SiteResolverTest.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\Middleware;
 
use PHPUnit\Framework\Attributes\DataProvider;
use PHPUnit\Framework\Attributes\Test;
use PHPUnit\Framework\MockObject\MockObject;
use Psr\Http\Message\ResponseInterface;
use Psr\Http\Message\ServerRequestInterface;
use Psr\Http\Server\RequestHandlerInterface;
use ‪TYPO3\CMS\Core\Cache\CacheManager;
use ‪TYPO3\CMS\Core\Configuration\Features;
use ‪TYPO3\CMS\Core\Configuration\SiteConfiguration;
use ‪TYPO3\CMS\Core\Http\JsonResponse;
use ‪TYPO3\CMS\Core\Http\NullResponse;
use ‪TYPO3\CMS\Core\Http\ServerRequest;
use ‪TYPO3\CMS\Core\Routing\BackendEntryPointResolver;
use ‪TYPO3\CMS\Core\Routing\RequestContextFactory;
use ‪TYPO3\CMS\Core\Routing\SiteMatcher;
use ‪TYPO3\CMS\Core\Site\Entity\Site;
use ‪TYPO3\CMS\Core\Site\SiteFinder;
use ‪TYPO3\CMS\Core\Utility\GeneralUtility;
use ‪TYPO3\CMS\Frontend\Middleware\SiteResolver;
use TYPO3\TestingFramework\Core\AccessibleObjectInterface;
use TYPO3\TestingFramework\Core\Unit\UnitTestCase;
 
final class ‪SiteResolverTest extends UnitTestCase
{
    protected bool ‪$resetSingletonInstances = true;
    protected ‪SiteFinder&AccessibleObjectInterface ‪$siteFinder;
 
    protected RequestHandlerInterface ‪$siteFoundRequestHandler;
    protected string ‪$originalLocale;
 
    protected function ‪setUp(): void
    {
        parent::setUp();
        $this->originalLocale = setlocale(LC_COLLATE, '0');
        $this->siteFinder = $this->getAccessibleMock(SiteFinder::class, null, [], '', false);
 
        // A request handler which expects a site to be found.
        $this->siteFoundRequestHandler = new class () implements RequestHandlerInterface {
            public function handle(ServerRequestInterface $request): ResponseInterface
            {
                $site = $request->getAttribute('site', false);
                $language = $request->getAttribute('language', false);
                if ($site && $language) {
                    return new ‪JsonResponse(
                        [
                            'site' => $site->getIdentifier(),
                            'language-id' => $language->getLanguageId(),
                            'language-base' => (string)$language->getBase(),
                            'rootpage' => $site->getRootPageId(),
                        ]
                    );
                }
                return new ‪NullResponse();
            }
        };
 
        $cacheManagerMock = $this->getMockBuilder(CacheManager::class)->disableOriginalConstructor()->getMock();
        GeneralUtility::setSingletonInstance(CacheManager::class, $cacheManagerMock);
    }
 
    protected function ‪tearDown(): void
    {
        // restore locale to original setting
        setlocale(LC_COLLATE, $this->originalLocale);
        setlocale(LC_MONETARY, $this->originalLocale);
        setlocale(LC_TIME, $this->originalLocale);
        parent::tearDown();
    }
 
    #[Test]
    public function ‪detectASingleSiteWhenProperRequestIsGiven(): void
    {
        $incomingUrl = 'https://a-random-domain.com/mysite/';
        ‪$siteIdentifier = 'full-site';
        ‪$siteFinder = $this->‪createSiteFinder(new ‪Site(‪$siteIdentifier, 13, [
            'base' => '/mysite/',
            'languages' => [
                0 => [
                    'languageId' => 0,
                    'locale' => 'fr_FR.UTF-8',
                    'base' => '/',
                ],
            ],
        ]));
        $featuresMock = $this->‪createFeaturesMock();
        $requestContextFactory = new ‪RequestContextFactory(new ‪BackendEntryPointResolver());
        $subject = new ‪SiteResolver(new ‪SiteMatcher($featuresMock, ‪$siteFinder, $requestContextFactory));
 
        $request = new ‪ServerRequest($incomingUrl, 'GET');
        $response = $subject->process($request, $this->siteFoundRequestHandler);
 
        if ($response instanceof ‪NullResponse) {
            self::fail('No site configuration found in URL ' . $incomingUrl . '.');
        } else {
            $result = $response->getBody()->getContents();
            $result = json_decode($result, true);
            self::assertEquals(‪$siteIdentifier, $result['site']);
            self::assertEquals(0, $result['language-id']);
            self::assertEquals('/mysite/', $result['language-base']);
        }
    }
 
