Edit File by line

<?php

[0] Fix | Delete

/**

[1] Fix | Delete

* WPSEO plugin file.

[2] Fix | Delete

[3] Fix | Delete

* @package WPSEO\XML_Sitemaps

[4] Fix | Delete

[5] Fix | Delete

[6] Fix | Delete

/**

[7] Fix | Delete

* Handles sitemaps caching and invalidation.

[8] Fix | Delete

[9] Fix | Delete

* @since 3.2

[10] Fix | Delete

[11] Fix | Delete

class WPSEO_Sitemaps_Cache {

[12] Fix | Delete

[13] Fix | Delete

/**

[14] Fix | Delete

* Holds the options that, when updated, should cause the cache to clear.

[15] Fix | Delete

[16] Fix | Delete

* @var array

[17] Fix | Delete

[18] Fix | Delete

protected static $cache_clear = [];

[19] Fix | Delete

[20] Fix | Delete

/**

[21] Fix | Delete

* Mirror of enabled status for static calls.

[22] Fix | Delete

[23] Fix | Delete

* @var bool

[24] Fix | Delete

[25] Fix | Delete

protected static $is_enabled = false;

[26] Fix | Delete

[27] Fix | Delete

/**

[28] Fix | Delete

* Holds the flag to clear all cache.

[29] Fix | Delete

[30] Fix | Delete

* @var bool

[31] Fix | Delete

[32] Fix | Delete

protected static $clear_all = false;

[33] Fix | Delete

[34] Fix | Delete

/**

[35] Fix | Delete

* Holds the array of types to clear.

[36] Fix | Delete

[37] Fix | Delete

* @var array

[38] Fix | Delete

[39] Fix | Delete

protected static $clear_types = [];

[40] Fix | Delete

[41] Fix | Delete

/**

[42] Fix | Delete

* Hook methods for invalidation on necessary events.

[43] Fix | Delete

[44] Fix | Delete

public function __construct() {

[45] Fix | Delete

[46] Fix | Delete

add_action( 'init', [ $this, 'init' ] );

[47] Fix | Delete

[48] Fix | Delete

add_action( 'deleted_term_relationships', [ self::class, 'invalidate' ] );

[49] Fix | Delete

[50] Fix | Delete

add_action( 'update_option', [ self::class, 'clear_on_option_update' ] );

[51] Fix | Delete

[52] Fix | Delete

add_action( 'edited_terms', [ self::class, 'invalidate_helper' ], 10, 2 );

[53] Fix | Delete

add_action( 'clean_term_cache', [ self::class, 'invalidate_helper' ], 10, 2 );

[54] Fix | Delete

add_action( 'clean_object_term_cache', [ self::class, 'invalidate_helper' ], 10, 2 );

[55] Fix | Delete

[56] Fix | Delete

add_action( 'user_register', [ self::class, 'invalidate_author' ] );

[57] Fix | Delete

add_action( 'delete_user', [ self::class, 'invalidate_author' ] );

[58] Fix | Delete

[59] Fix | Delete

add_action( 'shutdown', [ self::class, 'clear_queued' ] );

[60] Fix | Delete

}

[61] Fix | Delete

[62] Fix | Delete

/**

[63] Fix | Delete

* Setup context for static calls.

[64] Fix | Delete

[65] Fix | Delete

* @return void

[66] Fix | Delete

[67] Fix | Delete

public function init() {

[68] Fix | Delete

[69] Fix | Delete

self::$is_enabled = $this->is_enabled();

[70] Fix | Delete

}

[71] Fix | Delete

[72] Fix | Delete

/**

[73] Fix | Delete

* If cache is enabled.

[74] Fix | Delete

[75] Fix | Delete

* @since 3.2

[76] Fix | Delete

[77] Fix | Delete

* @return bool

[78] Fix | Delete

[79] Fix | Delete

public function is_enabled() {

[80] Fix | Delete

[81] Fix | Delete

/**

[82] Fix | Delete

* Filter if XML sitemap transient cache is enabled.

[83] Fix | Delete

[84] Fix | Delete

* @param bool $unsigned Enable cache or not, defaults to true.

[85] Fix | Delete

[86] Fix | Delete

return apply_filters( 'wpseo_enable_xml_sitemap_transient_caching', false );

[87] Fix | Delete

}

[88] Fix | Delete

[89] Fix | Delete

/**

[90] Fix | Delete

* Retrieve the sitemap page from cache.

[91] Fix | Delete

[92] Fix | Delete

* @since 3.2

[93] Fix | Delete

[94] Fix | Delete

* @param string $type Sitemap type.

[95] Fix | Delete

* @param int $page Page number to retrieve.

[96] Fix | Delete

[97] Fix | Delete

* @return string|bool

[98] Fix | Delete

[99] Fix | Delete

public function get_sitemap( $type, $page ) {

[100] Fix | Delete

[101] Fix | Delete

$transient_key = WPSEO_Sitemaps_Cache_Validator::get_storage_key( $type, $page );

[102] Fix | Delete

if ( $transient_key === false ) {

[103] Fix | Delete

return false;

[104] Fix | Delete

}

[105] Fix | Delete

[106] Fix | Delete

return get_transient( $transient_key );

[107] Fix | Delete

}

[108] Fix | Delete

[109] Fix | Delete

/**

[110] Fix | Delete

* Get the sitemap that is cached.

[111] Fix | Delete

[112] Fix | Delete

* @param string $type Sitemap type.

[113] Fix | Delete

* @param int $page Page number to retrieve.

[114] Fix | Delete

[115] Fix | Delete

* @return WPSEO_Sitemap_Cache_Data|null Null on no cache found otherwise object containing sitemap and meta data.

[116] Fix | Delete

[117] Fix | Delete

public function get_sitemap_data( $type, $page ) {

[118] Fix | Delete

[119] Fix | Delete

$sitemap = $this->get_sitemap( $type, $page );

[120] Fix | Delete

[121] Fix | Delete

if ( empty( $sitemap ) ) {

[122] Fix | Delete

return null;

[123] Fix | Delete

}

[124] Fix | Delete

[125] Fix | Delete

[126] Fix | Delete

* Unserialize Cache Data object as is_serialized() doesn't recognize classes in C format.

[127] Fix | Delete

* This work-around should no longer be needed once the minimum PHP version has gone up to PHP 7.4,

[128] Fix | Delete

* as the `WPSEO_Sitemap_Cache_Data` class uses O format serialization in PHP 7.4 and higher.

[129] Fix | Delete

[130] Fix | Delete

* @link https://wiki.php.net/rfc/custom_object_serialization

[131] Fix | Delete

[132] Fix | Delete

if ( is_string( $sitemap ) && strpos( $sitemap, 'C:24:"WPSEO_Sitemap_Cache_Data"' ) === 0 ) {

[133] Fix | Delete

// phpcs:ignore WordPress.PHP.DiscouragedPHPFunctions.serialize_unserialize -- Can't be avoided due to how WP stores options.

[134] Fix | Delete

$sitemap = unserialize( $sitemap );

[135] Fix | Delete

}

[136] Fix | Delete

[137] Fix | Delete

// What we expect it to be if it is set.

[138] Fix | Delete

if ( $sitemap instanceof WPSEO_Sitemap_Cache_Data_Interface ) {

[139] Fix | Delete

return $sitemap;

[140] Fix | Delete

}

[141] Fix | Delete

[142] Fix | Delete

return null;

[143] Fix | Delete

}

[144] Fix | Delete

[145] Fix | Delete

/**

[146] Fix | Delete

* Store the sitemap page from cache.

[147] Fix | Delete

[148] Fix | Delete

* @since 3.2

[149] Fix | Delete

[150] Fix | Delete

* @param string $type Sitemap type.

[151] Fix | Delete

* @param int $page Page number to store.

[152] Fix | Delete

* @param string $sitemap Sitemap body to store.

[153] Fix | Delete

* @param bool $usable Is this a valid sitemap or a cache of an invalid sitemap.

[154] Fix | Delete

[155] Fix | Delete

* @return bool

[156] Fix | Delete

[157] Fix | Delete

public function store_sitemap( $type, $page, $sitemap, $usable = true ) {

[158] Fix | Delete

[159] Fix | Delete

$transient_key = WPSEO_Sitemaps_Cache_Validator::get_storage_key( $type, $page );

[160] Fix | Delete

[161] Fix | Delete

if ( $transient_key === false ) {

[162] Fix | Delete

return false;

[163] Fix | Delete

}

[164] Fix | Delete

[165] Fix | Delete

$status = ( $usable ) ? WPSEO_Sitemap_Cache_Data::OK : WPSEO_Sitemap_Cache_Data::ERROR;

[166] Fix | Delete

[167] Fix | Delete

$sitemap_data = new WPSEO_Sitemap_Cache_Data();

[168] Fix | Delete

$sitemap_data->set_sitemap( $sitemap );

[169] Fix | Delete

$sitemap_data->set_status( $status );

[170] Fix | Delete

[171] Fix | Delete

return set_transient( $transient_key, $sitemap_data, DAY_IN_SECONDS );

[172] Fix | Delete

}

[173] Fix | Delete

[174] Fix | Delete

/**

[175] Fix | Delete

* Delete cache transients for index and specific type.

[176] Fix | Delete

[177] Fix | Delete

* Always deletes the main index sitemaps cache, as that's always invalidated by any other change.

[178] Fix | Delete

[179] Fix | Delete

* @since 1.5.4

[180] Fix | Delete

* @since 3.2 Changed from function wpseo_invalidate_sitemap_cache() to method in this class.

[181] Fix | Delete

[182] Fix | Delete

* @param string $type Sitemap type to invalidate.

[183] Fix | Delete

[184] Fix | Delete

* @return void

[185] Fix | Delete

[186] Fix | Delete

public static function invalidate( $type ) {

[187] Fix | Delete

[188] Fix | Delete

self::clear( [ $type ] );

[189] Fix | Delete

}

[190] Fix | Delete

[191] Fix | Delete

/**

[192] Fix | Delete

* Helper to invalidate in hooks where type is passed as second argument.

[193] Fix | Delete

[194] Fix | Delete

* @since 3.2

[195] Fix | Delete

[196] Fix | Delete

* @param int $unused Unused term ID value.

[197] Fix | Delete

* @param string $type Taxonomy to invalidate.

[198] Fix | Delete

[199] Fix | Delete

* @return void

[200] Fix | Delete

[201] Fix | Delete

public static function invalidate_helper( $unused, $type ) {

[202] Fix | Delete

[203] Fix | Delete

if (

[204] Fix | Delete

WPSEO_Options::get( 'noindex-' . $type ) === false

[205] Fix | Delete

|| WPSEO_Options::get( 'noindex-tax-' . $type ) === false

[206] Fix | Delete

) {

[207] Fix | Delete

self::invalidate( $type );

[208] Fix | Delete

}

[209] Fix | Delete

}

[210] Fix | Delete

[211] Fix | Delete

/**

[212] Fix | Delete

* Invalidate sitemap cache for authors.

[213] Fix | Delete

[214] Fix | Delete

* @param int $user_id User ID.

[215] Fix | Delete

[216] Fix | Delete

* @return bool True if the sitemap was properly invalidated. False otherwise.

[217] Fix | Delete

[218] Fix | Delete

public static function invalidate_author( $user_id ) {

[219] Fix | Delete

[220] Fix | Delete

$user = get_user_by( 'id', $user_id );

[221] Fix | Delete

[222] Fix | Delete

if ( $user === false ) {

[223] Fix | Delete

return false;

[224] Fix | Delete

}

[225] Fix | Delete

[226] Fix | Delete

if ( current_action() === 'user_register' ) {

[227] Fix | Delete

update_user_meta( $user_id, '_yoast_wpseo_profile_updated', time() );

[228] Fix | Delete

}

[229] Fix | Delete

[230] Fix | Delete

if ( empty( $user->roles ) || in_array( 'subscriber', $user->roles, true ) ) {

[231] Fix | Delete

return false;

[232] Fix | Delete

}

[233] Fix | Delete

[234] Fix | Delete

self::invalidate( 'author' );

[235] Fix | Delete

[236] Fix | Delete

return true;

[237] Fix | Delete

}

[238] Fix | Delete

[239] Fix | Delete

/**

[240] Fix | Delete

* Invalidate sitemap cache for the post type of a post.

[241] Fix | Delete

[242] Fix | Delete

* Don't invalidate for revisions.

[243] Fix | Delete

[244] Fix | Delete

* @since 1.5.4

[245] Fix | Delete

* @since 3.2 Changed from function wpseo_invalidate_sitemap_cache_on_save_post() to method in this class.

[246] Fix | Delete

[247] Fix | Delete

* @param int $post_id Post ID to invalidate type for.

[248] Fix | Delete

[249] Fix | Delete

* @return void

[250] Fix | Delete

[251] Fix | Delete

public static function invalidate_post( $post_id ) {

[252] Fix | Delete

[253] Fix | Delete

if ( wp_is_post_revision( $post_id ) ) {

[254] Fix | Delete

return;

[255] Fix | Delete

}

[256] Fix | Delete

[257] Fix | Delete

self::invalidate( get_post_type( $post_id ) );

[258] Fix | Delete

}

[259] Fix | Delete

[260] Fix | Delete

/**

[261] Fix | Delete

* Delete cache transients for given sitemaps types or all by default.

[262] Fix | Delete

[263] Fix | Delete

* @since 1.8.0

[264] Fix | Delete

* @since 3.2 Moved from WPSEO_Utils to this class.

[265] Fix | Delete

[266] Fix | Delete

* @param array $types Set of sitemap types to delete cache transients for.

[267] Fix | Delete

[268] Fix | Delete

* @return void

[269] Fix | Delete

[270] Fix | Delete

public static function clear( $types = [] ) {

[271] Fix | Delete

[272] Fix | Delete

if ( ! self::$is_enabled ) {

[273] Fix | Delete

return;

[274] Fix | Delete

}

[275] Fix | Delete

[276] Fix | Delete

// No types provided, clear all.

[277] Fix | Delete

if ( empty( $types ) ) {

[278] Fix | Delete

self::$clear_all = true;

[279] Fix | Delete

[280] Fix | Delete

return;

[281] Fix | Delete

}

[282] Fix | Delete

[283] Fix | Delete

// Always invalidate the index sitemap as well.

[284] Fix | Delete

if ( ! in_array( WPSEO_Sitemaps::SITEMAP_INDEX_TYPE, $types, true ) ) {

[285] Fix | Delete

array_unshift( $types, WPSEO_Sitemaps::SITEMAP_INDEX_TYPE );

[286] Fix | Delete

}

[287] Fix | Delete

[288] Fix | Delete

foreach ( $types as $type ) {

[289] Fix | Delete

if ( ! in_array( $type, self::$clear_types, true ) ) {

[290] Fix | Delete

self::$clear_types[] = $type;

[291] Fix | Delete

}

[292] Fix | Delete

}

[293] Fix | Delete

}

[294] Fix | Delete

[295] Fix | Delete

/**

[296] Fix | Delete

* Invalidate storage for cache types queued to clear.

[297] Fix | Delete

[298] Fix | Delete

* @return void

[299] Fix | Delete

[300] Fix | Delete

public static function clear_queued() {

[301] Fix | Delete

[302] Fix | Delete

if ( self::$clear_all ) {

[303] Fix | Delete

[304] Fix | Delete

WPSEO_Sitemaps_Cache_Validator::invalidate_storage();

[305] Fix | Delete

self::$clear_all = false;

[306] Fix | Delete

self::$clear_types = [];

[307] Fix | Delete

[308] Fix | Delete

return;

[309] Fix | Delete

}

[310] Fix | Delete

[311] Fix | Delete

foreach ( self::$clear_types as $type ) {

[312] Fix | Delete

WPSEO_Sitemaps_Cache_Validator::invalidate_storage( $type );

[313] Fix | Delete

}

[314] Fix | Delete

[315] Fix | Delete

self::$clear_types = [];

[316] Fix | Delete

}

[317] Fix | Delete

[318] Fix | Delete

/**

[319] Fix | Delete

* Adds a hook that when given option is updated, the cache is cleared.

[320] Fix | Delete

[321] Fix | Delete

* @since 3.2

[322] Fix | Delete

[323] Fix | Delete

* @param string $option Option name.

[324] Fix | Delete

* @param string $type Sitemap type.

[325] Fix | Delete

[326] Fix | Delete

* @return void

[327] Fix | Delete

[328] Fix | Delete

public static function register_clear_on_option_update( $option, $type = '' ) {

[329] Fix | Delete

[330] Fix | Delete

self::$cache_clear[ $option ] = $type;

[331] Fix | Delete

}

[332] Fix | Delete

[333] Fix | Delete

/**

[334] Fix | Delete

* Clears the transient cache when a given option is updated, if that option has been registered before.

[335] Fix | Delete

[336] Fix | Delete

* @since 3.2

[337] Fix | Delete

[338] Fix | Delete

* @param string $option The option name that's being updated.

[339] Fix | Delete

[340] Fix | Delete

* @return void

[341] Fix | Delete

[342] Fix | Delete

public static function clear_on_option_update( $option ) {

[343] Fix | Delete

[344] Fix | Delete

if ( array_key_exists( $option, self::$cache_clear ) ) {

[345] Fix | Delete

[346] Fix | Delete

if ( empty( self::$cache_clear[ $option ] ) ) {

[347] Fix | Delete

// Clear all caches.

[348] Fix | Delete

self::clear();

[349] Fix | Delete

}

[350] Fix | Delete

else {

[351] Fix | Delete

// Clear specific provided type(s).

[352] Fix | Delete

$types = (array) self::$cache_clear[ $option ];

[353] Fix | Delete

self::clear( $types );

[354] Fix | Delete

}

[355] Fix | Delete

}

[356] Fix | Delete

}

[357] Fix | Delete

}

[358] Fix | Delete

[359] Fix | Delete