ComposerDeficitDetector.php

Go to the documentation of this file.

<?php
 
declare(strict_types=1);
 
/*
 * 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\Package;
 
use ‪TYPO3\CMS\Extensionmanager\Utility\ListUtility;
 
class ‪ComposerDeficitDetector
{
    public const ‪EXTENSION_COMPOSER_MANIFEST_VALID = 0;
    public const ‪EXTENSION_COMPOSER_MANIFEST_MISSING = 1;
    public const ‪EXTENSION_KEY_MISSING = 2;
 
    private array ‪$availableExtensions;
 
    public function ‪__construct(‪ListUtility $listUtility)
    {
        $this->availableExtensions = $listUtility->‪getAvailableExtensions('Local');
    }
 
    public function ‪getExtensionsWithComposerDeficit(): array
    {
        $extensionsWithDeficit = [];
        foreach ($this->availableExtensions as $extensionKey => $extensionInformation) {
            $extensionComposerDeficit = $this->‪checkExtensionComposerDeficit($extensionKey);
            if ($extensionComposerDeficit !== self::EXTENSION_COMPOSER_MANIFEST_VALID) {
                $extensionsWithDeficit[$extensionKey] = $extensionInformation;
                $extensionsWithDeficit[$extensionKey]['deficit'] = $extensionComposerDeficit;
            }
        }
 
        return $extensionsWithDeficit;
    }
 
    public function ‪checkExtensionComposerDeficit(string $extensionKey): int
    {
        if (empty($this->availableExtensions[$extensionKey])) {
            throw new \InvalidArgumentException('Extension key ' . $extensionKey . ' is not valid.', 1619446378);
        }
 
        $composerManifestPath = $this->availableExtensions[$extensionKey]['packagePath'] . 'composer.json';
 
        if (!file_exists($composerManifestPath) || !($composerManifest = file_get_contents($composerManifestPath))) {
            return ‪self::EXTENSION_COMPOSER_MANIFEST_MISSING;
        }
 
        $composerManifest = json_decode($composerManifest, true) ?? [];
 
        if (!is_array($composerManifest) || $composerManifest === []) {
            // Treat empty or invalid composer.json as missing
            return ‪self::EXTENSION_COMPOSER_MANIFEST_MISSING;
        }
 
        return empty($composerManifest['extra']['typo3/cms']['extension-key'])
            ? ‪self::EXTENSION_KEY_MISSING
            : ‪self::EXTENSION_COMPOSER_MANIFEST_VALID;
    }
}