From ce92ba767a9557daf7f18be94882dd7e6f4591fb Mon Sep 17 00:00:00 2001
From: alecpl <alec@alec.pl>
Date: Thu, 30 Sep 2010 09:24:33 -0400
Subject: [PATCH] - Plugin API: improved 'abort' flag handling, added 'result' item in some hooks: group_*, contact_*, identity_* (#1486914)
---
program/include/rcmail.php | 365 ++++++++++++++++++++++++++++++++++------------------
1 files changed, 239 insertions(+), 126 deletions(-)
diff --git a/program/include/rcmail.php b/program/include/rcmail.php
index c9a0658..1b11ca3 100644
--- a/program/include/rcmail.php
+++ b/program/include/rcmail.php
@@ -4,8 +4,8 @@
+-----------------------------------------------------------------------+
| program/include/rcmail.php |
| |
- | This file is part of the RoundCube Webmail client |
- | Copyright (C) 2008-2010, RoundCube Dev. - Switzerland |
+ | This file is part of the Roundcube Webmail client |
+ | Copyright (C) 2008-2010, Roundcube Dev. - Switzerland |
| Licensed under the GNU GPL |
| |
| PURPOSE: |
@@ -21,36 +21,106 @@
/**
- * Application class of RoundCube Webmail
+ * Application class of Roundcube Webmail
* implemented as singleton
*
* @package Core
*/
class rcmail
{
- static public $main_tasks = array('mail','settings','addressbook','login','logout','dummy');
-
+ /**
+ * Main tasks.
+ *
+ * @var array
+ */
+ static public $main_tasks = array('mail','settings','addressbook','login','logout','utils','dummy');
+
+ /**
+ * Singleton instace of rcmail
+ *
+ * @var rcmail
+ */
static private $instance;
-
+
+ /**
+ * Stores instance of rcube_config.
+ *
+ * @var rcube_config
+ */
public $config;
+
+ /**
+ * Stores rcube_user instance.
+ *
+ * @var rcube_user
+ */
public $user;
+
+ /**
+ * Instace of database class.
+ *
+ * @var rcube_mdb2
+ */
public $db;
+
+ /**
+ * Instace of rcube_session class.
+ *
+ * @var rcube_session
+ */
public $session;
+
+ /**
+ * Instance of rcube_smtp class.
+ *
+ * @var rcube_smtp
+ */
public $smtp;
+
+ /**
+ * Instance of rcube_imap class.
+ *
+ * @var rcube_imap
+ */
public $imap;
+
+ /**
+ * Instance of rcube_template class.
+ *
+ * @var rcube_template
+ */
public $output;
+
+ /**
+ * Instance of rcube_plugin_api.
+ *
+ * @var rcube_plugin_api
+ */
public $plugins;
+
+ /**
+ * Current task.
+ *
+ * @var string
+ */
public $task;
+
+ /**
+ * Current action.
+ *
+ * @var string
+ */
public $action = '';
public $comm_path = './';
-
+
private $texts;
-
-
+ private $books = array();
+
+
/**
* This implements the 'singleton' design pattern
*
- * @return object rcmail The one and only instance
+ * @return rcmail The one and only instance
*/
static function get_instance()
{
@@ -61,8 +131,8 @@
return self::$instance;
}
-
-
+
+
/**
* Private constructor
*/
@@ -70,11 +140,11 @@
{
// load configuration
$this->config = new rcube_config();
-
+
register_shutdown_function(array($this, 'shutdown'));
}
-
-
+
+
/**
* Initial startup function
* to register session, create database and imap connections
@@ -107,11 +177,12 @@
$this->action = asciiwords(get_input_value('_action', RCUBE_INPUT_GPC));
// reset some session parameters when changing task
- if ($_SESSION['task'] != $this->task)
- $this->session->remove('page');
-
- // set current task to session
- $_SESSION['task'] = $this->task;
+ if ($this->task != 'utils') {
+ if ($this->session && $_SESSION['task'] != $this->task)
+ $this->session->remove('page');
+ // set current task to session
+ $_SESSION['task'] = $this->task;
+ }
// init output class
if (!empty($_REQUEST['_remote']))
@@ -125,8 +196,8 @@
// init plugins
$this->plugins->init();
}
-
-
+
+
/**
* Setter for application task
*
@@ -143,38 +214,38 @@
$this->task = $task;
$this->comm_path = $this->url(array('task' => $this->task));
-
+
if ($this->output)
$this->output->set_env('task', $this->task);
}
-
-
+
+
/**
* Setter for system user object
*
- * @param object rcube_user Current user instance
+ * @param rcube_user Current user instance
*/
public function set_user($user)
{
if (is_object($user)) {
$this->user = $user;
$GLOBALS['USER'] = $this->user;
-
+
// overwrite config with user preferences
$this->config->set_user_prefs((array)$this->user->get_prefs());
}
-
+
$_SESSION['language'] = $this->user->language = $this->language_prop($this->config->get('language', $_SESSION['language']));
// set localization
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');
+ // 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');
}
-
-
+
+
/**
* Check the given string and return a valid language code
*
@@ -184,17 +255,17 @@
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];
@@ -202,7 +273,7 @@
// try the first two chars
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];
@@ -219,12 +290,12 @@
return $lang;
}
-
-
+
+
/**
* Get the current database connection
*
- * @return object rcube_mdb2 Database connection object
+ * @return rcube_mdb2 Database connection object
*/
public function get_dbh()
{
@@ -234,19 +305,18 @@
$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');
}
return $this->db;
}
-
-
+
+
/**
* 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
+ * @return rcube_contacts Address book object
*/
public function get_address_book($id, $writeable = false)
{
@@ -254,8 +324,8 @@
$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 = $this->plugins->exec_hook('addressbook_get', array('id' => $id, 'writeable' => $writeable));
+
// plugin returned instance of a rcube_addressbook
if ($plugin['instance'] instanceof rcube_addressbook) {
$contacts = $plugin['instance'];
@@ -278,7 +348,11 @@
else { // $id == 'sql'
$contacts = new rcube_contacts($this->db, $this->user->ID);
}
-
+
+ // add to the 'books' array for shutdown function
+ if (!in_array($contacts, $this->books))
+ $this->books[] = $contacts;
+
return $contacts;
}
@@ -320,7 +394,7 @@
);
}
- $plugin = $this->plugins->exec_hook('address_sources', array('sources' => $list));
+ $plugin = $this->plugins->exec_hook('addressbooks_list', array('sources' => $list));
$list = $plugin['sources'];
if ($writeable && !empty($list)) {
@@ -333,15 +407,15 @@
return $list;
}
-
-
+
+
/**
* 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
+ * @return rcube_template Reference to HTML output object
*/
public function load_gui($framed = false)
{
@@ -350,7 +424,7 @@
$this->output = new rcube_template($this->task, $framed);
// set keep-alive/check-recent interval
- if ($keep_alive = $this->session->get_keep_alive()) {
+ if ($this->session && ($keep_alive = $this->session->get_keep_alive())) {
$this->output->set_env('keep_alive', $keep_alive);
}
@@ -366,21 +440,21 @@
// add some basic label to client
$this->output->add_label('loading', 'servererror');
-
+
return $this->output;
}
-
-
+
+
/**
* Create an output object for JSON responses
*
- * @return object rcube_json_output Reference to JSON output object
+ * @return rcube_json_output Reference to JSON output object
*/
public function json_init()
{
if (!($this->output instanceof rcube_json_output))
$this->output = new rcube_json_output($this->task);
-
+
return $this->output;
}
@@ -393,12 +467,12 @@
public function smtp_init($connect = false)
{
$this->smtp = new rcube_smtp();
-
+
if ($connect)
$this->smtp->connect();
}
-
-
+
+
/**
* Create global IMAP object and connect to server
*
@@ -410,7 +484,7 @@
// 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');
@@ -422,31 +496,35 @@
// set pagesize from config
$this->imap->set_pagesize($this->config->get('pagesize', 50));
-
+
// Setting root and delimiter before establishing the connection
- // can save time detecting them using NAMESPACE and LIST
+ // can save time detecting them using NAMESPACE and LIST
$options = array(
'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'),
+ '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'),
+ 'timeout' => (int) $this->config->get('imap_timeout', 0),
);
$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'];
-
+
// 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);
+ raise_error(array(
+ 'code' => 800, 'type' => 'imap',
+ 'file' => __FILE__, 'line' => __LINE__,
+ 'message' => "rcube::imap_init(true) is deprecated, use rcube::imap_connect() instead"),
+ true, false);
}
}
@@ -460,7 +538,7 @@
{
if (!$this->imap)
$this->imap_init();
-
+
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)
@@ -481,6 +559,10 @@
*/
public function session_init()
{
+ // session started (Installer?)
+ if (session_id())
+ return;
+
$lifetime = $this->config->get('session_lifetime', 0) * 60;
// set session domain
@@ -495,7 +577,7 @@
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.use_only_cookies', 1);
ini_set('session.serialize_handler', 'php');
// use database for storing session data
@@ -522,6 +604,9 @@
*/
public function session_configure()
{
+ if (!$this->session)
+ return;
+
$lifetime = $this->config->get('session_lifetime', 0) * 60;
// set keep-alive/check-recent interval
@@ -566,7 +651,7 @@
if (!$allowed)
return false;
}
- else if (!empty($config['default_host']) && $host != $config['default_host'])
+ else if (!empty($config['default_host']) && $host != rcube_parse_host($config['default_host']))
return false;
// parse $host URL
@@ -574,33 +659,29 @@
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;
- if(!empty($a_host['port']))
+ if (!empty($a_host['port']))
$imap_port = $a_host['port'];
- else if ($imap_ssl && $imap_ssl != 'tls')
+ else if ($imap_ssl && $imap_ssl != 'tls' && (!$config['default_port'] || $config['default_port'] == 143))
$imap_port = 993;
}
-
+
$imap_port = $imap_port ? $imap_port : $config['default_port'];
- /* Modify username with domain if required
+ /* Modify username with domain if required
Inspired by Marco <P0L0_notspam_binware.org>
*/
// Check if we need to add domain
- if (!empty($config['username_domain']) && !strpos($username, '@')) {
+ if (!empty($config['username_domain']) && strpos($username, '@') === false) {
if (is_array($config['username_domain']) && isset($config['username_domain'][$host]))
- $username .= '@'.$config['username_domain'][$host];
+ $username .= '@'.rcube_parse_host($config['username_domain'][$host]);
else if (is_string($config['username_domain']))
- $username .= '@'.$config['username_domain'];
+ $username .= '@'.rcube_parse_host($config['username_domain']);
}
// 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 = mb_strtolower($username);
// user already registered -> overwrite username
if ($user = rcube_user::query($username, $host))
@@ -609,8 +690,22 @@
if (!$this->imap)
$this->imap_init();
+ // Here we need IDNA ASCII
+ // Only rcube_contacts class is using domain names in Unicode
+ $host = idn_to_ascii($host);
+ if (strpos($username, '@'))
+ $username = idn_to_ascii($username);
+
+ // try IMAP login
+ if (!($imap_login = $this->imap->connect($host, $username, $pass, $imap_port, $imap_ssl))) {
+ // lowercase username if it's an e-mail address (#1484473)
+ $username_lc = mb_strtolower($username);
+ if ($username_lc != $username && ($imap_login = $this->imap->connect($host, $username_lc, $pass, $imap_port, $imap_ssl)))
+ $username = $username_lc;
+ }
+
// exit if IMAP login failed
- if (!($imap_login = $this->imap->connect($host, $username, $pass, $imap_port, $imap_ssl)))
+ if (!$imap_login)
return false;
$this->set_imap_prop();
@@ -633,7 +728,7 @@
else {
raise_error(array(
'code' => 600, 'type' => 'php',
- 'file' => __FILE__, 'line' => __LINE__,
+ 'file' => __FILE__, 'line' => __LINE__,
'message' => "Failed to create a user record. Maybe aborted by a plugin?"
), true, false);
}
@@ -658,8 +753,8 @@
$_SESSION['imap_ssl'] = $imap_ssl;
$_SESSION['password'] = $this->encrypt($pass);
$_SESSION['login_time'] = mktime();
-
- if ($_REQUEST['_timezone'] != '_default_')
+
+ if (isset($_REQUEST['_timezone']) && $_REQUEST['_timezone'] != '_default_')
$_SESSION['timezone'] = floatval($_REQUEST['_timezone']);
// force reloading complete list of subscribed mailboxes
@@ -689,7 +784,7 @@
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;
@@ -705,15 +800,15 @@
{
$default_host = $this->config->get('default_host');
$host = null;
-
+
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)) {
@@ -734,7 +829,7 @@
$host = get_input_value('_host', RCUBE_INPUT_POST);
}
else
- $host = $default_host;
+ $host = rcube_parse_host($default_host);
return $host;
}
@@ -751,7 +846,7 @@
// load localization files if not done yet
if (empty($this->texts))
$this->load_language();
-
+
// extract attributes
if (is_string($attrib))
$attrib = array('name' => $attrib);
@@ -767,7 +862,7 @@
return "[$name]";
}
- // make text item array
+ // make text item array
$a_text_item = is_array($text_item) ? $text_item : array('single' => $text_item);
// decide which text to use
@@ -801,9 +896,9 @@
if (($attrib['uppercase'] && strtolower($attrib['uppercase']=='first')) || $attrib['ucfirst'])
return ucfirst($text);
else if ($attrib['uppercase'])
- return strtoupper($text);
+ return mb_strtoupper($text);
else if ($attrib['lowercase'])
- return strtolower($text);
+ return mb_strtolower($text);
return $text;
}
@@ -817,7 +912,7 @@
public function load_language($lang = null, $add = array())
{
$lang = $this->language_prop(($lang ? $lang : $_SESSION['language']));
-
+
// load localized texts
if (empty($this->texts) || $lang != $_SESSION['language']) {
$this->texts = array();
@@ -841,7 +936,7 @@
if (is_array($messages))
$this->texts = array_merge($this->texts, $messages);
}
-
+
$_SESSION['language'] = $lang;
}
@@ -865,7 +960,7 @@
if ($dh = @opendir(INSTALL_PATH . 'program/localization')) {
while (($name = readdir($dh)) !== false) {
- if ($name{0}=='.' || !is_dir(INSTALL_PATH . 'program/localization/' . $name))
+ if ($name[0] == '.' || !is_dir(INSTALL_PATH . 'program/localization/' . $name))
continue;
if ($label = $rcube_languages[$name])
@@ -919,8 +1014,8 @@
*/
public function kill_session()
{
- $this->plugins->exec_hook('kill_session');
-
+ $this->plugins->exec_hook('session_destroy');
+
$this->session->remove();
$_SESSION = array('language' => $this->user->language, 'auth_time' => time(), 'temp' => true);
rcmail::setcookie('sessauth', '-del-', time() - 60);
@@ -934,8 +1029,8 @@
public function logout_actions()
{
$config = $this->config->all();
-
- // on logout action we're not connected to imap server
+
+ // on logout action we're not connected to imap server
if (($config['logout_purge'] && !empty($config['trash_mbox'])) || $config['logout_expunge']) {
if (!$this->authenticate_session())
return;
@@ -965,8 +1060,9 @@
if (is_object($this->smtp))
$this->smtp->disconnect();
- if (is_object($this->contacts))
- $this->contacts->close();
+ foreach ($this->books as $book)
+ if (is_object($book))
+ $book->close();
// before closing the database connection, write session data
if ($_SERVER['REMOTE_ADDR'])
@@ -980,11 +1076,14 @@
$mem .= '/'.show_bytes(memory_get_peak_usage());
$log = $this->task . ($this->action ? '/'.$this->action : '') . ($mem ? " [$mem]" : '');
- rcube_print_time(RCMAIL_START, $log);
+ if (defined('RCMAIL_START'))
+ rcube_print_time(RCMAIL_START, $log);
+ else
+ console($log);
}
}
-
-
+
+
/**
* Generate a unique token to be used in a form request
*
@@ -993,14 +1092,14 @@
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
*
@@ -1012,8 +1111,8 @@
$token = get_input_value('_token', $mode);
return !empty($token) && $_SESSION['request_tokens'][$this->task] == $token;
}
-
-
+
+
/**
* Create unique authorization hash
*
@@ -1055,11 +1154,11 @@
* upon decryption; see http://php.net/mcrypt_generic#68082
*/
$clear = pack("a*H2", $clear, "80");
-
+
if (function_exists('mcrypt_module_open') &&
($td = mcrypt_module_open(MCRYPT_TripleDES, "", MCRYPT_MODE_CBC, "")))
{
- $iv = mcrypt_create_iv(mcrypt_enc_get_iv_size($td), MCRYPT_RAND);
+ $iv = $this->create_iv(mcrypt_enc_get_iv_size($td));
mcrypt_generic_init($td, $this->config->get_crypto_key($key), $iv);
$cipher = $iv . mcrypt_generic($td, $clear);
mcrypt_generic_deinit($td);
@@ -1070,9 +1169,7 @@
if (function_exists('des')) {
$des_iv_size = 8;
- $iv = '';
- for ($i = 0; $i < $des_iv_size; $i++)
- $iv .= sprintf("%c", mt_rand(0, 255));
+ $iv = $this->create_iv($des_iv_size);
$cipher = $iv . des($this->config->get_crypto_key($key), $clear, 1, 1, $iv);
}
else {
@@ -1100,7 +1197,7 @@
{
if (!$cipher)
return '';
-
+
$cipher = $base64 ? base64_decode($cipher) : $cipher;
if (function_exists('mcrypt_module_open') &&
@@ -1115,7 +1212,7 @@
}
else {
@include_once('lib/des.inc');
-
+
if (function_exists('des')) {
$des_iv_size = 8;
$iv = substr($cipher, 0, $des_iv_size);
@@ -1136,12 +1233,28 @@
* rcmail::encrypt() and http://php.net/mcrypt_generic#68082
*/
$clear = substr(rtrim($clear, "\0"), 0, -1);
-
+
return $clear;
}
/**
- * Build a valid URL to this instance of RoundCube
+ * Generates encryption initialization vector (IV)
+ *
+ * @param int Vector size
+ * @return string Vector string
+ */
+ private function create_iv($size)
+ {
+ // mcrypt_create_iv() can be slow when system lacks entrophy
+ // we'll generate IV vector manually
+ $iv = '';
+ for ($i = 0; $i < $size; $i++)
+ $iv .= chr(mt_rand(0, 255));
+ return $iv;
+ }
+
+ /**
+ * 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
@@ -1150,7 +1263,7 @@
{
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']);
--
Gitblit v1.9.1