Merge pull request #6402 from WoltLab/6.2-refactor-user-group-copy

Migrate user group copy to `FormBuilderDialogInteraction`

Author: BurntimeX

ts/WoltLabSuite/Core/Acp/Component/User/Group/Copy.ts

@@ -20,7 +20,7 @@ async function handleFormBuilderDialogAction(
   interactionEffect: InteractionEffect = InteractionEffect.ReloadItem,
   detail: Payload,
 ): Promise<void> {
-  const { ok } = await dialogFactory().usingFormBuilder().fromEndpoint(endpoint);
+  const { ok, result } = await dialogFactory().usingFormBuilder().fromEndpoint<Payload>(endpoint);
 
   if (!ok) {
     return;
@@ -32,6 +32,7 @@ async function handleFormBuilderDialogAction(
         bubbles: true,
         detail: {
           ...detail,
+          ...result,
           _reloadPage: String(interactionEffect === InteractionEffect.ReloadPage),
         },
       }),
@@ -41,6 +42,7 @@ async function handleFormBuilderDialogAction(
       new CustomEvent<Payload>("interaction:invalidate-all", {
         detail: {
           ...detail,
+          ...result,
         },
       }),
     );
@@ -50,6 +52,7 @@ async function handleFormBuilderDialogAction(
         bubbles: true,
         detail: {
           ...detail,
+          ...result,
         },
       }),
     );

ts/WoltLabSuite/Core/Component/Interaction/FormBuilderDialog.ts

@@ -1,12 +1,6 @@
 {include file='header' pageTitle='wcf.acp.group.'|concat:$action}
 
 <script data-relocate="true">
-	{if $action == 'edit' && $group->canCopy()}
-		require(['WoltLabSuite/Core/Acp/Component/User/Group/Copy'], ({ init }) => {
-			init();
-		});
-	{/if}
-
 	$(function() {
 		{if $action === 'add' && $isBlankForm}
 			elBySelAll('.jsBbcodeSelectOptionHtml input[type="checkbox"]', undefined, function (checkbox) {
@@ -43,12 +37,20 @@
 					</li>
 				{/if}
 
-				{if $group->canCopy()}
-					<li><button type="button" class="jsButtonUserGroupCopy button" data-endpoint="{link controller="UserGroupCopy" id=$groupID}{/link}">{icon name='copy'} <span>{lang}wcf.acp.group.button.copy{/lang}</span></button></li>
-				{/if}
-
 				<li>
 					{unsafe:$interactionContextMenu->render()}
+					<script data-relocate="true">
+						{
+							const container = document.getElementById('{unsafe:$interactionContextMenu->getContainerID()|encodeJS}');
+							container.addEventListener('interaction:invalidate-all', (event) => {
+								if (event.detail.interaction === 'copy') {
+									setTimeout(() => {
+										window.location.href = event.detail.redirectURL;
+									}, 2000);
+								}
+							});
+						}
+					</script>
 				</li>
 			{/if}
 

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

@@ -89,7 +89,7 @@ private function getForm(): Psr15DialogForm
     {
         $form = new Psr15DialogForm(
             UserGroupCopyAction::class,
-            WCF::getLanguage()->get('wcf.acp.dashboard.configure')
+            WCF::getLanguage()->get('wcf.acp.group.copy')
         );
         $form->appendChildren([
             FormContainer::create('section')

wcfsetup/install/files/js/WoltLabSuite/Core/Acp/Component/User/Group/Copy.js

@@ -3,6 +3,10 @@
 namespace wcf\data\user\group;
 
 use wcf\data\AbstractDatabaseObjectAction;
+use wcf\system\exception\PermissionDeniedException;
+use wcf\system\request\LinkHandler;
+use wcf\system\user\group\command\CopyUserGroup;
+use wcf\system\WCF;
 
 /**
  * Executes user group-related actions.
@@ -20,6 +24,12 @@ class UserGroupAction extends AbstractDatabaseObjectAction
      */
     public $className = UserGroupEditor::class;
 
+    /**
+     * editor object for the copied user group
+     * @var UserGroupEditor
+     */
+    public $groupEditor;
+
     /**
      * @inheritDoc
      */
@@ -38,7 +48,7 @@ class UserGroupAction extends AbstractDatabaseObjectAction
     /**
      * @inheritDoc
      */
-    protected $requireACP = ['create', 'delete', 'update'];
+    protected $requireACP = ['copy', 'create', 'delete', 'update'];
 
     /**
      * @inheritDoc
@@ -71,4 +81,47 @@ public function update()
             $object->updateGroupOptions($this->parameters['options']);
         }
     }
+
+    /**
+     * Validates the 'copy' action.
+     * @deprecated 6.2 Use `CopyUserGroup` instead.
+     */
+    public function validateCopy()
+    {
+        WCF::getSession()->checkPermissions([
+            'admin.user.canAddGroup',
+            'admin.user.canEditGroup',
+        ]);
+
+        $this->readBoolean('copyACLOptions');
+        $this->readBoolean('copyMembers');
+        $this->readBoolean('copyUserGroupOptions');
+
+        $this->groupEditor = $this->getSingleObject();
+        if (!$this->groupEditor->canCopy()) {
+            throw new PermissionDeniedException();
+        }
+    }
+
+    /**
+     * Copies a user group.
+     * @deprecated 6.2 Use `CopyUserGroup` instead.
+     */
+    public function copy()
+    {
+        $command = new CopyUserGroup(
+            $this->groupEditor->getDecoratedObject(),
+            $this->parameters['copyUserGroupOptions'],
+            $this->parameters['copyMembers'],
+            $this->parameters['copyACLOptions']
+        );
+        $group = $command();
+
+        return [
+            'groupID' => $group->groupID,
+            'redirectURL' => LinkHandler::getInstance()->getLink('UserGroupEdit', [
+                'id' => $group->groupID,
+            ]),
+        ];
+    }
 }

wcfsetup/install/files/js/WoltLabSuite/Core/Component/Interaction/FormBuilderDialog.js

@@ -2,11 +2,15 @@
 
 namespace wcf\system\interaction\admin;
 
+use wcf\acp\action\UserGroupCopyAction;
 use wcf\data\user\group\UserGroup;
 use wcf\event\interaction\admin\UserGroupInteractionCollecting;
 use wcf\system\event\EventHandler;
 use wcf\system\interaction\AbstractInteractionProvider;
 use wcf\system\interaction\DeleteInteraction;
+use wcf\system\interaction\FormBuilderDialogInteraction;
+use wcf\system\interaction\InteractionEffect;
+use wcf\system\request\LinkHandler;
 
 /**
  * Interaction provider for user groups.
@@ -21,7 +25,16 @@ final class UserGroupInteractions extends AbstractInteractionProvider
     public function __construct()
     {
         $this->addInteractions([
-            new DeleteInteraction("core/users/groups/%s", static fn(UserGroup $group) => $group->isDeletable())
+            new DeleteInteraction("core/users/groups/%s", static fn(UserGroup $group) => $group->isDeletable()),
+            new FormBuilderDialogInteraction(
+                'copy',
+                LinkHandler::getInstance()->getControllerLink(UserGroupCopyAction::class, ['id' => '%s']),
+                'wcf.acp.group.button.copy',
+                static function (UserGroup $group): bool {
+                    return $group->canCopy();
+                },
+                InteractionEffect::ReloadList
+            )
         ]);
 
         EventHandler::getInstance()->fire(