Deprecated UserAction methods to enable/unban a user and enable avatar, cover photos and signature. Move this functionality to a command. Implement events that are triggered when this action is performed.

Author: Cyperghost

wcfsetup/install/files/lib/data/user/UserAction.class.php

@@ -28,9 +28,14 @@
 use wcf\system\user\command\BanUser;
 use wcf\system\user\command\DisableAvatar;
 use wcf\system\user\command\DisableSignature;
+use wcf\system\user\command\DisableUser;
+use wcf\system\user\command\EnableAvatar;
+use wcf\system\user\command\EnableCoverPhoto;
+use wcf\system\user\command\EnableSignature;
+use wcf\system\user\command\EnableUser;
+use wcf\system\user\command\UnbanUser;
 use wcf\system\user\group\assignment\UserGroupAssignmentHandler;
 use wcf\system\WCF;
-use wcf\util\UserRegistrationUtil;
 
 /**
  * Executes user-related actions.
@@ -262,23 +267,18 @@ public function ban()
      * Unbans users.
      *
      * @return void
+     *
+     * @deprecated 6.3 use `UnbanUser`
      */
     public function unban()
     {
-        $conditionBuilder = new PreparedStatementConditionBuilder();
-        $conditionBuilder->add('userID IN (?)', [$this->objectIDs]);
+        if ($this->objects === []) {
+            $this->readObjects();
+        }
 
-        $sql = "UPDATE  wcf1_user
-                SET     banned = ?,
-                        banExpires = ?
-                " . $conditionBuilder;
-        $statement = WCF::getDB()->prepare($sql);
-        $statement->execute(
-            \array_merge([
-                0,
-                0,
-            ], $conditionBuilder->getParameters())
-        );
+        foreach ($this->getObjects() as $userEditor) {
+            (new UnbanUser($userEditor->getDecoratedObject()))();
+        }
     }
 
     /**
@@ -759,59 +759,18 @@ public function unconfirmEmail()
      * Enables users.
      *
      * @return void
+     *
+     * @deprecated 6.3 use `EnableUser`
      */
     public function enable()
     {
         if (empty($this->objects)) {
             $this->readObjects();
         }
 
-        $data = [
-            'activationCode' => 0,
-            'blacklistMatches' => '',
-        ];
-
-        if (!((int)REGISTER_ACTIVATION_METHOD & User::REGISTER_ACTIVATION_USER)) {
-            $data['emailConfirmed'] = null;
-        }
-
-        $action = new self($this->objects, 'update', [
-            'data' => $data,
-            'removeGroups' => UserGroup::getGroupIDsByType([UserGroup::GUESTS]),
-        ]);
-        $action->executeAction();
-        $action = new self($this->objects, 'addToGroups', [
-            'groups' => UserGroup::getGroupIDsByType([UserGroup::USERS]),
-            'deleteOldGroups' => false,
-            'addDefaultGroups' => false,
-        ]);
-        $action->executeAction();
-
-        // send e-mail notification
-        if (empty($this->parameters['skipNotification'])) {
-            foreach ($this->getObjects() as $user) {
-                $email = new Email();
-                $email->setMessageID(\sprintf(
-                    'com.woltlab.wcf.adminActivation/%d/%d/%s',
-                    $user->userID,
-                    TIME_NOW,
-                    \bin2hex(\random_bytes(8))
-                ));
-                $email->addRecipient(new UserMailbox($user->getDecoratedObject()));
-                $email->setSubject($user->getLanguage()->getDynamicVariable('wcf.acp.user.activation.mail.subject'));
-                $email->setBody(new MimePartFacade([
-                    new RecipientAwareTextMimePart('text/html', 'email_adminActivation'),
-                    new RecipientAwareTextMimePart('text/plain', 'email_adminActivation'),
-                ]));
-                $email->send();
-            }
-        }
-
-        $userIDs = [];
         foreach ($this->getObjects() as $user) {
-            $userIDs[] = $user->userID;
+            (new EnableUser($user->getDecoratedObject(), $this->parameters['skipNotification'] ?? false))();
         }
-        UserGroupAssignmentHandler::getInstance()->checkUsers($userIDs);
 
         $this->unmarkItems();
     }
@@ -820,31 +779,18 @@ public function enable()
      * Disables users.
      *
      * @return void
