X-Git-Url: https://vcs.fsf.org/?a=blobdiff_plain;f=functions%2Fimap_messages.php;h=f16b5d2b7ffcb3331b6f00ffc9ba4dbbac802285;hb=202bcbcc2b67c7c153db1b09b608b62beeba0496;hp=0e140e5ad9a8e0c1d60f9e9378c76ab5e4a78f60;hpb=d40a7867988253916e959193b56210243982a89d;p=squirrelmail.git diff --git a/functions/imap_messages.php b/functions/imap_messages.php index 0e140e5a..f16b5d2b 100755 --- a/functions/imap_messages.php +++ b/functions/imap_messages.php @@ -3,12 +3,11 @@ /** * imap_messages.php * - * Copyright (c) 1999-2004 The SquirrelMail Project Team - * Licensed under the GNU GPL. For full terms see the file COPYING. - * * This implements functions that manipulate messages * NOTE: Quite a few functions in this file are obsolete * + * @copyright © 1999-2006 The SquirrelMail Project Team + * @license http://opensource.org/licenses/gpl-license.php GNU Public License * @version $Id$ * @package squirrelmail * @subpackage imap @@ -16,15 +15,16 @@ /** - * copy a set of messages ($id) to another mailbox ($mailbox) + * Copy a set of messages ($id) to another mailbox ($mailbox) * @param int $imap_stream The resource ID for the IMAP socket * @param string $id The list of messages to copy * @param string $mailbox The destination to copy to - * @return void + * @param bool $handle_errors Show error messages in case of a NO, BAD or BYE response + * @return bool If the copy completed without errors */ -function sqimap_msgs_list_copy ($imap_stream, $id, $mailbox) { +function sqimap_msgs_list_copy($imap_stream, $id, $mailbox, $handle_errors = true) { $msgs_id = sqimap_message_list_squisher($id); - $read = sqimap_run_command ($imap_stream, "COPY $msgs_id " . sqimap_encode_mailbox_name($mailbox), true, $response, $message, TRUE); + $read = sqimap_run_command ($imap_stream, "COPY $msgs_id " . sqimap_encode_mailbox_name($mailbox), $handle_errors, $response, $message, TRUE); if ($response == 'OK') { return true; } else { @@ -32,16 +32,23 @@ function sqimap_msgs_list_copy ($imap_stream, $id, $mailbox) { } } + /** - * move a set of messages ($id) to another mailbox. Deletes the originals. + * Move a set of messages ($id) to another mailbox. Deletes the originals. * @param int $imap_stream The resource ID for the IMAP socket * @param string $id The list of messages to move * @param string $mailbox The destination to move to - * @return void + * @param bool $handle_errors Show error messages in case of a NO, BAD or BYE response + * @param string $source_mailbox (since 1.5.1) name of source mailbox. It is used to + * validate that target mailbox != source mailbox. + * @return bool If the move completed without errors */ -function sqimap_msgs_list_move ($imap_stream, $id, $mailbox) { +function sqimap_msgs_list_move($imap_stream, $id, $mailbox, $handle_errors = true, $source_mailbox = false) { + if ($source_mailbox!==false && $source_mailbox==$mailbox) { + return false; + } $msgs_id = sqimap_message_list_squisher($id); - if (sqimap_msgs_list_copy ($imap_stream, $id, $mailbox)) { + if (sqimap_msgs_list_copy ($imap_stream, $id, $mailbox, $handle_errors)) { return sqimap_toggle_flag($imap_stream, $id, '\\Deleted', true, true); } else { return false; @@ -54,10 +61,11 @@ function sqimap_msgs_list_move ($imap_stream, $id, $mailbox) { * @param resource imap connection * @param string $mailbox mailbox, used for checking if it concerns the trash_folder * @param array $id list with uid's - * @param bool $bypass_trash skip copy to trash + * @param bool $bypass_trash (since 1.5.0) skip copy to trash * @return array $aMessageList array with messages containing the new flags and UID @see parseFetch + * @since 1.4.0 */ -function sqimap_msgs_list_delete ($imap_stream, $mailbox, $id, $bypass_trash=false) { +function sqimap_msgs_list_delete($imap_stream, $mailbox, $id, $bypass_trash=false) { // FIX ME, remove globals by introducing an associative array with properties // as 4th argument as replacement for the bypass_trash var global $move_to_trash, $trash_folder; @@ -74,7 +82,6 @@ function sqimap_msgs_list_delete ($imap_stream, $mailbox, $id, $bypass_trash=fal } - /** * Set a flag on the provided uid list * @param resource imap connection @@ -87,54 +94,72 @@ function sqimap_msgs_list_delete ($imap_stream, $mailbox, $id, $bypass_trash=fal function sqimap_toggle_flag($imap_stream, $id, $flag, $set, $handle_errors) { $msgs_id = sqimap_message_list_squisher($id); $set_string = ($set ? '+' : '-'); + + for ($i=0; $i (540) - * [1] => (1386) - * [2] => (1599 759 959 37) - * [3] => (492 1787) - * [4] => ((933)(1891)) - * [5] => (1030 (1497)(845)(1637)) - */ - for ($i=0,$iCnt=count($thread_temp);$i<$iCnt;$i++) { - if ($thread_temp[$i] != ')' && $thread_temp[$i] != '(') { - $thread_new[$k] = $thread_new[$k] . $thread_temp[$i]; - } elseif ($thread_temp[$i] == '(') { - $thread_new[$k] .= $thread_temp[$i]; - $counter++; - } elseif ($thread_temp[$i] == ')') { - if ($counter > 1) { - $thread_new[$k] .= $thread_temp[$i]; - $counter = $counter - 1; - } else { - $thread_new[$k] .= $thread_temp[$i]; - $k++; - $thread_new[$k] = ""; - $counter = $counter - 1; + $l = 0; + $aUidThread = array(); + $aIndent = array(); + $aUidSubThread = array(); + $aDepthStack = array(); + $sUid = ''; + + if ($sThreadResponse) { + for ($i=0,$iCnt = strlen($sThreadResponse);$i<$iCnt;++$i) { + $cChar = $sThreadResponse{$i}; + switch ($cChar) { + case '(': // new sub thread + // correction for a subthread of a thread with no parents in thread + if (!count($aUidSubThread) && $j > 0) { + --$l; + } + $aDepthStack[$j] = $l; + ++$j; + break; + case ')': // close sub thread + if($sUid !== '') { + $aUidSubThread[] = $sUid; + $aIndent[$sUid] = $j + $l - 1; + ++$l; + $sUid = ''; + } + --$j; + if ($j === 0) { + // show message that starts the thread first. + $aUidSubThread = array_reverse($aUidSubThread); + // do not use array_merge because it's extremely slow and is causing timeouts + foreach ($aUidSubThread as $iUid) { + $aUidThread[] = $iUid; + } + $aUidSubThread = array(); + $l = 0; + $aDepthStack = array(); + } else { + $l = $aDepthStack[$j]; + } + break; + case ' ': // new child + if ($sUid !== '') { + $aUidSubThread[] = $sUid; + $aIndent[$sUid] = $j + $l - 1; + ++$l; + $sUid = ''; + } + break; + default: // part of UID + $sUid .= $cChar; + break; } } } - - $thread_new = array_reverse($thread_new); - /* place the threads after each other in one string */ - $thread_list = implode(" ", $thread_new); - $thread_list = str_replace("(", " ", $thread_list); - $thread_list = str_replace(")", " ", $thread_list); - $thread_list = preg_split("/\s/", $thread_list, -1, PREG_SPLIT_NO_EMPTY); - $server_sort_array = $thread_list; - - $indent_array = get_parent_level ($thread_new); - return array($thread_list,$indent_array); + unset($sThreadResponse); + // show newest threads first + $aUidThread = array_reverse($aUidThread); + return array($aUidThread,$aIndent); } @@ -481,6 +456,33 @@ function elapsedTime($start) { return $timepassed; } + +/** + * Normalise the different Priority headers into a uniform value, + * namely that of the X-Priority header (1, 3, 5). Supports: + * Prioirty, X-Priority, Importance. + * X-MS-Mail-Priority is not parsed because it always coincides + * with one of the other headers. + * + * FIXME: DUPLICATE CODE ALERT: + * NOTE: this is actually a duplicate from the function in + * class/mime/Rfc822Header.php. + * @todo obsolate function or use it instead of code block in parseFetch() + */ +function parsePriority($sValue) { + $aValue = split('/\w/',trim($sValue)); + $value = strtolower(array_shift($aValue)); + if ( is_numeric($value) ) { + return $value; + } + if ( $value == 'urgent' || $value == 'high' ) { + return 1; + } elseif ( $value == 'non-urgent' || $value == 'low' ) { + return 5; + } + return 3; +} + /** * Parses a string in an imap response. String starts with " or { which means it * can handle double quoted strings and literal strings @@ -497,29 +499,29 @@ function parseString($read,&$i) { while (true) { $iPos = strpos($read,'"',$iPos); if (!$iPos) break; - if ($iPos && $read{$iPos -1} != '\\') { - $s = substr($read,$i,($iPos-$i)); - $i = $iPos; - break; - } - $iPos++; - if ($iPos > strlen($read)) { - break; - } + if ($iPos && $read{$iPos -1} != '\\') { + $s = substr($read,$i,($iPos-$i)); + $i = $iPos; + break; + } + $iPos++; + if ($iPos > strlen($read)) { + break; + } } } else if ($char == '{') { $lit_cnt = ''; ++$i; $iPos = strpos($read,'}',$i); if ($iPos) { - $lit_cnt = substr($read, $i, $iPos - $i); - $i += strlen($lit_cnt) + 3; /* skip } + \r + \n */ - /* Now read the literal */ - $s = ($lit_cnt ? substr($read,$i,$lit_cnt): ''); - $i += $lit_cnt; - /* temp bugfix (SM 1.5 will have a working clean version) - too much work to implement that version right now */ - --$i; + $lit_cnt = substr($read, $i, $iPos - $i); + $i += strlen($lit_cnt) + 3; /* skip } + \r + \n */ + /* Now read the literal */ + $s = ($lit_cnt ? substr($read,$i,$lit_cnt): ''); + $i += $lit_cnt; + /* temp bugfix (SM 1.5 will have a working clean version) + too much work to implement that version right now */ + --$i; } else { /* should never happen */ $i += 3; /* } + \r + \n */ $s = ''; @@ -531,6 +533,7 @@ function parseString($read,&$i) { return $s; } + /** * Parses a string containing an array from an imap response. String starts with ( and end with ) * @@ -550,20 +553,33 @@ function parseArray($read,&$i) { return false; } } + + /** * Retrieves a list with headers, flags, size or internaldate from the imap server - * @param resource $imap_stream imap connection - * @param array $msg_list array with id's to create a msgs set from - * @param array $aHeaderFields requested header fields - * @param array $aFetchItems requested other fetch items like FLAGS, RFC822.SIZE - * @return array $aMessages associative array with messages. Key is the UID, value is an associative array + * + * WARNING: function is not portable between SquirrelMail 1.2.x, 1.4.x and 1.5.x. + * Output format, third argument and $msg_list array format requirements differ. + * @param stream $imap_stream imap connection + * @param array $msg_list array with id's to create a msgs set from + * @param array $aHeaderFields (since 1.5.0) requested header fields + * @param array $aFetchItems (since 1.5.0) requested other fetch items like FLAGS, RFC822.SIZE + * @return array $aMessages associative array with messages. Key is the UID, value is an associative array + * @since 1.1.3 */ -function sqimap_get_small_header_list ($imap_stream, $msg_list, +function sqimap_get_small_header_list($imap_stream, $msg_list, $aHeaderFields = array('Date', 'To', 'Cc', 'From', 'Subject', 'X-Priority', 'Content-Type'), $aFetchItems = array('FLAGS', 'RFC822.SIZE', 'INTERNALDATE')) { $aMessageList = array(); - $read_list = array(); + + /** + * Catch other priority headers as well + */ + if (in_array('X-Priority',$aHeaderFields,true)) { + $aHeaderFields[] = 'Importance'; + $aHeaderFields[] = 'Priority'; + } $bUidFetch = ! in_array('UID', $aFetchItems, true); @@ -582,7 +598,6 @@ function sqimap_get_small_header_list ($imap_stream, $msg_list, } } else { $msgs_str = '1:*'; - $aId = array(); } /* @@ -605,6 +620,7 @@ function sqimap_get_small_header_list ($imap_stream, $msg_list, return $aMessages; } + /** * Parses a fetch response, currently it can hande FLAGS, HEADERS, RFC822.SIZE, INTERNALDATE and UID * @param array $aResponse Imap response @@ -613,23 +629,24 @@ function sqimap_get_small_header_list ($imap_stream, $msg_list, * @return array $aMessageList associative array with messages. Key is the UID, value is an associative array * @author Marc Groot Koerkamp */ -function parseFetch($aResponse,$aMessageList = array()) { - foreach ($aResponse as $r) { - $msg = array(); - // use unset because we do isset below - $read = implode('',$r); +function parseFetch(&$aResponse,$aMessageList = array()) { + for ($j=0,$iCnt=count($aResponse);$j<$iCnt;++$j) { + $aMsg = array(); + $read = implode('',$aResponse[$j]); + // free up memmory + unset($aResponse[$j]); /* unset does not reindex the array. the for loop is safe */ /* * #idFETCH( */ /* extract the message id */ - $i_space = strpos($read,' ',2); - $id = substr($read,2,$i_space-2); - $msg['ID'] = $id; + $i_space = strpos($read,' ',2);/* position 2ed */ + $id = substr($read,2/* skip "*" */,$i_space -2); + $aMsg['ID'] = $id; $fetch = substr($read,$i_space+1,5); if (!is_numeric($id) && $fetch !== 'FETCH') { - $msg['ERROR'] = $read; // htmlspecialchars should be done just before display. this is backend code + $aMsg['ERROR'] = $read; // htmlspecialchars should be done just before display. this is backend code break; } $i = strpos($read,'(',$i_space+5); @@ -643,6 +660,9 @@ function parseFetch($aResponse,$aMessageList = array()) { $i = strpos($read,' '); $arg = substr($read,0,$i); ++$i; + /* + * use allcaps for imap items and lowcaps for headers as key for the $aMsg array + */ switch ($arg) { case 'UID': @@ -665,7 +685,7 @@ function parseFetch($aResponse,$aMessageList = array()) { $flag = strtolower($flag); $aFlags[$flag] = true; } - $msg['FLAGS'] = $aFlags; + $aMsg['FLAGS'] = $aFlags; break; case 'RFC822.SIZE': $i_pos = strpos($read,' ',$i); @@ -673,85 +693,96 @@ function parseFetch($aResponse,$aMessageList = array()) { $i_pos = strpos($read,')',$i); } if ($i_pos) { - $msg['SIZE'] = substr($read,$i,$i_pos-$i); + $aMsg['SIZE'] = substr($read,$i,$i_pos-$i); $i = $i_pos+1; } else { break 3; } - break; case 'ENVELOPE': - break; // to be implemented, moving imap code out of the nessages class - sqimap_parse_address($read,$i,$msg); - break; // to be implemented, moving imap code out of the nessages class + // sqimap_parse_address($read,$i,$aMsg); + break; // to be implemented, moving imap code out of the Message class case 'BODYSTRUCTURE': - break; + break; // to be implemented, moving imap code out of the Message class case 'INTERNALDATE': - $msg['INTERNALDATE'] = str_replace(' ', ' ',parseString($read,$i)); + $aMsg['INTERNALDATE'] = trim(str_replace(' ', ' ',parseString($read,$i))); break; case 'BODY.PEEK[HEADER.FIELDS': case 'BODY[HEADER.FIELDS': - $i = strpos($read,'{',$i); + $i = strpos($read,'{',$i); // header is always returned as literal because it contain \n characters $header = parseString($read,$i); if ($header === false) break 2; /* First we replace all \r\n by \n, and unfold the header */ $hdr = trim(str_replace(array("\r\n", "\n\t", "\n "),array("\n", ' ', ' '), $header)); - /* Now we can make a new header array with */ - /* each element representing a headerline */ - $hdr = explode("\n" , $hdr); + /* Now we can make a new header array with + each element representing a headerline */ + $aHdr = explode("\n" , $hdr); $aReceived = array(); - foreach ($hdr as $line) { + foreach ($aHdr as $line) { $pos = strpos($line, ':'); if ($pos > 0) { $field = strtolower(substr($line, 0, $pos)); if (!strstr($field,' ')) { /* valid field */ $value = trim(substr($line, $pos+1)); - switch($field) - { - case 'to': $msg['TO'] = $value; break; - case 'cc': $msg['CC'] = $value; break; - case 'from': $msg['FROM'] = $value; break; - case 'date': - $msg['DATE'] = str_replace(' ', ' ', $value); - break; - case 'x-priority': $msg['PRIORITY'] = $value; break; - case 'subject': $msg['SUBJECT'] = $value; break; - case 'content-type': - $type = $value; - if ($pos = strpos($type, ";")) { - $type = substr($type, 0, $pos); - } - $type = explode("/", $type); - if(!is_array($type) || count($type) < 2) { - $msg['TYPE0'] = 'text'; - $msg['TYPE1'] = 'plain'; - } else { - $msg['TYPE0'] = strtolower($type[0]); - $msg['TYPE1'] = strtolower($type[1]); - } - break; - case 'received': - $aReceived[] = $value; - break; - default: break; + switch($field) { + case 'date': + $aMsg['date'] = trim(str_replace(' ', ' ', $value)); + break; + case 'x-priority': $aMsg['x-priority'] = ($value) ? (int) $value{0} : 3; break; + case 'priority': + case 'importance': + if (!isset($aMsg['x-priority'])) { + $aPrio = split('/\w/',trim($value)); + $sPrio = strtolower(array_shift($aPrio)); + if (is_numeric($sPrio)) { + $iPrio = (int) $sPrio; + } elseif ( $sPrio == 'non-urgent' || $sPrio == 'low' ) { + $iPrio = 3; + } elseif ( $sPrio == 'urgent' || $sPrio == 'high' ) { + $iPrio = 1; + } else { + // default is normal priority + $iPrio = 3; + } + $aMsg['x-priority'] = $iPrio; + } + break; + case 'content-type': + $type = $value; + if ($pos = strpos($type, ";")) { + $type = substr($type, 0, $pos); + } + $type = explode("/", $type); + if(!is_array($type) || count($type) < 2) { + $aMsg['content-type'] = array('text','plain'); + } else { + $aMsg['content-type'] = array(strtolower($type[0]),strtolower($type[1])); + } + break; + case 'received': + $aMsg['received'][] = $value; + break; + default: + $aMsg[$field] = $value; + break; } } } } - if (count($aReceived)) { - $msg['RECEIVED'] = $aReceived; - } break; default: ++$i; break; } } - $msgi ="$unique_id"; - $msg['UID'] = $unique_id; - - $aMessageList[$msgi] = $msg; - ++$msgi; + if (!empty($unique_id)) { + $msgi = "$unique_id"; + $aMsg['UID'] = $unique_id; + } else { + $msgi = ''; + } + $aMessageList[$msgi] = $aMsg; + $aResponse[$j] = NULL; } return $aMessageList; } @@ -822,7 +853,7 @@ function sqimap_parse_envelope($read, &$i, &$msg) { if (count($arg_a) > 9) { $d = strtr($arg_a[0], array(' ' => ' ')); $d = explode(' ', $d); - if (!$arg_a[1]) $arg_1[1] = ''; + if (!$arg_a[1]) $arg_a[1] = ''; $msg['DATE'] = $d; /* argument 1: date */ $msg['SUBJECT'] = $arg_a[1]; /* argument 2: subject */ $msg['FROM'] = is_array($arg_a[2]) ? $arg_a[2][0] : ''; /* argument 3: from */ @@ -836,6 +867,7 @@ function sqimap_parse_envelope($read, &$i, &$msg) { } } + /** * Work in process * @private @@ -873,6 +905,7 @@ function sqimap_parse_address($read, &$i) { return $adr; } + /** * Returns a message array with all the information about a message. * See the documentation folder for more information about this array. @@ -882,11 +915,11 @@ function sqimap_parse_address($read, &$i) { * @param string $mailbox used for error handling, can be removed because we should return an error code and generate the message elsewhere * @return Message Message object */ -function sqimap_get_message ($imap_stream, $id, $mailbox) { +function sqimap_get_message($imap_stream, $id, $mailbox) { // typecast to int to prohibit 1:* msgs sets $id = (int) $id; $flags = array(); - $read = sqimap_run_command ($imap_stream, "FETCH $id (FLAGS BODYSTRUCTURE)", true, $response, $message, TRUE); + $read = sqimap_run_command($imap_stream, "FETCH $id (FLAGS BODYSTRUCTURE)", true, $response, $message, TRUE); if ($read) { if (preg_match('/.+FLAGS\s\((.*)\)\s/AUi',$read[0],$regs)) { if (trim($regs[1])) { @@ -905,46 +938,11 @@ function sqimap_get_message ($imap_stream, $id, $mailbox) { } $bodystructure = implode('',$read); $msg = mime_structure($bodystructure,$flags); - $read = sqimap_run_command ($imap_stream, "FETCH $id BODY[HEADER]", true, $response, $message, TRUE); + $read = sqimap_run_command($imap_stream, "FETCH $id BODY[HEADER]", true, $response, $message, TRUE); $rfc822_header = new Rfc822Header(); $rfc822_header->parseHeader($read); $msg->rfc822_header = $rfc822_header; return $msg; } -/** -* Depricated !!!!!!! DO NOT USE THIS, use sqimap_msgs_list_copy instead -*/ -function sqimap_messages_copy ($imap_stream, $start, $end, $mailbox) { - $read = sqimap_run_command ($imap_stream, "COPY $start:$end " . sqimap_encode_mailbox_name($mailbox), true, $response, $message, TRUE); -} - -/** -* Depricated !!!!!!! DO NOT USE THIS, use sqimap_msgs_list_delete instead -*/ -function sqimap_messages_delete ($imap_stream, $start, $end, $mailbox, $bypass_trash=false) { - global $move_to_trash, $trash_folder, $auto_expunge; - - if (($move_to_trash == true) && ($bypass_trash != true) && - (sqimap_mailbox_exists($imap_stream, $trash_folder) && ($mailbox != $trash_folder))) { - sqimap_messages_copy ($imap_stream, $start, $end, $trash_folder); - } - sqimap_messages_flag ($imap_stream, $start, $end, "Deleted", true); -} - -/** -* Depricated !!!!!!! DO NOT USE THIS, use sqimap_toggle_flag instead -* Set a flag on the provided uid list -* @param resource imap connection -*/ -function sqimap_messages_flag ($imap_stream, $start, $end, $flag, $handle_errors) { - $read = sqimap_run_command ($imap_stream, "STORE $start:$end +FLAGS (\\$flag)", $handle_errors, $response, $message, TRUE); -} - -/** @deprecated */ -function sqimap_get_small_header ($imap_stream, $id, $sent) { - $res = sqimap_get_small_header_list($imap_stream, $id, $sent); - return $res[0]; -} - ?>