9.5/_backend_user_controller_8php_source.html

<?php

namespace ‪TYPO3\CMS\Beuser\Controller;


/*

 * 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!

 */


use ‪TYPO3\CMS\Core\Authentication\BackendUserAuthentication;

use ‪TYPO3\CMS\Core\Compatibility\PublicMethodDeprecationTrait;

use ‪TYPO3\CMS\Core\Session\Backend\HashableSessionBackendInterface;

use ‪TYPO3\CMS\Core\Session\Backend\SessionBackendInterface;

use ‪TYPO3\CMS\Core\Session\SessionManager;

use ‪TYPO3\CMS\Core\Utility\GeneralUtility;

use ‪TYPO3\CMS\Extbase\Mvc\Controller\ActionController;

use ‪TYPO3\CMS\Extbase\Mvc\View\ViewInterface;

use ‪TYPO3\CMS\Extbase\Utility\LocalizationUtility;


class ‪BackendUserController extends ‪ActionController

{

    use ‪PublicMethodDeprecationTrait;


    private ‪$deprecatedPublicMethods = [

        'initializeView' => 'Using BackendUserController::initializeView() is deprecated and will not be possible anymore in TYPO3 v10.0.',

    ];


    const ‪RECENT_USERS_LIMIT = 3;


    protected ‪$moduleData;


    protected ‪$moduleDataStorageService;


    protected ‪$backendUserRepository;


    protected ‪$backendUserGroupRepository;


    protected ‪$backendUserSessionRepository;


    public function ‪injectModuleDataStorageService(\‪TYPO3\CMS\Beuser\Service\ModuleDataStorageService ‪$moduleDataStorageService)

    {

        $this->moduleDataStorageService = ‪$moduleDataStorageService;

    }


    public function ‪injectBackendUserRepository(\‪TYPO3\CMS\Beuser\Domain\Repository\BackendUserRepository ‪$backendUserRepository)

    {

        $this->backendUserRepository = ‪$backendUserRepository;

    }


    public function ‪injectBackendUserGroupRepository(\‪TYPO3\CMS\Beuser\Domain\Repository\BackendUserGroupRepository ‪$backendUserGroupRepository)

    {

        $this->backendUserGroupRepository = ‪$backendUserGroupRepository;

    }


    public function ‪injectBackendUserSessionRepository(\‪TYPO3\CMS\Beuser\Domain\Repository\BackendUserSessionRepository ‪$backendUserSessionRepository)

    {

        $this->backendUserSessionRepository = ‪$backendUserSessionRepository;

    }


    public function ‪processRequest(\‪TYPO3\CMS\‪Extbase\Mvc\RequestInterface ‪$request, \‪TYPO3\CMS\‪Extbase\Mvc\ResponseInterface ‪$response)

    {

        $this->moduleData = $this->moduleDataStorageService->loadModuleData();

        // We "finally" persist the module data.

        try {

            parent::processRequest(‪$request, ‪$response);

            $this->moduleDataStorageService->persistModuleData($this->moduleData);

        } catch (\‪TYPO3\CMS\‪Extbase\Mvc\Exception\StopActionException $e) {

            $this->moduleDataStorageService->persistModuleData($this->moduleData);

            throw $e;

        }

    }


    protected function ‪initializeView(ViewInterface ‪$view)

    {

        ‪$view->‪assignMultiple([

            'shortcutLabel' => 'backendUsers',

            'dateFormat' => ‪$GLOBALS['TYPO3_CONF_VARS']['SYS']['ddmmyy'],

            'timeFormat' => ‪$GLOBALS['TYPO3_CONF_VARS']['SYS']['hhmm'],

        ]);

    }


    public function ‪indexAction(\‪TYPO3\CMS\Beuser\Domain\Model\Demand $demand = null)

    {

        if ($demand === null) {

            $demand = $this->moduleData->getDemand();

        } else {

            $this->moduleData->setDemand($demand);

        }

        // Switch user until logout

        $switchUser = (int)GeneralUtility::_GP('SwitchUser');

        if ($switchUser > 0) {

            $this->‪switchUser($switchUser);

        }

        $compareUserList = $this->moduleData->getCompareUserList();


        // Create online user list for easy parsing

        $onlineUsers = $this->backendUserSessionRepository->findAllActive();

        $onlineBackendUsers = [];

        if (is_array($onlineUsers)) {

            foreach ($onlineUsers as $onlineUser) {

                $onlineBackendUsers[$onlineUser['ses_userid']] = true;

            }

        }


        $this->view->assignMultiple([

            'onlineBackendUsers' => $onlineBackendUsers,

            'demand' => $demand,

            'backendUsers' => $this->backendUserRepository->findDemanded($demand),

            'backendUserGroups' => array_merge([''], $this->backendUserGroupRepository->findAll()->toArray()),

            'compareUserUidList' => array_combine($compareUserList, $compareUserList),

            'currentUserUid' => $this->‪getBackendUserAuthentication()->user['uid'],

            'compareUserList' => !empty($compareUserList) ? $this->backendUserRepository->findByUidList($compareUserList) : '',

        ]);

    }


