AbstractDriver.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\Resource\Driver;
 
use ‪TYPO3\CMS\Core\Resource\Capabilities;
use ‪TYPO3\CMS\Core\Utility\GeneralUtility;
use ‪TYPO3\CMS\Core\Utility\PathUtility;
 
abstract class ‪AbstractDriver implements DriverInterface
{
    /*******************
     * CAPABILITIES
     *******************/
    protected ‪Capabilities ‪$capabilities;
 
    protected ?int ‪$storageUid = null;
 
    protected array ‪$supportedHashAlgorithms = [];
 
    protected array ‪$configuration = [];
 
    public function ‪__construct(array ‪$configuration = [])
    {
        $this->configuration = ‪$configuration;
    }
 
    protected function ‪isValidFilename(string $fileName): bool
    {
        if (str_contains($fileName, '/')) {
            return false;
        }
        if (!preg_match('/^[\\pL\\d[:blank:]._-]*$/u', $fileName)) {
            return false;
        }
        return true;
    }
 
    public function ‪setStorageUid(int ‪$storageUid): void
    {
        $this->storageUid = ‪$storageUid;
    }
 
    public function ‪getCapabilities(): ‪Capabilities
    {
        return ‪$this->capabilities;
    }
 
    public function ‪hasCapability(int $capability): bool
    {
        return $this->‪getCapabilities()->hasCapability($capability);
    }
 
    /*******************
     * FILE FUNCTIONS
     *******************/
 
    protected function ‪getTemporaryPathForFile(string $fileIdentifier): string
    {
        return GeneralUtility::tempnam('fal-tempfile-', '.' . ‪PathUtility::pathinfo($fileIdentifier, PATHINFO_EXTENSION));
    }
 
    public function ‪hashIdentifier(string ‪$identifier): string
    {
        ‪$identifier = $this->‪canonicalizeAndCheckFileIdentifier($identifier);
        return sha1(‪$identifier);
    }
 
    public function ‪isCaseSensitiveFileSystem(): bool
    {
        if (isset($this->configuration['caseSensitive'])) {
            return (bool)$this->configuration['caseSensitive'];
        }
        return true;
    }
 
    abstract protected function ‪canonicalizeAndCheckFilePath(string $filePath): string;
 
    abstract protected function ‪canonicalizeAndCheckFileIdentifier(string $fileIdentifier): string;
 
    abstract protected function ‪canonicalizeAndCheckFolderIdentifier(string $folderIdentifier): string;
}