-
Notifications
You must be signed in to change notification settings - Fork 6
/
_mediavault.php
1271 lines (959 loc) · 37.1 KB
/
_mediavault.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?php
/*
Plugin Name: Media Vault
Plugin URI: http://wordpress.org/plugins/media-vault/
Description: Protect attachment files from direct access using powerful and flexible restrictions. Offer safe download links for any file in your uploads folder.
Network: true
Text Domain: media-vault
Domain Path: /languages
Version: 0.8.12
Author: Max GJ Panas
Author URI: http://maxpanas.com
License: GPLv3 or later
Copyright 2013 Maximilianos G J Panas (email : [email protected])
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License, version 3, as
published by the Free Software Foundation.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
*/
// define current plugin version constant
define( 'MGJP_MV_VERSION', '0.8.12' );
/**
* The default Media Vault permissions array
*
* @since 0.4
*
* @global $mgjp_mv_permissions array Array of default Media Vault file access permissions
*/
global $mgjp_mv_permissions;
$mgjp_mv_permissions = array(
'admin' => array(
'description' => __( 'Admin users only', 'media-vault' ),
'select' => __( 'Admin users', 'media-vault' ),
'logged_in' => true,
'run_in_admin' => true,
'cb' => 'mgjp_mv_check_admin_permission'
),
'author' => array(
'description' => __( 'The file\'s author', 'media-vault' ),
'select' => __( 'The file\'s author', 'media-vault' ),
'logged_in' => true,
'run_in_admin' => true,
'cb' => 'mgjp_mv_check_author_permission'
),
'logged-in' => array(
'description' => __( 'All logged-in users', 'media-vault' ),
'select' => __( 'Logged-in users', 'media-vault' ),
'logged_in' => true,
'run_in_admin' => false,
'cb' => false
),
'all' => array(
'description' => __( 'Anyone', 'media-vault' ),
'select' => __( 'Anyone', 'media-vault' ),
'logged_in' => false,
'run_in_admin' => false,
'cb' => false
)
);
register_activation_hook( __FILE__, 'mgjp_mv_activate' );
register_deactivation_hook( __FILE__, 'mgjp_mv_deactivate' );
add_action( 'plugins_loaded', 'mgjp_mv_textdomain' );
add_action( 'init', 'mgjp_mv_check_version' );
add_action( 'load-plugins.php', 'mgjp_mv_on_deactivation_request' );
if ( get_site_option( 'mgjp_mv_enabled' ) ) {
add_action( 'init', 'mgjp_mv_handle_file_request', 0 );
add_action( 'init', 'mgjp_mv_register_shortcodes' );
add_action( 'wp_enqueue_media', 'mgjp_mv_attachment_edit_fields_styles_and_scripts' );
add_filter( 'mod_rewrite_rules', 'mgjp_mv_add_plugin_rewrite_rules' );
add_filter( 'upload_dir', 'mgjp_mv_change_upload_directory', 999 );
add_filter( 'user_has_cap', 'mgjp_mv_edit_capabilities', 999, 3 );
add_filter( 'image_downsize', 'mgjp_mv_replace_protected_image', 999, 3 );
if ( is_admin() ) {
add_action( 'admin_init', 'mgjp_mv_ajax_actions_include', 0 );
add_action( 'admin_init', 'mgjp_mv_media_vault_options_include' );
add_action( 'admin_init', 'mgjp_mv_attachment_metabox_include' );
add_action( 'load-media-new.php', 'mgjp_mv_media_new_options_include' );
add_action( 'load-upload.php', 'mgjp_mv_media_library_options_include' );
add_filter( 'admin_body_class', 'mgjp_add_mp6_admin_body_class' );
add_filter( 'plugin_action_links_' . plugin_basename( __FILE__ ), 'mgjp_mv_settings_link' );
}
} else {
include( plugin_dir_path( __FILE__ ) . 'mv-extra-activation-steps.php' );
}
if ( get_site_option( 'mgjp_mv_deactivation' ) )
include( plugin_dir_path( __FILE__ ) . 'mv-extra-deactivation-steps.php' );
//-----------------------------------------------------------------------//
// MEDIA VAULT - PERMISSION CHECKING FUNCTIONS
//-----------------------------------------------------------------------//
/**
* The 'admin' permission checking callback.
*
* @since 0.4
*/
function mgjp_mv_check_admin_permission() {
if ( ! current_user_can( 'manage_options' ) )
return new WP_Error( 'not_admin', __( 'You do not have sufficient permissions to view this file.', 'media-vault' ) );
return true;
}
/**
* The 'author' permission checking callback.
*
* @since 0.4
*/
function mgjp_mv_check_author_permission( $attachment_id ) {
if ( current_user_can( 'manage_options' ) )
return true;
if ( ! isset( $attachment_id ) || empty( $attachment_id ) )
return new WP_Error( 'no_id', __( 'There was an error determining this attachment\'s author. Please contact the website administrator.', 'media-vault' ) );
if ( get_current_user_id() != get_post_field( 'post_author', $attachment_id, 'raw' ) )
return new WP_Error( 'not_author', __( 'You do not have sufficient permissions to view this file.', 'media-vault' ) );
return true;
}
//-----------------------------------------------------------------------//
// MEDIA VAULT - MAIN HOOKED FUNCTIONS
//-----------------------------------------------------------------------//
/**
* On plugin activation
*
* @since 0.1
*
* @uses _mgjp_mv_activate_local()
*/
function mgjp_mv_activate( $network_activating ) {
global $is_apache;
if ( $is_apache
&& ! is_multisite()
&& get_option( 'permalink_structure' )
&& got_mod_rewrite()
&& is_writable( get_home_path() . '.htaccess' ) ) {
// register plugin enabled option
update_site_option( 'mgjp_mv_enabled', true );
// Flush rewrite rules to add Media Vault rewrite rules to the
// site's .htaccess file on plugin activation
add_filter( 'mod_rewrite_rules', 'mgjp_mv_add_plugin_rewrite_rules' );
flush_rewrite_rules();
}
// register Media Vault's other network-wide options
add_site_option( 'mgjp_mv_version', MGJP_MV_VERSION, '', 'yes' );
delete_site_option( 'mgjp_mv_deactivation' );
if ( ! is_multisite() ) {
// run the activation function for the single site
_mgjp_mv_activate_local();
} else if ( ! wp_is_large_network() ) {
global $wpdb;
$blog_ids = $wpdb->get_col( "SELECT `blog_id` FROM `$wpdb->blogs`" );
// run the activation function for each site in the network
foreach ( $blog_ids as $blog_id ) {
switch_to_blog( $blog_id );
_mgjp_mv_activate_local( $blog_id );
restore_current_blog();
}
}
}
/**
* On plugin deactivation
*
* @since 0.1
*
* @uses mgjp_mv_check_rewrite_rules()
*/
function mgjp_mv_deactivate( $network_deactivating ) {
delete_site_option( 'mgjp_mv_deactivation' );
delete_site_option( 'mgjp_mv_enabled' );
// Flush rewrite rules to remove Media Vault rewrite rules from the
// site's .htaccess file on plugin deactivation
remove_filter( 'mod_rewrite_rules', 'mgjp_mv_add_plugin_rewrite_rules' );
flush_rewrite_rules();
if ( ! is_multisite() ) {
// run the deactivation function for the single site
_mgjp_mv_deactivate_local();
} else if ( ! wp_is_large_network() ) {
global $wpdb;
$blog_ids = $wpdb->get_col( "SELECT `blog_id` FROM `$wpdb->blogs`" );
// run the deactivation function for each site in the network
foreach ( $blog_ids as $blog_id ) {
switch_to_blog( $blog_id );
_mgjp_mv_deactivate_local( $blog_id );
restore_current_blog();
}
}
}
/**
* Load the plugin textdomain.
*
* @since 0.1
*/
function mgjp_mv_textdomain() {
load_plugin_textdomain( 'media-vault', false, plugin_dir_path( __FILE__ ) . 'languages/' );
}
/**
* Plugin update handling. Checks current version against
* a version number stored in the database and performs any
* necessary upgrades using the MGJP_MV_Update class
*
* @since 0.8
*
* @uses MGJP_MV_Update
*/
function mgjp_mv_check_version() {
$option_key = 'mgjp_mv_version';
$version_db = get_site_option( $option_key, '0' );
if ( version_compare( $version_db, MGJP_MV_VERSION, 'eq' ) )
return;
if ( version_compare( $version_db, MGJP_MV_VERSION, 'gt' ) )
return update_site_option( $option_key, MGJP_MV_VERSION );
include( plugin_dir_path( __FILE__ ) . 'mv-class-update.php' );
if ( class_exists( 'MGJP_MV_Update' ) )
new MGJP_MV_Update( $version_db, MGJP_MV_VERSION, $option_key );
}
/**
* Remove Media Vault from the plugins.php deactivation
* actions if Media Vault needs extra steps in order
* to deactivate
*
* @since 0.8.5
*
* @uses mgjp_mv_get_dirfile()
* @uses mgjp_mv_is_deactivation_allowed()
*/
function mgjp_mv_on_deactivation_request() {
if ( in_array( get_site_option( 'mgjp_mv_deactivation' ), array( 'allowed', 'temp' ) ) )
return;
$action = isset( $_REQUEST['action'] ) && -1 != $_REQUEST['action'] ?
$_REQUEST['action'] :
( isset( $_REQUEST['action2'] ) && -1 != $_REQUEST['action2'] ?
$_REQUEST['action2'] :
false
);
if ( ! in_array( $action, array( 'deactivate', 'deactivate-selected' ) ) )
return;
switch ( $action ) {
case 'deactivate':
if ( ! isset( $_REQUEST['plugin'] ) || mgjp_mv_get_dirfile() != $_REQUEST['plugin'] )
return;
if ( mgjp_mv_is_deactivation_allowed() )
return;
update_site_option( 'mgjp_mv_deactivation', 'disallowed' );
$location = remove_query_arg( array( 'action', 'plugin', '_wpnonce' ), $_SERVER['REQUEST_URI'] );
wp_redirect( $location );
exit;
break;
case 'deactivate-selected':
$plugin_dirfile = mgjp_mv_get_dirfile();
if ( ! isset( $_POST['checked'] ) || ! in_array( $plugin_dirfile, (array) $_POST['checked'] ) )
return;
if ( mgjp_mv_is_deactivation_allowed() )
return;
update_site_option( 'mgjp_mv_deactivation', 'disallowed' );
$_POST['checked'] = array_diff( $_POST['checked'], array( $plugin_dirfile ) );
break;
}
}
/**
* Trigger protected media uploads file handling function
* if 'file' GET parameter is set in URL on wp init
*
* @since 0.1
*
* @uses mgjp_mv_get_file()
*/
function mgjp_mv_handle_file_request() {
if ( isset( $_GET['mgjp_mv_file'] ) && ! empty( $_GET['mgjp_mv_file'] ) ) {
// used by @func mgjp_mv_check_rewrite_rules to verify rewrite rules are
// set and working as intended
if ( isset( $_GET['mgjp_mv_rewrite_test'] ) && $_GET['mgjp_mv_rewrite_test'] )
die( 'pass' );
require( plugin_dir_path( __FILE__ ) . 'mv-file-handler.php' );
// Check if force download flag is set
$force_download = isset( $_REQUEST['mgjp_mv_download'] ) ?
$_REQUEST['mgjp_mv_download'] :
'';
if ( function_exists( 'mgjp_mv_get_file' ) ) {
mgjp_mv_get_file( $_GET['mgjp_mv_file'], $force_download );
exit; // This exit is important as all we want to do when a
// media download is requested is to serve it and exit
// If it is missing WP will continue serving the page
// after the media file, thus breaking it
}
}
}
/**
* Register Media Vault Shortcodes
*
* @since 0.5
*/
function mgjp_mv_register_shortcodes() {
include( plugin_dir_path( __FILE__ ) . 'mv-shortcodes.php' );
if ( function_exists( 'mgjp_mv_download_links_list_shortcode_handler' ) )
add_shortcode( 'mv_dl_links', 'mgjp_mv_download_links_list_shortcode_handler' );
}
/**
* Enqueue styles and scripts for Media Vault
* attachment edit fields.
*
* @hook action 'wp_enqueue_media'
*
* @since 0.8.8
*/
function mgjp_mv_attachment_edit_fields_styles_and_scripts() {
wp_enqueue_style( 'mgjp-mv-att-fields-css', plugins_url( 'css/mv-attachment-fields.css', __FILE__ ), 'all', null );
wp_enqueue_script( 'mgjp-mv-att-fields-js', plugins_url( 'js/min/mv-attachment-fields.min.js', __FILE__ ), array( 'media-editor' ), null, true );
}
/**
* Add the plugin rewrite rules to the WP rewrite
* rules being written in the sitewide .htaccess file
*
* @since 0.8.5
*
* @uses mgjp_mv_get_the_rewrite_rules()
* @param $rules string String containing all rewrite rules to be written in htaccess
* @return string String containing all rewrite rules to be written in htaccess
* including Media Vault custom rewrite rules
*/
function mgjp_mv_add_plugin_rewrite_rules( $rules ) {
$pattern = "RewriteRule ^index\.php$ - [L]\n";
return str_replace( $pattern, "$pattern\n" . implode( "\n", mgjp_mv_get_the_rewrite_rules() ) . "\n\n", $rules );
}
/**
* Change upload directory for media uploads to a protected
* folder if the 'protected' post/get parameter has been set
* during the upload process.
*
* @since 0.1
*
* @uses mgjp_mv_upload_dir()
* @param $param array Array of path info for WP Upload Directory
* @return array Array of path info for Media Vault protected directory
*/
function mgjp_mv_change_upload_directory( $param ) {
if ( isset( $_POST['mgjp_mv_protected'] ) && 'on' == $_POST['mgjp_mv_protected'] ) {
$param['subdir'] = mgjp_mv_upload_dir( $param['subdir'], true );
$param['path'] = $param['basedir'] . $param['subdir'];
$param['url'] = $param['baseurl'] . $param['subdir'];
}
return $param;
}
/**
* Function for the 'user_has_cap' WP Core filter. Checks the permissions set
* on an attachment before making it available to a user to edit/delete/read.
*
* @since 0.7
*
* @uses mgjp_mv_check_user_permitted()
* @param $allcaps array Array of all user capabilities
* @param $cap array [0] string capability required
* @param $args array [0] string capability requested
* [1] int user ID
* [2] int post ID
* @return array @param $allcaps unchanged if user permitted to access post
* @return array @param $allcaps with capability @param $cap[0] set to false
*/
function mgjp_mv_edit_capabilities( $allcaps, $cap, $args ) {
$disallowed_caps = array(
'edit_post',
'delete_post',
'read_post'
);
if ( ! in_array( $args[0], $disallowed_caps ) )
return $allcaps;
if ( ! isset( $args[2] ) )
return $allcaps;
// check if user is permitted to access the post
if ( mgjp_mv_check_user_permitted( $args[2] ) )
return $allcaps;
$allcaps[$cap[0]] = false;
return $allcaps;
}
/**
* Replace requested image with a Media Vault place-holder
* if the user is not permitted to view them
*
* @since 0.8
*
* @param $img mixed false based on wp-includes/media.php or array if other filter has affected it
* @param $attachment_id int ID of the attachment whose image is being requested
* @param $size string name-id of the dimensions of the requested image
* @return mixed return the $url if the image is not protected
* @return array [0] string URL to the Media Vault replacement image of the requested size
* [1] string width of the Media Vault replacement image
* [2] string height of the Media Vault replacement image
* [3] bool whether the url is for a resized image or not
*/
function mgjp_mv_replace_protected_image( $img, $attachment_id, $size ) {
$ir = get_option( 'mgjp_mv_ir' );
if ( ! isset( $ir['is_on'] ) || ! $ir['is_on'] )
return $img;
$upload_dir = wp_upload_dir();
if ( isset( $img[0] ) && 0 !== strpos( ltrim( $img[0], $upload_dir['baseurl'] ), mgjp_mv_upload_dir( '/', true ) ) )
return $img;
if ( mgjp_mv_check_user_permitted( $attachment_id ) )
return $img;
if ( isset( $ir['id'] ) && ! mgjp_mv_is_protected( $ir['id'] ) ) {
remove_filter( 'image_downsize', 'mgjp_mv_replace_protected_image', 999, 3 );
$placeholder = wp_get_attachment_image_src( $ir['id'], $size );
add_filter( 'image_downsize', 'mgjp_mv_replace_protected_image', 999, 3 );
return $placeholder;
} else {
list( $width, $height ) = image_constrain_size_for_editor( 1024, 1024, $size );
return array(
plugins_url( 'imgs/media-vault-ir.jpg', __FILE__ ),
$width,
$height,
false
);
}
}
/**
* Include the Media Vault custom AJAX actions
*
* @since 0.8
*/
function mgjp_mv_ajax_actions_include() {
if ( defined( 'DOING_AJAX' ) && DOING_AJAX )
include( plugin_dir_path( __FILE__ ) . 'mv-ajax-actions.php' );
}
/**
* Include the plugin's general settings
*
* @since 0.4
*/
function mgjp_mv_media_vault_options_include() {
include( plugin_dir_path( __FILE__ ) . 'mv-options-media-vault.php' );
}
/**
* Include the custom attachment metabox functions
*
* @since 0.7.1
*/
function mgjp_mv_attachment_metabox_include() {
include( plugin_dir_path( __FILE__ ) . 'mv-metaboxes.php' );
}
/**
* Include the options for protected media uploads
* on the 'media-new.php' admin page
*
* @since 0.2
*/
function mgjp_mv_media_new_options_include() {
include( plugin_dir_path( __FILE__ ) . 'mv-options-media-new.php' );
}
/**
* Include the options for protected media uploads
* on the 'upload.php' (Media Library) admin page
*
* @since 0.3
*/
function mgjp_mv_media_library_options_include() {
include( plugin_dir_path( __FILE__ ) . 'mv-options-media-library.php' );
}
/**
* Add Media Vault flag to enable
* Media Vault mp6 styles for WP 3.8+
*
* @since 0.8.7
*
* @param $classes string admin body classes
* @return string admin body classes
*/
if ( ! function_exists( 'mgjp_add_mp6_admin_body_class' ) ) {
function mgjp_add_mp6_admin_body_class( $classes ) {
global $wp_version;
if ( version_compare( '3.7.5', $wp_version, '>' ) )
return $classes;
return $classes . ' mgjp_mp6 ';
}
}
/**
* Add Media Vault settings link on plugins manager page
*
* @since 0.8
*
* @param $links array Array of links associated with plugin
* @return array Array of links associated with plugin plus settings link
*/
function mgjp_mv_settings_link( $links ) {
$settings_link = '<a href="options-media.php#mgjp_mv_settings_section">'
. esc_html__( 'Settings', 'media-vault' )
. '</a>';
array_push( $links, $settings_link );
return $links;
}
//-----------------------------------------------------------------------//
// MEDIA VAULT - GENERAL FUNCTIONS
//-----------------------------------------------------------------------//
/**
* Media Vault internal Activation function for a single
* blog install or for each blog site
* in network activation mode
*
* @since 0.8.5
*
* @uses mgjp_mv_default_options()
* @uses mgjp_mv_load_placeholder_image()
*/
function _mgjp_mv_activate_local( $blog_id = 0 ) {
// register Media Vault options to the local options table
add_option( 'mgjp_mv_default_permission', 'logged-in', '', 'yes' );
add_option( 'mgjp_mv_options', mgjp_mv_default_options(), '', 'no' );
add_option( 'mgjp_mv_ir', array( 'is_on' => true ), '', 'no' );
mgjp_mv_load_placeholder_image();
do_action( 'mgjp_mv_activated_local', $blog_id );
}
/**
* Checks whether Media Vault requires extra
* deactivation steps before it can be correctly
* deactivated
*
* @since 0.8.5
*
* @return bool true
* false
*/
function mgjp_mv_is_deactivation_allowed() {
if ( 'temp' === get_site_option( 'mgjp_mv_deactivation' ) )
return true;
global $is_apache;
if ( $is_apache
&& ! is_multisite()
&& get_option( 'permalink_structure' )
&& is_writable( get_home_path() . '.htaccess' ) )
return true;
if ( ! mgjp_mv_check_rewrite_rules( true ) )
return true;
return false;
}
/**
* Media Vault internal Deactivation function for a single
* blog install or for each blog site
* in network activation mode
*
* @since 0.8.5
*/
function _mgjp_mv_deactivate_local( $blog_id = 0 ) {
// unload default placeholder image if it exists
$ir = get_option( 'mgjp_mv_ir' );
if ( isset( $ir['default'] ) && wp_attachment_is_image( $ir['default'] ) )
wp_delete_attachment( $ir['default'], true );
do_action( 'mgjp_mv_deactivated_local', $blog_id );
}
/**
* Return the relative "Path to plugin file with plugin data"
*
* @since 0.8.5
*
* @return string
*/
function mgjp_mv_get_dirfile() {
$plugin_dir = explode( '/', plugin_basename( __FILE__ ) );
$plugin_dir = $plugin_dir[0];
$plugin_file = array_keys( get_plugins( "/$plugin_dir" ) );
$plugin_file = $plugin_file[0];
return "$plugin_dir/$plugin_file";
}
/**
* Return the Media Vault protected upload folder
*
* @since 0.1
*
* @param $path string path to attach to the end of protected folder dirname
* @param $in_url bool set to true if slash before protected folder dirname is desired
* @return string Media Vault protected upload folder relative to WP uploads folder
*/
function mgjp_mv_upload_dir( $path = '', $in_url = false ) {
$dirpath = $in_url ? '/' : '';
$dirpath .= '_mediavault';
$dirpath .= $path;
return $dirpath;
}
/**
* Generate the rewrite rules to reroute requests for
* media uploads within protected folders and requests
* for media uploads with the `safeforce` download flag
* set, to the file-handling script. Even supporting
* WP Multisite.
*
* @since 0.8.5
*
* @uses mgjp_mv_upload_dir()
* @return array Array of strings of each line of the
* plugin's custom rewrite rules.
*/
function mgjp_mv_get_the_rewrite_rules() {
$upload = wp_upload_dir();
$uploads_path = str_replace( home_url( '/' ), '', $upload['baseurl'] );
// if is multisite add allowance for '/sites/ID' folders in uploads path
if ( is_multisite() )
$uploads_path .= '(?:/sites/[0-9]+)?';
// if multisite is on sub-directory mode add allowance for the site's
// sub-directory in the rewrite regex
if ( is_multisite() && ! is_subdomain_install() )
$uploads_path = '(?:[_0-9a-zA-Z-]+/)?' . $uploads_path;
$old_path_protected = $uploads_path . '(' . mgjp_mv_upload_dir( '/.*\.\w+)$', true );
$old_path_downloads = $uploads_path . '(/.*\.\w+)$';
$rewrite_rules = array(
'# Media Vault Rewrite Rules',
'RewriteRule ^' . $old_path_protected . ' index.php?mgjp_mv_file=$1 [QSA,L]',
'RewriteCond %{QUERY_STRING} ^(?:.*&)?mgjp_mv_download=safeforce(?:&.*)?$',
'RewriteRule ^' . $old_path_downloads . ' index.php?mgjp_mv_file=$1 [QSA,L]',
'# Media Vault Rewrite Rules End'
);
// if pretty permalinks not enabled then produce the code necessary for the user to manually
// add the rules to .htaccess
if ( ! is_multisite() && ! get_option( 'permalink_structure' ) ) {
$home_root = parse_url( home_url() );
if ( isset( $home_root['path'] ) )
$home_root = trailingslashit( $home_root['path'] );
else
$home_root = '/';
array_splice( $rewrite_rules, 1, 0, array(
'<ifModule mod_rewrite.c>',
'RewriteEngine On',
'RewriteBase ' . $home_root
) );
array_splice( $rewrite_rules, -1, 0, array(
'</ifModule>'
) );
}
return apply_filters( 'mgjp_mv_get_rewrite_rules', $rewrite_rules );
}
/**
* Check if request rewrite rules have been configured correctly
* Don't call on every init! - it makes **at least** two http
* requests every time it is called!
*
* @since 0.8.5
*
* @uses mgjp_mv_upload_dir()
* @return bool
*/
function mgjp_mv_check_rewrite_rules( $deactivation = false ) {
$upload_dir = wp_upload_dir();
$protected_test = mgjp_mv_upload_dir( '/mgjp_mv_rewrite_test.txt?mgjp_mv_rewrite_test=1', true );
$downloads_test = '/mgjp_mv_rewrite_test.txt?mgjp_mv_download=safeforce&mgjp_mv_rewrite_test=1';
$checks = array(
$upload_dir['baseurl'] . $protected_test,
$upload_dir['baseurl'] . $downloads_test
);
$checks = apply_filters( 'mgjp_mv_rewrite_rule_check_urls', $checks );
$checks_passed = true;
foreach ( $checks as $check_url ) {
$check = wp_remote_get( $check_url );
if ( is_wp_error( $check )
|| ! isset( $check['response']['code'] ) || 200 != $check['response']['code']
|| ! isset( $check['body'] ) || 'pass' != $check['body'] )
$checks_passed = false;
else
$checks_passed = true;
if ( ( ! $deactivation && ! $checks_passed ) || ( $deactivation && $checks_passed ) )
break;
}
return $checks_passed;
}
/**
* Adds the default Media Vault place-holder image to the
* Media Library and saves the id of the attachment created
* in the 'mgjp_mv_ir' option in the options table
*
* @since 0.8
*
* @return int the ID of the attachment that was created
* @return bool true on success
* @return bool false on failure to load image
*/
function mgjp_mv_load_placeholder_image( $restore_orig = false ) {
$ir = get_option( 'mgjp_mv_ir' );
// if placeholder image already exists return its attachment ID
if ( isset( $ir['id'] ) && wp_attachment_is_image( $ir['id'] ) && ! $restore_orig )
return $ir['id'];
// if original placeholder is loaded no need to
// reload it. Set it as placeholder and return its ID
if ( isset( $ir['default'] ) && wp_attachment_is_image( $ir['default'] ) ) {
$ir['id'] = $ir['default'];
update_option( 'mgjp_mv_ir', $ir );
return $ir['id'];
}
require_once( ABSPATH . 'wp-admin/includes/file.php' );
require_once( ABSPATH . 'wp-admin/includes/media.php' );
require_once( ABSPATH . 'wp-admin/includes/image.php' );
$tmp = download_url( plugins_url( 'imgs/media-vault-ir.jpg', __FILE__ ) );
if ( is_wp_error( $tmp ) ) {
@ unlink( $tmp );
return false;
}
$file_array = array(
'name' => 'media-vault-ir.jpg',
'tmp_name' => $tmp
);
$post_data['post_date_gmt'] = $post_data['post_date'] = '1988-01-31 12:00:00';
$id = media_handle_sideload(
$file_array,
0,
__( 'Do Not Delete, Media Vault Place-holder Image' , 'media-vault' ),
$post_data
);
if ( is_wp_error( $id ) ) {
@ unlink( $tmp );
return false;
}
$ir['default'] = $id;
$ir['id'] = $id;
update_option( 'mgjp_mv_ir', $ir );
return $id;
}
/**
* Check if an attachment is protected with Media Vault.
*
* A file is protected by media vault if and only if
* it is in the Media Vault Protected Directory within
* the WordPress Uploads Directory.
* ( eg: wp-content/uploads/_mediavault/../filename.ext )
*
* If a file is in the protected directory and no permission
* meta is detected for the file, the default permission is
* used to check if the user is allowed access.
*
* So to check if an attachment is protected by Media Vault we
* need to check whether its files are within the Media Vault
* Protected Directory.
*
* @since 0.8
*
* @uses mgjp_mv_upload_dir()
* @param $attachment_id int the id of the attachment we want to check
*/
function mgjp_mv_is_protected( $attachment_id ) {
// Get the base file path relative to the WordPress Uploads Directory
$file = get_post_meta( $attachment_id, '_wp_attached_file', true );
// Check if the path begins with the Media Vault Protected Directory
// Therefore check if the attachment's files are in the protected directory
if ( 0 === stripos( $file, mgjp_mv_upload_dir( '/' ) ) )
return true;
return false;
}
/**
* Adds a permission to the Media Vault permissions array
*
* @since 0.6
*
* @uses $mgjp_mv_permissions
* @param $name string Name-id of the new permission, must be unique
* @param $args array Array of arguments for permission must include:
* [description] string Human readable short description of permission
* [select] string Human readable very consice description of permission, used in option of select element
* [logged_in] bool Whether the user must be at least logged in
* [run_in_admin] bool Whether to run the permission check in WP Admin
* [cb] string Function name to be called to evaluate file access permissions, false if no callback desired
* Function MUST return TRUE if access permitted to file and FALSE or WP_Error if access denied