This repository has been archived by the owner on Jul 25, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 47
/
varnish-http-purge.php
executable file
·1134 lines (1003 loc) · 36.1 KB
/
varnish-http-purge.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: Proxy Cache Purge
* Plugin URI: https://github.com/ipstenu/varnish-http-purge/
* Description: Automatically empty cached pages when content on your site is modified.
* Version: 5.2.0
* Author: Mika Epstein
* Author URI: https://halfelf.org/
* License: http://www.apache.org/licenses/LICENSE-2.0
* Text Domain: varnish-http-purge
* Network: true
*
* @package varnish-http-purge
*
* Copyright 2016-2023 Mika Epstein (email: [email protected])
*
* This file is part of Proxy Cache Purge (formerly Varnish HTTP Purge), a
* plugin for WordPress.
*
* Proxy Cache Purge is free software: you can redistribute it and/or modify
* it under the terms of the Apache License 2.0 license.
*
* Proxy Cache Purge 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.
*/
/**
* Purge Class
*
* @since 2.0
*/
class VarnishPurger {
/**
* Version Number
* @var string
*/
public static $version = '5.2.0';
/**
* List of URLs to be purged
*
* (default value: array())
*
* @var array
* @access protected
*/
protected $purge_urls = array();
/**
* Devmode options
*
* (default value: array())
*
* @var array
* @access public
* @static
*/
public static $devmode = array();
/**
* Init
*
* @since 2.0
* @access public
*/
public function __construct() {
defined( 'VHP_VARNISH_IP' ) || define( 'VHP_VARNISH_IP', false );
defined( 'VHP_DEVMODE' ) || define( 'VHP_DEVMODE', false );
defined( 'VHP_DOMAINS' ) || define( 'VHP_DOMAINS', false );
// Development mode defaults to off.
self::$devmode = array(
'active' => false,
'expire' => time(),
);
if ( ! get_site_option( 'vhp_varnish_devmode' ) ) {
update_site_option( 'vhp_varnish_devmode', self::$devmode );
}
// Default URL is home.
if ( ! get_site_option( 'vhp_varnish_url' ) ) {
update_site_option( 'vhp_varnish_url', $this->the_home_url() );
}
// Default IP is nothing.
if ( ! get_site_option( 'vhp_varnish_ip' ) && ! VHP_VARNISH_IP ) {
update_site_option( 'vhp_varnish_ip', '' );
}
// Default Debug is the home.
if ( ! get_site_option( 'vhp_varnish_debug' ) ) {
update_site_option( 'vhp_varnish_debug', array( $this->the_home_url() => array() ) );
}
// Default Max posts to purge before purge all happens instead.
if ( ! get_site_option( 'vhp_varnish_max_posts_before_all' ) ) {
update_site_option( 'vhp_varnish_max_posts_before_all', 50 );
}
// Release the hounds!
add_action( 'init', array( &$this, 'init' ) );
add_action( 'admin_init', array( &$this, 'admin_init' ) );
add_action( 'import_start', array( &$this, 'import_start' ) );
add_action( 'import_end', array( &$this, 'import_end' ) );
// Check if there's an upgrade
add_action( 'upgrader_process_complete', array( &$this, 'check_upgrades' ), 10, 2 );
}
/**
* Admin Init
*
* @since 4.1
* @access public
*/
public function admin_init() {
global $pagenow;
// If WordPress.com Master Bar is active, show the activity box.
if ( class_exists( 'Jetpack' ) && Jetpack::is_module_active( 'masterbar' ) ) {
add_action( 'activity_box_end', array( $this, 'varnish_rightnow' ), 100 );
}
// Failure: Pre WP 4.7.
if ( version_compare( get_bloginfo( 'version' ), '4.7', '<=' ) ) {
deactivate_plugins( plugin_basename( __FILE__ ) );
add_action( 'admin_notices', array( $this, 'require_wp_version_notice' ) );
return;
}
// Admin notices.
if ( current_user_can( 'manage_options' ) && 'site-health.php' !== $pagenow ) {
// Warning: Debug is active.
if ( VarnishDebug::devmode_check() ) {
add_action( 'admin_notices', array( $this, 'devmode_is_active_notice' ) );
}
// Warning: No Pretty Permalinks!
if ( '' === get_site_option( 'permalink_structure' ) ) {
add_action( 'admin_notices', array( $this, 'require_pretty_permalinks_notice' ) );
}
}
}
/**
* Plugin Init
*
* @since 1.0
* @access public
*/
public function init() {
global $blog_id, $wp_db_version;
// If the DB version we detect isn't the same as the version core thinks
// we will flush DB cache. This may cause double dumping in some cases but
// should not be harmful.
if ( file_exists( WP_CONTENT_DIR . '/object-cache.php' ) && (int) get_option( 'db_version' ) !== $wp_db_version ) {
wp_cache_flush();
}
// If Dev Mode is true, kill caching.
if ( VarnishDebug::devmode_check() ) {
if ( ! is_admin() ) {
// Sessions used to break PHP caching.
// @codingStandardsIgnoreStart
if ( ! is_user_logged_in() && session_status() != PHP_SESSION_ACTIVE ) {
@session_start();
}
// @codingStandardsIgnoreEnd
// Add nocache to CSS and JS.
add_filter( 'style_loader_src', array( 'VarnishDebug', 'nocache_cssjs' ), 10, 2 );
add_filter( 'script_loader_src', array( 'VarnishDebug', 'nocache_cssjs' ), 10, 2 );
}
}
// get my events.
$events = $this->get_register_events();
$no_id_events = $this->get_no_id_events();
// make sure we have events and they're in an array.
if ( ! empty( $events ) && ! empty( $no_id_events ) ) {
// Force it to be an array, in case someone's stupid.
$events = (array) $events;
$no_id_events = (array) $no_id_events;
// Add the action for each event.
foreach ( $events as $event ) {
if ( in_array( $event, $no_id_events, true ) ) {
// These events have no post ID and, thus, will perform a full purge.
add_action( $event, array( $this, 'execute_purge_no_id' ) );
} else {
add_action( $event, array( $this, 'purge_post' ), 10, 2 );
}
}
}
add_action( 'shutdown', array( $this, 'execute_purge' ) );
// Success: Admin notice when purging.
if ( ( isset( $_GET['vhp_flush_all'] ) && check_admin_referer( 'vhp-flush-all' ) ) ||
( isset( $_GET['vhp_flush_do'] ) && check_admin_referer( 'vhp-flush-do' ) ) ) {
if ( 'devmode' === $_GET['vhp_flush_do'] && isset( $_GET['vhp_set_devmode'] ) ) {
VarnishDebug::devmode_toggle( esc_attr( $_GET['vhp_set_devmode'] ) );
add_action( 'admin_notices', array( $this, 'admin_message_devmode' ) );
} else {
add_action( 'admin_notices', array( $this, 'admin_message_purge' ) );
}
}
// Add Admin Bar.
add_action( 'admin_bar_menu', array( $this, 'varnish_rightnow_adminbar' ), 100 );
add_action( 'admin_enqueue_scripts', array( $this, 'custom_css' ) );
add_action( 'wp_enqueue_scripts', array( $this, 'custom_css' ) );
}
/**
* Check if something has upgraded and try to flush the DB cache.
* This runs for ALL upgrades (theme, plugin, and core) to account for
* the complex nature that are upgrades.
*
* @param array $object of upgrade data
* @param array $options picked for upgrade
* @since 4.8
*/
public function check_upgrades( $object, $options ) {
if ( file_exists( WP_CONTENT_DIR . '/object-cache.php' ) ) {
wp_cache_flush();
}
}
/**
* Pause caching if Importer was started
* @since 4.8
*/
public function import_start() {
VarnishDebug::devmode_toggle( 'activate' );
}
/**
* Resume caching if Importer has ended
* @since 4.8
*/
public function import_end() {
VarnishDebug::devmode_toggle( 'deactivate' );
}
/**
* Purge Message
* Informs of a successful purge
*
* @since 4.6
*/
public function admin_message_purge() {
echo '<div id="message" class="notice notice-success fade is-dismissible"><p><strong>' . esc_html__( 'Cache emptied!', 'varnish-http-purge' ) . '</strong></p></div>';
}
/**
* Devmode Message
* Informs of a toggle in Devmode
*
* @since 4.6
*/
public function admin_message_devmode() {
$message = ( VarnishDebug::devmode_check() ) ? __( 'Development Mode activated for the next 24 hours.', 'varnish-http-purge' ) : __( 'Development Mode deactivated.', 'varnish-http-purge' );
echo '<div id="message" class="notice notice-success fade is-dismissible"><p><strong>' . wp_kses_post( $message ) . '</strong></p></div>';
}
/**
* Require: Pretty Permalinks Message
* Explains you need Pretty Permalinks enabled to use this plugin
*
* @since 2.0
*/
public function require_pretty_permalinks_notice() {
// translators: The URL should link to the permalinks page.
echo wp_kses_post( '<div id="message" class="error"><p>' . sprintf( __( 'Proxy Cache Purge requires you to use custom permalinks. Please go to the <a href="%1$s">Permalinks Options Page</a> to configure them.', 'varnish-http-purge' ), esc_url( admin_url( 'options-permalink.php' ) ) ) . '</p></div>' );
}
/**
* Require: WP Version Message
* Explains you need WordPress 4.7+ to use this plugin
*
* @since 4.1
*/
public function require_wp_version_notice() {
// translators: The URL should link to the update core page.
echo "<div id='message' class='error'><p>" . sprintf( esc_html__( 'Proxy Cache Purge requires WordPress 4.7 or greater. Please <a href="%1$s">upgrade WordPress</a>.', 'varnish-http-purge' ), esc_url( admin_url( 'update-core.php' ) ) ) . '</p></div>';
}
/**
* Warning: Development Mode
* Checks if DevMode is active
*
* @since 4.6.0
*/
public function devmode_is_active_notice() {
if ( VHP_DEVMODE ) {
$message = __( 'Proxy Cache Purge Development Mode has been activated via wp-config.', 'varnish-http-purge' );
} else {
$devmode = get_site_option( 'vhp_varnish_devmode', self::$devmode );
$time = human_time_diff( time(), $devmode['expire'] );
if ( ! $devmode['active'] ) {
if ( ! is_multisite() ) {
// translators: %1$s is the time until dev mode expires.
// translators: %2$s is a link to the settings pages.
$message = sprintf( __( 'Proxy Cache Purge Development Mode is active for the next %1$s. You can disable this at the <a href="%2$s">Proxy Settings Page</a>.', 'varnish-http-purge' ), $time, esc_url( admin_url( 'admin.php?page=varnish-page' ) ) );
} else {
// translators: %1$s is the time until dev mode expires.
$message = sprintf( __( 'Proxy Cache Purge Development Mode is active for the next %1$s.', 'varnish-http-purge' ), $time );
}
}
}
// Only echo if there's actually a message
if ( isset( $message ) ) {
echo '<div class="notice notice-warning"><p>' . wp_kses_post( $message ) . '</p></div>';
}
}
/**
* The Home URL
* Get the Home URL and allow it to be filterable
* This is for domain mapping plugins that, for some reason, don't filter
* on their own (including WPMU, Ron's, and so on).
*
* @since 4.0
*/
public static function the_home_url() {
$home_url = apply_filters( 'vhp_home_url', home_url() );
return $home_url;
}
/**
* Custom CSS to allow for colouring.
*
* @since 4.5.0
*/
public function custom_css() {
if ( is_user_logged_in() && is_admin_bar_showing() ) {
wp_register_style( 'varnish_http_purge', plugins_url( 'style.css', __FILE__ ), false, self::$version );
wp_enqueue_style( 'varnish_http_purge' );
}
}
/**
* Purge Button in the Admin Bar
*
* @access public
* @param mixed $admin_bar - data passed back from admin bar.
* @return void
*/
public function varnish_rightnow_adminbar( $admin_bar ) {
global $wp;
$can_purge = false;
$cache_active = ( VarnishDebug::devmode_check() ) ? __( 'Inactive', 'varnish-http-purge' ) : __( 'Active', 'varnish-http-purge' );
// translators: %s is the state of cache.
$cache_titled = sprintf( __( 'Cache (%s)', 'varnish-http-purge' ), $cache_active );
if ( ( ! is_admin() && get_post() !== false && current_user_can( 'edit_published_posts' ) ) || current_user_can( 'activate_plugins' ) ) {
// Main Array.
$args = array(
array(
'id' => 'purge-varnish-cache',
'title' => '<span class="ab-icon" style="background-image: url(' . self::get_icon_svg() . ') !important;"></span><span class="ab-label">' . $cache_titled . '</span>',
'meta' => array(
'class' => 'varnish-http-purge',
),
),
);
$can_purge = true;
}
// Checking user permissions for who can and cannot use the all flush.
if (
// SingleSite - admins can always purge.
( ! is_multisite() && current_user_can( 'activate_plugins' ) ) ||
// Multisite - Network Admin can always purge.
current_user_can( 'manage_network' ) ||
// Multisite - Site admins can purge UNLESS it's a subfolder install and we're on site #1.
( is_multisite() && current_user_can( 'activate_plugins' ) && ( SUBDOMAIN_INSTALL || ( ! SUBDOMAIN_INSTALL && ( BLOG_ID_CURRENT_SITE !== $blog_id ) ) ) )
) {
$args[] = array(
'parent' => 'purge-varnish-cache',
'id' => 'purge-varnish-cache-all',
'title' => __( 'Purge Cache (All Pages)', 'varnish-http-purge' ),
'href' => wp_nonce_url( add_query_arg( 'vhp_flush_do', 'all' ), 'vhp-flush-do' ),
'meta' => array(
'title' => __( 'Purge Cache (All Pages)', 'varnish-http-purge' ),
),
);
// If a memcached file is found, we can do this too.
if ( file_exists( WP_CONTENT_DIR . '/object-cache.php' ) ) {
$args[] = array(
'parent' => 'purge-varnish-cache',
'id' => 'purge-varnish-cache-db',
'title' => __( 'Purge Database Cache', 'varnish-http-purge' ),
'href' => wp_nonce_url( add_query_arg( 'vhp_flush_do', 'object' ), 'vhp-flush-do' ),
'meta' => array(
'title' => __( 'Purge Database Cache', 'varnish-http-purge' ),
),
);
}
// If Devmode is in the config, don't allow it to be disabled.
if ( ! VHP_DEVMODE ) {
// Populate enable/disable cache button.
if ( VarnishDebug::devmode_check() ) {
$purge_devmode_title = __( 'Restart Cache', 'varnish-http-purge' );
$vhp_add_query_arg = array(
'vhp_flush_do' => 'devmode',
'vhp_set_devmode' => 'deactivate',
);
} else {
$purge_devmode_title = __( 'Pause Cache (24h)', 'varnish-http-purge' );
$vhp_add_query_arg = array(
'vhp_flush_do' => 'devmode',
'vhp_set_devmode' => 'activate',
);
}
$args[] = array(
'parent' => 'purge-varnish-cache',
'id' => 'purge-varnish-cache-devmode',
'title' => $purge_devmode_title,
'href' => wp_nonce_url( add_query_arg( $vhp_add_query_arg ), 'vhp-flush-do' ),
'meta' => array(
'title' => $purge_devmode_title,
),
);
}
}
// If we're on a front end page AND the current user can edit published posts, then they can do this.
if ( ! is_admin() && get_post() !== false && current_user_can( 'edit_published_posts' ) ) {
$page_url = esc_url( home_url( $wp->request ) );
$args[] = array(
'parent' => 'purge-varnish-cache',
'id' => 'purge-varnish-cache-this',
'title' => __( 'Purge Cache (This Page)', 'varnish-http-purge' ),
'href' => wp_nonce_url( add_query_arg( 'vhp_flush_do', $page_url . '/' ), 'vhp-flush-do' ),
'meta' => array(
'title' => __( 'Purge Cache (This Page)', 'varnish-http-purge' ),
),
);
}
if ( $can_purge ) {
foreach ( $args as $arg ) {
$admin_bar->add_node( $arg );
}
}
}
/**
* Get the icon as SVG.
*
* Forked from Yoast SEO
*
* @access public
* @param bool $base64 (default: true) - Use SVG, true/false?
* @param string $icon_color - What color to use.
* @return string
*/
public static function get_icon_svg( $base64 = true, $icon_color = false ) {
global $_wp_admin_css_colors;
$fill = ( false !== $icon_color ) ? sanitize_hex_color( $icon_color ) : '#82878c';
if ( is_admin() && false === $icon_color && get_user_option( 'admin_color' ) ) {
$admin_colors = json_decode( wp_json_encode( $_wp_admin_css_colors ), true );
$current_color = get_user_option( 'admin_color' );
$fill = $admin_colors[ $current_color ]['icon_colors']['base'];
}
// Flat
$svg = '<svg version="1.1" xmlns="http://www.w3.org/2000/svg" xml:space="preserve" width="100%" height="100%" style="fill:' . $fill . '" viewBox="0 0 36.2 34.39" role="img" aria-hidden="true" focusable="false"><g id="Layer_2" data-name="Layer 2"><g id="Layer_1-2" data-name="Layer 1"><path fill="' . $fill . '" d="M24.41,0H4L0,18.39H12.16v2a2,2,0,0,0,4.08,0v-2H24.1a8.8,8.8,0,0,1,4.09-1Z"/><path fill="' . $fill . '" d="M21.5,20.4H18.24a4,4,0,0,1-8.08,0v0H.2v8.68H19.61a9.15,9.15,0,0,1-.41-2.68A9,9,0,0,1,21.5,20.4Z"/><path fill="' . $fill . '" d="M28.7,33.85a7,7,0,1,1,7-7A7,7,0,0,1,28.7,33.85Zm-1.61-5.36h5V25.28H30.31v-3H27.09Z"/><path fill="' . $fill . '" d="M28.7,20.46a6.43,6.43,0,1,1-6.43,6.43,6.43,6.43,0,0,1,6.43-6.43M26.56,29h6.09V24.74H30.84V21.8H26.56V29m2.14-9.64a7.5,7.5,0,1,0,7.5,7.5,7.51,7.51,0,0,0-7.5-7.5ZM27.63,28V22.87h2.14v2.95h1.81V28Z"/></g></g></svg>';
if ( $base64 ) {
return 'data:image/svg+xml;base64,' . base64_encode( $svg );
}
return $svg;
}
/**
* Varnish Right Now Information
* This information is put on the Dashboard 'Right now' widget
*
* @since 1.0
*/
public function varnish_rightnow() {
global $blog_id;
// translators: %1$s links to the plugin's page on WordPress.org.
$intro = sprintf( __( '<a href="%1$s">Proxy Cache Purge</a> automatically deletes your cached posts when published or updated. When making major site changes, such as with a new theme, plugins, or widgets, you may need to manually empty the cache.', 'varnish-http-purge' ), 'http://wordpress.org/plugins/varnish-http-purge/' );
$url = wp_nonce_url( add_query_arg( 'vhp_flush_do', 'all' ), 'vhp-flush-do' );
$button = __( 'Press the button below to force it to empty your entire cache.', 'varnish-http-purge' );
$button .= '</p><p><span class="button"><strong><a href="' . $url . '">';
$button .= __( 'Empty Cache', 'varnish-http-purge' );
$button .= '</a></strong></span>';
$nobutton = __( 'You do not have permission to empty the proxy cache for the whole site. Please contact your administrator.', 'varnish-http-purge' );
if (
// SingleSite - admins can always purge.
( ! is_multisite() && current_user_can( 'activate_plugins' ) ) ||
// Multisite - Network Admin can always purge.
current_user_can( 'manage_network' ) ||
// Multisite - Site admins can purge UNLESS it's a subfolder install and we're on site #1.
( is_multisite() && current_user_can( 'activate_plugins' ) && ( SUBDOMAIN_INSTALL || ( ! SUBDOMAIN_INSTALL && ( BLOG_ID_CURRENT_SITE !== $blog_id ) ) ) )
) {
$text = $intro . ' ' . $button;
} else {
$text = $intro . ' ' . $nobutton;
}
// @codingStandardsIgnoreStart
// This is safe to echo as it's controlled and secured above.
// Using wp_kses will delete the icon.
echo '<p class="varnish-rightnow">' . $text . '</p>';
// @codingStandardsIgnoreEnd
}
/**
* Registered Events
* These are when the purge is triggered
*
* @since 1.0
* @access protected
*/
protected function get_register_events() {
// Define registered purge events.
$actions = array(
'autoptimize_action_cachepurged', // Compat with https://wordpress.org/plugins/autoptimize/ plugin.
'delete_attachment', // Delete an attachment - includes re-uploading.
'deleted_post', // Delete a post.
'edit_post', // Edit a post - includes leaving comments.
'import_start', // When importer starts
'import_end', // When importer ends
'save_post', // Save a post.
'switch_theme', // After a theme is changed.
'customize_save_after', // After Customizer is updated.
'trashed_post', // Empty Trashed post.
);
// send back the actions array, filtered.
// @param array $actions the actions that trigger the purge event.
return apply_filters( 'varnish_http_purge_events', $actions );
}
/**
* Events that have no post IDs
* These are when a full purge is triggered
*
* @since 3.9
* @access protected
*/
protected function get_no_id_events() {
// Define registered purge events.
$actions = array(
'autoptimize_action_cachepurged', // Compat with https://wordpress.org/plugins/autoptimize/ plugin.
'import_start', // When importer starts
'import_end', // When importer ends
'switch_theme', // After a theme is changed.
'customize_save_after', // After Customizer is updated.
);
/**
* Send back the actions array, filtered
*
* @param array $actions the actions that trigger the purge event
*
* DEVELOPERS! USE THIS SPARINGLY! YOU'RE A GREAT BIG 💩 IF YOU USE IT FLAGRANTLY
* Remember to add your action to this AND varnish_http_purge_events due to shenanigans
*/
return apply_filters( 'varnish_http_purge_events_full', $actions );
}
/**
* Execute Purge
* Run the purge command for the URLs. Calls $this->purge_url for each URL
*
* @since 1.0
* @access protected
*/
public function execute_purge() {
$purge_urls = array_unique( $this->purge_urls );
if ( ! empty( $purge_urls ) && is_array( $purge_urls ) ) {
// If there are URLs to purge and it's an array, we'll likely purge.
// Number of URLs to purge.
$count = count( $purge_urls );
// Max posts
if ( defined( 'VHP_VARNISH_MAXPOSTS' ) && false !== VHP_VARNISH_MAXPOSTS ) {
$max_posts = VHP_VARNISH_MAXPOSTS;
} else {
$max_posts = get_site_option( 'vhp_varnish_max_posts_before_all' );
}
// If there are more than vhp_varnish_max_posts_before_all URLs to purge (default 50),
// do a purge ALL instead. Else, do the normal.
if ( $max_posts <= $count ) {
// Too many URLs, purge all instead.
$this->purge_url( $this->the_home_url() . '/?vhp-regex' );
} else {
// Purge each URL.
foreach ( $purge_urls as $url ) {
$this->purge_url( $url );
}
}
} elseif ( isset( $_GET ) ) {
// Otherwise, if we've passed a GET call...
if ( isset( $_GET['vhp_flush_all'] ) && check_admin_referer( 'vhp-flush-all' ) ) {
// Flush Cache recursive.
$this->purge_url( $this->the_home_url() . '/?vhp-regex' );
} elseif ( isset( $_GET['vhp_flush_do'] ) && check_admin_referer( 'vhp-flush-do' ) ) {
if ( 'object' === $_GET['vhp_flush_do'] ) {
// Flush Object Cache (with a double check).
if ( file_exists( WP_CONTENT_DIR . '/object-cache.php' ) ) {
wp_cache_flush();
}
} elseif ( 'all' === $_GET['vhp_flush_do'] ) {
// Flush Cache recursive.
$this->purge_url( $this->the_home_url() . '/?vhp-regex' );
} else {
// Flush the URL we're on.
$p = wp_parse_url( esc_url_raw( wp_unslash( $_GET['vhp_flush_do'] ) ) );
if ( ! isset( $p['host'] ) ) {
return;
}
$this->purge_url( esc_url_raw( wp_unslash( $_GET['vhp_flush_do'] ) ) );
}
}
}
}
/**
* Purge URL
* Parse the URL for proxy proxies
*
* @since 1.0
* @param array $url - The url to be purged.
* @access protected
*/
public static function purge_url( $url ) {
// Bail early if someone sent a non-URL
if ( false === filter_var( $url, FILTER_VALIDATE_URL ) ) {
return;
}
$p = wp_parse_url( $url );
// Bail early if there's no host since some plugins are weird.
if ( ! isset( $p['host'] ) ) {
return;
}
// Determine if we're using regex to flush all pages or not.
$pregex = '';
$x_purge_method = 'default';
if ( isset( $p['query'] ) && ( 'vhp-regex' === $p['query'] ) ) {
$pregex = '.*';
$x_purge_method = 'regex';
}
// Build a varniship to sail. ⛵️
$varniship = ( VHP_VARNISH_IP !== false ) ? VHP_VARNISH_IP : get_site_option( 'vhp_varnish_ip' );
// If there are commas, and for whatever reason this didn't become an array
// properly, force it.
if ( ! is_array( $varniship ) && strpos( $varniship, ',' ) !== false ) {
$varniship = array_map( 'trim', explode( ',', $varniship ) );
}
// Now apply filters
if ( is_array( $varniship ) ) {
// To each ship:
for ( $i = 0; $i++; $i < count( $varniship ) ) {
$varniship[ $i ] = apply_filters( 'vhp_varnish_ip', $varniship[ $i ] );
}
} else {
// To the only ship:
$varniship = apply_filters( 'vhp_varnish_ip', $varniship );
}
// Determine the path.
$path = ( isset( $p['path'] ) ) ? $p['path'] : '';
/**
* Schema filter
*
* Allows default http:// schema to be changed to https
* varnish_http_purge_schema()
*
* @since 3.7.3
*/
// This is a very annoying check for DreamHost who needs to default to HTTPS without breaking
// people who've been around before.
$server_hostname = gethostname();
switch ( substr( $server_hostname, 0, 3 ) ) {
case 'dp-':
$schema_type = 'https://';
break;
default:
$schema_type = 'http://';
break;
}
$schema = apply_filters( 'varnish_http_purge_schema', $schema_type );
// When we have Varnish IPs, we use them in lieu of hosts.
if ( isset( $varniship ) && ! empty( $varniship ) ) {
$all_hosts = ( ! is_array( $varniship ) ) ? array( $varniship ) : $varniship;
} else {
// The default is the main host, converted into an array.
$all_hosts = array( $p['host'] );
}
// Since the ship is always an array now, let's loop.
foreach ( $all_hosts as $one_host ) {
/**
* Allow setting of ports in host name
* Credit: davidbarratt - https://github.com/Ipstenu/varnish-http-purge/pull/38/
*
* (default value: $p['host'])
*
* @var string
* @access public
* @since 4.4.0
*/
$host_headers = $p['host'];
// If the URL to be purged has a port, we're going to re-use it.
if ( isset( $p['port'] ) ) {
$host_headers .= ':' . $p['port'];
}
$parsed_url = $url;
// Filter URL based on the Proxy IP for nginx compatibility
if ( 'localhost' === $one_host ) {
$parsed_url = str_replace( $p['host'], 'localhost', $parsed_url );
}
// Create path to purge.
$purgeme = $schema . $one_host . $path . $pregex;
// Check the queries...
if ( ! empty( $p['query'] ) && 'vhp-regex' !== $p['query'] ) {
$purgeme .= '?' . $p['query'];
}
/**
* Filter the purge path
*
* Allows dynamically changing the purge cache for custom purge location
* or systems not supporting .* regex purge for example
*
* @since 5.1
*/
$purgeme = apply_filters( 'vhp_purgeme_path', $purgeme, $schema, $one_host, $path, $pregex, $p );
/**
* Filters the HTTP headers to send with a PURGE request.
*
* @since 4.1
*/
$headers = apply_filters(
'varnish_http_purge_headers',
array(
'host' => $host_headers,
'X-Purge-Method' => $x_purge_method,
)
);
// Send response.
// SSL Verify is required here since Varnish is HTTP only, but proxies are a thing.
$response = wp_remote_request(
$purgeme,
array(
'sslverify' => false,
'method' => 'PURGE',
'headers' => $headers,
)
);
do_action( 'after_purge_url', $parsed_url, $purgeme, $response, $headers );
}
}
/**
* Purge - No IDs
* Flush the whole cache
*
* @access public
* @param mixed $post_id - the post ID that triggered this (we don't use it yet).
* @return void
* @since 3.9
*/
public function execute_purge_no_id( $post_id ) {
$listofurls = array();
array_push( $listofurls, $this->the_home_url() . '/?vhp-regex' );
// Now flush all the URLs we've collected provided the array isn't empty.
if ( ! empty( $listofurls ) ) {
foreach ( $listofurls as $url ) {
array_push( $this->purge_urls, $url );
}
}
do_action( 'after_full_purge' );
}
/**
* Generate URLs
*
* Generates a list of URLs that should be purged, based on the post ID
* passed through. Useful for when you're trying to get a post to flush
* another post.
*
* @access public
* @param mixed $post_id - The ID of the post to be purged.
* @return array()
*/
public function generate_urls( $post_id ) {
$this->purge_post( $post_id );
return $this->purge_urls;
}
/**
* Purge Post
* Flush the post
*
* @since 1.0
* @param array $post_id - The ID of the post to be purged.
* @access public
*/
public function purge_post( $post_id ) {
/**
* If this is a valid post we want to purge the post,
* the home page and any associated tags and categories
*/
$valid_post_status = array( 'publish', 'private', 'trash', 'pending', 'draft' );
$this_post_status = get_post_status( $post_id );
// Not all post types are created equal.
$invalid_post_type = array( 'nav_menu_item', 'revision' );
$noarchive_post_type = array( 'post', 'page' );
$this_post_type = get_post_type( $post_id );
/**
* Determine the route for the rest API
* This will need to be revisited if WP updates the version.
* Future me: Consider an array? 4.7-?? use v2, and then adapt from there?
*/
if ( version_compare( get_bloginfo( 'version' ), '4.7', '>=' ) ) {
$json_disabled = false;
$json_disablers = array(
'disable-json-api/disable-json-api.php',
);
foreach ( $json_disablers as $json_plugin ) {
if ( function_exists( 'is_plugin_active' ) && is_plugin_active( $json_plugin ) ) {
$json_disabled = true;
}
}
// If json is NOT disabled...
if ( ! $json_disabled ) {
$rest_api_route = 'wp/v2';
}
}
// array to collect all our URLs.
$listofurls = array();
// Verify we have a permalink and that we're a valid post status and type.
if ( false !== get_permalink( $post_id ) && in_array( $this_post_status, $valid_post_status, true ) && ! in_array( $this_post_type, $invalid_post_type, true ) ) {
// Post URL.
array_push( $listofurls, get_permalink( $post_id ) );
/**
* JSON API Permalink for the post based on type
* We only want to do this if the rest_base exists
* But we apparently have to force it for posts and pages (seriously?)
*/
if ( isset( $rest_api_route ) ) {
$post_type_object = get_post_type_object( $post_id );
$rest_permalink = false;
if ( isset( $post_type_object->rest_base ) ) {
$rest_permalink = get_rest_url() . $rest_api_route . '/' . $post_type_object->rest_base . '/' . $post_id . '/';
} elseif ( 'post' === $this_post_type ) {
$rest_permalink = get_rest_url() . $rest_api_route . '/posts/' . $post_id . '/';
} elseif ( 'page' === $this_post_type ) {
$rest_permalink = get_rest_url() . $rest_api_route . '/pages/' . $post_id . '/';
}
if ( isset( $rest_permalink ) ) {
array_push( $listofurls, $rest_permalink );
}
}
// Add in AMP permalink for official WP AMP plugin:
// https://wordpress.org/plugins/amp/
if ( function_exists( 'amp_get_permalink' ) ) {
array_push( $listofurls, amp_get_permalink( $post_id ) );
}
// Regular AMP url for posts if ant of the following are active:
// https://wordpress.org/plugins/accelerated-mobile-pages/
if ( defined( 'AMPFORWP_AMP_QUERY_VAR' ) ) {
array_push( $listofurls, get_permalink( $post_id ) . 'amp/' );
}
// Also clean URL for trashed post.
if ( 'trash' === $this_post_status ) {
$trashpost = get_permalink( $post_id );
$trashpost = str_replace( '__trashed', '', $trashpost );
array_push( $listofurls, $trashpost, $trashpost . 'feed/' );
}
// Category purge based on Donnacha's work in WP Super Cache.
$categories = get_the_category( $post_id );
if ( $categories ) {
foreach ( $categories as $cat ) {
array_push(
$listofurls,
get_category_link( $cat->term_id ),
get_rest_url() . $rest_api_route . '/categories/' . $cat->term_id . '/'
);
}
}
// Tag purge based on Donnacha's work in WP Super Cache.
$tags = get_the_tags( $post_id );
if ( $tags ) {
$tag_base = get_site_option( 'tag_base' );
if ( '' === $tag_base ) {
$tag_base = '/tag/';
}
foreach ( $tags as $tag ) {
array_push(
$listofurls,
get_tag_link( $tag->term_id ),
get_rest_url() . $rest_api_route . $tag_base . $tag->term_id . '/'
);
}
}
// Custom Taxonomies: Only show if the taxonomy is public.
$taxonomies = get_post_taxonomies( $post_id );
if ( $taxonomies ) {
foreach ( $taxonomies as $taxonomy ) {
$features = (array) get_taxonomy( $taxonomy );
if ( $features['public'] ) {
$terms = wp_get_post_terms( $post_id, $taxonomy );
foreach ( $terms as $term ) {
array_push(
$listofurls,
get_term_link( $term ),
get_rest_url() . $rest_api_route . '/' . $term->taxonomy . '/' . $term->slug . '/'
);
}
}
}
}
// If the post is a post, we have more things to flush
// Pages and Woo Things don't need all this.
if ( $this_post_type && 'post' === $this_post_type ) {
// Author URLs:
$author_id = get_post_field( 'post_author', $post_id );
array_push(
$listofurls,
get_author_posts_url( $author_id ),
get_author_feed_link( $author_id ),
get_rest_url() . $rest_api_route . '/users/' . $author_id . '/'
);
// Feeds:
array_push(
$listofurls,
get_bloginfo_rss( 'rdf_url' ),
get_bloginfo_rss( 'rss_url' ),
get_bloginfo_rss( 'rss2_url' ),