index.php 45 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161
  1. <?php
  2. // Copyright (C) 2010 Combodo SARL
  3. //
  4. // This program is free software; you can redistribute it and/or modify
  5. // it under the terms of the GNU General Public License as published by
  6. // the Free Software Foundation; version 3 of the License.
  7. //
  8. // This program is distributed in the hope that it will be useful,
  9. // but WITHOUT ANY WARRANTY; without even the implied warranty of
  10. // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  11. // GNU General Public License for more details.
  12. //
  13. // You should have received a copy of the GNU General Public License
  14. // along with this program; if not, write to the Free Software
  15. // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
  16. /**
  17. * Wizard to configure and initialize the iTop application
  18. *
  19. * @author Erwan Taloc <erwan.taloc@combodo.com>
  20. * @author Romain Quetiez <romain.quetiez@combodo.com>
  21. * @author Denis Flaven <denis.flaven@combodo.com>
  22. * @license http://www.opensource.org/licenses/gpl-3.0.html LGPL
  23. */
  24. require_once('../application/utils.inc.php');
  25. require_once('../core/config.class.inc.php');
  26. require_once('../core/log.class.inc.php');
  27. require_once('../core/cmdbsource.class.inc.php');
  28. require_once('./setuppage.class.inc.php');
  29. define('TMP_CONFIG_FILE', '../tmp-config-itop.php');
  30. define('FINAL_CONFIG_FILE', '../config-itop.php');
  31. define('SETUP_STRUCTURE_DATA_DIR', './data/structure');
  32. define('SETUP_SAMPLE_DATA_DIR', './data');
  33. define('PHP_MIN_VERSION', '5.2.0');
  34. define('MYSQL_MIN_VERSION', '5.0.0');
  35. define('MIN_MEMORY_LIMIT', 32*1024*1024);
  36. $sOperation = Utils::ReadParam('operation', 'step0');
  37. $oP = new SetupWebPage('iTop configuration wizard');
  38. ///////////////////////////////////////////////////////////////////////////////////////////////////
  39. // Various helper function
  40. ///////////////////////////////////////////////////////////////////////////////////////////////////
  41. /**
  42. * Get a nicely formatted version string
  43. */
  44. function GetITopVersion($bShort = true)
  45. {
  46. $sVersionString = '';
  47. if ($bShort)
  48. {
  49. $sVersionString = "iTop Version ".ITOP_VERSION;
  50. }
  51. else
  52. {
  53. if (ITOP_REVISION == '$WCREV$')
  54. {
  55. // This is NOT a version built using the buil system, just display the main version
  56. $sVersionString = "iTop Version ".ITOP_VERSION;
  57. }
  58. else
  59. {
  60. // This is a build made from SVN, let display the full information
  61. $sVersionString = "iTop Version ".ITOP_VERSION." revision ".ITOP_REVISION.", built on: ".ITOP_BUILD_DATE;
  62. }
  63. }
  64. return $sVersionString;
  65. }
  66. /**
  67. * Helper function to retrieve the system's temporary directory
  68. * Emulates sys_get_temp_dir if neeed (PHP < 5.2.1)
  69. * @return string Path to the system's temp directory
  70. */
  71. function GetTmpDir()
  72. {
  73. // try to figure out what is the temporary directory
  74. // prior to PHP 5.2.1 the function sys_get_temp_dir
  75. // did not exist
  76. if ( !function_exists('sys_get_temp_dir'))
  77. {
  78. if( $temp=getenv('TMP') ) return realpath($temp);
  79. if( $temp=getenv('TEMP') ) return realpath($temp);
  80. if( $temp=getenv('TMPDIR') ) return realpath($temp);
  81. $temp=tempnam(__FILE__,'');
  82. if (file_exists($temp))
  83. {
  84. unlink($temp);
  85. return realpath(dirname($temp));
  86. }
  87. return null;
  88. }
  89. else
  90. {
  91. return realpath(sys_get_temp_dir());
  92. }
  93. }
  94. /**
  95. * Check the value of the PHP setting 'memory_limit'
  96. * against the minimum recommended value
  97. * @param SetpWebPage $oP The current web page
  98. * @param integer $iMinMemoryRequired The minimum memory for the test to pass
  99. * @return boolean Whether or not it's Ok to continue
  100. */
  101. function CheckMemoryLimit(SetupWebPage $oP, $iMinMemoryRequired)
  102. {
  103. $sMemoryLimit = trim(ini_get('memory_limit'));
  104. $bResult = true;
  105. if (empty($sMemoryLimit))
  106. {
  107. // On some PHP installations, memory_limit does not exist as a PHP setting!
  108. // (encountered on a 5.2.0 under Windows)
  109. // In that case, ini_set will not work, let's keep track of this and proceed anyway
  110. $oP->warning("No memory limit has been defined in this instance of PHP");
  111. }
  112. else
  113. {
  114. // Check that the limit will allow us to load the data
  115. //
  116. $iMemoryLimit = utils::ConvertToBytes($sMemoryLimit);
  117. if ($iMemoryLimit < $iMinMemoryRequired)
  118. {
  119. $oP->error("memory_limit ($iMemoryLimit) is too small, the minimum value to run iTop is $iMinMemoryRequired.");
  120. $bResult = false;
  121. }
  122. else
  123. {
  124. $oP->log_info("memory_limit is $iMemoryLimit, ok.");
  125. }
  126. }
  127. return $bResult;
  128. }
  129. /**
  130. * Helper function to retrieve the directory where files are to be uploaded
  131. * @return string Path to the temp directory used for uploading files
  132. */
  133. function GetUploadTmpDir()
  134. {
  135. $sPath = ini_get('upload_tmp_dir');
  136. if (empty($sPath))
  137. {
  138. $sPath = GetTmpDir();
  139. }
  140. return $sPath;
  141. }
  142. /**
  143. * Helper function to check if the current version of PHP
  144. * is compatible with the application
  145. * @return boolean true if this is Ok, false otherwise
  146. */
  147. function CheckPHPVersion(SetupWebPage $oP)
  148. {
  149. $bResult = true;
  150. $oP->log('Info - CheckPHPVersion');
  151. if (version_compare(phpversion(), PHP_MIN_VERSION, '>='))
  152. {
  153. $oP->ok("The current PHP Version (".phpversion().") is greater than the minimum required version (".PHP_MIN_VERSION.")");
  154. }
  155. else
  156. {
  157. $oP->error("Error: The current PHP Version (".phpversion().") is lower than the minimum required version (".PHP_MIN_VERSION.")");
  158. return false;
  159. }
  160. $aMandatoryExtensions = array('mysql', 'iconv', 'simplexml', 'soap');
  161. asort($aMandatoryExtensions); // Sort the list to look clean !
  162. $aExtensionsOk = array();
  163. $aMissingExtensions = array();
  164. $aMissingExtensionsLinks = array();
  165. foreach($aMandatoryExtensions as $sExtension)
  166. {
  167. if (extension_loaded($sExtension))
  168. {
  169. $aExtensionsOk[] = $sExtension;
  170. }
  171. else
  172. {
  173. $aMissingExtensions[] = $sExtension;
  174. $aMissingExtensionsLinks[] = "<a href=\"http://www.php.net/manual/en/book.$sExtension.php\">$sExtension</a>";
  175. }
  176. }
  177. if (count($aExtensionsOk) > 0)
  178. {
  179. $oP->ok("Required PHP extension(s): ".implode(', ', $aExtensionsOk).".");
  180. }
  181. if (count($aMissingExtensions) > 0)
  182. {
  183. $oP->error("Missing PHP extension(s): ".implode(', ', $aMissingExtensionsLinks).".");
  184. $bResult = false;
  185. }
  186. // Check some ini settings here
  187. if (function_exists('php_ini_loaded_file')) // PHP >= 5.2.4
  188. {
  189. $sPhpIniFile = php_ini_loaded_file();
  190. // Other included/scanned files
  191. if ($sFileList = php_ini_scanned_files())
  192. {
  193. if (strlen($sFileList) > 0)
  194. {
  195. $aFiles = explode(',', $sFileList);
  196. foreach ($aFiles as $sFile)
  197. {
  198. $sPhpIniFile .= ', '.trim($sFile);
  199. }
  200. }
  201. }
  202. $oP->log("Info - php.ini file(s): '$sPhpIniFile'");
  203. }
  204. else
  205. {
  206. $sPhpIniFile = 'php.ini';
  207. }
  208. if (!ini_get('file_uploads'))
  209. {
  210. $oP->error("Files upload is not allowed on this server (file_uploads = ".ini_get('file_uploads').").");
  211. $bResult = false;
  212. }
  213. $sUploadTmpDir = GetUploadTmpDir();
  214. if (empty($sUploadTmpDir))
  215. {
  216. $sUploadTmpDir = '/tmp';
  217. $oP->warning("Temporary directory for files upload is not defined (upload_tmp_dir), assuming that $sUploadTmpDir is used.");
  218. }
  219. // check that the upload directory is indeed writable from PHP
  220. if (!empty($sUploadTmpDir))
  221. {
  222. if (!file_exists($sUploadTmpDir))
  223. {
  224. $oP->error("Temporary directory for files upload ($sUploadTmpDir) does not exist or cannot be read by PHP.");
  225. $bResult = false;
  226. }
  227. else if (!is_writable($sUploadTmpDir))
  228. {
  229. $oP->error("Temporary directory for files upload ($sUploadTmpDir) is not writable.");
  230. $bResult = false;
  231. }
  232. else
  233. {
  234. $oP->log("Info - Temporary directory for files upload ($sUploadTmpDir) is writable.");
  235. }
  236. }
  237. if (!ini_get('upload_max_filesize'))
  238. {
  239. $oP->error("File upload is not allowed on this server (file_uploads = ".ini_get('file_uploads').").");
  240. }
  241. $iMaxFileUploads = ini_get('max_file_uploads');
  242. if (!empty($iMaxFileUploads) && ($iMaxFileUploads < 1))
  243. {
  244. $oP->error("File upload is not allowed on this server (max_file_uploads = ".ini_get('max_file_uploads').").");
  245. $bResult = false;
  246. }
  247. $oP->log("Info - upload_max_filesize: ".ini_get('upload_max_filesize'));
  248. $oP->log("Info - max_file_uploads: ".ini_get('max_file_uploads'));
  249. // Check some more ini settings here, needed for file upload
  250. if (get_magic_quotes_gpc())
  251. {
  252. $oP->error("'magic_quotes_gpc' is set to On. Please turn it Off before continuing. You may want to check the PHP configuration file(s): '$sPhpIniFile'. Be aware that this setting can also be overridden in the apache configuration.");
  253. $bResult = false;
  254. }
  255. $bResult = $bResult & CheckMemoryLimit($oP, MIN_MEMORY_LIMIT);
  256. return $bResult;
  257. }
  258. /**
  259. * Helper function check the connection to the database and (if connected) to enumerate
  260. * the existing databases
  261. * @return Array The list of databases found in the server
  262. */
  263. function CheckServerConnection(SetupWebPage $oP, $sDBServer, $sDBUser, $sDBPwd)
  264. {
  265. $aResult = array();
  266. $oP->log('Info - CheckServerConnection');
  267. try
  268. {
  269. $oDBSource = new CMDBSource;
  270. $oDBSource->Init($sDBServer, $sDBUser, $sDBPwd);
  271. $oP->ok("Connection to '$sDBServer' as '$sDBUser' successful.");
  272. $oP->log("Info - User privileges: ".($oDBSource->GetRawPrivileges()));
  273. $sDBVersion = $oDBSource->GetDBVersion();
  274. if (version_compare($sDBVersion, MYSQL_MIN_VERSION, '>='))
  275. {
  276. $oP->ok("Current MySQL version ($sDBVersion), greater than minimum required version (".MYSQL_MIN_VERSION.")");
  277. // Check some server variables
  278. $iMaxAllowedPacket = $oDBSource->GetServerVariable('max_allowed_packet');
  279. $iMaxUploadSize = utils::ConvertToBytes(ini_get('upload_max_filesize'));
  280. if ($iMaxAllowedPacket >= (500 + $iMaxUploadSize)) // Allow some space for the query + the file to upload
  281. {
  282. $oP->ok("MySQL server's max_allowed_packet is big enough.");
  283. }
  284. else if($iMaxAllowedPacket < $iMaxUploadSize)
  285. {
  286. $oP->warning("MySQL server's max_allowed_packet ($iMaxAllowedPacket) is not big enough. Please, consider setting it to at least ".(500 + $iMaxUploadSize).".");
  287. }
  288. $oP->log("Info - MySQL max_allowed_packet: $iMaxAllowedPacket");
  289. $iMaxConnections = $oDBSource->GetServerVariable('max_connections');
  290. if ($iMaxConnections < 5)
  291. {
  292. $oP->warning("MySQL server's max_connections ($iMaxConnections) is not enough. Please, consider setting it to at least 5.");
  293. }
  294. $oP->log("Info - MySQL max_connections: ".($oDBSource->GetServerVariable('max_connections')));
  295. }
  296. else
  297. {
  298. $oP->error("Error: Current MySQL version is ($sDBVersion), minimum required version (".MYSQL_MIN_VERSION.")");
  299. return false;
  300. }
  301. try
  302. {
  303. $aResult = $oDBSource->ListDB();
  304. }
  305. catch(Exception $e)
  306. {
  307. $oP->warning("Warning: unable to enumerate the current databases.");
  308. $aResult = true; // Not an array to differentiate with an empty array
  309. }
  310. }
  311. catch(Exception $e)
  312. {
  313. $oP->error("Error: Connection to '$sDBServer' as '$sDBUser' failed.");
  314. $oP->p($e->GetHtmlDesc());
  315. $aResult = false;
  316. }
  317. return $aResult;
  318. }
  319. /**
  320. * Helper function to initialize the ORM and load the data model
  321. * from the given file
  322. * @param $sConfigFileName string The name of the configuration file to load
  323. * @param $bModelOnly boolean Whether or not to allow loading a data model with no corresponding DB
  324. * @return none
  325. */
  326. function InitDataModel(SetupWebPage $oP, $sConfigFileName, $bModelOnly = true)
  327. {
  328. require_once('../core/log.class.inc.php');
  329. require_once('../core/coreexception.class.inc.php');
  330. require_once('../core/dict.class.inc.php');
  331. require_once('../core/attributedef.class.inc.php');
  332. require_once('../core/filterdef.class.inc.php');
  333. require_once('../core/stimulus.class.inc.php');
  334. require_once('../core/MyHelpers.class.inc.php');
  335. require_once('../core/expression.class.inc.php');
  336. require_once('../core/cmdbsource.class.inc.php');
  337. require_once('../core/sqlquery.class.inc.php');
  338. require_once('../core/dbobject.class.php');
  339. require_once('../core/dbobjectsearch.class.php');
  340. require_once('../core/dbobjectset.class.php');
  341. require_once('../application/cmdbabstract.class.inc.php');
  342. require_once('../core/userrights.class.inc.php');
  343. $oP->log("Info - MetaModel::Startup from file '$sConfigFileName' (ModelOnly = $bModelOnly)");
  344. MetaModel::Startup($sConfigFileName, $bModelOnly);
  345. }
  346. /**
  347. * Helper function to create the database structure
  348. * @return boolean true on success, false otherwise
  349. */
  350. function CreateDatabaseStructure(SetupWebPage $oP, Config $oConfig, $sDBName, $sDBPrefix)
  351. {
  352. InitDataModel($oP, TMP_CONFIG_FILE, true); // Allow the DB to NOT exist since we're about to create it !
  353. $oP->log('Info - CreateDatabaseStructure');
  354. if (strlen($sDBPrefix) > 0)
  355. {
  356. $oP->info("Creating the structure in '$sDBName' (table names prefixed by '$sDBPrefix').");
  357. }
  358. else
  359. {
  360. $oP->info("Creating the structure in '$sDBName'.");
  361. }
  362. //MetaModel::CheckDefinitions();
  363. if (!MetaModel::DBExists(/* bMustBeComplete */ false))
  364. {
  365. MetaModel::DBCreate();
  366. $oP->ok("Database structure successfully created.");
  367. }
  368. else
  369. {
  370. if (strlen($sDBPrefix) > 0)
  371. {
  372. $oP->error("Error: found iTop tables into the database '$sDBName' (prefix: '$sDBPrefix'). Please, try selecting another database instance or specify another prefix to prevent conflicting table names.");
  373. }
  374. else
  375. {
  376. $oP->error("Error: found iTop tables into the database '$sDBName'. Please, try selecting another database instance or specify a prefix to prevent conflicting table names.");
  377. }
  378. return false;
  379. }
  380. return true;
  381. }
  382. /**
  383. * Helper function to create and administrator account for iTop
  384. * @return boolean true on success, false otherwise
  385. */
  386. function CreateAdminAccount(SetupWebPage $oP, Config $oConfig, $sAdminUser, $sAdminPwd, $sLanguage)
  387. {
  388. $oP->log('Info - CreateAdminAccount');
  389. InitDataModel($oP, TMP_CONFIG_FILE, false); // load data model and connect to the database
  390. if (UserRights::CreateAdministrator($sAdminUser, $sAdminPwd, $sLanguage))
  391. {
  392. $oP->ok("Administrator account '$sAdminUser' created.");
  393. return true;
  394. }
  395. else
  396. {
  397. $oP->error("Failed to create the administrator account '$sAdminUser'.");
  398. return false;
  399. }
  400. }
  401. function ListModuleFiles($sDirectory, SetupWebPage $oP)
  402. {
  403. //echo "<p>$sDirectory</p>\n";
  404. if ($hDir = opendir($sDirectory))
  405. {
  406. // This is the correct way to loop over the directory. (according to the documentation)
  407. while (($sFile = readdir($hDir)) !== false)
  408. {
  409. $aMatches = array();
  410. if (is_dir($sDirectory.'/'.$sFile))
  411. {
  412. if (($sFile != '.') && ($sFile != '..') && ($sFile != '.svn'))
  413. {
  414. ListModuleFiles($sDirectory.'/'.$sFile, $oP);
  415. }
  416. }
  417. else if (preg_match('/^module\.(.*).php$/i', $sFile, $aMatches))
  418. {
  419. try
  420. {
  421. //echo "<p>Loading: $sDirectory/$sFile...</p>\n";
  422. require_once($sDirectory.'/'.$sFile);
  423. //echo "<p>Done.</p>\n";
  424. }
  425. catch(Exception $e)
  426. {
  427. // Continue...
  428. }
  429. }
  430. }
  431. closedir($hDir);
  432. }
  433. else
  434. {
  435. $oP->error("Data directory (".$sDirectory.") not found or not readable.");
  436. }
  437. }
  438. /**
  439. * Scans the ./data directory for XML files and output them as a Javascript array
  440. */
  441. function PopulateDataFilesList(SetupWebPage $oP, $aParamValues)
  442. {
  443. $oP->add("<script type=\"text/javascript\">\n");
  444. $oP->add("function PopulateDataFilesList()\n");
  445. $oP->add("{\n");
  446. $oP->add("if (aFilesToLoad.length > 0) return;"); // Populate the list only once...
  447. $aAvailableModules = GetAvailableModules($oP);
  448. $aStructureDataFiles = array();
  449. $aSampleDataFiles = array();
  450. foreach($aParamValues['module'] as $sModuleId)
  451. {
  452. $aModuleStruct = $aAvailableModules[$sModuleId]['data.struct'];
  453. $aModuleSamples = $aAvailableModules[$sModuleId]['data.sample'];
  454. $aStructureDataFiles = array_merge($aStructureDataFiles, $aModuleStruct);
  455. $aSampleDataFiles = array_merge($aSampleDataFiles, $aModuleSamples);
  456. }
  457. // Structure data
  458. //
  459. foreach($aStructureDataFiles as $sFile)
  460. {
  461. // Under Windows, it is a must to escape backslashes (not an issue until a folder name starts with t or n, etc...)
  462. $sFile = str_replace('\\', '\\\\', $sFile);
  463. $oP->add("aFilesToLoad[aFilesToLoad.length] = '$sFile';\n");
  464. }
  465. // Sample data - loaded IIF wished by the user
  466. //
  467. $oP->add("if (($(\"#sample_data:checked\").length == 1))");
  468. $oP->add("{");
  469. foreach($aSampleDataFiles as $sFile)
  470. {
  471. // Under Windows, it is a must to escape backslashes (not an issue until a folder name starts with t or n, etc...)
  472. $sFile = str_replace('\\', '\\\\', $sFile);
  473. $oP->add("aFilesToLoad[aFilesToLoad.length] = '$sFile';\n");
  474. }
  475. $oP->add("}\n");
  476. $oP->add("}\n");
  477. $oP->add("</script>\n");
  478. }
  479. /**
  480. * Add some parameters as hidden inputs into a form
  481. * @param SetupWebpage $oP The page to insert the form elements into
  482. * @param Hash $aParamValues The pairs name/value to be stored in the form
  483. * @param Array $aExcludeParams A list of parameters to exclude from the previous hash
  484. */
  485. function AddParamsToForm(SetupWebpage $oP, $aParamValues, $aExcludeParams = array())
  486. {
  487. foreach($aParamValues as $sName => $value)
  488. {
  489. if(!in_array($sName, $aExcludeParams))
  490. {
  491. if (is_array($value))
  492. {
  493. foreach($value as $sKey => $sItem)
  494. {
  495. $oP->add('<input type="hidden" name="'.$sName.'['.$sKey.']'.'" value="'.$sItem.'">');
  496. }
  497. }
  498. else
  499. {
  500. $oP->add('<input type="hidden" name="'.$sName.'" value="'.$value.'">');
  501. }
  502. }
  503. }
  504. }
  505. /**
  506. * Search (on the disk) for all defined iTop modules, load them and returns the list (as an array)
  507. * of the possible iTop modules to install
  508. * @param none
  509. * @return Hash A big array moduleID => ModuleData
  510. */
  511. function GetAvailableModules(SetupWebpage $oP)
  512. {
  513. clearstatcache();
  514. ListModuleFiles('../modules/', $oP);
  515. return $oP->GetModules();
  516. }
  517. /**
  518. * Build the config file from the parameters (especially the selected modules)
  519. */
  520. function BuildConfig(SetupWebpage $oP, Config &$oConfig, $aParamValues)
  521. {
  522. $aAvailableModules = GetAvailableModules($oP);
  523. // Initialize the arrays below with default values for the application...
  524. $aAddOns = $oConfig->GetAddOns();
  525. $aAppModules = $oConfig->GetAppModules();
  526. $aDataModels = $oConfig->GetDataModels();
  527. $sDictionaries = $oConfig->GetDictionaries();
  528. // Merge the values with the ones provided by the modules
  529. // Make sure when don't load the same file twice...
  530. foreach($aParamValues['module'] as $sModuleId)
  531. {
  532. $oP->log('Installed iTop module: '. $sModuleId);
  533. $aDataModels = array_unique(array_merge($aDataModels, $aAvailableModules[$sModuleId]['datamodel']));
  534. $sDictionaries = array_unique(array_merge($sDictionaries, $aAvailableModules[$sModuleId]['dictionary']));
  535. foreach($aAvailableModules[$sModuleId]['settings'] as $sProperty => $value)
  536. {
  537. $oConfig->SetModuleSetting($sModuleId, $sProperty, $value);
  538. }
  539. }
  540. $oConfig->SetAddOns($aAddOns);
  541. $oConfig->SetAppModules($aAppModules);
  542. $oConfig->SetDataModels($aDataModels);
  543. $oConfig->SetDictionaries($sDictionaries);
  544. }
  545. /////////////////////////////////////////////////////////////////////////////////////////////////////////////
  546. // Handling of the different steps of the setup wizard
  547. /////////////////////////////////////////////////////////////////////////////////////////////////////////////
  548. /**
  549. * Displays the welcome screen and check some basic prerequisites
  550. */
  551. function WelcomeAndCheckPrerequisites(SetupWebPage $oP, $aParamValues, $iCurrentStep)
  552. {
  553. $sNextOperation = 'step'.($iCurrentStep+1);
  554. $oP->add("<h1>iTop configuration wizard</h1>\n");
  555. $sVersionStringShort = GetITopVersion(true);
  556. $sVersionStringLong = GetITopVersion(false);
  557. $oP->set_title('Welcome to '.$sVersionStringShort);
  558. $oP->log($sVersionStringLong);
  559. $oP->add("<h2>Checking prerequisites</h2>\n");
  560. if (CheckPHPVersion($oP))
  561. {
  562. $oP->add("<h2 class=\"next\">Next: Licence agreement</h2>\n");
  563. $oP->add("<form id=\"theForm\" method=\"post\" onSubmit=\"return DoSubmit('', 0)\">\n");
  564. $oP->add("<input type=\"hidden\" name=\"operation\" value=\"$sNextOperation\">\n");
  565. AddParamsToForm($oP, $aParamValues);
  566. $oP->add("<table style=\"width:100%\"><tr>\n");
  567. $oP->add("<td style=\"text-align:right;\"><button type=\"submit\" type=\"submit\">Next >></button></td>\n");
  568. $oP->add("</tr></table>\n");
  569. $oP->add("</form>\n");
  570. }
  571. }
  572. function LicenceAcknowledgement($oP, $aParamValues, $iCurrentStep)
  573. {
  574. $sNextOperation = 'step'.($iCurrentStep+1);
  575. $oP->set_title('License Agreement');
  576. $oP->add('<h2>iTop is released by <a href="http://www.combodo.com">Combodo SARL</a> under the terms of the GPL V3 license. In order to use iTop you must accept the terms of this license.</h2>');
  577. $oP->add("<iframe style=\"width: 100%; height: 350px; overflow-y:auto; font-size:0.8em;\" src=\"./licence.html\">Next: Database server selection</iframe>\n");
  578. $oP->add("<form id=\"theForm\" method=\"post\">\n");
  579. $oP->add("<input type=\"hidden\" name=\"operation\" value=\"$sNextOperation\">\n");
  580. AddParamsToForm($oP, $aParamValues, array('licence_ok'));
  581. $sChecked = $aParamValues['licence_ok'] == 1 ? 'checked' : '';
  582. $oP->add("<h2><input id=\"licence_ok\" type=\"checkbox\" name=\"licence_ok\" value=\"1\" $sChecked><label for=\"licence_ok\">I accept the terms of this licence agreement</label></h2>\n");
  583. $oP->add("<h2 class=\"next\">Next: Database server selection</h2>\n");
  584. $oP->add("<table style=\"width:100%\"><tr>\n");
  585. $oP->add("<td style=\"text-align:left;\"><button type=\"button\" onClick=\"return DoGoBack($iCurrentStep)\"><< Back</button></td>\n");
  586. $oP->add("<td style=\"text-align:right;\"><button type=\"submit\" onClick=\"return DoSubmit('', $iCurrentStep)\">Next >></button></td>\n");
  587. $oP->add("</tr></table>\n");
  588. $oP->add("</form>\n");
  589. }
  590. /**
  591. * Display the form for the first step of the configuration wizard
  592. * which consists in the database server selection
  593. */
  594. function DatabaseServerSelection(SetupWebPage $oP, $aParamValues, $iCurrentStep)
  595. {
  596. $sNextOperation = 'step'.($iCurrentStep+1);
  597. $oP->add("<form id=\"theForm\" method=\"post\">\n");
  598. $oP->add("<input type=\"hidden\" name=\"operation\" value=\"$sNextOperation\">\n");
  599. AddParamsToForm($oP, $aParamValues, array('db_server', 'db_user', 'db_pwd'));
  600. if ($aParamValues['licence_ok'] == 1)
  601. {
  602. $sRedStar = '<span class="hilite">*</span>';
  603. $oP->set_title("Configuration of the database connection\n");
  604. $oP->add("<h2>Please enter the name of the MySQL database server you want to use for iTop and supply valid credentials to connect to it</h2>\n");
  605. // Form goes here
  606. $oP->add("<fieldset><legend>Database connection</legend>\n");
  607. $aForm = array();
  608. $aForm[] = array('label' => "Server name$sRedStar:", 'input' => "<input id=\"db_server\" type=\"text\" name=\"db_server\" value=\"{$aParamValues['db_server']}\">",
  609. 'help' => 'E.g. "localhost", "dbserver.mycompany.com" or "192.142.10.23"');
  610. $aForm[] = array('label' => "User name$sRedStar:", 'input' => "<input id=\"db_user\" type=\"text\" name=\"db_user\" value=\"{$aParamValues['db_user']}\">",
  611. 'help' => 'The account must have the following privileges: SELECT, INSERT, UPDATE, DELETE, CREATE, ALTER');
  612. $aForm[] = array('label' => 'Password:', 'input' => "<input id=\"db_pwd\" type=\"password\" name=\"db_pwd\" value=\"{$aParamValues['db_pwd']}\">");
  613. $oP->form($aForm);
  614. $oP->add("</fieldset>\n");
  615. $oP->add("<h2 class=\"next\">Next: Database Instance Selection</h2>\n");
  616. $oP->add("<table style=\"width:100%\"><tr>\n");
  617. $oP->add("<td style=\"text-align:left;\"><button type=\"button\" onClick=\"return DoGoBack($iCurrentStep)\"><< Back</button></td>\n");
  618. $oP->add("<td style=\"text-align:right;\"><button type=\"submit\" onClick=\"return DoSubmit('Connecting to the database...', $iCurrentStep);\">Next >></button></td>\n");
  619. $oP->add("</tr></table>\n");
  620. }
  621. else
  622. {
  623. $oP->add("<button type=\"button\" onClick=\"return DoGoBack($iCurrentStep);\"><< Back</button>\n");
  624. }
  625. $oP->add("</form>\n");
  626. }
  627. /**
  628. * Display the form for the second step of the configuration wizard
  629. * which consists in
  630. * 1) Validating the parameters by connecting to the database server
  631. * 2) Prompting to select an existing database or to create a new one
  632. */
  633. function DatabaseInstanceSelection(SetupWebPage $oP, $aParamValues, $iCurrentStep, $oConfig)
  634. {
  635. $sNextOperation = 'step'.($iCurrentStep+1);
  636. $oP->set_title("Database Instance Selection\n");
  637. $oP->add("<form id=\"theForm\" method=\"post\">\n");
  638. $oP->add("<input type=\"hidden\" name=\"operation\" value=\"$sNextOperation\">\n");
  639. AddParamsToForm($oP, $aParamValues, array('db_name', 'db_prefix', 'new_db_name'));
  640. $sDBServer = $aParamValues['db_server'];
  641. $sDBUser = $aParamValues['db_user'];
  642. $sDBPwd = $aParamValues['db_pwd'];
  643. $aDatabases = CheckServerConnection($oP, $sDBServer, $sDBUser, $sDBPwd);
  644. if ($aDatabases === false)
  645. {
  646. // Connection failed, invalid credentials ? Go back
  647. $oP->add("<button type=\"button\" onClick=\"return DoGoBack($iCurrentStep);\"><< Back</button>\n");
  648. }
  649. else
  650. {
  651. // Connection is Ok, save it and continue the setup wizard
  652. $oConfig->SetDBHost($sDBServer);
  653. $oConfig->SetDBUser($sDBUser);
  654. $oConfig->SetDBPwd($sDBPwd);
  655. $oConfig->WriteToFile();
  656. $oP->add("<fieldset><legend>Select the database instance to use for iTop<span class=\"hilite\">*</span></legend>\n");
  657. $aForm = array();
  658. $bExistingChecked = false;
  659. if (is_array($aDatabases))
  660. {
  661. foreach($aDatabases as $sDBName)
  662. {
  663. $sChecked = '';
  664. if ($aParamValues['db_name'] == $sDBName)
  665. {
  666. $sChecked = 'checked';
  667. $bExistingChecked = true;
  668. }
  669. $aForm[] = array('label' => "<input id=\"db_$sDBName\" type=\"radio\" name=\"db_name\" value=\"$sDBName\" $sChecked/><label for=\"db_$sDBName\"> $sDBName</label>");
  670. }
  671. }
  672. else
  673. {
  674. $aForm[] = array('label' => "<input id=\"current_db\" type=\"radio\" name=\"db_name\" value=\"-1\" /><label for=\"current_db\"> Use the existing database:</label> <input type=\"text\" id=\"current_db_name\" name=\"current_db_name\" value=\"\" maxlength=\"32\"/>");
  675. $oP->add_ready_script("$('#current_db_name').click( function() { $('#current_db').attr('checked', true); });");
  676. }
  677. $sChecked = '';
  678. $sDBName = '';
  679. // If the 'Create Database' option was checked... and the database still does not exist
  680. if (!$bExistingChecked && !empty($aParamValues['new_db_name']))
  681. {
  682. $sChecked = 'checked';
  683. $sDBName = $aParamValues['new_db_name'];
  684. }
  685. $aForm[] = array('label' => "<input id=\"new_db\" type=\"radio\" name=\"db_name\" value=\"\" $sChecked/><label for=\"new_db\"> Create a new database:</label> <input type=\"text\" id=\"new_db_name\" name=\"new_db_name\" value=\"$sDBName\" maxlength=\"32\"/>");
  686. $oP->form($aForm);
  687. $oP->add_ready_script("$('#new_db_name').click( function() { $('#new_db').attr('checked', true); })");
  688. $oP->add("</fieldset>\n");
  689. $aForm = array();
  690. $aForm[] = array('label' => "Add a prefix to all the tables: <input id=\"db_prefix\" type=\"text\" name=\"db_prefix\" value=\"{$aParamValues['db_prefix']}\" maxlength=\"32\"/>");
  691. $oP->form($aForm);
  692. $oP->add("<h2 class=\"next\">Next: iTop Modules Selection</h2>\n");
  693. $oP->add("<table style=\"width:100%\"><tr>\n");
  694. $oP->add("<td style=\"text-align:left;\"><button type=\"button\" onClick=\"return DoGoBack($iCurrentStep)\"><< Back</button></td>\n");
  695. $oP->add("<td style=\"text-align:right;\"><button type=\"submit\" onClick=\"return DoSubmit('', $iCurrentStep);\">Next >></button></td>\n");
  696. $oP->add("</tr></table>\n");
  697. }
  698. $oP->add("</form>\n");
  699. }
  700. /**
  701. * Display the form to select the iTop modules to be installed
  702. */
  703. function ModulesSelection(SetupWebPage $oP, $aParamValues, $iCurrentStep, $oConfig)
  704. {
  705. $sNextOperation = 'step'.($iCurrentStep+1);
  706. $sPrevOperation = 'step'.($iCurrentStep-1);
  707. $sDBName = $aParamValues['db_name'];
  708. if ($sDBName == '')
  709. {
  710. $sDBName = $aParamValues['new_db_name'];
  711. }
  712. $sDBPrefix = $aParamValues['db_prefix'];
  713. $oConfig->SetDBName($sDBName);
  714. $oConfig->SetDBSubname($sDBPrefix);
  715. $oConfig->WriteToFile(TMP_CONFIG_FILE);
  716. $oP->add("<form id=\"theForm\" method=\"post\">\n");
  717. $oP->add("<input type=\"hidden\" name=\"operation\" value=\"$sNextOperation\">\n");
  718. AddParamsToForm($oP, $aParamValues, array('module'));
  719. $sRedStar = '<span class="hilite">*</span>';
  720. $oP->set_title("Selection of the iTop Modules\n");
  721. $oP->add("<h2>Customize your iTop installation to fit your needs</h2>\n");
  722. $aAvailableModules = GetAvailableModules($oP);
  723. // Form goes here
  724. $oP->add("<fieldset><legend>Select the iTop modules you want to install:</legend>\n");
  725. $oP->add("<div style=\"border: 0;width:100%; height: 350px; overflow-y:auto;\">");
  726. $sRedStar = '<span class="hilite">*</span>';
  727. $index = 0;
  728. $aSelectedModules = $aParamValues['module'];
  729. if ($aSelectedModules == '')
  730. {
  731. // Make sure it gets initialized as an array, default value: all modules selected !
  732. $aSelectedModules = array();
  733. foreach($aAvailableModules as $sModuleId => $aModule)
  734. {
  735. $aSelectedModules[] = $sModuleId;
  736. }
  737. }
  738. foreach($aAvailableModules as $sModuleId => $aModule)
  739. {
  740. $sModuleLabel = $aModule['label'];
  741. $sModuleHelp = $aModule['doc.more_information'];
  742. $sClass = ($aModule['mandatory']) ? 'class="read-only"' : '';
  743. $sChecked = ($aModule['mandatory'] || in_array($sModuleId, $aSelectedModules) ) ? 'checked' : '';
  744. $sMoreInfo = (!empty($aModule['doc.more_information'])) ? "<a href=\"{$aModule['doc.more_information']}\" target=\"_blank\">more info</a>": '';
  745. if ($aModule['category'] == 'authentication')
  746. {
  747. // For now authentication modules are always on and hidden
  748. $oP->add("<input type=\"hidden\" id=\"module[$index]\" name=\"module[$index]\" value=\"$sModuleId\">\n");
  749. $index++;
  750. }
  751. elseif ($aModule['visible'])
  752. {
  753. $oP->add("<p><input type=\"checkbox\" $sClass $sChecked id=\"module[$index]\" name=\"module[$index]\" value=\"$sModuleId\"><label $sClass for=\"module[$index]\"> {$aModule['label']}</label> $sMoreInfo</p>\n");
  754. $index++;
  755. }
  756. else
  757. {
  758. // For now hidden modules are always on !
  759. $oP->add("<input type=\"hidden\" id=\"module[$index]\" name=\"module[$index]\" value=\"$sModuleId\">\n");
  760. $index++;
  761. }
  762. }
  763. $oP->add("</div>");
  764. $oP->add("</fieldset>\n");
  765. $oP->add("<h2 class=\"next\">Next: Administrator Account Creation</h2>\n");
  766. $oP->add("<table style=\"width:100%\"><tr>\n");
  767. $oP->add("<td style=\"text-align:left;\"><button type=\"button\" onClick=\"return DoGoBack($iCurrentStep)\"><< Back</button></td>\n");
  768. $oP->add("<td style=\"text-align:right;\"><button type=\"submit\" onClick=\"return DoSubmit('Creating the database structure...', $iCurrentStep);\">Next >></button></td>\n");
  769. $oP->add("</tr></table>\n");
  770. $oP->add("</form>\n");
  771. $oP->add_ready_script("$('.read-only').click( function() { $(this).attr('checked','checked'); } );");
  772. }
  773. /**
  774. * Display the form for the third step of the configuration wizard
  775. * which consists in
  776. * 1) Validating the parameters by connecting to the database server & selecting the database
  777. * 2) Creating the database structure
  778. * 3) Prompting for the admin account to be created
  779. */
  780. function AdminAccountDefinition(SetupWebPage $oP, $aParamValues, $iCurrentStep, Config $oConfig)
  781. {
  782. $sNextOperation = 'step'.($iCurrentStep+1);
  783. $oP->set_title("Configuration of the admin account");
  784. $oP->add("<h2>Creation of the database structure</h2>");
  785. $oP->add("<form id=\"theForm\" method=\"post\">\n");
  786. $oP->add("<input type=\"hidden\" name=\"operation\" value=\"$sNextOperation\">\n");
  787. AddParamsToForm($oP, $aParamValues, array('auth_user', 'auth_pwd', 'language'));
  788. $sDBName = $aParamValues['db_name'];
  789. if ($sDBName == '')
  790. {
  791. $sDBName = $aParamValues['new_db_name'];
  792. }
  793. $sDBPrefix = $aParamValues['db_prefix'];
  794. $oConfig->SetDBName($sDBName);
  795. $oConfig->SetDBSubname($sDBPrefix);
  796. BuildConfig($oP, $oConfig, $aParamValues); // Load all the includes based on the modules selected
  797. $oConfig->WriteToFile(TMP_CONFIG_FILE);
  798. if (CreateDatabaseStructure($oP, $oConfig, $sDBName, $sDBPrefix))
  799. {
  800. $sRedStar = "<span class=\"hilite\">*</span>";
  801. $oP->add("<h2>Default language for the application:</h2>\n");
  802. // Possible languages (depends on the dictionaries loaded in the config)
  803. $aForm = array();
  804. $aAvailableLanguages = Dict::GetLanguages();
  805. $sLanguages = '';
  806. $sDefaultCode = $oConfig->GetDefaultLanguage();
  807. foreach($aAvailableLanguages as $sLangCode => $aInfo)
  808. {
  809. $sSelected = ($sLangCode == $sDefaultCode ) ? 'selected ' : '';
  810. $sLanguages.="<option value=\"{$sLangCode}\">{$aInfo['description']} ({$aInfo['localized_description']})</option>";
  811. }
  812. $aForm[] = array('label' => "Default Language$sRedStar:", 'input' => "<select id=\"language\" name=\"language\">$sLanguages</option>");
  813. $oP->form($aForm);
  814. $oP->add("<h2>Definition of the administrator account</h2>\n");
  815. // Database created, continue with admin creation
  816. $oP->add("<fieldset><legend>Administrator account</legend>\n");
  817. $aForm = array();
  818. $aForm[] = array('label' => "Login$sRedStar:", 'input' => "<input id=\"auth_user\" type=\"text\" name=\"auth_user\" value=\"{$aParamValues['auth_user']}\">");
  819. $aForm[] = array('label' => "Password$sRedStar:", 'input' => "<input id=\"auth_pwd\" type=\"password\" name=\"auth_pwd\" value=\"{$aParamValues['auth_pwd']}\">");
  820. $aForm[] = array('label' => "Retype password$sRedStar:", 'input' => "<input id=\"auth_pwd2\" type=\"password\" name=\"auth_pwd2\" value=\"{$aParamValues['auth_pwd']}\">");
  821. $oP->form($aForm);
  822. $oP->add("</fieldset>\n");
  823. $oP->add("<h2 class=\"next\">Next: Administrator Account Creation</h2>\n");
  824. $oP->add("<table style=\"width:100%\"><tr>\n");
  825. $oP->add("<td style=\"text-align:left;\"><button type=\"button\" onClick=\"return DoGoBack($iCurrentStep)\"><< Back</button></td>\n");
  826. $oP->add("<td style=\"text-align:right;\"><button type=\"submit\" onClick=\"return DoSubmit('Creating the admin account and profiles...', $iCurrentStep);\">Next >></button></td>\n");
  827. $oP->add("</tr></table>\n");
  828. }
  829. else
  830. {
  831. $oP->add("<button type=\"button\" onClick=\"return DoGoBack($iCurrentStep)\"><< Back</button>\n");
  832. }
  833. // Form goes here
  834. $oP->add("</form>\n");
  835. }
  836. /**
  837. * Display the form for the fourth step of the configuration wizard
  838. * which consists in
  839. * 1) Creating the admin user account
  840. * 2) Prompting to load some sample data
  841. */
  842. function SampleDataSelection(SetupWebPage $oP, $aParamValues, $iCurrentStep, Config $oConfig)
  843. {
  844. $sNextOperation = 'step'.($iCurrentStep+1);
  845. $oP->set_title("Application Initialization");
  846. $sAdminUser = $aParamValues['auth_user'];
  847. $sAdminPwd = $aParamValues['auth_pwd'];
  848. $sLanguage = $aParamValues['language'];
  849. $oConfig->SetDefaultLanguage($aParamValues['language']);
  850. $oConfig->WriteToFile(TMP_CONFIG_FILE);
  851. $oP->add("<form id=\"theForm\" method=\"post\"\">\n");
  852. $oP->add("<input type=\"hidden\" name=\"operation\" value=\"$sNextOperation\">\n");
  853. AddParamsToForm($oP, $aParamValues, array('sample_data'));
  854. if (CreateAdminAccount($oP, $oConfig, $sAdminUser, $sAdminPwd, $sLanguage) && UserRights::Setup())
  855. {
  856. $oP->add("<h2>Loading of sample data</h2>\n");
  857. $oP->p("<fieldset><legend> Do you want to load sample data into the database ? </legend>\n");
  858. $oP->p("<input type=\"radio\" id=\"sample_data\" name=\"sample_data\" id=\"sample_data_no\" checked value=\"yes\"><label for=\"sample_data_yes\"> Yes, for testing purposes, populate the database with sample data.</label>\n");
  859. $oP->p("<input type=\"radio\" name=\"sample_data\" unchecked id=\"sample_data_no\" value=\"no\"><label for=\"sample_data_no\"> No, this is a production system, load only the data required by the application.</label>\n");
  860. $oP->p("</fieldset>\n");
  861. $oP->add("<h2 class=\"next\">Next: Application Initialization</h2>\n");
  862. $oP->add("<table style=\"width:100%\"><tr>\n");
  863. $oP->add("<td style=\"text-align:left;\"><button type=\"button\" onClick=\"return DoGoBack($iCurrentStep)\"><< Back</button></td>\n");
  864. $oP->add("<td style=\"text-align:right;\"><button type=\"submit\" onClick=\"return DoSubmit('Finalizing configuration and loading data...', $iCurrentStep)\">Next >></button></td>\n");
  865. $oP->add("</tr></table>\n");
  866. }
  867. else
  868. {
  869. // Creation failed
  870. $oP->error("Internal error: Failed to create the admin account or to setup the user rights");
  871. $oP->add("<button type=\"button\" onClick=\"return DoGoBack($iCurrentStep)\"><< Back</button>\n");
  872. }
  873. // End of visible form
  874. $oP->add("</form>\n");
  875. // Hidden form submitted when moving on to the next page, once all the data files
  876. // have been processed
  877. $oP->add("<form id=\"GoToNextStep\" method=\"post\">\n");
  878. AddParamsToForm($oP, $aParamValues, array('sample_data'));
  879. $oP->add("<input type=\"hidden\" name=\"operation\" value=\"$sNextOperation\">\n");
  880. $oP->add("</form>\n");
  881. $oP->add("<div id=\"log\" style=\"color:#F00;\"></div>\n");
  882. $oP->add_linked_script('./jquery.progression.js');
  883. PopulateDataFilesList($oP, $aParamValues);
  884. }
  885. /**
  886. * Display the form for the fifth (and final) step of the configuration wizard
  887. * which consists in
  888. * 1) Creating the final configuration file
  889. * 2) Prompting the user to make the file read-only
  890. */
  891. function SetupFinished(SetupWebPage $oP, $aParamValues, $iCurrentStep, Config $oConfig)
  892. {
  893. $sAuthUser = $aParamValues['auth_user'];
  894. $sAuthPwd = $aParamValues['auth_pwd'];
  895. try
  896. {
  897. session_start();
  898. // Write the final configuration file
  899. $oConfig->WriteToFile(FINAL_CONFIG_FILE);
  900. // Start the application
  901. InitDataModel($oP, FINAL_CONFIG_FILE, false); // Load model and startup DB
  902. if (UserRights::Login($sAuthUser, $sAuthPwd))
  903. {
  904. $_SESSION['auth_user'] = $sAuthUser;
  905. $_SESSION['auth_pwd'] = $sAuthPwd;
  906. // remove the tmp config file
  907. @unlink(TMP_CONFIG_FILE);
  908. // try to make the final config file read-only
  909. @chmod(FINAL_CONFIG_FILE, 0440); // Read-only for owner and group, nothing for others
  910. $oP->set_title("Configuration completed");
  911. $oP->add("<form id=\"theForm\" method=\"get\" action=\"../index.php\">\n");
  912. // Check if there are some manual steps required:
  913. $aAvailableModules = GetAvailableModules($oP);
  914. $aManualSteps = array();
  915. foreach($aParamValues['module'] as $sModuleId)
  916. {
  917. if (!empty($aAvailableModules[$sModuleId]['doc.manual_setup']))
  918. {
  919. $aManualSteps[$aAvailableModules[$sModuleId]['label']] = $aAvailableModules[$sModuleId]['doc.manual_setup'];
  920. }
  921. }
  922. if (count($aManualSteps) > 0)
  923. {
  924. $oP->add("<h2>Manual operations required</h2>");
  925. $oP->p("In order to complete the installation, the following manual operations are required:");
  926. foreach($aManualSteps as $sModuleLabel => $sUrl)
  927. {
  928. $oP->p("<a href=\"$sUrl\" target=\"_blank\">Manual instructions for $sModuleLabel</a>");
  929. }
  930. }
  931. else
  932. {
  933. $oP->add("<h2>Congratulations for installing iTop</h2>");
  934. $oP->ok("The initialization completed successfully.");
  935. }
  936. // Form goes here.. No back button since the job is done !
  937. $oP->add("<h1>Let us know what you think about iTop</h1>");
  938. $oP->add('<table style="width:100%;border:0;padding:0;"><tr><td style="width:100px;vertical-align:middle;background:#f6f6f1;text-align:center">');
  939. $oP->add('<a href="http://www.combodo.com" style="padding:0;background:transparent;margin:0;"><img style="border:0" src="../images/logo-combodo.png"></a></td>');
  940. $oP->add('<td style="padding-left: 10px;font-size:10pt">');
  941. $oP->add("Combodo built iTop because Combodo believes that modern ITIL tools should be at the center of any IT department.");
  942. $oP->p("Combodo invested a lot of time and effort in iTop, but you can help us improve it even further by providing your feedbacks</p>");
  943. $oP->p("<a href=\"http://www.combodo.com/register?product=iTop&version=".urlencode(ITOP_VERSION." revision ".ITOP_REVISION)."\" target=\"_blank\">Register online</a> to get informed about all iTop related events (new versions, webinars, etc...)");
  944. $oP->p("Check out the <a href=\"http://www.combodo.com/itopsupport\">support options</a> available for iTop.");
  945. $oP->add('</td></tr></table>');
  946. $oP->add("<p style=\"text-align:center;width:100%\"><button type=\"submit\">Enter iTop</button></p>\n");
  947. $oP->add("</form>\n");
  948. }
  949. else
  950. {
  951. $oP->add("<h1>iTop configuration wizard</h1>\n");
  952. $oP->add("<h2>Step 5: Configuration completed</h2>\n");
  953. @unlink(FINAL_CONFIG_FILE); // remove the aborted config
  954. $oP->error("Error: Failed to login for user: '$sAuthUser'\n");
  955. $oP->add("<form id=\"theForm\" method=\"post\">\n");
  956. $oP->add("<button type=\"button\" onClick=\"return DoGoBack($iCurrentStep);\"><< Back</button>\n");
  957. AddParamsToForm($oP, $aParamValues);
  958. $oP->add("<input type=\"hidden\" name=\"operation\" value=\"step0\">\n");
  959. $oP->add("</form>\n");
  960. }
  961. }
  962. catch(Exception $e)
  963. {
  964. $oP->error("Error: unable to create the configuration file.");
  965. $oP->p($e->getHtmlDesc());
  966. $oP->p("Did you forget to remove the previous (read-only) configuration file ?");
  967. $oP->add("<form id=\"theForm\" method=\"post\">\n");
  968. $oP->add("<input type=\"hidden\" name=\"operation\" value=\"step0\">\n");
  969. AddParamsToForm($oP, $aParamValues);
  970. $oP->add("<button type=\"button\" onClick=\"return DoGoBack($iCurrentStep);\"><< Back</button>\n");
  971. $oP->add("</form>\n");
  972. }
  973. }
  974. ///////////////////////////////////////////////////////////////////////////////////////////////////
  975. // Main program
  976. ///////////////////////////////////////////////////////////////////////////////////////////////////
  977. clearstatcache(); // Make sure we know what we are doing !
  978. if (file_exists(FINAL_CONFIG_FILE))
  979. {
  980. // The configuration file already exists
  981. if (is_writable(FINAL_CONFIG_FILE))
  982. {
  983. $oP->warning("<b>Warning:</b> a configuration file '".FINAL_CONFIG_FILE."' already exists, and will be overwritten.");
  984. }
  985. else
  986. {
  987. $oP->add("<h1>iTop configuration wizard</h1>\n");
  988. $oP->add("<h2>Fatal error</h2>\n");
  989. $oP->error("<b>Error:</b> the configuration file '".FINAL_CONFIG_FILE."' already exists and cannot be overwritten.");
  990. $oP->p("The wizard cannot create the configuration file for you. Please remove the file '<b>".realpath(FINAL_CONFIG_FILE)."</b>' or change its access-rights/read-only flag before continuing.");
  991. $oP->output();
  992. exit;
  993. }
  994. }
  995. else
  996. {
  997. // No configuration file yet
  998. // Check that the wizard can write into the root dir to create the configuration file
  999. if (!is_writable(dirname(FINAL_CONFIG_FILE)))
  1000. {
  1001. $oP->add("<h1>iTop configuration wizard</h1>\n");
  1002. $oP->add("<h2>Fatal error</h2>\n");
  1003. $oP->error("<b>Error:</b> the directory where to store the configuration file is not writable.");
  1004. $oP->p("The wizard cannot create the configuration file for you. Please make sure that the directory '<b>".realpath(dirname(FINAL_CONFIG_FILE))."</b>' is writable for the web server.");
  1005. $oP->output();
  1006. exit;
  1007. }
  1008. }
  1009. try
  1010. {
  1011. $oConfig = new Config(TMP_CONFIG_FILE);
  1012. }
  1013. catch(Exception $e)
  1014. {
  1015. // We'll end here when the tmp config file does not exist. It's normal
  1016. $oConfig = new Config(TMP_CONFIG_FILE, false /* Don't try to load it */);
  1017. }
  1018. try
  1019. {
  1020. $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');
  1021. foreach($aParams as $sName)
  1022. {
  1023. $aParamValues[$sName] = utils::ReadParam($sName, '');
  1024. }
  1025. switch($sOperation)
  1026. {
  1027. case 'step0':
  1028. $oP->no_cache();
  1029. $oP->log("Info - ========= Wizard step 0 ========");
  1030. WelcomeAndCheckPrerequisites($oP, $aParamValues, 0);
  1031. break;
  1032. case 'step1':
  1033. $oP->no_cache();
  1034. $oP->log("Info - ========= Wizard step 1 ========");
  1035. LicenceAcknowledgement($oP, $aParamValues, 1);
  1036. break;
  1037. case 'step2':
  1038. $oP->log("Info - ========= Wizard step 2 ========");
  1039. DatabaseServerSelection($oP, $aParamValues, 2);
  1040. break;
  1041. case 'step3':
  1042. $oP->no_cache();
  1043. $oP->log("Info - ========= Wizard step 3 ========");
  1044. DatabaseInstanceSelection($oP, $aParamValues, 3, $oConfig);
  1045. break;
  1046. case 'step4':
  1047. $oP->no_cache();
  1048. $oP->log("Info - ========= Wizard step 4 ========");
  1049. ModulesSelection($oP, $aParamValues, 4, $oConfig);
  1050. break;
  1051. case 'step5':
  1052. $oP->no_cache();
  1053. $oP->log("Info - ========= Wizard step 5 ========");
  1054. AdminAccountDefinition($oP, $aParamValues, 5, $oConfig);
  1055. break;
  1056. case 'step6':
  1057. $oP->no_cache();
  1058. $oP->log("Info - ========= Wizard step 6 ========");
  1059. SampleDataSelection($oP, $aParamValues, 6, $oConfig);
  1060. break;
  1061. case 'step7':
  1062. $oP->no_cache();
  1063. $oP->log("Info - ========= Wizard step 7 ========");
  1064. SetupFinished($oP, $aParamValues, 7, $oConfig);
  1065. break;
  1066. default:
  1067. $oP->error("Error: unsupported operation '$sOperation'");
  1068. }
  1069. }
  1070. catch(Exception $e)
  1071. {
  1072. $oP->error("Error: '".$e->getMessage()."'");
  1073. $oP->add("<button type=\"button\" onClick=\"window.history.back();\"><< Back</button>\n");
  1074. }
  1075. catch(CoreException $e)
  1076. {
  1077. $oP->error("Error: '".$e->getHtmlDesc()."'");
  1078. $oP->add("<button type=\"button\" onClick=\"window.history.back();\"><< Back</button>\n");
  1079. }
  1080. $oP->output();
  1081. ?>