/
safe-redirect-manager.php
1062 lines (896 loc) · 41.2 KB
/
safe-redirect-manager.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: Safe Redirect Manager
Plugin URI: http://www.10up.com
Description: Easily and safely manage HTTP redirects.
Author: Taylor Lovett (10up)
Version: 1.7.7
Author URI: http://www.10up.com
GNU General Public License, Free Software Foundation <http://creativecommons.org/licenses/GPL/2.0/>
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
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., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
if ( defined( 'WP_CLI' ) && WP_CLI )
require_once dirname( __FILE__ ) . '/inc/wp-cli.php';
class SRM_Safe_Redirect_Manager {
public $redirect_post_type = 'redirect_rule';
private $redirect_nonce_name = 'srm_redirect_nonce';
private $redirect_nonce_action = 'srm-save-redirect-meta';
public $meta_key_redirect_from = '_redirect_rule_from';
public $meta_key_redirect_to = '_redirect_rule_to';
public $meta_key_redirect_status_code = '_redirect_rule_status_code';
public $meta_key_enable_redirect_from_regex = '_redirect_rule_from_regex';
public $cache_key_redirects = '_srm_redirects';
public $valid_status_codes = array( 301, 302, 303, 307, 403, 404 );
public $status_code_labels = array(
301 => 'Moved Permanently',
302 => 'Found',
303 => 'See Other',
307 => 'Temporary Redirect',
403 => 'Forbidden',
404 => 'Not Found',
);
private $whitelist_hosts = array();
public $default_max_redirects = 150;
/**
* Sets up redirect manager
*
* @since 1.0
* @uses add_action, add_filter
* @return object
*/
public function __construct() {
add_action( 'init', array( $this, 'action_init_load_textdomain' ), 9 );
add_action( 'init', array( $this, 'action_init' ) );
add_action( 'init', array( $this, 'action_register_post_types' ) );
add_action( 'parse_request', array( $this, 'action_parse_request' ), 0 );
add_action( 'save_post', array( $this, 'action_save_post' ) );
add_filter( 'manage_' . $this->redirect_post_type . '_posts_columns' , array( $this, 'filter_redirect_columns' ) );
add_action( 'manage_' . $this->redirect_post_type . '_posts_custom_column' , array( $this, 'action_custom_redirect_columns' ), 10, 2 );
add_action( 'transition_post_status', array( $this, 'action_transition_post_status' ), 10, 3 );
add_filter( 'post_updated_messages', array( $this, 'filter_redirect_updated_messages' ) );
add_action( 'admin_notices', array( $this, 'action_redirect_chain_alert' ) );
add_filter( 'the_title', array( $this, 'filter_admin_title' ), 100, 2 );
add_filter( 'bulk_actions-edit-' . $this->redirect_post_type, array( $this, 'filter_bulk_actions' ) );
add_action( 'admin_print_styles-edit.php', array( $this, 'action_print_logo_css' ), 10, 1 );
add_action( 'admin_print_styles-post.php', array( $this, 'action_print_logo_css' ), 10, 1 );
add_action( 'admin_print_styles-post-new.php', array( $this, 'action_print_logo_css' ), 10, 1 );
add_filter( 'post_type_link', array( $this, 'filter_post_type_link' ), 10, 2 );
// Search filters
add_filter( 'posts_join', array( $this, 'filter_search_join' ) );
add_filter( 'posts_where', array( $this, 'filter_search_where' ) );
add_filter( 'posts_distinct', array( $this, 'filter_search_distinct' ) );
}
/**
* Localize plugin
*
* @since 1.7
* @uses load_plugin_textdomain
* @return void
*/
public function action_init_load_textdomain() {
load_plugin_textdomain( 'safe-redirect-manager', false, basename( dirname( __FILE__ ) ) . '/languages' );
}
/**
* Join posts table with postmeta table on search
*
* @since 1.2
* @param string $join
* @uses get_query_var
* @return string
*/
public function filter_search_join( $join ) {
global $wp_query;
if ( empty( $wp_query ) || $this->redirect_post_type != get_query_var( 'post_type' ) )
return $join;
global $wpdb;
$s = get_query_var( 's' );
if ( ! empty( $s ) ) {
$join .= " LEFT JOIN $wpdb->postmeta AS m ON ($wpdb->posts.ID = m.post_id) ";
}
return $join;
}
/**
* Return distinct search results
*
* @since 1.2
* @param string $distinct
* @uses get_query_var
* @return string
*/
public function filter_search_distinct( $distinct ) {
global $wp_query;
if ( empty( $wp_query ) || $this->redirect_post_type != get_query_var( 'post_type' ) )
return $distinct;
return 'DISTINCT';
}
/**
* Join posts table with postmeta table on search
*
* @since 1.2
* @param string $where
* @uses is_search, get_query_var
* @return string
*/
public function filter_search_where( $where ) {
global $wp_query;
if ( empty( $wp_query ) || $this->redirect_post_type != get_query_var( 'post_type' ) || ! is_search() || empty( $where ) )
return $where;
$exact = get_query_var( 'exact' );
$n = ( ! empty( $exact ) ) ? '' : '%';
$search = '';
$seperator = '';
$terms = $this->get_search_terms();
$search .= '(';
// we check the meta values against each term in the search
foreach ( $terms as $term ) {
$search .= $seperator;
$search .= sprintf( "( ( m.meta_value LIKE '%s%s%s' AND m.meta_key = '%s') OR ( m.meta_value LIKE '%s%s%s' AND m.meta_key = '%s') )", $n, $term, $n, $this->meta_key_redirect_from, $n, $term, $n, $this->meta_key_redirect_to );
$seperator = ' OR ';
}
$search .= ')';
$where = preg_replace( '/\(\(\(.*?\)\)\)/is', '((' . $search . '))', $where );
return $where;
}
/**
* Get an array of search terms
*
* @since 1.2
* @uses get_query_var
* @return array
*/
private function get_search_terms() {
$s = get_query_var( 's' );
if ( ! empty( $s ) ) {
preg_match_all( '/".*?("|$)|((?<=[\\s",+])|^)[^\\s",+]+/', stripslashes( $s ), $matches );
$search_terms = array_map( create_function( '$a', 'return trim( $a, "\\"\'\\n\\r " );' ), $matches[0] );
}
return $search_terms;
}
/**
* Swap tools logo for plugin logo
*
* @since 1.1
* @uses plugins_url
* @return void
*/
public function action_print_logo_css() {
if ( $this->is_plugin_page() ) {
?>
<style type="text/css">
#visibility, .view-switch, .posts .inline-edit-col-left .inline-edit-group {
display: none;
}
#srm<?php echo $this->meta_key_redirect_from; ?> {
width: 60%;
}
</style>
<?php
}
}
/**
* Limit the bulk actions available in the Manage Redirects view
*
* @since 1.0
* @return array
*/
public function filter_bulk_actions( $actions ) {
// No bulk editing at this time
unset( $actions['edit'] );
return $actions;
}
/**
* Creates a redirect post, this function will be useful for import/exports scripts
*
* @param string $redirect_from
* @param string $redirect_to
* @param int $status_code
* @param bool $enable_regex
* @param string $post_status
* @since 1.3
* @uses wp_insert_post, update_post_meta
* @return int|WP_Error
*/
public function create_redirect( $redirect_from, $redirect_to, $status_code = 302, $enable_regex = false, $post_status = 'publish' ) {
global $wpdb;
$sanitized_redirect_from = $this->sanitize_redirect_from( $redirect_from );
$sanitized_redirect_to = $this->sanitize_redirect_to( $redirect_to );
$sanitized_status_code = absint( $status_code );
$sanitized_enable_regex = (bool)$enable_regex;
$sanitized_post_status = sanitize_key( $post_status );
// check and make sure no parameters are empty or invalid after sanitation
if ( empty( $sanitized_redirect_from ) || empty( $sanitized_redirect_to ) )
return new WP_Error( 'invalid-argument', __( 'Redirect from and/or redirect to arguments are invalid.', 'safe-redirect-manager' ) );
if ( ! in_array( $sanitized_status_code, $this->valid_status_codes ) )
return new WP_Error( 'invalid-argument', __( 'Invalid status code.', 'safe-redirect-manager' ) );
// Check to ensure this redirect doesn't already exist
if ( $wpdb->get_var( $wpdb->prepare( "SELECT post_id FROM $wpdb->postmeta WHERE meta_key=%s AND meta_value=%s", $this->meta_key_redirect_from, $sanitized_redirect_from ) ) )
return new WP_Error( 'duplicate-redirect', sprintf( __( 'Redirect already exists for %s', 'safe-redirect-manager' ), $sanitized_redirect_from ) );
// create the post
$post_args = array(
'post_type' => $this->redirect_post_type,
'post_status' => $sanitized_post_status,
'post_author' => 1
);
$post_id = wp_insert_post( $post_args );
if ( 0 >= $post_id )
return new WP_Error( 'error-creating', __( 'An error occurred creating the redirect.', 'safe-redirect-manager' ) );
// update the posts meta info
update_post_meta( $post_id, $this->meta_key_redirect_from, $sanitized_redirect_from );
update_post_meta( $post_id, $this->meta_key_redirect_to, $sanitized_redirect_to );
update_post_meta( $post_id, $this->meta_key_redirect_status_code, $sanitized_status_code );
update_post_meta( $post_id, $this->meta_key_enable_redirect_from_regex, $sanitized_enable_regex );
// We need to update the cache after creating this redirect
$this->update_redirect_cache();
return $post_id;
}
/**
* Whether or not this is an admin page specific to the plugin
*
* @since 1.1
* @uses get_post_type
* @return bool
*/
private function is_plugin_page() {
return (bool) ( get_post_type() == $this->redirect_post_type || ( isset( $_GET['post_type'] ) && $this->redirect_post_type == $_GET['post_type'] ) );
}
/**
* Echoes admin message if redirect chains exist
*
* @since 1.0
* @uses apply_filters
* @return void
*/
public function action_redirect_chain_alert() {
global $hook_suffix;
if ( $this->is_plugin_page() ) {
/**
* check_for_possible_redirect_loops() runs in best case Theta(n^2) so if you have 100 redirects, this method
* will be running slow. Let's disable it by default.
*/
if ( apply_filters( 'srm_check_for_possible_redirect_loops', false ) ) {
if ( $this->check_for_possible_redirect_loops() ) {
?>
<div class="updated">
<p><?php _e( 'Safe Redirect Manager Warning: Possible redirect loops and/or chains have been created.', 'safe-redirect-manager' ); ?></p>
</div>
<?php
}
} if ( $this->max_redirects_reached() ) {
?>
<?php if ( 'post-new.php' == $hook_suffix ) : ?><style type="text/css">#post { display: none; }</style><?php endif; ?>
<div class="error">
<p><?php _e( 'Safe Redirect Manager Error: You have reached the maximum allowable number of redirects', 'safe-redirect-manager' ); ?></p>
</div>
<?php
}
}
}
/**
* Returns true if max redirects have been reached
*
* @since 1.0
* @uses apply_filters, get_transient
* @return bool
*/
public function max_redirects_reached() {
if ( false === ( $redirects = get_transient( $this->cache_key_redirects ) ) ) {
$redirects = $this->update_redirect_cache();
}
return ( count( $redirects ) >= $this->default_max_redirects );
}
/**
* Check for potential redirect loops or chains
*
* @since 1.0
* @uses home_url, get_transient
* @return boolean
*/
public function check_for_possible_redirect_loops() {
if ( false === ( $redirects = get_transient( $this->cache_key_redirects ) ) ) {
$redirects = $this->update_redirect_cache();
}
$current_url = parse_url( home_url() );
$this_host = ( is_array( $current_url ) && ! empty( $current_url['host'] ) ) ? $current_url['host'] : '';
foreach ( $redirects as $redirect ) {
$redirect_from = $redirect['redirect_from'];
// check redirect from against all redirect to's
foreach ( $redirects as $compare_redirect ) {
$redirect_to = $compare_redirect['redirect_to'];
$redirect_url = parse_url( $redirect_to );
$redirect_host = ( is_array( $redirect_url ) && ! empty( $redirect_url['host'] ) ) ? $redirect_url['host'] : '';
// check if we are redirecting locally
if ( empty( $redirect_host ) || $redirect_host == $this_host ) {
$redirect_from_url = preg_replace( '/(http:\/\/|https:\/\/|www\.)/i', '', home_url() . $redirect_from );
$redirect_to_url = $redirect_to;
if ( ! preg_match( '/https?:\/\//i', $redirect_to_url ) )
$redirect_to_url = $this_host . $redirect_to_url;
else
$redirect_to_url = preg_replace( '/(http:\/\/|https:\/\/|www\.)/i', '', $redirect_to_url );
// possible loop/chain found
if ( $redirect_to_url == $redirect_from_url )
return true;
}
}
}
return false;
}
/**
* Filters title out for redirect from in post manager
*
* @since 1.0
* @param string $title
* @param int $post_id
* @uses is_admin, get_post_meta
* @return string
*/
public function filter_admin_title( $title, $post_id = 0 ) {
if ( ! is_admin() )
return $title;
$redirect = get_post( $post_id );
if ( empty( $redirect ) )
return $title;
if ( $redirect->post_type != $this->redirect_post_type )
return $title;
$redirect_from = get_post_meta( $post_id, $this->meta_key_redirect_from, true );
if ( ! empty( $redirect_from ) )
return $redirect_from;
return $title;
}
/**
* Customizes updated messages for redirects
*
* @since 1.0
* @param array $messages
* @uses esc_url, get_permalink, add_query_var, wp_post_revision_title
* @return array
*/
public function filter_redirect_updated_messages( $messages ) {
global $post, $post_ID;
$messages[$this->redirect_post_type] = array(
0 => '', // Unused. Messages start at index 1.
1 => sprintf( __( 'Redirect rule updated.', 'safe-redirect-manager' ), esc_url( get_permalink( $post_ID ) ) ),
2 => __( 'Custom field updated.', 'safe-redirect-manager' ),
3 => __( 'Custom field deleted.', 'safe-redirect-manager' ),
4 => __( 'Redirect rule updated.', 'safe-redirect-manager' ),
/* translators: %s: date and time of the revision */
5 => isset( $_GET['revision'] ) ? sprintf( __('Redirect rule restored to revision from %s', 'safe-redirect-manager' ), wp_post_revision_title( (int) $_GET['revision'], false ) ) : false,
6 => sprintf( __( 'Redirect rule published.', 'safe-redirect-manager' ), esc_url( get_permalink( $post_ID ) ) ),
7 => __( 'Redirect rule saved.', 'safe-redirect-manager' ),
8 => sprintf( __( 'Redirect rule submitted.', 'safe-redirect-manager' ), esc_url( add_query_arg( 'preview', 'true', get_permalink( $post_ID ) ) ) ),
9 => sprintf( __( 'Redirect rule scheduled for: <strong>%1$s</strong>.', 'safe-redirect-manager' ),
// translators: Publish box date format, see http://php.net/date
date_i18n( __( 'M j, Y @ G:i' ), strtotime( $post->post_date ) ), esc_url( get_permalink($post_ID) ) ),
10 => sprintf( __( 'Redirect rule draft updated.', 'safe-redirect-manager' ), esc_url( add_query_arg( 'preview', 'true', get_permalink( $post_ID ) ) ) ),
);
return $messages;
}
/**
* Clear redirect cache if appropriate post type is transitioned
*
* @since 1.0
* @param string $new_status
* @param string $old_status
* @param object $post
* @uses delete_transient
* @return void
*/
public function action_transition_post_status( $new_status, $old_status, $post ) {
if ( ! is_object( $post ) )
return;
// recreate redirect cache
if ( $this->redirect_post_type == $post->post_type ) {
delete_transient( $this->cache_key_redirects );
$this->update_redirect_cache();
}
}
/**
* Displays custom columns on redirect manager screen
*
* @since 1.0
* @param string $column
* @param int $post_id
* @uses get_post_meta, esc_html, admin_url
* @return void
*/
public function action_custom_redirect_columns( $column, $post_id ) {
if ( 'srm' . $this->meta_key_redirect_to == $column ) {
echo esc_html( get_post_meta( $post_id, $this->meta_key_redirect_to, true ) );
} elseif ( 'srm' . $this->meta_key_redirect_status_code == $column ) {
echo absint( get_post_meta( $post_id, $this->meta_key_redirect_status_code, true ) );
}
}
/**
* Add new columns to manage redirect screen
*
* @since 1.0
* @param array $columns
* @return array
*/
public function filter_redirect_columns( $columns ) {
$columns['srm' . $this->meta_key_redirect_to] = __( 'Redirect To', 'safe-redirect-manager' );
$columns['srm'. $this->meta_key_redirect_status_code] = __( 'HTTP Status Code', 'safe-redirect-manager' );
// Change the title column
$columns['title'] = __( 'Redirect From', 'safe-redirect-manager' );
// Move date column to the back
unset( $columns['date'] );
$columns['date'] = __( 'Date', 'safe-redirect-manager' );
return $columns;
}
/**
* Saves meta info for redirect rules
*
* @since 1.0
* @param int $post_id
* @uses current_user_can, get_post_type, wp_verify_nonce, update_post_meta, delete_post_meta
* @return void
*/
public function action_save_post( $post_id ) {
if ( ( defined( 'DOING_AUTOSAVE' ) && DOING_AUTOSAVE ) || ! current_user_can( 'edit_post', $post_id ) || 'revision' == get_post_type( $post_id ) )
return;
// Update post meta for redirect rules
if ( ! empty( $_POST[$this->redirect_nonce_name] ) && wp_verify_nonce( $_POST[$this->redirect_nonce_name], $this->redirect_nonce_action ) ) {
if ( ! empty( $_POST['srm' . $this->meta_key_enable_redirect_from_regex] ) ) {
$allow_regex = (bool) $_POST['srm' . $this->meta_key_enable_redirect_from_regex];
update_post_meta( $post_id, $this->meta_key_enable_redirect_from_regex, $allow_regex );
} else {
$allow_regex = false;
delete_post_meta( $post_id, $this->meta_key_enable_redirect_from_regex );
}
if ( ! empty( $_POST['srm' . $this->meta_key_redirect_from] ) ) {
update_post_meta( $post_id, $this->meta_key_redirect_from, $this->sanitize_redirect_from( $_POST['srm' . $this->meta_key_redirect_from], $allow_regex ) );
} else {
delete_post_meta( $post_id, $this->meta_key_redirect_from );
}
if ( ! empty( $_POST['srm' . $this->meta_key_redirect_to] ) ) {
update_post_meta( $post_id, $this->meta_key_redirect_to, $this->sanitize_redirect_to( $_POST['srm' . $this->meta_key_redirect_to] ) );
} else {
delete_post_meta( $post_id, $this->meta_key_redirect_to );
}
if ( ! empty( $_POST['srm' . $this->meta_key_redirect_status_code] ) ) {
update_post_meta( $post_id, $this->meta_key_redirect_status_code, absint( $_POST['srm' . $this->meta_key_redirect_status_code] ) );
} else {
delete_post_meta( $post_id, $this->meta_key_redirect_status_code );
}
/**
* This fixes an important bug where the redirect cache was not up-to-date. Previously the cache was only being
* updated on transition_post_status which gets called BEFORE save post. But since save_post is where all the important
* redirect info is saved, updating the cache before it is not sufficient.
*/
$this->update_redirect_cache();
}
}
/**
* Registers post types for plugin
*
* @since 1.0
* @uses register_post_type, _x, plugins_url, apply_filters
* @return void
*/
public function action_register_post_types() {
$redirect_labels = array(
'name' => _x( 'Safe Redirect Manager', 'post type general name', 'safe-redirect-manager' ),
'singular_name' => _x( 'Redirect', 'post type singular name', 'safe-redirect-manager' ),
'add_new' => _x( 'Create Redirect Rule', $this->redirect_post_type, 'safe-redirect-manager' ),
'add_new_item' => __( 'Safe Redirect Manager', 'safe-redirect-manager' ),
'edit_item' => __( 'Edit Redirect Rule', 'safe-redirect-manager' ),
'new_item' => __( 'New Redirect Rule', 'safe-redirect-manager' ),
'all_items' => __( 'Safe Redirect Manager', 'safe-redirect-manager' ),
'view_item' => __( 'View Redirect Rule', 'safe-redirect-manager' ),
'search_items' => __( 'Search Redirects', 'safe-redirect-manager' ),
'not_found' => __( 'No redirect rules found.', 'safe-redirect-manager' ),
'not_found_in_trash' => __( 'No redirect rules found in trash.', 'safe-redirect-manager' ),
'parent_item_colon' => '',
'menu_name' => __( 'Safe Redirect Manager', 'safe-redirect-manager' )
);
$redirect_capability = 'manage_options';
$redirect_capability = apply_filters( 'srm_restrict_to_capability', $redirect_capability );
$capabilities = array(
'edit_post' => $redirect_capability,
'read_post' => $redirect_capability,
'delete_post' => $redirect_capability,
'delete_posts' => $redirect_capability,
'edit_posts' => $redirect_capability,
'edit_others_posts' => $redirect_capability,
'publish_posts' => $redirect_capability,
'read_private_posts' => $redirect_capability
);
$redirect_args = array(
'labels' => $redirect_labels,
'public' => false,
'publicly_queryable' => true,
'show_ui' => true,
'show_in_menu' => 'tools.php',
'query_var' => false,
'rewrite' => false,
'capability_type' => 'post',
'capabilities' => $capabilities,
'has_archive' => false,
'hierarchical' => false,
'register_meta_box_cb' => array( $this, 'action_redirect_rule_metabox' ),
'menu_position' => 80,
'supports' => array( '' )
);
register_post_type( $this->redirect_post_type, $redirect_args );
}
/**
* Registers meta boxes for redirect rule post type
*
* @since 1.0
* @uses add_meta_box
* @return void
*/
public function action_redirect_rule_metabox() {
add_meta_box( 'redirect_settings', __( 'Redirect Settings', 'safe-redirect-manager' ), array( $this, 'redirect_rule_metabox' ), $this->redirect_post_type, 'normal', 'core' );
}
/**
* Echoes HTML for redirect rule meta box
*
* @since 1.0
* @param object $post
* @uses wp_nonce_field, get_post_meta, esc_attr, selected
* @return void
*/
public function redirect_rule_metabox( $post ) {
wp_nonce_field( $this->redirect_nonce_action, $this->redirect_nonce_name );
$redirect_from = get_post_meta( $post->ID, $this->meta_key_redirect_from, true );
$redirect_to = get_post_meta( $post->ID, $this->meta_key_redirect_to, true );
$status_code = get_post_meta( $post->ID, $this->meta_key_redirect_status_code, true );
$enable_regex = get_post_meta( $post->ID, $this->meta_key_enable_redirect_from_regex, true );
if ( empty( $status_code ) )
$status_code = apply_filters( 'srm_default_direct_status', 302 );
?>
<p>
<label for="srm<?php echo $this->meta_key_redirect_from; ?>"><?php _e( 'Redirect From:', 'safe-redirect-manager' ); ?></label><br />
<input type="text" name="srm<?php echo $this->meta_key_redirect_from; ?>" id="srm<?php echo $this->meta_key_redirect_from; ?>" value="<?php echo esc_attr( $redirect_from ); ?>" />
<input type="checkbox" name="srm<?php echo $this->meta_key_enable_redirect_from_regex; ?>" id="srm<?php echo $this->meta_key_enable_redirect_from_regex; ?>" <?php checked( true, (bool) $enable_regex ); ?> value="1" />
<label for="srm<?php echo $this->meta_key_enable_redirect_from_regex; ?>"><?php _e( 'Enable Regular Expressions (advanced)', 'safe-redirect-manager' ); ?></label><br />
<p class="description"><?php _e( "This path should be relative to the root of this WordPress installation (or the sub-site, if you are running a multi-site). Appending a (*) wildcard character will match all requests with the base. Warning: Enabling regular expressions will disable wildcards and completely change the way the * symbol is interpretted.", 'safe-redirect-manager' ); ?></p>
</p>
<p>
<label for="srm<?php echo $this->meta_key_redirect_to; ?>"><?php _e( 'Redirect To:', 'safe-redirect-manager' ); ?></label><br />
<input class="widefat" type="text" name="srm<?php echo $this->meta_key_redirect_to; ?>" id="srm<?php echo $this->meta_key_redirect_to; ?>" value="<?php echo esc_attr( $redirect_to ); ?>" /><br />
<p class="description"><?php _e( "This can be a URL or a path relative to the root of your website (not your WordPress installation). Ending with a (*) wildcard character will append the request match to the redirect.", 'safe-redirect-manager'); ?></p>
</p>
<p>
<label for="srm<?php echo $this->meta_key_redirect_status_code; ?>"><?php _e( 'HTTP Status Code:', 'safe-redirect-manager' ); ?></label>
<select name="srm<?php echo $this->meta_key_redirect_status_code; ?>" id="srm<?php echo $this->meta_key_redirect_status_code; ?>">
<?php foreach ( $this->valid_status_codes as $code ) : ?>
<option value="<?php echo esc_attr( $code ); ?>" <?php selected( $status_code, $code ); ?>><?php echo esc_html( $code . ' ' . $this->status_code_labels[$code] ); ?></option>
<?php endforeach; ?>
</select>
<em><?php _e( "If you don't know what this is, leave it as is.", 'safe-redirect-manager' ); ?></em>
</p>
<?php
}
/**
* Localize plugin
*
* @since 1.0
* @uses load_plugin_textdomain, plugin_basename
* @return void
*/
public function action_init() {
load_plugin_textdomain( 'safe-redirect-manager', false, dirname( plugin_basename( __FILE__ ) ) . '/languages/' );
$this->default_max_redirects = apply_filters( 'srm_max_redirects', $this->default_max_redirects );
}
/**
* Apply whitelisted hosts to allowed_redirect_hosts filter
*
* @since 1.0
* @param array $content
* @return array
*/
public function filter_allowed_redirect_hosts( $content ) {
foreach ( $this->whitelist_hosts as $host ) {
$without_www = preg_replace( '/^www\./i', '', $host );
$with_www = 'www.' . $without_www;
if ( ! in_array( $without_www, $content ) ) $content[] = $without_www;
if ( ! in_array( $with_www, $content ) ) $content[] = $with_www;
}
return $content;
}
/**
* Get redirects from the database
*
* @since 1.6
* @param array $args Any arguments to filter by
* @return array $redirects An array of redirects
*/
public function get_redirects( $args = array() ) {
$redirects = array();
if ( $this->default_max_redirects > 50 )
$posts_per_page = 50;
else
$posts_per_page = $this->default_max_redirects;
$i = 1;
do {
$defaults = array(
'posts_per_page' => $posts_per_page,
'post_status' => 'publish',
'paged' => $i,
);
$query_args = array_merge( $defaults, $args );
// Some arguments that don't need to be configurable
$query_args['post_type'] = $this->redirect_post_type;
$query_args['no_found_rows'] = false;
$query_args['update_term_cache'] = false;
$redirect_query = new WP_Query( $query_args );
foreach( $redirect_query->posts as $redirect ) {
$redirects[] = array(
'ID' => $redirect->ID,
'post_status' => $redirect->post_status,
'redirect_from' => get_post_meta( $redirect->ID, $this->meta_key_redirect_from, true ),
'redirect_to' => get_post_meta( $redirect->ID, $this->meta_key_redirect_to, true ),
'status_code' => (int)get_post_meta( $redirect->ID, $this->meta_key_redirect_status_code, true ),
'enable_regex' => (bool)get_post_meta( $redirect->ID, $this->meta_key_enable_redirect_from_regex, true ),
);
}
if ( count( $redirects ) == $this->default_max_redirects
|| count( $redirect_query->posts ) < $posts_per_page )
$build = false;
else
$build = true;
$i++;
} while ( $build );
return $redirects;
}
/**
* Force update on the redirect cache and return cache
*
* @since 1.0
* @uses set_transient, get_post_meta, the_post, have_posts, get_the_ID
* @return array
*/
public function update_redirect_cache() {
$redirect_cache = $this->get_redirects();
set_transient( $this->cache_key_redirects, $redirect_cache );
return $redirect_cache;
}
/**
* Check current url against redirects
*
* @since 1.0
* @uses esc_url_raw, wp_safe_redirect, untrailingslashit, get_transient, add_filter
* @return void
*/
public function action_parse_request() {
// Don't redirect from wp-admin
if ( is_admin() )
return;
// get redirects from cache or recreate it
if ( false === ( $redirects = get_transient( $this->cache_key_redirects ) ) ) {
$redirects = $this->update_redirect_cache();
}
// If we have no redirects, there is no need to continue
if ( empty( $redirects ) )
return;
// get requested path and add a / before it
$requested_path = esc_url_raw( $_SERVER['REQUEST_URI'] );
$requested_path = stripslashes( $requested_path );
$requested_path = untrailingslashit( $requested_path );
if ( empty( $requested_path ) ){
$requested_path = '/';
}
/**
* If WordPress resides in a directory that is not the public root, we have to chop
* the pre-WP path off the requested path.
*/
$parsed_home_url = parse_url( home_url() );
if ( isset( $parsed_home_url['path'] ) && '/' != $parsed_home_url['path'] ) {
$requested_path = preg_replace( '@' . $parsed_home_url['path'] . '@i', '', $requested_path, 1 );
}
// Allow redirects to be filtered
$redirects = apply_filters( 'srm_registered_redirects', $redirects, $requested_path );
// Allow for case insensitive redirects
$case_insensitive = apply_filters( 'srm_case_insensitive_redirects', true );
if ( $case_insensitive ) {
$regex_flag = 'i';
// normalized path is used for matching but not for replace
$normalized_requested_path = strtolower( $requested_path );
} else {
$regex_flag = '';
$normalized_requested_path = $requested_path;
}
foreach ( (array)$redirects as $redirect ) {
$redirect_from = untrailingslashit( $redirect['redirect_from'] );
if ( empty( $redirect_from ) )
$redirect_from = '/'; // this only happens in the case where there is a redirect on the root
$redirect_to = $redirect['redirect_to'];
$status_code = $redirect['status_code'];
$enable_regex = ( isset( $redirect['enable_regex'] ) ) ? $redirect['enable_regex'] : false;
// check if the redirection destination is valid, otherwise just skip it
if ( empty( $redirect_to ) )
continue;
// check if requested path is the same as the redirect from path
if ( $enable_regex ) {
$matched_path = preg_match( '@' . $redirect_from . '@' . $regex_flag, $requested_path );
} else {
if ( $case_insensitive ) {
$redirect_from = strtolower( $redirect_from );
}
$matched_path = ( $normalized_requested_path == $redirect_from );
// check if the redirect_from ends in a wildcard
if ( !$matched_path && (strrpos( $redirect_from, '*' ) === strlen( $redirect_from ) - 1) ) {
$wildcard_base = substr( $redirect_from, 0, strlen( $redirect_from ) - 1 );
// mark as match if requested path matches the base of the redirect from
$matched_path = (substr( $normalized_requested_path, 0, strlen( $wildcard_base ) ) == $wildcard_base);
if ( (strrpos( $redirect_to, '*' ) == strlen( $redirect_to ) - 1 ) ) {
$redirect_to = rtrim( $redirect_to, '*' ) . ltrim( substr( $requested_path, strlen( $wildcard_base ) ), '/' );
}
}
}
if ( $matched_path ) {
// whitelist redirect to host if necessary
$parsed_redirect = parse_url( $redirect_to );
if ( is_array( $parsed_redirect ) && ! empty( $parsed_redirect['host'] ) ) {
$this->whitelist_hosts[] = $parsed_redirect['host'];
add_filter( 'allowed_redirect_hosts' , array( $this, 'filter_allowed_redirect_hosts' ) );
}
// Allow for regex replacement in $redirect_to
if ( $enable_regex ) {
$redirect_to = preg_replace( '@' . $redirect_from . '@' . $regex_flag, $redirect_to, $requested_path );
}
$sanitized_redirect_to = esc_url_raw( $redirect_to );
do_action( 'srm_do_redirect', $requested_path, $sanitized_redirect_to, $status_code );
if ( defined( 'PHPUNIT_SRM_TESTSUITE' ) && PHPUNIT_SRM_TESTSUITE ) {
// Don't actually redirect if we are testing
return;
}
header( 'X-Safe-Redirect-Manager: true' );
// if we have a valid status code, then redirect with it
if ( in_array( $status_code, $this->valid_status_codes ) )
wp_safe_redirect( $sanitized_redirect_to, $status_code );
else
wp_safe_redirect( $sanitized_redirect_to );
exit;
}
}
}
/**
* Sanitize redirect to path
*
* The only difference between this function and just calling esc_url_raw is
* esc_url_raw( 'test' ) == 'http://test', whereas sanitize_redirect_path( 'test' ) == '/test'
*
* @since 1.0
* @param string $path
* @uses esc_url_raw
* @return string
*/
public function sanitize_redirect_to( $path ) {
$path = trim( $path );
if ( preg_match( '/^www\./i', $path ) )
$path = 'http://' . $path;
if ( ! preg_match( '/^https?:\/\//i', $path ) )
if ( strpos( $path, '/' ) !== 0 )
$path = '/' . $path;
return esc_url_raw( $path );
}
/**
* Sanitize redirect from path
*
* @since 1.0
* @param string $path
* @param boolean $allow_regex
* @uses esc_url_raw
* @return string
*/
public function sanitize_redirect_from( $path, $allow_regex = false ) {
$path = trim( $path );
if ( empty( $path ) )
return '';
// dont accept paths starting with a .
if ( ! $allow_regex && strpos( $path, '.' ) === 0 )
return '';
// turn path in to absolute
if ( preg_match( '/https?:\/\//i', $path ) )
$path = preg_replace( '/^(http:\/\/|https:\/\/)(www\.)?[^\/?]+\/?(.*)/i', '/$3', $path );
elseif ( ! $allow_regex && strpos( $path, '/' ) !== 0 )
$path = '/' . $path;
// the @ symbol will break our regex engine
$path = str_replace( '@', '', $path );
return $path;
}
/**
* Return a permalink for a redirect post, which is the "redirect from"
* URL for that redirect.
*
* @since 1.7
* @param string $permalink The permalink
* @param object $post A Post object
* @uses home_url, get_post_meta
* @return string The permalink
*/
public function filter_post_type_link( $permalink, $post ) {
if ( $this->redirect_post_type != $post->post_type )
return $permalink;
// We can't do anything to provide a permalink
// for regex enabled redirects.
if ( get_post_meta( $post->ID, $this->meta_key_enable_redirect_from_regex, true ) )
return $permalink;
// We can't do anything if there is a wildcard in the redirect from
$redirect_from = get_post_meta( $post->ID, $this->meta_key_redirect_from, true );
if ( false !== strpos( $redirect_from, '*' ) )
return $permalink;
// Use default permalink if no $redirect_from exists - this prevents duplicate GUIDs
if ( empty( $redirect_from ) ) {
return $permalink;
}
return home_url( $redirect_from );
}
/**
* Imports redirects from CSV file or stream.
*
* @since 1.7.6
*
* @access public
* @param string|resource $file File path, file pointer or stream to read redirects from.
* @param array $args The array of arguments. Includes column mapping and CSV settings.
* @return array Returns importing statistic on success, otherwise FALSE.
*/
public function import_file( $file, $args ) {
$handle = $file;
$close_handle = false;
$doing_wp_cli = defined( 'WP_CLI' ) && WP_CLI;