|
|
<?php
/* +-----------------------------------------------------------------------+ | program/include/rcube_imap.php | | | | This file is part of the Roundcube Webmail client | | Copyright (C) 2005-2010, The Roundcube Dev Team | | Licensed under the GNU GPL | | | | PURPOSE: | | IMAP Engine | | | +-----------------------------------------------------------------------+ | Author: Thomas Bruederli <roundcube@gmail.com> | | Author: Aleksander Machniak <alec@alec.pl> | +-----------------------------------------------------------------------+
$Id$
*/
/** * Interface class for accessing an IMAP server * * @package Mail * @author Thomas Bruederli <roundcube@gmail.com> * @author Aleksander Machniak <alec@alec.pl> * @version 2.0 */class rcube_imap{ public $debug_level = 1; 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 * * @var rcube_imap_generic */ public $conn;
/** * Instance of rcube_mdb2 * * @var rcube_mdb2 */ private $db;
/** * Instance of rcube_cache * * @var rcube_cache */ private $cache; 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 $messages_caching = false; private $icache = array(); 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 $db_header_fields = array('idx', 'uid', 'subject', 'from', 'to', 'cc', 'date', 'size'); private $options = array('auth_method' => 'check'); private $host, $user, $pass, $port, $ssl; private $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-PRIORITY', '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;
/** * Object constructor. */ 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'])) $this->namespace = $_SESSION['imap_namespace']; if (isset($_SESSION['imap_delimiter'])) $this->delimiter = $_SESSION['imap_delimiter']; }
/** * Connect to an IMAP server * * @param string $host Host to connect * @param string $user Username for IMAP account * @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) { // check for OpenSSL support in PHP build
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__, 'message' => "OpenSSL not available"), true, false); $port = 143; }
$this->options['port'] = $port;
if ($this->options['debug']) { $this->conn->setDebug(true, array($this, 'debug_handler'));
$this->options['ident'] = array( 'name' => 'Roundcube Webmail', 'version' => RCMAIL_VERSION, 'php' => PHP_VERSION, 'os' => PHP_OS, 'command' => $_SERVER['REQUEST_URI'], ); }
$attempt = 0; do { $data = rcmail::get_instance()->plugins->exec_hook('imap_connect', array('host' => $host, 'user' => $user, 'attempt' => ++$attempt));
if (!empty($data['pass'])) $pass = $data['pass'];
$this->conn->connect($data['host'], $data['user'], $pass, $this->options); } while(!$this->conn->connected() && $data['retry']);
$this->host = $data['host']; $this->user = $data['user']; $this->pass = $pass; $this->port = $port; $this->ssl = $use_ssl;
if ($this->conn->connected()) { // get namespace and delimiter
$this->set_env(); return true; } // write error log
else if ($this->conn->error) { if ($pass && $user) { $message = sprintf("Login failed for %s from %s. %s", $user, rcmail_remote_ip(), $this->conn->error);
raise_error(array('code' => 403, 'type' => 'imap', 'file' => __FILE__, 'line' => __LINE__, 'message' => $message), true, false); } }
return false; }
/** * Close IMAP connection * Usually done on script shutdown * * @access public */ function close() { $this->conn->closeConnection(); }
/** * Close IMAP connection and re-connect * This is used to avoid some strange socket errors when talking to Courier IMAP * * @access public */ function reconnect() { $this->conn->closeConnection(); $connected = $this->connect($this->host, $this->user, $this->pass, $this->port, $this->ssl);
// issue SELECT command to restore connection status
if ($connected && strlen($this->mailbox)) $this->conn->select($this->mailbox); }
/** * Returns code of last error * * @return int Error code */ function get_error_code() { return $this->conn->errornum; }
/** * Returns message of last error * * @return string Error message */ function get_error_str() { return $this->conn->error; }
/** * Returns code of last command response * * @return int Response code */ function get_response_code() { switch ($this->conn->resultcode) { case 'NOPERM': return self::NOPERM; case 'READ-ONLY': return self::READONLY; case 'TRYCREATE': return self::TRYCREATE; case 'INUSE': return self::INUSE; case 'OVERQUOTA': return self::OVERQUOTA; case 'ALREADYEXISTS': return self::ALREADYEXISTS; case 'NONEXISTENT': return self::NONEXISTENT; case 'CONTACTADMIN': return self::CONTACTADMIN; default: return self::UNKNOWN; } }
/** * Returns last command response * * @return string Response */ function get_response_str() { return $this->conn->result; }
/** * Set options to be used in rcube_imap_generic::connect() * * @param array $opt Options array */ function set_options($opt) { $this->options = array_merge($this->options, (array)$opt); }
/** * 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. * * All operations will be perfomed on this mailbox/folder * * @param string $mailbox Mailbox/Folder name * @access public */ function set_mailbox($mailbox) { if ($this->mailbox == $mailbox) return;
$this->mailbox = $mailbox;
// clear messagecount cache for this mailbox
$this->_clear_messagecount($mailbox); }
/** * Forces selection of a mailbox * * @param string $mailbox Mailbox/Folder name * @access public */ function select_mailbox($mailbox=null) { if (!strlen($mailbox)) { $mailbox = $this->mailbox; }
$selected = $this->conn->select($mailbox);
if ($selected && $this->mailbox != $mailbox) { // clear messagecount cache for this mailbox
$this->_clear_messagecount($mailbox); $this->mailbox = $mailbox; } }
/** * Set internal list page * * @param number $page Page number to list * @access public */ function set_page($page) { $this->list_page = (int)$page; }
/** * 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; }
/** * Save a set of message ids for future message listing methods * * @param string IMAP Search query * @param array List of message ids or NULL if empty * @param string Charset of search string * @param string Sorting field * @param string True if set is sorted (SORT was used for searching) */ function set_search_set($str=null, $msgs=null, $charset=null, $sort_field=null, $threads=false, $sorted=false) { if (is_array($str) && $msgs == null) list($str, $msgs, $charset, $sort_field, $threads) = $str; if ($msgs === false) $msgs = array(); else if ($msgs != null && !is_array($msgs)) $msgs = explode(',', $msgs);
$this->search_string = $str; $this->search_set = $msgs; $this->search_charset = $charset; $this->search_sort_field = $sort_field; $this->search_threads = $threads; $this->search_sorted = $sorted; }
/** * Return the saved search set as hash array * @return array Search set */ function get_search_set() { return array($this->search_string, $this->search_set, $this->search_charset, $this->search_sort_field, $this->search_threads, $this->search_sorted, ); }
/** * Returns the currently used mailbox name * * @return string Name of the mailbox/folder * @access public */ function get_mailbox_name() { return $this->conn->connected() ? $this->mailbox : ''; }
/** * 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) { return $this->conn->getCapability(strtoupper($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 ($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'; }
return $this->threading; }
/** * Checks the PERMANENTFLAGS capability of the current mailbox * 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) { $flag = strtoupper($flag); $imap_flag = $this->conn->flags[$flag]; return (in_array_nocase($imap_flag, $this->conn->data['PERMANENTFLAGS'])); }
/** * Returns the delimiter that is used by the IMAP server for folder separation * * @return string Delimiter string * @access public */ function get_hierarchy_delimiter() { return $this->delimiter; }
/** * Get namespace * * @param string $name Namespace array index: personal, other, shared, prefix * * @return array Namespace data * @access public */ function get_namespace($name=null) { $ns = $this->namespace;
if ($name) { return isset($ns[$name]) ? $ns[$name] : null; }
unset($ns['prefix']); return $ns; }
/** * Sets delimiter and namespaces * * @access private */ private function set_env() { if ($this->delimiter !== null && $this->namespace !== null) { return; }
$config = rcmail::get_instance()->config; $imap_personal = $config->get('imap_ns_personal'); $imap_other = $config->get('imap_ns_other'); $imap_shared = $config->get('imap_ns_shared'); $imap_delimiter = $config->get('imap_delimiter');
if (!$this->conn->connected()) return;
$ns = $this->conn->getNamespace();
// Set namespaces (NAMESPACE supported)
if (is_array($ns)) { $this->namespace = $ns; } else { $this->namespace = array( 'personal' => NULL, 'other' => NULL, 'shared' => NULL, ); }
if ($imap_delimiter) { $this->delimiter = $imap_delimiter; } if (empty($this->delimiter)) { $this->delimiter = $this->namespace['personal'][0][1]; } if (empty($this->delimiter)) { $this->delimiter = $this->conn->getHierarchyDelimiter(); } if (empty($this->delimiter)) { $this->delimiter = '/'; }
// Overwrite namespaces
if ($imap_personal !== null) { $this->namespace['personal'] = NULL; foreach ((array)$imap_personal as $dir) { $this->namespace['personal'][] = array($dir, $this->delimiter); } } if ($imap_other !== null) { $this->namespace['other'] = NULL; foreach ((array)$imap_other as $dir) { if ($dir) { $this->namespace['other'][] = array($dir, $this->delimiter); } } } if ($imap_shared !== null) { $this->namespace['shared'] = NULL; foreach ((array)$imap_shared as $dir) { if ($dir) { $this->namespace['shared'][] = array($dir, $this->delimiter); } } }
// Find personal namespace prefix for mod_mailbox()
// 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]; }
$_SESSION['imap_namespace'] = $this->namespace; $_SESSION['imap_delimiter'] = $this->delimiter; }
/** * Get message count for a specific mailbox * * @param string $mailbox Mailbox/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() * @return int Number of messages * @access public */ function messagecount($mailbox='', $mode='ALL', $force=false, $status=true) { if (!strlen($mailbox)) { $mailbox = $this->mailbox; }
return $this->_messagecount($mailbox, $mode, $force, $status); }
/** * Private method for getting nr of messages * * @param string $mailbox Mailbox 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() * @return int Number of messages * @access private * @see rcube_imap::messagecount() */ private function _messagecount($mailbox, $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 ($this->search_threads) return $mode == 'ALL' ? count((array)$this->search_set['depth']) : count((array)$this->search_set['tree']); else return count((array)$this->search_set); }
$a_mailbox_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 (!is_array($a_mailbox_cache[$mailbox])) $a_mailbox_cache[$mailbox] = array();
if ($mode == 'THREADS') { $res = $this->_threadcount($mailbox, $msg_count); $count = $res['count'];
if ($status) { $this->set_folder_stats($mailbox, 'cnt', $res['msgcount']); $this->set_folder_stats($mailbox, 'maxuid', $res['maxuid'] ? $this->_id2uid($res['maxuid'], $mailbox) : 0); } } // RECENT count is fetched a bit different
else if ($mode == 'RECENT') { $count = $this->conn->countRecent($mailbox); } // use SEARCH for message counting
else if ($this->skip_deleted) { $search_str = "ALL UNDELETED"; $keys = array('COUNT'); $need_uid = false;
if ($mode == 'UNSEEN') { $search_str .= " UNSEEN"; } else { if ($this->messages_caching) { $keys[] = 'ALL'; } if ($status) { $keys[] = 'MAX'; $need_uid = true; } }
// get message count using (E)SEARCH
// not very performant but more precise (using UNDELETED)
$index = $this->conn->search($mailbox, $search_str, $need_uid, $keys);
$count = is_array($index) ? $index['COUNT'] : 0;
if ($mode == 'ALL') { if ($need_uid && $this->messages_caching) { // Save messages index for check_cache_status()
$this->icache['all_undeleted_idx'] = $index['ALL']; } if ($status) { $this->set_folder_stats($mailbox, 'cnt', $count); $this->set_folder_stats($mailbox, 'maxuid', is_array($index) ? $index['MAX'] : 0); } } } else { if ($mode == 'UNSEEN') $count = $this->conn->countUnseen($mailbox); else { $count = $this->conn->countMessages($mailbox); if ($status) { $this->set_folder_stats($mailbox,'cnt', $count); $this->set_folder_stats($mailbox, 'maxuid', $count ? $this->_id2uid($count, $mailbox) : 0); } } }
$a_mailbox_cache[$mailbox][$mode] = (int)$count;
// write back to cache
$this->update_cache('messagecount', $a_mailbox_cache);
return (int)$count; }
/** * Private method for getting nr of threads * * @param string $mailbox Folder name * * @returns array Array containing items: 'count' - threads count, * 'msgcount' = messages count, 'maxuid' = max. UID in the set * @access private */ private function _threadcount($mailbox) { $result = array();
if (!empty($this->icache['threads'])) { $dcount = count($this->icache['threads']['depth']); $result = array( 'count' => count($this->icache['threads']['tree']), 'msgcount' => $dcount, 'maxuid' => $dcount ? max(array_keys($this->icache['threads']['depth'])) : 0, ); } else if (is_array($result = $this->_fetch_threads($mailbox))) { $dcount = count($result[1]); $result = array( 'count' => count($result[0]), 'msgcount' => $dcount, 'maxuid' => $dcount ? max(array_keys($result[1])) : 0, ); }
return $result; }
/** * Public method for listing headers * convert mailbox name with root dir first * * @param string $mailbox Mailbox/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 */ function list_headers($mailbox='', $page=NULL, $sort_field=NULL, $sort_order=NULL, $slice=0) { if (!strlen($mailbox)) { $mailbox = $this->mailbox; }
return $this->_list_headers($mailbox, $page, $sort_field, $sort_order, false, $slice); }
/** * Private method for listing message headers * * @param string $mailbox Mailbox 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 private * @see rcube_imap::list_headers */ private function _list_headers($mailbox='', $page=NULL, $sort_field=NULL, $sort_order=NULL, $recursive=false, $slice=0) { if (!strlen($mailbox)) return array();
// use saved message set
if ($this->search_string && $mailbox == $this->mailbox) return $this->_list_header_set($mailbox, $page, $sort_field, $sort_order, $slice);
if ($this->threading) return $this->_list_thread_headers($mailbox, $page, $sort_field, $sort_order, $recursive, $slice);
$this->_set_sort_order($sort_field, $sort_order);
$page = $page ? $page : $this->list_page; $cache_key = $mailbox.'.msg';
if ($this->messages_caching) { // cache is OK, we can get messages from local cache
// (assume cache is in sync when in recursive mode)
if ($recursive || $this->check_cache_status($mailbox, $cache_key)>0) { $start_msg = ($page-1) * $this->page_size; $a_msg_headers = $this->get_message_cache($cache_key, $start_msg, $start_msg+$this->page_size, $this->sort_field, $this->sort_order); $result = array_values($a_msg_headers); if ($slice) $result = array_slice($result, -$slice, $slice); return $result; } // cache is incomplete, sync it (all messages in the folder)
else if (!$recursive) { $this->sync_header_index($mailbox); return $this->_list_headers($mailbox, $page, $this->sort_field, $this->sort_order, true, $slice); } }
// retrieve headers from IMAP
$a_msg_headers = array();
// use message index sort as default sorting (for better performance)
if (!$this->sort_field) { if ($this->skip_deleted) { // @TODO: this could be cached
if ($msg_index = $this->_search_index($mailbox, 'ALL UNDELETED')) { $max = max($msg_index); list($begin, $end) = $this->_get_message_range(count($msg_index), $page); $msg_index = array_slice($msg_index, $begin, $end-$begin); } } else if ($max = $this->conn->countMessages($mailbox)) { list($begin, $end) = $this->_get_message_range($max, $page); $msg_index = range($begin+1, $end); } else $msg_index = array();
if ($slice && $msg_index) $msg_index = array_slice($msg_index, ($this->sort_order == 'DESC' ? 0 : -$slice), $slice);
// fetch reqested headers from server
if ($msg_index) $this->_fetch_headers($mailbox, join(",", $msg_index), $a_msg_headers, $cache_key); } // use SORT command
else if ($this->get_capability('SORT') && // Courier-IMAP provides SORT capability but allows to disable it by admin (#1486959)
($msg_index = $this->conn->sort($mailbox, $this->sort_field, $this->skip_deleted ? 'UNDELETED' : '')) !== false ) { if (!empty($msg_index)) { list($begin, $end) = $this->_get_message_range(count($msg_index), $page); $max = max($msg_index); $msg_index = array_slice($msg_index, $begin, $end-$begin);
if ($slice) $msg_index = array_slice($msg_index, ($this->sort_order == 'DESC' ? 0 : -$slice), $slice);
// fetch reqested headers from server
$this->_fetch_headers($mailbox, join(',', $msg_index), $a_msg_headers, $cache_key); } } // fetch specified header for all messages and sort
else if ($a_index = $this->conn->fetchHeaderIndex($mailbox, "1:*", $this->sort_field, $this->skip_deleted)) { asort($a_index); // ASC
$msg_index = array_keys($a_index); $max = max($msg_index); list($begin, $end) = $this->_get_message_range(count($msg_index), $page); $msg_index = array_slice($msg_index, $begin, $end-$begin);
if ($slice) $msg_index = array_slice($msg_index, ($this->sort_order == 'DESC' ? 0 : -$slice), $slice);
// fetch reqested headers from server
$this->_fetch_headers($mailbox, join(",", $msg_index), $a_msg_headers, $cache_key); }
// delete cached messages with a higher index than $max+1
// Changed $max to $max+1 to fix this bug : #1484295
$this->clear_message_cache($cache_key, $max + 1);
// kick child process to sync cache
// ...
// return empty array if no messages found
if (!is_array($a_msg_headers) || empty($a_msg_headers)) return array();
// use this class for message sorting
$sorter = new rcube_header_sorter(); $sorter->set_sequence_numbers($msg_index); $sorter->sort_headers($a_msg_headers);
if ($this->sort_order == 'DESC') $a_msg_headers = array_reverse($a_msg_headers);
return array_values($a_msg_headers); }
/** * Private method for listing message headers using threads * * @param string $mailbox Mailbox/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 boolean $recursive True if called recursively * @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_headers */ private function _list_thread_headers($mailbox, $page=NULL, $sort_field=NULL, $sort_order=NULL, $recursive=false, $slice=0) { $this->_set_sort_order($sort_field, $sort_order);
$page = $page ? $page : $this->list_page;// $cache_key = $mailbox.'.msg';
// $cache_status = $this->check_cache_status($mailbox, $cache_key);
// get all threads (default sort order)
list ($thread_tree, $msg_depth, $has_children) = $this->_fetch_threads($mailbox);
if (empty($thread_tree)) return array();
$msg_index = $this->_sort_threads($mailbox, $thread_tree);
return $this->_fetch_thread_headers($mailbox, $thread_tree, $msg_depth, $has_children, $msg_index, $page, $slice); }
/** * Private method for fetching threads data * * @param string $mailbox Mailbox/folder name * @return array Array with thread data * @access private */ private function _fetch_threads($mailbox) { if (empty($this->icache['threads'])) { // get all threads
$result = $this->conn->thread($mailbox, $this->threading, $this->skip_deleted ? 'UNDELETED' : '');
// add to internal (fast) cache
$this->icache['threads'] = array(); $this->icache['threads']['tree'] = is_array($result) ? $result[0] : array(); $this->icache['threads']['depth'] = is_array($result) ? $result[1] : array(); $this->icache['threads']['has_children'] = is_array($result) ? $result[2] : array(); }
return array( $this->icache['threads']['tree'], $this->icache['threads']['depth'], $this->icache['threads']['has_children'], ); }
/** * Private method for fetching threaded messages headers * * @param string $mailbox Mailbox name * @param array $thread_tree Thread tree data * @param array $msg_depth Thread depth data * @param array $has_children Thread children data * @param array $msg_index Messages index * @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, $thread_tree, $msg_depth, $has_children, $msg_index, $page, $slice=0) { $cache_key = $mailbox.'.msg'; // now get IDs for current page
list($begin, $end) = $this->_get_message_range(count($msg_index), $page); $msg_index = array_slice($msg_index, $begin, $end-$begin);
if ($slice) $msg_index = array_slice($msg_index, ($this->sort_order == 'DESC' ? 0 : -$slice), $slice);
if ($this->sort_order == 'DESC') $msg_index = array_reverse($msg_index);
// flatten threads array
// @TODO: fetch children only in expanded mode (?)
$all_ids = array(); foreach ($msg_index as $root) { $all_ids[] = $root; if (!empty($thread_tree[$root])) $all_ids = array_merge($all_ids, array_keys_recursive($thread_tree[$root])); }
// fetch reqested headers from server
$this->_fetch_headers($mailbox, $all_ids, $a_msg_headers, $cache_key);
// return empty array if no messages found
if (!is_array($a_msg_headers) || empty($a_msg_headers)) return array();
// use this class for message sorting
$sorter = new rcube_header_sorter(); $sorter->set_sequence_numbers($all_ids); $sorter->sort_headers($a_msg_headers);
// Set depth, has_children and unread_children fields in headers
$this->_set_thread_flags($a_msg_headers, $msg_depth, $has_children);
return array_values($a_msg_headers); }
/** * Private method for setting threaded messages flags: * depth, has_children and unread_children * * @param array $headers Reference to headers array indexed by message ID * @param array $msg_depth Array of messages depth indexed by message ID * @param array $msg_children Array of messages children flags indexed by message ID * @return array Message headers array indexed by message ID * @access private */ private function _set_thread_flags(&$headers, $msg_depth, $msg_children) { $parents = array();
foreach ($headers as $idx => $header) { $id = $header->id; $depth = $msg_depth[$id]; $parents = array_slice($parents, 0, $depth);
if (!empty($parents)) { $headers[$idx]->parent_uid = end($parents); if (!$header->seen) $headers[$parents[0]]->unread_children++; } array_push($parents, $header->uid);
$headers[$idx]->depth = $depth; $headers[$idx]->has_children = $msg_children[$id]; } }
/** * Private method for listing a set of message headers (search results) * * @param string $mailbox Mailbox/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 private * @see rcube_imap::list_header_set() */ private function _list_header_set($mailbox, $page=NULL, $sort_field=NULL, $sort_order=NULL, $slice=0) { if (!strlen($mailbox) || empty($this->search_set)) return array();
// use saved messages from searching
if ($this->threading) return $this->_list_thread_header_set($mailbox, $page, $sort_field, $sort_order, $slice);
// search set is threaded, we need a new one
if ($this->search_threads) { if (empty($this->search_set['tree'])) return array(); $this->search('', $this->search_string, $this->search_charset, $sort_field); }
$msgs = $this->search_set; $a_msg_headers = array(); $page = $page ? $page : $this->list_page; $start_msg = ($page-1) * $this->page_size;
$this->_set_sort_order($sort_field, $sort_order);
// quickest method (default sorting)
if (!$this->search_sort_field && !$this->sort_field) { if ($sort_order == 'DESC') $msgs = array_reverse($msgs);
// get messages uids for one page
$msgs = array_slice(array_values($msgs), $start_msg, min(count($msgs)-$start_msg, $this->page_size));
if ($slice) $msgs = array_slice($msgs, -$slice, $slice);
// fetch headers
$this->_fetch_headers($mailbox, join(',',$msgs), $a_msg_headers, NULL);
// I didn't found in RFC that FETCH always returns messages sorted by index
$sorter = new rcube_header_sorter(); $sorter->set_sequence_numbers($msgs); $sorter->sort_headers($a_msg_headers);
return array_values($a_msg_headers); }
// sorted messages, so we can first slice array and then fetch only wanted headers
if ($this->search_sorted) { // SORT searching result
// reset search set if sorting field has been changed
if ($this->sort_field && $this->search_sort_field != $this->sort_field) $msgs = $this->search('', $this->search_string, $this->search_charset, $this->sort_field);
// return empty array if no messages found
if (empty($msgs)) return array();
if ($sort_order == 'DESC') $msgs = array_reverse($msgs);
// get messages uids for one page
$msgs = array_slice(array_values($msgs), $start_msg, min(count($msgs)-$start_msg, $this->page_size));
if ($slice) $msgs = array_slice($msgs, -$slice, $slice);
// fetch headers
$this->_fetch_headers($mailbox, join(',',$msgs), $a_msg_headers, NULL);
$sorter = new rcube_header_sorter(); $sorter->set_sequence_numbers($msgs); $sorter->sort_headers($a_msg_headers);
return array_values($a_msg_headers); } else { // SEARCH result, need sorting
$cnt = count($msgs); // 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
$a_index = $this->message_index('', $this->sort_field, $this->sort_order); // get messages uids for one page...
$msgs = array_slice($a_index, $start_msg, min($cnt-$start_msg, $this->page_size)); if ($slice) $msgs = array_slice($msgs, -$slice, $slice); // ...and fetch headers
$this->_fetch_headers($mailbox, join(',', $msgs), $a_msg_headers, NULL);
// return empty array if no messages found
if (!is_array($a_msg_headers) || empty($a_msg_headers)) return array();
$sorter = new rcube_header_sorter(); $sorter->set_sequence_numbers($msgs); $sorter->sort_headers($a_msg_headers);
return array_values($a_msg_headers); } else { // for small result set we can fetch all messages headers
$this->_fetch_headers($mailbox, join(',', $msgs), $a_msg_headers, NULL);
// return empty array if no messages found
if (!is_array($a_msg_headers) || empty($a_msg_headers)) return array();
// if not already sorted
$a_msg_headers = $this->conn->sortHeaders( $a_msg_headers, $this->sort_field, $this->sort_order);
// only return the requested part of the set
$a_msg_headers = array_slice(array_values($a_msg_headers), $start_msg, min($cnt-$start_msg, $this->page_size));
if ($slice) $a_msg_headers = array_slice($a_msg_headers, -$slice, $slice);
return $a_msg_headers; } } }
/** * Private method for listing a set of threaded message headers (search results) * * @param string $mailbox Mailbox/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 private * @see rcube_imap::list_header_set() */ private function _list_thread_header_set($mailbox, $page=NULL, $sort_field=NULL, $sort_order=NULL, $slice=0) { // update search_set if previous data was fetched with disabled threading
if (!$this->search_threads) { if (empty($this->search_set)) return array(); $this->search('', $this->search_string, $this->search_charset, $sort_field); }
// empty result
if (empty($this->search_set['tree'])) return array();
$thread_tree = $this->search_set['tree']; $msg_depth = $this->search_set['depth']; $has_children = $this->search_set['children']; $a_msg_headers = array();
$page = $page ? $page : $this->list_page; $start_msg = ($page-1) * $this->page_size;
$this->_set_sort_order($sort_field, $sort_order);
$msg_index = $this->_sort_threads($mailbox, $thread_tree, array_keys($msg_depth));
return $this->_fetch_thread_headers($mailbox, $thread_tree, $msg_depth, $has_children, $msg_index, $page, $slice=0); }
/** * Helper function to get first and last index of the requested set * * @param int $max Messages count * @param mixed $page Page number to show, or string 'all' * @return array Array with two values: first index, last index * @access private */ private function _get_message_range($max, $page) { $start_msg = ($page-1) * $this->page_size;
if ($page=='all') { $begin = 0; $end = $max; } else if ($this->sort_order=='DESC') { $begin = $max - $this->page_size - $start_msg; $end = $max - $start_msg; } else { $begin = $start_msg; $end = $start_msg + $this->page_size; }
if ($begin < 0) $begin = 0; if ($end < 0) $end = $max; if ($end > $max) $end = $max;
return array($begin, $end); }
/** * Fetches message headers (used for loop) * * @param string $mailbox Mailbox name * @param string $msgs Message index to fetch * @param array $a_msg_headers Reference to message headers array * @param string $cache_key Cache index key * @return int Messages count * @access private */ private function _fetch_headers($mailbox, $msgs, &$a_msg_headers, $cache_key) { // fetch reqested headers from server
$a_header_index = $this->conn->fetchHeaders( $mailbox, $msgs, false, false, $this->get_fetch_headers());
if (empty($a_header_index)) return 0;
foreach ($a_header_index as $i => $headers) { $a_msg_headers[$headers->uid] = $headers; }
// Update cache
if ($this->messages_caching && $cache_key) { // cache is incomplete?
$cache_index = $this->get_message_cache_index($cache_key);
foreach ($a_header_index as $headers) { // message in cache
if ($cache_index[$headers->id] == $headers->uid) { unset($cache_index[$headers->id]); continue; } // wrong UID at this position
if ($cache_index[$headers->id]) { $for_remove[] = $cache_index[$headers->id]; unset($cache_index[$headers->id]); } // message UID in cache but at wrong position
if (is_int($key = array_search($headers->uid, $cache_index))) { $for_remove[] = $cache_index[$key]; unset($cache_index[$key]); }
$for_create[] = $headers->uid; }
if ($for_remove) $this->remove_message_cache($cache_key, $for_remove);
// add messages to cache
foreach ((array)$for_create as $uid) { $headers = $a_msg_headers[$uid]; $this->add_message_cache($cache_key, $headers->id, $headers, NULL, true); } }
return count($a_msg_headers); }
/** * Returns current status of mailbox * * 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 * @return int Folder status */ function mailbox_status($mailbox = null) { if (!strlen($mailbox)) { $mailbox = $this->mailbox; } $old = $this->get_folder_stats($mailbox);
// refresh message count -> will update
$this->_messagecount($mailbox, 'ALL', true);
$result = 0; $new = $this->get_folder_stats($mailbox);
// got new messages
if ($new['maxuid'] > $old['maxuid']) $result += 1; // some messages has been deleted
if ($new['cnt'] < $old['cnt']) $result += 2;
// @TODO: optional checking for messages flags changes (?)
// @TODO: UIDVALIDITY checking
return $result; }
/** * Stores folder statistic data in session * @TODO: move to separate DB table (cache?) * * @param string $mailbox Mailbox name * @param string $name Data name * @param mixed $data Data value */ private function set_folder_stats($mailbox, $name, $data) { $_SESSION['folders'][$mailbox][$name] = $data; }
/** * Gets folder statistic data * * @param string $mailbox Mailbox name * * @return array Stats data */ private function get_folder_stats($mailbox) { if ($_SESSION['folders'][$mailbox]) return (array) $_SESSION['folders'][$mailbox]; else return array(); }
/** * Return sorted array of message IDs (not UIDs) * * @param string $mailbox Mailbox to get index from * @param string $sort_field Sort column * @param string $sort_order Sort order [ASC, DESC] * @return array Indexed array with message IDs */ function message_index($mailbox='', $sort_field=NULL, $sort_order=NULL) { if ($this->threading) return $this->thread_index($mailbox, $sort_field, $sort_order);
$this->_set_sort_order($sort_field, $sort_order);
if (!strlen($mailbox)) { $mailbox = $this->mailbox; } $key = "{$mailbox}:{$this->sort_field}:{$this->sort_order}:{$this->search_string}.msgi";
// we have a saved search result, get index from there
if (!isset($this->icache[$key]) && $this->search_string && !$this->search_threads && $mailbox == $this->mailbox) { // use message index sort as default sorting
if (!$this->sort_field) { $msgs = $this->search_set;
if ($this->search_sort_field != 'date') sort($msgs);
if ($this->sort_order == 'DESC') $this->icache[$key] = array_reverse($msgs); else $this->icache[$key] = $msgs; } // sort with SORT command
else if ($this->search_sorted) { if ($this->sort_field && $this->search_sort_field != $this->sort_field) $this->search('', $this->search_string, $this->search_charset, $this->sort_field);
if ($this->sort_order == 'DESC') $this->icache[$key] = array_reverse($this->search_set); else $this->icache[$key] = $this->search_set; } else { $a_index = $this->conn->fetchHeaderIndex($mailbox, join(',', $this->search_set), $this->sort_field, $this->skip_deleted);
if (is_array($a_index)) { if ($this->sort_order=="ASC") asort($a_index); else if ($this->sort_order=="DESC") arsort($a_index);
$this->icache[$key] = array_keys($a_index); } else { $this->icache[$key] = array(); } } }
// have stored it in RAM
if (isset($this->icache[$key])) return $this->icache[$key];
// check local cache
$cache_key = $mailbox.'.msg'; $cache_status = $this->check_cache_status($mailbox, $cache_key);
// cache is OK
if ($cache_status>0) { $a_index = $this->get_message_cache_index($cache_key, $this->sort_field, $this->sort_order); return array_keys($a_index); }
// use message index sort as default sorting
if (!$this->sort_field) { if ($this->skip_deleted) { $a_index = $this->_search_index($mailbox, 'ALL'); } else if ($max = $this->_messagecount($mailbox)) { $a_index = range(1, $max); }
if ($a_index !== false && $this->sort_order == 'DESC') $a_index = array_reverse($a_index);
$this->icache[$key] = $a_index; } // fetch complete message index
else if ($this->get_capability('SORT') && ($a_index = $this->conn->sort($mailbox, $this->sort_field, $this->skip_deleted ? 'UNDELETED' : '')) !== false ) { if ($this->sort_order == 'DESC') $a_index = array_reverse($a_index);
$this->icache[$key] = $a_index; } else if ($a_index = $this->conn->fetchHeaderIndex( $mailbox, "1:*", $this->sort_field, $this->skip_deleted)) { if ($this->sort_order=="ASC") asort($a_index); else if ($this->sort_order=="DESC") arsort($a_index);
$this->icache[$key] = array_keys($a_index); }
return $this->icache[$key] !== false ? $this->icache[$key] : array(); }
/** * Return sorted array of threaded message IDs (not UIDs) * * @param string $mailbox Mailbox to get index from * @param string $sort_field Sort column * @param string $sort_order Sort order [ASC, DESC] * @return array Indexed array with message IDs */ function thread_index($mailbox='', $sort_field=NULL, $sort_order=NULL) { $this->_set_sort_order($sort_field, $sort_order);
if (!strlen($mailbox)) { $mailbox = $this->mailbox; } $key = "{$mailbox}:{$this->sort_field}:{$this->sort_order}:{$this->search_string}.thi";
// we have a saved search result, get index from there
if (!isset($this->icache[$key]) && $this->search_string && $this->search_threads && $mailbox == $this->mailbox) { // use message IDs for better performance
$ids = array_keys_recursive($this->search_set['tree']); $this->icache[$key] = $this->_flatten_threads($mailbox, $this->search_set['tree'], $ids); }
// have stored it in RAM
if (isset($this->icache[$key])) return $this->icache[$key];/* // check local cache
$cache_key = $mailbox.'.msg'; $cache_status = $this->check_cache_status($mailbox, $cache_key);
// cache is OK
if ($cache_status>0) { $a_index = $this->get_message_cache_index($cache_key, $this->sort_field, $this->sort_order); return array_keys($a_index); }*/ // get all threads (default sort order)
list ($thread_tree) = $this->_fetch_threads($mailbox);
$this->icache[$key] = $this->_flatten_threads($mailbox, $thread_tree);
return $this->icache[$key]; }
/** * Return array of threaded messages (all, not only roots) * * @param string $mailbox Mailbox to get index from * @param array $thread_tree Threaded messages array (see _fetch_threads()) * @param array $ids Message IDs if we know what we need (e.g. search result) * for better performance * @return array Indexed array with message IDs * * @access private */ private function _flatten_threads($mailbox, $thread_tree, $ids=null) { if (empty($thread_tree)) return array();
$msg_index = $this->_sort_threads($mailbox, $thread_tree, $ids);
if ($this->sort_order == 'DESC') $msg_index = array_reverse($msg_index);
// flatten threads array
$all_ids = array(); foreach ($msg_index as $root) { $all_ids[] = $root; if (!empty($thread_tree[$root])) { foreach (array_keys_recursive($thread_tree[$root]) as $val) $all_ids[] = $val; } }
return $all_ids; }
/** * @param string $mailbox Mailbox name * @access private */ private function sync_header_index($mailbox) { $cache_key = $mailbox.'.msg'; $cache_index = $this->get_message_cache_index($cache_key); $chunk_size = 1000;
// cache is empty, get all messages
if (is_array($cache_index) && empty($cache_index)) { $max = $this->_messagecount($mailbox); // syncing a big folder maybe slow
@set_time_limit(0); $start = 1; $end = min($chunk_size, $max); while (true) { // do this in loop to save memory (1000 msgs ~= 10 MB)
if ($headers = $this->conn->fetchHeaders($mailbox, "$start:$end", false, false, $this->get_fetch_headers()) ) { foreach ($headers as $header) { $this->add_message_cache($cache_key, $header->id, $header, NULL, true); } } if ($end - $start < $chunk_size - 1) break;
$end = min($end+$chunk_size, $max); $start += $chunk_size; } return; }
// fetch complete message index
if (isset($this->icache['folder_index'])) $a_message_index = &$this->icache['folder_index']; else $a_message_index = $this->conn->fetchHeaderIndex($mailbox, "1:*", 'UID', $this->skip_deleted);
if ($a_message_index === false || $cache_index === null) return;
// compare cache index with real index
foreach ($a_message_index as $id => $uid) { // message in cache at correct position
if ($cache_index[$id] == $uid) { unset($cache_index[$id]); continue; }
// other message at this position
if (isset($cache_index[$id])) { $for_remove[] = $cache_index[$id]; unset($cache_index[$id]); }
// message in cache but at wrong position
if (is_int($key = array_search($uid, $cache_index))) { $for_remove[] = $uid; unset($cache_index[$key]); }
$for_update[] = $id; }
// remove messages at wrong positions and those deleted that are still in cache_index
if (!empty($for_remove)) $cache_index = array_merge($cache_index, $for_remove);
if (!empty($cache_index)) $this->remove_message_cache($cache_key, $cache_index);
// fetch complete headers and add to cache
if (!empty($for_update)) { // syncing a big folder maybe slow
@set_time_limit(0); // To save memory do this in chunks
$for_update = array_chunk($for_update, $chunk_size); foreach ($for_update as $uids) { if ($headers = $this->conn->fetchHeaders($mailbox, $uids, false, false, $this->get_fetch_headers()) ) { foreach ($headers as $header) { $this->add_message_cache($cache_key, $header->id, $header, NULL, true); } } } } }
/** * Invoke search request to IMAP server * * @param string $mailbox Mailbox name to search in * @param string $str Search criteria * @param string $charset Search charset * @param string $sort_field Header field to sort by * @return array search results as list of message IDs * @access public */ function search($mailbox='', $str=NULL, $charset=NULL, $sort_field=NULL) { if (!$str) return false;
if (!strlen($mailbox)) { $mailbox = $this->mailbox; }
$results = $this->_search_index($mailbox, $str, $charset, $sort_field);
$this->set_search_set($str, $results, $charset, $sort_field, (bool)$this->threading, $this->threading || $this->search_sorted ? true : false);
return $results; }
/** * Private search method * * @param string $mailbox Mailbox name * @param string $criteria Search criteria * @param string $charset Charset * @param string $sort_field Sorting field * @return array search results as list of message ids * @access private * @see rcube_imap::search() */ private function _search_index($mailbox, $criteria='ALL', $charset=NULL, $sort_field=NULL) { $orig_criteria = $criteria;
if ($this->skip_deleted && !preg_match('/UNDELETED/', $criteria)) $criteria = 'UNDELETED '.$criteria;
if ($this->threading) { $a_messages = $this->conn->thread($mailbox, $this->threading, $criteria, $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 ($a_messages === false && $charset && $charset != 'US-ASCII') $a_messages = $this->conn->thread($mailbox, $this->threading, $this->convert_criteria($criteria, $charset), 'US-ASCII');
if ($a_messages !== false) { list ($thread_tree, $msg_depth, $has_children) = $a_messages; $a_messages = array( 'tree' => $thread_tree, 'depth' => $msg_depth, 'children' => $has_children ); }
return $a_messages; }
if ($sort_field && $this->get_capability('SORT')) { $charset = $charset ? $charset : $this->default_charset; $a_messages = $this->conn->sort($mailbox, $sort_field, $criteria, false, $charset);
// 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 ($a_messages === false && $charset && $charset != 'US-ASCII') $a_messages = $this->conn->sort($mailbox, $sort_field, $this->convert_criteria($criteria, $charset), false, 'US-ASCII');
if ($a_messages !== false) { $this->search_sorted = true; return $a_messages; } }
if ($orig_criteria == 'ALL') { $max = $this->_messagecount($mailbox); $a_messages = $max ? range(1, $max) : array(); } else { $a_messages = $this->conn->search($mailbox, ($charset ? "CHARSET $charset " : '') . $criteria);
// Error, try with US-ASCII (some servers may support only US-ASCII)
if ($a_messages === false && $charset && $charset != 'US-ASCII') $a_messages = $this->conn->search($mailbox, 'CHARSET US-ASCII ' . $this->convert_criteria($criteria, $charset));
// I didn't found that SEARCH should return sorted IDs
if (is_array($a_messages) && !$this->sort_field) sort($a_messages); }
$this->search_sorted = false;
return $a_messages; }
/** * 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 array Search results as list of message IDs or UIDs * @access public */ function search_once($mailbox='', $str=NULL, $ret_uid=false) { if (!$str) return false;
if (!strlen($mailbox)) { $mailbox = $this->mailbox; }
return $this->conn->search($mailbox, $str, $ret_uid); }
/** * 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') { // convert strings to US_ASCII
if (preg_match_all('/\{([0-9]+)\}\r\n/', $str, $matches, PREG_OFFSET_CAPTURE)) { $last = 0; $res = ''; foreach ($matches[1] as $m) { $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) continue; $res .= sprintf("%s{%d}\r\n%s", substr($str, $last, $m[1] - $last - 1), strlen($string), $string); $last = $m[0] + $string_offset - 1; } if ($last < strlen($str)) $res .= substr($str, $last, strlen($str)-$last); } else // strings for conversion not found
$res = $str;
return $res; }
/** * Sort thread * * @param string $mailbox Mailbox name * @param array $thread_tree Unsorted thread tree (rcube_imap_generic::thread() result) * @param array $ids Message IDs if we know what we need (e.g. search result) * @return array Sorted roots IDs * @access private */ private function _sort_threads($mailbox, $thread_tree, $ids=NULL) { // THREAD=ORDEREDSUBJECT: sorting by sent date of root message
// THREAD=REFERENCES: sorting by sent date of root message
// THREAD=REFS: sorting by the most recent date in each thread
// default sorting
if (!$this->sort_field || ($this->sort_field == 'date' && $this->threading == 'REFS')) { return array_keys((array)$thread_tree); } // here we'll implement REFS sorting, for performance reason
else { // ($sort_field == 'date' && $this->threading != 'REFS')
// use SORT command
if ($this->get_capability('SORT') && ($a_index = $this->conn->sort($mailbox, $this->sort_field, !empty($ids) ? $ids : ($this->skip_deleted ? 'UNDELETED' : ''))) !== false ) { // return unsorted tree if we've got no index data
if (!$a_index) return array_keys((array)$thread_tree); } else { // fetch specified headers for all messages and sort them
$a_index = $this->conn->fetchHeaderIndex($mailbox, !empty($ids) ? $ids : "1:*", $this->sort_field, $this->skip_deleted);
// return unsorted tree if we've got no index data
if (!$a_index) return array_keys((array)$thread_tree);
asort($a_index); // ASC
$a_index = array_values($a_index); }
return $this->_sort_thread_refs($thread_tree, $a_index); } }
/** * THREAD=REFS sorting implementation * * @param array $tree Thread tree array (message identifiers as keys) * @param array $index Array of sorted message identifiers * @return array Array of sorted roots messages * @access private */ private function _sort_thread_refs($tree, $index) { if (empty($tree)) return array();
$index = array_combine(array_values($index), $index);
// assign roots
foreach ($tree as $idx => $val) { $index[$idx] = $idx; if (!empty($val)) { $idx_arr = array_keys_recursive($tree[$idx]); foreach ($idx_arr as $subidx) $index[$subidx] = $idx; } }
$index = array_values($index);
// create sorted array of roots
$msg_index = array(); if ($this->sort_order != 'DESC') { foreach ($index as $idx) if (!isset($msg_index[$idx])) $msg_index[$idx] = $idx; $msg_index = array_values($msg_index); } else { for ($x=count($index)-1; $x>=0; $x--) if (!isset($msg_index[$index[$x]])) $msg_index[$index[$x]] = $index[$x]; $msg_index = array_reverse($msg_index); }
return $msg_index; }
/** * Refresh saved search set * * @return array Current search set */ function refresh_search() { if (!empty($this->search_string)) $this->search_set = $this->search('', $this->search_string, $this->search_charset, $this->search_sort_field, $this->search_threads, $this->search_sorted);
return $this->get_search_set(); }
/** * Check if the given message ID is part of the current search set * * @param string $msgid Message id * @return boolean True on match or if no search request is stored */ function in_searchset($msgid) { if (!empty($this->search_string)) { if ($this->search_threads) return isset($this->search_set['depth']["$msgid"]); else return in_array("$msgid", (array)$this->search_set, true); } else return true; }
/** * Return message headers object of a specific message * * @param int $id Message ID * @param string $mailbox Mailbox to read from * @param boolean $is_uid True if $id is the message UID * @param boolean $bodystr True if we need also BODYSTRUCTURE in headers * @return object Message headers representation */ function get_headers($id, $mailbox=null, $is_uid=true, $bodystr=false) { if (!strlen($mailbox)) { $mailbox = $this->mailbox; } $uid = $is_uid ? $id : $this->_id2uid($id, $mailbox);
// get cached headers
if ($uid && ($headers = &$this->get_cached_message($mailbox.'.msg', $uid))) return $headers;
$headers = $this->conn->fetchHeader( $mailbox, $id, $is_uid, $bodystr, $this->get_fetch_headers());
// write headers cache
if ($headers) { if ($headers->uid && $headers->id) $this->uid_id_map[$mailbox][$headers->uid] = $headers->id;
$this->add_message_cache($mailbox.'.msg', $headers->id, $headers, NULL, false, true); }
return $headers; }
/** * Fetch body structure from the IMAP server and build * an object structure similar to the one generated by PEAR::Mail_mimeDecode * * @param int $uid Message UID to fetch * @param string $structure_str Message BODYSTRUCTURE string (optional) * @return object rcube_message_part Message part tree or False on failure */ function &get_structure($uid, $structure_str='') { $cache_key = $this->mailbox.'.msg'; $headers = &$this->get_cached_message($cache_key, $uid);
// return cached message structure
if (is_object($headers) && is_object($headers->structure)) { return $headers->structure; }
if (!$structure_str) { $structure_str = $this->conn->fetchStructureString($this->mailbox, $uid, true); } $structure = rcube_mime_struct::parseStructure($structure_str); $struct = false;
// parse structure and add headers
if (!empty($structure)) { $headers = $this->get_headers($uid); $this->_msg_id = $headers->id;
// set message charset from message headers
if ($headers->charset) $this->struct_charset = $headers->charset; else $this->struct_charset = $this->_structure_charset($structure);
$headers->ctype = strtolower($headers->ctype);
// Here we can recognize malformed BODYSTRUCTURE and
// 1. [@TODO] parse the message in other way to create our own message structure
// 2. or just show the raw message body.
// Example of structure for malformed MIME message:
// ("text" "plain" NIL NIL NIL "7bit" 2154 70 NIL NIL NIL)
if ($headers->ctype && !is_array($structure[0]) && $headers->ctype != 'text/plain' && strtolower($structure[0].'/'.$structure[1]) == 'text/plain') { // we can handle single-part messages, by simple fix in structure (#1486898)
if (preg_match('/^(text|application)\/(.*)/', $headers->ctype, $m)) { $structure[0] = $m[1]; $structure[1] = $m[2]; } else return false; }
$struct = &$this->_structure_part($structure, 0, '', $headers); $struct->headers = get_object_vars($headers);
// don't trust given content-type
if (empty($struct->parts) && !empty($struct->headers['ctype'])) { $struct->mime_id = '1'; $struct->mimetype = strtolower($struct->headers['ctype']); list($struct->ctype_primary, $struct->ctype_secondary) = explode('/', $struct->mimetype); }
// write structure to cache
if ($this->messages_caching) $this->add_message_cache($cache_key, $this->_msg_id, $headers, $struct, $this->icache['message.id'][$uid], true); }
return $struct; }
/** * Build message part object * * @param array $part * @param int $count * @param string $parent * @access private */ function &_structure_part($part, $count=0, $parent='', $mime_headers=null) { $struct = new rcube_message_part; $struct->mime_id = empty($parent) ? (string)$count : "$parent.$count";
// multipart
if (is_array($part[0])) { $struct->ctype_primary = 'multipart';
/* RFC3501: BODYSTRUCTURE fields of multipart part part1 array part2 array part3 array .... 1. subtype 2. parameters (optional) 3. description (optional) 4. language (optional) 5. location (optional) */
// find first non-array entry
for ($i=1; $i<count($part); $i++) { if (!is_array($part[$i])) { $struct->ctype_secondary = strtolower($part[$i]); break; } }
$struct->mimetype = 'multipart/'.$struct->ctype_secondary;
// build parts list for headers pre-fetching
for ($i=0; $i<count($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])) { $tmp_part_id = $struct->mime_id ? $struct->mime_id.'.'.($i+1) : $i+1; if (strtolower($part[$i][0]) == 'message' && strtolower($part[$i][1]) == 'rfc822') { $mime_part_headers[] = $tmp_part_id; } else if (in_array('name', (array)$part[$i][2]) && empty($part[$i][3])) { $mime_part_headers[] = $tmp_part_id; } } }
// pre-fetch headers of all parts (in one command for better performance)
// @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_id, $mime_part_headers); }
$struct->parts = array(); for ($i=0, $count=0; $i<count($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, $mime_part_headers[$tmp_part_id]); }
return $struct; }
/* RFC3501: BODYSTRUCTURE fields of non-multipart part 0. type 1. subtype 2. parameters 3. id 4. description 5. encoding 6. size -- text 7. lines -- message/rfc822 7. envelope structure 8. body structure 9. lines -- x. md5 (optional) x. disposition (optional) x. language (optional) x. location (optional) */
// regular part
$struct->ctype_primary = strtolower($part[0]); $struct->ctype_secondary = strtolower($part[1]); $struct->mimetype = $struct->ctype_primary.'/'.$struct->ctype_secondary;
// read content type parameters
if (is_array($part[2])) { $struct->ctype_parameters = array(); 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'])) $struct->charset = $struct->ctype_parameters['charset']; }
// #1487700: workaround for lack of charset in malformed structure
if (empty($struct->charset) && !empty($mime_headers) && $mime_headers->charset) { $struct->charset = $mime_headers->charset; }
// read content encoding
if (!empty($part[5])) { $struct->encoding = strtolower($part[5]); $struct->headers['content-transfer-encoding'] = $struct->encoding; }
// get part size
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 (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) $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])) break; $struct->parts[] = $this->_structure_part($part[8][$i], ++$count, $struct->mime_id); } }
// get part ID
if (!empty($part[3])) { $struct->content_id = $part[3]; $struct->headers['content-id'] = $part[3];
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_id, false, $struct->mime_id); }
if (is_string($mime_headers)) $struct->headers = $this->_parse_headers($mime_headers) + $struct->headers; else if (is_object($mime_headers)) $struct->headers = get_object_vars($mime_headers) + $struct->headers;
// get real content-type of message/rfc822
if ($struct->mimetype == 'message/rfc822') { // single-part
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])) 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); } }
// normalize filename property
$this->_set_part_filename($struct, $mime_headers);
return $struct; }
/** * Set attachment filename from message part structure * * @param rcube_message_part $part Part object * @param string $headers Part's raw headers * @access private */ private function _set_part_filename(&$part, $headers=null) { if (!empty($part->d_parameters['filename'])) $filename_mime = $part->d_parameters['filename']; else if (!empty($part->d_parameters['filename*'])) $filename_encoded = $part->d_parameters['filename*']; 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'])) { $i = 0; while (isset($part->d_parameters['filename*'.$i])) { $filename_mime .= $part->d_parameters['filename*'.$i]; $i++; } // some servers (eg. dovecot-1.x) have no support for parameter value continuations
// we must fetch and parse headers "manually"
if ($i<2) { if (!$headers) { $headers = $this->conn->fetchPartHeader( $this->mailbox, $this->_msg_id, false, $part->mime_id); } $filename_mime = ''; $i = 0; while (preg_match('/filename\*'.$i.'\s*=\s*"*([^"\n;]+)[";]*/', $headers, $matches)) { $filename_mime .= $matches[1]; $i++; } } } else if (!empty($part->d_parameters['filename*0*'])) { $i = 0; while (isset($part->d_parameters['filename*'.$i.'*'])) { $filename_encoded .= $part->d_parameters['filename*'.$i.'*']; $i++; } if ($i<2) { if (!$headers) { $headers = $this->conn->fetchPartHeader( $this->mailbox, $this->_msg_id, false, $part->mime_id); } $filename_encoded = ''; $i = 0; $matches = array(); while (preg_match('/filename\*'.$i.'\*\s*=\s*"*([^"\n;]+)[";]*/', $headers, $matches)) { $filename_encoded .= $matches[1]; $i++; } } } else if (!empty($part->ctype_parameters['name*0'])) { $i = 0; while (isset($part->ctype_parameters['name*'.$i])) { $filename_mime .= $part->ctype_parameters['name*'.$i]; $i++; } if ($i<2) { if (!$headers) { $headers = $this->conn->fetchPartHeader( $this->mailbox, $this->_msg_id, false, $part->mime_id); } $filename_mime = ''; $i = 0; $matches = array(); while (preg_match('/\s+name\*'.$i.'\s*=\s*"*([^"\n;]+)[";]*/', $headers, $matches)) { $filename_mime .= $matches[1]; $i++; } } } else if (!empty($part->ctype_parameters['name*0*'])) { $i = 0; while (isset($part->ctype_parameters['name*'.$i.'*'])) { $filename_encoded .= $part->ctype_parameters['name*'.$i.'*']; $i++; } if ($i<2) { if (!$headers) { $headers = $this->conn->fetchPartHeader( $this->mailbox, $this->_msg_id, false, $part->mime_id); } $filename_encoded = ''; $i = 0; $matches = array(); while (preg_match('/\s+name\*'.$i.'\*\s*=\s*"*([^"\n;]+)[";]*/', $headers, $matches)) { $filename_encoded .= $matches[1]; $i++; } } } // read 'name' after rfc2231 parameters as it may contains truncated filename (from Thunderbird)
else if (!empty($part->ctype_parameters['name'])) $filename_mime = $part->ctype_parameters['name']; // Content-Disposition
else if (!empty($part->headers['content-description'])) $filename_mime = $part->headers['content-description']; else return;
// decode filename
if (!empty($filename_mime)) { $part->filename = rcube_imap::decode_mime_string($filename_mime, $part->charset ? $part->charset : ($this->struct_charset ? $this->struct_charset : rc_detect_encoding($filename_mime, $this->default_charset))); } else if (!empty($filename_encoded)) { // decode filename according to RFC 2231, Section 4
if (preg_match("/^([^']*)'[^']*'(.*)$/", $filename_encoded, $fmatches)) { $filename_charset = $fmatches[1]; $filename_encoded = $fmatches[2]; } $part->filename = rcube_charset_convert(urldecode($filename_encoded), $filename_charset); } }
/** * Get charset name from message structure (first part) * * @param array $structure Message structure * @return string Charset name * @access private */ private function _structure_charset($structure) { while (is_array($structure)) { if (is_array($structure[2]) && $structure[2][0] == 'charset') return $structure[2][1]; $structure = $structure[0]; } }
/** * Fetch message body of a specific message from the server * * @param int $uid Message UID * @param string $part Part number * @param rcube_message_part $o_part Part object created by get_structure() * @param mixed $print True to print part, ressource to write part contents in * @param resource $fp File pointer to save the message part * @param boolean $skip_charset_conv Disables charset conversion * * @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) { // get part encoding if not provided
if (!is_object($o_part)) { $structure_str = $this->conn->fetchStructureString($this->mailbox, $uid, true); $structure = new rcube_mime_struct(); // error or message not found
if (!$structure->loadStructure($structure_str)) { return false; }
$o_part = new rcube_message_part; $o_part->ctype_primary = strtolower($structure->getPartType($part)); $o_part->encoding = strtolower($structure->getPartEncoding($part)); $o_part->charset = $structure->getPartCharset($part); }
// TODO: Add caching for message parts
if (!$part) { $part = 'TEXT'; }
$body = $this->conn->handlePartBody($this->mailbox, $uid, true, $part, $o_part->encoding, $print, $fp);
if ($fp || $print) { return true; }
// convert charset (if text or message part)
if ($body && !$skip_charset_conv && preg_match('/^(text|message)$/', $o_part->ctype_primary) ) { if (!$o_part->charset || strtoupper($o_part->charset) == 'US-ASCII') { $o_part->charset = $this->default_charset; } $body = rcube_charset_convert($body, $o_part->charset); }
return $body; }
/** * 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 * @param resource $fp File pointer to save the message * * @return string Message source string */ function &get_raw_body($uid, $fp=null) { return $this->conn->handlePartBody($this->mailbox, $uid, true, null, null, false, $fp); }
/** * Returns the message headers as string * * @param int $uid Message UID * @return string Message headers string */ function &get_raw_headers($uid) { return $this->conn->fetchPartHeader($this->mailbox, $uid, true); }
/** * Sends the whole message source to stdout * * @param int $uid Message UID */ function print_raw_body($uid) { $this->conn->handlePartBody($this->mailbox, $uid, true, NULL, NULL, true); }
/** * Set message flag to one or several messages * * @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 boolean $skip_cache True to skip message cache clean up * * @return boolean Operation status */ function set_flag($uids, $flag, $mailbox=null, $skip_cache=false) { if (!strlen($mailbox)) { $mailbox = $this->mailbox; }
$flag = strtoupper($flag); list($uids, $all_mode) = $this->_parse_uids($uids, $mailbox);
if (strpos($flag, 'UN') === 0) $result = $this->conn->unflag($mailbox, $uids, substr($flag, 2)); else $result = $this->conn->flag($mailbox, $uids, $flag);
if ($result) { // reload message headers if cached
if ($this->messages_caching && !$skip_cache) { $cache_key = $mailbox.'.msg'; if ($all_mode) $this->clear_message_cache($cache_key); else $this->remove_message_cache($cache_key, explode(',', $uids)); }
// clear cached counters
if ($flag == 'SEEN' || $flag == 'UNSEEN') { $this->_clear_messagecount($mailbox, 'SEEN'); $this->_clear_messagecount($mailbox, 'UNSEEN'); } else if ($flag == 'DELETED') { $this->_clear_messagecount($mailbox, 'DELETED'); } }
return $result; }
/** * 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 * * @param string $mailbox Target mailbox * @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 boolean True on success, False on error */ function save_message($mailbox, &$message, $headers='', $is_file=false) { if (!strlen($mailbox)) { $mailbox = $this->mailbox; }
// 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); }
if ($saved) { // increase messagecount of the target mailbox
$this->_set_messagecount($mailbox, 'ALL', 1); }
return $saved; }
/** * Move a message from one mailbox 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 * @return boolean True on success, False on error */ function move_message($uids, $to_mbox, $from_mbox='') { if (!strlen($from_mbox)) { $from_mbox = $this->mailbox; }
if ($to_mbox === $from_mbox) { return false; }
list($uids, $all_mode) = $this->_parse_uids($uids, $from_mbox);
// 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 (in_array($to_mbox, $this->default_folders)) $this->create_mailbox($to_mbox, true); else return false; }
$config = rcmail::get_instance()->config; $to_trash = $to_mbox == $config->get('trash_mbox');
// flag messages as read before moving them
if ($to_trash && $config->get('read_when_deleted')) { // don't flush cache (4th argument)
$this->set_flag($uids, 'SEEN', $from_mbox, true); }
// move messages
$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
if ($moved) { $this->_expunge($from_mbox, false, $uids); $this->_clear_messagecount($from_mbox); $this->_clear_messagecount($to_mbox); } // moving failed
else if ($to_trash && $config->get('delete_always', false)) { $moved = $this->delete_message($uids, $from_mbox); }
if ($moved) { // unset threads internal cache
unset($this->icache['threads']);
// remove message ids from search set
if ($this->search_set && $from_mbox == $this->mailbox) { // threads are too complicated to just remove messages from set
if ($this->search_threads || $all_mode) $this->refresh_search(); else { $uids = explode(',', $uids); foreach ($uids as $uid) $a_mids[] = $this->_uid2id($uid, $from_mbox); $this->search_set = array_diff($this->search_set, $a_mids); } }
// update cached message headers
$cache_key = $from_mbox.'.msg'; if ($all_mode || ($start_index = $this->get_message_cache_index_min($cache_key, $uids))) { // clear cache from the lowest index on
$this->clear_message_cache($cache_key, $all_mode ? 1 : $start_index); } }
return $moved; }
/** * Copy a message from one mailbox 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 * @return boolean True on success, False on error */ function copy_message($uids, $to_mbox, $from_mbox='') { if (!strlen($from_mbox)) { $from_mbox = $this->mailbox; }
list($uids, $all_mode) = $this->_parse_uids($uids, $from_mbox);
// 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 (in_array($to_mbox, $this->default_folders)) $this->create_mailbox($to_mbox, true); else return false; }
// copy messages
$copied = $this->conn->copy($uids, $from_mbox, $to_mbox);
if ($copied) { $this->_clear_messagecount($to_mbox); }
return $copied; }
/** * Mark messages as deleted and expunge mailbox * * @param mixed $uids Message UIDs as array or comma-separated string, or '*' * @param string $mailbox Source mailbox * * @return boolean True on success, False on error */ function delete_message($uids, $mailbox='') { if (!strlen($mailbox)) { $mailbox = $this->mailbox; }
list($uids, $all_mode) = $this->_parse_uids($uids, $mailbox);
// exit if no message uids are specified
if (empty($uids)) return false;
$deleted = $this->conn->delete($mailbox, $uids);
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]);
// unset threads internal cache
unset($this->icache['threads']);
// remove message ids from search set
if ($this->search_set && $mailbox == $this->mailbox) { // threads are too complicated to just remove messages from set
if ($this->search_threads || $all_mode) $this->refresh_search(); else { $uids = explode(',', $uids); foreach ($uids as $uid) $a_mids[] = $this->_uid2id($uid, $mailbox); $this->search_set = array_diff($this->search_set, $a_mids); } }
// remove deleted messages from cache
$cache_key = $mailbox.'.msg'; if ($all_mode || ($start_index = $this->get_message_cache_index_min($cache_key, $uids))) { // clear cache from the lowest index on
$this->clear_message_cache($cache_key, $all_mode ? 1 : $start_index); } }
return $deleted; }
/** * Clear all messages in a specific mailbox * * @param string $mailbox Mailbox name * * @return int Above 0 on success */ function clear_mailbox($mailbox=null) { if (!strlen($mailbox)) { $mailbox = $this->mailbox; }
// SELECT will set messages count for clearFolder()
if ($this->conn->select($mailbox)) { $cleared = $this->conn->clearFolder($mailbox); }
// make sure the message count cache is cleared as well
if ($cleared) { $this->clear_message_cache($mailbox.'.msg'); $a_mailbox_cache = $this->get_cache('messagecount'); unset($a_mailbox_cache[$mailbox]); $this->update_cache('messagecount', $a_mailbox_cache); }
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; }
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')) $a_uids = is_array($uids) ? join(',', $uids) : $uids; else $a_uids = NULL;
// force mailbox selection and check if mailbox is writeable
// to prevent a situation when CLOSE is executed on closed
// or EXPUNGE on read-only mailbox
$result = $this->conn->select($mailbox); if (!$result) { return false; } if (!$this->conn->data['READ-WRITE']) { $this->conn->setError(rcube_imap_generic::ERROR_READONLY, "Mailbox is read-only"); return false; }
// CLOSE(+SELECT) should be faster than EXPUNGE
if (empty($a_uids) || $a_uids == '1:*') $result = $this->conn->close(); else $result = $this->conn->expunge($mailbox, $a_uids);
if ($result && $clear_cache) { $this->clear_message_cache($mailbox.'.msg'); $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
// @TODO: skip fetchUIDs() and work with IDs instead of UIDs (?)
else { if ($this->search_threads) $uids = $this->conn->fetchUIDs($mailbox, array_keys($this->search_set['depth'])); else $uids = $this->conn->fetchUIDs($mailbox, $this->search_set);
// save ID-to-UID mapping in local cache
if (is_array($uids)) foreach ($uids as $id => $uid) $this->uid_id_map[$mailbox][$uid] = $id;
$uids = join(',', $uids); } } else { if (is_array($uids)) $uids = join(',', $uids);
if (preg_match('/[^0-9,]/', $uids)) $uids = ''; }
return array($uids, (bool) $all); }
/** * Translate UID to message ID * * @param int $uid Message UID * @param string $mailbox Mailbox name * * @return int Message ID */ function get_id($uid, $mailbox=null) { if (!strlen($mailbox)) { $mailbox = $this->mailbox; }
return $this->_uid2id($uid, $mailbox); }
/** * Translate message number to UID * * @param int $id Message ID * @param string $mailbox Mailbox name * * @return int Message UID */ function get_uid($id, $mailbox=null) { if (!strlen($mailbox)) { $mailbox = $this->mailbox; }
return $this->_id2uid($id, $mailbox); }
/* -------------------------------- * folder managment * --------------------------------*/
/** * Public method for listing subscribed folders * * @param string $root Optional root folder * @param string $name Optional name pattern * @param string $filter Optional filter * * @return array List of mailboxes/folders * @access public */ function list_mailboxes($root='', $name='*', $filter=null) { $a_mboxes = $this->_list_mailboxes($root, $name, $filter);
// INBOX should always be available
if ((!$filter || $filter == 'mail') && !in_array('INBOX', $a_mboxes)) { array_unshift($a_mboxes, 'INBOX'); }
// sort mailboxes
$a_mboxes = $this->_sort_mailbox_list($a_mboxes);
return $a_mboxes; }
/** * Private method for mailbox listing * * @param string $root Optional root folder * @param string $name Optional name pattern * @param mixed $filter Optional filter * * @return array List of mailboxes/folders * @see rcube_imap::list_mailboxes() * @access private */ private function _list_mailboxes($root='', $name='*', $filter=null) { $cache_key = $root.':'.$name; if (!empty($filter)) { $cache_key .= ':'.(is_string($filter) ? $filter : serialize($filter)); }
$cache_key = 'mailboxes.'.md5($cache_key);
// get cached folder list
$a_mboxes = $this->get_cache($cache_key); if (is_array($a_mboxes)) { return $a_mboxes; }
$a_defaults = $a_out = array();
// Give plugins a chance to provide a list of mailboxes
$data = rcmail::get_instance()->plugins->exec_hook('mailboxes_list', array('root' => $root, 'name' => $name, 'filter' => $filter, 'mode' => 'LSUB'));
if (isset($data['folders'])) { $a_folders = $data['folders']; } else { // Server supports LIST-EXTENDED, we can use selection options
$config = rcmail::get_instance()->config; // #1486225: Some dovecot versions returns wrong result using LIST-EXTENDED
if (!$config->get('imap_force_lsub') && $this->get_capability('LIST-EXTENDED')) { // This will also set mailbox options, LSUB doesn't do that
$a_folders = $this->conn->listMailboxes($root, $name, NULL, array('SUBSCRIBED'));
// remove non-existent folders
if (is_array($a_folders)) { foreach ($a_folders as $idx => $folder) { if ($this->conn->data['LIST'] && ($opts = $this->conn->data['LIST'][$folder]) && in_array('\\NonExistent', $opts) ) { unset($a_folders[$idx]); } } } } // retrieve list of folders from IMAP server using LSUB
else { $a_folders = $this->conn->listSubscribed($root, $name); } }
if (!is_array($a_folders) || !sizeof($a_folders)) { $a_folders = array(); }
// write mailboxlist to cache
$this->update_cache($cache_key, $a_folders);
return $a_folders; }
/** * Get a list of all folders available on the IMAP server * * @param string $root IMAP root dir * @param string $name Optional name pattern * @param mixed $filter Optional filter * * @return array Indexed array with folder names */ function list_unsubscribed($root='', $name='*', $filter=null) { // @TODO: caching
// Give plugins a chance to provide a list of mailboxes
$data = rcmail::get_instance()->plugins->exec_hook('mailboxes_list', array('root' => $root, 'name' => $name, 'filter' => $filter, 'mode' => 'LIST'));
if (isset($data['folders'])) { $a_mboxes = $data['folders']; } else { // retrieve list of folders from IMAP server
$a_mboxes = $this->conn->listMailboxes($root, $name); }
if (!is_array($a_mboxes)) { $a_mboxes = array(); }
// INBOX should always be available
if ((!$filter || $filter == 'mail') && !in_array('INBOX', $a_mboxes)) { array_unshift($a_mboxes, 'INBOX'); }
// filter folders and sort them
$a_mboxes = $this->_sort_mailbox_list($a_mboxes);
return $a_mboxes; }
/** * Get mailbox quota information * added by Nuny * * @return mixed Quota info or False if not supported */ function get_quota() { if ($this->get_capability('QUOTA')) return $this->conn->getQuota();
return false; }
/** * Get mailbox size (size of all messages in a mailbox) * * @param string $mailbox Mailbox name * * @return int Mailbox size in bytes, False on error */ function get_mailbox_size($mailbox) { // @TODO: could we try to use QUOTA here?
$result = $this->conn->fetchHeaderIndex($mailbox, '1:*', 'SIZE', false);
if (is_array($result)) $result = array_sum($result);
return $result; }
/** * Subscribe to a specific mailbox(es) * * @param array $a_mboxes Mailbox name(s) * @return boolean True on success */ function subscribe($a_mboxes) { 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'); }
/** * Unsubscribe mailboxes * * @param array $a_mboxes Mailbox name(s) * @return boolean True on success */ function unsubscribe($a_mboxes) { 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'); }
/** * Create a new mailbox 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 * * @return boolean True on success */ function create_mailbox($mailbox, $subscribe=false) { $result = $this->conn->createFolder($mailbox);
// try to subscribe it
if ($result) { // clear cache
$this->clear_cache('mailboxes', true);
if ($subscribe) $this->subscribe($mailbox); }
return $result; }
/** * Set a new name to an existing mailbox * * @param string $mailbox Mailbox to rename * @param string $new_name New mailbox name * * @return boolean True on success */ function rename_mailbox($mailbox, $new_name) { if (!strlen($new_name)) { 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); } else { $a_subscribed = $this->_list_mailboxes(); $subscribed = in_array($mailbox, $a_subscribed); }
$result = $this->conn->renameFolder($mailbox, $new_name);
if ($result) { // unsubscribe the old folder, subscribe the new one
if ($subscribed) { $this->conn->unsubscribe($mailbox); $this->conn->subscribe($new_name); }
// check if mailbox children are subscribed
foreach ($a_subscribed as $c_subscribed) { if (preg_match('/^'.preg_quote($mailbox.$delm, '/').'/', $c_subscribed)) { $this->conn->unsubscribe($c_subscribed); $this->conn->subscribe(preg_replace('/^'.preg_quote($mailbox, '/').'/', $new_name, $c_subscribed)); } }
// clear cache
$this->clear_message_cache($mailbox.'.msg'); $this->clear_cache('mailboxes', true); }
return $result; }
/** * Remove mailbox from server * * @param string $mailbox Mailbox name * * @return boolean True on success */ function delete_mailbox($mailbox) { $delm = $this->get_hierarchy_delimiter();
// get list of folders
if ((strpos($mailbox, '%') === false) && (strpos($mailbox, '*') === false)) $sub_mboxes = $this->list_unsubscribed('', $mailbox . $delm . '*'); else $sub_mboxes = $this->list_unsubscribed();
// send delete command to server
$result = $this->conn->deleteFolder($mailbox);
if ($result) { // unsubscribe mailbox
$this->conn->unsubscribe($mailbox);
foreach ($sub_mboxes as $c_mbox) { if (preg_match('/^'.preg_quote($mailbox.$delm, '/').'/', $c_mbox)) { $this->conn->unsubscribe($c_mbox); if ($this->conn->deleteFolder($c_mbox)) { $this->clear_message_cache($c_mbox.'.msg'); } } }
// clear mailbox-related cache
$this->clear_message_cache($mailbox.'.msg'); $this->clear_cache('mailboxes', true); }
return $result; }
/** * Create all folders specified as default */ 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)) $this->subscribe($folder); } }
/** * Checks if folder exists and is subscribed * * @param string $mailbox Folder name * @param boolean $subscription Enable subscription checking * * @return boolean TRUE or FALSE */ function mailbox_exists($mailbox, $subscription=false) { if ($mailbox == 'INBOX') { return true; }
$key = $subscription ? 'subscribed' : 'existing';
if (is_array($this->icache[$key]) && in_array($mailbox, $this->icache[$key])) return true;
if ($subscription) { $a_folders = $this->conn->listSubscribed('', $mailbox); } else { $a_folders = $this->conn->listMailboxes('', $mailbox); }
if (is_array($a_folders) && in_array($mailbox, $a_folders)) { $this->icache[$key][] = $mailbox; return true; }
return false; }
/** * Returns the namespace where the folder is in * * @param string $mailbox Folder name * * @return string One of 'personal', 'other' or 'shared' * @access public */ function mailbox_namespace($mailbox) { if ($mailbox == 'INBOX') { return 'personal'; }
foreach ($this->namespace as $type => $namespace) { if (is_array($namespace)) { foreach ($namespace as $ns) { if (strlen($ns[0])) { if ((strlen($ns[0])>1 && $mailbox == substr($ns[0], 0, -1)) || strpos($mailbox, $ns[0]) === 0 ) { return $type; } } } } }
return 'personal'; }
/** * Modify folder name according to namespace. * For output it removes prefix of the personal namespace if it's possible. * 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 $mode Mode name (out/in) * * @return string Folder name */ function mod_mailbox($mailbox, $mode = 'out') { if (!strlen($mailbox)) { return $mailbox; }
$prefix = $this->namespace['prefix']; // see set_env()
$prefix_len = strlen($prefix);
if (!$prefix_len) { return $mailbox; }
// remove prefix for output
if ($mode == 'out') { if (substr($mailbox, 0, $prefix_len) === $prefix) { return substr($mailbox, $prefix_len); } } // add prefix for input (e.g. folder creation)
else { return $prefix . $mailbox; }
return $mailbox; }
/** * Gets folder options from LIST response, e.g. \Noselect, \Noinferiors * * @param string $mailbox Folder name * @param bool $force Set to True if options should be refreshed * Options are available after LIST command only * * @return array Options list */ function mailbox_options($mailbox, $force=false) { if ($mailbox == 'INBOX') { return array(); }
if (!is_array($this->conn->data['LIST']) || !is_array($this->conn->data['LIST'][$mailbox])) { if ($force) { $this->conn->listMailboxes('', $mailbox); } else { return array(); } }
$opts = $this->conn->data['LIST'][$mailbox];
return is_array($opts) ? $opts : array(); }
/** * Returns extended information about the folder * * @param string $mailbox Folder name * * @return array Data */ function mailbox_info($mailbox) { $acl = $this->get_capability('ACL'); $namespace = $this->get_namespace(); $options = array();
// check if the folder is a namespace prefix
if (!empty($namespace)) { $mbox = $mailbox . $this->delimiter; foreach ($namespace as $ns) { if (!empty($ns)) { foreach ($ns as $item) { if ($item[0] === $mbox) { $options['is_root'] = true; break 2; } } } } } // check if the folder is other user virtual-root
if (!$options['is_root'] && !empty($namespace) && !empty($namespace['other'])) { $parts = explode($this->delimiter, $mailbox); if (count($parts) == 2) { $mbox = $parts[0] . $this->delimiter; foreach ($namespace['other'] as $item) { if ($item[0] === $mbox) { $options['is_root'] = true; break; } } } }
$options['name'] = $mailbox; $options['options'] = $this->mailbox_options($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);
// Set 'noselect' and 'norename' flags
if (is_array($options['options'])) { foreach ($options['options'] as $opt) { $opt = strtolower($opt); if ($opt == '\noselect' || $opt == '\nonexistent') { $options['noselect'] = true; } } } else { $options['noselect'] = true; }
if (!empty($options['rights'])) { $options['norename'] = !in_array('x', $options['rights']); if (!$options['noselect']) { $options['noselect'] = !in_array('r', $options['rights']); } } else { $options['norename'] = $options['is_root'] || $options['namespace'] != 'personal'; }
return $options; }
/** * Get message header names for rcube_imap_generic::fetchHeader(s) * * @return string Space-separated list of header names */ private function get_fetch_headers() { $headers = explode(' ', $this->fetch_add_headers); $headers = array_map('strtoupper', $headers);
if ($this->messages_caching || $this->get_all_headers) $headers = array_merge($headers, $this->all_headers);
return implode(' ', array_unique($headers)); }
/* ----------------------------------------- * ACL and METADATA/ANNOTATEMORE methods * ----------------------------------------*/
/** * Changes the ACL on the specified mailbox (SETACL) * * @param string $mailbox Mailbox 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) { if ($this->get_capability('ACL')) return $this->conn->setACL($mailbox, $user, $acl);
return false; }
/** * Removes any <identifier,rights> pair for the * specified user from the ACL for the specified * mailbox (DELETEACL) * * @param string $mailbox Mailbox 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) { if ($this->get_capability('ACL')) return $this->conn->deleteACL($mailbox, $user);
return false; }
/** * Returns the access control list for mailbox (GETACL) * * @param string $mailbox Mailbox name * * @return array User-rights array on success, NULL on error * @access public * @since 0.5-beta */ function get_acl($mailbox) { if ($this->get_capability('ACL')) return $this->conn->getACL($mailbox);
return NULL; }
/** * Returns information about what rights can be granted to the * user (identifier) in the ACL for the mailbox (LISTRIGHTS) * * @param string $mailbox Mailbox name * @param string $user User name * * @return array List of user rights * @access public * @since 0.5-beta */ function list_rights($mailbox, $user) { if ($this->get_capability('ACL')) return $this->conn->listRights($mailbox, $user);
return NULL; }
/** * Returns the set of rights that the current user has to * mailbox (MYRIGHTS) * * @param string $mailbox Mailbox name * * @return array MYRIGHTS response on success, NULL on error * @access public * @since 0.5-beta */ function my_rights($mailbox) { if ($this->get_capability('ACL')) return $this->conn->myRights($mailbox);
return NULL; }
/** * Sets IMAP metadata/annotations (SETMETADATA/SETANNOTATION) * * @param string $mailbox Mailbox 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) { if ($this->get_capability('METADATA') || (!strlen($mailbox) && $this->get_capability('METADATA-SERVER')) ) { return $this->conn->setMetadata($mailbox, $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 false; }
/** * Unsets IMAP metadata/annotations (SETMETADATA/SETANNOTATION) * * @param string $mailbox Mailbox 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) { if ($this->get_capability('METADATA') || (!strlen($mailbox) && $this->get_capability('METADATA-SERVER')) ) { return $this->conn->deleteMetadata($mailbox, $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 false; }
/** * Returns IMAP metadata/annotations (GETMETADATA/GETANNOTATION) * * @param string $mailbox Mailbox 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()) { if ($this->get_capability('METADATA') || (!strlen($mailbox) && $this->get_capability('METADATA-SERVER')) ) { return $this->conn->getMetadata($mailbox, $entries, $options); } else if ($this->get_capability('ANNOTATEMORE') || $this->get_capability('ANNOTATEMORE2')) { $queries = array(); $res = array();
// Convert entry names
foreach ((array)$entries as $entry) { list($ent, $attr) = $this->md2annotate($entry); $queries[$attr][] = $ent; }
// @TODO: Honor MAXSIZE and DEPTH options
foreach ($queries as $attrib => $entry) if ($result = $this->conn->getAnnotation($mailbox, $entry, $attrib)) $res = array_merge($res, $result);
return $res; }
return NULL; }
/** * Converts the METADATA extension entry name into the correct * entry-attrib names for older ANNOTATEMORE version. * * @param string $entry Entry name * * @return array Entry-attribute list, NULL if not supported (?) */ private function md2annotate($entry) { if (substr($entry, 0, 7) == '/shared') { return array(substr($entry, 7), 'value.shared'); } else if (substr($entry, 0, 8) == '/private') { return array(substr($entry, 8), 'value.priv'); }
// @TODO: log error
return NULL; }
/* -------------------------------- * internal caching methods * --------------------------------*/
/** * Enable or disable indexes caching * * @param boolean $type Cache type (@see rcmail::get_cache) * @access public */ function set_caching($type) { if ($type) { $this->caching = true; } else { if ($this->cache) $this->cache->close(); $this->cache = null; $this->caching = false; } }
/** * Getter for IMAP cache object */ private function get_cache_engine() { if ($this->caching && !$this->cache) { $rcmail = rcmail::get_instance(); $this->cache = $rcmail->get_cache('IMAP', $type); }
return $this->cache; }
/** * Returns cached value * * @param string $key Cache key * @return mixed * @access public */ function get_cache($key) { if ($cache = $this->get_cache_engine()) { return $cache->get($key); } }
/** * Update cache * * @param string $key Cache key * @param mixed $data Data * @access public */ function update_cache($key, $data) { if ($cache = $this->get_cache_engine()) { $cache->set($key, $data); } }
/** * Clears the cache. * * @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) { if ($cache = $this->get_cache_engine()) { $cache->remove($key, $prefix_mode); } }
/* -------------------------------- * message caching methods * --------------------------------*/
/** * Enable or disable messages caching * * @param boolean $set Flag * @access public */ function set_messages_caching($set) { $rcmail = rcmail::get_instance();
if ($set && ($dbh = $rcmail->get_dbh())) { $this->db = $dbh; $this->messages_caching = true; } else { $this->messages_caching = false; } }
/** * Checks if the cache is up-to-date * * @param string $mailbox Mailbox name * @param string $cache_key Internal cache key * @return int Cache status: -3 = off, -2 = incomplete, -1 = dirty, 1 = OK */ private function check_cache_status($mailbox, $cache_key) { if (!$this->messages_caching) return -3;
$cache_index = $this->get_message_cache_index($cache_key); $msg_count = $this->_messagecount($mailbox); $cache_count = count($cache_index);
// empty mailbox
if (!$msg_count) { return $cache_count ? -2 : 1; }
if ($cache_count == $msg_count) { if ($this->skip_deleted) { if (!empty($this->icache['all_undeleted_idx'])) { $uids = rcube_imap_generic::uncompressMessageSet($this->icache['all_undeleted_idx']); $uids = array_flip($uids); foreach ($cache_index as $uid) { unset($uids[$uid]); } } else { // get all undeleted messages excluding cached UIDs
$uids = $this->search_once($mailbox, 'ALL UNDELETED NOT UID '. rcube_imap_generic::compressMessageSet($cache_index)); } if (empty($uids)) { return 1; } } else { // get UID of the message with highest index
$uid = $this->_id2uid($msg_count, $mailbox); $cache_uid = array_pop($cache_index);
// uids of highest message matches -> cache seems OK
if ($cache_uid == $uid) { return 1; } } // cache is dirty
return -1; }
// if cache count differs less than 10% report as dirty
return (abs($msg_count - $cache_count) < $msg_count/10) ? -1 : -2; }
/** * @param string $key Cache key * @param string $from * @param string $to * @param string $sort_field * @param string $sort_order * @access private */ private function get_message_cache($key, $from, $to, $sort_field, $sort_order) { if (!$this->messages_caching) return NULL;
// use idx sort as default sorting
if (!$sort_field || !in_array($sort_field, $this->db_header_fields)) { $sort_field = 'idx'; }
$result = array();
$sql_result = $this->db->limitquery( "SELECT idx, uid, headers". " FROM ".get_table_name('messages'). " WHERE user_id=?". " AND cache_key=?". " ORDER BY ".$this->db->quoteIdentifier($sort_field)." ".strtoupper($sort_order), $from, $to - $from, $_SESSION['user_id'], $key);
while ($sql_arr = $this->db->fetch_assoc($sql_result)) { $uid = intval($sql_arr['uid']); $result[$uid] = $this->db->decode(unserialize($sql_arr['headers']));
// featch headers if unserialize failed
if (empty($result[$uid])) $result[$uid] = $this->conn->fetchHeader( preg_replace('/.msg$/', '', $key), $uid, true, false, $this->get_fetch_headers()); }
return $result; }
/** * @param string $key Cache key * @param int $uid Message UID * @return mixed * @access private */ private function &get_cached_message($key, $uid) { $internal_key = 'message';
if ($this->messages_caching && !isset($this->icache[$internal_key][$uid])) { $sql_result = $this->db->query( "SELECT idx, headers, structure, message_id". " FROM ".get_table_name('messages'). " WHERE user_id=?". " AND cache_key=?". " AND uid=?", $_SESSION['user_id'], $key, $uid);
if ($sql_arr = $this->db->fetch_assoc($sql_result)) { $this->icache['message.id'][$uid] = intval($sql_arr['message_id']); $this->uid_id_map[preg_replace('/\.msg$/', '', $key)][$uid] = intval($sql_arr['idx']); $this->icache[$internal_key][$uid] = $this->db->decode(unserialize($sql_arr['headers']));
if (is_object($this->icache[$internal_key][$uid]) && !empty($sql_arr['structure'])) $this->icache[$internal_key][$uid]->structure = $this->db->decode(unserialize($sql_arr['structure'])); } }
return $this->icache[$internal_key][$uid]; }
/** * @param string $key Cache key * @param string $sort_field Sorting column * @param string $sort_order Sorting order * @return array Messages index * @access private */ private function get_message_cache_index($key, $sort_field='idx', $sort_order='ASC') { if (!$this->messages_caching || empty($key)) return NULL;
// use idx sort as default
if (!$sort_field || !in_array($sort_field, $this->db_header_fields)) $sort_field = 'idx';
if (array_key_exists('index', $this->icache) && $this->icache['index']['key'] == $key && $this->icache['index']['sort_field'] == $sort_field ) { if ($this->icache['index']['sort_order'] == $sort_order) return $this->icache['index']['result']; else return array_reverse($this->icache['index']['result'], true); }
$this->icache['index'] = array( 'result' => array(), 'key' => $key, 'sort_field' => $sort_field, 'sort_order' => $sort_order, );
$sql_result = $this->db->query( "SELECT idx, uid". " FROM ".get_table_name('messages'). " WHERE user_id=?". " AND cache_key=?". " ORDER BY ".$this->db->quote_identifier($sort_field)." ".$sort_order, $_SESSION['user_id'], $key);
while ($sql_arr = $this->db->fetch_assoc($sql_result)) $this->icache['index']['result'][$sql_arr['idx']] = intval($sql_arr['uid']);
return $this->icache['index']['result']; }
/** * @access private */ private function add_message_cache($key, $index, $headers, $struct=null, $force=false, $internal_cache=false) { if (empty($key) || !is_object($headers) || empty($headers->uid)) return;
// add to internal (fast) cache
if ($internal_cache) { $this->icache['message'][$headers->uid] = clone $headers; $this->icache['message'][$headers->uid]->structure = $struct; }
// no further caching
if (!$this->messages_caching) return;
// known message id
if (is_int($force) && $force > 0) { $message_id = $force; } // check for an existing record (probably headers are cached but structure not)
else if (!$force) { $sql_result = $this->db->query( "SELECT message_id". " FROM ".get_table_name('messages'). " WHERE user_id=?". " AND cache_key=?". " AND uid=?", $_SESSION['user_id'], $key, $headers->uid);
if ($sql_arr = $this->db->fetch_assoc($sql_result)) $message_id = $sql_arr['message_id']; }
// update cache record
if ($message_id) { $this->db->query( "UPDATE ".get_table_name('messages'). " SET idx=?, headers=?, structure=?". " WHERE message_id=?", $index, serialize($this->db->encode(clone $headers)), is_object($struct) ? serialize($this->db->encode(clone $struct)) : NULL, $message_id ); } else { // insert new record
$this->db->query( "INSERT INTO ".get_table_name('messages'). " (user_id, del, cache_key, created, idx, uid, subject, ". $this->db->quoteIdentifier('from').", ". $this->db->quoteIdentifier('to').", ". "cc, date, size, headers, structure)". " VALUES (?, 0, ?, ".$this->db->now().", ?, ?, ?, ?, ?, ?, ". $this->db->fromunixtime($headers->timestamp).", ?, ?, ?)", $_SESSION['user_id'], $key, $index, $headers->uid, (string)mb_substr($this->db->encode($this->decode_header($headers->subject, true)), 0, 128), (string)mb_substr($this->db->encode($this->decode_header($headers->from, true)), 0, 128), (string)mb_substr($this->db->encode($this->decode_header($headers->to, true)), 0, 128), (string)mb_substr($this->db->encode($this->decode_header($headers->cc, true)), 0, 128), (int)$headers->size, serialize($this->db->encode(clone $headers)), is_object($struct) ? serialize($this->db->encode(clone $struct)) : NULL ); }
unset($this->icache['index']); }
/** * @access private */ private function remove_message_cache($key, $ids, $idx=false) { if (!$this->messages_caching) return;
$this->db->query( "DELETE FROM ".get_table_name('messages'). " WHERE user_id=?". " AND cache_key=?". " AND ".($idx ? "idx" : "uid")." IN (".$this->db->array2list($ids, 'integer').")", $_SESSION['user_id'], $key);
unset($this->icache['index']); }
/** * @param string $key Cache key * @param int $start_index Start index * @access private */ private function clear_message_cache($key, $start_index=1) { if (!$this->messages_caching) return;
$this->db->query( "DELETE FROM ".get_table_name('messages'). " WHERE user_id=?". " AND cache_key=?". " AND idx>=?", $_SESSION['user_id'], $key, $start_index);
unset($this->icache['index']); }
/** * @access private */ private function get_message_cache_index_min($key, $uids=NULL) { if (!$this->messages_caching) return;
if (!empty($uids) && !is_array($uids)) { if ($uids == '*' || $uids == '1:*') $uids = NULL; else $uids = explode(',', $uids); }
$sql_result = $this->db->query( "SELECT MIN(idx) AS minidx". " FROM ".get_table_name('messages'). " WHERE user_id=?". " AND cache_key=?" .(!empty($uids) ? " AND uid IN (".$this->db->array2list($uids, 'integer').")" : ''), $_SESSION['user_id'], $key);
if ($sql_arr = $this->db->fetch_assoc($sql_result)) return $sql_arr['minidx']; else return 0; }
/** * @param string $key Cache key * @param int $id Message (sequence) ID * @return int Message UID * @access private */ private function get_cache_id2uid($key, $id) { if (!$this->messages_caching) return null;
if (array_key_exists('index', $this->icache) && $this->icache['index']['key'] == $key ) { return $this->icache['index']['result'][$id]; }
$sql_result = $this->db->query( "SELECT uid". " FROM ".get_table_name('messages'). " WHERE user_id=?". " AND cache_key=?". " AND idx=?", $_SESSION['user_id'], $key, $id);
if ($sql_arr = $this->db->fetch_assoc($sql_result)) return intval($sql_arr['uid']);
return null; }
/** * @param string $key Cache key * @param int $uid Message UID * @return int Message (sequence) ID * @access private */ private function get_cache_uid2id($key, $uid) { if (!$this->messages_caching) return null;
if (array_key_exists('index', $this->icache) && $this->icache['index']['key'] == $key ) { return array_search($uid, $this->icache['index']['result']); }
$sql_result = $this->db->query( "SELECT idx". " FROM ".get_table_name('messages'). " WHERE user_id=?". " AND cache_key=?". " AND uid=?", $_SESSION['user_id'], $key, $uid);
if ($sql_arr = $this->db->fetch_assoc($sql_result)) return intval($sql_arr['idx']);
return null; }
/* -------------------------------- * encoding/decoding methods * --------------------------------*/
/** * Split an address list into a structured array list * * @param string $input Input string * @param int $max List only this number of addresses * @param boolean $decode Decode address strings * @return array Indexed list of addresses */ function decode_address_list($input, $max=null, $decode=true) { $a = $this->_parse_address_list($input, $decode); $out = array(); // Special chars as defined by RFC 822 need to in quoted string (or escaped).
$special_chars = '[\(\)\<\>\\\.\[\]@,;:"]';
if (!is_array($a)) return $out;
$c = count($a); $j = 0;
foreach ($a as $val) { $j++; $address = trim($val['address']); $name = trim($val['name']);
if ($name && $address && $name != $address) $string = sprintf('%s <%s>', preg_match("/$special_chars/", $name) ? '"'.addcslashes($name, '"').'"' : $name, $address); else if ($address) $string = $address; else if ($name) $string = $name;
$out[$j] = array( 'name' => $name, 'mailto' => $address, 'string' => $string );
if ($max && $j==$max) break; }
return $out; }
/** * Decode a message header value * * @param string $input Header value * @param boolean $remove_quotas Remove quotes if necessary * @return string Decoded string */ function decode_header($input, $remove_quotes=false) { $str = rcube_imap::decode_mime_string((string)$input, $this->default_charset); if ($str[0] == '"' && $remove_quotes) $str = str_replace('"', '', $str);
return $str; }
/** * Decode a mime-encoded string to internal charset * * @param string $input Header value * @param string $fallback Fallback charset if none specified * * @return string Decoded string * @static */ public static function decode_mime_string($input, $fallback=null) { if (!empty($fallback)) { $default_charset = $fallback; } else { $default_charset = rcmail::get_instance()->config->get('default_charset', 'ISO-8859-1'); }
// rfc: all line breaks or other characters not found
// in the Base64 Alphabet must be ignored by decoding software
// delete all blanks between MIME-lines, differently we can
// receive unnecessary blanks and broken utf-8 symbols
$input = preg_replace("/\?=\s+=\?/", '?==?', $input);
// encoded-word regexp
$re = '/=\?([^?]+)\?([BbQq])\?([^?\n]*)\?=/';
// Find all RFC2047's encoded words
if (preg_match_all($re, $input, $matches, PREG_OFFSET_CAPTURE | PREG_SET_ORDER)) { // Initialize variables
$tmp = array(); $out = ''; $start = 0;
foreach ($matches as $idx => $m) { $pos = $m[0][1]; $charset = $m[1][0]; $encoding = $m[2][0]; $text = $m[3][0]; $length = strlen($m[0][0]);
// Append everything that is before the text to be decoded
if ($start != $pos) { $substr = substr($input, $start, $pos-$start); $out .= rcube_charset_convert($substr, $default_charset); $start = $pos; } $start += $length;
// Per RFC2047, each string part "MUST represent an integral number
// of characters . A multi-octet character may not be split across
// adjacent encoded-words." However, some mailers break this, so we
// try to handle characters spanned across parts anyway by iterating
// through and aggregating sequential encoded parts with the same
// character set and encoding, then perform the decoding on the
// aggregation as a whole.
$tmp[] = $text; if ($next_match = $matches[$idx+1]) { if ($next_match[0][1] == $start && $next_match[1][0] == $charset && $next_match[2][0] == $encoding ) { continue; } }
$count = count($tmp); $text = '';
// Decode and join encoded-word's chunks
if ($encoding == 'B' || $encoding == 'b') { // base64 must be decoded a segment at a time
for ($i=0; $i<$count; $i++) $text .= base64_decode($tmp[$i]); } else { //if ($encoding == 'Q' || $encoding == 'q') {
// quoted printable can be combined and processed at once
for ($i=0; $i<$count; $i++) $text .= $tmp[$i];
$text = str_replace('_', ' ', $text); $text = quoted_printable_decode($text); }
$out .= rcube_charset_convert($text, $charset); $tmp = array(); }
// add the last part of the input string
if ($start != strlen($input)) { $out .= rcube_charset_convert(substr($input, $start), $default_charset); }
// return the results
return $out; }
// no encoding information, use fallback
return rcube_charset_convert($input, $default_charset); }
/** * Decode a mime part * * @param string $input Input string * @param string $encoding Part encoding * @return string Decoded string */ function mime_decode($input, $encoding='7bit') { switch (strtolower($encoding)) { case 'quoted-printable': return quoted_printable_decode($input); case 'base64': return base64_decode($input); case 'x-uuencode': case 'x-uue': case 'uue': case 'uuencode': return convert_uudecode($input); case '7bit': default: return $input; } }
/** * Convert body charset to RCMAIL_CHARSET according to the ctype_parameters * * @param string $body Part body to decode * @param string $ctype_param Charset to convert from * @return string Content converted to internal charset */ function charset_decode($body, $ctype_param) { if (is_array($ctype_param) && !empty($ctype_param['charset'])) return rcube_charset_convert($body, $ctype_param['charset']);
// defaults to what is specified in the class header
return rcube_charset_convert($body, $this->default_charset); }
/* -------------------------------- * private methods * --------------------------------*/
/** * Validate the given input and save to local properties * * @param string $sort_field Sort column * @param string $sort_order Sort order * @access private */ private function _set_sort_order($sort_field, $sort_order) { if ($sort_field != null) $this->sort_field = asciiwords($sort_field); if ($sort_order != null) $this->sort_order = strtoupper($sort_order) == 'DESC' ? 'DESC' : 'ASC'; }
/** * Sort mailboxes first by default folders and then in alphabethical order * * @param array $a_folders Mailboxes list * @access private */ private function _sort_mailbox_list($a_folders) { $a_out = $a_defaults = $folders = array();
$delimiter = $this->get_hierarchy_delimiter();
// find default folders and skip folders starting with '.'
foreach ($a_folders as $i => $folder) { if ($folder[0] == '.') continue;
if (($p = array_search($folder, $this->default_folders)) !== false && !$a_defaults[$p]) $a_defaults[$p] = $folder; else $folders[$folder] = rcube_charset_convert($folder, 'UTF7-IMAP'); }
// sort folders and place defaults on the top
asort($folders, SORT_LOCALE_STRING); ksort($a_defaults); $folders = array_merge($a_defaults, array_keys($folders));
// finally we must rebuild the list to move
// subfolders of default folders to their place...
// ...also do this for the rest of folders because
// asort() is not properly sorting case sensitive names
while (list($key, $folder) = each($folders)) { // set the type of folder name variable (#1485527)
$a_out[] = (string) $folder; unset($folders[$key]); $this->_rsort($folder, $delimiter, $folders, $a_out); }
return $a_out; }
/** * @access private */ private 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); } } reset($list); }
/** * @param int $uid Message UID * @param string $mailbox Mailbox name * @return int Message (sequence) ID * @access private */ private function _uid2id($uid, $mailbox=NULL) { if (!strlen($mailbox)) { $mailbox = $this->mailbox; }
if (!isset($this->uid_id_map[$mailbox][$uid])) { if (!($id = $this->get_cache_uid2id($mailbox.'.msg', $uid))) $id = $this->conn->UID2ID($mailbox, $uid);
$this->uid_id_map[$mailbox][$uid] = $id; }
return $this->uid_id_map[$mailbox][$uid]; }
/** * @param int $id Message (sequence) ID * @param string $mailbox Mailbox name * * @return int Message UID * @access private */ private function _id2uid($id, $mailbox=null) { if (!strlen($mailbox)) { $mailbox = $this->mailbox; }
if ($uid = array_search($id, (array)$this->uid_id_map[$mailbox])) { return $uid; }
if (!($uid = $this->get_cache_id2uid($mailbox.'.msg', $id))) { $uid = $this->conn->ID2UID($mailbox, $id); }
$this->uid_id_map[$mailbox][$uid] = $id;
return $uid; }
/** * Subscribe/unsubscribe a list of mailboxes and update local cache * @access private */ private function _change_subscription($a_mboxes, $mode) { $updated = false;
if (is_array($a_mboxes)) foreach ($a_mboxes as $i => $mailbox) { $a_mboxes[$i] = $mailbox;
if ($mode == 'subscribe') $updated = $this->conn->subscribe($mailbox); else if ($mode == 'unsubscribe') $updated = $this->conn->unsubscribe($mailbox); }
// clear cached mailbox list(s)
if ($updated) { $this->clear_cache('mailboxes', true); }
return $updated; }
/** * Increde/decrese messagecount for a specific mailbox * @access private */ private function _set_messagecount($mailbox, $mode, $increment) { $mode = strtoupper($mode); $a_mailbox_cache = $this->get_cache('messagecount');
if (!is_array($a_mailbox_cache[$mailbox]) || !isset($a_mailbox_cache[$mailbox][$mode]) || !is_numeric($increment)) return false;
// add incremental value to messagecount
$a_mailbox_cache[$mailbox][$mode] += $increment;
// there's something wrong, delete from cache
if ($a_mailbox_cache[$mailbox][$mode] < 0) unset($a_mailbox_cache[$mailbox][$mode]);
// write back to cache
$this->update_cache('messagecount', $a_mailbox_cache);
return true; }
/** * Remove messagecount of a specific mailbox from cache * @access private */ private function _clear_messagecount($mailbox, $mode=null) { $a_mailbox_cache = $this->get_cache('messagecount');
if (is_array($a_mailbox_cache[$mailbox])) { if ($mode) { unset($a_mailbox_cache[$mailbox][$mode]); } else { unset($a_mailbox_cache[$mailbox]); } $this->update_cache('messagecount', $a_mailbox_cache); } }
/** * Split RFC822 header string into an associative array * @access private */ private function _parse_headers($headers) { $a_headers = array(); $headers = preg_replace('/\r?\n(\t| )+/', ' ', $headers); $lines = explode("\n", $headers); $c = count($lines);
for ($i=0; $i<$c; $i++) { if ($p = strpos($lines[$i], ': ')) { $field = strtolower(substr($lines[$i], 0, $p)); $value = trim(substr($lines[$i], $p+1)); if (!empty($value)) $a_headers[$field] = $value; } }
return $a_headers; }
/** * @access private */ private function _parse_address_list($str, $decode=true) { // remove any newlines and carriage returns before
$str = preg_replace('/\r?\n(\s|\t)?/', ' ', $str);
// extract list items, remove comments
$str = self::explode_header_string(',;', $str, true); $result = array();
foreach ($str as $key => $val) { $name = ''; $address = ''; $val = trim($val);
if (preg_match('/(.*)<(\S+@\S+)>$/', $val, $m)) { $address = $m[2]; $name = trim($m[1]); } else if (preg_match('/^(\S+@\S+)$/', $val, $m)) { $address = $m[1]; $name = ''; } else { $name = $val; }
// dequote and/or decode name
if ($name) { if ($name[0] == '"') { $name = substr($name, 1, -1); $name = stripslashes($name); } if ($decode) { $name = $this->decode_header($name); } }
if (!$address && $name) { $address = $name; }
if ($address) { $result[$key] = array('name' => $name, 'address' => $address); } }
return $result; }
/** * Explodes header (e.g. address-list) string into array of strings * using specified separator characters with proper handling * of quoted-strings and comments (RFC2822) * * @param string $separator String containing separator characters * @param string $str Header string * @param bool $remove_comments Enable to remove comments * * @return array Header items */ static function explode_header_string($separator, $str, $remove_comments=false) { $length = strlen($str); $result = array(); $quoted = false; $comment = 0; $out = '';
for ($i=0; $i<$length; $i++) { // we're inside a quoted string
if ($quoted) { if ($str[$i] == '"') { $quoted = false; } else if ($str[$i] == '\\') { if ($comment <= 0) { $out .= '\\'; } $i++; } } // we're inside a comment string
else if ($comment > 0) { if ($str[$i] == ')') { $comment--; } else if ($str[$i] == '(') { $comment++; } else if ($str[$i] == '\\') { $i++; } continue; } // separator, add to result array
else if (strpos($separator, $str[$i]) !== false) { if ($out) { $result[] = $out; } $out = ''; continue; } // start of quoted string
else if ($str[$i] == '"') { $quoted = true; } // start of comment
else if ($remove_comments && $str[$i] == '(') { $comment++; }
if ($comment <= 0) { $out .= $str[$i]; } }
if ($out && $comment <= 0) { $result[] = $out; }
return $result; }
/** * This is our own debug handler for the IMAP connection * @access public */ public function debug_handler(&$imap, $message) { write_log('imap', $message); }
} // end class rcube_imap
/** * 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{ var $sequence_numbers = array();
/** * Set the predetermined sort order. * * @param array $seqnums Numerically indexed array of IMAP message sequence numbers */ function set_sequence_numbers($seqnums) { $this->sequence_numbers = array_flip($seqnums); }
/** * Sort the array of header objects * * @param array $headers Array of rcube_mail_header objects indexed by UID */ function sort_headers(&$headers) { /* * uksort would work if the keys were the sequence number, but unfortunately * the keys are the UIDs. We'll use uasort instead and dereference the value * to get the sequence number (in the "id" field). * * uksort($headers, array($this, "compare_seqnums")); */ uasort($headers, array($this, "compare_seqnums")); }
/** * Sort method called by uasort() * * @param rcube_mail_header $a * @param rcube_mail_header $b */ function compare_seqnums($a, $b) { // First get the sequence number from the header object (the 'id' field).
$seqa = $a->id; $seqb = $b->id;
// then find each sequence number in my ordered list
$posa = isset($this->sequence_numbers[$seqa]) ? intval($this->sequence_numbers[$seqa]) : -1; $posb = isset($this->sequence_numbers[$seqb]) ? intval($this->sequence_numbers[$seqb]) : -1;
// return the relative position as the comparison value
return $posa - $posb; }}
|
