Merge pull request joomla#8 from joomla-projects/ConstraintsCHecker

initial wip - ConstrainChecker
SniperSister · Jun 12, 2022 · caecbf3 · caecbf3
2 parents 9965451 + 36010be
commit caecbf3
Show file tree

Hide file tree

Showing 2 changed files with 409 additions and 0 deletions.
diff --git a/libraries/src/Updater/ConstraintChecker.php b/libraries/src/Updater/ConstraintChecker.php
@@ -0,0 +1,196 @@
+<?php
+/**
+ * Joomla! Content Management System
+ *
+ * @copyright  (C) 2022 Open Source Matters, Inc. <https://www.joomla.org>
+ * @license    GNU General Public License version 2 or later; see LICENSE.txt
+ */
+
+namespace Joomla\CMS\Updater;
+
+\defined('JPATH_PLATFORM') or die;
+
+use Joomla\CMS\Component\ComponentHelper;
+use Joomla\CMS\Factory;
+use Joomla\CMS\Filter\InputFilter;
+use Joomla\CMS\Updater\Updater;
+use Joomla\CMS\Version;
+
+/**
+ * ConstrainChecker Class
+ *
+ * @since  __DEPLOY_VERSION__
+ */
+class ConstraintChecker
+{
+	/**
+	 * Checks whether the passed constraints are matched
+	 *
+	 * @param   array  $constraints  The provided constraints to be checked
+	 *
+	 * @return  bool
+	 *
+	 * @since   __DEPLOY_VERSION__
+	 */
+	public function check(array $constraints)
+	{
+		if (!isset($constraints['targetplatform']))
+		{
+			// targetplatform is required
+			return false;
+		}
+
+		// Check targetplatform
+		if (!$this->checkTargetplatform($constraints['targetplatform']))
+		{
+			return false;
+		}
+
+		// Check php_minimum
+		if (isset($constraints['php_minimum']) && !$this->checkPhpMinimum($constraints['php_minimum']))
+		{
+			return false;
+		}
+
+		// Check supported databases
+		if (isset($constraints['supported_databases']) && !$this->checkSupportedDatabases($constraints['supported_databases']))
+		{
+			return false;
+		}
+
+		// Check stability
+		if (isset($constraints['tags']) && !$this->checkStability($constraints['tags']))
+		{
+			return false;
+		}
+
+		return true;
+	}
+
+	/**
+	 * Check the targetPlatform
+	 *
+	 * @param   object  $targetPlatform
+	 *
+	 * @return  bool
+	 *
+	 * @since   __DEPLOY_VERSION__
+	 */
+	protected function checkTargetplatform(\stdClass $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  bool
+	 *
+	 * @since   __DEPLOY_VERSION__
+	 */
+	protected function checkPhpMinimum(string $phpMinimum)
+	{
+		// Check if PHP version supported via <php_minimum> tag, assume true if tag isn't present
+		return version_compare(PHP_VERSION, $phpMinimum, '>=');
+	}
+
+	/**
+	 * Check the supported databases and versions
+	 *
+	 * @param   object  $supportedDatabases  stdClass of supported databases and versions
+	 *
+	 * @return  bool
+	 *
+	 * @since   __DEPLOY_VERSION__
+	 */
+	protected function checkSupportedDatabases(\stdClass $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 (\property_exists($supportedDatabases, $dbType))
+			{
+				$minimumVersion = $supportedDatabases->$dbType;
+
+				return version_compare($dbVersion, $minimumVersion, '>=');
+			}
+
+			return false;
+	}
+
+	/**
+	 * Check the stability
+	 *
+	 * @param   array  $stabilityTags  Stability tags to check
+	 *
+	 * @return  bool
+	 *
+	 * @since   __DEPLOY_VERSION__
+	 */
+	protected function checkStability(array $stabilityTags)
+	{
+		$minimumStability = ComponentHelper::getParams('com_installer')->get('minimum_stability', Updater::STABILITY_STABLE);
+
+		$stabilityMatch = false;
+
+		foreach ($stabilityTags as $tag)
+		{
+			$stability = $this->stabilityTagToInteger($tag);
+
+			if (($stability >= $minimumStability))
+			{
+				$stabilityMatch = true;
+			}
+		}
+
+		return $stabilityMatch;
+	}
+
+	/**
+	 * 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   __DEPLOY_VERSION__
+	 */
+	protected function stabilityTagToInteger($tag)
+	{
+		$constant = '\\Joomla\\CMS\\Updater\\Updater::STABILITY_' . strtoupper($tag);
+
+		if (\defined($constant))
+		{
+			return \constant($constant);
+		}
+
+		return Updater::STABILITY_STABLE;
+	}
+}