    #[Test]
    public function ‪detectSubsiteInsideNestedUrlStructure(): void
    {
        $incomingUrl = 'https://www.random-result.com/mysubsite/you-know-why/';
        ‪$siteFinder = $this->‪createSiteFinder(
            new ‪Site('outside-site', 13, [
                'base' => '/',
                'languages' => [
                    0 => [
                        'languageId' => 0,
                        'locale' => 'fr_FR.UTF-8',
                        'base' => '/',
                    ],
                ],
            ]),
            new ‪Site('sub-site', 15, [
                'base' => '/mysubsite/',
                'languages' => [
                    0 => [
                        'languageId' => 0,
                        'locale' => 'fr_FR.UTF-8',
                        'base' => '/',
                    ],
                ],
            ]),
        );
 
        $featuresMock = $this->‪createFeaturesMock();
        $requestContextFactory = new ‪RequestContextFactory(new ‪BackendEntryPointResolver());
        $subject = new ‪SiteResolver(new ‪SiteMatcher($featuresMock, ‪$siteFinder, $requestContextFactory));
 
        $request = new ‪ServerRequest($incomingUrl, 'GET');
        $response = $subject->process($request, $this->siteFoundRequestHandler);
        if ($response instanceof ‪NullResponse) {
            self::fail('No site configuration found in URL ' . $incomingUrl . '.');
        } else {
            $result = $response->getBody()->getContents();
            $result = json_decode($result, true);
            self::assertEquals('sub-site', $result['site']);
            self::assertEquals(0, $result['language-id']);
            self::assertEquals('/mysubsite/', $result['language-base']);
        }
    }
 
    public static function ‪detectSubSubsiteInsideNestedUrlStructureDataProvider(): array
    {
        return [
            'matches second site' => [
                'https://www.random-result.com/mysubsite/you-know-why/',
                'sub-site',
                14,
                '/mysubsite/',
            ],
            'matches third site' => [
                'https://www.random-result.com/mysubsite/micro-site/oh-yes-you-do/',
                'subsub-site',
                15,
                '/mysubsite/micro-site/',
            ],
            'matches a subsite in first site' => [
                'https://www.random-result.com/products/pampers/',
                'outside-site',
                13,
                '/',
            ],
        ];
    }
 
    #[DataProvider('detectSubSubsiteInsideNestedUrlStructureDataProvider')]
    #[Test]
    public function ‪detectSubSubsiteInsideNestedUrlStructure($incomingUrl, $expectedSiteIdentifier, $expectedRootPageId, $expectedBase): void
    {
        ‪$siteFinder = $this->‪createSiteFinder(
            new ‪Site('outside-site', 13, [
                'base' => '/',
                'languages' => [
                    0 => [
                        'languageId' => 0,
                        'locale' => 'fr_FR.UTF-8',
                        'base' => '/',
                    ],
                ],
            ]),
            new ‪Site('sub-site', 14, [
                'base' => '/mysubsite/',
                'languages' => [
                    0 => [
                        'languageId' => 0,
                        'locale' => 'fr_FR.UTF-8',
                        'base' => '/',
                    ],
                ],
            ]),
            new ‪Site('subsub-site', 15, [
                'base' => '/mysubsite/micro-site/',
                'languages' => [
                    0 => [
                        'languageId' => 0,
                        'locale' => 'fr_FR.UTF-8',
                        'base' => '/',
                    ],
                ],
            ]),
        );
 
        $featuresMock = $this->‪createFeaturesMock();
        $requestContextFactory = new ‪RequestContextFactory(new ‪BackendEntryPointResolver());
        $subject = new ‪SiteResolver(new ‪SiteMatcher($featuresMock, ‪$siteFinder, $requestContextFactory));
 
        $request = new ‪ServerRequest($incomingUrl, 'GET');
        $response = $subject->process($request, $this->siteFoundRequestHandler);
 
        if ($response instanceof ‪NullResponse) {
            self::fail('No site configuration found in URL ' . $incomingUrl . '.');
        } else {
            $result = $response->getBody()->getContents();
            $result = json_decode($result, true);
            self::assertEquals($expectedSiteIdentifier, $result['site']);
            self::assertEquals($expectedRootPageId, $result['rootpage']);
            self::assertEquals($expectedBase, $result['language-base']);
        }
    }
 
