From 107bde9cfd9a0392d18544b5a433552ce6f2f0a6 Mon Sep 17 00:00:00 2001 From: thomascube <thomas@roundcube.net> Date: Wed, 30 Aug 2006 13:41:21 -0400 Subject: [PATCH] Added MSSQL support --- program/include/rcube_imap.inc | 2063 +++++++++++++++++++++++++++++++++++++++++++++++----------- 1 files changed, 1,656 insertions(+), 407 deletions(-) diff --git a/program/include/rcube_imap.inc b/program/include/rcube_imap.inc index 2237b38..a11c749 100644 --- a/program/include/rcube_imap.inc +++ b/program/include/rcube_imap.inc @@ -21,58 +21,98 @@ */ +/** + * Obtain classes from the Iloha IMAP library + */ require_once('lib/imap.inc'); require_once('lib/mime.inc'); -require_once('lib/utf7.inc'); +/** + * Interface class for accessing an IMAP server + * + * This is a wrapper that implements the Iloha IMAP Library (IIL) + * + * @package RoundCube Webmail + * @author Thomas Bruederli <roundcube@gmail.com> + * @version 1.34 + * @link http://ilohamail.org + */ class rcube_imap { + var $db; var $conn; var $root_ns = ''; var $root_dir = ''; var $mailbox = 'INBOX'; var $list_page = 1; var $page_size = 10; + var $sort_field = 'date'; + var $sort_order = 'DESC'; var $delimiter = NULL; var $caching_enabled = FALSE; - var $default_folders = array('inbox', 'drafts', 'sent', 'junk', 'trash'); + var $default_folders = array('INBOX'); + var $default_folders_lc = array('inbox'); var $cache = array(); - var $cache_changes = array(); + var $cache_keys = array(); + var $cache_changes = array(); var $uid_id_map = array(); var $msg_headers = array(); + var $capabilities = array(); + var $skip_deleted = FALSE; + var $debug_level = 1; - // PHP 5 constructor - function __construct() + /** + * Object constructor + * + * @param object Database connection + */ + function __construct($db_conn) { - - } - - // PHP 4 compatibility - function rcube_imap() - { - $this->__construct(); + $this->db = $db_conn; } + /** + * PHP 4 object constructor + * + * @see rcube_imap::__construct + */ + function rcube_imap($db_conn) + { + $this->__construct($db_conn); + } + + + /** + * Connect to an IMAP server + * + * @param string Host to connect + * @param string Username for IMAP account + * @param string Password for IMAP account + * @param number Port to connect to + * @param boolean Use SSL connection + * @return boolean TRUE on success, FALSE on failure + * @access public + */ function connect($host, $user, $pass, $port=143, $use_ssl=FALSE) { - global $ICL_SSL, $ICL_PORT, $CONFIG; + global $ICL_SSL, $ICL_PORT, $IMAP_USE_INTERNAL_DATE; // check for Open-SSL support in PHP build if ($use_ssl && in_array('openssl', get_loaded_extensions())) $ICL_SSL = TRUE; else if ($use_ssl) { - raise_error(array('code' => 403, - 'type' => 'imap', - 'file' => __FILE__, + raise_error(array('code' => 403, 'type' => 'imap', 'file' => __FILE__, 'message' => 'Open SSL not available;'), TRUE, FALSE); $port = 143; } $ICL_PORT = $port; + $IMAP_USE_INTERNAL_DATE = false; + $this->conn = iil_Connect($host, $user, $pass, array('imap' => 'check')); $this->host = $host; $this->user = $user; @@ -81,7 +121,7 @@ $this->ssl = $use_ssl; // print trace mesages - if ($this->conn && ($CONFIG['debug_level'] & 8)) + if ($this->conn && ($this->debug_level & 8)) console($this->conn->message); // write error log @@ -92,10 +132,10 @@ 'message' => $GLOBALS['iil_error']), TRUE, FALSE); } - // get account namespace + // get server properties if ($this->conn) { - iil_C_NameSpace($this->conn); + $this->_parse_capability($this->conn->capability); if (!empty($this->conn->delimiter)) $this->delimiter = $this->conn->delimiter; @@ -110,6 +150,12 @@ } + /** + * Close IMAP connection + * Usually done on script shutdown + * + * @access public + */ function close() { if ($this->conn) @@ -117,6 +163,12 @@ } + /** + * 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->close(); @@ -124,6 +176,15 @@ } + /** + * Set a root folder for the IMAP connection. + * + * Only folders within this root folder will be displayed + * and all folder paths will be translated using this folder name + * + * @param string Root folder + * @access public + */ function set_rootdir($root) { if (ereg('[\.\/]$', $root)) //(substr($root, -1, 1)==='/') @@ -136,26 +197,41 @@ } + /** + * This list of folders will be listed above all other folders + * + * @param array Indexed list of folder names + * @access public + */ function set_default_mailboxes($arr) { if (is_array($arr)) { - $this->default_folders = array(); - - // add mailbox names lower case - foreach ($arr as $mbox) - $this->default_folders[] = strtolower($mbox); - + $this->default_folders = $arr; + $this->default_folders_lc = array(); + // add inbox if not included - if (!in_array('inbox', $this->default_folders)) - array_unshift($arr, 'inbox'); + if (!in_array_nocase('INBOX', $this->default_folders)) + array_unshift($this->default_folders, 'INBOX'); + + // create a second list with lower cased names + foreach ($this->default_folders as $mbox) + $this->default_folders_lc[] = strtolower($mbox); } } - function set_mailbox($mbox) + /** + * Set internal mailbox reference. + * + * All operations will be perfomed on this mailbox/folder + * + * @param string Mailbox/Folder name + * @access public + */ + function set_mailbox($new_mbox) { - $mailbox = $this->_mod_mailbox($mbox); + $mailbox = $this->_mod_mailbox($new_mbox); if ($this->mailbox == $mailbox) return; @@ -167,24 +243,62 @@ } + /** + * Set internal list page + * + * @param number Page number to list + * @access public + */ function set_page($page) { $this->list_page = (int)$page; } + /** + * Set internal page size + * + * @param number Number of messages to display on one page + * @access public + */ function set_pagesize($size) { $this->page_size = (int)$size; } + /** + * Returns the currently used mailbox name + * + * @return string Name of the mailbox/folder + * @access public + */ function get_mailbox_name() { return $this->conn ? $this->_mod_mailbox($this->mailbox, 'out') : ''; } + /** + * Returns the IMAP server's capability + * + * @param string Capability name + * @return mixed Capability value or TRUE if supported, FALSE if not + * @access public + */ + function get_capability($cap) + { + $cap = strtoupper($cap); + return $this->capabilities[$cap]; + } + + + /** + * Returns the delimiter that is used by the IMAP server for folder separation + * + * @return string Delimiter string + * @access public + */ function get_hierarchy_delimiter() { if ($this->conn && empty($this->delimiter)) @@ -196,19 +310,32 @@ return $this->delimiter; } - // public method for mailbox listing - // convert mailbox name with root dir first + + /** + * Public method for mailbox listing. + * + * Converts mailbox name with root dir first + * + * @param string Optional root folder + * @param string Optional filter for mailbox listing + * @return array List of mailboxes/folders + * @access public + */ function list_mailboxes($root='', $filter='*') { $a_out = array(); $a_mboxes = $this->_list_mailboxes($root, $filter); - foreach ($a_mboxes as $mbox) + foreach ($a_mboxes as $mbox_row) { - $name = $this->_mod_mailbox($mbox, 'out'); + $name = $this->_mod_mailbox($mbox_row, 'out'); if (strlen($name)) $a_out[] = $name; } + + // INBOX should always be available + if (!in_array_nocase('INBOX', $a_out)) + array_unshift($a_out, 'INBOX'); // sort mailboxes $a_out = $this->_sort_mailbox_list($a_out); @@ -216,7 +343,14 @@ return $a_out; } - // private method for mailbox listing + + /** + * Private method for mailbox listing + * + * @return array List of mailboxes/folders + * @access private + * @see rcube_imap::list_mailboxes + */ function _list_mailboxes($root='', $filter='*') { $a_defaults = $a_out = array(); @@ -232,15 +366,6 @@ if (!is_array($a_folders) || !sizeof($a_folders)) $a_folders = array(); - // create INBOX if it does not exist - if (!in_array_nocase('INBOX', $a_folders)) - { - $this->create_mailbox('INBOX', TRUE); - array_unshift($a_folders, 'INBOX'); - } - - $a_mailbox_cache = array(); - // write mailboxlist to cache $this->update_cache('mailboxes', $a_folders); @@ -248,39 +373,79 @@ } - // get message count for a specific mailbox; acceptes modes are: ALL, UNSEEN - function messagecount($mbox='', $mode='ALL', $force=FALSE) + /** + * Get message count for a specific mailbox + * + * @param string Mailbox/folder name + * @param string Mode for count [ALL|UNSEEN|RECENT] + * @param boolean Force reading from server and update cache + * @return number Number of messages + * @access public + */ + function messagecount($mbox_name='', $mode='ALL', $force=FALSE) { - $mailbox = $mbox ? $this->_mod_mailbox($mbox) : $this->mailbox; + $mailbox = $mbox_name ? $this->_mod_mailbox($mbox_name) : $this->mailbox; return $this->_messagecount($mailbox, $mode, $force); } - // private method for getting nr of mesages + + /** + * Private method for getting nr of messages + * + * @access private + * @see rcube_imap::messagecount + */ function _messagecount($mailbox='', $mode='ALL', $force=FALSE) { $a_mailbox_cache = FALSE; $mode = strtoupper($mode); - if (!$mailbox) + if (empty($mailbox)) $mailbox = $this->mailbox; $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]; + return $a_mailbox_cache[$mailbox][$mode]; - // get message count and store in cache - if ($mode == 'UNSEEN') - $count = iil_C_CountUnseen($this->conn, $mailbox); + // RECENT count is fetched abit different + if ($mode == 'RECENT') + $count = iil_C_CheckForRecent($this->conn, $mailbox); + + // use SEARCH for message counting + else if ($this->skip_deleted) + { + $search_str = "ALL UNDELETED"; + + // get message count and store in cache + if ($mode == 'UNSEEN') + $search_str .= " UNSEEN"; + + // get message count using SEARCH + // not very performant but more precise (using UNDELETED) + $count = 0; + $index = $this->_search_index($mailbox, $search_str); + if (is_array($index)) + { + $str = implode(",", $index); + if (!empty($str)) + $count = count($index); + } + } else - $count = iil_C_CountMessages($this->conn, $mailbox); + { + if ($mode == 'UNSEEN') + $count = iil_C_CountUnseen($this->conn, $mailbox); + else + $count = iil_C_CountMessages($this->conn, $mailbox); + } - if (is_array($a_mailbox_cache[$mailbox])) + if (!is_array($a_mailbox_cache[$mailbox])) $a_mailbox_cache[$mailbox] = array(); $a_mailbox_cache[$mailbox][$mode] = (int)$count; - + // write back to cache $this->update_cache('messagecount', $a_mailbox_cache); @@ -288,283 +453,711 @@ } - // public method for listing headers - // convert mailbox name with root dir first - function list_headers($mbox='', $page=NULL, $sort_field='date', $sort_order='DESC') + /** + * Public method for listing headers + * convert mailbox name with root dir first + * + * @param string Mailbox/folder name + * @param number Current page to list + * @param string Header field to sort by + * @param string Sort order [ASC|DESC] + * @return array Indexed array with message header objects + * @access public + */ + function list_headers($mbox_name='', $page=NULL, $sort_field=NULL, $sort_order=NULL) { - $mailbox = $mbox ? $this->_mod_mailbox($mbox) : $this->mailbox; + $mailbox = $mbox_name ? $this->_mod_mailbox($mbox_name) : $this->mailbox; return $this->_list_headers($mailbox, $page, $sort_field, $sort_order); } - // private method for listing message header - // by DrSlump <drslump@drslump.biz> - function __list_headers($mailbox='', $page=NULL, $sort_field='date', $sort_order='DESC') + /** + * Private method for listing message headers + * + * @access private + * @see rcube_imap::list_headers + */ + function _list_headers($mailbox='', $page=NULL, $sort_field=NULL, $sort_order=NULL, $recursive=FALSE) { - $a_out = array(); - $cached_count = 0; - - if (!strlen($mailbox)) - return $a_out; - - $mbox_count = $this->_messagecount($mailbox /*, 'ALL', TRUE*/); - - $revalidate = false; - if ($mbox_count) - { - // get cached headers - $a_out = $this->get_cache($mailbox.'.msg'); - $a_out = is_array($a_out) ? $a_out : array(); // make sure we get an array - - $cached_count = count($a_out); - $a_new = array(); - $revalidate = true; // revalidate by default - - // if the cache count is greater then there have been changes for sure - if ($cached_count <= $mbox_count) - { - $from = $cached_count?$cached_count:1; - - //get new headers (at least one is returned) - $a_temp = iil_C_FetchHeaders($this->conn, $mailbox, $from . ':' . $mbox_count); - $duplicated = $cached_count?true:false; - - foreach ($a_temp as $hdr) - { - //skip the first one if duplicated - if ($duplicated) - { - //check for changes using the UID - $lastCacheHdr = end($a_out); - if ($hdr->uid === $lastCacheHdr->uid) - $revalidate = false; - - $duplicated = false; - continue; - } - - //skip deleted ones - if (! $hdr->deleted) - $a_new[ $hdr->uid ] = $hdr; - } - } - - //revalidate cache if needed - $to = $mbox_count - count($a_new); - if ($revalidate && $to !== 0) //we'll need to reindex the array so we have to make a copy - { - $a_dirty = $a_out; - $a_out = array(); - $a_buffers = array(); - - //fetch chunks of 20 headers - $step = 20; - $found = false; - - //fetch headers in blocks starting from new to old - do { - $from = $to-$step; - if ($from < 1) $from = 1; - - //store the block in a temporal buffer - $a_buffers[$from] = iil_C_FetchHeaders($this->conn, $mailbox, $from . ':' . $to); - - //compare the fetched headers with the ones in the cache - $idx = 0; - foreach ($a_buffers[$from] as $k=>$hdr) - { - //if it's different the comparison ends - if (!isset($a_dirty[$hdr->uid]) || $a_dirty[$hdr->uid]->id !== $hdr->id) - break; - - //if we arrive here then we know that the older messages in cache are ok - $found = $hdr->id; - $idx++; - } - - //remove from the buffer the headers which are already cached - if ($found) - $a_buffers[$from] = array_splice($a_buffers[$from], 0, $idx ); - - $to = $from-1; - } - while ($found===false && $from > 1); - - //just keep the headers we are certain that didn't change in the cache - if ($found !== false) - { - foreach ($a_dirty as $hdr) - { - if ($hdr->id > $found) break; - $a_out[$hdr->uid] = $hdr; - } - } - - //we builded the block buffers from new to older, we process them in reverse order - ksort($a_buffers, SORT_NUMERIC); - foreach ($a_buffers as $a_buff) - { - foreach ($a_buff as $hdr) - { - if (! $hdr->deleted) - $a_out[$hdr->uid] = $hdr; - } - } - } - - //array_merge() would reindex the keys, so we use this 'hack' - $a_out += $a_new; - } - - //write headers list to cache if needed - if ($revalidate || count($a_out)!=$cached_count) { - $this->update_cache($mailbox.'.msg', $a_out); - } - - //sort headers by a specific col - $a_out = iil_SortHeaders( $a_out, $sort_field, $sort_order ); - - // return complete list of messages - if (strtolower($page)=='all') - return $a_out; - - $start_msg = ($this->list_page-1) * $this->page_size; - return array_slice($a_out, $start_msg, $this->page_size); - } - - - // original function; replaced 2005/10/18 - // private method for listing message header - function _list_headers($mailbox='', $page=NULL, $sort_field='date', $sort_order='DESC') - { - $max = $this->_messagecount($mailbox); - if (!strlen($mailbox)) return array(); + + if ($sort_field!=NULL) + $this->sort_field = $sort_field; + if ($sort_order!=NULL) + $this->sort_order = strtoupper($sort_order); - // get cached headers - $a_msg_headers = $this->get_cache($mailbox.'.msg'); + $max = $this->_messagecount($mailbox); + $start_msg = ($this->list_page-1) * $this->page_size; - // retrieve headers from IMAP - if (!is_array($a_msg_headers) || sizeof($a_msg_headers) != $max) + list($begin, $end) = $this->_get_message_range($max, $page); + + // mailbox is empty + if ($begin >= $end) + return array(); + + $headers_sorted = FALSE; + $cache_key = $mailbox.'.msg'; + $cache_status = $this->check_cache_status($mailbox, $cache_key); + + // cache is OK, we can get all messages from local cache + if ($cache_status>0) { - $a_header_index = iil_C_FetchHeaders($this->conn, $mailbox, "1:$max"); - $a_msg_headers = array(); - - if (!empty($a_header_index)) - foreach ($a_header_index as $i => $headers) - if (!$headers->deleted) - $a_msg_headers[$headers->uid] = $headers; + $a_msg_headers = $this->get_message_cache($cache_key, $start_msg, $start_msg+$this->page_size, $this->sort_field, $this->sort_order); + $headers_sorted = TRUE; + } + // cache is dirty, sync it + else if ($this->caching_enabled && $cache_status==-1 && !$recursive) + { + $this->sync_header_index($mailbox); + return $this->_list_headers($mailbox, $page, $this->sort_field, $this->sort_order, TRUE); } else - $headers_cached = TRUE; - - if (!is_array($a_msg_headers)) - return array(); - - // sort headers by a specific col - $a_headers = iil_SortHeaders($a_msg_headers, $sort_field, $sort_order); - $headers_count = count($a_headers); - - // free memory - unset($a_msg_headers); - - // write headers list to cache - if (!$headers_cached) - $this->update_cache($mailbox.'.msg', $a_headers); - - // update message count cache - $a_mailbox_cache = $this->get_cache('messagecount'); - if (isset($a_mailbox_cache[$mailbox]['ALL']) && $a_mailbox_cache[$mailbox]['ALL'] != $headers_count) { - $a_mailbox_cache[$mailbox]['ALL'] = (int)$headers_count; - $this->update_cache('messagecount', $a_mailbox_cache); + // retrieve headers from IMAP + if ($this->get_capability('sort') && ($msg_index = iil_C_Sort($this->conn, $mailbox, $this->sort_field, $this->skip_deleted ? 'UNDELETED' : ''))) + { + $msgs = $msg_index[$begin]; + for ($i=$begin+1; $i < $end; $i++) + $msgs = $msgs.','.$msg_index[$i]; + } + else + { + $msgs = sprintf("%d:%d", $begin+1, $end); + + $i = 0; + for ($msg_seqnum = $begin; $msg_seqnum <= $end; $msg_seqnum++) + $msg_index[$i++] = $msg_seqnum; + } + + // use this class for message sorting + $sorter = new rcube_header_sorter(); + $sorter->set_sequence_numbers($msg_index); + + // fetch reuested headers from server + $a_msg_headers = array(); + $deleted_count = $this->_fetch_headers($mailbox, $msgs, $a_msg_headers, $cache_key); + + // delete cached messages with a higher index than $max + $this->clear_message_cache($cache_key, $max); + + + // kick child process to sync cache + // ... + } - if (empty($a_headers)) + + // return empty array if no messages found + if (!is_array($a_msg_headers) || empty($a_msg_headers)) return array(); - - // return complete list of messages - if (strtolower($page)=='all') - return $a_headers; - $start_msg = ($this->list_page-1) * $this->page_size; - return array_slice($a_headers, $start_msg, $this->page_size); - } - - // return sorted array of message UIDs - function message_index($mbox='', $sort_field='date', $sort_order='DESC') - { - $mailbox = $mbox ? $this->_mod_mailbox($mbox) : $this->mailbox; - $a_out = array(); + // if not already sorted + if (!$headers_sorted) + { + $sorter->sort_headers($a_msg_headers); - // get array of message headers - $a_headers = $this->_list_headers($mailbox, 'all', $sort_field, $sort_order); + if ($this->sort_order == 'DESC') + $a_msg_headers = array_reverse($a_msg_headers); + } - if (is_array($a_headers)) - foreach ($a_headers as $header) - $a_out[] = $header->uid; - - return $a_out; + return array_values($a_msg_headers); } - function sync_header_index($mbox=NULL) + + /** + * Public method for listing a specific set of headers + * convert mailbox name with root dir first + * + * @param string Mailbox/folder name + * @param array List of message ids to list + * @param number Current page to list + * @param string Header field to sort by + * @param string Sort order [ASC|DESC] + * @return array Indexed array with message header objects + * @access public + */ + function list_header_set($mbox_name='', $msgs, $page=NULL, $sort_field=NULL, $sort_order=NULL) { + $mailbox = $mbox_name ? $this->_mod_mailbox($mbox_name) : $this->mailbox; + return $this->_list_header_set($mailbox, $msgs, $page, $sort_field, $sort_order); + } + + /** + * Private method for listing a set of message headers + * + * @access private + * @see rcube_imap::list_header_set + */ + function _list_header_set($mailbox, $msgs, $page=NULL, $sort_field=NULL, $sort_order=NULL) + { + // also accept a comma-separated list of message ids + if (is_string($msgs)) + $msgs = split(',', $msgs); + + if (!strlen($mailbox) || empty($msgs)) + return array(); + + if ($sort_field!=NULL) + $this->sort_field = $sort_field; + if ($sort_order!=NULL) + $this->sort_order = strtoupper($sort_order); + + $max = count($msgs); + $start_msg = ($this->list_page-1) * $this->page_size; + + // fetch reuested headers from server + $a_msg_headers = array(); + $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 = iil_SortHeaders($a_msg_headers, $this->sort_field, $this->sort_order); + + // only return the requested part of the set + return array_slice(array_values($a_msg_headers), $start_msg, min($max-$start_msg, $this->page_size)); } - function search($mbox='', $criteria='ALL') + /** + * Helper function to get first and last index of the requested set + * + * @param number message count + * @param mixed page number to show, or string 'all' + * @return array array with two values: first index, last index + * @access private + */ + function _get_message_range($max, $page) { - $mailbox = $mbox ? $this->_mod_mailbox($mbox) : $this->mailbox; + $start_msg = ($this->list_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 name + * @param string Message index to fetch + * @param array Reference to message headers array + * @param array Array with cache index + * @return number Number of deleted messages + * @access private + */ + function _fetch_headers($mailbox, $msgs, &$a_msg_headers, $cache_key) + { + // cache is incomplete + $cache_index = $this->get_message_cache_index($cache_key); + + // fetch reuested headers from server + $a_header_index = iil_C_FetchHeaders($this->conn, $mailbox, $msgs); + $deleted_count = 0; + + if (!empty($a_header_index)) + { + foreach ($a_header_index as $i => $headers) + { + if ($headers->deleted && $this->skip_deleted) + { + // delete from cache + if ($cache_index[$headers->id] && $cache_index[$headers->id] == $headers->uid) + $this->remove_message_cache($cache_key, $headers->id); + + $deleted_count++; + continue; + } + + // add message to cache + if ($this->caching_enabled && $cache_index[$headers->id] != $headers->uid) + $this->add_message_cache($cache_key, $headers->id, $headers); + + $a_msg_headers[$headers->uid] = $headers; + } + } + + return $deleted_count; + } + + + /** + * Return sorted array of message UIDs + * + * @param string Mailbox to get index from + * @param string Sort column + * @param string Sort order [ASC, DESC] + * @return array Indexed array with message ids + */ + function message_index($mbox_name='', $sort_field=NULL, $sort_order=NULL) + { + if ($sort_field!=NULL) + $this->sort_field = $sort_field; + if ($sort_order!=NULL) + $this->sort_order = strtoupper($sort_order); + + $mailbox = $mbox_name ? $this->_mod_mailbox($mbox_name) : $this->mailbox; + $key = "$mbox:".$this->sort_field.":".$this->sort_order.".msgi"; + + // have stored it in RAM + if (isset($this->cache[$key])) + return $this->cache[$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, TRUE, $this->sort_field, $this->sort_order); + return array_values($a_index); + } + + + // fetch complete message index + $msg_count = $this->_messagecount($mailbox); + if ($this->get_capability('sort') && ($a_index = iil_C_Sort($this->conn, $mailbox, $this->sort_field, '', TRUE))) + { + if ($this->sort_order == 'DESC') + $a_index = array_reverse($a_index); + + $this->cache[$key] = $a_index; + + } + else + { + $a_index = iil_C_FetchHeaderIndex($this->conn, $mailbox, "1:$msg_count", $this->sort_field); + $a_uids = iil_C_FetchUIDs($this->conn, $mailbox); + + if ($this->sort_order=="ASC") + asort($a_index); + else if ($this->sort_order=="DESC") + arsort($a_index); + + $i = 0; + $this->cache[$key] = array(); + foreach ($a_index as $index => $value) + $this->cache[$key][$i++] = $a_uids[$index]; + } + + return $this->cache[$key]; + } + + + function sync_header_index($mailbox) + { + $cache_key = $mailbox.'.msg'; + $cache_index = $this->get_message_cache_index($cache_key); + $msg_count = $this->_messagecount($mailbox); + + // fetch complete message index + $a_message_index = iil_C_FetchHeaderIndex($this->conn, $mailbox, "1:$msg_count", 'UID'); + + foreach ($a_message_index as $id => $uid) + { + // message in cache at correct position + if ($cache_index[$id] == $uid) + { + unset($cache_index[$id]); + continue; + } + + // message in cache but in wrong position + if (in_array((string)$uid, $cache_index, TRUE)) + { + unset($cache_index[$id]); + } + + // other message at this position + if (isset($cache_index[$id])) + { + $this->remove_message_cache($cache_key, $id); + unset($cache_index[$id]); + } + + + // fetch complete headers and add to cache + $headers = iil_C_FetchHeader($this->conn, $mailbox, $id); + $this->add_message_cache($cache_key, $headers->id, $headers); + } + + // those ids that are still in cache_index have been deleted + if (!empty($cache_index)) + { + foreach ($cache_index as $id => $uid) + $this->remove_message_cache($cache_key, $id); + } + } + + + /** + * Invoke search request to IMAP server + * + * @param string mailbox name to search in + * @param string search criteria (ALL, TO, FROM, SUBJECT, etc) + * @param string search string + * @return array search results as list of message ids + * @access public + */ + function search($mbox_name='', $criteria='ALL', $str=NULL, $charset=NULL) + { + $mailbox = $mbox_name ? $this->_mod_mailbox($mbox_name) : $this->mailbox; + if ($str && $criteria) + { + $search = (!empty($charset) ? "CHARSET $charset " : '') . sprintf("%s {%d}\r\n%s", $criteria, strlen($str), $str); + $results = $this->_search_index($mailbox, $search); + + // try search with ISO charset (should be supported by server) + if (empty($results) && !empty($charset) && $charset!='ISO-8859-1') + $results = $this->search($mbox_name, $criteria, rcube_charset_convert($str, $charset, 'ISO-8859-1'), 'ISO-8859-1'); + + return $results; + } + else + return $this->_search_index($mailbox, $criteria); + } + + + /** + * Private search method + * + * @return array search results as list of message ids + * @access private + * @see rcube_imap::search() + */ + function _search_index($mailbox, $criteria='ALL') + { $a_messages = iil_C_Search($this->conn, $mailbox, $criteria); + // clean message list (there might be some empty entries) + if (is_array($a_messages)) + { + foreach ($a_messages as $i => $val) + if (empty($val)) + unset($a_messages[$i]); + } + return $a_messages; } - function get_headers($uid, $mbox=NULL) + /** + * Return message headers object of a specific message + * + * @param int Message ID + * @param string Mailbox to read from + * @param boolean True if $id is the message UID + * @return object Message headers representation + */ + function get_headers($id, $mbox_name=NULL, $is_uid=TRUE) { - $mailbox = $mbox ? $this->_mod_mailbox($mbox) : $this->mailbox; - - // get cached headers - $a_msg_headers = $this->get_cache($mailbox.'.msg'); - - // return cached header - if ($a_msg_headers[$uid]) - return $a_msg_headers[$uid]; + $mailbox = $mbox_name ? $this->_mod_mailbox($mbox_name) : $this->mailbox; + $uid = $is_uid ? $id : $this->_id2uid($id); - $msg_id = $this->_uid2id($uid); - $header = iil_C_FetchHeader($this->conn, $mailbox, $msg_id); + // get cached headers + if ($uid && ($headers = &$this->get_cached_message($mailbox.'.msg', $uid))) + return $headers; + + $headers = iil_C_FetchHeader($this->conn, $mailbox, $id, $is_uid); // write headers cache - $a_msg_headers[$uid] = $header; - $this->update_cache($mailbox.'.msg', $a_msg_headers); + if ($headers) + { + if ($is_uid) + $this->uid_id_map[$mbox_name][$uid] = $headers->id; - return $header; + $this->add_message_cache($mailbox.'.msg', $headers->id, $headers); + } + + return $headers; } - function get_body($uid, $part=1) + /** + * Fetch body structure from the IMAP server and build + * an object structure similar to the one generated by PEAR::Mail_mimeDecode + * + * @param Int Message UID to fetch + * @return object Standard object tree or False on failure + */ + function &get_structure($uid) { + $cache_key = $this->mailbox.'.msg'; + $headers = &$this->get_cached_message($cache_key, $uid, true); + + // return cached message structure + if (is_object($headers) && is_object($headers->structure)) + return $headers->structure; + + // resolve message sequence number if (!($msg_id = $this->_uid2id($uid))) return FALSE; $structure_str = iil_C_FetchStructureString($this->conn, $this->mailbox, $msg_id); $structure = iml_GetRawStructureArray($structure_str); - $body = iil_C_FetchPartBody($this->conn, $this->mailbox, $msg_id, $part); + $struct = false; + + // parse structure and add headers + if (!empty($structure)) + { + $this->_msg_id = $msg_id; + $headers = $this->get_headers($msg_id, NULL, FALSE); + + $struct = &$this->_structure_part($structure); + $struct->headers = get_object_vars($headers); - $encoding = iml_GetPartEncodingCode($structure, $part); + // 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->caching_enabled) + $this->add_message_cache($cache_key, $msg_id, $headers, $struct); + } + + return $struct; + } + + + /** + * Build message part object + * + * @access private + */ + function &_structure_part($part, $count=0, $parent='') + { + $struct = new rcube_message_part; + $struct->mime_id = empty($parent) ? (string)$count : "$parent.$count"; - if ($encoding==3) $body = $this->mime_decode($body, 'base64'); - else if ($encoding==4) $body = $this->mime_decode($body, 'quoted-printable'); + // multipart + if (is_array($part[0])) + { + $struct->ctype_primary = 'multipart'; + + // find first non-array entry + for ($i=1; count($part); $i++) + if (!is_array($part[$i])) + { + $struct->ctype_secondary = strtolower($part[$i]); + break; + } + + $struct->mimetype = 'multipart/'.$struct->ctype_secondary; + + $struct->parts = array(); + for ($i=0, $count=0; $i<count($part); $i++) + if (is_array($part[$i]) && count($part[$i]) > 5) + $struct->parts[] = $this->_structure_part($part[$i], ++$count, $struct->mime_id); + + return $struct; + } + + + // 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']; + } + + // read content encoding + if (!empty($part[5]) && $part[5]!='NIL') + { + $struct->encoding = strtolower($part[5]); + $struct->headers['content-transfer-encoding'] = $struct->encoding; + } + + // get part size + if (!empty($part[6]) && $part[6]!='NIL') + $struct->size = intval($part[6]); + + // read part disposition + $di = count($part) - 3; + if (is_array($part[$di])) + { + $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 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]) && count($part[8][$i]) > 5) + $struct->parts[] = $this->_structure_part($part[8][$i], ++$count, $struct->mime_id); + } + + // get part ID + if (!empty($part[3]) && $part[3]!='NIL') + { + $struct->content_id = $part[3]; + $struct->headers['content-id'] = $part[3]; + + if (empty($struct->disposition)) + $struct->disposition = 'inline'; + } + + // fetch message headers if message/rfc822 + if ($struct->ctype_primary=='message') + { + $headers = iil_C_FetchPartBody($this->conn, $this->mailbox, $this->_msg_id, $struct->mime_id.'.HEADER'); + $struct->headers = $this->_parse_headers($headers); + } + + return $struct; + } + + + /** + * Return a flat array with references to all parts, indexed by part numbmers + * + * @param object Message body structure + * @return Array with part number -> object pairs + */ + function get_mime_numbers(&$structure) + { + $a_parts = array(); + $this->_get_part_numbers($structure, $a_parts); + return $a_parts; + } + + + /** + * Helper method for recursive calls + * + * @access + */ + function _get_part_numbers(&$part, &$a_parts) + { + if ($part->mime_id) + $a_parts[$part->mime_id] = &$part; + + if (is_array($part->parts)) + for ($i=0; $i<count($part->parts); $i++) + $this->_get_part_numbers($part->parts[$i], $a_parts); + } + + + /** + * Fetch message body of a specific message from the server + * + * @param int Message UID + * @param string Part number + * @param object Part object created by get_structure() + * @param mixed True to print part, ressource to write part contents in + * @return Message/part body if not printed + */ + function &get_message_part($uid, $part=1, $o_part=NULL, $print=NULL) + { + if (!($msg_id = $this->_uid2id($uid))) + return FALSE; + + // get part encoding if not provided + if (!is_object($o_part)) + { + $structure_str = iil_C_FetchStructureString($this->conn, $this->mailbox, $msg_id); + $structure = iml_GetRawStructureArray($structure_str); + $part_type = iml_GetPartTypeCode($structure, $part); + $o_part = new rcube_message_part; + $o_part->ctype_primary = $part_type==0 ? 'text' : ($part_type==2 ? 'message' : 'other'); + $o_part->encoding = strtolower(iml_GetPartEncodingString($structure, $part)); + $o_part->charset = iml_GetPartCharset($structure, $part); + } + + // TODO: Add caching for message parts + + if ($print) + { + iil_C_HandlePartBody($this->conn, $this->mailbox, $msg_id, $part, ($o_part->encoding=='base64'?3:2)); + $body = TRUE; + } + else + { + $body = iil_C_HandlePartBody($this->conn, $this->mailbox, $msg_id, $part, 1); + + // decode part body + if ($o_part->encoding=='base64' || $o_part->encoding=='quoted-printable') + $body = $this->mime_decode($body, $o_part->encoding); + + // convert charset (if text or message part) + if ($o_part->ctype_primary=='text' || $o_part->ctype_primary=='message') + { + // assume ISO-8859-1 if no charset specified + if (empty($o_part->charset)) + $o_part->charset = 'ISO-8859-1'; + + $body = rcube_charset_convert($body, $o_part->charset); + } + } return $body; } - function get_raw_body($uid) + /** + * Fetch message body of a specific message from the server + * + * @param int Message UID + * @return Message/part body + * @see ::get_message_part() + */ + function &get_body($uid, $part=1) + { + return $this->get_message_part($uid, $part); + } + + + /** + * Returns the whole message source as string + * + * @param int Message UID + * @return Message source string + */ + function &get_raw_body($uid) { if (!($msg_id = $this->_uid2id($uid))) return FALSE; @@ -574,44 +1167,69 @@ return $body; } + + + /** + * Sends the whole message source to stdout + * + * @param int Message UID + */ + function print_raw_body($uid) + { + if (!($msg_id = $this->_uid2id($uid))) + return FALSE; + + print iil_C_FetchPartHeader($this->conn, $this->mailbox, $msg_id, NULL); + flush(); + iil_C_HandlePartBody($this->conn, $this->mailbox, $msg_id, NULL, 2); + } - // set message flag to one or several messages - // possible flgs are: SEEN, DELETED, RECENT, ANSWERED, DRAFT + /** + * Set message flag to one or several messages + * + * @param mixed Message UIDs as array or as comma-separated string + * @param string Flag to set: SEEN, UNDELETED, DELETED, RECENT, ANSWERED, DRAFT + * @return True on success, False on failure + */ function set_flag($uids, $flag) { $flag = strtoupper($flag); $msg_ids = array(); if (!is_array($uids)) - $uids = array($uids); + $uids = explode(',',$uids); - foreach ($uids as $uid) - $msg_ids[] = $this->_uid2id($uid); + foreach ($uids as $uid) { + $msg_ids[$uid] = $this->_uid2id($uid); + } - if ($flag=='UNSEEN') - $result = iil_C_Unseen($this->conn, $this->mailbox, join(',', $msg_ids)); + if ($flag=='UNDELETED') + $result = iil_C_Undelete($this->conn, $this->mailbox, join(',', array_values($msg_ids))); + else if ($flag=='UNSEEN') + $result = iil_C_Unseen($this->conn, $this->mailbox, join(',', array_values($msg_ids))); else - $result = iil_C_Flag($this->conn, $this->mailbox, join(',', $msg_ids), $flag); + $result = iil_C_Flag($this->conn, $this->mailbox, join(',', array_values($msg_ids)), $flag); // reload message headers if cached $cache_key = $this->mailbox.'.msg'; - if ($this->caching_enabled && $result && ($a_cached_headers = $this->get_cache($cache_key))) + if ($this->caching_enabled) { - // close and re-open connection - $this->reconnect(); - - foreach ($uids as $uid) + foreach ($msg_ids as $uid => $id) { - if (isset($a_cached_headers[$uid])) + if ($cached_headers = $this->get_cached_message($cache_key, $uid)) { - unset($this->cache[$cache_key][$uid]); - $this->get_headers($uid); + $this->remove_message_cache($cache_key, $id); + //$this->get_headers($uid); } } + + // close and re-open connection + // this prevents connection problems with Courier + $this->reconnect(); } // set nr of messages that were flaged - $count = sizeof($msg_ids); + $count = count($msg_ids); // clear message count cache if ($result && $flag=='SEEN') @@ -626,14 +1244,15 @@ // append a mail message (source) to a specific mailbox - function save_message($mbox, $message) + function save_message($mbox_name, &$message) { - $mailbox = $this->_mod_mailbox($mbox); + $mbox_name = stripslashes($mbox_name); + $mailbox = $this->_mod_mailbox($mbox_name); - // make shure mailbox exists + // make sure mailbox exists if (in_array($mailbox, $this->_list_mailboxes())) $saved = iil_C_Append($this->conn, $mailbox, $message); - + if ($saved) { // increase messagecount of the target mailbox @@ -647,13 +1266,20 @@ // move a message from one mailbox to another function move_message($uids, $to_mbox, $from_mbox='') { + $to_mbox = stripslashes($to_mbox); + $from_mbox = stripslashes($from_mbox); $to_mbox = $this->_mod_mailbox($to_mbox); $from_mbox = $from_mbox ? $this->_mod_mailbox($from_mbox) : $this->mailbox; - // make shure mailbox exists + // make sure mailbox exists if (!in_array($to_mbox, $this->_list_mailboxes())) - return FALSE; - + { + if (in_array(strtolower($to_mbox), $this->default_folders)) + $this->create_mailbox($to_mbox, TRUE); + else + return FALSE; + } + // convert the list of uids to array $a_uids = is_string($uids) ? explode(',', $uids) : (is_array($uids) ? $uids : NULL); @@ -672,20 +1298,24 @@ // really deleted from the source mailbox if ($moved) { - $this->expunge($from_mbox, FALSE); - $this->clear_cache($to_mbox.'.msg'); + $this->_expunge($from_mbox, FALSE); $this->_clear_messagecount($from_mbox); $this->_clear_messagecount($to_mbox); } // update cached message headers $cache_key = $from_mbox.'.msg'; - if ($moved && ($a_cached_headers = $this->get_cache($cache_key))) + if ($moved && ($a_cache_index = $this->get_message_cache_index($cache_key))) { + $start_index = 100000; foreach ($a_uids as $uid) - unset($a_cached_headers[$uid]); + { + if(($index = array_search($uid, $a_cache_index)) !== FALSE) + $start_index = min($index, $start_index); + } - $this->update_cache($cache_key, $a_cached_headers); + // clear cache from the lowest index on + $this->clear_message_cache($cache_key, $start_index); } return $moved; @@ -693,9 +1323,10 @@ // mark messages as deleted and expunge mailbox - function delete_message($uids, $mbox='') + function delete_message($uids, $mbox_name='') { - $mailbox = $mbox ? $this->_mod_mailbox($mbox) : $this->mailbox; + $mbox_name = stripslashes($mbox_name); + $mailbox = $mbox_name ? $this->_mod_mailbox($mbox_name) : $this->mailbox; // convert the list of uids to array $a_uids = is_string($uids) ? explode(',', $uids) : (is_array($uids) ? $uids : NULL); @@ -716,17 +1347,23 @@ // really deleted from the mailbox if ($deleted) { - $this->expunge($mailbox, FALSE); + $this->_expunge($mailbox, FALSE); $this->_clear_messagecount($mailbox); } // remove deleted messages from cache - if ($deleted && ($a_cached_headers = $this->get_cache($mailbox.'.msg'))) + $cache_key = $mailbox.'.msg'; + if ($deleted && ($a_cache_index = $this->get_message_cache_index($cache_key))) { + $start_index = 100000; foreach ($a_uids as $uid) - unset($a_cached_headers[$uid]); + { + $index = array_search($uid, $a_cache_index); + $start_index = min($index, $start_index); + } - $this->update_cache($mailbox.'.msg', $a_cached_headers); + // clear cache from the lowest index on + $this->clear_message_cache($cache_key, $start_index); } return $deleted; @@ -734,28 +1371,49 @@ // clear all messages in a specific mailbox - function clear_mailbox($mbox) + function clear_mailbox($mbox_name=NULL) { - $mailbox = $mbox ? $this->_mod_mailbox($mbox) : $this->mailbox; + $mbox_name = stripslashes($mbox_name); + $mailbox = !empty($mbox_name) ? $this->_mod_mailbox($mbox_name) : $this->mailbox; $msg_count = $this->_messagecount($mailbox, 'ALL'); if ($msg_count>0) - return iil_C_ClearFolder($this->conn, $mailbox); + { + $cleared = iil_C_ClearFolder($this->conn, $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; + } else return 0; } // send IMAP expunge command and clear cache - function expunge($mbox='', $clear_cache=TRUE) + function expunge($mbox_name='', $clear_cache=TRUE) { - $mailbox = $mbox ? $this->_mod_mailbox($mbox) : $this->mailbox; - + $mbox_name = stripslashes($mbox_name); + $mailbox = $mbox_name ? $this->_mod_mailbox($mbox_name) : $this->mailbox; + return $this->_expunge($mailbox, $clear_cache); + } + + + // send IMAP expunge command and clear cache + function _expunge($mailbox, $clear_cache=TRUE) + { $result = iil_C_Expunge($this->conn, $mailbox); if ($result>=0 && $clear_cache) { - $this->clear_cache($mailbox.'.msg'); + //$this->clear_message_cache($mailbox.'.msg'); $this->_clear_messagecount($mailbox); } @@ -763,13 +1421,17 @@ } - /* -------------------------------- * folder managment * --------------------------------*/ - // return an array with all folders available in IMAP server + /** + * Get a list of all folders available on the IMAP server + * + * @param string IMAP root dir + * @return array Inbdexed array with folder names + */ function list_unsubscribed($root='') { static $sa_unsubscribed; @@ -781,9 +1443,9 @@ $a_mboxes = iil_C_ListMailboxes($this->conn, $this->_mod_mailbox($root), '*'); // modify names with root dir - foreach ($a_mboxes as $mbox) + foreach ($a_mboxes as $mbox_name) { - $name = $this->_mod_mailbox($mbox, 'out'); + $name = $this->_mod_mailbox($mbox_name, 'out'); if (strlen($name)) $a_folders[] = $name; } @@ -794,79 +1456,151 @@ } - // subscribe to a specific mailbox(es) - function subscribe($mbox, $mode='subscribe') + /** + * Get quota + * added by Nuny + */ + function get_quota() { - if (is_array($mbox)) - $a_mboxes = $mbox; - else if (is_string($mbox) && strlen($mbox)) - $a_mboxes = explode(',', $mbox); + if ($this->get_capability('QUOTA')) + { + $result = iil_C_GetQuota($this->conn); + if ($result["total"]) + return sprintf("%.2fMB / %.2fMB (%.0f%%)", $result["used"] / 1000.0, $result["total"] / 1000.0, $result["percent"]); + } + + return FALSE; + } + + + /** + * subscribe to a specific mailbox(es) + */ + function subscribe($mbox_name, $mode='subscribe') + { + if (is_array($mbox_name)) + $a_mboxes = $mbox_name; + else if (is_string($mbox_name) && strlen($mbox_name)) + $a_mboxes = explode(',', $mbox_name); // let this common function do the main work return $this->_change_subscription($a_mboxes, 'subscribe'); } - // unsubscribe mailboxes - function unsubscribe($mbox) + /** + * unsubscribe mailboxes + */ + function unsubscribe($mbox_name) { - if (is_array($mbox)) - $a_mboxes = $mbox; - else if (is_string($mbox) && strlen($mbox)) - $a_mboxes = explode(',', $mbox); + if (is_array($mbox_name)) + $a_mboxes = $mbox_name; + else if (is_string($mbox_name) && strlen($mbox_name)) + $a_mboxes = explode(',', $mbox_name); // 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 + /** + * Create a new mailbox on the server and register it in local cache + * + * @param string New mailbox name (as utf-7 string) + * @param boolean True if the new mailbox should be subscribed + * @param string Name of the created mailbox, false on error + */ function create_mailbox($name, $subscribe=FALSE) { $result = FALSE; - $name_enc = UTF7EncodeString($name); - $abs_name = $this->_mod_mailbox($name_enc); - $a_mailbox_cache = $this->get_cache('mailboxes'); - //if (strlen($this->root_ns)) - // $abs_name = $this->root_ns.$abs_name; + // replace backslashes + $name = preg_replace('/[\\\]+/', '-', $name); - if (strlen($abs_name) && (!is_array($a_mailbox_cache) || !in_array($abs_name, $a_mailbox_cache))) + // reduce mailbox name to 100 chars + $name = substr($name, 0, 100); + + $abs_name = $this->_mod_mailbox($name); + $a_mailbox_cache = $this->get_cache('mailboxes'); + + if (strlen($abs_name) && (!is_array($a_mailbox_cache) || !in_array_nocase($abs_name, $a_mailbox_cache))) $result = iil_C_CreateFolder($this->conn, $abs_name); - // update mailboxlist cache - if ($result && $subscribe) - $this->subscribe($name_enc); + // try to subscribe it + if ($subscribe) + $this->subscribe($name); return $result ? $name : FALSE; } - // set a new name to an existing mailbox - function rename_mailbox($mbox, $new_name) + /** + * Set a new name to an existing mailbox + * + * @param string Mailbox to rename (as utf-7 string) + * @param string New mailbox name (as utf-7 string) + * @param string Name of the renames mailbox, false on error + */ + function rename_mailbox($mbox_name, $new_name) { - // not implemented yet + $result = FALSE; + + // replace backslashes + $name = preg_replace('/[\\\]+/', '-', $new_name); + + // encode mailbox name and reduce it to 100 chars + $name = substr($new_name, 0, 100); + + // make absolute path + $mailbox = $this->_mod_mailbox($mbox_name); + $abs_name = $this->_mod_mailbox($name); + + // check if mailbox is subscribed + $a_subscribed = $this->_list_mailboxes(); + $subscribed = in_array($mailbox, $a_subscribed); + + // unsubscribe folder + if ($subscribed) + iil_C_UnSubscribe($this->conn, $mailbox); + + if (strlen($abs_name)) + $result = iil_C_RenameFolder($this->conn, $mailbox, $abs_name); + + // clear cache + if ($result) + { + $this->clear_message_cache($mailbox.'.msg'); + $this->clear_cache('mailboxes'); + } + + // try to subscribe it + if ($result && $subscribed) + iil_C_Subscribe($this->conn, $abs_name); + + return $result ? $name : FALSE; } - // remove mailboxes from server - function delete_mailbox($mbox) + /** + * remove mailboxes from server + */ + function delete_mailbox($mbox_name) { $deleted = FALSE; - if (is_array($mbox)) - $a_mboxes = $mbox; - else if (is_string($mbox) && strlen($mbox)) - $a_mboxes = explode(',', $mbox); + if (is_array($mbox_name)) + $a_mboxes = $mbox_name; + else if (is_string($mbox_name) && strlen($mbox_name)) + $a_mboxes = explode(',', $mbox_name); if (is_array($a_mboxes)) - foreach ($a_mboxes as $mbox) + foreach ($a_mboxes as $mbox_name) { - $mailbox = $this->_mod_mailbox($mbox); + $mailbox = $this->_mod_mailbox($mbox_name); // unsubscribe mailbox before deleting iil_C_UnSubscribe($this->conn, $mailbox); - + // send delete command to server $result = iil_C_DeleteFolder($this->conn, $mailbox); if ($result>=0) @@ -875,37 +1609,63 @@ // clear mailboxlist cache if ($deleted) + { + $this->clear_message_cache($mailbox.'.msg'); $this->clear_cache('mailboxes'); + } - return $updated; + return $deleted; + } + + + /** + * Create all folders specified as default + */ + function create_default_folders() + { + $a_folders = iil_C_ListMailboxes($this->conn, $this->_mod_mailbox(''), '*'); + $a_subscribed = iil_C_ListSubscribed($this->conn, $this->_mod_mailbox(''), '*'); + + // create default folders if they do not exist + foreach ($this->default_folders as $folder) + { + $abs_name = $this->_mod_mailbox($folder); + if (!in_array_nocase($abs_name, $a_subscribed)) + { + if (!in_array_nocase($abs_name, $a_folders)) + $this->create_mailbox($folder, TRUE); + else + $this->subscribe($folder); + } + } } - /* -------------------------------- - * internal caching functions + * internal caching methods * --------------------------------*/ function set_caching($set) { - if ($set && function_exists('rcube_read_cache')) + if ($set && is_object($this->db)) $this->caching_enabled = TRUE; else $this->caching_enabled = FALSE; } + function get_cache($key) { // read cache if (!isset($this->cache[$key]) && $this->caching_enabled) { - $cache_data = rcube_read_cache('IMAP.'.$key); + $cache_data = $this->_read_cache_record('IMAP.'.$key); $this->cache[$key] = strlen($cache_data) ? unserialize($cache_data) : FALSE; } - return $this->cache[$key]; + return $this->cache[$key]; } @@ -924,7 +1684,7 @@ foreach ($this->cache as $key => $data) { if ($this->cache_changes[$key]) - rcube_write_cache('IMAP.'.$key, serialize($data)); + $this->_write_cache_record('IMAP.'.$key, serialize($data)); } } } @@ -935,7 +1695,7 @@ if ($key===NULL) { foreach ($this->cache as $key => $data) - rcube_clear_cache('IMAP.'.$key); + $this->_clear_cache_record('IMAP.'.$key); $this->cache = array(); $this->cache_changed = FALSE; @@ -943,7 +1703,7 @@ } else { - rcube_clear_cache('IMAP.'.$key); + $this->_clear_cache_record('IMAP.'.$key); $this->cache_changes[$key] = FALSE; unset($this->cache[$key]); } @@ -951,8 +1711,309 @@ + function _read_cache_record($key) + { + $cache_data = FALSE; + + if ($this->db) + { + // get cached data from DB + $sql_result = $this->db->query( + "SELECT cache_id, data + FROM ".get_table_name('cache')." + WHERE user_id=? + AND cache_key=?", + $_SESSION['user_id'], + $key); + + if ($sql_arr = $this->db->fetch_assoc($sql_result)) + { + $cache_data = $sql_arr['data']; + $this->cache_keys[$key] = $sql_arr['cache_id']; + } + } + + return $cache_data; + } + + + function _write_cache_record($key, $data) + { + if (!$this->db) + return FALSE; + + // check if we already have a cache entry for this key + if (!isset($this->cache_keys[$key])) + { + $sql_result = $this->db->query( + "SELECT cache_id + FROM ".get_table_name('cache')." + WHERE user_id=? + AND cache_key=?", + $_SESSION['user_id'], + $key); + + if ($sql_arr = $this->db->fetch_assoc($sql_result)) + $this->cache_keys[$key] = $sql_arr['cache_id']; + else + $this->cache_keys[$key] = FALSE; + } + + // update existing cache record + if ($this->cache_keys[$key]) + { + $this->db->query( + "UPDATE ".get_table_name('cache')." + SET created=".$this->db->now().", + data=? + WHERE user_id=? + AND cache_key=?", + $data, + $_SESSION['user_id'], + $key); + } + // add new cache record + else + { + $this->db->query( + "INSERT INTO ".get_table_name('cache')." + (created, user_id, cache_key, data) + VALUES (".$this->db->now().", ?, ?, ?)", + $_SESSION['user_id'], + $key, + $data); + } + } + + + function _clear_cache_record($key) + { + $this->db->query( + "DELETE FROM ".get_table_name('cache')." + WHERE user_id=? + AND cache_key=?", + $_SESSION['user_id'], + $key); + } + + + /* -------------------------------- - * encoding/decoding functions + * message caching methods + * --------------------------------*/ + + + // checks if the cache is up-to-date + // return: -3 = off, -2 = incomplete, -1 = dirty + function check_cache_status($mailbox, $cache_key) + { + if (!$this->caching_enabled) + return -3; + + $cache_index = $this->get_message_cache_index($cache_key, TRUE); + $msg_count = $this->_messagecount($mailbox); + $cache_count = count($cache_index); + + // console("Cache check: $msg_count !== ".count($cache_index)); + + if ($cache_count==$msg_count) + { + // get highest index + $header = iil_C_FetchHeader($this->conn, $mailbox, "$msg_count"); + $cache_uid = array_pop($cache_index); + + // uids of highest message matches -> cache seems OK + if ($cache_uid == $header->uid) + return 1; + + // cache is dirty + return -1; + } + // if cache count differs less than 10% report as dirty + else if (abs($msg_count - $cache_count) < $msg_count/10) + return -1; + else + return -2; + } + + + + function get_message_cache($key, $from, $to, $sort_field, $sort_order) + { + $cache_key = "$key:$from:$to:$sort_field:$sort_order"; + $db_header_fields = array('idx', 'uid', 'subject', 'from', 'to', 'cc', 'date', 'size'); + + if (!in_array($sort_field, $db_header_fields)) + $sort_field = 'idx'; + + if ($this->caching_enabled && !isset($this->cache[$cache_key])) + { + $this->cache[$cache_key] = 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 = $sql_arr['uid']; + $this->cache[$cache_key][$uid] = unserialize($sql_arr['headers']); + } + } + + return $this->cache[$cache_key]; + } + + + function &get_cached_message($key, $uid, $struct=false) + { + if (!$this->caching_enabled) + return FALSE; + + $internal_key = '__single_msg'; + if ($this->caching_enabled && (!isset($this->cache[$internal_key][$uid]) || + ($struct && empty($this->cache[$internal_key][$uid]->structure)))) + { + $sql_select = "idx, uid, headers" . ($struct ? ", structure" : ''); + $sql_result = $this->db->query( + "SELECT $sql_select + 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->cache[$internal_key][$uid] = unserialize($sql_arr['headers']); + if (is_object($this->cache[$internal_key][$uid]) && !empty($sql_arr['structure'])) + $this->cache[$internal_key][$uid]->structure = unserialize($sql_arr['structure']); + } + } + + return $this->cache[$internal_key][$uid]; + } + + + function get_message_cache_index($key, $force=FALSE, $sort_col='idx', $sort_order='ASC') + { + static $sa_message_index = array(); + + // empty key -> empty array + if (empty($key)) + return array(); + + if (!empty($sa_message_index[$key]) && !$force) + return $sa_message_index[$key]; + + $sa_message_index[$key] = array(); + $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_col)." ".$sort_order, + $_SESSION['user_id'], + $key); + + while ($sql_arr = $this->db->fetch_assoc($sql_result)) + $sa_message_index[$key][$sql_arr['idx']] = $sql_arr['uid']; + + return $sa_message_index[$key]; + } + + + function add_message_cache($key, $index, $headers, $struct=null) + { + if (empty($key) || !is_object($headers) || empty($headers->uid)) + return; + + // check for an existing record (probly headers are cached but structure not) + $sql_result = $this->db->query( + "SELECT message_id + FROM ".get_table_name('messages')." + WHERE user_id=? + AND cache_key=? + AND uid=? + AND del<>1", + $_SESSION['user_id'], + $key, + $headers->uid); + + // update cache record + if ($sql_arr = $this->db->fetch_assoc($sql_result)) + { + $this->db->query( + "UPDATE ".get_table_name('messages')." + SET idx=?, headers=?, structure=? + WHERE message_id=?", + $index, + serialize($headers), + is_object($struct) ? serialize($struct) : NULL, + $sql_arr['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)substr($this->decode_header($headers->subject, TRUE), 0, 128), + (string)substr($this->decode_header($headers->from, TRUE), 0, 128), + (string)substr($this->decode_header($headers->to, TRUE), 0, 128), + (string)substr($this->decode_header($headers->cc, TRUE), 0, 128), + (int)$headers->size, + serialize($headers), + is_object($struct) ? serialize($struct) : NULL + ); + } + } + + + function remove_message_cache($key, $index) + { + $this->db->query( + "DELETE FROM ".get_table_name('messages')." + WHERE user_id=? + AND cache_key=? + AND idx=?", + $_SESSION['user_id'], + $key, + $index); + } + + + function clear_message_cache($key, $start_index=1) + { + $this->db->query( + "DELETE FROM ".get_table_name('messages')." + WHERE user_id=? + AND cache_key=? + AND idx>=?", + $_SESSION['user_id'], + $key, + $start_index); + } + + + + + /* -------------------------------- + * encoding/decoding methods * --------------------------------*/ @@ -960,7 +2021,7 @@ { $a = $this->_parse_address_list($input); $out = array(); - + if (!is_array($a)) return $out; @@ -986,13 +2047,24 @@ } - function decode_header($input) + function decode_header($input, $remove_quotes=FALSE) { - return $this->decode_mime_string($input); + $str = $this->decode_mime_string((string)$input); + if ($str{0}=='"' && $remove_quotes) + { + $str = str_replace('"', '', $str); + } + + return $str; } - - - function decode_mime_string($input) + + + /** + * Decode a mime-encoded string to internal charset + * + * @access static + */ + function decode_mime_string($input, $recursive=false) { $out = ''; @@ -1013,11 +2085,17 @@ return $out; } - else - return $input; + + // no encoding information, defaults to what is specified in the class header + return rcube_charset_convert($input, 'ISO-8859-1'); } + /** + * Decode a part of a mime-encoded string + * + * @access static + */ function _decode_mime_string_part($str) { $a = explode('?', $str); @@ -1037,10 +2115,10 @@ $rest = quoted_printable_decode($rest); } - return decode_specialchars($rest, $a[0]); + return rcube_charset_convert($rest, $a[0]); } else - return $str; //we dont' know what to do with this + return $str; // we dont' know what to do with this } @@ -1088,10 +2166,13 @@ function charset_decode($body, $ctype_param) { if (is_array($ctype_param) && !empty($ctype_param['charset'])) - return decode_specialchars($body, $ctype_param['charset']); + return rcube_charset_convert($body, $ctype_param['charset']); - return $body; + // defaults to what is specified in the class header + return rcube_charset_convert($body, 'ISO-8859-1'); } + + /* -------------------------------- @@ -1099,17 +2180,17 @@ * --------------------------------*/ - function _mod_mailbox($mbox, $mode='in') + function _mod_mailbox($mbox_name, $mode='in') { - if ((!empty($this->root_ns) && $this->root_ns == $mbox) || ($mbox == 'INBOX' && $mode == 'in')) - return $mbox; + if ((!empty($this->root_ns) && $this->root_ns == $mbox_name) || $mbox_name == 'INBOX') + return $mbox_name; if (!empty($this->root_dir) && $mode=='in') - $mbox = $this->root_dir.$this->delimiter.$mbox; + $mbox_name = $this->root_dir.$this->delimiter.$mbox_name; else if (strlen($this->root_dir) && $mode=='out') - $mbox = substr($mbox, strlen($this->root_dir)+1); + $mbox_name = substr($mbox_name, strlen($this->root_dir)+1); - return $mbox; + return $mbox_name; } @@ -1123,8 +2204,8 @@ { if ($folder{0}=='.') continue; - - if (($p = array_search(strtolower($folder), $this->default_folders))!==FALSE) + + if (($p = array_search(strtolower($folder), $this->default_folders_lc))!==FALSE) $a_defaults[$p] = $folder; else $a_out[] = $folder; @@ -1136,16 +2217,60 @@ return array_merge($a_defaults, $a_out); } - - function _uid2id($uid, $mbox=NULL) + function get_id($uid, $mbox_name=NULL) { - if (!$mbox) - $mbox = $this->mailbox; - - if (!isset($this->uid_id_map[$mbox][$uid])) - $this->uid_id_map[$mbox][$uid] = iil_C_UID2ID($this->conn, $mbox, $uid); + return $this->_uid2id($uid, $mbox_name); + } + + function get_uid($id,$mbox_name=NULL) + { + return $this->_id2uid($id, $mbox_name); + } - return $this->uid_id_map[$mbox][$uid]; + function _uid2id($uid, $mbox_name=NULL) + { + if (!$mbox_name) + $mbox_name = $this->mailbox; + + if (!isset($this->uid_id_map[$mbox_name][$uid])) + $this->uid_id_map[$mbox_name][$uid] = iil_C_UID2ID($this->conn, $mbox_name, $uid); + + return $this->uid_id_map[$mbox_name][$uid]; + } + + function _id2uid($id, $mbox_name=NULL) + { + if (!$mbox_name) + $mbox_name = $this->mailbox; + + return iil_C_ID2UID($this->conn, $mbox_name, $id); + } + + + // parse string or array of server capabilities and put them in internal array + function _parse_capability($caps) + { + if (!is_array($caps)) + $cap_arr = explode(' ', $caps); + else + $cap_arr = $caps; + + foreach ($cap_arr as $cap) + { + if ($cap=='CAPABILITY') + continue; + + if (strpos($cap, '=')>0) + { + list($key, $value) = explode('=', $cap); + if (!is_array($this->capabilities[$key])) + $this->capabilities[$key] = array(); + + $this->capabilities[$key][] = $value; + } + else + $this->capabilities[$cap] = TRUE; + } } @@ -1155,9 +2280,9 @@ $updated = FALSE; if (is_array($a_mboxes)) - foreach ($a_mboxes as $i => $mbox) + foreach ($a_mboxes as $i => $mbox_name) { - $mailbox = $this->_mod_mailbox($mbox); + $mailbox = $this->_mod_mailbox($mbox_name); $a_mboxes[$i] = $mailbox; if ($mode=='subscribe') @@ -1191,10 +2316,10 @@ // increde/decrese messagecount for a specific mailbox - function _set_messagecount($mbox, $mode, $increment) + function _set_messagecount($mbox_name, $mode, $increment) { $a_mailbox_cache = FALSE; - $mailbox = $mbox ? $mbox : $this->mailbox; + $mailbox = $mbox_name ? $mbox_name : $this->mailbox; $mode = strtoupper($mode); $a_mailbox_cache = $this->get_cache('messagecount'); @@ -1204,6 +2329,10 @@ // 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); @@ -1213,10 +2342,10 @@ // remove messagecount of a specific mailbox from cache - function _clear_messagecount($mbox='') + function _clear_messagecount($mbox_name='') { $a_mailbox_cache = FALSE; - $mailbox = $mbox ? $mbox : $this->mailbox; + $mailbox = $mbox_name ? $mbox_name : $this->mailbox; $a_mailbox_cache = $this->get_cache('messagecount'); @@ -1228,16 +2357,38 @@ } + // split RFC822 header string into an associative array + function _parse_headers($headers) + { + $a_headers = array(); + $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; + } + + function _parse_address_list($str) { $a = $this->_explode_quoted_string(',', $str); $result = array(); - + foreach ($a as $key => $val) { $val = str_replace("\"<", "\" <", $val); - $sub_a = $this->_explode_quoted_string(' ', $val); - + $sub_a = $this->_explode_quoted_string(' ', $this->decode_header($val)); + $result[$key]['name'] = ''; + foreach ($sub_a as $k => $v) { if ((strpos($v, '@') > 0) && (strpos($v, '.') > 0)) @@ -1247,9 +2398,7 @@ } if (empty($result[$key]['name'])) - $result[$key]['name'] = $result[$key]['address']; - - $result[$key]['name'] = $this->decode_header($result[$key]['name']); + $result[$key]['name'] = $result[$key]['address']; } return $result; @@ -1274,10 +2423,109 @@ } +/** + * Class representing a message part + */ +class rcube_message_part +{ + var $mime_id = ''; + var $ctype_primary = 'text'; + var $ctype_secondary = 'plain'; + var $mimetype = 'text/plain'; + var $disposition = ''; + var $encoding = '8bit'; + var $charset = ''; + var $size = 0; + var $headers = array(); + var $d_parameters = array(); + var $ctype_parameters = array(); + +} +/** + * rcube_header_sorter + * + * Class for sorting an array of iilBasicHeader objects in a predetermined order. + * + * @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 = $seqnums; + } + + /** + * sort the array of header objects + * + * @param array $headers array of iilBasicHeader 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")); + } + + /** + * get the position of a message sequence number in my sequence_numbers array + * + * @param integer $seqnum message sequence number contained in sequence_numbers + */ + function position_of($seqnum) + { + $c = count($this->sequence_numbers); + for ($pos = 0; $pos <= $c; $pos++) + { + if ($this->sequence_numbers[$pos] == $seqnum) + return $pos; + } + return -1; + } + + /** + * Sort method called by uasort() + */ + 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 = $this->position_of($seqa); + $posb = $this->position_of($seqb); + + // return the relative position as the comparison value + $ret = $posa - $posb; + return $ret; + } +} -function quoted_printable_encode($input="", $line_max=76, $space_conv=false) + +/** + * Add quoted-printable encoding to a given string + * + * @param string $input string to encode + * @param int $line_max add new line after this number of characters + * @param boolena $space_conf true if spaces should be converted into =20 + * @return encoded string + */ +function quoted_printable_encode($input, $line_max=76, $space_conv=false) { $hex = array('0','1','2','3','4','5','6','7','8','9','A','B','C','D','E','F'); $lines = preg_split("/(?:\r\n|\r|\n)/", $input); @@ -1334,4 +2582,5 @@ return trim($output); } + ?> -- Gitblit v1.9.1