BackendUserController.php

Go to the documentation of this file.

<?php
 
declare(strict_types=1);
 
/*
 * This file is part of the TYPO3 CMS project.
 *
 * It is free software; you can redistribute it and/or modify it under
 * the terms of the GNU General Public License, either version 2
 * of the License, or any later version.
 *
 * For the full copyright and license information, please read the
 * LICENSE.txt file that was distributed with this source code.
 *
 * The TYPO3 project - inspiring people to share!
 */
 
namespace ‪TYPO3\CMS\Beuser\Controller;
 
use Psr\Http\Message\ResponseInterface;
use ‪TYPO3\CMS\Backend\Authentication\PasswordReset;
use ‪TYPO3\CMS\Backend\Module\ModuleData;
use ‪TYPO3\CMS\Backend\Routing\UriBuilder as BackendUriBuilder;
use ‪TYPO3\CMS\Backend\Template\Components\ButtonBar;
use ‪TYPO3\CMS\Backend\Template\ModuleTemplate;
use ‪TYPO3\CMS\Backend\Template\ModuleTemplateFactory;
use ‪TYPO3\CMS\Beuser\Domain\Dto\BackendUserGroup;
use ‪TYPO3\CMS\Beuser\Domain\Model\BackendUser;
use ‪TYPO3\CMS\Beuser\Domain\Model\Demand;
use ‪TYPO3\CMS\Beuser\Domain\Repository\BackendUserGroupRepository;
use ‪TYPO3\CMS\Beuser\Domain\Repository\BackendUserRepository;
use ‪TYPO3\CMS\Beuser\Domain\Repository\BackendUserSessionRepository;
use ‪TYPO3\CMS\Beuser\Domain\Repository\FileMountRepository;
use ‪TYPO3\CMS\Beuser\Service\UserInformationService;
use ‪TYPO3\CMS\Core\Authentication\BackendUserAuthentication;
use ‪TYPO3\CMS\Core\Context\Context;
use ‪TYPO3\CMS\Core\Imaging\IconFactory;
use TYPO3\CMS\Core\Imaging\IconSize;
use ‪TYPO3\CMS\Core\Page\PageRenderer;
use ‪TYPO3\CMS\Core\Pagination\SimplePagination;
use ‪TYPO3\CMS\Core\Type\ContextualFeedbackSeverity;
use ‪TYPO3\CMS\Core\Utility\GeneralUtility;
use ‪TYPO3\CMS\Extbase\Http\ForwardResponse;
use ‪TYPO3\CMS\Extbase\Mvc\Controller\ActionController;
use ‪TYPO3\CMS\Extbase\Mvc\Request;
use ‪TYPO3\CMS\Extbase\Mvc\RequestInterface;
use ‪TYPO3\CMS\Extbase\Pagination\QueryResultPaginator;
use ‪TYPO3\CMS\Extbase\Persistence\QueryResultInterface;
use ‪TYPO3\CMS\Extbase\Utility\LocalizationUtility;
 
class ‪BackendUserController extends ‪ActionController
{
    protected ?‪ModuleData ‪$moduleData = null;
    protected ‪ModuleTemplate ‪$moduleTemplate;
 
    public function ‪__construct(
        protected readonly ‪BackendUserRepository $backendUserRepository,
        protected readonly ‪BackendUserGroupRepository $backendUserGroupRepository,
        protected readonly ‪BackendUserSessionRepository $backendUserSessionRepository,
        protected readonly ‪UserInformationService $userInformationService,
        protected readonly ‪ModuleTemplateFactory $moduleTemplateFactory,
        protected readonly BackendUriBuilder $backendUriBuilder,
        protected readonly ‪IconFactory $iconFactory,
        protected readonly ‪PageRenderer $pageRenderer,
        protected readonly ‪FileMountRepository $fileMountRepository
    ) {}
 
