From 10db0aaf3806686540aea4dcaeb0fa4faffebb8d Mon Sep 17 00:00:00 2001
From: Aleksander Machniak <alec@alec.pl>
Date: Wed, 08 Aug 2012 03:32:46 -0400
Subject: [PATCH] Make #settings-sections thiner
---
program/include/rcube_config.php | 191 +++++++++++++++++++++++++++++++++++++----------
1 files changed, 149 insertions(+), 42 deletions(-)
diff --git a/program/include/rcube_config.php b/program/include/rcube_config.php
index 36892c0..aae3656 100644
--- a/program/include/rcube_config.php
+++ b/program/include/rcube_config.php
@@ -5,8 +5,11 @@
| program/include/rcube_config.php |
| |
| This file is part of the Roundcube Webmail client |
- | Copyright (C) 2008-2010, Roundcube Dev. - Switzerland |
- | Licensed under the GNU GPL |
+ | Copyright (C) 2008-2012, The Roundcube Dev Team |
+ | |
+ | Licensed under the GNU General Public License version 3 or |
+ | any later version with exceptions for skins & plugins. |
+ | See the README file for a full license statement. |
| |
| PURPOSE: |
| Class to read configuration settings |
@@ -14,9 +17,6 @@
+-----------------------------------------------------------------------+
| Author: Thomas Bruederli <roundcube@gmail.com> |
+-----------------------------------------------------------------------+
-
- $Id$
-
*/
/**
@@ -30,6 +30,18 @@
private $errors = array();
private $userprefs = array();
+ /**
+ * Renamed options
+ *
+ * @var array
+ */
+ private $legacy_props = array(
+ // new name => old name
+ 'default_folders' => 'default_imap_folders',
+ 'mail_pagesize' => 'pagesize',
+ 'addressbook_pagesize' => 'pagesize',
+ );
+
/**
* Object constructor
@@ -37,6 +49,11 @@
public function __construct()
{
$this->load();
+
+ // Defaults, that we do not require you to configure,
+ // but contain information that is used in various
+ // locations in the code:
+ $this->set('contactlist_fields', array('name', 'firstname', 'surname', 'email'));
}
@@ -47,10 +64,6 @@
*/
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.';
@@ -58,27 +71,35 @@
// 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';
+ if (empty($this->prop['skin'])) {
+ if (!empty($this->prop['skin_path'])) {
+ $this->prop['skin'] = str_replace('skins/', '', unslashify($this->prop['skin_path']));
+ }
+ else {
+ $this->prop['skin'] = 'larry';
+ }
+ }
+
+ // larry is the new default skin :-)
+ if ($this->prop['skin'] == 'default')
+ $this->prop['skin'] = 'larry';
// 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');
+ $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');
+ if (!empty($this->prop['default_folders']))
+ foreach ($this->prop['default_folders'] as $n => $folder)
+ $this->prop['default_folders'][$n] = rcube_charset::convert($folder, RCMAIL_CHARSET, 'UTF7-IMAP');
// set PHP error logging according to config
if ($this->prop['debug_level'] & 1) {
@@ -91,15 +112,20 @@
ini_set('error_log', $this->prop['log_dir'].'/errors');
}
}
- if ($this->prop['debug_level'] & 4) {
- ini_set('display_errors', 1);
+
+ // 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 {
- ini_set('display_errors', 0);
+ else if (is_numeric($this->prop['timezone'])) {
+ $this->prop['timezone'] = timezone_name_from_abbr("", $this->prop['timezone'] * 3600, 0);
}
- // clear output buffer
- ob_end_clean();
+ // remove deprecated properties
+ unset($this->prop['dst_active']);
// export config data
$GLOBALS['CONFIG'] = &$this->prop;
@@ -130,13 +156,17 @@
* 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;
@@ -150,21 +180,39 @@
/**
* 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;
+ if (isset($this->prop[$name])) {
+ $result = $this->prop[$name];
+ }
+ else if (isset($this->legacy_props[$name])) {
+ return $this->get($this->legacy_props[$name], $def);
+ }
+ else {
+ $result = $def;
+ }
+
+ $rcube = rcube::get_instance();
+
+ if ($name == 'timezone' && isset($this->prop['_timezone_value']))
+ $result = $this->prop['_timezone_value'];
+
+ $plugin = $rcube->plugins->exec_hook('config_get', array(
+ 'name' => $name, 'default' => $def, 'result' => $result));
+
+ return $plugin['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)
{
@@ -175,7 +223,7 @@
/**
* 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)
{
@@ -187,12 +235,37 @@
* 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 ($dont_override as $key) {
+ unset($prefs[$key]);
+ }
+ }
+
+ // convert user's timezone into the new format
+ if (is_numeric($prefs['timezone'])) {
+ $prefs['timezone'] = timezone_name_from_abbr('', $prefs['timezone'] * 3600, 0);
+ }
+
+ // larry is the new default skin :-)
+ if ($prefs['skin'] == 'default') {
+ $prefs['skin'] = 'larry';
+ }
+
$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']) ? $this->client_timezone() : $this->prop['_timezone_value'];
+ }
+ else if (isset($this->prop['_timezone_value']))
+ unset($this->prop['_timezone_value']);
}
@@ -206,18 +279,37 @@
return $this->prop;
}
+ /**
+ * Special getter for user's timezone offset including DST
+ *
+ * @return float Timezone offset (in hours)
+ * @deprecated
+ */
+ public function get_timezone()
+ {
+ if ($tz = $this->get('timezone')) {
+ try {
+ $tz = new DateTimeZone($tz);
+ return $tz->getOffset(new DateTime('now')) / 3600;
+ }
+ catch (Exception $e) {
+ }
+ }
+
+ return 0;
+ }
/**
* 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)
{
// Bomb out if the requested key does not exist
if (!array_key_exists($key, $this->prop)) {
- raise_error(array(
+ rcube::raise_error(array(
'code' => 500, 'type' => 'php',
'file' => __FILE__, 'line' => __LINE__,
'message' => "Request for unconfigured crypto key \"$key\""
@@ -228,7 +320,7 @@
// Bomb out if the configured key is not exactly 24 bytes long
if (strlen($key) != 24) {
- raise_error(array(
+ rcube::raise_error(array(
'code' => 500, 'type' => 'php',
'file' => __FILE__, 'line' => __LINE__,
'message' => "Configured crypto key '$key' is not exactly 24 bytes long"
@@ -252,7 +344,7 @@
if ($delim == "\n" || $delim == "\r\n")
return $delim;
else
- raise_error(array(
+ rcube::raise_error(array(
'code' => 500, 'type' => 'php',
'file' => __FILE__, 'line' => __LINE__,
'message' => "Invalid mail_header_delimiter setting"
@@ -274,10 +366,11 @@
/**
* 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;
@@ -285,8 +378,13 @@
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']);
+ else if (!empty($this->prop['mail_domain'])) {
+ $domain = rcube_utils::parse_host($this->prop['mail_domain']);
+ }
+
+ if ($encode) {
+ $domain = rcube_utils::idn_to_ascii($domain);
+ }
return $domain;
}
@@ -302,4 +400,13 @@
return empty($this->errors) ? false : join("\n", $this->errors);
}
+
+ /**
+ * Internal getter for client's (browser) timezone identifier
+ */
+ private function client_timezone()
+ {
+ return isset($_SESSION['timezone']) ? timezone_name_from_abbr("", $_SESSION['timezone'] * 3600, 0) : date_default_timezone_get();
+ }
+
}
--
Gitblit v1.9.1