ExtensionManagementService.php

Go to the documentation of this file.

<?php
namespace TYPO3\CMS\Extensionmanager\Service;

use TYPO3\CMS\Extensionmanager\Domain\Model\Extension;

class ExtensionManagementService implements \TYPO3\CMS\Core\SingletonInterface {

    protected $downloadQueue;

    protected $dependencyUtility;

    protected $installUtility;

    protected $extensionModelUtility;

    protected $downloadUtility;

    protected $skipSystemDependencyCheck = FALSE;

    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
        $extension = $this->getExtension($extensionKey);
        $this->dependencyUtility->checkDependencies($extension);
        $this->downloadQueue->addExtensionToInstallQueue($extension);
    }

    public function markExtensionForCopy($extensionKey, $sourceFolder) {
        $this->downloadQueue->addExtensionToCopyQueue($extensionKey, $sourceFolder);
    }

    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 setSkipSystemDependencyCheck($skipSystemDependencyCheck) {
        $this->skipSystemDependencyCheck = $skipSystemDependencyCheck;
    }

    public function installExtension(Extension $extension) {
        $this->downloadExtension($extension);

        if (!$this->checkDependencies($extension)) {
            return FALSE;
        }

        $updatedDependencies = array();
        $installedDependencies = array();
        $queue = $this->downloadQueue->getExtensionQueue();
        $copyQueue = $this->downloadQueue->getExtensionCopyStorage();

        if (count($copyQueue) > 0) {
            $this->copyDependencies($copyQueue);
        }
        $downloadedDependencies = array();
        if (array_key_exists('download', $queue)) {
            $downloadedDependencies = $this->downloadDependencies($queue['download']);
        }
        if (array_key_exists('update', $queue)) {
            $this->downloadDependencies($queue['update']);
            $updatedDependencies = $this->uninstallDependenciesToBeUpdated($queue['update']);
        }
        // add extension at the end of the download queue
        $this->downloadQueue->addExtensionToInstallQueue($extension);
        $installQueue = $this->downloadQueue->getExtensionInstallStorage();
        if (count($installQueue) > 0) {
            $installedDependencies = $this->installDependencies($installQueue);
        }
        return array_merge($downloadedDependencies, $updatedDependencies, $installedDependencies);
    }

    public function getDependencyErrors() {
        return $this->dependencyUtility->getDependencyErrors();
    }

    public function getExtension($extensionKey) {
        return $this->extensionModelUtility->mapExtensionArrayToModel(
            $this->installUtility->enrichExtensionWithDetails($extensionKey)
        );
    }

    public function isAvailable($extensionKey) {
        return $this->installUtility->isAvailable($extensionKey);
    }

    protected function downloadExtension(Extension $extension) {
        $this->downloadMainExtension($extension);
        $this->setInExtensionRepository($extension->getExtensionKey());
    }

    protected function checkDependencies(Extension $extension) {
        $this->dependencyUtility->setSkipSystemDependencyCheck($this->skipSystemDependencyCheck);
        $this->dependencyUtility->checkDependencies($extension);

        return !$this->dependencyUtility->hasDependencyErrors();
    }

    protected function setInExtensionRepository($extensionKey) {
        $paths = Extension::returnInstallPaths();
        $path = $paths[$this->downloadUtility->getDownloadPath()];
        $localExtensionStorage = $path . $extensionKey . '/Initialisation/Extensions/';
        $this->dependencyUtility->setLocalExtensionStorage($localExtensionStorage);
    }

    protected function copyDependencies(array $copyQueue) {
        $installPaths = Extension::returnAllowedInstallPaths();
        foreach ($copyQueue as $extensionKey => $sourceFolder) {
            $destination = $installPaths['Local'] . $extensionKey;
            \TYPO3\CMS\Core\Utility\GeneralUtility::mkdir($destination);
            \TYPO3\CMS\Core\Utility\GeneralUtility::copyDirectory($sourceFolder . $extensionKey, $destination);
            $this->markExtensionForInstallation($extensionKey);
            $this->downloadQueue->removeExtensionFromCopyQueue($extensionKey);
        }
    }

    protected function uninstallDependenciesToBeUpdated(array $updateQueue) {
        $resolvedDependencies = array();
        foreach ($updateQueue as $extensionToUpdate) {
            $this->installUtility->uninstall($extensionToUpdate->getExtensionKey());
            $resolvedDependencies['updated'][$extensionToUpdate->getExtensionKey()] = $extensionToUpdate;
        }
        return $resolvedDependencies;
    }

    protected function installDependencies(array $installQueue) {
        if (!empty($installQueue)) {
            $this->emitWillInstallExtensionsSignal($installQueue);
        }
        $resolvedDependencies = array();
        foreach ($installQueue as $extensionKey => $_) {
            $this->installUtility->install($extensionKey);
            $this->emitHasInstalledExtensionSignal($extensionKey);
            if (!is_array($resolvedDependencies['installed'])) {
                $resolvedDependencies['installed'] = array();
            }
            $resolvedDependencies['installed'][$extensionKey] = $extensionKey;
        }
        return $resolvedDependencies;
    }

    protected function downloadDependencies(array $downloadQueue) {
        $resolvedDependencies = array();
        foreach ($downloadQueue as $extensionToDownload) {
            $this->downloadUtility->download($extensionToDownload);
            $this->downloadQueue->removeExtensionFromQueue($extensionToDownload);
            $resolvedDependencies['downloaded'][$extensionToDownload->getExtensionKey()] = $extensionToDownload;
            $this->markExtensionForInstallation($extensionToDownload->getExtensionKey());
        }
        return $resolvedDependencies;
    }

    public function getAndResolveDependencies(Extension $extension) {
        $this->dependencyUtility->setSkipSystemDependencyCheck($this->skipSystemDependencyCheck);
        $this->dependencyUtility->checkDependencies($extension);
        $installQueue = $this->downloadQueue->getExtensionInstallStorage();
        if (is_array($installQueue) && count($installQueue) > 0) {
            $installQueue = array('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->downloadUtility->download($extension);
        }
    }

    protected function emitWillInstallExtensionsSignal(array $installQueue) {
        $this->getSignalSlotDispatcher()->dispatch(__CLASS__, 'willInstallExtensions', array($installQueue));
    }

    protected function emitHasInstalledExtensionSignal($extensionKey) {
        $this->getSignalSlotDispatcher()->dispatch(__CLASS__, 'hasInstalledExtensions', array($extensionKey));
    }

    protected function getSignalSlotDispatcher() {
        if (!isset($this->signalSlotDispatcher)) {
            $this->signalSlotDispatcher = \TYPO3\CMS\Core\Utility\GeneralUtility::makeInstance('TYPO3\\CMS\\Extbase\\Object\\ObjectManager')
                ->get('TYPO3\\CMS\\Extbase\\SignalSlot\\Dispatcher');
        }
        return $this->signalSlotDispatcher;
    }

}