refactoring: code cleanup/standardization/remove all prototype stuffs

2026-05-18 06:48:50 +02:00 · 2025-09-15 11:14:14 +02:00
parent 609215857b
commit 5dea3c7ce2
13 changed files with 521 additions and 1232 deletions
--- a/setup/moduledependency/moduledependency.class.inc.php
+++ b/setup/moduledependency/moduledependency.class.inc.php
@@ -0,0 +1,135 @@
+<?php
+
+namespace Combodo\iTop\Setup\ModuleDependency;
+
+use Combodo\iTop\PhpParser\Evaluation\PhpExpressionEvaluator;
+use ModuleFileReaderException;
+use RunTimeEnvironment;
+
+/**
+ * Class that handles a module dependency
+ */
+class ModuleDependency {
+	private static PhpExpressionEvaluator $oPhpExpressionEvaluator;
+
+	private string $sDependencyExpression;
+	private bool $bInvalidDependencyRegexp=false;
+	private array $aDepencyModuleNames;
+	private array $aParamsPerModuleId;
+
+	public function __construct(string $sDependencyExpression)
+	{
+		$this->sDependencyExpression = $sDependencyExpression;
+		$this->aParamsPerModuleId = [];
+		$this->aDepencyModuleNames = [];
+
+		if (preg_match_all('/([^\(\)&| ]+)/', $sDependencyExpression, $aMatches))
+		{
+			foreach($aMatches as $aMatch)
+			{
+				foreach($aMatch as $sModuleId)
+				{
+					if (! array_key_exists($sModuleId, $this->aParamsPerModuleId)) {
+						// $sModuleId in the dependency string is made of a <name>/<optional_operator><version>
+						// where the operator is < <= = > >= (by default >=)
+						$aModuleMatches = array();
+						if (preg_match('|^([^/]+)/(<?>?=?)([^><=]+)$|', $sModuleId, $aModuleMatches)) {
+							$sModuleName = $aModuleMatches[1];
+							$this->aDepencyModuleNames[$sModuleName] = true;
+							$sOperator = $aModuleMatches[2];
+							if ($sOperator == '') {
+								$sOperator = '>=';
+							}
+							$sExpectedVersion = $aModuleMatches[3];
+							$this->aParamsPerModuleId[$sModuleId] = [$sModuleName, $sOperator, $sExpectedVersion];
+						}
+					}
+				}
+			}
+		} else {
+			$this->bInvalidDependencyRegexp=true;
+		}
+	}
+
+	private static function GetPhpExpressionEvaluator(): PhpExpressionEvaluator
+	{
+		if (!isset(static::$oPhpExpressionEvaluator)) {
+			static::$oPhpExpressionEvaluator = new PhpExpressionEvaluator([], RunTimeEnvironment::STATIC_CALL_AUTOSELECT_WHITELIST);
+		}
+
+		return static::$oPhpExpressionEvaluator;
+	}
+
+	/**
+	 * Return module names potentially required by current dependency
+	 * @return array
+	 */
+	public function GetPotentialPrerequisiteModuleNames() : array
+	{
+		return array_keys($this->aDepencyModuleNames);
+	}
+
+	/**
+	 * Check if dependency is resolved with current list of module versions
+	 * @param array $aModuleVersions: versions by module names dict
+	 * @param array $aSelectedModules: modules names dict
+	 *
+	 * @return bool
+	 */
+	public function IsDependencyResolved(array $aModuleVersions, array $aSelectedModules) : bool
+	{
+		if ($this->bInvalidDependencyRegexp){
+			return false;
+		}
+
+		$aReplacements=[];
+		foreach ($this->aParamsPerModuleId as $sModuleId => list($sModuleName, $sOperator, $sExpectedVersion)){
+			if (array_key_exists($sModuleName, $aModuleVersions))
+			{
+				// module is present, check the version
+				$sCurrentVersion = $aModuleVersions[$sModuleName];
+				if (version_compare($sCurrentVersion, $sExpectedVersion, $sOperator))
+				{
+					if (array_key_exists($sModuleName, $this->aDepencyModuleNames)) {
+						unset($this->aDepencyModuleNames[$sModuleName]);
+					}
+					$aReplacements[$sModuleId] = '(true)'; // Add parentheses to protect against invalid condition causing
+					// a function call that results in a runtime fatal error
+				}
+				else
+				{
+					$aReplacements[$sModuleId] = '(false)'; // Add parentheses to protect against invalid condition causing
+					// a function call that results in a runtime fatal error
+				}
+			}
+			else
+			{
+				// module is not present
+				$aReplacements[$sModuleId] = '(false)'; // Add parentheses to protect against invalid condition causing
+				// a function call that results in a runtime fatal error
+			}
+		}
+
+		foreach ($this->aDepencyModuleNames as $sModuleName => $c)
+		{
+			if (array_key_exists($sModuleName, $aSelectedModules))
+			{
+				// This module is actually a prerequisite
+				if (!array_key_exists($sModuleName, $aModuleVersions))
+				{
+					return false;
+				}
+			}
+		}
+
+		$bResult=false;
+		$sBooleanExpr = str_replace(array_keys($aReplacements), array_values($aReplacements), $this->sDependencyExpression);
+		try{
+			$bResult = self::GetPhpExpressionEvaluator()->ParseAndEvaluateBooleanExpression($sBooleanExpr);
+		} catch(ModuleFileReaderException $e){
+			//logged already
+			echo "Failed to parse the boolean Expression = '$sBooleanExpr'<br/>";
+		}
+		return $bResult;
+	}
+}