TypoScriptFrontendControllerTest.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\Unit\Controller;
 
use Prophecy\Argument;
use Psr\Container\ContainerInterface;
use ‪TYPO3\CMS\Core\Cache\Backend\NullBackend;
use ‪TYPO3\CMS\Core\Cache\CacheManager;
use ‪TYPO3\CMS\Core\Context\Context;
use ‪TYPO3\CMS\Core\Domain\Repository\PageRepository;
use ‪TYPO3\CMS\Core\EventDispatcher\EventDispatcher;
use ‪TYPO3\CMS\Core\EventDispatcher\ListenerProvider;
use ‪TYPO3\CMS\Core\Http\ServerRequest;
use ‪TYPO3\CMS\Core\Http\ServerRequestFactory;
use ‪TYPO3\CMS\Core\Localization\LanguageService;
use ‪TYPO3\CMS\Core\Localization\LanguageServiceFactory;
use ‪TYPO3\CMS\Core\Localization\LanguageStore;
use ‪TYPO3\CMS\Core\Localization\Locales;
use ‪TYPO3\CMS\Core\Localization\LocalizationFactory;
use ‪TYPO3\CMS\Core\Page\PageRenderer;
use ‪TYPO3\CMS\Core\PageTitle\PageTitleProviderManager;
use ‪TYPO3\CMS\Core\Routing\PageArguments;
use ‪TYPO3\CMS\Core\Site\Entity\Site;
use ‪TYPO3\CMS\Core\Utility\GeneralUtility;
use ‪TYPO3\CMS\Core\Utility\StringUtility;
use ‪TYPO3\CMS\Frontend\Controller\TypoScriptFrontendController;
use TYPO3\TestingFramework\Core\Unit\UnitTestCase;
 
class ‪TypoScriptFrontendControllerTest extends UnitTestCase
{
    protected ‪$resetSingletonInstances = true;
 
    protected ‪$subject;
 
    protected function ‪setUp(): void
    {
        parent::setUp();
        $this->subject = $this->getAccessibleMock(TypoScriptFrontendController::class, ['dummy'], [], '', false);
        $this->subject->_set('context', new ‪Context());
        ‪$GLOBALS['TYPO3_CONF_VARS']['SYS']['encryptionKey'] = '170928423746123078941623042360abceb12341234231';
 
        $pageRepository = $this->getMockBuilder(PageRepository::class)->getMock();
        $this->subject->sys_page = $pageRepository;
 
        $pageRenderer = $this->getMockBuilder(PageRenderer::class)->getMock();
        $this->subject->_set('pageRenderer', $pageRenderer);
    }
 
    public function ‪headerAndFooterMarkersAreReplacedDuringIntProcessing()
    {
        ‪$GLOBALS['TSFE'] = $this->‪setupTsfeMockForHeaderFooterReplacementCheck();
        ‪$GLOBALS['TSFE']->INTincScript();
        self::assertStringContainsString('headerData', ‪$GLOBALS['TSFE']->content);
        self::assertStringContainsString('footerData', ‪$GLOBALS['TSFE']->content);
    }
 
    public function ‪processNonCacheableContentPartsAndSubstituteContentMarkers()
    {
        ‪$GLOBALS['TSFE']->additionalHeaderData[] = 'headerData';
        ‪$GLOBALS['TSFE']->additionalFooterData[] = 'footerData';
    }
 
    protected function ‪setupTsfeMockForHeaderFooterReplacementCheck()
    {
        $tsfe = $this->getMockBuilder(TypoScriptFrontendController::class)
            ->setMethods([
                'processNonCacheableContentPartsAndSubstituteContentMarkers',
                'INTincScript_loadJSCode',
                'setAbsRefPrefix',
                'regeneratePageTitle'
            ])->disableOriginalConstructor()
            ->getMock();
        $tsfe->expects(self::exactly(2))->method('processNonCacheableContentPartsAndSubstituteContentMarkers')->willReturnCallback([$this, 'processNonCacheableContentPartsAndSubstituteContentMarkers']);
 
        GeneralUtility::setSingletonInstance(
            EventDispatcher::class,
            new EventDispatcher(
                new ListenerProvider($this->createMock(ContainerInterface::class))
            )
        );
 
        $tsfe->content = file_get_contents(__DIR__ . '/Fixtures/renderedPage.html');
        $config = [
            'INTincScript_ext' => [
                'divKey' => '679b52796e75d474ccbbed486b6837ab',
            ],
            'INTincScript' => [
                'INT_SCRIPT.679b52796e75d474ccbbed486b6837ab' => [],
            ]
        ];
        $tsfe->config = $config;
 
        return $tsfe;
    }
 
