9.5/_info_module_controller_8php_source.html

<?php

namespace ‪TYPO3\CMS\Info\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 Psr\Http\Message\ResponseInterface;

use Psr\Http\Message\ServerRequestInterface;

use ‪TYPO3\CMS\Backend\Routing\UriBuilder;

use ‪TYPO3\CMS\Backend\Template\Components\ButtonBar;

use ‪TYPO3\CMS\Backend\Template\DocumentTemplate;

use ‪TYPO3\CMS\Backend\Template\ModuleTemplate;

use ‪TYPO3\CMS\Backend\Utility\BackendUtility;

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

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

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

use ‪TYPO3\CMS\Core\Http\HtmlResponse;

use ‪TYPO3\CMS\Core\Imaging\Icon;

use ‪TYPO3\CMS\Core\Localization\LanguageService;

use ‪TYPO3\CMS\Core\Messaging\FlashMessage;

use ‪TYPO3\CMS\Core\Messaging\FlashMessageService;

use ‪TYPO3\CMS\Core\Type\Bitmask\Permission;

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

use ‪TYPO3\CMS\Fluid\View\StandaloneView;


class ‪InfoModuleController

{

    use ‪PublicPropertyDeprecationTrait;

    use ‪PublicMethodDeprecationTrait;


    private ‪$deprecatedPublicProperties = [

        'perms_clause' => 'Using InfoModuleController::$perms_clause is deprecated and will not be possible anymore in TYPO3 v10.0.',

        'modTSconfig' => 'Using InfoModuleController::$modTSconfig is deprecated and will not be possible anymore in TYPO3 v10.0.',

        'modMenu_setDefaultList' => 'Using InfoModuleController::$modMenu_setDefaultList is deprecated and will not be possible anymore in TYPO3 v10.0.',

        'modMenu_dontValidateList' => 'Using InfoModuleController::$modMenu_dontValidateList is deprecated and will not be possible anymore in TYPO3 v10.0.',

        'modMenu_type' => 'Using InfoModuleController::$modMenu_type$ is deprecated and will not be possible anymore in TYPO3 v10.0.',

        'extClassConf' => 'Using InfoModuleController::extClassConf$ is deprecated and will not be possible anymore in TYPO3 v10.0.',

        'extObj' => 'Using InfoModuleController::$extObj is deprecated and will not be possible anymore in TYPO3 v10.0.',

        'content' => 'Using InfoModuleController::$content is deprecated and will not be possible anymore in TYPO3 v10.0.',

        'pObj' => 'Using InfoModuleController::$pObj is deprecated and will not be possible anymore in TYPO3 v10.0.',

        'id' => 'Using InfoModuleController::id$ is deprecated and will not be possible anymore in TYPO3 v10.0.',

        'CMD' => 'Using InfoModuleController::$CMD is deprecated, property will be removed in TYPO3 v10.0.',

        'doc' => 'Using InfoModuleController::$doc is deprecated, property will be removed in TYPO3 v10.0.',

        'MCONF' => 'Using InfoModuleController::$MCONF is deprecated, property will be removed in TYPO3 v10.0.',

    ];


    private ‪$deprecatedPublicMethods = [

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

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

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

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

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

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

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

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

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

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

        'extObjHeader' => 'Using InfoModuleController::extObjHeader() is deprecated, method will be removed in TYPO3 v10.0.',

        'checkSubExtObj' => 'Using InfoModuleController::checkSubExtObj() is deprecated, method will be removed in TYPO3 v10.0.',

    ];


    public ‪$pageinfo;


    protected ‪$moduleName = 'web_info';


    protected ‪$moduleTemplate;


    protected ‪$view;


    protected ‪$MCONF = [];


    protected ‪$id;


    protected ‪$CMD;


    protected ‪$perms_clause;


    public ‪$MOD_MENU = [

        'function' => []

    ];


    public ‪$MOD_SETTINGS = [];


    protected ‪$modTSconfig;


    protected ‪$modMenu_type = '';


    protected ‪$modMenu_dontValidateList = '';


    protected ‪$modMenu_setDefaultList = '';


