X-Git-Url: https://vcs.fsf.org/?a=blobdiff_plain;f=functions%2Fimap_messages.php;h=db11da0368b281e65d6cee240e5caaf810116bcc;hb=eb19bc676326931545976b817f594025ed13eec0;hp=5df9ad31f1b7ffa45e887bea20c34aea51ea99dd;hpb=27932b080001da67162a69deeea62b327af05eb0;p=squirrelmail.git diff --git a/functions/imap_messages.php b/functions/imap_messages.php index 5df9ad31..db11da03 100755 --- a/functions/imap_messages.php +++ b/functions/imap_messages.php @@ -3,75 +3,105 @@ /** * imap_messages.php * - * Copyright (c) 1999-2003 The SquirrelMail Project Team + * Copyright (c) 1999-2004 The SquirrelMail Project Team * Licensed under the GNU GPL. For full terms see the file COPYING. * * This implements functions that manipulate messages + * NOTE: Quite a few functions in this file are obsolete * - * $Id$ + * @version $Id$ + * @package squirrelmail + * @subpackage imap */ -/* Copies specified messages to specified folder */ -/* obsolete */ +/** + * 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) { - global $uid_support; - $read = sqimap_run_command ($imap_stream, "COPY $start:$end \"$mailbox\"", true, $response, $message, $uid_support); + $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) { - global $uid_support; $msgs_id = sqimap_message_list_squisher($id); - $read = sqimap_run_command ($imap_stream, "COPY $msgs_id \"$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), 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) { + $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); } -/* 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; +/** + * 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 + * @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) && (sqimap_mailbox_exists($imap_stream, $trash_folder) && ($mailbox != $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); } -function sqimap_msgs_list_delete ($imap_stream, $mailbox, $id) { - global $move_to_trash, $trash_folder, $uid_support; +function sqimap_msgs_list_delete ($imap_stream, $mailbox, $id, $bypass_trash=false) { + global $move_to_trash, $trash_folder; $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 \"$trash_folder\"", true, $response, $message, $uid_support); + 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); } - $read = sqimap_run_command ($imap_stream, "STORE $msgs_id +FLAGS (\\Deleted)", true, $response, $message, $uid_support); + $read = sqimap_run_command ($imap_stream, "STORE $msgs_id +FLAGS (\\Deleted)", true, $response, $message, TRUE); } -/* Sets the specified messages with specified flag */ +/** + * 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); -} - -/* 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); + $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) { - 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); + $read = sqimap_run_command ($imap_stream, "STORE $msgs_id ".$set_string."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]; } -/* +/** * Sort the message list and crunch to be as small as possible * (overflow could happen, so make it small if possible) */ @@ -99,29 +129,13 @@ function sqimap_message_list_squisher($messages_array) { return $msgs_str; } -/* returns the references header lines */ -function get_reference_header ($imap_stream, $message) { - global $uid_support; - $responses = array (); - $results = array(); - $references = ""; - $responses = sqimap_run_command_list ($imap_stream, "FETCH $message BODY[HEADER.FIELDS (References)]", true, $response, $message, $uid_support); - if (!eregi("^\\* ([0-9]+) FETCH", $responses[0][0], $regs)) { - $responses = array (); - } - return $responses; -} - - -/* get sort order from server and - * return it as the $id array for - * mailbox_display +/** + * Get sort order from server and return it as the $id array for mailbox_display. */ - function sqimap_get_sort_order ($imap_stream, $sort, $mbxresponse) { global $default_charset, $thread_sort_messages, $internal_date_sort, $server_sort_array, - $sent_folder, $mailbox, $uid_support; + $sent_folder, $mailbox; if (sqsession_is_registered('server_sort_array')) { sqsession_unregister('server_sort_array'); @@ -134,25 +148,20 @@ function sqimap_get_sort_order ($imap_stream, $sort, $mbxresponse) { $sort_query = ''; if ($sort == 6) { - if ($uid_support) { - 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 (!preg_match("/OK/", $response)) { - $server_sort_array = 'no'; - } + if (isset($mbxresponse['UIDNEXT']) && $mbxresponse['UIDNEXT']) { + $uidnext = $mbxresponse['UIDNEXT']-1; } else { - $qty = $mbxresponse['EXISTS']; - $server_sort_array = range(1, $qty); + $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 (!preg_match("/OK/", $response)) { + $server_sort_array = 'no'; } $server_sort_array = array_reverse($server_sort_array); sqsession_register($server_sort_array, 'server_sort_array'); @@ -175,12 +184,15 @@ function sqimap_get_sort_order ($imap_stream, $sort, $mbxresponse) { } 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); + $sort_test = sqimap_run_command ($imap_stream, $query, true, $response, $message, TRUE); } if (isset($sort_test[0])) { - if (preg_match("/^\* SORT (.+)$/", $sort_test[0], $regs)) { + 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); @@ -192,9 +204,15 @@ function sqimap_get_sort_order ($imap_stream, $sort, $mbxresponse) { 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 + */ function sqimap_get_php_sort_order ($imap_stream, $mbxresponse) { - global $uid_support; if (sqsession_is_registered('php_sort_array')) { sqsession_unregister('php_sort_array'); @@ -202,41 +220,40 @@ function sqimap_get_php_sort_order ($imap_stream, $mbxresponse) { $php_sort_array = array(); - if ($uid_support) { - 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)) { - $php_sort_array = preg_split("/ /", trim($regs[1])); + 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])) { + $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])); } } - if (!preg_match("/OK/", $response)) { - $php_sort_array = 'no'; - } - } else { - $qty = $mbxresponse['EXISTS']; - $php_sort_array = range(1, $qty); + } + if (!preg_match("/OK/", $response)) { + $php_sort_array = 'no'; } 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) -*/ - +/** + * 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; + $parent = ''; + $child = ''; + $cutoff = 0; /* loop through the threads and take unwanted characters out of the thread string then chop it up @@ -326,13 +343,12 @@ function get_parent_level ($imap_stream) { } -/* 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. + */ function get_thread_sort ($imap_stream) { - global $thread_new, $sort_by_ref, $default_charset, $server_sort_array, $uid_support; + global $thread_new, $sort_by_ref, $default_charset, $server_sort_array; if (sqsession_is_registered('thread_new')) { sqsession_unregister('thread_new'); } @@ -347,11 +363,14 @@ function get_thread_sort ($imap_stream) { $sort_type = 'ORDEREDSUBJECT'; } $query = "THREAD $sort_type ".strtoupper($default_charset)." ALL"; - $thread_test = sqimap_run_command ($imap_stream, $query, true, $response, $message, $uid_support); + $thread_test = sqimap_run_command ($imap_stream, $query, true, $response, $message, TRUE); if (isset($thread_test[0])) { - if (preg_match("/^\* THREAD (.+)$/", $thread_test[0], $regs)) { - $thread_list = trim($regs[1]); - } + 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 = ""; @@ -407,6 +426,7 @@ function elapsedTime($start) { return $timepassed; } +// only used in sqimap_get_small_header_list function parseString($read,&$i) { $char = $read{$i}; $s = ''; @@ -449,19 +469,7 @@ function parseString($read,&$i) { return $s; } -function parseInteger($read,&$i) { - $s = false; - $i_pos = strpos($read,' ',$i); - if (!$i_pos) { - $i_pos = strpos($read,')',$i); - } - if ($i_pos) { - $s = substr($read,$i,$i_pos-$i); - $i = $i_pos+1; - } - return $s; -} - +// only used in sqimap_get_small_header_list function parseArray($read,&$i) { $i = strpos($read,'(',$i); $i_pos = strpos($read,')',$i); @@ -477,7 +485,7 @@ 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; + global $allow_server_sort; /* Get the small headers for each message in $msg_list */ $maxmsg = sizeof($msg_list); if ($show_num != '999999') { @@ -503,15 +511,19 @@ function sqimap_get_small_header_list ($imap_stream, $msg_list, $show_num=false) } 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, $uid_support); + $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"); + $from = _("Unknown sender"); $priority = 0; $messageid = '<>'; - $cc = $to = $date = $type[0] = $type[1] = $inrepto = ''; + $type = array('',''); + $cc = $to = $inrepto = ''; + // use unset because we do isset below + unset($date); $flag_seen = $flag_answered = $flag_deleted = $flag_flagged = false; $read = implode('',$r); @@ -598,12 +610,12 @@ function sqimap_get_small_header_list ($imap_stream, $msg_list, $show_num=false) case 'BODY[HEADER.FIELDS': $i = strpos($read,'{',$i); $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)); + if ($header === false) break 2; + /* First we replace all \r\n by \n, and unfold the header */ + $hdr = trim(str_replace(array("\r\n", "\n\t", "\n "),array("\n", ' ', ' '), $header)); /* Now we can make a new header array with */ /* each element representing a headerline */ - $hdr = explode("\r\n" , $hdr); + $hdr = explode("\n" , $hdr); foreach ($hdr as $line) { $pos = strpos($line, ':'); if ($pos > 0) { @@ -632,9 +644,6 @@ function sqimap_get_small_header_list ($imap_stream, $msg_list, $show_num=false) if(!is_array($type)) { $type[0] = 'text'; } - if (!isset($type[1])) { - $type[1] = ''; - } break; default: break; } @@ -651,15 +660,10 @@ function sqimap_get_small_header_list ($imap_stream, $msg_list, $show_num=false) $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; + $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); @@ -702,116 +706,37 @@ function sqimap_get_small_header_list ($imap_stream, $msg_list, $show_num=false) return $new_messages; } -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]; - } - } - $field = $r[1]; - $field = substr($field,strlen($field)+2); - $result[] = array($id,$field); - } - return $result; -} - - - - - -/* +/** * 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) { - global $uid_support; $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'); - } - } + 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 { - echo "ERROR Yeah I know, not a very usefull errormessage (id = $id, mailbox = $mailbox sqimap_get_message)"; - exit; + /* 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, $startMessage, $color); + 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. */ -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; -} - -/* Wrapper function that reformats the entity header information. */ -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 */ -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; -} - ?>