AbstractOnlineMediaHelper.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\OnlineMedia\Helpers;
 
use ‪TYPO3\CMS\Core\Core\Environment;
use ‪TYPO3\CMS\Core\Resource\Enum\DuplicationBehavior;
use ‪TYPO3\CMS\Core\Resource\Exception\IllegalFileExtensionException;
use ‪TYPO3\CMS\Core\Resource\Exception\InsufficientFileAccessPermissionsException;
use ‪TYPO3\CMS\Core\Resource\File;
use ‪TYPO3\CMS\Core\Resource\Folder;
use ‪TYPO3\CMS\Core\Resource\Index\FileIndexRepository;
use ‪TYPO3\CMS\Core\Resource\ResourceFactory;
use ‪TYPO3\CMS\Core\Utility\GeneralUtility;
 
abstract class ‪AbstractOnlineMediaHelper implements ‪OnlineMediaHelperInterface
{
    protected ‪$onlineMediaIdCache = [];
 
    protected ‪$extension = '';
 
    public function ‪__construct(‪$extension)
    {
        $this->extension = ‪$extension;
    }
 
    public function ‪getOnlineMediaId(‪File $file)
    {
        if (!isset($this->onlineMediaIdCache[$file->‪getUid()])) {
            // Limiting media identifier to 2048 bytes
            if ($file->getSize() > 2048) {
                return '';
            }
            try {
                // By definition these files only contain the ID of the remote media source
                $this->onlineMediaIdCache[$file->‪getUid()] = trim($file->‪getContents());
            } catch (‪InsufficientFileAccessPermissionsException | ‪IllegalFileExtensionException $e) {
                // User has no access to the file - online media id can not be fetched
                return '';
            }
        }
        return $this->onlineMediaIdCache[$file->‪getUid()];
    }
 
    protected function ‪findExistingFileByOnlineMediaId($onlineMediaId, ‪Folder $targetFolder, $fileExtension)
    {
        $file = null;
        $fileHash = sha1($onlineMediaId);
        $files = $this->‪getFileIndexRepository()->‪findByContentHash($fileHash);
        if (!empty($files)) {
            foreach ($files as $fileIndexEntry) {
                if (
                    $fileIndexEntry['folder_hash'] === $targetFolder->‪getHashedIdentifier()
                    && (int)$fileIndexEntry['storage'] === $targetFolder->‪getStorage()->getUid()
                    && $fileIndexEntry['extension'] === $fileExtension
                ) {
                    $file = $this->‪getResourceFactory()->‪getFileObject($fileIndexEntry['uid'], $fileIndexEntry);
                    break;
                }
            }
        }
        return $file;
    }
 
    protected function ‪createNewFile(‪Folder $targetFolder, $fileName, $onlineMediaId)
    {
        $temporaryFile = GeneralUtility::tempnam('online_media');
        ‪GeneralUtility::writeFileToTypo3tempDir($temporaryFile, $onlineMediaId);
        $file = $targetFolder->‪addFile($temporaryFile, $fileName, ‪DuplicationBehavior::RENAME);
        return $file;
    }
 
    protected function ‪getTempFolderPath()
    {
        $path = ‪Environment::getPublicPath() . '/typo3temp/assets/online_media/';
        if (!is_dir($path)) {
            ‪GeneralUtility::mkdir_deep($path);
        }
        return $path;
    }
 
    protected function ‪getFileIndexRepository()
    {
        return GeneralUtility::makeInstance(FileIndexRepository::class);
    }
 
    protected function ‪getResourceFactory()
    {
        return GeneralUtility::makeInstance(ResourceFactory::class);
    }
}