9.5/_path_utility_test_8php_source.html

<?php

declare(strict_types = 1);


namespace ‪TYPO3\CMS\Core\Tests\Unit\Utility;


/*

 * 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\Core\Environment;

use ‪TYPO3\CMS\Core\Utility\PathUtility;

use TYPO3\TestingFramework\Core\Unit\UnitTestCase;


class ‪PathUtilityTest extends UnitTestCase

{

    protected ‪$backupEnvironment = true;


    public function ‪isCommonPrefixResolvedCorrectly(array $paths, $expected)

    {

        $commonPrefix = ‪PathUtility::getCommonPrefix($paths);

        $this->assertEquals($expected, $commonPrefix);

    }


    public function ‪isCommonPrefixResolvedCorrectlyDataProvider()

    {

        return [

            [

                [

                    '/var/www/myhost.com/t3lib/'

                ],

                '/var/www/myhost.com/t3lib/'

            ],

            [

                [

                    '/var/www/myhost.com/t3lib/',

                    '/var/www/myhost.com/t3lib/'

                ],

                '/var/www/myhost.com/t3lib/'

            ],

            [

                [

                    '/var/www/myhost.com/typo3/',

                    '/var/www/myhost.com/t3lib/'

                ],

                '/var/www/myhost.com/'

            ],

            [

                [

                    '/var/www/myhost.com/typo3/',

                    '/var/www/myhost.com/typo3'

                ],

                '/var/www/myhost.com/typo3/'

            ],

            [

                [

                    '/var/www/myhost.com/typo3',

                    '/var/www/myhost.com/typo3'

                ],

                '/var/www/myhost.com/typo3/'

            ],

            [

                [

                    '/var/www/myhost.com/uploads/',

                    '/var/www/myhost.com/typo3/',

                    '/var/www/myhost.com/t3lib/'

                ],

                '/var/www/myhost.com/'

            ],

            [

                [

                    '/var/www/myhost.com/uploads/directory/',

                    '/var/www/myhost.com/typo3/sysext/',

                    '/var/www/myhost.com/t3lib/utility/'

                ],

                '/var/www/myhost.com/'

            ],

            [

                [

                    'C:\\www\\myhost.com\\t3lib\\'

                ],

                'C:/www/myhost.com/t3lib/'

            ],

            [

                [

                    'C:\\www\\myhost.com\\t3lib\\',

                    'C:\\www\\myhost.com\\t3lib\\'

                ],

                'C:/www/myhost.com/t3lib/'

            ],

            [

                [

                    'C:\\www\\myhost.com\\typo3\\',

                    'C:\\www\\myhost.com\\t3lib\\'

                ],

                'C:/www/myhost.com/'

            ],

            [

                [

                    'C:\\www\\myhost.com\\uploads\\',

                    'C:\\www\\myhost.com\\typo3\\',

                    'C:\\www\\myhost.com\\t3lib\\'

                ],

                'C:/www/myhost.com/'

            ],

            [

                [

                    'C:\\www\\myhost.com\\uploads\\directory\\',

                    'C:\\www\\myhost.com\\typo3\\sysext\\',

                    'C:\\www\\myhost.com\\t3lib\\utility\\'

                ],

                'C:/www/myhost.com/'

            ]

        ];

    }


    public function ‪isRelativePathResolvedCorrectly($source, $target, $expected)

    {

        $relativePath = ‪PathUtility::getRelativePath($source, $target);

        $this->assertEquals($expected, $relativePath);

    }


    public function ‪isRelativePathResolvedCorrectlyDataProvider()

    {

        return [

            [

                '/',

                ‪Environment::getPublicPath() . '/directory',

                null

            ],

            [

                ‪Environment::getPublicPath() . '/t3lib/',

                ‪Environment::getPublicPath() . '/t3lib/',

                ''

            ],

            [

                ‪Environment::getPublicPath() . '/typo3/',

                ‪Environment::getPublicPath() . '/t3lib/',

                '../t3lib/'

            ],

            [

                ‪Environment::getPublicPath() . '/',

                ‪Environment::getPublicPath() . '/t3lib/',

                't3lib/'

            ],

            [

                ‪Environment::getPublicPath() . '/t3lib/',

                ‪Environment::getPublicPath() . '/t3lib/stddb/',

                'stddb/'

            ],

            [

                ‪Environment::getPublicPath() . '/typo3/sysext/frontend/',

                ‪Environment::getPublicPath() . '/t3lib/utility/',

                '../../../t3lib/utility/'

            ],

        ];

    }


    public function ‪isTrailingSeparatorSanitizedCorrectly($path, $separator, $expected)

    {

        $sanitizedPath = ‪PathUtility::sanitizeTrailingSeparator($path, $separator);

        $this->assertEquals($expected, $sanitizedPath);

    }


    public function ‪isTrailingSeparatorSanitizedCorrectlyDataProvider()

    {

        return [

            ['/var/www//', '/', '/var/www/'],

            ['/var/www/', '/', '/var/www/'],

            ['/var/www', '/', '/var/www/']

        ];

    }


    public function ‪getAbsolutePathOfRelativeReferencedFileOrPathResolvesFileCorrectlyDataProvider()

    {

        return [

            'basic' => [

                '/abc/def/one.txt',

                '../two.txt',

                '/abc/two.txt'

            ],

            'same folder' => [

                '/abc/one.txt',

                './two.txt',

                '/abc/two.txt'

            ],

            'preserve relative path if path goes above start path' => [

                'abc/one.txt',

                '../../two.txt',

                '../two.txt'

            ],

            'preserve absolute path even if path goes above start path' => [

                '/abc/one.txt',

                '../../two.txt',

                '/two.txt',

            ],

            'base folder with same folder path' => [

                '/abc/',

                './two.txt',

                '/abc/two.txt'

            ],

            'base folder with parent folder path' => [

                '/abc/bar/',

                '../foo.txt',

                '/abc/foo.txt'

            ],

        ];

    }


    public function ‪getAbsolutePathOfRelativeReferencedFileOrPathResolvesFileCorrectly($baseFileName, $includeFileName, $expectedFileName)

    {

        $resolvedFilename = ‪PathUtility::getAbsolutePathOfRelativeReferencedFileOrPath($baseFileName, $includeFileName);

        $this->assertEquals($expectedFileName, $resolvedFilename);

    }


    public function ‪getCanonicalPathCorrectlyCleansPathDataProvider(): array

    {

        return [

            'removes single-dot-elements' => [

                'abc/./def/././ghi',

                'abc/def/ghi'

            ],

            'removes ./ at beginning' => [

                './abc/def/ghi',

                'abc/def/ghi'

            ],

            'removes double-slashes' => [

                'abc//def/ghi',

                'abc/def/ghi'

            ],

            'removes double-slashes from front, but keeps absolute path' => [

                '//abc/def/ghi',

                '/abc/def/ghi'

            ],

            'makes double-dot-elements go one level higher, test #1' => [

                'abc/def/ghi/../..',

                'abc'

            ],

            'makes double-dot-elements go one level higher, test #2' => [

                'abc/def/ghi/../123/456/..',

                'abc/def/123'

            ],

            'makes double-dot-elements go one level higher, test #3' => [

                'abc/../../def/ghi',

                '../def/ghi'

            ],

            'makes double-dot-elements go one level higher, test #4' => [

                'abc/def/ghi//../123/456/..',

                'abc/def/123'

            ],

            'truncates slash at the end' => [

                'abc/def/ghi/',

                'abc/def/ghi'

            ],

            'keeps slash in front of absolute paths' => [

                '/abc/def/ghi',

                '/abc/def/ghi'

            ],

            'keeps slash in front of absolute paths even if double-dot-elements want to go higher' => [

                '/abc/../../def/ghi',

                '/def/ghi'

            ],

            'works with EXT-syntax-paths' => [

                'EXT:abc/def/ghi/',

                'EXT:abc/def/ghi'

            ],

            'truncates ending slash with space' => [

                'abc/def/ ',

                'abc/def'

            ],

            'truncates ending space' => [

                'abc/def ',

                'abc/def'

            ],

            'truncates ending dot' => [

                'abc/def/.',

                'abc/def'

            ],

            'does not truncates ending dot if part of name' => [

                'abc/def.',

                'abc/def.'

            ],

            'protocol is not removed' => [

                'vfs://def/../text.txt',

                'vfs://text.txt'

            ],

            'works with filenames' => [

                '/def/../text.txt',

                '/text.txt'

            ],

            'absolute windwos path' => [

                'C:\def\..\..\test.txt',

                'C:/test.txt'

            ],

            'double slashaes' => [

                'abc//def',

                'abc/def'

            ],

            'multiple slashes' => [

                'abc///////def',

                'abc/def'

            ],

        ];

    }


    public function ‪getCanonicalPathCorrectlyCleansPath(string $inputName, string $expectedResult): void

    {

        // Ensure Environment runs as Windows test

        ‪Environment::initialize(

            ‪Environment::getContext(),

            true,

            false,

            ‪Environment::getProjectPath(),

            ‪Environment::getPublicPath(),

            ‪Environment::getVarPath(),

            ‪Environment::getConfigPath(),

            ‪Environment::getCurrentScript(),

            'WINDOWS'

        );

        $this->assertSame(

            $expectedResult,

            ‪PathUtility::getCanonicalPath($inputName)

        );

    }


    public function ‪dirnameDuringBootstrapCorrectlyFetchesParentDataProvider(): array

    {

        return [

            'relative path' => [

                'abc/def/ghi',

                'abc/def'

            ],

            'absolute path 1' => [

                '/var/www/html/index.php',

                '/var/www/html'

            ],

            'absolute path 2' => [

                '/var/www/html/typo3/index.php',

                '/var/www/html/typo3'

            ],

            'windows path' => [

                'C:\\inetpub\\index.php',

                'C:\\inetpub'

            ],

        ];

    }


    public function ‪dirnameDuringBootstrapCorrectlyFetchesParent(string $inputPath, string $expectedResult): void

    {

        $this->assertSame(

            $expectedResult,

            ‪PathUtility::dirnameDuringBootstrap($inputPath)

        );

    }


    public function ‪basenameDuringBootstrapCorrectlyFetchesBasenameDataProvider()

    {

        return [

            'relative path' => [

                'abc/def/ghi',

                'ghi'

            ],

            'absolute path 1' => [

                '/var/www/html/index.php',

                'index.php'

            ],

            'absolute path 2' => [

                '/var/www/html/typo3/index.php',

                'index.php'

            ],

            'windows path' => [

                'C:\\inetpub\\index.php',

                'index.php'

            ],

        ];

    }


    public function ‪basenameDuringBootstrapCorrectlyFetchesBasename(string $inputPath, string $expectedResult): void

    {

        $this->assertSame(

            $expectedResult,

            ‪PathUtility::basenameDuringBootstrap($inputPath)

        );

    }


    public function ‪isAbsolutePathRespectsAllOperatingSystemsPathDataProvider(): array

    {

        return [

            'starting slash' => [

                '/path',

                false,

                true

            ],

            'starting slash on windows' => [

                '/path',

                true,

                true

            ],

            'no match' => [

                'path',

                false,

                false

            ],

            'no match on windows' => [

                'path',

                true,

                false

            ],

            'path starts with C:/' => [

                'C:/folder',

                false,

                false

            ],

            'path starts with C:/ on windows' => [

                'C:/folder',

                true,

                true

            ],

            'path starts with C:\\' => [

                'C:\\folder',

                false,

                false

            ],

            'path starts with C:\\ on windows' => [

                'C:\\folder',

                true,

                true

            ],

        ];

    }


    public function ‪isAbsolutePathRespectsAllOperatingSystems(string $inputPath, bool $isWindows, bool $expectedResult): void

    {

        if ($isWindows) {

            // Ensure Environment runs as Windows test

            ‪Environment::initialize(

                ‪Environment::getContext(),

                true,

                false,

                ‪Environment::getProjectPath(),

                ‪Environment::getPublicPath(),

                ‪Environment::getVarPath(),

                ‪Environment::getConfigPath(),

                ‪Environment::getCurrentScript(),

                'WINDOWS'

            );

        }


        $this->assertSame($expectedResult, ‪PathUtility::isAbsolutePath($inputPath));

    }

}