config.class.inc.php 31 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964
  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_CHARACTER_SET', 'utf8');
  32. define ('DEFAULT_COLLATION', 'utf8_general_ci');
  33. define ('DEFAULT_LOG_GLOBAL', true);
  34. define ('DEFAULT_LOG_NOTIFICATION', true);
  35. define ('DEFAULT_LOG_ISSUE', true);
  36. define ('DEFAULT_LOG_WEB_SERVICE', true);
  37. define ('DEFAULT_LOG_KPI_DURATION', false);
  38. define ('DEFAULT_LOG_KPI_MEMORY', false);
  39. define ('DEFAULT_DEBUG_QUERIES', false);
  40. define ('DEFAULT_QUERY_CACHE_ENABLED', true);
  41. define ('DEFAULT_MIN_DISPLAY_LIMIT', 10);
  42. define ('DEFAULT_MAX_DISPLAY_LIMIT', 15);
  43. define ('DEFAULT_STANDARD_RELOAD_INTERVAL', 5*60);
  44. define ('DEFAULT_FAST_RELOAD_INTERVAL', 1*60);
  45. define ('DEFAULT_SECURE_CONNECTION_REQUIRED', false);
  46. define ('DEFAULT_HTTPS_HYPERLINKS', false);
  47. define ('DEFAULT_ALLOWED_LOGIN_TYPES', 'form|basic|external');
  48. define ('DEFAULT_EXT_AUTH_VARIABLE', '$_SERVER[\'REMOTE_USER\']');
  49. define ('DEFAULT_ENCRYPTION_KEY', '@iT0pEncr1pti0n!'); // We'll use a random value, later...
  50. /**
  51. * Config
  52. * configuration data (this class cannot not be localized, because it is responsible for loading the dictionaries)
  53. *
  54. * @package iTopORM
  55. */
  56. class Config
  57. {
  58. //protected $m_bIsLoaded = false;
  59. protected $m_sFile = '';
  60. protected $m_aAppModules;
  61. protected $m_aDataModels;
  62. protected $m_aWebServiceCategories;
  63. protected $m_aAddons;
  64. protected $m_aDictionaries;
  65. protected $m_aModuleSettings;
  66. // New way to store the settings !
  67. //
  68. protected $m_aSettings = array(
  69. 'skip_check_to_write' => array(
  70. 'type' => 'bool',
  71. 'description' => 'Disable data format and integrity checks to boost up data load (insert or update)',
  72. 'default' => false,
  73. 'value' => false,
  74. 'source_of_value' => '',
  75. 'show_in_conf_sample' => false,
  76. ),
  77. 'skip_check_ext_keys' => array(
  78. 'type' => 'bool',
  79. 'description' => 'Disable external key check when checking the value of attribtutes',
  80. 'default' => false,
  81. 'value' => false,
  82. 'source_of_value' => '',
  83. 'show_in_conf_sample' => false,
  84. ),
  85. 'skip_strong_security' => array(
  86. 'type' => 'bool',
  87. 'description' => 'Disable strong security - TEMPORY: this flag should be removed when we are more confident in the recent change in security',
  88. 'default' => true,
  89. 'value' => true,
  90. 'source_of_value' => '',
  91. 'show_in_conf_sample' => false,
  92. ),
  93. 'graphviz_path' => array(
  94. 'type' => 'string',
  95. 'description' => 'Path to the Graphviz "dot" executable for graphing objects lifecycle',
  96. 'default' => '/usr/bin/dot',
  97. 'value' => '',
  98. 'source_of_value' => '',
  99. 'show_in_conf_sample' => false,
  100. ),
  101. 'session_name' => array(
  102. 'type' => 'string',
  103. 'description' => 'The name of the cookie used to store the PHP session id',
  104. 'default' => 'iTop',
  105. 'value' => '',
  106. 'source_of_value' => '',
  107. 'show_in_conf_sample' => true,
  108. ),
  109. 'max_combo_length' => array(
  110. 'type' => 'int',
  111. 'description' => 'The maximum number of elements in a drop-down list. If more then an autocomplete will be used',
  112. 'default' => 50,
  113. 'value' => 50,
  114. 'source_of_value' => '',
  115. 'show_in_conf_sample' => false,
  116. ),
  117. 'min_autocomplete_chars' => array(
  118. 'type' => 'int',
  119. 'description' => 'The minimum number of characters to type in order to trigger the "autocomplete" behavior',
  120. 'default' => 3,
  121. 'value' => 3,
  122. 'source_of_value' => '',
  123. 'show_in_conf_sample' => false,
  124. ),
  125. 'database_read_only' => array(
  126. 'type' => 'bool',
  127. 'description' => 'Freeze the data for administration purposes - administrators can still do anything... in appearance!',
  128. 'default' => false,
  129. 'value' => '',
  130. 'source_of_value' => '',
  131. 'show_in_conf_sample' => false,
  132. ),
  133. );
  134. public function IsProperty($sPropCode)
  135. {
  136. return (array_key_exists($sPropCode, $this->m_aSettings));
  137. }
  138. public function Set($sPropCode, $value, $sSourceDesc = 'unknown')
  139. {
  140. $sType = $this->m_aSettings[$sPropCode]['type'];
  141. switch($sType)
  142. {
  143. case 'bool':
  144. $value = (bool) $value;
  145. break;
  146. case 'string':
  147. $value = (string) $value;
  148. break;
  149. case 'integer':
  150. $value = (integer) $value;
  151. break;
  152. case 'float':
  153. $value = (float) $value;
  154. break;
  155. default:
  156. throw new CoreException('Unknown type for setting', array('property' => $sPropCode, 'type' => $sType));
  157. }
  158. $this->m_aSettings[$sPropCode]['value'] = $value;
  159. $this->m_aSettings[$sPropCode]['source_of_value'] = $sSourceDesc;
  160. }
  161. public function Get($sPropCode)
  162. {
  163. return $this->m_aSettings[$sPropCode]['value'];
  164. }
  165. // Those variables will be deprecated later, when the transition to ...Get('my_setting') will be done
  166. protected $m_sDBHost;
  167. protected $m_sDBUser;
  168. protected $m_sDBPwd;
  169. protected $m_sDBName;
  170. protected $m_sDBSubname;
  171. protected $m_sDBCharacterSet;
  172. protected $m_sDBCollation;
  173. /**
  174. * Event log options (see LOG_... definition)
  175. */
  176. // Those variables will be deprecated later, when the transition to ...Get('my_setting') will be done
  177. protected $m_bLogGlobal;
  178. protected $m_bLogNotification;
  179. protected $m_bLogIssue;
  180. protected $m_bLogWebService;
  181. protected $m_bLogKpiDuration; // private setting
  182. protected $m_bLogKpiMemory; // private setting
  183. protected $m_bDebugQueries; // private setting
  184. protected $m_bQueryCacheEnabled; // private setting
  185. /**
  186. * @var integer Number of elements to be displayed when there are more than m_iMaxDisplayLimit elements
  187. */
  188. protected $m_iMinDisplayLimit;
  189. /**
  190. * @var integer Max number of elements before truncating the display
  191. */
  192. protected $m_iMaxDisplayLimit;
  193. /**
  194. * @var integer Number of seconds between two reloads of the display (standard)
  195. */
  196. protected $m_iStandardReloadInterval;
  197. /**
  198. * @var integer Number of seconds between two reloads of the display (fast)
  199. */
  200. protected $m_iFastReloadInterval;
  201. /**
  202. * @var boolean Whether or not a secure connection is required for using the application.
  203. * If set, any attempt to connect to an iTop page with http:// will be redirected
  204. * to https://
  205. */
  206. protected $m_bSecureConnectionRequired;
  207. /**
  208. * @var boolean Forces iTop to output hyperlinks starting with https:// even
  209. * if the current page is not using https. This can be useful when
  210. * the application runs behind a SSL gateway
  211. */
  212. protected $m_bHttpsHyperlinks;
  213. /**
  214. * @var string Langage code, default if the user language is undefined
  215. */
  216. protected $m_sDefaultLanguage;
  217. /**
  218. * @var string Type of login process allowed: form|basic|url|external
  219. */
  220. protected $m_sAllowedLoginTypes;
  221. /**
  222. * @var string Name of the PHP variable in which external authentication information is passed by the web server
  223. */
  224. protected $m_sExtAuthVariable;
  225. /**
  226. * @var string Encryption key used for all attributes of type "encrypted string". Can be set to a random value
  227. * unless you want to import a database from another iTop instance, in which case you must use
  228. * the same encryption key in order to properly decode the encrypted fields
  229. */
  230. protected $m_sEncryptionKey;
  231. /**
  232. * @var array Additional character sets to be supported by the interactive CSV import
  233. * 'iconv_code' => 'display name'
  234. */
  235. protected $m_aCharsets;
  236. public function __construct($sConfigFile, $bLoadConfig = true)
  237. {
  238. $this->m_sFile = $sConfigFile;
  239. $this->m_aAppModules = array(
  240. // Some default modules, always present can be move to an official iTop Module later if needed
  241. 'application/transaction.class.inc.php',
  242. 'application/menunode.class.inc.php',
  243. 'application/user.preferences.class.inc.php',
  244. 'application/audit.rule.class.inc.php',
  245. // Romain - That's dirty, because those 3 classes are in fact part of the core
  246. // but I needed those classes to be derived from cmdbAbstractObject
  247. // (to be managed via the GUI) and this class in not really known from
  248. // the core, PLUS I needed the includes to be there also for the setup
  249. // to create the tables.
  250. 'core/event.class.inc.php',
  251. 'core/action.class.inc.php',
  252. 'core/trigger.class.inc.php',
  253. );
  254. $this->m_aDataModels = array();
  255. $this->m_aWebServiceCategories = array(
  256. 'webservices/webservices.basic.php',
  257. );
  258. $this->m_aAddons = array(
  259. // Default AddOn, always present can be moved to an official iTop Module later if needed
  260. 'user rights' => 'addons/userrights/userrightsprofile.class.inc.php',
  261. );
  262. $this->m_aDictionaries = array(
  263. // Default dictionaries, always present can be moved to an official iTop Module later if needed
  264. 'dictionaries/dictionary.itop.core.php',
  265. 'dictionaries/dictionary.itop.ui.php', // Support for English
  266. 'dictionaries/fr.dictionary.itop.ui.php', // Support for French
  267. 'dictionaries/fr.dictionary.itop.core.php', // Support for French
  268. 'dictionaries/es_cr.dictionary.itop.ui.php', // Support for Spanish (from Costa Rica)
  269. 'dictionaries/es_cr.dictionary.itop.core.php', // Support for Spanish (from Costa Rica)
  270. 'dictionaries/de.dictionary.itop.ui.php', // Support for German
  271. 'dictionaries/de.dictionary.itop.core.php', // Support for German
  272. 'dictionaries/pt_br.dictionary.itop.ui.php', // Support for Brazilian Portuguese
  273. 'dictionaries/pt_br.dictionary.itop.core.php', // Support for Brazilian Portuguese
  274. );
  275. foreach($this->m_aSettings as $sPropCode => $aSettingInfo)
  276. {
  277. $this->m_aSettings[$sPropCode]['value'] = $aSettingInfo['default'];
  278. }
  279. $this->m_sDBHost = '';
  280. $this->m_sDBUser = '';
  281. $this->m_sDBPwd = '';
  282. $this->m_sDBName = '';
  283. $this->m_sDBSubname = '';
  284. $this->m_sDBCharacterSet = DEFAULT_CHARACTER_SET;
  285. $this->m_sDBCollation = DEFAULT_COLLATION;
  286. $this->m_bLogGlobal = DEFAULT_LOG_GLOBAL;
  287. $this->m_bLogNotification = DEFAULT_LOG_NOTIFICATION;
  288. $this->m_bLogIssue = DEFAULT_LOG_ISSUE;
  289. $this->m_bLogWebService = DEFAULT_LOG_WEB_SERVICE;
  290. $this->m_bLogKPIDuration = DEFAULT_LOG_KPI_DURATION;
  291. $this->m_bLogKPIDuration = DEFAULT_LOG_KPI_DURATION;
  292. $this->m_iMinDisplayLimit = DEFAULT_MIN_DISPLAY_LIMIT;
  293. $this->m_iMaxDisplayLimit = DEFAULT_MAX_DISPLAY_LIMIT;
  294. $this->m_iStandardReloadInterval = DEFAULT_STANDARD_RELOAD_INTERVAL;
  295. $this->m_iFastReloadInterval = DEFAULT_FAST_RELOAD_INTERVAL;
  296. $this->m_bSecureConnectionRequired = DEFAULT_SECURE_CONNECTION_REQUIRED;
  297. $this->m_bHttpsHyperlinks = DEFAULT_HTTPS_HYPERLINKS;
  298. $this->m_sDefaultLanguage = 'EN US';
  299. $this->m_sAllowedLoginTypes = DEFAULT_ALLOWED_LOGIN_TYPES;
  300. $this->m_sExtAuthVariable = DEFAULT_EXT_AUTH_VARIABLE;
  301. $this->m_sEncryptionKey = DEFAULT_ENCRYPTION_KEY;
  302. $this->m_aCharsets = array();
  303. $this->m_aModuleSettings = array();
  304. if ($bLoadConfig)
  305. {
  306. $this->Load($sConfigFile);
  307. $this->Verify();
  308. }
  309. }
  310. protected function CheckFile($sPurpose, $sFileName)
  311. {
  312. if (!file_exists($sFileName))
  313. {
  314. throw new ConfigException("Could not find $sPurpose file", array('file' => $sFileName));
  315. }
  316. }
  317. protected function Load($sConfigFile)
  318. {
  319. $this->CheckFile('configuration', $sConfigFile);
  320. $sConfigCode = trim(file_get_contents($sConfigFile));
  321. // This does not work on several lines
  322. // preg_match('/^<\\?php(.*)\\?'.'>$/', $sConfigCode, $aMatches)...
  323. // So, I've implemented a solution suggested in the PHP doc (search for phpWrapper)
  324. try
  325. {
  326. ob_start();
  327. eval('?'.'>'.trim($sConfigCode));
  328. $sNoise = trim(ob_get_contents());
  329. ob_end_clean();
  330. }
  331. catch (Exception $e)
  332. {
  333. // well, never reach in case of parsing error :-(
  334. // will be improved in PHP 6 ?
  335. throw new ConfigException('Error in configuration file', array('file' => $sConfigFile, 'error' => $e->getMessage()));
  336. }
  337. if (strlen($sNoise) > 0)
  338. {
  339. // Note: sNoise is an html output, but so far it was ok for me (e.g. showing the entire call stack)
  340. throw new ConfigException('Syntax error in configuration file', array('file' => $sConfigFile, 'error' => '<tt>'.htmlentities($sNoise).'</tt>'));
  341. }
  342. if (!isset($MySettings) || !is_array($MySettings))
  343. {
  344. throw new ConfigException('Missing array in configuration file', array('file' => $sConfigFile, 'expected' => '$MySettings'));
  345. }
  346. if (!isset($MyModules) || !is_array($MyModules))
  347. {
  348. throw new ConfigException('Missing item in configuration file', array('file' => $sConfigFile, 'expected' => '$MyModules'));
  349. }
  350. if (!array_key_exists('application', $MyModules))
  351. {
  352. throw new ConfigException('Missing item in configuration file', array('file' => $sConfigFile, 'expected' => '$MyModules[\'application\']'));
  353. }
  354. if (!array_key_exists('business', $MyModules))
  355. {
  356. throw new ConfigException('Missing item in configuration file', array('file' => $sConfigFile, 'expected' => '$MyModules[\'business\']'));
  357. }
  358. if (!array_key_exists('addons', $MyModules))
  359. {
  360. throw new ConfigException('Missing item in configuration file', array('file' => $sConfigFile, 'expected' => '$MyModules[\'addons\']'));
  361. }
  362. if (!array_key_exists('user rights', $MyModules['addons']))
  363. {
  364. // Add one, by default
  365. $MyModules['addons']['user rights'] = '/addons/userrights/userrightsnull.class.inc.php';
  366. }
  367. if (!array_key_exists('dictionaries', $MyModules))
  368. {
  369. throw new ConfigException('Missing item in configuration file', array('file' => $sConfigFile, 'expected' => '$MyModules[\'dictionaries\']'));
  370. }
  371. $this->m_aAppModules = $MyModules['application'];
  372. $this->m_aDataModels = $MyModules['business'];
  373. $this->m_aWebServiceCategories = $MyModules['webservices'];
  374. $this->m_aAddons = $MyModules['addons'];
  375. $this->m_aDictionaries = $MyModules['dictionaries'];
  376. foreach($MySettings as $sPropCode => $rawvalue)
  377. {
  378. if ($this->IsProperty($sPropCode))
  379. {
  380. $value = trim($rawvalue);
  381. $this->Set($sPropCode, $value, $sConfigFile);
  382. }
  383. }
  384. $this->m_sDBHost = trim($MySettings['db_host']);
  385. $this->m_sDBUser = trim($MySettings['db_user']);
  386. $this->m_sDBPwd = trim($MySettings['db_pwd']);
  387. $this->m_sDBName = trim($MySettings['db_name']);
  388. $this->m_sDBSubname = trim($MySettings['db_subname']);
  389. $this->m_sDBCharacterSet = isset($MySettings['db_character_set']) ? trim($MySettings['db_character_set']) : DEFAULT_CHARACTER_SET;
  390. $this->m_sDBCollation = isset($MySettings['db_collation']) ? trim($MySettings['db_collation']) : DEFAULT_COLLATION;
  391. $this->m_bLogGlobal = isset($MySettings['log_global']) ? (bool) trim($MySettings['log_global']) : DEFAULT_LOG_GLOBAL;
  392. $this->m_bLogNotification = isset($MySettings['log_notification']) ? (bool) trim($MySettings['log_notification']) : DEFAULT_LOG_NOTIFICATION;
  393. $this->m_bLogIssue = isset($MySettings['log_issue']) ? (bool) trim($MySettings['log_issue']) : DEFAULT_LOG_ISSUE;
  394. $this->m_bLogWebService = isset($MySettings['log_web_service']) ? (bool) trim($MySettings['log_web_service']) : DEFAULT_LOG_WEB_SERVICE;
  395. $this->m_bLogKPIDuration = isset($MySettings['log_kpi_duration']) ? (bool) trim($MySettings['log_kpi_duration']) : DEFAULT_LOG_KPI_DURATION;
  396. $this->m_bLogKPIMemory = isset($MySettings['log_kpi_memory']) ? (bool) trim($MySettings['log_kpi_memory']) : DEFAULT_LOG_KPI_MEMORY;
  397. $this->m_bDebugQueries = isset($MySettings['debug_queries']) ? (bool) trim($MySettings['debug_queries']) : DEFAULT_DEBUG_QUERIES;
  398. $this->m_bQueryCacheEnabled = isset($MySettings['query_cache_enabled']) ? (bool) trim($MySettings['query_cache_enabled']) : DEFAULT_QUERY_CACHE_ENABLED;
  399. $this->m_iMinDisplayLimit = isset($MySettings['min_display_limit']) ? trim($MySettings['min_display_limit']) : DEFAULT_MIN_DISPLAY_LIMIT;
  400. $this->m_iMaxDisplayLimit = isset($MySettings['max_display_limit']) ? trim($MySettings['max_display_limit']) : DEFAULT_MAX_DISPLAY_LIMIT;
  401. $this->m_iStandardReloadInterval = isset($MySettings['standard_reload_interval']) ? trim($MySettings['standard_reload_interval']) : DEFAULT_STANDARD_RELOAD_INTERVAL;
  402. $this->m_iFastReloadInterval = isset($MySettings['fast_reload_interval']) ? trim($MySettings['fast_reload_interval']) : DEFAULT_FAST_RELOAD_INTERVAL;
  403. $this->m_bSecureConnectionRequired = isset($MySettings['secure_connection_required']) ? (bool) trim($MySettings['secure_connection_required']) : DEFAULT_SECURE_CONNECTION_REQUIRED;
  404. $this->m_bHttpsHyperlinks = isset($MySettings['https_hyperlinks']) ? (bool) trim($MySettings['https_hyperlinks']) : DEFAULT_HTTPS_HYPERLINKS;
  405. $this->m_aModuleSettings = isset($MyModuleSettings) ? $MyModuleSettings : array();
  406. $this->m_sDefaultLanguage = isset($MySettings['default_language']) ? trim($MySettings['default_language']) : 'EN US';
  407. $this->m_sAllowedLoginTypes = isset($MySettings['allowed_login_types']) ? trim($MySettings['allowed_login_types']) : DEFAULT_ALLOWED_LOGIN_TYPES;
  408. $this->m_sExtAuthVariable = isset($MySettings['ext_auth_variable']) ? trim($MySettings['ext_auth_variable']) : DEFAULT_EXT_AUTH_VARIABLE;
  409. $this->m_sEncryptionKey = isset($MySettings['encryption_key']) ? trim($MySettings['encryption_key']) : DEFAULT_ENCRYPTION_KEY;
  410. $this->m_aCharsets = isset($MySettings['csv_import_charsets']) ? $MySettings['csv_import_charsets'] : array();
  411. }
  412. protected function Verify()
  413. {
  414. // Files are verified later on, just before using them -see MetaModel::Plugin()
  415. // (we have their final path at that point)
  416. }
  417. public function GetModuleSetting($sModule, $sProperty, $defaultvalue = null)
  418. {
  419. if (isset($this->m_aModuleSettings[$sModule][$sProperty]))
  420. {
  421. return $this->m_aModuleSettings[$sModule][$sProperty];
  422. }
  423. return $defaultvalue;
  424. }
  425. public function SetModuleSetting($sModule, $sProperty, $value)
  426. {
  427. $this->m_aModuleSettings[$sModule][$sProperty] = $value;
  428. }
  429. public function GetAppModules()
  430. {
  431. return $this->m_aAppModules;
  432. }
  433. public function SetAppModules($aAppModules)
  434. {
  435. $this->m_aAppModules = $aAppModules;
  436. }
  437. public function GetDataModels()
  438. {
  439. return $this->m_aDataModels;
  440. }
  441. public function SetDataModels($aDataModels)
  442. {
  443. $this->m_aDataModels = $aDataModels;
  444. }
  445. public function GetWebServiceCategories()
  446. {
  447. return $this->m_aWebServiceCategories;
  448. }
  449. public function SetWebServiceCategories($aWebServiceCategories)
  450. {
  451. $this->m_aWebServiceCategories = $aWebServiceCategories;
  452. }
  453. public function GetAddons()
  454. {
  455. return $this->m_aAddons;
  456. }
  457. public function SetAddons($aAddons)
  458. {
  459. $this->m_aAddons = $aAddons;
  460. }
  461. public function GetDictionaries()
  462. {
  463. return $this->m_aDictionaries;
  464. }
  465. public function SetDictionaries($aDictionaries)
  466. {
  467. $this->m_aDictionaries = $aDictionaries;
  468. }
  469. public function GetDBHost()
  470. {
  471. return $this->m_sDBHost;
  472. }
  473. public function GetDBName()
  474. {
  475. return $this->m_sDBName;
  476. }
  477. public function GetDBSubname()
  478. {
  479. return $this->m_sDBSubname;
  480. }
  481. public function GetDBCharacterSet()
  482. {
  483. return $this->m_sDBCharacterSet;
  484. }
  485. public function GetDBCollation()
  486. {
  487. return $this->m_sDBCollation;
  488. }
  489. public function GetDBUser()
  490. {
  491. return $this->m_sDBUser;
  492. }
  493. public function GetDBPwd()
  494. {
  495. return $this->m_sDBPwd;
  496. }
  497. public function GetLogGlobal()
  498. {
  499. return $this->m_bLogGlobal;
  500. }
  501. public function GetLogNotification()
  502. {
  503. return $this->m_bLogNotification;
  504. }
  505. public function GetLogIssue()
  506. {
  507. return $this->m_bLogIssue;
  508. }
  509. public function GetLogWebService()
  510. {
  511. return $this->m_bLogWebService;
  512. }
  513. public function GetLogKPIDuration()
  514. {
  515. return $this->m_bLogKPIDuration;
  516. }
  517. public function GetLogKPIMemory()
  518. {
  519. return $this->m_bLogKPIMemory;
  520. }
  521. public function GetDebugQueries()
  522. {
  523. return $this->m_bDebugQueries;
  524. }
  525. public function GetQueryCacheEnabled()
  526. {
  527. return $this->m_bQueryCacheEnabled;
  528. }
  529. public function GetMinDisplayLimit()
  530. {
  531. return $this->m_iMinDisplayLimit;
  532. }
  533. public function GetMaxDisplayLimit()
  534. {
  535. return $this->m_iMaxDisplayLimit;
  536. }
  537. public function GetStandardReloadInterval()
  538. {
  539. return $this->m_iStandardReloadInterval;
  540. }
  541. public function GetFastReloadInterval()
  542. {
  543. return $this->m_iFastReloadInterval;
  544. }
  545. public function GetSecureConnectionRequired()
  546. {
  547. return $this->m_bSecureConnectionRequired;
  548. }
  549. public function GetHttpsHyperlinks()
  550. {
  551. return $this->m_bHttpsHyperlinks;
  552. }
  553. public function GetDefaultLanguage()
  554. {
  555. return $this->m_sDefaultLanguage;
  556. }
  557. public function GetEncryptionKey()
  558. {
  559. return $this->m_sEncryptionKey;
  560. }
  561. public function GetAllowedLoginTypes()
  562. {
  563. return explode('|', $this->m_sAllowedLoginTypes);
  564. }
  565. public function GetExternalAuthenticationVariable()
  566. {
  567. return $this->m_sExtAuthVariable;
  568. }
  569. public function GetCSVImportCharsets()
  570. {
  571. return $this->m_aCharsets;
  572. }
  573. public function SetDBHost($sDBHost)
  574. {
  575. $this->m_sDBHost = $sDBHost;
  576. }
  577. public function SetDBName($sDBName)
  578. {
  579. $this->m_sDBName = $sDBName;
  580. }
  581. public function SetDBSubname($sDBSubName)
  582. {
  583. $this->m_sDBSubname = $sDBSubName;
  584. }
  585. public function SetDBCharacterSet($sDBCharacterSet)
  586. {
  587. $this->m_sDBCharacterSet = $sDBCharacterSet;
  588. }
  589. public function SetDBCollation($sDBCollation)
  590. {
  591. $this->m_sDBCollation = $sDBCollation;
  592. }
  593. public function SetDBUser($sUser)
  594. {
  595. $this->m_sDBUser = $sUser;
  596. }
  597. public function SetDBPwd($sPwd)
  598. {
  599. $this->m_sDBPwd = $sPwd;
  600. }
  601. public function SetLogGlobal($iLogGlobal)
  602. {
  603. $this->m_iLogGlobal = $iLogGlobal;
  604. }
  605. public function SetLogNotification($iLogNotification)
  606. {
  607. $this->m_iLogNotification = $iLogNotification;
  608. }
  609. public function SetLogIssue($iLogIssue)
  610. {
  611. $this->m_iLogIssue = $iLogIssue;
  612. }
  613. public function SetLogWebService($iLogWebService)
  614. {
  615. $this->m_iLogWebService = $iLogWebService;
  616. }
  617. public function SetMinDisplayLimit($iMinDisplayLimit)
  618. {
  619. $this->m_iMinDisplayLimit = $iMinDisplayLimit;
  620. }
  621. public function SetMaxDisplayLimit($iMaxDisplayLimit)
  622. {
  623. $this->m_iMaxDisplayLimit = $iMaxDisplayLimit;
  624. }
  625. public function SetStandardReloadInterval($iStandardReloadInterval)
  626. {
  627. $this->m_iStandardReloadInterval = $iStandardReloadInterval;
  628. }
  629. public function SetFastReloadInterval($iFastReloadInterval)
  630. {
  631. $this->m_iFastReloadInterval = $iFastReloadInterval;
  632. }
  633. public function SetSecureConnectionRequired($bSecureConnectionRequired)
  634. {
  635. $this->m_bSecureConnectionRequired = $bSecureConnectionRequired;
  636. }
  637. public function SetHttpsHyperlinks($bHttpsHyperlinks)
  638. {
  639. $this->m_bHttpsHyperlinks = $bHttpsHyperlinks;
  640. }
  641. public function SetDefaultLanguage($sLanguageCode)
  642. {
  643. $this->m_sDefaultLanguage = $sLanguageCode;
  644. }
  645. public function SetAllowedLoginTypes($aAllowedLoginTypes)
  646. {
  647. $this->m_sAllowedLoginTypes = implode('|', $aAllowedLoginTypes);
  648. }
  649. public function SetExternalAuthenticationVariable($sExtAuthVariable)
  650. {
  651. $this->m_sExtAuthVariable = $sExtAuthVariable;
  652. }
  653. public function SetEncryptionKey($sKey)
  654. {
  655. $this->m_sEncryptionKey = $sKey;
  656. }
  657. public function SetCSVImportCharsets($aCharsets)
  658. {
  659. $this->m_aCharsets = $aCharsets;
  660. }
  661. public function AddCSVImportCharset($sIconvCode, $sDisplayName)
  662. {
  663. $this->m_aCharsets[$sIconvCode] = $sDisplayName;
  664. }
  665. public function FileIsWritable()
  666. {
  667. return is_writable($this->m_sFile);
  668. }
  669. /**
  670. * Render the configuration as an associative array
  671. * @return boolean True otherwise throws an Exception
  672. */
  673. public function ToArray()
  674. {
  675. $aSettings = array();
  676. foreach($this->m_aSettings as $sPropCode => $aSettingInfo)
  677. {
  678. $aSettings[$sPropCode] = $aSettingInfo['value'];
  679. }
  680. $aSettings['db_host'] = $this->m_sDBHost;
  681. $aSettings['db_user'] = $this->m_sDBUser;
  682. $aSettings['db_pwd'] = $this->m_sDBPwd;
  683. $aSettings['db_name'] = $this->m_sDBName;
  684. $aSettings['db_subname'] = $this->m_sDBSubname;
  685. $aSettings['db_character_set'] = $this->m_sDBCharacterSet;
  686. $aSettings['db_collation'] = $this->m_sDBCollation;
  687. $aSettings['log_global'] = $this->m_bLogGlobal;
  688. $aSettings['log_notification'] = $this->m_bLogNotification;
  689. $aSettings['log_issue'] = $this->m_bLogIssue;
  690. $aSettings['log_web_service'] = $this->m_bLogWebService;
  691. $aSettings['min_display_limit'] = $this->m_iMinDisplayLimit;
  692. $aSettings['max_display_limit'] = $this->m_iMaxDisplayLimit;
  693. $aSettings['standard_reload_interval'] = $this->m_iStandardReloadInterval;
  694. $aSettings['fast_reload_interval'] = $this->m_iFastReloadInterval;
  695. $aSettings['secure_connection_required'] = $this->m_bSecureConnectionRequired;
  696. $aSettings['https_hyperlinks'] = $this->m_bHttpsHyperlinks;
  697. $aSettings['default_language'] = $this->m_sDefaultLanguage;
  698. $aSettings['allowed_login_types'] = $this->m_sAllowedLoginTypes;
  699. $aSettings['encryption_key'] = $this->m_sEncryptionKey;
  700. $aSettings['csv_import_charsets'] = $this->m_aCharsets;
  701. foreach ($this->m_aModuleSettings as $sModule => $aProperties)
  702. {
  703. foreach ($aProperties as $sProperty => $value)
  704. {
  705. $aSettings['module_settings'][$sModule][$sProperty] = $value;
  706. }
  707. }
  708. foreach($this->m_aAppModules as $sFile)
  709. {
  710. $aSettings['application_list'][] = $sFile;
  711. }
  712. foreach($this->m_aDataModels as $sFile)
  713. {
  714. $aSettings['datamodel_list'][] = $sFile;
  715. }
  716. foreach($this->m_aWebServiceCategories as $sFile)
  717. {
  718. $aSettings['webservice_list'][] = $sFile;
  719. }
  720. foreach($this->m_aAddons as $sKey => $sFile)
  721. {
  722. $aSettings['addon_list'][] = $sFile;
  723. }
  724. foreach($this->m_aDictionaries as $sFile)
  725. {
  726. $aSettings['dictionary_list'][] = $sFile;
  727. }
  728. return $aSettings;
  729. }
  730. /**
  731. * Write the configuration to a file (php format) that can be reloaded later
  732. * By default write to the same file that was specified when constructing the object
  733. * @param $sFileName string Name of the file to write to (emtpy to write to the same file)
  734. * @return boolean True otherwise throws an Exception
  735. */
  736. public function WriteToFile($sFileName = '')
  737. {
  738. if (empty($sFileName))
  739. {
  740. $sFileName = $this->m_sFile;
  741. }
  742. $hFile = @fopen($sFileName, 'w');
  743. if ($hFile !== false)
  744. {
  745. fwrite($hFile, "<?php\n");
  746. fwrite($hFile, "\n/**\n");
  747. fwrite($hFile, " *\n");
  748. fwrite($hFile, " * phpMyORM configuration file, generated by the iTop configuration wizard\n");
  749. fwrite($hFile, " *\n");
  750. fwrite($hFile, " * The file is used in MetaModel::LoadConfig() which does all the necessary initialization job\n");
  751. fwrite($hFile, " *\n");
  752. fwrite($hFile, " */\n");
  753. fwrite($hFile, "\n");
  754. fwrite($hFile, "\$MySettings = array(\n");
  755. foreach($this->m_aSettings as $sPropCode => $aSettingInfo)
  756. {
  757. if ($aSettingInfo['show_in_conf_sample'])
  758. {
  759. $sType = $this->m_aSettings[$sPropCode]['type'];
  760. switch($sType)
  761. {
  762. case 'bool':
  763. $sSeenAs = $aSettingInfo['value'] ? '1' : '0';
  764. break;
  765. default:
  766. $sSeenAs = "'".$aSettingInfo['value']."'";
  767. }
  768. fwrite($hFile, "\t'$sPropCode' => $sSeenAs,\n");
  769. }
  770. }
  771. fwrite($hFile, "\t'db_host' => '{$this->m_sDBHost}',\n");
  772. fwrite($hFile, "\t'db_user' => '{$this->m_sDBUser}',\n");
  773. fwrite($hFile, "\t'db_pwd' => '".addslashes($this->m_sDBPwd)."',\n");
  774. fwrite($hFile, "\t'db_name' => '{$this->m_sDBName}',\n");
  775. fwrite($hFile, "\t'db_subname' => '{$this->m_sDBSubname}',\n");
  776. fwrite($hFile, "\t'db_character_set' => '{$this->m_sDBCharacterSet}',\n");
  777. fwrite($hFile, "\t'db_collation' => '{$this->m_sDBCollation}',\n");
  778. fwrite($hFile, "\n");
  779. fwrite($hFile, "\t'log_global' => {$this->m_bLogGlobal},\n");
  780. fwrite($hFile, "\t'log_notification' => {$this->m_bLogNotification},\n");
  781. fwrite($hFile, "\t'log_issue' => {$this->m_bLogIssue},\n");
  782. fwrite($hFile, "\t'log_web_service' => {$this->m_bLogWebService},\n");
  783. fwrite($hFile, "\t'min_display_limit' => {$this->m_iMinDisplayLimit},\n");
  784. fwrite($hFile, "\t'max_display_limit' => {$this->m_iMaxDisplayLimit},\n");
  785. fwrite($hFile, "\t'standard_reload_interval' => {$this->m_iStandardReloadInterval},\n");
  786. fwrite($hFile, "\t'fast_reload_interval' => {$this->m_iFastReloadInterval},\n");
  787. fwrite($hFile, "\t'secure_connection_required' => ".($this->m_bSecureConnectionRequired ? 'true' : 'false').",\n");
  788. fwrite($hFile, "\t'https_hyperlinks' => ".($this->m_bHttpsHyperlinks ? 'true' : 'false').",\n");
  789. fwrite($hFile, "\t'default_language' => '{$this->m_sDefaultLanguage}',\n");
  790. fwrite($hFile, "\t'allowed_login_types' => '{$this->m_sAllowedLoginTypes}',\n");
  791. fwrite($hFile, "\t'encryption_key' => '{$this->m_sEncryptionKey}',\n");
  792. $sExport = var_export($this->m_aCharsets, true);
  793. fwrite($hFile, "\t'csv_import_charsets' => $sExport,\n");
  794. fwrite($hFile, ");\n");
  795. fwrite($hFile, "\n");
  796. fwrite($hFile, "\$MyModuleSettings = array(\n");
  797. foreach ($this->m_aModuleSettings as $sModule => $aProperties)
  798. {
  799. fwrite($hFile, "\t'$sModule' => array (\n");
  800. foreach ($aProperties as $sProperty => $value)
  801. {
  802. $sExport = var_export($value, true);
  803. fwrite($hFile, "\t\t'$sProperty' => $sExport,\n");
  804. }
  805. fwrite($hFile, "\t),\n");
  806. }
  807. fwrite($hFile, ");\n");
  808. fwrite($hFile, "\n/**\n");
  809. fwrite($hFile, " *\n");
  810. fwrite($hFile, " * Data model modules to be loaded. Names should be specified as absolute paths\n");
  811. fwrite($hFile, " *\n");
  812. fwrite($hFile, " */\n");
  813. fwrite($hFile, "\$MyModules = array(\n");
  814. fwrite($hFile, "\t'application' => array (\n");
  815. foreach($this->m_aAppModules as $sFile)
  816. {
  817. fwrite($hFile, "\t\t'$sFile',\n");
  818. }
  819. fwrite($hFile, "\t),\n");
  820. fwrite($hFile, "\t'business' => array (\n");
  821. foreach($this->m_aDataModels as $sFile)
  822. {
  823. fwrite($hFile, "\t\t'$sFile',\n");
  824. }
  825. fwrite($hFile, "\t),\n");
  826. fwrite($hFile, "\t'webservices' => array (\n");
  827. foreach($this->m_aWebServiceCategories as $sFile)
  828. {
  829. fwrite($hFile, "\t\t'$sFile',\n");
  830. }
  831. fwrite($hFile, "\t),\n");
  832. fwrite($hFile, "\t'addons' => array (\n");
  833. foreach($this->m_aAddons as $sKey => $sFile)
  834. {
  835. fwrite($hFile, "\t\t'$sKey' => '$sFile',\n");
  836. }
  837. fwrite($hFile, "\t),\n");
  838. fwrite($hFile, "\t'dictionaries' => array (\n");
  839. foreach($this->m_aDictionaries as $sFile)
  840. {
  841. fwrite($hFile, "\t\t'$sFile',\n");
  842. }
  843. fwrite($hFile, "\t),\n");
  844. fwrite($hFile, ");\n");
  845. fwrite($hFile, '?'.'>'); // Avoid perturbing the syntax highlighting !
  846. return fclose($hFile);
  847. }
  848. else
  849. {
  850. throw new ConfigException("Could not write to configuration file", array('file' => $sFileName));
  851. }
  852. }
  853. }
  854. ?>