+     *
+     * @deprecated 6.3 use `DisableUser`
      */
     public function disable()
     {
         if (empty($this->objects)) {
             $this->readObjects();
         }
 
-        // We reset the activationCode (which indicates, that the user is not enabled) AND disable the email
-        // confirm status, because if the user can enable himself by an email confirmation and we do not reset
-        // the email confirmed status, the behavior is undefined, because a user exists, which is not enabled
-        // but has a valid email address (Which doesn't usually happen).
-        $action = new self($this->objects, 'update', [
-            'data' => [
-                'activationCode' => UserRegistrationUtil::getActivationCode(),
-                'emailConfirmed' => Hex::encode(\random_bytes(20)),
-            ],
-            'removeGroups' => UserGroup::getGroupIDsByType([UserGroup::USERS]),
-        ]);
-        $action->executeAction();
-        $action = new self($this->objects, 'addToGroups', [
-            'groups' => UserGroup::getGroupIDsByType([UserGroup::GUESTS]),
-            'deleteOldGroups' => false,
-            'addDefaultGroups' => false,
-        ]);
-        $action->executeAction();
+        foreach ($this->getObjects() as $userEditor) {
+            (new DisableUser($userEditor->getDecoratedObject()))();
+        }
 
         $this->unmarkItems();
     }
@@ -937,6 +883,8 @@ public function validateEnableSignature()
      * Enables the signature of the handled users.
      *
      * @return void
+     *
+     * @deprecated 6.3 use `EnableSignature`
      */
     public function enableSignature()
     {
@@ -945,9 +893,7 @@ public function enableSignature()
         }
 
         foreach ($this->getObjects() as $userEditor) {
-            $userEditor->update([
-                'disableSignature' => 0,
-            ]);
+            (new EnableSignature($userEditor->getDecoratedObject()))();
         }
     }
 
@@ -1057,6 +1003,8 @@ public function validateEnableAvatar()
      * Enables the avatar of the handled users.
      *
      * @return void
+     *
+     * @deprecated 6.3 use `EnableAvatar`
      */
     public function enableAvatar()
     {
@@ -1065,9 +1013,7 @@ public function enableAvatar()
         }
 
         foreach ($this->getObjects() as $userEditor) {
-            $userEditor->update([
-                'disableAvatar' => 0,
-            ]);
+            (new EnableAvatar($userEditor->getDecoratedObject()))();
         }
     }
 
@@ -1097,6 +1043,8 @@ public function validateEnableCoverPhoto()
      *
      * @return void
      * @since   5.2
+     *
+     * @deprecated 6.3 use `EnableCoverPhoto`
      */
     public function enableCoverPhoto()
     {
@@ -1105,9 +1053,7 @@ public function enableCoverPhoto()
         }
 
         foreach ($this->getObjects() as $userEditor) {
-            $userEditor->update([
-                'disableCoverPhoto' => 0,
-            ]);
+            (new EnableCoverPhoto($userEditor->getDecoratedObject()))();
         }
     }
 

wcfsetup/install/files/lib/event/user/UserAvatarEnabled.class.php

@@ -0,0 +1,21 @@
+<?php
+
+namespace wcf\event\user;
+
+use wcf\data\user\User;
+use wcf\event\IPsr14Event;
+
+/**
+ * Indicates that a user's avatar has been enabled.
+ *
+ * @author Olaf Braun
+ * @copyright 2001-2025 WoltLab GmbH
+ * @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
+ * @since 6.3
+ */
+final class UserAvatarEnabled implements IPsr14Event
+{
+    public function __construct(public readonly User $user)
+    {
+    }
+}

wcfsetup/install/files/lib/event/user/UserCoverPhotoEnabled.class.php

@@ -0,0 +1,21 @@
+<?php
+
+namespace wcf\event\user;
+
+use wcf\data\user\User;
+use wcf\event\IPsr14Event;
+
+/**
+ * Indicates that a user's cover photo has been enabled.
+ *
+ * @author Olaf Braun
+ * @copyright 2001-2025 WoltLab GmbH
+ * @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
+ * @since 6.3
+ */
+final class UserCoverPhotoEnabled implements IPsr14Event
+{
+    public function __construct(public readonly User $user)
+    {
+    }
+}

wcfsetup/install/files/lib/event/user/UserDisabled.class.php

@@ -0,0 +1,21 @@
+<?php
+
+namespace wcf\event\user;
+
+use wcf\data\user\User;
+use wcf\event\IPsr14Event;
+
+/**
+ * Indicates that a user has been disabled.
+ *
+ * @author Olaf Braun
+ * @copyright 2001-2025 WoltLab GmbH
+ * @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
+ * @since 6.3
+ */
+final class UserDisabled implements IPsr14Event
+{
+    public function __construct(public readonly User $user)
+    {
+    }
+}

