class-wc-cache-helper.php
<?php
/**
* WC_Cache_Helper class.
*
* @package WooCommerce\Classes
*/
use Automattic\WooCommerce\Caching\CacheNameSpaceTrait;
defined( 'ABSPATH' ) || exit;
/**
* WC_Cache_Helper.
*/
class WC_Cache_Helper {
use CacheNameSpaceTrait;
/**
* Transients to delete on shutdown.
*
* @var array Array of transient keys.
*/
private static $delete_transients = array();
/**
* Hook in methods.
*/
public static function init() {
add_action( 'wp_headers', array( __CLASS__, 'prevent_caching' ), 5 ); // Lower priority than default to facilitate plugins enforcing `no-store` if desired.
add_action( 'shutdown', array( __CLASS__, 'delete_transients_on_shutdown' ), 10 );
add_action( 'template_redirect', array( __CLASS__, 'geolocation_ajax_redirect' ) );
add_action( 'wc_ajax_update_order_review', array( __CLASS__, 'update_geolocation_hash' ), 5 );
add_action( 'admin_notices', array( __CLASS__, 'notices' ) );
add_action( 'delete_version_transients', array( __CLASS__, 'delete_version_transients' ), 10 );
add_action( 'clean_term_cache', array( __CLASS__, 'clean_term_cache' ), 10, 2 );
add_action( 'edit_terms', array( __CLASS__, 'clean_term_cache' ), 10, 2 );
}
/**
* Prevent caching on certain pages.
*
* @since 3.6.0
* @since 10.1.0 This is now a callback for the `wp_headers` filter as opposed to a callback for the `wp` action.
*
* @param array<string, string> $headers Header names and field values.
* @return array<string, string> Filtered headers.
*/
public static function prevent_caching( $headers ) {
if ( ! is_blog_installed() ) {
return $headers;
}
$page_ids = array_filter( array( wc_get_page_id( 'cart' ), wc_get_page_id( 'checkout' ), wc_get_page_id( 'myaccount' ) ) );
if ( ! is_page( $page_ids ) ) {
return $headers;
}
self::set_nocache_constants();
// Gather the original Cache-Control directives as well as the nocache ones to merge into one new Cache-Control header.
if ( isset( $headers['Cache-Control'] ) ) {
$old_directives = preg_split( '/\s*,\s*/', trim( $headers['Cache-Control'] ) );
} else {
$old_directives = array();
}
$nocache_headers = wp_get_nocache_headers();
if ( isset( $nocache_headers['Cache-Control'] ) ) {
$new_directives = preg_split( '/\s*,\s*/', trim( $nocache_headers['Cache-Control'] ) );
} else {
$new_directives = array();
}
$headers = array_merge( $headers, $nocache_headers );
/*
* If the user is not logged in, remove the `no-store` directive so that bfcache is not blocked for visitors,
* allowing them to benefit from instant back/forward navigations in the storefront. This essentially undoes
* <https://core.trac.wordpress.org/ticket/61942> which seems to have been excessive since the `private`
* directive was already being sent to prevent the page from being cached in a proxy server.
*
* Note that <https://core.trac.wordpress.org/ticket/63636> proposes removing `no-store` for logged-in users as
* well. When that happens, the following if statement can be removed since core would no longer be sending
* `no-store` in the first place.
*
* If a site really wants to enforce the `no-store` directive for some reason, they can do so by making sure
* that the `no-store` directive is added to the `Cache-Control` header via the `wp_headers` filter, for
* example:
*
* add_filter( 'wp_headers', function ( $headers ) {
* if ( isset( $headers['Cache-Control'] ) ) {
* $directives = preg_split( ':\s*,\s*:', trim( $headers['Cache-Control'] ) );
* if ( in_array( 'private', $directives, true ) ) {
* $headers['Cache-Control'] = join(
* ', ',
* array_unique(
* array_merge(
* $directives,
* array( 'no-store' )
* )
* )
* );
* }
* }
* return $headers;
* } );
*/
if ( ! is_user_logged_in() ) {
$new_directives = array_diff( $new_directives, array( 'no-store' ) );
}
$headers['Cache-Control'] = implode( ', ', array_unique( array_merge( $old_directives, $new_directives ) ) );
return $headers;
}
/**
* Add a transient to delete on shutdown.
*
* @since 3.6.0
* @param string|array $keys Transient key or keys.
*/
public static function queue_delete_transient( $keys ) {
self::$delete_transients = array_unique( array_merge( is_array( $keys ) ? $keys : array( $keys ), self::$delete_transients ) );
}
/**
* Transients that don't need to be cleaned right away can be deleted on shutdown to avoid repetition.
*
* @since 3.6.0
*/
public static function delete_transients_on_shutdown() {
if ( self::$delete_transients ) {
foreach ( self::$delete_transients as $key ) {
delete_transient( $key );
}
self::$delete_transients = array();
}
}
/**
* Used to clear layered nav counts based on passed attribute names.
*
* @since 3.6.0
* @param array $attribute_keys Attribute keys.
*/
public static function invalidate_attribute_count( $attribute_keys ) {
if ( $attribute_keys ) {
foreach ( $attribute_keys as $attribute_key ) {
self::queue_delete_transient( 'wc_layered_nav_counts_' . $attribute_key );
}
}
}
/**
* Get a hash of the customer location.
*
* @return string
*/
public static function geolocation_ajax_get_location_hash() {
$customer = new WC_Customer( 0, true );
$location = array();
$location['country'] = $customer->get_billing_country();
$location['state'] = $customer->get_billing_state();
$location['postcode'] = $customer->get_billing_postcode();
$location['city'] = $customer->get_billing_city();
$location_hash = substr( md5( strtolower( implode( '', $location ) ) ), 0, 12 );
/**
* Controls the location hash used in geolocation-based caching.
*
* @since 3.6.0
*
* @param string $location_hash The hash used for geolocation.
* @param array $location The location/address data.
* @param WC_Customer $customer The current customer object.
*/
return apply_filters( 'woocommerce_geolocation_ajax_get_location_hash', $location_hash, $location, $customer );
}
/**
* When using geolocation via ajax, to bust cache, redirect if the location hash does not equal the querystring.
*
* This prevents caching of the wrong data for this request.
*/
public static function geolocation_ajax_redirect() {
if ( 'geolocation_ajax' === get_option( 'woocommerce_default_customer_address' ) && ! is_checkout() && ! is_cart() && ! is_account_page() && ! wp_doing_ajax() && empty( $_POST ) ) { // WPCS: CSRF ok, input var ok.
$location_hash = self::geolocation_ajax_get_location_hash();
$current_hash = isset( $_GET['v'] ) ? wc_clean( wp_unslash( $_GET['v'] ) ) : ''; // WPCS: sanitization ok, input var ok, CSRF ok.
if ( empty( $current_hash ) || $current_hash !== $location_hash ) {
global $wp;
$redirect_url = trailingslashit( home_url( $wp->request ) );
if ( ! empty( $_SERVER['QUERY_STRING'] ) ) { // WPCS: Input var ok.
$redirect_url = add_query_arg( wp_unslash( $_SERVER['QUERY_STRING'] ), '', $redirect_url ); // WPCS: sanitization ok, Input var ok.
}
if ( ! get_option( 'permalink_structure' ) ) {
$redirect_url = add_query_arg( $wp->query_string, '', $redirect_url );
}
$redirect_url = add_query_arg( 'v', $location_hash, remove_query_arg( array( 'v', 'add-to-cart' ), $redirect_url ) );
wp_safe_redirect( esc_url_raw( $redirect_url ), 307 );
exit;
}
}
}
/**
* Updates the `woocommerce_geo_hash` cookie, which is used to help ensure we display
* the correct pricing etc to customers, according to their billing country.
*
* Note that:
*
* A) This only sets the cookie if the default customer address is set to "Geolocate (with
* Page Caching Support)".
*
* B) It is hooked into the `wc_ajax_update_order_review` action, which has the benefit of
* ensuring we update the cookie any time the billing country is changed.
*/
public static function update_geolocation_hash() {
if ( 'geolocation_ajax' === get_option( 'woocommerce_default_customer_address' ) ) {
wc_setcookie( 'woocommerce_geo_hash', static::geolocation_ajax_get_location_hash(), time() + HOUR_IN_SECONDS );
}
}
/**
* Get transient version.
*
* When using transients with unpredictable names, e.g. those containing an md5
* hash in the name, we need a way to invalidate them all at once.
*
* When using default WP transients we're able to do this with a DB query to
* delete transients manually.
*
* With external cache however, this isn't possible. Instead, this function is used
* to append a unique string (based on time()) to each transient. When transients
* are invalidated, the transient version will increment and data will be regenerated.
*
* Raised in issue https://github.com/woocommerce/woocommerce/issues/5777.
* Adapted from ideas in http://tollmanz.com/invalidation-schemes/.
*
* @param string $group Name for the group of transients we need to invalidate.
* @param boolean $refresh true to force a new version.
* @return string transient version based on time(), 10 digits.
*/
public static function get_transient_version( $group, $refresh = false ) {
$transient_name = $group . '-transient-version';
$transient_value = get_transient( $transient_name );
if ( false === $transient_value || true === $refresh ) {
$transient_value = (string) time();
set_transient( $transient_name, $transient_value );
}
return $transient_value;
}
/**
* Set constants to prevent caching by some plugins.
*
* @param mixed $return Value to return. Previously hooked into a filter.
* @return mixed
*/
public static function set_nocache_constants( $return = true ) {
wc_maybe_define_constant( 'DONOTCACHEPAGE', true );
wc_maybe_define_constant( 'DONOTCACHEOBJECT', true );
wc_maybe_define_constant( 'DONOTCACHEDB', true );
return $return;
}
/**
* Notices function.
*/
public static function notices() {
if ( ! function_exists( 'w3tc_pgcache_flush' ) || ! function_exists( 'w3_instance' ) ) {
return;
}
$config = w3_instance( 'W3_Config' );
$enabled = $config->get_integer( 'dbcache.enabled' );
$settings = array_map( 'trim', $config->get_array( 'dbcache.reject.sql' ) );
if ( $enabled && ! in_array( '_wc_session_', $settings, true ) ) {
?>
<div class="error">
<p>
<?php
/* translators: 1: key 2: URL */
echo wp_kses_post( sprintf( __( 'In order for <strong>database caching</strong> to work with WooCommerce you must add %1$s to the "Ignored Query Strings" option in <a href="%2$s">W3 Total Cache settings</a>.', 'woocommerce' ), '<code>_wc_session_</code>', esc_url( admin_url( 'admin.php?page=w3tc_dbcache' ) ) ) );
?>
</p>
</div>
<?php
}
}
/**
* Clean term caches added by WooCommerce.
*
* @since 3.3.4
* @param array|int $ids Array of ids or single ID to clear cache for.
* @param string $taxonomy Taxonomy name.
*/
public static function clean_term_cache( $ids, $taxonomy ) {
if ( 'product_cat' === $taxonomy ) {
$ids = is_array( $ids ) ? $ids : array( $ids );
$clear_ids = array( 0 );
foreach ( $ids as $id ) {
$clear_ids[] = $id;
$clear_ids = array_merge( $clear_ids, get_ancestors( $id, 'product_cat', 'taxonomy' ) );
}
$clear_ids = array_unique( $clear_ids );
foreach ( $clear_ids as $id ) {
wp_cache_delete( 'product-category-hierarchy-' . $id, 'product_cat' );
}
}
}
/**
* When the transient version increases, this is used to remove all past transients to avoid filling the DB.
*
* Note; this only works on transients appended with the transient version, and when object caching is not being used.
*
* @deprecated 3.6.0 Adjusted transient usage to include versions within the transient values, making this cleanup obsolete.
* @since 2.3.10
* @param string $version Version of the transient to remove.
*/
public static function delete_version_transients( $version = '' ) {
if ( ! wp_using_ext_object_cache() && ! empty( $version ) ) {
global $wpdb;
$limit = apply_filters( 'woocommerce_delete_version_transients_limit', 1000 );
if ( ! $limit ) {
return;
}
$affected = $wpdb->query( $wpdb->prepare( "DELETE FROM {$wpdb->options} WHERE option_name LIKE %s LIMIT %d;", '\_transient\_%' . $version, $limit ) ); // WPCS: cache ok, db call ok.
// If affected rows is equal to limit, there are more rows to delete. Delete in 30 secs.
if ( $affected === $limit ) {
wp_schedule_single_event( time() + 30, 'delete_version_transients', array( $version ) );
}
}
}
}
WC_Cache_Helper::init();
