From 38dc510b2dba02dba5a60fbc00947aac4fd24aab Mon Sep 17 00:00:00 2001
From: alecpl <alec@alec.pl>
Date: Wed, 29 Feb 2012 06:53:52 -0500
Subject: [PATCH] - Fix warning when properties array is empty
---
program/include/rcube_imap_cache.php | 746 +++++++++++++++++++++++++++++++++++++-------------------
1 files changed, 493 insertions(+), 253 deletions(-)
diff --git a/program/include/rcube_imap_cache.php b/program/include/rcube_imap_cache.php
index f0c3fbb..655979d 100644
--- a/program/include/rcube_imap_cache.php
+++ b/program/include/rcube_imap_cache.php
@@ -6,7 +6,10 @@
| |
| This file is part of the Roundcube Webmail client |
| Copyright (C) 2005-2011, The Roundcube Dev Team |
- | Licensed under the GNU GPL |
+ | |
+ | Licensed under the GNU General Public License version 3 or |
+ | any later version with exceptions for skins & plugins. |
+ | See the README file for a full license statement. |
| |
| PURPOSE: |
| Caching of IMAP folder contents (messages and index) |
@@ -61,7 +64,28 @@
private $skip_deleted = false;
- public $flag_fields = array('seen', 'deleted', 'answered', 'forwarded', 'flagged', 'mdnsent');
+ /**
+ * List of known flags. Thanks to this we can handle flag changes
+ * with good performance. Bad thing is we need to know used flags.
+ */
+ public $flags = array(
+ 1 => 'SEEN', // RFC3501
+ 2 => 'DELETED', // RFC3501
+ 4 => 'ANSWERED', // RFC3501
+ 8 => 'FLAGGED', // RFC3501
+ 16 => 'DRAFT', // RFC3501
+ 32 => 'MDNSENT', // RFC3503
+ 64 => 'FORWARDED', // RFC5550
+ 128 => 'SUBMITPENDING', // RFC5550
+ 256 => 'SUBMITTED', // RFC5550
+ 512 => 'JUNK',
+ 1024 => 'NONJUNK',
+ 2048 => 'LABEL1',
+ 4096 => 'LABEL2',
+ 8192 => 'LABEL3',
+ 16384 => 'LABEL4',
+ 32768 => 'LABEL5',
+ );
/**
@@ -87,7 +111,7 @@
/**
- * Return (sorted) messages index.
+ * Return (sorted) messages index (UIDs).
* If index doesn't exist or is invalid, will be updated.
*
* @param string $mailbox Folder name
@@ -99,23 +123,30 @@
*/
function get_index($mailbox, $sort_field = null, $sort_order = null, $existing = false)
{
- if (empty($this->icache[$mailbox]))
+ if (empty($this->icache[$mailbox])) {
$this->icache[$mailbox] = array();
+ }
$sort_order = strtoupper($sort_order) == 'ASC' ? 'ASC' : 'DESC';
// Seek in internal cache
- if (array_key_exists('index', $this->icache[$mailbox])
- && ($sort_field == 'ANY' || $this->icache[$mailbox]['index']['sort_field'] == $sort_field)
- ) {
- if ($this->icache[$mailbox]['index']['sort_order'] == $sort_order)
- return $this->icache[$mailbox]['index']['result'];
- else
- return array_reverse($this->icache[$mailbox]['index']['result'], true);
+ if (array_key_exists('index', $this->icache[$mailbox])) {
+ // The index was fetched from database already, but not validated yet
+ if (!array_key_exists('object', $this->icache[$mailbox]['index'])) {
+ $index = $this->icache[$mailbox]['index'];
+ }
+ // We've got a valid index
+ else if ($sort_field == 'ANY' || $this->icache[$mailbox]['index']['sort_field'] == $sort_field) {
+ $result = $this->icache[$mailbox]['index']['object'];
+ if ($result->get_parameters('ORDER') != $sort_order) {
+ $result->revert();
+ }
+ return $result;
+ }
}
// Get index from DB (if DB wasn't already queried)
- if (empty($this->icache[$mailbox]['index_queried'])) {
+ if (empty($index) && empty($this->icache[$mailbox]['index_queried'])) {
$index = $this->get_index_row($mailbox);
// set the flag that DB was already queried for index
@@ -123,7 +154,8 @@
// get_index() is called more than once
$this->icache[$mailbox]['index_queried'] = true;
}
- $data = null;
+
+ $data = null;
// @TODO: Think about skipping validation checks.
// If we could check only every 10 minutes, we would be able to skip
@@ -131,7 +163,7 @@
// additional logic to force cache invalidation in some cases
// and many rcube_imap changes to connect when needed
- // Entry exist, check cache status
+ // Entry exists, check cache status
if (!empty($index)) {
$exists = true;
@@ -147,68 +179,39 @@
}
if ($is_valid) {
- // build index, assign sequence IDs to unique IDs
- $data = array_combine($index['seq'], $index['uid']);
+ $data = $index['object'];
// revert the order if needed
- if ($index['sort_order'] != $sort_order)
- $data = array_reverse($data, true);
+ if ($data->get_parameters('ORDER') != $sort_order) {
+ $data->revert();
+ }
}
}
else {
- // Got it in internal cache, so the row already exist
- $exists = array_key_exists('index', $this->icache[$mailbox]);
-
if ($existing) {
return null;
}
else if ($sort_field == 'ANY') {
$sort_field = '';
}
+
+ // Got it in internal cache, so the row already exist
+ $exists = array_key_exists('index', $this->icache[$mailbox]);
}
// Index not found, not valid or sort field changed, get index from IMAP server
if ($data === null) {
// Get mailbox data (UIDVALIDITY, counters, etc.) for status check
- $mbox_data = $this->imap->mailbox_data($mailbox);
- $data = array();
-
- // Prevent infinite loop.
- // It happens when rcube_imap::message_index_direct() is called.
- // There id2uid() is called which will again call get_index() and so on.
- if (!$sort_field && !$this->skip_deleted)
- $this->icache['pending_index_update'] = true;
-
- if ($mbox_data['EXISTS']) {
- // fetch sorted sequence numbers
- $data_seq = $this->imap->message_index_direct($mailbox, $sort_field, $sort_order);
- // fetch UIDs
- if (!empty($data_seq)) {
- // Seek in internal cache
- if (array_key_exists('index', (array)$this->icache[$mailbox]))
- $data_uid = $this->icache[$mailbox]['index']['result'];
- else
- $data_uid = $this->imap->conn->fetchUIDs($mailbox, $data_seq);
-
- // build index
- if (!empty($data_uid)) {
- foreach ($data_seq as $seq)
- if ($uid = $data_uid[$seq])
- $data[$seq] = $uid;
- }
- }
- }
-
- // Reset internal flags
- $this->icache['pending_index_update'] = false;
+ $mbox_data = $this->imap->folder_data($mailbox);
+ $data = $this->get_index_data($mailbox, $sort_field, $sort_order, $mbox_data);
// insert/update
- $this->add_index_row($mailbox, $sort_field, $sort_order, $data, $mbox_data, $exists);
+ $this->add_index_row($mailbox, $sort_field, $data, $mbox_data, $exists, $index['modseq']);
}
$this->icache[$mailbox]['index'] = array(
- 'result' => $data,
+ 'object' => $data,
'sort_field' => $sort_field,
- 'sort_order' => $sort_order,
+ 'modseq' => !empty($index['modseq']) ? $index['modseq'] : $mbox_data['HIGHESTMODSEQ']
);
return $data;
@@ -227,21 +230,24 @@
*/
function get_thread($mailbox)
{
- if (empty($this->icache[$mailbox]))
+ if (empty($this->icache[$mailbox])) {
$this->icache[$mailbox] = array();
+ }
// Seek in internal cache
if (array_key_exists('thread', $this->icache[$mailbox])) {
- return array(
- $this->icache[$mailbox]['thread']['tree'],
- $this->icache[$mailbox]['thread']['depth'],
- $this->icache[$mailbox]['thread']['children'],
- );
+ return $this->icache[$mailbox]['thread']['object'];
}
- // Get index from DB
- $index = $this->get_thread_row($mailbox);
- $data = null;
+ // Get thread from DB (if DB wasn't already queried)
+ if (empty($this->icache[$mailbox]['thread_queried'])) {
+ $index = $this->get_thread_row($mailbox);
+
+ // set the flag that DB was already queried for thread
+ // this way we'll be able to skip one SELECT, when
+ // get_thread() is called more than once or after clear()
+ $this->icache[$mailbox]['thread_queried'] = true;
+ }
// Entry exist, check cache status
if (!empty($index)) {
@@ -256,26 +262,25 @@
// Index not found or not valid, get index from IMAP server
if ($index === null) {
// Get mailbox data (UIDVALIDITY, counters, etc.) for status check
- $mbox_data = $this->imap->mailbox_data($mailbox);
+ $mbox_data = $this->imap->folder_data($mailbox);
if ($mbox_data['EXISTS']) {
// get all threads (default sort order)
- list ($thread_tree, $msg_depth, $has_children) = $this->imap->fetch_threads($mailbox, true);
+ $threads = $this->imap->fetch_threads($mailbox, true);
+ }
+ else {
+ $threads = new rcube_result_thread($mailbox, '* THREAD');
}
- $index = array(
- 'tree' => !empty($thread_tree) ? $thread_tree : array(),
- 'depth' => !empty($msg_depth) ? $msg_depth : array(),
- 'children' => !empty($has_children) ? $has_children : array(),
- );
+ $index['object'] = $threads;
// insert/update
- $this->add_thread_row($mailbox, $index, $mbox_data, $exists);
+ $this->add_thread_row($mailbox, $threads, $mbox_data, $exists);
}
$this->icache[$mailbox]['thread'] = $index;
- return array($index['tree'], $index['depth'], $index['children']);
+ return $index['object'];
}
@@ -283,32 +288,19 @@
* Returns list of messages (headers). See rcube_imap::fetch_headers().
*
* @param string $mailbox Folder name
- * @param array $msgs Message sequence numbers
- * @param bool $is_uid True if $msgs contains message UIDs
+ * @param array $msgs Message UIDs
*
* @return array The list of messages (rcube_mail_header) indexed by UID
*/
- function get_messages($mailbox, $msgs = array(), $is_uid = true)
+ function get_messages($mailbox, $msgs = array())
{
if (empty($msgs)) {
return array();
}
- // Convert IDs to UIDs
- // @TODO: it would be nice if we could work with UIDs only
- // then, e.g. when fetching search result, index would be not needed
- if (!$is_uid) {
- $index = $this->get_index($mailbox, 'ANY');
- foreach ($msgs as $idx => $msgid)
- if ($uid = $index[$msgid])
- $msgs[$idx] = $uid;
- }
-
- $flag_fields = implode(', ', array_map(array($this->db, 'quoteIdentifier'), $this->flag_fields));
-
// Fetch messages from cache
$sql_result = $this->db->query(
- "SELECT uid, data, ".$flag_fields
+ "SELECT uid, data, flags"
." FROM ".get_table_name('cache_messages')
." WHERE user_id = ?"
." AND mailbox = ?"
@@ -321,9 +313,9 @@
while ($sql_arr = $this->db->fetch_assoc($sql_result)) {
$uid = intval($sql_arr['uid']);
$result[$uid] = $this->build_message($sql_arr);
- // save memory, we don't need a body here
+
+ // save memory, we don't need message body here (?)
$result[$uid]->body = null;
-//@TODO: update message ID according to index data?
if (!empty($result[$uid])) {
unset($msgs[$uid]);
@@ -332,7 +324,7 @@
// Fetch not found messages from IMAP server
if (!empty($msgs)) {
- $messages = $this->imap->fetch_headers($mailbox, array_keys($msgs), true, true);
+ $messages = $this->imap->fetch_headers($mailbox, array_keys($msgs), false, true);
// Insert to DB and add to result list
if (!empty($messages)) {
@@ -352,10 +344,13 @@
*
* @param string $mailbox Folder name
* @param int $uid Message UID
+ * @param bool $update If message doesn't exists in cache it will be fetched
+ * from IMAP server
+ * @param bool $no_cache Enables internal cache usage
*
* @return rcube_mail_header Message data
*/
- function get_message($mailbox, $uid)
+ function get_message($mailbox, $uid, $update = true, $cache = true)
{
// Check internal cache
if (($message = $this->icache['message'])
@@ -364,10 +359,8 @@
return $this->icache['message']['object'];
}
- $flag_fields = implode(', ', array_map(array($this->db, 'quoteIdentifier'), $this->flag_fields));
-
$sql_result = $this->db->query(
- "SELECT data, ".$flag_fields
+ "SELECT flags, data"
." FROM ".get_table_name('cache_messages')
." WHERE user_id = ?"
." AND mailbox = ?"
@@ -377,13 +370,11 @@
if ($sql_arr = $this->db->fetch_assoc($sql_result)) {
$message = $this->build_message($sql_arr);
$found = true;
-
-//@TODO: update message ID according to index data?
}
// Get the message from IMAP server
- if (empty($message)) {
- $message = $this->imap->get_headers($uid, $mailbox, true);
+ if (empty($message) && $update) {
+ $message = $this->imap->get_message_headers($uid, $mailbox, true);
// cache will be updated in close(), see below
}
@@ -393,7 +384,7 @@
// - set message headers/structure (INSERT or UPDATE)
// - set \Seen flag (UPDATE)
// This way we can skip one UPDATE
- if (!empty($message)) {
+ if (!empty($message) && $cache) {
// Save current message from internal cache
$this->save_icache();
@@ -418,42 +409,44 @@
*/
function add_message($mailbox, $message, $force = false)
{
- if (!is_object($message) || empty($message->uid))
+ if (!is_object($message) || empty($message->uid)) {
return;
+ }
- $msg = serialize($this->db->encode(clone $message));
+ $msg = serialize($this->db->encode(clone $message));
+ $flags = 0;
- $flag_fields = array_map(array($this->db, 'quoteIdentifier'), $this->flag_fields);
- $flag_values = array();
-
- foreach ($this->flag_fields as $flag)
- $flag_values[] = (int) $message->$flag;
+ if (!empty($message->flags)) {
+ foreach ($this->flags as $idx => $flag) {
+ if (!empty($message->flags[$flag])) {
+ $flags += $idx;
+ }
+ }
+ }
+ unset($msg->flags);
// update cache record (even if it exists, the update
// here will work as select, assume row exist if affected_rows=0)
if (!$force) {
- foreach ($flag_fields as $key => $val)
- $flag_data[] = $val . " = " . $flag_values[$key];
-
$res = $this->db->query(
"UPDATE ".get_table_name('cache_messages')
- ." SET data = ?, changed = ".$this->db->now()
- .", " . implode(', ', $flag_data)
+ ." SET flags = ?, data = ?, changed = ".$this->db->now()
." WHERE user_id = ?"
." AND mailbox = ?"
." AND uid = ?",
- $msg, $this->userid, $mailbox, (int) $message->uid);
+ $flags, $msg, $this->userid, $mailbox, (int) $message->uid);
- if ($this->db->affected_rows())
+ if ($this->db->affected_rows()) {
return;
+ }
}
// insert new record
$this->db->query(
"INSERT INTO ".get_table_name('cache_messages')
- ." (user_id, mailbox, uid, changed, data, " . implode(', ', $flag_fields) . ")"
- ." VALUES (?, ?, ?, ".$this->db->now().", ?, " . implode(', ', $flag_values) . ")",
- $this->userid, $mailbox, (int) $message->uid, $msg);
+ ." (user_id, mailbox, uid, flags, changed, data)"
+ ." VALUES (?, ?, ?, ?, ".$this->db->now().", ?)",
+ $this->userid, $mailbox, (int) $message->uid, $flags, $msg);
}
@@ -468,31 +461,31 @@
*/
function change_flag($mailbox, $uids, $flag, $enabled = false)
{
- $flag = strtolower($flag);
+ $flag = strtoupper($flag);
+ $idx = (int) array_search($flag, $this->flags);
- if (in_array($flag, $this->flag_fields)) {
- // Internal cache update
- if ($uids && count($uids) == 1 && ($uid = current($uids))
- && ($message = $this->icache['message'])
- && $message['mailbox'] == $mailbox && $message['object']->uid == $uid
- ) {
- $message['object']->$flag = $enabled;
- return;
- }
+ if (!$idx) {
+ return;
+ }
- $this->db->query(
- "UPDATE ".get_table_name('cache_messages')
- ." SET changed = ".$this->db->now()
- .", " .$this->db->quoteIdentifier($flag) . " = " . intval($enabled)
- ." WHERE user_id = ?"
- ." AND mailbox = ?"
- .($uids !== null ? " AND uid IN (".$this->db->array2list((array)$uids, 'integer').")" : ""),
- $this->userid, $mailbox);
+ // Internal cache update
+ if ($uids && count($uids) == 1 && ($uid = current($uids))
+ && ($message = $this->icache['message'])
+ && $message['mailbox'] == $mailbox && $message['object']->uid == $uid
+ ) {
+ $message['object']->flags[$flag] = $enabled;
+ return;
}
- else {
- // @TODO: SELECT+UPDATE?
- $this->remove_message($mailbox, $uids);
- }
+
+ $this->db->query(
+ "UPDATE ".get_table_name('cache_messages')
+ ." SET changed = ".$this->db->now()
+ .", flags = flags ".($enabled ? "+ $idx" : "- $idx")
+ ." WHERE user_id = ?"
+ ." AND mailbox = ?"
+ .($uids !== null ? " AND uid IN (".$this->db->array2list((array)$uids, 'integer').")" : "")
+ ." AND (flags & $idx) ".($enabled ? "= 0" : "= $idx"),
+ $this->userid, $mailbox);
}
@@ -533,19 +526,37 @@
* Clears index cache.
*
* @param string $mailbox Folder name
+ * @param bool $remove Enable to remove the DB row
*/
- function remove_index($mailbox = null)
+ function remove_index($mailbox = null, $remove = false)
{
- $this->db->query(
- "DELETE FROM ".get_table_name('cache_index')
- ." WHERE user_id = ".intval($this->userid)
- .(strlen($mailbox) ? " AND mailbox = ".$this->db->quote($mailbox) : "")
- );
+ // The index should be only removed from database when
+ // UIDVALIDITY was detected or the mailbox is empty
+ // otherwise use 'valid' flag to not loose HIGHESTMODSEQ value
+ if ($remove) {
+ $this->db->query(
+ "DELETE FROM ".get_table_name('cache_index')
+ ." WHERE user_id = ".intval($this->userid)
+ .(strlen($mailbox) ? " AND mailbox = ".$this->db->quote($mailbox) : "")
+ );
+ }
+ else {
+ $this->db->query(
+ "UPDATE ".get_table_name('cache_index')
+ ." SET valid = 0"
+ ." WHERE user_id = ".intval($this->userid)
+ .(strlen($mailbox) ? " AND mailbox = ".$this->db->quote($mailbox) : "")
+ );
+ }
- if (strlen($mailbox))
+ if (strlen($mailbox)) {
unset($this->icache[$mailbox]['index']);
- else
+ // Index removed, set flag to skip SELECT query in get_index()
+ $this->icache[$mailbox]['index_queried'] = true;
+ }
+ else {
$this->icache = array();
+ }
}
@@ -562,10 +573,14 @@
.(strlen($mailbox) ? " AND mailbox = ".$this->db->quote($mailbox) : "")
);
- if (strlen($mailbox))
+ if (strlen($mailbox)) {
unset($this->icache[$mailbox]['thread']);
- else
+ // Thread data removed, set flag to skip SELECT query in get_thread()
+ $this->icache[$mailbox]['thread_queried'] = true;
+ }
+ else {
$this->icache = array();
+ }
}
@@ -577,45 +592,30 @@
*/
function clear($mailbox = null, $uids = null)
{
- $this->remove_index($mailbox);
+ $this->remove_index($mailbox, true);
$this->remove_thread($mailbox);
$this->remove_message($mailbox, $uids);
}
/**
- * @param string $mailbox Folder name
- * @param int $id Message (sequence) ID
+ * Delete cache entries older than TTL
*
- * @return int Message UID
+ * @param string $ttl Lifetime of message cache entries
*/
- function id2uid($mailbox, $id)
+ function expunge($ttl)
{
- if (!empty($this->icache['pending_index_update']))
- return null;
+ // get expiration timestamp
+ $ts = get_offset_time($ttl, -1);
- // get index if it exists
- $index = $this->get_index($mailbox, 'ANY', null, true);
+ $this->db->query("DELETE FROM ".get_table_name('cache_messages')
+ ." WHERE changed < " . $this->db->fromunixtime($ts));
- return $index[$id];
- }
+ $this->db->query("DELETE FROM ".get_table_name('cache_index')
+ ." WHERE changed < " . $this->db->fromunixtime($ts));
-
- /**
- * @param string $mailbox Folder name
- * @param int $uid Message UID
- *
- * @return int Message (sequence) ID
- */
- function uid2id($mailbox, $uid)
- {
- if (!empty($this->icache['pending_index_update']))
- return null;
-
- // get index if it exists
- $index = $this->get_index($mailbox, 'ANY', null, true);
-
- return array_search($uid, (array)$index);
+ $this->db->query("DELETE FROM ".get_table_name('cache_thread')
+ ." WHERE changed < " . $this->db->fromunixtime($ts));
}
@@ -626,23 +626,29 @@
{
// Get index from DB
$sql_result = $this->db->query(
- "SELECT data"
+ "SELECT data, valid"
." FROM ".get_table_name('cache_index')
." WHERE user_id = ?"
." AND mailbox = ?",
$this->userid, $mailbox);
if ($sql_arr = $this->db->fetch_assoc($sql_result)) {
- $data = explode('@', $sql_arr['data']);
+ $data = explode('@', $sql_arr['data']);
+ $index = @unserialize($data[0]);
+ unset($data[0]);
+
+ if (empty($index)) {
+ $index = new rcube_result_index($mailbox);
+ }
return array(
- 'seq' => explode(',', $data[0]),
- 'uid' => explode(',', $data[1]),
- 'sort_field' => $data[2],
- 'sort_order' => $data[3],
- 'deleted' => $data[4],
- 'validity' => $data[5],
- 'uidnext' => $data[6],
+ 'valid' => $sql_arr['valid'],
+ 'object' => $index,
+ 'sort_field' => $data[1],
+ 'deleted' => $data[2],
+ 'validity' => $data[3],
+ 'uidnext' => $data[4],
+ 'modseq' => $data[5],
);
}
@@ -664,17 +670,16 @@
$this->userid, $mailbox);
if ($sql_arr = $this->db->fetch_assoc($sql_result)) {
- $data = explode('@', $sql_arr['data']);
+ $data = explode('@', $sql_arr['data']);
+ $thread = @unserialize($data[0]);
+ unset($data[0]);
- $data[0] = unserialize($data[0]);
- // build 'depth' and 'children' arrays
- $depth = $children = array();
- $this->build_thread_data($data[0], $depth, $children);
+ if (empty($thread)) {
+ $thread = new rcube_result_thread($mailbox);
+ }
return array(
- 'tree' => $data[0],
- 'depth' => $depth,
- 'children' => $children,
+ 'object' => $thread,
'deleted' => $data[1],
'validity' => $data[2],
'uidnext' => $data[3],
@@ -688,62 +693,65 @@
/**
* Saves index data into database
*/
- private function add_index_row($mailbox, $sort_field, $sort_order,
- $data = array(), $mbox_data = array(), $exists = false)
+ private function add_index_row($mailbox, $sort_field,
+ $data, $mbox_data = array(), $exists = false, $modseq = null)
{
$data = array(
- implode(',', array_keys($data)),
- implode(',', array_values($data)),
+ serialize($data),
$sort_field,
- $sort_order,
(int) $this->skip_deleted,
(int) $mbox_data['UIDVALIDITY'],
(int) $mbox_data['UIDNEXT'],
+ $modseq ? $modseq : $mbox_data['HIGHESTMODSEQ'],
);
$data = implode('@', $data);
- if ($exists)
+ if ($exists) {
$sql_result = $this->db->query(
"UPDATE ".get_table_name('cache_index')
- ." SET data = ?, changed = ".$this->db->now()
+ ." SET data = ?, valid = 1, changed = ".$this->db->now()
." WHERE user_id = ?"
." AND mailbox = ?",
$data, $this->userid, $mailbox);
- else
+ }
+ else {
$sql_result = $this->db->query(
"INSERT INTO ".get_table_name('cache_index')
- ." (user_id, mailbox, data, changed)"
- ." VALUES (?, ?, ?, ".$this->db->now().")",
+ ." (user_id, mailbox, data, valid, changed)"
+ ." VALUES (?, ?, ?, 1, ".$this->db->now().")",
$this->userid, $mailbox, $data);
+ }
}
/**
* Saves thread data into database
*/
- private function add_thread_row($mailbox, $data = array(), $mbox_data = array(), $exists = false)
+ private function add_thread_row($mailbox, $data, $mbox_data = array(), $exists = false)
{
$data = array(
- serialize($data['tree']),
+ serialize($data),
(int) $this->skip_deleted,
(int) $mbox_data['UIDVALIDITY'],
(int) $mbox_data['UIDNEXT'],
);
$data = implode('@', $data);
- if ($exists)
+ if ($exists) {
$sql_result = $this->db->query(
"UPDATE ".get_table_name('cache_thread')
." SET data = ?, changed = ".$this->db->now()
." WHERE user_id = ?"
." AND mailbox = ?",
$data, $this->userid, $mailbox);
- else
+ }
+ else {
$sql_result = $this->db->query(
"INSERT INTO ".get_table_name('cache_thread')
." (user_id, mailbox, data, changed)"
." VALUES (?, ?, ?, ".$this->db->now().")",
$this->userid, $mailbox, $data);
+ }
}
@@ -752,10 +760,11 @@
*/
private function validate($mailbox, $index, &$exists = true)
{
- $is_thread = isset($index['tree']);
+ $object = $index['object'];
+ $is_thread = is_a($object, 'rcube_result_thread');
// Get mailbox data (UIDVALIDITY, counters, etc.) for status check
- $mbox_data = $this->imap->mailbox_data($mailbox);
+ $mbox_data = $this->imap->folder_data($mailbox);
// @TODO: Think about skipping validation checks.
// If we could check only every 10 minutes, we would be able to skip
@@ -764,25 +773,29 @@
// and many rcube_imap changes to connect when needed
// Check UIDVALIDITY
- // @TODO: while we're storing message sequence numbers in thread
- // index, should UIDVALIDITY invalidate the thread data?
if ($index['validity'] != $mbox_data['UIDVALIDITY']) {
- // the whole cache (all folders) is invalid
- $this->clear();
- $exists = false;
- return false;
- }
-
- // Folder is empty but cache isn't
- if (empty($mbox_data['EXISTS']) && (!empty($index['seq']) || !empty($index['tree']))) {
$this->clear($mailbox);
$exists = false;
return false;
}
- // Check UIDNEXT
- if ($index['uidnext'] != $mbox_data['UIDNEXT']) {
+ // Folder is empty but cache isn't
+ if (empty($mbox_data['EXISTS'])) {
+ if (!$object->is_empty()) {
+ $this->clear($mailbox);
+ $exists = false;
+ return false;
+ }
+ }
+ // Folder is not empty but cache is
+ else if ($object->is_empty()) {
unset($this->icache[$mailbox][$is_thread ? 'thread' : 'index']);
+ return false;
+ }
+
+ // Validation flag
+ if (!$is_thread && empty($index['valid'])) {
+ unset($this->icache[$mailbox]['index']);
return false;
}
@@ -791,10 +804,23 @@
return false;
}
+ // Check HIGHESTMODSEQ
+ if (!empty($index['modseq']) && !empty($mbox_data['HIGHESTMODSEQ'])
+ && $index['modseq'] == $mbox_data['HIGHESTMODSEQ']
+ ) {
+ return true;
+ }
+
+ // Check UIDNEXT
+ if ($index['uidnext'] != $mbox_data['UIDNEXT']) {
+ unset($this->icache[$mailbox][$is_thread ? 'thread' : 'index']);
+ return false;
+ }
+
// @TODO: find better validity check for threaded index
if ($is_thread) {
// check messages number...
- if ($mbox_data['EXISTS'] != max(array_keys($index['depth']))) {
+ if (!$this->skip_deleted && $mbox_data['EXISTS'] != $object->count_messages()) {
return false;
}
return true;
@@ -803,14 +829,15 @@
// The rest of checks, more expensive
if (!empty($this->skip_deleted)) {
// compare counts if available
- if ($mbox_data['COUNT_UNDELETED'] != null
- && $mbox_data['COUNT_UNDELETED'] != count($index['uid'])) {
+ if (!empty($mbox_data['UNDELETED'])
+ && $mbox_data['UNDELETED']->count() != $object->count()
+ ) {
return false;
}
// compare UID sets
- if ($mbox_data['ALL_UNDELETED'] != null) {
- $uids_new = rcube_imap_generic::uncompressMessageSet($mbox_data['ALL_UNDELETED']);
- $uids_old = $index['uid'];
+ if (!empty($mbox_data['UNDELETED'])) {
+ $uids_new = $mbox_data['UNDELETED']->get();
+ $uids_old = $object->get();
if (count($uids_new) != count($uids_old)) {
return false;
@@ -825,25 +852,203 @@
else {
// get all undeleted messages excluding cached UIDs
$ids = $this->imap->search_once($mailbox, 'ALL UNDELETED NOT UID '.
- rcube_imap_generic::compressMessageSet($index['uid']));
+ rcube_imap_generic::compressMessageSet($object->get()));
- if (!empty($ids)) {
- $index = null; // cache invalid
+ if (!$ids->is_empty()) {
+ return false;
}
}
}
else {
// check messages number...
- if ($mbox_data['EXISTS'] != max($index['seq'])) {
+ if ($mbox_data['EXISTS'] != $object->count()) {
return false;
}
// ... and max UID
- if (max($index['uid']) != $this->imap->id2uid($mbox_data['EXISTS'], $mailbox, true)) {
+ if ($object->max() != $this->imap->id2uid($mbox_data['EXISTS'], $mailbox, true)) {
return false;
}
}
return true;
+ }
+
+
+ /**
+ * Synchronizes the mailbox.
+ *
+ * @param string $mailbox Folder name
+ */
+ function synchronize($mailbox)
+ {
+ // RFC4549: Synchronization Operations for Disconnected IMAP4 Clients
+ // RFC4551: IMAP Extension for Conditional STORE Operation
+ // or Quick Flag Changes Resynchronization
+ // RFC5162: IMAP Extensions for Quick Mailbox Resynchronization
+
+ // @TODO: synchronize with other methods?
+ $qresync = $this->imap->get_capability('QRESYNC');
+ $condstore = $qresync ? true : $this->imap->get_capability('CONDSTORE');
+
+ if (!$qresync && !$condstore) {
+ return;
+ }
+
+ // Get stored index
+ $index = $this->get_index_row($mailbox);
+
+ // database is empty
+ if (empty($index)) {
+ // set the flag that DB was already queried for index
+ // this way we'll be able to skip one SELECT in get_index()
+ $this->icache[$mailbox]['index_queried'] = true;
+ return;
+ }
+
+ $this->icache[$mailbox]['index'] = $index;
+
+ // no last HIGHESTMODSEQ value
+ if (empty($index['modseq'])) {
+ return;
+ }
+
+ if (!$this->imap->check_connection()) {
+ return;
+ }
+
+ // NOTE: make sure the mailbox isn't selected, before
+ // enabling QRESYNC and invoking SELECT
+ if ($this->imap->conn->selected !== null) {
+ $this->imap->conn->close();
+ }
+
+ // Enable QRESYNC
+ $res = $this->imap->conn->enable($qresync ? 'QRESYNC' : 'CONDSTORE');
+ if (!is_array($res)) {
+ return;
+ }
+
+ // Get mailbox data (UIDVALIDITY, HIGHESTMODSEQ, counters, etc.)
+ $mbox_data = $this->imap->folder_data($mailbox);
+
+ if (empty($mbox_data)) {
+ return;
+ }
+
+ // Check UIDVALIDITY
+ if ($index['validity'] != $mbox_data['UIDVALIDITY']) {
+ $this->clear($mailbox);
+ return;
+ }
+
+ // QRESYNC not supported on specified mailbox
+ if (!empty($mbox_data['NOMODSEQ']) || empty($mbox_data['HIGHESTMODSEQ'])) {
+ return;
+ }
+
+ // Nothing new
+ if ($mbox_data['HIGHESTMODSEQ'] == $index['modseq']) {
+ return;
+ }
+
+ // Get known uids
+ $uids = array();
+ $sql_result = $this->db->query(
+ "SELECT uid"
+ ." FROM ".get_table_name('cache_messages')
+ ." WHERE user_id = ?"
+ ." AND mailbox = ?",
+ $this->userid, $mailbox);
+
+ while ($sql_arr = $this->db->fetch_assoc($sql_result)) {
+ $uids[] = $sql_arr['uid'];
+ }
+
+ // No messages in database, nothing to sync
+ if (empty($uids)) {
+ return;
+ }
+
+ // Get modified flags and vanished messages
+ // UID FETCH 1:* (FLAGS) (CHANGEDSINCE 0123456789 VANISHED)
+ $result = $this->imap->conn->fetch($mailbox,
+ !empty($uids) ? $uids : '1:*', true, array('FLAGS'),
+ $index['modseq'], $qresync);
+
+ $invalidated = false;
+
+ if (!empty($result)) {
+ foreach ($result as $id => $msg) {
+ $uid = $msg->uid;
+ // Remove deleted message
+ if ($this->skip_deleted && !empty($msg->flags['DELETED'])) {
+ $this->remove_message($mailbox, $uid);
+
+ if (!$invalidated) {
+ $invalidated = true;
+ // Invalidate thread indexes (?)
+ $this->remove_thread($mailbox);
+ // Invalidate index
+ $index['valid'] = false;
+ }
+ continue;
+ }
+
+ $flags = 0;
+ if (!empty($msg->flags)) {
+ foreach ($this->flags as $idx => $flag)
+ if (!empty($msg->flags[$flag]))
+ $flags += $idx;
+ }
+
+ $this->db->query(
+ "UPDATE ".get_table_name('cache_messages')
+ ." SET flags = ?, changed = ".$this->db->now()
+ ." WHERE user_id = ?"
+ ." AND mailbox = ?"
+ ." AND uid = ?"
+ ." AND flags <> ?",
+ $flags, $this->userid, $mailbox, $uid, $flags);
+ }
+ }
+
+ // Get VANISHED
+ if ($qresync) {
+ $mbox_data = $this->imap->folder_data($mailbox);
+
+ // Removed messages
+ if (!empty($mbox_data['VANISHED'])) {
+ $uids = rcube_imap_generic::uncompressMessageSet($mbox_data['VANISHED']);
+ if (!empty($uids)) {
+ // remove messages from database
+ $this->remove_message($mailbox, $uids);
+
+ // Invalidate thread indexes (?)
+ $this->remove_thread($mailbox);
+ // Invalidate index
+ $index['valid'] = false;
+ }
+ }
+ }
+
+ $sort_field = $index['sort_field'];
+ $sort_order = $index['object']->get_parameters('ORDER');
+ $exists = true;
+
+ // Validate index
+ if (!$this->validate($mailbox, $index, $exists)) {
+ // Update index
+ $data = $this->get_index_data($mailbox, $sort_field, $sort_order, $mbox_data);
+ }
+ else {
+ $data = $index['object'];
+ }
+
+ // update index and/or HIGHESTMODSEQ value
+ $this->add_index_row($mailbox, $sort_field, $data, $mbox_data, $exists);
+
+ // update internal cache for get_index()
+ $this->icache[$mailbox]['index']['object'] = $data;
}
@@ -859,25 +1064,15 @@
$message = $this->db->decode(unserialize($sql_arr['data']));
if ($message) {
- foreach ($this->flag_fields as $field)
- $message->$field = (bool) $sql_arr[$field];
+ $message->flags = array();
+ foreach ($this->flags as $idx => $flag) {
+ if (($sql_arr['flags'] & $idx) == $idx) {
+ $message->flags[$flag] = true;
+ }
+ }
}
return $message;
- }
-
-
- /**
- * Creates 'depth' and 'children' arrays from stored thread 'tree' data.
- */
- private function build_thread_data($data, &$depth, &$children, $level = 0)
- {
- foreach ((array)$data as $key => $val) {
- $children[$key] = !empty($val);
- $depth[$key] = $level;
- if (!empty($val))
- $this->build_thread_data($val, $depth, $children, $level + 1);
- }
}
@@ -888,10 +1083,8 @@
{
// Save current message from internal cache
if ($message = $this->icache['message']) {
- $object = $message['object'];
- // remove body too big (>500kB)
- if ($object->body && strlen($object->body) > 500 * 1024)
- $object->body = null;
+ // clean up some object's data
+ $object = $this->message_object_prepare($message['object']);
// calculate current md5 sum
$md5sum = md5(serialize($object));
@@ -904,4 +1097,51 @@
}
}
+
+ /**
+ * Prepares message object to be stored in database.
+ */
+ private function message_object_prepare($msg)
+ {
+ // Remove body too big (>25kB)
+ if ($msg->body && strlen($msg->body) > 25 * 1024) {
+ unset($msg->body);
+ }
+
+ // Fix mimetype which might be broken by some code when message is displayed
+ // Another solution would be to use object's copy in rcube_message class
+ // to prevent related issues, however I'm not sure which is better
+ if ($msg->mimetype) {
+ list($msg->ctype_primary, $msg->ctype_secondary) = explode('/', $msg->mimetype);
+ }
+
+ if (is_array($msg->structure->parts)) {
+ foreach ($msg->structure->parts as $idx => $part) {
+ $msg->structure->parts[$idx] = $this->message_object_prepare($part);
+ }
+ }
+
+ return $msg;
+ }
+
+
+ /**
+ * Fetches index data from IMAP server
+ */
+ private function get_index_data($mailbox, $sort_field, $sort_order, $mbox_data = array())
+ {
+ if (empty($mbox_data)) {
+ $mbox_data = $this->imap->folder_data($mailbox);
+ }
+
+ if ($mbox_data['EXISTS']) {
+ // fetch sorted sequence numbers
+ $index = $this->imap->index_direct($mailbox, $sort_field, $sort_order);
+ }
+ else {
+ $index = new rcube_result_index($mailbox, '* SORT');
+ }
+
+ return $index;
+ }
}
--
Gitblit v1.9.1