index.php 44 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144
  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 $bAllowMissingDatabase boolean Whether or not to allow loading a data model with no corresponding DB
  324. * @return none
  325. */
  326. function InitDataModel(SetupWebPage $oP, $sConfigFileName, $bAllowMissingDatabase = 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('../core/userrights.class.inc.php');
  342. $oP->log("Info - MetaModel::Startup from file '$sConfigFileName' (AllowMissingDB = $bAllowMissingDatabase)");
  343. MetaModel::Startup($sConfigFileName, $bAllowMissingDatabase);
  344. }
  345. /**
  346. * Helper function to create the database structure
  347. * @return boolean true on success, false otherwise
  348. */
  349. function CreateDatabaseStructure(SetupWebPage $oP, Config $oConfig, $sDBName, $sDBPrefix)
  350. {
  351. InitDataModel($oP, TMP_CONFIG_FILE, true); // Allow the DB to NOT exist since we're about to create it !
  352. $oP->log('Info - CreateDatabaseStructure');
  353. if (strlen($sDBPrefix) > 0)
  354. {
  355. $oP->info("Creating the structure in '$sDBName' (table names prefixed by '$sDBPrefix').");
  356. }
  357. else
  358. {
  359. $oP->info("Creating the structure in '$sDBName'.");
  360. }
  361. //MetaModel::CheckDefinitions();
  362. if (!MetaModel::DBExists(/* bMustBeComplete */ false))
  363. {
  364. MetaModel::DBCreate();
  365. $oP->ok("Database structure successfully created.");
  366. }
  367. else
  368. {
  369. if (strlen($sDBPrefix) > 0)
  370. {
  371. $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.");
  372. }
  373. else
  374. {
  375. $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.");
  376. }
  377. return false;
  378. }
  379. return true;
  380. }
  381. /**
  382. * Helper function to create and administrator account for iTop
  383. * @return boolean true on success, false otherwise
  384. */
  385. function CreateAdminAccount(SetupWebPage $oP, Config $oConfig, $sAdminUser, $sAdminPwd, $sLanguage)
  386. {
  387. $oP->log('Info - CreateAdminAccount');
  388. InitDataModel($oP, TMP_CONFIG_FILE, true); // allow missing DB
  389. if (UserRights::CreateAdministrator($sAdminUser, $sAdminPwd, $sLanguage))
  390. {
  391. $oP->ok("Administrator account '$sAdminUser' created.");
  392. return true;
  393. }
  394. else
  395. {
  396. $oP->error("Failed to create the administrator account '$sAdminUser'.");
  397. return false;
  398. }
  399. }
  400. function ListModuleFiles($sDirectory, SetupWebPage $oP)
  401. {
  402. //echo "<p>$sDirectory</p>\n";
  403. if ($hDir = opendir($sDirectory))
  404. {
  405. // This is the correct way to loop over the directory. (according to the documentation)
  406. while (($sFile = readdir($hDir)) !== false)
  407. {
  408. $aMatches = array();
  409. if (is_dir($sDirectory.'/'.$sFile))
  410. {
  411. if (($sFile != '.') && ($sFile != '..') && ($sFile != '.svn'))
  412. {
  413. ListModuleFiles($sDirectory.'/'.$sFile, $oP);
  414. }
  415. }
  416. else if (preg_match('/^module\.(.*).php$/i', $sFile, $aMatches))
  417. {
  418. try
  419. {
  420. //echo "<p>Loading: $sDirectory/$sFile...</p>\n";
  421. require_once($sDirectory.'/'.$sFile);
  422. //echo "<p>Done.</p>\n";
  423. }
  424. catch(Exception $e)
  425. {
  426. // Continue...
  427. }
  428. }
  429. }
  430. closedir($hDir);
  431. }
  432. else
  433. {
  434. $oP->error("Data directory (".$sDirectory.") not found or not readable.");
  435. }
  436. }
  437. /**
  438. * Scans the ./data directory for XML files and output them as a Javascript array
  439. */
  440. function PopulateDataFilesList(SetupWebPage $oP, $aParamValues)
  441. {
  442. $oP->add("<script type=\"text/javascript\">\n");
  443. $oP->add("function PopulateDataFilesList()\n");
  444. $oP->add("{\n");
  445. $oP->add("if (aFilesToLoad.length > 0) return;"); // Populate the list only once...
  446. $aAvailableModules = GetAvailableModules($oP);
  447. $aStructureDataFiles = array();
  448. $aSampleDataFiles = array();
  449. foreach($aParamValues['module'] as $sModuleId)
  450. {
  451. $aModuleStruct = $aAvailableModules[$sModuleId]['data.struct'];
  452. $aModuleSamples = $aAvailableModules[$sModuleId]['data.sample'];
  453. $aStructureDataFiles = array_merge($aStructureDataFiles, $aModuleStruct);
  454. $aSampleDataFiles = array_merge($aSampleDataFiles, $aModuleSamples);
  455. }
  456. // Structure data
  457. //
  458. foreach($aStructureDataFiles as $sFile)
  459. {
  460. // Under Windows, it is a must to escape backslashes (not an issue until a folder name starts with t or n, etc...)
  461. $sFile = str_replace('\\', '\\\\', $sFile);
  462. $oP->add("aFilesToLoad[aFilesToLoad.length] = '$sFile';\n");
  463. }
  464. // Sample data - loaded IIF wished by the user
  465. //
  466. $oP->add("if (($(\"#sample_data:checked\").length == 1))");
  467. $oP->add("{");
  468. foreach($aSampleDataFiles as $sFile)
  469. {
  470. // Under Windows, it is a must to escape backslashes (not an issue until a folder name starts with t or n, etc...)
  471. $sFile = str_replace('\\', '\\\\', $sFile);
  472. $oP->add("aFilesToLoad[aFilesToLoad.length] = '$sFile';\n");
  473. }
  474. $oP->add("}\n");
  475. $oP->add("}\n");
  476. $oP->add("</script>\n");
  477. }
  478. /**
  479. * Add some parameters as hidden inputs into a form
  480. * @param SetupWebpage $oP The page to insert the form elements into
  481. * @param Hash $aParamValues The pairs name/value to be stored in the form
  482. * @param Array $aExcludeParams A list of parameters to exclude from the previous hash
  483. */
  484. function AddParamsToForm(SetupWebpage $oP, $aParamValues, $aExcludeParams = array())
  485. {
  486. foreach($aParamValues as $sName => $value)
  487. {
  488. if(!in_array($sName, $aExcludeParams))
  489. {
  490. if (is_array($value))
  491. {
  492. foreach($value as $sKey => $sItem)
  493. {
  494. $oP->add('<input type="hidden" name="'.$sName.'['.$sKey.']'.'" value="'.$sItem.'">');
  495. }
  496. }
  497. else
  498. {
  499. $oP->add('<input type="hidden" name="'.$sName.'" value="'.$value.'">');
  500. }
  501. }
  502. }
  503. }
  504. /**
  505. * Search (on the disk) for all defined iTop modules, load them and returns the list (as an array)
  506. * of the possible iTop modules to install
  507. * @param none
  508. * @return Hash A big array moduleID => ModuleData
  509. */
  510. function GetAvailableModules(SetupWebpage $oP)
  511. {
  512. clearstatcache();
  513. ListModuleFiles('../modules/', $oP);
  514. return $oP->GetModules();
  515. }
  516. /**
  517. * Build the config file from the parameters (especially the selected modules)
  518. */
  519. function BuildConfig(SetupWebpage $oP, Config &$oConfig, $aParamValues)
  520. {
  521. $aAvailableModules = GetAvailableModules($oP);
  522. // Initialize the arrays below with default values for the application...
  523. $aAddOns = $oConfig->GetAddOns();
  524. $aAppModules = $oConfig->GetAppModules();
  525. $aDataModels = $oConfig->GetDataModels();
  526. $sDictionaries = $oConfig->GetDictionaries();
  527. // Merge the values with the ones provided by the modules
  528. // Make sure when don't load the same file twice...
  529. foreach($aParamValues['module'] as $sModuleId)
  530. {
  531. $oP->log('Installed iTop module: '. $sModuleId);
  532. $aDataModels = array_unique(array_merge($aDataModels, $aAvailableModules[$sModuleId]['datamodel']));
  533. $sDictionaries = array_unique(array_merge($sDictionaries, $aAvailableModules[$sModuleId]['dictionary']));
  534. }
  535. $oConfig->SetAddOns($aAddOns);
  536. $oConfig->SetAppModules($aAppModules);
  537. $oConfig->SetDataModels($aDataModels);
  538. $oConfig->SetDictionaries($sDictionaries);
  539. }
  540. /////////////////////////////////////////////////////////////////////////////////////////////////////////////
  541. // Handling of the different steps of the setup wizard
  542. /////////////////////////////////////////////////////////////////////////////////////////////////////////////
  543. /**
  544. * Displays the welcome screen and check some basic prerequisites
  545. */
  546. function WelcomeAndCheckPrerequisites(SetupWebPage $oP, $aParamValues, $iCurrentStep)
  547. {
  548. $sNextOperation = 'step'.($iCurrentStep+1);
  549. $oP->add("<h1>iTop configuration wizard</h1>\n");
  550. $sVersionStringShort = GetITopVersion(true);
  551. $sVersionStringLong = GetITopVersion(false);
  552. $oP->set_title('Welcome to '.$sVersionStringShort);
  553. $oP->log($sVersionStringLong);
  554. $oP->add("<h2>Checking prerequisites</h2>\n");
  555. if (CheckPHPVersion($oP))
  556. {
  557. $oP->add("<h2 class=\"next\">Next: Licence agreement</h2>\n");
  558. $oP->add("<form id=\"theForm\" method=\"post\" onSubmit=\"return DoSubmit('', 0)\">\n");
  559. $oP->add("<input type=\"hidden\" name=\"operation\" value=\"$sNextOperation\">\n");
  560. AddParamsToForm($oP, $aParamValues);
  561. $oP->add("<table style=\"width:100%\"><tr>\n");
  562. $oP->add("<td style=\"text-align:right;\"><button type=\"submit\" type=\"submit\">Next >></button></td>\n");
  563. $oP->add("</tr></table>\n");
  564. $oP->add("</form>\n");
  565. }
  566. }
  567. function LicenceAcknowledgement($oP, $aParamValues, $iCurrentStep)
  568. {
  569. $sNextOperation = 'step'.($iCurrentStep+1);
  570. $oP->set_title('License Agreement');
  571. $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>');
  572. $oP->add("<iframe style=\"width: 100%; height: 350px; overflow-y:auto; font-size:0.8em;\" src=\"./licence.html\">Next: Database server selection</iframe>\n");
  573. $oP->add("<form id=\"theForm\" method=\"post\">\n");
  574. $oP->add("<input type=\"hidden\" name=\"operation\" value=\"$sNextOperation\">\n");
  575. AddParamsToForm($oP, $aParamValues, array('licence_ok'));
  576. $sChecked = $aParamValues['licence_ok'] == 1 ? 'checked' : '';
  577. $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");
  578. $oP->add("<h2 class=\"next\">Next: Database server selection</h2>\n");
  579. $oP->add("<table style=\"width:100%\"><tr>\n");
  580. $oP->add("<td style=\"text-align:left;\"><button type=\"button\" onClick=\"return DoGoBack($iCurrentStep)\"><< Back</button></td>\n");
  581. $oP->add("<td style=\"text-align:right;\"><button type=\"submit\" onClick=\"return DoSubmit('', $iCurrentStep)\">Next >></button></td>\n");
  582. $oP->add("</tr></table>\n");
  583. $oP->add("</form>\n");
  584. }
  585. /**
  586. * Display the form for the first step of the configuration wizard
  587. * which consists in the database server selection
  588. */
  589. function DatabaseServerSelection(SetupWebPage $oP, $aParamValues, $iCurrentStep)
  590. {
  591. $sNextOperation = 'step'.($iCurrentStep+1);
  592. $oP->add("<form id=\"theForm\" method=\"post\">\n");
  593. $oP->add("<input type=\"hidden\" name=\"operation\" value=\"$sNextOperation\">\n");
  594. AddParamsToForm($oP, $aParamValues, array('db_server', 'db_user', 'db_pwd'));
  595. if ($aParamValues['licence_ok'] == 1)
  596. {
  597. $sRedStar = '<span class="hilite">*</span>';
  598. $oP->set_title("Configuration of the database connection\n");
  599. $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");
  600. // Form goes here
  601. $oP->add("<fieldset><legend>Database connection</legend>\n");
  602. $aForm = array();
  603. $aForm[] = array('label' => "Server name$sRedStar:", 'input' => "<input id=\"db_server\" type=\"text\" name=\"db_server\" value=\"{$aParamValues['db_server']}\">",
  604. 'help' => 'E.g. "localhost", "dbserver.mycompany.com" or "192.142.10.23"');
  605. $aForm[] = array('label' => "User name$sRedStar:", 'input' => "<input id=\"db_user\" type=\"text\" name=\"db_user\" value=\"{$aParamValues['db_user']}\">",
  606. 'help' => 'The account must have the following privileges: SELECT, INSERT, UPDATE, DELETE, CREATE, ALTER');
  607. $aForm[] = array('label' => 'Password:', 'input' => "<input id=\"db_pwd\" type=\"password\" name=\"db_pwd\" value=\"{$aParamValues['db_pwd']}\">");
  608. $oP->form($aForm);
  609. $oP->add("</fieldset>\n");
  610. $oP->add("<h2 class=\"next\">Next: Database Instance Selection</h2>\n");
  611. $oP->add("<table style=\"width:100%\"><tr>\n");
  612. $oP->add("<td style=\"text-align:left;\"><button type=\"button\" onClick=\"return DoGoBack($iCurrentStep)\"><< Back</button></td>\n");
  613. $oP->add("<td style=\"text-align:right;\"><button type=\"submit\" onClick=\"return DoSubmit('Connecting to the database...', $iCurrentStep);\">Next >></button></td>\n");
  614. $oP->add("</tr></table>\n");
  615. }
  616. else
  617. {
  618. $oP->add("<button type=\"button\" onClick=\"return DoGoBack($iCurrentStep);\"><< Back</button>\n");
  619. }
  620. $oP->add("</form>\n");
  621. }
  622. /**
  623. * Display the form for the second step of the configuration wizard
  624. * which consists in
  625. * 1) Validating the parameters by connecting to the database server
  626. * 2) Prompting to select an existing database or to create a new one
  627. */
  628. function DatabaseInstanceSelection(SetupWebPage $oP, $aParamValues, $iCurrentStep, $oConfig)
  629. {
  630. $sNextOperation = 'step'.($iCurrentStep+1);
  631. $oP->set_title("Database Instance Selection\n");
  632. $oP->add("<form id=\"theForm\" method=\"post\">\n");
  633. $oP->add("<input type=\"hidden\" name=\"operation\" value=\"$sNextOperation\">\n");
  634. AddParamsToForm($oP, $aParamValues, array('db_name', 'db_prefix', 'new_db_name'));
  635. $sDBServer = $aParamValues['db_server'];
  636. $sDBUser = $aParamValues['db_user'];
  637. $sDBPwd = $aParamValues['db_pwd'];
  638. $aDatabases = CheckServerConnection($oP, $sDBServer, $sDBUser, $sDBPwd);
  639. if ($aDatabases === false)
  640. {
  641. // Connection failed, invalid credentials ? Go back
  642. $oP->add("<button type=\"button\" onClick=\"return DoGoBack($iCurrentStep);\"><< Back</button>\n");
  643. }
  644. else
  645. {
  646. // Connection is Ok, save it and continue the setup wizard
  647. $oConfig->SetDBHost($sDBServer);
  648. $oConfig->SetDBUser($sDBUser);
  649. $oConfig->SetDBPwd($sDBPwd);
  650. $oConfig->WriteToFile();
  651. $oP->add("<fieldset><legend>Select the database instance to use for iTop<span class=\"hilite\">*</span></legend>\n");
  652. $aForm = array();
  653. $bExistingChecked = false;
  654. if (is_array($aDatabases))
  655. {
  656. foreach($aDatabases as $sDBName)
  657. {
  658. $sChecked = '';
  659. if ($aParamValues['db_name'] == $sDBName)
  660. {
  661. $sChecked = 'checked';
  662. $bExistingChecked = true;
  663. }
  664. $aForm[] = array('label' => "<input id=\"db_$sDBName\" type=\"radio\" name=\"db_name\" value=\"$sDBName\" $sChecked/><label for=\"db_$sDBName\"> $sDBName</label>");
  665. }
  666. }
  667. else
  668. {
  669. $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\"/>");
  670. $oP->add_ready_script("$('#current_db_name').click( function() { $('#current_db').attr('checked', true); });");
  671. }
  672. $sChecked = '';
  673. $sDBName = '';
  674. // If the 'Create Database' option was checked... and the database still does not exist
  675. if (!$bExistingChecked && !empty($aParamValues['new_db_name']))
  676. {
  677. $sChecked = 'checked';
  678. $sDBName = $aParamValues['new_db_name'];
  679. }
  680. $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\"/>");
  681. $oP->form($aForm);
  682. $oP->add_ready_script("$('#new_db_name').click( function() { $('#new_db').attr('checked', true); })");
  683. $oP->add("</fieldset>\n");
  684. $aForm = array();
  685. $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\"/>");
  686. $oP->form($aForm);
  687. $oP->add("<h2 class=\"next\">Next: iTop Modules Selection</h2>\n");
  688. $oP->add("<table style=\"width:100%\"><tr>\n");
  689. $oP->add("<td style=\"text-align:left;\"><button type=\"button\" onClick=\"return DoGoBack($iCurrentStep)\"><< Back</button></td>\n");
  690. $oP->add("<td style=\"text-align:right;\"><button type=\"submit\" onClick=\"return DoSubmit('', $iCurrentStep);\">Next >></button></td>\n");
  691. $oP->add("</tr></table>\n");
  692. }
  693. $oP->add("</form>\n");
  694. }
  695. /**
  696. * Display the form to select the iTop modules to be installed
  697. */
  698. function ModulesSelection(SetupWebPage $oP, $aParamValues, $iCurrentStep, $oConfig)
  699. {
  700. $sNextOperation = 'step'.($iCurrentStep+1);
  701. $sPrevOperation = 'step'.($iCurrentStep-1);
  702. $sDBName = $aParamValues['db_name'];
  703. if ($sDBName == '')
  704. {
  705. $sDBName = $aParamValues['new_db_name'];
  706. }
  707. $sDBPrefix = $aParamValues['db_prefix'];
  708. $oConfig->SetDBName($sDBName);
  709. $oConfig->SetDBSubname($sDBPrefix);
  710. $oConfig->WriteToFile(TMP_CONFIG_FILE);
  711. $oP->add("<form id=\"theForm\" method=\"post\">\n");
  712. $oP->add("<input type=\"hidden\" name=\"operation\" value=\"$sNextOperation\">\n");
  713. AddParamsToForm($oP, $aParamValues, array('module'));
  714. $sRedStar = '<span class="hilite">*</span>';
  715. $oP->set_title("Selection of the iTop Modules\n");
  716. $oP->add("<h2>Customize your iTop installation to fit your needs</h2>\n");
  717. $aAvailableModules = GetAvailableModules($oP);
  718. // Form goes here
  719. $oP->add("<fieldset><legend>Select the iTop modules you want to install:</legend>\n");
  720. $oP->add("<div style=\"border: 0;width:100%; height: 350px; overflow-y:auto;\">");
  721. $sRedStar = '<span class="hilite">*</span>';
  722. $index = 0;
  723. $aSelectedModules = $aParamValues['module'];
  724. if ($aSelectedModules == '')
  725. {
  726. // Make sure it gets initialized as an array
  727. $aSelectedModules = array();
  728. }
  729. foreach($aAvailableModules as $sModuleId => $aModule)
  730. {
  731. $sModuleLabel = $aModule['label'];
  732. $sModuleHelp = $aModule['doc.more_information'];
  733. $sClass = ($aModule['mandatory']) ? 'class="read-only"' : '';
  734. $sChecked = ($aModule['mandatory'] || in_array($sModuleId, $aSelectedModules) ) ? 'checked' : '';
  735. $sMoreInfo = (!empty($aModule['doc.more_information'])) ? "<a href=\"{$aModule['doc.more_information']}\" target=\"_blank\">more info</a>": '';
  736. if ($aModule['visible'])
  737. {
  738. $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");
  739. $index++;
  740. }
  741. else
  742. {
  743. // For now hidden modules are always on !
  744. $oP->add("<input type=\"hidden\" id=\"module[$index]\" name=\"module[$index]\" value=\"$sModuleId\">\n");
  745. }
  746. }
  747. $oP->add("</div>");
  748. $oP->add("</fieldset>\n");
  749. $oP->add("<h2 class=\"next\">Next: Administrator Account Creation</h2>\n");
  750. $oP->add("<table style=\"width:100%\"><tr>\n");
  751. $oP->add("<td style=\"text-align:left;\"><button type=\"button\" onClick=\"return DoGoBack($iCurrentStep)\"><< Back</button></td>\n");
  752. $oP->add("<td style=\"text-align:right;\"><button type=\"submit\" onClick=\"return DoSubmit('Creating the database structure...', $iCurrentStep);\">Next >></button></td>\n");
  753. $oP->add("</tr></table>\n");
  754. $oP->add("</form>\n");
  755. $oP->add_ready_script("$('.read-only').click( function() { $(this).attr('checked','checked'); } );");
  756. }
  757. /**
  758. * Display the form for the third step of the configuration wizard
  759. * which consists in
  760. * 1) Validating the parameters by connecting to the database server & selecting the database
  761. * 2) Creating the database structure
  762. * 3) Prompting for the admin account to be created
  763. */
  764. function AdminAccountDefinition(SetupWebPage $oP, $aParamValues, $iCurrentStep, Config $oConfig)
  765. {
  766. $sNextOperation = 'step'.($iCurrentStep+1);
  767. $oP->set_title("Configuration of the admin account");
  768. $oP->add("<h2>Creation of the database structure</h2>");
  769. $oP->add("<form id=\"theForm\" method=\"post\">\n");
  770. $oP->add("<input type=\"hidden\" name=\"operation\" value=\"$sNextOperation\">\n");
  771. AddParamsToForm($oP, $aParamValues, array('auth_user', 'auth_pwd', 'language'));
  772. $sDBName = $aParamValues['db_name'];
  773. if ($sDBName == '')
  774. {
  775. $sDBName = $aParamValues['new_db_name'];
  776. }
  777. $sDBPrefix = $aParamValues['db_prefix'];
  778. $oConfig->SetDBName($sDBName);
  779. $oConfig->SetDBSubname($sDBPrefix);
  780. BuildConfig($oP, $oConfig, $aParamValues); // Load all the includes based on the modules selected
  781. $oConfig->WriteToFile(TMP_CONFIG_FILE);
  782. if (CreateDatabaseStructure($oP, $oConfig, $sDBName, $sDBPrefix))
  783. {
  784. $sRedStar = "<span class=\"hilite\">*</span>";
  785. $oP->add("<h2>Default language for the application:</h2>\n");
  786. // Possible languages (depends on the dictionaries loaded in the config)
  787. $aForm = array();
  788. $aAvailableLanguages = Dict::GetLanguages();
  789. $sLanguages = '';
  790. $sDefaultCode = $oConfig->GetDefaultLanguage();
  791. foreach($aAvailableLanguages as $sLangCode => $aInfo)
  792. {
  793. $sSelected = ($sLangCode == $sDefaultCode ) ? 'selected ' : '';
  794. $sLanguages.="<option value=\"{$sLangCode}\">{$aInfo['description']} ({$aInfo['localized_description']})</option>";
  795. }
  796. $aForm[] = array('label' => "Default Language$sRedStar:", 'input' => "<select id=\"language\" name=\"language\">$sLanguages</option>");
  797. $oP->form($aForm);
  798. $oP->add("<h2>Definition of the administrator account</h2>\n");
  799. // Database created, continue with admin creation
  800. $oP->add("<fieldset><legend>Administrator account</legend>\n");
  801. $aForm = array();
  802. $aForm[] = array('label' => "Login$sRedStar:", 'input' => "<input id=\"auth_user\" type=\"text\" name=\"auth_user\" value=\"{$aParamValues['auth_user']}\">");
  803. $aForm[] = array('label' => "Password$sRedStar:", 'input' => "<input id=\"auth_pwd\" type=\"password\" name=\"auth_pwd\" value=\"{$aParamValues['auth_pwd']}\">");
  804. $aForm[] = array('label' => "Retype password$sRedStar:", 'input' => "<input id=\"auth_pwd2\" type=\"password\" name=\"auth_pwd2\" value=\"{$aParamValues['auth_pwd']}\">");
  805. $oP->form($aForm);
  806. $oP->add("</fieldset>\n");
  807. $oP->add("<h2 class=\"next\">Next: Administrator Account Creation</h2>\n");
  808. $oP->add("<table style=\"width:100%\"><tr>\n");
  809. $oP->add("<td style=\"text-align:left;\"><button type=\"button\" onClick=\"return DoGoBack($iCurrentStep)\"><< Back</button></td>\n");
  810. $oP->add("<td style=\"text-align:right;\"><button type=\"submit\" onClick=\"return DoSubmit('Creating the admin account and profiles...', $iCurrentStep);\">Next >></button></td>\n");
  811. $oP->add("</tr></table>\n");
  812. }
  813. else
  814. {
  815. $oP->add("<button type=\"button\" onClick=\"return DoGoBack($iCurrentStep)\"><< Back</button>\n");
  816. }
  817. // Form goes here
  818. $oP->add("</form>\n");
  819. }
  820. /**
  821. * Display the form for the fourth step of the configuration wizard
  822. * which consists in
  823. * 1) Creating the admin user account
  824. * 2) Prompting to load some sample data
  825. */
  826. function SampleDataSelection(SetupWebPage $oP, $aParamValues, $iCurrentStep, Config $oConfig)
  827. {
  828. $sNextOperation = 'step'.($iCurrentStep+1);
  829. $oP->set_title("Application Initialization");
  830. $sAdminUser = $aParamValues['auth_user'];
  831. $sAdminPwd = $aParamValues['auth_pwd'];
  832. $sLanguage = $aParamValues['language'];
  833. $oConfig->SetDefaultLanguage($aParamValues['language']);
  834. $oConfig->WriteToFile(TMP_CONFIG_FILE);
  835. $oP->add("<form id=\"theForm\" method=\"post\"\">\n");
  836. $oP->add("<input type=\"hidden\" name=\"operation\" value=\"$sNextOperation\">\n");
  837. AddParamsToForm($oP, $aParamValues, array('sample_data'));
  838. if (CreateAdminAccount($oP, $oConfig, $sAdminUser, $sAdminPwd, $sLanguage) && UserRights::Setup())
  839. {
  840. $oP->add("<h2>Loading of sample data</h2>\n");
  841. $oP->p("<fieldset><legend> Do you want to load sample data into the database ? </legend>\n");
  842. $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");
  843. $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");
  844. $oP->p("</fieldset>\n");
  845. $oP->add("<h2 class=\"next\">Next: Application Initialization</h2>\n");
  846. $oP->add("<table style=\"width:100%\"><tr>\n");
  847. $oP->add("<td style=\"text-align:left;\"><button type=\"button\" onClick=\"return DoGoBack($iCurrentStep)\"><< Back</button></td>\n");
  848. $oP->add("<td style=\"text-align:right;\"><button type=\"submit\" onClick=\"return DoSubmit('Finalizing configuration and loading data...', $iCurrentStep)\">Next >></button></td>\n");
  849. $oP->add("</tr></table>\n");
  850. }
  851. else
  852. {
  853. // Creation failed
  854. $oP->error("Internal error: Failed to create the admin account or to setup the user rights");
  855. $oP->add("<button type=\"button\" onClick=\"return DoGoBack($iCurrentStep)\"><< Back</button>\n");
  856. }
  857. // End of visible form
  858. $oP->add("</form>\n");
  859. // Hidden form submitted when moving on to the next page, once all the data files
  860. // have been processed
  861. $oP->add("<form id=\"GoToNextStep\" method=\"post\">\n");
  862. AddParamsToForm($oP, $aParamValues, array('sample_data'));
  863. $oP->add("<input type=\"hidden\" name=\"operation\" value=\"$sNextOperation\">\n");
  864. $oP->add("</form>\n");
  865. $oP->add("<div id=\"log\" style=\"color:#F00;\"></div>\n");
  866. $oP->add_linked_script('./jquery.progression.js');
  867. PopulateDataFilesList($oP, $aParamValues);
  868. }
  869. /**
  870. * Display the form for the fifth (and final) step of the configuration wizard
  871. * which consists in
  872. * 1) Creating the final configuration file
  873. * 2) Prompting the user to make the file read-only
  874. */
  875. function SetupFinished(SetupWebPage $oP, $aParamValues, $iCurrentStep, Config $oConfig)
  876. {
  877. $sAuthUser = $aParamValues['auth_user'];
  878. $sAuthPwd = $aParamValues['auth_pwd'];
  879. try
  880. {
  881. session_start();
  882. // Write the final configuration file
  883. $oConfig->WriteToFile(FINAL_CONFIG_FILE);
  884. // Start the application
  885. InitDataModel($oP, FINAL_CONFIG_FILE, false); // DO NOT allow missing DB
  886. if (UserRights::Login($sAuthUser, $sAuthPwd))
  887. {
  888. $_SESSION['auth_user'] = $sAuthUser;
  889. $_SESSION['auth_pwd'] = $sAuthPwd;
  890. // remove the tmp config file
  891. @unlink(TMP_CONFIG_FILE);
  892. // try to make the final config file read-only
  893. @chmod(FINAL_CONFIG_FILE, 0440); // Read-only for owner and group, nothing for others
  894. $oP->set_title("Configuration completed");
  895. $oP->add("<form id=\"theForm\" method=\"get\" action=\"../index.php\">\n");
  896. // Check if there are some manual steps required:
  897. $aAvailableModules = GetAvailableModules($oP);
  898. $aManualSteps = array();
  899. foreach($aParamValues['module'] as $sModuleId)
  900. {
  901. if (!empty($aAvailableModules[$sModuleId]['doc.manual_setup']))
  902. {
  903. $aManualSteps[$aAvailableModules[$sModuleId]['label']] = $aAvailableModules[$sModuleId]['doc.manual_setup'];
  904. }
  905. }
  906. if (count($aManualSteps) > 0)
  907. {
  908. $oP->add("<h2>Manual operations required</h2>");
  909. $oP->p("In order to complete the installation, the following manual operations are required:");
  910. foreach($aManualSteps as $sModuleLabel => $sUrl)
  911. {
  912. $oP->p("<a href=\"$sUrl\" target=\"_blank\">Manual instructions for $sModuleLabel</a>");
  913. }
  914. }
  915. else
  916. {
  917. $oP->add("<h2>Congratulations for installing iTop</h2>");
  918. $oP->ok("The initialization completed successfully.");
  919. }
  920. // Form goes here.. No back button since the job is done !
  921. $oP->add("<h1>Let us know what you think about iTop</h1>");
  922. $oP->add('<table style="width:100%;border:0;padding:0;"><tr><td style="width:100px;vertical-align:middle;background:#f6f6f1;text-align:center">');
  923. $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>');
  924. $oP->add('<td style="padding-left: 10px;font-size:10pt">');
  925. $oP->add("Combodo built iTop because Combodo believes that modern ITIL tools should be at the center of any IT department.");
  926. $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>");
  927. $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...)");
  928. $oP->p("Check out the <a href=\"http://www.combodo.com/itopsupport\">support options</a> available for iTop.");
  929. $oP->add('</td></tr></table>');
  930. $oP->add("<p style=\"text-align:center;width:100%\"><button type=\"submit\">Enter iTop</button></p>\n");
  931. $oP->add("</form>\n");
  932. }
  933. else
  934. {
  935. $oP->add("<h1>iTop configuration wizard</h1>\n");
  936. $oP->add("<h2>Step 5: Configuration completed</h2>\n");
  937. @unlink(FINAL_CONFIG_FILE); // remove the aborted config
  938. $oP->error("Error: Failed to login for user: '$sAuthUser'\n");
  939. $oP->add("<form id=\"theForm\" method=\"post\">\n");
  940. $oP->add("<button type=\"button\" onClick=\"return DoGoBack($iCurrentStep);\"><< Back</button>\n");
  941. AddParamsToForm($oP, $aParamValues);
  942. $oP->add("<input type=\"hidden\" name=\"operation\" value=\"step0\">\n");
  943. $oP->add("</form>\n");
  944. }
  945. }
  946. catch(Exception $e)
  947. {
  948. $oP->error("Error: unable to create the configuration file.");
  949. $oP->p($e->getHtmlDesc());
  950. $oP->p("Did you forget to remove the previous (read-only) configuration file ?");
  951. $oP->add("<form id=\"theForm\" method=\"post\">\n");
  952. $oP->add("<input type=\"hidden\" name=\"operation\" value=\"step0\">\n");
  953. AddParamsToForm($oP, $aParamValues);
  954. $oP->add("<button type=\"button\" onClick=\"return DoGoBack($iCurrentStep);\"><< Back</button>\n");
  955. $oP->add("</form>\n");
  956. }
  957. }
  958. ///////////////////////////////////////////////////////////////////////////////////////////////////
  959. // Main program
  960. ///////////////////////////////////////////////////////////////////////////////////////////////////
  961. clearstatcache(); // Make sure we know what we are doing !
  962. if (file_exists(FINAL_CONFIG_FILE))
  963. {
  964. // The configuration file already exists
  965. if (is_writable(FINAL_CONFIG_FILE))
  966. {
  967. $oP->warning("<b>Warning:</b> a configuration file '".FINAL_CONFIG_FILE."' already exists, and will be overwritten.");
  968. }
  969. else
  970. {
  971. $oP->add("<h1>iTop configuration wizard</h1>\n");
  972. $oP->add("<h2>Fatal error</h2>\n");
  973. $oP->error("<b>Error:</b> the configuration file '".FINAL_CONFIG_FILE."' already exists and cannot be overwritten.");
  974. $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.");
  975. $oP->output();
  976. exit;
  977. }
  978. }
  979. else
  980. {
  981. // No configuration file yet
  982. // Check that the wizard can write into the root dir to create the configuration file
  983. if (!is_writable(dirname(FINAL_CONFIG_FILE)))
  984. {
  985. $oP->add("<h1>iTop configuration wizard</h1>\n");
  986. $oP->add("<h2>Fatal error</h2>\n");
  987. $oP->error("<b>Error:</b> the directory where to store the configuration file is not writable.");
  988. $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.");
  989. $oP->output();
  990. exit;
  991. }
  992. }
  993. try
  994. {
  995. $oConfig = new Config(TMP_CONFIG_FILE);
  996. }
  997. catch(Exception $e)
  998. {
  999. // We'll end here when the tmp config file does not exist. It's normal
  1000. $oConfig = new Config(TMP_CONFIG_FILE, false /* Don't try to load it */);
  1001. }
  1002. try
  1003. {
  1004. $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');
  1005. foreach($aParams as $sName)
  1006. {
  1007. $aParamValues[$sName] = utils::ReadParam($sName, '');
  1008. }
  1009. switch($sOperation)
  1010. {
  1011. case 'step0':
  1012. $oP->no_cache();
  1013. $oP->log("Info - ========= Wizard step 0 ========");
  1014. WelcomeAndCheckPrerequisites($oP, $aParamValues, 0);
  1015. break;
  1016. case 'step1':
  1017. $oP->no_cache();
  1018. $oP->log("Info - ========= Wizard step 1 ========");
  1019. LicenceAcknowledgement($oP, $aParamValues, 1);
  1020. break;
  1021. case 'step2':
  1022. $oP->log("Info - ========= Wizard step 2 ========");
  1023. DatabaseServerSelection($oP, $aParamValues, 2);
  1024. break;
  1025. case 'step3':
  1026. $oP->no_cache();
  1027. $oP->log("Info - ========= Wizard step 3 ========");
  1028. DatabaseInstanceSelection($oP, $aParamValues, 3, $oConfig);
  1029. break;
  1030. case 'step4':
  1031. $oP->no_cache();
  1032. $oP->log("Info - ========= Wizard step 4 ========");
  1033. ModulesSelection($oP, $aParamValues, 4, $oConfig);
  1034. break;
  1035. case 'step5':
  1036. $oP->no_cache();
  1037. $oP->log("Info - ========= Wizard step 5 ========");
  1038. AdminAccountDefinition($oP, $aParamValues, 5, $oConfig);
  1039. break;
  1040. case 'step6':
  1041. $oP->no_cache();
  1042. $oP->log("Info - ========= Wizard step 6 ========");
  1043. SampleDataSelection($oP, $aParamValues, 6, $oConfig);
  1044. break;
  1045. case 'step7':
  1046. $oP->no_cache();
  1047. $oP->log("Info - ========= Wizard step 7 ========");
  1048. SetupFinished($oP, $aParamValues, 7, $oConfig);
  1049. break;
  1050. default:
  1051. $oP->error("Error: unsupported operation '$sOperation'");
  1052. }
  1053. }
  1054. catch(Exception $e)
  1055. {
  1056. $oP->error("Error: '".$e->getMessage()."'");
  1057. $oP->add("<button type=\"button\" onClick=\"window.history.back();\"><< Back</button>\n");
  1058. }
  1059. catch(CoreException $e)
  1060. {
  1061. $oP->error("Error: '".$e->getHtmlDesc()."'");
  1062. $oP->add("<button type=\"button\" onClick=\"window.history.back();\"><< Back</button>\n");
  1063. }
  1064. $oP->output();
  1065. ?>