functions/imap_mailbox.php

   1 <?php
   2
   3 /**
   4  * imap_mailbox.php
   5  *
   6  * Copyright (c) 1999-2003 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(SM_PATH . 'functions/imap_utf7_local.php');
  14
  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, $c = count($ary)-1; $i < $c; $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         $mbx_parent->mbxs[] = $mbx;
  51         if ($mbx->is_special && $specialfirst) {
  52             usort($mbx_parent->mbxs, 'sortSpecialMbx');
  53         }
  54     }
  55 }
  56
  57 function sortSpecialMbx($a, $b) {
  58     if ($a->is_inbox) {
  59         $acmp = '0'. $a->mailboxname_full;
  60     } else if ($a->is_special) {
  61         $acmp = '1'. $a->mailboxname_full;
  62     } else {
  63         $acmp = '2' . $a->mailboxname_full;
  64     }
  65     if ($b->is_inbox) {
  66         $bcmp = '0'. $b->mailboxname_full;
  67     }else if ($b->is_special) {
  68         $bcmp = '1' . $b->mailboxname_full;
  69     } else {
  70         $bcmp = '2' . $b->mailboxname_full;
  71     }
  72     if ($acmp == $bcmp) return 0;
  73     return ($acmp > $bcmp) ? 1: -1;
  74 }
  75
  76 function find_mailbox_name ($mailbox) {
  77     if (preg_match('/\*.+\"([^\r\n\"]*)\"[\s\r\n]*$/', $mailbox, $regs))
  78         return $regs[1];
  79     if (ereg(" *\"([^\r\n\"]*)\"[ \r\n]*$", $mailbox, $regs))
  80         return $regs[1];
  81     ereg(" *([^ \r\n\"]*)[ \r\n]*$",$mailbox,$regs);
  82     return $regs[1];
  83 }
  84
  85 function check_is_noselect ($lsub_line) {
  86     return preg_match("/^\* LSUB \([^\)]*\\Noselect[^\)]*\)/i", $lsub_line);
  87 }
  88
  89 /**
  90  * If $haystack is a full mailbox name, and $needle is the mailbox
  91  * separator character, returns the second last part of the full
  92  * mailbox name (i.e. the mailbox's parent mailbox)
  93  */
  94 function readMailboxParent($haystack, $needle) {
  95     if ($needle == '') {
  96         $ret = '';
  97     } else {
  98         $parts = explode($needle, $haystack);
  99         $elem = array_pop($parts);
 100         while ($elem == '' && count($parts)) {
 101             $elem = array_pop($parts);
 102         }
 103         $ret = join($needle, $parts);
 104     }
 105     return( $ret );
 106 }
 107
 108
 109 function isBoxBelow( $box2, $box1 ) {
 110 global $delimiter, $folder_prefix, $imap_server_type;
 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                 if (substr($box2,0,strlen($box1)) == $box1) {
 119                         return true;
 120                 }
 121                 $boxs = $box2 . $delimiter;
 122                 /* Skip next second delimiter */
 123                 $i = strpos( $box1, $delimiter );
 124                 $i = strpos( $box1, $delimiter, $i + 1  );
 125                 if ( $i === false ) {
 126                         $i = strlen( $box2 );
 127                 } else {
 128                         $i++;
 129                 }
 130         }
 131         return ( substr( $box1, 0, $i ) == substr( $boxs, 0, $i ) );
 132 }
 133
 134 /* Defines special mailboxes */
 135 function isSpecialMailbox( $box ) {
 136     global $trash_folder, $sent_folder, $draft_folder,
 137            $move_to_trash, $move_to_sent, $save_as_draft;
 138
 139     $ret = ( (strtolower($box) == 'inbox') ||
 140              ( $move_to_trash && $trash_folder && isBoxBelow( $box, $trash_folder )) ||
 141              ( $move_to_sent  && $sent_folder  && isBoxBelow( $box, $sent_folder  )) ||
 142              ($save_as_draft && $box == $draft_folder ) );
 143
 144     if ( !$ret ) {
 145         $ret = do_hook_function( 'special_mailbox', $box );
 146     }
 147     return $ret;
 148 }
 149
 150 /* Expunges a mailbox */
 151 function sqimap_mailbox_expunge ($imap_stream, $mailbox, $handle_errors = true, $id='') {
 152     global $uid_support;
 153     if ($id) {
 154         if (is_array($id)) {
 155             $id = sqimap_message_list_squisher($id);
 156         }
 157         $id = ' '.$id;
 158         $uid = $uid_support;
 159     } else {
 160         $uid = false;
 161     }
 162     $read = sqimap_run_command($imap_stream, 'EXPUNGE'.$id, $handle_errors,
 163                                $response, $message, $uid);
 164     $cnt = 0;
 165
 166     if (is_array($read)) {
 167         foreach ($read as $r) {
 168             if (preg_match('/^\*\s[0-9]+\sEXPUNGE/AUi',$r,$regs)) {
 169                 $cnt++;
 170             }
 171         }
 172     }
 173     return $cnt;
 174 }
 175
 176 /* Checks whether or not the specified mailbox exists */
 177 function sqimap_mailbox_exists ($imap_stream, $mailbox) {
 178     if (!isset($mailbox)) {
 179         return false;
 180     }
 181     $mbx = sqimap_run_command($imap_stream, "LIST \"\" \"$mailbox\"",
 182                               true, $response, $message);
 183     return isset($mbx[0]);
 184 }
 185
 186 /* Selects a mailbox */
 187 function sqimap_mailbox_select ($imap_stream, $mailbox) {
 188     global $auto_expunge;
 189
 190     if ($mailbox == 'None') {
 191         return;
 192     }
 193
 194     $read = sqimap_run_command($imap_stream, "SELECT \"$mailbox\"",
 195                                true, $response, $message);
 196     $result = array();
 197     for ($i = 0, $cnt = count($read); $i < $cnt; $i++) {
 198         if (preg_match('/^\*\s+OK\s\[(\w+)\s(\w+)\]/',$read[$i], $regs)) {
 199             $result[strtoupper($regs[1])] = $regs[2];
 200         } else if (preg_match('/^\*\s([0-9]+)\s(\w+)/',$read[$i], $regs)) {
 201             $result[strtoupper($regs[2])] = $regs[1];
 202         } else {
 203             if (preg_match("/PERMANENTFLAGS(.*)/i",$read[$i], $regs)) {
 204                 $regs[1]=trim(preg_replace (  array ("/\(/","/\)/","/\]/") ,'', $regs[1])) ;
 205                 $result['PERMANENTFLAGS'] = $regs[1];
 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
 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     $read_ary = sqimap_run_command($imap_stream, "UNSUBSCRIBE \"$mailbox\"",
 243                                    true, $response, $message);
 244 }
 245
 246 /* Deletes the given folder */
 247 function sqimap_mailbox_delete ($imap_stream, $mailbox) {
 248     global $data_dir, $username;
 249     $read_ary = sqimap_run_command($imap_stream, "DELETE \"$mailbox\"",
 250                                    true, $response, $message);
 251     sqimap_unsubscribe ($imap_stream, $mailbox);
 252     do_hook_function('rename_or_delete_folder', $args = array($mailbox, 'delete', ''));
 253     removePref($data_dir, $username, "thread_$mailbox");
 254 }
 255
 256 /* Determines if the user is subscribed to the folder or not */
 257 function sqimap_mailbox_is_subscribed($imap_stream, $folder) {
 258     $boxesall = sqimap_mailbox_list ($imap_stream);
 259     foreach ($boxesall as $ref) {
 260         if ($ref['unformatted'] == $folder) {
 261             return true;
 262         }
 263     }
 264     return false;
 265 }
 266
 267 /* Renames a mailbox */
 268 function sqimap_mailbox_rename( $imap_stream, $old_name, $new_name ) {
 269     if ( $old_name != $new_name ) {
 270         global $delimiter, $imap_server_type, $data_dir, $username;
 271         if ( substr( $old_name, -1 ) == $delimiter  ) {
 272             $old_name = substr( $old_name, 0, strlen( $old_name ) - 1 );
 273             $new_name = substr( $new_name, 0, strlen( $new_name ) - 1 );
 274             $postfix = $delimiter;
 275         } else {
 276             $postfix = '';
 277         }
 278
 279         $boxesall = sqimap_mailbox_list($imap_stream);
 280         $cmd = 'RENAME "' . $old_name . '" "' . $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
 291         foreach ($boxesall as $box) {
 292             if (substr($box[$p], 0, $l) == $old_name . $delimiter) {
 293                 $new_sub = $new_name . $delimiter . substr($box[$p], $l);
 294                 if ($imap_server_type == 'cyrus') {
 295                     $cmd = 'RENAME "' . $box[$p] . '" "' . $new_sub . '"';
 296                     $data = sqimap_run_command($imap_stream, $cmd, true,
 297                                                $response, $message);
 298                 }
 299                 sqimap_unsubscribe($imap_stream, $box[$p]);
 300                 $oldpref = getPref($data_dir, $username, 'thread_'.$box[$p]);
 301                 removePref($data_dir, $username, 'thread_'.$box[$p]);
 302                 sqimap_subscribe($imap_stream, $new_sub);
 303                 setPref($data_dir, $username, 'thread_'.$new_sub, $oldpref);
 304                 do_hook_function('rename_or_delete_folder',
 305                                  $args = array($box[$p], 'rename', $new_sub));
 306             }
 307         }
 308     }
 309 }
 310
 311 /*
 312  * Formats a mailbox into 4 parts for the $boxesall array
 313  *
 314  * The four parts are:
 315  *
 316  *     raw            - Raw LIST/LSUB response from the IMAP server
 317  *     formatted      - nicely formatted folder name
 318  *     unformatted    - unformatted, but with delimiter at end removed
 319  *     unformatted-dm - folder name as it appears in raw response
 320  *     unformatted-disp - unformatted without $folder_prefix
 321  */
 322 function sqimap_mailbox_parse ($line, $line_lsub) {
 323     global $folder_prefix, $delimiter;
 324
 325     /* Process each folder line */
 326     for ($g = 0, $cnt = count($line); $g < $cnt; $g++) {
 327         /* Store the raw IMAP reply */
 328         if (isset($line[$g])) {
 329             $boxesall[$g]['raw'] = $line[$g];
 330         } else {
 331             $boxesall[$g]['raw'] = '';
 332         }
 333
 334         /* Count number of delimiters ($delimiter) in folder name */
 335         $mailbox  = trim($line_lsub[$g]);
 336         $dm_count = substr_count($mailbox, $delimiter);
 337         if (substr($mailbox, -1) == $delimiter) {
 338             /* If name ends in delimiter, decrement count by one */
 339             $dm_count--;
 340         }
 341
 342         /* Format folder name, but only if it's a INBOX.* or has a parent. */
 343         $boxesallbyname[$mailbox] = $g;
 344         $parentfolder = readMailboxParent($mailbox, $delimiter);
 345         if ( (strtolower(substr($mailbox, 0, 5)) == "inbox") ||
 346              (substr($mailbox, 0, strlen($folder_prefix)) == $folder_prefix) ||
 347              (isset($boxesallbyname[$parentfolder]) &&
 348               (strlen($parentfolder) > 0) ) ) {
 349             $indent = $dm_count - (substr_count($folder_prefix, $delimiter));
 350             if ($indent > 0) {
 351                 $boxesall[$g]['formatted'] = str_repeat('&nbsp;&nbsp;', $indent);
 352             } else {
 353                 $boxesall[$g]['formatted'] = '';
 354             }
 355             $boxesall[$g]['formatted'] .= imap_utf7_decode_local(readShortMailboxName($mailbox, $delimiter));
 356         } else {
 357             $boxesall[$g]['formatted']  = imap_utf7_decode_local($mailbox);
 358         }
 359
 360         $boxesall[$g]['unformatted-dm'] = $mailbox;
 361         if (substr($mailbox, -1) == $delimiter) {
 362             $mailbox = substr($mailbox, 0, strlen($mailbox) - 1);
 363         }
 364         $boxesall[$g]['unformatted'] = $mailbox;
 365         if (substr($mailbox,0,strlen($folder_prefix))==$folder_prefix) {
 366             $mailbox = substr($mailbox, strlen($folder_prefix));
 367         }
 368         $boxesall[$g]['unformatted-disp'] = $mailbox;
 369         $boxesall[$g]['id'] = $g;
 370
 371         $boxesall[$g]['flags'] = array();
 372         if (isset($line[$g])) {
 373             ereg("\(([^)]*)\)",$line[$g],$regs);
 374             $flags = trim(strtolower(str_replace('\\', '',$regs[1])));
 375             if ($flags) {
 376                 $boxesall[$g]['flags'] = explode(' ', $flags);
 377             }
 378         }
 379     }
 380     return $boxesall;
 381 }
 382
 383 /*
 384  * Sorting function used to sort mailbox names.
 385  *     + Original patch from dave_michmerhuizen@yahoo.com
 386  *     + Allows case insensitivity when sorting folders
 387  *     + Takes care of the delimiter being sorted to the end, causing
 388  *       subfolders to be listed in below folders that are prefixed
 389  *       with their parent folders name.
 390  *
 391  *       For example: INBOX.foo, INBOX.foobar, and INBOX.foo.bar
 392  *       Without special sort function: foobar between foo and foo.bar
 393  *       With special sort function: foobar AFTER foo and foo.bar :)
 394  */
 395 function user_strcasecmp($a, $b) {
 396     global $delimiter;
 397
 398     return  strnatcasecmp($a, $b);
 399
 400     /* Calculate the length of some strings. */
 401     $a_length = strlen($a);
 402     $b_length = strlen($b);
 403     $min_length = min($a_length, $b_length);
 404     $delimiter_length = strlen($delimiter);
 405
 406     /* Set the initial result value. */
 407     $result = 0;
 408     /* Check the strings... */
 409     for ($c = 0; $c < $min_length; ++$c) {
 410         $a_del = substr($a, $c, $delimiter_length);
 411         $b_del = substr($b, $c, $delimiter_length);
 412
 413         if (($a_del == $delimiter) && ($b_del == $delimiter)) {
 414             $result = 0;
 415         } else if (($a_del == $delimiter) && ($b_del != $delimiter)) {
 416             $result = -1;
 417         } else if (($a_del != $delimiter) && ($b_del == $delimiter)) {
 418             $result = 1;
 419         } else {
 420             $result = strcasecmp($a{$c}, $b{$c});
 421         }
 422
 423         if ($result != 0) {
 424             break;
 425         }
 426     }
 427
 428     /* If one string is a prefix of the other... */
 429     if ($result == 0) {
 430         if ($a_length < $b_length) {
 431             $result = -1;
 432         } else if ($a_length > $b_length) {
 433             $result = 1;
 434         }
 435     }
 436
 437     return $result;
 438 }
 439
 440 /*
 441  * Returns list of options (to be echoed into select statement
 442  * based on available mailboxes and separators
 443  * Caller should surround options with <SELECT..> </SELECT> and
 444  * any formatting.
 445  *   $imap_stream - $imapConnection to query for mailboxes
 446  *   $show_selected - array containing list of mailboxes to pre-select (0 if none)
 447  *   $folder_skip - array of folders to keep out of option list (compared in lower)
 448  *   $boxes - list of already fetched boxes (for places like folder panel, where
 449  *            you know these options will be shown 3 times in a row.. (most often unset).
 450  */
 451 function sqimap_mailbox_option_list($imap_stream, $show_selected = 0, $folder_skip = 0, $boxes = 0 ) {
 452     global $username, $data_dir;
 453     $mbox_options = '';
 454
 455     $shorten_box_names = getPref($data_dir, $username, 'mailbox_select_style', SMPREF_OFF);
 456
 457     if ($boxes == 0) {
 458         $boxes = sqimap_mailbox_list($imap_stream);
 459     }
 460     foreach ($boxes as $boxes_part) {
 461         if (!in_array('noselect', $boxes_part['flags'])) {
 462             $box = $boxes_part['unformatted'];
 463             $lowerbox = strtolower($box);
 464
 465             if ($folder_skip != 0 && in_array($lowerbox, $folder_skip) ) {
 466                 continue;
 467             }
 468             if ($lowerbox == 'inbox'){
 469                 $box2 = _("INBOX");
 470             } else if ( $shorten_box_names == 2 ) {  /* delimited, style = 2 */
 471                 $box2 = str_replace('&nbsp;&nbsp;', '.&nbsp;', $boxes_part['formatted']);
 472             } else if ( $shorten_box_names == 1 ) {     /* indent, style = 1 */
 473                 $box2 = $boxes_part['formatted'];
 474             } else  {                      /* default, long names, style = 0 */
 475                 $box2 = str_replace(' ', '&nbsp;', imap_utf7_decode_local($boxes_part['unformatted-disp']));
 476             }
 477             if ($show_selected != 0 && in_array($lowerbox, $show_selected) ) {
 478                 $mbox_options .= '<OPTION VALUE="'.$box.'" SELECTED>'.$box2.'</OPTION>' . "\n";
 479             } else {
 480                 $mbox_options .= '<OPTION VALUE="'.$box.'">'.$box2.'</OPTION>' . "\n";
 481             }
 482         }
 483     }
 484     return $mbox_options;
 485 }
 486
 487 /*
 488  * Returns sorted mailbox lists in several different ways.
 489  * See comment on sqimap_mailbox_parse() for info about the returned array.
 490  */
 491 function sqimap_mailbox_list($imap_stream) {
 492     global $default_folder_prefix;
 493
 494     if (!isset($boxesnew)) {
 495         global $data_dir, $username, $list_special_folders_first,
 496                $folder_prefix, $trash_folder, $sent_folder, $draft_folder,
 497                $move_to_trash, $move_to_sent, $save_as_draft,
 498                $delimiter, $noselect_fix_enable;
 499
 500         $inbox_in_list = false;
 501         $inbox_subscribed = false;
 502
 503         require_once(SM_PATH . 'include/load_prefs.php');
 504
 505         if ($noselect_fix_enable) {
 506             $lsub_args = "LSUB \"$folder_prefix\" \"*%\"";
 507         } else {
 508             $lsub_args = "LSUB \"$folder_prefix\" \"*\"";
 509         }
 510         /* LSUB array */
 511         $lsub_ary = sqimap_run_command ($imap_stream, $lsub_args,
 512                                         true, $response, $message);
 513
 514
 515         /*
 516          * Section about removing the last element was removed
 517          * We don't return "* OK" anymore from sqimap_read_data
 518          */
 519
 520         $sorted_lsub_ary = array();
 521         for ($i = 0, $cnt = count($lsub_ary);$i < $cnt; $i++) {
 522             /*
 523              * Workaround for EIMS
 524              * Doesn't work if the mailbox name is multiple lines
 525              */
 526             if (isset($lsub_ary[$i + 1]) &&
 527                 ereg("^(\\* [A-Z]+.*)\\{[0-9]+\\}([ \n\r\t]*)$",
 528                      $lsub_ary[$i], $regs)) {
 529                 $i++;
 530                 $lsub_ary[$i] = $regs[1] . '"' . addslashes(trim($lsub_ary[$i])) . '"' . $regs[2];
 531             }
 532             $temp_mailbox_name = find_mailbox_name($lsub_ary[$i]);
 533             $sorted_lsub_ary[] = $temp_mailbox_name;
 534             if (strtoupper($temp_mailbox_name) == 'INBOX') {
 535                 $inbox_subscribed = true;
 536             }
 537         }
 538         $new_ary = array();
 539         for ($i = 0, $cnt = count($sorted_lsub_ary); $i < $cnt; $i++) {
 540             if (!in_array($sorted_lsub_ary[$i], $new_ary)) {
 541                 $new_ary[] = $sorted_lsub_ary[$i];
 542             }
 543         }
 544         $sorted_lsub_ary = $new_ary;
 545         if (isset($sorted_lsub_ary)) {
 546             usort($sorted_lsub_ary, 'user_strcasecmp');
 547         }
 548         $sorted_list_ary = $sorted_lsub_ary;
 549         /* LIST array */
 550 /*        $sorted_list_ary = array();
 551         for ($i=0; $i < count($sorted_lsub_ary); $i++) {
 552         if (false) {
 553             if (substr($sorted_lsub_ary[$i], -1) == $delimiter) {
 554                 $mbx = substr($sorted_lsub_ary[$i], 0, strlen($sorted_lsub_ary[$i])-1);
 555             }
 556             else {
 557                 $mbx = $sorted_lsub_ary[$i];
 558             }
 559
 560             $read = sqimap_run_command ($imap_stream, "LIST \"\" \"$mbx\"",
 561                                         true, $response, $message);
 562 */
 563             /* Another workaround for EIMS */
 564 /*
 565             if (isset($read[1]) &&
 566                 ereg("^(\\* [A-Z]+.*)\\{[0-9]+\\}([ \n\r\t]*)$",
 567                      $read[0], $regs)) {
 568                 $read[0] = $regs[1] . '"' . addslashes(trim($read[1])) . '"' . $regs[2];
 569             }
 570
 571             if (isset($sorted_list_ary[$i])) {
 572                 $sorted_list_ary[$i] = '';
 573             }
 574
 575             if (isset($read[0])) {
 576                 $sorted_list_ary[$i] = $read[0];
 577             }
 578             else {
 579                 $sorted_list_ary[$i] = '';
 580             }
 581
 582             if (isset($sorted_list_ary[$i]) &&
 583                 strtoupper(find_mailbox_name($sorted_list_ary[$i])) == 'INBOX') {
 584                 $inbox_in_list = true;
 585             }
 586         }
 587 */
 588 /*        $inbox_in_list = true; */
 589         /*
 590          * Just in case they're not subscribed to their inbox,
 591          * we'll get it for them anyway
 592          */
 593         if (!$inbox_subscribed) {/* || !$inbox_in_list) { */
 594             $inbox_ary = sqimap_run_command ($imap_stream, "LIST \"\" \"INBOX\"",
 595                                              true, $response, $message);
 596             /* Another workaround for EIMS */
 597             if (isset($inbox_ary[1]) &&
 598                 ereg("^(\\* [A-Z]+.*)\\{[0-9]+\\}([ \n\r\t]*)$",
 599                      $inbox_ary[0], $regs)) {
 600                 $inbox_ary[0] = $regs[1] . '"' . addslashes(trim($inbox_ary[1])) .
 601                                 '"' . $regs[2];
 602             }
 603
 604             $sorted_list_ary[] = $inbox_ary[0];
 605             $sorted_lsub_ary[] = find_mailbox_name($inbox_ary[0]);
 606         }
 607
 608         $boxesall = sqimap_mailbox_parse ($sorted_list_ary, $sorted_lsub_ary);
 609
 610         /* Now, lets sort for special folders */
 611         $boxesnew = $used = array();
 612
 613         /* Find INBOX */
 614         $cnt = count($boxesall);
 615         for($k = 0; $k < $cnt; $k++) {
 616             if (strtolower($boxesall[$k]['unformatted']) == 'inbox') {
 617                 $boxesnew[] = $boxesall[$k];
 618                 $used[$k] = true;
 619             } else {
 620                 $used[$k] = false;
 621             }
 622         }
 623         /* List special folders and their subfolders, if requested. */
 624         if ($list_special_folders_first) {
 625             for($k = 0; $k < $cnt; $k++) {
 626                 if (!$used[$k] && isSpecialMailbox($boxesall[$k]['unformatted'])) {
 627                     $boxesnew[] = $boxesall[$k];
 628                     $used[$k]   = true;
 629                 }
 630                 $spec_sub = str_replace('&nbsp;', '', $boxesall[$k]['formatted']);
 631                 $spec_sub = preg_replace("/(\*|\[|\]|\(|\)|\?|\+|\{|\}|\^|\\$)/", '\\\\'.'\\1', $spec_sub);
 632
 633                 /* In case of problems with preg
 634                    here is a ereg version
 635                 if (!$used[$k] && ereg("^$default_folder_prefix(Sent|Drafts|Trash).{1}$spec_sub$", $box['unformatted']) ) {
 636                 */
 637                 $match = "?^$default_folder_prefix(Sent|Drafts|Trash).{1}$spec_sub$?";
 638                 if (!$used[$k] && preg_match($match, $boxesall[$k]['unformatted']) ) {
 639                     $boxesnew[] = $boxesall[$k];
 640                     $used[$k]   = true;
 641                 }
 642             }
 643
 644         }
 645         /* Rest of the folders */
 646         for($k = 0; $k < $cnt; $k++) {
 647             if (!$used[$k]) {
 648                 $boxesnew[] = $boxesall[$k];
 649             }
 650         }
 651     }
 652     return $boxesnew;
 653 }
 654
 655 /*
 656  *  Returns a list of all folders, subscribed or not
 657  */
 658 function sqimap_mailbox_list_all($imap_stream) {
 659     global $list_special_folders_first, $folder_prefix, $delimiter;
 660
 661     $ssid = sqimap_session_id();
 662     $lsid = strlen( $ssid );
 663     fputs ($imap_stream, $ssid . " LIST \"$folder_prefix\" *\r\n");
 664     $read_ary = sqimap_read_data ($imap_stream, $ssid, true, $response, $message);
 665     $g = 0;
 666     $phase = 'inbox';
 667     $fld_pre_length = strlen($folder_prefix);
 668
 669     for ($i = 0, $cnt = count($read_ary); $i < $cnt; $i++) {
 670         /* Another workaround for EIMS */
 671         if (isset($read_ary[$i + 1]) &&
 672             ereg("^(\\* [A-Z]+.*)\\{[0-9]+\\}([ \n\r\t]*)$",
 673                  $read_ary[$i], $regs)) {
 674             $i ++;
 675             $read_ary[$i] = $regs[1] . '"' . addslashes(trim($read_ary[$i])) . '"' . $regs[2];
 676         }
 677         if (substr($read_ary[$i], 0, $lsid) != $ssid ) {
 678             /* Store the raw IMAP reply */
 679             $boxes[$g]['raw'] = $read_ary[$i];
 680
 681             /* Count number of delimiters ($delimiter) in folder name */
 682             $mailbox = find_mailbox_name($read_ary[$i]);
 683             $dm_count =  substr_count($mailbox, $delimiter);
 684             if (substr($mailbox, -1) == $delimiter) {
 685                 /* If name ends in delimiter - decrement count by one */
 686                 $dm_count--;
 687             }
 688
 689             /* Format folder name, but only if it's a INBOX.* or has a parent. */
 690             $boxesallbyname[$mailbox] = $g;
 691             $parentfolder = readMailboxParent($mailbox, $delimiter);
 692             if((eregi('^inbox'.quotemeta($delimiter), $mailbox)) ||
 693                (ereg('^'.$folder_prefix, $mailbox)) ||
 694                ( isset($boxesallbyname[$parentfolder]) && (strlen($parentfolder) > 0) ) ) {
 695                 if ($dm_count) {
 696                     $boxes[$g]['formatted']  = str_repeat('&nbsp;&nbsp;', $dm_count);
 697                 } else {
 698                     $boxes[$g]['formatted'] = '';
 699                 }
 700                 $boxes[$g]['formatted'] .= imap_utf7_decode_local(readShortMailboxName($mailbox, $delimiter));
 701             } else {
 702                 $boxes[$g]['formatted']  = imap_utf7_decode_local($mailbox);
 703             }
 704
 705             $boxes[$g]['unformatted-dm'] = $mailbox;
 706             if (substr($mailbox, -1) == $delimiter) {
 707                 $mailbox = substr($mailbox, 0, strlen($mailbox) - 1);
 708             }
 709             $boxes[$g]['unformatted'] = $mailbox;
 710             $boxes[$g]['unformatted-disp'] = substr($mailbox,$fld_pre_length);
 711
 712             $boxes[$g]['id'] = $g;
 713
 714             /* Now lets get the flags for this mailbox */
 715             $read_mlbx = $read_ary[$i];
 716
 717 //            $read_mlbx = sqimap_run_command ($imap_stream, "LIST \"\" \"$mailbox\"",
 718 //                                             true, $response, $message);
 719
 720             /* Another workaround for EIMS */
 721 //            if (isset($read_mlbx[1]) &&
 722 //                ereg("^(\\* [A-Z]+.*)\\{[0-9]+\\}([ \n\r\t]*)$", $read_mlbx[0], $regs)) {
 723 //                $read_mlbx[0] = $regs[1] . '"' . addslashes(trim($read_mlbx[1])) . '"' . $regs[2];
 724 //            }
 725 //            echo  $read_mlbx[0] .' raw 2 <br>';
 726
 727             $flags = substr($read_mlbx, strpos($read_mlbx, '(')+1);
 728             $flags = substr($flags, 0, strpos($flags, ')'));
 729             $flags = str_replace('\\', '', $flags);
 730             $flags = trim(strtolower($flags));
 731             if ($flags) {
 732                 $boxes[$g]['flags'] = explode(' ', $flags);
 733             } else {
 734                 $boxes[$g]['flags'] = array();
 735             }
 736         }
 737         $g++;
 738     }
 739     if(is_array($boxes)) {
 740         sort ($boxes);
 741     }
 742
 743     return $boxes;
 744 }
 745
 746 function sqimap_mailbox_tree($imap_stream) {
 747     global $boxesnew, $default_folder_prefix, $unseen_notify, $unseen_type;
 748     if (!isset($boxesnew)) {
 749
 750         global $data_dir, $username, $list_special_folders_first,
 751                $folder_prefix, $delimiter, $trash_folder, $move_to_trash;
 752
 753
 754         $inbox_in_list = false;
 755         $inbox_subscribed = false;
 756
 757         require_once(SM_PATH . 'include/load_prefs.php');
 758
 759         /* LSUB array */
 760         $lsub_ary = sqimap_run_command ($imap_stream, "LSUB \"$folder_prefix\" \"*\"",
 761                                         true, $response, $message);
 762
 763         /*
 764          * Section about removing the last element was removed
 765          * We don't return "* OK" anymore from sqimap_read_data
 766          */
 767         $sorted_lsub_ary = array();
 768         $cnt = count($lsub_ary);
 769         for ($i = 0; $i < $cnt; $i++) {
 770             /*
 771              * Workaround for EIMS
 772              * Doesn't work if the mailbox name is multiple lines
 773              */
 774             if (isset($lsub_ary[$i + 1]) &&
 775                 ereg("^(\\* [A-Z]+.*)\\{[0-9]+\\}([ \n\r\t]*)$",
 776                      $lsub_ary[$i], $regs)) {
 777                 $i++;
 778                 $lsub_ary[$i] = $regs[1] . '"' . addslashes(trim($lsub_ary[$i])) . '"' . $regs[2];
 779             }
 780
 781             /*
 782             if (preg_match("/^\*\s+LSUB\s+\((.*)\)\s+\"(.*)\"\s+\"?(.+(?=\")|.+).*$/",$lsub_ary[$i],$regs)) {
 783                 $flag = $regs[1];
 784                 $mbx = trim($regs[3]);
 785                 $sorted_lsub_ary[] = array ('mbx' => $mbx, 'flag' => $flag);
 786             }
 787             */
 788             $mbx = find_mailbox_name($lsub_ary[$i]);
 789             $noselect = check_is_noselect($lsub_ary[$i]);
 790             if (substr($mbx, -1) == $delimiter) {
 791                 $mbx = substr($mbx, 0, strlen($mbx) - 1);
 792             }
 793             $sorted_lsub_ary[] = array ('mbx' => $mbx, 'noselect' => $noselect);
 794         }
 795         array_multisort($sorted_lsub_ary, SORT_ASC, SORT_REGULAR);
 796
 797         for($i = 0; $i < $cnt; $i++) {
 798             if ($sorted_lsub_ary[$i]['mbx'] == 'INBOX') {
 799                 $inbox_in_list = true;
 800                 break;
 801             }
 802         }
 803
 804         /*
 805          * Just in case they're not subscribed to their inbox,
 806          * we'll get it for them anyway
 807          */
 808         if (!$inbox_in_list) {
 809             $inbox_ary = sqimap_run_command ($imap_stream, "LIST \"\" \"INBOX\"",
 810                                              true, $response, $message);
 811             /* Another workaround for EIMS */
 812             if (isset($inbox_ary[1]) &&
 813                 ereg("^(\\* [A-Z]+.*)\\{[0-9]+\\}([ \n\r\t]*)$",
 814                      $inbox_ary[0], $regs)) {
 815                 $inbox_ary[0] = $regs[1] . '"' . addslashes(trim($inbox_ary[1])) .
 816                                 '"' . $regs[2];
 817             }
 818             $mbx = find_mailbox_name($inbox_ary[0]);
 819             if (substr($mbx, -1) == $delimiter) {
 820                 $mbx = substr($mbx, 0, strlen($mbx) - 1);
 821             }
 822             if ($mbx == 'INBOX') {
 823                 $sorted_lsub_ary[] = array ('mbx' => $mbx, 'flag' => '');
 824                 sqimap_subscribe($imap_stream, 'INBOX');
 825                 $cnt++;
 826             }
 827
 828             /*
 829             if (preg_match("/^\*\s+LIST\s+\((.*)\)\s+\"(.*)\"\s+\"?(.+(?=\")|.+).*$/",$inbox_ary[0],$regs)) {
 830                 $flag = $regs[1];
 831                 $mbx = trim($regs[3]);
 832                 if (substr($mbx, -1) == $delimiter) {
 833                     $mbx = substr($mbx, 0, strlen($mbx) - 1);
 834                 }
 835                 $sorted_lsub_ary[] = array ('mbx' => $mbx, 'flag' => $flag);
 836             }
 837             */
 838         }
 839         for ($i = 0 ; $i < $cnt; $i++) {
 840             $mbx = $sorted_lsub_ary[$i]['mbx'];
 841             if (($unseen_notify == 2 && $mbx == 'INBOX') ||
 842                 ($unseen_notify == 3) ||
 843                 ($move_to_trash && ($mbx == $trash_folder))) {
 844                 if($sorted_lsub_ary[$i]['noselect']) {
 845                     $sorted_lsub_ary[$i]['unseen'] = 0;
 846                 } else {
 847                     $sorted_lsub_ary[$i]['unseen'] =
 848                         sqimap_unseen_messages($imap_stream, $mbx);
 849                 }
 850                 if (($unseen_type == 2) ||
 851                     ($move_to_trash && ($mbx == $trash_folder)) ||
 852                     ($mbx == $trash_folder)) {
 853                     if($sorted_lsub_ary[$i]['noselect']) {
 854                         $sorted_lsub_ary[$i]['nummessages'] = 0;
 855                     } else {
 856                         $sorted_lsub_ary[$i]['nummessages'] =
 857                             sqimap_get_num_messages($imap_stream, $mbx);
 858                     }
 859                 }
 860             }
 861         }
 862         $boxesnew = sqimap_fill_mailbox_tree($sorted_lsub_ary);
 863         return $boxesnew;
 864     }
 865 }
 866
 867
 868 function sqimap_fill_mailbox_tree($mbx_ary, $mbxs=false) {
 869     global $data_dir, $username, $list_special_folders_first,
 870            $folder_prefix, $trash_folder, $sent_folder, $draft_folder,
 871            $move_to_trash, $move_to_sent, $save_as_draft,
 872            $delimiter;
 873
 874     $special_folders = array ('INBOX', $sent_folder, $draft_folder, $trash_folder);
 875
 876     /* create virtual root node */
 877     $mailboxes= new mailboxes();
 878     $mailboxes->is_root = true;
 879     $trail_del = false;
 880     if (isset($folder_prefix) && $folder_prefix != '') {
 881         $start = substr_count($folder_prefix,$delimiter);
 882         if (strrpos($folder_prefix, $delimiter) == (strlen($folder_prefix)-1)) {
 883             $trail_del = true;
 884             $mailboxes->mailboxname_full = substr($folder_prefix,0, (strlen($folder_prefix)-1));
 885         } else {
 886             $mailboxes->mailboxname_full = $folder_prefix;
 887             $start++;
 888         }
 889         $mailboxes->mailboxname_sub = $mailboxes->mailboxname_full;
 890     } else {
 891         $start = 0;
 892     }
 893     $cnt =  count($mbx_ary);
 894     for ($i=0; $i < $cnt; $i++) {
 895         if ($mbx_ary[$i]['mbx'] !='' ) {
 896             $mbx = new mailboxes();
 897             $mailbox = $mbx_ary[$i]['mbx'];
 898             switch ($mailbox) {
 899                 case 'INBOX':
 900                     $mbx->is_inbox = true;
 901                     $mbx->is_special = true;
 902                     break;
 903                 case $trash_folder:
 904                     $mbx->is_trash = true;
 905                     $mbx->is_special = true;
 906                     break;
 907                 case $sent_folder:
 908                     $mbx->is_sent = true;
 909                     $mbx->is_special = true;
 910                     break;
 911                 case $draft_folder:
 912                     $mbx->is_draft = true;
 913                     $mbx->is_special = true;
 914                     break;
 915             }
 916
 917             if (isset($mbx_ary[$i]['unseen'])) {
 918                 $mbx->unseen = $mbx_ary[$i]['unseen'];
 919             }
 920             if (isset($mbx_ary[$i]['nummessages'])) {
 921                 $mbx->total = $mbx_ary[$i]['nummessages'];
 922             }
 923
 924             $mbx->is_noselect = $mbx_ary[$i]['noselect'];
 925
 926             $r_del_pos = strrpos($mbx_ary[$i]['mbx'], $delimiter);
 927             if ($r_del_pos) {
 928                 $mbx->mailboxname_sub = substr($mbx_ary[$i]['mbx'],$r_del_pos+1);
 929             } else {   /* mailbox is root folder */
 930                 $mbx->mailboxname_sub = $mbx_ary[$i]['mbx'];
 931             }
 932             $mbx->mailboxname_full = $mbx_ary[$i]['mbx'];
 933             $mailboxes->addMbx($mbx, $delimiter, $start, $list_special_folders_first);
 934         }
 935     }
 936
 937     return $mailboxes;
 938 }
 939
 940 function sqimap_mailbox_has_children($mailbox='INBOX',$stream=false) {
 941     if (!$stream) {
 942         /* We weren't provided an IMAP stream - make one */
 943         global $username,$imapServerAddress, $imapPort;
 944         $password=$_COOKIE['key'];
 945         $stream=sqimap_login($username,$password,$imapServerAddress,$imapPort,false);
 946                 $log_this_out=true;
 947     }
 948     $query = 'LIST "" "' . $mailbox . '"';
 949     $results=sqimap_run_command($stream,$query,true,$response,$message,false);
 950         if (isset($log_this_out)) {
 951                 /* It's our stream, and since we're done with it... */
 952                 sqimap_logout($stream);
 953         }
 954     if (isset($results[0])) {
 955         /* We got something back, let's parse the results */
 956         $pos = strpos($results[0], '\HasChildren');
 957         if ($pos === false) {
 958             /* Folder has no children */
 959             return false;
 960         } else {
 961             /* Folder has children */
 962             return true;
 963         }
 964     } else {
 965         /* Didn't get anything back, probably bad mailbox name */
 966         return false;
 967     }
 968     return true;
 969 }
 970
 971 ?>