X-Git-Url: https://vcs.fsf.org/?p=squirrelmail.git;a=blobdiff_plain;f=functions%2Fimap_messages.php;h=9107e43cd9de8b1be18aa252efdfe4bd5683a6cd;hp=a8bd46b8c049bba058da852ba2b7990192344ce2;hb=0331a925bde1c018c0c5e5bbee465c93cbeb1569;hpb=47ccfad452e8d345542d09e59112cac317cffed8 diff --git a/functions/imap_messages.php b/functions/imap_messages.php index a8bd46b8..9107e43c 100755 --- a/functions/imap_messages.php +++ b/functions/imap_messages.php @@ -6,7 +6,7 @@ * This implements functions that manipulate messages * NOTE: Quite a few functions in this file are obsolete * - * @copyright © 1999-2006 The SquirrelMail Project Team + * @copyright © 1999-2007 The SquirrelMail Project Team * @license http://opensource.org/licenses/gpl-license.php GNU Public License * @version $Id$ * @package squirrelmail @@ -39,7 +39,7 @@ function sqimap_msgs_list_copy($imap_stream, $id, $mailbox, $handle_errors = tru * @param string $id The list of messages to move * @param string $mailbox The destination to move to * @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 + * @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 */ @@ -66,19 +66,18 @@ function sqimap_msgs_list_move($imap_stream, $id, $mailbox, $handle_errors = tru * @since 1.4.0 */ function sqimap_msgs_list_delete($imap_stream, $mailbox, $id, $bypass_trash=false) { - // FIX ME, remove globals by introducing an associative array with properties + // FIXME, 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; - $bRes = true; if (($move_to_trash == true) && ($bypass_trash != true) && (sqimap_mailbox_exists($imap_stream, $trash_folder) && ($mailbox != $trash_folder)) ) { - $bRes = sqimap_msgs_list_copy ($imap_stream, $id, $trash_folder); - } - if ($bRes) { - return sqimap_toggle_flag($imap_stream, $id, '\\Deleted', true, true); - } else { - return false; + /** + * turn off internal error handling (fourth argument = false) and + * ignore copy to trash errors (allows to delete messages when overquota) + */ + sqimap_msgs_list_copy ($imap_stream, $id, $trash_folder, false); } + return sqimap_toggle_flag($imap_stream, $id, '\\Deleted', true, true); } @@ -119,29 +118,34 @@ function sqimap_toggle_flag($imap_stream, $id, $flag, $set, $handle_errors) { /** * Sort the message list and crunch to be as small as possible * (overflow could happen, so make it small if possible) + * @param array $aUid array with uid's + * @return string $s message set string */ -function sqimap_message_list_squisher($messages_array) { - if( !is_array( $messages_array ) ) { - return $messages_array; - } - - sort($messages_array, SORT_NUMERIC); - $msgs_str = ''; - while ($messages_array) { - $start = array_shift($messages_array); - $end = $start; - while (isset($messages_array[0]) && $messages_array[0] == $end + 1) { - $end = array_shift($messages_array); - } - if ($msgs_str != '') { - $msgs_str .= ','; - } - $msgs_str .= $start; - if ($start != $end) { - $msgs_str .= ':' . $end; +function sqimap_message_list_squisher($aUid) { + if( !is_array( $aUid ) ) { + return $aUid; + } + sort($aUid, SORT_NUMERIC); + + if (count($aUid)) { + $s = ''; + for ($i=0,$iCnt=count($aUid);$i<$iCnt;++$i) { + $iStart = $aUid[$i]; + $iEnd = $iStart; + while ($i<($iCnt-1) && $aUid[$i+1] == $iEnd +1) { + $iEnd = $aUid[$i+1]; + ++$i; + } + if ($s) { + $s .= ','; + } + $s .= $iStart; + if ($iStart != $iEnd) { + $s .= ':' . $iEnd; + } } } - return $msgs_str; + return $s; } @@ -161,12 +165,21 @@ function sqimap_get_sort_order($imap_stream, $sSortField, $reverse, $search='ALL $sSortField = 'REVERSE '.$sSortField; } $query = "SORT ($sSortField) ".strtoupper($default_charset)." $search"; - // FIX ME sqimap_run_command should return the parsed data accessible by $aDATA['SORT'] - $aData = sqimap_run_command ($imap_stream, $query, false, $response, $message, TRUE); + // FIXME sqimap_run_command should return the parsed data accessible by $aDATA['SORT'] + // use sqimap_run_command_list in case of unsollicited responses. If we don't we could loose the SORT response + $aData = sqimap_run_command_list ($imap_stream, $query, false, $response, $message, TRUE); /* fallback to default charset */ - if ($response == 'NO' && strpos($message,'[BADCHARSET]') !== false) { - $query = "SORT ($sSortField) US-ASCII $search"; - $aData = sqimap_run_command ($imap_stream, $query, true, $response, $message, TRUE); + if ($response == 'NO') { + if (strpos($message,'BADCHARSET') !== false || + strpos($message,'character') !== false) { + sqm_trigger_imap_error('SQM_IMAP_BADCHARSET',$query, $response, $message); + $query = "SORT ($sSortField) US-ASCII $search"; + $aData = sqimap_run_command_list ($imap_stream, $query, true, $response, $message, TRUE); + } else { + sqm_trigger_imap_error('SQM_IMAP_ERROR',$query, $response, $message); + } + } else if ($response == 'BAD') { + sqm_trigger_imap_error('SQM_IMAP_NO_SORT',$query, $response, $message); } } @@ -180,7 +193,7 @@ function sqimap_get_sort_order($imap_stream, $sSortField, $reverse, $search='ALL /** * Parses a UID list returned on a SORT or SEARCH request - * @param array $aData imap response + * @param array $aData imap response (retrieved from sqimap_run_command_list) * @param string $sCommand issued imap command (SEARCH or SORT) * @return array $aUid uid list */ @@ -188,8 +201,10 @@ function parseUidList($aData,$sCommand) { $aUid = array(); if (isset($aData) && count($aData)) { for ($i=0,$iCnt=count($aData);$i<$iCnt;++$i) { - if (preg_match("/^\* $sCommand (.+)$/", $aData[$i], $aMatch)) { - $aUid += preg_split("/ /", trim($aMatch[1])); + for ($j=0,$jCnt=count($aData[$i]);$j<$jCnt;++$j) { + if (preg_match("/^\* $sCommand (.+)$/", $aData[$i][$j], $aMatch)) { + $aUid += explode(' ', trim($aMatch[1])); + } } } } @@ -213,6 +228,13 @@ function get_squirrel_sort($imap_stream, $sSortField, $reverse = false, $aUid = $msgs = sqimap_get_small_header_list($imap_stream, $aUid, array(), array($sSortField)); } + + // sqimap_get_small_header (see above) returns fields in lower case, + // but the code below uses all upper case + foreach ($msgs as $k => $v) + if (isset($msgs[$k][strtolower($sSortField)])) + $msgs[$k][strtoupper($sSortField)] = $msgs[$k][strtolower($sSortField)]; + $aUid = array(); $walk = false; switch ($sSortField) { @@ -229,7 +251,7 @@ function get_squirrel_sort($imap_stream, $sSortField, $reverse = false, $aUid = $sEmail = ($addr[SQM_ADDR_HOST]) ? $addr[SQM_ADDR_MAILBOX] . "@".$addr[SQM_ADDR_HOST] : $addr[SQM_ADDR_HOST]; - $v[$f] = ($sPersonal) ? decodeHeader($sPersonal):$sEmail;'),$sSortField); + $v[$f] = ($sPersonal) ? decodeHeader($sPersonal, true, false):$sEmail;'),$sSortField); $walk = true; } // nobreak @@ -237,9 +259,9 @@ function get_squirrel_sort($imap_stream, $sSortField, $reverse = false, $aUid = if(!$walk) { array_walk($msgs, create_function('&$v,&$k,$f', '$v[$f] = (isset($v[$f])) ? $v[$f] : ""; - $v[$f] = strtolower(decodeHeader(trim($v[$f]))); - $v[$f] = (preg_match("/^(vedr|sv|re|aw|\[\w\]):\s*(.*)$/si", $v[$f], $matches)) ? - $matches[2] : $v[$f];'),$sSortField); + $v[$f] = strtolower(decodeHeader(trim($v[$f]), true, false)); + $v[$f] = (preg_match("/^(?:(?:vedr|sv|re|aw|fw|fwd|\[\w\]):\s*)*\s*(.*)$/si", $v[$f], $matches)) ? + $matches[1] : $v[$f];'),$sSortField); $walk = true; } foreach ($msgs as $item) { @@ -286,17 +308,72 @@ function get_squirrel_sort($imap_stream, $sSortField, $reverse = false, $aUid = return $aUid; } - /** - * Returns an indent array for printMessageinfo() - * This represents the amount of indent needed (value), - * for this message number (key) + * Returns an array with each element as a string representing one + * message-thread as returned by the IMAP server. + * @param resource $imap_stream IMAP socket connection + * @param string $search optional search string + * @return array + * @link http://www.ietf.org/internet-drafts/draft-ietf-imapext-sort-13.txt */ +function get_thread_sort($imap_stream, $search='ALL') { + global $sort_by_ref, $default_charset; + if ($sort_by_ref == 1) { + $sort_type = 'REFERENCES'; + } else { + $sort_type = 'ORDEREDSUBJECT'; + } + $query = "THREAD $sort_type ".strtoupper($default_charset)." $search"; + + // TODO use sqimap_run_command_list as we do in get_server_sort() + $sRead = sqimap_run_command ($imap_stream, $query, false, $response, $message, TRUE); + + /* fallback to default charset */ + if ($response == 'NO') { + if (strpos($message,'BADCHARSET') !== false || + strpos($message,'character') !== false) { + sqm_trigger_imap_error('SQM_IMAP_BADCHARSET',$query, $response, $message); + $query = "THREAD $sort_type US-ASCII $search"; + $sRead = sqimap_run_command ($imap_stream, $query, true, $response, $message, TRUE); + } else { + sqm_trigger_imap_error('SQM_IMAP_ERROR',$query, $response, $message); + } + } elseif ($response == 'BAD') { + sqm_trigger_imap_error('SQM_IMAP_NO_THREAD',$query, $response, $message); + } + $sThreadResponse = ''; + if (isset($sRead[0])) { + for ($i=0,$iCnt=count($sRead);$i<$iCnt;++$i) { + if (preg_match("/^\* THREAD (.+)$/", $sRead[$i], $aMatch)) { + $sThreadResponse = trim($aMatch[1]); + break; + } + } + } + unset($sRead); + + if ($response !== 'OK') { + return false; + } + + /* Example response + * S: * THREAD (2)(3 6 (4 23)(44 7 96)) + * -- 2 + * + * -- 3 + * \-- 6 + * |-- 4 + * | \-- 23 + * | + * \-- 44 + * \-- 7 + * \-- 96 + */ /* * Notes for future work: * indent_array should contain: indent_level, parent and flags, - * sibling notes .. + * sibling nodes .. * To achieve that we need to define the following flags: * 0: hasnochildren * 1: haschildren @@ -313,185 +390,68 @@ function get_squirrel_sort($imap_stream, $sSortField, $reverse = false, $aUid = * \-4 par = 3, level = 2, flag = 1 + 2 + 4 = 7 (haschildren, isfirst, islast) * \-5 par = 4, level = 3, flag = 0 + 2 + 4 = 6 (hasnochildren, isfirst, islast) */ -function get_parent_level($thread_new) { - $parent = ''; - $child = ''; - $cutoff = 0; - - /* - * loop through the threads and take unwanted characters out - * of the thread string then chop it up - */ - 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); } @@ -501,33 +461,6 @@ 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 @@ -674,7 +607,7 @@ 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()) { +function parseFetch(&$aResponse,$aMessageList = array()) { for ($j=0,$iCnt=count($aResponse);$j<$iCnt;++$j) { $aMsg = array(); @@ -776,13 +709,14 @@ function parseFetch($aResponse,$aMessageList = array()) { case 'x-priority': $aMsg['x-priority'] = ($value) ? (int) $value{0} : 3; break; case 'priority': case 'importance': + // duplicate code with Rfc822Header.cls:parsePriority() if (!isset($aMsg['x-priority'])) { - $aPrio = split('/\w/',trim($value)); + $aPrio = preg_split('/\s/',trim($value)); $sPrio = strtolower(array_shift($aPrio)); if (is_numeric($sPrio)) { $iPrio = (int) $sPrio; } elseif ( $sPrio == 'non-urgent' || $sPrio == 'low' ) { - $iPrio = 3; + $iPrio = 5; } elseif ( $sPrio == 'urgent' || $sPrio == 'high' ) { $iPrio = 1; } else { @@ -827,6 +761,7 @@ function parseFetch($aResponse,$aMessageList = array()) { $msgi = ''; } $aMessageList[$msgi] = $aMsg; + $aResponse[$j] = NULL; } return $aMessageList; } @@ -957,9 +892,10 @@ function sqimap_parse_address($read, &$i) { * @param resource $imap_stream imap connection * @param integer $id uid of the message * @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 + * @param int $hide Indicates whether or not to hide any errors: 0 = don't hide, 1 = hide (just exit), 2 = hide (return FALSE), 3 = hide (return error string) (OPTIONAL; default don't hide) + * @return mixed Message object or FALSE/error string if error occurred and $hide is set to 2/3 */ -function sqimap_get_message($imap_stream, $id, $mailbox) { +function sqimap_get_message($imap_stream, $id, $mailbox, $hide=0) { // typecast to int to prohibit 1:* msgs sets $id = (int) $id; $flags = array(); @@ -967,17 +903,25 @@ function sqimap_get_message($imap_stream, $id, $mailbox) { if ($read) { if (preg_match('/.+FLAGS\s\((.*)\)\s/AUi',$read[0],$regs)) { if (trim($regs[1])) { - $flags = preg_split('/ /', $regs[1],-1,'PREG_SPLIT_NI_EMPTY'); + $flags = preg_split('/ /', $regs[1],-1,PREG_SPLIT_NO_EMPTY); } } } else { + + if ($hide == 1) exit; + if ($hide == 2) return FALSE; + /* the message was not found, maybe the mailbox was modified? */ - global $sort, $startMessage, $color; + global $sort, $startMessage; + + $errmessage = _("The server couldn't find the message you requested."); + + if ($hide == 3) return $errmessage; + + $errmessage .= '

