Skip to content

feat(Utils): Add method to retrieve module version #58

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

feat(Utils): Add method to retrieve module version #58

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2d67a59
feat(Utils): Add method to retrieve module version
Hipska Sep 4, 2025
16240e9
Field `name` not needed anymore.
Hipska Sep 4, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 31 additions & 10 deletions core/utils.class.inc.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,11 @@ class Utils
*/
static protected $sLastInstallDate;

/**
* @var array<string, string> Keeps track of which version is installed for a module
*/
static protected $aModuleVersions = array();

static public function SetProjectName($sProjectName)
{
if ($sProjectName != null) {
Expand Down Expand Up @@ -704,19 +709,21 @@ public static function CheckModuleInstallation(string $sModuleId, bool $bRequire
$aDatamodel = current($aDatamodelResults['objects']);
static::$sLastInstallDate = $aDatamodel['fields']['installed'];
}

$aResults = $oClient->Get('ModuleInstallation', ['name' => $sName, 'installed' => static::$sLastInstallDate], 'name,version', 1);
if ($aResults['code'] != 0 || empty($aResults['objects'])) {
throw new Exception($aResults['message'], $aResults['code']);

if (!isset(static::$aModuleVersions[$sName])) {
$aResults = $oClient->Get('ModuleInstallation', ['name' => $sName, 'installed' => static::$sLastInstallDate], 'version', 1);
if ($aResults['code'] != 0 || empty($aResults['objects'])) {
throw new Exception($aResults['message'], $aResults['code']);
}
$aObject = current($aResults['objects']);
static::$aModuleVersions[$sName] = $aObject['fields']['version'];
}
$aObject = current($aResults['objects']);
$sCurrentVersion = $aObject['fields']['version'];

if (isset($sExpectedVersion) && !version_compare($sCurrentVersion, $sExpectedVersion, $sOperator)) {
throw new Exception(sprintf('Version mismatch (%s %s %s)', $sCurrentVersion, $sOperator, $sExpectedVersion));

if (isset($sExpectedVersion) && !version_compare(static::$aModuleVersions[$sName], $sExpectedVersion, $sOperator)) {
throw new Exception(sprintf('Version mismatch (%s %s %s)', static::$aModuleVersions[$sName], $sOperator, $sExpectedVersion));
}

Utils::Log(LOG_DEBUG, sprintf('iTop module %s version %s is installed.', $aObject['fields']['name'], $sCurrentVersion));
Utils::Log(LOG_DEBUG, sprintf('iTop module %s version %s is installed.', $sName, static::$aModuleVersions[$sName]));
} catch (Exception $e) {
$sMessage = sprintf('%s iTop module %s is considered as not installed due to: %s', $bRequired ? 'Required' : 'Optional', $sName, $e->getMessage());
if ($bRequired) {
Expand All @@ -728,6 +735,20 @@ public static function CheckModuleInstallation(string $sModuleId, bool $bRequire
}
return true;
}

/**
* Get the installed version of the given module
*
* @param string $sModuleId Name of the module
* @param RestClient|null $oClient
* @return string The installed version of the module
* @throws Exception When the module could not be found
*/
public static function GetModuleVersion(string $sModuleId, RestClient $oClient = null): string
{
if (!isset(static::$aModuleVersions[$sModuleId])) static::CheckModuleInstallation($sModuleId, true, $oClient);
return static::$aModuleVersions[$sModuleId];
}
}

class UtilsLogger
Expand Down