wcfsetup/install/files/lib/event/user/UserEnabled.class.php

@@ -0,0 +1,21 @@
+<?php
+
+namespace wcf\event\user;
+
+use wcf\data\user\User;
+use wcf\event\IPsr14Event;
+
+/**
+ * Indicates that a user has been enabled.
+ *
+ * @author Olaf Braun
+ * @copyright 2001-2025 WoltLab GmbH
+ * @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
+ * @since 6.3
+ */
+final class UserEnabled implements IPsr14Event
+{
+    public function __construct(public readonly User $user)
+    {
+    }
+}

wcfsetup/install/files/lib/event/user/UserSignatureEnabled.class.php

@@ -0,0 +1,21 @@
+<?php
+
+namespace wcf\event\user;
+
+use wcf\data\user\User;
+use wcf\event\IPsr14Event;
+
+/**
+ * Indicates that a user's signature has been enabled.
+ *
+ * @author Olaf Braun
+ * @copyright 2001-2025 WoltLab GmbH
+ * @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
+ * @since 6.3
+ */
+final class UserSignatureEnabled implements IPsr14Event
+{
+    public function __construct(public readonly User $user)
+    {
+    }
+}

wcfsetup/install/files/lib/event/user/UserUnbanned.class.php

@@ -0,0 +1,21 @@
+<?php
+
+namespace wcf\event\user;
+
+use wcf\data\user\User;
+use wcf\event\IPsr14Event;
+
+/**
+ * Indicates that a user has been unbanned.
+ *
+ * @author Olaf Braun
+ * @copyright 2001-2025 WoltLab GmbH
+ * @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
+ * @since 6.3
+ */
+final class UserUnbanned implements IPsr14Event
+{
+    public function __construct(public readonly User $user)
+    {
+    }
+}

wcfsetup/install/files/lib/system/endpoint/controller/core/users/DisableUser.class.php

@@ -7,7 +7,6 @@
 use Psr\Http\Message\ServerRequestInterface;
 use wcf\data\user\group\UserGroup;
 use wcf\data\user\User;
-use wcf\data\user\UserAction;
 use wcf\http\Helper;
 use wcf\system\endpoint\IController;
 use wcf\system\endpoint\PostRequest;
@@ -34,7 +33,7 @@ public function __invoke(ServerRequestInterface $request, array $variables): Res
         $this->assertUserCanBeDisabled($user);
 
         if (!$user->pendingActivation()) {
-            (new UserAction([$user], 'disable'))->executeAction();
+            (new \wcf\system\user\command\DisableUser($user))();
         }
 
         return new JsonResponse([]);

wcfsetup/install/files/lib/system/endpoint/controller/core/users/EnableUser.class.php

@@ -7,7 +7,6 @@
 use Psr\Http\Message\ServerRequestInterface;
 use wcf\data\user\group\UserGroup;
 use wcf\data\user\User;
-use wcf\data\user\UserAction;
 use wcf\http\Helper;
 use wcf\system\endpoint\IController;
 use wcf\system\endpoint\PostRequest;
@@ -34,7 +33,7 @@ public function __invoke(ServerRequestInterface $request, array $variables): Res
         $this->assertUserCanBeEnabled($user);
 
         if ($user->pendingActivation()) {
-            (new UserAction([$user], 'enable'))->executeAction();
+            (new \wcf\system\user\command\EnableUser($user))();
         }
 
         return new JsonResponse([]);

wcfsetup/install/files/lib/system/endpoint/controller/core/users/EnableUserAvatar.class.php

@@ -7,12 +7,12 @@
 use Psr\Http\Message\ServerRequestInterface;
 use wcf\data\user\group\UserGroup;
 use wcf\data\user\User;
-use wcf\data\user\UserAction;
 use wcf\http\Helper;
 use wcf\system\endpoint\IController;
 use wcf\system\endpoint\PostRequest;
 use wcf\system\exception\IllegalLinkException;
 use wcf\system\exception\PermissionDeniedException;
+use wcf\system\user\command\EnableAvatar;
 use wcf\system\WCF;
 
 /**
@@ -34,7 +34,7 @@ public function __invoke(ServerRequestInterface $request, array $variables): Res
         $this->assertAvatarCanBeEnabled($user);
 
         if ($user->disableAvatar) {
-            (new UserAction([$user], 'enableAvatar'))->executeAction();
+            (new EnableAvatar($user))();
         }
 
         return new JsonResponse([]);