AbstractHierarchicalFilesystemDriver.php

Go to the documentation of this file.

<?php
namespace ‪TYPO3\CMS\Core\Resource\Driver;
 
/*
 * 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\Charset\CharsetConverter;
use ‪TYPO3\CMS\Core\Resource\Exception\InvalidPathException;
use ‪TYPO3\CMS\Core\Utility\GeneralUtility;
use ‪TYPO3\CMS\Core\Utility\PathUtility;
 
abstract class ‪AbstractHierarchicalFilesystemDriver extends ‪AbstractDriver
{
    protected ‪$charsetConversion;
 
    protected function ‪getCharsetConversion()
    {
        trigger_error('Shorthand method "getCharsetConversion()" within the FAL driver method will be removed in TYPO3 v10.0, instantiate CharsetConverter yourself.', E_USER_DEPRECATED);
        if (!isset($this->charsetConversion)) {
            $this->charsetConversion = GeneralUtility::makeInstance(CharsetConverter::class);
        }
        return ‪$this->charsetConversion;
    }
 
    protected function ‪isPathValid($theFile)
    {
        return GeneralUtility::validPathStr($theFile);
    }
 
    protected function ‪canonicalizeAndCheckFilePath($filePath)
    {
        $filePath = ‪PathUtility::getCanonicalPath($filePath);
 
        // filePath must be valid
        // Special case is required by vfsStream in Unit Test context
        if (!$this->‪isPathValid($filePath) && strpos($filePath, 'vfs://') !== 0) {
            throw new ‪InvalidPathException('File ' . $filePath . ' is not valid (".." and "//" is not allowed in path).', 1320286857);
        }
        return $filePath;
    }
 
    protected function ‪canonicalizeAndCheckFileIdentifier($fileIdentifier)
    {
        if ($fileIdentifier !== '') {
            $fileIdentifier = $this->‪canonicalizeAndCheckFilePath($fileIdentifier);
            $fileIdentifier = '/' . ltrim($fileIdentifier, '/');
            if (!$this->‪isCaseSensitiveFileSystem()) {
                $fileIdentifier = mb_strtolower($fileIdentifier, 'utf-8');
            }
        }
        return $fileIdentifier;
    }
 
    protected function ‪canonicalizeAndCheckFolderIdentifier($folderPath)
    {
        if ($folderPath === '/') {
            $canonicalizedIdentifier = $folderPath;
        } else {
            $canonicalizedIdentifier = rtrim($this->‪canonicalizeAndCheckFileIdentifier($folderPath), '/') . '/';
        }
        return $canonicalizedIdentifier;
    }
 
    public function ‪getParentFolderIdentifierOfIdentifier($fileIdentifier)
    {
        $fileIdentifier = $this->‪canonicalizeAndCheckFileIdentifier($fileIdentifier);
        return rtrim(GeneralUtility::fixWindowsFilePath(‪PathUtility::dirname($fileIdentifier)), '/') . '/';
    }
}