X-Git-Url: https://vcs.fsf.org/?p=squirrelmail.git;a=blobdiff_plain;f=functions%2Fimap_messages.php;h=de96678592661fd5836e610c212b5124d0f78021;hp=583b5537702e9c21f6ab57da7bb1d809939f5f31;hb=8d8da447778a43b78bc95f9601b385416ad84477;hpb=461eda6c2c3922869a6134c84877a310808f0a96 diff --git a/functions/imap_messages.php b/functions/imap_messages.php index 583b5537..de966785 100755 --- a/functions/imap_messages.php +++ b/functions/imap_messages.php @@ -14,92 +14,84 @@ * @subpackage imap */ -/** - * Copies specified messages to specified folder - * @param int $imap_stream The resource ID for the IMAP connection - * @param string $start Beginning of range to copy - * @param string $end End of the range to copy - * @param string $mailbox Which box to copy to - * @deprecated This function is obsolete and should not be used - */ -function sqimap_messages_copy ($imap_stream, $start, $end, $mailbox) { - $read = sqimap_run_command ($imap_stream, "COPY $start:$end " . sqimap_encode_mailbox_name($mailbox), true, $response, $message, TRUE); -} /** -* copy a range of messages ($id) to another mailbox ($mailbox) -* @param int $imap_stream The resource ID for the IMAP socket -* @param string $id The list of messages to copy -* @param string $mailbox The destination to copy to -* @return void -*/ -function sqimap_msgs_list_copy ($imap_stream, $id, $mailbox) { - $msgs_id = sqimap_message_list_squisher($id); - $read = sqimap_run_command ($imap_stream, "COPY $msgs_id " . sqimap_encode_mailbox_name($mailbox), true, $response, $message, TRUE); -} - -/** -* move a range of messages ($id) to another mailbox. Deletes the originals. -* @param int $imap_stream The resource ID for the IMAP socket -* @param string $id The list of messages to move -* @param string $mailbox The destination to move to -* @return void -*/ -function sqimap_msgs_list_move ($imap_stream, $id, $mailbox) { + * Copy a set of messages ($id) to another mailbox ($mailbox) + * @param int $imap_stream The resource ID for the IMAP socket + * @param string $id The list of messages to copy + * @param string $mailbox The destination to copy to + * @return bool + */ +function sqimap_msgs_list_copy($imap_stream, $id, $mailbox) { $msgs_id = sqimap_message_list_squisher($id); $read = sqimap_run_command ($imap_stream, "COPY $msgs_id " . sqimap_encode_mailbox_name($mailbox), true, $response, $message, TRUE); - $read = sqimap_run_command ($imap_stream, "STORE $msgs_id +FLAGS (\\Deleted)", true, $response,$message, TRUE); + if ($response == 'OK') { + return true; + } else { + return false; + } } /** - * Deletes specified messages and moves them to trash if possible - * @deprecated This function is obsolete and should no longer be used - * @param int $imap_steam The resource ID for the IMAP connection - * @param string $start Start of range - * @param string $end End of range - * @param string $mailbox Mailbox messages are being deleted from + * Move a set of messages ($id) to another mailbox. Deletes the originals. + * @param int $imap_stream The resource ID for the IMAP socket + * @param string $id The list of messages to move + * @param string $mailbox The destination to move to * @return void */ -function sqimap_messages_delete ($imap_stream, $start, $end, $mailbox, $bypass_trash=false) { - global $move_to_trash, $trash_folder, $auto_expunge; - - if (($move_to_trash == true) && ($bypass_trash != true) && - (sqimap_mailbox_exists($imap_stream, $trash_folder) && ($mailbox != $trash_folder))) { - sqimap_messages_copy ($imap_stream, $start, $end, $trash_folder); +function sqimap_msgs_list_move($imap_stream, $id, $mailbox) { + $msgs_id = sqimap_message_list_squisher($id); + if (sqimap_msgs_list_copy ($imap_stream, $id, $mailbox)) { + return sqimap_toggle_flag($imap_stream, $id, '\\Deleted', true, true); + } else { + return false; } - sqimap_messages_flag ($imap_stream, $start, $end, "Deleted", true); } -function sqimap_msgs_list_delete ($imap_stream, $mailbox, $id, $bypass_trash=false) { + +/** + * 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 skip copy to trash + * @return array $aMessageList array with messages containing the new flags and UID @see parseFetch + */ +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; - $msgs_id = sqimap_message_list_squisher($id); + $bRes = true; if (($move_to_trash == true) && ($bypass_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, TRUE); + $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; } - $read = sqimap_run_command ($imap_stream, "STORE $msgs_id +FLAGS (\\Deleted)", true, $response, $message, TRUE); } /** - * Sets the specified messages with specified flag + * 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_messages_flag ($imap_stream, $start, $end, $flag, $handle_errors) { - $read = sqimap_run_command ($imap_stream, "STORE $start:$end +FLAGS (\\$flag)", $handle_errors, $response, $message, TRUE); -} - function sqimap_toggle_flag($imap_stream, $id, $flag, $set, $handle_errors) { $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, TRUE); + $aResponse = sqimap_run_command_list($imap_stream, "STORE $msgs_id ".$set_string."FLAGS ($flag)", $handle_errors, $response, $message, TRUE); + // parse the fetch response + return parseFetch($aResponse); } -/** @deprecated */ -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 @@ -129,118 +121,146 @@ function sqimap_message_list_squisher($messages_array) { return $msgs_str; } + /** - * Get sort order from server and return it as the $id array for mailbox_display. + * 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, $sort, $mbxresponse) { - global $default_charset, $thread_sort_messages, - $internal_date_sort, $server_sort_array, - $sent_folder, $mailbox; - - if (sqsession_is_registered('server_sort_array')) { - sqsession_unregister('server_sort_array'); - } +function sqimap_get_sort_order($imap_stream, $sSortField, $reverse, $search='ALL') { + global $default_charset; - $sort_on = array(); - $reverse = 0; - $server_sort_array = array(); - $sort_test = array(); - $sort_query = ''; - - if ($sort == 6) { - if (isset($mbxresponse['UIDNEXT']) && $mbxresponse['UIDNEXT']) { - $uidnext = $mbxresponse['UIDNEXT']-1; - } else { - $uidnext = '*'; - } - $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)) { - $server_sort_array = preg_split("/ /", trim($regs[1])); - } + if ($sSortField) { + if ($reverse) { + $sSortField = 'REVERSE '.$sSortField; } - if (!preg_match("/OK/", $response)) { - $server_sort_array = 'no'; + $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); + /* 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); } - $server_sort_array = array_reverse($server_sort_array); - sqsession_register($server_sort_array, 'server_sort_array'); - return $server_sort_array; } - $sort_on = array (0=> '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, TRUE); - } - 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'; + if ($response == 'OK') { + return parseUidList($aData,'SORT'); + } else { + return false; } - sqsession_register($server_sort_array, 'server_sort_array'); - return $server_sort_array; } + /** - * Get sort order from server if server does not have the SORT extension - * and return it as array for mailbox_display. - * - * @param resource $imap_stream - * @param array $mbxresponse response from a sqimap_mailbox_select - * @return array $php_sort_array + * Parses a UID list returned on a SORT or SEARCH request + * @param array $aData imap response + * @param string $sCommand issued imap command (SEARCH or SORT) + * @return array $aUid uid list */ -function sqimap_get_php_sort_order ($imap_stream, $mbxresponse) { - - if (sqsession_is_registered('php_sort_array')) { - sqsession_unregister('php_sort_array'); +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])); + } + } } + return array_unique($aUid); +} - $php_sort_array = array(); - - if (isset($mbxresponse['UIDNEXT']) && $mbxresponse['UIDNEXT']) { - $uidnext = $mbxresponse['UIDNEXT']-1; +/** + * Retrieves an array with a sorted uid list. Sorting is done by SquirrelMail + * + * @param resource $imap_stream IMAP socket connection + * @param string $sSortField Field to sort on + * @param bool $reverse Reverse order search + * @param array $aUid limit the search to the provided array with uid's default sqimap_get_small_headers uses 1:* + * @return array $aUid sorted uid list + */ +function get_squirrel_sort($imap_stream, $sSortField, $reverse = false, $aUid = NULL) { + if ($sSortField != 'RFC822.SIZE' && $sSortField != 'INTERNALDATE') { + $msgs = sqimap_get_small_header_list($imap_stream, $aUid, + array($sSortField), array()); } else { - $uidnext = '*'; - } - $query = "SEARCH UID 1:$uidnext"; - $uids = sqimap_run_command ($imap_stream, $query, true, $response, $message, true); - if (isset($uids[0])) { - $php_sort_array = array(); - // EIMS workaround. EIMS returns the result as multiple untagged SEARCH responses - foreach($uids as $line) { - if (preg_match("/^\* SEARCH (.+)$/", $line, $regs)) { - $php_sort_array += preg_split("/ /", trim($regs[1])); - } + $msgs = sqimap_get_small_header_list($imap_stream, $aUid, + array(), array($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_HOST] . "@".$addr[SQM_ADDR_HOST] : + $addr[SQM_ADDR_HOST]; + $v[$f] = ($sPersonal) ? decodeHeader($sPersonal):$sEmail;'),$sSortField); + $walk = true; } - } - if (!preg_match("/OK/", $response)) { - $php_sort_array = 'no'; - } - sqsession_register($php_sort_array, 'php_sort_array'); - return $php_sort_array; + // 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]))); + $v[$f] = (preg_match("/^(vedr|sv|re|aw|\[\w\]):\s*(.*)$/si", $v[$f], $matches)) ? + $matches[2] : $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; } @@ -249,28 +269,49 @@ function sqimap_get_php_sort_order ($imap_stream, $mbxresponse) { * 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; + +/* + * Notes for future work: + * indent_array should contain: indent_level, parent and flags, + * sibling notes .. + * 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) + */ +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 + /* + * 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 { - $thread_new[$k] .= $thread_temp[$i]; - $k++; - $thread_new[$k] = ""; - $counter = $counter - 1; - } + /* + * parse the thread response into separate threads + * + * example: + * [0] => (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; } + } } - sqsession_register($thread_new, 'thread_new'); + $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; - sqsession_register($server_sort_array, 'server_sort_array'); - return $thread_list; + + $indent_array = get_parent_level ($thread_new); + return array($thread_list,$indent_array); } 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); @@ -483,67 +550,87 @@ 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 $allow_server_sort; + +/** + * Retrieves a list with headers, flags, size or internaldate from the imap server + * @param resource $imap_stream imap connection + * @param array $msg_list array with id's to create a msgs set from + * @param array $aHeaderFields requested header fields + * @param array $aFetchItems requested other fetch items like FLAGS, RFC822.SIZE + * @return array $aMessages associative array with messages. Key is the UID, value is an associative array + */ +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(); + + $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(); + + $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; +} - $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)])"; - } - $read_list = sqimap_run_command_list ($imap_stream, $query, true, $response, $message, TRUE); - $i = 0; - - foreach ($read_list as $r) { - /* initialize/reset vars */ - $subject = _("(no subject)"); - $from = _("Unknown sender"); - $priority = 0; - $messageid = '<>'; - $type = array('',''); - $cc = $to = $inrepto = ''; - // use unset because we do isset below - unset($date); - $flag_seen = $flag_answered = $flag_deleted = $flag_flagged = false; +/** + * 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()) { + foreach ($aResponse as $r) { + $msg = array(); + // use unset because we do isset below $read = implode('',$r); - /* - * #idFETCH( - */ - + /* + * #idFETCH( + */ + /* extract the message id */ $i_space = strpos($read,' ',2); $id = substr($read,2,$i_space-2); + $msg['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; + $msg['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); @@ -573,17 +660,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; } + $msg['FLAGS'] = $aFlags; break; case 'RFC822.SIZE': $i_pos = strpos($read,' ',$i); @@ -591,20 +673,21 @@ 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); + $msg['SIZE'] = substr($read,$i,$i_pos-$i); $i = $i_pos+1; } else { break 3; } - + + break; + case 'ENVELOPE': + break; // to be implemented, moving imap code out of the nessages class + sqimap_parse_address($read,$i,$msg); + break; // to be implemented, moving imap code out of the nessages class + case 'BODYSTRUCTURE': break; 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]; + $msg['INTERNALDATE'] = str_replace(' ', ' ',parseString($read,$i)); break; case 'BODY.PEEK[HEADER.FIELDS': case 'BODY[HEADER.FIELDS': @@ -616,6 +699,7 @@ function sqimap_get_small_header_list ($imap_stream, $msg_list, $show_num=false) /* Now we can make a new header array with */ /* each element representing a headerline */ $hdr = explode("\n" , $hdr); + $aReceived = array(); foreach ($hdr as $line) { $pos = strpos($line, ':'); if ($pos > 0) { @@ -624,97 +708,188 @@ function sqimap_get_small_header_list ($imap_stream, $msg_list, $show_num=false) $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)"); - } + case 'to': $msg['TO'] = $value; break; + case 'cc': $msg['CC'] = $value; break; + case 'from': $msg['FROM'] = $value; break; + case 'date': + $msg['DATE'] = str_replace(' ', ' ', $value); break; + case 'x-priority': $msg['PRIORITY'] = $value; break; + case 'subject': $msg['SUBJECT'] = $value; break; case 'content-type': $type = $value; if ($pos = strpos($type, ";")) { $type = substr($type, 0, $pos); } $type = explode("/", $type); - if(!is_array($type)) { - $type[0] = 'text'; + if(!is_array($type) || count($type) < 2) { + $msg['TYPE0'] = 'text'; + $msg['TYPE1'] = 'plain'; + } else { + $msg['TYPE0'] = strtolower($type[0]); + $msg['TYPE1'] = strtolower($type[1]); } break; + case 'received': + $aReceived[] = $value; + break; default: break; } } } } + if (count($aReceived)) { + $msg['RECEIVED'] = $aReceived; + } break; default: ++$i; break; } } - if (isset($date)) { - $date = str_replace(' ', ' ', $date); - $tmpdate = explode(' ', trim($date)); - } else { - $tmpdate = $date = array(); - } $msgi ="$unique_id"; - $messages[$msgi]['ID'] = $unique_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; - } - } + $msg['UID'] = $unique_id; + + $aMessageList[$msgi] = $msg; ++$msgi; } - array_reverse($messages); - $new_messages = array(); - foreach ($messages as $i =>$message) { - $new_messages[] = $message; + 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; + } + } + + 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; + } + } + + 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 $new_messages; + 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 + * @return Message Message object */ -function sqimap_get_message ($imap_stream, $id, $mailbox) { +function sqimap_get_message($imap_stream, $id, $mailbox) { // typecast to int to prohibit 1:* msgs sets $id = (int) $id; $flags = array(); - $read = sqimap_run_command ($imap_stream, "FETCH $id (FLAGS BODYSTRUCTURE)", true, $response, $message, TRUE); + $read = sqimap_run_command($imap_stream, "FETCH $id (FLAGS BODYSTRUCTURE)", true, $response, $message, TRUE); if ($read) { if (preg_match('/.+FLAGS\s\((.*)\)\s/AUi',$read[0],$regs)) { if (trim($regs[1])) { @@ -726,18 +901,59 @@ function sqimap_get_message ($imap_stream, $id, $mailbox) { 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)."); + '

