AbstractContextMenuDataProvider.php

Go to the documentation of this file.

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

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

abstract class AbstractContextMenuDataProvider
{
    protected $disableItems = [];

    protected $contextMenuType = '';

    public function getContextMenuType()
    {
        return $this->contextMenuType;
    }

    public function setContextMenuType($contextMenuType)
    {
        $this->contextMenuType = $contextMenuType;
    }

    abstract public function getActionsForNode(TreeNode $node);

    protected function getConfiguration()
    {
        $contextMenuActions = $this->getBackendUser()->getTSConfig('options.contextMenu.' . $this->contextMenuType . '.items');
        return $contextMenuActions['properties'];
    }

    protected function evaluateDisplayCondition(TreeNode $node, $displayCondition)
    {
        if ($displayCondition === '') {
            return true;
        }
        // Parse condition string
        $conditions = [];
        preg_match_all('/(.+?)(>=|<=|!=|=|>|<)(.+?)(\\|\\||&&|$)/is', $displayCondition, $conditions);
        $lastResult = false;
        $chainType = '';
        $amountOfConditions = count($conditions[0]);
        for ($i = 0; $i < $amountOfConditions; ++$i) {
            // Check method for existence
            $method = trim($conditions[1][$i]);
            list($method, $index) = explode('|', $method);
            if (!method_exists($node, $method)) {
                continue;
            }
            // Fetch compare value
            $returnValue = call_user_func([$node, $method]);
            if (is_array($returnValue)) {
                $returnValue = $returnValue[$index];
            }
            // Compare fetched and expected values
            $operator = trim($conditions[2][$i]);
            $expected = trim($conditions[3][$i]);
            if ($operator === '=') {
                $returnValue = $returnValue == $expected;
            } elseif ($operator === '>') {
                $returnValue = $returnValue > $expected;
            } elseif ($operator === '<') {
                $returnValue = $returnValue < $expected;
            } elseif ($operator === '>=') {
                $returnValue = $returnValue >= $expected;
            } elseif ($operator === '<=') {
                $returnValue = $returnValue <= $expected;
            } elseif ($operator === '!=') {
                $returnValue = $returnValue != $expected;
            } else {
                $returnValue = false;
                $lastResult = false;
            }
            // Chain last result and the current if requested
            if ($chainType === '||') {
                $lastResult = $lastResult || $returnValue;
            } elseif ($chainType === '&&') {
                $lastResult = $lastResult && $returnValue;
            } else {
                $lastResult = $returnValue;
            }
            // Save chain type for the next condition
            $chainType = trim($conditions[4][$i]);
        }
        return $lastResult;
    }

    protected function getNextContextMenuLevel(array $actions, TreeNode $node, $level = 0)
    {
        $actionCollection = GeneralUtility::makeInstance(ContextMenuActionCollection::class);
        $iconFactory = GeneralUtility::makeInstance(IconFactory::class);
        if ($level > 5) {
            return $actionCollection;
        }
        $type = '';
        foreach ($actions as $index => $actionConfiguration) {
            if (substr($index, -1) !== '.') {
                $type = $actionConfiguration;
                if ($type !== 'DIVIDER') {
                    continue;
                }
            }
            if (!in_array($type, ['DIVIDER', 'SUBMENU', 'ITEM'])) {
                continue;
            }
            $action = GeneralUtility::makeInstance(ContextMenuAction::class);
            $action->setId($index);
            if ($type === 'DIVIDER') {
                $action->setType('divider');
            } else {
                if (in_array($actionConfiguration['name'], $this->disableItems) || isset($actionConfiguration['displayCondition']) && trim($actionConfiguration['displayCondition']) !== '' && !$this->evaluateDisplayCondition($node, $actionConfiguration['displayCondition'])) {
                    unset($action);
                    continue;
                }
                $label = $this->getLanguageService()->sL($actionConfiguration['label'], true);
                if ($type === 'SUBMENU') {
                    $action->setType('submenu');
                    $action->setChildActions($this->getNextContextMenuLevel($actionConfiguration, $node, $level + 1));
                } else {
                    $action->setType('action');
                    $action->setCallbackAction($actionConfiguration['callbackAction']);
                    if (is_array($actionConfiguration['customAttributes.'])) {
                        if (!empty($actionConfiguration['customAttributes.']['contentUrl'])) {
                            $actionConfiguration['customAttributes.']['contentUrl'] = $this->replaceModuleTokenInContentUrl($actionConfiguration['customAttributes.']['contentUrl']);
                        }
                        $action->setCustomAttributes($actionConfiguration['customAttributes.']);
                    }
                }
                $action->setLabel($label);
                if (!isset($actionConfiguration['iconName'])) {
                    $actionConfiguration['iconName'] = 'miscellaneous-placeholder';
                }
                $action->setIcon($iconFactory->getIcon($actionConfiguration['iconName'], Icon::SIZE_SMALL)->render());
            }
            $actionCollection->offsetSet($level . (int)$index, $action);
            $actionCollection->ksort();
        }
        return $actionCollection;
    }

    protected function replaceModuleTokenInContentUrl($contentUrl)
    {
        $parsedUrl = parse_url($contentUrl);
        parse_str($parsedUrl['query'], $urlParameters);
        if (isset($urlParameters['M'])) {
            $moduleName = $urlParameters['M'];
            unset($urlParameters['M']);
            $contentUrl = BackendUtility::getModuleUrl($moduleName, $urlParameters);
        }
        return $contentUrl;
    }

    protected function getLanguageService()
    {
        return $GLOBALS['LANG'];
    }

    protected function getBackendUser()
    {
        return $GLOBALS['BE_USER'];
    }
}