class-cache.php
<?php
/**
* Cache component.
*
* @package HivePress\Components
*/
namespace HivePress\Components;
use HivePress\Helpers as hp;
// Exit if accessed directly.
defined( 'ABSPATH' ) || exit;
/**
* Handles caching.
*/
final class Cache extends Component {
/**
* Class constructor.
*
* @param array $args Component arguments.
*/
public function __construct( $args = [] ) {
// Clear transient cache.
add_action( 'import_end', [ $this, 'clear_transient_cache' ] );
// Clear meta cache.
add_action( 'hivepress/v1/events/hourly', [ $this, 'clear_meta_cache' ] );
// Clear user cache.
add_action( 'hivepress/v1/models/user/create', [ $this, 'clear_user_cache' ], 1000 );
add_action( 'hivepress/v1/models/user/update', [ $this, 'clear_user_cache' ], 1000 );
add_action( 'hivepress/v1/models/user/delete', [ $this, 'clear_user_cache' ], 1000 );
// Clear post cache.
add_action( 'hivepress/v1/models/post/create', [ $this, 'clear_post_cache' ], 1000, 2 );
add_action( 'hivepress/v1/models/post/update', [ $this, 'clear_post_cache' ], 1000, 2 );
add_action( 'hivepress/v1/models/post/delete', [ $this, 'clear_post_cache' ], 1000, 2 );
// Clear post term cache.
add_action( 'hivepress/v1/models/post/update_terms', [ $this, 'clear_post_term_cache' ], 1000, 3 );
// Clear term cache.
add_action( 'hivepress/v1/models/term/create', [ $this, 'clear_term_cache' ], 1000, 2 );
add_action( 'hivepress/v1/models/term/update', [ $this, 'clear_term_cache' ], 1000, 2 );
add_action( 'hivepress/v1/models/term/delete', [ $this, 'clear_term_cache' ], 1000, 2 );
// Clear comment cache.
add_action( 'hivepress/v1/models/comment/create', [ $this, 'clear_comment_cache' ], 1000, 2 );
add_action( 'hivepress/v1/models/comment/update', [ $this, 'clear_comment_cache' ], 1000, 2 );
add_action( 'hivepress/v1/models/comment/delete', [ $this, 'clear_comment_cache' ], 1000, 2 );
parent::__construct( $args );
}
/**
* Checks if cache is enabled.
*
* @return bool
*/
protected function is_enabled() {
return ! defined( 'HP_CACHE' ) || HP_CACHE;
}
/**
* Catches calls to undefined methods.
*
* @param string $name Method name.
* @param array $args Method arguments.
* @throws \BadMethodCallException Invalid method.
* @return mixed
*/
public function __call( $name, $args ) {
preg_match( '/^(get|set|delete)_([a-z_]+)_cache$/', $name, $matches );
if ( is_array( $matches ) && count( $matches ) === 3 ) {
array_shift( $matches );
$method = hp\get_first_array_value( $matches ) . '_meta_cache';
$type = hp\get_last_array_value( $matches );
if ( method_exists( $this, $method ) ) {
return call_user_func_array( [ $this, $method ], array_merge( [ $type ], $args ) );
}
}
throw new \BadMethodCallException();
}
/**
* Gets transient cache.
*
* @param mixed $key Cache key.
* @param string $group Cache group.
* @return mixed
*/
public function get_cache( $key, $group = null ) {
// Check status.
if ( ! $this->is_enabled() ) {
return;
}
// Get value.
$cache = get_transient( $this->get_cache_name( $key, $group ) );
// Normalize value.
if ( false === $cache ) {
$cache = null;
}
return $cache;
}
/**
* Gets meta cache.
*
* @param string $type Meta type.
* @param int $id Object ID.
* @param mixed $key Cache key.
* @param string $group Cache group.
* @return mixed
*/
protected function get_meta_cache( $type, $id, $key, $group = null ) {
$cache = null;
// Check status.
if ( ! $this->is_enabled() ) {
return;
}
// Set callback.
$callback = 'get_' . $type . '_meta';
if ( function_exists( $callback ) ) {
// Get name.
$name = $this->get_meta_cache_name( $type, $id, $key, $group );
// Get timeout.
$timeout = absint( call_user_func_array( $callback, [ $id, '_transient_timeout_' . $name, true ] ) );
if ( 0 !== $timeout && $timeout <= time() ) {
// Delete value.
$this->delete_meta_cache( $type, $id, $key, $group );
} else {
// Get value.
$cache = call_user_func_array( $callback, [ $id, '_transient_' . $name, true ] );
// Normalize value.
if ( '' === $cache ) {
$cache = null;
}
}
}
return $cache;
}
/**
* Sets transient cache.
*
* @param mixed $key Cache key.
* @param string $group Cache group.
* @param mixed $value Cache value.
* @param int $expiration Expiration period in seconds.
*/
public function set_cache( $key, $group, $value, $expiration = 0 ) {
// Check status.
if ( ! $this->is_enabled() ) {
return;
}
// Get expiration period.
if ( 0 === $expiration ) {
if ( ! wp_using_ext_object_cache() ) {
$expiration = DAY_IN_SECONDS;
} else {
$expiration = WEEK_IN_SECONDS;
}
}
$expiration = absint( $expiration );
// Set value.
set_transient( $this->get_cache_name( $key, $group ), $value, $expiration );
}
/**
* Sets meta cache.
*
* @param string $type Meta type.
* @param int $id Object ID.
* @param mixed $key Cache key.
* @param string $group Cache group.
* @param mixed $value Cache value.
* @param int $expiration Expiration period in seconds.
*/
protected function set_meta_cache( $type, $id, $key, $group, $value, $expiration = DAY_IN_SECONDS ) {
// Check status.
if ( ! $this->is_enabled() ) {
return;
}
// Set callback.
$callback = 'update_' . $type . '_meta';
if ( function_exists( $callback ) ) {
// Get name.
$name = $this->get_meta_cache_name( $type, $id, $key, $group );
// Set value.
call_user_func_array( $callback, [ $id, '_transient_' . $name, $value ] );
// Set timeout.
if ( $expiration > 0 ) {
call_user_func_array( $callback, [ $id, '_transient_timeout_' . $name, time() + $expiration ] );
}
}
}
/**
* Deletes transient cache.
*
* @param mixed $key Cache key.
* @param string $group Cache group.
*/
public function delete_cache( $key, $group = null ) {
// Check status.
if ( ! $this->is_enabled() ) {
return;
}
if ( is_null( $key ) && ! is_null( $group ) ) {
// Update version.
$this->update_cache_version( $group );
} else {
// Delete value.
delete_transient( $this->get_cache_name( $key, $group ) );
}
}
/**
* Deletes meta cache.
*
* @param string $type Meta type.
* @param int $id Object ID.
* @param mixed $key Cache key.
* @param string $group Cache group.
*/
protected function delete_meta_cache( $type, $id, $key, $group = null ) {
// Check status.
if ( ! $this->is_enabled() ) {
return;
}
// Set callback.
$callback = 'delete_' . $type . '_meta';
if ( function_exists( $callback ) ) {
if ( is_null( $key ) && ! is_null( $group ) ) {
// Update version.
$this->update_meta_cache_version( $type, $id, $group );
} else {
// Get name.
$name = $this->get_meta_cache_name( $type, $id, $key, $group );
// Delete value.
call_user_func_array( $callback, [ $id, '_transient_' . $name ] );
// Delete timeout.
call_user_func_array( $callback, [ $id, '_transient_timeout_' . $name ] );
}
}
}
/**
* Gets transient cache name.
*
* @param mixed $key Cache key.
* @param string $group Cache group.
* @return string
*/
protected function get_cache_name( $key, $group = null ) {
$name = $this->serialize_cache_key( $key );
if ( ! is_null( $group ) ) {
$name .= $this->get_cache_version( $group );
$name = $group . '/' . md5( $name );
}
return hp\prefix( $name );
}
/**
* Gets meta cache name.
*
* @param string $type Meta type.
* @param int $id Object ID.
* @param mixed $key Cache key.
* @param string $group Cache group.
* @return string
*/
protected function get_meta_cache_name( $type, $id, $key, $group = null ) {
$name = $this->serialize_cache_key( $key );
if ( ! is_null( $group ) ) {
$name .= $this->get_meta_cache_version( $type, $id, $group );
$name = $group . '/' . md5( $name );
}
return hp\prefix( $name );
}
/**
* Gets transient cache version.
*
* @param string $group Cache group.
* @return string
*/
public function get_cache_version( $group ) {
// Check status.
if ( ! $this->is_enabled() ) {
return;
}
// Get version.
$version = $this->get_cache( $group . '/version' );
if ( is_null( $version ) ) {
// Set version.
$version = $this->update_cache_version( $group );
}
return $version;
}
/**
* Gets meta cache version.
*
* @param string $type Meta type.
* @param int $id Object ID.
* @param string $group Cache group.
* @return string
*/
protected function get_meta_cache_version( $type, $id, $group ) {
$version = $this->get_meta_cache( $type, $id, $group . '/version' );
if ( is_null( $version ) ) {
$version = $this->update_meta_cache_version( $type, $id, $group );
}
return $version;
}
/**
* Updates transient cache version.
*
* @param string $group Cache group.
* @return string
*/
protected function update_cache_version( $group ) {
// Get version.
$version = uniqid( '', true );
// Get expiration period.
$expiration = false;
if ( ! wp_using_ext_object_cache() ) {
$expiration = WEEK_IN_SECONDS;
}
// Set version.
$this->set_cache( $group . '/version', null, $version, $expiration );
return $version;
}
/**
* Updates meta cache version.
*
* @param string $type Meta type.
* @param int $id Object ID.
* @param string $group Cache group.
* @return string
*/
protected function update_meta_cache_version( $type, $id, $group ) {
$version = uniqid( '', true );
$this->set_meta_cache( $type, $id, $group . '/version', null, $version, WEEK_IN_SECONDS );
return $version;
}
/**
* Serializes cache key.
*
* @param mixed $key Cache key.
* @return string
*/
protected function serialize_cache_key( $key ) {
if ( is_array( $key ) ) {
$key = wp_json_encode( $this->sort_cache_key( $key ) );
}
return $key;
}
/**
* Sorts cache key contents.
*
* @param mixed $key Cache key.
* @return mixed
*/
protected function sort_cache_key( $key ) {
if ( is_array( $key ) ) {
ksort( $key );
foreach ( $key as $name => $value ) {
$key[ $name ] = $this->sort_cache_key( $value );
}
}
return $key;
}
/**
* Clears transient cache.
*/
public function clear_transient_cache() {
global $wpdb;
// Delete transients.
$wpdb->query( "DELETE FROM {$wpdb->options} WHERE option_name LIKE '\_transient\_hp\_%';" );
$wpdb->query( "DELETE FROM {$wpdb->options} WHERE option_name LIKE '\_transient\_timeout\_hp\_%';" );
}
/**
* Clears meta cache.
*/
public function clear_meta_cache() {
global $wpdb;
// Check status.
if ( ! $this->is_enabled() ) {
return;
}
// Set types.
$types = [ 'user', 'post', 'term', 'comment' ];
foreach ( $types as $type ) {
// Set callback.
$callback = 'delete_' . $type . '_meta';
if ( function_exists( $callback ) ) {
// Get values.
$table = $wpdb->prefix . $type . 'meta';
$column = $type . '_id';
$meta_values = $wpdb->get_results(
$wpdb->prepare(
"SELECT {$column}, meta_key FROM {$table} WHERE meta_key LIKE %s AND CAST(meta_value AS SIGNED) <= %d;",
'\_transient\_timeout\_%',
time()
),
ARRAY_A
);
// Delete values.
if ( $meta_values ) {
foreach ( $meta_values as $meta_value ) {
call_user_func_array( $callback, [ $meta_value[ $column ], $meta_value['meta_key'] ] );
call_user_func_array( $callback, [ $meta_value[ $column ], preg_replace( '/^_transient_timeout/', '_transient', $meta_value['meta_key'] ) ] );
}
}
}
}
}
/**
* Clears user cache.
*
* @param int $user_id User ID.
*/
public function clear_user_cache( $user_id ) {
// Check status.
if ( ! $this->is_enabled() ) {
return;
}
// Delete transient cache.
$this->delete_cache( null, 'models/user' );
}
/**
* Clears post cache.
*
* @param int $post_id Post ID.
* @param string $post_type Post type.
*/
public function clear_post_cache( $post_id, $post_type ) {
// Check status.
if ( ! $this->is_enabled() ) {
return;
}
// Get post.
$post = get_post( $post_id );
// Get cache group.
$group = hivepress()->model->get_cache_group( 'post', $post_type );
// Delete transient cache.
$this->delete_cache( null, $group );
// Delete meta cache.
if ( $post->post_author ) {
$this->delete_user_cache( $post->post_author, null, $group );
}
if ( $post->post_parent ) {
$this->delete_post_cache( $post->post_parent, null, $group );
}
}
/**
* Clears post term cache.
*
* @param int $post_id Post ID.
* @param string $post_type Post type.
* @param string $taxonomy Taxonomy name.
*/
public function clear_post_term_cache( $post_id, $post_type, $taxonomy ) {
// Check status.
if ( ! $this->is_enabled() ) {
return;
}
// Delete meta cache.
$this->delete_post_cache( $post_id, null, hivepress()->model->get_cache_group( 'term', $taxonomy ) );
}
/**
* Clears term cache.
*
* @param int $term_id Term ID.
* @param string $taxonomy Taxonomy name.
*/
public function clear_term_cache( $term_id, $taxonomy ) {
// Check status.
if ( ! $this->is_enabled() ) {
return;
}
// Delete transient cache.
$this->delete_cache( null, hivepress()->model->get_cache_group( 'term', $taxonomy ) );
}
/**
* Clears comment cache.
*
* @param int $comment_id Comment ID.
* @param string $comment_type Comment type.
*/
public function clear_comment_cache( $comment_id, $comment_type ) {
// Check status.
if ( ! $this->is_enabled() ) {
return;
}
// Get comment.
$comment = get_comment( $comment_id );
// Get cache group.
$group = hivepress()->model->get_cache_group( 'comment', $comment_type );
// Delete transient cache.
$this->delete_cache( null, $group );
// Delete meta cache.
if ( $comment->user_id ) {
$this->delete_user_cache( $comment->user_id, null, $group );
}
if ( $comment->comment_post_ID ) {
$this->delete_post_cache( $comment->comment_post_ID, null, $group );
}
}
}