    public function ‪processRequest(‪RequestInterface ‪$request): ResponseInterface
    {
        ‪$arguments = ‪$request->‪getArguments();
        ‪$moduleData = ‪$request->getAttribute('moduleData');
        if (
            isset(‪$arguments['action'])
            && in_array((string)‪$arguments['action'], ['index', 'groups', 'online', 'filemounts'])
            && (string)‪$moduleData->‪get('defaultAction') !== (string)‪$arguments['action']
        ) {
            ‪$moduleData->‪set('defaultAction', (string)‪$arguments['action']);
            $this->‪getBackendUser()->pushModuleData($moduleData->‪getModuleIdentifier(), ‪$moduleData->‪toArray());
        } elseif (
            !isset(‪$arguments['action'])
            && ‪$moduleData->‪has('defaultAction')
            && in_array((string)‪$moduleData->‪get('defaultAction'), ['index', 'groups', 'online', 'filemounts'])
        ) {
            ‪$request = ‪$request->‪withControllerActionName((string)‪$moduleData->‪get('defaultAction'));
        }
        return parent::processRequest(‪$request);
    }
 
    public function ‪initializeAction(): void
    {
        $this->moduleData = $this->request->getAttribute('moduleData');
        $this->moduleTemplate = $this->moduleTemplateFactory->create($this->request);
        $this->moduleTemplate->setTitle(‪LocalizationUtility::translate('LLL:EXT:beuser/Resources/Private/Language/locallang_mod.xlf:mlang_tabs_tab'));
        $this->moduleTemplate->setFlashMessageQueue($this->‪getFlashMessageQueue());
    }
 
    protected function ‪initializeView(): void
    {
        $this->moduleTemplate->assignMultiple([
            'dateFormat' => ‪$GLOBALS['TYPO3_CONF_VARS']['SYS']['ddmmyy'],
            'timeFormat' => ‪$GLOBALS['TYPO3_CONF_VARS']['SYS']['hhmm'],
        ]);
        // Load JavaScript modules
        $this->pageRenderer->loadJavaScriptModule('@typo3/backend/context-menu.js');
        $this->pageRenderer->loadJavaScriptModule('@typo3/backend/modal.js');
        $this->pageRenderer->loadJavaScriptModule('@typo3/beuser/backend-user-listing.js');
    }
 
    public function ‪indexAction(?‪Demand $demand = null, int $currentPage = 1, string $operation = ''): ResponseInterface
    {
        $backendUser = $this->‪getBackendUser();
 
        if ($operation === 'reset-filters') {
            // Reset the module data demand object
            $this->moduleData->set('demand', []);
            $demand = null;
        }
        if ($demand === null) {
            $demand = ‪Demand::fromUc((array)$this->moduleData->get('demand', []));
        } else {
            $this->moduleData->set('demand', $demand->forUc());
        }
        $backendUser->pushModuleData($this->moduleData->getModuleIdentifier(), $this->moduleData->toArray());
 
        $compareUserList = array_keys((array)$this->moduleData->get('compareUserList', []));
 
        $backendUsers = $this->backendUserRepository->findDemanded($demand);
        $paginator = new ‪QueryResultPaginator($backendUsers, $currentPage, 50);
        $pagination = new ‪SimplePagination($paginator);
 
        $this->moduleTemplate->assignMultiple([
            'onlineBackendUsers' => $this->‪getOnlineBackendUsers(),
            'demand' => $demand,
            'paginator' => $paginator,
            'pagination' => $pagination,
            'totalAmountOfBackendUsers' => $backendUsers->count(),
            'backendUserGroups' => array_merge([''], $this->backendUserGroupRepository->findAll()->toArray()),
            'compareUserUidList' => array_combine($compareUserList, $compareUserList),
            'currentUserUid' => $backendUser->user['uid'] ?? null,
            'compareUserList' => !empty($compareUserList) ? $this->backendUserRepository->findByUidList($compareUserList) : '',
        ]);
 
        $this->‪addMainMenu('index');
        $buttonBar = $this->moduleTemplate->getDocHeaderComponent()->getButtonBar();
        $addUserButton = $buttonBar->makeLinkButton()
            ->setIcon($this->iconFactory->getIcon('actions-plus', IconSize::SMALL))
            ->setTitle(‪LocalizationUtility::translate('LLL:EXT:beuser/Resources/Private/Language/locallang.xlf:backendUser.create', 'beuser'))
            ->setShowLabelText(true)
            ->setHref((string)$this->backendUriBuilder->buildUriFromRoute('record_edit', [
                'edit' => ['be_users' => [0 => 'new']],
                'returnUrl' => $this->request->getAttribute('normalizedParams')->getRequestUri(),
            ]));
        $buttonBar->addButton($addUserButton);
        $shortcutButton = $buttonBar->makeShortcutButton()
            ->setRouteIdentifier('backend_user_management')
            ->setArguments(['action' => 'index'])
            ->setDisplayName(‪LocalizationUtility::translate('LLL:EXT:beuser/Resources/Private/Language/locallang.xlf:backendUsers', 'beuser'));
        $buttonBar->addButton($shortcutButton, ‪ButtonBar::BUTTON_POSITION_RIGHT);
 
        $this->pageRenderer->loadJavaScriptModule('@typo3/backend/switch-user.js');
 
        return $this->moduleTemplate->renderResponse('BackendUser/List');
    }
 
