mirror of
https://github.com/Combodo/iTop.git
synced 2026-02-13 07:24:13 +01:00
2045 lines
69 KiB
PHP
2045 lines
69 KiB
PHP
<?php
|
|
// Copyright (C) 2012 Combodo SARL
|
|
//
|
|
// This program is free software; you can redistribute it and/or modify
|
|
// it under the terms of the GNU General Public License as published by
|
|
// the Free Software Foundation; version 3 of the License.
|
|
//
|
|
// This program is distributed in the hope that it will be useful,
|
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
// GNU General Public License for more details.
|
|
//
|
|
// You should have received a copy of the GNU General Public License
|
|
// along with this program; if not, write to the Free Software
|
|
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
|
|
|
|
/**
|
|
* All the steps of the iTop installation wizard
|
|
* @author Erwan Taloc <erwan.taloc@combodo.com>
|
|
* @author Romain Quetiez <romain.quetiez@combodo.com>
|
|
* @author Denis Flaven <denis.flaven@combodo.com>
|
|
* @license http://www.opensource.org/licenses/gpl-3.0.html GPL
|
|
*/
|
|
|
|
require_once(APPROOT.'setup/setuputils.class.inc.php');
|
|
require_once(APPROOT.'setup/parameters.class.inc.php');
|
|
require_once(APPROOT.'setup/applicationinstaller.class.inc.php');
|
|
require_once(APPROOT.'setup/parameters.class.inc.php');
|
|
|
|
/**
|
|
* First step of the iTop Installation Wizard: Welcome screen
|
|
*/
|
|
class WizStepWelcome extends WizardStep
|
|
{
|
|
protected $bCanMoveForward;
|
|
|
|
public function GetTitle()
|
|
{
|
|
return 'Welcome to '.ITOP_APPLICATION.' version '.ITOP_VERSION;
|
|
}
|
|
|
|
/**
|
|
* Returns the label for the " Next >> " button
|
|
* @return string The label for the button
|
|
*/
|
|
public function GetNextButtonLabel()
|
|
{
|
|
return ' Continue >> ';
|
|
}
|
|
|
|
public function GetPossibleSteps()
|
|
{
|
|
return array('WizStepInstallOrUpgrade');
|
|
}
|
|
|
|
public function ProcessParams($bMoveForward = true)
|
|
{
|
|
return array('class' => 'WizStepInstallOrUpgrade', 'state' => '');
|
|
}
|
|
|
|
public function Display(WebPage $oPage)
|
|
{
|
|
// Store the misc_options for the future...
|
|
$aMiscOptions = utils::ReadParam('option', array(), false, 'raw_data');
|
|
$sMiscOptions = $this->oWizard->GetParameter('misc_options', json_encode($aMiscOptions));
|
|
$this->oWizard->SetParameter('misc_options', $sMiscOptions);
|
|
|
|
$oPage->add('<h1>'.ITOP_APPLICATION.' Installation Wizard</h1>');
|
|
$aResults = SetupUtils::CheckPHPVersion($oPage);
|
|
$this->bCanMoveForward = true;
|
|
$aInfo = array();
|
|
$aWarnings = array();
|
|
$aErrors = array();
|
|
foreach($aResults as $oCheckResult)
|
|
{
|
|
switch($oCheckResult->iSeverity)
|
|
{
|
|
case CheckResult::ERROR:
|
|
$aErrors[] = $oCheckResult->sLabel;
|
|
$this->bCanMoveForward = false;
|
|
break;
|
|
|
|
case CheckResult::WARNING:
|
|
$aWarnings[] = $oCheckResult->sLabel;
|
|
break;
|
|
|
|
case CheckResult::INFO:
|
|
$aInfo[] = $oCheckResult->sLabel;
|
|
break;
|
|
}
|
|
}
|
|
$sStyle = 'style="display:none;max-height:196px;overflow:auto;"';
|
|
$sToggleButtons = '<button type="button" id="show_details" onclick="$(\'#details\').toggle(); $(this).toggle(); $(\'#hide_details\').toggle();">Show details</button><button type="button" id="hide_details" style="display:none;" onclick="$(\'#details\').toggle(); $(this).toggle(); $(\'#show_details\').toggle();">Hide details</button>';
|
|
if (count($aErrors)> 0)
|
|
{
|
|
$sStyle = 'style="max-height:196px;overflow:auto;"';
|
|
$sImage = "stop-mid.png";
|
|
$sTitle = count($aErrors).' Error(s), '.count($aWarnings).' Warning(s).';
|
|
}
|
|
else if (count($aWarnings)> 0)
|
|
{
|
|
$sTitle = count($aWarnings).' Warning(s) '.$sToggleButtons;
|
|
$sImage = "messagebox_warning-mid.png";
|
|
}
|
|
else
|
|
{
|
|
$sTitle = 'Ok. '.$sToggleButtons;
|
|
$sImage = "clean-mid.png";
|
|
}
|
|
$oPage->add('<h2>Prerequisites validation: ');
|
|
$oPage->add("<img style=\"vertical-align:middle;\" src=\"../images/$sImage\"> ");
|
|
$oPage->add($sTitle);
|
|
$oPage->add('</h2>');
|
|
$oPage->add('<div id="details" '.$sStyle.'>');
|
|
foreach($aErrors as $sText)
|
|
{
|
|
$oPage->error($sText);
|
|
}
|
|
foreach($aWarnings as $sText)
|
|
{
|
|
$oPage->warning($sText);
|
|
}
|
|
foreach($aInfo as $sText)
|
|
{
|
|
$oPage->ok($sText);
|
|
}
|
|
$oPage->add('</div>');
|
|
if (!$this->bCanMoveForward)
|
|
{
|
|
$oPage->p('Sorry, the installation cannot continue. Please fix the errors and reload this page to launch the installation again.');
|
|
}
|
|
}
|
|
|
|
public function CanMoveForward()
|
|
{
|
|
return $this->bCanMoveForward;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Second step of the iTop Installation Wizard: Install or Upgrade
|
|
*/
|
|
class WizStepInstallOrUpgrade extends WizardStep
|
|
{
|
|
public function GetTitle()
|
|
{
|
|
return 'Install or Upgrade choice';
|
|
}
|
|
|
|
public function GetPossibleSteps()
|
|
{
|
|
return array('WizStepDetectedInfo', 'WizStepLicense');
|
|
}
|
|
|
|
public function ProcessParams($bMoveForward = true)
|
|
{
|
|
$sNextStep = '';
|
|
$sInstallMode = utils::ReadParam('install_mode');
|
|
|
|
$this->oWizard->SaveParameter('previous_version_dir', '');
|
|
$this->oWizard->SaveParameter('db_server', '');
|
|
$this->oWizard->SaveParameter('db_user', '');
|
|
$this->oWizard->SaveParameter('db_pwd', '');
|
|
$this->oWizard->SaveParameter('db_name', '');
|
|
$this->oWizard->SaveParameter('db_prefix', '');
|
|
$this->oWizard->SaveParameter('db_backup', false);
|
|
$this->oWizard->SaveParameter('db_backup_path', '');
|
|
|
|
if ($sInstallMode == 'install')
|
|
{
|
|
$this->oWizard->SetParameter('install_mode', 'install');
|
|
$sFullSourceDir = SetupUtils::GetLatestDataModelDir();
|
|
$this->oWizard->SetParameter('source_dir', $sFullSourceDir);
|
|
$this->oWizard->SetParameter('datamodel_version', SetupUtils::GetDataModelVersion($sFullSourceDir));
|
|
$sNextStep = 'WizStepLicense';
|
|
}
|
|
else
|
|
{
|
|
$this->oWizard->SetParameter('install_mode', 'upgrade');
|
|
$sNextStep = 'WizStepDetectedInfo';
|
|
|
|
}
|
|
return array('class' => $sNextStep, 'state' => '');
|
|
}
|
|
|
|
public function Display(WebPage $oPage)
|
|
{
|
|
$sInstallMode = $this->oWizard->GetParameter('install_mode', '');
|
|
$sDBServer = $this->oWizard->GetParameter('db_server', '');
|
|
$sDBUser = $this->oWizard->GetParameter('db_user', '');
|
|
$sDBPwd = $this->oWizard->GetParameter('db_pwd', '');
|
|
$sDBName = $this->oWizard->GetParameter('db_name', '');
|
|
$sDBPrefix = $this->oWizard->GetParameter('db_prefix', '');
|
|
$bDBBackup = $this->oWizard->GetParameter('db_backup', false);
|
|
$sDBBackupPath = $this->oWizard->GetParameter('db_backup_path', '');
|
|
$sPreviousVersionDir = '';
|
|
if ($sInstallMode == '')
|
|
{
|
|
$sDBBackupPath = APPROOT.'data/'.ITOP_APPLICATION.strftime('-backup-%Y-%m-%d.zip');
|
|
$bDBBackup = true;
|
|
$aPreviousInstance = SetupUtils::GetPreviousInstance(APPROOT);
|
|
if ($aPreviousInstance['found'])
|
|
{
|
|
$sInstallMode = 'upgrade';
|
|
$sSourceDir = APPROOT;
|
|
$sDBServer = $aPreviousInstance['db_server'];
|
|
$sDBUser = $aPreviousInstance['db_user'];
|
|
$sDBPwd = $aPreviousInstance['db_pwd'];
|
|
$sDBName = $aPreviousInstance['db_name'];
|
|
$sDBPrefix = $aPreviousInstance['db_prefix'];
|
|
$sStyle = '';
|
|
$sPreviousVersionDir = APPROOT;
|
|
}
|
|
else
|
|
{
|
|
$sInstallMode = 'install';
|
|
}
|
|
}
|
|
$sPreviousVersionDir = $this->oWizard->GetParameter('previous_version_dir', $sPreviousVersionDir);
|
|
|
|
$sUpgradeInfoStyle = '';
|
|
if ($sInstallMode == 'install')
|
|
{
|
|
$sUpgradeInfoStyle = ' style="display: none;" ';
|
|
}
|
|
$oPage->add('<h2>What do you want to do?</h2>');
|
|
$sChecked = ($sInstallMode == 'install') ? ' checked ' : '';
|
|
$oPage->p('<input id="radio_install" type="radio" name="install_mode" value="install"'.$sChecked.'/><label for="radio_install"> Install a new '.ITOP_APPLICATION.'</label>');
|
|
$sChecked = ($sInstallMode == 'upgrade') ? ' checked ' : '';
|
|
$oPage->p('<input id="radio_update" type="radio" name="install_mode" value="upgrade"'.$sChecked.'/><label for="radio_update"> Upgrade an existing '.ITOP_APPLICATION.' instance</label>');
|
|
//$oPage->add('<fieldset id="upgrade_info"'.$sUpgradeInfoStyle.'>');
|
|
//$oPage->add('<legend>Information about the previous instance:</legend>');
|
|
$oPage->add('<table id="upgrade_info"'.$sUpgradeInfoStyle.'>');
|
|
$oPage->add('<tr><td>Location on the disk:</td><td><input id="previous_version_dir" type="text" name="previous_version_dir" value="'.htmlentities($sPreviousVersionDir, ENT_QUOTES, 'UTF-8').'" size="25"/></td></tr>');
|
|
SetupUtils::DisplayDBParameters($oPage, false, $sDBServer, $sDBUser, $sDBPwd, $sDBName, $sDBPrefix);
|
|
|
|
$aBackupChecks = SetupUtils::CheckBackupPrerequisites($sDBBackupPath);
|
|
$bCanBackup = true;
|
|
$sMySQLDumpMessage = '';
|
|
foreach($aBackupChecks as $oCheck)
|
|
{
|
|
if ($oCheck->iSeverity == CheckResult::ERROR)
|
|
{
|
|
$bCanBackup = false;
|
|
$sMySQLDumpMessage .= '<img src="../images/error.png"/> <b> Warning:</b> '.$oCheck->sLabel;
|
|
}
|
|
else
|
|
{
|
|
$sMySQLDumpMessage .= '<img src="../images/validation_ok.png"/> '.$oCheck->sLabel.' ';
|
|
}
|
|
}
|
|
$sChecked = ($bCanBackup && $bDBBackup) ? ' checked ' : '';
|
|
$sDisabled = $bCanBackup ? '' : ' disabled ';
|
|
$oPage->add('<tr><td colspan="2"><input id="db_backup" type="checkbox" name="db_backup"'.$sChecked.$sDisabled.' value="1"/><label for="db_backup"> Backup the '.ITOP_APPLICATION.' database before upgrading</label></td></tr>');
|
|
$oPage->add('<tr><td colspan="2">Save the backup to: <input id="db_backup_path" type="text" name="db_backup_path" '.$sDisabled.'value="'.htmlentities($sDBBackupPath, ENT_QUOTES, 'UTF-8').'" size="25"/></td></tr>');
|
|
$fFreeSpace = SetupUtils::CheckDiskSpace($sDBBackupPath);
|
|
$sMessage = '';
|
|
if ($fFreeSpace !== false)
|
|
{
|
|
$sMessage .= SetupUtils::HumanReadableSize($fFreeSpace).' free in '.dirname($sDBBackupPath);
|
|
}
|
|
$oPage->add('<tr><td colspan="2">');
|
|
$oPage->add($sMySQLDumpMessage.'<br/><span id="backup_info" style="font-size:small;color:#696969;">'.$sMessage.'</span></td></tr>');
|
|
$oPage->add('</table>');
|
|
//$oPage->add('</fieldset>');
|
|
$oPage->add_ready_script(
|
|
<<<EOF
|
|
$("#radio_update").bind('change', function() { if (this.checked ) { $('#upgrade_info').show(); WizardUpdateButtons(); } else { $('#upgrade_info').hide(); } });
|
|
$("#radio_install").bind('change', function() { if (this.checked ) { $('#upgrade_info').hide(); WizardUpdateButtons(); } else { $('#upgrade_info').show(); } });
|
|
$("#previous_version_dir").bind('change keyup', function() { WizardAsyncAction('check_path', { previous_version_dir: $('#previous_version_dir').val() }); });
|
|
$("#db_backup_path").bind('change keyup', function() { WizardAsyncAction('check_backup', { db_backup_path: $('#db_backup_path').val() }); });
|
|
EOF
|
|
);
|
|
}
|
|
|
|
public function AsyncAction(WebPage $oPage, $sCode, $aParameters)
|
|
{
|
|
switch($sCode)
|
|
{
|
|
case 'check_path':
|
|
$sPreviousVersionDir = $aParameters['previous_version_dir'];
|
|
$aPreviousInstance = SetupUtils::GetPreviousInstance($sPreviousVersionDir);
|
|
if ($aPreviousInstance['found'])
|
|
{
|
|
$sDBServer = htmlentities($aPreviousInstance['db_server'], ENT_QUOTES, 'UTF-8');
|
|
$sDBUser = htmlentities($aPreviousInstance['db_user'], ENT_QUOTES, 'UTF-8');
|
|
$sDBPwd = htmlentities($aPreviousInstance['db_pwd'], ENT_QUOTES, 'UTF-8');
|
|
$sDBName = htmlentities($aPreviousInstance['db_name'], ENT_QUOTES, 'UTF-8');
|
|
$sDBPrefix = htmlentities($aPreviousInstance['db_prefix'], ENT_QUOTES, 'UTF-8');
|
|
$oPage->add_ready_script(
|
|
<<<EOF
|
|
$("#db_server").val('$sDBServer');
|
|
$("#db_user").val('$sDBUser');
|
|
$("#db_pwd").val('$sDBPwd');
|
|
$("#db_name").val('$sDBName');
|
|
$("#db_prefix").val('$sDBPrefix');
|
|
EOF
|
|
);
|
|
}
|
|
break;
|
|
|
|
case 'check_db':
|
|
SetupUtils:: AsyncCheckDB($oPage, $aParameters);
|
|
break;
|
|
|
|
case 'check_backup':
|
|
$sDBBackupPath = $aParameters['db_backup_path'];
|
|
$fFreeSpace = SetupUtils::CheckDiskSpace($sDBBackupPath);
|
|
if ($fFreeSpace !== false)
|
|
{
|
|
$sMessage = htmlentities(SetupUtils::HumanReadableSize($fFreeSpace).' free in '.dirname($sDBBackupPath), ENT_QUOTES, 'UTF-8');
|
|
$oPage->add_ready_script(
|
|
<<<EOF
|
|
$("#backup_info").html('$sMessage');
|
|
EOF
|
|
);
|
|
}
|
|
else
|
|
{
|
|
$oPage->add_ready_script(
|
|
<<<EOF
|
|
$("#backup_info").html('');
|
|
EOF
|
|
);
|
|
}
|
|
break;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Tells whether the "Next" button should be enabled interactively
|
|
* @return string A piece of javascript code returning either true or false
|
|
*/
|
|
public function JSCanMoveForward()
|
|
{
|
|
return
|
|
<<<EOF
|
|
if ($("#radio_install").attr("checked") == "checked")
|
|
{
|
|
ValidateField("db_name", false);
|
|
ValidateField("db_new_name", false);
|
|
ValidateField("db_prefix", false);
|
|
return true;
|
|
}
|
|
else
|
|
{
|
|
var bRet = ($("#wiz_form").data("db_connection") !== "error");
|
|
bRet = ValidateField("db_name", true) && bRet;
|
|
bRet = ValidateField("db_new_name", true) && bRet;
|
|
bRet = ValidateField("db_prefix", true) && bRet;
|
|
|
|
return bRet;
|
|
}
|
|
EOF
|
|
;
|
|
}
|
|
|
|
}
|
|
|
|
/**
|
|
* Upgrade information
|
|
*/
|
|
class WizStepDetectedInfo extends WizardStep
|
|
{
|
|
protected $bCanMoveForward;
|
|
|
|
public function GetTitle()
|
|
{
|
|
return 'Upgrade Information';
|
|
}
|
|
|
|
public function GetPossibleSteps()
|
|
{
|
|
return array('WizStepUpgradeMiscParams', 'WizStepLicense2');
|
|
}
|
|
|
|
public function ProcessParams($bMoveForward = true)
|
|
{
|
|
$sUpgradeType = utils::ReadParam('upgrade_type');
|
|
|
|
$this->oWizard->SetParameter('mode', 'upgrade');
|
|
$this->oWizard->SetParameter('upgrade_type', $sUpgradeType);
|
|
$this->oWizard->SaveParameter('copy_extensions_from', '');
|
|
$bDisplayLicense = $this->oWizard->GetParameter('display_license');
|
|
|
|
switch ($sUpgradeType)
|
|
{
|
|
case 'keep-previous':
|
|
$sSourceDir = utils::ReadParam('relative_source_dir', '', false, 'raw_data');
|
|
$this->oWizard->SetParameter('source_dir', $this->oWizard->GetParameter('previous_version_dir').'/'.$sSourceDir);
|
|
$this->oWizard->SetParameter('datamodel_version', utils::ReadParam('datamodel_previous_version', '', false, 'raw_data'));
|
|
break;
|
|
|
|
case 'use-compatible':
|
|
$sDataModelPath = utils::ReadParam('datamodel_path', '', false, 'raw_data');
|
|
$this->oWizard->SetParameter('source_dir', $sDataModelPath);
|
|
$this->oWizard->SaveParameter('datamodel_version', '');
|
|
break;
|
|
|
|
default:
|
|
// Do nothing, maybe the user pressed the Back button
|
|
}
|
|
if ($bDisplayLicense)
|
|
{
|
|
$aRet = array('class' => 'WizStepLicense2', 'state' => '');
|
|
}
|
|
else
|
|
{
|
|
$aRet = array('class' => 'WizStepUpgradeMiscParams', 'state' => '');
|
|
}
|
|
return $aRet;
|
|
}
|
|
|
|
public function Display(WebPage $oPage)
|
|
{
|
|
$oPage->add_style(
|
|
<<<EOF
|
|
#changes_summary {
|
|
max-height: 200px;
|
|
overflow: auto;
|
|
}
|
|
#changes_summary div {
|
|
width:100;
|
|
margin-top:0;
|
|
padding-top: 0.5em;
|
|
padding-left: 0;
|
|
}
|
|
#changes_summary div ul {
|
|
margin-left:0;
|
|
padding-left: 20px;
|
|
}
|
|
#changes_summary div.closed ul {
|
|
display:none;
|
|
}
|
|
#changes_summary div li {
|
|
list-style: none;
|
|
width: 100;
|
|
margin-left:0;
|
|
padding-left: 0em;
|
|
}
|
|
.title {
|
|
padding-left: 20px;
|
|
font-weight: bold;
|
|
cursor: pointer;
|
|
background: url(../images/minus.gif) 2px 2px no-repeat;
|
|
}
|
|
#changes_summary div.closed .title {
|
|
background: url(../images/plus.gif) 2px 2px no-repeat;
|
|
}
|
|
EOF
|
|
);
|
|
$this->bCanMoveForward = true;
|
|
$bDisplayLicense = true;
|
|
$sPreviousVersionDir = $this->oWizard->GetParameter('previous_version_dir', '');
|
|
$aInstalledInfo = SetupUtils::GetApplicationVersion($this->oWizard);
|
|
|
|
if ($aInstalledInfo === false)
|
|
{
|
|
throw(new Exception('No previous version of '.ITOP_APPLICATION.' found in the supplied database. The upgrade cannot continue.'));
|
|
}
|
|
else if (strcasecmp($aInstalledInfo['product_name'], ITOP_APPLICATION) != 0)
|
|
{
|
|
$oPage->p("<b>Warning: The installed products seem different. Are you sure the you want to upgrade {$aInstalledInfo['product_name']} with ".ITOP_APPLICATION."?</b>");
|
|
}
|
|
|
|
$sInstalledVersion = $aInstalledInfo['product_version'];
|
|
$sInstalledDataModelVersion = $aInstalledInfo['datamodel_version'];
|
|
|
|
$oPage->add("<h2>Information about the upgrade from version $sInstalledVersion to ".ITOP_VERSION.'.'.ITOP_REVISION."</h2>");
|
|
|
|
if ($sInstalledVersion == (ITOP_VERSION.'.'.ITOP_REVISION))
|
|
{
|
|
// Reinstalling the same version let's skip the license agreement...
|
|
$bDisplayLicense = false;
|
|
}
|
|
$this->oWizard->SetParameter('license', $bDisplayLicense); // Remember for later
|
|
|
|
if ($sInstalledDataModelVersion == '$ITOP_VERSION$.$WCREV$')
|
|
{
|
|
// Special case for upgrading some development versions (temporary)
|
|
$sCompatibleDMDir = SetupUtils::GetLatestDataModelDir();
|
|
$sInstalledDataModelVersion = SetupUtils::GetDataModelVersion($sLatestDMDir);
|
|
}
|
|
else
|
|
{
|
|
$sCompatibleDMDir = SetupUtils::GetCompatibleDataModelDir($sInstalledDataModelVersion);
|
|
}
|
|
|
|
if ($sCompatibleDMDir === false)
|
|
{
|
|
// No compatible version exists... cannot upgrade. Either it is too old, or too new (downgrade !)
|
|
$this->bCanMoveForward = false;
|
|
$oPage->p("The current version of ".ITOP_APPLICATION." (".ITOP_VERSION.'.'.ITOP_REVISION.") does not seem to be compatible with the installed version ($sInstalledVersion).");
|
|
$oPage->p("The upgrade cannot continue, sorry.");
|
|
}
|
|
else
|
|
{
|
|
$sUpgradeDMVersion = SetupUtils::GetDataModelVersion($sCompatibleDMDir);
|
|
$sPreviousSourceDir = isset($aInstalledInfo['source_dir']) ? $aInstalledInfo['source_dir'] : 'modules';
|
|
$aChanges = false;
|
|
if (is_dir($sPreviousVersionDir))
|
|
{
|
|
// Check if the previous version is a "genuine" one or not...
|
|
$aChanges = SetupUtils::CheckVersion($sInstalledDataModelVersion, $sPreviousVersionDir.'/'.$sPreviousSourceDir);
|
|
}
|
|
if (($aChanges !== false) && (count($aChanges) > 0))
|
|
{
|
|
// Some changes were detected, prompt the user to keep or discard them
|
|
$oPage->p("<img src=\"../images/error.png\"/> Some modifications were detected between the ".ITOP_APPLICATION." version in '$sPreviousVersionDir' and a genuine $sInstalledVersion version.");
|
|
$oPage->p("What do you want to do?");
|
|
|
|
$aWritableDirs = array('modules', 'portal');
|
|
$aErrors = SetupUtils::CheckWritableDirs($aWritableDirs);
|
|
$sChecked = ($this->oWizard->GetParameter('upgrade_type') == 'keep-previous') ? ' checked ' : '';
|
|
$sDisabled = (count($aErrors) > 0) ? ' disabled ' : '';
|
|
|
|
$oPage->p('<input id="radio_upgrade_keep" type="radio" name="upgrade_type" value="keep-previous"'.$sChecked.$sDisabled.'/><label for="radio_upgrade_keep"> Preserve the modifications of the installed version (the dasboards inside '.ITOP_APPLICATION.' may not be editable).</label>');
|
|
$oPage->add('<input type="hidden" name="datamodel_previous_version" value="'.htmlentities($sInstalledDataModelVersion, ENT_QUOTES, 'UTF-8').'">');
|
|
|
|
$oPage->add('<input type="hidden" name="relative_source_dir" value="'.htmlentities($sPreviousSourceDir, ENT_QUOTES, 'UTF-8').'">');
|
|
|
|
if (count($aErrors) > 0)
|
|
{
|
|
$oPage->p("Cannot copy the installed version due to the following access rights issue(s):");
|
|
foreach($aErrors as $sDir => $oCheckResult)
|
|
{
|
|
$oPage->p('<img src="../images/error.png"/> '.$oCheckResult->sLabel);
|
|
}
|
|
}
|
|
|
|
$sChecked = ($this->oWizard->GetParameter('upgrade_type') == 'use-compatible') ? ' checked ' : '';
|
|
|
|
$oPage->p('<input id="radio_upgrade_convert" type="radio" name="upgrade_type" value="use-compatible"'.$sChecked.'/><label for="radio_upgrade_convert"> Discard the modifications, use a standard '.$sUpgradeDMVersion.' data model.</label>');
|
|
|
|
$oPage->add('<input type="hidden" name="datamodel_path" value="'.htmlentities($sCompatibleDMDir, ENT_QUOTES, 'UTF-8').'">');
|
|
$oPage->add('<input type="hidden" name="datamodel_version" value="'.htmlentities($sUpgradeDMVersion, ENT_QUOTES, 'UTF-8').'">');
|
|
|
|
$oPage->add('<div id="changes_summary"><div class="closed"><span class="title">Details of the modifications</span><div>');
|
|
if (count($aChanges['added']) > 0)
|
|
{
|
|
$oPage->add('<ul>New files added:');
|
|
foreach($aChanges['added'] as $sFilePath => $void)
|
|
{
|
|
$oPage->add('<li>'.$sFilePath.'</li>');
|
|
}
|
|
$oPage->add('</ul>');
|
|
}
|
|
if (count($aChanges['removed']) > 0)
|
|
{
|
|
$oPage->add('<ul>Deleted files:');
|
|
foreach($aChanges['removed'] as $sFilePath => $void)
|
|
{
|
|
$oPage->add('<li>'.$sFilePath.'</li>');
|
|
}
|
|
$oPage->add('</ul>');
|
|
}
|
|
if (count($aChanges['modified']) > 0)
|
|
{
|
|
$oPage->add('<ul>Modified files:');
|
|
foreach($aChanges['modified'] as $sFilePath => $void)
|
|
{
|
|
$oPage->add('<li>'.$sFilePath.'</li>');
|
|
}
|
|
$oPage->add('</ul>');
|
|
}
|
|
$oPage->add('</div></div></div>');
|
|
}
|
|
else
|
|
{
|
|
// No changes detected... or no way to tell because of the lack of a manifest or previous source dir
|
|
// Use the "compatible" datamodel as-is.
|
|
$oPage->p("<img src=\"../images/validation_ok.png\"/> The datamodel will be upgraded from version $sInstalledDataModelVersion to version $sUpgradeDMVersion.");
|
|
$oPage->add('<input type="hidden" name="upgrade_type" value="use-compatible">');
|
|
$oPage->add('<input type="hidden" name="datamodel_path" value="'.htmlentities($sCompatibleDMDir, ENT_QUOTES, 'UTF-8').'">');
|
|
$oPage->add('<input type="hidden" name="datamodel_version" value="'.htmlentities($sUpgradeDMVersion, ENT_QUOTES, 'UTF-8').'">');
|
|
}
|
|
|
|
// Check if there are "extensions" to preserve and if it's possible
|
|
if (is_dir($sPreviousVersionDir.'/extensions'))
|
|
{
|
|
$aExtensions = glob($sPreviousVersionDir.'/extensions/*', GLOB_ONLYDIR);
|
|
if (($aExtensions !== false) && (count($aExtensions)>0))
|
|
{
|
|
$aWritableDirs = array('extensions');
|
|
$aErrors = SetupUtils::CheckWritableDirs($aWritableDirs);
|
|
if (count($aErrors) > 0)
|
|
{
|
|
$oPage->p("Cannot copy the extensions from '$sPreviousVersionDir/extensions' to '".APPROOT."extensions' due to the following access rights issue(s):");
|
|
foreach($aErrors as $sDir => $oCheckResult)
|
|
{
|
|
$oPage->p('<img src="../images/error.png"/> '.$oCheckResult->sLabel);
|
|
}
|
|
}
|
|
else
|
|
{
|
|
$oPage->p("<b>Note:</b> The extensions present in '$sPreviousVersionDir/extensions' will be copied to '".APPROOT."extensions'.");
|
|
$oPage->add('<input type="hidden" name="copy_extensions_from" value="'.htmlentities($sPreviousVersionDir.'/extensions', ENT_QUOTES, 'UTF-8').'">');
|
|
}
|
|
}
|
|
}
|
|
$oPage->add_ready_script(
|
|
<<<EOF
|
|
$("#changes_summary .title").click(function() { $(this).parent().toggleClass('closed'); } );
|
|
$('input[name=upgrade_type]').bind('click change', function() { WizardUpdateButtons(); });
|
|
EOF
|
|
);
|
|
}
|
|
}
|
|
|
|
public function CanMoveForward()
|
|
{
|
|
return $this->bCanMoveForward;
|
|
}
|
|
|
|
/**
|
|
* Tells whether the "Next" button should be enabled interactively
|
|
* @return string A piece of javascript code returning either true or false
|
|
*/
|
|
public function JSCanMoveForward()
|
|
{
|
|
return
|
|
<<<EOF
|
|
if ($("#radio_upgrade_keep").length == 0) return true;
|
|
|
|
bRet = ($('input[name=upgrade_type]:checked').length > 0);
|
|
return bRet;
|
|
EOF
|
|
;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* License acceptation screen
|
|
*/
|
|
class WizStepLicense extends WizardStep
|
|
{
|
|
public function GetTitle()
|
|
{
|
|
return 'License Agreement';
|
|
}
|
|
|
|
public function GetPossibleSteps()
|
|
{
|
|
return array('WizStepDBParams');
|
|
}
|
|
|
|
public function ProcessParams($bMoveForward = true)
|
|
{
|
|
$this->oWizard->SaveParameter('accept_license', 'no');
|
|
return array('class' => 'WizStepDBParams', 'state' => '');
|
|
}
|
|
|
|
public function Display(WebPage $oPage)
|
|
{
|
|
$aLicenses = array();
|
|
foreach (glob(APPROOT.'setup/licenses/*.xml') as $sFile)
|
|
{
|
|
$oXml = simplexml_load_file($sFile);
|
|
foreach($oXml->license as $oLicense)
|
|
{
|
|
$aLicenses[] = $oLicense;
|
|
}
|
|
}
|
|
|
|
$oPage->add('<h2>Licenses agreements for the components of '.ITOP_APPLICATION.'</h2>');
|
|
$oPage->add_style('div a.no-arrow { background:transparent; padding-left:0;}');
|
|
$oPage->add_style('.toggle { cursor:pointer; text-decoration:underline; color:#1C94C4; }');
|
|
$oPage->add('<fieldset>');
|
|
$oPage->add('<legend>Components of '.ITOP_APPLICATION.'</legend>');
|
|
$oPage->add('<ul>');
|
|
foreach($aLicenses as $index => $oLicense)
|
|
{
|
|
$oPage->add('<li><b>'.$oLicense->product.'</b>, licensed by '.$oLicense->author.' under the <b>'.$oLicense->license_type.' license</b>. (<span class="toggle" id="toggle_'.$index.'">Details</span>)');
|
|
$oPage->add('<div id="license_'.$index.'" class="license_text" style="display:none;overflow:auto;max-height:10em;font-size:small;border:1px #696969 solid;margin-bottom:1em; margin-top:0.5em;padding:0.5em;">'.$oLicense->text.'</div>');
|
|
$oPage->add_ready_script('$(".license_text a").attr("target", "_blank").addClass("no-arrow");');
|
|
$oPage->add_ready_script('$("#toggle_'.$index.'").click( function() { $("#license_'.$index.'").toggle(); } );');
|
|
}
|
|
$oPage->add('</ul>');
|
|
$oPage->add('</fieldset>');
|
|
$sChecked = ($this->oWizard->GetParameter('accept_license', 'no') == 'yes') ? ' checked ' : '';
|
|
$oPage->p('<input type="checkbox" name="accept_license" id="accept" value="yes"'.$sChecked.'><label for="accept"> I accept the terms of the licenses of the '.count($aLicenses).' components mentioned above.</label>');
|
|
$oPage->add_ready_script('$("#accept").bind("click change", function() { WizardUpdateButtons(); });');
|
|
}
|
|
|
|
/**
|
|
* Tells whether the "Next" button should be enabled interactively
|
|
* @return string A piece of javascript code returning either true or false
|
|
*/
|
|
public function JSCanMoveForward()
|
|
{
|
|
return 'return ($("#accept").attr("checked") === "checked");';
|
|
}
|
|
|
|
}
|
|
|
|
/**
|
|
* License acceptation screen (when upgrading)
|
|
*/
|
|
class WizStepLicense2 extends WizStepLicense
|
|
{
|
|
public function GetPossibleSteps()
|
|
{
|
|
return array('WizStepUpgradeMiscParams');
|
|
}
|
|
|
|
public function ProcessParams($bMoveForward = true)
|
|
{
|
|
return array('class' => 'WizStepUpgradeMiscParams', 'state' => '');
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Database Connection parameters screen
|
|
*/
|
|
class WizStepDBParams extends WizardStep
|
|
{
|
|
public function GetTitle()
|
|
{
|
|
return 'Database Configuration';
|
|
}
|
|
|
|
public function GetPossibleSteps()
|
|
{
|
|
return array('WizStepAdminAccount');
|
|
}
|
|
|
|
public function ProcessParams($bMoveForward = true)
|
|
{
|
|
$this->oWizard->SaveParameter('db_server', '');
|
|
$this->oWizard->SaveParameter('db_user', '');
|
|
$this->oWizard->SaveParameter('db_pwd', '');
|
|
$this->oWizard->SaveParameter('db_name', '');
|
|
$this->oWizard->SaveParameter('db_prefix', '');
|
|
$this->oWizard->SaveParameter('new_db_name', '');
|
|
$this->oWizard->SaveParameter('create_db', '');
|
|
$this->oWizard->SaveParameter('db_new_name', '');
|
|
|
|
return array('class' => 'WizStepAdminAccount', 'state' => '');
|
|
}
|
|
|
|
public function Display(WebPage $oPage)
|
|
{
|
|
$oPage->add('<h2>Configuration of the database connection:</h2>');
|
|
$sDBServer = $this->oWizard->GetParameter('db_server', '');
|
|
$sDBUser = $this->oWizard->GetParameter('db_user', '');
|
|
$sDBPwd = $this->oWizard->GetParameter('db_pwd', '');
|
|
$sDBName = $this->oWizard->GetParameter('db_name', '');
|
|
$sDBPrefix = $this->oWizard->GetParameter('db_prefix', '');
|
|
$sNewDBName = $this->oWizard->GetParameter('db_new_name', false);
|
|
|
|
$oPage->add('<table>');
|
|
SetupUtils::DisplayDBParameters($oPage, true, $sDBServer, $sDBUser, $sDBPwd, $sDBName, $sDBPrefix, $sNewDBName);
|
|
$oPage->add('</table>');
|
|
$sCreateDB = $this->oWizard->GetParameter('create_db', 'yes');
|
|
if ($sCreateDB == 'no')
|
|
{
|
|
$oPage->add_ready_script('$("#existing_db").attr("checked", "checked");');
|
|
}
|
|
else
|
|
{
|
|
$oPage->add_ready_script('$("#create_db").attr("checked", "checked");');
|
|
}
|
|
}
|
|
|
|
public function AsyncAction(WebPage $oPage, $sCode, $aParameters)
|
|
{
|
|
switch($sCode)
|
|
{
|
|
case 'check_db':
|
|
SetupUtils:: AsyncCheckDB($oPage, $aParameters);
|
|
break;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Tells whether the "Next" button should be enabled interactively
|
|
* @return string A piece of javascript code returning either true or false
|
|
*/
|
|
public function JSCanMoveForward()
|
|
{
|
|
return
|
|
<<<EOF
|
|
if ($("#wiz_form").data("db_connection") === "error") return false;
|
|
|
|
var bRet = true;
|
|
bRet = ValidateField("db_name", true) && bRet;
|
|
bRet = ValidateField("db_new_name", true) && bRet;
|
|
bRet = ValidateField("db_prefix", true) && bRet;
|
|
|
|
return bRet;
|
|
EOF
|
|
;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Administrator Account definition screen
|
|
*/
|
|
class WizStepAdminAccount extends WizardStep
|
|
{
|
|
public function GetTitle()
|
|
{
|
|
return 'Administrator Account';
|
|
}
|
|
|
|
public function GetPossibleSteps()
|
|
{
|
|
return array('WizStepMiscParams');
|
|
}
|
|
|
|
public function ProcessParams($bMoveForward = true)
|
|
{
|
|
$this->oWizard->SaveParameter('admin_user', '');
|
|
$this->oWizard->SaveParameter('admin_pwd', '');
|
|
$this->oWizard->SaveParameter('confirm_pwd', '');
|
|
$this->oWizard->SaveParameter('admin_language', 'EN US');
|
|
return array('class' => 'WizStepMiscParams', 'state' => '');
|
|
}
|
|
|
|
public function Display(WebPage $oPage)
|
|
{
|
|
$sAdminUser = $this->oWizard->GetParameter('admin_user', 'admin');
|
|
$sAdminPwd = $this->oWizard->GetParameter('admin_pwd', '');
|
|
$sConfirmPwd = $this->oWizard->GetParameter('confirm_pwd', '');
|
|
$sAdminLanguage = $this->oWizard->GetParameter('admin_language', 'EN US');
|
|
$oPage->add('<h2>Definition of the Administrator Account</h2>');
|
|
$oPage->add('<fieldset>');
|
|
$oPage->add('<legend>Administrator Account</legend>');
|
|
$oPage->add('<table>');
|
|
$oPage->add('<tr><td>Login: </td><td><input id="admin_user" name="admin_user" type="text" size="25" maxlength="64" value="'.htmlentities($sAdminUser, ENT_QUOTES, 'UTF-8').'"><span id="v_admin_user"/></td><tr>');
|
|
$oPage->add('<tr><td>Password: </td><td><input id="admin_pwd" name="admin_pwd" type="password" size="25" maxlength="64" value="'.htmlentities($sAdminPwd, ENT_QUOTES, 'UTF-8').'"><span id="v_admin_pwd"/></td><tr>');
|
|
$oPage->add('<tr><td>Confirm password: </td><td><input id="confirm_pwd" name="confirm_pwd" type="password" size="25" maxlength="64" value="'.htmlentities($sConfirmPwd, ENT_QUOTES, 'UTF-8').'"></td><tr>');
|
|
$sSourceDir = APPROOT.'dictionaries/';
|
|
$aLanguages = SetupUtils::GetAvailableLanguages($sSourceDir);
|
|
$oPage->add('<tr><td>Language: </td><td>');
|
|
$oPage->add(SetupUtils::GetLanguageSelect($sSourceDir, 'admin_language', $sAdminLanguage));
|
|
$oPage->add('</td></tr>');
|
|
$oPage->add('</table>');
|
|
$oPage->add('</fieldset>');
|
|
$oPage->add_ready_script(
|
|
<<<EOF
|
|
$('#admin_user').bind('change keyup', function() { WizardUpdateButtons(); } );
|
|
$('#admin_pwd').bind('change keyup', function() { WizardUpdateButtons(); } );
|
|
$('#confirm_pwd').bind('change keyup', function() { WizardUpdateButtons(); } );
|
|
EOF
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Tells whether the "Next" button should be enabled interactively
|
|
* @return string A piece of javascript code returning either true or false
|
|
*/
|
|
public function JSCanMoveForward()
|
|
{
|
|
return
|
|
<<<EOF
|
|
bRet = ($('#admin_user').val() != '');
|
|
if (!bRet)
|
|
{
|
|
$("#v_admin_user").html('<img src="../images/validation_error.png" title="This field cannot be empty"/>');
|
|
}
|
|
else
|
|
{
|
|
$("#v_admin_user").html('');
|
|
}
|
|
|
|
bPasswordsMatch = ($('#admin_pwd').val() == $('#confirm_pwd').val());
|
|
if (!bPasswordsMatch)
|
|
{
|
|
$('#v_admin_pwd').html('<img src="../images/validation_error.png" title="Retyped password do not match"/>');
|
|
}
|
|
else
|
|
{
|
|
$('#v_admin_pwd').html('');
|
|
}
|
|
bRet = bPasswordsMatch && bRet;
|
|
|
|
return bRet;
|
|
EOF
|
|
;
|
|
}}
|
|
|
|
/**
|
|
* Miscellaneous Parameters (URL, Sample Data)
|
|
*/
|
|
class WizStepMiscParams extends WizardStep
|
|
{
|
|
public function GetTitle()
|
|
{
|
|
return 'Miscellaneous Parameters';
|
|
}
|
|
|
|
public function GetPossibleSteps()
|
|
{
|
|
return array('WizStepModulesChoice');
|
|
}
|
|
|
|
public function ProcessParams($bMoveForward = true)
|
|
{
|
|
$this->oWizard->SaveParameter('default_language', '');
|
|
$this->oWizard->SaveParameter('application_url', '');
|
|
$this->oWizard->SaveParameter('sample_data', 'yes');
|
|
return array('class' => 'WizStepModulesChoice', 'state' => 'start_install');
|
|
}
|
|
|
|
public function Display(WebPage $oPage)
|
|
{
|
|
$sDefaultLanguage = $this->oWizard->GetParameter('default_language', $this->oWizard->GetParameter('admin_language'));
|
|
$sApplicationURL = $this->oWizard->GetParameter('application_url', utils::GetDefaultUrlAppRoot());
|
|
$sSampleData = $this->oWizard->GetParameter('sample_data', 'yes');
|
|
$oPage->add('<h2>Additional parameters</h2>');
|
|
$oPage->add('<fieldset>');
|
|
$oPage->add('<legend>Default Language</legend>');
|
|
$oPage->add('<table>');
|
|
$sSourceDir = APPROOT.'dictionaries/';
|
|
$aLanguages = SetupUtils::GetAvailableLanguages($sSourceDir);
|
|
$oPage->add('<tr><td>Default Language: </td><td>');
|
|
$oPage->add(SetupUtils::GetLanguageSelect($sSourceDir, 'default_language', $sDefaultLanguage));
|
|
$oPage->add('</td></tr>');
|
|
$oPage->add('</table>');
|
|
$oPage->add('</fieldset>');
|
|
$oPage->add('<fieldset>');
|
|
$oPage->add('<legend>Application URL</legend>');
|
|
$oPage->add('<table>');
|
|
$oPage->add('<tr><td>URL: </td><td><input id="application_url" name="application_url" type="text" size="35" maxlength="1024" value="'.htmlentities($sApplicationURL, ENT_QUOTES, 'UTF-8').'"><span id="v_application_url"/></td><tr>');
|
|
$oPage->add('<tr><td colspan="2">Change the value above if the end-users will be accessing the application by another path due to a specific configuration of the web server.</td><tr>');
|
|
$oPage->add('</table>');
|
|
$oPage->add('</fieldset>');
|
|
$oPage->add('<fieldset>');
|
|
$oPage->add('<legend>Sample Data</legend>');
|
|
$oPage->add('<table>');
|
|
$sChecked = ($sSampleData == 'yes') ? ' checked ' : '';
|
|
$oPage->p('<input id="sample_data_yes" name="sample_data" type="radio" value="yes"'.$sChecked.'><label for="sample_data_yes"> I am installing a <b>demo or test</b> instance, populate the database with some demo data.');
|
|
$sChecked = ($sSampleData == 'no') ? ' checked ' : '';
|
|
$oPage->p('<input id="sample_data_no" name="sample_data" type="radio" value="no"'.$sChecked.'><label for="sample_data_no"> I am installing a <b>production</b> instance, create an empty database to start from.');
|
|
$oPage->add('</table>');
|
|
$oPage->add('</fieldset>');
|
|
$oPage->add_ready_script(
|
|
<<<EOF
|
|
$('#application_url').bind('change keyup', function() { WizardUpdateButtons(); } );
|
|
EOF
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Tells whether the "Next" button should be enabled interactively
|
|
* @return string A piece of javascript code returning either true or false
|
|
*/
|
|
public function JSCanMoveForward()
|
|
{
|
|
return
|
|
<<<EOF
|
|
bRet = ($('#application_url').val() != '');
|
|
if (!bRet)
|
|
{
|
|
$("#v_application_url").html('<img src="../images/validation_error.png" title="This field cannot be empty"/>');
|
|
}
|
|
else
|
|
{
|
|
$("#v_application_url").html('');
|
|
}
|
|
return bRet;
|
|
EOF
|
|
;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Miscellaneous Parameters (URL...) in case of upgrade
|
|
*/
|
|
class WizStepUpgradeMiscParams extends WizardStep
|
|
{
|
|
public function GetTitle()
|
|
{
|
|
return 'Miscellaneous Parameters';
|
|
}
|
|
|
|
public function GetPossibleSteps()
|
|
{
|
|
return array('WizStepModulesChoice');
|
|
}
|
|
|
|
public function ProcessParams($bMoveForward = true)
|
|
{
|
|
$this->oWizard->SaveParameter('application_url', '');
|
|
return array('class' => 'WizStepModulesChoice', 'state' => 'start_upgrade');
|
|
}
|
|
|
|
public function Display(WebPage $oPage)
|
|
{
|
|
$sApplicationURL = $this->oWizard->GetParameter('application_url', utils::GetDefaultUrlAppRoot());
|
|
$oPage->add('<h2>Additional parameters</h2>');
|
|
$oPage->add('<fieldset>');
|
|
$oPage->add('<legend>Application URL</legend>');
|
|
$oPage->add('<table>');
|
|
$oPage->add('<tr><td>URL: </td><td><input id="application_url" name="application_url" type="text" size="35" maxlength="1024" value="'.htmlentities($sApplicationURL, ENT_QUOTES, 'UTF-8').'"><span id="v_application_url"/></td><tr>');
|
|
$oPage->add('<tr><td colspan="2">Change the value above if the end-users will be accessing the application by another path due to a specific configuration of the web server.</td><tr>');
|
|
$oPage->add('</table>');
|
|
$oPage->add('</fieldset>');
|
|
$oPage->add_ready_script(
|
|
<<<EOF
|
|
$('#application_url').bind('change keyup', function() { WizardUpdateButtons(); } );
|
|
EOF
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Tells whether the "Next" button should be enabled interactively
|
|
* @return string A piece of javascript code returning either true or false
|
|
*/
|
|
public function JSCanMoveForward()
|
|
{
|
|
return
|
|
<<<EOF
|
|
bRet = ($('#application_url').val() != '');
|
|
if (!bRet)
|
|
{
|
|
$("#v_application_url").html('<img src="../images/validation_error.png" title="This field cannot be empty"/>');
|
|
}
|
|
else
|
|
{
|
|
$("#v_application_url").html('');
|
|
}
|
|
return bRet;
|
|
EOF
|
|
;
|
|
}
|
|
}
|
|
/**
|
|
* Choice of the modules to be installed
|
|
*/
|
|
class WizStepModulesChoice extends WizardStep
|
|
{
|
|
public function GetTitle()
|
|
{
|
|
$aStepInfo = $this->GetStepInfo();
|
|
$sTitle = isset($aStepInfo['title']) ? $aStepInfo['title'] : 'Modules selection';
|
|
return $sTitle;
|
|
}
|
|
|
|
public function GetPossibleSteps()
|
|
{
|
|
return array('WizStepModulesChoice', 'WizStepSummary');
|
|
}
|
|
|
|
public function ProcessParams($bMoveForward = true)
|
|
{
|
|
// Accumulates the selected modules:
|
|
$index = $this->GetStepIndex();
|
|
|
|
// use json_encode:decode to store a hash array: step_id => array(input_name => selected_input_id)
|
|
$aSelectedChoices = json_decode($this->oWizard->GetParameter('selected_components', '{}'), true);
|
|
$aSelected = utils::ReadParam('choice', array());
|
|
$aSelectedChoices[$index] = $aSelected;
|
|
$this->oWizard->SetParameter('selected_components', json_encode($aSelectedChoices));
|
|
|
|
if ($this->GetStepInfo($index) == null)
|
|
{
|
|
throw new Exception('Internal error: invalid step "'.$index.'" for the choice of modules.');
|
|
}
|
|
else if ($bMoveForward)
|
|
{
|
|
if ($this->GetStepInfo(1 + $index) != null)
|
|
{
|
|
return array('class' => 'WizStepModulesChoice', 'state' => (1+$index));
|
|
}
|
|
else
|
|
{
|
|
// Exiting this step of the wizard, let's convert the selection into a list of modules
|
|
$aModules = array();
|
|
$sDisplayChoices = '<ul>';
|
|
for($i = 0; $i <= $index; $i++)
|
|
{
|
|
$aStepInfo = $this->GetStepInfo($i);
|
|
$sDisplayChoices .= $this->GetSelectedModules($aStepInfo, $aSelectedChoices[$i], $aModules);
|
|
}
|
|
$sDisplayChoices .= '</ul>';
|
|
if (class_exists('CreateITILProfilesInstaller'))
|
|
{
|
|
$this->oWizard->SetParameter('old_addon', true);
|
|
}
|
|
$this->oWizard->SetParameter('selected_modules', json_encode(array_keys($aModules)));
|
|
$this->oWizard->SetParameter('display_choices', $sDisplayChoices);
|
|
return array('class' => 'WizStepSummary', 'state' => '');
|
|
}
|
|
|
|
}
|
|
}
|
|
|
|
public function Display(WebPage $oPage)
|
|
{
|
|
$this->DisplayStep($oPage);
|
|
}
|
|
|
|
protected function DisplayStep($oPage)
|
|
{
|
|
$aStepInfo = $this->GetStepInfo();
|
|
$oPage->add_style("div.choice { margin: 0.5em;}");
|
|
$oPage->add_style("div.choice a { text-decoration:none; font-weight: bold; color: #1C94C4 }");
|
|
$oPage->add_style("div.description { margin-left: 2em; }");
|
|
$oPage->add_style(".choice-disabled { color: #999; }");
|
|
$oPage->add('<table><tr>');
|
|
$sBannerPath = isset($aStepInfo['banner']) ? $aStepInfo['banner'] : '';
|
|
if (!empty($sBannerPath))
|
|
{
|
|
if (substr($sBannerPath, 0, 1) == '/')
|
|
{
|
|
// absolute path, means relative to APPROOT
|
|
$sBannerUrl = utils::GetDefaultUrlAppRoot().$sBannerPath;
|
|
}
|
|
else
|
|
{
|
|
// relative path: i.e. relative to the directory containing the XML file
|
|
$sFullPath = dirname($this->GetSourceFilePath()).'/'.$sBannerPath;
|
|
$sRealPath = realpath($sFullPath);
|
|
$sBannerUrl = utils::GetDefaultUrlAppRoot().str_replace(realpath(APPROOT), '', $sRealPath);
|
|
}
|
|
$oPage->add('<td><img src="'.$sBannerUrl.'"/><td>');
|
|
}
|
|
$sDescription = isset($aStepInfo['description']) ? $aStepInfo['description'] : '';
|
|
$oPage->add('<td>'.$sDescription.'<td>');
|
|
$oPage->add('</tr></table>');
|
|
|
|
// Build the default choices
|
|
$aDefaults = array();
|
|
$aModules = SetupUtils::AnalyzeInstallation($this->oWizard);
|
|
$this->GetDefaults($aStepInfo, $aDefaults, $aModules);
|
|
$index = $this->GetStepIndex();
|
|
|
|
// retrieve the saved selection
|
|
// use json_encode:decode to store a hash array: step_id => array(input_name => selected_input_id)
|
|
$aParameters = json_decode($this->oWizard->GetParameter('selected_components', '{}'), true);
|
|
if (!isset($aParameters[$index]))
|
|
{
|
|
$aParameters[$index] = $aDefaults;
|
|
}
|
|
$aSelectedComponents = $aParameters[$index];
|
|
|
|
$oPage->add('<div style="height:250px;overflow:auto;border:#ccc 1px solid;">');
|
|
$this->DisplayOptions($oPage, $aStepInfo, $aSelectedComponents);
|
|
$oPage->add('</div>');
|
|
|
|
$oPage->add_script(
|
|
<<<EOF
|
|
function CheckChoice(sChoiceId)
|
|
{
|
|
console.log('Ici !!');
|
|
var oElement = $('#'+sChoiceId);
|
|
var bChecked = (oElement.attr('checked') == 'checked');
|
|
var sId = sChoiceId.replace('choice', '');
|
|
if ((oElement.attr('type') == 'radio') && bChecked)
|
|
{
|
|
// Only the radio that is clicked is notified, let's warn the other radio buttons
|
|
sName = oElement.attr('name');
|
|
$('input[name="'+sName+'"]').each(function() {
|
|
var sRadioId = $(this).attr('id');
|
|
if (sRadioId != sChoiceId)
|
|
{
|
|
CheckChoice(sRadioId);
|
|
}
|
|
});
|
|
}
|
|
|
|
$('#sub_choices'+sId).each(function() {
|
|
if (!bChecked)
|
|
{
|
|
$(this).addClass('choice-disabled');
|
|
}
|
|
else
|
|
{
|
|
$(this).removeClass('choice-disabled');
|
|
}
|
|
|
|
$('input', this).each(function() {
|
|
if (bChecked)
|
|
{
|
|
if ($(this).attr('data-disabled') != 'disabled')
|
|
{
|
|
// Only non-mandatory fields can be enabled
|
|
$(this).removeAttr('disabled');
|
|
}
|
|
}
|
|
else
|
|
{
|
|
$(this).attr('disabled', 'disabled');
|
|
}
|
|
});
|
|
});
|
|
}
|
|
EOF
|
|
);
|
|
$oPage->add_ready_script(
|
|
<<<EOF
|
|
$('.wiz-choice').bind('change', function() { CheckChoice($(this).attr('id')); } );
|
|
$('.wiz-choice').trigger('change');
|
|
EOF
|
|
);
|
|
}
|
|
|
|
protected function GetDefaults($aInfo, &$aDefaults, $aModules, $sParentId = '')
|
|
{
|
|
$aOptions = isset($aInfo['options']) ? $aInfo['options'] : array();
|
|
foreach($aOptions as $index => $aChoice)
|
|
{
|
|
$sChoiceId = $sParentId.'_'.$index;
|
|
if (isset($aChoice['default']) && $aChoice['default'])
|
|
{
|
|
$aDefaults[$sChoiceId] = $sChoiceId;
|
|
}
|
|
foreach($aChoice['modules'] as $sModuleId)
|
|
{
|
|
if ($aModules[$sModuleId]['version_db'] != '')
|
|
{
|
|
// A module corresponding to this choice is installed, the whole choice is selected
|
|
$aDefaults[$sChoiceId] = $sChoiceId;
|
|
break;
|
|
}
|
|
}
|
|
if (isset($aChoice['sub_options']))
|
|
{
|
|
$this->GetDefaults($aChoice['sub_options'], $aDefaults, $sChoiceId);
|
|
}
|
|
$index++;
|
|
}
|
|
|
|
$aAlternatives = isset($aInfo['alternatives']) ? $aInfo['alternatives'] : array();
|
|
$sChoiceName = null;
|
|
foreach($aAlternatives as $index => $aChoice)
|
|
{
|
|
$sChoiceId = $sParentId.'_'.$index;
|
|
if ($sChoiceName == null)
|
|
{
|
|
$sChoiceName = $sChoiceId;
|
|
}
|
|
if (isset($aChoice['default']) && $aChoice['default'])
|
|
{
|
|
$aDefaults[$sChoiceName] = $sChoiceId;
|
|
}
|
|
if (isset($aChoice['sub_options']))
|
|
{
|
|
$this->GetDefaults($aChoice['sub_options'], $aDefaults, $aModules, $sChoiceId);
|
|
}
|
|
$index++;
|
|
}
|
|
|
|
// the installed choices have precedence over the 'default' choices
|
|
$sChoiceName = null;
|
|
foreach($aAlternatives as $index => $aChoice)
|
|
{
|
|
$sChoiceId = $sParentId.'_'.$index;
|
|
if ($sChoiceName == null)
|
|
{
|
|
$sChoiceName = $sChoiceId;
|
|
}
|
|
foreach($aChoice['modules'] as $sModuleId)
|
|
{
|
|
if ($aModules[$sModuleId]['version_db'] != '')
|
|
{
|
|
// A module corresponding to this choice is installed, the whole choice is selected
|
|
$aDefaults[$sChoiceName] = $sChoiceId;
|
|
break;
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Converts the list of selected "choices" into a list of "modules": take into account the selected and the mandatory modules
|
|
* @param hash $aInfo Info about the "choice" array('options' => array(...), 'alternatives' => array(...))
|
|
* @param hash $aSelectedChoices List of selected choices array('name' => 'selected_value_id')
|
|
* @param hash $aModules Return parameter: List of selected modules array('module_id' => true)
|
|
* @param string $sParentId Used for recursion
|
|
* @return void
|
|
*/
|
|
protected function GetSelectedModules($aInfo, $aSelectedChoices, &$aModules, $sParentId = '', $sDisplayChoices = '')
|
|
{
|
|
if ($sParentId == '')
|
|
{
|
|
// Check once (before recursing) that the hidden modules are selected
|
|
foreach(SetupUtils::AnalyzeInstallation($this->oWizard) as $sModuleId => $aModule)
|
|
{
|
|
if ($sModuleId != ROOT_MODULE)
|
|
{
|
|
if (($aModule['category'] == 'authentication') || (!$aModule['visible']))
|
|
{
|
|
$aModules[$sModuleId] = true;
|
|
}
|
|
}
|
|
}
|
|
|
|
}
|
|
$aOptions = isset($aInfo['options']) ? $aInfo['options'] : array();
|
|
foreach($aOptions as $index => $aChoice)
|
|
{
|
|
$sChoiceId = $sParentId.'_'.$index;
|
|
if ( (isset($aChoice['mandatory']) && $aChoice['mandatory']) ||
|
|
(isset($aSelectedChoices[$sChoiceId]) && ($aSelectedChoices[$sChoiceId] == $sChoiceId)) )
|
|
{
|
|
$sDisplayChoices .= '<li>'.$aChoice['title'].'</li>';
|
|
if (isset($aChoice['modules']))
|
|
{
|
|
foreach($aChoice['modules'] as $sModuleId)
|
|
{
|
|
$aModules[$sModuleId] = true; // store the Id of the selected module
|
|
}
|
|
}
|
|
// Recurse only for selected choices
|
|
if (isset($aChoice['sub_options']))
|
|
{
|
|
$sDisplayChoices .= '<ul>';
|
|
$sDisplayChoices = $this->GetSelectedModules($aChoice['sub_options'], $aSelectedChoices, $aModules, $sChoiceId, $sDisplayChoices);
|
|
$sDisplayChoices .= '</ul>';
|
|
}
|
|
$sDisplayChoices .= '</li>';
|
|
}
|
|
$index++;
|
|
}
|
|
|
|
$aAlternatives = isset($aInfo['alternatives']) ? $aInfo['alternatives'] : array();
|
|
$sChoiceName = null;
|
|
foreach($aAlternatives as $index => $aChoice)
|
|
{
|
|
$sChoiceId = $sParentId.'_'.$index;
|
|
if ($sChoiceName == null)
|
|
{
|
|
$sChoiceName = $sChoiceId;
|
|
}
|
|
if ( (isset($aChoice['mandatory']) && $aChoice['mandatory']) ||
|
|
(isset($aSelectedChoices[$sChoiceName]) && ($aSelectedChoices[$sChoiceName] == $sChoiceId)) )
|
|
{
|
|
$sDisplayChoices .= '<li>'.$aChoice['title'].'</li>';
|
|
if (isset($aChoice['modules']))
|
|
{
|
|
foreach($aChoice['modules'] as $sModuleId)
|
|
{
|
|
$aModules[$sModuleId] = true; // store the Id of the selected module
|
|
}
|
|
}
|
|
// Recurse only for selected choices
|
|
if (isset($aChoice['sub_options']))
|
|
{
|
|
$sDisplayChoices .= '<ul>';
|
|
$sDisplayChoices = $this->GetSelectedModules($aChoice['sub_options'], $aSelectedChoices, $aModules, $sChoiceId, $sDisplayChoices);
|
|
$sDisplayChoices .= '</ul>';
|
|
}
|
|
$sDisplayChoices .= '</li>';
|
|
}
|
|
$index++;
|
|
}
|
|
return $sDisplayChoices;
|
|
}
|
|
|
|
protected function GetStepIndex()
|
|
{
|
|
switch($this->sCurrentState)
|
|
{
|
|
case 'start_install':
|
|
case 'start_upgrade':
|
|
$index = 0;
|
|
break;
|
|
|
|
default:
|
|
$index = (integer)$this->sCurrentState;
|
|
}
|
|
return $index;
|
|
}
|
|
protected function GetStepInfo($idx = null)
|
|
{
|
|
$aStepInfo = null;
|
|
if ($idx === null)
|
|
{
|
|
$index = $this->GetStepIndex();
|
|
}
|
|
else
|
|
{
|
|
$index = $idx;
|
|
}
|
|
|
|
$aSteps = array();
|
|
if (@file_exists($this->GetSourceFilePath()))
|
|
{
|
|
$aParams = new XMLParameters($this->GetSourceFilePath());
|
|
$aSteps = $aParams->Get('steps', array());
|
|
$bAddExtensionsOnly = true;
|
|
}
|
|
else
|
|
{
|
|
// No wizard configuration provided, build a standard one:
|
|
$bAddExtensionsOnly = false;
|
|
$aSteps[] = array(
|
|
'title' => 'Modules Selection',
|
|
'description' => '<h2>Select the modules to install. You can launch the installation again to install new modules, but you cannot remove already installed modules.</h2>',
|
|
'banner' => '/images/modules.png',
|
|
'options' => array()
|
|
);
|
|
}
|
|
|
|
// Additional step for the extensions
|
|
$aSteps[] = array(
|
|
'title' => 'Extensions',
|
|
'description' => '<h2>Select additional extensions to install. You can launch the installation again to install new extensions, but you cannot remove already installed extensions.</h2>',
|
|
'banner' => '/images/extension.png',
|
|
'options' => array()
|
|
);
|
|
|
|
try
|
|
{
|
|
$sDefaultAppPath = utils::GetDefaultUrlAppRoot();
|
|
}
|
|
catch(Exception $e)
|
|
{
|
|
$sDefaultAppPath = '..';
|
|
}
|
|
|
|
$aAvailableModules = SetupUtils::AnalyzeInstallation($this->oWizard);
|
|
foreach($aAvailableModules as $sModuleId => $aModule)
|
|
{
|
|
if ($sModuleId == ROOT_MODULE) continue; // Convention: the version number of the application (and datamodel) are stored as a module named ROOT_MODULE
|
|
|
|
$sModuleLabel = $aModule['label'];
|
|
$sModuleHelp = $aModule['doc.more_information'];
|
|
$sMoreInfo = (!empty($aModule['doc.more_information'])) ? "<a href=\"$sDefaultAppPath{$aModule['doc.more_information']}\" target=\"_blank\">more info</a>": '';
|
|
if (($aModule['category'] != 'authentication') && ($aModule['visible']))
|
|
{
|
|
if (($bAddExtensionsOnly) && (!$this->IsExtension($aModule))) continue;
|
|
|
|
if ($this->IsExtension($aModule))
|
|
{
|
|
$iStepIndex = count($aSteps) - 1;
|
|
}
|
|
else
|
|
{
|
|
$iStepIndex = 0;
|
|
}
|
|
$aSteps[$iStepIndex]['options'][] = array(
|
|
'title' => $sModuleLabel,
|
|
'description' => '',
|
|
'more_info' => $sMoreInfo,
|
|
'default' => true, // by default offer to install all modules
|
|
'modules' => array($sModuleId),
|
|
'mandatory' => ($aModule['install']['flag'] & MODULE_ACTION_MANDATORY) ? true : false,
|
|
);
|
|
}
|
|
}
|
|
|
|
if (count($aSteps[count($aSteps) - 1]['options']) == 0)
|
|
{
|
|
// No extensions at all, remove the last step
|
|
array_pop($aSteps);
|
|
}
|
|
|
|
if (array_key_exists($index, $aSteps))
|
|
{
|
|
$aStepInfo = $aSteps[$index];
|
|
}
|
|
|
|
return $aStepInfo;
|
|
}
|
|
|
|
protected function GetExtensionsStepInfo()
|
|
{
|
|
// let the user select from the list of modules located in the "extensions" folder
|
|
}
|
|
|
|
protected function IsExtension($aModule)
|
|
{
|
|
// root_dir is the directory containing the module, check if its parent is "extensions"
|
|
if (basename(dirname($aModule['root_dir'])) == 'extensions')
|
|
{
|
|
return true;
|
|
}
|
|
return false;
|
|
}
|
|
|
|
protected function DisplayOptions($oPage, $aStepInfo, $aSelectedComponents, $sParentId = '')
|
|
{
|
|
$aOptions = isset($aStepInfo['options']) ? $aStepInfo['options'] : array();
|
|
$aAlternatives = isset($aStepInfo['alternatives']) ? $aStepInfo['alternatives'] : array();
|
|
$index = 0;
|
|
|
|
foreach($aOptions as $index => $aChoice)
|
|
{
|
|
$sAttributes = '';
|
|
$sChoiceId = $sParentId.'_'.$index;
|
|
if (isset($aChoice['mandatory']) && $aChoice['mandatory'])
|
|
{
|
|
$oPage->add('<div class="choice"><input id="choice'.$sChoiceId.'" checked disabled data-disabled="disabled" type="checkbox"'.$sAttributes.'/><input type="hidden" name="choice['.$sChoiceId.']" value="'.$sChoiceId.'"> ');
|
|
}
|
|
else if (isset($aSelectedComponents[$sChoiceId]) && ($aSelectedComponents[$sChoiceId] == $sChoiceId))
|
|
{
|
|
$oPage->add('<div class="choice"><input class="wiz-choice" id="choice'.$sChoiceId.'" name="choice['.$sChoiceId.']" type="checkbox" checked value="'.$sChoiceId.'"/> ');
|
|
}
|
|
else
|
|
{
|
|
$oPage->add('<div class="choice"><input class="wiz-choice" id="choice'.$sChoiceId.'" name="choice['.$sChoiceId.']" type="checkbox" value="'.$sChoiceId.'"/> ');
|
|
}
|
|
$this->DisplayChoice($oPage, $aChoice, $aSelectedComponents, $sChoiceId);
|
|
$oPage->add('</div>');
|
|
$index++;
|
|
}
|
|
$sChoiceName = null;
|
|
foreach($aAlternatives as $index => $aChoice)
|
|
{
|
|
$sAttributes = '';
|
|
$sChoiceId = $sParentId.'_'.$index;
|
|
if ($sChoiceName == null)
|
|
{
|
|
$sChoiceName = $sChoiceId; // All radios share the same name
|
|
}
|
|
|
|
if (isset($aSelectedComponents[$sChoiceName]) && ($aSelectedComponents[$sChoiceName] == $sChoiceId))
|
|
{
|
|
$sAttributes = ' checked ';
|
|
}
|
|
$oPage->add('<div class="choice"><input class="wiz-choice" id="choice'.$sChoiceId.'" name="choice['.$sChoiceName.']" type="radio"'.$sAttributes.' value="'.$sChoiceId.'"/> ');
|
|
$this->DisplayChoice($oPage, $aChoice, $aSelectedComponents, $sChoiceId);
|
|
$oPage->add('</div>');
|
|
$index++;
|
|
}
|
|
}
|
|
|
|
protected function DisplayChoice($oPage, $aChoice, $aSelectedComponents, $sChoiceId)
|
|
{
|
|
$sMoreInfo = isset($aChoice['more_info']) ? $aChoice['more_info'] : '';
|
|
$oPage->add('<label for="choice'.$sChoiceId.'"><b>'.htmlentities($aChoice['title'], ENT_QUOTES, 'UTF-8').'</b></label> '.$sMoreInfo);
|
|
$sDescription = isset($aChoice['description']) ? htmlentities($aChoice['description'], ENT_QUOTES, 'UTF-8') : '';
|
|
$oPage->add('<div class="description">'.$sDescription.'<span id="sub_choices'.$sChoiceId.'">');
|
|
if (isset($aChoice['sub_options']))
|
|
{
|
|
$this->DisplayOptions($oPage, $aChoice['sub_options'], $aSelectedComponents, $sChoiceId);
|
|
}
|
|
$oPage->add('</span></div>');
|
|
}
|
|
|
|
protected function GetSourceFilePath()
|
|
{
|
|
$sSourceDir = $this->oWizard->GetParameter('source_dir');
|
|
return $sSourceDir.'/installation.xml';
|
|
}
|
|
|
|
}
|
|
|
|
/**
|
|
* Summary of the installation tasks
|
|
*/
|
|
class WizStepSummary extends WizardStep
|
|
{
|
|
public function GetTitle()
|
|
{
|
|
$sMode = $this->oWizard->GetParameter('mode', 'install');
|
|
if ($sMode == 'install')
|
|
{
|
|
return 'Ready to install';
|
|
|
|
}
|
|
else
|
|
{
|
|
return 'Ready to upgrade';
|
|
}
|
|
}
|
|
|
|
public function GetPossibleSteps()
|
|
{
|
|
return array('WizStepDone');
|
|
}
|
|
|
|
/**
|
|
* Returns the label for the " Next >> " button
|
|
* @return string The label for the button
|
|
*/
|
|
public function GetNextButtonLabel()
|
|
{
|
|
return ' Install ! ';
|
|
}
|
|
|
|
public function ProcessParams($bMoveForward = true)
|
|
{
|
|
return array('class' => 'WizStepDone', 'state' => '');
|
|
}
|
|
|
|
public function Display(WebPage $oPage)
|
|
{
|
|
$oPage->add_style(
|
|
<<<EOF
|
|
#params_summary {
|
|
height: 200px;
|
|
overflow: auto;
|
|
}
|
|
#params_summary div {
|
|
width:100%;
|
|
margin-top:0;
|
|
padding-top: 0.5em;
|
|
padding-left: 0;
|
|
}
|
|
#params_summary div ul {
|
|
margin-left:0;
|
|
padding-left: 20px;
|
|
}
|
|
#params_summary div.closed ul {
|
|
display:none;
|
|
}
|
|
#params_summary div li {
|
|
list-style: none;
|
|
width: 100%;
|
|
margin-left:0;
|
|
padding-left: 0em;
|
|
}
|
|
.title {
|
|
padding-left: 20px;
|
|
font-weight: bold;
|
|
cursor: pointer;
|
|
background: url(../images/minus.gif) 2px 2px no-repeat;
|
|
}
|
|
#params_summary div.closed .title {
|
|
background: url(../images/plus.gif) 2px 2px no-repeat;
|
|
}
|
|
#progress_content {
|
|
height: 200px;
|
|
overflow: auto;
|
|
text-align: center;
|
|
}
|
|
#installation_progress {
|
|
display: none;
|
|
}
|
|
EOF
|
|
);
|
|
|
|
$aInstallParams = $this->BuildConfig();
|
|
|
|
$sMode = $aInstallParams['mode'];
|
|
|
|
$sPreinstallationPhase = '';
|
|
|
|
$sDestination = ITOP_APPLICATION.(($sMode == 'install') ? ' version '.ITOP_VERSION.' is about to be installed ' : ' is about to be upgraded ');
|
|
$sDBDescription = ' <b>existing</b> database <b>'.$aInstallParams['database']['name'].'</b>';
|
|
if (($sMode == 'install') && ($this->oWizard->GetParameter('create_db') == 'yes'))
|
|
{
|
|
$sDBDescription = ' <b>new</b> database <b>'.$aInstallParams['database']['name'].'</b>';
|
|
}
|
|
$sDestination .= 'into the '.$sDBDescription.' on the server <b>'.$aInstallParams['database']['server'].'</b>.';
|
|
$oPage->add('<h2>'.$sDestination.'</h2>');
|
|
|
|
$oPage->add('<fieldset id="summary"><legend>Installation Parameters</legend>');
|
|
$oPage->add('<div id="params_summary">');
|
|
$oPage->add('<div class="closed"><span class="title">Database Parameters</span><ul>');
|
|
$oPage->add('<li>Server Name: '.$aInstallParams['database']['server'].'</li>');
|
|
$oPage->add('<li>DB User Name: '.$aInstallParams['database']['user'].'</li>');
|
|
$oPage->add('<li>DB user password: '.$aInstallParams['database']['pwd'].'</li>');
|
|
if (($sMode == 'install') && ($this->oWizard->GetParameter('create_db') == 'yes'))
|
|
{
|
|
$oPage->add('<li>Database Name: '.$aInstallParams['database']['name'].' (will be created)</li>');
|
|
}
|
|
else
|
|
{
|
|
$oPage->add('<li>Database Name: '.$aInstallParams['database']['name'].'</li>');
|
|
}
|
|
if ($aInstallParams['database']['prefix'] != '')
|
|
{
|
|
$oPage->add('<li>Prefix for the '.ITOP_APPLICATION.' tables: '.$aInstallParams['database']['prefix'].'</li>');
|
|
}
|
|
else
|
|
{
|
|
$oPage->add('<li>Prefix for the '.ITOP_APPLICATION.' tables: none</li>');
|
|
}
|
|
$oPage->add('</ul></div>');
|
|
|
|
$oPage->add('<div><span class="title">Data Model Configuration</span>');
|
|
$oPage->add($this->oWizard->GetParameter('display_choices'));
|
|
$oPage->add('</div>');
|
|
|
|
$oPage->add('<div class="closed"><span class="title">Other Parameters</span><ul>');
|
|
if ($sMode == 'install')
|
|
{
|
|
$oPage->add('<li>Default language: '.$aInstallParams['language'].'</li>');
|
|
}
|
|
|
|
$oPage->add('<li>URL to access the application: '.$aInstallParams['url'].'</li>');
|
|
if ($aInstallParams['sample_data'] == 'yes')
|
|
{
|
|
$oPage->add('<li>Sample data will be loaded into the database.</li>');
|
|
}
|
|
if ($aInstallParams['old_addon'])
|
|
{
|
|
$oPage->add('<li>Compatibility mode: Using the version 1.2 of the UserRightsProfiles add-on.</li>');
|
|
}
|
|
$oPage->add('</ul></div>');
|
|
|
|
if ($sMode == 'install')
|
|
{
|
|
$oPage->add('<div class="closed"><span class="title">Admininistrator Account</span><ul>');
|
|
$oPage->add('<li>Login: '.$aInstallParams['admin_account']['user'].'</li>');
|
|
$oPage->add('<li>Password: '.$aInstallParams['admin_account']['pwd'].'</li>');
|
|
$oPage->add('<li>Language: '.$aInstallParams['admin_account']['language'].'</li>');
|
|
$oPage->add('</ul></div>');
|
|
}
|
|
|
|
$aMiscOptions = $aInstallParams['options'];
|
|
if (count($aMiscOptions) > 0)
|
|
{
|
|
$oPage->add('<div class="closed"><span class="title">Miscellaneous Options</span><ul>');
|
|
foreach($aMiscOptions as $sKey => $sValue)
|
|
{
|
|
$oPage->add('<li>'.$sKey.': '.$sValue.'</li>');
|
|
}
|
|
$oPage->add('</ul></div>');
|
|
|
|
}
|
|
|
|
$aSelectedModules = $aInstallParams['selected_modules'];
|
|
|
|
if (isset($aMiscOptions['generate_config']))
|
|
{
|
|
$oDoc = new DOMDocument('1.0', 'UTF-8');
|
|
$oDoc->preserveWhiteSpace = false;
|
|
$oDoc->formatOutput = true;
|
|
$oParams = new PHPParameters();
|
|
$oParams->LoadFromHash($aInstallParams);
|
|
$oParams->ToXML($oDoc, null, 'installation');
|
|
$sXML = $oDoc->saveXML();
|
|
|
|
$oPage->add('<div class="closed"><span class="title">XML Config file</span><ul><pre>');
|
|
$oPage->add(htmlentities($sXML, ENT_QUOTES, 'UTF-8'));
|
|
$oPage->add('</pre></ul></div>');
|
|
}
|
|
|
|
$oPage->add('</div>'); // params_summary
|
|
$oPage->add('</fieldset>');
|
|
|
|
$oPage->add('<fieldset id="installation_progress"><legend>Progress of the installation</legend>');
|
|
$oPage->add('<div id="progress_content">');
|
|
$oPage->add_linked_script('../setup/jquery.progression.js');
|
|
$oPage->add('<p class="center"><span id="setup_msg">Ready to start...</span></p><div style="display:block;margin-left: auto; margin-right:auto;" id="progress">0%</div>');
|
|
$oPage->add('</div>'); // progress_content
|
|
$oPage->add('</fieldset>');
|
|
|
|
$sJSONData = json_encode($aInstallParams);
|
|
$oPage->add('<input type="hidden" id="installer_parameters" value="'.htmlentities($sJSONData, ENT_QUOTES, 'UTF-8').'"/>');
|
|
|
|
$oPage->add_ready_script(
|
|
<<<EOF
|
|
$("#params_summary div").addClass('closed');
|
|
$("#params_summary .title").click(function() { $(this).parent().toggleClass('closed'); } );
|
|
$("#btn_next").bind("click.install", function(event) {
|
|
$('#summary').hide();
|
|
$('#installation_progress').show();
|
|
$(this).attr("disabled", "disabled"); event.preventDefault(); ExecuteStep("");
|
|
});
|
|
$("#wiz_form").data("installation_status", "not started")
|
|
EOF
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Prepare the parameters to execute the installation asynchronously
|
|
* @return Hash A big hash array that can be converted to XML or JSON with all the needed parameters
|
|
*/
|
|
protected function BuildConfig()
|
|
{
|
|
$sMode = $this->oWizard->GetParameter('install_mode', 'install');
|
|
$aSelectedModules = json_decode($this->oWizard->GetParameter('selected_modules'), true);
|
|
$sBackupDestination = '';
|
|
$sPreviousConfigurationFile = '';
|
|
$sDBName = $this->oWizard->GetParameter('db_name');
|
|
if ($sMode == 'upgrade')
|
|
{
|
|
$sPreviousVersionDir = $this->oWizard->GetParameter('previous_version_dir', '');
|
|
if (!empty($sPreviousVersionDir))
|
|
{
|
|
$aPreviousInstance = SetupUtils::GetPreviousInstance($sPreviousVersionDir);
|
|
if ($aPreviousInstance['found'])
|
|
{
|
|
$sPreviousConfigurationFile = $aPreviousInstance['configuration_file'];
|
|
}
|
|
}
|
|
|
|
if ($this->oWizard->GetParameter('db_backup', false))
|
|
{
|
|
$sBackupDestination = $this->oWizard->GetParameter('db_backup_path', '');
|
|
}
|
|
}
|
|
else
|
|
{
|
|
|
|
$sDBNewName = $this->oWizard->GetParameter('db_new_name', '');
|
|
if ($sDBNewName != '')
|
|
{
|
|
$sDBName = $sDBNewName; // Database will be created
|
|
}
|
|
}
|
|
|
|
$sSourceDir = $this->oWizard->GetParameter('source_dir');
|
|
$aCopies = array();
|
|
if (($sMode == 'upgrade') && ($this->oWizard->GetParameter('upgrade_type') == 'keep-previous'))
|
|
{
|
|
$sPreviousVersionDir = $this->oWizard->GetParameter('previous_version_dir');
|
|
$aCopies[] = array('source' => $sSourceDir, 'destination' => 'modules'); // Source is an absolute path, destination is relative to APPROOT
|
|
$aCopies[] = array('source' => $sPreviousVersionDir.'/portal', 'destination' => 'portal'); // Source is an absolute path, destination is relative to APPROOT
|
|
$sSourceDir = APPROOT.'modules';
|
|
}
|
|
|
|
if (($sMode == 'upgrade'))
|
|
{
|
|
// Copy the previous extensions, if any
|
|
$sPreviousExtensionsDir = $this->oWizard->GetParameter('copy_extensions_from');
|
|
if (is_dir($sPreviousExtensionsDir))
|
|
{
|
|
// Copy the extensions one by one to merge them with the existing extensions in /extensions
|
|
$aExtensions = glob($sPreviousExtensionsDir.'/*', GLOB_ONLYDIR);
|
|
foreach($aExtensions as $sDirPath)
|
|
{
|
|
$sExtName = basename($sDirPath);
|
|
$aCopies[] = array('source' => $sDirPath, 'destination' => 'extensions/'.$sExtName); // Source is an absolute path, destination is relative to APPROOT
|
|
}
|
|
}
|
|
}
|
|
|
|
$aInstallParams = array (
|
|
'mode' => $sMode,
|
|
'preinstall' => array (
|
|
'copies' => $aCopies,
|
|
// 'backup' => see below
|
|
),
|
|
'source_dir' => str_replace(APPROOT, '', $sSourceDir),
|
|
'datamodel_version' => $this->oWizard->GetParameter('datamodel_version'), //TODO: let the installer compute this automatically...
|
|
'previous_configuration_file' => $sPreviousConfigurationFile,
|
|
'extensions_dir' => 'extensions',
|
|
'target_env' => 'production',
|
|
'workspace_dir' => '',
|
|
'database' => array (
|
|
'server' => $this->oWizard->GetParameter('db_server'),
|
|
'user' => $this->oWizard->GetParameter('db_user'),
|
|
'pwd' => $this->oWizard->GetParameter('db_pwd'),
|
|
'name' => $sDBName,
|
|
'prefix' => $this->oWizard->GetParameter('db_prefix'),
|
|
),
|
|
'url' => $this->oWizard->GetParameter('application_url'),
|
|
'admin_account' => array (
|
|
'user' => $this->oWizard->GetParameter('admin_user'),
|
|
'pwd' => $this->oWizard->GetParameter('admin_pwd'),
|
|
'language' => $this->oWizard->GetParameter('admin_language'),
|
|
),
|
|
'language' => $this->oWizard->GetParameter('default_language'),
|
|
'selected_modules' => $aSelectedModules,
|
|
'sample_data' => ($this->oWizard->GetParameter('sample_data', '') == 'yes') ? true : false ,
|
|
'old_addon' => $this->oWizard->GetParameter('old_addon', false), // whether or not to use the "old" userrights profile addon
|
|
'options' => json_decode($this->oWizard->GetParameter('misc_options', '[]'), true),
|
|
);
|
|
|
|
if ($sBackupDestination != '')
|
|
{
|
|
$aInstallParams['preinstall']['backup'] = array (
|
|
'destination' => $sBackupDestination,
|
|
'configuration_file' => $sPreviousConfigurationFile,
|
|
);
|
|
}
|
|
return $aInstallParams;
|
|
}
|
|
|
|
public function AsyncAction(WebPage $oPage, $sCode, $aParameters)
|
|
{
|
|
$oParameters = new PHPParameters();
|
|
$sStep = $aParameters['installer_step'];
|
|
$sJSONParameters = $aParameters['installer_config'];
|
|
$oParameters->LoadFromHash(json_decode($sJSONParameters, true /* bAssoc */));
|
|
$oInstaller = new ApplicationInstaller($oParameters);
|
|
$aRes = $oInstaller->ExecuteStep($sStep);
|
|
if (($aRes['status'] != ApplicationInstaller::ERROR) && ($aRes['next-step'] != ''))
|
|
{
|
|
// Tell the web page to move the progress bar and to launch the next step
|
|
$sMessage = addslashes(htmlentities($aRes['next-step-label'], ENT_QUOTES, 'UTF-8'));
|
|
$oPage->add_ready_script(
|
|
<<<EOF
|
|
$("#wiz_form").data("installation_status", "running");
|
|
WizardUpdateButtons();
|
|
$('#setup_msg').html('$sMessage');
|
|
$('#progress').progression( {Current:{$aRes['percentage-completed']}, Maximum: 100, aBackgroundImg: GetAbsoluteUrlAppRoot()+'setup/orange-progress.gif', aTextColor: '#000000'} );
|
|
|
|
//$("#percentage").html('{$aRes['percentage-completed']} % completed<br/>{$aRes['next-step-label']}');
|
|
ExecuteStep('{$aRes['next-step']}');
|
|
EOF
|
|
);
|
|
}
|
|
else if ($aRes['status'] != ApplicationInstaller::ERROR)
|
|
{
|
|
// Installation complete, move to the next step of the wizard
|
|
$oPage->add_ready_script(
|
|
<<<EOF
|
|
$("#wiz_form").data("installation_status", "completed");
|
|
$('#progress').progression( {Current:100, Maximum: 100, aBackgroundImg: GetAbsoluteUrlAppRoot()+'setup/orange-progress.gif', aTextColor: '#000000'} );
|
|
WizardUpdateButtons();
|
|
$("#btn_next").unbind("click.install");
|
|
$("#btn_next").click();
|
|
EOF
|
|
);
|
|
}
|
|
else
|
|
{
|
|
$sMessage = addslashes(htmlentities($aRes['message'], ENT_QUOTES, 'UTF-8'));
|
|
$oPage->add_ready_script(
|
|
<<<EOF
|
|
$("#wiz_form").data("installation_status", "error");
|
|
WizardUpdateButtons();
|
|
$('#setup_msg').html('$sMessage');
|
|
EOF
|
|
);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Tells whether the "Next" button should be enabled interactively
|
|
* @return string A piece of javascript code returning either true or false
|
|
*/
|
|
public function JSCanMoveForward()
|
|
{
|
|
return 'return (($("#wiz_form").data("installation_status") === "not started") || ($("#wiz_form").data("installation_status") === "completed"));';
|
|
}
|
|
|
|
/**
|
|
* Tells whether the "Next" button should be enabled interactively
|
|
* @return string A piece of javascript code returning either true or false
|
|
*/
|
|
public function JSCanMoveBackward()
|
|
{
|
|
return 'var sStatus = $("#wiz_form").data("installation_status"); return ((sStatus === "not started") || (sStatus === "error"));';
|
|
}
|
|
|
|
}
|
|
|
|
/**
|
|
* Summary of the installation tasks
|
|
*/
|
|
class WizStepDone extends WizardStep
|
|
{
|
|
public function GetTitle()
|
|
{
|
|
return 'Done';
|
|
}
|
|
|
|
public function GetPossibleSteps()
|
|
{
|
|
return array();
|
|
}
|
|
|
|
public function ProcessParams($bMoveForward = true)
|
|
{
|
|
return array('class' => '', 'state' => '');
|
|
}
|
|
|
|
public function Display(WebPage $oPage)
|
|
{
|
|
// Check if there are some manual steps required:
|
|
$aManualSteps = array();
|
|
$aAvailableModules = SetupUtils::AnalyzeInstallation($this->oWizard);
|
|
|
|
$sRootUrl = utils::GetAbsoluteUrlAppRoot();
|
|
$aSelectedModules = json_decode($this->oWizard->GetParameter('selected_modules'), true);
|
|
foreach($aSelectedModules as $sModuleId)
|
|
{
|
|
if (!empty($aAvailableModules[$sModuleId]['doc.manual_setup']))
|
|
{
|
|
$aManualSteps[$aAvailableModules[$sModuleId]['label']] = $sRootUrl.$aAvailableModules[$sModuleId]['doc.manual_setup'];
|
|
}
|
|
}
|
|
if (count($aManualSteps) > 0)
|
|
{
|
|
$oPage->add("<h2>Manual operations required</h2>");
|
|
$oPage->p("In order to complete the installation, the following manual operations are required:");
|
|
foreach($aManualSteps as $sModuleLabel => $sUrl)
|
|
{
|
|
$oPage->p("<a href=\"$sUrl\" target=\"_blank\">Manual instructions for $sModuleLabel</a>");
|
|
}
|
|
$oPage->add("<h2>Congratulations for installing ".ITOP_APPLICATION."</h2>");
|
|
}
|
|
else
|
|
{
|
|
$oPage->add("<h2>Congratulations for installing ".ITOP_APPLICATION."</h2>");
|
|
$oPage->ok("The installation completed successfully.");
|
|
}
|
|
|
|
if (($this->oWizard->GetParameter('mode', '') == 'upgrade') && $this->oWizard->GetParameter('db_backup', false))
|
|
{
|
|
$sBackupDestination = $this->oWizard->GetParameter('db_backup_path', '');
|
|
if (file_exists($sBackupDestination))
|
|
{
|
|
// To mitigate security risks: pass only the filename without the extension, the download will add the extension itself
|
|
$sTruncatedFilePath = preg_replace('/\.zip$/', '', $sBackupDestination);
|
|
$oPage->p('Your backup is ready');
|
|
$oPage->p('<a style="background:transparent;" href="'.utils::GetAbsoluteUrlAppRoot().'setup/ajax.dataloader.php?operation=async_action&step_class=WizStepDone¶ms[backup]='.urlencode($sTruncatedFilePath).'" target="_blank"><img src="../images/tar.png" style="border:0;vertical-align:middle;"> Download '.basename($sBackupDestination).'</a>');
|
|
}
|
|
else
|
|
{
|
|
$oPage->p('<img src="../images/error.png"/> Warning: Backup creation failed !');
|
|
}
|
|
}
|
|
|
|
// Form goes here.. No back button since the job is done !
|
|
$oPage->add('<table style="width:600px;border:0;padding:0;"><tr>');
|
|
$oPage->add("<td><a style=\"background:transparent;padding:0;\" title=\"Free: Register your iTop version.\" href=\"http://www.combodo.com/register?product=iTop&version=".urlencode(ITOP_VERSION." revision ".ITOP_REVISION)."\" target=\"_blank\"><img style=\"border:0\" src=\"../images/setup-register.gif\"/></td></a>");
|
|
$oPage->add("<td><a style=\"background:transparent;padding:0;\" title=\"Get Professional Support from Combodo\" href=\"http://www.combodo.com/itopsupport\" target=\"_blank\"><img style=\"border:0\" src=\"../images/setup-support.gif\"/></td></a>");
|
|
$oPage->add("<td><a style=\"background:transparent;padding:0;\" title=\"Get Professional Training from Combodo\" href=\"http://www.combodo.com/itoptraining\" target=\"_blank\"><img style=\"border:0\" src=\"../images/setup-training.gif\"/></td></a>");
|
|
$oPage->add('</tr></table>');
|
|
$sForm = '<form method="post" action="'.$this->oWizard->GetParameter('application_url').'pages/UI.php">';
|
|
$sForm .= '<input type="hidden" name="auth_user" value="'.htmlentities($this->oWizard->GetParameter('admin_user'), ENT_QUOTES, 'UTF-8').'">';
|
|
$sForm .= '<input type="hidden" name="auth_pwd" value="'.htmlentities($this->oWizard->GetParameter('admin_pwd'), ENT_QUOTES, 'UTF-8').'">';
|
|
$sForm .= "<p style=\"text-align:center;width:100%\"><button id=\"enter_itop\" type=\"submit\">Enter ".ITOP_APPLICATION."</button></p>";
|
|
$sForm .= '</form>';
|
|
$oPage->add('<img style="border:0" src="http://www.combodo.com/stats/?p='.urlencode(ITOP_APPLICATION).'&v='.urlencode(ITOP_VERSION).'"/>');
|
|
$sForm = addslashes($sForm);
|
|
$oPage->add_ready_script("$('#wiz_form').after('$sForm');");
|
|
}
|
|
|
|
public function CanMoveForward()
|
|
{
|
|
return false;
|
|
}
|
|
public function CanMoveBackward()
|
|
{
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* Tells whether this step of the wizard requires that the configuration file be writable
|
|
* @return bool True if the wizard will possibly need to modify the configuration at some point
|
|
*/
|
|
public function RequiresWritableConfig()
|
|
{
|
|
return false; //This step executes once the config was written and secured
|
|
}
|
|
|
|
public function AsyncAction(WebPage $oPage, $sCode, $aParameters)
|
|
{
|
|
$oParameters = new PHPParameters();
|
|
// For security reasons: add the extension now so that this action can be used to read *only* .zip files from the disk...
|
|
$sBackupFile = $aParameters['backup'].'.zip';
|
|
if (file_exists($sBackupFile))
|
|
{
|
|
// Make sure there is NO output at all before our content, otherwise the document will be corrupted
|
|
$sPreviousContent = ob_get_clean();
|
|
$oPage->SetContentType('application/zip');
|
|
$oPage->SetContentDisposition('attachment', basename($sBackupFile));
|
|
$oPage->add(file_get_contents($sBackupFile));
|
|
}
|
|
}
|
|
}
|