X-Git-Url: https://vcs.fsf.org/?a=blobdiff_plain;f=functions%2Fimap_mailbox.php;h=191c6b944166b1b9650f56f77005e09e49d4c80a;hb=c2d47d51b70b0ffbc4203a91f4e38381fa48d751;hp=0fe2ce3fa1d153239ac7dc469f83774c34badb9b;hpb=86c2763df68fb7795c7949fa188f95eb26448812;p=squirrelmail.git diff --git a/functions/imap_mailbox.php b/functions/imap_mailbox.php index 0fe2ce3f..191c6b94 100755 --- a/functions/imap_mailbox.php +++ b/functions/imap_mailbox.php @@ -9,18 +9,24 @@ * This impliments all functions that manipulate mailboxes * * $Id$ + * @package squirrelmail */ + +/** UTF7 support */ require_once(SM_PATH . 'functions/imap_utf7_local.php'); global $boxesnew; -/* - FIXME. This class should be extracted and placed in a separate file that - can be included before we start the session. That makes caching of the tree - possible. On a refresh mailboxes from left_main.php the only function that - should be called is the sqimap_get_status_mbx_tree. In case of subscribe - / rename / delete / new we have to create methods for adding/changing the - mailbox in the mbx_tree without the need for a refresh. +/** + * Mailboxes class + * + * FIXME. This class should be extracted and placed in a separate file that + * can be included before we start the session. That makes caching of the tree + * possible. On a refresh mailboxes from left_main.php the only function that + * should be called is the sqimap_get_status_mbx_tree. In case of subscribe + * / rename / delete / new we have to create methods for adding/changing the + * mailbox in the mbx_tree without the need for a refresh. + * @package squirrelmail */ class mailboxes { @@ -79,8 +85,7 @@ 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 compact_mailboxes_response($ary) @@ -103,20 +108,11 @@ function compact_mailboxes_response($ary) return array_values(array_unique($ary)); } -/* -function find_mailbox_name ($mailbox) { - if (preg_match('/\*.+\"([^\r\n\"]*)\"[\s\r\n]*$/', $mailbox, $regs)) - return $regs[1]; - if (ereg(" *\"([^\r\n\"]*)\"[ \r\n]*$", $mailbox, $regs)) - return $regs[1]; - ereg(" *([^ \r\n\"]*)[ \r\n]*$",$mailbox,$regs); - return $regs[1]; -} -*/ - -// Extract the mailbox name from an untagged LIST (7.2.2) or LSUB (7.2.3) answer -// * (LIST|LSUB) () (NIL|"") \r\n -// mailbox name in quoted string MUST be unquoted and stripslashed (sm API) +/** + * 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)) { @@ -127,10 +123,16 @@ function find_mailbox_name($line) return ''; } +/** + * @return bool whether this is a Noselect mailbox. + */ function check_is_noselect ($lsub_line) { return preg_match("/^\* (LSUB|LIST) \([^\)]*\\\\Noselect[^\)]*\)/i", $lsub_line); } +/** + * @return bool whether this is a Noinferiors mailbox. + */ function check_is_noinferiors ($lsub_line) { return preg_match("/^\* (LSUB|LIST) \([^\)]*\\\\Noinferiors[^\)]*\)/i", $lsub_line); } @@ -177,36 +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 ) { $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) { @@ -232,7 +248,9 @@ function sqimap_mailbox_expunge ($imap_stream, $mailbox, $handle_errors = true, return $cnt; } -/* Checks whether or not the specified mailbox exists */ +/** + * Checks whether or not the specified mailbox exists + */ function sqimap_mailbox_exists ($imap_stream, $mailbox) { if (!isset($mailbox) || empty($mailbox)) { return false; @@ -242,7 +260,9 @@ function sqimap_mailbox_exists ($imap_stream, $mailbox) { return isset($mbx[0]); } -/* Selects a mailbox */ +/** + * Selects a mailbox + */ function sqimap_mailbox_select ($imap_stream, $mailbox) { global $auto_expunge; @@ -278,41 +298,55 @@ 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 ' . sqimap_encode_mailbox_name($mailbox), + $read_ary = sqimap_run_command($imap_stream, 'CREATE ' . + sqimap_encode_mailbox_name($mailbox), true, $response, $message); sqimap_subscribe ($imap_stream, $mailbox); } -/* Subscribes to an existing folder */ +/** + * Subscribes to an existing folder. + */ function sqimap_subscribe ($imap_stream, $mailbox) { - $read_ary = sqimap_run_command($imap_stream, 'SUBSCRIBE ' . sqimap_encode_mailbox_name($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 ' . sqimap_encode_mailbox_name($mailbox), + $read_ary = sqimap_run_command($imap_stream, 'UNSUBSCRIBE ' . + sqimap_encode_mailbox_name($mailbox), true, $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 ' . sqimap_encode_mailbox_name($mailbox), + $read_ary = sqimap_run_command($imap_stream, 'DELETE ' . + sqimap_encode_mailbox_name($mailbox), true, $response, $message); sqimap_unsubscribe ($imap_stream, $mailbox); do_hook_function('rename_or_delete_folder', $args = array($mailbox, 'delete', '')); removePref($data_dir, $username, "thread_$mailbox"); } -/* 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) { @@ -323,7 +357,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; @@ -336,7 +372,8 @@ function sqimap_mailbox_rename( $imap_stream, $old_name, $new_name ) { } $boxesall = sqimap_mailbox_list($imap_stream); - $cmd = 'RENAME ' . sqimap_encode_mailbox_name($old_name) . ' ' . sqimap_encode_mailbox_name($new_name); + $cmd = 'RENAME ' . sqimap_encode_mailbox_name($old_name) . + ' ' . sqimap_encode_mailbox_name($new_name); $data = sqimap_run_command($imap_stream, $cmd, true, $response, $message); sqimap_unsubscribe($imap_stream, $old_name.$postfix); $oldpref = getPref($data_dir, $username, 'thread_'.$old_name.$postfix); @@ -367,7 +404,7 @@ function sqimap_mailbox_rename( $imap_stream, $old_name, $new_name ) { } } -/* +/** * Formats a mailbox into parts for the $boxesall array * * The parts are: @@ -442,23 +479,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 @@ -513,7 +534,7 @@ function sqimap_mailbox_option_list($imap_stream, $show_selected = 0, $folder_sk $box2 = $boxes_part['formatted']; break; default: /* default, long names, style = 0 */ - $box2 = str_replace(' ', ' ', htmlentities(imap_utf7_decode_local($boxes_part['unformatted-disp']))); + $box2 = str_replace(' ', ' ', htmlspecialchars(imap_utf7_decode_local($boxes_part['unformatted-disp']))); break; } } @@ -527,7 +548,7 @@ function sqimap_mailbox_option_list($imap_stream, $show_selected = 0, $folder_sk return $mbox_options; } -/* +/** * Returns sorted mailbox lists in several different ways. * See comment on sqimap_mailbox_parse() for info about the returned array. */ @@ -566,7 +587,7 @@ function sqimap_mailbox_list($imap_stream) { /* natural sort mailboxes */ if (isset($sorted_lsub_ary)) { - usort($sorted_lsub_ary, 'user_strcasecmp'); + usort($sorted_lsub_ary, 'strnatcasecmp'); } /* * The LSUB response doesn't provide us information about \Noselect @@ -640,7 +661,7 @@ function sqimap_mailbox_list($imap_stream) { return $boxesnew; } -/* +/** * Returns a list of all folders, subscribed or not */ function sqimap_mailbox_list_all($imap_stream) { @@ -836,7 +857,7 @@ function sqimap_fill_mailbox_tree($mbx_ary, $mbxs=false,$imap_stream) { 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)) { @@ -851,7 +872,7 @@ function sqimap_fill_mailbox_tree($mbx_ary, $mbxs=false,$imap_stream) { case 'INBOX': $mbx->is_inbox = true; $mbx->is_special = true; - $mbx_ary[$i]['noselect'] = false; + $mbx_ary[$i]['noselect'] = false; break; case $trash_folder: $mbx->is_trash = true; @@ -866,6 +887,13 @@ function sqimap_fill_mailbox_tree($mbx_ary, $mbxs=false,$imap_stream) { $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 = do_hook_function('special_mailbox', $mailbox); if (isset($mbx_ary[$i]['unseen'])) { $mbx->unseen = $mbx_ary[$i]['unseen']; @@ -918,22 +946,6 @@ function sqimap_tree_to_ref_array(&$mbx_tree,&$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();