    public function ‪onlineAction(): ResponseInterface
    {
        $onlineUsersAndSessions = [];
        $onlineUsers = $this->backendUserRepository->findOnline();
        foreach ($onlineUsers as $onlineUser) {
            $onlineUsersAndSessions[] = [
                'backendUser' => $onlineUser,
                'sessions' => $this->backendUserSessionRepository->findByBackendUser($onlineUser),
            ];
        }
 
        $currentSessionId = $this->backendUserSessionRepository->getPersistedSessionIdentifier($this->‪getBackendUser());
 
        $this->moduleTemplate->assignMultiple([
            'onlineUsersAndSessions' => $onlineUsersAndSessions,
            'currentSessionId' => $currentSessionId,
        ]);
 
        $this->‪addMainMenu('online');
        $buttonBar = $this->moduleTemplate->getDocHeaderComponent()->getButtonBar();
        $shortcutButton = $buttonBar->makeShortcutButton()
            ->setRouteIdentifier('backend_user_management')
            ->setArguments(['action' => 'online'])
            ->setDisplayName(‪LocalizationUtility::translate('LLL:EXT:beuser/Resources/Private/Language/locallang.xlf:onlineUsers', 'beuser'));
        $buttonBar->addButton($shortcutButton, ‪ButtonBar::BUTTON_POSITION_RIGHT);
 
        return $this->moduleTemplate->renderResponse('BackendUser/Online');
    }
 
    public function ‪showAction(int ‪$uid = 0): ResponseInterface
    {
        $data = $this->userInformationService->getUserInformation(‪$uid);
        $this->moduleTemplate->assign('data', $data);
 
        $this->‪addMainMenu('show');
        $buttonBar = $this->moduleTemplate->getDocHeaderComponent()->getButtonBar();
        $backButton = $buttonBar->makeLinkButton()
            ->setIcon($this->iconFactory->getIcon('actions-view-go-back', IconSize::SMALL))
            ->setTitle(‪LocalizationUtility::translate('LLL:EXT:core/Resources/Private/Language/locallang_core.xlf:labels.goBack'))
            ->setShowLabelText(true)
            ->setHref((string)$this->backendUriBuilder->buildUriFromRoute('backend_user_management'));
        $buttonBar->addButton($backButton, ‪ButtonBar::BUTTON_POSITION_LEFT, 1);
        $editButton = $buttonBar->makeLinkButton()
            ->setIcon($this->iconFactory->getIcon('actions-open', IconSize::SMALL))
            ->setTitle(‪LocalizationUtility::translate('LLL:EXT:core/Resources/Private/Language/locallang_core.xlf:labels.edit'))
            ->setShowLabelText(true)
            ->setHref((string)$this->backendUriBuilder->buildUriFromRoute('record_edit', [
                'edit' => ['be_users' => [‪$uid => 'edit']],
                'returnUrl' => $this->request->getAttribute('normalizedParams')->getRequestUri(),
            ]));
        $buttonBar->addButton($editButton, ‪ButtonBar::BUTTON_POSITION_LEFT, 2);
        $addUserButton = $buttonBar->makeLinkButton()
            ->setIcon($this->iconFactory->getIcon('actions-plus', IconSize::SMALL))
            ->setTitle(‪LocalizationUtility::translate('LLL:EXT:beuser/Resources/Private/Language/locallang.xlf:backendUser.create', 'beuser'))
            ->setShowLabelText(true)
            ->setHref((string)$this->backendUriBuilder->buildUriFromRoute('record_edit', [
                'edit' => ['be_users' => [0 => 'new']],
                'returnUrl' => $this->request->getAttribute('normalizedParams')->getRequestUri(),
            ]));
        $buttonBar->addButton($addUserButton, ‪ButtonBar::BUTTON_POSITION_LEFT, 3);
        $username = empty($data['user']['username']) ? '' : ': ' . $data['user']['username'];
        $shortcutButton = $buttonBar->makeShortcutButton()
            ->setRouteIdentifier('backend_user_management')
            ->setArguments(['action' => 'show', 'uid' => ‪$uid])
            ->setDisplayName(‪LocalizationUtility::translate('LLL:EXT:beuser/Resources/Private/Language/locallang.xlf:backendUser', 'beuser') . $username);
        $buttonBar->addButton($shortcutButton, ‪ButtonBar::BUTTON_POSITION_RIGHT);
 
        return $this->moduleTemplate->renderResponse('BackendUser/Show');
    }
 
