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\Backend\Tests\Functional\Configuration\TypoScript\ConditionMatching;
 
use Prophecy\PhpUnit\ProphecyTrait;
use ‪TYPO3\CMS\Backend\Configuration\TypoScript\ConditionMatching\ConditionMatcher;
use ‪TYPO3\CMS\Core\Authentication\BackendUserAuthentication;
use ‪TYPO3\CMS\Core\Context\Context;
use ‪TYPO3\CMS\Core\Context\UserAspect;
use ‪TYPO3\CMS\Core\Context\WorkspaceAspect;
use ‪TYPO3\CMS\Core\Log\Logger;
use ‪TYPO3\CMS\Core\Utility\GeneralUtility;
use ‪TYPO3\CMS\Core\Utility\StringUtility;
use TYPO3\TestingFramework\Core\Functional\FunctionalTestCase;
 
class ‪ConditionMatcherTest extends FunctionalTestCase
{
    use ProphecyTrait;
 
    protected function ‪setUp(): void
    {
        parent::setUp();
 
        $this->importDataSet('PACKAGE:typo3/testing-framework/Resources/Core/Functional/Fixtures/pages.xml');
 
        $backendUser = new ‪BackendUserAuthentication();
        $backendUser->user['uid'] = 13;
        $backendUser->user['admin'] = true;
        $backendUser->userGroupsUID = [13, 14, 15];
        GeneralUtility::makeInstance(Context::class)->setAspect('backend.user', new ‪UserAspect($backendUser));
    }
 
