| | |
| | | */ |
| | | class rcube_imap_cache |
| | | { |
| | | const MODE_INDEX = 1; |
| | | const MODE_MESSAGE = 2; |
| | | |
| | | /** |
| | | * Instance of rcube_imap |
| | | * |
| | |
| | | private $ttl; |
| | | |
| | | /** |
| | | * Maximum cached message size |
| | | * |
| | | * @var int |
| | | */ |
| | | private $threshold; |
| | | |
| | | /** |
| | | * Internal (in-memory) cache |
| | | * |
| | | * @var array |
| | |
| | | private $icache = array(); |
| | | |
| | | private $skip_deleted = false; |
| | | private $mode; |
| | | |
| | | /** |
| | | * List of known flags. Thanks to this we can handle flag changes |
| | |
| | | ); |
| | | |
| | | |
| | | |
| | | /** |
| | | * Object constructor. |
| | | * |
| | |
| | | * @param int $userid User identifier |
| | | * @param bool $skip_deleted skip_deleted flag |
| | | * @param string $ttl Expiration time of memcache/apc items |
| | | * |
| | | * @param int $threshold Maximum cached message size |
| | | */ |
| | | function __construct($db, $imap, $userid, $skip_deleted, $ttl=0) |
| | | function __construct($db, $imap, $userid, $skip_deleted, $ttl=0, $threshold=0) |
| | | { |
| | | // convert ttl string to seconds |
| | | $ttl = get_offset_sec($ttl); |
| | |
| | | $this->userid = $userid; |
| | | $this->skip_deleted = $skip_deleted; |
| | | $this->ttl = $ttl; |
| | | $this->threshold = $threshold; |
| | | |
| | | // cache all possible information by default |
| | | $this->mode = self::MODE_INDEX | self::MODE_MESSAGE; |
| | | } |
| | | |
| | | |
| | |
| | | { |
| | | $this->save_icache(); |
| | | $this->icache = null; |
| | | } |
| | | |
| | | |
| | | /** |
| | | * Set cache mode |
| | | * |
| | | * @param int $mode Cache mode |
| | | */ |
| | | public function set_mode($mode) |
| | | { |
| | | $this->mode = $mode; |
| | | } |
| | | |
| | | |
| | |
| | | return array(); |
| | | } |
| | | |
| | | // Fetch messages from cache |
| | | $sql_result = $this->db->query( |
| | | "SELECT uid, data, flags" |
| | | ." FROM ".$this->db->table_name('cache_messages') |
| | | ." WHERE user_id = ?" |
| | | ." AND mailbox = ?" |
| | | ." AND uid IN (".$this->db->array2list($msgs, 'integer').")", |
| | | $this->userid, $mailbox); |
| | | |
| | | $msgs = array_flip($msgs); |
| | | $result = array(); |
| | | |
| | | while ($sql_arr = $this->db->fetch_assoc($sql_result)) { |
| | | $uid = intval($sql_arr['uid']); |
| | | $result[$uid] = $this->build_message($sql_arr); |
| | | if ($this->mode & self::MODE_MESSAGE) { |
| | | // Fetch messages from cache |
| | | $sql_result = $this->db->query( |
| | | "SELECT uid, data, flags" |
| | | ." FROM ".$this->db->table_name('cache_messages') |
| | | ." WHERE user_id = ?" |
| | | ." AND mailbox = ?" |
| | | ." AND uid IN (".$this->db->array2list($msgs, 'integer').")", |
| | | $this->userid, $mailbox); |
| | | |
| | | if (!empty($result[$uid])) { |
| | | // save memory, we don't need message body here (?) |
| | | $result[$uid]->body = null; |
| | | while ($sql_arr = $this->db->fetch_assoc($sql_result)) { |
| | | $uid = intval($sql_arr['uid']); |
| | | $result[$uid] = $this->build_message($sql_arr); |
| | | |
| | | unset($msgs[$uid]); |
| | | if (!empty($result[$uid])) { |
| | | // save memory, we don't need message body here (?) |
| | | $result[$uid]->body = null; |
| | | |
| | | unset($msgs[$uid]); |
| | | } |
| | | } |
| | | } |
| | | |
| | |
| | | // Insert to DB and add to result list |
| | | if (!empty($messages)) { |
| | | foreach ($messages as $msg) { |
| | | $this->add_message($mailbox, $msg, !array_key_exists($msg->uid, $result)); |
| | | if ($this->mode & self::MODE_MESSAGE) { |
| | | $this->add_message($mailbox, $msg, !array_key_exists($msg->uid, $result)); |
| | | } |
| | | |
| | | $result[$msg->uid] = $msg; |
| | | } |
| | | } |
| | |
| | | return $this->icache['__message']['object']; |
| | | } |
| | | |
| | | $sql_result = $this->db->query( |
| | | "SELECT flags, data" |
| | | ." FROM ".$this->db->table_name('cache_messages') |
| | | ." WHERE user_id = ?" |
| | | ." AND mailbox = ?" |
| | | ." AND uid = ?", |
| | | $this->userid, $mailbox, (int)$uid); |
| | | if ($this->mode & self::MODE_MESSAGE) { |
| | | $sql_result = $this->db->query( |
| | | "SELECT flags, data" |
| | | ." FROM ".$this->db->table_name('cache_messages') |
| | | ." WHERE user_id = ?" |
| | | ." AND mailbox = ?" |
| | | ." AND uid = ?", |
| | | $this->userid, $mailbox, (int)$uid); |
| | | |
| | | if ($sql_arr = $this->db->fetch_assoc($sql_result)) { |
| | | $message = $this->build_message($sql_arr); |
| | | $found = true; |
| | | if ($sql_arr = $this->db->fetch_assoc($sql_result)) { |
| | | $message = $this->build_message($sql_arr); |
| | | $found = true; |
| | | } |
| | | } |
| | | |
| | | // Get the message from IMAP server |
| | | if (empty($message) && $update) { |
| | | $message = $this->imap->get_message_headers($uid, $mailbox, true); |
| | | // cache will be updated in close(), see below |
| | | } |
| | | |
| | | if (!($this->mode & self::MODE_MESSAGE)) { |
| | | return $message; |
| | | } |
| | | |
| | | // Save the message in internal cache, will be written to DB in close() |
| | |
| | | function add_message($mailbox, $message, $force = false) |
| | | { |
| | | if (!is_object($message) || empty($message->uid)) { |
| | | return; |
| | | } |
| | | |
| | | if (!($this->mode & self::MODE_MESSAGE)) { |
| | | return; |
| | | } |
| | | |
| | |
| | | return; |
| | | } |
| | | |
| | | if (!($this->mode & self::MODE_MESSAGE)) { |
| | | return; |
| | | } |
| | | |
| | | $flag = strtoupper($flag); |
| | | $idx = (int) array_search($flag, $this->flags); |
| | | $uids = (array) $uids; |
| | |
| | | */ |
| | | function remove_message($mailbox = null, $uids = null) |
| | | { |
| | | if (!($this->mode & self::MODE_MESSAGE)) { |
| | | return; |
| | | } |
| | | |
| | | if (!strlen($mailbox)) { |
| | | $this->db->query( |
| | | "DELETE FROM ".$this->db->table_name('cache_messages') |
| | |
| | | $db = $rcube->get_dbh(); |
| | | |
| | | $db->query("DELETE FROM ".$db->table_name('cache_messages') |
| | | ." WHERE expired < " . $db->now()); |
| | | ." WHERE expires < " . $db->now()); |
| | | |
| | | $db->query("DELETE FROM ".$db->table_name('cache_index') |
| | | ." WHERE expired < " . $db->now()); |
| | | ." WHERE expires < " . $db->now()); |
| | | |
| | | $db->query("DELETE FROM ".$db->table_name('cache_thread') |
| | | ." WHERE expired < " . $db->now()); |
| | | ." WHERE expires < " . $db->now()); |
| | | } |
| | | |
| | | |
| | |
| | | $removed = array(); |
| | | |
| | | // Get known UIDs |
| | | $sql_result = $this->db->query( |
| | | "SELECT uid" |
| | | ." FROM ".$this->db->table_name('cache_messages') |
| | | ." WHERE user_id = ?" |
| | | ." AND mailbox = ?", |
| | | $this->userid, $mailbox); |
| | | if ($this->mode & self::MODE_MESSAGE) { |
| | | $sql_result = $this->db->query( |
| | | "SELECT uid" |
| | | ." 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']; |
| | | while ($sql_arr = $this->db->fetch_assoc($sql_result)) { |
| | | $uids[] = $sql_arr['uid']; |
| | | } |
| | | } |
| | | |
| | | // Synchronize messages data |
| | |
| | | // Save current message from internal cache |
| | | if ($message = $this->icache['__message']) { |
| | | // clean up some object's data |
| | | $object = $this->message_object_prepare($message['object']); |
| | | $this->message_object_prepare($message['object']); |
| | | |
| | | // calculate current md5 sum |
| | | $md5sum = md5(serialize($object)); |
| | | $md5sum = md5(serialize($message['object'])); |
| | | |
| | | if ($message['md5sum'] != $md5sum) { |
| | | $this->add_message($message['mailbox'], $object, !$message['exists']); |
| | | $this->add_message($message['mailbox'], $message['object'], !$message['exists']); |
| | | } |
| | | |
| | | $this->icache['__message']['md5sum'] = $md5sum; |
| | |
| | | |
| | | /** |
| | | * Prepares message object to be stored in database. |
| | | * |
| | | * @param rcube_message_header|rcube_message_part |
| | | */ |
| | | private function message_object_prepare($msg) |
| | | private function message_object_prepare(&$msg, &$size = 0) |
| | | { |
| | | // Remove body too big (>25kB) |
| | | if ($msg->body && strlen($msg->body) > 25 * 1024) { |
| | | unset($msg->body); |
| | | // Remove body too big |
| | | if ($msg->body && ($length = strlen($msg->body))) { |
| | | $size += $length; |
| | | |
| | | if ($size > $this->threshold * 1024) { |
| | | $size -= $length; |
| | | unset($msg->body); |
| | | } |
| | | } |
| | | |
| | | // Fix mimetype which might be broken by some code when message is displayed |
| | |
| | | list($msg->ctype_primary, $msg->ctype_secondary) = explode('/', $msg->mimetype); |
| | | } |
| | | |
| | | unset($msg->replaces); |
| | | |
| | | if (is_array($msg->structure->parts)) { |
| | | foreach ($msg->structure->parts as $idx => $part) { |
| | | $msg->structure->parts[$idx] = $this->message_object_prepare($part); |
| | | foreach ($msg->structure->parts as $part) { |
| | | $this->message_object_prepare($part, $size); |
| | | } |
| | | } |
| | | |
| | | return $msg; |
| | | if (is_array($msg->parts)) { |
| | | foreach ($msg->parts as $part) { |
| | | $this->message_object_prepare($part, $size); |
| | | } |
| | | } |
| | | } |
| | | |
| | | |