AbstractDownloadExtensionUpdate.php

Go to the documentation of this file.

<?php
namespace TYPO3\CMS\Install\Updates;

/*
 * 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 TYPO3\CMS\Core\Core\Bootstrap;
use TYPO3\CMS\Core\Utility\GeneralUtility;
use TYPO3\CMS\Extbase\Object\ObjectManager;
use TYPO3\CMS\Extensionmanager\Utility\Connection\TerUtility;
use TYPO3\CMS\Extensionmanager\Utility\FileHandlingUtility;
use TYPO3\CMS\Extensionmanager\Utility\InstallUtility;
use TYPO3\CMS\Extensionmanager\Utility\ListUtility;

abstract class AbstractDownloadExtensionUpdate extends AbstractUpdate
{
    protected $title = 'Install an Extension from the Extension Repository';

    protected $extensionDetails = [];

    protected $repositoryUrl = 'https://typo3.org/fileadmin/ter/@filename';

    protected function installExtension($extensionKey, &$customMessage)
    {
        $updateSuccessful = true;
        $objectManager = GeneralUtility::makeInstance(ObjectManager::class);

        $extensionListUtility = $objectManager->get(ListUtility::class);
        $availableExtensions = $extensionListUtility->getAvailableExtensions();
        $extensionDetails = $this->getExtensionDetails($extensionKey);

        $isExtensionAvailable = !empty($availableExtensions[$extensionKey]);
        $isComposerMode = Bootstrap::usesComposerClassLoading();

        if (!$isComposerMode && !$isExtensionAvailable) {
            $extensionTerUtility = $objectManager->get(TerUtility::class);
            if (empty($extensionDetails)) {
                $updateSuccessful = false;
                $customMessage .= 'No version information for extension ' . $extensionKey . ' found. Can not install the extension.';
            }
            $t3xContent = $this->fetchExtension($extensionKey, $extensionDetails['versionString']);
            if (empty($t3xContent)) {
                $updateSuccessful = false;
                $customMessage .= 'The extension ' . $extensionKey . ' could not be downloaded.';
            }
            $t3xExtracted = $extensionTerUtility->decodeExchangeData($t3xContent);
            if (empty($t3xExtracted) || !is_array($t3xExtracted) || empty($t3xExtracted['extKey'])) {
                $updateSuccessful = false;
                $customMessage .= 'The extension ' . $extensionKey . ' could not be extracted.';
            }

            $extensionFileHandlingUtility = $objectManager->get(FileHandlingUtility::class);
            $extensionFileHandlingUtility->unpackExtensionFromExtensionDataArray($t3xExtracted);

            // The listUtility now needs to have the regenerated list of packages
            $extensionListUtility->reloadAvailableExtensions();
        }

        if ($isComposerMode && !$isExtensionAvailable) {
            $updateSuccessful = false;
            $customMessage .= 'The extension ' . $extensionKey . ' can not be downloaded since ' .
              'Composer is used for package management. Please require this ' .
              'extension as package via Composer: ' .
              '"composer require ' . $extensionDetails['composerName'] . ':^' . $extensionDetails['versionString'] . '"';
        }

        if ($updateSuccessful) {
            $extensionInstallUtility = $objectManager->get(InstallUtility::class);
            $extensionInstallUtility->install($extensionKey);
        }

        return $updateSuccessful;
    }

    protected function getExtensionDetails($extensionKey)
    {
        if (array_key_exists($extensionKey, $this->extensionDetails)) {
            return $this->extensionDetails[$extensionKey];
        }

        return [];
    }

    protected function fetchExtension($extensionKey, $version)
    {
        if (empty($extensionKey) || empty($version)) {
            throw new \InvalidArgumentException(
                'No extension key for fetching an extension was given.',
                1344687432
            );
        }

        $filename = $extensionKey[0] . '/' . $extensionKey[1] . '/' . $extensionKey . '_' . $version . '.t3x';
        $url = str_replace('@filename', $filename, $this->repositoryUrl);

        return $this->fetchUrl($url);
    }

    protected function fetchUrl($url)
    {
        if (empty($url)) {
            throw new \InvalidArgumentException(
                'No URL for downloading an extension given.',
                1344687436
            );
        }

        $fileContent = GeneralUtility::getUrl($url);

        // Can not fetch url, throw an exception
        if ($fileContent === false) {
            throw new \RuntimeException(
                'Can not fetch URL "' . $url . '". Possible reasons are network problems or misconfiguration.',
                1344685036
            );
        }

        return $fileContent;
    }
}