diff --git a/com.woltlab.wcf/templates/shared_nodeTreeView.tpl b/com.woltlab.wcf/templates/shared_nodeTreeView.tpl new file mode 100644 index 00000000000..99f78994db5 --- /dev/null +++ b/com.woltlab.wcf/templates/shared_nodeTreeView.tpl @@ -0,0 +1,33 @@ +
+
    + {unsafe:$view->renderItems()} +
+ + +
+ + +{unsafe:$view->renderInteractionInitialization()} diff --git a/com.woltlab.wcf/templates/shared_nodeTreeViewItem.tpl b/com.woltlab.wcf/templates/shared_nodeTreeViewItem.tpl new file mode 100644 index 00000000000..6e2c0abd00d --- /dev/null +++ b/com.woltlab.wcf/templates/shared_nodeTreeViewItem.tpl @@ -0,0 +1,18 @@ +
  • +
    + {icon name='grip-vertical'} + {$node->getTitle()} + {if $view->hasInteractions()} +
    + {unsafe:$view->renderQuickInteractions($node)} + {unsafe:$view->renderInteractionContextMenuButton($node)} +
    + {/if} +
    + +
      + {foreach from=$node item='child'} + {unsafe:$view->renderItem($child)} + {/foreach} +
    +
    • diff --git a/com.woltlab.wcf/templates/shared_nodeTreeViewItems.tpl b/com.woltlab.wcf/templates/shared_nodeTreeViewItems.tpl new file mode 100644 index 00000000000..1d8812f225b --- /dev/null +++ b/com.woltlab.wcf/templates/shared_nodeTreeViewItems.tpl @@ -0,0 +1,19 @@ +{foreach from=$view->getNodes() item='node'} +
  • +
    + {icon name='grip-vertical'} + {$node->getTitle()} + {if $view->hasInteractions()} +
    + {unsafe:$view->renderQuickInteractions($node)} + {unsafe:$view->renderInteractionContextMenuButton($node)} +
    + {/if} +
    + +
      {if !$node->hasChildren()}
    • {/if} + + {if !$node->hasChildren() && $node->isLastSibling()} + {unsafe:""|str_repeat:$node->getOpenParentNodes()} + {/if} +{/foreach} diff --git a/ts/WoltLabSuite/Core/Api/NodeTreeViews/GetNode.ts b/ts/WoltLabSuite/Core/Api/NodeTreeViews/GetNode.ts new file mode 100644 index 00000000000..4767e624540 --- /dev/null +++ b/ts/WoltLabSuite/Core/Api/NodeTreeViews/GetNode.ts @@ -0,0 +1,40 @@ +/** + * Gets a single node for rendering in a node tree view. + * + * @author Marcel Werk + * @copyright 2001-2026 WoltLab GmbH + * @license GNU Lesser General Public License + * @since 6.3 + */ + +import { prepareRequest } from "WoltLabSuite/Core/Ajax/Backend"; +import { fromInfallibleApiRequest } from "../Result"; + +type Response = { + template: string; +}; + +export async function getNode( + nodeTreeViewClass: string, + objectId: string | number, + nodeTreeViewParameters?: Map, +): Promise { + const url = new URL(`${window.WSC_RPC_API_URL}core/node-tree-views/node`); + url.searchParams.set("nodeTreeView", nodeTreeViewClass); + url.searchParams.set("objectID", objectId.toString()); + if (nodeTreeViewParameters) { + nodeTreeViewParameters.forEach((value, key) => { + if (Array.isArray(value)) { + value.forEach((innerValue, innerKey) => { + url.searchParams.set(`nodeTreeViewParameters[${key}][${innerKey}]`, innerValue); + }); + } else { + url.searchParams.set(`nodeTreeViewParameters[${key}]`, value); + } + }); + } + + return fromInfallibleApiRequest(() => { + return prepareRequest(url).get().allowCaching().disableLoadingIndicator().fetchAsJson(); + }); +} diff --git a/ts/WoltLabSuite/Core/Api/NodeTreeViews/GetNodes.ts b/ts/WoltLabSuite/Core/Api/NodeTreeViews/GetNodes.ts new file mode 100644 index 00000000000..6d1f7ec0c2c --- /dev/null +++ b/ts/WoltLabSuite/Core/Api/NodeTreeViews/GetNodes.ts @@ -0,0 +1,38 @@ +/** + * Gets the items of a node tree view. + * + * @author Marcel Werk + * @copyright 2001-2026 WoltLab GmbH + * @license GNU Lesser General Public License + * @since 6.3 + */ + +import { prepareRequest } from "WoltLabSuite/Core/Ajax/Backend"; +import { fromInfallibleApiRequest } from "../Result"; + +type Response = { + template: string; +}; + +export async function getNodes( + nodeTreeViewClass: string, + nodeTreeViewParameters?: Map, +): Promise { + const url = new URL(`${window.WSC_RPC_API_URL}core/node-tree-views/nodes`); + url.searchParams.set("nodeTreeView", nodeTreeViewClass); + if (nodeTreeViewParameters) { + nodeTreeViewParameters.forEach((value, key) => { + if (Array.isArray(value)) { + value.forEach((innerValue, innerKey) => { + url.searchParams.set(`nodeTreeViewParameters[${key}][${innerKey}]`, innerValue); + }); + } else { + url.searchParams.set(`nodeTreeViewParameters[${key}]`, value); + } + }); + } + + return fromInfallibleApiRequest(() => { + return prepareRequest(url).get().allowCaching().disableLoadingIndicator().fetchAsJson(); + }); +} diff --git a/ts/WoltLabSuite/Core/Component/NodeTreeView.ts b/ts/WoltLabSuite/Core/Component/NodeTreeView.ts new file mode 100644 index 00000000000..a7b0e14f618 --- /dev/null +++ b/ts/WoltLabSuite/Core/Component/NodeTreeView.ts @@ -0,0 +1,168 @@ +/** + * Provides the program logic for node tree views. + * + * @author Marcel Werk + * @copyright 2001-2026 WoltLab GmbH + * @license GNU Lesser General Public License + * @since 6.3 + */ + +import { postObject } from "../Api/PostObject"; +import { getNode } from "../Api/NodeTreeViews/GetNode"; +import { getNodes } from "../Api/NodeTreeViews/GetNodes"; +import { promiseMutex } from "../Helper/PromiseMutex"; +import { wheneverFirstSeen } from "../Helper/Selector"; +import { createFragmentFromHtml, setInnerHtml } from "../Dom/Util"; +import UiDropdownSimple from "../Ui/Dropdown/Simple"; +import Sortable from "sortablejs"; + +export class NodeTreeView { + readonly #id: string; + readonly #viewClassName: string; + readonly #viewParameters: Map; + readonly #setPositionsEndpoint: string; + readonly #sortables = new Map(); + + constructor( + id: string, + viewClassName: string, + viewParameters: Map, + setPositionsEndpoint: string = "", + ) { + this.#id = id; + this.#viewClassName = viewClassName; + this.#viewParameters = viewParameters; + this.#setPositionsEndpoint = setPositionsEndpoint; + + this.#initInteractions(); + this.#initEventListeners(); + + if (this.#setPositionsEndpoint) { + this.#initializeSorting(); + } + } + + #initInteractions(): void { + wheneverFirstSeen(`#${this.#id} .nodeTreeView__item`, (node) => { + const content = node.querySelector(":scope > .nodeTreeView__item__content")!; + const containers = [content]; + + content.querySelectorAll(".dropdownToggle").forEach((element) => { + const dropdown = UiDropdownSimple.getDropdownMenu(element.dataset.target!); + if (dropdown) { + containers.push(dropdown); + } + }); + + for (const container of containers) { + container.querySelectorAll("[data-interaction]").forEach((element) => { + element.addEventListener("click", () => { + node.dispatchEvent( + new CustomEvent("interaction:execute", { + detail: element.dataset, + bubbles: true, + }), + ); + }); + }); + } + }); + } + + #showFooter(): void { + document.getElementById(`${this.#id}_footer`)!.hidden = false; + } + + #hideFooter(): void { + document.getElementById(`${this.#id}_footer`)!.hidden = true; + } + + async #setPositions(): Promise { + const positions: Record = {}; + for (const [objectId, sortables] of this.#sortables) { + const objectIds = sortables.toArray(); + if (objectIds.length === 0) { + continue; + } + + positions[objectId] = objectIds.map((objectId) => parseInt(objectId)); + } + + await postObject(`${window.WSC_RPC_API_URL}${this.#setPositionsEndpoint}`, { positions }); + + this.#hideFooter(); + } + + #initializeSorting(): void { + const button = document.getElementById(`${this.#id}_submitButton`)!; + button.addEventListener( + "click", + promiseMutex(() => this.#setPositions()), + ); + + wheneverFirstSeen(`#${this.#id} .nodeTreeView__list`, (list) => { + this.#sortables.set( + parseInt(list.dataset.parentObjectId!), + new Sortable(list, { + group: "nested", + animation: 150, + fallbackOnBody: true, + draggable: "li", + handle: ".nodeTreeView__item__handle", + dataIdAttr: "data-object-id", + onChange: () => { + this.#showFooter(); + }, + }), + ); + }); + } + + async #reloadTree(): Promise { + const { template } = await getNodes(this.#viewClassName, this.#viewParameters); + const rootList = document.querySelector(`#${this.#id} > .nodeTreeView__list`)!; + for (const [parentObjectId, sortable] of this.#sortables) { + if (parentObjectId === 0) { + continue; + } + sortable.destroy(); + this.#sortables.delete(parentObjectId); + } + setInnerHtml(rootList, template); + } + + async #reloadNode(item: HTMLElement): Promise { + const objectId = parseInt(item.dataset.objectId!); + const { template } = await getNode(this.#viewClassName, objectId, this.#viewParameters); + for (const list of item.querySelectorAll(".nodeTreeView__list")) { + const parentObjectId = parseInt(list.dataset.parentObjectId!); + this.#sortables.get(parentObjectId)?.destroy(); + this.#sortables.delete(parentObjectId); + } + item.replaceWith(createFragmentFromHtml(template)); + } + + #initEventListeners(): void { + const nodeTreeView = document.getElementById(this.#id)!; + + nodeTreeView.addEventListener("interaction:invalidate-all", () => { + void this.#reloadTree(); + }); + + nodeTreeView.addEventListener("interaction:invalidate", (event) => { + void this.#reloadNode(event.target as HTMLElement); + }); + + nodeTreeView.addEventListener("interaction:remove", (event) => { + const item = event.target as HTMLElement; + const childList = item.querySelector(":scope > .nodeTreeView__list"); + if (childList) { + const objectId = parseInt(item.dataset.objectId!); + this.#sortables.get(objectId)?.destroy(); + this.#sortables.delete(objectId); + item.before(...childList.children); + } + item.remove(); + }); + } +} diff --git a/ts/WoltLabSuite/Core/Ui/Sortable/List.ts b/ts/WoltLabSuite/Core/Ui/Sortable/List.ts index a7c5a452b09..1f911291537 100644 --- a/ts/WoltLabSuite/Core/Ui/Sortable/List.ts +++ b/ts/WoltLabSuite/Core/Ui/Sortable/List.ts @@ -5,6 +5,7 @@ * @copyright 2001-2024 WoltLab GmbH * @license GNU Lesser General Public License * @woltlabExcludeBundle tiny + * @deprecated 6.3 Use `AbstractNodeTreeView` instead. */ import * as Core from "../../Core"; diff --git a/wcfsetup/install/files/acp/templates/menuItemAdd.tpl b/wcfsetup/install/files/acp/templates/menuItemAdd.tpl index 79a22aad6b6..5c0bb6087bf 100644 --- a/wcfsetup/install/files/acp/templates/menuItemAdd.tpl +++ b/wcfsetup/install/files/acp/templates/menuItemAdd.tpl @@ -24,8 +24,10 @@ +
  • + {unsafe:$interactionContextMenu->render()} +
    • {/if} -
  • {icon name='list'} {lang}wcf.acp.menu.item.list{/lang}
    • {event name='contentHeaderNavigation'} diff --git a/wcfsetup/install/files/acp/templates/menuItemList.tpl b/wcfsetup/install/files/acp/templates/menuItemList.tpl index 75e7ad0168f..23fa03c613d 100644 --- a/wcfsetup/install/files/acp/templates/menuItemList.tpl +++ b/wcfsetup/install/files/acp/templates/menuItemList.tpl @@ -1,20 +1,5 @@ {include file='header' pageTitle='wcf.acp.menu.item.list'} - -

    {lang}wcf.acp.menu.item.list{/lang}

    @@ -31,57 +16,8 @@
    -{hascontent} - - -
    - -
    -{hascontentelse} - {lang}wcf.global.noItems{/lang} -{/hascontent} +
    + {unsafe:$nodeTreeView->render()} +
    {include file='footer'} diff --git a/wcfsetup/install/files/js/WoltLabSuite/Core/Api/NodeTreeViews/GetNode.js b/wcfsetup/install/files/js/WoltLabSuite/Core/Api/NodeTreeViews/GetNode.js new file mode 100644 index 00000000000..30b205513a2 --- /dev/null +++ b/wcfsetup/install/files/js/WoltLabSuite/Core/Api/NodeTreeViews/GetNode.js @@ -0,0 +1,33 @@ +/** + * Gets a single node for rendering in a node tree view. + * + * @author Marcel Werk + * @copyright 2001-2026 WoltLab GmbH + * @license GNU Lesser General Public License + * @since 6.3 + */ +define(["require", "exports", "WoltLabSuite/Core/Ajax/Backend", "../Result"], function (require, exports, Backend_1, Result_1) { + "use strict"; + Object.defineProperty(exports, "__esModule", { value: true }); + exports.getNode = getNode; + async function getNode(nodeTreeViewClass, objectId, nodeTreeViewParameters) { + const url = new URL(`${window.WSC_RPC_API_URL}core/node-tree-views/node`); + url.searchParams.set("nodeTreeView", nodeTreeViewClass); + url.searchParams.set("objectID", objectId.toString()); + if (nodeTreeViewParameters) { + nodeTreeViewParameters.forEach((value, key) => { + if (Array.isArray(value)) { + value.forEach((innerValue, innerKey) => { + url.searchParams.set(`nodeTreeViewParameters[${key}][${innerKey}]`, innerValue); + }); + } + else { + url.searchParams.set(`nodeTreeViewParameters[${key}]`, value); + } + }); + } + return (0, Result_1.fromInfallibleApiRequest)(() => { + return (0, Backend_1.prepareRequest)(url).get().allowCaching().disableLoadingIndicator().fetchAsJson(); + }); + } +}); diff --git a/wcfsetup/install/files/js/WoltLabSuite/Core/Api/NodeTreeViews/GetNodes.js b/wcfsetup/install/files/js/WoltLabSuite/Core/Api/NodeTreeViews/GetNodes.js new file mode 100644 index 00000000000..b63eeebeff8 --- /dev/null +++ b/wcfsetup/install/files/js/WoltLabSuite/Core/Api/NodeTreeViews/GetNodes.js @@ -0,0 +1,32 @@ +/** + * Gets the items of a node tree view. + * + * @author Marcel Werk + * @copyright 2001-2026 WoltLab GmbH + * @license GNU Lesser General Public License + * @since 6.3 + */ +define(["require", "exports", "WoltLabSuite/Core/Ajax/Backend", "../Result"], function (require, exports, Backend_1, Result_1) { + "use strict"; + Object.defineProperty(exports, "__esModule", { value: true }); + exports.getNodes = getNodes; + async function getNodes(nodeTreeViewClass, nodeTreeViewParameters) { + const url = new URL(`${window.WSC_RPC_API_URL}core/node-tree-views/nodes`); + url.searchParams.set("nodeTreeView", nodeTreeViewClass); + if (nodeTreeViewParameters) { + nodeTreeViewParameters.forEach((value, key) => { + if (Array.isArray(value)) { + value.forEach((innerValue, innerKey) => { + url.searchParams.set(`nodeTreeViewParameters[${key}][${innerKey}]`, innerValue); + }); + } + else { + url.searchParams.set(`nodeTreeViewParameters[${key}]`, value); + } + }); + } + return (0, Result_1.fromInfallibleApiRequest)(() => { + return (0, Backend_1.prepareRequest)(url).get().allowCaching().disableLoadingIndicator().fetchAsJson(); + }); + } +}); diff --git a/wcfsetup/install/files/js/WoltLabSuite/Core/Component/NodeTreeView.js b/wcfsetup/install/files/js/WoltLabSuite/Core/Component/NodeTreeView.js new file mode 100644 index 00000000000..517e72bf62c --- /dev/null +++ b/wcfsetup/install/files/js/WoltLabSuite/Core/Component/NodeTreeView.js @@ -0,0 +1,133 @@ +/** + * Provides the program logic for node tree views. + * + * @author Marcel Werk + * @copyright 2001-2026 WoltLab GmbH + * @license GNU Lesser General Public License + * @since 6.3 + */ +define(["require", "exports", "tslib", "../Api/PostObject", "../Api/NodeTreeViews/GetNode", "../Api/NodeTreeViews/GetNodes", "../Helper/PromiseMutex", "../Helper/Selector", "../Dom/Util", "../Ui/Dropdown/Simple", "sortablejs"], function (require, exports, tslib_1, PostObject_1, GetNode_1, GetNodes_1, PromiseMutex_1, Selector_1, Util_1, Simple_1, sortablejs_1) { + "use strict"; + Object.defineProperty(exports, "__esModule", { value: true }); + exports.NodeTreeView = void 0; + Simple_1 = tslib_1.__importDefault(Simple_1); + sortablejs_1 = tslib_1.__importDefault(sortablejs_1); + class NodeTreeView { + #id; + #viewClassName; + #viewParameters; + #setPositionsEndpoint; + #sortables = new Map(); + constructor(id, viewClassName, viewParameters, setPositionsEndpoint = "") { + this.#id = id; + this.#viewClassName = viewClassName; + this.#viewParameters = viewParameters; + this.#setPositionsEndpoint = setPositionsEndpoint; + this.#initInteractions(); + this.#initEventListeners(); + if (this.#setPositionsEndpoint) { + this.#initializeSorting(); + } + } + #initInteractions() { + (0, Selector_1.wheneverFirstSeen)(`#${this.#id} .nodeTreeView__item`, (node) => { + const content = node.querySelector(":scope > .nodeTreeView__item__content"); + const containers = [content]; + content.querySelectorAll(".dropdownToggle").forEach((element) => { + const dropdown = Simple_1.default.getDropdownMenu(element.dataset.target); + if (dropdown) { + containers.push(dropdown); + } + }); + for (const container of containers) { + container.querySelectorAll("[data-interaction]").forEach((element) => { + element.addEventListener("click", () => { + node.dispatchEvent(new CustomEvent("interaction:execute", { + detail: element.dataset, + bubbles: true, + })); + }); + }); + } + }); + } + #showFooter() { + document.getElementById(`${this.#id}_footer`).hidden = false; + } + #hideFooter() { + document.getElementById(`${this.#id}_footer`).hidden = true; + } + async #setPositions() { + const positions = {}; + for (const [objectId, sortables] of this.#sortables) { + const objectIds = sortables.toArray(); + if (objectIds.length === 0) { + continue; + } + positions[objectId] = objectIds.map((objectId) => parseInt(objectId)); + } + await (0, PostObject_1.postObject)(`${window.WSC_RPC_API_URL}${this.#setPositionsEndpoint}`, { positions }); + this.#hideFooter(); + } + #initializeSorting() { + const button = document.getElementById(`${this.#id}_submitButton`); + button.addEventListener("click", (0, PromiseMutex_1.promiseMutex)(() => this.#setPositions())); + (0, Selector_1.wheneverFirstSeen)(`#${this.#id} .nodeTreeView__list`, (list) => { + this.#sortables.set(parseInt(list.dataset.parentObjectId), new sortablejs_1.default(list, { + group: "nested", + animation: 150, + fallbackOnBody: true, + draggable: "li", + handle: ".nodeTreeView__item__handle", + dataIdAttr: "data-object-id", + onChange: () => { + this.#showFooter(); + }, + })); + }); + } + async #reloadTree() { + const { template } = await (0, GetNodes_1.getNodes)(this.#viewClassName, this.#viewParameters); + const rootList = document.querySelector(`#${this.#id} > .nodeTreeView__list`); + for (const [parentObjectId, sortable] of this.#sortables) { + if (parentObjectId === 0) { + continue; + } + sortable.destroy(); + this.#sortables.delete(parentObjectId); + } + (0, Util_1.setInnerHtml)(rootList, template); + } + async #reloadNode(item) { + const objectId = parseInt(item.dataset.objectId); + const { template } = await (0, GetNode_1.getNode)(this.#viewClassName, objectId, this.#viewParameters); + for (const list of item.querySelectorAll(".nodeTreeView__list")) { + const parentObjectId = parseInt(list.dataset.parentObjectId); + this.#sortables.get(parentObjectId)?.destroy(); + this.#sortables.delete(parentObjectId); + } + item.replaceWith((0, Util_1.createFragmentFromHtml)(template)); + } + #initEventListeners() { + const nodeTreeView = document.getElementById(this.#id); + nodeTreeView.addEventListener("interaction:invalidate-all", () => { + void this.#reloadTree(); + }); + nodeTreeView.addEventListener("interaction:invalidate", (event) => { + void this.#reloadNode(event.target); + }); + nodeTreeView.addEventListener("interaction:remove", (event) => { + const item = event.target; + const childList = item.querySelector(":scope > .nodeTreeView__list"); + if (childList) { + const objectId = parseInt(item.dataset.objectId); + this.#sortables.get(objectId)?.destroy(); + this.#sortables.delete(objectId); + item.before(...childList.children); + } + item.remove(); + }); + } + } + exports.NodeTreeView = NodeTreeView; +}); diff --git a/wcfsetup/install/files/js/WoltLabSuite/Core/Ui/Sortable/List.js b/wcfsetup/install/files/js/WoltLabSuite/Core/Ui/Sortable/List.js index 15b3e4a1a1e..c15a67e35a1 100644 --- a/wcfsetup/install/files/js/WoltLabSuite/Core/Ui/Sortable/List.js +++ b/wcfsetup/install/files/js/WoltLabSuite/Core/Ui/Sortable/List.js @@ -5,6 +5,7 @@ * @copyright 2001-2024 WoltLab GmbH * @license GNU Lesser General Public License * @woltlabExcludeBundle tiny + * @deprecated 6.3 Use `AbstractNodeTreeView` instead. */ define(["require", "exports", "tslib", "../../Core", "sortablejs", "WoltLabSuite/Core/Ajax", "WoltLabSuite/Core/Language", "WoltLabSuite/Core/Component/Snackbar"], function (require, exports, tslib_1, Core, sortablejs_1, Ajax_1, Language_1, Snackbar_1) { "use strict"; diff --git a/wcfsetup/install/files/lib/acp/form/MenuItemAddForm.class.php b/wcfsetup/install/files/lib/acp/form/MenuItemAddForm.class.php index 47643f0d1d6..266ac3f3452 100644 --- a/wcfsetup/install/files/lib/acp/form/MenuItemAddForm.class.php +++ b/wcfsetup/install/files/lib/acp/form/MenuItemAddForm.class.php @@ -76,6 +76,8 @@ class MenuItemAddForm extends AbstractFormBuilderForm */ public $objectActionClass = MenuItemAction::class; + public ?int $parentItemID = null; + #[\Override] public function readParameters() { @@ -88,6 +90,10 @@ public function readParameters() if (!$this->menu->menuID) { throw new IllegalLinkException(); } + + if (isset($_GET['parentItemID'])) { + $this->parentItemID = \intval($_GET['parentItemID']); + } } #[\Override] @@ -124,7 +130,8 @@ protected function createForm() ]; } return $result; - }, true), + }, true) + ->value($this->parentItemID), TitleFormField::create() ->i18n() ->required() diff --git a/wcfsetup/install/files/lib/acp/form/MenuItemEditForm.class.php b/wcfsetup/install/files/lib/acp/form/MenuItemEditForm.class.php index 71609542495..8ef0b34fc43 100644 --- a/wcfsetup/install/files/lib/acp/form/MenuItemEditForm.class.php +++ b/wcfsetup/install/files/lib/acp/form/MenuItemEditForm.class.php @@ -3,11 +3,16 @@ namespace wcf\acp\form; use CuyZ\Valinor\Mapper\MappingError; +use wcf\acp\page\MenuItemListPage; use wcf\data\menu\item\MenuItem; use wcf\data\menu\Menu; use wcf\form\AbstractFormBuilderForm; use wcf\http\Helper; use wcf\system\exception\IllegalLinkException; +use wcf\system\interaction\admin\MenuItemInteractions; +use wcf\system\interaction\StandaloneInteractionContextMenuComponent; +use wcf\system\request\LinkHandler; +use wcf\system\WCF; /** * Shows the menu item edit form. @@ -55,4 +60,21 @@ protected function setFormAction() { AbstractFormBuilderForm::setFormAction(); } + + #[\Override] + public function assignVariables() + { + parent::assignVariables(); + + WCF::getTPL()->assign([ + 'interactionContextMenu' => StandaloneInteractionContextMenuComponent::forContentHeaderButton( + new MenuItemInteractions(), + $this->formObject, + LinkHandler::getInstance()->getControllerLink( + MenuItemListPage::class, + ['id' => $this->menuID] + ) + ), + ]); + } } diff --git a/wcfsetup/install/files/lib/acp/page/MenuItemListPage.class.php b/wcfsetup/install/files/lib/acp/page/MenuItemListPage.class.php index 4357fafd3a6..d86206b51e9 100644 --- a/wcfsetup/install/files/lib/acp/page/MenuItemListPage.class.php +++ b/wcfsetup/install/files/lib/acp/page/MenuItemListPage.class.php @@ -2,20 +2,22 @@ namespace wcf\acp\page; -use wcf\data\menu\item\MenuItemNodeTree; use wcf\data\menu\Menu; -use wcf\page\AbstractPage; -use wcf\system\exception\IllegalLinkException; +use wcf\http\Helper; +use wcf\page\AbstractNodeTreeViewPage; +use wcf\system\nodeTreeView\admin\MenuItemNodeTreeView; use wcf\system\WCF; /** * Shows a list of menu items. * - * @author Marcel Werk - * @copyright 2001-2019 WoltLab GmbH - * @license GNU Lesser General Public License + * @author Marcel Werk + * @copyright 2001-2026 WoltLab GmbH + * @license GNU Lesser General Public License + * + * @extends AbstractNodeTreeViewPage */ -class MenuItemListPage extends AbstractPage +class MenuItemListPage extends AbstractNodeTreeViewPage { /** * @inheritDoc @@ -27,44 +29,14 @@ class MenuItemListPage extends AbstractPage */ public $neededPermissions = ['admin.content.cms.canManageMenu']; - /** - * menu item node tree - * @var MenuItemNodeTree - */ - public $menuItems; - - /** - * menu id - * @var int - */ - public $menuID = 0; - - /** - * menu object - * @var Menu - */ - public $menu; + public Menu $menu; #[\Override] public function readParameters() { parent::readParameters(); - if (isset($_REQUEST['id'])) { - $this->menuID = \intval($_REQUEST['id']); - } - $this->menu = new Menu($this->menuID); - if (!$this->menu->menuID) { - throw new IllegalLinkException(); - } - } - - #[\Override] - public function readData() - { - parent::readData(); - - $this->menuItems = new MenuItemNodeTree($this->menuID, null, false); + $this->menu = Helper::fetchObjectFromQueryParameter(Menu::class); } #[\Override] @@ -73,9 +45,20 @@ public function assignVariables() parent::assignVariables(); WCF::getTPL()->assign([ - 'menuID' => $this->menuID, 'menu' => $this->menu, - 'menuItemNodeList' => $this->menuItems->getNodeList(), + 'menuID' => $this->menu->getObjectID(), ]); } + + #[\Override] + protected function createNodeTreeView(): MenuItemNodeTreeView + { + return new MenuItemNodeTreeView($this->menu->getObjectID()); + } + + #[\Override] + protected function getBaseUrlParameters(): array + { + return ['id' => $this->menu->getObjectID()]; + } } diff --git a/wcfsetup/install/files/lib/command/menu/item/DisableMenuItem.class.php b/wcfsetup/install/files/lib/command/menu/item/DisableMenuItem.class.php new file mode 100644 index 00000000000..1a80960a20a --- /dev/null +++ b/wcfsetup/install/files/lib/command/menu/item/DisableMenuItem.class.php @@ -0,0 +1,33 @@ + + * @since 6.3 + */ +final class DisableMenuItem +{ + public function __construct(private readonly MenuItem $menuItem) {} + + public function __invoke(): void + { + (new MenuItemEditor($this->menuItem))->update([ + 'isDisabled' => 1, + ]); + + MenuItemEditor::resetCache(); + + $event = new MenuItemDisabled($this->menuItem); + EventHandler::getInstance()->fire($event); + } +} diff --git a/wcfsetup/install/files/lib/command/menu/item/EnableMenuItem.class.php b/wcfsetup/install/files/lib/command/menu/item/EnableMenuItem.class.php new file mode 100644 index 00000000000..70de29990b5 --- /dev/null +++ b/wcfsetup/install/files/lib/command/menu/item/EnableMenuItem.class.php @@ -0,0 +1,33 @@ + + * @since 6.3 + */ +final class EnableMenuItem +{ + public function __construct(private readonly MenuItem $menuItem) {} + + public function __invoke(): void + { + (new MenuItemEditor($this->menuItem))->update([ + 'isDisabled' => 0, + ]); + + MenuItemEditor::resetCache(); + + $event = new MenuItemEnabled($this->menuItem); + EventHandler::getInstance()->fire($event); + } +} diff --git a/wcfsetup/install/files/lib/command/menu/item/SetMenuItemPositions.class.php b/wcfsetup/install/files/lib/command/menu/item/SetMenuItemPositions.class.php new file mode 100644 index 00000000000..bace20403f2 --- /dev/null +++ b/wcfsetup/install/files/lib/command/menu/item/SetMenuItemPositions.class.php @@ -0,0 +1,45 @@ + + * @since 6.3 + */ +final class SetMenuItemPositions +{ + /** + * @param array> $positions + */ + public function __construct(private readonly array $positions) {} + + public function __invoke(): void + { + $sql = "UPDATE wcf1_menu_item + SET parentItemID = ?, + showOrder = ? + WHERE itemID = ?"; + $statement = WCF::getDB()->prepare($sql); + + WCF::getDB()->beginTransaction(); + foreach ($this->positions as $parentItemID => $children) { + foreach ($children as $showOrder => $menuItemID) { + $statement->execute([ + $parentItemID ?: null, + $showOrder + 1, + $menuItemID, + ]); + } + } + WCF::getDB()->commitTransaction(); + + MenuItemEditor::resetCache(); + } +} diff --git a/wcfsetup/install/files/lib/data/menu/item/MenuItemAction.class.php b/wcfsetup/install/files/lib/data/menu/item/MenuItemAction.class.php index b8d76a36ed0..2de39445c51 100644 --- a/wcfsetup/install/files/lib/data/menu/item/MenuItemAction.class.php +++ b/wcfsetup/install/files/lib/data/menu/item/MenuItemAction.class.php @@ -4,14 +4,7 @@ use wcf\data\AbstractDatabaseObjectAction; use wcf\data\DatabaseObject; -use wcf\data\ISortableAction; -use wcf\data\IToggleAction; -use wcf\data\menu\Menu; -use wcf\data\TDatabaseObjectToggle; use wcf\data\TI18nDatabaseObjectAction; -use wcf\system\exception\PermissionDeniedException; -use wcf\system\exception\UserInputException; -use wcf\system\WCF; /** * Executes menu item related actions. @@ -22,9 +15,8 @@ * * @extends AbstractDatabaseObjectAction */ -class MenuItemAction extends AbstractDatabaseObjectAction implements ISortableAction, IToggleAction +class MenuItemAction extends AbstractDatabaseObjectAction { - use TDatabaseObjectToggle; use TI18nDatabaseObjectAction; /** @@ -50,7 +42,7 @@ class MenuItemAction extends AbstractDatabaseObjectAction implements ISortableAc /** * @inheritDoc */ - protected $requireACP = ['create', 'delete', 'toggle', 'update']; + protected $requireACP = ['create', 'delete', 'update']; #[\Override] public function create() @@ -84,83 +76,6 @@ public function update() } } - #[\Override] - public function validateToggle() - { - parent::validateUpdate(); - - foreach ($this->getObjects() as $object) { - if (!$object->canDisable()) { - throw new PermissionDeniedException(); - } - } - } - - #[\Override] - public function validateUpdatePosition() - { - WCF::getSession()->checkPermissions(['admin.content.cms.canManageMenu']); - - // validate menu id - $this->readInteger('menuID'); - $menu = new Menu($this->parameters['menuID']); - if (!$menu->menuID) { - throw new UserInputException('menuID'); - } - - // validate structure - if ( - !isset($this->parameters['data']) - || !isset($this->parameters['data']['structure']) - || !\is_array($this->parameters['data']['structure']) - ) { - throw new UserInputException('structure'); - } - - $menuItemIDs = []; - foreach ($this->parameters['data']['structure'] as $menuItems) { - $menuItemIDs = \array_merge($menuItemIDs, $menuItems); - } - - $menuItemList = new MenuItemList(); - $menuItemList->getConditionBuilder()->add('menu_item.itemID IN (?)', [$menuItemIDs]); - $menuItemList->getConditionBuilder()->add('menu_item.menuID = ?', [$this->parameters['menuID']]); - $menuItemList->readObjects(); - $menuItems = $menuItemList->getObjects(); - - if (\count($menuItems) != \count($menuItemIDs)) { - throw new UserInputException('structure'); - } - - foreach ($this->parameters['data']['structure'] as $parentItemID => $children) { - if ($parentItemID && !isset($menuItems[$parentItemID])) { - throw new UserInputException('structure'); - } - } - } - - #[\Override] - public function updatePosition() - { - $sql = "UPDATE wcf1_menu_item - SET parentItemID = ?, - showOrder = ? - WHERE itemID = ?"; - $statement = WCF::getDB()->prepare($sql); - - WCF::getDB()->beginTransaction(); - foreach ($this->parameters['data']['structure'] as $parentItemID => $children) { - foreach ($children as $showOrder => $menuItemID) { - $statement->execute([ - $parentItemID ?: null, - $showOrder + 1, - $menuItemID, - ]); - } - } - WCF::getDB()->commitTransaction(); - } - /** * @return array */ diff --git a/wcfsetup/install/files/lib/event/interaction/admin/MenuItemInteractionCollecting.class.php b/wcfsetup/install/files/lib/event/interaction/admin/MenuItemInteractionCollecting.class.php new file mode 100644 index 00000000000..e9bcbefc2c0 --- /dev/null +++ b/wcfsetup/install/files/lib/event/interaction/admin/MenuItemInteractionCollecting.class.php @@ -0,0 +1,19 @@ + + * @since 6.3 + */ +final class MenuItemInteractionCollecting implements IPsr14Event +{ + public function __construct(public readonly MenuItemInteractions $provider) {} +} diff --git a/wcfsetup/install/files/lib/event/menu/item/MenuItemDisabled.class.php b/wcfsetup/install/files/lib/event/menu/item/MenuItemDisabled.class.php new file mode 100644 index 00000000000..0fb12aeb8bd --- /dev/null +++ b/wcfsetup/install/files/lib/event/menu/item/MenuItemDisabled.class.php @@ -0,0 +1,19 @@ + + * @since 6.3 + */ +final class MenuItemDisabled implements IPsr14Event +{ + public function __construct(public readonly MenuItem $menuItem) {} +} diff --git a/wcfsetup/install/files/lib/event/menu/item/MenuItemEnabled.class.php b/wcfsetup/install/files/lib/event/menu/item/MenuItemEnabled.class.php new file mode 100644 index 00000000000..375d9cd580e --- /dev/null +++ b/wcfsetup/install/files/lib/event/menu/item/MenuItemEnabled.class.php @@ -0,0 +1,19 @@ + + * @since 6.3 + */ +final class MenuItemEnabled implements IPsr14Event +{ + public function __construct(public readonly MenuItem $menuItem) {} +} diff --git a/wcfsetup/install/files/lib/page/AbstractNodeTreeViewPage.class.php b/wcfsetup/install/files/lib/page/AbstractNodeTreeViewPage.class.php new file mode 100644 index 00000000000..6d9a7e1453a --- /dev/null +++ b/wcfsetup/install/files/lib/page/AbstractNodeTreeViewPage.class.php @@ -0,0 +1,83 @@ + + * @since 6.3 + * + * @template TNodeTreeView of AbstractNodeTreeView + */ +abstract class AbstractNodeTreeViewPage extends AbstractPage +{ + /** + * @var TNodeTreeView + */ + protected AbstractNodeTreeView $nodeTreeView; + + #[\Override] + public function show() + { + $this->canonicalURL = $this->getCanonicalUrl(); + + return parent::show(); + } + + #[\Override] + public function readData() + { + parent::readData(); + + $this->initNodeTreeView(); + } + + #[\Override] + public function assignVariables() + { + parent::assignVariables(); + + WCF::getTPL()->assign([ + 'nodeTreeView' => $this->nodeTreeView, + ]); + } + + protected function initNodeTreeView(): void + { + $this->nodeTreeView = $this->createNodeTreeView(); + if (!$this->nodeTreeView->isAccessible()) { + throw new PermissionDeniedException(); + } + } + + /** + * @return array + */ + protected function getBaseUrlParameters(): array + { + return []; + } + + protected function getCanonicalUrl(): string + { + return LinkHandler::getInstance()->getControllerLink( + static::class, + $this->getBaseUrlParameters() + ); + } + + /** + * Returns the node tree view instance for the rendering of this page. + * + * @return TNodeTreeView + */ + protected abstract function createNodeTreeView(): AbstractNodeTreeView; +} diff --git a/wcfsetup/install/files/lib/system/endpoint/controller/core/menus/items/DeleteMenuItem.class.php b/wcfsetup/install/files/lib/system/endpoint/controller/core/menus/items/DeleteMenuItem.class.php new file mode 100644 index 00000000000..a2e0f0b1b94 --- /dev/null +++ b/wcfsetup/install/files/lib/system/endpoint/controller/core/menus/items/DeleteMenuItem.class.php @@ -0,0 +1,47 @@ + + * @since 6.3 + */ +#[DeleteRequest("/core/menus/items/{id:\d+}")] +final class DeleteMenuItem implements IController +{ + #[\Override] + public function __invoke(ServerRequestInterface $request, array $variables): ResponseInterface + { + $menuItem = Helper::fetchObjectFromRequestParameter($variables['id'], MenuItem::class); + + $this->assertMenuItemCanBeDeleted($menuItem); + + (new MenuItemAction([$menuItem], 'delete'))->executeAction(); + + return new JsonResponse([]); + } + + private function assertMenuItemCanBeDeleted(MenuItem $menuItem): void + { + WCF::getSession()->checkPermissions(['admin.content.cms.canManageMenu']); + + if (!$menuItem->canDelete()) { + throw new PermissionDeniedException(); + } + } +} diff --git a/wcfsetup/install/files/lib/system/endpoint/controller/core/menus/items/DisableMenuItem.class.php b/wcfsetup/install/files/lib/system/endpoint/controller/core/menus/items/DisableMenuItem.class.php new file mode 100644 index 00000000000..890077727a1 --- /dev/null +++ b/wcfsetup/install/files/lib/system/endpoint/controller/core/menus/items/DisableMenuItem.class.php @@ -0,0 +1,48 @@ + + * @since 6.3 + */ +#[PostRequest("/core/menus/items/{id:\d+}/disable")] +final class DisableMenuItem implements IController +{ + #[\Override] + public function __invoke(ServerRequestInterface $request, array $variables): ResponseInterface + { + $menuItem = Helper::fetchObjectFromRequestParameter($variables['id'], MenuItem::class); + + $this->assertMenuItemCanBeDisabled($menuItem); + + if (!$menuItem->isDisabled) { + (new \wcf\command\menu\item\DisableMenuItem($menuItem))(); + } + + return new JsonResponse([]); + } + + private function assertMenuItemCanBeDisabled(MenuItem $menuItem): void + { + WCF::getSession()->checkPermissions(['admin.content.cms.canManageMenu']); + + if (!$menuItem->canDisable()) { + throw new PermissionDeniedException(); + } + } +} diff --git a/wcfsetup/install/files/lib/system/endpoint/controller/core/menus/items/EnableMenuItem.class.php b/wcfsetup/install/files/lib/system/endpoint/controller/core/menus/items/EnableMenuItem.class.php new file mode 100644 index 00000000000..521c1587da8 --- /dev/null +++ b/wcfsetup/install/files/lib/system/endpoint/controller/core/menus/items/EnableMenuItem.class.php @@ -0,0 +1,48 @@ + + * @since 6.3 + */ +#[PostRequest("/core/menus/items/{id:\d+}/enable")] +final class EnableMenuItem implements IController +{ + #[\Override] + public function __invoke(ServerRequestInterface $request, array $variables): ResponseInterface + { + $menuItem = Helper::fetchObjectFromRequestParameter($variables['id'], MenuItem::class); + + $this->assertMenuItemCanBeEnabled($menuItem); + + if ($menuItem->isDisabled) { + (new \wcf\command\menu\item\EnableMenuItem($menuItem))(); + } + + return new JsonResponse([]); + } + + private function assertMenuItemCanBeEnabled(MenuItem $menuItem): void + { + WCF::getSession()->checkPermissions(['admin.content.cms.canManageMenu']); + + if (!$menuItem->canDisable()) { + throw new PermissionDeniedException(); + } + } +} diff --git a/wcfsetup/install/files/lib/system/endpoint/controller/core/menus/items/SetMenuItemPositions.class.php b/wcfsetup/install/files/lib/system/endpoint/controller/core/menus/items/SetMenuItemPositions.class.php new file mode 100644 index 00000000000..c26c0503d74 --- /dev/null +++ b/wcfsetup/install/files/lib/system/endpoint/controller/core/menus/items/SetMenuItemPositions.class.php @@ -0,0 +1,106 @@ + + * @since 6.3 + */ +#[PostRequest('/core/menus/{id:\d+}/items/positions')] +final class SetMenuItemPositions implements IController +{ + #[\Override] + public function __invoke(ServerRequestInterface $request, array $variables): ResponseInterface + { + $menu = Helper::fetchObjectFromRequestParameter($variables['id'], Menu::class); + + WCF::getSession()->checkPermissions(['admin.content.cms.canManageMenu']); + + $parameters = Helper::mapApiParameters($request, SetMenuItemPositionsParameters::class); + $positions = $this->validatePositions($menu, $parameters->positions); + + (new \wcf\command\menu\item\SetMenuItemPositions($positions))(); + + return new JsonResponse([]); + } + + /** + * @param array> $positions + * @return array> + */ + private function validatePositions(Menu $menu, array $positions): array + { + $menuItemIDs = []; + foreach ($positions as $children) { + $menuItemIDs = \array_merge($menuItemIDs, $children); + } + + if ($menuItemIDs === []) { + return $positions; + } + + $menuItemList = new MenuItemList(); + $menuItemList->getConditionBuilder()->add('menu_item.itemID IN (?)', [$menuItemIDs]); + $menuItemList->getConditionBuilder()->add('menu_item.menuID = ?', [$menu->menuID]); + $menuItemList->readObjects(); + $menuItems = $menuItemList->getObjects(); + + if (\count($menuItems) !== \count($menuItemIDs)) { + throw new IllegalLinkException(); + } + + foreach ($positions as $parentItemID => $children) { + if ($parentItemID && !isset($menuItems[$parentItemID])) { + throw new IllegalLinkException(); + } + } + + $parentOf = []; + foreach ($positions as $parentItemID => $children) { + foreach ($children as $childID) { + if (isset($parentOf[$childID])) { + throw new IllegalLinkException(); + } + $parentOf[$childID] = $parentItemID; + } + } + + foreach (\array_keys($parentOf) as $startID) { + $current = $startID; + $seen = [$startID => true]; + while (!empty($parentOf[$current])) { + $current = $parentOf[$current]; + if (isset($seen[$current])) { + throw new IllegalLinkException(); + } + $seen[$current] = true; + } + } + + return $positions; + } +} + +/** @internal */ +final class SetMenuItemPositionsParameters +{ + public function __construct( + /** @var array> */ + public readonly array $positions, + ) {} +} diff --git a/wcfsetup/install/files/lib/system/endpoint/controller/core/nodeTreeViews/GetNode.class.php b/wcfsetup/install/files/lib/system/endpoint/controller/core/nodeTreeViews/GetNode.class.php new file mode 100644 index 00000000000..68d2579f54a --- /dev/null +++ b/wcfsetup/install/files/lib/system/endpoint/controller/core/nodeTreeViews/GetNode.class.php @@ -0,0 +1,64 @@ + + * @since 6.3 + */ +#[GetRequest('/core/node-tree-views/node')] +final class GetNode implements IController +{ + #[\Override] + public function __invoke(ServerRequestInterface $request, array $variables): ResponseInterface + { + $parameters = Helper::mapApiParameters($request, GetNodeParameters::class); + + if (!\is_subclass_of($parameters->nodeTreeView, AbstractNodeTreeView::class)) { + throw new UserInputException('nodeTreeView', 'invalid'); + } + + $view = new $parameters->nodeTreeView(...$parameters->nodeTreeViewParameters); + // @phpstan-ignore function.alreadyNarrowedType, instanceof.alwaysTrue + \assert($view instanceof AbstractNodeTreeView); + + if (!$view->isAccessible()) { + throw new PermissionDeniedException(); + } + + $node = $view->getNode($parameters->objectID); + if ($node === null) { + throw new UserInputException('objectID', 'invalid'); + } + + return new JsonResponse([ + 'template' => $view->renderItem($node), + ]); + } +} + +/** @internal */ +final class GetNodeParameters +{ + public function __construct( + /** @var non-empty-string */ + public readonly string $nodeTreeView, + public readonly int $objectID, + /** @var array */ + public readonly array $nodeTreeViewParameters, + ) {} +} diff --git a/wcfsetup/install/files/lib/system/endpoint/controller/core/nodeTreeViews/GetNodes.class.php b/wcfsetup/install/files/lib/system/endpoint/controller/core/nodeTreeViews/GetNodes.class.php new file mode 100644 index 00000000000..5944a0a5442 --- /dev/null +++ b/wcfsetup/install/files/lib/system/endpoint/controller/core/nodeTreeViews/GetNodes.class.php @@ -0,0 +1,58 @@ + + * @since 6.3 + */ +#[GetRequest('/core/node-tree-views/nodes')] +final class GetNodes implements IController +{ + #[\Override] + public function __invoke(ServerRequestInterface $request, array $variables): ResponseInterface + { + $parameters = Helper::mapApiParameters($request, GetNodesParameters::class); + + if (!\is_subclass_of($parameters->nodeTreeView, AbstractNodeTreeView::class)) { + throw new UserInputException('nodeTreeView', 'invalid'); + } + + $view = new $parameters->nodeTreeView(...$parameters->nodeTreeViewParameters); + // @phpstan-ignore function.alreadyNarrowedType, instanceof.alwaysTrue + \assert($view instanceof AbstractNodeTreeView); + + if (!$view->isAccessible()) { + throw new PermissionDeniedException(); + } + + return new JsonResponse([ + 'template' => $view->renderItems(), + ]); + } +} + +/** @internal */ +final class GetNodesParameters +{ + public function __construct( + /** @var non-empty-string */ + public readonly string $nodeTreeView, + /** @var array */ + public readonly array $nodeTreeViewParameters, + ) {} +} diff --git a/wcfsetup/install/files/lib/system/interaction/admin/MenuItemInteractions.class.php b/wcfsetup/install/files/lib/system/interaction/admin/MenuItemInteractions.class.php new file mode 100644 index 00000000000..016f74e941b --- /dev/null +++ b/wcfsetup/install/files/lib/system/interaction/admin/MenuItemInteractions.class.php @@ -0,0 +1,59 @@ + + * @since 6.3 + */ +final class MenuItemInteractions extends AbstractInteractionProvider +{ + public function __construct() + { + $this->addInteractions([ + new class('add-child-node', MenuItemAddForm::class, 'wcf.acp.menu.item.addChildNode') extends LinkInteraction { + #[\Override] + protected function getLink(DatabaseObject $object): string + { + \assert($object instanceof MenuItem); + + return LinkHandler::getInstance()->getControllerLink( + $this->controllerClass, + [ + 'menuID' => $object->menuID, + 'parentItemID' => $object->getObjectID(), + ] + ); + } + }, + new DeleteInteraction( + 'core/menus/items/%s', + static fn(MenuItem $object) => $object->canDelete() + ), + ]); + + EventHandler::getInstance()->fire( + new MenuItemInteractionCollecting($this) + ); + } + + #[\Override] + public function getObjectClassName(): string + { + return MenuItem::class; + } +} diff --git a/wcfsetup/install/files/lib/system/nodeTreeView/AbstractNodeTreeView.class.php b/wcfsetup/install/files/lib/system/nodeTreeView/AbstractNodeTreeView.class.php new file mode 100644 index 00000000000..cd2d358fc4f --- /dev/null +++ b/wcfsetup/install/files/lib/system/nodeTreeView/AbstractNodeTreeView.class.php @@ -0,0 +1,257 @@ + + * @since 6.3 + */ +abstract class AbstractNodeTreeView +{ + /** + * @var IInteraction[] + */ + private array $quickInteractions = []; + + private ?IInteractionProvider $interactionProvider = null; + private InteractionContextMenuComponent $interactionContextMenuComponent; + private string $setPositionsEndpoint = ''; + + /** + * Sets the interaction provider that is used to render the interaction context menu. + */ + public function setInteractionProvider(IInteractionProvider $provider): void + { + $this->interactionProvider = $provider; + } + + /** + * Returns the interaction provider of the node tree view. + */ + public function getInteractionProvider(): ?IInteractionProvider + { + return $this->interactionProvider; + } + + /** + * @return \RecursiveIteratorIterator + */ + public abstract function getNodes(): \RecursiveIteratorIterator; + + public abstract function getNodeLink(IObjectTreeNode $node): string; + + /** + * Renders the node tree view and returns the HTML code. + */ + public function render(): string + { + return WCF::getTPL()->render('wcf', 'shared_nodeTreeView', ['view' => $this]); + } + + /** + * Renders the items and returns the HTML code. + */ + public function renderItems(): string + { + return WCF::getTPL()->render('wcf', 'shared_nodeTreeViewItems', [ + 'view' => $this, + ]); + } + + /** + * Renders a single node and its descendants and returns the HTML code. + */ + public function renderItem(IObjectTreeNode $node): string + { + return WCF::getTPL()->render('wcf', 'shared_nodeTreeViewItem', [ + 'view' => $this, + 'node' => $node, + ]); + } + + /** + * Returns the node with the given object id or `null` if no such node exists. + */ + public function getNode(int $objectID): ?IObjectTreeNode + { + foreach ($this->getNodes() as $node) { + if ($node->getObjectID() == $objectID) { + return $node; + } + } + + return null; + } + + /** + * Returns true, if this node tree view is accessible for the active user. + */ + public function isAccessible(): bool + { + return true; + } + + /** + * Gets the additional parameters of the node tree view. + * + * @return mixed[] + */ + public function getParameters(): array + { + return []; + } + + /** + * Returns true, if this node tree view has interactions. + */ + public function hasInteractions(): bool + { + return $this->interactionProvider !== null || $this->quickInteractions !== []; + } + + /** + * Adds a quick interaction. + */ + public function addQuickInteraction(IInteraction $interaction): void + { + $this->quickInteractions[] = $interaction; + } + + /** + * Returns the quick interactions. + * + * @return IInteraction[] + */ + public function getQuickInteractions(): array + { + return $this->quickInteractions; + } + + /** + * Renders the quick interactions for the given node. + */ + public function renderQuickInteractions(IObjectTreeNode $node): string + { + if ($node instanceof DatabaseObjectDecorator) { + $object = $node->getDecoratedObject(); + } else if ($node instanceof DatabaseObject) { + $object = $node; + } else { + throw new \LogicException('node has to be a `DatabaseObject`'); + } + + $availableInteractions = \array_filter( + $this->getQuickInteractions(), + static fn($interaction) => $interaction->isAvailable($object) + ); + + return \implode("\n", \array_map( + static fn($interaction) => $interaction->render($object), + $availableInteractions + )); + } + + /** + * Renders the interactions for the given node. + */ + public function renderInteractionContextMenuButton(IObjectTreeNode $node): string + { + if ($this->interactionProvider === null) { + return ''; + } + + if ($node instanceof DatabaseObjectDecorator) { + $object = $node->getDecoratedObject(); + } else if ($node instanceof DatabaseObject) { + $object = $node; + } else { + throw new \LogicException('node has to be a `DatabaseObject`'); + } + + return $this->getInteractionContextMenuComponent()->renderButton($object); + } + + /** + * Returns the view of the interaction context menu. + */ + public function getInteractionContextMenuComponent(): InteractionContextMenuComponent + { + if ($this->interactionProvider === null) { + throw new \BadMethodCallException("Missing interaction provider."); + } + + if (!isset($this->interactionContextMenuComponent)) { + $this->interactionContextMenuComponent = new InteractionContextMenuComponent($this->interactionProvider); + } + + return $this->interactionContextMenuComponent; + } + + /** + * Renders the initialization code for the interactions of the node tree view. + */ + public function renderInteractionInitialization(): string + { + $code = ''; + if ($this->interactionProvider !== null) { + $code = $this->getInteractionContextMenuComponent()->renderInitialization($this->getID()); + } + + if ($this->quickInteractions !== []) { + $code .= "\n"; + $code .= \implode("\n", \array_map( + fn($interaction) => $interaction->renderInitialization($this->getID()), + $this->getQuickInteractions() + )); + } + + return $code; + } + + /** + * Returns the name of the node tree view class. + */ + public function getClassName(): string + { + return static::class; + } + + /** + * Returns the id of this node tree view. + */ + public function getID(): string + { + $id = \str_replace('\\', '_', static::class); + + if ($this->getParameters() !== []) { + $parameters = $this->getParameters(); + \array_multisort($parameters); + + $id .= '_' . \sha1(\serialize($parameters)); + } + + return $id; + } + + public function setSetPositionsEndpoint(string $endpoint): void + { + $this->setPositionsEndpoint = $endpoint; + } + + public function getSetPositionsEndpoint(): string + { + return $this->setPositionsEndpoint; + } +} diff --git a/wcfsetup/install/files/lib/system/nodeTreeView/admin/MenuItemNodeTreeView.class.php b/wcfsetup/install/files/lib/system/nodeTreeView/admin/MenuItemNodeTreeView.class.php new file mode 100644 index 00000000000..7a40870c340 --- /dev/null +++ b/wcfsetup/install/files/lib/system/nodeTreeView/admin/MenuItemNodeTreeView.class.php @@ -0,0 +1,85 @@ + + * @since 6.3 + */ +class MenuItemNodeTreeView extends AbstractNodeTreeView +{ + public function __construct(public readonly int $menuID) + { + $provider = new MenuItemInteractions(); + $provider->addInteractions([ + new Divider(), + new EditInteraction(MenuItemEditForm::class) + ]); + $this->setInteractionProvider($provider); + $this->addQuickInteraction( + new ToggleInteraction( + 'enable', + 'core/menus/items/%s/enable', + 'core/menus/items/%s/disable' + ) + ); + $this->setSetPositionsEndpoint("core/menus/{$this->menuID}/items/positions"); + } + + #[\Override] + public function getNodes(): \RecursiveIteratorIterator + { + $nodeTree = new MenuItemNodeTree($this->menuID, null, false); + + return $nodeTree->getNodeList(); + } + + #[\Override] + public function getParameters(): array + { + return ['menuID' => $this->menuID]; + } + + #[\Override] + public function getNodeLink(IObjectTreeNode $node): string + { + \assert($node instanceof MenuItemNode); + + return LinkHandler::getInstance()->getControllerLink( + MenuItemEditForm::class, + ['id' => $node->getObjectID()] + ); + } + + #[\Override] + public function isAccessible(): bool + { + if (!WCF::getSession()->hasPermission('admin.content.cms.canManageMenu')) { + return false; + } + + $menu = new Menu($this->menuID); + if ($menu->isNil()) { + return false; + } + + return true; + } +} diff --git a/wcfsetup/install/files/style/ui/nodeTreeView.scss b/wcfsetup/install/files/style/ui/nodeTreeView.scss new file mode 100644 index 00000000000..2b3f37c82ce --- /dev/null +++ b/wcfsetup/install/files/style/ui/nodeTreeView.scss @@ -0,0 +1,132 @@ +.nodeTreeView__list { + counter-reset: count; + display: flex; + flex-direction: column; +} + +.nodeTreeView__item { + counter-increment: count; +} + +.nodeTreeView__item__content { + border: 1px solid transparent; + padding: 8px 10px; + display: flex; + align-items: center; + column-gap: 8px; + border-bottom: 1px solid var(--wcfContentBorderInner); + position: relative; +} + +.nodeTreeView__item__content::before { + content: counter(count, decimal); + background-color: var(--wcfContentText); + border-radius: 2px; + color: var(--wcfContentBackground); + padding: 2px 6px; + font-variant: tabular-nums; + + @include wcfFontSmall; +} + +.nodeTreeView__item__content:hover { + background-color: var(--wcfTabularBoxBackgroundActive); +} + +.nodeTreeView__item__link { + color: inherit; + font-weight: 600; + flex: 1 0 auto; + + &:hover { + color: inherit; + } +} + +.nodeTreeView__item__buttons { + align-items: center; + display: flex; + gap: 10px; + justify-content: end; +} + +.nodeTreeView__item__handle { + position: absolute; + left: 10px; + color: var(--wcfContentDimmedText); +} + +.nodeTreeView__item__content:hover .nodeTreeView__item__handle { + color: var(--wcfContentText); +} + +.nodeTreeView__footer { + bottom: -10px; + display: flex; + justify-content: center; + gap: 10px; + min-height: 54px; + padding: 20px 0; + position: sticky; + z-index: 2; +} + +@include screen-sm-down { + .nodeTreeView__footer { + margin-bottom: -10px; + } +} + +@include screen-md-up { + .nodeTreeView__footer { + margin-bottom: -20px; + } +} + +.nodeTreeView__footer__container { + backdrop-filter: blur(24px); + background-color: rgb(var(--wcfContentContainerBackground-rgb) / 78%); + border: 1px solid transparent; + border-radius: var(--wcfBorderRadiusContainer); + box-shadow: var(--wcfBoxShadow); + display: flex; + gap: 21px; + padding: 10px; +} + +@include screen-xs { + .nodeTreeView__footer__container { + align-items: center; + flex-direction: column; + } +} + +html[data-color-scheme="dark"] .nodeTreeView__footer__container { + border-color: var(--wcfContentContainerBorder); +} + +.nodeTreeView__list { + --baseIndentation: 36px; + --indentation: 26px; + --depth: 0; +} + +.nodeTreeView__list .nodeTreeView__list { + --depth: 1; +} + +.nodeTreeView__list .nodeTreeView__list .nodeTreeView__list { + --depth: 2; +} + +.nodeTreeView__list .nodeTreeView__list .nodeTreeView__list .nodeTreeView__list { + --depth: 3; +} + +.nodeTreeView__list .nodeTreeView__list .nodeTreeView__list .nodeTreeView__list .nodeTreeView__list { + --depth: 4; +} + +.nodeTreeView__item__content { + padding-left: calc(var(--baseIndentation) + calc(var(--depth) * var(--indentation))); +} diff --git a/wcfsetup/install/lang/de.xml b/wcfsetup/install/lang/de.xml index 5ddf902aace..2e939a5289c 100644 --- a/wcfsetup/install/lang/de.xml +++ b/wcfsetup/install/lang/de.xml @@ -1258,6 +1258,7 @@ Sie erreichen das Fehlerprotokoll unter: {link controller='ExceptionLogView' isE + diff --git a/wcfsetup/install/lang/en.xml b/wcfsetup/install/lang/en.xml index a8a3de1ac8b..dfbab4bd9e2 100644 --- a/wcfsetup/install/lang/en.xml +++ b/wcfsetup/install/lang/en.xml @@ -1234,6 +1234,7 @@ You can access the error log at: {link controller='ExceptionLogView' isEmail=tru +