X-Git-Url: https://vcs.fsf.org/?a=blobdiff_plain;f=functions%2Fimap_mailbox.php;h=30ecbd5ff40bc7632f6ccb3f97a3db5104efd799;hb=480feeacdef8ef7790e1b940901135520f4ea39d;hp=892c0f56528e739e4be1c055c90f7e180b2b3841;hpb=cc82c2b7f25b4635b52931b4682371b326cbe853;p=squirrelmail.git diff --git a/functions/imap_mailbox.php b/functions/imap_mailbox.php index 892c0f56..30ecbd5f 100755 --- a/functions/imap_mailbox.php +++ b/functions/imap_mailbox.php @@ -3,30 +3,37 @@ /** * imap_mailbox.php * - * Copyright (c) 1999-2003 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 */ require_once(SM_PATH . 'functions/imap_utf7_local.php'); global $boxesnew; -/* - 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. +/** + * 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 */ class mailboxes { - var $mailboxname_full = '', $mailboxname_sub= '', $is_noselect = false, + 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) { @@ -79,49 +86,17 @@ function sortSpecialMbx($a, $b) { } else { $bcmp = '2' . $b->mailboxname_full; } - if ($acmp == $bcmp) return 0; - return ($acmp > $bcmp) ? 1: -1; -} - -/* -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)) - return $regs[1]; - ereg(" *([^ \r\n\"]*)[ \r\n]*$",$mailbox,$regs); - return $regs[1]; -} -*/ - -// 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) -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]; - } - return ''; -} - -function encode_mailbox_name($what) -{ - if (ereg("[\"\\\r\n]", $what)) - return '{' . strlen($what) . "}\r\n" . $what; /* 4.3 literal form */ - return '"' . $what . '"'; /* 4.3 quoted string form */ + return strnatcasecmp($acmp, $bcmp); } 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; $i < count($ary); $i++) { + 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)) { @@ -134,10 +109,35 @@ function compact_mailboxes_response($ary) 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) + */ +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]; + } + return ''; +} + +/** + * @return bool whether this is a Noselect mailbox. + */ function check_is_noselect ($lsub_line) { return preg_match("/^\* (LSUB|LIST) \([^\)]*\\\\Noselect[^\)]*\)/i", $lsub_line); } +/** + * @return bool whether this is a Noinferiors mailbox. + */ +function check_is_noinferiors ($lsub_line) { + return preg_match("/^\* (LSUB|LIST) \([^\)]*\\\\Noinferiors[^\)]*\)/i", $lsub_line); +} + /** * If $haystack is a full mailbox name, and $needle is the mailbox * separator character, returns the second last part of the full @@ -157,13 +157,13 @@ function readMailboxParent($haystack, $needle) { return( $ret ); } -/** +/** * Check if $subbox is below the specified $parentbox */ 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) ) { @@ -180,47 +180,57 @@ function isBoxBelow( $subbox, $parentbox ) { } } -/* Defines special mailboxes */ +/** + * Defines special mailboxes: given a mailbox name, it checks if this is a + * "special" one: INBOX, Trash, Sent or Draft. + */ function isSpecialMailbox( $box ) { - global $trash_folder, $sent_folder, $draft_folder, - $move_to_trash, $move_to_sent, $save_as_draft; - $ret = ( (strtolower($box) == 'inbox') || 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; } +/** + * @return bool whether this is a Trash folder + */ function isTrashMailbox ($box) { global $trash_folder, $move_to_trash; return $move_to_trash && $trash_folder && ( $box == $trash_folder || isBoxBelow($box, $trash_folder) ); } +/** + * @return bool whether this is a Sent folder + */ function isSentMailbox($box) { global $sent_folder, $move_to_sent; return $move_to_sent && $sent_folder && ( $box == $sent_folder || isBoxBelow($box, $sent_folder) ); } +/** + * @return bool whether this is a Draft folder + */ function isDraftMailbox($box) { global $draft_folder, $save_as_draft; return $save_as_draft && ( $box == $draft_folder || isBoxBelow($box, $draft_folder) ); } -/* Expunges a mailbox */ +/** + * Expunges a mailbox, ie. delete all contents. + */ 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; } @@ -238,25 +248,27 @@ function sqimap_mailbox_expunge ($imap_stream, $mailbox, $handle_errors = true, return $cnt; } -/* Checks whether or not the specified mailbox exists */ +/** + * Checks whether or not the specified mailbox exists + */ function sqimap_mailbox_exists ($imap_stream, $mailbox) { if (!isset($mailbox) || empty($mailbox)) { return false; } - $mbx = sqimap_run_command($imap_stream, 'LIST "" ' . encode_mailbox_name($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 + */ function sqimap_mailbox_select ($imap_stream, $mailbox) { - global $auto_expunge; - if ($mailbox == 'None') { return; } - $read = sqimap_run_command($imap_stream, 'SELECT ' . encode_mailbox_name($mailbox), + $read = sqimap_run_command($imap_stream, 'SELECT ' . sqimap_encode_mailbox_name($mailbox), true, $response, $message); $result = array(); for ($i = 0, $cnt = count($read); $i < $cnt; $i++) { @@ -267,58 +279,77 @@ 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 */ +/** + * Creates a folder. + */ function sqimap_mailbox_create ($imap_stream, $mailbox, $type) { global $delimiter; if (strtolower($type) == 'noselect') { $mailbox .= $delimiter; } - $read_ary = sqimap_run_command($imap_stream, 'CREATE ' . encode_mailbox_name($mailbox), + $read_ary = sqimap_run_command($imap_stream, 'CREATE ' . + sqimap_encode_mailbox_name($mailbox), true, $response, $message); sqimap_subscribe ($imap_stream, $mailbox); } -/* Subscribes to an existing folder */ -function sqimap_subscribe ($imap_stream, $mailbox) { - $read_ary = sqimap_run_command($imap_stream, 'SUBSCRIBE ' . encode_mailbox_name($mailbox), - true, $response, $message); +/** + * Subscribes to an existing folder. + */ +function sqimap_subscribe ($imap_stream, $mailbox,$debug=true) { + $read_ary = sqimap_run_command($imap_stream, 'SUBSCRIBE ' . + sqimap_encode_mailbox_name($mailbox), + $debug, $response, $message); } -/* Unsubscribes to an existing folder */ +/** + * Unsubscribes from an existing folder + */ function sqimap_unsubscribe ($imap_stream, $mailbox) { - $read_ary = sqimap_run_command($imap_stream, 'UNSUBSCRIBE ' . encode_mailbox_name($mailbox), - true, $response, $message); + $read_ary = sqimap_run_command($imap_stream, 'UNSUBSCRIBE ' . + sqimap_encode_mailbox_name($mailbox), + false, $response, $message); } -/* Deletes the given folder */ +/** + * Deletes the given folder + */ function sqimap_mailbox_delete ($imap_stream, $mailbox) { global $data_dir, $username; - $read_ary = sqimap_run_command($imap_stream, 'DELETE ' . encode_mailbox_name($mailbox), - true, $response, $message); sqimap_unsubscribe ($imap_stream, $mailbox); - do_hook_function('rename_or_delete_folder', $args = array($mailbox, 'delete', '')); - removePref($data_dir, $username, "thread_$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"); + } } -/* Determines if the user is subscribed to the folder or not */ +/** + * Determines if the user is subscribed to the folder or not + */ function sqimap_mailbox_is_subscribed($imap_stream, $folder) { $boxesall = sqimap_mailbox_list ($imap_stream); foreach ($boxesall as $ref) { @@ -329,7 +360,9 @@ function sqimap_mailbox_is_subscribed($imap_stream, $folder) { return false; } -/* Renames a mailbox */ +/** + * Renames a mailbox. + */ function sqimap_mailbox_rename( $imap_stream, $old_name, $new_name ) { if ( $old_name != $new_name ) { global $delimiter, $imap_server_type, $data_dir, $username; @@ -342,7 +375,8 @@ function sqimap_mailbox_rename( $imap_stream, $old_name, $new_name ) { } $boxesall = sqimap_mailbox_list($imap_stream); - $cmd = 'RENAME ' . encode_mailbox_name($old_name) . ' ' . encode_mailbox_name($new_name); + $cmd = 'RENAME ' . sqimap_encode_mailbox_name($old_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); @@ -373,10 +407,10 @@ function sqimap_mailbox_rename( $imap_stream, $old_name, $new_name ) { } } -/* - * Formats a mailbox into 4 parts for the $boxesall array +/** + * Formats a mailbox into parts for the $boxesall array * - * The four parts are: + * The parts are: * * raw - Raw LIST/LSUB response from the IMAP server * formatted - nicely formatted folder name @@ -397,7 +431,7 @@ function sqimap_mailbox_parse ($line, $line_lsub) { } /* Count number of delimiters ($delimiter) in folder name */ - $mailbox = trim($line_lsub[$g]); + $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 */ @@ -436,7 +470,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]))); @@ -448,26 +482,10 @@ function sqimap_mailbox_parse ($line, $line_lsub) { 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) { - return strnatcasecmp($a, $b); -} - -/* +/** * 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) @@ -482,7 +500,7 @@ function user_strcasecmp($a, $b) { * \NoSelect and \NoInferiors * $use_long_format - override folder display preference and always show full folder name. */ -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 = ''; @@ -497,64 +515,73 @@ 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(' ', ' ', imap_utf7_decode_local($boxes_part['unformatted-disp'])); + $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. */ -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, @@ -563,6 +590,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') { @@ -572,7 +600,7 @@ function sqimap_mailbox_list($imap_stream) { /* natural sort mailboxes */ if (isset($sorted_lsub_ary)) { - usort($sorted_lsub_ary, 'user_strcasecmp'); + usort($sorted_lsub_ary, 'strnatcasecmp'); } /* * The LSUB response doesn't provide us information about \Noselect @@ -580,33 +608,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 "" ' . encode_mailbox_name($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 "" ' . encode_mailbox_name('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]); } @@ -634,18 +666,18 @@ function sqimap_mailbox_list($imap_stream) { } } } - - /* Rest of the folders */ + /* 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 */ function sqimap_mailbox_list_all($imap_stream) { @@ -655,7 +687,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 */ @@ -715,22 +746,25 @@ function sqimap_mailbox_list_all($imap_stream) { } 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); @@ -738,18 +772,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+(.*)\"?INBOX\"?[^(\/\.)].*$/",$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 () "' . $folder_prefix . '" 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 */ @@ -759,13 +813,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); + $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") { @@ -774,9 +829,9 @@ function sqimap_mailbox_tree($imap_stream) { // prepare an array with queries foreach ($sorted_lsub_ary as $aMbx) { $mbx = stripslashes($aMbx['mbx']); - sqimap_prepare_pipelined_query('LIST "" ' . encode_mailbox_name($mbx), $tag, $aQuery, false); + 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); @@ -784,25 +839,30 @@ function sqimap_mailbox_tree($imap_stream) { if ($aServerResponse[$tag] == 'OK') { $sResponse = implode('', $aResponse[$tag]); $noselect = check_is_noselect($sResponse); - $sorted_lsub_ary[] = array ('mbx' => $mbx, 'noselect' => $noselect); + $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; + usort($sorted_lsub_ary, 'mbxSort'); + $boxestree = sqimap_fill_mailbox_tree($sorted_lsub_ary,false,$imap_stream); + return $boxestree; } } +function mbxSort($a, $b) { + return strnatcasecmp($a['mbx'], $b['mbx']); +} + 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(); @@ -814,7 +874,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; @@ -825,22 +884,34 @@ 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']; - /* @@@ FIXME @@@ + /* 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; @@ -855,24 +926,13 @@ function sqimap_fill_mailbox_tree($mbx_ary, $mbxs=false,$imap_stream) { $mbx->is_special = true; break; } - - /FIXME/ - */ - - if ($mailbox == 'INBOX') { - $mbx->is_inbox = true; - $mbx->is_special = true; - } elseif (stristr($trash_folder , $mailbox)) { - $mbx->is_trash = true; - $mbx->is_special = true; - } elseif (stristr($sent_folder , $mailbox)) { - $mbx->is_sent = true; - $mbx->is_special = true; - } elseif (stristr($draft_folder , $mailbox)) { - $mbx->is_draft = true; - $mbx->is_special = true; - } - +*/ + $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']; @@ -882,6 +942,7 @@ function sqimap_fill_mailbox_tree($mbx_ary, $mbxs=false,$imap_stream) { } $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) { @@ -900,7 +961,7 @@ function sqimap_fill_mailbox_tree($mbx_ary, $mbxs=false,$imap_stream) { } 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); @@ -922,27 +983,11 @@ function sqimap_tree_to_ref_array(&$mbx_tree,&$aMbxs) { sqimap_tree_to_ref_array($mbx_tree->mbxs[$i],$aMbxs); } } -} - - -/* Define preferences for folder settings. */ -/* FIXME, we should load constants.php -unseen_notify -define('SMPREF_UNSEEN_NONE', 1); -define('SMPREF_UNSEEN_INBOX', 2); -define('SMPREF_UNSEEN_ALL', 3); - -define('SMPREF_UNSEEN_SPECIAL', 4); // Only special folders -define('SMPREF_UNSEEN_NORMAL', 5); // Only normal folders - -unseen_type -define('SMPREF_UNSEEN_ONLY', 1); -define('SMPREF_UNSEEN_TOTAL', 2); -*/ +} 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); @@ -955,9 +1000,9 @@ 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 ' . encode_mailbox_name($mbx) . ' (MESSAGES UNSEEN)'; + $query = 'STATUS ' . sqimap_encode_mailbox_name($mbx) . ' (MESSAGES UNSEEN)'; } else { - $query = 'STATUS ' . encode_mailbox_name($mbx) . ' (UNSEEN)'; + $query = 'STATUS ' . sqimap_encode_mailbox_name($mbx) . ' (UNSEEN)'; } sqimap_prepare_pipelined_query($query,$tag,$aQuery,false); } else { @@ -990,7 +1035,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']; @@ -1009,7 +1054,7 @@ function sqimap_get_status_mbx_tree($imap_stream,&$mbx_tree) { } } } - } -} + } +} ?>