    public function ‪compareAction(): ResponseInterface
    {
        $compareUserList = array_keys((array)$this->moduleData->get('compareUserList', []));
        if (empty($compareUserList)) {
            return $this->‪redirect('index');
        }
 
        $compareData = [];
        foreach ($compareUserList as ‪$uid) {
            if ($compareInformation = $this->userInformationService->getUserInformation(‪$uid)) {
                $compareData[] = $compareInformation;
            }
        }
 
        $this->moduleTemplate->assignMultiple([
            'compareUserList' => $compareData,
            'onlineBackendUsers' => $this->‪getOnlineBackendUsers(),
        ]);
 
        $this->‪addMainMenu('compare');
        $buttonBar = $this->moduleTemplate->getDocHeaderComponent()->getButtonBar();
        $backButton = $buttonBar->makeLinkButton()
            ->setIcon($this->iconFactory->getIcon('actions-view-go-back', IconSize::SMALL))
            ->setTitle(‪LocalizationUtility::translate('LLL:EXT:core/Resources/Private/Language/locallang_core.xlf:labels.goBack'))
            ->setShowLabelText(true)
            ->setHref((string)$this->backendUriBuilder->buildUriFromRoute('backend_user_management'));
        $buttonBar->addButton($backButton);
        $shortcutButton = $buttonBar->makeShortcutButton()
            ->setRouteIdentifier('backend_user_management')
            ->setArguments(['action' => 'compare'])
            ->setDisplayName(‪LocalizationUtility::translate('LLL:EXT:beuser/Resources/Private/Language/locallang.xlf:compareUsers', 'beuser'));
        $buttonBar->addButton($shortcutButton, ‪ButtonBar::BUTTON_POSITION_RIGHT);
 
        return $this->moduleTemplate->renderResponse('BackendUser/Compare');
    }
 
    public function ‪initiatePasswordResetAction(int $user): ResponseInterface
    {
        $context = GeneralUtility::makeInstance(Context::class);
        $userObject = $this->backendUserRepository->findByUid($user);
        if (!$userObject || !$userObject->isPasswordResetEnabled() || !$context->getAspect('backend.user')->isAdmin()) {
            // Add an error message
            $this->‪addFlashMessage(
                ‪LocalizationUtility::translate('LLL:EXT:beuser/Resources/Private/Language/locallang.xlf:flashMessage.resetPassword.error.text', 'beuser') ?? '',
                ‪LocalizationUtility::translate('LLL:EXT:beuser/Resources/Private/Language/locallang.xlf:flashMessage.resetPassword.error.title', 'beuser') ?? '',
                ContextualFeedbackSeverity::ERROR
            );
        } else {
            GeneralUtility::makeInstance(PasswordReset::class)->initiateReset(
                $this->request,
                $context,
                $userObject->getEmail()
            );
            $this->‪addFlashMessage(
                ‪LocalizationUtility::translate('LLL:EXT:beuser/Resources/Private/Language/locallang.xlf:flashMessage.resetPassword.success.text', 'beuser', [$userObject->getEmail()]) ?? '',
                ‪LocalizationUtility::translate('LLL:EXT:beuser/Resources/Private/Language/locallang.xlf:flashMessage.resetPassword.success.title', 'beuser') ?? ''
            );
        }
        return new ‪ForwardResponse('index');
    }
 
    public function ‪addToCompareListAction(int ‪$uid): ResponseInterface
    {
        $this->‪addToCompareList('compareUserList', $uid);
        return new ‪ForwardResponse('index');
    }
 