    protected ‪$extClassConf;


    protected ‪$content = '';


    protected ‪$doc;


    protected ‪$extObj;


    public function ‪__construct()

    {

        $this->moduleTemplate = GeneralUtility::makeInstance(ModuleTemplate::class);

        $languageService = $this->‪getLanguageService();

        $languageService->includeLLFile('EXT:info/Resources/Private/Language/locallang_mod_web_info.xlf');


        // @deprecated and will be removed in TYPO3 v10.0.

        $this->MCONF = [

            'name' => ‪$this->moduleName,

        ];

    }


    protected function ‪init()

    {

        $this->id = (int)GeneralUtility::_GP('id');

        // @deprecated since TYPO3 v9, will be removed in TYPO3 v10.0.

        $this->CMD = GeneralUtility::_GP('CMD');

        $this->perms_clause = $this->‪getBackendUser()->‪getPagePermsClause(‪Permission::PAGE_SHOW);

        $this->‪menuConfig();

        $this->‪handleExternalFunctionValue();

    }


    protected function ‪main()

    {

        // since TYPO3 v9, will be removed in TYPO3 v10.0.

        $this->doc = GeneralUtility::makeInstance(DocumentTemplate::class);


        $languageService = $this->‪getLanguageService();

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


        // The page will show only if there is a valid page and if this page

        // may be viewed by the user

        $this->pageinfo = ‪BackendUtility::readPageAccess($this->id, $this->perms_clause);

        if ($this->pageinfo) {

            $this->moduleTemplate->getDocHeaderComponent()->setMetaInformation($this->pageinfo);

        }

        $access = is_array($this->pageinfo);

        if ($this->id && $access || $backendUser->isAdmin() && !$this->id) {

            if ($backendUser->isAdmin() && !$this->id) {

                $this->pageinfo = ['title' => '[root-level]', 'uid' => 0, 'pid' => 0];

            }

            // JavaScript

            $this->moduleTemplate->addJavaScriptCode(

                'WebFuncInLineJS',

                'if (top.fsMod) top.fsMod.recentIds["web"] = ' . (int)$this->id . ';

                function jumpToUrl(URL) {

                    window.location.href = URL;

                    return false;

                }

                '

            );

            // Setting up the context sensitive menu:

            $this->moduleTemplate->getPageRenderer()->loadRequireJsModule('TYPO3/CMS/Backend/ContextMenu');


            $this->view = $this->‪getFluidTemplateObject();

            $uriBuilder = GeneralUtility::makeInstance(UriBuilder::class);

            $this->view->assign('moduleName', (string)$uriBuilder->buildUriFromRoute($this->moduleName));

            $this->view->assign('functionMenuModuleContent', $this->‪getExtObjContent());

            // Setting up the buttons and markers for doc header

            $this->‪getButtons();

            $this->‪generateMenu();

            $this->content .= $this->view->render();

        } else {

            // If no access or if ID == zero

            $this->content = $this->moduleTemplate->header($languageService->getLL('title'));

        }

    }


    public function ‪mainAction(ServerRequestInterface $request): ResponseInterface

    {

        // @deprecated and will be removed in TYPO3 v10.0.

        ‪$GLOBALS['SOBE'] = $this;


        $this->‪init();


        // Checking for first level external objects

        $this->‪checkExtObj();


        // Checking second level external objects

        // @deprecated and will be removed in TYPO3 v10.0.

        $this->‪checkSubExtObj();

        $this->‪main();


        $this->moduleTemplate->setContent($this->content);

        return new ‪HtmlResponse($this->moduleTemplate->renderContent());

    }


    protected function ‪getButtons()