    public function ‪localizationReturnsUnchangedStringIfNotLocallangLabel()
    {
        $nullCacheBackend = new NullBackend('');
        $cacheManager = $this->prophesize(CacheManager::class);
        $cacheManager->getCache('l10n')->willReturn($nullCacheBackend);
        $languageService = new LanguageService(new Locales(), new LocalizationFactory(new LanguageStore(), $cacheManager->reveal()));
        $languageServiceFactoryProphecy = $this->prophesize(LanguageServiceFactory::class);
        $languageServiceFactoryProphecy->create(Argument::any())->will(function (‪$args) use ($languageService) {
            $languageService->init(‪$args[0]);
            return $languageService;
        });
        GeneralUtility::addInstance(LanguageServiceFactory::class, $languageServiceFactoryProphecy->reveal());
        $string = ‪StringUtility::getUniqueId();
        $site = $this->‪createSiteWithDefaultLanguage([
            'locale' => 'fr',
            'typo3Language' => 'fr',
        ]);
        $this->subject->page = [];
        $this->subject->_set('language', $site->getLanguageById(0));
        $this->subject->_call('setOutputLanguage');
        self::assertEquals($string, $this->subject->sL($string));
    }
 
    public function ‪getSysDomainCacheDataProvider()
    {
        return [
            'typo3.org' => [
                'typo3.org',
            ],
            'foo.bar' => [
                'foo.bar',
            ],
            'example.com' => [
                'example.com',
            ],
        ];
    }
 
    public function ‪baseUrlWrapHandlesDifferentUrlsDataProvider()
    {
        return [
            'without base url' => [
                '',
                'fileadmin/user_uploads/image.jpg',
                'fileadmin/user_uploads/image.jpg'
            ],
            'with base url' => [
                'http://www.google.com/',
                'fileadmin/user_uploads/image.jpg',
                'http://www.google.com/fileadmin/user_uploads/image.jpg'
            ],
            'without base url but with url prepended with a forward slash' => [
                '',
                '/fileadmin/user_uploads/image.jpg',
                '/fileadmin/user_uploads/image.jpg',
            ],
            'with base url but with url prepended with a forward slash' => [
                'http://www.google.com/',
                '/fileadmin/user_uploads/image.jpg',
                '/fileadmin/user_uploads/image.jpg',
            ],
        ];
    }
 
    public function ‪baseUrlWrapHandlesDifferentUrls($baseUrl, $url, $expected)
    {
        $this->subject->baseUrl = $baseUrl;
        self::assertSame($expected, $this->subject->baseUrlWrap($url));
    }
 
    public function ‪initializeSearchWordDataBuildsCorrectRegexDataProvider()
    {
        return [
            'one simple search word' => [
                ['test'],
                false,
                'test',
            ],
            'one simple search word with standalone words' => [
                ['test'],
                true,
                '[[:space:]]test[[:space:]]',
            ],
            'two simple search words' => [
                ['test', 'test2'],
                false,
                'test|test2',
            ],
            'two simple search words with standalone words' => [
                ['test', 'test2'],
                true,
                '[[:space:]]test[[:space:]]|[[:space:]]test2[[:space:]]',
            ],
            'word with regex chars' => [
                ['A \\ word with / a bunch of [] regex () chars .*'],
                false,
                'A \\\\ word with \\/ a bunch of \\[\\] regex \\(\\) chars \\.\\*',
            ],
        ];
    }
 
    public function ‪initializeSearchWordDataBuildsCorrectRegex(array $searchWordGetParameters, $enableStandaloneSearchWords, $expectedRegex)
    {
        $_GET['sword_list'] = $searchWordGetParameters;
        $_SERVER['HTTP_HOST'] = 'localhost';
        $_SERVER['SCRIPT_NAME'] = '/index.php';
 
        $this->subject->page = [];
        if ($enableStandaloneSearchWords) {
            $this->subject->config = ['config' => ['sword_standAlone' => 1]];
        }
 
        $request = ‪ServerRequestFactory::fromGlobals();
        $this->subject->preparePageContentGeneration($request);
        self::assertEquals($this->subject->sWordRegEx, $expectedRegex);
    }
 
