X-Git-Url: https://vcs.fsf.org/?p=squirrelmail.git;a=blobdiff_plain;f=functions%2Fimap_mailbox.php;h=df3692044b27eec2df832502402534d2c0bbe124;hp=54577b8e23d159aa219036478793a4b711ee8894;hb=d56050e17bf919a100069eee0a454083bb9b0a05;hpb=6e097fb53cbf92507816803f9a7c0fa3a7cbac53 diff --git a/functions/imap_mailbox.php b/functions/imap_mailbox.php index 54577b8e..df369204 100755 --- a/functions/imap_mailbox.php +++ b/functions/imap_mailbox.php @@ -3,37 +3,39 @@ /** * imap_mailbox.php * - * Copyright (c) 1999-2004 The SquirrelMail Project Team - * Licensed under the GNU GPL. For full terms see the file COPYING. + * This implements all functions that manipulate mailboxes * - * This impliments all functions that manipulate mailboxes - * - * $Id$ + * @copyright © 1999-2007 The SquirrelMail Project Team + * @license http://opensource.org/licenses/gpl-license.php GNU Public License + * @version $Id$ * @package squirrelmail + * @subpackage imap */ /** UTF7 support */ require_once(SM_PATH . 'functions/imap_utf7_local.php'); -global $boxesnew; /** * Mailboxes class - * - * FIXME. This class should be extracted and placed in a separate file that + * + * FIXME. This class should be extracted and placed in a separate file that * can be included before we start the session. That makes caching of the tree - * possible. On a refresh mailboxes from left_main.php the only function that - * should be called is the sqimap_get_status_mbx_tree. In case of subscribe - * / rename / delete / new we have to create methods for adding/changing the + * possible. On a refresh mailboxes from left_main.php the only function that + * should be called is the sqimap_get_status_mbx_tree. In case of subscribe + * / rename / delete / new we have to create methods for adding/changing the * mailbox in the mbx_tree without the need for a refresh. + * + * Some code fragments are present in 1.3.0 - 1.4.4. * @package squirrelmail -*/ - + * @subpackage imap + * @since 1.5.0 + */ class mailboxes { var $mailboxname_full = '', $mailboxname_sub= '', $is_noselect = false, $is_noinferiors = false, $is_special = false, $is_root = false, $is_inbox = false, $is_sent = false, - $is_trash = false, $is_draft = false, $mbxs = array(), - $unseen = false, $total = false; + $is_trash = false, $is_draft = false, $mbxs = array(), + $unseen = false, $total = false, $recent = false; function addMbx($mbx, $delimiter, $start, $specialfirst) { $ary = explode($delimiter, $mbx->mailboxname_full); @@ -70,6 +72,13 @@ class mailboxes { } } +/** + * array callback used for sorting in mailboxes class + * @param object $a + * @param object $b + * @return integer see php strnatcasecmp() + * @since 1.3.0 + */ function sortSpecialMbx($a, $b) { if ($a->is_inbox) { $acmp = '0'. $a->mailboxname_full; @@ -85,14 +94,18 @@ function sortSpecialMbx($a, $b) { } else { $bcmp = '2' . $b->mailboxname_full; } - return strnatcasecmp($acmp, $bcmp); + return strnatcasecmp($acmp, $bcmp); } -function compact_mailboxes_response($ary) -{ +/** + * @param array $ary + * @return array + * @since 1.5.0 + */ +function compact_mailboxes_response($ary) { /* * Workaround for mailboxes returned as literal - * FIXME : Doesn't work if the mailbox name is multiple lines + * FIXME : Doesn't work if the mailbox name is multiple lines * (larger then fgets buffer) */ for ($i = 0, $iCnt=count($ary); $i < $iCnt; $i++) { @@ -112,9 +125,13 @@ function compact_mailboxes_response($ary) * Extract the mailbox name from an untagged LIST (7.2.2) or LSUB (7.2.3) answer * (LIST|LSUB) () (NIL|"") \r\n * mailbox name in quoted string MUST be unquoted and stripslashed (sm API) + * + * Originally stored in functions/strings.php. Since 1.2.6 stored in + * functions/imap_mailbox.php + * @param string $line imap LIST/LSUB response line + * @return string mailbox name */ -function find_mailbox_name($line) -{ +function find_mailbox_name($line) { if (preg_match('/^\* (?:LIST|LSUB) \([^\)]*\) (?:NIL|\"[^\"]*\") ([^\r\n]*)[\r\n]*$/i', $line, $regs)) { if (substr($regs[1], 0, 1) == '"') return stripslashes(substr($regs[1], 1, -1)); @@ -124,23 +141,39 @@ function find_mailbox_name($line) } /** + * Detects if mailbox has noselect flag (can't store messages) + * In versions older than 1.4.5 function checks only LSUB responses + * and can produce pcre warnings. + * @param string $lsub_line mailbox line from untagged LIST or LSUB response * @return bool whether this is a Noselect mailbox. + * @since 1.3.2 */ function check_is_noselect ($lsub_line) { return preg_match("/^\* (LSUB|LIST) \([^\)]*\\\\Noselect[^\)]*\)/i", $lsub_line); } /** + * Detects if mailbox has noinferiors flag (can't store subfolders) + * @param string $lsub_line mailbox line from untagged LIST or LSUB response * @return bool whether this is a Noinferiors mailbox. + * @since 1.5.0 */ function check_is_noinferiors ($lsub_line) { return preg_match("/^\* (LSUB|LIST) \([^\)]*\\\\Noinferiors[^\)]*\)/i", $lsub_line); } /** + * Detects mailbox's parent folder + * * If $haystack is a full mailbox name, and $needle is the mailbox * separator character, returns the second last part of the full * mailbox name (i.e. the mailbox's parent mailbox) + * + * Originally stored in functions/strings.php. Since 1.2.6 stored in + * functions/imap_mailbox.php + * @param string $haystack full mailbox name + * @param string $needle delimiter + * @return string parent mailbox */ function readMailboxParent($haystack, $needle) { if ($needle == '') { @@ -156,81 +189,122 @@ function readMailboxParent($haystack, $needle) { return( $ret ); } -/** +/** * Check if $subbox is below the specified $parentbox + * @param string $subbox potential sub folder + * @param string $parentbox potential parent + * @return boolean + * @since 1.2.3 */ function isBoxBelow( $subbox, $parentbox ) { global $delimiter; - /* - * Eliminate the obvious mismatch, where the + /* + * Eliminate the obvious mismatch, where the * subfolder path is shorter than that of the potential parent */ if ( strlen($subbox) < strlen($parentbox) ) { return false; } /* check for delimiter */ - if (!substr($parentbox,-1) == $delimiter) { - $parentbox.=$delimiter; - } - if (substr($subbox,0,strlen($parentbox)) == $parentbox) { - return true; - } else { - return false; - } + if (substr($parentbox,-1) != $delimiter) { + $parentbox .= $delimiter; + } + + return (substr($subbox,0,strlen($parentbox)) == $parentbox); } /** * Defines special mailboxes: given a mailbox name, it checks if this is a * "special" one: INBOX, Trash, Sent or Draft. + * + * Since 1.2.5 function includes special_mailbox hook.
+ * Since 1.4.3 hook supports more than one plugin. + * @param string $box mailbox name + * @param boolean $include_subs (since 1.5.2) if true, subfolders of system + * folders are special. if false, subfolders are not special mailboxes + * unless they are tagged as special in 'special_mailbox' hook. + * @return boolean + * @since 1.2.3 */ -function isSpecialMailbox( $box ) { +function isSpecialMailbox($box,$include_subs=true) { $ret = ( (strtolower($box) == 'inbox') || - isTrashMailbox($box) || isSentMailbox($box) || isDraftMailbox($box) ); + isTrashMailbox($box,$include_subs) || + isSentMailbox($box,$include_subs) || + isDraftMailbox($box,$include_subs) ); if ( !$ret ) { - $ret = boolean_hook_function('special_mailbox',$box,1); + $ret = boolean_hook_function('special_mailbox', $box, 1); } return $ret; } /** + * Detects if mailbox is a Trash folder or subfolder of Trash + * @param string $box mailbox name + * @param boolean $include_subs (since 1.5.2) if true, subfolders of system + * folders are special. if false, subfolders are not special mailboxes. * @return bool whether this is a Trash folder + * @since 1.4.0 */ -function isTrashMailbox ($box) { +function isTrashMailbox ($box,$include_subs=true) { global $trash_folder, $move_to_trash; return $move_to_trash && $trash_folder && - ( $box == $trash_folder || isBoxBelow($box, $trash_folder) ); + ( $box == $trash_folder || + ($include_subs && isBoxBelow($box, $trash_folder)) ); } /** + * Detects if mailbox is a Sent folder or subfolder of Sent + * @param string $box mailbox name + * @param boolean $include_subs (since 1.5.2) if true, subfolders of system + * folders are special. if false, subfolders are not special mailboxes. * @return bool whether this is a Sent folder + * @since 1.4.0 */ -function isSentMailbox($box) { +function isSentMailbox($box,$include_subs=true) { global $sent_folder, $move_to_sent; return $move_to_sent && $sent_folder && - ( $box == $sent_folder || isBoxBelow($box, $sent_folder) ); + ( $box == $sent_folder || + ($include_subs && isBoxBelow($box, $sent_folder)) ); } /** + * Detects if mailbox is a Drafts folder or subfolder of Drafts + * @param string $box mailbox name + * @param boolean $include_subs (since 1.5.2) if true, subfolders of system + * folders are special. if false, subfolders are not special mailboxes. * @return bool whether this is a Draft folder + * @since 1.4.0 */ -function isDraftMailbox($box) { +function isDraftMailbox($box,$include_subs=true) { global $draft_folder, $save_as_draft; return $save_as_draft && - ( $box == $draft_folder || isBoxBelow($box, $draft_folder) ); + ( $box == $draft_folder || + ($include_subs && isBoxBelow($box, $draft_folder)) ); } /** - * Expunges a mailbox, ie. delete all contents. + * Expunges a mailbox + * + * WARNING: Select mailbox before calling this function. + * + * permanently removes all messages that have the \Deleted flag + * set from the selected mailbox. See EXPUNGE command chapter in + * IMAP RFC. + * @param stream $imap_stream imap connection resource + * @param string $mailbox mailbox name (unused since 1.1.3). + * @param boolean $handle_errors error handling control (displays error_box on error). + * @param mixed $id (since 1.3.0) integer message id or array with integer ids + * @return integer number of expunged messages + * @since 1.0 or older */ function sqimap_mailbox_expunge ($imap_stream, $mailbox, $handle_errors = true, $id='') { - global $uid_support; if ($id) { if (is_array($id)) { $id = sqimap_message_list_squisher($id); } $id = ' '.$id; - $uid = $uid_support; + $uid = TRUE; } else { $uid = false; } @@ -249,79 +323,67 @@ function sqimap_mailbox_expunge ($imap_stream, $mailbox, $handle_errors = true, } /** - * Expunge specified message, updated $msgs and $msort - * - * Until Marc and I come up with a better way to maintain - * these stupid arrays, we'll use this wrapper function to - * remove the message with the matching UID .. the order - * won't be changed - the array element for the message - * will just be removed. + * Checks whether or not the specified mailbox exists + * + * @param stream $imap_stream imap connection resource + * @param string $mailbox mailbox name + * @param array $mailboxlist (since 1.5.1) optional array of mailboxes from + * sqimap_get_mailboxes() (to avoid having to talk to imap server) + * @return boolean + * @since 1.0 or older */ -function sqimap_mailbox_expunge_dmn($message_id) -{ - global $msgs, $msort, $sort, $imapConnection, - $mailbox, $uid_support, $mbx_response, $auto_expunge, - $sort, $allow_server_sort, $thread_sort_messages, $allow_thread_sort, - $username, $data_dir; - - // Got to grab this out of prefs, since it isn't saved from mailbox_view.php - if ($allow_thread_sort) { - $thread_sort_messages = getPref($data_dir, $username, "thread_$mailbox",0); +function sqimap_mailbox_exists ($imap_stream, $mailbox, $mailboxlist=null) { + if (!isset($mailbox) || empty($mailbox)) { + return false; } - for ($i = 0; $i < count($msort); $i++) { - if ($msgs[$i]['ID'] == $message_id) { - break; + if (is_array($mailboxlist)) { + // use previously retrieved mailbox list + foreach ($mailboxlist as $mbox) { + if ($mbox['unformatted-dm'] == $mailbox) { return true; } } - } - - unset($msgs[$i]); - unset($msort[$i]); - - $msgs = array_values($msgs); - $msort = array_values($msort); - - sqsession_register($msgs, 'msgs'); - sqsession_register($msort, 'msort'); - - if ($auto_expunge) { - sqimap_mailbox_expunge($imapConnection, $mailbox, true); - } - - // And after all that mucking around, update the sort list! - // Remind me why the hell we need those two arrays again?! - if ( $allow_thread_sort && $thread_sort_messages ) { - $server_sort_array = get_thread_sort($imapConnection); - } elseif ( $allow_server_sort ) { - $server_sort_array = sqimap_get_sort_order($imapConnection, $sort, $mbx_response); - } elseif ( $uid_support ) { - $server_sort_array = sqimap_get_php_sort_order($imapConnection, $mbx_response); - } - -} - -/** - * Checks whether or not the specified mailbox exists - */ -function sqimap_mailbox_exists ($imap_stream, $mailbox) { - if (!isset($mailbox) || empty($mailbox)) { return false; + } else { + // go to imap server + $mbx = sqimap_run_command($imap_stream, 'LIST "" ' . sqimap_encode_mailbox_name($mailbox), + true, $response, $message); + return isset($mbx[0]); } - $mbx = sqimap_run_command($imap_stream, 'LIST "" ' . sqimap_encode_mailbox_name($mailbox), - true, $response, $message); - return isset($mbx[0]); } /** * Selects a mailbox + * Before 1.3.0 used more arguments and returned data depended on those arguments. + * @param stream $imap_stream imap connection resource + * @param string $mailbox mailbox name + * @return array results of select command (on success - permanentflags, flags and rights) + * @since 1.0 or older */ function sqimap_mailbox_select ($imap_stream, $mailbox) { - global $auto_expunge; - - if ($mailbox == 'None') { + if (empty($mailbox)) { return; } + // cleanup $mailbox in order to prevent IMAP injection attacks + $mailbox = str_replace(array("\r","\n"), array("",""),$mailbox); + + /** + * Default UW IMAP server configuration allows to access other files + * on server. $imap_server_type is not checked because interface can + * be used with 'other' or any other server type setting. $mailbox + * variable can be modified in any script that uses variable from GET + * or POST. This code blocks all standard SquirrelMail IMAP API requests + * that use mailbox with full path (/etc/passwd) or with ../ characters + * in path (../../etc/passwd) + */ + if (strstr($mailbox, '../') || substr($mailbox, 0, 1) == '/') { + global $oTemplate; + error_box(sprintf(_("Invalid mailbox name: %s"),htmlspecialchars($mailbox))); + sqimap_logout($imap_stream); + $oTemplate->display('footer.tpl'); + die(); + } + $read = sqimap_run_command($imap_stream, 'SELECT ' . sqimap_encode_mailbox_name($mailbox), true, $response, $message); $result = array(); @@ -333,49 +395,69 @@ function sqimap_mailbox_select ($imap_stream, $mailbox) { } else { if (preg_match("/PERMANENTFLAGS(.*)/i",$read[$i], $regs)) { $regs[1]=trim(preg_replace ( array ("/\(/","/\)/","/\]/") ,'', $regs[1])) ; - $result['PERMANENTFLAGS'] = $regs[1]; + $result['PERMANENTFLAGS'] = explode(' ',strtolower($regs[1])); } else if (preg_match("/FLAGS(.*)/i",$read[$i], $regs)) { $regs[1]=trim(preg_replace ( array ("/\(/","/\)/") ,'', $regs[1])) ; - $result['FLAGS'] = $regs[1]; + $result['FLAGS'] = explode(' ',strtolower($regs[1])); } } } + if (!isset($result['PERMANENTFLAGS'])) { + $result['PERMANENTFLAGS'] = $result['FLAGS']; + } if (preg_match('/^\[(.+)\]/',$message, $regs)) { - $result['RIGHTS']=$regs[1]; + $result['RIGHTS']=strtoupper($regs[1]); } - if ($auto_expunge) { - $tmp = sqimap_run_command($imap_stream, 'EXPUNGE', false, $a, $b); - } return $result; } /** * Creates a folder. + * + * Mailbox is automatically subscribed. + * + * Set $type to string that does not match 'noselect' (case insensitive), + * if you don't want to prepend delimiter to mailbox name. Please note + * that 'noinferiors' might be used someday as keyword for folders + * that store only messages. + * @param stream $imap_steam imap connection resource + * @param string $mailbox mailbox name + * @param string $type folder type. + * @since 1.0 or older */ function sqimap_mailbox_create ($imap_stream, $mailbox, $type) { global $delimiter; if (strtolower($type) == 'noselect') { - $mailbox .= $delimiter; + $create_mailbox = $mailbox . $delimiter; + } else { + $create_mailbox = $mailbox; } $read_ary = sqimap_run_command($imap_stream, 'CREATE ' . - sqimap_encode_mailbox_name($mailbox), + sqimap_encode_mailbox_name($create_mailbox), true, $response, $message); sqimap_subscribe ($imap_stream, $mailbox); } /** * Subscribes to an existing folder. + * @param stream $imap_stream imap connection resource + * @param string $mailbox mailbox name + * @param boolean $debug (since 1.5.1) + * @since 1.0 or older */ -function sqimap_subscribe ($imap_stream, $mailbox) { +function sqimap_subscribe ($imap_stream, $mailbox,$debug=true) { $read_ary = sqimap_run_command($imap_stream, 'SUBSCRIBE ' . sqimap_encode_mailbox_name($mailbox), - true, $response, $message); + $debug, $response, $message); } /** * Unsubscribes from an existing folder + * @param stream $imap_stream imap connection resource + * @param string $mailbox mailbox name + * @since 1.0 or older */ function sqimap_unsubscribe ($imap_stream, $mailbox) { $read_ary = sqimap_run_command($imap_stream, 'UNSUBSCRIBE ' . @@ -385,24 +467,37 @@ function sqimap_unsubscribe ($imap_stream, $mailbox) { /** * Deletes the given folder + * Since 1.2.6 and 1.3.0 contains rename_or_delete_folder hook + * @param stream $imap_stream imap connection resource + * @param string $mailbox mailbox name + * @since 1.0 or older */ function sqimap_mailbox_delete ($imap_stream, $mailbox) { global $data_dir, $username; sqimap_unsubscribe ($imap_stream, $mailbox); - $read_ary = sqimap_run_command($imap_stream, 'DELETE ' . - sqimap_encode_mailbox_name($mailbox), - true, $response, $message); - if ($response !== 'OK') { - // subscribe again - sqimap_subscribe ($imap_stream, $mailbox); - } else { - do_hook_function('rename_or_delete_folder', $args = array($mailbox, 'delete', '')); - removePref($data_dir, $username, "thread_$mailbox"); + + if (sqimap_mailbox_exists($imap_stream, $mailbox)) { + + $read_ary = sqimap_run_command($imap_stream, 'DELETE ' . + sqimap_encode_mailbox_name($mailbox), + true, $response, $message); + if ($response !== 'OK') { + // subscribe again + sqimap_subscribe ($imap_stream, $mailbox); + } else { + do_hook('rename_or_delete_folder', $temp=array(&$mailbox, 'delete', '')); + removePref($data_dir, $username, "thread_$mailbox"); + removePref($data_dir, $username, "collapse_folder_$mailbox"); + } } } /** * Determines if the user is subscribed to the folder or not + * @param stream $imap_stream imap connection resource + * @param string $mailbox mailbox name + * @return boolean + * @since 1.2.0 */ function sqimap_mailbox_is_subscribed($imap_stream, $folder) { $boxesall = sqimap_mailbox_list ($imap_stream); @@ -416,6 +511,11 @@ function sqimap_mailbox_is_subscribed($imap_stream, $folder) { /** * Renames a mailbox. + * Since 1.2.6 and 1.3.0 contains rename_or_delete_folder hook + * @param stream $imap_stream imap connection resource + * @param string $old_name mailbox name + * @param string $new_name new mailbox name + * @since 1.2.3 */ function sqimap_mailbox_rename( $imap_stream, $old_name, $new_name ) { if ( $old_name != $new_name ) { @@ -428,34 +528,45 @@ function sqimap_mailbox_rename( $imap_stream, $old_name, $new_name ) { $postfix = ''; } - $boxesall = sqimap_mailbox_list($imap_stream); + $boxesall = sqimap_mailbox_list_all($imap_stream); $cmd = 'RENAME ' . sqimap_encode_mailbox_name($old_name) . - ' ' . sqimap_encode_mailbox_name($new_name); + ' ' . sqimap_encode_mailbox_name($new_name); $data = sqimap_run_command($imap_stream, $cmd, true, $response, $message); sqimap_unsubscribe($imap_stream, $old_name.$postfix); - $oldpref = getPref($data_dir, $username, 'thread_'.$old_name.$postfix); + $oldpref_thread = getPref($data_dir, $username, 'thread_'.$old_name.$postfix); + $oldpref_collapse = getPref($data_dir, $username, 'collapse_folder_'.$old_name.$postfix); removePref($data_dir, $username, 'thread_'.$old_name.$postfix); + removePref($data_dir, $username, 'collapse_folder_'.$old_name.$postfix); sqimap_subscribe($imap_stream, $new_name.$postfix); - setPref($data_dir, $username, 'thread_'.$new_name.$postfix, $oldpref); - do_hook_function('rename_or_delete_folder',$args = array($old_name, 'rename', $new_name)); + setPref($data_dir, $username, 'thread_'.$new_name.$postfix, $oldpref_thread); + setPref($data_dir, $username, 'collapse_folder_'.$new_name.$postfix, $oldpref_collapse); + do_hook('rename_or_delete_folder', $temp=array(&$old_name, 'rename', &$new_name)); $l = strlen( $old_name ) + 1; $p = 'unformatted'; foreach ($boxesall as $box) { if (substr($box[$p], 0, $l) == $old_name . $delimiter) { $new_sub = $new_name . $delimiter . substr($box[$p], $l); + /* With Cyrus IMAPd >= 2.0 rename is recursive, so don't check for errors here */ if ($imap_server_type == 'cyrus') { $cmd = 'RENAME "' . $box[$p] . '" "' . $new_sub . '"'; - $data = sqimap_run_command($imap_stream, $cmd, true, + $data = sqimap_run_command($imap_stream, $cmd, false, $response, $message); } - sqimap_unsubscribe($imap_stream, $box[$p]); - $oldpref = getPref($data_dir, $username, 'thread_'.$box[$p]); + $was_subscribed = sqimap_mailbox_is_subscribed($imap_stream, $box[$p]); + if ( $was_subscribed ) { + sqimap_unsubscribe($imap_stream, $box[$p]); + } + $oldpref_thread = getPref($data_dir, $username, 'thread_'.$box[$p]); + $oldpref_collapse = getPref($data_dir, $username, 'collapse_folder_'.$box[$p]); removePref($data_dir, $username, 'thread_'.$box[$p]); - sqimap_subscribe($imap_stream, $new_sub); - setPref($data_dir, $username, 'thread_'.$new_sub, $oldpref); - do_hook_function('rename_or_delete_folder', - $args = array($box[$p], 'rename', $new_sub)); + removePref($data_dir, $username, 'collapse_folder_'.$box[$p]); + if ( $was_subscribed ) { + sqimap_subscribe($imap_stream, $new_sub); + } + setPref($data_dir, $username, 'thread_'.$new_sub, $oldpref_thread); + setPref($data_dir, $username, 'collapse_folder_'.$new_sub, $oldpref_collapse); + do_hook('rename_or_delete_folder', $temp=array(&$box[$p], 'rename', &$new_sub)); } } } @@ -465,14 +576,26 @@ function sqimap_mailbox_rename( $imap_stream, $old_name, $new_name ) { * Formats a mailbox into parts for the $boxesall array * * The parts are: + *
    + *
  • raw - Raw LIST/LSUB response from the IMAP server + *
  • formatted - nicely formatted folder name + *
  • unformatted - unformatted, but with delimiter at end removed + *
  • unformatted-dm - folder name as it appears in raw response + *
  • unformatted-disp - unformatted without $folder_prefix + *
  • id - TODO: document me + *
  • flags - TODO: document me + *
+ * Before 1.2.0 used third argument for delimiter. * - * raw - Raw LIST/LSUB response from the IMAP server - * formatted - nicely formatted folder name - * unformatted - unformatted, but with delimiter at end removed - * unformatted-dm - folder name as it appears in raw response - * unformatted-disp - unformatted without $folder_prefix + * Before 1.5.1 used second argument for lsub line. Argument was removed in order to use + * find_mailbox_name() on the raw input. Since 1.5.1 includes RFC3501 names in flags + * array (for example, "\NoSelect" in addition to "noselect") + * @param array $line + * @return array + * @since 1.0 or older + * @todo document id and flags keys in boxes array and function arguments. */ -function sqimap_mailbox_parse ($line, $line_lsub) { +function sqimap_mailbox_parse ($line) { global $folder_prefix, $delimiter; /* Process each folder line */ @@ -485,7 +608,7 @@ function sqimap_mailbox_parse ($line, $line_lsub) { } /* Count number of delimiters ($delimiter) in folder name */ - $mailbox = /*trim(*/$line_lsub[$g]/*)*/; + $mailbox = find_mailbox_name($line[$g]); $dm_count = substr_count($mailbox, $delimiter); if (substr($mailbox, -1) == $delimiter) { /* If name ends in delimiter, decrement count by one */ @@ -524,12 +647,20 @@ function sqimap_mailbox_parse ($line, $line_lsub) { $boxesall[$g]['flags'] = array(); if (isset($line[$g])) { ereg("\(([^)]*)\)",$line[$g],$regs); - // FIXME Flags do contain the \ character. \NoSelect \NoInferiors - // and $MDNSent <= last one doesn't have the \ - // It's better to follow RFC3501 instead of using our own naming. - $flags = trim(strtolower(str_replace('\\', '',$regs[1]))); + /** + * Since 1.5.1 flags are stored with RFC3501 naming + * and also the old way for backwards compatibility + * so for example "\NoSelect" and "noselect" + */ + $flags = trim($regs[1]); if ($flags) { - $boxesall[$g]['flags'] = explode(' ', $flags); + $flagsarr = explode(' ',$flags); + $flagsarrnew=$flagsarr; + // add old type + foreach ($flagsarr as $flag) { + $flagsarrnew[]=strtolower(str_replace('\\', '',$flag)); + } + $boxesall[$g]['flags']=$flagsarrnew; } } } @@ -537,349 +668,516 @@ function sqimap_mailbox_parse ($line, $line_lsub) { } /** - * Returns list of options (to be echoed into select statement - * based on available mailboxes and separators - * Caller should surround options with and - * any formatting. - * $imap_stream - $imapConnection to query for mailboxes - * $show_selected - array containing list of mailboxes to pre-select (0 if none) - * $folder_skip - array of folders to keep out of option list (compared in lower) - * $boxes - list of already fetched boxes (for places like folder panel, where - * you know these options will be shown 3 times in a row.. (most often unset). - * $flag - flag to check for in mailbox flags, used to filter out mailboxes. - * 'noselect' by default to remove unselectable mailboxes. - * 'noinferiors' used to filter out folders that can not contain subfolders. - * NULL to avoid flag check entirely. - * NOTE: noselect and noiferiors are used internally. The IMAP representation is - * \NoSelect and \NoInferiors - * $use_long_format - override folder display preference and always show full folder name. + * Returns an array of mailboxes available. Separated from sqimap_mailbox_option_list() + * below for template development. + * + * @author Steve Brown + * @since 1.5.2 */ -function sqimap_mailbox_option_list($imap_stream, $show_selected = 0, $folder_skip = 0, $boxes = 0, +function sqimap_mailbox_option_array($imap_stream, $folder_skip = 0, $boxes = 0, $flag = 'noselect', $use_long_format = false ) { - global $username, $data_dir; + global $username, $data_dir, $translate_special_folders, $sent_folder, + $trash_folder, $draft_folder; + + $delimiter = sqimap_get_delimiter($imap_stream); + $mbox_options = ''; if ( $use_long_format ) { $shorten_box_names = 0; } else { - $shorten_box_names = getPref($data_dir, $username, 'mailbox_select_style', SMPREF_OFF); + $shorten_box_names = getPref($data_dir, $username, 'mailbox_select_style', SMPREF_MAILBOX_SELECT_INDENTED); } if ($boxes == 0) { $boxes = sqimap_mailbox_list($imap_stream); } + $a = array(); foreach ($boxes as $boxes_part) { - if ($flag == NULL || !in_array($flag, $boxes_part['flags'])) { + if ($flag == NULL || (is_array($boxes_part['flags']) + && !in_array($flag, $boxes_part['flags']))) { $box = $boxes_part['unformatted']; if ($folder_skip != 0 && in_array($box, $folder_skip) ) { continue; } - $lowerbox = strtolower($box); + $lowerbox = strtolower($box); // mailboxes are casesensitive => inbox.sent != inbox.Sent // nevermind, to many dependencies this should be fixed! - + if (strtolower($box) == 'inbox') { // inbox is special and not casesensitive $box2 = _("INBOX"); - } else { + } else { switch ($shorten_box_names) { - case 2: /* delimited, style = 2 */ - $box2 = str_replace('  ', '. ', $boxes_part['formatted']); + case SMPREF_MAILBOX_SELECT_DELIMITED: + if ($translate_special_folders && $boxes_part['unformatted-dm']==$sent_folder) { + /* + * calculate pad level from number of delimiters. do it inside if control in order + * to reduce number of calculations. Other folders don't need it. + */ + $pad = str_pad('',7 * (count(explode($delimiter,$boxes_part['unformatted-dm']))-1),'. '); + // i18n: Name of Sent folder + $box2 = $pad . _("Sent"); + } elseif ($translate_special_folders && $boxes_part['unformatted-dm']==$trash_folder) { + $pad = str_pad('',7 * (count(explode($delimiter,$boxes_part['unformatted-dm']))-1),'. '); + // i18n: Name of Trash folder + $box2 = $pad . _("Trash"); + } elseif ($translate_special_folders && $boxes_part['unformatted-dm']==$draft_folder) { + $pad = str_pad('',7 * (count(explode($delimiter,$boxes_part['unformatted-dm']))-1),'. '); + // i18n: Name of Drafts folder + $box2 = $pad . _("Drafts"); + } else { + $box2 = str_replace('&nbsp;&nbsp;', '. ', htmlspecialchars($boxes_part['formatted'])); + } break; - case 1: /* indent, style = 1 */ - $box2 = $boxes_part['formatted']; + case SMPREF_MAILBOX_SELECT_INDENTED: + if ($translate_special_folders && $boxes_part['unformatted-dm']==$sent_folder) { + $pad = str_pad('',12 * (count(explode($delimiter,$boxes_part['unformatted-dm']))-1),'  '); + $box2 = $pad . _("Sent"); + } elseif ($translate_special_folders && $boxes_part['unformatted-dm']==$trash_folder) { + $pad = str_pad('',12 * (count(explode($delimiter,$boxes_part['unformatted-dm']))-1),'  '); + $box2 = $pad . _("Trash"); + } elseif ($translate_special_folders && $boxes_part['unformatted-dm']==$draft_folder) { + $pad = str_pad('',12 * (count(explode($delimiter,$boxes_part['unformatted-dm']))-1),'  '); + $box2 = $pad . _("Drafts"); + } else { + $box2 = str_replace('&nbsp;&nbsp;', '  ', htmlspecialchars($boxes_part['formatted'])); + } break; default: /* default, long names, style = 0 */ $box2 = str_replace(' ', ' ', htmlspecialchars(imap_utf7_decode_local($boxes_part['unformatted-disp']))); break; } } - if ($show_selected != 0 && in_array($lowerbox, $show_selected) ) { - $mbox_options .= '' . "\n"; - } else { - $mbox_options .= '' . "\n"; + + $a[htmlspecialchars($box)] = $box2; + } + } + + return $a; +} + +/** + * Returns list of options (to be echoed into select statement + * based on available mailboxes and separators + * Caller should surround options with and + * any formatting. + * @param stream $imap_stream imap connection resource to query for mailboxes + * @param array $show_selected array containing list of mailboxes to pre-select (0 if none) + * @param array $folder_skip array of folders to keep out of option list (compared in lower) + * @param $boxes list of already fetched boxes (for places like folder panel, where + * you know these options will be shown 3 times in a row.. (most often unset). + * @param string $flag (since 1.4.1) flag to check for in mailbox flags, used to filter out mailboxes. + * 'noselect' by default to remove unselectable mailboxes. + * 'noinferiors' used to filter out folders that can not contain subfolders. + * NULL to avoid flag check entirely. + * NOTE: noselect and noiferiors are used internally. The IMAP representation is + * \NoSelect and \NoInferiors + * @param boolean $use_long_format (since 1.4.1) override folder display preference and always show full folder name. + * @return string html formated mailbox selection options + * @since 1.3.2 + */ +function sqimap_mailbox_option_list($imap_stream, $show_selected = 0, $folder_skip = 0, $boxes = 0, + $flag = 'noselect', $use_long_format = false ) { + global $username, $data_dir, $translate_special_folders, $sent_folder, + $trash_folder, $draft_folder; + + $boxes = sqimap_mailbox_option_array($imap_stream, $folder_skip, $boxes, $flag, $use_long_format); + + $str = ''; + foreach ($boxes as $value=>$option) { + $lowerbox = strtolower(htmlspecialchars($value)); + $sel = false; + if ($show_selected != 0) { + reset($show_selected); + while (!$sel && (list($x, $val) = each($show_selected))) { + if (strtolower($value) == strtolower(htmlspecialchars($val))) { + $sel = true; + } } } + + $str .= '\n"; } - return $mbox_options; + + return $str; } /** - * Returns sorted mailbox lists in several different ways. + * Returns sorted mailbox lists in several different ways. + * + * Since 1.5.1 most of the functionality has been moved to new function sqimap_get_mailboxes + * * See comment on sqimap_mailbox_parse() for info about the returned array. + * @param resource $imap_stream imap connection resource + * @param boolean $force force update of mailbox listing. available since 1.4.2 and 1.5.0 + * @return array list of mailboxes + * @since 1.0 or older */ -function sqimap_mailbox_list($imap_stream) { - global $default_folder_prefix; +function sqimap_mailbox_list($imap_stream, $force=false) { + global $boxesnew,$show_only_subscribed_folders; + if (!sqgetGlobalVar('boxesnew',$boxesnew,SQ_SESSION) || $force) { + $boxesnew=sqimap_get_mailboxes($imap_stream,$force,$show_only_subscribed_folders); + } + return $boxesnew; +} - if (!isset($boxesnew)) { - global $data_dir, $username, $list_special_folders_first, - $folder_prefix, $trash_folder, $sent_folder, $draft_folder, - $move_to_trash, $move_to_sent, $save_as_draft, - $delimiter, $noselect_fix_enable; +/** + * Returns a list of all folders, subscribed or not + * + * Since 1.5.1 code moved to sqimap_get_mailboxes() + * + * @param stream $imap_stream imap connection resource + * @return array see sqimap_mailbox_parse() + * @since 1.0 or older + */ +function sqimap_mailbox_list_all($imap_stream) { + global $show_only_subscribed_folders; + // fourth argument prevents registration of retrieved list of mailboxes in session + $boxes=sqimap_get_mailboxes($imap_stream,true,false,false); + return $boxes; +} - $inbox_in_list = false; - $inbox_subscribed = false; - require_once(SM_PATH . 'include/load_prefs.php'); +/** + * Gets the list of mailboxes for sqimap_maolbox_tree and sqimap_mailbox_list + * + * This is because both of those functions had duplicated logic, but with slightly different + * implementations. This will make both use the same implementation, which should make it + * easier to maintain and easier to modify in the future + * @param stream $imap_stream imap connection resource + * @param bool $force force a reload and ignore cache + * @param bool $show_only_subscribed controls listing of visible or all folders + * @param bool $session_register controls registration of retrieved data in session. + * @return object boxesnew - array of mailboxes and their attributes + * @since 1.5.1 + */ +function sqimap_get_mailboxes($imap_stream,$force=false,$show_only_subscribed=true,$session_register=true) { + global $show_only_subscribed_folders,$noselect_fix_enable,$folder_prefix, + $list_special_folders_first,$imap_server_type; + $inbox_subscribed = false; + $listsubscribed = sqimap_capability($imap_stream,'LIST-SUBSCRIBED'); + + if ($show_only_subscribed) { $show_only_subscribed=$show_only_subscribed_folders; } + + //require_once(SM_PATH . 'include/load_prefs.php'); + + /** + * There are three main listing commands we can use in IMAP: + * LSUB shows just the list of subscribed folders + * may include flags, but these are not necessarily accurate or authoratative + * \NoSelect has special meaning: the folder does not exist -OR- it means this + * folder is not subscribed but children may be + * [RFC-2060] + * LIST this shows every mailbox on the system + * flags are always included and are accurate and authoratative + * \NoSelect means folder should not be selected + * [RFC-2060] + * LIST (SUBSCRIBED) implemented with LIST-SUBSCRIBED extension + * this is like list but returns only subscribed folders + * flag meanings are like LIST, not LSUB + * \NonExistent means mailbox doesn't exist + * \PlaceHolder means parent is not valid (selectable), but one or more children are + * \NoSelect indeed means that the folder should not be selected + * IMAPEXT-LIST-EXTENSIONS-04 August 2003 B. Leiba + */ + if (!$show_only_subscribed) { + $lsub = 'LIST'; + $sub_cache_name='list_cache'; + } elseif ($listsubscribed) { + $lsub = 'LIST (SUBSCRIBED)'; + $sub_cache_name='listsub_cache'; + } else { + $lsub = 'LSUB'; + $sub_cache_name='lsub_cache'; + } - if ($noselect_fix_enable) { - $lsub_args = "LSUB \"$folder_prefix\" \"*%\""; - } else { - $lsub_args = "LSUB \"$folder_prefix\" \"*\""; - } - /* LSUB array */ - $lsub_ary = sqimap_run_command ($imap_stream, $lsub_args, - true, $response, $message); - $lsub_ary = compact_mailboxes_response($lsub_ary); + // Some IMAP servers allow subfolders to exist even if the parent folders do not + // This fixes some problems with the folder list when this is the case, causing the + // NoSelect folders to be displayed + if ($noselect_fix_enable) { + $lsub_args = "$lsub \"$folder_prefix\" \"*%\""; + $list_args = "LIST \"$folder_prefix\" \"*%\""; + } else { + $lsub_args = "$lsub \"$folder_prefix\" \"*\""; + $list_args = "LIST \"$folder_prefix\" \"*\""; + } - $sorted_lsub_ary = array(); - for ($i = 0, $cnt = count($lsub_ary);$i < $cnt; $i++) { - $temp_mailbox_name = find_mailbox_name($lsub_ary[$i]); - $sorted_lsub_ary[] = $temp_mailbox_name; - if (!$inbox_subscribed && strtoupper($temp_mailbox_name) == 'INBOX') { - $inbox_subscribed = true; + // get subscribed mailbox list from cache (session) + // if not there, then get it from the imap server and store in cache + + if (!$force) { + sqgetGlobalVar($sub_cache_name,$lsub_cache,SQ_SESSION); + } + + $lsub_assoc_ary=array(); + if (!empty($lsub_cache)) { + $lsub_assoc_ary=$lsub_cache; + } else { + $lsub_ary = sqimap_run_command ($imap_stream, $lsub_args, true, $response, $message); + $lsub_ary = compact_mailboxes_response($lsub_ary); + if (!empty($lsub_ary)) { + foreach ($lsub_ary as $rawline) { + $temp_mailbox_name=find_mailbox_name($rawline); + $lsub_assoc_ary[$temp_mailbox_name]=$rawline; } + unset($lsub_ary); + sqsession_register($lsub_assoc_ary,$sub_cache_name); } + } - /* natural sort mailboxes */ - if (isset($sorted_lsub_ary)) { - usort($sorted_lsub_ary, 'strnatcasecmp'); + // Now to get the mailbox flags + // The LSUB response may return \NoSelect flags, etc. but it is optional + // according to RFC3501, and even when returned it may not be accurate + // or authoratative. LIST will always return accurate results. + if (($lsub == 'LIST') || ($lsub == 'LIST (SUBSCRIBED)')) { + // we've already done a LIST or LIST (SUBSCRIBED) + // and NOT a LSUB, so no need to do it again + $list_assoc_ary = $lsub_assoc_ary; + } else { + // we did a LSUB so now we need to do a LIST + // first see if it is in cache + $list_cache_name='list_cache'; + if (!$force) { + sqgetGlobalVar($list_cache_name,$list_cache,SQ_SESSION); } - /* - * The LSUB response doesn't provide us information about \Noselect - * mail boxes. The LIST response does, that's why we need to do a LIST - * call to retrieve the flags for the mailbox - * Note: according RFC2060 an imap server may provide \NoSelect flags in the LSUB response. - * in other words, we cannot rely on it. - */ - $sorted_list_ary = array(); - for ($i=0; $i < count($sorted_lsub_ary); $i++) { - if (substr($sorted_lsub_ary[$i], -1) == $delimiter) { - $mbx = substr($sorted_lsub_ary[$i], 0, strlen($sorted_lsub_ary[$i])-1); - } - else { - $mbx = $sorted_lsub_ary[$i]; - } - $mbx = stripslashes($mbx); - $read = sqimap_run_command ($imap_stream, 'LIST "" ' . sqimap_encode_mailbox_name($mbx), - true, $response, $message); - $read = compact_mailboxes_response($read); - if (isset($read[0])) { - $sorted_list_ary[$i] = $read[0]; - } else { - $sorted_list_ary[$i] = ''; + + if (!empty($list_cache)) { + $list_assoc_ary=$list_cache; + // we could store this in list_cache_name but not necessary + } else { + // not in cache so we need to go get it from the imap server + $list_assoc_ary = array(); + $list_ary = sqimap_run_command($imap_stream, $list_args, + true, $response, $message); + $list_ary = compact_mailboxes_response($list_ary); + if (!empty($list_ary)) { + foreach ($list_ary as $rawline) { + $temp_mailbox_name=find_mailbox_name($rawline); + $list_assoc_ary[$temp_mailbox_name]=$rawline; + } + unset($list_ary); + sqsession_register($list_assoc_ary,$list_cache_name); } } - /* - * Just in case they're not subscribed to their inbox, - * we'll get it for them anyway - */ - if (!$inbox_subscribed) { - $inbox_ary = sqimap_run_command ($imap_stream, 'LIST "" INBOX', - true, $response, $message); - $sorted_list_ary[] = implode('', compact_mailboxes_response($inbox_ary)); - $sorted_lsub_ary[] = find_mailbox_name($inbox_ary[0]); - } - - $boxesall = sqimap_mailbox_parse ($sorted_list_ary, $sorted_lsub_ary); - - /* Now, lets sort for special folders */ - $boxesnew = $used = array(); + } - /* Find INBOX */ - $cnt = count($boxesall); - $used = array_pad($used,$cnt,false); - for($k = 0; $k < $cnt; ++$k) { - if (strtolower($boxesall[$k]['unformatted']) == 'inbox') { - $boxesnew[] = $boxesall[$k]; - $used[$k] = true; - break; + // If they aren't subscribed to the inbox, then add it anyway (if its in LIST) + $inbox_subscribed=false; + if (!empty($lsub_assoc_ary)) { + foreach ($lsub_assoc_ary as $temp_mailbox_name=>$rawline) { + if (strtoupper($temp_mailbox_name) == 'INBOX') { + $inbox_subscribed=true; } } - /* List special folders and their subfolders, if requested. */ - if ($list_special_folders_first) { - for($k = 0; $k < $cnt; ++$k) { - if (!$used[$k] && isSpecialMailbox($boxesall[$k]['unformatted'])) { - $boxesnew[] = $boxesall[$k]; - $used[$k] = true; + } + if (!$inbox_subscribed) { + if (!empty($list_assoc_ary)) { + foreach ($list_assoc_ary as $temp_mailbox_name=>$rawline) { + if (strtoupper($temp_mailbox_name) == 'INBOX') { + $lsub_assoc_ary[$temp_mailbox_name]=$rawline; } } } + } - /* Rest of the folders */ - for($k = 0; $k < $cnt; $k++) { - if (!$used[$k]) { - $boxesnew[] = $boxesall[$k]; + // Now we have the raw output, we need to create an array of mailbox names we will return + if (!$show_only_subscribed) { + $final_folders_assoc_ary=$list_assoc_ary; + } else { + /** + * only show subscribed folders + * we need to merge the folders here... we can't trust the flags, etc. from the lsub_assoc_array + * so we use the lsub_assoc_array as the list of folders and the values come from list_assoc_array + */ + if (!empty($lsub_assoc_ary)) { + foreach ($lsub_assoc_ary as $temp_mailbox_name=>$rawline) { + if (!empty($list_assoc_ary[$temp_mailbox_name])) { + $final_folders_assoc_ary[$temp_mailbox_name]=$list_assoc_ary[$temp_mailbox_name]; + } } } } - - return $boxesnew; -} -/** - * Returns a list of all folders, subscribed or not - */ -function sqimap_mailbox_list_all($imap_stream) { - global $list_special_folders_first, $folder_prefix, $delimiter; - $read_ary = sqimap_run_command($imap_stream,"LIST \"$folder_prefix\" *",true,$response, $message,false); - $read_ary = compact_mailboxes_response($read_ary); + // Now produce a flat, sorted list + if (!empty($final_folders_assoc_ary)) { + uksort($final_folders_assoc_ary,'strnatcasecmp'); + foreach ($final_folders_assoc_ary as $temp_mailbox_name=>$rawline) { + $final_folders_ary[]=$rawline; + } + } - $g = 0; - $phase = 'inbox'; - $fld_pre_length = strlen($folder_prefix); - for ($i = 0, $cnt = count($read_ary); $i < $cnt; $i++) { - /* Store the raw IMAP reply */ - $boxes[$g]['raw'] = $read_ary[$i]; + // this will put it into an array we can use later + // containing: + // raw - Raw LIST/LSUB response from the IMAP server + // formatted - formatted folder name + // unformatted - unformatted, but with the delimiter at the end removed + // unformated-dm - folder name as it appears in raw response + // unformatted-disp - unformatted without $folder_prefix + // id - the array element number (0, 1, 2, etc.) + // flags - mailbox flags + if (!empty($final_folders_ary)) { + $boxesall = sqimap_mailbox_parse($final_folders_ary); + } else { + // they have no mailboxes + $boxesall=array(); + } - /* Count number of delimiters ($delimiter) in folder name */ - $mailbox = find_mailbox_name($read_ary[$i]); - $dm_count = substr_count($mailbox, $delimiter); - if (substr($mailbox, -1) == $delimiter) { - /* If name ends in delimiter - decrement count by one */ - $dm_count--; + /* Now, lets sort for special folders */ + $boxesnew = $used = array(); + + /* Find INBOX */ + $cnt = count($boxesall); + $used = array_pad($used,$cnt,false); + $has_inbox = false; + for($k = 0; $k < $cnt; ++$k) { + if (strtoupper($boxesall[$k]['unformatted']) == 'INBOX') { + $boxesnew[] = $boxesall[$k]; + $used[$k] = true; + $has_inbox = true; + break; } + } - /* Format folder name, but only if it's a INBOX.* or has a parent. */ - $boxesallbyname[$mailbox] = $g; - $parentfolder = readMailboxParent($mailbox, $delimiter); - if((eregi('^inbox'.quotemeta($delimiter), $mailbox)) || - (ereg('^'.$folder_prefix, $mailbox)) || - ( isset($boxesallbyname[$parentfolder]) && (strlen($parentfolder) > 0) ) ) { - if ($dm_count) { - $boxes[$g]['formatted'] = str_repeat('  ', $dm_count); + if ($has_inbox == false) { + // do a list request for inbox because we should always show + // inbox even if the user isn't subscribed to it. + $inbox_ary = sqimap_run_command($imap_stream, 'LIST "" "INBOX"', + true, $response, $message); + $inbox_ary = compact_mailboxes_response($inbox_ary); + if (count($inbox_ary)) { + $inbox_entry = sqimap_mailbox_parse($inbox_ary); + // add it on top of the list + if (!empty($boxesnew)) { + array_unshift($boxesnew,$inbox_entry[0]); } else { - $boxes[$g]['formatted'] = ''; + $boxesnew[]=$inbox_entry[0]; } - $boxes[$g]['formatted'] .= imap_utf7_decode_local(readShortMailboxName($mailbox, $delimiter)); - } else { - $boxes[$g]['formatted'] = imap_utf7_decode_local($mailbox); + /* array_unshift($used,true); */ } + } - $boxes[$g]['unformatted-dm'] = $mailbox; - if (substr($mailbox, -1) == $delimiter) { - $mailbox = substr($mailbox, 0, strlen($mailbox) - 1); - } - $boxes[$g]['unformatted'] = $mailbox; - $boxes[$g]['unformatted-disp'] = substr($mailbox,$fld_pre_length); - - $boxes[$g]['id'] = $g; - - /* Now lets get the flags for this mailbox */ - $read_mlbx = $read_ary[$i]; - $flags = substr($read_mlbx, strpos($read_mlbx, '(')+1); - $flags = substr($flags, 0, strpos($flags, ')')); - $flags = str_replace('\\', '', $flags); - $flags = trim(strtolower($flags)); - if ($flags) { - $boxes[$g]['flags'] = explode(' ', $flags); - } else { - $boxes[$g]['flags'] = array(); + /* List special folders and their subfolders, if requested. */ + if ($list_special_folders_first) { + for($k = 0; $k < $cnt; ++$k) { + if (!$used[$k] && isSpecialMailbox($boxesall[$k]['unformatted'])) { + $boxesnew[] = $boxesall[$k]; + $used[$k] = true; + } } - $g++; } - if(is_array($boxes)) { - sort ($boxes); - } - - return $boxes; -} -function sqimap_mailbox_tree($imap_stream) { - global $boxesnew, $default_folder_prefix, $unseen_notify, $unseen_type; - if (!isset($boxesnew)) { - - global $data_dir, $username, $list_special_folders_first, - $folder_prefix, $delimiter, $trash_folder, $move_to_trash, - $imap_server_type; - - - $inbox_in_list = false; - $inbox_subscribed = false; - $noselect = false; - $noinferiors = false; - - require_once(SM_PATH . 'include/load_prefs.php'); - - /* LSUB array */ - $lsub_ary = sqimap_run_command ($imap_stream, "LSUB \"$folder_prefix\" \"*\"", - true, $response, $message); - $lsub_ary = compact_mailboxes_response($lsub_ary); - - /* Check to see if we have an INBOX */ - $has_inbox = false; + /* Find INBOX's children */ + for($k = 0; $k < $cnt; ++$k) { + $isboxbelow=isBoxBelow(strtoupper($boxesall[$k]['unformatted']),'INBOX'); + if (strtoupper($boxesall[$k]['unformatted']) == 'INBOX') { + $is_inbox=1; + } else { + $is_inbox=0; + } - for ($i = 0, $cnt = count($lsub_ary); $i < $cnt; $i++) { - if (preg_match("/^\*\s+LSUB.*\s\"?INBOX\"?[^(\/\.)].*$/i",$lsub_ary[$i])) { - $lsub_ary[$i] = strtoupper($lsub_ary[$i]); - $has_inbox = true; - break; - } + if (!$used[$k] && $isboxbelow && $is_inbox) { + $boxesnew[] = $boxesall[$k]; + $used[$k] = true; } + } - if ($has_inbox == false) { - $lsub_ary[] = '* LSUB () NIL INBOX'; + /* Rest of the folders */ + for($k = 0; $k < $cnt; $k++) { + if (!$used[$k]) { + $boxesnew[] = $boxesall[$k]; } + } + /** + * Don't register boxes in session, if $session_register is set to false + * Prevents registration of sqimap_mailbox_list_all() results. + */ + if ($session_register) sqsession_register($boxesnew,'boxesnew'); + return $boxesnew; +} - /* - * Section about removing the last element was removed - * We don't return "* OK" anymore from sqimap_read_data +/** + * Fills mailbox object + * + * this is passed the mailbox array by left_main.php + * who has previously obtained it from sqimap_get_mailboxes + * that way, the raw mailbox list is available in left_main to other + * things besides just sqimap_mailbox_tree + * imap_stream is just used now to get status info + * + * most of the functionality is moved to sqimap_get_mailboxes + * also takes care of TODO items: + * caching mailbox tree + * config setting for UW imap section (not needed now) + * + * Some code fragments are present in 1.3.0 - 1.4.4. + * @param stream $imap_stream imap connection resource + * @param array $lsub_ary output array from sqimap_get_mailboxes (contains mailboxes and flags) + * @return object see mailboxes class. + * @since 1.5.0 + */ +function sqimap_mailbox_tree($imap_stream,$lsub_ary) { + + $sorted_lsub_ary = array(); + $cnt = count($lsub_ary); + for ($i = 0; $i < $cnt; $i++) { + $mbx=$lsub_ary[$i]['unformatted']; + $flags=$lsub_ary[$i]['flags']; + + $noinferiors=0; + if (in_array('\Noinferiors',$flags)) { $noinferiors=1; } + if (in_array('\NoInferiors',$flags)) { $noinferiors=1; } + if (in_array('\HasNoChildren',$flags)) { $noinferiors=1; } + + $noselect=0; + if (in_array('\NoSelect',$flags)) { $noselect=1; } + /** + * LIST (SUBSCRIBED) has two new flags, \NonExistent which means the mailbox is subscribed to + * but doesn't exist, and \PlaceHolder which is similar (but not the same) as \NoSelect + * For right now, we'll treat these the same as \NoSelect and this behavior can be changed + * later if needed */ + if (in_array('\NonExistent',$flags)) { $noselect=1; } + if (in_array('\PlaceHolder',$flags)) { $noselect=1; } + $sorted_lsub_ary[] = array ('mbx' => $mbx, 'noselect' => $noselect, 'noinferiors' => $noinferiors); + } - $sorted_lsub_ary = array(); - $cnt = count($lsub_ary); - for ($i = 0; $i < $cnt; $i++) { - $mbx = find_mailbox_name($lsub_ary[$i]); + $sorted_lsub_ary = array_values($sorted_lsub_ary); + usort($sorted_lsub_ary, 'mbxSort'); + $boxestree = sqimap_fill_mailbox_tree($sorted_lsub_ary,false,$imap_stream); + return $boxestree; +} - // only do the noselect test if !uw, is checked later. FIX ME see conf.pl setting - if ($imap_server_type != "uw") { - $noselect = check_is_noselect($lsub_ary[$i]); - $noinferiors = check_is_noinferiors($lsub_ary[$i]); - } - if (substr($mbx, -1) == $delimiter) { - $mbx = substr($mbx, 0, strlen($mbx) - 1); - } - $sorted_lsub_ary[] = array ('mbx' => $mbx, 'noselect' => $noselect, 'noinferiors' => $noinferiors); - } - // FIX ME this requires a config setting inside conf.pl instead of checking on server type - if ($imap_server_type == "uw") { - $aQuery = array(); - $aTag = array(); - // prepare an array with queries - foreach ($sorted_lsub_ary as $aMbx) { - $mbx = stripslashes($aMbx['mbx']); - sqimap_prepare_pipelined_query('LIST "" ' . sqimap_encode_mailbox_name($mbx), $tag, $aQuery, false); - $aTag[$tag] = $mbx; - } - $sorted_lsub_ary = array(); - // execute all the queries at once - $aResponse = sqimap_run_pipelined_command ($imap_stream, $aQuery, false, $aServerResponse, $aServerMessage); - foreach($aTag as $tag => $mbx) { - if ($aServerResponse[$tag] == 'OK') { - $sResponse = implode('', $aResponse[$tag]); - $noselect = check_is_noselect($sResponse); - $noinferiors = check_is_noinferiors($sResponse); - $sorted_lsub_ary[] = array ('mbx' => $mbx, 'noselect' => $noselect, 'noinferiors' => $noinferiors); - } - } - $cnt = count($sorted_lsub_ary); - } - $sorted_lsub_ary = array_values($sorted_lsub_ary); - array_multisort($sorted_lsub_ary, SORT_ASC, SORT_REGULAR); - $boxesnew = sqimap_fill_mailbox_tree($sorted_lsub_ary,false,$imap_stream); - return $boxesnew; - } +/** + * Callback function used for sorting mailboxes in sqimap_mailbox_tree + * @param string $a + * @param string $b + * @return integer see php strnatcasecmp() + * @since 1.5.1 + */ +function mbxSort($a, $b) { + return strnatcasecmp($a['mbx'], $b['mbx']); } +/** + * Fills mailbox object + * + * Some code fragments are present in 1.3.0 - 1.4.4. + * @param array $mbx_ary + * @param $mbxs + * @param stream $imap_stream imap connection resource + * @return object see mailboxes class + * @since 1.5.0 + */ function sqimap_fill_mailbox_tree($mbx_ary, $mbxs=false,$imap_stream) { global $data_dir, $username, $list_special_folders_first, $folder_prefix, $trash_folder, $sent_folder, $draft_folder, $move_to_trash, $move_to_sent, $save_as_draft, $delimiter, $imap_server_type; - $special_folders = array ('INBOX', $sent_folder, $draft_folder, $trash_folder); + // $special_folders = array ('INBOX', $sent_folder, $draft_folder, $trash_folder); /* create virtual root node */ $mailboxes= new mailboxes(); @@ -887,11 +1185,9 @@ function sqimap_fill_mailbox_tree($mbx_ary, $mbxs=false,$imap_stream) { $trail_del = false; $start = 0; - if (isset($folder_prefix) && ($folder_prefix != '')) { $start = substr_count($folder_prefix,$delimiter); if (strrpos($folder_prefix, $delimiter) == (strlen($folder_prefix)-1)) { - $trail_del = true; $mailboxes->mailboxname_full = substr($folder_prefix,0, (strlen($folder_prefix)-1)); } else { $mailboxes->mailboxname_full = $folder_prefix; @@ -902,56 +1198,25 @@ function sqimap_fill_mailbox_tree($mbx_ary, $mbxs=false,$imap_stream) { $start = 0; } - $cnt = count($mbx_ary); + $cnt = count($mbx_ary); for ($i=0; $i < $cnt; $i++) { if ($mbx_ary[$i]['mbx'] !='' ) { $mbx = new mailboxes(); $mailbox = $mbx_ary[$i]['mbx']; - /* - sent subfolders messes up using existing code as subfolders - were marked, but the parents were ordered somewhere else in - the list, despite having "special folders at top" option set. - Need a better method than this. - */ -/* - if ($mailbox == 'INBOX') { - $mbx->is_special = true; - } elseif (stristr($trash_folder , $mailbox)) { - $mbx->is_special = true; - } elseif (stristr($sent_folder , $mailbox)) { - $mbx->is_special = true; - } elseif (stristr($draft_folder , $mailbox)) { - $mbx->is_special = true; - } - - switch ($mailbox) { - case 'INBOX': - $mbx->is_inbox = true; - $mbx->is_special = true; - $mbx_ary[$i]['noselect'] = false; - break; - case $trash_folder: - $mbx->is_trash = true; - $mbx->is_special = true; - break; - case $sent_folder: - $mbx->is_sent = true; - $mbx->is_special = true; - break; - case $draft_folder: - $mbx->is_draft = true; - $mbx->is_special = true; - break; - } -*/ + /* + * Set the is_special flag if it concerned a special mailbox. + * Used for displaying the special folders on top in the mailbox + * tree displaying code. + */ $mbx->is_special |= ($mbx->is_inbox = (strtoupper($mailbox) == 'INBOX')); $mbx->is_special |= ($mbx->is_trash = isTrashMailbox($mailbox)); $mbx->is_special |= ($mbx->is_sent = isSentMailbox($mailbox)); $mbx->is_special |= ($mbx->is_draft = isDraftMailbox($mailbox)); + if (!$mbx->is_special) $mbx->is_special = boolean_hook_function('special_mailbox', $mailbox, 1); - + if (isset($mbx_ary[$i]['unseen'])) { $mbx->unseen = $mbx_ary[$i]['unseen']; } @@ -978,20 +1243,39 @@ function sqimap_fill_mailbox_tree($mbx_ary, $mbxs=false,$imap_stream) { return $mailboxes; } +/** + * @param object $mbx_tree + * @since 1.5.0 + */ function sqimap_utf7_decode_mbx_tree(&$mbx_tree) { - if (strtoupper($mbx_tree->mailboxname_full) == 'INBOX') - $mbx_tree->mailboxname_sub = _("INBOX"); - else - $mbx_tree->mailboxname_sub = imap_utf7_decode_local($mbx_tree->mailboxname_sub); - if ($mbx_tree->mbxs) { - $iCnt = count($mbx_tree->mbxs); - for ($i=0;$i<$iCnt;++$i) { - $mbxs_tree->mbxs[$i] = sqimap_utf7_decode_mbx_tree($mbx_tree->mbxs[$i]); - } - } -} + global $draft_folder, $sent_folder, $trash_folder, $translate_special_folders; + + /* decode folder name and set mailboxname_sub */ + if ($translate_special_folders && strtoupper($mbx_tree->mailboxname_full) == 'INBOX') { + $mbx_tree->mailboxname_sub = _("INBOX"); + } elseif ($translate_special_folders && $mbx_tree->mailboxname_full == $draft_folder) { + $mbx_tree->mailboxname_sub = _("Drafts"); + } elseif ($translate_special_folders && $mbx_tree->mailboxname_full == $sent_folder) { + $mbx_tree->mailboxname_sub = _("Sent"); + } elseif ($translate_special_folders && $mbx_tree->mailboxname_full == $trash_folder) { + $mbx_tree->mailboxname_sub = _("Trash"); + } else { + $mbx_tree->mailboxname_sub = imap_utf7_decode_local($mbx_tree->mailboxname_sub); + } + if ($mbx_tree->mbxs) { + $iCnt = count($mbx_tree->mbxs); + for ($i=0;$i<$iCnt;++$i) { + sqimap_utf7_decode_mbx_tree($mbx_tree->mbxs[$i]); + } + } +} +/** + * @param object $mbx_tree + * @param array $aMbxs + * @since 1.5.0 + */ function sqimap_tree_to_ref_array(&$mbx_tree,&$aMbxs) { if ($mbx_tree) $aMbxs[] =& $mbx_tree; @@ -1001,11 +1285,16 @@ function sqimap_tree_to_ref_array(&$mbx_tree,&$aMbxs) { sqimap_tree_to_ref_array($mbx_tree->mbxs[$i],$aMbxs); } } -} +} +/** + * @param stream $imap_stream imap connection resource + * @param object $mbx_tree + * @since since 1.5.0 + */ function sqimap_get_status_mbx_tree($imap_stream,&$mbx_tree) { global $unseen_notify, $unseen_type, $trash_folder,$move_to_trash; - $aMbxs = $aQuery = $aTag = array(); + $aMbxs = $aQuery = array(); sqimap_tree_to_ref_array($mbx_tree,$aMbxs); // remove the root node array_shift($aMbxs); @@ -1018,13 +1307,13 @@ function sqimap_get_status_mbx_tree($imap_stream,&$mbx_tree) { $mbx = $oMbx->mailboxname_full; if ($unseen_type == 2 || ($move_to_trash && $oMbx->mailboxname_full == $trash_folder)) { - $query = 'STATUS ' . sqimap_encode_mailbox_name($mbx) . ' (MESSAGES UNSEEN)'; + $query = 'STATUS ' . sqimap_encode_mailbox_name($mbx) . ' (MESSAGES UNSEEN RECENT)'; } else { - $query = 'STATUS ' . sqimap_encode_mailbox_name($mbx) . ' (UNSEEN)'; + $query = 'STATUS ' . sqimap_encode_mailbox_name($mbx) . ' (UNSEEN RECENT)'; } sqimap_prepare_pipelined_query($query,$tag,$aQuery,false); } else { - $oMbx->unseen = $oMbx->total = false; + $oMbx->unseen = $oMbx->total = $oMbx->recent = false; $tag = false; } $oMbx->tag = $tag; @@ -1044,6 +1333,10 @@ function sqimap_get_status_mbx_tree($imap_stream,&$mbx_tree) { if (preg_match('/MESSAGES\s+([0-9]+)/i', $sResponse, $regs)) { $oMbx->total = $regs[1]; } + if (preg_match('/RECENT\s+([0-9]+)/i', $sResponse, $regs)) { + $oMbx->recent = $regs[1]; + } + } unset($oMbx->tag); } @@ -1053,11 +1346,12 @@ function sqimap_get_status_mbx_tree($imap_stream,&$mbx_tree) { $oMbx =& $aMbxs[$i]; if (strtoupper($oMbx->mailboxname_full) == 'INBOX' || ($move_to_trash && $oMbx->mailboxname_full == $trash_folder)) { - if ($unseen_type == 2 || + if ($unseen_type == 2 || ($oMbx->mailboxname_full == $trash_folder && $move_to_trash)) { $aStatus = sqimap_status_messages($imap_stream,$oMbx->mailboxname_full); $oMbx->unseen = $aStatus['UNSEEN']; $oMbx->total = $aStatus['MESSAGES']; + $oMbx->recent = $aStatus['RECENT']; } else { $oMbx->unseen = sqimap_unseen_messages($imap_stream,$oMbx->mailboxname_full); } @@ -1072,7 +1366,62 @@ function sqimap_get_status_mbx_tree($imap_stream,&$mbx_tree) { } } } - } -} + } -?> + $cnt = count($aMbxs); + for($i=0;$i<$cnt;++$i) { + $oMbx =& $aMbxs[$i]; + unset($hook_status); + if (!empty($oMbx->unseen)) { $hook_status['UNSEEN']=$oMbx->unseen; } + if (!empty($oMbx->total)) { $hook_status['MESSAGES']=$oMbx->total; } + if (!empty($oMbx->recent)) { $hook_status['RECENT']=$oMbx->recent; } + if (!empty($hook_status)) + { + $hook_status['MAILBOX']=$oMbx->mailboxname_full; + $hook_status['CALLER']='sqimap_get_status_mbx_tree'; // helps w/ debugging + do_hook('folder_status', $hook_status); + } + } +} + +/** + * Checks if folder is noselect (can't store messages) + * + * Function does not check if folder subscribed. + * @param stream $oImapStream imap connection resource + * @param string $sImapFolder imap folder name + * @param object $oBoxes mailboxes class object. + * @return boolean true, when folder has noselect flag. false in any other case. + * @since 1.5.1 + */ +function sqimap_mailbox_is_noselect($oImapStream,$sImapFolder,&$oBoxes) { + // build mailbox object if it is not available + if (! is_object($oBoxes)) $oBoxes=sqimap_mailbox_list($oImapStream); + foreach($oBoxes as $box) { + if ($box['unformatted']==$sImapFolder) { + return (bool) check_is_noselect($box['raw']); + } + } + return false; +} + +/** + * Checks if folder is noinferiors (can't store other folders) + * + * Function does not check if folder subscribed. + * @param stream $oImapStream imap connection resource + * @param string $sImapFolder imap folder name + * @param object $oBoxes mailboxes class object. + * @return boolean true, when folder has noinferiors flag. false in any other case. + * @since 1.5.1 + */ +function sqimap_mailbox_is_noinferiors($oImapStream,$sImapFolder,&$oBoxes) { + // build mailbox object if it is not available + if (! is_object($oBoxes)) $oBoxes=sqimap_mailbox_list($oImapStream); + foreach($oBoxes as $box) { + if ($box['unformatted']==$sImapFolder) { + return (bool) check_is_noinferiors($box['raw']); + } + } + return false; +}