N°8981: be able to remove extension during setup even when present on disk

2026-04-24 11:08:45 +02:00 · 2026-01-06 17:06:24 +01:00
parent 57b3610100
commit 5f2604c610
8 changed files with 252 additions and 195 deletions
--- a/setup/itopextension.class.inc.php
+++ b/setup/itopextension.class.inc.php
@@ -0,0 +1,143 @@
+<?php
+
+use Combodo\iTop\Setup\ModuleDiscovery\ModuleFileReader;
+use Combodo\iTop\Setup\ModuleDiscovery\ModuleFileReaderException;
+
+require_once(APPROOT.'/setup/parameters.class.inc.php');
+require_once(APPROOT.'/core/cmdbsource.class.inc.php');
+require_once(APPROOT.'/setup/modulediscovery.class.inc.php');
+require_once(APPROOT.'/setup/moduleinstaller.class.inc.php');
+
+/**
+ * Basic helper class to describe an extension, with some characteristics and a list of modules
+ */
+class iTopExtension
+{
+	public const SOURCE_WIZARD = 'datamodels';
+	public const SOURCE_MANUAL = 'extensions';
+	public const SOURCE_REMOTE = 'data';
+
+	/**
+	 * @var string
+	 */
+	public $sCode;
+
+	/**
+	 * @var string
+	 */
+	public $sVersion;
+
+	/**
+	 * @var string
+	 */
+	public $sInstalledVersion;
+
+	/**
+	 * @var string
+	 */
+	public $sLabel;
+
+	/**
+	 * @var string
+	 */
+	public $sDescription;
+
+	/**
+	 * @var string
+	 */
+	public $sSource;
+
+	/**
+	 * @var bool
+	 */
+	public $bMandatory;
+
+	/**
+	 * @var string
+	 */
+	public $sMoreInfoUrl;
+
+	/**
+	 * @var bool
+	 */
+	public $bMarkedAsChosen;
+	/**
+	 * If null, check if at least one module cannot be uninstalled
+	 * @var bool|null
+	 */
+	public ?bool $bCanBeUninstalled = null;
+
+	/**
+	 * @var bool
+	 */
+	public $bVisible;
+
+	/**
+	 * @var string[]
+	 */
+	public $aModules;
+
+	/**
+	 * @var string[]
+	 */
+	public $aModuleVersion;
+
+	/**
+	 * @var string[]
+	 */
+	public $aModuleInfo;
+
+	/**
+	 * @var string
+	 */
+	public $sSourceDir;
+
+	/**
+	 *
+	 * @var string[]
+	 */
+	public $aMissingDependencies;
+	/**
+	 * @var bool
+	 */
+	public bool $bInstalled = false;
+	/**
+	 * @var bool
+	 */
+	public bool $bRemovedFromDisk = false;
+
+	public function __construct()
+	{
+		$this->sCode = '';
+		$this->sLabel = '';
+		$this->sDescription = '';
+		$this->sSource = self::SOURCE_WIZARD;
+		$this->bMandatory = false;
+		$this->sMoreInfoUrl = '';
+		$this->bMarkedAsChosen = false;
+		$this->sVersion = ITOP_VERSION;
+		$this->sInstalledVersion = '';
+		$this->aModules = [];
+		$this->aModuleVersion = [];
+		$this->aModuleInfo = [];
+		$this->sSourceDir = '';
+		$this->bVisible = true;
+		$this->aMissingDependencies = [];
+	}
+
+	/**
+	 * @since 3.3.0
+	 * @return bool
+	 */
+	public function CanBeUninstalled(): bool
+	{
+		if (!is_null($this->bCanBeUninstalled)) {
+			return $this->bCanBeUninstalled;
+		}
+		foreach ($this->aModuleInfo as $sModuleCode => $aModuleInfo) {
+			$this->bCanBeUninstalled = $aModuleInfo['uninstallable'] === 'yes';
+			return $this->bCanBeUninstalled;
+		}
+		return true;
+	}
+}