SiteMatcherTest.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\Core\Tests\Unit\Routing;
 
use PHPUnit\Framework\Attributes\DataProvider;
use PHPUnit\Framework\Attributes\Test;
use PHPUnit\Framework\MockObject\MockObject;
use ‪TYPO3\CMS\Core\Configuration\Features;
use ‪TYPO3\CMS\Core\Configuration\SiteConfiguration;
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\Routing\SiteRouteResult;
use ‪TYPO3\CMS\Core\Site\Entity\Site;
use ‪TYPO3\CMS\Core\Site\SiteFinder;
use TYPO3\TestingFramework\Core\Unit\UnitTestCase;
 
final class ‪SiteMatcherTest extends UnitTestCase
{
    #[Test]
    public function ‪fullUrlMatchesSpecificLanguageWithSubdomainsAndDomainSuffixes(): void
    {
        $site = new ‪Site('main', 1, [
            'base' => '/',
            'languages' => [
                0 => [
                    'title' => 'English',
                    'languageId' => 0,
                    'base' => 'http://9-5.typo3.test/',
                    'locale' => 'en_US-UTF-8',
                ],
                2 => [
                    'title' => 'Deutsch',
                    'languageId' => 2,
                    'base' => 'http://de.9-5.typo3.test/',
                    'locale' => 'en_US-UTF-8',
                ],
                1 => [
                    'title' => 'Dansk',
                    'languageId' => 1,
                    'base' => 'http://9-5.typo3.test/da/',
                    'locale' => 'da_DK.UTF-8',
                ],
            ],
        ]);
        $secondSite = new ‪Site('second', 13, [
            'base' => '/',
            'languages' => [
                0 => [
                    'title' => 'English',
                    'languageId' => 0,
                    'base' => '/en/',
                    'locale' => 'en_US-UTF-8',
                ],
                1 => [
                    'title' => 'Dansk',
                    'languageId' => 1,
                    'base' => '/da/',
                    'locale' => 'da_DK.UTF-8',
                ],
            ],
        ]);
        $featuresMock = $this->‪createFeaturesMock();
        $finderMock = $this->‪createSiteFinder($site, $secondSite);
        $requestContextFactory = new ‪RequestContextFactory(new ‪BackendEntryPointResolver());
        $subject = new ‪SiteMatcher($featuresMock, $finderMock, $requestContextFactory);
 
        $request = new ‪ServerRequest('http://9-5.typo3.test/da/my-page/');
        $result = $subject->matchRequest($request);
        self::assertEquals(1, $result->getLanguage()->getLanguageId());
 
        $request = new ‪ServerRequest('http://9-5.typo3.test/da');
        $result = $subject->matchRequest($request);
        // Matches danish, as path fits
        self::assertEquals(1, $result->getLanguage()->getLanguageId());
 
        $request = new ‪ServerRequest('https://9-5.typo3.test/da');
        $result = $subject->matchRequest($request);
        // Matches the second site, as this is HTTPS and HTTP
        self::assertEquals('second', $result->getSite()->getIdentifier());
        self::assertEquals(1, $result->getLanguage()->getLanguageId());
 
        $request = new ‪ServerRequest('http://de.9-5.typo3.test/da');
        $result = $subject->matchRequest($request);
        // Matches german, as the domain fits!
        self::assertEquals(2, $result->getLanguage()->getLanguageId());
 
        $request = new ‪ServerRequest('http://9-5.typo3.test/');
        $result = $subject->matchRequest($request);
        // Matches english
        self::assertEquals(0, $result->getLanguage()->getLanguageId());
 
        // @todo this is a random result and needs to be refined
        // www.example.com is not defined at all, but it actually "matches"...
        $request = new ‪ServerRequest('http://www.example.com/');
        $result = $subject->matchRequest($request);
        // finds the second site, since that configuration does not have a host part, thus only `/` matches
        // @todo for future versions (TYPO3 v12+) this should be adjusted and be more explicit by enforcing host names
        self::assertNull($result->getLanguage());
        self::assertEquals('second', $result->getSite()->getIdentifier());
    }
 