    public function ‪splitLinkVarsStringSplitsStringByComma($string, $expected)
    {
        self::assertEquals($expected, $this->subject->_call('splitLinkVarsString', $string));
    }
 
    public function ‪splitLinkVarsDataProvider()
    {
        return [
            [
                'L',
                ['L']
            ],
            [
                'L,a',
                [
                    'L',
                    'a'
                ]
            ],
            [
                'L, a',
                [
                    'L',
                    'a'
                ]
            ],
            [
                'L , a',
                [
                    'L',
                    'a'
                ]
            ],
            [
                ' L, a ',
                [
                    'L',
                    'a'
                ]
            ],
            [
                'L(1)',
                [
                    'L(1)'
                ]
            ],
            [
                'L(1),a',
                [
                    'L(1)',
                    'a'
                ]
            ],
            [
                'L(1) ,  a',
                [
                    'L(1)',
                    'a'
                ]
            ],
            [
                'a,L(1)',
                [
                    'a',
                    'L(1)'
                ]
            ],
            [
                'L(1),a(2-3)',
                [
                    'L(1)',
                    'a(2-3)'
                ]
            ],
            [
                'L(1),a((2-3))',
                [
                    'L(1)',
                    'a((2-3))'
                ]
            ],
            [
                'L(1),a(a{2,4})',
                [
                    'L(1)',
                    'a(a{2,4})'
                ]
            ],
            [
                'L(1),a(/a{2,4}\,()/)',
                [
                    'L(1)',
                    'a(/a{2,4}\,()/)'
                ]
            ],
            [
                'L,a , b(c) , dd(/g{1,2}/), eee(, ()f) , 2',
                [
                    'L',
                    'a',
                    'b(c)',
                    'dd(/g{1,2}/)',
                    'eee(, ()f)',
                    '2'
                ]
            ]
        ];
    }
 
    public function ‪calculateLinkVarsConsidersCorrectVariables(string $linkVars, array $getVars, string $expected)
    {
        $this->subject->config['config']['linkVars'] = $linkVars;
        $this->subject->calculateLinkVars($getVars);
        self::assertEquals($expected, $this->subject->linkVars);
    }
 
    public function ‪calculateLinkVarsDataProvider(): array
    {
        return [
            'simple variable' => [
                'L',
                [
                    'L' => 1
                ],
                '&L=1'
            ],
            'missing variable' => [
                'L',
                [
                ],
                ''
            ],
            'restricted variables' => [
                'L(1-3),bar(3),foo(array),blub(array)',
                [
                    'L' => 1,
                    'bar' => 2,
                    'foo' => [ 1, 2, 'f' => [ 4, 5 ] ],
                    'blub' => 123
                ],
                '&L=1&foo%5B0%5D=1&foo%5B1%5D=2&foo%5Bf%5D%5B0%5D=4&foo%5Bf%5D%5B1%5D=5'
            ],
            'nested variables' => [
                'bar|foo(1-2)',
                [
                    'bar' => [
                        'foo' => 1,
                        'unused' => 'never'
                    ]
                ],
                '&bar[foo]=1'
            ],
        ];
    }
 
    public function ‪initializeSearchWordDataDoesNothingWithNullValue()
    {
        ‪$subject = $this->getAccessibleMock(TypoScriptFrontendController::class, ['dummy'], [], '', false);
        ‪$subject->_call('initializeSearchWordData', null);
        self::assertEquals('', ‪$subject->sWordRegEx);
        self::assertEquals('', ‪$subject->sWordList);
    }
 
    public function ‪initializeSearchWordDataDoesNothingWithEmptyStringValue()
    {
        ‪$subject = $this->getAccessibleMock(TypoScriptFrontendController::class, ['dummy'], [], '', false);
        ‪$subject->_call('initializeSearchWordData', '');
        self::assertEquals('', ‪$subject->sWordRegEx);
        self::assertEquals('', ‪$subject->sWordList);
    }
 
    public function ‪initializeSearchWordDataDoesNothingWithEmptyArrayValue()
    {
        ‪$subject = $this->getAccessibleMock(TypoScriptFrontendController::class, ['dummy'], [], '', false);
        ‪$subject->_call('initializeSearchWordData', []);
        self::assertEquals('', ‪$subject->sWordRegEx);
        self::assertEquals([], ‪$subject->sWordList);
    }
 
