functions/imap_mailbox.php

   1 <?php
   2
   3 /**
   4  * imap_mailbox.php
   5  *
   6  * Copyright (c) 1999-2002 The SquirrelMail Project Team
   7  * Licensed under the GNU GPL. For full terms see the file COPYING.
   8  *
   9  * This impliments all functions that manipulate mailboxes
  10  *
  11  * $Id$
  12  */
  13 require_once('../functions/imap_utf7_encode_local.php');
  14 require_once('../functions/imap_utf7_decode_local.php');
  15 global $boxesnew;
  16
  17 class mailboxes {
  18   var $mailboxname_full = '', $mailboxname_sub= '', $is_noselect = false,
  19       $is_special = false, $is_root = false, $is_inbox = false, $is_sent = false,
  20        $is_trash = false, $is_draft = false,  $mbxs = array(),
  21        $unseen = false, $total = false;
  22
  23   function addMbx($mbx, $delimiter, $start, $specialfirst) {
  24       $ary = explode($delimiter, $mbx->mailboxname_full);
  25       $mbx_parent = &$this;
  26       for ($i=$start; $i < (count($ary) -1); $i++) {
  27         $mbx_childs = &$mbx_parent->mbxs;
  28         $found = false;
  29         if ($mbx_childs) {
  30           foreach ($mbx_childs as $key => $parent) {
  31             if ($parent->mailboxname_sub == $ary[$i]) {
  32                 $mbx_parent = &$mbx_parent->mbxs[$key];
  33                 $found = true;
  34             }
  35           }
  36         }
  37         if (!$found) {
  38             $no_select_mbx = new mailboxes();
  39             if (isset($mbx_parent->mailboxname_full) && $mbx_parent->mailboxname_full != '') {
  40                 $no_select_mbx->mailboxname_full = $mbx_parent->mailboxname_full.$delimiter.$ary[$i];
  41             } else {
  42                 $no_select_mbx->mailboxname_full = $ary[$i];
  43             }
  44             $no_select_mbx->mailboxname_sub = $ary[$i];
  45             $no_select_mbx->is_noselect = true;
  46             $mbx_parent->mbxs[] = $no_select_mbx;
  47             $i--;
  48         }
  49
  50      }
  51      $mbx_parent->mbxs[] = $mbx;
  52      if ($mbx->is_special && $specialfirst) {
  53         usort($mbx_parent->mbxs, 'sortSpecialMbx');
  54      }
  55
  56   }
  57 }
  58
  59 function sortSpecialMbx($a, $b) {
  60     if ($a->is_inbox) {
  61         $acmp = '0'. $a->mailboxname_full;
  62     } else if ($a->is_special) {
  63         $acmp = '1'. $a->mailboxname_full;
  64     } else {
  65         $acmp = '2' . $a->mailboxname_full;
  66     }
  67     if ($b->is_inbox) {
  68         $bcmp = '0'. $b->mailboxname_full;
  69     }else if ($b->is_special) {
  70         $bcmp = '1' . $b->mailboxname_full;
  71     } else {
  72         $bcmp = '2' . $b->mailboxname_full;
  73     }
  74     if ($acmp == $bcmp) return 0;
  75     return ($acmp>$bcmp) ? 1: -1;
  76 }
  77
  78
  79 function find_mailbox_name ($mailbox) {
  80     if (ereg(" *\"([^\r\n\"]*)\"[ \r\n]*$", $mailbox, $regs))
  81         return $regs[1];
  82     ereg(" *([^ \r\n\"]*)[ \r\n]*$",$mailbox,$regs);
  83     return $regs[1];
  84
  85 }
  86
  87 /**
  88  * If $haystack is a full mailbox name, and $needle is the mailbox
  89  * separator character, returns the second last part of the full
  90  * mailbox name (i.e. the mailbox's parent mailbox)
  91  */
  92 function readMailboxParent($haystack, $needle) {
  93
  94     if ($needle == '') {
  95         $ret = '';
  96     } else {
  97         $parts = explode($needle, $haystack);
  98         $elem = array_pop($parts);
  99         while ($elem == '' && count($parts)) {
 100             $elem = array_pop($parts);
 101         }
 102         $ret = join($needle, $parts);
 103     }
 104     return( $ret );
 105 }
 106
 107
 108 function isBoxBelow( $box2, $box1 ) {
 109     global $delimiter, $folder_prefix, $imap_server_type;
 110
 111     if ( $imap_server_type == 'uw' ) {
 112         $boxs = $box2;
 113         $i = strpos( $box1, $delimiter, strlen( $folder_prefix ) );
 114         if ( $i === false ) {
 115             $i = strlen( $box2 );
 116         }
 117     } else {
 118         $boxs = $box2 . $delimiter;
 119         /* Skip next second delimiter */
 120         $i = strpos( $box1, $delimiter );
 121         $i = strpos( $box1, $delimiter, $i + 1  );
 122         if ( $i === false ) {
 123             $i = strlen( $box2 );
 124         } else {
 125             $i++;
 126         }
 127     }
 128
 129     return ( substr( $box1, 0, $i ) == substr( $boxs, 0, $i ) );
 130 }
 131
 132 /* Defines special mailboxes */
 133 function isSpecialMailbox( $box ) {
 134     global $trash_folder, $sent_folder, $draft_folder,
 135            $move_to_trash, $move_to_sent, $save_as_draft;
 136
 137     $ret = ( (strtolower($box) == 'inbox') ||
 138              ( $move_to_trash && isBoxBelow( $box, $trash_folder ) ) ||
 139              ( $move_to_sent && isBoxBelow( $box, $sent_folder )) ||
 140              ($save_as_draft && $box == $draft_folder ) );
 141
 142     if ( !$ret ) {
 143         $ret = do_hook_function( 'special_mailbox', $box );
 144     }
 145
 146     return $ret;
 147 }
 148
 149 /* Expunges a mailbox */
 150 function sqimap_mailbox_expunge ($imap_stream, $mailbox, $handle_errors = true, $id='') {
 151     global $uid_support;
 152     if ($id) {
 153        if (is_array($id)) {
 154           $id = sqimap_message_list_squisher($id);
 155        }
 156        $id = ' '.$id;
 157        $uid = $uid_support;
 158     } else {
 159        $uid = false;
 160     }
 161     $read = sqimap_run_command($imap_stream, 'EXPUNGE'.$id, $handle_errors,
 162                                $response, $message, $uid);
 163     $cnt = 0;
 164
 165     if ( is_array( $read ) ) {
 166         foreach ($read as $r) {
 167            if (preg_match('/^\*\s[0-9]+\sEXPUNGE/AUi',$r,$regs)) {
 168               $cnt++;
 169            }
 170         }
 171     }
 172     return $cnt;
 173 }
 174
 175 /* Checks whether or not the specified mailbox exists */
 176 function sqimap_mailbox_exists ($imap_stream, $mailbox) {
 177     if (! isset($mailbox)) {
 178         return false;
 179     }
 180     $mbx = sqimap_run_command($imap_stream, "LIST \"\" \"$mailbox\"",
 181                               true, $response, $message);
 182     return isset($mbx[0]);
 183 }
 184
 185 /* Selects a mailbox */
 186 function sqimap_mailbox_select ($imap_stream, $mailbox) {
 187     global $auto_expunge;
 188
 189     if ( $mailbox == 'None' ) {
 190         return;
 191     }
 192
 193     $read = sqimap_run_command($imap_stream, "SELECT \"$mailbox\"",
 194                                true, $response, $message);
 195     $result = array();
 196     for ($i=0; $i<count($read); $i++) {
 197         if (preg_match('/^\*\s+OK\s\[(\w+)\s(\w+)\]/',$read[$i], $regs)) {
 198            $result[strtoupper($regs[1])] = $regs[2];
 199         } else if (preg_match('/^\*\s([0-9]+)\s(\w+)/',$read[$i], $regs)) {
 200            $result[strtoupper($regs[2])] = $regs[1];
 201         } else {
 202                 if (preg_match("/PERMANENTFLAGS(.*)/i",$read[$i], $regs)) {
 203                     $regs[1]=trim(preg_replace (  array ("/\(/","/\)/","/\]/") ,'', $regs[1])) ;
 204                     $result['PERMANENTFLAGS'] = $regs[1];
 205                 }
 206                 else if (preg_match("/FLAGS(.*)/i",$read[$i], $regs)) {
 207                     $regs[1]=trim(preg_replace (  array ("/\(/","/\)/") ,'', $regs[1])) ;
 208                     $result['FLAGS'] = $regs[1];
 209                 }
 210         }
 211     }
 212     if (preg_match('/^\[(.+)\]/',$message, $regs)) {
 213        $result['RIGHTS']=$regs[1];
 214     }
 215
 216     if ($auto_expunge) {
 217             $tmp = sqimap_run_command($imap_stream, 'EXPUNGE', false, $a, $b);
 218     }
 219     return $result;
 220 }
 221
 222 /* Creates a folder */
 223 function sqimap_mailbox_create ($imap_stream, $mailbox, $type) {
 224     global $delimiter;
 225     if (strtolower($type) == 'noselect') {
 226         $mailbox .= $delimiter;
 227     }
 228     $mailbox = imap_utf7_encode_local($mailbox);
 229     $read_ary = sqimap_run_command($imap_stream, "CREATE \"$mailbox\"",
 230                                    true, $response, $message);
 231     sqimap_subscribe ($imap_stream, $mailbox);
 232 }
 233
 234 /* Subscribes to an existing folder */
 235 function sqimap_subscribe ($imap_stream, $mailbox) {
 236     $read_ary = sqimap_run_command($imap_stream, "SUBSCRIBE \"$mailbox\"",
 237                                    true, $response, $message);
 238 }
 239
 240 /* Unsubscribes to an existing folder */
 241 function sqimap_unsubscribe ($imap_stream, $mailbox) {
 242     global $imap_server_type;
 243     $read_ary = sqimap_run_command($imap_stream, "UNSUBSCRIBE \"$mailbox\"",
 244                                    true, $response, $message);
 245 }
 246
 247 /* Deletes the given folder */
 248 function sqimap_mailbox_delete ($imap_stream, $mailbox) {
 249     global $data_dir, $username;
 250     $read_ary = sqimap_run_command($imap_stream, "DELETE \"$mailbox\"",
 251                                    true, $response, $message);
 252     sqimap_unsubscribe ($imap_stream, $mailbox);
 253     do_hook_function("rename_or_delete_folder", $args = array($mailbox, 'delete', ''));
 254     removePref($data_dir, $username, "thread_$mailbox");
 255 }
 256
 257 /* Determines if the user is subscribed to the folder or not */
 258 function sqimap_mailbox_is_subscribed($imap_stream, $folder) {
 259     $boxesall = sqimap_mailbox_list ($imap_stream);
 260     foreach ($boxesall as $ref) {
 261         if ($ref['unformatted'] == $folder) {
 262             return true;
 263         }
 264     }
 265     return false;
 266 }
 267
 268 /* Renames a mailbox */
 269 function sqimap_mailbox_rename( $imap_stream, $old_name, $new_name ) {
 270     if ( $old_name != $new_name ) {
 271         global $delimiter, $imap_server_type, $data_dir, $username;
 272         if ( substr( $old_name, -1 ) == $delimiter  ) {
 273             $old_name = substr( $old_name, 0, strlen( $old_name ) - 1 );
 274             $new_name = substr( $new_name, 0, strlen( $new_name ) - 1 );
 275             $postfix = $delimiter;
 276         } else {
 277             $postfix = '';
 278         }
 279         $boxesall = sqimap_mailbox_list($imap_stream);
 280         $cmd = 'RENAME "' . quoteIMAP($old_name) . '" "' .  quoteIMAP($new_name) . '"';
 281         $data = sqimap_run_command($imap_stream, $cmd, true, $response, $message);
 282         sqimap_unsubscribe($imap_stream, $old_name.$postfix);
 283         $oldpref = getPref($data_dir, $username, "thread_".$old_name.$postfix);
 284         removePref($data_dir, $username, "thread_".$old_name.$postfix);
 285         sqimap_subscribe($imap_stream, $new_name.$postfix);
 286         setPref($data_dir, $username, "thread_".$new_name.$postfix, $oldpref);
 287         do_hook_function("rename_or_delete_folder",$args = array($old_name, 'rename', $new_name));
 288         $l = strlen( $old_name ) + 1;
 289         $p = 'unformatted';
 290         foreach ( $boxesall as $box ) {
 291             if ( substr( $box[$p], 0, $l ) == $old_name . $delimiter ) {
 292                 $new_sub = $new_name . $delimiter . substr($box[$p], $l);
 293                 if ($imap_server_type == 'cyrus') {
 294                     $cmd = 'RENAME "' . quoteIMAP($box[$p]) . '" "' .  quoteIMAP($new_sub) . '"';
 295                     $data = sqimap_run_command($imap_stream, $cmd, true,
 296                                                $response, $message);
 297                 }
 298                 sqimap_unsubscribe($imap_stream, $box[$p]);
 299                 $oldpref = getPref($data_dir, $username, "thread_".$box[$p]);
 300                 removePref($data_dir, $username, "thread_".$box[$p]);
 301                 sqimap_subscribe($imap_stream, $new_sub);
 302                 setPref($data_dir, $username, "thread_".$new_sub, $oldpref);
 303                 do_hook_function("rename_or_delete_folder",
 304                                  $args = array($box[$p], 'rename', $new_sub));
 305             }
 306         }
 307     }
 308 }
 309
 310 /*
 311  * Formats a mailbox into 4 parts for the $boxesall array
 312  *
 313  * The four parts are:
 314  *
 315  *     raw            - Raw LIST/LSUB response from the IMAP server
 316  *     formatted      - nicely formatted folder name
 317  *     unformatted    - unformatted, but with delimiter at end removed
 318  *     unformatted-dm - folder name as it appears in raw response
 319  *     unformatted-disp - unformatted without $folder_prefix
 320  */
 321 function sqimap_mailbox_parse ($line, $line_lsub) {
 322     global $folder_prefix, $delimiter;
 323
 324     /* Process each folder line */
 325     for ($g=0; $g < count($line); $g++) {
 326
 327         /* Store the raw IMAP reply */
 328         if (isset($line[$g])) {
 329             $boxesall[$g]["raw"] = $line[$g];
 330         }
 331         else {
 332             $boxesall[$g]["raw"] = '';
 333         }
 334
 335
 336         /* Count number of delimiters ($delimiter) in folder name */
 337         $mailbox = trim($line_lsub[$g]);
 338         $dm_count =  substr_count($mailbox, $delimiter);
 339         if (substr($mailbox, -1) == $delimiter) {
 340             /* If name ends in delimiter, decrement count by one */
 341             $dm_count--;
 342         }
 343
 344         /* Format folder name, but only if it's a INBOX.* or has a parent. */
 345         $boxesallbyname[$mailbox] = $g;
 346         $parentfolder = readMailboxParent($mailbox, $delimiter);
 347         if ( (strtolower(substr($mailbox, 0, 5)) == "inbox") ||
 348              (substr($mailbox, 0, strlen($folder_prefix)) == $folder_prefix) ||
 349              ( isset($boxesallbyname[$parentfolder]) &&
 350                (strlen($parentfolder) > 0) ) ) {
 351             $indent = $dm_count - ( substr_count($folder_prefix, $delimiter));
 352             if ($indent > 0) {
 353                 $boxesall[$g]['formatted']  = str_repeat('&nbsp;&nbsp;', $indent);
 354             }
 355             else {
 356                 $boxesall[$g]['formatted'] = '';
 357             }
 358             $boxesall[$g]['formatted'] .= imap_utf7_decode_local(readShortMailboxName($mailbox, $delimiter));
 359         }
 360         else {
 361             $boxesall[$g]['formatted']  = imap_utf7_decode_local($mailbox);
 362         }
 363
 364         $boxesall[$g]['unformatted-dm'] = $mailbox;
 365         if (substr($mailbox, -1) == $delimiter) {
 366             $mailbox = substr($mailbox, 0, strlen($mailbox) - 1);
 367         }
 368         $boxesall[$g]['unformatted'] = $mailbox;
 369         if (substr($mailbox,0,strlen($folder_prefix))==$folder_prefix) {
 370             $mailbox = substr($mailbox, strlen($folder_prefix));
 371         }
 372         $boxesall[$g]['unformatted-disp'] = $mailbox;
 373         $boxesall[$g]['id'] = $g;
 374
 375         $boxesall[$g]['flags'] = array();
 376         if (isset($line[$g])) {
 377             ereg("\(([^)]*)\)",$line[$g],$regs);
 378             $flags = trim(strtolower(str_replace('\\', '',$regs[1])));
 379             if ($flags) {
 380                 $boxesall[$g]['flags'] = explode(' ', $flags);
 381             }
 382         }
 383     }
 384
 385     return $boxesall;
 386 }
 387
 388 /*
 389  * Sorting function used to sort mailbox names.
 390  *     + Original patch from dave_michmerhuizen@yahoo.com
 391  *     + Allows case insensitivity when sorting folders
 392  *     + Takes care of the delimiter being sorted to the end, causing
 393  *       subfolders to be listed in below folders that are prefixed
 394  *       with their parent folders name.
 395  *
 396  *       For example: INBOX.foo, INBOX.foobar, and INBOX.foo.bar
 397  *       Without special sort function: foobar between foo and foo.bar
 398  *       With special sort function: foobar AFTER foo and foo.bar :)
 399  */
 400 function user_strcasecmp($a, $b) {
 401     global $delimiter;
 402
 403     /* Calculate the length of some strings. */
 404     $a_length = strlen($a);
 405     $b_length = strlen($b);
 406     $min_length = min($a_length, $b_length);
 407     $delimiter_length = strlen($delimiter);
 408
 409     /* Set the initial result value. */
 410     $result = 0;
 411
 412     /* Check the strings... */
 413     for ($c = 0; $c < $min_length; ++$c) {
 414         $a_del = substr($a, $c, $delimiter_length);
 415         $b_del = substr($b, $c, $delimiter_length);
 416
 417         if (($a_del == $delimiter) && ($b_del == $delimiter)) {
 418             $result = 0;
 419         } else if (($a_del == $delimiter) && ($b_del != $delimiter)) {
 420             $result = -1;
 421         } else if (($a_del != $delimiter) && ($b_del == $delimiter)) {
 422             $result = 1;
 423         } else {
 424             $result = strcasecmp($a{$c}, $b{$c});
 425         }
 426
 427         if ($result != 0) {
 428             break;
 429         }
 430     }
 431
 432     /* If one string is a prefix of the other... */
 433     if ($result == 0) {
 434         if ($a_length < $b_length) {
 435             $result = -1;
 436         } else if ($a_length > $b_length) {
 437             $result = 1;
 438         }
 439     }
 440
 441     return $result;
 442 }
 443
 444
 445 /*
 446  * Returns sorted mailbox lists in several different ways.
 447  * See comment on sqimap_mailbox_parse() for info about the returned array.
 448  */
 449 function sqimap_mailbox_list($imap_stream) {
 450     global $default_folder_prefix;
 451
 452     if ( !isset( $boxesnew ) ) {
 453
 454         global $data_dir, $username, $list_special_folders_first,
 455                $folder_prefix, $trash_folder, $sent_folder, $draft_folder,
 456                $move_to_trash, $move_to_sent, $save_as_draft,
 457                $delimiter, $noselect_fix_enable;
 458
 459         $inbox_in_list = false;
 460         $inbox_subscribed = false;
 461
 462         require_once('../src/load_prefs.php');
 463         require_once('../functions/array.php');
 464
 465     if ($noselect_fix_enable) {
 466         $lsub_args = "LSUB \"$folder_prefix\" \"*%\"";
 467     }
 468     else {
 469         $lsub_args = "LSUB \"$folder_prefix\" \"*\"";
 470     }
 471         /* LSUB array */
 472         $lsub_ary = sqimap_run_command ($imap_stream, $lsub_args,
 473                                         true, $response, $message);
 474
 475
 476         /*
 477          * Section about removing the last element was removed
 478          * We don't return "* OK" anymore from sqimap_read_data
 479          */
 480
 481         $sorted_lsub_ary = array();
 482         for ($i=0;$i < count($lsub_ary); $i++) {
 483             /*
 484              * Workaround for EIMS
 485              * Doesn't work if the mailbox name is multiple lines
 486              */
 487             if (isset($lsub_ary[$i + 1]) &&
 488                 ereg("^(\\* [A-Z]+.*)\\{[0-9]+\\}([ \n\r\t]*)$",
 489                      $lsub_ary[$i], $regs)) {
 490                 $i ++;
 491                 $lsub_ary[$i] = $regs[1] . '"' . addslashes(trim($lsub_ary[$i])) . '"' . $regs[2];
 492             }
 493             $temp_mailbox_name = find_mailbox_name($lsub_ary[$i]);
 494             $sorted_lsub_ary[] = $temp_mailbox_name;
 495             if (strtoupper($temp_mailbox_name) == 'INBOX') {
 496                 $inbox_subscribed = true;
 497             }
 498         }
 499         $new_ary = array();
 500         for ($i=0; $i < count($sorted_lsub_ary); $i++) {
 501             if (!in_array($sorted_lsub_ary[$i], $new_ary)) {
 502                 $new_ary[] = $sorted_lsub_ary[$i];
 503             }
 504         }
 505         $sorted_lsub_ary = $new_ary;
 506         if (isset($sorted_lsub_ary)) {
 507             usort($sorted_lsub_ary, 'user_strcasecmp');
 508         }
 509
 510         /* LIST array */
 511         $sorted_list_ary = array();
 512         for ($i=0; $i < count($sorted_lsub_ary); $i++) {
 513             if (substr($sorted_lsub_ary[$i], -1) == $delimiter) {
 514                 $mbx = substr($sorted_lsub_ary[$i], 0, strlen($sorted_lsub_ary[$i])-1);
 515             }
 516             else {
 517                 $mbx = $sorted_lsub_ary[$i];
 518             }
 519
 520             $read = sqimap_run_command ($imap_stream, "LIST \"\" \"$mbx\"",
 521                                         true, $response, $message);
 522             /* Another workaround for EIMS */
 523             if (isset($read[1]) &&
 524                 ereg("^(\\* [A-Z]+.*)\\{[0-9]+\\}([ \n\r\t]*)$",
 525                      $read[0], $regs)) {
 526                 $read[0] = $regs[1] . '"' . addslashes(trim($read[1])) . '"' . $regs[2];
 527             }
 528
 529             if (isset($sorted_list_ary[$i])) {
 530                 $sorted_list_ary[$i] = '';
 531             }
 532
 533             if (isset($read[0])) {
 534                 $sorted_list_ary[$i] = $read[0];
 535             }
 536             else {
 537                 $sorted_list_ary[$i] = '';
 538             }
 539
 540             if (isset($sorted_list_ary[$i]) &&
 541                 strtoupper(find_mailbox_name($sorted_list_ary[$i])) == 'INBOX') {
 542                 $inbox_in_list = true;
 543             }
 544         }
 545
 546         /*
 547          * Just in case they're not subscribed to their inbox,
 548          * we'll get it for them anyway
 549          */
 550         if (!$inbox_subscribed || !$inbox_in_list) {
 551             $inbox_ary = sqimap_run_command ($imap_stream, "LIST \"\" \"INBOX\"",
 552                                              true, $response, $message);
 553             /* Another workaround for EIMS */
 554             if (isset($inbox_ary[1]) &&
 555                 ereg("^(\\* [A-Z]+.*)\\{[0-9]+\\}([ \n\r\t]*)$",
 556                      $inbox_ary[0], $regs)) {
 557                 $inbox_ary[0] = $regs[1] . '"' . addslashes(trim($inbox_ary[1])) .
 558                     '"' . $regs[2];
 559             }
 560
 561             $sorted_list_ary[] = $inbox_ary[0];
 562             $sorted_lsub_ary[] = find_mailbox_name($inbox_ary[0]);
 563         }
 564
 565         $boxesall = sqimap_mailbox_parse ($sorted_list_ary, $sorted_lsub_ary);
 566
 567         /* Now, lets sort for special folders */
 568         $boxesnew = $used = array();
 569
 570         /* Find INBOX */
 571         foreach ( $boxesall as $k => $box ) {
 572             if ( strtolower($box['unformatted']) == 'inbox') {
 573                 $boxesnew[] = $box;
 574                 $used[$k] = true;
 575             } else {
 576                 $used[$k] = false;
 577             }
 578         }
 579         /* List special folders and their subfolders, if requested. */
 580         if ($list_special_folders_first) {
 581             foreach ( $boxesall as $k => $box ) {
 582                 if ( !$used[$k] && isSpecialMailbox( $box['unformatted'] ) ) {
 583                     $boxesnew[] = $box;
 584                     $used[$k] = true;
 585                 }
 586                 $spec_sub = str_replace('&nbsp;', '', $box['formatted']);
 587                 $spec_sub = preg_replace("/(\*|\[|\]|\(|\)|\?|\+|\{|\}|\^|\\$)/", '\\\\'.'\\1', $spec_sub);
 588
 589                /* In case of problems with preg
 590                   here is a ereg version
 591                  if (!$used[$k] && ereg("^$default_folder_prefix(Sent|Drafts|Trash).{1}$spec_sub$", $box['unformatted']) ) { */
 592
 593                 if (!$used[$k] && preg_match("?^$default_folder_prefix(Sent|Drafts|Trash).{1}$spec_sub$?", $box['unformatted']) ) {
 594                     $boxesnew[] = $box;
 595                     $used[$k] = true;
 596                 }
 597             }
 598
 599         }
 600         /* Rest of the folders */
 601         foreach ( $boxesall as $k => $box ) {
 602             if ( !$used[$k] ) {
 603                 $boxesnew[] = $box;
 604             }
 605         }
 606     }
 607     return $boxesnew;
 608 }
 609
 610 /*
 611  *  Returns a list of all folders, subscribed or not
 612  */
 613 function sqimap_mailbox_list_all($imap_stream) {
 614     global $list_special_folders_first, $folder_prefix, $delimiter;
 615
 616     require_once('../functions/array.php');
 617
 618     $ssid = sqimap_session_id();
 619     $lsid = strlen( $ssid );
 620     fputs ($imap_stream, $ssid . " LIST \"$folder_prefix\" *\r\n");
 621     $read_ary = sqimap_read_data ($imap_stream, $ssid, true, $response, $message);
 622     $g = 0;
 623     $phase = 'inbox';
 624
 625     for ($i = 0; $i < count($read_ary); $i++) {
 626         /* Another workaround for EIMS */
 627         if (isset($read_ary[$i + 1]) &&
 628             ereg("^(\\* [A-Z]+.*)\\{[0-9]+\\}([ \n\r\t]*)$",
 629                  $read_ary[$i], $regs)) {
 630             $i ++;
 631             $read_ary[$i] = $regs[1] . '"' . addslashes(trim($read_ary[$i])) . '"' . $regs[2];
 632         }
 633         if (substr($read_ary[$i], 0, $lsid) != $ssid ) {
 634
 635             /* Store the raw IMAP reply */
 636             $boxes[$g]['raw'] = $read_ary[$i];
 637
 638             /* Count number of delimiters ($delimiter) in folder name */
 639             $mailbox = find_mailbox_name($read_ary[$i]);
 640             $dm_count =  substr_count($mailbox, $delimiter);
 641             if (substr($mailbox, -1) == $delimiter) {
 642                 /* If name ends in delimiter - decrement count by one */
 643                 $dm_count--;
 644             }
 645
 646             /* Format folder name, but only if it's a INBOX.* or has a parent. */
 647             $boxesallbyname[$mailbox] = $g;
 648             $parentfolder = readMailboxParent($mailbox, $delimiter);
 649             if((eregi('^inbox'.quotemeta($delimiter), $mailbox)) ||
 650                (ereg('^'.$folder_prefix, $mailbox)) ||
 651                ( isset($boxesallbyname[$parentfolder]) && (strlen($parentfolder) > 0) ) ) {
 652                 if ($dm_count) {
 653                     $boxes[$g]['formatted']  = str_repeat('&nbsp;&nbsp;', $dm_count);
 654                 }
 655                 else {
 656                     $boxes[$g]['formatted'] = '';
 657                 }
 658                 $boxes[$g]['formatted'] .= imap_utf7_decode_local(readShortMailboxName($mailbox, $delimiter));
 659             }
 660             else {
 661                 $boxes[$g]['formatted']  = imap_utf7_decode_local($mailbox);
 662             }
 663
 664             $boxes[$g]['unformatted-dm'] = $mailbox;
 665             if (substr($mailbox, -1) == $delimiter) {
 666                 $mailbox = substr($mailbox, 0, strlen($mailbox) - 1);
 667             }
 668             $boxes[$g]['unformatted'] = $mailbox;
 669             $boxes[$g]['unformatted-disp'] = ereg_replace('^' . $folder_prefix, '', $mailbox);
 670             $boxes[$g]['id'] = $g;
 671
 672             /* Now lets get the flags for this mailbox */
 673             $read_mlbx = sqimap_run_command ($imap_stream, "LIST \"\" \"$mailbox\"",
 674                                              true, $response, $message);
 675
 676             /* Another workaround for EIMS */
 677             if (isset($read_mlbx[1]) &&
 678                 ereg("^(\\* [A-Z]+.*)\\{[0-9]+\\}([ \n\r\t]*)$", $read_mlbx[0], $regs)) {
 679                 $read_mlbx[0] = $regs[1] . '"' . addslashes(trim($read_mlbx[1])) . '"' . $regs[2];
 680             }
 681
 682             $flags = substr($read_mlbx[0], strpos($read_mlbx[0], '(')+1);
 683             $flags = substr($flags, 0, strpos($flags, ')'));
 684             $flags = str_replace('\\', '', $flags);
 685             $flags = trim(strtolower($flags));
 686             if ($flags) {
 687                 $boxes[$g]['flags'] = explode(' ', $flags);
 688             } else {
 689                 $boxes[$g]['flags'] = array();
 690             }
 691         }
 692         $g++;
 693     }
 694     if(is_array($boxes)) {
 695         $boxes = ary_sort ($boxes, 'unformatted', 1);
 696     }
 697
 698     return $boxes;
 699 }
 700
 701 function sqimap_mailbox_tree($imap_stream) {
 702     global $boxesnew, $default_folder_prefix, $unseen_notify, $unseen_type;
 703     if ( !isset( $boxesnew ) ) {
 704
 705         global $data_dir, $username, $list_special_folders_first,
 706                $folder_prefix, $delimiter, $trash_folder, $move_to_trash;
 707
 708
 709         $inbox_in_list = false;
 710         $inbox_subscribed = false;
 711
 712         require_once('../src/load_prefs.php');
 713         require_once('../functions/array.php');
 714
 715         /* LSUB array */
 716         $lsub_ary = sqimap_run_command ($imap_stream, "LSUB \"$folder_prefix\" \"*\"",
 717                                         true, $response, $message);
 718
 719         /*
 720          * Section about removing the last element was removed
 721          * We don't return "* OK" anymore from sqimap_read_data
 722          */
 723         $sorted_lsub_ary = array();
 724         $cnt = count($lsub_ary);
 725         for ($i=0;$i < $cnt; $i++) {
 726             /*
 727              * Workaround for EIMS
 728              * Doesn't work if the mailbox name is multiple lines
 729              */
 730             if (isset($lsub_ary[$i + 1]) &&
 731                 ereg("^(\\* [A-Z]+.*)\\{[0-9]+\\}([ \n\r\t]*)$",
 732                      $lsub_ary[$i], $regs)) {
 733                 $i ++;
 734                 $lsub_ary[$i] = $regs[1] . '"' . addslashes(trim($lsub_ary[$i])) . '"' . $regs[2];
 735             }
 736
 737 //          if (preg_match("/^\*\s+LSUB\s+\((.*)\)\s+\"(.*)\"\s+\"?(.+(?=\")|.+).*$/",$lsub_ary[$i],$regs)) {
 738 //              $flag = $regs[1];
 739 //              $mbx = trim($regs[3]);
 740 //              $sorted_lsub_ary[] = array ('mbx' => $mbx, 'flag' => $flag);
 741 //          }
 742             $mbx = find_mailbox_name($lsub_ary[$i]);
 743             if (substr($mbx, -1) == $delimiter) {
 744                 $mbx = substr($mbx, 0, strlen($mbx) - 1);
 745             }
 746             $sorted_lsub_ary[] = array ('mbx' => $mbx, 'flag' => '');
 747         }
 748         array_multisort($sorted_lsub_ary, SORT_ASC, SORT_REGULAR);
 749
 750         foreach ($sorted_lsub_ary as $mbx) {
 751             if ($mbx['mbx'] == 'INBOX') {
 752                 $inbox_in_list = true;
 753                 break;
 754             }
 755         }
 756
 757         /*
 758          * Just in case they're not subscribed to their inbox,
 759          * we'll get it for them anyway
 760          */
 761         if (!$inbox_in_list) {
 762             $inbox_ary = sqimap_run_command ($imap_stream, "LIST \"\" \"INBOX\"",
 763                                              true, $response, $message);
 764             /* Another workaround for EIMS */
 765             if (isset($inbox_ary[1]) &&
 766                 ereg("^(\\* [A-Z]+.*)\\{[0-9]+\\}([ \n\r\t]*)$",
 767                      $inbox_ary[0], $regs)) {
 768                 $inbox_ary[0] = $regs[1] . '"' . addslashes(trim($inbox_ary[1])) .
 769                     '"' . $regs[2];
 770             }
 771             $mbx = find_mailbox_name($inbox_ary[0]);
 772             if (substr($mbx, -1) == $delimiter) {
 773                 $mbx = substr($mbx, 0, strlen($mbx) - 1);
 774             }
 775             if ( $mbx == 'INBOX') {
 776                 $sorted_lsub_ary[] = array ('mbx' => $mbx, 'flag' => '');
 777                 sqimap_subscribe($imap_stream, 'INBOX');
 778             }
 779
 780 //          if (preg_match("/^\*\s+LIST\s+\((.*)\)\s+\"(.*)\"\s+\"?(.+(?=\")|.+).*$/",$inbox_ary[0],$regs)) {
 781 //              $flag = $regs[1];
 782 //              $mbx = trim($regs[3]);
 783 //              if (substr($mbx, -1) == $delimiter) {
 784 //                  $mbx = substr($mbx, 0, strlen($mbx) - 1);
 785 //              }
 786 //              $sorted_lsub_ary[] = array ('mbx' => $mbx, 'flag' => $flag);
 787 //          }
 788         }
 789         $cnt = count($sorted_lsub_ary);
 790         for ($i=0 ; $i < $cnt; $i++) {
 791             $mbx = $sorted_lsub_ary[$i]['mbx'];
 792             if (($unseen_notify == 2 && $mbx == 'INBOX')
 793                 || $unseen_notify == 3
 794                 || ($move_to_trash && ($mbx == $trash_folder))) {
 795                 $sorted_lsub_ary[$i]['unseen'] = sqimap_unseen_messages($imap_stream, $mbx);
 796                 if ($unseen_type == 2 || ($move_to_trash
 797                     && ($mbx == $trash_folder) )) {
 798                     $sorted_lsub_ary[$i]['nummessages'] = sqimap_get_num_messages($imap_stream, $mbx);
 799                 }
 800                 if ($mbx == $trash_folder) {
 801                     $sorted_lsub_ary[$i]['nummessages'] = sqimap_get_num_messages($imap_stream, $mbx);
 802                 }
 803             }
 804         }
 805         $boxesnew = sqimap_fill_mailbox_tree($sorted_lsub_ary);
 806     return $boxesnew;
 807     }
 808 }
 809
 810
 811 function sqimap_fill_mailbox_tree($mbx_ary, $mbxs=false) {
 812     global $data_dir, $username, $list_special_folders_first,
 813            $folder_prefix, $trash_folder, $sent_folder, $draft_folder,
 814            $move_to_trash, $move_to_sent, $save_as_draft,
 815            $delimiter;
 816
 817     $special_folders = array ('INBOX', $sent_folder, $draft_folder, $trash_folder);
 818
 819     /* create virtual root node */
 820     $mailboxes= new mailboxes();
 821     $mailboxes->is_root = true;
 822     $trail_del = false;
 823     if (isset($folder_prefix) && $folder_prefix != '') {
 824         $start = substr_count($folder_prefix,$delimiter);
 825         if (strrpos($folder_prefix, $delimiter) == (strlen($folder_prefix)-1)) {
 826             $trail_del = true;
 827             $mailboxes->mailboxname_full = substr($folder_prefix,0, (strlen($folder_prefix)-1));
 828         } else {
 829             $mailboxes->mailboxname_full = $folder_prefix;
 830             $start++;
 831         }
 832         $mailboxes->mailboxname_sub = $mailboxes->mailboxname_full;
 833     } else $start = 0;
 834     $cnt =  count($mbx_ary);
 835     for ($i=0; $i < $cnt; $i++) {
 836        if ($mbx_ary[$i]['mbx'] !='' ) {
 837             $mbx = new mailboxes();
 838             $mailbox = $mbx_ary[$i]['mbx'];
 839             switch ($mailbox) {
 840                 case 'INBOX':
 841                     $mbx->is_inbox = true;
 842                     $mbx->is_special = true;
 843                     break;
 844                 case $trash_folder:
 845                     $mbx->is_trash = true;
 846                     $mbx->is_special = true;
 847                     break;
 848                 case $sent_folder:
 849                     $mbx->is_sent = true;
 850                     $mbx->is_special = true;
 851                     break;
 852                 case $draft_folder:
 853                     $mbx->is_draft = true;
 854                     $mbx->is_special = true;
 855                     break;
 856             }
 857
 858             if (isset($mbx_ary[$i]['unseen'])) {
 859                 $mbx->unseen = $mbx_ary[$i]['unseen'];
 860             }
 861             if (isset($mbx_ary[$i]['nummessages'])) {
 862                 $mbx->total = $mbx_ary[$i]['nummessages'];
 863             }
 864
 865             $r_del_pos = strrpos($mbx_ary[$i]['mbx'], $delimiter);
 866             if ($r_del_pos) {
 867                 $mbx->mailboxname_sub = substr($mbx_ary[$i]['mbx'],$r_del_pos+1);
 868             } else {   /* mailbox is root folder */
 869                 $mbx->mailboxname_sub = $mbx_ary[$i]['mbx'];
 870             }
 871             $mbx->mailboxname_full = $mbx_ary[$i]['mbx'];
 872             $mailboxes->addMbx($mbx, $delimiter, $start, $list_special_folders_first);
 873         }
 874     }
 875
 876     return $mailboxes;
 877 }
 878
 879
 880 ?>