X-Git-Url: https://vcs.fsf.org/?p=squirrelmail.git;a=blobdiff_plain;f=functions%2Fimap_mailbox.php;h=b934d89d543492b48247601ede5b00ec23709dbb;hp=8553beca3fbf101956e0a3e2ce64920470027f64;hb=bac13dd7571f278ce40ad479ab8ed6f0b92112d6;hpb=4d5537d1f0a7800248d353f8e1776c36864ada6d diff --git a/functions/imap_mailbox.php b/functions/imap_mailbox.php index 8553beca..b934d89d 100755 --- a/functions/imap_mailbox.php +++ b/functions/imap_mailbox.php @@ -14,6 +14,15 @@ 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. +*/ + class mailboxes { var $mailboxname_full = '', $mailboxname_sub= '', $is_noselect = false, $is_special = false, $is_root = false, $is_inbox = false, $is_sent = false, @@ -22,15 +31,16 @@ class mailboxes { function addMbx($mbx, $delimiter, $start, $specialfirst) { $ary = explode($delimiter, $mbx->mailboxname_full); - $mbx_parent = &$this; + $mbx_parent =& $this; for ($i = $start, $c = count($ary)-1; $i < $c; $i++) { - $mbx_childs = &$mbx_parent->mbxs; + $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]; + $mbx_parent =& $mbx_parent->mbxs[$key]; $found = true; + break; } } } @@ -73,6 +83,7 @@ function sortSpecialMbx($a, $b) { return ($acmp > $bcmp) ? 1: -1; } +/* function find_mailbox_name ($mailbox) { if (preg_match('/\*.+\"([^\r\n\"]*)\"[\s\r\n]*$/', $mailbox, $regs)) return $regs[1]; @@ -81,9 +92,50 @@ function find_mailbox_name ($mailbox) { 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 */ +} + +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; $i < count($ary); $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)); +} function check_is_noselect ($lsub_line) { - return preg_match("/^\* LSUB \([^\)]*\\Noselect[^\)]*\)/i", $lsub_line); + return preg_match("/^\* (LSUB|LIST) \([^\)]*\\\\Noselect[^\)]*\)/i", $lsub_line); } /** @@ -105,30 +157,27 @@ 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 { - if (substr($box2,0,strlen($box1)) == $box1) { - return true; - } - $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++; - } - } - return ( substr( $box1, 0, $i ) == substr( $boxs, 0, $i ) ); +/** + * Check if $subbox is below the specified $parentbox + */ +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; + } + if (substr($subbox,0,strlen($parentbox)) == $parentbox) { + return true; + } else { + return false; + } } /* Defines special mailboxes */ @@ -137,9 +186,7 @@ function isSpecialMailbox( $box ) { $move_to_trash, $move_to_sent, $save_as_draft; $ret = ( (strtolower($box) == 'inbox') || - ( $move_to_trash && $trash_folder && isBoxBelow( $box, $trash_folder )) || - ( $move_to_sent && $sent_folder && 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 ); @@ -147,6 +194,24 @@ function isSpecialMailbox( $box ) { return $ret; } +function isTrashMailbox ($box) { + global $trash_folder, $move_to_trash; + return $move_to_trash && $trash_folder && + ( $box == $trash_folder || isBoxBelow($box, $trash_folder) ); +} + +function isSentMailbox($box) { + global $sent_folder, $move_to_sent; + return $move_to_sent && $sent_folder && + ( $box == $sent_folder || isBoxBelow($box, $sent_folder) ); +} + +function isDraftMailbox($box) { + global $draft_folder, $save_as_draft; + return $save_as_draft && + ( $box == $draft_folder || isBoxBelow($box, $draft_folder) ); +} + /* Expunges a mailbox */ function sqimap_mailbox_expunge ($imap_stream, $mailbox, $handle_errors = true, $id='') { global $uid_support; @@ -175,10 +240,10 @@ function sqimap_mailbox_expunge ($imap_stream, $mailbox, $handle_errors = true, /* Checks whether or not the specified mailbox exists */ 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 "" ' . encode_mailbox_name($mailbox), true, $response, $message); return isset($mbx[0]); } @@ -191,7 +256,7 @@ function sqimap_mailbox_select ($imap_stream, $mailbox) { return; } - $read = sqimap_run_command($imap_stream, "SELECT \"$mailbox\"", + $read = sqimap_run_command($imap_stream, 'SELECT ' . encode_mailbox_name($mailbox), true, $response, $message); $result = array(); for ($i = 0, $cnt = count($read); $i < $cnt; $i++) { @@ -226,27 +291,27 @@ function sqimap_mailbox_create ($imap_stream, $mailbox, $type) { $mailbox .= $delimiter; } - $read_ary = sqimap_run_command($imap_stream, "CREATE \"$mailbox\"", + $read_ary = sqimap_run_command($imap_stream, 'CREATE ' . 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 \"$mailbox\"", + $read_ary = sqimap_run_command($imap_stream, 'SUBSCRIBE ' . encode_mailbox_name($mailbox), true, $response, $message); } /* Unsubscribes to an existing folder */ function sqimap_unsubscribe ($imap_stream, $mailbox) { - $read_ary = sqimap_run_command($imap_stream, "UNSUBSCRIBE \"$mailbox\"", + $read_ary = sqimap_run_command($imap_stream, 'UNSUBSCRIBE ' . encode_mailbox_name($mailbox), true, $response, $message); } /* Deletes the given folder */ function sqimap_mailbox_delete ($imap_stream, $mailbox) { global $data_dir, $username; - $read_ary = sqimap_run_command($imap_stream, "DELETE \"$mailbox\"", + $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', '')); @@ -277,7 +342,7 @@ function sqimap_mailbox_rename( $imap_stream, $old_name, $new_name ) { } $boxesall = sqimap_mailbox_list($imap_stream); - $cmd = 'RENAME "' . $old_name . '" "' . $new_name . '"'; + $cmd = 'RENAME ' . encode_mailbox_name($old_name) . ' ' . 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); @@ -323,7 +388,7 @@ function sqimap_mailbox_parse ($line, $line_lsub) { global $folder_prefix, $delimiter; /* Process each folder line */ - for ($g = 0, $cnt = count($line); $g < $cnt; $g++) { + for ($g = 0, $cnt = count($line); $g < $cnt; ++$g) { /* Store the raw IMAP reply */ if (isset($line[$g])) { $boxesall[$g]['raw'] = $line[$g]; @@ -371,6 +436,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); @@ -393,48 +461,7 @@ function sqimap_mailbox_parse ($line, $line_lsub) { * 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; } /* @@ -447,32 +474,54 @@ function user_strcasecmp($a, $b) { * $folder_skip - array of folders to keep out of option list (compared in lower) * $boxes - list of already fetched boxes (for places like folder panel, where * you know these options will be shown 3 times in a row.. (most often unset). + * $flag - flag to check for in mailbox flags, used to filter out mailboxes. + * 'noselect' by default to remove unselectable mailboxes. + * 'noinferiors' used to filter out folders that can not contain subfolders. + * NULL to avoid flag check entirely. + * NOTE: noselect and noiferiors are used internally. The IMAP representation is + * \NoSelect and \NoInferiors + * $use_long_format - override folder display preference and always show full folder name. */ -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 = ''; - - $shorten_box_names = getPref($data_dir, $username, 'mailbox_select_style', SMPREF_OFF); + if ( $use_long_format ) { + $shorten_box_names = 0; + } else { + $shorten_box_names = getPref($data_dir, $username, 'mailbox_select_style', SMPREF_OFF); + } if ($boxes == 0) { $boxes = sqimap_mailbox_list($imap_stream); } + foreach ($boxes as $boxes_part) { - if (!in_array('noselect', $boxes_part['flags'])) { + 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(' ', ' ', imap_utf7_decode_local($boxes_part['unformatted-disp'])); + break; + } } if ($show_selected != 0 && in_array($lowerbox, $show_selected) ) { $mbox_options .= '' . "\n"; @@ -510,98 +559,54 @@ function sqimap_mailbox_list($imap_stream) { /* 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, $cnt = count($lsub_ary);$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]; - } $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, $cnt = count($sorted_lsub_ary); $i < $cnt; $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'); } - $sorted_list_ary = $sorted_lsub_ary; - /* LIST array */ -/* $sorted_list_ary = array(); + /* + * 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 (false) { 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]; } - - $read = sqimap_run_command ($imap_stream, "LIST \"\" \"$mbx\"", + $mbx = stripslashes($mbx); + $read = sqimap_run_command ($imap_stream, 'LIST "" ' . 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 "" ' . encode_mailbox_name('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]); } @@ -612,36 +617,24 @@ function sqimap_mailbox_list($imap_stream) { /* Find INBOX */ $cnt = count($boxesall); - for($k = 0; $k < $cnt; $k++) { + $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) { - for($k = 0; $k < $cnt; $k++) { + for($k = 0; $k < $cnt; ++$k) { if (!$used[$k] && isSpecialMailbox($boxesall[$k]['unformatted'])) { $boxesnew[] = $boxesall[$k]; $used[$k] = true; } - $spec_sub = str_replace(' ', '', $boxesall[$k]['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']) ) { - */ - $match = "?^$default_folder_prefix(Sent|Drafts|Trash).{1}$spec_sub$?"; - if (!$used[$k] && preg_match($match, $boxesall[$k]['unformatted']) ) { - $boxesnew[] = $boxesall[$k]; - $used[$k] = true; - } } - } + /* Rest of the folders */ for($k = 0; $k < $cnt; $k++) { if (!$used[$k]) { @@ -658,81 +651,59 @@ function sqimap_mailbox_list($imap_stream) { 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--; - } + /* Store the raw IMAP reply */ + $boxes[$g]['raw'] = $read_ary[$i]; - /* 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); - } + /* 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--; + } - $boxes[$g]['unformatted-dm'] = $mailbox; - if (substr($mailbox, -1) == $delimiter) { - $mailbox = substr($mailbox, 0, strlen($mailbox) - 1); + /* 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]['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]; + $boxes[$g]['formatted'] .= imap_utf7_decode_local(readShortMailboxName($mailbox, $delimiter)); + } else { + $boxes[$g]['formatted'] = imap_utf7_decode_local($mailbox); + } -// $read_mlbx = sqimap_run_command ($imap_stream, "LIST \"\" \"$mailbox\"", -// true, $response, $message); + $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); - /* 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
'; + $boxes[$g]['id'] = $g; - $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(); - } + /* 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++; } @@ -748,128 +719,88 @@ function sqimap_mailbox_tree($imap_stream) { if (!isset($boxesnew)) { 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; $inbox_in_list = false; $inbox_subscribed = false; + $noselect = 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; + break; + } + } + + if ($has_inbox == false) { + $lsub_ary[] = '* LSUB () INBOX'; + } /* * 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]; - } - - /* - 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); - - for($i = 0; $i < $cnt; $i++) { - if ($sorted_lsub_ary[$i]['mbx'] == 'INBOX') { - $inbox_in_list = true; - break; - } - } - /* - * 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]; + // 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]); } - $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'); - $cnt++; - } - - /* - 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); - } - */ - } - 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); } - $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 "" ' . 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); + $sorted_lsub_ary[] = array ('mbx' => $mbx, 'noselect' => $noselect); + } + } + $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, - $delimiter; + $delimiter, $imap_server_type; $special_folders = array ('INBOX', $sent_folder, $draft_folder, $trash_folder); @@ -877,7 +808,10 @@ function sqimap_fill_mailbox_tree($mbx_ary, $mbxs=false) { $mailboxes= new mailboxes(); $mailboxes->is_root = true; $trail_del = false; - if (isset($folder_prefix) && $folder_prefix != '') { + $start = 0; + + + if (isset($folder_prefix) && ($folder_prefix != '')) { $start = substr_count($folder_prefix,$delimiter); if (strrpos($folder_prefix, $delimiter) == (strlen($folder_prefix)-1)) { $trail_del = true; @@ -890,6 +824,7 @@ function sqimap_fill_mailbox_tree($mbx_ary, $mbxs=false) { } else { $start = 0; } + $cnt = count($mbx_ary); for ($i=0; $i < $cnt; $i++) { if ($mbx_ary[$i]['mbx'] !='' ) { @@ -930,11 +865,123 @@ function sqimap_fill_mailbox_tree($mbx_ary, $mbxs=false) { $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; } +function sqimap_utf7_decode_mbx_tree(&$mbx_tree) { + $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]); + } + } +} + + +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); + } + } +} + + +/* 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(); + 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 ' . encode_mailbox_name($mbx) . ' (MESSAGES UNSEEN)'; + } else { + $query = 'STATUS ' . 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; + } + } + } + } + } +} + ?>