-
-
Notifications
You must be signed in to change notification settings - Fork 47
/
cache.class.php
1092 lines (917 loc) · 31.1 KB
/
cache.class.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
/**
* @package The_SEO_Framework\Classes
*/
namespace The_SEO_Framework;
defined( 'ABSPATH' ) or die;
/**
* The SEO Framework plugin
* Copyright (C) 2015 - 2016 Sybre Waaijer, CyberWire (https://cyberwire.nl/)
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License version 3 as published
* by the Free Software Foundation.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
/**
* Class The_SEO_Framework\Cache
*
* Generates, stores and deletes common transients.
*
* @since 2.8.0
*/
class Cache extends Sitemaps {
/**
* The sitemap transient name.
*
* @since 2.2.9
*
* @var string The Sitemap Transient Name.
*/
protected $sitemap_transient;
/**
* The Automatic Description transient name.
*
* @since 2.3.3
*
* @var string The Automatic Description Transient Name.
*/
protected $auto_description_transient;
/**
* The LD+Json script transient name.
*
* @since 2.3.3
*
* @var string The LD+Json Script Transient Name.
*/
protected $ld_json_transient;
/**
* The Theme is doing the Title right transient name
*
* @since 2.5.2
*
* @var string The Theme Doing It Right Transient Name.
*/
protected $theme_doing_it_right_transient;
/**
* Constructor, load parent constructor and set up caches.
*/
protected function __construct() {
parent::__construct();
//* Setup Transient names
add_action( 'plugins_loaded', array( $this, 'setup_transient_names' ), 10 );
}
/**
* Determines whether object cache is being used.
*
* @since 2.8.0
* @see $this->use_object_cache
*
* @return bool
*/
protected function use_object_cache() {
return \wp_using_ext_object_cache() && $this->is_option_checked( 'cache_object' );
}
/**
* Initializes admin caching actions.
*
* @since 2.8.0
* @action init priority 1
* @see $this->init_admin_actions();
*/
public function init_admin_caching_actions() {
$this->init_post_cache_actions();
//* Deletes term description transient.
\add_action( 'edit_term', array( $this, 'delete_auto_description_transients_term' ), 10, 3 );
\add_action( 'delete_term', array( $this, 'delete_auto_description_transients_term' ), 10, 4 );
//* Deletes author transient.
\add_action( 'profile_update', array( $this, 'delete_author_cache' ) );
//* Delete Sitemap transient on permalink structure change.
\add_action( 'load-options-permalink.php', array( $this, 'delete_sitemap_transient_permalink_updated' ), 20 );
//* Deletes front page description transient on Tagline change.
\add_action( 'update_option_blogdescription', array( $this, 'delete_auto_description_frontpage_transient' ), 10, 1 );
//* Delete doing it wrong transient after theme switch or plugin upgrade.
\add_action( 'after_switch_theme', array( $this, 'delete_theme_dir_transient' ), 10, 0 );
\add_action( 'upgrader_process_complete', array( $this, 'delete_theme_dir_transient' ), 10, 2 );
}
/**
* Deletes Sitemap and Description transients on post publish/delete.
*
* @see WP Core wp_transition_post_status()
* @since 2.8.2
* @staticvar bool $run
* @action init priority 1
* @see $this->init_admin_actions();
* @see $this->init_cron_actions();
*
* @return void Early if already called.
*/
public function init_post_cache_actions() {
static $run = false;
if ( $run )
return;
//* Can-be cron actions.
\add_action( 'publish_post', array( $this, 'delete_post_cache' ) );
\add_action( 'publish_page', array( $this, 'delete_post_cache' ) );
//* Other actions.
\add_action( 'deleted_post', array( $this, 'delete_post_cache' ) );
\add_action( 'deleted_page', array( $this, 'delete_post_cache' ) );
\add_action( 'post_updated', array( $this, 'delete_post_cache' ) );
\add_action( 'page_updated', array( $this, 'delete_post_cache' ) );
$run = true;
}
/**
* Flushes front-page and global transients that can be affected by options.
*
* @since 2.8.0
* @since 2.9.0 : Added object cache flush.
* @TODO make 2.9 note work.
*/
public function delete_main_cache() {
$this->delete_cache( 'front' );
$this->delete_cache( 'sitemap' );
$this->delete_cache( 'robots' );
// $this->delete_cache( 'objectflush' );
}
/**
* Delete transient on post save.
*
* @since 2.8.0
*
* @param int $post_id The Post ID that has been updated.
* @return bool True on success, false on failure.
*/
public function delete_post_cache( $post_id ) {
$success = array();
$success[] = $this->delete_cache( 'post', $post_id );
if ( $this->is_option_checked( 'sitemaps_output' ) ) {
//* Don't flush sitemap on revision.
if ( ! \wp_is_post_revision( $post_id ) )
$success[] = $this->delete_cache( 'sitemap' );
}
return ! in_array( false, $success, true );
}
/**
* Deletes cache on profile save.
*
* @since 2.8.0
*
* @param int $user_id The User ID that has been updated.
* @return bool True on success, false on failure.
*/
public function delete_author_cache( $user_id ) {
return $this->delete_cache( 'author', $user_id );
}
/**
* Deletes object cache.
*
* @since 2.9.0
* @TODO make this work.
*
* @return bool True on success, false on failure.
*/
public function delete_object_cache() {
return false;
// return $this->delete_cache( 'objectflush' );
}
/**
* Handles all kinds of cache for removal.
* Main cache deletion function handler.
*
* @since 2.8.0
*
* @param string $type The type
* @param int $id The post, page or TT ID. Defaults to $this->get_the_real_ID().
* @param array $args Additional arguments. They can overwrite $type and $id.
* @return bool true on success, false on failure.
*/
public function delete_cache( $type, $id = 0, array $args = array() ) {
$this->parse_delete_cache_keys( $type, $id, $args );
switch ( $type ) :
case 'front' :
$front_id = $this->get_the_front_page_ID();
//* Code debt!:
$this->setup_auto_description_transient( $front_id, '', 'frontpage' );
$this->object_cache_delete( $this->get_meta_output_cache_key_by_type( $this->get_the_front_page_ID(), '', 'frontpage' ) );
$this->is_option_checked( 'cache_meta_schema' ) and $this->delete_ld_json_transient( $front_id, '', 'frontpage' );
$this->is_option_checked( 'cache_meta_description' ) and delete_transient( $this->auto_description_transient );
break;
case 'post' :
if ( ! $post_type = \get_post_type( $id ) )
return false;
$this->object_cache_delete( $this->get_meta_output_cache_key_by_type( $id, $post_type ) );
$this->delete_auto_description_transient( $id, '', $post_type );
$this->delete_ld_json_transient( $id, '', $post_type );
return true;
break;
//* Careful, this can only run on archive pages. For now.
case 'term' :
$this->object_cache_delete( $this->get_meta_output_cache_key( $id ) );
$this->delete_auto_description_transient( $id, $args['term'] );
$this->delete_ld_json_transient( $id, $args['term'] );
return true;
break;
case 'author' :
$this->object_cache_delete( $this->get_meta_output_cache_key( $id ) );
$this->delete_auto_description_transient( $id, 'author', 'author' );
return true;
break;
case 'sitemap' :
return $this->delete_sitemap_transient();
break;
case 'robots' :
return $this->object_cache_delete( $this->get_robots_txt_cache_key() );
break;
case 'detection' :
return $this->delete_theme_dir_transient();
break;
//* Flush all transients.
case 'transientflush' :
/**
* Applies filters 'the_seo_framework_allow_transient_flush' : boolean
* @since 2.8.0
* WARNING: Experimental and untested. Use at own risk.
*/
if ( \apply_filters( 'the_seo_framework_allow_transient_flush', false ) ) {
if ( ! \wp_using_ext_object_cache() ) {
//* Delete WordPress set transients.
if ( $GLOBALS['wpdb']->delete( $wpdb->options, array( 'option_name' => '%_transient_timeout_tsf_%' ) ) )
if ( $GLOBALS['wpdb']->delete( $wpdb->options, array( 'option_name' => '%_transient_tsf_%' ) ) )
return true;
}
}
break;
/**
* Flush whole object cache group.
* Set here for external functions to use. It works because of magic methods.
*
* @NOTE Other caching plugins can override these groups. Therefore this
* does NOT work.
* @TODO make this work.
*/
case 'objectflush' :
//* @NOTE false can't pass.
if ( false && $this->use_object_cache ) {
if ( isset( $GLOBALS['wp_object_cache']->cache['the_seo_framework'] ) ) {
$_cache = $GLOBALS['wp_object_cache']->cache;
unset( $_cache['the_seo_framework'] );
$GLOBALS['wp_object_cache']->cache = $_cache;
return true;
}
}
break;
default :
break;
endswitch;
return false;
}
/**
* Parses input keys for method delete_cache.
*
* @since 2.8.0
*
* @param string $type The cache type. Passed by reference.
* @param int $id The post, page or TT ID. Defaults to $this->get_the_real_ID(). Passed by reference.
* @param array $args Additional arguments. They can overwrite $type and $id. Passed by reference.
*/
protected function parse_delete_cache_keys( &$type, &$id, &$args ) {
$id = $id ?: $this->get_the_real_ID();
$defaults = array(
'type' => $type,
'id' => $id,
'term' => '',
);
/**
* Applies filters 'the_seo_framework_delete_cache_args' : array
* Careful: might infinitely loop method delete_cache() if not done strictly.
*
* @since 2.8.0
*
* @param array $args
* @param string $type
* @param int $id
*/
$args = (array) \apply_filters( 'the_seo_framework_delete_cache_args', $args, $type, $id );
$args = \wp_parse_args( $args, $defaults );
$type = $args['type'];
$id = $args['id'];
}
/**
* Set the value of the transient.
*
* Prevents setting of transients when they're disabled.
* @see $this->the_seo_framework_use_transients
*
* @since 2.6.0
*
* @param string $transient Transient name. Expected to not be SQL-escaped.
* @param string $value Transient value. Expected to not be SQL-escaped.
* @param int $expiration Optional Transient expiration date, optional. Expected to not be SQL-escaped.
*/
public function set_transient( $transient, $value, $expiration = '' ) {
if ( $this->the_seo_framework_use_transients )
\set_transient( $transient, $value, $expiration );
}
/**
* Get the value of the transient.
*
* If the transient does not exists, does not have a value or has expired,
* or transients have been disabled through a constant, then the transient
* will be false.
* @see $this->the_seo_framework_use_transients
*
* @since 2.6.0
*
* @param string $transient Transient name. Expected to not be SQL-escaped.
* @return mixed|bool Value of the transient. False on failure or non existing transient.
*/
public function get_transient( $transient ) {
if ( $this->the_seo_framework_use_transients )
return \get_transient( $transient );
return false;
}
/**
* Object cache set wrapper.
*
* @since 2.4.3
*
* @param string $key The Object cache key.
* @param mixed $data The Object cache data.
* @param int $expire The Object cache expire time.
* @param string $group The Object cache group.
* @return bool true on set, false when disabled.
*/
public function object_cache_set( $key, $data, $expire = 0, $group = 'the_seo_framework' ) {
if ( $this->use_object_cache )
return \wp_cache_set( $key, $data, $group, $expire );
return false;
}
/**
* Object cache get wrapper.
*
* @since 2.4.3
*
* @param string $key The Object cache key.
* @param string $group The Object cache group.
* @param bool $force Whether to force an update of the local cache.
* @param bool $found Whether the key was found in the cache. Disambiguates a return of false, a storable value. Passed by reference.
* @return mixed wp_cache_get if object caching is allowed. False otherwise.
*/
public function object_cache_get( $key, $group = 'the_seo_framework', $force = false, &$found = null ) {
if ( $this->use_object_cache )
return \wp_cache_get( $key, $group, $force, $found );
return false;
}
/**
* Object cache delete wrapper.
*
* @since 2.8.0
*
* @param string $key The Object cache key.
* @param string $group The Object cache group.
* @return mixed wp_cache_delete if object caching is allowed. False otherwise.
*/
public function object_cache_delete( $key, $group = 'the_seo_framework' ) {
if ( $this->use_object_cache )
return \wp_cache_delete( $key, $group );
return false;
}
/**
* Setup vars for general site transients.
*
* @since 2.3.3
* @since 2.8.0:
* 1. Added locale suffix.
* 2. Added check for option 'cache_sitemap'.
* @global int $blog_id
*/
public function setup_transient_names() {
global $blog_id;
/**
* When the caching mechanism changes. Change this value.
* Use hex. e.g. 0, 1, 2, 9, a, b
*/
$sitemap_revision = '2';
$theme_dir_revision = '0';
$this->sitemap_transient = $this->is_option_checked( 'cache_sitemap' ) ? $this->add_cache_key_suffix( 'tsf_sitemap_' . $sitemap_revision ) : '';
$this->theme_doing_it_right_transient = 'tsf_tdir_' . $theme_dir_revision . '_' . $blog_id;
}
/**
* Setup vars for transients which require $page_id.
*
* @since 2.3.3
* @since 2.8.0: Now listens to option 'cache_meta_description'.
*
* @param int|string|bool $page_id the Taxonomy or Post ID. If false it will generate for the blog page.
* @param string $taxonomy The taxonomy name.
* @param string $type The Post Type
* @return void Early if caching is disabled.
*/
public function setup_auto_description_transient( $page_id, $taxonomy = '', $type = null ) {
if ( false === $this->is_option_checked( 'cache_meta_description' ) )
return;
$cache_key = $this->generate_cache_key( $page_id, $taxonomy, $type );
/**
* When the caching mechanism changes. Change this value.
* Use hex. e.g. 0, 1, 2, 9, a, b
*
* @since 2.3.4
*/
$revision = '2';
$additions = $this->add_description_additions( $page_id, $taxonomy );
if ( $additions ) {
$option = $this->get_option( 'description_blogname' ) ? '1' : '0';
$this->auto_description_transient = 'tsf_desc_' . $option . '_' . $revision . '_' . $cache_key;
} else {
$this->auto_description_transient = 'tsf_desc_noa_' . $revision . '_' . $cache_key;
}
}
/**
* Setup vars for transients which require $page_id.
*
* @since 2.3.3
* @since 2.8.0: Now listens to option 'cache_meta_schema'.
*
* @param int|string|bool $page_id the Taxonomy or Post ID. If false it will generate for the blog page.
* @param string $taxonomy The taxonomy name.
* @param string|null $type The post type.
* @return void Early if caching is disabled.
*/
public function setup_ld_json_transient( $page_id, $taxonomy = '', $type = null ) {
if ( false === $this->is_option_checked( 'cache_meta_schema' ) )
return;
$cache_key = $this->generate_cache_key( $page_id, $taxonomy, $type );
/**
* When the caching mechanism changes. Change this value.
*
* Use hex. e.g. 0, 1, 2, 9, a, b
*/
$revision = '3';
/**
* Change key based on options.
*/
$options = $this->enable_ld_json_breadcrumbs() ? '1' : '0';
$options .= $this->enable_ld_json_sitename() ? '1' : '0';
$options .= $this->enable_ld_json_searchbox() ? '1' : '0';
$this->ld_json_transient = 'tsf_' . $revision . '_' . $options . '_ldjs_' . $cache_key;
}
/**
* Generate transient key based on query vars or input variables.
*
* Warning: This can generate errors when used too early if no type has been set.
*
* @since 2.3.3
* @since 2.6.0 Refactored.
* @since 2.9.1 : 1. Added early singular type detection.
* 2. Moved generation into $this->generate_cache_key_by_query().
* @see $this->generate_cache_key_by_query() to get cache key from the query.
* @see $this->generate_cache_key_by_type() to get cache key outside of the query.
*
* @param int|string|bool $page_id the Taxonomy or Post ID.
* @param string $taxonomy The Taxonomy name.
* @param string $type The Post Type
* @return string The generated cache key by query or type.
*/
public function generate_cache_key( $page_id, $taxonomy = '', $type = null ) {
if ( isset( $type ) )
return $this->generate_cache_key_by_type( $page_id, $taxonomy, $type );
return $this->generate_cache_key_by_query( $page_id, $taxonomy );
}
/**
* Generate transient key based on query vars.
*
* Warning: This can generate errors when used too early if no type has been set.
*
* @since 2.9.1
* @staticvar array $cached_id : contains cache strings.
* @see $this->generate_cache_key_by_type() to get cache key outside of the query.
*
* @param int|string|bool $page_id the Taxonomy or Post ID.
* @param string $taxonomy The Taxonomy name.
* @param string $type The Post Type
* @return string The generated cache key by query.
*/
public function generate_cache_key_by_query( $page_id, $taxonomy = '' ) {
$page_id = $page_id ?: $this->get_the_real_ID();
static $cached_id = array();
if ( isset( $cached_id[ $page_id ][ $taxonomy ] ) )
return $cached_id[ $page_id ][ $taxonomy ];
// var_dump(): debugging.
$this->can_cache_query();
//* Placeholder ID.
$the_id = '';
$t = $taxonomy;
if ( $this->is_404() ) {
$the_id = '_404_';
} elseif ( ( $this->is_real_front_page() || $this->is_front_page_by_id( $page_id ) ) || ( $this->is_admin() && $this->is_seo_settings_page( true ) ) ) {
//* Front/HomePage.
$the_id = $this->generate_front_page_cache_key();
} elseif ( $this->is_blog_page( $page_id ) ) {
$the_id = 'blog_' . $page_id;
} elseif ( $this->is_singular() ) {
if ( $this->is_page( $page_id ) ) {
$the_id = 'page_' . $page_id;
} elseif ( $this->is_single( $page_id ) ) {
$the_id = 'post_' . $page_id;
} elseif ( $this->is_attachment( $page_id ) ) {
$the_id = 'attach_' . $page_id;
} else {
//* Other.
$the_id = 'singular_' . $page_id;
}
} elseif ( $this->is_search() ) {
$query = '';
if ( function_exists( 'get_search_query' ) ) {
$search_query = \get_search_query();
if ( $search_query )
$query = str_replace( ' ', '', $search_query );
//* Limit to 10 chars.
if ( mb_strlen( $query ) > 10 )
$query = mb_substr( $query, 0, 10 );
$query = \esc_sql( $query );
}
//* Temporarily disable caches to prevent database spam.
$this->the_seo_framework_use_transients = false;
$this->use_object_cache = false;
$the_id = $page_id . '_s_' . $query;
} elseif ( $this->is_archive() ) {
if ( $this->is_category() || $this->is_tag() || $this->is_tax() ) {
if ( empty( $t ) ) {
$o = \get_queried_object();
if ( isset( $o->taxonomy ) )
$t = $o->taxonomy;
}
$the_id = $this->generate_taxonomial_cache_key( $page_id, $t );
if ( $this->is_tax() )
$the_id = 'archives_' . $the_id;
} elseif ( $this->is_author() ) {
$the_id = 'author_' . $page_id;
} elseif ( $this->is_date() ) {
$post = \get_post();
if ( $post && isset( $post->post_date ) ) {
$date = $post->post_date;
if ( $this->is_year() ) {
$the_id .= 'year_' . \mysql2date( 'y', $date, false );
} elseif ( $this->is_month() ) {
$the_id .= 'month_' . \mysql2date( 'm_y', $date, false );
} elseif ( $this->is_day() ) {
//* Day. The correct notation.
$the_id .= 'day_' . \mysql2date( 'd_m_y', $date, false );
}
} else {
//* Get seconds since UNIX Epoch. This is a failsafe.
/**
* @staticvar string $unix : Used to maintain a static timestamp for this query.
*/
static $unix = null;
if ( ! isset( $unix ) )
$unix = date( 'U' );
//* Temporarily disable caches to prevent database spam.
$this->the_seo_framework_use_transients = false;
$this->use_object_cache = false;
$the_id = 'unix_' . $unix;
}
} else {
//* Other taxonomial archives.
if ( empty( $t ) ) {
$post_type = \get_query_var( 'post_type' );
if ( is_array( $post_type ) )
reset( $post_type );
if ( $post_type )
$post_type_obj = \get_post_type_object( $post_type );
if ( isset( $post_type_obj->labels->name ) )
$t = $post_type_obj->labels->name;
}
//* Still empty? Try this.
if ( empty( $t ) )
$t = \get_query_var( 'taxonomy' );
$the_id = $this->generate_taxonomial_cache_key( $page_id, $t );
$the_id = 'archives_' . $the_id;
}
}
/**
* Blog page isn't set or something else is happening. Causes all kinds of problems :(
* Noob. :D
*/
if ( empty( $the_id ) )
$the_id = 'noob_' . $page_id . '_' . $t;
/**
* This should be at most 25 chars. Unless the $blog_id is higher than 99,999,999.
* Then some cache keys will conflict on every 10th blog ID from eachother which post something on the same day..
* On the day archive. With the same description setting (short).
*/
return $cached_id[ $page_id ][ $taxonomy ] = $this->add_cache_key_suffix( $the_id );
}
/**
* Generate transient key based on input.
*
* Use this method if you wish to evade the query usage.
*
* @since 2.9.1
* @staticvar array $cached_id : contains cache strings.
* @see $this->generate_cache_key().
* @see $this->generate_cache_key_by_query() to get cache key from the query.
*
* @param int|string|bool $page_id the Taxonomy or Post ID.
* @param string $taxonomy The Taxonomy name.
* @param string $type The Post Type
* @return string The generated cache key by type.
*/
public function generate_cache_key_by_type( $page_id, $taxonomy = '', $type = null ) {
switch ( $type ) :
case 'author' :
return $this->add_cache_key_suffix( 'author_' . $page_id );
break;
case 'frontpage' :
return $this->add_cache_key_suffix( $this->generate_front_page_cache_key() );
break;
case 'page' :
return $this->add_cache_key_suffix( 'page_' . $page_id );
break;
case 'post' :
return $this->add_cache_key_suffix( 'post_' . $page_id );
break;
case 'attachment' :
return $this->add_cache_key_suffix( 'attach_' . $page_id );
break;
case 'singular' :
return $this->add_cache_key_suffix( 'singular_' . $page_id );
break;
default :
$this->_doing_it_wrong( __METHOD__, 'Third parameter must be a known type.', '2.6.5' );
return $this->add_cache_key_suffix( \esc_sql( $type . '_' . $page_id . '_' . $taxonomy ) );
break;
endswitch;
}
/**
* Adds cache key suffix based on blog id and locale.
*
* @since 2.7.0
* @since 2.8.0 $locale is now static.
* $key may now be empty.
* @staticvar string $locale
*
* @return string the cache key.
*/
protected function add_cache_key_suffix( $key = '' ) {
global $blog_id;
static $locale = null;
if ( is_null( $locale ) )
$locale = strtolower( \get_locale() );
return $key . '_' . $blog_id . '_' . $locale;
}
/**
* Returns the front page partial transient key.
*
* @param string $type
* @return string the front page transient key.
*/
public function generate_front_page_cache_key( $type = '' ) {
if ( empty( $type ) ) {
if ( $this->has_page_on_front() ) {
$type = 'page';
} else {
$type = 'blog';
}
} else {
$type = \esc_sql( $type );
}
return $the_id = 'h' . $type . '_' . $this->get_the_front_page_ID();
}
/**
* Generates Cache key for taxonomial archives.
*
* @since 2.6.0
*
* @param int $page_id The taxonomy or page ID.
* @param string $taxonomy The taxonomy name.
*
* @return string The Taxonomial Archive cache key.
*/
protected function generate_taxonomial_cache_key( $page_id = '', $taxonomy = '' ) {
$the_id = '';
if ( false !== strpos( $taxonomy, '_' ) ) {
$taxonomy_name = explode( '_', $taxonomy );
if ( is_array( $taxonomy_name ) ) {
foreach ( $taxonomy_name as $name ) {
if ( mb_strlen( $name ) >= 3 ) {
$the_id .= mb_substr( $name, 0, 3 ) . '_';
} else {
$the_id = $name . '_';
}
}
}
}
if ( empty( $the_id ) ) {
if ( mb_strlen( $taxonomy ) >= 5 ) {
$the_id = mb_substr( $taxonomy, 0, 5 );
} else {
$the_id = \esc_sql( $taxonomy );
}
}
$the_id = strtolower( $the_id );
//* Put it all together.
return rtrim( $the_id, '_' ) . '_' . $page_id;
}
/**
* Returns the robots.txt object cache key.
*
* @since 2.8.0
*
* @return string The robots_txt cache key.
*/
public function get_robots_txt_cache_key() {
$revision = '1';
return $cache_key = 'robots_txt_output_' . $revision . $GLOBALS['blog_id'];
}
/**
* Returns the TSF meta output Object cache key.
*
* @since 2.8.0
* @uses THE_SEO_FRAMEWORK_DB_VERSION as cache key buster.
* @see $this->get_meta_output_cache_key_by_type();
*
* @param int $id The ID. Defaults to $this->get_the_real_ID();
* @return string The TSF meta output cache key.
*/
public function get_meta_output_cache_key( $id = 0 ) {
/**
* Cache key buster.
* Busts cache on each new db version.
*/
$key = $this->generate_cache_key( $id ) . '_' . THE_SEO_FRAMEWORK_DB_VERSION;
/**
* Give each paged pages/archives a different cache key.
* @since 2.2.6
*/
$page = (string) $this->page();
$paged = (string) $this->paged();
return $cache_key = 'seo_framework_output_' . $key . '_' . $paged . '_' . $page;
}
/**
* Returns the TSF meta output Object cache key.
*
* @since 2.9.1
* @uses THE_SEO_FRAMEWORK_DB_VERSION as cache key buster.
*
* @param int $id The ID. Defaults to $this->get_the_real_ID();
* @param string $type The post type.
* @return string The TSF meta output cache key.
*/
public function get_meta_output_cache_key_by_type( $id = 0, $type = '' ) {
/**
* Cache key buster.
* Busts cache on each new db version.
*/
$key = $this->generate_cache_key_by_type( $id, '', $type ) . '_' . THE_SEO_FRAMEWORK_DB_VERSION;
$page = '1';
$paged = '1';
return $cache_key = 'seo_framework_output_' . $key . '_' . $paged . '_' . $page;
}
/**
* Delete transient on term save/deletion.
*
* @since 2.3.3
*
* @param int $term_id The Term ID
* @param int $tt_id The Term Taxonomy ID.
* @param string $taxonomy The Taxonomy type.
* @param mixed $deleted_term Copy of the already-deleted term. Unused.
*/
public function delete_auto_description_transients_term( $term_id, $tt_id, $taxonomy, $deleted_term = '' ) {
$term_id = $term_id ?: $tt_id;
$this->delete_cache( 'term', $term_id, array( 'term' => $taxonomy ) );
}
/**
* Checks whether the permalink structure is updated.
*
* @since 2.3.0
* @since 2.7.0 : Added admin referer check.
*
* @return bool Whether if sitemap transient is deleted.
*/
public function delete_sitemap_transient_permalink_updated() {
if ( isset( $_POST['permalink_structure'] ) || isset( $_POST['category_base'] ) ) {
if ( \check_admin_referer( 'update-permalink' ) )
return $this->delete_cache( 'sitemap' );
}
return false;
}
/**
* Delete transient for sitemap on requests.
* Also ping search engines.
*
* @since 2.2.9
* @since 2.8.0 : Mow listens to option 'cache_sitemap' before deleting transient.
* @since 2.8.2 : Added cache to prevent duplicated flushes.
* @staticvar bool $run
*
* @return bool True on success, false on failure.
*/
public function delete_sitemap_transient() {
static $run = false;
if ( $run )
return false;
$this->is_option_checked( 'cache_sitemap' ) and \delete_transient( $this->sitemap_transient );
$this->ping_searchengines();
return $run = true;
}
/**
* Delete transient for the automatic description for blog on save request.
* Returns old option, since that's passed for sanitation within WP Core.
*
* @since 2.3.3
* @since 2.8.0 : Now listens to option 'cache_meta_description' before deleting transient.
*
* @param string $old_option The previous blog description option.
* @return string Previous option.
*/
public function delete_auto_description_frontpage_transient( $old_option ) {
$this->setup_auto_description_transient( $this->get_the_front_page_ID(), '', 'frontpage' );
$this->is_option_checked( 'cache_meta_description' ) and \delete_transient( $this->auto_description_transient );
return $old_option;
}
/**
* Delete transient for the automatic description on requests.
*