Merge branch 'release-3.1.0'

Author: chesio

CHANGELOG.md

@@ -1,5 +1,17 @@
 # BC Cache Changelog
 
+## Upcoming version 3.1.0 (2023-01-04)
+
+### Changed
+
+* WordPress 5.9 or newer is now required [#88](https://github.com/chesio/bc-cache/issues/88).
+* Improved serialization of data stored in database [#90](https://github.com/chesio/bc-cache/issues/90).
+* On WordPress 6.1 and newer, output buffering is started in `send_headers` action already [#87](https://github.com/chesio/bc-cache/issues/87).
+
+### Fixed
+
+* Prevent deprecation notices on PHP 8.1 and newer [#89](https://github.com/chesio/bc-cache/issues/89).
+
 ## Version 3.0.1 (2022-12-28)
 
 ### Fixed

README.md

@@ -7,13 +7,13 @@ Modern and simple full page cache plugin for WordPress inspired by [Cachify](htt
 
 BC Cache has no settings page - it is intended for webmasters who are familiar with `.htaccess` files and WordPress actions and filters.
 
-BC Cache can cache not only HTML pages, but [core XML sitemaps](https://make.wordpress.org/core/2020/07/22/new-xml-sitemaps-functionality-in-wordpress-5-5/) as well. Technically, any content type generated by WordPress for front-end requests routed via root `index.php` file can be handled provided that output generation triggers [`template_redirect`](https://developer.wordpress.org/reference/hooks/template_redirect/) hook.
+BC Cache can cache not only HTML pages, but [core XML sitemaps](https://make.wordpress.org/core/2020/07/22/new-xml-sitemaps-functionality-in-wordpress-5-5/) as well. Technically, any content type generated by WordPress for front-end requests routed via root `index.php` file can be handled provided that output generation triggers [`send_headers`](https://developer.wordpress.org/reference/hooks/send_headers/) (on WordPress 6.1 and newer) or [`template_redirect`](https://developer.wordpress.org/reference/hooks/template_redirect/) (on WordPress 6.0 and older) hook.
 
 ## Requirements
 
 * Apache webserver with [mod_rewrite](https://httpd.apache.org/docs/current/mod/mod_rewrite.html) enabled
 * [PHP](https://www.php.net/) 7.3 or newer
-* [WordPress](https://wordpress.org/) 5.5 or newer with [pretty permalinks](https://codex.wordpress.org/Using_Permalinks) on
+* [WordPress](https://wordpress.org/) 5.9 or newer with [pretty permalinks](https://codex.wordpress.org/Using_Permalinks) on
 
 ## Limitations
 
@@ -233,7 +233,7 @@ wp cron event schedule 'bc-cache/action:flush-cache' midnight daily
 A response to HTTP(S) request is **not** cached by BC Cache if **any** of the conditions below evaluates as true:
 
 1. Request is a POST request.
-2. Request is a GET request with one or more query string fields that are not whitelisted. By default, the whitelist consists of [Google click IDs](https://support.google.com/searchads/answer/7342044), [Facebook Click Identifier](https://fbclid.com/) and standard [UTM parameters](https://en.wikipedia.org/wiki/UTM_parameters), but it can be [filtered](#filters).
+2. Request is a GET request with one or more query string fields that are not whitelisted. By default, the whitelist consists of [Google click IDs](https://support.google.com/searchads/answer/7342044), [Facebook Click Identifier](https://fbclid.com/), [Microsoft Click ID](https://help.ads.microsoft.com/apex/index/3/en/60000) and standard [UTM parameters](https://en.wikipedia.org/wiki/UTM_parameters), but it can be [filtered](#filters).
 3. Request is not for a front-end page (ie. [`wp_using_themes`](https://developer.wordpress.org/reference/functions/wp_using_themes/) returns `false`). Output of AJAX, WP-CLI or WP-Cron calls is never cached.
 4. Request comes from a non-anonymous user (ie. user that is logged in, left a comment or accessed password protected page/post). The rule can be tweaked to ignore [front-end users](#front-end-users-and-caching) if your theme supports it.
 5. Request/response type is one of the following: search, 404, feed, trackback, robots.txt, preview or password protected post.

autoload.php

@@ -5,17 +5,17 @@
  */
 
 // Register autoload function
-spl_autoload_register(function (string $class) {
+\spl_autoload_register(function (string $class) {
     // Only autoload classes shipped with the plugin.
-    if (strpos($class, 'BlueChip\\Cache') !== 0) {
+    if (!\str_starts_with($class, 'BlueChip\\Cache')) {
         return;
     }
 
     // Get absolute name of class file
-    $file = __DIR__ . '/classes/' . str_replace('\\', '/', $class) . '.php';
+    $file = __DIR__ . '/classes/' . \str_replace('\\', '/', $class) . '.php';
 
     // If the class file is readable, load it!
-    if (is_readable($file)) {
+    if (\is_readable($file)) {
         require_once $file;
     }
 });

bc-cache.php

@@ -4,11 +4,11 @@
  * Plugin Name: BC Cache
  * Plugin URI: https://github.com/chesio/bc-cache
  * Description: Simple full page cache plugin inspired by Cachify.
- * Version: 3.0.1
+ * Version: 3.1.0
  * Author: Česlav Przywara <ceslav@przywara.cz>
  * Author URI: https://www.chesio.com
  * Requires PHP: 7.3
- * Requires WP: 5.5
+ * Requires WP: 5.9
  * Tested up to: 6.1
  * Text Domain: bc-cache
  * GitHub Plugin URI: https://github.com/chesio/bc-cache

classes/BlueChip/Cache/Core.php

@@ -595,13 +595,13 @@ private function getPath(string $url): string
             $url_parts['host'],
             trailingslashit($url_path),
             // URL path ends with slash? Yes: treat as directory path. No: treat as file path.
-            Utils::endsWithString($url_path, '/') ? self::DIRECTORY_PATH_DIRNAME : self::FILE_PATH_DIRNAME
+            \str_ends_with($url_path, '/') ? self::DIRECTORY_PATH_DIRNAME : self::FILE_PATH_DIRNAME
         ]);
 
         $normalized_path = self::normalizePath($path);
 
         // Make sure that normalized path still points to a subdirectory of root cache directory.
-        if (\strpos($normalized_path, $this->cache_dir . DIRECTORY_SEPARATOR) !== 0) {
+        if (!\str_starts_with($normalized_path, $this->cache_dir . DIRECTORY_SEPARATOR)) {
             throw new Exception("Could not retrieve a valid cache filename from URL {$url}.");
         }
 
@@ -626,7 +626,7 @@ private function getUrl(string $path): string
         $normalized_path = self::normalizePath($path);
 
         // The path must point to a subdirectory of root cache directory.
-        if (\strpos($normalized_path, $this->cache_dir . DIRECTORY_SEPARATOR) !== 0) {
+        if (!\str_starts_with($normalized_path, $this->cache_dir . DIRECTORY_SEPARATOR)) {
             throw new Exception("Path {$path} is not a valid cache path.");
         }
 
@@ -645,12 +645,12 @@ private function getUrl(string $path): string
         }
 
         $path = DIRECTORY_SEPARATOR . $subparts[1];
-        if (Utils::endsWithString($path, DIRECTORY_SEPARATOR . self::FILE_PATH_DIRNAME)) {
+        if (\str_ends_with($path, DIRECTORY_SEPARATOR . self::FILE_PATH_DIRNAME)) {
             // Strip file path dirname including trailing directory separator.
-            $path = substr($path, 0, -1 * strlen(DIRECTORY_SEPARATOR . self::FILE_PATH_DIRNAME));
-        } elseif (Utils::endsWithString($path, DIRECTORY_SEPARATOR . self::DIRECTORY_PATH_DIRNAME)) {
+            $path = \substr($path, 0, -1 * \strlen(DIRECTORY_SEPARATOR . self::FILE_PATH_DIRNAME));
+        } elseif (\str_ends_with($path, DIRECTORY_SEPARATOR . self::DIRECTORY_PATH_DIRNAME)) {
             // Strip directory path dirname, but keep trailing directory separator.
-            $path = substr($path, 0, -1 * strlen(self::DIRECTORY_PATH_DIRNAME));
+            $path = \substr($path, 0, -1 * \strlen(self::DIRECTORY_PATH_DIRNAME));
         }
 
         return $parts[0] . '://' . $subparts[0] . \str_replace(DIRECTORY_SEPARATOR, '/', $path);
@@ -850,7 +850,7 @@ private static function prepareHtaccessFile(array $headers): string
         $headers = \array_filter(
             $headers,
             function (string $header): bool {
-                return \strpos($header, ':') !== false;
+                return \str_contains($header, ':');
             }
         );
 

classes/BlueChip/Cache/Info.php

@@ -24,7 +24,7 @@ class Info
 
 
     /**
-     * @var mixed[] Cache data (lazy loaded)
+     * @var array Cache data (lazy loaded)
      */
     private $data = [];
 

classes/BlueChip/Cache/Item.php

@@ -5,8 +5,13 @@
 /**
  * A single cache item consists of URL and request variant.
  */
-class Item
+class Item extends Serializable
 {
+    /**
+     * @var int Internal class version (used for serialization/unserialization)
+     */
+    protected const DB_VERSION = 1;
+
     /**
      * @var string
      */
@@ -30,6 +35,24 @@ public function __construct(string $url, string $request_variant)
     }
 
 
+    /**
+     * @internal Serialization helper.
+     */
+    protected function deflate(): array
+    {
+        return ['request_variant' => $this->request_variant, 'url' => $this->url];
+    }
+
+
+    /**
+     * @internal Serialization helper.
+     */
+    public function inflate(array $data): void
+    {
+        ['request_variant' => $this->request_variant, 'url' => $this->url] = $data;
+    }
+
+
     public function getUrl(): string
     {
         return $this->url;

classes/BlueChip/Cache/ListTable.php

@@ -105,13 +105,13 @@ public function __construct(Core $cache, ?Crawler $cache_crawler, ?Feeder $cache
         // Get list of request variants.
         $this->request_variants = $cache->getRequestVariants();
 
-        $order_by = \filter_input(INPUT_GET, 'orderby', FILTER_SANITIZE_STRING);
+        $order_by = \filter_input(INPUT_GET, 'orderby');
         if (\in_array($order_by, $this->get_sortable_columns(), true)) {
             $this->order_by = $order_by;
             $this->url = add_query_arg('orderby', $order_by, $this->url);
         }
 
-        $order = \filter_input(INPUT_GET, 'order', FILTER_SANITIZE_STRING);
+        $order = \filter_input(INPUT_GET, 'order');
         if ($order === 'asc' || $order === 'desc') {
             $this->order = $order;
             $this->url = add_query_arg('order', $order, $this->url);
@@ -339,7 +339,7 @@ public function processActions(): void
                 return;
             }
 
-            $request_variant = \filter_input(INPUT_GET, 'request_variant', FILTER_SANITIZE_STRING);
+            $request_variant = \filter_input(INPUT_GET, 'request_variant');
             if (!isset($this->request_variants[$request_variant])) {
                 return;
             }

classes/BlueChip/Cache/Plugin.php

@@ -139,6 +139,11 @@ class Plugin
      */
     private $cache_feeder;
 
+    /**
+     * @var bool|null Null if cache has not been flushed yet in this request or cache flush status.
+     */
+    private $cache_is_flushed = null;
+
 
     /**
      * Perform activation and installation tasks.
@@ -291,7 +296,9 @@ public function init(): void
             }
         } else {
             // Add action to catch output buffer.
-            add_action('template_redirect', [$this, 'startOutputBuffering'], 0, 0);
+            // Use `send_headers` action from WordPress 6.1 on - see:
+            // https://make.wordpress.org/core/2022/10/10/moving-the-send_headers-action-to-later-in-the-load/
+            add_action(is_wp_version_compatible('6.1') ? 'send_headers' : 'template_redirect', [$this, 'startOutputBuffering'], 0, 0);
         }
 
         if ($this->cache_crawler) {
@@ -488,18 +495,12 @@ public function enqueueDashboardAssets(): void
      * Flush cache once per request only.
      *
      * @see Core::flush()
-     *
-     * @return bool Cached result of call to Core::flush().
      */
-    public function flushCacheOnce(): bool
+    public function flushCacheOnce(): void
     {
-        static $is_flushed = null;
-
-        if ($is_flushed === null) {
-            $is_flushed = $this->cache->flush();
+        if ($this->cache_is_flushed === null) {
+            $this->cache_is_flushed = $this->cache->flush();
         }
-
-        return $is_flushed;
     }
 
 

classes/BlueChip/Cache/Serializable.php

@@ -0,0 +1,48 @@
+<?php
+
+namespace BlueChip\Cache;
+
+/**
+ * Serialization helper
+ *
+ * @internal As soon as PHP 7.4 is required, only __serialize() and __unserialize() methods are necessary.
+ */
+abstract class Serializable implements \Serializable
+{
+    /**
+     * @var int
+     *
+     * @internal Should be overriden in child classes to non-zero value and incremented on every class properties change.
+     */
+    protected const DB_VERSION = 0;
+
+
+    public function serialize(): string
+    {
+        return \serialize($this->__serialize());
+    }
+
+
+    public function unserialize($serialized): void
+    {
+        $this->__unserialize(\unserialize($serialized));
+    }
+
+
+    public function __serialize(): array
+    {
+        return ['db_version' => static::DB_VERSION, 'data' => $this->deflate()];
+    }
+
+
+    public function __unserialize(array $data): void
+    {
+        if ($data['db_version'] === static::DB_VERSION) {
+            $this->inflate($data['data']);
+        }
+    }
+
+    abstract protected function deflate(): array;
+
+    abstract protected function inflate(array $data);
+}