| | |
| | | | | |
| | | | 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) | |
| | |
| | | */ |
| | | 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'; |
| | | |
| | |
| | | // 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; |
| | |
| | | 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(); |
| | | } |
| | | } |
| | |
| | | // 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 |
| | |
| | | */ |
| | | 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])) { |
| | |
| | | // 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) |
| | |
| | | $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]); |
| | | } |
| | | } |
| | |
| | | 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']; |
| | | } |
| | |
| | | |
| | | // 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 |
| | | } |
| | | |
| | |
| | | */ |
| | | 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); |
| | | |
| | |
| | | ." AND uid = ?", |
| | | $flags, $msg, $this->userid, $mailbox, (int) $message->uid); |
| | | |
| | | if ($this->db->affected_rows()) |
| | | if ($this->db->affected_rows()) { |
| | | return; |
| | | } |
| | | } |
| | | |
| | | // insert new record |
| | |
| | | // 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(); |
| | | } |
| | | } |
| | | |
| | | |
| | |
| | | // Thread data removed, set flag to skip SELECT query in get_thread() |
| | | $this->icache[$mailbox]['thread_queried'] = true; |
| | | } |
| | | else |
| | | else { |
| | | $this->icache = array(); |
| | | } |
| | | } |
| | | |
| | | |
| | |
| | | $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)); |
| | | } |
| | | |
| | | |
| | |
| | | ); |
| | | $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); |
| | | } |
| | | } |
| | | |
| | | |
| | |
| | | ); |
| | | $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); |
| | | } |
| | | } |
| | | |
| | | |
| | |
| | | $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 |
| | |
| | | |
| | | // 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; |
| | | } |
| | |
| | | // @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; |
| | |
| | | $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; |
| | | } |
| | | } |
| | |
| | | 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) { |
| | |
| | | } |
| | | |
| | | // 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; |
| | |
| | | |
| | | // 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'])) { |
| | |
| | | } |
| | | |
| | | $sort_field = $index['sort_field']; |
| | | $sort_order = $index['object']->getParameters('ORDER'); |
| | | $sort_order = $index['object']->get_parameters('ORDER'); |
| | | $exists = true; |
| | | |
| | | // Validate index |
| | |
| | | |
| | | 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; |
| | |
| | | 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'); |