From c0297f4172da47a20350d597176ecafee47c97bb Mon Sep 17 00:00:00 2001
From: thomascube <thomas@roundcube.net>
Date: Wed, 31 Mar 2010 11:23:22 -0400
Subject: [PATCH] Asynchronously expand contact groups + skip count queries in autocompletion mode + check for the existance of contactgroups table
---
program/include/rcmail.php | 376 ++++++++++++++++++++++++++++++++++++++---------------
1 files changed, 271 insertions(+), 105 deletions(-)
diff --git a/program/include/rcmail.php b/program/include/rcmail.php
index 2363715..f1e9d3f 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-2009, RoundCube Dev. - Switzerland |
+ | Copyright (C) 2008-2010, RoundCube Dev. - Switzerland |
| Licensed under the GNU GPL |
| |
| PURPOSE: |
@@ -15,7 +15,7 @@
| Author: Thomas Bruederli <roundcube@gmail.com> |
+-----------------------------------------------------------------------+
- $Id: rcmail.php 328 2006-08-30 17:41:21Z thomasb $
+ $Id$
*/
@@ -28,17 +28,19 @@
*/
class rcmail
{
- static public $main_tasks = array('mail','settings','addressbook','login','logout');
+ static public $main_tasks = array('mail','settings','addressbook','login','logout','dummy');
static private $instance;
public $config;
public $user;
public $db;
+ public $session;
+ public $smtp;
public $imap;
public $output;
public $plugins;
- public $task = 'mail';
+ public $task;
public $action = '';
public $comm_path = './';
@@ -81,8 +83,6 @@
*/
private function startup()
{
- $config_all = $this->config->all();
-
// initialize syslog
if ($this->config->get('log_driver') == 'syslog') {
$syslog_id = $this->config->get('syslog_id', 'roundcube');
@@ -90,51 +90,40 @@
openlog($syslog_id, LOG_ODELAY, $syslog_facility);
}
- // set task and action properties
- $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();
- // use database for storing session data
- include_once('include/session.inc');
-
- // set session domain
- if (!empty($config_all['session_domain'])) {
- ini_set('session.cookie_domain', $config_all['session_domain']);
- }
- // set session garbage collecting time according to session_lifetime
- if (!empty($config_all['session_lifetime'])) {
- ini_set('session.gc_maxlifetime', ($config_all['session_lifetime']) * 120);
- }
-
- // start PHP session (if not in CLI mode)
- if ($_SERVER['REMOTE_ADDR'])
- session_start();
-
- // set initial session vars
- if (!isset($_SESSION['auth_time'])) {
- $_SESSION['auth_time'] = time();
- $_SESSION['temp'] = true;
- }
+ // start session
+ $this->session_init();
// create user object
$this->set_user(new rcube_user($_SESSION['user_id']));
+ // configure session (after user config merge!)
+ $this->session_configure();
+
+ // set task and action properties
+ $this->set_task(get_input_value('_task', RCUBE_INPUT_GPC));
+ $this->action = asciiwords(get_input_value('_action', RCUBE_INPUT_GPC));
+
// reset some session parameters when changing task
if ($_SESSION['task'] != $this->task)
- rcube_sess_unset('page');
+ $this->session->remove('page');
// set current task to session
$_SESSION['task'] = $this->task;
- // create IMAP object
- if ($this->task == 'mail')
- $this->imap_init();
-
+ // init output class
+ if (!empty($_REQUEST['_remote']))
+ $GLOBALS['OUTPUT'] = $this->json_init();
+ else
+ $GLOBALS['OUTPUT'] = $this->load_gui(!empty($_REQUEST['_framed']));
+
// create plugin API and load plugins
$this->plugins = rcube_plugin_api::get_instance();
+
+ // init plugins
+ $this->plugins->init();
}
@@ -146,7 +135,13 @@
public function set_task($task)
{
$task = asciiwords($task);
- $this->task = $task ? $task : 'mail';
+
+ if ($this->user && $this->user->ID)
+ $task = !$task || $task == 'login' ? 'mail' : $task;
+ else
+ $task = 'login';
+
+ $this->task = $task;
$this->comm_path = $this->url(array('task' => $this->task));
if ($this->output)
@@ -166,7 +161,7 @@
$GLOBALS['USER'] = $this->user;
// overwrite config with user preferences
- $this->config->merge((array)$this->user->get_prefs());
+ $this->config->set_user_prefs((array)$this->user->get_prefs());
}
$_SESSION['language'] = $this->user->language = $this->language_prop($this->config->get('language', $_SESSION['language']));
@@ -249,6 +244,7 @@
/**
* Return instance of the internal address book class
*
+ * @param string Address book identifier
* @param boolean True if the address book needs to be writeable
* @return object rcube_contacts Address book object
*/
@@ -265,7 +261,7 @@
$contacts = $plugin['instance'];
}
else if ($id && $ldap_config[$id]) {
- $contacts = new rcube_ldap($ldap_config[$id]);
+ $contacts = new rcube_ldap($ldap_config[$id], $this->config->get('ldap_debug'), $this->config->mail_domain($_SESSION['imap_host']));
}
else if ($id === '0') {
$contacts = new rcube_contacts($this->db, $this->user->ID);
@@ -274,16 +270,67 @@
// Use the first writable LDAP address book.
foreach ($ldap_config as $id => $prop) {
if (!$writeable || $prop['writable']) {
- $contacts = new rcube_ldap($prop);
+ $contacts = new rcube_ldap($prop, $this->config->get('ldap_debug'), $this->config->mail_domain($_SESSION['imap_host']));
break;
}
}
}
- else {
+ else { // $id == 'sql'
$contacts = new rcube_contacts($this->db, $this->user->ID);
}
return $contacts;
+ }
+
+
+ /**
+ * Return address books list
+ *
+ * @param boolean True if the address book needs to be writeable
+ * @return array Address books array
+ */
+ public function get_address_sources($writeable = false)
+ {
+ $abook_type = strtolower($this->config->get('address_book_type'));
+ $ldap_config = (array)$this->config->get('ldap_public');
+ $autocomplete = (array)$this->config->get('autocomplete_addressbooks');
+ $list = array();
+
+ // We are using the DB address book
+ if ($abook_type != 'ldap') {
+ $contacts = new rcube_contacts($this->db, null);
+ $list['0'] = array(
+ 'id' => 0,
+ 'name' => rcube_label('personaladrbook'),
+ 'groups' => $contacts->groups,
+ 'readonly' => false,
+ 'autocomplete' => in_array('sql', $autocomplete)
+ );
+ }
+
+ if (is_array($ldap_config)) {
+ foreach ($ldap_config as $id => $prop)
+ $list[$id] = array(
+ 'id' => $id,
+ 'name' => $prop['name'],
+ 'groups' => false,
+ 'readonly' => !$prop['writable'],
+ 'autocomplete' => in_array('sql', $autocomplete)
+ );
+ }
+
+ $plugin = $this->plugins->exec_hook('address_sources', array('sources' => $list));
+ $list = $plugin['sources'];
+
+ if ($writeable && !empty($list)) {
+ foreach ($list as $idx => $item) {
+ if ($item['readonly']) {
+ unset($list[$idx]);
+ }
+ }
+ }
+
+ return $list;
}
@@ -302,11 +349,8 @@
$this->output = new rcube_template($this->task, $framed);
// 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 ($keep_alive = $this->session->get_keep_alive()) {
+ $this->output->set_env('keep_alive', $keep_alive);
}
if ($framed) {
@@ -331,12 +375,26 @@
*
* @return object rcube_json_output Reference to JSON output object
*/
- public function init_json()
+ public function json_init()
{
if (!($this->output instanceof rcube_json_output))
$this->output = new rcube_json_output($this->task);
return $this->output;
+ }
+
+
+ /**
+ * Create SMTP object and connect to server
+ *
+ * @param boolean True if connection should be established
+ */
+ public function smtp_init($connect = false)
+ {
+ $this->smtp = new rcube_smtp();
+
+ if ($connect)
+ $this->smtp->connect();
}
@@ -348,6 +406,10 @@
*/
public function imap_init($connect = false)
{
+ // already initialized
+ if (is_object($this->imap))
+ return;
+
$this->imap = new rcube_imap($this->db);
$this->imap->debug_level = $this->config->get('debug_level');
$this->imap->skip_deleted = $this->config->get('skip_deleted');
@@ -363,19 +425,28 @@
// 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'),
+ 'auth_method' => $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'),
'debug_mode' => (bool) $this->config->get('imap_debug', 0),
+ 'force_caps' => (bool) $this->config->get('imap_force_caps'),
);
$this->imap->set_options($options);
// set global object for backward compatibility
$GLOBALS['IMAP'] = $this->imap;
+
+ $hook = $this->plugins->exec_hook('imap_init', array('fetch_headers' => $this->imap->fetch_add_headers));
+ if ($hook['fetch_headers'])
+ $this->imap->fetch_add_headers = $hook['fetch_headers'];
- if ($connect)
+ // support this parameter for backward compatibility but log warning
+ if ($connect) {
$this->imap_connect();
+ raise_error(array('code' => 800, 'type' => 'imap', 'file' => __FILE__,
+ 'message' => "rcube::imap_init(true) is deprecated, use rcube::imap_connect() instead"), true, false);
+ }
}
@@ -386,18 +457,80 @@
*/
public function imap_connect()
{
- $conn = false;
+ if (!$this->imap)
+ $this->imap_init();
- if ($_SESSION['imap_host'] && !$this->imap->conn) {
- if (!($conn = $this->imap->connect($_SESSION['imap_host'], $_SESSION['username'], $this->decrypt($_SESSION['password']), $_SESSION['imap_port'], $_SESSION['imap_ssl']))) {
+ if ($_SESSION['imap_host'] && !$this->imap->conn->connected()) {
+ if (!$this->imap->connect($_SESSION['imap_host'], $_SESSION['username'], $this->decrypt($_SESSION['password']), $_SESSION['imap_port'], $_SESSION['imap_ssl'])) {
if ($this->output)
$this->output->show_message($this->imap->error_code == -1 ? 'imaperror' : 'sessionerror', 'error');
}
-
- $this->set_imap_prop();
+ else {
+ $this->set_imap_prop();
+ return $this->imap->conn;
+ }
}
- return $conn;
+ return false;
+ }
+
+
+ /**
+ * Create session object and start the session.
+ */
+ public function session_init()
+ {
+ $lifetime = $this->config->get('session_lifetime', 0) * 60;
+
+ // set session domain
+ if ($domain = $this->config->get('session_domain')) {
+ ini_set('session.cookie_domain', $domain);
+ }
+ // set session garbage collecting time according to session_lifetime
+ if ($lifetime) {
+ ini_set('session.gc_maxlifetime', $lifetime * 2);
+ }
+
+ ini_set('session.cookie_secure', rcube_https_check());
+ ini_set('session.name', 'roundcube_sessid');
+ ini_set('session.use_cookies', 1);
+ ini_set('session.use_only_cookies', 1);
+ ini_set('session.serialize_handler', 'php');
+
+ // use database for storing session data
+ $this->session = new rcube_session($this->get_dbh(), $lifetime);
+
+ $this->session->register_gc_handler('rcmail_temp_gc');
+ if ($this->config->get('enable_caching'))
+ $this->session->register_gc_handler('rcmail_cache_gc');
+
+ // start PHP session (if not in CLI mode)
+ if ($_SERVER['REMOTE_ADDR'])
+ session_start();
+
+ // set initial session vars
+ if (!isset($_SESSION['auth_time'])) {
+ $_SESSION['auth_time'] = time();
+ $_SESSION['temp'] = true;
+ }
+ }
+
+
+ /**
+ * Configure session object internals
+ */
+ public function session_configure()
+ {
+ $lifetime = $this->config->get('session_lifetime', 0) * 60;
+
+ // set keep-alive/check-recent interval
+ if ($keep_alive = $this->config->get('keep_alive')) {
+ // be sure that it's less than session lifetime
+ if ($lifetime)
+ $keep_alive = min($keep_alive, $lifetime - 30);
+ $keep_alive = max(60, $keep_alive);
+ $this->session->set_keep_alive($keep_alive);
+ }
}
@@ -466,41 +599,48 @@
// lowercase username if it's an e-mail address (#1484473)
if (strpos($username, '@'))
- $username = rc_strtolower($username);
+ $username = mb_strtolower($username);
// user already registered -> overwrite username
if ($user = rcube_user::query($username, $host))
$username = $user->data['username'];
+ if (!$this->imap)
+ $this->imap_init();
+
// exit if IMAP login failed
if (!($imap_login = $this->imap->connect($host, $username, $pass, $imap_port, $imap_ssl)))
return false;
+ $this->set_imap_prop();
+
// user already registered -> update user's record
if (is_object($user)) {
+ // create default folders on first login
+ if (!$user->data['last_login'] && $config['create_default_folders'])
+ $this->imap->create_default_folders();
$user->touch();
}
// create new system user
else if ($config['auto_create_user']) {
if ($created = rcube_user::create($username, $host)) {
$user = $created;
-
- // get existing mailboxes (but why?)
- // $a_mailboxes = $this->imap->list_mailboxes();
+ // create default folders on first login
+ if ($config['create_default_folders'])
+ $this->imap->create_default_folders();
}
else {
raise_error(array(
- 'code' => 600,
- 'type' => 'php',
+ 'code' => 600, 'type' => 'php',
+ 'file' => __FILE__, 'line' => __LINE__,
'message' => "Failed to create a user record. Maybe aborted by a plugin?"
- ), true, false);
+ ), true, false);
}
}
else {
raise_error(array(
- 'code' => 600,
- 'type' => 'php',
- 'file' => RCMAIL_CONFIG_DIR."/main.inc.php",
+ 'code' => 600, 'type' => 'php',
+ 'file' => __FILE__, 'line' => __LINE__,
'message' => "Acces denied for new user $username. 'auto_create_user' is disabled"
), true, false);
}
@@ -522,11 +662,7 @@
$_SESSION['timezone'] = floatval($_REQUEST['_timezone']);
// force reloading complete list of subscribed mailboxes
- $this->set_imap_prop();
$this->imap->clear_cache('mailboxes');
-
- if ($config['create_default_folders'])
- $this->imap->create_default_folders();
return true;
}
@@ -620,25 +756,14 @@
$attrib = array('name' => $attrib);
$nr = is_numeric($attrib['nr']) ? $attrib['nr'] : 1;
- $vars = isset($attrib['vars']) ? $attrib['vars'] : '';
+ $name = $attrib['name'] ? $attrib['name'] : '';
- $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]))
+ if ($domain && ($text_item = $this->texts[$domain.'.'.$name]))
;
// text does not exist
- else if (!($text_item = $this->texts[$alias])) {
- /*
- raise_error(array(
- 'code' => 500,
- 'type' => 'php',
- 'line' => __LINE__,
- 'file' => __FILE__,
- 'message' => "Missing localized text for '$alias' in '$sess_user_lang'"), TRUE, FALSE);
- */
- return "[$alias]";
+ else if (!($text_item = $this->texts[$name])) {
+ return "[$name]";
}
// make text item array
@@ -668,11 +793,8 @@
// replace vars in text
if (is_array($attrib['vars'])) {
foreach ($attrib['vars'] as $var_key => $var_value)
- $a_replace_vars[$var_key{0}=='$' ? substr($var_key, 1) : $var_key] = $var_value;
+ $text = str_replace($var_key[0]!='$' ? '$'.$var_key : $var_key, $var_value, $text);
}
-
- if ($a_replace_vars)
- $text = preg_replace('/\$\{?([_a-z]{1}[_a-z0-9]*)\}?/ei', '$a_replace_vars["\1"]', $text);
// format output
if (($attrib['uppercase'] && strtolower($attrib['uppercase']=='first')) || $attrib['ucfirst'])
@@ -746,7 +868,7 @@
continue;
if ($label = $rcube_languages[$name])
- $sa_languages[$name] = $label ? $label : $name;
+ $sa_languages[$name] = $label;
}
closedir($dh);
}
@@ -763,8 +885,6 @@
*/
function authenticate_session()
{
- global $SESS_CLIENT_IP, $SESS_CHANGED;
-
// advanced session authentication
if ($this->config->get('double_auth')) {
$now = time();
@@ -779,12 +899,13 @@
}
}
else {
- $valid = $this->config->get('ip_check') ? $_SERVER['REMOTE_ADDR'] == $SESS_CLIENT_IP : true;
+ $valid = $this->config->get('ip_check') ? $_SERVER['REMOTE_ADDR'] == $this->session->get_ip() : true;
}
// check session filetime
$lifetime = $this->config->get('session_lifetime');
- if (!empty($lifetime) && isset($SESS_CHANGED) && $SESS_CHANGED + $lifetime*60 < time()) {
+ $sess_ts = $this->session->get_ts();
+ if (!empty($lifetime) && !empty($sess_ts) && $sess_ts + $lifetime*60 < time()) {
$valid = false;
}
@@ -797,7 +918,9 @@
*/
public function kill_session()
{
- rcube_sess_unset();
+ $this->plugins->exec_hook('kill_session');
+
+ $this->session->remove();
$_SESSION = array('language' => $this->user->language, 'auth_time' => time(), 'temp' => true);
rcmail::setcookie('sessauth', '-del-', time() - 60);
$this->user->reset();
@@ -816,7 +939,7 @@
if (!$this->authenticate_session())
return;
- $this->imap_init(true);
+ $this->imap_connect();
}
if ($config['logout_purge'] && !empty($config['trash_mbox'])) {
@@ -835,10 +958,11 @@
*/
public function shutdown()
{
- if (is_object($this->imap)) {
+ if (is_object($this->imap))
$this->imap->close();
- $this->imap->write_cache();
- }
+
+ if (is_object($this->smtp))
+ $this->smtp->disconnect();
if (is_object($this->contacts))
$this->contacts->close();
@@ -846,6 +970,46 @@
// before closing the database connection, write session data
if ($_SERVER['REMOTE_ADDR'])
session_write_close();
+
+ // write performance stats to logs/console
+ if ($this->config->get('devel_mode')) {
+ if (function_exists('memory_get_usage'))
+ $mem = show_bytes(memory_get_usage());
+ if (function_exists('memory_get_peak_usage'))
+ $mem .= '/'.show_bytes(memory_get_peak_usage());
+
+ $log = $this->task . ($this->action ? '/'.$this->action : '') . ($mem ? " [$mem]" : '');
+ rcube_print_time(RCMAIL_START, $log);
+ }
+ }
+
+
+ /**
+ * Generate a unique token to be used in a form request
+ *
+ * @return string The request token
+ */
+ public function get_request_token()
+ {
+ $key = $this->task;
+
+ if (!$_SESSION['request_tokens'][$key])
+ $_SESSION['request_tokens'][$key] = md5(uniqid($key . mt_rand(), true));
+
+ return $_SESSION['request_tokens'][$key];
+ }
+
+
+ /**
+ * Check if the current request contains a valid token
+ *
+ * @param int Request method
+ * @return boolean True if request token is valid false if not
+ */
+ public function check_request($mode = RCUBE_INPUT_POST)
+ {
+ $token = get_input_value('_token', $mode);
+ return !empty($token) && $_SESSION['request_tokens'][$this->task] == $token;
}
@@ -911,9 +1075,8 @@
else
{
raise_error(array(
- 'code' => 500,
- 'type' => 'php',
- 'file' => __FILE__,
+ 'code' => 500, 'type' => 'php',
+ 'file' => __FILE__, 'line' => __LINE__,
'message' => "Could not perform encryption; make sure Mcrypt is installed or lib/des.inc is available"
), true, true);
}
@@ -957,9 +1120,8 @@
else
{
raise_error(array(
- 'code' => 500,
- 'type' => 'php',
- 'file' => __FILE__,
+ 'code' => 500, 'type' => 'php',
+ 'file' => __FILE__, 'line' => __LINE__,
'message' => "Could not perform decryption; make sure Mcrypt is installed or lib/des.inc is available"
), true, true);
}
@@ -1011,9 +1173,13 @@
*/
public static function setcookie($name, $value, $exp = 0)
{
+ if (headers_sent())
+ return;
+
$cookie = session_get_cookie_params();
+
setcookie($name, $value, $exp, $cookie['path'], $cookie['domain'],
- ($_SERVER['HTTPS'] && ($_SERVER['HTTPS'] != 'off')));
+ rcube_https_check(), true);
}
}
--
Gitblit v1.9.1