mirror of
https://github.com/Combodo/iTop.git
synced 2026-02-13 07:24:13 +01:00
389 lines
12 KiB
PHP
389 lines
12 KiB
PHP
<?php
|
|
|
|
use Combodo\iTop\PhpParser\Evaluation\PhpExpressionEvaluator;
|
|
use Combodo\iTop\Setup\ModuleDiscovery\ModuleFileReaderException;
|
|
|
|
require_once(APPROOT.'/application/utils.inc.php');
|
|
require_once(APPROOT.'/setup/setuppage.class.inc.php');
|
|
require_once(APPROOT.'/setup/wizardcontroller.class.inc.php');
|
|
require_once(APPROOT.'/setup/wizardsteps.class.inc.php');
|
|
|
|
class InstallationFileService
|
|
{
|
|
/** @var \RunTimeEnvironment $oProductionEnv */
|
|
private $oProductionEnv;
|
|
|
|
/** @var \ItopExtensionsMap $oProductionEnv */
|
|
private $oItopExtensionsMap;
|
|
|
|
private $sTargetEnvironment;
|
|
private $sInstallationPath;
|
|
private $aSelectedModules;
|
|
private $aSelectedExtensions;
|
|
private $aAfterComputationSelectedExtensions;
|
|
private $aUnSelectedModules;
|
|
private $aAutoSelectModules;
|
|
private $bInstallationOptionalChoicesChecked;
|
|
|
|
/**
|
|
* @param string $sInstallationPath
|
|
* @param string $sTargetEnvironment
|
|
* @param array $aSelectedExtensions
|
|
* @param bool $bInstallationOptionalChoicesChecked : this option is used only when no extensions are selected (ie empty
|
|
* $aSelectedExtensions)
|
|
*/
|
|
public function __construct(string $sInstallationPath, string $sTargetEnvironment = 'production', array $aSelectedExtensions = [], bool $bInstallationOptionalChoicesChecked = true)
|
|
{
|
|
$this->sInstallationPath = $sInstallationPath;
|
|
$this->aSelectedModules = [];
|
|
$this->aUnSelectedModules = [];
|
|
$this->sTargetEnvironment = $sTargetEnvironment;
|
|
$this->aSelectedExtensions = $aSelectedExtensions;
|
|
$this->aAfterComputationSelectedExtensions = (count($aSelectedExtensions) == 0) ? [] : $aSelectedExtensions;
|
|
$this->bInstallationOptionalChoicesChecked = $bInstallationOptionalChoicesChecked;
|
|
}
|
|
|
|
public function Init(): void
|
|
{
|
|
clearstatcache();
|
|
|
|
$this->ProcessDefaultModules();
|
|
$this->ProcessInstallationChoices();
|
|
$this->ProcessExtensionModulesNotSpecifiedInChoices();
|
|
$this->ProcessAutoSelectModules();
|
|
}
|
|
|
|
public function GetProductionEnv(): RunTimeEnvironment
|
|
{
|
|
if (is_null($this->oProductionEnv)) {
|
|
$this->oProductionEnv = new RunTimeEnvironment();
|
|
}
|
|
return $this->oProductionEnv;
|
|
}
|
|
|
|
public function SetProductionEnv(RunTimeEnvironment $oProductionEnv): void
|
|
{
|
|
$this->oProductionEnv = $oProductionEnv;
|
|
}
|
|
|
|
public function GetAfterComputationSelectedExtensions(): array
|
|
{
|
|
return $this->aAfterComputationSelectedExtensions;
|
|
}
|
|
|
|
public function SetItopExtensionsMap(iTopExtensionsMap $oItopExtensionsMap): void
|
|
{
|
|
$this->oItopExtensionsMap = $oItopExtensionsMap;
|
|
}
|
|
|
|
public function GetItopExtensionsMap(): iTopExtensionsMap
|
|
{
|
|
if (is_null($this->oItopExtensionsMap)) {
|
|
$this->oItopExtensionsMap = new iTopExtensionsMap($this->sTargetEnvironment);
|
|
}
|
|
return $this->oItopExtensionsMap;
|
|
}
|
|
|
|
public function GetAutoSelectModules(): array
|
|
{
|
|
return $this->aAutoSelectModules;
|
|
}
|
|
|
|
public function GetSelectedModules(): array
|
|
{
|
|
return $this->aSelectedModules;
|
|
}
|
|
|
|
public function GetUnSelectedModules(): array
|
|
{
|
|
return $this->aUnSelectedModules;
|
|
}
|
|
|
|
public function ProcessInstallationChoices(): void
|
|
{
|
|
$oXMLParameters = new XMLParameters($this->sInstallationPath);
|
|
$aSteps = $oXMLParameters->Get('steps', []);
|
|
if (! is_array($aSteps)) {
|
|
return;
|
|
}
|
|
|
|
foreach ($aSteps as $aStepInfo) {
|
|
$aOptions = $aStepInfo["options"] ?? null;
|
|
if (! is_null($aOptions) && is_array($aOptions)) {
|
|
foreach ($aOptions as $aChoiceInfo) {
|
|
$this->ProcessSelectedChoice($aChoiceInfo, $this->bInstallationOptionalChoicesChecked);
|
|
}
|
|
}
|
|
$aOptions = $aStepInfo["alternatives"] ?? null;
|
|
if (! is_null($aOptions) && is_array($aOptions)) {
|
|
foreach ($aOptions as $aChoiceInfo) {
|
|
$this->ProcessSelectedChoice($aChoiceInfo, false);
|
|
}
|
|
}
|
|
}
|
|
|
|
foreach ($this->aSelectedModules as $sModuleId => $sVal) {
|
|
if (array_key_exists($sModuleId, $this->aUnSelectedModules)) {
|
|
unset($this->aUnSelectedModules[$sModuleId]);
|
|
}
|
|
}
|
|
}
|
|
|
|
private function ProcessUnSelectedChoice($aChoiceInfo)
|
|
{
|
|
if (!is_array($aChoiceInfo)) {
|
|
return;
|
|
}
|
|
|
|
$aCurrentModules = $aChoiceInfo["modules"] ?? [];
|
|
foreach ($aCurrentModules as $sModuleId) {
|
|
$this->aUnSelectedModules[$sModuleId] = true;
|
|
}
|
|
|
|
$aAlternatives = $aChoiceInfo["alternatives"] ?? null;
|
|
if (!is_null($aAlternatives) && is_array($aAlternatives)) {
|
|
foreach ($aAlternatives as $aSubChoiceInfo) {
|
|
$this->ProcessUnSelectedChoice($aSubChoiceInfo);
|
|
}
|
|
}
|
|
|
|
if (array_key_exists('sub_options', $aChoiceInfo)) {
|
|
if (array_key_exists('options', $aChoiceInfo['sub_options'])) {
|
|
$aSubOptions = $aChoiceInfo['sub_options']['options'];
|
|
if (!is_null($aSubOptions) && is_array($aSubOptions)) {
|
|
foreach ($aSubOptions as $aSubChoiceInfo) {
|
|
$this->ProcessUnSelectedChoice($aSubChoiceInfo);
|
|
}
|
|
}
|
|
}
|
|
if (array_key_exists('alternatives', $aChoiceInfo['sub_options'])) {
|
|
$aSubAlternatives = $aChoiceInfo['sub_options']['alternatives'];
|
|
if (!is_null($aSubAlternatives) && is_array($aSubAlternatives)) {
|
|
foreach ($aSubAlternatives as $aSubChoiceInfo) {
|
|
$this->ProcessUnSelectedChoice($aSubChoiceInfo);
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
private function ProcessSelectedChoice($aChoiceInfo, bool $bAllChecked)
|
|
{
|
|
if (!is_array($aChoiceInfo)) {
|
|
return;
|
|
}
|
|
|
|
$sDefault = $aChoiceInfo["default"] ?? "false";
|
|
$sMandatory = $aChoiceInfo["mandatory"] ?? "false";
|
|
|
|
$aCurrentModules = $aChoiceInfo["modules"] ?? [];
|
|
$sExtensionCode = $aChoiceInfo["extension_code"] ?? null;
|
|
if (0 === count($this->aSelectedExtensions)) {
|
|
$bSelected = $bAllChecked || $sDefault === "true" || $sMandatory === "true";
|
|
if ($bSelected) {
|
|
$this->aAfterComputationSelectedExtensions[] = $sExtensionCode;
|
|
}
|
|
} else {
|
|
$bSelected = $sMandatory === "true" ||
|
|
(null !== $sExtensionCode && in_array($sExtensionCode, $this->aSelectedExtensions));
|
|
}
|
|
|
|
foreach ($aCurrentModules as $sModuleId) {
|
|
if ($bSelected) {
|
|
$this->aSelectedModules[$sModuleId] = true;
|
|
} else {
|
|
$this->aUnSelectedModules[$sModuleId] = true;
|
|
}
|
|
}
|
|
|
|
$aAlternatives = $aChoiceInfo["alternatives"] ?? null;
|
|
if (!is_null($aAlternatives) && is_array($aAlternatives)) {
|
|
foreach ($aAlternatives as $aSubChoiceInfo) {
|
|
if ($bSelected) {
|
|
$this->ProcessSelectedChoice($aSubChoiceInfo, $bAllChecked);
|
|
} else {
|
|
$this->ProcessUnSelectedChoice($aSubChoiceInfo);
|
|
}
|
|
}
|
|
}
|
|
|
|
if (array_key_exists('sub_options', $aChoiceInfo)) {
|
|
if (array_key_exists('options', $aChoiceInfo['sub_options'])) {
|
|
$aSubOptions = $aChoiceInfo['sub_options']['options'];
|
|
if (!is_null($aSubOptions) && is_array($aSubOptions)) {
|
|
foreach ($aSubOptions as $aSubChoiceInfo) {
|
|
if ($bSelected) {
|
|
$this->ProcessSelectedChoice($aSubChoiceInfo, $bAllChecked);
|
|
} else {
|
|
$this->ProcessUnSelectedChoice($aSubChoiceInfo);
|
|
}
|
|
}
|
|
}
|
|
}
|
|
if (array_key_exists('alternatives', $aChoiceInfo['sub_options'])) {
|
|
$aSubAlternatives = $aChoiceInfo['sub_options']['alternatives'];
|
|
if (!is_null($aSubAlternatives) && is_array($aSubAlternatives)) {
|
|
foreach ($aSubAlternatives as $aSubChoiceInfo) {
|
|
if ($bSelected) {
|
|
$this->ProcessSelectedChoice($aSubChoiceInfo, false);
|
|
} else {
|
|
$this->ProcessUnSelectedChoice($aSubChoiceInfo);
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
private function GetExtraDirs(): array
|
|
{
|
|
$aSearchDirs = [];
|
|
|
|
$aDirs = [
|
|
'/datamodels/1.x',
|
|
'/datamodels/2.x',
|
|
'data/'.$this->sTargetEnvironment.'-modules',
|
|
'extensions',
|
|
];
|
|
foreach ($aDirs as $sRelativeDir) {
|
|
$sDirPath = APPROOT.$sRelativeDir;
|
|
if (is_dir($sDirPath)) {
|
|
$aSearchDirs[] = $sDirPath;
|
|
}
|
|
}
|
|
|
|
return $aSearchDirs;
|
|
}
|
|
|
|
public function ProcessDefaultModules(): void
|
|
{
|
|
$sProductionModuleDir = APPROOT.'data/'.$this->sTargetEnvironment.'-modules/';
|
|
|
|
$aAvailableModules = $this->GetProductionEnv()->AnalyzeInstallation(MetaModel::GetConfig(), $this->GetExtraDirs());
|
|
|
|
$this->aAutoSelectModules = [];
|
|
foreach ($aAvailableModules as $sModuleId => $aModule) {
|
|
if (($sModuleId != ROOT_MODULE)) {
|
|
if (isset($aModule['auto_select'])) {
|
|
$this->aAutoSelectModules[$sModuleId] = $aModule;
|
|
continue;
|
|
}
|
|
|
|
if (($aModule['category'] == 'authentication') || (!$aModule['visible'])) {
|
|
$this->aSelectedModules[$sModuleId] = true;
|
|
continue;
|
|
}
|
|
$bIsExtra = (array_key_exists('root_dir', $aModule) && (strpos(
|
|
$aModule['root_dir'],
|
|
$sProductionModuleDir
|
|
) !== false)); // Some modules (root, datamodel) have no 'root_dir'
|
|
if ($bIsExtra) {
|
|
// Modules in data/production-modules/ are considered as mandatory and always installed
|
|
$this->aSelectedModules[$sModuleId] = true;
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
public function ProcessAutoSelectModules(): void
|
|
{
|
|
$oPhpExpressionEvaluator = new PhpExpressionEvaluator([], RunTimeEnvironment::STATIC_CALL_AUTOSELECT_WHITELIST);
|
|
|
|
foreach ($this->GetAutoSelectModules() as $sModuleId => $aModule) {
|
|
try {
|
|
SetupInfo::SetSelectedModules($this->aSelectedModules);
|
|
|
|
$bSelected = $oPhpExpressionEvaluator->ParseAndEvaluateBooleanExpression($aModule['auto_select']);
|
|
if ($bSelected) {
|
|
// Modules in data/production-modules/ are considered as mandatory and always installed
|
|
$this->aSelectedModules[$sModuleId] = true;
|
|
}
|
|
} catch (ModuleFileReaderException $e) {
|
|
//logged already
|
|
}
|
|
}
|
|
}
|
|
|
|
public function CanChooseUnpackageExtension(iTopExtension $oExtension): bool
|
|
{
|
|
if ($oExtension->sSource === iTopExtension::SOURCE_REMOTE) {
|
|
SetupLog::Info("Data Extension can be selected", null, ['extension' => $oExtension->sCode]);
|
|
return true;
|
|
}
|
|
|
|
$bSelectable = $this->bInstallationOptionalChoicesChecked && ($oExtension->sSource === iTopExtension::SOURCE_MANUAL);
|
|
if ($bSelectable) {
|
|
SetupLog::Info("Manual Extension can be selected", null, ['extension' => $oExtension->sCode]);
|
|
} else {
|
|
SetupLog::Debug("Manual Extension can NOT be selected", null, ['extension' => $oExtension->sCode]);
|
|
}
|
|
|
|
return $bSelectable;
|
|
}
|
|
|
|
public function ProcessExtensionModulesNotSpecifiedInChoices()
|
|
{
|
|
/** @var \iTopExtension $oExtension */
|
|
foreach ($this->GetItopExtensionsMap()->GetAllExtensions() as $oExtension) {
|
|
if (in_array($oExtension->sCode, $this->aAfterComputationSelectedExtensions)) {
|
|
//extension already processed in installation.xml
|
|
SetupLog::Info(
|
|
"Extension already processed via installation choices",
|
|
null,
|
|
[
|
|
'extension' => $oExtension->sCode,
|
|
]
|
|
) ;
|
|
continue;
|
|
}
|
|
if ($this->CanChooseUnpackageExtension($oExtension)) {
|
|
if (($oExtension->bVisible) && (count($oExtension->aMissingDependencies) === 0)) {
|
|
$aCurrentModules = [];
|
|
$aUnselectableModules = [];
|
|
$bIsExtensionSelectable = true;
|
|
foreach ($oExtension->aModules as $sModuleId) {
|
|
if (array_key_exists($sModuleId, $this->aSelectedModules)) {
|
|
//already selected
|
|
continue;
|
|
}
|
|
|
|
if (array_key_exists($sModuleId, $this->aUnSelectedModules)) {
|
|
$aUnselectableModules[] = $sModuleId;
|
|
|
|
//already unselected
|
|
$bIsExtensionSelectable = false;
|
|
} else {
|
|
$aCurrentModules[$sModuleId] = true;
|
|
}
|
|
}
|
|
|
|
if ($bIsExtensionSelectable) {
|
|
SetupLog::Debug(
|
|
"Add modules from unpackaged extension",
|
|
null,
|
|
[
|
|
'extension' => $oExtension->sCode,
|
|
'source' => $oExtension->sSource,
|
|
'modules to add' => array_keys($aCurrentModules),
|
|
]
|
|
);
|
|
$this->aSelectedModules = array_merge($this->aSelectedModules, $aCurrentModules);
|
|
$this->aAfterComputationSelectedExtensions[] = $oExtension->sCode;
|
|
} else {
|
|
SetupLog::Warning(
|
|
"Unpackaged extension can not be selected due to modules incompatible with installation choices",
|
|
null,
|
|
[
|
|
'extension' => $oExtension->sCode,
|
|
'source' => $oExtension->sSource,
|
|
'modules' => array_keys($aCurrentModules),
|
|
'unselectable modules' => $aUnselectableModules,
|
|
]
|
|
);
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|