From 48bc52e835bd5485f7443d54399e4fb0d36732d7 Mon Sep 17 00:00:00 2001 From: alecpl <alec@alec.pl> Date: Sat, 13 Feb 2010 12:33:25 -0500 Subject: [PATCH] - Fix imap_init hook broken in r3258 (#1486493) --- program/include/rcmail.php | 411 +++++++++++++++++++++++++++++++++++++++++---------------- 1 files changed, 293 insertions(+), 118 deletions(-) diff --git a/program/include/rcmail.php b/program/include/rcmail.php index 589adf5..68ab500 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: rcmail.php 328 2006-08-30 17:41:21Z thomasb $ + $Id$ */ @@ -28,16 +28,18 @@ */ 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 $smtp; public $imap; public $output; - public $task = 'mail'; + public $plugins; + public $task; public $action = ''; public $comm_path = './'; @@ -47,7 +49,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() { @@ -88,10 +90,6 @@ $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 = asciiwords(get_input_value('_action', RCUBE_INPUT_GPC)); // connect to database $GLOBALS['DB'] = $this->get_dbh(); @@ -121,16 +119,28 @@ // create user object $this->set_user(new rcube_user($_SESSION['user_id'])); + // 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) - unset($_SESSION['page']); + rcube_sess_unset('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->init_json(); + 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(); } @@ -141,14 +151,18 @@ */ public function set_task($task) { - if (!in_array($task, self::$main_tasks)) - $task = 'mail'; - + $task = asciiwords($task); + + 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' => $task)); + $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); } @@ -170,7 +184,11 @@ $_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'); } @@ -223,7 +241,7 @@ /** * Get the current database connection * - * @return object rcube_db Database connection object + * @return object rcube_mdb2 Database connection object */ public function get_dbh() { @@ -251,15 +269,24 @@ $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)); - if ($id && $ldap_config[$id]) { - $contacts = new rcube_ldap($ldap_config[$id]); + // 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], $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); } 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); + $contacts = new rcube_ldap($prop, $this->config->get('ldap_debug'), $this->config->mail_domain($_SESSION['imap_host'])); break; } } @@ -286,8 +313,12 @@ if (!($this->output instanceof rcube_template)) $this->output = new rcube_template($this->task, $framed); - 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) { @@ -298,10 +329,10 @@ $this->output->set_env('task', $this->task); $this->output->set_env('action', $this->action); $this->output->set_env('comm_path', $this->comm_path); - $this->output->set_charset($this->config->get('charset', RCMAIL_CHARSET)); + $this->output->set_charset(RCMAIL_CHARSET); // add some basic label to client - $this->output->add_label('loading'); + $this->output->add_label('loading', 'servererror'); return $this->output; } @@ -319,6 +350,20 @@ 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(); + } /** @@ -332,6 +377,7 @@ $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'); + $this->imap->index_sort = $this->config->get('index_sort', true); // enable caching of imap data if ($this->config->get('enable_caching')) { @@ -340,10 +386,25 @@ // 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( + '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), + ); + + $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) $this->imap_connect(); } @@ -357,9 +418,12 @@ 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_passwd($_SESSION['password']), $_SESSION['imap_port'], $_SESSION['imap_ssl'], rcmail::get_instance()->config->get('imap_auth_type', 'check')))) { + if (!($conn = $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'); } @@ -410,11 +474,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> @@ -427,40 +493,55 @@ $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 = 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, $config['imap_auth_type']))) + 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', + 'file' => __FILE__, 'line' => __LINE__, + 'message' => "Failed to create a user record. Maybe aborted by a plugin?" + ), true, false); } } else { raise_error(array( - 'code' => 600, - 'type' => 'php', - 'file' => "config/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); } @@ -475,18 +556,14 @@ $_SESSION['imap_host'] = $host; $_SESSION['imap_port'] = $imap_port; $_SESSION['imap_ssl'] = $imap_ssl; - $_SESSION['password'] = $this->encrypt_passwd($pass); + $_SESSION['password'] = $this->encrypt($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(); $this->imap->clear_cache('mailboxes'); - - if ($config['create_default_folders']) - $this->imap->create_default_folders(); return true; } @@ -503,10 +580,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); } @@ -516,6 +589,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; } @@ -569,7 +646,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)) @@ -580,22 +657,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.'.'.$name])) + ; // text does not exist - 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 @@ -625,11 +694,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']) @@ -648,7 +714,7 @@ * * @param string Language ID */ - public function load_language($lang = null) + public function load_language($lang = null, $add = array()) { $lang = $this->language_prop(($lang ? $lang : $_SESSION['language'])); @@ -678,6 +744,10 @@ $_SESSION['language'] = $lang; } + + // append additional texts (from plugin) + if (is_array($add) && !empty($add)) + $this->texts += $add; } @@ -699,7 +769,7 @@ continue; if ($label = $rcube_languages[$name]) - $sa_languages[$name] = $label ? $label : $name; + $sa_languages[$name] = $label; } closedir($dh); } @@ -728,8 +798,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), '/', - $_SERVER['HTTPS'] && ($_SERVER['HTTPS']!='off')); + rcmail::setcookie('sessauth', $this->get_auth_hash(session_id(), $now), 0); } } else { @@ -751,8 +820,11 @@ */ public function kill_session() { + $this->plugins->exec_hook('kill_session'); + + rcube_sess_unset(); $_SESSION = array('language' => $this->user->language, 'auth_time' => time(), 'temp' => true); - setcookie('sessauth', '-del-', time() - 60); + rcmail::setcookie('sessauth', '-del-', time() - 60); $this->user->reset(); } @@ -793,12 +865,55 @@ $this->imap->write_cache(); } + if (is_object($this->smtp)) + $this->smtp->disconnect(); + if (is_object($this->contacts)) $this->contacts->close(); // 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; } @@ -823,64 +938,106 @@ return md5($auth_string); } + /** - * Encrypt IMAP password using DES encryption + * Encrypt using 3DES * - * @param string Password to encrypt - * @return string Encryprted string + * @param string $clear clear text input + * @param string $key encryption key to retrieve from the configuration, defaults to 'des_key' + * @param boolean $base64 whether or not to base64_encode() the result before returning + * + * @return string encrypted text */ - public function encrypt_passwd($pass) + public function encrypt($clear, $key = 'des_key', $base64 = true) { - if (function_exists('mcrypt_module_open') && ($td = mcrypt_module_open(MCRYPT_TripleDES, "", MCRYPT_MODE_ECB, ""))) { + if (!$clear) + return ''; + /*- + * Add a single canary byte to the end of the clear text, which + * will help find out how much of padding will need to be removed + * 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); - mcrypt_generic_init($td, $this->config->get_des_key(), $iv); - $cypher = mcrypt_generic($td, $pass); + mcrypt_generic_init($td, $this->config->get_crypto_key($key), $iv); + $cipher = $iv . mcrypt_generic($td, $clear); mcrypt_generic_deinit($td); mcrypt_module_close($td); } - else if (function_exists('des')) { - $cypher = des($this->config->get_des_key(), $pass, 1, 0, NULL); + else if (function_exists('des')) + { + define('DES_IV_SIZE', 8); + $iv = ''; + for ($i = 0; $i < constant('DES_IV_SIZE'); $i++) + $iv .= sprintf("%c", mt_rand(0, 255)); + $cipher = $iv . des($this->config->get_crypto_key($key), $clear, 1, 1, $iv); } - else { - $cypher = $pass; - + else + { raise_error(array( - 'code' => 500, - 'type' => 'php', - 'file' => __FILE__, - 'message' => "Could not convert encrypt password. Make sure Mcrypt is installed or lib/des.inc is available" - ), true, false); + '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); } - - return base64_encode($cypher); + + return $base64 ? base64_encode($cipher) : $cipher; } - /** - * Decrypt IMAP password using DES encryption + * Decrypt 3DES-encrypted string * - * @param string Encrypted password - * @return string Plain password + * @param string $cipher encrypted text + * @param string $key encryption key to retrieve from the configuration, defaults to 'des_key' + * @param boolean $base64 whether or not input is base64-encoded + * + * @return string decrypted text */ - public function decrypt_passwd($cypher) + public function decrypt($cipher, $key = 'des_key', $base64 = true) { - if (function_exists('mcrypt_module_open') && ($td = mcrypt_module_open(MCRYPT_TripleDES, "", MCRYPT_MODE_ECB, ""))) { - $iv = mcrypt_create_iv(mcrypt_enc_get_iv_size($td), MCRYPT_RAND); - mcrypt_generic_init($td, $this->config->get_des_key(), $iv); - $pass = mdecrypt_generic($td, base64_decode($cypher)); + if (!$cipher) + return ''; + + $cipher = $base64 ? base64_decode($cipher) : $cipher; + + if (function_exists('mcrypt_module_open') && + ($td = mcrypt_module_open(MCRYPT_TripleDES, "", MCRYPT_MODE_CBC, ""))) + { + $iv = substr($cipher, 0, mcrypt_enc_get_iv_size($td)); + $cipher = substr($cipher, mcrypt_enc_get_iv_size($td)); + mcrypt_generic_init($td, $this->config->get_crypto_key($key), $iv); + $clear = mdecrypt_generic($td, $cipher); mcrypt_generic_deinit($td); mcrypt_module_close($td); } - else if (function_exists('des')) { - $pass = des($this->config->get_des_key(), base64_decode($cypher), 0, 0, NULL); + else if (function_exists('des')) + { + define('DES_IV_SIZE', 8); + $iv = substr($cipher, 0, constant('DES_IV_SIZE')); + $cipher = substr($cipher, constant('DES_IV_SIZE')); + $clear = des($this->config->get_crypto_key($key), $cipher, 0, 1, $iv); } - else { - $pass = base64_decode($cypher); + else + { + raise_error(array( + '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); } - - return preg_replace('/\x00/', '', $pass); + + /*- + * Trim PHP's padding and the canary byte; see note in + * 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 @@ -892,24 +1049,42 @@ { if (!is_array($p)) $p = array('_action' => @func_get_arg(0)); - - if (!$p['task'] || !in_array($p['task'], rcmail::$main_tasks)) - $p['task'] = $this->task; - - $p['_task'] = $p['task']; + + $task = $p['_task'] ? $p['_task'] : ($p['task'] ? $p['task'] : $this->task); + $p['_task'] = $task; unset($p['task']); $url = './'; $delm = '?'; - foreach (array_reverse($p) as $par => $val) + 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) + { + if (headers_sent()) + return; + + $cookie = session_get_cookie_params(); + + setcookie($name, $value, $exp, $cookie['path'], $cookie['domain'], + rcube_https_check(), true); + } } -- Gitblit v1.9.1