| | |
| | | +-----------------------------------------------------------------------+ |
| | | | program/include/rcube_config.php | |
| | | | | |
| | | | This file is part of the RoundCube Webmail client | |
| | | | Copyright (C) 2008-2010, RoundCube Dev. - Switzerland | |
| | | | This file is part of the Roundcube Webmail client | |
| | | | Copyright (C) 2008-2010, The Roundcube Dev Team | |
| | | | Licensed under the GNU GPL | |
| | | | | |
| | | | PURPOSE: | |
| | |
| | | */ |
| | | |
| | | /** |
| | | * Configuration class for RoundCube |
| | | * Configuration class for Roundcube |
| | | * |
| | | * @package Core |
| | | */ |
| | |
| | | */ |
| | | private function load() |
| | | { |
| | | // start output buffering, we don't need any output yet, |
| | | // it'll be cleared after reading of config files, etc. |
| | | ob_start(); |
| | | |
| | | // load main config file |
| | | if (!$this->load_from_file(RCMAIL_CONFIG_DIR . '/main.inc.php')) |
| | | $this->errors[] = 'main.inc.php was not found.'; |
| | |
| | | // load database config |
| | | if (!$this->load_from_file(RCMAIL_CONFIG_DIR . '/db.inc.php')) |
| | | $this->errors[] = 'db.inc.php was not found.'; |
| | | |
| | | |
| | | // load host-specific configuration |
| | | $this->load_host_config(); |
| | | |
| | |
| | | // fix paths |
| | | $this->prop['log_dir'] = $this->prop['log_dir'] ? realpath(unslashify($this->prop['log_dir'])) : INSTALL_PATH . 'logs'; |
| | | $this->prop['temp_dir'] = $this->prop['temp_dir'] ? realpath(unslashify($this->prop['temp_dir'])) : INSTALL_PATH . 'temp'; |
| | | |
| | | |
| | | // fix default imap folders encoding |
| | | foreach (array('drafts_mbox', 'junk_mbox', 'sent_mbox', 'trash_mbox') as $folder) |
| | | $this->prop[$folder] = rcube_charset_convert($this->prop[$folder], RCMAIL_CHARSET, 'UTF7-IMAP'); |
| | |
| | | ini_set('error_log', $this->prop['log_dir'].'/errors'); |
| | | } |
| | | } |
| | | if ($this->prop['debug_level'] & 4) { |
| | | ini_set('display_errors', 1); |
| | | } |
| | | else { |
| | | ini_set('display_errors', 0); |
| | | } |
| | | |
| | | // clear output buffer |
| | | ob_end_clean(); |
| | | // enable display_errors in 'show' level, but not for ajax requests |
| | | ini_set('display_errors', intval(empty($_REQUEST['_remote']) && ($this->prop['debug_level'] & 4))); |
| | | |
| | | // set timezone auto settings values |
| | | if ($this->prop['timezone'] == 'auto') { |
| | | $this->prop['dst_active'] = intval(date('I')); |
| | | $this->prop['_timezone_value'] = date('Z') / 3600 - $this->prop['dst_active']; |
| | | } |
| | | else if ($this->prop['dst_active'] === null) { |
| | | $this->prop['dst_active'] = intval(date('I')); |
| | | } |
| | | |
| | | // export config data |
| | | $GLOBALS['CONFIG'] = &$this->prop; |
| | |
| | | * Read configuration from a file |
| | | * and merge with the already stored config values |
| | | * |
| | | * @param string Full path to the config file to be loaded |
| | | * @param string $fpath Full path to the config file to be loaded |
| | | * @return booelan True on success, false on failure |
| | | */ |
| | | public function load_from_file($fpath) |
| | | { |
| | | if (is_file($fpath) && is_readable($fpath)) { |
| | | // use output buffering, we don't need any output here |
| | | ob_start(); |
| | | include($fpath); |
| | | ob_end_clean(); |
| | | |
| | | if (is_array($rcmail_config)) { |
| | | $this->prop = array_merge($this->prop, $rcmail_config, $this->userprefs); |
| | | return true; |
| | |
| | | /** |
| | | * Getter for a specific config parameter |
| | | * |
| | | * @param string Parameter name |
| | | * @param mixed Default value if not set |
| | | * @param string $name Parameter name |
| | | * @param mixed $def Default value if not set |
| | | * @return mixed The requested config value |
| | | */ |
| | | public function get($name, $def = null) |
| | | { |
| | | return isset($this->prop[$name]) ? $this->prop[$name] : $def; |
| | | $result = isset($this->prop[$name]) ? $this->prop[$name] : $def; |
| | | $rcmail = rcmail::get_instance(); |
| | | |
| | | if ($name == 'timezone' && isset($this->prop['_timezone_value'])) |
| | | $result = $this->prop['_timezone_value']; |
| | | |
| | | if (is_object($rcmail->plugins)) { |
| | | $plugin = $rcmail->plugins->exec_hook('config_get', array( |
| | | 'name' => $name, 'default' => $def, 'result' => $result)); |
| | | |
| | | return $plugin['result']; |
| | | } |
| | | |
| | | return $result; |
| | | } |
| | | |
| | | |
| | | /** |
| | | * Setter for a config parameter |
| | | * |
| | | * @param string Parameter name |
| | | * @param mixed Parameter value |
| | | * @param string $name Parameter name |
| | | * @param mixed $value Parameter value |
| | | */ |
| | | public function set($name, $value) |
| | | { |
| | |
| | | /** |
| | | * Override config options with the given values (eg. user prefs) |
| | | * |
| | | * @param array Hash array with config props to merge over |
| | | * @param array $prefs Hash array with config props to merge over |
| | | */ |
| | | public function merge($prefs) |
| | | { |
| | |
| | | * Merge the given prefs over the current config |
| | | * and make sure that they survive further merging. |
| | | * |
| | | * @param array Hash array with user prefs |
| | | * @param array $prefs Hash array with user prefs |
| | | */ |
| | | public function set_user_prefs($prefs) |
| | | { |
| | | // Honor the dont_override setting for any existing user preferences |
| | | $dont_override = $this->get('dont_override'); |
| | | if (is_array($dont_override) && !empty($dont_override)) { |
| | | foreach ($prefs as $key => $pref) { |
| | | if (in_array($key, $dont_override)) { |
| | | unset($prefs[$key]); |
| | | } |
| | | } |
| | | } |
| | | |
| | | $this->userprefs = $prefs; |
| | | $this->prop = array_merge($this->prop, $prefs); |
| | | $this->prop = array_merge($this->prop, $prefs); |
| | | |
| | | // override timezone settings with client values |
| | | if ($this->prop['timezone'] == 'auto') { |
| | | $this->prop['_timezone_value'] = isset($_SESSION['timezone']) ? $_SESSION['timezone'] : $this->prop['_timezone_value']; |
| | | $this->prop['dst_active'] = $this->userprefs['dst_active'] = isset($_SESSION['dst_active']) ? $_SESSION['dst_active'] : $this->prop['dst_active']; |
| | | } |
| | | else if (isset($this->prop['_timezone_value'])) |
| | | unset($this->prop['_timezone_value']); |
| | | } |
| | | |
| | | |
| | |
| | | return $this->prop; |
| | | } |
| | | |
| | | /** |
| | | * Special getter for user's timezone offset including DST |
| | | * |
| | | * @return float Timezone offset (in hours) |
| | | */ |
| | | public function get_timezone() |
| | | { |
| | | return floatval($this->get('timezone')) + intval($this->get('dst_active')); |
| | | } |
| | | |
| | | /** |
| | | * Return requested DES crypto key. |
| | | * |
| | | * @param string Crypto key name |
| | | * @param string $key Crypto key name |
| | | * @return string Crypto key |
| | | */ |
| | | public function get_crypto_key($key) |
| | |
| | | /** |
| | | * Return the mail domain configured for the given host |
| | | * |
| | | * @param string IMAP host |
| | | * @param string $host IMAP host |
| | | * @param boolean $encode If true, domain name will be converted to IDN ASCII |
| | | * @return string Resolved SMTP host |
| | | */ |
| | | public function mail_domain($host) |
| | | public function mail_domain($host, $encode=true) |
| | | { |
| | | $domain = $host; |
| | | |
| | |
| | | else if (!empty($this->prop['mail_domain'])) |
| | | $domain = rcube_parse_host($this->prop['mail_domain']); |
| | | |
| | | if ($encode) |
| | | $domain = rcube_idn_to_ascii($domain); |
| | | |
| | | return $domain; |
| | | } |
| | | |