diff options
author | alecpl <alec@alec.pl> | 2011-09-07 11:07:03 +0000 |
---|---|---|
committer | alecpl <alec@alec.pl> | 2011-09-07 11:07:03 +0000 |
commit | 80152b333ca5d856dcf09f5ca10a9ffd80ba117f (patch) | |
tree | 084aa3c8aabb3d2b1783dbb01170840ccefc0c62 /program/include/rcube_imap_generic.php | |
parent | b104e39f3425faf77cae67101c734fcfc3b0c1e9 (diff) |
- Rewritten messages caching (merged devel-mcache branch):
Indexes are stored in a separate table, so there's no need to store all messages in a folder
Added threads data caching
Flags are stored separately, so flag change doesn't cause DELETE+INSERT, just UPDATE
- Partial QRESYNC support
- Improved FETCH response handling
- Improvements in response tokenization method
Diffstat (limited to 'program/include/rcube_imap_generic.php')
-rw-r--r-- | program/include/rcube_imap_generic.php | 593 |
1 files changed, 374 insertions, 219 deletions
diff --git a/program/include/rcube_imap_generic.php b/program/include/rcube_imap_generic.php index 75acc5a3d..65b20254e 100644 --- a/program/include/rcube_imap_generic.php +++ b/program/include/rcube_imap_generic.php @@ -48,22 +48,20 @@ class rcube_mail_header public $encoding; public $charset; public $ctype; - public $flags; public $timestamp; - public $body_structure; + public $bodystructure; public $internaldate; public $references; public $priority; public $mdn_to; - public $mdn_sent = false; + + public $flags; + public $mdnsent = false; public $seen = false; public $deleted = false; public $answered = false; public $forwarded = false; public $flagged = false; - public $has_children = false; - public $depth = 0; - public $unread_children = 0; public $others = array(); } @@ -84,6 +82,7 @@ class rcube_imap_generic public $errornum; public $result; public $resultcode; + public $selected; public $data = array(); public $flags = array( 'SEEN' => '\\Seen', @@ -96,7 +95,6 @@ class rcube_imap_generic '*' => '\\*', ); - private $selected; private $fp; private $host; private $logged = false; @@ -235,14 +233,14 @@ class rcube_imap_generic return $line; } - function multLine($line, $escape=false) + function multLine($line, $escape = false) { $line = rtrim($line); - if (preg_match('/\{[0-9]+\}$/', $line)) { - $out = ''; + if (preg_match('/\{([0-9]+)\}$/', $line, $m)) { + $out = ''; + $str = substr($line, 0, -strlen($m[0])); + $bytes = $m[1]; - preg_match_all('/(.*)\{([0-9]+)\}$/', $line, $a); - $bytes = $a[2][0]; while (strlen($out) < $bytes) { $line = $this->readBytes($bytes); if ($line === NULL) @@ -250,7 +248,7 @@ class rcube_imap_generic $out .= $line; } - $line = $a[1][0] . ($escape ? $this->escape($out) : $out); + $line = $str . ($escape ? $this->escape($out) : $out); } return $line; @@ -877,12 +875,12 @@ class rcube_imap_generic /** * Executes SELECT command (if mailbox is already not in selected state) * - * @param string $mailbox Mailbox name + * @param string $mailbox Mailbox name + * @param array $qresync_data QRESYNC data (RFC5162) * * @return boolean True on success, false on error - * @access public */ - function select($mailbox) + function select($mailbox, $qresync_data = null) { if (!strlen($mailbox)) { return false; @@ -901,7 +899,21 @@ class rcube_imap_generic } } */ - list($code, $response) = $this->execute('SELECT', array($this->escape($mailbox))); + $params = array($this->escape($mailbox)); + + // QRESYNC data items + // 0. the last known UIDVALIDITY, + // 1. the last known modification sequence, + // 2. the optional set of known UIDs, and + // 3. an optional parenthesized list of known sequence ranges and their + // corresponding UIDs. + if (!empty($qresync_data)) { + if (!empty($qresync_data[2])) + $qresync_data[2] = self::compressMessageSet($qresync_data[2]); + $params[] = array('QRESYNC', $qresync_data); + } + + list($code, $response) = $this->execute('SELECT', $params); if ($code == self::ERROR_OK) { $response = explode("\r\n", $response); @@ -909,11 +921,39 @@ class rcube_imap_generic if (preg_match('/^\* ([0-9]+) (EXISTS|RECENT)$/i', $line, $m)) { $this->data[strtoupper($m[2])] = (int) $m[1]; } - else if (preg_match('/^\* OK \[(UIDNEXT|UIDVALIDITY|UNSEEN) ([0-9]+)\]/i', $line, $match)) { - $this->data[strtoupper($match[1])] = (int) $match[2]; + else if (preg_match('/^\* OK \[/i', $line, $match)) { + $line = substr($line, 6); + if (preg_match('/^(UIDNEXT|UIDVALIDITY|UNSEEN) ([0-9]+)/i', $line, $match)) { + $this->data[strtoupper($match[1])] = (int) $match[2]; + } + else if (preg_match('/^(HIGHESTMODSEQ) ([0-9]+)/i', $line, $match)) { + $this->data[strtoupper($match[1])] = (string) $match[2]; + } + else if (preg_match('/^(NOMODSEQ)/i', $line, $match)) { + $this->data[strtoupper($match[1])] = true; + } + else if (preg_match('/^PERMANENTFLAGS \(([^\)]+)\)/iU', $line, $match)) { + $this->data['PERMANENTFLAGS'] = explode(' ', $match[1]); + } } - else if (preg_match('/^\* OK \[PERMANENTFLAGS \(([^\)]+)\)\]/iU', $line, $match)) { - $this->data['PERMANENTFLAGS'] = explode(' ', $match[1]); + // QRESYNC FETCH response (RFC5162) + else if (preg_match('/^\* ([0-9+]) FETCH/i', $line, $match)) { + $line = substr($line, strlen($match[0])); + $fetch_data = $this->tokenizeResponse($line, 1); + $data = array('id' => $match[1]); + + for ($i=0, $size=count($fetch_data); $i<$size; $i+=2) { + $data[strtolower($fetch_data[$i])] = $fetch_data[$i+1]; + } + + $this->data['QRESYNC'][$data['uid']] = $data; + } + // QRESYNC VANISHED response (RFC5162) + else if (preg_match('/^\* VANISHED [()EARLIER]*/i', $line, $match)) { + $line = substr($line, strlen($match[0])); + $v_data = $this->tokenizeResponse($line, 1); + + $this->data['VANISHED'] = $v_data; } } @@ -935,7 +975,6 @@ class rcube_imap_generic * in RFC3501: UIDNEXT, UIDVALIDITY, RECENT * * @return array Status item-value hash - * @access public * @since 0.5-beta */ function status($mailbox, $items=array()) @@ -971,7 +1010,7 @@ class rcube_imap_generic } for ($i=0, $len=count($items); $i<$len; $i += 2) { - $result[$items[$i]] = (int) $items[$i+1]; + $result[$items[$i]] = $items[$i+1]; } $this->data['STATUS:'.$mailbox] = $result; @@ -989,7 +1028,6 @@ class rcube_imap_generic * @param string $messages Message UIDs to expunge * * @return boolean True on success, False on error - * @access public */ function expunge($mailbox, $messages=NULL) { @@ -1022,7 +1060,6 @@ class rcube_imap_generic * Executes CLOSE command * * @return boolean True on success, False on error - * @access public * @since 0.5 */ function close() @@ -1043,7 +1080,6 @@ class rcube_imap_generic * @param string $mailbox Mailbox name * * @return boolean True on success, False on error - * @access public */ function subscribe($mailbox) { @@ -1059,7 +1095,6 @@ class rcube_imap_generic * @param string $mailbox Mailbox name * * @return boolean True on success, False on error - * @access public */ function unsubscribe($mailbox) { @@ -1075,7 +1110,6 @@ class rcube_imap_generic * @param string $mailbox Mailbox name * * @return boolean True on success, False on error - * @access public */ function deleteFolder($mailbox) { @@ -1091,7 +1125,6 @@ class rcube_imap_generic * @param string $mailbox Mailbox name * * @return boolean True on success, False on error - * @access public */ function clearFolder($mailbox) { @@ -1116,7 +1149,6 @@ class rcube_imap_generic * @param string $mailbox Mailbox name * * @return int Number of messages, False on error - * @access public */ function countMessages($mailbox, $refresh = false) { @@ -1149,7 +1181,6 @@ class rcube_imap_generic * @param string $mailbox Mailbox name * * @return int Number of messages, False on error - * @access public */ function countRecent($mailbox) { @@ -1172,7 +1203,6 @@ class rcube_imap_generic * @param string $mailbox Mailbox name * * @return int Number of messages, False on error - * @access public */ function countUnseen($mailbox) { @@ -1203,7 +1233,6 @@ class rcube_imap_generic * @param array $items Client identification information key/value hash * * @return array Server identification information key/value hash - * @access public * @since 0.6 */ function id($items=array()) @@ -1235,6 +1264,37 @@ class rcube_imap_generic return false; } + /** + * Executes ENABLE command (RFC5161) + * + * @param mixed $extension Extension name to enable (or array of names) + * + * @return array|bool List of enabled extensions, False on error + * @since 0.6 + */ + function enable($extension) + { + if (empty($extension)) + return false; + + if (!$this->hasCapability('ENABLE')) + return false; + + if (!is_array($extension)) + $extension = array($extension); + + list($code, $response) = $this->execute('ENABLE', $extension); + + if ($code == self::ERROR_OK && preg_match('/\* ENABLED /i', $response)) { + $response = substr($response, 10); // remove prefix "* ENABLED " + $result = (array) $this->tokenizeResponse($response); + + return $result; + } + + return false; + } + function sort($mailbox, $field, $add='', $is_uid=FALSE, $encoding = 'US-ASCII') { $field = strtoupper($field); @@ -1472,7 +1532,6 @@ class rcube_imap_generic * @param int $uid Message unique identifier (UID) * * @return int Message sequence identifier - * @access public */ function UID2ID($mailbox, $uid) { @@ -1492,12 +1551,11 @@ class rcube_imap_generic * @param int $uid Message sequence identifier * * @return int Message unique identifier - * @access public */ function ID2UID($mailbox, $id) { if (empty($id) || $id < 0) { - return null; + return null; } if (!$this->select($mailbox)) { @@ -1515,47 +1573,59 @@ class rcube_imap_generic function fetchUIDs($mailbox, $message_set=null) { - if (is_array($message_set)) - $message_set = join(',', $message_set); - else if (empty($message_set)) + if (empty($message_set)) $message_set = '1:*'; return $this->fetchHeaderIndex($mailbox, $message_set, 'UID', false); } - function fetchHeaders($mailbox, $message_set, $uidfetch=false, $bodystr=false, $add='') + /** + * FETCH command (RFC3501) + * + * @param string $mailbox Mailbox name + * @param mixed $message_set Message(s) sequence identifier(s) or UID(s) + * @param bool $is_uid True if $message_set contains UIDs + * @param array $query_items FETCH command data items + * @param string $mod_seq Modification sequence for CHANGEDSINCE (RFC4551) query + * @param bool $vanished Enables VANISHED parameter (RFC5162) for CHANGEDSINCE query + * + * @return array List of rcube_mail_header elements, False on error + * @since 0.6 + */ + function fetch($mailbox, $message_set, $is_uid = false, $query_items = array(), + $mod_seq = null, $vanished = false) { - $result = array(); - if (!$this->select($mailbox)) { return false; } $message_set = $this->compressMessageSet($message_set); + $result = array(); - if ($add) - $add = ' '.trim($add); - - /* FETCH uid, size, flags and headers */ $key = $this->nextTag(); - $request = $key . ($uidfetch ? ' UID' : '') . " FETCH $message_set "; - $request .= "(UID RFC822.SIZE FLAGS INTERNALDATE "; - if ($bodystr) - $request .= "BODYSTRUCTURE "; - $request .= "BODY.PEEK[HEADER.FIELDS (DATE FROM TO SUBJECT CONTENT-TYPE "; - $request .= "CC REPLY-TO LIST-POST DISPOSITION-NOTIFICATION-TO X-PRIORITY".$add.")])"; + $request = $key . ($is_uid ? ' UID' : '') . " FETCH $message_set "; + $request .= "(" . implode(' ', $query_items) . ")"; + + if ($mod_seq !== null && $this->hasCapability('CONDSTORE')) { + $request .= " (CHANGEDSINCE $mod_seq" . ($vanished ? " VANISHED" : '') .")"; + } if (!$this->putLine($request)) { $this->setError(self::ERROR_COMMAND, "Unable to send command: $request"); return false; } + do { $line = $this->readLine(4096); - $line = $this->multLine($line); if (!$line) break; + // Sample reply line: + // * 321 FETCH (UID 2417 RFC822.SIZE 2730 FLAGS (\Seen) + // INTERNALDATE "16-Nov-2008 21:08:46 +0100" BODYSTRUCTURE (...) + // BODY[HEADER.FIELDS ... + if (preg_match('/^\* ([0-9]+) FETCH/', $line, $m)) { $id = intval($m[1]); @@ -1565,101 +1635,112 @@ class rcube_imap_generic $result[$id]->messageID = 'mid:' . $id; $lines = array(); - $ln = 0; + $line = substr($line, strlen($m[0]) + 2); + $ln = 0; - // Sample reply line: - // * 321 FETCH (UID 2417 RFC822.SIZE 2730 FLAGS (\Seen) - // INTERNALDATE "16-Nov-2008 21:08:46 +0100" BODYSTRUCTURE (...) - // BODY[HEADER.FIELDS ... + // get complete entry + while (preg_match('/\{([0-9]+)\}\r\n$/', $line, $m)) { + $bytes = $m[1]; + $out = ''; - if (preg_match('/^\* [0-9]+ FETCH \((.*) BODY/sU', $line, $matches)) { - $str = $matches[1]; - - while (list($name, $value) = $this->tokenizeResponse($str, 2)) { - if ($name == 'UID') { - $result[$id]->uid = intval($value); - } - else if ($name == 'RFC822.SIZE') { - $result[$id]->size = intval($value); - } - else if ($name == 'INTERNALDATE') { - $result[$id]->internaldate = $value; - $result[$id]->date = $value; - $result[$id]->timestamp = $this->StrToTime($value); - } - else if ($name == 'FLAGS') { - $flags_a = $value; - } + while (strlen($out) < $bytes) { + $out = $this->readBytes($bytes); + if ($out === NULL) + break; + $line .= $out; } - // BODYSTRUCTURE - if ($bodystr) { - while (!preg_match('/ BODYSTRUCTURE (.*) BODY\[HEADER.FIELDS/sU', $line, $m)) { - $line2 = $this->readLine(1024); - $line .= $this->multLine($line2, true); - } - $result[$id]->body_structure = $m[1]; - } + $str = $this->readLine(4096); + if ($str === false) + break; + + $line .= $str; + } - // the rest of the result - if (preg_match('/ BODY\[HEADER.FIELDS \(.*?\)\]\s*(.*)$/s', $line, $m)) { - $reslines = explode("\n", trim($m[1], '"')); - // re-parse (see below) - foreach ($reslines as $resln) { - if (ord($resln[0])<=32) { - $lines[$ln] .= (empty($lines[$ln])?'':"\n").trim($resln); - } else { - $lines[++$ln] = trim($resln); + // Tokenize response and assign to object properties + while (list($name, $value) = $this->tokenizeResponse($line, 2)) { + if ($name == 'UID') { + $result[$id]->uid = intval($value); + } + else if ($name == 'RFC822.SIZE') { + $result[$id]->size = intval($value); + } + else if ($name == 'RFC822.TEXT') { + $result[$id]->body = $value; + } + else if ($name == 'INTERNALDATE') { + $result[$id]->internaldate = $value; + $result[$id]->date = $value; + $result[$id]->timestamp = $this->StrToTime($value); + } + else if ($name == 'FLAGS') { + if (!empty($value)) { + foreach ((array)$value as $flag) { + $flag = str_replace('\\', '', $flag); + + switch (strtoupper($flag)) { + case 'SEEN': + $result[$id]->seen = true; + break; + case 'DELETED': + $result[$id]->deleted = true; + break; + case 'ANSWERED': + $result[$id]->answered = true; + break; + case '$FORWARDED': + $result[$id]->forwarded = true; + break; + case '$MDNSENT': + $result[$id]->mdnsent = true; + break; + case 'FLAGGED': + $result[$id]->flagged = true; + break; + default: + $result[$id]->flags[] = $flag; + break; + } } } } - } - - // Start parsing headers. The problem is, some header "lines" take up multiple lines. - // So, we'll read ahead, and if the one we're reading now is a valid header, we'll - // process the previous line. Otherwise, we'll keep adding the strings until we come - // to the next valid header line. - - do { - $line = rtrim($this->readLine(300), "\r\n"); - - // The preg_match below works around communigate imap, which outputs " UID <number>)". - // Without this, the while statement continues on and gets the "FH0 OK completed" message. - // If this loop gets the ending message, then the outer loop does not receive it from radline on line 1249. - // This in causes the if statement on line 1278 to never be true, which causes the headers to end up missing - // If the if statement was changed to pick up the fh0 from this loop, then it causes the outer loop to spin - // An alternative might be: - // if (!preg_match("/:/",$line) && preg_match("/\)$/",$line)) break; - // however, unsure how well this would work with all imap clients. - if (preg_match("/^\s*UID [0-9]+\)$/", $line)) { - break; + else if ($name == 'MODSEQ') { + $result[$id]->modseq = $value[0]; } - - // handle FLAGS reply after headers (AOL, Zimbra?) - if (preg_match('/\s+FLAGS \((.*)\)\)$/', $line, $matches)) { - $flags_a = $this->tokenizeResponse($matches[1]); - break; + else if ($name == 'ENVELOPE') { + $result[$id]->envelope = $value; } - - if (ord($line[0])<=32) { - $lines[$ln] .= (empty($lines[$ln])?'':"\n").trim($line); - } else { - $lines[++$ln] = trim($line); + else if ($name == 'BODYSTRUCTURE' || ($name == 'BODY' && count($value) > 2)) { + if (!is_array($value[0]) && (strtolower($value[0]) == 'message' && strtolower($value[1]) == 'rfc822')) { + $value = array($value); + } + $result[$id]->bodystructure = $value; + } + else if ($name == 'RFC822') { + $result[$id]->body = $value; + } + else if ($name == 'BODY') { + $body = $this->tokenizeResponse($line, 1); + if ($value[0] == 'HEADER.FIELDS') + $headers = $body; + else if (!empty($value)) + $result[$id]->bodypart[$value[0]] = $body; + else + $result[$id]->body = $body; } - // patch from "Maksim Rubis" <siburny@hotmail.com> - } while ($line[0] != ')' && !$this->startsWith($line, $key, true)); - - if (strncmp($line, $key, strlen($key))) { - // process header, fill rcube_mail_header obj. - // initialize - if (is_array($headers)) { - reset($headers); - while (list($k, $bar) = each($headers)) { - $headers[$k] = ''; + } + + // create array with header field:data + if (!empty($headers)) { + $headers = explode("\n", trim($headers)); + foreach ($headers as $hid => $resln) { + if (ord($resln[0]) <= 32) { + $lines[$ln] .= (empty($lines[$ln]) ? '' : "\n") . trim($resln); + } else { + $lines[++$ln] = trim($resln); } } - // create array with header field:data while (list($lines_key, $str) = each($lines)) { list($field, $string) = explode(':', $str, 2); @@ -1723,47 +1804,44 @@ class rcube_imap_generic $result[$id]->others[$field] = $string; } break; - } // end switch () - } // end while () - } - - // process flags - if (!empty($flags_a)) { - foreach ($flags_a as $flag) { - $flag = str_replace('\\', '', $flag); - $result[$id]->flags[] = $flag; - - switch (strtoupper($flag)) { - case 'SEEN': - $result[$id]->seen = true; - break; - case 'DELETED': - $result[$id]->deleted = true; - break; - case 'ANSWERED': - $result[$id]->answered = true; - break; - case '$FORWARDED': - $result[$id]->forwarded = true; - break; - case '$MDNSENT': - $result[$id]->mdn_sent = true; - break; - case 'FLAGGED': - $result[$id]->flagged = true; - break; } } } } + + // VANISHED response (QRESYNC RFC5162) + // Sample: * VANISHED (EARLIER) 300:310,405,411 + + else if (preg_match('/^\* VANISHED [EARLIER]*/i', $line, $match)) { + $line = substr($line, strlen($match[0])); + $v_data = $this->tokenizeResponse($line, 1); + + $this->data['VANISHED'] = $v_data; + } + } while (!$this->startsWith($line, $key, true)); return $result; } + function fetchHeaders($mailbox, $message_set, $is_uid = false, $bodystr = false, $add = '') + { + $query_items = array('UID', 'RFC822.SIZE', 'FLAGS', 'INTERNALDATE'); + if ($bodystr) + $query_items[] = 'BODYSTRUCTURE'; + $query_items[] = 'BODY.PEEK[HEADER.FIELDS (' + . 'DATE FROM TO SUBJECT CONTENT-TYPE CC REPLY-TO LIST-POST DISPOSITION-NOTIFICATION-TO X-PRIORITY' + . ($add ? ' ' . trim($add) : '') + . ')]'; + + $result = $this->fetch($mailbox, $message_set, $is_uid, $query_items); + + return $result; + } + function fetchHeader($mailbox, $id, $uidfetch=false, $bodystr=false, $add='') { - $a = $this->fetchHeaders($mailbox, $id, $uidfetch, $bodystr, $add); + $a = $this->fetchHeaders($mailbox, $id, $uidfetch, $bodystr, $add); if (is_array($a)) { return array_shift($a); } @@ -2043,6 +2121,7 @@ class rcube_imap_generic $params .= 'RETURN (' . implode(' ', $items) . ')'; } if (!empty($criteria)) { + $modseq = stripos($criteria, 'MODSEQ') !== false; $params .= ($params ? ' ' : '') . $criteria; } else { @@ -2054,20 +2133,27 @@ class rcube_imap_generic if ($code == self::ERROR_OK) { // remove prefix... - $response = substr($response, stripos($response, + $response = substr($response, stripos($response, $esearch ? '* ESEARCH' : '* SEARCH') + ($esearch ? 10 : 9)); // ...and unilateral untagged server responses if ($pos = strpos($response, '*')) { $response = rtrim(substr($response, 0, $pos)); } + // remove MODSEQ response + if ($modseq) { + if (preg_match('/\(MODSEQ ([0-9]+)\)$/', $response, $m)) { + $response = substr($response, 0, -strlen($m[0])); + } + } + if ($esearch) { // Skip prefix: ... (TAG "A285") UID ... $this->tokenizeResponse($response, $return_uid ? 2 : 1); $result = array(); for ($i=0; $i<count($items); $i++) { - // If the SEARCH results in no matches, the server MUST NOT + // If the SEARCH returns no matches, the server MUST NOT // include the item result option in the ESEARCH response if ($ret = $this->tokenizeResponse($response, 2)) { list ($name, $value) = $ret; @@ -2116,7 +2202,6 @@ class rcube_imap_generic * * @return array List of mailboxes or hash of options if $status_opts argument * is non-empty. - * @access public */ function listMailboxes($ref, $mailbox, $status_opts=array(), $select_opts=array()) { @@ -2132,7 +2217,6 @@ class rcube_imap_generic * * @return array List of mailboxes or hash of options if $status_opts argument * is non-empty. - * @access public */ function listSubscribed($ref, $mailbox, $status_opts=array()) { @@ -2152,7 +2236,6 @@ class rcube_imap_generic * * @return array List of mailboxes or hash of options if $status_ops argument * is non-empty. - * @access private */ private function _listMailboxes($ref, $mailbox, $subscribed=false, $status_opts=array(), $select_opts=array()) @@ -2231,7 +2314,7 @@ class rcube_imap_generic return false; } - function fetchMIMEHeaders($mailbox, $id, $parts, $mime=true) + function fetchMIMEHeaders($mailbox, $uid, $parts, $mime=true) { if (!$this->select($mailbox)) { return false; @@ -2249,7 +2332,7 @@ class rcube_imap_generic $peeks[] = "BODY.PEEK[$part.$type]"; } - $request = "$key FETCH $id (" . implode(' ', $peeks) . ')'; + $request = "$key UID FETCH $uid (" . implode(' ', $peeks) . ')'; // send request if (!$this->putLine($request)) { @@ -2263,7 +2346,7 @@ class rcube_imap_generic if (preg_match('/BODY\[([0-9\.]+)\.'.$type.'\]/', $line, $matches)) { $idx = $matches[1]; - $result[$idx] = preg_replace('/^(\* '.$id.' FETCH \()?\s*BODY\['.$idx.'\.'.$type.'\]\s+/', '', $line); + $result[$idx] = preg_replace('/^(\* [0-9]+ FETCH \()?\s*BODY\['.$idx.'\.'.$type.'\]\s+/', '', $line); $result[$idx] = trim($result[$idx], '"'); $result[$idx] = rtrim($result[$idx], "\t\r\n\0\x0B"); } @@ -2570,33 +2653,6 @@ class rcube_imap_generic return false; } - function fetchStructureString($mailbox, $id, $is_uid=false) - { - if (!$this->select($mailbox)) { - return false; - } - - $key = $this->nextTag(); - $result = false; - $command = $key . ($is_uid ? ' UID' : '') ." FETCH $id (BODYSTRUCTURE)"; - - if ($this->putLine($command)) { - do { - $line = $this->readLine(5000); - $line = $this->multLine($line, true); - if (!preg_match("/^$key /", $line)) - $result .= $line; - } while (!$this->startsWith($line, $key, true, true)); - - $result = trim(substr($result, strpos($result, 'BODYSTRUCTURE')+13, -1)); - } - else { - $this->setError(self::ERROR_COMMAND, "Unable to send command: $command"); - } - - return $result; - } - function getQuota() { /* @@ -2660,7 +2716,6 @@ class rcube_imap_generic * * @return boolean True on success, False on failure * - * @access public * @since 0.5-beta */ function setACL($mailbox, $user, $acl) @@ -2684,7 +2739,6 @@ class rcube_imap_generic * * @return boolean True on success, False on failure * - * @access public * @since 0.5-beta */ function deleteACL($mailbox, $user) @@ -2702,7 +2756,6 @@ class rcube_imap_generic * @param string $mailbox Mailbox name * * @return array User-rights array on success, NULL on error - * @access public * @since 0.5-beta */ function getACL($mailbox) @@ -2743,7 +2796,6 @@ class rcube_imap_generic * @param string $user User name * * @return array List of user rights - * @access public * @since 0.5-beta */ function listRights($mailbox, $user) @@ -2775,7 +2827,6 @@ class rcube_imap_generic * @param string $mailbox Mailbox name * * @return array MYRIGHTS response on success, NULL on error - * @access public * @since 0.5-beta */ function myRights($mailbox) @@ -2802,7 +2853,6 @@ class rcube_imap_generic * @param array $entries Entry-value array (use NULL value as NIL) * * @return boolean True on success, False on failure - * @access public * @since 0.5-beta */ function setMetadata($mailbox, $entries) @@ -2832,7 +2882,6 @@ class rcube_imap_generic * * @return boolean True on success, False on failure * - * @access public * @since 0.5-beta */ function deleteMetadata($mailbox, $entries) @@ -2862,7 +2911,6 @@ class rcube_imap_generic * * @return array GETMETADATA result on success, NULL on error * - * @access public * @since 0.5-beta */ function getMetadata($mailbox, $entries, $options=array()) @@ -2954,7 +3002,6 @@ class rcube_imap_generic * three elements: entry name, attribute name, value * * @return boolean True on success, False on failure - * @access public * @since 0.5-beta */ function setAnnotation($mailbox, $data) @@ -2986,7 +3033,6 @@ class rcube_imap_generic * * @return boolean True on success, False on failure * - * @access public * @since 0.5-beta */ function deleteAnnotation($mailbox, $data) @@ -3008,7 +3054,6 @@ class rcube_imap_generic * * @return array Annotations result on success, NULL on error * - * @access public * @since 0.5-beta */ function getAnnotation($mailbox, $entries, $attribs) @@ -3093,10 +3138,103 @@ class rcube_imap_generic } /** + * Returns BODYSTRUCTURE for the specified message. + * + * @param string $mailbox Folder name + * @param int $id Message sequence number or UID + * @param bool $is_uid True if $id is an UID + * + * @return array/bool Body structure array or False on error. + * @since 0.6 + */ + function getStructure($mailbox, $id, $is_uid = false) + { + $result = $this->fetch($mailbox, $id, $is_uid, array('BODYSTRUCTURE')); + if (is_array($result)) { + $result = array_shift($result); + return $result->bodystructure; + } + return false; + } + + static function getStructurePartType($structure, $part) + { + $part_a = self::getStructurePartArray($structure, $part); + if (!empty($part_a)) { + if (is_array($part_a[0])) + return 'multipart'; + else if ($part_a[0]) + return $part_a[0]; + } + + return 'other'; + } + + static function getStructurePartEncoding($structure, $part) + { + $part_a = self::getStructurePartArray($structure, $part); + if ($part_a) { + if (!is_array($part_a[0])) + return $part_a[5]; + } + + return ''; + } + + static function getStructurePartCharset($structure, $part) + { + $part_a = self::getStructurePartArray($structure, $part); + if ($part_a) { + if (is_array($part_a[0])) + return ''; + else { + if (is_array($part_a[2])) { + $name = ''; + while (list($key, $val) = each($part_a[2])) + if (strcasecmp($val, 'charset') == 0) + return $part_a[2][$key+1]; + } + } + } + + return ''; + } + + static function getStructurePartArray($a, $part) + { + if (!is_array($a)) { + return false; + } + if (strpos($part, '.') > 0) { + $original_part = $part; + $pos = strpos($part, '.'); + $rest = substr($original_part, $pos+1); + $part = substr($original_part, 0, $pos); + if ((strcasecmp($a[0], 'message') == 0) && (strcasecmp($a[1], 'rfc822') == 0)) { + $a = $a[8]; + } + return self::getStructurePartArray($a[$part-1], $rest); + } + else if ($part>0) { + if (!is_array($a[0]) && (strcasecmp($a[0], 'message') == 0) + && (strcasecmp($a[1], 'rfc822') == 0)) { + $a = $a[8]; + } + if (is_array($a[$part-1])) + return $a[$part-1]; + else + return $a; + } + else if (($part == 0) || (empty($part))) { + return $a; + } + } + + + /** * Creates next command identifier (tag) * * @return string Command identifier - * @access public * @since 0.5-beta */ function nextTag() @@ -3115,7 +3253,6 @@ class rcube_imap_generic * @param int $options Execution options * * @return mixed Response code or list of response code and data - * @access public * @since 0.5-beta */ function execute($command, $arguments=array(), $options=0) @@ -3126,7 +3263,9 @@ class rcube_imap_generic $response = $noresp ? null : ''; if (!empty($arguments)) { - $query .= ' ' . implode(' ', $arguments); + foreach ($arguments as $arg) { + $query .= ' ' . self::r_implode($arg); + } } // Send command @@ -3173,7 +3312,6 @@ class rcube_imap_generic * @param int $num Number of tokens to return * * @return mixed Tokens array or string if $num=1 - * @access public * @since 0.5-beta */ static function tokenizeResponse(&$str, $num=0) @@ -3194,7 +3332,7 @@ class rcube_imap_generic if (!is_numeric(($bytes = substr($str, 1, $epos - 1)))) { // error } - $result[] = substr($str, $epos + 3, $bytes); + $result[] = $bytes ? substr($str, $epos + 3, $bytes) : ''; // Advance the string $str = substr($str, $epos + 3 + $bytes); break; @@ -3223,10 +3361,12 @@ class rcube_imap_generic // Parenthesized list case '(': + case '[': $str = substr($str, 1); $result[] = self::tokenizeResponse($str); break; case ')': + case ']': $str = substr($str, 1); return $result; break; @@ -3243,8 +3383,8 @@ class rcube_imap_generic break; } - // excluded chars: SP, CTL, ) - if (preg_match('/^([^\x00-\x20\x29\x7F]+)/', $str, $m)) { + // excluded chars: SP, CTL, ), [, ] + if (preg_match('/^([^\x00-\x20\x29\x5B\x5D\x7F]+)/', $str, $m)) { $result[] = $m[1] == 'NIL' ? NULL : $m[1]; $str = substr($str, strlen($m[1])); } @@ -3255,6 +3395,23 @@ class rcube_imap_generic return $num == 1 ? $result[0] : $result; } + static function r_implode($element) + { + $string = ''; + + if (is_array($element)) { + reset($element); + while (list($key, $value) = each($element)) { + $string .= ' ' . self::r_implode($value); + } + } + else { + return $element; + } + + return '(' . trim($string) . ')'; + } + private function _xor($string, $string2) { $result = ''; @@ -3348,7 +3505,6 @@ class rcube_imap_generic * * @param boolean $debug New value for the debugging flag. * - * @access public * @since 0.5-stable */ function setDebug($debug, $handler = null) @@ -3362,7 +3518,6 @@ class rcube_imap_generic * * @param string $message Debug mesage text. * - * @access private * @since 0.5-stable */ private function debug($message) |