ConditionMatcherTest.php

Go to the documentation of this file.

<?php
 
declare(strict_types=1);
 
/*
 * 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!
 */
 
namespace ‪TYPO3\CMS\Frontend\Tests\Functional\Configuration\TypoScript\ConditionMatching;
 
use Prophecy\Argument;
use Psr\Log\NullLogger;
use ‪TYPO3\CMS\Core\Context\Context;
use ‪TYPO3\CMS\Core\Context\UserAspect;
use ‪TYPO3\CMS\Core\Context\WorkspaceAspect;
use ‪TYPO3\CMS\Core\Domain\Repository\PageRepository;
use ‪TYPO3\CMS\Core\Http\ServerRequest;
use ‪TYPO3\CMS\Core\Routing\PageArguments;
use ‪TYPO3\CMS\Core\Site\Entity\Site;
use ‪TYPO3\CMS\Core\TypoScript\TemplateService;
use ‪TYPO3\CMS\Core\Utility\GeneralUtility;
use ‪TYPO3\CMS\Core\Utility\StringUtility;
use ‪TYPO3\CMS\Frontend\Authentication\FrontendUserAuthentication;
use ‪TYPO3\CMS\Frontend\Configuration\TypoScript\ConditionMatching\ConditionMatcher;
use ‪TYPO3\CMS\Frontend\Controller\TypoScriptFrontendController;
use TYPO3\TestingFramework\Core\Functional\FunctionalTestCase;
 
class ‪ConditionMatcherTest extends FunctionalTestCase
{
    protected function ‪setUp(): void
    {
        parent::setUp();
 
        ‪$GLOBALS['TYPO3_REQUEST'] = new ‪ServerRequest();
 
        $this->importDataSet('PACKAGE:typo3/testing-framework/Resources/Core/Functional/Fixtures/pages.xml');
        $this->‪setupFrontendController(3);
    }
 
    public function ‪usergroupConditionMatchesSingleGroupId(): void
    {
        $this->‪setupFrontendUserContext([13]);
        $subject = $this->‪getConditionMatcher();
        self::assertTrue($subject->match('[usergroup(13)]'));
        self::assertTrue($subject->match('[usergroup("13")]'));
        self::assertTrue($subject->match('[usergroup(\'13\')]'));
    }
 
    public function ‪usergroupConditionMatchesMultipleUserGroupId(): void
    {
        $this->‪setupFrontendUserContext([13, 14, 15]);
        $subject = $this->‪getConditionMatcher();
        self::assertFalse($subject->match('[usergroup(999,15,14,13)]'));
        self::assertTrue($subject->match('[usergroup("999,15,14,13")]'));
        self::assertTrue($subject->match('[usergroup(\'999,15,14,13\')]'));
    }
 
    public function ‪usergroupConditionDoesNotMatchDefaultUserGroupIds(): void
    {
        $this->‪setupFrontendUserContext([0, -1]);
        $subject = $this->‪getConditionMatcher();
        self::assertFalse($subject->match('[usergroup("0,-1")]'));
        self::assertFalse($subject->match('[usergroup(\'0,-1\')]'));
    }
 
    public function ‪loginUserConditionMatchesAnyLoggedInUser(): void
    {
        $this->‪setupFrontendUserContext([13]);
        $subject = $this->‪getConditionMatcher();
        self::assertTrue($subject->match('[loginUser("*")]'));
        self::assertTrue($subject->match('[loginUser(\'*\')]'));
    }
 
    public function ‪loginUserConditionMatchesSingleLoggedInUser(): void
    {
        $this->‪setupFrontendUserContext([13, 14, 15]);
        $subject = $this->‪getConditionMatcher();
        self::assertTrue($subject->match('[loginUser(13)]'));
        self::assertTrue($subject->match('[loginUser("13")]'));
        self::assertTrue($subject->match('[loginUser(\'13\')]'));
    }
 
    public function ‪loginUserConditionMatchesMultipleLoggedInUsers(): void
    {
        $this->‪setupFrontendUserContext([13, 14, 15]);
        $subject = $this->‪getConditionMatcher();
        self::assertTrue($subject->match('[loginUser("999,13")]'));
        self::assertTrue($subject->match('[loginUser(\'999,13\')]'));
    }
 