    public function ‪onlineAction()

    {

        $onlineUsersAndSessions = [];

        $onlineUsers = $this->backendUserRepository->findOnline();

        foreach ($onlineUsers as $onlineUser) {

            $onlineUsersAndSessions[] = [

                'backendUser' => $onlineUser,

                'sessions' => $this->backendUserSessionRepository->findByBackendUser($onlineUser)

            ];

        }


        $currentSessionId = $this->‪getBackendUserAuthentication()->‪getSessionId();

        $sessionBackend = $this->‪getSessionBackend();

        if ($sessionBackend instanceof HashableSessionBackendInterface) {

            $currentSessionId = $sessionBackend->hash($currentSessionId);

        }

        $this->view->assignMultiple([

            'shortcutLabel' => 'onlineUsers',

            'onlineUsersAndSessions' => $onlineUsersAndSessions,

            'currentSessionId' => $currentSessionId,

        ]);

    }


    public function ‪compareAction()

    {

        $compareUserList = $this->moduleData->getCompareUserList();

        if (empty($compareUserList)) {

            $this->‪redirect('index');

        }


        $this->view->assignMultiple([

            'shortcutLabel' => 'compareUsers',

            'compareUserList' => $this->backendUserRepository->findByUidList($compareUserList),

        ]);

    }


    public function ‪addToCompareListAction($uid)

    {

        $this->moduleData->attachUidCompareUser($uid);

        $this->moduleDataStorageService->persistModuleData($this->moduleData);

        $this->‪forward('index');

    }


    public function ‪removeFromCompareListAction($uid)

    {

        $this->moduleData->detachUidCompareUser($uid);

        $this->moduleDataStorageService->persistModuleData($this->moduleData);

        $this->‪forward('index');

    }


    protected function ‪terminateBackendUserSessionAction(\‪TYPO3\CMS\Beuser\Domain\Model\BackendUser $backendUser, $sessionId)

    {

        // terminating value of persisted session ID (probably hashed value)

        $sessionBackend = $this->‪getSessionBackend();

        $success = $sessionBackend->remove($sessionId);


        if ($success) {

            $this->‪addFlashMessage(‪LocalizationUtility::translate('LLL:EXT:beuser/Resources/Private/Language/locallang.xlf:terminateSessionSuccess', 'beuser'));

        }

        $this->‪forward('online');

    }


    protected function ‪switchUser($switchUser)

    {

        $targetUser = ‪\TYPO3\CMS\Backend\Utility\BackendUtility::getRecord('be_users', $switchUser);

        if (is_array($targetUser) && $this->‪getBackendUserAuthentication()->isAdmin()) {

            // Set backend user listing module as starting module for switchback

            $this->‪getBackendUserAuthentication()->uc['startModuleOnFirstLogin'] = 'system_BeuserTxBeuser';

            $this->‪getBackendUserAuthentication()->uc['recentSwitchedToUsers'] = $this->‪generateListOfMostRecentSwitchedUsers($targetUser['uid']);

            $this->‪getBackendUserAuthentication()->‪writeUC();


            $this->‪getSessionBackend()->‪update(

                $this->‪getBackendUserAuthentication()->getSessionId(),

                [

                    'ses_userid' => (int)$targetUser['uid'],

                    'ses_backuserid' => (int)$this->‪getBackendUserAuthentication()->user['uid']

                ]

            );


            $this->‪emitSwitchUserSignal($targetUser);


            $redirectUrl = 'index.php' . (‪$GLOBALS['TYPO3_CONF_VARS']['BE']['interfaces'] ? '' : '?commandLI=1');

            ‪\TYPO3\CMS\Core\Utility\HttpUtility::redirect($redirectUrl);

        }

    }


    protected function ‪generateListOfMostRecentSwitchedUsers(int $targetUserUid): array

    {

        $latestUserUids = [];

        $backendUser = $this->‪getBackendUserAuthentication();


        if (isset($backendUser->uc['recentSwitchedToUsers']) && is_array($backendUser->uc['recentSwitchedToUsers'])) {

            $latestUserUids = $backendUser->uc['recentSwitchedToUsers'];

        }


        // Remove potentially existing user in that list

        $index = array_search($targetUserUid, $latestUserUids, true);

        if ($index !== false) {

            unset($latestUserUids[$index]);

        }


        array_unshift($latestUserUids, $targetUserUid);

        $latestUserUids = array_slice($latestUserUids, 0, static::RECENT_USERS_LIMIT);


        return $latestUserUids;

    }


    protected function ‪emitSwitchUserSignal(array $targetUser)

    {

        $this->signalSlotDispatcher->dispatch(__CLASS__, 'switchUser', [$targetUser]);

    }


    protected function ‪getBackendUserAuthentication(): ‪BackendUserAuthentication

    {

        return ‪$GLOBALS['BE_USER'];

    }


    protected function ‪getSessionBackend()

    {

        $loginType = $this->‪getBackendUserAuthentication()->‪getLoginType();

        return GeneralUtility::makeInstance(SessionManager::class)->getSessionBackend($loginType);

    }

}