wizardsteps.class.inc.php 69 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046
  1. <?php
  2. // Copyright (C) 2012 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. * All the steps of the iTop installation wizard
  18. * @author Erwan Taloc <erwan.taloc@combodo.com>
  19. * @author Romain Quetiez <romain.quetiez@combodo.com>
  20. * @author Denis Flaven <denis.flaven@combodo.com>
  21. * @license http://www.opensource.org/licenses/gpl-3.0.html GPL
  22. */
  23. require_once(APPROOT.'setup/setuputils.class.inc.php');
  24. require_once(APPROOT.'setup/parameters.class.inc.php');
  25. require_once(APPROOT.'setup/applicationinstaller.class.inc.php');
  26. require_once(APPROOT.'setup/parameters.class.inc.php');
  27. /**
  28. * First step of the iTop Installation Wizard: Welcome screen
  29. */
  30. class WizStepWelcome extends WizardStep
  31. {
  32. protected $bCanMoveForward;
  33. public function GetTitle()
  34. {
  35. return 'Welcome to '.ITOP_APPLICATION.' version '.ITOP_VERSION;
  36. }
  37. /**
  38. * Returns the label for the " Next >> " button
  39. * @return string The label for the button
  40. */
  41. public function GetNextButtonLabel()
  42. {
  43. return ' Continue >> ';
  44. }
  45. public function GetPossibleSteps()
  46. {
  47. return array('WizStepInstallOrUpgrade');
  48. }
  49. public function ProcessParams($bMoveForward = true)
  50. {
  51. return array('class' => 'WizStepInstallOrUpgrade', 'state' => '');
  52. }
  53. public function Display(WebPage $oPage)
  54. {
  55. // Store the misc_options for the future...
  56. $aMiscOptions = utils::ReadParam('option', array(), false, 'raw_data');
  57. $sMiscOptions = $this->oWizard->GetParameter('misc_options', json_encode($aMiscOptions));
  58. $this->oWizard->SetParameter('misc_options', $sMiscOptions);
  59. $oPage->add('<h1>iTop Installation Wizard</h1>');
  60. $aResults = SetupUtils::CheckPHPVersion($oPage);
  61. $this->bCanMoveForward = true;
  62. $aInfo = array();
  63. $aWarnings = array();
  64. $aErrors = array();
  65. foreach($aResults as $oCheckResult)
  66. {
  67. switch($oCheckResult->iSeverity)
  68. {
  69. case CheckResult::ERROR:
  70. $aErrors[] = $oCheckResult->sLabel;
  71. $this->bCanMoveForward = false;
  72. break;
  73. case CheckResult::WARNING:
  74. $aWarnings[] = $oCheckResult->sLabel;
  75. break;
  76. case CheckResult::INFO:
  77. $aInfo[] = $oCheckResult->sLabel;
  78. break;
  79. }
  80. }
  81. $sStyle = 'style="display:none;max-height:196px;overflow:auto;"';
  82. $sToggleButtons = '<button type="button" id="show_details" onclick="$(\'#details\').toggle(); $(this).toggle(); $(\'#hide_details\').toggle();">Show details</button><button type="button" id="hide_details" style="display:none;" onclick="$(\'#details\').toggle(); $(this).toggle(); $(\'#show_details\').toggle();">Hide details</button>';
  83. if (count($aErrors)> 0)
  84. {
  85. $sStyle = 'style="max-height:196px;overflow:auto;"';
  86. $sImage = "stop-mid.png";
  87. $sTitle = count($aErrors).' Error(s), '.count($aWarnings).' Warning(s).';
  88. }
  89. else if (count($aWarnings)> 0)
  90. {
  91. $sTitle = count($aWarnings).' Warning(s) '.$sToggleButtons;
  92. $sImage = "messagebox_warning-mid.png";
  93. }
  94. else
  95. {
  96. $sTitle = 'Ok. '.$sToggleButtons;
  97. $sImage = "clean-mid.png";
  98. }
  99. $oPage->add('<h2>Prerequisites validation: ');
  100. $oPage->add("<img style=\"vertical-align:middle;\" src=\"../images/$sImage\"> ");
  101. $oPage->add($sTitle);
  102. $oPage->add('</h2>');
  103. $oPage->add('<div id="details" '.$sStyle.'>');
  104. foreach($aErrors as $sText)
  105. {
  106. $oPage->error($sText);
  107. }
  108. foreach($aWarnings as $sText)
  109. {
  110. $oPage->warning($sText);
  111. }
  112. foreach($aInfo as $sText)
  113. {
  114. $oPage->ok($sText);
  115. }
  116. $oPage->add('</div>');
  117. if (!$this->bCanMoveForward)
  118. {
  119. $oPage->p('Sorry, the installation cannot continue. Please fix the errors and reload this page to launch the installation again.');
  120. }
  121. }
  122. public function CanMoveForward()
  123. {
  124. return $this->bCanMoveForward;
  125. }
  126. }
  127. /**
  128. * Second step of the iTop Installation Wizard: Install or Upgrade
  129. */
  130. class WizStepInstallOrUpgrade extends WizardStep
  131. {
  132. public function GetTitle()
  133. {
  134. return 'Install or Upgrade choice';
  135. }
  136. public function GetPossibleSteps()
  137. {
  138. return array('WizStepDetectedInfo', 'WizStepLicense');
  139. }
  140. public function ProcessParams($bMoveForward = true)
  141. {
  142. $sNextStep = '';
  143. $sInstallMode = utils::ReadParam('install_mode');
  144. $this->oWizard->SaveParameter('previous_version_dir', '');
  145. $this->oWizard->SaveParameter('db_server', '');
  146. $this->oWizard->SaveParameter('db_user', '');
  147. $this->oWizard->SaveParameter('db_pwd', '');
  148. $this->oWizard->SaveParameter('db_name', '');
  149. $this->oWizard->SaveParameter('db_prefix', '');
  150. $this->oWizard->SaveParameter('db_backup', false);
  151. $this->oWizard->SaveParameter('db_backup_path', '');
  152. if ($sInstallMode == 'install')
  153. {
  154. $this->oWizard->SetParameter('install_mode', 'install');
  155. $sFullSourceDir = SetupUtils::GetLatestDataModelDir();
  156. $this->oWizard->SetParameter('source_dir', $sFullSourceDir);
  157. $this->oWizard->SetParameter('datamodel_version', SetupUtils::GetDataModelVersion($sFullSourceDir));
  158. $sNextStep = 'WizStepLicense';
  159. }
  160. else
  161. {
  162. $this->oWizard->SetParameter('install_mode', 'upgrade');
  163. $sNextStep = 'WizStepDetectedInfo';
  164. }
  165. return array('class' => $sNextStep, 'state' => '');
  166. }
  167. public function Display(WebPage $oPage)
  168. {
  169. $sInstallMode = $this->oWizard->GetParameter('install_mode', '');
  170. $sDBServer = $this->oWizard->GetParameter('db_server', '');
  171. $sDBUser = $this->oWizard->GetParameter('db_user', '');
  172. $sDBPwd = $this->oWizard->GetParameter('db_pwd', '');
  173. $sDBName = $this->oWizard->GetParameter('db_name', '');
  174. $sDBPrefix = $this->oWizard->GetParameter('db_prefix', '');
  175. $bDBBackup = $this->oWizard->GetParameter('db_backup', false);
  176. $sDBBackupPath = $this->oWizard->GetParameter('db_backup_path', '');
  177. $sPreviousVersionDir = '';
  178. if ($sInstallMode == '')
  179. {
  180. $sDBBackupPath = APPROOT.'data/'.ITOP_APPLICATION.strftime('-backup-%Y-%m-%d.zip');
  181. $bDBBackup = true;
  182. $aPreviousInstance = SetupUtils::GetPreviousInstance(APPROOT);
  183. if ($aPreviousInstance['found'])
  184. {
  185. $sInstallMode = 'upgrade';
  186. $sSourceDir = APPROOT;
  187. $sDBServer = $aPreviousInstance['db_server'];
  188. $sDBUser = $aPreviousInstance['db_user'];
  189. $sDBPwd = $aPreviousInstance['db_pwd'];
  190. $sDBName = $aPreviousInstance['db_name'];
  191. $sDBPrefix = $aPreviousInstance['db_prefix'];
  192. $sStyle = '';
  193. $sPreviousVersionDir = APPROOT;
  194. }
  195. else
  196. {
  197. $sInstallMode = 'install';
  198. }
  199. }
  200. $sPreviousVersionDir = $this->oWizard->GetParameter('previous_version_dir', $sPreviousVersionDir);
  201. $sUpgradeInfoStyle = '';
  202. if ($sInstallMode == 'install')
  203. {
  204. $sUpgradeInfoStyle = ' style="display: none;" ';
  205. }
  206. $oPage->add('<h2>What do you want to do?</h2>');
  207. $sChecked = ($sInstallMode == 'install') ? ' checked ' : '';
  208. $oPage->p('<input id="radio_install" type="radio" name="install_mode" value="install"'.$sChecked.'/><label for="radio_install">&nbsp;Install a new '.ITOP_APPLICATION.'</label>');
  209. $sChecked = ($sInstallMode == 'upgrade') ? ' checked ' : '';
  210. $oPage->p('<input id="radio_update" type="radio" name="install_mode" value="upgrade"'.$sChecked.'/><label for="radio_update">&nbsp;Upgrade an existing '.ITOP_APPLICATION.' instance</label>');
  211. //$oPage->add('<fieldset id="upgrade_info"'.$sUpgradeInfoStyle.'>');
  212. //$oPage->add('<legend>Information about the previous instance:</legend>');
  213. $oPage->add('<table id="upgrade_info"'.$sUpgradeInfoStyle.'>');
  214. $oPage->add('<tr><td>Location on the disk:</td><td><input id="previous_version_dir" type="text" name="previous_version_dir" value="'.htmlentities($sPreviousVersionDir, ENT_QUOTES, 'UTF-8').'" size="25"/></td></tr>');
  215. SetupUtils::DisplayDBParameters($oPage, false, $sDBServer, $sDBUser, $sDBPwd, $sDBName, $sDBPrefix);
  216. $aBackupChecks = SetupUtils::CheckBackupPrerequisites($sDBBackupPath);
  217. $bCanBackup = true;
  218. $sMySQLDumpMessage = '';
  219. foreach($aBackupChecks as $oCheck)
  220. {
  221. if ($oCheck->iSeverity == CheckResult::ERROR)
  222. {
  223. $bCanBackup = false;
  224. $sMySQLDumpMessage .= '<img src="../images/error.png"/>&nbsp;<b> Warning:</b> '.$oCheck->sLabel;
  225. }
  226. else
  227. {
  228. $sMySQLDumpMessage .= '<img src="../images/validation_ok.png"/> '.$oCheck->sLabel.' ';
  229. }
  230. }
  231. $sChecked = ($bCanBackup && ($bDBBackup == 'install')) ? ' checked ' : '';
  232. $sDisabled = $bCanBackup ? '' : ' disabled ';
  233. $oPage->add('<tr><td colspan="2"><input id="db_backup" type="checkbox" name="db_backup"'.$sChecked.$sDisabled.' value="1"/>&nbsp;Backup the '.ITOP_APPLICATION.' database before upgrading</td></tr>');
  234. $oPage->add('<tr><td colspan="2">Save the backup to: <input id="db_backup_path" type="text" name="db_backup_path" '.$sDisabled.'value="'.htmlentities($sDBBackupPath, ENT_QUOTES, 'UTF-8').'" size="25"/></td></tr>');
  235. $fFreeSpace = SetupUtils::CheckDiskSpace($sDBBackupPath);
  236. $sMessage = '';
  237. if ($fFreeSpace !== false)
  238. {
  239. $sMessage .= SetupUtils::HumanReadableSize($fFreeSpace).' free in '.dirname($sDBBackupPath);
  240. }
  241. $oPage->add('<tr><td colspan="2">');
  242. $oPage->add($sMySQLDumpMessage.'<br/><span id="backup_info" style="font-size:small;color:#696969;">'.$sMessage.'</span></td></tr>');
  243. $oPage->add('</table>');
  244. //$oPage->add('</fieldset>');
  245. $oPage->add_ready_script(
  246. <<<EOF
  247. $("#radio_update").bind('change', function() { if (this.checked ) { $('#upgrade_info').show(); WizardUpdateButtons(); } else { $('#upgrade_info').hide(); } });
  248. $("#radio_install").bind('change', function() { if (this.checked ) { $('#upgrade_info').hide(); WizardUpdateButtons(); } else { $('#upgrade_info').show(); } });
  249. $("#previous_version_dir").bind('change keyup', function() { WizardAsyncAction('check_path', { previous_version_dir: $('#previous_version_dir').val() }); });
  250. $("#db_backup_path").bind('change keyup', function() { WizardAsyncAction('check_backup', { db_backup_path: $('#db_backup_path').val() }); });
  251. EOF
  252. );
  253. }
  254. public function AsyncAction(WebPage $oPage, $sCode, $aParameters)
  255. {
  256. switch($sCode)
  257. {
  258. case 'check_path':
  259. $sPreviousVersionDir = $aParameters['previous_version_dir'];
  260. $aPreviousInstance = SetupUtils::GetPreviousInstance($sPreviousVersionDir);
  261. if ($aPreviousInstance['found'])
  262. {
  263. $sDBServer = htmlentities($aPreviousInstance['db_server'], ENT_QUOTES, 'UTF-8');
  264. $sDBUser = htmlentities($aPreviousInstance['db_user'], ENT_QUOTES, 'UTF-8');
  265. $sDBPwd = htmlentities($aPreviousInstance['db_pwd'], ENT_QUOTES, 'UTF-8');
  266. $sDBName = htmlentities($aPreviousInstance['db_name'], ENT_QUOTES, 'UTF-8');
  267. $sDBPrefix = htmlentities($aPreviousInstance['db_prefix'], ENT_QUOTES, 'UTF-8');
  268. $oPage->add_ready_script(
  269. <<<EOF
  270. $("#db_server").val('$sDBServer');
  271. $("#db_user").val('$sDBUser');
  272. $("#db_pwd").val('$sDBPwd');
  273. $("#db_name").val('$sDBName');
  274. $("#db_prefix").val('$sDBPrefix');
  275. EOF
  276. );
  277. }
  278. break;
  279. case 'check_db':
  280. SetupUtils:: AsyncCheckDB($oPage, $aParameters);
  281. break;
  282. case 'check_backup':
  283. $sDBBackupPath = $aParameters['db_backup_path'];
  284. $fFreeSpace = SetupUtils::CheckDiskSpace($sDBBackupPath);
  285. if ($fFreeSpace !== false)
  286. {
  287. $sMessage = htmlentities(SetupUtils::HumanReadableSize($fFreeSpace).' free in '.dirname($sDBBackupPath), ENT_QUOTES, 'UTF-8');
  288. $oPage->add_ready_script(
  289. <<<EOF
  290. $("#backup_info").html('$sMessage');
  291. EOF
  292. );
  293. }
  294. else
  295. {
  296. $oPage->add_ready_script(
  297. <<<EOF
  298. $("#backup_info").html('');
  299. EOF
  300. );
  301. }
  302. break;
  303. }
  304. }
  305. /**
  306. * Tells whether the "Next" button should be enabled interactively
  307. * @return string A piece of javascript code returning either true or false
  308. */
  309. public function JSCanMoveForward()
  310. {
  311. return
  312. <<<EOF
  313. if ($("#radio_install").attr("checked") == "checked")
  314. {
  315. ValidateField("db_name", false);
  316. ValidateField("db_new_name", false);
  317. ValidateField("db_prefix", false);
  318. return true;
  319. }
  320. else
  321. {
  322. var bRet = ($("#wiz_form").data("db_connection") !== "error");
  323. bRet = ValidateField("db_name", true) && bRet;
  324. bRet = ValidateField("db_new_name", true) && bRet;
  325. bRet = ValidateField("db_prefix", true) && bRet;
  326. return bRet;
  327. }
  328. EOF
  329. ;
  330. }
  331. }
  332. /**
  333. * Upgrade information
  334. */
  335. class WizStepDetectedInfo extends WizardStep
  336. {
  337. protected $bCanMoveForward;
  338. public function GetTitle()
  339. {
  340. return 'Upgrade Information';
  341. }
  342. public function GetPossibleSteps()
  343. {
  344. return array('WizStepUpgradeMiscParams', 'WizStepLicense2');
  345. }
  346. public function ProcessParams($bMoveForward = true)
  347. {
  348. $sUpgradeType = utils::ReadParam('upgrade_type');
  349. $this->oWizard->SetParameter('mode', 'upgrade');
  350. $this->oWizard->SetParameter('upgrade_type', $sUpgradeType);
  351. $this->oWizard->SaveParameter('copy_extensions_from', '');
  352. $bDisplayLicense = $this->oWizard->GetParameter('display_license');
  353. switch ($sUpgradeType)
  354. {
  355. case 'keep-previous':
  356. $sSourceDir = utils::ReadParam('relative_source_dir', '', false, 'raw_data');
  357. $this->oWizard->SetParameter('source_dir', $this->oWizard->GetParameter('previous_version_dir').'/'.$sSourceDir);
  358. $this->oWizard->SetParameter('datamodel_version', utils::ReadParam('datamodel_previous_version', '', false, 'raw_data'));
  359. break;
  360. case 'use-compatible':
  361. $sDataModelPath = utils::ReadParam('datamodel_path', '', false, 'raw_data');
  362. $this->oWizard->SetParameter('source_dir', $sDataModelPath);
  363. $this->oWizard->SaveParameter('datamodel_version', '');
  364. break;
  365. default:
  366. // Do nothing, maybe the user pressed the Back button
  367. }
  368. if ($bDisplayLicense)
  369. {
  370. $aRet = array('class' => 'WizStepLicense2', 'state' => '');
  371. }
  372. else
  373. {
  374. $aRet = array('class' => 'WizStepUpgradeMiscParams', 'state' => '');
  375. }
  376. return $aRet;
  377. }
  378. public function Display(WebPage $oPage)
  379. {
  380. $oPage->add_style(
  381. <<<EOF
  382. #changes_summary {
  383. max-height: 200px;
  384. overflow: auto;
  385. }
  386. #changes_summary div {
  387. width:100;
  388. margin-top:0;
  389. padding-top: 0.5em;
  390. padding-left: 0;
  391. }
  392. #changes_summary div ul {
  393. margin-left:0;
  394. padding-left: 20px;
  395. }
  396. #changes_summary div.closed ul {
  397. display:none;
  398. }
  399. #changes_summary div li {
  400. list-style: none;
  401. width: 100;
  402. margin-left:0;
  403. padding-left: 0em;
  404. }
  405. .title {
  406. padding-left: 20px;
  407. font-weight: bold;
  408. cursor: pointer;
  409. background: url(../images/minus.gif) 2px 2px no-repeat;
  410. }
  411. #changes_summary div.closed .title {
  412. background: url(../images/plus.gif) 2px 2px no-repeat;
  413. }
  414. EOF
  415. );
  416. $this->bCanMoveForward = true;
  417. $bDisplayLicense = true;
  418. $sPreviousVersionDir = $this->oWizard->GetParameter('previous_version_dir', '');
  419. $aInstalledInfo = SetupUtils::GetApplicationVersion($this->oWizard);
  420. if ($aInstalledInfo === false)
  421. {
  422. throw(new Exception('No previous version of '.ITOP_APPLICATION.' found in the supplied database. The upgrade cannot continue.'));
  423. }
  424. else if (strcasecmp($aInstalledInfo['product_name'], ITOP_APPLICATION) != 0)
  425. {
  426. $oPage->p("<b>Warning: The installed products seem different. Are you sure the you want to upgrade {$aInstalledInfo['product_name']} with ".ITOP_APPLICATION."?</b>");
  427. }
  428. $sInstalledVersion = $aInstalledInfo['product_version'];
  429. $sInstalledDataModelVersion = $aInstalledInfo['datamodel_version'];
  430. $oPage->add("<h2>Information about the upgrade from version $sInstalledVersion to ".ITOP_VERSION.'.'.ITOP_REVISION."</h2>");
  431. if ($sInstalledVersion == (ITOP_VERSION.'.'.ITOP_REVISION))
  432. {
  433. // Reinstalling the same version let's skip the license agreement...
  434. $bDisplayLicense = false;
  435. }
  436. $this->oWizard->SetParameter('license', $bDisplayLicense); // Remember for later
  437. echo "sInstalledDataModelVersion: $sInstalledDataModelVersion";
  438. if ($sInstalledDataModelVersion == '$ITOP_VERSION$.$WCREV$')
  439. {
  440. // Special case for upgrading some development versions (temporary)
  441. $sCompatibleDMDir = SetupUtils::GetLatestDataModelDir();
  442. $sInstalledDataModelVersion = SetupUtils::GetDataModelVersion($sLatestDMDir);
  443. }
  444. else
  445. {
  446. $sCompatibleDMDir = SetupUtils::GetCompatibleDataModelDir($sInstalledDataModelVersion);
  447. }
  448. if ($sCompatibleDMDir === false)
  449. {
  450. // No compatible version exists... cannot upgrade. Either it is too old, or too new (downgrade !)
  451. $this->bCanMoveForward = false;
  452. $oPage->p("The current version of ".ITOP_APPLICATION." (".ITOP_VERSION.'.'.ITOP_REVISION.") does not seem to be compatible with the installed version ($sInstalledVersion).");
  453. $oPage->p("The upgrade cannot continue, sorry.");
  454. }
  455. else
  456. {
  457. $sUpgradeDMVersion = SetupUtils::GetDataModelVersion($sCompatibleDMDir);
  458. $sPreviousSourceDir = isset($aInstalledInfo['source_dir']) ? $aInstalledInfo['source_dir'] : 'modules';
  459. $aChanges = false;
  460. if (is_dir($sPreviousVersionDir))
  461. {
  462. // Check if the previous version is a "genuine" one or not...
  463. $aChanges = SetupUtils::CheckVersion($sInstalledDataModelVersion, $sPreviousVersionDir.'/'.$sPreviousSourceDir);
  464. }
  465. if (($aChanges !== false) && (count($aChanges) > 0))
  466. {
  467. // Some changes were detected, prompt the user to keep or discard them
  468. $oPage->p("<img src=\"../images/error.png\"/>&nbsp;Some modifications were detected between the ".ITOP_APPLICATION." version in '$sPreviousVersionDir' and a genuine $sInstalledVersion version.");
  469. $oPage->p("What do you want to do?");
  470. $aWritableDirs = array('modules', 'portal');
  471. $aErrors = SetupUtils::CheckWritableDirs($aWritableDirs);
  472. $sChecked = ($this->oWizard->GetParameter('upgrade_type') == 'keep-previous') ? ' checked ' : '';
  473. $sDisabled = (count($aErrors) > 0) ? ' disabled ' : '';
  474. $oPage->p('<input id="radio_upgrade_keep" type="radio" name="upgrade_type" value="keep-previous"'.$sChecked.$sDisabled.'/><label for="radio_upgrade_keep">&nbsp;Preserve the modifications of the installed version (the dasboards inside '.ITOP_APPLICATION.' may not be editable).</label>');
  475. $oPage->add('<input type="hidden" name="datamodel_previous_version" value="'.htmlentities($sInstalledDataModelVersion, ENT_QUOTES, 'UTF-8').'">');
  476. $oPage->add('<input type="hidden" name="relative_source_dir" value="'.htmlentities($sPreviousSourceDir, ENT_QUOTES, 'UTF-8').'">');
  477. if (count($aErrors) > 0)
  478. {
  479. $oPage->p("Cannot copy the installed version due to the following access rights issue(s):");
  480. foreach($aErrors as $sDir => $oCheckResult)
  481. {
  482. $oPage->p('<img src="../images/error.png"/>&nbsp;'.$oCheckResult->sLabel);
  483. }
  484. }
  485. $sChecked = ($this->oWizard->GetParameter('upgrade_type') == 'use-compatible') ? ' checked ' : '';
  486. $oPage->p('<input id="radio_upgrade_convert" type="radio" name="upgrade_type" value="use-compatible"'.$sChecked.'/><label for="radio_upgrade_convert">&nbsp;Discard the modifications, use a standard '.$sUpgradeDMVersion.' data model.</label>');
  487. $oPage->add('<input type="hidden" name="datamodel_path" value="'.htmlentities($sCompatibleDMDir, ENT_QUOTES, 'UTF-8').'">');
  488. $oPage->add('<input type="hidden" name="datamodel_version" value="'.htmlentities($sUpgradeDMVersion, ENT_QUOTES, 'UTF-8').'">');
  489. $oPage->add('<div id="changes_summary"><div class="closed"><span class="title">Details of the modifications</span><div>');
  490. if (count($aChanges['added']) > 0)
  491. {
  492. $oPage->add('<ul>New files added:');
  493. foreach($aChanges['added'] as $sFilePath => $void)
  494. {
  495. $oPage->add('<li>'.$sFilePath.'</li>');
  496. }
  497. $oPage->add('</ul>');
  498. }
  499. if (count($aChanges['removed']) > 0)
  500. {
  501. $oPage->add('<ul>Deleted files:');
  502. foreach($aChanges['removed'] as $sFilePath => $void)
  503. {
  504. $oPage->add('<li>'.$sFilePath.'</li>');
  505. }
  506. $oPage->add('</ul>');
  507. }
  508. if (count($aChanges['modified']) > 0)
  509. {
  510. $oPage->add('<ul>Modified files:');
  511. foreach($aChanges['modified'] as $sFilePath => $void)
  512. {
  513. $oPage->add('<li>'.$sFilePath.'</li>');
  514. }
  515. $oPage->add('</ul>');
  516. }
  517. $oPage->add('</div></div></div>');
  518. }
  519. else
  520. {
  521. // No changes detected... or no way to tell because of the lack of a manifest or previous source dir
  522. // Use the "compatible" datamodel as-is.
  523. $oPage->p("<img src=\"../images/validation_ok.png\"/>&nbsp;The datamodel will be upgraded from version $sInstalledDataModelVersion to version $sUpgradeDMVersion.");
  524. $oPage->add('<input type="hidden" name="upgrade_type" value="use-compatible">');
  525. $oPage->add('<input type="hidden" name="datamodel_path" value="'.htmlentities($sCompatibleDMDir, ENT_QUOTES, 'UTF-8').'">');
  526. $oPage->add('<input type="hidden" name="datamodel_version" value="'.htmlentities($sUpgradeDMVersion, ENT_QUOTES, 'UTF-8').'">');
  527. }
  528. // Check if there are "extensions" to preserve and if it's possible
  529. if (is_dir($sPreviousVersionDir.'/extensions'))
  530. {
  531. $aExtensions = glob($sPreviousVersionDir.'/extensions/*', GLOB_ONLYDIR);
  532. if (($aExtensions !== false) && (count($aExtensions)>0))
  533. {
  534. $aWritableDirs = array('extensions');
  535. $aErrors = SetupUtils::CheckWritableDirs($aWritableDirs);
  536. if (count($aErrors) > 0)
  537. {
  538. $oPage->p("Cannot copy the extensions from '$sPreviousVersionDir/extensions' to '".APPROOT."extensions' due to the following access rights issue(s):");
  539. foreach($aErrors as $sDir => $oCheckResult)
  540. {
  541. $oPage->p('<img src="../images/error.png"/>&nbsp;'.$oCheckResult->sLabel);
  542. }
  543. }
  544. else
  545. {
  546. $oPage->p("<b>Note:</b> The extensions present in '$sPreviousVersionDir/extensions' will be copied to '".APPROOT."extensions'.");
  547. $oPage->add('<input type="hidden" name="copy_extensions_from" value="'.htmlentities($sPreviousVersionDir.'/extensions', ENT_QUOTES, 'UTF-8').'">');
  548. }
  549. }
  550. }
  551. $oPage->add_ready_script(
  552. <<<EOF
  553. $("#changes_summary .title").click(function() { $(this).parent().toggleClass('closed'); } );
  554. $('input[name=upgrade_type]').bind('click change', function() { WizardUpdateButtons(); });
  555. EOF
  556. );
  557. }
  558. }
  559. public function CanMoveForward()
  560. {
  561. return $this->bCanMoveForward;
  562. }
  563. /**
  564. * Tells whether the "Next" button should be enabled interactively
  565. * @return string A piece of javascript code returning either true or false
  566. */
  567. public function JSCanMoveForward()
  568. {
  569. return
  570. <<<EOF
  571. if ($("#radio_upgrade_keep").length == 0) return true;
  572. bRet = ($('input[name=upgrade_type]:checked').length > 0);
  573. return bRet;
  574. EOF
  575. ;
  576. }
  577. }
  578. /**
  579. * License acceptation screen
  580. */
  581. class WizStepLicense extends WizardStep
  582. {
  583. public function GetTitle()
  584. {
  585. return 'License Agreement';
  586. }
  587. public function GetPossibleSteps()
  588. {
  589. return array('WizStepDBParams');
  590. }
  591. public function ProcessParams($bMoveForward = true)
  592. {
  593. $this->oWizard->SaveParameter('accept_license', 'no');
  594. return array('class' => 'WizStepDBParams', 'state' => '');
  595. }
  596. public function Display(WebPage $oPage)
  597. {
  598. $aLicenses = array();
  599. foreach (glob(APPROOT.'setup/licenses/*.xml') as $sFile)
  600. {
  601. $oXml = simplexml_load_file($sFile);
  602. foreach($oXml->license as $oLicense)
  603. {
  604. $aLicenses[] = $oLicense;
  605. }
  606. }
  607. $oPage->add('<h2>Licenses agreements for the components of '.ITOP_APPLICATION.'</h2>');
  608. $oPage->add_style('div a.no-arrow { background:transparent; padding-left:0;}');
  609. $oPage->add_style('.toggle { cursor:pointer; text-decoration:underline; color:#1C94C4; }');
  610. $oPage->add('<fieldset>');
  611. $oPage->add('<legend>Components of '.ITOP_APPLICATION.'</legend>');
  612. $oPage->add('<ul>');
  613. foreach($aLicenses as $index => $oLicense)
  614. {
  615. $oPage->add('<li><b>'.$oLicense->product.'</b>, licensed by '.$oLicense->author.' under the <b>'.$oLicense->license_type.' license</b>. (<span class="toggle" id="toggle_'.$index.'">Details</span>)');
  616. $oPage->add('<div id="license_'.$index.'" class="license_text" style="display:none;overflow:auto;max-height:10em;font-size:small;border:1px #696969 solid;margin-bottom:1em; margin-top:0.5em;padding:0.5em;">'.$oLicense->text.'</div>');
  617. $oPage->add_ready_script('$(".license_text a").attr("target", "_blank").addClass("no-arrow");');
  618. $oPage->add_ready_script('$("#toggle_'.$index.'").click( function() { $("#license_'.$index.'").toggle(); } );');
  619. }
  620. $oPage->add('</ul>');
  621. $oPage->add('</fieldset>');
  622. $sChecked = ($this->oWizard->GetParameter('accept_license', 'no') == 'yes') ? ' checked ' : '';
  623. $oPage->p('<input type="checkbox" name="accept_license" id="accept" value="yes"'.$sChecked.'><label for="accept">&nbsp;I accept the terms of the licenses of the '.count($aLicenses).' components mentioned above.</label>');
  624. $oPage->add_ready_script('$("#accept").bind("click change", function() { WizardUpdateButtons(); });');
  625. }
  626. /**
  627. * Tells whether the "Next" button should be enabled interactively
  628. * @return string A piece of javascript code returning either true or false
  629. */
  630. public function JSCanMoveForward()
  631. {
  632. return 'return ($("#accept").attr("checked") === "checked");';
  633. }
  634. }
  635. /**
  636. * License acceptation screen (when upgrading)
  637. */
  638. class WizStepLicense2 extends WizStepLicense
  639. {
  640. public function GetPossibleSteps()
  641. {
  642. return array('WizStepUpgradeMiscParams');
  643. }
  644. public function ProcessParams($bMoveForward = true)
  645. {
  646. return array('class' => 'WizStepUpgradeMiscParams', 'state' => '');
  647. }
  648. }
  649. /**
  650. * Database Connection parameters screen
  651. */
  652. class WizStepDBParams extends WizardStep
  653. {
  654. public function GetTitle()
  655. {
  656. return 'Database Configuration';
  657. }
  658. public function GetPossibleSteps()
  659. {
  660. return array('WizStepAdminAccount');
  661. }
  662. public function ProcessParams($bMoveForward = true)
  663. {
  664. $this->oWizard->SaveParameter('db_server', '');
  665. $this->oWizard->SaveParameter('db_user', '');
  666. $this->oWizard->SaveParameter('db_pwd', '');
  667. $this->oWizard->SaveParameter('db_name', '');
  668. $this->oWizard->SaveParameter('db_prefix', '');
  669. $this->oWizard->SaveParameter('new_db_name', '');
  670. $this->oWizard->SaveParameter('create_db', '');
  671. $this->oWizard->SaveParameter('db_new_name', '');
  672. return array('class' => 'WizStepAdminAccount', 'state' => '');
  673. }
  674. public function Display(WebPage $oPage)
  675. {
  676. $oPage->add('<h2>Configuration of the database connection:</h2>');
  677. $sDBServer = $this->oWizard->GetParameter('db_server', '');
  678. $sDBUser = $this->oWizard->GetParameter('db_user', '');
  679. $sDBPwd = $this->oWizard->GetParameter('db_pwd', '');
  680. $sDBName = $this->oWizard->GetParameter('db_name', '');
  681. $sDBPrefix = $this->oWizard->GetParameter('db_prefix', '');
  682. $sNewDBName = $this->oWizard->GetParameter('db_new_name', false);
  683. $oPage->add('<table>');
  684. SetupUtils::DisplayDBParameters($oPage, true, $sDBServer, $sDBUser, $sDBPwd, $sDBName, $sDBPrefix, $sNewDBName);
  685. $oPage->add('</table>');
  686. $sCreateDB = $this->oWizard->GetParameter('create_db', 'yes');
  687. if ($sCreateDB == 'no')
  688. {
  689. $oPage->add_ready_script('$("#existing_db").attr("checked", "checked");');
  690. }
  691. else
  692. {
  693. $oPage->add_ready_script('$("#create_db").attr("checked", "checked");');
  694. }
  695. }
  696. public function AsyncAction(WebPage $oPage, $sCode, $aParameters)
  697. {
  698. switch($sCode)
  699. {
  700. case 'check_db':
  701. SetupUtils:: AsyncCheckDB($oPage, $aParameters);
  702. break;
  703. }
  704. }
  705. /**
  706. * Tells whether the "Next" button should be enabled interactively
  707. * @return string A piece of javascript code returning either true or false
  708. */
  709. public function JSCanMoveForward()
  710. {
  711. return
  712. <<<EOF
  713. if ($("#wiz_form").data("db_connection") === "error") return false;
  714. var bRet = true;
  715. bRet = ValidateField("db_name", true) && bRet;
  716. bRet = ValidateField("db_new_name", true) && bRet;
  717. bRet = ValidateField("db_prefix", true) && bRet;
  718. return bRet;
  719. EOF
  720. ;
  721. }
  722. }
  723. /**
  724. * Administrator Account definition screen
  725. */
  726. class WizStepAdminAccount extends WizardStep
  727. {
  728. public function GetTitle()
  729. {
  730. return 'Administrator Account';
  731. }
  732. public function GetPossibleSteps()
  733. {
  734. return array('WizStepMiscParams');
  735. }
  736. public function ProcessParams($bMoveForward = true)
  737. {
  738. $this->oWizard->SaveParameter('admin_user', '');
  739. $this->oWizard->SaveParameter('admin_pwd', '');
  740. $this->oWizard->SaveParameter('confirm_pwd', '');
  741. $this->oWizard->SaveParameter('admin_language', 'EN US');
  742. return array('class' => 'WizStepMiscParams', 'state' => '');
  743. }
  744. public function Display(WebPage $oPage)
  745. {
  746. $sAdminUser = $this->oWizard->GetParameter('admin_user', 'admin');
  747. $sAdminPwd = $this->oWizard->GetParameter('admin_pwd', '');
  748. $sConfirmPwd = $this->oWizard->GetParameter('confirm_pwd', '');
  749. $sAdminLanguage = $this->oWizard->GetParameter('admin_language', 'EN US');
  750. $oPage->add('<h2>Definition of the Administrator Account</h2>');
  751. $oPage->add('<fieldset>');
  752. $oPage->add('<legend>Administrator Account</legend>');
  753. $oPage->add('<table>');
  754. $oPage->add('<tr><td>Login: </td><td><input id="admin_user" name="admin_user" type="text" size="25" maxlength="64" value="'.htmlentities($sAdminUser, ENT_QUOTES, 'UTF-8').'"><span id="v_admin_user"/></td><tr>');
  755. $oPage->add('<tr><td>Password: </td><td><input id="admin_pwd" name="admin_pwd" type="password" size="25" maxlength="64" value="'.htmlentities($sAdminPwd, ENT_QUOTES, 'UTF-8').'"><span id="v_admin_pwd"/></td><tr>');
  756. $oPage->add('<tr><td>Confirm password: </td><td><input id="confirm_pwd" name="confirm_pwd" type="password" size="25" maxlength="64" value="'.htmlentities($sConfirmPwd, ENT_QUOTES, 'UTF-8').'"></td><tr>');
  757. $sSourceDir = APPROOT.'dictionaries/';
  758. $aLanguages = SetupUtils::GetAvailableLanguages($sSourceDir);
  759. $oPage->add('<tr><td>Language: </td><td>');
  760. $oPage->add(SetupUtils::GetLanguageSelect($sSourceDir, 'admin_language', $sAdminLanguage));
  761. $oPage->add('</td></tr>');
  762. $oPage->add('</table>');
  763. $oPage->add('</fieldset>');
  764. $oPage->add_ready_script(
  765. <<<EOF
  766. $('#admin_user').bind('change keyup', function() { WizardUpdateButtons(); } );
  767. $('#admin_pwd').bind('change keyup', function() { WizardUpdateButtons(); } );
  768. $('#confirm_pwd').bind('change keyup', function() { WizardUpdateButtons(); } );
  769. EOF
  770. );
  771. }
  772. /**
  773. * Tells whether the "Next" button should be enabled interactively
  774. * @return string A piece of javascript code returning either true or false
  775. */
  776. public function JSCanMoveForward()
  777. {
  778. return
  779. <<<EOF
  780. bRet = ($('#admin_user').val() != '');
  781. if (!bRet)
  782. {
  783. $("#v_admin_user").html('<img src="../images/validation_error.png" title="This field cannot be empty"/>');
  784. }
  785. else
  786. {
  787. $("#v_admin_user").html('');
  788. }
  789. bPasswordsMatch = ($('#admin_pwd').val() == $('#confirm_pwd').val());
  790. if (!bPasswordsMatch)
  791. {
  792. $('#v_admin_pwd').html('<img src="../images/validation_error.png" title="Retyped password do not match"/>');
  793. }
  794. else
  795. {
  796. $('#v_admin_pwd').html('');
  797. }
  798. bRet = bPasswordsMatch && bRet;
  799. return bRet;
  800. EOF
  801. ;
  802. }}
  803. /**
  804. * Miscellaneous Parameters (URL, Sample Data)
  805. */
  806. class WizStepMiscParams extends WizardStep
  807. {
  808. public function GetTitle()
  809. {
  810. return 'Miscellaneous Parameters';
  811. }
  812. public function GetPossibleSteps()
  813. {
  814. return array('WizStepModulesChoice');
  815. }
  816. public function ProcessParams($bMoveForward = true)
  817. {
  818. $this->oWizard->SaveParameter('default_language', '');
  819. $this->oWizard->SaveParameter('application_url', '');
  820. $this->oWizard->SaveParameter('sample_data', 'yes');
  821. return array('class' => 'WizStepModulesChoice', 'state' => 'start_install');
  822. }
  823. public function Display(WebPage $oPage)
  824. {
  825. $sDefaultLanguage = $this->oWizard->GetParameter('default_language', $this->oWizard->GetParameter('admin_language'));
  826. $sApplicationURL = $this->oWizard->GetParameter('application_url', utils::GetDefaultUrlAppRoot());
  827. $sSampleData = $this->oWizard->GetParameter('sample_data', 'yes');
  828. $oPage->add('<h2>Additional parameters</h2>');
  829. $oPage->add('<fieldset>');
  830. $oPage->add('<legend>Default Language</legend>');
  831. $oPage->add('<table>');
  832. $sSourceDir = APPROOT.'dictionaries/';
  833. $aLanguages = SetupUtils::GetAvailableLanguages($sSourceDir);
  834. $oPage->add('<tr><td>Default Language: </td><td>');
  835. $oPage->add(SetupUtils::GetLanguageSelect($sSourceDir, 'default_language', $sDefaultLanguage));
  836. $oPage->add('</td></tr>');
  837. $oPage->add('</table>');
  838. $oPage->add('</fieldset>');
  839. $oPage->add('<fieldset>');
  840. $oPage->add('<legend>Application URL</legend>');
  841. $oPage->add('<table>');
  842. $oPage->add('<tr><td>URL: </td><td><input id="application_url" name="application_url" type="text" size="35" maxlength="1024" value="'.htmlentities($sApplicationURL, ENT_QUOTES, 'UTF-8').'"><span id="v_application_url"/></td><tr>');
  843. $oPage->add('<tr><td colspan="2">Change the value above if the end-users will be accessing the application by another path due to a specific configuration of the web server.</td><tr>');
  844. $oPage->add('</table>');
  845. $oPage->add('</fieldset>');
  846. $oPage->add('<fieldset>');
  847. $oPage->add('<legend>Sample Data</legend>');
  848. $oPage->add('<table>');
  849. $sChecked = ($sSampleData == 'yes') ? ' checked ' : '';
  850. $oPage->p('<input id="sample_data_yes" name="sample_data" type="radio" value="yes"'.$sChecked.'><label for="sample_data_yes">&nbsp;I am installing a <b>demo or test</b> instance, populate the database with some demo data.');
  851. $sChecked = ($sSampleData == 'no') ? ' checked ' : '';
  852. $oPage->p('<input id="sample_data_no" name="sample_data" type="radio" value="no"'.$sChecked.'><label for="sample_data_no">&nbsp;I am installing a <b>production</b> instance, create an empty database to start from.');
  853. $oPage->add('</table>');
  854. $oPage->add('</fieldset>');
  855. $oPage->add_ready_script(
  856. <<<EOF
  857. $('#application_url').bind('change keyup', function() { WizardUpdateButtons(); } );
  858. EOF
  859. );
  860. }
  861. /**
  862. * Tells whether the "Next" button should be enabled interactively
  863. * @return string A piece of javascript code returning either true or false
  864. */
  865. public function JSCanMoveForward()
  866. {
  867. return
  868. <<<EOF
  869. bRet = ($('#application_url').val() != '');
  870. if (!bRet)
  871. {
  872. $("#v_application_url").html('<img src="../images/validation_error.png" title="This field cannot be empty"/>');
  873. }
  874. else
  875. {
  876. $("#v_application_url").html('');
  877. }
  878. return bRet;
  879. EOF
  880. ;
  881. }
  882. }
  883. /**
  884. * Miscellaneous Parameters (URL...) in case of upgrade
  885. */
  886. class WizStepUpgradeMiscParams extends WizardStep
  887. {
  888. public function GetTitle()
  889. {
  890. return 'Miscellaneous Parameters';
  891. }
  892. public function GetPossibleSteps()
  893. {
  894. return array('WizStepModulesChoice');
  895. }
  896. public function ProcessParams($bMoveForward = true)
  897. {
  898. $this->oWizard->SaveParameter('application_url', '');
  899. return array('class' => 'WizStepModulesChoice', 'state' => 'start_upgrade');
  900. }
  901. public function Display(WebPage $oPage)
  902. {
  903. $sApplicationURL = $this->oWizard->GetParameter('application_url', utils::GetDefaultUrlAppRoot());
  904. $oPage->add('<h2>Additional parameters</h2>');
  905. $oPage->add('<fieldset>');
  906. $oPage->add('<legend>Application URL</legend>');
  907. $oPage->add('<table>');
  908. $oPage->add('<tr><td>URL: </td><td><input id="application_url" name="application_url" type="text" size="35" maxlength="1024" value="'.htmlentities($sApplicationURL, ENT_QUOTES, 'UTF-8').'"><span id="v_application_url"/></td><tr>');
  909. $oPage->add('<tr><td colspan="2">Change the value above if the end-users will be accessing the application by another path due to a specific configuration of the web server.</td><tr>');
  910. $oPage->add('</table>');
  911. $oPage->add('</fieldset>');
  912. $oPage->add_ready_script(
  913. <<<EOF
  914. $('#application_url').bind('change keyup', function() { WizardUpdateButtons(); } );
  915. EOF
  916. );
  917. }
  918. /**
  919. * Tells whether the "Next" button should be enabled interactively
  920. * @return string A piece of javascript code returning either true or false
  921. */
  922. public function JSCanMoveForward()
  923. {
  924. return
  925. <<<EOF
  926. bRet = ($('#application_url').val() != '');
  927. if (!bRet)
  928. {
  929. $("#v_application_url").html('<img src="../images/validation_error.png" title="This field cannot be empty"/>');
  930. }
  931. else
  932. {
  933. $("#v_application_url").html('');
  934. }
  935. return bRet;
  936. EOF
  937. ;
  938. }
  939. }
  940. /**
  941. * Choice of the modules to be installed
  942. */
  943. class WizStepModulesChoice extends WizardStep
  944. {
  945. public function GetTitle()
  946. {
  947. $aStepInfo = $this->GetStepInfo();
  948. $sTitle = isset($aStepInfo['title']) ? $aStepInfo['title'] : 'Modules selection';
  949. return $sTitle;
  950. }
  951. public function GetPossibleSteps()
  952. {
  953. return array('WizStepModulesChoice', 'WizStepSummary');
  954. }
  955. public function ProcessParams($bMoveForward = true)
  956. {
  957. // Accumulates the selected modules:
  958. $index = $this->GetStepIndex();
  959. // use json_encode:decode to store a hash array: step_id => array(input_name => selected_input_id)
  960. $aSelectedChoices = json_decode($this->oWizard->GetParameter('selected_components', '{}'), true);
  961. $aSelected = utils::ReadParam('choice', array());
  962. $aSelectedChoices[$index] = $aSelected;
  963. $this->oWizard->SetParameter('selected_components', json_encode($aSelectedChoices));
  964. if ($this->GetStepInfo($index) == null)
  965. {
  966. throw new Exception('Internal error: invalid step "'.$index.'" for the choice of modules.');
  967. }
  968. else if ($bMoveForward)
  969. {
  970. if ($this->GetStepInfo(1 + $index) != null)
  971. {
  972. return array('class' => 'WizStepModulesChoice', 'state' => (1+$index));
  973. }
  974. else
  975. {
  976. // Exiting this step of the wizard, let's convert the selection into a list of modules
  977. $aModules = array();
  978. $sDisplayChoices = '<ul>';
  979. for($i = 0; $i <= $index; $i++)
  980. {
  981. $aStepInfo = $this->GetStepInfo($i);
  982. $sDisplayChoices .= $this->GetSelectedModules($aStepInfo, $aSelectedChoices[$i], $aModules);
  983. }
  984. $sDisplayChoices .= '</ul>';
  985. if (class_exists('CreateITILProfilesInstaller'))
  986. {
  987. $this->oWizard->SetParameter('old_addon', true);
  988. }
  989. $this->oWizard->SetParameter('selected_modules', json_encode(array_keys($aModules)));
  990. $this->oWizard->SetParameter('display_choices', $sDisplayChoices);
  991. return array('class' => 'WizStepSummary', 'state' => '');
  992. }
  993. }
  994. }
  995. public function Display(WebPage $oPage)
  996. {
  997. $this->DisplayStep($oPage);
  998. }
  999. protected function DisplayStep($oPage)
  1000. {
  1001. $aStepInfo = $this->GetStepInfo();
  1002. $oPage->add_style("div.choice { margin: 0.5em;}");
  1003. $oPage->add_style("div.choice a { text-decoration:none; font-weight: bold; color: #1C94C4 }");
  1004. $oPage->add_style("div.description { margin-left: 2em; }");
  1005. $oPage->add_style(".choice-disabled { color: #999; }");
  1006. $oPage->add('<table><tr>');
  1007. $sBannerPath = isset($aStepInfo['banner']) ? $aStepInfo['banner'] : '';
  1008. if (!empty($sBannerPath))
  1009. {
  1010. if (substr($sBannerPath, 0, 1) == '/')
  1011. {
  1012. // absolute path, means relative to APPROOT
  1013. $sBannerUrl = utils::GetDefaultUrlAppRoot().$sBannerPath;
  1014. }
  1015. else
  1016. {
  1017. // relative path: i.e. relative to the directory containing the XML file
  1018. $sFullPath = dirname($this->GetSourceFilePath()).'/'.$sBannerPath;
  1019. $sRealPath = realpath($sFullPath);
  1020. $sBannerUrl = utils::GetDefaultUrlAppRoot().str_replace(realpath(APPROOT), '', $sRealPath);
  1021. }
  1022. $oPage->add('<td><img src="'.$sBannerUrl.'"/><td>');
  1023. }
  1024. $sDescription = isset($aStepInfo['description']) ? $aStepInfo['description'] : '';
  1025. $oPage->add('<td>'.$sDescription.'<td>');
  1026. $oPage->add('</tr></table>');
  1027. // Build the default choices
  1028. $aDefaults = array();
  1029. $aModules = SetupUtils::AnalyzeInstallation($this->oWizard);
  1030. $this->GetDefaults($aStepInfo, $aDefaults, $aModules);
  1031. $index = $this->GetStepIndex();
  1032. // retrieve the saved selection
  1033. // use json_encode:decode to store a hash array: step_id => array(input_name => selected_input_id)
  1034. $aParameters = json_decode($this->oWizard->GetParameter('selected_components', '{}'), true);
  1035. if (!isset($aParameters[$index]))
  1036. {
  1037. $aParameters[$index] = $aDefaults;
  1038. }
  1039. $aSelectedComponents = $aParameters[$index];
  1040. $oPage->add('<div style="height:250px;overflow:auto;border:#ccc 1px solid;">');
  1041. $this->DisplayOptions($oPage, $aStepInfo, $aSelectedComponents);
  1042. $oPage->add('</div>');
  1043. $oPage->add_script(
  1044. <<<EOF
  1045. function CheckChoice(sChoiceId)
  1046. {
  1047. console.log('Ici !!');
  1048. var oElement = $('#'+sChoiceId);
  1049. var bChecked = (oElement.attr('checked') == 'checked');
  1050. var sId = sChoiceId.replace('choice', '');
  1051. if ((oElement.attr('type') == 'radio') && bChecked)
  1052. {
  1053. // Only the radio that is clicked is notified, let's warn the other radio buttons
  1054. sName = oElement.attr('name');
  1055. $('input[name="'+sName+'"]').each(function() {
  1056. var sRadioId = $(this).attr('id');
  1057. if (sRadioId != sChoiceId)
  1058. {
  1059. CheckChoice(sRadioId);
  1060. }
  1061. });
  1062. }
  1063. $('#sub_choices'+sId).each(function() {
  1064. if (!bChecked)
  1065. {
  1066. $(this).addClass('choice-disabled');
  1067. }
  1068. else
  1069. {
  1070. $(this).removeClass('choice-disabled');
  1071. }
  1072. $('input', this).each(function() {
  1073. if (bChecked)
  1074. {
  1075. if ($(this).attr('data-disabled') != 'disabled')
  1076. {
  1077. // Only non-mandatory fields can be enabled
  1078. $(this).removeAttr('disabled');
  1079. }
  1080. }
  1081. else
  1082. {
  1083. $(this).attr('disabled', 'disabled');
  1084. }
  1085. });
  1086. });
  1087. }
  1088. EOF
  1089. );
  1090. $oPage->add_ready_script(
  1091. <<<EOF
  1092. $('.wiz-choice').bind('change', function() { CheckChoice($(this).attr('id')); } );
  1093. $('.wiz-choice').trigger('change');
  1094. EOF
  1095. );
  1096. }
  1097. protected function GetDefaults($aInfo, &$aDefaults, $aModules, $sParentId = '')
  1098. {
  1099. $aOptions = isset($aInfo['options']) ? $aInfo['options'] : array();
  1100. foreach($aOptions as $index => $aChoice)
  1101. {
  1102. $sChoiceId = $sParentId.'_'.$index;
  1103. if (isset($aChoice['default']) && $aChoice['default'])
  1104. {
  1105. $aDefaults[$sChoiceId] = $sChoiceId;
  1106. }
  1107. foreach($aChoice['modules'] as $sModuleId)
  1108. {
  1109. if ($aModules[$sModuleId]['version_db'] != '')
  1110. {
  1111. // A module corresponding to this choice is installed, the whole choice is selected
  1112. $aDefaults[$sChoiceId] = $sChoiceId;
  1113. break;
  1114. }
  1115. }
  1116. if (isset($aChoice['sub_options']))
  1117. {
  1118. $this->GetDefaults($aChoice['sub_options'], $aDefaults, $sChoiceId);
  1119. }
  1120. $index++;
  1121. }
  1122. $aAlternatives = isset($aInfo['alternatives']) ? $aInfo['alternatives'] : array();
  1123. $sChoiceName = null;
  1124. foreach($aAlternatives as $index => $aChoice)
  1125. {
  1126. $sChoiceId = $sParentId.'_'.$index;
  1127. if ($sChoiceName == null)
  1128. {
  1129. $sChoiceName = $sChoiceId;
  1130. }
  1131. if (isset($aChoice['default']) && $aChoice['default'])
  1132. {
  1133. $aDefaults[$sChoiceName] = $sChoiceId;
  1134. }
  1135. if (isset($aChoice['sub_options']))
  1136. {
  1137. $this->GetDefaults($aChoice['sub_options'], $aDefaults, $aModules, $sChoiceId);
  1138. }
  1139. $index++;
  1140. }
  1141. // the installed choices have precedence over the 'default' choices
  1142. $sChoiceName = null;
  1143. foreach($aAlternatives as $index => $aChoice)
  1144. {
  1145. $sChoiceId = $sParentId.'_'.$index;
  1146. if ($sChoiceName == null)
  1147. {
  1148. $sChoiceName = $sChoiceId;
  1149. }
  1150. foreach($aChoice['modules'] as $sModuleId)
  1151. {
  1152. if ($aModules[$sModuleId]['version_db'] != '')
  1153. {
  1154. // A module corresponding to this choice is installed, the whole choice is selected
  1155. $aDefaults[$sChoiceName] = $sChoiceId;
  1156. break;
  1157. }
  1158. }
  1159. }
  1160. }
  1161. /**
  1162. * Converts the list of selected "choices" into a list of "modules": take into account the selected and the mandatory modules
  1163. * @param hash $aInfo Info about the "choice" array('options' => array(...), 'alternatives' => array(...))
  1164. * @param hash $aSelectedChoices List of selected choices array('name' => 'selected_value_id')
  1165. * @param hash $aModules Return parameter: List of selected modules array('module_id' => true)
  1166. * @param string $sParentId Used for recursion
  1167. * @return void
  1168. */
  1169. protected function GetSelectedModules($aInfo, $aSelectedChoices, &$aModules, $sParentId = '', $sDisplayChoices = '')
  1170. {
  1171. if ($sParentId == '')
  1172. {
  1173. // Check once (before recursing) that the hidden modules are selected
  1174. foreach(SetupUtils::AnalyzeInstallation($this->oWizard) as $sModuleId => $aModule)
  1175. {
  1176. if ($sModuleId != ROOT_MODULE)
  1177. {
  1178. if (($aModule['category'] == 'authentication') || (!$aModule['visible']))
  1179. {
  1180. $aModules[$sModuleId] = true;
  1181. }
  1182. }
  1183. }
  1184. }
  1185. $aOptions = isset($aInfo['options']) ? $aInfo['options'] : array();
  1186. foreach($aOptions as $index => $aChoice)
  1187. {
  1188. $sChoiceId = $sParentId.'_'.$index;
  1189. if ( (isset($aChoice['mandatory']) && $aChoice['mandatory']) ||
  1190. (isset($aSelectedChoices[$sChoiceId]) && ($aSelectedChoices[$sChoiceId] == $sChoiceId)) )
  1191. {
  1192. $sDisplayChoices .= '<li>'.$aChoice['title'].'</li>';
  1193. if (isset($aChoice['modules']))
  1194. {
  1195. foreach($aChoice['modules'] as $sModuleId)
  1196. {
  1197. $aModules[$sModuleId] = true; // store the Id of the selected module
  1198. }
  1199. }
  1200. // Recurse only for selected choices
  1201. if (isset($aChoice['sub_options']))
  1202. {
  1203. $sDisplayChoices .= '<ul>';
  1204. $sDisplayChoices = $this->GetSelectedModules($aChoice['sub_options'], $aSelectedChoices, $aModules, $sChoiceId, $sDisplayChoices);
  1205. $sDisplayChoices .= '</ul>';
  1206. }
  1207. $sDisplayChoices .= '</li>';
  1208. }
  1209. $index++;
  1210. }
  1211. $aAlternatives = isset($aInfo['alternatives']) ? $aInfo['alternatives'] : array();
  1212. $sChoiceName = null;
  1213. foreach($aAlternatives as $index => $aChoice)
  1214. {
  1215. $sChoiceId = $sParentId.'_'.$index;
  1216. if ($sChoiceName == null)
  1217. {
  1218. $sChoiceName = $sChoiceId;
  1219. }
  1220. if ( (isset($aChoice['mandatory']) && $aChoice['mandatory']) ||
  1221. (isset($aSelectedChoices[$sChoiceName]) && ($aSelectedChoices[$sChoiceName] == $sChoiceId)) )
  1222. {
  1223. $sDisplayChoices .= '<li>'.$aChoice['title'].'</li>';
  1224. if (isset($aChoice['modules']))
  1225. {
  1226. foreach($aChoice['modules'] as $sModuleId)
  1227. {
  1228. $aModules[$sModuleId] = true; // store the Id of the selected module
  1229. }
  1230. }
  1231. // Recurse only for selected choices
  1232. if (isset($aChoice['sub_options']))
  1233. {
  1234. $sDisplayChoices .= '<ul>';
  1235. $sDisplayChoices = $this->GetSelectedModules($aChoice['sub_options'], $aSelectedChoices, $aModules, $sChoiceId, $sDisplayChoices);
  1236. $sDisplayChoices .= '</ul>';
  1237. }
  1238. $sDisplayChoices .= '</li>';
  1239. }
  1240. $index++;
  1241. }
  1242. return $sDisplayChoices;
  1243. }
  1244. protected function GetStepIndex()
  1245. {
  1246. switch($this->sCurrentState)
  1247. {
  1248. case 'start_install':
  1249. case 'start_upgrade':
  1250. $index = 0;
  1251. break;
  1252. default:
  1253. $index = (integer)$this->sCurrentState;
  1254. }
  1255. return $index;
  1256. }
  1257. protected function GetStepInfo($idx = null)
  1258. {
  1259. $aStepInfo = null;
  1260. if ($idx === null)
  1261. {
  1262. $index = $this->GetStepIndex();
  1263. }
  1264. else
  1265. {
  1266. $index = $idx;
  1267. }
  1268. $aSteps = array();
  1269. if (@file_exists($this->GetSourceFilePath()))
  1270. {
  1271. $aParams = new XMLParameters($this->GetSourceFilePath());
  1272. $aSteps = $aParams->Get('steps', array());
  1273. $bAddExtensionsOnly = true;
  1274. }
  1275. else
  1276. {
  1277. // No wizard configuration provided, build a standard one:
  1278. $bAddExtensionsOnly = false;
  1279. $aSteps[] = array(
  1280. 'title' => 'Modules Selection',
  1281. 'description' => '<h2>Select the modules to install. You can launch the installation again to install new modules, but you cannot remove already installed modules.</h2>',
  1282. 'banner' => '/images/modules.png',
  1283. 'options' => array()
  1284. );
  1285. }
  1286. // Additional step for the extensions
  1287. $aSteps[] = array(
  1288. 'title' => 'Extensions',
  1289. 'description' => '<h2>Select additional extensions to install. You can launch the installation again to install new extensions, but you cannot remove already installed extensions.</h2>',
  1290. 'banner' => '/images/extension.png',
  1291. 'options' => array()
  1292. );
  1293. try
  1294. {
  1295. $sDefaultAppPath = utils::GetDefaultUrlAppRoot();
  1296. }
  1297. catch(Exception $e)
  1298. {
  1299. $sDefaultAppPath = '..';
  1300. }
  1301. $aAvailableModules = SetupUtils::AnalyzeInstallation($this->oWizard);
  1302. foreach($aAvailableModules as $sModuleId => $aModule)
  1303. {
  1304. if ($sModuleId == ROOT_MODULE) continue; // Convention: the version number of the application (and datamodel) are stored as a module named ROOT_MODULE
  1305. $sModuleLabel = $aModule['label'];
  1306. $sModuleHelp = $aModule['doc.more_information'];
  1307. $sMoreInfo = (!empty($aModule['doc.more_information'])) ? "<a href=\"$sDefaultAppPath{$aModule['doc.more_information']}\" target=\"_blank\">more info</a>": '';
  1308. if (($aModule['category'] != 'authentication') && ($aModule['visible']))
  1309. {
  1310. if (($bAddExtensionsOnly) && (!$this->IsExtension($aModule))) continue;
  1311. if ($this->IsExtension($aModule))
  1312. {
  1313. $iStepIndex = count($aSteps) - 1;
  1314. }
  1315. else
  1316. {
  1317. $iStepIndex = 0;
  1318. }
  1319. $aSteps[$iStepIndex]['options'][] = array(
  1320. 'title' => $sModuleLabel,
  1321. 'description' => '',
  1322. 'more_info' => $sMoreInfo,
  1323. 'default' => true, // by default offer to install all modules
  1324. 'modules' => array($sModuleId),
  1325. 'mandatory' => ($aModule['install']['flag'] & MODULE_ACTION_MANDATORY) ? true : false,
  1326. );
  1327. }
  1328. }
  1329. if (count($aSteps[count($aSteps) - 1]['options']) == 0)
  1330. {
  1331. // No extensions at all, remove the last step
  1332. array_pop($aSteps);
  1333. }
  1334. if (array_key_exists($index, $aSteps))
  1335. {
  1336. $aStepInfo = $aSteps[$index];
  1337. }
  1338. return $aStepInfo;
  1339. }
  1340. protected function GetExtensionsStepInfo()
  1341. {
  1342. // let the user select from the list of modules located in the "extensions" folder
  1343. }
  1344. protected function IsExtension($aModule)
  1345. {
  1346. // root_dir is the directory containing the module, check if its parent is "extensions"
  1347. if (basename(dirname($aModule['root_dir'])) == 'extensions')
  1348. {
  1349. return true;
  1350. }
  1351. return false;
  1352. }
  1353. protected function DisplayOptions($oPage, $aStepInfo, $aSelectedComponents, $sParentId = '')
  1354. {
  1355. $aOptions = isset($aStepInfo['options']) ? $aStepInfo['options'] : array();
  1356. $aAlternatives = isset($aStepInfo['alternatives']) ? $aStepInfo['alternatives'] : array();
  1357. $index = 0;
  1358. foreach($aOptions as $index => $aChoice)
  1359. {
  1360. $sAttributes = '';
  1361. $sChoiceId = $sParentId.'_'.$index;
  1362. if (isset($aChoice['mandatory']) && $aChoice['mandatory'])
  1363. {
  1364. $oPage->add('<div class="choice"><input id="choice'.$sChoiceId.'" checked disabled data-disabled="disabled" type="checkbox"'.$sAttributes.'/><input type="hidden" name="choice['.$sChoiceId.']" value="'.$sChoiceId.'">&nbsp;');
  1365. }
  1366. else if (isset($aSelectedComponents[$sChoiceId]) && ($aSelectedComponents[$sChoiceId] == $sChoiceId))
  1367. {
  1368. $oPage->add('<div class="choice"><input class="wiz-choice" id="choice'.$sChoiceId.'" name="choice['.$sChoiceId.']" type="checkbox" checked value="'.$sChoiceId.'"/>&nbsp;');
  1369. }
  1370. else
  1371. {
  1372. $oPage->add('<div class="choice"><input class="wiz-choice" id="choice'.$sChoiceId.'" name="choice['.$sChoiceId.']" type="checkbox" value="'.$sChoiceId.'"/>&nbsp;');
  1373. }
  1374. $this->DisplayChoice($oPage, $aChoice, $aSelectedComponents, $sChoiceId);
  1375. $oPage->add('</div>');
  1376. $index++;
  1377. }
  1378. $sChoiceName = null;
  1379. foreach($aAlternatives as $index => $aChoice)
  1380. {
  1381. $sAttributes = '';
  1382. $sChoiceId = $sParentId.'_'.$index;
  1383. if ($sChoiceName == null)
  1384. {
  1385. $sChoiceName = $sChoiceId; // All radios share the same name
  1386. }
  1387. if (isset($aSelectedComponents[$sChoiceName]) && ($aSelectedComponents[$sChoiceName] == $sChoiceId))
  1388. {
  1389. $sAttributes = ' checked ';
  1390. }
  1391. $oPage->add('<div class="choice"><input class="wiz-choice" id="choice'.$sChoiceId.'" name="choice['.$sChoiceName.']" type="radio"'.$sAttributes.' value="'.$sChoiceId.'"/>&nbsp;');
  1392. $this->DisplayChoice($oPage, $aChoice, $aSelectedComponents, $sChoiceId);
  1393. $oPage->add('</div>');
  1394. $index++;
  1395. }
  1396. }
  1397. protected function DisplayChoice($oPage, $aChoice, $aSelectedComponents, $sChoiceId)
  1398. {
  1399. $sMoreInfo = isset($aChoice['more_info']) ? $aChoice['more_info'] : '';
  1400. $oPage->add('<label for="choice'.$sChoiceId.'"><b>'.htmlentities($aChoice['title'], ENT_QUOTES, 'UTF-8').'</b></label> '.$sMoreInfo);
  1401. $sDescription = isset($aChoice['description']) ? htmlentities($aChoice['description'], ENT_QUOTES, 'UTF-8') : '';
  1402. $oPage->add('<div class="description">'.$sDescription.'<span id="sub_choices'.$sChoiceId.'">');
  1403. if (isset($aChoice['sub_options']))
  1404. {
  1405. $this->DisplayOptions($oPage, $aChoice['sub_options'], $aSelectedComponents, $sChoiceId);
  1406. }
  1407. $oPage->add('</span></div>');
  1408. }
  1409. protected function GetSourceFilePath()
  1410. {
  1411. $sSourceDir = $this->oWizard->GetParameter('source_dir');
  1412. return $sSourceDir.'/installation.xml';
  1413. }
  1414. }
  1415. /**
  1416. * Summary of the installation tasks
  1417. */
  1418. class WizStepSummary extends WizardStep
  1419. {
  1420. public function GetTitle()
  1421. {
  1422. $sMode = $this->oWizard->GetParameter('mode', 'install');
  1423. if ($sMode == 'install')
  1424. {
  1425. return 'Ready to install';
  1426. }
  1427. else
  1428. {
  1429. return 'Ready to upgrade';
  1430. }
  1431. }
  1432. public function GetPossibleSteps()
  1433. {
  1434. return array('WizStepDone');
  1435. }
  1436. /**
  1437. * Returns the label for the " Next >> " button
  1438. * @return string The label for the button
  1439. */
  1440. public function GetNextButtonLabel()
  1441. {
  1442. return ' Install ! ';
  1443. }
  1444. public function ProcessParams($bMoveForward = true)
  1445. {
  1446. return array('class' => 'WizStepDone', 'state' => '');
  1447. }
  1448. public function Display(WebPage $oPage)
  1449. {
  1450. $oPage->add_style(
  1451. <<<EOF
  1452. #params_summary {
  1453. height: 200px;
  1454. overflow: auto;
  1455. }
  1456. #params_summary div {
  1457. width:100%;
  1458. margin-top:0;
  1459. padding-top: 0.5em;
  1460. padding-left: 0;
  1461. }
  1462. #params_summary div ul {
  1463. margin-left:0;
  1464. padding-left: 20px;
  1465. }
  1466. #params_summary div.closed ul {
  1467. display:none;
  1468. }
  1469. #params_summary div li {
  1470. list-style: none;
  1471. width: 100%;
  1472. margin-left:0;
  1473. padding-left: 0em;
  1474. }
  1475. .title {
  1476. padding-left: 20px;
  1477. font-weight: bold;
  1478. cursor: pointer;
  1479. background: url(../images/minus.gif) 2px 2px no-repeat;
  1480. }
  1481. #params_summary div.closed .title {
  1482. background: url(../images/plus.gif) 2px 2px no-repeat;
  1483. }
  1484. #progress_content {
  1485. height: 200px;
  1486. overflow: auto;
  1487. text-align: center;
  1488. }
  1489. #installation_progress {
  1490. display: none;
  1491. }
  1492. EOF
  1493. );
  1494. $aInstallParams = $this->BuildConfig();
  1495. $sMode = $aInstallParams['mode'];
  1496. $sPreinstallationPhase = '';
  1497. $sDestination = ITOP_APPLICATION.(($sMode == 'install') ? ' version '.ITOP_VERSION.' is about to be installed ' : ' is about to be upgraded ');
  1498. $sDBDescription = ' <b>existing</b> database <b>'.$aInstallParams['database']['name'].'</b>';
  1499. if (($sMode == 'install') && ($this->oWizard->GetParameter('create_db') == 'yes'))
  1500. {
  1501. $sDBDescription = ' <b>new</b> database <b>'.$aInstallParams['database']['name'].'</b>';
  1502. }
  1503. $sDestination .= 'into the '.$sDBDescription.' on the server <b>'.$aInstallParams['database']['server'].'</b>.';
  1504. $oPage->add('<h2>'.$sDestination.'</h2>');
  1505. $oPage->add('<fieldset id="summary"><legend>Installation Parameters</legend>');
  1506. $oPage->add('<div id="params_summary">');
  1507. $oPage->add('<div class="closed"><span class="title">Database Parameters</span><ul>');
  1508. $oPage->add('<li>Server Name: '.$aInstallParams['database']['server'].'</li>');
  1509. $oPage->add('<li>DB User Name: '.$aInstallParams['database']['user'].'</li>');
  1510. $oPage->add('<li>DB user password: '.$aInstallParams['database']['pwd'].'</li>');
  1511. if (($sMode == 'install') && ($this->oWizard->GetParameter('create_db') == 'yes'))
  1512. {
  1513. $oPage->add('<li>Database Name: '.$aInstallParams['database']['name'].' (will be created)</li>');
  1514. }
  1515. else
  1516. {
  1517. $oPage->add('<li>Database Name: '.$aInstallParams['database']['name'].'</li>');
  1518. }
  1519. if ($aInstallParams['database']['prefix'] != '')
  1520. {
  1521. $oPage->add('<li>Prefix for the '.ITOP_APPLICATION.' tables: '.$aInstallParams['database']['prefix'].'</li>');
  1522. }
  1523. else
  1524. {
  1525. $oPage->add('<li>Prefix for the '.ITOP_APPLICATION.' tables: none</li>');
  1526. }
  1527. $oPage->add('</ul></div>');
  1528. $oPage->add('<div><span class="title">Data Model Configuration</span>');
  1529. $oPage->add($this->oWizard->GetParameter('display_choices'));
  1530. $oPage->add('</div>');
  1531. $oPage->add('<div class="closed"><span class="title">Other Parameters</span><ul>');
  1532. if ($sMode == 'install')
  1533. {
  1534. $oPage->add('<li>Default language: '.$aInstallParams['language'].'</li>');
  1535. }
  1536. $oPage->add('<li>URL to access the application: '.$aInstallParams['url'].'</li>');
  1537. if ($aInstallParams['sample_data'] == 'yes')
  1538. {
  1539. $oPage->add('<li>Sample data will be loaded into the database.</li>');
  1540. }
  1541. if ($aInstallParams['old_addon'])
  1542. {
  1543. $oPage->add('<li>Compatibility mode: Using the version 1.2 of the UserRightsProfiles add-on.</li>');
  1544. }
  1545. $oPage->add('</ul></div>');
  1546. if ($sMode == 'install')
  1547. {
  1548. $oPage->add('<div class="closed"><span class="title">Admininistrator Account</span><ul>');
  1549. $oPage->add('<li>Login: '.$aInstallParams['admin_account']['user'].'</li>');
  1550. $oPage->add('<li>Password: '.$aInstallParams['admin_account']['pwd'].'</li>');
  1551. $oPage->add('<li>Language: '.$aInstallParams['admin_account']['language'].'</li>');
  1552. $oPage->add('</ul></div>');
  1553. }
  1554. $aMiscOptions = $aInstallParams['options'];
  1555. if (count($aMiscOptions) > 0)
  1556. {
  1557. $oPage->add('<div class="closed"><span class="title">Miscellaneous Options</span><ul>');
  1558. foreach($aMiscOptions as $sKey => $sValue)
  1559. {
  1560. $oPage->add('<li>'.$sKey.': '.$sValue.'</li>');
  1561. }
  1562. $oPage->add('</ul></div>');
  1563. }
  1564. $aSelectedModules = $aInstallParams['selected_modules'];
  1565. if (isset($aMiscOptions['generate_config']))
  1566. {
  1567. $oDoc = new DOMDocument('1.0', 'UTF-8');
  1568. $oDoc->preserveWhiteSpace = false;
  1569. $oDoc->formatOutput = true;
  1570. $oParams = new PHPParameters();
  1571. $oParams->LoadFromHash($aInstallParams);
  1572. $oParams->ToXML($oDoc, null, 'installation');
  1573. $sXML = $oDoc->saveXML();
  1574. $oPage->add('<div class="closed"><span class="title">XML Config file</span><ul><pre>');
  1575. $oPage->add(htmlentities($sXML, ENT_QUOTES, 'UTF-8'));
  1576. $oPage->add('</pre></ul></div>');
  1577. }
  1578. $oPage->add('</div>'); // params_summary
  1579. $oPage->add('</fieldset>');
  1580. $oPage->add('<fieldset id="installation_progress"><legend>Progress of the installation</legend>');
  1581. $oPage->add('<div id="progress_content">');
  1582. $oPage->add_linked_script('../setup/jquery.progression.js');
  1583. $oPage->add('<p class="center"><span id="setup_msg">Ready to start...</span></p><div style="display:block;margin-left: auto; margin-right:auto;" id="progress">0%</div>');
  1584. $oPage->add('</div>'); // progress_content
  1585. $oPage->add('</fieldset>');
  1586. $sJSONData = json_encode($aInstallParams);
  1587. $oPage->add('<input type="hidden" id="installer_parameters" value="'.htmlentities($sJSONData, ENT_QUOTES, 'UTF-8').'"/>');
  1588. $oPage->add_ready_script(
  1589. <<<EOF
  1590. $("#params_summary div").addClass('closed');
  1591. $("#params_summary .title").click(function() { $(this).parent().toggleClass('closed'); } );
  1592. $("#btn_next").bind("click.install", function(event) {
  1593. $('#summary').hide();
  1594. $('#installation_progress').show();
  1595. $(this).attr("disabled", "disabled"); event.preventDefault(); ExecuteStep("");
  1596. });
  1597. $("#wiz_form").data("installation_status", "not started")
  1598. EOF
  1599. );
  1600. }
  1601. /**
  1602. * Prepare the parameters to execute the installation asynchronously
  1603. * @return Hash A big hash array that can be converted to XML or JSON with all the needed parameters
  1604. */
  1605. protected function BuildConfig()
  1606. {
  1607. $sMode = $this->oWizard->GetParameter('install_mode', 'install');
  1608. $aSelectedModules = json_decode($this->oWizard->GetParameter('selected_modules'), true);
  1609. $sBackupDestination = '';
  1610. $sPreviousConfigurationFile = '';
  1611. $sDBName = $this->oWizard->GetParameter('db_name');
  1612. if ($sMode == 'upgrade')
  1613. {
  1614. $sPreviousVersionDir = $this->oWizard->GetParameter('previous_version_dir', '');
  1615. if (!empty($sPreviousVersionDir))
  1616. {
  1617. $aPreviousInstance = SetupUtils::GetPreviousInstance($sPreviousVersionDir);
  1618. if ($aPreviousInstance['found'])
  1619. {
  1620. $sPreviousConfigurationFile = $aPreviousInstance['configuration_file'];
  1621. }
  1622. }
  1623. if ($this->oWizard->GetParameter('db_backup', false))
  1624. {
  1625. $sBackupDestination = $this->oWizard->GetParameter('db_backup_path', '');
  1626. }
  1627. }
  1628. else
  1629. {
  1630. $sDBNewName = $this->oWizard->GetParameter('db_new_name', '');
  1631. if ($sDBNewName != '')
  1632. {
  1633. $sDBName = $sDBNewName; // Database will be created
  1634. }
  1635. }
  1636. $sSourceDir = $this->oWizard->GetParameter('source_dir');
  1637. $aCopies = array();
  1638. if (($sMode == 'upgrade') && ($this->oWizard->GetParameter('upgrade_type') == 'keep-previous'))
  1639. {
  1640. $sPreviousVersionDir = $this->oWizard->GetParameter('previous_version_dir');
  1641. $aCopies[] = array('source' => $sSourceDir, 'destination' => 'modules'); // Source is an absolute path, destination is relative to APPROOT
  1642. $aCopies[] = array('source' => $sPreviousVersionDir.'/portal', 'destination' => 'portal'); // Source is an absolute path, destination is relative to APPROOT
  1643. $sSourceDir = APPROOT.'modules';
  1644. }
  1645. if (($sMode == 'upgrade'))
  1646. {
  1647. // Copy the previous extensions, if any
  1648. $sPreviousExtensionsDir = $this->oWizard->GetParameter('copy_extensions_from');
  1649. if (is_dir($sPreviousExtensionsDir))
  1650. {
  1651. // Copy the extensions one by one to merge them with the existing extensions in /extensions
  1652. $aExtensions = glob($sPreviousExtensionsDir.'/*', GLOB_ONLYDIR);
  1653. foreach($aExtensions as $sDirPath)
  1654. {
  1655. $sExtName = basename($sDirPath);
  1656. $aCopies[] = array('source' => $sDirPath, 'destination' => 'extensions/'.$sExtName); // Source is an absolute path, destination is relative to APPROOT
  1657. }
  1658. }
  1659. }
  1660. $aInstallParams = array (
  1661. 'mode' => $sMode,
  1662. 'preinstall' => array (
  1663. 'copies' => $aCopies,
  1664. // 'backup' => see below
  1665. ),
  1666. 'source_dir' => str_replace(APPROOT, '', $sSourceDir),
  1667. 'datamodel_version' => $this->oWizard->GetParameter('datamodel_version'), //TODO: let the installer compute this automatically...
  1668. 'previous_configuration_file' => $sPreviousConfigurationFile,
  1669. 'extensions_dir' => 'extensions',
  1670. 'target_env' => 'production',
  1671. 'workspace_dir' => '',
  1672. 'database' => array (
  1673. 'server' => $this->oWizard->GetParameter('db_server'),
  1674. 'user' => $this->oWizard->GetParameter('db_user'),
  1675. 'pwd' => $this->oWizard->GetParameter('db_pwd'),
  1676. 'name' => $sDBName,
  1677. 'prefix' => $this->oWizard->GetParameter('db_prefix'),
  1678. ),
  1679. 'url' => $this->oWizard->GetParameter('application_url'),
  1680. 'admin_account' => array (
  1681. 'user' => $this->oWizard->GetParameter('admin_user'),
  1682. 'pwd' => $this->oWizard->GetParameter('admin_pwd'),
  1683. 'language' => $this->oWizard->GetParameter('admin_language'),
  1684. ),
  1685. 'language' => $this->oWizard->GetParameter('default_language'),
  1686. 'selected_modules' => $aSelectedModules,
  1687. 'sample_data' => ($this->oWizard->GetParameter('sample_data', '') == 'yes') ? true : false ,
  1688. 'old_addon' => $this->oWizard->GetParameter('old_addon', false), // whether or not to use the "old" userrights profile addon
  1689. 'options' => json_decode($this->oWizard->GetParameter('misc_options', '[]'), true),
  1690. );
  1691. if ($sBackupDestination != '')
  1692. {
  1693. $aInstallParams['preinstall']['backup'] = array (
  1694. 'destination' => $sBackupDestination,
  1695. 'configuration_file' => $sPreviousConfigurationFile,
  1696. );
  1697. }
  1698. return $aInstallParams;
  1699. }
  1700. public function AsyncAction(WebPage $oPage, $sCode, $aParameters)
  1701. {
  1702. $oParameters = new PHPParameters();
  1703. $sStep = $aParameters['installer_step'];
  1704. $sJSONParameters = $aParameters['installer_config'];
  1705. $oParameters->LoadFromHash(json_decode($sJSONParameters, true /* bAssoc */));
  1706. $oInstaller = new ApplicationInstaller($oParameters);
  1707. $aRes = $oInstaller->ExecuteStep($sStep);
  1708. if (($aRes['status'] != ApplicationInstaller::ERROR) && ($aRes['next-step'] != ''))
  1709. {
  1710. // Tell the web page to move the progress bar and to launch the next step
  1711. $sMessage = addslashes(htmlentities($aRes['next-step-label'], ENT_QUOTES, 'UTF-8'));
  1712. $oPage->add_ready_script(
  1713. <<<EOF
  1714. $("#wiz_form").data("installation_status", "running");
  1715. WizardUpdateButtons();
  1716. $('#setup_msg').html('$sMessage');
  1717. $('#progress').progression( {Current:{$aRes['percentage-completed']}, Maximum: 100, aBackgroundImg: GetAbsoluteUrlAppRoot()+'setup/orange-progress.gif', aTextColor: '#000000'} );
  1718. //$("#percentage").html('{$aRes['percentage-completed']} % completed<br/>{$aRes['next-step-label']}');
  1719. ExecuteStep('{$aRes['next-step']}');
  1720. EOF
  1721. );
  1722. }
  1723. else if ($aRes['status'] != ApplicationInstaller::ERROR)
  1724. {
  1725. // Installation complete, move to the next step of the wizard
  1726. $oPage->add_ready_script(
  1727. <<<EOF
  1728. $("#wiz_form").data("installation_status", "completed");
  1729. $('#progress').progression( {Current:100, Maximum: 100, aBackgroundImg: GetAbsoluteUrlAppRoot()+'setup/orange-progress.gif', aTextColor: '#000000'} );
  1730. WizardUpdateButtons();
  1731. $("#btn_next").unbind("click.install");
  1732. $("#btn_next").click();
  1733. EOF
  1734. );
  1735. }
  1736. else
  1737. {
  1738. $sMessage = addslashes(htmlentities($aRes['message'], ENT_QUOTES, 'UTF-8'));
  1739. $oPage->add_ready_script(
  1740. <<<EOF
  1741. $("#wiz_form").data("installation_status", "error");
  1742. WizardUpdateButtons();
  1743. $('#setup_msg').html('$sMessage');
  1744. EOF
  1745. );
  1746. }
  1747. }
  1748. /**
  1749. * Tells whether the "Next" button should be enabled interactively
  1750. * @return string A piece of javascript code returning either true or false
  1751. */
  1752. public function JSCanMoveForward()
  1753. {
  1754. return 'return (($("#wiz_form").data("installation_status") === "not started") || ($("#wiz_form").data("installation_status") === "completed"));';
  1755. }
  1756. /**
  1757. * Tells whether the "Next" button should be enabled interactively
  1758. * @return string A piece of javascript code returning either true or false
  1759. */
  1760. public function JSCanMoveBackward()
  1761. {
  1762. return 'var sStatus = $("#wiz_form").data("installation_status"); return ((sStatus === "not started") || (sStatus === "error"));';
  1763. }
  1764. }
  1765. /**
  1766. * Summary of the installation tasks
  1767. */
  1768. class WizStepDone extends WizardStep
  1769. {
  1770. public function GetTitle()
  1771. {
  1772. return 'Done';
  1773. }
  1774. public function GetPossibleSteps()
  1775. {
  1776. return array();
  1777. }
  1778. public function ProcessParams($bMoveForward = true)
  1779. {
  1780. return array('class' => '', 'state' => '');
  1781. }
  1782. public function Display(WebPage $oPage)
  1783. {
  1784. // Check if there are some manual steps required:
  1785. $aManualSteps = array();
  1786. $aAvailableModules = SetupUtils::AnalyzeInstallation($this->oWizard);
  1787. $sRootUrl = utils::GetAbsoluteUrlAppRoot();
  1788. $aSelectedModules = json_decode($this->oWizard->GetParameter('selected_modules'), true);
  1789. foreach($aSelectedModules as $sModuleId)
  1790. {
  1791. if (!empty($aAvailableModules[$sModuleId]['doc.manual_setup']))
  1792. {
  1793. $aManualSteps[$aAvailableModules[$sModuleId]['label']] = $sRootUrl.$aAvailableModules[$sModuleId]['doc.manual_setup'];
  1794. }
  1795. }
  1796. if (count($aManualSteps) > 0)
  1797. {
  1798. $oPage->add("<h2>Manual operations required</h2>");
  1799. $oPage->p("In order to complete the installation, the following manual operations are required:");
  1800. foreach($aManualSteps as $sModuleLabel => $sUrl)
  1801. {
  1802. $oPage->p("<a href=\"$sUrl\" target=\"_blank\">Manual instructions for $sModuleLabel</a>");
  1803. }
  1804. $oPage->add("<h2>Congratulations for installing iTop</h2>");
  1805. }
  1806. else
  1807. {
  1808. $oPage->add("<h2>Congratulations for installing iTop</h2>");
  1809. $oPage->ok("The installation completed successfully.");
  1810. }
  1811. if ($this->oWizard->GetParameter('db_backup', false))
  1812. {
  1813. $sBackupDestination = $this->oWizard->GetParameter('db_backup_path', '');
  1814. if (file_exists($sBackupDestination))
  1815. {
  1816. // To mitigate security risks: pass only the filename without the extension, the download will add the extensino itself
  1817. $sTruncatedFilePath = preg_replace('/\.zip$/', '', $sBackupDestination);
  1818. $oPage->p('Your backup is ready');
  1819. $oPage->p('<a style="background:transparent;" href="'.utils::GetAbsoluteUrlAppRoot().'setup/ajax.dataloader.php?operation=async_action&step_class=WizStepDone&params[backup]='.urlencode($sTruncatedFilePath).'" target="_blank"><img src="../images/tar.png" style="border:0;vertical-align:middle;">&nbspDownload '.basename($sBackupDestination).'</a>');
  1820. }
  1821. else
  1822. {
  1823. $oPage->p('<img src="../images/error.png"/>&nbsp;Warning: Backup creation failed !');
  1824. }
  1825. }
  1826. // Form goes here.. No back button since the job is done !
  1827. $oPage->add('<table style="width:600px;border:0;padding:0;"><tr>');
  1828. $oPage->add("<td><a style=\"background:transparent;padding:0;\" title=\"Free: Register your iTop version.\" href=\"http://www.combodo.com/register?product=iTop&version=".urlencode(ITOP_VERSION." revision ".ITOP_REVISION)."\" target=\"_blank\"><img style=\"border:0\" src=\"../images/setup-register.gif\"/></td></a>");
  1829. $oPage->add("<td><a style=\"background:transparent;padding:0;\" title=\"Get Professional Support from Combodo\" href=\"http://www.combodo.com/itopsupport\" target=\"_blank\"><img style=\"border:0\" src=\"../images/setup-support.gif\"/></td></a>");
  1830. $oPage->add("<td><a style=\"background:transparent;padding:0;\" title=\"Get Professional Training from Combodo\" href=\"http://www.combodo.com/itoptraining\" target=\"_blank\"><img style=\"border:0\" src=\"../images/setup-training.gif\"/></td></a>");
  1831. $oPage->add('</tr></table>');
  1832. $sForm = '<form method="post" action="'.$this->oWizard->GetParameter('application_url').'pages/UI.php">';
  1833. $sForm .= '<input type="hidden" name="auth_user" value="'.htmlentities($this->oWizard->GetParameter('admin_user'), ENT_QUOTES, 'UTF-8').'">';
  1834. $sForm .= '<input type="hidden" name="auth_pwd" value="'.htmlentities($this->oWizard->GetParameter('admin_pwd'), ENT_QUOTES, 'UTF-8').'">';
  1835. $sForm .= "<p style=\"text-align:center;width:100%\"><button id=\"enter_itop\" type=\"submit\">Enter iTop</button></p>";
  1836. $sForm .= '</form>';
  1837. $oPage->add('<img style="border:0" src="http://www.combodo.com/stats/?p='.urlencode(ITOP_APPLICATION).'&v='.urlencode(ITOP_VERSION).'"/>');
  1838. $sForm = addslashes($sForm);
  1839. $oPage->add_ready_script("$('#wiz_form').after('$sForm');");
  1840. }
  1841. public function CanMoveForward()
  1842. {
  1843. return false;
  1844. }
  1845. public function CanMoveBackward()
  1846. {
  1847. return false;
  1848. }
  1849. /**
  1850. * Tells whether this step of the wizard requires that the configuration file be writable
  1851. * @return bool True if the wizard will possibly need to modify the configuration at some point
  1852. */
  1853. public function RequiresWritableConfig()
  1854. {
  1855. return false; //This step executes once the config was written and secured
  1856. }
  1857. public function AsyncAction(WebPage $oPage, $sCode, $aParameters)
  1858. {
  1859. $oParameters = new PHPParameters();
  1860. // For security reasons: add the extension now so that this action can be used to read *only* .zip files from the disk...
  1861. $sBackupFile = $aParameters['backup'].'.zip';
  1862. if (file_exists($sBackupFile))
  1863. {
  1864. // Make sure there is NO output at all before our content, otherwise the document will be corrupted
  1865. $sPreviousContent = ob_get_clean();
  1866. $oPage->SetContentType('application/zip');
  1867. $oPage->SetContentDisposition('attachment', basename($sBackupFile));
  1868. $oPage->add(file_get_contents($sBackupFile));
  1869. }
  1870. }
  1871. }