    public function ‪loginUserConditionDoesNotMatchIfNotUserIsLoggedId(): void
    {
        $this->‪setupFrontendUserContext();
        $subject = $this->‪getConditionMatcher();
        self::assertFalse($subject->match('[loginUser("*")]'));
        self::assertTrue($subject->match('[loginUser("*") == false]'));
        self::assertFalse($subject->match('[loginUser("13")]'));
        self::assertFalse($subject->match('[loginUser(\'*\')]'));
        self::assertFalse($subject->match('[loginUser(\'13\')]'));
    }
 
    public function ‪loginUserConditionMatchIfUserIsNotLoggedIn(): void
    {
        $this->‪setupFrontendUserContext();
        $subject = $this->‪getConditionMatcher();
        self::assertTrue($subject->match('[loginUser(\'*\') == false]'));
        self::assertTrue($subject->match('[loginUser("*") == false]'));
    }
 
    public function ‪workspaceIdConditionMatchesCurrentWorkspaceId(): void
    {
        $this->‪setUpWorkspaceAspect(0);
        $subject = $this->‪getConditionMatcher();
        self::assertTrue($subject->match('[workspace.workspaceId === 0]'));
        self::assertTrue($subject->match('[workspace.workspaceId == 0]'));
        self::assertTrue($subject->match('[workspace.workspaceId == "0"]'));
        self::assertTrue($subject->match('[workspace.workspaceId == \'0\']'));
    }
 
    public function ‪workspaceIsLiveMatchesCorrectWorkspaceState(): void
    {
        $this->‪setUpWorkspaceAspect(1);
        $subject = $this->‪getConditionMatcher();
        self::assertFalse($subject->match('[workspace.isLive]'));
        self::assertFalse($subject->match('[workspace.isLive === true]'));
        self::assertFalse($subject->match('[workspace.isLive == true]'));
        self::assertFalse($subject->match('[workspace.isLive !== false]'));
        self::assertFalse($subject->match('[workspace.isLive != false]'));
    }
 
    public function ‪workspaceIsOfflineMatchesCorrectWorkspaceState(): void
    {
        $this->‪setUpWorkspaceAspect(1);
        $subject = $this->‪getConditionMatcher();
        self::assertTrue($subject->match('[workspace.isOffline]'));
        self::assertTrue($subject->match('[workspace.isOffline === true]'));
        self::assertTrue($subject->match('[workspace.isOffline == true]'));
        self::assertTrue($subject->match('[workspace.isOffline !== false]'));
        self::assertTrue($subject->match('[workspace.isOffline != false]'));
    }
 
    public function ‪treeLevelConditionMatchesSingleValue(): void
    {
        self::assertTrue($this->‪getConditionMatcher()->match('[tree.level == 2]'));
    }
 
    public function ‪treeLevelConditionMatchesMultipleValues(): void
    {
        self::assertTrue($this->‪getConditionMatcher()->match('[tree.level in [999,998,2]]'));
    }
 
    public function ‪treeLevelConditionDoesNotMatchFaultyValue(): void
    {
        self::assertFalse($this->‪getConditionMatcher()->match('[tree.level == 999]'));
    }
 
    public function ‪PIDupinRootlineConditionMatchesSinglePageIdInRootline(): void
    {
        $subject = $this->‪getConditionMatcher();
        self::assertTrue($subject->match('[2 in tree.rootLineParentIds]'));
        self::assertTrue($subject->match('["2" in tree.rootLineParentIds]'));
        self::assertTrue($subject->match('[\'2\' in tree.rootLineParentIds]'));
    }
 
    public function ‪PIDupinRootlineConditionDoesNotMatchLastPageIdInRootline(): void
    {
        self::assertFalse($this->‪getConditionMatcher()->match('[3 in tree.rootLineParentIds]'));
    }
 
    public function ‪PIDupinRootlineConditionDoesNotMatchPageIdNotInRootline(): void
    {
        self::assertFalse($this->‪getConditionMatcher()->match('[999 in tree.rootLineParentIds]'));
    }
 
