12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493 |
- <?php
- // Copyright (C) 2010 Combodo SARL
- //
- // This program is free software; you can redistribute it and/or modify
- // it under the terms of the GNU General Public License as published by
- // the Free Software Foundation; version 3 of the License.
- //
- // This program is distributed in the hope that it will be useful,
- // but WITHOUT ANY WARRANTY; without even the implied warranty of
- // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- // GNU General Public License for more details.
- //
- // You should have received a copy of the GNU General Public License
- // along with this program; if not, write to the Free Software
- // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
- define('ITOP_APPLICATION', 'iTop');
- define('ITOP_VERSION', '$ITOP_VERSION$');
- define('ITOP_REVISION', '$WCREV$');
- define('ITOP_BUILD_DATE', '$WCNOW$');
- define('ACCESS_USER_WRITE', 1);
- define('ACCESS_ADMIN_WRITE', 2);
- define('ACCESS_FULL', ACCESS_USER_WRITE | ACCESS_ADMIN_WRITE);
- define('ACCESS_READONLY', 0);
- /**
- * Configuration read/write
- *
- * @author Erwan Taloc <erwan.taloc@combodo.com>
- * @author Romain Quetiez <romain.quetiez@combodo.com>
- * @author Denis Flaven <denis.flaven@combodo.com>
- * @license http://www.opensource.org/licenses/gpl-3.0.html LGPL
- */
- require_once('coreexception.class.inc.php');
- class ConfigException extends CoreException
- {
- }
- define ('DEFAULT_CHARACTER_SET', 'utf8');
- define ('DEFAULT_COLLATION', 'utf8_unicode_ci');
- define ('DEFAULT_LOG_GLOBAL', true);
- define ('DEFAULT_LOG_NOTIFICATION', true);
- define ('DEFAULT_LOG_ISSUE', true);
- define ('DEFAULT_LOG_WEB_SERVICE', true);
- define ('DEFAULT_LOG_KPI_DURATION', false);
- define ('DEFAULT_LOG_KPI_MEMORY', false);
- define ('DEFAULT_DEBUG_QUERIES', false);
- define ('DEFAULT_QUERY_CACHE_ENABLED', true);
- define ('DEFAULT_MIN_DISPLAY_LIMIT', 10);
- define ('DEFAULT_MAX_DISPLAY_LIMIT', 15);
- define ('DEFAULT_STANDARD_RELOAD_INTERVAL', 5*60);
- define ('DEFAULT_FAST_RELOAD_INTERVAL', 1*60);
- define ('DEFAULT_SECURE_CONNECTION_REQUIRED', false);
- define ('DEFAULT_ALLOWED_LOGIN_TYPES', 'form|basic|external');
- define ('DEFAULT_EXT_AUTH_VARIABLE', '$_SERVER[\'REMOTE_USER\']');
- define ('DEFAULT_ENCRYPTION_KEY', '@iT0pEncr1pti0n!'); // We'll use a random value, later...
- /**
- * Config
- * configuration data (this class cannot not be localized, because it is responsible for loading the dictionaries)
- *
- * @package iTopORM
- */
- class Config
- {
- //protected $m_bIsLoaded = false;
- protected $m_sFile = '';
- protected $m_aAppModules;
- protected $m_aDataModels;
- protected $m_aWebServiceCategories;
- protected $m_aAddons;
- protected $m_aDictionaries;
- protected $m_aModuleSettings;
- // New way to store the settings !
- //
- protected $m_aSettings = array(
- 'app_env_label' => array(
- 'type' => 'string',
- 'description' => 'Label displayed to describe the current application environnment, defaults to the environment name (e.g. "production")',
- 'default' => '',
- 'value' => '',
- 'source_of_value' => '',
- 'show_in_conf_sample' => true,
- ),
- 'app_root_url' => array(
- 'type' => 'string',
- '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)',
- 'default' => '',
- 'value' => '',
- 'source_of_value' => '',
- 'show_in_conf_sample' => true,
- ),
- 'skip_check_to_write' => array(
- 'type' => 'bool',
- 'description' => 'Disable data format and integrity checks to boost up data load (insert or update)',
- 'default' => false,
- 'value' => false,
- 'source_of_value' => '',
- 'show_in_conf_sample' => false,
- ),
- 'skip_check_ext_keys' => array(
- 'type' => 'bool',
- 'description' => 'Disable external key check when checking the value of attributes',
- 'default' => false,
- 'value' => false,
- 'source_of_value' => '',
- 'show_in_conf_sample' => false,
- ),
- 'skip_strong_security' => array(
- 'type' => 'bool',
- 'description' => 'Disable strong security - TEMPORY: this flag should be removed when we are more confident in the recent change in security',
- 'default' => true,
- 'value' => true,
- 'source_of_value' => '',
- 'show_in_conf_sample' => false,
- ),
- 'graphviz_path' => array(
- 'type' => 'string',
- 'description' => 'Path to the Graphviz "dot" executable for graphing objects lifecycle',
- 'default' => '/usr/bin/dot',
- 'value' => '',
- 'source_of_value' => '',
- 'show_in_conf_sample' => false,
- ),
- 'php_path' => array(
- 'type' => 'string',
- 'description' => 'Path to the php executable in CLI mode',
- 'default' => 'php',
- 'value' => 'php',
- 'source_of_value' => '',
- 'show_in_conf_sample' => true,
- ),
- 'session_name' => array(
- 'type' => 'string',
- 'description' => 'The name of the cookie used to store the PHP session id',
- 'default' => 'iTop',
- 'value' => '',
- 'source_of_value' => '',
- 'show_in_conf_sample' => true,
- ),
- 'max_combo_length' => array(
- 'type' => 'integer',
- 'description' => 'The maximum number of elements in a drop-down list. If more then an autocomplete will be used',
- 'default' => 50,
- 'value' => 50,
- 'source_of_value' => '',
- 'show_in_conf_sample' => false,
- ),
- 'min_autocomplete_chars' => array(
- 'type' => 'integer',
- 'description' => 'The minimum number of characters to type in order to trigger the "autocomplete" behavior',
- 'default' => 3,
- 'value' => 3,
- 'source_of_value' => '',
- 'show_in_conf_sample' => false,
- ),
- 'allow_target_creation' => array(
- 'type' => 'bool',
- 'description' => 'Displays the + button on external keys to create target objects',
- 'default' => true,
- 'value' => true,
- 'source_of_value' => '',
- 'show_in_conf_sample' => false,
- ),
- // Levels that trigger a confirmation in the CSV import/synchro wizard
- 'csv_import_min_object_confirmation' => array(
- 'type' => 'integer',
- 'description' => 'Minimum number of objects to check for the confirmation percentages',
- 'default' => 3,
- 'value' => 3,
- 'source_of_value' => '',
- 'show_in_conf_sample' => false,
- ),
- 'csv_import_errors_percentage' => array(
- 'type' => 'integer',
- 'description' => 'Percentage of errors that trigger a confirmation in the CSV import',
- 'default' => 50,
- 'value' => 50,
- 'source_of_value' => '',
- 'show_in_conf_sample' => false,
- ),
- 'csv_import_modifications_percentage' => array(
- 'type' => 'integer',
- 'description' => 'Percentage of modifications that trigger a confirmation in the CSV import',
- 'default' => 50,
- 'value' => 50,
- 'source_of_value' => '',
- 'show_in_conf_sample' => false,
- ),
- 'csv_import_creations_percentage' => array(
- 'type' => 'integer',
- 'description' => 'Percentage of creations that trigger a confirmation in the CSV import',
- 'default' => 50,
- 'value' => 50,
- 'source_of_value' => '',
- 'show_in_conf_sample' => false,
- ),
- 'access_mode' => array(
- 'type' => 'integer',
- 'description' => 'Combination of flags (ACCESS_USER_WRITE | ACCESS_ADMIN_WRITE, or ACCESS_FULL)',
- 'default' => ACCESS_FULL,
- 'value' => ACCESS_FULL,
- 'source_of_value' => '',
- 'show_in_conf_sample' => true,
- ),
- 'access_message' => array(
- 'type' => 'string',
- 'description' => 'Message displayed to the users when there is any access restriction',
- 'default' => 'iTop is temporarily frozen, please wait... (the admin team)',
- 'value' => '',
- 'source_of_value' => '',
- 'show_in_conf_sample' => true,
- ),
- 'online_help' => array(
- 'type' => 'string',
- 'description' => 'Hyperlink to the online-help web page',
- 'default' => 'http://www.combodo.com/itop-help',
- 'value' => '',
- 'source_of_value' => '',
- 'show_in_conf_sample' => true,
- ),
- 'log_usage' => array(
- 'type' => 'bool',
- 'description' => 'Log the usage of the application (i.e. the date/time and the user name of each login)',
- 'default' => false,
- 'value' => false,
- 'source_of_value' => '',
- 'show_in_conf_sample' => false,
- ),
- 'synchro_trace' => array(
- 'type' => 'string',
- 'description' => 'Synchronization details: none, display, save (includes \'display\')',
- 'default' => 'none',
- 'value' => 'none',
- 'source_of_value' => '',
- 'show_in_conf_sample' => true,
- ),
- 'link_set_item_separator' => array(
- 'type' => 'string',
- 'description' => 'Link set from string: line separator',
- 'default' => '|',
- 'value' => '|',
- 'source_of_value' => '',
- 'show_in_conf_sample' => true,
- ),
- 'link_set_attribute_separator' => array(
- 'type' => 'string',
- 'description' => 'Link set from string: attribute separator',
- 'default' => ';',
- 'value' => ';',
- 'source_of_value' => '',
- 'show_in_conf_sample' => true,
- ),
- 'link_set_value_separator' => array(
- 'type' => 'string',
- 'description' => 'Link set from string: value separator (between the attcode and the value itself',
- 'default' => ':',
- 'value' => ':',
- 'source_of_value' => '',
- 'show_in_conf_sample' => true,
- ),
- 'link_set_attribute_qualifier' => array(
- 'type' => 'string',
- 'description' => 'Link set from string: attribute qualifier (encloses both the attcode and the value)',
- 'default' => "'",
- 'value' => "'",
- 'source_of_value' => '',
- 'show_in_conf_sample' => true,
- ),
- 'cron_max_execution_time' => array(
- 'type' => 'integer',
- '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',
- 'default' => 600,
- 'value' => 600,
- 'source_of_value' => '',
- 'show_in_conf_sample' => true,
- ),
- 'cron_sleep' => array(
- 'type' => 'integer',
- 'description' => 'Duration (seconds) before cron.php checks again if something must be done',
- 'default' => 2,
- 'value' => 2,
- 'source_of_value' => '',
- 'show_in_conf_sample' => false,
- ),
- 'email_asynchronous' => array(
- 'type' => 'bool',
- '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',
- 'default' => false,
- 'value' => false,
- 'source_of_value' => '',
- 'show_in_conf_sample' => true,
- ),
- 'email_transport' => array(
- 'type' => 'string',
- 'description' => 'Mean to send emails: PHPMail (uses the function mail()) or SMTP (implements the client protocole)',
- 'default' => "PHPMail",
- 'value' => "PHPMail",
- 'source_of_value' => '',
- 'show_in_conf_sample' => true,
- ),
- 'email_transport_smtp.host' => array(
- 'type' => 'string',
- 'description' => 'host name or IP address (optional)',
- 'default' => "localhost",
- 'value' => "localhost",
- 'source_of_value' => '',
- 'show_in_conf_sample' => false,
- ),
- 'email_transport_smtp.port' => array(
- 'type' => 'integer',
- 'description' => 'port number (optional)',
- 'default' => 25,
- 'value' => 25,
- 'source_of_value' => '',
- 'show_in_conf_sample' => false,
- ),
- 'email_transport_smtp.encryption' => array(
- 'type' => 'string',
- 'description' => 'tls or ssl (optional)',
- 'default' => "",
- 'value' => "",
- 'source_of_value' => '',
- 'show_in_conf_sample' => false,
- ),
- 'email_transport_smtp.username' => array(
- 'type' => 'string',
- 'description' => 'Authentication user (optional)',
- 'default' => "",
- 'value' => "",
- 'source_of_value' => '',
- 'show_in_conf_sample' => false,
- ),
- 'email_transport_smtp.password' => array(
- 'type' => 'string',
- 'description' => 'Authentication password (optional)',
- 'default' => "",
- 'value' => "",
- 'source_of_value' => '',
- 'show_in_conf_sample' => false,
- ),
- 'apc_cache.enabled' => array(
- 'type' => 'bool',
- 'description' => 'If set, the APC cache is allowed (the PHP extension must also be active)',
- 'default' => true,
- 'value' => true,
- 'source_of_value' => '',
- 'show_in_conf_sample' => true,
- ),
- 'apc_cache.query_ttl' => array(
- 'type' => 'integer',
- 'description' => 'Time to live set in APC for the prepared queries (seconds - 0 means no timeout)',
- 'default' => 3600,
- 'value' => 3600,
- 'source_of_value' => '',
- 'show_in_conf_sample' => true,
- ),
- 'timezone' => array(
- 'type' => 'string',
- 'description' => 'Timezone (reference: http://php.net/manual/en/timezones.php). If empty, it will be left unchanged and MUST be explicitely configured in PHP',
- // examples... not used (nor 'description')
- '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'),
- 'default' => 'Europe/Paris',
- 'value' => 'Europe/Paris',
- 'source_of_value' => '',
- 'show_in_conf_sample' => true,
- ),
- 'cas_include_path' => array(
- 'type' => 'string',
- 'description' => 'The path where to find the phpCAS library',
- // examples... not used (nor 'description')
- 'default' => '/usr/share/php',
- 'value' => '/usr/share/php',
- 'source_of_value' => '',
- 'show_in_conf_sample' => true,
- ),
- 'cas_version' => array(
- 'type' => 'string',
- 'description' => 'The CAS protocol version to use: "1.0" (CAS v1), "2.0" (CAS v2) or "S1" (SAML V1) )',
- // examples... not used (nor 'description')
- 'default' => '2.0',
- 'value' => '',
- 'source_of_value' => '',
- 'show_in_conf_sample' => true,
- ),
- 'cas_host' => array(
- 'type' => 'string',
- 'description' => 'The name of the CAS host',
- // examples... not used (nor 'description')
- 'default' => '',
- 'value' => '',
- 'source_of_value' => '',
- 'show_in_conf_sample' => true,
- ),
- 'cas_port' => array(
- 'type' => 'integer',
- 'description' => 'The port used by the CAS server',
- // examples... not used (nor 'description')
- 'default' => 443,
- 'value' => 443,
- 'source_of_value' => '',
- 'show_in_conf_sample' => true,
- ),
- 'cas_context' => array(
- 'type' => 'string',
- 'description' => 'The CAS context',
- // examples... not used (nor 'description')
- 'default' => '',
- 'value' => '',
- 'source_of_value' => '',
- 'show_in_conf_sample' => true,
- ),
- 'cas_server_ca_cert_path' => array(
- 'type' => 'string',
- 'description' => 'The path where to find the certificate of the CA for validating the certificate of the CAS server',
- // examples... not used (nor 'description')
- 'default' => '',
- 'value' => '',
- 'source_of_value' => '',
- 'show_in_conf_sample' => true,
- ),
- 'cas_logout_redirect_service' => array(
- 'type' => 'string',
- 'description' => 'The redirect service (URL) to use when logging-out with CAS',
- // examples... not used (nor 'description')
- 'default' => '',
- 'value' => '',
- 'source_of_value' => '',
- 'show_in_conf_sample' => true,
- ),
- 'cas_memberof' => array(
- 'type' => 'string',
- 'description' => 'A semicolon separated list of group names that the user must be member of (works only with SAML - e.g. cas_version=> "S1")',
- // examples... not used (nor 'description')
- 'default' => '',
- 'value' => '',
- 'source_of_value' => '',
- 'show_in_conf_sample' => true,
- ),
- 'cas_user_synchro' => array(
- 'type' => 'bool',
- 'description' => 'Whether or not to synchronize users with CAS/LDAP',
- // examples... not used (nor 'description')
- 'default' => 0,
- 'value' => 0,
- 'source_of_value' => '',
- 'show_in_conf_sample' => true,
- ),
- 'cas_update_profiles' => array(
- 'type' => 'bool',
- 'description' => 'Whether or not to update the profiles of an existing user from the CAS information',
- // examples... not used (nor 'description')
- 'default' => 0,
- 'value' => 0,
- 'source_of_value' => '',
- 'show_in_conf_sample' => true,
- ),
- 'cas_profile_pattern' => array(
- 'type' => 'string',
- 'description' => 'A regular expression pattern to extract the name of the iTop profile from the name of an LDAP/CAS group',
- // examples... not used (nor 'description')
- 'default' => '/^cn=([^,]+),/',
- 'value' => '/^cn=([^,]+),/',
- 'source_of_value' => '',
- 'show_in_conf_sample' => true,
- ),
- 'cas_default_profiles' => array(
- 'type' => 'string',
- 'description' => 'A semi-colon separated list of iTop Profiles to use when creating a new user if no profile is retrieved from CAS',
- // examples... not used (nor 'description')
- 'default' => 'Portal user',
- 'value' => 'Portal user',
- 'source_of_value' => '',
- 'show_in_conf_sample' => true,
- ),
- 'cas_debug' => array(
- 'type' => 'bool',
- 'description' => 'Activate the CAS debug',
- // examples... not used (nor 'description')
- 'default' => false,
- 'value' => false,
- 'source_of_value' => '',
- 'show_in_conf_sample' => true,
- ),
- 'deadline_format' => array(
- 'type' => 'string',
- 'description' => 'The format used for displaying "deadline" attributes: any string with the following placeholders: $date$, $difference$',
- // examples... $date$ ($deadline$)
- 'default' => '$difference$',
- 'value' => '$difference$',
- 'source_of_value' => '',
- 'show_in_conf_sample' => true,
- ),
- 'buttons_position' => array(
- 'type' => 'string',
- 'description' => 'Position of the forms buttons: bottom | top | both',
- // examples... not used
- 'default' => 'both',
- 'value' => 'both',
- 'source_of_value' => '',
- 'show_in_conf_sample' => true,
- ),
- 'shortcut_actions' => array(
- 'type' => 'string',
- 'description' => 'Actions that are available as direct buttons next to the "Actions" menu',
- // examples... not used
- 'default' => 'UI:Menu:Modify,UI:Menu:New',
- 'value' => 'UI:Menu:Modify',
- 'source_of_value' => '',
- 'show_in_conf_sample' => true,
- ),
- );
- public function IsProperty($sPropCode)
- {
- return (array_key_exists($sPropCode, $this->m_aSettings));
- }
- public function GetDescription($sPropCode)
- {
- return $this->m_aSettings[$sPropCode];
- }
- public function Set($sPropCode, $value, $sSourceDesc = 'unknown')
- {
- $sType = $this->m_aSettings[$sPropCode]['type'];
- switch($sType)
- {
- case 'bool':
- $value = (bool) $value;
- break;
- case 'string':
- $value = (string) $value;
- break;
- case 'integer':
- $value = (integer) $value;
- break;
- case 'float':
- $value = (float) $value;
- break;
- default:
- throw new CoreException('Unknown type for setting', array('property' => $sPropCode, 'type' => $sType));
- }
- $this->m_aSettings[$sPropCode]['value'] = $value;
- $this->m_aSettings[$sPropCode]['source_of_value'] = $sSourceDesc;
- }
- public function Get($sPropCode)
- {
- return $this->m_aSettings[$sPropCode]['value'];
- }
- // Those variables will be deprecated later, when the transition to ...Get('my_setting') will be done
- protected $m_sDBHost;
- protected $m_sDBUser;
- protected $m_sDBPwd;
- protected $m_sDBName;
- protected $m_sDBSubname;
- protected $m_sDBCharacterSet;
- protected $m_sDBCollation;
- /**
- * Event log options (see LOG_... definition)
- */
- // Those variables will be deprecated later, when the transition to ...Get('my_setting') will be done
- protected $m_bLogGlobal;
- protected $m_bLogNotification;
- protected $m_bLogIssue;
- protected $m_bLogWebService;
- protected $m_bLogKPIDuration; // private setting
- protected $m_bLogKPIMemory; // private setting
- protected $m_bDebugQueries; // private setting
- protected $m_bQueryCacheEnabled; // private setting
- /**
- * @var integer Number of elements to be displayed when there are more than m_iMaxDisplayLimit elements
- */
- protected $m_iMinDisplayLimit;
- /**
- * @var integer Max number of elements before truncating the display
- */
- protected $m_iMaxDisplayLimit;
- /**
- * @var integer Number of seconds between two reloads of the display (standard)
- */
- protected $m_iStandardReloadInterval;
- /**
- * @var integer Number of seconds between two reloads of the display (fast)
- */
- protected $m_iFastReloadInterval;
-
- /**
- * @var boolean Whether or not a secure connection is required for using the application.
- * If set, any attempt to connect to an iTop page with http:// will be redirected
- * to https://
- */
- protected $m_bSecureConnectionRequired;
- /**
- * @var string Langage code, default if the user language is undefined
- */
- protected $m_sDefaultLanguage;
-
- /**
- * @var string Type of login process allowed: form|basic|url|external
- */
- protected $m_sAllowedLoginTypes;
-
- /**
- * @var string Name of the PHP variable in which external authentication information is passed by the web server
- */
- protected $m_sExtAuthVariable;
- /**
- * @var string Encryption key used for all attributes of type "encrypted string". Can be set to a random value
- * unless you want to import a database from another iTop instance, in which case you must use
- * the same encryption key in order to properly decode the encrypted fields
- */
- protected $m_sEncryptionKey;
- /**
- * @var array Additional character sets to be supported by the interactive CSV import
- * 'iconv_code' => 'display name'
- */
- protected $m_aCharsets;
- public function __construct($sConfigFile = null, $bLoadConfig = true)
- {
- $this->m_sFile = $sConfigFile;
- if (is_null($sConfigFile))
- {
- $bLoadConfig = false;
- }
- $this->m_aAppModules = array(
- // Some default modules, always present can be move to an official iTop Module later if needed
- 'application/transaction.class.inc.php',
- 'application/menunode.class.inc.php',
- 'application/user.preferences.class.inc.php',
- 'application/user.dashboard.class.inc.php',
- 'application/audit.rule.class.inc.php',
- 'application/query.class.inc.php',
- // Romain - That's dirty, because those classes are in fact part of the core
- // but I needed those classes to be derived from cmdbAbstractObject
- // (to be managed via the GUI) and this class in not really known from
- // the core, PLUS I needed the includes to be there also for the setup
- // to create the tables.
- 'core/event.class.inc.php',
- 'core/action.class.inc.php',
- 'core/trigger.class.inc.php',
- 'synchro/synchrodatasource.class.inc.php',
- );
- $this->m_aDataModels = array();
- $this->m_aWebServiceCategories = array(
- 'webservices/webservices.basic.php',
- );
- $this->m_aAddons = array(
- // Default AddOn, always present can be moved to an official iTop Module later if needed
- 'user rights' => 'addons/userrights/userrightsprofile.class.inc.php',
- );
- $this->m_aDictionaries = self::ScanDictionariesDir();
-
- foreach($this->m_aSettings as $sPropCode => $aSettingInfo)
- {
- $this->m_aSettings[$sPropCode]['value'] = $aSettingInfo['default'];
- }
- $this->m_sDBHost = '';
- $this->m_sDBUser = '';
- $this->m_sDBPwd = '';
- $this->m_sDBName = '';
- $this->m_sDBSubname = '';
- $this->m_sDBCharacterSet = DEFAULT_CHARACTER_SET;
- $this->m_sDBCollation = DEFAULT_COLLATION;
- $this->m_bLogGlobal = DEFAULT_LOG_GLOBAL;
- $this->m_bLogNotification = DEFAULT_LOG_NOTIFICATION;
- $this->m_bLogIssue = DEFAULT_LOG_ISSUE;
- $this->m_bLogWebService = DEFAULT_LOG_WEB_SERVICE;
- $this->m_bLogKPIDuration = DEFAULT_LOG_KPI_DURATION;
- $this->m_bLogKPIDuration = DEFAULT_LOG_KPI_DURATION;
- $this->m_iMinDisplayLimit = DEFAULT_MIN_DISPLAY_LIMIT;
- $this->m_iMaxDisplayLimit = DEFAULT_MAX_DISPLAY_LIMIT;
- $this->m_iStandardReloadInterval = DEFAULT_STANDARD_RELOAD_INTERVAL;
- $this->m_iFastReloadInterval = DEFAULT_FAST_RELOAD_INTERVAL;
- $this->m_bSecureConnectionRequired = DEFAULT_SECURE_CONNECTION_REQUIRED;
- $this->m_sDefaultLanguage = 'EN US';
- $this->m_sAllowedLoginTypes = DEFAULT_ALLOWED_LOGIN_TYPES;
- $this->m_sExtAuthVariable = DEFAULT_EXT_AUTH_VARIABLE;
- $this->m_sEncryptionKey = DEFAULT_ENCRYPTION_KEY;
- $this->m_aCharsets = array();
-
- $this->m_aModuleSettings = array();
- if ($bLoadConfig)
- {
- $this->Load($sConfigFile);
- $this->Verify();
- }
- // Application root url: set a default value, then normalize it
- $sAppRootUrl = trim($this->Get('app_root_url'));
- if (strlen($sAppRootUrl) == 0)
- {
- $sAppRootUrl = utils::GetDefaultUrlAppRoot();
- }
- if (substr($sAppRootUrl, -1, 1) != '/')
- {
- $sAppRootUrl .= '/';
- }
- $this->Set('app_root_url', $sAppRootUrl);
- }
- protected function CheckFile($sPurpose, $sFileName)
- {
- if (!file_exists($sFileName))
- {
- throw new ConfigException("Could not find $sPurpose file", array('file' => $sFileName));
- }
- if (!is_readable($sFileName))
- {
- 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));
- }
- }
- protected function Load($sConfigFile)
- {
- $this->CheckFile('configuration', $sConfigFile);
- $sConfigCode = trim(file_get_contents($sConfigFile));
- // This does not work on several lines
- // preg_match('/^<\\?php(.*)\\?'.'>$/', $sConfigCode, $aMatches)...
- // So, I've implemented a solution suggested in the PHP doc (search for phpWrapper)
- try
- {
- ob_start();
- eval('?'.'>'.trim($sConfigCode));
- $sNoise = trim(ob_get_contents());
- ob_end_clean();
- }
- catch (Exception $e)
- {
- // well, never reach in case of parsing error :-(
- // will be improved in PHP 6 ?
- throw new ConfigException('Error in configuration file', array('file' => $sConfigFile, 'error' => $e->getMessage()));
- }
- if (strlen($sNoise) > 0)
- {
- // Note: sNoise is an html output, but so far it was ok for me (e.g. showing the entire call stack)
- throw new ConfigException('Syntax error in configuration file', array('file' => $sConfigFile, 'error' => '<tt>'.htmlentities($sNoise, ENT_QUOTES, 'UTF-8').'</tt>'));
- }
- if (!isset($MySettings) || !is_array($MySettings))
- {
- throw new ConfigException('Missing array in configuration file', array('file' => $sConfigFile, 'expected' => '$MySettings'));
- }
- if (!isset($MyModules) || !is_array($MyModules))
- {
- throw new ConfigException('Missing item in configuration file', array('file' => $sConfigFile, 'expected' => '$MyModules'));
- }
- if (!array_key_exists('application', $MyModules))
- {
- throw new ConfigException('Missing item in configuration file', array('file' => $sConfigFile, 'expected' => '$MyModules[\'application\']'));
- }
- if (!array_key_exists('business', $MyModules))
- {
- throw new ConfigException('Missing item in configuration file', array('file' => $sConfigFile, 'expected' => '$MyModules[\'business\']'));
- }
- if (!array_key_exists('addons', $MyModules))
- {
- throw new ConfigException('Missing item in configuration file', array('file' => $sConfigFile, 'expected' => '$MyModules[\'addons\']'));
- }
- if (!array_key_exists('user rights', $MyModules['addons']))
- {
- // Add one, by default
- $MyModules['addons']['user rights'] = '/addons/userrights/userrightsnull.class.inc.php';
- }
- if (!array_key_exists('dictionaries', $MyModules))
- {
- throw new ConfigException('Missing item in configuration file', array('file' => $sConfigFile, 'expected' => '$MyModules[\'dictionaries\']'));
- }
- $this->m_aAppModules = $MyModules['application'];
- $this->m_aDataModels = $MyModules['business'];
- if (isset($MyModules['webservices']))
- {
- $this->m_aWebServiceCategories = $MyModules['webservices'];
- }
- $this->m_aAddons = $MyModules['addons'];
- $this->m_aDictionaries = $MyModules['dictionaries'];
- foreach($MySettings as $sPropCode => $rawvalue)
- {
- if ($this->IsProperty($sPropCode))
- {
- $value = trim($rawvalue);
- $this->Set($sPropCode, $value, $sConfigFile);
- }
- }
- $this->m_sDBHost = trim($MySettings['db_host']);
- $this->m_sDBUser = trim($MySettings['db_user']);
- $this->m_sDBPwd = trim($MySettings['db_pwd']);
- $this->m_sDBName = trim($MySettings['db_name']);
- $this->m_sDBSubname = trim($MySettings['db_subname']);
- $this->m_sDBCharacterSet = isset($MySettings['db_character_set']) ? trim($MySettings['db_character_set']) : DEFAULT_CHARACTER_SET;
- $this->m_sDBCollation = isset($MySettings['db_collation']) ? trim($MySettings['db_collation']) : DEFAULT_COLLATION;
- $this->m_bLogGlobal = isset($MySettings['log_global']) ? (bool) trim($MySettings['log_global']) : DEFAULT_LOG_GLOBAL;
- $this->m_bLogNotification = isset($MySettings['log_notification']) ? (bool) trim($MySettings['log_notification']) : DEFAULT_LOG_NOTIFICATION;
- $this->m_bLogIssue = isset($MySettings['log_issue']) ? (bool) trim($MySettings['log_issue']) : DEFAULT_LOG_ISSUE;
- $this->m_bLogWebService = isset($MySettings['log_web_service']) ? (bool) trim($MySettings['log_web_service']) : DEFAULT_LOG_WEB_SERVICE;
- $this->m_bLogKPIDuration = isset($MySettings['log_kpi_duration']) ? (bool) trim($MySettings['log_kpi_duration']) : DEFAULT_LOG_KPI_DURATION;
- $this->m_bLogKPIMemory = isset($MySettings['log_kpi_memory']) ? (bool) trim($MySettings['log_kpi_memory']) : DEFAULT_LOG_KPI_MEMORY;
- $this->m_bDebugQueries = isset($MySettings['debug_queries']) ? (bool) trim($MySettings['debug_queries']) : DEFAULT_DEBUG_QUERIES;
- $this->m_bQueryCacheEnabled = isset($MySettings['query_cache_enabled']) ? (bool) trim($MySettings['query_cache_enabled']) : DEFAULT_QUERY_CACHE_ENABLED;
- $this->m_iMinDisplayLimit = isset($MySettings['min_display_limit']) ? trim($MySettings['min_display_limit']) : DEFAULT_MIN_DISPLAY_LIMIT;
- $this->m_iMaxDisplayLimit = isset($MySettings['max_display_limit']) ? trim($MySettings['max_display_limit']) : DEFAULT_MAX_DISPLAY_LIMIT;
- $this->m_iStandardReloadInterval = isset($MySettings['standard_reload_interval']) ? trim($MySettings['standard_reload_interval']) : DEFAULT_STANDARD_RELOAD_INTERVAL;
- $this->m_iFastReloadInterval = isset($MySettings['fast_reload_interval']) ? trim($MySettings['fast_reload_interval']) : DEFAULT_FAST_RELOAD_INTERVAL;
- $this->m_bSecureConnectionRequired = isset($MySettings['secure_connection_required']) ? (bool) trim($MySettings['secure_connection_required']) : DEFAULT_SECURE_CONNECTION_REQUIRED;
- $this->m_aModuleSettings = isset($MyModuleSettings) ? $MyModuleSettings : array();
- $this->m_sDefaultLanguage = isset($MySettings['default_language']) ? trim($MySettings['default_language']) : 'EN US';
- $this->m_sAllowedLoginTypes = isset($MySettings['allowed_login_types']) ? trim($MySettings['allowed_login_types']) : DEFAULT_ALLOWED_LOGIN_TYPES;
- $this->m_sExtAuthVariable = isset($MySettings['ext_auth_variable']) ? trim($MySettings['ext_auth_variable']) : DEFAULT_EXT_AUTH_VARIABLE;
- $this->m_sEncryptionKey = isset($MySettings['encryption_key']) ? trim($MySettings['encryption_key']) : DEFAULT_ENCRYPTION_KEY;
- $this->m_aCharsets = isset($MySettings['csv_import_charsets']) ? $MySettings['csv_import_charsets'] : array();
- }
- protected function Verify()
- {
- // Files are verified later on, just before using them -see MetaModel::Plugin()
- // (we have their final path at that point)
- }
- public function GetModuleSetting($sModule, $sProperty, $defaultvalue = null)
- {
- if (isset($this->m_aModuleSettings[$sModule][$sProperty]))
- {
- return $this->m_aModuleSettings[$sModule][$sProperty];
- }
- return $defaultvalue;
- }
- public function SetModuleSetting($sModule, $sProperty, $value)
- {
- $this->m_aModuleSettings[$sModule][$sProperty] = $value;
- }
- public function GetAppModules()
- {
- return $this->m_aAppModules;
- }
- public function SetAppModules($aAppModules)
- {
- $this->m_aAppModules = $aAppModules;
- }
- public function GetDataModels()
- {
- return $this->m_aDataModels;
- }
- public function SetDataModels($aDataModels)
- {
- $this->m_aDataModels = $aDataModels;
- }
- public function GetWebServiceCategories()
- {
- return $this->m_aWebServiceCategories;
- }
- public function SetWebServiceCategories($aWebServiceCategories)
- {
- $this->m_aWebServiceCategories = $aWebServiceCategories;
- }
- public function GetAddons()
- {
- return $this->m_aAddons;
- }
- public function SetAddons($aAddons)
- {
- $this->m_aAddons = $aAddons;
- }
- public function GetDictionaries()
- {
- return $this->m_aDictionaries;
- }
- public function SetDictionaries($aDictionaries)
- {
- $this->m_aDictionaries = $aDictionaries;
- }
- public function GetDBHost()
- {
- return $this->m_sDBHost;
- }
-
- public function GetDBName()
- {
- return $this->m_sDBName;
- }
- public function GetDBSubname()
- {
- return $this->m_sDBSubname;
- }
- public function GetDBCharacterSet()
- {
- return $this->m_sDBCharacterSet;
- }
- public function GetDBCollation()
- {
- return $this->m_sDBCollation;
- }
- public function GetDBUser()
- {
- return $this->m_sDBUser;
- }
- public function GetDBPwd()
- {
- return $this->m_sDBPwd;
- }
- public function GetLogGlobal()
- {
- return $this->m_bLogGlobal;
- }
- public function GetLogNotification()
- {
- return $this->m_bLogNotification;
- }
- public function GetLogIssue()
- {
- return $this->m_bLogIssue;
- }
- public function GetLogWebService()
- {
- return $this->m_bLogWebService;
- }
- public function GetLogKPIDuration()
- {
- return $this->m_bLogKPIDuration;
- }
- public function GetLogKPIMemory()
- {
- return $this->m_bLogKPIMemory;
- }
- public function GetDebugQueries()
- {
- return $this->m_bDebugQueries;
- }
- public function GetQueryCacheEnabled()
- {
- return $this->m_bQueryCacheEnabled;
- }
- public function GetMinDisplayLimit()
- {
- return $this->m_iMinDisplayLimit;
- }
- public function GetMaxDisplayLimit()
- {
- return $this->m_iMaxDisplayLimit;
- }
- public function GetStandardReloadInterval()
- {
- return $this->m_iStandardReloadInterval;
- }
- public function GetFastReloadInterval()
- {
- return $this->m_iFastReloadInterval;
- }
- public function GetSecureConnectionRequired()
- {
- return $this->m_bSecureConnectionRequired;
- }
- public function GetDefaultLanguage()
- {
- return $this->m_sDefaultLanguage;
- }
- public function GetEncryptionKey()
- {
- return $this->m_sEncryptionKey;
- }
- public function GetAllowedLoginTypes()
- {
- return explode('|', $this->m_sAllowedLoginTypes);
- }
- public function GetExternalAuthenticationVariable()
- {
- return $this->m_sExtAuthVariable;
- }
- public function GetCSVImportCharsets()
- {
- return $this->m_aCharsets;
- }
-
- public function SetDBHost($sDBHost)
- {
- $this->m_sDBHost = $sDBHost;
- }
-
- public function SetDBName($sDBName)
- {
- $this->m_sDBName = $sDBName;
- }
- public function SetDBSubname($sDBSubName)
- {
- $this->m_sDBSubname = $sDBSubName;
- }
- public function SetDBCharacterSet($sDBCharacterSet)
- {
- $this->m_sDBCharacterSet = $sDBCharacterSet;
- }
- public function SetDBCollation($sDBCollation)
- {
- $this->m_sDBCollation = $sDBCollation;
- }
- public function SetDBUser($sUser)
- {
- $this->m_sDBUser = $sUser;
- }
- public function SetDBPwd($sPwd)
- {
- $this->m_sDBPwd = $sPwd;
- }
- public function SetLogGlobal($iLogGlobal)
- {
- $this->m_iLogGlobal = $iLogGlobal;
- }
- public function SetLogNotification($iLogNotification)
- {
- $this->m_iLogNotification = $iLogNotification;
- }
- public function SetLogIssue($iLogIssue)
- {
- $this->m_iLogIssue = $iLogIssue;
- }
- public function SetLogWebService($iLogWebService)
- {
- $this->m_iLogWebService = $iLogWebService;
- }
- public function SetMinDisplayLimit($iMinDisplayLimit)
- {
- $this->m_iMinDisplayLimit = $iMinDisplayLimit;
- }
- public function SetMaxDisplayLimit($iMaxDisplayLimit)
- {
- $this->m_iMaxDisplayLimit = $iMaxDisplayLimit;
- }
- public function SetStandardReloadInterval($iStandardReloadInterval)
- {
- $this->m_iStandardReloadInterval = $iStandardReloadInterval;
- }
- public function SetFastReloadInterval($iFastReloadInterval)
- {
- $this->m_iFastReloadInterval = $iFastReloadInterval;
- }
- public function SetSecureConnectionRequired($bSecureConnectionRequired)
- {
- $this->m_bSecureConnectionRequired = $bSecureConnectionRequired;
- }
- public function SetDefaultLanguage($sLanguageCode)
- {
- $this->m_sDefaultLanguage = $sLanguageCode;
- }
- public function SetAllowedLoginTypes($aAllowedLoginTypes)
- {
- $this->m_sAllowedLoginTypes = implode('|', $aAllowedLoginTypes);
- }
- public function SetExternalAuthenticationVariable($sExtAuthVariable)
- {
- $this->m_sExtAuthVariable = $sExtAuthVariable;
- }
- public function SetEncryptionKey($sKey)
- {
- $this->m_sEncryptionKey = $sKey;
- }
- public function SetCSVImportCharsets($aCharsets)
- {
- $this->m_aCharsets = $aCharsets;
- }
- public function AddCSVImportCharset($sIconvCode, $sDisplayName)
- {
- $this->m_aCharsets[$sIconvCode] = $sDisplayName;
- }
- public function GetLoadedFile()
- {
- if (is_null($this->m_sFile))
- {
- return '';
- }
- else
- {
- return $this->m_sFile;
- }
- }
-
- /**
- * Render the configuration as an associative array
- * @return boolean True otherwise throws an Exception
- */
- public function ToArray()
- {
- $aSettings = array();
- foreach($this->m_aSettings as $sPropCode => $aSettingInfo)
- {
- $aSettings[$sPropCode] = $aSettingInfo['value'];
- }
- $aSettings['db_host'] = $this->m_sDBHost;
- $aSettings['db_user'] = $this->m_sDBUser;
- $aSettings['db_pwd'] = $this->m_sDBPwd;
- $aSettings['db_name'] = $this->m_sDBName;
- $aSettings['db_subname'] = $this->m_sDBSubname;
- $aSettings['db_character_set'] = $this->m_sDBCharacterSet;
- $aSettings['db_collation'] = $this->m_sDBCollation;
- $aSettings['log_global'] = $this->m_bLogGlobal;
- $aSettings['log_notification'] = $this->m_bLogNotification;
- $aSettings['log_issue'] = $this->m_bLogIssue;
- $aSettings['log_web_service'] = $this->m_bLogWebService;
- $aSettings['min_display_limit'] = $this->m_iMinDisplayLimit;
- $aSettings['max_display_limit'] = $this->m_iMaxDisplayLimit;
- $aSettings['standard_reload_interval'] = $this->m_iStandardReloadInterval;
- $aSettings['fast_reload_interval'] = $this->m_iFastReloadInterval;
- $aSettings['secure_connection_required'] = $this->m_bSecureConnectionRequired;
- $aSettings['default_language'] = $this->m_sDefaultLanguage;
- $aSettings['allowed_login_types'] = $this->m_sAllowedLoginTypes;
- $aSettings['encryption_key'] = $this->m_sEncryptionKey;
- $aSettings['csv_import_charsets'] = $this->m_aCharsets;
- foreach ($this->m_aModuleSettings as $sModule => $aProperties)
- {
- foreach ($aProperties as $sProperty => $value)
- {
- $aSettings['module_settings'][$sModule][$sProperty] = $value;
- }
- }
- foreach($this->m_aAppModules as $sFile)
- {
- $aSettings['application_list'][] = $sFile;
- }
- foreach($this->m_aDataModels as $sFile)
- {
- $aSettings['datamodel_list'][] = $sFile;
- }
- foreach($this->m_aWebServiceCategories as $sFile)
- {
- $aSettings['webservice_list'][] = $sFile;
- }
- foreach($this->m_aAddons as $sKey => $sFile)
- {
- $aSettings['addon_list'][] = $sFile;
- }
- foreach($this->m_aDictionaries as $sFile)
- {
- $aSettings['dictionary_list'][] = $sFile;
- }
- return $aSettings;
- }
- /**
- * Write the configuration to a file (php format) that can be reloaded later
- * By default write to the same file that was specified when constructing the object
- * @param $sFileName string Name of the file to write to (emtpy to write to the same file)
- * @return boolean True otherwise throws an Exception
- */
- public function WriteToFile($sFileName = '')
- {
- if (empty($sFileName))
- {
- $sFileName = $this->m_sFile;
- }
- $hFile = @fopen($sFileName, 'w');
- if ($hFile !== false)
- {
- fwrite($hFile, "<?php\n");
- fwrite($hFile, "\n/**\n");
- fwrite($hFile, " *\n");
- fwrite($hFile, " * phpMyORM configuration file, generated by the iTop configuration wizard\n");
- fwrite($hFile, " *\n");
- fwrite($hFile, " * The file is used in MetaModel::LoadConfig() which does all the necessary initialization job\n");
- fwrite($hFile, " *\n");
- fwrite($hFile, " */\n");
- fwrite($hFile, "\n");
-
- fwrite($hFile, "\$MySettings = array(\n");
- foreach($this->m_aSettings as $sPropCode => $aSettingInfo)
- {
- if ($aSettingInfo['show_in_conf_sample'])
- {
- $sType = $this->m_aSettings[$sPropCode]['type'];
- switch($sType)
- {
- case 'bool':
- $sSeenAs = $aSettingInfo['value'] ? '1' : '0';
- break;
- default:
- $sSeenAs = "'".addslashes($aSettingInfo['value'])."'";
- }
- fwrite($hFile, "\t'$sPropCode' => $sSeenAs,\n");
- }
- }
- fwrite($hFile, "\t'db_host' => '{$this->m_sDBHost}',\n");
- fwrite($hFile, "\t'db_user' => '{$this->m_sDBUser}',\n");
- fwrite($hFile, "\t'db_pwd' => '".addslashes($this->m_sDBPwd)."',\n");
- fwrite($hFile, "\t'db_name' => '{$this->m_sDBName}',\n");
- fwrite($hFile, "\t'db_subname' => '{$this->m_sDBSubname}',\n");
- fwrite($hFile, "\t'db_character_set' => '{$this->m_sDBCharacterSet}',\n");
- fwrite($hFile, "\t'db_collation' => '{$this->m_sDBCollation}',\n");
- fwrite($hFile, "\n");
- fwrite($hFile, "\t'log_global' => {$this->m_bLogGlobal},\n");
- fwrite($hFile, "\t'log_notification' => {$this->m_bLogNotification},\n");
- fwrite($hFile, "\t'log_issue' => {$this->m_bLogIssue},\n");
- fwrite($hFile, "\t'log_web_service' => {$this->m_bLogWebService},\n");
- fwrite($hFile, "\t'min_display_limit' => {$this->m_iMinDisplayLimit},\n");
- fwrite($hFile, "\t'max_display_limit' => {$this->m_iMaxDisplayLimit},\n");
- fwrite($hFile, "\t'standard_reload_interval' => {$this->m_iStandardReloadInterval},\n");
- fwrite($hFile, "\t'fast_reload_interval' => {$this->m_iFastReloadInterval},\n");
- fwrite($hFile, "\t'secure_connection_required' => ".($this->m_bSecureConnectionRequired ? 'true' : 'false').",\n");
- fwrite($hFile, "\t'default_language' => '{$this->m_sDefaultLanguage}',\n");
- fwrite($hFile, "\t'allowed_login_types' => '{$this->m_sAllowedLoginTypes}',\n");
- fwrite($hFile, "\t'encryption_key' => '{$this->m_sEncryptionKey}',\n");
- $sExport = var_export($this->m_aCharsets, true);
- fwrite($hFile, "\t'csv_import_charsets' => $sExport,\n");
- fwrite($hFile, ");\n");
- fwrite($hFile, "\n");
- fwrite($hFile, "\$MyModuleSettings = array(\n");
- foreach ($this->m_aModuleSettings as $sModule => $aProperties)
- {
- fwrite($hFile, "\t'$sModule' => array (\n");
- foreach ($aProperties as $sProperty => $value)
- {
- $sExport = var_export($value, true);
- fwrite($hFile, "\t\t'$sProperty' => $sExport,\n");
- }
- fwrite($hFile, "\t),\n");
- }
- fwrite($hFile, ");\n");
-
- fwrite($hFile, "\n/**\n");
- fwrite($hFile, " *\n");
- fwrite($hFile, " * Data model modules to be loaded. Names are specified as relative paths\n");
- fwrite($hFile, " *\n");
- fwrite($hFile, " */\n");
- fwrite($hFile, "\$MyModules = array(\n");
- fwrite($hFile, "\t'application' => array (\n");
- foreach($this->m_aAppModules as $sFile)
- {
- fwrite($hFile, "\t\t'$sFile',\n");
- }
- fwrite($hFile, "\t),\n");
- fwrite($hFile, "\t'business' => array (\n");
- foreach($this->m_aDataModels as $sFile)
- {
- fwrite($hFile, "\t\t'$sFile',\n");
- }
- fwrite($hFile, "\t),\n");
- fwrite($hFile, "\t'webservices' => array (\n");
- foreach($this->m_aWebServiceCategories as $sFile)
- {
- fwrite($hFile, "\t\t'$sFile',\n");
- }
- fwrite($hFile, "\t),\n");
- fwrite($hFile, "\t'addons' => array (\n");
- foreach($this->m_aAddons as $sKey => $sFile)
- {
- fwrite($hFile, "\t\t'$sKey' => '$sFile',\n");
- }
- fwrite($hFile, "\t),\n");
- fwrite($hFile, "\t'dictionaries' => array (\n");
- foreach($this->m_aDictionaries as $sFile)
- {
- fwrite($hFile, "\t\t'$sFile',\n");
- }
- fwrite($hFile, "\t),\n");
- fwrite($hFile, ");\n");
- fwrite($hFile, '?'.'>'); // Avoid perturbing the syntax highlighting !
- return fclose($hFile);
- }
- else
- {
- throw new ConfigException("Could not write to configuration file", array('file' => $sFileName));
- }
- }
-
- protected static function ScanDictionariesDir()
- {
- $aResult = array();
- // Populate automatically the list of dictionary files
- $sDir = APPROOT.'/dictionaries';
- if ($hDir = @opendir($sDir))
- {
- while (($sFile = readdir($hDir)) !== false)
- {
- $aMatches = array();
- if (preg_match("/^([^\.]+\.)?dictionary\.itop\.(ui|core)\.php$/i", $sFile, $aMatches)) // Dictionary files named like [<Lang>.]dictionary.[core|ui].php are loaded automatically
- {
- $aResult[] = 'dictionaries/'.$sFile;
- }
- }
- closedir($hDir);
- }
- return $aResult;
- }
- /**
- * Helper function to initialize a configuration from the page arguments
- */
- public function UpdateFromParams($aParamValues, $sModulesDir = null)
- {
- if (isset($aParamValues['application_path']))
- {
- $this->Set('app_root_url', $aParamValues['application_path']);
- }
- if (isset($aParamValues['mode']) && isset($aParamValues['language']))
- {
- if (($aParamValues['mode'] == 'install') || $this->GetDefaultLanguage() == '')
- {
- $this->SetDefaultLanguage($aParamValues['language']);
- }
- }
- if (isset($aParamValues['db_server']))
- {
- $this->SetDBHost($aParamValues['db_server']);
- $this->SetDBUser($aParamValues['db_user']);
- $this->SetDBPwd($aParamValues['db_pwd']);
- $sDBName = $aParamValues['db_name'];
- if ($sDBName == '')
- {
- $sDBName = $aParamValues['new_db_name'];
- }
- $this->SetDBName($sDBName);
- $this->SetDBSubname($aParamValues['db_prefix']);
- }
-
- if (!is_null($sModulesDir))
- {
- if (isset($aParamValues['selected_modules']))
- {
- $aSelectedModules = explode(',', $aParamValues['selected_modules']);
- }
- else
- {
- $aSelectedModules = null;
- }
-
- // Initialize the arrays below with default values for the application...
- $oEmptyConfig = new Config('dummy_file', false); // Do NOT load any config file, just set the default values
- $aAddOns = $oEmptyConfig->GetAddOns();
- $aAppModules = $oEmptyConfig->GetAppModules();
- $aDataModels = $oEmptyConfig->GetDataModels();
- $aWebServiceCategories = $oEmptyConfig->GetWebServiceCategories();
- $aDictionaries = $oEmptyConfig->GetDictionaries();
- // Merge the values with the ones provided by the modules
- // Make sure when don't load the same file twice...
-
- $aModules = ModuleDiscovery::GetAvailableModules(APPROOT, $sModulesDir);
- foreach($aModules as $sModuleId => $aModuleInfo)
- {
- list($sModuleName, $sModuleVersion) = ModuleDiscovery::GetModuleName($sModuleId);
- if (is_null($aSelectedModules) || in_array($sModuleName, $aSelectedModules))
- {
- if (isset($aModuleInfo['datamodel']))
- {
- $aDataModels = array_unique(array_merge($aDataModels, $aModuleInfo['datamodel']));
- }
- if (isset($aModuleInfo['webservice']))
- {
- $aWebServiceCategories = array_unique(array_merge($aWebServiceCategories, $aModuleInfo['webservice']));
- }
- if (isset($aModuleInfo['dictionary']))
- {
- $aDictionaries = array_unique(array_merge($aDictionaries, $aModuleInfo['dictionary']));
- }
- if (isset($aModuleInfo['settings']))
- {
- foreach($aModuleInfo['settings'] as $sProperty => $value)
- {
- list($sName, $sVersion) = ModuleDiscovery::GetModuleName($sModuleId);
- $this->SetModuleSetting($sName, $sProperty, $value);
- }
- }
- if (isset($aModuleInfo['installer']))
- {
- $sModuleInstallerClass = $aModuleInfo['installer'];
- if (!class_exists($sModuleInstallerClass))
- {
- throw new Exception("Wrong installer class: '$sModuleInstallerClass' is not a PHP class - Module: ".$aModuleInfo['label']);
- }
- if (!is_subclass_of($sModuleInstallerClass, 'ModuleInstallerAPI'))
- {
- throw new Exception("Wrong installer class: '$sModuleInstallerClass' is not derived from 'ModuleInstallerAPI' - Module: ".$aModuleInfo['label']);
- }
- $aCallSpec = array($sModuleInstallerClass, 'BeforeWritingConfig');
- call_user_func_array($aCallSpec, array($this));
- }
- }
- }
- $this->SetAddOns($aAddOns);
- $this->SetAppModules($aAppModules);
- $this->SetDataModels($aDataModels);
- $this->SetWebServiceCategories($aWebServiceCategories);
- $this->SetDictionaries($aDictionaries);
- }
- }
- /**
- * Helper: for an array of string, change the prefix when found
- */
- protected static function ChangePrefix(&$aStrings, $sSearchPrefix, $sNewPrefix)
- {
- foreach ($aStrings as &$sFile)
- {
- if (substr($sFile, 0, strlen($sSearchPrefix)) == $sSearchPrefix)
- {
- $sFile = $sNewPrefix.substr($sFile, strlen($sSearchPrefix));
- }
- }
- }
- /**
- * Quick an dirty way to clone a config file into another environment
- */
- public function ChangeModulesPath($sSourceEnv, $sTargetEnv)
- {
- $sSearchPrefix = 'env-'.$sSourceEnv.'/';
- $sNewPrefix = 'env-'.$sTargetEnv.'/';
- self::ChangePrefix($this->m_aDataModels, $sSearchPrefix, $sNewPrefix);
- self::ChangePrefix($this->m_aWebServiceCategories, $sSearchPrefix, $sNewPrefix);
- self::ChangePrefix($this->m_aDictionaries, $sSearchPrefix, $sNewPrefix);
- }
- }
- ?>
|