X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=program%2Finclude%2Frcube_config.php;h=ceada11fa84d96eda82d3df47d9c2225f58e8092;hb=76507f7c63a660742e76889ad6e3919f3dde3bb0;hp=7be2b0d2cff69ad6a55adebd5ce60e9a2be4fb7f;hpb=1213c6e65f2bab1e140369839a9d0f6db28a9492;p=roundcube.git diff --git a/program/include/rcube_config.php b/program/include/rcube_config.php index 7be2b0d..ceada11 100644 --- a/program/include/rcube_config.php +++ b/program/include/rcube_config.php @@ -4,8 +4,8 @@ +-----------------------------------------------------------------------+ | program/include/rcube_config.php | | | - | This file is part of the RoundCube Webmail client | - | Copyright (C) 2008-2009, 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: | @@ -15,239 +15,338 @@ | Author: Thomas Bruederli | +-----------------------------------------------------------------------+ - $Id: $ + $Id: rcube_config.php 5499 2011-11-28 09:03:27Z alec $ */ /** - * Configuration class for RoundCube + * Configuration class for Roundcube * * @package Core */ class rcube_config { - private $prop = array(); - private $errors = array(); - - - /** - * Object constructor - */ - public function __construct() - { - $this->load(); - } - - - /** - * Load config from local config file - * - * @todo Remove global $CONFIG - */ - 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 (include(RCMAIL_CONFIG_DIR . '/main.inc.php')) - $this->prop = (array)$rcmail_config; - else - $this->errors[] = 'main.inc.php was not found.'; - - // load database config - if (include(RCMAIL_CONFIG_DIR . '/db.inc.php')) - $this->prop += (array)$rcmail_config; - else - $this->errors[] = 'db.inc.php was not found.'; - - // load host-specific configuration - $this->load_host_config(); - - // set skin (with fallback to old 'skin_path' property) - if (empty($this->prop['skin']) && !empty($this->prop['skin_path'])) - $this->prop['skin'] = str_replace('skins/', '', unslashify($this->prop['skin_path'])); - else if (empty($this->prop['skin'])) - $this->prop['skin'] = 'default'; - - // fix paths - $this->prop['log_dir'] = $this->prop['log_dir'] ? unslashify($this->prop['log_dir']) : INSTALL_PATH . 'logs'; - $this->prop['temp_dir'] = $this->prop['temp_dir'] ? 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, 'UTF-7'); - - if (!empty($this->prop['default_imap_folders'])) - foreach ($this->prop['default_imap_folders'] as $n => $folder) - $this->prop['default_imap_folders'][$n] = rcube_charset_convert($folder, RCMAIL_CHARSET, 'UTF-7'); - - // set PHP error logging according to config - if ($this->prop['debug_level'] & 1) { - ini_set('log_errors', 1); - - if ($this->prop['log_driver'] == 'syslog') { - ini_set('error_log', 'syslog'); - } else { - ini_set('error_log', $this->prop['log_dir'].'/errors'); - } + private $prop = array(); + private $errors = array(); + private $userprefs = array(); + + + /** + * Object constructor + */ + public function __construct() + { + $this->load(); } - if ($this->prop['debug_level'] & 4) { - ini_set('display_errors', 1); + + + /** + * Load config from local config file + * + * @todo Remove global $CONFIG + */ + private function load() + { + // 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(); + + // set skin (with fallback to old 'skin_path' property) + if (empty($this->prop['skin']) && !empty($this->prop['skin_path'])) + $this->prop['skin'] = str_replace('skins/', '', unslashify($this->prop['skin_path'])); + else if (empty($this->prop['skin'])) + $this->prop['skin'] = 'default'; + + // 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'); + + if (!empty($this->prop['default_imap_folders'])) + foreach ($this->prop['default_imap_folders'] as $n => $folder) + $this->prop['default_imap_folders'][$n] = rcube_charset_convert($folder, RCMAIL_CHARSET, 'UTF7-IMAP'); + + // set PHP error logging according to config + if ($this->prop['debug_level'] & 1) { + ini_set('log_errors', 1); + + if ($this->prop['log_driver'] == 'syslog') { + ini_set('error_log', 'syslog'); + } + else { + ini_set('error_log', $this->prop['log_dir'].'/errors'); + } + } + + // 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; } - else { - ini_set('display_errors', 0); + + /** + * Load a host-specific config file if configured + * This will merge the host specific configuration with the given one + */ + private function load_host_config() + { + $fname = null; + + if (is_array($this->prop['include_host_config'])) { + $fname = $this->prop['include_host_config'][$_SERVER['HTTP_HOST']]; + } + else if (!empty($this->prop['include_host_config'])) { + $fname = preg_replace('/[^a-z0-9\.\-_]/i', '', $_SERVER['HTTP_HOST']) . '.inc.php'; + } + + if ($fname) { + $this->load_from_file(RCMAIL_CONFIG_DIR . '/' . $fname); + } } - - // clear output buffer - ob_end_clean(); - - // export config data - $GLOBALS['CONFIG'] = &$this->prop; - } - - - /** - * Load a host-specific config file if configured - * This will merge the host specific configuration with the given one - */ - private function load_host_config() - { - $fname = null; - - if (is_array($this->prop['include_host_config'])) { - $fname = $this->prop['include_host_config'][$_SERVER['HTTP_HOST']]; + + + /** + * Read configuration from a file + * and merge with the already stored config values + * + * @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; + } + } + + return false; } - else if (!empty($this->prop['include_host_config'])) { - $fname = preg_replace('/[^a-z0-9\.\-_]/i', '', $_SERVER['HTTP_HOST']) . '.inc.php'; + + + /** + * Getter for a specific config parameter + * + * @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) + { + $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; } - if ($fname && is_file(RCMAIL_CONFIG_DIR . '/' . $fname)) { - include(RCMAIL_CONFIG_DIR . '/' . $fname); - $this->prop = array_merge($this->prop, (array)$rcmail_config); + + /** + * Setter for a config parameter + * + * @param string $name Parameter name + * @param mixed $value Parameter value + */ + public function set($name, $value) + { + $this->prop[$name] = $value; } - } - - - /** - * Getter for a specific config parameter - * - * @param string Parameter name - * @param mixed 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; - } - - - /** - * Setter for a config parameter - * - * @param string Parameter name - * @param mixed Parameter value - */ - public function set($name, $value) - { - $this->prop[$name] = $value; - } - - - /** - * Override config options with the given values (eg. user prefs) - * - * @param array Hash array with config props to merge over - */ - public function merge($prefs) - { - $this->prop = array_merge($this->prop, $prefs); - } - - - /** - * Getter for all config options - * - * @return array Hash array containg all config properties - */ - public function all() - { - return $this->prop; - } - - - /** - * Return a 24 byte key for the DES encryption - * - * @return string DES encryption key - */ - public function get_des_key() - { - $key = !empty($this->prop['des_key']) ? $this->prop['des_key'] : 'rcmail?24BitPwDkeyF**ECB'; - $len = strlen($key); - - // make sure the key is exactly 24 chars long - if ($len<24) - $key .= str_repeat('_', 24-$len); - else if ($len>24) - substr($key, 0, 24); - - return $key; - } - - - /** - * Try to autodetect operating system and find the correct line endings - * - * @return string The appropriate mail header delimiter - */ - public function header_delimiter() - { - // use the configured delimiter for headers - if (!empty($this->prop['mail_header_delimiter'])) - return $this->prop['mail_header_delimiter']; - else if (strtolower(substr(PHP_OS, 0, 3) == 'win')) - return "\r\n"; - else if (strtolower(substr(PHP_OS, 0, 3) == 'mac')) - return "\r\n"; - else - return "\n"; - } - - - - /** - * Return the mail domain configured for the given host - * - * @param string IMAP host - * @return string Resolved SMTP host - */ - public function mail_domain($host) - { - $domain = $host; - - if (is_array($this->prop['mail_domain'])) { - if (isset($this->prop['mail_domain'][$host])) - $domain = $this->prop['mail_domain'][$host]; + + + /** + * Override config options with the given values (eg. user prefs) + * + * @param array $prefs Hash array with config props to merge over + */ + public function merge($prefs) + { + $this->prop = array_merge($this->prop, $prefs, $this->userprefs); } - else if (!empty($this->prop['mail_domain'])) - $domain = $this->prop['mail_domain']; - - return $domain; - } - - - /** - * Getter for error state - * - * @return mixed Error message on error, False if no errors - */ - public function get_error() - { - return empty($this->errors) ? false : join("\n", $this->errors); - } -} + /** + * Merge the given prefs over the current config + * and make sure that they survive further merging. + * + * @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); + + // 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']); + } + + + /** + * Getter for all config options + * + * @return array Hash array containg all config properties + */ + public function all() + { + 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 $key Crypto key name + * @return string Crypto key + */ + public function get_crypto_key($key) + { + // Bomb out if the requested key does not exist + if (!array_key_exists($key, $this->prop)) { + raise_error(array( + 'code' => 500, 'type' => 'php', + 'file' => __FILE__, 'line' => __LINE__, + 'message' => "Request for unconfigured crypto key \"$key\"" + ), true, true); + } + + $key = $this->prop[$key]; + + // Bomb out if the configured key is not exactly 24 bytes long + if (strlen($key) != 24) { + raise_error(array( + 'code' => 500, 'type' => 'php', + 'file' => __FILE__, 'line' => __LINE__, + 'message' => "Configured crypto key '$key' is not exactly 24 bytes long" + ), true, true); + } + + return $key; + } + + + /** + * Try to autodetect operating system and find the correct line endings + * + * @return string The appropriate mail header delimiter + */ + public function header_delimiter() + { + // use the configured delimiter for headers + if (!empty($this->prop['mail_header_delimiter'])) { + $delim = $this->prop['mail_header_delimiter']; + if ($delim == "\n" || $delim == "\r\n") + return $delim; + else + raise_error(array( + 'code' => 500, 'type' => 'php', + 'file' => __FILE__, 'line' => __LINE__, + 'message' => "Invalid mail_header_delimiter setting" + ), true, false); + } + + $php_os = strtolower(substr(PHP_OS, 0, 3)); + + if ($php_os == 'win') + return "\r\n"; + + if ($php_os == 'mac') + return "\r\n"; + + return "\n"; + } + + + /** + * Return the mail domain configured for the given 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, $encode=true) + { + $domain = $host; + + if (is_array($this->prop['mail_domain'])) { + if (isset($this->prop['mail_domain'][$host])) + $domain = $this->prop['mail_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; + } + + + /** + * Getter for error state + * + * @return mixed Error message on error, False if no errors + */ + public function get_error() + { + return empty($this->errors) ? false : join("\n", $this->errors); + } + +}