    public function ‪PIDinRootlineConditionMatchesSinglePageIdInRootline(): void
    {
        $this->‪setupFrontendController(3);
    }
 
    public function ‪PIDinRootlineConditionMatchesLastPageIdInRootline(): void
    {
        self::assertTrue($this->‪getConditionMatcher()->match('[3 in tree.rootLineIds]'));
    }
 
    public function ‪PIDinRootlineConditionDoesNotMatchPageIdNotInRootline(): void
    {
        self::assertFalse($this->‪getConditionMatcher()->match('[999 in tree.rootLineIds]'));
    }
 
    public function ‪compatVersionConditionMatchesOlderRelease(): void
    {
        $subject = $this->‪getConditionMatcher();
        self::assertTrue($subject->match('[compatVersion(7.0)]'));
        self::assertTrue($subject->match('[compatVersion("7.0")]'));
        self::assertTrue($subject->match('[compatVersion(\'7.0\')]'));
    }
 
    public function ‪compatVersionConditionMatchesSameRelease(): void
    {
        self::assertTrue($this->‪getConditionMatcher()->match('[compatVersion(' . TYPO3_branch . ')]'));
    }
 
    public function ‪compatVersionConditionDoesNotMatchNewerRelease(): void
    {
        $subject = $this->‪getConditionMatcher();
        self::assertFalse($subject->match('[compatVersion(15.0)]'));
        self::assertFalse($subject->match('[compatVersion("15.0")]'));
        self::assertFalse($subject->match('[compatVersion(\'15.0\')]'));
    }
 
    public function ‪genericGetVariablesSucceedsWithNamespaceTSFE(): void
    {
        ‪$GLOBALS['TSFE']->id = 1234567;
        ‪$GLOBALS['TSFE']->testSimpleObject = new \stdClass();
        ‪$GLOBALS['TSFE']->testSimpleObject->testSimpleVariable = 'testValue';
 
        $subject = $this->‪getConditionMatcher();
        self::assertTrue($subject->match('[getTSFE().id == 1234567]'));
        self::assertTrue($subject->match('[getTSFE().testSimpleObject.testSimpleVariable == "testValue"]'));
    }
 
    public function ‪genericGetVariablesSucceedsWithNamespaceSession(): void
    {
        $prophecy = $this->prophesize(FrontendUserAuthentication::class);
        $prophecy->getSessionData(Argument::exact('foo'))->willReturn(['bar' => 1234567]);
        ‪$GLOBALS['TSFE']->fe_user = $prophecy->reveal();
 
        self::assertTrue($this->‪getConditionMatcher()->match('[session("foo|bar") == 1234567]'));
    }
 
    public function ‪genericGetVariablesSucceedsWithNamespaceENV(): void
    {
        $testKey = ‪StringUtility::getUniqueId('test');
        putenv($testKey . '=testValue');
        self::assertTrue($this->‪getConditionMatcher()->match('[getenv("' . $testKey . '") == "testValue"]'));
    }
 
    public function ‪siteLanguageMatchesCondition(): void
    {
        $site = new ‪Site('angelo', 13, [
            'languages' => [
                [
                    'languageId' => 0,
                    'title' => 'United States',
                    'locale' => 'en_US.UTF-8',
                ],
                [
                    'languageId' => 2,
                    'title' => 'UK',
                    'locale' => 'en_UK.UTF-8',
                ]
            ]
        ]);
        ‪$GLOBALS['TYPO3_REQUEST'] = ‪$GLOBALS['TYPO3_REQUEST']->withAttribute('language', $site->getLanguageById(0));
        $subject = $this->‪getConditionMatcher();
        self::assertTrue($subject->match('[siteLanguage("locale") == "en_US.UTF-8"]'));
        self::assertTrue($subject->match('[siteLanguage("locale") in ["de_DE", "en_US.UTF-8"]]'));
    }
 
