Edit File by line

<?php

[0] Fix | Delete

/**

[1] Fix | Delete

* @package Freemius

[2] Fix | Delete

[3] Fix | Delete

* @license https://www.gnu.org/licenses/gpl-3.0.html GNU General Public License Version 3

[4] Fix | Delete

* @since 1.1.6

[5] Fix | Delete

[6] Fix | Delete

[7] Fix | Delete

if ( ! defined( 'ABSPATH' ) ) {

[8] Fix | Delete

exit;

[9] Fix | Delete

}

[10] Fix | Delete

[11] Fix | Delete

class FS_Cache_Manager {

[12] Fix | Delete

/**

[13] Fix | Delete

* @var FS_Option_Manager

[14] Fix | Delete

[15] Fix | Delete

private $_options;

[16] Fix | Delete

/**

[17] Fix | Delete

* @var FS_Logger

[18] Fix | Delete

[19] Fix | Delete

private $_logger;

[20] Fix | Delete

[21] Fix | Delete

/**

[22] Fix | Delete

* @var FS_Cache_Manager[]

[23] Fix | Delete

[24] Fix | Delete

private static $_MANAGERS = array();

[25] Fix | Delete

[26] Fix | Delete

/**

[27] Fix | Delete

* @author Vova Feldman (@svovaf)

[28] Fix | Delete

* @since 1.1.3

[29] Fix | Delete

[30] Fix | Delete

* @param string $id

[31] Fix | Delete

[32] Fix | Delete

private function __construct( $id ) {

[33] Fix | Delete

$this->_logger = FS_Logger::get_logger( WP_FS__SLUG . '_cach_mngr_' . $id, WP_FS__DEBUG_SDK, WP_FS__ECHO_DEBUG_SDK );

[34] Fix | Delete

[35] Fix | Delete

$this->_logger->entrance();

[36] Fix | Delete

$this->_logger->log( 'id = ' . $id );

[37] Fix | Delete

[38] Fix | Delete

$this->_options = FS_Option_Manager::get_manager( $id, true, true, false );

[39] Fix | Delete

}

[40] Fix | Delete

[41] Fix | Delete

/**

[42] Fix | Delete

* @author Vova Feldman (@svovaf)

[43] Fix | Delete

* @since 1.1.6

[44] Fix | Delete

[45] Fix | Delete

* @param $id

[46] Fix | Delete

[47] Fix | Delete

* @return FS_Cache_Manager

[48] Fix | Delete

[49] Fix | Delete

static function get_manager( $id ) {

[50] Fix | Delete

$id = strtolower( $id );

[51] Fix | Delete

[52] Fix | Delete

if ( ! isset( self::$_MANAGERS[ $id ] ) ) {

[53] Fix | Delete

self::$_MANAGERS[ $id ] = new FS_Cache_Manager( $id );

[54] Fix | Delete

}

[55] Fix | Delete

[56] Fix | Delete

return self::$_MANAGERS[ $id ];

[57] Fix | Delete

}

[58] Fix | Delete

[59] Fix | Delete

/**

[60] Fix | Delete

* @author Vova Feldman (@svovaf)

[61] Fix | Delete

* @since 1.1.6

[62] Fix | Delete

[63] Fix | Delete

* @return bool

[64] Fix | Delete

[65] Fix | Delete

function is_empty() {

[66] Fix | Delete

$this->_logger->entrance();

[67] Fix | Delete

[68] Fix | Delete

return $this->_options->is_empty();

[69] Fix | Delete

}

[70] Fix | Delete

[71] Fix | Delete

/**

[72] Fix | Delete

* @author Vova Feldman (@svovaf)

[73] Fix | Delete

* @since 1.1.6

[74] Fix | Delete

[75] Fix | Delete

function clear() {

[76] Fix | Delete

$this->_logger->entrance();

[77] Fix | Delete

[78] Fix | Delete

$this->_options->clear( true );

[79] Fix | Delete

}

[80] Fix | Delete

[81] Fix | Delete

/**

[82] Fix | Delete

* Delete cache manager from DB.

[83] Fix | Delete

[84] Fix | Delete

* @author Vova Feldman (@svovaf)

[85] Fix | Delete

* @since 1.0.9

[86] Fix | Delete

[87] Fix | Delete

function delete() {

[88] Fix | Delete

$this->_options->delete();

[89] Fix | Delete

}

[90] Fix | Delete

[91] Fix | Delete

/**

[92] Fix | Delete

* Check if there's a cached item.

[93] Fix | Delete

[94] Fix | Delete

* @author Vova Feldman (@svovaf)

[95] Fix | Delete

* @since 1.1.6

[96] Fix | Delete

[97] Fix | Delete

* @param string $key

[98] Fix | Delete

[99] Fix | Delete

* @return bool

[100] Fix | Delete

[101] Fix | Delete

function has( $key ) {

[102] Fix | Delete

$cache_entry = $this->_options->get_option( $key, false );

[103] Fix | Delete

[104] Fix | Delete

return ( is_object( $cache_entry ) &&

[105] Fix | Delete

isset( $cache_entry->timestamp ) &&

[106] Fix | Delete

is_numeric( $cache_entry->timestamp )

[107] Fix | Delete

);

[108] Fix | Delete

}

[109] Fix | Delete

[110] Fix | Delete

/**

[111] Fix | Delete

* Check if there's a valid cached item.

[112] Fix | Delete

[113] Fix | Delete

* @author Vova Feldman (@svovaf)

[114] Fix | Delete

* @since 1.1.6

[115] Fix | Delete

[116] Fix | Delete

* @param string $key

[117] Fix | Delete

* @param null|int $expiration Since 1.2.2.7

[118] Fix | Delete

[119] Fix | Delete

* @return bool

[120] Fix | Delete

[121] Fix | Delete

function has_valid( $key, $expiration = null ) {

[122] Fix | Delete

$cache_entry = $this->_options->get_option( $key, false );

[123] Fix | Delete

[124] Fix | Delete

$is_valid = ( is_object( $cache_entry ) &&

[125] Fix | Delete

isset( $cache_entry->timestamp ) &&

[126] Fix | Delete

is_numeric( $cache_entry->timestamp ) &&

[127] Fix | Delete

$cache_entry->timestamp > WP_FS__SCRIPT_START_TIME

[128] Fix | Delete

);

[129] Fix | Delete

[130] Fix | Delete

if ( $is_valid &&

[131] Fix | Delete

is_numeric( $expiration ) &&

[132] Fix | Delete

isset( $cache_entry->created ) &&

[133] Fix | Delete

is_numeric( $cache_entry->created ) &&

[134] Fix | Delete

$cache_entry->created + $expiration < WP_FS__SCRIPT_START_TIME

[135] Fix | Delete

) {

[136] Fix | Delete

/**

[137] Fix | Delete

* Even if the cache is still valid, since we are checking for validity

[138] Fix | Delete

* with an explicit expiration period, if the period has past, return

[139] Fix | Delete

* `false` as if the cache is invalid.

[140] Fix | Delete

[141] Fix | Delete

* @since 1.2.2.7

[142] Fix | Delete

[143] Fix | Delete

$is_valid = false;

[144] Fix | Delete

}

[145] Fix | Delete

[146] Fix | Delete

return $is_valid;

[147] Fix | Delete

}

[148] Fix | Delete

[149] Fix | Delete

/**

[150] Fix | Delete

* @author Vova Feldman (@svovaf)

[151] Fix | Delete

* @since 1.1.6

[152] Fix | Delete

[153] Fix | Delete

* @param string $key

[154] Fix | Delete

* @param mixed $default

[155] Fix | Delete

[156] Fix | Delete

* @return mixed

[157] Fix | Delete

[158] Fix | Delete

function get( $key, $default = null ) {

[159] Fix | Delete

$this->_logger->entrance( 'key = ' . $key );

[160] Fix | Delete

[161] Fix | Delete

$cache_entry = $this->_options->get_option( $key, false );

[162] Fix | Delete

[163] Fix | Delete

if ( is_object( $cache_entry ) &&

[164] Fix | Delete

isset( $cache_entry->timestamp ) &&

[165] Fix | Delete

is_numeric( $cache_entry->timestamp )

[166] Fix | Delete

) {

[167] Fix | Delete

return $cache_entry->result;

[168] Fix | Delete

}

[169] Fix | Delete

[170] Fix | Delete

return is_object( $default ) ? clone $default : $default;

[171] Fix | Delete

}

[172] Fix | Delete

[173] Fix | Delete

/**

[174] Fix | Delete

* @author Vova Feldman (@svovaf)

[175] Fix | Delete

* @since 1.1.6

[176] Fix | Delete

[177] Fix | Delete

* @param string $key

[178] Fix | Delete

* @param mixed $default

[179] Fix | Delete

[180] Fix | Delete

* @return mixed

[181] Fix | Delete

[182] Fix | Delete

function get_valid( $key, $default = null ) {

[183] Fix | Delete

$this->_logger->entrance( 'key = ' . $key );

[184] Fix | Delete

[185] Fix | Delete

$cache_entry = $this->_options->get_option( $key, false );

[186] Fix | Delete

[187] Fix | Delete

if ( is_object( $cache_entry ) &&

[188] Fix | Delete

isset( $cache_entry->timestamp ) &&

[189] Fix | Delete

is_numeric( $cache_entry->timestamp ) &&

[190] Fix | Delete

$cache_entry->timestamp > WP_FS__SCRIPT_START_TIME

[191] Fix | Delete

) {

[192] Fix | Delete

return $cache_entry->result;

[193] Fix | Delete

}

[194] Fix | Delete

[195] Fix | Delete

return is_object( $default ) ? clone $default : $default;

[196] Fix | Delete

}

[197] Fix | Delete

[198] Fix | Delete

/**

[199] Fix | Delete

* @author Vova Feldman (@svovaf)

[200] Fix | Delete

* @since 1.1.6

[201] Fix | Delete

[202] Fix | Delete

* @param string $key

[203] Fix | Delete

* @param mixed $value

[204] Fix | Delete

* @param int $expiration

[205] Fix | Delete

* @param int $created Since 2.0.0 Cache creation date.

[206] Fix | Delete

[207] Fix | Delete

function set( $key, $value, $expiration = WP_FS__TIME_24_HOURS_IN_SEC, $created = WP_FS__SCRIPT_START_TIME ) {

[208] Fix | Delete

$this->_logger->entrance( 'key = ' . $key );

[209] Fix | Delete

[210] Fix | Delete

$cache_entry = new stdClass();

[211] Fix | Delete

[212] Fix | Delete

$cache_entry->result = $value;

[213] Fix | Delete

$cache_entry->created = $created;

[214] Fix | Delete

$cache_entry->timestamp = $created + $expiration;

[215] Fix | Delete

$this->_options->set_option( $key, $cache_entry, true );

[216] Fix | Delete

}

[217] Fix | Delete

[218] Fix | Delete

/**

[219] Fix | Delete

* Get cached record expiration, or false if not cached or expired.

[220] Fix | Delete

[221] Fix | Delete

* @author Vova Feldman (@svovaf)

[222] Fix | Delete

* @since 1.1.7.3

[223] Fix | Delete

[224] Fix | Delete

* @param string $key

[225] Fix | Delete

[226] Fix | Delete

* @return bool|int

[227] Fix | Delete

[228] Fix | Delete

function get_record_expiration( $key ) {

[229] Fix | Delete

$this->_logger->entrance( 'key = ' . $key );

[230] Fix | Delete

[231] Fix | Delete

$cache_entry = $this->_options->get_option( $key, false );

[232] Fix | Delete

[233] Fix | Delete

if ( is_object( $cache_entry ) &&

[234] Fix | Delete

isset( $cache_entry->timestamp ) &&

[235] Fix | Delete

is_numeric( $cache_entry->timestamp ) &&

[236] Fix | Delete

$cache_entry->timestamp > WP_FS__SCRIPT_START_TIME

[237] Fix | Delete

) {

[238] Fix | Delete

return $cache_entry->timestamp;

[239] Fix | Delete

}

[240] Fix | Delete

[241] Fix | Delete

return false;

[242] Fix | Delete

}

[243] Fix | Delete

[244] Fix | Delete

/**

[245] Fix | Delete

* Purge cached item.

[246] Fix | Delete

[247] Fix | Delete

* @author Vova Feldman (@svovaf)

[248] Fix | Delete

* @since 1.1.6

[249] Fix | Delete

[250] Fix | Delete

* @param string $key

[251] Fix | Delete

[252] Fix | Delete

function purge( $key ) {

[253] Fix | Delete

$this->_logger->entrance( 'key = ' . $key );

[254] Fix | Delete

[255] Fix | Delete

$this->_options->unset_option( $key, true );

[256] Fix | Delete

}

[257] Fix | Delete

[258] Fix | Delete

/**

[259] Fix | Delete

* Extend cached item caching period.

[260] Fix | Delete

[261] Fix | Delete

* @author Vova Feldman (@svovaf)

[262] Fix | Delete

* @since 2.0.0

[263] Fix | Delete

[264] Fix | Delete

* @param string $key

[265] Fix | Delete

* @param int $expiration

[266] Fix | Delete

[267] Fix | Delete

* @return bool

[268] Fix | Delete

[269] Fix | Delete

function update_expiration( $key, $expiration = WP_FS__TIME_24_HOURS_IN_SEC ) {

[270] Fix | Delete

$this->_logger->entrance( 'key = ' . $key );

[271] Fix | Delete

[272] Fix | Delete

$cache_entry = $this->_options->get_option( $key, false );

[273] Fix | Delete

[274] Fix | Delete

if ( ! is_object( $cache_entry ) ||

[275] Fix | Delete

! isset( $cache_entry->timestamp ) ||

[276] Fix | Delete

! is_numeric( $cache_entry->timestamp )

[277] Fix | Delete

) {

[278] Fix | Delete

return false;

[279] Fix | Delete

}

[280] Fix | Delete

[281] Fix | Delete

$this->set( $key, $cache_entry->result, $expiration, $cache_entry->created );

[282] Fix | Delete

[283] Fix | Delete

return true;

[284] Fix | Delete

}

[285] Fix | Delete

[286] Fix | Delete

/**

[287] Fix | Delete

* Set cached item as expired.

[288] Fix | Delete

[289] Fix | Delete

* @author Vova Feldman (@svovaf)

[290] Fix | Delete

* @since 1.2.2.7

[291] Fix | Delete

[292] Fix | Delete

* @param string $key

[293] Fix | Delete

[294] Fix | Delete

function expire( $key ) {

[295] Fix | Delete

$this->_logger->entrance( 'key = ' . $key );

[296] Fix | Delete

[297] Fix | Delete

$cache_entry = $this->_options->get_option( $key, false );

[298] Fix | Delete

[299] Fix | Delete

if ( is_object( $cache_entry ) &&

[300] Fix | Delete

isset( $cache_entry->timestamp ) &&

[301] Fix | Delete

is_numeric( $cache_entry->timestamp )

[302] Fix | Delete

) {

[303] Fix | Delete

// Set to expired.

[304] Fix | Delete

$cache_entry->timestamp = WP_FS__SCRIPT_START_TIME;

[305] Fix | Delete

$this->_options->set_option( $key, $cache_entry, true );

[306] Fix | Delete

}

[307] Fix | Delete

}

[308] Fix | Delete

[309] Fix | Delete

#--------------------------------------------------------------------------------

[310] Fix | Delete

#region Migration

[311] Fix | Delete

#--------------------------------------------------------------------------------

[312] Fix | Delete

[313] Fix | Delete

/**

[314] Fix | Delete

* Migrate options from site level.

[315] Fix | Delete

[316] Fix | Delete

* @author Vova Feldman (@svovaf)

[317] Fix | Delete

* @since 2.0.0

[318] Fix | Delete

[319] Fix | Delete

function migrate_to_network() {

[320] Fix | Delete

$this->_options->migrate_to_network();

[321] Fix | Delete

}

[322] Fix | Delete

[323] Fix | Delete

#endregion

[324] Fix | Delete

}

[325] Fix | Delete