AbstractDriver.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\Utility\PathUtility;

abstract class AbstractDriver implements DriverInterface
{
    /*******************
     * CAPABILITIES
     *******************/
    protected $capabilities = 0;

    protected $storageUid;

    protected $supportedHashAlgorithms = [];

    protected $configuration = [];

    public function __construct(array $configuration = [])
    {
        $this->configuration = $configuration;
    }

    protected function isValidFilename($fileName)
    {
        if (strpos($fileName, '/') !== false) {
            return false;
        }
        if (!preg_match('/^[\\pL\\d[:blank:]._-]*$/u', $fileName)) {
            return false;
        }
        return true;
    }

    public function setStorageUid($storageUid)
    {
        $this->storageUid = $storageUid;
    }

    public function getCapabilities()
    {
        return $this->capabilities;
    }

    public function hasCapability($capability)
    {
        return $this->capabilities & $capability == $capability;
    }

    /*******************
     * FILE FUNCTIONS
     *******************/

    protected function getTemporaryPathForFile($fileIdentifier)
    {
        return \TYPO3\CMS\Core\Utility\GeneralUtility::tempnam('fal-tempfile-', '.' . PathUtility::pathinfo($fileIdentifier, PATHINFO_EXTENSION));
    }

    public function hashIdentifier($identifier)
    {
        $identifier = $this->canonicalizeAndCheckFileIdentifier($identifier);
        return sha1($identifier);
    }

    public function sanitizeFileName($fileName, $charset = '')
    {
        return $fileName;
    }

    public function isCaseSensitiveFileSystem()
    {
        if (isset($this->configuration['caseSensitive'])) {
            return (bool)$this->configuration['caseSensitive'];
        }
        return true;
    }

    abstract protected function canonicalizeAndCheckFilePath($filePath);

    abstract protected function canonicalizeAndCheckFileIdentifier($fileIdentifier);

    abstract protected function canonicalizeAndCheckFolderIdentifier($folderIdentifier);
}