'.Dict::S('bkp-restore-running').'
'); @@ -156,7 +156,7 @@ try { require_once(APPROOT.'/setup/backup.class.inc.php'); require_once(__DIR__.'/dbrestore.class.inc.php'); - $sEnvironment = utils::ReadParam('environment', 'production', false, 'raw_data'); + $sEnvironment = utils::ReadParam('environment', ITOP_DEFAULT_ENV, false, 'raw_data'); try { set_time_limit(0); diff --git a/datamodels/2.x/itop-backup/dbrestore.class.inc.php b/datamodels/2.x/itop-backup/dbrestore.class.inc.php index e8ffe53d1..3a3ccbd1a 100644 --- a/datamodels/2.x/itop-backup/dbrestore.class.inc.php +++ b/datamodels/2.x/itop-backup/dbrestore.class.inc.php @@ -97,7 +97,7 @@ class DBRestore extends DBBackup * * @uses \RunTimeEnvironment::CompileFrom() */ - public function RestoreFromCompressedBackup($sFile, $sEnvironment = 'production') + public function RestoreFromCompressedBackup($sFile, $sEnvironment = ITOP_DEFAULT_ENV) { $oRestoreMutex = new iTopMutex('restore.'.$sEnvironment); IssueLog::Info("Backup Restore - Acquiring the LOCK 'restore.$sEnvironment'"); diff --git a/datamodels/2.x/itop-backup/restore.php b/datamodels/2.x/itop-backup/restore.php index 395f1c15c..bf18435c2 100644 --- a/datamodels/2.x/itop-backup/restore.php +++ b/datamodels/2.x/itop-backup/restore.php @@ -126,7 +126,7 @@ function ExecuteMainOperation($oP) if (MetaModel::GetConfig()->Get('demo_mode')) { $oP->p("Sorry, iTop is in demonstration mode: the feature is disabled"); } else { - $sEnvironment = utils::ReadParam('environment', 'production', false, 'raw_data'); + $sEnvironment = utils::ReadParam('environment', ITOP_DEFAULT_ENV, false, 'raw_data'); $oRestore->RestoreFromCompressedBackup($sBackupFile, $sEnvironment); } } diff --git a/datamodels/2.x/itop-core-update/src/Controller/AjaxController.php b/datamodels/2.x/itop-core-update/src/Controller/AjaxController.php index 34f772dd4..aa510a93d 100644 --- a/datamodels/2.x/itop-core-update/src/Controller/AjaxController.php +++ b/datamodels/2.x/itop-core-update/src/Controller/AjaxController.php @@ -246,10 +246,10 @@ class AjaxController extends Controller $iResponseCode = 200; try { $aParams['sAjaxURL'] = utils::GetAbsoluteUrlAppRoot().'/pages/UI.php'; - $oConfig = new Config(APPCONF.'production'.'/'.ITOP_CONFIG_FILE); - $oEnvironment = new RunTimeEnvironment('production'); + $oConfig = new Config(APPCONF.ITOP_DEFAULT_ENV.'/'.ITOP_CONFIG_FILE); + $oEnvironment = new RunTimeEnvironment(ITOP_DEFAULT_ENV); $oEnvironment->WriteConfigFileSafe($oConfig); - $oEnvironment->CompileFrom('production'); + $oEnvironment->CompileFrom(ITOP_DEFAULT_ENV); } catch (Exception $e) { IssueLog::Error('RebuildToolkitEnvironment: '.$e->getMessage()); $aParams['sError'] = $e->getMessage(); diff --git a/datamodels/2.x/itop-core-update/src/Service/CoreUpdater.php b/datamodels/2.x/itop-core-update/src/Service/CoreUpdater.php index b60524866..31b56e074 100644 --- a/datamodels/2.x/itop-core-update/src/Service/CoreUpdater.php +++ b/datamodels/2.x/itop-core-update/src/Service/CoreUpdater.php @@ -89,7 +89,7 @@ final class CoreUpdater // Compile code SetupLog::Info('itop-core-update: Start checking compilation'); - $sFinalEnv = 'production'; + $sFinalEnv = ITOP_DEFAULT_ENV; $oRuntimeEnv = new RunTimeEnvironmentCoreUpdater($sFinalEnv, false); $oRuntimeEnv->CheckDirectories($sFinalEnv); $oRuntimeEnv->CompileFrom($sFinalEnv); @@ -117,10 +117,10 @@ final class CoreUpdater // Compile code SetupLog::Info('itop-core-update: Start compilation'); - $sFinalEnv = 'production'; + $sFinalEnv = ITOP_DEFAULT_ENV; $oRuntimeEnv = new RunTimeEnvironmentCoreUpdater($sFinalEnv, true); $oRuntimeEnv->CheckDirectories($sFinalEnv); - $oRuntimeEnv->CompileFrom('production'); + $oRuntimeEnv->CompileFrom(ITOP_DEFAULT_ENV); SetupLog::Info('itop-core-update: Compilation done'); } catch (Exception $e) { @@ -142,7 +142,7 @@ final class CoreUpdater try { SetupLog::Info('itop-core-update: Start Update database'); - $sFinalEnv = 'production'; + $sFinalEnv = ITOP_DEFAULT_ENV; $oRuntimeEnv = new RunTimeEnvironmentCoreUpdater($sFinalEnv, true); $oConfig = $oRuntimeEnv->MakeConfigFile($sFinalEnv.' (built on '.date('Y-m-d').')'); $oConfig->Set('access_mode', ACCESS_FULL); diff --git a/datamodels/2.x/itop-core-update/src/Service/RunTimeEnvironmentCoreUpdater.php b/datamodels/2.x/itop-core-update/src/Service/RunTimeEnvironmentCoreUpdater.php index 807e6ee39..7aeed94bb 100644 --- a/datamodels/2.x/itop-core-update/src/Service/RunTimeEnvironmentCoreUpdater.php +++ b/datamodels/2.x/itop-core-update/src/Service/RunTimeEnvironmentCoreUpdater.php @@ -25,7 +25,7 @@ class RunTimeEnvironmentCoreUpdater extends RunTimeEnvironment * * @throws \Exception */ - public function __construct($sEnvironment = 'production', $bAutoCommit = true) + public function __construct($sEnvironment = ITOP_DEFAULT_ENV, $bAutoCommit = true) { parent::__construct($sEnvironment, $bAutoCommit); @@ -83,7 +83,7 @@ class RunTimeEnvironmentCoreUpdater extends RunTimeEnvironment { // Clone the default 'production' config file // - $oConfig = clone($this->GetConfig('production')); + $oConfig = clone($this->GetConfig(ITOP_DEFAULT_ENV)); $oConfig->UpdateIncludes('env-'.$this->sBuildEnv); diff --git a/datamodels/2.x/itop-hub-connector/land.php b/datamodels/2.x/itop-hub-connector/land.php index d50ac2b3d..b3553af0a 100644 --- a/datamodels/2.x/itop-hub-connector/land.php +++ b/datamodels/2.x/itop-hub-connector/land.php @@ -20,7 +20,7 @@ function DisplayStatus(WebPage $oPage) if (is_dir($sPath)) { $aExtraDirs[] = $sPath; // Also read the extra downloaded-modules directory } - $oExtensionsMap = new iTopExtensionsMap('production', $aExtraDirs); + $oExtensionsMap = new iTopExtensionsMap(ITOP_DEFAULT_ENV, $aExtraDirs); $oExtensionsMap->LoadChoicesFromDatabase(MetaModel::GetConfig()); foreach ($oExtensionsMap->GetAllExtensions() as $oExtension) { @@ -154,7 +154,7 @@ function DoInstall(WebPage $oPage) if (is_dir($sPath)) { $aExtraDirs[] = $sPath; // Also read the extra downloaded-modules directory } - $oExtensionsMap = new iTopExtensionsMap('production', $aExtraDirs); + $oExtensionsMap = new iTopExtensionsMap(ITOP_DEFAULT_ENV, $aExtraDirs); $oExtensionsMap->LoadChoicesFromDatabase(MetaModel::GetConfig()); foreach ($oExtensionsMap->GetAllExtensions() as $oExtension) { diff --git a/setup/ajax.dataloader.php b/setup/ajax.dataloader.php index 8e42e3c77..fa2aba589 100644 --- a/setup/ajax.dataloader.php +++ b/setup/ajax.dataloader.php @@ -149,9 +149,9 @@ try { if (is_subclass_of($sClass, 'WizardStep')) { /** @var WizardStep $oStep */ $oStep = new $sClass($oDummyController, $sState); - $sConfigFile = utils::GetConfigFilePath(); + $sConfigFile = utils::GetConfigFilePath(ITOP_DEFAULT_ENV); if (file_exists($sConfigFile) && !is_writable($sConfigFile) && $oStep->RequiresWritableConfig()) { - $sRelativePath = utils::GetConfigFilePathRelative(); + $sRelativePath = utils::GetConfigFilePathRelative(ITOP_DEFAULT_ENV); $oPage->error("Error: the configuration file '".$sRelativePath."' already exists and cannot be overwritten."); $oPage->p("The wizard cannot modify the configuration file for you. If you want to upgrade ".ITOP_APPLICATION.", make sure that the file '".$sRelativePath."' can be modified by the web server."); $oPage->output(); diff --git a/setup/compiler.class.inc.php b/setup/compiler.class.inc.php index c2bc78ec1..0e1a669eb 100644 --- a/setup/compiler.class.inc.php +++ b/setup/compiler.class.inc.php @@ -290,7 +290,7 @@ class MFCompiler } else { $oConfig = null; } - if (($this->sEnvironment == 'production') && !$bIsAlreadyInMaintenanceMode && $bEnterMaintenanceMode) { + if (($this->sEnvironment == ITOP_DEFAULT_ENV) && !$bIsAlreadyInMaintenanceMode && $bEnterMaintenanceMode) { SetupUtils::EnterMaintenanceMode($oConfig); } if ($bUseSymbolicLinks || $bSkipTempDir) { @@ -313,7 +313,7 @@ class MFCompiler // Cleanup the temporary directory SetupUtils::rrmdir($sTempTargetDir); } - if (($this->sEnvironment == 'production') && !$bIsAlreadyInMaintenanceMode && $bEnterMaintenanceMode) { + if (($this->sEnvironment == ITOP_DEFAULT_ENV) && !$bIsAlreadyInMaintenanceMode && $bEnterMaintenanceMode) { SetupUtils::ExitMaintenanceMode(); } throw $e; @@ -323,7 +323,7 @@ class MFCompiler // Move the results to the target directory SetupUtils::movedir($sTempTargetDir, $sFinalTargetDir); } - if (($this->sEnvironment == 'production') && !$bIsAlreadyInMaintenanceMode && $bEnterMaintenanceMode) { + if (($this->sEnvironment == ITOP_DEFAULT_ENV) && !$bIsAlreadyInMaintenanceMode && $bEnterMaintenanceMode) { SetupUtils::ExitMaintenanceMode(); } diff --git a/setup/extensionsmap.class.inc.php b/setup/extensionsmap.class.inc.php index 31ad96680..08ff6e6a5 100644 --- a/setup/extensionsmap.class.inc.php +++ b/setup/extensionsmap.class.inc.php @@ -41,7 +41,7 @@ class iTopExtensionsMap * @param bool $bNormailizeOldExtension true to "magically" convert some well-known old extensions (i.e. a set of modules) to the new iTopExtension format * @return void */ - public function __construct($sFromEnvironment = 'production', $aExtraDirs = []) + public function __construct($sFromEnvironment = ITOP_DEFAULT_ENV, $aExtraDirs = []) { $this->aExtensions = []; $this->aExtensionsByCode = []; diff --git a/setup/runtimeenv.class.inc.php b/setup/runtimeenv.class.inc.php index 808293a01..72560fe12 100644 --- a/setup/runtimeenv.class.inc.php +++ b/setup/runtimeenv.class.inc.php @@ -92,7 +92,7 @@ class RunTimeEnvironment * @param string $sEnvironment (e.g. 'test') * @param bool $bAutoCommit (make the final environment directly, or build a temporary one) */ - public function __construct($sEnvironment = 'production', $bAutoCommit = true) + public function __construct($sEnvironment = ITOP_DEFAULT_ENV, $bAutoCommit = true) { $this->sFinalEnv = $sEnvironment; if ($bAutoCommit) { @@ -167,10 +167,10 @@ class RunTimeEnvironment } if (! isset($_SESSION)) { - Session::$bAllowCLI = true; - Session::Start(); + //used in all UI setups (not unattended) + session_start(); } - Session::Set('itop_env', $this->sBuildEnv); + $_SESSION['itop_env'] = $this->sBuildEnv; MetaModel::Startup($oConfig, $bModelOnly, $bUseCache, false, $this->sBuildEnv); self::$bMetamodelStarted = true; @@ -1024,12 +1024,11 @@ class RunTimeEnvironment @chmod($sFinalConfig, 0440); // Read-only for owner and group, nothing for others @rmdir(dirname($sBuildConfig)); // Cleanup the temporary build dir if empty - MetaModel::ResetAllCaches($this->sFinalEnv); if (! isset($_SESSION)) { - Session::$bAllowCLI = true; - Session::Start(); + //used in all UI setups (not unattended) + session_start(); } - Session::Set('itop_env', $this->sFinalEnv); + $_SESSION['itop_env'] = $this->sFinalEnv; } } @@ -1318,7 +1317,7 @@ class RunTimeEnvironment public function DataToCleanupAudit() { - $oSetupAudit = new SetupAudit('production', $this->sBuildEnv); + $oSetupAudit = new SetupAudit(ITOP_DEFAULT_ENV, $this->sBuildEnv); //Make sure the MetaModel is started before analysing for issues $sConfFile = utils::GetConfigFilePath($this->sBuildEnv); @@ -1333,7 +1332,7 @@ class RunTimeEnvironment public function CopySetupFiles(): void { - $sSourceEnv = 'production'; + $sSourceEnv = ITOP_DEFAULT_ENV; $sDestinationEnv = $this->sBuildEnv; if ($sDestinationEnv != $sSourceEnv) { @@ -1347,10 +1346,6 @@ class RunTimeEnvironment chmod($sFinalConfig, 0770); // In case it exists: RWX for owner and group, nothing for others } SetupUtils::copydir(APPCONF.$sSourceEnv, APPCONF.$sDestinationEnv); - if (is_file($sFinalConfig)) { - chmod($sFinalConfig, 0440); // Read-only for owner and group, nothing for others - } - MetaModel::ResetAllCaches($sDestinationEnv); } } @@ -1456,7 +1451,7 @@ class RunTimeEnvironment SetupUtils::tidydir($sBuildPath); } - $oExtensionsMap = new iTopExtensionsMap('production', $aDirsToScan); + $oExtensionsMap = new iTopExtensionsMap(ITOP_DEFAULT_ENV, $aDirsToScan); // Removed modules are stored as static for FindModules() $oExtensionsMap->DeclareExtensionAsRemoved($aRemovedExtensionCodes); diff --git a/setup/sequencers/ApplicationInstallSequencer.php b/setup/sequencers/ApplicationInstallSequencer.php index 11e37b02c..012c84d4f 100644 --- a/setup/sequencers/ApplicationInstallSequencer.php +++ b/setup/sequencers/ApplicationInstallSequencer.php @@ -67,7 +67,6 @@ class ApplicationInstallSequencer extends StepSequencer case 'backup': if (array_key_exists('backup', $this->oParams->Get('optional_steps', []))) { - $aBackupOptions = $this->oParams->Get('optional_steps')['backup']; // __DB__-%Y-%m-%d $sDestination = $aBackupOptions['destination']; @@ -136,7 +135,7 @@ class ApplicationInstallSequencer extends StepSequencer return $this->GetNextStep('', "Unknown setup step '$sStep'.", 100, '', self::ERROR); } } catch (Exception $e) { - $this->ReportException($e); + SetupLog::Exception("$sStep failed", $e); $aResult = $this->GetNextStep('', '', 100, $e->getMessage(), self::ERROR); $aResult['error_code'] = $e->getCode(); return $aResult; diff --git a/setup/sequencers/DataAuditSequencer.php b/setup/sequencers/DataAuditSequencer.php index 01664c37c..718692f5e 100644 --- a/setup/sequencers/DataAuditSequencer.php +++ b/setup/sequencers/DataAuditSequencer.php @@ -64,20 +64,19 @@ class DataAuditSequencer extends StepSequencer $sExtensionDir, $bUseSymbolicLinks ); - if ($this->IsDataAuditRequired()) { - return $this->GetNextStep('setup-audit', 'Checking data consistency with the new data model', 70, $sMessage); - } - return $this->GetNextStep('', 'Completed', 100); + return $this->GetNextStep('setup-audit', 'Checking data consistency with the new data model', 70, $sMessage); case 'setup-audit': - $this->oRunTimeEnvironment->DataToCleanupAudit(); + if ($this->IsDataAuditRequired()) { + $this->oRunTimeEnvironment->DataToCleanupAudit(); + } return $this->GetNextStep('', 'Completed', 100); default: return $this->GetNextStep('', "Unknown setup step '$sStep'.", 100, '', self::ERROR); } } catch (Exception $e) { - $this->ReportException($e); + SetupLog::Exception("$sStep failed", $e); $aResult = $this->GetNextStep('', '', 100, $e->getMessage(), self::ERROR); $aResult['error_code'] = $e->getCode(); return $aResult; diff --git a/setup/sequencers/StepSequencer.php b/setup/sequencers/StepSequencer.php index 5f3d5664e..da1b9ae6b 100644 --- a/setup/sequencers/StepSequencer.php +++ b/setup/sequencers/StepSequencer.php @@ -159,24 +159,6 @@ abstract class StepSequencer file_put_contents(APPROOT.'log/'.$sFileName.'.xml', $sSafeXml); } - protected function ReportException(Exception $e) - { - SetupLog::Error('An exception occurred: '.$e->getMessage().' at line '.$e->getLine().' in file '.$e->getFile()); - $idx = 0; - // Log the call stack, but not the parameters since they may contain passwords or other sensitive data - SetupLog::Ok('Call stack:'); - foreach ($e->getTrace() as $aTrace) { - $sLine = empty($aTrace['line']) ? '' : $aTrace['line']; - $sFile = empty($aTrace['file']) ? '' : $aTrace['file']; - $sClass = empty($aTrace['class']) ? '' : $aTrace['class']; - $sType = empty($aTrace['type']) ? '' : $aTrace['type']; - $sFunction = empty($aTrace['function']) ? '' : $aTrace['function']; - $sVerb = empty($sClass) ? $sFunction : "$sClass{$sType}$sFunction"; - SetupLog::Ok("#$idx $sFile($sLine): $sVerb(...)"); - $idx++; - } - } - protected function GetConfig() { $sTargetEnvironment = $this->oRunTimeEnvironment->GetBuildEnv(); diff --git a/setup/setuputils.class.inc.php b/setup/setuputils.class.inc.php index f10f8532a..9b9e88485 100644 --- a/setup/setuputils.class.inc.php +++ b/setup/setuputils.class.inc.php @@ -915,7 +915,7 @@ class SetupUtils $aResult['found'] = true; } elseif (file_exists($sDir.'/conf/production/config-itop.php')) { $sSourceDir = $sDir; - $sSourceEnvironment = 'production'; + $sSourceEnvironment = ITOP_DEFAULT_ENV; $sConfigFile = $sDir.'/conf/production/config-itop.php'; $aResult['found'] = true; } @@ -1586,7 +1586,7 @@ JS } $oProductionEnv = new RunTimeEnvironment(); $aRemovedExtensionCodes = json_decode($oWizard->GetParameter('removed_extensions'), true) ?? []; - $oExtensionsMap = new iTopExtensionsMap('production', $aDirsToScan); + $oExtensionsMap = new iTopExtensionsMap(ITOP_DEFAULT_ENV, $aDirsToScan); $oExtensionsMap->DeclareExtensionAsRemoved($aRemovedExtensionCodes); $aAvailableModules = $oProductionEnv->AnalyzeInstallation($oConfig, $aDirsToScan, $bAbortOnMissingDependency, $aModulesToLoad); diff --git a/setup/unattended-install/InstallationFileService.php b/setup/unattended-install/InstallationFileService.php index f3e1e1b89..7eea61c3a 100644 --- a/setup/unattended-install/InstallationFileService.php +++ b/setup/unattended-install/InstallationFileService.php @@ -31,7 +31,7 @@ class InstallationFileService * @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) + public function __construct(string $sInstallationPath, string $sTargetEnvironment = ITOP_DEFAULT_ENV, array $aSelectedExtensions = [], bool $bInstallationOptionalChoicesChecked = true) { $this->sInstallationPath = $sInstallationPath; $this->aSelectedModules = []; diff --git a/setup/unattended-install/unattended-install.php b/setup/unattended-install/unattended-install.php index a89fdef0d..4d75a01c6 100644 --- a/setup/unattended-install/unattended-install.php +++ b/setup/unattended-install/unattended-install.php @@ -56,7 +56,7 @@ $sMode = $oParams->Get('mode'); $sTargetEnvironment = $oParams->Get('target_env', ''); if ($sTargetEnvironment == '') { - $sTargetEnvironment = 'production'; + $sTargetEnvironment = ITOP_DEFAULT_ENV; } $sXmlSetupBaseName = basename($sParamFile); @@ -218,7 +218,7 @@ if ($sMode == 'install') { //use settings from itop conf $sTargetEnvironment = $oParams->Get('target_env', ''); if ($sTargetEnvironment == '') { - $sTargetEnvironment = 'production'; + $sTargetEnvironment = ITOP_DEFAULT_ENV; } $sTargetDir = APPROOT.'env-'.$sTargetEnvironment; } @@ -271,6 +271,10 @@ $bFoundIssues = false; $bInstall = utils::ReadParam('install', true, true /* CLI allowed */); if ($bInstall) { + if (! isset($_SESSION)) { + $_SESSION = []; + } + echo "Starting the unattended installation...\n"; $oWizard = new DataAuditSequencer($oParams); $bRes = $oWizard->ExecuteAllSteps(); diff --git a/setup/wizardcontroller.class.inc.php b/setup/wizardcontroller.class.inc.php index 9f7eee90e..a02a5415e 100644 --- a/setup/wizardcontroller.class.inc.php +++ b/setup/wizardcontroller.class.inc.php @@ -190,15 +190,16 @@ class WizardController */ protected function DisplayStep(WizardStep $oStep) { + SetupLog::Info("=== Setup screen: ".$oStep->GetTitle().' ('.get_class($oStep).')'); $oPage = new SetupPage($oStep->GetTitle()); if ($oStep->RequiresWritableConfig()) { - $sConfigFile = utils::GetConfigFilePath(); + $sConfigFile = utils::GetConfigFilePath(ITOP_DEFAULT_ENV); if (file_exists($sConfigFile)) { // The configuration file already exists if (!is_writable($sConfigFile)) { SetupUtils::ExitReadOnlyMode(false); // Reset readonly mode in case of problem SetupUtils::EraseSetupToken(); - $sRelativePath = utils::GetConfigFilePathRelative(); + $sRelativePath = utils::GetConfigFilePathRelative(ITOP_DEFAULT_ENV); $oP = new SetupPage('Installation Cannot Continue'); $oP->add("