From 2f8b1036da42ec3d15a51c6b17a473f9f4df71d3 Mon Sep 17 00:00:00 2001
From: Thomas Bruederli <bruederli@kolabsys.com>
Date: Sat, 07 Feb 2015 12:33:24 -0500
Subject: [PATCH] Bump version and copyright year
---
program/lib/Roundcube/rcube_config.php | 454 ++++++++++++++++++++++++++++++++++++++++++++------------
1 files changed, 355 insertions(+), 99 deletions(-)
diff --git a/program/lib/Roundcube/rcube_config.php b/program/lib/Roundcube/rcube_config.php
index 18055f7..89e4544 100644
--- a/program/lib/Roundcube/rcube_config.php
+++ b/program/lib/Roundcube/rcube_config.php
@@ -3,7 +3,7 @@
/*
+-----------------------------------------------------------------------+
| This file is part of the Roundcube Webmail client |
- | Copyright (C) 2008-2012, 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. |
@@ -26,9 +26,12 @@
{
const DEFAULT_SKIN = 'larry';
- private $prop = array();
- private $errors = array();
+ private $env = '';
+ private $paths = array();
+ private $prop = array();
+ private $errors = array();
private $userprefs = array();
+
/**
* Renamed options
@@ -37,7 +40,6 @@
*/
private $legacy_props = array(
// new name => old name
- 'default_folders' => 'default_imap_folders',
'mail_pagesize' => 'pagesize',
'addressbook_pagesize' => 'pagesize',
'reply_mode' => 'top_posting',
@@ -47,12 +49,41 @@
'redundant_attachments_cache_ttl' => 'redundant_attachments_memcache_ttl',
);
-
/**
* Object constructor
+ *
+ * @param string Environment suffix for config files to load
*/
- public function __construct()
+ public function __construct($env = '')
{
+ $this->env = $env;
+
+ if ($paths = getenv('RCUBE_CONFIG_PATH')) {
+ $this->paths = explode(PATH_SEPARATOR, $paths);
+ // make all paths absolute
+ foreach ($this->paths as $i => $path) {
+ if (!rcube_utils::is_absolute_path($path)) {
+ if ($realpath = realpath(RCUBE_INSTALL_PATH . $path)) {
+ $this->paths[$i] = unslashify($realpath) . '/';
+ }
+ else {
+ unset($this->paths[$i]);
+ }
+ }
+ else {
+ $this->paths[$i] = unslashify($path) . '/';
+ }
+ }
+ }
+
+ if (defined('RCUBE_CONFIG_DIR') && !in_array(RCUBE_CONFIG_DIR, $this->paths)) {
+ $this->paths[] = RCUBE_CONFIG_DIR;
+ }
+
+ if (empty($this->paths)) {
+ $this->paths[] = RCUBE_INSTALL_PATH . 'config/';
+ }
+
$this->load();
// Defaults, that we do not require you to configure,
@@ -61,6 +92,104 @@
$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)
+ {
+ $_ = 'string';
+
+ // array requires hint to be passed.
+
+ if (preg_match('/^[-+]?(\d+(\.\d*)?|\.\d+)([eE][-+]?\d+)?$/', $value) !== false) {
+ $_ = 'double';
+ }
+ else if (preg_match('/^\d+$/', $value) !== false) {
+ $_ = 'integer';
+ }
+ else if (preg_match('/(t(rue)?)|(f(alse)?)/i', $value) !== false) {
+ $_ = 'boolean';
+ }
+
+ return $_;
+ }
+
+ /**
+ * @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)
+ {
+ $_ = getenv($varname);
+
+ if ($_ === false) {
+ $_ = $default_value;
+ }
+ else {
+ if (is_null($type)) {
+ $type = gettype($default_value);
+ }
+
+ $_ = $this->parse_env($_, $type);
+ }
+
+ return $_;
+ }
/**
* Load config from local config file
@@ -69,13 +198,22 @@
*/
private function load()
{
- // load main config file
- if (!$this->load_from_file(RCUBE_CONFIG_DIR . 'main.inc.php'))
- $this->errors[] = 'main.inc.php was not found.';
+ // Load default settings
+ if (!$this->load_from_file('defaults.inc.php')) {
+ $this->errors[] = 'defaults.inc.php was not found.';
+ }
- // load database config
- if (!$this->load_from_file(RCUBE_CONFIG_DIR . 'db.inc.php'))
- $this->errors[] = 'db.inc.php was not found.';
+ // 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')) {
+ $this->errors[] = 'config.inc.php was not found.';
+ }
+ else if (rand(1,100) == 10) { // log warning on every 100th request (average)
+ trigger_error("config.inc.php was not found. Please migrate your config by running bin/update.sh", E_USER_WARNING);
+ }
+ }
// load host-specific configuration
$this->load_host_config();
@@ -95,16 +233,19 @@
$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) {
@@ -121,17 +262,6 @@
// 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['_timezone_value'] = $this->client_timezone();
- }
- else if (is_numeric($this->prop['timezone']) && ($tz = timezone_name_from_abbr("", $this->prop['timezone'] * 3600, 0))) {
- $this->prop['timezone'] = $tz;
- }
- else if (empty($this->prop['timezone'])) {
- $this->prop['timezone'] = 'UTC';
- }
-
// remove deprecated properties
unset($this->prop['dst_active']);
@@ -145,45 +275,99 @@
*/
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(RCUBE_CONFIG_DIR . $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
* and merge with the already stored config values
*
- * @param string $fpath Full path to the config file to be loaded
+ * @param string $file Name of the config file to be loaded
* @return booelan True on success, false on failure
*/
- public function load_from_file($fpath)
+ public function load_from_file($file)
{
- if (is_file($fpath) && is_readable($fpath)) {
- // use output buffering, we don't need any output here
- ob_start();
- include($fpath);
- ob_end_clean();
+ $success = false;
- if (is_array($rcmail_config)) {
- $this->merge($rcmail_config);
- return true;
+ 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
+ ob_start();
+ include($fpath);
+ ob_end_clean();
+
+ if (is_array($config)) {
+ $this->merge($config);
+ $success = true;
+ }
+ // deprecated name of config variable
+ if (is_array($rcmail_config)) {
+ $this->merge($rcmail_config);
+ $success = true;
+ }
}
}
- return false;
+ return $success;
}
+ /**
+ * Helper method to resolve absolute paths to the given config file.
+ * This also takes the 'env' property into account.
+ *
+ * @param string Filename or absolute file path
+ * @param boolean Return -$env file path if exists
+ * @return array List of candidates in config dir path(s)
+ */
+ public function resolve_paths($file, $use_env = true)
+ {
+ $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))
+ $realpath = $envfile;
+ }
+
+ if ($realpath) {
+ $files[] = $realpath;
+
+ // no need to continue the loop if an absolute file path is given
+ if ($abs_path) {
+ break;
+ }
+ }
+ }
+
+ return $files;
+ }
/**
* Getter for a specific config parameter
@@ -201,10 +385,14 @@
$result = $def;
}
+ $result = $this->getenv_default('ROUNDCUBE_' . strtoupper($name), $result);
+
$rcube = rcube::get_instance();
- if ($name == 'timezone' && isset($this->prop['_timezone_value'])) {
- $result = $this->prop['_timezone_value'];
+ if ($name == 'timezone') {
+ if (empty($result) || $result == 'auto') {
+ $result = $this->client_timezone();
+ }
}
else if ($name == 'client_mimetypes') {
if ($result == null && $def == null)
@@ -219,7 +407,6 @@
return $plugin['result'];
}
-
/**
* Setter for a config parameter
*
@@ -231,7 +418,6 @@
$this->prop[$name] = $value;
}
-
/**
* Override config options with the given values (eg. user prefs)
*
@@ -239,10 +425,9 @@
*/
public function merge($prefs)
{
+ $prefs = $this->fix_legacy_props($prefs);
$this->prop = array_merge($this->prop, $prefs, $this->userprefs);
- $this->fix_legacy_props();
}
-
/**
* Merge the given prefs over the current config
@@ -252,17 +437,14 @@
*/
public function set_user_prefs($prefs)
{
+ $prefs = $this->fix_legacy_props($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 ($dont_override as $key) {
unset($prefs[$key]);
}
- }
-
- // convert user's timezone into the new format
- if (is_numeric($prefs['timezone']) && ($tz = timezone_name_from_abbr('', $prefs['timezone'] * 3600, 0))) {
- $prefs['timezone'] = $tz;
}
// larry is the new default skin :-)
@@ -272,26 +454,26 @@
$this->userprefs = $prefs;
$this->prop = array_merge($this->prop, $prefs);
-
- $this->fix_legacy_props();
-
- // override timezone settings with client values
- if ($this->prop['timezone'] == 'auto') {
- $this->prop['_timezone_value'] = isset($_SESSION['timezone']) ? $this->client_timezone() : $this->prop['_timezone_value'];
- }
- 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
+ * @return array Hash array containing all config properties
*/
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'];
}
/**
@@ -302,16 +484,16 @@
*/
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;
}
/**
@@ -345,7 +527,6 @@
return $key;
}
-
/**
* Try to autodetect operating system and find the correct line endings
*
@@ -356,14 +537,16 @@
// 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));
@@ -376,7 +559,6 @@
return "\n";
}
-
/**
* Return the mail domain configured for the given host
@@ -404,7 +586,6 @@
return $domain;
}
-
/**
* Getter for error state
*
@@ -415,19 +596,17 @@
return empty($this->errors) ? false : join("\n", $this->errors);
}
-
/**
* Internal getter for client's (browser) timezone identifier
*/
private function client_timezone()
{
- if (isset($_SESSION['timezone']) && is_numeric($_SESSION['timezone'])
- && ($ctz = timezone_name_from_abbr("", $_SESSION['timezone'] * 3600, 0))) {
- return $ctz;
- }
- else if (!empty($_SESSION['timezone'])) {
+ // @TODO: remove this legacy timezone handling in the future
+ $props = $this->fix_legacy_props(array('timezone' => $_SESSION['timezone']));
+
+ if (!empty($props['timezone'])) {
try {
- $tz = timezone_open($_SESSION['timezone']);
+ $tz = new DateTimeZone($props['timezone']);
return $tz->getName();
}
catch (Exception $e) { /* gracefully ignore */ }
@@ -439,16 +618,93 @@
/**
* Convert legacy options into new ones
+ *
+ * @param array $props Hash array with config props
+ *
+ * @return array Converted config props
*/
- private function fix_legacy_props()
+ private function fix_legacy_props($props)
{
foreach ($this->legacy_props as $new => $old) {
- if (isset($this->prop[$old])) {
- if (!isset($this->prop[$new])) {
- $this->prop[$new] = $this->prop[$old];
+ if (isset($props[$old])) {
+ if (!isset($props[$new])) {
+ $props[$new] = $props[$old];
}
- unset($this->prop[$old]);
+ unset($props[$old]);
}
}
+
+ // convert deprecated numeric timezone value
+ if (isset($props['timezone']) && is_numeric($props['timezone'])) {
+ if ($tz = self::timezone_name_from_abbr($props['timezone'])) {
+ $props['timezone'] = $tz;
+ }
+ else {
+ unset($props['timezone']);
+ }
+ }
+
+ return $props;
+ }
+
+ /**
+ * timezone_name_from_abbr() replacement. Converts timezone offset
+ * into timezone name abbreviation.
+ *
+ * @param float $offset Timezone offset (in hours)
+ *
+ * @return string Timezone abbreviation
+ */
+ static public function timezone_name_from_abbr($offset)
+ {
+ // List of timezones here is not complete - https://bugs.php.net/bug.php?id=44780
+ if ($tz = timezone_name_from_abbr('', $offset * 3600, 0)) {
+ return $tz;
+ }
+
+ // try with more complete list (#1489261)
+ $timezones = array(
+ '-660' => "Pacific/Apia",
+ '-600' => "Pacific/Honolulu",
+ '-570' => "Pacific/Marquesas",
+ '-540' => "America/Anchorage",
+ '-480' => "America/Los_Angeles",
+ '-420' => "America/Denver",
+ '-360' => "America/Chicago",
+ '-300' => "America/New_York",
+ '-270' => "America/Caracas",
+ '-240' => "America/Halifax",
+ '-210' => "Canada/Newfoundland",
+ '-180' => "America/Sao_Paulo",
+ '-60' => "Atlantic/Azores",
+ '0' => "Europe/London",
+ '60' => "Europe/Paris",
+ '120' => "Europe/Helsinki",
+ '180' => "Europe/Moscow",
+ '210' => "Asia/Tehran",
+ '240' => "Asia/Dubai",
+ '300' => "Asia/Karachi",
+ '270' => "Asia/Kabul",
+ '300' => "Asia/Karachi",
+ '330' => "Asia/Kolkata",
+ '345' => "Asia/Katmandu",
+ '360' => "Asia/Yekaterinburg",
+ '390' => "Asia/Rangoon",
+ '420' => "Asia/Krasnoyarsk",
+ '480' => "Asia/Shanghai",
+ '525' => "Australia/Eucla",
+ '540' => "Asia/Tokyo",
+ '570' => "Australia/Adelaide",
+ '600' => "Australia/Melbourne",
+ '630' => "Australia/Lord_Howe",
+ '660' => "Asia/Vladivostok",
+ '690' => "Pacific/Norfolk",
+ '720' => "Pacific/Auckland",
+ '765' => "Pacific/Chatham",
+ '780' => "Pacific/Enderbury",
+ '840' => "Pacific/Kiritimati",
+ );
+
+ return $timezones[(string) intval($offset * 60)];
}
}
--
Gitblit v1.9.1