    public function ‪initializeSearchWordDataFillsProperRegexpWithArray()
    {
        ‪$subject = $this->getAccessibleMock(TypoScriptFrontendController::class, ['dummy'], [], '', false);
        ‪$subject->_call('initializeSearchWordData', ['stop', 'word']);
        self::assertEquals('stop|word', ‪$subject->sWordRegEx);
        self::assertEquals(['stop', 'word'], ‪$subject->sWordList);
    }
 
    public function ‪initializeSearchWordDataFillsProperRegexpWithArrayAndStandaloneOption()
    {
        ‪$subject = $this->getAccessibleMock(TypoScriptFrontendController::class, ['dummy'], [], '', false);
        ‪$subject->config['config']['sword_standAlone'] = 1;
        ‪$subject->_call('initializeSearchWordData', ['stop', 'word']);
        self::assertEquals('[[:space:]]stop[[:space:]]|[[:space:]]word[[:space:]]', ‪$subject->sWordRegEx);
        self::assertEquals(['stop', 'word'], ‪$subject->sWordList);
    }
 
    public function ‪indexedSearchHookUsesPageTitleApi(): void
    {
        $pageTitle = 'This is a test page title coming from PageTitleProviderManager';
 
        $pageTitleProvider = $this->prophesize(PageTitleProviderManager::class);
        $pageTitleProvider->getTitle()->willReturn($pageTitle);
        $pageTitleProvider->getPageTitleCache()->willReturn([]);
        GeneralUtility::setSingletonInstance(PageTitleProviderManager::class, $pageTitleProvider->reveal());
 
        $nullCacheBackend = new NullBackend('');
        $cacheManager = $this->prophesize(CacheManager::class);
        $cacheManager->getCache('pages')->willReturn($nullCacheBackend);
        GeneralUtility::setSingletonInstance(CacheManager::class, $cacheManager->reveal());
 
        $this->subject->generatePageTitle();
        self::assertSame($pageTitle, $this->subject->indexedDocTitle);
    }
 
    public function ‪pageRendererLanguageIsSetToSiteLanguageTypo3LanguageInConstructor(): void
    {
        $nullCacheBackend = new NullBackend('');
        $cacheManager = $this->prophesize(CacheManager::class);
        $cacheManager->getCache('pages')->willReturn($nullCacheBackend);
        $cacheManager->getCache('l10n')->willReturn($nullCacheBackend);
        GeneralUtility::setSingletonInstance(CacheManager::class, $cacheManager->reveal());
        ‪$GLOBALS['TYPO3_REQUEST'] = new ServerRequest('https://www.example.com/');
        $site = $this->‪createSiteWithDefaultLanguage([
            'locale' => 'fr',
            'typo3Language' => 'fr-test',
        ]);
        $languageService = new LanguageService(new Locales(), new LocalizationFactory(new LanguageStore(), $cacheManager->reveal()));
        $languageServiceFactoryProphecy = $this->prophesize(LanguageServiceFactory::class);
        $languageServiceFactoryProphecy->create(Argument::any())->will(function (‪$args) use ($languageService) {
            $languageService->init(‪$args[0]);
            return $languageService;
        });
        GeneralUtility::addInstance(LanguageServiceFactory::class, $languageServiceFactoryProphecy->reveal());
        // Constructor calling initPageRenderer()
        new TypoScriptFrontendController(
            new Context(),
            $site,
            $site->getLanguageById(0),
            new PageArguments(13, '0', [])
        );
        // since PageRenderer is a singleton, this can be queried via the makeInstance call
        self::assertEquals('fr-test', GeneralUtility::makeInstance(PageRenderer::class)->getLanguage());
    }
 
