Fixed a bug where users that did not log in before would get tons of
[squirrelmail.git] / functions / imap_mailbox.php
index ef129876bd0776b445487ff3f1bf19a0acb199bf..8e2600f059f6e70d70a553fc68377e1cc43a8291 100755 (executable)
@@ -8,10 +8,10 @@
    /******************************************************************************
     **  Expunges a mailbox 
     ******************************************************************************/
-   function sqimap_mailbox_expunge ($imap_stream, $mailbox) {
+   function sqimap_mailbox_expunge ($imap_stream, $mailbox,$handle_errors = true) {
       sqimap_mailbox_select ($imap_stream, $mailbox);
       fputs ($imap_stream, "a001 EXPUNGE\r\n");
-      $read = sqimap_read_data($imap_stream, "a001", true, $response, $message);
+      $read = sqimap_read_data($imap_stream, "a001", $handle_errors, $response, $message);
    }
 
 
     **  Checks whether or not the specified mailbox exists 
     ******************************************************************************/
    function sqimap_mailbox_exists ($imap_stream, $mailbox) {
-      $boxes = sqimap_mailbox_list ($imap_stream);
-      $found = false;
-      for ($i = 0; $i < count ($boxes); $i++) {
-         if ($boxes[$i]["unformatted"] == $mailbox)
-            $found = true;
+      fputs ($imap_stream, "a001 LIST \"\" \"$mailbox\"\r\n");
+      $mbx = sqimap_read_data($imap_stream, "a001", true, $response, $message);
+      if ($mailbox) {
+         return !!(ereg ("$mailbox", $mbx[0]));  // To force into true/false
       }
-      return $found;
    }
 
-
-   
    /******************************************************************************
     **  Selects a mailbox
     ******************************************************************************/
-   function sqimap_mailbox_select ($imap_stream, $mailbox, $hide) {
+   function sqimap_mailbox_select ($imap_stream, $mailbox, $hide=true, $recent=false) {
+      global $auto_expunge;
+      
       fputs ($imap_stream, "a001 SELECT \"$mailbox\"\r\n");
-       $read = sqimap_read_data($imap_stream, "a001", true, $response, $message);
+             $read = sqimap_read_data($imap_stream, "a001", true, $response, $message);
+      if ($recent) {
+         for ($i=0; $i<count($read); $i++) {
+            if (strpos(strtolower($read[$i]), "recent")) {
+               $r = explode(" ", $read[$i]);
+            }
+         }
+         return $r[1];
+      }
+      if ($auto_expunge) {
+         fputs ($imap_stream, "a001 EXPUNGE\r\n");
+         $tmp = sqimap_read_data($imap_stream, "a001", false, $a, $b);
+      }   
    }
 
    
     **  Unsubscribes to an existing folder 
     ******************************************************************************/
    function sqimap_unsubscribe ($imap_stream, $mailbox) {
-               global $imap_server_type;
-
-               /** This is a hack for UW server
-                **    Sometimes a folder will have a / at the end.  If that's the case,
-                **    the unsubscribe doesn't work for a box named "mailbox/".  We have
-                **    to strip off the / at the end.  There may be a better way of doing
-                **    this, but this is the best I've found so far.  (lme - April 26, 2000)
-                **/
-               if ($imap_server_type == "uw") {
-                       if (substr($mailbox, -1) == "/") {
-                               $mailbox = substr($mailbox, 0, strlen($mailbox)-1);
-                       }
-               }       
+                global $imap_server_type;
 
       fputs ($imap_stream, "a001 UNSUBSCRIBE \"$mailbox\"\r\n");
       $read_ary = sqimap_read_data($imap_stream, "a001", true, $response, $message);
 
    /******************************************************************************
     **  Formats a mailbox into 4 parts for the $boxes array
+    **
+    **  The four parts are:
+    **
+    **    raw            - Raw LIST/LSUB response from the IMAP server
+    **    formatted      - nicely formatted folder name
+    **    unformatted    - unformatted, but with delimiter at end removed
+    **    unformatted-dm - folder name as it appears in raw response
+       **    unformatted-disp - unformatted without $folder_prefix
+    **
     ******************************************************************************/
-   function sqimap_mailbox_parse ($line, $dm) {
-               global $folder_prefix;
+   function sqimap_mailbox_parse ($line, $line_lsub, $dm) {
+      global $folder_prefix;
+     
+      // Process each folder line
       for ($g=0; $g < count($line); $g++) {
+
+         // Store the raw IMAP reply
          $boxes[$g]["raw"] = $line[$g];
-            
-         $mailbox = find_mailbox_name($line[$g]);
+
+         // Count number of delimiters ($dm) in folder name
+         $mailbox = trim($line_lsub[$g]);
          $dm_count = countCharInString($mailbox, $dm);
          if (substr($mailbox, -1) == $dm)
-            $dm_count--;
-            
-         for ($j = 0; $j < $dm_count - (countCharInString($folder_prefix, $dm)); $j++)
-            $boxes[$g]["formatted"] = $boxes[$g]["formatted"] . "  ";
-         $boxes[$g]["formatted"] .= readShortMailboxName($mailbox, $dm);
+            $dm_count--;  // If name ends in delimiter - decrement count by one
+
+         // Format folder name, but only if it's a INBOX.* or have
+         // a parent.
+         $boxesbyname[$mailbox] = $g;
+         $parentfolder = readMailboxParent($mailbox, $dm);
+         if((eregi("^inbox".quotemeta($dm), $mailbox)) || 
+           (ereg("^".$folder_prefix, $mailbox)) ||
+            ( isset($boxesbyname[$parentfolder]) && (strlen($parentfolder) > 0) ) ) {
+            $indent = $dm_count - (countCharInString($folder_prefix, $dm));
+            if ($indent)
+                $boxes[$g]["formatted"]  = str_repeat("&nbsp;&nbsp;", $indent);
+            else
+                $boxes[$g]["formatted"] = '';
+            $boxes[$g]["formatted"] .= readShortMailboxName($mailbox, $dm);
+         } else {
+            $boxes[$g]["formatted"]  = $mailbox;
+         }
             
          $boxes[$g]["unformatted-dm"] = $mailbox;
          if (substr($mailbox, -1) == $dm)
             $mailbox = substr($mailbox, 0, strlen($mailbox) - 1);
          $boxes[$g]["unformatted"] = $mailbox;
+         $boxes[$g]["unformatted-disp"] = ereg_replace("^" . $folder_prefix, "", $mailbox);
          $boxes[$g]["id"] = $g;
 
-         $flags = substr($line[$g], strpos($line[$g], "(")+1);
-         $flags = substr($flags, 0, strpos($flags, ")"));
-         $flags = str_replace("\\", "", $flags);
-         $flags = trim(strtolower($flags));
+         ereg("\(([^)]*)\)",$line[$g],$regs);
+         $flags = trim(strtolower(str_replace("\\", "",$regs[1])));
          if ($flags) {
             $boxes[$g]["flags"] = explode(" ", $flags);
          }
-                       /****  I'm not sure why this was even in here to begin with..  (lme)
-                       for ($i=0; $i < count($boxes[$g]["flags"]); $i++) {
-                               if ($boxes[$g]["flags"][$i] == "noselect") {
-                                       $boxes[$g]["unformatted-dm"] = $boxes[$g]["unformatted-dm"].$dm;
-//                                     echo $boxes[$g]["unformatted-dm"]." - debug<br>";
-                               }
-                       }
-                       ****/
       }
+
       return $boxes;
    }
+
+   /* patch from dave_michmerhuizen@yahoo.com
+    * allows case insensativity when sorting folders
+    */
+   function _icmp ($a, $b) {
+      return strcasecmp($a, $b);
+   }
    
    /******************************************************************************
     **  Returns sorted mailbox lists in several different ways.
-    **  The array returned looks like this:
+    **  See comment on sqimap_mailbox_parse() for info about the returned array.
     ******************************************************************************/
    function sqimap_mailbox_list ($imap_stream) {
-      global $load_prefs_php, $prefs_php, $config_php, $data_dir, $username, $list_special_folders_first;
-               global $trash_folder, $sent_folder;
-               global $move_to_trash, $move_to_sent;
+      global $load_prefs_php, $prefs_php, $config_php;
+      global $data_dir, $username, $list_special_folders_first;
+      global $trash_folder, $sent_folder;
+      global $move_to_trash, $move_to_sent;
 
       $inbox_in_list = false;
       $inbox_subscribed = false;
 
       $dm = sqimap_get_delimiter ($imap_stream);
 
-      /** LIST array **/
-      fputs ($imap_stream, "a001 LIST \"\" \"$folder_prefix*\"\r\n");
-      $list_ary = sqimap_read_data ($imap_stream, "a001", true, $response, $message);
-
-      for ($i=0;$i < count($list_ary); $i++) {
-         $sorted_list_ary[$i]["name"] = find_mailbox_name($list_ary[$i]);
-         $sorted_list_ary[$i]["raw"]  = $list_ary[$i];
-         if ($sorted_list_ary[$i]["name"] == "INBOX")
-            $inbox_in_list = true;
-      }
-      if (isset($sorted_list_ary)) {
-         $list_sorted = array_cleave ($sorted_list_ary, "name");
-         asort($list_sorted);
-      }   
-
-
       /** LSUB array **/
       $inbox_subscribed = false;
       fputs ($imap_stream, "a001 LSUB \"\" \"*\"\r\n");
       $lsub_ary = sqimap_read_data ($imap_stream, "a001", true, $response, $message);
+
+         /** OS: we don't want to parse last element of array, 'cause it is OK command, so we unset it **/
+         unset($lsub_ary[count($lsub_ary)-1]);
+
       for ($i=0;$i < count($lsub_ary); $i++) {
          $sorted_lsub_ary[$i] = find_mailbox_name($lsub_ary[$i]);
-         if (substr($sorted_lsub_ary[$i], -1) == $dm)
-            $sorted_lsub_ary[$i] = substr($sorted_lsub_ary[$i], 0, strlen($sorted_lsub_ary[$i])-1);
          if ($sorted_lsub_ary[$i] == "INBOX")
             $inbox_subscribed = true;
       }
+      $new_ary = array();
+      for ($i=0; $i < count($sorted_lsub_ary); $i++) {
+         if (!in_array($sorted_lsub_ary[$i], $new_ary)) {
+            $new_ary[] = $sorted_lsub_ary[$i];
+         }
+      }
+      $sorted_lsub_ary = $new_ary;
       if (isset($sorted_lsub_ary)) {
-         sort($sorted_lsub_ary);
+         usort($sorted_lsub_ary, "_icmp");
+         //sort($sorted_lsub_ary);
       }   
 
-      
+      /** LIST array **/
+      for ($i=0; $i < count($sorted_lsub_ary); $i++) {
+         if (substr($sorted_lsub_ary[$i], -1) == $dm)
+            $mbx = substr($sorted_lsub_ary[$i], 0, strlen($sorted_lsub_ary[$i])-1);
+         else
+            $mbx = $sorted_lsub_ary[$i];
+
+         fputs ($imap_stream, "a001 LIST \"\" \"$mbx\"\r\n");
+         $read = sqimap_read_data ($imap_stream, "a001", true, $response, $message);
+         $sorted_list_ary[$i] = $read[0];
+         if (find_mailbox_name($sorted_list_ary[$i]) == "INBOX")
+            $inbox_in_list = true;
+      }
+                
       /** Just in case they're not subscribed to their inbox, we'll get it for them anyway **/
       if ($inbox_subscribed == false || $inbox_in_list == false) {
          fputs ($imap_stream, "a001 LIST \"\" \"INBOX\"\r\n");
          $inbox_ary = sqimap_read_data ($imap_stream, "a001", true, $response, $message);
-         $merged[0] = $inbox_ary[0];
-         $k = 1;
-      } else {
-         $k = 0;
-      }
 
-      $i = $j = 0;
-      
-      if (isset($list_sorted) && isset($sorted_lsub_ary)) {
-             reset ($list_sorted);
-             for (reset($list_sorted); $key = key($list_sorted), isset($key);) {
-                if ($sorted_lsub_ary[$i] == $list_sorted[$key]) {
-                   $merged[$k] = $sorted_list_ary[$key]["raw"];
-                   $k++;
-                   $i++;
-                   next($list_sorted);
-                } else if (isset($sorted_lsub_ary[$i]) && isset($list_sorted[$key]) && $sorted_lsub_ary[$i] < $list_sorted[$key]) {
-                   $i++;
-                } else {
-                   next($list_sorted);
-                }
-             }
+         $pos = count($sorted_list_ary);
+         $sorted_list_ary[$pos] = $inbox_ary[0];
+
+         $pos = count($sorted_lsub_ary);
+         $sorted_lsub_ary[$pos] = find_mailbox_name($inbox_ary[0]);
       }
-               $boxes = sqimap_mailbox_parse ($merged, $dm);
-               
-               /** Now, lets sort for special folders **/
+
+      $boxes = sqimap_mailbox_parse ($sorted_list_ary, $sorted_lsub_ary, $dm);
+
+
+      /** Now, lets sort for special folders **/
+
+      $boxesnew = Array();
+
+      // Find INBOX
       for ($i = 0; $i < count($boxes); $i++) {
          if (strtolower($boxes[$i]["unformatted"]) == "inbox") {
-            $boxesnew[0] = $boxes[$i];
+            $boxesnew[] = $boxes[$i];
             $boxes[$i]["used"] = true;
-                               $i = count($boxes);
+            $i = count($boxes);
          }
       }
 
       if ($list_special_folders_first == true) {
-         for ($i = count($boxes)-1; $i >= 0 ; $i--) {
-                               if (($boxes[$i]["unformatted"] == $trash_folder) && ($move_to_trash)) { 
-               $pos = count($boxesnew);
-               $boxesnew[$pos] = $boxes[$i];
+
+         // Then list special folders and their subfolders
+         for ($i = 0 ; $i <= count($boxes) ; $i++) {
+            if((eregi("^".quotemeta($trash_folder).'$', $boxes[$i]["unformatted"]) ||
+                eregi("^".quotemeta($trash_folder).quotemeta($dm), $boxes[$i]["unformatted"]) )  &&
+               ($move_to_trash)) {        
+               $boxesnew[] = $boxes[$i];
                $boxes[$i]["used"] = true;
-                                       $trash_found = true;
             }
-                               else if (($boxes[$i]["unformatted"] == $sent_folder) && ($move_to_sent)) {      
-               $pos = count($boxesnew);
-               $boxesnew[$pos] = $boxes[$i];
+            else if((eregi("^".quotemeta($sent_folder).'$', $boxes[$i]["unformatted"]) ||
+                     eregi("^".quotemeta($sent_folder).quotemeta($dm), $boxes[$i]["unformatted"]) )  &&
+                    ($move_to_sent)) {        
+               $boxesnew[] = $boxes[$i];
                $boxes[$i]["used"] = true;
-                                       $sent_found = true;
             }
+         }
 
-                               if (($sent_found && $trash_found) || ($sent_found && !$move_to_trash) || ($trash_found && !$move_to_sent) || (!$move_to_sent && !$move_to_trash))
-                                       $i = -1;
+         // Put INBOX.* folders ahead of the rest
+         for ($i = 0; $i <= count($boxes); $i++) {
+            if (eregi("^inbox\.", $boxes[$i]["unformatted"]) &&
+                ($boxes[$i]["used"] == false)) {
+               $boxesnew[] = $boxes[$i];
+               $boxes[$i]["used"] = true;
+            }
          }
+
       }
 
+      // Rest of the folders
       for ($i = 0; $i < count($boxes); $i++) {
          if ((strtolower($boxes[$i]["unformatted"]) != "inbox") &&
              ($boxes[$i]["used"] == false))  {
-            $pos = count($boxesnew);
-            $boxesnew[$pos] = $boxes[$i];
+            $boxesnew[] = $boxes[$i];
             $boxes[$i]["used"] = true;
          }
       }
       $read_ary = sqimap_read_data ($imap_stream, "a001", true, $response, $message);
       $g = 0;
       $phase = "inbox"; 
+
       for ($i = 0; $i < count($read_ary); $i++) {
          if (substr ($read_ary[$i], 0, 4) != "a001") {
+
+            // Store the raw IMAP reply
             $boxes[$g]["raw"] = $read_ary[$i];
 
+            // Count number of delimiters ($dm) in folder name
             $mailbox = find_mailbox_name($read_ary[$i]);
             $dm_count = countCharInString($mailbox, $dm);
             if (substr($mailbox, -1) == $dm)
-               $dm_count--;
-               
-            for ($j = 0; $j < $dm_count; $j++)
-               $boxes[$g]["formatted"] = $boxes[$g]["formatted"] . "  ";
-            $boxes[$g]["formatted"] .= readShortMailboxName($mailbox, $dm);
+               $dm_count--;  // If name ends in delimiter - decrement count by one
+            
+            // Format folder name, but only if it's a INBOX.* or have
+            // a parent.
+            $boxesbyname[$mailbox] = $g;
+            $parentfolder = readMailboxParent($mailbox, $dm);
+            if((eregi("^inbox".quotemeta($dm), $mailbox)) || 
+               (ereg("^".$folder_prefix, $mailbox)) ||
+               ( isset($boxesbyname[$parentfolder]) && (strlen($parentfolder) > 0) ) ) {
+               if ($dm_count)
+                   $boxes[$g]["formatted"]  = str_repeat("&nbsp;&nbsp;", $dm_count);
+               else
+                   $boxes[$g]["formatted"] = '';
+               $boxes[$g]["formatted"] .= readShortMailboxName($mailbox, $dm);
+            } else {
+               $boxes[$g]["formatted"]  = $mailbox;
+            }
                
             $boxes[$g]["unformatted-dm"] = $mailbox;
             if (substr($mailbox, -1) == $dm)
                $mailbox = substr($mailbox, 0, strlen($mailbox) - 1);
             $boxes[$g]["unformatted"] = $mailbox;
+            $boxes[$g]["unformatted-disp"] = ereg_replace("^" . $folder_prefix, "", $mailbox);
             $boxes[$g]["id"] = $g;
 
             /** Now lets get the flags for this mailbox **/
          }
          $g++;
       }
-      $boxes = ary_sort ($boxes, "unformatted", 1);
+      if(is_array($boxes)) {
+         $boxes = ary_sort ($boxes, "unformatted", 1);
+      }
+
       return $boxes;
    }