ResourceStorage.php

Go to the documentation of this file.

<?php
 
/*
 * 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;
 
use Psr\EventDispatcher\EventDispatcherInterface;
use Psr\Http\Message\ResponseInterface;
use Psr\Http\Message\ServerRequestInterface;
use ‪TYPO3\CMS\Core\Authentication\BackendUserAuthentication;
use ‪TYPO3\CMS\Core\Core\Environment;
use ‪TYPO3\CMS\Core\Database\ConnectionPool;
use ‪TYPO3\CMS\Core\Http\ApplicationType;
use ‪TYPO3\CMS\Core\Http\FalDumpFileContentsDecoratorStream;
use ‪TYPO3\CMS\Core\Http\Response;
use ‪TYPO3\CMS\Core\Http\UploadedFile;
use ‪TYPO3\CMS\Core\Log\LogManager;
use ‪TYPO3\CMS\Core\Registry;
use ‪TYPO3\CMS\Core\Resource\Driver\DriverInterface;
use ‪TYPO3\CMS\Core\Resource\Driver\StreamableDriverInterface;
use ‪TYPO3\CMS\Core\Resource\Event\AfterFileAddedEvent;
use ‪TYPO3\CMS\Core\Resource\Event\AfterFileContentsSetEvent;
use ‪TYPO3\CMS\Core\Resource\Event\AfterFileCopiedEvent;
use ‪TYPO3\CMS\Core\Resource\Event\AfterFileCreatedEvent;
use ‪TYPO3\CMS\Core\Resource\Event\AfterFileDeletedEvent;
use ‪TYPO3\CMS\Core\Resource\Event\AfterFileMovedEvent;
use ‪TYPO3\CMS\Core\Resource\Event\AfterFileRenamedEvent;
use ‪TYPO3\CMS\Core\Resource\Event\AfterFileReplacedEvent;
use ‪TYPO3\CMS\Core\Resource\Event\AfterFolderAddedEvent;
use ‪TYPO3\CMS\Core\Resource\Event\AfterFolderCopiedEvent;
use ‪TYPO3\CMS\Core\Resource\Event\AfterFolderDeletedEvent;
use ‪TYPO3\CMS\Core\Resource\Event\AfterFolderMovedEvent;
use ‪TYPO3\CMS\Core\Resource\Event\AfterFolderRenamedEvent;
use ‪TYPO3\CMS\Core\Resource\Event\BeforeFileAddedEvent;
use ‪TYPO3\CMS\Core\Resource\Event\BeforeFileContentsSetEvent;
use ‪TYPO3\CMS\Core\Resource\Event\BeforeFileCopiedEvent;
use ‪TYPO3\CMS\Core\Resource\Event\BeforeFileCreatedEvent;
use ‪TYPO3\CMS\Core\Resource\Event\BeforeFileDeletedEvent;
use ‪TYPO3\CMS\Core\Resource\Event\BeforeFileMovedEvent;
use ‪TYPO3\CMS\Core\Resource\Event\BeforeFileRenamedEvent;
use ‪TYPO3\CMS\Core\Resource\Event\BeforeFileReplacedEvent;
use ‪TYPO3\CMS\Core\Resource\Event\BeforeFolderAddedEvent;
use ‪TYPO3\CMS\Core\Resource\Event\BeforeFolderCopiedEvent;
use ‪TYPO3\CMS\Core\Resource\Event\BeforeFolderDeletedEvent;
use ‪TYPO3\CMS\Core\Resource\Event\BeforeFolderMovedEvent;
use ‪TYPO3\CMS\Core\Resource\Event\BeforeFolderRenamedEvent;
use ‪TYPO3\CMS\Core\Resource\Event\GeneratePublicUrlForResourceEvent;
use ‪TYPO3\CMS\Core\Resource\Event\SanitizeFileNameEvent;
use ‪TYPO3\CMS\Core\Resource\Exception\ExistingTargetFileNameException;
use ‪TYPO3\CMS\Core\Resource\Exception\ExistingTargetFolderException;
use ‪TYPO3\CMS\Core\Resource\Exception\FileOperationErrorException;
use ‪TYPO3\CMS\Core\Resource\Exception\FolderDoesNotExistException;
use ‪TYPO3\CMS\Core\Resource\Exception\IllegalFileExtensionException;
use ‪TYPO3\CMS\Core\Resource\Exception\InsufficientFileAccessPermissionsException;
use ‪TYPO3\CMS\Core\Resource\Exception\InsufficientFileReadPermissionsException;
use ‪TYPO3\CMS\Core\Resource\Exception\InsufficientFileWritePermissionsException;
use ‪TYPO3\CMS\Core\Resource\Exception\InsufficientFolderAccessPermissionsException;
use ‪TYPO3\CMS\Core\Resource\Exception\InsufficientFolderWritePermissionsException;
use ‪TYPO3\CMS\Core\Resource\Exception\InsufficientUserPermissionsException;
use ‪TYPO3\CMS\Core\Resource\Exception\InvalidConfigurationException;
use ‪TYPO3\CMS\Core\Resource\Exception\InvalidHashException;
use ‪TYPO3\CMS\Core\Resource\Exception\InvalidTargetFolderException;
use ‪TYPO3\CMS\Core\Resource\Exception\ResourcePermissionsUnavailableException;
use ‪TYPO3\CMS\Core\Resource\Exception\UploadException;
use ‪TYPO3\CMS\Core\Resource\Exception\UploadSizeException;
use ‪TYPO3\CMS\Core\Resource\Filter\ImportExportFilter;
use ‪TYPO3\CMS\Core\Resource\Index\FileIndexRepository;
use ‪TYPO3\CMS\Core\Resource\Index\Indexer;
use ‪TYPO3\CMS\Core\Resource\OnlineMedia\Helpers\OnlineMediaHelperRegistry;
use ‪TYPO3\CMS\Core\Resource\Search\FileSearchDemand;
use ‪TYPO3\CMS\Core\Resource\Search\Result\DriverFilteredSearchResult;
use ‪TYPO3\CMS\Core\Resource\Search\Result\EmptyFileSearchResult;
use ‪TYPO3\CMS\Core\Resource\Search\Result\FileSearchResult;
use ‪TYPO3\CMS\Core\Resource\Search\Result\FileSearchResultInterface;
use ‪TYPO3\CMS\Core\Resource\Security\FileNameValidator;
use ‪TYPO3\CMS\Core\Resource\Service\FileProcessingService;
use ‪TYPO3\CMS\Core\Service\FlexFormService;
use ‪TYPO3\CMS\Core\Utility\Exception\NotImplementedMethodException;
use ‪TYPO3\CMS\Core\Utility\GeneralUtility;
use ‪TYPO3\CMS\Core\Utility\PathUtility;
use ‪TYPO3\CMS\Core\Utility\StringUtility;
 
class ‪ResourceStorage implements ‪ResourceStorageInterface
{
    protected ‪$driver;
 
    protected ‪$storageRecord;
 
    protected ‪$configuration;
 
    protected ‪$fileProcessingService;
 
    protected ‪$evaluatePermissions = false;
 
    protected ‪$fileMounts = [];
 
    protected ‪$userPermissions = [];
 
    protected ‪$capabilities;
 
    protected ‪$eventDispatcher;
 
    protected ‪$processingFolder;
 
    protected ‪$processingFolders;
 
    protected ‪$isOnline;
 
    protected ‪$isDefault = false;
 
    protected ‪$fileAndFolderNameFilters = [];
 
    public const ‪PROCESSING_FOLDER_LEVELS = 2;
 
    public function ‪__construct(‪DriverInterface ‪$driver, array ‪$storageRecord, EventDispatcherInterface ‪$eventDispatcher = null)
    {
        $this->storageRecord = ‪$storageRecord;
        $this->eventDispatcher = ‪$eventDispatcher ?? GeneralUtility::makeInstance(EventDispatcherInterface::class);
        if (is_array(‪$storageRecord['configuration'] ?? null)) {
            $this->configuration = ‪$storageRecord['configuration'];
        } elseif (!empty(‪$storageRecord['configuration'] ?? '')) {
            $this->configuration = GeneralUtility::makeInstance(FlexFormService::class)->convertFlexFormContentToArray(‪$storageRecord['configuration']);
        } else {
            $this->configuration = [];
        }
        $this->capabilities =
            ($this->storageRecord['is_browsable'] ?? null ? ‪self::CAPABILITY_BROWSABLE : 0) |
            ($this->storageRecord['is_public'] ?? null ? self::CAPABILITY_PUBLIC : 0) |
            ($this->storageRecord['is_writable'] ?? null ? ‪self::CAPABILITY_WRITABLE : 0) |
            // Always let the driver decide whether to set this capability
            self::CAPABILITY_HIERARCHICAL_IDENTIFIERS;
 
        $this->driver = ‪$driver;
        $this->driver->‪setStorageUid(‪$storageRecord['uid'] ?? null);
        $this->driver->mergeConfigurationCapabilities($this->capabilities);
        try {
            $this->driver->processConfiguration();
        } catch (‪InvalidConfigurationException $e) {
            // Configuration error
            $this->‪isOnline = false;
 
            $message = sprintf(
                'Failed initializing storage [%d] "%s", error: %s',
                $this->‪getUid(),
                $this->‪getName(),
                $e->getMessage()
            );
 
            // create a dedicated logger instance because we need a logger in the constructor
            GeneralUtility::makeInstance(LogManager::class)->getLogger(static::class)->error($message);
        }
        $this->driver->initialize();
        $this->capabilities = $this->driver->getCapabilities();
 
        $this->‪isDefault = (isset(‪$storageRecord['is_default']) && ‪$storageRecord['is_default'] == 1);
        $this->‪resetFileAndFolderNameFiltersToDefault();
    }
 
    public function ‪getConfiguration()
    {
        return ‪$this->configuration;
    }
 
    public function ‪setConfiguration(array ‪$configuration)
    {
        $this->configuration = ‪$configuration;
    }
 
    public function ‪getStorageRecord()
    {
        return ‪$this->storageRecord;
    }
 
    public function ‪setDriver(DriverInterface ‪$driver)
    {
        $this->driver = ‪$driver;
        return ‪$this;
    }
 
    protected function ‪getDriver()
    {
        return ‪$this->driver;
    }
 
    public function ‪getName()
    {
        return $this->storageRecord['name'];
    }
 
    public function ‪getUid()
    {
        return (int)($this->storageRecord['uid'] ?? 0);
    }
 
    public function ‪hasChildren()
    {
        return true;
    }
 
    /*********************************
     * Capabilities
     ********************************/
    public function ‪getCapabilities()
    {
        return (int)‪$this->capabilities;
    }
 
    protected function ‪hasCapability($capability)
    {
        return ($this->capabilities & $capability) == $capability;
    }
 
    public function ‪isPublic()
    {
        return $this->‪hasCapability(self::CAPABILITY_PUBLIC);
    }
 
    public function ‪isWritable()
    {
        return $this->‪hasCapability(self::CAPABILITY_WRITABLE);
    }
 
    public function ‪isBrowsable()
    {
        return $this->‪isOnline() && $this->‪hasCapability(self::CAPABILITY_BROWSABLE);
    }
 
    public function ‪hasHierarchicalIdentifiers(): bool
    {
        return $this->‪hasCapability(self::CAPABILITY_HIERARCHICAL_IDENTIFIERS);
    }
 
    public function ‪searchFiles(FileSearchDemand $searchDemand, Folder $folder = null, bool $useFilters = true): FileSearchResultInterface
    {
        $folder = $folder ?? $this->‪getRootLevelFolder();
        if (!$folder->‪checkActionPermission('read')) {
            return new EmptyFileSearchResult();
        }
 
        return new ‪DriverFilteredSearchResult(
            new ‪FileSearchResult(
                $searchDemand->withFolder($folder)
            ),
            ‪$this->driver,
            $useFilters ? ‪$this->getFileAndFolderNameFilters() : []
        );
    }
 
    public function ‪usesCaseSensitiveIdentifiers()
    {
        return $this->driver->isCaseSensitiveFileSystem();
    }
 
    public function ‪isOnline()
    {
        if ($this->‪isOnline === null) {
            if ($this->‪getUid() === 0) {
                $this->‪isOnline = true;
            }
            // the storage is not marked as online for a longer time
            if ($this->storageRecord['is_online'] == 0) {
                $this->‪isOnline = false;
            }
            if ($this->‪isOnline !== false) {
                if ((‪$GLOBALS['TYPO3_REQUEST'] ?? null) instanceof ServerRequestInterface
                    && ‪ApplicationType::fromRequest(‪$GLOBALS['TYPO3_REQUEST'])->isFrontend()
                ) {
                    // All files are ALWAYS available in the frontend
                    $this->‪isOnline = true;
                } else {
                    // check if the storage is disabled temporary for now
                    $registryObject = GeneralUtility::makeInstance(Registry::class);
                    $offlineUntil = $registryObject->get('core', 'sys_file_storage-' . $this->‪getUid() . '-offline-until');
                    if ($offlineUntil && $offlineUntil > time()) {
                        $this->‪isOnline = false;
                    } else {
                        $this->‪isOnline = true;
                    }
                }
            }
        }
        return ‪$this->isOnline;
    }
 
    public function ‪autoExtractMetadataEnabled()
    {
        return !empty($this->storageRecord['auto_extract_metadata']);
    }
 
    public function ‪markAsPermanentlyOffline()
    {
        if ($this->‪getUid() > 0) {
            // @todo: move this to the storage repository
            GeneralUtility::makeInstance(ConnectionPool::class)
                ->getConnectionForTable('sys_file_storage')
                ->update(
                    'sys_file_storage',
                    ['is_online' => 0],
                    ['uid' => (int)$this->‪getUid()]
                );
        }
        $this->storageRecord['is_online'] = 0;
        $this->‪isOnline = false;
    }
 
    public function ‪markAsTemporaryOffline()
    {
        $registryObject = GeneralUtility::makeInstance(Registry::class);
        $registryObject->set('core', 'sys_file_storage-' . $this->‪getUid() . '-offline-until', time() + 60 * 5);
        $this->storageRecord['is_online'] = 0;
        $this->‪isOnline = false;
    }
 
    /*********************************
     * User Permissions / File Mounts
     ********************************/
    public function ‪addFileMount($folderIdentifier, $additionalData = [])
    {
        // check for the folder before we add it as a filemount
        if ($this->driver->folderExists($folderIdentifier) === false) {
            // if there is an error, this is important and should be handled
            // as otherwise the user would see the whole storage without any restrictions for the filemounts
            throw new ‪FolderDoesNotExistException('Folder for file mount ' . $folderIdentifier . ' does not exist.', 1334427099);
        }
        $data = $this->driver->getFolderInfoByIdentifier($folderIdentifier);
        $folderObject = $this->‪createFolderObject($data['identifier'], $data['name']);
        // Use the canonical identifier instead of the user provided one!
        $folderIdentifier = $folderObject->getIdentifier();
        if (
            !empty($this->fileMounts[$folderIdentifier])
            && empty($this->fileMounts[$folderIdentifier]['read_only'])
            && !empty($additionalData['read_only'])
        ) {
            // Do not overwrite a regular mount with a read only mount
            return;
        }
        if (empty($additionalData)) {
            $additionalData = [
                'path' => $folderIdentifier,
                'title' => $folderIdentifier,
                'folder' => $folderObject,
            ];
        } else {
            $additionalData['folder'] = $folderObject;
            if (!isset($additionalData['title'])) {
                $additionalData['title'] = $folderIdentifier;
            }
        }
        $this->fileMounts[$folderIdentifier] = $additionalData;
    }
 
    public function ‪getFileMounts()
    {
        return ‪$this->fileMounts;
    }
 
    public function ‪isWithinFileMountBoundaries($subject, $checkWriteAccess = false)
    {
        if (!$this->evaluatePermissions) {
            return true;
        }
        $isWithinFileMount = false;
        if (!$subject) {
            $subject = $this->‪getRootLevelFolder();
        }
        ‪$identifier = $subject->getIdentifier();
 
        // Allow access to processing folder
        if ($this->‪isWithinProcessingFolder(‪$identifier)) {
            $isWithinFileMount = true;
        } else {
            // Check if the identifier of the subject is within at
            // least one of the file mounts
            $writableFileMountAvailable = false;
            foreach ($this->fileMounts as $fileMount) {
                $folder = $fileMount['folder'];
                if ($this->driver->isWithin($folder->‪getIdentifier(), ‪$identifier)) {
                    $isWithinFileMount = true;
                    if (!$checkWriteAccess) {
                        break;
                    }
                    if (empty($fileMount['read_only'])) {
                        $writableFileMountAvailable = true;
                        break;
                    }
                }
            }
            $isWithinFileMount = $checkWriteAccess ? $writableFileMountAvailable : $isWithinFileMount;
        }
        return $isWithinFileMount;
    }
 
    public function ‪setEvaluatePermissions(‪$evaluatePermissions)
    {
        $this->evaluatePermissions = (bool)‪$evaluatePermissions;
    }
 
    public function ‪getEvaluatePermissions()
    {
        return ‪$this->evaluatePermissions;
    }
 
    public function ‪setUserPermissions(array ‪$userPermissions)
    {
        $this->userPermissions = ‪$userPermissions;
    }
 
    public function ‪checkUserActionPermission($action, $type)
    {
        if (!$this->evaluatePermissions) {
            return true;
        }
 
        $allow = false;
        if (!empty($this->userPermissions[strtolower($action) . ucfirst(strtolower($type))])) {
            $allow = true;
        }
 
        return $allow;
    }
 
    public function ‪checkFileActionPermission($action, ‪FileInterface $file)
    {
        $isProcessedFile = $file instanceof ‪ProcessedFile;
        // Check 1: Allow editing meta data of a file if it is in mount boundaries of a writable file mount
        if ($action === 'editMeta') {
            return !$isProcessedFile && $this->‪isWithinFileMountBoundaries($file, true);
        }
        // Check 2: Does the user have permission to perform the action? e.g. "readFile"
        if (!$isProcessedFile && $this->‪checkUserActionPermission($action, 'File') === false) {
            return false;
        }
        // Check 3: No action allowed on files for denied file extensions
        if (!$this->‪checkFileExtensionPermission($file->‪getName())) {
            return false;
        }
        $isReadCheck = false;
        if (in_array($action, ['read', 'copy', 'move', 'replace'], true)) {
            $isReadCheck = true;
        }
        $isWriteCheck = false;
        if (in_array($action, ['add', 'write', 'move', 'rename', 'replace', 'delete'], true)) {
            $isWriteCheck = true;
        }
        // Check 4: Does the user have the right to perform the action?
        // (= is he within the file mount borders)
        if (!$isProcessedFile && !$this->‪isWithinFileMountBoundaries($file, $isWriteCheck)) {
            return false;
        }
 
        $isMissing = false;
        if (!$isProcessedFile && $file instanceof ‪File) {
            $isMissing = $file->isMissing();
        }
 
        if ($this->driver->fileExists($file->‪getIdentifier()) === false) {
            $file->setMissing(true);
            $isMissing = true;
        }
 
        // Check 5: Check the capabilities of the storage (and the driver)
        if ($isWriteCheck && ($isMissing || !$this->‪isWritable())) {
            return false;
        }
 
        // Check 6: "File permissions" of the driver (only when file isn't marked as missing)
        if (!$isMissing) {
            $filePermissions = $this->driver->getPermissions($file->‪getIdentifier());
            if ($isReadCheck && !$filePermissions['r']) {
                return false;
            }
            if ($isWriteCheck && !$filePermissions['w']) {
                return false;
            }
        }
        return true;
    }
 
    public function ‪checkFolderActionPermission($action, Folder $folder = null)
    {
        // Check 1: Does the user have permission to perform the action? e.g. "writeFolder"
        if ($this->‪checkUserActionPermission($action, 'Folder') === false) {
            return false;
        }
 
        // If we do not have a folder here, we cannot do further checks
        if ($folder === null) {
            return true;
        }
 
        $isReadCheck = false;
        if (in_array($action, ['read', 'copy'], true)) {
            $isReadCheck = true;
        }
        $isWriteCheck = false;
        if (in_array($action, ['add', 'move', 'write', 'delete', 'rename'], true)) {
            $isWriteCheck = true;
        }
        // Check 2: Does the user has the right to perform the action?
        // (= is he within the file mount borders)
        if (!$this->‪isWithinFileMountBoundaries($folder, $isWriteCheck)) {
            return false;
        }
        // Check 3: Check the capabilities of the storage (and the driver)
        if ($isReadCheck && !$this->‪isBrowsable()) {
            return false;
        }
        if ($isWriteCheck && !$this->‪isWritable()) {
            return false;
        }
 
        // Check 4: "Folder permissions" of the driver
        $folderPermissions = $this->driver->getPermissions($folder->‪getIdentifier());
        if ($isReadCheck && !$folderPermissions['r']) {
            return false;
        }
        if ($isWriteCheck && !$folderPermissions['w']) {
            return false;
        }
        return true;
    }
 
    protected function ‪checkFileExtensionPermission($fileName)
    {
        $fileName = $this->driver->sanitizeFileName($fileName);
        return GeneralUtility::makeInstance(FileNameValidator::class)->isValid($fileName);
    }
 
    protected function ‪assureFolderReadPermission(Folder $folder = null)
    {
        if (!$this->‪checkFolderActionPermission('read', $folder)) {
            if ($folder === null) {
                throw new InsufficientFolderAccessPermissionsException(
                    'You are not allowed to read folders',
                    1430657869
                );
            }
            throw new InsufficientFolderAccessPermissionsException(
                'You are not allowed to access the given folder: "' . $folder->‪getName() . '"',
                1375955684
            );
        }
    }
 
    protected function ‪assureFolderDeletePermission(Folder $folder, $checkDeleteRecursively)
    {
        // Check user permissions for recursive deletion if it is requested
        if ($checkDeleteRecursively && !$this->‪checkUserActionPermission('recursivedelete', 'Folder')) {
            throw new InsufficientUserPermissionsException('You are not allowed to delete folders recursively', 1377779423);
        }
        // Check user action permission
        if (!$this->‪checkFolderActionPermission('delete', $folder)) {
            throw new InsufficientFolderAccessPermissionsException(
                'You are not allowed to delete the given folder: "' . $folder->getName() . '"',
                1377779039
            );
        }
        // Check if the user has write permissions to folders
        // Would be good if we could check for actual write permissions in the containing folder
        // but we cannot since we have no access to the containing folder of this file.
        if (!$this->‪checkUserActionPermission('write', 'Folder')) {
            throw new ‪InsufficientFolderWritePermissionsException('Writing to folders is not allowed.', 1377779111);
        }
    }
 
    protected function ‪assureFileReadPermission(FileInterface $file)
    {
        if (!$this->‪checkFileActionPermission('read', $file)) {
            throw new InsufficientFileAccessPermissionsException(
                'You are not allowed to access that file: "' . $file->getName() . '"',
                1375955429
            );
        }
        if (!$this->‪checkFileExtensionPermission($file->getName())) {
            throw new ‪IllegalFileExtensionException(
                'You are not allowed to use that file extension. File: "' . $file->getName() . '"',
                1375955430
            );
        }
    }
 
    protected function ‪assureFileWritePermissions(FileInterface $file)
    {
        // Check if user is allowed to write the file and $file is writable
        if (!$this->‪checkFileActionPermission('write', $file)) {
            throw new ‪InsufficientFileWritePermissionsException('Writing to file "' . $file->getIdentifier() . '" is not allowed.', 1330121088);
        }
        if (!$this->‪checkFileExtensionPermission($file->getName())) {
            throw new ‪IllegalFileExtensionException('You are not allowed to edit a file with extension "' . $file->getExtension() . '"', 1366711933);
        }
    }
 
    protected function ‪assureFileReplacePermissions(FileInterface $file)
    {
        // Check if user is allowed to replace the file and $file is writable
        if (!$this->‪checkFileActionPermission('replace', $file)) {
            throw new InsufficientFileWritePermissionsException('Replacing file "' . $file->getIdentifier() . '" is not allowed.', 1436899571);
        }
        // Check if parentFolder is writable for the user
        if (!$this->‪checkFolderActionPermission('write', $file->getParentFolder())) {
            throw new ‪InsufficientFolderWritePermissionsException('You are not allowed to write to the target folder "' . $file->getIdentifier() . '"', 1436899572);
        }
    }
 
    protected function ‪assureFileDeletePermissions(FileInterface $file)
    {
        // Check for disallowed file extensions
        if (!$this->‪checkFileExtensionPermission($file->getName())) {
            throw new IllegalFileExtensionException('You are not allowed to delete a file with extension "' . $file->getExtension() . '"', 1377778916);
        }
        // Check further permissions if file is not a processed file
        if (!$file instanceof ProcessedFile) {
            // Check if user is allowed to delete the file and $file is writable
            if (!$this->‪checkFileActionPermission('delete', $file)) {
                throw new InsufficientFileWritePermissionsException('You are not allowed to delete the file "' . $file->getIdentifier() . '"', 1319550425);
            }
            // Check if the user has write permissions to folders
            // Would be good if we could check for actual write permissions in the containing folder
            // but we cannot since we have no access to the containing folder of this file.
            if (!$this->‪checkUserActionPermission('write', 'Folder')) {
                throw new InsufficientFolderWritePermissionsException('Writing to folders is not allowed.', 1377778702);
            }
        }
    }
 
    protected function ‪assureFileAddPermissions($targetFolder, $targetFileName)
    {
        // Check for a valid file extension
        if (!$this->‪checkFileExtensionPermission($targetFileName)) {
            throw new IllegalFileExtensionException('Extension of file name is not allowed in "' . $targetFileName . '"!', 1322120271);
        }
        // Makes sure the user is allowed to upload
        if (!$this->‪checkUserActionPermission('add', 'File')) {
            throw new InsufficientUserPermissionsException('You are not allowed to add files to this storage "' . $this->‪getUid() . '"', 1376992145);
        }
        // Check if targetFolder is writable
        if (!$this->‪checkFolderActionPermission('write', $targetFolder)) {
            throw new InsufficientFolderWritePermissionsException('You are not allowed to write to the target folder "' . $targetFolder->getIdentifier() . '"', 1322120356);
        }
    }
 
    protected function ‪assureFileUploadPermissions($localFilePath, $targetFolder, $targetFileName, $uploadedFileSize)
    {
        // Makes sure this is an uploaded file
        if (!is_uploaded_file($localFilePath)) {
            throw new UploadException('The upload has failed, no uploaded file found!', 1322110455);
        }
        // Max upload size (kb) for files.
        $maxUploadFileSize = GeneralUtility::getMaxUploadFileSize() * 1024;
        if ($maxUploadFileSize > 0 && $uploadedFileSize >= $maxUploadFileSize) {
            unlink($localFilePath);
            throw new ‪UploadSizeException('The uploaded file exceeds the size-limit of ' . $maxUploadFileSize . ' bytes', 1322110041);
        }
        $this->‪assureFileAddPermissions($targetFolder, $targetFileName);
    }
 
    protected function ‪assureFileMovePermissions(FileInterface $file, Folder $targetFolder, $targetFileName)
    {
        // Check if targetFolder is within this storage
        if ($this->‪getUid() !== $targetFolder->getStorage()->getUid()) {
            throw new \RuntimeException('The target folder is not in the same storage. Target folder given: "' . $targetFolder->getIdentifier() . '"', 1422553107);
        }
        // Check for a valid file extension
        if (!$this->‪checkFileExtensionPermission($targetFileName)) {
            throw new IllegalFileExtensionException('Extension of file name is not allowed in "' . $targetFileName . '"!', 1378243279);
        }
        // Check if user is allowed to move and $file is readable and writable
        if (!$file->getStorage()->checkFileActionPermission('move', $file)) {
            throw new InsufficientUserPermissionsException('You are not allowed to move files to storage "' . $this->‪getUid() . '"', 1319219349);
        }
        // Check if target folder is writable
        if (!$this->‪checkFolderActionPermission('write', $targetFolder)) {
            throw new ‪InsufficientFolderAccessPermissionsException('You are not allowed to write to the target folder "' . $targetFolder->getIdentifier() . '"', 1319219350);
        }
    }
 
    protected function ‪assureFileRenamePermissions(FileInterface $file, $targetFileName)
    {
        // Check if file extension is allowed
        if (!$this->‪checkFileExtensionPermission($targetFileName) || !$this->‪checkFileExtensionPermission($file->getName())) {
            throw new IllegalFileExtensionException('You are not allowed to rename a file with this extension. File given: "' . $file->getName() . '"', 1371466663);
        }
        // Check if user is allowed to rename
        if (!$this->‪checkFileActionPermission('rename', $file)) {
            throw new InsufficientUserPermissionsException('You are not allowed to rename files. File given: "' . $file->getName() . '"', 1319219351);
        }
        // Check if the user is allowed to write to folders
        // Although it would be good to check, we cannot check here if the folder actually is writable
        // because we do not know in which folder the file resides.
        // So we rely on the driver to throw an exception in case the renaming failed.
        if (!$this->‪checkFolderActionPermission('write')) {
            throw new InsufficientFileWritePermissionsException('You are not allowed to write to folders', 1319219352);
        }
    }
 
    protected function ‪assureFileCopyPermissions(‪FileInterface $file, ‪Folder $targetFolder, $targetFileName)
    {
        // Check if targetFolder is within this storage, this should never happen
        if ($this->‪getUid() != $targetFolder->‪getStorage()->‪getUid()) {
            throw new ‪Exception('The operation of the folder cannot be called by this storage "' . $this->‪getUid() . '"', 1319550405);
        }
        // Check if user is allowed to copy
        if (!$file->‪getStorage()->‪checkFileActionPermission('copy', $file)) {
            throw new InsufficientFileReadPermissionsException('You are not allowed to copy the file "' . $file->‪getIdentifier() . '"', 1319550426);
        }
        // Check if targetFolder is writable
        if (!$this->‪checkFolderActionPermission('write', $targetFolder)) {
            throw new InsufficientFolderWritePermissionsException('You are not allowed to write to the target folder "' . $targetFolder->‪getIdentifier() . '"', 1319550435);
        }
        // Check for a valid file extension
        if (!$this->‪checkFileExtensionPermission($targetFileName) || !$this->‪checkFileExtensionPermission($file->‪getName())) {
            throw new IllegalFileExtensionException('You are not allowed to copy a file of that type.', 1319553317);
        }
    }
 
    protected function ‪assureFolderCopyPermissions(‪FolderInterface $folderToCopy, ‪FolderInterface $targetParentFolder)
    {
        // Check if targetFolder is within this storage, this should never happen
        if ($this->‪getUid() !== $targetParentFolder->‪getStorage()->‪getUid()) {
            throw new ‪Exception('The operation of the folder cannot be called by this storage "' . $this->‪getUid() . '"', 1377777624);
        }
        if (!$folderToCopy instanceof Folder) {
            throw new \RuntimeException('The folder "' . $folderToCopy->‪getIdentifier() . '" to copy is not of type folder.', 1384209020);
        }
        // Check if user is allowed to copy and the folder is readable
        if (!$folderToCopy->‪getStorage()->‪checkFolderActionPermission('copy', $folderToCopy)) {
            throw new InsufficientFileReadPermissionsException('You are not allowed to copy the folder "' . $folderToCopy->‪getIdentifier() . '"', 1377777629);
        }
        if (!$targetParentFolder instanceof Folder) {
            throw new \RuntimeException('The target folder "' . $targetParentFolder->‪getIdentifier() . '" is not of type folder.', 1384209021);
        }
        // Check if targetFolder is writable
        if (!$this->‪checkFolderActionPermission('write', $targetParentFolder)) {
            throw new InsufficientFolderWritePermissionsException('You are not allowed to write to the target folder "' . $targetParentFolder->‪getIdentifier() . '"', 1377777635);
        }
    }
 
    protected function ‪assureFolderMovePermissions(‪FolderInterface $folderToMove, ‪FolderInterface $targetParentFolder)
    {
        // Check if targetFolder is within this storage, this should never happen
        if ($this->‪getUid() !== $targetParentFolder->‪getStorage()->‪getUid()) {
            throw new \InvalidArgumentException('Cannot move a folder into a folder that does not belong to this storage.', 1325777289);
        }
        if (!$folderToMove instanceof Folder) {
            throw new \RuntimeException('The folder "' . $folderToMove->‪getIdentifier() . '" to move is not of type Folder.', 1384209022);
        }
        // Check if user is allowed to move and the folder is writable
        // In fact we would need to check if the parent folder of the folder to move is writable also
        // But as of now we cannot extract the parent folder from this folder
        if (!$folderToMove->‪getStorage()->‪checkFolderActionPermission('move', $folderToMove)) {
            throw new InsufficientFileReadPermissionsException('You are not allowed to copy the folder "' . $folderToMove->‪getIdentifier() . '"', 1377778045);
        }
        if (!$targetParentFolder instanceof Folder) {
            throw new \RuntimeException('The target folder "' . $targetParentFolder->‪getIdentifier() . '" is not of type Folder.', 1384209023);
        }
        // Check if targetFolder is writable
        if (!$this->‪checkFolderActionPermission('write', $targetParentFolder)) {
            throw new ‪InsufficientFolderWritePermissionsException('You are not allowed to write to the target folder "' . $targetParentFolder->‪getIdentifier() . '"', 1377778049);
        }
    }
 
    public function ‪sanitizeFileName($fileName, Folder $targetFolder = null)
    {
        $targetFolder = $targetFolder ?: $this->‪getDefaultFolder();
        $fileName = $this->driver->sanitizeFileName($fileName);
 
        // The file name could be changed by an event listener
        $fileName = $this->eventDispatcher->dispatch(
            new SanitizeFileNameEvent($fileName, $targetFolder, ‪$this, $this->driver)
        )->getFileName();
 
        return $fileName;
    }
 
    /********************
     * FILE ACTIONS
     ********************/
    public function ‪addFile($localFilePath, ‪Folder $targetFolder, $targetFileName = '', $conflictMode = ‪DuplicationBehavior::RENAME, $removeOriginal = true)
    {
        $localFilePath = ‪PathUtility::getCanonicalPath($localFilePath);
        // File is not available locally NOR is it an uploaded file
        if (!is_uploaded_file($localFilePath) && !file_exists($localFilePath)) {
            throw new \InvalidArgumentException('File "' . $localFilePath . '" does not exist.', 1319552745);
        }
        $conflictMode = ‪DuplicationBehavior::cast($conflictMode);
        $targetFileName = $this->‪sanitizeFileName($targetFileName ?: ‪PathUtility::basename($localFilePath), $targetFolder);
 
        $targetFileName = $this->eventDispatcher->dispatch(
            new ‪BeforeFileAddedEvent($targetFileName, $localFilePath, $targetFolder, ‪$this, $this->driver)
        )->getFileName();
 
        $this->‪assureFileAddPermissions($targetFolder, $targetFileName);
 
        $replaceExisting = false;
        if ($conflictMode->equals(‪DuplicationBehavior::CANCEL) && ‪$this->driver->fileExistsInFolder($targetFileName, $targetFolder->‪getIdentifier())) {
            throw new ‪ExistingTargetFileNameException('File "' . $targetFileName . '" already exists in folder ' . $targetFolder->‪getIdentifier(), 1322121068);
        }
        if ($conflictMode->equals(‪DuplicationBehavior::RENAME)) {
            $targetFileName = $this->‪getUniqueName($targetFolder, $targetFileName);
        } elseif ($conflictMode->equals(‪DuplicationBehavior::REPLACE) && ‪$this->driver->fileExistsInFolder($targetFileName, $targetFolder->‪getIdentifier())) {
            $replaceExisting = true;
        }
 
        $fileIdentifier = $this->driver->addFile($localFilePath, $targetFolder->‪getIdentifier(), $targetFileName, $removeOriginal);
        $file = $this->‪getFileByIdentifier($fileIdentifier);
 
        if ($replaceExisting && $file instanceof ‪File) {
            $this->‪getIndexer()->‪updateIndexEntry($file);
        }
 
        $this->eventDispatcher->dispatch(
            new ‪AfterFileAddedEvent($file, $targetFolder)
        );
        return $file;
    }
 
    public function ‪updateProcessedFile($localFilePath, ‪ProcessedFile $processedFile, ‪Folder ‪$processingFolder = null)
    {
        if (!file_exists($localFilePath)) {
            throw new \InvalidArgumentException('File "' . $localFilePath . '" does not exist.', 1319552746);
        }
        if (‪$processingFolder === null) {
            ‪$processingFolder = $this->‪getProcessingFolder($processedFile->‪getOriginalFile());
        }
        $fileIdentifier = $this->driver->addFile($localFilePath, ‪$processingFolder->‪getIdentifier(), $processedFile->‪getName());
        // @todo check if we have to update the processed file other then the identifier
        $processedFile->‪setIdentifier($fileIdentifier);
        return $processedFile;
    }
 
    public function ‪hashFile(FileInterface $fileObject, $hash)
    {
        return $this->‪hashFileByIdentifier($fileObject->getIdentifier(), $hash);
    }
 
    public function ‪hashFileByIdentifier($fileIdentifier, $hash)
    {
        $hash = $this->driver->hash($fileIdentifier, $hash);
        if (!is_string($hash) || $hash === '') {
            throw new ‪InvalidHashException('Hash has to be non-empty string.', 1551950301);
        }
        return $hash;
    }
 
    public function ‪hashFileIdentifier($file)
    {
        if (is_object($file) && $file instanceof FileInterface) {
            $file = $file->‪getIdentifier();
        }
        return $this->driver->hashIdentifier($file);
    }
 
    public function ‪getPublicUrl(ResourceInterface $resourceObject)
    {
        ‪$publicUrl = null;
        if ($this->‪isOnline()) {
            // Pre-process the public URL by an accordant event
            $event = new GeneratePublicUrlForResourceEvent($resourceObject, ‪$this, $this->driver);
            ‪$publicUrl = $this->eventDispatcher->dispatch($event)->getPublicUrl();
            if (
                ‪$publicUrl === null
                && $resourceObject instanceof File
                && ($helper = GeneralUtility::makeInstance(OnlineMediaHelperRegistry::class)->getOnlineMediaHelper($resourceObject)) !== false
            ) {
                ‪$publicUrl = $helper->getPublicUrl($resourceObject);
            }
 
            // If an event listener did not handle the URL generation, use the default way to determine public URL
            if (‪$publicUrl === null) {
                if ($this->‪hasCapability(self::CAPABILITY_PUBLIC)) {
                    ‪$publicUrl = $this->driver->getPublicUrl($resourceObject->getIdentifier());
                }
 
                if (‪$publicUrl === null && $resourceObject instanceof FileInterface) {
                    $queryParameterArray = ['eID' => 'dumpFile', 't' => ''];
                    if ($resourceObject instanceof File) {
                        $queryParameterArray['f'] = $resourceObject->getUid();
                        $queryParameterArray['t'] = 'f';
                    } elseif ($resourceObject instanceof ProcessedFile) {
                        $queryParameterArray['p'] = $resourceObject->getUid();
                        $queryParameterArray['t'] = 'p';
                    }
 
                    $queryParameterArray['token'] = ‪GeneralUtility::hmac(implode('|', $queryParameterArray), 'resourceStorageDumpFile');
                    ‪$publicUrl = GeneralUtility::locationHeaderUrl(‪PathUtility::getAbsoluteWebPath(‪Environment::getPublicPath() . '/index.php'));
                    ‪$publicUrl .= '?' . http_build_query($queryParameterArray, '', '&', PHP_QUERY_RFC3986);
                }
            }
        }
        return ‪$publicUrl;
    }
 
    public function ‪processFile(FileInterface $fileObject, $context, array ‪$configuration)
    {
        if ($fileObject->getStorage() !== ‪$this) {
            throw new \InvalidArgumentException('Cannot process files of foreign storage', 1353401835);
        }
        $processedFile = $this->‪getFileProcessingService()->‪processFile($fileObject, ‪$this, $context, ‪$configuration);
 
        return $processedFile;
    }
 
    public function ‪getFileForLocalProcessing(FileInterface $fileObject, $writable = true)
    {
        $filePath = $this->driver->getFileForLocalProcessing($fileObject->getIdentifier(), $writable);
        return $filePath;
    }
 
    public function ‪getFile(‪$identifier)
    {
        $file = $this->‪getFileByIdentifier(‪$identifier);
        if (!$this->driver->fileExists(‪$identifier)) {
            $file->setMissing(true);
        }
        return $file;
    }
 
    public function ‪getFileByIdentifier(string $fileIdentifier)
    {
        if (!$this->‪isWithinProcessingFolder($fileIdentifier)) {
            $fileData = $this->‪getFileIndexRepository()->‪findOneByStorageAndIdentifier(‪$this, $fileIdentifier);
            if ($fileData === false) {
                return $this->‪getIndexer()->‪createIndexEntry($fileIdentifier);
            }
            return $this->‪getResourceFactoryInstance()->getFileObject($fileData['uid'], $fileData);
        }
        return $this->‪getProcessedFileRepository()->findByStorageAndIdentifier(‪$this, $fileIdentifier);
    }
 
    protected function ‪getProcessedFileRepository(): ‪ProcessedFileRepository
    {
        return GeneralUtility::makeInstance(ProcessedFileRepository::class);
    }
 
    public function ‪getFileInfo(FileInterface $fileObject)
    {
        return $this->‪getFileInfoByIdentifier($fileObject->getIdentifier());
    }
 
    public function ‪getFileInfoByIdentifier(‪$identifier, array $propertiesToExtract = [])
    {
        return $this->driver->getFileInfoByIdentifier(‪$identifier, $propertiesToExtract);
    }
 
    public function ‪unsetFileAndFolderNameFilters()
    {
        $this->‪fileAndFolderNameFilters = [];
    }
 
    public function ‪resetFileAndFolderNameFiltersToDefault()
    {
        $this->‪fileAndFolderNameFilters = ‪$GLOBALS['TYPO3_CONF_VARS']['SYS']['fal']['defaultFilterCallbacks'];
    }
 
    public function getImportExportFilter(): array
    {
        $filter = GeneralUtility::makeInstance(ImportExportFilter::class);
 
        return [$filter, 'filterImportExportFilesAndFolders'];
    }
 
    public function ‪getFileAndFolderNameFilters()
    {
        return array_merge($this->‪fileAndFolderNameFilters, [$this->getImportExportFilter()]);
    }
 
    public function setFileAndFolderNameFilters(array $filters)
    {
        $this->‪fileAndFolderNameFilters = $filters;
        return ‪$this;
    }
 
    public function ‪addFileAndFolderNameFilter($filter)
    {
        $this->‪fileAndFolderNameFilters[] = $filter;
    }
 
    public function ‪getFolderIdentifierFromFileIdentifier($fileIdentifier)
    {
        return $this->driver->getParentFolderIdentifierOfIdentifier($fileIdentifier);
    }
 
    public function ‪getFileInFolder($fileName, Folder $folder)
    {
        ‪$identifier = $this->driver->getFileInFolder($fileName, $folder->getIdentifier());
        return $this->‪getFileByIdentifier(‪$identifier);
    }
 
    public function ‪getFilesInFolder(Folder $folder, $start = 0, $maxNumberOfItems = 0, $useFilters = true, $recursive = false, $sort = '', $sortRev = false)
    {
        $this->‪assureFolderReadPermission($folder);
 
        $rows = $this->‪getFileIndexRepository()->‪findByFolder($folder);
 
        $filters = $useFilters == true ? $this->‪getFileAndFolderNameFilters() : [];
        $fileIdentifiers = array_values($this->driver->getFilesInFolder($folder->getIdentifier(), $start, $maxNumberOfItems, $recursive, $filters, $sort, $sortRev));
 
        $items = [];
        foreach ($fileIdentifiers as ‪$identifier) {
            if (isset($rows[‪$identifier])) {
                $fileObject = $this->‪getFileFactory()->‪getFileObject($rows[‪$identifier]['uid'], $rows[‪$identifier]);
            } else {
                $fileObject = $this->‪getFileByIdentifier($identifier);
            }
            if ($fileObject instanceof FileInterface) {
                $key = $fileObject->getName();
                while (isset($items[$key])) {
                    $key .= 'z';
                }
                $items[$key] = $fileObject;
            }
        }
 
        return $items;
    }
 
    public function ‪getFileIdentifiersInFolder($folderIdentifier, $useFilters = true, $recursive = false)
    {
        $filters = $useFilters == true ? $this->‪getFileAndFolderNameFilters() : [];
        return $this->driver->getFilesInFolder($folderIdentifier, 0, 0, $recursive, $filters);
    }
 
    public function ‪countFilesInFolder(Folder $folder, $useFilters = true, $recursive = false)
    {
        $this->‪assureFolderReadPermission($folder);
        $filters = $useFilters ? $this->‪getFileAndFolderNameFilters() : [];
        return $this->driver->countFilesInFolder($folder->getIdentifier(), $recursive, $filters);
    }
 
    public function ‪getFolderIdentifiersInFolder($folderIdentifier, $useFilters = true, $recursive = false)
    {
        $filters = $useFilters == true ? $this->‪getFileAndFolderNameFilters() : [];
        return $this->driver->getFoldersInFolder($folderIdentifier, 0, 0, $recursive, $filters);
    }
 
    public function ‪hasFile(‪$identifier)
    {
        // Allow if identifier is in processing folder
        if (!$this->‪isWithinProcessingFolder($identifier)) {
            $this->‪assureFolderReadPermission();
        }
        return $this->driver->fileExists(‪$identifier);
    }
 
    public function ‪getProcessingFolders()
    {
        if ($this->processingFolders === null) {
            $this->processingFolders = [];
            $this->processingFolders[] = $this->‪getProcessingFolder();
            $storageRepository = GeneralUtility::makeInstance(StorageRepository::class);
            $allStorages = $storageRepository->findAll();
            foreach ($allStorages as $storage) {
                // To circumvent the permission check of the folder, we use the factory to create it "manually" instead of directly using $storage->getProcessingFolder()
                // See #66695 for details
                [$storageUid, $processingFolderIdentifier] = array_pad(‪GeneralUtility::trimExplode(':', $storage->getStorageRecord()['processingfolder']), 2, null);
                if (empty($processingFolderIdentifier) || (int)$storageUid !== $this->‪getUid()) {
                    continue;
                }
                $potentialProcessingFolder = $this->‪createFolderObject($processingFolderIdentifier, $processingFolderIdentifier);
                if ($potentialProcessingFolder->getStorage() === ‪$this && $potentialProcessingFolder->getIdentifier() !== ‪$this->getProcessingFolder()->getIdentifier()) {
                    $this->processingFolders[] = $potentialProcessingFolder;
                }
            }
        }
 
        return ‪$this->processingFolders;
    }
 
    public function ‪isProcessingFolder(Folder $folder)
    {
        $isProcessingFolder = false;
        foreach ($this->‪getProcessingFolders() as ‪$processingFolder) {
            if ($folder->getCombinedIdentifier() === ‪$processingFolder->‪getCombinedIdentifier()) {
                $isProcessingFolder = true;
                break;
            }
        }
        return $isProcessingFolder;
    }
 
    public function ‪hasFileInFolder($fileName, ‪Folder $folder)
    {
        $this->‪assureFolderReadPermission($folder);
        return $this->driver->fileExistsInFolder($fileName, $folder->‪getIdentifier());
    }
 
    public function ‪getFileContents($file)
    {
        $this->‪assureFileReadPermission($file);
        return $this->driver->getFileContents($file->‪getIdentifier());
    }
 
    public function ‪streamFile(
        FileInterface $file,
        bool $asDownload = false,
        string $alternativeFilename = null,
        string $overrideMimeType = null
    ): ResponseInterface {
        if (!$this->driver instanceof StreamableDriverInterface) {
            return $this->‪getPseudoStream($file, $asDownload, $alternativeFilename, $overrideMimeType);
        }
 
        $properties = [
            'as_download' => $asDownload,
            'filename_overwrite' => $alternativeFilename,
            'mimetype_overwrite' => $overrideMimeType,
        ];
        return $this->driver->streamFile($file->getIdentifier(), $properties);
    }
 
    protected function ‪getPseudoStream(
        ‪FileInterface $file,
        bool $asDownload = false,
        string $alternativeFilename = null,
        string $overrideMimeType = null
    ) {
        $downloadName = $alternativeFilename ?: $file->‪getName();
        $contentDisposition = $asDownload ? 'attachment' : 'inline';
 
        $stream = new ‪FalDumpFileContentsDecoratorStream($file->‪getIdentifier(), ‪$this->driver, $file->‪getSize());
        $fileInfo = $this->driver->getFileInfoByIdentifier($file->‪getIdentifier(), ['mtime']);
        $headers = [
            'Content-Disposition' => $contentDisposition . '; filename="' . $downloadName . '"',
            'Content-Type' => $overrideMimeType ?: $file->‪getMimeType(),
            'Content-Length' => (string)$file->‪getSize(),
            'Last-Modified' => gmdate('D, d M Y H:i:s', array_pop($fileInfo)) . ' GMT',
            // Cache-Control header is needed here to solve an issue with browser IE8 and lower
            // See for more information: http://support.microsoft.com/kb/323308
            'Cache-Control' => '',
        ];
 
        return new ‪Response($stream, 200, $headers);
    }
 
    public function ‪setFileContents(‪AbstractFile $file, $contents)
    {
        // Check if user is allowed to edit
        $this->‪assureFileWritePermissions($file);
        $this->eventDispatcher->dispatch(
            new ‪BeforeFileContentsSetEvent($file, $contents)
        );
        // Call driver method to update the file and update file index entry afterwards
        $result = $this->driver->setFileContents($file->‪getIdentifier(), $contents);
        if ($file instanceof ‪File) {
            $this->‪getIndexer()->‪updateIndexEntry($file);
        }
        $this->eventDispatcher->dispatch(
            new AfterFileContentsSetEvent($file, $contents)
        );
        return $result;
    }
 
    public function ‪createFile($fileName, ‪Folder $targetFolderObject)
    {
        $this->‪assureFileAddPermissions($targetFolderObject, $fileName);
        $this->eventDispatcher->dispatch(
            new ‪BeforeFileCreatedEvent($fileName, $targetFolderObject)
        );
        $newFileIdentifier = $this->driver->createFile($fileName, $targetFolderObject->‪getIdentifier());
        $this->eventDispatcher->dispatch(
            new ‪AfterFileCreatedEvent($newFileIdentifier, $targetFolderObject)
        );
        return $this->‪getFileByIdentifier($newFileIdentifier);
    }
 
    public function ‪deleteFile($fileObject)
    {
        $this->‪assureFileDeletePermissions($fileObject);
 
        $this->eventDispatcher->dispatch(
            new ‪BeforeFileDeletedEvent($fileObject)
        );
        $deleted = true;
 
        if ($this->driver->fileExists($fileObject->getIdentifier())) {
            // Disable permission check to find nearest recycler and move file without errors
            $currentPermissions = ‪$this->evaluatePermissions;
            $this->evaluatePermissions = false;
 
            $recyclerFolder = $this->‪getNearestRecyclerFolder($fileObject);
            if ($recyclerFolder === null) {
                $result = $this->driver->deleteFile($fileObject->getIdentifier());
            } else {
                $result = $this->‪moveFile($fileObject, $recyclerFolder);
                $deleted = false;
            }
 
            $this->evaluatePermissions = $currentPermissions;
 
            if (!$result) {
                throw new FileOperationErrorException('Deleting the file "' . $fileObject->getIdentifier() . '\' failed.', 1329831691);
            }
        }
        // Mark the file object as deleted
        if ($deleted && $fileObject instanceof AbstractFile) {
            $fileObject->setDeleted();
        }
 
        $this->eventDispatcher->dispatch(
            new AfterFileDeletedEvent($fileObject)
        );
 
        return true;
    }
 
    public function copyFile(FileInterface $file, Folder $targetFolder, $targetFileName = null, $conflictMode = DuplicationBehavior::RENAME)
    {
        $conflictMode = DuplicationBehavior::cast($conflictMode);
        if ($targetFileName === null) {
            $targetFileName = $file->getName();
        }
        $sanitizedTargetFileName = $this->driver->sanitizeFileName($targetFileName);
        $this->assureFileCopyPermissions($file, $targetFolder, $sanitizedTargetFileName);
 
        $this->eventDispatcher->dispatch(
            new BeforeFileCopiedEvent($file, $targetFolder)
        );
 
        // File exists and we should abort, let's abort
        ‪if ($conflictMode->equals(‪DuplicationBehavior::CANCEL) && $targetFolder->‪hasFile($sanitizedTargetFileName)) {
            throw new ExistingTargetFileNameException('The target file already exists.', 1320291064);
        }
        // File exists and we should find another name, let's find another one
        ‪if ($conflictMode->equals(‪DuplicationBehavior::RENAME) && $targetFolder->‪hasFile($sanitizedTargetFileName)) {
            $sanitizedTargetFileName = $this->getUniqueName($targetFolder, $sanitizedTargetFileName);
        }
        $sourceStorage = $file->‪getStorage();
        // Call driver method to create a new file from an existing file object,
        // and return the new file object
        ‪if ($sourceStorage === ‪$this) {
            $newFileObjectIdentifier = $this->driver->copyFileWithinStorage($file->‪getIdentifier(), $targetFolder->‪getIdentifier(), $sanitizedTargetFileName);
        } else {
            $tempPath = $file->‪getForLocalProcessing();
            $newFileObjectIdentifier = $this->driver->addFile($tempPath, $targetFolder->‪getIdentifier(), $sanitizedTargetFileName);
        }
        $newFileObject = $this->‪getFileByIdentifier($newFileObjectIdentifier);
 
        $this->eventDispatcher->dispatch(
            new AfterFileCopiedEvent($file, $targetFolder, $newFileObjectIdentifier, $newFileObject)
        );
        return $newFileObject;
    }
 
    public function ‪moveFile($file, $targetFolder, $targetFileName = null, $conflictMode = ‪DuplicationBehavior::RENAME)
    {
        $conflictMode = ‪DuplicationBehavior::cast($conflictMode);
        if ($targetFileName === null) {
            $targetFileName = $file->‪getName();
        }
        $originalFolder = $file->‪getParentFolder();
        $sanitizedTargetFileName = $this->driver->sanitizeFileName($targetFileName);
        $this->‪assureFileMovePermissions($file, $targetFolder, $sanitizedTargetFileName);
        if ($targetFolder->‪hasFile($sanitizedTargetFileName)) {
            // File exists and we should abort, let's abort
            if ($conflictMode->equals(‪DuplicationBehavior::RENAME)) {
                $sanitizedTargetFileName = $this->‪getUniqueName($targetFolder, $sanitizedTargetFileName);
            } elseif ($conflictMode->equals(‪DuplicationBehavior::CANCEL)) {
                throw new ExistingTargetFileNameException('The target file already exists', 1329850997);
            }
        }
        $this->eventDispatcher->dispatch(
            new BeforeFileMovedEvent($file, $targetFolder, $sanitizedTargetFileName)
        );
        $sourceStorage = $file->‪getStorage();
        // Call driver method to move the file and update the index entry
        try {
            if ($sourceStorage === ‪$this) {
                $newIdentifier = $this->driver->moveFileWithinStorage($file->‪getIdentifier(), $targetFolder->‪getIdentifier(), $sanitizedTargetFileName);
                if (!$file instanceof AbstractFile) {
                    throw new \RuntimeException('The given file is not of type AbstractFile.', 1384209025);
                }
                $file->‪updateProperties(['identifier' => $newIdentifier]);
            } else {
                $tempPath = $file->‪getForLocalProcessing();
                $newIdentifier = $this->driver->addFile($tempPath, $targetFolder->‪getIdentifier(), $sanitizedTargetFileName);
 
                // Disable permission check to find nearest recycler and move file without errors
                $currentPermissions = $sourceStorage->evaluatePermissions;
                $sourceStorage->evaluatePermissions = false;
 
                $recyclerFolder = $sourceStorage->getNearestRecyclerFolder($file);
                if ($recyclerFolder === null) {
                    $sourceStorage->driver->deleteFile($file->‪getIdentifier());
                } else {
                    $sourceStorage->moveFile($file, $recyclerFolder);
                }
                $sourceStorage->evaluatePermissions = $currentPermissions;
                if ($file instanceof File) {
                    $file->‪updateProperties(['storage' => $this->‪getUid(), 'identifier' => $newIdentifier]);
                }
            }
            $this->‪getIndexer()->‪updateIndexEntry($file);
        } catch (\‪TYPO3\CMS\Core\Exception $e) {
            echo $e->getMessage();
        }
        $this->eventDispatcher->dispatch(
            new ‪AfterFileMovedEvent($file, $targetFolder, $originalFolder)
        );
        return $file;
    }
 
    public function ‪renameFile($file, $targetFileName, $conflictMode = ‪DuplicationBehavior::RENAME)
    {
        // The name should be different from the current.
        if ($file->‪getName() === $targetFileName) {
            return $file;
        }
        $sanitizedTargetFileName = $this->driver->sanitizeFileName($targetFileName);
        $this->‪assureFileRenamePermissions($file, $sanitizedTargetFileName);
        $this->eventDispatcher->dispatch(
            new BeforeFileRenamedEvent($file, $sanitizedTargetFileName)
        );
 
        $conflictMode = ‪DuplicationBehavior::cast($conflictMode);
 
        // Call driver method to rename the file and update the index entry
        try {
            $newIdentifier = $this->driver->renameFile($file->‪getIdentifier(), $sanitizedTargetFileName);
            if ($file instanceof File) {
                $file->‪updateProperties(['identifier' => $newIdentifier]);
            }
            $this->‪getIndexer()->‪updateIndexEntry($file);
        } catch (ExistingTargetFileNameException $exception) {
            if ($conflictMode->equals(‪DuplicationBehavior::RENAME)) {
                $newName = $this->‪getUniqueName($file->‪getParentFolder(), $sanitizedTargetFileName);
                $file = $this->‪renameFile($file, $newName);
            } elseif ($conflictMode->equals(‪DuplicationBehavior::CANCEL)) {
                throw $exception;
            } elseif ($conflictMode->equals(‪DuplicationBehavior::REPLACE)) {
                $sourceFileIdentifier = substr($file->‪getCombinedIdentifier(), 0, (int)strrpos($file->‪getCombinedIdentifier(), '/') + 1) . $sanitizedTargetFileName;
                $sourceFile = $this->‪getResourceFactoryInstance()->getFileObjectFromCombinedIdentifier($sourceFileIdentifier);
                $file = $this->‪replaceFile($sourceFile, ‪Environment::getPublicPath() . '/' . $file->‪getPublicUrl());
            }
        } catch (\RuntimeException $e) {
        }
 
        $this->eventDispatcher->dispatch(
            new AfterFileRenamedEvent($file, $sanitizedTargetFileName)
        );
 
        return $file;
    }
 
    public function ‪replaceFile(‪FileInterface $file, $localFilePath)
    {
        $this->‪assureFileReplacePermissions($file);
        if (!file_exists($localFilePath)) {
            throw new \InvalidArgumentException('File "' . $localFilePath . '" does not exist.', 1325842622);
        }
        $this->eventDispatcher->dispatch(
            new BeforeFileReplacedEvent($file, $localFilePath)
        );
        $this->driver->replaceFile($file->‪getIdentifier(), $localFilePath);
        if ($file instanceof File) {
            $this->‪getIndexer()->‪updateIndexEntry($file);
        }
        $this->eventDispatcher->dispatch(
            new ‪AfterFileReplacedEvent($file, $localFilePath)
        );
        return $file;
    }
 
    public function ‪addUploadedFile(array|‪UploadedFile $uploadedFileData, ‪Folder $targetFolder = null, $targetFileName = null, $conflictMode = ‪DuplicationBehavior::CANCEL)
    {
        $conflictMode = ‪DuplicationBehavior::cast($conflictMode);
        if ($uploadedFileData instanceof ‪UploadedFile) {
            $localFilePath = $uploadedFileData->‪getTemporaryFileName();
            if ($targetFileName === null) {
                $targetFileName = $uploadedFileData->‪getClientFilename();
            }
            $size = $uploadedFileData->‪getSize();
        } else {
            $localFilePath = $uploadedFileData['tmp_name'];
            if ($targetFileName === null) {
                $targetFileName = $uploadedFileData['name'];
            }
            $size = $uploadedFileData['size'];
        }
        if ($targetFolder === null) {
            $targetFolder = $this->‪getDefaultFolder();
        }
 
        $targetFileName = $this->driver->sanitizeFileName($targetFileName);
 
        $this->‪assureFileUploadPermissions($localFilePath, $targetFolder, $targetFileName, $size);
        if ($this->‪hasFileInFolder($targetFileName, $targetFolder) && $conflictMode->equals(‪DuplicationBehavior::REPLACE)) {
            $file = $this->‪getFileInFolder($targetFileName, $targetFolder);
            $resultObject = $this->‪replaceFile($file, $localFilePath);
        } else {
            $resultObject = $this->‪addFile($localFilePath, $targetFolder, $targetFileName, (string)$conflictMode);
        }
        return $resultObject;
    }
 
    /********************
     * FOLDER ACTIONS
     ********************/
    protected function ‪getAllFileObjectsInFolder(Folder $folder)
    {
        $files = [];
        $folderQueue = [$folder];
        while (!empty($folderQueue)) {
            $folder = array_shift($folderQueue);
            foreach ($folder->getSubfolders() as $subfolder) {
                $folderQueue[] = $subfolder;
            }
            foreach ($folder->getFiles() as $file) {
                $files[$file->getIdentifier()] = $file;
            }
        }
 
        return $files;
    }
 
    public function ‪moveFolder(Folder $folderToMove, Folder $targetParentFolder, $newFolderName = null, $conflictMode = ‪DuplicationBehavior::RENAME)
    {
        // @todo add tests
        $this->‪assureFolderMovePermissions($folderToMove, $targetParentFolder);
        $sourceStorage = $folderToMove->getStorage();
        $sanitizedNewFolderName = $this->driver->sanitizeFileName($newFolderName ?: $folderToMove->getName());
        // @todo check if folder already exists in $targetParentFolder, handle this conflict then
        $this->eventDispatcher->dispatch(
            new BeforeFolderMovedEvent($folderToMove, $targetParentFolder, $sanitizedNewFolderName)
        );
        // Get all file objects now so we are able to update them after moving the folder
        $fileObjects = $this->‪getAllFileObjectsInFolder($folderToMove);
        if ($sourceStorage === ‪$this) {
            if ($this->‪isWithinFolder($folderToMove, $targetParentFolder)) {
                throw new InvalidTargetFolderException(
                    sprintf(
                        'Cannot move folder "%s" into target folder "%s", because the target folder is already within the folder to be moved!',
                        $folderToMove->getName(),
                        $targetParentFolder->getName()
                    ),
                    1422723050
                );
            }
            $fileMappings = $this->driver->moveFolderWithinStorage($folderToMove->getIdentifier(), $targetParentFolder->getIdentifier(), $sanitizedNewFolderName);
        } else {
            $fileMappings = $this->‪moveFolderBetweenStorages($folderToMove, $targetParentFolder, $sanitizedNewFolderName);
        }
        // Update the identifier and storage of all file objects
        foreach ($fileObjects as $oldIdentifier => $fileObject) {
            $newIdentifier = $fileMappings[$oldIdentifier];
            $fileObject->updateProperties(['storage' => $this->‪getUid(), 'identifier' => $newIdentifier]);
            $this->‪getIndexer()->‪updateIndexEntry($fileObject);
        }
        $returnObject = $this->‪getFolder($fileMappings[$folderToMove->getIdentifier()]);
 
        $this->eventDispatcher->dispatch(
            new ‪AfterFolderMovedEvent($folderToMove, $targetParentFolder, $returnObject)
        );
        return $returnObject;
    }
 
    protected function ‪moveFolderBetweenStorages(‪Folder $folderToMove, ‪Folder $targetParentFolder, $newFolderName)
    {
        throw new ‪NotImplementedMethodException('Not yet implemented', 1476046361);
    }
 
    public function ‪copyFolder(‪FolderInterface $folderToCopy, ‪FolderInterface $targetParentFolder, $newFolderName = null, $conflictMode = ‪DuplicationBehavior::RENAME)
    {
        $conflictMode = ‪DuplicationBehavior::cast($conflictMode);
        $this->‪assureFolderCopyPermissions($folderToCopy, $targetParentFolder);
        $returnObject = null;
        $sanitizedNewFolderName = $this->driver->sanitizeFileName($newFolderName ?: $folderToCopy->‪getName());
        if ($folderToCopy instanceof ‪Folder && $targetParentFolder instanceof ‪Folder) {
            $this->eventDispatcher->dispatch(
                new ‪BeforeFolderCopiedEvent($folderToCopy, $targetParentFolder, $sanitizedNewFolderName)
            );
        }
        if ($conflictMode->equals(‪DuplicationBehavior::CANCEL) && ($targetParentFolder->hasFolder($sanitizedNewFolderName) || $targetParentFolder->hasFile($sanitizedNewFolderName))) {
            throw new InvalidTargetFolderException(
                sprintf(
                    'Cannot copy folder "%s" into target folder "%s", because there is already a folder or file with that name in the target folder!',
                    $sanitizedNewFolderName,
                    $targetParentFolder->‪getIdentifier()
                ),
                1422723059
            );
        }
        // Folder exists and we should find another name, let's find another one
        if ($conflictMode->equals(‪DuplicationBehavior::RENAME) && ($targetParentFolder->hasFolder($sanitizedNewFolderName) || $targetParentFolder->hasFile($sanitizedNewFolderName))) {
            $sanitizedNewFolderName = $this->‪getUniqueName($targetParentFolder, $sanitizedNewFolderName);
        }
        $sourceStorage = $folderToCopy->‪getStorage();
        // call driver method to move the file
        // that also updates the file object properties
        if ($sourceStorage === ‪$this) {
            $this->driver->copyFolderWithinStorage($folderToCopy->‪getIdentifier(), $targetParentFolder->‪getIdentifier(), $sanitizedNewFolderName);
            $returnObject = $this->‪getFolder($targetParentFolder->getSubfolder($sanitizedNewFolderName)->‪getIdentifier());
        } else {
            $this->‪copyFolderBetweenStorages($folderToCopy, $targetParentFolder, $sanitizedNewFolderName);
        }
        if ($folderToCopy instanceof ‪Folder && $targetParentFolder instanceof ‪Folder) {
            $this->eventDispatcher->dispatch(
                new ‪AfterFolderCopiedEvent($folderToCopy, $targetParentFolder, $returnObject)
            );
        }
        return $returnObject;
    }
 
    protected function ‪copyFolderBetweenStorages(‪FolderInterface $folderToCopy, ‪FolderInterface $targetParentFolder, $newFolderName)
    {
        throw new ‪NotImplementedMethodException('Not yet implemented.', 1476046386);
    }
 
    public function ‪renameFolder($folderObject, $newName)
    {
        // Renaming the folder should check if the parent folder is writable
        // We cannot do this however because we cannot extract the parent folder from a folder currently
        if (!$this->‪checkFolderActionPermission('rename', $folderObject)) {
            throw new ‪InsufficientUserPermissionsException('You are not allowed to rename the folder "' . $folderObject->getIdentifier() . '\'', 1357811441);
        }
 
        $sanitizedNewName = $this->driver->sanitizeFileName($newName);
        if ($this->driver->folderExistsInFolder($sanitizedNewName, $folderObject->getIdentifier())) {
            throw new \InvalidArgumentException('The folder ' . $sanitizedNewName . ' already exists in folder ' . $folderObject->getIdentifier(), 1325418870);
        }
        $this->eventDispatcher->dispatch(
            new BeforeFolderRenamedEvent($folderObject, $sanitizedNewName)
        );
        $fileObjects = $this->‪getAllFileObjectsInFolder($folderObject);
        $fileMappings = $this->driver->renameFolder($folderObject->getIdentifier(), $sanitizedNewName);
        // Update the identifier of all file objects
        foreach ($fileObjects as $oldIdentifier => $fileObject) {
            $newIdentifier = $fileMappings[$oldIdentifier];
            $fileObject->updateProperties(['identifier' => $newIdentifier]);
            $this->‪getIndexer()->‪updateIndexEntry($fileObject);
        }
        $returnObject = $this->‪getFolder($fileMappings[$folderObject->getIdentifier()]);
 
        $this->eventDispatcher->dispatch(
            new AfterFolderRenamedEvent($returnObject, $folderObject)
        );
        return $returnObject;
    }
 
    public function ‪deleteFolder($folderObject, $deleteRecursively = false)
    {
        $isEmpty = $this->driver->isFolderEmpty($folderObject->getIdentifier());
        $this->‪assureFolderDeletePermission($folderObject, $deleteRecursively && !$isEmpty);
        if (!$isEmpty && !$deleteRecursively) {
            throw new \RuntimeException('Could not delete folder "' . $folderObject->getIdentifier() . '" because it is not empty.', 1325952534);
        }
 
        $this->eventDispatcher->dispatch(
            new BeforeFolderDeletedEvent($folderObject)
        );
 
        foreach ($this->‪getFilesInFolder($folderObject, 0, 0, false, $deleteRecursively) as $file) {
            $this->‪deleteFile($file);
        }
 
        $result = $this->driver->deleteFolder($folderObject->getIdentifier(), $deleteRecursively);
 
        $this->eventDispatcher->dispatch(
            new ‪AfterFolderDeletedEvent($folderObject, $result)
        );
        return $result;
    }
 
    public function ‪getFolderInFolder($folderName, ‪Folder $parentFolder, $returnInaccessibleFolderObject = false)
    {
        $folderIdentifier = $this->driver->getFolderInFolder($folderName, $parentFolder->‪getIdentifier());
        return $this->‪getFolder($folderIdentifier, $returnInaccessibleFolderObject);
    }
 
    public function getFoldersInFolder(‪Folder $folder, $start = 0, $maxNumberOfItems = 0, $useFilters = true, $recursive = false, $sort = '', $sortRev = false)
    {
        $filters = $useFilters == true ? $this->‪getFileAndFolderNameFilters() : [];
 
        ‪$folderIdentifiers = $this->driver->getFoldersInFolder($folder->‪getIdentifier(), $start, $maxNumberOfItems, $recursive, $filters, $sort, $sortRev);
 
        // Exclude processing folders
        foreach ($this->‪getProcessingFolders() as ‪$processingFolder) {
            $processingIdentifier = ‪$processingFolder->‪getIdentifier();
            if (isset(‪$folderIdentifiers[$processingIdentifier])) {
                unset(‪$folderIdentifiers[$processingIdentifier]);
            }
        }
 
        ‪$folders = [];
        foreach (‪$folderIdentifiers as $folderIdentifier) {
            // The folder identifier can also be an int-like string, resulting in int array keys.
            ‪$folders[$folderIdentifier] = $this->‪getFolder($folderIdentifier, true);
        }
        return ‪$folders;
    }
 
    public function ‪countFoldersInFolder(Folder $folder, $useFilters = true, $recursive = false)
    {
        $this->‪assureFolderReadPermission($folder);
        $filters = $useFilters ? $this->‪getFileAndFolderNameFilters() : [];
        return $this->driver->countFoldersInFolder($folder->getIdentifier(), $recursive, $filters);
    }
 
    public function ‪hasFolder(‪$identifier)
    {
        $this->‪assureFolderReadPermission();
        return $this->driver->folderExists(‪$identifier);
    }
 
    public function ‪hasFolderInFolder($folderName, Folder $folder)
    {
        $this->‪assureFolderReadPermission($folder);
        return $this->driver->folderExistsInFolder($folderName, $folder->getIdentifier());
    }
 
    public function ‪createFolder($folderName, ‪Folder $parentFolder = null)
    {
        if ($parentFolder === null) {
            $parentFolder = $this->‪getRootLevelFolder();
        } elseif (!$this->driver->folderExists($parentFolder->getIdentifier())) {
            throw new \InvalidArgumentException('Parent folder "' . $parentFolder->getIdentifier() . '" does not exist.', 1325689164);
        }
        if (!$this->‪checkFolderActionPermission('add', $parentFolder)) {
            throw new ‪InsufficientFolderWritePermissionsException('You are not allowed to create directories in the folder "' . $parentFolder->getIdentifier() . '"', 1323059807);
        }
        if ($this->driver->folderExistsInFolder($folderName, $parentFolder->getIdentifier())) {
            throw new ‪ExistingTargetFolderException('Folder "' . $folderName . '" already exists.', 1423347324);
        }
 
        $this->eventDispatcher->dispatch(
            new ‪BeforeFolderAddedEvent($parentFolder, $folderName)
        );
 
        $newFolder = $this->‪getDriver()->‪createFolder($folderName, $parentFolder->getIdentifier(), true);
        $newFolder = $this->‪getFolder($newFolder);
 
        $this->eventDispatcher->dispatch(
            new ‪AfterFolderAddedEvent($newFolder)
        );
 
        return $newFolder;
    }
 
    public function ‪getFolderInfo(‪Folder $folder)
    {
        return $this->driver->getFolderInfoByIdentifier($folder->‪getIdentifier());
    }
 
    public function ‪getDefaultFolder()
    {
        return $this->‪getFolder($this->driver->getDefaultFolder());
    }
 
    public function ‪getFolder(‪$identifier, $returnInaccessibleFolderObject = false)
    {
        $data = $this->driver->getFolderInfoByIdentifier(‪$identifier);
        $folder = $this->‪createFolderObject($data['identifier'] ?? '', $data['name'] ?? '');
 
        try {
            $this->‪assureFolderReadPermission($folder);
        } catch (InsufficientFolderAccessPermissionsException $e) {
            $folder = null;
            if ($returnInaccessibleFolderObject) {
                // if parent folder is readable return inaccessible folder object
                $parentPermissions = $this->driver->getPermissions($this->driver->getParentFolderIdentifierOfIdentifier(‪$identifier));
                if ($parentPermissions['r']) {
                    $folder = GeneralUtility::makeInstance(
                        InaccessibleFolder::class,
                        ‪$this,
                        $data['identifier'],
                        $data['name']
                    );
                }
            }
 
            if ($folder === null) {
                throw $e;
            }
        }
        return $folder;
    }
 
    public function ‪isWithinProcessingFolder(‪$identifier)
    {
        $inProcessingFolder = false;
        foreach ($this->‪getProcessingFolders() as ‪$processingFolder) {
            if (‪$processingFolder->‪getStorage()->‪getDriver()->‪isWithin(‪$processingFolder->‪getIdentifier(), ‪$identifier)) {
                $inProcessingFolder = true;
                break;
            }
        }
        return $inProcessingFolder;
    }
 
    public function ‪isWithinFolder(Folder $folder, ResourceInterface $resource)
    {
        if ($folder->getStorage() !== ‪$this) {
            throw new \InvalidArgumentException('Given folder "' . $folder->getIdentifier() . '" is not part of this storage!', 1422709241);
        }
        if ($folder->getStorage() !== $resource->getStorage()) {
            return false;
        }
        return $this->driver->isWithin($folder->getIdentifier(), $resource->getIdentifier());
    }
 
    public function ‪getRootLevelFolder($respectFileMounts = true)
    {
        if ($respectFileMounts && !empty($this->fileMounts)) {
            $mount = reset($this->fileMounts);
            return $mount['folder'];
        }
        return $this->‪createFolderObject($this->driver->getRootLevelFolder(), '');
    }
 
    protected function ‪getUniqueName(FolderInterface $folder, $theFile, $dontCheckForUnique = false)
    {
        $maxNumber = 99;
        // Fetches info about path, name, extension of $theFile
        $origFileInfo = ‪PathUtility::pathinfo($theFile);
        // Check if the file exists and if not - return the fileName...
        // The destinations file
        $theDestFile = $origFileInfo['basename'];
        // If the file does NOT exist we return this fileName
        if ($dontCheckForUnique || (!$this->driver->fileExistsInFolder($theDestFile, $folder->getIdentifier()) && !‪$this->driver->folderExistsInFolder($theDestFile, $folder->getIdentifier()))) {
            return $theDestFile;
        }
        // Well the fileName in its pure form existed. Now we try to append
        // numbers / unique-strings and see if we can find an available fileName
        // This removes _xx if appended to the file
        $theTempFileBody = preg_replace('/_[0-9][0-9]$/', '', $origFileInfo['filename']);
        $theOrigExt = ($origFileInfo['extension'] ?? '') ? '.' . $origFileInfo['extension'] : '';
        for ($a = 1; $a <= $maxNumber + 1; $a++) {
            // First we try to append numbers
            if ($a <= $maxNumber) {
                $insert = '_' . sprintf('%02d', $a);
            } else {
                $insert = '_' . substr(md5(‪StringUtility::getUniqueId()), 0, 6);
            }
            $theTestFile = $theTempFileBody . $insert . $theOrigExt;
            // The destinations file
            $theDestFile = $theTestFile;
            // If the file does NOT exist we return this fileName
            if (!$this->driver->fileExistsInFolder($theDestFile, $folder->getIdentifier()) && !‪$this->driver->folderExistsInFolder($theDestFile, $folder->getIdentifier())) {
                return $theDestFile;
            }
        }
        throw new \RuntimeException('Last possible name "' . $theDestFile . '" is already taken.', 1325194291);
    }
 
    protected function ‪getFileFactory()
    {
        return GeneralUtility::makeInstance(ResourceFactory::class);
    }
 
    protected function ‪getFileIndexRepository()
    {
        return GeneralUtility::makeInstance(FileIndexRepository::class);
    }
 
    protected function ‪getFileProcessingService()
    {
        if (!$this->fileProcessingService) {
            $this->fileProcessingService = GeneralUtility::makeInstance(FileProcessingService::class, ‪$this, $this->driver, $this->eventDispatcher);
        }
        return ‪$this->fileProcessingService;
    }
 
    public function ‪getRole(‪FolderInterface $folder)
    {
        $folderRole = ‪FolderInterface::ROLE_DEFAULT;
        ‪$identifier = $folder->‪getIdentifier();
        if (method_exists($this->driver, 'getRole')) {
            $folderRole = $this->driver->getRole($folder->‪getIdentifier());
        }
        if (isset($this->fileMounts[‪$identifier])) {
            $folderRole = ‪FolderInterface::ROLE_MOUNT;
 
            if (!empty($this->fileMounts[‪$identifier]['read_only'])) {
                $folderRole = ‪FolderInterface::ROLE_READONLY_MOUNT;
            }
            if ($this->fileMounts[‪$identifier]['user_mount'] ?? false) {
                $folderRole = ‪FolderInterface::ROLE_USER_MOUNT;
            }
        }
        if ($folder instanceof ‪Folder && $this->‪isProcessingFolder($folder)) {
            $folderRole = ‪FolderInterface::ROLE_PROCESSING;
        }
 
        return $folderRole;
    }
 
    public function ‪getProcessingFolder(File $file = null)
    {
        // If a file is given, make sure to return the processing folder of the correct storage
        if ($file !== null && $file->getStorage()->getUid() !== ‪$this->getUid()) {
            return $file->‪getStorage()->‪getProcessingFolder($file);
        }
        if (!isset($this->processingFolder)) {
            ‪$processingFolder = ‪self::DEFAULT_ProcessingFolder;
            if (!empty($this->storageRecord['processingfolder'])) {
                ‪$processingFolder = $this->storageRecord['processingfolder'];
            }
            try {
                if (str_contains(‪$processingFolder, ':')) {
                    [$storageUid, $processingFolderIdentifier] = explode(':', ‪$processingFolder, 2);
                    $storage = GeneralUtility::makeInstance(StorageRepository::class)->findByUid((int)$storageUid);
                    if ($storage->hasFolder($processingFolderIdentifier)) {
                        $this->processingFolder = $storage->getFolder($processingFolderIdentifier);
                    } else {
                        $rootFolder = $storage->getRootLevelFolder(false);
                        $currentEvaluatePermissions = $storage->getEvaluatePermissions();
                        $storage->setEvaluatePermissions(false);
                        $this->processingFolder = $storage->createFolder(
                            ltrim($processingFolderIdentifier, '/'),
                            $rootFolder
                        );
                        $storage->setEvaluatePermissions($currentEvaluatePermissions);
                    }
                } else {
                    if ($this->driver->folderExists(‪$processingFolder) === false) {
                        $rootFolder = $this->‪getRootLevelFolder(false);
                        try {
                            $currentEvaluatePermissions = ‪$this->evaluatePermissions;
                            $this->evaluatePermissions = false;
                            $this->processingFolder = $this->‪createFolder(
                                $processingFolder,
                                $rootFolder
                            );
                            $this->evaluatePermissions = $currentEvaluatePermissions;
                        } catch (\InvalidArgumentException $e) {
                            $this->processingFolder = GeneralUtility::makeInstance(
                                InaccessibleFolder::class,
                                ‪$this,
                                ‪$processingFolder,
                                ‪$processingFolder
                            );
                        }
                    } else {
                        $data = $this->driver->getFolderInfoByIdentifier(‪$processingFolder);
                        $this->processingFolder = $this->‪createFolderObject($data['identifier'], $data['name']);
                    }
                }
            } catch (InsufficientFolderWritePermissionsException|ResourcePermissionsUnavailableException $e) {
                $this->processingFolder = GeneralUtility::makeInstance(
                    InaccessibleFolder::class,
                    ‪$this,
                    ‪$processingFolder,
                    ‪$processingFolder
                );
            }
        }
 
        ‪$processingFolder = ‪$this->processingFolder;
        if (!empty($file)) {
            ‪$processingFolder = $this->‪getNestedProcessingFolder($file, ‪$processingFolder);
        }
        return ‪$processingFolder;
    }
 
    protected function ‪getNestedProcessingFolder(File $file, Folder $rootProcessingFolder)
    {
        ‪$processingFolder = $rootProcessingFolder;
        $nestedFolderNames = $this->‪getNamesForNestedProcessingFolder(
            $file->getIdentifier(),
            self::PROCESSING_FOLDER_LEVELS
        );
 
        try {
            foreach ($nestedFolderNames as $folderName) {
                if (‪$processingFolder->‪hasFolder($folderName)) {
                    ‪$processingFolder = ‪$processingFolder->‪getSubfolder($folderName);
                } else {
                    $currentEvaluatePermissions = ‪$processingFolder->‪getStorage()->‪getEvaluatePermissions();
                    ‪$processingFolder->‪getStorage()->‪setEvaluatePermissions(false);
                    ‪$processingFolder = ‪$processingFolder->‪createFolder($folderName);
                    ‪$processingFolder->‪getStorage()->‪setEvaluatePermissions($currentEvaluatePermissions);
                }
            }
        } catch (FolderDoesNotExistException $e) {
        }
 
        return ‪$processingFolder;
    }
 
    protected function ‪getNamesForNestedProcessingFolder($fileIdentifier, $levels)
    {
        $names = [];
        if ($levels === 0) {
            return $names;
        }
        $hash = md5($fileIdentifier);
        for ($i = 1; $i <= $levels; $i++) {
            $names[] = substr($hash, $i, 1);
        }
        return $names;
    }
 
    public function ‪getDriverType()
    {
        return $this->storageRecord['driver'];
    }
 
    protected function ‪getIndexer()
    {
        return GeneralUtility::makeInstance(Indexer::class, ‪$this);
    }
 
    public function ‪setDefault(‪$isDefault)
    {
        $this->‪isDefault = (bool)‪$isDefault;
    }
 
    public function ‪isDefault()
    {
        return ‪$this->isDefault;
    }
 
    public function ‪getResourceFactoryInstance(): ‪ResourceFactory
    {
        return GeneralUtility::makeInstance(ResourceFactory::class);
    }
 
    protected function ‪getBackendUser(): BackendUserAuthentication
    {
        return ‪$GLOBALS['BE_USER'];
    }
 
    protected function ‪getNearestRecyclerFolder(‪FileInterface $file)
    {
        if ($file instanceof ‪ProcessedFile) {
            return null;
        }
        // if the storage is not browsable we cannot fetch the parent folder of the file so no recycler handling is possible
        if (!$this->‪isBrowsable()) {
            return null;
        }
 
        $recyclerFolder = null;
        $folder = $file->‪getParentFolder();
 
        do {
            if ($folder->getRole() === ‪FolderInterface::ROLE_RECYCLER) {
                break;
            }
 
            foreach ($folder->getSubfolders() as $subFolder) {
                if ($subFolder->getRole() === ‪FolderInterface::ROLE_RECYCLER) {
                    $recyclerFolder = $subFolder;
                    break;
                }
            }
 
            $parentFolder = $folder->‪getParentFolder();
            $isFolderLoop = $folder->‪getIdentifier() === $parentFolder->getIdentifier();
            $folder = $parentFolder;
        } while ($recyclerFolder === null && !$isFolderLoop);
 
        return $recyclerFolder;
    }
 
    protected function ‪createFolderObject(string ‪$identifier, string $name)
    {
        return GeneralUtility::makeInstance(Folder::class, ‪$this, ‪$identifier, $name);
    }
}