Merge pull request #2 from dwnload/develop

thefrosty · web-flow · commit 9e5ee772d285 · 2018-04-23T10:04:36.000-07:00
Version 1.1.0
diff --git a/CHANGELONG.md b/CHANGELONG.md
@@ -4,6 +4,13 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
+## 1.1.0 - 2018-04-23
+### Updated
+- The admin settings page now works.
+- wp_cache_set expire from settings is used (if available).
+- Be sure to clean the URL queries after calls to avoid caching delete requests.
+- Make sure the cache flush button in the settings is invoked to show the URL.
+
 ## 1.0.4 - 2018-04-19
 ### Updated
 - `RestDispatch::preDispatch` should set the $request_uri from `CacheApiTrait::getRequestUri` and not use
diff --git a/src/RestApi/CacheApiTrait.php b/src/RestApi/CacheApiTrait.php
@@ -44,9 +44,7 @@ protected function getCacheKey(
             }
         }
 
-        // Be sure to remove our added cache refresh & cache delete queries.
-        $uri = \remove_query_arg([RestDispatch::QUERY_CACHE_DELETE, RestDispatch::QUERY_CACHE_REFRESH], $request_uri);
-        return filter_var_string(\apply_filters(RestDispatch::FILTER_API_KEY, $uri, $server, $request));
+        return filter_var_string(\apply_filters(RestDispatch::FILTER_API_KEY, $request_uri, $server, $request));
     }
 
     /**
@@ -79,7 +77,23 @@ protected function wpCacheFlush() : bool
      */
     protected function wpCacheDeleteByKey(string $key) : bool
     {
-        return \wp_cache_delete($key, $this->getCacheGroup());
+        return \wp_cache_delete($this->cleanKey($key), $this->getCacheGroup());
+    }
+
+    /**
+     * Clean the cache of query params that shouldn't be part of the string; like delete params.
+     *
+     * @param string $key
+     * @return string
+     */
+    protected function cleanKey(string $key) : string
+    {
+        $query_args = [
+            RestDispatch::QUERY_CACHE_DELETE,
+            RestDispatch::QUERY_CACHE_FORCE_DELETE,
+            RestDispatch::QUERY_CACHE_REFRESH,
+        ];
+        return \remove_query_arg($query_args, $key);
     }
 
     /**
diff --git a/src/RestApi/RestDispatch.php b/src/RestApi/RestDispatch.php
@@ -4,6 +4,8 @@
 
 use function Dwnload\WpRestApi\Helpers\filter_var_bool;
 use function Dwnload\WpRestApi\Helpers\filter_var_int;
+use Dwnload\WpRestApi\WpAdmin\Admin;
+use Dwnload\WpRestApi\WpAdmin\Settings;
 use Dwnload\WpRestApi\WpRestApiCache;
 use TheFrosty\WpUtilities\Plugin\HooksTrait;
 use TheFrosty\WpUtilities\Plugin\WpHooksInterface;
@@ -29,6 +31,7 @@ class RestDispatch implements WpHooksInterface
     const CACHE_HEADER_DELETE = 'X-WP-API-Cache-Delete';
     const FILTER_API_GROUP = WpRestApiCache::FILTER_PREFIX . 'group';
     const FILTER_API_KEY = WpRestApiCache::FILTER_PREFIX . 'key';
+    const FILTER_KEYS_NOT_ALLOWED = WpRestApiCache::FILTER_PREFIX . 'keys_not_allowed';
     const FILTER_ALLOWED_CACHE_STATUS = WpRestApiCache::FILTER_PREFIX . 'allowed_cache_status';
     const FILTER_CACHE_CONTROL_HEADERS = WpRestApiCache::FILTER_PREFIX . 'cache_control_headers';
     const FILTER_CACHE_EXPIRE = WpRestApiCache::FILTER_PREFIX . 'expire';
@@ -39,7 +42,7 @@ class RestDispatch implements WpHooksInterface
     const QUERY_CACHE_FORCE_DELETE = 'rest_force_delete';
     const QUERY_CACHE_REFRESH = 'rest_cache_refresh';
 
-    const VERSION = '2.0.4';
+    const VERSION = '1.1.0';
 
     /**
      * Add class hooks.
@@ -60,7 +63,7 @@ public function addHooks()
      *
      * @return mixed Response
      */
