Migrate "old" conditions

com.woltlab.wcf/package.xml

@@ -51,9 +51,8 @@
 	</instructions>
 
 	<!-- 
-	Required order of the following steps for the update to 6.2:
-	<instruction type="database" run="standalone">acp/database/update_com.woltlab.wcf_62_step1.php</instruction>
-	<instruction type="script">acp/update_com.woltlab.wcf_6.2_contactOptions.php</instruction>
-	<instruction type="database" run="standalone">acp/database/update_com.woltlab.wcf_62_step2.php</instruction>
+	Required order of the following steps for the update to 6.3:
+	<instruction type="database" run="standalone">acp/database/update_com.woltlab.wcf_6.3_step1.php</instruction>
+	<instruction type="script">acp/update_com.woltlab.wcf_6.3_userGroupAssignment.php</instruction>
 	-->
 </package>

wcfsetup/install/files/acp/database/update_com.woltlab.wcf_6.3_step1.php

@@ -8,12 +8,14 @@
  * @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
  */
 
+use wcf\system\database\table\column\DefaultFalseBooleanDatabaseTableColumn;
 use wcf\system\database\table\column\MediumtextDatabaseTableColumn;
 use wcf\system\database\table\PartialDatabaseTable;
 
 return [
     PartialDatabaseTable::create('wcf1_user_group_assignment')
         ->columns([
             MediumtextDatabaseTableColumn::create('conditions'),
+            DefaultFalseBooleanDatabaseTableColumn::create('isLegacy'),
         ]),
 ];

wcfsetup/install/files/acp/templates/userGroupAssignmentList.tpl

@@ -14,6 +14,12 @@
 	</nav>
 </header>
 
+{if $hasLegacyObjects}
+	<woltlab-core-notice type="warning">
+		{lang}wcf.acp.group.assignment.legacyNotice{/lang}
+	</woltlab-core-notice>
+{/if}
+
 <div class="section">
 	{unsafe:$gridView->render()}
 </div>

wcfsetup/install/files/acp/update_com.woltlab.wcf_6.3_userGroupAssignment.php

@@ -0,0 +1,59 @@
+<?php
+
+use wcf\system\condition\ConditionHandler;
+use wcf\system\WCF;
+use wcf\util\JSON;
+
+$exportedConditions = ConditionHandler::getInstance()->exportConditions("com.woltlab.wcf.condition.userGroupAssignment");
+if ($exportedConditions === []) {
+    return;
+}
+
+$sql = "UPDATE wcf1_user_group_assignment
+        SET    conditions = ?,
+               isLegacy = ?
+        WHERE  assignmentID = ?";
+$statement = WCF::getDB()->prepare($sql);
+foreach ($exportedConditions as $assignmentID => $conditionData) {
+    renameObjectTypes($conditionData);
+
+    $statement->execute([
+        JSON::encode($conditionData),
+        1,
+        $assignmentID,
+    ]);
+}
+
+/**
+ * Rename the object types so that the migration functions can handle them.
+ * @see \wcf\system\condition\provider\UserConditionProvider
+ *
+ * @param array<string, mixed> $conditionData
+ */
+function renameObjectTypes(array &$conditionData): void
+{
+    $objectTypeMap = [
+        'com.woltlab.wcf.username' => 'com.woltlab.wcf.user.username',
+        'com.woltlab.wcf.email' => 'com.woltlab.wcf.user.email',
+        'com.woltlab.wcf.userGroup' => 'com.woltlab.wcf.user.userGroup',
+        'com.woltlab.wcf.languages' => 'com.woltlab.wcf.user.languages',
+        'com.woltlab.wcf.registrationDate' => 'com.woltlab.wcf.user.registrationDate',
+        'com.woltlab.wcf.registrationDateInterval' => 'com.woltlab.wcf.user.registrationDateInterval',
+        'com.woltlab.wcf.avatar' => 'com.woltlab.wcf.user.avatar',
+        'com.woltlab.wcf.signature' => 'com.woltlab.wcf.user.signature',
+        'com.woltlab.wcf.coverPhoto' => 'com.woltlab.wcf.user.coverPhoto',
+        'com.woltlab.wcf.state' => 'com.woltlab.wcf.user.state',
+        'com.woltlab.wcf.activityPoints' => 'com.woltlab.wcf.user.activityPoints',
+        'com.woltlab.wcf.likesReceived' => 'com.woltlab.wcf.user.likesReceived',
+        // TODO 'com.woltlab.wcf.userOptions'
+        'com.woltlab.wcf.userTrophyCondition' => 'com.woltlab.wcf.user.trophyCondition',
+        'com.woltlab.wcf.trophyPoints' => 'com.woltlab.wcf.user.trophyPoints',
+    ];
+
+    foreach ($objectTypeMap as $currentName => $newName) {
+        if (isset($conditionData[$currentName])) {
+            $conditionData[$newName] = $conditionData[$currentName];
+            unset($conditionData[$currentName]);
+        }
+    }
+}

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

@@ -4,6 +4,9 @@
 
 use wcf\data\user\group\assignment\UserGroupAssignment;
 use wcf\system\exception\IllegalLinkException;
