From ab0b51a1fef87bcc643c3aaf2e635c811b28ccd8 Mon Sep 17 00:00:00 2001
From: alecpl <alec@alec.pl>
Date: Tue, 15 Feb 2011 06:10:59 -0500
Subject: [PATCH] - Use only one from IMAP authentication methods to prevent login delays (1487784)
---
program/include/rcube_imap.php | 852 +++++++++++++++++++++++++++++++++++++++-----------------
1 files changed, 587 insertions(+), 265 deletions(-)
diff --git a/program/include/rcube_imap.php b/program/include/rcube_imap.php
index d085542..f5a9368 100644
--- a/program/include/rcube_imap.php
+++ b/program/include/rcube_imap.php
@@ -5,7 +5,7 @@
| program/include/rcube_imap.php |
| |
| This file is part of the Roundcube Webmail client |
- | Copyright (C) 2005-2010, Roundcube Dev. - Switzerland |
+ | Copyright (C) 2005-2010, The Roundcube Dev Team |
| Licensed under the GNU GPL |
| |
| PURPOSE: |
@@ -33,10 +33,8 @@
{
public $debug_level = 1;
public $skip_deleted = false;
- public $root_dir = '';
public $page_size = 10;
public $list_page = 1;
- public $delimiter = NULL;
public $threading = false;
public $fetch_add_headers = '';
public $get_all_headers = false;
@@ -54,8 +52,9 @@
* @var rcube_mdb2
*/
private $db;
- private $root_ns = '';
private $mailbox = 'INBOX';
+ private $delimiter = NULL;
+ private $namespace = NULL;
private $sort_field = '';
private $sort_order = 'DESC';
private $caching_enabled = false;
@@ -101,6 +100,16 @@
'RETURN-PATH',
);
+ const UNKNOWN = 0;
+ const NOPERM = 1;
+ const READONLY = 2;
+ const TRYCREATE = 3;
+ const INUSE = 4;
+ const OVERQUOTA = 5;
+ const ALREADYEXISTS = 6;
+ const NONEXISTENT = 7;
+ const CONTACTADMIN = 8;
+
/**
* Object constructor
@@ -113,7 +122,7 @@
$this->conn = new rcube_imap_generic();
}
-
+
/**
* Connect to an IMAP server
*
@@ -139,6 +148,18 @@
$this->options['port'] = $port;
+ if ($this->options['debug']) {
+ $this->conn->setDebug(true, array($this, 'debug_handler'));
+
+ $this->options['ident'] = array(
+ 'name' => 'Roundcube Webmail',
+ 'version' => RCMAIL_VERSION,
+ 'php' => PHP_VERSION,
+ 'os' => PHP_OS,
+ 'command' => $_SERVER['REQUEST_URI'],
+ );
+ }
+
$attempt = 0;
do {
$data = rcmail::get_instance()->plugins->exec_hook('imap_connect',
@@ -156,33 +177,27 @@
$this->port = $port;
$this->ssl = $use_ssl;
- // print trace messages
if ($this->conn->connected()) {
- if ($this->conn->message && ($this->debug_level & 8)) {
- console($this->conn->message);
- }
-
- // get server properties
- $rootdir = $this->conn->getRootDir();
- if (!empty($rootdir))
- $this->set_rootdir($rootdir);
- if (empty($this->delimiter))
- $this->get_hierarchy_delimiter();
-
+ // get namespace and delimiter
+ $this->set_env();
return true;
}
// write error log
else if ($this->conn->error) {
- if ($pass && $user)
+ if ($pass && $user) {
+ $message = sprintf("Login failed for %s from %s. %s",
+ $user, rcmail_remote_ip(), $this->conn->error);
+
raise_error(array('code' => 403, 'type' => 'imap',
'file' => __FILE__, 'line' => __LINE__,
- 'message' => $this->conn->error), true, false);
+ 'message' => $message), true, false);
+ }
}
return false;
}
-
+
/**
* Close IMAP connection
* Usually done on script shutdown
@@ -191,11 +206,11 @@
*/
function close()
{
- $this->conn->close();
+ $this->conn->closeConnection();
$this->write_cache();
}
-
+
/**
* Close IMAP connection and re-connect
* This is used to avoid some strange socket errors when talking to Courier IMAP
@@ -204,11 +219,11 @@
*/
function reconnect()
{
- $this->close();
- $this->connect($this->host, $this->user, $this->pass, $this->port, $this->ssl);
+ $this->conn->closeConnection();
+ $connected = $this->connect($this->host, $this->user, $this->pass, $this->port, $this->ssl);
// issue SELECT command to restore connection status
- if ($this->mailbox)
+ if ($connected && strlen($this->mailbox))
$this->conn->select($this->mailbox);
}
@@ -220,7 +235,7 @@
*/
function get_error_code()
{
- return ($this->conn) ? $this->conn->errornum : 0;
+ return $this->conn->errornum;
}
@@ -231,9 +246,50 @@
*/
function get_error_str()
{
- return ($this->conn) ? $this->conn->error : '';
+ return $this->conn->error;
}
-
+
+
+ /**
+ * Returns code of last command response
+ *
+ * @return int Response code
+ */
+ function get_response_code()
+ {
+ switch ($this->conn->resultcode) {
+ case 'NOPERM':
+ return self::NOPERM;
+ case 'READ-ONLY':
+ return self::READONLY;
+ case 'TRYCREATE':
+ return self::TRYCREATE;
+ case 'INUSE':
+ return self::INUSE;
+ case 'OVERQUOTA':
+ return self::OVERQUOTA;
+ case 'ALREADYEXISTS':
+ return self::ALREADYEXISTS;
+ case 'NONEXISTENT':
+ return self::NONEXISTENT;
+ case 'CONTACTADMIN':
+ return self::CONTACTADMIN;
+ default:
+ return self::UNKNOWN;
+ }
+ }
+
+
+ /**
+ * Returns last command response
+ *
+ * @return string Response
+ */
+ function get_response_str()
+ {
+ return $this->conn->result;
+ }
+
/**
* Set options to be used in rcube_imap_generic::connect()
@@ -245,29 +301,7 @@
$this->options = array_merge($this->options, (array)$opt);
}
-
- /**
- * Set a root folder for the IMAP connection.
- *
- * Only folders within this root folder will be displayed
- * and all folder paths will be translated using this folder name
- *
- * @param string $root Root folder
- * @access public
- */
- function set_rootdir($root)
- {
- if (preg_match('/[.\/]$/', $root)) //(substr($root, -1, 1)==='/')
- $root = substr($root, 0, -1);
- $this->root_dir = $root;
- $this->options['rootdir'] = $root;
-
- if (empty($this->delimiter))
- $this->get_hierarchy_delimiter();
- }
-
-
/**
* Set default message charset
*
@@ -281,7 +315,7 @@
$this->default_charset = $cs;
}
-
+
/**
* This list of folders will be listed above all other folders
*
@@ -299,7 +333,7 @@
}
}
-
+
/**
* Set internal mailbox reference.
*
@@ -321,7 +355,27 @@
$this->_clear_messagecount($mailbox);
}
-
+
+ /**
+ * Forces selection of a mailbox
+ *
+ * @param string $mailbox Mailbox/Folder name
+ * @access public
+ */
+ function select_mailbox($mailbox=null)
+ {
+ $mailbox = strlen($mailbox) ? $this->mod_mailbox($mailbox) : $this->mailbox;
+
+ $selected = $this->conn->select($mailbox);
+
+ if ($selected && $this->mailbox != $mailbox) {
+ // clear messagecount cache for this mailbox
+ $this->_clear_messagecount($mailbox);
+ $this->mailbox = $mailbox;
+ }
+ }
+
+
/**
* Set internal list page
*
@@ -333,7 +387,7 @@
$this->list_page = (int)$page;
}
-
+
/**
* Set internal page size
*
@@ -345,7 +399,7 @@
$this->page_size = (int)$size;
}
-
+
/**
* Save a set of message ids for future message listing methods
*
@@ -372,7 +426,7 @@
$this->search_sorted = $sorted;
}
-
+
/**
* Return the saved search set as hash array
* @return array Search set
@@ -388,7 +442,7 @@
);
}
-
+
/**
* Returns the currently used mailbox name
*
@@ -400,7 +454,7 @@
return $this->conn->connected() ? $this->mod_mailbox($this->mailbox, 'out') : '';
}
-
+
/**
* Returns the IMAP server's capability
*
@@ -413,7 +467,7 @@
return $this->conn->getCapability(strtoupper($cap));
}
-
+
/**
* Sets threading flag to the best supported THREAD algorithm
*
@@ -425,19 +479,19 @@
{
$this->threading = false;
- if ($enable) {
- if ($this->get_capability('THREAD=REFS'))
+ if ($enable && ($caps = $this->get_capability('THREAD'))) {
+ if (in_array('REFS', $caps))
$this->threading = 'REFS';
- else if ($this->get_capability('THREAD=REFERENCES'))
+ else if (in_array('REFERENCES', $caps))
$this->threading = 'REFERENCES';
- else if ($this->get_capability('THREAD=ORDEREDSUBJECT'))
+ else if (in_array('ORDEREDSUBJECT', $caps))
$this->threading = 'ORDEREDSUBJECT';
}
return $this->threading;
}
-
+
/**
* Checks the PERMANENTFLAGS capability of the current mailbox
* and returns true if the given flag is supported by the IMAP server
@@ -453,7 +507,7 @@
return (in_array_nocase($imap_flag, $this->conn->data['PERMANENTFLAGS']));
}
-
+
/**
* Returns the delimiter that is used by the IMAP server for folder separation
*
@@ -462,16 +516,104 @@
*/
function get_hierarchy_delimiter()
{
- if ($this->conn && empty($this->delimiter))
- $this->delimiter = $this->conn->getHierarchyDelimiter();
-
- if (empty($this->delimiter))
- $this->delimiter = '/';
-
return $this->delimiter;
}
-
+
+ /**
+ * Get namespace
+ *
+ * @return array Namespace data
+ * @access public
+ */
+ function get_namespace()
+ {
+ return $this->namespace;
+ }
+
+
+ /**
+ * Sets delimiter and namespaces
+ *
+ * @access private
+ */
+ private function set_env()
+ {
+ if ($this->delimiter !== null && $this->namespace !== null) {
+ return;
+ }
+
+ if (isset($_SESSION['imap_namespace']) && isset($_SESSION['imap_delimiter'])) {
+ $this->namespace = $_SESSION['imap_namespace'];
+ $this->delimiter = $_SESSION['imap_delimiter'];
+ return;
+ }
+
+ $config = rcmail::get_instance()->config;
+ $imap_personal = $config->get('imap_ns_personal');
+ $imap_other = $config->get('imap_ns_other');
+ $imap_shared = $config->get('imap_ns_shared');
+ $imap_delimiter = $config->get('imap_delimiter');
+
+ if (!$this->conn->connected())
+ return;
+
+ $ns = $this->conn->getNamespace();
+
+ // Set namespaces (NAMESPACE supported)
+ if (is_array($ns)) {
+ $this->namespace = $ns;
+ }
+ else {
+ $this->namespace = array(
+ 'personal' => NULL,
+ 'other' => NULL,
+ 'shared' => NULL,
+ );
+ }
+
+ if ($imap_delimiter) {
+ $this->delimiter = $imap_delimiter;
+ }
+ if (empty($this->delimiter)) {
+ $this->delimiter = $this->namespace['personal'][0][1];
+ }
+ if (empty($this->delimiter)) {
+ $this->delimiter = $this->conn->getHierarchyDelimiter();
+ }
+ if (empty($this->delimiter)) {
+ $this->delimiter = '/';
+ }
+
+ // Overwrite namespaces
+ if ($imap_personal !== null) {
+ $this->namespace['personal'] = NULL;
+ foreach ((array)$imap_personal as $dir) {
+ $this->namespace['personal'][] = array($dir, $this->delimiter);
+ }
+ }
+ if ($imap_other !== null) {
+ $this->namespace['other'] = NULL;
+ foreach ((array)$imap_other as $dir) {
+ if ($dir) {
+ $this->namespace['other'][] = array($dir, $this->delimiter);
+ }
+ }
+ }
+ if ($imap_shared !== null) {
+ $this->namespace['shared'] = NULL;
+ foreach ((array)$imap_shared as $dir) {
+ if ($dir) {
+ $this->namespace['shared'][] = array($dir, $this->delimiter);
+ }
+ }
+ }
+
+ $_SESSION['imap_namespace'] = $this->namespace;
+ $_SESSION['imap_delimiter'] = $this->delimiter;
+ }
+
+
/**
* Get message count for a specific mailbox
*
@@ -485,11 +627,11 @@
*/
function messagecount($mbox_name='', $mode='ALL', $force=false, $status=true)
{
- $mailbox = $mbox_name ? $this->mod_mailbox($mbox_name) : $this->mailbox;
+ $mailbox = strlen($mbox_name) ? $this->mod_mailbox($mbox_name) : $this->mailbox;
return $this->_messagecount($mailbox, $mode, $force, $status);
}
-
+
/**
* Private method for getting nr of messages
*
@@ -506,7 +648,7 @@
{
$mode = strtoupper($mode);
- if (empty($mailbox))
+ if (!strlen($mailbox))
$mailbox = $this->mailbox;
// count search set
@@ -527,15 +669,17 @@
$a_mailbox_cache[$mailbox] = array();
if ($mode == 'THREADS') {
- $count = $this->_threadcount($mailbox, $msg_count);
+ $res = $this->_threadcount($mailbox, $msg_count);
+ $count = $res['count'];
+
if ($status) {
- $this->set_folder_stats($mailbox, 'cnt', $msg_count);
- $this->set_folder_stats($mailbox, 'maxuid', $msg_count ? $this->_id2uid($msg_count, $mailbox) : 0);
+ $this->set_folder_stats($mailbox, 'cnt', $res['msgcount']);
+ $this->set_folder_stats($mailbox, 'maxuid', $res['maxuid'] ? $this->_id2uid($res['maxuid'], $mailbox) : 0);
}
}
// RECENT count is fetched a bit different
else if ($mode == 'RECENT') {
- $count = $this->conn->checkForRecent($mailbox);
+ $count = $this->conn->countRecent($mailbox);
}
// use SEARCH for message counting
else if ($this->skip_deleted) {
@@ -546,9 +690,14 @@
if ($mode == 'UNSEEN') {
$search_str .= " UNSEEN";
}
- else if ($status) {
- $keys[] = 'MAX';
- $need_uid = true;
+ else {
+ if ($this->caching_enabled) {
+ $keys[] = 'ALL';
+ }
+ if ($status) {
+ $keys[] = 'MAX';
+ $need_uid = true;
+ }
}
// get message count using (E)SEARCH
@@ -557,9 +706,15 @@
$count = is_array($index) ? $index['COUNT'] : 0;
- if ($mode == 'ALL' && $status) {
- $this->set_folder_stats($mailbox, 'cnt', $count);
- $this->set_folder_stats($mailbox, 'maxuid', is_array($index) ? $index['MAX'] : 0);
+ if ($mode == 'ALL') {
+ if ($need_uid && $this->caching_enabled) {
+ // Save messages index for check_cache_status()
+ $this->icache['all_undeleted_idx'] = $index['ALL'];
+ }
+ if ($status) {
+ $this->set_folder_stats($mailbox, 'cnt', $count);
+ $this->set_folder_stats($mailbox, 'maxuid', is_array($index) ? $index['MAX'] : 0);
+ }
}
}
else {
@@ -587,25 +742,33 @@
* Private method for getting nr of threads
*
* @param string $mailbox Folder name
- * @param int $msg_count Number of messages in the folder
+ *
+ * @returns array Array containing items: 'count' - threads count,
+ * 'msgcount' = messages count, 'maxuid' = max. UID in the set
* @access private
- * @see rcube_imap::messagecount()
*/
- private function _threadcount($mailbox, &$msg_count)
+ private function _threadcount($mailbox)
{
+ $result = array();
+
if (!empty($this->icache['threads'])) {
- $msg_count = count($this->icache['threads']['depth']);
- return count($this->icache['threads']['tree']);
+ $dcount = count($this->icache['threads']['depth']);
+ $result = array(
+ 'count' => count($this->icache['threads']['tree']),
+ 'msgcount' => $dcount,
+ 'maxuid' => $dcount ? max(array_keys($this->icache['threads']['depth'])) : 0,
+ );
+ }
+ else if (is_array($result = $this->_fetch_threads($mailbox))) {
+ $dcount = count($result[1]);
+ $result = array(
+ 'count' => count($result[0]),
+ 'msgcount' => $dcount,
+ 'maxuid' => $dcount ? max(array_keys($result[1])) : 0,
+ );
}
- if (is_array($result = $this->_fetch_threads($mailbox))) {
- $thread_tree = array_shift($result);
- $msg_count = count($result[0]);
- }
-
-// list ($thread_tree, $msg_depth, $has_children) = $result;
-// $this->update_thread_cache($mailbox, $thread_tree, $msg_depth, $has_children);
- return count($thread_tree);
+ return $result;
}
@@ -623,7 +786,7 @@
*/
function list_headers($mbox_name='', $page=NULL, $sort_field=NULL, $sort_order=NULL, $slice=0)
{
- $mailbox = $mbox_name ? $this->mod_mailbox($mbox_name) : $this->mailbox;
+ $mailbox = strlen($mbox_name) ? $this->mod_mailbox($mbox_name) : $this->mailbox;
return $this->_list_headers($mailbox, $page, $sort_field, $sort_order, false, $slice);
}
@@ -803,14 +966,14 @@
{
if (empty($this->icache['threads'])) {
// get all threads
- list ($thread_tree, $msg_depth, $has_children) = $this->conn->thread(
- $mailbox, $this->threading, $this->skip_deleted ? 'UNDELETED' : '');
+ $result = $this->conn->thread($mailbox, $this->threading,
+ $this->skip_deleted ? 'UNDELETED' : '');
// add to internal (fast) cache
$this->icache['threads'] = array();
- $this->icache['threads']['tree'] = $thread_tree;
- $this->icache['threads']['depth'] = $msg_depth;
- $this->icache['threads']['has_children'] = $has_children;
+ $this->icache['threads']['tree'] = is_array($result) ? $result[0] : array();
+ $this->icache['threads']['depth'] = is_array($result) ? $result[1] : array();
+ $this->icache['threads']['has_children'] = is_array($result) ? $result[2] : array();
}
return array(
@@ -850,7 +1013,7 @@
// flatten threads array
// @TODO: fetch children only in expanded mode (?)
$all_ids = array();
- foreach($msg_index as $root) {
+ foreach ($msg_index as $root) {
$all_ids[] = $root;
if (!empty($thread_tree[$root]))
$all_ids = array_merge($all_ids, array_keys_recursive($thread_tree[$root]));
@@ -1188,7 +1351,7 @@
*/
function mailbox_status($mbox_name = null)
{
- $mailbox = $mbox_name ? $this->mod_mailbox($mbox_name) : $this->mailbox;
+ $mailbox = strlen($mbox_name) ? $this->mod_mailbox($mbox_name) : $this->mailbox;
$old = $this->get_folder_stats($mailbox);
// refresh message count -> will update
@@ -1255,7 +1418,7 @@
$this->_set_sort_order($sort_field, $sort_order);
- $mailbox = $mbox_name ? $this->mod_mailbox($mbox_name) : $this->mailbox;
+ $mailbox = strlen($mbox_name) ? $this->mod_mailbox($mbox_name) : $this->mailbox;
$key = "{$mailbox}:{$this->sort_field}:{$this->sort_order}:{$this->search_string}.msgi";
// we have a saved search result, get index from there
@@ -1365,7 +1528,7 @@
{
$this->_set_sort_order($sort_field, $sort_order);
- $mailbox = $mbox_name ? $this->mod_mailbox($mbox_name) : $this->mailbox;
+ $mailbox = strlen($mbox_name) ? $this->mod_mailbox($mbox_name) : $this->mailbox;
$key = "{$mailbox}:{$this->sort_field}:{$this->sort_order}:{$this->search_string}.thi";
// we have a saved search result, get index from there
@@ -1422,7 +1585,7 @@
// flatten threads array
$all_ids = array();
- foreach($msg_index as $root) {
+ foreach ($msg_index as $root) {
$all_ids[] = $root;
if (!empty($thread_tree[$root])) {
foreach (array_keys_recursive($thread_tree[$root]) as $val)
@@ -1542,7 +1705,7 @@
if (!$str)
return false;
- $mailbox = $mbox_name ? $this->mod_mailbox($mbox_name) : $this->mailbox;
+ $mailbox = strlen($mbox_name) ? $this->mod_mailbox($mbox_name) : $this->mailbox;
$results = $this->_search_index($mailbox, $str, $charset, $sort_field);
@@ -1591,7 +1754,7 @@
return $a_messages;
}
-
+
if ($sort_field && $this->get_capability('SORT')) {
$charset = $charset ? $charset : $this->default_charset;
$a_messages = $this->conn->sort($mailbox, $sort_field, $criteria, false, $charset);
@@ -1647,7 +1810,7 @@
if (!$str)
return false;
- $mailbox = $mbox_name ? $this->mod_mailbox($mbox_name) : $this->mailbox;
+ $mailbox = strlen($mbox_name) ? $this->mod_mailbox($mbox_name) : $this->mailbox;
return $this->conn->search($mailbox, $str, $ret_uid);
}
@@ -1824,7 +1987,7 @@
*/
function get_headers($id, $mbox_name=NULL, $is_uid=true, $bodystr=false)
{
- $mailbox = $mbox_name ? $this->mod_mailbox($mbox_name) : $this->mailbox;
+ $mailbox = strlen($mbox_name) ? $this->mod_mailbox($mbox_name) : $this->mailbox;
$uid = $is_uid ? $id : $this->_id2uid($id, $mailbox);
// get cached headers
@@ -1899,7 +2062,7 @@
return false;
}
- $struct = &$this->_structure_part($structure);
+ $struct = &$this->_structure_part($structure, 0, '', $headers);
$struct->headers = get_object_vars($headers);
// don't trust given content-type
@@ -2031,6 +2194,11 @@
$struct->charset = $struct->ctype_parameters['charset'];
}
+ // #1487700: workaround for lack of charset in malformed structure
+ if (empty($struct->charset) && !empty($mime_headers) && $mime_headers->charset) {
+ $struct->charset = $mime_headers->charset;
+ }
+
// read content encoding
if (!empty($part[5]) && $part[5]!='NIL') {
$struct->encoding = strtolower($part[5]);
@@ -2079,7 +2247,11 @@
$mime_headers = $this->conn->fetchPartHeader(
$this->mailbox, $this->_msg_id, false, $struct->mime_id);
}
- $struct->headers = $this->_parse_headers($mime_headers) + $struct->headers;
+
+ if (is_string($mime_headers))
+ $struct->headers = $this->_parse_headers($mime_headers) + $struct->headers;
+ else if (is_object($mime_headers))
+ $struct->headers = get_object_vars($mime_headers) + $struct->headers;
// get real content-type of message/rfc822
if ($struct->mimetype == 'message/rfc822') {
@@ -2275,20 +2447,21 @@
// TODO: Add caching for message parts
- if (!$part) $part = 'TEXT';
+ if (!$part) {
+ $part = 'TEXT';
+ }
$body = $this->conn->handlePartBody($this->mailbox, $uid, true, $part,
$o_part->encoding, $print, $fp);
- if ($fp || $print)
+ if ($fp || $print) {
return true;
+ }
- // convert charset (if text or message part)
- if ($body && ($o_part->ctype_primary == 'text' || $o_part->ctype_primary == 'message')) {
- // assume default if no charset specified
- if (empty($o_part->charset) || strtolower($o_part->charset) == 'us-ascii')
- $o_part->charset = $this->default_charset;
-
+ // convert charset (if text or message part) and part's charset is specified
+ if ($body && $o_part->charset
+ && preg_match('/^(text|message)$/', $o_part->ctype_primary)
+ ) {
$body = rcube_charset_convert($body, $o_part->charset);
}
@@ -2357,7 +2530,7 @@
*/
function set_flag($uids, $flag, $mbox_name=NULL, $skip_cache=false)
{
- $mailbox = $mbox_name ? $this->mod_mailbox($mbox_name) : $this->mailbox;
+ $mailbox = strlen($mbox_name) ? $this->mod_mailbox($mbox_name) : $this->mailbox;
$flag = strtoupper($flag);
list($uids, $all_mode) = $this->_parse_uids($uids, $mailbox);
@@ -2421,7 +2594,7 @@
$mailbox = $this->mod_mailbox($mbox_name);
// make sure mailbox exists
- if ($this->mailbox_exists($mbox_name, true)) {
+ if ($this->mailbox_exists($mbox_name)) {
if ($is_file)
$saved = $this->conn->appendFromFile($mailbox, $message, $headers);
else
@@ -2450,7 +2623,10 @@
$fbox = $from_mbox;
$tbox = $to_mbox;
$to_mbox = $this->mod_mailbox($to_mbox);
- $from_mbox = $from_mbox ? $this->mod_mailbox($from_mbox) : $this->mailbox;
+ $from_mbox = strlen($from_mbox) ? $this->mod_mailbox($from_mbox) : $this->mailbox;
+
+ if ($to_mbox === $from_mbox)
+ return false;
list($uids, $all_mode) = $this->_parse_uids($uids, $from_mbox);
@@ -2459,7 +2635,7 @@
return false;
// make sure mailbox exists
- if ($to_mbox != 'INBOX' && !$this->mailbox_exists($tbox, true)) {
+ if ($to_mbox != 'INBOX' && !$this->mailbox_exists($tbox)) {
if (in_array($tbox, $this->default_folders))
$this->create_mailbox($tbox, true);
else
@@ -2474,8 +2650,7 @@
}
// move messages
- $move = $this->conn->move($uids, $from_mbox, $to_mbox);
- $moved = !($move === false || $move < 0);
+ $moved = $this->conn->move($uids, $from_mbox, $to_mbox);
// send expunge command in order to have the moved message
// really deleted from the source mailbox
@@ -2536,11 +2711,12 @@
list($uids, $all_mode) = $this->_parse_uids($uids, $from_mbox);
// exit if no message uids are specified
- if (empty($uids))
+ if (empty($uids)) {
return false;
+ }
// make sure mailbox exists
- if ($to_mbox != 'INBOX' && !$this->mailbox_exists($tbox, true)) {
+ if ($to_mbox != 'INBOX' && !$this->mailbox_exists($tbox)) {
if (in_array($tbox, $this->default_folders))
$this->create_mailbox($tbox, true);
else
@@ -2548,8 +2724,7 @@
}
// copy messages
- $copy = $this->conn->copy($uids, $from_mbox, $to_mbox);
- $copied = !($copy === false || $copy < 0);
+ $copied = $this->conn->copy($uids, $from_mbox, $to_mbox);
if ($copied) {
$this->_clear_messagecount($to_mbox);
@@ -2568,7 +2743,7 @@
*/
function delete_message($uids, $mbox_name='')
{
- $mailbox = $mbox_name ? $this->mod_mailbox($mbox_name) : $this->mailbox;
+ $mailbox = strlen($mbox_name) ? $this->mod_mailbox($mbox_name) : $this->mailbox;
list($uids, $all_mode) = $this->_parse_uids($uids, $mailbox);
@@ -2621,7 +2796,7 @@
*/
function clear_mailbox($mbox_name=NULL)
{
- $mailbox = !empty($mbox_name) ? $this->mod_mailbox($mbox_name) : $this->mailbox;
+ $mailbox = strlen($mbox_name) ? $this->mod_mailbox($mbox_name) : $this->mailbox;
// SELECT will set messages count for clearFolder()
if ($this->conn->select($mailbox)) {
@@ -2649,7 +2824,7 @@
*/
function expunge($mbox_name='', $clear_cache=true)
{
- $mailbox = $mbox_name ? $this->mod_mailbox($mbox_name) : $this->mailbox;
+ $mailbox = strlen($mbox_name) ? $this->mod_mailbox($mbox_name) : $this->mailbox;
return $this->_expunge($mailbox, $clear_cache);
}
@@ -2671,7 +2846,23 @@
else
$a_uids = NULL;
- $result = $this->conn->expunge($mailbox, $a_uids);
+ // force mailbox selection and check if mailbox is writeable
+ // to prevent a situation when CLOSE is executed on closed
+ // or EXPUNGE on read-only mailbox
+ $result = $this->conn->select($mailbox);
+ if (!$result) {
+ return false;
+ }
+ if (!$this->conn->data['READ-WRITE']) {
+ $this->conn->setError(rcube_imap_generic::ERROR_READONLY, "Mailbox is read-only");
+ return false;
+ }
+
+ // CLOSE(+SELECT) should be faster than EXPUNGE
+ if (empty($a_uids) || $a_uids == '1:*')
+ $result = $this->conn->close();
+ else
+ $result = $this->conn->expunge($mailbox, $a_uids);
if ($result && $clear_cache) {
$this->clear_message_cache($mailbox.'.msg');
@@ -2734,7 +2925,7 @@
*/
function get_id($uid, $mbox_name=NULL)
{
- $mailbox = $mbox_name ? $this->mod_mailbox($mbox_name) : $this->mailbox;
+ $mailbox = strlen($mbox_name) ? $this->mod_mailbox($mbox_name) : $this->mailbox;
return $this->_uid2id($uid, $mailbox);
}
@@ -2746,9 +2937,9 @@
* @param string $mbox_name Mailbox name
* @return int Message UID
*/
- function get_uid($id,$mbox_name=NULL)
+ function get_uid($id, $mbox_name=NULL)
{
- $mailbox = $mbox_name ? $this->mod_mailbox($mbox_name) : $this->mailbox;
+ $mailbox = strlen($mbox_name) ? $this->mod_mailbox($mbox_name) : $this->mailbox;
return $this->_id2uid($id, $mailbox);
}
@@ -2774,7 +2965,7 @@
$a_mboxes = $this->_list_mailboxes($root, $filter);
foreach ($a_mboxes as $idx => $mbox_row) {
- if ($name = $this->mod_mailbox($mbox_row, 'out'))
+ if (strlen($name = $this->mod_mailbox($mbox_row, 'out')))
$a_out[] = $name;
unset($a_mboxes[$idx]);
}
@@ -2817,7 +3008,9 @@
}
else {
// Server supports LIST-EXTENDED, we can use selection options
- if ($this->get_capability('LIST-EXTENDED')) {
+ $config = rcmail::get_instance()->config;
+ // #1486225: Some dovecot versions returns wrong result using LIST-EXTENDED
+ if (!$config->get('imap_force_lsub') && $this->get_capability('LIST-EXTENDED')) {
// This will also set mailbox options, LSUB doesn't do that
$a_folders = $this->conn->listMailboxes($this->mod_mailbox($root), $filter,
NULL, array('SUBSCRIBED'));
@@ -2876,7 +3069,7 @@
// modify names with root dir
foreach ($a_mboxes as $idx => $mbox_name) {
- if ($name = $this->mod_mailbox($mbox_name, 'out'))
+ if (strlen($name = $this->mod_mailbox($mbox_name, 'out')))
$a_folders[] = $name;
unset($a_mboxes[$idx]);
}
@@ -2903,6 +3096,26 @@
return $this->conn->getQuota();
return false;
+ }
+
+
+ /**
+ * Get mailbox size (size of all messages in a mailbox)
+ *
+ * @param string $name Mailbox name
+ * @return int Mailbox size in bytes, False on error
+ */
+ function get_mailbox_size($name)
+ {
+ $name = $this->mod_mailbox($name);
+
+ // @TODO: could we try to use QUOTA here?
+ $result = $this->conn->fetchHeaderIndex($name, '1:*', 'SIZE', false);
+
+ if (is_array($result))
+ $result = array_sum($result);
+
+ return $result;
}
@@ -2941,129 +3154,120 @@
/**
* Create a new mailbox on the server and register it in local cache
*
- * @param string $name New mailbox name (as utf-7 string)
+ * @param string $name New mailbox name
* @param boolean $subscribe True if the new mailbox should be subscribed
- * @param string Name of the created mailbox, false on error
+ * @param boolean True on success
*/
function create_mailbox($name, $subscribe=false)
{
- $result = false;
-
- // reduce mailbox name to 100 chars
- $name = substr($name, 0, 100);
+ $result = false;
$abs_name = $this->mod_mailbox($name);
- $result = $this->conn->createFolder($abs_name);
+ $result = $this->conn->createFolder($abs_name);
// try to subscribe it
if ($result && $subscribe)
$this->subscribe($name);
- return $result ? $name : false;
+ return $result;
}
/**
* Set a new name to an existing mailbox
*
- * @param string $mbox_name Mailbox to rename (as utf-7 string)
- * @param string $new_name New mailbox name (as utf-7 string)
- * @return string Name of the renames mailbox, False on error
+ * @param string $mbox_name Mailbox to rename
+ * @param string $new_name New mailbox name
+ *
+ * @return boolean True on success
*/
function rename_mailbox($mbox_name, $new_name)
{
$result = false;
- // encode mailbox name and reduce it to 100 chars
- $name = substr($new_name, 0, 100);
-
// make absolute path
- $mailbox = $this->mod_mailbox($mbox_name);
- $abs_name = $this->mod_mailbox($name);
+ $mailbox = $this->mod_mailbox($mbox_name);
+ $abs_name = $this->mod_mailbox($new_name);
+ $delm = $this->get_hierarchy_delimiter();
- // check if mailbox is subscribed
- $a_subscribed = $this->_list_mailboxes();
- $subscribed = in_array($mailbox, $a_subscribed);
-
- // unsubscribe folder
- if ($subscribed)
- $this->conn->unsubscribe($mailbox);
+ // get list of subscribed folders
+ if ((strpos($mailbox, '%') === false) && (strpos($mailbox, '*') === false)) {
+ $a_subscribed = $this->_list_mailboxes('', $mbox_name . $delm . '*');
+ $subscribed = $this->mailbox_exists($mbox_name, true);
+ }
+ else {
+ $a_subscribed = $this->_list_mailboxes();
+ $subscribed = in_array($mailbox, $a_subscribed);
+ }
if (strlen($abs_name))
$result = $this->conn->renameFolder($mailbox, $abs_name);
if ($result) {
- $delm = $this->get_hierarchy_delimiter();
+ // unsubscribe the old folder, subscribe the new one
+ if ($subscribed) {
+ $this->conn->unsubscribe($mailbox);
+ $this->conn->subscribe($abs_name);
+ }
// check if mailbox children are subscribed
- foreach ($a_subscribed as $c_subscribed)
+ foreach ($a_subscribed as $c_subscribed) {
if (preg_match('/^'.preg_quote($mailbox.$delm, '/').'/', $c_subscribed)) {
$this->conn->unsubscribe($c_subscribed);
$this->conn->subscribe(preg_replace('/^'.preg_quote($mailbox, '/').'/',
$abs_name, $c_subscribed));
}
+ }
// clear cache
$this->clear_message_cache($mailbox.'.msg');
$this->clear_cache('mailboxes');
}
- // try to subscribe it
- if ($result && $subscribed)
- $this->conn->subscribe($abs_name);
-
- return $result ? $name : false;
+ return $result;
}
/**
- * Remove mailboxes from server
+ * Remove mailbox from server
*
- * @param string|array $mbox_name sMailbox name(s) string/array
+ * @param string $mbox_name Mailbox name
+ *
* @return boolean True on success
*/
function delete_mailbox($mbox_name)
{
- $deleted = false;
+ $result = false;
+ $mailbox = $this->mod_mailbox($mbox_name);
+ $delm = $this->get_hierarchy_delimiter();
- if (is_array($mbox_name))
- $a_mboxes = $mbox_name;
- else if (is_string($mbox_name) && strlen($mbox_name))
- $a_mboxes = explode(',', $mbox_name);
+ // get list of folders
+ if ((strpos($mailbox, '%') === false) && (strpos($mailbox, '*') === false))
+ $sub_mboxes = $this->list_unsubscribed('', $mailbox . $delm . '*');
+ else
+ $sub_mboxes = $this->list_unsubscribed();
- if (is_array($a_mboxes)) {
- foreach ($a_mboxes as $mbox_name) {
- $mailbox = $this->mod_mailbox($mbox_name);
- $sub_mboxes = $this->conn->listMailboxes($this->mod_mailbox(''),
- $mbox_name . $this->delimiter . '*');
+ // send delete command to server
+ $result = $this->conn->deleteFolder($mailbox);
- // unsubscribe mailbox before deleting
- $this->conn->unsubscribe($mailbox);
+ if ($result) {
+ // unsubscribe mailbox
+ $this->conn->unsubscribe($mailbox);
- // send delete command to server
- $result = $this->conn->deleteFolder($mailbox);
- if ($result) {
- $deleted = true;
- $this->clear_message_cache($mailbox.'.msg');
- }
-
- foreach ($sub_mboxes as $c_mbox) {
- if ($c_mbox != 'INBOX') {
- $this->conn->unsubscribe($c_mbox);
- $result = $this->conn->deleteFolder($c_mbox);
- if ($result) {
- $deleted = true;
- $this->clear_message_cache($c_mbox.'.msg');
- }
+ foreach ($sub_mboxes as $c_mbox) {
+ if (preg_match('/^'.preg_quote($mailbox.$delm, '/').'/', $c_mbox)) {
+ $this->conn->unsubscribe($c_mbox);
+ if ($this->conn->deleteFolder($c_mbox)) {
+ $this->clear_message_cache($c_mbox.'.msg');
}
}
}
+
+ // clear mailbox-related cache
+ $this->clear_message_cache($mailbox.'.msg');
+ $this->clear_cache('mailboxes');
}
- // clear mailboxlist cache
- if ($deleted)
- $this->clear_cache('mailboxes');
-
- return $deleted;
+ return $result;
}
@@ -3091,25 +3295,25 @@
*/
function mailbox_exists($mbox_name, $subscription=false)
{
- if ($mbox_name) {
- if ($mbox_name == 'INBOX')
- return true;
+ if ($mbox_name == 'INBOX')
+ return true;
- $key = $subscription ? 'subscribed' : 'existing';
- if (is_array($this->icache[$key]) && in_array($mbox_name, $this->icache[$key]))
- return true;
+ $key = $subscription ? 'subscribed' : 'existing';
+ $mbox = $this->mod_mailbox($mbox_name);
- if ($subscription) {
- $a_folders = $this->conn->listSubscribed($this->mod_mailbox(''), $mbox_name);
- }
- else {
- $a_folders = $this->conn->listMailboxes($this->mod_mailbox(''), $mbox_name);
- }
+ if (is_array($this->icache[$key]) && in_array($mbox, $this->icache[$key]))
+ return true;
- if (is_array($a_folders) && in_array($this->mod_mailbox($mbox_name), $a_folders)) {
- $this->icache[$key][] = $mbox_name;
- return true;
- }
+ if ($subscription) {
+ $a_folders = $this->conn->listSubscribed('', $mbox);
+ }
+ else {
+ $a_folders = $this->conn->listMailboxes('', $mbox);
+ }
+
+ if (is_array($a_folders) && in_array($mbox, $a_folders)) {
+ $this->icache[$key][] = $mbox;
+ return true;
}
return false;
@@ -3125,14 +3329,46 @@
*/
function mod_mailbox($mbox_name, $mode='in')
{
- if ($mbox_name == 'INBOX')
- return $mbox_name;
+ if (!strlen($mbox_name))
+ return '';
- if (!empty($this->root_dir)) {
- if ($mode=='in')
- $mbox_name = $this->root_dir.$this->delimiter.$mbox_name;
- else if (!empty($mbox_name)) // $mode=='out'
- $mbox_name = substr($mbox_name, strlen($this->root_dir)+1);
+ if ($mode == 'in') {
+ // If folder contains namespace prefix, don't modify it
+ if (is_array($this->namespace['shared'])) {
+ foreach ($this->namespace['shared'] as $ns) {
+ if ($ns[0] && strpos($mbox_name, $ns[0]) === 0) {
+ return $mbox_name;
+ }
+ }
+ }
+ if (is_array($this->namespace['other'])) {
+ foreach ($this->namespace['other'] as $ns) {
+ if ($ns[0] && strpos($mbox_name, $ns[0]) === 0) {
+ return $mbox_name;
+ }
+ }
+ }
+ if (is_array($this->namespace['personal'])) {
+ foreach ($this->namespace['personal'] as $ns) {
+ if ($ns[0] && strpos($mbox_name, $ns[0]) === 0) {
+ return $mbox_name;
+ }
+ }
+ // Add prefix if first personal namespace is non-empty
+ if ($mbox_name != 'INBOX' && $this->namespace['personal'][0][0]) {
+ return $this->namespace['personal'][0][0].$mbox_name;
+ }
+ }
+ }
+ else {
+ // Remove prefix if folder is from first ("non-empty") personal namespace
+ if (is_array($this->namespace['personal'])) {
+ if ($prefix = $this->namespace['personal'][0][0]) {
+ if (strpos($mbox_name, $prefix) === 0) {
+ return substr($mbox_name, strlen($prefix));
+ }
+ }
+ }
}
return $mbox_name;
@@ -3158,7 +3394,7 @@
if (!is_array($this->conn->data['LIST']) || !is_array($this->conn->data['LIST'][$mbox])) {
if ($force) {
- $this->conn->listMailboxes($this->mod_mailbox(''), $mbox_name);
+ $this->conn->listMailboxes('', $mbox_name);
}
else {
return array();
@@ -3317,8 +3553,8 @@
if ($mailbox)
$mailbox = $this->mod_mailbox($mailbox);
- if ($this->get_capability('METADATA') ||
- empty($mailbox) && $this->get_capability('METADATA-SERVER')
+ if ($this->get_capability('METADATA') ||
+ (!strlen($mailbox) && $this->get_capability('METADATA-SERVER'))
) {
return $this->conn->setMetadata($mailbox, $entries);
}
@@ -3351,7 +3587,7 @@
$mailbox = $this->mod_mailbox($mailbox);
if ($this->get_capability('METADATA') ||
- empty($mailbox) && $this->get_capability('METADATA-SERVER')
+ (!strlen($mailbox) && $this->get_capability('METADATA-SERVER'))
) {
return $this->conn->deleteMetadata($mailbox, $entries);
}
@@ -3385,7 +3621,7 @@
$mailbox = $this->mod_mailbox($mailbox);
if ($this->get_capability('METADATA') ||
- empty($mailbox) && $this->get_capability('METADATA-SERVER')
+ !strlen(($mailbox) && $this->get_capability('METADATA-SERVER'))
) {
return $this->conn->getMetadata($mailbox, $entries, $options);
}
@@ -3647,45 +3883,43 @@
$cache_count = count($cache_index);
// empty mailbox
- if (!$msg_count)
+ if (!$msg_count) {
return $cache_count ? -2 : 1;
+ }
- if ($cache_count==$msg_count) {
+ if ($cache_count == $msg_count) {
if ($this->skip_deleted) {
- $h_index = $this->conn->fetchHeaderIndex($mailbox, "1:*", 'UID', $this->skip_deleted);
-
- // Save index in internal cache, will be used when syncing the cache
- $this->icache['folder_index'] = $h_index;
-
- if (empty($h_index))
- return -2;
-
- if (sizeof($h_index) == $cache_count) {
- $cache_index = array_flip($cache_index);
- foreach ($h_index as $idx => $uid)
- unset($cache_index[$uid]);
-
- if (empty($cache_index))
- return 1;
- }
- return -2;
+ if (!empty($this->icache['all_undeleted_idx'])) {
+ $uids = rcube_imap_generic::uncompressMessageSet($this->icache['all_undeleted_idx']);
+ $uids = array_flip($uids);
+ foreach ($cache_index as $uid) {
+ unset($uids[$uid]);
+ }
+ }
+ else {
+ // get all undeleted messages excluding cached UIDs
+ $uids = $this->search_once($mailbox, 'ALL UNDELETED NOT UID '.
+ rcube_imap_generic::compressMessageSet($cache_index));
+ }
+ if (empty($uids)) {
+ return 1;
+ }
} else {
// get UID of the message with highest index
$uid = $this->_id2uid($msg_count, $mailbox);
$cache_uid = array_pop($cache_index);
// uids of highest message matches -> cache seems OK
- if ($cache_uid == $uid)
+ if ($cache_uid == $uid) {
return 1;
+ }
}
// cache is dirty
return -1;
}
+
// if cache count differs less than 10% report as dirty
- else if (abs($msg_count - $cache_count) < $msg_count/10)
- return -1;
- else
- return -2;
+ return (abs($msg_count - $cache_count) < $msg_count/10) ? -1 : -2;
}
@@ -4318,7 +4552,7 @@
*/
private function _uid2id($uid, $mbox_name=NULL)
{
- if (!$mbox_name)
+ if (!strlen($mbox_name))
$mbox_name = $this->mailbox;
if (!isset($this->uid_id_map[$mbox_name][$uid])) {
@@ -4340,7 +4574,7 @@
*/
private function _id2uid($id, $mbox_name=NULL)
{
- if (!$mbox_name)
+ if (!strlen($mbox_name))
$mbox_name = $this->mailbox;
if ($uid = array_search($id, (array)$this->uid_id_map[$mbox_name]))
@@ -4401,7 +4635,7 @@
private function _set_messagecount($mbox_name, $mode, $increment)
{
$a_mailbox_cache = false;
- $mailbox = $mbox_name ? $mbox_name : $this->mailbox;
+ $mailbox = strlen($mbox_name) ? $mbox_name : $this->mailbox;
$mode = strtoupper($mode);
$a_mailbox_cache = $this->get_cache('messagecount');
@@ -4429,7 +4663,7 @@
*/
private function _clear_messagecount($mbox_name='', $mode=null)
{
- $mailbox = $mbox_name ? $mbox_name : $this->mailbox;
+ $mailbox = strlen($mbox_name) ? $mbox_name : $this->mailbox;
$a_mailbox_cache = $this->get_cache('messagecount');
@@ -4475,10 +4709,13 @@
private function _parse_address_list($str, $decode=true)
{
// remove any newlines and carriage returns before
- $a = rcube_explode_quoted_string('[,;]', preg_replace( "/[\r\n]/", " ", $str));
+ $str = preg_replace('/\r?\n(\s|\t)?/', ' ', $str);
+
+ // extract list items, remove comments
+ $str = self::explode_header_string(',;', $str, true);
$result = array();
- foreach ($a as $key => $val) {
+ foreach ($str as $key => $val) {
$name = '';
$address = '';
$val = trim($val);
@@ -4518,6 +4755,91 @@
return $result;
}
+
+ /**
+ * Explodes header (e.g. address-list) string into array of strings
+ * using specified separator characters with proper handling
+ * of quoted-strings and comments (RFC2822)
+ *
+ * @param string $separator String containing separator characters
+ * @param string $str Header string
+ * @param bool $remove_comments Enable to remove comments
+ *
+ * @return array Header items
+ */
+ static function explode_header_string($separator, $str, $remove_comments=false)
+ {
+ $length = strlen($str);
+ $result = array();
+ $quoted = false;
+ $comment = 0;
+ $out = '';
+
+ for ($i=0; $i<$length; $i++) {
+ // we're inside a quoted string
+ if ($quoted) {
+ if ($str[$i] == '"') {
+ $quoted = false;
+ }
+ else if ($str[$i] == '\\') {
+ if ($comment <= 0) {
+ $out .= '\\';
+ }
+ $i++;
+ }
+ }
+ // we're inside a comment string
+ else if ($comment > 0) {
+ if ($str[$i] == ')') {
+ $comment--;
+ }
+ else if ($str[$i] == '(') {
+ $comment++;
+ }
+ else if ($str[$i] == '\\') {
+ $i++;
+ }
+ continue;
+ }
+ // separator, add to result array
+ else if (strpos($separator, $str[$i]) !== false) {
+ if ($out) {
+ $result[] = $out;
+ }
+ $out = '';
+ continue;
+ }
+ // start of quoted string
+ else if ($str[$i] == '"') {
+ $quoted = true;
+ }
+ // start of comment
+ else if ($remove_comments && $str[$i] == '(') {
+ $comment++;
+ }
+
+ if ($comment <= 0) {
+ $out .= $str[$i];
+ }
+ }
+
+ if ($out && $comment <= 0) {
+ $result[] = $out;
+ }
+
+ return $result;
+ }
+
+
+ /**
+ * This is our own debug handler for the IMAP connection
+ * @access public
+ */
+ public function debug_handler(&$imap, $message)
+ {
+ write_log('imap', $message);
+ }
+
} // end class rcube_imap
--
Gitblit v1.9.1