FileHandlingUtility.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\Extensionmanager\Utility;
 
use Psr\Log\LoggerAwareInterface;
use Psr\Log\LoggerAwareTrait;
use ‪TYPO3\CMS\Core\Core\Environment;
use ‪TYPO3\CMS\Core\Exception\Archive\ExtractException;
use ‪TYPO3\CMS\Core\Localization\LanguageService;
use ‪TYPO3\CMS\Core\Service\Archive\ZipService;
use ‪TYPO3\CMS\Core\SingletonInterface;
use ‪TYPO3\CMS\Core\Utility\GeneralUtility;
use ‪TYPO3\CMS\Core\Utility\PathUtility;
use ‪TYPO3\CMS\Extensionmanager\Domain\Model\Extension;
use ‪TYPO3\CMS\Extensionmanager\Exception\ExtensionManagerException;
 
class ‪FileHandlingUtility implements ‪SingletonInterface, LoggerAwareInterface
{
    use LoggerAwareTrait;
 
    protected ‪$emConfUtility;
 
    protected ‪$installUtility;
 
    protected ‪$languageService;
 
    public function ‪injectEmConfUtility(EmConfUtility ‪$emConfUtility)
    {
        $this->emConfUtility = ‪$emConfUtility;
    }
 
    public function ‪injectInstallUtility(‪InstallUtility ‪$installUtility)
    {
        $this->installUtility = ‪$installUtility;
    }
 
    public function ‪injectLanguageService(‪LanguageService ‪$languageService)
    {
        $this->languageService = ‪$languageService;
    }
 
    public function ‪initializeObject()
    {
        $this->languageService->includeLLFile('EXT:extensionmanager/Resources/Private/Language/locallang.xlf');
    }
 
    public function ‪unpackExtensionFromExtensionDataArray(array $extensionData, ‪Extension $extension = null, $pathType = 'Local')
    {
        $extensionDir = $this->‪makeAndClearExtensionDir($extensionData['extKey'], $pathType);
        $files = $this->‪extractFilesArrayFromExtensionData($extensionData);
        $directories = $this->‪extractDirectoriesFromExtensionData($files);
        $files = array_diff_key($files, array_flip($directories));
        $this->‪createDirectoriesForExtensionFiles($directories, $extensionDir);
        $this->‪writeExtensionFiles($files, $extensionDir);
        $this->‪writeEmConfToFile($extensionData, $extensionDir, $extension);
        $this->‪reloadPackageInformation($extensionData['extKey']);
    }
 
    protected function ‪extractDirectoriesFromExtensionData(array $files)
    {
        $directories = [];
        foreach ($files as $filePath => $file) {
            preg_match('/(.*)\\//', $filePath, $matches);
            if (!empty($matches[0])) {
                $directories[] = $matches[0];
            }
        }
        return array_unique($directories);
    }
 
    protected function ‪extractFilesArrayFromExtensionData(array $extensionData)
    {
        return $extensionData['FILES'];
    }
 
    protected function ‪createDirectoriesForExtensionFiles(array $directories, $rootPath)
    {
        foreach ($directories as $directory) {
            $this->‪createNestedDirectory($rootPath . $directory);
        }
    }
 
    protected function ‪createNestedDirectory($directory)
    {
        try {
            ‪GeneralUtility::mkdir_deep($directory);
        } catch (\RuntimeException $exception) {
            throw new ‪ExtensionManagerException(
                sprintf($this->languageService->getLL('fileHandling.couldNotCreateDirectory'), $this->getRelativePath($directory)),
                1337280416
            );
        }
    }
 
    protected function ‪writeExtensionFiles(array $files, $rootPath)
    {
        foreach ($files as $file) {
            ‪GeneralUtility::writeFile($rootPath . $file['name'], $file['content']);
        }
    }
 
    protected function ‪makeAndClearExtensionDir($extensionKey, $pathType = 'Local')
    {
        $extDirPath = $this->‪getExtensionDir($extensionKey, $pathType);
        if (is_dir($extDirPath)) {
            $this->‪removeDirectory($extDirPath);
        }
        $this->‪addDirectory($extDirPath);
 
        return $extDirPath;
    }
 
    public function ‪getExtensionDir($extensionKey, $pathType = 'Local')
    {
        $paths = ‪Extension::returnInstallPaths();
        $path = $paths[$pathType] ?? '';
        if (!$path || !is_dir($path) || !$extensionKey) {
            throw new ‪ExtensionManagerException(
                sprintf($this->languageService->getLL('fileHandling.installPathWasNoDirectory'), $this->getRelativePath($path)),
                1337280417
            );
        }
 
        return $path . $extensionKey . '/';
    }
 
    protected function ‪addDirectory($extDirPath)
    {
        ‪GeneralUtility::mkdir($extDirPath);
        if (!is_dir($extDirPath)) {
            throw new ‪ExtensionManagerException(
                sprintf($this->languageService->getLL('fileHandling.couldNotCreateDirectory'), $this->getRelativePath($extDirPath)),
                1337280418
            );
        }
    }
 
    public function ‪removeDirectory($extDirPath)
    {
        $extDirPath = GeneralUtility::fixWindowsFilePath($extDirPath);
        $extensionPathWithoutTrailingSlash = rtrim($extDirPath, '/');
        if (is_link($extensionPathWithoutTrailingSlash) && !‪Environment::isWindows()) {
            $result = unlink($extensionPathWithoutTrailingSlash);
        } else {
            $result = ‪GeneralUtility::rmdir($extDirPath, true);
        }
        if ($result === false) {
            throw new ‪ExtensionManagerException(
                sprintf($this->languageService->getLL('fileHandling.couldNotRemoveDirectory'), $this->getRelativePath($extDirPath)),
                1337280415
            );
        }
    }
 
