UploadExtensionFileController.php

Go to the documentation of this file.

<?php
 
declare(strict_types=1);
 
/*
 * This file is part of the TYPO3 CMS project.
 *
 * It is free software; you can redistribute it and/or modify it under
 * the terms of the GNU General Public License, either version 2
 * of the License, or any later version.
 *
 * For the full copyright and license information, please read the
 * LICENSE.txt file that was distributed with this source code.
 *
 * The TYPO3 project - inspiring people to share!
 */
 
namespace ‪TYPO3\CMS\Extensionmanager\Controller;
 
use Psr\Http\Message\ResponseInterface;
use ‪TYPO3\CMS\Core\Configuration\ExtensionConfiguration;
use ‪TYPO3\CMS\Core\Core\Environment;
use ‪TYPO3\CMS\Core\Security\BlockSerializationTrait;
use ‪TYPO3\CMS\Core\Type\ContextualFeedbackSeverity;
use ‪TYPO3\CMS\Core\Utility\GeneralUtility;
use ‪TYPO3\CMS\Extensionmanager\Exception\ExtensionManagerException;
use ‪TYPO3\CMS\Extensionmanager\Exception\InvalidFileException;
use ‪TYPO3\CMS\Extensionmanager\Service\ExtensionManagementService;
use ‪TYPO3\CMS\Extensionmanager\Utility\FileHandlingUtility;
 
class ‪UploadExtensionFileController extends ‪AbstractController
{
    use ‪BlockSerializationTrait;
 
    protected string ‪$extensionBackupPath = '';
    protected bool ‪$removeFromOriginalPath = false;
 
    public function ‪__construct(
        protected readonly ‪FileHandlingUtility $fileHandlingUtility,
        protected readonly ‪ExtensionManagementService $managementService,
        protected readonly ‪ExtensionConfiguration $extensionConfiguration,
    ) {
    }
 
    public function ‪__destruct()
    {
        $this->‪removeBackupFolder();
    }
 
    public function ‪formAction(): ResponseInterface
    {
        if (‪Environment::isComposerMode()) {
            throw new ExtensionManagerException(
                'Composer mode is active. You are not allowed to upload any extension file.',
                1444725828
            );
        }
 
        return $this->‪htmlResponse();
    }
 
    public function ‪extractAction(bool $overwrite = false): ResponseInterface
    {
        if (‪Environment::isComposerMode()) {
            throw new ExtensionManagerException(
                'Composer mode is active. You are not allowed to upload any extension file.',
                1444725853
            );
        }
 
        try {
            $fileName = null;
            $file = $this->request->getUploadedFiles()['extensionFile'] ?? null;
            if ($file === null) {
                throw new ExtensionManagerException(
                    'Uploading file failed. Check your upload_max_filesize and post_max_size limits.',
                    1342864339
                );
            }
            $fileName = pathinfo($file->getClientFilename(), PATHINFO_BASENAME);
            // If the file name isn't valid an error will be thrown
            $this->‪checkFileName($fileName);
 
            $tempFile = GeneralUtility::tempnam('upload_temp_');
            $file->moveTo($tempFile);
 
            // Remove version and extension from filename to determine the extension key
            $extensionKey = $this->‪getExtensionKeyFromFileName($fileName);
            if (empty($extensionKey)) {
                throw new ExtensionManagerException(
                    'Could not extract extension key from uploaded file name. File name must be something like "my_extension_4.2.2.zip".',
                    1603087515
                );
            }
            $this->‪extractExtensionFromZipFile($tempFile, $extensionKey, (bool)$overwrite);
            $isAutomaticInstallationEnabled = (bool)$this->extensionConfiguration->get('extensionmanager', 'automaticInstallation');
            if (!$isAutomaticInstallationEnabled) {
                $this->‪addFlashMessage(
                    $this->‪translate('extensionList.uploadFlashMessage.message', [$extensionKey]),
                    $this->‪translate('extensionList.uploadFlashMessage.title')
                );
            } else {
                // @todo This cannot work without reloading the package information
                if ($this->‪activateExtension($extensionKey)) {
                    $this->‪addFlashMessage(
                        $this->‪translate('extensionList.installedFlashMessage.message', [$extensionKey]),
                        ''
                    );
                } else {
                    return $this->‪redirect(
                        'unresolvedDependencies',
                        'List',
                        null,
                        [
                            'extensionKey' => $extensionKey,
                            'returnAction' => ['controller' => 'List', 'action' => 'index'],
                        ]
                    );
                }
            }
        } catch (InvalidFileException $exception) {
            $this->‪addFlashMessage($exception->getMessage(), '', ContextualFeedbackSeverity::ERROR);
        } catch (\Exception $exception) {
            if ($fileName !== null) {
                $this->‪removeExtensionAndRestoreFromBackup($fileName);
            }
            $this->‪addFlashMessage($exception->getMessage(), '', ContextualFeedbackSeverity::ERROR);
        }
        return $this->‪redirect('index', 'List', null, [
            self::TRIGGER_RefreshModuleMenu => true,
            self::TRIGGER_RefreshTopbar => true,
        ]);
    }
 
