Better support for malformed/absent dates and headerlines ending in only "\n".
[squirrelmail.git] / functions / imap_messages.php
index d95531576f997564ba082115f4eaa3af44de3ab4..23bb1ac28a0a2bd71cc910cfff989eb1ac0ca726 100755 (executable)
 /**
  * imap_messages.php
  *
- * Copyright (c) 1999-2002 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$
+ * @package squirrelmail
  */
 
-/****************************************************************************
- **  Copies specified messages to specified folder
- ****************************************************************************/
+/**
+ * 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 \"$mailbox\"", true, $response, $message);
+    global $uid_support;
+    $read = sqimap_run_command ($imap_stream, "COPY $start:$end " . sqimap_encode_mailbox_name($mailbox), true, $response, $message, $uid_support);
+}
+
+/**
+* copy a range of messages ($id) to another mailbox ($mailbox)
+* @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 " . sqimap_encode_mailbox_name($mailbox), true, $response, $message, $uid_support);
 }
 
-/****************************************************************************
- **  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;
+/**
+* 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) {
+    global $uid_support;
+    $msgs_id = sqimap_message_list_squisher($id);
+    $read = sqimap_run_command ($imap_stream, "COPY $msgs_id " . sqimap_encode_mailbox_name($mailbox), true, $response, $message, $uid_support);
+    $read = sqimap_run_command ($imap_stream, "STORE $msgs_id +FLAGS (\\Deleted)", true, $response,$message, $uid_support);
+}
 
-    if (($move_to_trash == true) && (sqimap_mailbox_exists($imap_stream, $trash_folder) && ($mailbox != $trash_folder))) {
+
+/**
+ * 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, $uid_support;
+
+    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");
-    } else {
-        sqimap_messages_flag ($imap_stream, $start, $end, "Deleted");
     }
+    sqimap_messages_flag ($imap_stream, $start, $end, "Deleted", true);
 }
 
-/****************************************************************************
- **  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);
+function sqimap_msgs_list_delete ($imap_stream, $mailbox, $id, $bypass_trash=false) {
+    global $move_to_trash, $trash_folder, $uid_support;
+    $msgs_id = sqimap_message_list_squisher($id);
+    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, $uid_support);
+    }
+    $read = sqimap_run_command ($imap_stream, "STORE $msgs_id +FLAGS (\\Deleted)", true, $response, $message, $uid_support);
 }
 
 
-/****************************************************************************
- **  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);
+/**
+ * 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);
 }
 
-
-/****************************************************************************
- **  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_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);
 }
 
+/** @deprecated */
 function sqimap_get_small_header ($imap_stream, $id, $sent) {
-    $res = sqimap_get_small_header_list($imap_stream, array($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
+
+/**
+ * Sort the message list and crunch to be as small as possible
  * (overflow could happen, so make it small if possible)
  */
 function sqimap_message_list_squisher($messages_array) {
     if( !is_array( $messages_array ) ) {
-        return;
+        return $messages_array;
     }
+
     sort($messages_array, SORT_NUMERIC);
     $msgs_str = '';
     while ($messages_array) {
@@ -84,447 +130,634 @@ function sqimap_message_list_squisher($messages_array) {
             $msgs_str .= ':' . $end;
         }
     }
-      
     return $msgs_str;
-}   
-
-function sqimap_get_small_header_list ($imap_stream, $msg_list, $issent) {
-    global $squirrelmail_language, $color;
+}
 
-    /* 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();
+/**
+ * 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;
 
-    /**
-     * 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;
+    if (sqsession_is_registered('server_sort_array')) {
+        sqsession_unregister('server_sort_array');
     }
 
-    $query = "$sid FETCH $msgs_str BODY.PEEK[HEADER.FIELDS (Date To From Cc Subject Message-Id X-Priority Content-Type)]\r\n";
-    fputs ($imap_stream, $query);
-    $readin_list = sqimap_read_data_list($imap_stream, $sid, true, $response, $message);
+    $sort_on = array();
+    $reverse = 0;
+    $server_sort_array = array();
+    $sort_test = array();
+    $sort_query = '';
 
-    foreach ($readin_list as $r) {
-        if (!eregi("^\\* ([0-9]+) FETCH", $r[0], $regs)) {
-            set_up_language($squirrelmail_language);
-            echo '<br><b><font color=$color[2]>' .
-                  _("ERROR : Could not complete request.") .
-                  '</b><br>' .
-                  _("Unknown response from IMAP server: ") . ' 1.' .
-                  $r[0] . "</font><br>\n";
-             /* exit; */
-        } else if (! isset($id2index[$regs[1]]) || !count($id2index[$regs[1]])) {
-             set_up_language($squirrelmail_language);
-             echo '<br><b><font color=$color[2]>' .
-                  _("ERROR : Could not complete request.") .
-                  '</b><br>' .
-                  _("Unknown message number in reply from server: ") .
-                  $regs[1] . "</font><br>\n";
-             /* exit */
-        } else {
-             $read_list[$id2index[$regs[1]]] = $r;
-        }
-    }
-    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 "<br><b><font color=$color[2]>\n";
-            echo _("ERROR : Could not complete request.");
-            echo "</b><br>\n";
-            echo _("Unknown response from IMAP server: ") . ' 2.';
-            echo $r[0] . "</font><br>\n";
-            exit;
-        }
-        if (!count($id2index[$regs[1]])) {
-            set_up_language($squirrelmail_language);
-            echo "<br><b><font color=$color[2]>\n";
-            echo _("ERROR : Could not complete request.");
-            echo "</b><br>\n";
-            echo _("Unknown messagenumber in reply from server: ");
-            echo $regs[1] . "</font><br>\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] = "";
-        $read = $read_list[$msgi];
-
-        for ($i = 0; $i < count($read); $i++) {
-            if (eregi ("^to:(.*)$", $read[$i], $regs)) {
-                /*$to = sqimap_find_displayable_name(substr($read[$i], 3));*/
-                $to = $regs[1];
-            } else if (eregi ("^from:(.*)$", $read[$i], $regs)) {
-                /*$from = sqimap_find_displayable_name(substr($read[$i], 5));*/
-                $from = $regs[1];
-            } else if (eregi ("^x-priority:(.*)$", $read[$i], $regs)) {
-                $priority = trim($regs[1]);
-            } else if (eregi ("^message-id:(.*)$", $read[$i], $regs)) {
-                $messageid = trim($regs[1]);
-            } else if (eregi ("^cc:(.*)$", $read[$i], $regs)) {
-                $cc = $regs[1];
-            } else if (eregi ("^date:(.*)$", $read[$i], $regs)) {
-                $date = $regs[1];
-            } else if (eregi ("^subject:(.*)$", $read[$i], $regs)) {
-                $subject = htmlspecialchars(trim($regs[1]));
-                if ($subject == "") {
-                    $subject = _("(no subject)");
-                }
-            } else if (eregi ("^content-type:(.*)$", $read[$i], $regs)) {
-                $type = strtolower(trim($regs[1]));
-                if ($pos = strpos($type, ";")) {
-                    $type = substr($type, 0, $pos);
-                }
-                $type = explode("/", $type);
-                if (! isset($type[1])) {
-                    $type[1] = '';
+    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 (trim($date) == "") {
-            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);
+            if (!preg_match("/OK/", $response)) {
+                $server_sort_array = 'no';
             }
-        }
-        eregi("([0-9]+)[^0-9]*$", $sizes_list[$msgi][0], $regs);
-        $size = $regs[1];
-         
-        $header = new small_header;
-        if ($issent == true) {
-            $header->from = (trim($to) != '' ? $to : '(' ._("No To Address") . ')');
         } else {
-            $header->from = $from;
+            $qty = $mbxresponse['EXISTS'];
+            $server_sort_array = range(1, $qty);
         }
-
-        $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];
-
-        $result[] = $header;
+        $server_sort_array = array_reverse($server_sort_array);
+        sqsession_register($server_sort_array, 'server_sort_array');
+        return $server_sort_array;
     }
-    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])));
+    $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';
     }
