From ad84f9c06c14b70f6f764df1f77b964d65db1f99 Mon Sep 17 00:00:00 2001
From: alecpl <alec@alec.pl>
Date: Mon, 22 Jun 2009 14:32:51 -0400
Subject: [PATCH] - performance improvements of messages caching
---
program/include/rcube_imap.php | 252 ++++++++++++++++++++++++++------------------------
1 files changed, 132 insertions(+), 120 deletions(-)
diff --git a/program/include/rcube_imap.php b/program/include/rcube_imap.php
index 1e2ac00..87742ab 100644
--- a/program/include/rcube_imap.php
+++ b/program/include/rcube_imap.php
@@ -303,7 +303,7 @@
if (is_array($str) && $msgs == null)
list($str, $msgs, $charset, $sort_field) = $str;
if ($msgs != null && !is_array($msgs))
- $msgs = split(',', $msgs);
+ $msgs = explode(',', $msgs);
$this->search_string = $str;
$this->search_set = $msgs;
@@ -506,14 +506,8 @@
// 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);
- }
+ $count = is_array($index) ? count($index) : 0;
}
else
{
@@ -570,24 +564,16 @@
$this->_set_sort_order($sort_field, $sort_order);
- $max = $this->_messagecount($mailbox);
- $start_msg = ($this->list_page-1) * $this->page_size;
-
- list($begin, $end) = $this->_get_message_range($max, $page);
-
- // mailbox is empty
- if ($begin >= $end)
- return array();
-
- $headers_sorted = FALSE;
+ $page = $page ? $page : $this->list_page;
$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)
{
+ $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);
- $headers_sorted = TRUE;
+ return array_values($a_msg_headers);
}
// cache is dirty, sync it
else if ($this->caching_enabled && $cache_status==-1 && !$recursive)
@@ -595,49 +581,54 @@
$this->sync_header_index($mailbox);
return $this->_list_headers($mailbox, $page, $this->sort_field, $this->sort_order, TRUE);
}
+
+ // retrieve headers from IMAP
+ $a_msg_headers = array();
+
+ if ($this->get_capability('sort') && ($msg_index = iil_C_Sort($this->conn, $mailbox, $this->sort_field, $this->skip_deleted ? 'UNDELETED' : '')))
+ {
+ list($begin, $end) = $this->_get_message_range(count($msg_index), $page);
+ $max = max($msg_index);
+ $msg_index = array_slice($msg_index, $begin, $end-$begin);
+
+ // fetch reqested headers from server
+ $this->_fetch_headers($mailbox, join(',', $msg_index), $a_msg_headers, $cache_key);
+ }
else
{
- // retrieve headers from IMAP
- if ($this->get_capability('sort') && ($msg_index = iil_C_Sort($this->conn, $mailbox, $this->sort_field, $this->skip_deleted ? 'UNDELETED' : '')))
- {
- $mymsgidx = array_slice ($msg_index, $begin, $end-$begin);
- $msgs = join(",", $mymsgidx);
- }
- else
- {
- $msgs = sprintf("%d:%d", $begin+1, $end);
- $msg_index = range($begin, $end);
- }
+ $a_index = iil_C_FetchHeaderIndex($this->conn, $mailbox, "1:*", $this->sort_field, $this->skip_deleted);
+
+ if (empty($a_index))
+ return array();
+ 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);
- // 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+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
- // ...
+ // 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)) {
+ 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 not already sorted
- if (!$headers_sorted)
- {
- // 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);
- }
+ if ($this->sort_order == 'DESC')
+ $a_msg_headers = array_reverse($a_msg_headers);
return array_values($a_msg_headers);
}
@@ -661,7 +652,8 @@
$msgs = $this->search_set;
$a_msg_headers = array();
- $start_msg = ($this->list_page-1) * $this->page_size;
+ $page = $page ? $page : $this->list_page;
+ $start_msg = ($page-1) * $this->page_size;
$this->_set_sort_order($sort_field, $sort_order);
@@ -741,7 +733,7 @@
*/
function _get_message_range($max, $page)
{
- $start_msg = ($this->list_page-1) * $this->page_size;
+ $start_msg = ($page-1) * $this->page_size;
if ($page=='all')
{
@@ -766,7 +758,6 @@
return array($begin, $end);
}
-
/**
* Fetches message headers
@@ -776,7 +767,7 @@
* @param string Message index to fetch
* @param array Reference to message headers array
* @param array Array with cache index
- * @return int Number of deleted messages
+ * @return int Messages count
* @access private
*/
function _fetch_headers($mailbox, $msgs, &$a_msg_headers, $cache_key)
@@ -784,24 +775,23 @@
// cache is incomplete
$cache_index = $this->get_message_cache_index($cache_key);
- // fetch reuested headers from server
+ // fetch reqested headers from server
$a_header_index = iil_C_FetchHeaders($this->conn, $mailbox, $msgs, false, $this->fetch_add_headers);
- $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->uid);
- $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);
@@ -810,7 +800,7 @@
}
}
- return $deleted_count;
+ return count($a_msg_headers);
}
@@ -846,7 +836,7 @@
}
else
{
- $a_index = iil_C_FetchHeaderIndex($this->conn, $mailbox, join(',', $this->search_set), $this->sort_field, false);
+ $a_index = iil_C_FetchHeaderIndex($this->conn, $mailbox, join(',', $this->search_set), $this->sort_field, $this->skip_deleted);
if ($this->sort_order=="ASC")
asort($a_index);
@@ -873,8 +863,7 @@
}
// 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, '')))
+ if ($this->get_capability('sort') && ($a_index = iil_C_Sort($this->conn, $mailbox, $this->sort_field, $this->skip_deleted ? 'UNDELETED' : '')))
{
if ($this->sort_order == 'DESC')
$a_index = array_reverse($a_index);
@@ -883,7 +872,7 @@
}
else
{
- $a_index = iil_C_FetchHeaderIndex($this->conn, $mailbox, "1:$msg_count", $this->sort_field);
+ $a_index = iil_C_FetchHeaderIndex($this->conn, $mailbox, "1:*", $this->sort_field, $this->skip_deleted);
if ($this->sort_order=="ASC")
asort($a_index);
@@ -904,10 +893,12 @@
{
$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');
+ $a_message_index = iil_C_FetchHeaderIndex($this->conn, $mailbox, "1:*", 'UID', $this->skip_deleted);
+
+ if ($a_message_index === false)
+ return false;
foreach ($a_message_index as $id => $uid)
{
@@ -927,21 +918,25 @@
// other message at this position
if (isset($cache_index[$id]))
{
- $this->remove_message_cache($cache_key, $cache_index[$id]);
+ $for_remove[] = $cache_index[$id];
unset($cache_index[$id]);
}
-
- // fetch complete headers and add to cache
- $headers = iil_C_FetchHeader($this->conn, $mailbox, $id, false, $this->fetch_add_headers);
- $this->add_message_cache($cache_key, $headers->id, $headers);
+ $for_update[] = $id;
}
- // those ids that are still in cache_index have been deleted
+ // clear 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))
- {
- foreach ($cache_index as $id => $uid)
- $this->remove_message_cache($cache_key, $uid);
+ $this->remove_message_cache($cache_key, $cache_index);
+
+ // fetch complete headers and add to cache
+ if (!empty($for_update)) {
+ if ($headers = iil_C_FetchHeader($this->conn, $mailbox, join(',', $for_update), false, $this->fetch_add_headers))
+ foreach ($headers as $header)
+ $this->add_message_cache($cache_key, $header->id, $header);
}
}
@@ -967,7 +962,7 @@
// try search with US-ASCII charset (should be supported by server)
// only if UTF-8 search is not supported
- if (empty($results) && !is_array($results) && !empty($charset) && $charset!='US-ASCII')
+ if (empty($results) && !is_array($results) && !empty($charset) && $charset != 'US-ASCII')
{
// convert strings to US_ASCII
if(preg_match_all('/\{([0-9]+)\}\r\n/', $str, $matches, PREG_OFFSET_CAPTURE))
@@ -988,7 +983,7 @@
else // strings for conversion not found
$res = $str;
- $results = $this->search($mbox_name, $res, 'US-ASCII', $sort_field);
+ $results = $this->search($mbox_name, $res, NULL, $sort_field);
}
$this->set_search_set($str, $results, $charset, $sort_field);
@@ -1006,6 +1001,11 @@
*/
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 ($sort_field && $this->get_capability('sort'))
{
$charset = $charset ? $charset : $this->default_charset;
@@ -1021,6 +1021,11 @@
if (empty($val))
unset($a_messages[$i]);
}
+
+ // update messagecount cache ?
+// $a_mailbox_cache = get_cache('messagecount');
+// $a_mailbox_cache[$mailbox][$criteria] = sizeof($a_messages);
+// $this->update_cache('messagecount', $a_mailbox_cache);
return $a_messages;
}
@@ -1543,9 +1548,7 @@
$cache_key = $mailbox.'.msg';
if ($this->caching_enabled)
{
- foreach ($uids as $uid)
- if ($cached_headers = $this->get_cached_message($cache_key, $uid))
- $this->remove_message_cache($cache_key, $uid);
+ $this->remove_message_cache($cache_key, $uids);
// close and re-open connection
// this prevents connection problems with Courier
@@ -1627,13 +1630,9 @@
// send expunge command in order to have the moved message
// really deleted from the source mailbox
if ($moved) {
- // but only when flag_for_deletion is set to false
- if (!rcmail::get_instance()->config->get('flag_for_deletion', false))
- {
- $this->_expunge($from_mbox, FALSE, $a_uids);
- $this->_clear_messagecount($from_mbox);
- $this->_clear_messagecount($to_mbox);
- }
+ $this->_expunge($from_mbox, FALSE, $a_uids);
+ $this->_clear_messagecount($from_mbox);
+ $this->_clear_messagecount($to_mbox);
}
// moving failed
else if (rcmail::get_instance()->config->get('delete_always', false)) {
@@ -1658,7 +1657,8 @@
}
// clear cache from the lowest index on
- $this->clear_message_cache($cache_key, $start_index);
+ if ($start_index < 100000)
+ $this->clear_message_cache($cache_key, $start_index);
}
return $moved;
@@ -1713,7 +1713,8 @@
}
// clear cache from the lowest index on
- $this->clear_message_cache($cache_key, $start_index);
+ if ($start_index < 100000)
+ $this->clear_message_cache($cache_key, $start_index);
}
return $deleted;
@@ -1961,7 +1962,7 @@
/**
* Remove mailboxes from server
*
- * @param string Mailbox name
+ * @param string Mailbox name(s) string/array
* @return boolean True on success
*/
function delete_mailbox($mbox_name)
@@ -1985,9 +1986,11 @@
// send delete command to server
$result = iil_C_DeleteFolder($this->conn, $mailbox);
- if ($result>=0)
+ if ($result >= 0) {
$deleted = TRUE;
-
+ $this->clear_message_cache($mailbox.'.msg');
+ }
+
foreach ($all_mboxes as $c_mbox)
{
$regex = preg_quote($mailbox . $this->delimiter, '/');
@@ -1996,18 +1999,17 @@
{
iil_C_UnSubscribe($this->conn, $c_mbox);
$result = iil_C_DeleteFolder($this->conn, $c_mbox);
- if ($result>=0)
+ if ($result >= 0) {
$deleted = TRUE;
- }
+ $this->clear_message_cache($c_mbox.'.msg');
+ }
+ }
}
}
// clear mailboxlist cache
if ($deleted)
- {
- $this->clear_message_cache($mailbox.'.msg');
$this->clear_cache('mailboxes');
- }
return $deleted;
}
@@ -2220,7 +2222,7 @@
* @return int -3 = off, -2 = incomplete, -1 = dirty
*/
function check_cache_status($mailbox, $cache_key)
- {
+ {
if (!$this->caching_enabled)
return -3;
@@ -2230,25 +2232,37 @@
// 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", false, $this->fetch_add_headers);
- $cache_uid = array_pop($cache_index);
-
- // uids of highest message matches -> cache seems OK
- if ($cache_uid == $header->uid)
- return 1;
+ if ($cache_count==$msg_count) {
+ if ($this->skip_deleted) {
+ $h_index = iil_C_FetchHeaderIndex($this->conn, $mailbox, "1:*", 'UID', $this->skip_deleted);
+ if (sizeof($h_index) == $cache_count) {
+ $cache_index = array_flip($cache_index);
+ foreach ($h_index as $idx => $uid)
+ unset($cache_index[$uid]);
+
+ if (empty($cache_index))
+ return 1;
+ }
+ return -2;
+ } else {
+ // 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;
- }
+ }
/**
* @access private
@@ -2310,7 +2324,6 @@
$_SESSION['user_id'],
$key,
$uid);
-
if ($sql_arr = $this->db->fetch_assoc($sql_result))
{
$this->cache[$internal_key][$uid] = unserialize($sql_arr['headers']);
@@ -2417,19 +2430,18 @@
/**
* @access private
*/
- function remove_message_cache($key, $uid)
+ function remove_message_cache($key, $uids)
{
if (!$this->caching_enabled)
return;
$this->db->query(
"DELETE FROM ".get_table_name('messages')."
- WHERE user_id=?
- AND cache_key=?
- AND uid=?",
+ WHERE user_id=?
+ AND cache_key=?
+ AND uid IN (".$this->db->array2list($uids, 'integer').")",
$_SESSION['user_id'],
- $key,
- $uid);
+ $key);
}
/**
@@ -2675,7 +2687,7 @@
/**
- * Convert body charset to UTF-8 according to the ctype_parameters
+ * Convert body charset to RCMAIL_CHARSET according to the ctype_parameters
*
* @param string Part body to decode
* @param string Charset to convert from
--
Gitblit v1.9.1