9.5/_core_version_service_8php_source.html

<?php

declare(strict_types = 1);


namespace ‪TYPO3\CMS\Install\Service;


/*

 * 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\Registry;

use ‪TYPO3\CMS\Core\Utility\GeneralUtility;

use ‪TYPO3\CMS\Core\Utility\VersionNumberUtility;

use ‪TYPO3\CMS\Install\CoreVersion\CoreRelease;

use ‪TYPO3\CMS\Install\CoreVersion\MaintenanceWindow;

use ‪TYPO3\CMS\Install\CoreVersion\MajorRelease;


class CoreVersionService

{

    protected $registry;


    protected $apiBaseUrl = 'https://get.typo3.org/v1/api/';


    public function __construct(Registry $registry = null)

    {

        if (null !== $registry) {

            trigger_error(

                'The constructor parameter $registry for CoreVersionService is deprecated since TYPO3 v9 and will be removed in TYPO3 v10.0.',

                E_USER_DEPRECATED

            );

            $this->registry = $registry;

        } else {

            $this->registry = GeneralUtility::makeInstance(Registry::class);

        }

    }


    public function isInstalledVersionAReleasedVersion(): bool

    {

        $version = $this->getInstalledVersion();

        return substr($version, -4) !== '-dev';

    }


    public function getInstalledVersion(): string

    {

        return ‪VersionNumberUtility::getCurrentTypo3Version();

    }


    public function getMaintenanceWindow(): MaintenanceWindow

    {

        $url = 'major/' . $this->getInstalledMajorVersion();

        $result = $this->fetchFromRemote($url);


        return ‪MaintenanceWindow::fromApiResponse($result);

    }


    public function getSupportedMajorReleases(): array

    {

        $url = 'major';

        $result = $this->fetchFromRemote($url);


        $majorReleases = [

            'community' => [],

            'elts' => [],

        ];

        foreach ($result as $release) {

            $majorRelease = ‪MajorRelease::fromApiResponse($release);

            $maintenanceWindow = $majorRelease->getMaintenanceWindow();


            if ($maintenanceWindow->isSupportedByCommunity()) {

                $group = 'community';

            } elseif ($maintenanceWindow->isSupportedByElts()) {

                $group = 'elts';

            } else {

                // Major version is unsupported

                continue;

            }


            $majorReleases[$group][] = $majorRelease->getLts() ?? $majorRelease->getVersion();

        }


        return $majorReleases;

    }


    public function isPatchReleaseSuitableForUpdate(CoreRelease $coreRelease): bool

    {

        return version_compare($this->getInstalledVersion(), $coreRelease->getVersion()) === -1;

    }


    public function isYoungerPatchReleaseAvailable(): bool

    {

        return version_compare($this->getInstalledVersion(), $this->getYoungestPatchRelease()->getVersion()) === -1;

    }


    public function isUpdateSecurityRelevant(CoreRelease $releaseToCheck): bool

    {

        $url = 'major/' . $this->getInstalledMajorVersion() . '/release';

        $result = $this->fetchFromRemote($url);


        $installedVersion = $this->getInstalledVersion();

        foreach ($result as $release) {

            $coreRelease = ‪CoreRelease::fromApiResponse($release);

            if ($coreRelease->isSecurityUpdate()

                && version_compare($installedVersion, $coreRelease->getVersion()) === -1 // installed version is lower than release

                && version_compare($releaseToCheck->getVersion(), $coreRelease->getVersion()) > -1 // release to check is equal or higher than release

            ) {

                return true;

            }

        }


        return false;

    }


    public function isCurrentInstalledVersionElts(): bool

    {

        $url = 'major/' . $this->getInstalledMajorVersion() . '/release';

        $result = $this->fetchFromRemote($url);


        $installedVersion = $this->getInstalledVersion();

        foreach ($result as $release) {

            if (version_compare($installedVersion, $release['version']) === 0) {

                return $release['elts'] ?? false;

            }

        }


        return false;

    }


    public function getYoungestPatchRelease(): CoreRelease

    {

        $url = 'major/' . $this->getInstalledMajorVersion() . '/release/latest';

        $result = $this->fetchFromRemote($url);

        return ‪CoreRelease::fromApiResponse($result);

    }


    public function getYoungestCommunityPatchRelease(): CoreRelease

    {

        $url = 'major/' . $this->getInstalledMajorVersion() . '/release';

        $result = $this->fetchFromRemote($url);


        // Make sure all releases are sorted by their version

        $columns = array_column($result, 'version');

        array_multisort($columns, SORT_NATURAL, $result);


        // Remove any ELTS release

        $releases = array_filter($result, static function (array $release) {

            return ($release['elts'] ?? false) === false;

        });


        $latestRelease = end($releases);


        return ‪CoreRelease::fromApiResponse($latestRelease);

    }


    protected function fetchFromRemote(string $url): array

    {

        $url = $this->apiBaseUrl . $url;

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


        if (!$json) {

            $this->throwFetchException($url);

        }

        return json_decode($json, true);

    }


    protected function getInstalledMajorVersion(): string

    {

        return $this->getMajorVersion($this->getInstalledVersion());

    }


    protected function getMajorVersion(string $version): string

    {

        $explodedVersion = explode('.', $version);

        return $explodedVersion[0];

    }


    public function updateVersionMatrix(): void

    {

        trigger_error('Method updateVersionMatrix will be removed in TYPO3 v10.0, use new REST API directly (see https://get.typo3.org/v1/api/doc).', E_USER_DEPRECATED);

        $url = 'https://get.typo3.org/json';

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

        if (!$versionJson) {

            $this->throwFetchException($url);

        }

        $versionArray = json_decode($versionJson, true);

        $installedMajorVersion = (int)$this->getInstalledMajorVersion();


        foreach ($versionArray as $versionNumber => $versionDetails) {

            if (is_array($versionDetails) && (int)$this->getMajorVersion((string)$versionNumber) < $installedMajorVersion) {

                unset($versionArray[$versionNumber]);

            }

        }


        $this->registry->set('TYPO3.CMS.Install', 'coreVersionMatrix', $versionArray);

    }


    public function getYoungestPatchDevelopmentRelease(): string

    {

        trigger_error(

            'Method getYoungestPatchDevelopmentRelease() is deprecated since TYPO3 v9 and will be removed in TYPO3 v10.0, use getYoungestPatchRelease() instead.',

            E_USER_DEPRECATED

        );

        return $this->getYoungestPatchRelease()->getVersion();

    }


    public function isYoungerPatchDevelopmentReleaseAvailable(): bool

    {

        trigger_error(

            'Method isYoungerPatchDevelopmentReleaseAvailable() is deprecated since TYPO3 v9 and will be removed in TYPO3 v10.0, use isYoungerPatchReleaseAvailable() instead.',

            E_USER_DEPRECATED

        );

        return $this->isYoungerPatchReleaseAvailable();

    }


    public function getDownloadBaseUrl(): string

    {

        trigger_error(

            'Method getDownloadBaseUrl() is deprecated since TYPO3 v9 and will be removed in TYPO3 v10.0, use https://get.typo3.org directly.',

            E_USER_DEPRECATED

        );

        return $this->apiBaseUrl;

    }


    protected function throwFetchException(string $url): void

    {

        throw new Exception\RemoteFetchException(

            'Fetching ' .

            $url .

            ' failed. Maybe this instance can not connect to the remote system properly.',

            1380897593

        );

    }

}