ListUtility.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\EventDispatcher\EventDispatcherInterface;
use ‪TYPO3\CMS\Core\Core\Environment;
use ‪TYPO3\CMS\Core\Package\Event\PackagesMayHaveChangedEvent;
use ‪TYPO3\CMS\Core\Package\PackageInterface;
use TYPO3\CMS\Core\Package\PackageManager;
use ‪TYPO3\CMS\Core\SingletonInterface;
use ‪TYPO3\CMS\Core\Utility\ExtensionManagementUtility;
use ‪TYPO3\CMS\Core\Utility\GeneralUtility;
use ‪TYPO3\CMS\Core\Utility\PathUtility;
use ‪TYPO3\CMS\Core\Utility\VersionNumberUtility;
use ‪TYPO3\CMS\Extensionmanager\Domain\Model\Extension;
use ‪TYPO3\CMS\Extensionmanager\Domain\Repository\ExtensionRepository;
 
class ‪ListUtility implements ‪SingletonInterface
{
    protected ‪$emConfUtility;
 
    protected ‪$extensionRepository;
 
    protected ‪$installUtility;
 
    protected ‪$packageManager;
 
    protected ‪$availableExtensions;
 
    protected ‪$eventDispatcher;
 
    public function ‪injectEventDispatcher(EventDispatcherInterface ‪$eventDispatcher)
    {
        $this->eventDispatcher = ‪$eventDispatcher;
    }
 
    public function ‪injectEmConfUtility(EmConfUtility ‪$emConfUtility)
    {
        $this->emConfUtility = ‪$emConfUtility;
    }
 
    public function ‪injectExtensionRepository(‪ExtensionRepository ‪$extensionRepository)
    {
        $this->extensionRepository = ‪$extensionRepository;
    }
 
    public function ‪injectInstallUtility(‪InstallUtility ‪$installUtility)
    {
        $this->installUtility = ‪$installUtility;
    }
 
    public function ‪injectPackageManager(PackageManager ‪$packageManager)
    {
        $this->packageManager = ‪$packageManager;
    }
 
    public function ‪getAvailableExtensions(string $filter = ''): array
    {
        if ($this->availableExtensions === null) {
            $this->availableExtensions = [];
            $this->eventDispatcher->dispatch(new PackagesMayHaveChangedEvent());
            foreach ($this->packageManager->getAvailablePackages() as $package) {
                $installationType = $this->‪getInstallTypeForPackage($package);
                if ($filter === '' || $filter === $installationType) {
                    $this->availableExtensions[$package->getPackageKey()] = [
                        'siteRelPath' => str_replace(‪Environment::getPublicPath() . '/', '', $package->getPackagePath()),
                        'type' => $installationType,
                        'key' => $package->getPackageKey(),
                        'icon' => ‪PathUtility::getAbsoluteWebPath($package->getPackagePath() . ‪ExtensionManagementUtility::getExtensionIcon($package->getPackagePath())),
                    ];
                }
            }
        }
 
        return ‪$this->availableExtensions;
    }
 
    public function ‪reloadAvailableExtensions()
    {
        $this->availableExtensions = null;
        $this->packageManager->scanAvailablePackages();
        $this->‪getAvailableExtensions();
    }
 
    public function ‪getExtension($extensionKey)
    {
        return $this->packageManager->getPackage($extensionKey);
    }
 
    protected function ‪getInstallTypeForPackage(‪PackageInterface $package)
    {
        foreach (‪Extension::returnInstallPaths() as $installType => $installPath) {
            if (GeneralUtility::isFirstPartOfStr($package->‪getPackagePath(), $installPath)) {
                return $installType;
            }
        }
        return '';
    }
 
    public function ‪getAvailableAndInstalledExtensions(array ‪$availableExtensions)
    {
        foreach ($this->packageManager->getActivePackages() as $extKey => $_) {
            if (isset(‪$availableExtensions[$extKey])) {
                ‪$availableExtensions[$extKey]['installed'] = true;
            }
        }
        return ‪$availableExtensions;
    }
 
    public function ‪enrichExtensionsWithEmConfInformation(array $extensions)
    {
        foreach ($extensions as $extensionKey => $properties) {
            $emconf = $this->emConfUtility->includeEmConf($extensionKey, $properties);
            if (is_array($emconf)) {
                $extensions[$extensionKey] = array_merge($emconf, $properties);
            } else {
                unset($extensions[$extensionKey]);
            }
        }
        return $extensions;
    }
 
    public function ‪enrichExtensionsWithEmConfAndTerInformation(array $extensions)
    {
        $extensions = $this->‪enrichExtensionsWithEmConfInformation($extensions);
        foreach ($extensions as $extensionKey => $properties) {
            $terObject = $this->‪getExtensionTerData($extensionKey, $extensions[$extensionKey]['version'] ?? '');
            if ($terObject !== null) {
                $extensions[$extensionKey]['terObject'] = $terObject;
                $extensions[$extensionKey]['updateAvailable'] = false;
                $extensions[$extensionKey]['updateToVersion'] = null;
                $extensionToUpdate = $this->installUtility->getUpdateableVersion($terObject);
                if ($extensionToUpdate !== false) {
                    $extensions[$extensionKey]['updateAvailable'] = true;
                    $extensions[$extensionKey]['updateToVersion'] = $extensionToUpdate;
                }
            }
        }
        return $extensions;
    }
 
    protected function ‪getExtensionTerData($extensionKey, $version)
    {
        $terObject = $this->extensionRepository->findOneByExtensionKeyAndVersion($extensionKey, $version);
        if (!$terObject instanceof Extension) {
            // Version unknown in TER data, try to find extension
            $terObject = $this->extensionRepository->findHighestAvailableVersion($extensionKey);
            if ($terObject instanceof Extension) {
                // Found in TER now, set version information to the known ones, so we can look if there is a newer one
                // Use a cloned object, otherwise wrong information is stored in persistenceManager
                $terObject = clone $terObject;
                $terObject->‪setVersion($version);
                $terObject->setIntegerVersion(
                    ‪VersionNumberUtility::convertVersionNumberToInteger($terObject->getVersion())
                );
            } else {
                $terObject = null;
            }
        }
 
        return $terObject;
    }
 
    public function ‪getAvailableAndInstalledExtensionsWithAdditionalInformation(string $filter = ''): array
    {
        ‪$availableExtensions = $this->‪getAvailableExtensions($filter);
        $availableAndInstalledExtensions = $this->‪getAvailableAndInstalledExtensions($availableExtensions);
        return $this->‪enrichExtensionsWithEmConfAndTerInformation($availableAndInstalledExtensions);
    }
}