X-Git-Url: https://vcs.fsf.org/?p=squirrelmail.git;a=blobdiff_plain;f=functions%2Fimap_messages.php;h=9107e43cd9de8b1be18aa252efdfe4bd5683a6cd;hp=931ca0369834fd3fcfaa1ff708b2feef90d21983;hb=0331a925bde1c018c0c5e5bbee465c93cbeb1569;hpb=7c3e08025fc6ea6685d381953cb08e03f361eece diff --git a/functions/imap_messages.php b/functions/imap_messages.php index 931ca036..9107e43c 100755 --- a/functions/imap_messages.php +++ b/functions/imap_messages.php @@ -3,475 +3,522 @@ /** * imap_messages.php * - * Copyright (c) 1999-2003 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 * - * $Id$ + * @copyright © 1999-2007 The SquirrelMail Project Team + * @license http://opensource.org/licenses/gpl-license.php GNU Public License + * @version $Id$ + * @package squirrelmail + * @subpackage imap */ -/* NOTE: quite some functions in this file are not used anymore. */ - -/* Copies specified messages to specified folder */ -/* obsolete */ -function sqimap_messages_copy ($imap_stream, $start, $end, $mailbox) { - global $uid_support; - $read = sqimap_run_command ($imap_stream, "COPY $start:$end " . sqimap_encode_mailbox_name($mailbox), true, $response, $message, $uid_support); -} - -/** -* copy a range of messages ($id) to another mailbox ($mailbox) -*/ -function sqimap_msgs_list_copy ($imap_stream, $id, $mailbox) { - global $uid_support; - $msgs_id = sqimap_message_list_squisher($id); - $read = sqimap_run_command ($imap_stream, "COPY $msgs_id " . sqimap_encode_mailbox_name($mailbox), true, $response, $message, $uid_support); -} /** -* move a range of messages ($id) to another mailbox. Deletes the originals. -*/ -function sqimap_msgs_list_move ($imap_stream, $id, $mailbox) { - global $uid_support; + * 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 + * @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, $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, $uid_support); - $read = sqimap_run_command ($imap_stream, "STORE $msgs_id +FLAGS (\\Deleted)", true, $response,$message, $uid_support); + $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 { + return false; + } } -/* Deletes specified messages and moves them to trash if possible */ -/* obsolete */ -function sqimap_messages_delete ($imap_stream, $start, $end, $mailbox) { - global $move_to_trash, $trash_folder, $auto_expunge, $uid_support; - - if (($move_to_trash == true) && (sqimap_mailbox_exists($imap_stream, $trash_folder) && ($mailbox != $trash_folder))) { - sqimap_messages_copy ($imap_stream, $start, $end, $trash_folder); +/** + * 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 + * @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, $handle_errors = true, $source_mailbox = false) { + if ($source_mailbox!==false && $source_mailbox==$mailbox) { + return false; } - sqimap_messages_flag ($imap_stream, $start, $end, "Deleted", true); -} - -function sqimap_msgs_list_delete ($imap_stream, $mailbox, $id) { - global $move_to_trash, $trash_folder, $uid_support; $msgs_id = sqimap_message_list_squisher($id); - if (($move_to_trash == true) && (sqimap_mailbox_exists($imap_stream, $trash_folder) && ($mailbox != $trash_folder))) { - $read = sqimap_run_command ($imap_stream, "COPY $msgs_id " . sqimap_encode_mailbox_name($trash_folder), true, $response, $message, $uid_support); + if (sqimap_msgs_list_copy ($imap_stream, $id, $mailbox, $handle_errors)) { + return sqimap_toggle_flag($imap_stream, $id, '\\Deleted', true, true); + } else { + return false; } - $read = sqimap_run_command ($imap_stream, "STORE $msgs_id +FLAGS (\\Deleted)", true, $response, $message, $uid_support); } -/* Sets the specified messages with specified flag */ -function sqimap_messages_flag ($imap_stream, $start, $end, $flag, $handle_errors) { - global $uid_support; - $read = sqimap_run_command ($imap_stream, "STORE $start:$end +FLAGS (\\$flag)", $handle_errors, $response, $message, $uid_support); +/** + * Deletes a message and move it to trash or expunge the 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 (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) { + // 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; + if (($move_to_trash == true) && ($bypass_trash != true) && + (sqimap_mailbox_exists($imap_stream, $trash_folder) && ($mailbox != $trash_folder)) ) { + /** + * 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); } -/* Remove specified flag from specified messages */ -function sqimap_messages_remove_flag ($imap_stream, $start, $end, $flag, $handle_errors) { - global $uid_support; - $read = sqimap_run_command ($imap_stream, "STORE $start:$end -FLAGS (\\$flag)", $handle_errors, $response, $message, $uid_support); -} +/** + * Set a flag on the provided uid list + * @param resource imap connection + * @param array $id list with uid's + * @param string $flag Flags to set/unset flags can be i.e.'\Seen', '\Answered', '\Seen \Answered' + * @param bool $set add (true) or remove (false) the provided flag + * @param bool $handle_errors Show error messages in case of a NO, BAD or BYE response + * @return array $aMessageList array with messages containing the new flags and UID @see parseFetch + */ function sqimap_toggle_flag($imap_stream, $id, $flag, $set, $handle_errors) { - global $uid_support; $msgs_id = sqimap_message_list_squisher($id); $set_string = ($set ? '+' : '-'); - $read = sqimap_run_command ($imap_stream, "STORE $msgs_id ".$set_string."FLAGS ($flag)", $handle_errors, $response, $message, $uid_support); -} -// obsolete? -function sqimap_get_small_header ($imap_stream, $id, $sent) { - $res = sqimap_get_small_header_list($imap_stream, $id, $sent); - return $res[0]; -} - -/* - * Sort the message list and crunch to be as small as possible - * (overflow could happen, so make it small if possible) - */ -function sqimap_message_list_squisher($messages_array) { - if( !is_array( $messages_array ) ) { - return $messages_array; + for ($i=0; $i 'DATE', - 1=> 'DATE', - 2=> 'FROM', - 3=> 'FROM', - 4=> 'SUBJECT', - 5=> 'SUBJECT'); - if ($internal_date_sort == true) { - $sort_on[0] = 'ARRIVAL'; - $sort_on[1] = 'ARRIVAL'; - } - if ($sent_folder == $mailbox) { - $sort_on[2] = 'TO'; - $sort_on[3] = 'TO'; - } - if (!empty($sort_on[$sort])) { - $query = "SORT ($sort_on[$sort]) ".strtoupper($default_charset).' ALL'; - $sort_test = sqimap_run_command ($imap_stream, $query, true, $response, $message, $uid_support); - } - if (isset($sort_test[0])) { - for ($i=0,$iCnt=count($sort_test);$i<$iCnt;++$i) { - if (preg_match("/^\* SORT (.+)$/", $sort_test[$i], $regs)) { - $server_sort_array = preg_split("/ /", trim($regs[1])); - break; } - } - } - if ($sort == 0 || $sort == 2 || $sort == 4) { - $server_sort_array = array_reverse($server_sort_array); - } - if (!preg_match("/OK/", $response)) { - $server_sort_array = 'no'; } - sqsession_register($server_sort_array, 'server_sort_array'); - return $server_sort_array; + return $s; } -function sqimap_get_php_sort_order ($imap_stream, $mbxresponse) { - global $uid_support; - - if (sqsession_is_registered('php_sort_array')) { - sqsession_unregister('php_sort_array'); - } - - $php_sort_array = array(); +/** + * Retrieves an array with a sorted uid list. Sorting is done on the imap server + * @link http://www.ietf.org/internet-drafts/draft-ietf-imapext-sort-17.txt + * @param resource $imap_stream IMAP socket connection + * @param string $sSortField Field to sort on + * @param bool $reverse Reverse order search + * @return array $id sorted uid list + */ +function sqimap_get_sort_order($imap_stream, $sSortField, $reverse, $search='ALL') { + global $default_charset; - if ($uid_support) { - if (isset($mbxresponse['UIDNEXT']) && $mbxresponse['UIDNEXT']) { - $uidnext = $mbxresponse['UIDNEXT']-1; - } else { - $uidnext = '*'; + if ($sSortField) { + if ($reverse) { + $sSortField = 'REVERSE '.$sSortField; } - $query = "SEARCH UID 1:$uidnext"; - $uids = sqimap_run_command ($imap_stream, $query, true, $response, $message, true); - if (isset($uids[0])) { - if (preg_match("/^\* SEARCH (.+)$/", $uids[0], $regs)) { - $php_sort_array = preg_split("/ /", trim($regs[1])); + $query = "SORT ($sSortField) ".strtoupper($default_charset)." $search"; + // 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') { + 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); } - if (!preg_match("/OK/", $response)) { - $php_sort_array = 'no'; - } + } + + if ($response == 'OK') { + return parseUidList($aData,'SORT'); } else { - $qty = $mbxresponse['EXISTS']; - $php_sort_array = range(1, $qty); + return false; } - sqsession_register($php_sort_array, 'php_sort_array'); - return $php_sort_array; } -/* returns an indent array for printMessageinfo() - this represents the amount of indent needed (value) - for this message number (key) -*/ - -function get_parent_level ($imap_stream) { - global $sort_by_ref, $default_charset, $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 $v) + if (isset($msgs[$k][strtolower($sSortField)])) + $msgs[$k][strtoupper($sSortField)] = $msgs[$k][strtolower($sSortField)]; + + $aUid = array(); + $walk = false; + switch ($sSortField) { + // natcasesort section + case 'FROM': + case 'TO': + case 'CC': + if(!$walk) { + array_walk($msgs, create_function('&$v,&$k,$f', + '$v[$f] = (isset($v[$f])) ? $v[$f] : ""; + $addr = reset(parseRFC822Address($v[$f],1)); + $sPersonal = (isset($addr[SQM_ADDR_PERSONAL]) && $addr[SQM_ADDR_PERSONAL]) ? + $addr[SQM_ADDR_PERSONAL] : ""; + $sEmail = ($addr[SQM_ADDR_HOST]) ? + $addr[SQM_ADDR_MAILBOX] . "@".$addr[SQM_ADDR_HOST] : + $addr[SQM_ADDR_HOST]; + $v[$f] = ($sPersonal) ? decodeHeader($sPersonal, true, false):$sEmail;'),$sSortField); + $walk = true; + } + // nobreak + case 'SUBJECT': + if(!$walk) { + array_walk($msgs, create_function('&$v,&$k,$f', + '$v[$f] = (isset($v[$f])) ? $v[$f] : ""; + $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) { + $aUid[$item['UID']] = $item[$sSortField]; + } + natcasesort($aUid); + $aUid = array_keys($aUid); + if ($reverse) { + $aUid = array_reverse($aUid); + } + break; + // \natcasesort section + // sort_numeric section + case 'DATE': + case 'INTERNALDATE': + if(!$walk) { + array_walk($msgs, create_function('&$v,$k,$f', + '$v[$f] = (isset($v[$f])) ? $v[$f] : ""; + $v[$f] = getTimeStamp(explode(" ",$v[$f]));'),$sSortField); + $walk = true; + } + // nobreak; + case 'RFC822.SIZE': + if(!$walk) { + // redefine $sSortField to maintain the same namespace between + // server-side sorting and SquirrelMail sorting + $sSortField = 'SIZE'; + } + foreach ($msgs as $item) { + $aUid[$item['UID']] = (isset($item[$sSortField])) ? $item[$sSortField] : 0; + } + if ($reverse) { + arsort($aUid,SORT_NUMERIC); + } else { + asort($aUid, SORT_NUMERIC); + } + $aUid = array_keys($aUid); + break; + // \sort_numeric section + case 'UID': + $aUid = array_reverse($msgs); + break; + } + return $aUid; +} -/* returns an array with each element as a string - representing one message thread as returned by - the IMAP server -*/ +/** + * 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; -function get_thread_sort ($imap_stream) { - global $thread_new, $sort_by_ref, $default_charset, $server_sort_array, $uid_support; - if (sqsession_is_registered('thread_new')) { - sqsession_unregister('thread_new'); - } - if (sqsession_is_registered('server_sort_array')) { - sqsession_unregister('server_sort_array'); - } - $thread_temp = array (); if ($sort_by_ref == 1) { $sort_type = 'REFERENCES'; - } - else { + } else { $sort_type = 'ORDEREDSUBJECT'; } - $query = "THREAD $sort_type ".strtoupper($default_charset)." ALL"; - $thread_test = sqimap_run_command ($imap_stream, $query, true, $response, $message, $uid_support); - if (isset($thread_test[0])) { - for ($i=0,$iCnt=count($thread_test);$i<$iCnt;++$i) { - if (preg_match("/^\* THREAD (.+)$/", $thread_test[$i], $regs)) { - $thread_list = trim($regs[1]); - break; - } - } - } - else { - $thread_list = ""; - } - if (!preg_match("/OK/", $response)) { - $server_sort_array = 'no'; - return $server_sort_array; + $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; + } + } } - if (isset($thread_list)) { - $thread_temp = preg_split("//", $thread_list, -1, PREG_SPLIT_NO_EMPTY); + unset($sRead); + + if ($response !== 'OK') { + return false; } - $char_count = count($thread_temp); - $counter = 0; - $thread_new = array(); + + /* 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 nodes .. + * To achieve that we need to define the following flags: + * 0: hasnochildren + * 1: haschildren + * 2: is first + * 4: is last + * a node has sibling nodes if it's not the last node + * a node has no sibling nodes if it's the last node + * By using binary comparations we can store the flag in one var + * + * example: + * -1 par = 0, level = 0, flag = 1 + 2 + 4 = 7 (haschildren, isfirst, islast) + * \-2 par = 1, level = 1, flag = 0 + 2 = 2 (hasnochildren, isfirst) + * |-3 par = 1, level = 1, flag = 1 + 4 = 5 (haschildren, islast) + * \-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) + */ + + $j = 0; $k = 0; - $thread_new[0] = ""; - for ($i=0;$i<$char_count;$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; + $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 = ''; } - else { - $thread_new[$k] .= $thread_temp[$i]; - $k++; - $thread_new[$k] = ""; - $counter = $counter - 1; + --$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; } + } } - sqsession_register($thread_new, 'thread_new'); - $thread_new = array_reverse($thread_new); - $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; - sqsession_register($server_sort_array, 'server_sort_array'); - return $thread_list; + unset($sThreadResponse); + // show newest threads first + $aUidThread = array_reverse($aUidThread); + return array($aUidThread,$aIndent); } function elapsedTime($start) { - $stop = gettimeofday(); - $timepassed = 1000000 * ($stop['sec'] - $start['sec']) + $stop['usec'] - $start['usec']; - return $timepassed; + $stop = gettimeofday(); + $timepassed = 1000000 * ($stop['sec'] - $start['sec']) + $stop['usec'] - $start['usec']; + return $timepassed; } -// only used in sqimap_get_small_header_list +/** + * Parses a string in an imap response. String starts with " or { which means it + * can handle double quoted strings and literal strings + * + * @param string $read imap response + * @param integer $i (reference) offset in string + * @return string $s parsed string without the double quotes or literal count + */ function parseString($read,&$i) { $char = $read{$i}; $s = ''; if ($char == '"') { - $iPos = ++$i; - while (true) { - $iPos = strpos($read,'"',$iPos); - if (!$iPos) break; - if ($iPos && $read{$iPos -1} != '\\') { + $iPos = ++$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)) { + } + $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; - } else { /* should never happen */ + $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 = ''; - } + } } else { - return false; + return false; } ++$i; return $s; } -// only used in sqimap_get_small_header_list + +/** + * Parses a string containing an array from an imap response. String starts with ( and end with ) + * + * @param string $read imap response + * @param integer $i (reference) offset in string + * @return array $a + */ function parseArray($read,&$i) { $i = strpos($read,'(',$i); $i_pos = strpos($read,')',$i); @@ -485,63 +532,100 @@ function parseArray($read,&$i) { } } -function sqimap_get_small_header_list ($imap_stream, $msg_list, $show_num=false) { - global $squirrelmail_language, $color, $data_dir, $username, $imap_server_type; - global $uid_support, $allow_server_sort; + +/** + * Retrieves a list with headers, flags, size or internaldate from the imap server + * + * 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, + $aHeaderFields = array('Date', 'To', 'Cc', 'From', 'Subject', 'X-Priority', 'Content-Type'), + $aFetchItems = array('FLAGS', 'RFC822.SIZE', 'INTERNALDATE')) { + + $aMessageList = array(); + + /** + * Catch other priority headers as well + */ + if (in_array('X-Priority',$aHeaderFields,true)) { + $aHeaderFields[] = 'Importance'; + $aHeaderFields[] = 'Priority'; + } + + $bUidFetch = ! in_array('UID', $aFetchItems, true); + /* Get the small headers for each message in $msg_list */ - $maxmsg = sizeof($msg_list); - if ($show_num != '999999') { + if ($msg_list !== NULL) { $msgs_str = sqimap_message_list_squisher($msg_list); - } else { + /* + * We need to return the data in the same order as the caller supplied + * in $msg_list, but IMAP servers are free to return responses in + * whatever order they wish... So we need to re-sort manually + */ + if ($bUidFetch) { + for ($i = 0; $i < sizeof($msg_list); $i++) { + $aMessageList["$msg_list[$i]"] = array(); + } + } + } else { $msgs_str = '1:*'; } - $messages = array(); - $read_list = array(); /* - * We need to return the data in the same order as the caller supplied - * in $msg_list, but IMAP servers are free to return responses in - * whatever order they wish... So we need to re-sort manually + * Create the query */ - for ($i = 0; $i < sizeof($msg_list); $i++) { - $messages["$msg_list[$i]"] = array(); - } - $internaldate = getPref($data_dir, $username, 'internal_date_sort'); - if ($internaldate) { - $query = "FETCH $msgs_str (FLAGS UID RFC822.SIZE INTERNALDATE BODY.PEEK[HEADER.FIELDS (Date To Cc From Subject X-Priority Content-Type)])"; - } else { - $query = "FETCH $msgs_str (FLAGS UID RFC822.SIZE BODY.PEEK[HEADER.FIELDS (Date To Cc From Subject X-Priority Content-Type)])"; + $sFetchItems = ''; + $query = "FETCH $msgs_str ("; + if (count($aFetchItems)) { + $sFetchItems = implode(' ',$aFetchItems); } - $read_list = sqimap_run_command_list ($imap_stream, $query, true, $response, $message, $uid_support); - $i = 0; - - foreach ($read_list as $r) { - $subject = _("(no subject)"); - $from = _("Unknown Sender"); - $priority = 0; - $messageid = '<>'; - $cc = $to = $date = $type[0] = $type[1] = $inrepto = ''; - $flag_seen = $flag_answered = $flag_deleted = $flag_flagged = false; - - $read = implode('',$r); - - /* + if (count($aHeaderFields)) { + $sHeaderFields = implode(' ',$aHeaderFields); + $sFetchItems .= ' BODY.PEEK[HEADER.FIELDS ('.$sHeaderFields.')]'; + } + $query .= trim($sFetchItems) . ')'; + $aResponse = sqimap_run_command_list ($imap_stream, $query, true, $response, $message, $bUidFetch); + $aMessages = parseFetch($aResponse,$aMessageList); + array_reverse($aMessages); + return $aMessages; +} + + +/** + * Parses a fetch response, currently it can hande FLAGS, HEADERS, RFC822.SIZE, INTERNALDATE and UID + * @param array $aResponse Imap response + * @param array $aMessageList Placeholder array for results. The keys of the + * placeholder array should be the UID so we can reconstruct the order. + * @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()) { + 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); + $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') { - set_up_language($squirrelmail_language); - echo '
' . - _("ERROR : Could not complete request.") . - '
' . - _("Unknown response from IMAP server: ") . ' 1.' . - htmlspecialchars($read) . "
\n"; - break; + $aMsg['ERROR'] = $read; // htmlspecialchars should be done just before display. this is backend code + break; } $i = strpos($read,'(',$i_space+5); $read = substr($read,$i+1); @@ -554,6 +638,9 @@ function sqimap_get_small_header_list ($imap_stream, $msg_list, $show_num=false) $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': @@ -571,17 +658,12 @@ function sqimap_get_small_header_list ($imap_stream, $msg_list, $show_num=false) case 'FLAGS': $flags = parseArray($read,$i); if (!$flags) break 3; + $aFlags = array(); foreach ($flags as $flag) { $flag = strtolower($flag); - switch ($flag) - { - case '\\seen': $flag_seen = true; break; - case '\\answered': $flag_answered = true; break; - case '\\deleted': $flag_deleted = true; break; - case '\\flagged': $flag_flagged = true; break; - default: break; - } + $aFlags[$flag] = true; } + $aMsg['FLAGS'] = $aFlags; break; case 'RFC822.SIZE': $i_pos = strpos($read,' ',$i); @@ -589,64 +671,79 @@ function sqimap_get_small_header_list ($imap_stream, $msg_list, $show_num=false) $i_pos = strpos($read,')',$i); } if ($i_pos) { - $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': + // sqimap_parse_address($read,$i,$aMsg); + break; // to be implemented, moving imap code out of the Message class + case 'BODYSTRUCTURE': + break; // to be implemented, moving imap code out of the Message class case 'INTERNALDATE': - $date = parseString($read,$i); - //if ($tmpdate === false) break 3; - //$tmpdate = str_replace(' ',' ',$tmpdate); - //$tmpdate = explode(' ',$tmpdate); - //$date = str_replace('-',' ',$tmpdate[0]) . " " . - // $tmpdate[1] . ' ' . $tmpdate[2]; + $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 3; - /* First we unfold the header */ - $hdr = trim(str_replace(array("\r\n\t", "\r\n "),array('', ''), $header)); - /* Now we can make a new header array with */ - /* each element representing a headerline */ - $hdr = explode("\r\n" , $hdr); - foreach ($hdr as $line) { + 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 */ + $aHdr = explode("\n" , $hdr); + $aReceived = array(); + 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': $to = $value; break; - case 'cc': $cc = $value; break; - case 'from': $from = $value; break; - case 'date': $date = $value; break; - case 'x-priority': $priority = $value; break; - case 'subject': - $subject = $value; - if ($subject == "") { - $subject = _("(no subject)"); - } - break; - case 'content-type': - $type = $value; - if ($pos = strpos($type, ";")) { - $type = substr($type, 0, $pos); - } - $type = explode("/", $type); - if(!is_array($type)) { - $type[0] = 'text'; - } - if (!isset($type[1])) { - $type[1] = ''; - } - 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': + // duplicate code with Rfc822Header.cls:parsePriority() + if (!isset($aMsg['x-priority'])) { + $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 = 5; + } 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; } } } @@ -657,181 +754,215 @@ function sqimap_get_small_header_list ($imap_stream, $msg_list, $show_num=false) break; } } - if (isset($date)) { - $date = str_replace(' ', ' ', $date); - $tmpdate = explode(' ', trim($date)); - } else { - $tmpdate = $date = array('', '', '', '', '', ''); - } - if ($uid_support) { - $msgi ="$unique_id"; - $messages[$msgi]['ID'] = $unique_id; - } else { - $msgi = "$id"; - $messages[$msgi]['ID'] = $id; - } - $messages[$msgi]['TIME_STAMP'] = getTimeStamp($tmpdate); - $messages[$msgi]['DATE_STRING'] = getDateString($messages[$msgi]['TIME_STAMP']); - $messages[$msgi]['FROM'] = $from; //parseAddress($from); - $messages[$msgi]['SUBJECT'] = $subject; -// if (handleAsSent($mailbox)) { - $messages[$msgi]['TO'] = $to; //parseAddress($to); -// } - $messages[$msgi]['PRIORITY'] = $priority; - $messages[$msgi]['CC'] = $cc; //parseAddress($cc); - $messages[$msgi]['SIZE'] = $size; - $messages[$msgi]['TYPE0'] = $type[0]; - $messages[$msgi]['FLAG_DELETED'] = $flag_deleted; - $messages[$msgi]['FLAG_ANSWERED'] = $flag_answered; - $messages[$msgi]['FLAG_SEEN'] = $flag_seen; - $messages[$msgi]['FLAG_FLAGGED'] = $flag_flagged; - - /* non server sort stuff */ - if (!$allow_server_sort) { - $from = parseAddress($from); - if ($from[0][1]) { - $from = decodeHeader($from[0][1]); - } else { - $from = $from[0][0]; - } - $messages[$msgi]['FROM-SORT'] = $from; - $subject_sort = strtolower(decodeHeader($subject)); - if (preg_match("/^(vedr|sv|re|aw):\s*(.*)$/si", $subject_sort, $matches)){ - $messages[$msgi]['SUBJECT-SORT'] = $matches[2]; - } else { - $messages[$msgi]['SUBJECT-SORT'] = $subject_sort; - } + if (!empty($unique_id)) { + $msgi = "$unique_id"; + $aMsg['UID'] = $unique_id; + } else { + $msgi = ''; + } + $aMessageList[$msgi] = $aMsg; + $aResponse[$j] = NULL; + } + return $aMessageList; +} + +/** + * Work in process + * @private + * @author Marc Groot Koerkamp + */ +function sqimap_parse_envelope($read, &$i, &$msg) { + $arg_no = 0; + $arg_a = array(); + ++$i; + for ($cnt = strlen($read); ($i < $cnt) && ($read{$i} != ')'); ++$i) { + $char = strtoupper($read{$i}); + switch ($char) { + case '{': + case '"': + $arg_a[] = parseString($read,$i); + ++$arg_no; + break; + case 'N': + /* probably NIL argument */ + if (strtoupper(substr($read, $i, 3)) == 'NIL') { + $arg_a[] = ''; + ++$arg_no; + $i += 2; + } + break; + case '(': + /* Address structure (with group support) + * Note: Group support is useless on SMTP connections + * because the protocol doesn't support it + */ + $addr_a = array(); + $group = ''; + $a=0; + for (; $i < $cnt && $read{$i} != ')'; ++$i) { + if ($read{$i} == '(') { + $addr = sqimap_parse_address($read, $i); + if (($addr[3] == '') && ($addr[2] != '')) { + /* start of group */ + $group = $addr[2]; + $group_addr = $addr; + $j = $a; + } else if ($group && ($addr[3] == '') && ($addr[2] == '')) { + /* end group */ + if ($a == ($j+1)) { /* no group members */ + $group_addr[4] = $group; + $group_addr[2] = ''; + $group_addr[0] = "$group: Undisclosed recipients;"; + $addr_a[] = $group_addr; + $group =''; + } + } else { + $addr[4] = $group; + $addr_a[] = $addr; + } + ++$a; + } + } + $arg_a[] = $addr_a; + break; + default: break; } - ++$msgi; } - array_reverse($messages); - $new_messages = array(); - foreach ($messages as $i =>$message) { - $new_messages[] = $message; + + if (count($arg_a) > 9) { + $d = strtr($arg_a[0], array(' ' => ' ')); + $d = explode(' ', $d); + 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 */ + $msg['SENDER'] = is_array($arg_a[3]) ? $arg_a[3][0] : ''; /* argument 4: sender */ + $msg['REPLY-TO'] = is_array($arg_a[4]) ? $arg_a[4][0] : ''; /* argument 5: reply-to */ + $msg['TO'] = $arg_a[5]; /* argument 6: to */ + $msg['CC'] = $arg_a[6]; /* argument 7: cc */ + $msg['BCC'] = $arg_a[7]; /* argument 8: bcc */ + $msg['IN-REPLY-TO'] = $arg_a[8]; /* argument 9: in-reply-to */ + $msg['MESSAGE-ID'] = $arg_a[9]; /* argument 10: message-id */ } - return $new_messages; } -// obsolete? -function sqimap_get_headerfield($imap_stream, $field) { - global $uid_support; - $sid = sqimap_session_id(false); - - $results = array(); - $read_list = array(); - - $query = "FETCH 1:* (UID BODY.PEEK[HEADER.FIELDS ($field)])"; - $readin_list = sqimap_run_command_list ($imap_stream, $query, true, $response, $message, $uid_support); - $i = 0; - - foreach ($readin_list as $r) { - $r = implode('',$r); - /* first we unfold the header */ - $r = str_replace(array("\r\n\t","\r\n\s"),array('',''),$r); - /* - * now we can make a new header array with each element representing - * a headerline - */ - $r = explode("\r\n" , $r); - if (!$uid_support) { - if (!preg_match("/^\\*\s+([0-9]+)\s+FETCH/iAU",$r[0], $regs)) { - set_up_language($squirrelmail_language); - echo '
' . - _("ERROR : Could not complete request.") . - '
' . - _("Unknown response from IMAP server: ") . ' 1.' . - $r[0] . "
\n"; - } else { - $id = $regs[1]; - } - } else { - if (!preg_match("/^\\*\s+([0-9]+)\s+FETCH.*UID\s+([0-9]+)\s+/iAU",$r[0], $regs)) { - set_up_language($squirrelmail_language); - echo '
' . - _("ERROR : Could not complete request.") . - '
' . - _("Unknown response from IMAP server: ") . ' 1.' . - $r[0] . "
\n"; - } else { - $id = $regs[2]; - } + +/** + * Work in process + * @private + * @author Marc Groot Koerkamp + */ +function sqimap_parse_address($read, &$i) { + $arg_a = array(); + for (; $read{$i} != ')'; ++$i) { + $char = strtoupper($read{$i}); + switch ($char) { + case '{': + case '"': $arg_a[] = parseString($read,$i); break; + case 'n': + case 'N': + if (strtoupper(substr($read, $i, 3)) == 'NIL') { + $arg_a[] = ''; + $i += 2; + } + break; + default: break; } - $field = $r[1]; - $field = substr($field,strlen($field)+2); - $result[] = array($id,$field); } - return $result; -} + if (count($arg_a) == 4) { + return $arg_a; +// $adr = new AddressStructure(); +// $adr->personal = $arg_a[0]; +// $adr->adl = $arg_a[1]; +// $adr->mailbox = $arg_a[2]; +// $adr->host = $arg_a[3]; + } else { + $adr = ''; + } + return $adr; +} - -/* - * Returns a message array with all the information about a message. +/** + * Returns a message array with all the information about a message. * See the documentation folder for more information about this array. + * + * @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 + * @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) { - global $uid_support; - +function sqimap_get_message($imap_stream, $id, $mailbox, $hide=0) { + // 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, $uid_support); + $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])) { - $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, $startMessage, $color); + error_message($errmessage, $mailbox, $sort, (int) $startMessage); exit; - } + } $bodystructure = implode('',$read); $msg = mime_structure($bodystructure,$flags); - $read = sqimap_run_command ($imap_stream, "FETCH $id BODY[HEADER]", true, $response, $message, $uid_support); + $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; -} -/* Wrapper function that reformats the header information. */ -// obsolete? -function sqimap_get_message_header ($imap_stream, $id, $mailbox) { - global $uid_support; - $read = sqimap_run_command ($imap_stream, "FETCH $id BODY[HEADER]", true, $response, $message, $uid_support); - $header = sqimap_get_header($imap_stream, $read); - $header->id = $id; - $header->mailbox = $mailbox; - return $header; -} + parse_message_entities($msg, $id, $imap_stream); + return $msg; + } -/* Wrapper function that reformats the entity header information. */ -// obsolete? -function sqimap_get_ent_header ($imap_stream, $id, $mailbox, $ent) { - global $uid_support; - $read = sqimap_run_command ($imap_stream, "FETCH $id BODY[$ent.HEADER]", true, $response, $message, $uid_support); - $header = sqimap_get_header($imap_stream, $read); - $header->id = $id; - $header->mailbox = $mailbox; - return $header; -} -/* function to get the mime headers */ -// obsolete? -function sqimap_get_mime_ent_header ($imap_stream, $id, $mailbox, $ent) { - global $uid_support; - $read = sqimap_run_command ($imap_stream, "FETCH $id:$id BODY[$ent.MIME]", true, $response, $message, $uid_support); - $header = sqimap_get_header($imap_stream, $read); - $header->id = $id; - $header->mailbox = $mailbox; - return $header; +/** + * 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); + } + } } - -?>