ExtensionManagementService.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\Service;
 
use Psr\EventDispatcher\EventDispatcherInterface;
use ‪TYPO3\CMS\Core\Configuration\ExtensionConfiguration;
use ‪TYPO3\CMS\Core\Core\Environment;
use ‪TYPO3\CMS\Core\Package\Event\BeforePackageActivationEvent;
use ‪TYPO3\CMS\Core\SingletonInterface;
use ‪TYPO3\CMS\Core\Utility\GeneralUtility;
use ‪TYPO3\CMS\Extensionmanager\Domain\Model\DownloadQueue;
use ‪TYPO3\CMS\Extensionmanager\Domain\Model\Extension;
use ‪TYPO3\CMS\Extensionmanager\Exception\ExtensionManagerException;
use ‪TYPO3\CMS\Extensionmanager\Remote\RemoteRegistry;
use ‪TYPO3\CMS\Extensionmanager\Utility\DependencyUtility;
use ‪TYPO3\CMS\Extensionmanager\Utility\FileHandlingUtility;
use ‪TYPO3\CMS\Extensionmanager\Utility\InstallUtility;
 
class ‪ExtensionManagementService implements ‪SingletonInterface
{
    protected ‪$downloadQueue;
 
    protected ‪$dependencyUtility;
 
    protected ‪$installUtility;
 
    protected ‪$automaticInstallationEnabled = true;
 
    protected ‪$skipDependencyCheck = false;
 
    protected ‪$eventDispatcher;
 
    protected ‪$fileHandlingUtility;
 
    protected ‪$remoteRegistry;
 
    protected ‪$downloadPath = 'Local';
 
    public function ‪__construct(‪RemoteRegistry ‪$remoteRegistry, ‪FileHandlingUtility ‪$fileHandlingUtility)
    {
        $this->remoteRegistry = ‪$remoteRegistry;
        $this->fileHandlingUtility = ‪$fileHandlingUtility;
    }
 
    public function ‪injectEventDispatcher(EventDispatcherInterface ‪$eventDispatcher)
    {
        $this->eventDispatcher = ‪$eventDispatcher;
    }
 
    public function ‪injectDownloadQueue(‪DownloadQueue ‪$downloadQueue)
    {
        $this->downloadQueue = ‪$downloadQueue;
    }
 
    public function ‪injectDependencyUtility(‪DependencyUtility ‪$dependencyUtility)
    {
        $this->dependencyUtility = ‪$dependencyUtility;
    }
 
    public function ‪injectInstallUtility(‪InstallUtility ‪$installUtility)
    {
        $this->installUtility = ‪$installUtility;
    }
 
    public function ‪markExtensionForInstallation($extensionKey)
    {
        // We have to check for dependencies of the extension first, before marking it for installation
        // because this extension might have dependencies, which need to be installed first
        $this->installUtility->reloadAvailableExtensions();
        $extension = $this->‪getExtension($extensionKey);
        $this->dependencyUtility->checkDependencies($extension);
        $this->downloadQueue->addExtensionToInstallQueue($extension);
    }
 
    public function ‪markExtensionForDownload(‪Extension $extension)
    {
        // We have to check for dependencies of the extension first, before marking it for download
        // because this extension might have dependencies, which need to be downloaded and installed first
        $this->dependencyUtility->checkDependencies($extension);
        if (!$this->dependencyUtility->hasDependencyErrors()) {
            $this->downloadQueue->addExtensionToQueue($extension);
        }
    }
 
    public function ‪markExtensionForUpdate(‪Extension $extension)
    {
        // We have to check for dependencies of the extension first, before marking it for download
        // because this extension might have dependencies, which need to be downloaded and installed first
        $this->dependencyUtility->checkDependencies($extension);
        $this->downloadQueue->addExtensionToQueue($extension, 'update');
    }
 
    public function ‪setSkipDependencyCheck(‪$skipDependencyCheck)
    {
        $this->skipDependencyCheck = ‪$skipDependencyCheck;
    }
 
    public function ‪setAutomaticInstallationEnabled(‪$automaticInstallationEnabled)
    {
        $this->automaticInstallationEnabled = (bool)‪$automaticInstallationEnabled;
    }
 
    public function ‪installExtension(‪Extension $extension)
    {
        $this->‪downloadMainExtension($extension);
        if (!$this->‪checkDependencies($extension)) {
            return false;
        }
 
        $downloadedDependencies = [];
        $updatedDependencies = [];
        $installQueue = [];
 
        // First resolve all dependencies and the sub-dependencies until all queues are empty as new extensions might be
        // added each time
        // Extensions have to be installed in reverse order. Extensions which were added at last are dependencies of
        // earlier ones and need to be available before
        while (!$this->downloadQueue->isQueueEmpty('download')
            || !$this->downloadQueue->isQueueEmpty('update')
        ) {
            $installQueue = array_merge($this->downloadQueue->resetExtensionInstallStorage(), $installQueue);
            // Get download and update information
            $queue = $this->downloadQueue->resetExtensionQueue();
            if (!empty($queue['download'])) {
                $downloadedDependencies = array_merge($downloadedDependencies, $this->‪downloadDependencies($queue['download']));
            }
            $installQueue = array_merge($this->downloadQueue->resetExtensionInstallStorage(), $installQueue);
            if ($this->automaticInstallationEnabled) {
                if (!empty($queue['update'])) {
                    $this->‪downloadDependencies($queue['update']);
                    $updatedDependencies = array_merge($updatedDependencies, $this->‪uninstallDependenciesToBeUpdated($queue['update']));
                }
                $installQueue = array_merge($this->downloadQueue->resetExtensionInstallStorage(), $installQueue);
            }
        }
 
        // If there were any dependency errors we have to abort here
        if ($this->dependencyUtility->hasDependencyErrors()) {
            return false;
        }
 
        // Attach extension to install queue
        $this->downloadQueue->addExtensionToInstallQueue($extension);
        $installQueue += $this->downloadQueue->resetExtensionInstallStorage();
        $installedDependencies = [];
        if ($this->automaticInstallationEnabled) {
            $installedDependencies = $this->‪installDependencies($installQueue);
        }
 
        return array_merge($downloadedDependencies, $updatedDependencies, $installedDependencies);
    }
 