+use wcf\system\exception\NamedUserException;
+use wcf\system\WCF;
+use wcf\util\HtmlString;
 
 /**
  * Shows the form to edit an existing automatic user group assignment.
@@ -39,5 +42,11 @@ public function readParameters()
         if (!$this->formObject->assignmentID) {
             throw new IllegalLinkException();
         }
+
+        if ($this->formObject->isLegacy) {
+            throw new NamedUserException(
+                HtmlString::fromSafeHtml(WCF::getLanguage()->getDynamicVariable('wcf.acp.group.assignment.legacyNotice'))
+            );
+        }
     }
 }

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

@@ -4,6 +4,7 @@
 
 use wcf\page\AbstractGridViewPage;
 use wcf\system\gridView\admin\UserGroupAssignmentGridView;
+use wcf\system\WCF;
 
 /**
  * Lists the available automatic user group assignments.
@@ -31,4 +32,25 @@ protected function createGridView(): UserGroupAssignmentGridView
     {
         return new UserGroupAssignmentGridView();
     }
+
+    #[\Override]
+    public function assignVariables()
+    {
+        parent::assignVariables();
+
+        WCF::getTPL()->assign([
+            'hasLegacyObjects' => $this->hasLegacyObjects(),
+        ]);
+    }
+
+    private function hasLegacyObjects(): bool
+    {
+        $sql = "SELECT COUNT(*) AS count
+                FROM   wcf1_user_group_assignment
+                WHERE  isLegacy = ?";
+        $statement = WCF::getDB()->prepare($sql);
+        $statement->execute([1]);
+
+        return $statement->fetchColumn() > 0;
+    }
 }

wcfsetup/install/files/lib/bootstrap/com.woltlab.wcf.php

@@ -97,6 +97,7 @@ static function (\wcf\event\worker\RebuildWorkerCollecting $event) {
             $event->register(\wcf\system\worker\UnfurlUrlRebuildDataWorker::class, 450);
             $event->register(\wcf\system\worker\FileRebuildDataWorker::class, 475);
             $event->register(\wcf\system\worker\SitemapRebuildWorker::class, 500);
+            $event->register(\wcf\system\worker\UserGroupAssignmentRebuildDataWorker::class, 600);
             $event->register(\wcf\system\worker\StatDailyRebuildDataWorker::class, 800);
         }
     );

wcfsetup/install/files/lib/data/user/group/UserGroupEditor.class.php

@@ -4,9 +4,9 @@
 
 use wcf\data\DatabaseObjectEditor;
 use wcf\data\IEditableCachedObject;
-use wcf\system\cache\builder\UserGroupAssignmentCacheBuilder;
 use wcf\system\cache\builder\UserGroupCacheBuilder;
 use wcf\system\cache\builder\UserGroupPermissionCacheBuilder;
+use wcf\system\cache\eager\UserGroupAssignmentCache;
 use wcf\system\exception\SystemException;
 use wcf\system\user\storage\UserStorageHandler;
 use wcf\system\WCF;
@@ -208,7 +208,7 @@ public static function resetCache()
         UserGroupPermissionCacheBuilder::getInstance()->reset();
 
         // https://github.com/WoltLab/WCF/issues/4045
-        UserGroupAssignmentCacheBuilder::getInstance()->reset();
+        (new UserGroupAssignmentCache())->rebuild();
 
         // Clear cached group assignments.
         UserStorageHandler::getInstance()->resetAll('groupIDs');

wcfsetup/install/files/lib/data/user/group/assignment/UserGroupAssignment.class.php

@@ -19,6 +19,7 @@
  * @property-read   string $title          title of the automatic user group assignment
  * @property-read   int $isDisabled     is `1` if the user group assignment is disabled and thus not checked for automatic assignments, otherwise `0`
  * @property-read string $conditions JSON-encoded string containing the conditions of the automatic user group assignment
+ * @property-read bool $isLegacy indicates whether the conditions need to be migrated to the new format
  */
 class UserGroupAssignment extends DatabaseObject implements IRouteController
 {

wcfsetup/install/files/lib/data/user/group/assignment/UserGroupAssignmentEditor.class.php

@@ -4,7 +4,7 @@
 
 use wcf\data\DatabaseObjectEditor;
 use wcf\data\IEditableCachedObject;
-use wcf\system\cache\builder\UserGroupAssignmentCacheBuilder;
+use wcf\system\cache\eager\UserGroupAssignmentCache;
 
 /**
  * Executes user group assignment-related actions.
@@ -29,6 +29,6 @@ class UserGroupAssignmentEditor extends DatabaseObjectEditor implements IEditabl
      */
     public static function resetCache()
     {
-        UserGroupAssignmentCacheBuilder::getInstance()->reset();
+        (new UserGroupAssignmentCache())->rebuild();
     }
 }

wcfsetup/install/files/lib/event/acp/dashboard/box/MigrationCollecting.class.php