-    return Array('None');
-}
-
-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;
+    if ($sent_folder == $mailbox) {
+        $sort_on[2] = 'TO';
+        $sort_on[3] = 'TO';
     }
-    $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 "<br><b><font color=$color[2]>\n";
-            echo _("ERROR : Could not complete request.");
-            echo "</b><br>\n";
-            echo _("Unknown response from IMAP server: ");
-            echo $result_list[$i][0] . "</font><br>\n";
-            exit;
+    if (!empty($sort_on[$sort])) {
+        $query = "SORT ($sort_on[$sort]) ".strtoupper($default_charset).' ALL';
+        $sort_test = sqimap_run_command ($imap_stream, $query, true, $response, $message, $uid_support);
+    }
+    if (isset($sort_test[0])) {
+      for ($i=0,$iCnt=count($sort_test);$i<$iCnt;++$i) {
+        if (preg_match("/^\* SORT (.+)$/", $sort_test[$i], $regs)) {
+            $server_sort_array = preg_split("/ /", trim($regs[1]));
+           break;
         }
+      }
     }
-    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;
+    if ($sort == 0 || $sort == 2 || $sort == 4) {
+       $server_sort_array = array_reverse($server_sort_array);
+    }
+    if (!preg_match("/OK/", $response)) {
+       $server_sort_array = 'no';
+    }
+    sqsession_register($server_sort_array, 'server_sort_array');
+    return $server_sort_array;
 }
 
