/
files.php
executable file
·1458 lines (1249 loc) · 40 KB
/
files.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
use WP_Rocket\Logger\Logger;
use WP_Rocket\Engine\Cache\AdvancedCache;
defined( 'ABSPATH' ) || exit;
/**
* Creates the advanced-cache.php file.
*
* @since 3.6 Uses AdvancedCache::get_advanced_cache_content().
* @since 2.0
*
* @param AdvancedCache $advanced_cache Optional. Instance of the advanced cache handler.
*/
function rocket_generate_advanced_cache_file( $advanced_cache = null ) {
/**
* Filters whether to generate the advanced-cache.php file.
*
* @since 3.6.3
*
* @param bool True (default) to go ahead with advanced cache file generation; false to stop generation.
*/
if ( ! (bool) apply_filters( 'rocket_generate_advanced_cache_file', true ) ) {
return false;
}
static $done = false;
if ( rocket_get_constant( 'WP_ROCKET_IS_TESTING', false ) ) {
$done = false;
}
if ( $done ) {
return false;
}
$done = true;
if ( is_null( $advanced_cache ) ) {
$container = apply_filters( 'rocket_container', null );
$advanced_cache = $container->get( 'advanced_cache' );
}
return rocket_put_content(
rocket_get_constant( 'WP_CONTENT_DIR' ) . '/advanced-cache.php',
$advanced_cache->get_advanced_cache_content()
);
}
/**
* Generates the configuration file for the current domain based on the values of options
*
* @since 2.0
*
* @return array Names of all config files & The content that will be printed
*/
function get_rocket_config_file() { // phpcs:ignore WordPress.NamingConventions.PrefixAllGlobals
$options = get_option( WP_ROCKET_SLUG );
if ( ! $options ) {
return;
}
$buffer = "<?php\n";
$buffer .= "defined( 'ABSPATH' ) || exit;\n\n";
$buffer .= '$rocket_cookie_hash = \'' . COOKIEHASH . "';\n";
$buffer .= '$rocket_logged_in_cookie = \'' . LOGGED_IN_COOKIE . "';\n";
/**
* Filters the activation of the common cache for logged-in users.
*
* @since 2.10
* @author Remy Perona
*
* @param bool True to activate the common cache, false to ignore.
*/
if ( apply_filters( 'rocket_common_cache_logged_users', false ) ) {
$buffer .= '$rocket_common_cache_logged_users = 1;' . "\n";
}
if ( ! empty( $options['cache_webp'] ) ) {
/** This filter is documented in inc/classes/buffer/class-cache.php */
$disable_webp_cache = apply_filters( 'rocket_disable_webp_cache', false );
if ( $disable_webp_cache ) {
$options['cache_webp'] = 0;
}
}
/**
* Filters the use of the mobile cache version for tablets
* 'desktop' will serve desktop to tablets, 'mobile' will serve mobile to tablets
*
* @since 3.2
* @author Remy Perona
*
* @param string $tablet_version valid values are 'mobile' or 'desktop'
*/
$buffer .= '$rocket_cache_mobile_files_tablet = \'' . apply_filters( 'rocket_cache_mobile_files_tablet', 'desktop' ) . "';\n";
foreach ( $options as $option => $value ) {
if ( 'cache_ssl' === $option ) {
if ( 1 !== (int) $value ) {
if ( rocket_is_ssl_website() ) {
update_rocket_option( 'cache_ssl', 1 );
$value = 1;
}
}
$buffer .= '$rocket_' . $option . ' = ' . (int) $value . ";\n";
}
if ( 'cache_mobile' === $option || 'do_caching_mobile_files' === $option || 'cache_webp' === $option ) {
$buffer .= '$rocket_' . $option . ' = ' . (int) $value . ";\n";
}
if ( 'secret_cache_key' === $option ) {
$buffer .= '$rocket_' . $option . ' = \'' . $value . "';\n";
}
if ( 'cache_reject_uri' === $option ) {
$buffer .= '$rocket_' . $option . ' = \'' . get_rocket_cache_reject_uri() . "';\n";
}
if ( 'cache_query_strings' === $option ) {
$buffer .= '$rocket_' . $option . ' = ' . call_user_func( 'var_export', get_rocket_cache_query_string(), true ) . ";\n";
}
if ( 'cache_reject_cookies' === $option ) {
$cookies = get_rocket_cache_reject_cookies();
if ( $cookies && get_rocket_option( 'cache_logged_user' ) ) {
// Make sure the "logged-in cookies" are not rejected.
$logged_in_cookie = explode( COOKIEHASH, LOGGED_IN_COOKIE );
$logged_in_cookie = array_map( 'preg_quote', $logged_in_cookie );
$logged_in_cookie = implode( '[^|]*', $logged_in_cookie );
$cookies = preg_replace( '/\|' . $logged_in_cookie . '\|/', '|', '|' . $cookies . '|' );
$cookies = trim( $cookies, '|' );
}
$buffer .= '$rocket_' . $option . ' = \'' . $cookies . "';\n";
}
if ( 'cache_reject_ua' === $option ) {
$buffer .= '$rocket_' . $option . ' = \'' . get_rocket_cache_reject_ua() . "';\n";
}
}
$buffer .= '$rocket_cache_ignored_parameters = ' . call_user_func( 'var_export', rocket_get_ignored_parameters(), true ) . ";\n";
$buffer .= '$rocket_cache_mandatory_cookies = ' . call_user_func( 'var_export', get_rocket_cache_mandatory_cookies(), true ) . ";\n";
$buffer .= '$rocket_cache_dynamic_cookies = ' . call_user_func( 'var_export', get_rocket_cache_dynamic_cookies(), true ) . ";\n";
/** This filter is documented in inc/front/htaccess.php */
if ( apply_filters( 'rocket_url_no_dots', false ) ) {
$buffer .= '$rocket_url_no_dots = 1;';
}
$config_files_path = [];
$urls = [ rocket_get_home_url() ];
// Check if a translation plugin is activated and this configuration is in subdomain.
$subdomains = get_rocket_i18n_subdomains();
if ( $subdomains ) {
$urls = $subdomains;
}
foreach ( $urls as $url ) {
$file = get_rocket_parse_url( untrailingslashit( $url ) );
$file['path'] = ( ! empty( $file['path'] ) ) ? str_replace( '/', '.', untrailingslashit( $file['path'] ) ) : '';
$config_files_path[] = WP_ROCKET_CONFIG_PATH . strtolower( $file['host'] ) . $file['path'] . '.php';
}
/**
* Filter all config files path
*
* @since 2.6.5
*
* @param array $config_files_path Path of all config files.
*/
$config_files_path = apply_filters( 'rocket_config_files_path', $config_files_path );
/**
* Filter the content of all config files
*
* @since 2.1
*
* @param string $buffer The content that will be printed.
* @param array $config_files_path Names of all config files.
*/
$buffer = apply_filters( 'rocket_config_file', $buffer, $config_files_path );
$buffer = preg_replace( '@array\s+\(@i', 'array(', $buffer );
$buffer = preg_replace( '@array\(\s+\)@i', 'array()', $buffer );
return [ $config_files_path, $buffer ];
}
/**
* Create the current config domain file
* For example, if home_url() return example.com, the config domain file will be in /config/example.com
*
* @since 2.0
*
* @return void
*/
function rocket_generate_config_file() {
list( $config_files_path, $buffer ) = get_rocket_config_file();
if ( count( $config_files_path ) ) {
rocket_init_config_dir();
foreach ( $config_files_path as $file ) {
rocket_put_content( $file, $buffer );
}
}
}
/**
* Remove the current config domain file
*
* @since 2.6
*
* @return void
*/
function rocket_delete_config_file() {
list( $config_files_path ) = get_rocket_config_file();
foreach ( $config_files_path as $config_file ) {
rocket_direct_filesystem()->delete( $config_file );
}
}
/**
* Create all cache folders (wp-rocket & min)
*
* @since 2.6
*
* @return void
*/
function rocket_init_cache_dir() {
global $is_apache;
$filesystem = rocket_direct_filesystem();
// Create cache folder if not exist.
if ( ! $filesystem->is_dir( WP_ROCKET_CACHE_PATH ) ) {
rocket_mkdir_p( WP_ROCKET_CACHE_PATH );
}
if ( ! $filesystem->is_file( WP_ROCKET_CACHE_PATH . 'index.html' ) ) {
$filesystem->touch( WP_ROCKET_CACHE_PATH . 'index.html' );
}
if ( $is_apache ) {
$htaccess_path = WP_ROCKET_CACHE_PATH . '.htaccess';
if ( ! $filesystem->is_file( $htaccess_path ) ) {
$filesystem->touch( $htaccess_path );
rocket_put_content( $htaccess_path, "<IfModule mod_autoindex.c>\nOptions -Indexes\n</IfModule>" );
}
}
// Create minify cache folder if not exist.
if ( ! $filesystem->is_dir( WP_ROCKET_MINIFY_CACHE_PATH ) ) {
rocket_mkdir_p( WP_ROCKET_MINIFY_CACHE_PATH );
}
if ( ! $filesystem->is_file( WP_ROCKET_MINIFY_CACHE_PATH . 'index.html' ) ) {
$filesystem->touch( WP_ROCKET_MINIFY_CACHE_PATH . 'index.html' );
}
// Create busting cache folder if not exist.
if ( ! $filesystem->is_dir( WP_ROCKET_CACHE_BUSTING_PATH ) ) {
rocket_mkdir_p( WP_ROCKET_CACHE_BUSTING_PATH );
}
if ( ! $filesystem->is_file( WP_ROCKET_CACHE_BUSTING_PATH . 'index.html' ) ) {
$filesystem->touch( WP_ROCKET_CACHE_BUSTING_PATH . 'index.html' );
}
// Create critical CSS folder if not exist.
if ( ! $filesystem->is_dir( WP_ROCKET_CRITICAL_CSS_PATH ) ) {
rocket_mkdir_p( WP_ROCKET_CRITICAL_CSS_PATH );
}
if ( ! $filesystem->is_file( WP_ROCKET_CRITICAL_CSS_PATH . 'index.html' ) ) {
$filesystem->touch( WP_ROCKET_CRITICAL_CSS_PATH . 'index.html' );
}
}
/**
* Create the config folder (wp-rocket-config)
*
* @since 2.6
*
* @return void
*/
function rocket_init_config_dir() {
$filesystem = rocket_direct_filesystem();
// Create config domain folder if not exist.
if ( ! $filesystem->is_dir( WP_ROCKET_CONFIG_PATH ) ) {
rocket_mkdir_p( WP_ROCKET_CONFIG_PATH );
}
// Initialize the config directory with index.html to prevent indexing.
if ( ! $filesystem->is_file( WP_ROCKET_CONFIG_PATH . 'index.html' ) ) {
$filesystem->touch( WP_ROCKET_CONFIG_PATH . 'index.html' );
}
}
/**
* Delete all minify cache files.
*
* @since 3.5.3 Replaces glob.
* @since 2.1
*
* @param string|array $extensions Optional. File extensions to minify. Default: js and css.
*/
function rocket_clean_minify( $extensions = [ 'js', 'css' ] ) {
// Bails out if there are no extensions to target.
if ( empty( $extensions ) ) {
return;
}
if ( is_string( $extensions ) ) {
$extensions = (array) $extensions;
}
$min_cache_path = rocket_get_constant( 'WP_ROCKET_MINIFY_CACHE_PATH' );
$min_path = $min_cache_path . get_current_blog_id() . '/';
$iterator = _rocket_get_cache_path_iterator( $min_path );
if ( false === $iterator ) {
return;
}
$filesystem = rocket_direct_filesystem();
$min_path_regex = str_replace( '/', '\/', $min_path );
foreach ( $extensions as $ext ) {
/**
* Fires before the minify cache files are deleted.
*
* @since 2.1
*
* @param string $ext File extensions to minify.
*/
do_action( 'before_rocket_clean_minify', $ext ); // phpcs:ignore WordPress.NamingConventions.PrefixAllGlobals
try {
$entries = new RegexIterator( $iterator, "/{$min_path_regex}.*\.{$ext}/" );
} catch ( Exception $e ) {
return;
}
foreach ( $entries as $entry ) {
$filesystem->delete( $entry->getPathname() );
}
/**
* Fires after the minify cache files was deleted.
*
* @since 2.1
*
* @param string $ext File extensions to minify.
*/
do_action( 'after_rocket_clean_minify', $ext ); // phpcs:ignore WordPress.NamingConventions.PrefixAllGlobals
}
// Delete any directories.
foreach ( $iterator as $item ) {
if ( $filesystem->is_dir( $item ) ) {
$filesystem->delete( $item );
}
}
// Clean the cache/min/3rd-party items.
try {
$files = new FilesystemIterator( "{$min_cache_path}3rd-party" );
foreach ( $files as $file ) {
if ( $filesystem->is_file( $file ) ) {
$filesystem->delete( $file );
}
}
} catch ( UnexpectedValueException $e ) {
// No logging yet.
return;
}
}
/**
* Delete all cache busting files.
*
* @since 2.9
*
* @param string|array $extensions (default: array('js','css') File extensions to clean.
* @return void
*/
function rocket_clean_cache_busting( $extensions = [ 'js', 'css' ] ) {
$extensions = is_string( $extensions ) ? (array) $extensions : $extensions;
$cache_busting_path = WP_ROCKET_CACHE_BUSTING_PATH . get_current_blog_id();
if ( ! rocket_direct_filesystem()->is_dir( $cache_busting_path ) ) {
rocket_mkdir_p( $cache_busting_path );
Logger::debug(
'No Cache Busting folder found.',
[
'mkdir cache busting folder',
'cache_busting_path' => $cache_busting_path,
]
);
return;
}
try {
$dir = new RecursiveDirectoryIterator( $cache_busting_path, FilesystemIterator::SKIP_DOTS );
} catch ( UnexpectedValueException $e ) {
// No logging yet.
return;
}
try {
$iterator = new RecursiveIteratorIterator( $dir, RecursiveIteratorIterator::CHILD_FIRST );
} catch ( Exception $e ) {
// No logging yet.
return;
}
foreach ( $extensions as $ext ) {
/**
* Fires before the cache busting files are deleted
*
* @since 2.9
*
* @param string $ext File extensions to clean.
*/
do_action( 'before_rocket_clean_busting', $ext ); // phpcs:ignore WordPress.NamingConventions.PrefixAllGlobals
try {
$files = new RegexIterator( $iterator, '#.*\.' . $ext . '#', RegexIterator::GET_MATCH );
foreach ( $files as $file ) {
rocket_direct_filesystem()->delete( $file[0] );
}
} catch ( InvalidArgumentException $e ) {
// No logging yet.
return;
}
/**
* Fires after the cache busting files was deleted
*
* @since 2.9
*
* @param string $ext File extensions to clean.
*/
do_action( 'after_rocket_clean_cache_busting', $ext ); // phpcs:ignore WordPress.NamingConventions.PrefixAllGlobals
}
try {
foreach ( $iterator as $item ) {
if ( rocket_direct_filesystem()->is_dir( $item ) ) {
rocket_direct_filesystem()->delete( $item );
}
}
} catch ( UnexpectedValueException $e ) {
// Log the error.
Logger::debug(
'Cache Busting folder structure contains a directory we cannot recurse into.',
[
'Full error',
'UnexpectedValueException' => $e->getMessage(),
]
);
}
}
/**
* Delete one or several cache files.
*
* @since 3.5.5 Optimizes by grabbing root cache dirs once, bailing out when file/dir doesn't exist, & directly
* deleting files.
* @since 3.5.4 Replaces glob and optimizes.
* @since 2.0 Delete cache files for all users.
* @since 1.1.0 Add filter rocket_clean_files.
* @since 1.0
*
* @param string|array $urls URLs of cache files to be deleted.
* @param WP_Filesystem_Direct|null $filesystem Optional. Instance of filesystem handler.
*/
function rocket_clean_files( $urls, $filesystem = null ) {
$urls = (array) $urls;
if ( empty( $urls ) ) {
return;
}
$urls = array_filter( $urls );
if ( empty( $urls ) ) {
return;
}
/** This filter is documented in inc/front/htaccess.php */
$url_no_dots = (bool) apply_filters( 'rocket_url_no_dots', false );
$cache_path = _rocket_get_wp_rocket_cache_path();
if ( empty( $filesystem ) ) {
$filesystem = rocket_direct_filesystem();
}
/**
* Fires before all cache files are deleted.
*
* @since 3.2.2
*
* @param array $urls The URLs corresponding to the deleted cache files.
*/
do_action( 'before_rocket_clean_files', $urls ); // phpcs:ignore WordPress.NamingConventions.PrefixAllGlobals
foreach ( $urls as $url ) {
/**
* Fires before the cache file is deleted.
*
* @since 1.0
*
* @param string $url The URL that the cache file to be deleted.
*/
do_action( 'before_rocket_clean_file', $url ); // phpcs:ignore WordPress.NamingConventions.PrefixAllGlobals
if ( $url_no_dots ) {
$url = str_replace( '.', '_', $url );
}
$parsed_url = get_rocket_parse_url( $url );
if ( ! empty( $parsed_url['host'] ) ) {
foreach ( _rocket_get_cache_dirs( $parsed_url['host'], $cache_path ) as $dir ) {
$entry = $dir . $parsed_url['path'];
// Skip if the dir/file does not exist.
if ( ! $filesystem->exists( $entry ) ) {
continue;
}
if ( $filesystem->is_dir( $entry ) ) {
rocket_rrmdir( $entry, [], $filesystem );
} else {
$filesystem->delete( $entry );
}
}
}
/**
* Fires after the cache file is deleted.
*
* @since 1.0
*
* @param string $url The URL that the cache file was deleted.
*/
do_action( 'after_rocket_clean_file', $url ); // phpcs:ignore WordPress.NamingConventions.PrefixAllGlobals
}
/**
* Fires after all cache files are deleted.
*
* @since 3.2.2
*
* @param array $urls The URLs corresponding to the deleted cache files.
*/
do_action( 'after_rocket_clean_files', $urls ); // phpcs:ignore WordPress.NamingConventions.PrefixAllGlobals
}
/**
* Remove the home cache file and pagination
*
* $since 2.2 Add $lang argument
*
* @since 2.0 Delete cache files for all users
* @since 1.0
*
* @param string $lang (default: '') The language code.
* @return void
*/
function rocket_clean_home( $lang = '' ) {
$parse_url = get_rocket_parse_url( get_rocket_i18n_home_url( $lang ) );
/** This filter is documented in inc/front/htaccess.php */
if ( apply_filters( 'rocket_url_no_dots', false ) ) {
$parse_url['host'] = str_replace( '.', '_', $parse_url['host'] );
}
$root = WP_ROCKET_CACHE_PATH . $parse_url['host'] . '*' . untrailingslashit( $parse_url['path'] );
/**
* Filter the homepage caching folder root
*
* @since 2.6.5
* @param array $root The root that will be returned.
* @param string $host The website host.
* @param string $path The website path.
*/
$root = apply_filters( 'rocket_clean_home_root', $root, $parse_url['host'], $parse_url['path'] );
/**
* Fires before the home cache file is deleted
*
* @since 1.0
*
* @param string $root The path of home cache file.
* @param string $lang The current lang to purge.
*/
do_action( 'before_rocket_clean_home', $root, $lang ); // phpcs:ignore WordPress.NamingConventions.PrefixAllGlobals
// Delete homepage.
$files = glob( $root . '/{index,index-*}.{html,html_gzip}', GLOB_BRACE | GLOB_NOSORT );
if ( $files ) {
foreach ( $files as $file ) { // no array map to use @.
rocket_direct_filesystem()->delete( $file );
}
}
// Delete homepage pagination.
$dirs = glob( $root . '*/' . $GLOBALS['wp_rewrite']->pagination_base, GLOB_NOSORT );
if ( $dirs ) {
foreach ( $dirs as $dir ) {
rocket_rrmdir( $dir );
}
}
// Remove the hidden empty file for mobile detection on NGINX with the Rocket NGINX configuration.
$nginx_mobile_detect_files = glob( $root . '/.mobile-active', GLOB_BRACE | GLOB_NOSORT );
if ( $nginx_mobile_detect_files ) {
foreach ( $nginx_mobile_detect_files as $nginx_mobile_detect_file ) { // no array map to use @.
rocket_direct_filesystem()->delete( $nginx_mobile_detect_file );
}
}
// Remove the hidden empty file for webp.
$nowebp_detect_files = glob( $root . '/.no-webp', GLOB_BRACE | GLOB_NOSORT );
if ( $nowebp_detect_files ) {
foreach ( $nowebp_detect_files as $nowebp_detect_file ) { // no array map to use @.
rocket_direct_filesystem()->delete( $nowebp_detect_file );
}
}
/**
* Fires after the home cache file was deleted
*
* @since 1.0
*
* @param string $root The path of home cache file.
* @param string $lang The current lang to purge.
*/
do_action( 'after_rocket_clean_home', $root, $lang ); // phpcs:ignore WordPress.NamingConventions.PrefixAllGlobals
}
/**
* Remove the home cache feed
*
* @since 2.7
*
* @return void
*/
function rocket_clean_home_feeds() {
$urls = [];
$urls[] = get_feed_link();
$urls[] = get_feed_link( 'comments_' );
/**
* Filter the home feeds urls
*
* @since 2.7
* @param array $urls The urls of the home feeds.
*/
$urls = apply_filters( 'rocket_clean_home_feeds', $urls );
/**
* Fires before the home feeds cache is deleted
*
* @since 2.7
*
* @param array $urls The urls of the home feeds.
*/
do_action( 'before_rocket_clean_home_feeds', $urls ); // phpcs:ignore WordPress.NamingConventions.PrefixAllGlobals
rocket_clean_files( $urls );
/**
* Fires after the home feeds cache was deleted
*
* @since 2.7
*
* @param array $urls The urls of the home feeds.
*/
do_action( 'after_rocket_clean_home_feeds', $urls ); // phpcs:ignore WordPress.NamingConventions.PrefixAllGlobals
}
/**
* Remove all cache files for the domain.
*
* @since 3.5.5 Optimizes by grabbing root cache dirs once, bailing out when file/dir doesn't exist, & directly
* deleting files.
* @since 3.5.3 Replaces glob with SPL.
* @since 2.0 Delete domain cache files for all users
* @since 1.0
*
* @param string $lang Optional. The language code. Default: empty string.
* @param WP_Filesystem_Direct|null $filesystem Optional. Instance of filesystem handler.
*/
function rocket_clean_domain( $lang = '', $filesystem = null ) {
$urls = ( ! $lang || is_object( $lang ) || is_array( $lang ) || is_int( $lang ) )
? (array) get_rocket_i18n_uri()
: (array) get_rocket_i18n_home_url( $lang );
/**
* Filter URLs to delete all caching files from a domain.
*
* @since 2.6.4
*
* @param array URLs that will be returned.
* @param string The language code.
*/
$urls = (array) apply_filters( 'rocket_clean_domain_urls', $urls, $lang );
$urls = array_filter( $urls );
if ( empty( $urls ) ) {
return false;
}
/** This filter is documented in inc/front/htaccess.php */
$url_no_dots = (bool) apply_filters( 'rocket_url_no_dots', false );
$cache_path = _rocket_get_wp_rocket_cache_path();
$dirs_to_preserve = get_rocket_i18n_to_preserve( $lang, $cache_path );
if ( empty( $filesystem ) ) {
$filesystem = rocket_direct_filesystem();
}
foreach ( $urls as $url ) {
$parsed_url = get_rocket_parse_url( $url );
if ( $url_no_dots ) {
$parsed_url['host'] = str_replace( '.', '_', $parsed_url['host'] );
}
$root = $cache_path . $parsed_url['host'] . $parsed_url['path'];
/**
* Fires before all cache files are deleted.
*
* @since 1.0
*
* @param string $root The path of home cache file.
* @param string $lang The current lang to purge.
* @param string $url The home url.
*/
do_action( 'before_rocket_clean_domain', $root, $lang, $url ); // phpcs:ignore WordPress.NamingConventions.PrefixAllGlobals
foreach ( _rocket_get_cache_dirs( $parsed_url['host'], $cache_path ) as $dir ) {
$entry = $dir . $parsed_url['path'];
// Skip if the dir/file does not exist.
if ( ! $filesystem->exists( $entry ) ) {
continue;
}
if ( $filesystem->is_dir( $entry ) ) {
rocket_rrmdir( $entry, $dirs_to_preserve, $filesystem );
} else {
$filesystem->delete( $entry );
}
}
/**
* Fires after all cache files was deleted.
*
* @since 1.0
*
* @param string $root The path of home cache file.
* @param string $lang The current lang to purge.
* @param string $url The home url.
*/
do_action( 'after_rocket_clean_domain', $root, $lang, $url ); // phpcs:ignore WordPress.NamingConventions.PrefixAllGlobals
}
return true;
}
/**
* Delete the caching files of a specific term.
*
* $since 2.6.8
*
* @param int $term_id The term ID.
* @param string $taxonomy_slug The taxonomy slug.
* @return void
*/
function rocket_clean_term( $term_id, $taxonomy_slug ) {
$purge_urls = [];
// Get all term infos.
$term = get_term_by( 'id', $term_id, $taxonomy_slug );
// Get the term language.
$i18n_plugin = rocket_has_i18n();
if ( 'wpml' === $i18n_plugin && ! rocket_is_plugin_active( 'woocommerce-multilingual/wpml-woocommerce.php' ) ) {
// WPML.
$lang = $GLOBALS['sitepress']->get_language_for_element( $term_id, 'tax_' . $taxonomy_slug );
} elseif ( 'polylang' === $i18n_plugin ) {
// Polylang.
$lang = pll_get_term_language( $term_id );
} else {
$lang = false;
}
// Get permalink.
$permalink = get_term_link( $term, $taxonomy_slug );
// Add permalink.
if ( '/' !== rocket_extract_url_component( $permalink, PHP_URL_PATH ) ) {
array_push( $purge_urls, $permalink );
}
/**
* Fires before deleted caching files related with the term
*
* @since 2.6.8
* @param obj $term The term object.
* @param array $purge_urls URLs cache files to remove.
* @param string $lang The term language.
*/
do_action( 'before_rocket_clean_term', $term, $purge_urls, $lang ); // phpcs:ignore WordPress.NamingConventions.PrefixAllGlobals
/**
* Filter URLs cache files to remove
*
* @since 2.6.8
* @param array $purge_urls List of URLs cache files to remove.
* @param obj $term The term object.
*/
$purge_urls = apply_filters( 'rocket_term_purge_urls', $purge_urls, $term );
// Purge all files.
rocket_clean_files( $purge_urls );
// Never forget to purge homepage and their pagination.
rocket_clean_home( $lang );
/**
* Fires before deleted caching files related with the term
*
* @since 2.6.8
* @param obj $term The term object.
* @param array $purge_urls URLs cache files to remove.
* @param string $lang The term language.
*/
do_action( 'after_rocket_clean_term', $term, $purge_urls, $lang ); // phpcs:ignore WordPress.NamingConventions.PrefixAllGlobals
}
/**
* Delete the caching files of a specific user
*
* $since 2.6.12
*
* @param int $user_id The user ID.
* @param string $lang The language code.
* @return void
*/
function rocket_clean_user( $user_id, $lang = '' ) {
$urls = ( ! $lang || is_object( $lang ) ) ? get_rocket_i18n_uri() : get_rocket_i18n_home_url( $lang );
$urls = (array) $urls;
/** This filter is documented in inc/functions/files.php */
$urls = apply_filters( 'rocket_clean_domain_urls', $urls, $lang );
$urls = array_filter( $urls );
$user = get_user_by( 'id', $user_id );
if ( ! $user ) {
return;
}
$user_key = $user->user_login . '-' . get_rocket_option( 'secret_cache_key' );
foreach ( $urls as $url ) {
$parse_url = get_rocket_parse_url( $url );
/** This filter is documented in inc/front/htaccess.php */
if ( apply_filters( 'rocket_url_no_dots', false ) ) {
$parse_url['host'] = str_replace( '.', '_', $parse_url['host'] );
}
$root = rocket_get_constant( 'WP_ROCKET_CACHE_PATH' ) . $parse_url['host'] . '-' . $user_key . '*' . $parse_url['path'];
/**
* Fires before all caching files are deleted for a specific user
*
* @since 2.6.12
*
* @param int $user_id The path of home cache file.
* @param string $lang The language code.
*/
do_action( 'before_rocket_clean_user', $user_id, $lang ); // phpcs:ignore WordPress.NamingConventions.PrefixAllGlobals
// Delete cache domain files.
$dirs = glob( $root . '*', GLOB_NOSORT );
if ( $dirs ) {
foreach ( $dirs as $dir ) {
rocket_rrmdir( $dir, get_rocket_i18n_to_preserve( $lang ) );
}
}
/**
* Fires after all caching files are deleted for a specific user
*
* @since 2.6.12
*
* @param int $user_id The path of home cache file.
* @param string $lang The language code.
*/
do_action( 'after_rocket_clean_user', $user_id, $lang ); // phpcs:ignore WordPress.NamingConventions.PrefixAllGlobals
}
}
/**
* Remove all caching files in the cache folder
*
* @since 2.6.8
*
* @return void
*/
function rocket_clean_cache_dir() {
/**
* Fires before deleting all caching files in the cache folder
*
* @since 2.6.8
*/
do_action( 'before_rocket_clean_cache_dir' ); // phpcs:ignore WordPress.NamingConventions.PrefixAllGlobals
// Delete all caching files.
$dirs = glob( WP_ROCKET_CACHE_PATH . '*', GLOB_NOSORT );
if ( $dirs ) {
foreach ( $dirs as $dir ) {
rocket_rrmdir( $dir );
}
}
/**
* Fires after deleting all caching files in the cache folder
*
* @since 2.6.8
*/
do_action( 'after_rocket_clean_cache_dir' ); // phpcs:ignore WordPress.NamingConventions.PrefixAllGlobals
}
/**
* Remove a single file or a folder recursively.
*
* @since 3.5.3 Replaces glob and optimizes.
* @since 1.0
* @since 3.5.3 Bails if given dir should be preserved; replaces glob; optimizes.
*
* @param string $dir File/Directory to delete.
* @param array $dirs_to_preserve Optional. Dirs that should not be deleted.
* @param WP_Filesystem_Direct|null $filesystem Optional. Instance of filesystem handler.
*/
function rocket_rrmdir( $dir, array $dirs_to_preserve = [], $filesystem = null ) {
$dir = untrailingslashit( $dir );
if ( empty( $filesystem ) ) {
$filesystem = rocket_direct_filesystem();
}
/**
* Fires before a file/directory cache is deleted
*
* @since 1.1.0
*
* @param string $dir File/Directory to delete.
* @param array $dirs_to_preserve Directories that should not be deleted.
*/
do_action( 'before_rocket_rrmdir', $dir, $dirs_to_preserve ); // phpcs:ignore WordPress.NamingConventions.PrefixAllGlobals
// Remove the hidden empty file for mobile detection on NGINX with the Rocket NGINX configuration.
$nginx_mobile_detect_file = $dir . '/.mobile-active';
if ( $filesystem->is_dir( $dir ) && $filesystem->exists( $nginx_mobile_detect_file ) ) {
$filesystem->delete( $nginx_mobile_detect_file );
}
// Remove the hidden empty file for webp.
$nowebp_detect_file = $dir . '/.no-webp';
if ( $filesystem->is_dir( $dir ) && $filesystem->exists( $nowebp_detect_file ) ) {
$filesystem->delete( $nowebp_detect_file );
}
if ( ! $filesystem->is_dir( $dir ) ) {