From bc92ca56ef6c51393d2782b7654eaa162dfc2e10 Mon Sep 17 00:00:00 2001
From: Aleksander Machniak <alec@alec.pl>
Date: Mon, 30 Jul 2012 07:20:56 -0400
Subject: [PATCH] Fixes after default->classic switch
---
program/include/rcube_imap_cache.php | 303 ++++++++++++++++++++++++++++---------------------
1 files changed, 173 insertions(+), 130 deletions(-)
diff --git a/program/include/rcube_imap_cache.php b/program/include/rcube_imap_cache.php
index 58336da..530284a 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) |
@@ -15,9 +18,6 @@
| Author: Thomas Bruederli <roundcube@gmail.com> |
| Author: Aleksander Machniak <alec@alec.pl> |
+-----------------------------------------------------------------------+
-
- $Id$
-
*/
@@ -92,7 +92,7 @@
{
$this->db = $db;
$this->imap = $imap;
- $this->userid = (int)$userid;
+ $this->userid = $userid;
$this->skip_deleted = $skip_deleted;
}
@@ -120,8 +120,9 @@
*/
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';
@@ -134,7 +135,7 @@
// 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->getParameters('ORDER') != $sort_order) {
+ if ($result->get_parameters('ORDER') != $sort_order) {
$result->revert();
}
return $result;
@@ -177,7 +178,7 @@
if ($is_valid) {
$data = $index['object'];
// revert the order if needed
- if ($data->getParameters('ORDER') != $sort_order) {
+ if ($data->get_parameters('ORDER') != $sort_order) {
$data->revert();
}
}
@@ -197,7 +198,7 @@
// 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);
+ $mbox_data = $this->imap->folder_data($mailbox);
$data = $this->get_index_data($mailbox, $sort_field, $sort_order, $mbox_data);
// insert/update
@@ -226,8 +227,9 @@
*/
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])) {
@@ -257,7 +259,7 @@
// 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)
@@ -285,7 +287,7 @@
* @param string $mailbox Folder name
* @param array $msgs Message UIDs
*
- * @return array The list of messages (rcube_mail_header) indexed by UID
+ * @return array The list of messages (rcube_message_header) indexed by UID
*/
function get_messages($mailbox, $msgs = array())
{
@@ -296,7 +298,7 @@
// Fetch messages from cache
$sql_result = $this->db->query(
"SELECT uid, data, flags"
- ." FROM ".get_table_name('cache_messages')
+ ." FROM ".$this->db->table_name('cache_messages')
." WHERE user_id = ?"
." AND mailbox = ?"
." AND uid IN (".$this->db->array2list($msgs, 'integer').")",
@@ -309,10 +311,10 @@
$uid = intval($sql_arr['uid']);
$result[$uid] = $this->build_message($sql_arr);
- // save memory, we don't need message body here (?)
- $result[$uid]->body = null;
-
if (!empty($result[$uid])) {
+ // save memory, we don't need message body here (?)
+ $result[$uid]->body = null;
+
unset($msgs[$uid]);
}
}
@@ -343,20 +345,21 @@
* from IMAP server
* @param bool $no_cache Enables internal cache usage
*
- * @return rcube_mail_header Message data
+ * @return rcube_message_header Message data
*/
function get_message($mailbox, $uid, $update = true, $cache = true)
{
// Check internal cache
- if (($message = $this->icache['message'])
- && $message['mailbox'] == $mailbox && $message['object']->uid == $uid
+ if ($this->icache['message']
+ && $this->icache['message']['mailbox'] == $mailbox
+ && $this->icache['message']['object']->uid == $uid
) {
return $this->icache['message']['object'];
}
$sql_result = $this->db->query(
"SELECT flags, data"
- ." FROM ".get_table_name('cache_messages')
+ ." FROM ".$this->db->table_name('cache_messages')
." WHERE user_id = ?"
." AND mailbox = ?"
." AND uid = ?",
@@ -369,7 +372,7 @@
// Get the message from IMAP server
if (empty($message) && $update) {
- $message = $this->imap->get_headers($uid, $mailbox, true);
+ $message = $this->imap->get_message_headers($uid, $mailbox, true);
// cache will be updated in close(), see below
}
@@ -398,22 +401,25 @@
/**
* Saves the message in cache.
*
- * @param string $mailbox Folder name
- * @param rcube_mail_header $message Message data
- * @param bool $force Skips message in-cache existance check
+ * @param string $mailbox Folder name
+ * @param rcube_message_header $message Message data
+ * @param bool $force Skips message in-cache existance check
*/
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));
$flags = 0;
if (!empty($message->flags)) {
- foreach ($this->flags as $idx => $flag)
- if (!empty($message->flags[$flag]))
+ foreach ($this->flags as $idx => $flag) {
+ if (!empty($message->flags[$flag])) {
$flags += $idx;
+ }
+ }
}
unset($msg->flags);
@@ -421,20 +427,21 @@
// here will work as select, assume row exist if affected_rows=0)
if (!$force) {
$res = $this->db->query(
- "UPDATE ".get_table_name('cache_messages')
+ "UPDATE ".$this->db->table_name('cache_messages')
." SET flags = ?, data = ?, changed = ".$this->db->now()
." WHERE user_id = ?"
." AND mailbox = ?"
." AND 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')
+ "INSERT INTO ".$this->db->table_name('cache_messages')
." (user_id, mailbox, uid, flags, changed, data)"
." VALUES (?, ?, ?, ?, ".$this->db->now().", ?)",
$this->userid, $mailbox, (int) $message->uid, $flags, $msg);
@@ -469,7 +476,7 @@
}
$this->db->query(
- "UPDATE ".get_table_name('cache_messages')
+ "UPDATE ".$this->db->table_name('cache_messages')
." SET changed = ".$this->db->now()
.", flags = flags ".($enabled ? "+ $idx" : "- $idx")
." WHERE user_id = ?"
@@ -490,7 +497,7 @@
{
if (!strlen($mailbox)) {
$this->db->query(
- "DELETE FROM ".get_table_name('cache_messages')
+ "DELETE FROM ".$this->db->table_name('cache_messages')
." WHERE user_id = ?",
$this->userid);
}
@@ -503,13 +510,12 @@
}
$this->db->query(
- "DELETE FROM ".get_table_name('cache_messages')
+ "DELETE FROM ".$this->db->table_name('cache_messages')
." WHERE user_id = ?"
- ." AND mailbox = ".$this->db->quote($mailbox)
+ ." AND mailbox = ?"
.($uids !== null ? " AND uid IN (".$this->db->array2list((array)$uids, 'integer').")" : ""),
- $this->userid);
+ $this->userid, $mailbox);
}
-
}
@@ -524,27 +530,32 @@
// 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)
+ 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) : "")
+ "DELETE FROM ".$this->db->table_name('cache_index')
+ ." WHERE user_id = ?"
+ .(strlen($mailbox) ? " AND mailbox = ".$this->db->quote($mailbox) : ""),
+ $this->userid
);
- else
+ }
+ else {
$this->db->query(
- "UPDATE ".get_table_name('cache_index')
+ "UPDATE ".$this->db->table_name('cache_index')
." SET valid = 0"
- ." WHERE user_id = ".intval($this->userid)
- .(strlen($mailbox) ? " AND mailbox = ".$this->db->quote($mailbox) : "")
+ ." WHERE user_id = ?"
+ .(strlen($mailbox) ? " AND mailbox = ".$this->db->quote($mailbox) : ""),
+ $this->userid
);
+ }
if (strlen($mailbox)) {
unset($this->icache[$mailbox]['index']);
// Index removed, set flag to skip SELECT query in get_index()
$this->icache[$mailbox]['index_queried'] = true;
}
- else
+ else {
$this->icache = array();
+ }
}
@@ -556,9 +567,10 @@
function remove_thread($mailbox = null)
{
$this->db->query(
- "DELETE FROM ".get_table_name('cache_thread')
- ." WHERE user_id = ".intval($this->userid)
- .(strlen($mailbox) ? " AND mailbox = ".$this->db->quote($mailbox) : "")
+ "DELETE FROM ".$this->db->table_name('cache_thread')
+ ." WHERE user_id = ?"
+ .(strlen($mailbox) ? " AND mailbox = ".$this->db->quote($mailbox) : ""),
+ $this->userid
);
if (strlen($mailbox)) {
@@ -566,8 +578,9 @@
// Thread data removed, set flag to skip SELECT query in get_thread()
$this->icache[$mailbox]['thread_queried'] = true;
}
- else
+ else {
$this->icache = array();
+ }
}
@@ -586,6 +599,27 @@
/**
+ * Delete cache entries older than TTL
+ *
+ * @param string $ttl Lifetime of message cache entries
+ */
+ function expunge($ttl)
+ {
+ // get expiration timestamp
+ $ts = get_offset_time($ttl, -1);
+
+ $this->db->query("DELETE FROM ".get_table_name('cache_messages')
+ ." WHERE changed < " . $this->db->fromunixtime($ts));
+
+ $this->db->query("DELETE FROM ".get_table_name('cache_index')
+ ." WHERE changed < " . $this->db->fromunixtime($ts));
+
+ $this->db->query("DELETE FROM ".get_table_name('cache_thread')
+ ." WHERE changed < " . $this->db->fromunixtime($ts));
+ }
+
+
+ /**
* Fetches index data from database
*/
private function get_index_row($mailbox)
@@ -593,7 +627,7 @@
// Get index from DB
$sql_result = $this->db->query(
"SELECT data, valid"
- ." FROM ".get_table_name('cache_index')
+ ." FROM ".$this->db->table_name('cache_index')
." WHERE user_id = ?"
." AND mailbox = ?",
$this->userid, $mailbox);
@@ -630,7 +664,7 @@
// Get thread from DB
$sql_result = $this->db->query(
"SELECT data"
- ." FROM ".get_table_name('cache_thread')
+ ." FROM ".$this->db->table_name('cache_thread')
." WHERE user_id = ?"
." AND mailbox = ?",
$this->userid, $mailbox);
@@ -672,19 +706,21 @@
);
$data = implode('@', $data);
- if ($exists)
+ if ($exists) {
$sql_result = $this->db->query(
- "UPDATE ".get_table_name('cache_index')
+ "UPDATE ".$this->db->table_name('cache_index')
." 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')
+ "INSERT INTO ".$this->db->table_name('cache_index')
." (user_id, mailbox, data, valid, changed)"
." VALUES (?, ?, ?, 1, ".$this->db->now().")",
$this->userid, $mailbox, $data);
+ }
}
@@ -701,19 +737,21 @@
);
$data = implode('@', $data);
- if ($exists)
+ if ($exists) {
$sql_result = $this->db->query(
- "UPDATE ".get_table_name('cache_thread')
+ "UPDATE ".$this->db->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')
+ "INSERT INTO ".$this->db->table_name('cache_thread')
." (user_id, mailbox, data, changed)"
." VALUES (?, ?, ?, ".$this->db->now().")",
$this->userid, $mailbox, $data);
+ }
}
@@ -726,7 +764,7 @@
$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
@@ -743,14 +781,14 @@
// Folder is empty but cache isn't
if (empty($mbox_data['EXISTS'])) {
- if (!$object->isEmpty()) {
+ if (!$object->is_empty()) {
$this->clear($mailbox);
$exists = false;
return false;
}
}
// Folder is not empty but cache is
- else if ($object->isEmpty()) {
+ else if ($object->is_empty()) {
unset($this->icache[$mailbox][$is_thread ? 'thread' : 'index']);
return false;
}
@@ -782,7 +820,7 @@
// @TODO: find better validity check for threaded index
if ($is_thread) {
// check messages number...
- if (!$this->skip_deleted && $mbox_data['EXISTS'] != $object->countMessages()) {
+ if (!$this->skip_deleted && $mbox_data['EXISTS'] != $object->count_messages()) {
return false;
}
return true;
@@ -816,7 +854,7 @@
$ids = $this->imap->search_once($mailbox, 'ALL UNDELETED NOT UID '.
rcube_imap_generic::compressMessageSet($object->get()));
- if (!$ids->isEmpty()) {
+ if (!$ids->is_empty()) {
return false;
}
}
@@ -874,20 +912,23 @@
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();
+ if (!$this->imap->check_connection()) {
+ return;
}
// Enable QRESYNC
$res = $this->imap->conn->enable($qresync ? 'QRESYNC' : 'CONDSTORE');
- if (!is_array($res)) {
+ if ($res === false) {
return;
}
+ // Close mailbox if already selected to get most recent data
+ if ($this->imap->conn->selected == $mailbox) {
+ $this->imap->conn->close();
+ }
+
// Get mailbox data (UIDVALIDITY, HIGHESTMODSEQ, counters, etc.)
- $mbox_data = $this->imap->mailbox_data($mailbox);
+ $mbox_data = $this->imap->folder_data($mailbox);
if (empty($mbox_data)) {
return;
@@ -909,88 +950,85 @@
return;
}
- // Get known uids
- $uids = array();
+ $uids = array();
+ $removed = array();
+
+ // Get known UIDs
$sql_result = $this->db->query(
"SELECT uid"
- ." FROM ".get_table_name('cache_messages')
+ ." FROM ".$this->db->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'];
+ $uids[] = $sql_arr['uid'];
}
- // No messages in database, nothing to sync
- if (empty($uids)) {
- return;
- }
+ // Synchronize messages data
+ if (!empty($uids)) {
+ // Get modified flags and vanished messages
+ // UID FETCH 1:* (FLAGS) (CHANGEDSINCE 0123456789 VANISHED)
+ $result = $this->imap->conn->fetch($mailbox,
+ $uids, true, array('FLAGS'), $index['modseq'], $qresync);
- // 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);
+ if (!empty($result)) {
+ foreach ($result as $id => $msg) {
+ $uid = $msg->uid;
+ // Remove deleted message
+ if ($this->skip_deleted && !empty($msg->flags['DELETED'])) {
+ $removed[] = $uid;
// Invalidate index
$index['valid'] = false;
+ continue;
}
- continue;
- }
- $flags = 0;
- if (!empty($msg->flags)) {
- foreach ($this->flags as $idx => $flag)
- if (!empty($msg->flags[$flag]))
- $flags += $idx;
- }
+ $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);
+ $this->db->query(
+ "UPDATE ".$this->db->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->mailbox_data($mailbox);
+ // VANISHED found?
+ if ($qresync) {
+ $mbox_data = $this->imap->folder_data($mailbox);
- // Removed messages
- if (!empty($mbox_data['VANISHED'])) {
+ // Removed messages found
$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);
+ $removed = array_merge($removed, $uids);
// Invalidate index
$index['valid'] = false;
}
}
+
+ // remove messages from database
+ if (!empty($removed)) {
+ $this->remove_message($mailbox, $removed);
+ }
+ }
+
+ // Invalidate thread index (?)
+ if (!$index['valid']) {
+ $this->remove_thread($mailbox);
}
$sort_field = $index['sort_field'];
- $sort_order = $index['object']->getParameters('ORDER');
+ $sort_order = $index['object']->get_parameters('ORDER');
$exists = true;
// Validate index
@@ -1015,7 +1053,7 @@
*
* @param array $sql_arr Message row data
*
- * @return rcube_mail_header Message object
+ * @return rcube_message_header Message object
*/
private function build_message($sql_arr)
{
@@ -1023,9 +1061,11 @@
if ($message) {
$message->flags = array();
- foreach ($this->flags as $idx => $flag)
- if (($sql_arr['flags'] & $idx) == $idx)
+ foreach ($this->flags as $idx => $flag) {
+ if (($sql_arr['flags'] & $idx) == $idx) {
$message->flags[$flag] = true;
+ }
+ }
}
return $message;
@@ -1087,12 +1127,12 @@
private function get_index_data($mailbox, $sort_field, $sort_order, $mbox_data = array())
{
if (empty($mbox_data)) {
- $mbox_data = $this->imap->mailbox_data($mailbox);
+ $mbox_data = $this->imap->folder_data($mailbox);
}
if ($mbox_data['EXISTS']) {
// fetch sorted sequence numbers
- $index = $this->imap->message_index_direct($mailbox, $sort_field, $sort_order);
+ $index = $this->imap->index_direct($mailbox, $sort_field, $sort_order);
}
else {
$index = new rcube_result_index($mailbox, '* SORT');
@@ -1101,3 +1141,6 @@
return $index;
}
}
+
+// for backward compat.
+class rcube_mail_header extends rcube_message_header { }
--
Gitblit v1.9.1