    public function ‪getDependencyErrors()
    {
        return $this->dependencyUtility->getDependencyErrors();
    }
 
    public function ‪getExtension($extensionKey)
    {
        return ‪Extension::createFromExtensionArray(
            $this->installUtility->enrichExtensionWithDetails($extensionKey)
        );
    }
 
    public function ‪isAvailable($extensionKey)
    {
        return $this->installUtility->isAvailable($extensionKey);
    }
 
    public function ‪reloadPackageInformation($extensionKey)
    {
        $this->installUtility->reloadPackageInformation($extensionKey);
    }
 
    protected function ‪checkDependencies(‪Extension $extension)
    {
        $this->dependencyUtility->setSkipDependencyCheck($this->skipDependencyCheck);
        $this->dependencyUtility->checkDependencies($extension);
 
        return !$this->dependencyUtility->hasDependencyErrors();
    }
 
    protected function ‪uninstallDependenciesToBeUpdated(array $updateQueue)
    {
        $resolvedDependencies = [];
        foreach ($updateQueue as $extensionToUpdate) {
            $this->installUtility->uninstall($extensionToUpdate->getExtensionKey());
            $resolvedDependencies['updated'][$extensionToUpdate->getExtensionKey()] = $extensionToUpdate;
        }
        return $resolvedDependencies;
    }
 
    protected function ‪installDependencies(array $installQueue)
    {
        if (empty($installQueue)) {
            return [];
        }
        $this->eventDispatcher->dispatch(new BeforePackageActivationEvent($installQueue));
        $resolvedDependencies = [];
        $this->installUtility->install(...array_keys($installQueue));
        foreach ($installQueue as $extensionKey => $_) {
            if (!isset($resolvedDependencies['installed']) || !is_array($resolvedDependencies['installed'])) {
                $resolvedDependencies['installed'] = [];
            }
            $resolvedDependencies['installed'][$extensionKey] = $extensionKey;
        }
        return $resolvedDependencies;
    }
 
    protected function ‪downloadDependencies(array ‪$downloadQueue)
    {
        $resolvedDependencies = [];
        foreach (‪$downloadQueue as $extensionToDownload) {
            $this->‪rawDownload($extensionToDownload);
            $this->downloadQueue->removeExtensionFromQueue($extensionToDownload);
            $resolvedDependencies['downloaded'][$extensionToDownload->getExtensionKey()] = $extensionToDownload;
            $this->‪markExtensionForInstallation($extensionToDownload->getExtensionKey());
        }
        return $resolvedDependencies;
    }
 
    public function ‪getAndResolveDependencies(Extension $extension)
    {
        $this->dependencyUtility->setSkipDependencyCheck($this->skipDependencyCheck);
        $this->dependencyUtility->checkDependencies($extension);
        $installQueue = $this->downloadQueue->getExtensionInstallStorage();
        if (is_array($installQueue) && !empty($installQueue)) {
            $installQueue = ['install' => $installQueue];
        }
        return array_merge($this->downloadQueue->getExtensionQueue(), $installQueue);
    }
 
    public function ‪downloadMainExtension(‪Extension $extension)
    {
        // The extension object has a uid if the extension is not present in the system
        // or an update of a present extension is triggered.
        if ($extension->‪getUid()) {
            $this->‪rawDownload($extension);
        }
    }
 
    protected function ‪rawDownload(‪Extension $extension): void
    {
        if (
            ‪Environment::isComposerMode()
            || (bool)GeneralUtility::makeInstance(ExtensionConfiguration::class)->get('extensionmanager', 'offlineMode')
        ) {
            throw new ‪ExtensionManagerException('Extension Manager is in offline mode. No TER connection available.', 1437078620);
        }
 
        $remoteIdentifier = $extension->‪getRemoteIdentifier();
 
        if ($this->remoteRegistry->hasRemote($remoteIdentifier)) {
            $this->remoteRegistry
                ->getRemote($remoteIdentifier)
                ->downloadExtension(
                    $extension->‪getExtensionKey(),
                    $extension->‪getVersion(),
                    $this->fileHandlingUtility,
                    $extension->‪getMd5hash(),
                    $this->downloadPath
                );
        }
    }
 
    public function ‪setDownloadPath(string ‪$downloadPath): void
    {
        if (!in_array(‪$downloadPath, ‪Extension::returnAllowedInstallTypes(), true)) {
            throw new ExtensionManagerException(‪$downloadPath . ' not in allowed download paths', 1344766387);
        }
        $this->downloadPath = ‪$downloadPath;
    }
}