X-Git-Url: https://vcs.fsf.org/?a=blobdiff_plain;f=functions%2Fimap_messages.php;h=f16b5d2b7ffcb3331b6f00ffc9ba4dbbac802285;hb=2198d485d5b406f3f007f5c0146b275fb8272326;hp=8ae69c3c9c10c8759cd40622718199028e89c740;hpb=75d916b725c14160998740294a7ed77792f9d313;p=squirrelmail.git diff --git a/functions/imap_messages.php b/functions/imap_messages.php index 8ae69c3c..f16b5d2b 100755 --- a/functions/imap_messages.php +++ b/functions/imap_messages.php @@ -3,753 +3,946 @@ /** * imap_messages.php * - * Copyright (c) 1999-2002 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-2006 The SquirrelMail Project Team + * @license http://opensource.org/licenses/gpl-license.php GNU Public License + * @version $Id$ + * @package squirrelmail + * @subpackage imap */ -/* Copies specified messages to specified folder */ -function sqimap_messages_copy ($imap_stream, $start, $end, $mailbox) { - $read = sqimap_run_command ($imap_stream, "COPY $start:$end \"$mailbox\"", true, $response, $message); + +/** + * 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), $handle_errors, $response, $message, TRUE); + if ($response == 'OK') { + return true; + } else { + return false; + } } -/* Deletes specified messages and moves them to trash if possible */ -function sqimap_messages_delete ($imap_stream, $start, $end, $mailbox) { - global $move_to_trash, $trash_folder, $auto_expunge; - 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; + } + $msgs_id = sqimap_message_list_squisher($id); + if (sqimap_msgs_list_copy ($imap_stream, $id, $mailbox, $handle_errors)) { + return sqimap_toggle_flag($imap_stream, $id, '\\Deleted', true, true); + } else { + return false; } - sqimap_messages_flag ($imap_stream, $start, $end, "Deleted"); } -/* Sets the specified messages with specified flag */ -function sqimap_messages_flag ($imap_stream, $start, $end, $flag) { - $read = sqimap_run_command ($imap_stream, "STORE $start:$end +FLAGS (\\$flag)", true, $response, $message); -} -/* Remove specified flag from specified messages */ -function sqimap_messages_remove_flag ($imap_stream, $start, $end, $flag) { - $read = sqimap_run_command ($imap_stream, "STORE $start:$end -FLAGS (\\$flag)", true, $response, $message); +/** + * 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) { + // 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; + $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; + } } -/* Returns some general header information -- FROM, DATE, and SUBJECT */ -class small_header { - var $from = '', $subject = '', $date = '', $to = '', - $priority = 0, $message_id = 0, $cc = ''; -} -function sqimap_get_small_header ($imap_stream, $id, $sent) { - $res = sqimap_get_small_header_list($imap_stream, array($id), $sent); - return $res[0]; +/** + * 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) { + $msgs_id = sqimap_message_list_squisher($id); + $set_string = ($set ? '+' : '-'); + + for ($i=0; $i 'DATE', - 1=> 'DATE', - 2=> 'FROM', - 3=> 'FROM', - 4=> 'SUBJECT', - 5=> 'SUBJECT', - 6=> 'DATE'); - 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])) { - $sort_query = "$sid SORT ($sort_on[$sort]) ".strtoupper($default_charset)." ALL\r\n"; - fputs($imap_stream, $sort_query); - $sort_test = sqimap_read_data($imap_stream, $sid, false, $response, $message); - } - if (isset($sort_test[0])) { - if (preg_match("/^\* SORT (.+)$/", $sort_test[0], $regs)) { - $server_sort_array = preg_split("/ /", trim($regs[1])); +function parseUidList($aData,$sCommand) { + $aUid = array(); + if (isset($aData) && count($aData)) { + for ($i=0,$iCnt=count($aData);$i<$iCnt;++$i) { + for ($j=0,$jCnt=count($aData[$i]);$j<$jCnt;++$j) { + if (preg_match("/^\* $sCommand (.+)$/", $aData[$i][$j], $aMatch)) { + $aUid += preg_split("/ /", trim($aMatch[1])); + } + } } } - if ($sort == 0 || $sort == 2 || $sort == 4) { - $server_sort_array = array_reverse($server_sort_array); - } - if (!preg_match("/OK/", $response)) { - $server_sort_array = 'no'; - } - session_register('server_sort_array'); - return $server_sort_array; + return array_unique($aUid); } - -/* 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 1) { - $thread_new[$k] .= $thread_temp[$i]; - $counter = $counter - 1; + } + } else { + $sThreadResponse = ""; + } + 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 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; + $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; } - else { - $thread_new[$k] .= $thread_temp[$i]; - $k++; - $thread_new[$k] = ""; - $counter = $counter - 1; + $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; } + } } - session_register('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; - session_register('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; +} -function sqimap_get_small_header_list ($imap_stream, $msg_list, $issent) { - global $squirrelmail_language, $color, $data_dir, $username; - /* Get the small headers for each message in $msg_list */ - $sid = sqimap_session_id(); - $maxmsg = sizeof($msg_list); - $msgs_str = sqimap_message_list_squisher($msg_list); - $results = array(); - $read_list = array(); - $sizes_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 - */ - for ($i = 0; $i < sizeof($msg_list); $i++) { - $id2index[$msg_list[$i]] = $i; - } - - $query = "$sid FETCH $msgs_str BODY.PEEK[HEADER.FIELDS (Date To From Cc Subject Message-Id X-Priority Content-Type In-Reply-To)]\r\n"; - fputs ($imap_stream, $query); - $readin_list = sqimap_read_data_list($imap_stream, $sid, true, $response, $message); - - foreach ($readin_list as $r) { - if (!eregi("^\\* ([0-9]+) FETCH", $r[0], $regs)) { - set_up_language($squirrelmail_language); - echo '
' . - _("ERROR : Could not complete request.") . - '
' . - _("Unknown response from IMAP server: ") . ' 1.' . - $r[0] . "
\n"; - } else if (! isset($id2index[$regs[1]]) || !count($id2index[$regs[1]])) { - set_up_language($squirrelmail_language); - echo '
' . - _("ERROR : Could not complete request.") . - '
' . - _("Unknown message number in reply from server: ") . - $regs[1] . "
\n"; - } else { - $read_list[$id2index[$regs[1]]] = $r; - } +/** + * 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; } - arsort($read_list); - - $query = "$sid FETCH $msgs_str RFC822.SIZE\r\n"; - fputs ($imap_stream, $query); - $sizesin_list = sqimap_read_data_list($imap_stream, $sid, true, $response, $message); - - foreach ($sizesin_list as $r) { - if (!eregi("^\\* ([0-9]+) FETCH", $r[0], $regs)) { - set_up_language($squirrelmail_language); - echo "
\n"; - echo _("ERROR : Could not complete request."); - echo "
\n"; - echo _("Unknown response from IMAP server: ") . ' 2.'; - echo $r[0] . "
\n"; - exit; - } - if (!count($id2index[$regs[1]])) { - set_up_language($squirrelmail_language); - echo "
\n"; - echo _("ERROR : Could not complete request."); - echo "
\n"; - echo _("Unknown messagenumber in reply from server: "); - echo $regs[1] . "
\n"; - exit; - } - $sizes_list[$id2index[$regs[1]]] = $r; - } - arsort($sizes_list); - - for ($msgi = 0; $msgi < $maxmsg; $msgi++) { - $subject = _("(no subject)"); - $from = _("Unknown Sender"); - $priority = 0; - $messageid = "<>"; - $cc = ""; - $to = ""; - $date = ""; - $type[0] = ""; - $type[1] = ""; - $inrepto = ""; - $read = $read_list[$msgi]; - - $prevline = false; - foreach ($read as $read_part) { - //unfold multi-line headers - while ($prevline && strspn($read_part, "\t ") > 0) { - $read_part = substr($prevline, 0, -2) . ' ' . ltrim($read_part); - } - $prevline = $read_part; - if (eregi ("^to:(.*)$", $read_part, $regs)) { - $to = $regs[1]; - } else if (eregi ("^from:(.*)$", $read_part, $regs)) { - $from = $regs[1]; - } else if (eregi ("^x-priority:(.*)$", $read_part, $regs)) { - $priority = trim($regs[1]); - } else if (eregi ("^message-id:(.*)$", $read_part, $regs)) { - $messageid = trim($regs[1]); - } else if (eregi ("^cc:(.*)$", $read_part, $regs)) { - $cc = $regs[1]; - } else if (eregi ("^date:(.*)$", $read_part, $regs)) { - $date = $regs[1]; - } else if (eregi ("^subject:(.*)$", $read_part, $regs)) { - $subject = htmlspecialchars(trim($regs[1])); - if ($subject == "") { - $subject = _("(no subject)"); - } - } else if (eregi ("^content-type:(.*)$", $read_part, $regs)) { - $type = strtolower(trim($regs[1])); - if ($pos = strpos($type, ";")) { - $type = substr($type, 0, $pos); - } - $type = explode("/", $type); - if (!isset($type[1])) { - $type[1] = ''; - } - } else if (eregi ("^in-reply-to:(.*)$", $read_part, $regs)) { - $inrepto = trim($regs[1]); + 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 + * + * @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} != '\\') { + $s = substr($read,$i,($iPos-$i)); + $i = $iPos; + break; } - } - $internaldate = getPref($data_dir, $username, 'internal_date_sort'); - if (trim($date) == "" || $internaldate) { - fputs($imap_stream, "$sid FETCH $msg_list[$msgi] INTERNALDATE\r\n"); - $readdate = sqimap_read_data($imap_stream, $sid, true, $response, $message); - if (eregi(".*INTERNALDATE \"(.*)\".*", $readdate[0], $regs)) { - $date_list = explode(' ', trim($regs[1])); - $date_list[0] = str_replace("-", ' ', $date_list[0]); - $date = implode(' ', $date_list); + $iPos++; + if ($iPos > strlen($read)) { + break; } } - eregi("([0-9]+)[^0-9]*$", $sizes_list[$msgi][0], $regs); - $size = $regs[1]; - - $header = new small_header; - if ($issent) { - $header->from = (trim($to) != '' ? $to : '(' ._("No To Address") . ')'); - } else { - $header->from = $from; + } 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 */ + $i += 3; /* } + \r + \n */ + $s = ''; } - - $header->date = $date; - $header->subject = $subject; - $header->to = $to; - $header->priority = $priority; - $header->message_id = $messageid; - $header->cc = $cc; - $header->size = $size; - $header->type0 = $type[0]; - $header->type1 = $type[1]; - $header->inrepto = $inrepto; - $result[] = $header; - } - return $result; -} - -/* Returns the flags for the specified messages */ -function sqimap_get_flags ($imap_stream, $i) { - $read = sqimap_run_command ($imap_stream, "FETCH $i:$i FLAGS", true, $response, $message); - if (ereg('FLAGS(.*)', $read[0], $regs)) { - return explode(' ', trim(ereg_replace('[\\(\\)\\\\]', '', $regs[1]))); + } else { + return false; } - return array('None'); + ++$i; + return $s; } -function sqimap_get_flags_list ($imap_stream, $msg_list) { - $msgs_str = sqimap_message_list_squisher($msg_list); - for ($i = 0; $i < sizeof($msg_list); $i++) { - $id2index[$msg_list[$i]] = $i; - } - $result_list = sqimap_run_command_list ($imap_stream, "FETCH $msgs_str FLAGS", true, $response, $message); - $result_flags = array(); - for ($i = 0; $i < sizeof($result_list); $i++) { - if (eregi('^\* ([0-9]+).*FETCH.*FLAGS(.*)', $result_list[$i][0], $regs) - && isset($id2index[$regs[1]]) && count($id2index[$regs[1]])) { - $result_flags[$id2index[$regs[1]]] = explode(" ", trim(ereg_replace('[\\(\\)\\\\]', '', $regs[2]))); - } else { - set_up_language($squirrelmail_language); - echo "
\n" . - _("ERROR : Could not complete request.") . - "
\n" . - _("Unknown response from IMAP server: ") . - $result_list[$i][0] . "
\n"; - exit; - } +/** + * 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); + $s = substr($read,$i+1,$i_pos - $i -1); + $a = explode(' ',$s); + if ($i_pos) { + $i = $i_pos+1; + return $a; + } else { + return false; } - arsort($result_flags); - return $result_flags; } -/* - * Returns a message array with all the information about a message. - * See the documentation folder for more information about this array. - */ -function sqimap_get_message ($imap_stream, $id, $mailbox) { - $header = sqimap_get_message_header($imap_stream, $id, $mailbox); - return sqimap_get_message_body($imap_stream, $header); -} -/* Wrapper function that reformats the header information. */ -function sqimap_get_message_header ($imap_stream, $id, $mailbox) { - $read = sqimap_run_command ($imap_stream, "FETCH $id:$id BODY[HEADER]", true, $response, $message); - $header = sqimap_get_header($imap_stream, $read); - $header->id = $id; - $header->mailbox = $mailbox; - return $header; -} +/** + * 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')) { -/* Wrapper function that reformats the entity header information. */ -function sqimap_get_ent_header ($imap_stream, $id, $mailbox, $ent) { - $read = sqimap_run_command ($imap_stream, "FETCH $id:$id BODY[$ent.HEADER]", true, $response, $message); - $header = sqimap_get_header($imap_stream, $read); - $header->id = $id; - $header->mailbox = $mailbox; - return $header; -} + $aMessageList = array(); + /** + * Catch other priority headers as well + */ + if (in_array('X-Priority',$aHeaderFields,true)) { + $aHeaderFields[] = 'Importance'; + $aHeaderFields[] = 'Priority'; + } -/* Wrapper function that returns entity headers for use by decodeMime */ -/* -function sqimap_get_entity_header ($imap_stream, &$read, &$type0, &$type1, &$bound, &$encoding, &$charset, &$filename) { - $header = sqimap_get_header($imap_stream, $read); - $type0 = $header["TYPE0"]; - $type1 = $header["TYPE1"]; - $bound = $header["BOUNDARY"]; - $encoding = $header["ENCODING"]; - $charset = $header["CHARSET"]; - $filename = $header["FILENAME"]; -} -*/ -/* Queries the IMAP server and gets all header information. */ -function sqimap_get_header ($imap_stream, $read) { - global $where, $what; - - $hdr = new msg_header(); - $i = 0; - - /* Set up some defaults */ - $hdr->type0 = "text"; - $hdr->type1 = "plain"; - $hdr->charset = "us-ascii"; - - while ($i < count($read)) { - //unfold multi-line headers - while ($i + 1 < count($read) && strspn($read[$i + 1], "\t ") > 0) { - $read[$i + 1] = substr($read[$i], 0, -2) . ' ' . ltrim($read[$i + 1]); - array_splice($read, $i, 1); - } + $bUidFetch = ! in_array('UID', $aFetchItems, true); - if (substr($read[$i], 0, 17) == "MIME-Version: 1.0") { - $hdr->mime = true; - $i++; - } - /* ENCODING TYPE */ - else if (substr(strtolower($read[$i]), 0, 26) == "content-transfer-encoding:") { - $hdr->encoding = strtolower(trim(substr($read[$i], 26))); - $i++; - } - /* CONTENT-TYPE */ - else if (strtolower(substr($read[$i], 0, 13)) == "content-type:") { - $cont = strtolower(trim(substr($read[$i], 13))); - if (strpos($cont, ";")) { - $cont = substr($cont, 0, strpos($cont, ";")); + /* Get the small headers for each message in $msg_list */ + if ($msg_list !== NULL) { + $msgs_str = sqimap_message_list_squisher($msg_list); + /* + * 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:*'; + } - if (strpos($cont, "/")) { - $hdr->type0 = substr($cont, 0, strpos($cont, "/")); - $hdr->type1 = substr($cont, strpos($cont, "/")+1); - } else { - $hdr->type0 = $cont; - } + /* + * Create the query + */ - $line = $read[$i]; - $i++; - while ( (substr(substr($read[$i], 0, strpos($read[$i], " ")), -1) != ":") && (trim($read[$i]) != "") && (trim($read[$i]) != ")")) { - str_replace("\n", "", $line); - str_replace("\n", "", $read[$i]); - $line = "$line $read[$i]"; - $i++; - } + $sFetchItems = ''; + $query = "FETCH $msgs_str ("; + if (count($aFetchItems)) { + $sFetchItems = implode(' ',$aFetchItems); + } + 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; +} - /* Detect the boundary of a multipart message */ - if (eregi('boundary="([^"]+)"', $line, $regs)) { - $hdr->boundary = $regs[1]; - } - /* Detect the charset */ - if (strpos(strtolower(trim($line)), "charset=")) { - $pos = strpos($line, "charset=") + 8; - $charset = trim($line); - if (strpos($line, ";", $pos) > 0) { - $charset = substr($charset, $pos, strpos($line, ";", $pos)-$pos); - } else { - $charset = substr($charset, $pos); +/** + * 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);/* 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') { + $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); + $i_len = strlen($read); + $i = 0; + while ($i < $i_len && $i !== false) { + /* get argument */ + $read = trim(substr($read,$i)); + $i_len = strlen($read); + $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': + $i_pos = strpos($read,' ',$i); + if (!$i_pos) { + $i_pos = strpos($read,')',$i); } - $charset = str_replace("\"", "", $charset); - $hdr->charset = $charset; - } else { - $hdr->charset = "us-ascii"; - } - /* Detect type in case of multipart/related */ - if (strpos(strtolower(trim($line)), "type=")) { - $pos = strpos($line, "type=") + 6; - $type = trim($line); - if (strpos($line, ";", $pos) > 0) { - $type = substr($type, $pos, strpos($line, ";", $pos)-$pos); + if ($i_pos) { + $unique_id = substr($read,$i,$i_pos-$i); + $i = $i_pos+1; } else { - $type = substr($type, $pos); + break 3; } - $hdr->type = $type; - } - } - else if (strtolower(substr($read[$i], 0, 20)) == "content-disposition:") { - /* Add better content-disposition support */ - $line = $read[$i]; - $i++; - while ( (substr(substr($read[$i], 0, strpos($read[$i], " ")), -1) != ":") && (trim($read[$i]) != "") && (trim($read[$i]) != ")")) { - str_replace("\n", "", $line); - str_replace("\n", "", $read[$i]); - $line = "$line $read[$i]"; - $i++; - } - - /* Detects filename if any */ - if (strpos(strtolower(trim($line)), "filename=")) { - $pos = strpos($line, "filename=") + 9; - $name = trim($line); - if (strpos($line, " ", $pos) > 0) { - $name = substr($name, $pos, strpos($line, " ", $pos)); + break; + case 'FLAGS': + $flags = parseArray($read,$i); + if (!$flags) break 3; + $aFlags = array(); + foreach ($flags as $flag) { + $flag = strtolower($flag); + $aFlags[$flag] = true; + } + $aMsg['FLAGS'] = $aFlags; + break; + case 'RFC822.SIZE': + $i_pos = strpos($read,' ',$i); + if (!$i_pos) { + $i_pos = strpos($read,')',$i); + } + if ($i_pos) { + $aMsg['SIZE'] = substr($read,$i,$i_pos-$i); + $i = $i_pos+1; } else { - $name = substr($name, $pos); + break 3; } - $name = str_replace("\"", "", $name); - $hdr->filename = $name; - } - } - /* REPLY-TO */ - else if (strtolower(substr($read[$i], 0, 9)) == "reply-to:") { - $hdr->replyto = trim(substr($read[$i], 9, strlen($read[$i]))); - $i++; - } - /* FROM */ - else if (strtolower(substr($read[$i], 0, 5)) == "from:") { - $hdr->from = trim(substr($read[$i], 5, strlen($read[$i]) - 6)); - if (! isset($hdr->replyto) || $hdr->replyto == "") { - $hdr->replyto = $hdr->from; - } - $i++; - } - /* DATE */ - else if (strtolower(substr($read[$i], 0, 5)) == "date:") { - $d = substr($read[$i], 5); - $d = trim($d); - $d = strtr($d, array(' ' => ' ')); - $d = explode(' ', $d); - $hdr->date = getTimeStamp($d); - $i++; - } - /* SUBJECT */ - else if (strtolower(substr($read[$i], 0, 8)) == "subject:") { - $hdr->subject = trim(substr($read[$i], 8, strlen($read[$i]) - 9)); - if (strlen(Chop($hdr->subject)) == 0) { - $hdr->subject = _("(no subject)"); - } - /* - if ($where == 'SUBJECT') { - $hdr->subject = $what; - // $hdr->subject = eregi_replace($what, "\\0", $hdr->subject); - } - */ - $i++; - } - /* CC */ - else if (strtolower(substr($read[$i], 0, 3)) == "cc:") { - $pos = 0; - $hdr->cc[$pos] = trim(substr($read[$i], 4)); - $i++; - while (((substr($read[$i], 0, 1) == " ") || (substr($read[$i], 0, 1) == "\t")) && (trim($read[$i]) != "")){ - $pos++; - $hdr->cc[$pos] = trim($read[$i]); - $i++; - } - } - /* BCC */ - else if (strtolower(substr($read[$i], 0, 4)) == "bcc:") { - $pos = 0; - $hdr->bcc[$pos] = trim(substr($read[$i], 5)); - $i++; - while (((substr($read[$i], 0, 1) == " ") || (substr($read[$i], 0, 1) == "\t")) && (trim($read[$i]) != "")){ - $pos++; - $hdr->bcc[$pos] = trim($read[$i]); - $i++; - } - } - /* TO */ - else if (strtolower(substr($read[$i], 0, 3)) == "to:") { - $pos = 0; - $hdr->to[$pos] = trim(substr($read[$i], 4)); - $i++; - while (((substr($read[$i], 0, 1) == " ") || (substr($read[$i], 0, 1) == "\t")) && (trim($read[$i]) != "")){ - $pos++; - $hdr->to[$pos] = trim($read[$i]); - $i++; - } - } - /* MESSAGE ID */ - else if (strtolower(substr($read[$i], 0, 11)) == "message-id:") { - $hdr->message_id = trim(substr($read[$i], 11)); - $i++; - } - /* ERROR CORRECTION */ - else if (substr($read[$i], 0, 1) == ")") { - if (strlen(trim($hdr->subject)) == 0) { - $hdr->subject = _("(no subject)"); - } - if (strlen(trim($hdr->from)) == 0) { - $hdr->from = _("(unknown sender)"); - } - if (strlen(trim($hdr->date)) == 0) { - $hdr->date = time(); + 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': + $aMsg['INTERNALDATE'] = trim(str_replace(' ', ' ',parseString($read,$i))); + break; + case 'BODY.PEEK[HEADER.FIELDS': + case 'BODY[HEADER.FIELDS': + $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 */ + $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 '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; + } + } + } + } + break; + default: + ++$i; + break; } - $i++; } - /* X-PRIORITY */ - else if (strtolower(substr($read[$i], 0, 11)) == "x-priority:") { - $hdr->priority = trim(substr($read[$i], 11)); - $i++; + 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; } - else { - $i++; + } + + 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 */ + } +} + + +/** + * 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; } - } - return $hdr; + } + + 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 the body of a message. */ -function sqimap_get_message_body ($imap_stream, &$header) { - $id = $header->id; - return decodeMime($imap_stream, $header); + +/** + * 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 + * @return Message Message object + */ +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); + 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'); + } + } + } else { + /* the message was not found, maybe the mailbox was modified? */ + global $sort, $startMessage, $color; + + $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); + exit; + } + $bodystructure = implode('',$read); + $msg = mime_structure($bodystructure,$flags); + $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; } ?>