X-Git-Url: https://vcs.fsf.org/?p=squirrelmail.git;a=blobdiff_plain;f=functions%2Fimap_mailbox.php;h=63509bacec6718a2f5db6346f55290f29b337a55;hp=2c161eaeae92bc31d1af90ce8fff534c2dfd4a69;hb=0853837b3efb9d8fca15cb9cb22b54a916adfc72;hpb=be2d549570f1501e50b89557351aa3b0372e2e36 diff --git a/functions/imap_mailbox.php b/functions/imap_mailbox.php index 2c161eae..63509bac 100755 --- a/functions/imap_mailbox.php +++ b/functions/imap_mailbox.php @@ -3,98 +3,179 @@ /** * imap_mailbox.php * - * Copyright (c) 1999-2002 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 */ -require_once(SM_PATH . 'functions/imap_utf7_encode_local.php'); -require_once(SM_PATH . 'functions/imap_utf7_decode_local.php'); + +/** 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 + * 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 + * 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_special = false, $is_root = false, $is_inbox = false, $is_sent = false, - $is_trash = false, $is_draft = false, $mbxs = array(), - $unseen = false, $total = false; - - function addMbx($mbx, $delimiter, $start, $specialfirst) { - $ary = explode($delimiter, $mbx->mailboxname_full); - $mbx_parent = &$this; - for ($i=$start; $i < (count($ary) -1); $i++) { - $mbx_childs = &$mbx_parent->mbxs; - $found = false; - if ($mbx_childs) { - foreach ($mbx_childs as $key => $parent) { - if ($parent->mailboxname_sub == $ary[$i]) { - $mbx_parent = &$mbx_parent->mbxs[$key]; - $found = true; - } - } - } - if (!$found) { - $no_select_mbx = new mailboxes(); - if (isset($mbx_parent->mailboxname_full) && $mbx_parent->mailboxname_full != '') { - $no_select_mbx->mailboxname_full = $mbx_parent->mailboxname_full.$delimiter.$ary[$i]; - } else { - $no_select_mbx->mailboxname_full = $ary[$i]; - } - $no_select_mbx->mailboxname_sub = $ary[$i]; - $no_select_mbx->is_noselect = true; - $mbx_parent->mbxs[] = $no_select_mbx; - $i--; - } - - } - $mbx_parent->mbxs[] = $mbx; - if ($mbx->is_special && $specialfirst) { - usort($mbx_parent->mbxs, 'sortSpecialMbx'); - } - - } + 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; + + function addMbx($mbx, $delimiter, $start, $specialfirst) { + $ary = explode($delimiter, $mbx->mailboxname_full); + $mbx_parent =& $this; + for ($i = $start, $c = count($ary)-1; $i < $c; $i++) { + $mbx_childs =& $mbx_parent->mbxs; + $found = false; + if ($mbx_childs) { + foreach ($mbx_childs as $key => $parent) { + if ($parent->mailboxname_sub == $ary[$i]) { + $mbx_parent =& $mbx_parent->mbxs[$key]; + $found = true; + break; + } + } + } + if (!$found) { + $no_select_mbx = new mailboxes(); + if (isset($mbx_parent->mailboxname_full) && $mbx_parent->mailboxname_full != '') { + $no_select_mbx->mailboxname_full = $mbx_parent->mailboxname_full.$delimiter.$ary[$i]; + } else { + $no_select_mbx->mailboxname_full = $ary[$i]; + } + $no_select_mbx->mailboxname_sub = $ary[$i]; + $no_select_mbx->is_noselect = true; + $mbx_parent->mbxs[] = $no_select_mbx; + $i--; + } + } + $mbx_parent->mbxs[] = $mbx; + if ($mbx->is_special && $specialfirst) { + usort($mbx_parent->mbxs, 'sortSpecialMbx'); + } + } } +/** + * 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; + $acmp = '0'. $a->mailboxname_full; } else if ($a->is_special) { - $acmp = '1'. $a->mailboxname_full; + $acmp = '1'. $a->mailboxname_full; } else { - $acmp = '2' . $a->mailboxname_full; - } + $acmp = '2' . $a->mailboxname_full; + } if ($b->is_inbox) { - $bcmp = '0'. $b->mailboxname_full; + $bcmp = '0'. $b->mailboxname_full; }else if ($b->is_special) { - $bcmp = '1' . $b->mailboxname_full; + $bcmp = '1' . $b->mailboxname_full; } else { - $bcmp = '2' . $b->mailboxname_full; + $bcmp = '2' . $b->mailboxname_full; } - if ($acmp == $bcmp) return 0; - return ($acmp>$bcmp) ? 1: -1; -} + return strnatcasecmp($acmp, $bcmp); +} -function find_mailbox_name ($mailbox) { - if (preg_match('/\*.+\"([^\r\n\"]*)\"[\s\r\n]*$/', $mailbox, $regs)) - return $regs[1]; - if (ereg(" *\"([^\r\n\"]*)\"[ \r\n]*$", $mailbox, $regs)) +/** + * @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 + * (larger then fgets buffer) + */ + for ($i = 0, $iCnt=count($ary); $i < $iCnt; $i++) { + if (isset($ary[$i + 1]) && substr($ary[$i], -3) == "}\r\n") { + if (ereg("^(\\* [A-Z]+.*)\\{[0-9]+\\}([ \n\r\t]*)$", + $ary[$i], $regs)) { + $ary[$i] = $regs[1] . '"' . addslashes(trim($ary[$i+1])) . '"' . $regs[2]; + array_splice($ary, $i+1, 2); + } + } + } + /* remove duplicates and ensure array is contiguous */ + return array_values(array_unique($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) { + 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)); return $regs[1]; - ereg(" *([^ \r\n\"]*)[ \r\n]*$",$mailbox,$regs); - return $regs[1]; + } + return ''; } +/** + * 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 \([^\)]*\\Noselect[^\)]*\)/i", $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 == '') { $ret = ''; } else { @@ -108,157 +189,263 @@ function readMailboxParent($haystack, $needle) { return( $ret ); } - -function isBoxBelow( $box2, $box1 ) { - global $delimiter, $folder_prefix, $imap_server_type; - - if ( $imap_server_type == 'uw' ) { - $boxs = $box2; - $i = strpos( $box1, $delimiter, strlen( $folder_prefix ) ); - if ( $i === false ) { - $i = strlen( $box2 ); - } - } else { - $boxs = $box2 . $delimiter; - /* Skip next second delimiter */ - $i = strpos( $box1, $delimiter ); - $i = strpos( $box1, $delimiter, $i + 1 ); - if ( $i === false ) { - $i = strlen( $box2 ); - } else { - $i++; - } +/** + * 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 + * 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; } - return ( substr( $box1, 0, $i ) == substr( $boxs, 0, $i ) ); + return (substr($subbox,0,strlen($parentbox)) == $parentbox); } -/* Defines special mailboxes */ +/** + * 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 ) { - global $trash_folder, $sent_folder, $draft_folder, - $move_to_trash, $move_to_sent, $save_as_draft; - $ret = ( (strtolower($box) == 'inbox') || - ( $move_to_trash && isBoxBelow( $box, $trash_folder ) ) || - ( $move_to_sent && isBoxBelow( $box, $sent_folder )) || - ($save_as_draft && $box == $draft_folder ) ); + isTrashMailbox($box) || isSentMailbox($box) || isDraftMailbox($box) ); if ( !$ret ) { - $ret = do_hook_function( 'special_mailbox', $box ); + $ret = boolean_hook_function('special_mailbox',$box,1); } - return $ret; } -/* Expunges a mailbox */ +/** + * 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; + return $move_to_trash && $trash_folder && + ( $box == $trash_folder || isBoxBelow($box, $trash_folder) ); +} + +/** + * 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; + return $move_to_sent && $sent_folder && + ( $box == $sent_folder || isBoxBelow($box, $sent_folder) ); +} + +/** + * 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; + return $save_as_draft && + ( $box == $draft_folder || isBoxBelow($box, $draft_folder) ); +} + +/** + * 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; + if (is_array($id)) { + $id = sqimap_message_list_squisher($id); + } + $id = ' '.$id; + $uid = TRUE; } else { - $uid = false; + $uid = false; } $read = sqimap_run_command($imap_stream, 'EXPUNGE'.$id, $handle_errors, $response, $message, $uid); $cnt = 0; - - if ( is_array( $read ) ) { + + if (is_array($read)) { foreach ($read as $r) { - if (preg_match('/^\*\s[0-9]+\sEXPUNGE/AUi',$r,$regs)) { - $cnt++; - } + if (preg_match('/^\*\s[0-9]+\sEXPUNGE/AUi',$r,$regs)) { + $cnt++; + } } } - return $cnt; + return $cnt; } -/* Checks whether or not the specified mailbox exists */ +/** + * 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)) { + if (!isset($mailbox) || empty($mailbox)) { return false; } - $mbx = sqimap_run_command($imap_stream, "LIST \"\" \"$mailbox\"", + $mbx = sqimap_run_command($imap_stream, 'LIST "" ' . sqimap_encode_mailbox_name($mailbox), true, $response, $message); return isset($mbx[0]); } -/* Selects a 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' ) { + if ($mailbox == 'None') { return; } - $read = sqimap_run_command($imap_stream, "SELECT \"$mailbox\"", + $read = sqimap_run_command($imap_stream, 'SELECT ' . sqimap_encode_mailbox_name($mailbox), true, $response, $message); $result = array(); - for ($i=0; $i= 2.0 rename is recursive, so don't check for errors here */ if ($imap_server_type == 'cyrus') { - $cmd = 'RENAME "' . quoteIMAP($box[$p]) . '" "' . quoteIMAP($new_sub) . '"'; - $data = sqimap_run_command($imap_stream, $cmd, true, + $cmd = 'RENAME "' . $box[$p] . '" "' . $new_sub . '"'; + $data = sqimap_run_command($imap_stream, $cmd, false, $response, $message); } - sqimap_unsubscribe($imap_stream, $box[$p]); - $oldpref = getPref($data_dir, $username, "thread_".$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", + $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]); + 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)); } } } } -/* - * Formats a mailbox into 4 parts for the $boxesall array - * - * The four parts are: +/** + * Formats a mailbox into parts for the $boxesall array * - * 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 + * 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. + * @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; /* Process each folder line */ - for ($g=0; $g < count($line); $g++) { - + for ($g = 0, $cnt = count($line); $g < $cnt; ++$g) { /* Store the raw IMAP reply */ if (isset($line[$g])) { - $boxesall[$g]["raw"] = $line[$g]; - } - else { - $boxesall[$g]["raw"] = ''; + $boxesall[$g]['raw'] = $line[$g]; + } else { + $boxesall[$g]['raw'] = ''; } - /* Count number of delimiters ($delimiter) in folder name */ - $mailbox = trim($line_lsub[$g]); - $dm_count = substr_count($mailbox, $delimiter); + $mailbox = /*trim(*/$line_lsub[$g]/*)*/; + $dm_count = substr_count($mailbox, $delimiter); if (substr($mailbox, -1) == $delimiter) { /* If name ends in delimiter, decrement count by one */ $dm_count--; @@ -350,18 +565,16 @@ function sqimap_mailbox_parse ($line, $line_lsub) { $parentfolder = readMailboxParent($mailbox, $delimiter); if ( (strtolower(substr($mailbox, 0, 5)) == "inbox") || (substr($mailbox, 0, strlen($folder_prefix)) == $folder_prefix) || - ( isset($boxesallbyname[$parentfolder]) && - (strlen($parentfolder) > 0) ) ) { - $indent = $dm_count - ( substr_count($folder_prefix, $delimiter)); + (isset($boxesallbyname[$parentfolder]) && + (strlen($parentfolder) > 0) ) ) { + $indent = $dm_count - (substr_count($folder_prefix, $delimiter)); if ($indent > 0) { - $boxesall[$g]['formatted'] = str_repeat('  ', $indent); - } - else { + $boxesall[$g]['formatted'] = str_repeat('  ', $indent); + } else { $boxesall[$g]['formatted'] = ''; } $boxesall[$g]['formatted'] .= imap_utf7_decode_local(readShortMailboxName($mailbox, $delimiter)); - } - else { + } else { $boxesall[$g]['formatted'] = imap_utf7_decode_local($mailbox); } @@ -379,189 +592,152 @@ 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]))); if ($flags) { $boxesall[$g]['flags'] = explode(' ', $flags); } } } - return $boxesall; } -/* - * Sorting function used to sort mailbox names. - * + Original patch from dave_michmerhuizen@yahoo.com - * + Allows case insensitivity when sorting folders - * + Takes care of the delimiter being sorted to the end, causing - * subfolders to be listed in below folders that are prefixed - * with their parent folders name. - * - * For example: INBOX.foo, INBOX.foobar, and INBOX.foo.bar - * Without special sort function: foobar between foo and foo.bar - * With special sort function: foobar AFTER foo and foo.bar :) - */ -function user_strcasecmp($a, $b) { - global $delimiter; - - return strnatcasecmp($a, $b); - - /* Calculate the length of some strings. */ - $a_length = strlen($a); - $b_length = strlen($b); - $min_length = min($a_length, $b_length); - $delimiter_length = strlen($delimiter); - - /* Set the initial result value. */ - $result = 0; - /* Check the strings... */ - for ($c = 0; $c < $min_length; ++$c) { - $a_del = substr($a, $c, $delimiter_length); - $b_del = substr($b, $c, $delimiter_length); - - if (($a_del == $delimiter) && ($b_del == $delimiter)) { - $result = 0; - } else if (($a_del == $delimiter) && ($b_del != $delimiter)) { - $result = -1; - } else if (($a_del != $delimiter) && ($b_del == $delimiter)) { - $result = 1; - } else { - $result = strcasecmp($a{$c}, $b{$c}); - } - - if ($result != 0) { - break; - } - } - - /* If one string is a prefix of the other... */ - if ($result == 0) { - if ($a_length < $b_length) { - $result = -1; - } else if ($a_length > $b_length) { - $result = 1; - } - } - - return $result; -} - -/* +/** * 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). + * @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 ) { +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 = ''; + 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_OFF); - - if ( $boxes == 0 ) { + if ($boxes == 0) { $boxes = sqimap_mailbox_list($imap_stream); - } + } + foreach ($boxes as $boxes_part) { - if (!in_array('noselect', $boxes_part['flags'])) { + if ($flag == NULL || (is_array($boxes_part['flags']) + && !in_array($flag, $boxes_part['flags']))) { $box = $boxes_part['unformatted']; - $lowerbox = strtolower($box); - if ( $folder_skip != 0 && in_array($lowerbox, $folder_skip) ) { + if ($folder_skip != 0 && in_array($box, $folder_skip) ) { continue; } - if ($lowerbox == 'inbox'){ + $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 if ( $shorten_box_names == 2 ) { /* delimited, style = 2 */ - $box2 = str_replace('  ', '. ', $boxes_part['formatted']); - } else if ( $shorten_box_names == 1 ) { /* indent, style = 1 */ - $box2 = $boxes_part['formatted']; - } else { /* default, long names, style = 0 */ - $box2 = str_replace(' ', ' ', imap_utf7_decode_local($boxes_part['unformatted-disp'])); + } else { + switch ($shorten_box_names) + { + case 2: /* delimited, style = 2 */ + $box2 = str_replace('&nbsp;&nbsp;', '. ', htmlspecialchars($boxes_part['formatted'])); + break; + case 1: /* indent, style = 1 */ + $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"; + $mbox_options .= '' . "\n"; } else { - $mbox_options .= '' . "\n"; + $mbox_options .= '' . "\n"; } } } return $mbox_options; } -/* - * 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'); - require_once(SM_PATH . 'functions/array.php'); - if ($noselect_fix_enable) { - $lsub_args = "LSUB \"$folder_prefix\" \"*%\""; - } - else { - $lsub_args = "LSUB \"$folder_prefix\" \"*\""; - } + if (!$show_only_subscribed_folders) { + $lsub = 'LIST'; + } elseif ($listsubscribed) { + $lsub = 'LIST (SUBSCRIBED)'; + } else { + $lsub = 'LSUB'; + } + + 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); - - - /* - * Section about removing the last element was removed - * We don't return "* OK" anymore from sqimap_read_data - */ + $lsub_ary = compact_mailboxes_response($lsub_ary); $sorted_lsub_ary = array(); - for ($i=0;$i < count($lsub_ary); $i++) { - /* - * Workaround for EIMS - * Doesn't work if the mailbox name is multiple lines - */ - if (isset($lsub_ary[$i + 1]) && - ereg("^(\\* [A-Z]+.*)\\{[0-9]+\\}([ \n\r\t]*)$", - $lsub_ary[$i], $regs)) { - $i ++; - $lsub_ary[$i] = $regs[1] . '"' . addslashes(trim($lsub_ary[$i])) . '"' . $regs[2]; - } + 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 (strtoupper($temp_mailbox_name) == 'INBOX') { + if (!$inbox_subscribed && strtoupper($temp_mailbox_name) == 'INBOX') { $inbox_subscribed = true; } } - $new_ary = array(); - for ($i=0; $i < count($sorted_lsub_ary); $i++) { - if (!in_array($sorted_lsub_ary[$i], $new_ary)) { - $new_ary[] = $sorted_lsub_ary[$i]; - } - } - $sorted_lsub_ary = $new_ary; + + /* natural sort mailboxes */ if (isset($sorted_lsub_ary)) { - usort($sorted_lsub_ary, 'user_strcasecmp'); + usort($sorted_lsub_ary, 'strnatcasecmp'); } - $sorted_list_ary = $sorted_lsub_ary; - /* LIST array */ -// $sorted_list_ary = array(); -// for ($i=0; $i < count($sorted_lsub_ary); $i++) { - if (false) { + /* + * 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(); + // 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); } @@ -569,48 +745,26 @@ function sqimap_mailbox_list($imap_stream) { $mbx = $sorted_lsub_ary[$i]; } - $read = sqimap_run_command ($imap_stream, "LIST \"\" \"$mbx\"", + $read = sqimap_run_command ($imap_stream, 'LIST "" ' . sqimap_encode_mailbox_name($mbx), true, $response, $message); - /* Another workaround for EIMS */ - if (isset($read[1]) && - ereg("^(\\* [A-Z]+.*)\\{[0-9]+\\}([ \n\r\t]*)$", - $read[0], $regs)) { - $read[0] = $regs[1] . '"' . addslashes(trim($read[1])) . '"' . $regs[2]; - } - if (isset($sorted_list_ary[$i])) { - $sorted_list_ary[$i] = ''; - } + $read = compact_mailboxes_response($read); if (isset($read[0])) { $sorted_list_ary[$i] = $read[0]; - } - else { + } else { $sorted_list_ary[$i] = ''; } - - if (isset($sorted_list_ary[$i]) && - strtoupper(find_mailbox_name($sorted_list_ary[$i])) == 'INBOX') { - $inbox_in_list = true; - } - } -// $inbox_in_list = true; + } + // } /* * Just in case they're not subscribed to their inbox, * we'll get it for them anyway */ - if (!$inbox_subscribed) {// || !$inbox_in_list) { - $inbox_ary = sqimap_run_command ($imap_stream, "LIST \"\" \"INBOX\"", + if (!$inbox_subscribed) { + $inbox_ary = sqimap_run_command ($imap_stream, 'LIST "" "INBOX"', true, $response, $message); - /* Another workaround for EIMS */ - if (isset($inbox_ary[1]) && - ereg("^(\\* [A-Z]+.*)\\{[0-9]+\\}([ \n\r\t]*)$", - $inbox_ary[0], $regs)) { - $inbox_ary[0] = $regs[1] . '"' . addslashes(trim($inbox_ary[1])) . - '"' . $regs[2]; - } - - $sorted_list_ary[] = $inbox_ary[0]; + $sorted_list_ary[] = implode('',compact_mailboxes_response($inbox_ary)); $sorted_lsub_ary[] = find_mailbox_name($inbox_ary[0]); } @@ -620,326 +774,458 @@ function sqimap_mailbox_list($imap_stream) { $boxesnew = $used = array(); /* Find INBOX */ - foreach ( $boxesall as $k => $box ) { - if ( strtolower($box['unformatted']) == 'inbox') { - $boxesnew[] = $box; + $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; - } else { - $used[$k] = false; + break; } } /* List special folders and their subfolders, if requested. */ if ($list_special_folders_first) { - foreach ( $boxesall as $k => $box ) { - if ( !$used[$k] && isSpecialMailbox( $box['unformatted'] ) ) { - $boxesnew[] = $box; - $used[$k] = true; - } - $spec_sub = str_replace(' ', '', $box['formatted']); - $spec_sub = preg_replace("/(\*|\[|\]|\(|\)|\?|\+|\{|\}|\^|\\$)/", '\\\\'.'\\1', $spec_sub); - - /* In case of problems with preg - here is a ereg version - if (!$used[$k] && ereg("^$default_folder_prefix(Sent|Drafts|Trash).{1}$spec_sub$", $box['unformatted']) ) { */ - - if (!$used[$k] && preg_match("?^$default_folder_prefix(Sent|Drafts|Trash).{1}$spec_sub$?", $box['unformatted']) ) { - $boxesnew[] = $box; - $used[$k] = true; + for($k = 0; $k < $cnt; ++$k) { + if (!$used[$k] && isSpecialMailbox($boxesall[$k]['unformatted'])) { + $boxesnew[] = $boxesall[$k]; + $used[$k] = true; } } + } + /* 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 */ - foreach ( $boxesall as $k => $box ) { - if ( !$used[$k] ) { - $boxesnew[] = $box; + 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; - require_once(SM_PATH . 'functions/array.php'); + $read_ary = sqimap_run_command($imap_stream,"LIST \"$folder_prefix\" *",true,$response, $message,false); + $read_ary = compact_mailboxes_response($read_ary); - $ssid = sqimap_session_id(); - $lsid = strlen( $ssid ); - fputs ($imap_stream, $ssid . " LIST \"$folder_prefix\" *\r\n"); - $read_ary = sqimap_read_data ($imap_stream, $ssid, true, $response, $message); $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]; - for ($i = 0; $i < count($read_ary); $i++) { - /* Another workaround for EIMS */ - if (isset($read_ary[$i + 1]) && - ereg("^(\\* [A-Z]+.*)\\{[0-9]+\\}([ \n\r\t]*)$", - $read_ary[$i], $regs)) { - $i ++; - $read_ary[$i] = $regs[1] . '"' . addslashes(trim($read_ary[$i])) . '"' . $regs[2]; - } - if (substr($read_ary[$i], 0, $lsid) != $ssid ) { - /* Store the raw IMAP reply */ - $boxes[$g]['raw'] = $read_ary[$i]; - - /* 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--; - } - - /* 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); - } - else { - $boxes[$g]['formatted'] = ''; - } - $boxes[$g]['formatted'] .= imap_utf7_decode_local(readShortMailboxName($mailbox, $delimiter)); - } - else { - $boxes[$g]['formatted'] = imap_utf7_decode_local($mailbox); - } - - $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]; - -// $read_mlbx = sqimap_run_command ($imap_stream, "LIST \"\" \"$mailbox\"", -// true, $response, $message); - - /* Another workaround for EIMS */ -// if (isset($read_mlbx[1]) && -// ereg("^(\\* [A-Z]+.*)\\{[0-9]+\\}([ \n\r\t]*)$", $read_mlbx[0], $regs)) { -// $read_mlbx[0] = $regs[1] . '"' . addslashes(trim($read_mlbx[1])) . '"' . $regs[2]; -// } -// echo $read_mlbx[0] .' raw 2
'; + /* 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--; + } - $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); + /* 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); } else { - $boxes[$g]['flags'] = array(); + $boxes[$g]['formatted'] = ''; } + $boxes[$g]['formatted'] .= imap_utf7_decode_local(readShortMailboxName($mailbox, $delimiter)); + } else { + $boxes[$g]['formatted'] = imap_utf7_decode_local($mailbox); + } + + $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(); } $g++; } if(is_array($boxes)) { - $boxes = ary_sort ($boxes, 'unformatted', 1); + sort ($boxes); } 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; + $folder_prefix, $delimiter, $trash_folder, $move_to_trash, + $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'); - require_once(SM_PATH . 'functions/array.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); + + /* Check to see if we have an INBOX */ + $has_inbox = false; + + for ($i = 0, $cnt = count($lsub_ary); $i < $cnt; $i++) { + 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) { + // 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 */ + $sorted_lsub_ary = array(); $cnt = count($lsub_ary); - for ($i=0;$i < $cnt; $i++) { - /* - * Workaround for EIMS - * Doesn't work if the mailbox name is multiple lines - */ - if (isset($lsub_ary[$i + 1]) && - ereg("^(\\* [A-Z]+.*)\\{[0-9]+\\}([ \n\r\t]*)$", - $lsub_ary[$i], $regs)) { - $i ++; - $lsub_ary[$i] = $regs[1] . '"' . addslashes(trim($lsub_ary[$i])) . '"' . $regs[2]; - } + for ($i = 0; $i < $cnt; $i++) { + $mbx = find_mailbox_name($lsub_ary[$i]); -// if (preg_match("/^\*\s+LSUB\s+\((.*)\)\s+\"(.*)\"\s+\"?(.+(?=\")|.+).*$/",$lsub_ary[$i],$regs)) { -// $flag = $regs[1]; -// $mbx = trim($regs[3]); -// $sorted_lsub_ary[] = array ('mbx' => $mbx, 'flag' => $flag); -// } - $mbx = find_mailbox_name($lsub_ary[$i]); - $noselect = check_is_noselect($lsub_ary[$i]); - if (substr($mbx, -1) == $delimiter) { - $mbx = substr($mbx, 0, strlen($mbx) - 1); - } - $sorted_lsub_ary[] = array ('mbx' => $mbx, 'noselect' => $noselect); - } - array_multisort($sorted_lsub_ary, SORT_ASC, SORT_REGULAR); - - foreach ($sorted_lsub_ary as $mbx) { - if ($mbx['mbx'] == 'INBOX') { - $inbox_in_list = true; - break; + // 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]); } - } - - /* - * Just in case they're not subscribed to their inbox, - * we'll get it for them anyway - */ - if (!$inbox_in_list) { - $inbox_ary = sqimap_run_command ($imap_stream, "LIST \"\" \"INBOX\"", - true, $response, $message); - /* Another workaround for EIMS */ - if (isset($inbox_ary[1]) && - ereg("^(\\* [A-Z]+.*)\\{[0-9]+\\}([ \n\r\t]*)$", - $inbox_ary[0], $regs)) { - $inbox_ary[0] = $regs[1] . '"' . addslashes(trim($inbox_ary[1])) . - '"' . $regs[2]; + if (substr($mbx, -1) == $delimiter) { + $mbx = substr($mbx, 0, strlen($mbx) - 1); } - $mbx = find_mailbox_name($inbox_ary[0]); - if (substr($mbx, -1) == $delimiter) { - $mbx = substr($mbx, 0, strlen($mbx) - 1); - } - if ( $mbx == 'INBOX') { - $sorted_lsub_ary[] = array ('mbx' => $mbx, 'flag' => ''); - sqimap_subscribe($imap_stream, 'INBOX'); - } - -// if (preg_match("/^\*\s+LIST\s+\((.*)\)\s+\"(.*)\"\s+\"?(.+(?=\")|.+).*$/",$inbox_ary[0],$regs)) { -// $flag = $regs[1]; -// $mbx = trim($regs[3]); -// if (substr($mbx, -1) == $delimiter) { -// $mbx = substr($mbx, 0, strlen($mbx) - 1); -// } -// $sorted_lsub_ary[] = array ('mbx' => $mbx, 'flag' => $flag); -// } - } - $cnt = count($sorted_lsub_ary); - for ($i=0 ; $i < $cnt; $i++) { - $mbx = $sorted_lsub_ary[$i]['mbx']; - if (($unseen_notify == 2 && $mbx == 'INBOX') - || $unseen_notify == 3 - || ($move_to_trash && ($mbx == $trash_folder))) { - $sorted_lsub_ary[$i]['unseen'] = - $sorted_lsub_ary[$i]['noselect'] ? - 0 : sqimap_unseen_messages($imap_stream, $mbx); - if ($unseen_type == 2 || ($move_to_trash - && ($mbx == $trash_folder) )) { - $sorted_lsub_ary[$i]['nummessages'] = - $sorted_lsub_ary[$i]['noselect'] ? - 0 : sqimap_get_num_messages($imap_stream, $mbx); - } - if ($mbx == $trash_folder) { - $sorted_lsub_ary[$i]['nummessages'] = - $sorted_lsub_ary[$i]['noselect'] ? - 0 : sqimap_get_num_messages($imap_stream, $mbx); - } - } - } - $boxesnew = sqimap_fill_mailbox_tree($sorted_lsub_ary); - return $boxesnew; + $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); + 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']); +} -function sqimap_fill_mailbox_tree($mbx_ary, $mbxs=false) { +/** + * @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; + $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(); $mailboxes->is_root = true; - $trail_del = false; - 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; - $start++; - } - $mailboxes->mailboxname_sub = $mailboxes->mailboxname_full; - } else $start = 0; - $cnt = count($mbx_ary); + $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)) { + $mailboxes->mailboxname_full = substr($folder_prefix,0, (strlen($folder_prefix)-1)); + } else { + $mailboxes->mailboxname_full = $folder_prefix; + $start++; + } + $mailboxes->mailboxname_sub = $mailboxes->mailboxname_full; + } else { + $start = 0; + } + + $cnt = count($mbx_ary); for ($i=0; $i < $cnt; $i++) { - if ($mbx_ary[$i]['mbx'] !='' ) { - $mbx = new mailboxes(); - $mailbox = $mbx_ary[$i]['mbx']; - switch ($mailbox) { - case 'INBOX': - $mbx->is_inbox = true; - $mbx->is_special = true; - 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; - } - - if (isset($mbx_ary[$i]['unseen'])) { - $mbx->unseen = $mbx_ary[$i]['unseen']; - } - if (isset($mbx_ary[$i]['nummessages'])) { - $mbx->total = $mbx_ary[$i]['nummessages']; - } - - $mbx->is_noselect = $mbx_ary[$i]['noselect']; - + 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; + } +*/ + $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']; + } + if (isset($mbx_ary[$i]['nummessages'])) { + $mbx->total = $mbx_ary[$i]['nummessages']; + } + + $mbx->is_noselect = $mbx_ary[$i]['noselect']; + $mbx->is_noinferiors = $mbx_ary[$i]['noinferiors']; + $r_del_pos = strrpos($mbx_ary[$i]['mbx'], $delimiter); - if ($r_del_pos) { - $mbx->mailboxname_sub = substr($mbx_ary[$i]['mbx'],$r_del_pos+1); - } else { /* mailbox is root folder */ - $mbx->mailboxname_sub = $mbx_ary[$i]['mbx']; - } - $mbx->mailboxname_full = $mbx_ary[$i]['mbx']; - $mailboxes->addMbx($mbx, $delimiter, $start, $list_special_folders_first); - } - } + if ($r_del_pos) { + $mbx->mailboxname_sub = substr($mbx_ary[$i]['mbx'],$r_del_pos+1); + } else { /* mailbox is root folder */ + $mbx->mailboxname_sub = $mbx_ary[$i]['mbx']; + } + $mbx->mailboxname_full = $mbx_ary[$i]['mbx']; + $mailboxes->addMbx($mbx, $delimiter, $start, $list_special_folders_first); + } + } + sqimap_utf7_decode_mbx_tree($mailboxes); + sqimap_get_status_mbx_tree($imap_stream,$mailboxes); 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]); + } + } +} + +/** + * @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; + if ($mbx_tree->mbxs) { + $iCnt = count($mbx_tree->mbxs); + for ($i=0;$i<$iCnt;++$i) { + 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 = array(); + sqimap_tree_to_ref_array($mbx_tree,$aMbxs); + // remove the root node + array_shift($aMbxs); + + if($unseen_notify == 3) { + $cnt = count($aMbxs); + for($i=0;$i<$cnt;++$i) { + $oMbx =& $aMbxs[$i]; + if (!$oMbx->is_noselect) { + $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)'; + } else { + $query = 'STATUS ' . sqimap_encode_mailbox_name($mbx) . ' (UNSEEN)'; + } + sqimap_prepare_pipelined_query($query,$tag,$aQuery,false); + } else { + $oMbx->unseen = $oMbx->total = false; + $tag = false; + } + $oMbx->tag = $tag; + $aMbxs[$i] =& $oMbx; + } + // execute all the queries at once + $aResponse = sqimap_run_pipelined_command ($imap_stream, $aQuery, false, $aServerResponse, $aServerMessage); + $cnt = count($aMbxs); + for($i=0;$i<$cnt;++$i) { + $oMbx =& $aMbxs[$i]; + $tag = $oMbx->tag; + if ($tag && $aServerResponse[$tag] == 'OK') { + $sResponse = implode('', $aResponse[$tag]); + if (preg_match('/UNSEEN\s+([0-9]+)/i', $sResponse, $regs)) { + $oMbx->unseen = $regs[1]; + } + if (preg_match('/MESSAGES\s+([0-9]+)/i', $sResponse, $regs)) { + $oMbx->total = $regs[1]; + } + } + unset($oMbx->tag); + } + } else if ($unseen_notify == 2) { // INBOX only + $cnt = count($aMbxs); + for($i=0;$i<$cnt;++$i) { + $oMbx =& $aMbxs[$i]; + if (strtoupper($oMbx->mailboxname_full) == 'INBOX' || + ($move_to_trash && $oMbx->mailboxname_full == $trash_folder)) { + 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']; + } else { + $oMbx->unseen = sqimap_unseen_messages($imap_stream,$oMbx->mailboxname_full); + } + $aMbxs[$i] =& $oMbx; + if (!$move_to_trash && $trash_folder) { + break; + } else { + // trash comes after INBOX + if ($oMbx->mailboxname_full == $trash_folder) { + break; + } + } + } + } + } +} -?> +?> \ No newline at end of file