    public function ‪removeFromCompareListAction(int ‪$uid, int $redirectToCompare = 0): ResponseInterface
    {
        $this->‪removeFromCompareList('compareUserList', $uid);
        if ($redirectToCompare) {
            return $this->‪redirect('compare');
        }
        return $this->‪redirect('index');
    }
 
    public function ‪removeAllFromCompareListAction(): ResponseInterface
    {
        $this->‪cleanCompareList('compareUserList');
        return $this->‪redirect('index');
    }
 
    protected function ‪terminateBackendUserSessionAction(string $sessionId): ResponseInterface
    {
        // terminating value of persisted session ID
        $success = $this->backendUserSessionRepository->terminateSessionByIdentifier($sessionId);
        if ($success) {
            $this->‪addFlashMessage(‪LocalizationUtility::translate('LLL:EXT:beuser/Resources/Private/Language/locallang.xlf:terminateSessionSuccess', 'beuser') ?? '');
        }
        return new ‪ForwardResponse('online');
    }
 
    public function ‪groupsAction(?‪BackendUserGroup $userGroupDto = null, int $currentPage = 1, string $operation = ''): ResponseInterface
    {
        $backendUser = $this->‪getBackendUser();
 
        if ($operation === 'reset-filters') {
            $this->moduleData->set('userGroupDto', []);
            $userGroupDto = null;
        }
 
        if ($userGroupDto === null) {
            $userGroupDto = ‪BackendUserGroup::fromUc((array)$this->moduleData->get('userGroupDto', []));
        } else {
            $this->moduleData->set('userGroupDto', $userGroupDto->forUc());
        }
 
        $backendUser->pushModuleData($this->moduleData->getModuleIdentifier(), $this->moduleData->toArray());
 
        $backendUserGroups = $this->backendUserGroupRepository->findByFilter($userGroupDto);
        $paginator = new ‪QueryResultPaginator($backendUserGroups, $currentPage, 50);
        $pagination = new ‪SimplePagination($paginator);
        $compareGroupUidList = array_keys((array)$this->moduleData->get('compareGroupUidList', []));
        $this->moduleTemplate->assignMultiple(
            [
                'paginator' => $paginator,
                'pagination' => $pagination,
                'totalAmountOfBackendUserGroups' => $backendUserGroups->count(),
                'compareGroupUidList' => array_map(static function (int $value): int { // uid as key and force value to 1
                    return 1;
                }, array_flip($compareGroupUidList)),
                'compareGroupList' => !empty($compareGroupUidList) ? $this->backendUserGroupRepository->findByUidList($compareGroupUidList) : [],
                'userGroupDto' => $userGroupDto,
            ]
        );
 
        $this->‪addMainMenu('groups');
        $buttonBar = $this->moduleTemplate->getDocHeaderComponent()->getButtonBar();
        $addGroupButton = $buttonBar->makeLinkButton()
            ->setIcon($this->iconFactory->getIcon('actions-plus', IconSize::SMALL))
            ->setTitle(‪LocalizationUtility::translate('LLL:EXT:beuser/Resources/Private/Language/locallang.xlf:backendUserGroup.create', 'beuser'))
            ->setShowLabelText(true)
            ->setHref((string)$this->backendUriBuilder->buildUriFromRoute('record_edit', [
                'edit' => ['be_groups' => [0 => 'new']],
                'returnUrl' => $this->request->getAttribute('normalizedParams')->getRequestUri(),
            ]));
        $buttonBar->addButton($addGroupButton);
        $shortcutButton = $buttonBar->makeShortcutButton()
            ->setRouteIdentifier('backend_user_management')
            ->setArguments(['action' => 'groups'])
            ->setDisplayName(‪LocalizationUtility::translate('LLL:EXT:beuser/Resources/Private/Language/locallang.xlf:backendUserGroupsMenu', 'beuser'));
        $buttonBar->addButton($shortcutButton, ‪ButtonBar::BUTTON_POSITION_RIGHT);
 
        return $this->moduleTemplate->renderResponse('BackendUserGroup/List');
    }
 
