config.class.inc.php 49 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493
  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_APPLICATION', 'iTop');
  17. define('ITOP_VERSION', '$ITOP_VERSION$');
  18. define('ITOP_REVISION', '$WCREV$');
  19. define('ITOP_BUILD_DATE', '$WCNOW$');
  20. define('ACCESS_USER_WRITE', 1);
  21. define('ACCESS_ADMIN_WRITE', 2);
  22. define('ACCESS_FULL', ACCESS_USER_WRITE | ACCESS_ADMIN_WRITE);
  23. define('ACCESS_READONLY', 0);
  24. /**
  25. * Configuration read/write
  26. *
  27. * @author Erwan Taloc <erwan.taloc@combodo.com>
  28. * @author Romain Quetiez <romain.quetiez@combodo.com>
  29. * @author Denis Flaven <denis.flaven@combodo.com>
  30. * @license http://www.opensource.org/licenses/gpl-3.0.html LGPL
  31. */
  32. require_once('coreexception.class.inc.php');
  33. class ConfigException extends CoreException
  34. {
  35. }
  36. define ('DEFAULT_CHARACTER_SET', 'utf8');
  37. define ('DEFAULT_COLLATION', 'utf8_unicode_ci');
  38. define ('DEFAULT_LOG_GLOBAL', true);
  39. define ('DEFAULT_LOG_NOTIFICATION', true);
  40. define ('DEFAULT_LOG_ISSUE', true);
  41. define ('DEFAULT_LOG_WEB_SERVICE', true);
  42. define ('DEFAULT_LOG_KPI_DURATION', false);
  43. define ('DEFAULT_LOG_KPI_MEMORY', false);
  44. define ('DEFAULT_DEBUG_QUERIES', false);
  45. define ('DEFAULT_QUERY_CACHE_ENABLED', true);
  46. define ('DEFAULT_MIN_DISPLAY_LIMIT', 10);
  47. define ('DEFAULT_MAX_DISPLAY_LIMIT', 15);
  48. define ('DEFAULT_STANDARD_RELOAD_INTERVAL', 5*60);
  49. define ('DEFAULT_FAST_RELOAD_INTERVAL', 1*60);
  50. define ('DEFAULT_SECURE_CONNECTION_REQUIRED', false);
  51. define ('DEFAULT_ALLOWED_LOGIN_TYPES', 'form|basic|external');
  52. define ('DEFAULT_EXT_AUTH_VARIABLE', '$_SERVER[\'REMOTE_USER\']');
  53. define ('DEFAULT_ENCRYPTION_KEY', '@iT0pEncr1pti0n!'); // We'll use a random value, later...
  54. /**
  55. * Config
  56. * configuration data (this class cannot not be localized, because it is responsible for loading the dictionaries)
  57. *
  58. * @package iTopORM
  59. */
  60. class Config
  61. {
  62. //protected $m_bIsLoaded = false;
  63. protected $m_sFile = '';
  64. protected $m_aAppModules;
  65. protected $m_aDataModels;
  66. protected $m_aWebServiceCategories;
  67. protected $m_aAddons;
  68. protected $m_aDictionaries;
  69. protected $m_aModuleSettings;
  70. // New way to store the settings !
  71. //
  72. protected $m_aSettings = array(
  73. 'app_env_label' => array(
  74. 'type' => 'string',
  75. 'description' => 'Label displayed to describe the current application environnment, defaults to the environment name (e.g. "production")',
  76. 'default' => '',
  77. 'value' => '',
  78. 'source_of_value' => '',
  79. 'show_in_conf_sample' => true,
  80. ),
  81. 'app_root_url' => array(
  82. 'type' => 'string',
  83. 'description' => 'Root URL used for navigating within the application, or from an email to the application (you can put $SERVER_NAME$ as a placeholder for the server\'s name)',
  84. 'default' => '',
  85. 'value' => '',
  86. 'source_of_value' => '',
  87. 'show_in_conf_sample' => true,
  88. ),
  89. 'skip_check_to_write' => array(
  90. 'type' => 'bool',
  91. 'description' => 'Disable data format and integrity checks to boost up data load (insert or update)',
  92. 'default' => false,
  93. 'value' => false,
  94. 'source_of_value' => '',
  95. 'show_in_conf_sample' => false,
  96. ),
  97. 'skip_check_ext_keys' => array(
  98. 'type' => 'bool',
  99. 'description' => 'Disable external key check when checking the value of attributes',
  100. 'default' => false,
  101. 'value' => false,
  102. 'source_of_value' => '',
  103. 'show_in_conf_sample' => false,
  104. ),
  105. 'skip_strong_security' => array(
  106. 'type' => 'bool',
  107. 'description' => 'Disable strong security - TEMPORY: this flag should be removed when we are more confident in the recent change in security',
  108. 'default' => true,
  109. 'value' => true,
  110. 'source_of_value' => '',
  111. 'show_in_conf_sample' => false,
  112. ),
  113. 'graphviz_path' => array(
  114. 'type' => 'string',
  115. 'description' => 'Path to the Graphviz "dot" executable for graphing objects lifecycle',
  116. 'default' => '/usr/bin/dot',
  117. 'value' => '',
  118. 'source_of_value' => '',
  119. 'show_in_conf_sample' => false,
  120. ),
  121. 'php_path' => array(
  122. 'type' => 'string',
  123. 'description' => 'Path to the php executable in CLI mode',
  124. 'default' => 'php',
  125. 'value' => 'php',
  126. 'source_of_value' => '',
  127. 'show_in_conf_sample' => true,
  128. ),
  129. 'session_name' => array(
  130. 'type' => 'string',
  131. 'description' => 'The name of the cookie used to store the PHP session id',
  132. 'default' => 'iTop',
  133. 'value' => '',
  134. 'source_of_value' => '',
  135. 'show_in_conf_sample' => true,
  136. ),
  137. 'max_combo_length' => array(
  138. 'type' => 'integer',
  139. 'description' => 'The maximum number of elements in a drop-down list. If more then an autocomplete will be used',
  140. 'default' => 50,
  141. 'value' => 50,
  142. 'source_of_value' => '',
  143. 'show_in_conf_sample' => false,
  144. ),
  145. 'min_autocomplete_chars' => array(
  146. 'type' => 'integer',
  147. 'description' => 'The minimum number of characters to type in order to trigger the "autocomplete" behavior',
  148. 'default' => 3,
  149. 'value' => 3,
  150. 'source_of_value' => '',
  151. 'show_in_conf_sample' => false,
  152. ),
  153. 'allow_target_creation' => array(
  154. 'type' => 'bool',
  155. 'description' => 'Displays the + button on external keys to create target objects',
  156. 'default' => true,
  157. 'value' => true,
  158. 'source_of_value' => '',
  159. 'show_in_conf_sample' => false,
  160. ),
  161. // Levels that trigger a confirmation in the CSV import/synchro wizard
  162. 'csv_import_min_object_confirmation' => array(
  163. 'type' => 'integer',
  164. 'description' => 'Minimum number of objects to check for the confirmation percentages',
  165. 'default' => 3,
  166. 'value' => 3,
  167. 'source_of_value' => '',
  168. 'show_in_conf_sample' => false,
  169. ),
  170. 'csv_import_errors_percentage' => array(
  171. 'type' => 'integer',
  172. 'description' => 'Percentage of errors that trigger a confirmation in the CSV import',
  173. 'default' => 50,
  174. 'value' => 50,
  175. 'source_of_value' => '',
  176. 'show_in_conf_sample' => false,
  177. ),
  178. 'csv_import_modifications_percentage' => array(
  179. 'type' => 'integer',
  180. 'description' => 'Percentage of modifications that trigger a confirmation in the CSV import',
  181. 'default' => 50,
  182. 'value' => 50,
  183. 'source_of_value' => '',
  184. 'show_in_conf_sample' => false,
  185. ),
  186. 'csv_import_creations_percentage' => array(
  187. 'type' => 'integer',
  188. 'description' => 'Percentage of creations that trigger a confirmation in the CSV import',
  189. 'default' => 50,
  190. 'value' => 50,
  191. 'source_of_value' => '',
  192. 'show_in_conf_sample' => false,
  193. ),
  194. 'access_mode' => array(
  195. 'type' => 'integer',
  196. 'description' => 'Combination of flags (ACCESS_USER_WRITE | ACCESS_ADMIN_WRITE, or ACCESS_FULL)',
  197. 'default' => ACCESS_FULL,
  198. 'value' => ACCESS_FULL,
  199. 'source_of_value' => '',
  200. 'show_in_conf_sample' => true,
  201. ),
  202. 'access_message' => array(
  203. 'type' => 'string',
  204. 'description' => 'Message displayed to the users when there is any access restriction',
  205. 'default' => 'iTop is temporarily frozen, please wait... (the admin team)',
  206. 'value' => '',
  207. 'source_of_value' => '',
  208. 'show_in_conf_sample' => true,
  209. ),
  210. 'online_help' => array(
  211. 'type' => 'string',
  212. 'description' => 'Hyperlink to the online-help web page',
  213. 'default' => 'http://www.combodo.com/itop-help',
  214. 'value' => '',
  215. 'source_of_value' => '',
  216. 'show_in_conf_sample' => true,
  217. ),
  218. 'log_usage' => array(
  219. 'type' => 'bool',
  220. 'description' => 'Log the usage of the application (i.e. the date/time and the user name of each login)',
  221. 'default' => false,
  222. 'value' => false,
  223. 'source_of_value' => '',
  224. 'show_in_conf_sample' => false,
  225. ),
  226. 'synchro_trace' => array(
  227. 'type' => 'string',
  228. 'description' => 'Synchronization details: none, display, save (includes \'display\')',
  229. 'default' => 'none',
  230. 'value' => 'none',
  231. 'source_of_value' => '',
  232. 'show_in_conf_sample' => true,
  233. ),
  234. 'link_set_item_separator' => array(
  235. 'type' => 'string',
  236. 'description' => 'Link set from string: line separator',
  237. 'default' => '|',
  238. 'value' => '|',
  239. 'source_of_value' => '',
  240. 'show_in_conf_sample' => true,
  241. ),
  242. 'link_set_attribute_separator' => array(
  243. 'type' => 'string',
  244. 'description' => 'Link set from string: attribute separator',
  245. 'default' => ';',
  246. 'value' => ';',
  247. 'source_of_value' => '',
  248. 'show_in_conf_sample' => true,
  249. ),
  250. 'link_set_value_separator' => array(
  251. 'type' => 'string',
  252. 'description' => 'Link set from string: value separator (between the attcode and the value itself',
  253. 'default' => ':',
  254. 'value' => ':',
  255. 'source_of_value' => '',
  256. 'show_in_conf_sample' => true,
  257. ),
  258. 'link_set_attribute_qualifier' => array(
  259. 'type' => 'string',
  260. 'description' => 'Link set from string: attribute qualifier (encloses both the attcode and the value)',
  261. 'default' => "'",
  262. 'value' => "'",
  263. 'source_of_value' => '',
  264. 'show_in_conf_sample' => true,
  265. ),
  266. 'cron_max_execution_time' => array(
  267. 'type' => 'integer',
  268. 'description' => 'Duration (seconds) of the page cron.php, must be shorter than php setting max_execution_time and shorter than the web server response timeout',
  269. 'default' => 600,
  270. 'value' => 600,
  271. 'source_of_value' => '',
  272. 'show_in_conf_sample' => true,
  273. ),
  274. 'cron_sleep' => array(
  275. 'type' => 'integer',
  276. 'description' => 'Duration (seconds) before cron.php checks again if something must be done',
  277. 'default' => 2,
  278. 'value' => 2,
  279. 'source_of_value' => '',
  280. 'show_in_conf_sample' => false,
  281. ),
  282. 'email_asynchronous' => array(
  283. 'type' => 'bool',
  284. 'description' => 'If set, the emails are sent off line, which requires cron.php to be activated. Exception: some features like the email test utility will force the serialized mode',
  285. 'default' => false,
  286. 'value' => false,
  287. 'source_of_value' => '',
  288. 'show_in_conf_sample' => true,
  289. ),
  290. 'email_transport' => array(
  291. 'type' => 'string',
  292. 'description' => 'Mean to send emails: PHPMail (uses the function mail()) or SMTP (implements the client protocole)',
  293. 'default' => "PHPMail",
  294. 'value' => "PHPMail",
  295. 'source_of_value' => '',
  296. 'show_in_conf_sample' => true,
  297. ),
  298. 'email_transport_smtp.host' => array(
  299. 'type' => 'string',
  300. 'description' => 'host name or IP address (optional)',
  301. 'default' => "localhost",
  302. 'value' => "localhost",
  303. 'source_of_value' => '',
  304. 'show_in_conf_sample' => false,
  305. ),
  306. 'email_transport_smtp.port' => array(
  307. 'type' => 'integer',
  308. 'description' => 'port number (optional)',
  309. 'default' => 25,
  310. 'value' => 25,
  311. 'source_of_value' => '',
  312. 'show_in_conf_sample' => false,
  313. ),
  314. 'email_transport_smtp.encryption' => array(
  315. 'type' => 'string',
  316. 'description' => 'tls or ssl (optional)',
  317. 'default' => "",
  318. 'value' => "",
  319. 'source_of_value' => '',
  320. 'show_in_conf_sample' => false,
  321. ),
  322. 'email_transport_smtp.username' => array(
  323. 'type' => 'string',
  324. 'description' => 'Authentication user (optional)',
  325. 'default' => "",
  326. 'value' => "",
  327. 'source_of_value' => '',
  328. 'show_in_conf_sample' => false,
  329. ),
  330. 'email_transport_smtp.password' => array(
  331. 'type' => 'string',
  332. 'description' => 'Authentication password (optional)',
  333. 'default' => "",
  334. 'value' => "",
  335. 'source_of_value' => '',
  336. 'show_in_conf_sample' => false,
  337. ),
  338. 'apc_cache.enabled' => array(
  339. 'type' => 'bool',
  340. 'description' => 'If set, the APC cache is allowed (the PHP extension must also be active)',
  341. 'default' => true,
  342. 'value' => true,
  343. 'source_of_value' => '',
  344. 'show_in_conf_sample' => true,
  345. ),
  346. 'apc_cache.query_ttl' => array(
  347. 'type' => 'integer',
  348. 'description' => 'Time to live set in APC for the prepared queries (seconds - 0 means no timeout)',
  349. 'default' => 3600,
  350. 'value' => 3600,
  351. 'source_of_value' => '',
  352. 'show_in_conf_sample' => true,
  353. ),
  354. 'timezone' => array(
  355. 'type' => 'string',
  356. 'description' => 'Timezone (reference: http://php.net/manual/en/timezones.php). If empty, it will be left unchanged and MUST be explicitely configured in PHP',
  357. // examples... not used (nor 'description')
  358. 'examples' => array('America/Sao_Paulo', 'America/New_York (standing for EDT)', 'America/Los_Angeles (standing for PDT)', 'Asia/Istanbul', 'Asia/Singapore', 'Africa/Casablanca', 'Australia/Sydney'),
  359. 'default' => 'Europe/Paris',
  360. 'value' => 'Europe/Paris',
  361. 'source_of_value' => '',
  362. 'show_in_conf_sample' => true,
  363. ),
  364. 'cas_include_path' => array(
  365. 'type' => 'string',
  366. 'description' => 'The path where to find the phpCAS library',
  367. // examples... not used (nor 'description')
  368. 'default' => '/usr/share/php',
  369. 'value' => '/usr/share/php',
  370. 'source_of_value' => '',
  371. 'show_in_conf_sample' => true,
  372. ),
  373. 'cas_version' => array(
  374. 'type' => 'string',
  375. 'description' => 'The CAS protocol version to use: "1.0" (CAS v1), "2.0" (CAS v2) or "S1" (SAML V1) )',
  376. // examples... not used (nor 'description')
  377. 'default' => '2.0',
  378. 'value' => '',
  379. 'source_of_value' => '',
  380. 'show_in_conf_sample' => true,
  381. ),
  382. 'cas_host' => array(
  383. 'type' => 'string',
  384. 'description' => 'The name of the CAS host',
  385. // examples... not used (nor 'description')
  386. 'default' => '',
  387. 'value' => '',
  388. 'source_of_value' => '',
  389. 'show_in_conf_sample' => true,
  390. ),
  391. 'cas_port' => array(
  392. 'type' => 'integer',
  393. 'description' => 'The port used by the CAS server',
  394. // examples... not used (nor 'description')
  395. 'default' => 443,
  396. 'value' => 443,
  397. 'source_of_value' => '',
  398. 'show_in_conf_sample' => true,
  399. ),
  400. 'cas_context' => array(
  401. 'type' => 'string',
  402. 'description' => 'The CAS context',
  403. // examples... not used (nor 'description')
  404. 'default' => '',
  405. 'value' => '',
  406. 'source_of_value' => '',
  407. 'show_in_conf_sample' => true,
  408. ),
  409. 'cas_server_ca_cert_path' => array(
  410. 'type' => 'string',
  411. 'description' => 'The path where to find the certificate of the CA for validating the certificate of the CAS server',
  412. // examples... not used (nor 'description')
  413. 'default' => '',
  414. 'value' => '',
  415. 'source_of_value' => '',
  416. 'show_in_conf_sample' => true,
  417. ),
  418. 'cas_logout_redirect_service' => array(
  419. 'type' => 'string',
  420. 'description' => 'The redirect service (URL) to use when logging-out with CAS',
  421. // examples... not used (nor 'description')
  422. 'default' => '',
  423. 'value' => '',
  424. 'source_of_value' => '',
  425. 'show_in_conf_sample' => true,
  426. ),
  427. 'cas_memberof' => array(
  428. 'type' => 'string',
  429. 'description' => 'A semicolon separated list of group names that the user must be member of (works only with SAML - e.g. cas_version=> "S1")',
  430. // examples... not used (nor 'description')
  431. 'default' => '',
  432. 'value' => '',
  433. 'source_of_value' => '',
  434. 'show_in_conf_sample' => true,
  435. ),
  436. 'cas_user_synchro' => array(
  437. 'type' => 'bool',
  438. 'description' => 'Whether or not to synchronize users with CAS/LDAP',
  439. // examples... not used (nor 'description')
  440. 'default' => 0,
  441. 'value' => 0,
  442. 'source_of_value' => '',
  443. 'show_in_conf_sample' => true,
  444. ),
  445. 'cas_update_profiles' => array(
  446. 'type' => 'bool',
  447. 'description' => 'Whether or not to update the profiles of an existing user from the CAS information',
  448. // examples... not used (nor 'description')
  449. 'default' => 0,
  450. 'value' => 0,
  451. 'source_of_value' => '',
  452. 'show_in_conf_sample' => true,
  453. ),
  454. 'cas_profile_pattern' => array(
  455. 'type' => 'string',
  456. 'description' => 'A regular expression pattern to extract the name of the iTop profile from the name of an LDAP/CAS group',
  457. // examples... not used (nor 'description')
  458. 'default' => '/^cn=([^,]+),/',
  459. 'value' => '/^cn=([^,]+),/',
  460. 'source_of_value' => '',
  461. 'show_in_conf_sample' => true,
  462. ),
  463. 'cas_default_profiles' => array(
  464. 'type' => 'string',
  465. 'description' => 'A semi-colon separated list of iTop Profiles to use when creating a new user if no profile is retrieved from CAS',
  466. // examples... not used (nor 'description')
  467. 'default' => 'Portal user',
  468. 'value' => 'Portal user',
  469. 'source_of_value' => '',
  470. 'show_in_conf_sample' => true,
  471. ),
  472. 'cas_debug' => array(
  473. 'type' => 'bool',
  474. 'description' => 'Activate the CAS debug',
  475. // examples... not used (nor 'description')
  476. 'default' => false,
  477. 'value' => false,
  478. 'source_of_value' => '',
  479. 'show_in_conf_sample' => true,
  480. ),
  481. 'deadline_format' => array(
  482. 'type' => 'string',
  483. 'description' => 'The format used for displaying "deadline" attributes: any string with the following placeholders: $date$, $difference$',
  484. // examples... $date$ ($deadline$)
  485. 'default' => '$difference$',
  486. 'value' => '$difference$',
  487. 'source_of_value' => '',
  488. 'show_in_conf_sample' => true,
  489. ),
  490. 'buttons_position' => array(
  491. 'type' => 'string',
  492. 'description' => 'Position of the forms buttons: bottom | top | both',
  493. // examples... not used
  494. 'default' => 'both',
  495. 'value' => 'both',
  496. 'source_of_value' => '',
  497. 'show_in_conf_sample' => true,
  498. ),
  499. 'shortcut_actions' => array(
  500. 'type' => 'string',
  501. 'description' => 'Actions that are available as direct buttons next to the "Actions" menu',
  502. // examples... not used
  503. 'default' => 'UI:Menu:Modify,UI:Menu:New',
  504. 'value' => 'UI:Menu:Modify',
  505. 'source_of_value' => '',
  506. 'show_in_conf_sample' => true,
  507. ),
  508. );
  509. public function IsProperty($sPropCode)
  510. {
  511. return (array_key_exists($sPropCode, $this->m_aSettings));
  512. }
  513. public function GetDescription($sPropCode)
  514. {
  515. return $this->m_aSettings[$sPropCode];
  516. }
  517. public function Set($sPropCode, $value, $sSourceDesc = 'unknown')
  518. {
  519. $sType = $this->m_aSettings[$sPropCode]['type'];
  520. switch($sType)
  521. {
  522. case 'bool':
  523. $value = (bool) $value;
  524. break;
  525. case 'string':
  526. $value = (string) $value;
  527. break;
  528. case 'integer':
  529. $value = (integer) $value;
  530. break;
  531. case 'float':
  532. $value = (float) $value;
  533. break;
  534. default:
  535. throw new CoreException('Unknown type for setting', array('property' => $sPropCode, 'type' => $sType));
  536. }
  537. $this->m_aSettings[$sPropCode]['value'] = $value;
  538. $this->m_aSettings[$sPropCode]['source_of_value'] = $sSourceDesc;
  539. }
  540. public function Get($sPropCode)
  541. {
  542. return $this->m_aSettings[$sPropCode]['value'];
  543. }
  544. // Those variables will be deprecated later, when the transition to ...Get('my_setting') will be done
  545. protected $m_sDBHost;
  546. protected $m_sDBUser;
  547. protected $m_sDBPwd;
  548. protected $m_sDBName;
  549. protected $m_sDBSubname;
  550. protected $m_sDBCharacterSet;
  551. protected $m_sDBCollation;
  552. /**
  553. * Event log options (see LOG_... definition)
  554. */
  555. // Those variables will be deprecated later, when the transition to ...Get('my_setting') will be done
  556. protected $m_bLogGlobal;
  557. protected $m_bLogNotification;
  558. protected $m_bLogIssue;
  559. protected $m_bLogWebService;
  560. protected $m_bLogKPIDuration; // private setting
  561. protected $m_bLogKPIMemory; // private setting
  562. protected $m_bDebugQueries; // private setting
  563. protected $m_bQueryCacheEnabled; // private setting
  564. /**
  565. * @var integer Number of elements to be displayed when there are more than m_iMaxDisplayLimit elements
  566. */
  567. protected $m_iMinDisplayLimit;
  568. /**
  569. * @var integer Max number of elements before truncating the display
  570. */
  571. protected $m_iMaxDisplayLimit;
  572. /**
  573. * @var integer Number of seconds between two reloads of the display (standard)
  574. */
  575. protected $m_iStandardReloadInterval;
  576. /**
  577. * @var integer Number of seconds between two reloads of the display (fast)
  578. */
  579. protected $m_iFastReloadInterval;
  580. /**
  581. * @var boolean Whether or not a secure connection is required for using the application.
  582. * If set, any attempt to connect to an iTop page with http:// will be redirected
  583. * to https://
  584. */
  585. protected $m_bSecureConnectionRequired;
  586. /**
  587. * @var string Langage code, default if the user language is undefined
  588. */
  589. protected $m_sDefaultLanguage;
  590. /**
  591. * @var string Type of login process allowed: form|basic|url|external
  592. */
  593. protected $m_sAllowedLoginTypes;
  594. /**
  595. * @var string Name of the PHP variable in which external authentication information is passed by the web server
  596. */
  597. protected $m_sExtAuthVariable;
  598. /**
  599. * @var string Encryption key used for all attributes of type "encrypted string". Can be set to a random value
  600. * unless you want to import a database from another iTop instance, in which case you must use
  601. * the same encryption key in order to properly decode the encrypted fields
  602. */
  603. protected $m_sEncryptionKey;
  604. /**
  605. * @var array Additional character sets to be supported by the interactive CSV import
  606. * 'iconv_code' => 'display name'
  607. */
  608. protected $m_aCharsets;
  609. public function __construct($sConfigFile = null, $bLoadConfig = true)
  610. {
  611. $this->m_sFile = $sConfigFile;
  612. if (is_null($sConfigFile))
  613. {
  614. $bLoadConfig = false;
  615. }
  616. $this->m_aAppModules = array(
  617. // Some default modules, always present can be move to an official iTop Module later if needed
  618. 'application/transaction.class.inc.php',
  619. 'application/menunode.class.inc.php',
  620. 'application/user.preferences.class.inc.php',
  621. 'application/user.dashboard.class.inc.php',
  622. 'application/audit.rule.class.inc.php',
  623. 'application/query.class.inc.php',
  624. // Romain - That's dirty, because those classes are in fact part of the core
  625. // but I needed those classes to be derived from cmdbAbstractObject
  626. // (to be managed via the GUI) and this class in not really known from
  627. // the core, PLUS I needed the includes to be there also for the setup
  628. // to create the tables.
  629. 'core/event.class.inc.php',
  630. 'core/action.class.inc.php',
  631. 'core/trigger.class.inc.php',
  632. 'synchro/synchrodatasource.class.inc.php',
  633. );
  634. $this->m_aDataModels = array();
  635. $this->m_aWebServiceCategories = array(
  636. 'webservices/webservices.basic.php',
  637. );
  638. $this->m_aAddons = array(
  639. // Default AddOn, always present can be moved to an official iTop Module later if needed
  640. 'user rights' => 'addons/userrights/userrightsprofile.class.inc.php',
  641. );
  642. $this->m_aDictionaries = self::ScanDictionariesDir();
  643. foreach($this->m_aSettings as $sPropCode => $aSettingInfo)
  644. {
  645. $this->m_aSettings[$sPropCode]['value'] = $aSettingInfo['default'];
  646. }
  647. $this->m_sDBHost = '';
  648. $this->m_sDBUser = '';
  649. $this->m_sDBPwd = '';
  650. $this->m_sDBName = '';
  651. $this->m_sDBSubname = '';
  652. $this->m_sDBCharacterSet = DEFAULT_CHARACTER_SET;
  653. $this->m_sDBCollation = DEFAULT_COLLATION;
  654. $this->m_bLogGlobal = DEFAULT_LOG_GLOBAL;
  655. $this->m_bLogNotification = DEFAULT_LOG_NOTIFICATION;
  656. $this->m_bLogIssue = DEFAULT_LOG_ISSUE;
  657. $this->m_bLogWebService = DEFAULT_LOG_WEB_SERVICE;
  658. $this->m_bLogKPIDuration = DEFAULT_LOG_KPI_DURATION;
  659. $this->m_bLogKPIDuration = DEFAULT_LOG_KPI_DURATION;
  660. $this->m_iMinDisplayLimit = DEFAULT_MIN_DISPLAY_LIMIT;
  661. $this->m_iMaxDisplayLimit = DEFAULT_MAX_DISPLAY_LIMIT;
  662. $this->m_iStandardReloadInterval = DEFAULT_STANDARD_RELOAD_INTERVAL;
  663. $this->m_iFastReloadInterval = DEFAULT_FAST_RELOAD_INTERVAL;
  664. $this->m_bSecureConnectionRequired = DEFAULT_SECURE_CONNECTION_REQUIRED;
  665. $this->m_sDefaultLanguage = 'EN US';
  666. $this->m_sAllowedLoginTypes = DEFAULT_ALLOWED_LOGIN_TYPES;
  667. $this->m_sExtAuthVariable = DEFAULT_EXT_AUTH_VARIABLE;
  668. $this->m_sEncryptionKey = DEFAULT_ENCRYPTION_KEY;
  669. $this->m_aCharsets = array();
  670. $this->m_aModuleSettings = array();
  671. if ($bLoadConfig)
  672. {
  673. $this->Load($sConfigFile);
  674. $this->Verify();
  675. }
  676. // Application root url: set a default value, then normalize it
  677. $sAppRootUrl = trim($this->Get('app_root_url'));
  678. if (strlen($sAppRootUrl) == 0)
  679. {
  680. $sAppRootUrl = utils::GetDefaultUrlAppRoot();
  681. }
  682. if (substr($sAppRootUrl, -1, 1) != '/')
  683. {
  684. $sAppRootUrl .= '/';
  685. }
  686. $this->Set('app_root_url', $sAppRootUrl);
  687. }
  688. protected function CheckFile($sPurpose, $sFileName)
  689. {
  690. if (!file_exists($sFileName))
  691. {
  692. throw new ConfigException("Could not find $sPurpose file", array('file' => $sFileName));
  693. }
  694. if (!is_readable($sFileName))
  695. {
  696. throw new ConfigException("Could not read $sPurpose file (the file exists but cannot be read). Do you have the rights to access this file?", array('file' => $sFileName));
  697. }
  698. }
  699. protected function Load($sConfigFile)
  700. {
  701. $this->CheckFile('configuration', $sConfigFile);
  702. $sConfigCode = trim(file_get_contents($sConfigFile));
  703. // This does not work on several lines
  704. // preg_match('/^<\\?php(.*)\\?'.'>$/', $sConfigCode, $aMatches)...
  705. // So, I've implemented a solution suggested in the PHP doc (search for phpWrapper)
  706. try
  707. {
  708. ob_start();
  709. eval('?'.'>'.trim($sConfigCode));
  710. $sNoise = trim(ob_get_contents());
  711. ob_end_clean();
  712. }
  713. catch (Exception $e)
  714. {
  715. // well, never reach in case of parsing error :-(
  716. // will be improved in PHP 6 ?
  717. throw new ConfigException('Error in configuration file', array('file' => $sConfigFile, 'error' => $e->getMessage()));
  718. }
  719. if (strlen($sNoise) > 0)
  720. {
  721. // Note: sNoise is an html output, but so far it was ok for me (e.g. showing the entire call stack)
  722. throw new ConfigException('Syntax error in configuration file', array('file' => $sConfigFile, 'error' => '<tt>'.htmlentities($sNoise, ENT_QUOTES, 'UTF-8').'</tt>'));
  723. }
  724. if (!isset($MySettings) || !is_array($MySettings))
  725. {
  726. throw new ConfigException('Missing array in configuration file', array('file' => $sConfigFile, 'expected' => '$MySettings'));
  727. }
  728. if (!isset($MyModules) || !is_array($MyModules))
  729. {
  730. throw new ConfigException('Missing item in configuration file', array('file' => $sConfigFile, 'expected' => '$MyModules'));
  731. }
  732. if (!array_key_exists('application', $MyModules))
  733. {
  734. throw new ConfigException('Missing item in configuration file', array('file' => $sConfigFile, 'expected' => '$MyModules[\'application\']'));
  735. }
  736. if (!array_key_exists('business', $MyModules))
  737. {
  738. throw new ConfigException('Missing item in configuration file', array('file' => $sConfigFile, 'expected' => '$MyModules[\'business\']'));
  739. }
  740. if (!array_key_exists('addons', $MyModules))
  741. {
  742. throw new ConfigException('Missing item in configuration file', array('file' => $sConfigFile, 'expected' => '$MyModules[\'addons\']'));
  743. }
  744. if (!array_key_exists('user rights', $MyModules['addons']))
  745. {
  746. // Add one, by default
  747. $MyModules['addons']['user rights'] = '/addons/userrights/userrightsnull.class.inc.php';
  748. }
  749. if (!array_key_exists('dictionaries', $MyModules))
  750. {
  751. throw new ConfigException('Missing item in configuration file', array('file' => $sConfigFile, 'expected' => '$MyModules[\'dictionaries\']'));
  752. }
  753. $this->m_aAppModules = $MyModules['application'];
  754. $this->m_aDataModels = $MyModules['business'];
  755. if (isset($MyModules['webservices']))
  756. {
  757. $this->m_aWebServiceCategories = $MyModules['webservices'];
  758. }
  759. $this->m_aAddons = $MyModules['addons'];
  760. $this->m_aDictionaries = $MyModules['dictionaries'];
  761. foreach($MySettings as $sPropCode => $rawvalue)
  762. {
  763. if ($this->IsProperty($sPropCode))
  764. {
  765. $value = trim($rawvalue);
  766. $this->Set($sPropCode, $value, $sConfigFile);
  767. }
  768. }
  769. $this->m_sDBHost = trim($MySettings['db_host']);
  770. $this->m_sDBUser = trim($MySettings['db_user']);
  771. $this->m_sDBPwd = trim($MySettings['db_pwd']);
  772. $this->m_sDBName = trim($MySettings['db_name']);
  773. $this->m_sDBSubname = trim($MySettings['db_subname']);
  774. $this->m_sDBCharacterSet = isset($MySettings['db_character_set']) ? trim($MySettings['db_character_set']) : DEFAULT_CHARACTER_SET;
  775. $this->m_sDBCollation = isset($MySettings['db_collation']) ? trim($MySettings['db_collation']) : DEFAULT_COLLATION;
  776. $this->m_bLogGlobal = isset($MySettings['log_global']) ? (bool) trim($MySettings['log_global']) : DEFAULT_LOG_GLOBAL;
  777. $this->m_bLogNotification = isset($MySettings['log_notification']) ? (bool) trim($MySettings['log_notification']) : DEFAULT_LOG_NOTIFICATION;
  778. $this->m_bLogIssue = isset($MySettings['log_issue']) ? (bool) trim($MySettings['log_issue']) : DEFAULT_LOG_ISSUE;
  779. $this->m_bLogWebService = isset($MySettings['log_web_service']) ? (bool) trim($MySettings['log_web_service']) : DEFAULT_LOG_WEB_SERVICE;
  780. $this->m_bLogKPIDuration = isset($MySettings['log_kpi_duration']) ? (bool) trim($MySettings['log_kpi_duration']) : DEFAULT_LOG_KPI_DURATION;
  781. $this->m_bLogKPIMemory = isset($MySettings['log_kpi_memory']) ? (bool) trim($MySettings['log_kpi_memory']) : DEFAULT_LOG_KPI_MEMORY;
  782. $this->m_bDebugQueries = isset($MySettings['debug_queries']) ? (bool) trim($MySettings['debug_queries']) : DEFAULT_DEBUG_QUERIES;
  783. $this->m_bQueryCacheEnabled = isset($MySettings['query_cache_enabled']) ? (bool) trim($MySettings['query_cache_enabled']) : DEFAULT_QUERY_CACHE_ENABLED;
  784. $this->m_iMinDisplayLimit = isset($MySettings['min_display_limit']) ? trim($MySettings['min_display_limit']) : DEFAULT_MIN_DISPLAY_LIMIT;
  785. $this->m_iMaxDisplayLimit = isset($MySettings['max_display_limit']) ? trim($MySettings['max_display_limit']) : DEFAULT_MAX_DISPLAY_LIMIT;
  786. $this->m_iStandardReloadInterval = isset($MySettings['standard_reload_interval']) ? trim($MySettings['standard_reload_interval']) : DEFAULT_STANDARD_RELOAD_INTERVAL;
  787. $this->m_iFastReloadInterval = isset($MySettings['fast_reload_interval']) ? trim($MySettings['fast_reload_interval']) : DEFAULT_FAST_RELOAD_INTERVAL;
  788. $this->m_bSecureConnectionRequired = isset($MySettings['secure_connection_required']) ? (bool) trim($MySettings['secure_connection_required']) : DEFAULT_SECURE_CONNECTION_REQUIRED;
  789. $this->m_aModuleSettings = isset($MyModuleSettings) ? $MyModuleSettings : array();
  790. $this->m_sDefaultLanguage = isset($MySettings['default_language']) ? trim($MySettings['default_language']) : 'EN US';
  791. $this->m_sAllowedLoginTypes = isset($MySettings['allowed_login_types']) ? trim($MySettings['allowed_login_types']) : DEFAULT_ALLOWED_LOGIN_TYPES;
  792. $this->m_sExtAuthVariable = isset($MySettings['ext_auth_variable']) ? trim($MySettings['ext_auth_variable']) : DEFAULT_EXT_AUTH_VARIABLE;
  793. $this->m_sEncryptionKey = isset($MySettings['encryption_key']) ? trim($MySettings['encryption_key']) : DEFAULT_ENCRYPTION_KEY;
  794. $this->m_aCharsets = isset($MySettings['csv_import_charsets']) ? $MySettings['csv_import_charsets'] : array();
  795. }
  796. protected function Verify()
  797. {
  798. // Files are verified later on, just before using them -see MetaModel::Plugin()
  799. // (we have their final path at that point)
  800. }
  801. public function GetModuleSetting($sModule, $sProperty, $defaultvalue = null)
  802. {
  803. if (isset($this->m_aModuleSettings[$sModule][$sProperty]))
  804. {
  805. return $this->m_aModuleSettings[$sModule][$sProperty];
  806. }
  807. return $defaultvalue;
  808. }
  809. public function SetModuleSetting($sModule, $sProperty, $value)
  810. {
  811. $this->m_aModuleSettings[$sModule][$sProperty] = $value;
  812. }
  813. public function GetAppModules()
  814. {
  815. return $this->m_aAppModules;
  816. }
  817. public function SetAppModules($aAppModules)
  818. {
  819. $this->m_aAppModules = $aAppModules;
  820. }
  821. public function GetDataModels()
  822. {
  823. return $this->m_aDataModels;
  824. }
  825. public function SetDataModels($aDataModels)
  826. {
  827. $this->m_aDataModels = $aDataModels;
  828. }
  829. public function GetWebServiceCategories()
  830. {
  831. return $this->m_aWebServiceCategories;
  832. }
  833. public function SetWebServiceCategories($aWebServiceCategories)
  834. {
  835. $this->m_aWebServiceCategories = $aWebServiceCategories;
  836. }
  837. public function GetAddons()
  838. {
  839. return $this->m_aAddons;
  840. }
  841. public function SetAddons($aAddons)
  842. {
  843. $this->m_aAddons = $aAddons;
  844. }
  845. public function GetDictionaries()
  846. {
  847. return $this->m_aDictionaries;
  848. }
  849. public function SetDictionaries($aDictionaries)
  850. {
  851. $this->m_aDictionaries = $aDictionaries;
  852. }
  853. public function GetDBHost()
  854. {
  855. return $this->m_sDBHost;
  856. }
  857. public function GetDBName()
  858. {
  859. return $this->m_sDBName;
  860. }
  861. public function GetDBSubname()
  862. {
  863. return $this->m_sDBSubname;
  864. }
  865. public function GetDBCharacterSet()
  866. {
  867. return $this->m_sDBCharacterSet;
  868. }
  869. public function GetDBCollation()
  870. {
  871. return $this->m_sDBCollation;
  872. }
  873. public function GetDBUser()
  874. {
  875. return $this->m_sDBUser;
  876. }
  877. public function GetDBPwd()
  878. {
  879. return $this->m_sDBPwd;
  880. }
  881. public function GetLogGlobal()
  882. {
  883. return $this->m_bLogGlobal;
  884. }
  885. public function GetLogNotification()
  886. {
  887. return $this->m_bLogNotification;
  888. }
  889. public function GetLogIssue()
  890. {
  891. return $this->m_bLogIssue;
  892. }
  893. public function GetLogWebService()
  894. {
  895. return $this->m_bLogWebService;
  896. }
  897. public function GetLogKPIDuration()
  898. {
  899. return $this->m_bLogKPIDuration;
  900. }
  901. public function GetLogKPIMemory()
  902. {
  903. return $this->m_bLogKPIMemory;
  904. }
  905. public function GetDebugQueries()
  906. {
  907. return $this->m_bDebugQueries;
  908. }
  909. public function GetQueryCacheEnabled()
  910. {
  911. return $this->m_bQueryCacheEnabled;
  912. }
  913. public function GetMinDisplayLimit()
  914. {
  915. return $this->m_iMinDisplayLimit;
  916. }
  917. public function GetMaxDisplayLimit()
  918. {
  919. return $this->m_iMaxDisplayLimit;
  920. }
  921. public function GetStandardReloadInterval()
  922. {
  923. return $this->m_iStandardReloadInterval;
  924. }
  925. public function GetFastReloadInterval()
  926. {
  927. return $this->m_iFastReloadInterval;
  928. }
  929. public function GetSecureConnectionRequired()
  930. {
  931. return $this->m_bSecureConnectionRequired;
  932. }
  933. public function GetDefaultLanguage()
  934. {
  935. return $this->m_sDefaultLanguage;
  936. }
  937. public function GetEncryptionKey()
  938. {
  939. return $this->m_sEncryptionKey;
  940. }
  941. public function GetAllowedLoginTypes()
  942. {
  943. return explode('|', $this->m_sAllowedLoginTypes);
  944. }
  945. public function GetExternalAuthenticationVariable()
  946. {
  947. return $this->m_sExtAuthVariable;
  948. }
  949. public function GetCSVImportCharsets()
  950. {
  951. return $this->m_aCharsets;
  952. }
  953. public function SetDBHost($sDBHost)
  954. {
  955. $this->m_sDBHost = $sDBHost;
  956. }
  957. public function SetDBName($sDBName)
  958. {
  959. $this->m_sDBName = $sDBName;
  960. }
  961. public function SetDBSubname($sDBSubName)
  962. {
  963. $this->m_sDBSubname = $sDBSubName;
  964. }
  965. public function SetDBCharacterSet($sDBCharacterSet)
  966. {
  967. $this->m_sDBCharacterSet = $sDBCharacterSet;
  968. }
  969. public function SetDBCollation($sDBCollation)
  970. {
  971. $this->m_sDBCollation = $sDBCollation;
  972. }
  973. public function SetDBUser($sUser)
  974. {
  975. $this->m_sDBUser = $sUser;
  976. }
  977. public function SetDBPwd($sPwd)
  978. {
  979. $this->m_sDBPwd = $sPwd;
  980. }
  981. public function SetLogGlobal($iLogGlobal)
  982. {
  983. $this->m_iLogGlobal = $iLogGlobal;
  984. }
  985. public function SetLogNotification($iLogNotification)
  986. {
  987. $this->m_iLogNotification = $iLogNotification;
  988. }
  989. public function SetLogIssue($iLogIssue)
  990. {
  991. $this->m_iLogIssue = $iLogIssue;
  992. }
  993. public function SetLogWebService($iLogWebService)
  994. {
  995. $this->m_iLogWebService = $iLogWebService;
  996. }
  997. public function SetMinDisplayLimit($iMinDisplayLimit)
  998. {
  999. $this->m_iMinDisplayLimit = $iMinDisplayLimit;
  1000. }
  1001. public function SetMaxDisplayLimit($iMaxDisplayLimit)
  1002. {
  1003. $this->m_iMaxDisplayLimit = $iMaxDisplayLimit;
  1004. }
  1005. public function SetStandardReloadInterval($iStandardReloadInterval)
  1006. {
  1007. $this->m_iStandardReloadInterval = $iStandardReloadInterval;
  1008. }
  1009. public function SetFastReloadInterval($iFastReloadInterval)
  1010. {
  1011. $this->m_iFastReloadInterval = $iFastReloadInterval;
  1012. }
  1013. public function SetSecureConnectionRequired($bSecureConnectionRequired)
  1014. {
  1015. $this->m_bSecureConnectionRequired = $bSecureConnectionRequired;
  1016. }
  1017. public function SetDefaultLanguage($sLanguageCode)
  1018. {
  1019. $this->m_sDefaultLanguage = $sLanguageCode;
  1020. }
  1021. public function SetAllowedLoginTypes($aAllowedLoginTypes)
  1022. {
  1023. $this->m_sAllowedLoginTypes = implode('|', $aAllowedLoginTypes);
  1024. }
  1025. public function SetExternalAuthenticationVariable($sExtAuthVariable)
  1026. {
  1027. $this->m_sExtAuthVariable = $sExtAuthVariable;
  1028. }
  1029. public function SetEncryptionKey($sKey)
  1030. {
  1031. $this->m_sEncryptionKey = $sKey;
  1032. }
  1033. public function SetCSVImportCharsets($aCharsets)
  1034. {
  1035. $this->m_aCharsets = $aCharsets;
  1036. }
  1037. public function AddCSVImportCharset($sIconvCode, $sDisplayName)
  1038. {
  1039. $this->m_aCharsets[$sIconvCode] = $sDisplayName;
  1040. }
  1041. public function GetLoadedFile()
  1042. {
  1043. if (is_null($this->m_sFile))
  1044. {
  1045. return '';
  1046. }
  1047. else
  1048. {
  1049. return $this->m_sFile;
  1050. }
  1051. }
  1052. /**
  1053. * Render the configuration as an associative array
  1054. * @return boolean True otherwise throws an Exception
  1055. */
  1056. public function ToArray()
  1057. {
  1058. $aSettings = array();
  1059. foreach($this->m_aSettings as $sPropCode => $aSettingInfo)
  1060. {
  1061. $aSettings[$sPropCode] = $aSettingInfo['value'];
  1062. }
  1063. $aSettings['db_host'] = $this->m_sDBHost;
  1064. $aSettings['db_user'] = $this->m_sDBUser;
  1065. $aSettings['db_pwd'] = $this->m_sDBPwd;
  1066. $aSettings['db_name'] = $this->m_sDBName;
  1067. $aSettings['db_subname'] = $this->m_sDBSubname;
  1068. $aSettings['db_character_set'] = $this->m_sDBCharacterSet;
  1069. $aSettings['db_collation'] = $this->m_sDBCollation;
  1070. $aSettings['log_global'] = $this->m_bLogGlobal;
  1071. $aSettings['log_notification'] = $this->m_bLogNotification;
  1072. $aSettings['log_issue'] = $this->m_bLogIssue;
  1073. $aSettings['log_web_service'] = $this->m_bLogWebService;
  1074. $aSettings['min_display_limit'] = $this->m_iMinDisplayLimit;
  1075. $aSettings['max_display_limit'] = $this->m_iMaxDisplayLimit;
  1076. $aSettings['standard_reload_interval'] = $this->m_iStandardReloadInterval;
  1077. $aSettings['fast_reload_interval'] = $this->m_iFastReloadInterval;
  1078. $aSettings['secure_connection_required'] = $this->m_bSecureConnectionRequired;
  1079. $aSettings['default_language'] = $this->m_sDefaultLanguage;
  1080. $aSettings['allowed_login_types'] = $this->m_sAllowedLoginTypes;
  1081. $aSettings['encryption_key'] = $this->m_sEncryptionKey;
  1082. $aSettings['csv_import_charsets'] = $this->m_aCharsets;
  1083. foreach ($this->m_aModuleSettings as $sModule => $aProperties)
  1084. {
  1085. foreach ($aProperties as $sProperty => $value)
  1086. {
  1087. $aSettings['module_settings'][$sModule][$sProperty] = $value;
  1088. }
  1089. }
  1090. foreach($this->m_aAppModules as $sFile)
  1091. {
  1092. $aSettings['application_list'][] = $sFile;
  1093. }
  1094. foreach($this->m_aDataModels as $sFile)
  1095. {
  1096. $aSettings['datamodel_list'][] = $sFile;
  1097. }
  1098. foreach($this->m_aWebServiceCategories as $sFile)
  1099. {
  1100. $aSettings['webservice_list'][] = $sFile;
  1101. }
  1102. foreach($this->m_aAddons as $sKey => $sFile)
  1103. {
  1104. $aSettings['addon_list'][] = $sFile;
  1105. }
  1106. foreach($this->m_aDictionaries as $sFile)
  1107. {
  1108. $aSettings['dictionary_list'][] = $sFile;
  1109. }
  1110. return $aSettings;
  1111. }
  1112. /**
  1113. * Write the configuration to a file (php format) that can be reloaded later
  1114. * By default write to the same file that was specified when constructing the object
  1115. * @param $sFileName string Name of the file to write to (emtpy to write to the same file)
  1116. * @return boolean True otherwise throws an Exception
  1117. */
  1118. public function WriteToFile($sFileName = '')
  1119. {
  1120. if (empty($sFileName))
  1121. {
  1122. $sFileName = $this->m_sFile;
  1123. }
  1124. $hFile = @fopen($sFileName, 'w');
  1125. if ($hFile !== false)
  1126. {
  1127. fwrite($hFile, "<?php\n");
  1128. fwrite($hFile, "\n/**\n");
  1129. fwrite($hFile, " *\n");
  1130. fwrite($hFile, " * phpMyORM configuration file, generated by the iTop configuration wizard\n");
  1131. fwrite($hFile, " *\n");
  1132. fwrite($hFile, " * The file is used in MetaModel::LoadConfig() which does all the necessary initialization job\n");
  1133. fwrite($hFile, " *\n");
  1134. fwrite($hFile, " */\n");
  1135. fwrite($hFile, "\n");
  1136. fwrite($hFile, "\$MySettings = array(\n");
  1137. foreach($this->m_aSettings as $sPropCode => $aSettingInfo)
  1138. {
  1139. if ($aSettingInfo['show_in_conf_sample'])
  1140. {
  1141. $sType = $this->m_aSettings[$sPropCode]['type'];
  1142. switch($sType)
  1143. {
  1144. case 'bool':
  1145. $sSeenAs = $aSettingInfo['value'] ? '1' : '0';
  1146. break;
  1147. default:
  1148. $sSeenAs = "'".addslashes($aSettingInfo['value'])."'";
  1149. }
  1150. fwrite($hFile, "\t'$sPropCode' => $sSeenAs,\n");
  1151. }
  1152. }
  1153. fwrite($hFile, "\t'db_host' => '{$this->m_sDBHost}',\n");
  1154. fwrite($hFile, "\t'db_user' => '{$this->m_sDBUser}',\n");
  1155. fwrite($hFile, "\t'db_pwd' => '".addslashes($this->m_sDBPwd)."',\n");
  1156. fwrite($hFile, "\t'db_name' => '{$this->m_sDBName}',\n");
  1157. fwrite($hFile, "\t'db_subname' => '{$this->m_sDBSubname}',\n");
  1158. fwrite($hFile, "\t'db_character_set' => '{$this->m_sDBCharacterSet}',\n");
  1159. fwrite($hFile, "\t'db_collation' => '{$this->m_sDBCollation}',\n");
  1160. fwrite($hFile, "\n");
  1161. fwrite($hFile, "\t'log_global' => {$this->m_bLogGlobal},\n");
  1162. fwrite($hFile, "\t'log_notification' => {$this->m_bLogNotification},\n");
  1163. fwrite($hFile, "\t'log_issue' => {$this->m_bLogIssue},\n");
  1164. fwrite($hFile, "\t'log_web_service' => {$this->m_bLogWebService},\n");
  1165. fwrite($hFile, "\t'min_display_limit' => {$this->m_iMinDisplayLimit},\n");
  1166. fwrite($hFile, "\t'max_display_limit' => {$this->m_iMaxDisplayLimit},\n");
  1167. fwrite($hFile, "\t'standard_reload_interval' => {$this->m_iStandardReloadInterval},\n");
  1168. fwrite($hFile, "\t'fast_reload_interval' => {$this->m_iFastReloadInterval},\n");
  1169. fwrite($hFile, "\t'secure_connection_required' => ".($this->m_bSecureConnectionRequired ? 'true' : 'false').",\n");
  1170. fwrite($hFile, "\t'default_language' => '{$this->m_sDefaultLanguage}',\n");
  1171. fwrite($hFile, "\t'allowed_login_types' => '{$this->m_sAllowedLoginTypes}',\n");
  1172. fwrite($hFile, "\t'encryption_key' => '{$this->m_sEncryptionKey}',\n");
  1173. $sExport = var_export($this->m_aCharsets, true);
  1174. fwrite($hFile, "\t'csv_import_charsets' => $sExport,\n");
  1175. fwrite($hFile, ");\n");
  1176. fwrite($hFile, "\n");
  1177. fwrite($hFile, "\$MyModuleSettings = array(\n");
  1178. foreach ($this->m_aModuleSettings as $sModule => $aProperties)
  1179. {
  1180. fwrite($hFile, "\t'$sModule' => array (\n");
  1181. foreach ($aProperties as $sProperty => $value)
  1182. {
  1183. $sExport = var_export($value, true);
  1184. fwrite($hFile, "\t\t'$sProperty' => $sExport,\n");
  1185. }
  1186. fwrite($hFile, "\t),\n");
  1187. }
  1188. fwrite($hFile, ");\n");
  1189. fwrite($hFile, "\n/**\n");
  1190. fwrite($hFile, " *\n");
  1191. fwrite($hFile, " * Data model modules to be loaded. Names are specified as relative paths\n");
  1192. fwrite($hFile, " *\n");
  1193. fwrite($hFile, " */\n");
  1194. fwrite($hFile, "\$MyModules = array(\n");
  1195. fwrite($hFile, "\t'application' => array (\n");
  1196. foreach($this->m_aAppModules as $sFile)
  1197. {
  1198. fwrite($hFile, "\t\t'$sFile',\n");
  1199. }
  1200. fwrite($hFile, "\t),\n");
  1201. fwrite($hFile, "\t'business' => array (\n");
  1202. foreach($this->m_aDataModels as $sFile)
  1203. {
  1204. fwrite($hFile, "\t\t'$sFile',\n");
  1205. }
  1206. fwrite($hFile, "\t),\n");
  1207. fwrite($hFile, "\t'webservices' => array (\n");
  1208. foreach($this->m_aWebServiceCategories as $sFile)
  1209. {
  1210. fwrite($hFile, "\t\t'$sFile',\n");
  1211. }
  1212. fwrite($hFile, "\t),\n");
  1213. fwrite($hFile, "\t'addons' => array (\n");
  1214. foreach($this->m_aAddons as $sKey => $sFile)
  1215. {
  1216. fwrite($hFile, "\t\t'$sKey' => '$sFile',\n");
  1217. }
  1218. fwrite($hFile, "\t),\n");
  1219. fwrite($hFile, "\t'dictionaries' => array (\n");
  1220. foreach($this->m_aDictionaries as $sFile)
  1221. {
  1222. fwrite($hFile, "\t\t'$sFile',\n");
  1223. }
  1224. fwrite($hFile, "\t),\n");
  1225. fwrite($hFile, ");\n");
  1226. fwrite($hFile, '?'.'>'); // Avoid perturbing the syntax highlighting !
  1227. return fclose($hFile);
  1228. }
  1229. else
  1230. {
  1231. throw new ConfigException("Could not write to configuration file", array('file' => $sFileName));
  1232. }
  1233. }
  1234. protected static function ScanDictionariesDir()
  1235. {
  1236. $aResult = array();
  1237. // Populate automatically the list of dictionary files
  1238. $sDir = APPROOT.'/dictionaries';
  1239. if ($hDir = @opendir($sDir))
  1240. {
  1241. while (($sFile = readdir($hDir)) !== false)
  1242. {
  1243. $aMatches = array();
  1244. if (preg_match("/^([^\.]+\.)?dictionary\.itop\.(ui|core)\.php$/i", $sFile, $aMatches)) // Dictionary files named like [<Lang>.]dictionary.[core|ui].php are loaded automatically
  1245. {
  1246. $aResult[] = 'dictionaries/'.$sFile;
  1247. }
  1248. }
  1249. closedir($hDir);
  1250. }
  1251. return $aResult;
  1252. }
  1253. /**
  1254. * Helper function to initialize a configuration from the page arguments
  1255. */
  1256. public function UpdateFromParams($aParamValues, $sModulesDir = null)
  1257. {
  1258. if (isset($aParamValues['application_path']))
  1259. {
  1260. $this->Set('app_root_url', $aParamValues['application_path']);
  1261. }
  1262. if (isset($aParamValues['mode']) && isset($aParamValues['language']))
  1263. {
  1264. if (($aParamValues['mode'] == 'install') || $this->GetDefaultLanguage() == '')
  1265. {
  1266. $this->SetDefaultLanguage($aParamValues['language']);
  1267. }
  1268. }
  1269. if (isset($aParamValues['db_server']))
  1270. {
  1271. $this->SetDBHost($aParamValues['db_server']);
  1272. $this->SetDBUser($aParamValues['db_user']);
  1273. $this->SetDBPwd($aParamValues['db_pwd']);
  1274. $sDBName = $aParamValues['db_name'];
  1275. if ($sDBName == '')
  1276. {
  1277. $sDBName = $aParamValues['new_db_name'];
  1278. }
  1279. $this->SetDBName($sDBName);
  1280. $this->SetDBSubname($aParamValues['db_prefix']);
  1281. }
  1282. if (!is_null($sModulesDir))
  1283. {
  1284. if (isset($aParamValues['selected_modules']))
  1285. {
  1286. $aSelectedModules = explode(',', $aParamValues['selected_modules']);
  1287. }
  1288. else
  1289. {
  1290. $aSelectedModules = null;
  1291. }
  1292. // Initialize the arrays below with default values for the application...
  1293. $oEmptyConfig = new Config('dummy_file', false); // Do NOT load any config file, just set the default values
  1294. $aAddOns = $oEmptyConfig->GetAddOns();
  1295. $aAppModules = $oEmptyConfig->GetAppModules();
  1296. $aDataModels = $oEmptyConfig->GetDataModels();
  1297. $aWebServiceCategories = $oEmptyConfig->GetWebServiceCategories();
  1298. $aDictionaries = $oEmptyConfig->GetDictionaries();
  1299. // Merge the values with the ones provided by the modules
  1300. // Make sure when don't load the same file twice...
  1301. $aModules = ModuleDiscovery::GetAvailableModules(APPROOT, $sModulesDir);
  1302. foreach($aModules as $sModuleId => $aModuleInfo)
  1303. {
  1304. list($sModuleName, $sModuleVersion) = ModuleDiscovery::GetModuleName($sModuleId);
  1305. if (is_null($aSelectedModules) || in_array($sModuleName, $aSelectedModules))
  1306. {
  1307. if (isset($aModuleInfo['datamodel']))
  1308. {
  1309. $aDataModels = array_unique(array_merge($aDataModels, $aModuleInfo['datamodel']));
  1310. }
  1311. if (isset($aModuleInfo['webservice']))
  1312. {
  1313. $aWebServiceCategories = array_unique(array_merge($aWebServiceCategories, $aModuleInfo['webservice']));
  1314. }
  1315. if (isset($aModuleInfo['dictionary']))
  1316. {
  1317. $aDictionaries = array_unique(array_merge($aDictionaries, $aModuleInfo['dictionary']));
  1318. }
  1319. if (isset($aModuleInfo['settings']))
  1320. {
  1321. foreach($aModuleInfo['settings'] as $sProperty => $value)
  1322. {
  1323. list($sName, $sVersion) = ModuleDiscovery::GetModuleName($sModuleId);
  1324. $this->SetModuleSetting($sName, $sProperty, $value);
  1325. }
  1326. }
  1327. if (isset($aModuleInfo['installer']))
  1328. {
  1329. $sModuleInstallerClass = $aModuleInfo['installer'];
  1330. if (!class_exists($sModuleInstallerClass))
  1331. {
  1332. throw new Exception("Wrong installer class: '$sModuleInstallerClass' is not a PHP class - Module: ".$aModuleInfo['label']);
  1333. }
  1334. if (!is_subclass_of($sModuleInstallerClass, 'ModuleInstallerAPI'))
  1335. {
  1336. throw new Exception("Wrong installer class: '$sModuleInstallerClass' is not derived from 'ModuleInstallerAPI' - Module: ".$aModuleInfo['label']);
  1337. }
  1338. $aCallSpec = array($sModuleInstallerClass, 'BeforeWritingConfig');
  1339. call_user_func_array($aCallSpec, array($this));
  1340. }
  1341. }
  1342. }
  1343. $this->SetAddOns($aAddOns);
  1344. $this->SetAppModules($aAppModules);
  1345. $this->SetDataModels($aDataModels);
  1346. $this->SetWebServiceCategories($aWebServiceCategories);
  1347. $this->SetDictionaries($aDictionaries);
  1348. }
  1349. }
  1350. /**
  1351. * Helper: for an array of string, change the prefix when found
  1352. */
  1353. protected static function ChangePrefix(&$aStrings, $sSearchPrefix, $sNewPrefix)
  1354. {
  1355. foreach ($aStrings as &$sFile)
  1356. {
  1357. if (substr($sFile, 0, strlen($sSearchPrefix)) == $sSearchPrefix)
  1358. {
  1359. $sFile = $sNewPrefix.substr($sFile, strlen($sSearchPrefix));
  1360. }
  1361. }
  1362. }
  1363. /**
  1364. * Quick an dirty way to clone a config file into another environment
  1365. */
  1366. public function ChangeModulesPath($sSourceEnv, $sTargetEnv)
  1367. {
  1368. $sSearchPrefix = 'env-'.$sSourceEnv.'/';
  1369. $sNewPrefix = 'env-'.$sTargetEnv.'/';
  1370. self::ChangePrefix($this->m_aDataModels, $sSearchPrefix, $sNewPrefix);
  1371. self::ChangePrefix($this->m_aWebServiceCategories, $sSearchPrefix, $sNewPrefix);
  1372. self::ChangePrefix($this->m_aDictionaries, $sSearchPrefix, $sNewPrefix);
  1373. }
  1374. }
  1375. ?>