'._("Most probably your message list was out of date and the message has been moved away or deleted (perhaps by another program accessing the same mailbox)."); - $errmessage = _("The server couldn't find the message you requested.") . - '

'._("Most probably your message list was out of date and the message has been moved away or deleted (perhaps by another program accessing the same mailbox)."); /* this will include a link back to the message list */ - error_message($errmessage, $mailbox, $sort, (int) $startMessage, $color); + error_message($errmessage, $mailbox, $sort, (int) $startMessage); exit; } $bodystructure = implode('',$read); @@ -986,7 +930,39 @@ function sqimap_get_message($imap_stream, $id, $mailbox) { $rfc822_header = new Rfc822Header(); $rfc822_header->parseHeader($read); $msg->rfc822_header = $rfc822_header; + + parse_message_entities($msg, $id, $imap_stream); return $msg; -} + } + -?> +/** + * Recursively parse embedded messages (if any) in the given + * message, building correct rfc822 headers for each one + * + * @param object $msg The message object to scan for attached messages + * NOTE: this is passed by reference! Changes made + * within will affect the caller's copy of $msg! + * @param int $id The top-level message UID on the IMAP server, even + * if the $msg being passed in is only an attached entity + * thereof. + * @param resource $imap_stream A live connection to the IMAP server. + * + * @return void + * + * @since 1.5.2 + * + */ +function parse_message_entities(&$msg, $id, $imap_stream) { + if (!empty($msg->entities)) foreach ($msg->entities as $i => $entity) { + if (is_object($entity) && get_class($entity) == 'Message') { + if (!empty($entity->rfc822_header)) { + $read = sqimap_run_command($imap_stream, "FETCH $id BODY[". $entity->entity_id .".HEADER]", true, $response, $message, TRUE); + $rfc822_header = new Rfc822Header(); + $rfc822_header->parseHeader($read); + $msg->entities[$i]->rfc822_header = $rfc822_header; + } + parse_message_entities($msg->entities[$i], $id, $imap_stream); + } + } +}