Merge pull request #6237 from WoltLab/6.2-tolerant-cache

Eager and Tolerant Caching

Author: Cyperghost

wcfsetup/install/files/lib/acp/form/BoxAddForm.class.php

@@ -630,7 +630,7 @@ public function save()
             'cssClassName' => $this->cssClassName,
             'showHeader' => $this->showHeader,
             'isDisabled' => $this->isDisabled ? 1 : 0,
-            'linkPageID' => $this->linkPageID,
+            'linkPageID' => $this->linkPageID ?: null,
             'linkPageObjectID' => $this->linkPageObjectID ?: 0,
             'externalURL' => $this->externalURL,
             'identifier' => '',

wcfsetup/install/files/lib/acp/form/BoxEditForm.class.php

@@ -119,7 +119,7 @@ public function save()
             'cssClassName' => $this->cssClassName,
             'showHeader' => $this->showHeader,
             'isDisabled' => $this->isDisabled ? 1 : 0,
-            'linkPageID' => $this->linkPageID,
+            'linkPageID' => $this->linkPageID ?: null,
             'linkPageObjectID' => $this->linkPageObjectID ?: 0,
             'externalURL' => $this->externalURL,
             'invertPermissions' => $this->invertPermissions,

wcfsetup/install/files/lib/acp/form/LanguageMultilingualismForm.class.php

@@ -5,7 +5,7 @@
 use wcf\data\language\Language;
 use wcf\data\language\LanguageEditor;
 use wcf\form\AbstractForm;
-use wcf\system\cache\builder\LanguageCacheBuilder;
+use wcf\system\cache\eager\LanguageCache;
 use wcf\system\exception\UserInputException;
 use wcf\system\language\LanguageFactory;
 use wcf\system\WCF;
@@ -116,7 +116,7 @@ public function save()
         LanguageEditor::enableMultilingualism(($this->enable == 1 ? $this->languageIDs : []));
 
         // clear cache
-        LanguageCacheBuilder::getInstance()->reset();
+        (new LanguageCache())->rebuild();
         $this->saved();
 
         // show success message

wcfsetup/install/files/lib/data/language/LanguageEditor.class.php

@@ -10,7 +10,7 @@
 use wcf\data\language\item\LanguageItemList;
 use wcf\data\page\PageEditor;
 use wcf\event\language\LanguageContentCopying;
-use wcf\system\cache\builder\LanguageCacheBuilder;
+use wcf\system\cache\eager\LanguageCache;
 use wcf\system\database\util\PreparedStatementConditionBuilder;
 use wcf\system\event\EventHandler;
 use wcf\system\exception\SystemException;
@@ -932,7 +932,7 @@ public function setAsDefault()
         $statement->execute([0]);
 
         // set current language as default language
-        $this->update(['isDefault' => 1]);
+        $this->update(['isDefault' => 1, 'isDisabled' => 0]);
 
         $this->clearCache();
     }
@@ -944,7 +944,7 @@ public function setAsDefault()
      */
     public function clearCache()
     {
-        LanguageCacheBuilder::getInstance()->reset();
+        (new LanguageCache())->rebuild();
     }
 
     /**

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

@@ -12,13 +12,12 @@
 use wcf\system\application\IApplication;
 use wcf\system\benchmark\Benchmark;
 use wcf\system\box\BoxHandler;
-use wcf\system\cache\builder\CoreObjectCacheBuilder;
 use wcf\system\cache\builder\PackageUpdateCacheBuilder;
+use wcf\system\cache\eager\CoreObjectCache;
 use wcf\system\database\MySQLDatabase;
 use wcf\system\event\EventHandler;
 use wcf\system\exception\ErrorException;
 use wcf\system\exception\IPrintableException;
-use wcf\system\exception\ParentClassException;
 use wcf\system\exception\SystemException;
 use wcf\system\language\LanguageFactory;
 use wcf\system\package\command\RebuildBootstrapper;
@@ -140,9 +139,10 @@ class WCF
 
     /**
      * list of cached core objects
-     * @var string[]
+     *
+     * @var array<string, class-string<SingletonFactory>>
      */
