X-Git-Url: https://vcs.fsf.org/?p=squirrelmail.git;a=blobdiff_plain;f=functions%2Fimap_mailbox.php;h=a5a6277c7c6a2b28f3d18e021c3e27bcac0af244;hp=5f42748fc14fa5781f6ffb3a9b75b61a06a96081;hb=31a5064d113ed89bf0d593d350b4736fb1d120a7;hpb=a2e66c6d35a0a73d8d9f48af1288a34f83219ec6 diff --git a/functions/imap_mailbox.php b/functions/imap_mailbox.php index 5f42748f..a5a6277c 100755 --- a/functions/imap_mailbox.php +++ b/functions/imap_mailbox.php @@ -3,19 +3,34 @@ /** * imap_mailbox.php * - * Copyright (c) 1999-2003 The SquirrelMail Project Team + * Copyright (c) 1999-2004 The SquirrelMail Project Team * Licensed under the GNU GPL. For full terms see the file COPYING. * * This impliments all functions that manipulate mailboxes * * $Id$ + * @package squirrelmail */ + +/** 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 +*/ + 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(), $unseen = false, $total = false; @@ -70,21 +85,56 @@ function sortSpecialMbx($a, $b) { } else { $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)) +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) + */ +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 ''; } +/** + * @return bool whether this is a Noselect mailbox. + */ function check_is_noselect ($lsub_line) { - return preg_match("/^\* (LSUB|LIST) \([^\)]*\\Noselect[^\)]*\)/i", $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); } /** @@ -129,39 +179,50 @@ 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) { @@ -187,17 +248,73 @@ function sqimap_mailbox_expunge ($imap_stream, $mailbox, $handle_errors = true, return $cnt; } -/* Checks whether or not the specified mailbox exists */ +/** + * 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 + */ function sqimap_mailbox_exists ($imap_stream, $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 + */ function sqimap_mailbox_select ($imap_stream, $mailbox) { global $auto_expunge; @@ -205,7 +322,7 @@ function sqimap_mailbox_select ($imap_stream, $mailbox) { 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, $cnt = count($read); $i < $cnt; $i++) { @@ -233,41 +350,60 @@ function sqimap_mailbox_select ($imap_stream, $mailbox) { 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 \"$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 */ +/** + * Subscribes to an existing folder. + */ function sqimap_subscribe ($imap_stream, $mailbox) { - $read_ary = sqimap_run_command($imap_stream, "SUBSCRIBE \"$mailbox\"", + $read_ary = sqimap_run_command($imap_stream, 'SUBSCRIBE ' . + sqimap_encode_mailbox_name($mailbox), true, $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 \"$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 \"$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) { @@ -278,7 +414,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; @@ -291,7 +429,8 @@ function sqimap_mailbox_rename( $imap_stream, $old_name, $new_name ) { } $boxesall = sqimap_mailbox_list($imap_stream); - $cmd = 'RENAME "' . $old_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); @@ -322,10 +461,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 @@ -346,7 +485,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 */ @@ -385,6 +524,9 @@ 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); @@ -394,23 +536,7 @@ 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 @@ -424,13 +550,14 @@ function user_strcasecmp($a, $b) { * '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. */ 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 { @@ -444,31 +571,41 @@ 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'])) { $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('  ', '. ', $boxes_part['formatted']); + break; + case 1: /* indent, style = 1 */ + $box2 = $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. * See comment on sqimap_mailbox_parse() for info about the returned array. */ @@ -494,41 +631,28 @@ function sqimap_mailbox_list($imap_stream) { /* LSUB array */ $lsub_ary = sqimap_run_command ($imap_stream, $lsub_args, true, $response, $message); + $lsub_ary = compact_mailboxes_response($lsub_ary); $sorted_lsub_ary = array(); for ($i = 0, $cnt = count($lsub_ary);$i < $cnt; $i++) { - /* - * Workaround for mailboxes returned as literal - * Doesn't work if the mailbox name is multiple lines - * (larger then fgets buffer) - */ - if (isset($lsub_ary[$i + 1]) && substr($lsub_ary[$i],-3) == "}\r\n") { - if (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]; - } - } $temp_mailbox_name = find_mailbox_name($lsub_ary[$i]); $sorted_lsub_ary[] = $temp_mailbox_name; if (!$inbox_subscribed && strtoupper($temp_mailbox_name) == 'INBOX') { $inbox_subscribed = true; } } - /* remove duplicates */ - $sorted_lsub_ary = array_unique($sorted_lsub_ary); - /* natural sort mailboxes */ + /* 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 - * mail boxes. The LIST response does, that's why we need to do a LIST - * call to retrieve the flags for the mailbox + /* + * The LSUB response doesn't provide us information about \Noselect + * mail boxes. The LIST response does, that's why we need to do a LIST + * call to retrieve the flags for the mailbox * Note: according RFC2060 an imap server may provide \NoSelect flags in the LSUB response. * in other words, we cannot rely on it. - */ + */ $sorted_list_ary = array(); for ($i=0; $i < count($sorted_lsub_ary); $i++) { if (substr($sorted_lsub_ary[$i], -1) == $delimiter) { @@ -537,42 +661,24 @@ function sqimap_mailbox_list($imap_stream) { else { $mbx = $sorted_lsub_ary[$i]; } - - $read = sqimap_run_command ($imap_stream, "LIST \"\" \"$mbx\"", + $mbx = stripslashes($mbx); + $read = sqimap_run_command ($imap_stream, 'LIST "" ' . sqimap_encode_mailbox_name($mbx), true, $response, $message); - - /* Another workaround for literals */ - - if (isset($read[1]) && substr($read[1],-3) == "}\r\n") { - if (ereg("^(\\* [A-Z]+.*)\\{[0-9]+\\}([ \n\r\t]*)$", - $read[0], $regs)) { - $read[0] = $regs[1] . '"' . addslashes(trim($read[1])) . '"' . $regs[2]; - } - } - + $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); - /* Another workaround for literals */ - if (isset($inbox_ary[1]) && substr($inbox_ary[0],-3) == "}\r\n") { - if (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]); } @@ -583,12 +689,12 @@ function sqimap_mailbox_list($imap_stream) { /* Find INBOX */ $cnt = count($boxesall); - $used = array_pad($used,$cnt,false); + $used = array_pad($used,$cnt,false); for($k = 0; $k < $cnt; ++$k) { if (strtolower($boxesall[$k]['unformatted']) == 'inbox') { $boxesnew[] = $boxesall[$k]; $used[$k] = true; - break; + break; } } /* List special folders and their subfolders, if requested. */ @@ -598,8 +704,8 @@ function sqimap_mailbox_list($imap_stream) { $boxesnew[] = $boxesall[$k]; $used[$k] = true; } - } - } + } + } /* Rest of the folders */ for($k = 0; $k < $cnt; $k++) { @@ -608,90 +714,69 @@ function sqimap_mailbox_list($imap_stream) { } } } + return $boxesnew; } -/* +/** * Returns a list of all folders, subscribed or not */ function sqimap_mailbox_list_all($imap_stream) { global $list_special_folders_first, $folder_prefix, $delimiter; - $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); + $read_ary = sqimap_run_command($imap_stream,"LIST \"$folder_prefix\" *",true,$response, $message,false); + $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++) { - /* 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); + /* Store the raw IMAP reply */ + $boxes[$g]['raw'] = $read_ary[$i]; - /* 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++; } @@ -713,34 +798,44 @@ function sqimap_mailbox_tree($imap_stream) { $inbox_in_list = false; $inbox_subscribed = false; + $noselect = false; + $noinferiors = false; require_once(SM_PATH . 'include/load_prefs.php'); /* LSUB array */ $lsub_ary = sqimap_run_command ($imap_stream, "LSUB \"$folder_prefix\" \"*\"", true, $response, $message); + $lsub_ary = compact_mailboxes_response($lsub_ary); /* Check to see if we have an INBOX */ $has_inbox = false; 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.*\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\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]); + } break; } } if ($has_inbox == false) { - $lsub_ibx = sqimap_run_command( $imap_stream, "LSUB \"\" \"INBOX\"", true, $response, $message ); - if (isset($lsub_ibx[0]) && (preg_match("/^\*\s+LSUB\s+(.*)\"?INBOX\"?[^(\/\.)].*$/",$lsub_ibx[0]))) { - $lsub_ary[] = $lsub_ibx[0]; - } else { - $lsub_ibx = sqimap_run_command( $imap_stream, "LIST \"\" \"INBOX\"", true, $response, $message ); - if (preg_match("/^\*\s+LIST\s+(.*)\"?INBOX\"?[^(\/\.)].*$/",$lsub_ibx[0])) { - sqimap_run_command( $imap_stream, "SUBSCRIBE \"INBOX\"", true, $response, $message ); - $lsub_ibx[0] = str_replace("LIST","LSUB",$lsub_ibx[0]); - $lsub_ary[] = $lsub_ibx[0]; - } + // 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]; } } @@ -748,68 +843,53 @@ function sqimap_mailbox_tree($imap_stream) { * 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]; - } - $mbx = find_mailbox_name($lsub_ary[$i]); - // Force a list for UW as it returns \NoSelect in LIST and not LSUB // - if ($imap_server_type == "uw") { - $tmp_str = sqimap_run_command( $imap_stream , "LIST \"\" \"$mbx\"" , true, $response, $message ); - if (isset($tmp_str[0])) { - $lsub_ary[$i] = $tmp_str[0]; - } + // 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]); } - $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); - - 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))) { - if( $sorted_lsub_ary[$i]['noselect'] ) { - $sorted_lsub_ary[$i]['unseen'] = 0; - } else { - $sorted_lsub_ary[$i]['unseen'] = - sqimap_unseen_messages($imap_stream, $mbx); - } - if (($unseen_type == 2) || - ($move_to_trash && ($mbx == $trash_folder)) || - ($mbx == $trash_folder)) { - if($sorted_lsub_ary[$i]['noselect']) { - $sorted_lsub_ary[$i]['nummessages'] = 0; - } else { - $sorted_lsub_ary[$i]['nummessages'] = - sqimap_get_num_messages($imap_stream, $mbx); - } - } - } + $sorted_lsub_ary[] = array ('mbx' => $mbx, 'noselect' => $noselect, 'noinferiors' => $noinferiors); } - $boxesnew = sqimap_fill_mailbox_tree($sorted_lsub_ary); - return $boxesnew; + // FIX ME this requires a config setting inside conf.pl instead of checking on server type + if ($imap_server_type == "uw") { + $aQuery = array(); + $aTag = array(); + // prepare an array with queries + foreach ($sorted_lsub_ary as $aMbx) { + $mbx = stripslashes($aMbx['mbx']); + sqimap_prepare_pipelined_query('LIST "" ' . sqimap_encode_mailbox_name($mbx), $tag, $aQuery, false); + $aTag[$tag] = $mbx; + } + $sorted_lsub_ary = array(); + // execute all the queries at once + $aResponse = sqimap_run_pipelined_command ($imap_stream, $aQuery, false, $aServerResponse, $aServerMessage); + foreach($aTag as $tag => $mbx) { + if ($aServerResponse[$tag] == 'OK') { + $sResponse = implode('', $aResponse[$tag]); + $noselect = check_is_noselect($sResponse); + $noinferiors = check_is_noinferiors($sResponse); + $sorted_lsub_ary[] = array ('mbx' => $mbx, 'noselect' => $noselect, 'noinferiors' => $noinferiors); + } + } + $cnt = count($sorted_lsub_ary); + } + $sorted_lsub_ary = array_values($sorted_lsub_ary); + array_multisort($sorted_lsub_ary, SORT_ASC, SORT_REGULAR); + $boxesnew = sqimap_fill_mailbox_tree($sorted_lsub_ary,false,$imap_stream); + return $boxesnew; } } - -function sqimap_fill_mailbox_tree($mbx_ary, $mbxs=false) { +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, @@ -843,10 +923,29 @@ function sqimap_fill_mailbox_tree($mbx_ary, $mbxs=false) { 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; @@ -861,7 +960,14 @@ function sqimap_fill_mailbox_tree($mbx_ary, $mbxs=false) { $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']; } @@ -870,6 +976,7 @@ function sqimap_fill_mailbox_tree($mbx_ary, $mbxs=false) { } $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) { @@ -883,17 +990,105 @@ function sqimap_fill_mailbox_tree($mbx_ary, $mbxs=false) { } } sqimap_utf7_decode_mbx_tree($mailboxes); + sqimap_get_status_mbx_tree($imap_stream,$mailboxes); return $mailboxes; } function sqimap_utf7_decode_mbx_tree(&$mbx_tree) { - $mbx_tree->mailboxname_sub=imap_utf7_decode_local($mbx_tree->mailboxname_sub); + 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]); + $mbxs_tree->mbxs[$i] = sqimap_utf7_decode_mbx_tree($mbx_tree->mbxs[$i]); } } -} +} + + +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); + } + } +} + +function sqimap_get_status_mbx_tree($imap_stream,&$mbx_tree) { + global $unseen_notify, $unseen_type, $trash_folder,$move_to_trash; + $aMbxs = $aQuery = $aTag = 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; + } + } + } + } + } +} ?>