ModuleMenuView.php

Go to the documentation of this file.

<?php
namespace TYPO3\CMS\Backend\View;

/*
 * 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\Backend\Utility\BackendUtility;
use TYPO3\CMS\Core\Utility\GeneralUtility;

class ModuleMenuView
{
    protected $moduleLoader;

    protected $backPath;

    protected $linkModules;

    protected $loadedModules;

    public function __construct()
    {
        GeneralUtility::logDeprecatedFunction();
        if (TYPO3_REQUESTTYPE & TYPO3_REQUESTTYPE_AJAX) {
            $GLOBALS['LANG']->includeLLFile('EXT:lang/locallang_misc.xlf');
        }
        $this->backPath = '';
        $this->linkModules = true;
        // Loads the backend modules available for the logged in user.
        $this->moduleLoader = GeneralUtility::makeInstance(\TYPO3\CMS\Backend\Module\ModuleLoader::class);
        $this->moduleLoader->observeWorkspaces = true;
        $this->moduleLoader->load($GLOBALS['TBE_MODULES']);
        $this->loadedModules = $this->moduleLoader->modules;
    }

    public function setBackPath($backPath)
    {
        if (!is_string($backPath)) {
            throw new \InvalidArgumentException('parameter $backPath must be of type string', 1193315266);
        }
        $this->backPath = $backPath;
    }

    protected function getCollapsedStates()
    {
        $collapsedStates = [];
        if ($GLOBALS['BE_USER']->uc['moduleData']['moduleMenu']) {
            $collapsedStates = $GLOBALS['BE_USER']->uc['moduleData']['moduleMenu'];
        }
        return $collapsedStates;
    }

    public function getModuleData($params, $ajaxObj)
    {
        $data = ['success' => true, 'root' => []];
        $rawModuleData = $this->getRawModuleData();
        $index = 0;
        $dummyLink = BackendUtility::getModuleUrl('dummy');
        foreach ($rawModuleData as $moduleKey => $moduleData) {
            $key = substr($moduleKey, 8);
            $num = count($data['root']);
            if ($moduleData['link'] != $dummyLink || $moduleData['link'] == $dummyLink && is_array($moduleData['subitems'])) {
                $data['root'][$num]['key'] = $key;
                $data['root'][$num]['menuState'] = $GLOBALS['BE_USER']->uc['moduleData']['menuState'][$moduleKey];
                $data['root'][$num]['label'] = $moduleData['title'];
                $data['root'][$num]['subitems'] = is_array($moduleData['subitems']) ? count($moduleData['subitems']) : 0;
                if ($moduleData['link'] && $this->linkModules) {
                    $data['root'][$num]['link'] = 'top.goToModule(' . GeneralUtility::quoteJSvalue($moduleData['name']) . ')';
                }
                // Traverse submodules
                if (is_array($moduleData['subitems'])) {
                    foreach ($moduleData['subitems'] as $subKey => $subData) {
                        $data['root'][$num]['sub'][] = [
                            'name' => $subData['name'],
                            'description' => $subData['description'],
                            'label' => $subData['title'],
                            'icon' => $subData['icon']['filename'],
                            'navframe' => $subData['parentNavigationFrameScript'],
                            'link' => $subData['link'],
                            'originalLink' => $subData['originalLink'],
                            'index' => $index++,
                            'navigationFrameScript' => $subData['navigationFrameScript'],
                            'navigationFrameScriptParam' => $subData['navigationFrameScriptParam'],
                            'navigationComponentId' => $subData['navigationComponentId']
                        ];
                    }
                }
            }
        }
        if ($ajaxObj) {
            $ajaxObj->setContent($data);
            $ajaxObj->setContentFormat('jsonbody');
        } else {
            return $data;
        }
    }

    public function getLoadedModules()
    {
        return $this->loadedModules;
    }

    public function saveMenuState($params, $ajaxObj)
    {
        $menuItem = GeneralUtility::_POST('menuid');
        $state = GeneralUtility::_POST('state') === 'true' ? 1 : 0;
        $GLOBALS['BE_USER']->uc['moduleData']['menuState'][$menuItem] = $state;
        $GLOBALS['BE_USER']->writeUC();
    }

    protected function unsetHiddenModules()
    {
        // Hide modules if set in userTS.
        $hiddenModules = $GLOBALS['BE_USER']->getTSConfig('options.hideModules');
        if (!empty($hiddenModules['value'])) {
            $hiddenMainModules = GeneralUtility::trimExplode(',', $hiddenModules['value'], true);
            foreach ($hiddenMainModules as $hiddenMainModule) {
                unset($this->loadedModules[$hiddenMainModule]);
            }
        }

        // Hide sub-modules if set in userTS.
        if (!empty($hiddenModules['properties']) && is_array($hiddenModules['properties'])) {
            foreach ($hiddenModules['properties'] as $mainModuleName => $subModules) {
                $hiddenSubModules = GeneralUtility::trimExplode(',', $subModules, true);
                foreach ($hiddenSubModules as $hiddenSubModule) {
                    unset($this->loadedModules[$mainModuleName]['sub'][$hiddenSubModule]);
                }
            }
        }
    }

    public function getRawModuleData()
    {
        $modules = [];

        // Unset modules that are meant to be hidden from the menu.
        $this->unsetHiddenModules();
        $dummyScript = BackendUtility::getModuleUrl('dummy');
        foreach ($this->loadedModules as $moduleName => $moduleData) {
            $moduleLink = '';
            if (!is_array($moduleData['sub'])) {
                $moduleLink = $moduleData['script'];
            }
            $moduleLink = GeneralUtility::resolveBackPath($moduleLink);
            $moduleKey = 'modmenu_' . $moduleName;
            $moduleIcon = $this->getModuleIcon($moduleKey);
            $modules[$moduleKey] = [
                'name' => $moduleName,
                'title' => $GLOBALS['LANG']->moduleLabels['tabs'][$moduleName . '_tab'],
                'onclick' => 'top.goToModule(' . GeneralUtility::quoteJSvalue($moduleName) . ');',
                'icon' => $moduleIcon,
                'link' => $moduleLink,
                'description' => $GLOBALS['LANG']->moduleLabels['labels'][$moduleKey . 'label']
            ];
            if (!is_array($moduleData['sub']) && $moduleData['script'] != $dummyScript) {
                // Work around for modules with own main entry, but being self the only submodule
                $modules[$moduleKey]['subitems'][$moduleKey] = [
                    'name' => $moduleName,
                    'title' => $GLOBALS['LANG']->moduleLabels['tabs'][$moduleName . '_tab'],
                    'onclick' => 'top.goToModule(' . GeneralUtility::quoteJSvalue($moduleName) . ');',
                    'icon' => $this->getModuleIcon($moduleName . '_tab'),
                    'link' => $moduleLink,
                    'originalLink' => $moduleLink,
                    'description' => $GLOBALS['LANG']->moduleLabels['labels'][$moduleKey . 'label'],
                    'navigationFrameScript' => null,
                    'navigationFrameScriptParam' => null,
                    'navigationComponentId' => null
                ];
            } elseif (is_array($moduleData['sub'])) {
                foreach ($moduleData['sub'] as $submoduleName => $submoduleData) {
                    if (isset($submoduleData['script'])) {
                        $submoduleLink = GeneralUtility::resolveBackPath($submoduleData['script']);
                    } else {
                        $submoduleLink = BackendUtility::getModuleUrl($submoduleData['name']);
                    }
                    $submoduleKey = $moduleName . '_' . $submoduleName . '_tab';
                    $submoduleIcon = $this->getModuleIcon($submoduleKey);
                    $submoduleDescription = $GLOBALS['LANG']->moduleLabels['labels'][$submoduleKey . 'label'];
                    $originalLink = $submoduleLink;
                    $navigationFrameScript = $submoduleData['navFrameScript'];
                    $modules[$moduleKey]['subitems'][$submoduleKey] = [
                        'name' => $moduleName . '_' . $submoduleName,
                        'title' => $GLOBALS['LANG']->moduleLabels['tabs'][$submoduleKey],
                        'onclick' => 'top.goToModule(' . GeneralUtility::quoteJSvalue($moduleName . '_' . $submoduleName) . ');',
                        'icon' => $submoduleIcon,
                        'link' => $submoduleLink,
                        'originalLink' => $originalLink,
                        'description' => $submoduleDescription,
                        'navigationFrameScript' => $navigationFrameScript,
                        'navigationFrameScriptParam' => $submoduleData['navFrameScriptParam'],
                        'navigationComponentId' => $submoduleData['navigationComponentId']
                    ];
                    // if the main module has a navframe script, inherit to the submodule,
                    // but only if it is not disabled explicitly (option is set to FALSE)
                    if ($moduleData['navFrameScript'] && $submoduleData['inheritNavigationComponentFromMainModule'] !== false) {
                        $modules[$moduleKey]['subitems'][$submoduleKey]['parentNavigationFrameScript'] = $moduleData['navFrameScript'];
                    }
                }
            }
        }
        return $modules;
    }

    protected function getModuleIcon($moduleKey)
    {
        $icon = [
            'filename' => '',
            'size' => '',
            'title' => '',
            'html' => ''
        ];

        if (!empty($GLOBALS['LANG']->moduleLabels['tabs_images'][$moduleKey])) {
            $imageReference = $GLOBALS['LANG']->moduleLabels['tabs_images'][$moduleKey];
            $iconFileRelative = $this->getModuleIconRelative($imageReference);
            if (!empty($iconFileRelative)) {
                $iconTitle = $GLOBALS['LANG']->moduleLabels['tabs'][$moduleKey];
                $iconFileAbsolute = $this->getModuleIconAbsolute($imageReference);
                $iconSizes = @getimagesize($iconFileAbsolute);
                $icon['filename'] = $iconFileRelative;
                $icon['size'] = $iconSizes[3];
                $icon['title'] = htmlspecialchars($iconTitle);
                $icon['html'] = '<img src="' . $iconFileRelative . '" ' . $iconSizes[3] . ' title="' . htmlspecialchars($iconTitle) . '" alt="' . htmlspecialchars($iconTitle) . '" />';
            }
        }
        return $icon;
    }

    protected function getModuleIconAbsolute($iconFilename)
    {
        if (!GeneralUtility::isAbsPath($iconFilename)) {
            $iconFilename = $this->backPath . $iconFilename;
        }
        return $iconFilename;
    }

    protected function getModuleIconRelative($iconFilename)
    {
        if (GeneralUtility::isAbsPath($iconFilename)) {
            $iconFilename = '../' . \TYPO3\CMS\Core\Utility\PathUtility::stripPathSitePrefix($iconFilename);
        }
        return $this->backPath . $iconFilename;
    }

    protected function appendQuestionmarkToLink($link)
    {
        if (!strstr($link, '?')) {
            $link .= '?';
        }
        return $link;
    }

    public function renderLogoutButton()
    {
        $buttonLabel = $GLOBALS['BE_USER']->user['ses_backuserid'] ? 'LLL:EXT:lang/locallang_core.xlf:buttons.exit' : 'LLL:EXT:lang/locallang_core.xlf:buttons.logout';
        $buttonForm = '
        <form action="' . htmlspecialchars(BackendUtility::getModuleUrl('logout')) . '" target="_top">
            <input class="btn btn-default" type="submit" id="logout-submit-button" value="' . $GLOBALS['LANG']->sL($buttonLabel, true) . '" />
        </form>';
        return $buttonForm;
    }

    public function setLinkModules($linkModules)
    {
        if (!is_bool($linkModules)) {
            throw new \InvalidArgumentException('parameter $linkModules must be of type bool', 1193326558);
        }
        $this->linkModules = $linkModules;
    }
}