@@ -0,0 +1,37 @@
+<?php
+
+namespace wcf\event\acp\dashboard\box;
+
+use wcf\event\IPsr14Event;
+
+/**
+ * Requests the collection of objects that still need to be migrated
+ *
+ * @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 MigrationCollecting implements IPsr14Event
+{
+    /**
+     * @var string[]
+     */
+    private array $needsMigration = [];
+
+    /**
+     * Adds the name of objects that still need to be migrated on the `RebuildDataPage`
+     */
+    public function migrationNeeded(string $title): void
+    {
+        $this->needsMigration[] = $title;
+    }
+
+    /**
+     * @return string[]
+     */
+    public function needsMigration(): array
+    {
+        return $this->needsMigration;
+    }
+}

wcfsetup/install/files/lib/system/acp/dashboard/box/StatusMessageAcpDashboardBox.class.php

@@ -3,6 +3,7 @@
 namespace wcf\system\acp\dashboard\box;
 
 use wcf\data\devtools\missing\language\item\DevtoolsMissingLanguageItemList;
+use wcf\event\acp\dashboard\box\MigrationCollecting;
 use wcf\event\acp\dashboard\box\PHPExtensionCollecting;
 use wcf\event\acp\dashboard\box\StatusMessageCollecting;
 use wcf\system\application\ApplicationHandler;
@@ -60,6 +61,7 @@ private function getMessages(): array
                 $this->getPHPExtensionMessage(),
                 $this->getEvaluationMessages(),
                 $this->getBasicMessages(),
+                $this->getMigrationMessage(),
                 $this->getCustomMessages()
             );
         }
@@ -271,4 +273,42 @@ private function getPHPExtensionMessage(): array
 
         return [];
     }
+
+    /**
+     * @return StatusMessage[]
+     *
+     * @since 6.2
+     */
+    private function getMigrationMessage(): array
+    {
+        $event = new MigrationCollecting();
+        EventHandler::getInstance()->fire($event);
+        if ($this->userGroupAssignmentHasLegacyObjects()) {
+            $event->migrationNeeded(WCF::getLanguage()->get('wcf.acp.group.assignment'));
+        }
+
+        if ($event->needsMigration() === []) {
+            return [];
+        }
+
+        return [
+            new StatusMessage(
+                StatusMessageType::Warning,
+                WCF::getLanguage()->getDynamicVariable('wcf.acp.dashboard.box.migrationNeeded', [
+                    'titles' => $event->needsMigration(),
+                ])
+            ),
+        ];
+    }
+
+    private function userGroupAssignmentHasLegacyObjects(): bool
+    {
+        $sql = "SELECT COUNT(*) AS count
+                FROM   wcf1_user_group_assignment
+                WHERE  isLegacy = ?";
+        $statement = WCF::getDB()->prepare($sql);
+        $statement->execute([1]);
+
+        return $statement->fetchColumn() > 0;
+    }
 }

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

@@ -2,26 +2,28 @@
 
 namespace wcf\system\cache\builder;
 
-use wcf\data\user\group\assignment\UserGroupAssignmentList;
+use wcf\system\cache\eager\UserGroupAssignmentCache;
 
 /**
  * Caches the enabled automatic user group assignments.
  *
  * @author  Matthias Schmidt
  * @copyright   2001-2019 WoltLab GmbH
  * @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
+ *
+ * @deprecated 6.2 use `UserGroupAssignmentCache` instead
  */
-class UserGroupAssignmentCacheBuilder extends AbstractCacheBuilder
+final class UserGroupAssignmentCacheBuilder extends AbstractLegacyCacheBuilder
 {
-    /**
-     * @inheritDoc
-     */
-    protected function rebuild(array $parameters)
+    #[\Override]
+    protected function rebuild(array $parameters): array
     {
-        $assignmentList = new UserGroupAssignmentList();
-        $assignmentList->getConditionBuilder()->add('isDisabled = ?', [0]);
-        $assignmentList->readObjects();
+        return (new UserGroupAssignmentCache())->getCache();
+    }
 
-        return $assignmentList->getObjects();
+    #[\Override]
+    public function reset(array $parameters = [])
+    {
+        (new UserGroupAssignmentCache())->rebuild();
     }
 }

wcfsetup/install/files/lib/system/cache/eager/UserGroupAssignmentCache.class.php

@@ -0,0 +1,30 @@
+<?php
+
+namespace wcf\system\cache\eager;
+
+use wcf\data\user\group\assignment\UserGroupAssignment;
+use wcf\data\user\group\assignment\UserGroupAssignmentList;
+
+/**
+ * Caches the enabled automatic user group assignments.
+ *
+ * @author Olaf Braun
+ * @copyright 2001-2025 WoltLab GmbH
+ * @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
+ * @since 6.3
+ *
+ * @extends AbstractEagerCache<array<int, UserGroupAssignment>>
+ */
+final class UserGroupAssignmentCache extends AbstractEagerCache
+{
+    #[\Override]
+    protected function getCacheData(): array
+    {
+        $assignmentList = new UserGroupAssignmentList();
+        $assignmentList->getConditionBuilder()->add('isDisabled = ?', [0]);
+        $assignmentList->getConditionBuilder()->add('isLegacy = ?', [0]);
+        $assignmentList->readObjects();
+
+        return $assignmentList->getObjects();
+    }
+}