libraries/src/Updater/ConstraintChecker.php - 5.4-dev - githubmirror/joomla-cms

libraries/src/Updater/ConstraintChecker.php
274 строки8 KB
Martina Scholz
[5.1] updater contraintchecker stability check early return (#43497)
21 май 2024, 00:38
21 май 2024, 00:38de31a3f
<?php

/**
 * Joomla! Content Management System
 *
 * @copyright  (C) 2024 Open Source Matters, Inc. <https://www.joomla.org>
 * @license    GNU General Public License version 2 or later; see LICENSE.txt
 */

namespace Joomla\CMS\Updater;

// phpcs:disable PSR1.Files.SideEffects
\defined('_JEXEC') or die;
// phpcs:enable PSR1.Files.SideEffects

use Joomla\CMS\Component\ComponentHelper;
use Joomla\CMS\Factory;
use Joomla\CMS\Filter\InputFilter;
use Joomla\CMS\Version;

/**
 * ConstraintChecker Class
 *
 * @since  5.1.0
 *
 * @internal Currently this class is only used for Joomla! updates and will be extended in the future to support 3rd party updates
 */
class ConstraintChecker
{
    /**
     * This property holds information about failed environment constraints.
     * It b/c reasons to make sure the TUF implementation mirrors the XML update behaviors
     *
     * @var \stdClass
     *
     * @since   5.1.0
     */
    protected \stdClass $failedEnvironmentConstraints;

    /**
     * The channel to check the constraints against
     *
     * @var string
     */
    protected $channel;

    /**
     * Constructor, used to populate the failed
     *
     * @param string|null $channel  The channel to be used for updating
     *
     * @return  void
     *
     * @since   5.1.0
     */
    public function __construct($channel = null)
    {
        $this->failedEnvironmentConstraints = new \stdClass();

        if (!isset($channel)) {
            $params = ComponentHelper::getParams('com_joomlaupdate');

            $channel = (Version::MAJOR_VERSION + ($params->get('updatesource', 'default') == 'next' ? 1 : 0)) . '.x';
        }

        $this->channel = $channel;
    }

    /**
     * Checks whether the passed constraints are matched
     *
     * @param array $candidate         The provided constraints to be checked
     * @param int   $minimumStability  The minimum stability required for updating
     *
     * @return  boolean
     *
     * @since   5.1.0
     */
    public function check(array $candidate, $minimumStability = Updater::STABILITY_STABLE)
    {
        if (!isset($candidate['targetplatform'])) {
            // targetplatform is required
            return false;
        }

        // Check targetplatform
        if (!$this->checkTargetplatform($candidate['targetplatform'])) {
            return false;
        }

        // Check channel
        if (isset($candidate['channel']) && $candidate['channel'] !== $this->channel) {
            return false;
        }

        // Check stability, assume true when not set
        if (
            isset($candidate['stability'])
            && !$this->checkStability($candidate['stability'], $minimumStability)
        ) {
            return false;
        }

        $result = true;

        // Check php_minimum, assume true when not set
        if (
            isset($candidate['php_minimum'])
            && !$this->checkPhpMinimum($candidate['php_minimum'])
        ) {
            $result = false;
        }

        // Check supported databases, assume true when not set
        if (
            isset($candidate['supported_databases'])
            && !$this->checkSupportedDatabases($candidate['supported_databases'])
        ) {
            $result = false;
        }

        return $result;
    }

    /**
     * Gets the failed constraints for further processing
     *
     * @return  \stdClass
     *
     * @since   5.1.0
     */
    public function getFailedEnvironmentConstraints(): \stdClass
    {
        return $this->failedEnvironmentConstraints;
    }

    /**
     * Check the targetPlatform
     *
     * @param array $targetPlatform
     *
     * @return  boolean
     *
     * @since   5.1.0
     */
    protected function checkTargetplatform(array $targetPlatform)
    {
        // Lower case and remove the exclamation mark
        $product = strtolower(InputFilter::getInstance()->clean(Version::PRODUCT, 'cmd'));

        // Check that the product matches and that the version matches (optionally a regexp)
        if (
            $product === $targetPlatform["name"]
            && preg_match('/^' . $targetPlatform["version"] . '/', JVERSION)
        ) {
            return true;
        }

        return false;
    }

    /**
     * Check the minimum PHP version
     *
     * @param string $phpMinimum The minimum php version to check
     *
     * @return  boolean
     *
     * @since   5.1.0
     */
    protected function checkPhpMinimum(string $phpMinimum)
    {
        // Check if PHP version supported via <php_minimum> tag
        $result = version_compare(PHP_VERSION, $phpMinimum, '>=');

        if (!$result) {
            $this->failedEnvironmentConstraints->php           = new \stdClass();
            $this->failedEnvironmentConstraints->php->required = $phpMinimum;
            $this->failedEnvironmentConstraints->php->used     = PHP_VERSION;

            return false;
        }

        return true;
    }

    /**
     * Check the supported databases and versions
     *
     * @param array $supportedDatabases array of supported databases and versions
     *
     * @return  boolean
     *
     * @since   5.1.0
     */
    protected function checkSupportedDatabases(array $supportedDatabases)
    {
        $db        = Factory::getDbo();
        $dbType    = strtolower($db->getServerType());
        $dbVersion = $db->getVersion();

        // MySQL and MariaDB use the same database driver but not the same version numbers
        if ($dbType === 'mysql') {
            // Check whether we have a MariaDB version string and extract the proper version from it
            if (stripos($dbVersion, 'mariadb') !== false) {
                // MariaDB: Strip off any leading '5.5.5-', if present
                $dbVersion = preg_replace('/^5\.5\.5-/', '', $dbVersion);
                $dbType    = 'mariadb';
            }
        }

        // Do we have an entry for the database?
        if (!empty($supportedDatabases["$dbType"])) {
            $minimumVersion = $supportedDatabases["$dbType"];

            $result = version_compare($dbVersion, $minimumVersion, '>=');

            if (!$result) {
                $this->failedEnvironmentConstraints->db           = new \stdClass();
                $this->failedEnvironmentConstraints->db->type     = $dbType;
                $this->failedEnvironmentConstraints->db->required = $minimumVersion;
                $this->failedEnvironmentConstraints->db->used     = $dbVersion;

                return false;
            }

            return true;
        }

        return false;
    }

    /**
     * Check the stability
     *
     * @param string $stability         Stability to check
     * @param int    $minimumStability  The minimum stability required for updating
     *
     * @return  boolean
     *
     * @since   5.1.0
     */
    protected function checkStability(string $stability, $minimumStability = Updater::STABILITY_STABLE)
    {
        $stabilityInt = $this->stabilityToInteger($stability);

        if ($stabilityInt < $minimumStability) {
            return false;
        }

        return true;
    }

    /**
     * Converts a tag to numeric stability representation. If the tag doesn't represent a known stability level (one of
     * dev, alpha, beta, rc, stable) it is ignored.
     *
     * @param string $tag The tag string, e.g. dev, alpha, beta, rc, stable
     *
     * @return  integer
     *
     * @since   5.1.0
     */
    protected function stabilityToInteger($tag)
    {
        $constant = '\\Joomla\\CMS\\Updater\\Updater::STABILITY_' . strtoupper($tag);

        if (\defined($constant)) {
            return \constant($constant);
        }

        return Updater::STABILITY_STABLE;
    }
}