Use the symfony cache contracts

Author: Cyperghost

wcfsetup/install/files/lib/acp/page/CacheListPage.class.php

@@ -4,9 +4,9 @@
 
 use wcf\acp\action\CacheClearAction;
 use wcf\page\AbstractPage;
+use wcf\system\cache\adapter\DiskCacheAdapter;
+use wcf\system\cache\adapter\RedisCacheAdapter;
 use wcf\system\cache\CacheHandler;
-use wcf\system\cache\source\DiskCacheSource;
-use wcf\system\cache\source\RedisCacheSource;
 use wcf\system\exception\SystemException;
 use wcf\system\Regex;
 use wcf\system\request\LinkHandler;
@@ -62,25 +62,23 @@ public function readData()
 
         // init cache data
         $this->cacheData = [
-            'source' => \get_class(CacheHandler::getInstance()->getCacheSource()),
+            'source' => \get_class(CacheHandler::getInstance()->getCacheAdapter()),
             'version' => '',
             'size' => 0,
             'files' => 0,
         ];
 
         switch ($this->cacheData['source']) {
-            case DiskCacheSource::class:
+            case DiskCacheAdapter::class:
                 // set version
                 $this->cacheData['version'] = WCF_VERSION;
 
                 $this->readCacheFiles('data', FileUtil::unifyDirSeparator(WCF_DIR . 'cache'));
                 break;
 
-            case RedisCacheSource::class:
+            case RedisCacheAdapter::class:
                 // set version
-                $cacheSource = CacheHandler::getInstance()->getCacheSource();
-                \assert($cacheSource instanceof RedisCacheSource);
-                $this->cacheData['version'] = $cacheSource->getRedisVersion();
+                $this->cacheData['version'] = RedisCacheAdapter::getRedisVersion();
                 break;
         }
 

wcfsetup/install/files/lib/system/WCF.class.php

@@ -748,7 +748,7 @@ protected function initCoreObjects(): void
             return;
         }
 
-        self::$coreObjectCache = (new CoreObjectCache())->getCache();
+        self::$coreObjectCache = (new CoreObjectCache())->get();
     }
 
     /**

wcfsetup/install/files/lib/system/background/job/TolerantCacheRebuildBackgroundJob.class.php

@@ -97,7 +97,7 @@ protected function readObjects()
     {
         EventHandler::getInstance()->fireAction($this, 'readObjects');
 
-        $userIDs = (new WhoWasOnlineCache())->getCache();
+        $userIDs = (new WhoWasOnlineCache())->get();
 
         if (!empty($userIDs)) {
             $this->users = \array_filter(

wcfsetup/install/files/lib/system/box/WhoWasOnlineBoxController.class.php

@@ -2,140 +2,100 @@
 
 namespace wcf\system\cache;
 
-use wcf\system\cache\builder\ICacheBuilder;
-use wcf\system\cache\source\DiskCacheSource;
-use wcf\system\exception\SystemException;
+use Symfony\Component\Cache\Adapter\FilesystemTagAwareAdapter;
+use Symfony\Component\Cache\Adapter\TagAwareAdapterInterface;
+use Symfony\Contracts\Cache\TagAwareCacheInterface;
+use wcf\system\cache\adapter\DiskCacheAdapter;
+use wcf\system\cache\adapter\ICacheAdapter;
 use wcf\system\SingletonFactory;
 
 /**
  * Manages transparent cache access.
  *
- * @author  Alexander Ebert, Marcel Werk
- * @copyright   2001-2019 WoltLab GmbH
+ * @author  Olaf Braun, Alexander Ebert, Marcel Werk
+ * @copyright   2001-2025 WoltLab GmbH
  * @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
  */
