$sDirectory
\n"; - if ($hDir = opendir($sDirectory)) - { - // This is the correct way to loop over the directory. (according to the documentation) - while (($sFile = readdir($hDir)) !== false) - { - $aMatches = array(); - if (is_dir($sDirectory.'/'.$sFile)) - { - if (($sFile != '.') && ($sFile != '..') && ($sFile != '.svn')) - { - ListModuleFiles($sRelDir.'/'.$sFile, $oP); - } - } - else if (preg_match('/^module\.(.*).php$/i', $sFile, $aMatches)) - { - $oP->SetModulePath($sRelDir); - try - { - //echo "Loading: $sDirectory/$sFile...
\n"; - require_once($sDirectory.'/'.$sFile); - //echo "Done.
\n"; - } - catch(Exception $e) - { - // Continue... - } - } - } - closedir($hDir); - } - else - { - $oP->error("Data directory (".$sDirectory.") not found or not readable."); - } -} - - -/** - * Scans the ./data directory for XML files and output them as a Javascript array - */ -function PopulateDataFilesList(SetupWebPage $oP, $aParamValues) -{ - - $oP->add("\n"); -} - -/** - * Add some parameters as hidden inputs into a form - * @param SetupWebpage $oP The page to insert the form elements into - * @param Hash $aParamValues The pairs name/value to be stored in the form - * @param Array $aExcludeParams A list of parameters to exclude from the previous hash - */ -function AddParamsToForm(SetupWebpage $oP, $aParamValues, $aExcludeParams = array()) -{ - foreach($aParamValues as $sName => $value) - { - if(!in_array($sName, $aExcludeParams)) - { - if (is_array($value)) - { - foreach($value as $sKey => $sItem) - { - $oP->add(''); - } - } - else - { - $oP->add(''); - } - } - } -} - -/** - * Search (on the disk) for all defined iTop modules, load them and returns the list (as an array) - * of the possible iTop modules to install - * @param none - * @return Hash A big array moduleID => ModuleData - */ -function GetAvailableModules(SetupWebpage $oP) -{ - clearstatcache(); - ListModuleFiles('modules', $oP); - return $oP->GetModules(); -} - -/** - * Build the config file from the parameters (especially the selected modules) - */ -function BuildConfig(SetupWebpage $oP, Config &$oConfig, $aParamValues, $aAvailableModules) -{ - // Initialize the arrays below with default values for the application... - $aAddOns = $oConfig->GetAddOns(); - $aAppModules = $oConfig->GetAppModules(); - $aDataModels = $oConfig->GetDataModels(); - $aWebServiceCategories = $oConfig->GetWebServiceCategories(); - $aDictionaries = $oConfig->GetDictionaries(); - // Merge the values with the ones provided by the modules - // Make sure when don't load the same file twice... - foreach($aParamValues['module'] as $sModuleId) - { - $oP->log('Installed iTop module: '. $sModuleId); - if (isset($aAvailableModules[$sModuleId]['datamodel'])) - { - $aDataModels = array_unique(array_merge($aDataModels, $aAvailableModules[$sModuleId]['datamodel'])); - } - if (isset($aAvailableModules[$sModuleId]['webservice'])) - { - $aWebServiceCategories = array_unique(array_merge($aWebServiceCategories, $aAvailableModules[$sModuleId]['webservice'])); - } - if (isset($aAvailableModules[$sModuleId]['dictionary'])) - { - $aDictionaries = array_unique(array_merge($aDictionaries, $aAvailableModules[$sModuleId]['dictionary'])); - } - if (isset($aAvailableModules[$sModuleId]['settings'])) - { - foreach($aAvailableModules[$sModuleId]['settings'] as $sProperty => $value) - { - list($sName, $sVersion) = GetModuleName($sModuleId); - $oConfig->SetModuleSetting($sName, $sProperty, $value); - } - } - if (isset($aAvailableModules[$sModuleId]['installer'])) - { - $sModuleInstallerClass = $aAvailableModules[$sModuleId]['installer']; - if (!class_exists($sModuleInstallerClass)) - { - throw new Exception("Wrong installer class: '$sModuleInstallerClass' is not a PHP class - Module: ".$aAvailableModules[$sModuleId]['label']); - } - if (!is_subclass_of($sModuleInstallerClass, 'ModuleInstallerAPI')) - { - throw new Exception("Wrong installer class: '$sModuleInstallerClass' is not derived from 'ModuleInstallerAPI' - Module: ".$aAvailableModules[$sModuleId]['label']); - } - $aCallSpec = array($sModuleInstallerClass, 'BeforeWritingConfig'); - $oConfig = call_user_func_array($aCallSpec, array($oConfig)); - } - } - $oConfig->SetAddOns($aAddOns); - $oConfig->SetAppModules($aAppModules); - $oConfig->SetDataModels($aDataModels); - $oConfig->SetWebServiceCategories($aWebServiceCategories); - $oConfig->SetDictionaries($aDictionaries); -} - -///////////////////////////////////////////////////////////////////////////////////////////////////////////// -// Handling of the different steps of the setup wizard -///////////////////////////////////////////////////////////////////////////////////////////////////////////// - -/** - * Displays the welcome screen and check some basic prerequisites - */ -function WelcomeAndCheckPrerequisites(SetupWebPage $oP, $aParamValues, $iCurrentStep) -{ - $sNextOperation = 'step'.($iCurrentStep+1); - $oP->add("iTop configuration wizard
\n"); - $sVersionStringShort = GetITopVersion(true); - $sVersionStringLong = GetITopVersion(false); - $oP->set_title('Welcome to '.$sVersionStringShort); - $oP->log($sVersionStringLong); - $oP->add("Checking prerequisites
\n"); - if (CheckPHPVersion($oP)) - { - $oP->add("Next: Licence agreement
\n"); - $oP->add("\n"); - } -} - -function LicenceAcknowledgement($oP, $aParamValues, $iCurrentStep) -{ - $sNextOperation = 'step'.($iCurrentStep+1); - - $oP->set_title('License agreement'); - $oP->add('iTop is released by Combodo SARL under the terms of the GPL V3 license. In order to use iTop you must accept the terms of this license.
'); - $oP->add("\n"); - $oP->add("\n"); -} - -/** - * Display the form for the first step of the configuration wizard - * which consists in the database server selection - */ -function DatabaseServerSelection(SetupWebPage $oP, $aParamValues, $iCurrentStep) -{ - $sNextOperation = 'step'.($iCurrentStep+1); - - $oP->add("\n"); -} - -/** - * Display the form for the second step of the configuration wizard - * which consists in - * 1) Validating the parameters by connecting to the database server - * 2) Prompting to select an existing database or to create a new one - */ -function DatabaseInstanceSelection(SetupWebPage $oP, $aParamValues, $iCurrentStep, $oConfig) -{ - $sNextOperation = 'step'.($iCurrentStep+1); - $oP->set_title("Database instance selection\n"); - $oP->add("\n"); -} - -/** - * Display the form to select the iTop modules to be installed - */ -function ModulesSelection(SetupWebPage $oP, $aParamValues, $iCurrentStep, $oConfig) -{ - $sNextOperation = 'step'.($iCurrentStep+1); - $sPrevOperation = 'step'.($iCurrentStep-1); - - $sDBName = $aParamValues['db_name']; - if ($sDBName == '') - { - $sDBName = $aParamValues['new_db_name']; - } - $sDBPrefix = $aParamValues['db_prefix']; - $oConfig->SetDBName($sDBName); - $oConfig->SetDBSubname($sDBPrefix); - $oConfig->WriteToFile(TMP_CONFIG_FILE); - - $oP->add("\n"); - $oP->add_ready_script("$('.read-only').click( function() { $(this).attr('checked','checked'); } );"); - -} -/** - * Display the form for the third step of the configuration wizard - * which consists in - * 1) Validating the parameters by connecting to the database server & selecting the database - * 2) Creating the database structure - * 3) Prompting for the admin account to be created - */ -function AdminAccountDefinition(SetupWebPage $oP, $aParamValues, $iCurrentStep, Config $oConfig) -{ - $sNextOperation = 'step'.($iCurrentStep+1); - $oP->set_title("Administrator account creation"); - $oP->add("Creation of the database structure
"); - $oP->add("\n"); -} - -/** - * Display the form for the fourth step of the configuration wizard - * which consists in - * 1) Creating the admin user account - * 2) Prompting to load some sample data - */ -function SampleDataSelection(SetupWebPage $oP, $aParamValues, $iCurrentStep, Config $oConfig) -{ - $sNextOperation = 'step'.($iCurrentStep+1); - - $oP->set_title("Application initialization"); - $sAdminUser = $aParamValues['auth_user']; - $sAdminPwd = $aParamValues['auth_pwd']; - $sLanguage = $aParamValues['language']; - $oConfig->SetDefaultLanguage($aParamValues['language']); - $oConfig->WriteToFile(TMP_CONFIG_FILE); - - $oP->add("\n"); - // Hidden form submitted when moving on to the next page, once all the data files - // have been processed - $oP->add("\n"); - $oP->add("\n"); - $oP->add_linked_script('./jquery.progression.js'); - - PopulateDataFilesList($oP, $aParamValues); -} -/** - * Display the form for the fifth (and final) step of the configuration wizard - * which consists in - * 1) Creating the final configuration file - * 2) Prompting the user to make the file read-only - */ -function SetupFinished(SetupWebPage $oP, $aParamValues, $iCurrentStep, Config $oConfig) -{ - $sAuthUser = $aParamValues['auth_user']; - $sAuthPwd = $aParamValues['auth_pwd']; - try - { - $sSessionName = sprintf('iTop-%x', rand()); - $oConfig->Set('session_name', $sSessionName); - session_name($sSessionName); - session_start(); - - // Write the final configuration file - $oConfig->WriteToFile(FINAL_CONFIG_FILE); - - // Start the application - InitDataModel($oP, FINAL_CONFIG_FILE, false); // Load model and startup DB - if (UserRights::CheckCredentials($sAuthUser, $sAuthPwd)) - { - UserRights::Login($sAuthUser); - $_SESSION['auth_user'] = $sAuthUser; - $_SESSION['login_mode'] = 'form'; // Will enable the "log-off button" - - // remove the tmp config file - @unlink(TMP_CONFIG_FILE); - // try to make the final config file read-only - @chmod(FINAL_CONFIG_FILE, 0440); // Read-only for owner and group, nothing for others - - $oP->set_title("Setup complete"); - $oP->add("\n"); - } - else - { - $oP->add("iTop configuration wizard
\n"); - $oP->add("Step 5: Configuration completed
\n"); - - @unlink(FINAL_CONFIG_FILE); // remove the aborted config - $oP->error("Error: Failed to login for user: '$sAuthUser'\n"); - - $oP->add("\n"); - } - } - catch(Exception $e) - { - $oP->error("Error: unable to create the configuration file."); - $oP->p($e->getHtmlDesc()); - $oP->p("Did you forget to remove the previous (read-only) configuration file ?"); - $oP->add("\n"); - } -} - -/////////////////////////////////////////////////////////////////////////////////////////////////// -// Main program -/////////////////////////////////////////////////////////////////////////////////////////////////// - -clearstatcache(); // Make sure we know what we are doing ! -if (file_exists(FINAL_CONFIG_FILE)) -{ - // The configuration file already exists - if (is_writable(FINAL_CONFIG_FILE)) - { - $oP->warning("Warning: a configuration file '".FINAL_CONFIG_FILE."' already exists, and will be overwritten."); - } - else - { - $oP->add("iTop configuration wizard
\n"); - $oP->add("Fatal error
\n"); - $oP->error("Error: the configuration file '".FINAL_CONFIG_FILE."' already exists and cannot be overwritten."); - $oP->p("The wizard cannot create the configuration file for you. Please remove the file '".realpath(FINAL_CONFIG_FILE)."' or change its access-rights/read-only flag before continuing."); - $oP->output(); - exit; - } -} -else -{ - // No configuration file yet - // Check that the wizard can write into the root dir to create the configuration file - if (!is_writable(dirname(TMP_CONFIG_FILE))) - { - $oP->add("iTop configuration wizard
\n"); - $oP->add("Fatal error
\n"); - $oP->error("Error: the directory where to store the configuration file is not writable."); - $oP->p("The wizard cannot create the configuration file for you. Please make sure that the directory '".realpath(dirname(TMP_CONFIG_FILE))."' is writable for the web server."); - $oP->output(); - exit; - } - if (!is_writable(dirname(TMP_CONFIG_FILE).'/setup')) - { - $oP->add("iTop configuration wizard
\n"); - $oP->add("Fatal error
\n"); - $oP->error("Error: the directory where to store temporary setup files is not writable."); - $oP->p("The wizard cannot create operate. Please make sure that the directory '".realpath(dirname(TMP_CONFIG_FILE))."/setup' is writable for the web server."); - $oP->output(); - exit; - } - -} -try -{ - $oConfig = new Config(TMP_CONFIG_FILE); -} -catch(Exception $e) -{ - // We'll end here when the tmp config file does not exist. It's normal - $oConfig = new Config(TMP_CONFIG_FILE, false /* Don't try to load it */); -} -try -{ - // Set a long (at least 4 minutes) execution time for the setup to avoid timeouts during this phase - ini_set('max_execution_time', max(240, ini_get('max_execution_time'))); - // While running the setup it is desirable to see any error that may happen - ini_set('display_errors', true); - ini_set('display_startup_errors', true); - - $aParams = array('licence_ok', 'db_server', 'db_user', 'db_pwd','db_name', 'new_db_name', 'db_prefix', 'module', 'sample_data', 'auth_user', 'auth_pwd', 'language'); - foreach($aParams as $sName) - { - $aParamValues[$sName] = utils::ReadParam($sName, ''); - } - - switch($sOperation) - { - case 'step0': - $oP->no_cache(); - $oP->log("Info - ========= Wizard step 0 ========"); - WelcomeAndCheckPrerequisites($oP, $aParamValues, 0); - break; - - case 'step1': - $oP->no_cache(); - $oP->log("Info - ========= Wizard step 1 ========"); - LicenceAcknowledgement($oP, $aParamValues, 1); - break; - - case 'step2': - $oP->log("Info - ========= Wizard step 2 ========"); - DatabaseServerSelection($oP, $aParamValues, 2); - break; - - case 'step3': - $oP->no_cache(); - $oP->log("Info - ========= Wizard step 3 ========"); - DatabaseInstanceSelection($oP, $aParamValues, 3, $oConfig); - break; - - case 'step4': - $oP->no_cache(); - $oP->log("Info - ========= Wizard step 4 ========"); - ModulesSelection($oP, $aParamValues, 4, $oConfig); - break; - - - case 'step5': - $oP->no_cache(); - $oP->log("Info - ========= Wizard step 5 ========"); - AdminAccountDefinition($oP, $aParamValues, 5, $oConfig); - break; - - case 'step6': - $oP->no_cache(); - $oP->log("Info - ========= Wizard step 6 ========"); - SampleDataSelection($oP, $aParamValues, 6, $oConfig); - break; - - case 'step7': - $oP->no_cache(); - $oP->log("Info - ========= Wizard step 7 ========"); - SetupFinished($oP, $aParamValues, 7, $oConfig); - break; - - default: - $oP->error("Error: unsupported operation '$sOperation'"); - - } -} -catch(Exception $e) -{ - $oP->error("Error: '".$e->getMessage()."'"); - $oP->add("\n"); -} -catch(CoreException $e) -{ - $oP->error("Error: '".$e->getHtmlDesc()."'"); - $oP->add("\n"); -} -$oP->output(); -?> + + * @author Romain Quetiez
Checking prerequisites: Warning (show details)';
+ $oP->add_ready_script("$('#prereq_details').hide();\n");
+ }
+ else
+ {
+ $sTitle = '
Checking prerequisites: Ok (show details)';
+ $oP->add_ready_script("$('#prereq_details').hide();\n");
+ }
+ }
+ $oP->add("$sTitle
\n"); + $oP->add("\n");
+ foreach($aErrors as $sError)
+ {
+ $oP->error($sError);
+ //$oP->add_ready_script("$('#prereq_details').show();");
+ }
+ foreach($aWarnings as $sWarning)
+ {
+ $oP->warning($sWarning);
+ }
+ foreach($aOk as $sOk)
+ {
+ $oP->ok($sOk);
+ }
+ $oP->add("
\n");
+ return $bResult;
+}
+
+/**
+ * Helper function check the connection to the database and (if connected) to enumerate
+ * the existing databases
+ * @return Array The list of databases found in the server
+ */
+function CheckServerConnection(SetupWebPage $oP, $sDBServer, $sDBUser, $sDBPwd)
+{
+ $aResult = array();
+ $oP->log('Info - CheckServerConnection');
+ try
+ {
+ $oDBSource = new CMDBSource;
+ $oDBSource->Init($sDBServer, $sDBUser, $sDBPwd);
+ $oP->ok("Connection to '$sDBServer' as '$sDBUser' successful.");
+
+ $oP->log("Info - User privileges: ".($oDBSource->GetRawPrivileges()));
+
+ $sDBVersion = $oDBSource->GetDBVersion();
+ if (version_compare($sDBVersion, MYSQL_MIN_VERSION, '>='))
+ {
+ $oP->ok("Current MySQL version ($sDBVersion), greater than minimum required version (".MYSQL_MIN_VERSION.")");
+ // Check some server variables
+ $iMaxAllowedPacket = $oDBSource->GetServerVariable('max_allowed_packet');
+ $iMaxUploadSize = utils::ConvertToBytes(ini_get('upload_max_filesize'));
+ if ($iMaxAllowedPacket >= (500 + $iMaxUploadSize)) // Allow some space for the query + the file to upload
+ {
+ $oP->ok("MySQL server's max_allowed_packet is big enough.");
+ }
+ else if($iMaxAllowedPacket < $iMaxUploadSize)
+ {
+ $oP->warning("MySQL server's max_allowed_packet ($iMaxAllowedPacket) is not big enough. Please, consider setting it to at least ".(500 + $iMaxUploadSize).".");
+ }
+ $oP->log("Info - MySQL max_allowed_packet: $iMaxAllowedPacket");
+ $iMaxConnections = $oDBSource->GetServerVariable('max_connections');
+ if ($iMaxConnections < 5)
+ {
+ $oP->warning("MySQL server's max_connections ($iMaxConnections) is not enough. Please, consider setting it to at least 5.");
+ }
+ $oP->log("Info - MySQL max_connections: ".($oDBSource->GetServerVariable('max_connections')));
+ }
+ else
+ {
+ $oP->error("Error: Current MySQL version is ($sDBVersion), minimum required version (".MYSQL_MIN_VERSION.")");
+ return false;
+ }
+ try
+ {
+ $aResult = $oDBSource->ListDB();
+ }
+ catch(Exception $e)
+ {
+ $oP->warning("Warning: unable to enumerate the current databases.");
+ $aResult = true; // Not an array to differentiate with an empty array
+ }
+ }
+ catch(Exception $e)
+ {
+ $oP->error("Error: Connection to '$sDBServer' as '$sDBUser' failed.");
+ $oP->p($e->GetHtmlDesc());
+ $aResult = false;
+ }
+ return $aResult;
+}
+
+/**
+ * Scans the ./data directory for XML files and output them as a Javascript array
+ */
+function PopulateDataFilesList(SetupWebPage $oP, $aParamValues, $oConfig)
+{
+
+ $oP->add("\n");
+}
+
+/**
+ * Add some parameters as hidden inputs into a form
+ * @param SetupWebpage $oP The page to insert the form elements into
+ * @param Hash $aParamValues The pairs name/value to be stored in the form
+ * @param Array $aExcludeParams A list of parameters to exclude from the previous hash
+ */
+function AddParamsToForm(SetupWebpage $oP, $aParamValues, $aExcludeParams = array())
+{
+ foreach($aParamValues as $sName => $value)
+ {
+ if(!in_array($sName, $aExcludeParams))
+ {
+ AddHiddenParam($oP, $sName, $value);
+ }
+ }
+}
+
+/**
+ * Add a hidden field to store the specified parameter
+ * @param $sName string Name of the parameter
+ * @param $value mixed Value of the parameter
+ */
+function AddHiddenParam($oP, $sName, $value)
+{
+ if (is_array($value))
+ {
+ foreach($value as $sKey => $sItem)
+ {
+ $oP->add('');
+ }
+ }
+ else
+ {
+ $oP->add('');
+ }
+}
+
+/**
+ * Build the config file from the parameters (especially the selected modules)
+ */
+function BuildConfig(SetupWebpage $oP, Config &$oConfig, $aParamValues, $aAvailableModules)
+{
+ // Initialize the arrays below with default values for the application...
+ $aAddOns = $oConfig->GetAddOns();
+ $aAppModules = $oConfig->GetAppModules();
+ $aDataModels = $oConfig->GetDataModels();
+ $aWebServiceCategories = $oConfig->GetWebServiceCategories();
+ $aDictionaries = $oConfig->GetDictionaries();
+ // Merge the values with the ones provided by the modules
+ // Make sure when don't load the same file twice...
+ foreach($aParamValues['module'] as $sModuleId)
+ {
+ $oP->log('Installed iTop module: '. $sModuleId);
+ if (isset($aAvailableModules[$sModuleId]['datamodel']))
+ {
+ $aDataModels = array_unique(array_merge($aDataModels, $aAvailableModules[$sModuleId]['datamodel']));
+ }
+ if (isset($aAvailableModules[$sModuleId]['webservice']))
+ {
+ $aWebServiceCategories = array_unique(array_merge($aWebServiceCategories, $aAvailableModules[$sModuleId]['webservice']));
+ }
+ if (isset($aAvailableModules[$sModuleId]['dictionary']))
+ {
+ $aDictionaries = array_unique(array_merge($aDictionaries, $aAvailableModules[$sModuleId]['dictionary']));
+ }
+ if (isset($aAvailableModules[$sModuleId]['settings']))
+ {
+ foreach($aAvailableModules[$sModuleId]['settings'] as $sProperty => $value)
+ {
+ list($sName, $sVersion) = GetModuleName($sModuleId);
+ $oConfig->SetModuleSetting($sName, $sProperty, $value);
+ }
+ }
+ if (isset($aAvailableModules[$sModuleId]['installer']))
+ {
+ $sModuleInstallerClass = $aAvailableModules[$sModuleId]['installer'];
+ if (!class_exists($sModuleInstallerClass))
+ {
+ throw new Exception("Wrong installer class: '$sModuleInstallerClass' is not a PHP class - Module: ".$aAvailableModules[$sModuleId]['label']);
+ }
+ if (!is_subclass_of($sModuleInstallerClass, 'ModuleInstallerAPI'))
+ {
+ throw new Exception("Wrong installer class: '$sModuleInstallerClass' is not derived from 'ModuleInstallerAPI' - Module: ".$aAvailableModules[$sModuleId]['label']);
+ }
+ $aCallSpec = array($sModuleInstallerClass, 'BeforeWritingConfig');
+ $oConfig = call_user_func_array($aCallSpec, array($oConfig));
+ }
+ }
+ $oConfig->SetAddOns($aAddOns);
+ $oConfig->SetAppModules($aAppModules);
+ $oConfig->SetDataModels($aDataModels);
+ $oConfig->SetWebServiceCategories($aWebServiceCategories);
+ $oConfig->SetDictionaries($aDictionaries);
+}
+
+/////////////////////////////////////////////////////////////////////////////////////////////////////////////
+// Handling of the different steps of the setup wizard
+/////////////////////////////////////////////////////////////////////////////////////////////////////////////
+
+/**
+ * Displays the welcome screen and check some basic prerequisites
+ */
+function WelcomeAndCheckPrerequisites(SetupWebPage $oP, $aParamValues, $iCurrentStep)
+{
+ $sNextOperation = 'step'.($iCurrentStep+1);
+ $aParamValues['previous_step'] = 0;
+
+ $oP->add("