|
| 1 | +<?php |
| 2 | + |
| 3 | +namespace Combodo\iTop\Setup\ModuleDependency; |
| 4 | + |
| 5 | +require_once(APPROOT.'/setup/runtimeenv.class.inc.php'); |
| 6 | +use Combodo\iTop\PhpParser\Evaluation\PhpExpressionEvaluator; |
| 7 | +use ModuleFileReaderException; |
| 8 | +use RunTimeEnvironment; |
| 9 | + |
| 10 | +/** |
| 11 | + * Class that handles a module dependency |
| 12 | + * Dependency expression example : (moduleA/123 || moduleB>456) |
| 13 | + */ |
| 14 | +class DependencyExpression |
| 15 | +{ |
| 16 | + private static PhpExpressionEvaluator $oPhpExpressionEvaluator; |
| 17 | + |
| 18 | + private string $sDependencyExpression; |
| 19 | + private bool $bValid = true; |
| 20 | + private bool $bResolved = false; |
| 21 | + |
| 22 | + /** |
| 23 | + * @var array<string, bool> $aRemainingModuleNamesToResolve |
| 24 | + */ |
| 25 | + private array $aRemainingModuleNamesToResolve; |
| 26 | + |
| 27 | + /** |
| 28 | + * @var array<string, array> $aParamsPerModuleId |
| 29 | + */ |
| 30 | + private array $aParamsPerModuleId; |
| 31 | + |
| 32 | + public function __construct(string $sDependencyExpression) |
| 33 | + { |
| 34 | + $this->sDependencyExpression = $sDependencyExpression; |
| 35 | + $this->aParamsPerModuleId = []; |
| 36 | + $this->aRemainingModuleNamesToResolve = []; |
| 37 | + |
| 38 | + if (preg_match_all('/([^\(\)&| ]+)/', $sDependencyExpression, $aMatches)) { |
| 39 | + foreach ($aMatches as $aMatch) { |
| 40 | + foreach ($aMatch as $sModuleId) { |
| 41 | + if (! array_key_exists($sModuleId, $this->aParamsPerModuleId)) { |
| 42 | + // $sModuleId in the dependency string is made of a <name>/<optional_operator><version> |
| 43 | + // where the operator is < <= = > >= (by default >=) |
| 44 | + $aModuleMatches = []; |
| 45 | + if (preg_match('|^([^/]+)/(<?>?=?)([^><=]+)$|', $sModuleId, $aModuleMatches)) { |
| 46 | + $sModuleName = $aModuleMatches[1]; |
| 47 | + $this->aRemainingModuleNamesToResolve[$sModuleName] = true; |
| 48 | + $sOperator = $aModuleMatches[2]; |
| 49 | + if ($sOperator == '') { |
| 50 | + $sOperator = '>='; |
| 51 | + } |
| 52 | + $sExpectedVersion = $aModuleMatches[3]; |
| 53 | + $this->aParamsPerModuleId[$sModuleId] = [$sModuleName, $sOperator, $sExpectedVersion]; |
| 54 | + } |
| 55 | + } |
| 56 | + } |
| 57 | + } |
| 58 | + } else { |
| 59 | + $this->bValid = false; |
| 60 | + } |
| 61 | + } |
| 62 | + |
| 63 | + private static function GetPhpExpressionEvaluator(): PhpExpressionEvaluator |
| 64 | + { |
| 65 | + if (!isset(static::$oPhpExpressionEvaluator)) { |
| 66 | + static::$oPhpExpressionEvaluator = new PhpExpressionEvaluator([], RunTimeEnvironment::STATIC_CALL_AUTOSELECT_WHITELIST); |
| 67 | + } |
| 68 | + |
| 69 | + return static::$oPhpExpressionEvaluator; |
| 70 | + } |
| 71 | + |
| 72 | + /** |
| 73 | + * Return module names potentially required by current dependency |
| 74 | + * @return array |
| 75 | + */ |
| 76 | + public function GetRemainingModuleNamesToResolve(): array |
| 77 | + { |
| 78 | + return array_keys($this->aRemainingModuleNamesToResolve); |
| 79 | + } |
| 80 | + |
| 81 | + public function IsResolved(): bool |
| 82 | + { |
| 83 | + return $this->bResolved; |
| 84 | + } |
| 85 | + |
| 86 | + /** |
| 87 | + * Check if dependency is resolved with current list of module versions |
| 88 | + * @param array $aModuleVersions: versions by module names dict |
| 89 | + * @param array $aSelectedModules: modules names dict |
| 90 | + * |
| 91 | + * @return void |
| 92 | + */ |
| 93 | + public function UpdateModuleResolutionState(array $aModuleVersions, array $aSelectedModules): void |
| 94 | + { |
| 95 | + if (!$this->bValid) { |
| 96 | + return; |
| 97 | + } |
| 98 | + |
| 99 | + $aReplacements = []; |
| 100 | + foreach ($this->aParamsPerModuleId as $sModuleId => list($sModuleName, $sOperator, $sExpectedVersion)) { |
| 101 | + if (array_key_exists($sModuleName, $aModuleVersions)) { |
| 102 | + // module is present, check the version |
| 103 | + $sCurrentVersion = $aModuleVersions[$sModuleName]; |
| 104 | + if (version_compare($sCurrentVersion, $sExpectedVersion, $sOperator)) { |
| 105 | + if (array_key_exists($sModuleName, $this->aRemainingModuleNamesToResolve)) { |
| 106 | + unset($this->aRemainingModuleNamesToResolve[$sModuleName]); |
| 107 | + } |
| 108 | + $aReplacements[$sModuleId] = '(true)'; // Add parentheses to protect against invalid condition causing |
| 109 | + // a function call that results in a runtime fatal error |
| 110 | + } else { |
| 111 | + $aReplacements[$sModuleId] = '(false)'; // Add parentheses to protect against invalid condition causing |
| 112 | + // a function call that results in a runtime fatal error |
| 113 | + } |
| 114 | + } else { |
| 115 | + // module is not present |
| 116 | + $aReplacements[$sModuleId] = '(false)'; // Add parentheses to protect against invalid condition causing |
| 117 | + // a function call that results in a runtime fatal error |
| 118 | + } |
| 119 | + } |
| 120 | + |
| 121 | + foreach ($this->aRemainingModuleNamesToResolve as $sModuleName => $c) { |
| 122 | + if (array_key_exists($sModuleName, $aSelectedModules)) { |
| 123 | + // This module is actually a prerequisite |
| 124 | + if (!array_key_exists($sModuleName, $aModuleVersions)) { |
| 125 | + return; |
| 126 | + } |
| 127 | + } |
| 128 | + } |
| 129 | + |
| 130 | + $bResult = false; |
| 131 | + $sBooleanExpr = str_replace(array_keys($aReplacements), array_values($aReplacements), $this->sDependencyExpression); |
| 132 | + try { |
| 133 | + $bResult = self::GetPhpExpressionEvaluator()->ParseAndEvaluateBooleanExpression($sBooleanExpr); |
| 134 | + } catch (ModuleFileReaderException $e) { |
| 135 | + //logged already |
| 136 | + echo "Failed to parse the boolean Expression = '$sBooleanExpr'<br/>"; |
| 137 | + } |
| 138 | + |
| 139 | + $this->bResolved = $bResult; |
| 140 | + } |
| 141 | + |
| 142 | + public function IsValid(): bool |
| 143 | + { |
| 144 | + return $this->bValid; |
| 145 | + } |
| 146 | +} |
0 commit comments