ConditionMatcher.php

Go to the documentation of this file.

<?php
namespace ‪TYPO3\CMS\Backend\Configuration\TypoScript\ConditionMatching;
 
/*
 * 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\Controller\EditDocumentController;
use ‪TYPO3\CMS\Backend\Utility\BackendUtility;
use ‪TYPO3\CMS\Core\Configuration\TypoScript\ConditionMatching\AbstractConditionMatcher;
use ‪TYPO3\CMS\Core\Context\Context;
use ‪TYPO3\CMS\Core\Utility\GeneralUtility;
 
class ‪ConditionMatcher extends ‪AbstractConditionMatcher
{
    protected ‪$context;
 
    public function ‪__construct(‪Context ‪$context = null)
    {
        $this->context = ‪$context ?? GeneralUtility::makeInstance(Context::class);
        $this->rootline = $this->‪determineRootline() ?? [];
        $this->‪initializeExpressionLanguageResolver();
    }
 
    protected function ‪updateExpressionLanguageVariables(): void
    {
        $treeLevel = $this->rootline ? count($this->rootline) - 1 : 0;
        if ($this->‪isNewPageWithPageId($this->pageId)) {
            $treeLevel++;
        }
        $tree = new \stdClass();
        $tree->level = $treeLevel;
        $tree->rootLine = ‪$this->rootline;
        $tree->rootLineIds = array_column($this->rootline, 'uid');
 
        $backendUserAspect = $this->context->getAspect('backend.user');
        $backend = new \stdClass();
        $backend->user = new \stdClass();
        $backend->user->isAdmin = $backendUserAspect->get('isAdmin');
        $backend->user->isLoggedIn = $backendUserAspect->get('isLoggedIn');
        $backend->user->userId = $backendUserAspect->get('id');
        $backend->user->userGroupList = implode(',', $backendUserAspect->get('groupIds'));
 
        $this->expressionLanguageResolverVariables = [
            'tree' => $tree,
            'backend' => $backend,
            'page' => ‪BackendUtility::getRecord('pages', $this->pageId ?? $this->‪determinePageId()) ?: [],
        ];
    }
 
    protected function ‪evaluateCondition($string)
    {
        if ($this->‪strictSyntaxEnabled()) {
            trigger_error('The old condition syntax will be removed in TYPO3 v10.0, use the new expression language. Used condition: [' . $string . '].', E_USER_DEPRECATED);
        }
 
        list($key, $value) = GeneralUtility::trimExplode('=', $string, false, 2);
        $result = $this->‪evaluateConditionCommon($key, $value);
        if (is_bool($result)) {
            return $result;
        }
 
        switch ($key) {
                case 'usergroup':
                    $groupList = $this->‪getGroupList();
                    $values = GeneralUtility::trimExplode(',', $value, true);
                    foreach ($values as $test) {
                        if ($test === '*' || GeneralUtility::inList($groupList, $test)) {
                            return true;
                        }
                    }
                    break;
                case 'adminUser':
                    if ($this->‪isUserLoggedIn()) {
                        return !((bool)$value xor $this->‪isAdminUser());
                    }
                    break;
                case 'treeLevel':
                    $values = GeneralUtility::trimExplode(',', $value, true);
                    $treeLevel = count($this->rootline) - 1;
                    // If a new page is being edited or saved the treeLevel is higher by one:
                    if ($this->‪isNewPageWithPageId($this->pageId)) {
                        $treeLevel++;
                    }
                    foreach ($values as $test) {
                        if ($test == $treeLevel) {
                            return true;
                        }
                    }
                    break;
                case 'PIDupinRootline':
                case 'PIDinRootline':
                    $values = GeneralUtility::trimExplode(',', $value, true);
                    if ($key === 'PIDinRootline' || !in_array($this->pageId, $values) || $this->‪isNewPageWithPageId($this->pageId)) {
                        foreach ($values as $test) {
                            foreach ($this->rootline as $rl_dat) {
                                if ($rl_dat['uid'] == $test) {
                                    return true;
                                }
                            }
                        }
                    }
                    break;
                default:
                    $conditionResult = $this->‪evaluateCustomDefinedCondition($string);
                    if ($conditionResult !== null) {
                        return $conditionResult;
                    }
            }
 
        return false;
    }
 
    protected function ‪getVariable($var)
    {
        $vars = explode(':', $var, 2);
        return $this->‪getVariableCommon($vars);
    }
 
    protected function ‪getGroupList()
    {
        return $this->‪getBackendUserAuthentication()->groupList;
    }
 
    protected function ‪determinePageId()
    {
        ‪$pageId = 0;
        $editStatement = GeneralUtility::_GP('edit');
        $commandStatement = GeneralUtility::_GP('cmd');
        // Determine id from module that was called with an id:
        if ($id = (int)GeneralUtility::_GP('id')) {
            ‪$pageId = $id;
        } elseif (is_array($editStatement)) {
            $table = key($editStatement);
            $uidAndAction = current($editStatement);
            $uid = key($uidAndAction);
            $action = current($uidAndAction);
            if ($action === 'edit') {
                ‪$pageId = $this->‪getPageIdByRecord($table, $uid);
            } elseif ($action === 'new') {
                ‪$pageId = $this->‪getPageIdByRecord($table, $uid, true);
            }
        } elseif (is_array($commandStatement)) {
            $table = key($commandStatement);
            $uidActionAndTarget = current($commandStatement);
            $uid = key($uidActionAndTarget);
            $actionAndTarget = current($uidActionAndTarget);
            $action = key($actionAndTarget);
            $target = current($actionAndTarget);
            if ($action === 'delete') {
                ‪$pageId = $this->‪getPageIdByRecord($table, $uid);
            } elseif ($action === 'copy' || $action === 'move') {
                ‪$pageId = $this->‪getPageIdByRecord($table, $target, true);
            }
        }
        return ‪$pageId;
    }
 
    protected function ‪getPage()
    {
        ‪$pageId = $this->pageId ?? $this->‪determinePageId();
        return ‪BackendUtility::getRecord('pages', ‪$pageId) ?? [];
    }
 
    protected function ‪getPageIdByRecord($table, $id, $ignoreTable = false)
    {
        ‪$pageId = 0;
        $id = (int)$id;
        if ($table && $id) {
            if (($ignoreTable || $table === 'pages') && $id >= 0) {
                ‪$pageId = $id;
            } else {
                $record = ‪BackendUtility::getRecordWSOL($table, abs($id), '*', '', false);
                ‪$pageId = $record['pid'];
            }
        }
        return ‪$pageId;
    }
 
    protected function ‪isNewPageWithPageId(‪$pageId)
    {
        if (isset(‪$GLOBALS['SOBE']) && ‪$GLOBALS['SOBE'] instanceof EditDocumentController) {
            ‪$pageId = (int)‪$pageId;
            $elementsData = ‪$GLOBALS['SOBE']->elementsData;
            $data = ‪$GLOBALS['SOBE']->data;
            // If saving a new page record:
            if (is_array($data) && isset($data['pages']) && is_array($data['pages'])) {
                foreach ($data['pages'] as $uid => ‪$fields) {
                    if (strpos($uid, 'NEW') === 0 && ‪$fields['pid'] == ‪$pageId) {
                        return true;
                    }
                }
            }
            // If editing a new page record (not saved yet):
            if (is_array($elementsData)) {
                foreach ($elementsData as $element) {
                    if ($element['cmd'] === 'new' && $element['table'] === 'pages') {
                        if ($element['pid'] < 0) {
                            $pageRecord = ‪BackendUtility::getRecord('pages', abs($element['pid']), 'pid');
                            $element['pid'] = $pageRecord['pid'];
                        }
                        if ($element['pid'] == ‪$pageId) {
                            return true;
                        }
                    }
                }
            }
        }
        return false;
    }
 
    protected function ‪determineRootline()
    {
        ‪$pageId = $this->pageId ?? $this->‪determinePageId();
        return ‪BackendUtility::BEgetRootLine(‪$pageId, '', true);
    }
 
    protected function ‪getUserId()
    {
        return $this->‪getBackendUserAuthentication()->user['uid'];
    }
 
    protected function ‪isUserLoggedIn()
    {
        return (bool)$this->‪getBackendUserAuthentication()->user['uid'];
    }
 
    protected function ‪isAdminUser()
    {
        return $this->‪getBackendUserAuthentication()->‪isAdmin();
    }
 
    protected function ‪getBackendUserAuthentication()
    {
        return ‪$GLOBALS['BE_USER'] ?? null;
    }
}