setuputils.class.inc.php 43 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322
  1. <?php
  2. // Copyright (C) 2010-2012 Combodo SARL
  3. //
  4. // This file is part of iTop.
  5. //
  6. // iTop is free software; you can redistribute it and/or modify
  7. // it under the terms of the GNU Affero General Public License as published by
  8. // the Free Software Foundation, either version 3 of the License, or
  9. // (at your option) any later version.
  10. //
  11. // iTop is distributed in the hope that it will be useful,
  12. // but WITHOUT ANY WARRANTY; without even the implied warranty of
  13. // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  14. // GNU Affero General Public License for more details.
  15. //
  16. // You should have received a copy of the GNU Affero General Public License
  17. // along with iTop. If not, see <http://www.gnu.org/licenses/>
  18. /**
  19. * The standardized result of any pass/fail check performed by the setup
  20. * @copyright Copyright (C) 2010-2012 Combodo SARL
  21. * @license http://opensource.org/licenses/AGPL-3.0
  22. */
  23. class CheckResult
  24. {
  25. // Severity levels
  26. const ERROR = 0;
  27. const WARNING = 1;
  28. const INFO = 2;
  29. public $iSeverity;
  30. public $sLabel;
  31. public $sDescription;
  32. public function __construct($iSeverity, $sLabel, $sDescription = '')
  33. {
  34. $this->iSeverity = $iSeverity;
  35. $this->sLabel = $sLabel;
  36. $this->sDescription = $sDescription;
  37. }
  38. }
  39. /**
  40. * Namespace for storing all the functions/utilities needed by both
  41. * the setup wizard and the installation process
  42. * @copyright Copyright (C) 2010-2012 Combodo SARL
  43. * @license http://opensource.org/licenses/AGPL-3.0
  44. */
  45. class SetupUtils
  46. {
  47. const PHP_MIN_VERSION = '5.2.0';
  48. const MYSQL_MIN_VERSION = '5.0.0';
  49. const MIN_MEMORY_LIMIT = 33554432; // = 32*1024*1024 Beware: Computations are not allowed in defining constants
  50. const SUHOSIN_GET_MAX_VALUE_LENGTH = 2048;
  51. /**
  52. * Check the version of PHP, the needed PHP extension and a number
  53. * of configuration parameters (memory_limit, max_upload_file_size, etc...)
  54. * @param SetupPage $oP The page used only for its 'log' method
  55. * @return array An array of CheckResults objects
  56. */
  57. static function CheckPHPVersion()
  58. {
  59. $aResult = array();
  60. // For log file(s)
  61. if (!is_dir(APPROOT.'log'))
  62. {
  63. @mkdir(APPROOT.'log');
  64. }
  65. SetupPage::log('Info - CheckPHPVersion');
  66. if (version_compare(phpversion(), self::PHP_MIN_VERSION, '>='))
  67. {
  68. $aResult[] = new CheckResult(CheckResult::INFO, "The current PHP Version (".phpversion().") is greater than the minimum version required to run ".ITOP_APPLICATION.", which is (".self::PHP_MIN_VERSION.")");
  69. }
  70. else
  71. {
  72. $aResult[] = new CheckResult(CheckResult::ERROR, "Error: The current PHP Version (".phpversion().") is lower than the minimum version required to run ".ITOP_APPLICATION.", which is (".self::PHP_MIN_VERSION.")");
  73. }
  74. // Check the common directories
  75. $aWritableDirsErrors = self::CheckWritableDirs(array('log', 'env-production', 'conf', 'data'));
  76. $aResult = array_merge($aResult, $aWritableDirsErrors);
  77. $aMandatoryExtensions = array('mysqli', 'iconv', 'simplexml', 'soap', 'hash', 'json', 'session', 'pcre', 'dom');
  78. $aOptionalExtensions = array('mcrypt' => 'Strong encryption will not be used.',
  79. 'ldap' => 'LDAP authentication will be disabled.');
  80. asort($aMandatoryExtensions); // Sort the list to look clean !
  81. ksort($aOptionalExtensions); // Sort the list to look clean !
  82. $aExtensionsOk = array();
  83. $aMissingExtensions = array();
  84. $aMissingExtensionsLinks = array();
  85. // First check the mandatory extensions
  86. foreach($aMandatoryExtensions as $sExtension)
  87. {
  88. if (extension_loaded($sExtension))
  89. {
  90. $aExtensionsOk[] = $sExtension;
  91. }
  92. else
  93. {
  94. $aMissingExtensions[] = $sExtension;
  95. $aMissingExtensionsLinks[] = "<a href=\"http://www.php.net/manual/en/book.$sExtension.php\" target=\"_blank\">$sExtension</a>";
  96. }
  97. }
  98. if (count($aExtensionsOk) > 0)
  99. {
  100. $aResult[] = new CheckResult(CheckResult::INFO, "Required PHP extension(s): ".implode(', ', $aExtensionsOk).".");
  101. }
  102. if (count($aMissingExtensions) > 0)
  103. {
  104. $aResult[] = new CheckResult(CheckResult::ERROR, "Missing PHP extension(s): ".implode(', ', $aMissingExtensionsLinks).".");
  105. }
  106. // Next check the optional extensions
  107. $aExtensionsOk = array();
  108. $aMissingExtensions = array();
  109. foreach($aOptionalExtensions as $sExtension => $sMessage)
  110. {
  111. if (extension_loaded($sExtension))
  112. {
  113. $aExtensionsOk[] = $sExtension;
  114. }
  115. else
  116. {
  117. $aMissingExtensions[$sExtension] = $sMessage;
  118. }
  119. }
  120. if (count($aExtensionsOk) > 0)
  121. {
  122. $aResult[] = new CheckResult(CheckResult::INFO, "Optional PHP extension(s): ".implode(', ', $aExtensionsOk).".");
  123. }
  124. if (count($aMissingExtensions) > 0)
  125. {
  126. foreach($aMissingExtensions as $sExtension => $sMessage)
  127. {
  128. $aResult[] = new CheckResult(CheckResult::WARNING, "Missing optional PHP extension: $sExtension. ".$sMessage);
  129. }
  130. }
  131. // Check some ini settings here
  132. if (function_exists('php_ini_loaded_file')) // PHP >= 5.2.4
  133. {
  134. $sPhpIniFile = php_ini_loaded_file();
  135. // Other included/scanned files
  136. if ($sFileList = php_ini_scanned_files())
  137. {
  138. if (strlen($sFileList) > 0)
  139. {
  140. $aFiles = explode(',', $sFileList);
  141. foreach ($aFiles as $sFile)
  142. {
  143. $sPhpIniFile .= ', '.trim($sFile);
  144. }
  145. }
  146. }
  147. SetupPage::log("Info - php.ini file(s): '$sPhpIniFile'");
  148. }
  149. else
  150. {
  151. $sPhpIniFile = 'php.ini';
  152. }
  153. if (!ini_get('file_uploads'))
  154. {
  155. $aResult[] = new CheckResult(CheckResult::ERROR, "Files upload is not allowed on this server (file_uploads = ".ini_get('file_uploads').").");
  156. }
  157. $sUploadTmpDir = self::GetUploadTmpDir();
  158. if (empty($sUploadTmpDir))
  159. {
  160. $sUploadTmpDir = '/tmp';
  161. $aResult[] = new CheckResult(CheckResult::WARNING, "Temporary directory for files upload is not defined (upload_tmp_dir), assuming that $sUploadTmpDir is used.");
  162. }
  163. // check that the upload directory is indeed writable from PHP
  164. if (!empty($sUploadTmpDir))
  165. {
  166. if (!file_exists($sUploadTmpDir))
  167. {
  168. $aResult[] = new CheckResult(CheckResult::ERROR, "Temporary directory for files upload ($sUploadTmpDir) does not exist or cannot be read by PHP.");
  169. }
  170. else if (!is_writable($sUploadTmpDir))
  171. {
  172. $aResult[] = new CheckResult(CheckResult::ERROR, "Temporary directory for files upload ($sUploadTmpDir) is not writable.");
  173. }
  174. else
  175. {
  176. SetupPage::log("Info - Temporary directory for files upload ($sUploadTmpDir) is writable.");
  177. }
  178. }
  179. if (!ini_get('upload_max_filesize'))
  180. {
  181. $aResult[] = new CheckResult(CheckResult::ERROR, "File upload is not allowed on this server (upload_max_filesize = ".ini_get('upload_max_filesize').").");
  182. }
  183. $iMaxFileUploads = ini_get('max_file_uploads');
  184. if (!empty($iMaxFileUploads) && ($iMaxFileUploads < 1))
  185. {
  186. $aResult[] = new CheckResult(CheckResult::ERROR, "File upload is not allowed on this server (max_file_uploads = ".ini_get('max_file_uploads').").");
  187. }
  188. $iMaxUploadSize = utils::ConvertToBytes(ini_get('upload_max_filesize'));
  189. $iMaxPostSize = utils::ConvertToBytes(ini_get('post_max_size'));
  190. if ($iMaxPostSize <= $iMaxUploadSize)
  191. {
  192. $aResult[] = new CheckResult(CheckResult::WARNING, "post_max_size (".ini_get('post_max_size').") in php.ini should be strictly greater than upload_max_filesize (".ini_get('upload_max_filesize').") otherwise you cannot upload files of the maximum size.");
  193. }
  194. SetupPage::log("Info - upload_max_filesize: ".ini_get('upload_max_filesize'));
  195. SetupPage::log("Info - post_max_size: ".ini_get('post_max_size'));
  196. SetupPage::log("Info - max_file_uploads: ".ini_get('max_file_uploads'));
  197. // Check some more ini settings here, needed for file upload
  198. if (function_exists('get_magic_quotes_gpc'))
  199. {
  200. if (@get_magic_quotes_gpc())
  201. {
  202. $aResult[] = new CheckResult(CheckResult::ERROR, "'magic_quotes_gpc' is set to On. Please turn it Off in php.ini before continuing.");
  203. }
  204. }
  205. if (function_exists('magic_quotes_runtime'))
  206. {
  207. if (@magic_quotes_runtime())
  208. {
  209. $aResult[] = new CheckResult(CheckResult::ERROR, "'magic_quotes_runtime' is set to On. Please turn it Off in php.ini before continuing.");
  210. }
  211. }
  212. $sMemoryLimit = trim(ini_get('memory_limit'));
  213. if (empty($sMemoryLimit))
  214. {
  215. // On some PHP installations, memory_limit does not exist as a PHP setting!
  216. // (encountered on a 5.2.0 under Windows)
  217. // In that case, ini_set will not work, let's keep track of this and proceed anyway
  218. $aResult[] = new CheckResult(CheckResult::WARNING, "No memory limit has been defined in this instance of PHP");
  219. }
  220. else
  221. {
  222. // Check that the limit will allow us to load the data
  223. //
  224. $iMemoryLimit = utils::ConvertToBytes($sMemoryLimit);
  225. if ($iMemoryLimit < self::MIN_MEMORY_LIMIT)
  226. {
  227. $aResult[] = new CheckResult(CheckResult::ERROR, "memory_limit ($iMemoryLimit) is too small, the minimum value to run the application is ".self::MIN_MEMORY_LIMIT.".");
  228. }
  229. else
  230. {
  231. SetupPage::log("Info - memory_limit is $iMemoryLimit, ok.");
  232. }
  233. }
  234. // Special case for APC
  235. if (extension_loaded('apc'))
  236. {
  237. $sAPCVersion = phpversion('apc');
  238. $aResult[] = new CheckResult(CheckResult::INFO, "APC detected (version $sAPCVersion). The APC cache will be used to speed-up ".ITOP_APPLICATION.".");
  239. }
  240. // Special case Suhosin extension
  241. if (extension_loaded('suhosin'))
  242. {
  243. $sSuhosinVersion = phpversion('suhosin');
  244. $aOk[] = "Suhosin extension detected (version $sSuhosinVersion).";
  245. $iGetMaxValueLength = ini_get('suhosin.get.max_value_length');
  246. if ($iGetMaxValueLength < self::SUHOSIN_GET_MAX_VALUE_LENGTH)
  247. {
  248. $aResult[] = new CheckResult(CheckResult::WARNING, "suhosin.get.max_value_length ($iGetMaxValueLength) is too small, the minimum value recommended to run the application is ".self::SUHOSIN_GET_MAX_VALUE_LENGTH.".");
  249. }
  250. else
  251. {
  252. SetupPage::log("Info - suhosin.get.max_value_length = $iGetMaxValueLength, ok.");
  253. }
  254. }
  255. if (function_exists('php_ini_loaded_file')) // PHP >= 5.2.4
  256. {
  257. $sPhpIniFile = php_ini_loaded_file();
  258. // Other included/scanned files
  259. if ($sFileList = php_ini_scanned_files())
  260. {
  261. if (strlen($sFileList) > 0)
  262. {
  263. $aFiles = explode(',', $sFileList);
  264. foreach ($aFiles as $sFile)
  265. {
  266. $sPhpIniFile .= ', '.trim($sFile);
  267. }
  268. }
  269. }
  270. $aResult[] = new CheckResult(CheckResult::INFO, "Loaded php.ini files: $sPhpIniFile");
  271. }
  272. // Check the configuration of the sessions persistence, since this is critical for the authentication
  273. if (ini_get('session.save_handler') == 'files')
  274. {
  275. $sSavePath = ini_get('session.save_path');
  276. SetupPage::log("Info - session.save_path is: '$sSavePath'.");
  277. // According to the PHP documentation, the format can be /path/where/to_save_sessions or "N;/path/where/to_save_sessions" or "N;MODE;/path/where/to_save_sessions"
  278. $sSavePath = ltrim(rtrim($sSavePath, '"'), '"'); // remove surrounding quotes (if any)
  279. if (!empty($sSavePath))
  280. {
  281. if (($iPos = strrpos($sSavePath, ';', 0)) !== false)
  282. {
  283. // The actual path is after the last semicolon
  284. $sSavePath = substr($sSavePath, $iPos+1);
  285. }
  286. if (!is_writable($sSavePath))
  287. {
  288. $aResult[] = new CheckResult(CheckResult::ERROR, "The value for session.save_path ($sSavePath) is not writable for the web server. Make sure that PHP can actually save session variables. (Refer to the PHP documentation: http://php.net/manual/en/session.configuration.php#ini.session.save-path)");
  289. }
  290. else
  291. {
  292. $aResult[] = new CheckResult(CheckResult::INFO, "The value for session.save_path ($sSavePath) is writable for the web server.");
  293. }
  294. }
  295. else
  296. {
  297. $aResult[] = new CheckResult(CheckResult::WARNING, "Empty path for session.save_path. Make sure that PHP can actually save session variables. (Refer to the PHP documentation: http://php.net/manual/en/session.configuration.php#ini.session.save-path)");
  298. }
  299. }
  300. else
  301. {
  302. $aResult[] = new CheckResult(CheckResult::INFO, "session.save_handler is: '".ini_get('session.save_handler')."' (different from 'files').");
  303. }
  304. return $aResult;
  305. }
  306. /**
  307. * Check that the backup could be executed
  308. * @param Page $oP The page used only for its 'log' method
  309. * @return array An array of CheckResults objects
  310. */
  311. static function CheckBackupPrerequisites($sDestDir)
  312. {
  313. $aResult = array();
  314. SetupPage::log('Info - CheckBackupPrerequisites');
  315. // zip extension
  316. //
  317. if (!extension_loaded('zip'))
  318. {
  319. $sMissingExtensionLink = "<a href=\"http://www.php.net/manual/en/book.zip.php\" target=\"_blank\">zip</a>";
  320. $aResult[] = new CheckResult(CheckResult::ERROR, "Missing PHP extension: zip", $sMissingExtensionLink);
  321. }
  322. // availability of exec()
  323. //
  324. $aDisabled = explode(', ', ini_get('disable_functions'));
  325. SetupPage::log('Info - PHP functions disabled: '.implode(', ', $aDisabled));
  326. if (in_array('exec', $aDisabled))
  327. {
  328. $aResult[] = new CheckResult(CheckResult::ERROR, "The PHP exec() function has been disabled on this server");
  329. }
  330. // availability of mysqldump
  331. $sMySQLBinDir = utils::ReadParam('mysql_bindir', '', true);
  332. if (empty($sMySQLBinDir))
  333. {
  334. $sMySQLDump = 'mysqldump';
  335. }
  336. else
  337. {
  338. SetupPage::log('Info - Found mysql_bindir: '.$sMySQLBinDir);
  339. $sMySQLDump = '"'.$sMySQLBinDir.'/mysqldump"';
  340. }
  341. $sCommand = "$sMySQLDump -V 2>&1";
  342. $aOutput = array();
  343. $iRetCode = 0;
  344. exec($sCommand, $aOutput, $iRetCode);
  345. if ($iRetCode == 0)
  346. {
  347. $aResult[] = new CheckResult(CheckResult::INFO, "mysqldump is present: ".$aOutput[0]);
  348. }
  349. elseif ($iRetCode == 1)
  350. {
  351. $aResult[] = new CheckResult(CheckResult::ERROR, "mysqldump could not be found: ".implode(' ', $aOutput)." - Please make sure it is installed and in the path.");
  352. }
  353. else
  354. {
  355. $aResult[] = new CheckResult(CheckResult::ERROR, "mysqldump could not be executed (retcode=$iRetCode): Please make sure it is installed and in the path");
  356. }
  357. foreach($aOutput as $sLine)
  358. {
  359. SetupPage::log('Info - mysqldump -V said: '.$sLine);
  360. }
  361. // check disk space
  362. // to do... evaluate how we can correlate the DB size with the size of the dump (and the zip!)
  363. // E.g. 2,28 Mb after a full install, giving a zip of 26 Kb (data = 26 Kb)
  364. // Example of query (DB without a suffix)
  365. //$sDBSize = "SELECT SUM(ROUND(DATA_LENGTH/1024/1024, 2)) AS size_mb FROM INFORMATION_SCHEMA.TABLES WHERE TABLE_SCHEMA = `$sDBName`";
  366. return $aResult;
  367. }
  368. /**
  369. * Helper function to retrieve the system's temporary directory
  370. * Emulates sys_get_temp_dir if neeed (PHP < 5.2.1)
  371. * @return string Path to the system's temp directory
  372. */
  373. static function GetTmpDir()
  374. {
  375. // try to figure out what is the temporary directory
  376. // prior to PHP 5.2.1 the function sys_get_temp_dir
  377. // did not exist
  378. if ( !function_exists('sys_get_temp_dir'))
  379. {
  380. if( $temp=getenv('TMP') ) return realpath($temp);
  381. if( $temp=getenv('TEMP') ) return realpath($temp);
  382. if( $temp=getenv('TMPDIR') ) return realpath($temp);
  383. $temp=tempnam(__FILE__,'');
  384. if (file_exists($temp))
  385. {
  386. unlink($temp);
  387. return realpath(dirname($temp));
  388. }
  389. return null;
  390. }
  391. else
  392. {
  393. return realpath(sys_get_temp_dir());
  394. }
  395. }
  396. /**
  397. * Helper function to retrieve the directory where files are to be uploaded
  398. * @return string Path to the temp directory used for uploading files
  399. */
  400. static function GetUploadTmpDir()
  401. {
  402. $sPath = ini_get('upload_tmp_dir');
  403. if (empty($sPath))
  404. {
  405. $sPath = self::GetTmpDir();
  406. }
  407. return $sPath;
  408. }
  409. /**
  410. * Helper to recursively remove a directory
  411. */
  412. public static function rrmdir($dir)
  413. {
  414. if ((strlen(trim($dir)) == 0) || ($dir == '/') || ($dir == '\\'))
  415. {
  416. throw new Exception("Attempting to delete directory: '$dir'");
  417. }
  418. self::tidydir($dir);
  419. rmdir($dir);
  420. }
  421. /**
  422. * Helper to recursively cleanup a directory
  423. */
  424. public static function tidydir($dir)
  425. {
  426. if ((strlen(trim($dir)) == 0) || ($dir == '/') || ($dir == '\\'))
  427. {
  428. throw new Exception("Attempting to delete directory: '$dir'");
  429. }
  430. foreach(glob($dir . '/*') as $file)
  431. {
  432. if(is_dir($file))
  433. {
  434. self::tidydir($file);
  435. rmdir($file);
  436. }
  437. else
  438. {
  439. unlink($file);
  440. }
  441. }
  442. }
  443. /**
  444. * Helper to build the full path of a new directory
  445. */
  446. public static function builddir($dir)
  447. {
  448. $parent = dirname($dir);
  449. if(!is_dir($parent))
  450. {
  451. self::builddir($parent);
  452. }
  453. if (!is_dir($dir))
  454. {
  455. mkdir($dir);
  456. }
  457. }
  458. /**
  459. * Helper to copy a directory to a target directory, skipping .SVN files (for developer's comfort!)
  460. * Returns true if successfull
  461. */
  462. public static function copydir($sSource, $sDest, $bUseSymbolicLinks = false)
  463. {
  464. if (is_dir($sSource))
  465. {
  466. if (!is_dir($sDest))
  467. {
  468. mkdir($sDest);
  469. }
  470. $aFiles = scandir($sSource);
  471. if(sizeof($aFiles) > 0 )
  472. {
  473. foreach($aFiles as $sFile)
  474. {
  475. if ($sFile == '.' || $sFile == '..' || $sFile == '.svn')
  476. {
  477. // Skip
  478. continue;
  479. }
  480. if (is_dir($sSource.'/'.$sFile))
  481. {
  482. // Recurse
  483. self::copydir($sSource.'/'.$sFile, $sDest.'/'.$sFile, $bUseSymbolicLinks);
  484. }
  485. else
  486. {
  487. if ($bUseSymbolicLinks)
  488. {
  489. if (function_exists('symlink'))
  490. {
  491. symlink($sSource.'/'.$sFile, $sDest.'/'.$sFile);
  492. }
  493. else
  494. {
  495. throw(new Exception("Error, cannot *copy* '$sSource/$sFile' to '$sDest/$sFile' using symbolic links, 'symlink' is not supported on this system."));
  496. }
  497. }
  498. else
  499. {
  500. copy($sSource.'/'.$sFile, $sDest.'/'.$sFile);
  501. }
  502. }
  503. }
  504. }
  505. return true;
  506. }
  507. elseif (is_file($sSource))
  508. {
  509. if ($bUseSymbolicLinks)
  510. {
  511. if (function_exists('symlink'))
  512. {
  513. return symlink($sSource, $sDest);
  514. }
  515. else
  516. {
  517. throw(new Exception("Error, cannot *copy* '$sSource' to '$sDest' using symbolic links, 'symlink' is not supported on this system."));
  518. }
  519. }
  520. else
  521. {
  522. return copy($sSource, $sDest);
  523. }
  524. }
  525. else
  526. {
  527. return false;
  528. }
  529. }
  530. static function GetPreviousInstance($sDir)
  531. {
  532. $bFound = false;
  533. $sSourceDir = '';
  534. $sSourceEnvironement = '';
  535. $sConfigFile = '';
  536. $aResult = array(
  537. 'found' => false,
  538. );
  539. if (file_exists($sDir.'/config-itop.php'))
  540. {
  541. $sSourceDir = $sDir;
  542. $sSourceEnvironment = '';
  543. $sConfigFile = $sDir.'/config-itop.php';
  544. $aResult['found'] = true;
  545. }
  546. else if (file_exists($sDir.'/conf/production/config-itop.php'))
  547. {
  548. $sSourceDir = $sDir;
  549. $sSourceEnvironment = 'production';
  550. $sConfigFile = $sDir.'/conf/production/config-itop.php';
  551. $aResult['found'] = true;
  552. }
  553. if ($aResult['found'])
  554. {
  555. $oPrevConf = new Config($sConfigFile);
  556. $aResult = array(
  557. 'found' => true,
  558. 'source_dir' => $sSourceDir,
  559. 'source_environment' => $sSourceEnvironment,
  560. 'configuration_file' => $sConfigFile,
  561. 'db_server' => $oPrevConf->GetDBHost(),
  562. 'db_user' => $oPrevConf->GetDBUser(),
  563. 'db_pwd' => $oPrevConf->GetDBPwd(),
  564. 'db_name' => $oPrevConf->GetDBName(),
  565. 'db_prefix' => $oPrevConf->GetDBSubname(),
  566. );
  567. }
  568. return $aResult;
  569. }
  570. static function CheckDiskSpace($sDir)
  571. {
  572. while(($f = @disk_free_space($sDir)) == false)
  573. {
  574. if ($sDir == dirname($sDir)) break;
  575. if ($sDir == '.') break;
  576. $sDir = dirname($sDir);
  577. }
  578. return $f;
  579. }
  580. static function HumanReadableSize($fBytes)
  581. {
  582. $aSizes = array('bytes', 'Kb', 'Mb', 'Gb', 'Tb', 'Pb', 'Hb');
  583. $index = 0;
  584. while (($fBytes > 1000) && ($index < count($aSizes)))
  585. {
  586. $index++;
  587. $fBytes = $fBytes / 1000;
  588. }
  589. return sprintf('%.2f %s', $fBytes, $aSizes[$index]);
  590. }
  591. static function DisplayDBParameters($oPage, $bAllowDBCreation, $sDBServer, $sDBUser, $sDBPwd, $sDBName, $sDBPrefix, $sNewDBName = '')
  592. {
  593. $oPage->add('<tr><td colspan="2">');
  594. $oPage->add('<fieldset><legend>Database Server Connection</legend>');
  595. $oPage->add('<table>');
  596. $oPage->add('<tr><td>Server Name:</td><td><input id="db_server" type="text" name="db_server" value="'.htmlentities($sDBServer, ENT_QUOTES, 'UTF-8').'" size="15"/></td><td>E.g. "localhost", "dbserver.mycompany.com" or "192.142.10.23"</td></tr>');
  597. $oPage->add('<tr><td>Login:</td><td><input id="db_user" type="text" name="db_user" value="'.htmlentities($sDBUser, ENT_QUOTES, 'UTF-8').'" size="15"/></td><td rowspan="2" style="vertical-align:top">The account must have the following privileges on the database: SELECT, INSERT, UPDATE, DELETE, DROP, CREATE, ALTER, CREATE VIEW, SUPER, TRIGGER</td></tr>');
  598. $oPage->add('<tr><td>Password:</td><td><input id="db_pwd" autocomplete="off" type="password" name="db_pwd" value="'.htmlentities($sDBPwd, ENT_QUOTES, 'UTF-8').'" size="15"/></td></tr>');
  599. $oPage->add('</table>');
  600. $oPage->add('</fieldset>');
  601. $oPage->add('</td></tr>');
  602. $oPage->add('<tr><td colspan="2"><span id="db_info"></span></td></tr>');
  603. $oPage->add('<tr><td colspan="2">');
  604. $oPage->add('<fieldset><legend>Database</legend>');
  605. $oPage->add('<table>');
  606. if ($bAllowDBCreation)
  607. {
  608. $oPage->add('<tr><td><input type="radio" id="create_db" name="create_db" value="yes"/><label for="create_db">&nbsp;Create a new database:</label></td>');
  609. $oPage->add('<td><input id="db_new_name" type="text" name="db_new_name" value="'.htmlentities($sNewDBName, ENT_QUOTES, 'UTF-8').'" size="15" maxlength="32"/><span style="width:20px;" id="v_db_new_name"></span></td></tr>');
  610. $oPage->add('<tr><td><input type="radio" id="existing_db" name="create_db" value="no"/><label for="existing_db">&nbsp;Use the existing database:</label></td>');
  611. $oPage->add('<td id="db_name_container"><input id="db_name" name="db_name" size="15" maxlen="32" value="'.htmlentities($sDBName, ENT_QUOTES, 'UTF-8').'"/><span style="width:20px;" id="v_db_name"></span></td></tr>');
  612. $oPage->add('<tr><td>Use a prefix for the tables:</td><td><input id="db_prefix" type="text" name="db_prefix" value="'.htmlentities($sDBPrefix, ENT_QUOTES, 'UTF-8').'" size="15" maxlength="32"/><span style="width:20px;" id="v_db_prefix"></span></td></tr>');
  613. }
  614. else
  615. {
  616. $oPage->add('<tr><td>Database Name:</td><td id="db_name_container"><input id="db_name" name="db_name" size="15" maxlen="32" value="'.htmlentities($sDBName, ENT_QUOTES, 'UTF-8').'"/><span style="width:20px;" id="v_db_name"></span></td></tr>');
  617. $oPage->add('<tr><td>Use a prefix for the tables:</td><td><input id="db_prefix" type="text" name="db_prefix" value="'.htmlentities($sDBPrefix, ENT_QUOTES, 'UTF-8').'" size="15"/><span style="width:20px;" id="v_db_prefix"></span></td></tr>');
  618. }
  619. $oPage->add('</table>');
  620. $oPage->add('</fieldset>');
  621. $oPage->add('<tr><td colspan="2"><span id="table_info">&nbsp;</span></td></tr>');
  622. $oPage->add('</td></tr>');
  623. $oPage->add_script(
  624. <<<EOF
  625. var iCheckDBTimer = null;
  626. var oXHRCheckDB = null;
  627. function CheckDBConnection()
  628. {
  629. // Don't call the server too often...
  630. if (iCheckDBTimer !== null)
  631. {
  632. clearTimeout(iCheckDBTimer);
  633. iCheckDBTimer = null;
  634. }
  635. iCheckDBTimer = setTimeout(DoCheckDBConnection, 500);
  636. }
  637. function DoCheckDBConnection()
  638. {
  639. iCheckDBTimer = null;
  640. var oParams = {
  641. 'db_server': $("#db_server").val(),
  642. 'db_user': $("#db_user").val(),
  643. 'db_pwd': $("#db_pwd").val(),
  644. 'db_name': $("#db_name").val()
  645. }
  646. if ((oXHRCheckDB != null) && (oXHRCheckDB != undefined))
  647. {
  648. oXHRCheckDB.abort();
  649. oXHRCheckDB = null;
  650. }
  651. oXHRCheckDB = WizardAsyncAction("check_db", oParams);
  652. }
  653. function ValidateField(sFieldId, bUsed)
  654. {
  655. var sValue = new String($("#"+sFieldId).val());
  656. var bMandatory = false;
  657. if (bUsed)
  658. {
  659. if (sFieldId == 'db_name')
  660. {
  661. bUsed = ($("#existing_db").attr("checked") == "checked");
  662. bMandatory = true;
  663. }
  664. if (sFieldId == 'db_new_name')
  665. {
  666. bUsed = ($("#create_db").attr("checked") == "checked");
  667. bMandatory = true;
  668. }
  669. }
  670. if (!bUsed)
  671. {
  672. $("#v_"+sFieldId).html("");
  673. return true;
  674. }
  675. else
  676. {
  677. if (sValue != "")
  678. {
  679. if (sValue.match(/^[A-Za-z][A-Za-z0-9_]*$/))
  680. {
  681. var bCollision = false;
  682. if (sFieldId == 'db_new_name')
  683. {
  684. // check that the "new name" does not correspond to an existing database
  685. var sNewName = $('#db_new_name').val();
  686. $('#db_name option').each( function() {
  687. if ($(this).attr('value') == sNewName)
  688. {
  689. bCollision = true;
  690. }
  691. });
  692. }
  693. if (bCollision)
  694. {
  695. $("#v_"+sFieldId).html('<img src="../images/validation_error.png" title="A database with the same name already exists"/>');
  696. return false;
  697. }
  698. else
  699. {
  700. $("#v_"+sFieldId).html("");
  701. return true;
  702. }
  703. }
  704. else
  705. {
  706. $("#v_"+sFieldId).html('<img src="../images/validation_error.png" title="Only the characters [A-Za-z0-9_] are allowed"/>');
  707. return false;
  708. }
  709. }
  710. else if (bMandatory)
  711. {
  712. $("#v_"+sFieldId).html('<img src="../images/validation_error.png" title="This field cannot be empty"/>');
  713. return false;
  714. }
  715. else
  716. {
  717. $("#v_"+sFieldId).html("");
  718. return true;
  719. }
  720. }
  721. }
  722. EOF
  723. );
  724. $oPage->add_ready_script(
  725. <<<EOF
  726. DoCheckDBConnection(); // Validate the initial values immediately
  727. $("#db_server").bind("keyup change", function() { CheckDBConnection(); });
  728. $("#db_user").bind("keyup change", function() { CheckDBConnection(); });
  729. $("#db_pwd").bind("keyup change", function() { CheckDBConnection(); });
  730. $("#db_new_name").bind("click keyup change", function() { $("#create_db").attr("checked", "checked"); WizardUpdateButtons(); });
  731. $("#db_name").bind("click keyup change", function() { $("#existing_db").attr("checked", "checked"); WizardUpdateButtons(); });
  732. $("#db_prefix").bind("keyup change", function() { WizardUpdateButtons(); });
  733. $("#existing_db").bind("click change", function() { WizardUpdateButtons(); });
  734. $("#create_db").bind("click change", function() { WizardUpdateButtons(); });
  735. EOF
  736. );
  737. }
  738. /**
  739. * Helper function check the connection to the database, verify a few conditions (minimum version, etc...) and (if connected)
  740. * enumerate the existing databases (if possible)
  741. * @return mixed false if the connection failed or array('checks' => Array of CheckResult, 'databases' => Array of database names (as strings) or null if not allowed)
  742. */
  743. static function CheckServerConnection($sDBServer, $sDBUser, $sDBPwd)
  744. {
  745. $aResult = array('checks' => array(), 'databases' => null);
  746. try
  747. {
  748. $oDBSource = new CMDBSource;
  749. $oDBSource->Init($sDBServer, $sDBUser, $sDBPwd);
  750. $aResult['checks'][] = new CheckResult(CheckResult::INFO, "Connection to '$sDBServer' as '$sDBUser' successful.");
  751. $aResult['checks'][] = new CheckResult(CheckResult::INFO, "Info - User privileges: ".($oDBSource->GetRawPrivileges()));
  752. $sDBVersion = $oDBSource->GetDBVersion();
  753. if (version_compare($sDBVersion, self::MYSQL_MIN_VERSION, '>='))
  754. {
  755. $aResult['checks'][] = new CheckResult(CheckResult::INFO, "Current MySQL version ($sDBVersion), greater than minimum required version (".self::MYSQL_MIN_VERSION.")");
  756. // Check some server variables
  757. $iMaxAllowedPacket = $oDBSource->GetServerVariable('max_allowed_packet');
  758. $iMaxUploadSize = utils::ConvertToBytes(ini_get('upload_max_filesize'));
  759. if ($iMaxAllowedPacket >= (500 + $iMaxUploadSize)) // Allow some space for the query + the file to upload
  760. {
  761. $aResult['checks'][] = new CheckResult(CheckResult::INFO, "MySQL server's max_allowed_packet ($iMaxAllowedPacket) is big enough compared to upload_max_filesize ($iMaxUploadSize).");
  762. }
  763. else if($iMaxAllowedPacket < $iMaxUploadSize)
  764. {
  765. $aResult['checks'][] = new CheckResult(CheckResult::WARNING, "MySQL server's max_allowed_packet ($iMaxAllowedPacket) is not big enough. Please, consider setting it to at least ".(500 + $iMaxUploadSize).".");
  766. }
  767. $iMaxConnections = $oDBSource->GetServerVariable('max_connections');
  768. if ($iMaxConnections < 5)
  769. {
  770. $aResult['checks'][] = new CheckResult(CheckResult::WARNING, "MySQL server's max_connections ($iMaxConnections) is not enough. Please, consider setting it to at least 5.");
  771. }
  772. else
  773. {
  774. $aResult['checks'][] = new CheckResult(CheckResult::INFO, "MySQL server's max_connections is set to $iMaxConnections.");
  775. }
  776. }
  777. else
  778. {
  779. $aResult['checks'][] = new CheckResult(CheckResult::ERROR, "Error: Current MySQL version is ($sDBVersion), minimum required version (".self::MYSQL_MIN_VERSION.")");
  780. }
  781. try
  782. {
  783. $aResult['databases'] = $oDBSource->ListDB();
  784. }
  785. catch(Exception $e)
  786. {
  787. $aResult['databases'] = null;
  788. }
  789. }
  790. catch(Exception $e)
  791. {
  792. return false;
  793. }
  794. return $aResult;
  795. }
  796. static public function GetMySQLVersion($sDBServer, $sDBUser, $sDBPwd)
  797. {
  798. $oDBSource = new CMDBSource;
  799. $oDBSource->Init($sDBServer, $sDBUser, $sDBPwd);
  800. $sDBVersion = $oDBSource->GetDBVersion();
  801. return $sDBVersion;
  802. }
  803. static public function AsyncCheckDB($oPage, $aParameters)
  804. {
  805. $sDBServer = $aParameters['db_server'];
  806. $sDBUser = $aParameters['db_user'];
  807. $sDBPwd = $aParameters['db_pwd'];
  808. $sDBName = $aParameters['db_name'];
  809. $oPage->add_ready_script('oXHRCheckDB = null;');
  810. $checks = SetupUtils::CheckServerConnection($sDBServer, $sDBUser, $sDBPwd);
  811. if ($checks === false)
  812. {
  813. // Connection failed, disable the "Next" button
  814. $oPage->add_ready_script('$("#wiz_form").data("db_connection", "error");');
  815. $oPage->add_ready_script('$("#db_info").html("No connection to the database...");');
  816. }
  817. else
  818. {
  819. $aErrors = array();
  820. $aWarnings = array();
  821. foreach($checks['checks'] as $oCheck)
  822. {
  823. if ($oCheck->iSeverity == CheckResult::ERROR)
  824. {
  825. $aErrors[] = $oCheck->sLabel;
  826. }
  827. else if ($oCheck->iSeverity == CheckResult::WARNING)
  828. {
  829. $aWarnings[] = $oCheck->sLabel;
  830. }
  831. }
  832. if (count($aErrors) > 0)
  833. {
  834. $oPage->add_ready_script('$("#wiz_form").data("db_connection", "error");');
  835. $oPage->add_ready_script('$("#db_info").html(\'<img src="../images/validation_error.png"/>&nbsp;<b>Error:</b> '.htmlentities(implode('<br/>', $aErrors), ENT_QUOTES, 'UTF-8').'\');');
  836. }
  837. else if (count($aWarnings) > 0)
  838. {
  839. $oPage->add_ready_script('$("#wiz_form").data("db_connection", "");');
  840. $oPage->add_ready_script('$("#db_info").html(\'<img src="../images/error.png"/>&nbsp;<b>Warning:</b> '.htmlentities(implode('<br/>', $aWarnings), ENT_QUOTES, 'UTF-8').'\');');
  841. }
  842. else
  843. {
  844. $oPage->add_ready_script('$("#wiz_form").data("db_connection", "");');
  845. $oPage->add_ready_script('$("#db_info").html(\'<img src="../images/validation_ok.png"/>&nbsp;Database server connection Ok.\');');
  846. }
  847. if ($checks['databases'] == null)
  848. {
  849. $sDBNameInput = '<input id="db_name" name="db_name" size="15" maxlen="32" value="'.htmlentities($sDBName, ENT_QUOTES, 'UTF-8').'"/><span style="width:20px;" id="v_db_name"></span>';
  850. $oPage->add_ready_script('$("#table_info").html(\'<img src="../images/error.png"/>&nbsp;Not enough rights to enumerate the databases\');');
  851. }
  852. else
  853. {
  854. $sDBNameInput = '<select id="db_name" name="db_name">';
  855. foreach($checks['databases'] as $sDatabaseName)
  856. {
  857. if ($sDatabaseName != 'information_schema')
  858. {
  859. $sEncodedName = htmlentities($sDatabaseName, ENT_QUOTES, 'UTF-8');
  860. $sSelected = ($sDatabaseName == $sDBName) ? ' selected ' : '';
  861. $sDBNameInput .= '<option value="'.$sEncodedName.'"'.$sSelected.'>'.$sEncodedName.'</option>';
  862. }
  863. }
  864. $sDBNameInput .= '</select>';
  865. }
  866. $oPage->add_ready_script('$("#db_name_container").html("'.addslashes($sDBNameInput).'");');
  867. $oPage->add_ready_script('$("#db_name").bind("click keyup change", function() { $("#existing_db").attr("checked", "checked"); WizardUpdateButtons(); });');
  868. }
  869. $oPage->add_ready_script('WizardUpdateButtons();');
  870. }
  871. /**
  872. * Helper function to get the available languages from the given directory
  873. * @param $sDir Path to the dictionary
  874. * @return an array of language code => description
  875. */
  876. static public function GetAvailableLanguages($sDir)
  877. {
  878. require_once(APPROOT.'/core/coreexception.class.inc.php');
  879. require_once(APPROOT.'/core/dict.class.inc.php');
  880. $aFiles = scandir($sDir);
  881. foreach($aFiles as $sFile)
  882. {
  883. if ($sFile == '.' || $sFile == '..' || $sFile == '.svn')
  884. {
  885. // Skip
  886. continue;
  887. }
  888. $sFilePath = $sDir.'/'.$sFile;
  889. if (is_file($sFilePath) && preg_match('/^.*dict.*\.php$/i', $sFilePath, $aMatches))
  890. {
  891. require_once($sFilePath);
  892. }
  893. }
  894. return Dict::GetLanguages();
  895. }
  896. static public function GetLanguageSelect($sSourceDir, $sInputName, $sDefaultLanguageCode)
  897. {
  898. $sHtml = '<select id="'.$sInputName.'" name="'.$sInputName.'">';
  899. $sSourceDir = APPROOT.'dictionaries/';
  900. $aLanguages = SetupUtils::GetAvailableLanguages($sSourceDir);
  901. foreach($aLanguages as $sCode => $aInfo)
  902. {
  903. $sSelected = ($sCode == $sDefaultLanguageCode) ? ' selected ' : '';
  904. $sHtml .= '<option value="'.$sCode.'"'.$sSelected.'>'.htmlentities($aInfo['description'], ENT_QUOTES, 'UTF-8').' ('.htmlentities($aInfo['localized_description'], ENT_QUOTES, 'UTF-8').')</option>';
  905. }
  906. $sHtml .= '</select></td></tr>';
  907. return $sHtml;
  908. }
  909. public static function AnalyzeInstallation($oWizard)
  910. {
  911. require_once(APPROOT.'/setup/moduleinstaller.class.inc.php');
  912. $oConfig = new Config();
  913. $sSourceDir = $oWizard->GetParameter('source_dir', '');
  914. if (strpos($sSourceDir, APPROOT) !== false)
  915. {
  916. $sRelativeSourceDir = str_replace(APPROOT, '', $sSourceDir);
  917. }
  918. else if (strpos($sSourceDir, $oWizard->GetParameter('previous_version_dir')) !== false)
  919. {
  920. $sRelativeSourceDir = str_replace($oWizard->GetParameter('previous_version_dir'), '', $sSourceDir);
  921. }
  922. else
  923. {
  924. throw(new Exception('Internal error: AnalyzeInstallation: source_dir is neither under APPROOT nor under previous_installation_dir ???'));
  925. }
  926. $aParamValues = array(
  927. 'db_server' => $oWizard->GetParameter('db_server', ''),
  928. 'db_user' => $oWizard->GetParameter('db_user', ''),
  929. 'db_pwd' => $oWizard->GetParameter('db_pwd', ''),
  930. 'db_name' => $oWizard->GetParameter('db_name', ''),
  931. 'db_prefix' => $oWizard->GetParameter('db_prefix', ''),
  932. 'source_dir' => $sRelativeSourceDir,
  933. );
  934. $oConfig->UpdateFromParams($aParamValues, null);
  935. $aDirsToScan = array($sSourceDir);
  936. if (is_dir(APPROOT.'extensions'))
  937. {
  938. $aDirsToScan[] = APPROOT.'extensions';
  939. }
  940. if (is_dir($oWizard->GetParameter('copy_extensions_from')))
  941. {
  942. $aDirsToScan[] = $oWizard->GetParameter('copy_extensions_from');
  943. }
  944. $oProductionEnv = new RunTimeEnvironment();
  945. $aAvailableModules = $oProductionEnv->AnalyzeInstallation($oConfig, $aDirsToScan);
  946. return $aAvailableModules;
  947. }
  948. public static function GetApplicationVersion($oWizard)
  949. {
  950. require_once(APPROOT.'/setup/moduleinstaller.class.inc.php');
  951. $oConfig = new Config();
  952. $aParamValues = array(
  953. 'db_server' => $oWizard->GetParameter('db_server', ''),
  954. 'db_user' => $oWizard->GetParameter('db_user', ''),
  955. 'db_pwd' => $oWizard->GetParameter('db_pwd', ''),
  956. 'db_name' => $oWizard->GetParameter('db_name', ''),
  957. 'db_prefix' => $oWizard->GetParameter('db_prefix', ''),
  958. 'source_dir' => '',
  959. );
  960. $oConfig->UpdateFromParams($aParamValues, null);
  961. $oProductionEnv = new RunTimeEnvironment();
  962. return $oProductionEnv->GetApplicationVersion($oConfig);
  963. }
  964. /**
  965. * Checks if the content of a directory matches the given manifest
  966. * @param string $sBaseDir Path to the root directory of iTop
  967. * @param string $sSourceDir Relative path to the directory to check under $sBaseDir
  968. * @param Array $aDOMManifest Array of array('path' => relative_path 'size'=> iSize, 'md5' => sHexMD5)
  969. * @param Hash $aResult Used for recursion
  970. * @return hash Hash array ('added' => array(), 'removed' => array(), 'modified' => array())
  971. */
  972. public static function CheckDirAgainstManifest($sBaseDir, $sSourceDir, $aManifest, $aExcludeNames = array('.svn'), $aResult = null)
  973. {
  974. //echo "CheckDirAgainstManifest($sBaseDir, $sSourceDir ...)\n";
  975. if ($aResult === null)
  976. {
  977. $aResult = array('added' => array(), 'removed' => array(), 'modified' => array());
  978. }
  979. if (substr($sSourceDir, 0, 1) == '/')
  980. {
  981. $sSourceDir = substr($sSourceDir, 1);
  982. }
  983. // Manifest limited to all the files supposed to be located in this directory
  984. $aDirManifest = array();
  985. foreach($aManifest as $aFileInfo)
  986. {
  987. $sDir = dirname($aFileInfo['path']);
  988. if ($sDir == '.')
  989. {
  990. // Hmm... the file seems located at the root of iTop
  991. $sDir = '';
  992. }
  993. if ($sDir == $sSourceDir)
  994. {
  995. $aDirManifest[basename($aFileInfo['path'])] = $aFileInfo;
  996. }
  997. }
  998. //echo "The manifest contains ".count($aDirManifest)." files for the directory '$sSourceDir' (and below)\n";
  999. // Read the content of the directory
  1000. foreach(glob($sBaseDir.'/'.$sSourceDir .'/*') as $sFilePath)
  1001. {
  1002. $sFile = basename($sFilePath);
  1003. //echo "Checking $sFile ($sFilePath)\n";
  1004. if (in_array(basename($sFile), $aExcludeNames)) continue;
  1005. if(is_dir($sFilePath))
  1006. {
  1007. $aResult = self::CheckDirAgainstManifest($sBaseDir, $sSourceDir.'/'.$sFile, $aManifest, $aExcludeNames, $aResult);
  1008. }
  1009. else
  1010. {
  1011. if (!array_key_exists($sFile, $aDirManifest))
  1012. {
  1013. //echo "New file ".$sFile." in $sSourceDir\n";
  1014. $aResult['added'][$sSourceDir.'/'.$sFile] = true;
  1015. }
  1016. else
  1017. {
  1018. $aStats = stat($sFilePath);
  1019. if ($aStats['size'] != $aDirManifest[$sFile]['size'])
  1020. {
  1021. // Different sizes
  1022. $aResult['modified'][$sSourceDir.'/'.$sFile] = 'Different sizes. Original size: '.$aDirManifest[$sFile]['size'].' bytes, actual file size on disk: '.$aStats['size'].' bytes.';
  1023. }
  1024. else
  1025. {
  1026. // Same size, compare the md5 signature
  1027. $sMD5 = md5_file($sFilePath);
  1028. if ($sMD5 != $aDirManifest[$sFile]['md5'])
  1029. {
  1030. $aResult['modified'][$sSourceDir.'/'.$sFile] = 'Content modified (MD5 checksums differ).';
  1031. //echo $sSourceDir.'/'.$sFile." modified ($sMD5 == {$aDirManifest[$sFile]['md5']})\n";
  1032. }
  1033. //else
  1034. //{
  1035. // echo $sSourceDir.'/'.$sFile." unmodified ($sMD5 == {$aDirManifest[$sFile]['md5']})\n";
  1036. //}
  1037. }
  1038. //echo "Removing ".$sFile." from aDirManifest\n";
  1039. unset($aDirManifest[$sFile]);
  1040. }
  1041. }
  1042. }
  1043. // What remains in the array are files that were deleted
  1044. foreach($aDirManifest as $sDeletedFile => $void)
  1045. {
  1046. $aResult['removed'][$sSourceDir.'/'.$sDeletedFile] = true;
  1047. }
  1048. return $aResult;
  1049. }
  1050. public static function CheckDataModelFiles($sManifestFile, $sBaseDir)
  1051. {
  1052. $oXML = simplexml_load_file($sManifestFile);
  1053. $aManifest = array();
  1054. foreach($oXML as $oFileInfo)
  1055. {
  1056. $aManifest[] = array('path' => (string)$oFileInfo->path, 'size' => (int)$oFileInfo->size, 'md5' => (string)$oFileInfo->md5);
  1057. }
  1058. $sBaseDir = preg_replace('|modules/?$|', '', $sBaseDir);
  1059. $aResults = self::CheckDirAgainstManifest($sBaseDir, 'modules', $aManifest);
  1060. // echo "<pre>Comparison of ".dirname($sBaseDir)."/modules against $sManifestFile:\n".print_r($aResults, true)."</pre>";
  1061. return $aResults;
  1062. }
  1063. public static function CheckPortalFiles($sManifestFile, $sBaseDir)
  1064. {
  1065. $oXML = simplexml_load_file($sManifestFile);
  1066. $aManifest = array();
  1067. foreach($oXML as $oFileInfo)
  1068. {
  1069. $aManifest[] = array('path' => (string)$oFileInfo->path, 'size' => (int)$oFileInfo->size, 'md5' => (string)$oFileInfo->md5);
  1070. }
  1071. $aResults = self::CheckDirAgainstManifest($sBaseDir, 'portal', $aManifest);
  1072. // echo "<pre>Comparison of ".dirname($sBaseDir)."/portal:\n".print_r($aResults, true)."</pre>";
  1073. return $aResults;
  1074. }
  1075. public static function CheckApplicationFiles($sManifestFile, $sBaseDir)
  1076. {
  1077. $oXML = simplexml_load_file($sManifestFile);
  1078. $aManifest = array();
  1079. foreach($oXML as $oFileInfo)
  1080. {
  1081. $aManifest[] = array('path' => (string)$oFileInfo->path, 'size' => (int)$oFileInfo->size, 'md5' => (string)$oFileInfo->md5);
  1082. }
  1083. $aResults = array('added' => array(), 'removed' => array(), 'modified' => array());
  1084. foreach(array('addons', 'core', 'dictionaries', 'js', 'application', 'css', 'pages', 'synchro', 'webservices') as $sDir)
  1085. {
  1086. $aTmp = self::CheckDirAgainstManifest($sBaseDir, $sDir, $aManifest);
  1087. $aResults['added'] = array_merge($aResults['added'], $aTmp['added']);
  1088. $aResults['modified'] = array_merge($aResults['modified'], $aTmp['modified']);
  1089. $aResults['removed'] = array_merge($aResults['removed'], $aTmp['removed']);
  1090. }
  1091. // echo "<pre>Comparison of ".dirname($sBaseDir)."/portal:\n".print_r($aResults, true)."</pre>";
  1092. return $aResults;
  1093. }
  1094. public static function CheckVersion($sInstalledVersion, $sSourceDir)
  1095. {
  1096. $sManifestFilePath = self::GetVersionManifest($sInstalledVersion);
  1097. if ($sSourceDir != '')
  1098. {
  1099. if (file_exists($sManifestFilePath))
  1100. {
  1101. $aDMchanges = self::CheckDataModelFiles($sManifestFilePath, $sSourceDir);
  1102. //$aPortalChanges = self::CheckPortalFiles($sManifestFilePath, $sSourceDir);
  1103. //$aCodeChanges = self::CheckApplicationFiles($sManifestFilePath, $sSourceDir);
  1104. //echo("Changes detected compared to $sInstalledVersion:<br/>DataModel:<br/><pre>".print_r($aDMchanges, true)."</pre>");
  1105. //echo("Changes detected compared to $sInstalledVersion:<br/>DataModel:<br/><pre>".print_r($aDMchanges, true)."</pre><br/>Portal:<br/><pre>".print_r($aPortalChanges, true)."</pre><br/>Code:<br/><pre>".print_r($aCodeChanges, true)."</pre>");
  1106. return $aDMchanges;
  1107. }
  1108. else
  1109. {
  1110. return false;
  1111. }
  1112. }
  1113. else
  1114. {
  1115. throw(new Exception("Cannot check version '$sInstalledVersion', no source directory provided to check the files."));
  1116. }
  1117. }
  1118. public static function GetVersionManifest($sInstalledVersion)
  1119. {
  1120. if (preg_match('/^([0-9]+)\./', $sInstalledVersion, $aMatches))
  1121. {
  1122. return APPROOT.'datamodels/'.$aMatches[1].'.x/manifest-'.$sInstalledVersion.'.xml';
  1123. }
  1124. return false;
  1125. }
  1126. public static function CheckWritableDirs($aWritableDirs)
  1127. {
  1128. $aNonWritableDirs = array();
  1129. foreach($aWritableDirs as $sDir)
  1130. {
  1131. $sFullPath = APPROOT.$sDir;
  1132. if (is_dir($sFullPath) && !is_writable($sFullPath))
  1133. {
  1134. $aNonWritableDirs[APPROOT.$sDir] = new CheckResult(CheckResult::ERROR, "The directory <b>'".APPROOT.$sDir."'</b> exists but is not writable for the application.");
  1135. }
  1136. else if (file_exists($sFullPath) && !is_dir($sFullPath))
  1137. {
  1138. $aNonWritableDirs[APPROOT.$sDir] = new CheckResult(CheckResult::ERROR, ITOP_APPLICATION." needs the directory <b>'".APPROOT.$sDir."'</b> to be writable. However <i>file</i> named <b>'".APPROOT.$sDir."'</b> already exists.");
  1139. }
  1140. else if (!is_dir($sFullPath) && !is_writable(APPROOT))
  1141. {
  1142. $aNonWritableDirs[APPROOT.$sDir] = new CheckResult(CheckResult::ERROR, ITOP_APPLICATION." needs the directory <b>'".APPROOT.$sDir."'</b> to be writable. The directory <b>'".APPROOT.$sDir."'</b> does not exist and '".APPROOT."' is not writable, the application cannot create the directory '$sDir' inside it.");
  1143. }
  1144. }
  1145. return $aNonWritableDirs;
  1146. }
  1147. public static function GetLatestDataModelDir()
  1148. {
  1149. $sBaseDir = APPROOT.'datamodels';
  1150. $aDirs = glob($sBaseDir.'/*', GLOB_MARK | GLOB_ONLYDIR);
  1151. if ($aDirs !== false)
  1152. {
  1153. sort($aDirs);
  1154. return array_pop($aDirs);
  1155. }
  1156. return false;
  1157. }
  1158. public static function GetCompatibleDataModelDir($sInstalledVersion)
  1159. {
  1160. if (preg_match('/^([0-9]+)\./', $sInstalledVersion, $aMatches))
  1161. {
  1162. $sMajorVersion = $aMatches[1];
  1163. $sDir = APPROOT.'datamodels/'.$sMajorVersion.'.x/';
  1164. if (is_dir($sDir))
  1165. {
  1166. return $sDir;
  1167. }
  1168. }
  1169. return false;
  1170. }
  1171. static public function GetDataModelVersion($sDatamodelDir)
  1172. {
  1173. $sVersionFile = $sDatamodelDir.'version.xml';
  1174. if (file_exists($sVersionFile))
  1175. {
  1176. $oParams = new XMLParameters($sVersionFile);
  1177. return $oParams->Get('version');
  1178. }
  1179. return false;
  1180. }
  1181. }
  1182. /**
  1183. * Helper class to write rules (as PHP expressions) in the 'auto_select' field of the 'module'
  1184. */
  1185. class SetupInfo
  1186. {
  1187. static $aSelectedModules = array();
  1188. /**
  1189. * Called by the setup process to initializes the list of selected modules. Do not call this method
  1190. * from an 'auto_select' rule
  1191. * @param hash $aModules
  1192. * @return void
  1193. */
  1194. static function SetSelectedModules($aModules)
  1195. {
  1196. self::$aSelectedModules = $aModules;
  1197. }
  1198. /**
  1199. * Returns true if a module is selected (as a consequence of the end-user's choices,
  1200. * or because the module is hidden, or mandatory, or because of a previous auto_select rule)
  1201. * @param string $sModuleId The identifier of the module (without the version number. Example: itop-config-mgmt)
  1202. * @return boolean True if the module is already selected, false otherwise
  1203. */
  1204. static function ModuleIsSelected($sModuleId)
  1205. {
  1206. return (array_key_exists($sModuleId, self::$aSelectedModules));
  1207. }
  1208. }