| | |
| | | <?php |
| | | |
| | | /* |
| | | /** |
| | | +-----------------------------------------------------------------------+ |
| | | | This file is part of the Roundcube Webmail client | |
| | | | Copyright (C) 2008-2013, The Roundcube Dev Team | |
| | | | Copyright (C) 2008-2014, The Roundcube Dev Team | |
| | | | | |
| | | | Licensed under the GNU General Public License version 3 or | |
| | | | any later version with exceptions for skins & plugins. | |
| | |
| | | { |
| | | const DEFAULT_SKIN = 'larry'; |
| | | |
| | | private $env = ''; |
| | | private $paths = array(); |
| | | private $prop = array(); |
| | | private $errors = array(); |
| | | private $env = ''; |
| | | private $paths = array(); |
| | | private $prop = array(); |
| | | private $errors = array(); |
| | | private $userprefs = array(); |
| | | |
| | | |
| | | /** |
| | | * Renamed options |
| | |
| | | */ |
| | | private $legacy_props = array( |
| | | // new name => old name |
| | | 'default_folders' => 'default_imap_folders', |
| | | 'mail_pagesize' => 'pagesize', |
| | | 'addressbook_pagesize' => 'pagesize', |
| | | 'reply_mode' => 'top_posting', |
| | |
| | | 'messages_cache_ttl' => 'message_cache_lifetime', |
| | | 'redundant_attachments_cache_ttl' => 'redundant_attachments_memcache_ttl', |
| | | ); |
| | | |
| | | |
| | | /** |
| | | * Object constructor |
| | |
| | | $this->paths = explode(PATH_SEPARATOR, $paths); |
| | | // make all paths absolute |
| | | foreach ($this->paths as $i => $path) { |
| | | if (!$this->_is_absolute($path)) { |
| | | if (!rcube_utils::is_absolute_path($path)) { |
| | | if ($realpath = realpath(RCUBE_INSTALL_PATH . $path)) { |
| | | $this->paths[$i] = unslashify($realpath) . '/'; |
| | | } |
| | |
| | | $this->set('contactlist_fields', array('name', 'firstname', 'surname', 'email')); |
| | | } |
| | | |
| | | /** |
| | | * @brief Guess the type the string may fit into. |
| | | * |
| | | * Look inside the string to determine what type might be best as a container. |
| | | * |
| | | * @param $value The value to inspect |
| | | * |
| | | * @return The guess at the type. |
| | | */ |
| | | private function guess_type($value) |
| | | { |
| | | $type = 'string'; |
| | | |
| | | // array requires hint to be passed. |
| | | |
| | | if (preg_match('/^[-+]?(\d+(\.\d*)?|\.\d+)([eE][-+]?\d+)?$/', $value) !== false) { |
| | | $type = 'double'; |
| | | } |
| | | else if (preg_match('/^\d+$/', $value) !== false) { |
| | | $type = 'integer'; |
| | | } |
| | | else if (preg_match('/(t(rue)?)|(f(alse)?)/i', $value) !== false) { |
| | | $type = 'boolean'; |
| | | } |
| | | |
| | | return $type; |
| | | } |
| | | |
| | | /** |
| | | * @brief Parse environment variable into PHP type. |
| | | * |
| | | * Perform an appropriate parsing of the string to create the desired PHP type. |
| | | * |
| | | * @param $string String to parse into PHP type |
| | | * @param $type Type of value to return |
| | | * |
| | | * @return Appropriately typed interpretation of $string. |
| | | */ |
| | | private function parse_env($string, $type) |
| | | { |
| | | $_ = $string; |
| | | |
| | | switch ($type) { |
| | | case 'boolean': |
| | | $_ = (boolean) $_; |
| | | break; |
| | | case 'integer': |
| | | $_ = (integer) $_; |
| | | break; |
| | | case 'double': |
| | | $_ = (double) $_; |
| | | break; |
| | | case 'string': |
| | | break; |
| | | case 'array': |
| | | $_ = json_decode($_, true); |
| | | break; |
| | | case 'object': |
| | | $_ = json_decode($_, false); |
| | | break; |
| | | case 'resource': |
| | | case 'NULL': |
| | | default: |
| | | $_ = $this->parse_env($_, $this->guess_type($_)); |
| | | } |
| | | |
| | | return $_; |
| | | } |
| | | |
| | | /** |
| | | * @brief Get environment variable value. |
| | | * |
| | | * Retrieve an environment variable's value or if it's not found, return the |
| | | * provided default value. |
| | | * |
| | | * @param $varname Environment variable name |
| | | * @param $default_value Default value to return if necessary |
| | | * @param $type Type of value to return |
| | | * |
| | | * @return Value of the environment variable or default if not found. |
| | | */ |
| | | private function getenv_default($varname, $default_value, $type = null) |
| | | { |
| | | $value = getenv($varname); |
| | | |
| | | if ($value === false) { |
| | | $value = $default_value; |
| | | } |
| | | else { |
| | | $value = $this->parse_env($value, $type ?: gettype($default_value)); |
| | | } |
| | | |
| | | return $value; |
| | | } |
| | | |
| | | /** |
| | | * Load config from local config file |
| | |
| | | // load main config file |
| | | if (!$this->load_from_file('config.inc.php')) { |
| | | // Old configuration files |
| | | if (!$this->load_from_file('main.inc.php') || |
| | | !$this->load_from_file('db.inc.php')) { |
| | | if (!$this->load_from_file('main.inc.php') || !$this->load_from_file('db.inc.php')) { |
| | | $this->errors[] = 'config.inc.php was not found.'; |
| | | } |
| | | else if (rand(1,100) == 10) { // log warning on every 100th request (average) |
| | |
| | | } |
| | | |
| | | // load host-specific configuration |
| | | if (!empty($_SERVER['HTTP_HOST'])) |
| | | $this->load_host_config(); |
| | | $this->load_host_config(); |
| | | |
| | | // set skin (with fallback to old 'skin_path' property) |
| | | if (empty($this->prop['skin'])) { |
| | |
| | | } |
| | | |
| | | // larry is the new default skin :-) |
| | | if ($this->prop['skin'] == 'default') |
| | | if ($this->prop['skin'] == 'default') { |
| | | $this->prop['skin'] = self::DEFAULT_SKIN; |
| | | } |
| | | |
| | | // fix paths |
| | | $this->prop['log_dir'] = $this->prop['log_dir'] ? realpath(unslashify($this->prop['log_dir'])) : RCUBE_INSTALL_PATH . 'logs'; |
| | | $this->prop['temp_dir'] = $this->prop['temp_dir'] ? realpath(unslashify($this->prop['temp_dir'])) : RCUBE_INSTALL_PATH . 'temp'; |
| | | foreach (array('log_dir' => 'logs', 'temp_dir' => 'temp') as $key => $dir) { |
| | | foreach (array($this->prop[$key], '../' . $this->prop[$key], RCUBE_INSTALL_PATH . $dir) as $path) { |
| | | if ($path && ($realpath = realpath(unslashify($path)))) { |
| | | $this->prop[$key] = $realpath; |
| | | break; |
| | | } |
| | | } |
| | | } |
| | | |
| | | // fix default imap folders encoding |
| | | foreach (array('drafts_mbox', 'junk_mbox', 'sent_mbox', 'trash_mbox') as $folder) |
| | | foreach (array('drafts_mbox', 'junk_mbox', 'sent_mbox', 'trash_mbox') as $folder) { |
| | | $this->prop[$folder] = rcube_charset::convert($this->prop[$folder], RCUBE_CHARSET, 'UTF7-IMAP'); |
| | | |
| | | if (!empty($this->prop['default_folders'])) |
| | | foreach ($this->prop['default_folders'] as $n => $folder) |
| | | $this->prop['default_folders'][$n] = rcube_charset::convert($folder, RCUBE_CHARSET, 'UTF7-IMAP'); |
| | | } |
| | | |
| | | // set PHP error logging according to config |
| | | if ($this->prop['debug_level'] & 1) { |
| | |
| | | */ |
| | | 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 (empty($this->prop['include_host_config'])) { |
| | | return; |
| | | } |
| | | |
| | | if ($fname) { |
| | | $this->load_from_file($fname); |
| | | foreach (array('HTTP_HOST', 'SERVER_NAME', 'SERVER_ADDR') as $key) { |
| | | $fname = null; |
| | | $name = $_SERVER[$key]; |
| | | |
| | | if (!$name) { |
| | | continue; |
| | | } |
| | | |
| | | if (is_array($this->prop['include_host_config'])) { |
| | | $fname = $this->prop['include_host_config'][$name]; |
| | | } |
| | | else { |
| | | $fname = preg_replace('/[^a-z0-9\.\-_]/i', '', $name) . '.inc.php'; |
| | | } |
| | | |
| | | if ($fname && $this->load_from_file($fname)) { |
| | | return; |
| | | } |
| | | } |
| | | } |
| | | |
| | | |
| | | /** |
| | | * Read configuration from a file |
| | |
| | | |
| | | foreach ($this->resolve_paths($file) as $fpath) { |
| | | if ($fpath && is_file($fpath) && is_readable($fpath)) { |
| | | // use output buffering, we don't need any output here |
| | | // use output buffering, we don't need any output here |
| | | ob_start(); |
| | | include($fpath); |
| | | ob_end_clean(); |
| | |
| | | $success = true; |
| | | } |
| | | // deprecated name of config variable |
| | | else if (is_array($rcmail_config)) { |
| | | if (is_array($rcmail_config)) { |
| | | $this->merge($rcmail_config); |
| | | $success = true; |
| | | } |
| | |
| | | */ |
| | | public function resolve_paths($file, $use_env = true) |
| | | { |
| | | $files = array(); |
| | | $abs_path = $this->_is_absolute($file); |
| | | $files = array(); |
| | | $abs_path = rcube_utils::is_absolute_path($file); |
| | | |
| | | foreach ($this->paths as $basepath) { |
| | | $realpath = $abs_path ? $file : realpath($basepath . '/' . $file); |
| | |
| | | // check if <file>-env.ini exists |
| | | if ($realpath && $use_env && !empty($this->env)) { |
| | | $envfile = preg_replace('/\.(inc.php)$/', '-' . $this->env . '.\\1', $realpath); |
| | | if (is_file($envfile)) |
| | | if (is_file($envfile)) { |
| | | $realpath = $envfile; |
| | | } |
| | | } |
| | | |
| | | if ($realpath) { |
| | |
| | | } |
| | | |
| | | return $files; |
| | | } |
| | | |
| | | /** |
| | | * Determine whether the given file path is absolute or relative |
| | | */ |
| | | private function _is_absolute($path) |
| | | { |
| | | return $path[0] == DIRECTORY_SEPARATOR || preg_match('!^[a-z]:[\\\\/]!i', $path); |
| | | } |
| | | |
| | | /** |
| | |
| | | $result = $def; |
| | | } |
| | | |
| | | $rcube = rcube::get_instance(); |
| | | $result = $this->getenv_default('ROUNDCUBE_' . strtoupper($name), $result); |
| | | $rcube = rcube::get_instance(); |
| | | |
| | | if ($name == 'timezone') { |
| | | if (empty($result) || $result == 'auto') { |
| | |
| | | } |
| | | } |
| | | else if ($name == 'client_mimetypes') { |
| | | if ($result == null && $def == null) |
| | | if (!$result && !$def) { |
| | | $result = 'text/plain,text/html,text/xml,image/jpeg,image/gif,image/png,image/bmp,image/tiff,application/x-javascript,application/pdf,application/x-shockwave-flash'; |
| | | if ($result && is_string($result)) |
| | | } |
| | | if ($result && is_string($result)) { |
| | | $result = explode(',', $result); |
| | | } |
| | | } |
| | | |
| | | $plugin = $rcube->plugins->exec_hook('config_get', array( |
| | |
| | | |
| | | return $plugin['result']; |
| | | } |
| | | |
| | | |
| | | /** |
| | | * Setter for a config parameter |
| | |
| | | $this->prop[$name] = $value; |
| | | } |
| | | |
| | | |
| | | /** |
| | | * Override config options with the given values (eg. user prefs) |
| | | * |
| | |
| | | $prefs = $this->fix_legacy_props($prefs); |
| | | $this->prop = array_merge($this->prop, $prefs, $this->userprefs); |
| | | } |
| | | |
| | | |
| | | /** |
| | | * Merge the given prefs over the current config |
| | |
| | | $this->prop = array_merge($this->prop, $prefs); |
| | | } |
| | | |
| | | |
| | | /** |
| | | * Getter for all config options |
| | | * |
| | |
| | | */ |
| | | public function all() |
| | | { |
| | | return $this->prop; |
| | | $props = $this->prop; |
| | | |
| | | foreach ($props as $prop_name => $prop_value) { |
| | | $props[$prop_name] = $this->getenv_default('ROUNDCUBE_' . strtoupper($prop_name), $prop_value); |
| | | } |
| | | |
| | | $rcube = rcube::get_instance(); |
| | | $plugin = $rcube->plugins->exec_hook('config_get', array( |
| | | 'name' => '*', 'result' => $props)); |
| | | |
| | | return $plugin['result']; |
| | | } |
| | | |
| | | /** |
| | |
| | | */ |
| | | public function get_timezone() |
| | | { |
| | | if ($tz = $this->get('timezone')) { |
| | | try { |
| | | $tz = new DateTimeZone($tz); |
| | | return $tz->getOffset(new DateTime('now')) / 3600; |
| | | if ($tz = $this->get('timezone')) { |
| | | try { |
| | | $tz = new DateTimeZone($tz); |
| | | return $tz->getOffset(new DateTime('now')) / 3600; |
| | | } |
| | | catch (Exception $e) { |
| | | } |
| | | } |
| | | catch (Exception $e) { |
| | | } |
| | | } |
| | | |
| | | return 0; |
| | | return 0; |
| | | } |
| | | |
| | | /** |
| | | * 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)) { |
| | | if (!array_key_exists($key, $this->prop) || empty($this->prop[$key])) { |
| | | rcube::raise_error(array( |
| | | 'code' => 500, 'type' => 'php', |
| | | 'file' => __FILE__, 'line' => __LINE__, |
| | |
| | | ), true, true); |
| | | } |
| | | |
| | | $key = $this->prop[$key]; |
| | | |
| | | // Bomb out if the configured key is not exactly 24 bytes long |
| | | if (strlen($key) != 24) { |
| | | rcube::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; |
| | | return $this->prop[$key]; |
| | | } |
| | | |
| | | /** |
| | | * Return configured crypto method. |
| | | * |
| | | * @return string Crypto method |
| | | */ |
| | | public function get_crypto_method() |
| | | { |
| | | return $this->get('cipher_method') ?: 'DES-EDE3-CBC'; |
| | | } |
| | | |
| | | /** |
| | | * Try to autodetect operating system and find the correct line endings |
| | |
| | | // 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") |
| | | if ($delim == "\n" || $delim == "\r\n") { |
| | | return $delim; |
| | | else |
| | | } |
| | | else { |
| | | rcube::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)); |
| | |
| | | return "\n"; |
| | | } |
| | | |
| | | |
| | | /** |
| | | * Return the mail domain configured for the given host |
| | | * |
| | |
| | | $domain = $host; |
| | | |
| | | if (is_array($this->prop['mail_domain'])) { |
| | | if (isset($this->prop['mail_domain'][$host])) |
| | | if (isset($this->prop['mail_domain'][$host])) { |
| | | $domain = $this->prop['mail_domain'][$host]; |
| | | } |
| | | } |
| | | else if (!empty($this->prop['mail_domain'])) { |
| | | $domain = rcube_utils::parse_host($this->prop['mail_domain']); |
| | |
| | | return $domain; |
| | | } |
| | | |
| | | |
| | | /** |
| | | * Getter for error state |
| | | * |
| | |
| | | { |
| | | return empty($this->errors) ? false : join("\n", $this->errors); |
| | | } |
| | | |
| | | |
| | | /** |
| | | * Internal getter for client's (browser) timezone identifier |
| | |
| | | '180' => "Europe/Moscow", |
| | | '210' => "Asia/Tehran", |
| | | '240' => "Asia/Dubai", |
| | | '300' => "Asia/Karachi", |
| | | '270' => "Asia/Kabul", |
| | | '300' => "Asia/Karachi", |
| | | '330' => "Asia/Kolkata", |