X-Git-Url: https://vcs.fsf.org/?p=squirrelmail.git;a=blobdiff_plain;f=functions%2Fimap_mailbox.php;h=4d4e830b2c718fd6990401e64b30d394d4d669ce;hp=8d5b957e52c2da4dcd9e371dbe7ab92e642514d0;hb=3fe751d7e853eef227ef3a57f0fcce83df69f9e7;hpb=3bc714d503d53465083aaf325a649c6bd1bfc650 diff --git a/functions/imap_mailbox.php b/functions/imap_mailbox.php index 8d5b957e..4d4e830b 100755 --- a/functions/imap_mailbox.php +++ b/functions/imap_mailbox.php @@ -3,13 +3,14 @@ /** * imap_mailbox.php * - * Copyright (c) 1999-2004 The SquirrelMail Project Team + * Copyright (c) 1999-2005 The SquirrelMail Project Team * Licensed under the GNU GPL. For full terms see the file COPYING. * * This impliments all functions that manipulate mailboxes * - * $Id$ + * @version $Id$ * @package squirrelmail + * @subpackage imap */ /** UTF7 support */ @@ -19,20 +20,21 @@ 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. * @package squirrelmail -*/ - + * @subpackage imap + * @since 1.3.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(), + $is_trash = false, $is_draft = false, $mbxs = array(), $unseen = false, $total = false; function addMbx($mbx, $delimiter, $start, $specialfirst) { @@ -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,32 +189,39 @@ 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 + * @return boolean + * @since 1.2.3 */ function isSpecialMailbox( $box ) { $ret = ( (strtolower($box) == 'inbox') || @@ -194,7 +234,10 @@ function isSpecialMailbox( $box ) { } /** + * Detects if mailbox is a Trash folder or subfolder of Trash + * @param string $box mailbox name * @return bool whether this is a Trash folder + * @since 1.4.0 */ function isTrashMailbox ($box) { global $trash_folder, $move_to_trash; @@ -203,7 +246,10 @@ function isTrashMailbox ($box) { } /** + * Detects if mailbox is a Sent folder or subfolder of Sent + * @param string $box mailbox name * @return bool whether this is a Sent folder + * @since 1.4.0 */ function isSentMailbox($box) { global $sent_folder, $move_to_sent; @@ -212,7 +258,10 @@ function isSentMailbox($box) { } /** + * Detects if mailbox is a Drafts folder or subfolder of Drafts + * @param string $box mailbox name * @return bool whether this is a Draft folder + * @since 1.4.0 */ function isDraftMailbox($box) { global $draft_folder, $save_as_draft; @@ -221,16 +270,27 @@ function isDraftMailbox($box) { } /** - * 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; } @@ -248,60 +308,12 @@ function sqimap_mailbox_expunge ($imap_stream, $mailbox, $handle_errors = true, return $cnt; } -/** - * 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. - */ -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); - } - - for ($i = 0; $i < count($msort); $i++) { - if ($msgs[$i]['ID'] == $message_id) { - break; - } - } - - 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 + * @param stream $imap_stream imap connection resource + * @param string $mailbox mailbox name + * @return boolean + * @since 1.0 or older */ function sqimap_mailbox_exists ($imap_stream, $mailbox) { if (!isset($mailbox) || empty($mailbox)) { @@ -314,10 +326,13 @@ function sqimap_mailbox_exists ($imap_stream, $mailbox) { /** * Selects a mailbox + * Before 1.3.0 used more arguments and returned data depended on those argumements. + * @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') { return; } @@ -333,25 +348,36 @@ 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; @@ -367,15 +393,22 @@ function sqimap_mailbox_create ($imap_stream, $mailbox, $type) { /** * 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,6 +418,10 @@ 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; @@ -398,11 +435,16 @@ function sqimap_mailbox_delete ($imap_stream, $mailbox) { } else { do_hook_function('rename_or_delete_folder', $args = 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 +458,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,15 +475,18 @@ 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); + setPref($data_dir, $username, 'thread_'.$new_name.$postfix, $oldpref_thread); + setPref($data_dir, $username, 'collapse_folder_'.$new_name.$postfix, $oldpref_collapse); do_hook_function('rename_or_delete_folder',$args = array($old_name, 'rename', $new_name)); $l = strlen( $old_name ) + 1; $p = 'unformatted'; @@ -444,16 +494,25 @@ function sqimap_mailbox_rename( $imap_stream, $old_name, $new_name ) { 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); + 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_function('rename_or_delete_folder', $args = array($box[$p], 'rename', $new_sub)); } @@ -465,12 +524,21 @@ 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 + *
    + *
  • 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. + * @param $line + * @param $line_lsub + * @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) { global $folder_prefix, $delimiter; @@ -524,7 +592,7 @@ 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 + // 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]))); @@ -539,22 +607,24 @@ 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 + * 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 + * @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). - * $flag - flag to check for in mailbox flags, used to filter out mailboxes. + * @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 - * $use_long_format - override folder display preference and always show full folder name. + * @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, +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; $mbox_options = ''; @@ -569,26 +639,27 @@ function sqimap_mailbox_option_list($imap_stream, $show_selected = 0, $folder_sk } 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']); + $box2 = str_replace('&nbsp;&nbsp;', '. ', htmlspecialchars($boxes_part['formatted'])); break; case 1: /* indent, style = 1 */ - $box2 = $boxes_part['formatted']; + $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']))); @@ -596,9 +667,9 @@ function sqimap_mailbox_option_list($imap_stream, $show_selected = 0, $folder_sk } } if ($show_selected != 0 && in_array($lowerbox, $show_selected) ) { - $mbox_options .= '' . "\n"; + $mbox_options .= '' . "\n"; } else { - $mbox_options .= '' . "\n"; + $mbox_options .= '' . "\n"; } } } @@ -606,27 +677,37 @@ function sqimap_mailbox_option_list($imap_stream, $show_selected = 0, $folder_sk } /** - * Returns sorted mailbox lists in several different ways. + * Returns sorted mailbox lists in several different ways. * 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; - - if (!isset($boxesnew)) { +function sqimap_mailbox_list($imap_stream, $force=false) { + if (!sqgetGlobalVar('boxesnew',$boxesnew,SQ_SESSION) || $force) { 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; - - $inbox_in_list = false; + $delimiter, $noselect_fix_enable, $imap_server_type, + $show_only_subscribed_folders; $inbox_subscribed = false; + $listsubscribed = sqimap_capability($imap_stream,'LIST-SUBSCRIBED'); require_once(SM_PATH . 'include/load_prefs.php'); + if (!$show_only_subscribed_folders) { + $lsub = 'LIST'; + } elseif ($listsubscribed) { + $lsub = 'LIST (SUBSCRIBED)'; + } else { + $lsub = 'LSUB'; + } + if ($noselect_fix_enable) { - $lsub_args = "LSUB \"$folder_prefix\" \"*%\""; + $lsub_args = "$lsub \"$folder_prefix\" \"*%\""; } else { - $lsub_args = "LSUB \"$folder_prefix\" \"*\""; + $lsub_args = "$lsub \"$folder_prefix\" \"*\""; } /* LSUB array */ $lsub_ary = sqimap_run_command ($imap_stream, $lsub_args, @@ -635,6 +716,7 @@ function sqimap_mailbox_list($imap_stream) { $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') { @@ -652,33 +734,37 @@ function sqimap_mailbox_list($imap_stream) { * 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 (!$listsubscribed) { + 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] = ''; } - } + } + // } /* * 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', + $inbox_ary = sqimap_run_command ($imap_stream, 'LIST "" "INBOX"', true, $response, $message); - $sorted_list_ary[] = implode('', compact_mailboxes_response($inbox_ary)); + $sorted_list_ary[] = implode('',compact_mailboxes_response($inbox_ary)); $sorted_lsub_ary[] = find_mailbox_name($inbox_ary[0]); } @@ -707,19 +793,31 @@ function sqimap_mailbox_list($imap_stream) { } } + /* Find INBOX's children */ + for($k = 0; $k < $cnt; ++$k) { + if (!$used[$k] && isBoxBelow(strtolower($boxesall[$k]['unformatted']), 'inbox') && + strtolower($boxesall[$k]['unformatted']) != 'inbox') { + $boxesnew[] = $boxesall[$k]; + $used[$k] = true; + } + } + /* Rest of the folders */ for($k = 0; $k < $cnt; $k++) { if (!$used[$k]) { $boxesnew[] = $boxesall[$k]; } } + sqsession_register($boxesnew,'boxesnew'); } - return $boxesnew; } /** - * Returns a list of all folders, subscribed or not + * Returns a list of all folders, subscribed or not + * @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 $list_special_folders_first, $folder_prefix, $delimiter; @@ -728,7 +826,6 @@ function sqimap_mailbox_list_all($imap_stream) { $read_ary = compact_mailboxes_response($read_ary); $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 */ @@ -787,24 +884,31 @@ function sqimap_mailbox_list_all($imap_stream) { return $boxes; } +/** + * @param stream $imap_stream imap connection resource + * @return object see mailboxes class. + * @since 1.3.0 + */ function sqimap_mailbox_tree($imap_stream) { - global $boxesnew, $default_folder_prefix, $unseen_notify, $unseen_type; - if (!isset($boxesnew)) { - + global $default_folder_prefix; + if (true) { global $data_dir, $username, $list_special_folders_first, $folder_prefix, $delimiter, $trash_folder, $move_to_trash, - $imap_server_type; + $imap_server_type, $show_only_subscribed_folders; - - $inbox_in_list = false; - $inbox_subscribed = false; $noselect = false; $noinferiors = false; require_once(SM_PATH . 'include/load_prefs.php'); + if ($show_only_subscribed_folders) { + $lsub_cmd = 'LSUB'; + } else { + $lsub_cmd = 'LIST'; + } + /* LSUB array */ - $lsub_ary = sqimap_run_command ($imap_stream, "LSUB \"$folder_prefix\" \"*\"", + $lsub_ary = sqimap_run_command ($imap_stream, "$lsub_cmd \"$folder_prefix\" \"*\"", true, $response, $message); $lsub_ary = compact_mailboxes_response($lsub_ary); @@ -812,19 +916,38 @@ function sqimap_mailbox_tree($imap_stream) { $has_inbox = false; for ($i = 0, $cnt = count($lsub_ary); $i < $cnt; $i++) { - if (preg_match("/^\*\s+LSUB\s+(.*)\s\"?INBOX\"?[^(\/\.)].*$/i",$lsub_ary[$i])) { - $lsub_ary[$i] = strtoupper($lsub_ary[$i]); - $has_inbox = true; + if (preg_match("/^\*\s+$lsub_cmd.*\s\"?INBOX\"?[^(\/\.)].*$/i",$lsub_ary[$i])) { + $lsub_ary[$i] = strtoupper($lsub_ary[$i]); + // in case of an unsubscribed inbox an imap server can + // return the inbox in the lsub results with a \NoSelect + // flag. + if (!preg_match("/\*\s+$lsub_cmd\s+\(.*\\\\NoSelect.*\).*/i",$lsub_ary[$i])) { + $has_inbox = true; + } else { + // remove the result and request it again with a list + // response at a later stage. + unset($lsub_ary[$i]); + // re-index the array otherwise the addition of the LIST + // response will fail in PHP 4.1.2 and probably other older versions + $lsub_ary = array_values($lsub_ary); + } break; } } if ($has_inbox == false) { - $lsub_ary[] = '* LSUB () NIL INBOX'; + // 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)) { + $lsub_ary[] = $inbox_ary[0]; + } } /* - * Section about removing the last element was removed + * Section about removing the last element was removed * We don't return "* OK" anymore from sqimap_read_data */ @@ -834,14 +957,14 @@ function sqimap_mailbox_tree($imap_stream) { $mbx = find_mailbox_name($lsub_ary[$i]); // only do the noselect test if !uw, is checked later. FIX ME see conf.pl setting - if ($imap_server_type != "uw") { + 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); + $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") { @@ -852,7 +975,7 @@ function sqimap_mailbox_tree($imap_stream) { $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); @@ -867,19 +990,37 @@ function sqimap_mailbox_tree($imap_stream) { $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; + usort($sorted_lsub_ary, 'mbxSort'); + $boxestree = sqimap_fill_mailbox_tree($sorted_lsub_ary,false,$imap_stream); + return $boxestree; } } +/** + * 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']); +} + +/** + * @param array $mbx_ary + * @param $mbxs + * @param stream $imap_stream (since 1.5.0) imap connection resource + * @return object see mailboxes class + * @since 1.3.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(); @@ -891,7 +1032,6 @@ function sqimap_fill_mailbox_tree($mbx_ary, $mbxs=false,$imap_stream) { 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 +1042,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,8 +1087,12 @@ 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_sub) == 'INBOX') + 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); @@ -991,7 +1104,11 @@ function sqimap_utf7_decode_mbx_tree(&$mbx_tree) { } } - +/** + * @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 +1118,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); @@ -1053,7 +1175,7 @@ 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']; @@ -1072,7 +1194,7 @@ function sqimap_get_status_mbx_tree($imap_stream,&$mbx_tree) { } } } - } -} + } +} -?> +?> \ No newline at end of file