<?php

[0] Fix | Delete

[1] Fix | Delete

namespace WPForms\Helpers;

[2] Fix | Delete

[3] Fix | Delete

/**

[4] Fix | Delete

* WPForms Transients implementation.

[5] Fix | Delete

*

[6] Fix | Delete

* @since 1.6.3.1

[7] Fix | Delete

*/

[8] Fix | Delete

class Transient {

[9] Fix | Delete

[10] Fix | Delete

/**

[11] Fix | Delete

* Transient option name prefix.

[12] Fix | Delete

*

[13] Fix | Delete

* @since 1.6.3.1

[14] Fix | Delete

*

[15] Fix | Delete

* @var string

[16] Fix | Delete

*/

[17] Fix | Delete

const OPTION_PREFIX = '_wpforms_transient_';

[18] Fix | Delete

[19] Fix | Delete

/**

[20] Fix | Delete

* Transient timeout option name prefix.

[21] Fix | Delete

*

[22] Fix | Delete

* @since 1.6.3.1

[23] Fix | Delete

*

[24] Fix | Delete

* @var string

[25] Fix | Delete

*/

[26] Fix | Delete

const TIMEOUT_PREFIX = '_wpforms_transient_timeout_';

[27] Fix | Delete

[28] Fix | Delete

/**

[29] Fix | Delete

* Get the value of a transient.

[30] Fix | Delete

*

[31] Fix | Delete

* If the transient does not exist, does not have a value, or has expired,

[32] Fix | Delete

* then the return value will be false.

[33] Fix | Delete

*

[34] Fix | Delete

* @since 1.6.3.1

[35] Fix | Delete

*

[36] Fix | Delete

* @param string $transient Transient name. Expected to not be SQL-escaped.

[37] Fix | Delete

*

[38] Fix | Delete

* @return mixed Value of transient.

[39] Fix | Delete

*/

[40] Fix | Delete

public static function get( $transient ) {

[41] Fix | Delete

[42] Fix | Delete

$transient_option = self::OPTION_PREFIX . $transient;

[43] Fix | Delete

$transient_timeout = self::TIMEOUT_PREFIX . $transient;

[44] Fix | Delete

[45] Fix | Delete

$alloptions = wp_load_alloptions();

[46] Fix | Delete

[47] Fix | Delete

// If option is not in alloptions, it is not autoloaded and thus has a timeout to check.

[48] Fix | Delete

if ( ! isset( $alloptions[ $transient_option ] ) ) {

[49] Fix | Delete

$is_expired = self::is_expired( $transient );

[50] Fix | Delete

}

[51] Fix | Delete

[52] Fix | Delete

// Return the data if it's not expired.

[53] Fix | Delete

if ( empty( $is_expired ) ) {

[54] Fix | Delete

return self::get_option( $transient );

[55] Fix | Delete

}

[56] Fix | Delete

[57] Fix | Delete

delete_option( $transient_option );

[58] Fix | Delete

delete_option( $transient_timeout );

[59] Fix | Delete

[60] Fix | Delete

return false;

[61] Fix | Delete

}

[62] Fix | Delete

[63] Fix | Delete

/**

[64] Fix | Delete

* Set/update the value of a transient.

[65] Fix | Delete

*

[66] Fix | Delete

* You do not need to serialize values. If the value needs to be serialized, then

[67] Fix | Delete

* it will be serialized before it is set.

[68] Fix | Delete

*

[69] Fix | Delete

* @since 1.6.3.1

[70] Fix | Delete

*

[71] Fix | Delete

* @param string $transient Transient name. Expected to not be SQL-escaped. Must be

[72] Fix | Delete

* 164 characters or fewer.

[73] Fix | Delete

* @param mixed $value Transient value. Must be serializable if non-scalar.

[74] Fix | Delete

* Expected to not be SQL-escaped.

[75] Fix | Delete

* @param int $expiration Optional. Time until expiration in seconds. Default 0 (no expiration).

[76] Fix | Delete

*

[77] Fix | Delete

* @return bool False if value was not set and true if value was set.

[78] Fix | Delete

*/

[79] Fix | Delete

public static function set( $transient, $value, $expiration = 0 ) {

[80] Fix | Delete

[81] Fix | Delete

if ( false === self::get_option( $transient ) ) {

[82] Fix | Delete

return self::add( $transient, $value, $expiration );

[83] Fix | Delete

}

[84] Fix | Delete

[85] Fix | Delete

return self::update( $transient, $value, $expiration );

[86] Fix | Delete

}

[87] Fix | Delete

[88] Fix | Delete

/**

[89] Fix | Delete

* Create a new transient with a given value.

[90] Fix | Delete

*

[91] Fix | Delete

* Internal method, use Transient::set() instead.

[92] Fix | Delete

*

[93] Fix | Delete

* @since 1.6.3.1

[94] Fix | Delete

*

[95] Fix | Delete

* @param string $transient Transient name. Expected to not be SQL-escaped. Must be

[96] Fix | Delete

* 164 characters or fewer.

[97] Fix | Delete

* @param mixed $value Transient value. Must be serializable if non-scalar.

[98] Fix | Delete

* Expected to not be SQL-escaped.

[99] Fix | Delete

* @param int $expiration Optional. Time until expiration in seconds. Default 0 (no expiration).

[100] Fix | Delete

*

[101] Fix | Delete

* @return bool False if value was not set and true if value was set.

[102] Fix | Delete

*/

[103] Fix | Delete

private static function add( $transient, $value, $expiration ) {

[104] Fix | Delete

[105] Fix | Delete

if ( $expiration ) {

[106] Fix | Delete

add_option( self::TIMEOUT_PREFIX . $transient, time() + $expiration, '', 'no' );

[107] Fix | Delete

}

[108] Fix | Delete

[109] Fix | Delete

// If there's an expiration, the option won't be autoloaded.

[110] Fix | Delete

return add_option( self::OPTION_PREFIX . $transient, $value, '', $expiration ? 'no' : 'yes' );

[111] Fix | Delete

}

[112] Fix | Delete

[113] Fix | Delete

/**

[114] Fix | Delete

* Update the value of a transient.

[115] Fix | Delete

*

[116] Fix | Delete

* Internal method, use Transient::set() instead.

[117] Fix | Delete

*

[118] Fix | Delete

* @since 1.6.3.1

[119] Fix | Delete

*

[120] Fix | Delete

* @param string $transient Transient name. Expected to not be SQL-escaped. Must be

[121] Fix | Delete

* 164 characters or fewer.

[122] Fix | Delete

* @param mixed $value Transient value. Must be serializable if non-scalar.

[123] Fix | Delete

* Expected to not be SQL-escaped.

[124] Fix | Delete

* @param int $expiration Optional. Time until expiration in seconds. Default 0 (no expiration).

[125] Fix | Delete

*

[126] Fix | Delete

* @return bool False if value was not set and true if value was set.

[127] Fix | Delete

*/

[128] Fix | Delete

private static function update( $transient, $value, $expiration ) {

[129] Fix | Delete

[130] Fix | Delete

$transient_option = self::OPTION_PREFIX . $transient;

[131] Fix | Delete

$transient_timeout = self::TIMEOUT_PREFIX . $transient;

[132] Fix | Delete

[133] Fix | Delete

if ( ! $expiration ) {

[134] Fix | Delete

return update_option( $transient_option, $value );

[135] Fix | Delete

}

[136] Fix | Delete

[137] Fix | Delete

$timeout = self::get_timeout( $transient );

[138] Fix | Delete

[139] Fix | Delete

if ( $timeout !== false ) {

[140] Fix | Delete

update_option( $transient_timeout, time() + $expiration );

[141] Fix | Delete

[142] Fix | Delete

return update_option( $transient_option, $value );

[143] Fix | Delete

}

[144] Fix | Delete

[145] Fix | Delete

// If expiration is requested, but the transient has no timeout option,

[146] Fix | Delete

// delete, then re-create transient rather than update.

[147] Fix | Delete

delete_option( $transient_option );

[148] Fix | Delete

add_option( $transient_timeout, time() + $expiration, '', 'no' );

[149] Fix | Delete

[150] Fix | Delete

return add_option( $transient_option, $value, '', 'no' );

[151] Fix | Delete

}

[152] Fix | Delete

[153] Fix | Delete

/**

[154] Fix | Delete

* Delete a transient.

[155] Fix | Delete

*

[156] Fix | Delete

* @since 1.6.3.1

[157] Fix | Delete

*

[158] Fix | Delete

* @param string $transient Transient name. Expected to not be SQL-escaped.

[159] Fix | Delete

*

[160] Fix | Delete

* @return bool true if successful, false otherwise

[161] Fix | Delete

*/

[162] Fix | Delete

public static function delete( $transient ) {

[163] Fix | Delete

[164] Fix | Delete

$result = delete_option( self::OPTION_PREFIX . $transient );

[165] Fix | Delete

[166] Fix | Delete

if ( $result ) {

[167] Fix | Delete

delete_option( self::TIMEOUT_PREFIX . $transient );

[168] Fix | Delete

}

[169] Fix | Delete

[170] Fix | Delete

return $result;

[171] Fix | Delete

}

[172] Fix | Delete

[173] Fix | Delete

/**

[174] Fix | Delete

* Delete all WPForms transients.

[175] Fix | Delete

*

[176] Fix | Delete

* @since 1.6.3.1

[177] Fix | Delete

*

[178] Fix | Delete

* @return int|false Number of rows affected/selected or false on error

[179] Fix | Delete

*/

[180] Fix | Delete

public static function delete_all() {

[181] Fix | Delete

[182] Fix | Delete

global $wpdb;

[183] Fix | Delete

[184] Fix | Delete

// phpcs:ignore WordPress.DB.DirectDatabaseQuery.DirectQuery, WordPress.DB.DirectDatabaseQuery.NoCaching

[185] Fix | Delete

return $wpdb->query(

[186] Fix | Delete

$wpdb->prepare(

[187] Fix | Delete

"DELETE FROM $wpdb->options

[188] Fix | Delete

WHERE option_name LIKE %s",

[189] Fix | Delete

$wpdb->esc_like( self::OPTION_PREFIX ) . '%'

[190] Fix | Delete

)

[191] Fix | Delete

);

[192] Fix | Delete

}

[193] Fix | Delete

[194] Fix | Delete

/**

[195] Fix | Delete

* Delete all expired WPForms transients.

[196] Fix | Delete

*

[197] Fix | Delete

* The multi-table delete syntax is used to delete the transient record

[198] Fix | Delete

* from table 'a', and the corresponding transient_timeout record from table 'b'.

[199] Fix | Delete

*

[200] Fix | Delete

* @since 1.6.3.1

[201] Fix | Delete

*

[202] Fix | Delete

* @return int|false Number of rows affected/selected or false on error

[203] Fix | Delete

*/

[204] Fix | Delete

public static function delete_all_expired() {

[205] Fix | Delete

[206] Fix | Delete

global $wpdb;

[207] Fix | Delete

[208] Fix | Delete

// phpcs:ignore WordPress.DB.DirectDatabaseQuery.DirectQuery, WordPress.DB.DirectDatabaseQuery.NoCaching

[209] Fix | Delete

return $wpdb->query(

[210] Fix | Delete

$wpdb->prepare(

[211] Fix | Delete

"DELETE a, b FROM $wpdb->options a, $wpdb->options b

[212] Fix | Delete

WHERE a.option_name LIKE %s

[213] Fix | Delete

AND a.option_name NOT LIKE %s

[214] Fix | Delete

AND b.option_name = CONCAT( %s, SUBSTRING( a.option_name, %d ) )

[215] Fix | Delete

AND b.option_value < %d",

[216] Fix | Delete

$wpdb->esc_like( self::OPTION_PREFIX ) . '%',

[217] Fix | Delete

$wpdb->esc_like( self::TIMEOUT_PREFIX ) . '%',

[218] Fix | Delete

self::TIMEOUT_PREFIX,

[219] Fix | Delete

strlen( self::OPTION_PREFIX ) + 1,

[220] Fix | Delete

time()

[221] Fix | Delete

)

[222] Fix | Delete

);

[223] Fix | Delete

}

[224] Fix | Delete

[225] Fix | Delete

/**

[226] Fix | Delete

* Check if transient is expired.

[227] Fix | Delete

*

[228] Fix | Delete

* @since 1.6.3.1

[229] Fix | Delete

*

[230] Fix | Delete

* @param string $transient Transient name. Expected to not be SQL-escaped.

[231] Fix | Delete

*

[232] Fix | Delete

* @return bool true if expired, false otherwise

[233] Fix | Delete

*/

[234] Fix | Delete

public static function is_expired( $transient ) {

[235] Fix | Delete

[236] Fix | Delete

$timeout = self::get_timeout( $transient );

[237] Fix | Delete

[238] Fix | Delete

// If there's no timeout data found, the transient is considered to be valid.

[239] Fix | Delete

if ( $timeout === false ) {

[240] Fix | Delete

return false;

[241] Fix | Delete

}

[242] Fix | Delete

[243] Fix | Delete

if ( $timeout >= time() ) {

[244] Fix | Delete

return false;

[245] Fix | Delete

}

[246] Fix | Delete

[247] Fix | Delete

return true;

[248] Fix | Delete

}

[249] Fix | Delete

[250] Fix | Delete

/**

[251] Fix | Delete

* Get a transient option value.

[252] Fix | Delete

*

[253] Fix | Delete

* @since 1.6.3.1

[254] Fix | Delete

*

[255] Fix | Delete

* @param string $transient Transient name. Expected to not be SQL-escaped.

[256] Fix | Delete

*

[257] Fix | Delete

* @return mixed Value set for the option.

[258] Fix | Delete

*/

[259] Fix | Delete

private static function get_option( $transient ) {

[260] Fix | Delete

[261] Fix | Delete

return get_option( self::OPTION_PREFIX . $transient );

[262] Fix | Delete

}

[263] Fix | Delete

[264] Fix | Delete

/**

[265] Fix | Delete

* Get a transient timeout option value.

[266] Fix | Delete

*

[267] Fix | Delete

* @since 1.6.3.1

[268] Fix | Delete

*

[269] Fix | Delete

* @param string $transient Transient name. Expected to not be SQL-escaped.

[270] Fix | Delete

*

[271] Fix | Delete

* @return mixed Value set for the option.

[272] Fix | Delete

*/

[273] Fix | Delete

private static function get_timeout( $transient ) {

[274] Fix | Delete

[275] Fix | Delete

return get_option( self::TIMEOUT_PREFIX . $transient );

[276] Fix | Delete

}

[277] Fix | Delete

}

[278] Fix | Delete

[279] Fix | Delete