    public function ‪compareGroupsAction(): ResponseInterface
    {
        $compareGroupUidList = array_keys((array)$this->moduleData->get('compareGroupUidList', []));
 
        $compareData = [];
        foreach ($compareGroupUidList as ‪$uid) {
            if ($compareInformation = $this->userInformationService->getGroupInformation(‪$uid)) {
                $compareData[] = $compareInformation;
            }
        }
        if (empty($compareData)) {
            return $this->‪redirect('groups');
        }
 
        $this->moduleTemplate->assign('compareGroupList', $compareData);
 
        $this->‪addMainMenu('compareGroups');
        $buttonBar = $this->moduleTemplate->getDocHeaderComponent()->getButtonBar();
        $backButton = $buttonBar->makeLinkButton()
            ->setIcon($this->iconFactory->getIcon('actions-view-go-back', IconSize::SMALL))
            ->setTitle(‪LocalizationUtility::translate('LLL:EXT:core/Resources/Private/Language/locallang_core.xlf:labels.goBack'))
            ->setShowLabelText(true)
            ->setHref($this->uriBuilder->uriFor('groups'));
        $buttonBar->addButton($backButton);
        $shortcutButton = $buttonBar->makeShortcutButton()
            ->setRouteIdentifier('backend_user_management')
            ->setArguments(['action' => 'compareGroups'])
            ->setDisplayName(‪LocalizationUtility::translate('LLL:EXT:beuser/Resources/Private/Language/locallang.xlf:compareBackendUsersGroups', 'beuser'));
        $buttonBar->addButton($shortcutButton, ‪ButtonBar::BUTTON_POSITION_RIGHT);
 
        return $this->moduleTemplate->renderResponse('BackendUserGroup/Compare');
    }
 
    public function ‪addGroupToCompareListAction(int ‪$uid): ResponseInterface
    {
        $this->‪addToCompareList('compareGroupUidList', $uid);
        return $this->‪redirect('groups');
    }
 
    public function ‪removeGroupFromCompareListAction(int ‪$uid, int $redirectToCompare = 0): ResponseInterface
    {
        $this->‪removeFromCompareList('compareGroupUidList', $uid);
        if ($redirectToCompare) {
            return $this->‪redirect('compareGroups');
        }
        return $this->‪redirect('groups');
    }
 
    public function ‪removeAllGroupsFromCompareListAction(): ResponseInterface
    {
        $this->‪cleanCompareList('compareGroupUidList');
        return $this->‪redirect('groups');
    }
 
    protected function ‪filemountsAction(int $currentPage = 1): ResponseInterface
    {
        $filemounts = $this->fileMountRepository->findAll();
 
        $this->‪addMainMenu('filemounts');
 
        $paginator = new ‪QueryResultPaginator($filemounts, $currentPage, 50);
        $pagination = new ‪SimplePagination($paginator);
        $this->moduleTemplate->assignMultiple(
            [
                'paginator' => $paginator,
                'pagination' => $pagination,
                'totalAmountOfFilemounts' => $filemounts->count(),
            ]
        );
 
        $buttonBar = $this->moduleTemplate->getDocHeaderComponent()->getButtonBar();
 
        $addFilemountButton = $buttonBar->makeLinkButton()
            ->setIcon($this->iconFactory->getIcon('actions-plus', IconSize::SMALL))
            ->setTitle(‪LocalizationUtility::translate('LLL:EXT:beuser/Resources/Private/Language/locallang.xlf:filemount.create', 'beuser'))
            ->setShowLabelText(true)
            ->setHref((string)$this->backendUriBuilder->buildUriFromRoute('record_edit', [
                'edit' => ['sys_filemounts' => [0 => 'new']],
                'returnUrl' => $this->request->getAttribute('normalizedParams')->getRequestUri(),
            ]));
        $buttonBar->addButton($addFilemountButton);
 
        return $this->moduleTemplate->renderResponse('Filemount/List');
    }
 
    protected function ‪getOnlineBackendUsers(): array
    {
        $onlineUsers = $this->backendUserSessionRepository->findAllActive();
        $onlineBackendUsers = [];
        foreach ($onlineUsers as $onlineUser) {
            $onlineBackendUsers[$onlineUser['ses_userid']] = true;
        }
        return $onlineBackendUsers;
    }
 
