X-Git-Url: https://vcs.fsf.org/?p=squirrelmail.git;a=blobdiff_plain;f=functions%2Fimap_mailbox.php;h=b934d89d543492b48247601ede5b00ec23709dbb;hp=5427bbe46eddf3a06d885fcbbd4e9a6fee857395;hb=bac13dd7571f278ce40ad479ab8ed6f0b92112d6;hpb=483f9ef91bef2d0ee064341ec8ac058e73acdb69 diff --git a/functions/imap_mailbox.php b/functions/imap_mailbox.php index 5427bbe4..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, @@ -74,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]; @@ -82,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|LIST) \([^\)]*\\Noselect[^\)]*\)/i", $lsub_line); + return preg_match("/^\* (LSUB|LIST) \([^\)]*\\\\Noselect[^\)]*\)/i", $lsub_line); } /** @@ -192,7 +243,7 @@ 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 "" ' . encode_mailbox_name($mailbox), true, $response, $message); return isset($mbx[0]); } @@ -205,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++) { @@ -240,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', '')); @@ -291,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); @@ -385,9 +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. + // 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); @@ -453,24 +504,24 @@ function sqimap_mailbox_option_list($imap_stream, $show_selected = 0, $folder_sk continue; } $lowerbox = strtolower($box); - // mailboxes are casesensitive => inbox.sent != inbox.Sent - // nevermind, to many dependencies this should be fixed! - + // 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 { - switch ($shorten_box_names) - { - case 2: /* delimited, style = 2 */ + switch ($shorten_box_names) + { + case 2: /* delimited, style = 2 */ $box2 = str_replace('  ', '. ', $boxes_part['formatted']); - break; + break; case 1: /* indent, style = 1 */ $box2 = $boxes_part['formatted']; - break; + break; default: /* default, long names, style = 0 */ $box2 = str_replace(' ', ' ', imap_utf7_decode_local($boxes_part['unformatted-disp'])); - break; - } + break; + } } if ($show_selected != 0 && in_array($lowerbox, $show_selected) ) { $mbox_options .= '' . "\n"; @@ -508,41 +559,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'); } - /* - * 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) { @@ -551,42 +589,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 "" ' . 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 "" ' . encode_mailbox_name('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]); } @@ -597,12 +617,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. */ @@ -612,8 +632,8 @@ function sqimap_mailbox_list($imap_stream) { $boxesnew[] = $boxesall[$k]; $used[$k] = true; } - } - } + } + } /* Rest of the folders */ for($k = 0; $k < $cnt; $k++) { @@ -630,18 +650,14 @@ function sqimap_mailbox_list($imap_stream) { */ function sqimap_mailbox_list_all($imap_stream) { global $list_special_folders_first, $folder_prefix, $delimiter; - $read_ary = sqimap_run_command($imap_stream,"LIST \"$folder_prefix\" *",true,$response, $message,false); + + $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]; - } /* Store the raw IMAP reply */ $boxes[$g]['raw'] = $read_ary[$i]; @@ -709,12 +725,14 @@ function sqimap_mailbox_tree($imap_stream) { $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; @@ -727,38 +745,17 @@ function sqimap_mailbox_tree($imap_stream) { } 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]; - } - } + $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]; - } - $mbx = find_mailbox_name($lsub_ary[$i]); // only do the noselect test if !uw, is checked later. FIX ME see conf.pl setting @@ -770,31 +767,29 @@ function sqimap_mailbox_tree($imap_stream) { } $sorted_lsub_ary[] = array ('mbx' => $mbx, 'noselect' => $noselect); } - // FIX ME this requires a config setting inside conf.pl instead of checking on server type + // 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 = $aMbx['mbx']; - $query = "LIST \"\" \"$mbx\""; - sqimap_prepare_pipelined_query($query,$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); + $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); + $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; @@ -891,11 +886,12 @@ function sqimap_utf7_decode_mbx_tree(&$mbx_tree) { 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) { - $aMbxs[] =& sqimap_tree_to_ref_array($mbx_tree->mbxs[$i],$aMbxs); + sqimap_tree_to_ref_array($mbx_tree->mbxs[$i],$aMbxs); } } } @@ -926,64 +922,66 @@ function sqimap_get_status_mbx_tree($imap_stream,&$mbx_tree) { if($unseen_notify == 3) { $cnt = count($aMbxs); for($i=0;$i<$cnt;++$i) { - $oMbx =& $aMbxs[$i]; - if (!$oMbx->is_noselect) { + $oMbx =& $aMbxs[$i]; + if (!$oMbx->is_noselect) { $mbx = $oMbx->mailboxname_full; - if ($unseen_type == 2) { - $query = "STATUS \"$mbx\" (MESSAGES UNSEEN)"; - } else { - $query = "STATUS \"$mbx\" (UNSEEN)"; - } + 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; + } 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]); + $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); - } + } + } + 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) { - $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; - } - } - } - } - } + $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; + } + } + } + } + } } ?>