    public function ‪siteLanguageDoesNotMatchCondition(): void
    {
        $site = new ‪Site('angelo', 13, [
            'languages' => [
                [
                    'languageId' => 0,
                    'title' => 'United States',
                    'locale' => 'en_US.UTF-8',
                ],
                [
                    'languageId' => 2,
                    'title' => 'UK',
                    'locale' => 'en_UK.UTF-8',
                ]
            ]
        ]);
        ‪$GLOBALS['TYPO3_REQUEST'] = ‪$GLOBALS['TYPO3_REQUEST']->withAttribute('language', $site->getLanguageById(0));
        $subject = $this->‪getConditionMatcher();
        self::assertFalse($subject->match('[siteLanguage("locale") == "en_UK.UTF-8"]'));
        self::assertFalse($subject->match('[siteLanguage("locale") == "de_DE" && siteLanguage("title") == "UK"]'));
    }
 
    public function ‪siteMatchesCondition(): void
    {
        $site = new ‪Site('angelo', 13, ['languages' => [], 'base' => 'https://typo3.org/']);
        ‪$GLOBALS['TYPO3_REQUEST'] = ‪$GLOBALS['TYPO3_REQUEST']->withAttribute('site', $site);
        $subject = $this->‪getConditionMatcher();
        self::assertTrue($subject->match('[site("identifier") == "angelo"]'));
        self::assertTrue($subject->match('[site("rootPageId") == 13]'));
        self::assertTrue($subject->match('[site("base") == "https://typo3.org/"]'));
    }
 
    public function ‪siteDoesNotMatchCondition(): void
    {
        $site = new ‪Site('angelo', 13, [
            'languages' => [
                [
                    'languageId' => 0,
                    'title' => 'United States',
                    'locale' => 'en_US.UTF-8',
                ],
                [
                    'languageId' => 2,
                    'title' => 'UK',
                    'locale' => 'en_UK.UTF-8',
                ]
            ]
        ]);
        ‪$GLOBALS['TYPO3_REQUEST'] = ‪$GLOBALS['TYPO3_REQUEST']->withAttribute('site', $site);
        $subject = $this->‪getConditionMatcher();
        self::assertFalse($subject->match('[site("identifier") == "berta"]'));
        self::assertFalse($subject->match('[site("rootPageId") == 14 && site("rootPageId") == 23]'));
    }
 
    protected function ‪getConditionMatcher(): ‪ConditionMatcher
    {
        $conditionMatcher = new ‪ConditionMatcher();
        $conditionMatcher->setLogger(new NullLogger());
 
        return $conditionMatcher;
    }
 
    protected function ‪setupFrontendUserContext(array $groups = []): void
    {
        $frontendUser = new ‪FrontendUserAuthentication();
        $frontendUser->user['uid'] = empty($groups) ? 0 : 13;
        $frontendUser->groupData['uid'] = $groups;
 
        GeneralUtility::makeInstance(Context::class)->setAspect('frontend.user', new ‪UserAspect($frontendUser, $groups));
    }
 
    protected function ‪setUpWorkspaceAspect(int $workspaceId): void
    {
        GeneralUtility::makeInstance(Context::class)->setAspect('workspace', new ‪WorkspaceAspect($workspaceId));
    }
 
    protected function ‪setupFrontendController(int $pageId): void
    {
        $site = new ‪Site('angelo', 13, [
            'languages' => [
                [
                    'languageId' => 0,
                    'title' => 'United States',
                    'locale' => 'en_US.UTF-8',
                ],
                [
                    'languageId' => 2,
                    'title' => 'UK',
                    'locale' => 'en_UK.UTF-8',
                ]
            ]
        ]);
        ‪$GLOBALS['TSFE'] = GeneralUtility::makeInstance(
            TypoScriptFrontendController::class,
            GeneralUtility::makeInstance(Context::class),
            $site,
            $site->getLanguageById(0),
            new ‪PageArguments($pageId, '0', [])
        );
        ‪$GLOBALS['TSFE']->sys_page = GeneralUtility::makeInstance(PageRepository::class);
        ‪$GLOBALS['TSFE']->tmpl = GeneralUtility::makeInstance(TemplateService::class);
        ‪$GLOBALS['TSFE']->tmpl->rootLine = [
            0 => ['uid' => 1, 'pid' => 0],
            1 => ['uid' => 2, 'pid' => 1],
            2 => ['uid' => 3, 'pid' => 2],
        ];
    }
}