From 0ec36ce0858450516cd66d3312266f331ae077a6 Mon Sep 17 00:00:00 2001 From: naxvog Date: Sat, 15 Aug 2020 15:44:46 +0200 Subject: [PATCH 01/93] phpcbf auto fixes --- includes/class-plugin.php | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/includes/class-plugin.php b/includes/class-plugin.php index 801503b0..4ce2e3bb 100644 --- a/includes/class-plugin.php +++ b/includes/class-plugin.php @@ -279,8 +279,8 @@ public function enqueue_redis_metrics() { ); wp_localize_script( 'redis-cache', 'rediscache_metrics', $metrics ); - } catch (Exception $exception) { - error_log($exception); + } catch ( Exception $exception ) { + error_log( $exception ); } } @@ -518,12 +518,14 @@ public function do_admin_actions() { $result ? add_settings_error( 'redis-cache', - 'dropin', __( 'Object cache disabled.', 'redis-cache' ), + 'dropin', + __( 'Object cache disabled.', 'redis-cache' ), 'updated' ) : add_settings_error( 'redis-cache', - 'dropin', __( 'Object cache could not be disabled.', 'redis-cache' ), + 'dropin', + __( 'Object cache could not be disabled.', 'redis-cache' ), 'error' ); } @@ -552,7 +554,6 @@ public function do_admin_actions() { 'error' ); } - } $messages = get_settings_errors( 'redis-cache' ); @@ -683,8 +684,8 @@ public function record_metrics() { time(), http_build_query( $metrics, null, ';' ) ); - } catch (Exception $exception) { - error_log($exception); + } catch ( Exception $exception ) { + error_log( $exception ); } } @@ -709,8 +710,8 @@ public function discard_metrics() { 0, time() - HOUR_IN_SECONDS ); - } catch (Exception $exception) { - error_log($exception); + } catch ( Exception $exception ) { + error_log( $exception ); } } @@ -791,9 +792,8 @@ public function initialize_filesystem( $url, $silent = false ) { return true; } - public function test_filesystem_writing() - { - global $wp_filesystem; + public function test_filesystem_writing() { + global $wp_filesystem; if ( ! $this->initialize_filesystem( '', true ) ) { return new WP_Error( 'fs', __( 'Could not initialize filesystem.', 'redis-cache' ) ); From 2ecd9543714362462a29d3f85c811f94384b286a Mon Sep 17 00:00:00 2001 From: naxvog Date: Sat, 15 Aug 2020 15:45:54 +0200 Subject: [PATCH 02/93] added property and method comments --- includes/class-plugin.php | 234 +++++++++++++++++++++++++++++++++++--- 1 file changed, 218 insertions(+), 16 deletions(-) diff --git a/includes/class-plugin.php b/includes/class-plugin.php index 4ce2e3bb..073b1dfc 100644 --- a/includes/class-plugin.php +++ b/includes/class-plugin.php @@ -12,12 +12,30 @@ defined( '\\ABSPATH' ) || exit; +/** + * Main plugin class definition + */ class Plugin { - private $page; + /** + * Settings page uri + * + * @var string $page + */ + private $page = ''; + /** + * Settings page slug + * + * @var string $screen + */ private $screen = ''; + /** + * Allowed setting page actions + * + * @var string[] $actions + */ private $actions = array( 'enable-cache', 'disable-cache', @@ -26,14 +44,14 @@ class Plugin { ); /** - * Plugin instance property. + * Plugin instance property * * @var Plugin */ private static $instance; /** - * Plugin instanciation method. + * Plugin instanciation method * * @return Plugin */ @@ -45,6 +63,9 @@ public static function instance() { return self::$instance; } + /** + * Constructor + */ private function __construct() { require_once ABSPATH . 'wp-admin/includes/plugin.php'; @@ -66,6 +87,11 @@ private function __construct() { } } + /** + * Adds all necessary hooks + * + * @return void + */ public function add_actions_and_filters() { add_action( 'deactivate_plugin', array( $this, 'on_deactivation' ) ); add_action( 'admin_init', array( $this, 'maybe_update_dropin' ) ); @@ -97,8 +123,12 @@ public function add_actions_and_filters() { add_filter( 'qm/outputter/html', array( $this, 'register_qm_output' ) ); } + /** + * Adds a submenu page to "Settings" + * + * @return void + */ public function add_admin_menu_page() { - // add sub-page to "Settings" add_submenu_page( is_multisite() ? 'settings.php' : 'options-general.php', __( 'Redis Object Cache', 'redis-cache' ), @@ -109,18 +139,23 @@ public function add_admin_menu_page() { ); } + /** + * Displays the settings page + * + * @return void + */ public function show_admin_page() { - // request filesystem credentials? + // Request filesystem credentials? if ( isset( $_GET['_wpnonce'], $_GET['action'] ) ) { $action = $_GET['action']; foreach ( $this->actions as $name ) { - // verify nonce + // Nonce verification. if ( $action === $name && wp_verify_nonce( $_GET['_wpnonce'], $action ) ) { $url = $this->action_link( $action ); if ( $this->initialize_filesystem( $url ) === false ) { - return; // request filesystem credentials + return; // Request filesystem credentials. } } } @@ -147,10 +182,15 @@ public function show_admin_page() { __( 'Diagnostics', 'redis-cache' ) ); - // show admin page + // Show the admin page. require_once WP_REDIS_PLUGIN_PATH . '/includes/ui/settings.php'; } + /** + * Adds the dashboard metrics widget + * + * @return void + */ public function setup_dashboard_widget() { if ( defined( 'WP_REDIS_DISABLE_METRICS' ) && WP_REDIS_DISABLE_METRICS ) { return; @@ -163,18 +203,33 @@ public function setup_dashboard_widget() { ); } + /** + * Displays the dashboard widget + * + * @return void + */ public function show_dashboard_widget() { require_once WP_REDIS_PLUGIN_PATH . '/includes/ui/widget.php'; } + /** + * Adds the settings page to the plugin action links on the plugin page + * + * @param string[] $links The current plugin action links. + * @return string[] + */ public function add_plugin_actions_links( $links ) { - // add settings link to plugin actions return array_merge( [ sprintf( '%s', network_admin_url( $this->page ), esc_html__( 'Settings', 'redis-cache' ) ) ], $links ); } + /** + * Enqueues admin style resources + * + * @return void + */ public function enqueue_admin_styles() { $screen = get_current_screen(); @@ -195,6 +250,11 @@ public function enqueue_admin_styles() { wp_enqueue_style( 'redis-cache', WP_REDIS_DIR . '/assets/css/admin.css', null, WP_REDIS_VERSION ); } + /** + * Enqueues admin script resources + * + * @return void + */ public function enqueue_admin_scripts() { $screen = get_current_screen(); @@ -242,6 +302,11 @@ public function enqueue_admin_scripts() { ); } + /** + * Enqueues scripts to display recorded metrics + * + * @return void + */ public function enqueue_redis_metrics() { global $wp_object_cache; @@ -284,12 +349,24 @@ public function enqueue_redis_metrics() { } } + /** + * Registers a new cache collector for the Query Monitor plugin + * + * @param array $collectors Array of currently registered collectors. + * @return array + */ public function register_qm_collector( array $collectors ) { $collectors['cache'] = new QM_Collector(); return $collectors; } + /** + * Registers a new cache output using our collector for the Query Monitor plugin + * + * @param array $output Array of current QM_Output handlers. + * @return array + */ public function register_qm_output( $output ) { $collector = \QM_Collectors::get( 'cache' ); @@ -303,10 +380,20 @@ public function register_qm_output( $output ) { return $output; } + /** + * Checks if the `object-cache.php` drop-in exists + * + * @return bool + */ public function object_cache_dropin_exists() { return file_exists( WP_CONTENT_DIR . '/object-cache.php' ); } + /** + * Validates the `object-cache.php` drop-in + * + * @return bool + */ public function validate_object_cache_dropin() { if ( ! $this->object_cache_dropin_exists() ) { return false; @@ -318,6 +405,11 @@ public function validate_object_cache_dropin() { return $dropin['PluginURI'] === $plugin['PluginURI']; } + /** + * Checks if the `object-cache.php` drop-in is outdated + * + * @return bool + */ public function object_cache_dropin_outdated() { if ( ! $this->object_cache_dropin_exists() ) { return false; @@ -333,6 +425,11 @@ public function object_cache_dropin_outdated() { return false; } + /** + * Retrieves the current human-readable status + * + * @return string + */ public function get_status() { global $wp_object_cache; @@ -380,6 +477,12 @@ public function get_redis_status() { return $wp_object_cache->redis_status(); } + /** + * Returns the redis version if possible + * + * @see WP_Object_Cache::redis_version() + * @return null|string + */ public function get_redis_version() { global $wp_object_cache; @@ -392,6 +495,11 @@ public function get_redis_version() { } } + /** + * Returns the currently used redis client (if any) + * + * @return null|string + */ public function get_redis_client_name() { global $wp_object_cache; @@ -404,6 +512,11 @@ public function get_redis_client_name() { } } + /** + * Fetches the redis diagnostics data + * + * @return null|array + */ public function get_diagnostics() { global $wp_object_cache; @@ -412,21 +525,36 @@ public function get_diagnostics() { } } + /** + * Retrieves the redis prefix + * + * @return null|mixed + */ public function get_redis_prefix() { return defined( 'WP_REDIS_PREFIX' ) ? WP_REDIS_PREFIX : null; } + /** + * Retrieves the redis maximum time to live + * + * @return null|mixed + */ public function get_redis_maxttl() { return defined( 'WP_REDIS_MAXTTL' ) ? WP_REDIS_MAXTTL : null; } + /** + * Displays admin notices + * + * @return void + */ public function show_admin_notices() { if ( ! defined( 'WP_REDIS_DISABLE_BANNERS' ) || ! WP_REDIS_DISABLE_BANNERS ) { $this->pro_notice(); $this->wc_pro_notice(); } - // only show admin notices to users with the right capability + // Only show admin notices to users with the right capability. if ( ! current_user_can( is_multisite() ? 'manage_network_options' : 'manage_options' ) ) { return; } @@ -436,11 +564,11 @@ public function show_admin_notices() { if ( $this->validate_object_cache_dropin() ) { if ( $this->object_cache_dropin_outdated() ) { - // translators: %s = Action link to update the drop-in + // translators: %s = Action link to update the drop-in. $message = sprintf( __( 'The Redis object cache drop-in is outdated. Please update the drop-in.', 'redis-cache' ), $url ); } } else { - // translators: %s = Action link to update the drop-in + // translators: %s = Action link to update the drop-in. $message = sprintf( __( 'A foreign object cache drop-in was found. To use Redis for object caching, please enable the drop-in.', 'redis-cache' ), $url ); } @@ -450,13 +578,18 @@ public function show_admin_notices() { } } + /** + * Executes admin actions + * + * @return void + */ public function do_admin_actions() { global $wp_filesystem; if ( isset( $_GET['_wpnonce'], $_GET['action'] ) ) { $action = $_GET['action']; - // verify nonce + // Nonce verification. foreach ( $this->actions as $name ) { if ( $action === $name && ! wp_verify_nonce( $_GET['_wpnonce'], $action ) ) { return; @@ -570,6 +703,11 @@ public function do_admin_actions() { } } + /** + * Dismisses the admin notice for the current user + * + * @return void + */ public function dismiss_notice() { $notice = sprintf( 'roc_dismissed_%s', @@ -581,6 +719,11 @@ public function dismiss_notice() { wp_die(); } + /** + * Displays a redis cache pro admin notice + * + * @return void + */ public function pro_notice() { $screen = get_current_screen(); @@ -604,13 +747,18 @@ public function pro_notice() { '

%s %s

', __( 'Object Cache Pro is out!', 'redis-cache' ), sprintf( - // translators: %s = Link to the plugin setting screen + // translators: %s = Link to the plugin setting screen. __( 'A business class object cache backend. Truly reliable, highly-optimized and fully customizable, with a dedicated engineer when you most need it. Learn more »', 'redis-cache' ), network_admin_url( $this->page ) ) ); } + /** + * Displays a redis cache pro admin notice specifically for WooCommerce + * + * @return void + */ public function wc_pro_notice() { if ( ! class_exists( 'WooCommerce' ) ) { return; @@ -638,19 +786,29 @@ public function wc_pro_notice() { '

%s

%s

', __( 'Object Cache Pro + WooCommerce = ❤️', 'redis-cache' ), sprintf( - // translators: %s = Link to the plugin's settings screen + // translators: %s = Link to the plugin's settings screen. __( 'Object Cache Pro is a business class object cache that’s highly-optimized for WooCommerce to provide true reliability, peace of mind and faster load times for your store. Learn more »', 'redis-cache' ), network_admin_url( $this->page ) ) ); } + /** + * Registers all hooks associated with the shutdown hook + * + * @return void + */ public function register_shutdown_hooks() { if ( ! defined( 'WP_REDIS_DISABLE_COMMENT' ) || ! WP_REDIS_DISABLE_COMMENT ) { add_action( 'shutdown', array( $this, 'maybe_print_comment' ), 0 ); } } + /** + * Adds the recorded metrics to redis + * + * @return void + */ public function record_metrics() { global $wp_object_cache; @@ -689,6 +847,11 @@ public function record_metrics() { } } + /** + * Removes recorded metrics after an hour + * + * @return void + */ public function discard_metrics() { global $wp_object_cache; @@ -715,6 +878,11 @@ public function discard_metrics() { } } + /** + * Displays the redis cache html comment + * + * @return void + */ public function maybe_print_comment() { global $wp_object_cache; @@ -766,6 +934,13 @@ function_exists( 'size_format' ) ? size_format( $bytes ) : "{$bytes} bytes", printf( "\n", $message, $debug ); } + /** + * Initializes the WP filesystem API to be ready for use + * + * @param string $url The URL to post the form to. + * @param bool $silent Wheather to ask the user for credentials if necessary or not. + * @return bool + */ public function initialize_filesystem( $url, $silent = false ) { if ( $silent ) { ob_start(); @@ -792,8 +967,13 @@ public function initialize_filesystem( $url, $silent = false ) { return true; } + /** + * Test if we can write in the WP_CONTENT_DIR and modify the `object-cache.php` drop-in + * + * @return true|WP_Error + */ public function test_filesystem_writing() { - global $wp_filesystem; + global $wp_filesystem; if ( ! $this->initialize_filesystem( '', true ) ) { return new WP_Error( 'fs', __( 'Could not initialize filesystem.', 'redis-cache' ) ); @@ -833,6 +1013,11 @@ public function test_filesystem_writing() { return true; } + /** + * Calls the drop-in update method if necessary + * + * @return void + */ public function maybe_update_dropin() { if ( defined( 'WP_REDIS_DISABLE_DROPIN_AUTOUPDATE' ) && WP_REDIS_DISABLE_DROPIN_AUTOUPDATE ) { return; @@ -843,6 +1028,11 @@ public function maybe_update_dropin() { } } + /** + * Updates the `object-cache.php` drop-in + * + * @return void + */ public function update_dropin() { global $wp_filesystem; @@ -862,6 +1052,12 @@ public function update_dropin() { } } + /** + * Plugin deactivation hook + * + * @param string $plugin Plugin basename. + * @return void + */ public function on_deactivation( $plugin ) { global $wp_filesystem; @@ -882,6 +1078,12 @@ public function on_deactivation( $plugin ) { ob_end_clean(); } + /** + * Helper method to retrieve a nonced plugin action link + * + * @param string $action The action to be executed once the link is followed + * @return string + */ public function action_link( $action ) { return wp_nonce_url( network_admin_url( add_query_arg( 'action', $action, $this->page ) ), From ad7a2be36932fa67640803977c510fcc051ab892 Mon Sep 17 00:00:00 2001 From: naxvog Date: Sat, 15 Aug 2020 16:24:10 +0200 Subject: [PATCH 03/93] ignore phpcs error_log function sniff --- includes/class-plugin.php | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/includes/class-plugin.php b/includes/class-plugin.php index 073b1dfc..a361ba7a 100644 --- a/includes/class-plugin.php +++ b/includes/class-plugin.php @@ -345,7 +345,7 @@ public function enqueue_redis_metrics() { wp_localize_script( 'redis-cache', 'rediscache_metrics', $metrics ); } catch ( Exception $exception ) { - error_log( $exception ); + error_log( $exception ); // phpcs:ignore WordPress.PHP.DevelopmentFunctions.error_log_error_log } } @@ -843,7 +843,7 @@ public function record_metrics() { http_build_query( $metrics, null, ';' ) ); } catch ( Exception $exception ) { - error_log( $exception ); + error_log( $exception ); // phpcs:ignore WordPress.PHP.DevelopmentFunctions.error_log_error_log } } @@ -874,7 +874,7 @@ public function discard_metrics() { time() - HOUR_IN_SECONDS ); } catch ( Exception $exception ) { - error_log( $exception ); + error_log( $exception ); // phpcs:ignore WordPress.PHP.DevelopmentFunctions.error_log_error_log } } From c1c2ed596092d1ec1ea9cc014096b150016a5df7 Mon Sep 17 00:00:00 2001 From: naxvog Date: Sat, 15 Aug 2020 15:57:44 +0200 Subject: [PATCH 04/93] Added html comment output escaping --- includes/class-plugin.php | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/includes/class-plugin.php b/includes/class-plugin.php index a361ba7a..4a5df96a 100644 --- a/includes/class-plugin.php +++ b/includes/class-plugin.php @@ -916,7 +916,7 @@ public function maybe_print_comment() { ); if ( ! WP_DEBUG ) { - printf( "\n\n", $message ); + printf( "\n\n", esc_html( $message ) ); return; } @@ -931,7 +931,7 @@ function_exists( 'size_format' ) ? size_format( $bytes ) : "{$bytes} bytes", $wp_object_cache->diagnostics['client'] ); - printf( "\n", $message, $debug ); + printf( "\n", esc_html( $message ), esc_html( $debug ) ); } /** From a7c2928b0aaff425ae7f9d731b991b182ee67894 Mon Sep 17 00:00:00 2001 From: naxvog Date: Sat, 15 Aug 2020 16:09:58 +0200 Subject: [PATCH 05/93] yoda style conditions --- includes/class-plugin.php | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/includes/class-plugin.php b/includes/class-plugin.php index 4a5df96a..ca3850cd 100644 --- a/includes/class-plugin.php +++ b/includes/class-plugin.php @@ -599,7 +599,7 @@ public function do_admin_actions() { if ( in_array( $action, $this->actions ) ) { $url = $this->action_link( $action ); - if ( $action === 'flush-cache' ) { + if ( 'flush-cache' === $action ) { wp_cache_flush() ? add_settings_error( 'redis-cache', @@ -618,7 +618,7 @@ public function do_admin_actions() { // do we have filesystem credentials? if ( $this->initialize_filesystem( $url, true ) ) { - if ( $action === 'enable-cache' ) { + if ( 'enable-cache' === $action ) { $result = $wp_filesystem->copy( WP_REDIS_PLUGIN_PATH . '/includes/object-cache.php', WP_CONTENT_DIR . '/object-cache.php', @@ -643,7 +643,7 @@ public function do_admin_actions() { ); } - if ( $action === 'disable-cache' ) { + if ( 'disable-cache' === $action ) { $result = $wp_filesystem->delete( WP_CONTENT_DIR . '/object-cache.php' ); do_action( 'redis_object_cache_disable', $result ); @@ -663,7 +663,7 @@ public function do_admin_actions() { ); } - if ( $action === 'update-dropin' ) { + if ( 'update-dropin' === $action ) { $result = $wp_filesystem->copy( WP_REDIS_PLUGIN_PATH . '/includes/object-cache.php', WP_CONTENT_DIR . '/object-cache.php', @@ -1002,7 +1002,7 @@ public function test_filesystem_writing() { $meta = get_file_data( $testfile, [ 'Version' => 'Version' ] ); - if ( $meta['Version'] !== WP_REDIS_VERSION ) { + if ( WP_REDIS_VERSION !== $meta['Version'] ) { return new WP_Error( 'version', __( 'Couldn’t verify test file contents.', 'redis-cache' ) ); } @@ -1063,7 +1063,7 @@ public function on_deactivation( $plugin ) { ob_start(); - if ( $plugin === WP_REDIS_BASENAME ) { + if ( WP_REDIS_BASENAME === $plugin ) { if ( $timestamp = wp_next_scheduled( 'rediscache_discard_metrics' ) ) { wp_unschedule_event( $timestamp, 'rediscache_discard_metrics' ); } From 49038590c04669aacc330fdc74a451b333d74bb1 Mon Sep 17 00:00:00 2001 From: naxvog Date: Sat, 15 Aug 2020 17:47:35 +0200 Subject: [PATCH 06/93] Added additional output escaping for admin notices --- includes/class-plugin.php | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/includes/class-plugin.php b/includes/class-plugin.php index ca3850cd..8390ff41 100644 --- a/includes/class-plugin.php +++ b/includes/class-plugin.php @@ -573,7 +573,7 @@ public function show_admin_notices() { } if ( isset( $message ) ) { - printf( '
%s
', $message ); + printf( '
%s
', wp_kses_post( $message ) ); } } } @@ -745,11 +745,11 @@ public function pro_notice() { printf( '

%s %s

', - __( 'Object Cache Pro is out!', 'redis-cache' ), + esc_html__( 'Object Cache Pro is out!', 'redis-cache' ), sprintf( // translators: %s = Link to the plugin setting screen. - __( 'A business class object cache backend. Truly reliable, highly-optimized and fully customizable, with a dedicated engineer when you most need it. Learn more »', 'redis-cache' ), - network_admin_url( $this->page ) + wp_kses_post( __( 'A business class object cache backend. Truly reliable, highly-optimized and fully customizable, with a dedicated engineer when you most need it. Learn more »', 'redis-cache' ) ), + esc_url( network_admin_url( $this->page ) ) ) ); } @@ -784,11 +784,11 @@ public function wc_pro_notice() { printf( '

%s

%s

', - __( 'Object Cache Pro + WooCommerce = ❤️', 'redis-cache' ), + esc_html__( 'Object Cache Pro + WooCommerce = ❤️', 'redis-cache' ), sprintf( // translators: %s = Link to the plugin's settings screen. - __( 'Object Cache Pro is a business class object cache that’s highly-optimized for WooCommerce to provide true reliability, peace of mind and faster load times for your store. Learn more »', 'redis-cache' ), - network_admin_url( $this->page ) + wp_kses_post( __( 'Object Cache Pro is a business class object cache that’s highly-optimized for WooCommerce to provide true reliability, peace of mind and faster load times for your store. Learn more »', 'redis-cache' ) ), + esc_url( network_admin_url( $this->page ) ) ) ); } From 1a04958a358ed5049e811009847127d036c3a81c Mon Sep 17 00:00:00 2001 From: naxvog Date: Sat, 15 Aug 2020 17:50:15 +0200 Subject: [PATCH 07/93] strict comparisson for in_array --- includes/class-plugin.php | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/includes/class-plugin.php b/includes/class-plugin.php index 8390ff41..d7446932 100644 --- a/includes/class-plugin.php +++ b/includes/class-plugin.php @@ -243,7 +243,7 @@ public function enqueue_admin_styles() { 'dashboard-network', ); - if ( ! in_array( $screen->id, $screens ) ) { + if ( ! in_array( $screen->id, $screens, true ) ) { return; } @@ -271,7 +271,7 @@ public function enqueue_admin_scripts() { 'woocommerce_page_wc-admin', ); - if ( ! in_array( $screen->id, $screens ) ) { + if ( ! in_array( $screen->id, $screens, true ) ) { return; } @@ -320,7 +320,7 @@ public function enqueue_redis_metrics() { return; } - if ( ! in_array( $screen->id, array( $this->screen, 'dashboard', 'dashboard-network' ) ) ) { + if ( ! in_array( $screen->id, array( $this->screen, 'dashboard', 'dashboard-network' ), true ) ) { return; } @@ -596,7 +596,7 @@ public function do_admin_actions() { } } - if ( in_array( $action, $this->actions ) ) { + if ( in_array( $action, $this->actions, true ) ) { $url = $this->action_link( $action ); if ( 'flush-cache' === $action ) { @@ -731,7 +731,7 @@ public function pro_notice() { return; } - if ( ! in_array( $screen->id, array( 'dashboard', 'dashboard-network' ) ) ) { + if ( ! in_array( $screen->id, array( 'dashboard', 'dashboard-network' ), true ) ) { return; } @@ -770,7 +770,7 @@ public function wc_pro_notice() { return; } - if ( ! in_array( $screen->id, array( 'edit-shop_order', 'edit-product', 'woocommerce_page_wc-admin' ) ) ) { + if ( ! in_array( $screen->id, array( 'edit-shop_order', 'edit-product', 'woocommerce_page_wc-admin' ), true ) ) { return; } From a6d09bc0f5dfed1d3b389d1dbc1f76f5823afbe1 Mon Sep 17 00:00:00 2001 From: naxvog Date: Sat, 15 Aug 2020 18:09:25 +0200 Subject: [PATCH 08/93] avoided assignments in comparisons --- includes/class-plugin.php | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/includes/class-plugin.php b/includes/class-plugin.php index d7446932..975ecdca 100644 --- a/includes/class-plugin.php +++ b/includes/class-plugin.php @@ -946,7 +946,8 @@ public function initialize_filesystem( $url, $silent = false ) { ob_start(); } - if ( ( $credentials = request_filesystem_credentials( $url ) ) === false ) { + $credentials = request_filesystem_credentials( $url ); + if ( false === $credentials ) { if ( $silent ) { ob_end_clean(); } @@ -1064,7 +1065,8 @@ public function on_deactivation( $plugin ) { ob_start(); if ( WP_REDIS_BASENAME === $plugin ) { - if ( $timestamp = wp_next_scheduled( 'rediscache_discard_metrics' ) ) { + $timestamp = wp_next_scheduled( 'rediscache_discard_metrics' ); + if ( $timestamp ) { wp_unschedule_event( $timestamp, 'rediscache_discard_metrics' ); } From 3a4a741641c1aef7f6fec52755b43664f6a1ce99 Mon Sep 17 00:00:00 2001 From: naxvog Date: Sat, 15 Aug 2020 18:11:22 +0200 Subject: [PATCH 09/93] changed script loading position to footer --- includes/class-plugin.php | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/includes/class-plugin.php b/includes/class-plugin.php index 975ecdca..bfe23f71 100644 --- a/includes/class-plugin.php +++ b/includes/class-plugin.php @@ -279,7 +279,8 @@ public function enqueue_admin_scripts() { 'redis-cache', plugins_url( 'assets/js/admin.js', WP_REDIS_FILE ), array( 'jquery', 'underscore' ), - WP_REDIS_VERSION + WP_REDIS_VERSION, + true ); wp_localize_script( @@ -328,7 +329,8 @@ public function enqueue_redis_metrics() { 'redis-cache-charts', plugins_url( 'assets/js/apexcharts.min.js', WP_REDIS_FILE ), null, - WP_REDIS_VERSION + WP_REDIS_VERSION, + true ); if ( ! method_exists( $wp_object_cache, 'redis_instance' ) ) { From 6a16184322e7e2842a2bad956c43b953f2bcad1d Mon Sep 17 00:00:00 2001 From: naxvog Date: Sat, 15 Aug 2020 18:42:24 +0200 Subject: [PATCH 10/93] added additional sanitization and nonces --- assets/js/admin.js | 4 +++- includes/class-plugin.php | 34 ++++++++++++++++++++++------------ 2 files changed, 25 insertions(+), 13 deletions(-) diff --git a/assets/js/admin.js b/assets/js/admin.js index f7a7816b..760a36f6 100644 --- a/assets/js/admin.js +++ b/assets/js/admin.js @@ -449,9 +449,11 @@ function ( event ) { event.preventDefault(); + var $parent = $( this ).parent(); $.post( ajaxurl, { - notice: $( this ).parent().attr( 'data-dismissible' ), + notice: $parent.data( 'dismissible' ), action: 'roc_dismiss_notice', + _ajax_nonce: $parent.data( 'nonce' ), } ); } ); diff --git a/includes/class-plugin.php b/includes/class-plugin.php index bfe23f71..d633a784 100644 --- a/includes/class-plugin.php +++ b/includes/class-plugin.php @@ -147,11 +147,12 @@ public function add_admin_menu_page() { public function show_admin_page() { // Request filesystem credentials? if ( isset( $_GET['_wpnonce'], $_GET['action'] ) ) { - $action = $_GET['action']; + $action = sanitize_key( $_GET['action'] ); + $nonce = sanitize_key( $_GET['_wpnonce'] ); foreach ( $this->actions as $name ) { // Nonce verification. - if ( $action === $name && wp_verify_nonce( $_GET['_wpnonce'], $action ) ) { + if ( $action === $name && wp_verify_nonce( $nonce, $action ) ) { $url = $this->action_link( $action ); if ( $this->initialize_filesystem( $url ) === false ) { @@ -589,11 +590,12 @@ public function do_admin_actions() { global $wp_filesystem; if ( isset( $_GET['_wpnonce'], $_GET['action'] ) ) { - $action = $_GET['action']; + $action = sanitize_key( $_GET['action'] ); + $nonce = sanitize_key( $_GET['_wpnonce'] ); // Nonce verification. foreach ( $this->actions as $name ) { - if ( $action === $name && ! wp_verify_nonce( $_GET['_wpnonce'], $action ) ) { + if ( $action === $name && ! wp_verify_nonce( $nonce, $action ) ) { return; } } @@ -711,12 +713,15 @@ public function do_admin_actions() { * @return void */ public function dismiss_notice() { - $notice = sprintf( - 'roc_dismissed_%s', - sanitize_key( $_POST['notice'] ) - ); + if ( isset( $_POST['notice'] ) ) { + check_ajax_referer( 'roc_dismiss_notice' ); + $notice = sprintf( + 'roc_dismissed_%s', + sanitize_key( $_POST['notice'] ) + ); - update_user_meta( get_current_user_id(), $notice, '1' ); + update_user_meta( get_current_user_id(), $notice, '1' ); + } wp_die(); } @@ -746,7 +751,8 @@ public function pro_notice() { } printf( - '

%s %s

', + '

%s %s

', + esc_attr( wp_create_nonce( 'roc_dismiss_notice' ) ), esc_html__( 'Object Cache Pro is out!', 'redis-cache' ), sprintf( // translators: %s = Link to the plugin setting screen. @@ -785,7 +791,8 @@ public function wc_pro_notice() { } printf( - '

%s

%s

', + '

%s

%s

', + esc_attr( wp_create_nonce( 'roc_dismiss_notice' ) ), esc_html__( 'Object Cache Pro + WooCommerce = ❤️', 'redis-cache' ), sprintf( // translators: %s = Link to the plugin's settings screen. @@ -1085,10 +1092,13 @@ public function on_deactivation( $plugin ) { /** * Helper method to retrieve a nonced plugin action link * - * @param string $action The action to be executed once the link is followed + * @param string $action The action to be executed once the link is followed. * @return string */ public function action_link( $action ) { + if ( ! in_array( $action, $this->actions, true ) ) { + return ''; + } return wp_nonce_url( network_admin_url( add_query_arg( 'action', $action, $this->page ) ), $action From 36eef2c6ba073b049b55c16965f222a7b4b52c10 Mon Sep 17 00:00:00 2001 From: naxvog Date: Sat, 15 Aug 2020 18:38:17 +0200 Subject: [PATCH 11/93] switched to strict comparison --- includes/class-plugin.php | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/includes/class-plugin.php b/includes/class-plugin.php index d633a784..cdb6abda 100644 --- a/includes/class-plugin.php +++ b/includes/class-plugin.php @@ -746,7 +746,7 @@ public function pro_notice() { return; } - if ( get_user_meta( get_current_user_id(), 'roc_dismissed_pro_release_notice', true ) == '1' ) { + if ( 1 === intval( get_user_meta( get_current_user_id(), 'roc_dismissed_pro_release_notice', true ) ) ) { return; } @@ -786,7 +786,7 @@ public function wc_pro_notice() { return; } - if ( get_user_meta( get_current_user_id(), 'roc_dismissed_wc_pro_notice', true ) == '1' ) { + if ( 1 === intval( get_user_meta( get_current_user_id(), 'roc_dismissed_wc_pro_notice', true ) ) ) { return; } From ff517245a72d847342d7e8c914147b1932829df3 Mon Sep 17 00:00:00 2001 From: naxvog Date: Sat, 15 Aug 2020 18:39:07 +0200 Subject: [PATCH 12/93] ignored warning & added todo for `serialize` function --- includes/class-plugin.php | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/includes/class-plugin.php b/includes/class-plugin.php index cdb6abda..7a986715 100644 --- a/includes/class-plugin.php +++ b/includes/class-plugin.php @@ -930,7 +930,8 @@ public function maybe_print_comment() { return; } - $bytes = strlen( serialize( $wp_object_cache->cache ) ); + // TODO: find a better method to determine cache size as using `serialize` is discouraged. + $bytes = strlen( serialize( $wp_object_cache->cache ) ); // phpcs:ignore WordPress.PHP.DiscouragedPHPFunctions.serialize_serialize $debug = sprintf( // translators: %1$d = number of objects. %2$s = human-readable size of cache. %3$s = name of the used client. From c6eed5b95f9414e24919dadd014b1df9d6ca3bb7 Mon Sep 17 00:00:00 2001 From: naxvog Date: Sat, 15 Aug 2020 18:54:22 +0200 Subject: [PATCH 13/93] one function argument per line --- includes/class-ui.php | 17 ++++++++++------- 1 file changed, 10 insertions(+), 7 deletions(-) diff --git a/includes/class-ui.php b/includes/class-ui.php index 4d338807..79a50287 100644 --- a/includes/class-ui.php +++ b/includes/class-ui.php @@ -30,13 +30,16 @@ class UI { * @return void */ public static function register_tab( $slug, $label, $args = [] ) { - self::$tabs[ $slug ] = (object) wp_parse_args( $args, [ - 'label' => $label, - 'file' => WP_REDIS_PLUGIN_PATH . "/includes/ui/tabs/{$slug}.php", - 'slug' => $slug, - 'default' => false, - 'disabled' => false, - ] ); + self::$tabs[ $slug ] = (object) wp_parse_args( + $args, + [ + 'label' => $label, + 'file' => WP_REDIS_PLUGIN_PATH . "/includes/ui/tabs/{$slug}.php", + 'slug' => $slug, + 'default' => false, + 'disabled' => false, + ] + ); } /** From 75a72480197b0cffc8285818a4e9b377c53f0e16 Mon Sep 17 00:00:00 2001 From: naxvog Date: Sat, 15 Aug 2020 19:24:49 +0200 Subject: [PATCH 14/93] ui tab abstraction --- includes/class-ui.php | 11 +- includes/ui/class-tab.php | 219 +++++++++++++++++++++++++++++++ includes/ui/diagnostics.php | 14 +- includes/ui/settings.php | 30 ++--- includes/ui/tabs/diagnostics.php | 2 - includes/ui/tabs/overview.php | 42 +++--- 6 files changed, 263 insertions(+), 55 deletions(-) create mode 100644 includes/ui/class-tab.php diff --git a/includes/class-ui.php b/includes/class-ui.php index 79a50287..b251dcce 100644 --- a/includes/class-ui.php +++ b/includes/class-ui.php @@ -30,16 +30,7 @@ class UI { * @return void */ public static function register_tab( $slug, $label, $args = [] ) { - self::$tabs[ $slug ] = (object) wp_parse_args( - $args, - [ - 'label' => $label, - 'file' => WP_REDIS_PLUGIN_PATH . "/includes/ui/tabs/{$slug}.php", - 'slug' => $slug, - 'default' => false, - 'disabled' => false, - ] - ); + self::$tabs[ $slug ] = new UI\Tab( $slug, $label, $args ); } /** diff --git a/includes/ui/class-tab.php b/includes/ui/class-tab.php new file mode 100644 index 00000000..7759cd12 --- /dev/null +++ b/includes/ui/class-tab.php @@ -0,0 +1,219 @@ + $slug, + 'label' => $label, + 'file' => WP_REDIS_PLUGIN_PATH . "/includes/ui/tabs/{$slug}.php", + ] + ); + foreach ( $args ?: [] as $property => $value ) { + if ( property_exists( $this, $property ) ) { + $this->{$property} = $value; + } else { + $this->custom[ $property ] = $value; + } + } + } + + /** + * Getter for tab slug + * + * @return string + */ + public function slug() { + return $this->slug; + } + + /** + * Getter for tab label + * + * @return string + */ + public function label() { + return $this->label; + } + + /** + * Getter for tab file + * + * @return string + */ + public function file() { + return $this->file; + } + + /** + * Getter for tab disabled state + * + * @return bool + */ + public function is_disabled() { + return $this->disabled; + } + + /** + * Getter for tab default state + * + * @return bool + */ + public function is_default() { + return $this->default; + } + + /** + * Getter for tab custom data + * + * @param $string $key Custom data key. + * @return mixed + */ + public function custom( $key ) { + if ( ! isset( $this->custom[ $key ] ) ) { + return null; + } + return $this->custom[ $key ]; + } + + /** + * Disabled notice for tab + * + * @return string + */ + public function disabled_notice() { + return sprintf( + // translators: %s = Tab label. + __( '%s are disabled for this site.', 'redis-cache' ), + $this->label + ); + } + + /** + * Displays the tab template + * + * @return void + */ + public function display() { + $roc = Plugin::instance(); + include $this->file; + } + + /** + * Returns the tab nav id attribute + * + * @return string + */ + public function nav_id() { + return apply_filters( 'roc_tab_nav_id', "{$this->slug}-tab", $this ); + } + + /** + * Returns the tab nav css classes + * + * @return string + */ + public function nav_classes() { + $classes = [ + 'nav-tab', + ]; + if ( $this->default ) { + $classes[] = 'nav-tab-active'; + } + if ( $this->disabled ) { + $classes[] = 'nav-tab-disabled'; + } + return implode( ' ', apply_filters( 'roc_tab_nav_classes', $classes, $this ) ); + } + + /** + * Returns the tab id attribute + * + * @return string + */ + public function id() { + return apply_filters( 'roc_tab_id', "{$this->slug}-pane", $this ); + } + + /** + * Returns the tab css classes + * + * @return string + */ + public function classes() { + $classes = [ + 'tab-pane', + "tab-pane-{$this->slug}", + ]; + if ( $this->default ) { + $classes[] = 'active'; + } + return implode( ' ', apply_filters( 'roc_tab_classes', $classes, $this ) ); + } + +} diff --git a/includes/ui/diagnostics.php b/includes/ui/diagnostics.php index ce3cb1a0..f8720192 100644 --- a/includes/ui/diagnostics.php +++ b/includes/ui/diagnostics.php @@ -10,14 +10,14 @@ global $wp_object_cache; $info = []; -$filesystem = $plugin->test_filesystem_writing(); -$dropin = $plugin->validate_object_cache_dropin(); +$filesystem = $roc->test_filesystem_writing(); +$dropin = $roc->validate_object_cache_dropin(); $disabled = defined( 'WP_REDIS_DISABLED' ) && WP_REDIS_DISABLED; -$info['Status'] = $plugin->get_status(); -$info['Client'] = $plugin->get_redis_client_name(); -$info['Drop-in'] = $plugin->object_cache_dropin_exists() - ? ($dropin ? 'Valid' : 'Invalid') +$info['Status'] = $roc->get_status(); +$info['Client'] = $roc->get_redis_client_name(); +$info['Drop-in'] = $roc->object_cache_dropin_exists() + ? ( $dropin ? 'Valid' : 'Invalid' ) : 'Not installed'; $info['Disabled'] = $disabled ? 'Yes' : 'No'; $info['Filesystem'] = is_wp_error( $filesystem ) ? $filesystem->get_error_message() : 'Working'; @@ -52,7 +52,7 @@ } $info['Plugin Version'] = WP_REDIS_VERSION; -$info['Redis Version'] = $plugin->get_redis_version() ?: 'Unknown'; +$info['Redis Version'] = $roc->get_redis_version() ?: 'Unknown'; $info['Multisite'] = is_multisite() ? 'Yes' : 'No'; diff --git a/includes/ui/settings.php b/includes/ui/settings.php index 2632a36d..9ba99cd7 100644 --- a/includes/ui/settings.php +++ b/includes/ui/settings.php @@ -26,28 +26,24 @@

- disabled ) : ?> + is_disabled() ) : ?> - label ); ?> + label() ); ?> - label ); ?> + label() ); ?> @@ -56,11 +52,11 @@ class="nav-tab default ? 'nav-tab-active' : ''; ?>"
- disabled ) : ?> -
is_disabled() ) : ?> +
- file; ?> + display(); ?>
diff --git a/includes/ui/tabs/diagnostics.php b/includes/ui/tabs/diagnostics.php index 4509e0c3..4a4e9a91 100644 --- a/includes/ui/tabs/diagnostics.php +++ b/includes/ui/tabs/diagnostics.php @@ -7,8 +7,6 @@ defined( '\\ABSPATH' ) || exit; -$plugin = $this; - ?>

diff --git a/includes/ui/tabs/overview.php b/includes/ui/tabs/overview.php index 6f1bf029..9c15348b 100644 --- a/includes/ui/tabs/overview.php +++ b/includes/ui/tabs/overview.php @@ -7,14 +7,12 @@ defined( '\\ABSPATH' ) || exit; -$plugin = redis_object_cache(); +$redis_client = $roc->get_redis_client_name(); +$redis_prefix = $roc->get_redis_prefix(); +$redis_maxttl = $roc->get_redis_maxttl(); +$redis_version = $roc->get_redis_version(); -$redis_client = $plugin->get_redis_client_name(); -$redis_prefix = $plugin->get_redis_prefix(); -$redis_maxttl = $plugin->get_redis_maxttl(); -$redis_version = $plugin->get_redis_version(); - -$diagnostics = $plugin->get_diagnostics(); +$diagnostics = $roc->get_diagnostics(); ?> @@ -37,14 +35,15 @@ - object_cache_dropin_exists() ) : ?> + object_cache_dropin_exists() ) : ?> - object_cache_dropin_outdated() ) : ?> + object_cache_dropin_outdated() ) : ?> - validate_object_cache_dropin() - ? esc_html_e( 'Valid', 'redis-cache' ) - : esc_html_e( 'Invalid', 'redis-cache' ); + validate_object_cache_dropin() + ? esc_html_e( 'Valid', 'redis-cache' ) + : esc_html_e( 'Invalid', 'redis-cache' ); ?> @@ -94,7 +93,7 @@ - get_status() ); ?> + get_status() ); ?> @@ -161,7 +160,12 @@ - + + + @@ -235,18 +239,18 @@

- get_redis_status() ) : ?> - + get_redis_status() ) : ?> +   - validate_object_cache_dropin() ) : ?> - + validate_object_cache_dropin() ) : ?> + - + From 26122227c3352bc6fb2e6176251e59b42cc5bdd7 Mon Sep 17 00:00:00 2001 From: naxvog Date: Sat, 15 Aug 2020 21:34:51 +0200 Subject: [PATCH 15/93] diagnostics output escaping --- includes/ui/diagnostics.php | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/includes/ui/diagnostics.php b/includes/ui/diagnostics.php index f8720192..b71d9c1d 100644 --- a/includes/ui/diagnostics.php +++ b/includes/ui/diagnostics.php @@ -140,6 +140,6 @@ if ( defined( 'WP_CLI' ) && WP_CLI ) { WP_CLI::line( "{$name}: $value" ); } else { - echo "{$name}: {$value}\r\n"; + echo esc_html( "{$name}: {$value}\r\n" ); } } From e3dbe9f5aef73fff79352b851d4256c70947f1e3 Mon Sep 17 00:00:00 2001 From: naxvog Date: Sat, 15 Aug 2020 21:59:46 +0200 Subject: [PATCH 16/93] added documentation for QM classes --- includes/class-qm-collector.php | 35 +++++++++++++++++++++++++++------ includes/class-qm-output.php | 28 ++++++++++++++++++++++++++ 2 files changed, 57 insertions(+), 6 deletions(-) diff --git a/includes/class-qm-collector.php b/includes/class-qm-collector.php index 1cda3af4..32829a77 100644 --- a/includes/class-qm-collector.php +++ b/includes/class-qm-collector.php @@ -11,24 +11,42 @@ defined( '\\ABSPATH' ) || exit; +/** + * Query Monitor data collector class definition + */ class QM_Collector extends Base_Collector { + /** + * Collector id + * + * @var string $id + */ public $id = 'cache'; + /** + * Retrieves the collector name + * + * @return string + */ public function name() { return __( 'Object Cache', 'redis-cache' ); } + /** + * Fills the collector with data + * + * @return void + */ public function process() { - global $wp_object_cache; + global $wp_object_cache; $this->process_defaults(); - $plugin = Plugin::instance(); + $roc = Plugin::instance(); - $this->data['status'] = $plugin->get_status(); - $this->data['has_dropin'] = $plugin->object_cache_dropin_exists(); - $this->data['valid_dropin'] = $plugin->validate_object_cache_dropin(); + $this->data['status'] = $roc->get_status(); + $this->data['has_dropin'] = $roc->object_cache_dropin_exists(); + $this->data['valid_dropin'] = $roc->validate_object_cache_dropin(); if ( ! method_exists( $wp_object_cache, 'info' ) ) { return; @@ -54,12 +72,17 @@ public function process() { 'unflushable' => $info->groups->unflushable, ]; - // these are used by Query Monitor + // These are used by Query Monitor. $this->data['stats']['cache_hits'] = $info->hits; $this->data['stats']['cache_misses'] = $info->misses; $this->data['cache_hit_percentage'] = $info->ratio; } + /** + * Sets collector defaults + * + * @return void + */ public function process_defaults() { $this->data['hits'] = 0; $this->data['misses'] = 0; diff --git a/includes/class-qm-output.php b/includes/class-qm-output.php index 17978479..6c28d922 100644 --- a/includes/class-qm-output.php +++ b/includes/class-qm-output.php @@ -11,8 +11,16 @@ defined( '\\ABSPATH' ) || exit; +/** + * Query Monitor output logic class definition + */ class QM_Output extends QM_Output_Html { + /** + * Contructor + * + * @param QM_Collector $collector The corresponding collector instance. + */ public function __construct( QM_Collector $collector ) { parent::__construct( $collector ); @@ -20,10 +28,20 @@ public function __construct( QM_Collector $collector ) { add_filter( 'qm/output/panel_menus', [ $this, 'panel_menu' ] ); } + /** + * Output class name + * + * @return string + */ public function name() { return __( 'Object Cache', 'redis cache' ); } + /** + * Adds a menu to the panel navigation menu in Query Monitor's output + * + * @param array $menu Array of menus. + */ public function admin_menu( array $menu ) { $data = $this->collector->get_data(); @@ -48,6 +66,11 @@ public function admin_menu( array $menu ) { return $menu; } + /** + * Adds a menu item in the panel navigation menu in Query Monitor's output. + * + * @param array $menu Array of menus. + */ public function panel_menu( array $menu ) { $ids = array_keys( $menu ); $request = array_search( 'qm-request', $ids, true ); @@ -64,6 +87,11 @@ public function panel_menu( array $menu ) { ); } + /** + * Renders the output + * + * @return void + */ public function output() { $data = $this->collector->get_data(); From 9caaefd0fad53db7444818443ff3c93b8829b633 Mon Sep 17 00:00:00 2001 From: naxvog Date: Sat, 15 Aug 2020 22:00:29 +0200 Subject: [PATCH 17/93] added output escaping + ignore statements --- includes/class-qm-output.php | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/includes/class-qm-output.php b/includes/class-qm-output.php index 6c28d922..f44534b5 100644 --- a/includes/class-qm-output.php +++ b/includes/class-qm-output.php @@ -97,7 +97,10 @@ public function output() { if ( ! $data['has_dropin'] ) { $this->before_non_tabular_output(); - echo $this->build_notice( __( 'The Redis Object Cache drop-in is not installed. Use WP CLI or go to "Settings -> Redis" to enable drop-in.', 'redis-cache' ) ); + // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped + echo $this->build_notice( + esc_html__( 'The Redis Object Cache drop-in is not installed. Use WP CLI or go to "Settings -> Redis" to enable drop-in.', 'redis-cache' ) + ); $this->after_non_tabular_output(); return; @@ -105,7 +108,10 @@ public function output() { if ( ! $data['valid_dropin'] ) { $this->before_non_tabular_output(); - echo $this->build_notice( __( 'WordPress is using a foreign object cache drop-in and Redis Object Cache is not being used. Use WP CLI or go to "Settings -> Redis" to enable drop-in.', 'redis-cache' ) ); + // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped + echo $this->build_notice( + esc_html__( 'WordPress is using a foreign object cache drop-in and Redis Object Cache is not being used. Use WP CLI or go to "Settings -> Redis" to enable drop-in.', 'redis-cache' ) + ); $this->after_non_tabular_output(); return; From dc707f9991a54f25d90df613c0f1ec0fe30c64bc Mon Sep 17 00:00:00 2001 From: naxvog Date: Sat, 15 Aug 2020 22:08:04 +0200 Subject: [PATCH 18/93] ignore file naming convention due to class definition in drop-in --- includes/object-cache.php | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/includes/object-cache.php b/includes/object-cache.php index b47bc984..7a2090f2 100644 --- a/includes/object-cache.php +++ b/includes/object-cache.php @@ -1,4 +1,4 @@ - Date: Sat, 15 Aug 2020 22:09:55 +0200 Subject: [PATCH 19/93] fixed indentation issue --- includes/object-cache.php | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/includes/object-cache.php b/includes/object-cache.php index 7a2090f2..ff0bfdfe 100644 --- a/includes/object-cache.php +++ b/includes/object-cache.php @@ -14,7 +14,9 @@ defined( '\\ABSPATH' ) || exit; -if ( ! defined( 'WP_REDIS_DISABLED' ) || ! WP_REDIS_DISABLED ) : +if ( ! defined( 'WP_REDIS_DISABLED' ) || ! WP_REDIS_DISABLED ) { + return; +} /** * Adds a value to cache. @@ -1999,5 +2001,3 @@ public function __get( $name ) { return isset($this->{$name}) ? $this->{$name} : null; } } - -endif; From aa2c843d033fefa0412f8971a44a97242fe68bc6 Mon Sep 17 00:00:00 2001 From: naxvog Date: Sat, 15 Aug 2020 22:42:27 +0200 Subject: [PATCH 20/93] fixed precision alignment issues --- includes/object-cache.php | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/includes/object-cache.php b/includes/object-cache.php index ff0bfdfe..480852f2 100644 --- a/includes/object-cache.php +++ b/includes/object-cache.php @@ -48,7 +48,7 @@ function wp_cache_add( $key, $value, $group = '', $expiration = 0 ) { * @return bool Always returns True */ function wp_cache_close() { - return true; + return true; } /** @@ -865,7 +865,7 @@ public function fetch_info() { * @return bool */ public function redis_status() { - return (bool) $this->redis_connected; + return (bool) $this->redis_connected; } /** @@ -874,7 +874,7 @@ public function redis_status() { * @return mixed */ public function redis_instance() { - return $this->redis; + return $this->redis; } /** @@ -883,7 +883,7 @@ public function redis_instance() { * @return null|string */ public function redis_version() { - return $this->redis_version; + return $this->redis_version; } /** @@ -1671,7 +1671,7 @@ public function build_key( $key, $group = 'default' ) { * @return string Sanitized string. */ protected function sanitize_key_part( $part ) { - return str_replace( ':', '-', $part ); + return str_replace( ':', '-', $part ); } /** From a8b3c75372824f95f0982523e4e70da56fe02130 Mon Sep 17 00:00:00 2001 From: naxvog Date: Sat, 15 Aug 2020 23:02:12 +0200 Subject: [PATCH 21/93] Added and improved documentation --- includes/object-cache.php | 98 +++++++++++++++++++++++---------------- 1 file changed, 57 insertions(+), 41 deletions(-) diff --git a/includes/object-cache.php b/includes/object-cache.php index 480852f2..dcd2f2f4 100644 --- a/includes/object-cache.php +++ b/includes/object-cache.php @@ -104,7 +104,7 @@ function wp_cache_flush( $delay = 0 ) { * @param string $group The group value appended to the $key. * @param bool $force Optional. Whether to force an update of the local cache from the persistent * cache. Default false. - * @param bool &$found Optional. Whether the key was found in the cache. Disambiguates a return of false, + * @param bool $found Optional. Whether the key was found in the cache. Disambiguates a return of false, * a storable value. Passed by reference. Default null. * * @return bool|mixed Cached object value. @@ -153,7 +153,7 @@ function wp_cache_incr( $key, $offset = 1, $group = '' ) { function wp_cache_init() { global $wp_object_cache; - // backwards compatibility: map `WP_CACHE_KEY_SALT` constant to `WP_REDIS_PREFIX` + // Backwards compatibility: map `WP_CACHE_KEY_SALT` constant to `WP_REDIS_PREFIX`. if ( defined( 'WP_CACHE_KEY_SALT' ) && ! defined( 'WP_REDIS_PREFIX' ) ) { define( 'WP_REDIS_PREFIX', WP_CACHE_KEY_SALT ); } @@ -207,7 +207,7 @@ function wp_cache_set( $key, $value, $group = '', $expiration = 0 ) { * * This changes the blog id used to create keys in blog specific groups. * - * @param int $_blog_id Blog ID + * @param int $_blog_id The blog ID. * * @return bool */ @@ -243,6 +243,9 @@ function wp_cache_add_non_persistent_groups( $groups ) { $wp_object_cache->add_non_persistent_groups( $groups ); } +/** + * Object cache class definition + */ class WP_Object_Cache { /** @@ -382,7 +385,7 @@ class WP_Object_Cache { /** * Instantiate the Redis class. * - * @param bool $fail_gracefully + * @param bool $fail_gracefully Handles and logs errors if true throws exceptions otherwise. */ public function __construct( $fail_gracefully = true ) { global $blog_id, $table_prefix; @@ -434,7 +437,7 @@ public function __construct( $fail_gracefully = true ) { $this->handle_exception( $exception ); } - // Assign global and blog prefixes for use with keys + // Assign global and blog prefixes for use with keys. if ( function_exists( 'is_multisite' ) ) { $this->global_prefix = is_multisite() ? '' : $table_prefix; $this->blog_prefix = is_multisite() ? $blog_id : $table_prefix; @@ -511,7 +514,7 @@ protected function build_parameters() { /** * Connect to Redis using the PhpRedis (PECL) extention. * - * @param array $parameters + * @param array $parameters Connection parameters built by the `build_parameters` method. * @return void */ protected function connectUsingPhpRedis( $parameters ) { @@ -595,7 +598,8 @@ protected function connectUsingPhpRedis( $parameters ) { /** * Connect to Redis using the Predis library. * - * @param array $parameters + * @param array $parameters Connection parameters built by the `build_parameters` method. + * @throws \Exception If the Predis library was not found or is unreadable. * @return void */ protected function connectUsingPredis( $parameters ) { @@ -606,7 +610,7 @@ protected function connectUsingPredis( $parameters ) { throw new Exception( 'Predis requires PHP 5.4 or newer.' ); } - // Load bundled Predis library + // Load bundled Predis library. if ( ! class_exists( 'Predis\Client' ) ) { $predis = sprintf( '%s/redis-cache/dependencies/predis/predis/autoload.php', @@ -668,7 +672,10 @@ protected function connectUsingPredis( $parameters ) { /** * Connect to Redis using the Credis library. * - * @param array $parameters + * @param array $parameters Connection parameters built by the `build_parameters` method. + * @throws \Exception If the Credis library was not found or is unreadable. + * @throws \Exception If redis sharding should be configured as Credis does not support sharding. + * @throws \Exception If more than one seninel is configured as Credis does not support multiple sentinel servers. * @return void */ protected function connectUsingCredis( $parameters ) { @@ -769,7 +776,7 @@ protected function connectUsingCredis( $parameters ) { $this->redis = new Credis_Client( ...array_values( $args ) ); } - // Don't use PhpRedis + // Don't use PhpRedis if it is available. $this->redis->forceStandalone(); $this->redis->connect(); @@ -788,13 +795,13 @@ protected function connectUsingCredis( $parameters ) { /** * Connect to Redis using HHVM's Redis extention. * - * @param array $parameters + * @param array $parameters Connection parameters built by the `build_parameters` method. * @return void */ protected function connectUsingHHVM( $parameters ) { $this->redis = new Redis(); - // Adjust host and port, if the scheme is `unix` + // Adjust host and port if the scheme is `unix`. if ( strcasecmp( 'unix', $parameters['scheme'] ) === 0 ) { $parameters['host'] = 'unix://' . $parameters['path']; $parameters['port'] = 0; @@ -923,7 +930,7 @@ public function replace( $key, $value, $group = 'default', $expiration = 0 ) { * * Add does not set the value if the key exists; replace does not replace if the value doesn't exist. * - * @param bool $add True if should only add if value doesn't exist, false to only add when value already exists + * @param bool $add True if should only add if value doesn't exist, false to only add when value already exists. * @param string $key The key under which to store the value. * @param mixed $value The value to store. * @param string $group The group value appended to the $key. @@ -942,7 +949,7 @@ protected function add_or_replace( $add, $key, $value, $group = 'default', $expi $result = true; $derived_key = $this->build_key( $key, $group ); - // save if group not excluded and redis is up + // Save if group not excluded and redis is up. if ( ! $this->is_ignored_group( $group ) && $this->redis_status() ) { try { $expiration = apply_filters( 'redis_cache_expiration', $this->validate_expiration( $expiration ), $key, $group ); @@ -1150,6 +1157,12 @@ protected function get_flush_closure( $salt ) { } } + /** + * Quotes a string for usage in the `glob` function + * + * @param string $string The string to quote. + * @return string + */ protected function glob_quote( $string ) { $characters = [ '*', '+', '?', '!', '{', '}', '[', ']', '(', ')', '|', '@' ]; @@ -1267,7 +1280,7 @@ function ( $group ) { * @param string $group The group value appended to the $key. * @param string $force Optional. Whether to force a refetch rather than relying on the local * cache. Default false. - * @param bool &$found Optional. Whether the key was found in the cache. Disambiguates a return of + * @param bool $found Optional. Whether the key was found in the cache. Disambiguates a return of * false, a storable value. Passed by reference. Default null. * @return bool|mixed Cached object value. */ @@ -1444,7 +1457,7 @@ public function set( $key, $value, $group = 'default', $expiration = 0 ) { $start_time = microtime( true ); - // save if group not excluded from redis and redis is up + // Save if group not excluded from redis and redis is up. if ( ! $this->is_ignored_group( $group ) && $this->redis_status() ) { $expiration = apply_filters( 'redis_cache_expiration', $this->validate_expiration( $expiration ), $key, $group ); @@ -1464,7 +1477,7 @@ public function set( $key, $value, $group = 'default', $expiration = 0 ) { $this->cache_time += ( microtime( true ) - $start_time ); } - // if the set was successful, or we didn't go to redis + // If the set was successful, or we didn't go to redis. if ( $result ) { $this->add_to_internal_cache( $derived_key, $value ); } @@ -1481,16 +1494,16 @@ public function set( $key, $value, $group = 'default', $expiration = 0 ) { /** * Increment a Redis counter by the amount specified * - * @param string $key - * @param int $offset - * @param string $group + * @param string $key The key name. + * @param int $offset Optional. The increment. Defaults to 1. + * @param string $group Optional. The key group. Default is 'default'. * @return int|bool */ public function increment( $key, $offset = 1, $group = 'default' ) { $offset = (int) $offset; $derived_key = $this->build_key( $key, $group ); - // If group is a non-Redis group, save to internal cache, not Redis + // If group is a non-Redis group, save to internal cache, not Redis. if ( $this->is_ignored_group( $group ) || ! $this->redis_status() ) { $value = $this->get_from_internal_cache( $derived_key ); $value += $offset; @@ -1522,10 +1535,11 @@ public function increment( $key, $offset = 1, $group = 'default' ) { /** * Alias of `increment()`. * - * @param string $key - * @param int $offset - * @param string $group - * @return bool + * @see self::increment() + * @param string $key The key name. + * @param int $offset Optional. The increment. Defaults to 1. + * @param string $group Optional. The key group. Default is 'default'. + * @return int|bool */ public function incr( $key, $offset = 1, $group = 'default' ) { return $this->increment( $key, $offset, $group ); @@ -1534,16 +1548,16 @@ public function incr( $key, $offset = 1, $group = 'default' ) { /** * Decrement a Redis counter by the amount specified * - * @param string $key - * @param int $offset - * @param string $group + * @param string $key The key name. + * @param int $offset Optional. The decrement. Defaults to 1. + * @param string $group Optional. The key group. Default is 'default'. * @return int|bool */ public function decrement( $key, $offset = 1, $group = 'default' ) { $derived_key = $this->build_key( $key, $group ); $offset = (int) $offset; - // If group is a non-Redis group, save to internal cache, not Redis + // If group is a non-Redis group, save to internal cache, not Redis. if ( $this->is_ignored_group( $group ) || ! $this->redis_status() ) { $value = $this->get_from_internal_cache( $derived_key ); $value -= $offset; @@ -1555,7 +1569,7 @@ public function decrement( $key, $offset = 1, $group = 'default' ) { $start_time = microtime( true ); try { - // Save to Redis + // Save to Redis. $result = $this->parse_redis_response( $this->redis->decrBy( $derived_key, $offset ) ); $this->add_to_internal_cache( $derived_key, (int) $this->redis->get( $derived_key ) ); @@ -1677,7 +1691,7 @@ protected function sanitize_key_part( $part ) { /** * Checks if the given group is part the ignored group array * - * @param string $group Name of the group to check + * @param string $group Name of the group to check. * @return bool */ protected function is_ignored_group( $group ) { @@ -1687,7 +1701,7 @@ protected function is_ignored_group( $group ) { /** * Checks if the given group is part the global group array * - * @param string $group Name of the group to check + * @param string $group Name of the group to check. * @return bool */ protected function is_global_group( $group ) { @@ -1697,7 +1711,7 @@ protected function is_global_group( $group ) { /** * Checks if the given group is part the unflushable group array * - * @param string $group Name of the group to check + * @param string $group Name of the group to check. * @return bool */ protected function is_unflushable_group( $group ) { @@ -1707,7 +1721,7 @@ protected function is_unflushable_group( $group ) { /** * Convert Redis responses into something meaningful * - * @param mixed $response + * @param mixed $response Response sent from the redis instance. * @return mixed */ protected function parse_redis_response( $response ) { @@ -1762,7 +1776,7 @@ public function get_from_internal_cache( $derived_key ) { /** * In multisite, switch blog prefix when switching blogs * - * @param int $_blog_id + * @param int $_blog_id Blog ID. * @return bool */ public function switch_to_blog( $_blog_id ) { @@ -1815,7 +1829,7 @@ public function add_unflushable_groups( $groups ) { /** * Wrapper to validate the cache keys expiration value * - * @param mixed $expiration Incoming expiration value (whatever it is) + * @param mixed $expiration Incoming expiration value (whatever it is). */ protected function validate_expiration( $expiration ) { $expiration = is_int( $expiration ) || ctype_digit( $expiration ) ? (int) $expiration : 0; @@ -1846,7 +1860,7 @@ protected function maybe_unserialize( $original ) { return igbinary_unserialize( $original ); } - // don't attempt to unserialize data that wasn't serialized going in + // Don't attempt to unserialize data that wasn't serialized going in. if ( $this->is_serialized( $original ) ) { $value = @unserialize( $original ); @@ -1951,8 +1965,8 @@ protected function is_serialized( $data, $strict = true ) { } elseif ( false === strpos( $data, '"' ) ) { return false; } - // or else fall through - // no break + // Or else fall through. + // No break! case 'a': case 'O': return (bool) preg_match( "/^{$token}:[0-9]+:/s", $data ); @@ -1971,11 +1985,13 @@ protected function is_serialized( $data, $strict = true ) { * Handle the redis failure gracefully or throw an exception. * * @param \Exception $exception Exception thrown. + * @throws \Exception If `fail_gracefully` flag is set to a falsy value. + * @return void */ protected function handle_exception( $exception ) { $this->redis_connected = false; - // When Redis is unavailable, fall back to the internal cache by forcing all groups to be "no redis" groups + // When Redis is unavailable, fall back to the internal cache by forcing all groups to be "no redis" groups. $this->ignored_groups = array_unique( array_merge( $this->ignored_groups, $this->global_groups ) ); if ( ! $this->fail_gracefully ) { @@ -1994,7 +2010,7 @@ protected function handle_exception( $exception ) { /** * Allows access to private properties for backwards compatibility. * - * @param string $name + * @param string $name Name of the property. * @return mixed */ public function __get( $name ) { From 9ea70de35eea89c4969d9b6e64ad5acade981948 Mon Sep 17 00:00:00 2001 From: naxvog Date: Sat, 15 Aug 2020 22:47:06 +0200 Subject: [PATCH 22/93] phpcs ignores --- includes/object-cache.php | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/includes/object-cache.php b/includes/object-cache.php index dcd2f2f4..c77ac719 100644 --- a/includes/object-cache.php +++ b/includes/object-cache.php @@ -161,6 +161,8 @@ function wp_cache_init() { if ( ! ( $wp_object_cache instanceof WP_Object_Cache ) ) { $fail_gracefully = ! defined( 'WP_REDIS_GRACEFUL' ) || WP_REDIS_GRACEFUL; + // We need to override this WordPress global in order to inject our cache. + // phpcs:ignore WordPress.WP.GlobalVariablesOverride.Prohibited $wp_object_cache = new WP_Object_Cache( $fail_gracefully ); } } @@ -1595,6 +1597,7 @@ public function decrement( $key, $offset = 1, $group = 'default' ) { public function stats() { $bytes = array_map( function ( $key ) { + // phpcs:ignore WordPress.PHP.DiscouragedPHPFunctions.serialize_serialize return strlen( serialize( $key ) ); }, $this->cache @@ -1629,6 +1632,7 @@ public function info() { $bytes = array_map( function ( $keys ) { + // phpcs:ignore WordPress.PHP.DiscouragedPHPFunctions.serialize_serialize return strlen( serialize( $keys ) ); }, $this->cache @@ -1862,6 +1866,7 @@ protected function maybe_unserialize( $original ) { // Don't attempt to unserialize data that wasn't serialized going in. if ( $this->is_serialized( $original ) ) { + // phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged, WordPress.PHP.DiscouragedPHPFunctions.serialize_unserialize $value = @unserialize( $original ); return is_object( $value ) ? clone $value : $value; @@ -1890,10 +1895,12 @@ protected function maybe_serialize( $data ) { } if ( is_array( $data ) || is_object( $data ) ) { + // phpcs:ignore WordPress.PHP.DiscouragedPHPFunctions.serialize_serialize return serialize( $data ); } if ( $this->is_serialized( $data, false ) ) { + // phpcs:ignore WordPress.PHP.DiscouragedPHPFunctions.serialize_serialize return serialize( $data ); } @@ -2000,7 +2007,7 @@ protected function handle_exception( $exception ) { $this->errors[] = $exception->getMessage(); - error_log( $exception ); + error_log( $exception ); // phpcs:ignore WordPress.PHP.DevelopmentFunctions.error_log_error_log if ( function_exists( 'do_action' ) ) { do_action( 'redis_object_cache_error', $exception ); From 8877d738c7ecc08bf71290cf7f7ff4ac5f41fd72 Mon Sep 17 00:00:00 2001 From: naxvog Date: Sat, 15 Aug 2020 22:48:22 +0200 Subject: [PATCH 23/93] method name fixes --- includes/object-cache.php | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/includes/object-cache.php b/includes/object-cache.php index c77ac719..28ee5af1 100644 --- a/includes/object-cache.php +++ b/includes/object-cache.php @@ -412,17 +412,17 @@ public function __construct( $fail_gracefully = true ) { try { switch ( $client ) { case 'hhvm': - $this->connectUsingHHVM( $parameters ); + $this->connect_using_hhvm( $parameters ); break; case 'phpredis': - $this->connectUsingPhpRedis( $parameters ); + $this->connect_using_phpredis( $parameters ); break; case 'credis': - $this->connectUsingCredis( $parameters ); + $this->connect_using_credis( $parameters ); break; case 'predis': default: - $this->connectUsingPredis( $parameters ); + $this->connect_using_predis( $parameters ); break; } @@ -519,7 +519,7 @@ protected function build_parameters() { * @param array $parameters Connection parameters built by the `build_parameters` method. * @return void */ - protected function connectUsingPhpRedis( $parameters ) { + protected function connect_using_phpredis( $parameters ) { $version = phpversion( 'redis' ); $this->diagnostics[ 'client' ] = sprintf( 'PhpRedis (v%s)', $version ); @@ -604,7 +604,7 @@ protected function connectUsingPhpRedis( $parameters ) { * @throws \Exception If the Predis library was not found or is unreadable. * @return void */ - protected function connectUsingPredis( $parameters ) { + protected function connect_using_predis( $parameters ) { $client = 'Predis'; // Require PHP 5.4 or greater @@ -680,7 +680,7 @@ protected function connectUsingPredis( $parameters ) { * @throws \Exception If more than one seninel is configured as Credis does not support multiple sentinel servers. * @return void */ - protected function connectUsingCredis( $parameters ) { + protected function connect_using_credis( $parameters ) { $client = 'Credis'; // Require PHP 5.4 or greater @@ -800,7 +800,7 @@ protected function connectUsingCredis( $parameters ) { * @param array $parameters Connection parameters built by the `build_parameters` method. * @return void */ - protected function connectUsingHHVM( $parameters ) { + protected function connect_using_hhvm( $parameters ) { $this->redis = new Redis(); // Adjust host and port if the scheme is `unix`. From b079844cd9863e3891cb80bebd5d117419b3f5d3 Mon Sep 17 00:00:00 2001 From: naxvog Date: Sat, 15 Aug 2020 22:49:02 +0200 Subject: [PATCH 24/93] yoda style conditions --- includes/object-cache.php | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/includes/object-cache.php b/includes/object-cache.php index 28ee5af1..3db22ca4 100644 --- a/includes/object-cache.php +++ b/includes/object-cache.php @@ -505,7 +505,7 @@ protected function build_parameters() { if ( isset( $parameters['password'] ) ) { $password = $parameters['password']; - if ( is_null( $password ) || $password === '' ) { + if ( is_null( $password ) || '' === $password ) { unset( $parameters['password'] ); } } @@ -767,7 +767,7 @@ protected function connect_using_credis( $parameters ) { $args['servers'] = $clients; } else { $args = [ - 'host' => $parameters['scheme'] === 'unix' ? $parameters['path'] : $parameters['host'], + 'host' => 'unix' === $parameters['scheme'] ? $parameters['path'] : $parameters['host'], 'port' => $parameters['port'], 'timeout' => $parameters['timeout'], 'persistent' => null, @@ -1316,7 +1316,7 @@ public function get( $key, $group = 'default', $force = false, &$found = null ) $this->cache_calls++; $this->cache_time += $execute_time; - if ( $result === null || $result === false ) { + if ( null === $result || false === $result ) { $found = false; $this->cache_misses++; @@ -1366,7 +1366,7 @@ public function get_multiple( $keys, $group = 'default', $force = false ) { if ( $this->is_ignored_group( $group ) || ! $this->redis_status() ) { foreach ( $keys as $key ) { $cache[ $key ] = $this->get_from_internal_cache( $derived_keys[ $key ] ); - $cache[ $key ] === false ? $this->cache_misses++ : $this->cache_hits++; + false === $cache[ $key ] ? $this->cache_misses++ : $this->cache_hits++; } return $cache; @@ -1376,7 +1376,7 @@ public function get_multiple( $keys, $group = 'default', $force = false ) { foreach ( $keys as $key ) { $value = $this->get_from_internal_cache( $derived_keys[ $key ] ); - if ( $value === false ) { + if ( false === $value ) { $this->cache_misses++; } else { $cache[ $key ] = $value; @@ -1416,7 +1416,7 @@ public function get_multiple( $keys, $group = 'default', $force = false ) { $this->cache_time += $execute_time; foreach ( $results as $key => $value ) { - if ( $value === null || $value === false ) { + if ( null === $value || false === $value ) { $cache[ $key ] = false; $this->cache_misses++; } else { @@ -1841,7 +1841,7 @@ protected function validate_expiration( $expiration ) { if ( defined( 'WP_REDIS_MAXTTL' ) ) { $max = (int) WP_REDIS_MAXTTL; - if ( $expiration === 0 || $expiration > $max ) { + if ( 0 === $expiration || $expiration > $max ) { $expiration = $max; } } From a02aed8b722380ee6afd592cd32cdb5b20dc6bdb Mon Sep 17 00:00:00 2001 From: naxvog Date: Sat, 15 Aug 2020 22:49:23 +0200 Subject: [PATCH 25/93] comment typo --- includes/object-cache.php | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/includes/object-cache.php b/includes/object-cache.php index 3db22ca4..006a1b70 100644 --- a/includes/object-cache.php +++ b/includes/object-cache.php @@ -731,7 +731,7 @@ protected function connect_using_credis( $parameters ) { if ( defined( 'WP_REDIS_SENTINEL' ) ) { if ( is_array( WP_REDIS_SERVERS ) && count( WP_REDIS_SERVERS ) > 1 ) { throw new Exception( - 'Multipe sentinel servers are not supported by the bundled Credis library. Please review your Redis Cache configurations.' + 'Multipe sentinel servers are not supported by the bundled Credis library. Please review your Redis Cache configuration.' ); } From b416210da7d3e531735889186b3ec1cd864eb67a Mon Sep 17 00:00:00 2001 From: naxvog Date: Sat, 15 Aug 2020 22:49:44 +0200 Subject: [PATCH 26/93] use `wp_parse_url` for better compatibility --- includes/object-cache.php | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/includes/object-cache.php b/includes/object-cache.php index 006a1b70..593191a3 100644 --- a/includes/object-cache.php +++ b/includes/object-cache.php @@ -746,7 +746,7 @@ protected function connect_using_credis( $parameters ) { $clients = $is_cluster ? WP_REDIS_CLUSTER : WP_REDIS_SERVERS; foreach ( $clients as $index => &$connection_string ) { - $url_components = parse_url( $connection_string ); + $url_components = wp_parse_url( $connection_string ); parse_str( $url_components['query'], $add_params ); if ( ! $is_cluster && isset( $add_params['alias'] ) ) { From ae147cc71c509494dfb450b1f74b8d3d44e3e1ad Mon Sep 17 00:00:00 2001 From: naxvog Date: Sat, 15 Aug 2020 22:50:41 +0200 Subject: [PATCH 27/93] strict comparisons --- includes/object-cache.php | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/includes/object-cache.php b/includes/object-cache.php index 593191a3..b8fc8ea9 100644 --- a/includes/object-cache.php +++ b/includes/object-cache.php @@ -1004,7 +1004,7 @@ protected function add_or_replace( $add, $key, $value, $group = 'default', $expi $exists = isset( $this->cache[ $derived_key ] ); - if ( $add == $exists ) { + if ( (bool) $add === $exists ) { return false; } @@ -1925,7 +1925,7 @@ protected function is_serialized( $data, $strict = true ) { $data = trim( $data ); - if ( 'N;' == $data ) { + if ( 'N;' === $data ) { return true; } From 2cc0e50902798def882c4be4d69f2c6e8a73eb98 Mon Sep 17 00:00:00 2001 From: naxvog Date: Sat, 15 Aug 2020 22:56:14 +0200 Subject: [PATCH 28/93] fixed formatting --- includes/object-cache.php | 24 +++++++++++++++--------- 1 file changed, 15 insertions(+), 9 deletions(-) diff --git a/includes/object-cache.php b/includes/object-cache.php index b8fc8ea9..94b373ca 100644 --- a/includes/object-cache.php +++ b/includes/object-cache.php @@ -619,7 +619,6 @@ protected function connect_using_predis( $parameters ) { defined( 'WP_PLUGIN_DIR' ) ? WP_PLUGIN_DIR : WP_CONTENT_DIR . '/plugins' ); - if ( is_readable( $predis ) ) { require_once $predis; } else { @@ -1385,9 +1384,12 @@ public function get_multiple( $keys, $group = 'default', $force = false ) { } } - $remaining_keys = array_filter( $keys, function ( $key ) use ( $cache ) { - return ! isset( $cache[ $key ] ); - } ); + $remaining_keys = array_filter( + $keys, + function ( $key ) use ( $cache ) { + return ! isset( $cache[ $key ] ); + } + ); if ( empty( $remaining_keys ) ) { return $cache; @@ -1396,9 +1398,12 @@ public function get_multiple( $keys, $group = 'default', $force = false ) { $start_time = microtime( true ); try { - $remaining_ids = array_map( function ( $key ) use ( $derived_keys ) { - return $derived_keys[ $key ]; - }, $remaining_keys ); + $remaining_ids = array_map( + function ( $key ) use ( $derived_keys ) { + return $derived_keys[ $key ]; + }, + $remaining_keys + ); $results = array_combine( $remaining_keys, @@ -1603,7 +1608,8 @@ function ( $key ) { $this->cache ); - ?>

+ ?> +

Redis Status: redis_status() ? 'Connected' : 'Not connected'; ?>
@@ -2021,6 +2027,6 @@ protected function handle_exception( $exception ) { * @return mixed */ public function __get( $name ) { - return isset($this->{$name}) ? $this->{$name} : null; + return isset( $this->{$name} ) ? $this->{$name} : null; } } From aa74eca4495873146292f647726201292fc1808a Mon Sep 17 00:00:00 2001 From: naxvog Date: Sat, 15 Aug 2020 22:52:40 +0200 Subject: [PATCH 29/93] fixed wrong return type --- includes/object-cache.php | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/includes/object-cache.php b/includes/object-cache.php index 94b373ca..8c86c6e5 100644 --- a/includes/object-cache.php +++ b/includes/object-cache.php @@ -1597,7 +1597,7 @@ public function decrement( $key, $offset = 1, $group = 'default' ) { /** * Render data about current cache requests * - * @return string + * @return void */ public function stats() { $bytes = array_map( From b659d13f7bbfbf7e7983d8416a2bb364e83267f4 Mon Sep 17 00:00:00 2001 From: naxvog Date: Sat, 15 Aug 2020 22:53:02 +0200 Subject: [PATCH 30/93] output sanitization --- includes/object-cache.php | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/includes/object-cache.php b/includes/object-cache.php index 8c86c6e5..b0496c8b 100644 --- a/includes/object-cache.php +++ b/includes/object-cache.php @@ -1617,10 +1617,10 @@ function ( $key ) { diagnostics['client'] ?: 'Unknown'; ?>
Cache Hits: - cache_hits; ?> + cache_hits ); ?>
Cache Misses: - cache_misses; ?> + cache_misses ); ?>
Cache Size: kB From 57ce2b3e70724bc8f37856bc275a195563b3b9b3 Mon Sep 17 00:00:00 2001 From: naxvog Date: Sat, 15 Aug 2020 22:54:32 +0200 Subject: [PATCH 31/93] removed unnecessary php version checks for <= 5.6 --- includes/object-cache.php | 10 ---------- 1 file changed, 10 deletions(-) diff --git a/includes/object-cache.php b/includes/object-cache.php index b0496c8b..c8eacc82 100644 --- a/includes/object-cache.php +++ b/includes/object-cache.php @@ -607,11 +607,6 @@ protected function connect_using_phpredis( $parameters ) { protected function connect_using_predis( $parameters ) { $client = 'Predis'; - // Require PHP 5.4 or greater - if ( version_compare( PHP_VERSION, '5.4.0', '<' ) ) { - throw new Exception( 'Predis requires PHP 5.4 or newer.' ); - } - // Load bundled Predis library. if ( ! class_exists( 'Predis\Client' ) ) { $predis = sprintf( @@ -682,11 +677,6 @@ protected function connect_using_predis( $parameters ) { protected function connect_using_credis( $parameters ) { $client = 'Credis'; - // Require PHP 5.4 or greater - if ( version_compare( PHP_VERSION, '5.4.0', '<' ) ) { - throw new Exception( 'Predis requires PHP 5.4 or newer.' ); - } - $creds_path = sprintf( '%s/redis-cache/dependencies/colinmollenhour/credis/', defined( 'WP_PLUGIN_DIR' ) ? WP_PLUGIN_DIR : WP_CONTENT_DIR . '/plugins' From f24b1273a77905d0cc883bdbf249722a771d5ebf Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Till=20Kr=C3=BCss?= Date: Sat, 15 Aug 2020 14:50:03 -0700 Subject: [PATCH 32/93] extra line --- assets/js/admin.js | 1 + 1 file changed, 1 insertion(+) diff --git a/assets/js/admin.js b/assets/js/admin.js index 760a36f6..028ed5ef 100644 --- a/assets/js/admin.js +++ b/assets/js/admin.js @@ -450,6 +450,7 @@ event.preventDefault(); var $parent = $( this ).parent(); + $.post( ajaxurl, { notice: $parent.data( 'dismissible' ), action: 'roc_dismiss_notice', From 656cabf324c7474b0b6932f50cff8f6d4ed2d7c0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Till=20Kr=C3=BCss?= Date: Sat, 15 Aug 2020 14:53:58 -0700 Subject: [PATCH 33/93] extra line --- includes/class-plugin.php | 1 + 1 file changed, 1 insertion(+) diff --git a/includes/class-plugin.php b/includes/class-plugin.php index 7a986715..7a8a8b63 100644 --- a/includes/class-plugin.php +++ b/includes/class-plugin.php @@ -1076,6 +1076,7 @@ public function on_deactivation( $plugin ) { if ( WP_REDIS_BASENAME === $plugin ) { $timestamp = wp_next_scheduled( 'rediscache_discard_metrics' ); + if ( $timestamp ) { wp_unschedule_event( $timestamp, 'rediscache_discard_metrics' ); } From e306b22e8dae6f88c79503310bed6551ca9e5a13 Mon Sep 17 00:00:00 2001 From: naxvog Date: Sun, 16 Aug 2020 00:07:52 +0200 Subject: [PATCH 34/93] :facepalm: unfumbled the WP_REDIS_DISABLED check of the drop-in --- includes/object-cache.php | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/includes/object-cache.php b/includes/object-cache.php index c8eacc82..57176f77 100644 --- a/includes/object-cache.php +++ b/includes/object-cache.php @@ -14,7 +14,7 @@ defined( '\\ABSPATH' ) || exit; -if ( ! defined( 'WP_REDIS_DISABLED' ) || ! WP_REDIS_DISABLED ) { +if ( defined( 'WP_REDIS_DISABLED' ) && WP_REDIS_DISABLED ) { return; } From 27a0c2fca046c6b0fdcdb82ef661d9ebddca1ff1 Mon Sep 17 00:00:00 2001 From: naxvog Date: Sun, 16 Aug 2020 00:12:51 +0200 Subject: [PATCH 35/93] simplified password obfuscation --- includes/ui/tabs/overview.php | 7 +------ 1 file changed, 1 insertion(+), 6 deletions(-) diff --git a/includes/ui/tabs/overview.php b/includes/ui/tabs/overview.php index 9c15348b..eb3bd2a8 100644 --- a/includes/ui/tabs/overview.php +++ b/includes/ui/tabs/overview.php @@ -160,12 +160,7 @@ - - - + •••••••• From cef23888ee03773d39902542473f5f7b4cc6ca76 Mon Sep 17 00:00:00 2001 From: naxvog Date: Sun, 16 Aug 2020 00:18:17 +0200 Subject: [PATCH 36/93] dropped output sanitization for static comment --- includes/class-plugin.php | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/includes/class-plugin.php b/includes/class-plugin.php index 7a8a8b63..b662950d 100644 --- a/includes/class-plugin.php +++ b/includes/class-plugin.php @@ -925,7 +925,8 @@ public function maybe_print_comment() { ); if ( ! WP_DEBUG ) { - printf( "\n\n", esc_html( $message ) ); + // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped + printf( "\n\n", $message ); return; } @@ -941,7 +942,11 @@ function_exists( 'size_format' ) ? size_format( $bytes ) : "{$bytes} bytes", $wp_object_cache->diagnostics['client'] ); - printf( "\n", esc_html( $message ), esc_html( $debug ) ); + printf( + "\n", + $message, // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped + esc_html( $debug ) + ); } /** From 48b81ea7fbb1d1f83f14cacc46ca6c827da2a607 Mon Sep 17 00:00:00 2001 From: naxvog Date: Sun, 16 Aug 2020 00:58:58 +0200 Subject: [PATCH 37/93] resolved cache size calc issue + unified method --- includes/class-plugin.php | 1 - includes/object-cache.php | 8 +------- 2 files changed, 1 insertion(+), 8 deletions(-) diff --git a/includes/class-plugin.php b/includes/class-plugin.php index b662950d..f912e456 100644 --- a/includes/class-plugin.php +++ b/includes/class-plugin.php @@ -931,7 +931,6 @@ public function maybe_print_comment() { return; } - // TODO: find a better method to determine cache size as using `serialize` is discouraged. $bytes = strlen( serialize( $wp_object_cache->cache ) ); // phpcs:ignore WordPress.PHP.DiscouragedPHPFunctions.serialize_serialize $debug = sprintf( diff --git a/includes/object-cache.php b/includes/object-cache.php index 57176f77..b0e7bd8f 100644 --- a/includes/object-cache.php +++ b/includes/object-cache.php @@ -1590,13 +1590,7 @@ public function decrement( $key, $offset = 1, $group = 'default' ) { * @return void */ public function stats() { - $bytes = array_map( - function ( $key ) { - // phpcs:ignore WordPress.PHP.DiscouragedPHPFunctions.serialize_serialize - return strlen( serialize( $key ) ); - }, - $this->cache - ); + $bytes = strlen( serialize( $wp_object_cache->cache ) ); // phpcs:ignore WordPress.PHP.DiscouragedPHPFunctions.serialize_serialize ?>

From 04d131ce09fd4edcbb305d5616de8f6ad7aaaa1e Mon Sep 17 00:00:00 2001 From: naxvog Date: Sun, 16 Aug 2020 00:59:41 +0200 Subject: [PATCH 38/93] marked WP_Object_Cache::stats deprecated --- includes/object-cache.php | 1 + 1 file changed, 1 insertion(+) diff --git a/includes/object-cache.php b/includes/object-cache.php index b0e7bd8f..9aeca055 100644 --- a/includes/object-cache.php +++ b/includes/object-cache.php @@ -1587,6 +1587,7 @@ public function decrement( $key, $offset = 1, $group = 'default' ) { /** * Render data about current cache requests * + * @deprecated No longer used by the plugin. * @return void */ public function stats() { From 7658068b1a2027d80bd19710ff8122902adca4b7 Mon Sep 17 00:00:00 2001 From: naxvog Date: Sun, 16 Aug 2020 01:02:36 +0200 Subject: [PATCH 39/93] Revert "yoda style conditions" This reverts commit b079844cd9863e3891cb80bebd5d117419b3f5d3. --- includes/object-cache.php | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/includes/object-cache.php b/includes/object-cache.php index 9aeca055..08210142 100644 --- a/includes/object-cache.php +++ b/includes/object-cache.php @@ -505,7 +505,7 @@ protected function build_parameters() { if ( isset( $parameters['password'] ) ) { $password = $parameters['password']; - if ( is_null( $password ) || '' === $password ) { + if ( is_null( $password ) || $password === '' ) { unset( $parameters['password'] ); } } @@ -756,7 +756,7 @@ protected function connect_using_credis( $parameters ) { $args['servers'] = $clients; } else { $args = [ - 'host' => 'unix' === $parameters['scheme'] ? $parameters['path'] : $parameters['host'], + 'host' => $parameters['scheme'] === 'unix' ? $parameters['path'] : $parameters['host'], 'port' => $parameters['port'], 'timeout' => $parameters['timeout'], 'persistent' => null, @@ -1305,7 +1305,7 @@ public function get( $key, $group = 'default', $force = false, &$found = null ) $this->cache_calls++; $this->cache_time += $execute_time; - if ( null === $result || false === $result ) { + if ( $result === null || $result === false ) { $found = false; $this->cache_misses++; @@ -1355,7 +1355,7 @@ public function get_multiple( $keys, $group = 'default', $force = false ) { if ( $this->is_ignored_group( $group ) || ! $this->redis_status() ) { foreach ( $keys as $key ) { $cache[ $key ] = $this->get_from_internal_cache( $derived_keys[ $key ] ); - false === $cache[ $key ] ? $this->cache_misses++ : $this->cache_hits++; + $cache[ $key ] === false ? $this->cache_misses++ : $this->cache_hits++; } return $cache; @@ -1365,7 +1365,7 @@ public function get_multiple( $keys, $group = 'default', $force = false ) { foreach ( $keys as $key ) { $value = $this->get_from_internal_cache( $derived_keys[ $key ] ); - if ( false === $value ) { + if ( $value === false ) { $this->cache_misses++; } else { $cache[ $key ] = $value; @@ -1411,7 +1411,7 @@ function ( $key ) use ( $derived_keys ) { $this->cache_time += $execute_time; foreach ( $results as $key => $value ) { - if ( null === $value || false === $value ) { + if ( $value === null || $value === false ) { $cache[ $key ] = false; $this->cache_misses++; } else { @@ -1832,7 +1832,7 @@ protected function validate_expiration( $expiration ) { if ( defined( 'WP_REDIS_MAXTTL' ) ) { $max = (int) WP_REDIS_MAXTTL; - if ( 0 === $expiration || $expiration > $max ) { + if ( $expiration === 0 || $expiration > $max ) { $expiration = $max; } } From bcaabc50f1b8b0f259765a75c6abcb02fc6e1085 Mon Sep 17 00:00:00 2001 From: naxvog Date: Sun, 16 Aug 2020 01:03:22 +0200 Subject: [PATCH 40/93] Revert "yoda style conditions" This reverts commit a7c2928b0aaff425ae7f9d731b991b182ee67894. --- includes/class-plugin.php | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/includes/class-plugin.php b/includes/class-plugin.php index f912e456..f53b24a5 100644 --- a/includes/class-plugin.php +++ b/includes/class-plugin.php @@ -603,7 +603,7 @@ public function do_admin_actions() { if ( in_array( $action, $this->actions, true ) ) { $url = $this->action_link( $action ); - if ( 'flush-cache' === $action ) { + if ( $action === 'flush-cache' ) { wp_cache_flush() ? add_settings_error( 'redis-cache', @@ -622,7 +622,7 @@ public function do_admin_actions() { // do we have filesystem credentials? if ( $this->initialize_filesystem( $url, true ) ) { - if ( 'enable-cache' === $action ) { + if ( $action === 'enable-cache' ) { $result = $wp_filesystem->copy( WP_REDIS_PLUGIN_PATH . '/includes/object-cache.php', WP_CONTENT_DIR . '/object-cache.php', @@ -647,7 +647,7 @@ public function do_admin_actions() { ); } - if ( 'disable-cache' === $action ) { + if ( $action === 'disable-cache' ) { $result = $wp_filesystem->delete( WP_CONTENT_DIR . '/object-cache.php' ); do_action( 'redis_object_cache_disable', $result ); @@ -667,7 +667,7 @@ public function do_admin_actions() { ); } - if ( 'update-dropin' === $action ) { + if ( $action === 'update-dropin' ) { $result = $wp_filesystem->copy( WP_REDIS_PLUGIN_PATH . '/includes/object-cache.php', WP_CONTENT_DIR . '/object-cache.php', @@ -1017,7 +1017,7 @@ public function test_filesystem_writing() { $meta = get_file_data( $testfile, [ 'Version' => 'Version' ] ); - if ( WP_REDIS_VERSION !== $meta['Version'] ) { + if ( $meta['Version'] !== WP_REDIS_VERSION ) { return new WP_Error( 'version', __( 'Couldn’t verify test file contents.', 'redis-cache' ) ); } @@ -1078,7 +1078,7 @@ public function on_deactivation( $plugin ) { ob_start(); - if ( WP_REDIS_BASENAME === $plugin ) { + if ( $plugin === WP_REDIS_BASENAME ) { $timestamp = wp_next_scheduled( 'rediscache_discard_metrics' ); if ( $timestamp ) { From c52790ba697810f318c3a17090a62eb9dbb6e3af Mon Sep 17 00:00:00 2001 From: naxvog Date: Sun, 16 Aug 2020 01:06:45 +0200 Subject: [PATCH 41/93] removed yoda style condition checks from phpcs ruleset --- phpcs.xml | 1 + 1 file changed, 1 insertion(+) diff --git a/phpcs.xml b/phpcs.xml index 45832e8c..9bd6882a 100644 --- a/phpcs.xml +++ b/phpcs.xml @@ -18,6 +18,7 @@ + From 5a2ec01ce404e5cfb158327d2e0897daf390b6f2 Mon Sep 17 00:00:00 2001 From: naxvog Date: Sun, 16 Aug 2020 01:31:53 +0200 Subject: [PATCH 42/93] reverted deprecation and added explanation --- includes/object-cache.php | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/includes/object-cache.php b/includes/object-cache.php index 08210142..2f0805a7 100644 --- a/includes/object-cache.php +++ b/includes/object-cache.php @@ -1586,8 +1586,8 @@ public function decrement( $key, $offset = 1, $group = 'default' ) { /** * Render data about current cache requests + * Used by the Debug bar plugin * - * @deprecated No longer used by the plugin. * @return void */ public function stats() { From eb4cb480dbe33a653ba35aeeda2c2d3094fd27dc Mon Sep 17 00:00:00 2001 From: naxvog Date: Sun, 16 Aug 2020 02:26:03 +0200 Subject: [PATCH 43/93] reverted WP_REDIS_DISABLED shorthand --- includes/object-cache.php | 3132 ++++++++++++++++++------------------- 1 file changed, 1566 insertions(+), 1566 deletions(-) diff --git a/includes/object-cache.php b/includes/object-cache.php index 2f0805a7..db3304fd 100644 --- a/includes/object-cache.php +++ b/includes/object-cache.php @@ -14,1172 +14,1170 @@ defined( '\\ABSPATH' ) || exit; -if ( defined( 'WP_REDIS_DISABLED' ) && WP_REDIS_DISABLED ) { - return; -} - -/** - * Adds a value to cache. - * - * If the specified key already exists, the value is not stored and the function - * returns false. - * - * @param string $key The key under which to store the value. - * @param mixed $value The value to store. - * @param string $group The group value appended to the $key. - * @param int $expiration The expiration time, defaults to 0. - * - * @return bool Returns TRUE on success or FALSE on failure. - */ -function wp_cache_add( $key, $value, $group = '', $expiration = 0 ) { - global $wp_object_cache; - - return $wp_object_cache->add( $key, $value, $group, $expiration ); -} - -/** - * Closes the cache. - * - * This function has ceased to do anything since WordPress 2.5. The - * functionality was removed along with the rest of the persistent cache. This - * does not mean that plugins can't implement this function when they need to - * make sure that the cache is cleaned up after WordPress no longer needs it. - * - * @return bool Always returns True - */ -function wp_cache_close() { - return true; -} - -/** - * Decrement a numeric item's value. - * - * @param string $key The key under which to store the value. - * @param int $offset The amount by which to decrement the item's value. - * @param string $group The group value appended to the $key. - * - * @return int|bool Returns item's new value on success or FALSE on failure. - */ -function wp_cache_decr( $key, $offset = 1, $group = '' ) { - global $wp_object_cache; - - return $wp_object_cache->decrement( $key, $offset, $group ); -} - -/** - * Remove the item from the cache. - * - * @param string $key The key under which to store the value. - * @param string $group The group value appended to the $key. - * @param int $time The amount of time the server will wait to delete the item in seconds. - * - * @return bool Returns TRUE on success or FALSE on failure. - */ -function wp_cache_delete( $key, $group = '', $time = 0 ) { - global $wp_object_cache; - - return $wp_object_cache->delete( $key, $group, $time ); -} - -/** - * Invalidate all items in the cache. If `WP_REDIS_SELECTIVE_FLUSH` is `true`, - * only keys prefixed with the `WP_REDIS_PREFIX` are flushed. - * - * @param int $delay Number of seconds to wait before invalidating the items. - * - * @return bool Returns TRUE on success or FALSE on failure. - */ -function wp_cache_flush( $delay = 0 ) { - global $wp_object_cache; - - return $wp_object_cache->flush( $delay ); -} - -/** - * Retrieve object from cache. - * - * Gets an object from cache based on $key and $group. - * - * @param string $key The key under which to store the value. - * @param string $group The group value appended to the $key. - * @param bool $force Optional. Whether to force an update of the local cache from the persistent - * cache. Default false. - * @param bool $found Optional. Whether the key was found in the cache. Disambiguates a return of false, - * a storable value. Passed by reference. Default null. - * - * @return bool|mixed Cached object value. - */ -function wp_cache_get( $key, $group = '', $force = false, &$found = null ) { - global $wp_object_cache; - - return $wp_object_cache->get( $key, $group, $force, $found ); -} - -/** - * Retrieves multiple values from the cache in one call. - * - * @param array $keys Array of keys under which the cache contents are stored. - * @param string $group Optional. Where the cache contents are grouped. Default empty. - * @param bool $force Optional. Whether to force an update of the local cache - * from the persistent cache. Default false. - * @return array Array of values organized into groups. - */ -function wp_cache_get_multiple( $keys, $group = '', $force = false ) { - global $wp_object_cache; - - return $wp_object_cache->get_multiple( $keys, $group, $force ); -} - -/** - * Increment a numeric item's value. - * - * @param string $key The key under which to store the value. - * @param int $offset The amount by which to increment the item's value. - * @param string $group The group value appended to the $key. - * - * @return int|bool Returns item's new value on success or FALSE on failure. - */ -function wp_cache_incr( $key, $offset = 1, $group = '' ) { - global $wp_object_cache; - - return $wp_object_cache->increment( $key, $offset, $group ); -} - -/** - * Sets up Object Cache Global and assigns it. - * - * @return void - */ -function wp_cache_init() { - global $wp_object_cache; - - // Backwards compatibility: map `WP_CACHE_KEY_SALT` constant to `WP_REDIS_PREFIX`. - if ( defined( 'WP_CACHE_KEY_SALT' ) && ! defined( 'WP_REDIS_PREFIX' ) ) { - define( 'WP_REDIS_PREFIX', WP_CACHE_KEY_SALT ); - } - - if ( ! ( $wp_object_cache instanceof WP_Object_Cache ) ) { - $fail_gracefully = ! defined( 'WP_REDIS_GRACEFUL' ) || WP_REDIS_GRACEFUL; - - // We need to override this WordPress global in order to inject our cache. - // phpcs:ignore WordPress.WP.GlobalVariablesOverride.Prohibited - $wp_object_cache = new WP_Object_Cache( $fail_gracefully ); - } -} - -/** - * Replaces a value in cache. - * - * This method is similar to "add"; however, is does not successfully set a value if - * the object's key is not already set in cache. - * - * @param string $key The key under which to store the value. - * @param mixed $value The value to store. - * @param string $group The group value appended to the $key. - * @param int $expiration The expiration time, defaults to 0. - * - * @return bool Returns TRUE on success or FALSE on failure. - */ -function wp_cache_replace( $key, $value, $group = '', $expiration = 0 ) { - global $wp_object_cache; - - return $wp_object_cache->replace( $key, $value, $group, $expiration ); -} - -/** - * Sets a value in cache. - * - * The value is set whether or not this key already exists in Redis. - * - * @param string $key The key under which to store the value. - * @param mixed $value The value to store. - * @param string $group The group value appended to the $key. - * @param int $expiration The expiration time, defaults to 0. - * - * @return bool Returns TRUE on success or FALSE on failure. - */ -function wp_cache_set( $key, $value, $group = '', $expiration = 0 ) { - global $wp_object_cache; - - return $wp_object_cache->set( $key, $value, $group, $expiration ); -} - -/** - * Switch the internal blog id. - * - * This changes the blog id used to create keys in blog specific groups. - * - * @param int $_blog_id The blog ID. - * - * @return bool - */ -function wp_cache_switch_to_blog( $_blog_id ) { - global $wp_object_cache; - - return $wp_object_cache->switch_to_blog( $_blog_id ); -} - -/** - * Adds a group or set of groups to the list of Redis groups. - * - * @param string|array $groups A group or an array of groups to add. - * - * @return void - */ -function wp_cache_add_global_groups( $groups ) { - global $wp_object_cache; - - $wp_object_cache->add_global_groups( $groups ); -} - -/** - * Adds a group or set of groups to the list of non-Redis groups. - * - * @param string|array $groups A group or an array of groups to add. - * - * @return void - */ -function wp_cache_add_non_persistent_groups( $groups ) { - global $wp_object_cache; - - $wp_object_cache->add_non_persistent_groups( $groups ); -} - -/** - * Object cache class definition - */ -class WP_Object_Cache { +if ( ! defined( 'WP_REDIS_DISABLED' ) || ! WP_REDIS_DISABLED ) : /** - * The Redis client. + * Adds a value to cache. * - * @var mixed - */ - private $redis; - - /** - * The Redis server version. + * If the specified key already exists, the value is not stored and the function + * returns false. * - * @var null|string - */ - private $redis_version = null; - - /** - * Track if Redis is available. + * @param string $key The key under which to store the value. + * @param mixed $value The value to store. + * @param string $group The group value appended to the $key. + * @param int $expiration The expiration time, defaults to 0. * - * @var bool + * @return bool Returns TRUE on success or FALSE on failure. */ - private $redis_connected = false; + function wp_cache_add( $key, $value, $group = '', $expiration = 0 ) { + global $wp_object_cache; - /** - * Check to fail gracefully or throw an exception. - * - * @var bool - */ - private $fail_gracefully = true; + return $wp_object_cache->add( $key, $value, $group, $expiration ); + } /** - * Holds the non-Redis objects. + * Closes the cache. * - * @var array - */ - public $cache = array(); - - /** - * Holds the diagnostics values. + * This function has ceased to do anything since WordPress 2.5. The + * functionality was removed along with the rest of the persistent cache. This + * does not mean that plugins can't implement this function when they need to + * make sure that the cache is cleaned up after WordPress no longer needs it. * - * @var array + * @return bool Always returns True */ - public $diagnostics = null; + function wp_cache_close() { + return true; + } /** - * Holds the error messages. + * Decrement a numeric item's value. + * + * @param string $key The key under which to store the value. + * @param int $offset The amount by which to decrement the item's value. + * @param string $group The group value appended to the $key. * - * @var array + * @return int|bool Returns item's new value on success or FALSE on failure. */ - public $errors = array(); + function wp_cache_decr( $key, $offset = 1, $group = '' ) { + global $wp_object_cache; + + return $wp_object_cache->decrement( $key, $offset, $group ); + } /** - * List of global groups. + * Remove the item from the cache. + * + * @param string $key The key under which to store the value. + * @param string $group The group value appended to the $key. + * @param int $time The amount of time the server will wait to delete the item in seconds. * - * @var array + * @return bool Returns TRUE on success or FALSE on failure. */ - public $global_groups = array( - 'blog-details', - 'blog-id-cache', - 'blog-lookup', - 'global-posts', - 'networks', - 'rss', - 'sites', - 'site-details', - 'site-lookup', - 'site-options', - 'site-transient', - 'users', - 'useremail', - 'userlogins', - 'usermeta', - 'user_meta', - 'userslugs', - ); + function wp_cache_delete( $key, $group = '', $time = 0 ) { + global $wp_object_cache; + + return $wp_object_cache->delete( $key, $group, $time ); + } /** - * List of groups that will not be flushed. + * Invalidate all items in the cache. If `WP_REDIS_SELECTIVE_FLUSH` is `true`, + * only keys prefixed with the `WP_REDIS_PREFIX` are flushed. + * + * @param int $delay Number of seconds to wait before invalidating the items. * - * @var array + * @return bool Returns TRUE on success or FALSE on failure. */ - public $unflushable_groups = array(); + function wp_cache_flush( $delay = 0 ) { + global $wp_object_cache; + + return $wp_object_cache->flush( $delay ); + } /** - * List of groups not saved to Redis. + * Retrieve object from cache. + * + * Gets an object from cache based on $key and $group. + * + * @param string $key The key under which to store the value. + * @param string $group The group value appended to the $key. + * @param bool $force Optional. Whether to force an update of the local cache from the persistent + * cache. Default false. + * @param bool $found Optional. Whether the key was found in the cache. Disambiguates a return of false, + * a storable value. Passed by reference. Default null. * - * @var array + * @return bool|mixed Cached object value. */ - public $ignored_groups = array( - 'counts', - 'plugins', - 'themes', - ); + function wp_cache_get( $key, $group = '', $force = false, &$found = null ) { + global $wp_object_cache; + + return $wp_object_cache->get( $key, $group, $force, $found ); + } /** - * Prefix used for global groups. + * Retrieves multiple values from the cache in one call. * - * @var string + * @param array $keys Array of keys under which the cache contents are stored. + * @param string $group Optional. Where the cache contents are grouped. Default empty. + * @param bool $force Optional. Whether to force an update of the local cache + * from the persistent cache. Default false. + * @return array Array of values organized into groups. */ - public $global_prefix = ''; + function wp_cache_get_multiple( $keys, $group = '', $force = false ) { + global $wp_object_cache; + + return $wp_object_cache->get_multiple( $keys, $group, $force ); + } /** - * Prefix used for non-global groups. + * Increment a numeric item's value. + * + * @param string $key The key under which to store the value. + * @param int $offset The amount by which to increment the item's value. + * @param string $group The group value appended to the $key. * - * @var string + * @return int|bool Returns item's new value on success or FALSE on failure. */ - public $blog_prefix = ''; + function wp_cache_incr( $key, $offset = 1, $group = '' ) { + global $wp_object_cache; + + return $wp_object_cache->increment( $key, $offset, $group ); + } /** - * Track how many requests were found in cache. + * Sets up Object Cache Global and assigns it. * - * @var int + * @return void */ - public $cache_hits = 0; + function wp_cache_init() { + global $wp_object_cache; + + // Backwards compatibility: map `WP_CACHE_KEY_SALT` constant to `WP_REDIS_PREFIX`. + if ( defined( 'WP_CACHE_KEY_SALT' ) && ! defined( 'WP_REDIS_PREFIX' ) ) { + define( 'WP_REDIS_PREFIX', WP_CACHE_KEY_SALT ); + } + + if ( ! ( $wp_object_cache instanceof WP_Object_Cache ) ) { + $fail_gracefully = ! defined( 'WP_REDIS_GRACEFUL' ) || WP_REDIS_GRACEFUL; + + // We need to override this WordPress global in order to inject our cache. + // phpcs:ignore WordPress.WP.GlobalVariablesOverride.Prohibited + $wp_object_cache = new WP_Object_Cache( $fail_gracefully ); + } + } /** - * Track how may requests were not cached. + * Replaces a value in cache. * - * @var int + * This method is similar to "add"; however, is does not successfully set a value if + * the object's key is not already set in cache. + * + * @param string $key The key under which to store the value. + * @param mixed $value The value to store. + * @param string $group The group value appended to the $key. + * @param int $expiration The expiration time, defaults to 0. + * + * @return bool Returns TRUE on success or FALSE on failure. */ - public $cache_misses = 0; + function wp_cache_replace( $key, $value, $group = '', $expiration = 0 ) { + global $wp_object_cache; + + return $wp_object_cache->replace( $key, $value, $group, $expiration ); + } /** - * Track how long request took. + * Sets a value in cache. + * + * The value is set whether or not this key already exists in Redis. + * + * @param string $key The key under which to store the value. + * @param mixed $value The value to store. + * @param string $group The group value appended to the $key. + * @param int $expiration The expiration time, defaults to 0. * - * @var int + * @return bool Returns TRUE on success or FALSE on failure. */ - public $cache_time = 0; + function wp_cache_set( $key, $value, $group = '', $expiration = 0 ) { + global $wp_object_cache; + + return $wp_object_cache->set( $key, $value, $group, $expiration ); + } /** - * Track how may calls were made. + * Switch the internal blog id. + * + * This changes the blog id used to create keys in blog specific groups. * - * @var int + * @param int $_blog_id The blog ID. + * + * @return bool */ - public $cache_calls = 0; + function wp_cache_switch_to_blog( $_blog_id ) { + global $wp_object_cache; + + return $wp_object_cache->switch_to_blog( $_blog_id ); + } /** - * Instantiate the Redis class. + * Adds a group or set of groups to the list of Redis groups. + * + * @param string|array $groups A group or an array of groups to add. * - * @param bool $fail_gracefully Handles and logs errors if true throws exceptions otherwise. + * @return void */ - public function __construct( $fail_gracefully = true ) { - global $blog_id, $table_prefix; - - $this->fail_gracefully = $fail_gracefully; - - if ( defined( 'WP_REDIS_GLOBAL_GROUPS' ) && is_array( WP_REDIS_GLOBAL_GROUPS ) ) { - $this->global_groups = array_map( [ $this, 'sanitize_key_part' ], WP_REDIS_GLOBAL_GROUPS ); - } - - if ( defined( 'WP_REDIS_IGNORED_GROUPS' ) && is_array( WP_REDIS_IGNORED_GROUPS ) ) { - $this->ignored_groups = array_map( [ $this, 'sanitize_key_part' ], WP_REDIS_IGNORED_GROUPS ); - } - - if ( defined( 'WP_REDIS_UNFLUSHABLE_GROUPS' ) && is_array( WP_REDIS_UNFLUSHABLE_GROUPS ) ) { - $this->unflushable_groups = array_map( [ $this, 'sanitize_key_part' ], WP_REDIS_UNFLUSHABLE_GROUPS ); - } - - $client = $this->determine_client(); - $parameters = $this->build_parameters(); - - try { - switch ( $client ) { - case 'hhvm': - $this->connect_using_hhvm( $parameters ); - break; - case 'phpredis': - $this->connect_using_phpredis( $parameters ); - break; - case 'credis': - $this->connect_using_credis( $parameters ); - break; - case 'predis': - default: - $this->connect_using_predis( $parameters ); - break; - } - - if ( defined( 'WP_REDIS_CLUSTER' ) ) { - $this->diagnostics[ 'ping' ] = $this->redis->ping( current( array_values( WP_REDIS_CLUSTER ) ) ); - } else { - $this->diagnostics[ 'ping' ] = $this->redis->ping(); - } + function wp_cache_add_global_groups( $groups ) { + global $wp_object_cache; - $this->fetch_info(); - - $this->redis_connected = true; - } catch ( Exception $exception ) { - $this->handle_exception( $exception ); - } - - // Assign global and blog prefixes for use with keys. - if ( function_exists( 'is_multisite' ) ) { - $this->global_prefix = is_multisite() ? '' : $table_prefix; - $this->blog_prefix = is_multisite() ? $blog_id : $table_prefix; - } + $wp_object_cache->add_global_groups( $groups ); } /** - * Determine the Redis client. + * Adds a group or set of groups to the list of non-Redis groups. + * + * @param string|array $groups A group or an array of groups to add. * - * @return string + * @return void */ - protected function determine_client() { - $client = 'predis'; + function wp_cache_add_non_persistent_groups( $groups ) { + global $wp_object_cache; - if ( class_exists( 'Redis' ) ) { - $client = defined( 'HHVM_VERSION' ) ? 'hhvm' : 'phpredis'; - } - - if ( defined( 'WP_REDIS_CLIENT' ) ) { - $client = (string) WP_REDIS_CLIENT; - $client = str_replace( 'pecl', 'phpredis', $client ); - } - - return trim( strtolower( $client ) ); + $wp_object_cache->add_non_persistent_groups( $groups ); } /** - * Build the connection parameters from config constants. - * - * @return array + * Object cache class definition */ - protected function build_parameters() { - $parameters = array( - 'scheme' => 'tcp', - 'host' => '127.0.0.1', - 'port' => 6379, - 'database' => 0, - 'timeout' => 1, - 'read_timeout' => 1, - 'retry_interval' => null, + class WP_Object_Cache { + + /** + * The Redis client. + * + * @var mixed + */ + private $redis; + + /** + * The Redis server version. + * + * @var null|string + */ + private $redis_version = null; + + /** + * Track if Redis is available. + * + * @var bool + */ + private $redis_connected = false; + + /** + * Check to fail gracefully or throw an exception. + * + * @var bool + */ + private $fail_gracefully = true; + + /** + * Holds the non-Redis objects. + * + * @var array + */ + public $cache = array(); + + /** + * Holds the diagnostics values. + * + * @var array + */ + public $diagnostics = null; + + /** + * Holds the error messages. + * + * @var array + */ + public $errors = array(); + + /** + * List of global groups. + * + * @var array + */ + public $global_groups = array( + 'blog-details', + 'blog-id-cache', + 'blog-lookup', + 'global-posts', + 'networks', + 'rss', + 'sites', + 'site-details', + 'site-lookup', + 'site-options', + 'site-transient', + 'users', + 'useremail', + 'userlogins', + 'usermeta', + 'user_meta', + 'userslugs', ); - $settings = array( - 'scheme', - 'host', - 'port', - 'path', - 'password', - 'database', - 'timeout', - 'read_timeout', - 'retry_interval', + /** + * List of groups that will not be flushed. + * + * @var array + */ + public $unflushable_groups = array(); + + /** + * List of groups not saved to Redis. + * + * @var array + */ + public $ignored_groups = array( + 'counts', + 'plugins', + 'themes', ); - foreach ( $settings as $setting ) { - $constant = sprintf( 'WP_REDIS_%s', strtoupper( $setting ) ); - - if ( defined( $constant ) ) { - $parameters[ $setting ] = constant( $constant ); + /** + * Prefix used for global groups. + * + * @var string + */ + public $global_prefix = ''; + + /** + * Prefix used for non-global groups. + * + * @var string + */ + public $blog_prefix = ''; + + /** + * Track how many requests were found in cache. + * + * @var int + */ + public $cache_hits = 0; + + /** + * Track how may requests were not cached. + * + * @var int + */ + public $cache_misses = 0; + + /** + * Track how long request took. + * + * @var int + */ + public $cache_time = 0; + + /** + * Track how may calls were made. + * + * @var int + */ + public $cache_calls = 0; + + /** + * Instantiate the Redis class. + * + * @param bool $fail_gracefully Handles and logs errors if true throws exceptions otherwise. + */ + public function __construct( $fail_gracefully = true ) { + global $blog_id, $table_prefix; + + $this->fail_gracefully = $fail_gracefully; + + if ( defined( 'WP_REDIS_GLOBAL_GROUPS' ) && is_array( WP_REDIS_GLOBAL_GROUPS ) ) { + $this->global_groups = array_map( [ $this, 'sanitize_key_part' ], WP_REDIS_GLOBAL_GROUPS ); } - } - if ( isset( $parameters['password'] ) ) { - $password = $parameters['password']; + if ( defined( 'WP_REDIS_IGNORED_GROUPS' ) && is_array( WP_REDIS_IGNORED_GROUPS ) ) { + $this->ignored_groups = array_map( [ $this, 'sanitize_key_part' ], WP_REDIS_IGNORED_GROUPS ); + } - if ( is_null( $password ) || $password === '' ) { - unset( $parameters['password'] ); + if ( defined( 'WP_REDIS_UNFLUSHABLE_GROUPS' ) && is_array( WP_REDIS_UNFLUSHABLE_GROUPS ) ) { + $this->unflushable_groups = array_map( [ $this, 'sanitize_key_part' ], WP_REDIS_UNFLUSHABLE_GROUPS ); } - } - return $parameters; - } + $client = $this->determine_client(); + $parameters = $this->build_parameters(); - /** - * Connect to Redis using the PhpRedis (PECL) extention. - * - * @param array $parameters Connection parameters built by the `build_parameters` method. - * @return void - */ - protected function connect_using_phpredis( $parameters ) { - $version = phpversion( 'redis' ); - - $this->diagnostics[ 'client' ] = sprintf( 'PhpRedis (v%s)', $version ); + try { + switch ( $client ) { + case 'hhvm': + $this->connect_using_hhvm( $parameters ); + break; + case 'phpredis': + $this->connect_using_phpredis( $parameters ); + break; + case 'credis': + $this->connect_using_credis( $parameters ); + break; + case 'predis': + default: + $this->connect_using_predis( $parameters ); + break; + } - if ( defined( 'WP_REDIS_SHARDS' ) ) { - $this->redis = new RedisArray( array_values( WP_REDIS_SHARDS ) ); + if ( defined( 'WP_REDIS_CLUSTER' ) ) { + $this->diagnostics[ 'ping' ] = $this->redis->ping( current( array_values( WP_REDIS_CLUSTER ) ) ); + } else { + $this->diagnostics[ 'ping' ] = $this->redis->ping(); + } - $this->diagnostics[ 'shards' ] = WP_REDIS_SHARDS; - } elseif ( defined( 'WP_REDIS_CLUSTER' ) ) { - $args = [ - 'cluster' => array_values( WP_REDIS_CLUSTER ), - 'timeout' => $parameters['timeout'], - 'read_timeout' => $parameters['read_timeout'], - ]; + $this->fetch_info(); - if ( isset( $parameters['password'] ) && version_compare( $version, '4.3.0', '>=' ) ) { - $args['password'] = $parameters['password']; + $this->redis_connected = true; + } catch ( Exception $exception ) { + $this->handle_exception( $exception ); } - $this->redis = new RedisCluster( null, ...array_values( $args ) ); - - $this->diagnostics += $args; - } else { - $this->redis = new Redis(); + // Assign global and blog prefixes for use with keys. + if ( function_exists( 'is_multisite' ) ) { + $this->global_prefix = is_multisite() ? '' : $table_prefix; + $this->blog_prefix = is_multisite() ? $blog_id : $table_prefix; + } + } - $args = [ - 'host' => $parameters['host'], - 'port' => $parameters['port'], - 'timeout' => $parameters['timeout'], - null, - 'retry_interval' => $parameters['retry_interval'], - ]; + /** + * Determine the Redis client. + * + * @return string + */ + protected function determine_client() { + $client = 'predis'; - if ( strcasecmp( 'tls', $parameters['scheme'] ) === 0 ) { - $args['host'] = sprintf( - '%s://%s', - $parameters['scheme'], - str_replace( 'tls://', '', $parameters['host'] ) - ); + if ( class_exists( 'Redis' ) ) { + $client = defined( 'HHVM_VERSION' ) ? 'hhvm' : 'phpredis'; } - if ( strcasecmp( 'unix', $parameters['scheme'] ) === 0 ) { - $args['host'] = $parameters['path']; - $args['port'] = null; + if ( defined( 'WP_REDIS_CLIENT' ) ) { + $client = (string) WP_REDIS_CLIENT; + $client = str_replace( 'pecl', 'phpredis', $client ); } - if ( version_compare( $version, '3.1.3', '>=' ) ) { - $args['read_timeout'] = $parameters['read_timeout']; - } + return trim( strtolower( $client ) ); + } + + /** + * Build the connection parameters from config constants. + * + * @return array + */ + protected function build_parameters() { + $parameters = array( + 'scheme' => 'tcp', + 'host' => '127.0.0.1', + 'port' => 6379, + 'database' => 0, + 'timeout' => 1, + 'read_timeout' => 1, + 'retry_interval' => null, + ); - call_user_func_array( [ $this->redis, 'connect' ], array_values( $args ) ); + $settings = array( + 'scheme', + 'host', + 'port', + 'path', + 'password', + 'database', + 'timeout', + 'read_timeout', + 'retry_interval', + ); - if ( isset( $parameters['password'] ) ) { - $args['password'] = $parameters['password']; - $this->redis->auth( $parameters['password'] ); - } + foreach ( $settings as $setting ) { + $constant = sprintf( 'WP_REDIS_%s', strtoupper( $setting ) ); - if ( isset( $parameters['database'] ) ) { - if ( ctype_digit( $parameters['database'] ) ) { - $parameters['database'] = intval( $parameters['database'] ); + if ( defined( $constant ) ) { + $parameters[ $setting ] = constant( $constant ); } + } - $args['database'] = $parameters['database']; + if ( isset( $parameters['password'] ) ) { + $password = $parameters['password']; - if ( $parameters['database'] ) { - $this->redis->select( $parameters['database'] ); + if ( is_null( $password ) || $password === '' ) { + unset( $parameters['password'] ); } } - $this->diagnostics += $args; + return $parameters; } - if ( defined( 'WP_REDIS_SERIALIZER' ) && ! empty( WP_REDIS_SERIALIZER ) ) { - $this->redis->setOption( Redis::OPT_SERIALIZER, WP_REDIS_SERIALIZER ); - } - } + /** + * Connect to Redis using the PhpRedis (PECL) extention. + * + * @param array $parameters Connection parameters built by the `build_parameters` method. + * @return void + */ + protected function connect_using_phpredis( $parameters ) { + $version = phpversion( 'redis' ); - /** - * Connect to Redis using the Predis library. - * - * @param array $parameters Connection parameters built by the `build_parameters` method. - * @throws \Exception If the Predis library was not found or is unreadable. - * @return void - */ - protected function connect_using_predis( $parameters ) { - $client = 'Predis'; + $this->diagnostics[ 'client' ] = sprintf( 'PhpRedis (v%s)', $version ); - // Load bundled Predis library. - if ( ! class_exists( 'Predis\Client' ) ) { - $predis = sprintf( - '%s/redis-cache/dependencies/predis/predis/autoload.php', - defined( 'WP_PLUGIN_DIR' ) ? WP_PLUGIN_DIR : WP_CONTENT_DIR . '/plugins' - ); + if ( defined( 'WP_REDIS_SHARDS' ) ) { + $this->redis = new RedisArray( array_values( WP_REDIS_SHARDS ) ); - if ( is_readable( $predis ) ) { - require_once $predis; - } else { - throw new Exception( - 'Predis library not found. Re-install Redis Cache plugin or delete the object-cache.php.' - ); - } - } + $this->diagnostics[ 'shards' ] = WP_REDIS_SHARDS; + } elseif ( defined( 'WP_REDIS_CLUSTER' ) ) { + $args = [ + 'cluster' => array_values( WP_REDIS_CLUSTER ), + 'timeout' => $parameters['timeout'], + 'read_timeout' => $parameters['read_timeout'], + ]; - $options = array(); - - if ( defined( 'WP_REDIS_SHARDS' ) ) { - $parameters = WP_REDIS_SHARDS; - } elseif ( defined( 'WP_REDIS_SENTINEL' ) ) { - $parameters = WP_REDIS_SERVERS; - $options['replication'] = 'sentinel'; - $options['service'] = WP_REDIS_SENTINEL; - } elseif ( defined( 'WP_REDIS_SERVERS' ) ) { - $parameters = WP_REDIS_SERVERS; - $options['replication'] = true; - } elseif ( defined( 'WP_REDIS_CLUSTER' ) ) { - $parameters = WP_REDIS_CLUSTER; - $options['cluster'] = 'redis'; - } + if ( isset( $parameters['password'] ) && version_compare( $version, '4.3.0', '>=' ) ) { + $args['password'] = $parameters['password']; + } - if ( isset( $parameters['read_timeout'] ) && $parameters['read_timeout'] ) { - $parameters['read_write_timeout'] = $parameters['read_timeout']; - } + $this->redis = new RedisCluster( null, ...array_values( $args ) ); - foreach ( array( 'WP_REDIS_SERVERS', 'WP_REDIS_SHARDS', 'WP_REDIS_CLUSTER' ) as $constant ) { - if ( defined( $constant ) ) { - if ( $parameters['database'] ) { - $options['parameters']['database'] = $parameters['database']; + $this->diagnostics += $args; + } else { + $this->redis = new Redis(); + + $args = [ + 'host' => $parameters['host'], + 'port' => $parameters['port'], + 'timeout' => $parameters['timeout'], + null, + 'retry_interval' => $parameters['retry_interval'], + ]; + + if ( strcasecmp( 'tls', $parameters['scheme'] ) === 0 ) { + $args['host'] = sprintf( + '%s://%s', + $parameters['scheme'], + str_replace( 'tls://', '', $parameters['host'] ) + ); } - if ( isset( $parameters['password'] ) ) { - $options['parameters']['password'] = WP_REDIS_PASSWORD; + if ( strcasecmp( 'unix', $parameters['scheme'] ) === 0 ) { + $args['host'] = $parameters['path']; + $args['port'] = null; } - } - } - $this->redis = new Predis\Client( $parameters, $options ); - $this->redis->connect(); + if ( version_compare( $version, '3.1.3', '>=' ) ) { + $args['read_timeout'] = $parameters['read_timeout']; + } - $this->diagnostics = array_merge( - [ 'client' => sprintf( '%s (v%s)', $client, Predis\Client::VERSION ) ], - $parameters, - $options - ); - } + call_user_func_array( [ $this->redis, 'connect' ], array_values( $args ) ); - /** - * Connect to Redis using the Credis library. - * - * @param array $parameters Connection parameters built by the `build_parameters` method. - * @throws \Exception If the Credis library was not found or is unreadable. - * @throws \Exception If redis sharding should be configured as Credis does not support sharding. - * @throws \Exception If more than one seninel is configured as Credis does not support multiple sentinel servers. - * @return void - */ - protected function connect_using_credis( $parameters ) { - $client = 'Credis'; + if ( isset( $parameters['password'] ) ) { + $args['password'] = $parameters['password']; + $this->redis->auth( $parameters['password'] ); + } - $creds_path = sprintf( - '%s/redis-cache/dependencies/colinmollenhour/credis/', - defined( 'WP_PLUGIN_DIR' ) ? WP_PLUGIN_DIR : WP_CONTENT_DIR . '/plugins' - ); + if ( isset( $parameters['database'] ) ) { + if ( ctype_digit( $parameters['database'] ) ) { + $parameters['database'] = intval( $parameters['database'] ); + } - $to_load = []; + $args['database'] = $parameters['database']; - if ( ! class_exists( 'Credis_Client' ) ) { - $to_load[] = 'Client.php'; - } + if ( $parameters['database'] ) { + $this->redis->select( $parameters['database'] ); + } + } - if ( - ( defined( 'WP_REDIS_SHARDS' ) || defined( 'WP_REDIS_SENTINEL' ) || defined( 'WP_REDIS_SERVERS' ) || defined( 'WP_REDIS_CLUSTER' ) ) && - ! class_exists( 'Credis_Cluster' ) - ) { - $to_load[] = 'Cluster.php'; + $this->diagnostics += $args; + } - if ( defined( 'WP_REDIS_SENTINEL' ) && ! class_exists( 'Credis_Sentinel' ) ) { - $to_load[] = 'Sentinel.php'; + if ( defined( 'WP_REDIS_SERIALIZER' ) && ! empty( WP_REDIS_SERIALIZER ) ) { + $this->redis->setOption( Redis::OPT_SERIALIZER, WP_REDIS_SERIALIZER ); } } - foreach ( $to_load as $sub_path ) { - $path = $creds_path . $sub_path; - - if ( file_exists( $path ) ) { - require_once $path; - } else { - throw new Exception( - 'Credis library not found. Re-install Redis Cache plugin or delete object-cache.php.' + /** + * Connect to Redis using the Predis library. + * + * @param array $parameters Connection parameters built by the `build_parameters` method. + * @throws \Exception If the Predis library was not found or is unreadable. + * @return void + */ + protected function connect_using_predis( $parameters ) { + $client = 'Predis'; + + // Load bundled Predis library. + if ( ! class_exists( 'Predis\Client' ) ) { + $predis = sprintf( + '%s/redis-cache/dependencies/predis/predis/autoload.php', + defined( 'WP_PLUGIN_DIR' ) ? WP_PLUGIN_DIR : WP_CONTENT_DIR . '/plugins' ); + + if ( is_readable( $predis ) ) { + require_once $predis; + } else { + throw new Exception( + 'Predis library not found. Re-install Redis Cache plugin or delete the object-cache.php.' + ); + } } - } - if ( defined( 'WP_REDIS_SHARDS' ) ) { - throw new Exception( - 'Sharding not supported by bundled Credis library. Please review your Redis Cache configuration.' + $options = array(); + + if ( defined( 'WP_REDIS_SHARDS' ) ) { + $parameters = WP_REDIS_SHARDS; + } elseif ( defined( 'WP_REDIS_SENTINEL' ) ) { + $parameters = WP_REDIS_SERVERS; + $options['replication'] = 'sentinel'; + $options['service'] = WP_REDIS_SENTINEL; + } elseif ( defined( 'WP_REDIS_SERVERS' ) ) { + $parameters = WP_REDIS_SERVERS; + $options['replication'] = true; + } elseif ( defined( 'WP_REDIS_CLUSTER' ) ) { + $parameters = WP_REDIS_CLUSTER; + $options['cluster'] = 'redis'; + } + + if ( isset( $parameters['read_timeout'] ) && $parameters['read_timeout'] ) { + $parameters['read_write_timeout'] = $parameters['read_timeout']; + } + + foreach ( array( 'WP_REDIS_SERVERS', 'WP_REDIS_SHARDS', 'WP_REDIS_CLUSTER' ) as $constant ) { + if ( defined( $constant ) ) { + if ( $parameters['database'] ) { + $options['parameters']['database'] = $parameters['database']; + } + + if ( isset( $parameters['password'] ) ) { + $options['parameters']['password'] = WP_REDIS_PASSWORD; + } + } + } + + $this->redis = new Predis\Client( $parameters, $options ); + $this->redis->connect(); + + $this->diagnostics = array_merge( + [ 'client' => sprintf( '%s (v%s)', $client, Predis\Client::VERSION ) ], + $parameters, + $options ); } - if ( defined( 'WP_REDIS_SENTINEL' ) ) { - if ( is_array( WP_REDIS_SERVERS ) && count( WP_REDIS_SERVERS ) > 1 ) { - throw new Exception( - 'Multipe sentinel servers are not supported by the bundled Credis library. Please review your Redis Cache configuration.' - ); - } + /** + * Connect to Redis using the Credis library. + * + * @param array $parameters Connection parameters built by the `build_parameters` method. + * @throws \Exception If the Credis library was not found or is unreadable. + * @throws \Exception If redis sharding should be configured as Credis does not support sharding. + * @throws \Exception If more than one seninel is configured as Credis does not support multiple sentinel servers. + * @return void + */ + protected function connect_using_credis( $parameters ) { + $client = 'Credis'; + + $creds_path = sprintf( + '%s/redis-cache/dependencies/colinmollenhour/credis/', + defined( 'WP_PLUGIN_DIR' ) ? WP_PLUGIN_DIR : WP_CONTENT_DIR . '/plugins' + ); - $connection_string = array_values( WP_REDIS_SERVERS )[0]; - $sentinel = new Credis_Sentinel( new Credis_Client( $connection_string ) ); - $this->redis = $sentinel->getCluster( WP_REDIS_SENTINEL ); - $args['servers'] = WP_REDIS_SERVERS; - } elseif ( defined( 'WP_REDIS_CLUSTER' ) || defined( 'WP_REDIS_SERVERS' ) ) { - $parameters['db'] = $parameters['database']; + $to_load = []; - $is_cluster = defined( 'WP_REDIS_CLUSTER' ); - $clients = $is_cluster ? WP_REDIS_CLUSTER : WP_REDIS_SERVERS; + if ( ! class_exists( 'Credis_Client' ) ) { + $to_load[] = 'Client.php'; + } - foreach ( $clients as $index => &$connection_string ) { - $url_components = wp_parse_url( $connection_string ); - parse_str( $url_components['query'], $add_params ); + if ( + ( defined( 'WP_REDIS_SHARDS' ) || defined( 'WP_REDIS_SENTINEL' ) || defined( 'WP_REDIS_SERVERS' ) || defined( 'WP_REDIS_CLUSTER' ) ) && + ! class_exists( 'Credis_Cluster' ) + ) { + $to_load[] = 'Cluster.php'; - if ( ! $is_cluster && isset( $add_params['alias'] ) ) { - $add_params['master'] = 'master' === $add_params['alias']; + if ( defined( 'WP_REDIS_SENTINEL' ) && ! class_exists( 'Credis_Sentinel' ) ) { + $to_load[] = 'Sentinel.php'; } + } - $add_params['host'] = $url_components['host']; + foreach ( $to_load as $sub_path ) { + $path = $creds_path . $sub_path; - if ( ! isset( $add_params['alias'] ) ) { - $add_params['alias'] = "redis-$index"; + if ( file_exists( $path ) ) { + require_once $path; + } else { + throw new Exception( + 'Credis library not found. Re-install Redis Cache plugin or delete object-cache.php.' + ); } + } - $connection_string = array_merge( $parameters, $add_params ); + if ( defined( 'WP_REDIS_SHARDS' ) ) { + throw new Exception( + 'Sharding not supported by bundled Credis library. Please review your Redis Cache configuration.' + ); } - $this->redis = new Credis_Cluster( $clients ); + if ( defined( 'WP_REDIS_SENTINEL' ) ) { + if ( is_array( WP_REDIS_SERVERS ) && count( WP_REDIS_SERVERS ) > 1 ) { + throw new Exception( + 'Multipe sentinel servers are not supported by the bundled Credis library. Please review your Redis Cache configuration.' + ); + } - $args['servers'] = $clients; - } else { - $args = [ - 'host' => $parameters['scheme'] === 'unix' ? $parameters['path'] : $parameters['host'], - 'port' => $parameters['port'], - 'timeout' => $parameters['timeout'], - 'persistent' => null, - 'database' => $parameters['database'], - 'password' => isset( $parameters['password'] ) ? $parameters['password'] : null, - ]; + $connection_string = array_values( WP_REDIS_SERVERS )[0]; + $sentinel = new Credis_Sentinel( new Credis_Client( $connection_string ) ); + $this->redis = $sentinel->getCluster( WP_REDIS_SENTINEL ); + $args['servers'] = WP_REDIS_SERVERS; + } elseif ( defined( 'WP_REDIS_CLUSTER' ) || defined( 'WP_REDIS_SERVERS' ) ) { + $parameters['db'] = $parameters['database']; - $this->redis = new Credis_Client( ...array_values( $args ) ); - } + $is_cluster = defined( 'WP_REDIS_CLUSTER' ); + $clients = $is_cluster ? WP_REDIS_CLUSTER : WP_REDIS_SERVERS; - // Don't use PhpRedis if it is available. - $this->redis->forceStandalone(); + foreach ( $clients as $index => &$connection_string ) { + $url_components = wp_parse_url( $connection_string ); + parse_str( $url_components['query'], $add_params ); - $this->redis->connect(); + if ( ! $is_cluster && isset( $add_params['alias'] ) ) { + $add_params['master'] = 'master' === $add_params['alias']; + } - if ( $parameters['read_timeout'] ) { - $args['read_timeout'] = $parameters['read_timeout']; - $this->redis->setReadTimeout( $parameters['read_timeout'] ); - } + $add_params['host'] = $url_components['host']; - $this->diagnostics = array_merge( - [ 'client' => sprintf( '%s (v%s)', $client, Credis_Client::VERSION ) ], - $args - ); - } + if ( ! isset( $add_params['alias'] ) ) { + $add_params['alias'] = "redis-$index"; + } - /** - * Connect to Redis using HHVM's Redis extention. - * - * @param array $parameters Connection parameters built by the `build_parameters` method. - * @return void - */ - protected function connect_using_hhvm( $parameters ) { - $this->redis = new Redis(); + $connection_string = array_merge( $parameters, $add_params ); + } - // Adjust host and port if the scheme is `unix`. - if ( strcasecmp( 'unix', $parameters['scheme'] ) === 0 ) { - $parameters['host'] = 'unix://' . $parameters['path']; - $parameters['port'] = 0; - } + $this->redis = new Credis_Cluster( $clients ); - $this->redis->connect( - $parameters['host'], - $parameters['port'], - $parameters['timeout'], - null, - $parameters['retry_interval'] - ); + $args['servers'] = $clients; + } else { + $args = [ + 'host' => $parameters['scheme'] === 'unix' ? $parameters['path'] : $parameters['host'], + 'port' => $parameters['port'], + 'timeout' => $parameters['timeout'], + 'persistent' => null, + 'database' => $parameters['database'], + 'password' => isset( $parameters['password'] ) ? $parameters['password'] : null, + ]; + + $this->redis = new Credis_Client( ...array_values( $args ) ); + } - if ( $parameters['read_timeout'] ) { - $this->redis->setOption( Redis::OPT_READ_TIMEOUT, $parameters['read_timeout'] ); - } + // Don't use PhpRedis if it is available. + $this->redis->forceStandalone(); - if ( isset( $parameters['password'] ) ) { - $this->redis->auth( $parameters['password'] ); - } + $this->redis->connect(); - if ( isset( $parameters['database'] ) ) { - if ( ctype_digit( $parameters['database'] ) ) { - $parameters['database'] = intval( $parameters['database'] ); + if ( $parameters['read_timeout'] ) { + $args['read_timeout'] = $parameters['read_timeout']; + $this->redis->setReadTimeout( $parameters['read_timeout'] ); } - if ( $parameters['database'] ) { - $this->redis->select( $parameters['database'] ); - } + $this->diagnostics = array_merge( + [ 'client' => sprintf( '%s (v%s)', $client, Credis_Client::VERSION ) ], + $args + ); } - $this->diagnostics = array_merge( - [ 'client' => sprintf( 'HHVM Extension (v%s)', HHVM_VERSION ) ], - $parameters - ); - } + /** + * Connect to Redis using HHVM's Redis extention. + * + * @param array $parameters Connection parameters built by the `build_parameters` method. + * @return void + */ + protected function connect_using_hhvm( $parameters ) { + $this->redis = new Redis(); - /** - * Fetches Redis `INFO` mostly for server version. - * - * @return void - */ - public function fetch_info() { - $options = method_exists( $this->redis, 'getOptions' ) - ? $this->redis->getOptions() - : new stdClass(); + // Adjust host and port if the scheme is `unix`. + if ( strcasecmp( 'unix', $parameters['scheme'] ) === 0 ) { + $parameters['host'] = 'unix://' . $parameters['path']; + $parameters['port'] = 0; + } - if ( isset( $options->replication ) && $options->replication ) { - return; - } + $this->redis->connect( + $parameters['host'], + $parameters['port'], + $parameters['timeout'], + null, + $parameters['retry_interval'] + ); - if ( defined( 'WP_REDIS_CLUSTER' ) ) { - $info = $this->redis->info( current( array_values( WP_REDIS_CLUSTER ) ) ); - } else { - $info = $this->redis->info(); - } + if ( $parameters['read_timeout'] ) { + $this->redis->setOption( Redis::OPT_READ_TIMEOUT, $parameters['read_timeout'] ); + } - if ( isset( $info['redis_version'] ) ) { - $this->redis_version = $info['redis_version']; - } elseif ( isset( $info['Server']['redis_version'] ) ) { - $this->redis_version = $info['Server']['redis_version']; - } - } + if ( isset( $parameters['password'] ) ) { + $this->redis->auth( $parameters['password'] ); + } - /** - * Is Redis available? - * - * @return bool - */ - public function redis_status() { - return (bool) $this->redis_connected; - } + if ( isset( $parameters['database'] ) ) { + if ( ctype_digit( $parameters['database'] ) ) { + $parameters['database'] = intval( $parameters['database'] ); + } + + if ( $parameters['database'] ) { + $this->redis->select( $parameters['database'] ); + } + } - /** - * Returns the Redis instance. - * - * @return mixed - */ - public function redis_instance() { - return $this->redis; - } + $this->diagnostics = array_merge( + [ 'client' => sprintf( 'HHVM Extension (v%s)', HHVM_VERSION ) ], + $parameters + ); + } - /** - * Returns the Redis server version. - * - * @return null|string - */ - public function redis_version() { - return $this->redis_version; - } + /** + * Fetches Redis `INFO` mostly for server version. + * + * @return void + */ + public function fetch_info() { + $options = method_exists( $this->redis, 'getOptions' ) + ? $this->redis->getOptions() + : new stdClass(); - /** - * Adds a value to cache. - * - * If the specified key already exists, the value is not stored and the function - * returns false. - * - * @param string $key The key under which to store the value. - * @param mixed $value The value to store. - * @param string $group The group value appended to the $key. - * @param int $expiration The expiration time, defaults to 0. - * @return bool Returns TRUE on success or FALSE on failure. - */ - public function add( $key, $value, $group = 'default', $expiration = 0 ) { - return $this->add_or_replace( true, $key, $value, $group, $expiration ); - } + if ( isset( $options->replication ) && $options->replication ) { + return; + } - /** - * Replace a value in the cache. - * - * If the specified key doesn't exist, the value is not stored and the function - * returns false. - * - * @param string $key The key under which to store the value. - * @param mixed $value The value to store. - * @param string $group The group value appended to the $key. - * @param int $expiration The expiration time, defaults to 0. - * @return bool Returns TRUE on success or FALSE on failure. - */ - public function replace( $key, $value, $group = 'default', $expiration = 0 ) { - return $this->add_or_replace( false, $key, $value, $group, $expiration ); - } + if ( defined( 'WP_REDIS_CLUSTER' ) ) { + $info = $this->redis->info( current( array_values( WP_REDIS_CLUSTER ) ) ); + } else { + $info = $this->redis->info(); + } - /** - * Add or replace a value in the cache. - * - * Add does not set the value if the key exists; replace does not replace if the value doesn't exist. - * - * @param bool $add True if should only add if value doesn't exist, false to only add when value already exists. - * @param string $key The key under which to store the value. - * @param mixed $value The value to store. - * @param string $group The group value appended to the $key. - * @param int $expiration The expiration time, defaults to 0. - * @return bool Returns TRUE on success or FALSE on failure. - */ - protected function add_or_replace( $add, $key, $value, $group = 'default', $expiration = 0 ) { - $cache_addition_suspended = function_exists( 'wp_suspend_cache_addition' ) + if ( isset( $info['redis_version'] ) ) { + $this->redis_version = $info['redis_version']; + } elseif ( isset( $info['Server']['redis_version'] ) ) { + $this->redis_version = $info['Server']['redis_version']; + } + } + + /** + * Is Redis available? + * + * @return bool + */ + public function redis_status() { + return (bool) $this->redis_connected; + } + + /** + * Returns the Redis instance. + * + * @return mixed + */ + public function redis_instance() { + return $this->redis; + } + + /** + * Returns the Redis server version. + * + * @return null|string + */ + public function redis_version() { + return $this->redis_version; + } + + /** + * Adds a value to cache. + * + * If the specified key already exists, the value is not stored and the function + * returns false. + * + * @param string $key The key under which to store the value. + * @param mixed $value The value to store. + * @param string $group The group value appended to the $key. + * @param int $expiration The expiration time, defaults to 0. + * @return bool Returns TRUE on success or FALSE on failure. + */ + public function add( $key, $value, $group = 'default', $expiration = 0 ) { + return $this->add_or_replace( true, $key, $value, $group, $expiration ); + } + + /** + * Replace a value in the cache. + * + * If the specified key doesn't exist, the value is not stored and the function + * returns false. + * + * @param string $key The key under which to store the value. + * @param mixed $value The value to store. + * @param string $group The group value appended to the $key. + * @param int $expiration The expiration time, defaults to 0. + * @return bool Returns TRUE on success or FALSE on failure. + */ + public function replace( $key, $value, $group = 'default', $expiration = 0 ) { + return $this->add_or_replace( false, $key, $value, $group, $expiration ); + } + + /** + * Add or replace a value in the cache. + * + * Add does not set the value if the key exists; replace does not replace if the value doesn't exist. + * + * @param bool $add True if should only add if value doesn't exist, false to only add when value already exists. + * @param string $key The key under which to store the value. + * @param mixed $value The value to store. + * @param string $group The group value appended to the $key. + * @param int $expiration The expiration time, defaults to 0. + * @return bool Returns TRUE on success or FALSE on failure. + */ + protected function add_or_replace( $add, $key, $value, $group = 'default', $expiration = 0 ) { + $cache_addition_suspended = function_exists( 'wp_suspend_cache_addition' ) ? wp_suspend_cache_addition() : false; - if ( $add && $cache_addition_suspended ) { - return false; - } + if ( $add && $cache_addition_suspended ) { + return false; + } - $result = true; - $derived_key = $this->build_key( $key, $group ); + $result = true; + $derived_key = $this->build_key( $key, $group ); - // Save if group not excluded and redis is up. - if ( ! $this->is_ignored_group( $group ) && $this->redis_status() ) { - try { - $expiration = apply_filters( 'redis_cache_expiration', $this->validate_expiration( $expiration ), $key, $group ); - $start_time = microtime( true ); + // Save if group not excluded and redis is up. + if ( ! $this->is_ignored_group( $group ) && $this->redis_status() ) { + try { + $expiration = apply_filters( 'redis_cache_expiration', $this->validate_expiration( $expiration ), $key, $group ); + $start_time = microtime( true ); - if ( $add ) { - $args = [ $derived_key, $this->maybe_serialize( $value ) ]; + if ( $add ) { + $args = [ $derived_key, $this->maybe_serialize( $value ) ]; - if ( $this->redis instanceof Predis\Client ) { - $args[] = 'nx'; + if ( $this->redis instanceof Predis\Client ) { + $args[] = 'nx'; - if ( $expiration ) { - $args[] = 'ex'; - $args[] = $expiration; - } - } else { - if ( $expiration ) { - $args[] = [ - 'nx', - 'ex' => $expiration, - ]; + if ( $expiration ) { + $args[] = 'ex'; + $args[] = $expiration; + } } else { - $args[] = [ 'nx' ]; + if ( $expiration ) { + $args[] = [ + 'nx', + 'ex' => $expiration, + ]; + } else { + $args[] = [ 'nx' ]; + } } - } - $result = $this->parse_redis_response( - $this->redis->set( ...$args ) - ); + $result = $this->parse_redis_response( + $this->redis->set( ...$args ) + ); - if ( ! $result ) { - return false; + if ( ! $result ) { + return false; + } + } elseif ( $expiration ) { + $result = $this->parse_redis_response( $this->redis->setex( $derived_key, $expiration, $this->maybe_serialize( $value ) ) ); + } else { + $result = $this->parse_redis_response( $this->redis->set( $derived_key, $this->maybe_serialize( $value ) ) ); } - } elseif ( $expiration ) { - $result = $this->parse_redis_response( $this->redis->setex( $derived_key, $expiration, $this->maybe_serialize( $value ) ) ); - } else { - $result = $this->parse_redis_response( $this->redis->set( $derived_key, $this->maybe_serialize( $value ) ) ); - } - $execute_time = microtime( true ) - $start_time; + $execute_time = microtime( true ) - $start_time; - $this->cache_calls++; - $this->cache_time += $execute_time; - } catch ( Exception $exception ) { - $this->handle_exception( $exception ); + $this->cache_calls++; + $this->cache_time += $execute_time; + } catch ( Exception $exception ) { + $this->handle_exception( $exception ); - return false; + return false; + } } - } - - $exists = isset( $this->cache[ $derived_key ] ); - - if ( (bool) $add === $exists ) { - return false; - } - if ( $result ) { - $this->add_to_internal_cache( $derived_key, $value ); - } + $exists = isset( $this->cache[ $derived_key ] ); - return $result; - } + if ( (bool) $add === $exists ) { + return false; + } - /** - * Remove the item from the cache. - * - * @param string $key The key under which to store the value. - * @param string $group The group value appended to the $key. - * @return bool Returns TRUE on success or FALSE on failure. - */ - public function delete( $key, $group = 'default' ) { - $result = false; - $derived_key = $this->build_key( $key, $group ); + if ( $result ) { + $this->add_to_internal_cache( $derived_key, $value ); + } - if ( isset( $this->cache[ $derived_key ] ) ) { - unset( $this->cache[ $derived_key ] ); - $result = true; + return $result; } - $start_time = microtime( true ); - - if ( $this->redis_status() && ! $this->is_ignored_group( $group ) ) { - try { - $result = $this->parse_redis_response( $this->redis->del( $derived_key ) ); - } catch ( Exception $exception ) { - $this->handle_exception( $exception ); + /** + * Remove the item from the cache. + * + * @param string $key The key under which to store the value. + * @param string $group The group value appended to the $key. + * @return bool Returns TRUE on success or FALSE on failure. + */ + public function delete( $key, $group = 'default' ) { + $result = false; + $derived_key = $this->build_key( $key, $group ); - return false; + if ( isset( $this->cache[ $derived_key ] ) ) { + unset( $this->cache[ $derived_key ] ); + $result = true; } - } - $execute_time = microtime( true ) - $start_time; + $start_time = microtime( true ); - $this->cache_calls++; - $this->cache_time += $execute_time; + if ( $this->redis_status() && ! $this->is_ignored_group( $group ) ) { + try { + $result = $this->parse_redis_response( $this->redis->del( $derived_key ) ); + } catch ( Exception $exception ) { + $this->handle_exception( $exception ); - if ( function_exists( 'do_action' ) ) { - do_action( 'redis_object_cache_delete', $key, $group, $execute_time ); - } + return false; + } + } - return (bool) $result; - } + $execute_time = microtime( true ) - $start_time; - /** - * Invalidate all items in the cache. If `WP_REDIS_SELECTIVE_FLUSH` is `true`, - * only keys prefixed with the `WP_REDIS_PREFIX` are flushed. - * - * @param int $delay Number of seconds to wait before invalidating the items. - * @return bool Returns TRUE on success or FALSE on failure. - */ - public function flush( $delay = 0 ) { - $delay = abs( intval( $delay ) ); + $this->cache_calls++; + $this->cache_time += $execute_time; - if ( $delay ) { - sleep( $delay ); + if ( function_exists( 'do_action' ) ) { + do_action( 'redis_object_cache_delete', $key, $group, $execute_time ); + } + + return (bool) $result; } - $results = []; - $this->cache = array(); + /** + * Invalidate all items in the cache. If `WP_REDIS_SELECTIVE_FLUSH` is `true`, + * only keys prefixed with the `WP_REDIS_PREFIX` are flushed. + * + * @param int $delay Number of seconds to wait before invalidating the items. + * @return bool Returns TRUE on success or FALSE on failure. + */ + public function flush( $delay = 0 ) { + $delay = abs( intval( $delay ) ); - if ( $this->redis_status() ) { - $salt = defined( 'WP_REDIS_PREFIX' ) ? trim( WP_REDIS_PREFIX ) : null; - $selective = defined( 'WP_REDIS_SELECTIVE_FLUSH' ) ? WP_REDIS_SELECTIVE_FLUSH : null; + if ( $delay ) { + sleep( $delay ); + } - $start_time = microtime( true ); + $results = []; + $this->cache = array(); - if ( $salt && $selective ) { - $script = $this->get_flush_closure( $salt ); + if ( $this->redis_status() ) { + $salt = defined( 'WP_REDIS_PREFIX' ) ? trim( WP_REDIS_PREFIX ) : null; + $selective = defined( 'WP_REDIS_SELECTIVE_FLUSH' ) ? WP_REDIS_SELECTIVE_FLUSH : null; - if ( defined( 'WP_REDIS_CLUSTER' ) ) { - try { - foreach ( $this->redis->_masters() as $master ) { - $redis = new Redis(); - $redis->connect( $master[0], $master[1] ); - $results[] = $this->parse_redis_response( $script() ); - unset( $redis ); + $start_time = microtime( true ); + + if ( $salt && $selective ) { + $script = $this->get_flush_closure( $salt ); + + if ( defined( 'WP_REDIS_CLUSTER' ) ) { + try { + foreach ( $this->redis->_masters() as $master ) { + $redis = new Redis(); + $redis->connect( $master[0], $master[1] ); + $results[] = $this->parse_redis_response( $script() ); + unset( $redis ); + } + } catch ( Exception $exception ) { + $this->handle_exception( $exception ); + + return false; } - } catch ( Exception $exception ) { - $this->handle_exception( $exception ); + } else { + try { + $results[] = $this->parse_redis_response( $script() ); + } catch ( Exception $exception ) { + $this->handle_exception( $exception ); - return false; + return false; + } } } else { - try { - $results[] = $this->parse_redis_response( $script() ); - } catch ( Exception $exception ) { - $this->handle_exception( $exception ); + if ( defined( 'WP_REDIS_CLUSTER' ) ) { + try { + foreach ( $this->redis->_masters() as $master ) { + $results[] = $this->parse_redis_response( $this->redis->flushdb( $master ) ); + } + } catch ( Exception $exception ) { + $this->handle_exception( $exception ); + + return false; + } + } else { + try { + $results[] = $this->parse_redis_response( $this->redis->flushdb() ); + } catch ( Exception $exception ) { + $this->handle_exception( $exception ); - return false; + return false; + } } } - } else { - if ( defined( 'WP_REDIS_CLUSTER' ) ) { - try { - foreach ( $this->redis->_masters() as $master ) { - $results[] = $this->parse_redis_response( $this->redis->flushdb( $master ) ); - } - } catch ( Exception $exception ) { - $this->handle_exception( $exception ); - return false; - } - } else { - try { - $results[] = $this->parse_redis_response( $this->redis->flushdb() ); - } catch ( Exception $exception ) { - $this->handle_exception( $exception ); + if ( function_exists( 'do_action' ) ) { + $execute_time = microtime( true ) - $start_time; - return false; - } + do_action( 'redis_object_cache_flush', $results, $delay, $selective, $salt, $execute_time ); } } - if ( function_exists( 'do_action' ) ) { - $execute_time = microtime( true ) - $start_time; + if ( empty( $results ) ) { + return false; + } - do_action( 'redis_object_cache_flush', $results, $delay, $selective, $salt, $execute_time ); + foreach ( $results as $result ) { + if ( ! $result ) { + return false; + } } - } - if ( empty( $results ) ) { - return false; + return true; } - foreach ( $results as $result ) { - if ( ! $result ) { - return false; + /** + * Returns a closure to flush selectively. + * + * @param string $salt The salt to be used to differentiate. + * @return callable Generated callable executing the lua script. + */ + protected function get_flush_closure( $salt ) { + if ( $this->unflushable_groups ) { + return $this->lua_flush_extended_closure( $salt ); + } else { + return $this->lua_flush_closure( $salt ); } } - return true; - } - - /** - * Returns a closure to flush selectively. - * - * @param string $salt The salt to be used to differentiate. - * @return callable Generated callable executing the lua script. - */ - protected function get_flush_closure( $salt ) { - if ( $this->unflushable_groups ) { - return $this->lua_flush_extended_closure( $salt ); - } else { - return $this->lua_flush_closure( $salt ); + /** + * Quotes a string for usage in the `glob` function + * + * @param string $string The string to quote. + * @return string + */ + protected function glob_quote( $string ) { + $characters = [ '*', '+', '?', '!', '{', '}', '[', ']', '(', ')', '|', '@' ]; + + return str_replace( + $characters, + array_map( + function ( $character ) { + return "[{$character}]"; + }, + $characters + ), + $string + ); } - } - - /** - * Quotes a string for usage in the `glob` function - * - * @param string $string The string to quote. - * @return string - */ - protected function glob_quote( $string ) { - $characters = [ '*', '+', '?', '!', '{', '}', '[', ']', '(', ')', '|', '@' ]; - - return str_replace( - $characters, - array_map( - function ( $character ) { - return "[{$character}]"; - }, - $characters - ), - $string - ); - } - /** - * Returns a closure ready to be called to flush selectively ignoring unflushable groups. - * - * @param string $salt The salt to be used to differentiate. - * @return callable Generated callable executing the lua script. - */ - protected function lua_flush_closure( $salt ) { - $salt = $this->glob_quote( $salt ); + /** + * Returns a closure ready to be called to flush selectively ignoring unflushable groups. + * + * @param string $salt The salt to be used to differentiate. + * @return callable Generated callable executing the lua script. + */ + protected function lua_flush_closure( $salt ) { + $salt = $this->glob_quote( $salt ); - return function () use ( $salt ) { - $script = <<redis_version(), '5', '<' ) && version_compare( $this->redis_version(), '3.2', '>=' ) ) { - $script = 'redis.replicate_commands()' . "\n" . $script; - } + if ( version_compare( $this->redis_version(), '5', '<' ) && version_compare( $this->redis_version(), '3.2', '>=' ) ) { + $script = 'redis.replicate_commands()' . "\n" . $script; + } - $args = ( $this->redis instanceof Predis\Client ) + $args = ( $this->redis instanceof Predis\Client ) ? [ $script, 0 ] : [ $script ]; - return call_user_func_array( [ $this->redis, 'eval' ], $args ); - }; - } + return call_user_func_array( [ $this->redis, 'eval' ], $args ); + }; + } - /** - * Returns a closure ready to be called to flush selectively. - * - * @param string $salt The salt to be used to differentiate. - * @return callable Generated callable executing the lua script. - */ - protected function lua_flush_extended_closure( $salt ) { - $salt = $this->glob_quote( $salt ); + /** + * Returns a closure ready to be called to flush selectively. + * + * @param string $salt The salt to be used to differentiate. + * @return callable Generated callable executing the lua script. + */ + protected function lua_flush_extended_closure( $salt ) { + $salt = $this->glob_quote( $salt ); - return function () use ( $salt ) { - $salt_length = strlen( $salt ); + return function () use ( $salt ) { + $salt_length = strlen( $salt ); - $unflushable = array_map( - function ( $group ) { - return ":{$group}:"; - }, - $this->unflushable_groups - ); + $unflushable = array_map( + function ( $group ) { + return ":{$group}:"; + }, + $this->unflushable_groups + ); - $script = <<redis_version(), '5', '<' ) && version_compare( $this->redis_version(), '3.2', '>=' ) ) { - $script = 'redis.replicate_commands()' . "\n" . $script; - } + if ( version_compare( $this->redis_version(), '5', '<' ) && version_compare( $this->redis_version(), '3.2', '>=' ) ) { + $script = 'redis.replicate_commands()' . "\n" . $script; + } - $args = ( $this->redis instanceof Predis\Client ) + $args = ( $this->redis instanceof Predis\Client ) ? array_merge( [ $script, count( $unflushable ) ], $unflushable ) : [ $script, $unflushable, count( $unflushable ) ]; - return call_user_func_array( [ $this->redis, 'eval' ], $args ); - }; - } - - /** - * Retrieve object from cache. - * - * Gets an object from cache based on $key and $group. - * - * @param string $key The key under which to store the value. - * @param string $group The group value appended to the $key. - * @param string $force Optional. Whether to force a refetch rather than relying on the local - * cache. Default false. - * @param bool $found Optional. Whether the key was found in the cache. Disambiguates a return of - * false, a storable value. Passed by reference. Default null. - * @return bool|mixed Cached object value. - */ - public function get( $key, $group = 'default', $force = false, &$found = null ) { - $derived_key = $this->build_key( $key, $group ); - - if ( isset( $this->cache[ $derived_key ] ) && ! $force ) { - $found = true; - $this->cache_hits++; - - return $this->get_from_internal_cache( $derived_key ); - } elseif ( $this->is_ignored_group( $group ) || ! $this->redis_status() ) { - $found = false; - $this->cache_misses++; + return call_user_func_array( [ $this->redis, 'eval' ], $args ); + }; + } + + /** + * Retrieve object from cache. + * + * Gets an object from cache based on $key and $group. + * + * @param string $key The key under which to store the value. + * @param string $group The group value appended to the $key. + * @param string $force Optional. Whether to force a refetch rather than relying on the local + * cache. Default false. + * @param bool $found Optional. Whether the key was found in the cache. Disambiguates a return of + * false, a storable value. Passed by reference. Default null. + * @return bool|mixed Cached object value. + */ + public function get( $key, $group = 'default', $force = false, &$found = null ) { + $derived_key = $this->build_key( $key, $group ); + + if ( isset( $this->cache[ $derived_key ] ) && ! $force ) { + $found = true; + $this->cache_hits++; - return false; - } + return $this->get_from_internal_cache( $derived_key ); + } elseif ( $this->is_ignored_group( $group ) || ! $this->redis_status() ) { + $found = false; + $this->cache_misses++; - $start_time = microtime( true ); + return false; + } - try { - $result = $this->redis->get( $derived_key ); - } catch ( Exception $exception ) { - $this->handle_exception( $exception ); + $start_time = microtime( true ); - return false; - } + try { + $result = $this->redis->get( $derived_key ); + } catch ( Exception $exception ) { + $this->handle_exception( $exception ); - $execute_time = microtime( true ) - $start_time; + return false; + } - $this->cache_calls++; - $this->cache_time += $execute_time; + $execute_time = microtime( true ) - $start_time; - if ( $result === null || $result === false ) { - $found = false; - $this->cache_misses++; + $this->cache_calls++; + $this->cache_time += $execute_time; - return false; - } else { - $found = true; - $this->cache_hits++; - $value = $this->maybe_unserialize( $result ); - } + if ( $result === null || $result === false ) { + $found = false; + $this->cache_misses++; - $this->add_to_internal_cache( $derived_key, $value ); + return false; + } else { + $found = true; + $this->cache_hits++; + $value = $this->maybe_unserialize( $result ); + } - if ( function_exists( 'do_action' ) ) { - do_action( 'redis_object_cache_get', $key, $value, $group, $force, $found, $execute_time ); - } + $this->add_to_internal_cache( $derived_key, $value ); - if ( function_exists( 'apply_filters' ) && function_exists( 'has_filter' ) ) { - if ( has_filter( 'redis_object_cache_get_value' ) ) { - return apply_filters( 'redis_object_cache_get_value', $value, $key, $group, $force, $found ); + if ( function_exists( 'do_action' ) ) { + do_action( 'redis_object_cache_get', $key, $value, $group, $force, $found, $execute_time ); } - } - return $value; - } + if ( function_exists( 'apply_filters' ) && function_exists( 'has_filter' ) ) { + if ( has_filter( 'redis_object_cache_get_value' ) ) { + return apply_filters( 'redis_object_cache_get_value', $value, $key, $group, $force, $found ); + } + } - /** - * Retrieves multiple values from the cache in one call. - * - * @param array $keys Array of keys under which the cache contents are stored. - * @param string $group Optional. Where the cache contents are grouped. Default empty. - * @param bool $force Optional. Whether to force an update of the local cache - * from the persistent cache. Default false. - * @return array Array of values organized into groups. - */ - public function get_multiple( $keys, $group = 'default', $force = false ) { - if ( ! is_array( $keys ) ) { - return false; + return $value; } - $cache = array(); - $derived_keys = array(); + /** + * Retrieves multiple values from the cache in one call. + * + * @param array $keys Array of keys under which the cache contents are stored. + * @param string $group Optional. Where the cache contents are grouped. Default empty. + * @param bool $force Optional. Whether to force an update of the local cache + * from the persistent cache. Default false. + * @return array Array of values organized into groups. + */ + public function get_multiple( $keys, $group = 'default', $force = false ) { + if ( ! is_array( $keys ) ) { + return false; + } - foreach ( $keys as $key ) { - $derived_keys[ $key ] = $this->build_key( $key, $group ); - } + $cache = array(); + $derived_keys = array(); - if ( $this->is_ignored_group( $group ) || ! $this->redis_status() ) { foreach ( $keys as $key ) { - $cache[ $key ] = $this->get_from_internal_cache( $derived_keys[ $key ] ); - $cache[ $key ] === false ? $this->cache_misses++ : $this->cache_hits++; + $derived_keys[ $key ] = $this->build_key( $key, $group ); } - return $cache; - } + if ( $this->is_ignored_group( $group ) || ! $this->redis_status() ) { + foreach ( $keys as $key ) { + $cache[ $key ] = $this->get_from_internal_cache( $derived_keys[ $key ] ); + $cache[ $key ] === false ? $this->cache_misses++ : $this->cache_hits++; + } - if ( ! $force ) { - foreach ( $keys as $key ) { - $value = $this->get_from_internal_cache( $derived_keys[ $key ] ); + return $cache; + } - if ( $value === false ) { - $this->cache_misses++; - } else { - $cache[ $key ] = $value; - $this->cache_hits++; + if ( ! $force ) { + foreach ( $keys as $key ) { + $value = $this->get_from_internal_cache( $derived_keys[ $key ] ); + + if ( $value === false ) { + $this->cache_misses++; + } else { + $cache[ $key ] = $value; + $this->cache_hits++; + } } } - } - $remaining_keys = array_filter( - $keys, - function ( $key ) use ( $cache ) { - return ! isset( $cache[ $key ] ); - } - ); + $remaining_keys = array_filter( + $keys, + function ( $key ) use ( $cache ) { + return ! isset( $cache[ $key ] ); + } + ); - if ( empty( $remaining_keys ) ) { - return $cache; - } + if ( empty( $remaining_keys ) ) { + return $cache; + } - $start_time = microtime( true ); + $start_time = microtime( true ); - try { - $remaining_ids = array_map( - function ( $key ) use ( $derived_keys ) { - return $derived_keys[ $key ]; - }, - $remaining_keys - ); + try { + $remaining_ids = array_map( + function ( $key ) use ( $derived_keys ) { + return $derived_keys[ $key ]; + }, + $remaining_keys + ); - $results = array_combine( - $remaining_keys, - $this->redis->mget( $remaining_ids ) - ); - } catch ( Exception $exception ) { - $this->handle_exception( $exception ); + $results = array_combine( + $remaining_keys, + $this->redis->mget( $remaining_ids ) + ); + } catch ( Exception $exception ) { + $this->handle_exception( $exception ); - $cache = array_fill( 0, count( $derived_keys ) - 1, false ); - } + $cache = array_fill( 0, count( $derived_keys ) - 1, false ); + } - $execute_time = microtime( true ) - $start_time; + $execute_time = microtime( true ) - $start_time; - $this->cache_calls++; - $this->cache_time += $execute_time; + $this->cache_calls++; + $this->cache_time += $execute_time; - foreach ( $results as $key => $value ) { - if ( $value === null || $value === false ) { - $cache[ $key ] = false; - $this->cache_misses++; - } else { - $cache[ $key ] = $this->maybe_unserialize( $value ); - $this->add_to_internal_cache( $derived_keys[ $key ], $cache[ $key ] ); + foreach ( $results as $key => $value ) { + if ( $value === null || $value === false ) { + $cache[ $key ] = false; + $this->cache_misses++; + } else { + $cache[ $key ] = $this->maybe_unserialize( $value ); + $this->add_to_internal_cache( $derived_keys[ $key ], $cache[ $key ] ); - $this->cache_hits++; + $this->cache_hits++; + } } - } - if ( function_exists( 'do_action' ) ) { - do_action( 'redis_object_cache_get_multiple', $keys, $cache, $group, $force, $execute_time ); - } + if ( function_exists( 'do_action' ) ) { + do_action( 'redis_object_cache_get_multiple', $keys, $cache, $group, $force, $execute_time ); + } - if ( function_exists( 'apply_filters' ) && function_exists( 'has_filter' ) ) { - if ( has_filter( 'redis_object_cache_get_value' ) ) { - foreach ( $cache as $key => $value ) { - $cache[ $key ] = apply_filters( 'redis_object_cache_get_value', $value, $key, $group, $force ); + if ( function_exists( 'apply_filters' ) && function_exists( 'has_filter' ) ) { + if ( has_filter( 'redis_object_cache_get_value' ) ) { + foreach ( $cache as $key => $value ) { + $cache[ $key ] = apply_filters( 'redis_object_cache_get_value', $value, $key, $group, $force ); + } } } + + return $cache; } - return $cache; - } + /** + * Sets a value in cache. + * + * The value is set whether or not this key already exists in Redis. + * + * @param string $key The key under which to store the value. + * @param mixed $value The value to store. + * @param string $group The group value appended to the $key. + * @param int $expiration The expiration time, defaults to 0. + * @return bool Returns TRUE on success or FALSE on failure. + */ + public function set( $key, $value, $group = 'default', $expiration = 0 ) { + $result = true; + $derived_key = $this->build_key( $key, $group ); - /** - * Sets a value in cache. - * - * The value is set whether or not this key already exists in Redis. - * - * @param string $key The key under which to store the value. - * @param mixed $value The value to store. - * @param string $group The group value appended to the $key. - * @param int $expiration The expiration time, defaults to 0. - * @return bool Returns TRUE on success or FALSE on failure. - */ - public function set( $key, $value, $group = 'default', $expiration = 0 ) { - $result = true; - $derived_key = $this->build_key( $key, $group ); + $start_time = microtime( true ); - $start_time = microtime( true ); + // Save if group not excluded from redis and redis is up. + if ( ! $this->is_ignored_group( $group ) && $this->redis_status() ) { + $expiration = apply_filters( 'redis_cache_expiration', $this->validate_expiration( $expiration ), $key, $group ); - // Save if group not excluded from redis and redis is up. - if ( ! $this->is_ignored_group( $group ) && $this->redis_status() ) { - $expiration = apply_filters( 'redis_cache_expiration', $this->validate_expiration( $expiration ), $key, $group ); + try { + if ( $expiration ) { + $result = $this->parse_redis_response( $this->redis->setex( $derived_key, $expiration, $this->maybe_serialize( $value ) ) ); + } else { + $result = $this->parse_redis_response( $this->redis->set( $derived_key, $this->maybe_serialize( $value ) ) ); + } + } catch ( Exception $exception ) { + $this->handle_exception( $exception ); - try { - if ( $expiration ) { - $result = $this->parse_redis_response( $this->redis->setex( $derived_key, $expiration, $this->maybe_serialize( $value ) ) ); - } else { - $result = $this->parse_redis_response( $this->redis->set( $derived_key, $this->maybe_serialize( $value ) ) ); + return false; } - } catch ( Exception $exception ) { - $this->handle_exception( $exception ); - return false; + $this->cache_calls++; + $this->cache_time += ( microtime( true ) - $start_time ); } - $this->cache_calls++; - $this->cache_time += ( microtime( true ) - $start_time ); - } + // If the set was successful, or we didn't go to redis. + if ( $result ) { + $this->add_to_internal_cache( $derived_key, $value ); + } - // If the set was successful, or we didn't go to redis. - if ( $result ) { - $this->add_to_internal_cache( $derived_key, $value ); - } + if ( function_exists( 'do_action' ) ) { + $execute_time = microtime( true ) - $start_time; - if ( function_exists( 'do_action' ) ) { - $execute_time = microtime( true ) - $start_time; + do_action( 'redis_object_cache_set', $key, $value, $group, $expiration, $execute_time ); + } - do_action( 'redis_object_cache_set', $key, $value, $group, $expiration, $execute_time ); + return $result; } - return $result; - } - - /** - * Increment a Redis counter by the amount specified - * - * @param string $key The key name. - * @param int $offset Optional. The increment. Defaults to 1. - * @param string $group Optional. The key group. Default is 'default'. - * @return int|bool - */ - public function increment( $key, $offset = 1, $group = 'default' ) { - $offset = (int) $offset; - $derived_key = $this->build_key( $key, $group ); - - // If group is a non-Redis group, save to internal cache, not Redis. - if ( $this->is_ignored_group( $group ) || ! $this->redis_status() ) { - $value = $this->get_from_internal_cache( $derived_key ); - $value += $offset; - $this->add_to_internal_cache( $derived_key, $value ); + /** + * Increment a Redis counter by the amount specified + * + * @param string $key The key name. + * @param int $offset Optional. The increment. Defaults to 1. + * @param string $group Optional. The key group. Default is 'default'. + * @return int|bool + */ + public function increment( $key, $offset = 1, $group = 'default' ) { + $offset = (int) $offset; + $derived_key = $this->build_key( $key, $group ); - return $value; - } + // If group is a non-Redis group, save to internal cache, not Redis. + if ( $this->is_ignored_group( $group ) || ! $this->redis_status() ) { + $value = $this->get_from_internal_cache( $derived_key ); + $value += $offset; + $this->add_to_internal_cache( $derived_key, $value ); - $start_time = microtime( true ); + return $value; + } - try { - $result = $this->parse_redis_response( $this->redis->incrBy( $derived_key, $offset ) ); + $start_time = microtime( true ); - $this->add_to_internal_cache( $derived_key, (int) $this->redis->get( $derived_key ) ); - } catch ( Exception $exception ) { - $this->handle_exception( $exception ); + try { + $result = $this->parse_redis_response( $this->redis->incrBy( $derived_key, $offset ) ); - return false; - } + $this->add_to_internal_cache( $derived_key, (int) $this->redis->get( $derived_key ) ); + } catch ( Exception $exception ) { + $this->handle_exception( $exception ); - $execute_time = microtime( true ) - $start_time; + return false; + } - $this->cache_calls += 2; - $this->cache_time += $execute_time; + $execute_time = microtime( true ) - $start_time; - return $result; - } + $this->cache_calls += 2; + $this->cache_time += $execute_time; + + return $result; + } + + /** + * Alias of `increment()`. + * + * @see self::increment() + * @param string $key The key name. + * @param int $offset Optional. The increment. Defaults to 1. + * @param string $group Optional. The key group. Default is 'default'. + * @return int|bool + */ + public function incr( $key, $offset = 1, $group = 'default' ) { + return $this->increment( $key, $offset, $group ); + } + + /** + * Decrement a Redis counter by the amount specified + * + * @param string $key The key name. + * @param int $offset Optional. The decrement. Defaults to 1. + * @param string $group Optional. The key group. Default is 'default'. + * @return int|bool + */ + public function decrement( $key, $offset = 1, $group = 'default' ) { + $derived_key = $this->build_key( $key, $group ); + $offset = (int) $offset; + + // If group is a non-Redis group, save to internal cache, not Redis. + if ( $this->is_ignored_group( $group ) || ! $this->redis_status() ) { + $value = $this->get_from_internal_cache( $derived_key ); + $value -= $offset; + $this->add_to_internal_cache( $derived_key, $value ); + + return $value; + } - /** - * Alias of `increment()`. - * - * @see self::increment() - * @param string $key The key name. - * @param int $offset Optional. The increment. Defaults to 1. - * @param string $group Optional. The key group. Default is 'default'. - * @return int|bool - */ - public function incr( $key, $offset = 1, $group = 'default' ) { - return $this->increment( $key, $offset, $group ); - } + $start_time = microtime( true ); - /** - * Decrement a Redis counter by the amount specified - * - * @param string $key The key name. - * @param int $offset Optional. The decrement. Defaults to 1. - * @param string $group Optional. The key group. Default is 'default'. - * @return int|bool - */ - public function decrement( $key, $offset = 1, $group = 'default' ) { - $derived_key = $this->build_key( $key, $group ); - $offset = (int) $offset; - - // If group is a non-Redis group, save to internal cache, not Redis. - if ( $this->is_ignored_group( $group ) || ! $this->redis_status() ) { - $value = $this->get_from_internal_cache( $derived_key ); - $value -= $offset; - $this->add_to_internal_cache( $derived_key, $value ); + try { + // Save to Redis. + $result = $this->parse_redis_response( $this->redis->decrBy( $derived_key, $offset ) ); - return $value; - } + $this->add_to_internal_cache( $derived_key, (int) $this->redis->get( $derived_key ) ); + } catch ( Exception $exception ) { + $this->handle_exception( $exception ); - $start_time = microtime( true ); + return false; + } - try { - // Save to Redis. - $result = $this->parse_redis_response( $this->redis->decrBy( $derived_key, $offset ) ); + $execute_time = microtime( true ) - $start_time; - $this->add_to_internal_cache( $derived_key, (int) $this->redis->get( $derived_key ) ); - } catch ( Exception $exception ) { - $this->handle_exception( $exception ); + $this->cache_calls += 2; + $this->cache_time += $execute_time; - return false; + return $result; } - $execute_time = microtime( true ) - $start_time; + /** + * Render data about current cache requests + * Used by the Debug bar plugin + * + * @return void + */ + public function stats() { + $bytes = strlen( serialize( $wp_object_cache->cache ) ); // phpcs:ignore WordPress.PHP.DiscouragedPHPFunctions.serialize_serialize - $this->cache_calls += 2; - $this->cache_time += $execute_time; - - return $result; - } - - /** - * Render data about current cache requests - * Used by the Debug bar plugin - * - * @return void - */ - public function stats() { - $bytes = strlen( serialize( $wp_object_cache->cache ) ); // phpcs:ignore WordPress.PHP.DiscouragedPHPFunctions.serialize_serialize - - ?> + ?>

Redis Status: redis_status() ? 'Connected' : 'Not connected'; ?> @@ -1610,408 +1608,410 @@ public function stats() { Cache Size: kB

- cache_hits + $this->cache_misses; - - $bytes = array_map( - function ( $keys ) { - // phpcs:ignore WordPress.PHP.DiscouragedPHPFunctions.serialize_serialize - return strlen( serialize( $keys ) ); - }, - $this->cache - ); - - return (object) [ - 'hits' => $this->cache_hits, - 'misses' => $this->cache_misses, - 'ratio' => $total > 0 ? round( $this->cache_hits / ( $total / 100 ), 1 ) : 100, - 'bytes' => array_sum( $bytes ), - 'time' => $this->cache_time, - 'calls' => $this->cache_calls, - 'groups' => (object) [ - 'global' => $this->global_groups, - 'non_persistent' => $this->ignored_groups, - 'unflushable' => $this->unflushable_groups, - ], - 'errors' => empty( $this->errors ) ? null : $this->errors, - 'meta' => [ - 'Client' => $this->diagnostics['client'] ?: 'Unknown', - 'Redis Version' => $this->redis_version, - ], - ]; - } - - /** - * Builds a key for the cached object using the prefix, group and key. - * - * @param string $key The key under which to store the value. - * @param string $group The group value appended to the $key. - * - * @return string - */ - public function build_key( $key, $group = 'default' ) { - if ( empty( $group ) ) { - $group = 'default'; + is_global_group( $group ) ? $this->global_prefix : $this->blog_prefix; + /** + * Returns various information about the object cache. + * + * @return object + */ + public function info() { + $total = $this->cache_hits + $this->cache_misses; - $key = $this->sanitize_key_part( $key ); - $group = $this->sanitize_key_part( $group ); - - $prefix = trim( $prefix, '_-:$' ); + $bytes = array_map( + function ( $keys ) { + // phpcs:ignore WordPress.PHP.DiscouragedPHPFunctions.serialize_serialize + return strlen( serialize( $keys ) ); + }, + $this->cache + ); - return "{$salt}{$prefix}:{$group}:{$key}"; - } + return (object) [ + 'hits' => $this->cache_hits, + 'misses' => $this->cache_misses, + 'ratio' => $total > 0 ? round( $this->cache_hits / ( $total / 100 ), 1 ) : 100, + 'bytes' => array_sum( $bytes ), + 'time' => $this->cache_time, + 'calls' => $this->cache_calls, + 'groups' => (object) [ + 'global' => $this->global_groups, + 'non_persistent' => $this->ignored_groups, + 'unflushable' => $this->unflushable_groups, + ], + 'errors' => empty( $this->errors ) ? null : $this->errors, + 'meta' => [ + 'Client' => $this->diagnostics['client'] ?: 'Unknown', + 'Redis Version' => $this->redis_version, + ], + ]; + } - /** - * Replaces the set group separator by another one - * - * @param string $part The string to sanitize. - * @return string Sanitized string. - */ - protected function sanitize_key_part( $part ) { - return str_replace( ':', '-', $part ); - } + /** + * Builds a key for the cached object using the prefix, group and key. + * + * @param string $key The key under which to store the value. + * @param string $group The group value appended to the $key. + * + * @return string + */ + public function build_key( $key, $group = 'default' ) { + if ( empty( $group ) ) { + $group = 'default'; + } - /** - * Checks if the given group is part the ignored group array - * - * @param string $group Name of the group to check. - * @return bool - */ - protected function is_ignored_group( $group ) { - return in_array( $this->sanitize_key_part( $group ), $this->ignored_groups, true ); - } + $salt = defined( 'WP_REDIS_PREFIX' ) ? trim( WP_REDIS_PREFIX ) : ''; + $prefix = $this->is_global_group( $group ) ? $this->global_prefix : $this->blog_prefix; + + $key = $this->sanitize_key_part( $key ); + $group = $this->sanitize_key_part( $group ); + + $prefix = trim( $prefix, '_-:$' ); + + return "{$salt}{$prefix}:{$group}:{$key}"; + } + + /** + * Replaces the set group separator by another one + * + * @param string $part The string to sanitize. + * @return string Sanitized string. + */ + protected function sanitize_key_part( $part ) { + return str_replace( ':', '-', $part ); + } + + /** + * Checks if the given group is part the ignored group array + * + * @param string $group Name of the group to check. + * @return bool + */ + protected function is_ignored_group( $group ) { + return in_array( $this->sanitize_key_part( $group ), $this->ignored_groups, true ); + } + + /** + * Checks if the given group is part the global group array + * + * @param string $group Name of the group to check. + * @return bool + */ + protected function is_global_group( $group ) { + return in_array( $this->sanitize_key_part( $group ), $this->global_groups, true ); + } + + /** + * Checks if the given group is part the unflushable group array + * + * @param string $group Name of the group to check. + * @return bool + */ + protected function is_unflushable_group( $group ) { + return in_array( $this->sanitize_key_part( $group ), $this->unflushable_groups, true ); + } + + /** + * Convert Redis responses into something meaningful + * + * @param mixed $response Response sent from the redis instance. + * @return mixed + */ + protected function parse_redis_response( $response ) { + if ( is_bool( $response ) ) { + return $response; + } - /** - * Checks if the given group is part the global group array - * - * @param string $group Name of the group to check. - * @return bool - */ - protected function is_global_group( $group ) { - return in_array( $this->sanitize_key_part( $group ), $this->global_groups, true ); - } + if ( is_numeric( $response ) ) { + return $response; + } - /** - * Checks if the given group is part the unflushable group array - * - * @param string $group Name of the group to check. - * @return bool - */ - protected function is_unflushable_group( $group ) { - return in_array( $this->sanitize_key_part( $group ), $this->unflushable_groups, true ); - } + if ( is_object( $response ) && method_exists( $response, 'getPayload' ) ) { + return $response->getPayload() === 'OK'; + } - /** - * Convert Redis responses into something meaningful - * - * @param mixed $response Response sent from the redis instance. - * @return mixed - */ - protected function parse_redis_response( $response ) { - if ( is_bool( $response ) ) { - return $response; + return false; } - if ( is_numeric( $response ) ) { - return $response; - } + /** + * Simple wrapper for saving object to the internal cache. + * + * @param string $derived_key Key to save value under. + * @param mixed $value Object value. + */ + public function add_to_internal_cache( $derived_key, $value ) { + if ( is_object( $value ) ) { + $value = clone $value; + } - if ( is_object( $response ) && method_exists( $response, 'getPayload' ) ) { - return $response->getPayload() === 'OK'; + $this->cache[ $derived_key ] = $value; } - return false; - } - - /** - * Simple wrapper for saving object to the internal cache. - * - * @param string $derived_key Key to save value under. - * @param mixed $value Object value. - */ - public function add_to_internal_cache( $derived_key, $value ) { - if ( is_object( $value ) ) { - $value = clone $value; - } + /** + * Get a value specifically from the internal, run-time cache, not Redis. + * + * @param int|string $derived_key Key value. + * + * @return bool|mixed Value on success; false on failure. + */ + public function get_from_internal_cache( $derived_key ) { + if ( ! isset( $this->cache[ $derived_key ] ) ) { + return false; + } - $this->cache[ $derived_key ] = $value; - } + if ( is_object( $this->cache[ $derived_key ] ) ) { + return clone $this->cache[ $derived_key ]; + } - /** - * Get a value specifically from the internal, run-time cache, not Redis. - * - * @param int|string $derived_key Key value. - * - * @return bool|mixed Value on success; false on failure. - */ - public function get_from_internal_cache( $derived_key ) { - if ( ! isset( $this->cache[ $derived_key ] ) ) { - return false; + return $this->cache[ $derived_key ]; } - if ( is_object( $this->cache[ $derived_key ] ) ) { - return clone $this->cache[ $derived_key ]; - } + /** + * In multisite, switch blog prefix when switching blogs + * + * @param int $_blog_id Blog ID. + * @return bool + */ + public function switch_to_blog( $_blog_id ) { + if ( ! function_exists( 'is_multisite' ) || ! is_multisite() ) { + return false; + } - return $this->cache[ $derived_key ]; - } + $this->blog_prefix = $_blog_id; - /** - * In multisite, switch blog prefix when switching blogs - * - * @param int $_blog_id Blog ID. - * @return bool - */ - public function switch_to_blog( $_blog_id ) { - if ( ! function_exists( 'is_multisite' ) || ! is_multisite() ) { - return false; + return true; } - $this->blog_prefix = $_blog_id; + /** + * Sets the list of global groups. + * + * @param array $groups List of groups that are global. + */ + public function add_global_groups( $groups ) { + $groups = (array) $groups; - return true; - } + if ( $this->redis_status() ) { + $this->global_groups = array_unique( array_merge( $this->global_groups, $groups ) ); + } else { + $this->ignored_groups = array_unique( array_merge( $this->ignored_groups, $groups ) ); + } + } - /** - * Sets the list of global groups. - * - * @param array $groups List of groups that are global. - */ - public function add_global_groups( $groups ) { - $groups = (array) $groups; + /** + * Sets the list of groups not to be cached by Redis. + * + * @param array $groups List of groups that are to be ignored. + */ + public function add_non_persistent_groups( $groups ) { + $groups = (array) $groups; - if ( $this->redis_status() ) { - $this->global_groups = array_unique( array_merge( $this->global_groups, $groups ) ); - } else { $this->ignored_groups = array_unique( array_merge( $this->ignored_groups, $groups ) ); } - } - - /** - * Sets the list of groups not to be cached by Redis. - * - * @param array $groups List of groups that are to be ignored. - */ - public function add_non_persistent_groups( $groups ) { - $groups = (array) $groups; - - $this->ignored_groups = array_unique( array_merge( $this->ignored_groups, $groups ) ); - } - - /** - * Sets the list of groups not to flushed cached. - * - * @param array $groups List of groups that are unflushable. - */ - public function add_unflushable_groups( $groups ) { - $groups = (array) $groups; - - $this->unflushable_groups = array_unique( array_merge( $this->unflushable_groups, $groups ) ); - } - - /** - * Wrapper to validate the cache keys expiration value - * - * @param mixed $expiration Incoming expiration value (whatever it is). - */ - protected function validate_expiration( $expiration ) { - $expiration = is_int( $expiration ) || ctype_digit( $expiration ) ? (int) $expiration : 0; - if ( defined( 'WP_REDIS_MAXTTL' ) ) { - $max = (int) WP_REDIS_MAXTTL; + /** + * Sets the list of groups not to flushed cached. + * + * @param array $groups List of groups that are unflushable. + */ + public function add_unflushable_groups( $groups ) { + $groups = (array) $groups; - if ( $expiration === 0 || $expiration > $max ) { - $expiration = $max; - } + $this->unflushable_groups = array_unique( array_merge( $this->unflushable_groups, $groups ) ); } - return $expiration; - } - - /** - * Unserialize value only if it was serialized. - * - * @param string $original Maybe unserialized original, if is needed. - * @return mixed Unserialized data can be any type. - */ - protected function maybe_unserialize( $original ) { - if ( defined( 'WP_REDIS_SERIALIZER' ) && ! empty( WP_REDIS_SERIALIZER ) ) { - return $original; - } + /** + * Wrapper to validate the cache keys expiration value + * + * @param mixed $expiration Incoming expiration value (whatever it is). + */ + protected function validate_expiration( $expiration ) { + $expiration = is_int( $expiration ) || ctype_digit( $expiration ) ? (int) $expiration : 0; - if ( defined( 'WP_REDIS_IGBINARY' ) && WP_REDIS_IGBINARY && function_exists( 'igbinary_unserialize' ) ) { - return igbinary_unserialize( $original ); - } + if ( defined( 'WP_REDIS_MAXTTL' ) ) { + $max = (int) WP_REDIS_MAXTTL; - // Don't attempt to unserialize data that wasn't serialized going in. - if ( $this->is_serialized( $original ) ) { - // phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged, WordPress.PHP.DiscouragedPHPFunctions.serialize_unserialize - $value = @unserialize( $original ); + if ( $expiration === 0 || $expiration > $max ) { + $expiration = $max; + } + } - return is_object( $value ) ? clone $value : $value; + return $expiration; } - return $original; - } + /** + * Unserialize value only if it was serialized. + * + * @param string $original Maybe unserialized original, if is needed. + * @return mixed Unserialized data can be any type. + */ + protected function maybe_unserialize( $original ) { + if ( defined( 'WP_REDIS_SERIALIZER' ) && ! empty( WP_REDIS_SERIALIZER ) ) { + return $original; + } - /** - * Serialize data, if needed. - * - * @param mixed $data Data that might be serialized. - * @return mixed A scalar data - */ - protected function maybe_serialize( $data ) { - if ( is_object( $data ) ) { - $data = clone $data; - } + if ( defined( 'WP_REDIS_IGBINARY' ) && WP_REDIS_IGBINARY && function_exists( 'igbinary_unserialize' ) ) { + return igbinary_unserialize( $original ); + } - if ( defined( 'WP_REDIS_SERIALIZER' ) && ! empty( WP_REDIS_SERIALIZER ) ) { - return $data; - } + // Don't attempt to unserialize data that wasn't serialized going in. + if ( $this->is_serialized( $original ) ) { + // phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged, WordPress.PHP.DiscouragedPHPFunctions.serialize_unserialize + $value = @unserialize( $original ); - if ( defined( 'WP_REDIS_IGBINARY' ) && WP_REDIS_IGBINARY && function_exists( 'igbinary_serialize' ) ) { - return igbinary_serialize( $data ); - } + return is_object( $value ) ? clone $value : $value; + } - if ( is_array( $data ) || is_object( $data ) ) { - // phpcs:ignore WordPress.PHP.DiscouragedPHPFunctions.serialize_serialize - return serialize( $data ); + return $original; } - if ( $this->is_serialized( $data, false ) ) { - // phpcs:ignore WordPress.PHP.DiscouragedPHPFunctions.serialize_serialize - return serialize( $data ); - } + /** + * Serialize data, if needed. + * + * @param mixed $data Data that might be serialized. + * @return mixed A scalar data + */ + protected function maybe_serialize( $data ) { + if ( is_object( $data ) ) { + $data = clone $data; + } - return $data; - } + if ( defined( 'WP_REDIS_SERIALIZER' ) && ! empty( WP_REDIS_SERIALIZER ) ) { + return $data; + } - /** - * Check value to find if it was serialized. - * - * If $data is not an string, then returned value will always be false. - * Serialized data is always a string. - * - * @param string $data Value to check to see if was serialized. - * @param bool $strict Optional. Whether to be strict about the end of the string. Default true. - * @return bool False if not serialized and true if it was. - */ - protected function is_serialized( $data, $strict = true ) { - // if it isn't a string, it isn't serialized. - if ( ! is_string( $data ) ) { - return false; - } + if ( defined( 'WP_REDIS_IGBINARY' ) && WP_REDIS_IGBINARY && function_exists( 'igbinary_serialize' ) ) { + return igbinary_serialize( $data ); + } - $data = trim( $data ); + if ( is_array( $data ) || is_object( $data ) ) { + // phpcs:ignore WordPress.PHP.DiscouragedPHPFunctions.serialize_serialize + return serialize( $data ); + } - if ( 'N;' === $data ) { - return true; - } + if ( $this->is_serialized( $data, false ) ) { + // phpcs:ignore WordPress.PHP.DiscouragedPHPFunctions.serialize_serialize + return serialize( $data ); + } - if ( strlen( $data ) < 4 ) { - return false; + return $data; } - if ( ':' !== $data[1] ) { - return false; - } + /** + * Check value to find if it was serialized. + * + * If $data is not an string, then returned value will always be false. + * Serialized data is always a string. + * + * @param string $data Value to check to see if was serialized. + * @param bool $strict Optional. Whether to be strict about the end of the string. Default true. + * @return bool False if not serialized and true if it was. + */ + protected function is_serialized( $data, $strict = true ) { + // if it isn't a string, it isn't serialized. + if ( ! is_string( $data ) ) { + return false; + } - if ( $strict ) { - $lastc = substr( $data, -1 ); + $data = trim( $data ); - if ( ';' !== $lastc && '}' !== $lastc ) { - return false; + if ( 'N;' === $data ) { + return true; } - } else { - $semicolon = strpos( $data, ';' ); - $brace = strpos( $data, '}' ); - // Either ; or } must exist. - if ( false === $semicolon && false === $brace ) { + if ( strlen( $data ) < 4 ) { return false; } - // But neither must be in the first X characters. - if ( false !== $semicolon && $semicolon < 3 ) { + if ( ':' !== $data[1] ) { return false; } - if ( false !== $brace && $brace < 4 ) { - return false; + if ( $strict ) { + $lastc = substr( $data, -1 ); + + if ( ';' !== $lastc && '}' !== $lastc ) { + return false; + } + } else { + $semicolon = strpos( $data, ';' ); + $brace = strpos( $data, '}' ); + + // Either ; or } must exist. + if ( false === $semicolon && false === $brace ) { + return false; + } + + // But neither must be in the first X characters. + if ( false !== $semicolon && $semicolon < 3 ) { + return false; + } + + if ( false !== $brace && $brace < 4 ) { + return false; + } } - } - $token = $data[0]; + $token = $data[0]; - switch ( $token ) { - case 's': - if ( $strict ) { - if ( '"' !== substr( $data, -2, 1 ) ) { + switch ( $token ) { + case 's': + if ( $strict ) { + if ( '"' !== substr( $data, -2, 1 ) ) { + return false; + } + } elseif ( false === strpos( $data, '"' ) ) { return false; } - } elseif ( false === strpos( $data, '"' ) ) { - return false; - } - // Or else fall through. - // No break! - case 'a': - case 'O': - return (bool) preg_match( "/^{$token}:[0-9]+:/s", $data ); - case 'b': - case 'i': - case 'd': - $end = $strict ? '$' : ''; - - return (bool) preg_match( "/^{$token}:[0-9.E-]+;$end/", $data ); + // Or else fall through. + // No break! + case 'a': + case 'O': + return (bool) preg_match( "/^{$token}:[0-9]+:/s", $data ); + case 'b': + case 'i': + case 'd': + $end = $strict ? '$' : ''; + + return (bool) preg_match( "/^{$token}:[0-9.E-]+;$end/", $data ); + } + + return false; } - return false; - } + /** + * Handle the redis failure gracefully or throw an exception. + * + * @param \Exception $exception Exception thrown. + * @throws \Exception If `fail_gracefully` flag is set to a falsy value. + * @return void + */ + protected function handle_exception( $exception ) { + $this->redis_connected = false; - /** - * Handle the redis failure gracefully or throw an exception. - * - * @param \Exception $exception Exception thrown. - * @throws \Exception If `fail_gracefully` flag is set to a falsy value. - * @return void - */ - protected function handle_exception( $exception ) { - $this->redis_connected = false; + // When Redis is unavailable, fall back to the internal cache by forcing all groups to be "no redis" groups. + $this->ignored_groups = array_unique( array_merge( $this->ignored_groups, $this->global_groups ) ); - // When Redis is unavailable, fall back to the internal cache by forcing all groups to be "no redis" groups. - $this->ignored_groups = array_unique( array_merge( $this->ignored_groups, $this->global_groups ) ); + if ( ! $this->fail_gracefully ) { + throw $exception; + } - if ( ! $this->fail_gracefully ) { - throw $exception; - } + $this->errors[] = $exception->getMessage(); - $this->errors[] = $exception->getMessage(); + error_log( $exception ); // phpcs:ignore WordPress.PHP.DevelopmentFunctions.error_log_error_log - error_log( $exception ); // phpcs:ignore WordPress.PHP.DevelopmentFunctions.error_log_error_log + if ( function_exists( 'do_action' ) ) { + do_action( 'redis_object_cache_error', $exception ); + } + } - if ( function_exists( 'do_action' ) ) { - do_action( 'redis_object_cache_error', $exception ); + /** + * Allows access to private properties for backwards compatibility. + * + * @param string $name Name of the property. + * @return mixed + */ + public function __get( $name ) { + return isset( $this->{$name} ) ? $this->{$name} : null; } } - /** - * Allows access to private properties for backwards compatibility. - * - * @param string $name Name of the property. - * @return mixed - */ - public function __get( $name ) { - return isset( $this->{$name} ) ? $this->{$name} : null; - } -} +endif; From 09df910df0e5a31ddc6aa24543e50a91b02e92ae Mon Sep 17 00:00:00 2001 From: naxvog Date: Sun, 16 Aug 2020 11:22:34 +0200 Subject: [PATCH 44/93] removed indentation sniff due to non standard indentation --- includes/object-cache.php | 3248 +++++++++++++++++++------------------ 1 file changed, 1625 insertions(+), 1623 deletions(-) diff --git a/includes/object-cache.php b/includes/object-cache.php index db3304fd..6993d12b 100644 --- a/includes/object-cache.php +++ b/includes/object-cache.php @@ -14,2004 +14,2006 @@ defined( '\\ABSPATH' ) || exit; +// phpcs:disable Generic.WhiteSpace.ScopeIndent.IncorrectExact, Generic.WhiteSpace.ScopeIndent.Incorrect if ( ! defined( 'WP_REDIS_DISABLED' ) || ! WP_REDIS_DISABLED ) : - /** - * Adds a value to cache. - * - * If the specified key already exists, the value is not stored and the function - * returns false. - * - * @param string $key The key under which to store the value. - * @param mixed $value The value to store. - * @param string $group The group value appended to the $key. - * @param int $expiration The expiration time, defaults to 0. - * - * @return bool Returns TRUE on success or FALSE on failure. - */ - function wp_cache_add( $key, $value, $group = '', $expiration = 0 ) { - global $wp_object_cache; +/** + * Adds a value to cache. + * + * If the specified key already exists, the value is not stored and the function + * returns false. + * + * @param string $key The key under which to store the value. + * @param mixed $value The value to store. + * @param string $group The group value appended to the $key. + * @param int $expiration The expiration time, defaults to 0. + * + * @return bool Returns TRUE on success or FALSE on failure. + */ +function wp_cache_add( $key, $value, $group = '', $expiration = 0 ) { + global $wp_object_cache; + + return $wp_object_cache->add( $key, $value, $group, $expiration ); +} + +/** + * Closes the cache. + * + * This function has ceased to do anything since WordPress 2.5. The + * functionality was removed along with the rest of the persistent cache. This + * does not mean that plugins can't implement this function when they need to + * make sure that the cache is cleaned up after WordPress no longer needs it. + * + * @return bool Always returns True + */ +function wp_cache_close() { + return true; +} + +/** + * Decrement a numeric item's value. + * + * @param string $key The key under which to store the value. + * @param int $offset The amount by which to decrement the item's value. + * @param string $group The group value appended to the $key. + * + * @return int|bool Returns item's new value on success or FALSE on failure. + */ +function wp_cache_decr( $key, $offset = 1, $group = '' ) { + global $wp_object_cache; + + return $wp_object_cache->decrement( $key, $offset, $group ); +} + +/** + * Remove the item from the cache. + * + * @param string $key The key under which to store the value. + * @param string $group The group value appended to the $key. + * @param int $time The amount of time the server will wait to delete the item in seconds. + * + * @return bool Returns TRUE on success or FALSE on failure. + */ +function wp_cache_delete( $key, $group = '', $time = 0 ) { + global $wp_object_cache; + + return $wp_object_cache->delete( $key, $group, $time ); +} + +/** + * Invalidate all items in the cache. If `WP_REDIS_SELECTIVE_FLUSH` is `true`, + * only keys prefixed with the `WP_REDIS_PREFIX` are flushed. + * + * @param int $delay Number of seconds to wait before invalidating the items. + * + * @return bool Returns TRUE on success or FALSE on failure. + */ +function wp_cache_flush( $delay = 0 ) { + global $wp_object_cache; + + return $wp_object_cache->flush( $delay ); +} + +/** + * Retrieve object from cache. + * + * Gets an object from cache based on $key and $group. + * + * @param string $key The key under which to store the value. + * @param string $group The group value appended to the $key. + * @param bool $force Optional. Whether to force an update of the local cache from the persistent + * cache. Default false. + * @param bool $found Optional. Whether the key was found in the cache. Disambiguates a return of false, + * a storable value. Passed by reference. Default null. + * + * @return bool|mixed Cached object value. + */ +function wp_cache_get( $key, $group = '', $force = false, &$found = null ) { + global $wp_object_cache; + + return $wp_object_cache->get( $key, $group, $force, $found ); +} + +/** + * Retrieves multiple values from the cache in one call. + * + * @param array $keys Array of keys under which the cache contents are stored. + * @param string $group Optional. Where the cache contents are grouped. Default empty. + * @param bool $force Optional. Whether to force an update of the local cache + * from the persistent cache. Default false. + * @return array Array of values organized into groups. + */ +function wp_cache_get_multiple( $keys, $group = '', $force = false ) { + global $wp_object_cache; - return $wp_object_cache->add( $key, $value, $group, $expiration ); + return $wp_object_cache->get_multiple( $keys, $group, $force ); +} + +/** + * Increment a numeric item's value. + * + * @param string $key The key under which to store the value. + * @param int $offset The amount by which to increment the item's value. + * @param string $group The group value appended to the $key. + * + * @return int|bool Returns item's new value on success or FALSE on failure. + */ +function wp_cache_incr( $key, $offset = 1, $group = '' ) { + global $wp_object_cache; + + return $wp_object_cache->increment( $key, $offset, $group ); +} + +/** + * Sets up Object Cache Global and assigns it. + * + * @return void + */ +function wp_cache_init() { + global $wp_object_cache; + + // Backwards compatibility: map `WP_CACHE_KEY_SALT` constant to `WP_REDIS_PREFIX`. + if ( defined( 'WP_CACHE_KEY_SALT' ) && ! defined( 'WP_REDIS_PREFIX' ) ) { + define( 'WP_REDIS_PREFIX', WP_CACHE_KEY_SALT ); + } + + if ( ! ( $wp_object_cache instanceof WP_Object_Cache ) ) { + $fail_gracefully = ! defined( 'WP_REDIS_GRACEFUL' ) || WP_REDIS_GRACEFUL; + + // We need to override this WordPress global in order to inject our cache. + // phpcs:ignore WordPress.WP.GlobalVariablesOverride.Prohibited + $wp_object_cache = new WP_Object_Cache( $fail_gracefully ); } +} + +/** + * Replaces a value in cache. + * + * This method is similar to "add"; however, is does not successfully set a value if + * the object's key is not already set in cache. + * + * @param string $key The key under which to store the value. + * @param mixed $value The value to store. + * @param string $group The group value appended to the $key. + * @param int $expiration The expiration time, defaults to 0. + * + * @return bool Returns TRUE on success or FALSE on failure. + */ +function wp_cache_replace( $key, $value, $group = '', $expiration = 0 ) { + global $wp_object_cache; + + return $wp_object_cache->replace( $key, $value, $group, $expiration ); +} + +/** + * Sets a value in cache. + * + * The value is set whether or not this key already exists in Redis. + * + * @param string $key The key under which to store the value. + * @param mixed $value The value to store. + * @param string $group The group value appended to the $key. + * @param int $expiration The expiration time, defaults to 0. + * + * @return bool Returns TRUE on success or FALSE on failure. + */ +function wp_cache_set( $key, $value, $group = '', $expiration = 0 ) { + global $wp_object_cache; + + return $wp_object_cache->set( $key, $value, $group, $expiration ); +} + +/** + * Switch the internal blog id. + * + * This changes the blog id used to create keys in blog specific groups. + * + * @param int $_blog_id The blog ID. + * + * @return bool + */ +function wp_cache_switch_to_blog( $_blog_id ) { + global $wp_object_cache; + + return $wp_object_cache->switch_to_blog( $_blog_id ); +} + +/** + * Adds a group or set of groups to the list of Redis groups. + * + * @param string|array $groups A group or an array of groups to add. + * + * @return void + */ +function wp_cache_add_global_groups( $groups ) { + global $wp_object_cache; + + $wp_object_cache->add_global_groups( $groups ); +} + +/** + * Adds a group or set of groups to the list of non-Redis groups. + * + * @param string|array $groups A group or an array of groups to add. + * + * @return void + */ +function wp_cache_add_non_persistent_groups( $groups ) { + global $wp_object_cache; + + $wp_object_cache->add_non_persistent_groups( $groups ); +} + +/** + * Object cache class definition + */ +class WP_Object_Cache { /** - * Closes the cache. + * The Redis client. * - * This function has ceased to do anything since WordPress 2.5. The - * functionality was removed along with the rest of the persistent cache. This - * does not mean that plugins can't implement this function when they need to - * make sure that the cache is cleaned up after WordPress no longer needs it. - * - * @return bool Always returns True + * @var mixed */ - function wp_cache_close() { - return true; - } + private $redis; /** - * Decrement a numeric item's value. - * - * @param string $key The key under which to store the value. - * @param int $offset The amount by which to decrement the item's value. - * @param string $group The group value appended to the $key. + * The Redis server version. * - * @return int|bool Returns item's new value on success or FALSE on failure. + * @var null|string */ - function wp_cache_decr( $key, $offset = 1, $group = '' ) { - global $wp_object_cache; - - return $wp_object_cache->decrement( $key, $offset, $group ); - } + private $redis_version = null; /** - * Remove the item from the cache. - * - * @param string $key The key under which to store the value. - * @param string $group The group value appended to the $key. - * @param int $time The amount of time the server will wait to delete the item in seconds. + * Track if Redis is available. * - * @return bool Returns TRUE on success or FALSE on failure. + * @var bool */ - function wp_cache_delete( $key, $group = '', $time = 0 ) { - global $wp_object_cache; - - return $wp_object_cache->delete( $key, $group, $time ); - } + private $redis_connected = false; /** - * Invalidate all items in the cache. If `WP_REDIS_SELECTIVE_FLUSH` is `true`, - * only keys prefixed with the `WP_REDIS_PREFIX` are flushed. + * Check to fail gracefully or throw an exception. * - * @param int $delay Number of seconds to wait before invalidating the items. - * - * @return bool Returns TRUE on success or FALSE on failure. + * @var bool */ - function wp_cache_flush( $delay = 0 ) { - global $wp_object_cache; - - return $wp_object_cache->flush( $delay ); - } + private $fail_gracefully = true; /** - * Retrieve object from cache. - * - * Gets an object from cache based on $key and $group. + * Holds the non-Redis objects. * - * @param string $key The key under which to store the value. - * @param string $group The group value appended to the $key. - * @param bool $force Optional. Whether to force an update of the local cache from the persistent - * cache. Default false. - * @param bool $found Optional. Whether the key was found in the cache. Disambiguates a return of false, - * a storable value. Passed by reference. Default null. - * - * @return bool|mixed Cached object value. + * @var array */ - function wp_cache_get( $key, $group = '', $force = false, &$found = null ) { - global $wp_object_cache; - - return $wp_object_cache->get( $key, $group, $force, $found ); - } + public $cache = array(); /** - * Retrieves multiple values from the cache in one call. + * Holds the diagnostics values. * - * @param array $keys Array of keys under which the cache contents are stored. - * @param string $group Optional. Where the cache contents are grouped. Default empty. - * @param bool $force Optional. Whether to force an update of the local cache - * from the persistent cache. Default false. - * @return array Array of values organized into groups. + * @var array */ - function wp_cache_get_multiple( $keys, $group = '', $force = false ) { - global $wp_object_cache; - - return $wp_object_cache->get_multiple( $keys, $group, $force ); - } + public $diagnostics = null; /** - * Increment a numeric item's value. - * - * @param string $key The key under which to store the value. - * @param int $offset The amount by which to increment the item's value. - * @param string $group The group value appended to the $key. + * Holds the error messages. * - * @return int|bool Returns item's new value on success or FALSE on failure. + * @var array */ - function wp_cache_incr( $key, $offset = 1, $group = '' ) { - global $wp_object_cache; - - return $wp_object_cache->increment( $key, $offset, $group ); - } + public $errors = array(); /** - * Sets up Object Cache Global and assigns it. + * List of global groups. * - * @return void + * @var array */ - function wp_cache_init() { - global $wp_object_cache; - - // Backwards compatibility: map `WP_CACHE_KEY_SALT` constant to `WP_REDIS_PREFIX`. - if ( defined( 'WP_CACHE_KEY_SALT' ) && ! defined( 'WP_REDIS_PREFIX' ) ) { - define( 'WP_REDIS_PREFIX', WP_CACHE_KEY_SALT ); - } - - if ( ! ( $wp_object_cache instanceof WP_Object_Cache ) ) { - $fail_gracefully = ! defined( 'WP_REDIS_GRACEFUL' ) || WP_REDIS_GRACEFUL; - - // We need to override this WordPress global in order to inject our cache. - // phpcs:ignore WordPress.WP.GlobalVariablesOverride.Prohibited - $wp_object_cache = new WP_Object_Cache( $fail_gracefully ); - } - } + public $global_groups = array( + 'blog-details', + 'blog-id-cache', + 'blog-lookup', + 'global-posts', + 'networks', + 'rss', + 'sites', + 'site-details', + 'site-lookup', + 'site-options', + 'site-transient', + 'users', + 'useremail', + 'userlogins', + 'usermeta', + 'user_meta', + 'userslugs', + ); /** - * Replaces a value in cache. + * List of groups that will not be flushed. * - * This method is similar to "add"; however, is does not successfully set a value if - * the object's key is not already set in cache. - * - * @param string $key The key under which to store the value. - * @param mixed $value The value to store. - * @param string $group The group value appended to the $key. - * @param int $expiration The expiration time, defaults to 0. - * - * @return bool Returns TRUE on success or FALSE on failure. + * @var array */ - function wp_cache_replace( $key, $value, $group = '', $expiration = 0 ) { - global $wp_object_cache; - - return $wp_object_cache->replace( $key, $value, $group, $expiration ); - } + public $unflushable_groups = array(); /** - * Sets a value in cache. - * - * The value is set whether or not this key already exists in Redis. - * - * @param string $key The key under which to store the value. - * @param mixed $value The value to store. - * @param string $group The group value appended to the $key. - * @param int $expiration The expiration time, defaults to 0. + * List of groups not saved to Redis. * - * @return bool Returns TRUE on success or FALSE on failure. + * @var array */ - function wp_cache_set( $key, $value, $group = '', $expiration = 0 ) { - global $wp_object_cache; + public $ignored_groups = array( + 'counts', + 'plugins', + 'themes', + ); - return $wp_object_cache->set( $key, $value, $group, $expiration ); - } + /** + * Prefix used for global groups. + * + * @var string + */ + public $global_prefix = ''; /** - * Switch the internal blog id. + * Prefix used for non-global groups. * - * This changes the blog id used to create keys in blog specific groups. + * @var string + */ + public $blog_prefix = ''; + + /** + * Track how many requests were found in cache. * - * @param int $_blog_id The blog ID. + * @var int + */ + public $cache_hits = 0; + + /** + * Track how may requests were not cached. * - * @return bool + * @var int */ - function wp_cache_switch_to_blog( $_blog_id ) { - global $wp_object_cache; + public $cache_misses = 0; - return $wp_object_cache->switch_to_blog( $_blog_id ); - } + /** + * Track how long request took. + * + * @var int + */ + public $cache_time = 0; /** - * Adds a group or set of groups to the list of Redis groups. + * Track how may calls were made. * - * @param string|array $groups A group or an array of groups to add. + * @var int + */ + public $cache_calls = 0; + + /** + * Instantiate the Redis class. * - * @return void + * @param bool $fail_gracefully Handles and logs errors if true throws exceptions otherwise. */ - function wp_cache_add_global_groups( $groups ) { - global $wp_object_cache; + public function __construct( $fail_gracefully = true ) { + global $blog_id, $table_prefix; + + $this->fail_gracefully = $fail_gracefully; + + if ( defined( 'WP_REDIS_GLOBAL_GROUPS' ) && is_array( WP_REDIS_GLOBAL_GROUPS ) ) { + $this->global_groups = array_map( [ $this, 'sanitize_key_part' ], WP_REDIS_GLOBAL_GROUPS ); + } + + if ( defined( 'WP_REDIS_IGNORED_GROUPS' ) && is_array( WP_REDIS_IGNORED_GROUPS ) ) { + $this->ignored_groups = array_map( [ $this, 'sanitize_key_part' ], WP_REDIS_IGNORED_GROUPS ); + } + + if ( defined( 'WP_REDIS_UNFLUSHABLE_GROUPS' ) && is_array( WP_REDIS_UNFLUSHABLE_GROUPS ) ) { + $this->unflushable_groups = array_map( [ $this, 'sanitize_key_part' ], WP_REDIS_UNFLUSHABLE_GROUPS ); + } + + $client = $this->determine_client(); + $parameters = $this->build_parameters(); + + try { + switch ( $client ) { + case 'hhvm': + $this->connect_using_hhvm( $parameters ); + break; + case 'phpredis': + $this->connect_using_phpredis( $parameters ); + break; + case 'credis': + $this->connect_using_credis( $parameters ); + break; + case 'predis': + default: + $this->connect_using_predis( $parameters ); + break; + } + + if ( defined( 'WP_REDIS_CLUSTER' ) ) { + $this->diagnostics[ 'ping' ] = $this->redis->ping( current( array_values( WP_REDIS_CLUSTER ) ) ); + } else { + $this->diagnostics[ 'ping' ] = $this->redis->ping(); + } + + $this->fetch_info(); - $wp_object_cache->add_global_groups( $groups ); + $this->redis_connected = true; + } catch ( Exception $exception ) { + $this->handle_exception( $exception ); + } + + // Assign global and blog prefixes for use with keys. + if ( function_exists( 'is_multisite' ) ) { + $this->global_prefix = is_multisite() ? '' : $table_prefix; + $this->blog_prefix = is_multisite() ? $blog_id : $table_prefix; + } } /** - * Adds a group or set of groups to the list of non-Redis groups. - * - * @param string|array $groups A group or an array of groups to add. + * Determine the Redis client. * - * @return void + * @return string */ - function wp_cache_add_non_persistent_groups( $groups ) { - global $wp_object_cache; + protected function determine_client() { + $client = 'predis'; + + if ( class_exists( 'Redis' ) ) { + $client = defined( 'HHVM_VERSION' ) ? 'hhvm' : 'phpredis'; + } + + if ( defined( 'WP_REDIS_CLIENT' ) ) { + $client = (string) WP_REDIS_CLIENT; + $client = str_replace( 'pecl', 'phpredis', $client ); + } - $wp_object_cache->add_non_persistent_groups( $groups ); + return trim( strtolower( $client ) ); } /** - * Object cache class definition + * Build the connection parameters from config constants. + * + * @return array */ - class WP_Object_Cache { - - /** - * The Redis client. - * - * @var mixed - */ - private $redis; - - /** - * The Redis server version. - * - * @var null|string - */ - private $redis_version = null; - - /** - * Track if Redis is available. - * - * @var bool - */ - private $redis_connected = false; - - /** - * Check to fail gracefully or throw an exception. - * - * @var bool - */ - private $fail_gracefully = true; - - /** - * Holds the non-Redis objects. - * - * @var array - */ - public $cache = array(); - - /** - * Holds the diagnostics values. - * - * @var array - */ - public $diagnostics = null; - - /** - * Holds the error messages. - * - * @var array - */ - public $errors = array(); - - /** - * List of global groups. - * - * @var array - */ - public $global_groups = array( - 'blog-details', - 'blog-id-cache', - 'blog-lookup', - 'global-posts', - 'networks', - 'rss', - 'sites', - 'site-details', - 'site-lookup', - 'site-options', - 'site-transient', - 'users', - 'useremail', - 'userlogins', - 'usermeta', - 'user_meta', - 'userslugs', + protected function build_parameters() { + $parameters = array( + 'scheme' => 'tcp', + 'host' => '127.0.0.1', + 'port' => 6379, + 'database' => 0, + 'timeout' => 1, + 'read_timeout' => 1, + 'retry_interval' => null, ); - /** - * List of groups that will not be flushed. - * - * @var array - */ - public $unflushable_groups = array(); - - /** - * List of groups not saved to Redis. - * - * @var array - */ - public $ignored_groups = array( - 'counts', - 'plugins', - 'themes', + $settings = array( + 'scheme', + 'host', + 'port', + 'path', + 'password', + 'database', + 'timeout', + 'read_timeout', + 'retry_interval', ); - /** - * Prefix used for global groups. - * - * @var string - */ - public $global_prefix = ''; - - /** - * Prefix used for non-global groups. - * - * @var string - */ - public $blog_prefix = ''; - - /** - * Track how many requests were found in cache. - * - * @var int - */ - public $cache_hits = 0; - - /** - * Track how may requests were not cached. - * - * @var int - */ - public $cache_misses = 0; - - /** - * Track how long request took. - * - * @var int - */ - public $cache_time = 0; - - /** - * Track how may calls were made. - * - * @var int - */ - public $cache_calls = 0; - - /** - * Instantiate the Redis class. - * - * @param bool $fail_gracefully Handles and logs errors if true throws exceptions otherwise. - */ - public function __construct( $fail_gracefully = true ) { - global $blog_id, $table_prefix; - - $this->fail_gracefully = $fail_gracefully; - - if ( defined( 'WP_REDIS_GLOBAL_GROUPS' ) && is_array( WP_REDIS_GLOBAL_GROUPS ) ) { - $this->global_groups = array_map( [ $this, 'sanitize_key_part' ], WP_REDIS_GLOBAL_GROUPS ); - } + foreach ( $settings as $setting ) { + $constant = sprintf( 'WP_REDIS_%s', strtoupper( $setting ) ); - if ( defined( 'WP_REDIS_IGNORED_GROUPS' ) && is_array( WP_REDIS_IGNORED_GROUPS ) ) { - $this->ignored_groups = array_map( [ $this, 'sanitize_key_part' ], WP_REDIS_IGNORED_GROUPS ); + if ( defined( $constant ) ) { + $parameters[ $setting ] = constant( $constant ); } + } + + if ( isset( $parameters['password'] ) ) { + $password = $parameters['password']; - if ( defined( 'WP_REDIS_UNFLUSHABLE_GROUPS' ) && is_array( WP_REDIS_UNFLUSHABLE_GROUPS ) ) { - $this->unflushable_groups = array_map( [ $this, 'sanitize_key_part' ], WP_REDIS_UNFLUSHABLE_GROUPS ); + if ( is_null( $password ) || $password === '' ) { + unset( $parameters['password'] ); } + } - $client = $this->determine_client(); - $parameters = $this->build_parameters(); + return $parameters; + } - try { - switch ( $client ) { - case 'hhvm': - $this->connect_using_hhvm( $parameters ); - break; - case 'phpredis': - $this->connect_using_phpredis( $parameters ); - break; - case 'credis': - $this->connect_using_credis( $parameters ); - break; - case 'predis': - default: - $this->connect_using_predis( $parameters ); - break; - } + /** + * Connect to Redis using the PhpRedis (PECL) extention. + * + * @param array $parameters Connection parameters built by the `build_parameters` method. + * @return void + */ + protected function connect_using_phpredis( $parameters ) { + $version = phpversion( 'redis' ); - if ( defined( 'WP_REDIS_CLUSTER' ) ) { - $this->diagnostics[ 'ping' ] = $this->redis->ping( current( array_values( WP_REDIS_CLUSTER ) ) ); - } else { - $this->diagnostics[ 'ping' ] = $this->redis->ping(); - } + $this->diagnostics[ 'client' ] = sprintf( 'PhpRedis (v%s)', $version ); - $this->fetch_info(); + if ( defined( 'WP_REDIS_SHARDS' ) ) { + $this->redis = new RedisArray( array_values( WP_REDIS_SHARDS ) ); - $this->redis_connected = true; - } catch ( Exception $exception ) { - $this->handle_exception( $exception ); - } + $this->diagnostics[ 'shards' ] = WP_REDIS_SHARDS; + } elseif ( defined( 'WP_REDIS_CLUSTER' ) ) { + $args = [ + 'cluster' => array_values( WP_REDIS_CLUSTER ), + 'timeout' => $parameters['timeout'], + 'read_timeout' => $parameters['read_timeout'], + ]; - // Assign global and blog prefixes for use with keys. - if ( function_exists( 'is_multisite' ) ) { - $this->global_prefix = is_multisite() ? '' : $table_prefix; - $this->blog_prefix = is_multisite() ? $blog_id : $table_prefix; + if ( isset( $parameters['password'] ) && version_compare( $version, '4.3.0', '>=' ) ) { + $args['password'] = $parameters['password']; } - } - /** - * Determine the Redis client. - * - * @return string - */ - protected function determine_client() { - $client = 'predis'; + $this->redis = new RedisCluster( null, ...array_values( $args ) ); + + $this->diagnostics += $args; + } else { + $this->redis = new Redis(); + + $args = [ + 'host' => $parameters['host'], + 'port' => $parameters['port'], + 'timeout' => $parameters['timeout'], + null, + 'retry_interval' => $parameters['retry_interval'], + ]; - if ( class_exists( 'Redis' ) ) { - $client = defined( 'HHVM_VERSION' ) ? 'hhvm' : 'phpredis'; + if ( strcasecmp( 'tls', $parameters['scheme'] ) === 0 ) { + $args['host'] = sprintf( + '%s://%s', + $parameters['scheme'], + str_replace( 'tls://', '', $parameters['host'] ) + ); } - if ( defined( 'WP_REDIS_CLIENT' ) ) { - $client = (string) WP_REDIS_CLIENT; - $client = str_replace( 'pecl', 'phpredis', $client ); + if ( strcasecmp( 'unix', $parameters['scheme'] ) === 0 ) { + $args['host'] = $parameters['path']; + $args['port'] = null; } - return trim( strtolower( $client ) ); - } - - /** - * Build the connection parameters from config constants. - * - * @return array - */ - protected function build_parameters() { - $parameters = array( - 'scheme' => 'tcp', - 'host' => '127.0.0.1', - 'port' => 6379, - 'database' => 0, - 'timeout' => 1, - 'read_timeout' => 1, - 'retry_interval' => null, - ); + if ( version_compare( $version, '3.1.3', '>=' ) ) { + $args['read_timeout'] = $parameters['read_timeout']; + } - $settings = array( - 'scheme', - 'host', - 'port', - 'path', - 'password', - 'database', - 'timeout', - 'read_timeout', - 'retry_interval', - ); + call_user_func_array( [ $this->redis, 'connect' ], array_values( $args ) ); - foreach ( $settings as $setting ) { - $constant = sprintf( 'WP_REDIS_%s', strtoupper( $setting ) ); + if ( isset( $parameters['password'] ) ) { + $args['password'] = $parameters['password']; + $this->redis->auth( $parameters['password'] ); + } - if ( defined( $constant ) ) { - $parameters[ $setting ] = constant( $constant ); + if ( isset( $parameters['database'] ) ) { + if ( ctype_digit( $parameters['database'] ) ) { + $parameters['database'] = intval( $parameters['database'] ); } - } - if ( isset( $parameters['password'] ) ) { - $password = $parameters['password']; + $args['database'] = $parameters['database']; - if ( is_null( $password ) || $password === '' ) { - unset( $parameters['password'] ); + if ( $parameters['database'] ) { + $this->redis->select( $parameters['database'] ); } } - return $parameters; + $this->diagnostics += $args; } - /** - * Connect to Redis using the PhpRedis (PECL) extention. - * - * @param array $parameters Connection parameters built by the `build_parameters` method. - * @return void - */ - protected function connect_using_phpredis( $parameters ) { - $version = phpversion( 'redis' ); + if ( defined( 'WP_REDIS_SERIALIZER' ) && ! empty( WP_REDIS_SERIALIZER ) ) { + $this->redis->setOption( Redis::OPT_SERIALIZER, WP_REDIS_SERIALIZER ); + } + } - $this->diagnostics[ 'client' ] = sprintf( 'PhpRedis (v%s)', $version ); + /** + * Connect to Redis using the Predis library. + * + * @param array $parameters Connection parameters built by the `build_parameters` method. + * @throws \Exception If the Predis library was not found or is unreadable. + * @return void + */ + protected function connect_using_predis( $parameters ) { + $client = 'Predis'; - if ( defined( 'WP_REDIS_SHARDS' ) ) { - $this->redis = new RedisArray( array_values( WP_REDIS_SHARDS ) ); + // Load bundled Predis library. + if ( ! class_exists( 'Predis\Client' ) ) { + $predis = sprintf( + '%s/redis-cache/dependencies/predis/predis/autoload.php', + defined( 'WP_PLUGIN_DIR' ) ? WP_PLUGIN_DIR : WP_CONTENT_DIR . '/plugins' + ); - $this->diagnostics[ 'shards' ] = WP_REDIS_SHARDS; - } elseif ( defined( 'WP_REDIS_CLUSTER' ) ) { - $args = [ - 'cluster' => array_values( WP_REDIS_CLUSTER ), - 'timeout' => $parameters['timeout'], - 'read_timeout' => $parameters['read_timeout'], - ]; + if ( is_readable( $predis ) ) { + require_once $predis; + } else { + throw new Exception( + 'Predis library not found. Re-install Redis Cache plugin or delete the object-cache.php.' + ); + } + } - if ( isset( $parameters['password'] ) && version_compare( $version, '4.3.0', '>=' ) ) { - $args['password'] = $parameters['password']; - } + $options = array(); + + if ( defined( 'WP_REDIS_SHARDS' ) ) { + $parameters = WP_REDIS_SHARDS; + } elseif ( defined( 'WP_REDIS_SENTINEL' ) ) { + $parameters = WP_REDIS_SERVERS; + $options['replication'] = 'sentinel'; + $options['service'] = WP_REDIS_SENTINEL; + } elseif ( defined( 'WP_REDIS_SERVERS' ) ) { + $parameters = WP_REDIS_SERVERS; + $options['replication'] = true; + } elseif ( defined( 'WP_REDIS_CLUSTER' ) ) { + $parameters = WP_REDIS_CLUSTER; + $options['cluster'] = 'redis'; + } - $this->redis = new RedisCluster( null, ...array_values( $args ) ); + if ( isset( $parameters['read_timeout'] ) && $parameters['read_timeout'] ) { + $parameters['read_write_timeout'] = $parameters['read_timeout']; + } - $this->diagnostics += $args; - } else { - $this->redis = new Redis(); - - $args = [ - 'host' => $parameters['host'], - 'port' => $parameters['port'], - 'timeout' => $parameters['timeout'], - null, - 'retry_interval' => $parameters['retry_interval'], - ]; - - if ( strcasecmp( 'tls', $parameters['scheme'] ) === 0 ) { - $args['host'] = sprintf( - '%s://%s', - $parameters['scheme'], - str_replace( 'tls://', '', $parameters['host'] ) - ); + foreach ( array( 'WP_REDIS_SERVERS', 'WP_REDIS_SHARDS', 'WP_REDIS_CLUSTER' ) as $constant ) { + if ( defined( $constant ) ) { + if ( $parameters['database'] ) { + $options['parameters']['database'] = $parameters['database']; } - if ( strcasecmp( 'unix', $parameters['scheme'] ) === 0 ) { - $args['host'] = $parameters['path']; - $args['port'] = null; + if ( isset( $parameters['password'] ) ) { + $options['parameters']['password'] = WP_REDIS_PASSWORD; } + } + } - if ( version_compare( $version, '3.1.3', '>=' ) ) { - $args['read_timeout'] = $parameters['read_timeout']; - } + $this->redis = new Predis\Client( $parameters, $options ); + $this->redis->connect(); - call_user_func_array( [ $this->redis, 'connect' ], array_values( $args ) ); + $this->diagnostics = array_merge( + [ 'client' => sprintf( '%s (v%s)', $client, Predis\Client::VERSION ) ], + $parameters, + $options + ); + } - if ( isset( $parameters['password'] ) ) { - $args['password'] = $parameters['password']; - $this->redis->auth( $parameters['password'] ); - } + /** + * Connect to Redis using the Credis library. + * + * @param array $parameters Connection parameters built by the `build_parameters` method. + * @throws \Exception If the Credis library was not found or is unreadable. + * @throws \Exception If redis sharding should be configured as Credis does not support sharding. + * @throws \Exception If more than one seninel is configured as Credis does not support multiple sentinel servers. + * @return void + */ + protected function connect_using_credis( $parameters ) { + $client = 'Credis'; - if ( isset( $parameters['database'] ) ) { - if ( ctype_digit( $parameters['database'] ) ) { - $parameters['database'] = intval( $parameters['database'] ); - } + $creds_path = sprintf( + '%s/redis-cache/dependencies/colinmollenhour/credis/', + defined( 'WP_PLUGIN_DIR' ) ? WP_PLUGIN_DIR : WP_CONTENT_DIR . '/plugins' + ); - $args['database'] = $parameters['database']; + $to_load = []; - if ( $parameters['database'] ) { - $this->redis->select( $parameters['database'] ); - } - } - - $this->diagnostics += $args; - } - - if ( defined( 'WP_REDIS_SERIALIZER' ) && ! empty( WP_REDIS_SERIALIZER ) ) { - $this->redis->setOption( Redis::OPT_SERIALIZER, WP_REDIS_SERIALIZER ); - } + if ( ! class_exists( 'Credis_Client' ) ) { + $to_load[] = 'Client.php'; } - /** - * Connect to Redis using the Predis library. - * - * @param array $parameters Connection parameters built by the `build_parameters` method. - * @throws \Exception If the Predis library was not found or is unreadable. - * @return void - */ - protected function connect_using_predis( $parameters ) { - $client = 'Predis'; - - // Load bundled Predis library. - if ( ! class_exists( 'Predis\Client' ) ) { - $predis = sprintf( - '%s/redis-cache/dependencies/predis/predis/autoload.php', - defined( 'WP_PLUGIN_DIR' ) ? WP_PLUGIN_DIR : WP_CONTENT_DIR . '/plugins' - ); - - if ( is_readable( $predis ) ) { - require_once $predis; - } else { - throw new Exception( - 'Predis library not found. Re-install Redis Cache plugin or delete the object-cache.php.' - ); - } - } - - $options = array(); - - if ( defined( 'WP_REDIS_SHARDS' ) ) { - $parameters = WP_REDIS_SHARDS; - } elseif ( defined( 'WP_REDIS_SENTINEL' ) ) { - $parameters = WP_REDIS_SERVERS; - $options['replication'] = 'sentinel'; - $options['service'] = WP_REDIS_SENTINEL; - } elseif ( defined( 'WP_REDIS_SERVERS' ) ) { - $parameters = WP_REDIS_SERVERS; - $options['replication'] = true; - } elseif ( defined( 'WP_REDIS_CLUSTER' ) ) { - $parameters = WP_REDIS_CLUSTER; - $options['cluster'] = 'redis'; - } + if ( + ( defined( 'WP_REDIS_SHARDS' ) || defined( 'WP_REDIS_SENTINEL' ) || defined( 'WP_REDIS_SERVERS' ) || defined( 'WP_REDIS_CLUSTER' ) ) && + ! class_exists( 'Credis_Cluster' ) + ) { + $to_load[] = 'Cluster.php'; - if ( isset( $parameters['read_timeout'] ) && $parameters['read_timeout'] ) { - $parameters['read_write_timeout'] = $parameters['read_timeout']; + if ( defined( 'WP_REDIS_SENTINEL' ) && ! class_exists( 'Credis_Sentinel' ) ) { + $to_load[] = 'Sentinel.php'; } + } - foreach ( array( 'WP_REDIS_SERVERS', 'WP_REDIS_SHARDS', 'WP_REDIS_CLUSTER' ) as $constant ) { - if ( defined( $constant ) ) { - if ( $parameters['database'] ) { - $options['parameters']['database'] = $parameters['database']; - } + foreach ( $to_load as $sub_path ) { + $path = $creds_path . $sub_path; - if ( isset( $parameters['password'] ) ) { - $options['parameters']['password'] = WP_REDIS_PASSWORD; - } - } + if ( file_exists( $path ) ) { + require_once $path; + } else { + throw new Exception( + 'Credis library not found. Re-install Redis Cache plugin or delete object-cache.php.' + ); } - - $this->redis = new Predis\Client( $parameters, $options ); - $this->redis->connect(); - - $this->diagnostics = array_merge( - [ 'client' => sprintf( '%s (v%s)', $client, Predis\Client::VERSION ) ], - $parameters, - $options - ); } - /** - * Connect to Redis using the Credis library. - * - * @param array $parameters Connection parameters built by the `build_parameters` method. - * @throws \Exception If the Credis library was not found or is unreadable. - * @throws \Exception If redis sharding should be configured as Credis does not support sharding. - * @throws \Exception If more than one seninel is configured as Credis does not support multiple sentinel servers. - * @return void - */ - protected function connect_using_credis( $parameters ) { - $client = 'Credis'; - - $creds_path = sprintf( - '%s/redis-cache/dependencies/colinmollenhour/credis/', - defined( 'WP_PLUGIN_DIR' ) ? WP_PLUGIN_DIR : WP_CONTENT_DIR . '/plugins' + if ( defined( 'WP_REDIS_SHARDS' ) ) { + throw new Exception( + 'Sharding not supported by bundled Credis library. Please review your Redis Cache configuration.' ); + } - $to_load = []; - - if ( ! class_exists( 'Credis_Client' ) ) { - $to_load[] = 'Client.php'; + if ( defined( 'WP_REDIS_SENTINEL' ) ) { + if ( is_array( WP_REDIS_SERVERS ) && count( WP_REDIS_SERVERS ) > 1 ) { + throw new Exception( + 'Multipe sentinel servers are not supported by the bundled Credis library. Please review your Redis Cache configuration.' + ); } - if ( - ( defined( 'WP_REDIS_SHARDS' ) || defined( 'WP_REDIS_SENTINEL' ) || defined( 'WP_REDIS_SERVERS' ) || defined( 'WP_REDIS_CLUSTER' ) ) && - ! class_exists( 'Credis_Cluster' ) - ) { - $to_load[] = 'Cluster.php'; + $connection_string = array_values( WP_REDIS_SERVERS )[0]; + $sentinel = new Credis_Sentinel( new Credis_Client( $connection_string ) ); + $this->redis = $sentinel->getCluster( WP_REDIS_SENTINEL ); + $args['servers'] = WP_REDIS_SERVERS; + } elseif ( defined( 'WP_REDIS_CLUSTER' ) || defined( 'WP_REDIS_SERVERS' ) ) { + $parameters['db'] = $parameters['database']; - if ( defined( 'WP_REDIS_SENTINEL' ) && ! class_exists( 'Credis_Sentinel' ) ) { - $to_load[] = 'Sentinel.php'; - } - } + $is_cluster = defined( 'WP_REDIS_CLUSTER' ); + $clients = $is_cluster ? WP_REDIS_CLUSTER : WP_REDIS_SERVERS; - foreach ( $to_load as $sub_path ) { - $path = $creds_path . $sub_path; + foreach ( $clients as $index => &$connection_string ) { + $url_components = wp_parse_url( $connection_string ); + parse_str( $url_components['query'], $add_params ); - if ( file_exists( $path ) ) { - require_once $path; - } else { - throw new Exception( - 'Credis library not found. Re-install Redis Cache plugin or delete object-cache.php.' - ); + if ( ! $is_cluster && isset( $add_params['alias'] ) ) { + $add_params['master'] = 'master' === $add_params['alias']; } - } - if ( defined( 'WP_REDIS_SHARDS' ) ) { - throw new Exception( - 'Sharding not supported by bundled Credis library. Please review your Redis Cache configuration.' - ); - } + $add_params['host'] = $url_components['host']; - if ( defined( 'WP_REDIS_SENTINEL' ) ) { - if ( is_array( WP_REDIS_SERVERS ) && count( WP_REDIS_SERVERS ) > 1 ) { - throw new Exception( - 'Multipe sentinel servers are not supported by the bundled Credis library. Please review your Redis Cache configuration.' - ); + if ( ! isset( $add_params['alias'] ) ) { + $add_params['alias'] = "redis-$index"; } - $connection_string = array_values( WP_REDIS_SERVERS )[0]; - $sentinel = new Credis_Sentinel( new Credis_Client( $connection_string ) ); - $this->redis = $sentinel->getCluster( WP_REDIS_SENTINEL ); - $args['servers'] = WP_REDIS_SERVERS; - } elseif ( defined( 'WP_REDIS_CLUSTER' ) || defined( 'WP_REDIS_SERVERS' ) ) { - $parameters['db'] = $parameters['database']; - - $is_cluster = defined( 'WP_REDIS_CLUSTER' ); - $clients = $is_cluster ? WP_REDIS_CLUSTER : WP_REDIS_SERVERS; + $connection_string = array_merge( $parameters, $add_params ); + } - foreach ( $clients as $index => &$connection_string ) { - $url_components = wp_parse_url( $connection_string ); - parse_str( $url_components['query'], $add_params ); + $this->redis = new Credis_Cluster( $clients ); - if ( ! $is_cluster && isset( $add_params['alias'] ) ) { - $add_params['master'] = 'master' === $add_params['alias']; - } + $args['servers'] = $clients; + } else { + $args = [ + 'host' => $parameters['scheme'] === 'unix' ? $parameters['path'] : $parameters['host'], + 'port' => $parameters['port'], + 'timeout' => $parameters['timeout'], + 'persistent' => null, + 'database' => $parameters['database'], + 'password' => isset( $parameters['password'] ) ? $parameters['password'] : null, + ]; - $add_params['host'] = $url_components['host']; + $this->redis = new Credis_Client( ...array_values( $args ) ); + } - if ( ! isset( $add_params['alias'] ) ) { - $add_params['alias'] = "redis-$index"; - } + // Don't use PhpRedis if it is available. + $this->redis->forceStandalone(); - $connection_string = array_merge( $parameters, $add_params ); - } + $this->redis->connect(); - $this->redis = new Credis_Cluster( $clients ); + if ( $parameters['read_timeout'] ) { + $args['read_timeout'] = $parameters['read_timeout']; + $this->redis->setReadTimeout( $parameters['read_timeout'] ); + } - $args['servers'] = $clients; - } else { - $args = [ - 'host' => $parameters['scheme'] === 'unix' ? $parameters['path'] : $parameters['host'], - 'port' => $parameters['port'], - 'timeout' => $parameters['timeout'], - 'persistent' => null, - 'database' => $parameters['database'], - 'password' => isset( $parameters['password'] ) ? $parameters['password'] : null, - ]; - - $this->redis = new Credis_Client( ...array_values( $args ) ); - } + $this->diagnostics = array_merge( + [ 'client' => sprintf( '%s (v%s)', $client, Credis_Client::VERSION ) ], + $args + ); + } - // Don't use PhpRedis if it is available. - $this->redis->forceStandalone(); + /** + * Connect to Redis using HHVM's Redis extention. + * + * @param array $parameters Connection parameters built by the `build_parameters` method. + * @return void + */ + protected function connect_using_hhvm( $parameters ) { + $this->redis = new Redis(); - $this->redis->connect(); + // Adjust host and port if the scheme is `unix`. + if ( strcasecmp( 'unix', $parameters['scheme'] ) === 0 ) { + $parameters['host'] = 'unix://' . $parameters['path']; + $parameters['port'] = 0; + } - if ( $parameters['read_timeout'] ) { - $args['read_timeout'] = $parameters['read_timeout']; - $this->redis->setReadTimeout( $parameters['read_timeout'] ); - } + $this->redis->connect( + $parameters['host'], + $parameters['port'], + $parameters['timeout'], + null, + $parameters['retry_interval'] + ); - $this->diagnostics = array_merge( - [ 'client' => sprintf( '%s (v%s)', $client, Credis_Client::VERSION ) ], - $args - ); + if ( $parameters['read_timeout'] ) { + $this->redis->setOption( Redis::OPT_READ_TIMEOUT, $parameters['read_timeout'] ); } - /** - * Connect to Redis using HHVM's Redis extention. - * - * @param array $parameters Connection parameters built by the `build_parameters` method. - * @return void - */ - protected function connect_using_hhvm( $parameters ) { - $this->redis = new Redis(); + if ( isset( $parameters['password'] ) ) { + $this->redis->auth( $parameters['password'] ); + } - // Adjust host and port if the scheme is `unix`. - if ( strcasecmp( 'unix', $parameters['scheme'] ) === 0 ) { - $parameters['host'] = 'unix://' . $parameters['path']; - $parameters['port'] = 0; + if ( isset( $parameters['database'] ) ) { + if ( ctype_digit( $parameters['database'] ) ) { + $parameters['database'] = intval( $parameters['database'] ); } - $this->redis->connect( - $parameters['host'], - $parameters['port'], - $parameters['timeout'], - null, - $parameters['retry_interval'] - ); - - if ( $parameters['read_timeout'] ) { - $this->redis->setOption( Redis::OPT_READ_TIMEOUT, $parameters['read_timeout'] ); + if ( $parameters['database'] ) { + $this->redis->select( $parameters['database'] ); } + } - if ( isset( $parameters['password'] ) ) { - $this->redis->auth( $parameters['password'] ); - } + $this->diagnostics = array_merge( + [ 'client' => sprintf( 'HHVM Extension (v%s)', HHVM_VERSION ) ], + $parameters + ); + } - if ( isset( $parameters['database'] ) ) { - if ( ctype_digit( $parameters['database'] ) ) { - $parameters['database'] = intval( $parameters['database'] ); - } + /** + * Fetches Redis `INFO` mostly for server version. + * + * @return void + */ + public function fetch_info() { + $options = method_exists( $this->redis, 'getOptions' ) + ? $this->redis->getOptions() + : new stdClass(); - if ( $parameters['database'] ) { - $this->redis->select( $parameters['database'] ); - } - } + if ( isset( $options->replication ) && $options->replication ) { + return; + } - $this->diagnostics = array_merge( - [ 'client' => sprintf( 'HHVM Extension (v%s)', HHVM_VERSION ) ], - $parameters - ); + if ( defined( 'WP_REDIS_CLUSTER' ) ) { + $info = $this->redis->info( current( array_values( WP_REDIS_CLUSTER ) ) ); + } else { + $info = $this->redis->info(); } - /** - * Fetches Redis `INFO` mostly for server version. - * - * @return void - */ - public function fetch_info() { - $options = method_exists( $this->redis, 'getOptions' ) - ? $this->redis->getOptions() - : new stdClass(); + if ( isset( $info['redis_version'] ) ) { + $this->redis_version = $info['redis_version']; + } elseif ( isset( $info['Server']['redis_version'] ) ) { + $this->redis_version = $info['Server']['redis_version']; + } + } - if ( isset( $options->replication ) && $options->replication ) { - return; - } + /** + * Is Redis available? + * + * @return bool + */ + public function redis_status() { + return (bool) $this->redis_connected; + } - if ( defined( 'WP_REDIS_CLUSTER' ) ) { - $info = $this->redis->info( current( array_values( WP_REDIS_CLUSTER ) ) ); - } else { - $info = $this->redis->info(); - } + /** + * Returns the Redis instance. + * + * @return mixed + */ + public function redis_instance() { + return $this->redis; + } - if ( isset( $info['redis_version'] ) ) { - $this->redis_version = $info['redis_version']; - } elseif ( isset( $info['Server']['redis_version'] ) ) { - $this->redis_version = $info['Server']['redis_version']; - } - } + /** + * Returns the Redis server version. + * + * @return null|string + */ + public function redis_version() { + return $this->redis_version; + } - /** - * Is Redis available? - * - * @return bool - */ - public function redis_status() { - return (bool) $this->redis_connected; - } - - /** - * Returns the Redis instance. - * - * @return mixed - */ - public function redis_instance() { - return $this->redis; - } - - /** - * Returns the Redis server version. - * - * @return null|string - */ - public function redis_version() { - return $this->redis_version; - } - - /** - * Adds a value to cache. - * - * If the specified key already exists, the value is not stored and the function - * returns false. - * - * @param string $key The key under which to store the value. - * @param mixed $value The value to store. - * @param string $group The group value appended to the $key. - * @param int $expiration The expiration time, defaults to 0. - * @return bool Returns TRUE on success or FALSE on failure. - */ - public function add( $key, $value, $group = 'default', $expiration = 0 ) { - return $this->add_or_replace( true, $key, $value, $group, $expiration ); - } - - /** - * Replace a value in the cache. - * - * If the specified key doesn't exist, the value is not stored and the function - * returns false. - * - * @param string $key The key under which to store the value. - * @param mixed $value The value to store. - * @param string $group The group value appended to the $key. - * @param int $expiration The expiration time, defaults to 0. - * @return bool Returns TRUE on success or FALSE on failure. - */ - public function replace( $key, $value, $group = 'default', $expiration = 0 ) { - return $this->add_or_replace( false, $key, $value, $group, $expiration ); - } - - /** - * Add or replace a value in the cache. - * - * Add does not set the value if the key exists; replace does not replace if the value doesn't exist. - * - * @param bool $add True if should only add if value doesn't exist, false to only add when value already exists. - * @param string $key The key under which to store the value. - * @param mixed $value The value to store. - * @param string $group The group value appended to the $key. - * @param int $expiration The expiration time, defaults to 0. - * @return bool Returns TRUE on success or FALSE on failure. - */ - protected function add_or_replace( $add, $key, $value, $group = 'default', $expiration = 0 ) { - $cache_addition_suspended = function_exists( 'wp_suspend_cache_addition' ) - ? wp_suspend_cache_addition() - : false; - - if ( $add && $cache_addition_suspended ) { - return false; - } + /** + * Adds a value to cache. + * + * If the specified key already exists, the value is not stored and the function + * returns false. + * + * @param string $key The key under which to store the value. + * @param mixed $value The value to store. + * @param string $group The group value appended to the $key. + * @param int $expiration The expiration time, defaults to 0. + * @return bool Returns TRUE on success or FALSE on failure. + */ + public function add( $key, $value, $group = 'default', $expiration = 0 ) { + return $this->add_or_replace( true, $key, $value, $group, $expiration ); + } - $result = true; - $derived_key = $this->build_key( $key, $group ); + /** + * Replace a value in the cache. + * + * If the specified key doesn't exist, the value is not stored and the function + * returns false. + * + * @param string $key The key under which to store the value. + * @param mixed $value The value to store. + * @param string $group The group value appended to the $key. + * @param int $expiration The expiration time, defaults to 0. + * @return bool Returns TRUE on success or FALSE on failure. + */ + public function replace( $key, $value, $group = 'default', $expiration = 0 ) { + return $this->add_or_replace( false, $key, $value, $group, $expiration ); + } - // Save if group not excluded and redis is up. - if ( ! $this->is_ignored_group( $group ) && $this->redis_status() ) { - try { - $expiration = apply_filters( 'redis_cache_expiration', $this->validate_expiration( $expiration ), $key, $group ); - $start_time = microtime( true ); + /** + * Add or replace a value in the cache. + * + * Add does not set the value if the key exists; replace does not replace if the value doesn't exist. + * + * @param bool $add True if should only add if value doesn't exist, false to only add when value already exists. + * @param string $key The key under which to store the value. + * @param mixed $value The value to store. + * @param string $group The group value appended to the $key. + * @param int $expiration The expiration time, defaults to 0. + * @return bool Returns TRUE on success or FALSE on failure. + */ + protected function add_or_replace( $add, $key, $value, $group = 'default', $expiration = 0 ) { + $cache_addition_suspended = function_exists( 'wp_suspend_cache_addition' ) + ? wp_suspend_cache_addition() + : false; - if ( $add ) { - $args = [ $derived_key, $this->maybe_serialize( $value ) ]; + if ( $add && $cache_addition_suspended ) { + return false; + } - if ( $this->redis instanceof Predis\Client ) { - $args[] = 'nx'; + $result = true; + $derived_key = $this->build_key( $key, $group ); - if ( $expiration ) { - $args[] = 'ex'; - $args[] = $expiration; - } - } else { - if ( $expiration ) { - $args[] = [ - 'nx', - 'ex' => $expiration, - ]; - } else { - $args[] = [ 'nx' ]; - } - } + // Save if group not excluded and redis is up. + if ( ! $this->is_ignored_group( $group ) && $this->redis_status() ) { + try { + $expiration = apply_filters( 'redis_cache_expiration', $this->validate_expiration( $expiration ), $key, $group ); + $start_time = microtime( true ); + + if ( $add ) { + $args = [ $derived_key, $this->maybe_serialize( $value ) ]; - $result = $this->parse_redis_response( - $this->redis->set( ...$args ) - ); + if ( $this->redis instanceof Predis\Client ) { + $args[] = 'nx'; - if ( ! $result ) { - return false; + if ( $expiration ) { + $args[] = 'ex'; + $args[] = $expiration; } - } elseif ( $expiration ) { - $result = $this->parse_redis_response( $this->redis->setex( $derived_key, $expiration, $this->maybe_serialize( $value ) ) ); } else { - $result = $this->parse_redis_response( $this->redis->set( $derived_key, $this->maybe_serialize( $value ) ) ); + if ( $expiration ) { + $args[] = [ + 'nx', + 'ex' => $expiration, + ]; + } else { + $args[] = [ 'nx' ]; + } } - $execute_time = microtime( true ) - $start_time; - - $this->cache_calls++; - $this->cache_time += $execute_time; - } catch ( Exception $exception ) { - $this->handle_exception( $exception ); + $result = $this->parse_redis_response( + $this->redis->set( ...$args ) + ); - return false; + if ( ! $result ) { + return false; + } + } elseif ( $expiration ) { + $result = $this->parse_redis_response( $this->redis->setex( $derived_key, $expiration, $this->maybe_serialize( $value ) ) ); + } else { + $result = $this->parse_redis_response( $this->redis->set( $derived_key, $this->maybe_serialize( $value ) ) ); } - } - $exists = isset( $this->cache[ $derived_key ] ); + $execute_time = microtime( true ) - $start_time; + + $this->cache_calls++; + $this->cache_time += $execute_time; + } catch ( Exception $exception ) { + $this->handle_exception( $exception ); - if ( (bool) $add === $exists ) { return false; } + } - if ( $result ) { - $this->add_to_internal_cache( $derived_key, $value ); - } + $exists = isset( $this->cache[ $derived_key ] ); - return $result; + if ( (bool) $add === $exists ) { + return false; } - /** - * Remove the item from the cache. - * - * @param string $key The key under which to store the value. - * @param string $group The group value appended to the $key. - * @return bool Returns TRUE on success or FALSE on failure. - */ - public function delete( $key, $group = 'default' ) { - $result = false; - $derived_key = $this->build_key( $key, $group ); - - if ( isset( $this->cache[ $derived_key ] ) ) { - unset( $this->cache[ $derived_key ] ); - $result = true; - } + if ( $result ) { + $this->add_to_internal_cache( $derived_key, $value ); + } - $start_time = microtime( true ); + return $result; + } - if ( $this->redis_status() && ! $this->is_ignored_group( $group ) ) { - try { - $result = $this->parse_redis_response( $this->redis->del( $derived_key ) ); - } catch ( Exception $exception ) { - $this->handle_exception( $exception ); + /** + * Remove the item from the cache. + * + * @param string $key The key under which to store the value. + * @param string $group The group value appended to the $key. + * @return bool Returns TRUE on success or FALSE on failure. + */ + public function delete( $key, $group = 'default' ) { + $result = false; + $derived_key = $this->build_key( $key, $group ); - return false; - } - } + if ( isset( $this->cache[ $derived_key ] ) ) { + unset( $this->cache[ $derived_key ] ); + $result = true; + } - $execute_time = microtime( true ) - $start_time; + $start_time = microtime( true ); - $this->cache_calls++; - $this->cache_time += $execute_time; + if ( $this->redis_status() && ! $this->is_ignored_group( $group ) ) { + try { + $result = $this->parse_redis_response( $this->redis->del( $derived_key ) ); + } catch ( Exception $exception ) { + $this->handle_exception( $exception ); - if ( function_exists( 'do_action' ) ) { - do_action( 'redis_object_cache_delete', $key, $group, $execute_time ); + return false; } + } - return (bool) $result; + $execute_time = microtime( true ) - $start_time; + + $this->cache_calls++; + $this->cache_time += $execute_time; + + if ( function_exists( 'do_action' ) ) { + do_action( 'redis_object_cache_delete', $key, $group, $execute_time ); } - /** - * Invalidate all items in the cache. If `WP_REDIS_SELECTIVE_FLUSH` is `true`, - * only keys prefixed with the `WP_REDIS_PREFIX` are flushed. - * - * @param int $delay Number of seconds to wait before invalidating the items. - * @return bool Returns TRUE on success or FALSE on failure. - */ - public function flush( $delay = 0 ) { - $delay = abs( intval( $delay ) ); + return (bool) $result; + } - if ( $delay ) { - sleep( $delay ); - } + /** + * Invalidate all items in the cache. If `WP_REDIS_SELECTIVE_FLUSH` is `true`, + * only keys prefixed with the `WP_REDIS_PREFIX` are flushed. + * + * @param int $delay Number of seconds to wait before invalidating the items. + * @return bool Returns TRUE on success or FALSE on failure. + */ + public function flush( $delay = 0 ) { + $delay = abs( intval( $delay ) ); - $results = []; - $this->cache = array(); + if ( $delay ) { + sleep( $delay ); + } - if ( $this->redis_status() ) { - $salt = defined( 'WP_REDIS_PREFIX' ) ? trim( WP_REDIS_PREFIX ) : null; - $selective = defined( 'WP_REDIS_SELECTIVE_FLUSH' ) ? WP_REDIS_SELECTIVE_FLUSH : null; + $results = []; + $this->cache = array(); - $start_time = microtime( true ); + if ( $this->redis_status() ) { + $salt = defined( 'WP_REDIS_PREFIX' ) ? trim( WP_REDIS_PREFIX ) : null; + $selective = defined( 'WP_REDIS_SELECTIVE_FLUSH' ) ? WP_REDIS_SELECTIVE_FLUSH : null; - if ( $salt && $selective ) { - $script = $this->get_flush_closure( $salt ); - - if ( defined( 'WP_REDIS_CLUSTER' ) ) { - try { - foreach ( $this->redis->_masters() as $master ) { - $redis = new Redis(); - $redis->connect( $master[0], $master[1] ); - $results[] = $this->parse_redis_response( $script() ); - unset( $redis ); - } - } catch ( Exception $exception ) { - $this->handle_exception( $exception ); - - return false; - } - } else { - try { - $results[] = $this->parse_redis_response( $script() ); - } catch ( Exception $exception ) { - $this->handle_exception( $exception ); + $start_time = microtime( true ); + + if ( $salt && $selective ) { + $script = $this->get_flush_closure( $salt ); - return false; + if ( defined( 'WP_REDIS_CLUSTER' ) ) { + try { + foreach ( $this->redis->_masters() as $master ) { + $redis = new Redis(); + $redis->connect( $master[0], $master[1] ); + $results[] = $this->parse_redis_response( $script() ); + unset( $redis ); } + } catch ( Exception $exception ) { + $this->handle_exception( $exception ); + + return false; } } else { - if ( defined( 'WP_REDIS_CLUSTER' ) ) { - try { - foreach ( $this->redis->_masters() as $master ) { - $results[] = $this->parse_redis_response( $this->redis->flushdb( $master ) ); - } - } catch ( Exception $exception ) { - $this->handle_exception( $exception ); - - return false; - } - } else { - try { - $results[] = $this->parse_redis_response( $this->redis->flushdb() ); - } catch ( Exception $exception ) { - $this->handle_exception( $exception ); + try { + $results[] = $this->parse_redis_response( $script() ); + } catch ( Exception $exception ) { + $this->handle_exception( $exception ); - return false; - } + return false; } } + } else { + if ( defined( 'WP_REDIS_CLUSTER' ) ) { + try { + foreach ( $this->redis->_masters() as $master ) { + $results[] = $this->parse_redis_response( $this->redis->flushdb( $master ) ); + } + } catch ( Exception $exception ) { + $this->handle_exception( $exception ); - if ( function_exists( 'do_action' ) ) { - $execute_time = microtime( true ) - $start_time; + return false; + } + } else { + try { + $results[] = $this->parse_redis_response( $this->redis->flushdb() ); + } catch ( Exception $exception ) { + $this->handle_exception( $exception ); - do_action( 'redis_object_cache_flush', $results, $delay, $selective, $salt, $execute_time ); + return false; + } } } - if ( empty( $results ) ) { - return false; - } + if ( function_exists( 'do_action' ) ) { + $execute_time = microtime( true ) - $start_time; - foreach ( $results as $result ) { - if ( ! $result ) { - return false; - } + do_action( 'redis_object_cache_flush', $results, $delay, $selective, $salt, $execute_time ); } + } - return true; + if ( empty( $results ) ) { + return false; } - /** - * Returns a closure to flush selectively. - * - * @param string $salt The salt to be used to differentiate. - * @return callable Generated callable executing the lua script. - */ - protected function get_flush_closure( $salt ) { - if ( $this->unflushable_groups ) { - return $this->lua_flush_extended_closure( $salt ); - } else { - return $this->lua_flush_closure( $salt ); + foreach ( $results as $result ) { + if ( ! $result ) { + return false; } } - /** - * Quotes a string for usage in the `glob` function - * - * @param string $string The string to quote. - * @return string - */ - protected function glob_quote( $string ) { - $characters = [ '*', '+', '?', '!', '{', '}', '[', ']', '(', ')', '|', '@' ]; - - return str_replace( - $characters, - array_map( - function ( $character ) { - return "[{$character}]"; - }, - $characters - ), - $string - ); + return true; + } + + /** + * Returns a closure to flush selectively. + * + * @param string $salt The salt to be used to differentiate. + * @return callable Generated callable executing the lua script. + */ + protected function get_flush_closure( $salt ) { + if ( $this->unflushable_groups ) { + return $this->lua_flush_extended_closure( $salt ); + } else { + return $this->lua_flush_closure( $salt ); } + } - /** - * Returns a closure ready to be called to flush selectively ignoring unflushable groups. - * - * @param string $salt The salt to be used to differentiate. - * @return callable Generated callable executing the lua script. - */ - protected function lua_flush_closure( $salt ) { - $salt = $this->glob_quote( $salt ); - - return function () use ( $salt ) { - $script = <<glob_quote( $salt ); + + return function () use ( $salt ) { + $script = <<redis_version(), '5', '<' ) && version_compare( $this->redis_version(), '3.2', '>=' ) ) { - $script = 'redis.replicate_commands()' . "\n" . $script; - } + if ( version_compare( $this->redis_version(), '5', '<' ) && version_compare( $this->redis_version(), '3.2', '>=' ) ) { + $script = 'redis.replicate_commands()' . "\n" . $script; + } - $args = ( $this->redis instanceof Predis\Client ) - ? [ $script, 0 ] - : [ $script ]; + $args = ( $this->redis instanceof Predis\Client ) + ? [ $script, 0 ] + : [ $script ]; - return call_user_func_array( [ $this->redis, 'eval' ], $args ); - }; - } + return call_user_func_array( [ $this->redis, 'eval' ], $args ); + }; + } - /** - * Returns a closure ready to be called to flush selectively. - * - * @param string $salt The salt to be used to differentiate. - * @return callable Generated callable executing the lua script. - */ - protected function lua_flush_extended_closure( $salt ) { - $salt = $this->glob_quote( $salt ); + /** + * Returns a closure ready to be called to flush selectively. + * + * @param string $salt The salt to be used to differentiate. + * @return callable Generated callable executing the lua script. + */ + protected function lua_flush_extended_closure( $salt ) { + $salt = $this->glob_quote( $salt ); - return function () use ( $salt ) { - $salt_length = strlen( $salt ); + return function () use ( $salt ) { + $salt_length = strlen( $salt ); - $unflushable = array_map( - function ( $group ) { - return ":{$group}:"; - }, - $this->unflushable_groups - ); + $unflushable = array_map( + function ( $group ) { + return ":{$group}:"; + }, + $this->unflushable_groups + ); - $script = <<redis_version(), '5', '<' ) && version_compare( $this->redis_version(), '3.2', '>=' ) ) { - $script = 'redis.replicate_commands()' . "\n" . $script; - } + if ( version_compare( $this->redis_version(), '5', '<' ) && version_compare( $this->redis_version(), '3.2', '>=' ) ) { + $script = 'redis.replicate_commands()' . "\n" . $script; + } - $args = ( $this->redis instanceof Predis\Client ) - ? array_merge( [ $script, count( $unflushable ) ], $unflushable ) - : [ $script, $unflushable, count( $unflushable ) ]; - - return call_user_func_array( [ $this->redis, 'eval' ], $args ); - }; - } - - /** - * Retrieve object from cache. - * - * Gets an object from cache based on $key and $group. - * - * @param string $key The key under which to store the value. - * @param string $group The group value appended to the $key. - * @param string $force Optional. Whether to force a refetch rather than relying on the local - * cache. Default false. - * @param bool $found Optional. Whether the key was found in the cache. Disambiguates a return of - * false, a storable value. Passed by reference. Default null. - * @return bool|mixed Cached object value. - */ - public function get( $key, $group = 'default', $force = false, &$found = null ) { - $derived_key = $this->build_key( $key, $group ); - - if ( isset( $this->cache[ $derived_key ] ) && ! $force ) { - $found = true; - $this->cache_hits++; + $args = ( $this->redis instanceof Predis\Client ) + ? array_merge( [ $script, count( $unflushable ) ], $unflushable ) + : [ $script, $unflushable, count( $unflushable ) ]; - return $this->get_from_internal_cache( $derived_key ); - } elseif ( $this->is_ignored_group( $group ) || ! $this->redis_status() ) { - $found = false; - $this->cache_misses++; + return call_user_func_array( [ $this->redis, 'eval' ], $args ); + }; + } - return false; - } - - $start_time = microtime( true ); + /** + * Retrieve object from cache. + * + * Gets an object from cache based on $key and $group. + * + * @param string $key The key under which to store the value. + * @param string $group The group value appended to the $key. + * @param string $force Optional. Whether to force a refetch rather than relying on the local + * cache. Default false. + * @param bool $found Optional. Whether the key was found in the cache. Disambiguates a return of + * false, a storable value. Passed by reference. Default null. + * @return bool|mixed Cached object value. + */ + public function get( $key, $group = 'default', $force = false, &$found = null ) { + $derived_key = $this->build_key( $key, $group ); - try { - $result = $this->redis->get( $derived_key ); - } catch ( Exception $exception ) { - $this->handle_exception( $exception ); + if ( isset( $this->cache[ $derived_key ] ) && ! $force ) { + $found = true; + $this->cache_hits++; - return false; - } + return $this->get_from_internal_cache( $derived_key ); + } elseif ( $this->is_ignored_group( $group ) || ! $this->redis_status() ) { + $found = false; + $this->cache_misses++; - $execute_time = microtime( true ) - $start_time; + return false; + } - $this->cache_calls++; - $this->cache_time += $execute_time; + $start_time = microtime( true ); - if ( $result === null || $result === false ) { - $found = false; - $this->cache_misses++; + try { + $result = $this->redis->get( $derived_key ); + } catch ( Exception $exception ) { + $this->handle_exception( $exception ); - return false; - } else { - $found = true; - $this->cache_hits++; - $value = $this->maybe_unserialize( $result ); - } + return false; + } - $this->add_to_internal_cache( $derived_key, $value ); + $execute_time = microtime( true ) - $start_time; - if ( function_exists( 'do_action' ) ) { - do_action( 'redis_object_cache_get', $key, $value, $group, $force, $found, $execute_time ); - } + $this->cache_calls++; + $this->cache_time += $execute_time; - if ( function_exists( 'apply_filters' ) && function_exists( 'has_filter' ) ) { - if ( has_filter( 'redis_object_cache_get_value' ) ) { - return apply_filters( 'redis_object_cache_get_value', $value, $key, $group, $force, $found ); - } - } + if ( $result === null || $result === false ) { + $found = false; + $this->cache_misses++; - return $value; + return false; + } else { + $found = true; + $this->cache_hits++; + $value = $this->maybe_unserialize( $result ); } - /** - * Retrieves multiple values from the cache in one call. - * - * @param array $keys Array of keys under which the cache contents are stored. - * @param string $group Optional. Where the cache contents are grouped. Default empty. - * @param bool $force Optional. Whether to force an update of the local cache - * from the persistent cache. Default false. - * @return array Array of values organized into groups. - */ - public function get_multiple( $keys, $group = 'default', $force = false ) { - if ( ! is_array( $keys ) ) { - return false; - } - - $cache = array(); - $derived_keys = array(); - - foreach ( $keys as $key ) { - $derived_keys[ $key ] = $this->build_key( $key, $group ); - } + $this->add_to_internal_cache( $derived_key, $value ); - if ( $this->is_ignored_group( $group ) || ! $this->redis_status() ) { - foreach ( $keys as $key ) { - $cache[ $key ] = $this->get_from_internal_cache( $derived_keys[ $key ] ); - $cache[ $key ] === false ? $this->cache_misses++ : $this->cache_hits++; - } + if ( function_exists( 'do_action' ) ) { + do_action( 'redis_object_cache_get', $key, $value, $group, $force, $found, $execute_time ); + } - return $cache; + if ( function_exists( 'apply_filters' ) && function_exists( 'has_filter' ) ) { + if ( has_filter( 'redis_object_cache_get_value' ) ) { + return apply_filters( 'redis_object_cache_get_value', $value, $key, $group, $force, $found ); } + } - if ( ! $force ) { - foreach ( $keys as $key ) { - $value = $this->get_from_internal_cache( $derived_keys[ $key ] ); - - if ( $value === false ) { - $this->cache_misses++; - } else { - $cache[ $key ] = $value; - $this->cache_hits++; - } - } - } - - $remaining_keys = array_filter( - $keys, - function ( $key ) use ( $cache ) { - return ! isset( $cache[ $key ] ); - } - ); - - if ( empty( $remaining_keys ) ) { - return $cache; - } + return $value; + } - $start_time = microtime( true ); + /** + * Retrieves multiple values from the cache in one call. + * + * @param array $keys Array of keys under which the cache contents are stored. + * @param string $group Optional. Where the cache contents are grouped. Default empty. + * @param bool $force Optional. Whether to force an update of the local cache + * from the persistent cache. Default false. + * @return array Array of values organized into groups. + */ + public function get_multiple( $keys, $group = 'default', $force = false ) { + if ( ! is_array( $keys ) ) { + return false; + } - try { - $remaining_ids = array_map( - function ( $key ) use ( $derived_keys ) { - return $derived_keys[ $key ]; - }, - $remaining_keys - ); + $cache = array(); + $derived_keys = array(); - $results = array_combine( - $remaining_keys, - $this->redis->mget( $remaining_ids ) - ); - } catch ( Exception $exception ) { - $this->handle_exception( $exception ); + foreach ( $keys as $key ) { + $derived_keys[ $key ] = $this->build_key( $key, $group ); + } - $cache = array_fill( 0, count( $derived_keys ) - 1, false ); + if ( $this->is_ignored_group( $group ) || ! $this->redis_status() ) { + foreach ( $keys as $key ) { + $cache[ $key ] = $this->get_from_internal_cache( $derived_keys[ $key ] ); + $cache[ $key ] === false ? $this->cache_misses++ : $this->cache_hits++; } - $execute_time = microtime( true ) - $start_time; + return $cache; + } - $this->cache_calls++; - $this->cache_time += $execute_time; + if ( ! $force ) { + foreach ( $keys as $key ) { + $value = $this->get_from_internal_cache( $derived_keys[ $key ] ); - foreach ( $results as $key => $value ) { - if ( $value === null || $value === false ) { - $cache[ $key ] = false; + if ( $value === false ) { $this->cache_misses++; } else { - $cache[ $key ] = $this->maybe_unserialize( $value ); - $this->add_to_internal_cache( $derived_keys[ $key ], $cache[ $key ] ); - + $cache[ $key ] = $value; $this->cache_hits++; } } + } - if ( function_exists( 'do_action' ) ) { - do_action( 'redis_object_cache_get_multiple', $keys, $cache, $group, $force, $execute_time ); - } - - if ( function_exists( 'apply_filters' ) && function_exists( 'has_filter' ) ) { - if ( has_filter( 'redis_object_cache_get_value' ) ) { - foreach ( $cache as $key => $value ) { - $cache[ $key ] = apply_filters( 'redis_object_cache_get_value', $value, $key, $group, $force ); - } - } + $remaining_keys = array_filter( + $keys, + function ( $key ) use ( $cache ) { + return ! isset( $cache[ $key ] ); } + ); + if ( empty( $remaining_keys ) ) { return $cache; } - /** - * Sets a value in cache. - * - * The value is set whether or not this key already exists in Redis. - * - * @param string $key The key under which to store the value. - * @param mixed $value The value to store. - * @param string $group The group value appended to the $key. - * @param int $expiration The expiration time, defaults to 0. - * @return bool Returns TRUE on success or FALSE on failure. - */ - public function set( $key, $value, $group = 'default', $expiration = 0 ) { - $result = true; - $derived_key = $this->build_key( $key, $group ); + $start_time = microtime( true ); - $start_time = microtime( true ); + try { + $remaining_ids = array_map( + function ( $key ) use ( $derived_keys ) { + return $derived_keys[ $key ]; + }, + $remaining_keys + ); - // Save if group not excluded from redis and redis is up. - if ( ! $this->is_ignored_group( $group ) && $this->redis_status() ) { - $expiration = apply_filters( 'redis_cache_expiration', $this->validate_expiration( $expiration ), $key, $group ); + $results = array_combine( + $remaining_keys, + $this->redis->mget( $remaining_ids ) + ); + } catch ( Exception $exception ) { + $this->handle_exception( $exception ); - try { - if ( $expiration ) { - $result = $this->parse_redis_response( $this->redis->setex( $derived_key, $expiration, $this->maybe_serialize( $value ) ) ); - } else { - $result = $this->parse_redis_response( $this->redis->set( $derived_key, $this->maybe_serialize( $value ) ) ); - } - } catch ( Exception $exception ) { - $this->handle_exception( $exception ); + $cache = array_fill( 0, count( $derived_keys ) - 1, false ); + } - return false; - } + $execute_time = microtime( true ) - $start_time; - $this->cache_calls++; - $this->cache_time += ( microtime( true ) - $start_time ); - } + $this->cache_calls++; + $this->cache_time += $execute_time; + + foreach ( $results as $key => $value ) { + if ( $value === null || $value === false ) { + $cache[ $key ] = false; + $this->cache_misses++; + } else { + $cache[ $key ] = $this->maybe_unserialize( $value ); + $this->add_to_internal_cache( $derived_keys[ $key ], $cache[ $key ] ); - // If the set was successful, or we didn't go to redis. - if ( $result ) { - $this->add_to_internal_cache( $derived_key, $value ); + $this->cache_hits++; } + } - if ( function_exists( 'do_action' ) ) { - $execute_time = microtime( true ) - $start_time; + if ( function_exists( 'do_action' ) ) { + do_action( 'redis_object_cache_get_multiple', $keys, $cache, $group, $force, $execute_time ); + } - do_action( 'redis_object_cache_set', $key, $value, $group, $expiration, $execute_time ); + if ( function_exists( 'apply_filters' ) && function_exists( 'has_filter' ) ) { + if ( has_filter( 'redis_object_cache_get_value' ) ) { + foreach ( $cache as $key => $value ) { + $cache[ $key ] = apply_filters( 'redis_object_cache_get_value', $value, $key, $group, $force ); + } } - - return $result; } - /** - * Increment a Redis counter by the amount specified - * - * @param string $key The key name. - * @param int $offset Optional. The increment. Defaults to 1. - * @param string $group Optional. The key group. Default is 'default'. - * @return int|bool - */ - public function increment( $key, $offset = 1, $group = 'default' ) { - $offset = (int) $offset; - $derived_key = $this->build_key( $key, $group ); + return $cache; + } - // If group is a non-Redis group, save to internal cache, not Redis. - if ( $this->is_ignored_group( $group ) || ! $this->redis_status() ) { - $value = $this->get_from_internal_cache( $derived_key ); - $value += $offset; - $this->add_to_internal_cache( $derived_key, $value ); + /** + * Sets a value in cache. + * + * The value is set whether or not this key already exists in Redis. + * + * @param string $key The key under which to store the value. + * @param mixed $value The value to store. + * @param string $group The group value appended to the $key. + * @param int $expiration The expiration time, defaults to 0. + * @return bool Returns TRUE on success or FALSE on failure. + */ + public function set( $key, $value, $group = 'default', $expiration = 0 ) { + $result = true; + $derived_key = $this->build_key( $key, $group ); - return $value; - } + $start_time = microtime( true ); - $start_time = microtime( true ); + // Save if group not excluded from redis and redis is up. + if ( ! $this->is_ignored_group( $group ) && $this->redis_status() ) { + $expiration = apply_filters( 'redis_cache_expiration', $this->validate_expiration( $expiration ), $key, $group ); try { - $result = $this->parse_redis_response( $this->redis->incrBy( $derived_key, $offset ) ); - - $this->add_to_internal_cache( $derived_key, (int) $this->redis->get( $derived_key ) ); + if ( $expiration ) { + $result = $this->parse_redis_response( $this->redis->setex( $derived_key, $expiration, $this->maybe_serialize( $value ) ) ); + } else { + $result = $this->parse_redis_response( $this->redis->set( $derived_key, $this->maybe_serialize( $value ) ) ); + } } catch ( Exception $exception ) { $this->handle_exception( $exception ); return false; } + $this->cache_calls++; + $this->cache_time += ( microtime( true ) - $start_time ); + } + + // If the set was successful, or we didn't go to redis. + if ( $result ) { + $this->add_to_internal_cache( $derived_key, $value ); + } + + if ( function_exists( 'do_action' ) ) { $execute_time = microtime( true ) - $start_time; - $this->cache_calls += 2; - $this->cache_time += $execute_time; - - return $result; - } - - /** - * Alias of `increment()`. - * - * @see self::increment() - * @param string $key The key name. - * @param int $offset Optional. The increment. Defaults to 1. - * @param string $group Optional. The key group. Default is 'default'. - * @return int|bool - */ - public function incr( $key, $offset = 1, $group = 'default' ) { - return $this->increment( $key, $offset, $group ); - } - - /** - * Decrement a Redis counter by the amount specified - * - * @param string $key The key name. - * @param int $offset Optional. The decrement. Defaults to 1. - * @param string $group Optional. The key group. Default is 'default'. - * @return int|bool - */ - public function decrement( $key, $offset = 1, $group = 'default' ) { - $derived_key = $this->build_key( $key, $group ); - $offset = (int) $offset; - - // If group is a non-Redis group, save to internal cache, not Redis. - if ( $this->is_ignored_group( $group ) || ! $this->redis_status() ) { - $value = $this->get_from_internal_cache( $derived_key ); - $value -= $offset; - $this->add_to_internal_cache( $derived_key, $value ); - - return $value; - } + do_action( 'redis_object_cache_set', $key, $value, $group, $expiration, $execute_time ); + } - $start_time = microtime( true ); + return $result; + } - try { - // Save to Redis. - $result = $this->parse_redis_response( $this->redis->decrBy( $derived_key, $offset ) ); + /** + * Increment a Redis counter by the amount specified + * + * @param string $key The key name. + * @param int $offset Optional. The increment. Defaults to 1. + * @param string $group Optional. The key group. Default is 'default'. + * @return int|bool + */ + public function increment( $key, $offset = 1, $group = 'default' ) { + $offset = (int) $offset; + $derived_key = $this->build_key( $key, $group ); + + // If group is a non-Redis group, save to internal cache, not Redis. + if ( $this->is_ignored_group( $group ) || ! $this->redis_status() ) { + $value = $this->get_from_internal_cache( $derived_key ); + $value += $offset; + $this->add_to_internal_cache( $derived_key, $value ); - $this->add_to_internal_cache( $derived_key, (int) $this->redis->get( $derived_key ) ); - } catch ( Exception $exception ) { - $this->handle_exception( $exception ); + return $value; + } - return false; - } + $start_time = microtime( true ); - $execute_time = microtime( true ) - $start_time; + try { + $result = $this->parse_redis_response( $this->redis->incrBy( $derived_key, $offset ) ); - $this->cache_calls += 2; - $this->cache_time += $execute_time; - - return $result; - } - - /** - * Render data about current cache requests - * Used by the Debug bar plugin - * - * @return void - */ - public function stats() { - $bytes = strlen( serialize( $wp_object_cache->cache ) ); // phpcs:ignore WordPress.PHP.DiscouragedPHPFunctions.serialize_serialize - - ?> -

- Redis Status: - redis_status() ? 'Connected' : 'Not connected'; ?> -
- Redis Client: - diagnostics['client'] ?: 'Unknown'; ?> -
- Cache Hits: - cache_hits ); ?> -
- Cache Misses: - cache_misses ); ?> -
- Cache Size: - kB -

- cache_hits + $this->cache_misses; - - $bytes = array_map( - function ( $keys ) { - // phpcs:ignore WordPress.PHP.DiscouragedPHPFunctions.serialize_serialize - return strlen( serialize( $keys ) ); - }, - $this->cache - ); + $this->add_to_internal_cache( $derived_key, (int) $this->redis->get( $derived_key ) ); + } catch ( Exception $exception ) { + $this->handle_exception( $exception ); - return (object) [ - 'hits' => $this->cache_hits, - 'misses' => $this->cache_misses, - 'ratio' => $total > 0 ? round( $this->cache_hits / ( $total / 100 ), 1 ) : 100, - 'bytes' => array_sum( $bytes ), - 'time' => $this->cache_time, - 'calls' => $this->cache_calls, - 'groups' => (object) [ - 'global' => $this->global_groups, - 'non_persistent' => $this->ignored_groups, - 'unflushable' => $this->unflushable_groups, - ], - 'errors' => empty( $this->errors ) ? null : $this->errors, - 'meta' => [ - 'Client' => $this->diagnostics['client'] ?: 'Unknown', - 'Redis Version' => $this->redis_version, - ], - ]; + return false; } - /** - * Builds a key for the cached object using the prefix, group and key. - * - * @param string $key The key under which to store the value. - * @param string $group The group value appended to the $key. - * - * @return string - */ - public function build_key( $key, $group = 'default' ) { - if ( empty( $group ) ) { - $group = 'default'; - } + $execute_time = microtime( true ) - $start_time; - $salt = defined( 'WP_REDIS_PREFIX' ) ? trim( WP_REDIS_PREFIX ) : ''; - $prefix = $this->is_global_group( $group ) ? $this->global_prefix : $this->blog_prefix; - - $key = $this->sanitize_key_part( $key ); - $group = $this->sanitize_key_part( $group ); - - $prefix = trim( $prefix, '_-:$' ); - - return "{$salt}{$prefix}:{$group}:{$key}"; - } - - /** - * Replaces the set group separator by another one - * - * @param string $part The string to sanitize. - * @return string Sanitized string. - */ - protected function sanitize_key_part( $part ) { - return str_replace( ':', '-', $part ); - } - - /** - * Checks if the given group is part the ignored group array - * - * @param string $group Name of the group to check. - * @return bool - */ - protected function is_ignored_group( $group ) { - return in_array( $this->sanitize_key_part( $group ), $this->ignored_groups, true ); - } - - /** - * Checks if the given group is part the global group array - * - * @param string $group Name of the group to check. - * @return bool - */ - protected function is_global_group( $group ) { - return in_array( $this->sanitize_key_part( $group ), $this->global_groups, true ); - } - - /** - * Checks if the given group is part the unflushable group array - * - * @param string $group Name of the group to check. - * @return bool - */ - protected function is_unflushable_group( $group ) { - return in_array( $this->sanitize_key_part( $group ), $this->unflushable_groups, true ); - } - - /** - * Convert Redis responses into something meaningful - * - * @param mixed $response Response sent from the redis instance. - * @return mixed - */ - protected function parse_redis_response( $response ) { - if ( is_bool( $response ) ) { - return $response; - } + $this->cache_calls += 2; + $this->cache_time += $execute_time; - if ( is_numeric( $response ) ) { - return $response; - } + return $result; + } - if ( is_object( $response ) && method_exists( $response, 'getPayload' ) ) { - return $response->getPayload() === 'OK'; - } + /** + * Alias of `increment()`. + * + * @see self::increment() + * @param string $key The key name. + * @param int $offset Optional. The increment. Defaults to 1. + * @param string $group Optional. The key group. Default is 'default'. + * @return int|bool + */ + public function incr( $key, $offset = 1, $group = 'default' ) { + return $this->increment( $key, $offset, $group ); + } - return false; + /** + * Decrement a Redis counter by the amount specified + * + * @param string $key The key name. + * @param int $offset Optional. The decrement. Defaults to 1. + * @param string $group Optional. The key group. Default is 'default'. + * @return int|bool + */ + public function decrement( $key, $offset = 1, $group = 'default' ) { + $derived_key = $this->build_key( $key, $group ); + $offset = (int) $offset; + + // If group is a non-Redis group, save to internal cache, not Redis. + if ( $this->is_ignored_group( $group ) || ! $this->redis_status() ) { + $value = $this->get_from_internal_cache( $derived_key ); + $value -= $offset; + $this->add_to_internal_cache( $derived_key, $value ); + + return $value; } - /** - * Simple wrapper for saving object to the internal cache. - * - * @param string $derived_key Key to save value under. - * @param mixed $value Object value. - */ - public function add_to_internal_cache( $derived_key, $value ) { - if ( is_object( $value ) ) { - $value = clone $value; - } + $start_time = microtime( true ); + + try { + // Save to Redis. + $result = $this->parse_redis_response( $this->redis->decrBy( $derived_key, $offset ) ); - $this->cache[ $derived_key ] = $value; + $this->add_to_internal_cache( $derived_key, (int) $this->redis->get( $derived_key ) ); + } catch ( Exception $exception ) { + $this->handle_exception( $exception ); + + return false; } - /** - * Get a value specifically from the internal, run-time cache, not Redis. - * - * @param int|string $derived_key Key value. - * - * @return bool|mixed Value on success; false on failure. - */ - public function get_from_internal_cache( $derived_key ) { - if ( ! isset( $this->cache[ $derived_key ] ) ) { - return false; - } + $execute_time = microtime( true ) - $start_time; - if ( is_object( $this->cache[ $derived_key ] ) ) { - return clone $this->cache[ $derived_key ]; - } + $this->cache_calls += 2; + $this->cache_time += $execute_time; + + return $result; + } + + /** + * Render data about current cache requests + * Used by the Debug bar plugin + * + * @return void + */ + public function stats() { + $bytes = strlen( serialize( $wp_object_cache->cache ) ); // phpcs:ignore WordPress.PHP.DiscouragedPHPFunctions.serialize_serialize + + ?> +

+ Redis Status: + redis_status() ? 'Connected' : 'Not connected'; ?> +
+ Redis Client: + diagnostics['client'] ?: 'Unknown'; ?> +
+ Cache Hits: + cache_hits ); ?> +
+ Cache Misses: + cache_misses ); ?> +
+ Cache Size: + kB +

+ cache[ $derived_key ]; + /** + * Returns various information about the object cache. + * + * @return object + */ + public function info() { + $total = $this->cache_hits + $this->cache_misses; + + $bytes = array_map( + function ( $keys ) { + // phpcs:ignore WordPress.PHP.DiscouragedPHPFunctions.serialize_serialize + return strlen( serialize( $keys ) ); + }, + $this->cache + ); + + return (object) [ + 'hits' => $this->cache_hits, + 'misses' => $this->cache_misses, + 'ratio' => $total > 0 ? round( $this->cache_hits / ( $total / 100 ), 1 ) : 100, + 'bytes' => array_sum( $bytes ), + 'time' => $this->cache_time, + 'calls' => $this->cache_calls, + 'groups' => (object) [ + 'global' => $this->global_groups, + 'non_persistent' => $this->ignored_groups, + 'unflushable' => $this->unflushable_groups, + ], + 'errors' => empty( $this->errors ) ? null : $this->errors, + 'meta' => [ + 'Client' => $this->diagnostics['client'] ?: 'Unknown', + 'Redis Version' => $this->redis_version, + ], + ]; + } + + /** + * Builds a key for the cached object using the prefix, group and key. + * + * @param string $key The key under which to store the value. + * @param string $group The group value appended to the $key. + * + * @return string + */ + public function build_key( $key, $group = 'default' ) { + if ( empty( $group ) ) { + $group = 'default'; } - /** - * In multisite, switch blog prefix when switching blogs - * - * @param int $_blog_id Blog ID. - * @return bool - */ - public function switch_to_blog( $_blog_id ) { - if ( ! function_exists( 'is_multisite' ) || ! is_multisite() ) { - return false; - } + $salt = defined( 'WP_REDIS_PREFIX' ) ? trim( WP_REDIS_PREFIX ) : ''; + $prefix = $this->is_global_group( $group ) ? $this->global_prefix : $this->blog_prefix; - $this->blog_prefix = $_blog_id; + $key = $this->sanitize_key_part( $key ); + $group = $this->sanitize_key_part( $group ); - return true; + $prefix = trim( $prefix, '_-:$' ); + + return "{$salt}{$prefix}:{$group}:{$key}"; + } + + /** + * Replaces the set group separator by another one + * + * @param string $part The string to sanitize. + * @return string Sanitized string. + */ + protected function sanitize_key_part( $part ) { + return str_replace( ':', '-', $part ); + } + + /** + * Checks if the given group is part the ignored group array + * + * @param string $group Name of the group to check. + * @return bool + */ + protected function is_ignored_group( $group ) { + return in_array( $this->sanitize_key_part( $group ), $this->ignored_groups, true ); + } + + /** + * Checks if the given group is part the global group array + * + * @param string $group Name of the group to check. + * @return bool + */ + protected function is_global_group( $group ) { + return in_array( $this->sanitize_key_part( $group ), $this->global_groups, true ); + } + + /** + * Checks if the given group is part the unflushable group array + * + * @param string $group Name of the group to check. + * @return bool + */ + protected function is_unflushable_group( $group ) { + return in_array( $this->sanitize_key_part( $group ), $this->unflushable_groups, true ); + } + + /** + * Convert Redis responses into something meaningful + * + * @param mixed $response Response sent from the redis instance. + * @return mixed + */ + protected function parse_redis_response( $response ) { + if ( is_bool( $response ) ) { + return $response; } - /** - * Sets the list of global groups. - * - * @param array $groups List of groups that are global. - */ - public function add_global_groups( $groups ) { - $groups = (array) $groups; + if ( is_numeric( $response ) ) { + return $response; + } - if ( $this->redis_status() ) { - $this->global_groups = array_unique( array_merge( $this->global_groups, $groups ) ); - } else { - $this->ignored_groups = array_unique( array_merge( $this->ignored_groups, $groups ) ); - } + if ( is_object( $response ) && method_exists( $response, 'getPayload' ) ) { + return $response->getPayload() === 'OK'; } - /** - * Sets the list of groups not to be cached by Redis. - * - * @param array $groups List of groups that are to be ignored. - */ - public function add_non_persistent_groups( $groups ) { - $groups = (array) $groups; + return false; + } - $this->ignored_groups = array_unique( array_merge( $this->ignored_groups, $groups ) ); + /** + * Simple wrapper for saving object to the internal cache. + * + * @param string $derived_key Key to save value under. + * @param mixed $value Object value. + */ + public function add_to_internal_cache( $derived_key, $value ) { + if ( is_object( $value ) ) { + $value = clone $value; } - /** - * Sets the list of groups not to flushed cached. - * - * @param array $groups List of groups that are unflushable. - */ - public function add_unflushable_groups( $groups ) { - $groups = (array) $groups; + $this->cache[ $derived_key ] = $value; + } - $this->unflushable_groups = array_unique( array_merge( $this->unflushable_groups, $groups ) ); + /** + * Get a value specifically from the internal, run-time cache, not Redis. + * + * @param int|string $derived_key Key value. + * + * @return bool|mixed Value on success; false on failure. + */ + public function get_from_internal_cache( $derived_key ) { + if ( ! isset( $this->cache[ $derived_key ] ) ) { + return false; } - /** - * Wrapper to validate the cache keys expiration value - * - * @param mixed $expiration Incoming expiration value (whatever it is). - */ - protected function validate_expiration( $expiration ) { - $expiration = is_int( $expiration ) || ctype_digit( $expiration ) ? (int) $expiration : 0; + if ( is_object( $this->cache[ $derived_key ] ) ) { + return clone $this->cache[ $derived_key ]; + } - if ( defined( 'WP_REDIS_MAXTTL' ) ) { - $max = (int) WP_REDIS_MAXTTL; + return $this->cache[ $derived_key ]; + } - if ( $expiration === 0 || $expiration > $max ) { - $expiration = $max; - } - } + /** + * In multisite, switch blog prefix when switching blogs + * + * @param int $_blog_id Blog ID. + * @return bool + */ + public function switch_to_blog( $_blog_id ) { + if ( ! function_exists( 'is_multisite' ) || ! is_multisite() ) { + return false; + } + + $this->blog_prefix = $_blog_id; + + return true; + } - return $expiration; + /** + * Sets the list of global groups. + * + * @param array $groups List of groups that are global. + */ + public function add_global_groups( $groups ) { + $groups = (array) $groups; + + if ( $this->redis_status() ) { + $this->global_groups = array_unique( array_merge( $this->global_groups, $groups ) ); + } else { + $this->ignored_groups = array_unique( array_merge( $this->ignored_groups, $groups ) ); } + } - /** - * Unserialize value only if it was serialized. - * - * @param string $original Maybe unserialized original, if is needed. - * @return mixed Unserialized data can be any type. - */ - protected function maybe_unserialize( $original ) { - if ( defined( 'WP_REDIS_SERIALIZER' ) && ! empty( WP_REDIS_SERIALIZER ) ) { - return $original; - } + /** + * Sets the list of groups not to be cached by Redis. + * + * @param array $groups List of groups that are to be ignored. + */ + public function add_non_persistent_groups( $groups ) { + $groups = (array) $groups; - if ( defined( 'WP_REDIS_IGBINARY' ) && WP_REDIS_IGBINARY && function_exists( 'igbinary_unserialize' ) ) { - return igbinary_unserialize( $original ); - } + $this->ignored_groups = array_unique( array_merge( $this->ignored_groups, $groups ) ); + } - // Don't attempt to unserialize data that wasn't serialized going in. - if ( $this->is_serialized( $original ) ) { - // phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged, WordPress.PHP.DiscouragedPHPFunctions.serialize_unserialize - $value = @unserialize( $original ); + /** + * Sets the list of groups not to flushed cached. + * + * @param array $groups List of groups that are unflushable. + */ + public function add_unflushable_groups( $groups ) { + $groups = (array) $groups; - return is_object( $value ) ? clone $value : $value; + $this->unflushable_groups = array_unique( array_merge( $this->unflushable_groups, $groups ) ); + } + + /** + * Wrapper to validate the cache keys expiration value + * + * @param mixed $expiration Incoming expiration value (whatever it is). + */ + protected function validate_expiration( $expiration ) { + $expiration = is_int( $expiration ) || ctype_digit( $expiration ) ? (int) $expiration : 0; + + if ( defined( 'WP_REDIS_MAXTTL' ) ) { + $max = (int) WP_REDIS_MAXTTL; + + if ( $expiration === 0 || $expiration > $max ) { + $expiration = $max; } + } + + return $expiration; + } + /** + * Unserialize value only if it was serialized. + * + * @param string $original Maybe unserialized original, if is needed. + * @return mixed Unserialized data can be any type. + */ + protected function maybe_unserialize( $original ) { + if ( defined( 'WP_REDIS_SERIALIZER' ) && ! empty( WP_REDIS_SERIALIZER ) ) { return $original; } - /** - * Serialize data, if needed. - * - * @param mixed $data Data that might be serialized. - * @return mixed A scalar data - */ - protected function maybe_serialize( $data ) { - if ( is_object( $data ) ) { - $data = clone $data; - } + if ( defined( 'WP_REDIS_IGBINARY' ) && WP_REDIS_IGBINARY && function_exists( 'igbinary_unserialize' ) ) { + return igbinary_unserialize( $original ); + } - if ( defined( 'WP_REDIS_SERIALIZER' ) && ! empty( WP_REDIS_SERIALIZER ) ) { - return $data; - } + // Don't attempt to unserialize data that wasn't serialized going in. + if ( $this->is_serialized( $original ) ) { + // phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged, WordPress.PHP.DiscouragedPHPFunctions.serialize_unserialize + $value = @unserialize( $original ); - if ( defined( 'WP_REDIS_IGBINARY' ) && WP_REDIS_IGBINARY && function_exists( 'igbinary_serialize' ) ) { - return igbinary_serialize( $data ); - } + return is_object( $value ) ? clone $value : $value; + } - if ( is_array( $data ) || is_object( $data ) ) { - // phpcs:ignore WordPress.PHP.DiscouragedPHPFunctions.serialize_serialize - return serialize( $data ); - } + return $original; + } - if ( $this->is_serialized( $data, false ) ) { - // phpcs:ignore WordPress.PHP.DiscouragedPHPFunctions.serialize_serialize - return serialize( $data ); - } + /** + * Serialize data, if needed. + * + * @param mixed $data Data that might be serialized. + * @return mixed A scalar data + */ + protected function maybe_serialize( $data ) { + if ( is_object( $data ) ) { + $data = clone $data; + } + if ( defined( 'WP_REDIS_SERIALIZER' ) && ! empty( WP_REDIS_SERIALIZER ) ) { return $data; } - /** - * Check value to find if it was serialized. - * - * If $data is not an string, then returned value will always be false. - * Serialized data is always a string. - * - * @param string $data Value to check to see if was serialized. - * @param bool $strict Optional. Whether to be strict about the end of the string. Default true. - * @return bool False if not serialized and true if it was. - */ - protected function is_serialized( $data, $strict = true ) { - // if it isn't a string, it isn't serialized. - if ( ! is_string( $data ) ) { - return false; - } + if ( defined( 'WP_REDIS_IGBINARY' ) && WP_REDIS_IGBINARY && function_exists( 'igbinary_serialize' ) ) { + return igbinary_serialize( $data ); + } - $data = trim( $data ); + if ( is_array( $data ) || is_object( $data ) ) { + // phpcs:ignore WordPress.PHP.DiscouragedPHPFunctions.serialize_serialize + return serialize( $data ); + } - if ( 'N;' === $data ) { - return true; - } + if ( $this->is_serialized( $data, false ) ) { + // phpcs:ignore WordPress.PHP.DiscouragedPHPFunctions.serialize_serialize + return serialize( $data ); + } + + return $data; + } + + /** + * Check value to find if it was serialized. + * + * If $data is not an string, then returned value will always be false. + * Serialized data is always a string. + * + * @param string $data Value to check to see if was serialized. + * @param bool $strict Optional. Whether to be strict about the end of the string. Default true. + * @return bool False if not serialized and true if it was. + */ + protected function is_serialized( $data, $strict = true ) { + // if it isn't a string, it isn't serialized. + if ( ! is_string( $data ) ) { + return false; + } + + $data = trim( $data ); + + if ( 'N;' === $data ) { + return true; + } - if ( strlen( $data ) < 4 ) { + if ( strlen( $data ) < 4 ) { + return false; + } + + if ( ':' !== $data[1] ) { + return false; + } + + if ( $strict ) { + $lastc = substr( $data, -1 ); + + if ( ';' !== $lastc && '}' !== $lastc ) { return false; } + } else { + $semicolon = strpos( $data, ';' ); + $brace = strpos( $data, '}' ); - if ( ':' !== $data[1] ) { + // Either ; or } must exist. + if ( false === $semicolon && false === $brace ) { return false; } - if ( $strict ) { - $lastc = substr( $data, -1 ); - - if ( ';' !== $lastc && '}' !== $lastc ) { - return false; - } - } else { - $semicolon = strpos( $data, ';' ); - $brace = strpos( $data, '}' ); - - // Either ; or } must exist. - if ( false === $semicolon && false === $brace ) { - return false; - } - - // But neither must be in the first X characters. - if ( false !== $semicolon && $semicolon < 3 ) { - return false; - } + // But neither must be in the first X characters. + if ( false !== $semicolon && $semicolon < 3 ) { + return false; + } - if ( false !== $brace && $brace < 4 ) { - return false; - } + if ( false !== $brace && $brace < 4 ) { + return false; } - $token = $data[0]; + } + $token = $data[0]; - switch ( $token ) { - case 's': - if ( $strict ) { - if ( '"' !== substr( $data, -2, 1 ) ) { - return false; - } - } elseif ( false === strpos( $data, '"' ) ) { + switch ( $token ) { + case 's': + if ( $strict ) { + if ( '"' !== substr( $data, -2, 1 ) ) { return false; } - // Or else fall through. - // No break! - case 'a': - case 'O': - return (bool) preg_match( "/^{$token}:[0-9]+:/s", $data ); - case 'b': - case 'i': - case 'd': - $end = $strict ? '$' : ''; - - return (bool) preg_match( "/^{$token}:[0-9.E-]+;$end/", $data ); - } - - return false; + } elseif ( false === strpos( $data, '"' ) ) { + return false; + } + // Or else fall through. + // No break! + case 'a': + case 'O': + return (bool) preg_match( "/^{$token}:[0-9]+:/s", $data ); + case 'b': + case 'i': + case 'd': + $end = $strict ? '$' : ''; + + return (bool) preg_match( "/^{$token}:[0-9.E-]+;$end/", $data ); } - /** - * Handle the redis failure gracefully or throw an exception. - * - * @param \Exception $exception Exception thrown. - * @throws \Exception If `fail_gracefully` flag is set to a falsy value. - * @return void - */ - protected function handle_exception( $exception ) { - $this->redis_connected = false; + return false; + } - // When Redis is unavailable, fall back to the internal cache by forcing all groups to be "no redis" groups. - $this->ignored_groups = array_unique( array_merge( $this->ignored_groups, $this->global_groups ) ); + /** + * Handle the redis failure gracefully or throw an exception. + * + * @param \Exception $exception Exception thrown. + * @throws \Exception If `fail_gracefully` flag is set to a falsy value. + * @return void + */ + protected function handle_exception( $exception ) { + $this->redis_connected = false; - if ( ! $this->fail_gracefully ) { - throw $exception; - } + // When Redis is unavailable, fall back to the internal cache by forcing all groups to be "no redis" groups. + $this->ignored_groups = array_unique( array_merge( $this->ignored_groups, $this->global_groups ) ); - $this->errors[] = $exception->getMessage(); + if ( ! $this->fail_gracefully ) { + throw $exception; + } - error_log( $exception ); // phpcs:ignore WordPress.PHP.DevelopmentFunctions.error_log_error_log + $this->errors[] = $exception->getMessage(); - if ( function_exists( 'do_action' ) ) { - do_action( 'redis_object_cache_error', $exception ); - } - } + error_log( $exception ); // phpcs:ignore WordPress.PHP.DevelopmentFunctions.error_log_error_log - /** - * Allows access to private properties for backwards compatibility. - * - * @param string $name Name of the property. - * @return mixed - */ - public function __get( $name ) { - return isset( $this->{$name} ) ? $this->{$name} : null; + if ( function_exists( 'do_action' ) ) { + do_action( 'redis_object_cache_error', $exception ); } } + /** + * Allows access to private properties for backwards compatibility. + * + * @param string $name Name of the property. + * @return mixed + */ + public function __get( $name ) { + return isset( $this->{$name} ) ? $this->{$name} : null; + } +} + endif; +// phpcs:enable Generic.WhiteSpace.ScopeIndent.IncorrectExact, Generic.WhiteSpace.ScopeIndent.Incorrect From 028232cf56b5f3edbb9a114ac80683148d13ca14 Mon Sep 17 00:00:00 2001 From: naxvog Date: Sat, 15 Aug 2020 15:44:46 +0200 Subject: [PATCH 45/93] phpcbf auto fixes --- includes/class-plugin.php | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/includes/class-plugin.php b/includes/class-plugin.php index 801503b0..4ce2e3bb 100644 --- a/includes/class-plugin.php +++ b/includes/class-plugin.php @@ -279,8 +279,8 @@ public function enqueue_redis_metrics() { ); wp_localize_script( 'redis-cache', 'rediscache_metrics', $metrics ); - } catch (Exception $exception) { - error_log($exception); + } catch ( Exception $exception ) { + error_log( $exception ); } } @@ -518,12 +518,14 @@ public function do_admin_actions() { $result ? add_settings_error( 'redis-cache', - 'dropin', __( 'Object cache disabled.', 'redis-cache' ), + 'dropin', + __( 'Object cache disabled.', 'redis-cache' ), 'updated' ) : add_settings_error( 'redis-cache', - 'dropin', __( 'Object cache could not be disabled.', 'redis-cache' ), + 'dropin', + __( 'Object cache could not be disabled.', 'redis-cache' ), 'error' ); } @@ -552,7 +554,6 @@ public function do_admin_actions() { 'error' ); } - } $messages = get_settings_errors( 'redis-cache' ); @@ -683,8 +684,8 @@ public function record_metrics() { time(), http_build_query( $metrics, null, ';' ) ); - } catch (Exception $exception) { - error_log($exception); + } catch ( Exception $exception ) { + error_log( $exception ); } } @@ -709,8 +710,8 @@ public function discard_metrics() { 0, time() - HOUR_IN_SECONDS ); - } catch (Exception $exception) { - error_log($exception); + } catch ( Exception $exception ) { + error_log( $exception ); } } @@ -791,9 +792,8 @@ public function initialize_filesystem( $url, $silent = false ) { return true; } - public function test_filesystem_writing() - { - global $wp_filesystem; + public function test_filesystem_writing() { + global $wp_filesystem; if ( ! $this->initialize_filesystem( '', true ) ) { return new WP_Error( 'fs', __( 'Could not initialize filesystem.', 'redis-cache' ) ); From f40baa908a2292a6be4782d2093e70d431378d32 Mon Sep 17 00:00:00 2001 From: naxvog Date: Sat, 15 Aug 2020 15:45:54 +0200 Subject: [PATCH 46/93] added property and method comments --- includes/class-plugin.php | 234 +++++++++++++++++++++++++++++++++++--- 1 file changed, 218 insertions(+), 16 deletions(-) diff --git a/includes/class-plugin.php b/includes/class-plugin.php index 4ce2e3bb..073b1dfc 100644 --- a/includes/class-plugin.php +++ b/includes/class-plugin.php @@ -12,12 +12,30 @@ defined( '\\ABSPATH' ) || exit; +/** + * Main plugin class definition + */ class Plugin { - private $page; + /** + * Settings page uri + * + * @var string $page + */ + private $page = ''; + /** + * Settings page slug + * + * @var string $screen + */ private $screen = ''; + /** + * Allowed setting page actions + * + * @var string[] $actions + */ private $actions = array( 'enable-cache', 'disable-cache', @@ -26,14 +44,14 @@ class Plugin { ); /** - * Plugin instance property. + * Plugin instance property * * @var Plugin */ private static $instance; /** - * Plugin instanciation method. + * Plugin instanciation method * * @return Plugin */ @@ -45,6 +63,9 @@ public static function instance() { return self::$instance; } + /** + * Constructor + */ private function __construct() { require_once ABSPATH . 'wp-admin/includes/plugin.php'; @@ -66,6 +87,11 @@ private function __construct() { } } + /** + * Adds all necessary hooks + * + * @return void + */ public function add_actions_and_filters() { add_action( 'deactivate_plugin', array( $this, 'on_deactivation' ) ); add_action( 'admin_init', array( $this, 'maybe_update_dropin' ) ); @@ -97,8 +123,12 @@ public function add_actions_and_filters() { add_filter( 'qm/outputter/html', array( $this, 'register_qm_output' ) ); } + /** + * Adds a submenu page to "Settings" + * + * @return void + */ public function add_admin_menu_page() { - // add sub-page to "Settings" add_submenu_page( is_multisite() ? 'settings.php' : 'options-general.php', __( 'Redis Object Cache', 'redis-cache' ), @@ -109,18 +139,23 @@ public function add_admin_menu_page() { ); } + /** + * Displays the settings page + * + * @return void + */ public function show_admin_page() { - // request filesystem credentials? + // Request filesystem credentials? if ( isset( $_GET['_wpnonce'], $_GET['action'] ) ) { $action = $_GET['action']; foreach ( $this->actions as $name ) { - // verify nonce + // Nonce verification. if ( $action === $name && wp_verify_nonce( $_GET['_wpnonce'], $action ) ) { $url = $this->action_link( $action ); if ( $this->initialize_filesystem( $url ) === false ) { - return; // request filesystem credentials + return; // Request filesystem credentials. } } } @@ -147,10 +182,15 @@ public function show_admin_page() { __( 'Diagnostics', 'redis-cache' ) ); - // show admin page + // Show the admin page. require_once WP_REDIS_PLUGIN_PATH . '/includes/ui/settings.php'; } + /** + * Adds the dashboard metrics widget + * + * @return void + */ public function setup_dashboard_widget() { if ( defined( 'WP_REDIS_DISABLE_METRICS' ) && WP_REDIS_DISABLE_METRICS ) { return; @@ -163,18 +203,33 @@ public function setup_dashboard_widget() { ); } + /** + * Displays the dashboard widget + * + * @return void + */ public function show_dashboard_widget() { require_once WP_REDIS_PLUGIN_PATH . '/includes/ui/widget.php'; } + /** + * Adds the settings page to the plugin action links on the plugin page + * + * @param string[] $links The current plugin action links. + * @return string[] + */ public function add_plugin_actions_links( $links ) { - // add settings link to plugin actions return array_merge( [ sprintf( '%s', network_admin_url( $this->page ), esc_html__( 'Settings', 'redis-cache' ) ) ], $links ); } + /** + * Enqueues admin style resources + * + * @return void + */ public function enqueue_admin_styles() { $screen = get_current_screen(); @@ -195,6 +250,11 @@ public function enqueue_admin_styles() { wp_enqueue_style( 'redis-cache', WP_REDIS_DIR . '/assets/css/admin.css', null, WP_REDIS_VERSION ); } + /** + * Enqueues admin script resources + * + * @return void + */ public function enqueue_admin_scripts() { $screen = get_current_screen(); @@ -242,6 +302,11 @@ public function enqueue_admin_scripts() { ); } + /** + * Enqueues scripts to display recorded metrics + * + * @return void + */ public function enqueue_redis_metrics() { global $wp_object_cache; @@ -284,12 +349,24 @@ public function enqueue_redis_metrics() { } } + /** + * Registers a new cache collector for the Query Monitor plugin + * + * @param array $collectors Array of currently registered collectors. + * @return array + */ public function register_qm_collector( array $collectors ) { $collectors['cache'] = new QM_Collector(); return $collectors; } + /** + * Registers a new cache output using our collector for the Query Monitor plugin + * + * @param array $output Array of current QM_Output handlers. + * @return array + */ public function register_qm_output( $output ) { $collector = \QM_Collectors::get( 'cache' ); @@ -303,10 +380,20 @@ public function register_qm_output( $output ) { return $output; } + /** + * Checks if the `object-cache.php` drop-in exists + * + * @return bool + */ public function object_cache_dropin_exists() { return file_exists( WP_CONTENT_DIR . '/object-cache.php' ); } + /** + * Validates the `object-cache.php` drop-in + * + * @return bool + */ public function validate_object_cache_dropin() { if ( ! $this->object_cache_dropin_exists() ) { return false; @@ -318,6 +405,11 @@ public function validate_object_cache_dropin() { return $dropin['PluginURI'] === $plugin['PluginURI']; } + /** + * Checks if the `object-cache.php` drop-in is outdated + * + * @return bool + */ public function object_cache_dropin_outdated() { if ( ! $this->object_cache_dropin_exists() ) { return false; @@ -333,6 +425,11 @@ public function object_cache_dropin_outdated() { return false; } + /** + * Retrieves the current human-readable status + * + * @return string + */ public function get_status() { global $wp_object_cache; @@ -380,6 +477,12 @@ public function get_redis_status() { return $wp_object_cache->redis_status(); } + /** + * Returns the redis version if possible + * + * @see WP_Object_Cache::redis_version() + * @return null|string + */ public function get_redis_version() { global $wp_object_cache; @@ -392,6 +495,11 @@ public function get_redis_version() { } } + /** + * Returns the currently used redis client (if any) + * + * @return null|string + */ public function get_redis_client_name() { global $wp_object_cache; @@ -404,6 +512,11 @@ public function get_redis_client_name() { } } + /** + * Fetches the redis diagnostics data + * + * @return null|array + */ public function get_diagnostics() { global $wp_object_cache; @@ -412,21 +525,36 @@ public function get_diagnostics() { } } + /** + * Retrieves the redis prefix + * + * @return null|mixed + */ public function get_redis_prefix() { return defined( 'WP_REDIS_PREFIX' ) ? WP_REDIS_PREFIX : null; } + /** + * Retrieves the redis maximum time to live + * + * @return null|mixed + */ public function get_redis_maxttl() { return defined( 'WP_REDIS_MAXTTL' ) ? WP_REDIS_MAXTTL : null; } + /** + * Displays admin notices + * + * @return void + */ public function show_admin_notices() { if ( ! defined( 'WP_REDIS_DISABLE_BANNERS' ) || ! WP_REDIS_DISABLE_BANNERS ) { $this->pro_notice(); $this->wc_pro_notice(); } - // only show admin notices to users with the right capability + // Only show admin notices to users with the right capability. if ( ! current_user_can( is_multisite() ? 'manage_network_options' : 'manage_options' ) ) { return; } @@ -436,11 +564,11 @@ public function show_admin_notices() { if ( $this->validate_object_cache_dropin() ) { if ( $this->object_cache_dropin_outdated() ) { - // translators: %s = Action link to update the drop-in + // translators: %s = Action link to update the drop-in. $message = sprintf( __( 'The Redis object cache drop-in is outdated. Please update the drop-in.', 'redis-cache' ), $url ); } } else { - // translators: %s = Action link to update the drop-in + // translators: %s = Action link to update the drop-in. $message = sprintf( __( 'A foreign object cache drop-in was found. To use Redis for object caching, please enable the drop-in.', 'redis-cache' ), $url ); } @@ -450,13 +578,18 @@ public function show_admin_notices() { } } + /** + * Executes admin actions + * + * @return void + */ public function do_admin_actions() { global $wp_filesystem; if ( isset( $_GET['_wpnonce'], $_GET['action'] ) ) { $action = $_GET['action']; - // verify nonce + // Nonce verification. foreach ( $this->actions as $name ) { if ( $action === $name && ! wp_verify_nonce( $_GET['_wpnonce'], $action ) ) { return; @@ -570,6 +703,11 @@ public function do_admin_actions() { } } + /** + * Dismisses the admin notice for the current user + * + * @return void + */ public function dismiss_notice() { $notice = sprintf( 'roc_dismissed_%s', @@ -581,6 +719,11 @@ public function dismiss_notice() { wp_die(); } + /** + * Displays a redis cache pro admin notice + * + * @return void + */ public function pro_notice() { $screen = get_current_screen(); @@ -604,13 +747,18 @@ public function pro_notice() { '

%s %s

', __( 'Object Cache Pro is out!', 'redis-cache' ), sprintf( - // translators: %s = Link to the plugin setting screen + // translators: %s = Link to the plugin setting screen. __( 'A business class object cache backend. Truly reliable, highly-optimized and fully customizable, with a dedicated engineer when you most need it. Learn more »', 'redis-cache' ), network_admin_url( $this->page ) ) ); } + /** + * Displays a redis cache pro admin notice specifically for WooCommerce + * + * @return void + */ public function wc_pro_notice() { if ( ! class_exists( 'WooCommerce' ) ) { return; @@ -638,19 +786,29 @@ public function wc_pro_notice() { '

%s

%s

', __( 'Object Cache Pro + WooCommerce = ❤️', 'redis-cache' ), sprintf( - // translators: %s = Link to the plugin's settings screen + // translators: %s = Link to the plugin's settings screen. __( 'Object Cache Pro is a business class object cache that’s highly-optimized for WooCommerce to provide true reliability, peace of mind and faster load times for your store. Learn more »', 'redis-cache' ), network_admin_url( $this->page ) ) ); } + /** + * Registers all hooks associated with the shutdown hook + * + * @return void + */ public function register_shutdown_hooks() { if ( ! defined( 'WP_REDIS_DISABLE_COMMENT' ) || ! WP_REDIS_DISABLE_COMMENT ) { add_action( 'shutdown', array( $this, 'maybe_print_comment' ), 0 ); } } + /** + * Adds the recorded metrics to redis + * + * @return void + */ public function record_metrics() { global $wp_object_cache; @@ -689,6 +847,11 @@ public function record_metrics() { } } + /** + * Removes recorded metrics after an hour + * + * @return void + */ public function discard_metrics() { global $wp_object_cache; @@ -715,6 +878,11 @@ public function discard_metrics() { } } + /** + * Displays the redis cache html comment + * + * @return void + */ public function maybe_print_comment() { global $wp_object_cache; @@ -766,6 +934,13 @@ function_exists( 'size_format' ) ? size_format( $bytes ) : "{$bytes} bytes", printf( "\n", $message, $debug ); } + /** + * Initializes the WP filesystem API to be ready for use + * + * @param string $url The URL to post the form to. + * @param bool $silent Wheather to ask the user for credentials if necessary or not. + * @return bool + */ public function initialize_filesystem( $url, $silent = false ) { if ( $silent ) { ob_start(); @@ -792,8 +967,13 @@ public function initialize_filesystem( $url, $silent = false ) { return true; } + /** + * Test if we can write in the WP_CONTENT_DIR and modify the `object-cache.php` drop-in + * + * @return true|WP_Error + */ public function test_filesystem_writing() { - global $wp_filesystem; + global $wp_filesystem; if ( ! $this->initialize_filesystem( '', true ) ) { return new WP_Error( 'fs', __( 'Could not initialize filesystem.', 'redis-cache' ) ); @@ -833,6 +1013,11 @@ public function test_filesystem_writing() { return true; } + /** + * Calls the drop-in update method if necessary + * + * @return void + */ public function maybe_update_dropin() { if ( defined( 'WP_REDIS_DISABLE_DROPIN_AUTOUPDATE' ) && WP_REDIS_DISABLE_DROPIN_AUTOUPDATE ) { return; @@ -843,6 +1028,11 @@ public function maybe_update_dropin() { } } + /** + * Updates the `object-cache.php` drop-in + * + * @return void + */ public function update_dropin() { global $wp_filesystem; @@ -862,6 +1052,12 @@ public function update_dropin() { } } + /** + * Plugin deactivation hook + * + * @param string $plugin Plugin basename. + * @return void + */ public function on_deactivation( $plugin ) { global $wp_filesystem; @@ -882,6 +1078,12 @@ public function on_deactivation( $plugin ) { ob_end_clean(); } + /** + * Helper method to retrieve a nonced plugin action link + * + * @param string $action The action to be executed once the link is followed + * @return string + */ public function action_link( $action ) { return wp_nonce_url( network_admin_url( add_query_arg( 'action', $action, $this->page ) ), From 044fcb62dfad2fb660f643c360d3fadbcfea15d9 Mon Sep 17 00:00:00 2001 From: naxvog Date: Sat, 15 Aug 2020 16:24:10 +0200 Subject: [PATCH 47/93] ignore phpcs error_log function sniff --- includes/class-plugin.php | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/includes/class-plugin.php b/includes/class-plugin.php index 073b1dfc..a361ba7a 100644 --- a/includes/class-plugin.php +++ b/includes/class-plugin.php @@ -345,7 +345,7 @@ public function enqueue_redis_metrics() { wp_localize_script( 'redis-cache', 'rediscache_metrics', $metrics ); } catch ( Exception $exception ) { - error_log( $exception ); + error_log( $exception ); // phpcs:ignore WordPress.PHP.DevelopmentFunctions.error_log_error_log } } @@ -843,7 +843,7 @@ public function record_metrics() { http_build_query( $metrics, null, ';' ) ); } catch ( Exception $exception ) { - error_log( $exception ); + error_log( $exception ); // phpcs:ignore WordPress.PHP.DevelopmentFunctions.error_log_error_log } } @@ -874,7 +874,7 @@ public function discard_metrics() { time() - HOUR_IN_SECONDS ); } catch ( Exception $exception ) { - error_log( $exception ); + error_log( $exception ); // phpcs:ignore WordPress.PHP.DevelopmentFunctions.error_log_error_log } } From 8f9c408aa6201c7778a40e422bfe4846b1becde8 Mon Sep 17 00:00:00 2001 From: naxvog Date: Sat, 15 Aug 2020 15:57:44 +0200 Subject: [PATCH 48/93] Added html comment output escaping --- includes/class-plugin.php | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/includes/class-plugin.php b/includes/class-plugin.php index a361ba7a..4a5df96a 100644 --- a/includes/class-plugin.php +++ b/includes/class-plugin.php @@ -916,7 +916,7 @@ public function maybe_print_comment() { ); if ( ! WP_DEBUG ) { - printf( "\n\n", $message ); + printf( "\n\n", esc_html( $message ) ); return; } @@ -931,7 +931,7 @@ function_exists( 'size_format' ) ? size_format( $bytes ) : "{$bytes} bytes", $wp_object_cache->diagnostics['client'] ); - printf( "\n", $message, $debug ); + printf( "\n", esc_html( $message ), esc_html( $debug ) ); } /** From 712cac820f327abc34b49e253be892dbcf673ad3 Mon Sep 17 00:00:00 2001 From: naxvog Date: Sat, 15 Aug 2020 16:09:58 +0200 Subject: [PATCH 49/93] yoda style conditions --- includes/class-plugin.php | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/includes/class-plugin.php b/includes/class-plugin.php index 4a5df96a..ca3850cd 100644 --- a/includes/class-plugin.php +++ b/includes/class-plugin.php @@ -599,7 +599,7 @@ public function do_admin_actions() { if ( in_array( $action, $this->actions ) ) { $url = $this->action_link( $action ); - if ( $action === 'flush-cache' ) { + if ( 'flush-cache' === $action ) { wp_cache_flush() ? add_settings_error( 'redis-cache', @@ -618,7 +618,7 @@ public function do_admin_actions() { // do we have filesystem credentials? if ( $this->initialize_filesystem( $url, true ) ) { - if ( $action === 'enable-cache' ) { + if ( 'enable-cache' === $action ) { $result = $wp_filesystem->copy( WP_REDIS_PLUGIN_PATH . '/includes/object-cache.php', WP_CONTENT_DIR . '/object-cache.php', @@ -643,7 +643,7 @@ public function do_admin_actions() { ); } - if ( $action === 'disable-cache' ) { + if ( 'disable-cache' === $action ) { $result = $wp_filesystem->delete( WP_CONTENT_DIR . '/object-cache.php' ); do_action( 'redis_object_cache_disable', $result ); @@ -663,7 +663,7 @@ public function do_admin_actions() { ); } - if ( $action === 'update-dropin' ) { + if ( 'update-dropin' === $action ) { $result = $wp_filesystem->copy( WP_REDIS_PLUGIN_PATH . '/includes/object-cache.php', WP_CONTENT_DIR . '/object-cache.php', @@ -1002,7 +1002,7 @@ public function test_filesystem_writing() { $meta = get_file_data( $testfile, [ 'Version' => 'Version' ] ); - if ( $meta['Version'] !== WP_REDIS_VERSION ) { + if ( WP_REDIS_VERSION !== $meta['Version'] ) { return new WP_Error( 'version', __( 'Couldn’t verify test file contents.', 'redis-cache' ) ); } @@ -1063,7 +1063,7 @@ public function on_deactivation( $plugin ) { ob_start(); - if ( $plugin === WP_REDIS_BASENAME ) { + if ( WP_REDIS_BASENAME === $plugin ) { if ( $timestamp = wp_next_scheduled( 'rediscache_discard_metrics' ) ) { wp_unschedule_event( $timestamp, 'rediscache_discard_metrics' ); } From b545a83a9ed74ea5c983798f0eb48e94a0b01513 Mon Sep 17 00:00:00 2001 From: naxvog Date: Sat, 15 Aug 2020 17:47:35 +0200 Subject: [PATCH 50/93] Added additional output escaping for admin notices --- includes/class-plugin.php | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/includes/class-plugin.php b/includes/class-plugin.php index ca3850cd..8390ff41 100644 --- a/includes/class-plugin.php +++ b/includes/class-plugin.php @@ -573,7 +573,7 @@ public function show_admin_notices() { } if ( isset( $message ) ) { - printf( '
%s
', $message ); + printf( '
%s
', wp_kses_post( $message ) ); } } } @@ -745,11 +745,11 @@ public function pro_notice() { printf( '

%s %s

', - __( 'Object Cache Pro is out!', 'redis-cache' ), + esc_html__( 'Object Cache Pro is out!', 'redis-cache' ), sprintf( // translators: %s = Link to the plugin setting screen. - __( 'A business class object cache backend. Truly reliable, highly-optimized and fully customizable, with a dedicated engineer when you most need it. Learn more »', 'redis-cache' ), - network_admin_url( $this->page ) + wp_kses_post( __( 'A business class object cache backend. Truly reliable, highly-optimized and fully customizable, with a dedicated engineer when you most need it. Learn more »', 'redis-cache' ) ), + esc_url( network_admin_url( $this->page ) ) ) ); } @@ -784,11 +784,11 @@ public function wc_pro_notice() { printf( '

%s

%s

', - __( 'Object Cache Pro + WooCommerce = ❤️', 'redis-cache' ), + esc_html__( 'Object Cache Pro + WooCommerce = ❤️', 'redis-cache' ), sprintf( // translators: %s = Link to the plugin's settings screen. - __( 'Object Cache Pro is a business class object cache that’s highly-optimized for WooCommerce to provide true reliability, peace of mind and faster load times for your store. Learn more »', 'redis-cache' ), - network_admin_url( $this->page ) + wp_kses_post( __( 'Object Cache Pro is a business class object cache that’s highly-optimized for WooCommerce to provide true reliability, peace of mind and faster load times for your store. Learn more »', 'redis-cache' ) ), + esc_url( network_admin_url( $this->page ) ) ) ); } From 5abb75252f2f29cb23bdc77e9b3e065c91f0b871 Mon Sep 17 00:00:00 2001 From: naxvog Date: Sat, 15 Aug 2020 17:50:15 +0200 Subject: [PATCH 51/93] strict comparisson for in_array --- includes/class-plugin.php | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/includes/class-plugin.php b/includes/class-plugin.php index 8390ff41..d7446932 100644 --- a/includes/class-plugin.php +++ b/includes/class-plugin.php @@ -243,7 +243,7 @@ public function enqueue_admin_styles() { 'dashboard-network', ); - if ( ! in_array( $screen->id, $screens ) ) { + if ( ! in_array( $screen->id, $screens, true ) ) { return; } @@ -271,7 +271,7 @@ public function enqueue_admin_scripts() { 'woocommerce_page_wc-admin', ); - if ( ! in_array( $screen->id, $screens ) ) { + if ( ! in_array( $screen->id, $screens, true ) ) { return; } @@ -320,7 +320,7 @@ public function enqueue_redis_metrics() { return; } - if ( ! in_array( $screen->id, array( $this->screen, 'dashboard', 'dashboard-network' ) ) ) { + if ( ! in_array( $screen->id, array( $this->screen, 'dashboard', 'dashboard-network' ), true ) ) { return; } @@ -596,7 +596,7 @@ public function do_admin_actions() { } } - if ( in_array( $action, $this->actions ) ) { + if ( in_array( $action, $this->actions, true ) ) { $url = $this->action_link( $action ); if ( 'flush-cache' === $action ) { @@ -731,7 +731,7 @@ public function pro_notice() { return; } - if ( ! in_array( $screen->id, array( 'dashboard', 'dashboard-network' ) ) ) { + if ( ! in_array( $screen->id, array( 'dashboard', 'dashboard-network' ), true ) ) { return; } @@ -770,7 +770,7 @@ public function wc_pro_notice() { return; } - if ( ! in_array( $screen->id, array( 'edit-shop_order', 'edit-product', 'woocommerce_page_wc-admin' ) ) ) { + if ( ! in_array( $screen->id, array( 'edit-shop_order', 'edit-product', 'woocommerce_page_wc-admin' ), true ) ) { return; } From 319f2b0fe13fcca5675b66d3359e4b9076026bf9 Mon Sep 17 00:00:00 2001 From: naxvog Date: Sat, 15 Aug 2020 18:09:25 +0200 Subject: [PATCH 52/93] avoided assignments in comparisons --- includes/class-plugin.php | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/includes/class-plugin.php b/includes/class-plugin.php index d7446932..975ecdca 100644 --- a/includes/class-plugin.php +++ b/includes/class-plugin.php @@ -946,7 +946,8 @@ public function initialize_filesystem( $url, $silent = false ) { ob_start(); } - if ( ( $credentials = request_filesystem_credentials( $url ) ) === false ) { + $credentials = request_filesystem_credentials( $url ); + if ( false === $credentials ) { if ( $silent ) { ob_end_clean(); } @@ -1064,7 +1065,8 @@ public function on_deactivation( $plugin ) { ob_start(); if ( WP_REDIS_BASENAME === $plugin ) { - if ( $timestamp = wp_next_scheduled( 'rediscache_discard_metrics' ) ) { + $timestamp = wp_next_scheduled( 'rediscache_discard_metrics' ); + if ( $timestamp ) { wp_unschedule_event( $timestamp, 'rediscache_discard_metrics' ); } From c85d4f9468883b438223243fe235b592162fae89 Mon Sep 17 00:00:00 2001 From: naxvog Date: Sat, 15 Aug 2020 18:11:22 +0200 Subject: [PATCH 53/93] changed script loading position to footer --- includes/class-plugin.php | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/includes/class-plugin.php b/includes/class-plugin.php index 975ecdca..bfe23f71 100644 --- a/includes/class-plugin.php +++ b/includes/class-plugin.php @@ -279,7 +279,8 @@ public function enqueue_admin_scripts() { 'redis-cache', plugins_url( 'assets/js/admin.js', WP_REDIS_FILE ), array( 'jquery', 'underscore' ), - WP_REDIS_VERSION + WP_REDIS_VERSION, + true ); wp_localize_script( @@ -328,7 +329,8 @@ public function enqueue_redis_metrics() { 'redis-cache-charts', plugins_url( 'assets/js/apexcharts.min.js', WP_REDIS_FILE ), null, - WP_REDIS_VERSION + WP_REDIS_VERSION, + true ); if ( ! method_exists( $wp_object_cache, 'redis_instance' ) ) { From 94f2c35684ce0425e192eca21524ea5e84b92894 Mon Sep 17 00:00:00 2001 From: naxvog Date: Sat, 15 Aug 2020 18:42:24 +0200 Subject: [PATCH 54/93] added additional sanitization and nonces --- assets/js/admin.js | 4 +++- includes/class-plugin.php | 34 ++++++++++++++++++++++------------ 2 files changed, 25 insertions(+), 13 deletions(-) diff --git a/assets/js/admin.js b/assets/js/admin.js index f7a7816b..760a36f6 100644 --- a/assets/js/admin.js +++ b/assets/js/admin.js @@ -449,9 +449,11 @@ function ( event ) { event.preventDefault(); + var $parent = $( this ).parent(); $.post( ajaxurl, { - notice: $( this ).parent().attr( 'data-dismissible' ), + notice: $parent.data( 'dismissible' ), action: 'roc_dismiss_notice', + _ajax_nonce: $parent.data( 'nonce' ), } ); } ); diff --git a/includes/class-plugin.php b/includes/class-plugin.php index bfe23f71..d633a784 100644 --- a/includes/class-plugin.php +++ b/includes/class-plugin.php @@ -147,11 +147,12 @@ public function add_admin_menu_page() { public function show_admin_page() { // Request filesystem credentials? if ( isset( $_GET['_wpnonce'], $_GET['action'] ) ) { - $action = $_GET['action']; + $action = sanitize_key( $_GET['action'] ); + $nonce = sanitize_key( $_GET['_wpnonce'] ); foreach ( $this->actions as $name ) { // Nonce verification. - if ( $action === $name && wp_verify_nonce( $_GET['_wpnonce'], $action ) ) { + if ( $action === $name && wp_verify_nonce( $nonce, $action ) ) { $url = $this->action_link( $action ); if ( $this->initialize_filesystem( $url ) === false ) { @@ -589,11 +590,12 @@ public function do_admin_actions() { global $wp_filesystem; if ( isset( $_GET['_wpnonce'], $_GET['action'] ) ) { - $action = $_GET['action']; + $action = sanitize_key( $_GET['action'] ); + $nonce = sanitize_key( $_GET['_wpnonce'] ); // Nonce verification. foreach ( $this->actions as $name ) { - if ( $action === $name && ! wp_verify_nonce( $_GET['_wpnonce'], $action ) ) { + if ( $action === $name && ! wp_verify_nonce( $nonce, $action ) ) { return; } } @@ -711,12 +713,15 @@ public function do_admin_actions() { * @return void */ public function dismiss_notice() { - $notice = sprintf( - 'roc_dismissed_%s', - sanitize_key( $_POST['notice'] ) - ); + if ( isset( $_POST['notice'] ) ) { + check_ajax_referer( 'roc_dismiss_notice' ); + $notice = sprintf( + 'roc_dismissed_%s', + sanitize_key( $_POST['notice'] ) + ); - update_user_meta( get_current_user_id(), $notice, '1' ); + update_user_meta( get_current_user_id(), $notice, '1' ); + } wp_die(); } @@ -746,7 +751,8 @@ public function pro_notice() { } printf( - '

%s %s

', + '

%s %s

', + esc_attr( wp_create_nonce( 'roc_dismiss_notice' ) ), esc_html__( 'Object Cache Pro is out!', 'redis-cache' ), sprintf( // translators: %s = Link to the plugin setting screen. @@ -785,7 +791,8 @@ public function wc_pro_notice() { } printf( - '

%s

%s

', + '

%s

%s

', + esc_attr( wp_create_nonce( 'roc_dismiss_notice' ) ), esc_html__( 'Object Cache Pro + WooCommerce = ❤️', 'redis-cache' ), sprintf( // translators: %s = Link to the plugin's settings screen. @@ -1085,10 +1092,13 @@ public function on_deactivation( $plugin ) { /** * Helper method to retrieve a nonced plugin action link * - * @param string $action The action to be executed once the link is followed + * @param string $action The action to be executed once the link is followed. * @return string */ public function action_link( $action ) { + if ( ! in_array( $action, $this->actions, true ) ) { + return ''; + } return wp_nonce_url( network_admin_url( add_query_arg( 'action', $action, $this->page ) ), $action From d32973ea7eea2eb47c6ed3b9a1f8c4f9f2d3e1e3 Mon Sep 17 00:00:00 2001 From: naxvog Date: Sat, 15 Aug 2020 18:38:17 +0200 Subject: [PATCH 55/93] switched to strict comparison --- includes/class-plugin.php | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/includes/class-plugin.php b/includes/class-plugin.php index d633a784..cdb6abda 100644 --- a/includes/class-plugin.php +++ b/includes/class-plugin.php @@ -746,7 +746,7 @@ public function pro_notice() { return; } - if ( get_user_meta( get_current_user_id(), 'roc_dismissed_pro_release_notice', true ) == '1' ) { + if ( 1 === intval( get_user_meta( get_current_user_id(), 'roc_dismissed_pro_release_notice', true ) ) ) { return; } @@ -786,7 +786,7 @@ public function wc_pro_notice() { return; } - if ( get_user_meta( get_current_user_id(), 'roc_dismissed_wc_pro_notice', true ) == '1' ) { + if ( 1 === intval( get_user_meta( get_current_user_id(), 'roc_dismissed_wc_pro_notice', true ) ) ) { return; } From 1af9dcf4633bebdbabbb22a7f4f3ee40cc6629c9 Mon Sep 17 00:00:00 2001 From: naxvog Date: Sat, 15 Aug 2020 18:39:07 +0200 Subject: [PATCH 56/93] ignored warning & added todo for `serialize` function --- includes/class-plugin.php | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/includes/class-plugin.php b/includes/class-plugin.php index cdb6abda..7a986715 100644 --- a/includes/class-plugin.php +++ b/includes/class-plugin.php @@ -930,7 +930,8 @@ public function maybe_print_comment() { return; } - $bytes = strlen( serialize( $wp_object_cache->cache ) ); + // TODO: find a better method to determine cache size as using `serialize` is discouraged. + $bytes = strlen( serialize( $wp_object_cache->cache ) ); // phpcs:ignore WordPress.PHP.DiscouragedPHPFunctions.serialize_serialize $debug = sprintf( // translators: %1$d = number of objects. %2$s = human-readable size of cache. %3$s = name of the used client. From fbd962bdf30b5332cbd5af49fd886043e36bb2ed Mon Sep 17 00:00:00 2001 From: naxvog Date: Sat, 15 Aug 2020 18:54:22 +0200 Subject: [PATCH 57/93] one function argument per line --- includes/class-ui.php | 17 ++++++++++------- 1 file changed, 10 insertions(+), 7 deletions(-) diff --git a/includes/class-ui.php b/includes/class-ui.php index 4d338807..79a50287 100644 --- a/includes/class-ui.php +++ b/includes/class-ui.php @@ -30,13 +30,16 @@ class UI { * @return void */ public static function register_tab( $slug, $label, $args = [] ) { - self::$tabs[ $slug ] = (object) wp_parse_args( $args, [ - 'label' => $label, - 'file' => WP_REDIS_PLUGIN_PATH . "/includes/ui/tabs/{$slug}.php", - 'slug' => $slug, - 'default' => false, - 'disabled' => false, - ] ); + self::$tabs[ $slug ] = (object) wp_parse_args( + $args, + [ + 'label' => $label, + 'file' => WP_REDIS_PLUGIN_PATH . "/includes/ui/tabs/{$slug}.php", + 'slug' => $slug, + 'default' => false, + 'disabled' => false, + ] + ); } /** From f556a5f9bc2ff41e6dce6e47bbe81c2088739475 Mon Sep 17 00:00:00 2001 From: naxvog Date: Sat, 15 Aug 2020 19:24:49 +0200 Subject: [PATCH 58/93] ui tab abstraction --- includes/class-ui.php | 11 +- includes/ui/class-tab.php | 219 +++++++++++++++++++++++++++++++ includes/ui/diagnostics.php | 14 +- includes/ui/settings.php | 30 ++--- includes/ui/tabs/diagnostics.php | 2 - includes/ui/tabs/overview.php | 42 +++--- 6 files changed, 263 insertions(+), 55 deletions(-) create mode 100644 includes/ui/class-tab.php diff --git a/includes/class-ui.php b/includes/class-ui.php index 79a50287..b251dcce 100644 --- a/includes/class-ui.php +++ b/includes/class-ui.php @@ -30,16 +30,7 @@ class UI { * @return void */ public static function register_tab( $slug, $label, $args = [] ) { - self::$tabs[ $slug ] = (object) wp_parse_args( - $args, - [ - 'label' => $label, - 'file' => WP_REDIS_PLUGIN_PATH . "/includes/ui/tabs/{$slug}.php", - 'slug' => $slug, - 'default' => false, - 'disabled' => false, - ] - ); + self::$tabs[ $slug ] = new UI\Tab( $slug, $label, $args ); } /** diff --git a/includes/ui/class-tab.php b/includes/ui/class-tab.php new file mode 100644 index 00000000..7759cd12 --- /dev/null +++ b/includes/ui/class-tab.php @@ -0,0 +1,219 @@ + $slug, + 'label' => $label, + 'file' => WP_REDIS_PLUGIN_PATH . "/includes/ui/tabs/{$slug}.php", + ] + ); + foreach ( $args ?: [] as $property => $value ) { + if ( property_exists( $this, $property ) ) { + $this->{$property} = $value; + } else { + $this->custom[ $property ] = $value; + } + } + } + + /** + * Getter for tab slug + * + * @return string + */ + public function slug() { + return $this->slug; + } + + /** + * Getter for tab label + * + * @return string + */ + public function label() { + return $this->label; + } + + /** + * Getter for tab file + * + * @return string + */ + public function file() { + return $this->file; + } + + /** + * Getter for tab disabled state + * + * @return bool + */ + public function is_disabled() { + return $this->disabled; + } + + /** + * Getter for tab default state + * + * @return bool + */ + public function is_default() { + return $this->default; + } + + /** + * Getter for tab custom data + * + * @param $string $key Custom data key. + * @return mixed + */ + public function custom( $key ) { + if ( ! isset( $this->custom[ $key ] ) ) { + return null; + } + return $this->custom[ $key ]; + } + + /** + * Disabled notice for tab + * + * @return string + */ + public function disabled_notice() { + return sprintf( + // translators: %s = Tab label. + __( '%s are disabled for this site.', 'redis-cache' ), + $this->label + ); + } + + /** + * Displays the tab template + * + * @return void + */ + public function display() { + $roc = Plugin::instance(); + include $this->file; + } + + /** + * Returns the tab nav id attribute + * + * @return string + */ + public function nav_id() { + return apply_filters( 'roc_tab_nav_id', "{$this->slug}-tab", $this ); + } + + /** + * Returns the tab nav css classes + * + * @return string + */ + public function nav_classes() { + $classes = [ + 'nav-tab', + ]; + if ( $this->default ) { + $classes[] = 'nav-tab-active'; + } + if ( $this->disabled ) { + $classes[] = 'nav-tab-disabled'; + } + return implode( ' ', apply_filters( 'roc_tab_nav_classes', $classes, $this ) ); + } + + /** + * Returns the tab id attribute + * + * @return string + */ + public function id() { + return apply_filters( 'roc_tab_id', "{$this->slug}-pane", $this ); + } + + /** + * Returns the tab css classes + * + * @return string + */ + public function classes() { + $classes = [ + 'tab-pane', + "tab-pane-{$this->slug}", + ]; + if ( $this->default ) { + $classes[] = 'active'; + } + return implode( ' ', apply_filters( 'roc_tab_classes', $classes, $this ) ); + } + +} diff --git a/includes/ui/diagnostics.php b/includes/ui/diagnostics.php index ce3cb1a0..f8720192 100644 --- a/includes/ui/diagnostics.php +++ b/includes/ui/diagnostics.php @@ -10,14 +10,14 @@ global $wp_object_cache; $info = []; -$filesystem = $plugin->test_filesystem_writing(); -$dropin = $plugin->validate_object_cache_dropin(); +$filesystem = $roc->test_filesystem_writing(); +$dropin = $roc->validate_object_cache_dropin(); $disabled = defined( 'WP_REDIS_DISABLED' ) && WP_REDIS_DISABLED; -$info['Status'] = $plugin->get_status(); -$info['Client'] = $plugin->get_redis_client_name(); -$info['Drop-in'] = $plugin->object_cache_dropin_exists() - ? ($dropin ? 'Valid' : 'Invalid') +$info['Status'] = $roc->get_status(); +$info['Client'] = $roc->get_redis_client_name(); +$info['Drop-in'] = $roc->object_cache_dropin_exists() + ? ( $dropin ? 'Valid' : 'Invalid' ) : 'Not installed'; $info['Disabled'] = $disabled ? 'Yes' : 'No'; $info['Filesystem'] = is_wp_error( $filesystem ) ? $filesystem->get_error_message() : 'Working'; @@ -52,7 +52,7 @@ } $info['Plugin Version'] = WP_REDIS_VERSION; -$info['Redis Version'] = $plugin->get_redis_version() ?: 'Unknown'; +$info['Redis Version'] = $roc->get_redis_version() ?: 'Unknown'; $info['Multisite'] = is_multisite() ? 'Yes' : 'No'; diff --git a/includes/ui/settings.php b/includes/ui/settings.php index 2632a36d..9ba99cd7 100644 --- a/includes/ui/settings.php +++ b/includes/ui/settings.php @@ -26,28 +26,24 @@

- disabled ) : ?> + is_disabled() ) : ?> - label ); ?> + label() ); ?> - label ); ?> + label() ); ?> @@ -56,11 +52,11 @@ class="nav-tab default ? 'nav-tab-active' : ''; ?>"
- disabled ) : ?> -
is_disabled() ) : ?> +
- file; ?> + display(); ?>
diff --git a/includes/ui/tabs/diagnostics.php b/includes/ui/tabs/diagnostics.php index 4509e0c3..4a4e9a91 100644 --- a/includes/ui/tabs/diagnostics.php +++ b/includes/ui/tabs/diagnostics.php @@ -7,8 +7,6 @@ defined( '\\ABSPATH' ) || exit; -$plugin = $this; - ?>

diff --git a/includes/ui/tabs/overview.php b/includes/ui/tabs/overview.php index 6f1bf029..9c15348b 100644 --- a/includes/ui/tabs/overview.php +++ b/includes/ui/tabs/overview.php @@ -7,14 +7,12 @@ defined( '\\ABSPATH' ) || exit; -$plugin = redis_object_cache(); +$redis_client = $roc->get_redis_client_name(); +$redis_prefix = $roc->get_redis_prefix(); +$redis_maxttl = $roc->get_redis_maxttl(); +$redis_version = $roc->get_redis_version(); -$redis_client = $plugin->get_redis_client_name(); -$redis_prefix = $plugin->get_redis_prefix(); -$redis_maxttl = $plugin->get_redis_maxttl(); -$redis_version = $plugin->get_redis_version(); - -$diagnostics = $plugin->get_diagnostics(); +$diagnostics = $roc->get_diagnostics(); ?> @@ -37,14 +35,15 @@ - object_cache_dropin_exists() ) : ?> + object_cache_dropin_exists() ) : ?> - object_cache_dropin_outdated() ) : ?> + object_cache_dropin_outdated() ) : ?> - validate_object_cache_dropin() - ? esc_html_e( 'Valid', 'redis-cache' ) - : esc_html_e( 'Invalid', 'redis-cache' ); + validate_object_cache_dropin() + ? esc_html_e( 'Valid', 'redis-cache' ) + : esc_html_e( 'Invalid', 'redis-cache' ); ?> @@ -94,7 +93,7 @@ - get_status() ); ?> + get_status() ); ?> @@ -161,7 +160,12 @@ - + + + @@ -235,18 +239,18 @@

- get_redis_status() ) : ?> - + get_redis_status() ) : ?> +   - validate_object_cache_dropin() ) : ?> - + validate_object_cache_dropin() ) : ?> + - + From 5ce24cf3fe1c9e121387b88ed8aec45a55d7ce03 Mon Sep 17 00:00:00 2001 From: naxvog Date: Sat, 15 Aug 2020 21:34:51 +0200 Subject: [PATCH 59/93] diagnostics output escaping --- includes/ui/diagnostics.php | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/includes/ui/diagnostics.php b/includes/ui/diagnostics.php index f8720192..b71d9c1d 100644 --- a/includes/ui/diagnostics.php +++ b/includes/ui/diagnostics.php @@ -140,6 +140,6 @@ if ( defined( 'WP_CLI' ) && WP_CLI ) { WP_CLI::line( "{$name}: $value" ); } else { - echo "{$name}: {$value}\r\n"; + echo esc_html( "{$name}: {$value}\r\n" ); } } From 5565c311fea142898d53aad77f7ccbaf422e9beb Mon Sep 17 00:00:00 2001 From: naxvog Date: Sat, 15 Aug 2020 21:59:46 +0200 Subject: [PATCH 60/93] added documentation for QM classes --- includes/class-qm-collector.php | 35 +++++++++++++++++++++++++++------ includes/class-qm-output.php | 28 ++++++++++++++++++++++++++ 2 files changed, 57 insertions(+), 6 deletions(-) diff --git a/includes/class-qm-collector.php b/includes/class-qm-collector.php index 1cda3af4..32829a77 100644 --- a/includes/class-qm-collector.php +++ b/includes/class-qm-collector.php @@ -11,24 +11,42 @@ defined( '\\ABSPATH' ) || exit; +/** + * Query Monitor data collector class definition + */ class QM_Collector extends Base_Collector { + /** + * Collector id + * + * @var string $id + */ public $id = 'cache'; + /** + * Retrieves the collector name + * + * @return string + */ public function name() { return __( 'Object Cache', 'redis-cache' ); } + /** + * Fills the collector with data + * + * @return void + */ public function process() { - global $wp_object_cache; + global $wp_object_cache; $this->process_defaults(); - $plugin = Plugin::instance(); + $roc = Plugin::instance(); - $this->data['status'] = $plugin->get_status(); - $this->data['has_dropin'] = $plugin->object_cache_dropin_exists(); - $this->data['valid_dropin'] = $plugin->validate_object_cache_dropin(); + $this->data['status'] = $roc->get_status(); + $this->data['has_dropin'] = $roc->object_cache_dropin_exists(); + $this->data['valid_dropin'] = $roc->validate_object_cache_dropin(); if ( ! method_exists( $wp_object_cache, 'info' ) ) { return; @@ -54,12 +72,17 @@ public function process() { 'unflushable' => $info->groups->unflushable, ]; - // these are used by Query Monitor + // These are used by Query Monitor. $this->data['stats']['cache_hits'] = $info->hits; $this->data['stats']['cache_misses'] = $info->misses; $this->data['cache_hit_percentage'] = $info->ratio; } + /** + * Sets collector defaults + * + * @return void + */ public function process_defaults() { $this->data['hits'] = 0; $this->data['misses'] = 0; diff --git a/includes/class-qm-output.php b/includes/class-qm-output.php index 17978479..6c28d922 100644 --- a/includes/class-qm-output.php +++ b/includes/class-qm-output.php @@ -11,8 +11,16 @@ defined( '\\ABSPATH' ) || exit; +/** + * Query Monitor output logic class definition + */ class QM_Output extends QM_Output_Html { + /** + * Contructor + * + * @param QM_Collector $collector The corresponding collector instance. + */ public function __construct( QM_Collector $collector ) { parent::__construct( $collector ); @@ -20,10 +28,20 @@ public function __construct( QM_Collector $collector ) { add_filter( 'qm/output/panel_menus', [ $this, 'panel_menu' ] ); } + /** + * Output class name + * + * @return string + */ public function name() { return __( 'Object Cache', 'redis cache' ); } + /** + * Adds a menu to the panel navigation menu in Query Monitor's output + * + * @param array $menu Array of menus. + */ public function admin_menu( array $menu ) { $data = $this->collector->get_data(); @@ -48,6 +66,11 @@ public function admin_menu( array $menu ) { return $menu; } + /** + * Adds a menu item in the panel navigation menu in Query Monitor's output. + * + * @param array $menu Array of menus. + */ public function panel_menu( array $menu ) { $ids = array_keys( $menu ); $request = array_search( 'qm-request', $ids, true ); @@ -64,6 +87,11 @@ public function panel_menu( array $menu ) { ); } + /** + * Renders the output + * + * @return void + */ public function output() { $data = $this->collector->get_data(); From ccaa2051a9c352eef212ec31416ba3a424b43b41 Mon Sep 17 00:00:00 2001 From: naxvog Date: Sat, 15 Aug 2020 22:00:29 +0200 Subject: [PATCH 61/93] added output escaping + ignore statements --- includes/class-qm-output.php | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/includes/class-qm-output.php b/includes/class-qm-output.php index 6c28d922..f44534b5 100644 --- a/includes/class-qm-output.php +++ b/includes/class-qm-output.php @@ -97,7 +97,10 @@ public function output() { if ( ! $data['has_dropin'] ) { $this->before_non_tabular_output(); - echo $this->build_notice( __( 'The Redis Object Cache drop-in is not installed. Use WP CLI or go to "Settings -> Redis" to enable drop-in.', 'redis-cache' ) ); + // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped + echo $this->build_notice( + esc_html__( 'The Redis Object Cache drop-in is not installed. Use WP CLI or go to "Settings -> Redis" to enable drop-in.', 'redis-cache' ) + ); $this->after_non_tabular_output(); return; @@ -105,7 +108,10 @@ public function output() { if ( ! $data['valid_dropin'] ) { $this->before_non_tabular_output(); - echo $this->build_notice( __( 'WordPress is using a foreign object cache drop-in and Redis Object Cache is not being used. Use WP CLI or go to "Settings -> Redis" to enable drop-in.', 'redis-cache' ) ); + // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped + echo $this->build_notice( + esc_html__( 'WordPress is using a foreign object cache drop-in and Redis Object Cache is not being used. Use WP CLI or go to "Settings -> Redis" to enable drop-in.', 'redis-cache' ) + ); $this->after_non_tabular_output(); return; From 408b7465059675a76bd9a9a20f05b3c634267178 Mon Sep 17 00:00:00 2001 From: naxvog Date: Sat, 15 Aug 2020 22:08:04 +0200 Subject: [PATCH 62/93] ignore file naming convention due to class definition in drop-in --- includes/object-cache.php | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/includes/object-cache.php b/includes/object-cache.php index b47bc984..7a2090f2 100644 --- a/includes/object-cache.php +++ b/includes/object-cache.php @@ -1,4 +1,4 @@ - Date: Sat, 15 Aug 2020 22:09:55 +0200 Subject: [PATCH 63/93] fixed indentation issue --- includes/object-cache.php | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/includes/object-cache.php b/includes/object-cache.php index 7a2090f2..ff0bfdfe 100644 --- a/includes/object-cache.php +++ b/includes/object-cache.php @@ -14,7 +14,9 @@ defined( '\\ABSPATH' ) || exit; -if ( ! defined( 'WP_REDIS_DISABLED' ) || ! WP_REDIS_DISABLED ) : +if ( ! defined( 'WP_REDIS_DISABLED' ) || ! WP_REDIS_DISABLED ) { + return; +} /** * Adds a value to cache. @@ -1999,5 +2001,3 @@ public function __get( $name ) { return isset($this->{$name}) ? $this->{$name} : null; } } - -endif; From b64717b9f73cd0d213e817f19db95a2ac1c1d5b1 Mon Sep 17 00:00:00 2001 From: naxvog Date: Sat, 15 Aug 2020 22:42:27 +0200 Subject: [PATCH 64/93] fixed precision alignment issues --- includes/object-cache.php | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/includes/object-cache.php b/includes/object-cache.php index ff0bfdfe..480852f2 100644 --- a/includes/object-cache.php +++ b/includes/object-cache.php @@ -48,7 +48,7 @@ function wp_cache_add( $key, $value, $group = '', $expiration = 0 ) { * @return bool Always returns True */ function wp_cache_close() { - return true; + return true; } /** @@ -865,7 +865,7 @@ public function fetch_info() { * @return bool */ public function redis_status() { - return (bool) $this->redis_connected; + return (bool) $this->redis_connected; } /** @@ -874,7 +874,7 @@ public function redis_status() { * @return mixed */ public function redis_instance() { - return $this->redis; + return $this->redis; } /** @@ -883,7 +883,7 @@ public function redis_instance() { * @return null|string */ public function redis_version() { - return $this->redis_version; + return $this->redis_version; } /** @@ -1671,7 +1671,7 @@ public function build_key( $key, $group = 'default' ) { * @return string Sanitized string. */ protected function sanitize_key_part( $part ) { - return str_replace( ':', '-', $part ); + return str_replace( ':', '-', $part ); } /** From 3ebae67e044a49dec8b247efbc1f2c0343e1218e Mon Sep 17 00:00:00 2001 From: naxvog Date: Sat, 15 Aug 2020 23:02:12 +0200 Subject: [PATCH 65/93] Added and improved documentation --- includes/object-cache.php | 98 +++++++++++++++++++++++---------------- 1 file changed, 57 insertions(+), 41 deletions(-) diff --git a/includes/object-cache.php b/includes/object-cache.php index 480852f2..dcd2f2f4 100644 --- a/includes/object-cache.php +++ b/includes/object-cache.php @@ -104,7 +104,7 @@ function wp_cache_flush( $delay = 0 ) { * @param string $group The group value appended to the $key. * @param bool $force Optional. Whether to force an update of the local cache from the persistent * cache. Default false. - * @param bool &$found Optional. Whether the key was found in the cache. Disambiguates a return of false, + * @param bool $found Optional. Whether the key was found in the cache. Disambiguates a return of false, * a storable value. Passed by reference. Default null. * * @return bool|mixed Cached object value. @@ -153,7 +153,7 @@ function wp_cache_incr( $key, $offset = 1, $group = '' ) { function wp_cache_init() { global $wp_object_cache; - // backwards compatibility: map `WP_CACHE_KEY_SALT` constant to `WP_REDIS_PREFIX` + // Backwards compatibility: map `WP_CACHE_KEY_SALT` constant to `WP_REDIS_PREFIX`. if ( defined( 'WP_CACHE_KEY_SALT' ) && ! defined( 'WP_REDIS_PREFIX' ) ) { define( 'WP_REDIS_PREFIX', WP_CACHE_KEY_SALT ); } @@ -207,7 +207,7 @@ function wp_cache_set( $key, $value, $group = '', $expiration = 0 ) { * * This changes the blog id used to create keys in blog specific groups. * - * @param int $_blog_id Blog ID + * @param int $_blog_id The blog ID. * * @return bool */ @@ -243,6 +243,9 @@ function wp_cache_add_non_persistent_groups( $groups ) { $wp_object_cache->add_non_persistent_groups( $groups ); } +/** + * Object cache class definition + */ class WP_Object_Cache { /** @@ -382,7 +385,7 @@ class WP_Object_Cache { /** * Instantiate the Redis class. * - * @param bool $fail_gracefully + * @param bool $fail_gracefully Handles and logs errors if true throws exceptions otherwise. */ public function __construct( $fail_gracefully = true ) { global $blog_id, $table_prefix; @@ -434,7 +437,7 @@ public function __construct( $fail_gracefully = true ) { $this->handle_exception( $exception ); } - // Assign global and blog prefixes for use with keys + // Assign global and blog prefixes for use with keys. if ( function_exists( 'is_multisite' ) ) { $this->global_prefix = is_multisite() ? '' : $table_prefix; $this->blog_prefix = is_multisite() ? $blog_id : $table_prefix; @@ -511,7 +514,7 @@ protected function build_parameters() { /** * Connect to Redis using the PhpRedis (PECL) extention. * - * @param array $parameters + * @param array $parameters Connection parameters built by the `build_parameters` method. * @return void */ protected function connectUsingPhpRedis( $parameters ) { @@ -595,7 +598,8 @@ protected function connectUsingPhpRedis( $parameters ) { /** * Connect to Redis using the Predis library. * - * @param array $parameters + * @param array $parameters Connection parameters built by the `build_parameters` method. + * @throws \Exception If the Predis library was not found or is unreadable. * @return void */ protected function connectUsingPredis( $parameters ) { @@ -606,7 +610,7 @@ protected function connectUsingPredis( $parameters ) { throw new Exception( 'Predis requires PHP 5.4 or newer.' ); } - // Load bundled Predis library + // Load bundled Predis library. if ( ! class_exists( 'Predis\Client' ) ) { $predis = sprintf( '%s/redis-cache/dependencies/predis/predis/autoload.php', @@ -668,7 +672,10 @@ protected function connectUsingPredis( $parameters ) { /** * Connect to Redis using the Credis library. * - * @param array $parameters + * @param array $parameters Connection parameters built by the `build_parameters` method. + * @throws \Exception If the Credis library was not found or is unreadable. + * @throws \Exception If redis sharding should be configured as Credis does not support sharding. + * @throws \Exception If more than one seninel is configured as Credis does not support multiple sentinel servers. * @return void */ protected function connectUsingCredis( $parameters ) { @@ -769,7 +776,7 @@ protected function connectUsingCredis( $parameters ) { $this->redis = new Credis_Client( ...array_values( $args ) ); } - // Don't use PhpRedis + // Don't use PhpRedis if it is available. $this->redis->forceStandalone(); $this->redis->connect(); @@ -788,13 +795,13 @@ protected function connectUsingCredis( $parameters ) { /** * Connect to Redis using HHVM's Redis extention. * - * @param array $parameters + * @param array $parameters Connection parameters built by the `build_parameters` method. * @return void */ protected function connectUsingHHVM( $parameters ) { $this->redis = new Redis(); - // Adjust host and port, if the scheme is `unix` + // Adjust host and port if the scheme is `unix`. if ( strcasecmp( 'unix', $parameters['scheme'] ) === 0 ) { $parameters['host'] = 'unix://' . $parameters['path']; $parameters['port'] = 0; @@ -923,7 +930,7 @@ public function replace( $key, $value, $group = 'default', $expiration = 0 ) { * * Add does not set the value if the key exists; replace does not replace if the value doesn't exist. * - * @param bool $add True if should only add if value doesn't exist, false to only add when value already exists + * @param bool $add True if should only add if value doesn't exist, false to only add when value already exists. * @param string $key The key under which to store the value. * @param mixed $value The value to store. * @param string $group The group value appended to the $key. @@ -942,7 +949,7 @@ protected function add_or_replace( $add, $key, $value, $group = 'default', $expi $result = true; $derived_key = $this->build_key( $key, $group ); - // save if group not excluded and redis is up + // Save if group not excluded and redis is up. if ( ! $this->is_ignored_group( $group ) && $this->redis_status() ) { try { $expiration = apply_filters( 'redis_cache_expiration', $this->validate_expiration( $expiration ), $key, $group ); @@ -1150,6 +1157,12 @@ protected function get_flush_closure( $salt ) { } } + /** + * Quotes a string for usage in the `glob` function + * + * @param string $string The string to quote. + * @return string + */ protected function glob_quote( $string ) { $characters = [ '*', '+', '?', '!', '{', '}', '[', ']', '(', ')', '|', '@' ]; @@ -1267,7 +1280,7 @@ function ( $group ) { * @param string $group The group value appended to the $key. * @param string $force Optional. Whether to force a refetch rather than relying on the local * cache. Default false. - * @param bool &$found Optional. Whether the key was found in the cache. Disambiguates a return of + * @param bool $found Optional. Whether the key was found in the cache. Disambiguates a return of * false, a storable value. Passed by reference. Default null. * @return bool|mixed Cached object value. */ @@ -1444,7 +1457,7 @@ public function set( $key, $value, $group = 'default', $expiration = 0 ) { $start_time = microtime( true ); - // save if group not excluded from redis and redis is up + // Save if group not excluded from redis and redis is up. if ( ! $this->is_ignored_group( $group ) && $this->redis_status() ) { $expiration = apply_filters( 'redis_cache_expiration', $this->validate_expiration( $expiration ), $key, $group ); @@ -1464,7 +1477,7 @@ public function set( $key, $value, $group = 'default', $expiration = 0 ) { $this->cache_time += ( microtime( true ) - $start_time ); } - // if the set was successful, or we didn't go to redis + // If the set was successful, or we didn't go to redis. if ( $result ) { $this->add_to_internal_cache( $derived_key, $value ); } @@ -1481,16 +1494,16 @@ public function set( $key, $value, $group = 'default', $expiration = 0 ) { /** * Increment a Redis counter by the amount specified * - * @param string $key - * @param int $offset - * @param string $group + * @param string $key The key name. + * @param int $offset Optional. The increment. Defaults to 1. + * @param string $group Optional. The key group. Default is 'default'. * @return int|bool */ public function increment( $key, $offset = 1, $group = 'default' ) { $offset = (int) $offset; $derived_key = $this->build_key( $key, $group ); - // If group is a non-Redis group, save to internal cache, not Redis + // If group is a non-Redis group, save to internal cache, not Redis. if ( $this->is_ignored_group( $group ) || ! $this->redis_status() ) { $value = $this->get_from_internal_cache( $derived_key ); $value += $offset; @@ -1522,10 +1535,11 @@ public function increment( $key, $offset = 1, $group = 'default' ) { /** * Alias of `increment()`. * - * @param string $key - * @param int $offset - * @param string $group - * @return bool + * @see self::increment() + * @param string $key The key name. + * @param int $offset Optional. The increment. Defaults to 1. + * @param string $group Optional. The key group. Default is 'default'. + * @return int|bool */ public function incr( $key, $offset = 1, $group = 'default' ) { return $this->increment( $key, $offset, $group ); @@ -1534,16 +1548,16 @@ public function incr( $key, $offset = 1, $group = 'default' ) { /** * Decrement a Redis counter by the amount specified * - * @param string $key - * @param int $offset - * @param string $group + * @param string $key The key name. + * @param int $offset Optional. The decrement. Defaults to 1. + * @param string $group Optional. The key group. Default is 'default'. * @return int|bool */ public function decrement( $key, $offset = 1, $group = 'default' ) { $derived_key = $this->build_key( $key, $group ); $offset = (int) $offset; - // If group is a non-Redis group, save to internal cache, not Redis + // If group is a non-Redis group, save to internal cache, not Redis. if ( $this->is_ignored_group( $group ) || ! $this->redis_status() ) { $value = $this->get_from_internal_cache( $derived_key ); $value -= $offset; @@ -1555,7 +1569,7 @@ public function decrement( $key, $offset = 1, $group = 'default' ) { $start_time = microtime( true ); try { - // Save to Redis + // Save to Redis. $result = $this->parse_redis_response( $this->redis->decrBy( $derived_key, $offset ) ); $this->add_to_internal_cache( $derived_key, (int) $this->redis->get( $derived_key ) ); @@ -1677,7 +1691,7 @@ protected function sanitize_key_part( $part ) { /** * Checks if the given group is part the ignored group array * - * @param string $group Name of the group to check + * @param string $group Name of the group to check. * @return bool */ protected function is_ignored_group( $group ) { @@ -1687,7 +1701,7 @@ protected function is_ignored_group( $group ) { /** * Checks if the given group is part the global group array * - * @param string $group Name of the group to check + * @param string $group Name of the group to check. * @return bool */ protected function is_global_group( $group ) { @@ -1697,7 +1711,7 @@ protected function is_global_group( $group ) { /** * Checks if the given group is part the unflushable group array * - * @param string $group Name of the group to check + * @param string $group Name of the group to check. * @return bool */ protected function is_unflushable_group( $group ) { @@ -1707,7 +1721,7 @@ protected function is_unflushable_group( $group ) { /** * Convert Redis responses into something meaningful * - * @param mixed $response + * @param mixed $response Response sent from the redis instance. * @return mixed */ protected function parse_redis_response( $response ) { @@ -1762,7 +1776,7 @@ public function get_from_internal_cache( $derived_key ) { /** * In multisite, switch blog prefix when switching blogs * - * @param int $_blog_id + * @param int $_blog_id Blog ID. * @return bool */ public function switch_to_blog( $_blog_id ) { @@ -1815,7 +1829,7 @@ public function add_unflushable_groups( $groups ) { /** * Wrapper to validate the cache keys expiration value * - * @param mixed $expiration Incoming expiration value (whatever it is) + * @param mixed $expiration Incoming expiration value (whatever it is). */ protected function validate_expiration( $expiration ) { $expiration = is_int( $expiration ) || ctype_digit( $expiration ) ? (int) $expiration : 0; @@ -1846,7 +1860,7 @@ protected function maybe_unserialize( $original ) { return igbinary_unserialize( $original ); } - // don't attempt to unserialize data that wasn't serialized going in + // Don't attempt to unserialize data that wasn't serialized going in. if ( $this->is_serialized( $original ) ) { $value = @unserialize( $original ); @@ -1951,8 +1965,8 @@ protected function is_serialized( $data, $strict = true ) { } elseif ( false === strpos( $data, '"' ) ) { return false; } - // or else fall through - // no break + // Or else fall through. + // No break! case 'a': case 'O': return (bool) preg_match( "/^{$token}:[0-9]+:/s", $data ); @@ -1971,11 +1985,13 @@ protected function is_serialized( $data, $strict = true ) { * Handle the redis failure gracefully or throw an exception. * * @param \Exception $exception Exception thrown. + * @throws \Exception If `fail_gracefully` flag is set to a falsy value. + * @return void */ protected function handle_exception( $exception ) { $this->redis_connected = false; - // When Redis is unavailable, fall back to the internal cache by forcing all groups to be "no redis" groups + // When Redis is unavailable, fall back to the internal cache by forcing all groups to be "no redis" groups. $this->ignored_groups = array_unique( array_merge( $this->ignored_groups, $this->global_groups ) ); if ( ! $this->fail_gracefully ) { @@ -1994,7 +2010,7 @@ protected function handle_exception( $exception ) { /** * Allows access to private properties for backwards compatibility. * - * @param string $name + * @param string $name Name of the property. * @return mixed */ public function __get( $name ) { From 28147b2a2fef8196d1bb267fe31899713a385e50 Mon Sep 17 00:00:00 2001 From: naxvog Date: Sat, 15 Aug 2020 22:47:06 +0200 Subject: [PATCH 66/93] phpcs ignores --- includes/object-cache.php | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/includes/object-cache.php b/includes/object-cache.php index dcd2f2f4..c77ac719 100644 --- a/includes/object-cache.php +++ b/includes/object-cache.php @@ -161,6 +161,8 @@ function wp_cache_init() { if ( ! ( $wp_object_cache instanceof WP_Object_Cache ) ) { $fail_gracefully = ! defined( 'WP_REDIS_GRACEFUL' ) || WP_REDIS_GRACEFUL; + // We need to override this WordPress global in order to inject our cache. + // phpcs:ignore WordPress.WP.GlobalVariablesOverride.Prohibited $wp_object_cache = new WP_Object_Cache( $fail_gracefully ); } } @@ -1595,6 +1597,7 @@ public function decrement( $key, $offset = 1, $group = 'default' ) { public function stats() { $bytes = array_map( function ( $key ) { + // phpcs:ignore WordPress.PHP.DiscouragedPHPFunctions.serialize_serialize return strlen( serialize( $key ) ); }, $this->cache @@ -1629,6 +1632,7 @@ public function info() { $bytes = array_map( function ( $keys ) { + // phpcs:ignore WordPress.PHP.DiscouragedPHPFunctions.serialize_serialize return strlen( serialize( $keys ) ); }, $this->cache @@ -1862,6 +1866,7 @@ protected function maybe_unserialize( $original ) { // Don't attempt to unserialize data that wasn't serialized going in. if ( $this->is_serialized( $original ) ) { + // phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged, WordPress.PHP.DiscouragedPHPFunctions.serialize_unserialize $value = @unserialize( $original ); return is_object( $value ) ? clone $value : $value; @@ -1890,10 +1895,12 @@ protected function maybe_serialize( $data ) { } if ( is_array( $data ) || is_object( $data ) ) { + // phpcs:ignore WordPress.PHP.DiscouragedPHPFunctions.serialize_serialize return serialize( $data ); } if ( $this->is_serialized( $data, false ) ) { + // phpcs:ignore WordPress.PHP.DiscouragedPHPFunctions.serialize_serialize return serialize( $data ); } @@ -2000,7 +2007,7 @@ protected function handle_exception( $exception ) { $this->errors[] = $exception->getMessage(); - error_log( $exception ); + error_log( $exception ); // phpcs:ignore WordPress.PHP.DevelopmentFunctions.error_log_error_log if ( function_exists( 'do_action' ) ) { do_action( 'redis_object_cache_error', $exception ); From b1c4fc9d9ee6e066484615db0c2088e6ae42b813 Mon Sep 17 00:00:00 2001 From: naxvog Date: Sat, 15 Aug 2020 22:48:22 +0200 Subject: [PATCH 67/93] method name fixes --- includes/object-cache.php | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/includes/object-cache.php b/includes/object-cache.php index c77ac719..28ee5af1 100644 --- a/includes/object-cache.php +++ b/includes/object-cache.php @@ -412,17 +412,17 @@ public function __construct( $fail_gracefully = true ) { try { switch ( $client ) { case 'hhvm': - $this->connectUsingHHVM( $parameters ); + $this->connect_using_hhvm( $parameters ); break; case 'phpredis': - $this->connectUsingPhpRedis( $parameters ); + $this->connect_using_phpredis( $parameters ); break; case 'credis': - $this->connectUsingCredis( $parameters ); + $this->connect_using_credis( $parameters ); break; case 'predis': default: - $this->connectUsingPredis( $parameters ); + $this->connect_using_predis( $parameters ); break; } @@ -519,7 +519,7 @@ protected function build_parameters() { * @param array $parameters Connection parameters built by the `build_parameters` method. * @return void */ - protected function connectUsingPhpRedis( $parameters ) { + protected function connect_using_phpredis( $parameters ) { $version = phpversion( 'redis' ); $this->diagnostics[ 'client' ] = sprintf( 'PhpRedis (v%s)', $version ); @@ -604,7 +604,7 @@ protected function connectUsingPhpRedis( $parameters ) { * @throws \Exception If the Predis library was not found or is unreadable. * @return void */ - protected function connectUsingPredis( $parameters ) { + protected function connect_using_predis( $parameters ) { $client = 'Predis'; // Require PHP 5.4 or greater @@ -680,7 +680,7 @@ protected function connectUsingPredis( $parameters ) { * @throws \Exception If more than one seninel is configured as Credis does not support multiple sentinel servers. * @return void */ - protected function connectUsingCredis( $parameters ) { + protected function connect_using_credis( $parameters ) { $client = 'Credis'; // Require PHP 5.4 or greater @@ -800,7 +800,7 @@ protected function connectUsingCredis( $parameters ) { * @param array $parameters Connection parameters built by the `build_parameters` method. * @return void */ - protected function connectUsingHHVM( $parameters ) { + protected function connect_using_hhvm( $parameters ) { $this->redis = new Redis(); // Adjust host and port if the scheme is `unix`. From c0072a6aba92edf14c0a429663555a97a0e3bc7d Mon Sep 17 00:00:00 2001 From: naxvog Date: Sat, 15 Aug 2020 22:49:02 +0200 Subject: [PATCH 68/93] yoda style conditions --- includes/object-cache.php | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/includes/object-cache.php b/includes/object-cache.php index 28ee5af1..3db22ca4 100644 --- a/includes/object-cache.php +++ b/includes/object-cache.php @@ -505,7 +505,7 @@ protected function build_parameters() { if ( isset( $parameters['password'] ) ) { $password = $parameters['password']; - if ( is_null( $password ) || $password === '' ) { + if ( is_null( $password ) || '' === $password ) { unset( $parameters['password'] ); } } @@ -767,7 +767,7 @@ protected function connect_using_credis( $parameters ) { $args['servers'] = $clients; } else { $args = [ - 'host' => $parameters['scheme'] === 'unix' ? $parameters['path'] : $parameters['host'], + 'host' => 'unix' === $parameters['scheme'] ? $parameters['path'] : $parameters['host'], 'port' => $parameters['port'], 'timeout' => $parameters['timeout'], 'persistent' => null, @@ -1316,7 +1316,7 @@ public function get( $key, $group = 'default', $force = false, &$found = null ) $this->cache_calls++; $this->cache_time += $execute_time; - if ( $result === null || $result === false ) { + if ( null === $result || false === $result ) { $found = false; $this->cache_misses++; @@ -1366,7 +1366,7 @@ public function get_multiple( $keys, $group = 'default', $force = false ) { if ( $this->is_ignored_group( $group ) || ! $this->redis_status() ) { foreach ( $keys as $key ) { $cache[ $key ] = $this->get_from_internal_cache( $derived_keys[ $key ] ); - $cache[ $key ] === false ? $this->cache_misses++ : $this->cache_hits++; + false === $cache[ $key ] ? $this->cache_misses++ : $this->cache_hits++; } return $cache; @@ -1376,7 +1376,7 @@ public function get_multiple( $keys, $group = 'default', $force = false ) { foreach ( $keys as $key ) { $value = $this->get_from_internal_cache( $derived_keys[ $key ] ); - if ( $value === false ) { + if ( false === $value ) { $this->cache_misses++; } else { $cache[ $key ] = $value; @@ -1416,7 +1416,7 @@ public function get_multiple( $keys, $group = 'default', $force = false ) { $this->cache_time += $execute_time; foreach ( $results as $key => $value ) { - if ( $value === null || $value === false ) { + if ( null === $value || false === $value ) { $cache[ $key ] = false; $this->cache_misses++; } else { @@ -1841,7 +1841,7 @@ protected function validate_expiration( $expiration ) { if ( defined( 'WP_REDIS_MAXTTL' ) ) { $max = (int) WP_REDIS_MAXTTL; - if ( $expiration === 0 || $expiration > $max ) { + if ( 0 === $expiration || $expiration > $max ) { $expiration = $max; } } From efb9272417a5b71da1c32e900662f99e6120bc2b Mon Sep 17 00:00:00 2001 From: naxvog Date: Sat, 15 Aug 2020 22:49:23 +0200 Subject: [PATCH 69/93] comment typo --- includes/object-cache.php | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/includes/object-cache.php b/includes/object-cache.php index 3db22ca4..006a1b70 100644 --- a/includes/object-cache.php +++ b/includes/object-cache.php @@ -731,7 +731,7 @@ protected function connect_using_credis( $parameters ) { if ( defined( 'WP_REDIS_SENTINEL' ) ) { if ( is_array( WP_REDIS_SERVERS ) && count( WP_REDIS_SERVERS ) > 1 ) { throw new Exception( - 'Multipe sentinel servers are not supported by the bundled Credis library. Please review your Redis Cache configurations.' + 'Multipe sentinel servers are not supported by the bundled Credis library. Please review your Redis Cache configuration.' ); } From 5a0dc13f83185f08c765bce638923e43adf6c74f Mon Sep 17 00:00:00 2001 From: naxvog Date: Sat, 15 Aug 2020 22:49:44 +0200 Subject: [PATCH 70/93] use `wp_parse_url` for better compatibility --- includes/object-cache.php | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/includes/object-cache.php b/includes/object-cache.php index 006a1b70..593191a3 100644 --- a/includes/object-cache.php +++ b/includes/object-cache.php @@ -746,7 +746,7 @@ protected function connect_using_credis( $parameters ) { $clients = $is_cluster ? WP_REDIS_CLUSTER : WP_REDIS_SERVERS; foreach ( $clients as $index => &$connection_string ) { - $url_components = parse_url( $connection_string ); + $url_components = wp_parse_url( $connection_string ); parse_str( $url_components['query'], $add_params ); if ( ! $is_cluster && isset( $add_params['alias'] ) ) { From aa2db7c77316ea18625a12130d647620199bc5e4 Mon Sep 17 00:00:00 2001 From: naxvog Date: Sat, 15 Aug 2020 22:50:41 +0200 Subject: [PATCH 71/93] strict comparisons --- includes/object-cache.php | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/includes/object-cache.php b/includes/object-cache.php index 593191a3..b8fc8ea9 100644 --- a/includes/object-cache.php +++ b/includes/object-cache.php @@ -1004,7 +1004,7 @@ protected function add_or_replace( $add, $key, $value, $group = 'default', $expi $exists = isset( $this->cache[ $derived_key ] ); - if ( $add == $exists ) { + if ( (bool) $add === $exists ) { return false; } @@ -1925,7 +1925,7 @@ protected function is_serialized( $data, $strict = true ) { $data = trim( $data ); - if ( 'N;' == $data ) { + if ( 'N;' === $data ) { return true; } From c418f3d93f2b0323a67631db87e5f4f34c7764ab Mon Sep 17 00:00:00 2001 From: naxvog Date: Sat, 15 Aug 2020 22:56:14 +0200 Subject: [PATCH 72/93] fixed formatting --- includes/object-cache.php | 24 +++++++++++++++--------- 1 file changed, 15 insertions(+), 9 deletions(-) diff --git a/includes/object-cache.php b/includes/object-cache.php index b8fc8ea9..94b373ca 100644 --- a/includes/object-cache.php +++ b/includes/object-cache.php @@ -619,7 +619,6 @@ protected function connect_using_predis( $parameters ) { defined( 'WP_PLUGIN_DIR' ) ? WP_PLUGIN_DIR : WP_CONTENT_DIR . '/plugins' ); - if ( is_readable( $predis ) ) { require_once $predis; } else { @@ -1385,9 +1384,12 @@ public function get_multiple( $keys, $group = 'default', $force = false ) { } } - $remaining_keys = array_filter( $keys, function ( $key ) use ( $cache ) { - return ! isset( $cache[ $key ] ); - } ); + $remaining_keys = array_filter( + $keys, + function ( $key ) use ( $cache ) { + return ! isset( $cache[ $key ] ); + } + ); if ( empty( $remaining_keys ) ) { return $cache; @@ -1396,9 +1398,12 @@ public function get_multiple( $keys, $group = 'default', $force = false ) { $start_time = microtime( true ); try { - $remaining_ids = array_map( function ( $key ) use ( $derived_keys ) { - return $derived_keys[ $key ]; - }, $remaining_keys ); + $remaining_ids = array_map( + function ( $key ) use ( $derived_keys ) { + return $derived_keys[ $key ]; + }, + $remaining_keys + ); $results = array_combine( $remaining_keys, @@ -1603,7 +1608,8 @@ function ( $key ) { $this->cache ); - ?>

+ ?> +

Redis Status: redis_status() ? 'Connected' : 'Not connected'; ?>
@@ -2021,6 +2027,6 @@ protected function handle_exception( $exception ) { * @return mixed */ public function __get( $name ) { - return isset($this->{$name}) ? $this->{$name} : null; + return isset( $this->{$name} ) ? $this->{$name} : null; } } From 698a30f461c5ad60255573b07470d2880d0b7b2c Mon Sep 17 00:00:00 2001 From: naxvog Date: Sat, 15 Aug 2020 22:52:40 +0200 Subject: [PATCH 73/93] fixed wrong return type --- includes/object-cache.php | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/includes/object-cache.php b/includes/object-cache.php index 94b373ca..8c86c6e5 100644 --- a/includes/object-cache.php +++ b/includes/object-cache.php @@ -1597,7 +1597,7 @@ public function decrement( $key, $offset = 1, $group = 'default' ) { /** * Render data about current cache requests * - * @return string + * @return void */ public function stats() { $bytes = array_map( From de709aa2e9011522d812818eb312490c6583cd9e Mon Sep 17 00:00:00 2001 From: naxvog Date: Sat, 15 Aug 2020 22:53:02 +0200 Subject: [PATCH 74/93] output sanitization --- includes/object-cache.php | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/includes/object-cache.php b/includes/object-cache.php index 8c86c6e5..b0496c8b 100644 --- a/includes/object-cache.php +++ b/includes/object-cache.php @@ -1617,10 +1617,10 @@ function ( $key ) { diagnostics['client'] ?: 'Unknown'; ?>
Cache Hits: - cache_hits; ?> + cache_hits ); ?>
Cache Misses: - cache_misses; ?> + cache_misses ); ?>
Cache Size: kB From 2c574a7fe4c446a23a6154947da2bd0eb7e26e17 Mon Sep 17 00:00:00 2001 From: naxvog Date: Sat, 15 Aug 2020 22:54:32 +0200 Subject: [PATCH 75/93] removed unnecessary php version checks for <= 5.6 --- includes/object-cache.php | 10 ---------- 1 file changed, 10 deletions(-) diff --git a/includes/object-cache.php b/includes/object-cache.php index b0496c8b..c8eacc82 100644 --- a/includes/object-cache.php +++ b/includes/object-cache.php @@ -607,11 +607,6 @@ protected function connect_using_phpredis( $parameters ) { protected function connect_using_predis( $parameters ) { $client = 'Predis'; - // Require PHP 5.4 or greater - if ( version_compare( PHP_VERSION, '5.4.0', '<' ) ) { - throw new Exception( 'Predis requires PHP 5.4 or newer.' ); - } - // Load bundled Predis library. if ( ! class_exists( 'Predis\Client' ) ) { $predis = sprintf( @@ -682,11 +677,6 @@ protected function connect_using_predis( $parameters ) { protected function connect_using_credis( $parameters ) { $client = 'Credis'; - // Require PHP 5.4 or greater - if ( version_compare( PHP_VERSION, '5.4.0', '<' ) ) { - throw new Exception( 'Predis requires PHP 5.4 or newer.' ); - } - $creds_path = sprintf( '%s/redis-cache/dependencies/colinmollenhour/credis/', defined( 'WP_PLUGIN_DIR' ) ? WP_PLUGIN_DIR : WP_CONTENT_DIR . '/plugins' From 28246dc09d1a9770c97fd3e23878e57250ae8b82 Mon Sep 17 00:00:00 2001 From: naxvog Date: Sun, 16 Aug 2020 00:07:52 +0200 Subject: [PATCH 76/93] :facepalm: unfumbled the WP_REDIS_DISABLED check of the drop-in --- includes/object-cache.php | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/includes/object-cache.php b/includes/object-cache.php index c8eacc82..57176f77 100644 --- a/includes/object-cache.php +++ b/includes/object-cache.php @@ -14,7 +14,7 @@ defined( '\\ABSPATH' ) || exit; -if ( ! defined( 'WP_REDIS_DISABLED' ) || ! WP_REDIS_DISABLED ) { +if ( defined( 'WP_REDIS_DISABLED' ) && WP_REDIS_DISABLED ) { return; } From 1a48aaed00ee08f7ddbacacf61d20c1669476c83 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Till=20Kr=C3=BCss?= Date: Sat, 15 Aug 2020 14:50:03 -0700 Subject: [PATCH 77/93] extra line --- assets/js/admin.js | 1 + 1 file changed, 1 insertion(+) diff --git a/assets/js/admin.js b/assets/js/admin.js index 760a36f6..028ed5ef 100644 --- a/assets/js/admin.js +++ b/assets/js/admin.js @@ -450,6 +450,7 @@ event.preventDefault(); var $parent = $( this ).parent(); + $.post( ajaxurl, { notice: $parent.data( 'dismissible' ), action: 'roc_dismiss_notice', From 2bed259f7901a913bbd12c24178b3bb0268a3406 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Till=20Kr=C3=BCss?= Date: Sat, 15 Aug 2020 14:53:58 -0700 Subject: [PATCH 78/93] extra line --- includes/class-plugin.php | 1 + 1 file changed, 1 insertion(+) diff --git a/includes/class-plugin.php b/includes/class-plugin.php index 7a986715..7a8a8b63 100644 --- a/includes/class-plugin.php +++ b/includes/class-plugin.php @@ -1076,6 +1076,7 @@ public function on_deactivation( $plugin ) { if ( WP_REDIS_BASENAME === $plugin ) { $timestamp = wp_next_scheduled( 'rediscache_discard_metrics' ); + if ( $timestamp ) { wp_unschedule_event( $timestamp, 'rediscache_discard_metrics' ); } From bf62405e20da00c0377f1c7d51d370a306b9b8ef Mon Sep 17 00:00:00 2001 From: naxvog Date: Sun, 16 Aug 2020 00:12:51 +0200 Subject: [PATCH 79/93] simplified password obfuscation --- includes/ui/tabs/overview.php | 7 +------ 1 file changed, 1 insertion(+), 6 deletions(-) diff --git a/includes/ui/tabs/overview.php b/includes/ui/tabs/overview.php index 9c15348b..eb3bd2a8 100644 --- a/includes/ui/tabs/overview.php +++ b/includes/ui/tabs/overview.php @@ -160,12 +160,7 @@ - - - + •••••••• From 261b52c2c20097f7e5f2901e12964dac993cb601 Mon Sep 17 00:00:00 2001 From: naxvog Date: Sun, 16 Aug 2020 00:18:17 +0200 Subject: [PATCH 80/93] dropped output sanitization for static comment --- includes/class-plugin.php | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/includes/class-plugin.php b/includes/class-plugin.php index 7a8a8b63..b662950d 100644 --- a/includes/class-plugin.php +++ b/includes/class-plugin.php @@ -925,7 +925,8 @@ public function maybe_print_comment() { ); if ( ! WP_DEBUG ) { - printf( "\n\n", esc_html( $message ) ); + // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped + printf( "\n\n", $message ); return; } @@ -941,7 +942,11 @@ function_exists( 'size_format' ) ? size_format( $bytes ) : "{$bytes} bytes", $wp_object_cache->diagnostics['client'] ); - printf( "\n", esc_html( $message ), esc_html( $debug ) ); + printf( + "\n", + $message, // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped + esc_html( $debug ) + ); } /** From 0370cbef48f7ceb2092ad482abfd8a1486147214 Mon Sep 17 00:00:00 2001 From: naxvog Date: Sun, 16 Aug 2020 00:58:58 +0200 Subject: [PATCH 81/93] resolved cache size calc issue + unified method --- includes/class-plugin.php | 1 - includes/object-cache.php | 8 +------- 2 files changed, 1 insertion(+), 8 deletions(-) diff --git a/includes/class-plugin.php b/includes/class-plugin.php index b662950d..f912e456 100644 --- a/includes/class-plugin.php +++ b/includes/class-plugin.php @@ -931,7 +931,6 @@ public function maybe_print_comment() { return; } - // TODO: find a better method to determine cache size as using `serialize` is discouraged. $bytes = strlen( serialize( $wp_object_cache->cache ) ); // phpcs:ignore WordPress.PHP.DiscouragedPHPFunctions.serialize_serialize $debug = sprintf( diff --git a/includes/object-cache.php b/includes/object-cache.php index 57176f77..b0e7bd8f 100644 --- a/includes/object-cache.php +++ b/includes/object-cache.php @@ -1590,13 +1590,7 @@ public function decrement( $key, $offset = 1, $group = 'default' ) { * @return void */ public function stats() { - $bytes = array_map( - function ( $key ) { - // phpcs:ignore WordPress.PHP.DiscouragedPHPFunctions.serialize_serialize - return strlen( serialize( $key ) ); - }, - $this->cache - ); + $bytes = strlen( serialize( $wp_object_cache->cache ) ); // phpcs:ignore WordPress.PHP.DiscouragedPHPFunctions.serialize_serialize ?>

From 0200fafe0c2d58e2dd534c8158ff6405f83ae569 Mon Sep 17 00:00:00 2001 From: naxvog Date: Sun, 16 Aug 2020 00:59:41 +0200 Subject: [PATCH 82/93] marked WP_Object_Cache::stats deprecated --- includes/object-cache.php | 1 + 1 file changed, 1 insertion(+) diff --git a/includes/object-cache.php b/includes/object-cache.php index b0e7bd8f..9aeca055 100644 --- a/includes/object-cache.php +++ b/includes/object-cache.php @@ -1587,6 +1587,7 @@ public function decrement( $key, $offset = 1, $group = 'default' ) { /** * Render data about current cache requests * + * @deprecated No longer used by the plugin. * @return void */ public function stats() { From aa449efb7b6dfbf9bb566930c6e73e8d71e77ec5 Mon Sep 17 00:00:00 2001 From: naxvog Date: Sun, 16 Aug 2020 01:02:36 +0200 Subject: [PATCH 83/93] Revert "yoda style conditions" This reverts commit b079844cd9863e3891cb80bebd5d117419b3f5d3. --- includes/object-cache.php | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/includes/object-cache.php b/includes/object-cache.php index 9aeca055..08210142 100644 --- a/includes/object-cache.php +++ b/includes/object-cache.php @@ -505,7 +505,7 @@ protected function build_parameters() { if ( isset( $parameters['password'] ) ) { $password = $parameters['password']; - if ( is_null( $password ) || '' === $password ) { + if ( is_null( $password ) || $password === '' ) { unset( $parameters['password'] ); } } @@ -756,7 +756,7 @@ protected function connect_using_credis( $parameters ) { $args['servers'] = $clients; } else { $args = [ - 'host' => 'unix' === $parameters['scheme'] ? $parameters['path'] : $parameters['host'], + 'host' => $parameters['scheme'] === 'unix' ? $parameters['path'] : $parameters['host'], 'port' => $parameters['port'], 'timeout' => $parameters['timeout'], 'persistent' => null, @@ -1305,7 +1305,7 @@ public function get( $key, $group = 'default', $force = false, &$found = null ) $this->cache_calls++; $this->cache_time += $execute_time; - if ( null === $result || false === $result ) { + if ( $result === null || $result === false ) { $found = false; $this->cache_misses++; @@ -1355,7 +1355,7 @@ public function get_multiple( $keys, $group = 'default', $force = false ) { if ( $this->is_ignored_group( $group ) || ! $this->redis_status() ) { foreach ( $keys as $key ) { $cache[ $key ] = $this->get_from_internal_cache( $derived_keys[ $key ] ); - false === $cache[ $key ] ? $this->cache_misses++ : $this->cache_hits++; + $cache[ $key ] === false ? $this->cache_misses++ : $this->cache_hits++; } return $cache; @@ -1365,7 +1365,7 @@ public function get_multiple( $keys, $group = 'default', $force = false ) { foreach ( $keys as $key ) { $value = $this->get_from_internal_cache( $derived_keys[ $key ] ); - if ( false === $value ) { + if ( $value === false ) { $this->cache_misses++; } else { $cache[ $key ] = $value; @@ -1411,7 +1411,7 @@ function ( $key ) use ( $derived_keys ) { $this->cache_time += $execute_time; foreach ( $results as $key => $value ) { - if ( null === $value || false === $value ) { + if ( $value === null || $value === false ) { $cache[ $key ] = false; $this->cache_misses++; } else { @@ -1832,7 +1832,7 @@ protected function validate_expiration( $expiration ) { if ( defined( 'WP_REDIS_MAXTTL' ) ) { $max = (int) WP_REDIS_MAXTTL; - if ( 0 === $expiration || $expiration > $max ) { + if ( $expiration === 0 || $expiration > $max ) { $expiration = $max; } } From ebb7f1fe134eab03ff8f677e1582d11b4a1bfbfe Mon Sep 17 00:00:00 2001 From: naxvog Date: Sun, 16 Aug 2020 01:03:22 +0200 Subject: [PATCH 84/93] Revert "yoda style conditions" This reverts commit a7c2928b0aaff425ae7f9d731b991b182ee67894. --- includes/class-plugin.php | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/includes/class-plugin.php b/includes/class-plugin.php index f912e456..f53b24a5 100644 --- a/includes/class-plugin.php +++ b/includes/class-plugin.php @@ -603,7 +603,7 @@ public function do_admin_actions() { if ( in_array( $action, $this->actions, true ) ) { $url = $this->action_link( $action ); - if ( 'flush-cache' === $action ) { + if ( $action === 'flush-cache' ) { wp_cache_flush() ? add_settings_error( 'redis-cache', @@ -622,7 +622,7 @@ public function do_admin_actions() { // do we have filesystem credentials? if ( $this->initialize_filesystem( $url, true ) ) { - if ( 'enable-cache' === $action ) { + if ( $action === 'enable-cache' ) { $result = $wp_filesystem->copy( WP_REDIS_PLUGIN_PATH . '/includes/object-cache.php', WP_CONTENT_DIR . '/object-cache.php', @@ -647,7 +647,7 @@ public function do_admin_actions() { ); } - if ( 'disable-cache' === $action ) { + if ( $action === 'disable-cache' ) { $result = $wp_filesystem->delete( WP_CONTENT_DIR . '/object-cache.php' ); do_action( 'redis_object_cache_disable', $result ); @@ -667,7 +667,7 @@ public function do_admin_actions() { ); } - if ( 'update-dropin' === $action ) { + if ( $action === 'update-dropin' ) { $result = $wp_filesystem->copy( WP_REDIS_PLUGIN_PATH . '/includes/object-cache.php', WP_CONTENT_DIR . '/object-cache.php', @@ -1017,7 +1017,7 @@ public function test_filesystem_writing() { $meta = get_file_data( $testfile, [ 'Version' => 'Version' ] ); - if ( WP_REDIS_VERSION !== $meta['Version'] ) { + if ( $meta['Version'] !== WP_REDIS_VERSION ) { return new WP_Error( 'version', __( 'Couldn’t verify test file contents.', 'redis-cache' ) ); } @@ -1078,7 +1078,7 @@ public function on_deactivation( $plugin ) { ob_start(); - if ( WP_REDIS_BASENAME === $plugin ) { + if ( $plugin === WP_REDIS_BASENAME ) { $timestamp = wp_next_scheduled( 'rediscache_discard_metrics' ); if ( $timestamp ) { From ef1ea74129e09bf4979d9be771b4548f10937481 Mon Sep 17 00:00:00 2001 From: naxvog Date: Sun, 16 Aug 2020 01:06:45 +0200 Subject: [PATCH 85/93] removed yoda style condition checks from phpcs ruleset --- phpcs.xml | 1 + 1 file changed, 1 insertion(+) diff --git a/phpcs.xml b/phpcs.xml index 45832e8c..9bd6882a 100644 --- a/phpcs.xml +++ b/phpcs.xml @@ -18,6 +18,7 @@ + From 9de3854313006a86e950c8256001e78a412445b4 Mon Sep 17 00:00:00 2001 From: naxvog Date: Sun, 16 Aug 2020 01:31:53 +0200 Subject: [PATCH 86/93] reverted deprecation and added explanation --- includes/object-cache.php | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/includes/object-cache.php b/includes/object-cache.php index 08210142..2f0805a7 100644 --- a/includes/object-cache.php +++ b/includes/object-cache.php @@ -1586,8 +1586,8 @@ public function decrement( $key, $offset = 1, $group = 'default' ) { /** * Render data about current cache requests + * Used by the Debug bar plugin * - * @deprecated No longer used by the plugin. * @return void */ public function stats() { From 49b05b445ace12a3dafcf5727ac035b7b6f28e95 Mon Sep 17 00:00:00 2001 From: naxvog Date: Sun, 16 Aug 2020 02:26:03 +0200 Subject: [PATCH 87/93] reverted WP_REDIS_DISABLED shorthand --- includes/object-cache.php | 3132 ++++++++++++++++++------------------- 1 file changed, 1566 insertions(+), 1566 deletions(-) diff --git a/includes/object-cache.php b/includes/object-cache.php index 2f0805a7..db3304fd 100644 --- a/includes/object-cache.php +++ b/includes/object-cache.php @@ -14,1172 +14,1170 @@ defined( '\\ABSPATH' ) || exit; -if ( defined( 'WP_REDIS_DISABLED' ) && WP_REDIS_DISABLED ) { - return; -} - -/** - * Adds a value to cache. - * - * If the specified key already exists, the value is not stored and the function - * returns false. - * - * @param string $key The key under which to store the value. - * @param mixed $value The value to store. - * @param string $group The group value appended to the $key. - * @param int $expiration The expiration time, defaults to 0. - * - * @return bool Returns TRUE on success or FALSE on failure. - */ -function wp_cache_add( $key, $value, $group = '', $expiration = 0 ) { - global $wp_object_cache; - - return $wp_object_cache->add( $key, $value, $group, $expiration ); -} - -/** - * Closes the cache. - * - * This function has ceased to do anything since WordPress 2.5. The - * functionality was removed along with the rest of the persistent cache. This - * does not mean that plugins can't implement this function when they need to - * make sure that the cache is cleaned up after WordPress no longer needs it. - * - * @return bool Always returns True - */ -function wp_cache_close() { - return true; -} - -/** - * Decrement a numeric item's value. - * - * @param string $key The key under which to store the value. - * @param int $offset The amount by which to decrement the item's value. - * @param string $group The group value appended to the $key. - * - * @return int|bool Returns item's new value on success or FALSE on failure. - */ -function wp_cache_decr( $key, $offset = 1, $group = '' ) { - global $wp_object_cache; - - return $wp_object_cache->decrement( $key, $offset, $group ); -} - -/** - * Remove the item from the cache. - * - * @param string $key The key under which to store the value. - * @param string $group The group value appended to the $key. - * @param int $time The amount of time the server will wait to delete the item in seconds. - * - * @return bool Returns TRUE on success or FALSE on failure. - */ -function wp_cache_delete( $key, $group = '', $time = 0 ) { - global $wp_object_cache; - - return $wp_object_cache->delete( $key, $group, $time ); -} - -/** - * Invalidate all items in the cache. If `WP_REDIS_SELECTIVE_FLUSH` is `true`, - * only keys prefixed with the `WP_REDIS_PREFIX` are flushed. - * - * @param int $delay Number of seconds to wait before invalidating the items. - * - * @return bool Returns TRUE on success or FALSE on failure. - */ -function wp_cache_flush( $delay = 0 ) { - global $wp_object_cache; - - return $wp_object_cache->flush( $delay ); -} - -/** - * Retrieve object from cache. - * - * Gets an object from cache based on $key and $group. - * - * @param string $key The key under which to store the value. - * @param string $group The group value appended to the $key. - * @param bool $force Optional. Whether to force an update of the local cache from the persistent - * cache. Default false. - * @param bool $found Optional. Whether the key was found in the cache. Disambiguates a return of false, - * a storable value. Passed by reference. Default null. - * - * @return bool|mixed Cached object value. - */ -function wp_cache_get( $key, $group = '', $force = false, &$found = null ) { - global $wp_object_cache; - - return $wp_object_cache->get( $key, $group, $force, $found ); -} - -/** - * Retrieves multiple values from the cache in one call. - * - * @param array $keys Array of keys under which the cache contents are stored. - * @param string $group Optional. Where the cache contents are grouped. Default empty. - * @param bool $force Optional. Whether to force an update of the local cache - * from the persistent cache. Default false. - * @return array Array of values organized into groups. - */ -function wp_cache_get_multiple( $keys, $group = '', $force = false ) { - global $wp_object_cache; - - return $wp_object_cache->get_multiple( $keys, $group, $force ); -} - -/** - * Increment a numeric item's value. - * - * @param string $key The key under which to store the value. - * @param int $offset The amount by which to increment the item's value. - * @param string $group The group value appended to the $key. - * - * @return int|bool Returns item's new value on success or FALSE on failure. - */ -function wp_cache_incr( $key, $offset = 1, $group = '' ) { - global $wp_object_cache; - - return $wp_object_cache->increment( $key, $offset, $group ); -} - -/** - * Sets up Object Cache Global and assigns it. - * - * @return void - */ -function wp_cache_init() { - global $wp_object_cache; - - // Backwards compatibility: map `WP_CACHE_KEY_SALT` constant to `WP_REDIS_PREFIX`. - if ( defined( 'WP_CACHE_KEY_SALT' ) && ! defined( 'WP_REDIS_PREFIX' ) ) { - define( 'WP_REDIS_PREFIX', WP_CACHE_KEY_SALT ); - } - - if ( ! ( $wp_object_cache instanceof WP_Object_Cache ) ) { - $fail_gracefully = ! defined( 'WP_REDIS_GRACEFUL' ) || WP_REDIS_GRACEFUL; - - // We need to override this WordPress global in order to inject our cache. - // phpcs:ignore WordPress.WP.GlobalVariablesOverride.Prohibited - $wp_object_cache = new WP_Object_Cache( $fail_gracefully ); - } -} - -/** - * Replaces a value in cache. - * - * This method is similar to "add"; however, is does not successfully set a value if - * the object's key is not already set in cache. - * - * @param string $key The key under which to store the value. - * @param mixed $value The value to store. - * @param string $group The group value appended to the $key. - * @param int $expiration The expiration time, defaults to 0. - * - * @return bool Returns TRUE on success or FALSE on failure. - */ -function wp_cache_replace( $key, $value, $group = '', $expiration = 0 ) { - global $wp_object_cache; - - return $wp_object_cache->replace( $key, $value, $group, $expiration ); -} - -/** - * Sets a value in cache. - * - * The value is set whether or not this key already exists in Redis. - * - * @param string $key The key under which to store the value. - * @param mixed $value The value to store. - * @param string $group The group value appended to the $key. - * @param int $expiration The expiration time, defaults to 0. - * - * @return bool Returns TRUE on success or FALSE on failure. - */ -function wp_cache_set( $key, $value, $group = '', $expiration = 0 ) { - global $wp_object_cache; - - return $wp_object_cache->set( $key, $value, $group, $expiration ); -} - -/** - * Switch the internal blog id. - * - * This changes the blog id used to create keys in blog specific groups. - * - * @param int $_blog_id The blog ID. - * - * @return bool - */ -function wp_cache_switch_to_blog( $_blog_id ) { - global $wp_object_cache; - - return $wp_object_cache->switch_to_blog( $_blog_id ); -} - -/** - * Adds a group or set of groups to the list of Redis groups. - * - * @param string|array $groups A group or an array of groups to add. - * - * @return void - */ -function wp_cache_add_global_groups( $groups ) { - global $wp_object_cache; - - $wp_object_cache->add_global_groups( $groups ); -} - -/** - * Adds a group or set of groups to the list of non-Redis groups. - * - * @param string|array $groups A group or an array of groups to add. - * - * @return void - */ -function wp_cache_add_non_persistent_groups( $groups ) { - global $wp_object_cache; - - $wp_object_cache->add_non_persistent_groups( $groups ); -} - -/** - * Object cache class definition - */ -class WP_Object_Cache { +if ( ! defined( 'WP_REDIS_DISABLED' ) || ! WP_REDIS_DISABLED ) : /** - * The Redis client. + * Adds a value to cache. * - * @var mixed - */ - private $redis; - - /** - * The Redis server version. + * If the specified key already exists, the value is not stored and the function + * returns false. * - * @var null|string - */ - private $redis_version = null; - - /** - * Track if Redis is available. + * @param string $key The key under which to store the value. + * @param mixed $value The value to store. + * @param string $group The group value appended to the $key. + * @param int $expiration The expiration time, defaults to 0. * - * @var bool + * @return bool Returns TRUE on success or FALSE on failure. */ - private $redis_connected = false; + function wp_cache_add( $key, $value, $group = '', $expiration = 0 ) { + global $wp_object_cache; - /** - * Check to fail gracefully or throw an exception. - * - * @var bool - */ - private $fail_gracefully = true; + return $wp_object_cache->add( $key, $value, $group, $expiration ); + } /** - * Holds the non-Redis objects. + * Closes the cache. * - * @var array - */ - public $cache = array(); - - /** - * Holds the diagnostics values. + * This function has ceased to do anything since WordPress 2.5. The + * functionality was removed along with the rest of the persistent cache. This + * does not mean that plugins can't implement this function when they need to + * make sure that the cache is cleaned up after WordPress no longer needs it. * - * @var array + * @return bool Always returns True */ - public $diagnostics = null; + function wp_cache_close() { + return true; + } /** - * Holds the error messages. + * Decrement a numeric item's value. + * + * @param string $key The key under which to store the value. + * @param int $offset The amount by which to decrement the item's value. + * @param string $group The group value appended to the $key. * - * @var array + * @return int|bool Returns item's new value on success or FALSE on failure. */ - public $errors = array(); + function wp_cache_decr( $key, $offset = 1, $group = '' ) { + global $wp_object_cache; + + return $wp_object_cache->decrement( $key, $offset, $group ); + } /** - * List of global groups. + * Remove the item from the cache. + * + * @param string $key The key under which to store the value. + * @param string $group The group value appended to the $key. + * @param int $time The amount of time the server will wait to delete the item in seconds. * - * @var array + * @return bool Returns TRUE on success or FALSE on failure. */ - public $global_groups = array( - 'blog-details', - 'blog-id-cache', - 'blog-lookup', - 'global-posts', - 'networks', - 'rss', - 'sites', - 'site-details', - 'site-lookup', - 'site-options', - 'site-transient', - 'users', - 'useremail', - 'userlogins', - 'usermeta', - 'user_meta', - 'userslugs', - ); + function wp_cache_delete( $key, $group = '', $time = 0 ) { + global $wp_object_cache; + + return $wp_object_cache->delete( $key, $group, $time ); + } /** - * List of groups that will not be flushed. + * Invalidate all items in the cache. If `WP_REDIS_SELECTIVE_FLUSH` is `true`, + * only keys prefixed with the `WP_REDIS_PREFIX` are flushed. + * + * @param int $delay Number of seconds to wait before invalidating the items. * - * @var array + * @return bool Returns TRUE on success or FALSE on failure. */ - public $unflushable_groups = array(); + function wp_cache_flush( $delay = 0 ) { + global $wp_object_cache; + + return $wp_object_cache->flush( $delay ); + } /** - * List of groups not saved to Redis. + * Retrieve object from cache. + * + * Gets an object from cache based on $key and $group. + * + * @param string $key The key under which to store the value. + * @param string $group The group value appended to the $key. + * @param bool $force Optional. Whether to force an update of the local cache from the persistent + * cache. Default false. + * @param bool $found Optional. Whether the key was found in the cache. Disambiguates a return of false, + * a storable value. Passed by reference. Default null. * - * @var array + * @return bool|mixed Cached object value. */ - public $ignored_groups = array( - 'counts', - 'plugins', - 'themes', - ); + function wp_cache_get( $key, $group = '', $force = false, &$found = null ) { + global $wp_object_cache; + + return $wp_object_cache->get( $key, $group, $force, $found ); + } /** - * Prefix used for global groups. + * Retrieves multiple values from the cache in one call. * - * @var string + * @param array $keys Array of keys under which the cache contents are stored. + * @param string $group Optional. Where the cache contents are grouped. Default empty. + * @param bool $force Optional. Whether to force an update of the local cache + * from the persistent cache. Default false. + * @return array Array of values organized into groups. */ - public $global_prefix = ''; + function wp_cache_get_multiple( $keys, $group = '', $force = false ) { + global $wp_object_cache; + + return $wp_object_cache->get_multiple( $keys, $group, $force ); + } /** - * Prefix used for non-global groups. + * Increment a numeric item's value. + * + * @param string $key The key under which to store the value. + * @param int $offset The amount by which to increment the item's value. + * @param string $group The group value appended to the $key. * - * @var string + * @return int|bool Returns item's new value on success or FALSE on failure. */ - public $blog_prefix = ''; + function wp_cache_incr( $key, $offset = 1, $group = '' ) { + global $wp_object_cache; + + return $wp_object_cache->increment( $key, $offset, $group ); + } /** - * Track how many requests were found in cache. + * Sets up Object Cache Global and assigns it. * - * @var int + * @return void */ - public $cache_hits = 0; + function wp_cache_init() { + global $wp_object_cache; + + // Backwards compatibility: map `WP_CACHE_KEY_SALT` constant to `WP_REDIS_PREFIX`. + if ( defined( 'WP_CACHE_KEY_SALT' ) && ! defined( 'WP_REDIS_PREFIX' ) ) { + define( 'WP_REDIS_PREFIX', WP_CACHE_KEY_SALT ); + } + + if ( ! ( $wp_object_cache instanceof WP_Object_Cache ) ) { + $fail_gracefully = ! defined( 'WP_REDIS_GRACEFUL' ) || WP_REDIS_GRACEFUL; + + // We need to override this WordPress global in order to inject our cache. + // phpcs:ignore WordPress.WP.GlobalVariablesOverride.Prohibited + $wp_object_cache = new WP_Object_Cache( $fail_gracefully ); + } + } /** - * Track how may requests were not cached. + * Replaces a value in cache. * - * @var int + * This method is similar to "add"; however, is does not successfully set a value if + * the object's key is not already set in cache. + * + * @param string $key The key under which to store the value. + * @param mixed $value The value to store. + * @param string $group The group value appended to the $key. + * @param int $expiration The expiration time, defaults to 0. + * + * @return bool Returns TRUE on success or FALSE on failure. */ - public $cache_misses = 0; + function wp_cache_replace( $key, $value, $group = '', $expiration = 0 ) { + global $wp_object_cache; + + return $wp_object_cache->replace( $key, $value, $group, $expiration ); + } /** - * Track how long request took. + * Sets a value in cache. + * + * The value is set whether or not this key already exists in Redis. + * + * @param string $key The key under which to store the value. + * @param mixed $value The value to store. + * @param string $group The group value appended to the $key. + * @param int $expiration The expiration time, defaults to 0. * - * @var int + * @return bool Returns TRUE on success or FALSE on failure. */ - public $cache_time = 0; + function wp_cache_set( $key, $value, $group = '', $expiration = 0 ) { + global $wp_object_cache; + + return $wp_object_cache->set( $key, $value, $group, $expiration ); + } /** - * Track how may calls were made. + * Switch the internal blog id. + * + * This changes the blog id used to create keys in blog specific groups. * - * @var int + * @param int $_blog_id The blog ID. + * + * @return bool */ - public $cache_calls = 0; + function wp_cache_switch_to_blog( $_blog_id ) { + global $wp_object_cache; + + return $wp_object_cache->switch_to_blog( $_blog_id ); + } /** - * Instantiate the Redis class. + * Adds a group or set of groups to the list of Redis groups. + * + * @param string|array $groups A group or an array of groups to add. * - * @param bool $fail_gracefully Handles and logs errors if true throws exceptions otherwise. + * @return void */ - public function __construct( $fail_gracefully = true ) { - global $blog_id, $table_prefix; - - $this->fail_gracefully = $fail_gracefully; - - if ( defined( 'WP_REDIS_GLOBAL_GROUPS' ) && is_array( WP_REDIS_GLOBAL_GROUPS ) ) { - $this->global_groups = array_map( [ $this, 'sanitize_key_part' ], WP_REDIS_GLOBAL_GROUPS ); - } - - if ( defined( 'WP_REDIS_IGNORED_GROUPS' ) && is_array( WP_REDIS_IGNORED_GROUPS ) ) { - $this->ignored_groups = array_map( [ $this, 'sanitize_key_part' ], WP_REDIS_IGNORED_GROUPS ); - } - - if ( defined( 'WP_REDIS_UNFLUSHABLE_GROUPS' ) && is_array( WP_REDIS_UNFLUSHABLE_GROUPS ) ) { - $this->unflushable_groups = array_map( [ $this, 'sanitize_key_part' ], WP_REDIS_UNFLUSHABLE_GROUPS ); - } - - $client = $this->determine_client(); - $parameters = $this->build_parameters(); - - try { - switch ( $client ) { - case 'hhvm': - $this->connect_using_hhvm( $parameters ); - break; - case 'phpredis': - $this->connect_using_phpredis( $parameters ); - break; - case 'credis': - $this->connect_using_credis( $parameters ); - break; - case 'predis': - default: - $this->connect_using_predis( $parameters ); - break; - } - - if ( defined( 'WP_REDIS_CLUSTER' ) ) { - $this->diagnostics[ 'ping' ] = $this->redis->ping( current( array_values( WP_REDIS_CLUSTER ) ) ); - } else { - $this->diagnostics[ 'ping' ] = $this->redis->ping(); - } + function wp_cache_add_global_groups( $groups ) { + global $wp_object_cache; - $this->fetch_info(); - - $this->redis_connected = true; - } catch ( Exception $exception ) { - $this->handle_exception( $exception ); - } - - // Assign global and blog prefixes for use with keys. - if ( function_exists( 'is_multisite' ) ) { - $this->global_prefix = is_multisite() ? '' : $table_prefix; - $this->blog_prefix = is_multisite() ? $blog_id : $table_prefix; - } + $wp_object_cache->add_global_groups( $groups ); } /** - * Determine the Redis client. + * Adds a group or set of groups to the list of non-Redis groups. + * + * @param string|array $groups A group or an array of groups to add. * - * @return string + * @return void */ - protected function determine_client() { - $client = 'predis'; + function wp_cache_add_non_persistent_groups( $groups ) { + global $wp_object_cache; - if ( class_exists( 'Redis' ) ) { - $client = defined( 'HHVM_VERSION' ) ? 'hhvm' : 'phpredis'; - } - - if ( defined( 'WP_REDIS_CLIENT' ) ) { - $client = (string) WP_REDIS_CLIENT; - $client = str_replace( 'pecl', 'phpredis', $client ); - } - - return trim( strtolower( $client ) ); + $wp_object_cache->add_non_persistent_groups( $groups ); } /** - * Build the connection parameters from config constants. - * - * @return array + * Object cache class definition */ - protected function build_parameters() { - $parameters = array( - 'scheme' => 'tcp', - 'host' => '127.0.0.1', - 'port' => 6379, - 'database' => 0, - 'timeout' => 1, - 'read_timeout' => 1, - 'retry_interval' => null, + class WP_Object_Cache { + + /** + * The Redis client. + * + * @var mixed + */ + private $redis; + + /** + * The Redis server version. + * + * @var null|string + */ + private $redis_version = null; + + /** + * Track if Redis is available. + * + * @var bool + */ + private $redis_connected = false; + + /** + * Check to fail gracefully or throw an exception. + * + * @var bool + */ + private $fail_gracefully = true; + + /** + * Holds the non-Redis objects. + * + * @var array + */ + public $cache = array(); + + /** + * Holds the diagnostics values. + * + * @var array + */ + public $diagnostics = null; + + /** + * Holds the error messages. + * + * @var array + */ + public $errors = array(); + + /** + * List of global groups. + * + * @var array + */ + public $global_groups = array( + 'blog-details', + 'blog-id-cache', + 'blog-lookup', + 'global-posts', + 'networks', + 'rss', + 'sites', + 'site-details', + 'site-lookup', + 'site-options', + 'site-transient', + 'users', + 'useremail', + 'userlogins', + 'usermeta', + 'user_meta', + 'userslugs', ); - $settings = array( - 'scheme', - 'host', - 'port', - 'path', - 'password', - 'database', - 'timeout', - 'read_timeout', - 'retry_interval', + /** + * List of groups that will not be flushed. + * + * @var array + */ + public $unflushable_groups = array(); + + /** + * List of groups not saved to Redis. + * + * @var array + */ + public $ignored_groups = array( + 'counts', + 'plugins', + 'themes', ); - foreach ( $settings as $setting ) { - $constant = sprintf( 'WP_REDIS_%s', strtoupper( $setting ) ); - - if ( defined( $constant ) ) { - $parameters[ $setting ] = constant( $constant ); + /** + * Prefix used for global groups. + * + * @var string + */ + public $global_prefix = ''; + + /** + * Prefix used for non-global groups. + * + * @var string + */ + public $blog_prefix = ''; + + /** + * Track how many requests were found in cache. + * + * @var int + */ + public $cache_hits = 0; + + /** + * Track how may requests were not cached. + * + * @var int + */ + public $cache_misses = 0; + + /** + * Track how long request took. + * + * @var int + */ + public $cache_time = 0; + + /** + * Track how may calls were made. + * + * @var int + */ + public $cache_calls = 0; + + /** + * Instantiate the Redis class. + * + * @param bool $fail_gracefully Handles and logs errors if true throws exceptions otherwise. + */ + public function __construct( $fail_gracefully = true ) { + global $blog_id, $table_prefix; + + $this->fail_gracefully = $fail_gracefully; + + if ( defined( 'WP_REDIS_GLOBAL_GROUPS' ) && is_array( WP_REDIS_GLOBAL_GROUPS ) ) { + $this->global_groups = array_map( [ $this, 'sanitize_key_part' ], WP_REDIS_GLOBAL_GROUPS ); } - } - if ( isset( $parameters['password'] ) ) { - $password = $parameters['password']; + if ( defined( 'WP_REDIS_IGNORED_GROUPS' ) && is_array( WP_REDIS_IGNORED_GROUPS ) ) { + $this->ignored_groups = array_map( [ $this, 'sanitize_key_part' ], WP_REDIS_IGNORED_GROUPS ); + } - if ( is_null( $password ) || $password === '' ) { - unset( $parameters['password'] ); + if ( defined( 'WP_REDIS_UNFLUSHABLE_GROUPS' ) && is_array( WP_REDIS_UNFLUSHABLE_GROUPS ) ) { + $this->unflushable_groups = array_map( [ $this, 'sanitize_key_part' ], WP_REDIS_UNFLUSHABLE_GROUPS ); } - } - return $parameters; - } + $client = $this->determine_client(); + $parameters = $this->build_parameters(); - /** - * Connect to Redis using the PhpRedis (PECL) extention. - * - * @param array $parameters Connection parameters built by the `build_parameters` method. - * @return void - */ - protected function connect_using_phpredis( $parameters ) { - $version = phpversion( 'redis' ); - - $this->diagnostics[ 'client' ] = sprintf( 'PhpRedis (v%s)', $version ); + try { + switch ( $client ) { + case 'hhvm': + $this->connect_using_hhvm( $parameters ); + break; + case 'phpredis': + $this->connect_using_phpredis( $parameters ); + break; + case 'credis': + $this->connect_using_credis( $parameters ); + break; + case 'predis': + default: + $this->connect_using_predis( $parameters ); + break; + } - if ( defined( 'WP_REDIS_SHARDS' ) ) { - $this->redis = new RedisArray( array_values( WP_REDIS_SHARDS ) ); + if ( defined( 'WP_REDIS_CLUSTER' ) ) { + $this->diagnostics[ 'ping' ] = $this->redis->ping( current( array_values( WP_REDIS_CLUSTER ) ) ); + } else { + $this->diagnostics[ 'ping' ] = $this->redis->ping(); + } - $this->diagnostics[ 'shards' ] = WP_REDIS_SHARDS; - } elseif ( defined( 'WP_REDIS_CLUSTER' ) ) { - $args = [ - 'cluster' => array_values( WP_REDIS_CLUSTER ), - 'timeout' => $parameters['timeout'], - 'read_timeout' => $parameters['read_timeout'], - ]; + $this->fetch_info(); - if ( isset( $parameters['password'] ) && version_compare( $version, '4.3.0', '>=' ) ) { - $args['password'] = $parameters['password']; + $this->redis_connected = true; + } catch ( Exception $exception ) { + $this->handle_exception( $exception ); } - $this->redis = new RedisCluster( null, ...array_values( $args ) ); - - $this->diagnostics += $args; - } else { - $this->redis = new Redis(); + // Assign global and blog prefixes for use with keys. + if ( function_exists( 'is_multisite' ) ) { + $this->global_prefix = is_multisite() ? '' : $table_prefix; + $this->blog_prefix = is_multisite() ? $blog_id : $table_prefix; + } + } - $args = [ - 'host' => $parameters['host'], - 'port' => $parameters['port'], - 'timeout' => $parameters['timeout'], - null, - 'retry_interval' => $parameters['retry_interval'], - ]; + /** + * Determine the Redis client. + * + * @return string + */ + protected function determine_client() { + $client = 'predis'; - if ( strcasecmp( 'tls', $parameters['scheme'] ) === 0 ) { - $args['host'] = sprintf( - '%s://%s', - $parameters['scheme'], - str_replace( 'tls://', '', $parameters['host'] ) - ); + if ( class_exists( 'Redis' ) ) { + $client = defined( 'HHVM_VERSION' ) ? 'hhvm' : 'phpredis'; } - if ( strcasecmp( 'unix', $parameters['scheme'] ) === 0 ) { - $args['host'] = $parameters['path']; - $args['port'] = null; + if ( defined( 'WP_REDIS_CLIENT' ) ) { + $client = (string) WP_REDIS_CLIENT; + $client = str_replace( 'pecl', 'phpredis', $client ); } - if ( version_compare( $version, '3.1.3', '>=' ) ) { - $args['read_timeout'] = $parameters['read_timeout']; - } + return trim( strtolower( $client ) ); + } + + /** + * Build the connection parameters from config constants. + * + * @return array + */ + protected function build_parameters() { + $parameters = array( + 'scheme' => 'tcp', + 'host' => '127.0.0.1', + 'port' => 6379, + 'database' => 0, + 'timeout' => 1, + 'read_timeout' => 1, + 'retry_interval' => null, + ); - call_user_func_array( [ $this->redis, 'connect' ], array_values( $args ) ); + $settings = array( + 'scheme', + 'host', + 'port', + 'path', + 'password', + 'database', + 'timeout', + 'read_timeout', + 'retry_interval', + ); - if ( isset( $parameters['password'] ) ) { - $args['password'] = $parameters['password']; - $this->redis->auth( $parameters['password'] ); - } + foreach ( $settings as $setting ) { + $constant = sprintf( 'WP_REDIS_%s', strtoupper( $setting ) ); - if ( isset( $parameters['database'] ) ) { - if ( ctype_digit( $parameters['database'] ) ) { - $parameters['database'] = intval( $parameters['database'] ); + if ( defined( $constant ) ) { + $parameters[ $setting ] = constant( $constant ); } + } - $args['database'] = $parameters['database']; + if ( isset( $parameters['password'] ) ) { + $password = $parameters['password']; - if ( $parameters['database'] ) { - $this->redis->select( $parameters['database'] ); + if ( is_null( $password ) || $password === '' ) { + unset( $parameters['password'] ); } } - $this->diagnostics += $args; + return $parameters; } - if ( defined( 'WP_REDIS_SERIALIZER' ) && ! empty( WP_REDIS_SERIALIZER ) ) { - $this->redis->setOption( Redis::OPT_SERIALIZER, WP_REDIS_SERIALIZER ); - } - } + /** + * Connect to Redis using the PhpRedis (PECL) extention. + * + * @param array $parameters Connection parameters built by the `build_parameters` method. + * @return void + */ + protected function connect_using_phpredis( $parameters ) { + $version = phpversion( 'redis' ); - /** - * Connect to Redis using the Predis library. - * - * @param array $parameters Connection parameters built by the `build_parameters` method. - * @throws \Exception If the Predis library was not found or is unreadable. - * @return void - */ - protected function connect_using_predis( $parameters ) { - $client = 'Predis'; + $this->diagnostics[ 'client' ] = sprintf( 'PhpRedis (v%s)', $version ); - // Load bundled Predis library. - if ( ! class_exists( 'Predis\Client' ) ) { - $predis = sprintf( - '%s/redis-cache/dependencies/predis/predis/autoload.php', - defined( 'WP_PLUGIN_DIR' ) ? WP_PLUGIN_DIR : WP_CONTENT_DIR . '/plugins' - ); + if ( defined( 'WP_REDIS_SHARDS' ) ) { + $this->redis = new RedisArray( array_values( WP_REDIS_SHARDS ) ); - if ( is_readable( $predis ) ) { - require_once $predis; - } else { - throw new Exception( - 'Predis library not found. Re-install Redis Cache plugin or delete the object-cache.php.' - ); - } - } + $this->diagnostics[ 'shards' ] = WP_REDIS_SHARDS; + } elseif ( defined( 'WP_REDIS_CLUSTER' ) ) { + $args = [ + 'cluster' => array_values( WP_REDIS_CLUSTER ), + 'timeout' => $parameters['timeout'], + 'read_timeout' => $parameters['read_timeout'], + ]; - $options = array(); - - if ( defined( 'WP_REDIS_SHARDS' ) ) { - $parameters = WP_REDIS_SHARDS; - } elseif ( defined( 'WP_REDIS_SENTINEL' ) ) { - $parameters = WP_REDIS_SERVERS; - $options['replication'] = 'sentinel'; - $options['service'] = WP_REDIS_SENTINEL; - } elseif ( defined( 'WP_REDIS_SERVERS' ) ) { - $parameters = WP_REDIS_SERVERS; - $options['replication'] = true; - } elseif ( defined( 'WP_REDIS_CLUSTER' ) ) { - $parameters = WP_REDIS_CLUSTER; - $options['cluster'] = 'redis'; - } + if ( isset( $parameters['password'] ) && version_compare( $version, '4.3.0', '>=' ) ) { + $args['password'] = $parameters['password']; + } - if ( isset( $parameters['read_timeout'] ) && $parameters['read_timeout'] ) { - $parameters['read_write_timeout'] = $parameters['read_timeout']; - } + $this->redis = new RedisCluster( null, ...array_values( $args ) ); - foreach ( array( 'WP_REDIS_SERVERS', 'WP_REDIS_SHARDS', 'WP_REDIS_CLUSTER' ) as $constant ) { - if ( defined( $constant ) ) { - if ( $parameters['database'] ) { - $options['parameters']['database'] = $parameters['database']; + $this->diagnostics += $args; + } else { + $this->redis = new Redis(); + + $args = [ + 'host' => $parameters['host'], + 'port' => $parameters['port'], + 'timeout' => $parameters['timeout'], + null, + 'retry_interval' => $parameters['retry_interval'], + ]; + + if ( strcasecmp( 'tls', $parameters['scheme'] ) === 0 ) { + $args['host'] = sprintf( + '%s://%s', + $parameters['scheme'], + str_replace( 'tls://', '', $parameters['host'] ) + ); } - if ( isset( $parameters['password'] ) ) { - $options['parameters']['password'] = WP_REDIS_PASSWORD; + if ( strcasecmp( 'unix', $parameters['scheme'] ) === 0 ) { + $args['host'] = $parameters['path']; + $args['port'] = null; } - } - } - $this->redis = new Predis\Client( $parameters, $options ); - $this->redis->connect(); + if ( version_compare( $version, '3.1.3', '>=' ) ) { + $args['read_timeout'] = $parameters['read_timeout']; + } - $this->diagnostics = array_merge( - [ 'client' => sprintf( '%s (v%s)', $client, Predis\Client::VERSION ) ], - $parameters, - $options - ); - } + call_user_func_array( [ $this->redis, 'connect' ], array_values( $args ) ); - /** - * Connect to Redis using the Credis library. - * - * @param array $parameters Connection parameters built by the `build_parameters` method. - * @throws \Exception If the Credis library was not found or is unreadable. - * @throws \Exception If redis sharding should be configured as Credis does not support sharding. - * @throws \Exception If more than one seninel is configured as Credis does not support multiple sentinel servers. - * @return void - */ - protected function connect_using_credis( $parameters ) { - $client = 'Credis'; + if ( isset( $parameters['password'] ) ) { + $args['password'] = $parameters['password']; + $this->redis->auth( $parameters['password'] ); + } - $creds_path = sprintf( - '%s/redis-cache/dependencies/colinmollenhour/credis/', - defined( 'WP_PLUGIN_DIR' ) ? WP_PLUGIN_DIR : WP_CONTENT_DIR . '/plugins' - ); + if ( isset( $parameters['database'] ) ) { + if ( ctype_digit( $parameters['database'] ) ) { + $parameters['database'] = intval( $parameters['database'] ); + } - $to_load = []; + $args['database'] = $parameters['database']; - if ( ! class_exists( 'Credis_Client' ) ) { - $to_load[] = 'Client.php'; - } + if ( $parameters['database'] ) { + $this->redis->select( $parameters['database'] ); + } + } - if ( - ( defined( 'WP_REDIS_SHARDS' ) || defined( 'WP_REDIS_SENTINEL' ) || defined( 'WP_REDIS_SERVERS' ) || defined( 'WP_REDIS_CLUSTER' ) ) && - ! class_exists( 'Credis_Cluster' ) - ) { - $to_load[] = 'Cluster.php'; + $this->diagnostics += $args; + } - if ( defined( 'WP_REDIS_SENTINEL' ) && ! class_exists( 'Credis_Sentinel' ) ) { - $to_load[] = 'Sentinel.php'; + if ( defined( 'WP_REDIS_SERIALIZER' ) && ! empty( WP_REDIS_SERIALIZER ) ) { + $this->redis->setOption( Redis::OPT_SERIALIZER, WP_REDIS_SERIALIZER ); } } - foreach ( $to_load as $sub_path ) { - $path = $creds_path . $sub_path; - - if ( file_exists( $path ) ) { - require_once $path; - } else { - throw new Exception( - 'Credis library not found. Re-install Redis Cache plugin or delete object-cache.php.' + /** + * Connect to Redis using the Predis library. + * + * @param array $parameters Connection parameters built by the `build_parameters` method. + * @throws \Exception If the Predis library was not found or is unreadable. + * @return void + */ + protected function connect_using_predis( $parameters ) { + $client = 'Predis'; + + // Load bundled Predis library. + if ( ! class_exists( 'Predis\Client' ) ) { + $predis = sprintf( + '%s/redis-cache/dependencies/predis/predis/autoload.php', + defined( 'WP_PLUGIN_DIR' ) ? WP_PLUGIN_DIR : WP_CONTENT_DIR . '/plugins' ); + + if ( is_readable( $predis ) ) { + require_once $predis; + } else { + throw new Exception( + 'Predis library not found. Re-install Redis Cache plugin or delete the object-cache.php.' + ); + } } - } - if ( defined( 'WP_REDIS_SHARDS' ) ) { - throw new Exception( - 'Sharding not supported by bundled Credis library. Please review your Redis Cache configuration.' + $options = array(); + + if ( defined( 'WP_REDIS_SHARDS' ) ) { + $parameters = WP_REDIS_SHARDS; + } elseif ( defined( 'WP_REDIS_SENTINEL' ) ) { + $parameters = WP_REDIS_SERVERS; + $options['replication'] = 'sentinel'; + $options['service'] = WP_REDIS_SENTINEL; + } elseif ( defined( 'WP_REDIS_SERVERS' ) ) { + $parameters = WP_REDIS_SERVERS; + $options['replication'] = true; + } elseif ( defined( 'WP_REDIS_CLUSTER' ) ) { + $parameters = WP_REDIS_CLUSTER; + $options['cluster'] = 'redis'; + } + + if ( isset( $parameters['read_timeout'] ) && $parameters['read_timeout'] ) { + $parameters['read_write_timeout'] = $parameters['read_timeout']; + } + + foreach ( array( 'WP_REDIS_SERVERS', 'WP_REDIS_SHARDS', 'WP_REDIS_CLUSTER' ) as $constant ) { + if ( defined( $constant ) ) { + if ( $parameters['database'] ) { + $options['parameters']['database'] = $parameters['database']; + } + + if ( isset( $parameters['password'] ) ) { + $options['parameters']['password'] = WP_REDIS_PASSWORD; + } + } + } + + $this->redis = new Predis\Client( $parameters, $options ); + $this->redis->connect(); + + $this->diagnostics = array_merge( + [ 'client' => sprintf( '%s (v%s)', $client, Predis\Client::VERSION ) ], + $parameters, + $options ); } - if ( defined( 'WP_REDIS_SENTINEL' ) ) { - if ( is_array( WP_REDIS_SERVERS ) && count( WP_REDIS_SERVERS ) > 1 ) { - throw new Exception( - 'Multipe sentinel servers are not supported by the bundled Credis library. Please review your Redis Cache configuration.' - ); - } + /** + * Connect to Redis using the Credis library. + * + * @param array $parameters Connection parameters built by the `build_parameters` method. + * @throws \Exception If the Credis library was not found or is unreadable. + * @throws \Exception If redis sharding should be configured as Credis does not support sharding. + * @throws \Exception If more than one seninel is configured as Credis does not support multiple sentinel servers. + * @return void + */ + protected function connect_using_credis( $parameters ) { + $client = 'Credis'; + + $creds_path = sprintf( + '%s/redis-cache/dependencies/colinmollenhour/credis/', + defined( 'WP_PLUGIN_DIR' ) ? WP_PLUGIN_DIR : WP_CONTENT_DIR . '/plugins' + ); - $connection_string = array_values( WP_REDIS_SERVERS )[0]; - $sentinel = new Credis_Sentinel( new Credis_Client( $connection_string ) ); - $this->redis = $sentinel->getCluster( WP_REDIS_SENTINEL ); - $args['servers'] = WP_REDIS_SERVERS; - } elseif ( defined( 'WP_REDIS_CLUSTER' ) || defined( 'WP_REDIS_SERVERS' ) ) { - $parameters['db'] = $parameters['database']; + $to_load = []; - $is_cluster = defined( 'WP_REDIS_CLUSTER' ); - $clients = $is_cluster ? WP_REDIS_CLUSTER : WP_REDIS_SERVERS; + if ( ! class_exists( 'Credis_Client' ) ) { + $to_load[] = 'Client.php'; + } - foreach ( $clients as $index => &$connection_string ) { - $url_components = wp_parse_url( $connection_string ); - parse_str( $url_components['query'], $add_params ); + if ( + ( defined( 'WP_REDIS_SHARDS' ) || defined( 'WP_REDIS_SENTINEL' ) || defined( 'WP_REDIS_SERVERS' ) || defined( 'WP_REDIS_CLUSTER' ) ) && + ! class_exists( 'Credis_Cluster' ) + ) { + $to_load[] = 'Cluster.php'; - if ( ! $is_cluster && isset( $add_params['alias'] ) ) { - $add_params['master'] = 'master' === $add_params['alias']; + if ( defined( 'WP_REDIS_SENTINEL' ) && ! class_exists( 'Credis_Sentinel' ) ) { + $to_load[] = 'Sentinel.php'; } + } - $add_params['host'] = $url_components['host']; + foreach ( $to_load as $sub_path ) { + $path = $creds_path . $sub_path; - if ( ! isset( $add_params['alias'] ) ) { - $add_params['alias'] = "redis-$index"; + if ( file_exists( $path ) ) { + require_once $path; + } else { + throw new Exception( + 'Credis library not found. Re-install Redis Cache plugin or delete object-cache.php.' + ); } + } - $connection_string = array_merge( $parameters, $add_params ); + if ( defined( 'WP_REDIS_SHARDS' ) ) { + throw new Exception( + 'Sharding not supported by bundled Credis library. Please review your Redis Cache configuration.' + ); } - $this->redis = new Credis_Cluster( $clients ); + if ( defined( 'WP_REDIS_SENTINEL' ) ) { + if ( is_array( WP_REDIS_SERVERS ) && count( WP_REDIS_SERVERS ) > 1 ) { + throw new Exception( + 'Multipe sentinel servers are not supported by the bundled Credis library. Please review your Redis Cache configuration.' + ); + } - $args['servers'] = $clients; - } else { - $args = [ - 'host' => $parameters['scheme'] === 'unix' ? $parameters['path'] : $parameters['host'], - 'port' => $parameters['port'], - 'timeout' => $parameters['timeout'], - 'persistent' => null, - 'database' => $parameters['database'], - 'password' => isset( $parameters['password'] ) ? $parameters['password'] : null, - ]; + $connection_string = array_values( WP_REDIS_SERVERS )[0]; + $sentinel = new Credis_Sentinel( new Credis_Client( $connection_string ) ); + $this->redis = $sentinel->getCluster( WP_REDIS_SENTINEL ); + $args['servers'] = WP_REDIS_SERVERS; + } elseif ( defined( 'WP_REDIS_CLUSTER' ) || defined( 'WP_REDIS_SERVERS' ) ) { + $parameters['db'] = $parameters['database']; - $this->redis = new Credis_Client( ...array_values( $args ) ); - } + $is_cluster = defined( 'WP_REDIS_CLUSTER' ); + $clients = $is_cluster ? WP_REDIS_CLUSTER : WP_REDIS_SERVERS; - // Don't use PhpRedis if it is available. - $this->redis->forceStandalone(); + foreach ( $clients as $index => &$connection_string ) { + $url_components = wp_parse_url( $connection_string ); + parse_str( $url_components['query'], $add_params ); - $this->redis->connect(); + if ( ! $is_cluster && isset( $add_params['alias'] ) ) { + $add_params['master'] = 'master' === $add_params['alias']; + } - if ( $parameters['read_timeout'] ) { - $args['read_timeout'] = $parameters['read_timeout']; - $this->redis->setReadTimeout( $parameters['read_timeout'] ); - } + $add_params['host'] = $url_components['host']; - $this->diagnostics = array_merge( - [ 'client' => sprintf( '%s (v%s)', $client, Credis_Client::VERSION ) ], - $args - ); - } + if ( ! isset( $add_params['alias'] ) ) { + $add_params['alias'] = "redis-$index"; + } - /** - * Connect to Redis using HHVM's Redis extention. - * - * @param array $parameters Connection parameters built by the `build_parameters` method. - * @return void - */ - protected function connect_using_hhvm( $parameters ) { - $this->redis = new Redis(); + $connection_string = array_merge( $parameters, $add_params ); + } - // Adjust host and port if the scheme is `unix`. - if ( strcasecmp( 'unix', $parameters['scheme'] ) === 0 ) { - $parameters['host'] = 'unix://' . $parameters['path']; - $parameters['port'] = 0; - } + $this->redis = new Credis_Cluster( $clients ); - $this->redis->connect( - $parameters['host'], - $parameters['port'], - $parameters['timeout'], - null, - $parameters['retry_interval'] - ); + $args['servers'] = $clients; + } else { + $args = [ + 'host' => $parameters['scheme'] === 'unix' ? $parameters['path'] : $parameters['host'], + 'port' => $parameters['port'], + 'timeout' => $parameters['timeout'], + 'persistent' => null, + 'database' => $parameters['database'], + 'password' => isset( $parameters['password'] ) ? $parameters['password'] : null, + ]; + + $this->redis = new Credis_Client( ...array_values( $args ) ); + } - if ( $parameters['read_timeout'] ) { - $this->redis->setOption( Redis::OPT_READ_TIMEOUT, $parameters['read_timeout'] ); - } + // Don't use PhpRedis if it is available. + $this->redis->forceStandalone(); - if ( isset( $parameters['password'] ) ) { - $this->redis->auth( $parameters['password'] ); - } + $this->redis->connect(); - if ( isset( $parameters['database'] ) ) { - if ( ctype_digit( $parameters['database'] ) ) { - $parameters['database'] = intval( $parameters['database'] ); + if ( $parameters['read_timeout'] ) { + $args['read_timeout'] = $parameters['read_timeout']; + $this->redis->setReadTimeout( $parameters['read_timeout'] ); } - if ( $parameters['database'] ) { - $this->redis->select( $parameters['database'] ); - } + $this->diagnostics = array_merge( + [ 'client' => sprintf( '%s (v%s)', $client, Credis_Client::VERSION ) ], + $args + ); } - $this->diagnostics = array_merge( - [ 'client' => sprintf( 'HHVM Extension (v%s)', HHVM_VERSION ) ], - $parameters - ); - } + /** + * Connect to Redis using HHVM's Redis extention. + * + * @param array $parameters Connection parameters built by the `build_parameters` method. + * @return void + */ + protected function connect_using_hhvm( $parameters ) { + $this->redis = new Redis(); - /** - * Fetches Redis `INFO` mostly for server version. - * - * @return void - */ - public function fetch_info() { - $options = method_exists( $this->redis, 'getOptions' ) - ? $this->redis->getOptions() - : new stdClass(); + // Adjust host and port if the scheme is `unix`. + if ( strcasecmp( 'unix', $parameters['scheme'] ) === 0 ) { + $parameters['host'] = 'unix://' . $parameters['path']; + $parameters['port'] = 0; + } - if ( isset( $options->replication ) && $options->replication ) { - return; - } + $this->redis->connect( + $parameters['host'], + $parameters['port'], + $parameters['timeout'], + null, + $parameters['retry_interval'] + ); - if ( defined( 'WP_REDIS_CLUSTER' ) ) { - $info = $this->redis->info( current( array_values( WP_REDIS_CLUSTER ) ) ); - } else { - $info = $this->redis->info(); - } + if ( $parameters['read_timeout'] ) { + $this->redis->setOption( Redis::OPT_READ_TIMEOUT, $parameters['read_timeout'] ); + } - if ( isset( $info['redis_version'] ) ) { - $this->redis_version = $info['redis_version']; - } elseif ( isset( $info['Server']['redis_version'] ) ) { - $this->redis_version = $info['Server']['redis_version']; - } - } + if ( isset( $parameters['password'] ) ) { + $this->redis->auth( $parameters['password'] ); + } - /** - * Is Redis available? - * - * @return bool - */ - public function redis_status() { - return (bool) $this->redis_connected; - } + if ( isset( $parameters['database'] ) ) { + if ( ctype_digit( $parameters['database'] ) ) { + $parameters['database'] = intval( $parameters['database'] ); + } + + if ( $parameters['database'] ) { + $this->redis->select( $parameters['database'] ); + } + } - /** - * Returns the Redis instance. - * - * @return mixed - */ - public function redis_instance() { - return $this->redis; - } + $this->diagnostics = array_merge( + [ 'client' => sprintf( 'HHVM Extension (v%s)', HHVM_VERSION ) ], + $parameters + ); + } - /** - * Returns the Redis server version. - * - * @return null|string - */ - public function redis_version() { - return $this->redis_version; - } + /** + * Fetches Redis `INFO` mostly for server version. + * + * @return void + */ + public function fetch_info() { + $options = method_exists( $this->redis, 'getOptions' ) + ? $this->redis->getOptions() + : new stdClass(); - /** - * Adds a value to cache. - * - * If the specified key already exists, the value is not stored and the function - * returns false. - * - * @param string $key The key under which to store the value. - * @param mixed $value The value to store. - * @param string $group The group value appended to the $key. - * @param int $expiration The expiration time, defaults to 0. - * @return bool Returns TRUE on success or FALSE on failure. - */ - public function add( $key, $value, $group = 'default', $expiration = 0 ) { - return $this->add_or_replace( true, $key, $value, $group, $expiration ); - } + if ( isset( $options->replication ) && $options->replication ) { + return; + } - /** - * Replace a value in the cache. - * - * If the specified key doesn't exist, the value is not stored and the function - * returns false. - * - * @param string $key The key under which to store the value. - * @param mixed $value The value to store. - * @param string $group The group value appended to the $key. - * @param int $expiration The expiration time, defaults to 0. - * @return bool Returns TRUE on success or FALSE on failure. - */ - public function replace( $key, $value, $group = 'default', $expiration = 0 ) { - return $this->add_or_replace( false, $key, $value, $group, $expiration ); - } + if ( defined( 'WP_REDIS_CLUSTER' ) ) { + $info = $this->redis->info( current( array_values( WP_REDIS_CLUSTER ) ) ); + } else { + $info = $this->redis->info(); + } - /** - * Add or replace a value in the cache. - * - * Add does not set the value if the key exists; replace does not replace if the value doesn't exist. - * - * @param bool $add True if should only add if value doesn't exist, false to only add when value already exists. - * @param string $key The key under which to store the value. - * @param mixed $value The value to store. - * @param string $group The group value appended to the $key. - * @param int $expiration The expiration time, defaults to 0. - * @return bool Returns TRUE on success or FALSE on failure. - */ - protected function add_or_replace( $add, $key, $value, $group = 'default', $expiration = 0 ) { - $cache_addition_suspended = function_exists( 'wp_suspend_cache_addition' ) + if ( isset( $info['redis_version'] ) ) { + $this->redis_version = $info['redis_version']; + } elseif ( isset( $info['Server']['redis_version'] ) ) { + $this->redis_version = $info['Server']['redis_version']; + } + } + + /** + * Is Redis available? + * + * @return bool + */ + public function redis_status() { + return (bool) $this->redis_connected; + } + + /** + * Returns the Redis instance. + * + * @return mixed + */ + public function redis_instance() { + return $this->redis; + } + + /** + * Returns the Redis server version. + * + * @return null|string + */ + public function redis_version() { + return $this->redis_version; + } + + /** + * Adds a value to cache. + * + * If the specified key already exists, the value is not stored and the function + * returns false. + * + * @param string $key The key under which to store the value. + * @param mixed $value The value to store. + * @param string $group The group value appended to the $key. + * @param int $expiration The expiration time, defaults to 0. + * @return bool Returns TRUE on success or FALSE on failure. + */ + public function add( $key, $value, $group = 'default', $expiration = 0 ) { + return $this->add_or_replace( true, $key, $value, $group, $expiration ); + } + + /** + * Replace a value in the cache. + * + * If the specified key doesn't exist, the value is not stored and the function + * returns false. + * + * @param string $key The key under which to store the value. + * @param mixed $value The value to store. + * @param string $group The group value appended to the $key. + * @param int $expiration The expiration time, defaults to 0. + * @return bool Returns TRUE on success or FALSE on failure. + */ + public function replace( $key, $value, $group = 'default', $expiration = 0 ) { + return $this->add_or_replace( false, $key, $value, $group, $expiration ); + } + + /** + * Add or replace a value in the cache. + * + * Add does not set the value if the key exists; replace does not replace if the value doesn't exist. + * + * @param bool $add True if should only add if value doesn't exist, false to only add when value already exists. + * @param string $key The key under which to store the value. + * @param mixed $value The value to store. + * @param string $group The group value appended to the $key. + * @param int $expiration The expiration time, defaults to 0. + * @return bool Returns TRUE on success or FALSE on failure. + */ + protected function add_or_replace( $add, $key, $value, $group = 'default', $expiration = 0 ) { + $cache_addition_suspended = function_exists( 'wp_suspend_cache_addition' ) ? wp_suspend_cache_addition() : false; - if ( $add && $cache_addition_suspended ) { - return false; - } + if ( $add && $cache_addition_suspended ) { + return false; + } - $result = true; - $derived_key = $this->build_key( $key, $group ); + $result = true; + $derived_key = $this->build_key( $key, $group ); - // Save if group not excluded and redis is up. - if ( ! $this->is_ignored_group( $group ) && $this->redis_status() ) { - try { - $expiration = apply_filters( 'redis_cache_expiration', $this->validate_expiration( $expiration ), $key, $group ); - $start_time = microtime( true ); + // Save if group not excluded and redis is up. + if ( ! $this->is_ignored_group( $group ) && $this->redis_status() ) { + try { + $expiration = apply_filters( 'redis_cache_expiration', $this->validate_expiration( $expiration ), $key, $group ); + $start_time = microtime( true ); - if ( $add ) { - $args = [ $derived_key, $this->maybe_serialize( $value ) ]; + if ( $add ) { + $args = [ $derived_key, $this->maybe_serialize( $value ) ]; - if ( $this->redis instanceof Predis\Client ) { - $args[] = 'nx'; + if ( $this->redis instanceof Predis\Client ) { + $args[] = 'nx'; - if ( $expiration ) { - $args[] = 'ex'; - $args[] = $expiration; - } - } else { - if ( $expiration ) { - $args[] = [ - 'nx', - 'ex' => $expiration, - ]; + if ( $expiration ) { + $args[] = 'ex'; + $args[] = $expiration; + } } else { - $args[] = [ 'nx' ]; + if ( $expiration ) { + $args[] = [ + 'nx', + 'ex' => $expiration, + ]; + } else { + $args[] = [ 'nx' ]; + } } - } - $result = $this->parse_redis_response( - $this->redis->set( ...$args ) - ); + $result = $this->parse_redis_response( + $this->redis->set( ...$args ) + ); - if ( ! $result ) { - return false; + if ( ! $result ) { + return false; + } + } elseif ( $expiration ) { + $result = $this->parse_redis_response( $this->redis->setex( $derived_key, $expiration, $this->maybe_serialize( $value ) ) ); + } else { + $result = $this->parse_redis_response( $this->redis->set( $derived_key, $this->maybe_serialize( $value ) ) ); } - } elseif ( $expiration ) { - $result = $this->parse_redis_response( $this->redis->setex( $derived_key, $expiration, $this->maybe_serialize( $value ) ) ); - } else { - $result = $this->parse_redis_response( $this->redis->set( $derived_key, $this->maybe_serialize( $value ) ) ); - } - $execute_time = microtime( true ) - $start_time; + $execute_time = microtime( true ) - $start_time; - $this->cache_calls++; - $this->cache_time += $execute_time; - } catch ( Exception $exception ) { - $this->handle_exception( $exception ); + $this->cache_calls++; + $this->cache_time += $execute_time; + } catch ( Exception $exception ) { + $this->handle_exception( $exception ); - return false; + return false; + } } - } - - $exists = isset( $this->cache[ $derived_key ] ); - - if ( (bool) $add === $exists ) { - return false; - } - if ( $result ) { - $this->add_to_internal_cache( $derived_key, $value ); - } + $exists = isset( $this->cache[ $derived_key ] ); - return $result; - } + if ( (bool) $add === $exists ) { + return false; + } - /** - * Remove the item from the cache. - * - * @param string $key The key under which to store the value. - * @param string $group The group value appended to the $key. - * @return bool Returns TRUE on success or FALSE on failure. - */ - public function delete( $key, $group = 'default' ) { - $result = false; - $derived_key = $this->build_key( $key, $group ); + if ( $result ) { + $this->add_to_internal_cache( $derived_key, $value ); + } - if ( isset( $this->cache[ $derived_key ] ) ) { - unset( $this->cache[ $derived_key ] ); - $result = true; + return $result; } - $start_time = microtime( true ); - - if ( $this->redis_status() && ! $this->is_ignored_group( $group ) ) { - try { - $result = $this->parse_redis_response( $this->redis->del( $derived_key ) ); - } catch ( Exception $exception ) { - $this->handle_exception( $exception ); + /** + * Remove the item from the cache. + * + * @param string $key The key under which to store the value. + * @param string $group The group value appended to the $key. + * @return bool Returns TRUE on success or FALSE on failure. + */ + public function delete( $key, $group = 'default' ) { + $result = false; + $derived_key = $this->build_key( $key, $group ); - return false; + if ( isset( $this->cache[ $derived_key ] ) ) { + unset( $this->cache[ $derived_key ] ); + $result = true; } - } - $execute_time = microtime( true ) - $start_time; + $start_time = microtime( true ); - $this->cache_calls++; - $this->cache_time += $execute_time; + if ( $this->redis_status() && ! $this->is_ignored_group( $group ) ) { + try { + $result = $this->parse_redis_response( $this->redis->del( $derived_key ) ); + } catch ( Exception $exception ) { + $this->handle_exception( $exception ); - if ( function_exists( 'do_action' ) ) { - do_action( 'redis_object_cache_delete', $key, $group, $execute_time ); - } + return false; + } + } - return (bool) $result; - } + $execute_time = microtime( true ) - $start_time; - /** - * Invalidate all items in the cache. If `WP_REDIS_SELECTIVE_FLUSH` is `true`, - * only keys prefixed with the `WP_REDIS_PREFIX` are flushed. - * - * @param int $delay Number of seconds to wait before invalidating the items. - * @return bool Returns TRUE on success or FALSE on failure. - */ - public function flush( $delay = 0 ) { - $delay = abs( intval( $delay ) ); + $this->cache_calls++; + $this->cache_time += $execute_time; - if ( $delay ) { - sleep( $delay ); + if ( function_exists( 'do_action' ) ) { + do_action( 'redis_object_cache_delete', $key, $group, $execute_time ); + } + + return (bool) $result; } - $results = []; - $this->cache = array(); + /** + * Invalidate all items in the cache. If `WP_REDIS_SELECTIVE_FLUSH` is `true`, + * only keys prefixed with the `WP_REDIS_PREFIX` are flushed. + * + * @param int $delay Number of seconds to wait before invalidating the items. + * @return bool Returns TRUE on success or FALSE on failure. + */ + public function flush( $delay = 0 ) { + $delay = abs( intval( $delay ) ); - if ( $this->redis_status() ) { - $salt = defined( 'WP_REDIS_PREFIX' ) ? trim( WP_REDIS_PREFIX ) : null; - $selective = defined( 'WP_REDIS_SELECTIVE_FLUSH' ) ? WP_REDIS_SELECTIVE_FLUSH : null; + if ( $delay ) { + sleep( $delay ); + } - $start_time = microtime( true ); + $results = []; + $this->cache = array(); - if ( $salt && $selective ) { - $script = $this->get_flush_closure( $salt ); + if ( $this->redis_status() ) { + $salt = defined( 'WP_REDIS_PREFIX' ) ? trim( WP_REDIS_PREFIX ) : null; + $selective = defined( 'WP_REDIS_SELECTIVE_FLUSH' ) ? WP_REDIS_SELECTIVE_FLUSH : null; - if ( defined( 'WP_REDIS_CLUSTER' ) ) { - try { - foreach ( $this->redis->_masters() as $master ) { - $redis = new Redis(); - $redis->connect( $master[0], $master[1] ); - $results[] = $this->parse_redis_response( $script() ); - unset( $redis ); + $start_time = microtime( true ); + + if ( $salt && $selective ) { + $script = $this->get_flush_closure( $salt ); + + if ( defined( 'WP_REDIS_CLUSTER' ) ) { + try { + foreach ( $this->redis->_masters() as $master ) { + $redis = new Redis(); + $redis->connect( $master[0], $master[1] ); + $results[] = $this->parse_redis_response( $script() ); + unset( $redis ); + } + } catch ( Exception $exception ) { + $this->handle_exception( $exception ); + + return false; } - } catch ( Exception $exception ) { - $this->handle_exception( $exception ); + } else { + try { + $results[] = $this->parse_redis_response( $script() ); + } catch ( Exception $exception ) { + $this->handle_exception( $exception ); - return false; + return false; + } } } else { - try { - $results[] = $this->parse_redis_response( $script() ); - } catch ( Exception $exception ) { - $this->handle_exception( $exception ); + if ( defined( 'WP_REDIS_CLUSTER' ) ) { + try { + foreach ( $this->redis->_masters() as $master ) { + $results[] = $this->parse_redis_response( $this->redis->flushdb( $master ) ); + } + } catch ( Exception $exception ) { + $this->handle_exception( $exception ); + + return false; + } + } else { + try { + $results[] = $this->parse_redis_response( $this->redis->flushdb() ); + } catch ( Exception $exception ) { + $this->handle_exception( $exception ); - return false; + return false; + } } } - } else { - if ( defined( 'WP_REDIS_CLUSTER' ) ) { - try { - foreach ( $this->redis->_masters() as $master ) { - $results[] = $this->parse_redis_response( $this->redis->flushdb( $master ) ); - } - } catch ( Exception $exception ) { - $this->handle_exception( $exception ); - return false; - } - } else { - try { - $results[] = $this->parse_redis_response( $this->redis->flushdb() ); - } catch ( Exception $exception ) { - $this->handle_exception( $exception ); + if ( function_exists( 'do_action' ) ) { + $execute_time = microtime( true ) - $start_time; - return false; - } + do_action( 'redis_object_cache_flush', $results, $delay, $selective, $salt, $execute_time ); } } - if ( function_exists( 'do_action' ) ) { - $execute_time = microtime( true ) - $start_time; + if ( empty( $results ) ) { + return false; + } - do_action( 'redis_object_cache_flush', $results, $delay, $selective, $salt, $execute_time ); + foreach ( $results as $result ) { + if ( ! $result ) { + return false; + } } - } - if ( empty( $results ) ) { - return false; + return true; } - foreach ( $results as $result ) { - if ( ! $result ) { - return false; + /** + * Returns a closure to flush selectively. + * + * @param string $salt The salt to be used to differentiate. + * @return callable Generated callable executing the lua script. + */ + protected function get_flush_closure( $salt ) { + if ( $this->unflushable_groups ) { + return $this->lua_flush_extended_closure( $salt ); + } else { + return $this->lua_flush_closure( $salt ); } } - return true; - } - - /** - * Returns a closure to flush selectively. - * - * @param string $salt The salt to be used to differentiate. - * @return callable Generated callable executing the lua script. - */ - protected function get_flush_closure( $salt ) { - if ( $this->unflushable_groups ) { - return $this->lua_flush_extended_closure( $salt ); - } else { - return $this->lua_flush_closure( $salt ); + /** + * Quotes a string for usage in the `glob` function + * + * @param string $string The string to quote. + * @return string + */ + protected function glob_quote( $string ) { + $characters = [ '*', '+', '?', '!', '{', '}', '[', ']', '(', ')', '|', '@' ]; + + return str_replace( + $characters, + array_map( + function ( $character ) { + return "[{$character}]"; + }, + $characters + ), + $string + ); } - } - - /** - * Quotes a string for usage in the `glob` function - * - * @param string $string The string to quote. - * @return string - */ - protected function glob_quote( $string ) { - $characters = [ '*', '+', '?', '!', '{', '}', '[', ']', '(', ')', '|', '@' ]; - - return str_replace( - $characters, - array_map( - function ( $character ) { - return "[{$character}]"; - }, - $characters - ), - $string - ); - } - /** - * Returns a closure ready to be called to flush selectively ignoring unflushable groups. - * - * @param string $salt The salt to be used to differentiate. - * @return callable Generated callable executing the lua script. - */ - protected function lua_flush_closure( $salt ) { - $salt = $this->glob_quote( $salt ); + /** + * Returns a closure ready to be called to flush selectively ignoring unflushable groups. + * + * @param string $salt The salt to be used to differentiate. + * @return callable Generated callable executing the lua script. + */ + protected function lua_flush_closure( $salt ) { + $salt = $this->glob_quote( $salt ); - return function () use ( $salt ) { - $script = <<redis_version(), '5', '<' ) && version_compare( $this->redis_version(), '3.2', '>=' ) ) { - $script = 'redis.replicate_commands()' . "\n" . $script; - } + if ( version_compare( $this->redis_version(), '5', '<' ) && version_compare( $this->redis_version(), '3.2', '>=' ) ) { + $script = 'redis.replicate_commands()' . "\n" . $script; + } - $args = ( $this->redis instanceof Predis\Client ) + $args = ( $this->redis instanceof Predis\Client ) ? [ $script, 0 ] : [ $script ]; - return call_user_func_array( [ $this->redis, 'eval' ], $args ); - }; - } + return call_user_func_array( [ $this->redis, 'eval' ], $args ); + }; + } - /** - * Returns a closure ready to be called to flush selectively. - * - * @param string $salt The salt to be used to differentiate. - * @return callable Generated callable executing the lua script. - */ - protected function lua_flush_extended_closure( $salt ) { - $salt = $this->glob_quote( $salt ); + /** + * Returns a closure ready to be called to flush selectively. + * + * @param string $salt The salt to be used to differentiate. + * @return callable Generated callable executing the lua script. + */ + protected function lua_flush_extended_closure( $salt ) { + $salt = $this->glob_quote( $salt ); - return function () use ( $salt ) { - $salt_length = strlen( $salt ); + return function () use ( $salt ) { + $salt_length = strlen( $salt ); - $unflushable = array_map( - function ( $group ) { - return ":{$group}:"; - }, - $this->unflushable_groups - ); + $unflushable = array_map( + function ( $group ) { + return ":{$group}:"; + }, + $this->unflushable_groups + ); - $script = <<redis_version(), '5', '<' ) && version_compare( $this->redis_version(), '3.2', '>=' ) ) { - $script = 'redis.replicate_commands()' . "\n" . $script; - } + if ( version_compare( $this->redis_version(), '5', '<' ) && version_compare( $this->redis_version(), '3.2', '>=' ) ) { + $script = 'redis.replicate_commands()' . "\n" . $script; + } - $args = ( $this->redis instanceof Predis\Client ) + $args = ( $this->redis instanceof Predis\Client ) ? array_merge( [ $script, count( $unflushable ) ], $unflushable ) : [ $script, $unflushable, count( $unflushable ) ]; - return call_user_func_array( [ $this->redis, 'eval' ], $args ); - }; - } - - /** - * Retrieve object from cache. - * - * Gets an object from cache based on $key and $group. - * - * @param string $key The key under which to store the value. - * @param string $group The group value appended to the $key. - * @param string $force Optional. Whether to force a refetch rather than relying on the local - * cache. Default false. - * @param bool $found Optional. Whether the key was found in the cache. Disambiguates a return of - * false, a storable value. Passed by reference. Default null. - * @return bool|mixed Cached object value. - */ - public function get( $key, $group = 'default', $force = false, &$found = null ) { - $derived_key = $this->build_key( $key, $group ); - - if ( isset( $this->cache[ $derived_key ] ) && ! $force ) { - $found = true; - $this->cache_hits++; - - return $this->get_from_internal_cache( $derived_key ); - } elseif ( $this->is_ignored_group( $group ) || ! $this->redis_status() ) { - $found = false; - $this->cache_misses++; + return call_user_func_array( [ $this->redis, 'eval' ], $args ); + }; + } + + /** + * Retrieve object from cache. + * + * Gets an object from cache based on $key and $group. + * + * @param string $key The key under which to store the value. + * @param string $group The group value appended to the $key. + * @param string $force Optional. Whether to force a refetch rather than relying on the local + * cache. Default false. + * @param bool $found Optional. Whether the key was found in the cache. Disambiguates a return of + * false, a storable value. Passed by reference. Default null. + * @return bool|mixed Cached object value. + */ + public function get( $key, $group = 'default', $force = false, &$found = null ) { + $derived_key = $this->build_key( $key, $group ); + + if ( isset( $this->cache[ $derived_key ] ) && ! $force ) { + $found = true; + $this->cache_hits++; - return false; - } + return $this->get_from_internal_cache( $derived_key ); + } elseif ( $this->is_ignored_group( $group ) || ! $this->redis_status() ) { + $found = false; + $this->cache_misses++; - $start_time = microtime( true ); + return false; + } - try { - $result = $this->redis->get( $derived_key ); - } catch ( Exception $exception ) { - $this->handle_exception( $exception ); + $start_time = microtime( true ); - return false; - } + try { + $result = $this->redis->get( $derived_key ); + } catch ( Exception $exception ) { + $this->handle_exception( $exception ); - $execute_time = microtime( true ) - $start_time; + return false; + } - $this->cache_calls++; - $this->cache_time += $execute_time; + $execute_time = microtime( true ) - $start_time; - if ( $result === null || $result === false ) { - $found = false; - $this->cache_misses++; + $this->cache_calls++; + $this->cache_time += $execute_time; - return false; - } else { - $found = true; - $this->cache_hits++; - $value = $this->maybe_unserialize( $result ); - } + if ( $result === null || $result === false ) { + $found = false; + $this->cache_misses++; - $this->add_to_internal_cache( $derived_key, $value ); + return false; + } else { + $found = true; + $this->cache_hits++; + $value = $this->maybe_unserialize( $result ); + } - if ( function_exists( 'do_action' ) ) { - do_action( 'redis_object_cache_get', $key, $value, $group, $force, $found, $execute_time ); - } + $this->add_to_internal_cache( $derived_key, $value ); - if ( function_exists( 'apply_filters' ) && function_exists( 'has_filter' ) ) { - if ( has_filter( 'redis_object_cache_get_value' ) ) { - return apply_filters( 'redis_object_cache_get_value', $value, $key, $group, $force, $found ); + if ( function_exists( 'do_action' ) ) { + do_action( 'redis_object_cache_get', $key, $value, $group, $force, $found, $execute_time ); } - } - return $value; - } + if ( function_exists( 'apply_filters' ) && function_exists( 'has_filter' ) ) { + if ( has_filter( 'redis_object_cache_get_value' ) ) { + return apply_filters( 'redis_object_cache_get_value', $value, $key, $group, $force, $found ); + } + } - /** - * Retrieves multiple values from the cache in one call. - * - * @param array $keys Array of keys under which the cache contents are stored. - * @param string $group Optional. Where the cache contents are grouped. Default empty. - * @param bool $force Optional. Whether to force an update of the local cache - * from the persistent cache. Default false. - * @return array Array of values organized into groups. - */ - public function get_multiple( $keys, $group = 'default', $force = false ) { - if ( ! is_array( $keys ) ) { - return false; + return $value; } - $cache = array(); - $derived_keys = array(); + /** + * Retrieves multiple values from the cache in one call. + * + * @param array $keys Array of keys under which the cache contents are stored. + * @param string $group Optional. Where the cache contents are grouped. Default empty. + * @param bool $force Optional. Whether to force an update of the local cache + * from the persistent cache. Default false. + * @return array Array of values organized into groups. + */ + public function get_multiple( $keys, $group = 'default', $force = false ) { + if ( ! is_array( $keys ) ) { + return false; + } - foreach ( $keys as $key ) { - $derived_keys[ $key ] = $this->build_key( $key, $group ); - } + $cache = array(); + $derived_keys = array(); - if ( $this->is_ignored_group( $group ) || ! $this->redis_status() ) { foreach ( $keys as $key ) { - $cache[ $key ] = $this->get_from_internal_cache( $derived_keys[ $key ] ); - $cache[ $key ] === false ? $this->cache_misses++ : $this->cache_hits++; + $derived_keys[ $key ] = $this->build_key( $key, $group ); } - return $cache; - } + if ( $this->is_ignored_group( $group ) || ! $this->redis_status() ) { + foreach ( $keys as $key ) { + $cache[ $key ] = $this->get_from_internal_cache( $derived_keys[ $key ] ); + $cache[ $key ] === false ? $this->cache_misses++ : $this->cache_hits++; + } - if ( ! $force ) { - foreach ( $keys as $key ) { - $value = $this->get_from_internal_cache( $derived_keys[ $key ] ); + return $cache; + } - if ( $value === false ) { - $this->cache_misses++; - } else { - $cache[ $key ] = $value; - $this->cache_hits++; + if ( ! $force ) { + foreach ( $keys as $key ) { + $value = $this->get_from_internal_cache( $derived_keys[ $key ] ); + + if ( $value === false ) { + $this->cache_misses++; + } else { + $cache[ $key ] = $value; + $this->cache_hits++; + } } } - } - $remaining_keys = array_filter( - $keys, - function ( $key ) use ( $cache ) { - return ! isset( $cache[ $key ] ); - } - ); + $remaining_keys = array_filter( + $keys, + function ( $key ) use ( $cache ) { + return ! isset( $cache[ $key ] ); + } + ); - if ( empty( $remaining_keys ) ) { - return $cache; - } + if ( empty( $remaining_keys ) ) { + return $cache; + } - $start_time = microtime( true ); + $start_time = microtime( true ); - try { - $remaining_ids = array_map( - function ( $key ) use ( $derived_keys ) { - return $derived_keys[ $key ]; - }, - $remaining_keys - ); + try { + $remaining_ids = array_map( + function ( $key ) use ( $derived_keys ) { + return $derived_keys[ $key ]; + }, + $remaining_keys + ); - $results = array_combine( - $remaining_keys, - $this->redis->mget( $remaining_ids ) - ); - } catch ( Exception $exception ) { - $this->handle_exception( $exception ); + $results = array_combine( + $remaining_keys, + $this->redis->mget( $remaining_ids ) + ); + } catch ( Exception $exception ) { + $this->handle_exception( $exception ); - $cache = array_fill( 0, count( $derived_keys ) - 1, false ); - } + $cache = array_fill( 0, count( $derived_keys ) - 1, false ); + } - $execute_time = microtime( true ) - $start_time; + $execute_time = microtime( true ) - $start_time; - $this->cache_calls++; - $this->cache_time += $execute_time; + $this->cache_calls++; + $this->cache_time += $execute_time; - foreach ( $results as $key => $value ) { - if ( $value === null || $value === false ) { - $cache[ $key ] = false; - $this->cache_misses++; - } else { - $cache[ $key ] = $this->maybe_unserialize( $value ); - $this->add_to_internal_cache( $derived_keys[ $key ], $cache[ $key ] ); + foreach ( $results as $key => $value ) { + if ( $value === null || $value === false ) { + $cache[ $key ] = false; + $this->cache_misses++; + } else { + $cache[ $key ] = $this->maybe_unserialize( $value ); + $this->add_to_internal_cache( $derived_keys[ $key ], $cache[ $key ] ); - $this->cache_hits++; + $this->cache_hits++; + } } - } - if ( function_exists( 'do_action' ) ) { - do_action( 'redis_object_cache_get_multiple', $keys, $cache, $group, $force, $execute_time ); - } + if ( function_exists( 'do_action' ) ) { + do_action( 'redis_object_cache_get_multiple', $keys, $cache, $group, $force, $execute_time ); + } - if ( function_exists( 'apply_filters' ) && function_exists( 'has_filter' ) ) { - if ( has_filter( 'redis_object_cache_get_value' ) ) { - foreach ( $cache as $key => $value ) { - $cache[ $key ] = apply_filters( 'redis_object_cache_get_value', $value, $key, $group, $force ); + if ( function_exists( 'apply_filters' ) && function_exists( 'has_filter' ) ) { + if ( has_filter( 'redis_object_cache_get_value' ) ) { + foreach ( $cache as $key => $value ) { + $cache[ $key ] = apply_filters( 'redis_object_cache_get_value', $value, $key, $group, $force ); + } } } + + return $cache; } - return $cache; - } + /** + * Sets a value in cache. + * + * The value is set whether or not this key already exists in Redis. + * + * @param string $key The key under which to store the value. + * @param mixed $value The value to store. + * @param string $group The group value appended to the $key. + * @param int $expiration The expiration time, defaults to 0. + * @return bool Returns TRUE on success or FALSE on failure. + */ + public function set( $key, $value, $group = 'default', $expiration = 0 ) { + $result = true; + $derived_key = $this->build_key( $key, $group ); - /** - * Sets a value in cache. - * - * The value is set whether or not this key already exists in Redis. - * - * @param string $key The key under which to store the value. - * @param mixed $value The value to store. - * @param string $group The group value appended to the $key. - * @param int $expiration The expiration time, defaults to 0. - * @return bool Returns TRUE on success or FALSE on failure. - */ - public function set( $key, $value, $group = 'default', $expiration = 0 ) { - $result = true; - $derived_key = $this->build_key( $key, $group ); + $start_time = microtime( true ); - $start_time = microtime( true ); + // Save if group not excluded from redis and redis is up. + if ( ! $this->is_ignored_group( $group ) && $this->redis_status() ) { + $expiration = apply_filters( 'redis_cache_expiration', $this->validate_expiration( $expiration ), $key, $group ); - // Save if group not excluded from redis and redis is up. - if ( ! $this->is_ignored_group( $group ) && $this->redis_status() ) { - $expiration = apply_filters( 'redis_cache_expiration', $this->validate_expiration( $expiration ), $key, $group ); + try { + if ( $expiration ) { + $result = $this->parse_redis_response( $this->redis->setex( $derived_key, $expiration, $this->maybe_serialize( $value ) ) ); + } else { + $result = $this->parse_redis_response( $this->redis->set( $derived_key, $this->maybe_serialize( $value ) ) ); + } + } catch ( Exception $exception ) { + $this->handle_exception( $exception ); - try { - if ( $expiration ) { - $result = $this->parse_redis_response( $this->redis->setex( $derived_key, $expiration, $this->maybe_serialize( $value ) ) ); - } else { - $result = $this->parse_redis_response( $this->redis->set( $derived_key, $this->maybe_serialize( $value ) ) ); + return false; } - } catch ( Exception $exception ) { - $this->handle_exception( $exception ); - return false; + $this->cache_calls++; + $this->cache_time += ( microtime( true ) - $start_time ); } - $this->cache_calls++; - $this->cache_time += ( microtime( true ) - $start_time ); - } + // If the set was successful, or we didn't go to redis. + if ( $result ) { + $this->add_to_internal_cache( $derived_key, $value ); + } - // If the set was successful, or we didn't go to redis. - if ( $result ) { - $this->add_to_internal_cache( $derived_key, $value ); - } + if ( function_exists( 'do_action' ) ) { + $execute_time = microtime( true ) - $start_time; - if ( function_exists( 'do_action' ) ) { - $execute_time = microtime( true ) - $start_time; + do_action( 'redis_object_cache_set', $key, $value, $group, $expiration, $execute_time ); + } - do_action( 'redis_object_cache_set', $key, $value, $group, $expiration, $execute_time ); + return $result; } - return $result; - } - - /** - * Increment a Redis counter by the amount specified - * - * @param string $key The key name. - * @param int $offset Optional. The increment. Defaults to 1. - * @param string $group Optional. The key group. Default is 'default'. - * @return int|bool - */ - public function increment( $key, $offset = 1, $group = 'default' ) { - $offset = (int) $offset; - $derived_key = $this->build_key( $key, $group ); - - // If group is a non-Redis group, save to internal cache, not Redis. - if ( $this->is_ignored_group( $group ) || ! $this->redis_status() ) { - $value = $this->get_from_internal_cache( $derived_key ); - $value += $offset; - $this->add_to_internal_cache( $derived_key, $value ); + /** + * Increment a Redis counter by the amount specified + * + * @param string $key The key name. + * @param int $offset Optional. The increment. Defaults to 1. + * @param string $group Optional. The key group. Default is 'default'. + * @return int|bool + */ + public function increment( $key, $offset = 1, $group = 'default' ) { + $offset = (int) $offset; + $derived_key = $this->build_key( $key, $group ); - return $value; - } + // If group is a non-Redis group, save to internal cache, not Redis. + if ( $this->is_ignored_group( $group ) || ! $this->redis_status() ) { + $value = $this->get_from_internal_cache( $derived_key ); + $value += $offset; + $this->add_to_internal_cache( $derived_key, $value ); - $start_time = microtime( true ); + return $value; + } - try { - $result = $this->parse_redis_response( $this->redis->incrBy( $derived_key, $offset ) ); + $start_time = microtime( true ); - $this->add_to_internal_cache( $derived_key, (int) $this->redis->get( $derived_key ) ); - } catch ( Exception $exception ) { - $this->handle_exception( $exception ); + try { + $result = $this->parse_redis_response( $this->redis->incrBy( $derived_key, $offset ) ); - return false; - } + $this->add_to_internal_cache( $derived_key, (int) $this->redis->get( $derived_key ) ); + } catch ( Exception $exception ) { + $this->handle_exception( $exception ); - $execute_time = microtime( true ) - $start_time; + return false; + } - $this->cache_calls += 2; - $this->cache_time += $execute_time; + $execute_time = microtime( true ) - $start_time; - return $result; - } + $this->cache_calls += 2; + $this->cache_time += $execute_time; + + return $result; + } + + /** + * Alias of `increment()`. + * + * @see self::increment() + * @param string $key The key name. + * @param int $offset Optional. The increment. Defaults to 1. + * @param string $group Optional. The key group. Default is 'default'. + * @return int|bool + */ + public function incr( $key, $offset = 1, $group = 'default' ) { + return $this->increment( $key, $offset, $group ); + } + + /** + * Decrement a Redis counter by the amount specified + * + * @param string $key The key name. + * @param int $offset Optional. The decrement. Defaults to 1. + * @param string $group Optional. The key group. Default is 'default'. + * @return int|bool + */ + public function decrement( $key, $offset = 1, $group = 'default' ) { + $derived_key = $this->build_key( $key, $group ); + $offset = (int) $offset; + + // If group is a non-Redis group, save to internal cache, not Redis. + if ( $this->is_ignored_group( $group ) || ! $this->redis_status() ) { + $value = $this->get_from_internal_cache( $derived_key ); + $value -= $offset; + $this->add_to_internal_cache( $derived_key, $value ); + + return $value; + } - /** - * Alias of `increment()`. - * - * @see self::increment() - * @param string $key The key name. - * @param int $offset Optional. The increment. Defaults to 1. - * @param string $group Optional. The key group. Default is 'default'. - * @return int|bool - */ - public function incr( $key, $offset = 1, $group = 'default' ) { - return $this->increment( $key, $offset, $group ); - } + $start_time = microtime( true ); - /** - * Decrement a Redis counter by the amount specified - * - * @param string $key The key name. - * @param int $offset Optional. The decrement. Defaults to 1. - * @param string $group Optional. The key group. Default is 'default'. - * @return int|bool - */ - public function decrement( $key, $offset = 1, $group = 'default' ) { - $derived_key = $this->build_key( $key, $group ); - $offset = (int) $offset; - - // If group is a non-Redis group, save to internal cache, not Redis. - if ( $this->is_ignored_group( $group ) || ! $this->redis_status() ) { - $value = $this->get_from_internal_cache( $derived_key ); - $value -= $offset; - $this->add_to_internal_cache( $derived_key, $value ); + try { + // Save to Redis. + $result = $this->parse_redis_response( $this->redis->decrBy( $derived_key, $offset ) ); - return $value; - } + $this->add_to_internal_cache( $derived_key, (int) $this->redis->get( $derived_key ) ); + } catch ( Exception $exception ) { + $this->handle_exception( $exception ); - $start_time = microtime( true ); + return false; + } - try { - // Save to Redis. - $result = $this->parse_redis_response( $this->redis->decrBy( $derived_key, $offset ) ); + $execute_time = microtime( true ) - $start_time; - $this->add_to_internal_cache( $derived_key, (int) $this->redis->get( $derived_key ) ); - } catch ( Exception $exception ) { - $this->handle_exception( $exception ); + $this->cache_calls += 2; + $this->cache_time += $execute_time; - return false; + return $result; } - $execute_time = microtime( true ) - $start_time; + /** + * Render data about current cache requests + * Used by the Debug bar plugin + * + * @return void + */ + public function stats() { + $bytes = strlen( serialize( $wp_object_cache->cache ) ); // phpcs:ignore WordPress.PHP.DiscouragedPHPFunctions.serialize_serialize - $this->cache_calls += 2; - $this->cache_time += $execute_time; - - return $result; - } - - /** - * Render data about current cache requests - * Used by the Debug bar plugin - * - * @return void - */ - public function stats() { - $bytes = strlen( serialize( $wp_object_cache->cache ) ); // phpcs:ignore WordPress.PHP.DiscouragedPHPFunctions.serialize_serialize - - ?> + ?>

Redis Status: redis_status() ? 'Connected' : 'Not connected'; ?> @@ -1610,408 +1608,410 @@ public function stats() { Cache Size: kB

- cache_hits + $this->cache_misses; - - $bytes = array_map( - function ( $keys ) { - // phpcs:ignore WordPress.PHP.DiscouragedPHPFunctions.serialize_serialize - return strlen( serialize( $keys ) ); - }, - $this->cache - ); - - return (object) [ - 'hits' => $this->cache_hits, - 'misses' => $this->cache_misses, - 'ratio' => $total > 0 ? round( $this->cache_hits / ( $total / 100 ), 1 ) : 100, - 'bytes' => array_sum( $bytes ), - 'time' => $this->cache_time, - 'calls' => $this->cache_calls, - 'groups' => (object) [ - 'global' => $this->global_groups, - 'non_persistent' => $this->ignored_groups, - 'unflushable' => $this->unflushable_groups, - ], - 'errors' => empty( $this->errors ) ? null : $this->errors, - 'meta' => [ - 'Client' => $this->diagnostics['client'] ?: 'Unknown', - 'Redis Version' => $this->redis_version, - ], - ]; - } - - /** - * Builds a key for the cached object using the prefix, group and key. - * - * @param string $key The key under which to store the value. - * @param string $group The group value appended to the $key. - * - * @return string - */ - public function build_key( $key, $group = 'default' ) { - if ( empty( $group ) ) { - $group = 'default'; + is_global_group( $group ) ? $this->global_prefix : $this->blog_prefix; + /** + * Returns various information about the object cache. + * + * @return object + */ + public function info() { + $total = $this->cache_hits + $this->cache_misses; - $key = $this->sanitize_key_part( $key ); - $group = $this->sanitize_key_part( $group ); - - $prefix = trim( $prefix, '_-:$' ); + $bytes = array_map( + function ( $keys ) { + // phpcs:ignore WordPress.PHP.DiscouragedPHPFunctions.serialize_serialize + return strlen( serialize( $keys ) ); + }, + $this->cache + ); - return "{$salt}{$prefix}:{$group}:{$key}"; - } + return (object) [ + 'hits' => $this->cache_hits, + 'misses' => $this->cache_misses, + 'ratio' => $total > 0 ? round( $this->cache_hits / ( $total / 100 ), 1 ) : 100, + 'bytes' => array_sum( $bytes ), + 'time' => $this->cache_time, + 'calls' => $this->cache_calls, + 'groups' => (object) [ + 'global' => $this->global_groups, + 'non_persistent' => $this->ignored_groups, + 'unflushable' => $this->unflushable_groups, + ], + 'errors' => empty( $this->errors ) ? null : $this->errors, + 'meta' => [ + 'Client' => $this->diagnostics['client'] ?: 'Unknown', + 'Redis Version' => $this->redis_version, + ], + ]; + } - /** - * Replaces the set group separator by another one - * - * @param string $part The string to sanitize. - * @return string Sanitized string. - */ - protected function sanitize_key_part( $part ) { - return str_replace( ':', '-', $part ); - } + /** + * Builds a key for the cached object using the prefix, group and key. + * + * @param string $key The key under which to store the value. + * @param string $group The group value appended to the $key. + * + * @return string + */ + public function build_key( $key, $group = 'default' ) { + if ( empty( $group ) ) { + $group = 'default'; + } - /** - * Checks if the given group is part the ignored group array - * - * @param string $group Name of the group to check. - * @return bool - */ - protected function is_ignored_group( $group ) { - return in_array( $this->sanitize_key_part( $group ), $this->ignored_groups, true ); - } + $salt = defined( 'WP_REDIS_PREFIX' ) ? trim( WP_REDIS_PREFIX ) : ''; + $prefix = $this->is_global_group( $group ) ? $this->global_prefix : $this->blog_prefix; + + $key = $this->sanitize_key_part( $key ); + $group = $this->sanitize_key_part( $group ); + + $prefix = trim( $prefix, '_-:$' ); + + return "{$salt}{$prefix}:{$group}:{$key}"; + } + + /** + * Replaces the set group separator by another one + * + * @param string $part The string to sanitize. + * @return string Sanitized string. + */ + protected function sanitize_key_part( $part ) { + return str_replace( ':', '-', $part ); + } + + /** + * Checks if the given group is part the ignored group array + * + * @param string $group Name of the group to check. + * @return bool + */ + protected function is_ignored_group( $group ) { + return in_array( $this->sanitize_key_part( $group ), $this->ignored_groups, true ); + } + + /** + * Checks if the given group is part the global group array + * + * @param string $group Name of the group to check. + * @return bool + */ + protected function is_global_group( $group ) { + return in_array( $this->sanitize_key_part( $group ), $this->global_groups, true ); + } + + /** + * Checks if the given group is part the unflushable group array + * + * @param string $group Name of the group to check. + * @return bool + */ + protected function is_unflushable_group( $group ) { + return in_array( $this->sanitize_key_part( $group ), $this->unflushable_groups, true ); + } + + /** + * Convert Redis responses into something meaningful + * + * @param mixed $response Response sent from the redis instance. + * @return mixed + */ + protected function parse_redis_response( $response ) { + if ( is_bool( $response ) ) { + return $response; + } - /** - * Checks if the given group is part the global group array - * - * @param string $group Name of the group to check. - * @return bool - */ - protected function is_global_group( $group ) { - return in_array( $this->sanitize_key_part( $group ), $this->global_groups, true ); - } + if ( is_numeric( $response ) ) { + return $response; + } - /** - * Checks if the given group is part the unflushable group array - * - * @param string $group Name of the group to check. - * @return bool - */ - protected function is_unflushable_group( $group ) { - return in_array( $this->sanitize_key_part( $group ), $this->unflushable_groups, true ); - } + if ( is_object( $response ) && method_exists( $response, 'getPayload' ) ) { + return $response->getPayload() === 'OK'; + } - /** - * Convert Redis responses into something meaningful - * - * @param mixed $response Response sent from the redis instance. - * @return mixed - */ - protected function parse_redis_response( $response ) { - if ( is_bool( $response ) ) { - return $response; + return false; } - if ( is_numeric( $response ) ) { - return $response; - } + /** + * Simple wrapper for saving object to the internal cache. + * + * @param string $derived_key Key to save value under. + * @param mixed $value Object value. + */ + public function add_to_internal_cache( $derived_key, $value ) { + if ( is_object( $value ) ) { + $value = clone $value; + } - if ( is_object( $response ) && method_exists( $response, 'getPayload' ) ) { - return $response->getPayload() === 'OK'; + $this->cache[ $derived_key ] = $value; } - return false; - } - - /** - * Simple wrapper for saving object to the internal cache. - * - * @param string $derived_key Key to save value under. - * @param mixed $value Object value. - */ - public function add_to_internal_cache( $derived_key, $value ) { - if ( is_object( $value ) ) { - $value = clone $value; - } + /** + * Get a value specifically from the internal, run-time cache, not Redis. + * + * @param int|string $derived_key Key value. + * + * @return bool|mixed Value on success; false on failure. + */ + public function get_from_internal_cache( $derived_key ) { + if ( ! isset( $this->cache[ $derived_key ] ) ) { + return false; + } - $this->cache[ $derived_key ] = $value; - } + if ( is_object( $this->cache[ $derived_key ] ) ) { + return clone $this->cache[ $derived_key ]; + } - /** - * Get a value specifically from the internal, run-time cache, not Redis. - * - * @param int|string $derived_key Key value. - * - * @return bool|mixed Value on success; false on failure. - */ - public function get_from_internal_cache( $derived_key ) { - if ( ! isset( $this->cache[ $derived_key ] ) ) { - return false; + return $this->cache[ $derived_key ]; } - if ( is_object( $this->cache[ $derived_key ] ) ) { - return clone $this->cache[ $derived_key ]; - } + /** + * In multisite, switch blog prefix when switching blogs + * + * @param int $_blog_id Blog ID. + * @return bool + */ + public function switch_to_blog( $_blog_id ) { + if ( ! function_exists( 'is_multisite' ) || ! is_multisite() ) { + return false; + } - return $this->cache[ $derived_key ]; - } + $this->blog_prefix = $_blog_id; - /** - * In multisite, switch blog prefix when switching blogs - * - * @param int $_blog_id Blog ID. - * @return bool - */ - public function switch_to_blog( $_blog_id ) { - if ( ! function_exists( 'is_multisite' ) || ! is_multisite() ) { - return false; + return true; } - $this->blog_prefix = $_blog_id; + /** + * Sets the list of global groups. + * + * @param array $groups List of groups that are global. + */ + public function add_global_groups( $groups ) { + $groups = (array) $groups; - return true; - } + if ( $this->redis_status() ) { + $this->global_groups = array_unique( array_merge( $this->global_groups, $groups ) ); + } else { + $this->ignored_groups = array_unique( array_merge( $this->ignored_groups, $groups ) ); + } + } - /** - * Sets the list of global groups. - * - * @param array $groups List of groups that are global. - */ - public function add_global_groups( $groups ) { - $groups = (array) $groups; + /** + * Sets the list of groups not to be cached by Redis. + * + * @param array $groups List of groups that are to be ignored. + */ + public function add_non_persistent_groups( $groups ) { + $groups = (array) $groups; - if ( $this->redis_status() ) { - $this->global_groups = array_unique( array_merge( $this->global_groups, $groups ) ); - } else { $this->ignored_groups = array_unique( array_merge( $this->ignored_groups, $groups ) ); } - } - - /** - * Sets the list of groups not to be cached by Redis. - * - * @param array $groups List of groups that are to be ignored. - */ - public function add_non_persistent_groups( $groups ) { - $groups = (array) $groups; - - $this->ignored_groups = array_unique( array_merge( $this->ignored_groups, $groups ) ); - } - - /** - * Sets the list of groups not to flushed cached. - * - * @param array $groups List of groups that are unflushable. - */ - public function add_unflushable_groups( $groups ) { - $groups = (array) $groups; - - $this->unflushable_groups = array_unique( array_merge( $this->unflushable_groups, $groups ) ); - } - - /** - * Wrapper to validate the cache keys expiration value - * - * @param mixed $expiration Incoming expiration value (whatever it is). - */ - protected function validate_expiration( $expiration ) { - $expiration = is_int( $expiration ) || ctype_digit( $expiration ) ? (int) $expiration : 0; - if ( defined( 'WP_REDIS_MAXTTL' ) ) { - $max = (int) WP_REDIS_MAXTTL; + /** + * Sets the list of groups not to flushed cached. + * + * @param array $groups List of groups that are unflushable. + */ + public function add_unflushable_groups( $groups ) { + $groups = (array) $groups; - if ( $expiration === 0 || $expiration > $max ) { - $expiration = $max; - } + $this->unflushable_groups = array_unique( array_merge( $this->unflushable_groups, $groups ) ); } - return $expiration; - } - - /** - * Unserialize value only if it was serialized. - * - * @param string $original Maybe unserialized original, if is needed. - * @return mixed Unserialized data can be any type. - */ - protected function maybe_unserialize( $original ) { - if ( defined( 'WP_REDIS_SERIALIZER' ) && ! empty( WP_REDIS_SERIALIZER ) ) { - return $original; - } + /** + * Wrapper to validate the cache keys expiration value + * + * @param mixed $expiration Incoming expiration value (whatever it is). + */ + protected function validate_expiration( $expiration ) { + $expiration = is_int( $expiration ) || ctype_digit( $expiration ) ? (int) $expiration : 0; - if ( defined( 'WP_REDIS_IGBINARY' ) && WP_REDIS_IGBINARY && function_exists( 'igbinary_unserialize' ) ) { - return igbinary_unserialize( $original ); - } + if ( defined( 'WP_REDIS_MAXTTL' ) ) { + $max = (int) WP_REDIS_MAXTTL; - // Don't attempt to unserialize data that wasn't serialized going in. - if ( $this->is_serialized( $original ) ) { - // phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged, WordPress.PHP.DiscouragedPHPFunctions.serialize_unserialize - $value = @unserialize( $original ); + if ( $expiration === 0 || $expiration > $max ) { + $expiration = $max; + } + } - return is_object( $value ) ? clone $value : $value; + return $expiration; } - return $original; - } + /** + * Unserialize value only if it was serialized. + * + * @param string $original Maybe unserialized original, if is needed. + * @return mixed Unserialized data can be any type. + */ + protected function maybe_unserialize( $original ) { + if ( defined( 'WP_REDIS_SERIALIZER' ) && ! empty( WP_REDIS_SERIALIZER ) ) { + return $original; + } - /** - * Serialize data, if needed. - * - * @param mixed $data Data that might be serialized. - * @return mixed A scalar data - */ - protected function maybe_serialize( $data ) { - if ( is_object( $data ) ) { - $data = clone $data; - } + if ( defined( 'WP_REDIS_IGBINARY' ) && WP_REDIS_IGBINARY && function_exists( 'igbinary_unserialize' ) ) { + return igbinary_unserialize( $original ); + } - if ( defined( 'WP_REDIS_SERIALIZER' ) && ! empty( WP_REDIS_SERIALIZER ) ) { - return $data; - } + // Don't attempt to unserialize data that wasn't serialized going in. + if ( $this->is_serialized( $original ) ) { + // phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged, WordPress.PHP.DiscouragedPHPFunctions.serialize_unserialize + $value = @unserialize( $original ); - if ( defined( 'WP_REDIS_IGBINARY' ) && WP_REDIS_IGBINARY && function_exists( 'igbinary_serialize' ) ) { - return igbinary_serialize( $data ); - } + return is_object( $value ) ? clone $value : $value; + } - if ( is_array( $data ) || is_object( $data ) ) { - // phpcs:ignore WordPress.PHP.DiscouragedPHPFunctions.serialize_serialize - return serialize( $data ); + return $original; } - if ( $this->is_serialized( $data, false ) ) { - // phpcs:ignore WordPress.PHP.DiscouragedPHPFunctions.serialize_serialize - return serialize( $data ); - } + /** + * Serialize data, if needed. + * + * @param mixed $data Data that might be serialized. + * @return mixed A scalar data + */ + protected function maybe_serialize( $data ) { + if ( is_object( $data ) ) { + $data = clone $data; + } - return $data; - } + if ( defined( 'WP_REDIS_SERIALIZER' ) && ! empty( WP_REDIS_SERIALIZER ) ) { + return $data; + } - /** - * Check value to find if it was serialized. - * - * If $data is not an string, then returned value will always be false. - * Serialized data is always a string. - * - * @param string $data Value to check to see if was serialized. - * @param bool $strict Optional. Whether to be strict about the end of the string. Default true. - * @return bool False if not serialized and true if it was. - */ - protected function is_serialized( $data, $strict = true ) { - // if it isn't a string, it isn't serialized. - if ( ! is_string( $data ) ) { - return false; - } + if ( defined( 'WP_REDIS_IGBINARY' ) && WP_REDIS_IGBINARY && function_exists( 'igbinary_serialize' ) ) { + return igbinary_serialize( $data ); + } - $data = trim( $data ); + if ( is_array( $data ) || is_object( $data ) ) { + // phpcs:ignore WordPress.PHP.DiscouragedPHPFunctions.serialize_serialize + return serialize( $data ); + } - if ( 'N;' === $data ) { - return true; - } + if ( $this->is_serialized( $data, false ) ) { + // phpcs:ignore WordPress.PHP.DiscouragedPHPFunctions.serialize_serialize + return serialize( $data ); + } - if ( strlen( $data ) < 4 ) { - return false; + return $data; } - if ( ':' !== $data[1] ) { - return false; - } + /** + * Check value to find if it was serialized. + * + * If $data is not an string, then returned value will always be false. + * Serialized data is always a string. + * + * @param string $data Value to check to see if was serialized. + * @param bool $strict Optional. Whether to be strict about the end of the string. Default true. + * @return bool False if not serialized and true if it was. + */ + protected function is_serialized( $data, $strict = true ) { + // if it isn't a string, it isn't serialized. + if ( ! is_string( $data ) ) { + return false; + } - if ( $strict ) { - $lastc = substr( $data, -1 ); + $data = trim( $data ); - if ( ';' !== $lastc && '}' !== $lastc ) { - return false; + if ( 'N;' === $data ) { + return true; } - } else { - $semicolon = strpos( $data, ';' ); - $brace = strpos( $data, '}' ); - // Either ; or } must exist. - if ( false === $semicolon && false === $brace ) { + if ( strlen( $data ) < 4 ) { return false; } - // But neither must be in the first X characters. - if ( false !== $semicolon && $semicolon < 3 ) { + if ( ':' !== $data[1] ) { return false; } - if ( false !== $brace && $brace < 4 ) { - return false; + if ( $strict ) { + $lastc = substr( $data, -1 ); + + if ( ';' !== $lastc && '}' !== $lastc ) { + return false; + } + } else { + $semicolon = strpos( $data, ';' ); + $brace = strpos( $data, '}' ); + + // Either ; or } must exist. + if ( false === $semicolon && false === $brace ) { + return false; + } + + // But neither must be in the first X characters. + if ( false !== $semicolon && $semicolon < 3 ) { + return false; + } + + if ( false !== $brace && $brace < 4 ) { + return false; + } } - } - $token = $data[0]; + $token = $data[0]; - switch ( $token ) { - case 's': - if ( $strict ) { - if ( '"' !== substr( $data, -2, 1 ) ) { + switch ( $token ) { + case 's': + if ( $strict ) { + if ( '"' !== substr( $data, -2, 1 ) ) { + return false; + } + } elseif ( false === strpos( $data, '"' ) ) { return false; } - } elseif ( false === strpos( $data, '"' ) ) { - return false; - } - // Or else fall through. - // No break! - case 'a': - case 'O': - return (bool) preg_match( "/^{$token}:[0-9]+:/s", $data ); - case 'b': - case 'i': - case 'd': - $end = $strict ? '$' : ''; - - return (bool) preg_match( "/^{$token}:[0-9.E-]+;$end/", $data ); + // Or else fall through. + // No break! + case 'a': + case 'O': + return (bool) preg_match( "/^{$token}:[0-9]+:/s", $data ); + case 'b': + case 'i': + case 'd': + $end = $strict ? '$' : ''; + + return (bool) preg_match( "/^{$token}:[0-9.E-]+;$end/", $data ); + } + + return false; } - return false; - } + /** + * Handle the redis failure gracefully or throw an exception. + * + * @param \Exception $exception Exception thrown. + * @throws \Exception If `fail_gracefully` flag is set to a falsy value. + * @return void + */ + protected function handle_exception( $exception ) { + $this->redis_connected = false; - /** - * Handle the redis failure gracefully or throw an exception. - * - * @param \Exception $exception Exception thrown. - * @throws \Exception If `fail_gracefully` flag is set to a falsy value. - * @return void - */ - protected function handle_exception( $exception ) { - $this->redis_connected = false; + // When Redis is unavailable, fall back to the internal cache by forcing all groups to be "no redis" groups. + $this->ignored_groups = array_unique( array_merge( $this->ignored_groups, $this->global_groups ) ); - // When Redis is unavailable, fall back to the internal cache by forcing all groups to be "no redis" groups. - $this->ignored_groups = array_unique( array_merge( $this->ignored_groups, $this->global_groups ) ); + if ( ! $this->fail_gracefully ) { + throw $exception; + } - if ( ! $this->fail_gracefully ) { - throw $exception; - } + $this->errors[] = $exception->getMessage(); - $this->errors[] = $exception->getMessage(); + error_log( $exception ); // phpcs:ignore WordPress.PHP.DevelopmentFunctions.error_log_error_log - error_log( $exception ); // phpcs:ignore WordPress.PHP.DevelopmentFunctions.error_log_error_log + if ( function_exists( 'do_action' ) ) { + do_action( 'redis_object_cache_error', $exception ); + } + } - if ( function_exists( 'do_action' ) ) { - do_action( 'redis_object_cache_error', $exception ); + /** + * Allows access to private properties for backwards compatibility. + * + * @param string $name Name of the property. + * @return mixed + */ + public function __get( $name ) { + return isset( $this->{$name} ) ? $this->{$name} : null; } } - /** - * Allows access to private properties for backwards compatibility. - * - * @param string $name Name of the property. - * @return mixed - */ - public function __get( $name ) { - return isset( $this->{$name} ) ? $this->{$name} : null; - } -} +endif; From 812683bcbe38588b2cf69f3f1c172f3e7ec5dc8a Mon Sep 17 00:00:00 2001 From: naxvog Date: Sun, 16 Aug 2020 11:22:34 +0200 Subject: [PATCH 88/93] removed indentation sniff due to non standard indentation --- includes/object-cache.php | 3248 +++++++++++++++++++------------------ 1 file changed, 1625 insertions(+), 1623 deletions(-) diff --git a/includes/object-cache.php b/includes/object-cache.php index db3304fd..6993d12b 100644 --- a/includes/object-cache.php +++ b/includes/object-cache.php @@ -14,2004 +14,2006 @@ defined( '\\ABSPATH' ) || exit; +// phpcs:disable Generic.WhiteSpace.ScopeIndent.IncorrectExact, Generic.WhiteSpace.ScopeIndent.Incorrect if ( ! defined( 'WP_REDIS_DISABLED' ) || ! WP_REDIS_DISABLED ) : - /** - * Adds a value to cache. - * - * If the specified key already exists, the value is not stored and the function - * returns false. - * - * @param string $key The key under which to store the value. - * @param mixed $value The value to store. - * @param string $group The group value appended to the $key. - * @param int $expiration The expiration time, defaults to 0. - * - * @return bool Returns TRUE on success or FALSE on failure. - */ - function wp_cache_add( $key, $value, $group = '', $expiration = 0 ) { - global $wp_object_cache; +/** + * Adds a value to cache. + * + * If the specified key already exists, the value is not stored and the function + * returns false. + * + * @param string $key The key under which to store the value. + * @param mixed $value The value to store. + * @param string $group The group value appended to the $key. + * @param int $expiration The expiration time, defaults to 0. + * + * @return bool Returns TRUE on success or FALSE on failure. + */ +function wp_cache_add( $key, $value, $group = '', $expiration = 0 ) { + global $wp_object_cache; + + return $wp_object_cache->add( $key, $value, $group, $expiration ); +} + +/** + * Closes the cache. + * + * This function has ceased to do anything since WordPress 2.5. The + * functionality was removed along with the rest of the persistent cache. This + * does not mean that plugins can't implement this function when they need to + * make sure that the cache is cleaned up after WordPress no longer needs it. + * + * @return bool Always returns True + */ +function wp_cache_close() { + return true; +} + +/** + * Decrement a numeric item's value. + * + * @param string $key The key under which to store the value. + * @param int $offset The amount by which to decrement the item's value. + * @param string $group The group value appended to the $key. + * + * @return int|bool Returns item's new value on success or FALSE on failure. + */ +function wp_cache_decr( $key, $offset = 1, $group = '' ) { + global $wp_object_cache; + + return $wp_object_cache->decrement( $key, $offset, $group ); +} + +/** + * Remove the item from the cache. + * + * @param string $key The key under which to store the value. + * @param string $group The group value appended to the $key. + * @param int $time The amount of time the server will wait to delete the item in seconds. + * + * @return bool Returns TRUE on success or FALSE on failure. + */ +function wp_cache_delete( $key, $group = '', $time = 0 ) { + global $wp_object_cache; + + return $wp_object_cache->delete( $key, $group, $time ); +} + +/** + * Invalidate all items in the cache. If `WP_REDIS_SELECTIVE_FLUSH` is `true`, + * only keys prefixed with the `WP_REDIS_PREFIX` are flushed. + * + * @param int $delay Number of seconds to wait before invalidating the items. + * + * @return bool Returns TRUE on success or FALSE on failure. + */ +function wp_cache_flush( $delay = 0 ) { + global $wp_object_cache; + + return $wp_object_cache->flush( $delay ); +} + +/** + * Retrieve object from cache. + * + * Gets an object from cache based on $key and $group. + * + * @param string $key The key under which to store the value. + * @param string $group The group value appended to the $key. + * @param bool $force Optional. Whether to force an update of the local cache from the persistent + * cache. Default false. + * @param bool $found Optional. Whether the key was found in the cache. Disambiguates a return of false, + * a storable value. Passed by reference. Default null. + * + * @return bool|mixed Cached object value. + */ +function wp_cache_get( $key, $group = '', $force = false, &$found = null ) { + global $wp_object_cache; + + return $wp_object_cache->get( $key, $group, $force, $found ); +} + +/** + * Retrieves multiple values from the cache in one call. + * + * @param array $keys Array of keys under which the cache contents are stored. + * @param string $group Optional. Where the cache contents are grouped. Default empty. + * @param bool $force Optional. Whether to force an update of the local cache + * from the persistent cache. Default false. + * @return array Array of values organized into groups. + */ +function wp_cache_get_multiple( $keys, $group = '', $force = false ) { + global $wp_object_cache; - return $wp_object_cache->add( $key, $value, $group, $expiration ); + return $wp_object_cache->get_multiple( $keys, $group, $force ); +} + +/** + * Increment a numeric item's value. + * + * @param string $key The key under which to store the value. + * @param int $offset The amount by which to increment the item's value. + * @param string $group The group value appended to the $key. + * + * @return int|bool Returns item's new value on success or FALSE on failure. + */ +function wp_cache_incr( $key, $offset = 1, $group = '' ) { + global $wp_object_cache; + + return $wp_object_cache->increment( $key, $offset, $group ); +} + +/** + * Sets up Object Cache Global and assigns it. + * + * @return void + */ +function wp_cache_init() { + global $wp_object_cache; + + // Backwards compatibility: map `WP_CACHE_KEY_SALT` constant to `WP_REDIS_PREFIX`. + if ( defined( 'WP_CACHE_KEY_SALT' ) && ! defined( 'WP_REDIS_PREFIX' ) ) { + define( 'WP_REDIS_PREFIX', WP_CACHE_KEY_SALT ); + } + + if ( ! ( $wp_object_cache instanceof WP_Object_Cache ) ) { + $fail_gracefully = ! defined( 'WP_REDIS_GRACEFUL' ) || WP_REDIS_GRACEFUL; + + // We need to override this WordPress global in order to inject our cache. + // phpcs:ignore WordPress.WP.GlobalVariablesOverride.Prohibited + $wp_object_cache = new WP_Object_Cache( $fail_gracefully ); } +} + +/** + * Replaces a value in cache. + * + * This method is similar to "add"; however, is does not successfully set a value if + * the object's key is not already set in cache. + * + * @param string $key The key under which to store the value. + * @param mixed $value The value to store. + * @param string $group The group value appended to the $key. + * @param int $expiration The expiration time, defaults to 0. + * + * @return bool Returns TRUE on success or FALSE on failure. + */ +function wp_cache_replace( $key, $value, $group = '', $expiration = 0 ) { + global $wp_object_cache; + + return $wp_object_cache->replace( $key, $value, $group, $expiration ); +} + +/** + * Sets a value in cache. + * + * The value is set whether or not this key already exists in Redis. + * + * @param string $key The key under which to store the value. + * @param mixed $value The value to store. + * @param string $group The group value appended to the $key. + * @param int $expiration The expiration time, defaults to 0. + * + * @return bool Returns TRUE on success or FALSE on failure. + */ +function wp_cache_set( $key, $value, $group = '', $expiration = 0 ) { + global $wp_object_cache; + + return $wp_object_cache->set( $key, $value, $group, $expiration ); +} + +/** + * Switch the internal blog id. + * + * This changes the blog id used to create keys in blog specific groups. + * + * @param int $_blog_id The blog ID. + * + * @return bool + */ +function wp_cache_switch_to_blog( $_blog_id ) { + global $wp_object_cache; + + return $wp_object_cache->switch_to_blog( $_blog_id ); +} + +/** + * Adds a group or set of groups to the list of Redis groups. + * + * @param string|array $groups A group or an array of groups to add. + * + * @return void + */ +function wp_cache_add_global_groups( $groups ) { + global $wp_object_cache; + + $wp_object_cache->add_global_groups( $groups ); +} + +/** + * Adds a group or set of groups to the list of non-Redis groups. + * + * @param string|array $groups A group or an array of groups to add. + * + * @return void + */ +function wp_cache_add_non_persistent_groups( $groups ) { + global $wp_object_cache; + + $wp_object_cache->add_non_persistent_groups( $groups ); +} + +/** + * Object cache class definition + */ +class WP_Object_Cache { /** - * Closes the cache. + * The Redis client. * - * This function has ceased to do anything since WordPress 2.5. The - * functionality was removed along with the rest of the persistent cache. This - * does not mean that plugins can't implement this function when they need to - * make sure that the cache is cleaned up after WordPress no longer needs it. - * - * @return bool Always returns True + * @var mixed */ - function wp_cache_close() { - return true; - } + private $redis; /** - * Decrement a numeric item's value. - * - * @param string $key The key under which to store the value. - * @param int $offset The amount by which to decrement the item's value. - * @param string $group The group value appended to the $key. + * The Redis server version. * - * @return int|bool Returns item's new value on success or FALSE on failure. + * @var null|string */ - function wp_cache_decr( $key, $offset = 1, $group = '' ) { - global $wp_object_cache; - - return $wp_object_cache->decrement( $key, $offset, $group ); - } + private $redis_version = null; /** - * Remove the item from the cache. - * - * @param string $key The key under which to store the value. - * @param string $group The group value appended to the $key. - * @param int $time The amount of time the server will wait to delete the item in seconds. + * Track if Redis is available. * - * @return bool Returns TRUE on success or FALSE on failure. + * @var bool */ - function wp_cache_delete( $key, $group = '', $time = 0 ) { - global $wp_object_cache; - - return $wp_object_cache->delete( $key, $group, $time ); - } + private $redis_connected = false; /** - * Invalidate all items in the cache. If `WP_REDIS_SELECTIVE_FLUSH` is `true`, - * only keys prefixed with the `WP_REDIS_PREFIX` are flushed. + * Check to fail gracefully or throw an exception. * - * @param int $delay Number of seconds to wait before invalidating the items. - * - * @return bool Returns TRUE on success or FALSE on failure. + * @var bool */ - function wp_cache_flush( $delay = 0 ) { - global $wp_object_cache; - - return $wp_object_cache->flush( $delay ); - } + private $fail_gracefully = true; /** - * Retrieve object from cache. - * - * Gets an object from cache based on $key and $group. + * Holds the non-Redis objects. * - * @param string $key The key under which to store the value. - * @param string $group The group value appended to the $key. - * @param bool $force Optional. Whether to force an update of the local cache from the persistent - * cache. Default false. - * @param bool $found Optional. Whether the key was found in the cache. Disambiguates a return of false, - * a storable value. Passed by reference. Default null. - * - * @return bool|mixed Cached object value. + * @var array */ - function wp_cache_get( $key, $group = '', $force = false, &$found = null ) { - global $wp_object_cache; - - return $wp_object_cache->get( $key, $group, $force, $found ); - } + public $cache = array(); /** - * Retrieves multiple values from the cache in one call. + * Holds the diagnostics values. * - * @param array $keys Array of keys under which the cache contents are stored. - * @param string $group Optional. Where the cache contents are grouped. Default empty. - * @param bool $force Optional. Whether to force an update of the local cache - * from the persistent cache. Default false. - * @return array Array of values organized into groups. + * @var array */ - function wp_cache_get_multiple( $keys, $group = '', $force = false ) { - global $wp_object_cache; - - return $wp_object_cache->get_multiple( $keys, $group, $force ); - } + public $diagnostics = null; /** - * Increment a numeric item's value. - * - * @param string $key The key under which to store the value. - * @param int $offset The amount by which to increment the item's value. - * @param string $group The group value appended to the $key. + * Holds the error messages. * - * @return int|bool Returns item's new value on success or FALSE on failure. + * @var array */ - function wp_cache_incr( $key, $offset = 1, $group = '' ) { - global $wp_object_cache; - - return $wp_object_cache->increment( $key, $offset, $group ); - } + public $errors = array(); /** - * Sets up Object Cache Global and assigns it. + * List of global groups. * - * @return void + * @var array */ - function wp_cache_init() { - global $wp_object_cache; - - // Backwards compatibility: map `WP_CACHE_KEY_SALT` constant to `WP_REDIS_PREFIX`. - if ( defined( 'WP_CACHE_KEY_SALT' ) && ! defined( 'WP_REDIS_PREFIX' ) ) { - define( 'WP_REDIS_PREFIX', WP_CACHE_KEY_SALT ); - } - - if ( ! ( $wp_object_cache instanceof WP_Object_Cache ) ) { - $fail_gracefully = ! defined( 'WP_REDIS_GRACEFUL' ) || WP_REDIS_GRACEFUL; - - // We need to override this WordPress global in order to inject our cache. - // phpcs:ignore WordPress.WP.GlobalVariablesOverride.Prohibited - $wp_object_cache = new WP_Object_Cache( $fail_gracefully ); - } - } + public $global_groups = array( + 'blog-details', + 'blog-id-cache', + 'blog-lookup', + 'global-posts', + 'networks', + 'rss', + 'sites', + 'site-details', + 'site-lookup', + 'site-options', + 'site-transient', + 'users', + 'useremail', + 'userlogins', + 'usermeta', + 'user_meta', + 'userslugs', + ); /** - * Replaces a value in cache. + * List of groups that will not be flushed. * - * This method is similar to "add"; however, is does not successfully set a value if - * the object's key is not already set in cache. - * - * @param string $key The key under which to store the value. - * @param mixed $value The value to store. - * @param string $group The group value appended to the $key. - * @param int $expiration The expiration time, defaults to 0. - * - * @return bool Returns TRUE on success or FALSE on failure. + * @var array */ - function wp_cache_replace( $key, $value, $group = '', $expiration = 0 ) { - global $wp_object_cache; - - return $wp_object_cache->replace( $key, $value, $group, $expiration ); - } + public $unflushable_groups = array(); /** - * Sets a value in cache. - * - * The value is set whether or not this key already exists in Redis. - * - * @param string $key The key under which to store the value. - * @param mixed $value The value to store. - * @param string $group The group value appended to the $key. - * @param int $expiration The expiration time, defaults to 0. + * List of groups not saved to Redis. * - * @return bool Returns TRUE on success or FALSE on failure. + * @var array */ - function wp_cache_set( $key, $value, $group = '', $expiration = 0 ) { - global $wp_object_cache; + public $ignored_groups = array( + 'counts', + 'plugins', + 'themes', + ); - return $wp_object_cache->set( $key, $value, $group, $expiration ); - } + /** + * Prefix used for global groups. + * + * @var string + */ + public $global_prefix = ''; /** - * Switch the internal blog id. + * Prefix used for non-global groups. * - * This changes the blog id used to create keys in blog specific groups. + * @var string + */ + public $blog_prefix = ''; + + /** + * Track how many requests were found in cache. * - * @param int $_blog_id The blog ID. + * @var int + */ + public $cache_hits = 0; + + /** + * Track how may requests were not cached. * - * @return bool + * @var int */ - function wp_cache_switch_to_blog( $_blog_id ) { - global $wp_object_cache; + public $cache_misses = 0; - return $wp_object_cache->switch_to_blog( $_blog_id ); - } + /** + * Track how long request took. + * + * @var int + */ + public $cache_time = 0; /** - * Adds a group or set of groups to the list of Redis groups. + * Track how may calls were made. * - * @param string|array $groups A group or an array of groups to add. + * @var int + */ + public $cache_calls = 0; + + /** + * Instantiate the Redis class. * - * @return void + * @param bool $fail_gracefully Handles and logs errors if true throws exceptions otherwise. */ - function wp_cache_add_global_groups( $groups ) { - global $wp_object_cache; + public function __construct( $fail_gracefully = true ) { + global $blog_id, $table_prefix; + + $this->fail_gracefully = $fail_gracefully; + + if ( defined( 'WP_REDIS_GLOBAL_GROUPS' ) && is_array( WP_REDIS_GLOBAL_GROUPS ) ) { + $this->global_groups = array_map( [ $this, 'sanitize_key_part' ], WP_REDIS_GLOBAL_GROUPS ); + } + + if ( defined( 'WP_REDIS_IGNORED_GROUPS' ) && is_array( WP_REDIS_IGNORED_GROUPS ) ) { + $this->ignored_groups = array_map( [ $this, 'sanitize_key_part' ], WP_REDIS_IGNORED_GROUPS ); + } + + if ( defined( 'WP_REDIS_UNFLUSHABLE_GROUPS' ) && is_array( WP_REDIS_UNFLUSHABLE_GROUPS ) ) { + $this->unflushable_groups = array_map( [ $this, 'sanitize_key_part' ], WP_REDIS_UNFLUSHABLE_GROUPS ); + } + + $client = $this->determine_client(); + $parameters = $this->build_parameters(); + + try { + switch ( $client ) { + case 'hhvm': + $this->connect_using_hhvm( $parameters ); + break; + case 'phpredis': + $this->connect_using_phpredis( $parameters ); + break; + case 'credis': + $this->connect_using_credis( $parameters ); + break; + case 'predis': + default: + $this->connect_using_predis( $parameters ); + break; + } + + if ( defined( 'WP_REDIS_CLUSTER' ) ) { + $this->diagnostics[ 'ping' ] = $this->redis->ping( current( array_values( WP_REDIS_CLUSTER ) ) ); + } else { + $this->diagnostics[ 'ping' ] = $this->redis->ping(); + } + + $this->fetch_info(); - $wp_object_cache->add_global_groups( $groups ); + $this->redis_connected = true; + } catch ( Exception $exception ) { + $this->handle_exception( $exception ); + } + + // Assign global and blog prefixes for use with keys. + if ( function_exists( 'is_multisite' ) ) { + $this->global_prefix = is_multisite() ? '' : $table_prefix; + $this->blog_prefix = is_multisite() ? $blog_id : $table_prefix; + } } /** - * Adds a group or set of groups to the list of non-Redis groups. - * - * @param string|array $groups A group or an array of groups to add. + * Determine the Redis client. * - * @return void + * @return string */ - function wp_cache_add_non_persistent_groups( $groups ) { - global $wp_object_cache; + protected function determine_client() { + $client = 'predis'; + + if ( class_exists( 'Redis' ) ) { + $client = defined( 'HHVM_VERSION' ) ? 'hhvm' : 'phpredis'; + } + + if ( defined( 'WP_REDIS_CLIENT' ) ) { + $client = (string) WP_REDIS_CLIENT; + $client = str_replace( 'pecl', 'phpredis', $client ); + } - $wp_object_cache->add_non_persistent_groups( $groups ); + return trim( strtolower( $client ) ); } /** - * Object cache class definition + * Build the connection parameters from config constants. + * + * @return array */ - class WP_Object_Cache { - - /** - * The Redis client. - * - * @var mixed - */ - private $redis; - - /** - * The Redis server version. - * - * @var null|string - */ - private $redis_version = null; - - /** - * Track if Redis is available. - * - * @var bool - */ - private $redis_connected = false; - - /** - * Check to fail gracefully or throw an exception. - * - * @var bool - */ - private $fail_gracefully = true; - - /** - * Holds the non-Redis objects. - * - * @var array - */ - public $cache = array(); - - /** - * Holds the diagnostics values. - * - * @var array - */ - public $diagnostics = null; - - /** - * Holds the error messages. - * - * @var array - */ - public $errors = array(); - - /** - * List of global groups. - * - * @var array - */ - public $global_groups = array( - 'blog-details', - 'blog-id-cache', - 'blog-lookup', - 'global-posts', - 'networks', - 'rss', - 'sites', - 'site-details', - 'site-lookup', - 'site-options', - 'site-transient', - 'users', - 'useremail', - 'userlogins', - 'usermeta', - 'user_meta', - 'userslugs', + protected function build_parameters() { + $parameters = array( + 'scheme' => 'tcp', + 'host' => '127.0.0.1', + 'port' => 6379, + 'database' => 0, + 'timeout' => 1, + 'read_timeout' => 1, + 'retry_interval' => null, ); - /** - * List of groups that will not be flushed. - * - * @var array - */ - public $unflushable_groups = array(); - - /** - * List of groups not saved to Redis. - * - * @var array - */ - public $ignored_groups = array( - 'counts', - 'plugins', - 'themes', + $settings = array( + 'scheme', + 'host', + 'port', + 'path', + 'password', + 'database', + 'timeout', + 'read_timeout', + 'retry_interval', ); - /** - * Prefix used for global groups. - * - * @var string - */ - public $global_prefix = ''; - - /** - * Prefix used for non-global groups. - * - * @var string - */ - public $blog_prefix = ''; - - /** - * Track how many requests were found in cache. - * - * @var int - */ - public $cache_hits = 0; - - /** - * Track how may requests were not cached. - * - * @var int - */ - public $cache_misses = 0; - - /** - * Track how long request took. - * - * @var int - */ - public $cache_time = 0; - - /** - * Track how may calls were made. - * - * @var int - */ - public $cache_calls = 0; - - /** - * Instantiate the Redis class. - * - * @param bool $fail_gracefully Handles and logs errors if true throws exceptions otherwise. - */ - public function __construct( $fail_gracefully = true ) { - global $blog_id, $table_prefix; - - $this->fail_gracefully = $fail_gracefully; - - if ( defined( 'WP_REDIS_GLOBAL_GROUPS' ) && is_array( WP_REDIS_GLOBAL_GROUPS ) ) { - $this->global_groups = array_map( [ $this, 'sanitize_key_part' ], WP_REDIS_GLOBAL_GROUPS ); - } + foreach ( $settings as $setting ) { + $constant = sprintf( 'WP_REDIS_%s', strtoupper( $setting ) ); - if ( defined( 'WP_REDIS_IGNORED_GROUPS' ) && is_array( WP_REDIS_IGNORED_GROUPS ) ) { - $this->ignored_groups = array_map( [ $this, 'sanitize_key_part' ], WP_REDIS_IGNORED_GROUPS ); + if ( defined( $constant ) ) { + $parameters[ $setting ] = constant( $constant ); } + } + + if ( isset( $parameters['password'] ) ) { + $password = $parameters['password']; - if ( defined( 'WP_REDIS_UNFLUSHABLE_GROUPS' ) && is_array( WP_REDIS_UNFLUSHABLE_GROUPS ) ) { - $this->unflushable_groups = array_map( [ $this, 'sanitize_key_part' ], WP_REDIS_UNFLUSHABLE_GROUPS ); + if ( is_null( $password ) || $password === '' ) { + unset( $parameters['password'] ); } + } - $client = $this->determine_client(); - $parameters = $this->build_parameters(); + return $parameters; + } - try { - switch ( $client ) { - case 'hhvm': - $this->connect_using_hhvm( $parameters ); - break; - case 'phpredis': - $this->connect_using_phpredis( $parameters ); - break; - case 'credis': - $this->connect_using_credis( $parameters ); - break; - case 'predis': - default: - $this->connect_using_predis( $parameters ); - break; - } + /** + * Connect to Redis using the PhpRedis (PECL) extention. + * + * @param array $parameters Connection parameters built by the `build_parameters` method. + * @return void + */ + protected function connect_using_phpredis( $parameters ) { + $version = phpversion( 'redis' ); - if ( defined( 'WP_REDIS_CLUSTER' ) ) { - $this->diagnostics[ 'ping' ] = $this->redis->ping( current( array_values( WP_REDIS_CLUSTER ) ) ); - } else { - $this->diagnostics[ 'ping' ] = $this->redis->ping(); - } + $this->diagnostics[ 'client' ] = sprintf( 'PhpRedis (v%s)', $version ); - $this->fetch_info(); + if ( defined( 'WP_REDIS_SHARDS' ) ) { + $this->redis = new RedisArray( array_values( WP_REDIS_SHARDS ) ); - $this->redis_connected = true; - } catch ( Exception $exception ) { - $this->handle_exception( $exception ); - } + $this->diagnostics[ 'shards' ] = WP_REDIS_SHARDS; + } elseif ( defined( 'WP_REDIS_CLUSTER' ) ) { + $args = [ + 'cluster' => array_values( WP_REDIS_CLUSTER ), + 'timeout' => $parameters['timeout'], + 'read_timeout' => $parameters['read_timeout'], + ]; - // Assign global and blog prefixes for use with keys. - if ( function_exists( 'is_multisite' ) ) { - $this->global_prefix = is_multisite() ? '' : $table_prefix; - $this->blog_prefix = is_multisite() ? $blog_id : $table_prefix; + if ( isset( $parameters['password'] ) && version_compare( $version, '4.3.0', '>=' ) ) { + $args['password'] = $parameters['password']; } - } - /** - * Determine the Redis client. - * - * @return string - */ - protected function determine_client() { - $client = 'predis'; + $this->redis = new RedisCluster( null, ...array_values( $args ) ); + + $this->diagnostics += $args; + } else { + $this->redis = new Redis(); + + $args = [ + 'host' => $parameters['host'], + 'port' => $parameters['port'], + 'timeout' => $parameters['timeout'], + null, + 'retry_interval' => $parameters['retry_interval'], + ]; - if ( class_exists( 'Redis' ) ) { - $client = defined( 'HHVM_VERSION' ) ? 'hhvm' : 'phpredis'; + if ( strcasecmp( 'tls', $parameters['scheme'] ) === 0 ) { + $args['host'] = sprintf( + '%s://%s', + $parameters['scheme'], + str_replace( 'tls://', '', $parameters['host'] ) + ); } - if ( defined( 'WP_REDIS_CLIENT' ) ) { - $client = (string) WP_REDIS_CLIENT; - $client = str_replace( 'pecl', 'phpredis', $client ); + if ( strcasecmp( 'unix', $parameters['scheme'] ) === 0 ) { + $args['host'] = $parameters['path']; + $args['port'] = null; } - return trim( strtolower( $client ) ); - } - - /** - * Build the connection parameters from config constants. - * - * @return array - */ - protected function build_parameters() { - $parameters = array( - 'scheme' => 'tcp', - 'host' => '127.0.0.1', - 'port' => 6379, - 'database' => 0, - 'timeout' => 1, - 'read_timeout' => 1, - 'retry_interval' => null, - ); + if ( version_compare( $version, '3.1.3', '>=' ) ) { + $args['read_timeout'] = $parameters['read_timeout']; + } - $settings = array( - 'scheme', - 'host', - 'port', - 'path', - 'password', - 'database', - 'timeout', - 'read_timeout', - 'retry_interval', - ); + call_user_func_array( [ $this->redis, 'connect' ], array_values( $args ) ); - foreach ( $settings as $setting ) { - $constant = sprintf( 'WP_REDIS_%s', strtoupper( $setting ) ); + if ( isset( $parameters['password'] ) ) { + $args['password'] = $parameters['password']; + $this->redis->auth( $parameters['password'] ); + } - if ( defined( $constant ) ) { - $parameters[ $setting ] = constant( $constant ); + if ( isset( $parameters['database'] ) ) { + if ( ctype_digit( $parameters['database'] ) ) { + $parameters['database'] = intval( $parameters['database'] ); } - } - if ( isset( $parameters['password'] ) ) { - $password = $parameters['password']; + $args['database'] = $parameters['database']; - if ( is_null( $password ) || $password === '' ) { - unset( $parameters['password'] ); + if ( $parameters['database'] ) { + $this->redis->select( $parameters['database'] ); } } - return $parameters; + $this->diagnostics += $args; } - /** - * Connect to Redis using the PhpRedis (PECL) extention. - * - * @param array $parameters Connection parameters built by the `build_parameters` method. - * @return void - */ - protected function connect_using_phpredis( $parameters ) { - $version = phpversion( 'redis' ); + if ( defined( 'WP_REDIS_SERIALIZER' ) && ! empty( WP_REDIS_SERIALIZER ) ) { + $this->redis->setOption( Redis::OPT_SERIALIZER, WP_REDIS_SERIALIZER ); + } + } - $this->diagnostics[ 'client' ] = sprintf( 'PhpRedis (v%s)', $version ); + /** + * Connect to Redis using the Predis library. + * + * @param array $parameters Connection parameters built by the `build_parameters` method. + * @throws \Exception If the Predis library was not found or is unreadable. + * @return void + */ + protected function connect_using_predis( $parameters ) { + $client = 'Predis'; - if ( defined( 'WP_REDIS_SHARDS' ) ) { - $this->redis = new RedisArray( array_values( WP_REDIS_SHARDS ) ); + // Load bundled Predis library. + if ( ! class_exists( 'Predis\Client' ) ) { + $predis = sprintf( + '%s/redis-cache/dependencies/predis/predis/autoload.php', + defined( 'WP_PLUGIN_DIR' ) ? WP_PLUGIN_DIR : WP_CONTENT_DIR . '/plugins' + ); - $this->diagnostics[ 'shards' ] = WP_REDIS_SHARDS; - } elseif ( defined( 'WP_REDIS_CLUSTER' ) ) { - $args = [ - 'cluster' => array_values( WP_REDIS_CLUSTER ), - 'timeout' => $parameters['timeout'], - 'read_timeout' => $parameters['read_timeout'], - ]; + if ( is_readable( $predis ) ) { + require_once $predis; + } else { + throw new Exception( + 'Predis library not found. Re-install Redis Cache plugin or delete the object-cache.php.' + ); + } + } - if ( isset( $parameters['password'] ) && version_compare( $version, '4.3.0', '>=' ) ) { - $args['password'] = $parameters['password']; - } + $options = array(); + + if ( defined( 'WP_REDIS_SHARDS' ) ) { + $parameters = WP_REDIS_SHARDS; + } elseif ( defined( 'WP_REDIS_SENTINEL' ) ) { + $parameters = WP_REDIS_SERVERS; + $options['replication'] = 'sentinel'; + $options['service'] = WP_REDIS_SENTINEL; + } elseif ( defined( 'WP_REDIS_SERVERS' ) ) { + $parameters = WP_REDIS_SERVERS; + $options['replication'] = true; + } elseif ( defined( 'WP_REDIS_CLUSTER' ) ) { + $parameters = WP_REDIS_CLUSTER; + $options['cluster'] = 'redis'; + } - $this->redis = new RedisCluster( null, ...array_values( $args ) ); + if ( isset( $parameters['read_timeout'] ) && $parameters['read_timeout'] ) { + $parameters['read_write_timeout'] = $parameters['read_timeout']; + } - $this->diagnostics += $args; - } else { - $this->redis = new Redis(); - - $args = [ - 'host' => $parameters['host'], - 'port' => $parameters['port'], - 'timeout' => $parameters['timeout'], - null, - 'retry_interval' => $parameters['retry_interval'], - ]; - - if ( strcasecmp( 'tls', $parameters['scheme'] ) === 0 ) { - $args['host'] = sprintf( - '%s://%s', - $parameters['scheme'], - str_replace( 'tls://', '', $parameters['host'] ) - ); + foreach ( array( 'WP_REDIS_SERVERS', 'WP_REDIS_SHARDS', 'WP_REDIS_CLUSTER' ) as $constant ) { + if ( defined( $constant ) ) { + if ( $parameters['database'] ) { + $options['parameters']['database'] = $parameters['database']; } - if ( strcasecmp( 'unix', $parameters['scheme'] ) === 0 ) { - $args['host'] = $parameters['path']; - $args['port'] = null; + if ( isset( $parameters['password'] ) ) { + $options['parameters']['password'] = WP_REDIS_PASSWORD; } + } + } - if ( version_compare( $version, '3.1.3', '>=' ) ) { - $args['read_timeout'] = $parameters['read_timeout']; - } + $this->redis = new Predis\Client( $parameters, $options ); + $this->redis->connect(); - call_user_func_array( [ $this->redis, 'connect' ], array_values( $args ) ); + $this->diagnostics = array_merge( + [ 'client' => sprintf( '%s (v%s)', $client, Predis\Client::VERSION ) ], + $parameters, + $options + ); + } - if ( isset( $parameters['password'] ) ) { - $args['password'] = $parameters['password']; - $this->redis->auth( $parameters['password'] ); - } + /** + * Connect to Redis using the Credis library. + * + * @param array $parameters Connection parameters built by the `build_parameters` method. + * @throws \Exception If the Credis library was not found or is unreadable. + * @throws \Exception If redis sharding should be configured as Credis does not support sharding. + * @throws \Exception If more than one seninel is configured as Credis does not support multiple sentinel servers. + * @return void + */ + protected function connect_using_credis( $parameters ) { + $client = 'Credis'; - if ( isset( $parameters['database'] ) ) { - if ( ctype_digit( $parameters['database'] ) ) { - $parameters['database'] = intval( $parameters['database'] ); - } + $creds_path = sprintf( + '%s/redis-cache/dependencies/colinmollenhour/credis/', + defined( 'WP_PLUGIN_DIR' ) ? WP_PLUGIN_DIR : WP_CONTENT_DIR . '/plugins' + ); - $args['database'] = $parameters['database']; + $to_load = []; - if ( $parameters['database'] ) { - $this->redis->select( $parameters['database'] ); - } - } - - $this->diagnostics += $args; - } - - if ( defined( 'WP_REDIS_SERIALIZER' ) && ! empty( WP_REDIS_SERIALIZER ) ) { - $this->redis->setOption( Redis::OPT_SERIALIZER, WP_REDIS_SERIALIZER ); - } + if ( ! class_exists( 'Credis_Client' ) ) { + $to_load[] = 'Client.php'; } - /** - * Connect to Redis using the Predis library. - * - * @param array $parameters Connection parameters built by the `build_parameters` method. - * @throws \Exception If the Predis library was not found or is unreadable. - * @return void - */ - protected function connect_using_predis( $parameters ) { - $client = 'Predis'; - - // Load bundled Predis library. - if ( ! class_exists( 'Predis\Client' ) ) { - $predis = sprintf( - '%s/redis-cache/dependencies/predis/predis/autoload.php', - defined( 'WP_PLUGIN_DIR' ) ? WP_PLUGIN_DIR : WP_CONTENT_DIR . '/plugins' - ); - - if ( is_readable( $predis ) ) { - require_once $predis; - } else { - throw new Exception( - 'Predis library not found. Re-install Redis Cache plugin or delete the object-cache.php.' - ); - } - } - - $options = array(); - - if ( defined( 'WP_REDIS_SHARDS' ) ) { - $parameters = WP_REDIS_SHARDS; - } elseif ( defined( 'WP_REDIS_SENTINEL' ) ) { - $parameters = WP_REDIS_SERVERS; - $options['replication'] = 'sentinel'; - $options['service'] = WP_REDIS_SENTINEL; - } elseif ( defined( 'WP_REDIS_SERVERS' ) ) { - $parameters = WP_REDIS_SERVERS; - $options['replication'] = true; - } elseif ( defined( 'WP_REDIS_CLUSTER' ) ) { - $parameters = WP_REDIS_CLUSTER; - $options['cluster'] = 'redis'; - } + if ( + ( defined( 'WP_REDIS_SHARDS' ) || defined( 'WP_REDIS_SENTINEL' ) || defined( 'WP_REDIS_SERVERS' ) || defined( 'WP_REDIS_CLUSTER' ) ) && + ! class_exists( 'Credis_Cluster' ) + ) { + $to_load[] = 'Cluster.php'; - if ( isset( $parameters['read_timeout'] ) && $parameters['read_timeout'] ) { - $parameters['read_write_timeout'] = $parameters['read_timeout']; + if ( defined( 'WP_REDIS_SENTINEL' ) && ! class_exists( 'Credis_Sentinel' ) ) { + $to_load[] = 'Sentinel.php'; } + } - foreach ( array( 'WP_REDIS_SERVERS', 'WP_REDIS_SHARDS', 'WP_REDIS_CLUSTER' ) as $constant ) { - if ( defined( $constant ) ) { - if ( $parameters['database'] ) { - $options['parameters']['database'] = $parameters['database']; - } + foreach ( $to_load as $sub_path ) { + $path = $creds_path . $sub_path; - if ( isset( $parameters['password'] ) ) { - $options['parameters']['password'] = WP_REDIS_PASSWORD; - } - } + if ( file_exists( $path ) ) { + require_once $path; + } else { + throw new Exception( + 'Credis library not found. Re-install Redis Cache plugin or delete object-cache.php.' + ); } - - $this->redis = new Predis\Client( $parameters, $options ); - $this->redis->connect(); - - $this->diagnostics = array_merge( - [ 'client' => sprintf( '%s (v%s)', $client, Predis\Client::VERSION ) ], - $parameters, - $options - ); } - /** - * Connect to Redis using the Credis library. - * - * @param array $parameters Connection parameters built by the `build_parameters` method. - * @throws \Exception If the Credis library was not found or is unreadable. - * @throws \Exception If redis sharding should be configured as Credis does not support sharding. - * @throws \Exception If more than one seninel is configured as Credis does not support multiple sentinel servers. - * @return void - */ - protected function connect_using_credis( $parameters ) { - $client = 'Credis'; - - $creds_path = sprintf( - '%s/redis-cache/dependencies/colinmollenhour/credis/', - defined( 'WP_PLUGIN_DIR' ) ? WP_PLUGIN_DIR : WP_CONTENT_DIR . '/plugins' + if ( defined( 'WP_REDIS_SHARDS' ) ) { + throw new Exception( + 'Sharding not supported by bundled Credis library. Please review your Redis Cache configuration.' ); + } - $to_load = []; - - if ( ! class_exists( 'Credis_Client' ) ) { - $to_load[] = 'Client.php'; + if ( defined( 'WP_REDIS_SENTINEL' ) ) { + if ( is_array( WP_REDIS_SERVERS ) && count( WP_REDIS_SERVERS ) > 1 ) { + throw new Exception( + 'Multipe sentinel servers are not supported by the bundled Credis library. Please review your Redis Cache configuration.' + ); } - if ( - ( defined( 'WP_REDIS_SHARDS' ) || defined( 'WP_REDIS_SENTINEL' ) || defined( 'WP_REDIS_SERVERS' ) || defined( 'WP_REDIS_CLUSTER' ) ) && - ! class_exists( 'Credis_Cluster' ) - ) { - $to_load[] = 'Cluster.php'; + $connection_string = array_values( WP_REDIS_SERVERS )[0]; + $sentinel = new Credis_Sentinel( new Credis_Client( $connection_string ) ); + $this->redis = $sentinel->getCluster( WP_REDIS_SENTINEL ); + $args['servers'] = WP_REDIS_SERVERS; + } elseif ( defined( 'WP_REDIS_CLUSTER' ) || defined( 'WP_REDIS_SERVERS' ) ) { + $parameters['db'] = $parameters['database']; - if ( defined( 'WP_REDIS_SENTINEL' ) && ! class_exists( 'Credis_Sentinel' ) ) { - $to_load[] = 'Sentinel.php'; - } - } + $is_cluster = defined( 'WP_REDIS_CLUSTER' ); + $clients = $is_cluster ? WP_REDIS_CLUSTER : WP_REDIS_SERVERS; - foreach ( $to_load as $sub_path ) { - $path = $creds_path . $sub_path; + foreach ( $clients as $index => &$connection_string ) { + $url_components = wp_parse_url( $connection_string ); + parse_str( $url_components['query'], $add_params ); - if ( file_exists( $path ) ) { - require_once $path; - } else { - throw new Exception( - 'Credis library not found. Re-install Redis Cache plugin or delete object-cache.php.' - ); + if ( ! $is_cluster && isset( $add_params['alias'] ) ) { + $add_params['master'] = 'master' === $add_params['alias']; } - } - if ( defined( 'WP_REDIS_SHARDS' ) ) { - throw new Exception( - 'Sharding not supported by bundled Credis library. Please review your Redis Cache configuration.' - ); - } + $add_params['host'] = $url_components['host']; - if ( defined( 'WP_REDIS_SENTINEL' ) ) { - if ( is_array( WP_REDIS_SERVERS ) && count( WP_REDIS_SERVERS ) > 1 ) { - throw new Exception( - 'Multipe sentinel servers are not supported by the bundled Credis library. Please review your Redis Cache configuration.' - ); + if ( ! isset( $add_params['alias'] ) ) { + $add_params['alias'] = "redis-$index"; } - $connection_string = array_values( WP_REDIS_SERVERS )[0]; - $sentinel = new Credis_Sentinel( new Credis_Client( $connection_string ) ); - $this->redis = $sentinel->getCluster( WP_REDIS_SENTINEL ); - $args['servers'] = WP_REDIS_SERVERS; - } elseif ( defined( 'WP_REDIS_CLUSTER' ) || defined( 'WP_REDIS_SERVERS' ) ) { - $parameters['db'] = $parameters['database']; - - $is_cluster = defined( 'WP_REDIS_CLUSTER' ); - $clients = $is_cluster ? WP_REDIS_CLUSTER : WP_REDIS_SERVERS; + $connection_string = array_merge( $parameters, $add_params ); + } - foreach ( $clients as $index => &$connection_string ) { - $url_components = wp_parse_url( $connection_string ); - parse_str( $url_components['query'], $add_params ); + $this->redis = new Credis_Cluster( $clients ); - if ( ! $is_cluster && isset( $add_params['alias'] ) ) { - $add_params['master'] = 'master' === $add_params['alias']; - } + $args['servers'] = $clients; + } else { + $args = [ + 'host' => $parameters['scheme'] === 'unix' ? $parameters['path'] : $parameters['host'], + 'port' => $parameters['port'], + 'timeout' => $parameters['timeout'], + 'persistent' => null, + 'database' => $parameters['database'], + 'password' => isset( $parameters['password'] ) ? $parameters['password'] : null, + ]; - $add_params['host'] = $url_components['host']; + $this->redis = new Credis_Client( ...array_values( $args ) ); + } - if ( ! isset( $add_params['alias'] ) ) { - $add_params['alias'] = "redis-$index"; - } + // Don't use PhpRedis if it is available. + $this->redis->forceStandalone(); - $connection_string = array_merge( $parameters, $add_params ); - } + $this->redis->connect(); - $this->redis = new Credis_Cluster( $clients ); + if ( $parameters['read_timeout'] ) { + $args['read_timeout'] = $parameters['read_timeout']; + $this->redis->setReadTimeout( $parameters['read_timeout'] ); + } - $args['servers'] = $clients; - } else { - $args = [ - 'host' => $parameters['scheme'] === 'unix' ? $parameters['path'] : $parameters['host'], - 'port' => $parameters['port'], - 'timeout' => $parameters['timeout'], - 'persistent' => null, - 'database' => $parameters['database'], - 'password' => isset( $parameters['password'] ) ? $parameters['password'] : null, - ]; - - $this->redis = new Credis_Client( ...array_values( $args ) ); - } + $this->diagnostics = array_merge( + [ 'client' => sprintf( '%s (v%s)', $client, Credis_Client::VERSION ) ], + $args + ); + } - // Don't use PhpRedis if it is available. - $this->redis->forceStandalone(); + /** + * Connect to Redis using HHVM's Redis extention. + * + * @param array $parameters Connection parameters built by the `build_parameters` method. + * @return void + */ + protected function connect_using_hhvm( $parameters ) { + $this->redis = new Redis(); - $this->redis->connect(); + // Adjust host and port if the scheme is `unix`. + if ( strcasecmp( 'unix', $parameters['scheme'] ) === 0 ) { + $parameters['host'] = 'unix://' . $parameters['path']; + $parameters['port'] = 0; + } - if ( $parameters['read_timeout'] ) { - $args['read_timeout'] = $parameters['read_timeout']; - $this->redis->setReadTimeout( $parameters['read_timeout'] ); - } + $this->redis->connect( + $parameters['host'], + $parameters['port'], + $parameters['timeout'], + null, + $parameters['retry_interval'] + ); - $this->diagnostics = array_merge( - [ 'client' => sprintf( '%s (v%s)', $client, Credis_Client::VERSION ) ], - $args - ); + if ( $parameters['read_timeout'] ) { + $this->redis->setOption( Redis::OPT_READ_TIMEOUT, $parameters['read_timeout'] ); } - /** - * Connect to Redis using HHVM's Redis extention. - * - * @param array $parameters Connection parameters built by the `build_parameters` method. - * @return void - */ - protected function connect_using_hhvm( $parameters ) { - $this->redis = new Redis(); + if ( isset( $parameters['password'] ) ) { + $this->redis->auth( $parameters['password'] ); + } - // Adjust host and port if the scheme is `unix`. - if ( strcasecmp( 'unix', $parameters['scheme'] ) === 0 ) { - $parameters['host'] = 'unix://' . $parameters['path']; - $parameters['port'] = 0; + if ( isset( $parameters['database'] ) ) { + if ( ctype_digit( $parameters['database'] ) ) { + $parameters['database'] = intval( $parameters['database'] ); } - $this->redis->connect( - $parameters['host'], - $parameters['port'], - $parameters['timeout'], - null, - $parameters['retry_interval'] - ); - - if ( $parameters['read_timeout'] ) { - $this->redis->setOption( Redis::OPT_READ_TIMEOUT, $parameters['read_timeout'] ); + if ( $parameters['database'] ) { + $this->redis->select( $parameters['database'] ); } + } - if ( isset( $parameters['password'] ) ) { - $this->redis->auth( $parameters['password'] ); - } + $this->diagnostics = array_merge( + [ 'client' => sprintf( 'HHVM Extension (v%s)', HHVM_VERSION ) ], + $parameters + ); + } - if ( isset( $parameters['database'] ) ) { - if ( ctype_digit( $parameters['database'] ) ) { - $parameters['database'] = intval( $parameters['database'] ); - } + /** + * Fetches Redis `INFO` mostly for server version. + * + * @return void + */ + public function fetch_info() { + $options = method_exists( $this->redis, 'getOptions' ) + ? $this->redis->getOptions() + : new stdClass(); - if ( $parameters['database'] ) { - $this->redis->select( $parameters['database'] ); - } - } + if ( isset( $options->replication ) && $options->replication ) { + return; + } - $this->diagnostics = array_merge( - [ 'client' => sprintf( 'HHVM Extension (v%s)', HHVM_VERSION ) ], - $parameters - ); + if ( defined( 'WP_REDIS_CLUSTER' ) ) { + $info = $this->redis->info( current( array_values( WP_REDIS_CLUSTER ) ) ); + } else { + $info = $this->redis->info(); } - /** - * Fetches Redis `INFO` mostly for server version. - * - * @return void - */ - public function fetch_info() { - $options = method_exists( $this->redis, 'getOptions' ) - ? $this->redis->getOptions() - : new stdClass(); + if ( isset( $info['redis_version'] ) ) { + $this->redis_version = $info['redis_version']; + } elseif ( isset( $info['Server']['redis_version'] ) ) { + $this->redis_version = $info['Server']['redis_version']; + } + } - if ( isset( $options->replication ) && $options->replication ) { - return; - } + /** + * Is Redis available? + * + * @return bool + */ + public function redis_status() { + return (bool) $this->redis_connected; + } - if ( defined( 'WP_REDIS_CLUSTER' ) ) { - $info = $this->redis->info( current( array_values( WP_REDIS_CLUSTER ) ) ); - } else { - $info = $this->redis->info(); - } + /** + * Returns the Redis instance. + * + * @return mixed + */ + public function redis_instance() { + return $this->redis; + } - if ( isset( $info['redis_version'] ) ) { - $this->redis_version = $info['redis_version']; - } elseif ( isset( $info['Server']['redis_version'] ) ) { - $this->redis_version = $info['Server']['redis_version']; - } - } + /** + * Returns the Redis server version. + * + * @return null|string + */ + public function redis_version() { + return $this->redis_version; + } - /** - * Is Redis available? - * - * @return bool - */ - public function redis_status() { - return (bool) $this->redis_connected; - } - - /** - * Returns the Redis instance. - * - * @return mixed - */ - public function redis_instance() { - return $this->redis; - } - - /** - * Returns the Redis server version. - * - * @return null|string - */ - public function redis_version() { - return $this->redis_version; - } - - /** - * Adds a value to cache. - * - * If the specified key already exists, the value is not stored and the function - * returns false. - * - * @param string $key The key under which to store the value. - * @param mixed $value The value to store. - * @param string $group The group value appended to the $key. - * @param int $expiration The expiration time, defaults to 0. - * @return bool Returns TRUE on success or FALSE on failure. - */ - public function add( $key, $value, $group = 'default', $expiration = 0 ) { - return $this->add_or_replace( true, $key, $value, $group, $expiration ); - } - - /** - * Replace a value in the cache. - * - * If the specified key doesn't exist, the value is not stored and the function - * returns false. - * - * @param string $key The key under which to store the value. - * @param mixed $value The value to store. - * @param string $group The group value appended to the $key. - * @param int $expiration The expiration time, defaults to 0. - * @return bool Returns TRUE on success or FALSE on failure. - */ - public function replace( $key, $value, $group = 'default', $expiration = 0 ) { - return $this->add_or_replace( false, $key, $value, $group, $expiration ); - } - - /** - * Add or replace a value in the cache. - * - * Add does not set the value if the key exists; replace does not replace if the value doesn't exist. - * - * @param bool $add True if should only add if value doesn't exist, false to only add when value already exists. - * @param string $key The key under which to store the value. - * @param mixed $value The value to store. - * @param string $group The group value appended to the $key. - * @param int $expiration The expiration time, defaults to 0. - * @return bool Returns TRUE on success or FALSE on failure. - */ - protected function add_or_replace( $add, $key, $value, $group = 'default', $expiration = 0 ) { - $cache_addition_suspended = function_exists( 'wp_suspend_cache_addition' ) - ? wp_suspend_cache_addition() - : false; - - if ( $add && $cache_addition_suspended ) { - return false; - } + /** + * Adds a value to cache. + * + * If the specified key already exists, the value is not stored and the function + * returns false. + * + * @param string $key The key under which to store the value. + * @param mixed $value The value to store. + * @param string $group The group value appended to the $key. + * @param int $expiration The expiration time, defaults to 0. + * @return bool Returns TRUE on success or FALSE on failure. + */ + public function add( $key, $value, $group = 'default', $expiration = 0 ) { + return $this->add_or_replace( true, $key, $value, $group, $expiration ); + } - $result = true; - $derived_key = $this->build_key( $key, $group ); + /** + * Replace a value in the cache. + * + * If the specified key doesn't exist, the value is not stored and the function + * returns false. + * + * @param string $key The key under which to store the value. + * @param mixed $value The value to store. + * @param string $group The group value appended to the $key. + * @param int $expiration The expiration time, defaults to 0. + * @return bool Returns TRUE on success or FALSE on failure. + */ + public function replace( $key, $value, $group = 'default', $expiration = 0 ) { + return $this->add_or_replace( false, $key, $value, $group, $expiration ); + } - // Save if group not excluded and redis is up. - if ( ! $this->is_ignored_group( $group ) && $this->redis_status() ) { - try { - $expiration = apply_filters( 'redis_cache_expiration', $this->validate_expiration( $expiration ), $key, $group ); - $start_time = microtime( true ); + /** + * Add or replace a value in the cache. + * + * Add does not set the value if the key exists; replace does not replace if the value doesn't exist. + * + * @param bool $add True if should only add if value doesn't exist, false to only add when value already exists. + * @param string $key The key under which to store the value. + * @param mixed $value The value to store. + * @param string $group The group value appended to the $key. + * @param int $expiration The expiration time, defaults to 0. + * @return bool Returns TRUE on success or FALSE on failure. + */ + protected function add_or_replace( $add, $key, $value, $group = 'default', $expiration = 0 ) { + $cache_addition_suspended = function_exists( 'wp_suspend_cache_addition' ) + ? wp_suspend_cache_addition() + : false; - if ( $add ) { - $args = [ $derived_key, $this->maybe_serialize( $value ) ]; + if ( $add && $cache_addition_suspended ) { + return false; + } - if ( $this->redis instanceof Predis\Client ) { - $args[] = 'nx'; + $result = true; + $derived_key = $this->build_key( $key, $group ); - if ( $expiration ) { - $args[] = 'ex'; - $args[] = $expiration; - } - } else { - if ( $expiration ) { - $args[] = [ - 'nx', - 'ex' => $expiration, - ]; - } else { - $args[] = [ 'nx' ]; - } - } + // Save if group not excluded and redis is up. + if ( ! $this->is_ignored_group( $group ) && $this->redis_status() ) { + try { + $expiration = apply_filters( 'redis_cache_expiration', $this->validate_expiration( $expiration ), $key, $group ); + $start_time = microtime( true ); + + if ( $add ) { + $args = [ $derived_key, $this->maybe_serialize( $value ) ]; - $result = $this->parse_redis_response( - $this->redis->set( ...$args ) - ); + if ( $this->redis instanceof Predis\Client ) { + $args[] = 'nx'; - if ( ! $result ) { - return false; + if ( $expiration ) { + $args[] = 'ex'; + $args[] = $expiration; } - } elseif ( $expiration ) { - $result = $this->parse_redis_response( $this->redis->setex( $derived_key, $expiration, $this->maybe_serialize( $value ) ) ); } else { - $result = $this->parse_redis_response( $this->redis->set( $derived_key, $this->maybe_serialize( $value ) ) ); + if ( $expiration ) { + $args[] = [ + 'nx', + 'ex' => $expiration, + ]; + } else { + $args[] = [ 'nx' ]; + } } - $execute_time = microtime( true ) - $start_time; - - $this->cache_calls++; - $this->cache_time += $execute_time; - } catch ( Exception $exception ) { - $this->handle_exception( $exception ); + $result = $this->parse_redis_response( + $this->redis->set( ...$args ) + ); - return false; + if ( ! $result ) { + return false; + } + } elseif ( $expiration ) { + $result = $this->parse_redis_response( $this->redis->setex( $derived_key, $expiration, $this->maybe_serialize( $value ) ) ); + } else { + $result = $this->parse_redis_response( $this->redis->set( $derived_key, $this->maybe_serialize( $value ) ) ); } - } - $exists = isset( $this->cache[ $derived_key ] ); + $execute_time = microtime( true ) - $start_time; + + $this->cache_calls++; + $this->cache_time += $execute_time; + } catch ( Exception $exception ) { + $this->handle_exception( $exception ); - if ( (bool) $add === $exists ) { return false; } + } - if ( $result ) { - $this->add_to_internal_cache( $derived_key, $value ); - } + $exists = isset( $this->cache[ $derived_key ] ); - return $result; + if ( (bool) $add === $exists ) { + return false; } - /** - * Remove the item from the cache. - * - * @param string $key The key under which to store the value. - * @param string $group The group value appended to the $key. - * @return bool Returns TRUE on success or FALSE on failure. - */ - public function delete( $key, $group = 'default' ) { - $result = false; - $derived_key = $this->build_key( $key, $group ); - - if ( isset( $this->cache[ $derived_key ] ) ) { - unset( $this->cache[ $derived_key ] ); - $result = true; - } + if ( $result ) { + $this->add_to_internal_cache( $derived_key, $value ); + } - $start_time = microtime( true ); + return $result; + } - if ( $this->redis_status() && ! $this->is_ignored_group( $group ) ) { - try { - $result = $this->parse_redis_response( $this->redis->del( $derived_key ) ); - } catch ( Exception $exception ) { - $this->handle_exception( $exception ); + /** + * Remove the item from the cache. + * + * @param string $key The key under which to store the value. + * @param string $group The group value appended to the $key. + * @return bool Returns TRUE on success or FALSE on failure. + */ + public function delete( $key, $group = 'default' ) { + $result = false; + $derived_key = $this->build_key( $key, $group ); - return false; - } - } + if ( isset( $this->cache[ $derived_key ] ) ) { + unset( $this->cache[ $derived_key ] ); + $result = true; + } - $execute_time = microtime( true ) - $start_time; + $start_time = microtime( true ); - $this->cache_calls++; - $this->cache_time += $execute_time; + if ( $this->redis_status() && ! $this->is_ignored_group( $group ) ) { + try { + $result = $this->parse_redis_response( $this->redis->del( $derived_key ) ); + } catch ( Exception $exception ) { + $this->handle_exception( $exception ); - if ( function_exists( 'do_action' ) ) { - do_action( 'redis_object_cache_delete', $key, $group, $execute_time ); + return false; } + } - return (bool) $result; + $execute_time = microtime( true ) - $start_time; + + $this->cache_calls++; + $this->cache_time += $execute_time; + + if ( function_exists( 'do_action' ) ) { + do_action( 'redis_object_cache_delete', $key, $group, $execute_time ); } - /** - * Invalidate all items in the cache. If `WP_REDIS_SELECTIVE_FLUSH` is `true`, - * only keys prefixed with the `WP_REDIS_PREFIX` are flushed. - * - * @param int $delay Number of seconds to wait before invalidating the items. - * @return bool Returns TRUE on success or FALSE on failure. - */ - public function flush( $delay = 0 ) { - $delay = abs( intval( $delay ) ); + return (bool) $result; + } - if ( $delay ) { - sleep( $delay ); - } + /** + * Invalidate all items in the cache. If `WP_REDIS_SELECTIVE_FLUSH` is `true`, + * only keys prefixed with the `WP_REDIS_PREFIX` are flushed. + * + * @param int $delay Number of seconds to wait before invalidating the items. + * @return bool Returns TRUE on success or FALSE on failure. + */ + public function flush( $delay = 0 ) { + $delay = abs( intval( $delay ) ); - $results = []; - $this->cache = array(); + if ( $delay ) { + sleep( $delay ); + } - if ( $this->redis_status() ) { - $salt = defined( 'WP_REDIS_PREFIX' ) ? trim( WP_REDIS_PREFIX ) : null; - $selective = defined( 'WP_REDIS_SELECTIVE_FLUSH' ) ? WP_REDIS_SELECTIVE_FLUSH : null; + $results = []; + $this->cache = array(); - $start_time = microtime( true ); + if ( $this->redis_status() ) { + $salt = defined( 'WP_REDIS_PREFIX' ) ? trim( WP_REDIS_PREFIX ) : null; + $selective = defined( 'WP_REDIS_SELECTIVE_FLUSH' ) ? WP_REDIS_SELECTIVE_FLUSH : null; - if ( $salt && $selective ) { - $script = $this->get_flush_closure( $salt ); - - if ( defined( 'WP_REDIS_CLUSTER' ) ) { - try { - foreach ( $this->redis->_masters() as $master ) { - $redis = new Redis(); - $redis->connect( $master[0], $master[1] ); - $results[] = $this->parse_redis_response( $script() ); - unset( $redis ); - } - } catch ( Exception $exception ) { - $this->handle_exception( $exception ); - - return false; - } - } else { - try { - $results[] = $this->parse_redis_response( $script() ); - } catch ( Exception $exception ) { - $this->handle_exception( $exception ); + $start_time = microtime( true ); + + if ( $salt && $selective ) { + $script = $this->get_flush_closure( $salt ); - return false; + if ( defined( 'WP_REDIS_CLUSTER' ) ) { + try { + foreach ( $this->redis->_masters() as $master ) { + $redis = new Redis(); + $redis->connect( $master[0], $master[1] ); + $results[] = $this->parse_redis_response( $script() ); + unset( $redis ); } + } catch ( Exception $exception ) { + $this->handle_exception( $exception ); + + return false; } } else { - if ( defined( 'WP_REDIS_CLUSTER' ) ) { - try { - foreach ( $this->redis->_masters() as $master ) { - $results[] = $this->parse_redis_response( $this->redis->flushdb( $master ) ); - } - } catch ( Exception $exception ) { - $this->handle_exception( $exception ); - - return false; - } - } else { - try { - $results[] = $this->parse_redis_response( $this->redis->flushdb() ); - } catch ( Exception $exception ) { - $this->handle_exception( $exception ); + try { + $results[] = $this->parse_redis_response( $script() ); + } catch ( Exception $exception ) { + $this->handle_exception( $exception ); - return false; - } + return false; } } + } else { + if ( defined( 'WP_REDIS_CLUSTER' ) ) { + try { + foreach ( $this->redis->_masters() as $master ) { + $results[] = $this->parse_redis_response( $this->redis->flushdb( $master ) ); + } + } catch ( Exception $exception ) { + $this->handle_exception( $exception ); - if ( function_exists( 'do_action' ) ) { - $execute_time = microtime( true ) - $start_time; + return false; + } + } else { + try { + $results[] = $this->parse_redis_response( $this->redis->flushdb() ); + } catch ( Exception $exception ) { + $this->handle_exception( $exception ); - do_action( 'redis_object_cache_flush', $results, $delay, $selective, $salt, $execute_time ); + return false; + } } } - if ( empty( $results ) ) { - return false; - } + if ( function_exists( 'do_action' ) ) { + $execute_time = microtime( true ) - $start_time; - foreach ( $results as $result ) { - if ( ! $result ) { - return false; - } + do_action( 'redis_object_cache_flush', $results, $delay, $selective, $salt, $execute_time ); } + } - return true; + if ( empty( $results ) ) { + return false; } - /** - * Returns a closure to flush selectively. - * - * @param string $salt The salt to be used to differentiate. - * @return callable Generated callable executing the lua script. - */ - protected function get_flush_closure( $salt ) { - if ( $this->unflushable_groups ) { - return $this->lua_flush_extended_closure( $salt ); - } else { - return $this->lua_flush_closure( $salt ); + foreach ( $results as $result ) { + if ( ! $result ) { + return false; } } - /** - * Quotes a string for usage in the `glob` function - * - * @param string $string The string to quote. - * @return string - */ - protected function glob_quote( $string ) { - $characters = [ '*', '+', '?', '!', '{', '}', '[', ']', '(', ')', '|', '@' ]; - - return str_replace( - $characters, - array_map( - function ( $character ) { - return "[{$character}]"; - }, - $characters - ), - $string - ); + return true; + } + + /** + * Returns a closure to flush selectively. + * + * @param string $salt The salt to be used to differentiate. + * @return callable Generated callable executing the lua script. + */ + protected function get_flush_closure( $salt ) { + if ( $this->unflushable_groups ) { + return $this->lua_flush_extended_closure( $salt ); + } else { + return $this->lua_flush_closure( $salt ); } + } - /** - * Returns a closure ready to be called to flush selectively ignoring unflushable groups. - * - * @param string $salt The salt to be used to differentiate. - * @return callable Generated callable executing the lua script. - */ - protected function lua_flush_closure( $salt ) { - $salt = $this->glob_quote( $salt ); - - return function () use ( $salt ) { - $script = <<glob_quote( $salt ); + + return function () use ( $salt ) { + $script = <<redis_version(), '5', '<' ) && version_compare( $this->redis_version(), '3.2', '>=' ) ) { - $script = 'redis.replicate_commands()' . "\n" . $script; - } + if ( version_compare( $this->redis_version(), '5', '<' ) && version_compare( $this->redis_version(), '3.2', '>=' ) ) { + $script = 'redis.replicate_commands()' . "\n" . $script; + } - $args = ( $this->redis instanceof Predis\Client ) - ? [ $script, 0 ] - : [ $script ]; + $args = ( $this->redis instanceof Predis\Client ) + ? [ $script, 0 ] + : [ $script ]; - return call_user_func_array( [ $this->redis, 'eval' ], $args ); - }; - } + return call_user_func_array( [ $this->redis, 'eval' ], $args ); + }; + } - /** - * Returns a closure ready to be called to flush selectively. - * - * @param string $salt The salt to be used to differentiate. - * @return callable Generated callable executing the lua script. - */ - protected function lua_flush_extended_closure( $salt ) { - $salt = $this->glob_quote( $salt ); + /** + * Returns a closure ready to be called to flush selectively. + * + * @param string $salt The salt to be used to differentiate. + * @return callable Generated callable executing the lua script. + */ + protected function lua_flush_extended_closure( $salt ) { + $salt = $this->glob_quote( $salt ); - return function () use ( $salt ) { - $salt_length = strlen( $salt ); + return function () use ( $salt ) { + $salt_length = strlen( $salt ); - $unflushable = array_map( - function ( $group ) { - return ":{$group}:"; - }, - $this->unflushable_groups - ); + $unflushable = array_map( + function ( $group ) { + return ":{$group}:"; + }, + $this->unflushable_groups + ); - $script = <<redis_version(), '5', '<' ) && version_compare( $this->redis_version(), '3.2', '>=' ) ) { - $script = 'redis.replicate_commands()' . "\n" . $script; - } + if ( version_compare( $this->redis_version(), '5', '<' ) && version_compare( $this->redis_version(), '3.2', '>=' ) ) { + $script = 'redis.replicate_commands()' . "\n" . $script; + } - $args = ( $this->redis instanceof Predis\Client ) - ? array_merge( [ $script, count( $unflushable ) ], $unflushable ) - : [ $script, $unflushable, count( $unflushable ) ]; - - return call_user_func_array( [ $this->redis, 'eval' ], $args ); - }; - } - - /** - * Retrieve object from cache. - * - * Gets an object from cache based on $key and $group. - * - * @param string $key The key under which to store the value. - * @param string $group The group value appended to the $key. - * @param string $force Optional. Whether to force a refetch rather than relying on the local - * cache. Default false. - * @param bool $found Optional. Whether the key was found in the cache. Disambiguates a return of - * false, a storable value. Passed by reference. Default null. - * @return bool|mixed Cached object value. - */ - public function get( $key, $group = 'default', $force = false, &$found = null ) { - $derived_key = $this->build_key( $key, $group ); - - if ( isset( $this->cache[ $derived_key ] ) && ! $force ) { - $found = true; - $this->cache_hits++; + $args = ( $this->redis instanceof Predis\Client ) + ? array_merge( [ $script, count( $unflushable ) ], $unflushable ) + : [ $script, $unflushable, count( $unflushable ) ]; - return $this->get_from_internal_cache( $derived_key ); - } elseif ( $this->is_ignored_group( $group ) || ! $this->redis_status() ) { - $found = false; - $this->cache_misses++; + return call_user_func_array( [ $this->redis, 'eval' ], $args ); + }; + } - return false; - } - - $start_time = microtime( true ); + /** + * Retrieve object from cache. + * + * Gets an object from cache based on $key and $group. + * + * @param string $key The key under which to store the value. + * @param string $group The group value appended to the $key. + * @param string $force Optional. Whether to force a refetch rather than relying on the local + * cache. Default false. + * @param bool $found Optional. Whether the key was found in the cache. Disambiguates a return of + * false, a storable value. Passed by reference. Default null. + * @return bool|mixed Cached object value. + */ + public function get( $key, $group = 'default', $force = false, &$found = null ) { + $derived_key = $this->build_key( $key, $group ); - try { - $result = $this->redis->get( $derived_key ); - } catch ( Exception $exception ) { - $this->handle_exception( $exception ); + if ( isset( $this->cache[ $derived_key ] ) && ! $force ) { + $found = true; + $this->cache_hits++; - return false; - } + return $this->get_from_internal_cache( $derived_key ); + } elseif ( $this->is_ignored_group( $group ) || ! $this->redis_status() ) { + $found = false; + $this->cache_misses++; - $execute_time = microtime( true ) - $start_time; + return false; + } - $this->cache_calls++; - $this->cache_time += $execute_time; + $start_time = microtime( true ); - if ( $result === null || $result === false ) { - $found = false; - $this->cache_misses++; + try { + $result = $this->redis->get( $derived_key ); + } catch ( Exception $exception ) { + $this->handle_exception( $exception ); - return false; - } else { - $found = true; - $this->cache_hits++; - $value = $this->maybe_unserialize( $result ); - } + return false; + } - $this->add_to_internal_cache( $derived_key, $value ); + $execute_time = microtime( true ) - $start_time; - if ( function_exists( 'do_action' ) ) { - do_action( 'redis_object_cache_get', $key, $value, $group, $force, $found, $execute_time ); - } + $this->cache_calls++; + $this->cache_time += $execute_time; - if ( function_exists( 'apply_filters' ) && function_exists( 'has_filter' ) ) { - if ( has_filter( 'redis_object_cache_get_value' ) ) { - return apply_filters( 'redis_object_cache_get_value', $value, $key, $group, $force, $found ); - } - } + if ( $result === null || $result === false ) { + $found = false; + $this->cache_misses++; - return $value; + return false; + } else { + $found = true; + $this->cache_hits++; + $value = $this->maybe_unserialize( $result ); } - /** - * Retrieves multiple values from the cache in one call. - * - * @param array $keys Array of keys under which the cache contents are stored. - * @param string $group Optional. Where the cache contents are grouped. Default empty. - * @param bool $force Optional. Whether to force an update of the local cache - * from the persistent cache. Default false. - * @return array Array of values organized into groups. - */ - public function get_multiple( $keys, $group = 'default', $force = false ) { - if ( ! is_array( $keys ) ) { - return false; - } - - $cache = array(); - $derived_keys = array(); - - foreach ( $keys as $key ) { - $derived_keys[ $key ] = $this->build_key( $key, $group ); - } + $this->add_to_internal_cache( $derived_key, $value ); - if ( $this->is_ignored_group( $group ) || ! $this->redis_status() ) { - foreach ( $keys as $key ) { - $cache[ $key ] = $this->get_from_internal_cache( $derived_keys[ $key ] ); - $cache[ $key ] === false ? $this->cache_misses++ : $this->cache_hits++; - } + if ( function_exists( 'do_action' ) ) { + do_action( 'redis_object_cache_get', $key, $value, $group, $force, $found, $execute_time ); + } - return $cache; + if ( function_exists( 'apply_filters' ) && function_exists( 'has_filter' ) ) { + if ( has_filter( 'redis_object_cache_get_value' ) ) { + return apply_filters( 'redis_object_cache_get_value', $value, $key, $group, $force, $found ); } + } - if ( ! $force ) { - foreach ( $keys as $key ) { - $value = $this->get_from_internal_cache( $derived_keys[ $key ] ); - - if ( $value === false ) { - $this->cache_misses++; - } else { - $cache[ $key ] = $value; - $this->cache_hits++; - } - } - } - - $remaining_keys = array_filter( - $keys, - function ( $key ) use ( $cache ) { - return ! isset( $cache[ $key ] ); - } - ); - - if ( empty( $remaining_keys ) ) { - return $cache; - } + return $value; + } - $start_time = microtime( true ); + /** + * Retrieves multiple values from the cache in one call. + * + * @param array $keys Array of keys under which the cache contents are stored. + * @param string $group Optional. Where the cache contents are grouped. Default empty. + * @param bool $force Optional. Whether to force an update of the local cache + * from the persistent cache. Default false. + * @return array Array of values organized into groups. + */ + public function get_multiple( $keys, $group = 'default', $force = false ) { + if ( ! is_array( $keys ) ) { + return false; + } - try { - $remaining_ids = array_map( - function ( $key ) use ( $derived_keys ) { - return $derived_keys[ $key ]; - }, - $remaining_keys - ); + $cache = array(); + $derived_keys = array(); - $results = array_combine( - $remaining_keys, - $this->redis->mget( $remaining_ids ) - ); - } catch ( Exception $exception ) { - $this->handle_exception( $exception ); + foreach ( $keys as $key ) { + $derived_keys[ $key ] = $this->build_key( $key, $group ); + } - $cache = array_fill( 0, count( $derived_keys ) - 1, false ); + if ( $this->is_ignored_group( $group ) || ! $this->redis_status() ) { + foreach ( $keys as $key ) { + $cache[ $key ] = $this->get_from_internal_cache( $derived_keys[ $key ] ); + $cache[ $key ] === false ? $this->cache_misses++ : $this->cache_hits++; } - $execute_time = microtime( true ) - $start_time; + return $cache; + } - $this->cache_calls++; - $this->cache_time += $execute_time; + if ( ! $force ) { + foreach ( $keys as $key ) { + $value = $this->get_from_internal_cache( $derived_keys[ $key ] ); - foreach ( $results as $key => $value ) { - if ( $value === null || $value === false ) { - $cache[ $key ] = false; + if ( $value === false ) { $this->cache_misses++; } else { - $cache[ $key ] = $this->maybe_unserialize( $value ); - $this->add_to_internal_cache( $derived_keys[ $key ], $cache[ $key ] ); - + $cache[ $key ] = $value; $this->cache_hits++; } } + } - if ( function_exists( 'do_action' ) ) { - do_action( 'redis_object_cache_get_multiple', $keys, $cache, $group, $force, $execute_time ); - } - - if ( function_exists( 'apply_filters' ) && function_exists( 'has_filter' ) ) { - if ( has_filter( 'redis_object_cache_get_value' ) ) { - foreach ( $cache as $key => $value ) { - $cache[ $key ] = apply_filters( 'redis_object_cache_get_value', $value, $key, $group, $force ); - } - } + $remaining_keys = array_filter( + $keys, + function ( $key ) use ( $cache ) { + return ! isset( $cache[ $key ] ); } + ); + if ( empty( $remaining_keys ) ) { return $cache; } - /** - * Sets a value in cache. - * - * The value is set whether or not this key already exists in Redis. - * - * @param string $key The key under which to store the value. - * @param mixed $value The value to store. - * @param string $group The group value appended to the $key. - * @param int $expiration The expiration time, defaults to 0. - * @return bool Returns TRUE on success or FALSE on failure. - */ - public function set( $key, $value, $group = 'default', $expiration = 0 ) { - $result = true; - $derived_key = $this->build_key( $key, $group ); + $start_time = microtime( true ); - $start_time = microtime( true ); + try { + $remaining_ids = array_map( + function ( $key ) use ( $derived_keys ) { + return $derived_keys[ $key ]; + }, + $remaining_keys + ); - // Save if group not excluded from redis and redis is up. - if ( ! $this->is_ignored_group( $group ) && $this->redis_status() ) { - $expiration = apply_filters( 'redis_cache_expiration', $this->validate_expiration( $expiration ), $key, $group ); + $results = array_combine( + $remaining_keys, + $this->redis->mget( $remaining_ids ) + ); + } catch ( Exception $exception ) { + $this->handle_exception( $exception ); - try { - if ( $expiration ) { - $result = $this->parse_redis_response( $this->redis->setex( $derived_key, $expiration, $this->maybe_serialize( $value ) ) ); - } else { - $result = $this->parse_redis_response( $this->redis->set( $derived_key, $this->maybe_serialize( $value ) ) ); - } - } catch ( Exception $exception ) { - $this->handle_exception( $exception ); + $cache = array_fill( 0, count( $derived_keys ) - 1, false ); + } - return false; - } + $execute_time = microtime( true ) - $start_time; - $this->cache_calls++; - $this->cache_time += ( microtime( true ) - $start_time ); - } + $this->cache_calls++; + $this->cache_time += $execute_time; + + foreach ( $results as $key => $value ) { + if ( $value === null || $value === false ) { + $cache[ $key ] = false; + $this->cache_misses++; + } else { + $cache[ $key ] = $this->maybe_unserialize( $value ); + $this->add_to_internal_cache( $derived_keys[ $key ], $cache[ $key ] ); - // If the set was successful, or we didn't go to redis. - if ( $result ) { - $this->add_to_internal_cache( $derived_key, $value ); + $this->cache_hits++; } + } - if ( function_exists( 'do_action' ) ) { - $execute_time = microtime( true ) - $start_time; + if ( function_exists( 'do_action' ) ) { + do_action( 'redis_object_cache_get_multiple', $keys, $cache, $group, $force, $execute_time ); + } - do_action( 'redis_object_cache_set', $key, $value, $group, $expiration, $execute_time ); + if ( function_exists( 'apply_filters' ) && function_exists( 'has_filter' ) ) { + if ( has_filter( 'redis_object_cache_get_value' ) ) { + foreach ( $cache as $key => $value ) { + $cache[ $key ] = apply_filters( 'redis_object_cache_get_value', $value, $key, $group, $force ); + } } - - return $result; } - /** - * Increment a Redis counter by the amount specified - * - * @param string $key The key name. - * @param int $offset Optional. The increment. Defaults to 1. - * @param string $group Optional. The key group. Default is 'default'. - * @return int|bool - */ - public function increment( $key, $offset = 1, $group = 'default' ) { - $offset = (int) $offset; - $derived_key = $this->build_key( $key, $group ); + return $cache; + } - // If group is a non-Redis group, save to internal cache, not Redis. - if ( $this->is_ignored_group( $group ) || ! $this->redis_status() ) { - $value = $this->get_from_internal_cache( $derived_key ); - $value += $offset; - $this->add_to_internal_cache( $derived_key, $value ); + /** + * Sets a value in cache. + * + * The value is set whether or not this key already exists in Redis. + * + * @param string $key The key under which to store the value. + * @param mixed $value The value to store. + * @param string $group The group value appended to the $key. + * @param int $expiration The expiration time, defaults to 0. + * @return bool Returns TRUE on success or FALSE on failure. + */ + public function set( $key, $value, $group = 'default', $expiration = 0 ) { + $result = true; + $derived_key = $this->build_key( $key, $group ); - return $value; - } + $start_time = microtime( true ); - $start_time = microtime( true ); + // Save if group not excluded from redis and redis is up. + if ( ! $this->is_ignored_group( $group ) && $this->redis_status() ) { + $expiration = apply_filters( 'redis_cache_expiration', $this->validate_expiration( $expiration ), $key, $group ); try { - $result = $this->parse_redis_response( $this->redis->incrBy( $derived_key, $offset ) ); - - $this->add_to_internal_cache( $derived_key, (int) $this->redis->get( $derived_key ) ); + if ( $expiration ) { + $result = $this->parse_redis_response( $this->redis->setex( $derived_key, $expiration, $this->maybe_serialize( $value ) ) ); + } else { + $result = $this->parse_redis_response( $this->redis->set( $derived_key, $this->maybe_serialize( $value ) ) ); + } } catch ( Exception $exception ) { $this->handle_exception( $exception ); return false; } + $this->cache_calls++; + $this->cache_time += ( microtime( true ) - $start_time ); + } + + // If the set was successful, or we didn't go to redis. + if ( $result ) { + $this->add_to_internal_cache( $derived_key, $value ); + } + + if ( function_exists( 'do_action' ) ) { $execute_time = microtime( true ) - $start_time; - $this->cache_calls += 2; - $this->cache_time += $execute_time; - - return $result; - } - - /** - * Alias of `increment()`. - * - * @see self::increment() - * @param string $key The key name. - * @param int $offset Optional. The increment. Defaults to 1. - * @param string $group Optional. The key group. Default is 'default'. - * @return int|bool - */ - public function incr( $key, $offset = 1, $group = 'default' ) { - return $this->increment( $key, $offset, $group ); - } - - /** - * Decrement a Redis counter by the amount specified - * - * @param string $key The key name. - * @param int $offset Optional. The decrement. Defaults to 1. - * @param string $group Optional. The key group. Default is 'default'. - * @return int|bool - */ - public function decrement( $key, $offset = 1, $group = 'default' ) { - $derived_key = $this->build_key( $key, $group ); - $offset = (int) $offset; - - // If group is a non-Redis group, save to internal cache, not Redis. - if ( $this->is_ignored_group( $group ) || ! $this->redis_status() ) { - $value = $this->get_from_internal_cache( $derived_key ); - $value -= $offset; - $this->add_to_internal_cache( $derived_key, $value ); - - return $value; - } + do_action( 'redis_object_cache_set', $key, $value, $group, $expiration, $execute_time ); + } - $start_time = microtime( true ); + return $result; + } - try { - // Save to Redis. - $result = $this->parse_redis_response( $this->redis->decrBy( $derived_key, $offset ) ); + /** + * Increment a Redis counter by the amount specified + * + * @param string $key The key name. + * @param int $offset Optional. The increment. Defaults to 1. + * @param string $group Optional. The key group. Default is 'default'. + * @return int|bool + */ + public function increment( $key, $offset = 1, $group = 'default' ) { + $offset = (int) $offset; + $derived_key = $this->build_key( $key, $group ); + + // If group is a non-Redis group, save to internal cache, not Redis. + if ( $this->is_ignored_group( $group ) || ! $this->redis_status() ) { + $value = $this->get_from_internal_cache( $derived_key ); + $value += $offset; + $this->add_to_internal_cache( $derived_key, $value ); - $this->add_to_internal_cache( $derived_key, (int) $this->redis->get( $derived_key ) ); - } catch ( Exception $exception ) { - $this->handle_exception( $exception ); + return $value; + } - return false; - } + $start_time = microtime( true ); - $execute_time = microtime( true ) - $start_time; + try { + $result = $this->parse_redis_response( $this->redis->incrBy( $derived_key, $offset ) ); - $this->cache_calls += 2; - $this->cache_time += $execute_time; - - return $result; - } - - /** - * Render data about current cache requests - * Used by the Debug bar plugin - * - * @return void - */ - public function stats() { - $bytes = strlen( serialize( $wp_object_cache->cache ) ); // phpcs:ignore WordPress.PHP.DiscouragedPHPFunctions.serialize_serialize - - ?> -

- Redis Status: - redis_status() ? 'Connected' : 'Not connected'; ?> -
- Redis Client: - diagnostics['client'] ?: 'Unknown'; ?> -
- Cache Hits: - cache_hits ); ?> -
- Cache Misses: - cache_misses ); ?> -
- Cache Size: - kB -

- cache_hits + $this->cache_misses; - - $bytes = array_map( - function ( $keys ) { - // phpcs:ignore WordPress.PHP.DiscouragedPHPFunctions.serialize_serialize - return strlen( serialize( $keys ) ); - }, - $this->cache - ); + $this->add_to_internal_cache( $derived_key, (int) $this->redis->get( $derived_key ) ); + } catch ( Exception $exception ) { + $this->handle_exception( $exception ); - return (object) [ - 'hits' => $this->cache_hits, - 'misses' => $this->cache_misses, - 'ratio' => $total > 0 ? round( $this->cache_hits / ( $total / 100 ), 1 ) : 100, - 'bytes' => array_sum( $bytes ), - 'time' => $this->cache_time, - 'calls' => $this->cache_calls, - 'groups' => (object) [ - 'global' => $this->global_groups, - 'non_persistent' => $this->ignored_groups, - 'unflushable' => $this->unflushable_groups, - ], - 'errors' => empty( $this->errors ) ? null : $this->errors, - 'meta' => [ - 'Client' => $this->diagnostics['client'] ?: 'Unknown', - 'Redis Version' => $this->redis_version, - ], - ]; + return false; } - /** - * Builds a key for the cached object using the prefix, group and key. - * - * @param string $key The key under which to store the value. - * @param string $group The group value appended to the $key. - * - * @return string - */ - public function build_key( $key, $group = 'default' ) { - if ( empty( $group ) ) { - $group = 'default'; - } + $execute_time = microtime( true ) - $start_time; - $salt = defined( 'WP_REDIS_PREFIX' ) ? trim( WP_REDIS_PREFIX ) : ''; - $prefix = $this->is_global_group( $group ) ? $this->global_prefix : $this->blog_prefix; - - $key = $this->sanitize_key_part( $key ); - $group = $this->sanitize_key_part( $group ); - - $prefix = trim( $prefix, '_-:$' ); - - return "{$salt}{$prefix}:{$group}:{$key}"; - } - - /** - * Replaces the set group separator by another one - * - * @param string $part The string to sanitize. - * @return string Sanitized string. - */ - protected function sanitize_key_part( $part ) { - return str_replace( ':', '-', $part ); - } - - /** - * Checks if the given group is part the ignored group array - * - * @param string $group Name of the group to check. - * @return bool - */ - protected function is_ignored_group( $group ) { - return in_array( $this->sanitize_key_part( $group ), $this->ignored_groups, true ); - } - - /** - * Checks if the given group is part the global group array - * - * @param string $group Name of the group to check. - * @return bool - */ - protected function is_global_group( $group ) { - return in_array( $this->sanitize_key_part( $group ), $this->global_groups, true ); - } - - /** - * Checks if the given group is part the unflushable group array - * - * @param string $group Name of the group to check. - * @return bool - */ - protected function is_unflushable_group( $group ) { - return in_array( $this->sanitize_key_part( $group ), $this->unflushable_groups, true ); - } - - /** - * Convert Redis responses into something meaningful - * - * @param mixed $response Response sent from the redis instance. - * @return mixed - */ - protected function parse_redis_response( $response ) { - if ( is_bool( $response ) ) { - return $response; - } + $this->cache_calls += 2; + $this->cache_time += $execute_time; - if ( is_numeric( $response ) ) { - return $response; - } + return $result; + } - if ( is_object( $response ) && method_exists( $response, 'getPayload' ) ) { - return $response->getPayload() === 'OK'; - } + /** + * Alias of `increment()`. + * + * @see self::increment() + * @param string $key The key name. + * @param int $offset Optional. The increment. Defaults to 1. + * @param string $group Optional. The key group. Default is 'default'. + * @return int|bool + */ + public function incr( $key, $offset = 1, $group = 'default' ) { + return $this->increment( $key, $offset, $group ); + } - return false; + /** + * Decrement a Redis counter by the amount specified + * + * @param string $key The key name. + * @param int $offset Optional. The decrement. Defaults to 1. + * @param string $group Optional. The key group. Default is 'default'. + * @return int|bool + */ + public function decrement( $key, $offset = 1, $group = 'default' ) { + $derived_key = $this->build_key( $key, $group ); + $offset = (int) $offset; + + // If group is a non-Redis group, save to internal cache, not Redis. + if ( $this->is_ignored_group( $group ) || ! $this->redis_status() ) { + $value = $this->get_from_internal_cache( $derived_key ); + $value -= $offset; + $this->add_to_internal_cache( $derived_key, $value ); + + return $value; } - /** - * Simple wrapper for saving object to the internal cache. - * - * @param string $derived_key Key to save value under. - * @param mixed $value Object value. - */ - public function add_to_internal_cache( $derived_key, $value ) { - if ( is_object( $value ) ) { - $value = clone $value; - } + $start_time = microtime( true ); + + try { + // Save to Redis. + $result = $this->parse_redis_response( $this->redis->decrBy( $derived_key, $offset ) ); - $this->cache[ $derived_key ] = $value; + $this->add_to_internal_cache( $derived_key, (int) $this->redis->get( $derived_key ) ); + } catch ( Exception $exception ) { + $this->handle_exception( $exception ); + + return false; } - /** - * Get a value specifically from the internal, run-time cache, not Redis. - * - * @param int|string $derived_key Key value. - * - * @return bool|mixed Value on success; false on failure. - */ - public function get_from_internal_cache( $derived_key ) { - if ( ! isset( $this->cache[ $derived_key ] ) ) { - return false; - } + $execute_time = microtime( true ) - $start_time; - if ( is_object( $this->cache[ $derived_key ] ) ) { - return clone $this->cache[ $derived_key ]; - } + $this->cache_calls += 2; + $this->cache_time += $execute_time; + + return $result; + } + + /** + * Render data about current cache requests + * Used by the Debug bar plugin + * + * @return void + */ + public function stats() { + $bytes = strlen( serialize( $wp_object_cache->cache ) ); // phpcs:ignore WordPress.PHP.DiscouragedPHPFunctions.serialize_serialize + + ?> +

+ Redis Status: + redis_status() ? 'Connected' : 'Not connected'; ?> +
+ Redis Client: + diagnostics['client'] ?: 'Unknown'; ?> +
+ Cache Hits: + cache_hits ); ?> +
+ Cache Misses: + cache_misses ); ?> +
+ Cache Size: + kB +

+ cache[ $derived_key ]; + /** + * Returns various information about the object cache. + * + * @return object + */ + public function info() { + $total = $this->cache_hits + $this->cache_misses; + + $bytes = array_map( + function ( $keys ) { + // phpcs:ignore WordPress.PHP.DiscouragedPHPFunctions.serialize_serialize + return strlen( serialize( $keys ) ); + }, + $this->cache + ); + + return (object) [ + 'hits' => $this->cache_hits, + 'misses' => $this->cache_misses, + 'ratio' => $total > 0 ? round( $this->cache_hits / ( $total / 100 ), 1 ) : 100, + 'bytes' => array_sum( $bytes ), + 'time' => $this->cache_time, + 'calls' => $this->cache_calls, + 'groups' => (object) [ + 'global' => $this->global_groups, + 'non_persistent' => $this->ignored_groups, + 'unflushable' => $this->unflushable_groups, + ], + 'errors' => empty( $this->errors ) ? null : $this->errors, + 'meta' => [ + 'Client' => $this->diagnostics['client'] ?: 'Unknown', + 'Redis Version' => $this->redis_version, + ], + ]; + } + + /** + * Builds a key for the cached object using the prefix, group and key. + * + * @param string $key The key under which to store the value. + * @param string $group The group value appended to the $key. + * + * @return string + */ + public function build_key( $key, $group = 'default' ) { + if ( empty( $group ) ) { + $group = 'default'; } - /** - * In multisite, switch blog prefix when switching blogs - * - * @param int $_blog_id Blog ID. - * @return bool - */ - public function switch_to_blog( $_blog_id ) { - if ( ! function_exists( 'is_multisite' ) || ! is_multisite() ) { - return false; - } + $salt = defined( 'WP_REDIS_PREFIX' ) ? trim( WP_REDIS_PREFIX ) : ''; + $prefix = $this->is_global_group( $group ) ? $this->global_prefix : $this->blog_prefix; - $this->blog_prefix = $_blog_id; + $key = $this->sanitize_key_part( $key ); + $group = $this->sanitize_key_part( $group ); - return true; + $prefix = trim( $prefix, '_-:$' ); + + return "{$salt}{$prefix}:{$group}:{$key}"; + } + + /** + * Replaces the set group separator by another one + * + * @param string $part The string to sanitize. + * @return string Sanitized string. + */ + protected function sanitize_key_part( $part ) { + return str_replace( ':', '-', $part ); + } + + /** + * Checks if the given group is part the ignored group array + * + * @param string $group Name of the group to check. + * @return bool + */ + protected function is_ignored_group( $group ) { + return in_array( $this->sanitize_key_part( $group ), $this->ignored_groups, true ); + } + + /** + * Checks if the given group is part the global group array + * + * @param string $group Name of the group to check. + * @return bool + */ + protected function is_global_group( $group ) { + return in_array( $this->sanitize_key_part( $group ), $this->global_groups, true ); + } + + /** + * Checks if the given group is part the unflushable group array + * + * @param string $group Name of the group to check. + * @return bool + */ + protected function is_unflushable_group( $group ) { + return in_array( $this->sanitize_key_part( $group ), $this->unflushable_groups, true ); + } + + /** + * Convert Redis responses into something meaningful + * + * @param mixed $response Response sent from the redis instance. + * @return mixed + */ + protected function parse_redis_response( $response ) { + if ( is_bool( $response ) ) { + return $response; } - /** - * Sets the list of global groups. - * - * @param array $groups List of groups that are global. - */ - public function add_global_groups( $groups ) { - $groups = (array) $groups; + if ( is_numeric( $response ) ) { + return $response; + } - if ( $this->redis_status() ) { - $this->global_groups = array_unique( array_merge( $this->global_groups, $groups ) ); - } else { - $this->ignored_groups = array_unique( array_merge( $this->ignored_groups, $groups ) ); - } + if ( is_object( $response ) && method_exists( $response, 'getPayload' ) ) { + return $response->getPayload() === 'OK'; } - /** - * Sets the list of groups not to be cached by Redis. - * - * @param array $groups List of groups that are to be ignored. - */ - public function add_non_persistent_groups( $groups ) { - $groups = (array) $groups; + return false; + } - $this->ignored_groups = array_unique( array_merge( $this->ignored_groups, $groups ) ); + /** + * Simple wrapper for saving object to the internal cache. + * + * @param string $derived_key Key to save value under. + * @param mixed $value Object value. + */ + public function add_to_internal_cache( $derived_key, $value ) { + if ( is_object( $value ) ) { + $value = clone $value; } - /** - * Sets the list of groups not to flushed cached. - * - * @param array $groups List of groups that are unflushable. - */ - public function add_unflushable_groups( $groups ) { - $groups = (array) $groups; + $this->cache[ $derived_key ] = $value; + } - $this->unflushable_groups = array_unique( array_merge( $this->unflushable_groups, $groups ) ); + /** + * Get a value specifically from the internal, run-time cache, not Redis. + * + * @param int|string $derived_key Key value. + * + * @return bool|mixed Value on success; false on failure. + */ + public function get_from_internal_cache( $derived_key ) { + if ( ! isset( $this->cache[ $derived_key ] ) ) { + return false; } - /** - * Wrapper to validate the cache keys expiration value - * - * @param mixed $expiration Incoming expiration value (whatever it is). - */ - protected function validate_expiration( $expiration ) { - $expiration = is_int( $expiration ) || ctype_digit( $expiration ) ? (int) $expiration : 0; + if ( is_object( $this->cache[ $derived_key ] ) ) { + return clone $this->cache[ $derived_key ]; + } - if ( defined( 'WP_REDIS_MAXTTL' ) ) { - $max = (int) WP_REDIS_MAXTTL; + return $this->cache[ $derived_key ]; + } - if ( $expiration === 0 || $expiration > $max ) { - $expiration = $max; - } - } + /** + * In multisite, switch blog prefix when switching blogs + * + * @param int $_blog_id Blog ID. + * @return bool + */ + public function switch_to_blog( $_blog_id ) { + if ( ! function_exists( 'is_multisite' ) || ! is_multisite() ) { + return false; + } + + $this->blog_prefix = $_blog_id; + + return true; + } - return $expiration; + /** + * Sets the list of global groups. + * + * @param array $groups List of groups that are global. + */ + public function add_global_groups( $groups ) { + $groups = (array) $groups; + + if ( $this->redis_status() ) { + $this->global_groups = array_unique( array_merge( $this->global_groups, $groups ) ); + } else { + $this->ignored_groups = array_unique( array_merge( $this->ignored_groups, $groups ) ); } + } - /** - * Unserialize value only if it was serialized. - * - * @param string $original Maybe unserialized original, if is needed. - * @return mixed Unserialized data can be any type. - */ - protected function maybe_unserialize( $original ) { - if ( defined( 'WP_REDIS_SERIALIZER' ) && ! empty( WP_REDIS_SERIALIZER ) ) { - return $original; - } + /** + * Sets the list of groups not to be cached by Redis. + * + * @param array $groups List of groups that are to be ignored. + */ + public function add_non_persistent_groups( $groups ) { + $groups = (array) $groups; - if ( defined( 'WP_REDIS_IGBINARY' ) && WP_REDIS_IGBINARY && function_exists( 'igbinary_unserialize' ) ) { - return igbinary_unserialize( $original ); - } + $this->ignored_groups = array_unique( array_merge( $this->ignored_groups, $groups ) ); + } - // Don't attempt to unserialize data that wasn't serialized going in. - if ( $this->is_serialized( $original ) ) { - // phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged, WordPress.PHP.DiscouragedPHPFunctions.serialize_unserialize - $value = @unserialize( $original ); + /** + * Sets the list of groups not to flushed cached. + * + * @param array $groups List of groups that are unflushable. + */ + public function add_unflushable_groups( $groups ) { + $groups = (array) $groups; - return is_object( $value ) ? clone $value : $value; + $this->unflushable_groups = array_unique( array_merge( $this->unflushable_groups, $groups ) ); + } + + /** + * Wrapper to validate the cache keys expiration value + * + * @param mixed $expiration Incoming expiration value (whatever it is). + */ + protected function validate_expiration( $expiration ) { + $expiration = is_int( $expiration ) || ctype_digit( $expiration ) ? (int) $expiration : 0; + + if ( defined( 'WP_REDIS_MAXTTL' ) ) { + $max = (int) WP_REDIS_MAXTTL; + + if ( $expiration === 0 || $expiration > $max ) { + $expiration = $max; } + } + + return $expiration; + } + /** + * Unserialize value only if it was serialized. + * + * @param string $original Maybe unserialized original, if is needed. + * @return mixed Unserialized data can be any type. + */ + protected function maybe_unserialize( $original ) { + if ( defined( 'WP_REDIS_SERIALIZER' ) && ! empty( WP_REDIS_SERIALIZER ) ) { return $original; } - /** - * Serialize data, if needed. - * - * @param mixed $data Data that might be serialized. - * @return mixed A scalar data - */ - protected function maybe_serialize( $data ) { - if ( is_object( $data ) ) { - $data = clone $data; - } + if ( defined( 'WP_REDIS_IGBINARY' ) && WP_REDIS_IGBINARY && function_exists( 'igbinary_unserialize' ) ) { + return igbinary_unserialize( $original ); + } - if ( defined( 'WP_REDIS_SERIALIZER' ) && ! empty( WP_REDIS_SERIALIZER ) ) { - return $data; - } + // Don't attempt to unserialize data that wasn't serialized going in. + if ( $this->is_serialized( $original ) ) { + // phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged, WordPress.PHP.DiscouragedPHPFunctions.serialize_unserialize + $value = @unserialize( $original ); - if ( defined( 'WP_REDIS_IGBINARY' ) && WP_REDIS_IGBINARY && function_exists( 'igbinary_serialize' ) ) { - return igbinary_serialize( $data ); - } + return is_object( $value ) ? clone $value : $value; + } - if ( is_array( $data ) || is_object( $data ) ) { - // phpcs:ignore WordPress.PHP.DiscouragedPHPFunctions.serialize_serialize - return serialize( $data ); - } + return $original; + } - if ( $this->is_serialized( $data, false ) ) { - // phpcs:ignore WordPress.PHP.DiscouragedPHPFunctions.serialize_serialize - return serialize( $data ); - } + /** + * Serialize data, if needed. + * + * @param mixed $data Data that might be serialized. + * @return mixed A scalar data + */ + protected function maybe_serialize( $data ) { + if ( is_object( $data ) ) { + $data = clone $data; + } + if ( defined( 'WP_REDIS_SERIALIZER' ) && ! empty( WP_REDIS_SERIALIZER ) ) { return $data; } - /** - * Check value to find if it was serialized. - * - * If $data is not an string, then returned value will always be false. - * Serialized data is always a string. - * - * @param string $data Value to check to see if was serialized. - * @param bool $strict Optional. Whether to be strict about the end of the string. Default true. - * @return bool False if not serialized and true if it was. - */ - protected function is_serialized( $data, $strict = true ) { - // if it isn't a string, it isn't serialized. - if ( ! is_string( $data ) ) { - return false; - } + if ( defined( 'WP_REDIS_IGBINARY' ) && WP_REDIS_IGBINARY && function_exists( 'igbinary_serialize' ) ) { + return igbinary_serialize( $data ); + } - $data = trim( $data ); + if ( is_array( $data ) || is_object( $data ) ) { + // phpcs:ignore WordPress.PHP.DiscouragedPHPFunctions.serialize_serialize + return serialize( $data ); + } - if ( 'N;' === $data ) { - return true; - } + if ( $this->is_serialized( $data, false ) ) { + // phpcs:ignore WordPress.PHP.DiscouragedPHPFunctions.serialize_serialize + return serialize( $data ); + } + + return $data; + } + + /** + * Check value to find if it was serialized. + * + * If $data is not an string, then returned value will always be false. + * Serialized data is always a string. + * + * @param string $data Value to check to see if was serialized. + * @param bool $strict Optional. Whether to be strict about the end of the string. Default true. + * @return bool False if not serialized and true if it was. + */ + protected function is_serialized( $data, $strict = true ) { + // if it isn't a string, it isn't serialized. + if ( ! is_string( $data ) ) { + return false; + } + + $data = trim( $data ); + + if ( 'N;' === $data ) { + return true; + } - if ( strlen( $data ) < 4 ) { + if ( strlen( $data ) < 4 ) { + return false; + } + + if ( ':' !== $data[1] ) { + return false; + } + + if ( $strict ) { + $lastc = substr( $data, -1 ); + + if ( ';' !== $lastc && '}' !== $lastc ) { return false; } + } else { + $semicolon = strpos( $data, ';' ); + $brace = strpos( $data, '}' ); - if ( ':' !== $data[1] ) { + // Either ; or } must exist. + if ( false === $semicolon && false === $brace ) { return false; } - if ( $strict ) { - $lastc = substr( $data, -1 ); - - if ( ';' !== $lastc && '}' !== $lastc ) { - return false; - } - } else { - $semicolon = strpos( $data, ';' ); - $brace = strpos( $data, '}' ); - - // Either ; or } must exist. - if ( false === $semicolon && false === $brace ) { - return false; - } - - // But neither must be in the first X characters. - if ( false !== $semicolon && $semicolon < 3 ) { - return false; - } + // But neither must be in the first X characters. + if ( false !== $semicolon && $semicolon < 3 ) { + return false; + } - if ( false !== $brace && $brace < 4 ) { - return false; - } + if ( false !== $brace && $brace < 4 ) { + return false; } - $token = $data[0]; + } + $token = $data[0]; - switch ( $token ) { - case 's': - if ( $strict ) { - if ( '"' !== substr( $data, -2, 1 ) ) { - return false; - } - } elseif ( false === strpos( $data, '"' ) ) { + switch ( $token ) { + case 's': + if ( $strict ) { + if ( '"' !== substr( $data, -2, 1 ) ) { return false; } - // Or else fall through. - // No break! - case 'a': - case 'O': - return (bool) preg_match( "/^{$token}:[0-9]+:/s", $data ); - case 'b': - case 'i': - case 'd': - $end = $strict ? '$' : ''; - - return (bool) preg_match( "/^{$token}:[0-9.E-]+;$end/", $data ); - } - - return false; + } elseif ( false === strpos( $data, '"' ) ) { + return false; + } + // Or else fall through. + // No break! + case 'a': + case 'O': + return (bool) preg_match( "/^{$token}:[0-9]+:/s", $data ); + case 'b': + case 'i': + case 'd': + $end = $strict ? '$' : ''; + + return (bool) preg_match( "/^{$token}:[0-9.E-]+;$end/", $data ); } - /** - * Handle the redis failure gracefully or throw an exception. - * - * @param \Exception $exception Exception thrown. - * @throws \Exception If `fail_gracefully` flag is set to a falsy value. - * @return void - */ - protected function handle_exception( $exception ) { - $this->redis_connected = false; + return false; + } - // When Redis is unavailable, fall back to the internal cache by forcing all groups to be "no redis" groups. - $this->ignored_groups = array_unique( array_merge( $this->ignored_groups, $this->global_groups ) ); + /** + * Handle the redis failure gracefully or throw an exception. + * + * @param \Exception $exception Exception thrown. + * @throws \Exception If `fail_gracefully` flag is set to a falsy value. + * @return void + */ + protected function handle_exception( $exception ) { + $this->redis_connected = false; - if ( ! $this->fail_gracefully ) { - throw $exception; - } + // When Redis is unavailable, fall back to the internal cache by forcing all groups to be "no redis" groups. + $this->ignored_groups = array_unique( array_merge( $this->ignored_groups, $this->global_groups ) ); - $this->errors[] = $exception->getMessage(); + if ( ! $this->fail_gracefully ) { + throw $exception; + } - error_log( $exception ); // phpcs:ignore WordPress.PHP.DevelopmentFunctions.error_log_error_log + $this->errors[] = $exception->getMessage(); - if ( function_exists( 'do_action' ) ) { - do_action( 'redis_object_cache_error', $exception ); - } - } + error_log( $exception ); // phpcs:ignore WordPress.PHP.DevelopmentFunctions.error_log_error_log - /** - * Allows access to private properties for backwards compatibility. - * - * @param string $name Name of the property. - * @return mixed - */ - public function __get( $name ) { - return isset( $this->{$name} ) ? $this->{$name} : null; + if ( function_exists( 'do_action' ) ) { + do_action( 'redis_object_cache_error', $exception ); } } + /** + * Allows access to private properties for backwards compatibility. + * + * @param string $name Name of the property. + * @return mixed + */ + public function __get( $name ) { + return isset( $this->{$name} ) ? $this->{$name} : null; + } +} + endif; +// phpcs:enable Generic.WhiteSpace.ScopeIndent.IncorrectExact, Generic.WhiteSpace.ScopeIndent.Incorrect From 94083975499a7b963c7e0fbca57106994b29b312 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Till=20Kr=C3=BCss?= Date: Sun, 16 Aug 2020 09:03:42 -0700 Subject: [PATCH 89/93] new line --- includes/class-plugin.php | 1 + 1 file changed, 1 insertion(+) diff --git a/includes/class-plugin.php b/includes/class-plugin.php index f53b24a5..a81ae701 100644 --- a/includes/class-plugin.php +++ b/includes/class-plugin.php @@ -715,6 +715,7 @@ public function do_admin_actions() { public function dismiss_notice() { if ( isset( $_POST['notice'] ) ) { check_ajax_referer( 'roc_dismiss_notice' ); + $notice = sprintf( 'roc_dismissed_%s', sanitize_key( $_POST['notice'] ) From 3e510a68b28eb739883ea4a521c80987e77ef5b8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Till=20Kr=C3=BCss?= Date: Sun, 16 Aug 2020 09:05:40 -0700 Subject: [PATCH 90/93] new line --- includes/class-plugin.php | 1 + 1 file changed, 1 insertion(+) diff --git a/includes/class-plugin.php b/includes/class-plugin.php index a81ae701..9c1a6143 100644 --- a/includes/class-plugin.php +++ b/includes/class-plugin.php @@ -962,6 +962,7 @@ public function initialize_filesystem( $url, $silent = false ) { } $credentials = request_filesystem_credentials( $url ); + if ( false === $credentials ) { if ( $silent ) { ob_end_clean(); From 68d2d291ef59808737027b13540e2c0321eff6b5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Till=20Kr=C3=BCss?= Date: Sun, 16 Aug 2020 09:06:46 -0700 Subject: [PATCH 91/93] new line --- includes/class-plugin.php | 1 + 1 file changed, 1 insertion(+) diff --git a/includes/class-plugin.php b/includes/class-plugin.php index 9c1a6143..c376d4a3 100644 --- a/includes/class-plugin.php +++ b/includes/class-plugin.php @@ -1107,6 +1107,7 @@ public function action_link( $action ) { if ( ! in_array( $action, $this->actions, true ) ) { return ''; } + return wp_nonce_url( network_admin_url( add_query_arg( 'action', $action, $this->page ) ), $action From 8307a7b7aee3248fe2ac207774e573810f571a99 Mon Sep 17 00:00:00 2001 From: naxvog Date: Sun, 16 Aug 2020 18:29:43 +0200 Subject: [PATCH 92/93] added esc_textarea --- includes/ui/diagnostics.php | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/includes/ui/diagnostics.php b/includes/ui/diagnostics.php index b71d9c1d..d9620056 100644 --- a/includes/ui/diagnostics.php +++ b/includes/ui/diagnostics.php @@ -140,6 +140,6 @@ if ( defined( 'WP_CLI' ) && WP_CLI ) { WP_CLI::line( "{$name}: $value" ); } else { - echo esc_html( "{$name}: {$value}\r\n" ); + echo esc_textarea( "{$name}: {$value}\r\n" ); } } From 3102d91f6497d5edb8a62ac39626427f4069c112 Mon Sep 17 00:00:00 2001 From: naxvog Date: Sun, 16 Aug 2020 18:40:57 +0200 Subject: [PATCH 93/93] restored ternary whitespaces --- includes/object-cache.php | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/includes/object-cache.php b/includes/object-cache.php index 6993d12b..6aa88ab1 100644 --- a/includes/object-cache.php +++ b/includes/object-cache.php @@ -836,8 +836,8 @@ protected function connect_using_hhvm( $parameters ) { */ public function fetch_info() { $options = method_exists( $this->redis, 'getOptions' ) - ? $this->redis->getOptions() - : new stdClass(); + ? $this->redis->getOptions() + : new stdClass(); if ( isset( $options->replication ) && $options->replication ) { return; @@ -929,8 +929,8 @@ public function replace( $key, $value, $group = 'default', $expiration = 0 ) { */ protected function add_or_replace( $add, $key, $value, $group = 'default', $expiration = 0 ) { $cache_addition_suspended = function_exists( 'wp_suspend_cache_addition' ) - ? wp_suspend_cache_addition() - : false; + ? wp_suspend_cache_addition() + : false; if ( $add && $cache_addition_suspended ) { return false; @@ -1200,8 +1200,8 @@ protected function lua_flush_closure( $salt ) { } $args = ( $this->redis instanceof Predis\Client ) - ? [ $script, 0 ] - : [ $script ]; + ? [ $script, 0 ] + : [ $script ]; return call_user_func_array( [ $this->redis, 'eval' ], $args ); }; @@ -1254,8 +1254,8 @@ function ( $group ) { } $args = ( $this->redis instanceof Predis\Client ) - ? array_merge( [ $script, count( $unflushable ) ], $unflushable ) - : [ $script, $unflushable, count( $unflushable ) ]; + ? array_merge( [ $script, count( $unflushable ) ], $unflushable ) + : [ $script, $unflushable, count( $unflushable ) ]; return call_user_func_array( [ $this->redis, 'eval' ], $args ); };