-/****************************************************************************
- **  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"];
-}
-*/
+/**
+ * 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;
 
-/****************************************************************************
- **  Queries the IMAP server and gets all header information.
- ****************************************************************************/
-function sqimap_get_header ($imap_stream, $read) {
-    global $where, $what;
+    if (sqsession_is_registered('php_sort_array')) {
+        sqsession_unregister('php_sort_array');
+    }
 
-    $hdr = new msg_header();
-    $i = 0;
-    /* Set up some defaults */
-    $hdr->type0 = "text";
-    $hdr->type1 = "plain";
-    $hdr->charset = "us-ascii";
-
-    while ($i < count($read)) {
-        if (substr($read[$i], 0, 17) == "MIME-Version: 1.0") {
-            $hdr->mime = true;
-            $i++;
-        }
+    $php_sort_array = array();
 
-        /** ENCODING TYPE **/
-        else if (substr(strtolower($read[$i]), 0, 26) == "content-transfer-encoding:") {
-            $hdr->encoding = strtolower(trim(substr($read[$i], 26)));
-            $i++;
+    if ($uid_support) {
+        if (isset($mbxresponse['UIDNEXT']) && $mbxresponse['UIDNEXT']) {
+                $uidnext = $mbxresponse['UIDNEXT']-1;
+        } else {
+            $uidnext = '*';
         }
-
-         /** 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, ";"));
+        $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);
+    }
+    sqsession_register($php_sort_array, 'php_sort_array');
+    return $php_sort_array;
+}
 
 
-            if (strpos($cont, "/")) {
-                $hdr->type0 = substr($cont, 0, strpos($cont, "/"));
-                $hdr->type1 = substr($cont, strpos($cont, "/")+1);
-            } else {
-                $hdr->type0 = $cont;
-            }
+/**
+ * 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<count($thread_new);$i++) {
+        $thread_new[$i] = preg_replace("/\s\(/", "(", $thread_new[$i]);
+        $thread_new[$i] = preg_replace("/(\d+)/", "$1|", $thread_new[$i]);
+        $thread_new[$i] = preg_split("/\|/", $thread_new[$i], -1, PREG_SPLIT_NO_EMPTY);
+    } 
+    $indent_array = array();
+        if (!$thread_new) {
+            $thread_new = array();
+        }
+    /* looping through the parts of one message thread */
 
+    for ($i=0;$i<count($thread_new);$i++) {
+    /* first grab the parent, it does not indent */
 
-            $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++;
+        if (isset($thread_new[$i][0])) {
+            if (preg_match("/(\d+)/", $thread_new[$i][0], $regs)) {
+                $parent = $regs[1];
             }
-
-            /** Detect the boundary of a multipart message **/
-            if (eregi('boundary="([^"]+)"', $line, $regs)) {
-                $hdr->boundary = $regs[1];
+        }
+        $indent_array[$parent] = 0;
+
+    /* now the children, checking each thread portion for
+       ),(, and space, adjusting the level and space values
+       to get the indent level
+    */
+        $level = 0;
+        $spaces = array();
+        $spaces_total = 0;
+        $indent = 0;
+        $fake = FALSE;
+        for ($k=1;$k<(count($thread_new[$i]))-1;$k++) {
+            $chars = count_chars($thread_new[$i][$k], 1);
+            if (isset($chars['40'])) {       /* testing for ( */
+                $level = $level + $chars['40'];
             }
-
-            /** 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);
+            if (isset($chars['41'])) {      /* testing for ) */
+                $level = $level - $chars['41'];
+                $spaces[$level] = 0;
+                /* if we were faking lets stop, this portion
+                   of the thread is over
+                */
+                if ($level == $cutoff) {
+                    $fake = FALSE;
                 }
-                $charset = str_replace("\"", "", $charset);
-                $hdr->charset = $charset;
-            } else {
-                $hdr->charset = "us-ascii";
             }
-        }
-
-        else if (strtolower(substr($read[$i], 0, 20)) == "content-disposition:") {
-            /** Add better dontent-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++;
+            if (isset($chars['32'])) {      /* testing for space */
+                if (!isset($spaces[$level])) {
+                    $spaces[$level] = 0;
+                }
+                $spaces[$level] = $spaces[$level] + $chars['32'];
             }
-
-            /** 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));
-                } else {
-                   $name = substr($name, $pos);
+            for ($x=0;$x<=$level;$x++) {
+                if (isset($spaces[$x])) {
+                    $spaces_total = $spaces_total + $spaces[$x];
                 }
-                $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;
+            $indent = $level + $spaces_total;
+            /* must have run into a message that broke the thread
+               so we are adjusting for that portion
+            */
+            if ($fake == TRUE) {
+                $indent = $indent +1;
             }
-            $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 (preg_match("/(\d+)/", $thread_new[$i][$k], $regs)) {
+                $child = $regs[1];
             }
-            
-            /*  
-            if ($where == 'SUBJECT') {
-                 $hdr->subject = $what;
-                 // $hdr->subject = eregi_replace($what, "<b>\\0</b>", $hdr->subject);
+            /* the thread must be broken if $indent == 0
+               so indent the message once and start faking it
+            */
+            if ($indent == 0) {
+                $indent = 1;
+                $fake = TRUE;
+                $cutoff = $level;
             }
+            /* dont need abs but if indent was negative
+               errors would occur
             */
-            
-            $i++;
+            $indent_array[$child] = abs($indent);
+            $spaces_total = 0;
         }
-        /** 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++;
+    }
+    return $indent_array;
+}
+
+
+/**
+ * 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;
+    if (sqsession_is_registered('thread_new')) {
+        sqsession_unregister('thread_new');
+    }
+    if (sqsession_is_registered('server_sort_array')) {
+        sqsession_unregister('server_sort_array');
+    }
+    $thread_temp = array ();
+    if ($sort_by_ref == 1) {
+        $sort_type = 'REFERENCES';
+    }
+    else {
+        $sort_type = 'ORDEREDSUBJECT';
+    }
+    $query = "THREAD $sort_type ".strtoupper($default_charset)." ALL";
+    $thread_test = sqimap_run_command ($imap_stream, $query, true, $response, $message, $uid_support);
+    if (isset($thread_test[0])) {
+        for ($i=0,$iCnt=count($thread_test);$i<$iCnt;++$i) {
+           if (preg_match("/^\* THREAD (.+)$/", $thread_test[$i], $regs)) {
+              $thread_list = trim($regs[1]);
+             break;
+           }
+        } 
+    }
+    else {
+       $thread_list = "";
+    }
+    if (!preg_match("/OK/", $response)) {
+       $server_sort_array = 'no';
+       return $server_sort_array;
+    }
+    if (isset($thread_list)) {
+        $thread_temp = preg_split("//", $thread_list, -1, PREG_SPLIT_NO_EMPTY);
+    }
+    $char_count = count($thread_temp);
+    $counter = 0;
+    $thread_new = array();
+    $k = 0;
+    $thread_new[0] = "";
+    for ($i=0;$i<$char_count;$i++) {
+            if ($thread_temp[$i] != ')' && $thread_temp[$i] != '(') {
+                    $thread_new[$k] = $thread_new[$k] . $thread_temp[$i];
             }
-        }
-        /** 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++;
+            elseif ($thread_temp[$i] == '(') {
+                    $thread_new[$k] .= $thread_temp[$i];
+                    $counter++;
             }
-        }
-        /** 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++;
+            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;
+                    }
             }
-        }
-        /** MESSAGE ID **/
-        else if (strtolower(substr($read[$i], 0, 11)) == "message-id:") {
-            $hdr->message_id = trim(substr($read[$i], 11));
-            $i++;
-        }
+    }
+    sqsession_register($thread_new, 'thread_new');
+    $thread_new = array_reverse($thread_new);
+    $thread_list = implode(" ", $thread_new);
+    $thread_list = str_replace("(", " ", $thread_list);
+    $thread_list = str_replace(")", " ", $thread_list);
+    $thread_list = preg_split("/\s/", $thread_list, -1, PREG_SPLIT_NO_EMPTY);
+    $server_sort_array = $thread_list;
+    sqsession_register($server_sort_array, 'server_sort_array');
+    return $thread_list;
+}
 
 
-        /** 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();
+function elapsedTime($start) {
+ $stop = gettimeofday();
+ $timepassed =  1000000 * ($stop['sec'] - $start['sec']) + $stop['usec'] - $start['usec'];
+ return $timepassed;
+}
+
+// only used in sqimap_get_small_header_list
+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;
+             }
+             $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 */
+            $i += 3; /* } + \r + \n */
+            $s = '';
+         }
+    } else {
+       return false;
+    }
+    ++$i;
+    return $s;
+}
+
+// only used in sqimap_get_small_header_list
+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;
+    }
+}
+
+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;
+    /* Get the small headers for each message in $msg_list */
+    $maxmsg = sizeof($msg_list);
+    if ($show_num != '999999') {
+        $msgs_str = sqimap_message_list_squisher($msg_list);
+    } 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
+     */
+    for ($i = 0; $i < sizeof($msg_list); $i++) {
+        $messages["$msg_list[$i]"] = array();
+    }
+
+    $internaldate = getPref($data_dir, $username, 'internal_date_sort');
+    if ($internaldate) {
+        $query = "FETCH $msgs_str (FLAGS UID RFC822.SIZE INTERNALDATE BODY.PEEK[HEADER.FIELDS (Date To Cc From Subject X-Priority Content-Type)])";
+    } else {
+        $query = "FETCH $msgs_str (FLAGS UID RFC822.SIZE BODY.PEEK[HEADER.FIELDS (Date To Cc From Subject X-Priority Content-Type)])";
+    }
+    $read_list = sqimap_run_command_list ($imap_stream, $query, true, $response, $message, $uid_support);
+    $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;
+
+        $read = implode('',$r);
+
+        /* 
+            * #id<space>FETCH<space>(
+        */
+    
+        /* extract the message id */
+        $i_space = strpos($read,' ',2);
+        $id = substr($read,2,$i_space-2);
+        $fetch = substr($read,$i_space+1,5);
+        if (!is_numeric($id) && $fetch !== 'FETCH') {
+            set_up_language($squirrelmail_language);
+            echo '<br><b><font color=$color[2]>' .
+                 _("ERROR : Could not complete request.") .
+                 '</b><br>' .
+                 _("Unknown response from IMAP server: ") . ' 1.' .
+                 htmlspecialchars($read) . "</font><br>\n";
+                 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;
+            switch ($arg)
+            {
+            case 'UID':
+                $i_pos = strpos($read,' ',$i);
+                if (!$i_pos) {
+                    $i_pos = strpos($read,')',$i);
+                }
+                if ($i_pos) {
+                    $unique_id = substr($read,$i,$i_pos-$i);
+                    $i = $i_pos+1;
+                } else {
+                    break 3;
+                }
+                break;
+            case 'FLAGS':
+                $flags = parseArray($read,$i);
+                if (!$flags) break 3;
+                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;
+                    }
+                }
+                break;
+            case 'RFC822.SIZE':
+                $i_pos = strpos($read,' ',$i);
+                if (!$i_pos) {
+                    $i_pos = strpos($read,')',$i);
+                }
+                if ($i_pos) {
+                    $size = substr($read,$i,$i_pos-$i);
+                    $i = $i_pos+1;
+                } else {
+                    break 3;
+                }
+                
+                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];
+                break;
+            case 'BODY.PEEK[HEADER.FIELDS':
+            case 'BODY[HEADER.FIELDS':
+                $i = strpos($read,'{',$i);
+                $header = parseString($read,$i);
+                if ($header === false) break 3;
+                /* 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("\n" , $hdr);
+                foreach ($hdr as $line) {
+                    $pos = strpos($line, ':');
+                    if ($pos > 0) {
+                        $field = strtolower(substr($line, 0, $pos));
+                        if (!strstr($field,' ')) { /* valid field */
+                            $value = trim(substr($line, $pos+1));
+                            switch($field)
+                            {
+                            case 'to': $to = $value; break;
+                            case 'cc': $cc = $value; break;
+                            case 'from': $from = $value; break;
+                            case 'date': $date = $value; break;
+                            case 'x-priority': $priority = $value; break;
+                            case 'subject':
+                                $subject = $value;
+                                if ($subject == "") {
+                                    $subject = _("(no subject)");
+                                }
+                                break;
+                            case 'content-type':
+                                $type = $value;
+                                if ($pos = strpos($type, ";")) {
+                                    $type = substr($type, 0, $pos);
+                                }
+                                $type = explode("/", $type);
+                                if(!is_array($type)) {
+                                    $type[0] = 'text';
+                                }
+                                break;
+                            default: 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 (isset($date)) {
+            $date = str_replace('  ', ' ', $date);
+            $tmpdate  = explode(' ', trim($date));
+        } else {
+            $tmpdate = $date = array();
+        }
+        if ($uid_support) {
+            $msgi ="$unique_id";
+            $messages[$msgi]['ID'] = $unique_id;
+        } else {
+            $msgi = "$id";
+            $messages[$msgi]['ID'] = $id;
         }
-        else {
-            $i++;
+        $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;
+           }
         }
-     }
-     return $hdr;
+        ++$msgi;
+    }
+    array_reverse($messages);
+    $new_messages = array();
+    foreach ($messages as $i =>$message) {
+        $new_messages[] = $message;
+    }
+    return $new_messages;
 }
 
-
-/****************************************************************************
- **  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.
+ */
+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);
+    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.") .
+              '<p>'._("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);
+    $rfc822_header = new Rfc822Header();
+    $rfc822_header->parseHeader($read);
+    $msg->rfc822_header = $rfc822_header;
+    return $msg;
 }
 
-
-/****************************************************************************
- **  Returns an array with the body structure 
- ****************************************************************************/
 ?>