SiteTest.php

Go to the documentation of this file.

<?php
declare(strict_types = 1);
 
namespace ‪TYPO3\CMS\Core\Tests\Unit\Site\Entity;
 
/*
 * 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!
 */
 
use ‪TYPO3\CMS\Core\Crypto\Random;
use ‪TYPO3\CMS\Core\Error\PageErrorHandler\FluidPageErrorHandler;
use ‪TYPO3\CMS\Core\Error\PageErrorHandler\InvalidPageErrorHandlerException;
use ‪TYPO3\CMS\Core\Error\PageErrorHandler\PageContentErrorHandler;
use ‪TYPO3\CMS\Core\Error\PageErrorHandler\PageErrorHandlerInterface;
use ‪TYPO3\CMS\Core\Error\PageErrorHandler\PageErrorHandlerNotConfiguredException;
use ‪TYPO3\CMS\Core\Http\Uri;
use ‪TYPO3\CMS\Core\Site\Entity\Site;
use ‪TYPO3\CMS\Core\Utility\GeneralUtility;
use TYPO3\TestingFramework\Core\Unit\UnitTestCase;
 
class ‪SiteTest extends UnitTestCase
{
    public function ‪getBaseReturnsProperUriDataProvider()
    {
        return [
            'URL with scheme and domain' => ['https://www.typo3.org', 'https://www.typo3.org'],
            'URL with scheme and domain and path' => ['https://www.typo3.org/howdy', 'https://www.typo3.org/howdy'],
            'URL with scheme and domain and path with trailing slash' => ['https://www.typo3.org/howdy/', 'https://www.typo3.org/howdy/'],
            'URL without scheme, but with domain' => ['www.typo3.org', '//www.typo3.org'],
            'URL without scheme, but with domain and path' => ['www.typo3.org/partner', '//www.typo3.org/partner'],
            'URL without scheme, but with domain and path and trailing slash' => ['www.typo3.org/partner/', '//www.typo3.org/partner/'],
            'URL without scheme and domain but with absolute path' => ['/partner', '/partner'],
            'URL without scheme and domain but with absolute path and trailing slash' => ['/partner/', '/partner/'],
            'URL without scheme, domain but with random path receives a scheme divider' => ['partner/', '/partner/'],
            'URL with ID query parameter' => ['/partner/?id=nice-to-see-you', '/partner/?id=nice-to-see-you'],
            'URL with unknown query parameter' => ['/partner/?in-crime=nice-to-see-you', '/partner/?in-crime=nice-to-see-you'],
        ];
    }
 
    public function ‪getBaseReturnsProperUri($input, $expected)
    {
        $subject = new ‪Site('all-your-base-belongs-to-us', 13, [
            'base' => $input,
            'languages' => []
        ]);
        $this->assertEquals(new ‪Uri($expected), $subject->getBase());
    }
 
    public function ‪getBaseForSiteLanguageReturnsProperUriDataProvider()
    {
        return [
            'Language as a regular path segment' => [
                'https://www.typo3.org',
                'en',
                'https://www.typo3.org/en',
            ],
            'Language with two path segments' => [
                'https://www.typo3.org',
                'us/en',
                'https://www.typo3.org/us/en',
            ],
            'Site base is added to absolute path segment' => [
                'https://www.typo3.com/microsites/',
                '/onboarding/',
                'https://www.typo3.com/microsites/onboarding/',
            ],
            'Site base is prefixed to absolute path segment' => [
                'https://www.typo3.com/microsites/',
                'onboarding/',
                'https://www.typo3.com/microsites/onboarding/',
            ],
            'Language with domain and scheme, do not care about site base' => [
                'https://www.typo3.org',
                'https://www.typo3.it',
                'https://www.typo3.it',
            ],
            'Language with domain but no scheme, do not care about site base' => [
                'blabla.car',
                'www.typo3.fr',
                '//www.typo3.fr',
            ],
        ];
    }
 
    public function ‪getBaseForSiteLanguageReturnsProperUri($siteBase, $languageBase, $expected)
    {
        $subject = new ‪Site('all-of-base', 13, [
            'base' => $siteBase,
            'languages' => [
                [
                    'languageId' => 0,
                    'base' => $languageBase,
                    'locale' => 'it_IT.UTF-8',
                ]
            ]
        ]);
        $this->assertEquals(new ‪Uri($expected), $subject->getLanguageById(0)->getBase());
    }
 
    public function ‪getErrorHandlerReturnsConfiguredErrorHandler()
    {
        $subject = new ‪Site('aint-misbehaving', 13, [
            'languages' => [],
            'errorHandling' => [
                [
                    'errorCode' => 123,
                    'errorHandler' => 'Fluid',
                ],
                [
                    'errorCode' => 124,
                    'errorContentSource' => 123,
                    'errorHandler' => 'Page'
                ],
                [
                    'errorCode' => 125,
                    'errorHandler' => 'PHP',
                    'errorContentSource' => 123,
                    'errorPhpClassFQCN' => PageContentErrorHandler::class
                ]
            ]
        ]);
 
        $fluidProphecy = $this->prophesize(FluidPageErrorHandler::class);
        GeneralUtility::addInstance(FluidPageErrorHandler::class, $fluidProphecy->reveal());
 
        $this->assertEquals(true, $subject->getErrorHandler(123) instanceof ‪PageErrorHandlerInterface);
        $this->assertEquals(true, $subject->getErrorHandler(124) instanceof ‪PageErrorHandlerInterface);
        $this->assertEquals(true, $subject->getErrorHandler(125) instanceof ‪PageErrorHandlerInterface);
    }
 
    public function ‪getErrorHandlerThrowsExceptionOnInvalidErrorHandler()
    {
        $this->expectException(InvalidPageErrorHandlerException::class);
        $this->expectExceptionCode(1527432330);
        $this->expectExceptionMessage('The configured error handler "' . Random::class . '" for status code 404 must implement the PageErrorHandlerInterface.');
        $subject = new ‪Site('aint-misbehaving', 13, [
            'languages' => [],
            'errorHandling' => [
                [
                    'errorCode' => 404,
                    'errorHandler' => 'PHP',
                    'errorPhpClassFQCN' => Random::class
                ],
            ]
        ]);
        $subject->getErrorHandler(404);
    }
 
    public function ‪getErrorHandlerThrowsExceptionWhenNoErrorHandlerIsConfigured()
    {
        $this->expectException(PageErrorHandlerNotConfiguredException::class);
        $this->expectExceptionCode(1522495914);
        $this->expectExceptionMessage('No error handler given for the status code "404".');
        $subject = new ‪Site('aint-misbehaving', 13, ['languages' => []]);
        $subject->getErrorHandler(404);
    }
 
    public function ‪getErrorHandlerThrowsExceptionWhenNoErrorHandlerForStatusCodeIsConfigured()
    {
        $this->expectException(PageErrorHandlerNotConfiguredException::class);
        $this->expectExceptionCode(1522495914);
        $this->expectExceptionMessage('No error handler given for the status code "404".');
        $subject = new ‪Site('aint-misbehaving', 13, [
            'languages' => [],
            'errorHandling' => [
                [
                    'errorCode' => 403,
                    'errorHandler' => 'Does it really matter?'
                ],
            ]
        ]);
        $subject->getErrorHandler(404);
    }
}