'._("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); + $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; } -?> + +/** + * Deprecated !!!!!!! DO NOT USE THIS, use sqimap_msgs_list_copy instead + */ +function sqimap_messages_copy($imap_stream, $start, $end, $mailbox) { + $read = sqimap_run_command ($imap_stream, "COPY $start:$end " . sqimap_encode_mailbox_name($mailbox), true, $response, $message, TRUE); +} + + +/** + * Deprecated !!!!!!! DO NOT USE THIS, use sqimap_msgs_list_delete instead + */ +function sqimap_messages_delete($imap_stream, $start, $end, $mailbox, $bypass_trash=false) { + global $move_to_trash, $trash_folder; + + if (($move_to_trash == true) && ($bypass_trash != true) && + (sqimap_mailbox_exists($imap_stream, $trash_folder) && ($mailbox != $trash_folder))) { + sqimap_messages_copy ($imap_stream, $start, $end, $trash_folder); + } + sqimap_messages_flag ($imap_stream, $start, $end, "Deleted", true); +} + + +/** + * Deprecated !!!!!!! DO NOT USE THIS, use sqimap_toggle_flag instead + * Set a flag on the provided uid list + * @param resource imap connection + */ +function sqimap_messages_flag($imap_stream, $start, $end, $flag, $handle_errors) { + $read = sqimap_run_command ($imap_stream, "STORE $start:$end +FLAGS (\\$flag)", $handle_errors, $response, $message, TRUE); +} + + +/** + * @deprecated + */ +function sqimap_get_small_header($imap_stream, $id, $sent) { + $res = sqimap_get_small_header_list($imap_stream, $id, $sent); + return $res[0]; +} + +?> \ No newline at end of file