    #[Test]
    public function ‪fullUrlMatchesSpecificLanguageWithSubdomainsAndPathSuffixes(): void
    {
        $site = new ‪Site('main', 1, [
            'base' => 'https://www.example.com/',
            'languages' => [
                0 => [
                    'title' => 'English',
                    'languageId' => 0,
                    'base' => 'http://example.us/',
                    'locale' => 'en_US-UTF-8',
                ],
                2 => [
                    'title' => 'Deutsch',
                    'languageId' => 2,
                    'base' => 'http://www.example.de/',
                    'locale' => 'en_US-UTF-8',
                ],
                1 => [
                    'title' => 'Dansk',
                    'languageId' => 1,
                    'base' => 'http://www.example.com/da/',
                    'locale' => 'da_DK.UTF-8',
                ],
                3 => [
                    'title' => 'French',
                    'languageId' => 3,
                    'base' => '/fr/',
                    'locale' => 'fr_FR.UTF-8',
                ],
            ],
        ]);
        $secondSite = new ‪Site('second', 13, [
            'base' => '/',
            'languages' => [
                0 => [
                    'title' => 'English',
                    'languageId' => 0,
                    'base' => '/en/',
                    'locale' => 'en_US-UTF-8',
                ],
                1 => [
                    'title' => 'Dansk',
                    'languageId' => 1,
                    'base' => '/da/',
                    'locale' => 'da_DK.UTF-8',
                ],
            ],
        ]);
        $featuresMock = $this->‪createFeaturesMock();
        $finderMock = $this->‪createSiteFinder($site, $secondSite);
        $requestContextFactory = new ‪RequestContextFactory(new ‪BackendEntryPointResolver());
        $subject = new ‪SiteMatcher($featuresMock, $finderMock, $requestContextFactory);
 
        $request = new ‪ServerRequest('https://www.example.com/de');
        $result = $subject->matchRequest($request);
        // Site found, but no language
        self::assertEquals($site, $result->getSite());
        self::assertNull($result->getLanguage());
 
        $request = new ‪ServerRequest('http://www.other-domain.com/da');
        $result = $subject->matchRequest($request);
        self::assertEquals($secondSite, $result->getSite());
        self::assertEquals(1, $result->getLanguage()->getLanguageId());
 
        $request = new ‪ServerRequest('http://www.other-domain.com/de');
        $result = $subject->matchRequest($request);
        // No language for this solution
        self::assertEquals($secondSite, $result->getSite());
        self::assertNull($result->getLanguage());
    }
 
    public static function ‪bestMatchingUrlIsUsedDataProvider(): \Generator
    {
        yield ['https://example.org/page', '1-main', 'en-US'];
        yield ['https://example.org/', '1-main', 'en-US'];
        yield ['https://example.org/f', '1-main', 'en-US'];
        yield ['https://example.org/fr', '3-fr', 'fr-FR'];
        yield ['https://example.org/friendly-page', '1-main', 'en-US'];
        yield ['https://example.org/fr/', '3-fr', 'fr-FR'];
        yield ['https://example.org/fr/page', '3-fr', 'fr-FR'];
        yield ['https://example.org/de', '1-main', 'de-DE'];
        yield ['https://example.org/deterministic', '1-main', 'en-US'];
        yield ['https://example.org/da', '2-da', 'da-DK'];
        yield ['https://example.org/daother', '1-main', 'en-US'];
    }
 
    #[DataProvider('bestMatchingUrlIsUsedDataProvider')]
    #[Test]
    public function ‪bestMatchingUrlIsUsed(string $requestUri, string $expectedSite, string $expectedLocale): void
    {
        $mainSite = new ‪Site('1-main', 31, [
            'base' => 'https://example.org/',
            'languages' => [
                [
                    'languageId' => 0,
                    'base' => 'https://example.org/',
                    'locale' => 'en-US',
                ],
                [
                    'languageId' => 2,
                    'base' => 'https://example.org/de/',
                    'locale' => 'de-DE',
                ],
            ],
        ]);
        $dkSite = new ‪Site('2-da', 21, [
            'base' => 'https://example.org/',
            'languages' => [
                [
                    'languageId' => 0,
                    'base' => 'https://example.org/da/',
                    'locale' => 'da-DK',
                ],
            ],
        ]);
        $frSite = new ‪Site('3-fr', 11, [
            'base' => 'https://example.org/',
            'languages' => [
                [
                    'languageId' => 0,
                    'base' => 'https://example.org/fr/',
                    'locale' => 'fr-FR',
                ],
            ],
        ]);
 
        $featuresMock = $this->‪createFeaturesMock();
        $finderMock = $this->‪createSiteFinder($mainSite, $dkSite, $frSite);
        $requestContextFactory = new ‪RequestContextFactory(new ‪BackendEntryPointResolver());
        $subject = new ‪SiteMatcher($featuresMock, $finderMock, $requestContextFactory);
 
        $request = new ‪ServerRequest($requestUri);
        $result = $subject->matchRequest($request);
 
        self::assertSame($expectedSite, $result->getSite()->getIdentifier());
        self::assertSame($expectedLocale, (string)$result->getLanguage()->getLocale());
    }
 
    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));
    }
}