X-Git-Url: https://vcs.fsf.org/?a=blobdiff_plain;f=functions%2Fimap_mailbox.php;h=3be48cdd436964c73a3e8a0e0a65db1df2fdb8dd;hb=c957afd1e88453c75ab24e94c163c23cf8a10b26;hp=0029094541a3747b59d7d5e46aae4f3d0d2b7325;hpb=d43853c736be2e95235d62f54891fa917cd6e992;p=squirrelmail.git diff --git a/functions/imap_mailbox.php b/functions/imap_mailbox.php index 00290945..3be48cdd 100755 --- a/functions/imap_mailbox.php +++ b/functions/imap_mailbox.php @@ -6,13 +6,16 @@ * 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 + * This implements all functions that manipulate mailboxes * * @version $Id$ * @package squirrelmail * @subpackage imap */ +/** @ignore */ +if (! defined('SM_PATH')) define('SM_PATH','../'); + /** UTF7 support */ require_once(SM_PATH . 'functions/imap_utf7_local.php'); @@ -27,9 +30,11 @@ global $boxesnew; * 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. + * + * Some code fragments are present in 1.3.0 - 1.4.4. * @package squirrelmail * @subpackage imap - * @since 1.3.0 + * @since 1.5.0 */ class mailboxes { var $mailboxname_full = '', $mailboxname_sub= '', $is_noselect = false, $is_noinferiors = false, @@ -76,6 +81,7 @@ class mailboxes { * array callback used for sorting in mailboxes class * @param object $a * @param object $b + * @return integer see php strnatcasecmp() * @since 1.3.0 */ function sortSpecialMbx($a, $b) { @@ -125,7 +131,7 @@ function compact_mailboxes_response($ary) { * (LIST|LSUB) () (NIL|"") \r\n * mailbox name in quoted string MUST be unquoted and stripslashed (sm API) * - * Originally stored in functions/strings.php. Since 1.2.6 stored in + * Originally stored in functions/strings.php. Since 1.2.6 stored in * functions/imap_mailbox.php * @param string $line imap LIST/LSUB response line * @return string mailbox name @@ -141,6 +147,8 @@ function find_mailbox_name($line) { /** * Detects if mailbox has noselect flag (can't store messages) + * In versions older than 1.4.5 function checks only LSUB responses + * and can produce pcre warnings. * @param string $lsub_line mailbox line from untagged LIST or LSUB response * @return bool whether this is a Noselect mailbox. * @since 1.3.2 @@ -166,11 +174,11 @@ function check_is_noinferiors ($lsub_line) { * separator character, returns the second last part of the full * mailbox name (i.e. the mailbox's parent mailbox) * - * Originally stored in functions/strings.php. Since 1.2.6 stored in + * Originally stored in functions/strings.php. Since 1.2.6 stored in * functions/imap_mailbox.php * @param string $haystack full mailbox name * @param string $needle delimiter - * @return string parent mailbox + * @return string parent mailbox */ function readMailboxParent($haystack, $needle) { if ($needle == '') { @@ -213,7 +221,7 @@ function isBoxBelow( $subbox, $parentbox ) { /** * Defines special mailboxes: given a mailbox name, it checks if this is a * "special" one: INBOX, Trash, Sent or Draft. - * + * * Since 1.2.5 function includes special_mailbox hook.
* Since 1.4.3 hook supports more than one plugin. * @param string $box mailbox name @@ -268,18 +276,18 @@ function isDraftMailbox($box) { /** * Expunges a mailbox - * + * * WARNING: Select mailbox before calling this function. - * - * permanently removes all messages that have the \Deleted flag - * set from the selected mailbox. See EXPUNGE command chapter in + * + * permanently removes all messages that have the \Deleted flag + * set from the selected mailbox. See EXPUNGE command chapter in * IMAP RFC. * @param stream $imap_stream imap connection resource * @param string $mailbox mailbox name (unused since 1.1.3). * @param boolean $handle_errors error handling control (displays error_box on error). * @param mixed $id (since 1.3.0) integer message id or array with integer ids * @return integer number of expunged messages - * + * @since 1.0 or older */ function sqimap_mailbox_expunge ($imap_stream, $mailbox, $handle_errors = true, $id='') { if ($id) { @@ -326,7 +334,7 @@ function sqimap_mailbox_exists ($imap_stream, $mailbox) { * Before 1.3.0 used more arguments and returned data depended on those argumements. * @param stream $imap_stream imap connection resource * @param string $mailbox mailbox name - * @return array results of select command (on success - permanentflags, flags and rights) + * @return array results of select command (on success - permanentflags, flags and rights) * @since 1.0 or older */ function sqimap_mailbox_select ($imap_stream, $mailbox) { @@ -366,10 +374,10 @@ function sqimap_mailbox_select ($imap_stream, $mailbox) { * Creates a folder. * * Mailbox is automatically subscribed. - * - * Set $type to string that does not match 'noselect' (case insensitive), - * if you don't want to prepend delimiter to mailbox name. Please note - * that 'noinferiors' might be used someday as keyword for folders + * + * Set $type to string that does not match 'noselect' (case insensitive), + * if you don't want to prepend delimiter to mailbox name. Please note + * that 'noinferiors' might be used someday as keyword for folders * that store only messages. * @param stream $imap_steam imap connection resource * @param string $mailbox mailbox name @@ -415,25 +423,37 @@ function sqimap_unsubscribe ($imap_stream, $mailbox) { /** * Deletes the given folder + * Since 1.2.6 and 1.3.0 contains rename_or_delete_folder hook + * @param stream $imap_stream imap connection resource + * @param string $mailbox mailbox name + * @since 1.0 or older */ function sqimap_mailbox_delete ($imap_stream, $mailbox) { global $data_dir, $username; sqimap_unsubscribe ($imap_stream, $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"); - removePref($data_dir, $username, "collapse_folder_$mailbox"); + + if (sqimap_mailbox_exists($imap_stream, $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"); + removePref($data_dir, $username, "collapse_folder_$mailbox"); + } } } /** * Determines if the user is subscribed to the folder or not + * @param stream $imap_stream imap connection resource + * @param string $mailbox mailbox name + * @return boolean + * @since 1.2.0 */ function sqimap_mailbox_is_subscribed($imap_stream, $folder) { $boxesall = sqimap_mailbox_list ($imap_stream); @@ -447,6 +467,11 @@ function sqimap_mailbox_is_subscribed($imap_stream, $folder) { /** * Renames a mailbox. + * Since 1.2.6 and 1.3.0 contains rename_or_delete_folder hook + * @param stream $imap_stream imap connection resource + * @param string $old_name mailbox name + * @param string $new_name new mailbox name + * @since 1.2.3 */ function sqimap_mailbox_rename( $imap_stream, $old_name, $new_name ) { if ( $old_name != $new_name ) { @@ -508,12 +533,21 @@ function sqimap_mailbox_rename( $imap_stream, $old_name, $new_name ) { * Formats a mailbox into parts for the $boxesall array * * The parts are: - * - * raw - Raw LIST/LSUB response from the IMAP server - * formatted - nicely formatted folder name - * unformatted - unformatted, but with delimiter at end removed - * unformatted-dm - folder name as it appears in raw response - * unformatted-disp - unformatted without $folder_prefix + *
    + *
  • raw - Raw LIST/LSUB response from the IMAP server + *
  • formatted - nicely formatted folder name + *
  • unformatted - unformatted, but with delimiter at end removed + *
  • unformatted-dm - folder name as it appears in raw response + *
  • unformatted-disp - unformatted without $folder_prefix + *
  • id - TODO: document me + *
  • flags - TODO: document me + *
+ * Before 1.2.0 used third argument for delimiter. + * @param $line + * @param $line_lsub + * @return array + * @since 1.0 or older + * @todo document id and flags keys in boxes array and function arguments. */ function sqimap_mailbox_parse ($line, $line_lsub) { global $folder_prefix, $delimiter; @@ -584,18 +618,20 @@ function sqimap_mailbox_parse ($line, $line_lsub) { * based on available mailboxes and separators * Caller should surround options with and * any formatting. - * $imap_stream - $imapConnection to query for mailboxes - * $show_selected - array containing list of mailboxes to pre-select (0 if none) - * $folder_skip - array of folders to keep out of option list (compared in lower) - * $boxes - list of already fetched boxes (for places like folder panel, where + * @param stream $imap_stream imap connection resource to query for mailboxes + * @param array $show_selected array containing list of mailboxes to pre-select (0 if none) + * @param array $folder_skip array of folders to keep out of option list (compared in lower) + * @param $boxes list of already fetched boxes (for places like folder panel, where * you know these options will be shown 3 times in a row.. (most often unset). - * $flag - flag to check for in mailbox flags, used to filter out mailboxes. + * @param string $flag (since 1.4.1) flag to check for in mailbox flags, used to filter out mailboxes. * 'noselect' by default to remove unselectable mailboxes. * 'noinferiors' used to filter out folders that can not contain subfolders. * NULL to avoid flag check entirely. * NOTE: noselect and noiferiors are used internally. The IMAP representation is * \NoSelect and \NoInferiors - * $use_long_format - override folder display preference and always show full folder name. + * @param boolean $use_long_format (since 1.4.1) override folder display preference and always show full folder name. + * @return string html formated mailbox selection options + * @since 1.3.2 */ function sqimap_mailbox_option_list($imap_stream, $show_selected = 0, $folder_skip = 0, $boxes = 0, $flag = 'noselect', $use_long_format = false ) { @@ -655,6 +691,7 @@ function sqimap_mailbox_option_list($imap_stream, $show_selected = 0, $folder_sk * @param resource $imap_stream imap connection resource * @param boolean $force force update of mailbox listing. available since 1.4.2 and 1.5.0 * @return array list of mailboxes + * @since 1.0 or older */ function sqimap_mailbox_list($imap_stream, $force=false) { if (!sqgetGlobalVar('boxesnew',$boxesnew,SQ_SESSION) || $force) { @@ -767,13 +804,13 @@ function sqimap_mailbox_list($imap_stream, $force=false) { /* Find INBOX's children */ for($k = 0; $k < $cnt; ++$k) { - if (!$used[$k] && isBoxBelow(strtolower($boxesall[$k]['unformatted']), 'inbox') && + if (!$used[$k] && isBoxBelow(strtolower($boxesall[$k]['unformatted']), 'inbox') && strtolower($boxesall[$k]['unformatted']) != 'inbox') { $boxesnew[] = $boxesall[$k]; $used[$k] = true; - } + } } - + /* Rest of the folders */ for($k = 0; $k < $cnt; $k++) { if (!$used[$k]) { @@ -786,7 +823,10 @@ function sqimap_mailbox_list($imap_stream, $force=false) { } /** - * Returns a list of all folders, subscribed or not + * Returns a list of all folders, subscribed or not + * @param stream $imap_stream imap connection resource + * @return array see sqimap_mailbox_parse() + * @since 1.0 or older */ function sqimap_mailbox_list_all($imap_stream) { global $list_special_folders_first, $folder_prefix, $delimiter; @@ -853,117 +893,141 @@ function sqimap_mailbox_list_all($imap_stream) { return $boxes; } +/** + * Fills mailbox object + * + * Some code fragments are present in 1.3.0 - 1.4.4. + * @param stream $imap_stream imap connection resource + * @return object see mailboxes class. + * @since 1.5.0 + */ function sqimap_mailbox_tree($imap_stream) { - 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, $show_only_subscribed_folders; + global $default_folder_prefix, $data_dir, $username, $list_special_folders_first, + $folder_prefix, $delimiter, $trash_folder, $move_to_trash, + $imap_server_type, $show_only_subscribed_folders; - $noselect = false; - $noinferiors = false; + // TODO: implement mailbox tree caching. maybe store object in session? - require_once(SM_PATH . 'include/load_prefs.php'); + $noselect = false; + $noinferiors = false; - if ($show_only_subscribed_folders) { - $lsub_cmd = 'LSUB'; - } else { - $lsub_cmd = 'LIST'; - } + require_once(SM_PATH . 'include/load_prefs.php'); - /* LSUB array */ - $lsub_ary = sqimap_run_command ($imap_stream, "$lsub_cmd \"$folder_prefix\" \"*\"", - true, $response, $message); - $lsub_ary = compact_mailboxes_response($lsub_ary); + if ($show_only_subscribed_folders) { + $lsub_cmd = 'LSUB'; + } else { + $lsub_cmd = 'LIST'; + } - /* Check to see if we have an INBOX */ - $has_inbox = false; - - for ($i = 0, $cnt = count($lsub_ary); $i < $cnt; $i++) { - if (preg_match("/^\*\s+$lsub_cmd.*\s\"?INBOX\"?[^(\/\.)].*$/i",$lsub_ary[$i])) { - $lsub_ary[$i] = strtoupper($lsub_ary[$i]); - // in case of an unsubscribed inbox an imap server can - // return the inbox in the lsub results with a \NoSelect - // flag. - if (!preg_match("/\*\s+$lsub_cmd\s+\(.*\\\\NoSelect.*\).*/i",$lsub_ary[$i])) { - $has_inbox = true; - } else { - // remove the result and request it again with a list - // response at a later stage. - unset($lsub_ary[$i]); - // re-index the array otherwise the addition of the LIST - // response will fail in PHP 4.1.2 and probably other older versions - $lsub_ary = array_values($lsub_ary); - } - break; + /* LSUB array */ + $lsub_ary = sqimap_run_command ($imap_stream, "$lsub_cmd \"$folder_prefix\" \"*\"", + true, $response, $message); + $lsub_ary = compact_mailboxes_response($lsub_ary); + + /* Check to see if we have an INBOX */ + $has_inbox = false; + + for ($i = 0, $cnt = count($lsub_ary); $i < $cnt; $i++) { + if (preg_match("/^\*\s+$lsub_cmd.*\s\"?INBOX\"?\s*$/i",$lsub_ary[$i])) { + $lsub_ary[$i] = strtoupper($lsub_ary[$i]); + // in case of an unsubscribed inbox an imap server can + // return the inbox in the lsub results with a \NoSelect + // flag. + if (!preg_match("/\*\s+$lsub_cmd\s+\(.*\\\\NoSelect.*\).*/i",$lsub_ary[$i])) { + $has_inbox = true; + } else { + // remove the result and request it again with a list + // response at a later stage. + unset($lsub_ary[$i]); + // re-index the array otherwise the addition of the LIST + // response will fail in PHP 4.1.2 and probably other older versions + $lsub_ary = array_values($lsub_ary); } + break; } + } - if ($has_inbox == false) { - // do a list request for inbox because we should always show - // inbox even if the user isn't subscribed to it. - $inbox_ary = sqimap_run_command ($imap_stream, 'LIST "" "INBOX"', - true, $response, $message); - $inbox_ary = compact_mailboxes_response($inbox_ary); - if (count($inbox_ary)) { - $lsub_ary[] = $inbox_ary[0]; - } + if ($has_inbox == false) { + // do a list request for inbox because we should always show + // inbox even if the user isn't subscribed to it. + $inbox_ary = sqimap_run_command ($imap_stream, 'LIST "" "INBOX"', + true, $response, $message); + $inbox_ary = compact_mailboxes_response($inbox_ary); + if (count($inbox_ary)) { + $lsub_ary[] = $inbox_ary[0]; } + } - /* - * Section about removing the last element was removed - * We don't return "* OK" anymore from sqimap_read_data - */ + /* + * 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++) { + $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") { + $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, 'noinferiors' => $noinferiors); + } + // FIX ME this requires a config setting inside conf.pl instead of checking on server type + if ($imap_server_type == "uw") { + $aQuery = array(); + $aTag = array(); + // prepare an array with queries + foreach ($sorted_lsub_ary as $aMbx) { + $mbx = stripslashes($aMbx['mbx']); + sqimap_prepare_pipelined_query('LIST "" ' . sqimap_encode_mailbox_name($mbx), $tag, $aQuery, false); + $aTag[$tag] = $mbx; + } $sorted_lsub_ary = array(); - $cnt = count($lsub_ary); - for ($i = 0; $i < $cnt; $i++) { - $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") { - $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); + // 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); } - $sorted_lsub_ary[] = array ('mbx' => $mbx, 'noselect' => $noselect, 'noinferiors' => $noinferiors); } - // FIX ME this requires a config setting inside conf.pl instead of checking on server type - if ($imap_server_type == "uw") { - $aQuery = array(); - $aTag = array(); - // prepare an array with queries - foreach ($sorted_lsub_ary as $aMbx) { - $mbx = stripslashes($aMbx['mbx']); - sqimap_prepare_pipelined_query('LIST "" ' . sqimap_encode_mailbox_name($mbx), $tag, $aQuery, false); - $aTag[$tag] = $mbx; - } - $sorted_lsub_ary = array(); - // execute all the queries at once - $aResponse = sqimap_run_pipelined_command ($imap_stream, $aQuery, false, $aServerResponse, $aServerMessage); - foreach($aTag as $tag => $mbx) { - if ($aServerResponse[$tag] == 'OK') { - $sResponse = implode('', $aResponse[$tag]); - $noselect = check_is_noselect($sResponse); - $noinferiors = check_is_noinferiors($sResponse); - $sorted_lsub_ary[] = array ('mbx' => $mbx, 'noselect' => $noselect, 'noinferiors' => $noinferiors); - } - } - $cnt = count($sorted_lsub_ary); - } - $sorted_lsub_ary = array_values($sorted_lsub_ary); - usort($sorted_lsub_ary, 'mbxSort'); - $boxestree = sqimap_fill_mailbox_tree($sorted_lsub_ary,false,$imap_stream); - return $boxestree; + $cnt = count($sorted_lsub_ary); } + $sorted_lsub_ary = array_values($sorted_lsub_ary); + usort($sorted_lsub_ary, 'mbxSort'); + $boxestree = sqimap_fill_mailbox_tree($sorted_lsub_ary,false,$imap_stream); + return $boxestree; } +/** + * Callback function used for sorting mailboxes in sqimap_mailbox_tree + * @param string $a + * @param string $b + * @return integer see php strnatcasecmp() + * @since 1.5.1 + */ function mbxSort($a, $b) { return strnatcasecmp($a['mbx'], $b['mbx']); } +/** + * Fills mailbox object + * + * Some code fragments are present in 1.3.0 - 1.4.4. + * @param array $mbx_ary + * @param $mbxs + * @param stream $imap_stream imap connection resource + * @return object see mailboxes class + * @since 1.5.0 + */ function sqimap_fill_mailbox_tree($mbx_ary, $mbxs=false,$imap_stream) { global $data_dir, $username, $list_special_folders_first, $folder_prefix, $trash_folder, $sent_folder, $draft_folder, @@ -999,46 +1063,15 @@ function sqimap_fill_mailbox_tree($mbx_ary, $mbxs=false,$imap_stream) { $mailbox = $mbx_ary[$i]['mbx']; /* - sent subfolders messes up using existing code as subfolders - were marked, but the parents were ordered somewhere else in - the list, despite having "special folders at top" option set. - Need a better method than this. - */ -/* - if ($mailbox == 'INBOX') { - $mbx->is_special = true; - } elseif (stristr($trash_folder , $mailbox)) { - $mbx->is_special = true; - } elseif (stristr($sent_folder , $mailbox)) { - $mbx->is_special = true; - } elseif (stristr($draft_folder , $mailbox)) { - $mbx->is_special = true; - } - - switch ($mailbox) { - case 'INBOX': - $mbx->is_inbox = true; - $mbx->is_special = true; - $mbx_ary[$i]['noselect'] = false; - break; - case $trash_folder: - $mbx->is_trash = true; - $mbx->is_special = true; - break; - case $sent_folder: - $mbx->is_sent = true; - $mbx->is_special = true; - break; - case $draft_folder: - $mbx->is_draft = true; - $mbx->is_special = true; - break; - } -*/ + * Set the is_special flag if it concerned a special mailbox. + * Used for displaying the special folders on top in the mailbox + * tree displaying code. + */ $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); @@ -1068,6 +1101,10 @@ function sqimap_fill_mailbox_tree($mbx_ary, $mbxs=false,$imap_stream) { return $mailboxes; } +/** + * @param object $mbx_tree + * @since 1.5.0 + */ function sqimap_utf7_decode_mbx_tree(&$mbx_tree) { if (strtoupper($mbx_tree->mailboxname_full) == 'INBOX') $mbx_tree->mailboxname_sub = _("INBOX"); @@ -1081,7 +1118,11 @@ function sqimap_utf7_decode_mbx_tree(&$mbx_tree) { } } - +/** + * @param object $mbx_tree + * @param array $aMbxs + * @since 1.5.0 + */ function sqimap_tree_to_ref_array(&$mbx_tree,&$aMbxs) { if ($mbx_tree) $aMbxs[] =& $mbx_tree; @@ -1093,6 +1134,11 @@ function sqimap_tree_to_ref_array(&$mbx_tree,&$aMbxs) { } } +/** + * @param stream $imap_stream imap connection resource + * @param object $mbx_tree + * @since since 1.5.0 + */ function sqimap_get_status_mbx_tree($imap_stream,&$mbx_tree) { global $unseen_notify, $unseen_type, $trash_folder,$move_to_trash; $aMbxs = $aQuery = array();