<?php

[0] Fix | Delete

[1] Fix | Delete

/**

[2] Fix | Delete

* The plugin cache-control class for X-Litespeed-Cache-Control

[3] Fix | Delete

*

[4] Fix | Delete

* @since 1.1.3

[5] Fix | Delete

* @package LiteSpeed

[6] Fix | Delete

* @subpackage LiteSpeed/inc

[7] Fix | Delete

* @author LiteSpeed Technologies <info@litespeedtech.com>

[8] Fix | Delete

*/

[9] Fix | Delete

[10] Fix | Delete

namespace LiteSpeed;

[11] Fix | Delete

[12] Fix | Delete

defined('WPINC') || exit();

[13] Fix | Delete

[14] Fix | Delete

class Control extends Root

[15] Fix | Delete

{

[16] Fix | Delete

const LOG_TAG = '💵';

[17] Fix | Delete

[18] Fix | Delete

const BM_CACHEABLE = 1;

[19] Fix | Delete

const BM_PRIVATE = 2;

[20] Fix | Delete

const BM_SHARED = 4;

[21] Fix | Delete

const BM_NO_VARY = 8;

[22] Fix | Delete

const BM_FORCED_CACHEABLE = 32;

[23] Fix | Delete

const BM_PUBLIC_FORCED = 64;

[24] Fix | Delete

const BM_STALE = 128;

[25] Fix | Delete

const BM_NOTCACHEABLE = 256;

[26] Fix | Delete

[27] Fix | Delete

const X_HEADER = 'X-LiteSpeed-Cache-Control';

[28] Fix | Delete

[29] Fix | Delete

protected static $_control = 0;

[30] Fix | Delete

protected static $_custom_ttl = 0;

[31] Fix | Delete

[32] Fix | Delete

private $_response_header_ttls = array();

[33] Fix | Delete

[34] Fix | Delete

/**

[35] Fix | Delete

* Init cache control

[36] Fix | Delete

*

[37] Fix | Delete

* @since 1.6.2

[38] Fix | Delete

*/

[39] Fix | Delete

public function init()

[40] Fix | Delete

{

[41] Fix | Delete

/**

[42] Fix | Delete

* Add vary filter for Role Excludes

[43] Fix | Delete

* @since 1.6.2

[44] Fix | Delete

*/

[45] Fix | Delete

add_filter('litespeed_vary', array($this, 'vary_add_role_exclude'));

[46] Fix | Delete

[47] Fix | Delete

// 301 redirect hook

[48] Fix | Delete

add_filter('wp_redirect', array($this, 'check_redirect'), 10, 2);

[49] Fix | Delete

[50] Fix | Delete

// Load response header conf

[51] Fix | Delete

$this->_response_header_ttls = $this->conf(Base::O_CACHE_TTL_STATUS);

[52] Fix | Delete

foreach ($this->_response_header_ttls as $k => $v) {

[53] Fix | Delete

$v = explode(' ', $v);

[54] Fix | Delete

if (empty($v[0]) || empty($v[1])) {

[55] Fix | Delete

continue;

[56] Fix | Delete

}

[57] Fix | Delete

$this->_response_header_ttls[$v[0]] = $v[1];

[58] Fix | Delete

}

[59] Fix | Delete

[60] Fix | Delete

if ($this->conf(Base::O_PURGE_STALE)) {

[61] Fix | Delete

$this->set_stale();

[62] Fix | Delete

}

[63] Fix | Delete

}

[64] Fix | Delete

[65] Fix | Delete

/**

[66] Fix | Delete

* Exclude role from optimization filter

[67] Fix | Delete

*

[68] Fix | Delete

* @since 1.6.2

[69] Fix | Delete

* @access public

[70] Fix | Delete

*/

[71] Fix | Delete

public function vary_add_role_exclude($vary)

[72] Fix | Delete

{

[73] Fix | Delete

if ($this->in_cache_exc_roles()) {

[74] Fix | Delete

$vary['role_exclude_cache'] = 1;

[75] Fix | Delete

}

[76] Fix | Delete

[77] Fix | Delete

return $vary;

[78] Fix | Delete

}

[79] Fix | Delete

[80] Fix | Delete

/**

[81] Fix | Delete

* Check if one user role is in exclude cache group settings

[82] Fix | Delete

*

[83] Fix | Delete

* @since 1.6.2

[84] Fix | Delete

* @since 3.0 Moved here from conf.cls

[85] Fix | Delete

* @access public

[86] Fix | Delete

* @param string $role The user role

[87] Fix | Delete

* @return int The set value if already set

[88] Fix | Delete

*/

[89] Fix | Delete

public function in_cache_exc_roles($role = null)

[90] Fix | Delete

{

[91] Fix | Delete

// Get user role

[92] Fix | Delete

if ($role === null) {

[93] Fix | Delete

$role = Router::get_role();

[94] Fix | Delete

}

[95] Fix | Delete

[96] Fix | Delete

if (!$role) {

[97] Fix | Delete

return false;

[98] Fix | Delete

}

[99] Fix | Delete

[100] Fix | Delete

$roles = explode(',', $role);

[101] Fix | Delete

$found = array_intersect($roles, $this->conf(Base::O_CACHE_EXC_ROLES));

[102] Fix | Delete

[103] Fix | Delete

return $found ? implode(',', $found) : false;

[104] Fix | Delete

}

[105] Fix | Delete

[106] Fix | Delete

/**

[107] Fix | Delete

* 1. Initialize cacheable status for `wp` hook

[108] Fix | Delete

* 2. Hook error page tags for cacheable pages

[109] Fix | Delete

*

[110] Fix | Delete

* @since 1.1.3

[111] Fix | Delete

* @access public

[112] Fix | Delete

*/

[113] Fix | Delete

public function init_cacheable()

[114] Fix | Delete

{

[115] Fix | Delete

// Hook `wp` to mark default cacheable status

[116] Fix | Delete

// NOTE: Any process that does NOT run into `wp` hook will not get cacheable by default

[117] Fix | Delete

add_action('wp', array($this, 'set_cacheable'), 5);

[118] Fix | Delete

[119] Fix | Delete

// Hook WP REST to be cacheable

[120] Fix | Delete

if ($this->conf(Base::O_CACHE_REST)) {

[121] Fix | Delete

add_action('rest_api_init', array($this, 'set_cacheable'), 5);

[122] Fix | Delete

}

[123] Fix | Delete

[124] Fix | Delete

// Cache resources

[125] Fix | Delete

// NOTE: If any strange resource doesn't use normal WP logic `wp_loaded` hook, rewrite rule can handle it

[126] Fix | Delete

$cache_res = $this->conf(Base::O_CACHE_RES);

[127] Fix | Delete

if ($cache_res) {

[128] Fix | Delete

$uri = esc_url($_SERVER['REQUEST_URI']); // todo: check if need esc_url()

[129] Fix | Delete

$pattern = '!' . LSCWP_CONTENT_FOLDER . Htaccess::RW_PATTERN_RES . '!';

[130] Fix | Delete

if (preg_match($pattern, $uri)) {

[131] Fix | Delete

add_action('wp_loaded', array($this, 'set_cacheable'), 5);

[132] Fix | Delete

}

[133] Fix | Delete

}

[134] Fix | Delete

[135] Fix | Delete

// AJAX cache

[136] Fix | Delete

$ajax_cache = $this->conf(Base::O_CACHE_AJAX_TTL);

[137] Fix | Delete

foreach ($ajax_cache as $v) {

[138] Fix | Delete

$v = explode(' ', $v);

[139] Fix | Delete

if (empty($v[0]) || empty($v[1])) {

[140] Fix | Delete

continue;

[141] Fix | Delete

}

[142] Fix | Delete

// self::debug("Initializing cacheable status for wp_ajax_nopriv_" . $v[0]);

[143] Fix | Delete

add_action(

[144] Fix | Delete

'wp_ajax_nopriv_' . $v[0],

[145] Fix | Delete

function () use ($v) {

[146] Fix | Delete

self::set_custom_ttl($v[1]);

[147] Fix | Delete

self::force_cacheable('ajax Cache setting for action ' . $v[0]);

[148] Fix | Delete

},

[149] Fix | Delete

4

[150] Fix | Delete

);

[151] Fix | Delete

}

[152] Fix | Delete

[153] Fix | Delete

// Check error page

[154] Fix | Delete

add_filter('status_header', array($this, 'check_error_codes'), 10, 2);

[155] Fix | Delete

}

[156] Fix | Delete

[157] Fix | Delete

/**

[158] Fix | Delete

* Check if the page returns any error code.

[159] Fix | Delete

*

[160] Fix | Delete

* @since 1.0.13.1

[161] Fix | Delete

* @access public

[162] Fix | Delete

* @param $status_header

[163] Fix | Delete

* @param $code

[164] Fix | Delete

* @return $error_status

[165] Fix | Delete

*/

[166] Fix | Delete

public function check_error_codes($status_header, $code)

[167] Fix | Delete

{

[168] Fix | Delete

if (array_key_exists($code, $this->_response_header_ttls)) {

[169] Fix | Delete

if (self::is_cacheable() && !$this->_response_header_ttls[$code]) {

[170] Fix | Delete

self::set_nocache('[Ctrl] TTL is set to no cache [status_header] ' . $code);

[171] Fix | Delete

}

[172] Fix | Delete

[173] Fix | Delete

// Set TTL

[174] Fix | Delete

self::set_custom_ttl($this->_response_header_ttls[$code]);

[175] Fix | Delete

} elseif (self::is_cacheable()) {

[176] Fix | Delete

if (substr($code, 0, 1) == 4 || substr($code, 0, 1) == 5) {

[177] Fix | Delete

self::set_nocache('[Ctrl] 4xx/5xx default to no cache [status_header] ' . $code);

[178] Fix | Delete

}

[179] Fix | Delete

}

[180] Fix | Delete

[181] Fix | Delete

// Set cache tag

[182] Fix | Delete

Tag::add(Tag::TYPE_HTTP . $code);

[183] Fix | Delete

[184] Fix | Delete

// Give the default status_header back

[185] Fix | Delete

return $status_header;

[186] Fix | Delete

}

[187] Fix | Delete

[188] Fix | Delete

/**

[189] Fix | Delete

* Set no vary setting

[190] Fix | Delete

*

[191] Fix | Delete

* @access public

[192] Fix | Delete

* @since 1.1.3

[193] Fix | Delete

*/

[194] Fix | Delete

public static function set_no_vary()

[195] Fix | Delete

{

[196] Fix | Delete

if (self::is_no_vary()) {

[197] Fix | Delete

return;

[198] Fix | Delete

}

[199] Fix | Delete

self::$_control |= self::BM_NO_VARY;

[200] Fix | Delete

Debug2::debug('[Ctrl] X Cache_control -> no-vary', 3);

[201] Fix | Delete

}

[202] Fix | Delete

[203] Fix | Delete

/**

[204] Fix | Delete

* Get no vary setting

[205] Fix | Delete

*

[206] Fix | Delete

* @access public

[207] Fix | Delete

* @since 1.1.3

[208] Fix | Delete

*/

[209] Fix | Delete

public static function is_no_vary()

[210] Fix | Delete

{

[211] Fix | Delete

return self::$_control & self::BM_NO_VARY;

[212] Fix | Delete

}

[213] Fix | Delete

[214] Fix | Delete

/**

[215] Fix | Delete

* Set stale

[216] Fix | Delete

*

[217] Fix | Delete

* @access public

[218] Fix | Delete

* @since 1.1.3

[219] Fix | Delete

*/

[220] Fix | Delete

public function set_stale()

[221] Fix | Delete

{

[222] Fix | Delete

if (self::is_stale()) {

[223] Fix | Delete

return;

[224] Fix | Delete

}

[225] Fix | Delete

self::$_control |= self::BM_STALE;

[226] Fix | Delete

Debug2::debug('[Ctrl] X Cache_control -> stale');

[227] Fix | Delete

}

[228] Fix | Delete

[229] Fix | Delete

/**

[230] Fix | Delete

* Get stale

[231] Fix | Delete

*

[232] Fix | Delete

* @access public

[233] Fix | Delete

* @since 1.1.3

[234] Fix | Delete

*/

[235] Fix | Delete

public static function is_stale()

[236] Fix | Delete

{

[237] Fix | Delete

return self::$_control & self::BM_STALE;

[238] Fix | Delete

}

[239] Fix | Delete

[240] Fix | Delete

/**

[241] Fix | Delete

* Set cache control to shared private

[242] Fix | Delete

*

[243] Fix | Delete

* @access public

[244] Fix | Delete

* @since 1.1.3

[245] Fix | Delete

* @param string $reason The reason to no cache

[246] Fix | Delete

*/

[247] Fix | Delete

public static function set_shared($reason = false)

[248] Fix | Delete

{

[249] Fix | Delete

if (self::is_shared()) {

[250] Fix | Delete

return;

[251] Fix | Delete

}

[252] Fix | Delete

self::$_control |= self::BM_SHARED;

[253] Fix | Delete

self::set_private();

[254] Fix | Delete

[255] Fix | Delete

if (!is_string($reason)) {

[256] Fix | Delete

$reason = false;

[257] Fix | Delete

}

[258] Fix | Delete

[259] Fix | Delete

if ($reason) {

[260] Fix | Delete

$reason = "( $reason )";

[261] Fix | Delete

}

[262] Fix | Delete

Debug2::debug('[Ctrl] X Cache_control -> shared ' . $reason);

[263] Fix | Delete

}

[264] Fix | Delete

[265] Fix | Delete

/**

[266] Fix | Delete

* Check if is shared private

[267] Fix | Delete

*

[268] Fix | Delete

* @access public

[269] Fix | Delete

* @since 1.1.3

[270] Fix | Delete

*/

[271] Fix | Delete

public static function is_shared()

[272] Fix | Delete

{

[273] Fix | Delete

return self::$_control & self::BM_SHARED && self::is_private();

[274] Fix | Delete

}

[275] Fix | Delete

[276] Fix | Delete

/**

[277] Fix | Delete

* Set cache control to forced public

[278] Fix | Delete

*

[279] Fix | Delete

* @access public

[280] Fix | Delete

* @since 1.7.1

[281] Fix | Delete

*/

[282] Fix | Delete

public static function set_public_forced($reason = false)

[283] Fix | Delete

{

[284] Fix | Delete

if (self::is_public_forced()) {

[285] Fix | Delete

return;

[286] Fix | Delete

}

[287] Fix | Delete

self::$_control |= self::BM_PUBLIC_FORCED;

[288] Fix | Delete

[289] Fix | Delete

if (!is_string($reason)) {

[290] Fix | Delete

$reason = false;

[291] Fix | Delete

}

[292] Fix | Delete

[293] Fix | Delete

if ($reason) {

[294] Fix | Delete

$reason = "( $reason )";

[295] Fix | Delete

}

[296] Fix | Delete

Debug2::debug('[Ctrl] X Cache_control -> public forced ' . $reason);

[297] Fix | Delete

}

[298] Fix | Delete

[299] Fix | Delete

/**

[300] Fix | Delete

* Check if is public forced

[301] Fix | Delete

*

[302] Fix | Delete

* @access public

[303] Fix | Delete

* @since 1.7.1

[304] Fix | Delete

*/

[305] Fix | Delete

public static function is_public_forced()

[306] Fix | Delete

{

[307] Fix | Delete

return self::$_control & self::BM_PUBLIC_FORCED;

[308] Fix | Delete

}

[309] Fix | Delete

[310] Fix | Delete

/**

[311] Fix | Delete

* Set cache control to private

[312] Fix | Delete

*

[313] Fix | Delete

* @access public

[314] Fix | Delete

* @since 1.1.3

[315] Fix | Delete

* @param string $reason The reason to no cache

[316] Fix | Delete

*/

[317] Fix | Delete

public static function set_private($reason = false)

[318] Fix | Delete

{

[319] Fix | Delete

if (self::is_private()) {

[320] Fix | Delete

return;

[321] Fix | Delete

}

[322] Fix | Delete

self::$_control |= self::BM_PRIVATE;

[323] Fix | Delete

[324] Fix | Delete

if (!is_string($reason)) {

[325] Fix | Delete

$reason = false;

[326] Fix | Delete

}

[327] Fix | Delete

[328] Fix | Delete

if ($reason) {

[329] Fix | Delete

$reason = "( $reason )";

[330] Fix | Delete

}

[331] Fix | Delete

Debug2::debug('[Ctrl] X Cache_control -> private ' . $reason);

[332] Fix | Delete

}

[333] Fix | Delete

[334] Fix | Delete

/**

[335] Fix | Delete

* Check if is private

[336] Fix | Delete

*

[337] Fix | Delete

* @access public

[338] Fix | Delete

* @since 1.1.3

[339] Fix | Delete

*/

[340] Fix | Delete

public static function is_private()

[341] Fix | Delete

{

[342] Fix | Delete

if (defined('LITESPEED_GUEST') && LITESPEED_GUEST) {

[343] Fix | Delete

// return false;

[344] Fix | Delete

}

[345] Fix | Delete

[346] Fix | Delete

return self::$_control & self::BM_PRIVATE && !self::is_public_forced();

[347] Fix | Delete

}

[348] Fix | Delete

[349] Fix | Delete

/**

[350] Fix | Delete

* Initialize cacheable status in `wp` hook, if not call this, by default it will be non-cacheable

[351] Fix | Delete

*

[352] Fix | Delete

* @access public

[353] Fix | Delete

* @since 1.1.3

[354] Fix | Delete

*/

[355] Fix | Delete

public function set_cacheable($reason = false)

[356] Fix | Delete

{

[357] Fix | Delete

self::$_control |= self::BM_CACHEABLE;

[358] Fix | Delete

[359] Fix | Delete

if (!is_string($reason)) {

[360] Fix | Delete

$reason = false;

[361] Fix | Delete

}

[362] Fix | Delete

[363] Fix | Delete

if ($reason) {

[364] Fix | Delete

$reason = ' [reason] ' . $reason;

[365] Fix | Delete

}

[366] Fix | Delete

Debug2::debug('[Ctrl] X Cache_control init on' . $reason);

[367] Fix | Delete

}

[368] Fix | Delete

[369] Fix | Delete

/**

[370] Fix | Delete

* This will disable non-cacheable BM

[371] Fix | Delete

*

[372] Fix | Delete

* @access public

[373] Fix | Delete

* @since 2.2

[374] Fix | Delete

*/

[375] Fix | Delete

public static function force_cacheable($reason = false)

[376] Fix | Delete

{

[377] Fix | Delete

self::$_control |= self::BM_FORCED_CACHEABLE;

[378] Fix | Delete

[379] Fix | Delete

if (!is_string($reason)) {

[380] Fix | Delete

$reason = false;

[381] Fix | Delete

}

[382] Fix | Delete

[383] Fix | Delete

if ($reason) {

[384] Fix | Delete

$reason = ' [reason] ' . $reason;

[385] Fix | Delete

}

[386] Fix | Delete

Debug2::debug('[Ctrl] Forced cacheable' . $reason);

[387] Fix | Delete

}

[388] Fix | Delete

[389] Fix | Delete

/**

[390] Fix | Delete

* Switch to nocacheable status

[391] Fix | Delete

*

[392] Fix | Delete

* @access public

[393] Fix | Delete

* @since 1.1.3

[394] Fix | Delete

* @param string $reason The reason to no cache

[395] Fix | Delete

*/

[396] Fix | Delete

public static function set_nocache($reason = false)

[397] Fix | Delete

{

[398] Fix | Delete

self::$_control |= self::BM_NOTCACHEABLE;

[399] Fix | Delete

[400] Fix | Delete

if (!is_string($reason)) {

[401] Fix | Delete

$reason = false;

[402] Fix | Delete

}

[403] Fix | Delete

[404] Fix | Delete

if ($reason) {

[405] Fix | Delete

$reason = "( $reason )";

[406] Fix | Delete

}

[407] Fix | Delete

Debug2::debug('[Ctrl] X Cache_control -> no Cache ' . $reason, 5);

[408] Fix | Delete

}

[409] Fix | Delete

[410] Fix | Delete

/**

[411] Fix | Delete

* Check current notcacheable bit set

[412] Fix | Delete

*

[413] Fix | Delete

* @access public

[414] Fix | Delete

* @since 1.1.3

[415] Fix | Delete

* @return bool True if notcacheable bit is set, otherwise false.

[416] Fix | Delete

*/

[417] Fix | Delete

public static function isset_notcacheable()

[418] Fix | Delete

{

[419] Fix | Delete

return self::$_control & self::BM_NOTCACHEABLE;

[420] Fix | Delete

}

[421] Fix | Delete

[422] Fix | Delete

/**

[423] Fix | Delete

* Check current force cacheable bit set

[424] Fix | Delete

*

[425] Fix | Delete

* @access public

[426] Fix | Delete

* @since 2.2

[427] Fix | Delete

*/

[428] Fix | Delete

public static function is_forced_cacheable()

[429] Fix | Delete

{

[430] Fix | Delete

return self::$_control & self::BM_FORCED_CACHEABLE;

[431] Fix | Delete

}

[432] Fix | Delete

[433] Fix | Delete

/**

[434] Fix | Delete

* Check current cacheable status

[435] Fix | Delete

*

[436] Fix | Delete

* @access public

[437] Fix | Delete

* @since 1.1.3

[438] Fix | Delete

* @return bool True if is still cacheable, otherwise false.

[439] Fix | Delete

*/

[440] Fix | Delete

public static function is_cacheable()

[441] Fix | Delete

{

[442] Fix | Delete

if (defined('LSCACHE_NO_CACHE') && LSCACHE_NO_CACHE) {

[443] Fix | Delete

Debug2::debug('[Ctrl] LSCACHE_NO_CACHE constant defined');

[444] Fix | Delete

return false;

[445] Fix | Delete

}

[446] Fix | Delete

[447] Fix | Delete

// Guest mode always cacheable

[448] Fix | Delete

if (defined('LITESPEED_GUEST') && LITESPEED_GUEST) {

[449] Fix | Delete

// return true;

[450] Fix | Delete

}

[451] Fix | Delete

[452] Fix | Delete

// If its forced public cacheable

[453] Fix | Delete

if (self::is_public_forced()) {

[454] Fix | Delete

return true;

[455] Fix | Delete

}

[456] Fix | Delete

[457] Fix | Delete

// If its forced cacheable

[458] Fix | Delete

if (self::is_forced_cacheable()) {

[459] Fix | Delete

return true;

[460] Fix | Delete

}

[461] Fix | Delete

[462] Fix | Delete

return !self::isset_notcacheable() && self::$_control & self::BM_CACHEABLE;

[463] Fix | Delete

}

[464] Fix | Delete

[465] Fix | Delete

/**

[466] Fix | Delete

* Set a custom TTL to use with the request if needed.

[467] Fix | Delete

*

[468] Fix | Delete

* @access public

[469] Fix | Delete

* @since 1.1.3

[470] Fix | Delete

* @param mixed $ttl An integer or string to use as the TTL. Must be numeric.

[471] Fix | Delete

*/

[472] Fix | Delete

public static function set_custom_ttl($ttl, $reason = false)

[473] Fix | Delete

{

[474] Fix | Delete

if (is_numeric($ttl)) {

[475] Fix | Delete

self::$_custom_ttl = $ttl;

[476] Fix | Delete

Debug2::debug('[Ctrl] X Cache_control TTL -> ' . $ttl . ($reason ? ' [reason] ' . $ttl : ''));

[477] Fix | Delete

}

[478] Fix | Delete

}

[479] Fix | Delete

[480] Fix | Delete

/**

[481] Fix | Delete

* Generate final TTL.

[482] Fix | Delete

*

[483] Fix | Delete

* @access public

[484] Fix | Delete

* @since 1.1.3

[485] Fix | Delete

*/

[486] Fix | Delete

public function get_ttl()

[487] Fix | Delete

{

[488] Fix | Delete

if (self::$_custom_ttl != 0) {

[489] Fix | Delete

return self::$_custom_ttl;

[490] Fix | Delete

}

[491] Fix | Delete

[492] Fix | Delete

// Check if is in timed url list or not

[493] Fix | Delete

$timed_urls = Utility::wildcard2regex($this->conf(Base::O_PURGE_TIMED_URLS));

[494] Fix | Delete

$timed_urls_time = $this->conf(Base::O_PURGE_TIMED_URLS_TIME);

[495] Fix | Delete

if ($timed_urls && $timed_urls_time) {

[496] Fix | Delete

$current_url = Tag::build_uri_tag(true);

[497] Fix | Delete

// Use time limit ttl

[498] Fix | Delete

$scheduled_time = strtotime($timed_urls_time);

[499] Fix | Delete