    protected function ‪writeEmConfToFile(array $extensionData, $rootPath, ‪Extension $extension = null)
    {
        $emConfFileData = [];
        if (file_exists($rootPath . 'ext_emconf.php')) {
            $emConfFileData = $this->emConfUtility->includeEmConf(
                $extensionData['extKey'],
                [
                    'packagePath' => $rootPath,
                    'siteRelPath' => ‪PathUtility::stripPathSitePrefix($rootPath)
                ]
            );
            $emConfFileData = is_array($emConfFileData) ? $emConfFileData : [];
        }
        $extensionData['EM_CONF'] = array_replace_recursive($emConfFileData, $extensionData['EM_CONF']);
        $emConfContent = $this->emConfUtility->constructEmConf($extensionData, $extension);
        ‪GeneralUtility::writeFile($rootPath . 'ext_emconf.php', $emConfContent);
    }
 
    public function ‪isValidExtensionPath($path)
    {
        $allowedPaths = ‪Extension::returnAllowedInstallPaths();
        foreach ($allowedPaths as $allowedPath) {
            if (GeneralUtility::isFirstPartOfStr($path, $allowedPath)) {
                return true;
            }
        }
        return false;
    }
 
    protected function ‪getAbsolutePath($relativePath)
    {
        $absolutePath = GeneralUtility::getFileAbsFileName(GeneralUtility::resolveBackPath(‪Environment::getPublicPath() . '/' . $relativePath));
        if (empty($absolutePath)) {
            throw new ‪ExtensionManagerException('Illegal relative path given', 1350742864);
        }
        return $absolutePath;
    }
 
    protected function ‪getRelativePath(string $absolutePath): string
    {
        return ‪PathUtility::stripPathSitePrefix($absolutePath);
    }
 
    public function ‪getAbsoluteExtensionPath(string $extensionKey): string
    {
        $extension = $this->installUtility->enrichExtensionWithDetails($extensionKey);
        return $this->‪getAbsolutePath($extension['siteRelPath']);
    }
 
    protected function ‪getExtensionVersion(string $extensionKey): string
    {
        $extensionData = $this->installUtility->enrichExtensionWithDetails($extensionKey);
        return (string)$extensionData['version'];
    }
 
    public function ‪createZipFileFromExtension($extensionKey): string
    {
        $extensionPath = $this->‪getAbsoluteExtensionPath($extensionKey);
 
        // Add trailing slash to the extension path, getAllFilesAndFoldersInPath explicitly requires that.
        $extensionPath = ‪PathUtility::sanitizeTrailingSeparator($extensionPath);
 
        $version = $this->‪getExtensionVersion($extensionKey);
        if (empty($version)) {
            $version = '0.0.0';
        }
 
        $temporaryPath = ‪Environment::getVarPath() . '/transient/';
        if (!@is_dir($temporaryPath)) {
            ‪GeneralUtility::mkdir($temporaryPath);
        }
        $fileName = $temporaryPath . $extensionKey . '_' . $version . '_' . date('YmdHi', ‪$GLOBALS['EXEC_TIME']) . '.zip';
 
        $zip = new \ZipArchive();
        $zip->open($fileName, \ZipArchive::CREATE);
 
        $excludePattern = ‪$GLOBALS['TYPO3_CONF_VARS']['EXT']['excludeForPackaging'];
 
        // Get all the files of the extension, but exclude the ones specified in the excludePattern
        $files = GeneralUtility::getAllFilesAndFoldersInPath(
            [], // No files pre-added
            $extensionPath, // Start from here
            '', // Do not filter files by extension
            true, // Include subdirectories
            PHP_INT_MAX, // Recursion level
            $excludePattern        // Files and directories to exclude.
        );
 
        // Make paths relative to extension root directory.
        $files = GeneralUtility::removePrefixPathFromList($files, $extensionPath);
        $files = is_array($files) ? $files : [];
 
        // Remove the one empty path that is the extension dir itself.
        $files = array_filter($files);
 
        foreach ($files as $file) {
            $fullPath = $extensionPath . $file;
            // Distinguish between files and directories, as creation of the archive
            // fails on Windows when trying to add a directory with "addFile".
            if (is_dir($fullPath)) {
                $zip->addEmptyDir($file);
            } else {
                $zip->addFile($fullPath, $file);
            }
        }
 
        $zip->close();
        return $fileName;
    }
 
    public function ‪unzipExtensionFromFile($file, $fileName, $pathType = 'Local')
    {
        $extensionDir = $this->‪makeAndClearExtensionDir($fileName, $pathType);
 
        try {
            $zipService = GeneralUtility::makeInstance(ZipService::class);
            if ($zipService->verify($file)) {
                $zipService->extract($file, $extensionDir);
            }
        } catch (‪ExtractException $e) {
            $this->logger->error('Extracting the extension archive failed', ['exception' => $e]);
            throw new ‪ExtensionManagerException('Extracting the extension archive failed: ' . $e->getMessage(), 1565777179, $e);
        }
 
        ‪GeneralUtility::fixPermissions($extensionDir, true);
    }
 
    protected function ‪reloadPackageInformation($extensionKey)
    {
        $this->installUtility->reloadPackageInformation($extensionKey);
    }
}