functions/imap_mailbox.php

   1 <?php
   2
   3 /**
   4  * imap_mailbox.php
   5  *
   6  * This implements all functions that manipulate mailboxes
   7  *
   8  * @copyright &copy; 1999-2006 The SquirrelMail Project Team
   9  * @license http://opensource.org/licenses/gpl-license.php GNU Public License
  10  * @version $Id$
  11  * @package squirrelmail
  12  * @subpackage imap
  13  */
  14
  15 /** UTF7 support */
  16 require_once(SM_PATH . 'functions/imap_utf7_local.php');
  17
  18
  19 /**
  20  * Mailboxes class
  21  *
  22  * FIXME. This class should be extracted and placed in a separate file that
  23  * can be included before we start the session. That makes caching of the tree
  24  * possible. On a refresh mailboxes from left_main.php the only function that
  25  * should be called is the sqimap_get_status_mbx_tree. In case of subscribe
  26  * / rename / delete / new we have to create methods for adding/changing the
  27  * mailbox in the mbx_tree without the need for a refresh.
  28  *
  29  * Some code fragments are present in 1.3.0 - 1.4.4.
  30  * @package squirrelmail
  31  * @subpackage imap
  32  * @since 1.5.0
  33  */
  34 class mailboxes {
  35     var $mailboxname_full = '', $mailboxname_sub= '', $is_noselect = false, $is_noinferiors = false,
  36         $is_special = false, $is_root = false, $is_inbox = false, $is_sent = false,
  37         $is_trash = false, $is_draft = false,  $mbxs = array(),
  38         $unseen = false, $total = false, $recent = false;
  39
  40     function addMbx($mbx, $delimiter, $start, $specialfirst) {
  41         $ary = explode($delimiter, $mbx->mailboxname_full);
  42         $mbx_parent =& $this;
  43         for ($i = $start, $c = count($ary)-1; $i < $c; $i++) {
  44             $mbx_childs =& $mbx_parent->mbxs;
  45             $found = false;
  46             if ($mbx_childs) {
  47                 foreach ($mbx_childs as $key => $parent) {
  48                     if ($parent->mailboxname_sub == $ary[$i]) {
  49                         $mbx_parent =& $mbx_parent->mbxs[$key];
  50                         $found = true;
  51                         break;
  52                     }
  53                 }
  54             }
  55             if (!$found) {
  56                 $no_select_mbx = new mailboxes();
  57                 if (isset($mbx_parent->mailboxname_full) && $mbx_parent->mailboxname_full != '') {
  58                     $no_select_mbx->mailboxname_full = $mbx_parent->mailboxname_full.$delimiter.$ary[$i];
  59                 } else {
  60                     $no_select_mbx->mailboxname_full = $ary[$i];
  61                 }
  62                 $no_select_mbx->mailboxname_sub = $ary[$i];
  63                 $no_select_mbx->is_noselect = true;
  64                 $mbx_parent->mbxs[] = $no_select_mbx;
  65                 $i--;
  66             }
  67         }
  68         $mbx_parent->mbxs[] = $mbx;
  69         if ($mbx->is_special && $specialfirst) {
  70             usort($mbx_parent->mbxs, 'sortSpecialMbx');
  71         }
  72     }
  73 }
  74
  75 /**
  76  * array callback used for sorting in mailboxes class
  77  * @param object $a
  78  * @param object $b
  79  * @return integer see php strnatcasecmp()
  80  * @since 1.3.0
  81  */
  82 function sortSpecialMbx($a, $b) {
  83     if ($a->is_inbox) {
  84         $acmp = '0'. $a->mailboxname_full;
  85     } else if ($a->is_special) {
  86         $acmp = '1'. $a->mailboxname_full;
  87     } else {
  88         $acmp = '2' . $a->mailboxname_full;
  89     }
  90     if ($b->is_inbox) {
  91         $bcmp = '0'. $b->mailboxname_full;
  92     }else if ($b->is_special) {
  93         $bcmp = '1' . $b->mailboxname_full;
  94     } else {
  95         $bcmp = '2' . $b->mailboxname_full;
  96     }
  97     return strnatcasecmp($acmp, $bcmp);
  98 }
  99
 100 /**
 101  * @param array $ary
 102  * @return array
 103  * @since 1.5.0
 104  */
 105 function compact_mailboxes_response($ary) {
 106     /*
 107      * Workaround for mailboxes returned as literal
 108      * FIXME : Doesn't work if the mailbox name is multiple lines
 109      * (larger then fgets buffer)
 110      */
 111     for ($i = 0, $iCnt=count($ary); $i < $iCnt; $i++) {
 112         if (isset($ary[$i + 1]) && substr($ary[$i], -3) == "}\r\n") {
 113             if (ereg("^(\\* [A-Z]+.*)\\{[0-9]+\\}([ \n\r\t]*)$",
 114                  $ary[$i], $regs)) {
 115                 $ary[$i] = $regs[1] . '"' . addslashes(trim($ary[$i+1])) . '"' . $regs[2];
 116                 array_splice($ary, $i+1, 2);
 117             }
 118         }
 119     }
 120     /* remove duplicates and ensure array is contiguous */
 121     return array_values(array_unique($ary));
 122 }
 123
 124 /**
 125  * Extract the mailbox name from an untagged LIST (7.2.2) or LSUB (7.2.3) answer
 126  * (LIST|LSUB) (<Flags list>) (NIL|"<separator atom>") <mailbox name string>\r\n
 127  * mailbox name in quoted string MUST be unquoted and stripslashed (sm API)
 128  *
 129  * Originally stored in functions/strings.php. Since 1.2.6 stored in
 130  * functions/imap_mailbox.php
 131  * @param string $line imap LIST/LSUB response line
 132  * @return string mailbox name
 133  */
 134 function find_mailbox_name($line) {
 135     if (preg_match('/^\* (?:LIST|LSUB) \([^\)]*\) (?:NIL|\"[^\"]*\") ([^\r\n]*)[\r\n]*$/i', $line, $regs)) {
 136         if (substr($regs[1], 0, 1) == '"')
 137             return stripslashes(substr($regs[1], 1, -1));
 138         return $regs[1];
 139     }
 140     return '';
 141 }
 142
 143 /**
 144  * Detects if mailbox has noselect flag (can't store messages)
 145  * In versions older than 1.4.5 function checks only LSUB responses
 146  * and can produce pcre warnings.
 147  * @param string $lsub_line mailbox line from untagged LIST or LSUB response
 148  * @return bool whether this is a Noselect mailbox.
 149  * @since 1.3.2
 150  */
 151 function check_is_noselect ($lsub_line) {
 152     return preg_match("/^\* (LSUB|LIST) \([^\)]*\\\\Noselect[^\)]*\)/i", $lsub_line);
 153 }
 154
 155 /**
 156  * Detects if mailbox has noinferiors flag (can't store subfolders)
 157  * @param string $lsub_line mailbox line from untagged LIST or LSUB response
 158  * @return bool whether this is a Noinferiors mailbox.
 159  * @since 1.5.0
 160  */
 161 function check_is_noinferiors ($lsub_line) {
 162     return preg_match("/^\* (LSUB|LIST) \([^\)]*\\\\Noinferiors[^\)]*\)/i", $lsub_line);
 163 }
 164
 165 /**
 166  * Detects mailbox's parent folder
 167  *
 168  * If $haystack is a full mailbox name, and $needle is the mailbox
 169  * separator character, returns the second last part of the full
 170  * mailbox name (i.e. the mailbox's parent mailbox)
 171  *
 172  * Originally stored in functions/strings.php. Since 1.2.6 stored in
 173  * functions/imap_mailbox.php
 174  * @param string $haystack full mailbox name
 175  * @param string $needle delimiter
 176  * @return string parent mailbox
 177  */
 178 function readMailboxParent($haystack, $needle) {
 179     if ($needle == '') {
 180         $ret = '';
 181     } else {
 182         $parts = explode($needle, $haystack);
 183         $elem = array_pop($parts);
 184         while ($elem == '' && count($parts)) {
 185             $elem = array_pop($parts);
 186         }
 187         $ret = join($needle, $parts);
 188     }
 189     return( $ret );
 190 }
 191
 192 /**
 193  * Check if $subbox is below the specified $parentbox
 194  * @param string $subbox potential sub folder
 195  * @param string $parentbox potential parent
 196  * @return boolean
 197  * @since 1.2.3
 198  */
 199 function isBoxBelow( $subbox, $parentbox ) {
 200     global $delimiter;
 201     /*
 202      * Eliminate the obvious mismatch, where the
 203      * subfolder path is shorter than that of the potential parent
 204      */
 205     if ( strlen($subbox) < strlen($parentbox) ) {
 206       return false;
 207     }
 208     /* check for delimiter */
 209     if (substr($parentbox,-1) != $delimiter) {
 210         $parentbox .= $delimiter;
 211     }
 212
 213     return (substr($subbox,0,strlen($parentbox)) == $parentbox);
 214 }
 215
 216 /**
 217  * Defines special mailboxes: given a mailbox name, it checks if this is a
 218  * "special" one: INBOX, Trash, Sent or Draft.
 219  *
 220  * Since 1.2.5 function includes special_mailbox hook.<br>
 221  * Since 1.4.3 hook supports more than one plugin.
 222  * @param string $box mailbox name
 223  * @param boolean $include_subs (since 1.5.2) if true, subfolders of system
 224  *  folders are special. if false, subfolders are not special mailboxes
 225  *  unless they are tagged as special in 'special_mailbox' hook.
 226  * @return boolean
 227  * @since 1.2.3
 228  */
 229 function isSpecialMailbox($box,$include_subs=true) {
 230     $ret = ( (strtolower($box) == 'inbox') ||
 231              isTrashMailbox($box,$include_subs) ||
 232              isSentMailbox($box,$include_subs) ||
 233              isDraftMailbox($box,$include_subs) );
 234
 235     if ( !$ret ) {
 236         $ret = boolean_hook_function('special_mailbox',$box,1);
 237     }
 238     return $ret;
 239 }
 240
 241 /**
 242  * Detects if mailbox is a Trash folder or subfolder of Trash
 243  * @param string $box mailbox name
 244  * @param boolean $include_subs (since 1.5.2) if true, subfolders of system
 245  *  folders are special. if false, subfolders are not special mailboxes.
 246  * @return bool whether this is a Trash folder
 247  * @since 1.4.0
 248  */
 249 function isTrashMailbox ($box,$include_subs=true) {
 250     global $trash_folder, $move_to_trash;
 251     return $move_to_trash && $trash_folder &&
 252            ( $box == $trash_folder ||
 253              ($include_subs && isBoxBelow($box, $trash_folder)) );
 254 }
 255
 256 /**
 257  * Detects if mailbox is a Sent folder or subfolder of Sent
 258  * @param string $box mailbox name
 259  * @param boolean $include_subs (since 1.5.2) if true, subfolders of system
 260  *  folders are special. if false, subfolders are not special mailboxes.
 261  * @return bool whether this is a Sent folder
 262  * @since 1.4.0
 263  */
 264 function isSentMailbox($box,$include_subs=true) {
 265    global $sent_folder, $move_to_sent;
 266    return $move_to_sent && $sent_folder &&
 267           ( $box == $sent_folder ||
 268             ($include_subs && isBoxBelow($box, $sent_folder)) );
 269 }
 270
 271 /**
 272  * Detects if mailbox is a Drafts folder or subfolder of Drafts
 273  * @param string $box mailbox name
 274  * @param boolean $include_subs (since 1.5.2) if true, subfolders of system
 275  *  folders are special. if false, subfolders are not special mailboxes.
 276  * @return bool whether this is a Draft folder
 277  * @since 1.4.0
 278  */
 279 function isDraftMailbox($box,$include_subs=true) {
 280    global $draft_folder, $save_as_draft;
 281    return $save_as_draft &&
 282           ( $box == $draft_folder ||
 283             ($include_subs && isBoxBelow($box, $draft_folder)) );
 284 }
 285
 286 /**
 287  * Expunges a mailbox
 288  *
 289  * WARNING: Select mailbox before calling this function.
 290  *
 291  * permanently removes all messages that have the \Deleted flag
 292  * set from the selected mailbox. See EXPUNGE command chapter in
 293  * IMAP RFC.
 294  * @param stream $imap_stream imap connection resource
 295  * @param string $mailbox mailbox name (unused since 1.1.3).
 296  * @param boolean $handle_errors error handling control (displays error_box on error).
 297  * @param mixed $id (since 1.3.0) integer message id or array with integer ids
 298  * @return integer number of expunged messages
 299  * @since 1.0 or older
 300  */
 301 function sqimap_mailbox_expunge ($imap_stream, $mailbox, $handle_errors = true, $id='') {
 302     if ($id) {
 303         if (is_array($id)) {
 304             $id = sqimap_message_list_squisher($id);
 305         }
 306         $id = ' '.$id;
 307         $uid = TRUE;
 308     } else {
 309         $uid = false;
 310     }
 311     $read = sqimap_run_command($imap_stream, 'EXPUNGE'.$id, $handle_errors,
 312                                $response, $message, $uid);
 313     $cnt = 0;
 314
 315     if (is_array($read)) {
 316         foreach ($read as $r) {
 317             if (preg_match('/^\*\s[0-9]+\sEXPUNGE/AUi',$r,$regs)) {
 318                 $cnt++;
 319             }
 320         }
 321     }
 322     return $cnt;
 323 }
 324
 325 /**
 326  * Checks whether or not the specified mailbox exists
 327  *
 328  * @param stream $imap_stream imap connection resource
 329  * @param string $mailbox mailbox name
 330  * @param array $mailboxlist (since 1.5.1) optional array of mailboxes from
 331  *  sqimap_get_mailboxes() (to avoid having to talk to imap server)
 332  * @return boolean
 333  * @since 1.0 or older
 334  */
 335 function sqimap_mailbox_exists ($imap_stream, $mailbox, $mailboxlist=null) {
 336     if (!isset($mailbox) || empty($mailbox)) {
 337         return false;
 338     }
 339
 340     if (is_array($mailboxlist)) {
 341         // use previously retrieved mailbox list
 342         foreach ($mailboxlist as $mbox) {
 343             if ($mbox['unformatted-dm'] == $mailbox) { return true; }
 344         }
 345         return false;
 346     } else {
 347         // go to imap server
 348         $mbx = sqimap_run_command($imap_stream, 'LIST "" ' . sqimap_encode_mailbox_name($mailbox),
 349                                   true, $response, $message);
 350         return isset($mbx[0]);
 351     }
 352 }
 353
 354 /**
 355  * Selects a mailbox
 356  * Before 1.3.0 used more arguments and returned data depended on those arguments.
 357  * @param stream $imap_stream imap connection resource
 358  * @param string $mailbox mailbox name
 359  * @return array results of select command (on success - permanentflags, flags and rights)
 360  * @since 1.0 or older
 361  */
 362 function sqimap_mailbox_select ($imap_stream, $mailbox) {
 363     // FIX ME: WHAAAA DO NOT USE "None" for something that does not exist. Use false or NULL instead
 364     if ($mailbox == 'None') {
 365         return;
 366     }
 367     // cleanup $mailbox in order to prevent IMAP injection attacks
 368     $mailbox = str_replace(array("\r","\n"), array("",""),$mailbox);
 369     $read = sqimap_run_command($imap_stream, 'SELECT ' . sqimap_encode_mailbox_name($mailbox),
 370                                true, $response, $message);
 371     $result = array();
 372     for ($i = 0, $cnt = count($read); $i < $cnt; $i++) {
 373         if (preg_match('/^\*\s+OK\s\[(\w+)\s(\w+)\]/',$read[$i], $regs)) {
 374             $result[strtoupper($regs[1])] = $regs[2];
 375         } else if (preg_match('/^\*\s([0-9]+)\s(\w+)/',$read[$i], $regs)) {
 376             $result[strtoupper($regs[2])] = $regs[1];
 377         } else {
 378             if (preg_match("/PERMANENTFLAGS(.*)/i",$read[$i], $regs)) {
 379                 $regs[1]=trim(preg_replace (  array ("/\(/","/\)/","/\]/") ,'', $regs[1])) ;
 380                 $result['PERMANENTFLAGS'] = explode(' ',strtolower($regs[1]));
 381             } else if (preg_match("/FLAGS(.*)/i",$read[$i], $regs)) {
 382                 $regs[1]=trim(preg_replace (  array ("/\(/","/\)/") ,'', $regs[1])) ;
 383                 $result['FLAGS'] = explode(' ',strtolower($regs[1]));
 384             }
 385         }
 386     }
 387     if (!isset($result['PERMANENTFLAGS'])) {
 388         $result['PERMANENTFLAGS'] = $result['FLAGS'];
 389     }
 390     if (preg_match('/^\[(.+)\]/',$message, $regs)) {
 391         $result['RIGHTS']=strtoupper($regs[1]);
 392     }
 393
 394     return $result;
 395 }
 396
 397 /**
 398  * Creates a folder.
 399  *
 400  * Mailbox is automatically subscribed.
 401  *
 402  * Set $type to string that does not match 'noselect' (case insensitive),
 403  * if you don't want to prepend delimiter to mailbox name. Please note
 404  * that 'noinferiors' might be used someday as keyword for folders
 405  * that store only messages.
 406  * @param stream $imap_steam imap connection resource
 407  * @param string $mailbox mailbox name
 408  * @param string $type folder type.
 409  * @since 1.0 or older
 410  */
 411 function sqimap_mailbox_create ($imap_stream, $mailbox, $type) {
 412     global $delimiter;
 413     if (strtolower($type) == 'noselect') {
 414         $create_mailbox = $mailbox . $delimiter;
 415     } else {
 416         $create_mailbox = $mailbox;
 417     }
 418
 419     $read_ary = sqimap_run_command($imap_stream, 'CREATE ' .
 420                                    sqimap_encode_mailbox_name($create_mailbox),
 421                                    true, $response, $message);
 422     sqimap_subscribe ($imap_stream, $mailbox);
 423 }
 424
 425 /**
 426  * Subscribes to an existing folder.
 427  * @param stream $imap_stream imap connection resource
 428  * @param string $mailbox mailbox name
 429  * @param boolean $debug (since 1.5.1)
 430  * @since 1.0 or older
 431  */
 432 function sqimap_subscribe ($imap_stream, $mailbox,$debug=true) {
 433     $read_ary = sqimap_run_command($imap_stream, 'SUBSCRIBE ' .
 434                                    sqimap_encode_mailbox_name($mailbox),
 435                                    $debug, $response, $message);
 436 }
 437
 438 /**
 439  * Unsubscribes from an existing folder
 440  * @param stream $imap_stream imap connection resource
 441  * @param string $mailbox mailbox name
 442  * @since 1.0 or older
 443  */
 444 function sqimap_unsubscribe ($imap_stream, $mailbox) {
 445     $read_ary = sqimap_run_command($imap_stream, 'UNSUBSCRIBE ' .
 446                                    sqimap_encode_mailbox_name($mailbox),
 447                                    false, $response, $message);
 448 }
 449
 450 /**
 451  * Deletes the given folder
 452  * Since 1.2.6 and 1.3.0 contains rename_or_delete_folder hook
 453  * @param stream $imap_stream imap connection resource
 454  * @param string $mailbox mailbox name
 455  * @since 1.0 or older
 456  */
 457 function sqimap_mailbox_delete ($imap_stream, $mailbox) {
 458     global $data_dir, $username;
 459     sqimap_unsubscribe ($imap_stream, $mailbox);
 460
 461     if (sqimap_mailbox_exists($imap_stream, $mailbox)) {
 462
 463         $read_ary = sqimap_run_command($imap_stream, 'DELETE ' .
 464                                        sqimap_encode_mailbox_name($mailbox),
 465                                        true, $response, $message);
 466         if ($response !== 'OK') {
 467             // subscribe again
 468             sqimap_subscribe ($imap_stream, $mailbox);
 469         } else {
 470             do_hook_function('rename_or_delete_folder', $args = array($mailbox, 'delete', ''));
 471             removePref($data_dir, $username, "thread_$mailbox");
 472             removePref($data_dir, $username, "collapse_folder_$mailbox");
 473         }
 474     }
 475 }
 476
 477 /**
 478  * Determines if the user is subscribed to the folder or not
 479  * @param stream $imap_stream imap connection resource
 480  * @param string $mailbox mailbox name
 481  * @return boolean
 482  * @since 1.2.0
 483  */
 484 function sqimap_mailbox_is_subscribed($imap_stream, $folder) {
 485     $boxesall = sqimap_mailbox_list ($imap_stream);
 486     foreach ($boxesall as $ref) {
 487         if ($ref['unformatted'] == $folder) {
 488             return true;
 489         }
 490     }
 491     return false;
 492 }
 493
 494 /**
 495  * Renames a mailbox.
 496  * Since 1.2.6 and 1.3.0 contains rename_or_delete_folder hook
 497  * @param stream $imap_stream imap connection resource
 498  * @param string $old_name mailbox name
 499  * @param string $new_name new mailbox name
 500  * @since 1.2.3
 501  */
 502 function sqimap_mailbox_rename( $imap_stream, $old_name, $new_name ) {
 503     if ( $old_name != $new_name ) {
 504         global $delimiter, $imap_server_type, $data_dir, $username;
 505         if ( substr( $old_name, -1 ) == $delimiter  ) {
 506             $old_name = substr( $old_name, 0, strlen( $old_name ) - 1 );
 507             $new_name = substr( $new_name, 0, strlen( $new_name ) - 1 );
 508             $postfix = $delimiter;
 509         } else {
 510             $postfix = '';
 511         }
 512
 513         $boxesall = sqimap_mailbox_list_all($imap_stream);
 514         $cmd = 'RENAME ' . sqimap_encode_mailbox_name($old_name) .
 515                      ' ' . sqimap_encode_mailbox_name($new_name);
 516         $data = sqimap_run_command($imap_stream, $cmd, true, $response, $message);
 517         sqimap_unsubscribe($imap_stream, $old_name.$postfix);
 518         $oldpref_thread = getPref($data_dir, $username, 'thread_'.$old_name.$postfix);
 519         $oldpref_collapse = getPref($data_dir, $username, 'collapse_folder_'.$old_name.$postfix);
 520         removePref($data_dir, $username, 'thread_'.$old_name.$postfix);
 521         removePref($data_dir, $username, 'collapse_folder_'.$old_name.$postfix);
 522         sqimap_subscribe($imap_stream, $new_name.$postfix);
 523         setPref($data_dir, $username, 'thread_'.$new_name.$postfix, $oldpref_thread);
 524         setPref($data_dir, $username, 'collapse_folder_'.$new_name.$postfix, $oldpref_collapse);
 525         do_hook_function('rename_or_delete_folder',$args = array($old_name, 'rename', $new_name));
 526         $l = strlen( $old_name ) + 1;
 527         $p = 'unformatted';
 528
 529         foreach ($boxesall as $box) {
 530             if (substr($box[$p], 0, $l) == $old_name . $delimiter) {
 531                 $new_sub = $new_name . $delimiter . substr($box[$p], $l);
 532                 /* With Cyrus IMAPd >= 2.0 rename is recursive, so don't check for errors here */
 533                 if ($imap_server_type == 'cyrus') {
 534                     $cmd = 'RENAME "' . $box[$p] . '" "' . $new_sub . '"';
 535                     $data = sqimap_run_command($imap_stream, $cmd, false,
 536                                                $response, $message);
 537                 }
 538                 $was_subscribed = sqimap_mailbox_is_subscribed($imap_stream, $box[$p]);
 539                 if ( $was_subscribed ) {
 540                     sqimap_unsubscribe($imap_stream, $box[$p]);
 541                 }
 542                 $oldpref_thread = getPref($data_dir, $username, 'thread_'.$box[$p]);
 543                 $oldpref_collapse = getPref($data_dir, $username, 'collapse_folder_'.$box[$p]);
 544                 removePref($data_dir, $username, 'thread_'.$box[$p]);
 545                 removePref($data_dir, $username, 'collapse_folder_'.$box[$p]);
 546                 if ( $was_subscribed ) {
 547                     sqimap_subscribe($imap_stream, $new_sub);
 548                 }
 549                 setPref($data_dir, $username, 'thread_'.$new_sub, $oldpref_thread);
 550                 setPref($data_dir, $username, 'collapse_folder_'.$new_sub, $oldpref_collapse);
 551                 do_hook_function('rename_or_delete_folder',
 552                                  $args = array($box[$p], 'rename', $new_sub));
 553             }
 554         }
 555     }
 556 }
 557
 558 /**
 559  * Formats a mailbox into parts for the $boxesall array
 560  *
 561  * The parts are:
 562  * <ul>
 563  *   <li>raw            - Raw LIST/LSUB response from the IMAP server
 564  *   <li>formatted      - nicely formatted folder name
 565  *   <li>unformatted    - unformatted, but with delimiter at end removed
 566  *   <li>unformatted-dm - folder name as it appears in raw response
 567  *   <li>unformatted-disp - unformatted without $folder_prefix
 568  *   <li>id             - TODO: document me
 569  *   <li>flags          - TODO: document me
 570  * </ul>
 571  * Before 1.2.0 used third argument for delimiter.
 572  *
 573  * Before 1.5.1 used second argument for lsub line. Argument was removed in order to use
 574  * find_mailbox_name() on the raw input. Since 1.5.1 includes RFC3501 names in flags
 575  * array (for example, "\NoSelect" in addition to "noselect")
 576  * @param array $line
 577  * @return array
 578  * @since 1.0 or older
 579  * @todo document id and flags keys in boxes array and function arguments.
 580  */
 581 function sqimap_mailbox_parse ($line) {
 582     global $folder_prefix, $delimiter;
 583
 584     /* Process each folder line */
 585     for ($g = 0, $cnt = count($line); $g < $cnt; ++$g) {
 586         /* Store the raw IMAP reply */
 587         if (isset($line[$g])) {
 588             $boxesall[$g]['raw'] = $line[$g];
 589         } else {
 590             $boxesall[$g]['raw'] = '';
 591         }
 592
 593         /* Count number of delimiters ($delimiter) in folder name */
 594         $mailbox = find_mailbox_name($line[$g]);
 595         $dm_count = substr_count($mailbox, $delimiter);
 596         if (substr($mailbox, -1) == $delimiter) {
 597             /* If name ends in delimiter, decrement count by one */
 598             $dm_count--;
 599         }
 600
 601         /* Format folder name, but only if it's a INBOX.* or has a parent. */
 602         $boxesallbyname[$mailbox] = $g;
 603         $parentfolder = readMailboxParent($mailbox, $delimiter);
 604         if ( (strtolower(substr($mailbox, 0, 5)) == "inbox") ||
 605              (substr($mailbox, 0, strlen($folder_prefix)) == $folder_prefix) ||
 606              (isset($boxesallbyname[$parentfolder]) &&
 607               (strlen($parentfolder) > 0) ) ) {
 608             $indent = $dm_count - (substr_count($folder_prefix, $delimiter));
 609             if ($indent > 0) {
 610                 $boxesall[$g]['formatted'] = str_repeat('&nbsp;&nbsp;', $indent);
 611             } else {
 612                 $boxesall[$g]['formatted'] = '';
 613             }
 614             $boxesall[$g]['formatted'] .= imap_utf7_decode_local(readShortMailboxName($mailbox, $delimiter));
 615         } else {
 616             $boxesall[$g]['formatted']  = imap_utf7_decode_local($mailbox);
 617         }
 618
 619         $boxesall[$g]['unformatted-dm'] = $mailbox;
 620         if (substr($mailbox, -1) == $delimiter) {
 621             $mailbox = substr($mailbox, 0, strlen($mailbox) - 1);
 622         }
 623         $boxesall[$g]['unformatted'] = $mailbox;
 624         if (substr($mailbox,0,strlen($folder_prefix))==$folder_prefix) {
 625             $mailbox = substr($mailbox, strlen($folder_prefix));
 626         }
 627         $boxesall[$g]['unformatted-disp'] = $mailbox;
 628         $boxesall[$g]['id'] = $g;
 629
 630         $boxesall[$g]['flags'] = array();
 631         if (isset($line[$g])) {
 632             ereg("\(([^)]*)\)",$line[$g],$regs);
 633             /**
 634              * Since 1.5.1 flags are stored with RFC3501 naming
 635              * and also the old way for backwards compatibility
 636              * so for example "\NoSelect" and "noselect"
 637              */
 638             $flags = trim($regs[1]);
 639             if ($flags) {
 640                 $flagsarr = explode(' ',$flags);
 641                 $flagsarrnew=$flagsarr;
 642                 // add old type
 643                 foreach ($flagsarr as $flag) {
 644                     $flagsarrnew[]=strtolower(str_replace('\\', '',$flag));
 645                 }
 646                 $boxesall[$g]['flags']=$flagsarrnew;
 647             }
 648         }
 649     }
 650     return $boxesall;
 651 }
 652
 653 /**
 654  * Returns list of options (to be echoed into select statement
 655  * based on available mailboxes and separators
 656  * Caller should surround options with <select ...> </select> and
 657  * any formatting.
 658  * @param stream $imap_stream imap connection resource to query for mailboxes
 659  * @param array $show_selected array containing list of mailboxes to pre-select (0 if none)
 660  * @param array $folder_skip array of folders to keep out of option list (compared in lower)
 661  * @param $boxes list of already fetched boxes (for places like folder panel, where
 662  *            you know these options will be shown 3 times in a row.. (most often unset).
 663  * @param string $flag (since 1.4.1) flag to check for in mailbox flags, used to filter out mailboxes.
 664  *           'noselect' by default to remove unselectable mailboxes.
 665  *           'noinferiors' used to filter out folders that can not contain subfolders.
 666  *           NULL to avoid flag check entirely.
 667  *           NOTE: noselect and noiferiors are used internally. The IMAP representation is
 668  *                 \NoSelect and \NoInferiors
 669  * @param boolean $use_long_format (since 1.4.1) override folder display preference and always show full folder name.
 670  * @return string html formated mailbox selection options
 671  * @since 1.3.2
 672  */
 673 function sqimap_mailbox_option_list($imap_stream, $show_selected = 0, $folder_skip = 0, $boxes = 0,
 674                                     $flag = 'noselect', $use_long_format = false ) {
 675     global $username, $data_dir, $translate_special_folders, $sent_folder,
 676         $trash_folder, $draft_folder;
 677
 678     $delimiter = sqimap_get_delimiter($imap_stream);
 679
 680     $mbox_options = '';
 681     if ( $use_long_format ) {
 682         $shorten_box_names = 0;
 683     } else {
 684         $shorten_box_names = getPref($data_dir, $username, 'mailbox_select_style', SMPREF_OFF);
 685     }
 686
 687     if ($boxes == 0) {
 688         $boxes = sqimap_mailbox_list($imap_stream);
 689     }
 690
 691     foreach ($boxes as $boxes_part) {
 692         if ($flag == NULL || (is_array($boxes_part['flags'])
 693                       && !in_array($flag, $boxes_part['flags']))) {
 694             $box = $boxes_part['unformatted'];
 695
 696             if ($folder_skip != 0 && in_array($box, $folder_skip) ) {
 697                 continue;
 698             }
 699             $lowerbox = strtolower($box);
 700             // mailboxes are casesensitive => inbox.sent != inbox.Sent
 701             // nevermind, to many dependencies this should be fixed!
 702
 703             if (strtolower($box) == 'inbox') { // inbox is special and not casesensitive
 704                 $box2 = _("INBOX");
 705             } else {
 706                 switch ($shorten_box_names)
 707                 {
 708                   case 2:   /* delimited, style = 2 */
 709                       if ($translate_special_folders && $boxes_part['unformatted-dm']==$sent_folder) {
 710                           /*
 711                            * calculate pad level from number of delimiters. do it inside if control in order
 712                            * to reduce number of calculations. Other folders don't need it.
 713                            */
 714                           $pad = str_pad('',7 * (count(explode($delimiter,$boxes_part['unformatted-dm']))-1),'.&nbsp;');
 715                           // i18n: Name of Sent folder
 716                           $box2 = $pad . _("Sent");
 717                       } elseif ($translate_special_folders && $boxes_part['unformatted-dm']==$trash_folder) {
 718                           $pad = str_pad('',7 * (count(explode($delimiter,$boxes_part['unformatted-dm']))-1),'.&nbsp;');
 719                           // i18n: Name of Trash folder
 720                           $box2 = $pad . _("Trash");
 721                       } elseif ($translate_special_folders && $boxes_part['unformatted-dm']==$draft_folder) {
 722                           $pad = str_pad('',7 * (count(explode($delimiter,$boxes_part['unformatted-dm']))-1),'.&nbsp;');
 723                           // i18n: Name of Drafts folder
 724                           $box2 = $pad . _("Drafts");
 725                       } else {
 726                           $box2 = str_replace('&amp;nbsp;&amp;nbsp;', '.&nbsp;', htmlspecialchars($boxes_part['formatted']));
 727                       }
 728                     break;
 729                   case 1:   /* indent, style = 1 */
 730                       if ($translate_special_folders && $boxes_part['unformatted-dm']==$sent_folder) {
 731                           $pad = str_pad('',12 * (count(explode($delimiter,$boxes_part['unformatted-dm']))-1),'&nbsp;&nbsp;');
 732                           $box2 = $pad . _("Sent");
 733                       } elseif ($translate_special_folders && $boxes_part['unformatted-dm']==$trash_folder) {
 734                           $pad = str_pad('',12 * (count(explode($delimiter,$boxes_part['unformatted-dm']))-1),'&nbsp;&nbsp;');
 735                           $box2 = $pad . _("Trash");
 736                       } elseif ($translate_special_folders && $boxes_part['unformatted-dm']==$draft_folder) {
 737                           $pad = str_pad('',12 * (count(explode($delimiter,$boxes_part['unformatted-dm']))-1),'&nbsp;&nbsp;');
 738                           $box2 = $pad . _("Drafts");
 739                       } else {
 740                           $box2 = str_replace('&amp;nbsp;&amp;nbsp;', '&nbsp;&nbsp;', htmlspecialchars($boxes_part['formatted']));
 741                       }
 742                     break;
 743                   default:  /* default, long names, style = 0 */
 744                     $box2 = str_replace(' ', '&nbsp;', htmlspecialchars(imap_utf7_decode_local($boxes_part['unformatted-disp'])));
 745                     break;
 746                 }
 747             }
 748             if ($show_selected != 0 && in_array($lowerbox, $show_selected) ) {
 749                 $mbox_options .= '<option value="' . htmlspecialchars($box) .'" selected="selected">'.$box2.'</option>' . "\n";
 750             } else {
 751                 $mbox_options .= '<option value="' . htmlspecialchars($box) .'">'.$box2.'</option>' . "\n";
 752             }
 753         }
 754     }
 755     return $mbox_options;
 756 }
 757
 758 /**
 759  * Returns sorted mailbox lists in several different ways.
 760  *
 761  * Since 1.5.1 most of the functionality has been moved to new function sqimap_get_mailboxes
 762  *
 763  * See comment on sqimap_mailbox_parse() for info about the returned array.
 764  * @param resource $imap_stream imap connection resource
 765  * @param boolean $force force update of mailbox listing. available since 1.4.2 and 1.5.0
 766  * @return array list of mailboxes
 767  * @since 1.0 or older
 768  */
 769 function sqimap_mailbox_list($imap_stream, $force=false) {
 770     global $boxesnew,$show_only_subscribed_folders;
 771     if (!sqgetGlobalVar('boxesnew',$boxesnew,SQ_SESSION) || $force) {
 772         $boxesnew=sqimap_get_mailboxes($imap_stream,$force,$show_only_subscribed_folders);
 773     }
 774     return $boxesnew;
 775 }
 776
 777 /**
 778  * Returns a list of all folders, subscribed or not
 779  *
 780  * Since 1.5.1 code moved to sqimap_get_mailboxes()
 781  *
 782  * @param stream $imap_stream imap connection resource
 783  * @return array see sqimap_mailbox_parse()
 784  * @since 1.0 or older
 785  */
 786 function sqimap_mailbox_list_all($imap_stream) {
 787     global $show_only_subscribed_folders;
 788     // fourth argument prevents registration of retrieved list of mailboxes in session
 789     $boxes=sqimap_get_mailboxes($imap_stream,true,false,false);
 790     return $boxes;
 791 }
 792
 793
 794 /**
 795  * Gets the list of mailboxes for sqimap_maolbox_tree and sqimap_mailbox_list
 796  *
 797  * This is because both of those functions had duplicated logic, but with slightly different
 798  * implementations. This will make both use the same implementation, which should make it
 799  * easier to maintain and easier to modify in the future
 800  * @param stream $imap_stream imap connection resource
 801  * @param bool $force force a reload and ignore cache
 802  * @param bool $show_only_subscribed controls listing of visible or all folders
 803  * @param bool $session_register controls registration of retrieved data in session.
 804  * @return object boxesnew - array of mailboxes and their attributes
 805  * @since 1.5.1
 806  */
 807 function sqimap_get_mailboxes($imap_stream,$force=false,$show_only_subscribed=true,$session_register=true) {
 808     global    $show_only_subscribed_folders,$noselect_fix_enable,$folder_prefix,
 809             $list_special_folders_first,$imap_server_type;
 810     $inbox_subscribed = false;
 811     $listsubscribed = sqimap_capability($imap_stream,'LIST-SUBSCRIBED');
 812
 813     if ($show_only_subscribed) { $show_only_subscribed=$show_only_subscribed_folders; }
 814
 815     //require_once(SM_PATH . 'include/load_prefs.php');
 816
 817     /**
 818      * There are three main listing commands we can use in IMAP:
 819      * LSUB        shows just the list of subscribed folders
 820      *            may include flags, but these are not necessarily accurate or authoratative
 821      *            \NoSelect has special meaning: the folder does not exist -OR- it means this
 822      *            folder is not subscribed but children may be
 823      *            [RFC-2060]
 824      * LIST        this shows every mailbox on the system
 825      *            flags are always included and are accurate and authoratative
 826      *            \NoSelect means folder should not be selected
 827      *            [RFC-2060]
 828      * LIST (SUBSCRIBED)    implemented with LIST-SUBSCRIBED extension
 829      *            this is like list but returns only subscribed folders
 830      *            flag meanings are like LIST, not LSUB
 831      *            \NonExistent means mailbox doesn't exist
 832      *            \PlaceHolder means parent is not valid (selectable), but one or more children are
 833      *            \NoSelect indeed means that the folder should not be selected
 834      *            IMAPEXT-LIST-EXTENSIONS-04 August 2003 B. Leiba
 835      */
 836     if (!$show_only_subscribed) {
 837         $lsub = 'LIST';
 838         $sub_cache_name='list_cache';
 839     }  elseif ($listsubscribed) {
 840         $lsub = 'LIST (SUBSCRIBED)';
 841         $sub_cache_name='listsub_cache';
 842     } else {
 843         $lsub = 'LSUB';
 844         $sub_cache_name='lsub_cache';
 845     }
 846
 847     // Some IMAP servers allow subfolders to exist even if the parent folders do not
 848     // This fixes some problems with the folder list when this is the case, causing the
 849     // NoSelect folders to be displayed
 850     if ($noselect_fix_enable) {
 851         $lsub_args = "$lsub \"$folder_prefix\" \"*%\"";
 852         $list_args = "LIST \"$folder_prefix\" \"*%\"";
 853     } else {
 854         $lsub_args = "$lsub \"$folder_prefix\" \"*\"";
 855         $list_args = "LIST \"$folder_prefix\" \"*\"";
 856     }
 857
 858     // get subscribed mailbox list from cache (session)
 859     // if not there, then get it from the imap server and store in cache
 860
 861     if (!$force) {
 862         sqgetGlobalVar($sub_cache_name,$lsub_cache,SQ_SESSION);
 863     }
 864
 865     $lsub_assoc_ary=array();
 866     if (!empty($lsub_cache)) {
 867         $lsub_assoc_ary=$lsub_cache;
 868     } else {
 869         $lsub_ary = sqimap_run_command ($imap_stream, $lsub_args, true, $response, $message);
 870         $lsub_ary = compact_mailboxes_response($lsub_ary);
 871         if (!empty($lsub_ary)) {
 872             foreach ($lsub_ary as $rawline) {
 873                 $temp_mailbox_name=find_mailbox_name($rawline);
 874                 $lsub_assoc_ary[$temp_mailbox_name]=$rawline;
 875             }
 876             unset($lsub_ary);
 877             sqsession_register($lsub_assoc_ary,$sub_cache_name);
 878         }
 879     }
 880
 881     // Now to get the mailbox flags
 882     // The LSUB response may return \NoSelect flags, etc. but it is optional
 883     // according to RFC3501, and even when returned it may not be accurate
 884     // or authoratative. LIST will always return accurate results.
 885     if (($lsub == 'LIST') || ($lsub == 'LIST (SUBSCRIBED)')) {
 886         // we've already done a LIST or LIST (SUBSCRIBED)
 887         // and NOT a LSUB, so no need to do it again
 888         $list_assoc_ary  = $lsub_assoc_ary;
 889     } else {
 890         // we did a LSUB so now we need to do a LIST
 891         // first see if it is in cache
 892         $list_cache_name='list_cache';
 893         if (!$force) {
 894             sqgetGlobalVar($list_cache_name,$list_cache,SQ_SESSION);
 895         }
 896
 897         if (!empty($list_cache)) {
 898             $list_assoc_ary=$list_cache;
 899             // we could store this in list_cache_name but not necessary
 900         } else {
 901             // not in cache so we need to go get it from the imap server
 902             $list_assoc_ary = array();
 903             $list_ary = sqimap_run_command($imap_stream, $list_args,
 904                                            true, $response, $message);
 905             $list_ary = compact_mailboxes_response($list_ary);
 906             if (!empty($list_ary)) {
 907                 foreach ($list_ary as $rawline) {
 908                     $temp_mailbox_name=find_mailbox_name($rawline);
 909                     $list_assoc_ary[$temp_mailbox_name]=$rawline;
 910                 }
 911                 unset($list_ary);
 912                 sqsession_register($list_assoc_ary,$list_cache_name);
 913             }
 914         }
 915     }
 916
 917     // If they aren't subscribed to the inbox, then add it anyway (if its in LIST)
 918     $inbox_subscribed=false;
 919     if (!empty($lsub_assoc_ary)) {
 920         foreach ($lsub_assoc_ary as $temp_mailbox_name=>$rawline) {
 921             if (strtoupper($temp_mailbox_name) == 'INBOX') {
 922                 $inbox_subscribed=true;
 923             }
 924         }
 925     }
 926     if (!$inbox_subscribed)  {
 927         if (!empty($list_assoc_ary)) {
 928             foreach ($list_assoc_ary as $temp_mailbox_name=>$rawline) {
 929                 if (strtoupper($temp_mailbox_name) == 'INBOX') {
 930                     $lsub_assoc_ary[$temp_mailbox_name]=$rawline;
 931                 }
 932             }
 933         }
 934     }
 935
 936     // Now we have the raw output, we need to create an array of mailbox names we will return
 937     if (!$show_only_subscribed) {
 938         $final_folders_assoc_ary=$list_assoc_ary;
 939     } else {
 940         /**
 941          * only show subscribed folders
 942          * we need to merge the folders here... we can't trust the flags, etc. from the lsub_assoc_array
 943          * so we use the lsub_assoc_array as the list of folders and the values come from list_assoc_array
 944          */
 945         if (!empty($lsub_assoc_ary)) {
 946             foreach ($lsub_assoc_ary as $temp_mailbox_name=>$rawline) {
 947                 if (!empty($list_assoc_ary[$temp_mailbox_name])) {
 948                     $final_folders_assoc_ary[$temp_mailbox_name]=$list_assoc_ary[$temp_mailbox_name];
 949                 }
 950             }
 951         }
 952     }
 953
 954
 955     // Now produce a flat, sorted list
 956     if (!empty($final_folders_assoc_ary)) {
 957         uksort($final_folders_assoc_ary,'strnatcasecmp');
 958         foreach ($final_folders_assoc_ary as $temp_mailbox_name=>$rawline) {
 959             $final_folders_ary[]=$rawline;
 960         }
 961     }
 962
 963     // this will put it into an array we can use later
 964     // containing:
 965     // raw    - Raw LIST/LSUB response from the IMAP server
 966     // formatted - formatted folder name
 967     // unformatted - unformatted, but with the delimiter at the end removed
 968     // unformated-dm - folder name as it appears in raw response
 969     // unformatted-disp - unformatted without $folder_prefix
 970     // id - the array element number (0, 1, 2, etc.)
 971     // flags - mailbox flags
 972     if (!empty($final_folders_ary)) {
 973         $boxesall = sqimap_mailbox_parse($final_folders_ary);
 974     } else {
 975         // they have no mailboxes
 976         $boxesall=array();
 977     }
 978
 979     /* Now, lets sort for special folders */
 980     $boxesnew = $used = array();
 981
 982     /* Find INBOX */
 983     $cnt = count($boxesall);
 984     $used = array_pad($used,$cnt,false);
 985     $has_inbox = false;
 986     for($k = 0; $k < $cnt; ++$k) {
 987         if (strtoupper($boxesall[$k]['unformatted']) == 'INBOX') {
 988             $boxesnew[] = $boxesall[$k];
 989             $used[$k] = true;
 990             $has_inbox = true;
 991             break;
 992         }
 993     }
 994
 995     if ($has_inbox == false) {
 996         // do a list request for inbox because we should always show
 997         // inbox even if the user isn't subscribed to it.
 998         $inbox_ary = sqimap_run_command($imap_stream, 'LIST "" "INBOX"',
 999                                         true, $response, $message);
1000         $inbox_ary = compact_mailboxes_response($inbox_ary);
1001         if (count($inbox_ary)) {
1002             $inbox_entry = sqimap_mailbox_parse($inbox_ary);
1003             // add it on top of the list
1004             if (!empty($boxesnew)) {
1005                 array_unshift($boxesnew,$inbox_entry[0]);
1006             } else {
1007                 $boxesnew[]=$inbox_entry[0];
1008             }
1009             /* array_unshift($used,true); */
1010         }
1011     }
1012
1013     /* List special folders and their subfolders, if requested. */
1014     if ($list_special_folders_first) {
1015         for($k = 0; $k < $cnt; ++$k) {
1016             if (!$used[$k] && isSpecialMailbox($boxesall[$k]['unformatted'])) {
1017                 $boxesnew[] = $boxesall[$k];
1018                 $used[$k]   = true;
1019             }
1020         }
1021     }
1022
1023     /* Find INBOX's children */
1024     for($k = 0; $k < $cnt; ++$k) {
1025         $isboxbelow=isBoxBelow(strtoupper($boxesall[$k]['unformatted']),'INBOX');
1026         if (strtoupper($boxesall[$k]['unformatted']) == 'INBOX') {
1027             $is_inbox=1;
1028         } else {
1029             $is_inbox=0;
1030         }
1031
1032         if (!$used[$k] && $isboxbelow && $is_inbox) {
1033             $boxesnew[] = $boxesall[$k];
1034             $used[$k] = true;
1035         }
1036     }
1037
1038     /* Rest of the folders */
1039     for($k = 0; $k < $cnt; $k++) {
1040         if (!$used[$k]) {
1041             $boxesnew[] = $boxesall[$k];
1042         }
1043     }
1044     /**
1045      * Don't register boxes in session, if $session_register is set to false
1046      * Prevents registration of sqimap_mailbox_list_all() results.
1047      */
1048     if ($session_register) sqsession_register($boxesnew,'boxesnew');
1049     return $boxesnew;
1050 }
1051
1052 /**
1053  * Fills mailbox object
1054  *
1055  * this is passed the mailbox array by left_main.php
1056  * who has previously obtained it from sqimap_get_mailboxes
1057  * that way, the raw mailbox list is available in left_main to other
1058  * things besides just sqimap_mailbox_tree
1059  * imap_stream is just used now to get status info
1060  *
1061  * most of the functionality is moved to sqimap_get_mailboxes
1062  * also takes care of TODO items:
1063  * caching mailbox tree
1064  * config setting for UW imap section (not needed now)
1065  *
1066  * Some code fragments are present in 1.3.0 - 1.4.4.
1067  * @param stream $imap_stream imap connection resource
1068  * @param array $lsub_ary output array from sqimap_get_mailboxes (contains mailboxes and flags)
1069  * @return object see mailboxes class.
1070  * @since 1.5.0
1071  */
1072 function sqimap_mailbox_tree($imap_stream,$lsub_ary) {
1073
1074     $sorted_lsub_ary = array();
1075     $cnt = count($lsub_ary);
1076     for ($i = 0; $i < $cnt; $i++) {
1077         $mbx=$lsub_ary[$i]['unformatted'];
1078         $flags=$lsub_ary[$i]['flags'];
1079
1080         $noinferiors=0;
1081         if (in_array('\Noinferiors',$flags)) { $noinferiors=1; }
1082         if (in_array('\NoInferiors',$flags)) { $noinferiors=1; }
1083         if (in_array('\HasNoChildren',$flags)) { $noinferiors=1; }
1084
1085         $noselect=0;
1086         if (in_array('\NoSelect',$flags)) { $noselect=1; }
1087         /**
1088          * LIST (SUBSCRIBED) has two new flags, \NonExistent which means the mailbox is subscribed to
1089          * but doesn't exist, and \PlaceHolder which is similar (but not the same) as \NoSelect
1090          * For right now, we'll treat these the same as \NoSelect and this behavior can be changed
1091          * later if needed
1092          */
1093         if (in_array('\NonExistent',$flags)) { $noselect=1; }
1094         if (in_array('\PlaceHolder',$flags)) { $noselect=1; }
1095         $sorted_lsub_ary[] = array ('mbx' => $mbx, 'noselect' => $noselect, 'noinferiors' => $noinferiors);
1096     }
1097
1098     $sorted_lsub_ary = array_values($sorted_lsub_ary);
1099     usort($sorted_lsub_ary, 'mbxSort');
1100     $boxestree = sqimap_fill_mailbox_tree($sorted_lsub_ary,false,$imap_stream);
1101     return $boxestree;
1102 }
1103
1104 /**
1105  * Callback function used for sorting mailboxes in sqimap_mailbox_tree
1106  * @param string $a
1107  * @param string $b
1108  * @return integer see php strnatcasecmp()
1109  * @since 1.5.1
1110  */
1111 function mbxSort($a, $b) {
1112     return strnatcasecmp($a['mbx'], $b['mbx']);
1113 }
1114
1115 /**
1116  * Fills mailbox object
1117  *
1118  * Some code fragments are present in 1.3.0 - 1.4.4.
1119  * @param array $mbx_ary
1120  * @param $mbxs
1121  * @param stream $imap_stream imap connection resource
1122  * @return object see mailboxes class
1123  * @since 1.5.0
1124  */
1125 function sqimap_fill_mailbox_tree($mbx_ary, $mbxs=false,$imap_stream) {
1126     global $data_dir, $username, $list_special_folders_first,
1127            $folder_prefix, $trash_folder, $sent_folder, $draft_folder,
1128            $move_to_trash, $move_to_sent, $save_as_draft,
1129            $delimiter, $imap_server_type;
1130
1131     // $special_folders = array ('INBOX', $sent_folder, $draft_folder, $trash_folder);
1132
1133     /* create virtual root node */
1134     $mailboxes= new mailboxes();
1135     $mailboxes->is_root = true;
1136     $trail_del = false;
1137     $start = 0;
1138
1139     if (isset($folder_prefix) && ($folder_prefix != '')) {
1140         $start = substr_count($folder_prefix,$delimiter);
1141         if (strrpos($folder_prefix, $delimiter) == (strlen($folder_prefix)-1)) {
1142             $mailboxes->mailboxname_full = substr($folder_prefix,0, (strlen($folder_prefix)-1));
1143         } else {
1144             $mailboxes->mailboxname_full = $folder_prefix;
1145             $start++;
1146         }
1147         $mailboxes->mailboxname_sub = $mailboxes->mailboxname_full;
1148     } else {
1149         $start = 0;
1150     }
1151
1152     $cnt = count($mbx_ary);
1153     for ($i=0; $i < $cnt; $i++) {
1154         if ($mbx_ary[$i]['mbx'] !='' ) {
1155             $mbx = new mailboxes();
1156             $mailbox = $mbx_ary[$i]['mbx'];
1157
1158             /*
1159              * Set the is_special flag if it concerned a special mailbox.
1160              * Used for displaying the special folders on top in the mailbox
1161              * tree displaying code.
1162              */
1163             $mbx->is_special |= ($mbx->is_inbox = (strtoupper($mailbox) == 'INBOX'));
1164             $mbx->is_special |= ($mbx->is_trash = isTrashMailbox($mailbox));
1165             $mbx->is_special |= ($mbx->is_sent = isSentMailbox($mailbox));
1166             $mbx->is_special |= ($mbx->is_draft = isDraftMailbox($mailbox));
1167
1168             if (!$mbx->is_special)
1169                 $mbx->is_special = boolean_hook_function('special_mailbox', $mailbox, 1);
1170
1171             if (isset($mbx_ary[$i]['unseen'])) {
1172                 $mbx->unseen = $mbx_ary[$i]['unseen'];
1173             }
1174             if (isset($mbx_ary[$i]['nummessages'])) {
1175                 $mbx->total = $mbx_ary[$i]['nummessages'];
1176             }
1177
1178             $mbx->is_noselect = $mbx_ary[$i]['noselect'];
1179             $mbx->is_noinferiors = $mbx_ary[$i]['noinferiors'];
1180
1181             $r_del_pos = strrpos($mbx_ary[$i]['mbx'], $delimiter);
1182             if ($r_del_pos) {
1183                 $mbx->mailboxname_sub = substr($mbx_ary[$i]['mbx'],$r_del_pos+1);
1184             } else {   /* mailbox is root folder */
1185                 $mbx->mailboxname_sub = $mbx_ary[$i]['mbx'];
1186             }
1187             $mbx->mailboxname_full = $mbx_ary[$i]['mbx'];
1188
1189             $mailboxes->addMbx($mbx, $delimiter, $start, $list_special_folders_first);
1190         }
1191     }
1192     sqimap_utf7_decode_mbx_tree($mailboxes);
1193     sqimap_get_status_mbx_tree($imap_stream,$mailboxes);
1194     return $mailboxes;
1195 }
1196
1197 /**
1198  * @param object $mbx_tree
1199  * @since 1.5.0
1200  */
1201 function sqimap_utf7_decode_mbx_tree(&$mbx_tree) {
1202     global $draft_folder, $sent_folder, $trash_folder, $translate_special_folders;
1203
1204     /* decode folder name and set mailboxname_sub */
1205     if ($translate_special_folders && strtoupper($mbx_tree->mailboxname_full) == 'INBOX') {
1206         $mbx_tree->mailboxname_sub = _("INBOX");
1207     } elseif ($translate_special_folders && $mbx_tree->mailboxname_full == $draft_folder) {
1208         $mbx_tree->mailboxname_sub = _("Drafts");
1209     } elseif ($translate_special_folders && $mbx_tree->mailboxname_full == $sent_folder) {
1210         $mbx_tree->mailboxname_sub = _("Sent");
1211     } elseif ($translate_special_folders && $mbx_tree->mailboxname_full == $trash_folder) {
1212         $mbx_tree->mailboxname_sub = _("Trash");
1213     } else {
1214         $mbx_tree->mailboxname_sub = imap_utf7_decode_local($mbx_tree->mailboxname_sub);
1215     }
1216
1217     if ($mbx_tree->mbxs) {
1218         $iCnt = count($mbx_tree->mbxs);
1219         for ($i=0;$i<$iCnt;++$i) {
1220             sqimap_utf7_decode_mbx_tree($mbx_tree->mbxs[$i]);
1221         }
1222     }
1223 }
1224
1225 /**
1226  * @param object $mbx_tree
1227  * @param array $aMbxs
1228  * @since 1.5.0
1229  */
1230 function sqimap_tree_to_ref_array(&$mbx_tree,&$aMbxs) {
1231    if ($mbx_tree)
1232    $aMbxs[] =& $mbx_tree;
1233    if ($mbx_tree->mbxs) {
1234       $iCnt = count($mbx_tree->mbxs);
1235       for ($i=0;$i<$iCnt;++$i) {
1236          sqimap_tree_to_ref_array($mbx_tree->mbxs[$i],$aMbxs);
1237       }
1238    }
1239 }
1240
1241 /**
1242  * @param stream $imap_stream imap connection resource
1243  * @param object $mbx_tree
1244  * @since since 1.5.0
1245  */
1246 function sqimap_get_status_mbx_tree($imap_stream,&$mbx_tree) {
1247     global $unseen_notify, $unseen_type, $trash_folder,$move_to_trash;
1248     $aMbxs = $aQuery = array();
1249     sqimap_tree_to_ref_array($mbx_tree,$aMbxs);
1250     // remove the root node
1251     array_shift($aMbxs);
1252
1253     if($unseen_notify == 3) {
1254         $cnt = count($aMbxs);
1255         for($i=0;$i<$cnt;++$i) {
1256             $oMbx =& $aMbxs[$i];
1257             if (!$oMbx->is_noselect) {
1258                 $mbx = $oMbx->mailboxname_full;
1259                 if ($unseen_type == 2 ||
1260                    ($move_to_trash && $oMbx->mailboxname_full == $trash_folder)) {
1261                    $query = 'STATUS ' . sqimap_encode_mailbox_name($mbx) . ' (MESSAGES UNSEEN RECENT)';
1262                 } else {
1263                    $query = 'STATUS ' . sqimap_encode_mailbox_name($mbx) . ' (UNSEEN RECENT)';
1264                 }
1265                 sqimap_prepare_pipelined_query($query,$tag,$aQuery,false);
1266             } else {
1267                 $oMbx->unseen = $oMbx->total = $oMbx->recent = false;
1268                 $tag = false;
1269             }
1270             $oMbx->tag = $tag;
1271             $aMbxs[$i] =& $oMbx;
1272         }
1273         // execute all the queries at once
1274         $aResponse = sqimap_run_pipelined_command ($imap_stream, $aQuery, false, $aServerResponse, $aServerMessage);
1275         $cnt = count($aMbxs);
1276         for($i=0;$i<$cnt;++$i) {
1277             $oMbx =& $aMbxs[$i];
1278             $tag = $oMbx->tag;
1279             if ($tag && $aServerResponse[$tag] == 'OK') {
1280                 $sResponse = implode('', $aResponse[$tag]);
1281                 if (preg_match('/UNSEEN\s+([0-9]+)/i', $sResponse, $regs)) {
1282                     $oMbx->unseen = $regs[1];
1283                 }
1284                 if (preg_match('/MESSAGES\s+([0-9]+)/i', $sResponse, $regs)) {
1285                     $oMbx->total = $regs[1];
1286                 }
1287                 if (preg_match('/RECENT\s+([0-9]+)/i', $sResponse, $regs)) {
1288                     $oMbx->recent = $regs[1];
1289                 }
1290
1291            }
1292            unset($oMbx->tag);
1293         }
1294     } else if ($unseen_notify == 2) { // INBOX only
1295         $cnt = count($aMbxs);
1296         for($i=0;$i<$cnt;++$i) {
1297             $oMbx =& $aMbxs[$i];
1298             if (strtoupper($oMbx->mailboxname_full) == 'INBOX' ||
1299                ($move_to_trash && $oMbx->mailboxname_full == $trash_folder)) {
1300                  if ($unseen_type == 2 ||
1301                    ($oMbx->mailboxname_full == $trash_folder && $move_to_trash)) {
1302                     $aStatus = sqimap_status_messages($imap_stream,$oMbx->mailboxname_full);
1303                     $oMbx->unseen = $aStatus['UNSEEN'];
1304                     $oMbx->total  = $aStatus['MESSAGES'];
1305                     $oMbx->recent = $aStatus['RECENT'];
1306                 } else {
1307                     $oMbx->unseen = sqimap_unseen_messages($imap_stream,$oMbx->mailboxname_full);
1308                 }
1309                 $aMbxs[$i] =& $oMbx;
1310                 if (!$move_to_trash && $trash_folder) {
1311                     break;
1312                 } else {
1313                    // trash comes after INBOX
1314                    if ($oMbx->mailboxname_full == $trash_folder) {
1315                       break;
1316                    }
1317                 }
1318             }
1319         }
1320     }
1321
1322     $cnt = count($aMbxs);
1323     for($i=0;$i<$cnt;++$i) {
1324          $oMbx =& $aMbxs[$i];
1325          unset($hook_status);
1326          if (!empty($oMbx->unseen)) { $hook_status['UNSEEN']=$oMbx->unseen; }
1327          if (!empty($oMbx->total)) { $hook_status['MESSAGES']=$oMbx->total; }
1328          if (!empty($oMbx->recent)) { $hook_status['RECENT']=$oMbx->recent; }
1329          if (!empty($hook_status))
1330          {
1331               $hook_status['MAILBOX']=$oMbx->mailboxname_full;
1332               $hook_status['CALLER']='sqimap_get_status_mbx_tree'; // helps w/ debugging
1333               do_hook_function('folder_status',$hook_status);
1334          }
1335     }
1336 }
1337
1338 /**
1339  * Checks if folder is noselect (can't store messages)
1340  *
1341  * Function does not check if folder subscribed.
1342  * @param stream $oImapStream imap connection resource
1343  * @param string $sImapFolder imap folder name
1344  * @param object $oBoxes mailboxes class object.
1345  * @return boolean true, when folder has noselect flag. false in any other case.
1346  * @since 1.5.1
1347  */
1348 function sqimap_mailbox_is_noselect($oImapStream,$sImapFolder,&$oBoxes) {
1349     // build mailbox object if it is not available
1350     if (! is_object($oBoxes)) $oBoxes=sqimap_mailbox_list($oImapStream);
1351     foreach($oBoxes as $box) {
1352         if ($box['unformatted']==$sImapFolder) {
1353             return (bool) check_is_noselect($box['raw']);
1354         }
1355     }
1356     return false;
1357 }
1358
1359 /**
1360  * Checks if folder is noinferiors (can't store other folders)
1361  *
1362  * Function does not check if folder subscribed.
1363  * @param stream $oImapStream imap connection resource
1364  * @param string $sImapFolder imap folder name
1365  * @param object $oBoxes mailboxes class object.
1366  * @return boolean true, when folder has noinferiors flag. false in any other case.
1367  * @since 1.5.1
1368  */
1369 function sqimap_mailbox_is_noinferiors($oImapStream,$sImapFolder,&$oBoxes) {
1370     // build mailbox object if it is not available
1371     if (! is_object($oBoxes)) $oBoxes=sqimap_mailbox_list($oImapStream);
1372     foreach($oBoxes as $box) {
1373         if ($box['unformatted']==$sImapFolder) {
1374             return (bool) check_is_noinferiors($box['raw']);
1375         }
1376     }
1377     return false;
1378 }