Add migration support for user group assignment conditions

Author: Cyperghost

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('needMigration'),
         ]),
 ];

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

@@ -0,0 +1,23 @@
+<?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 = ?,
+               needMigration = ?
+        WHERE  assignmentID = ?";
+$statement = WCF::getDB()->prepare($sql);
+foreach ($exportedConditions as $assignmentID => $conditionData) {
+    $statement->execute([
+        JSON::encode($conditionData),
+        1,
+        $assignmentID,
+    ]);
+}

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

@@ -4,6 +4,7 @@
 
 use wcf\data\user\group\assignment\UserGroupAssignment;
 use wcf\system\exception\IllegalLinkException;
+use wcf\system\user\group\assignment\command\UserGroupAssignmentMigrateCondition;
 
 /**
  * Shows the form to edit an existing automatic user group assignment.
@@ -39,5 +40,10 @@ public function readParameters()
         if (!$this->formObject->assignmentID) {
             throw new IllegalLinkException();
         }
+
+        if ($this->formObject->needMigration) {
+            (new UserGroupAssignmentMigrateCondition($this->formObject))();
+            $this->formObject = new UserGroupAssignment(\intval($_REQUEST['id']));
+        }
     }
 }

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 $needMigration 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/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,50 @@
+<?php
+
+namespace wcf\system\cache\eager;
+
+use wcf\data\user\group\assignment\UserGroupAssignment;
+use wcf\data\user\group\assignment\UserGroupAssignmentList;
+use wcf\system\user\group\assignment\command\UserGroupAssignmentMigrateCondition;
+
+/**
+ * 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 = $this->getUserGroupAssignments();
+
+        $migrationDone = false;
+        foreach ($assignmentList as $assignment) {
+            if ($assignment->needMigration) {
+                (new UserGroupAssignmentMigrateCondition($assignment))();
+                $migrationDone = true;
+            }
+        }
+
+        if ($migrationDone) {
+            // Reload the list to ensure that no disabled assignments are included
+            return $this->getUserGroupAssignments()->getObjects();
+        } else {
+            return $assignmentList->getObjects();
+        }
+    }
+
+    private function getUserGroupAssignments(): UserGroupAssignmentList
+    {
+        $assignmentList = new UserGroupAssignmentList();
+        $assignmentList->getConditionBuilder()->add('isDisabled = ?', [0]);
+        $assignmentList->readObjects();
+
+        return $assignmentList;
+    }
+}

wcfsetup/install/files/lib/system/condition/provider/UserConditionProvider.class.php

@@ -42,7 +42,7 @@ public function __construct()
             new UserInGroupConditionType(),
             new UserNotInGroupConditionType(),
             new UserLanguageConditionType(),
-            new class("avatar", 'avatarFileID') extends AbstractUserIsNullConditionType {},
+            new class("avatar", 'avatarFileID', 'userAvatar', 'com.woltlab.wcf.avatar') extends AbstractUserIsNullConditionType {},
             new UserSignatureConditionType(),
             new class("coverPhoto", 'coverPhotoFileID') extends AbstractUserIsNullConditionType {},
             new class("isBanned", 'banned') extends AbstractUserBooleanConditionType {},