    protected function ‪addMainMenu(string $currentAction): void
    {
        $this->uriBuilder->setRequest($this->request);
        $menu = $this->moduleTemplate->getDocHeaderComponent()->getMenuRegistry()->makeMenu();
        $menu->setIdentifier('BackendUserModuleMenu');
        $menu->setLabel(
            ‪LocalizationUtility::translate(
                'LLL:EXT:backend/Resources/Private/Language/locallang.xlf:modulemenu.label',
                'backend',
            )
        );
        $menu->addMenuItem(
            $menu->makeMenuItem()
            ->setTitle(‪LocalizationUtility::translate('LLL:EXT:beuser/Resources/Private/Language/locallang.xlf:backendUsers', 'beuser'))
            ->setHref($this->uriBuilder->uriFor('index'))
            ->setActive($currentAction === 'index')
        );
        if ($currentAction === 'show') {
            $menu->addMenuItem(
                $menu->makeMenuItem()
                ->setTitle(‪LocalizationUtility::translate('LLL:EXT:beuser/Resources/Private/Language/locallang.xlf:backendUserDetails', 'beuser'))
                ->setHref($this->uriBuilder->uriFor('show'))
                ->setActive(true)
            );
        }
        if ($currentAction === 'compare') {
            $menu->addMenuItem(
                $menu->makeMenuItem()
                ->setTitle(‪LocalizationUtility::translate('LLL:EXT:beuser/Resources/Private/Language/locallang.xlf:compareBackendUsers', 'beuser'))
                ->setHref($this->uriBuilder->uriFor('index'))
                ->setActive(true)
            );
        }
        $menu->addMenuItem(
            $menu->makeMenuItem()
            ->setTitle(‪LocalizationUtility::translate('LLL:EXT:beuser/Resources/Private/Language/locallang.xlf:backendUserGroupsMenu', 'beuser'))
            ->setHref($this->uriBuilder->uriFor('groups'))
            ->setActive($currentAction === 'groups')
        );
        if ($currentAction === 'compareGroups') {
            $menu->addMenuItem(
                $menu->makeMenuItem()
                ->setTitle(‪LocalizationUtility::translate('LLL:EXT:beuser/Resources/Private/Language/locallang.xlf:compareBackendUsersGroups', 'beuser'))
                ->setHref($this->uriBuilder->uriFor('compareGroups'))
                ->setActive(true)
            );
        }
        $menu->addMenuItem(
            $menu->makeMenuItem()
            ->setTitle(‪LocalizationUtility::translate('LLL:EXT:beuser/Resources/Private/Language/locallang.xlf:onlineUsers', 'beuser'))
            ->setHref($this->uriBuilder->uriFor('online'))
            ->setActive($currentAction === 'online')
        );
        $menu->addMenuItem(
            $menu->makeMenuItem()
            ->setTitle(‪LocalizationUtility::translate('LLL:EXT:beuser/Resources/Private/Language/locallang.xlf:filemounts', 'beuser'))
            ->setHref($this->uriBuilder->uriFor('filemounts'))
            ->setActive($currentAction === 'filemounts')
        );
        $this->moduleTemplate->getDocHeaderComponent()->getMenuRegistry()->addMenu($menu);
    }
 
    protected function ‪addToCompareList(string $listIdentifier, int ‪$uid): void
    {
        $compareList = (array)$this->moduleData->get($listIdentifier, []);
        $compareList[‪$uid] = true;
        $this->moduleData->set($listIdentifier, $compareList);
        $this->‪getBackendUser()->pushModuleData($this->moduleData->getModuleIdentifier(), $this->moduleData->toArray());
    }
 
    protected function ‪removeFromCompareList(string $listIdentifier, int ‪$uid): void
    {
        $compareList = (array)$this->moduleData->get($listIdentifier, []);
        unset($compareList[‪$uid]);
        $this->moduleData->set($listIdentifier, $compareList);
        $this->‪getBackendUser()->pushModuleData($this->moduleData->getModuleIdentifier(), $this->moduleData->toArray());
    }
 
    protected function ‪cleanCompareList(string $listIdentifier): void
    {
        $this->moduleData->set($listIdentifier, []);
        $this->‪getBackendUser()->pushModuleData($this->moduleData->getModuleIdentifier(), $this->moduleData->toArray());
    }
 
    protected function ‪getBackendUser(): ‪BackendUserAuthentication
    {
        return ‪$GLOBALS['BE_USER'];
    }
}