    {

        $languageService = $this->‪getLanguageService();

        $buttonBar = $this->moduleTemplate->getDocHeaderComponent()->getButtonBar();

        // View page

        $viewButton = $buttonBar->makeLinkButton()

            ->setHref('#')

            ->setOnClick(‪BackendUtility::viewOnClick(

                $this->pageinfo['uid'],

                '',

                ‪BackendUtility::BEgetRootLine($this->pageinfo['uid'])

            ))

            ->setTitle($languageService->sL('LLL:EXT:core/Resources/Private/Language/locallang_core.xlf:labels.showPage'))

            ->setIcon($this->moduleTemplate->getIconFactory()->getIcon('actions-view-page', ‪Icon::SIZE_SMALL));

        $buttonBar->addButton($viewButton, ‪ButtonBar::BUTTON_POSITION_LEFT, 1);

        // Shortcut

        $shortCutButton = $buttonBar->makeShortcutButton()

            ->setModuleName($this->moduleName)

            ->setDisplayName($this->MOD_MENU['function'][$this->MOD_SETTINGS['function']])

            ->setGetVariables([

                'route',

                'id',

                'edit_record',

                'pointer',

                'new_unique_uid',

                'search_field',

                'search_levels',

                'showLimit'

            ])

            ->setSetVariables(array_keys($this->MOD_MENU));

        $buttonBar->addButton($shortCutButton, ‪ButtonBar::BUTTON_POSITION_RIGHT);


        // CSH

        $cshButton = $buttonBar->makeHelpButton()

            ->setModuleName('xMOD_csh_corebe')

            ->setFieldName('pagetree_overview');

        $buttonBar->addButton($cshButton);

    }


    protected function ‪generateMenu()

    {

        $menu = $this->moduleTemplate->getDocHeaderComponent()->getMenuRegistry()->makeMenu();

        $menu->setIdentifier('WebInfoJumpMenu');

        $uriBuilder = GeneralUtility::makeInstance(UriBuilder::class);

        foreach ($this->MOD_MENU['function'] as $controller => $title) {

            $item = $menu

                ->makeMenuItem()

                ->setHref(

                    (string)$uriBuilder->buildUriFromRoute(

                        $this->moduleName,

                        [

                            'id' => $this->id,

                            'SET' => [

                                'function' => $controller

                            ]

                        ]

                    )

                )

                ->setTitle($title);

            if ($controller === $this->MOD_SETTINGS['function']) {

                $item->setActive(true);

            }

            $menu->addMenuItem($item);

        }

        $this->moduleTemplate->getDocHeaderComponent()->getMenuRegistry()->addMenu($menu);

    }


    protected function ‪getModuleTemplate()

    {

        return ‪$this->moduleTemplate;

    }


    protected function ‪getFluidTemplateObject()

    {

        ‪$view = GeneralUtility::makeInstance(StandaloneView::class);

        ‪$view->‪setLayoutRootPaths([GeneralUtility::getFileAbsFileName('EXT:info/Resources/Private/Layouts')]);

        ‪$view->‪setPartialRootPaths([GeneralUtility::getFileAbsFileName('EXT:info/Resources/Private/Partials')]);

        ‪$view->‪setTemplateRootPaths([GeneralUtility::getFileAbsFileName('EXT:info/Resources/Private/Templates')]);


        ‪$view->‪setTemplatePathAndFilename(GeneralUtility::getFileAbsFileName('EXT:info/Resources/Private/Templates/Main.html'));


        ‪$view->‪getRequest()->setControllerExtensionName('info');

        return ‪$view;

    }


    protected function ‪menuConfig()

    {

        // Page / user TSconfig settings and blinding of menu-items

        $this->modTSconfig['properties'] = ‪BackendUtility::getPagesTSconfig($this->id)['mod.']['web_info.'] ?? [];

        $this->MOD_MENU['function'] = $this->‪mergeExternalItems('web_info', 'function', $this->MOD_MENU['function']);

        $blindActions = $this->modTSconfig['properties']['menu.']['function.'] ?? [];

        foreach ($blindActions as $key => $value) {

            if (!$value && array_key_exists($key, $this->MOD_MENU['function'])) {

                unset($this->MOD_MENU['function'][$key]);

            }

        }

        $this->MOD_SETTINGS = ‪BackendUtility::getModuleData($this->MOD_MENU, GeneralUtility::_GP('SET'), 'web_info', $this->modMenu_type, $this->modMenu_dontValidateList, $this->modMenu_setDefaultList);

    }


