Merge branch 'refs/heads/6.2-overhaul-caching' into 6.2-tolerant-cache

Cyperghost · Cyperghost · commit 2877423ee69f · 2025-02-21T19:35:40.000+01:00
diff --git a/wcfsetup/install/files/lib/system/cache/builder/AbstractLegacyCacheBuilder.class.php b/wcfsetup/install/files/lib/system/cache/builder/AbstractLegacyCacheBuilder.class.php
@@ -9,16 +9,19 @@
 /**
  * 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>
+ * @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
+ * @since 6.2
+ * @deprecated 6.2
  */
 abstract class AbstractLegacyCacheBuilder extends SingletonFactory implements ICacheBuilder
 {
-    protected array $cache = [];
+    /**
+     * @var array<string, array<string|int, mixed>>
+     */
+    private array $cache = [];
 
     #[\Override]
     public function getData(array $parameters = [], $arrayIndex = '')
diff --git a/wcfsetup/install/files/lib/system/cache/builder/CoreObjectCacheBuilder.class.php b/wcfsetup/install/files/lib/system/cache/builder/CoreObjectCacheBuilder.class.php
@@ -7,11 +7,11 @@
 /**
  * Caches the core objects.
  *
- * @author      Alexander Ebert
- * @copyright   2001-2019 WoltLab GmbH
- * @license     GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
+ * @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
+ * @deprecated 6.2 use `CoreObjectCache` instead
  */
 class CoreObjectCacheBuilder extends AbstractLegacyCacheBuilder
 {
diff --git a/wcfsetup/install/files/lib/system/cache/builder/LanguageCacheBuilder.class.php b/wcfsetup/install/files/lib/system/cache/builder/LanguageCacheBuilder.class.php
@@ -7,11 +7,11 @@
 /**
  * Caches languages and the id of the default language.
  *
- * @author      Olaf Braun, Marcel Werk
- * @copyright   2001-2025 WoltLab GmbH
- * @license     GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
+ * @author Olaf Braun, Marcel Werk
+ * @copyright 2001-2025 WoltLab GmbH
+ * @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
  *
- * @deprecated  6.2 use `LanguageCache` instead
+ * @deprecated 6.2 use `LanguageCache` instead
  */
 class LanguageCacheBuilder extends AbstractLegacyCacheBuilder
 {
diff --git a/wcfsetup/install/files/lib/system/cache/eager/AbstractEagerCache.class.php b/wcfsetup/install/files/lib/system/cache/eager/AbstractEagerCache.class.php
@@ -5,10 +5,10 @@
 use wcf\system\cache\CacheHandler;
 
 /**
- * @author      Olaf Braun
- * @copyright   2001-2025 WoltLab GmbH
- * @license     GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
- * @since       6.2
+ * @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
  */
@@ -25,7 +25,7 @@ abstract class AbstractEagerCache
      *
      * @return T
      */
-    final public function getCache(): array | object
+    final public function getCache(): array|object
     {
         $key = $this->getCacheKey();
 
@@ -97,5 +97,5 @@ final public function rebuild(): void
      *
      * @return T
      */
-    abstract protected function getCacheData(): array | object;
+    abstract protected function getCacheData(): array|object;
 }
diff --git a/wcfsetup/install/files/lib/system/cache/eager/CoreObjectCache.class.php b/wcfsetup/install/files/lib/system/cache/eager/CoreObjectCache.class.php
@@ -8,10 +8,10 @@
 /**
  * Eager cache implementation for core objects.
  *
- * @author      Olaf Braun
- * @copyright   2001-2025 WoltLab GmbH
- * @license     GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
- * @since       6.2
+ * @author Olaf Braun
+ * @copyright 2001-2025 WoltLab GmbH
+ * @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
+ * @since 6.2
  *
  * @extends AbstractEagerCache<array<string, class-string<SingletonFactory>>>
  */
diff --git a/wcfsetup/install/files/lib/system/cache/eager/LanguageCache.class.php b/wcfsetup/install/files/lib/system/cache/eager/LanguageCache.class.php
@@ -6,15 +6,14 @@
 use wcf\data\language\category\LanguageCategoryList;
 use wcf\data\language\LanguageList;
 use wcf\system\cache\eager\data\LanguageCacheData;
-use wcf\system\exception\SystemException;
 
 /**
  * Eager cache implementation for languages.
  *
- * @author      Olaf Braun
- * @copyright   2001-2025 WoltLab GmbH
- * @license     GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
- * @since       6.2
+ * @author Olaf Braun
+ * @copyright 2001-2025 WoltLab GmbH
+ * @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
+ * @since 6.2
  *
  * @extends AbstractEagerCache<LanguageCacheData>
  */
@@ -59,7 +58,7 @@ protected function getCacheData(): LanguageCacheData
         }
 
         if (!isset($languages[$default])) {
-            throw new SystemException('No default language defined!');
+            throw new \RuntimeException('No default language defined!');
         }
 
         return new LanguageCacheData(
diff --git a/wcfsetup/install/files/lib/system/cache/eager/data/LanguageCacheData.class.php b/wcfsetup/install/files/lib/system/cache/eager/data/LanguageCacheData.class.php
@@ -8,10 +8,10 @@
 /**
  * Language cache data structure.
  *
- * @author      Olaf Braun
- * @copyright   2001-2025 WoltLab GmbH
- * @license     GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
- * @since       6.2
+ * @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 LanguageCacheData
 {
@@ -50,36 +50,33 @@ public function getLanguage(int $languageID): ?Language
     /**
      * Returns the language category with the given category name.
      */
-    public function getLanguageCategory(string $categoryName): ?LanguageCategory
+    public function getCategory(string $categoryName): ?LanguageCategory
     {
         return $this->categories[$categoryName] ?? null;
     }
 
     /**
      * Returns the language category with the given category id.
      */
-    public function getLanguageCategoryByID(int $languageCategoryID): ?LanguageCategory
+    public function getCategoryByID(int $languageCategoryID): ?LanguageCategory
     {
         $categoryName = $this->categoryIDs[$languageCategoryID] ?? null;
         if ($categoryName === null) {
             return null;
         }
 
-        return $this->getLanguageCategory($categoryName);
+        return $this->getCategory($categoryName);
     }
 
-    /**
-     * Returns `true` if the language category with the given category name exists.
-     */
-    public function languageCategoryExists(string $categoryName): bool
+    public function hasCategory(string $categoryName): bool
     {
         return \array_key_exists($categoryName, $this->categories);
     }
 
     /**
      * Return all content languages.
      *
-     * @return list<Language>
+     * @return array<int, Language>
      */
     public function getContentLanguages(): array
     {
@@ -96,10 +93,7 @@ public function getContentLanguages(): array
      */
     public function getContentLanguageIDs(): array
     {
-        return \array_map(
-            static fn(Language $language) => $language->languageID,
-            $this->getContentLanguages()
-        );
+        return \array_keys($this->getContentLanguages());
     }
 
     /**
diff --git a/wcfsetup/install/files/lib/system/language/LanguageFactory.class.php b/wcfsetup/install/files/lib/system/language/LanguageFactory.class.php
@@ -9,16 +9,15 @@
 use wcf\data\language\LanguageEditor;
 use wcf\system\cache\eager\data\LanguageCacheData;
 use wcf\system\cache\eager\LanguageCache;
-use wcf\system\exception\SystemException;
 use wcf\system\SingletonFactory;
 use wcf\system\template\TemplateScriptingCompiler;
 use wcf\system\WCF;
 
 /**
  * Handles language related functions.
  *
- * @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>
  */
 class LanguageFactory extends SingletonFactory
@@ -73,42 +72,41 @@ public function getUserLanguage(?int $languageID = null): Language
      */
     public function getLanguageByCode(string $languageCode): ?Language
     {
-        $language = $this->getLanguageByCode($languageCode);
-        if ($language === null) {
+        if ($this->cache->codes === []) {
             // called within WCFSetup
             $sql = "SELECT  *
                     FROM    wcf1_language
                     WHERE   languageCode = ?";
             $statement = WCF::getDB()->prepare($sql);
             $statement->execute([$languageCode]);
-            $language = $statement->fetchObject(Language::class);
+            return $statement->fetchObject(Language::class);
+        } else {
+            return $this->getLanguageByCode($languageCode);
         }
-
-        return $language;
     }
 
     /**
      * Returns true if the language category with the given name exists.
      */
     public function isValidCategory(string $categoryName): bool
     {
-        return $this->cache->languageCategoryExists($categoryName);
+        return $this->cache->hasCategory($categoryName);
     }
 
     /**
      * Returns the language category with the given name.
      */
     public function getCategory(string $categoryName): ?LanguageCategory
     {
-        return $this->cache->getLanguageCategory($categoryName);
+        return $this->cache->getCategory($categoryName);
     }
 
     /**
      * Returns language category by id.
      */
     public function getCategoryByID(int $languageCategoryID): ?LanguageCategory
     {
-        return $this->cache->getLanguageCategoryByID($languageCategoryID);
+        return $this->cache->getCategoryByID($languageCategoryID);
     }
 
     /**
@@ -138,7 +136,7 @@ protected function findPreferredLanguage(): int
             }
         }
 
-        throw new SystemException("No language found for language code '{$languageCode}'");
+        throw new \RuntimeException("No language found for language code '{$languageCode}'");
     }
 
     /**

Original file line number	Diff line number	Diff line change
`@@ -7,11 +7,11 @@`
`7`	`7`	`/**`
`8`	`8`	`* Caches the core objects.`
`9`	`9`	`*`
`10`		`- * @author Alexander Ebert`
`11`		`- * @copyright 2001-2019 WoltLab GmbH`
`12`		`- * @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>`
	`10`	`+ * @author Olaf Braun, Alexander Ebert`
	`11`	`+ * @copyright 2001-2025 WoltLab GmbH`
	`12`	`+ * @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>`
`13`	`13`	`*`
`14`		- * @deprecated 6.2 use `CoreObjectCache` instead
	`14`	+ * @deprecated 6.2 use `CoreObjectCache` instead
`15`	`15`	`*/`
`16`	`16`	`class CoreObjectCacheBuilder extends AbstractLegacyCacheBuilder`
`17`	`17`	`{`
Original file line number	Diff line number	Diff line change
`@@ -7,11 +7,11 @@`
`7`	`7`	`/**`
`8`	`8`	`* Caches languages and the id of the default language.`
`9`	`9`	`*`
`10`		`- * @author Olaf Braun, Marcel Werk`
`11`		`- * @copyright 2001-2025 WoltLab GmbH`
`12`		`- * @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>`
	`10`	`+ * @author Olaf Braun, Marcel Werk`
	`11`	`+ * @copyright 2001-2025 WoltLab GmbH`
	`12`	`+ * @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>`
`13`	`13`	`*`
`14`		- * @deprecated 6.2 use `LanguageCache` instead
	`14`	+ * @deprecated 6.2 use `LanguageCache` instead
`15`	`15`	`*/`
`16`	`16`	`class LanguageCacheBuilder extends AbstractLegacyCacheBuilder`
`17`	`17`	`{`
Original file line number	Diff line number	Diff line change
`@@ -5,10 +5,10 @@`
`5`	`5`	`use wcf\system\cache\CacheHandler;`
`6`	`6`
`7`	`7`	`/**`
`8`		`- * @author Olaf Braun`
`9`		`- * @copyright 2001-2025 WoltLab GmbH`
`10`		`- * @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>`
`11`		`- * @since 6.2`
	`8`	`+ * @author Olaf Braun`
	`9`	`+ * @copyright 2001-2025 WoltLab GmbH`
	`10`	`+ * @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>`
	`11`	`+ * @since 6.2`
`12`	`12`	`*`
`13`	`13`	`* @template T of array\|object`
`14`	`14`	`*/`
`@@ -25,7 +25,7 @@ abstract class AbstractEagerCache`
`25`	`25`	`*`
`26`	`26`	`* @return T`
`27`	`27`	`*/`
`28`		`- final public function getCache(): array \| object`
	`28`	`+ final public function getCache(): array\|object`
`29`	`29`	`{`
`30`	`30`	`$key = $this->getCacheKey();`
`31`	`31`
`@@ -97,5 +97,5 @@ final public function rebuild(): void`
`97`	`97`	`*`
`98`	`98`	`* @return T`
`99`	`99`	`*/`
`100`		`- abstract protected function getCacheData(): array \| object;`
	`100`	`+ abstract protected function getCacheData(): array\|object;`
`101`	`101`	`}`
Original file line number	Diff line number	Diff line change
`@@ -8,10 +8,10 @@`
`8`	`8`	`/**`
`9`	`9`	`* Language cache data structure.`
`10`	`10`	`*`
`11`		`- * @author Olaf Braun`
`12`		`- * @copyright 2001-2025 WoltLab GmbH`
`13`		`- * @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>`
`14`		`- * @since 6.2`
	`11`	`+ * @author Olaf Braun`
	`12`	`+ * @copyright 2001-2025 WoltLab GmbH`
	`13`	`+ * @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>`
	`14`	`+ * @since 6.2`
`15`	`15`	`*/`
`16`	`16`	`final class LanguageCacheData`
`17`	`17`	`{`
`@@ -50,36 +50,33 @@ public function getLanguage(int $languageID): ?Language`
`50`	`50`	`/**`
`51`	`51`	`* Returns the language category with the given category name.`
`52`	`52`	`*/`
`53`		`- public function getLanguageCategory(string $categoryName): ?LanguageCategory`
	`53`	`+ public function getCategory(string $categoryName): ?LanguageCategory`
`54`	`54`	`{`
`55`	`55`	`return $this->categories[$categoryName] ?? null;`
`56`	`56`	`}`
`57`	`57`
`58`	`58`	`/**`
`59`	`59`	`* Returns the language category with the given category id.`
`60`	`60`	`*/`
`61`		`- public function getLanguageCategoryByID(int $languageCategoryID): ?LanguageCategory`
	`61`	`+ public function getCategoryByID(int $languageCategoryID): ?LanguageCategory`
`62`	`62`	`{`
`63`	`63`	`$categoryName = $this->categoryIDs[$languageCategoryID] ?? null;`
`64`	`64`	`if ($categoryName === null) {`
`65`	`65`	`return null;`
`66`	`66`	`}`
`67`	`67`
`68`		`- return $this->getLanguageCategory($categoryName);`
	`68`	`+ return $this->getCategory($categoryName);`
`69`	`69`	`}`
`70`	`70`
`71`		`- /**`
`72`		- * Returns `true` if the language category with the given category name exists.
`73`		`- */`
`74`		`- public function languageCategoryExists(string $categoryName): bool`
	`71`	`+ public function hasCategory(string $categoryName): bool`
`75`	`72`	`{`
`76`	`73`	`return \array_key_exists($categoryName, $this->categories);`
`77`	`74`	`}`
`78`	`75`
`79`	`76`	`/**`
`80`	`77`	`* Return all content languages.`
`81`	`78`	`*`
`82`		`- * @return list<Language>`
	`79`	`+ * @return array<int, Language>`
`83`	`80`	`*/`
`84`	`81`	`public function getContentLanguages(): array`
`85`	`82`	`{`
`@@ -96,10 +93,7 @@ public function getContentLanguages(): array`
`96`	`93`	`*/`
`97`	`94`	`public function getContentLanguageIDs(): array`
`98`	`95`	`{`
`99`		`- return \array_map(`
`100`		`- static fn(Language $language) => $language->languageID,`
`101`		`- $this->getContentLanguages()`
`102`		`- );`
	`96`	`+ return \array_keys($this->getContentLanguages());`
`103`	`97`	`}`
`104`	`98`
`105`	`99`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -9,16 +9,15 @@`
`9`	`9`	`use wcf\data\language\LanguageEditor;`
`10`	`10`	`use wcf\system\cache\eager\data\LanguageCacheData;`
`11`	`11`	`use wcf\system\cache\eager\LanguageCache;`
`12`		`-use wcf\system\exception\SystemException;`
`13`	`12`	`use wcf\system\SingletonFactory;`
`14`	`13`	`use wcf\system\template\TemplateScriptingCompiler;`
`15`	`14`	`use wcf\system\WCF;`
`16`	`15`
`17`	`16`	`/**`
`18`	`17`	`* Handles language related functions.`
`19`	`18`	`*`
`20`		`- * @author Alexander Ebert`
`21`		`- * @copyright 2001-2019 WoltLab GmbH`
	`19`	`+ * @author Olaf Braun, Alexander Ebert`
	`20`	`+ * @copyright 2001-2025 WoltLab GmbH`
`22`	`21`	`* @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>`
`23`	`22`	`*/`
`24`	`23`	`class LanguageFactory extends SingletonFactory`
`@@ -73,42 +72,41 @@ public function getUserLanguage(?int $languageID = null): Language`
`73`	`72`	`*/`
`74`	`73`	`public function getLanguageByCode(string $languageCode): ?Language`
`75`	`74`	`{`
`76`		`- $language = $this->getLanguageByCode($languageCode);`
`77`		`- if ($language === null) {`
	`75`	`+ if ($this->cache->codes === []) {`
`78`	`76`	`// called within WCFSetup`
`79`	`77`	`$sql = "SELECT *`
`80`	`78`	`FROM wcf1_language`
`81`	`79`	`WHERE languageCode = ?";`
`82`	`80`	`$statement = WCF::getDB()->prepare($sql);`
`83`	`81`	`$statement->execute([$languageCode]);`
`84`		`- $language = $statement->fetchObject(Language::class);`
	`82`	`+ return $statement->fetchObject(Language::class);`
	`83`	`+ } else {`
	`84`	`+ return $this->getLanguageByCode($languageCode);`
`85`	`85`	`}`
`86`		`-`
`87`		`- return $language;`
`88`	`86`	`}`
`89`	`87`
`90`	`88`	`/**`
`91`	`89`	`* Returns true if the language category with the given name exists.`
`92`	`90`	`*/`
`93`	`91`	`public function isValidCategory(string $categoryName): bool`
`94`	`92`	`{`
`95`		`- return $this->cache->languageCategoryExists($categoryName);`
	`93`	`+ return $this->cache->hasCategory($categoryName);`
`96`	`94`	`}`
`97`	`95`
`98`	`96`	`/**`
`99`	`97`	`* Returns the language category with the given name.`
`100`	`98`	`*/`
`101`	`99`	`public function getCategory(string $categoryName): ?LanguageCategory`
`102`	`100`	`{`
`103`		`- return $this->cache->getLanguageCategory($categoryName);`
	`101`	`+ return $this->cache->getCategory($categoryName);`
`104`	`102`	`}`
`105`	`103`
`106`	`104`	`/**`
`107`	`105`	`* Returns language category by id.`
`108`	`106`	`*/`
`109`	`107`	`public function getCategoryByID(int $languageCategoryID): ?LanguageCategory`
`110`	`108`	`{`
`111`		`- return $this->cache->getLanguageCategoryByID($languageCategoryID);`
	`109`	`+ return $this->cache->getCategoryByID($languageCategoryID);`
`112`	`110`	`}`
`113`	`111`
`114`	`112`	`/**`
`@@ -138,7 +136,7 @@ protected function findPreferredLanguage(): int`
`138`	`136`	`}`
`139`	`137`	`}`
`140`	`138`
`141`		`- throw new SystemException("No language found for language code '{$languageCode}'");`
	`139`	`+ throw new \RuntimeException("No language found for language code '{$languageCode}'");`
`142`	`140`	`}`
`143`	`141`
`144`	`142`	`/**`