FileController.php

Go to the documentation of this file.

<?php
declare(strict_types = 1);
namespace ‪TYPO3\CMS\Backend\Controller\File;
 
/*
 * 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 Psr\Http\Message\ResponseInterface;
use Psr\Http\Message\ServerRequestInterface;
use ‪TYPO3\CMS\Backend\Clipboard\Clipboard;
use ‪TYPO3\CMS\Backend\Routing\UriBuilder;
use ‪TYPO3\CMS\Backend\Utility\BackendUtility;
use ‪TYPO3\CMS\Core\Authentication\BackendUserAuthentication;
use ‪TYPO3\CMS\Core\Compatibility\PublicMethodDeprecationTrait;
use ‪TYPO3\CMS\Core\Http\HtmlResponse;
use ‪TYPO3\CMS\Core\Http\JsonResponse;
use ‪TYPO3\CMS\Core\Http\RedirectResponse;
use ‪TYPO3\CMS\Core\Imaging\Icon;
use ‪TYPO3\CMS\Core\Imaging\IconFactory;
use ‪TYPO3\CMS\Core\Resource\DuplicationBehavior;
use ‪TYPO3\CMS\Core\Resource\File;
use ‪TYPO3\CMS\Core\Resource\Folder;
use ‪TYPO3\CMS\Core\Resource\ProcessedFile;
use ‪TYPO3\CMS\Core\Resource\ResourceFactory;
use ‪TYPO3\CMS\Core\Utility\File\ExtendedFileUtility;
use ‪TYPO3\CMS\Core\Utility\GeneralUtility;
use ‪TYPO3\CMS\Core\Utility\HttpUtility;
 
class ‪FileController
{
    use ‪PublicMethodDeprecationTrait;
 
    private ‪$deprecatedPublicMethods = [
        'initClipboard' => 'Using FileController::initClipboard() is deprecated and will not be possible anymore in TYPO3 v10.0.',
        'main' => 'Using FileController::main() is deprecated and will not be possible anymore in TYPO3 v10.0.',
    ];
 
    protected ‪$file;
 
    protected ‪$CB;
 
    protected ‪$overwriteExistingFiles;
 
    protected ‪$redirect;
 
    protected ‪$fileProcessor;
 
    protected ‪$fileData;
 
    public function ‪__construct()
    {
        // @deprecated since TYPO3 v9, will be moved out of __construct() in TYPO3 v10.0
        $this->‪init(‪$GLOBALS['TYPO3_REQUEST']);
    }
 
    public function ‪mainAction(ServerRequestInterface $request): ResponseInterface
    {
        $this->‪main();
 
        ‪BackendUtility::setUpdateSignal('updateFolderTree');
 
        // go and edit the new created file
        if ($request->getParsedBody()['edit'] ?? '') {
            ‪$file = $this->fileData['newfile'][0];
            if (‪$file !== null) {
                $this->redirect = $this->‪getFileEditRedirect(‪$file) ?? ‪$this->redirect;
            }
        }
        if ($this->redirect) {
            return new ‪RedirectResponse(
                GeneralUtility::locationHeaderUrl($this->redirect),
                303
            );
        }
        // empty response
        return new ‪HtmlResponse('');
    }
 
    public function ‪processAjaxRequest(ServerRequestInterface $request): ResponseInterface
    {
        $this->‪main();
        ‪$errors = $this->fileProcessor->getErrorMessages();
        if (!empty(‪$errors)) {
            return (new ‪HtmlResponse('<t3err>' . implode(',', ‪$errors) . '</t3err>'))->withStatus(500, '(AJAX)');
        }
        $flatResult = [];
        foreach ($this->fileData as $action => $results) {
            foreach ($results as $result) {
                if (is_array($result)) {
                    foreach ($result as $subResult) {
                        $flatResult[$action][] = $this->‪flattenResultDataValue($subResult);
                    }
                } else {
                    $flatResult[$action][] = $this->‪flattenResultDataValue($result);
                }
            }
        }
        return (new JsonResponse())->setPayload($flatResult);
    }
 
    public function ‪fileExistsInFolderAction(ServerRequestInterface $request): ResponseInterface
    {
        $fileName = $request->getParsedBody()['fileName'] ?? $request->getQueryParams()['fileName'] ?? null;
        $fileTarget = $request->getParsedBody()['fileTarget'] ?? $request->getQueryParams()['fileTarget'] ?? null;
 
        $fileFactory = GeneralUtility::makeInstance(ResourceFactory::class);
        $fileTargetObject = $fileFactory->retrieveFileOrFolderObject($fileTarget);
        $processedFileName = $fileTargetObject->getStorage()->sanitizeFileName($fileName, $fileTargetObject);
 
        $result = [];
        if ($fileTargetObject->hasFile($processedFileName)) {
            $result = $this->‪flattenResultDataValue($fileTargetObject->getStorage()->getFileInFolder($processedFileName, $fileTargetObject));
        }
        return (new ‪JsonResponse())->setPayload($result);
    }
 
    protected function ‪init(ServerRequestInterface $request): void
    {
        // Set the GPvars from outside
        $parsedBody = $request->getParsedBody();
        $queryParams = $request->getQueryParams();
        $this->file = $parsedBody['data'] ?? $queryParams['data'] ?? null;
        if ($this->file === null) {
            // This happens in clipboard mode only
            $this->redirect = GeneralUtility::sanitizeLocalUrl($parsedBody['redirect'] ?? $queryParams['redirect'] ?? '');
        } else {
            $mode = key($this->file);
            $elementKey = key($this->file[$mode]);
            $this->redirect = GeneralUtility::sanitizeLocalUrl($this->file[$mode][$elementKey]['redirect']);
        }
        $this->CB = $parsedBody['CB'] ?? $queryParams['CB'] ?? null;
 
        if (isset($this->file['rename'][0]['conflictMode'])) {
            $conflictMode = $this->file['rename'][0]['conflictMode'];
            unset($this->file['rename'][0]['conflictMode']);
            $this->overwriteExistingFiles = ‪DuplicationBehavior::cast($conflictMode);
        } else {
            $this->overwriteExistingFiles = ‪DuplicationBehavior::cast($parsedBody['overwriteExistingFiles'] ?? $queryParams['overwriteExistingFiles'] ?? null);
        }
        $this->‪initClipboard();
        $this->fileProcessor = GeneralUtility::makeInstance(ExtendedFileUtility::class);
    }
 
    protected function ‪initClipboard(): void
    {
        if (is_array($this->CB)) {
            $clipObj = GeneralUtility::makeInstance(Clipboard::class);
            $clipObj->initializeClipboard();
            if ($this->CB['paste']) {
                $clipObj->setCurrentPad($this->CB['pad']);
                $this->file = $clipObj->makePasteCmdArray_file($this->CB['paste'], $this->file);
            }
            if ($this->CB['delete']) {
                $clipObj->setCurrentPad($this->CB['pad']);
                $this->file = $clipObj->makeDeleteCmdArray_file($this->file);
            }
        }
    }
 
    protected function ‪main(): void
    {
        // Initializing:
        $this->fileProcessor->setActionPermissions();
        $this->fileProcessor->setExistingFilesConflictMode($this->overwriteExistingFiles);
        $this->fileProcessor->start($this->file);
        $this->fileData = $this->fileProcessor->processData();
    }
 
    protected function ‪getFileEditRedirect(‪File ‪$file): ?string
    {
        $textFileExtensionList = ‪$GLOBALS['TYPO3_CONF_VARS']['SYS']['textfile_ext'] ?? '';
        if (!GeneralUtility::inList($textFileExtensionList, ‪$file->getExtension())) {
            return null;
        }
        ‪$properties = ‪$file->getProperties();
        $urlParameters = [
            'target' =>  ‪$properties['storage'] . ':' . ‪$properties['identifier']
        ];
        if ($this->redirect) {
            $urlParameters['returnUrl'] = ‪$this->redirect;
        }
        $uriBuilder = GeneralUtility::makeInstance(UriBuilder::class);
        return (string)$uriBuilder->buildUriFromRoute('file_edit', $urlParameters);
    }
 
    public function ‪finish()
    {
        trigger_error('FileController->finish() will be removed in TYPO3 v10.0. Do not call from other extension.', E_USER_DEPRECATED);
        ‪BackendUtility::setUpdateSignal('updateFolderTree');
        if ($this->redirect) {
            ‪HttpUtility::redirect($this->redirect);
        }
    }
 
    protected function ‪flattenResultDataValue($result)
    {
        if ($result instanceof File) {
            $thumbUrl = '';
            if (GeneralUtility::inList(‪$GLOBALS['TYPO3_CONF_VARS']['GFX']['imagefile_ext'], $result->getExtension())) {
                $processedFile = $result->process(‪ProcessedFile::CONTEXT_IMAGEPREVIEW, []);
                if ($processedFile) {
                    $thumbUrl = $processedFile->getPublicUrl(true);
                }
            }
            $iconFactory = GeneralUtility::makeInstance(IconFactory::class);
            $result = array_merge(
                $result->toArray(),
                [
                    'date' => ‪BackendUtility::date($result->getModificationTime()),
                    'icon' => $iconFactory->getIconForFileExtension($result->getExtension(), ‪Icon::SIZE_SMALL)->render(),
                    'thumbUrl' => $thumbUrl
                ]
            );
        } elseif ($result instanceof Folder) {
            $result = $result->getIdentifier();
        }
 
        return $result;
    }
 
    protected function ‪getBackendUser(): ‪BackendUserAuthentication
    {
        return ‪$GLOBALS['BE_USER'];
    }
}