    protected function ‪mergeExternalItems($modName, $menuKey, $menuArr)

    {

        $mergeArray = ‪$GLOBALS['TBE_MODULES_EXT'][$modName]['MOD_MENU'][$menuKey];

        if (is_array($mergeArray)) {

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

            foreach ($mergeArray as $k => $v) {

                if (((string)$v['ws'] === '' || $backendUser->workspace === 0 && GeneralUtility::inList($v['ws'], 'online'))

                    || $backendUser->workspace === -1 && GeneralUtility::inList($v['ws'], 'offline')

                    || $backendUser->workspace > 0 && GeneralUtility::inList($v['ws'], 'custom')

                ) {

                    $menuArr[$k] = $this->‪getLanguageService()->‪sL($v['title']);

                }

            }

        }

        return $menuArr;

    }


    protected function ‪handleExternalFunctionValue($MM_key = 'function', $MS_value = null)

    {

        if ($MS_value === null) {

            $MS_value = $this->MOD_SETTINGS[$MM_key];

        }

        $this->extClassConf = $this->‪getExternalItemConfig('web_info', $MM_key, $MS_value);

    }


    protected function ‪getExternalItemConfig($modName, $menuKey, $value = '')

    {

        if (isset(‪$GLOBALS['TBE_MODULES_EXT'][$modName])) {

            return (string)$value !== ''

                ? ‪$GLOBALS['TBE_MODULES_EXT'][$modName]['MOD_MENU'][$menuKey][$value]

                : ‪$GLOBALS['TBE_MODULES_EXT'][$modName]['MOD_MENU'][$menuKey];

        }

        return null;

    }


    protected function ‪checkExtObj()

    {

        if (is_array($this->extClassConf) && $this->extClassConf['name']) {

            $this->extObj = GeneralUtility::makeInstance($this->extClassConf['name']);

            if (is_callable([$this->extObj, 'init'])) {

                $this->extObj->init($this);

            }

            // Re-write:

            $this->MOD_SETTINGS = ‪BackendUtility::getModuleData($this->MOD_MENU, GeneralUtility::_GP('SET'), 'web_info', $this->modMenu_type, $this->modMenu_dontValidateList, $this->modMenu_setDefaultList);

        }

    }


    protected function ‪checkSubExtObj()

    {

        if (is_object($this->extObj) && is_callable([$this->extObj, 'checkExtObj'])) {

            $this->extObj->checkExtObj();

        }

    }


    protected function ‪extObjHeader()

    {

        if (is_callable([$this->extObj, 'head'])) {

            $this->extObj->head();

        }

    }


    protected function ‪extObjContent()

    {

        if ($this->extObj === null) {

            $languageService = $this->‪getLanguageService();

            $flashMessage = GeneralUtility::makeInstance(

                FlashMessage::class,

                $languageService->sL('LLL:EXT:backend/Resources/Private/Language/locallang.xlf:no_modules_registered'),

                $languageService->getLL('title'),

                ‪FlashMessage::ERROR

            );

            $flashMessageService = GeneralUtility::makeInstance(FlashMessageService::class);

            $defaultFlashMessageQueue = $flashMessageService->getMessageQueueByIdentifier();

            $defaultFlashMessageQueue->enqueue($flashMessage);

        } else {

            if (is_callable([$this->extObj, 'main'])) {

                $main = $this->extObj->main();

                if ($main instanceof ResponseInterface) {

                    $stream = $main->getBody();

                    $stream->rewind();

                    $main = $stream->getContents();

                }

                $this->content .= $main;

            }

        }

    }


    protected function ‪getExtObjContent()

    {

        $savedContent = ‪$this->content;

        $this->content = '';

        $this->‪extObjContent();

        $newContent = ‪$this->content;

        $this->content = $savedContent;

        return $newContent;

    }


    protected function ‪getLanguageService(): ‪LanguageService

    {

        return ‪$GLOBALS['LANG'];

    }


    protected function ‪getBackendUser(): BackendUserAuthentication

    {

        return ‪$GLOBALS['BE_USER'];

    }

}