-
Notifications
You must be signed in to change notification settings - Fork 107
/
esi.class.php
executable file
·901 lines (772 loc) · 24.7 KB
/
esi.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
<?php
/**
* The esi class.
*
* This is used to define all esi related functions.
*
* @since 1.1.3
* @since 1.5 Moved into /inc
* @package LiteSpeed_Cache
* @subpackage LiteSpeed_Cache/inc
* @author LiteSpeed Technologies <info@litespeedtech.com>
*/
if ( ! defined( 'WPINC' ) ) {
die ;
}
class LiteSpeed_Cache_ESI
{
private static $_instance ;
private static $has_esi = false ;
private $esi_args = null ;
private $_esi_preserve_list = array() ;
private $_nonce_actions = array( -1 ) ;
const QS_ACTION = 'lsesi' ;
const QS_PARAMS = 'esi' ;
const PARAM_ARGS = 'args' ;
const PARAM_ID = 'id' ;
const PARAM_INSTANCE = 'instance' ;
const PARAM_NAME = 'name' ;
const WIDGET_OPID_ESIENABLE = 'widget_esi_enable' ;
const WIDGET_OPID_TTL = 'widget_ttl' ;
/**
* Constructor of ESI
*
* @since 1.2.0
* @access private
*/
private function __construct()
{
add_action( 'template_include', 'LiteSpeed_Cache_ESI::esi_template', 100 ) ;
add_action( 'load-widgets.php', 'LiteSpeed_Cache_Purge::purge_widget' ) ;
add_action( 'wp_update_comment_count', 'LiteSpeed_Cache_Purge::purge_comment_widget' ) ;
// This defination is along with LiteSpeed_Cache_API::nonce() func
! defined( 'LSCWP_NONCE' ) && define( 'LSCWP_NONCE', true ) ;//Used in Bloom
/**
* Recover REQUEST_URI
* @since 1.8.1
*/
if ( ! empty( $_GET[ self::QS_ACTION ] ) ) {
$this->_register_esi_actions() ;
}
/**
* Shortcode ESI
*
* To use it, just change the origianl shortcode as below:
* old: [someshortcode aa='bb']
* new: [esi someshortcode aa='bb' cache='private,no-vary' ttl='600']
*
* 1. `cache` attribute is optional, default to 'public,no-vary'.
* 2. `ttl` attribute is optional, default is your public TTL setting.
*
* @since 2.8
* @since 2.8.1 Check is_admin for Elementor compatibility #726013
*/
if ( ! is_admin() ) {
add_shortcode( 'esi', array( $this, 'shortcode' ) ) ;
}
/**
* Overwrite wp_create_nonce func
* @since 2.9.5
*/
if ( ! is_admin() && ! function_exists( 'wp_create_nonce' ) ) {
$this->_transform_nonce() ;
}
}
/**
* Take over all nonce calls and transform to ESI
*
* @since 2.9.5
*/
private function _transform_nonce()
{
LiteSpeed_Cache_Log::debug( '[ESI] Overwrite wp_create_nonce()' ) ;
/**
* If the nonce is in none_actions filter, convert it to ESI
*/
function wp_create_nonce( $action = -1 ) {
if ( LiteSpeed_Cache_ESI::get_instance()->is_nonce_action( $action ) ) {
$params = array(
'action' => $action,
) ;
return LiteSpeed_Cache_ESI::sub_esi_block( 'nonce', 'wp_create_nonce ' . $action, $params, '', true, true ) ;
}
return wp_create_nonce_litespeed_esi( $action ) ;
}
/**
* Ori WP wp_create_nonce
*/
function wp_create_nonce_litespeed_esi( $action = -1 ) {
$user = wp_get_current_user();
$uid = (int) $user->ID;
if ( ! $uid ) {
/** This filter is documented in wp-includes/pluggable.php */
$uid = apply_filters( 'nonce_user_logged_out', $uid, $action );
}
$token = wp_get_session_token();
$i = wp_nonce_tick();
return substr( wp_hash( $i . '|' . $action . '|' . $uid . '|' . $token, 'nonce' ), -12, 10 );
}
}
/**
* Register a new nonce action to convert it to ESI
*
* @since 2.9.5
*/
public function nonce_action( $action )
{
if ( in_array( $action, $this->_nonce_actions ) ) {
return ;
}
LiteSpeed_Cache_Log::debug( '[ESI] Append nonce action to nonce list [action] ' . $action ) ;
$this->_nonce_actions[] = $action ;
}
/**
* Check if an action is registered to replace ESI
*
* @since 2.9.5
*/
public function is_nonce_action( $action )
{
return in_array( $action, $this->_nonce_actions ) ;
}
/**
* Shortcode ESI
*
* @since 2.8
* @access public
*/
public function shortcode( $atts )
{
if ( empty( $atts[ 0 ] ) ) {
LiteSpeed_Cache_Log::debug( '[ESI] ===shortcode wrong format', $atts ) ;
return 'Wrong shortcode esi format' ;
}
$cache = 'public,no-vary' ;
if ( ! empty( $atts[ 'cache' ] ) ) {
$cache = $atts[ 'cache' ] ;
unset( $atts[ 'cache' ] ) ;
}
do_action( 'litespeed_esi_shortcode-' . $atts[ 0 ] ) ;
// Show ESI link
return self::sub_esi_block( 'esi', 'esi-shortcode', $atts, $cache ) ;
}
/**
* Check if the requested page has esi elements. If so, return esi on
* header.
*
* @since 1.1.3
* @access public
* @return string Esi On header if request has esi, empty string otherwise.
*/
public static function has_esi()
{
return self::$has_esi ;
}
/**
* Sets that the requested page has esi elements.
*
* @since 1.1.3
* @access public
*/
public static function set_has_esi()
{
self::$has_esi = true ;
}
/**
* Register all of the hooks related to the esi logic of the plugin.
* Specifically when the page IS an esi page.
*
* @since 1.1.3
* @access private
*/
private function _register_esi_actions()
{
define( 'LSCACHE_IS_ESI', $_GET[ self::QS_ACTION ] ) ;// Reused this to ESI block ID
! empty( $_SERVER[ 'ESI_REFERER' ] ) && defined( 'LSCWP_LOG' ) && LiteSpeed_Cache_Log::debug( '[ESI] ESI_REFERER: ' . $_SERVER[ 'ESI_REFERER' ] ) ;
/**
* Only when ESI's parent is not REST, replace REQUEST_URI to avoid breaking WP5 editor REST call
* @since 2.9.3
*/
if ( ! empty( $_SERVER[ 'ESI_REFERER' ] ) && ! LiteSpeed_Cache_REST::get_instance()->is_rest( $_SERVER[ 'ESI_REFERER' ] ) ) {
$_SERVER[ 'REQUEST_URI' ] = $_SERVER[ 'ESI_REFERER' ] ;
}
if ( ! empty( $_SERVER[ 'ESI_CONTENT_TYPE' ] ) && strpos( $_SERVER[ 'ESI_CONTENT_TYPE' ], 'application/json' ) === 0 ) {
add_filter( 'litespeed_is_json', '__return_true' ) ;
}
/**
* Make REST call be able to parse ESI
* NOTE: Not effective due to ESI req are all to `/` yet
* @since 2.9.4
*/
add_action( 'rest_api_init', array( $this, 'load_esi_block' ), 101 ) ;
// Register ESI blocks
add_action('litespeed_cache_load_esi_block-widget', array($this, 'load_widget_block')) ;
add_action('litespeed_cache_load_esi_block-admin-bar', array($this, 'load_admin_bar_block')) ;
add_action('litespeed_cache_load_esi_block-comment-form', array($this, 'load_comment_form_block')) ;
add_action('litespeed_cache_load_esi_block-nonce', array( $this, 'load_nonce_block' ) ) ;
add_action('litespeed_cache_load_esi_block-esi', array( $this, 'load_esi_shortcode' ) ) ;
}
/**
* Hooked to the template_include action.
* Selects the esi template file when the post type is a LiteSpeed ESI page.
*
* @since 1.1.3
* @access public
* @param string $template The template path filtered.
* @return string The new template path.
*/
public static function esi_template($template)
{
// Check if is an ESI request
if ( defined( 'LSCACHE_IS_ESI' ) ) {
LiteSpeed_Cache_Log::debug( '[ESI] calling template' ) ;
return LSCWP_DIR . 'tpl/esi.tpl.php' ;
}
self::get_instance()->register_not_esi_actions() ;
return $template ;
}
/**
* Register all of the hooks related to the esi logic of the plugin.
* Specifically when the page is NOT an esi page.
*
* @since 1.1.3
* @access public
*/
public function register_not_esi_actions()
{
do_action('litespeed_cache_is_not_esi_template') ;
if ( ! LiteSpeed_Cache_Control::is_cacheable() ) {
return ;
}
if ( LiteSpeed_Cache_Router::is_ajax() ) {
return ;
}
add_filter('widget_display_callback', array($this, 'sub_widget_block'), 0, 3) ;
// Add admin_bar esi
if ( LiteSpeed_Cache_Router::is_logged_in() ) {
remove_action('wp_footer', 'wp_admin_bar_render', 1000) ;
add_action('wp_footer', array($this, 'sub_admin_bar_block'), 1000) ;
}
// Add comment forum esi for logged-in user or commenter
if ( ! LiteSpeed_Cache_Router::is_ajax() && LiteSpeed_Cache_Vary::has_vary() ) {
add_filter( 'comment_form_defaults', array( $this, 'register_comment_form_actions' ) ) ;
}
}
/**
* Build the esi url. This method will build the html comment wrapper as well as serialize and encode the parameter array.
*
* The block_id parameter should contain alphanumeric and '-_' only.
*
* @since 1.1.3
* @access private
* @param string $block_id The id to use to display the correct esi block.
* @param string $wrapper The wrapper for the esi comments.
* @param array $params The esi parameters.
* @param string $control The cache control attribute if any.
* @param bool $silence If generate wrapper comment or not
* @param bool $preserved If this ESI block is used in any filter, need to temporarily convert it to a string to avoid the HTML tag being removed/filtered.
* @param bool $svar If store the value in memory or not, in memory wil be faster
* @param bool $inline_val If show the current value for current request( this can avoid multiple esi requests in first time cache generating process ) -- Not used yet
* @return bool|string False on error, the output otherwise.
*/
public static function sub_esi_block( $block_id, $wrapper, $params = array(), $control = 'private,no-vary', $silence = false, $preserved = false, $svar = false, $inline_val = false )
{
if ( empty($block_id) || ! is_array($params) || preg_match('/[^\w-]/', $block_id) ) {
return false ;
}
if ( $silence ) {
// Don't add comment to esi block ( orignal for nonce used in tag property data-nonce='esi_block' )
$params[ '_ls_silence' ] = true ;
}
if ( LiteSpeed_Cache_REST::get_instance()->is_rest() || LiteSpeed_Cache_REST::get_instance()->is_internal_rest() ) {
$params[ 'is_json' ] = 1 ;
}
$params = apply_filters('litespeed_cache_sub_esi_params-' . $block_id, $params) ;
$control = apply_filters('litespeed_cache_sub_esi_control-' . $block_id, $control) ;
if ( !is_array($params) || !is_string($control) ) {
defined( 'LSCWP_LOG' ) && LiteSpeed_Cache_Log::debug( "[ESI] 🛑 Sub hooks returned Params: \n" . var_export($params, true) . "\ncache control: \n" . var_export($control, true) ) ;
return false ;
}
// Build params for URL
$appended_params = array(
self::QS_ACTION => $block_id,
) ;
if ( ! empty( $control ) ) {
$appended_params[ '_control' ] = $control ;
}
if ( $params ) {
$appended_params[ self::QS_PARAMS ] = base64_encode( json_encode( $params ) ) ;
}
// Append hash
$appended_params[ '_hash' ] = self::_gen_esi_md5( $appended_params ) ;
/**
* Escape potential chars
* @since 2.9.4
*/
$appended_params = array_map( 'urlencode', $appended_params ) ;
// Generate ESI URL
$url = add_query_arg( $appended_params, trailingslashit( wp_make_link_relative( home_url() ) ) ) ;
$output = "<esi:include src='$url'" ;
if ( ! empty( $control ) ) {
$output .= " cache-control='$control'" ;
}
if ( $svar ) {
$output .= " as-var='1'" ;
}
$output .= " />" ;
if ( ! $silence ) {
$output = "<!-- lscwp $wrapper -->$output<!-- lscwp $wrapper esi end -->" ;
}
LiteSpeed_Cache_Log::debug( "[ESI] 💕 [BLock_ID] $block_id \t[wrapper] $wrapper \t\t[Control] $control" ) ;
LiteSpeed_Cache_Log::debug2( $output ) ;
self::set_has_esi() ;
// Convert to string to avoid html chars filter when using
// Will reverse the buffer when output in self::finalize()
if ( $preserved ) {
$hash = md5( $output ) ;
self::get_instance()->_esi_preserve_list[ $hash ] = $output ;
LiteSpeed_Cache_Log::debug( "[ESI] Preserved to $hash" ) ;
return $hash ;
}
return $output ;
}
/**
* Generate ESI hash md5
*
* @since 2.9.6
* @access private
*/
private static function _gen_esi_md5( $params )
{
$keys = array(
self::QS_ACTION,
'_control',
self::QS_PARAMS,
) ;
$str = '' ;
foreach ( $keys as $v ) {
if ( isset( $params[ $v ] ) && is_string( $params[ $v ] ) ) {
$str .= $params[ $v ] ;
}
}
LiteSpeed_Cache_Log::debug2( '[ESI] md5_string=' . $str ) ;
return md5( LiteSpeed_Cache::config( LiteSpeed_Cache_Config::HASH ) . $str ) ;
}
/**
* Parses the request parameters on an ESI request
*
* @since 1.1.3
* @access private
*/
private function _parse_esi_param()
{
if ( ! isset($_REQUEST[self::QS_PARAMS]) ) {
return false ;
}
$req_params = $_REQUEST[self::QS_PARAMS] ;
$unencrypted = base64_decode($req_params) ;
if ( $unencrypted === false ) {
return false ;
}
LiteSpeed_Cache_Log::debug2( '[ESI] parms', $unencrypted ) ;
// $unencoded = urldecode($unencrypted) ; no need to do this as $_GET is already parsed
$params = json_decode( $unencrypted, true ) ;
return $params ;
}
/**
* Select the correct esi output based on the parameters in an ESI request.
*
* @since 1.1.3
* @access public
*/
public function load_esi_block()
{
/**
* Validate if is a legal ESI req
* @since 2.9.6
*/
if ( empty( $_GET[ '_hash' ] ) || self::_gen_esi_md5( $_GET ) != $_GET[ '_hash' ] ) {
LiteSpeed_Cache_Log::debug( '[ESI] ❌ Failed to validate _hash' ) ;
return ;
}
$params = $this->_parse_esi_param() ;
if ( defined( 'LSCWP_LOG' ) ) {
$logInfo = '[ESI] ⭕ ' ;
if( ! empty( $params[ self::PARAM_NAME ] ) ) {
$logInfo .= ' Name: ' . $params[ self::PARAM_NAME ] . ' ----- ' ;
}
$logInfo .= ' [ID] ' . LSCACHE_IS_ESI ;
LiteSpeed_Cache_Log::debug( $logInfo ) ;
}
if ( ! empty( $params[ '_ls_silence' ] ) ) {
define( 'LSCACHE_ESI_SILENCE', true ) ;
}
/**
* Buffer needs to be JSON format
* @since 2.9.4
*/
if ( ! empty( $params[ 'is_json' ] ) ) {
add_filter( 'litespeed_is_json', '__return_true' ) ;
}
LiteSpeed_Cache_Tag::add( rtrim( LiteSpeed_Cache_Tag::TYPE_ESI, '.' ) ) ;
LiteSpeed_Cache_Tag::add( LiteSpeed_Cache_Tag::TYPE_ESI . LSCACHE_IS_ESI ) ;
// LiteSpeed_Cache_Log::debug(var_export($params, true ));
/**
* Handle default cache control 'private,no-vary' for sub_esi_block() @ticket #923505
*
* @since 2.2.3
*/
if ( ! empty( $_GET[ '_control' ] ) ) {
$control = explode( ',', $_GET[ '_control' ] ) ;
if ( in_array( 'private', $control ) ) {
LiteSpeed_Cache_Control::set_private() ;
}
if ( in_array( 'no-vary', $control ) ) {
LiteSpeed_Cache_Control::set_no_vary() ;
}
}
do_action('litespeed_cache_load_esi_block-' . LSCACHE_IS_ESI, $params) ;
}
// BEGIN helper functions
// The *_sub_* functions are helpers for the sub_* functions.
// The *_load_* functions are helpers for the load_* functions.
/**
* Get the configuration option for the current widget.
*
* @since 1.1.3
* @access public
* @param WP_Widget $widget The widget to get the options for.
* @return mixed null if not found, an array of the options otherwise.
*/
public static function widget_load_get_options($widget)
{
add_filter('litespeed_cache_widget_default_options', 'LiteSpeed_Cache_ESI::widget_default_options', 10, 2) ;
if ( ! is_numeric($widget->number) ) {
return null ;
}
if ( $widget->updated ) {
$settings = get_option($widget->option_name) ;
}
else {
$settings = $widget->get_settings() ;
}
if ( ! isset($settings) ) {
return null ;
}
$instance = $settings[$widget->number] ;
if ( ! isset($instance) || ! isset($instance[LiteSpeed_Cache_Config::OPTION_NAME]) ) {
return null;
}
return $instance[LiteSpeed_Cache_Config::OPTION_NAME] ;
}
/**
* Loads the default options for default WordPress widgets.
*
* @since 1.1.3
* @access public
* @param array $options The current options selected.
* @param WP_Widget $widget The widget to be configured.
* @return array The updated options.
*/
public static function widget_default_options($options, $widget)
{
if ( ! is_array($options) ) {
return $options ;
}
$widget_name = get_class($widget) ;
switch ($widget_name) {
case 'WP_Widget_Recent_Posts' :
case 'WP_Widget_Recent_Comments' :
$options[self::WIDGET_OPID_ESIENABLE] = LiteSpeed_Cache_Config::VAL_OFF ;
$options[self::WIDGET_OPID_TTL] = 86400 ;
break ;
default :
break ;
}
return $options ;
}
// END helper functions.
/**
* Hooked to the widget_display_callback filter.
* If the admin configured the widget to display via esi, this function
* will set up the esi request and cancel the widget display.
*
* @since 1.1.3
* @access public
* @param array $instance Parameter used to build the widget.
* @param WP_Widget $widget The widget to build.
* @param array $args Parameter used to build the widget.
* @return mixed Return false if display through esi, instance otherwise.
*/
public function sub_widget_block( $instance, WP_Widget $widget, array $args )
{
// #210407
if ( ! is_array( $instance ) ) {
return $instance ;
}
$name = get_class( $widget ) ;
if ( ! isset( $instance[ LiteSpeed_Cache_Config::OPTION_NAME ] ) ) {
return $instance ;
}
$options = $instance[ LiteSpeed_Cache_Config::OPTION_NAME ] ;
if ( ! isset( $options ) || ! $options[ self::WIDGET_OPID_ESIENABLE ] ) {
defined( 'LSCWP_LOG' ) && LiteSpeed_Cache_Log::debug( 'ESI 0 ' . $name . ': '. ( ! isset( $options ) ? 'not set' : 'set off' ) ) ;
return $instance ;
}
$esi_private = $options[ self::WIDGET_OPID_ESIENABLE ] === LiteSpeed_Cache_Config::VAL_ON2 ? 'private,' : '' ;
$params = array(
self::PARAM_NAME => $name,
self::PARAM_ID => $widget->id,
self::PARAM_INSTANCE => $instance,
self::PARAM_ARGS => $args
) ;
echo self::sub_esi_block( 'widget', 'widget ' . $name, $params, $esi_private . 'no-vary' ) ;
return false ;
}
/**
* Hooked to the wp_footer action.
* Sets up the ESI request for the admin bar.
*
* @access public
* @since 1.1.3
* @global type $wp_admin_bar
*/
public function sub_admin_bar_block()
{
global $wp_admin_bar ;
if ( ! is_admin_bar_showing() || ! is_object($wp_admin_bar) ) {
return ;
}
// To make each admin bar ESI request different for `Edit` button different link
$params = array(
'ref' => $_SERVER[ 'REQUEST_URI' ],
) ;
echo self::sub_esi_block( 'admin-bar', 'adminbar', $params ) ;
}
/**
* Parses the esi input parameters and generates the widget for esi display.
*
* @access public
* @since 1.1.3
* @global $wp_widget_factory
* @param array $params Input parameters needed to correctly display widget
*/
public function load_widget_block( $params )
{
global $wp_widget_factory ;
$widget = $wp_widget_factory->widgets[ $params[ self::PARAM_NAME ] ] ;
$option = self::widget_load_get_options( $widget ) ;
// Since we only reach here via esi, safe to assume setting exists.
$ttl = $option[ self::WIDGET_OPID_TTL ] ;
defined( 'LSCWP_LOG' ) && LiteSpeed_Cache_Log::debug( 'ESI widget render: name ' . $params[ self::PARAM_NAME ] . ', id ' . $params[ self::PARAM_ID ] . ', ttl ' . $ttl ) ;
if ( $ttl == 0 ) {
LiteSpeed_Cache_Control::set_nocache( 'ESI Widget time to live set to 0' ) ;
}
else {
LiteSpeed_Cache_Control::set_custom_ttl( $ttl ) ;
if ( $option[ self::WIDGET_OPID_ESIENABLE ] === LiteSpeed_Cache_Config::VAL_ON2 ) {
LiteSpeed_Cache_Control::set_private() ;
}
LiteSpeed_Cache_Control::set_no_vary() ;
LiteSpeed_Cache_Tag::add( LiteSpeed_Cache_Tag::TYPE_WIDGET . $params[ self::PARAM_ID ] ) ;
}
the_widget( $params[ self::PARAM_NAME ], $params[ self::PARAM_INSTANCE ], $params[ self::PARAM_ARGS ] ) ;
}
/**
* Generates the admin bar for esi display.
*
* @access public
* @since 1.1.3
*/
public function load_admin_bar_block( $params )
{
wp_admin_bar_render() ;
if ( ! LiteSpeed_Cache::config( LiteSpeed_Cache_Config::OPID_ESI_CACHE_ADMBAR ) ) {
LiteSpeed_Cache_Control::set_nocache( 'build-in set to not cacheable' ) ;
}
else {
LiteSpeed_Cache_Control::set_private() ;
LiteSpeed_Cache_Control::set_no_vary() ;
}
defined( 'LSCWP_LOG' ) && LiteSpeed_Cache_Log::debug( 'ESI: adminbar ref: ' . $_SERVER[ 'REQUEST_URI' ] ) ;
}
/**
* Parses the esi input parameters and generates the comment form for esi display.
*
* @access public
* @since 1.1.3
* @param array $params Input parameters needed to correctly display comment form
*/
public function load_comment_form_block( $params )
{
comment_form( $params[ self::PARAM_ARGS ], $params[ self::PARAM_ID ] ) ;
if ( ! LiteSpeed_Cache::config( LiteSpeed_Cache_Config::OPID_ESI_CACHE_COMMFORM ) ) {
LiteSpeed_Cache_Control::set_nocache( 'build-in set to not cacheable' ) ;
}
else {
// by default comment form is public
if ( LiteSpeed_Cache_Vary::has_vary() ) {
LiteSpeed_Cache_Control::set_private() ;
LiteSpeed_Cache_Control::set_no_vary() ;
}
}
}
/**
* Generate nonce for certain action
*
* @access public
* @since 2.6
*/
public function load_nonce_block( $params )
{
$action = $params[ 'action' ] ;
LiteSpeed_Cache_Log::debug( '[ESI] load_nonce_block [action] ' . $action ) ;
// set nonce TTL to half day
LiteSpeed_Cache_Control::set_custom_ttl( 43200 ) ;
if ( LiteSpeed_Cache_Router::is_logged_in() ) {
LiteSpeed_Cache_Control::set_private() ;
}
if ( function_exists( 'wp_create_nonce_litespeed_esi' ) ) {
echo wp_create_nonce_litespeed_esi( $action ) ;
}
else {
echo wp_create_nonce( $action ) ;
}
}
/**
* Show original shortcode
*
* @access public
* @since 2.8
*/
public function load_esi_shortcode( $params )
{
if ( isset( $params[ 'ttl' ] ) ) {
if ( ! $params[ 'ttl' ] ) {
LiteSpeed_Cache_Control::set_nocache( 'ESI shortcode att ttl=0' ) ;
}
else {
LiteSpeed_Cache_Control::set_custom_ttl( $params[ 'ttl' ] ) ;
}
unset( $params[ 'ttl' ] ) ;
}
// Replace to original shortcode
$shortcode = $params[ 0 ] ;
$atts_ori = array() ;
foreach ( $params as $k => $v ) {
if ( $k === 0 ) {
continue ;
}
$atts_ori[] = is_string( $k ) ? "$k='" . addslashes( $v ) . "'" : $v ;
}
LiteSpeed_Cache_Tag::add( LiteSpeed_Cache_Tag::TYPE_ESI . "esi.$shortcode" ) ;
// Output original shortcode final content
echo do_shortcode( "[$shortcode " . implode( ' ', $atts_ori ) . " ]" ) ;
}
/**
* Hooked to the comment_form_defaults filter.
* Stores the default comment form settings.
* If sub_comment_form_block is triggered, the output buffer is cleared and an esi block is added. The remaining comment form is also buffered and cleared.
* Else there is no need to make the comment form ESI.
*
* @since 1.1.3
* @access public
* @param array $defaults The default comment form settings.
* @return array The default comment form settings.
*/
public function register_comment_form_actions( $defaults )
{
$this->esi_args = $defaults ;
echo LiteSpeed_Cache_GUI::clean_wrapper_begin() ;
add_filter( 'comment_form_submit_button', array( $this, 'sub_comment_form_block' ), 1000, 2 ) ;// Needs to get param from this hook and generate esi block
return $defaults ;
}
/**
* Hooked to the comment_form_submit_button filter.
*
* This method will compare the used comment form args against the default args. The difference will be passed to the esi request.
*
* @access public
* @since 1.1.3
* @global type $post
* @param $unused
* @param array $args The used comment form args.
* @return unused.
*/
public function sub_comment_form_block( $unused, $args )
{
if ( empty( $args ) || empty( $this->esi_args ) ) {
LiteSpeed_Cache_Log::debug( 'comment form args empty?' ) ;
return $unused ;
}
$esi_args = array() ;
// compare current args with default ones
foreach ( $args as $k => $v ) {
if ( ! isset( $this->esi_args[ $k ] ) ) {
$esi_args[ $k ] = $v ;
}
elseif ( is_array( $v ) ) {
$diff = array_diff_assoc( $v, $this->esi_args[ $k ] ) ;
if ( ! empty( $diff ) ) {
$esi_args[ $k ] = $diff ;
}
}
elseif ( $v !== $this->esi_args[ $k ] ) {
$esi_args[ $k ] = $v ;
}
}
echo LiteSpeed_Cache_GUI::clean_wrapper_end() ;
global $post ;
$params = array(
self::PARAM_ID => $post->ID,
self::PARAM_ARGS => $esi_args,
) ;
echo self::sub_esi_block( 'comment-form', 'comment form', $params ) ;
echo LiteSpeed_Cache_GUI::clean_wrapper_begin() ;
add_action( 'comment_form_after', array( $this, 'comment_form_sub_clean' ) ) ;
return $unused ;
}
/**
* Hooked to the comment_form_after action.
* Cleans up the remaining comment form output.
*
* @since 1.1.3
* @access public
*/
public function comment_form_sub_clean()
{
echo LiteSpeed_Cache_GUI::clean_wrapper_end() ;
}
/**
* Replace preseved blocks
*
* @since 2.6
* @access public
*/
public static function finalize( $buffer )
{
$instance = self::get_instance() ;
// Bypass if no preserved list to be replaced
if ( ! $instance->_esi_preserve_list ) {
return $buffer ;
}
$keys = array_keys( $instance->_esi_preserve_list ) ;
LiteSpeed_Cache_Log::debug( '[ESI] replacing preserved blocks', $keys ) ;
$buffer = str_replace( $keys , $instance->_esi_preserve_list, $buffer ) ;
return $buffer ;
}
/**
* Get the current instance object.
*
* @since 1.1.3
* @access public
* @return Current class instance.
*/
public static function get_instance()
{
if ( ! isset(self::$_instance) ) {
self::$_instance = new self() ;
}
return self::$_instance ;
}
}