    protected function ‪checkFileName($fileName)
    {
        if (empty($fileName)) {
            throw new InvalidFileException('No file given.', 1342858852);
        }
        $fileExtension = pathinfo($fileName, PATHINFO_EXTENSION);
        if ($fileExtension !== 'zip') {
            throw new InvalidFileException('Wrong file format "' . $fileExtension . '" given. Only .zip files are allowed.', 1342858853);
        }
    }
 
    protected function ‪activateExtension(string $extensionKey): bool
    {
        $this->managementService->reloadPackageInformation($extensionKey);
        $extension = $this->managementService->getExtension($extensionKey);
        return is_array($this->managementService->installExtension($extension));
    }
 
    protected function ‪extractExtensionFromZipFile(string $uploadedFile, string $extensionKey, bool $overwrite = false): string
    {
        $isExtensionAvailable = $this->managementService->isAvailable($extensionKey);
        if (!$overwrite && $isExtensionAvailable) {
            throw new ‪ExtensionManagerException('Extension is already available and overwriting is disabled.', 1342864311);
        }
        if ($isExtensionAvailable) {
            $this->‪copyExtensionFolderToTempFolder($extensionKey);
        }
        $this->removeFromOriginalPath = true;
        $this->fileHandlingUtility->unzipExtensionFromFile($uploadedFile, $extensionKey);
        return $extensionKey;
    }
 
    protected function ‪getExtensionKeyFromFileName(string $fileName): string
    {
        return (string)preg_replace('/_(\\d+)(\\.|\\-)(\\d+)(\\.|\\-)(\\d+).*/i', '', strtolower(substr($fileName, 0, -4)));
    }
 
    protected function ‪copyExtensionFolderToTempFolder(string $extensionKey): void
    {
        $this->extensionBackupPath = ‪Environment::getVarPath() . '/transient/' . $extensionKey . substr(sha1($extensionKey . microtime()), 0, 7) . '/';
        ‪GeneralUtility::mkdir($this->extensionBackupPath);
        GeneralUtility::copyDirectory(
            $this->fileHandlingUtility->getExtensionDir($extensionKey),
            $this->extensionBackupPath
        );
    }
 
    protected function ‪removeExtensionAndRestoreFromBackup(string $fileName): void
    {
        $extDirPath = $this->fileHandlingUtility->getExtensionDir($this->‪getExtensionKeyFromFileName($fileName));
        if ($this->removeFromOriginalPath && is_dir($extDirPath)) {
            ‪GeneralUtility::rmdir($extDirPath, true);
        }
        if (!empty($this->extensionBackupPath)) {
            ‪GeneralUtility::mkdir($extDirPath);
            GeneralUtility::copyDirectory($this->extensionBackupPath, $extDirPath);
        }
    }
 
    protected function ‪removeBackupFolder(): void
    {
        if (!empty($this->extensionBackupPath)) {
            ‪GeneralUtility::rmdir($this->extensionBackupPath, true);
            $this->extensionBackupPath = '';
        }
    }
}