-    protected static $coreObjectCache = [];
+    protected static array $coreObjectCache;
 
     /**
      * database object
@@ -752,7 +752,7 @@ protected function initCoreObjects(): void
             return;
         }
 
-        self::$coreObjectCache = CoreObjectCacheBuilder::getInstance()->getData();
+        self::$coreObjectCache = (new CoreObjectCache())->getCache();
     }
 
     /**
@@ -919,10 +919,6 @@ final public static function __callStatic(string $name, array $arguments)
         }
 
         if (\class_exists($objectName)) {
-            if (!\is_subclass_of($objectName, SingletonFactory::class)) {
-                throw new ParentClassException($objectName, SingletonFactory::class);
-            }
-
             self::$coreObject[$className] = \call_user_func([$objectName, 'getInstance']);
 
             return self::$coreObject[$className];
@@ -934,7 +930,7 @@ final public static function __callStatic(string $name, array $arguments)
     /**
      * Searches for cached core object definition.
      *
-     * @return  string|null
+     * @return  class-string<SingletonFactory>|null
      */
     final protected static function getCoreObject(string $className)
     {

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

@@ -10,7 +10,7 @@
 use wcf\data\package\installation\queue\PackageInstallationQueueEditor;
 use wcf\data\user\User;
 use wcf\data\user\UserAction;
-use wcf\system\cache\builder\LanguageCacheBuilder;
+use wcf\system\cache\eager\LanguageCache;
 use wcf\system\database\Database;
 use wcf\system\database\exception\DatabaseException;
 use wcf\system\database\MySQLDatabase;
@@ -779,7 +779,7 @@ protected function installLanguage(): ResponseInterface
         LanguageFactory::getInstance()->makeDefault($language->languageID);
 
         // rebuild language cache
-        LanguageCacheBuilder::getInstance()->reset();
+        (new LanguageCache())->rebuild();
 
         return $this->gotoNextStep('createUser');
     }

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

@@ -0,0 +1,60 @@
+<?php
+
+namespace wcf\system\background\job;
+
+use wcf\system\cache\CacheHandler;
+use wcf\system\cache\tolerant\AbstractTolerantCache;
+
+/**
+ * Rebuilds the cache data of a tolerant cache.
+ *
+ * @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 TolerantCacheRebuildBackgroundJob extends AbstractUniqueBackgroundJob
+{
+    public function __construct(
+        /** @var class-string<AbstractTolerantCache<array|object> */
+        public readonly string $cacheClass,
+        /** @var array<string, mixed> */
+        public readonly array $parameters = []
+    ) {
+    }
+
+    public function identifier(): string
+    {
+        $identifier = $this->cacheClass;
+        if (!empty($this->parameters)) {
+            $identifier .= '-' . CacheHandler::getInstance()->getCacheIndex($this->parameters);
+        }
+
+        return $identifier;
+    }
+
+    #[\Override]
+    public function newInstance(): static
+    {
+        return new TolerantCacheRebuildBackgroundJob($this->cacheClass, $this->parameters);
+    }
+
+    #[\Override]
+    public function queueAgain(): bool
+    {
+        return false;
+    }
+
+    #[\Override]
+    public function perform()
+    {
+        if (!\class_exists($this->cacheClass)) {
+            return;
+        }
+
+        $asyncCache = new $this->cacheClass(...$this->parameters);
+        \assert($asyncCache instanceof AbstractTolerantCache);
+
+        $asyncCache->rebuild();
+    }
+}

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

@@ -7,8 +7,8 @@
 use wcf\data\user\online\UserOnline;
 use wcf\data\user\online\UsersOnlineList;
 use wcf\data\user\UserProfile;
-use wcf\system\cache\builder\WhoWasOnlineCacheBuilder;
 use wcf\system\cache\runtime\UserProfileRuntimeCache;
+use wcf\system\cache\tolerant\WhoWasOnlineCache;
 use wcf\system\event\EventHandler;
 use wcf\system\WCF;
 use wcf\util\DateUtil;
