config.class.inc.php 22 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677
  1. <?php
  2. // Copyright (C) 2010 Combodo SARL
  3. //
  4. // This program is free software; you can redistribute it and/or modify
  5. // it under the terms of the GNU General Public License as published by
  6. // the Free Software Foundation; version 3 of the License.
  7. //
  8. // This program is distributed in the hope that it will be useful,
  9. // but WITHOUT ANY WARRANTY; without even the implied warranty of
  10. // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  11. // GNU General Public License for more details.
  12. //
  13. // You should have received a copy of the GNU General Public License
  14. // along with this program; if not, write to the Free Software
  15. // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
  16. define('ITOP_VERSION', '$ITOP_VERSION$');
  17. define('ITOP_REVISION', '$WCREV$');
  18. define('ITOP_BUILD_DATE', '$WCNOW$');
  19. /**
  20. * Configuration read/write
  21. *
  22. * @author Erwan Taloc <erwan.taloc@combodo.com>
  23. * @author Romain Quetiez <romain.quetiez@combodo.com>
  24. * @author Denis Flaven <denis.flaven@combodo.com>
  25. * @license http://www.opensource.org/licenses/gpl-3.0.html LGPL
  26. */
  27. require_once('coreexception.class.inc.php');
  28. class ConfigException extends CoreException
  29. {
  30. }
  31. define ('DEFAULT_LOG_GLOBAL', true);
  32. define ('DEFAULT_LOG_NOTIFICATION', true);
  33. define ('DEFAULT_LOG_ISSUE', true);
  34. define ('DEFAULT_LOG_WEB_SERVICE', true);
  35. define ('DEFAULT_LOG_KPI_DURATION', false);
  36. define ('DEFAULT_LOG_KPI_MEMORY', false);
  37. define ('DEFAULT_MIN_DISPLAY_LIMIT', 10);
  38. define ('DEFAULT_MAX_DISPLAY_LIMIT', 15);
  39. define ('DEFAULT_STANDARD_RELOAD_INTERVAL', 5*60);
  40. define ('DEFAULT_FAST_RELOAD_INTERVAL', 1*60);
  41. define ('DEFAULT_SECURE_CONNECTION_REQUIRED', false);
  42. define ('DEFAULT_HTTPS_HYPERLINKS', false);
  43. define ('DEFAULT_ALLOWED_LOGIN_TYPES', 'form|basic|external');
  44. define ('DEFAULT_EXT_AUTH_VARIABLE', '$_SERVER[\'REMOTE_USER\']');
  45. define ('DEFAULT_ENCRYPTION_KEY', '@iT0pEncr1pti0n!'); // We'll use a random value, later...
  46. /**
  47. * Config
  48. * configuration data (this class cannot not be localized, because it is responsible for loading the dictionaries)
  49. *
  50. * @package iTopORM
  51. */
  52. class Config
  53. {
  54. //protected $m_bIsLoaded = false;
  55. protected $m_sFile = '';
  56. protected $m_aAppModules;
  57. protected $m_aDataModels;
  58. protected $m_aAddons;
  59. protected $m_aDictionaries;
  60. protected $m_aModuleSettings;
  61. protected $m_sDBHost;
  62. protected $m_sDBUser;
  63. protected $m_sDBPwd;
  64. protected $m_sDBName;
  65. protected $m_sDBSubname;
  66. /**
  67. * @var integer Event log options (see LOG_... definition)
  68. */
  69. protected $m_bLogGlobal;
  70. protected $m_bLogNotification;
  71. protected $m_bLogIssue;
  72. protected $m_bLogWebService;
  73. protected $m_bLogKpiDuration; // private setting
  74. protected $m_bLogKpiMemory; // private setting
  75. /**
  76. * @var integer Number of elements to be displayed when there are more than m_iMaxDisplayLimit elements
  77. */
  78. protected $m_iMinDisplayLimit;
  79. /**
  80. * @var integer Max number of elements before truncating the display
  81. */
  82. protected $m_iMaxDisplayLimit;
  83. /**
  84. * @var integer Number of seconds between two reloads of the display (standard)
  85. */
  86. protected $m_iStandardReloadInterval;
  87. /**
  88. * @var integer Number of seconds between two reloads of the display (fast)
  89. */
  90. protected $m_iFastReloadInterval;
  91. /**
  92. * @var boolean Whether or not a secure connection is required for using the application.
  93. * If set, any attempt to connect to an iTop page with http:// will be redirected
  94. * to https://
  95. */
  96. protected $m_bSecureConnectionRequired;
  97. /**
  98. * @var boolean Forces iTop to output hyperlinks starting with https:// even
  99. * if the current page is not using https. This can be useful when
  100. * the application runs behind a SSL gateway
  101. */
  102. protected $m_bHttpsHyperlinks;
  103. /**
  104. * @var string Langage code, default if the user language is undefined
  105. */
  106. protected $m_sDefaultLanguage;
  107. /**
  108. * @var string Type of login process allowed: form|basic|url|external
  109. */
  110. protected $m_sAllowedLoginTypes;
  111. /**
  112. * @var string Name of the PHP variable in which external authentication information is passed by the web server
  113. */
  114. protected $m_sExtAuthVariable;
  115. /**
  116. * @var string Encryption key used for all attributes of type "encrypted string". Can be set to a random value
  117. * unless you want to import a database from another iTop instance, in which case you must use
  118. * the same encryption key in order to properly decode the encrypted fields
  119. */
  120. protected $m_sEncryptionKey;
  121. public function __construct($sConfigFile, $bLoadConfig = true)
  122. {
  123. $this->m_sFile = $sConfigFile;
  124. $this->m_aAppModules = array(
  125. // Some default modules, always present can be move to an official iTop Module later if needed
  126. '../application/transaction.class.inc.php',
  127. '../application/menunode.class.inc.php',
  128. '../application/user.preferences.class.inc.php',
  129. '../application/audit.rule.class.inc.php',
  130. // Romain - That's dirty, because those 3 classes are in fact part of the core
  131. // but I needed those classes to be derived from cmdbAbstractObject
  132. // (to be managed via the GUI) and this class in not really known from
  133. // the core, PLUS I needed the includes to be there also for the setup
  134. // to create the tables.
  135. '../core/event.class.inc.php',
  136. '../core/action.class.inc.php',
  137. '../core/trigger.class.inc.php',
  138. );
  139. $this->m_aDataModels = array();
  140. $this->m_aAddons = array(
  141. // Default AddOn, always present can be moved to an official iTop Module later if needed
  142. 'user rights' => '../addons/userrights/userrightsprofile.class.inc.php',
  143. );
  144. $this->m_aDictionaries = array(
  145. // Default dictionaries, always present can be moved to an official iTop Module later if needed
  146. '../dictionaries/dictionary.itop.core.php',
  147. '../dictionaries/dictionary.itop.ui.php', // Support for English
  148. '../dictionaries/fr.dictionary.itop.ui.php', // Support for French
  149. '../dictionaries/fr.dictionary.itop.core.php', // Support for French
  150. '../dictionaries/es_cr.dictionary.itop.ui.php', // Support for Spanish (from Costa Rica)
  151. '../dictionaries/es_cr.dictionary.itop.core.php', // Support for Spanish (from Costa Rica)
  152. );
  153. $this->m_sDBHost = '';
  154. $this->m_sDBUser = '';
  155. $this->m_sDBPwd = '';
  156. $this->m_sDBName = '';
  157. $this->m_sDBSubname = '';
  158. $this->m_bLogGlobal = DEFAULT_LOG_GLOBAL;
  159. $this->m_bLogNotification = DEFAULT_LOG_NOTIFICATION;
  160. $this->m_bLogIssue = DEFAULT_LOG_ISSUE;
  161. $this->m_bLogWebService = DEFAULT_LOG_WEB_SERVICE;
  162. $this->m_bLogKPIDuration = DEFAULT_LOG_KPI_DURATION;
  163. $this->m_bLogKPIDuration = DEFAULT_LOG_KPI_DURATION;
  164. $this->m_iMinDisplayLimit = DEFAULT_MIN_DISPLAY_LIMIT;
  165. $this->m_iMaxDisplayLimit = DEFAULT_MAX_DISPLAY_LIMIT;
  166. $this->m_iStandardReloadInterval = DEFAULT_STANDARD_RELOAD_INTERVAL;
  167. $this->m_iFastReloadInterval = DEFAULT_FAST_RELOAD_INTERVAL;
  168. $this->m_bSecureConnectionRequired = DEFAULT_SECURE_CONNECTION_REQUIRED;
  169. $this->m_bHttpsHyperlinks = DEFAULT_HTTPS_HYPERLINKS;
  170. $this->m_sDefaultLanguage = 'EN US';
  171. $this->m_sAllowedLoginTypes = DEFAULT_ALLOWED_LOGIN_TYPES;
  172. $this->m_sExtAuthVariable = DEFAULT_EXT_AUTH_VARIABLE;
  173. $this->m_sEncryptionKey = DEFAULT_ENCRYPTION_KEY;
  174. $this->m_aModuleSettings = array();
  175. if ($bLoadConfig)
  176. {
  177. $this->Load($sConfigFile);
  178. $this->Verify();
  179. }
  180. }
  181. protected function CheckFile($sPurpose, $sFileName)
  182. {
  183. if (!file_exists($sFileName))
  184. {
  185. throw new ConfigException("Could not find $sPurpose file", array('file' => $sFileName));
  186. }
  187. }
  188. protected function Load($sConfigFile)
  189. {
  190. $this->CheckFile('configuration', $sConfigFile);
  191. $sConfigCode = trim(file_get_contents($sConfigFile));
  192. // This does not work on several lines
  193. // preg_match('/^<\\?php(.*)\\?'.'>$/', $sConfigCode, $aMatches)...
  194. // So, I've implemented a solution suggested in the PHP doc (search for phpWrapper)
  195. try
  196. {
  197. ob_start();
  198. eval('?'.'>'.trim($sConfigCode));
  199. $sNoise = trim(ob_get_contents());
  200. ob_end_clean();
  201. }
  202. catch (Exception $e)
  203. {
  204. // well, never reach in case of parsing error :-(
  205. // will be improved in PHP 6 ?
  206. throw new ConfigException('Error in configuration file', array('file' => $sConfigFile, 'error' => $e->getMessage()));
  207. }
  208. if (strlen($sNoise) > 0)
  209. {
  210. // Note: sNoise is an html output, but so far it was ok for me (e.g. showing the entire call stack)
  211. throw new ConfigException('Syntax error in configuration file', array('file' => $sConfigFile, 'error' => '<tt>'.htmlentities($sNoise).'</tt>'));
  212. }
  213. if (!isset($MySettings) || !is_array($MySettings))
  214. {
  215. throw new ConfigException('Missing array in configuration file', array('file' => $sConfigFile, 'expected' => '$MySettings'));
  216. }
  217. if (!isset($MyModules) || !is_array($MyModules))
  218. {
  219. throw new ConfigException('Missing item in configuration file', array('file' => $sConfigFile, 'expected' => '$MyModules'));
  220. }
  221. if (!array_key_exists('application', $MyModules))
  222. {
  223. throw new ConfigException('Missing item in configuration file', array('file' => $sConfigFile, 'expected' => '$MyModules[\'application\']'));
  224. }
  225. if (!array_key_exists('business', $MyModules))
  226. {
  227. throw new ConfigException('Missing item in configuration file', array('file' => $sConfigFile, 'expected' => '$MyModules[\'business\']'));
  228. }
  229. if (!array_key_exists('addons', $MyModules))
  230. {
  231. throw new ConfigException('Missing item in configuration file', array('file' => $sConfigFile, 'expected' => '$MyModules[\'addons\']'));
  232. }
  233. if (!array_key_exists('user rights', $MyModules['addons']))
  234. {
  235. $MyModules['addons']['user rights'] = '../addons/userrights/userrightsnull.class.inc.php';
  236. }
  237. if (!array_key_exists('dictionaries', $MyModules))
  238. {
  239. throw new ConfigException('Missing item in configuration file', array('file' => $sConfigFile, 'expected' => '$MyModules[\'dictionaries\']'));
  240. }
  241. $this->m_aAppModules = $MyModules['application'];
  242. $this->m_aDataModels = $MyModules['business'];
  243. $this->m_aAddons = $MyModules['addons'];
  244. $this->m_aDictionaries = $MyModules['dictionaries'];
  245. $this->m_sDBHost = trim($MySettings['db_host']);
  246. $this->m_sDBUser = trim($MySettings['db_user']);
  247. $this->m_sDBPwd = trim($MySettings['db_pwd']);
  248. $this->m_sDBName = trim($MySettings['db_name']);
  249. $this->m_sDBSubname = trim($MySettings['db_subname']);
  250. $this->m_bLogGlobal = isset($MySettings['log_global']) ? (bool) trim($MySettings['log_global']) : DEFAULT_LOG_GLOBAL;
  251. $this->m_bLogNotification = isset($MySettings['log_notification']) ? (bool) trim($MySettings['log_notification']) : DEFAULT_LOG_NOTIFICATION;
  252. $this->m_bLogIssue = isset($MySettings['log_issue']) ? (bool) trim($MySettings['log_issue']) : DEFAULT_LOG_ISSUE;
  253. $this->m_bLogWebService = isset($MySettings['log_web_service']) ? (bool) trim($MySettings['log_web_service']) : DEFAULT_LOG_WEB_SERVICE;
  254. $this->m_bLogKPIDuration = isset($MySettings['log_kpi_duration']) ? (bool) trim($MySettings['log_kpi_duration']) : DEFAULT_LOG_KPI_DURATION;
  255. $this->m_bLogKPIMemory = isset($MySettings['log_kpi_memory']) ? (bool) trim($MySettings['log_kpi_memory']) : DEFAULT_LOG_KPI_MEMORY;
  256. $this->m_iMinDisplayLimit = isset($MySettings['min_display_limit']) ? trim($MySettings['min_display_limit']) : DEFAULT_MIN_DISPLAY_LIMIT;
  257. $this->m_iMaxDisplayLimit = isset($MySettings['max_display_limit']) ? trim($MySettings['max_display_limit']) : DEFAULT_MAX_DISPLAY_LIMIT;
  258. $this->m_iStandardReloadInterval = isset($MySettings['standard_reload_interval']) ? trim($MySettings['standard_reload_interval']) : DEFAULT_STANDARD_RELOAD_INTERVAL;
  259. $this->m_iFastReloadInterval = isset($MySettings['fast_reload_interval']) ? trim($MySettings['fast_reload_interval']) : DEFAULT_FAST_RELOAD_INTERVAL;
  260. $this->m_bSecureConnectionRequired = isset($MySettings['secure_connection_required']) ? (bool) trim($MySettings['secure_connection_required']) : DEFAULT_SECURE_CONNECTION_REQUIRED;
  261. $this->m_bHttpsHyperlinks = isset($MySettings['https_hyperlinks']) ? (bool) trim($MySettings['https_hyperlinks']) : DEFAULT_HTTPS_HYPERLINKS;
  262. $this->m_aModuleSettings = isset($MyModuleSettings) ? $MyModuleSettings : array();
  263. $this->m_sDefaultLanguage = isset($MySettings['default_language']) ? trim($MySettings['default_language']) : 'EN US';
  264. $this->m_sAllowedLoginTypes = isset($MySettings['allowed_login_types']) ? trim($MySettings['allowed_login_types']) : DEFAULT_ALLOWED_LOGIN_TYPES;
  265. $this->m_sExtAuthVariable = isset($MySettings['ext_auth_variable']) ? trim($MySettings['ext_auth_variable']) : DEFAULT_EXT_AUTH_VARIABLE;
  266. $this->m_sEncryptionKey = isset($MySettings['encryption_key']) ? trim($MySettings['encryption_key']) : DEFAULT_ENCRYPTION_KEY;
  267. }
  268. protected function Verify()
  269. {
  270. foreach ($this->m_aAppModules as $sModule => $sToInclude)
  271. {
  272. $this->CheckFile('application module', $sToInclude);
  273. }
  274. foreach ($this->m_aDataModels as $sModule => $sToInclude)
  275. {
  276. $this->CheckFile('business model', $sToInclude);
  277. }
  278. foreach ($this->m_aAddons as $sModule => $sToInclude)
  279. {
  280. $this->CheckFile('addon module', $sToInclude);
  281. }
  282. foreach ($this->m_aDictionaries as $sModule => $sToInclude)
  283. {
  284. $this->CheckFile('dictionary', $sToInclude);
  285. }
  286. }
  287. public function GetModuleSetting($sModule, $sProperty, $defaultvalue = null)
  288. {
  289. if (isset($this->m_aModuleSettings[$sModule][$sProperty]))
  290. {
  291. return $this->m_aModuleSettings[$sModule][$sProperty];
  292. }
  293. return $defaultvalue;
  294. }
  295. public function SetModuleSetting($sModule, $sProperty, $value)
  296. {
  297. $this->m_aModuleSettings[$sModule][$sProperty] = $value;
  298. }
  299. public function GetAppModules()
  300. {
  301. return $this->m_aAppModules;
  302. }
  303. public function SetAppModules($aAppModules)
  304. {
  305. $this->m_aAppModules = $aAppModules;
  306. }
  307. public function GetDataModels()
  308. {
  309. return $this->m_aDataModels;
  310. }
  311. public function SetDataModels($aDataModels)
  312. {
  313. $this->m_aDataModels = $aDataModels;
  314. }
  315. public function GetAddons()
  316. {
  317. return $this->m_aAddons;
  318. }
  319. public function SetAddons($aAddons)
  320. {
  321. $this->m_aAddons = $aAddons;
  322. }
  323. public function GetDictionaries()
  324. {
  325. return $this->m_aDictionaries;
  326. }
  327. public function SetDictionaries($aDictionaries)
  328. {
  329. $this->m_aDictionaries = $aDictionaries;
  330. }
  331. public function GetDBHost()
  332. {
  333. return $this->m_sDBHost;
  334. }
  335. public function GetDBName()
  336. {
  337. return $this->m_sDBName;
  338. }
  339. public function GetDBSubname()
  340. {
  341. return $this->m_sDBSubname;
  342. }
  343. public function GetDBUser()
  344. {
  345. return $this->m_sDBUser;
  346. }
  347. public function GetDBPwd()
  348. {
  349. return $this->m_sDBPwd;
  350. }
  351. public function GetLogGlobal()
  352. {
  353. return $this->m_bLogGlobal;
  354. }
  355. public function GetLogNotification()
  356. {
  357. return $this->m_bLogNotification;
  358. }
  359. public function GetLogIssue()
  360. {
  361. return $this->m_bLogIssue;
  362. }
  363. public function GetLogWebService()
  364. {
  365. return $this->m_bLogWebService;
  366. }
  367. public function GetLogKPIDuration()
  368. {
  369. return $this->m_bLogKPIDuration;
  370. }
  371. public function GetLogKPIMemory()
  372. {
  373. return $this->m_bLogKPIMemory;
  374. }
  375. public function GetMinDisplayLimit()
  376. {
  377. return $this->m_iMinDisplayLimit;
  378. }
  379. public function GetMaxDisplayLimit()
  380. {
  381. return $this->m_iMaxDisplayLimit;
  382. }
  383. public function GetStandardReloadInterval()
  384. {
  385. return $this->m_iStandardReloadInterval;
  386. }
  387. public function GetFastReloadInterval()
  388. {
  389. return $this->m_iFastReloadInterval;
  390. }
  391. public function GetSecureConnectionRequired()
  392. {
  393. return $this->m_bSecureConnectionRequired;
  394. }
  395. public function GetHttpsHyperlinks()
  396. {
  397. return $this->m_bHttpsHyperlinks;
  398. }
  399. public function GetDefaultLanguage()
  400. {
  401. return $this->m_sDefaultLanguage;
  402. }
  403. public function GetEncryptionKey()
  404. {
  405. return $this->m_sEncryptionKey;
  406. }
  407. public function GetAllowedLoginTypes()
  408. {
  409. return explode('|', $this->m_sAllowedLoginTypes);
  410. }
  411. public function GetExternalAuthenticationVariable()
  412. {
  413. return $this->m_sExtAuthVariable;
  414. }
  415. public function SetDBHost($sDBHost)
  416. {
  417. $this->m_sDBHost = $sDBHost;
  418. }
  419. public function SetDBName($sDBName)
  420. {
  421. $this->m_sDBName = $sDBName;
  422. }
  423. public function SetDBSubname($sDBSubName)
  424. {
  425. $this->m_sDBSubname = $sDBSubName;
  426. }
  427. public function SetDBUser($sUser)
  428. {
  429. $this->m_sDBUser = $sUser;
  430. }
  431. public function SetDBPwd($sPwd)
  432. {
  433. $this->m_sDBPwd = $sPwd;
  434. }
  435. public function SetLogGlobal($iLogGlobal)
  436. {
  437. $this->m_iLogGlobal = $iLogGlobal;
  438. }
  439. public function SetLogNotification($iLogNotification)
  440. {
  441. $this->m_iLogNotification = $iLogNotification;
  442. }
  443. public function SetLogIssue($iLogIssue)
  444. {
  445. $this->m_iLogIssue = $iLogIssue;
  446. }
  447. public function SetLogWebService($iLogWebService)
  448. {
  449. $this->m_iLogWebService = $iLogWebService;
  450. }
  451. public function SetMinDisplayLimit($iMinDisplayLimit)
  452. {
  453. $this->m_iMinDisplayLimit = $iMinDisplayLimit;
  454. }
  455. public function SetMaxDisplayLimit($iMaxDisplayLimit)
  456. {
  457. $this->m_iMaxDisplayLimit = $iMaxDisplayLimit;
  458. }
  459. public function SetStandardReloadInterval($iStandardReloadInterval)
  460. {
  461. $this->m_iStandardReloadInterval = $iStandardReloadInterval;
  462. }
  463. public function SetFastReloadInterval($iFastReloadInterval)
  464. {
  465. $this->m_iFastReloadInterval = $iFastReloadInterval;
  466. }
  467. public function SetSecureConnectionRequired($bSecureConnectionRequired)
  468. {
  469. $this->m_bSecureConnectionRequired = $bSecureConnectionRequired;
  470. }
  471. public function SetHttpsHyperlinks($bHttpsHyperlinks)
  472. {
  473. $this->m_bHttpsHyperlinks = $bHttpsHyperlinks;
  474. }
  475. public function SetDefaultLanguage($sLanguageCode)
  476. {
  477. $this->m_sDefaultLanguage = $sLanguageCode;
  478. }
  479. public function SetAllowedLoginTypes($aAllowedLoginTypes)
  480. {
  481. $this->m_sAllowedLoginTypes = implode('|', $aAllowedLoginTypes);
  482. }
  483. public function SetExternalAuthenticationVariable($sExtAuthVariable)
  484. {
  485. $this->m_sExtAuthVariable = $sExtAuthVariable;
  486. }
  487. public function SetEncryptionKey($sKey)
  488. {
  489. $this->m_sEncryptionKey = $sKey;
  490. }
  491. public function FileIsWritable()
  492. {
  493. return is_writable($this->m_sFile);
  494. }
  495. /**
  496. * Write the configuration to a file (php format) that can be reloaded later
  497. * By default write to the same file that was specified when constructing the object
  498. * @param $sFileName string Name of the file to write to (emtpy to write to the same file)
  499. * @return boolean True otherwise throws an Exception
  500. */
  501. public function WriteToFile($sFileName = '')
  502. {
  503. if (empty($sFileName))
  504. {
  505. $sFileName = $this->m_sFile;
  506. }
  507. $hFile = @fopen($sFileName, 'w');
  508. if ($hFile !== false)
  509. {
  510. fwrite($hFile, "<?php\n");
  511. fwrite($hFile, "\n/**\n");
  512. fwrite($hFile, " *\n");
  513. fwrite($hFile, " * phpMyORM configuration file, generated by the iTop configuration wizard\n");
  514. fwrite($hFile, " *\n");
  515. fwrite($hFile, " * The file is used in MetaModel::LoadConfig() which does all the necessary initialization job\n");
  516. fwrite($hFile, " *\n");
  517. fwrite($hFile, " */\n");
  518. fwrite($hFile, "\n");
  519. fwrite($hFile, "\$MySettings = array(\n");
  520. fwrite($hFile, "\t'db_host' => '{$this->m_sDBHost}',\n");
  521. fwrite($hFile, "\t'db_user' => '{$this->m_sDBUser}',\n");
  522. fwrite($hFile, "\t'db_pwd' => '".addslashes($this->m_sDBPwd)."',\n");
  523. fwrite($hFile, "\t'db_name' => '{$this->m_sDBName}',\n");
  524. fwrite($hFile, "\t'db_subname' => '{$this->m_sDBSubname}',\n");
  525. fwrite($hFile, "\n");
  526. fwrite($hFile, "\t'log_global' => {$this->m_bLogGlobal},\n");
  527. fwrite($hFile, "\t'log_notification' => {$this->m_bLogNotification},\n");
  528. fwrite($hFile, "\t'log_issue' => {$this->m_bLogIssue},\n");
  529. fwrite($hFile, "\t'log_web_service' => {$this->m_bLogWebService},\n");
  530. fwrite($hFile, "\t'min_display_limit' => {$this->m_iMinDisplayLimit},\n");
  531. fwrite($hFile, "\t'max_display_limit' => {$this->m_iMaxDisplayLimit},\n");
  532. fwrite($hFile, "\t'standard_reload_interval' => {$this->m_iStandardReloadInterval},\n");
  533. fwrite($hFile, "\t'fast_reload_interval' => {$this->m_iFastReloadInterval},\n");
  534. fwrite($hFile, "\t'secure_connection_required' => ".($this->m_bSecureConnectionRequired ? 'true' : 'false').",\n");
  535. fwrite($hFile, "\t'https_hyperlinks' => ".($this->m_bHttpsHyperlinks ? 'true' : 'false').",\n");
  536. fwrite($hFile, "\t'default_language' => '{$this->m_sDefaultLanguage}',\n");
  537. fwrite($hFile, "\t'allowed_login_types' => '{$this->m_sAllowedLoginTypes}',\n");
  538. fwrite($hFile, "\t'encryption_key' => '{$this->m_sEncryptionKey}',\n");
  539. fwrite($hFile, ");\n");
  540. fwrite($hFile, "\n");
  541. fwrite($hFile, "\$MyModuleSettings = array(\n");
  542. foreach ($this->m_aModuleSettings as $sModule => $aProperties)
  543. {
  544. fwrite($hFile, "\t'$sModule' => array (\n");
  545. foreach ($aProperties as $sProperty => $value)
  546. {
  547. $sExport = var_export($value, true);
  548. fwrite($hFile, "\t\t'$sProperty' => $sExport,\n");
  549. }
  550. fwrite($hFile, "\t),\n");
  551. }
  552. fwrite($hFile, ");\n");
  553. fwrite($hFile, "\n/**\n");
  554. fwrite($hFile, " *\n");
  555. fwrite($hFile, " * Data model modules to be loaded. Names should be specified as absolute paths\n");
  556. fwrite($hFile, " *\n");
  557. fwrite($hFile, " */\n");
  558. fwrite($hFile, "\$MyModules = array(\n");
  559. fwrite($hFile, "\t'application' => array (\n");
  560. foreach($this->m_aAppModules as $sFile)
  561. {
  562. fwrite($hFile, "\t\t'$sFile',\n");
  563. }
  564. fwrite($hFile, "\t),\n");
  565. fwrite($hFile, "\t'business' => array (\n");
  566. foreach($this->m_aDataModels as $sFile)
  567. {
  568. fwrite($hFile, "\t\t'$sFile',\n");
  569. }
  570. fwrite($hFile, "\t),\n");
  571. fwrite($hFile, "\t'addons' => array (\n");
  572. foreach($this->m_aAddons as $sKey => $sFile)
  573. {
  574. fwrite($hFile, "\t\t'$sKey' => '$sFile',\n");
  575. }
  576. fwrite($hFile, "\t),\n");
  577. fwrite($hFile, "\t'dictionaries' => array (\n");
  578. foreach($this->m_aDictionaries as $sFile)
  579. {
  580. fwrite($hFile, "\t\t'$sFile',\n");
  581. }
  582. fwrite($hFile, "\t),\n");
  583. fwrite($hFile, ");\n");
  584. fwrite($hFile, '?'.'>'); // Avoid perturbing the syntax highlighting !
  585. return fclose($hFile);
  586. }
  587. else
  588. {
  589. throw new ConfigException("Could not write to configuration file", array('file' => $sFileName));
  590. }
  591. }
  592. }
  593. ?>