-    public function preDispatch($result, WP_REST_Server $server, WP_REST_Request $request)
+    protected function preDispatch($result, WP_REST_Server $server, WP_REST_Request $request)
     {
         $request_uri = $this->getRequestUri();
         $group = $this->getCacheGroup();
@@ -151,7 +154,7 @@ public function preDispatch($result, WP_REST_Server $server, WP_REST_Request $re
      *
      * @return WP_REST_Response
      */
-    public function postDispatch($response, WP_REST_Server $server, WP_REST_Request $request) : WP_REST_Response
+    protected function postDispatch($response, WP_REST_Server $server, WP_REST_Request $request) : WP_REST_Response
     {
         $request_uri = $this->getRequestUri();
         $key = $this->getCacheKey($request_uri, $server, $request);
@@ -197,11 +200,28 @@ protected function getCachedResult(
         string $group,
         bool $force = false
     ) {
-        $result = \wp_cache_get($key, $group, $force);
+        $result = \wp_cache_get($this->cleanKey($key), $group, $force);
         if ($result === false) {
             $result = $this->dispatchRequest($server, $request);
-            $expire = \absint(\apply_filters(self::FILTER_CACHE_EXPIRE, (MINUTE_IN_SECONDS * 10)));
-            \wp_cache_set($key, $result, $group, $expire);
+            $defaults = [
+                Settings::EXPIRATION => [
+                    Settings::LENGTH => 10,
+                    Settings::PERIOD => MINUTE_IN_SECONDS,
+                ],
+            ];
+            $options = \get_option(Admin::OPTION_KEY, $defaults);
+            /**
+             * Filter for cache expiration time.
+             * @param int Expiration time.
+             * @param array Array of settings from the expiration length and period.
+             * @return int
+             */
+            $expire = \apply_filters(
+                self::FILTER_CACHE_EXPIRE,
+                ($options[Settings::EXPIRATION][Settings::PERIOD] * $options[Settings::EXPIRATION][Settings::LENGTH]),
+                $options[Settings::EXPIRATION]
+            );
+            \wp_cache_set($this->cleanKey($key), $result, $group, \absint($expire));
 
             return $result;
         }
diff --git a/src/WpAdmin/Admin.php b/src/WpAdmin/Admin.php
@@ -42,8 +42,8 @@ class Admin implements WpHooksInterface
     public function __construct()
     {
         $this->settings = new Settings([
-            Settings::LENGTH => 1,
-            Settings::PERIOD => WEEK_IN_SECONDS,
+            Settings::LENGTH => 10,
+            Settings::PERIOD => MINUTE_IN_SECONDS,
         ]);
     }
 
@@ -52,15 +52,15 @@ public function __construct()
      */
     public function addHooks()
     {
-        if (\apply_filters(self::FILTER_SHOW_ADMIN, true)) {
-            if (\apply_filters(self::FILTER_SHOW_ADMIN_MENU, true)) {
+        if ($this->showAdmin()) {
+            if ($this->showAdminMenu()) {
                 $this->addAction('admin_menu', [$this, 'adminMenu']);
             } else {
                 $this->addAction('admin_action_' . self::ADMIN_ACTION, [$this, 'adminAction']);
                 $this->addAction('admin_notices', [$this, 'adminNotices']);
             }
 
-            if (\apply_filters(self::FILTER_SHOW_ADMIN_BAR_MENU, true)) {
+            if ($this->showAdminMenuBar()) {
                 $this->addAction('admin_bar_menu', [$this, 'adminBarMenu'], 999);
             }
         }
@@ -69,7 +69,7 @@ public function addHooks()
     /**
      * Hook into the WordPress admin menu.
      */
-    public function adminMenu()
+    protected function adminMenu()
     {
         \add_submenu_page(
             'options-general.php',
@@ -86,7 +86,7 @@ public function adminMenu()
      *
      * @param WP_Admin_Bar $wp_admin_bar WP_Admin_Bar object.
      */
-    public function adminBarMenu(WP_Admin_Bar $wp_admin_bar)
+    protected function adminBarMenu(WP_Admin_Bar $wp_admin_bar)
     {
         $args = [
             'id' => WpRestApiCache::ID,
@@ -105,7 +105,7 @@ public function adminBarMenu(WP_Admin_Bar $wp_admin_bar)
     /**
      * Helper to check the request action.
      */
-    public function adminAction()
+    protected function adminAction()
     {
         $this->requestCallback();
 
@@ -127,7 +127,7 @@ public function adminAction()
     /**
      * Maybe add an admin notice.
      */
-    public function adminNotices()
+    protected function adminNotices()
     {
         if (! empty($_REQUEST[self::NONCE_NAME]) &&
             \wp_verify_nonce($_REQUEST[self::NONCE_NAME], self::NONCE_ACTION) &&
@@ -142,10 +142,10 @@ public function adminNotices()
     /**
      * Render the admin settings page.
      */
-    public function renderPage()
+    protected function renderPage()
     {
         $this->requestCallback();
-        require_once \dirname(__FILE__) . '../../views/settings.php';
+        require_once \dirname(__FILE__) . '/../../views/settings.php';
     }
 
     /**
@@ -154,7 +154,7 @@ public function renderPage()
      * @param null|string $key Option key value.
      * @return mixed
      */
-    public function getOptions($key = null)
+    protected function getOptions($key = null)
     {
         $options = \apply_filters(
             self::FILTER_CACHE_OPTIONS,
@@ -177,7 +177,7 @@ private function requestCallback()
         $message = \esc_html__('Nothing to see here.', 'wp-rest-api-cache');
 
         if (! empty($_REQUEST[self::NONCE_NAME]) &&
-            \wp_verify_nonce($_REQUEST[self::NONCE_NAME], 'rest_cache_options')
+            \wp_verify_nonce($_REQUEST[self::NONCE_NAME], 'rest_cache_options') !== false
         ) {
             if (! empty($_GET['rest_cache_empty']) &&
                 filter_var_int($_GET['rest_cache_empty']) === 1
@@ -197,7 +197,7 @@ private function requestCallback()
                  * @param \WP_User The current user.
                  */
                 \do_action(self::ACTION_REQUEST_FLUSH_CACHE, $message, $type, \wp_get_current_user());
-            } elseif (isset($_POST['rest_cache_options']) && ! empty($_POST['rest_cache_options'])) {
+            } elseif (! empty($_POST[self::OPTION_KEY])) {
                 if ($this->updateOptions($_POST['rest_cache_options'])) {
                     $type = 'updated';
                     $message = \esc_html__('The cache time has been updated', 'wp-rest-api-cache');
@@ -218,12 +218,10 @@ private function requestCallback()
      */
     private function updateOptions(array $options) : bool
     {
-        $options = \array_map(
-            'sanitize_text_field',
-            \apply_filters(self::FILTER_CACHE_UPDATE_OPTIONS, $options)
-        );
+        $this->settings->setLength(absint($options[Settings::EXPIRATION][Settings::LENGTH]));
+        $this->settings->setPeriod(absint($options[Settings::EXPIRATION][Settings::PERIOD]));
 
-        return \update_option(self::OPTION_KEY, $options, 'yes');
+        return \update_option(self::OPTION_KEY, $this->settings->getExpiration(), 'yes');
     }
 
     /**
@@ -233,7 +231,7 @@ private function updateOptions(array $options) : bool
      */
     private function getEmptyCacheUrl() : string
     {
-        if (\apply_filters(self::FILTER_SHOW_ADMIN_MENU, true)) {
+        if ($this->showAdminMenu()) {
             return \wp_nonce_url(
                 \add_query_arg(
                     [
@@ -259,4 +257,31 @@ private function getEmptyCacheUrl() : string
             self::NONCE_NAME
         );
     }
+
+    /**
+     * Should the admin functions be shown?
+     * @return bool
+     */
+    private function showAdmin() : bool
+    {
+        return \apply_filters(self::FILTER_SHOW_ADMIN, true) === true;
+    }
+
+    /**
+     * Show the admin menu be shown?
+     * @return bool
+     */
+    private function showAdminMenu() : bool
+    {
+        return \apply_filters(self::FILTER_SHOW_ADMIN_MENU, true) === true;
+    }
+
+    /**
+     * Show the admin menu bar be shown?
+     * @return bool
+     */
+    private function showAdminMenuBar() : bool
+    {
+        return \apply_filters(self::FILTER_SHOW_ADMIN_BAR_MENU, true) === true;
+    }
 }
diff --git a/src/WpAdmin/Settings.php b/src/WpAdmin/Settings.php
@@ -20,14 +20,19 @@ class Settings extends BaseModel
      *
      * @var array $expiration
      */
-    protected $expiration;
+    protected $expiration = [];
 
+    /**
+     * Get's the expiration settings array.
+     * @return array
+     */
     public function getExpiration() : array
     {
         return $this->expiration;
     }
 
     /**
+     * Sets the expiration length.
      * @param int $length
      */
     public function setLength(int $length)
@@ -36,6 +41,7 @@ public function setLength(int $length)
     }
 
     /**
+     * Sets the expiration period.
      * @param int $period
      */
     public function setPeriod(int $period)
diff --git a/views/settings.php b/views/settings.php
@@ -21,11 +21,11 @@
 <div class="wrap">
     <h1><?php esc_html_e( 'WP REST API Cache', 'wp-rest-api-cache' ); ?></h1>
     <form action="" method="POST">
-        <?php wp_nonce_field( Admin::OPTION_KEY, Admin::NONCE_NAME ); ?>
+        <?php wp_nonce_field( 'rest_cache_options', Admin::NONCE_NAME ); ?>
         <table class="form-table">
             <tr>
                 <th scope="row"><?php esc_html_e( 'Empty all cache', 'wp-rest-api-cache' ); ?></th>
-                <td><a href="<?php echo esc_url( $cache_url ); ?>"
+                <td><a href="<?php echo esc_url( $cache_url->invoke( $this ) ); ?>"
                        class="button button-primary"><?php esc_html_e( 'empty cache', 'wp-rest-api-cache' ); ?></a></td>
             </tr>
             <tr>
diff --git a/wp-rest-api-cache.php b/wp-rest-api-cache.php
@@ -4,7 +4,7 @@
  * Description: Enable object caching for WordPress' REST API. Aids in increased response times of your applications endpoints.
  * Author: Austin Passy
  * Author URI: http://github.com/thefrosty
- * Version: 1.0.2
+ * Version: 1.1.0
  * Requires at least: 4.9
  * Tested up to: 4.9
  * Requires PHP: 7.0
@@ -14,10 +14,12 @@
 defined('ABSPATH') || exit;
 
 use Dwnload\WpRestApi\RestApi\RestDispatch;
+use Dwnload\WpRestApi\WpAdmin\Admin;
 use TheFrosty\WpUtilities\Plugin\PluginFactory;
 
 PluginFactory::create('rest-api-object-cache')
     ->addOnHook(RestDispatch::class)
+	->addOnHook(Admin::class)
     ->initialize();
 
 call_user_func_array(