    public static function ‪detectProperLanguageByIncomingUrlDataProvider(): array
    {
        return [
            'matches second site' => [
                'https://www.random-result.com/mysubsite/you-know-why/',
                'sub-site',
                14,
                2,
                '/mysubsite/',
            ],
            'matches second site in other language' => [
                'https://www.random-result.com/mysubsite/it/you-know-why/',
                'sub-site',
                14,
                2,
                '/mysubsite/',
            ],
            'matches third site' => [
                'https://www.random-result.com/mysubsite/micro-site/ru/oh-yes-you-do/',
                'subsub-site',
                15,
                13,
                '/mysubsite/micro-site/ru/',
            ],
            'matches a subpage in first site' => [
                'https://www.random-result.com/en/products/pampers/',
                'outside-site',
                13,
                0,
                '/en/',
            ],
            'matches a subpage with translation in first site' => [
                'https://www.random-result.com/fr/products/pampers/',
                'outside-site',
                13,
                1,
                '/fr/',
            ],
        ];
    }
 
    #[DataProvider('detectProperLanguageByIncomingUrlDataProvider')]
    #[Test]
    public function ‪detectProperLanguageByIncomingUrl($incomingUrl, $expectedSiteIdentifier, $expectedRootPageId, $expectedLanguageId, $expectedBase): void
    {
        ‪$siteFinder = $this->‪createSiteFinder(
            new ‪Site('outside-site', 13, [
                'base' => '/',
                'languages' => [
                    0 => [
                        'languageId' => 0,
                        'locale' => 'en_US.UTF-8',
                        'base' => '/en/',
                    ],
                    1 => [
                        'languageId' => 1,
                        'locale' => 'fr_CA.UTF-8',
                        'base' => '/fr/',
                    ],
                ],
            ]),
            new ‪Site('sub-site', 14, [
                'base' => '/mysubsite/',
                'languages' => [
                    2 => [
                        'languageId' => 2,
                        'locale' => 'it_IT.UTF-8',
                        'base' => '/',
                    ],
                ],
            ]),
            new ‪Site('subsub-site', 15, [
                'base' => '/mysubsite/micro-site/',
                'languages' => [
                    13 => [
                        'languageId' => 13,
                        'locale' => 'ru_RU.UTF-8',
                        'base' => '/ru/',
                    ],
                ],
            ]),
        );
 
        $featuresMock = $this->‪createFeaturesMock();
        $requestContextFactory = new ‪RequestContextFactory(new ‪BackendEntryPointResolver());
        $subject = new ‪SiteResolver(new ‪SiteMatcher($featuresMock, ‪$siteFinder, $requestContextFactory));
 
        $request = new ‪ServerRequest($incomingUrl, 'GET');
        $response = $subject->process($request, $this->siteFoundRequestHandler);
 
        if ($response instanceof ‪NullResponse) {
            self::fail('No site configuration found in URL ' . $incomingUrl . '.');
        } else {
            $result = $response->getBody()->getContents();
            $result = json_decode($result, true);
            self::assertEquals($expectedSiteIdentifier, $result['site']);
            self::assertEquals($expectedRootPageId, $result['rootpage']);
            self::assertEquals($expectedLanguageId, $result['language-id']);
            self::assertEquals($expectedBase, $result['language-base']);
        }
    }
 
    private function ‪createFeaturesMock(): MockObject&‪Features
    {
        $mock = $this->getMockBuilder(Features::class)
            ->onlyMethods(['isFeatureEnabled'])
            ->getMock();
        $mock->expects(self::any())
            ->method('isFeatureEnabled')
            ->with('security.frontend.allowInsecureSiteResolutionByQueryParameters')
            ->willReturn(false);
        return $mock;
    }
 
    private function ‪createSiteFinder(‪Site ...$sites): ‪SiteFinder
    {
        $siteConfiguration = new class ($sites) extends ‪SiteConfiguration {
            public function __construct(
                protected array $sites
            ) {
                // empty by default
            }
 
            public function getAllExistingSites(bool $useCache = true): array
            {
                return array_combine(
                    array_map(static function (‪Site $site) { return $site->‪getIdentifier(); }, $this->sites),
                    $this->sites
                );
            }
        };
        return new ‪SiteFinder(new $siteConfiguration($sites));
    }
}