@@ -100,14 +100,9 @@ protected function readObjects()
     {
         EventHandler::getInstance()->fireAction($this, 'readObjects');
 
-        $userIDs = WhoWasOnlineCacheBuilder::getInstance()->getData();
+        $userIDs = (new WhoWasOnlineCache())->getCache();
 
         if (!empty($userIDs)) {
-            if (WCF::getUser()->userID && !\in_array(WCF::getUser()->userID, $userIDs)) {
-                // current user is missing in cache -> reset cache
-                WhoWasOnlineCacheBuilder::getInstance()->reset();
-            }
-
             $this->users = \array_filter(
                 UserProfileRuntimeCache::getInstance()->getObjects($userIDs),
                 static function ($user) {

wcfsetup/install/files/lib/system/cache/builder/AbstractLegacyCacheBuilder.class.php

@@ -0,0 +1,58 @@
+<?php
+
+namespace wcf\system\cache\builder;
+
+use wcf\system\cache\CacheHandler;
+use wcf\system\exception\SystemException;
+use wcf\system\SingletonFactory;
+
+/**
+ * Provides a backwards compatible interface for ICacheBuilder classes that have been migrated to the eager or tolerant cache implementations.
+ *
+ * @author Olaf Braun
+ * @copyright 2001-2025 WoltLab GmbH
+ * @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
+ *
+ * @since 6.2
+ * @deprecated 6.2
+ */
+abstract class AbstractLegacyCacheBuilder extends SingletonFactory implements ICacheBuilder
+{
+    /**
+     * @var array<string, array<string|int, mixed>>
+     */
+    private array $cache = [];
+
+    #[\Override]
+    public function getData(array $parameters = [], $arrayIndex = '')
+    {
+        $index = CacheHandler::getInstance()->getCacheIndex($parameters);
+        if (isset($this->cache[$index])) {
+            $cache = $this->cache[$index];
+        } else {
+            $cache = $this->rebuild($parameters);
+            $this->cache[$index] = $cache;
+        }
+
+        if (!empty($arrayIndex)) {
+            if (!\array_key_exists($arrayIndex, $cache)) {
+                throw new SystemException("array index '" . $arrayIndex . "' does not exist in cache resource");
+            }
+
+            return $cache[$arrayIndex];
+        }
+
+        return $cache;
+    }
+
+    /**
+     * Rebuilds cache for current resource.
+     */
+    abstract protected function rebuild(array $parameters): array;
+
+    #[\Override]
+    final public function getMaxLifetime()
+    {
+        return 0;
+    }
+}

wcfsetup/install/files/lib/system/cache/builder/CoreObjectCacheBuilder.class.php

@@ -2,34 +2,28 @@
 
 namespace wcf\system\cache\builder;
 
-use wcf\data\core\object\CoreObjectList;
+use wcf\system\cache\eager\CoreObjectCache;
 
 /**
  * Caches the core objects.
  *
- * @author  Alexander Ebert
- * @copyright   2001-2019 WoltLab GmbH
+ * @author Olaf Braun, Alexander Ebert
+ * @copyright 2001-2025 WoltLab GmbH
  * @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
+ *
+ * @deprecated 6.2 use `CoreObjectCache` instead
  */
-class CoreObjectCacheBuilder extends AbstractCacheBuilder
+class CoreObjectCacheBuilder extends AbstractLegacyCacheBuilder
 {
-    /**
-     * @inheritDoc
-     */
-    public function rebuild(array $parameters)
+    #[\Override]
+    public function reset(array $parameters = [])
     {
-        $data = [];
-
-        $coreObjectList = new CoreObjectList();
-        $coreObjectList->readObjects();
-        $coreObjects = $coreObjectList->getObjects();
-
-        foreach ($coreObjects as $coreObject) {
-            $tmp = \explode('\\', $coreObject->objectName);
-            $className = \array_pop($tmp);
-            $data[$className] = $coreObject->objectName;
-        }
+        (new CoreObjectCache())->rebuild();
+    }
 
-        return $data;
+    #[\Override]
+    public function rebuild(array $parameters): array
+    {
+        return (new CoreObjectCache())->getCache();
     }
 }