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-2007 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     if (empty($mailbox)) {
 364         return;
 365     }
 366
 367     // cleanup $mailbox in order to prevent IMAP injection attacks
 368     $mailbox = str_replace(array("\r","\n"), array("",""),$mailbox);
 369
 370     /**
 371      * Default UW IMAP server configuration allows to access other files
 372      * on server. $imap_server_type is not checked because interface can
 373      * be used with 'other' or any other server type setting. $mailbox
 374      * variable can be modified in any script that uses variable from GET
 375      * or POST. This code blocks all standard SquirrelMail IMAP API requests
 376      * that use mailbox with full path (/etc/passwd) or with ../ characters
 377      * in path (../../etc/passwd)
 378      */
 379     if (strstr($mailbox, '../') || substr($mailbox, 0, 1) == '/') {
 380         global $oTemplate;
 381         error_box(sprintf(_("Invalid mailbox name: %s"),htmlspecialchars($mailbox)));
 382         sqimap_logout($imap_stream);
 383         $oTemplate->display('footer.tpl');
 384         die();
 385     }
 386
 387     $read = sqimap_run_command($imap_stream, 'SELECT ' . sqimap_encode_mailbox_name($mailbox),
 388                                true, $response, $message);
 389     $result = array();
 390     for ($i = 0, $cnt = count($read); $i < $cnt; $i++) {
 391         if (preg_match('/^\*\s+OK\s\[(\w+)\s(\w+)\]/',$read[$i], $regs)) {
 392             $result[strtoupper($regs[1])] = $regs[2];
 393         } else if (preg_match('/^\*\s([0-9]+)\s(\w+)/',$read[$i], $regs)) {
 394             $result[strtoupper($regs[2])] = $regs[1];
 395         } else {
 396             if (preg_match("/PERMANENTFLAGS(.*)/i",$read[$i], $regs)) {
 397                 $regs[1]=trim(preg_replace (  array ("/\(/","/\)/","/\]/") ,'', $regs[1])) ;
 398                 $result['PERMANENTFLAGS'] = explode(' ',strtolower($regs[1]));
 399             } else if (preg_match("/FLAGS(.*)/i",$read[$i], $regs)) {
 400                 $regs[1]=trim(preg_replace (  array ("/\(/","/\)/") ,'', $regs[1])) ;
 401                 $result['FLAGS'] = explode(' ',strtolower($regs[1]));
 402             }
 403         }
 404     }
 405     if (!isset($result['PERMANENTFLAGS'])) {
 406         $result['PERMANENTFLAGS'] = $result['FLAGS'];
 407     }
 408     if (preg_match('/^\[(.+)\]/',$message, $regs)) {
 409         $result['RIGHTS']=strtoupper($regs[1]);
 410     }
 411
 412     return $result;
 413 }
 414
 415 /**
 416  * Creates a folder.
 417  *
 418  * Mailbox is automatically subscribed.
 419  *
 420  * Set $type to string that does not match 'noselect' (case insensitive),
 421  * if you don't want to prepend delimiter to mailbox name. Please note
 422  * that 'noinferiors' might be used someday as keyword for folders
 423  * that store only messages.
 424  * @param stream $imap_steam imap connection resource
 425  * @param string $mailbox mailbox name
 426  * @param string $type folder type.
 427  * @since 1.0 or older
 428  */
 429 function sqimap_mailbox_create ($imap_stream, $mailbox, $type) {
 430     global $delimiter;
 431     if (strtolower($type) == 'noselect') {
 432         $create_mailbox = $mailbox . $delimiter;
 433     } else {
 434         $create_mailbox = $mailbox;
 435     }
 436
 437     $read_ary = sqimap_run_command($imap_stream, 'CREATE ' .
 438                                    sqimap_encode_mailbox_name($create_mailbox),
 439                                    true, $response, $message);
 440     sqimap_subscribe ($imap_stream, $mailbox);
 441 }
 442
 443 /**
 444  * Subscribes to an existing folder.
 445  * @param stream $imap_stream imap connection resource
 446  * @param string $mailbox mailbox name
 447  * @param boolean $debug (since 1.5.1)
 448  * @since 1.0 or older
 449  */
 450 function sqimap_subscribe ($imap_stream, $mailbox,$debug=true) {
 451     $read_ary = sqimap_run_command($imap_stream, 'SUBSCRIBE ' .
 452                                    sqimap_encode_mailbox_name($mailbox),
 453                                    $debug, $response, $message);
 454 }
 455
 456 /**
 457  * Unsubscribes from an existing folder
 458  * @param stream $imap_stream imap connection resource
 459  * @param string $mailbox mailbox name
 460  * @since 1.0 or older
 461  */
 462 function sqimap_unsubscribe ($imap_stream, $mailbox) {
 463     $read_ary = sqimap_run_command($imap_stream, 'UNSUBSCRIBE ' .
 464                                    sqimap_encode_mailbox_name($mailbox),
 465                                    false, $response, $message);
 466 }
 467
 468 /**
 469  * Deletes the given folder
 470  * Since 1.2.6 and 1.3.0 contains rename_or_delete_folder hook
 471  * @param stream $imap_stream imap connection resource
 472  * @param string $mailbox mailbox name
 473  * @since 1.0 or older
 474  */
 475 function sqimap_mailbox_delete ($imap_stream, $mailbox) {
 476     global $data_dir, $username;
 477     sqimap_unsubscribe ($imap_stream, $mailbox);
 478
 479     if (sqimap_mailbox_exists($imap_stream, $mailbox)) {
 480
 481         $read_ary = sqimap_run_command($imap_stream, 'DELETE ' .
 482                                        sqimap_encode_mailbox_name($mailbox),
 483                                        true, $response, $message);
 484         if ($response !== 'OK') {
 485             // subscribe again
 486             sqimap_subscribe ($imap_stream, $mailbox);
 487         } else {
 488             do_hook('rename_or_delete_folder', $temp=array(&$mailbox, 'delete', ''));
 489             removePref($data_dir, $username, "thread_$mailbox");
 490             removePref($data_dir, $username, "collapse_folder_$mailbox");
 491         }
 492     }
 493 }
 494
 495 /**
 496  * Determines if the user is subscribed to the folder or not
 497  * @param stream $imap_stream imap connection resource
 498  * @param string $mailbox mailbox name
 499  * @return boolean
 500  * @since 1.2.0
 501  */
 502 function sqimap_mailbox_is_subscribed($imap_stream, $folder) {
 503     $boxesall = sqimap_mailbox_list ($imap_stream);
 504     foreach ($boxesall as $ref) {
 505         if ($ref['unformatted'] == $folder) {
 506             return true;
 507         }
 508     }
 509     return false;
 510 }
 511
 512 /**
 513  * Renames a mailbox.
 514  * Since 1.2.6 and 1.3.0 contains rename_or_delete_folder hook
 515  * @param stream $imap_stream imap connection resource
 516  * @param string $old_name mailbox name
 517  * @param string $new_name new mailbox name
 518  * @since 1.2.3
 519  */
 520 function sqimap_mailbox_rename( $imap_stream, $old_name, $new_name ) {
 521     if ( $old_name != $new_name ) {
 522         global $delimiter, $imap_server_type, $data_dir, $username;
 523         if ( substr( $old_name, -1 ) == $delimiter  ) {
 524             $old_name = substr( $old_name, 0, strlen( $old_name ) - 1 );
 525             $new_name = substr( $new_name, 0, strlen( $new_name ) - 1 );
 526             $postfix = $delimiter;
 527         } else {
 528             $postfix = '';
 529         }
 530
 531         $boxesall = sqimap_mailbox_list_all($imap_stream);
 532         $cmd = 'RENAME ' . sqimap_encode_mailbox_name($old_name) .
 533                      ' ' . sqimap_encode_mailbox_name($new_name);
 534         $data = sqimap_run_command($imap_stream, $cmd, true, $response, $message);
 535         sqimap_unsubscribe($imap_stream, $old_name.$postfix);
 536         $oldpref_thread = getPref($data_dir, $username, 'thread_'.$old_name.$postfix);
 537         $oldpref_collapse = getPref($data_dir, $username, 'collapse_folder_'.$old_name.$postfix);
 538         removePref($data_dir, $username, 'thread_'.$old_name.$postfix);
 539         removePref($data_dir, $username, 'collapse_folder_'.$old_name.$postfix);
 540         sqimap_subscribe($imap_stream, $new_name.$postfix);
 541         setPref($data_dir, $username, 'thread_'.$new_name.$postfix, $oldpref_thread);
 542         setPref($data_dir, $username, 'collapse_folder_'.$new_name.$postfix, $oldpref_collapse);
 543         do_hook('rename_or_delete_folder', $temp=array(&$old_name, 'rename', &$new_name));
 544         $l = strlen( $old_name ) + 1;
 545         $p = 'unformatted';
 546
 547         foreach ($boxesall as $box) {
 548             if (substr($box[$p], 0, $l) == $old_name . $delimiter) {
 549                 $new_sub = $new_name . $delimiter . substr($box[$p], $l);
 550                 /* With Cyrus IMAPd >= 2.0 rename is recursive, so don't check for errors here */
 551                 if ($imap_server_type == 'cyrus') {
 552                     $cmd = 'RENAME "' . $box[$p] . '" "' . $new_sub . '"';
 553                     $data = sqimap_run_command($imap_stream, $cmd, false,
 554                                                $response, $message);
 555                 }
 556                 $was_subscribed = sqimap_mailbox_is_subscribed($imap_stream, $box[$p]);
 557                 if ( $was_subscribed ) {
 558                     sqimap_unsubscribe($imap_stream, $box[$p]);
 559                 }
 560                 $oldpref_thread = getPref($data_dir, $username, 'thread_'.$box[$p]);
 561                 $oldpref_collapse = getPref($data_dir, $username, 'collapse_folder_'.$box[$p]);
 562                 removePref($data_dir, $username, 'thread_'.$box[$p]);
 563                 removePref($data_dir, $username, 'collapse_folder_'.$box[$p]);
 564                 if ( $was_subscribed ) {
 565                     sqimap_subscribe($imap_stream, $new_sub);
 566                 }
 567                 setPref($data_dir, $username, 'thread_'.$new_sub, $oldpref_thread);
 568                 setPref($data_dir, $username, 'collapse_folder_'.$new_sub, $oldpref_collapse);
 569                 do_hook('rename_or_delete_folder', $temp=array(&$box[$p], 'rename', &$new_sub));
 570             }
 571         }
 572     }
 573 }
 574
 575 /**
 576  * Formats a mailbox into parts for the $boxesall array
 577  *
 578  * The parts are:
 579  * <ul>
 580  *   <li>raw            - Raw LIST/LSUB response from the IMAP server
 581  *   <li>formatted      - nicely formatted folder name
 582  *   <li>unformatted    - unformatted, but with delimiter at end removed
 583  *   <li>unformatted-dm - folder name as it appears in raw response
 584  *   <li>unformatted-disp - unformatted without $folder_prefix
 585  *   <li>id             - TODO: document me
 586  *   <li>flags          - TODO: document me
 587  * </ul>
 588  * Before 1.2.0 used third argument for delimiter.
 589  *
 590  * Before 1.5.1 used second argument for lsub line. Argument was removed in order to use
 591  * find_mailbox_name() on the raw input. Since 1.5.1 includes RFC3501 names in flags
 592  * array (for example, "\NoSelect" in addition to "noselect")
 593  * @param array $line
 594  * @return array
 595  * @since 1.0 or older
 596  * @todo document id and flags keys in boxes array and function arguments.
 597  */
 598 function sqimap_mailbox_parse ($line) {
 599     global $folder_prefix, $delimiter;
 600
 601     /* Process each folder line */
 602     for ($g = 0, $cnt = count($line); $g < $cnt; ++$g) {
 603         /* Store the raw IMAP reply */
 604         if (isset($line[$g])) {
 605             $boxesall[$g]['raw'] = $line[$g];
 606         } else {
 607             $boxesall[$g]['raw'] = '';
 608         }
 609
 610         /* Count number of delimiters ($delimiter) in folder name */
 611         $mailbox = find_mailbox_name($line[$g]);
 612         $dm_count = substr_count($mailbox, $delimiter);
 613         if (substr($mailbox, -1) == $delimiter) {
 614             /* If name ends in delimiter, decrement count by one */
 615             $dm_count--;
 616         }
 617
 618         /* Format folder name, but only if it's a INBOX.* or has a parent. */
 619         $boxesallbyname[$mailbox] = $g;
 620         $parentfolder = readMailboxParent($mailbox, $delimiter);
 621         if ( (strtolower(substr($mailbox, 0, 5)) == "inbox") ||
 622              (substr($mailbox, 0, strlen($folder_prefix)) == $folder_prefix) ||
 623              (isset($boxesallbyname[$parentfolder]) &&
 624               (strlen($parentfolder) > 0) ) ) {
 625             $indent = $dm_count - (substr_count($folder_prefix, $delimiter));
 626             if ($indent > 0) {
 627                 $boxesall[$g]['formatted'] = str_repeat('&nbsp;&nbsp;', $indent);
 628             } else {
 629                 $boxesall[$g]['formatted'] = '';
 630             }
 631             $boxesall[$g]['formatted'] .= imap_utf7_decode_local(readShortMailboxName($mailbox, $delimiter));
 632         } else {
 633             $boxesall[$g]['formatted']  = imap_utf7_decode_local($mailbox);
 634         }
 635
 636         $boxesall[$g]['unformatted-dm'] = $mailbox;
 637         if (substr($mailbox, -1) == $delimiter) {
 638             $mailbox = substr($mailbox, 0, strlen($mailbox) - 1);
 639         }
 640         $boxesall[$g]['unformatted'] = $mailbox;
 641         if (substr($mailbox,0,strlen($folder_prefix))==$folder_prefix) {
 642             $mailbox = substr($mailbox, strlen($folder_prefix));
 643         }
 644         $boxesall[$g]['unformatted-disp'] = $mailbox;
 645         $boxesall[$g]['id'] = $g;
 646
 647         $boxesall[$g]['flags'] = array();
 648         if (isset($line[$g])) {
 649             ereg("\(([^)]*)\)",$line[$g],$regs);
 650             /**
 651              * Since 1.5.1 flags are stored with RFC3501 naming
 652              * and also the old way for backwards compatibility
 653              * so for example "\NoSelect" and "noselect"
 654              */
 655             $flags = trim($regs[1]);
 656             if ($flags) {
 657                 $flagsarr = explode(' ',$flags);
 658                 $flagsarrnew=$flagsarr;
 659                 // add old type
 660                 foreach ($flagsarr as $flag) {
 661                     $flagsarrnew[]=strtolower(str_replace('\\', '',$flag));
 662                 }
 663                 $boxesall[$g]['flags']=$flagsarrnew;
 664             }
 665         }
 666     }
 667     return $boxesall;
 668 }
 669
 670 /**
 671  * Returns an array of mailboxes available.  Separated from sqimap_mailbox_option_list()
 672  * below for template development.
 673  *
 674  * @author Steve Brown
 675  * @since 1.5.2
 676  */
 677 function sqimap_mailbox_option_array($imap_stream, $folder_skip = 0, $boxes = 0,
 678                                     $flag = 'noselect', $use_long_format = false ) {
 679     global $username, $data_dir, $translate_special_folders, $sent_folder,
 680         $trash_folder, $draft_folder;
 681
 682     $delimiter = sqimap_get_delimiter($imap_stream);
 683
 684     $mbox_options = '';
 685     if ( $use_long_format ) {
 686         $shorten_box_names = 0;
 687     } else {
 688         $shorten_box_names = getPref($data_dir, $username, 'mailbox_select_style', SMPREF_MAILBOX_SELECT_INDENTED);
 689     }
 690
 691     if ($boxes == 0) {
 692         $boxes = sqimap_mailbox_list($imap_stream);
 693     }
 694
 695     $a = array();
 696     foreach ($boxes as $boxes_part) {
 697         if ($flag == NULL || (is_array($boxes_part['flags'])
 698                       && !in_array($flag, $boxes_part['flags']))) {
 699             $box = $boxes_part['unformatted'];
 700
 701             if ($folder_skip != 0 && in_array($box, $folder_skip) ) {
 702                 continue;
 703             }
 704             $lowerbox = strtolower($box);
 705             // mailboxes are casesensitive => inbox.sent != inbox.Sent
 706             // nevermind, to many dependencies this should be fixed!
 707
 708             if (strtolower($box) == 'inbox') { // inbox is special and not casesensitive
 709                 $box2 = _("INBOX");
 710             } else {
 711                 switch ($shorten_box_names)
 712                 {
 713                   case SMPREF_MAILBOX_SELECT_DELIMITED:
 714                       if ($translate_special_folders && $boxes_part['unformatted-dm']==$sent_folder) {
 715                           /*
 716                            * calculate pad level from number of delimiters. do it inside if control in order
 717                            * to reduce number of calculations. Other folders don't need it.
 718                            */
 719                           $pad = str_pad('',7 * (count(explode($delimiter,$boxes_part['unformatted-dm']))-1),'.&nbsp;');
 720                           // i18n: Name of Sent folder
 721                           $box2 = $pad . _("Sent");
 722                       } elseif ($translate_special_folders && $boxes_part['unformatted-dm']==$trash_folder) {
 723                           $pad = str_pad('',7 * (count(explode($delimiter,$boxes_part['unformatted-dm']))-1),'.&nbsp;');
 724                           // i18n: Name of Trash folder
 725                           $box2 = $pad . _("Trash");
 726                       } elseif ($translate_special_folders && $boxes_part['unformatted-dm']==$draft_folder) {
 727                           $pad = str_pad('',7 * (count(explode($delimiter,$boxes_part['unformatted-dm']))-1),'.&nbsp;');
 728                           // i18n: Name of Drafts folder
 729                           $box2 = $pad . _("Drafts");
 730                       } else {
 731                           $box2 = str_replace('&amp;nbsp;&amp;nbsp;', '.&nbsp;', htmlspecialchars($boxes_part['formatted']));
 732                       }
 733                     break;
 734                   case SMPREF_MAILBOX_SELECT_INDENTED:
 735                       if ($translate_special_folders && $boxes_part['unformatted-dm']==$sent_folder) {
 736                           $pad = str_pad('',12 * (count(explode($delimiter,$boxes_part['unformatted-dm']))-1),'&nbsp;&nbsp;');
 737                           $box2 = $pad . _("Sent");
 738                       } elseif ($translate_special_folders && $boxes_part['unformatted-dm']==$trash_folder) {
 739                           $pad = str_pad('',12 * (count(explode($delimiter,$boxes_part['unformatted-dm']))-1),'&nbsp;&nbsp;');
 740                           $box2 = $pad . _("Trash");
 741                       } elseif ($translate_special_folders && $boxes_part['unformatted-dm']==$draft_folder) {
 742                           $pad = str_pad('',12 * (count(explode($delimiter,$boxes_part['unformatted-dm']))-1),'&nbsp;&nbsp;');
 743                           $box2 = $pad . _("Drafts");
 744                       } else {
 745                           $box2 = str_replace('&amp;nbsp;&amp;nbsp;', '&nbsp;&nbsp;', htmlspecialchars($boxes_part['formatted']));
 746                       }
 747                     break;
 748                   default:  /* default, long names, style = 0 */
 749                     $box2 = str_replace(' ', '&nbsp;', htmlspecialchars(imap_utf7_decode_local($boxes_part['unformatted-disp'])));
 750                     break;
 751                 }
 752             }
 753
 754             $a[htmlspecialchars($box)] = $box2;
 755         }
 756     }
 757
 758     return $a;
 759 }
 760
 761 /**
 762  * Returns list of options (to be echoed into select statement
 763  * based on available mailboxes and separators
 764  * Caller should surround options with <select ...> </select> and
 765  * any formatting.
 766  * @param stream $imap_stream imap connection resource to query for mailboxes
 767  * @param array $show_selected array containing list of mailboxes to pre-select (0 if none)
 768  * @param array $folder_skip array of folders to keep out of option list (compared in lower)
 769  * @param $boxes list of already fetched boxes (for places like folder panel, where
 770  *            you know these options will be shown 3 times in a row.. (most often unset).
 771  * @param string $flag (since 1.4.1) flag to check for in mailbox flags, used to filter out mailboxes.
 772  *           'noselect' by default to remove unselectable mailboxes.
 773  *           'noinferiors' used to filter out folders that can not contain subfolders.
 774  *           NULL to avoid flag check entirely.
 775  *           NOTE: noselect and noiferiors are used internally. The IMAP representation is
 776  *                 \NoSelect and \NoInferiors
 777  * @param boolean $use_long_format (since 1.4.1) override folder display preference and always show full folder name.
 778  * @return string html formated mailbox selection options
 779  * @since 1.3.2
 780  */
 781 function sqimap_mailbox_option_list($imap_stream, $show_selected = 0, $folder_skip = 0, $boxes = 0,
 782                                     $flag = 'noselect', $use_long_format = false ) {
 783     global $username, $data_dir, $translate_special_folders, $sent_folder,
 784         $trash_folder, $draft_folder;
 785
 786     $boxes = sqimap_mailbox_option_array($imap_stream, $folder_skip, $boxes, $flag, $use_long_format);
 787
 788     $str = '';
 789     foreach ($boxes as $value=>$option) {
 790         $lowerbox = strtolower(htmlspecialchars($value));
 791         $sel = false;
 792         if ($show_selected != 0) {
 793             reset($show_selected);
 794             while (!$sel && (list($x, $val) = each($show_selected))) {
 795                 if (strtolower($value) == strtolower(htmlspecialchars($val))) {
 796                     $sel = true;
 797                 }
 798             }
 799         }
 800
 801         $str .= '<option value="'. $value .'"'. ($sel ? ' selected="selected"' : '').'>'. $option ."</option>\n";
 802     }
 803
 804     return $str;
 805 }
 806
 807 /**
 808  * Returns sorted mailbox lists in several different ways.
 809  *
 810  * Since 1.5.1 most of the functionality has been moved to new function sqimap_get_mailboxes
 811  *
 812  * See comment on sqimap_mailbox_parse() for info about the returned array.
 813  * @param resource $imap_stream imap connection resource
 814  * @param boolean $force force update of mailbox listing. available since 1.4.2 and 1.5.0
 815  * @return array list of mailboxes
 816  * @since 1.0 or older
 817  */
 818 function sqimap_mailbox_list($imap_stream, $force=false) {
 819     global $boxesnew,$show_only_subscribed_folders;
 820     if (!sqgetGlobalVar('boxesnew',$boxesnew,SQ_SESSION) || $force) {
 821         $boxesnew=sqimap_get_mailboxes($imap_stream,$force,$show_only_subscribed_folders);
 822     }
 823     return $boxesnew;
 824 }
 825
 826 /**
 827  * Returns a list of all folders, subscribed or not
 828  *
 829  * Since 1.5.1 code moved to sqimap_get_mailboxes()
 830  *
 831  * @param stream $imap_stream imap connection resource
 832  * @return array see sqimap_mailbox_parse()
 833  * @since 1.0 or older
 834  */
 835 function sqimap_mailbox_list_all($imap_stream) {
 836     global $show_only_subscribed_folders;
 837     // fourth argument prevents registration of retrieved list of mailboxes in session
 838     $boxes=sqimap_get_mailboxes($imap_stream,true,false,false);
 839     return $boxes;
 840 }
 841
 842
 843 /**
 844  * Gets the list of mailboxes for sqimap_maolbox_tree and sqimap_mailbox_list
 845  *
 846  * This is because both of those functions had duplicated logic, but with slightly different
 847  * implementations. This will make both use the same implementation, which should make it
 848  * easier to maintain and easier to modify in the future
 849  * @param stream $imap_stream imap connection resource
 850  * @param bool $force force a reload and ignore cache
 851  * @param bool $show_only_subscribed controls listing of visible or all folders
 852  * @param bool $session_register controls registration of retrieved data in session.
 853  * @return object boxesnew - array of mailboxes and their attributes
 854  * @since 1.5.1
 855  */
 856 function sqimap_get_mailboxes($imap_stream,$force=false,$show_only_subscribed=true,$session_register=true) {
 857     global    $show_only_subscribed_folders,$noselect_fix_enable,$folder_prefix,
 858             $list_special_folders_first,$imap_server_type;
 859     $inbox_subscribed = false;
 860     $listsubscribed = sqimap_capability($imap_stream,'LIST-SUBSCRIBED');
 861
 862     if ($show_only_subscribed) { $show_only_subscribed=$show_only_subscribed_folders; }
 863
 864     //require_once(SM_PATH . 'include/load_prefs.php');
 865
 866     /**
 867      * There are three main listing commands we can use in IMAP:
 868      * LSUB        shows just the list of subscribed folders
 869      *            may include flags, but these are not necessarily accurate or authoratative
 870      *            \NoSelect has special meaning: the folder does not exist -OR- it means this
 871      *            folder is not subscribed but children may be
 872      *            [RFC-2060]
 873      * LIST        this shows every mailbox on the system
 874      *            flags are always included and are accurate and authoratative
 875      *            \NoSelect means folder should not be selected
 876      *            [RFC-2060]
 877      * LIST (SUBSCRIBED)    implemented with LIST-SUBSCRIBED extension
 878      *            this is like list but returns only subscribed folders
 879      *            flag meanings are like LIST, not LSUB
 880      *            \NonExistent means mailbox doesn't exist
 881      *            \PlaceHolder means parent is not valid (selectable), but one or more children are
 882      *            \NoSelect indeed means that the folder should not be selected
 883      *            IMAPEXT-LIST-EXTENSIONS-04 August 2003 B. Leiba
 884      */
 885     if (!$show_only_subscribed) {
 886         $lsub = 'LIST';
 887         $sub_cache_name='list_cache';
 888     }  elseif ($listsubscribed) {
 889         $lsub = 'LIST (SUBSCRIBED)';
 890         $sub_cache_name='listsub_cache';
 891     } else {
 892         $lsub = 'LSUB';
 893         $sub_cache_name='lsub_cache';
 894     }
 895
 896     // Some IMAP servers allow subfolders to exist even if the parent folders do not
 897     // This fixes some problems with the folder list when this is the case, causing the
 898     // NoSelect folders to be displayed
 899     if ($noselect_fix_enable) {
 900         $lsub_args = "$lsub \"$folder_prefix\" \"*%\"";
 901         $list_args = "LIST \"$folder_prefix\" \"*%\"";
 902     } else {
 903         $lsub_args = "$lsub \"$folder_prefix\" \"*\"";
 904         $list_args = "LIST \"$folder_prefix\" \"*\"";
 905     }
 906
 907     // get subscribed mailbox list from cache (session)
 908     // if not there, then get it from the imap server and store in cache
 909
 910     if (!$force) {
 911         sqgetGlobalVar($sub_cache_name,$lsub_cache,SQ_SESSION);
 912     }
 913
 914     $lsub_assoc_ary=array();
 915     if (!empty($lsub_cache)) {
 916         $lsub_assoc_ary=$lsub_cache;
 917     } else {
 918         $lsub_ary = sqimap_run_command ($imap_stream, $lsub_args, true, $response, $message);
 919         $lsub_ary = compact_mailboxes_response($lsub_ary);
 920         if (!empty($lsub_ary)) {
 921             foreach ($lsub_ary as $rawline) {
 922                 $temp_mailbox_name=find_mailbox_name($rawline);
 923                 $lsub_assoc_ary[$temp_mailbox_name]=$rawline;
 924             }
 925             unset($lsub_ary);
 926             sqsession_register($lsub_assoc_ary,$sub_cache_name);
 927         }
 928     }
 929
 930     // Now to get the mailbox flags
 931     // The LSUB response may return \NoSelect flags, etc. but it is optional
 932     // according to RFC3501, and even when returned it may not be accurate
 933     // or authoratative. LIST will always return accurate results.
 934     if (($lsub == 'LIST') || ($lsub == 'LIST (SUBSCRIBED)')) {
 935         // we've already done a LIST or LIST (SUBSCRIBED)
 936         // and NOT a LSUB, so no need to do it again
 937         $list_assoc_ary  = $lsub_assoc_ary;
 938     } else {
 939         // we did a LSUB so now we need to do a LIST
 940         // first see if it is in cache
 941         $list_cache_name='list_cache';
 942         if (!$force) {
 943             sqgetGlobalVar($list_cache_name,$list_cache,SQ_SESSION);
 944         }
 945
 946         if (!empty($list_cache)) {
 947             $list_assoc_ary=$list_cache;
 948             // we could store this in list_cache_name but not necessary
 949         } else {
 950             // not in cache so we need to go get it from the imap server
 951             $list_assoc_ary = array();
 952             $list_ary = sqimap_run_command($imap_stream, $list_args,
 953                                            true, $response, $message);
 954             $list_ary = compact_mailboxes_response($list_ary);
 955             if (!empty($list_ary)) {
 956                 foreach ($list_ary as $rawline) {
 957                     $temp_mailbox_name=find_mailbox_name($rawline);
 958                     $list_assoc_ary[$temp_mailbox_name]=$rawline;
 959                 }
 960                 unset($list_ary);
 961                 sqsession_register($list_assoc_ary,$list_cache_name);
 962             }
 963         }
 964     }
 965
 966     // If they aren't subscribed to the inbox, then add it anyway (if its in LIST)
 967     $inbox_subscribed=false;
 968     if (!empty($lsub_assoc_ary)) {
 969         foreach ($lsub_assoc_ary as $temp_mailbox_name=>$rawline) {
 970             if (strtoupper($temp_mailbox_name) == 'INBOX') {
 971                 $inbox_subscribed=true;
 972             }
 973         }
 974     }
 975     if (!$inbox_subscribed)  {
 976         if (!empty($list_assoc_ary)) {
 977             foreach ($list_assoc_ary as $temp_mailbox_name=>$rawline) {
 978                 if (strtoupper($temp_mailbox_name) == 'INBOX') {
 979                     $lsub_assoc_ary[$temp_mailbox_name]=$rawline;
 980                 }
 981             }
 982         }
 983     }
 984
 985     // Now we have the raw output, we need to create an array of mailbox names we will return
 986     if (!$show_only_subscribed) {
 987         $final_folders_assoc_ary=$list_assoc_ary;
 988     } else {
 989         /**
 990          * only show subscribed folders
 991          * we need to merge the folders here... we can't trust the flags, etc. from the lsub_assoc_array
 992          * so we use the lsub_assoc_array as the list of folders and the values come from list_assoc_array
 993          */
 994         if (!empty($lsub_assoc_ary)) {
 995             foreach ($lsub_assoc_ary as $temp_mailbox_name=>$rawline) {
 996                 if (!empty($list_assoc_ary[$temp_mailbox_name])) {
 997                     $final_folders_assoc_ary[$temp_mailbox_name]=$list_assoc_ary[$temp_mailbox_name];
 998                 }
 999             }
1000         }
1001     }
1002
1003
1004     // Now produce a flat, sorted list
1005     if (!empty($final_folders_assoc_ary)) {
1006         uksort($final_folders_assoc_ary,'strnatcasecmp');
1007         foreach ($final_folders_assoc_ary as $temp_mailbox_name=>$rawline) {
1008             $final_folders_ary[]=$rawline;
1009         }
1010     }
1011
1012     // this will put it into an array we can use later
1013     // containing:
1014     // raw    - Raw LIST/LSUB response from the IMAP server
1015     // formatted - formatted folder name
1016     // unformatted - unformatted, but with the delimiter at the end removed
1017     // unformated-dm - folder name as it appears in raw response
1018     // unformatted-disp - unformatted without $folder_prefix
1019     // id - the array element number (0, 1, 2, etc.)
1020     // flags - mailbox flags
1021     if (!empty($final_folders_ary)) {
1022         $boxesall = sqimap_mailbox_parse($final_folders_ary);
1023     } else {
1024         // they have no mailboxes
1025         $boxesall=array();
1026     }
1027
1028     /* Now, lets sort for special folders */
1029     $boxesnew = $used = array();
1030
1031     /* Find INBOX */
1032     $cnt = count($boxesall);
1033     $used = array_pad($used,$cnt,false);
1034     $has_inbox = false;
1035     for($k = 0; $k < $cnt; ++$k) {
1036         if (strtoupper($boxesall[$k]['unformatted']) == 'INBOX') {
1037             $boxesnew[] = $boxesall[$k];
1038             $used[$k] = true;
1039             $has_inbox = true;
1040             break;
1041         }
1042     }
1043
1044     if ($has_inbox == false) {
1045         // do a list request for inbox because we should always show
1046         // inbox even if the user isn't subscribed to it.
1047         $inbox_ary = sqimap_run_command($imap_stream, 'LIST "" "INBOX"',
1048                                         true, $response, $message);
1049         $inbox_ary = compact_mailboxes_response($inbox_ary);
1050         if (count($inbox_ary)) {
1051             $inbox_entry = sqimap_mailbox_parse($inbox_ary);
1052             // add it on top of the list
1053             if (!empty($boxesnew)) {
1054                 array_unshift($boxesnew,$inbox_entry[0]);
1055             } else {
1056                 $boxesnew[]=$inbox_entry[0];
1057             }
1058             /* array_unshift($used,true); */
1059         }
1060     }
1061
1062     /* List special folders and their subfolders, if requested. */
1063     if ($list_special_folders_first) {
1064         for($k = 0; $k < $cnt; ++$k) {
1065             if (!$used[$k] && isSpecialMailbox($boxesall[$k]['unformatted'])) {
1066                 $boxesnew[] = $boxesall[$k];
1067                 $used[$k]   = true;
1068             }
1069         }
1070     }
1071
1072     /* Find INBOX's children */
1073     for($k = 0; $k < $cnt; ++$k) {
1074         $isboxbelow=isBoxBelow(strtoupper($boxesall[$k]['unformatted']),'INBOX');
1075         if (strtoupper($boxesall[$k]['unformatted']) == 'INBOX') {
1076             $is_inbox=1;
1077         } else {
1078             $is_inbox=0;
1079         }
1080
1081         if (!$used[$k] && $isboxbelow && $is_inbox) {
1082             $boxesnew[] = $boxesall[$k];
1083             $used[$k] = true;
1084         }
1085     }
1086
1087     /* Rest of the folders */
1088     for($k = 0; $k < $cnt; $k++) {
1089         if (!$used[$k]) {
1090             $boxesnew[] = $boxesall[$k];
1091         }
1092     }
1093     /**
1094      * Don't register boxes in session, if $session_register is set to false
1095      * Prevents registration of sqimap_mailbox_list_all() results.
1096      */
1097     if ($session_register) sqsession_register($boxesnew,'boxesnew');
1098     return $boxesnew;
1099 }
1100
1101 /**
1102  * Fills mailbox object
1103  *
1104  * this is passed the mailbox array by left_main.php
1105  * who has previously obtained it from sqimap_get_mailboxes
1106  * that way, the raw mailbox list is available in left_main to other
1107  * things besides just sqimap_mailbox_tree
1108  * imap_stream is just used now to get status info
1109  *
1110  * most of the functionality is moved to sqimap_get_mailboxes
1111  * also takes care of TODO items:
1112  * caching mailbox tree
1113  * config setting for UW imap section (not needed now)
1114  *
1115  * Some code fragments are present in 1.3.0 - 1.4.4.
1116  * @param stream $imap_stream imap connection resource
1117  * @param array $lsub_ary output array from sqimap_get_mailboxes (contains mailboxes and flags)
1118  * @return object see mailboxes class.
1119  * @since 1.5.0
1120  */
1121 function sqimap_mailbox_tree($imap_stream,$lsub_ary) {
1122
1123     $sorted_lsub_ary = array();
1124     $cnt = count($lsub_ary);
1125     for ($i = 0; $i < $cnt; $i++) {
1126         $mbx=$lsub_ary[$i]['unformatted'];
1127         $flags=$lsub_ary[$i]['flags'];
1128
1129         $noinferiors=0;
1130         if (in_array('\Noinferiors',$flags)) { $noinferiors=1; }
1131         if (in_array('\NoInferiors',$flags)) { $noinferiors=1; }
1132         if (in_array('\HasNoChildren',$flags)) { $noinferiors=1; }
1133
1134         $noselect=0;
1135         if (in_array('\NoSelect',$flags)) { $noselect=1; }
1136         /**
1137          * LIST (SUBSCRIBED) has two new flags, \NonExistent which means the mailbox is subscribed to
1138          * but doesn't exist, and \PlaceHolder which is similar (but not the same) as \NoSelect
1139          * For right now, we'll treat these the same as \NoSelect and this behavior can be changed
1140          * later if needed
1141          */
1142         if (in_array('\NonExistent',$flags)) { $noselect=1; }
1143         if (in_array('\PlaceHolder',$flags)) { $noselect=1; }
1144         $sorted_lsub_ary[] = array ('mbx' => $mbx, 'noselect' => $noselect, 'noinferiors' => $noinferiors);
1145     }
1146
1147     $sorted_lsub_ary = array_values($sorted_lsub_ary);
1148     usort($sorted_lsub_ary, 'mbxSort');
1149     $boxestree = sqimap_fill_mailbox_tree($sorted_lsub_ary,false,$imap_stream);
1150     return $boxestree;
1151 }
1152
1153 /**
1154  * Callback function used for sorting mailboxes in sqimap_mailbox_tree
1155  * @param string $a
1156  * @param string $b
1157  * @return integer see php strnatcasecmp()
1158  * @since 1.5.1
1159  */
1160 function mbxSort($a, $b) {
1161     return strnatcasecmp($a['mbx'], $b['mbx']);
1162 }
1163
1164 /**
1165  * Fills mailbox object
1166  *
1167  * Some code fragments are present in 1.3.0 - 1.4.4.
1168  * @param array $mbx_ary
1169  * @param $mbxs
1170  * @param stream $imap_stream imap connection resource
1171  * @return object see mailboxes class
1172  * @since 1.5.0
1173  */
1174 function sqimap_fill_mailbox_tree($mbx_ary, $mbxs=false,$imap_stream) {
1175     global $data_dir, $username, $list_special_folders_first,
1176            $folder_prefix, $trash_folder, $sent_folder, $draft_folder,
1177            $move_to_trash, $move_to_sent, $save_as_draft,
1178            $delimiter, $imap_server_type;
1179
1180     // $special_folders = array ('INBOX', $sent_folder, $draft_folder, $trash_folder);
1181
1182     /* create virtual root node */
1183     $mailboxes= new mailboxes();
1184     $mailboxes->is_root = true;
1185     $trail_del = false;
1186     $start = 0;
1187
1188     if (isset($folder_prefix) && ($folder_prefix != '')) {
1189         $start = substr_count($folder_prefix,$delimiter);
1190         if (strrpos($folder_prefix, $delimiter) == (strlen($folder_prefix)-1)) {
1191             $mailboxes->mailboxname_full = substr($folder_prefix,0, (strlen($folder_prefix)-1));
1192         } else {
1193             $mailboxes->mailboxname_full = $folder_prefix;
1194             $start++;
1195         }
1196         $mailboxes->mailboxname_sub = $mailboxes->mailboxname_full;
1197     } else {
1198         $start = 0;
1199     }
1200
1201     $cnt = count($mbx_ary);
1202     for ($i=0; $i < $cnt; $i++) {
1203         if ($mbx_ary[$i]['mbx'] !='' ) {
1204             $mbx = new mailboxes();
1205             $mailbox = $mbx_ary[$i]['mbx'];
1206
1207             /*
1208              * Set the is_special flag if it concerned a special mailbox.
1209              * Used for displaying the special folders on top in the mailbox
1210              * tree displaying code.
1211              */
1212             $mbx->is_special |= ($mbx->is_inbox = (strtoupper($mailbox) == 'INBOX'));
1213             $mbx->is_special |= ($mbx->is_trash = isTrashMailbox($mailbox));
1214             $mbx->is_special |= ($mbx->is_sent = isSentMailbox($mailbox));
1215             $mbx->is_special |= ($mbx->is_draft = isDraftMailbox($mailbox));
1216
1217             if (!$mbx->is_special)
1218                 $mbx->is_special = boolean_hook_function('special_mailbox', $mailbox, 1);
1219
1220             if (isset($mbx_ary[$i]['unseen'])) {
1221                 $mbx->unseen = $mbx_ary[$i]['unseen'];
1222             }
1223             if (isset($mbx_ary[$i]['nummessages'])) {
1224                 $mbx->total = $mbx_ary[$i]['nummessages'];
1225             }
1226
1227             $mbx->is_noselect = $mbx_ary[$i]['noselect'];
1228             $mbx->is_noinferiors = $mbx_ary[$i]['noinferiors'];
1229
1230             $r_del_pos = strrpos($mbx_ary[$i]['mbx'], $delimiter);
1231             if ($r_del_pos) {
1232                 $mbx->mailboxname_sub = substr($mbx_ary[$i]['mbx'],$r_del_pos+1);
1233             } else {   /* mailbox is root folder */
1234                 $mbx->mailboxname_sub = $mbx_ary[$i]['mbx'];
1235             }
1236             $mbx->mailboxname_full = $mbx_ary[$i]['mbx'];
1237
1238             $mailboxes->addMbx($mbx, $delimiter, $start, $list_special_folders_first);
1239         }
1240     }
1241     sqimap_utf7_decode_mbx_tree($mailboxes);
1242     sqimap_get_status_mbx_tree($imap_stream,$mailboxes);
1243     return $mailboxes;
1244 }
1245
1246 /**
1247  * @param object $mbx_tree
1248  * @since 1.5.0
1249  */
1250 function sqimap_utf7_decode_mbx_tree(&$mbx_tree) {
1251     global $draft_folder, $sent_folder, $trash_folder, $translate_special_folders;
1252
1253     /* decode folder name and set mailboxname_sub */
1254     if ($translate_special_folders && strtoupper($mbx_tree->mailboxname_full) == 'INBOX') {
1255         $mbx_tree->mailboxname_sub = _("INBOX");
1256     } elseif ($translate_special_folders && $mbx_tree->mailboxname_full == $draft_folder) {
1257         $mbx_tree->mailboxname_sub = _("Drafts");
1258     } elseif ($translate_special_folders && $mbx_tree->mailboxname_full == $sent_folder) {
1259         $mbx_tree->mailboxname_sub = _("Sent");
1260     } elseif ($translate_special_folders && $mbx_tree->mailboxname_full == $trash_folder) {
1261         $mbx_tree->mailboxname_sub = _("Trash");
1262     } else {
1263         $mbx_tree->mailboxname_sub = imap_utf7_decode_local($mbx_tree->mailboxname_sub);
1264     }
1265
1266     if ($mbx_tree->mbxs) {
1267         $iCnt = count($mbx_tree->mbxs);
1268         for ($i=0;$i<$iCnt;++$i) {
1269             sqimap_utf7_decode_mbx_tree($mbx_tree->mbxs[$i]);
1270         }
1271     }
1272 }
1273
1274 /**
1275  * @param object $mbx_tree
1276  * @param array $aMbxs
1277  * @since 1.5.0
1278  */
1279 function sqimap_tree_to_ref_array(&$mbx_tree,&$aMbxs) {
1280    if ($mbx_tree)
1281    $aMbxs[] =& $mbx_tree;
1282    if ($mbx_tree->mbxs) {
1283       $iCnt = count($mbx_tree->mbxs);
1284       for ($i=0;$i<$iCnt;++$i) {
1285          sqimap_tree_to_ref_array($mbx_tree->mbxs[$i],$aMbxs);
1286       }
1287    }
1288 }
1289
1290 /**
1291  * @param stream $imap_stream imap connection resource
1292  * @param object $mbx_tree
1293  * @since since 1.5.0
1294  */
1295 function sqimap_get_status_mbx_tree($imap_stream,&$mbx_tree) {
1296     global $unseen_notify, $unseen_type, $trash_folder,$move_to_trash;
1297     $aMbxs = $aQuery = array();
1298     sqimap_tree_to_ref_array($mbx_tree,$aMbxs);
1299     // remove the root node
1300     array_shift($aMbxs);
1301
1302     if($unseen_notify == 3) {
1303         $cnt = count($aMbxs);
1304         for($i=0;$i<$cnt;++$i) {
1305             $oMbx =& $aMbxs[$i];
1306             if (!$oMbx->is_noselect) {
1307                 $mbx = $oMbx->mailboxname_full;
1308                 if ($unseen_type == 2 ||
1309                    ($move_to_trash && $oMbx->mailboxname_full == $trash_folder)) {
1310                    $query = 'STATUS ' . sqimap_encode_mailbox_name($mbx) . ' (MESSAGES UNSEEN RECENT)';
1311                 } else {
1312                    $query = 'STATUS ' . sqimap_encode_mailbox_name($mbx) . ' (UNSEEN RECENT)';
1313                 }
1314                 sqimap_prepare_pipelined_query($query,$tag,$aQuery,false);
1315             } else {
1316                 $oMbx->unseen = $oMbx->total = $oMbx->recent = false;
1317                 $tag = false;
1318             }
1319             $oMbx->tag = $tag;
1320             $aMbxs[$i] =& $oMbx;
1321         }
1322         // execute all the queries at once
1323         $aResponse = sqimap_run_pipelined_command ($imap_stream, $aQuery, false, $aServerResponse, $aServerMessage);
1324         $cnt = count($aMbxs);
1325         for($i=0;$i<$cnt;++$i) {
1326             $oMbx =& $aMbxs[$i];
1327             $tag = $oMbx->tag;
1328             if ($tag && $aServerResponse[$tag] == 'OK') {
1329                 $sResponse = implode('', $aResponse[$tag]);
1330                 if (preg_match('/UNSEEN\s+([0-9]+)/i', $sResponse, $regs)) {
1331                     $oMbx->unseen = $regs[1];
1332                 }
1333                 if (preg_match('/MESSAGES\s+([0-9]+)/i', $sResponse, $regs)) {
1334                     $oMbx->total = $regs[1];
1335                 }
1336                 if (preg_match('/RECENT\s+([0-9]+)/i', $sResponse, $regs)) {
1337                     $oMbx->recent = $regs[1];
1338                 }
1339
1340            }
1341            unset($oMbx->tag);
1342         }
1343     } else if ($unseen_notify == 2) { // INBOX only
1344         $cnt = count($aMbxs);
1345         for($i=0;$i<$cnt;++$i) {
1346             $oMbx =& $aMbxs[$i];
1347             if (strtoupper($oMbx->mailboxname_full) == 'INBOX' ||
1348                ($move_to_trash && $oMbx->mailboxname_full == $trash_folder)) {
1349                  if ($unseen_type == 2 ||
1350                    ($oMbx->mailboxname_full == $trash_folder && $move_to_trash)) {
1351                     $aStatus = sqimap_status_messages($imap_stream,$oMbx->mailboxname_full);
1352                     $oMbx->unseen = $aStatus['UNSEEN'];
1353                     $oMbx->total  = $aStatus['MESSAGES'];
1354                     $oMbx->recent = $aStatus['RECENT'];
1355                 } else {
1356                     $oMbx->unseen = sqimap_unseen_messages($imap_stream,$oMbx->mailboxname_full);
1357                 }
1358                 $aMbxs[$i] =& $oMbx;
1359                 if (!$move_to_trash && $trash_folder) {
1360                     break;
1361                 } else {
1362                    // trash comes after INBOX
1363                    if ($oMbx->mailboxname_full == $trash_folder) {
1364                       break;
1365                    }
1366                 }
1367             }
1368         }
1369     }
1370
1371     $cnt = count($aMbxs);
1372     for($i=0;$i<$cnt;++$i) {
1373          $oMbx =& $aMbxs[$i];
1374          unset($hook_status);
1375          if (!empty($oMbx->unseen)) { $hook_status['UNSEEN']=$oMbx->unseen; }
1376          if (!empty($oMbx->total)) { $hook_status['MESSAGES']=$oMbx->total; }
1377          if (!empty($oMbx->recent)) { $hook_status['RECENT']=$oMbx->recent; }
1378          if (!empty($hook_status))
1379          {
1380               $hook_status['MAILBOX']=$oMbx->mailboxname_full;
1381               $hook_status['CALLER']='sqimap_get_status_mbx_tree'; // helps w/ debugging
1382               do_hook('folder_status', $hook_status);
1383          }
1384     }
1385 }
1386
1387 /**
1388  * Checks if folder is noselect (can't store messages)
1389  *
1390  * Function does not check if folder subscribed.
1391  * @param stream $oImapStream imap connection resource
1392  * @param string $sImapFolder imap folder name
1393  * @param object $oBoxes mailboxes class object.
1394  * @return boolean true, when folder has noselect flag. false in any other case.
1395  * @since 1.5.1
1396  */
1397 function sqimap_mailbox_is_noselect($oImapStream,$sImapFolder,&$oBoxes) {
1398     // build mailbox object if it is not available
1399     if (! is_object($oBoxes)) $oBoxes=sqimap_mailbox_list($oImapStream);
1400     foreach($oBoxes as $box) {
1401         if ($box['unformatted']==$sImapFolder) {
1402             return (bool) check_is_noselect($box['raw']);
1403         }
1404     }
1405     return false;
1406 }
1407
1408 /**
1409  * Checks if folder is noinferiors (can't store other folders)
1410  *
1411  * Function does not check if folder subscribed.
1412  * @param stream $oImapStream imap connection resource
1413  * @param string $sImapFolder imap folder name
1414  * @param object $oBoxes mailboxes class object.
1415  * @return boolean true, when folder has noinferiors flag. false in any other case.
1416  * @since 1.5.1
1417  */
1418 function sqimap_mailbox_is_noinferiors($oImapStream,$sImapFolder,&$oBoxes) {
1419     // build mailbox object if it is not available
1420     if (! is_object($oBoxes)) $oBoxes=sqimap_mailbox_list($oImapStream);
1421     foreach($oBoxes as $box) {
1422         if ($box['unformatted']==$sImapFolder) {
1423             return (bool) check_is_noinferiors($box['raw']);
1424         }
1425     }
1426     return false;
1427 }