    public function ‪usergroupConditionMatchesSingleGroupId(): void
    {
        $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
    {
        $subject = $this->‪getConditionMatcher();
        self::assertTrue($subject->match('[usergroup("999,15,14,13")]'));
        self::assertTrue($subject->match('[usergroup(\'999,15,14,13\')]'));
    }
 
    public function ‪userGroupInOperatorConditionMatchesGroupId(): void
    {
        $subject = $this->‪getConditionMatcher();
        self::assertTrue($subject->match('[14 in backend.user.userGroupIds]'));
    }
 
    public function ‪loginUserConditionMatchesAnyLoggedInUser(): void
    {
        $subject = $this->‪getConditionMatcher();
        self::assertTrue($subject->match('[loginUser("*")]'));
        self::assertTrue($subject->match('[loginUser(\'*\')]'));
    }
 
    public function ‪loginUserConditionMatchesSingleLoggedInUser(): void
    {
        $subject = $this->‪getConditionMatcher();
        self::assertTrue($subject->match('[loginUser(13)]'));
        self::assertTrue($subject->match('[loginUser("13")]'));
        self::assertTrue($subject->match('[loginUser(\'13\')]'));
    }
 
    public function ‪loginUserConditionDoesNotMatchSingleLoggedInUser(): void
    {
        $subject = $this->‪getConditionMatcher();
        self::assertFalse($subject->match('[loginUser(999)]'));
        self::assertFalse($subject->match('[loginUser("999")]'));
        self::assertFalse($subject->match('[loginUser(\'999\')]'));
    }
 
    public function ‪loginUserConditionMatchesMultipleLoggedInUsers(): void
    {
        $subject = $this->‪getConditionMatcher();
        self::assertTrue($subject->match('[loginUser("999,13")]'));
        self::assertTrue($subject->match('[loginUser(\'999,13\')]'));
    }
 
    public function ‪adminUserConditionMatchesAdminUser(): void
    {
        $subject = $this->‪getConditionMatcher();
        self::assertTrue($subject->match('[backend.user.isAdmin == true]'));
        self::assertTrue($subject->match('[backend.user.isAdmin != false]'));
        self::assertTrue($subject->match('[backend.user.isAdmin]'));
    }
 
    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
    {
        $subject = $this->‪getConditionMatcher(2);
        self::assertTrue($subject->match('[tree.level == 2]'));
    }
 
    public function ‪treeLevelConditionMatchesMultipleValues(): void
    {
        $subject = $this->‪getConditionMatcher(2);
        self::assertTrue($subject->match('[tree.level in [999,998,2]]'));
    }
 
    public function ‪treeLevelConditionDoesNotMatchFaultyValue(): void
    {
        $subject = $this->‪getConditionMatcher();
        self::assertFalse($subject->match('[tree.level == 999]'));
    }
 
    public function ‪PIDupinRootlineConditionMatchesSinglePageIdInRootline(): void
    {
        $subject = $this->‪getConditionMatcher(3);
        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
    {
        $subject = $this->‪getConditionMatcher(3);
        self::assertFalse($subject->match('[3 in tree.rootLineParentIds]'));
    }
 
    public function ‪PIDupinRootlineConditionDoesNotMatchPageIdNotInRootline(): void
    {
        $subject = $this->‪getConditionMatcher(3);
        self::assertFalse($subject->match('[999 in tree.rootLineParentIds]'));
    }
 
    public function ‪PIDinRootlineConditionMatchesSinglePageIdInRootline(): void
    {
        $subject = $this->‪getConditionMatcher(3);
        self::assertTrue($subject->match('[2 in tree.rootLineIds]'));
    }
 
    public function ‪PIDinRootlineConditionMatchesLastPageIdInRootline(): void
    {
        $subject = $this->‪getConditionMatcher(3);
        self::assertTrue($subject->match('[3 in tree.rootLineIds]'));
    }
 
    public function ‪PIDinRootlineConditionDoesNotMatchPageIdNotInRootline(): void
    {
        $subject = $this->‪getConditionMatcher(3);
        self::assertFalse($subject->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
    {
        $subject = $this->‪getConditionMatcher();
        self::assertTrue($subject->match('[compatVersion(' . TYPO3_branch . ')]'));
        self::assertTrue($subject->match('[compatVersion("' . TYPO3_branch . '")]'));
        self::assertTrue($subject->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 ‪genericGetVariablesSucceedsWithNamespaceENV(): void
    {
        $testKey = ‪StringUtility::getUniqueId('test');
        putenv($testKey . '=testValue');
        $subject = $this->‪getConditionMatcher();
        self::assertTrue($subject->match('[getenv("' . $testKey . '") == "testValue"]'));
    }
 
    public function ‪usingTSFEInATestInBeContextIsAlwaysFalse(): void
    {
        $subject = $this->‪getConditionMatcher();
        self::assertFalse($subject->match('[getTSFE().id == 1]'));
    }
 
    public function ‪determinePageIdFindIdFromQueryParametersDataProvider(): array
    {
        return [
            'Page ID from "id" parameter' => [
                ['id' => 6],
                6,
            ],
            'Page ID from "edit" parameter' => [
                [
                    'edit' => [
                        'pages' => [
                            6 => 'edit',
                        ],
                    ],
                ],
                6,
            ],
            'Page ID from "new" parameter' => [
                [
                    'edit' => [
                        'pages' => [
                            -6 => 'new',
                        ],
                    ],
                ],
                5,
            ],
            'Page ID from "copy" parameter' => [
                [
                    'cmd' => [
                        'pages' => [
                            5 => [
                                'copy' => 6,
                            ],
                        ],
                    ],
                ],
                6,
            ],
            'Page ID from "move" target parameter' => [
                [
                    'cmd' => [
                        'pages' => [
                            5 => [
                                'move' => [
                                    'target' => 6,
                                ],
                            ],
                        ],
                    ],
                ],
                6,
            ],
        ];
    }
 
    public function ‪determinePageIdFindIdFromQueryParameters($queryParameters, $resultPageId): void
    {
        $_GET = $queryParameters;
        $subject = GeneralUtility::makeInstance(ConditionMatcher::class);
        self::assertEquals($resultPageId, $subject->getPageId());
    }
 
    protected function ‪getConditionMatcher(int $pageId = null): ConditionMatcher
    {
        $conditionMatcher = new ConditionMatcher(null, $pageId);
        $conditionMatcher->setLogger($this->prophesize(Logger::class)->reveal());
 
        return $conditionMatcher;
    }
 
    protected function ‪setUpWorkspaceAspect(int $workspaceId): void
    {
        GeneralUtility::makeInstance(Context::class)->setAspect('workspace', new WorkspaceAspect($workspaceId));
    }
}