-class CacheHandler extends SingletonFactory
+final class CacheHandler extends SingletonFactory
 {
-    /**
-     * cache source object
-     * @var \wcf\system\cache\source\ICacheSource
-     */
-    protected $cacheSource;
+    private TagAwareCacheInterface & TagAwareAdapterInterface $cache;
 
     /**
      * Creates a new CacheHandler object.
      */
     protected function init()
     {
-        // init cache source object
         try {
-            $className = 'wcf\system\cache\source\\' . \ucfirst(CACHE_SOURCE_TYPE) . 'CacheSource';
-            if (\class_exists($className)) {
-                $this->cacheSource = new $className();
-            } else {
-                // fallback to disk cache
-                $this->cacheSource = new DiskCacheSource();
+            $className = 'wcf\system\cache\adapter\\' . \ucfirst(CACHE_SOURCE_TYPE) . 'CacheAdapter';
+            if (!\is_subclass_of($className, ICacheAdapter::class)) {
+                $className = DiskCacheAdapter::class;
             }
-        } catch (SystemException $e) {
+
+            $this->cache = $className::getAdapter();
+        } catch (\Exception $e) {
             if (CACHE_SOURCE_TYPE != 'disk') {
                 // fallback to disk cache
-                $this->cacheSource = new DiskCacheSource();
+                $this->cache = DiskCacheAdapter::getAdapter();
             } else {
                 throw $e;
             }
         }
     }
 
-    /**
-     * Flush cache for given resource.
-     *
-     * @param ICacheBuilder $cacheBuilder
-     * @param array $parameters
-     */
-    public function flush(ICacheBuilder $cacheBuilder, array $parameters)
-    {
-        $this->getCacheSource()->flush($this->getCacheName($cacheBuilder, $parameters), empty($parameters));
-    }
-
     /**
      * Flushes the entire cache.
      */
-    public function flushAll()
+    public function flushAll(): void
     {
-        $this->getCacheSource()->flushAll();
+        $this->cache->clear();
     }
 
     /**
-     * Returns cached value for given resource, false if no cache exists.
+     * Returns the cache item for the given key.
      *
-     * @param ICacheBuilder $cacheBuilder
-     * @param array $parameters
-     * @return  mixed
+     * @template T of array|object
+     *
+     * @param ICacheCallback<T> $callback
+     *
+     * @return T
      */
-    public function get(ICacheBuilder $cacheBuilder, array $parameters)
+    public function get(string $key, ICacheCallback $callback, bool $forceRebuild = false): array|object
     {
-        return $this->getCacheSource()->get(
-            $this->getCacheName($cacheBuilder, $parameters),
-            $cacheBuilder->getMaxLifetime()
-        );
+        return $this->cache->get($key, $callback, $forceRebuild ? \INF : null);
     }
 
     /**
-     * Caches a value for given resource,
-     *
-     * @param ICacheBuilder $cacheBuilder
-     * @param array $parameters
-     * @param array $data
+     * Deletes the cache item for the given key.
      */
-    public function set(ICacheBuilder $cacheBuilder, array $parameters, array $data)
+    public function delete(string $key): bool
     {
-        $this->getCacheSource()->set(
-            $this->getCacheName($cacheBuilder, $parameters),
-            $data,
-            $cacheBuilder->getMaxLifetime()
-        );
+        return $this->cache->delete($key);
     }
 
     /**
-     * Returns cache index hash.
+     * Invalidates the cache items with the associated tags.
      *
-     * @param array $parameters
-     * @return  string
+     * @param list<string> $tags
      */
-    public function getCacheIndex(array $parameters)
+    public function invalidateTags(array $tags): bool
     {
-        return \sha1(\serialize($this->orderParameters($parameters)));
+        return $this->cache->invalidateTags($tags);
     }
 
     /**
-     * Builds cache name.
-     *
-     * @param ICacheBuilder $cacheBuilder
-     * @param array $parameters
-     * @return  string
+     * Returns cache index hash.
      */
-    protected function getCacheName(ICacheBuilder $cacheBuilder, array $parameters = [])
+    public function getCacheIndex(array $parameters): string
     {
-        $cacheName = \str_replace(
-            ['\\', 'system_cache_builder_'],
-            ['_', ''],
-            \get_class($cacheBuilder)
-        );
-        if (!empty($parameters)) {
-            $cacheName .= '-' . $this->getCacheIndex($parameters);
-        }
-
-        return $cacheName;
+        return \sha1(\serialize($this->orderParameters($parameters)));
     }
 
     /**
-     * Returns the cache source object.
-     *
-     * @return  \wcf\system\cache\source\ICacheSource
+     * Returns the cache adapter.
      */
-    public function getCacheSource()
+    public function getCacheAdapter(): TagAwareCacheInterface & TagAwareAdapterInterface
     {
-        return $this->cacheSource;
+        return $this->cache;
     }
 
     /**
@@ -162,7 +122,7 @@ public function sanityCheck(): bool
     {
         if (
             CACHE_SOURCE_TYPE != 'disk'
-            && \get_class(CacheHandler::getInstance()->getCacheSource()) === \wcf\system\cache\source\DiskCacheSource::class
+            && \get_class($this->cache) === FilesystemTagAwareAdapter::class
         ) {
             return false;
         }

wcfsetup/install/files/lib/system/cache/CacheHandler.class.php

@@ -0,0 +1,24 @@
+<?php
+
+namespace wcf\system\cache;
+
+use Symfony\Contracts\Cache\ItemInterface;
+
+/**
+ * @author Olaf Braun
+ * @copyright 2001-2025 WoltLab GmbH
+ * @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
+ * @since 6.2
+ *
+ * @template T of array|object
+ */
+interface ICacheCallback
+{
+    /**
+     * Generates the cache data and returns it.
+     * This method MUST NOT rely on any (runtime) cache at any point because those could be stale.
+     *
+     * @return T
+     */
+    public function __invoke(ItemInterface $item): array|object;
+}

wcfsetup/install/files/lib/system/cache/ICacheCallback.class.php

@@ -0,0 +1,20 @@
+<?php
+
+namespace wcf\system\cache\adapter;
+
+use Symfony\Component\Cache\Adapter\FilesystemTagAwareAdapter;
+
+/**
+ * @author Olaf Braun
+ * @copyright 2001-2025 WoltLab GmbH
+ * @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
+ * @since 6.2
+ */
+final class DiskCacheAdapter implements ICacheAdapter
+{
+    #[\Override]
+    public static function getAdapter(): FilesystemTagAwareAdapter
+    {
+        return new FilesystemTagAwareAdapter(namespace: 'cache', directory: WCF_DIR);
+    }
+}

wcfsetup/install/files/lib/system/cache/adapter/DiskCacheAdapter.class.php

@@ -0,0 +1,17 @@
+<?php
+
+namespace wcf\system\cache\adapter;
+
+use Symfony\Component\Cache\Adapter\TagAwareAdapterInterface;
+use Symfony\Contracts\Cache\TagAwareCacheInterface;
+
+/**
+ * @author Olaf Braun
+ * @copyright 2001-2025 WoltLab GmbH
+ * @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
+ * @since 6.2
+ */
+interface ICacheAdapter
+{
+    public static function getAdapter(): TagAwareCacheInterface & TagAwareAdapterInterface;
+}