fix for expunge with UID in the sid
[squirrelmail.git] / functions / imap_mailbox.php
index fe275a1ecedbe35188c965d8c795a70f1908642f..cebd71b4a0983e186a73bfafa7326937132ef67c 100755 (executable)
  *
  * $Id$
  */
-
+require_once('../functions/imap_utf7_encode_local.php');
+require_once('../functions/imap_utf7_decode_local.php');
 global $boxesnew;
 
+class mailboxes {
+  var $mailboxname_full = '', $mailboxname_sub= '', $is_noselect = false, 
+      $is_special = false, $is_root = false, $is_inbox = false, $is_sent = false,
+       $is_trash = false, $is_draft = false,  $mbxs = array(), 
+       $unseen = false, $total = false;
+
+  function addMbx($mbx, $delimiter, $start, $specialfirst) {
+      $ary = explode($delimiter, $mbx->mailboxname_full);
+      $mbx_parent = &$this;
+      for ($i=$start; $i < (count($ary) -1); $i++) {
+        $mbx_childs = &$mbx_parent->mbxs;
+       $found = false;
+       if ($mbx_childs) {
+          foreach ($mbx_childs as $key => $parent) {
+           if ($parent->mailboxname_sub == $ary[$i]) {
+               $mbx_parent = &$mbx_parent->mbxs[$key];
+               $found = true;
+           } 
+         }
+       }  
+       if (!$found) {
+           $no_select_mbx = new mailboxes();
+           if (isset($mbx_parent->mailboxname_full) && $mbx_parent->mailboxname_full != '') {
+               $no_select_mbx->mailboxname_full = $mbx_parent->mailboxname_full.$delimiter.$ary[$i];
+           } else {
+               $no_select_mbx->mailboxname_full = $ary[$i];
+           }
+           $no_select_mbx->mailboxname_sub = $ary[$i];
+           $no_select_mbx->is_noselect = true;
+           $mbx_parent->mbxs[] = $no_select_mbx;
+           $i--;
+       }
+       
+     }
+     $mbx_parent->mbxs[] = $mbx;
+     if ($mbx->is_special && $specialfirst) {
+       usort($mbx_parent->mbxs, 'sortSpecialMbx');
+     }
+     
+  }
+}
+
+function sortSpecialMbx($a, $b) {
+    if ($a->is_inbox) {
+       $acmp = '0'. $a->mailboxname_full;
+    } else if ($a->is_special) {
+       $acmp = '1'. $a->mailboxname_full;
+    } else {
+       $acmp = '2' . $a->mailboxname_full;
+    }  
+    if ($b->is_inbox) {
+       $bcmp = '0'. $b->mailboxname_full;
+    }else if ($b->is_special) {
+       $bcmp = '1' . $b->mailboxname_full;
+    } else {
+       $bcmp = '2' . $b->mailboxname_full;
+    }
+    if ($acmp == $bcmp) return 0;
+    return ($acmp>$bcmp) ? 1: -1;
+}      
+
+
+function find_mailbox_name ($mailbox) {
+    if (ereg(" *\"([^\r\n\"]*)\"[ \r\n]*$", $mailbox, $regs))
+        return $regs[1];
+    ereg(" *([^ \r\n\"]*)[ \r\n]*$",$mailbox,$regs);
+    return $regs[1];
+    
+}
+
+/**
+ * If $haystack is a full mailbox name, and $needle is the mailbox
+ * separator character, returns the second last part of the full
+ * mailbox name (i.e. the mailbox's parent mailbox)
+ */
+function readMailboxParent($haystack, $needle) {
+
+    if ($needle == '') {
+        $ret = '';
+    } else {
+        $parts = explode($needle, $haystack);
+        $elem = array_pop($parts);
+        while ($elem == '' && count($parts)) {
+            $elem = array_pop($parts);
+        }
+        $ret = join($needle, $parts);
+    }
+    return( $ret );
+}
+
+
 function isBoxBelow( $box2, $box1 ) {
     global $delimiter, $folder_prefix, $imap_server_type;
 
@@ -55,9 +147,26 @@ function isSpecialMailbox( $box ) {
 }
 
 /* Expunges a mailbox */
-function sqimap_mailbox_expunge ($imap_stream, $mailbox, $handle_errors = true) {
-    $read = sqimap_run_command($imap_stream, 'EXPUNGE', $handle_errors,
-                               $response, $message);
+function sqimap_mailbox_expunge ($imap_stream, $mailbox, $handle_errors = true, $id='') {
+  global $uid_support;
+    if ($id) {
+       if (is_array($id)) {
+          $id = sqimap_message_list_squisher($id);
+       }
+       $id = ' '.$id;
+       $uid = $uid_support;
+    } else {
+       $uid = false;
+    }
+    $read = sqimap_run_command($imap_stream, 'EXPUNGE'.$id, $handle_errors,
+                               $response, $message, $uid);
+    $cnt = 0;                         
+    foreach ($read as $r) {
+       if (preg_match('/^\*\s[0-9]+\sEXPUNGE/AUi',$r,$regs)) {
+          $cnt++;
+       }
+    }
+    return $cnt; 
 }
 
 /* Checks whether or not the specified mailbox exists */
@@ -71,8 +180,7 @@ function sqimap_mailbox_exists ($imap_stream, $mailbox) {
 }
 
 /* Selects a mailbox */
-function sqimap_mailbox_select ($imap_stream, $mailbox,
-                                $hide = true, $recent = false, $extrainfo = false) {
+function sqimap_mailbox_select ($imap_stream, $mailbox) {
     global $auto_expunge;
 
     if ( $mailbox == 'None' ) {
@@ -81,20 +189,13 @@ function sqimap_mailbox_select ($imap_stream, $mailbox,
 
     $read = sqimap_run_command($imap_stream, "SELECT \"$mailbox\"",
                                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];
-    } else {
-        if ($auto_expunge) {
-            $tmp = sqimap_run_command($imap_stream, 'EXPUNGE', false, $a, $b);
-        }
-        if (isset( $extrainfo ) && $extrainfo) {
-            $result = array();
-            for ($i=0; $i<count($read); $i++) {
+    $result = array();
+    for ($i=0; $i<count($read); $i++) {
+        if (preg_match('/^\*\s+OK\s\[(\w+)\s(\w+)\]/',$read[$i], $regs)) {
+          $result[strtoupper($regs[1])] = $regs[2];
+       } else if (preg_match('/^\*\s([0-9]+)\s(\w+)/',$read[$i], $regs)) {
+          $result[strtoupper($regs[2])] = $regs[1];
+       } else {
                 if (preg_match("/PERMANENTFLAGS(.*)/i",$read[$i], $regs)) {
                     $regs[1]=trim(preg_replace (  array ("/\(/","/\)/","/\]/") ,'', $regs[1])) ;
                     $result['PERMANENTFLAGS'] = $regs[1];
@@ -103,20 +204,16 @@ function sqimap_mailbox_select ($imap_stream, $mailbox,
                     $regs[1]=trim(preg_replace (  array ("/\(/","/\)/") ,'', $regs[1])) ;
                     $result['FLAGS'] = $regs[1];
                 }
-                else if (preg_match("/(.*)EXISTS/i",$read[$i], $regs)) {
-                    $result['EXISTS']=trim($regs[1]);
-                }
-                else if (preg_match("/(.*)RECENT/i",$read[$i], $regs)) {
-                    $result['RECENT']=trim($regs[1]);
-                }
-                else if (preg_match("/\[UNSEEN(.*)\]/i",$read[$i], $regs)) {
-                    $result['UNSEEN']=trim($regs[1]);
-                }
+       }
+    }
+    if (preg_match('/^\[(.+)\]/',$message, $regs)) {
+       $result['RIGHTS']=$regs[1];
+    }
 
-            }
-            return( $result );
-        }
+    if ($auto_expunge) {
+            $tmp = sqimap_run_command($imap_stream, 'EXPUNGE', false, $a, $b);
     }
+    return $result;
 }
 
 /* Creates a folder */
@@ -125,6 +222,7 @@ function sqimap_mailbox_create ($imap_stream, $mailbox, $type) {
     if (strtolower($type) == 'noselect') {
         $mailbox .= $delimiter;
     }
+    $mailbox = imap_utf7_encode_local($mailbox);
     $read_ary = sqimap_run_command($imap_stream, "CREATE \"$mailbox\"",
                                    true, $response, $message);
     sqimap_subscribe ($imap_stream, $mailbox);
@@ -145,10 +243,12 @@ function sqimap_unsubscribe ($imap_stream, $mailbox) {
 
 /* Deletes the given folder */
 function sqimap_mailbox_delete ($imap_stream, $mailbox) {
+    global $data_dir, $username;
     $read_ary = sqimap_run_command($imap_stream, "DELETE \"$mailbox\"",
                                    true, $response, $message);
     sqimap_unsubscribe ($imap_stream, $mailbox);
     do_hook_function("rename_or_delete_folder", $args = array($mailbox, 'delete', ''));
+    removePref($data_dir, $username, "thread_$mailbox");
 }
 
 /* Determines if the user is subscribed to the folder or not */
@@ -165,7 +265,7 @@ function sqimap_mailbox_is_subscribed($imap_stream, $folder) {
 /* Renames a mailbox */
 function sqimap_mailbox_rename( $imap_stream, $old_name, $new_name ) {
     if ( $old_name != $new_name ) {
-        global $delimiter, $imap_server_type;
+        global $delimiter, $imap_server_type, $data_dir, $username;
         if ( substr( $old_name, -1 ) == $delimiter  ) {
             $old_name = substr( $old_name, 0, strlen( $old_name ) - 1 );
             $new_name = substr( $new_name, 0, strlen( $new_name ) - 1 );
@@ -177,7 +277,10 @@ function sqimap_mailbox_rename( $imap_stream, $old_name, $new_name ) {
         $cmd = 'RENAME "' . quoteIMAP($old_name) . '" "' .  quoteIMAP($new_name) . '"';
         $data = sqimap_run_command($imap_stream, $cmd, true, $response, $message);
         sqimap_unsubscribe($imap_stream, $old_name.$postfix);
+        $oldpref = getPref($data_dir, $username, "thread_".$old_name.$postfix);
+        removePref($data_dir, $username, "thread_".$old_name.$postfix);
         sqimap_subscribe($imap_stream, $new_name.$postfix);
+        setPref($data_dir, $username, "thread_".$new_name.$postfix, $oldpref);
         do_hook_function("rename_or_delete_folder",$args = array($old_name, 'rename', $new_name));
         $l = strlen( $old_name ) + 1;
         $p = 'unformatted';
@@ -190,7 +293,10 @@ function sqimap_mailbox_rename( $imap_stream, $old_name, $new_name ) {
                                                $response, $message);
                 }
                 sqimap_unsubscribe($imap_stream, $box[$p]);
+                $oldpref = getPref($data_dir, $username, "thread_".$box[$p]);
+                removePref($data_dir, $username, "thread_".$box[$p]);
                 sqimap_subscribe($imap_stream, $new_sub);
+                setPref($data_dir, $username, "thread_".$new_sub, $oldpref);
                 do_hook_function("rename_or_delete_folder",
                                  $args = array($box[$p], 'rename', $new_sub));
             }
@@ -246,10 +352,10 @@ function sqimap_mailbox_parse ($line, $line_lsub) {
             else {
                 $boxesall[$g]['formatted'] = '';
             }
-            $boxesall[$g]['formatted'] .= readShortMailboxName($mailbox, $delimiter);
+            $boxesall[$g]['formatted'] .= imap_utf7_decode_local(readShortMailboxName($mailbox, $delimiter));
         }
         else {
-            $boxesall[$g]['formatted']  = $mailbox;
+            $boxesall[$g]['formatted']  = imap_utf7_decode_local($mailbox);
         }
 
         $boxesall[$g]['unformatted-dm'] = $mailbox;
@@ -338,14 +444,14 @@ function user_strcasecmp($a, $b) {
  * See comment on sqimap_mailbox_parse() for info about the returned array.
  */
 function sqimap_mailbox_list($imap_stream) {
-    global $boxesnew, $default_folder_prefix;
+    global $default_folder_prefix;
 
     if ( !isset( $boxesnew ) ) {
 
         global $data_dir, $username, $list_special_folders_first,
                $folder_prefix, $trash_folder, $sent_folder, $draft_folder,
                $move_to_trash, $move_to_sent, $save_as_draft,
-               $delimiter;
+               $delimiter, $noselect_fix_enable;
 
         $inbox_in_list = false;
         $inbox_subscribed = false;
@@ -353,10 +459,17 @@ function sqimap_mailbox_list($imap_stream) {
         require_once('../src/load_prefs.php');
         require_once('../functions/array.php');
 
+    if ($noselect_fix_enable) {
+        $lsub_args = "LSUB \"$folder_prefix\" \"*%\"";
+    }
+    else {
+        $lsub_args = "LSUB \"$folder_prefix\" \"*\"";
+    }
         /* LSUB array */
-        $lsub_ary = sqimap_run_command ($imap_stream, "LSUB \"$folder_prefix\" \"*%\"",
+        $lsub_ary = sqimap_run_command ($imap_stream, $lsub_args,
                                         true, $response, $message);
 
+
         /*
          * Section about removing the last element was removed 
          * We don't return "* OK" anymore from sqimap_read_data
@@ -468,7 +581,14 @@ function sqimap_mailbox_list($imap_stream) {
                     $used[$k] = true;
                 }
                 $spec_sub = str_replace('&nbsp;', '', $box['formatted']);
-                if (!$used[$k] && preg_match("/^$default_folder_prefix(Sent|Drafts|Trash).{1}$spec_sub$/", $box['unformatted']) ) {
+                $spec_sub = str_replace('*', '', $spec_sub);
+                $spec_sub = str_replace('?', '\?', $spec_sub);
+
+               /* In case of problems with preg
+                  here is a ereg version
+                 if (!$used[$k] && ereg("^$default_folder_prefix(Sent|Drafts|Trash).{1}$spec_sub$", $box['unformatted']) ) { */
+                 
+                if (!$used[$k] && preg_match("?^$default_folder_prefix(Sent|Drafts|Trash).{1}$spec_sub$?", $box['unformatted']) ) {
                     $boxesnew[] = $box;
                     $used[$k] = true;
                 }
@@ -533,10 +653,10 @@ function sqimap_mailbox_list_all($imap_stream) {
                 else {
                     $boxes[$g]['formatted'] = '';
                 }
-                $boxes[$g]['formatted'] .= readShortMailboxName($mailbox, $delimiter);
+                $boxes[$g]['formatted'] .= imap_utf7_decode_local(readShortMailboxName($mailbox, $delimiter));
             }
             else {
-                $boxes[$g]['formatted']  = $mailbox;
+                $boxes[$g]['formatted']  = imap_utf7_decode_local($mailbox);
             }
 
             $boxes[$g]['unformatted-dm'] = $mailbox;
@@ -576,4 +696,183 @@ function sqimap_mailbox_list_all($imap_stream) {
     return $boxes;
 }
 
+function sqimap_mailbox_tree($imap_stream) {
+    global $boxesnew, $default_folder_prefix, $unseen_notify, $unseen_type;
+    if ( !isset( $boxesnew ) ) {
+
+        global $data_dir, $username, $list_special_folders_first,
+               $folder_prefix, $delimiter, $trash_folder, $move_to_trash;
+
+
+        $inbox_in_list = false;
+        $inbox_subscribed = false;
+
+        require_once('../src/load_prefs.php');
+        require_once('../functions/array.php');
+
+        /* LSUB array */
+        $lsub_ary = sqimap_run_command ($imap_stream, "LSUB \"$folder_prefix\" \"*\"",
+                                        true, $response, $message);
+
+        /*
+         * Section about removing the last element was removed 
+         * We don't return "* OK" anymore from sqimap_read_data
+         */
+        $sorted_lsub_ary = array();
+        $cnt = count($lsub_ary);
+        for ($i=0;$i < $cnt; $i++) {
+            /*
+             * Workaround for EIMS
+             * Doesn't work if the mailbox name is multiple lines
+             */
+            if (isset($lsub_ary[$i + 1]) &&
+                ereg("^(\\* [A-Z]+.*)\\{[0-9]+\\}([ \n\r\t]*)$",
+                     $lsub_ary[$i], $regs)) {
+                $i ++;
+                $lsub_ary[$i] = $regs[1] . '"' . addslashes(trim($lsub_ary[$i])) . '"' . $regs[2];
+            }
+
+//         if (preg_match("/^\*\s+LSUB\s+\((.*)\)\s+\"(.*)\"\s+\"?(.+(?=\")|.+).*$/",$lsub_ary[$i],$regs)) {
+//             $flag = $regs[1];
+//             $mbx = trim($regs[3]);
+//             $sorted_lsub_ary[] = array ('mbx' => $mbx, 'flag' => $flag); 
+//         }
+           $mbx = find_mailbox_name($lsub_ary[$i]);
+           if (substr($mbx, -1) == $delimiter) {
+               $mbx = substr($mbx, 0, strlen($mbx) - 1);
+           }
+           $sorted_lsub_ary[] = array ('mbx' => $mbx, 'flag' => ''); 
+        }
+       array_multisort($sorted_lsub_ary, SORT_ASC, SORT_REGULAR);
+
+       foreach ($sorted_lsub_ary as $mbx) {
+           if ($mbx['mbx'] == 'INBOX') {
+                $inbox_in_list = true;
+               break;
+            }
+       }
+
+        /*
+         * Just in case they're not subscribed to their inbox,
+         * we'll get it for them anyway
+         */
+        if (!$inbox_in_list) {
+            $inbox_ary = sqimap_run_command ($imap_stream, "LIST \"\" \"INBOX\"",
+                                             true, $response, $message);
+            /* Another workaround for EIMS */
+            if (isset($inbox_ary[1]) &&
+                ereg("^(\\* [A-Z]+.*)\\{[0-9]+\\}([ \n\r\t]*)$",
+                     $inbox_ary[0], $regs)) {
+                $inbox_ary[0] = $regs[1] . '"' . addslashes(trim($inbox_ary[1])) .
+                    '"' . $regs[2];
+            }
+           $mbx = find_mailbox_name($inbox_ary[0]);
+           if (substr($mbx, -1) == $delimiter) {
+               $mbx = substr($mbx, 0, strlen($mbx) - 1);
+           }
+           if ( $mbx == 'INBOX') {
+               $sorted_lsub_ary[] = array ('mbx' => $mbx, 'flag' => ''); 
+               sqimap_subscribe($imap_stream, 'INBOX');
+           }   
+           
+//         if (preg_match("/^\*\s+LIST\s+\((.*)\)\s+\"(.*)\"\s+\"?(.+(?=\")|.+).*$/",$inbox_ary[0],$regs)) {
+//             $flag = $regs[1];
+//             $mbx = trim($regs[3]);
+//             if (substr($mbx, -1) == $delimiter) {
+//                 $mbx = substr($mbx, 0, strlen($mbx) - 1);
+//             }
+//             $sorted_lsub_ary[] = array ('mbx' => $mbx, 'flag' => $flag); 
+//         }
+        }
+        $cnt = count($sorted_lsub_ary);
+       for ($i=0 ; $i < $cnt; $i++) {
+           $mbx = $sorted_lsub_ary[$i]['mbx'];
+           if (($unseen_notify == 2 && $mbx == 'INBOX') 
+               || $unseen_notify == 3 
+               || ($move_to_trash && ($mbx == $trash_folder))) {
+               $sorted_lsub_ary[$i]['unseen'] = sqimap_unseen_messages($imap_stream, $mbx);
+               if ($unseen_type == 2 || ($move_to_trash 
+                   && ($mbx == $trash_folder) )) {
+                   $sorted_lsub_ary[$i]['nummessages'] = sqimap_get_num_messages($imap_stream, $mbx);
+               }
+               if ($mbx == $trash_folder) {
+                   $sorted_lsub_ary[$i]['nummessages'] = sqimap_get_num_messages($imap_stream, $mbx);
+               }           
+           }
+       }
+       $boxesnew = sqimap_fill_mailbox_tree($sorted_lsub_ary);
+    return $boxesnew;
+    }
+}
+
+
+function sqimap_fill_mailbox_tree($mbx_ary, $mbxs=false) {
+    global $data_dir, $username, $list_special_folders_first,
+           $folder_prefix, $trash_folder, $sent_folder, $draft_folder,
+           $move_to_trash, $move_to_sent, $save_as_draft,
+           $delimiter;
+
+    $special_folders = array ('INBOX', $sent_folder, $draft_folder, $trash_folder);
+          
+    /* create virtual root node */
+    $mailboxes= new mailboxes();
+    $mailboxes->is_root = true;
+    $trail_del = false;           
+    if (isset($folder_prefix) && $folder_prefix != '') {
+       $start = substr_count($folder_prefix,$delimiter);
+       if (strrpos($folder_prefix, $delimiter) == (strlen($folder_prefix)-1)) {
+           $trail_del = true;
+           $mailboxes->mailboxname_full = substr($folder_prefix,0, (strlen($folder_prefix)-1));
+       } else {
+           $mailboxes->mailboxname_full = $folder_prefix;
+           $start++;
+       }
+       $mailboxes->mailboxname_sub = $mailboxes->mailboxname_full;
+    } else $start = 0;
+    $cnt =  count($mbx_ary);
+    for ($i=0; $i < $cnt; $i++) {
+       if ($mbx_ary[$i]['mbx'] !='' ) {
+           $mbx = new mailboxes();
+           $mailbox = $mbx_ary[$i]['mbx'];
+           switch ($mailbox) {
+               case 'INBOX':
+                   $mbx->is_inbox = true;
+                   $mbx->is_special = true;
+                   break;
+               case $trash_folder:
+                   $mbx->is_trash = true;
+                   $mbx->is_special = true;
+                   break;
+               case $sent_folder:
+                   $mbx->is_sent = true;
+                   $mbx->is_special = true;
+                   break;
+               case $draft_folder:
+                   $mbx->is_draft = true;
+                   $mbx->is_special = true;
+                   break;
+           }    
+                           
+           if (isset($mbx_ary[$i]['unseen'])) {
+               $mbx->unseen = $mbx_ary[$i]['unseen'];
+           }
+           if (isset($mbx_ary[$i]['nummessages'])) {
+               $mbx->total = $mbx_ary[$i]['nummessages'];
+           }
+           
+            $r_del_pos = strrpos($mbx_ary[$i]['mbx'], $delimiter);
+           if ($r_del_pos) {
+               $mbx->mailboxname_sub = substr($mbx_ary[$i]['mbx'],$r_del_pos+1);
+           } else {   /* mailbox is root folder */
+               $mbx->mailboxname_sub = $mbx_ary[$i]['mbx'];
+           }
+           $mbx->mailboxname_full = $mbx_ary[$i]['mbx'];
+           $mailboxes->addMbx($mbx, $delimiter, $start, $list_special_folders_first);
+       }
+    }
+
+    return $mailboxes;
+}
+
+
 ?>