    public function ‪languageServiceIsSetUpWithSiteLanguageTypo3LanguageInConstructor(): void
    {
        $nullCacheBackend = new NullBackend('');
        $cacheManager = $this->prophesize(CacheManager::class);
        $cacheManager->getCache('pages')->willReturn($nullCacheBackend);
        $cacheManager->getCache('l10n')->willReturn($nullCacheBackend);
        GeneralUtility::setSingletonInstance(CacheManager::class, $cacheManager->reveal());
        ‪$GLOBALS['TYPO3_REQUEST'] = new ServerRequest('https://www.example.com/');
        $site = $this->‪createSiteWithDefaultLanguage([
            'locale' => 'fr',
            'typo3Language' => 'fr',
        ]);
        $languageService = new LanguageService(new Locales(), new LocalizationFactory(new LanguageStore(), $cacheManager->reveal()));
        $languageServiceFactoryProphecy = $this->prophesize(LanguageServiceFactory::class);
        $languageServiceFactoryProphecy->create(Argument::any())->will(function (‪$args) use ($languageService) {
            $languageService->init(‪$args[0]);
            return $languageService;
        });
        GeneralUtility::addInstance(LanguageServiceFactory::class, $languageServiceFactoryProphecy->reveal());
        // Constructor calling setOutputLanguage()
        ‪$subject = $this->getAccessibleMock(
            TypoScriptFrontendController::class,
            ['dummy'],
            [
                new Context(),
                $site,
                $site->getLanguageById(0),
                new PageArguments(13, '0', [])
            ]
        );
        $languageService = ‪$subject->_get('languageService');
        // since PageRenderer is a singleton, this can be queried via the makeInstance call
        self::assertEquals('fr', $languageService->lang);
    }
 
    public function ‪mountPointParameterContainsOnlyValidMPValues(): void
    {
        $nullCacheBackend = new NullBackend('');
        $cacheManager = $this->prophesize(CacheManager::class);
        $cacheManager->getCache('pages')->willReturn($nullCacheBackend);
        $cacheManager->getCache('l10n')->willReturn($nullCacheBackend);
        GeneralUtility::setSingletonInstance(CacheManager::class, $cacheManager->reveal());
        $languageService = new LanguageService(new Locales(), new LocalizationFactory(new LanguageStore(), $cacheManager->reveal()));
        $languageServiceFactoryProphecy = $this->prophesize(LanguageServiceFactory::class);
        $languageServiceFactoryProphecy->create(Argument::any())->will(function (‪$args) use ($languageService) {
            $languageService->init(‪$args[0]);
            return $languageService;
        });
        GeneralUtility::addInstance(LanguageServiceFactory::class, $languageServiceFactoryProphecy->reveal());
        ‪$GLOBALS['TYPO3_REQUEST'] = new ServerRequest('https://www.example.com/');
 
        $site = $this->‪createSiteWithDefaultLanguage([
            'locale' => 'fr',
            'typo3Language' => 'fr-test',
        ]);
 
        // no MP Parameter given
        ‪$subject = new TypoScriptFrontendController(
            new Context(),
            $site,
            $site->getLanguageById(0),
            new PageArguments(13, '0', [], [], [])
        );
        self::assertEquals('', ‪$subject->MP);
 
        // single MP parameter given
        GeneralUtility::addInstance(LanguageServiceFactory::class, $languageServiceFactoryProphecy->reveal());
        ‪$subject = new TypoScriptFrontendController(
            new Context(),
            $site,
            $site->getLanguageById(0),
            new PageArguments(13, '0', [], [], ['MP' => '592-182'])
        );
        self::assertEquals('592-182', ‪$subject->MP);
 
        // invalid characters included
        GeneralUtility::addInstance(LanguageServiceFactory::class, $languageServiceFactoryProphecy->reveal());
        ‪$subject = new TypoScriptFrontendController(
            new Context(),
            $site,
            $site->getLanguageById(0),
            new PageArguments(13, '0', [], [], ['MP' => '12-13,a34-45/'])
        );
        self::assertEquals('12-13,34-45', ‪$subject->MP);
 
        // single MP parameter given but MP feature is turned off
        ‪$GLOBALS['TYPO3_CONF_VARS']['FE']['enable_mount_pids'] = false;
        GeneralUtility::addInstance(LanguageServiceFactory::class, $languageServiceFactoryProphecy->reveal());
        ‪$subject = new TypoScriptFrontendController(
            new Context(),
            $site,
            $site->getLanguageById(0),
            new PageArguments(13, '0', [], [], ['MP' => '592-182'])
        );
        self::assertEquals('', ‪$subject->MP);
    }
 
    private function ‪createSiteWithDefaultLanguage(array $languageConfiguration): ‪Site
    {
        return new ‪Site('test', 13, [
            'identifier' => 'test',
            'rootPageId' => 13,
            'base' => 'https://www.example.com/',
            'languages' => [
                array_merge(
                    $languageConfiguration,
                    [
                        'languageId' => 0,
                        'base' => '/',
                    ]
                )
            ]
        ]);
    }
}