diff options
| author | thomascube <thomas@roundcube.net> | 2012-01-16 15:14:41 +0000 |
|---|---|---|
| committer | thomascube <thomas@roundcube.net> | 2012-01-16 15:14:41 +0000 |
| commit | c321a955a7b0f6d6b13ffaebf040a6c7091037ae (patch) | |
| tree | 60c257d29a726d9bdda7fb75a198342aaef315fa /program/include/rcube_imap.php | |
| parent | 8764b6ecf0c8d1b0646915a8139cdf6bbac2ca14 (diff) | |
Merged devel-framework branch (r5746:5779) back into trunk
Diffstat (limited to 'program/include/rcube_imap.php')
| -rw-r--r-- | program/include/rcube_imap.php | 2138 |
1 files changed, 1044 insertions, 1094 deletions
diff --git a/program/include/rcube_imap.php b/program/include/rcube_imap.php index 6542f3ca1..8d5acfb9d 100644 --- a/program/include/rcube_imap.php +++ b/program/include/rcube_imap.php @@ -5,12 +5,12 @@ | program/include/rcube_imap.php | | | | This file is part of the Roundcube Webmail client | - | Copyright (C) 2005-2011, The Roundcube Dev Team | - | Copyright (C) 2011, Kolab Systems AG | + | Copyright (C) 2005-2012, The Roundcube Dev Team | + | Copyright (C) 2011-2012, Kolab Systems AG | | Licensed under the GNU GPL | | | | PURPOSE: | - | IMAP Engine | + | IMAP Storage Engine | | | +-----------------------------------------------------------------------+ | Author: Thomas Bruederli <roundcube@gmail.com> | @@ -30,15 +30,8 @@ * @author Aleksander Machniak <alec@alec.pl> * @version 2.0 */ -class rcube_imap +class rcube_imap extends rcube_storage { - public $skip_deleted = false; - public $page_size = 10; - public $list_page = 1; - public $threading = false; - public $fetch_add_headers = ''; - public $get_all_headers = false; - /** * Instance of rcube_imap_generic * @@ -51,87 +44,70 @@ class rcube_imap * * @var rcube_imap_cache */ - private $mcache; + protected $mcache; /** * Instance of rcube_cache * * @var rcube_cache */ - private $cache; + protected $cache; /** * Internal (in-memory) cache * * @var array */ - private $icache = array(); - - private $mailbox = 'INBOX'; - private $delimiter = NULL; - private $namespace = NULL; - private $sort_field = ''; - private $sort_order = 'DESC'; - private $default_charset = 'ISO-8859-1'; - private $struct_charset = NULL; - private $default_folders = array('INBOX'); - private $uid_id_map = array(); - private $msg_headers = array(); - public $search_set = NULL; - public $search_string = ''; - private $search_charset = ''; - private $search_sort_field = ''; - private $search_threads = false; - private $search_sorted = false; - private $options = array('auth_method' => 'check'); - private $host, $user, $pass, $port, $ssl; - private $caching = false; - private $messages_caching = false; - - /** - * All (additional) headers used (in any way) by Roundcube - * Not listed here: DATE, FROM, TO, CC, REPLY-TO, SUBJECT, CONTENT-TYPE, LIST-POST - * (used for messages listing) are hardcoded in rcube_imap_generic::fetchHeaders() - * - * @var array - * @see rcube_imap::fetch_add_headers - */ - private $all_headers = array( - 'IN-REPLY-TO', - 'BCC', - 'MESSAGE-ID', - 'CONTENT-TRANSFER-ENCODING', - 'REFERENCES', - 'X-DRAFT-INFO', - 'MAIL-FOLLOWUP-TO', - 'MAIL-REPLY-TO', - '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; + protected $icache = array(); + + protected $list_page = 1; + protected $delimiter; + protected $namespace; + protected $sort_field = ''; + protected $sort_order = 'DESC'; + protected $struct_charset; + protected $uid_id_map = array(); + protected $msg_headers = array(); + protected $search_set; + protected $search_string = ''; + protected $search_charset = ''; + protected $search_sort_field = ''; + protected $search_threads = false; + protected $search_sorted = false; + protected $options = array('auth_method' => 'check'); + protected $caching = false; + protected $messages_caching = false; + protected $threading = false; /** * Object constructor. */ - function __construct() + public function __construct() { $this->conn = new rcube_imap_generic(); // Set namespace and delimiter from session, // so some methods would work before connection - if (isset($_SESSION['imap_namespace'])) + if (isset($_SESSION['imap_namespace'])) { $this->namespace = $_SESSION['imap_namespace']; - if (isset($_SESSION['imap_delimiter'])) + } + if (isset($_SESSION['imap_delimiter'])) { $this->delimiter = $_SESSION['imap_delimiter']; + } + } + + + /** + * Magic getter for backward compat. + * + * @deprecated. + */ + public function __get($name) + { + if (isset($this->{$name})) { + return $this->{$name}; + } } @@ -143,14 +119,15 @@ class rcube_imap * @param string $pass Password for IMAP account * @param integer $port Port to connect to * @param string $use_ssl SSL schema (either ssl or tls) or null if plain connection + * * @return boolean TRUE on success, FALSE on failure - * @access public */ - function connect($host, $user, $pass, $port=143, $use_ssl=null) + public function connect($host, $user, $pass, $port=143, $use_ssl=null) { // check for OpenSSL support in PHP build - if ($use_ssl && extension_loaded('openssl')) + if ($use_ssl && extension_loaded('openssl')) { $this->options['ssl_mode'] = $use_ssl == 'imaps' ? 'ssl' : $use_ssl; + } else if ($use_ssl) { raise_error(array('code' => 403, 'type' => 'imap', 'file' => __FILE__, 'line' => __LINE__, @@ -161,7 +138,7 @@ class rcube_imap $this->options['port'] = $port; if ($this->options['debug']) { - $this->conn->setDebug(true, array($this, 'debug_handler')); + $this->set_debug(true); $this->options['ident'] = array( 'name' => 'Roundcube Webmail', @@ -178,17 +155,23 @@ class rcube_imap array_merge($this->options, array('host' => $host, 'user' => $user, 'attempt' => ++$attempt))); - if (!empty($data['pass'])) + if (!empty($data['pass'])) { $pass = $data['pass']; + } $this->conn->connect($data['host'], $data['user'], $pass, $data); } while(!$this->conn->connected() && $data['retry']); - $this->host = $data['host']; - $this->user = $data['user']; - $this->pass = $pass; - $this->port = $port; - $this->ssl = $use_ssl; + $config = array( + 'host' => $data['host'], + 'user' => $data['user'], + 'password' => $pass, + 'port' => $port, + 'ssl' => $use_ssl, + ); + + $this->options = array_merge($this->options, $config); + $this->connect_done = true; if ($this->conn->connected()) { // get namespace and delimiter @@ -212,33 +195,46 @@ class rcube_imap /** - * Close IMAP connection + * Close IMAP connection. * Usually done on script shutdown - * - * @access public */ - function close() + public function close() { $this->conn->closeConnection(); - if ($this->mcache) + if ($this->mcache) { $this->mcache->close(); + } } /** - * Close IMAP connection and re-connect - * This is used to avoid some strange socket errors when talking to Courier IMAP - * - * @access public + * Check connection state, connect if not connected. */ - function reconnect() + public function check_connection() { - $this->conn->closeConnection(); - $connected = $this->connect($this->host, $this->user, $this->pass, $this->port, $this->ssl); + // Establish connection if it wasn't done yet + if (!$this->connect_done && !empty($this->options['user'])) { + return $this->connect( + $this->options['host'], + $this->options['user'], + $this->options['password'], + $this->options['port'], + $this->options['ssl'] + ); + } + + return $this->is_connected(); + } + - // issue SELECT command to restore connection status - if ($connected && strlen($this->mailbox)) - $this->conn->select($this->mailbox); + /** + * Checks IMAP connection. + * + * @return boolean TRUE on success, FALSE on failure + */ + public function is_connected() + { + return $this->conn->connected(); } @@ -247,18 +243,18 @@ class rcube_imap * * @return int Error code */ - function get_error_code() + public function get_error_code() { return $this->conn->errornum; } /** - * Returns message of last error + * Returns text of last error * - * @return string Error message + * @return string Error string */ - function get_error_str() + public function get_error_str() { return $this->conn->error; } @@ -269,7 +265,7 @@ class rcube_imap * * @return int Response code */ - function get_response_code() + public function get_response_code() { switch ($this->conn->resultcode) { case 'NOPERM': @@ -295,34 +291,11 @@ class rcube_imap /** - * 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() - * - * @param array $opt Options array - */ - function set_options($opt) - { - $this->options = array_merge($this->options, (array)$opt); - } - - - /** * Activate/deactivate debug mode * * @param boolean $dbg True if IMAP conversation should be logged - * @access public */ - function set_debug($dbg = true) + public function set_debug($dbg = true) { $this->options['debug'] = $dbg; $this->conn->setDebug($dbg, array($this, 'debug_handler')); @@ -330,78 +303,21 @@ class rcube_imap /** - * Set default message charset - * - * This will be used for message decoding if a charset specification is not available - * - * @param string $cs Charset string - * @access public - */ - function set_charset($cs) - { - $this->default_charset = $cs; - } - - - /** - * This list of folders will be listed above all other folders - * - * @param array $arr Indexed list of folder names - * @access public - */ - function set_default_mailboxes($arr) - { - if (is_array($arr)) { - $this->default_folders = $arr; - - // add inbox if not included - if (!in_array('INBOX', $this->default_folders)) - array_unshift($this->default_folders, 'INBOX'); - } - } - - - /** - * Set internal mailbox reference. + * Set internal folder reference. + * All operations will be perfomed on this folder. * - * All operations will be perfomed on this mailbox/folder - * - * @param string $mailbox Mailbox/Folder name - * @access public + * @param string $folder Folder name */ - function set_mailbox($mailbox) + public function set_folder($folder) { - if ($this->mailbox == $mailbox) + if ($this->folder == $folder) { return; + } - $this->mailbox = $mailbox; - - // clear messagecount cache for this mailbox - $this->_clear_messagecount($mailbox); - } - - - /** - * Set internal list page - * - * @param number $page Page number to list - * @access public - */ - function set_page($page) - { - $this->list_page = (int)$page; - } - + $this->folder = $folder; - /** - * Set internal page size - * - * @param number $size Number of messages to display on one page - * @access public - */ - function set_pagesize($size) - { - $this->page_size = (int)$size; + // clear messagecount cache for this folder + $this->clear_messagecount($folder); } @@ -415,7 +331,7 @@ class rcube_imap * 3 - sorting field, string * 4 - true if sorted, bool */ - function set_search_set($set) + public function set_search_set($set) { $set = (array)$set; @@ -433,8 +349,12 @@ class rcube_imap * * @return array Search set */ - function get_search_set() + public function get_search_set() { + if (empty($this->search_set)) { + return null; + } + return array( $this->search_string, $this->search_set, @@ -446,66 +366,47 @@ class rcube_imap /** - * Returns the currently used mailbox name - * - * @return string Name of the mailbox/folder - * @access public - */ - function get_mailbox_name() - { - return $this->mailbox; - } - - - /** - * Returns the IMAP server's capability + * Returns the IMAP server's capability. * * @param string $cap Capability name + * * @return mixed Capability value or TRUE if supported, FALSE if not - * @access public */ - function get_capability($cap) + public function get_capability($cap) { - return $this->conn->getCapability(strtoupper($cap)); - } - + $cap = strtoupper($cap); + $sess_key = "STORAGE_$cap"; - /** - * Sets threading flag to the best supported THREAD algorithm - * - * @param boolean $enable TRUE to enable and FALSE - * @return string Algorithm or false if THREAD is not supported - * @access public - */ - function set_threading($enable=false) - { - $this->threading = false; + if (!isset($_SESSION[$sess_key])) { + if (!$this->check_connection()) { + return false; + } - if ($enable && ($caps = $this->get_capability('THREAD'))) { - if (in_array('REFS', $caps)) - $this->threading = 'REFS'; - else if (in_array('REFERENCES', $caps)) - $this->threading = 'REFERENCES'; - else if (in_array('ORDEREDSUBJECT', $caps)) - $this->threading = 'ORDEREDSUBJECT'; + $_SESSION[$sess_key] = $this->conn->getCapability($cap); } - return $this->threading; + return $_SESSION[$sess_key]; } /** - * Checks the PERMANENTFLAGS capability of the current mailbox + * Checks the PERMANENTFLAGS capability of the current folder * and returns true if the given flag is supported by the IMAP server * * @param string $flag Permanentflag name + * * @return boolean True if this flag is supported - * @access public */ - function check_permflag($flag) + public function check_permflag($flag) { $flag = strtoupper($flag); $imap_flag = $this->conn->flags[$flag]; + + if ($this->folder !== null) { + $this->check_connection(); + } + // @TODO: cache permanent flags (?) + return (in_array_nocase($imap_flag, $this->conn->data['PERMANENTFLAGS'])); } @@ -516,7 +417,7 @@ class rcube_imap * @return string Delimiter string * @access public */ - function get_hierarchy_delimiter() + public function get_hierarchy_delimiter() { return $this->delimiter; } @@ -528,9 +429,8 @@ class rcube_imap * @param string $name Namespace array index: personal, other, shared, prefix * * @return array Namespace data - * @access public */ - function get_namespace($name=null) + public function get_namespace($name = null) { $ns = $this->namespace; @@ -545,10 +445,8 @@ class rcube_imap /** * Sets delimiter and namespaces - * - * @access private */ - private function set_env() + protected function set_env() { if ($this->delimiter !== null && $this->namespace !== null) { return; @@ -560,8 +458,9 @@ class rcube_imap $imap_shared = $config->get('imap_ns_shared'); $imap_delimiter = $config->get('imap_delimiter'); - if (!$this->conn->connected()) + if (!$this->check_connection()) { return; + } $ns = $this->conn->getNamespace(); @@ -614,7 +513,7 @@ class rcube_imap } } - // Find personal namespace prefix for mod_mailbox() + // Find personal namespace prefix for mod_folder() // Prefix can be removed when there is only one personal namespace if (is_array($this->namespace['personal']) && count($this->namespace['personal']) == 1) { $this->namespace['prefix'] = $this->namespace['personal'][0][0]; @@ -626,75 +525,83 @@ class rcube_imap /** - * Get message count for a specific mailbox + * Get message count for a specific folder * - * @param string $mailbox Mailbox/folder name + * @param string $folder Folder name * @param string $mode Mode for count [ALL|THREADS|UNSEEN|RECENT] * @param boolean $force Force reading from server and update cache * @param boolean $status Enables storing folder status info (max UID/count), - * required for mailbox_status() + * required for folder_status() + * * @return int Number of messages - * @access public */ - function messagecount($mailbox='', $mode='ALL', $force=false, $status=true) + public function count($folder='', $mode='ALL', $force=false, $status=true) { - if (!strlen($mailbox)) { - $mailbox = $this->mailbox; + if (!strlen($folder)) { + $folder = $this->folder; } - return $this->_messagecount($mailbox, $mode, $force, $status); + return $this->messagecount($folder, $mode, $force, $status); } /** - * Private method for getting nr of messages + * protected method for getting nr of messages * - * @param string $mailbox Mailbox name + * @param string $folder Folder name * @param string $mode Mode for count [ALL|THREADS|UNSEEN|RECENT] * @param boolean $force Force reading from server and update cache * @param boolean $status Enables storing folder status info (max UID/count), - * required for mailbox_status() + * required for folder_status() + * * @return int Number of messages - * @access private - * @see rcube_imap::messagecount() + * @see rcube_imap::count() */ - private function _messagecount($mailbox, $mode='ALL', $force=false, $status=true) + protected function messagecount($folder, $mode='ALL', $force=false, $status=true) { $mode = strtoupper($mode); // count search set - if ($this->search_string && $mailbox == $this->mailbox && ($mode == 'ALL' || $mode == 'THREADS') && !$force) { - if ($mode == 'ALL') - return $this->search_set->countMessages(); - else + if ($this->search_string && $folder == $this->folder && ($mode == 'ALL' || $mode == 'THREADS') && !$force) { + if ($mode == 'ALL') { + return $this->search_set->count_messages(); + } + else { return $this->search_set->count(); + } } - $a_mailbox_cache = $this->get_cache('messagecount'); + $a_folder_cache = $this->get_cache('messagecount'); // return cached value - if (!$force && is_array($a_mailbox_cache[$mailbox]) && isset($a_mailbox_cache[$mailbox][$mode])) - return $a_mailbox_cache[$mailbox][$mode]; + if (!$force && is_array($a_folder_cache[$folder]) && isset($a_folder_cache[$folder][$mode])) { + return $a_folder_cache[$folder][$mode]; + } - if (!is_array($a_mailbox_cache[$mailbox])) - $a_mailbox_cache[$mailbox] = array(); + if (!is_array($a_folder_cache[$folder])) { + $a_folder_cache[$folder] = array(); + } if ($mode == 'THREADS') { - $res = $this->fetch_threads($mailbox, $force); + $res = $this->fetch_threads($folder, $force); $count = $res->count(); if ($status) { - $msg_count = $res->countMessages(); - $this->set_folder_stats($mailbox, 'cnt', $msg_count); - $this->set_folder_stats($mailbox, 'maxuid', $msg_count ? $this->id2uid($msg_count, $mailbox) : 0); + $msg_count = $res->count_messages(); + $this->set_folder_stats($folder, 'cnt', $msg_count); + $this->set_folder_stats($folder, 'maxuid', $msg_count ? $this->id2uid($msg_count, $folder) : 0); } } + // Need connection here + else if (!$this->check_connection()) { + return 0; + } // RECENT count is fetched a bit different else if ($mode == 'RECENT') { - $count = $this->conn->countRecent($mailbox); + $count = $this->conn->countRecent($folder); } // use SEARCH for message counting - else if ($this->skip_deleted) { + else if (!empty($this->options['skip_deleted'])) { $search_str = "ALL UNDELETED"; $keys = array('COUNT'); @@ -714,35 +621,36 @@ class rcube_imap // get message count using (E)SEARCH // not very performant but more precise (using UNDELETED) - $index = $this->conn->search($mailbox, $search_str, true, $keys); + $index = $this->conn->search($folder, $search_str, true, $keys); $count = $index->count(); if ($mode == 'ALL') { - // Cache index data, will be used in message_index_direct() + // Cache index data, will be used in index_direct() $this->icache['undeleted_idx'] = $index; if ($status) { - $this->set_folder_stats($mailbox, 'cnt', $count); - $this->set_folder_stats($mailbox, 'maxuid', $index->max()); + $this->set_folder_stats($folder, 'cnt', $count); + $this->set_folder_stats($folder, 'maxuid', $index->max()); } } } else { - if ($mode == 'UNSEEN') - $count = $this->conn->countUnseen($mailbox); + if ($mode == 'UNSEEN') { + $count = $this->conn->countUnseen($folder); + } else { - $count = $this->conn->countMessages($mailbox); + $count = $this->conn->countMessages($folder); if ($status) { - $this->set_folder_stats($mailbox,'cnt', $count); - $this->set_folder_stats($mailbox, 'maxuid', $count ? $this->id2uid($count, $mailbox) : 0); + $this->set_folder_stats($folder,'cnt', $count); + $this->set_folder_stats($folder, 'maxuid', $count ? $this->id2uid($count, $folder) : 0); } } } - $a_mailbox_cache[$mailbox][$mode] = (int)$count; + $a_folder_cache[$folder][$mode] = (int)$count; // write back to cache - $this->update_cache('messagecount', $a_mailbox_cache); + $this->update_cache('messagecount', $a_folder_cache); return (int)$count; } @@ -750,42 +658,40 @@ class rcube_imap /** * Public method for listing headers - * convert mailbox name with root dir first * - * @param string $mailbox Mailbox/folder name + * @param string $folder Folder name * @param int $page Current page to list * @param string $sort_field Header field to sort by * @param string $sort_order Sort order [ASC|DESC] * @param int $slice Number of slice items to extract from result array * * @return array Indexed array with message header objects - * @access public */ - public function list_headers($mailbox='', $page=NULL, $sort_field=NULL, $sort_order=NULL, $slice=0) + public function list_messages($folder='', $page=NULL, $sort_field=NULL, $sort_order=NULL, $slice=0) { - if (!strlen($mailbox)) { - $mailbox = $this->mailbox; + if (!strlen($folder)) { + $folder = $this->folder; } - return $this->_list_headers($mailbox, $page, $sort_field, $sort_order, $slice); + return $this->_list_messages($folder, $page, $sort_field, $sort_order, $slice); } /** - * Private method for listing message headers + * protected method for listing message headers * - * @param string $mailbox Mailbox name + * @param string $folder Folder name * @param int $page Current page to list * @param string $sort_field Header field to sort by * @param string $sort_order Sort order [ASC|DESC] * @param int $slice Number of slice items to extract from result array * * @return array Indexed array with message header objects - * @see rcube_imap::list_headers + * @see rcube_imap::list_messages */ - private function _list_headers($mailbox='', $page=NULL, $sort_field=NULL, $sort_order=NULL, $slice=0) + protected function _list_messages($folder='', $page=NULL, $sort_field=NULL, $sort_order=NULL, $slice=0) { - if (!strlen($mailbox)) { + if (!strlen($folder)) { return array(); } @@ -793,18 +699,18 @@ class rcube_imap $page = $page ? $page : $this->list_page; // use saved message set - if ($this->search_string && $mailbox == $this->mailbox) { - return $this->_list_header_set($mailbox, $page, $slice); + if ($this->search_string && $folder == $this->folder) { + return $this->list_search_messages($folder, $page, $slice); } if ($this->threading) { - return $this->_list_thread_headers($mailbox, $page, $slice); + return $this->list_thread_messages($folder, $page, $slice); } // get UIDs of all messages in the folder, sorted - $index = $this->message_index($mailbox, $this->sort_field, $this->sort_order); + $index = $this->index($folder, $this->sort_field, $this->sort_order); - if ($index->isEmpty()) { + if ($index->is_empty()) { return array(); } @@ -813,58 +719,64 @@ class rcube_imap $index->slice($from, $to - $from); - if ($slice) + if ($slice) { $index->slice(-$slice, $slice); + } // fetch reqested messages headers $a_index = $index->get(); - $a_msg_headers = $this->fetch_headers($mailbox, $a_index); + $a_msg_headers = $this->fetch_headers($folder, $a_index); return array_values($a_msg_headers); } /** - * Private method for listing message headers using threads + * protected method for listing message headers using threads * - * @param string $mailbox Mailbox/folder name + * @param string $folder Folder name * @param int $page Current page to list * @param int $slice Number of slice items to extract from result array * * @return array Indexed array with message header objects - * @see rcube_imap::list_headers + * @see rcube_imap::list_messages */ - private function _list_thread_headers($mailbox, $page, $slice=0) + protected function list_thread_messages($folder, $page, $slice=0) { // get all threads (not sorted) - if ($mcache = $this->get_mcache_engine()) - $threads = $mcache->get_thread($mailbox); - else - $threads = $this->fetch_threads($mailbox); + if ($mcache = $this->get_mcache_engine()) { + $threads = $mcache->get_thread($folder); + } + else { + $threads = $this->fetch_threads($folder); + } - return $this->_fetch_thread_headers($mailbox, $threads, $page, $slice); + return $this->fetch_thread_headers($folder, $threads, $page, $slice); } - /** * Method for fetching threads data * - * @param string $mailbox Folder name - * @param bool $force Use IMAP server, no cache + * @param string $folder Folder name + * @param bool $force Use IMAP server, no cache * * @return rcube_imap_thread Thread data object */ - function fetch_threads($mailbox, $force = false) + function fetch_threads($folder, $force = false) { if (!$force && ($mcache = $this->get_mcache_engine())) { // don't store in self's internal cache, cache has it's own internal cache - return $mcache->get_thread($mailbox); + return $mcache->get_thread($folder); } if (empty($this->icache['threads'])) { + if (!$this->check_connection()) { + return new rcube_result_thread(); + } + // get all threads - $result = $this->conn->thread($mailbox, $this->threading, - $this->skip_deleted ? 'UNDELETED' : '', true); + $result = $this->conn->thread($folder, $this->threading, + $this->options['skip_deleted'] ? 'UNDELETED' : '', true); // add to internal (fast) cache $this->icache['threads'] = $result; @@ -875,17 +787,16 @@ class rcube_imap /** - * Private method for fetching threaded messages headers + * protected method for fetching threaded messages headers * - * @param string $mailbox Mailbox name + * @param string $folder Folder name * @param rcube_result_thread $threads Threads data object * @param int $page List page number * @param int $slice Number of threads to slice * * @return array Messages headers - * @access private */ - private function _fetch_thread_headers($mailbox, $threads, $page, $slice=0) + protected function fetch_thread_headers($folder, $threads, $page, $slice=0) { // Sort thread structure $this->sort_threads($threads); @@ -895,39 +806,39 @@ class rcube_imap $threads->slice($from, $to - $from); - if ($slice) + if ($slice) { $threads->slice(-$slice, $slice); + } // Get UIDs of all messages in all threads $a_index = $threads->get(); // fetch reqested headers from server - $a_msg_headers = $this->fetch_headers($mailbox, $a_index); + $a_msg_headers = $this->fetch_headers($folder, $a_index); unset($a_index); // Set depth, has_children and unread_children fields in headers - $this->_set_thread_flags($a_msg_headers, $threads); + $this->set_thread_flags($a_msg_headers, $threads); return array_values($a_msg_headers); } /** - * Private method for setting threaded messages flags: + * protected method for setting threaded messages flags: * depth, has_children and unread_children * * @param array $headers Reference to headers array indexed by message UID * @param rcube_imap_result $threads Threads data object * * @return array Message headers array indexed by message UID - * @access private */ - private function _set_thread_flags(&$headers, $threads) + protected function set_thread_flags(&$headers, $threads) { $parents = array(); - list ($msg_depth, $msg_children) = $threads->getThreadData(); + list ($msg_depth, $msg_children) = $threads->get_thread_data(); foreach ($headers as $uid => $header) { $depth = $msg_depth[$uid]; @@ -947,24 +858,23 @@ class rcube_imap /** - * Private method for listing a set of message headers (search results) + * protected method for listing a set of message headers (search results) * - * @param string $mailbox Mailbox/folder name + * @param string $folder Folder name * @param int $page Current page to list * @param int $slice Number of slice items to extract from result array * * @return array Indexed array with message header objects - * @access private */ - private function _list_header_set($mailbox, $page, $slice=0) + protected function list_search_messages($folder, $page, $slice=0) { - if (!strlen($mailbox) || empty($this->search_set) || $this->search_set->isEmpty()) { + if (!strlen($folder) || empty($this->search_set) || $this->search_set->is_empty()) { return array(); } // use saved messages from searching if ($this->threading) { - return $this->_list_thread_header_set($mailbox, $page, $slice); + return $this->list_search_thread_messages($folder, $page, $slice); } // search set is threaded, we need a new one @@ -977,8 +887,9 @@ class rcube_imap $to = $from + $this->page_size; // return empty array if no messages found - if ($index->isEmpty()) + if ($index->is_empty()) { return array(); + } // quickest method (default sorting) if (!$this->search_sort_field && !$this->sort_field) { @@ -994,25 +905,27 @@ class rcube_imap $index = clone $this->search_set; // return empty array if no messages found - if ($index->isEmpty()) + if ($index->is_empty()) { return array(); + } } } if ($got_index) { - if ($this->sort_order != $index->getParameters('ORDER')) { + if ($this->sort_order != $index->get_parameters('ORDER')) { $index->revert(); } // get messages uids for one page $index->slice($from, $to-$from); - if ($slice) + if ($slice) { $index->slice(-$slice, $slice); + } // fetch headers $a_index = $index->get(); - $a_msg_headers = $this->fetch_headers($mailbox, $a_index); + $a_msg_headers = $this->fetch_headers($folder, $a_index); return array_values($a_msg_headers); } @@ -1023,27 +936,33 @@ class rcube_imap // 300: experimantal value for best result if (($cnt > 300 && $cnt > $this->page_size) || !$this->sort_field) { // use memory less expensive (and quick) method for big result set - $index = clone $this->message_index('', $this->sort_field, $this->sort_order); + $index = clone $this->index('', $this->sort_field, $this->sort_order); // get messages uids for one page... $index->slice($start_msg, min($cnt-$from, $this->page_size)); - if ($slice) + if ($slice) { $index->slice(-$slice, $slice); + } // ...and fetch headers $a_index = $index->get(); - $a_msg_headers = $this->fetch_headers($mailbox, $a_index); + $a_msg_headers = $this->fetch_headers($folder, $a_index); return array_values($a_msg_headers); } else { // for small result set we can fetch all messages headers $a_index = $index->get(); - $a_msg_headers = $this->fetch_headers($mailbox, $a_index, false); + $a_msg_headers = $this->fetch_headers($folder, $a_index, false); // return empty array if no messages found - if (!is_array($a_msg_headers) || empty($a_msg_headers)) + if (!is_array($a_msg_headers) || empty($a_msg_headers)) { return array(); + } + + if (!$this->check_connection()) { + return array(); + } // if not already sorted $a_msg_headers = $this->conn->sortHeaders( @@ -1053,8 +972,9 @@ class rcube_imap $a_msg_headers = array_slice(array_values($a_msg_headers), $from, min($cnt-$to, $this->page_size)); - if ($slice) + if ($slice) { $a_msg_headers = array_slice($a_msg_headers, -$slice, $slice); + } return $a_msg_headers; } @@ -1062,56 +982,60 @@ class rcube_imap /** - * Private method for listing a set of threaded message headers (search results) + * protected method for listing a set of threaded message headers (search results) * - * @param string $mailbox Mailbox/folder name + * @param string $folder Folder name * @param int $page Current page to list * @param int $slice Number of slice items to extract from result array * * @return array Indexed array with message header objects - * @access private - * @see rcube_imap::list_header_set() + * @see rcube_imap::list_search_messages() */ - private function _list_thread_header_set($mailbox, $page, $slice=0) + protected function list_search_thread_messages($folder, $page, $slice=0) { // update search_set if previous data was fetched with disabled threading if (!$this->search_threads) { - if ($this->search_set->isEmpty()) + if ($this->search_set->is_empty()) { return array(); + } $this->search('', $this->search_string, $this->search_charset, $this->sort_field); } - return $this->_fetch_thread_headers($mailbox, clone $this->search_set, $page, $slice); + return $this->fetch_thread_headers($folder, clone $this->search_set, $page, $slice); } /** * Fetches messages headers (by UID) * - * @param string $mailbox Mailbox name + * @param string $folder Folder name * @param array $msgs Message UIDs * @param bool $sort Enables result sorting by $msgs * @param bool $force Disables cache use * * @return array Messages headers indexed by UID - * @access private */ - function fetch_headers($mailbox, $msgs, $sort = true, $force = false) + function fetch_headers($folder, $msgs, $sort = true, $force = false) { - if (empty($msgs)) + if (empty($msgs)) { return array(); + } if (!$force && ($mcache = $this->get_mcache_engine())) { - $headers = $mcache->get_messages($mailbox, $msgs); + $headers = $mcache->get_messages($folder, $msgs); + } + else if (!$this->check_connection()) { + return array(); } else { // fetch reqested headers from server $headers = $this->conn->fetchHeaders( - $mailbox, $msgs, true, false, $this->get_fetch_headers()); + $folder, $msgs, true, false, $this->get_fetch_headers()); } - if (empty($headers)) + if (empty($headers)) { return array(); + } foreach ($headers as $h) { $a_msg_headers[$h->uid] = $h; @@ -1129,23 +1053,24 @@ class rcube_imap /** - * Returns current status of mailbox + * Returns current status of folder * * We compare the maximum UID to determine the number of * new messages because the RECENT flag is not reliable. * - * @param string $mailbox Mailbox/folder name + * @param string $folder Folder name + * * @return int Folder status */ - public function mailbox_status($mailbox = null) + public function folder_status($folder = null) { - if (!strlen($mailbox)) { - $mailbox = $this->mailbox; + if (!strlen($folder)) { + $folder = $this->folder; } - $old = $this->get_folder_stats($mailbox); + $old = $this->get_folder_stats($folder); // refresh message count -> will update - $this->_messagecount($mailbox, 'ALL', true); + $this->messagecount($folder, 'ALL', true); $result = 0; @@ -1153,14 +1078,16 @@ class rcube_imap return $result; } - $new = $this->get_folder_stats($mailbox); + $new = $this->get_folder_stats($folder); // got new messages - if ($new['maxuid'] > $old['maxuid']) + if ($new['maxuid'] > $old['maxuid']) { $result += 1; + } // some messages has been deleted - if ($new['cnt'] < $old['cnt']) + if ($new['cnt'] < $old['cnt']) { $result += 2; + } // @TODO: optional checking for messages flags changes (?) // @TODO: UIDVALIDITY checking @@ -1173,71 +1100,76 @@ class rcube_imap * Stores folder statistic data in session * @TODO: move to separate DB table (cache?) * - * @param string $mailbox Mailbox name + * @param string $folder Folder name * @param string $name Data name * @param mixed $data Data value */ - private function set_folder_stats($mailbox, $name, $data) + protected function set_folder_stats($folder, $name, $data) { - $_SESSION['folders'][$mailbox][$name] = $data; + $_SESSION['folders'][$folder][$name] = $data; } /** * Gets folder statistic data * - * @param string $mailbox Mailbox name + * @param string $folder Folder name * * @return array Stats data */ - private function get_folder_stats($mailbox) + protected function get_folder_stats($folder) { - if ($_SESSION['folders'][$mailbox]) - return (array) $_SESSION['folders'][$mailbox]; - else - return array(); + if ($_SESSION['folders'][$folder]) { + return (array) $_SESSION['folders'][$folder]; + } + + return array(); } /** * Return sorted list of message UIDs * - * @param string $mailbox Mailbox to get index from + * @param string $folder Folder to get index from * @param string $sort_field Sort column * @param string $sort_order Sort order [ASC, DESC] * * @return rcube_result_index|rcube_result_thread List of messages (UIDs) */ - public function message_index($mailbox='', $sort_field=NULL, $sort_order=NULL) + public function index($folder = '', $sort_field = NULL, $sort_order = NULL) { - if ($this->threading) - return $this->thread_index($mailbox, $sort_field, $sort_order); + if ($this->threading) { + return $this->thread_index($folder, $sort_field, $sort_order); + } $this->set_sort_order($sort_field, $sort_order); - if (!strlen($mailbox)) { - $mailbox = $this->mailbox; + if (!strlen($folder)) { + $folder = $this->folder; } // we have a saved search result, get index from there if ($this->search_string) { if ($this->search_threads) { - $this->search($mailbox, $this->search_string, $this->search_charset, $this->sort_field); + $this->search($folder, $this->search_string, $this->search_charset, $this->sort_field); } // use message index sort as default sorting if (!$this->sort_field || $this->search_sorted) { if ($this->sort_field && $this->search_sort_field != $this->sort_field) { - $this->search($mailbox, $this->search_string, $this->search_charset, $this->sort_field); + $this->search($folder, $this->search_string, $this->search_charset, $this->sort_field); } $index = $this->search_set; } + else if (!$this->check_connection()) { + return new rcube_result_index(); + } else { - $index = $this->conn->index($mailbox, $this->search_set->get(), - $this->sort_field, $this->skip_deleted, true, true); + $index = $this->conn->index($folder, $this->search_set->get(), + $this->sort_field, $this->options['skip_deleted'], true, true); } - if ($this->sort_order != $index->getParameters('ORDER')) { + if ($this->sort_order != $index->get_parameters('ORDER')) { $index->revert(); } @@ -1246,12 +1178,12 @@ class rcube_imap // check local cache if ($mcache = $this->get_mcache_engine()) { - $index = $mcache->get_index($mailbox, $this->sort_field, $this->sort_order); + $index = $mcache->get_index($folder, $this->sort_field, $this->sort_order); } // fetch from IMAP server else { - $index = $this->message_index_direct( - $mailbox, $this->sort_field, $this->sort_order); + $index = $this->index_direct( + $folder, $this->sort_field, $this->sort_order); } return $index; @@ -1262,44 +1194,50 @@ class rcube_imap * Return sorted list of message UIDs ignoring current search settings. * Doesn't uses cache by default. * - * @param string $mailbox Mailbox to get index from + * @param string $folder Folder to get index from * @param string $sort_field Sort column * @param string $sort_order Sort order [ASC, DESC] * @param bool $skip_cache Disables cache usage * * @return rcube_result_index Sorted list of message UIDs */ - public function message_index_direct($mailbox, $sort_field = null, $sort_order = null, $skip_cache = true) + public function index_direct($folder, $sort_field = null, $sort_order = null, $skip_cache = true) { if (!$skip_cache && ($mcache = $this->get_mcache_engine())) { - $index = $mcache->get_index($mailbox, $sort_field, $sort_order); + $index = $mcache->get_index($folder, $sort_field, $sort_order); } // use message index sort as default sorting else if (!$sort_field) { - if ($this->skip_deleted && !empty($this->icache['undeleted_idx']) - && $this->icache['undeleted_idx']->getParameters('MAILBOX') == $mailbox + if ($this->options['skip_deleted'] && !empty($this->icache['undeleted_idx']) + && $this->icache['undeleted_idx']->get_parameters('MAILBOX') == $folder ) { $index = $this->icache['undeleted_idx']; } + else if (!$this->check_connection()) { + return new rcube_result_index(); + } else { - $index = $this->conn->search($mailbox, - 'ALL' .($this->skip_deleted ? ' UNDELETED' : ''), true); + $index = $this->conn->search($folder, + 'ALL' .($this->options['skip_deleted'] ? ' UNDELETED' : ''), true); } } + else if (!$this->check_connection()) { + return new rcube_result_index(); + } // fetch complete message index else { if ($this->get_capability('SORT')) { - $index = $this->conn->sort($mailbox, $sort_field, - $this->skip_deleted ? 'UNDELETED' : '', true); + $index = $this->conn->sort($folder, $sort_field, + $this->options['skip_deleted'] ? 'UNDELETED' : '', true); } - if (empty($index) || $index->isError()) { - $index = $this->conn->index($mailbox, "1:*", $sort_field, - $this->skip_deleted, false, true); + if (empty($index) || $index->is_error()) { + $index = $this->conn->index($folder, "1:*", $sort_field, + $this->options['skip_deleted'], false, true); } } - if ($sort_order != $index->getParameters('ORDER')) { + if ($sort_order != $index->get_parameters('ORDER')) { $index->revert(); } @@ -1310,25 +1248,25 @@ class rcube_imap /** * Return index of threaded message UIDs * - * @param string $mailbox Mailbox to get index from + * @param string $folder Folder to get index from * @param string $sort_field Sort column * @param string $sort_order Sort order [ASC, DESC] * * @return rcube_result_thread Message UIDs */ - function thread_index($mailbox='', $sort_field=NULL, $sort_order=NULL) + public function thread_index($folder='', $sort_field=NULL, $sort_order=NULL) { - if (!strlen($mailbox)) { - $mailbox = $this->mailbox; + if (!strlen($folder)) { + $folder = $this->folder; } // we have a saved search result, get index from there - if ($this->search_string && $this->search_threads && $mailbox == $this->mailbox) { + if ($this->search_string && $this->search_threads && $folder == $this->folder) { $threads = $this->search_set; } else { // get all threads (default sort order) - $threads = $this->fetch_threads($mailbox); + $threads = $this->fetch_threads($folder); } $this->set_sort_order($sort_field, $sort_order); @@ -1343,9 +1281,9 @@ class rcube_imap * * @param rcube_result_thread $threads Threads result set */ - private function sort_threads($threads) + protected function sort_threads($threads) { - if ($threads->isEmpty()) { + if ($threads->is_empty()) { return; } @@ -1354,14 +1292,14 @@ class rcube_imap // THREAD=REFS: sorting by the most recent date in each thread if ($this->sort_field && ($this->sort_field != 'date' || $this->get_capability('THREAD') != 'REFS')) { - $index = $this->message_index_direct($this->mailbox, $this->sort_field, $this->sort_order, false); + $index = $this->index_direct($this->folder, $this->sort_field, $this->sort_order, false); - if (!$index->isEmpty()) { + if (!$index->is_empty()) { $threads->sort($index); } } else { - if ($this->sort_order != $threads->getParameters('ORDER')) { + if ($this->sort_order != $threads->get_parameters('ORDER')) { $threads->revert(); } } @@ -1371,23 +1309,24 @@ class rcube_imap /** * Invoke search request to IMAP server * - * @param string $mailbox Mailbox name to search in + * @param string $folder Folder name to search in * @param string $str Search criteria * @param string $charset Search charset * @param string $sort_field Header field to sort by - * @access public + * * @todo: Search criteria should be provided in non-IMAP format, eg. array */ - function search($mailbox='', $str='ALL', $charset=NULL, $sort_field=NULL) + public function search($folder='', $str='ALL', $charset=NULL, $sort_field=NULL) { - if (!$str) + if (!$str) { $str = 'ALL'; + } - if (!strlen($mailbox)) { - $mailbox = $this->mailbox; + if (!strlen($folder)) { + $folder = $this->folder; } - $results = $this->_search_index($mailbox, $str, $charset, $sort_field); + $results = $this->search_index($folder, $str, $charset, $sort_field); $this->set_search_set(array($str, $results, $charset, $sort_field, $this->threading || $this->search_sorted ? true : false)); @@ -1395,9 +1334,37 @@ class rcube_imap /** - * Private search method + * Direct (real and simple) SEARCH request (without result sorting and caching). * - * @param string $mailbox Mailbox name + * @param string $mailbox Mailbox name to search in + * @param string $str Search string + * + * @return rcube_result_index Search result (UIDs) + */ + public function search_once($mailbox = null, $str = 'ALL') + { + if (!$str) { + return 'ALL'; + } + + if (!strlen($mailbox)) { + $mailbox = $this->mailbox; + } + + if (!$this->check_connection()) { + return new rcube_result_index(); + } + + $index = $this->conn->search($mailbox, $str, true); + + return $index; + } + + + /** + * protected search method + * + * @param string $folder Folder name * @param string $criteria Search criteria * @param string $charset Charset * @param string $sort_field Sorting field @@ -1405,48 +1372,61 @@ class rcube_imap * @return rcube_result_index|rcube_result_thread Search results (UIDs) * @see rcube_imap::search() */ - private function _search_index($mailbox, $criteria='ALL', $charset=NULL, $sort_field=NULL) + protected function search_index($folder, $criteria='ALL', $charset=NULL, $sort_field=NULL) { $orig_criteria = $criteria; - if ($this->skip_deleted && !preg_match('/UNDELETED/', $criteria)) + if (!$this->check_connection()) { + if ($this->threading) { + return new rcube_result_thread(); + } + else { + return new rcube_result_index(); + } + } + + if ($this->options['skip_deleted'] && !preg_match('/UNDELETED/', $criteria)) { $criteria = 'UNDELETED '.$criteria; + } if ($this->threading) { - $threads = $this->conn->thread($mailbox, $this->threading, $criteria, true, $charset); + $threads = $this->conn->thread($folder, $this->threading, $criteria, true, $charset); // Error, try with US-ASCII (RFC5256: SORT/THREAD must support US-ASCII and UTF-8, // but I've seen that Courier doesn't support UTF-8) - if ($threads->isError() && $charset && $charset != 'US-ASCII') - $threads = $this->conn->thread($mailbox, $this->threading, + if ($threads->is_error() && $charset && $charset != 'US-ASCII') { + $threads = $this->conn->thread($folder, $this->threading, $this->convert_criteria($criteria, $charset), true, 'US-ASCII'); + } return $threads; } if ($sort_field && $this->get_capability('SORT')) { $charset = $charset ? $charset : $this->default_charset; - $messages = $this->conn->sort($mailbox, $sort_field, $criteria, true, $charset); + $messages = $this->conn->sort($folder, $sort_field, $criteria, true, $charset); // Error, try with US-ASCII (RFC5256: SORT/THREAD must support US-ASCII and UTF-8, // but I've seen Courier with disabled UTF-8 support) - if ($messages->isError() && $charset && $charset != 'US-ASCII') - $messages = $this->conn->sort($mailbox, $sort_field, + if ($messages->is_error() && $charset && $charset != 'US-ASCII') { + $messages = $this->conn->sort($folder, $sort_field, $this->convert_criteria($criteria, $charset), true, 'US-ASCII'); + } - if (!$messages->isError()) { + if (!$messages->is_error()) { $this->search_sorted = true; return $messages; } } - $messages = $this->conn->search($mailbox, + $messages = $this->conn->search($folder, ($charset ? "CHARSET $charset " : '') . $criteria, true); // Error, try with US-ASCII (some servers may support only US-ASCII) - if ($messages->isError() && $charset && $charset != 'US-ASCII') - $messages = $this->conn->search($mailbox, + if ($messages->is_error() && $charset && $charset != 'US-ASCII') { + $messages = $this->conn->search($folder, $this->convert_criteria($criteria, $charset), true); + } $this->search_sorted = false; @@ -1455,40 +1435,15 @@ class rcube_imap /** - * Direct (real and simple) SEARCH request to IMAP server, - * without result sorting and caching - * - * @param string $mailbox Mailbox name to search in - * @param string $str Search string - * @param boolean $ret_uid True if UIDs should be returned - * - * @return rcube_result_index Search result (UIDs) - */ - function search_once($mailbox='', $str='ALL') - { - if (!$str) - return 'ALL'; - - if (!strlen($mailbox)) { - $mailbox = $this->mailbox; - } - - $index = $this->conn->search($mailbox, $str, true); - - return $index; - } - - - /** * Converts charset of search criteria string * * @param string $str Search string * @param string $charset Original charset * @param string $dest_charset Destination charset (default US-ASCII) + * * @return string Search string - * @access private */ - private function convert_criteria($str, $charset, $dest_charset='US-ASCII') + protected function convert_criteria($str, $charset, $dest_charset='US-ASCII') { // convert strings to US_ASCII if (preg_match_all('/\{([0-9]+)\}\r\n/', $str, $matches, PREG_OFFSET_CAPTURE)) { @@ -1497,16 +1452,20 @@ class rcube_imap $string_offset = $m[1] + strlen($m[0]) + 4; // {}\r\n $string = substr($str, $string_offset - 1, $m[0]); $string = rcube_charset_convert($string, $charset, $dest_charset); - if ($string === false) + if ($string === false) { continue; + } $res .= substr($str, $last, $m[1] - $last - 1) . rcube_imap_generic::escape($string); $last = $m[0] + $string_offset - 1; } - if ($last < strlen($str)) + if ($last < strlen($str)) { $res .= substr($str, $last, strlen($str)-$last); + } } - else // strings for conversion not found + // strings for conversion not found + else { $res = $str; + } return $res; } @@ -1517,7 +1476,7 @@ class rcube_imap * * @return array Current search set */ - function refresh_search() + public function refresh_search() { if (!empty($this->search_string)) { $this->search('', $this->search_string, $this->search_charset, $this->search_sort_field); @@ -1530,25 +1489,28 @@ class rcube_imap /** * Return message headers object of a specific message * - * @param int $id Message sequence ID or UID - * @param string $mailbox Mailbox to read from + * @param int $id Message UID + * @param string $folder Folder to read from * @param bool $force True to skip cache * * @return rcube_mail_header Message headers */ - function get_headers($uid, $mailbox = null, $force = false) + public function get_message_headers($uid, $folder = null, $force = false) { - if (!strlen($mailbox)) { - $mailbox = $this->mailbox; + if (!strlen($folder)) { + $folder = $this->folder; } // get cached headers if (!$force && $uid && ($mcache = $this->get_mcache_engine())) { - $headers = $mcache->get_message($mailbox, $uid); + $headers = $mcache->get_message($folder, $uid); + } + else if (!$this->check_connection()) { + $headers = false; } else { $headers = $this->conn->fetchHeader( - $mailbox, $uid, true, true, $this->get_fetch_headers()); + $folder, $uid, true, true, $this->get_fetch_headers()); } return $headers; @@ -1560,14 +1522,14 @@ class rcube_imap * an object structure similar to the one generated by PEAR::Mail_mimeDecode * * @param int $uid Message UID to fetch - * @param string $mailbox Mailbox to read from + * @param string $folder Folder to read from * * @return object rcube_mail_header Message data */ - function get_message($uid, $mailbox = null) + public function get_message($uid, $folder = null) { - if (!strlen($mailbox)) { - $mailbox = $this->mailbox; + if (!strlen($folder)) { + $folder = $this->folder; } // Check internal cache @@ -1577,32 +1539,41 @@ class rcube_imap } } - $headers = $this->get_headers($uid, $mailbox); + $headers = $this->get_message_headers($uid, $folder); // message doesn't exist? - if (empty($headers)) + if (empty($headers)) { return null; + } // structure might be cached - if (!empty($headers->structure)) + if (!empty($headers->structure)) { return $headers; + } - $this->_msg_uid = $uid; + $this->msg_uid = $uid; + + if (!$this->check_connection()) { + return $headers; + } if (empty($headers->bodystructure)) { - $headers->bodystructure = $this->conn->getStructure($mailbox, $uid, true); + $headers->bodystructure = $this->conn->getStructure($folder, $uid, true); } $structure = $headers->bodystructure; - if (empty($structure)) + if (empty($structure)) { return $headers; + } // set message charset from message headers - if ($headers->charset) + if ($headers->charset) { $this->struct_charset = $headers->charset; - else - $this->struct_charset = $this->_structure_charset($structure); + } + else { + $this->struct_charset = $this->structure_charset($structure); + } $headers->ctype = strtolower($headers->ctype); @@ -1618,11 +1589,12 @@ class rcube_imap $structure[0] = $m[1]; $structure[1] = $m[2]; } - else + else { return $headers; + } } - $struct = $this->_structure_part($structure, 0, '', $headers); + $struct = $this->structure_part($structure, 0, '', $headers); // don't trust given content-type if (empty($struct->parts) && !empty($headers->ctype)) { @@ -1643,9 +1615,8 @@ class rcube_imap * @param array $part * @param int $count * @param string $parent - * @access private */ - private function _structure_part($part, $count=0, $parent='', $mime_headers=null) + protected function structure_part($part, $count=0, $parent='', $mime_headers=null) { $struct = new rcube_message_part; $struct->mime_id = empty($parent) ? (string)$count : "$parent.$count"; @@ -1678,8 +1649,9 @@ class rcube_imap // build parts list for headers pre-fetching for ($i=0; $i<count($part); $i++) { - if (!is_array($part[$i])) + if (!is_array($part[$i])) { break; + } // fetch message headers if message/rfc822 // or named part (could contain Content-Location header) if (!is_array($part[$i][0])) { @@ -1697,16 +1669,17 @@ class rcube_imap // @TODO: we could do this before _structure_part() call, to fetch // headers for parts on all levels if ($mime_part_headers) { - $mime_part_headers = $this->conn->fetchMIMEHeaders($this->mailbox, - $this->_msg_uid, $mime_part_headers); + $mime_part_headers = $this->conn->fetchMIMEHeaders($this->folder, + $this->msg_uid, $mime_part_headers); } $struct->parts = array(); for ($i=0, $count=0; $i<count($part); $i++) { - if (!is_array($part[$i])) + if (!is_array($part[$i])) { break; + } $tmp_part_id = $struct->mime_id ? $struct->mime_id.'.'.($i+1) : $i+1; - $struct->parts[] = $this->_structure_part($part[$i], ++$count, $struct->mime_id, + $struct->parts[] = $this->structure_part($part[$i], ++$count, $struct->mime_id, $mime_part_headers[$tmp_part_id]); } @@ -1742,11 +1715,13 @@ class rcube_imap // read content type parameters if (is_array($part[2])) { $struct->ctype_parameters = array(); - for ($i=0; $i<count($part[2]); $i+=2) + for ($i=0; $i<count($part[2]); $i+=2) { $struct->ctype_parameters[strtolower($part[2][$i])] = $part[2][$i+1]; + } - if (isset($struct->ctype_parameters['charset'])) + if (isset($struct->ctype_parameters['charset'])) { $struct->charset = $struct->ctype_parameters['charset']; + } } // #1487700: workaround for lack of charset in malformed structure @@ -1761,29 +1736,37 @@ class rcube_imap } // get part size - if (!empty($part[6])) + if (!empty($part[6])) { $struct->size = intval($part[6]); + } // read part disposition $di = 8; - if ($struct->ctype_primary == 'text') $di += 1; - else if ($struct->mimetype == 'message/rfc822') $di += 3; + if ($struct->ctype_primary == 'text') { + $di += 1; + } + else if ($struct->mimetype == 'message/rfc822') { + $di += 3; + } if (is_array($part[$di]) && count($part[$di]) == 2) { $struct->disposition = strtolower($part[$di][0]); - if (is_array($part[$di][1])) - for ($n=0; $n<count($part[$di][1]); $n+=2) + if (is_array($part[$di][1])) { + for ($n=0; $n<count($part[$di][1]); $n+=2) { $struct->d_parameters[strtolower($part[$di][1][$n])] = $part[$di][1][$n+1]; + } + } } // get message/rfc822's child-parts if (is_array($part[8]) && $di != 8) { $struct->parts = array(); for ($i=0, $count=0; $i<count($part[8]); $i++) { - if (!is_array($part[8][$i])) + if (!is_array($part[8][$i])) { break; - $struct->parts[] = $this->_structure_part($part[8][$i], ++$count, $struct->mime_id); + } + $struct->parts[] = $this->structure_part($part[8][$i], ++$count, $struct->mime_id); } } @@ -1792,44 +1775,51 @@ class rcube_imap $struct->content_id = $part[3]; $struct->headers['content-id'] = $part[3]; - if (empty($struct->disposition)) + if (empty($struct->disposition)) { $struct->disposition = 'inline'; + } } // fetch message headers if message/rfc822 or named part (could contain Content-Location header) if ($struct->ctype_primary == 'message' || ($struct->ctype_parameters['name'] && !$struct->content_id)) { if (empty($mime_headers)) { $mime_headers = $this->conn->fetchPartHeader( - $this->mailbox, $this->_msg_uid, true, $struct->mime_id); + $this->folder, $this->msg_uid, true, $struct->mime_id); } - if (is_string($mime_headers)) + if (is_string($mime_headers)) { $struct->headers = rcube_mime::parse_headers($mime_headers) + $struct->headers; - else if (is_object($mime_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') { // single-part - if (!is_array($part[8][0])) + if (!is_array($part[8][0])) { $struct->real_mimetype = strtolower($part[8][0] . '/' . $part[8][1]); + } // multi-part else { - for ($n=0; $n<count($part[8]); $n++) - if (!is_array($part[8][$n])) + for ($n=0; $n<count($part[8]); $n++) { + if (!is_array($part[8][$n])) { break; + } + } $struct->real_mimetype = 'multipart/' . strtolower($part[8][$n]); } } if ($struct->ctype_primary == 'message' && empty($struct->parts)) { - if (is_array($part[8]) && $di != 8) - $struct->parts[] = $this->_structure_part($part[8], ++$count, $struct->mime_id); + if (is_array($part[8]) && $di != 8) { + $struct->parts[] = $this->structure_part($part[8], ++$count, $struct->mime_id); + } } } // normalize filename property - $this->_set_part_filename($struct, $mime_headers); + $this->set_part_filename($struct, $mime_headers); return $struct; } @@ -1840,16 +1830,18 @@ class rcube_imap * * @param rcube_message_part $part Part object * @param string $headers Part's raw headers - * @access private */ - private function _set_part_filename(&$part, $headers=null) + protected function set_part_filename(&$part, $headers=null) { - if (!empty($part->d_parameters['filename'])) + if (!empty($part->d_parameters['filename'])) { $filename_mime = $part->d_parameters['filename']; - else if (!empty($part->d_parameters['filename*'])) + } + else if (!empty($part->d_parameters['filename*'])) { $filename_encoded = $part->d_parameters['filename*']; - else if (!empty($part->ctype_parameters['name*'])) + } + else if (!empty($part->ctype_parameters['name*'])) { $filename_encoded = $part->ctype_parameters['name*']; + } // RFC2231 value continuations // TODO: this should be rewrited to support RFC2231 4.1 combinations else if (!empty($part->d_parameters['filename*0'])) { @@ -1863,7 +1855,7 @@ class rcube_imap if ($i<2) { if (!$headers) { $headers = $this->conn->fetchPartHeader( - $this->mailbox, $this->_msg_uid, true, $part->mime_id); + $this->folder, $this->msg_uid, true, $part->mime_id); } $filename_mime = ''; $i = 0; @@ -1882,7 +1874,7 @@ class rcube_imap if ($i<2) { if (!$headers) { $headers = $this->conn->fetchPartHeader( - $this->mailbox, $this->_msg_uid, true, $part->mime_id); + $this->folder, $this->msg_uid, true, $part->mime_id); } $filename_encoded = ''; $i = 0; $matches = array(); @@ -1901,7 +1893,7 @@ class rcube_imap if ($i<2) { if (!$headers) { $headers = $this->conn->fetchPartHeader( - $this->mailbox, $this->_msg_uid, true, $part->mime_id); + $this->folder, $this->msg_uid, true, $part->mime_id); } $filename_mime = ''; $i = 0; $matches = array(); @@ -1920,7 +1912,7 @@ class rcube_imap if ($i<2) { if (!$headers) { $headers = $this->conn->fetchPartHeader( - $this->mailbox, $this->_msg_uid, true, $part->mime_id); + $this->folder, $this->msg_uid, true, $part->mime_id); } $filename_encoded = ''; $i = 0; $matches = array(); @@ -1931,22 +1923,28 @@ class rcube_imap } } // read 'name' after rfc2231 parameters as it may contains truncated filename (from Thunderbird) - else if (!empty($part->ctype_parameters['name'])) + else if (!empty($part->ctype_parameters['name'])) { $filename_mime = $part->ctype_parameters['name']; + } // Content-Disposition - else if (!empty($part->headers['content-description'])) + else if (!empty($part->headers['content-description'])) { $filename_mime = $part->headers['content-description']; - else + } + else { return; + } // decode filename if (!empty($filename_mime)) { - if (!empty($part->charset)) + if (!empty($part->charset)) { $charset = $part->charset; - else if (!empty($this->struct_charset)) + } + else if (!empty($this->struct_charset)) { $charset = $this->struct_charset; - else + } + else { $charset = rc_detect_encoding($filename_mime, $this->default_charset); + } $part->filename = rcube_mime::decode_mime_string($filename_mime, $charset); } @@ -1966,14 +1964,15 @@ class rcube_imap * Get charset name from message structure (first part) * * @param array $structure Message structure + * * @return string Charset name - * @access private */ - private function _structure_charset($structure) + protected function structure_charset($structure) { while (is_array($structure)) { - if (is_array($structure[2]) && $structure[2][0] == 'charset') + if (is_array($structure[2]) && $structure[2][0] == 'charset') { return $structure[2][1]; + } $structure = $structure[0]; } } @@ -1991,11 +1990,15 @@ class rcube_imap * * @return string Message/part body if not printed */ - function get_message_part($uid, $part=1, $o_part=NULL, $print=NULL, $fp=NULL, $skip_charset_conv=false) + public function get_message_part($uid, $part=1, $o_part=NULL, $print=NULL, $fp=NULL, $skip_charset_conv=false) { + if (!$this->check_connection()) { + return null; + } + // get part data if not provided if (!is_object($o_part)) { - $structure = $this->conn->getStructure($this->mailbox, $uid, true); + $structure = $this->conn->getStructure($this->folder, $uid, true); $part_data = rcube_imap_generic::getStructurePartData($structure, $part); $o_part = new rcube_message_part; @@ -2006,7 +2009,7 @@ class rcube_imap } if ($o_part && $o_part->size) { - $body = $this->conn->handlePartBody($this->mailbox, $uid, true, + $body = $this->conn->handlePartBody($this->folder, $uid, true, $part ? $part : 'TEXT', $o_part->encoding, $print, $fp); } @@ -2024,10 +2027,12 @@ class rcube_imap if (!$skip_charset_conv) { if (!$o_part->charset || strtoupper($o_part->charset) == 'US-ASCII') { // try to extract charset information from HTML meta tag (#1488125) - if ($o_part->ctype_secondary == 'html' && preg_match('/<meta[^>]+charset=([a-z0-9-_]+)/i', $body, $m)) + if ($o_part->ctype_secondary == 'html' && preg_match('/<meta[^>]+charset=([a-z0-9-_]+)/i', $body, $m)) { $o_part->charset = strtoupper($m[1]); - else + } + else { $o_part->charset = $this->default_charset; + } } $body = rcube_charset_convert($body, $o_part->charset); } @@ -2038,21 +2043,6 @@ class rcube_imap /** - * Fetch message body of a specific message from the server - * - * @param int $uid Message UID - * @return string $part Message/part body - * @see rcube_imap::get_message_part() - */ - function get_body($uid, $part=1) - { - $headers = $this->get_headers($uid); - return rcube_charset_convert($this->get_message_part($uid, $part, NULL), - $headers->charset ? $headers->charset : $this->default_charset); - } - - - /** * Returns the whole message source as string (or saves to a file) * * @param int $uid Message UID @@ -2060,9 +2050,13 @@ class rcube_imap * * @return string Message source string */ - function get_raw_body($uid, $fp=null) + public function get_raw_body($uid, $fp=null) { - return $this->conn->handlePartBody($this->mailbox, $uid, + if (!$this->check_connection()) { + return null; + } + + return $this->conn->handlePartBody($this->folder, $uid, true, null, null, false, $fp); } @@ -2071,22 +2065,29 @@ class rcube_imap * Returns the message headers as string * * @param int $uid Message UID + * * @return string Message headers string */ - function get_raw_headers($uid) + public function get_raw_headers($uid) { - return $this->conn->fetchPartHeader($this->mailbox, $uid, true); + if (!$this->check_connection()) { + return null; + } + + return $this->conn->fetchPartHeader($this->folder, $uid, true); } /** * Sends the whole message source to stdout - * - * @param int $uid Message UID */ - function print_raw_body($uid) + public function print_raw_body($uid) { - $this->conn->handlePartBody($this->mailbox, $uid, true, NULL, NULL, true); + if (!$this->check_connection()) { + return; + } + + $this->conn->handlePartBody($this->folder, $uid, true, NULL, NULL, true); } @@ -2095,24 +2096,30 @@ class rcube_imap * * @param mixed $uids Message UIDs as array or comma-separated string, or '*' * @param string $flag Flag to set: SEEN, UNDELETED, DELETED, RECENT, ANSWERED, DRAFT, MDNSENT - * @param string $mailbox Folder name + * @param string $folder Folder name * @param boolean $skip_cache True to skip message cache clean up * * @return boolean Operation status */ - function set_flag($uids, $flag, $mailbox=null, $skip_cache=false) + public function set_flag($uids, $flag, $folder=null, $skip_cache=false) { - if (!strlen($mailbox)) { - $mailbox = $this->mailbox; + if (!strlen($folder)) { + $folder = $this->folder; + } + + if (!$this->check_connection()) { + return false; } $flag = strtoupper($flag); - list($uids, $all_mode) = $this->_parse_uids($uids, $mailbox); + list($uids, $all_mode) = $this->parse_uids($uids); - if (strpos($flag, 'UN') === 0) - $result = $this->conn->unflag($mailbox, $uids, substr($flag, 2)); - else - $result = $this->conn->flag($mailbox, $uids, $flag); + if (strpos($flag, 'UN') === 0) { + $result = $this->conn->unflag($folder, $uids, substr($flag, 2)); + } + else { + $result = $this->conn->flag($folder, $uids, $flag); + } if ($result) { // reload message headers if cached @@ -2120,17 +2127,17 @@ class rcube_imap if (!$skip_cache && ($mcache = $this->get_mcache_engine())) { $status = strpos($flag, 'UN') !== 0; $mflag = preg_replace('/^UN/', '', $flag); - $mcache->change_flag($mailbox, $all_mode ? null : explode(',', $uids), + $mcache->change_flag($folder, $all_mode ? null : explode(',', $uids), $mflag, $status); } // clear cached counters if ($flag == 'SEEN' || $flag == 'UNSEEN') { - $this->_clear_messagecount($mailbox, 'SEEN'); - $this->_clear_messagecount($mailbox, 'UNSEEN'); + $this->clear_messagecount($folder, 'SEEN'); + $this->clear_messagecount($folder, 'UNSEEN'); } else if ($flag == 'DELETED') { - $this->_clear_messagecount($mailbox, 'DELETED'); + $this->clear_messagecount($folder, 'DELETED'); } } @@ -2139,48 +2146,34 @@ class rcube_imap /** - * Remove message flag for one or several messages - * - * @param mixed $uids Message UIDs as array or comma-separated string, or '*' - * @param string $flag Flag to unset: SEEN, DELETED, RECENT, ANSWERED, DRAFT, MDNSENT - * @param string $mailbox Folder name - * - * @return int Number of flagged messages, -1 on failure - * @see set_flag - */ - function unset_flag($uids, $flag, $mailbox=null) - { - return $this->set_flag($uids, 'UN'.$flag, $mailbox); - } - - - /** - * Append a mail message (source) to a specific mailbox + * Append a mail message (source) to a specific folder * - * @param string $mailbox Target mailbox + * @param string $folder Target folder * @param string $message The message source string or filename * @param string $headers Headers string if $message contains only the body * @param boolean $is_file True if $message is a filename * * @return int|bool Appended message UID or True on success, False on error */ - function save_message($mailbox, &$message, $headers='', $is_file=false) + public function save_message($folder, &$message, $headers='', $is_file=false) { - if (!strlen($mailbox)) { - $mailbox = $this->mailbox; + if (!strlen($folder)) { + $folder = $this->folder; } - // make sure mailbox exists - if ($this->mailbox_exists($mailbox)) { - if ($is_file) - $saved = $this->conn->appendFromFile($mailbox, $message, $headers); - else - $saved = $this->conn->append($mailbox, $message); + // make sure folder exists + if ($this->folder_exists($folder)) { + if ($is_file) { + $saved = $this->conn->appendFromFile($folder, $message, $headers); + } + else { + $saved = $this->conn->append($folder, $message); + } } if ($saved) { - // increase messagecount of the target mailbox - $this->_set_messagecount($mailbox, 'ALL', 1); + // increase messagecount of the target folder + $this->set_messagecount($folder, 'ALL', 1); } return $saved; @@ -2188,33 +2181,39 @@ class rcube_imap /** - * Move a message from one mailbox to another + * Move a message from one folder to another * * @param mixed $uids Message UIDs as array or comma-separated string, or '*' - * @param string $to_mbox Target mailbox - * @param string $from_mbox Source mailbox + * @param string $to_mbox Target folder + * @param string $from_mbox Source folder + * * @return boolean True on success, False on error */ - function move_message($uids, $to_mbox, $from_mbox='') + public function move_message($uids, $to_mbox, $from_mbox='') { if (!strlen($from_mbox)) { - $from_mbox = $this->mailbox; + $from_mbox = $this->folder; } if ($to_mbox === $from_mbox) { return false; } - list($uids, $all_mode) = $this->_parse_uids($uids, $from_mbox); + list($uids, $all_mode) = $this->parse_uids($uids); // 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($to_mbox)) { + if (!$this->check_connection()) { + return false; + } + + // make sure folder exists + if ($to_mbox != 'INBOX' && !$this->folder_exists($to_mbox)) { if (in_array($to_mbox, $this->default_folders)) { - if (!$this->create_mailbox($to_mbox, true)) { + if (!$this->create_folder($to_mbox, true)) { return false; } } @@ -2236,11 +2235,11 @@ class rcube_imap $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 + // really deleted from the source folder if ($moved) { - $this->_expunge($from_mbox, false, $uids); - $this->_clear_messagecount($from_mbox); - $this->_clear_messagecount($to_mbox); + $this->expunge_message($uids, $from_mbox, false); + $this->clear_messagecount($from_mbox); + $this->clear_messagecount($to_mbox); } // moving failed else if ($to_trash && $config->get('delete_always', false)) { @@ -2252,12 +2251,14 @@ class rcube_imap unset($this->icache['threads']); // remove message ids from search set - if ($this->search_set && $from_mbox == $this->mailbox) { + if ($this->search_set && $from_mbox == $this->folder) { // threads are too complicated to just remove messages from set - if ($this->search_threads || $all_mode) + if ($this->search_threads || $all_mode) { $this->refresh_search(); - else + } + else { $this->search_set->filter(explode(',', $uids)); + } } // remove cached messages @@ -2270,30 +2271,35 @@ class rcube_imap /** - * Copy a message from one mailbox to another + * Copy a message from one folder to another * * @param mixed $uids Message UIDs as array or comma-separated string, or '*' - * @param string $to_mbox Target mailbox - * @param string $from_mbox Source mailbox + * @param string $to_mbox Target folder + * @param string $from_mbox Source folder + * * @return boolean True on success, False on error */ - function copy_message($uids, $to_mbox, $from_mbox='') + public function copy_message($uids, $to_mbox, $from_mbox='') { if (!strlen($from_mbox)) { - $from_mbox = $this->mailbox; + $from_mbox = $this->folder; } - list($uids, $all_mode) = $this->_parse_uids($uids, $from_mbox); + list($uids, $all_mode) = $this->parse_uids($uids); // exit if no message uids are specified if (empty($uids)) { return false; } - // make sure mailbox exists - if ($to_mbox != 'INBOX' && !$this->mailbox_exists($to_mbox)) { + if (!$this->check_connection()) { + return false; + } + + // make sure folder exists + if ($to_mbox != 'INBOX' && !$this->folder_exists($to_mbox)) { if (in_array($to_mbox, $this->default_folders)) { - if (!$this->create_mailbox($to_mbox, true)) { + if (!$this->create_folder($to_mbox, true)) { return false; } } @@ -2306,7 +2312,7 @@ class rcube_imap $copied = $this->conn->copy($uids, $from_mbox, $to_mbox); if ($copied) { - $this->_clear_messagecount($to_mbox); + $this->clear_messagecount($to_mbox); } return $copied; @@ -2314,48 +2320,55 @@ class rcube_imap /** - * Mark messages as deleted and expunge mailbox + * Mark messages as deleted and expunge them * * @param mixed $uids Message UIDs as array or comma-separated string, or '*' - * @param string $mailbox Source mailbox + * @param string $folder Source folder * * @return boolean True on success, False on error */ - function delete_message($uids, $mailbox='') + public function delete_message($uids, $folder='') { - if (!strlen($mailbox)) { - $mailbox = $this->mailbox; + if (!strlen($folder)) { + $folder = $this->folder; } - list($uids, $all_mode) = $this->_parse_uids($uids, $mailbox); + list($uids, $all_mode) = $this->parse_uids($uids); // exit if no message uids are specified - if (empty($uids)) + if (empty($uids)) { return false; + } + + if (!$this->check_connection()) { + return false; + } - $deleted = $this->conn->flag($mailbox, $uids, 'DELETED'); + $deleted = $this->conn->flag($folder, $uids, 'DELETED'); if ($deleted) { // send expunge command in order to have the deleted message - // really deleted from the mailbox - $this->_expunge($mailbox, false, $uids); - $this->_clear_messagecount($mailbox); - unset($this->uid_id_map[$mailbox]); + // really deleted from the folder + $this->expunge_message($uids, $folder, false); + $this->clear_messagecount($folder); + unset($this->uid_id_map[$folder]); // unset threads internal cache unset($this->icache['threads']); // remove message ids from search set - if ($this->search_set && $mailbox == $this->mailbox) { + if ($this->search_set && $folder == $this->folder) { // threads are too complicated to just remove messages from set - if ($this->search_threads || $all_mode) + if ($this->search_threads || $all_mode) { $this->refresh_search(); - else + } + else { $this->search_set->filter(explode(',', $uids)); + } } // remove cached messages - $this->clear_message_cache($mailbox, $all_mode ? null : explode(',', $uids)); + $this->clear_message_cache($folder, $all_mode ? null : explode(',', $uids)); } return $deleted; @@ -2363,126 +2376,58 @@ class rcube_imap /** - * Clear all messages in a specific mailbox + * Send IMAP expunge command and clear cache * - * @param string $mailbox Mailbox name + * @param mixed $uids Message UIDs as array or comma-separated string, or '*' + * @param string $folder Folder name + * @param boolean $clear_cache False if cache should not be cleared * - * @return int Above 0 on success + * @return boolean True on success, False on failure */ - function clear_mailbox($mailbox=null) + public function expunge_message($uids, $folder = null, $clear_cache = true) { - if (!strlen($mailbox)) { - $mailbox = $this->mailbox; + if ($uids && $this->get_capability('UIDPLUS')) { + list($uids, $all_mode) = $this->parse_uids($uids); } - - // SELECT will set messages count for clearFolder() - if ($this->conn->select($mailbox)) { - $cleared = $this->conn->clearFolder($mailbox); + else { + $uids = null; } - // make sure the cache is cleared as well - if ($cleared) { - $this->clear_message_cache($mailbox); - $a_mailbox_cache = $this->get_cache('messagecount'); - unset($a_mailbox_cache[$mailbox]); - $this->update_cache('messagecount', $a_mailbox_cache); + if (!strlen($folder)) { + $folder = $this->folder; } - return $cleared; - } - - - /** - * Send IMAP expunge command and clear cache - * - * @param string $mailbox Mailbox name - * @param boolean $clear_cache False if cache should not be cleared - * - * @return boolean True on success - */ - function expunge($mailbox='', $clear_cache=true) - { - if (!strlen($mailbox)) { - $mailbox = $this->mailbox; + if (!$this->check_connection()) { + return false; } - return $this->_expunge($mailbox, $clear_cache); - } - - - /** - * Send IMAP expunge command and clear cache - * - * @param string $mailbox Mailbox name - * @param boolean $clear_cache False if cache should not be cleared - * @param mixed $uids Message UIDs as array or comma-separated string, or '*' - * @return boolean True on success - * @access private - * @see rcube_imap::expunge() - */ - private function _expunge($mailbox, $clear_cache=true, $uids=NULL) - { - if ($uids && $this->get_capability('UIDPLUS')) - list($uids, $all_mode) = $this->_parse_uids($uids, $mailbox); - else - $uids = null; - - // force mailbox selection and check if mailbox is writeable + // force folder selection and check if folder is writeable // to prevent a situation when CLOSE is executed on closed - // or EXPUNGE on read-only mailbox - $result = $this->conn->select($mailbox); + // or EXPUNGE on read-only folder + $result = $this->conn->select($folder); if (!$result) { return false; } + if (!$this->conn->data['READ-WRITE']) { - $this->conn->setError(rcube_imap_generic::ERROR_READONLY, "Mailbox is read-only"); + $this->conn->setError(rcube_imap_generic::ERROR_READONLY, "Folder is read-only"); return false; } // CLOSE(+SELECT) should be faster than EXPUNGE - if (empty($uids) || $all_mode) + if (empty($uids) || $all_mode) { $result = $this->conn->close(); - else - $result = $this->conn->expunge($mailbox, $uids); - - if ($result && $clear_cache) { - $this->clear_message_cache($mailbox, $all_mode ? null : explode(',', $uids)); - $this->_clear_messagecount($mailbox); - } - - return $result; - } - - - /** - * Parse message UIDs input - * - * @param mixed $uids UIDs array or comma-separated list or '*' or '1:*' - * @param string $mailbox Mailbox name - * @return array Two elements array with UIDs converted to list and ALL flag - * @access private - */ - private function _parse_uids($uids, $mailbox) - { - if ($uids === '*' || $uids === '1:*') { - if (empty($this->search_set)) { - $uids = '1:*'; - $all = true; - } - // get UIDs from current search set - else { - $uids = join(',', $this->search_set->get()); - } } else { - if (is_array($uids)) - $uids = join(',', $uids); + $result = $this->conn->expunge($folder, $uids); + } - if (preg_match('/[^0-9,]/', $uids)) - $uids = ''; + if ($result && $clear_cache) { + $this->clear_message_cache($folder, $all_mode ? null : explode(',', $uids)); + $this->clear_messagecount($folder); } - return array($uids, (bool) $all); + return $result; } @@ -2491,7 +2436,7 @@ class rcube_imap * --------------------------------*/ /** - * Public method for listing subscribed folders + * Public method for listing subscribed folders. * * @param string $root Optional root folder * @param string $name Optional name pattern @@ -2500,9 +2445,8 @@ class rcube_imap * @param bool $skip_sort Enable to return unsorted list (for better performance) * * @return array List of folders - * @access public */ - function list_mailboxes($root='', $name='*', $filter=null, $rights=null, $skip_sort=false) + public function list_folders_subscribed($root='', $name='*', $filter=null, $rights=null, $skip_sort=false) { $cache_key = $root.':'.$name; if (!empty($filter)) { @@ -2517,7 +2461,7 @@ class rcube_imap return $a_mboxes; } - $a_mboxes = $this->_list_mailboxes($root, $name, $filter, $rights); + $a_mboxes = $this->_list_folders_subscribed($root, $name, $filter, $rights); if (!is_array($a_mboxes)) { return array(); @@ -2533,12 +2477,12 @@ class rcube_imap array_unshift($a_mboxes, 'INBOX'); } - // sort mailboxes (always sort for cache) + // sort folders (always sort for cache) if (!$skip_sort || $this->cache) { - $a_mboxes = $this->_sort_mailbox_list($a_mboxes); + $a_mboxes = $this->sort_folder_list($a_mboxes); } - // write mailboxlist to cache + // write folders list to cache $this->update_cache($cache_key, $a_mboxes); return $a_mboxes; @@ -2546,7 +2490,7 @@ class rcube_imap /** - * Private method for mailbox listing (LSUB) + * protected method for folders listing (LSUB) * * @param string $root Optional root folder * @param string $name Optional name pattern @@ -2554,21 +2498,20 @@ class rcube_imap * @param string $rights Optional ACL requirements * * @return array List of subscribed folders - * @see rcube_imap::list_mailboxes() - * @access private + * @see rcube_imap::list_folders_subscribed() */ - private function _list_mailboxes($root='', $name='*', $filter=null, $rights=null) + protected function _list_folders_subscribed($root='', $name='*', $filter=null, $rights=null) { $a_defaults = $a_out = array(); - // Give plugins a chance to provide a list of mailboxes - $data = rcmail::get_instance()->plugins->exec_hook('mailboxes_list', + // Give plugins a chance to provide a list of folders + $data = rcmail::get_instance()->plugins->exec_hook('folders_list', array('root' => $root, 'name' => $name, 'filter' => $filter, 'mode' => 'LSUB')); if (isset($data['folders'])) { $a_folders = $data['folders']; } - else if (!$this->conn->connected()) { + else if (!$this->check_connection()) { return null; } else { @@ -2576,7 +2519,7 @@ class rcube_imap $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 + // This will also set folder options, LSUB doesn't do that $a_folders = $this->conn->listMailboxes($root, $name, NULL, array('SUBSCRIBED')); @@ -2603,7 +2546,7 @@ class rcube_imap && in_array('\\Noselect', $opts) ) { // Some servers returns \Noselect for existing folders - if (!$this->mailbox_exists($folder)) { + if (!$this->folder_exists($folder)) { $this->conn->unsubscribe($folder); unset($a_folders[$idx]); } @@ -2622,7 +2565,7 @@ class rcube_imap /** - * Get a list of all folders available on the IMAP server + * Get a list of all folders available on the server * * @param string $root IMAP root dir * @param string $name Optional name pattern @@ -2632,7 +2575,7 @@ class rcube_imap * * @return array Indexed array with folder names */ - function list_unsubscribed($root='', $name='*', $filter=null, $rights=null, $skip_sort=false) + public function list_folders($root='', $name='*', $filter=null, $rights=null, $skip_sort=false) { $cache_key = $root.':'.$name; if (!empty($filter)) { @@ -2647,8 +2590,8 @@ class rcube_imap return $a_mboxes; } - // Give plugins a chance to provide a list of mailboxes - $data = rcmail::get_instance()->plugins->exec_hook('mailboxes_list', + // Give plugins a chance to provide a list of folders + $data = rcmail::get_instance()->plugins->exec_hook('folders_list', array('root' => $root, 'name' => $name, 'filter' => $filter, 'mode' => 'LIST')); if (isset($data['folders'])) { @@ -2656,7 +2599,7 @@ class rcube_imap } else { // retrieve list of folders from IMAP server - $a_mboxes = $this->_list_unsubscribed($root, $name); + $a_mboxes = $this->_list_folders($root, $name); } if (!is_array($a_mboxes)) { @@ -2669,7 +2612,7 @@ class rcube_imap } // cache folder attributes - if ($root == '' && $name == '*' && empty($filter)) { + if ($root == '' && $name == '*' && empty($filter) && !empty($this->conn->data)) { $this->update_cache('mailboxes.attributes', $this->conn->data['LIST']); } @@ -2680,10 +2623,10 @@ class rcube_imap // filter folders and sort them if (!$skip_sort) { - $a_mboxes = $this->_sort_mailbox_list($a_mboxes); + $a_mboxes = $this->sort_folder_list($a_mboxes); } - // write mailboxlist to cache + // write folders list to cache $this->update_cache($cache_key, $a_mboxes); return $a_mboxes; @@ -2691,16 +2634,20 @@ class rcube_imap /** - * Private method for mailbox listing (LIST) + * protected method for folders listing (LIST) * * @param string $root Optional root folder * @param string $name Optional name pattern * * @return array List of folders - * @see rcube_imap::list_unsubscribed() + * @see rcube_imap::list_folders() */ - private function _list_unsubscribed($root='', $name='*') + protected function _list_folders($root='', $name='*') { + if (!$this->check_connection()) { + return null; + } + $result = $this->conn->listMailboxes($root, $name); if (!is_array($result)) { @@ -2757,13 +2704,14 @@ class rcube_imap /** * Filter the given list of folders according to access rights */ - private function filter_rights($a_folders, $rights) + protected function filter_rights($a_folders, $rights) { $regex = '/('.$rights.')/'; foreach ($a_folders as $idx => $folder) { $myrights = join('', (array)$this->my_rights($folder)); - if ($myrights !== null && !preg_match($regex, $myrights)) + if ($myrights !== null && !preg_match($regex, $myrights)) { unset($a_folders[$idx]); + } } return $a_folders; @@ -2776,85 +2724,92 @@ class rcube_imap * * @return mixed Quota info or False if not supported */ - function get_quota() + public function get_quota() { - if ($this->get_capability('QUOTA')) + if ($this->get_capability('QUOTA')) { return $this->conn->getQuota(); + } return false; } /** - * Get mailbox size (size of all messages in a mailbox) + * Get folder size (size of all messages in a folder) * - * @param string $mailbox Mailbox name + * @param string $folder Folder name * - * @return int Mailbox size in bytes, False on error + * @return int Folder size in bytes, False on error */ - function get_mailbox_size($mailbox) + public function folder_size($folder) { + if (!$this->check_connection()) { + return 0; + } + // @TODO: could we try to use QUOTA here? - $result = $this->conn->fetchHeaderIndex($mailbox, '1:*', 'SIZE', false); + $result = $this->conn->fetchHeaderIndex($folder, '1:*', 'SIZE', false); - if (is_array($result)) + if (is_array($result)) { $result = array_sum($result); + } return $result; } /** - * Subscribe to a specific mailbox(es) + * Subscribe to a specific folder(s) + * + * @param array $folders Folder name(s) * - * @param array $a_mboxes Mailbox name(s) * @return boolean True on success */ - function subscribe($a_mboxes) + public function subscribe($folders) { - if (!is_array($a_mboxes)) - $a_mboxes = array($a_mboxes); - // let this common function do the main work - return $this->_change_subscription($a_mboxes, 'subscribe'); + return $this->change_subscription($folders, 'subscribe'); } /** - * Unsubscribe mailboxes + * Unsubscribe folder(s) + * + * @param array $a_mboxes Folder name(s) * - * @param array $a_mboxes Mailbox name(s) * @return boolean True on success */ - function unsubscribe($a_mboxes) + public function unsubscribe($folders) { - if (!is_array($a_mboxes)) - $a_mboxes = array($a_mboxes); - // let this common function do the main work - return $this->_change_subscription($a_mboxes, 'unsubscribe'); + return $this->change_subscription($folders, 'unsubscribe'); } /** - * Create a new mailbox on the server and register it in local cache + * Create a new folder on the server and register it in local cache * - * @param string $mailbox New mailbox name - * @param boolean $subscribe True if the new mailbox should be subscribed + * @param string $folder New folder name + * @param boolean $subscribe True if the new folder should be subscribed * * @return boolean True on success */ - function create_mailbox($mailbox, $subscribe=false) + public function create_folder($folder, $subscribe=false) { - $result = $this->conn->createFolder($mailbox); + if (!$this->check_connection()) { + return false; + } + + $result = $this->conn->createFolder($folder); // try to subscribe it if ($result) { // clear cache $this->clear_cache('mailboxes', true); - if ($subscribe) - $this->subscribe($mailbox); + if ($subscribe) { + $this->subscribe($folder); + } } return $result; @@ -2862,45 +2817,49 @@ class rcube_imap /** - * Set a new name to an existing mailbox + * Set a new name to an existing folder * - * @param string $mailbox Mailbox to rename - * @param string $new_name New mailbox name + * @param string $folder Folder to rename + * @param string $new_name New folder name * * @return boolean True on success */ - function rename_mailbox($mailbox, $new_name) + public function rename_folder($folder, $new_name) { if (!strlen($new_name)) { return false; } + if (!$this->check_connection()) { + return false; + } + $delm = $this->get_hierarchy_delimiter(); // get list of subscribed folders - if ((strpos($mailbox, '%') === false) && (strpos($mailbox, '*') === false)) { - $a_subscribed = $this->_list_mailboxes('', $mailbox . $delm . '*'); - $subscribed = $this->mailbox_exists($mailbox, true); + if ((strpos($folder, '%') === false) && (strpos($folder, '*') === false)) { + $a_subscribed = $this->_list_folders_subscribed('', $folder . $delm . '*'); + $subscribed = $this->folder_exists($folder, true); } else { - $a_subscribed = $this->_list_mailboxes(); - $subscribed = in_array($mailbox, $a_subscribed); + $a_subscribed = $this->_list_folders_subscribed(); + $subscribed = in_array($folder, $a_subscribed); } - $result = $this->conn->renameFolder($mailbox, $new_name); + $result = $this->conn->renameFolder($folder, $new_name); if ($result) { // unsubscribe the old folder, subscribe the new one if ($subscribed) { - $this->conn->unsubscribe($mailbox); + $this->conn->unsubscribe($folder); $this->conn->subscribe($new_name); } - // check if mailbox children are subscribed + // check if folder children are subscribed foreach ($a_subscribed as $c_subscribed) { - if (strpos($c_subscribed, $mailbox.$delm) === 0) { + if (strpos($c_subscribed, $folder.$delm) === 0) { $this->conn->unsubscribe($c_subscribed); - $this->conn->subscribe(preg_replace('/^'.preg_quote($mailbox, '/').'/', + $this->conn->subscribe(preg_replace('/^'.preg_quote($folder, '/').'/', $new_name, $c_subscribed)); // clear cache @@ -2909,7 +2868,7 @@ class rcube_imap } // clear cache - $this->clear_message_cache($mailbox); + $this->clear_message_cache($folder); $this->clear_cache('mailboxes', true); } @@ -2918,31 +2877,37 @@ class rcube_imap /** - * Remove mailbox from server + * Remove folder from server * - * @param string $mailbox Mailbox name + * @param string $folder Folder name * * @return boolean True on success */ - function delete_mailbox($mailbox) + function delete_folder($folder) { $delm = $this->get_hierarchy_delimiter(); + if (!$this->check_connection()) { + return false; + } + // get list of folders - if ((strpos($mailbox, '%') === false) && (strpos($mailbox, '*') === false)) - $sub_mboxes = $this->list_unsubscribed('', $mailbox . $delm . '*'); - else + if ((strpos($folder, '%') === false) && (strpos($folder, '*') === false)) { + $sub_mboxes = $this->list_unsubscribed('', $folder . $delm . '*'); + } + else { $sub_mboxes = $this->list_unsubscribed(); + } // send delete command to server - $result = $this->conn->deleteFolder($mailbox); + $result = $this->conn->deleteFolder($folder); if ($result) { - // unsubscribe mailbox - $this->conn->unsubscribe($mailbox); + // unsubscribe folder + $this->conn->unsubscribe($folder); foreach ($sub_mboxes as $c_mbox) { - if (strpos($c_mbox, $mailbox.$delm) === 0) { + if (strpos($c_mbox, $folder.$delm) === 0) { $this->conn->unsubscribe($c_mbox); if ($this->conn->deleteFolder($c_mbox)) { $this->clear_message_cache($c_mbox); @@ -2950,8 +2915,8 @@ class rcube_imap } } - // clear mailbox-related cache - $this->clear_message_cache($mailbox); + // clear folder-related cache + $this->clear_message_cache($folder); $this->clear_cache('mailboxes', true); } @@ -2962,14 +2927,16 @@ class rcube_imap /** * Create all folders specified as default */ - function create_default_folders() + public function create_default_folders() { // create default folders if they do not exist foreach ($this->default_folders as $folder) { - if (!$this->mailbox_exists($folder)) - $this->create_mailbox($folder, true); - else if (!$this->mailbox_exists($folder, true)) + if (!$this->folder_exists($folder)) { + $this->create_folder($folder, true); + } + else if (!$this->folder_exists($folder, true)) { $this->subscribe($folder); + } } } @@ -2977,31 +2944,36 @@ class rcube_imap /** * Checks if folder exists and is subscribed * - * @param string $mailbox Folder name + * @param string $folder Folder name * @param boolean $subscription Enable subscription checking * * @return boolean TRUE or FALSE */ - function mailbox_exists($mailbox, $subscription=false) + public function folder_exists($folder, $subscription=false) { - if ($mailbox == 'INBOX') { + if ($folder == 'INBOX') { return true; } $key = $subscription ? 'subscribed' : 'existing'; - if (is_array($this->icache[$key]) && in_array($mailbox, $this->icache[$key])) + if (is_array($this->icache[$key]) && in_array($folder, $this->icache[$key])) { return true; + } + + if (!$this->check_connection()) { + return false; + } if ($subscription) { - $a_folders = $this->conn->listSubscribed('', $mailbox); + $a_folders = $this->conn->listSubscribed('', $folder); } else { - $a_folders = $this->conn->listMailboxes('', $mailbox); + $a_folders = $this->conn->listMailboxes('', $folder); } - if (is_array($a_folders) && in_array($mailbox, $a_folders)) { - $this->icache[$key][] = $mailbox; + if (is_array($a_folders) && in_array($folder, $a_folders)) { + $this->icache[$key][] = $folder; return true; } @@ -3012,14 +2984,13 @@ class rcube_imap /** * Returns the namespace where the folder is in * - * @param string $mailbox Folder name + * @param string $folder Folder name * * @return string One of 'personal', 'other' or 'shared' - * @access public */ - function mailbox_namespace($mailbox) + public function folder_namespace($folder) { - if ($mailbox == 'INBOX') { + if ($folder == 'INBOX') { return 'personal'; } @@ -3027,8 +2998,8 @@ class rcube_imap if (is_array($namespace)) { foreach ($namespace as $ns) { if ($len = strlen($ns[0])) { - if (($len > 1 && $mailbox == substr($ns[0], 0, -1)) - || strpos($mailbox, $ns[0]) === 0 + if (($len > 1 && $folder == substr($ns[0], 0, -1)) + || strpos($folder, $ns[0]) === 0 ) { return $type; } @@ -3047,62 +3018,66 @@ class rcube_imap * For input it adds the prefix. Use it before creating a folder in root * of the folders tree. * - * @param string $mailbox Folder name + * @param string $folder Folder name * @param string $mode Mode name (out/in) * * @return string Folder name */ - function mod_mailbox($mailbox, $mode = 'out') + public function mod_folder($folder, $mode = 'out') { - if (!strlen($mailbox)) { - return $mailbox; + if (!strlen($folder)) { + return $folder; } $prefix = $this->namespace['prefix']; // see set_env() $prefix_len = strlen($prefix); if (!$prefix_len) { - return $mailbox; + return $folder; } // remove prefix for output if ($mode == 'out') { - if (substr($mailbox, 0, $prefix_len) === $prefix) { - return substr($mailbox, $prefix_len); + if (substr($folder, 0, $prefix_len) === $prefix) { + return substr($folder, $prefix_len); } } // add prefix for input (e.g. folder creation) else { - return $prefix . $mailbox; + return $prefix . $folder; } - return $mailbox; + return $folder; } /** * Gets folder attributes from LIST response, e.g. \Noselect, \Noinferiors * - * @param string $mailbox Folder name + * @param string $folder Folder name * @param bool $force Set to True if attributes should be refreshed * * @return array Options list */ - function mailbox_attributes($mailbox, $force=false) + public function folder_attributes($folder, $force=false) { // get attributes directly from LIST command - if (!empty($this->conn->data['LIST']) && is_array($this->conn->data['LIST'][$mailbox])) { - $opts = $this->conn->data['LIST'][$mailbox]; + if (!empty($this->conn->data['LIST']) && is_array($this->conn->data['LIST'][$folder])) { + $opts = $this->conn->data['LIST'][$folder]; } // get cached folder attributes else if (!$force) { $opts = $this->get_cache('mailboxes.attributes'); - $opts = $opts[$mailbox]; + $opts = $opts[$folder]; } if (!is_array($opts)) { - $this->conn->listMailboxes('', $mailbox); - $opts = $this->conn->data['LIST'][$mailbox]; + if (!$this->check_connection()) { + return array(); + } + + $this->conn->listMailboxes('', $folder); + $opts = $this->conn->data['LIST'][$folder]; } return is_array($opts) ? $opts : array(); @@ -3110,30 +3085,37 @@ class rcube_imap /** - * Gets connection (and current mailbox) data: UIDVALIDITY, EXISTS, RECENT, + * Gets connection (and current folder) data: UIDVALIDITY, EXISTS, RECENT, * PERMANENTFLAGS, UIDNEXT, UNSEEN * - * @param string $mailbox Folder name + * @param string $folder Folder name * * @return array Data */ - function mailbox_data($mailbox) + public function folder_data($folder) { - if (!strlen($mailbox)) - $mailbox = $this->mailbox !== null ? $this->mailbox : 'INBOX'; + if (!strlen($folder)) { + $folder = $this->folder !== null ? $this->folder : 'INBOX'; + } + + if ($this->conn->selected != $folder) { + if (!$this->check_connection()) { + return array(); + } - if ($this->conn->selected != $mailbox) { - if ($this->conn->select($mailbox)) - $this->mailbox = $mailbox; - else + if ($this->conn->select($folder)) { + $this->folder = $folder; + } + else { return null; + } } $data = $this->conn->data; // add (E)SEARCH result for ALL UNDELETED query if (!empty($this->icache['undeleted_idx']) - && $this->icache['undeleted_idx']->getParameters('MAILBOX') == $mailbox + && $this->icache['undeleted_idx']->get_parameters('MAILBOX') == $folder ) { $data['UNDELETED'] = $this->icache['undeleted_idx']; } @@ -3145,13 +3127,13 @@ class rcube_imap /** * Returns extended information about the folder * - * @param string $mailbox Folder name + * @param string $folder Folder name * * @return array Data */ - function mailbox_info($mailbox) + public function folder_info($folder) { - if ($this->icache['options'] && $this->icache['options']['name'] == $mailbox) { + if ($this->icache['options'] && $this->icache['options']['name'] == $folder) { return $this->icache['options']; } @@ -3161,7 +3143,7 @@ class rcube_imap // check if the folder is a namespace prefix if (!empty($namespace)) { - $mbox = $mailbox . $this->delimiter; + $mbox = $folder . $this->delimiter; foreach ($namespace as $ns) { if (!empty($ns)) { foreach ($ns as $item) { @@ -3175,7 +3157,7 @@ class rcube_imap } // check if the folder is other user virtual-root if (!$options['is_root'] && !empty($namespace) && !empty($namespace['other'])) { - $parts = explode($this->delimiter, $mailbox); + $parts = explode($this->delimiter, $folder); if (count($parts) == 2) { $mbox = $parts[0] . $this->delimiter; foreach ($namespace['other'] as $item) { @@ -3187,11 +3169,11 @@ class rcube_imap } } - $options['name'] = $mailbox; - $options['attributes'] = $this->mailbox_attributes($mailbox, true); - $options['namespace'] = $this->mailbox_namespace($mailbox); - $options['rights'] = $acl && !$options['is_root'] ? (array)$this->my_rights($mailbox) : array(); - $options['special'] = in_array($mailbox, $this->default_folders); + $options['name'] = $folder; + $options['attributes'] = $this->folder_attributes($folder, true); + $options['namespace'] = $this->folder_namespace($folder); + $options['rights'] = $acl && !$options['is_root'] ? (array)$this->my_rights($folder) : array(); + $options['special'] = in_array($folder, $this->default_folders); // Set 'noselect' and 'norename' flags if (is_array($options['attributes'])) { @@ -3226,12 +3208,12 @@ class rcube_imap /** * Synchronizes messages cache. * - * @param string $mailbox Folder name + * @param string $folder Folder name */ - public function mailbox_sync($mailbox) + public function folder_sync($folder) { if ($mcache = $this->get_mcache_engine()) { - $mcache->synchronize($mailbox); + $mcache->synchronize($folder); } } @@ -3241,13 +3223,19 @@ class rcube_imap * * @return string Space-separated list of header names */ - private function get_fetch_headers() + protected function get_fetch_headers() { - $headers = explode(' ', $this->fetch_add_headers); - $headers = array_map('strtoupper', $headers); + if (!empty($this->options['fetch_headers'])) { + $headers = explode(' ', $this->options['fetch_headers']); + $headers = array_map('strtoupper', $headers); + } + else { + $headers = array(); + } - if ($this->messages_caching || $this->get_all_headers) + if ($this->messages_caching || $this->options['all_headers']) { $headers = array_merge($headers, $this->all_headers); + } return implode(' ', array_unique($headers)); } @@ -3258,128 +3246,149 @@ class rcube_imap * ----------------------------------------*/ /** - * Changes the ACL on the specified mailbox (SETACL) + * Changes the ACL on the specified folder (SETACL) * - * @param string $mailbox Mailbox name + * @param string $folder Folder name * @param string $user User name * @param string $acl ACL string * * @return boolean True on success, False on failure - * - * @access public * @since 0.5-beta */ - function set_acl($mailbox, $user, $acl) + public function set_acl($folder, $user, $acl) { - if ($this->get_capability('ACL')) - return $this->conn->setACL($mailbox, $user, $acl); + if (!$this->get_capability('ACL')) { + return false; + } - return false; + if (!$this->check_connection()) { + return false; + } + + return $this->conn->setACL($folder, $user, $acl); } /** * Removes any <identifier,rights> pair for the * specified user from the ACL for the specified - * mailbox (DELETEACL) + * folder (DELETEACL) * - * @param string $mailbox Mailbox name + * @param string $folder Folder name * @param string $user User name * * @return boolean True on success, False on failure - * - * @access public * @since 0.5-beta */ - function delete_acl($mailbox, $user) + public function delete_acl($folder, $user) { - if ($this->get_capability('ACL')) - return $this->conn->deleteACL($mailbox, $user); + if (!$this->get_capability('ACL')) { + return false; + } - return false; + if (!$this->check_connection()) { + return false; + } + + return $this->conn->deleteACL($folder, $user); } /** - * Returns the access control list for mailbox (GETACL) + * Returns the access control list for folder (GETACL) * - * @param string $mailbox Mailbox name + * @param string $folder Folder name * * @return array User-rights array on success, NULL on error - * @access public * @since 0.5-beta */ - function get_acl($mailbox) + public function get_acl($folder) { - if ($this->get_capability('ACL')) - return $this->conn->getACL($mailbox); + if (!$this->get_capability('ACL')) { + return null; + } - return NULL; + if (!$this->check_connection()) { + return null; + } + + return $this->conn->getACL($folder); } /** * Returns information about what rights can be granted to the - * user (identifier) in the ACL for the mailbox (LISTRIGHTS) + * user (identifier) in the ACL for the folder (LISTRIGHTS) * - * @param string $mailbox Mailbox name + * @param string $folder Folder name * @param string $user User name * * @return array List of user rights - * @access public * @since 0.5-beta */ - function list_rights($mailbox, $user) + public function list_rights($folder, $user) { - if ($this->get_capability('ACL')) - return $this->conn->listRights($mailbox, $user); + if (!$this->get_capability('ACL')) { + return null; + } + + if (!$this->check_connection()) { + return null; + } - return NULL; + return $this->conn->listRights($folder, $user); } /** * Returns the set of rights that the current user has to - * mailbox (MYRIGHTS) + * folder (MYRIGHTS) * - * @param string $mailbox Mailbox name + * @param string $folder Folder name * * @return array MYRIGHTS response on success, NULL on error - * @access public * @since 0.5-beta */ - function my_rights($mailbox) + public function my_rights($folder) { - if ($this->get_capability('ACL')) - return $this->conn->myRights($mailbox); + if (!$this->get_capability('ACL')) { + return null; + } - return NULL; + if (!$this->check_connection()) { + return null; + } + + return $this->conn->myRights($folder); } /** * Sets IMAP metadata/annotations (SETMETADATA/SETANNOTATION) * - * @param string $mailbox Mailbox name (empty for server metadata) + * @param string $folder Folder name (empty for server metadata) * @param array $entries Entry-value array (use NULL value as NIL) * * @return boolean True on success, False on failure - * @access public * @since 0.5-beta */ - function set_metadata($mailbox, $entries) + public function set_metadata($folder, $entries) { + if (!$this->check_connection()) { + return false; + } + if ($this->get_capability('METADATA') || - (!strlen($mailbox) && $this->get_capability('METADATA-SERVER')) + (!strlen($folder) && $this->get_capability('METADATA-SERVER')) ) { - return $this->conn->setMetadata($mailbox, $entries); + return $this->conn->setMetadata($folder, $entries); } else if ($this->get_capability('ANNOTATEMORE') || $this->get_capability('ANNOTATEMORE2')) { foreach ((array)$entries as $entry => $value) { list($ent, $attr) = $this->md2annotate($entry); $entries[$entry] = array($ent, $attr, $value); } - return $this->conn->setAnnotation($mailbox, $entries); + return $this->conn->setAnnotation($folder, $entries); } return false; @@ -3389,27 +3398,29 @@ class rcube_imap /** * Unsets IMAP metadata/annotations (SETMETADATA/SETANNOTATION) * - * @param string $mailbox Mailbox name (empty for server metadata) + * @param string $folder Folder name (empty for server metadata) * @param array $entries Entry names array * * @return boolean True on success, False on failure - * - * @access public * @since 0.5-beta */ - function delete_metadata($mailbox, $entries) + public function delete_metadata($folder, $entries) { + if (!$this->check_connection()) { + return false; + } + if ($this->get_capability('METADATA') || - (!strlen($mailbox) && $this->get_capability('METADATA-SERVER')) + (!strlen($folder) && $this->get_capability('METADATA-SERVER')) ) { - return $this->conn->deleteMetadata($mailbox, $entries); + return $this->conn->deleteMetadata($folder, $entries); } else if ($this->get_capability('ANNOTATEMORE') || $this->get_capability('ANNOTATEMORE2')) { foreach ((array)$entries as $idx => $entry) { list($ent, $attr) = $this->md2annotate($entry); $entries[$idx] = array($ent, $attr, NULL); } - return $this->conn->setAnnotation($mailbox, $entries); + return $this->conn->setAnnotation($folder, $entries); } return false; @@ -3419,21 +3430,23 @@ class rcube_imap /** * Returns IMAP metadata/annotations (GETMETADATA/GETANNOTATION) * - * @param string $mailbox Mailbox name (empty for server metadata) + * @param string $folder Folder name (empty for server metadata) * @param array $entries Entries * @param array $options Command options (with MAXSIZE and DEPTH keys) * * @return array Metadata entry-value hash array on success, NULL on error - * - * @access public * @since 0.5-beta */ - function get_metadata($mailbox, $entries, $options=array()) + public function get_metadata($folder, $entries, $options=array()) { - if ($this->get_capability('METADATA') || - (!strlen($mailbox) && $this->get_capability('METADATA-SERVER')) + if (!$this->check_connection()) { + return null; + } + + if ($this->get_capability('METADATA') || + (!strlen($folder) && $this->get_capability('METADATA-SERVER')) ) { - return $this->conn->getMetadata($mailbox, $entries, $options); + return $this->conn->getMetadata($folder, $entries, $options); } else if ($this->get_capability('ANNOTATEMORE') || $this->get_capability('ANNOTATEMORE2')) { $queries = array(); @@ -3446,14 +3459,16 @@ class rcube_imap } // @TODO: Honor MAXSIZE and DEPTH options - foreach ($queries as $attrib => $entry) - if ($result = $this->conn->getAnnotation($mailbox, $entry, $attrib)) + foreach ($queries as $attrib => $entry) { + if ($result = $this->conn->getAnnotation($folder, $entry, $attrib)) { $res = array_merge_recursive($res, $result); + } + } return $res; } - return NULL; + return null; } @@ -3465,17 +3480,17 @@ class rcube_imap * * @return array Entry-attribute list, NULL if not supported (?) */ - private function md2annotate($entry) + protected function md2annotate($entry) { if (substr($entry, 0, 7) == '/shared') { return array(substr($entry, 7), 'value.shared'); } - else if (substr($entry, 0, 8) == '/private') { + else if (substr($entry, 0, 8) == '/protected') { return array(substr($entry, 8), 'value.priv'); } // @TODO: log error - return NULL; + return null; } @@ -3487,16 +3502,16 @@ class rcube_imap * Enable or disable indexes caching * * @param string $type Cache type (@see rcmail::get_cache) - * @access public */ - function set_caching($type) + public function set_caching($type) { if ($type) { $this->caching = $type; } else { - if ($this->cache) + if ($this->cache) { $this->cache->close(); + } $this->cache = null; $this->caching = false; } @@ -3505,7 +3520,7 @@ class rcube_imap /** * Getter for IMAP cache object */ - private function get_cache_engine() + protected function get_cache_engine() { if ($this->caching && !$this->cache) { $rcmail = rcmail::get_instance(); @@ -3519,10 +3534,10 @@ class rcube_imap * Returns cached value * * @param string $key Cache key + * * @return mixed - * @access public */ - function get_cache($key) + public function get_cache($key) { if ($cache = $this->get_cache_engine()) { return $cache->get($key); @@ -3534,9 +3549,8 @@ class rcube_imap * * @param string $key Cache key * @param mixed $data Data - * @access public */ - function update_cache($key, $data) + protected function update_cache($key, $data) { if ($cache = $this->get_cache_engine()) { $cache->set($key, $data); @@ -3549,9 +3563,8 @@ class rcube_imap * @param string $key Cache key name or pattern * @param boolean $prefix_mode Enable it to clear all keys starting * with prefix specified in $key - * @access public */ - function clear_cache($key=null, $prefix_mode=false) + public function clear_cache($key = null, $prefix_mode = false) { if ($cache = $this->get_cache_engine()) { $cache->remove($key, $prefix_mode); @@ -3568,14 +3581,15 @@ class rcube_imap * * @param boolean $set Flag */ - function set_messages_caching($set) + public function set_messages_caching($set) { if ($set) { $this->messages_caching = true; } else { - if ($this->mcache) + if ($this->mcache) { $this->mcache->close(); + } $this->mcache = null; $this->messages_caching = false; } @@ -3585,13 +3599,13 @@ class rcube_imap /** * Getter for messages cache object */ - private function get_mcache_engine() + protected function get_mcache_engine() { if ($this->messages_caching && !$this->mcache) { $rcmail = rcmail::get_instance(); if ($dbh = $rcmail->get_dbh()) { $this->mcache = new rcube_imap_cache( - $dbh, $this, $rcmail->user->ID, $this->skip_deleted); + $dbh, $this, $rcmail->user->ID, $this->options['skip_deleted']); } } @@ -3602,19 +3616,19 @@ class rcube_imap /** * Clears the messages cache. * - * @param string $mailbox Folder name + * @param string $folder Folder name * @param array $uids Optional message UIDs to remove from cache */ - function clear_message_cache($mailbox = null, $uids = null) + protected function clear_message_cache($folder = null, $uids = null) { if ($mcache = $this->get_mcache_engine()) { - $mcache->clear($mailbox, $uids); + $mcache->clear($folder, $uids); } } /* -------------------------------- - * private methods + * protected methods * --------------------------------*/ /** @@ -3622,24 +3636,24 @@ class rcube_imap * * @param string $sort_field Sort column * @param string $sort_order Sort order - * @access private */ - private function set_sort_order($sort_field, $sort_order) + protected function set_sort_order($sort_field, $sort_order) { - if ($sort_field != null) + if ($sort_field != null) { $this->sort_field = asciiwords($sort_field); - if ($sort_order != null) + } + if ($sort_order != null) { $this->sort_order = strtoupper($sort_order) == 'DESC' ? 'DESC' : 'ASC'; + } } /** - * Sort mailboxes first by default folders and then in alphabethical order + * Sort folders first by default folders and then in alphabethical order * - * @param array $a_folders Mailboxes list - * @access private + * @param array $a_folders Folders list */ - private function _sort_mailbox_list($a_folders) + protected function sort_folder_list($a_folders) { $a_out = $a_defaults = $folders = array(); @@ -3647,13 +3661,16 @@ class rcube_imap // find default folders and skip folders starting with '.' foreach ($a_folders as $i => $folder) { - if ($folder[0] == '.') + if ($folder[0] == '.') { continue; + } - if (($p = array_search($folder, $this->default_folders)) !== false && !$a_defaults[$p]) + if (($p = array_search($folder, $this->default_folders)) !== false && !$a_defaults[$p]) { $a_defaults[$p] = $folder; - else + } + else { $folders[$folder] = rcube_charset_convert($folder, 'UTF7-IMAP'); + } } // sort folders and place defaults on the top @@ -3669,7 +3686,7 @@ class rcube_imap // set the type of folder name variable (#1485527) $a_out[] = (string) $folder; unset($folders[$key]); - $this->_rsort($folder, $delimiter, $folders, $a_out); + $this->rsort($folder, $delimiter, $folders, $a_out); } return $a_out; @@ -3677,16 +3694,16 @@ class rcube_imap /** - * @access private + * Recursive method for sorting folders */ - private function _rsort($folder, $delimiter, &$list, &$out) + protected function rsort($folder, $delimiter, &$list, &$out) { while (list($key, $name) = each($list)) { if (strpos($name, $folder.$delimiter) === 0) { // set the type of folder name variable (#1485527) $out[] = (string) $name; unset($list[$key]); - $this->_rsort($name, $delimiter, $list, $out); + $this->rsort($name, $delimiter, $list, $out); } } reset($list); @@ -3697,47 +3714,57 @@ class rcube_imap * Find UID of the specified message sequence ID * * @param int $id Message (sequence) ID - * @param string $mailbox Mailbox name + * @param string $folder Folder name * * @return int Message UID */ - public function id2uid($id, $mailbox = null) + public function id2uid($id, $folder = null) { - if (!strlen($mailbox)) { - $mailbox = $this->mailbox; + if (!strlen($folder)) { + $folder = $this->folder; } - if ($uid = array_search($id, (array)$this->uid_id_map[$mailbox])) { + if ($uid = array_search($id, (array)$this->uid_id_map[$folder])) { return $uid; } - $uid = $this->conn->ID2UID($mailbox, $id); + if (!$this->check_connection()) { + return null; + } - $this->uid_id_map[$mailbox][$uid] = $id; + $uid = $this->conn->ID2UID($folder, $id); + + $this->uid_id_map[$folder][$uid] = $id; return $uid; } /** - * Subscribe/unsubscribe a list of mailboxes and update local cache - * @access private + * Subscribe/unsubscribe a list of folders and update local cache */ - private function _change_subscription($a_mboxes, $mode) + protected function change_subscription($folders, $mode) { $updated = false; - if (is_array($a_mboxes)) - foreach ($a_mboxes as $i => $mailbox) { - $a_mboxes[$i] = $mailbox; + if (!empty($folders)) { + if (!$this->check_connection()) { + return false; + } + + foreach ((array)$folders as $i => $folder) { + $folders[$i] = $folder; - if ($mode == 'subscribe') - $updated = $this->conn->subscribe($mailbox); - else if ($mode == 'unsubscribe') - $updated = $this->conn->unsubscribe($mailbox); + if ($mode == 'subscribe') { + $updated = $this->conn->subscribe($folder); + } + else if ($mode == 'unsubscribe') { + $updated = $this->conn->unsubscribe($folder); + } } + } - // clear cached mailbox list(s) + // clear cached folders list(s) if ($updated) { $this->clear_cache('mailboxes', true); } @@ -3747,47 +3774,51 @@ class rcube_imap /** - * Increde/decrese messagecount for a specific mailbox - * @access private + * Increde/decrese messagecount for a specific folder */ - private function _set_messagecount($mailbox, $mode, $increment) + protected function set_messagecount($folder, $mode, $increment) { + if (!is_numeric($increment)) { + return false; + } + $mode = strtoupper($mode); - $a_mailbox_cache = $this->get_cache('messagecount'); + $a_folder_cache = $this->get_cache('messagecount'); - if (!is_array($a_mailbox_cache[$mailbox]) || !isset($a_mailbox_cache[$mailbox][$mode]) || !is_numeric($increment)) + if (!is_array($a_folder_cache[$folder]) || !isset($a_folder_cache[$folder][$mode])) { return false; + } // add incremental value to messagecount - $a_mailbox_cache[$mailbox][$mode] += $increment; + $a_folder_cache[$folder][$mode] += $increment; // there's something wrong, delete from cache - if ($a_mailbox_cache[$mailbox][$mode] < 0) - unset($a_mailbox_cache[$mailbox][$mode]); + if ($a_folder_cache[$folder][$mode] < 0) { + unset($a_folder_cache[$folder][$mode]); + } // write back to cache - $this->update_cache('messagecount', $a_mailbox_cache); + $this->update_cache('messagecount', $a_folder_cache); return true; } /** - * Remove messagecount of a specific mailbox from cache - * @access private + * Remove messagecount of a specific folder from cache */ - private function _clear_messagecount($mailbox, $mode=null) + protected function clear_messagecount($folder, $mode=null) { - $a_mailbox_cache = $this->get_cache('messagecount'); + $a_folder_cache = $this->get_cache('messagecount'); - if (is_array($a_mailbox_cache[$mailbox])) { + if (is_array($a_folder_cache[$folder])) { if ($mode) { - unset($a_mailbox_cache[$mailbox][$mode]); + unset($a_folder_cache[$folder][$mode]); } else { - unset($a_mailbox_cache[$mailbox]); + unset($a_folder_cache[$folder]); } - $this->update_cache('messagecount', $a_mailbox_cache); + $this->update_cache('messagecount', $a_folder_cache); } } @@ -3802,84 +3833,3 @@ class rcube_imap } } // end class rcube_imap - - -/** - * Class representing a message part - * - * @package Mail - */ -class rcube_message_part -{ - var $mime_id = ''; - var $ctype_primary = 'text'; - var $ctype_secondary = 'plain'; - var $mimetype = 'text/plain'; - var $disposition = ''; - var $filename = ''; - var $encoding = '8bit'; - var $charset = ''; - var $size = 0; - var $headers = array(); - var $d_parameters = array(); - var $ctype_parameters = array(); - - function __clone() - { - if (isset($this->parts)) - foreach ($this->parts as $idx => $part) - if (is_object($part)) - $this->parts[$idx] = clone $part; - } -} - - -/** - * Class for sorting an array of rcube_mail_header objects in a predetermined order. - * - * @package Mail - * @author Eric Stadtherr - */ -class rcube_header_sorter -{ - private $uids = array(); - - - /** - * Set the predetermined sort order. - * - * @param array $index Numerically indexed array of IMAP UIDs - */ - function set_index($index) - { - $index = array_flip($index); - - $this->uids = $index; - } - - /** - * Sort the array of header objects - * - * @param array $headers Array of rcube_mail_header objects indexed by UID - */ - function sort_headers(&$headers) - { - uksort($headers, array($this, "compare_uids")); - } - - /** - * Sort method called by uksort() - * - * @param int $a Array key (UID) - * @param int $b Array key (UID) - */ - function compare_uids($a, $b) - { - // then find each sequence number in my ordered list - $posa = isset($this->uids[$a]) ? intval($this->uids[$a]) : -1; - $posb = isset($this->uids[$b]) ? intval($this->uids[$b]) : -1; - - // return the relative position as the comparison value - return $posa - $posb; - } -} |