Thomas Bruederli
2013-10-21 f06aa8058b7e32ba32d4551074b6e0b8a300f751
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)                |
@@ -120,8 +123,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 +138,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 +181,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 +201,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 +230,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 +262,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)
@@ -309,10 +314,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]);
            }
        }
@@ -348,8 +353,9 @@
    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'];
        }
@@ -369,7 +375,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
        }
@@ -404,16 +410,19 @@
     */
    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);
@@ -428,8 +437,9 @@
                    ." AND uid = ?",
                $flags, $msg, $this->userid, $mailbox, (int) $message->uid);
            if ($this->db->affected_rows())
            if ($this->db->affected_rows()) {
                return;
            }
        }
        // insert new record
@@ -524,27 +534,30 @@
        // 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) : "")
            );
        else
        }
        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)) {
            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();
        }
    }
@@ -566,8 +579,9 @@
            // Thread data removed, set flag to skip SELECT query in get_thread()
            $this->icache[$mailbox]['thread_queried'] = true;
        }
        else
        else {
            $this->icache = array();
        }
    }
@@ -582,6 +596,27 @@
        $this->remove_index($mailbox, true);
        $this->remove_thread($mailbox);
        $this->remove_message($mailbox, $uids);
    }
    /**
     * 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));
    }
@@ -672,19 +707,21 @@
        );
        $data = implode('@', $data);
        if ($exists)
        if ($exists) {
            $sql_result = $this->db->query(
                "UPDATE ".get_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')
                ." (user_id, mailbox, data, valid, changed)"
                ." VALUES (?, ?, ?, 1, ".$this->db->now().")",
                $this->userid, $mailbox, $data);
        }
    }
@@ -701,19 +738,21 @@
        );
        $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);
        }
    }
@@ -726,7 +765,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 +782,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 +821,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 +855,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,6 +913,10 @@
            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) {
@@ -887,7 +930,7 @@
        }
        // 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;
@@ -972,7 +1015,7 @@
        // Get VANISHED
        if ($qresync) {
            $mbox_data = $this->imap->mailbox_data($mailbox);
            $mbox_data = $this->imap->folder_data($mailbox);
            // Removed messages
            if (!empty($mbox_data['VANISHED'])) {
@@ -990,7 +1033,7 @@
        }
        $sort_field = $index['sort_field'];
        $sort_order = $index['object']->getParameters('ORDER');
        $sort_order = $index['object']->get_parameters('ORDER');
        $exists     = true;
        // Validate index
@@ -1023,9 +1066,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 +1132,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');