From 617b4f699f2e47991c50e05528b1f9ecbc3c3d9c Mon Sep 17 00:00:00 2001
From: svncommit <devs@roundcube.net>
Date: Tue, 12 May 2009 09:26:07 -0400
Subject: [PATCH] Minimize chance of race condition in session handling (#1485659, #1484678)
---
program/include/rcmail.php | 280 +++++++++++++++++++++++++++++++++++++++++++------------
1 files changed, 217 insertions(+), 63 deletions(-)
diff --git a/program/include/rcmail.php b/program/include/rcmail.php
index 5b8e74c..45b59ae 100644
--- a/program/include/rcmail.php
+++ b/program/include/rcmail.php
@@ -5,7 +5,7 @@
| program/include/rcmail.php |
| |
| This file is part of the RoundCube Webmail client |
- | Copyright (C) 2008, RoundCube Dev. - Switzerland |
+ | Copyright (C) 2008-2009, RoundCube Dev. - Switzerland |
| Licensed under the GNU GPL |
| |
| PURPOSE: |
@@ -15,7 +15,7 @@
| Author: Thomas Bruederli <roundcube@gmail.com> |
+-----------------------------------------------------------------------+
- $Id: rcube_browser.php 328 2006-08-30 17:41:21Z thomasb $
+ $Id: rcmail.php 328 2006-08-30 17:41:21Z thomasb $
*/
@@ -37,6 +37,7 @@
public $db;
public $imap;
public $output;
+ public $plugins;
public $task = 'mail';
public $action = '';
public $comm_path = './';
@@ -47,7 +48,7 @@
/**
* This implements the 'singleton' design pattern
*
- * @return object qvert The one and only instance
+ * @return object rcmail The one and only instance
*/
static function get_instance()
{
@@ -82,9 +83,16 @@
{
$config_all = $this->config->all();
+ // initialize syslog
+ if ($this->config->get('log_driver') == 'syslog') {
+ $syslog_id = $this->config->get('syslog_id', 'roundcube');
+ $syslog_facility = $this->config->get('syslog_facility', LOG_USER);
+ openlog($syslog_id, LOG_ODELAY, $syslog_facility);
+ }
+
// set task and action properties
- $this->set_task(strip_quotes(get_input_value('_task', RCUBE_INPUT_GPC)));
- $this->action = strip_quotes(get_input_value('_action', RCUBE_INPUT_GPC));
+ $this->set_task(get_input_value('_task', RCUBE_INPUT_GPC));
+ $this->action = asciiwords(get_input_value('_action', RCUBE_INPUT_GPC));
// connect to database
$GLOBALS['DB'] = $this->get_dbh();
@@ -111,13 +119,12 @@
$_SESSION['temp'] = true;
}
-
// create user object
$this->set_user(new rcube_user($_SESSION['user_id']));
// reset some session parameters when changing task
if ($_SESSION['task'] != $this->task)
- unset($_SESSION['page']);
+ rcube_sess_unset('page');
// set current task to session
$_SESSION['task'] = $this->task;
@@ -125,6 +132,9 @@
// create IMAP object
if ($this->task == 'mail')
$this->imap_init();
+
+ // create plugin API and load plugins
+ $this->plugins = rcube_plugin_api::get_instance();
}
@@ -135,14 +145,12 @@
*/
public function set_task($task)
{
- if (!in_array($task, self::$main_tasks))
- $task = 'mail';
-
- $this->task = $task;
- $this->comm_path = './?_task=' . $task;
+ $task = asciiwords($task);
+ $this->task = $task ? $task : 'mail';
+ $this->comm_path = $this->url(array('task' => $this->task));
if ($this->output)
- $this->output->set_env('task', $task);
+ $this->output->set_env('task', $this->task);
}
@@ -161,10 +169,14 @@
$this->config->merge((array)$this->user->get_prefs());
}
- $_SESSION['language'] = $this->user->language = $this->language_prop($this->config->get('language'));
+ $_SESSION['language'] = $this->user->language = $this->language_prop($this->config->get('language', $_SESSION['language']));
// set localization
- setlocale(LC_ALL, $_SESSION['language'] . '.utf8');
+ setlocale(LC_ALL, $_SESSION['language'] . '.utf8', 'en_US.utf8');
+
+ // workaround for http://bugs.php.net/bug.php?id=18556
+ if (in_array($_SESSION['language'], array('tr_TR', 'ku', 'az_AZ')))
+ setlocale(LC_CTYPE, 'en_US' . '.utf8');
}
@@ -177,19 +189,33 @@
private function language_prop($lang)
{
static $rcube_languages, $rcube_language_aliases;
-
+
+ // user HTTP_ACCEPT_LANGUAGE if no language is specified
+ if (empty($lang) || $lang == 'auto') {
+ $accept_langs = explode(',', $_SERVER['HTTP_ACCEPT_LANGUAGE']);
+ $lang = str_replace('-', '_', $accept_langs[0]);
+ }
+
if (empty($rcube_languages)) {
@include(INSTALL_PATH . 'program/localization/index.inc');
}
-
+
// check if we have an alias for that language
if (!isset($rcube_languages[$lang]) && isset($rcube_language_aliases[$lang])) {
$lang = $rcube_language_aliases[$lang];
}
-
// try the first two chars
- if (!isset($rcube_languages[$lang]) && strlen($lang)>2) {
- $lang = $this->language_prop(substr($lang, 0, 2));
+ else if (!isset($rcube_languages[$lang])) {
+ $short = substr($lang, 0, 2);
+
+ // check if we have an alias for the short language code
+ if (!isset($rcube_languages[$short]) && isset($rcube_language_aliases[$short])) {
+ $lang = $rcube_language_aliases[$short];
+ }
+ // expand 'nn' to 'nn_NN'
+ else if (!isset($rcube_languages[$short])) {
+ $lang = $short.'_'.strtoupper($short);
+ }
}
if (!isset($rcube_languages[$lang]) || !is_dir(INSTALL_PATH . 'program/localization/' . $lang)) {
@@ -203,15 +229,14 @@
/**
* Get the current database connection
*
- * @return object rcube_db Database connection object
+ * @return object rcube_mdb2 Database connection object
*/
public function get_dbh()
{
if (!$this->db) {
- $dbclass = "rcube_" . $this->config->get('db_backend', 'mdb2');
$config_all = $this->config->all();
- $this->db = new $dbclass($config_all['db_dsnw'], $config_all['db_dsnr'], $config_all['db_persistent']);
+ $this->db = new rcube_mdb2($config_all['db_dsnw'], $config_all['db_dsnr'], $config_all['db_persistent']);
$this->db->sqlite_initials = INSTALL_PATH . 'SQL/sqlite.initial.sql';
$this->db->set_debug((bool)$config_all['sql_debug']);
$this->db->db_connect('w');
@@ -222,17 +247,70 @@
/**
+ * Return instance of the internal address book class
+ *
+ * @param boolean True if the address book needs to be writeable
+ * @return object rcube_contacts Address book object
+ */
+ public function get_address_book($id, $writeable = false)
+ {
+ $contacts = null;
+ $ldap_config = (array)$this->config->get('ldap_public');
+ $abook_type = strtolower($this->config->get('address_book_type'));
+
+ $plugin = $this->plugins->exec_hook('get_address_book', array('id' => $id, 'writeable' => $writeable));
+
+ // plugin returned instance of a rcube_addressbook
+ if ($plugin['instance'] instanceof rcube_addressbook) {
+ $contacts = $plugin['instance'];
+ }
+ else if ($id && $ldap_config[$id]) {
+ $contacts = new rcube_ldap($ldap_config[$id]);
+ }
+ else if ($id === '0') {
+ $contacts = new rcube_contacts($this->db, $this->user->ID);
+ }
+ else if ($abook_type == 'ldap') {
+ // Use the first writable LDAP address book.
+ foreach ($ldap_config as $id => $prop) {
+ if (!$writeable || $prop['writable']) {
+ $contacts = new rcube_ldap($prop);
+ break;
+ }
+ }
+ }
+ else {
+ $contacts = new rcube_contacts($this->db, $this->user->ID);
+ }
+
+ return $contacts;
+ }
+
+
+ /**
* Init output object for GUI and add common scripts.
* This will instantiate a rcmail_template object and set
* environment vars according to the current session and configuration
+ *
+ * @param boolean True if this request is loaded in a (i)frame
+ * @return object rcube_template Reference to HTML output object
*/
public function load_gui($framed = false)
{
// init output page
- $this->output = new rcube_template($this->task, $framed);
+ if (!($this->output instanceof rcube_template))
+ $this->output = new rcube_template($this->task, $framed);
- foreach (array('flag_for_deletion') as $js_config_var) {
+ foreach (array('flag_for_deletion','read_when_deleted') as $js_config_var) {
$this->output->set_env($js_config_var, $this->config->get($js_config_var));
+ }
+
+ // set keep-alive/check-recent interval
+ if ($keep_alive = $this->config->get('keep_alive')) {
+ // be sure that it's less than session lifetime
+ if ($session_lifetime = $this->config->get('session_lifetime'))
+ $keep_alive = min($keep_alive, $session_lifetime * 60 - 30);
+ $this->output->set_env('keep_alive', max(60, $keep_alive));
}
if ($framed) {
@@ -254,10 +332,13 @@
/**
* Create an output object for JSON responses
+ *
+ * @return object rcube_json_output Reference to JSON output object
*/
public function init_json()
{
- $this->output = new rcube_json_output($this->task);
+ if (!($this->output instanceof rcube_json_output))
+ $this->output = new rcube_json_output($this->task);
return $this->output;
}
@@ -282,6 +363,16 @@
// set pagesize from config
$this->imap->set_pagesize($this->config->get('pagesize', 50));
+
+ // Setting root and delimiter before iil_Connect can save time detecting them
+ // using NAMESPACE and LIST
+ $options = array(
+ 'imap' => $this->config->get('imap_auth_type', 'check'),
+ 'delimiter' => isset($_SESSION['imap_delimiter']) ? $_SESSION['imap_delimiter'] : $this->config->get('imap_delimiter'),
+ 'rootdir' => isset($_SESSION['imap_root']) ? $_SESSION['imap_root'] : $this->config->get('imap_root'),
+ );
+
+ $this->imap->set_options($options);
// set global object for backward compatibility
$GLOBALS['IMAP'] = $this->imap;
@@ -300,8 +391,8 @@
{
$conn = false;
- if ($_SESSION['imap_host']) {
- if (!($conn = $this->imap->connect($_SESSION['imap_host'], $_SESSION['username'], $this->decrypt_passwd($_SESSION['password']), $_SESSION['imap_port'], $_SESSION['imap_ssl'], rcmail::get_instance()->config->get('imap_auth_type', 'check')))) {
+ if ($_SESSION['imap_host'] && !$this->imap->conn) {
+ if (!($conn = $this->imap->connect($_SESSION['imap_host'], $_SESSION['username'], $this->decrypt_passwd($_SESSION['password']), $_SESSION['imap_port'], $_SESSION['imap_ssl']))) {
if ($this->output)
$this->output->show_message($this->imap->error_code == -1 ? 'imaperror' : 'sessionerror', 'error');
}
@@ -309,7 +400,7 @@
$this->set_imap_prop();
}
- return $conn;
+ return $conn;
}
@@ -352,11 +443,13 @@
if ($a_host['host']) {
$host = $a_host['host'];
$imap_ssl = (isset($a_host['scheme']) && in_array($a_host['scheme'], array('ssl','imaps','tls'))) ? $a_host['scheme'] : null;
- $imap_port = isset($a_host['port']) ? $a_host['port'] : ($imap_ssl ? 993 : $config['default_port']);
+ if(!empty($a_host['port']))
+ $imap_port = $a_host['port'];
+ else if ($imap_ssl && $imap_ssl != 'tls')
+ $imap_port = 993;
}
- else
- $imap_port = $config['default_port'];
-
+
+ $imap_port = $imap_port ? $imap_port : $config['default_port'];
/* Modify username with domain if required
Inspired by Marco <P0L0_notspam_binware.org>
@@ -369,20 +462,21 @@
$username .= '@'.$config['username_domain'];
}
- // try to resolve email address from virtuser table
- if (!empty($config['virtuser_file']) && strpos($username, '@'))
- $username = rcube_user::email2user($username);
+ // try to resolve email address from virtuser table
+ if (strpos($username, '@'))
+ if ($virtuser = rcube_user::email2user($username))
+ $username = $virtuser;
// lowercase username if it's an e-mail address (#1484473)
if (strpos($username, '@'))
- $username = strtolower($username);
+ $username = rc_strtolower($username);
// user already registered -> overwrite username
if ($user = rcube_user::query($username, $host))
$username = $user->data['username'];
// exit if IMAP login failed
- if (!($imap_login = $this->imap->connect($host, $username, $pass, $imap_port, $imap_ssl, $config['imap_auth_type'])))
+ if (!($imap_login = $this->imap->connect($host, $username, $pass, $imap_port, $imap_ssl)))
return false;
// user already registered -> update user's record
@@ -402,7 +496,7 @@
raise_error(array(
'code' => 600,
'type' => 'php',
- 'file' => "config/main.inc.php",
+ 'file' => RCMAIL_CONFIG_DIR."/main.inc.php",
'message' => "Acces denied for new user $username. 'auto_create_user' is disabled"
), true, false);
}
@@ -419,6 +513,9 @@
$_SESSION['imap_ssl'] = $imap_ssl;
$_SESSION['password'] = $this->encrypt_passwd($pass);
$_SESSION['login_time'] = mktime();
+
+ if ($_REQUEST['_timezone'] != '_default_')
+ $_SESSION['timezone'] = floatval($_REQUEST['_timezone']);
// force reloading complete list of subscribed mailboxes
$this->set_imap_prop();
@@ -442,10 +539,6 @@
{
$this->imap->set_charset($this->config->get('default_charset', RCMAIL_CHARSET));
- // set root dir from config
- if ($imap_root = $this->config->get('imap_root')) {
- $this->imap->set_rootdir($imap_root);
- }
if ($default_folders = $this->config->get('default_imap_folders')) {
$this->imap->set_default_mailboxes($default_folders);
}
@@ -455,6 +548,10 @@
if (isset($_SESSION['page'])) {
$this->imap->set_page($_SESSION['page']);
}
+
+ // cache IMAP root and delimiter in session for performance reasons
+ $_SESSION['imap_root'] = $this->imap->root_dir;
+ $_SESSION['imap_delimiter'] = $this->imap->delimiter;
}
@@ -466,12 +563,20 @@
public function autoselect_host()
{
$default_host = $this->config->get('default_host');
- $host = !empty($default_host) ? get_input_value('_host', RCUBE_INPUT_POST) : $default_host;
+ $host = null;
- if (is_array($host)) {
+ if (is_array($default_host)) {
+ $post_host = get_input_value('_host', RCUBE_INPUT_POST);
+
+ // direct match in default_host array
+ if ($default_host[$post_host] || in_array($post_host, array_values($default_host))) {
+ $host = $post_host;
+ }
+
+ // try to select host by mail domain
list($user, $domain) = explode('@', get_input_value('_user', RCUBE_INPUT_POST));
if (!empty($domain)) {
- foreach ($host as $imap_host => $mail_domains) {
+ foreach ($default_host as $imap_host => $mail_domains) {
if (is_array($mail_domains) && in_array($domain, $mail_domains)) {
$host = $imap_host;
break;
@@ -480,9 +585,15 @@
}
// take the first entry if $host is still an array
- if (is_array($host))
- $host = array_shift($host);
+ if (empty($host)) {
+ $host = array_shift($default_host);
+ }
}
+ else if (empty($default_host)) {
+ $host = get_input_value('_host', RCUBE_INPUT_POST);
+ }
+ else
+ $host = $default_host;
return $host;
}
@@ -494,7 +605,7 @@
* @param mixed Named parameters array or label name
* @return string Localized text
*/
- public function gettext($attrib)
+ public function gettext($attrib, $domain=null)
{
// load localization files if not done yet
if (empty($this->texts))
@@ -509,9 +620,12 @@
$command_name = !empty($attrib['command']) ? $attrib['command'] : NULL;
$alias = $attrib['name'] ? $attrib['name'] : ($command_name && $command_label_map[$command_name] ? $command_label_map[$command_name] : '');
-
+
+ // check for text with domain
+ if ($domain && ($text_item = $this->texts[$domain.'.'.$alias]))
+ ;
// text does not exist
- if (!($text_item = $this->texts[$alias])) {
+ else if (!($text_item = $this->texts[$alias])) {
/*
raise_error(array(
'code' => 500,
@@ -573,9 +687,9 @@
*
* @param string Language ID
*/
- public function load_language($lang = null)
+ public function load_language($lang = null, $add = array())
{
- $lang = $lang ? $this->language_prop($lang) : $_SESSION['language'];
+ $lang = $this->language_prop(($lang ? $lang : $_SESSION['language']));
// load localized texts
if (empty($this->texts) || $lang != $_SESSION['language']) {
@@ -603,6 +717,10 @@
$_SESSION['language'] = $lang;
}
+
+ // append additional texts (from plugin)
+ if (is_array($add) && !empty($add))
+ $this->texts += $add;
}
@@ -653,7 +771,7 @@
if (!$valid || ($_SERVER['REQUEST_METHOD']!='POST' && $now - $_SESSION['auth_time'] > 300)) {
$_SESSION['last_auth'] = $_SESSION['auth_time'];
$_SESSION['auth_time'] = $now;
- setcookie('sessauth', $this->get_auth_hash(session_id(), $now));
+ rcmail::setcookie('sessauth', $this->get_auth_hash(session_id(), $now), 0);
}
}
else {
@@ -675,15 +793,8 @@
*/
public function kill_session()
{
- $user_prefs = $this->user->get_prefs();
-
- if ((isset($_SESSION['sort_col']) && $_SESSION['sort_col'] != $user_prefs['message_sort_col']) ||
- (isset($_SESSION['sort_order']) && $_SESSION['sort_order'] != $user_prefs['message_sort_order'])) {
- $this->user->save_prefs(array('message_sort_col' => $_SESSION['sort_col'], 'message_sort_order' => $_SESSION['sort_order']));
- }
-
- $_SESSION = array('language' => $USER->language, 'auth_time' => time(), 'temp' => true);
- setcookie('sessauth', '-del-', time() - 60);
+ $_SESSION = array('language' => $this->user->language, 'auth_time' => time(), 'temp' => true);
+ rcmail::setcookie('sessauth', '-del-', time() - 60);
$this->user->reset();
}
@@ -812,6 +923,49 @@
return preg_replace('/\x00/', '', $pass);
}
+
+ /**
+ * Build a valid URL to this instance of RoundCube
+ *
+ * @param mixed Either a string with the action or url parameters as key-value pairs
+ * @return string Valid application URL
+ */
+ public function url($p)
+ {
+ if (!is_array($p))
+ $p = array('_action' => @func_get_arg(0));
+
+ $task = $p['_task'] ? $p['_task'] : ($p['task'] ? $p['task'] : $this->task);
+ $p['_task'] = $task;
+ unset($p['task']);
+
+ $url = './';
+ $delm = '?';
+ foreach (array_reverse($p) as $key => $val)
+ {
+ if (!empty($val)) {
+ $par = $key[0] == '_' ? $key : '_'.$key;
+ $url .= $delm.urlencode($par).'='.urlencode($val);
+ $delm = '&';
+ }
+ }
+ return $url;
+ }
+
+
+ /**
+ * Helper method to set a cookie with the current path and host settings
+ *
+ * @param string Cookie name
+ * @param string Cookie value
+ * @param string Expiration time
+ */
+ public static function setcookie($name, $value, $exp = 0)
+ {
+ $cookie = session_get_cookie_params();
+ setcookie($name, $value, $exp, $cookie['path'], $cookie['domain'],
+ ($_SERVER['HTTPS'] && ($_SERVER['HTTPS'] != 'off')));
+ }
}
--
Gitblit v1.9.1