X-Git-Url: https://vcs.fsf.org/?a=blobdiff_plain;f=functions%2Fimap_mailbox.php;h=94b46aa82671fb21aede7747399a55645bcf2f60;hb=ad2f0b546afcb978ee67ef25332cf4f12c363892;hp=b6a36c0fe6eb07cdae63ed9a6e341173d800b087;hpb=3824e89aa69f6db72f7f7789ac3fa78318c362b9;p=squirrelmail.git diff --git a/functions/imap_mailbox.php b/functions/imap_mailbox.php index b6a36c0f..94b46aa8 100755 --- a/functions/imap_mailbox.php +++ b/functions/imap_mailbox.php @@ -5,7 +5,7 @@ * * This implements all functions that manipulate mailboxes * - * @copyright © 1999-2006 The SquirrelMail Project Team + * @copyright 1999-2012 The SquirrelMail Project Team * @license http://opensource.org/licenses/gpl-license.php GNU Public License * @version $Id$ * @package squirrelmail @@ -110,8 +110,7 @@ function compact_mailboxes_response($ary) { */ 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)) { + if (preg_match('/^(\* [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); } @@ -217,8 +216,16 @@ 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.2.5 function includes special_mailbox hook. + * * Since 1.4.3 hook supports more than one plugin. + * +//FIXME: make $subfolders_of_inbox_are_special a configuration setting in conf.pl and config.php + * Since 1.4.22/1.5.2, the administrator can add + * $subfolders_of_inbox_are_special = TRUE; + * to config/config_local.php and all subfolders + * of the INBOX will be treated as special. + * * @param string $box mailbox name * @param boolean $include_subs (since 1.5.2) if true, subfolders of system * folders are special. if false, subfolders are not special mailboxes @@ -227,17 +234,36 @@ function isBoxBelow( $subbox, $parentbox ) { * @since 1.2.3 */ function isSpecialMailbox($box,$include_subs=true) { - $ret = ( (strtolower($box) == 'inbox') || + global $subfolders_of_inbox_are_special; + $ret = ( ($subfolders_of_inbox_are_special && isInboxMailbox($box,$include_subs)) || + (!$subfolders_of_inbox_are_special && strtolower($box) == 'inbox') || isTrashMailbox($box,$include_subs) || isSentMailbox($box,$include_subs) || isDraftMailbox($box,$include_subs) ); if ( !$ret ) { - $ret = boolean_hook_function('special_mailbox',$box,1); + $ret = boolean_hook_function('special_mailbox', $box, 1); } return $ret; } +/** + * Detects if mailbox is the Inbox folder or subfolder of the Inbox + * + * @param string $box The mailbox name to test + * @param boolean $include_subs If true, subfolders of system folders + * are special. If false, subfolders are + * not special mailboxes. + * + * @return boolean Whether this is the Inbox or a child thereof. + * + * @since 1.4.22 + */ +function isInboxMailbox($box, $include_subs=TRUE) { + return ((strtolower($box) == 'inbox') + || ($include_subs && isBoxBelow(strtolower($box), 'inbox'))); +} + /** * Detects if mailbox is a Trash folder or subfolder of Trash * @param string $box mailbox name @@ -283,6 +309,34 @@ function isDraftMailbox($box,$include_subs=true) { ($include_subs && isBoxBelow($box, $draft_folder)) ); } +/** + * Is the given folder "sent-like" in nature? + * + * The most obvious use of this is to know what folders you usually + * want to show the To field instead of the From field on the mailbox list + * + * This function returns TRUE if the given folder is the sent + * folder (or any of its subfolders) or if it is the draft + * folder (or any of its subfolders) + * + * @param string $mailbox + * + * @return boolean See explanation above + * + */ +function handleAsSent($mailbox) { + global $handleAsSent_result; + + /* First check if this is the sent or draft folder. */ + $handleAsSent_result = isSentMailbox($mailbox) || isDraftMailbox($mailbox); + + /* Then check the result of the handleAsSent hook. */ + do_hook('check_handleAsSent_result', $mailbox); + + /* And return the result. */ + return $handleAsSent_result; +} + /** * Expunges a mailbox * @@ -360,8 +414,7 @@ function sqimap_mailbox_exists ($imap_stream, $mailbox, $mailboxlist=null) { * @since 1.0 or older */ function sqimap_mailbox_select ($imap_stream, $mailbox) { - // FIX ME: WHAAAA DO NOT USE "None" for something that does not exist. Use false or NULL instead - if ($mailbox == 'None') { + if (empty($mailbox)) { return; } @@ -486,7 +539,8 @@ function sqimap_mailbox_delete ($imap_stream, $mailbox) { // subscribe again sqimap_subscribe ($imap_stream, $mailbox); } else { - do_hook_function('rename_or_delete_folder', $args = array($mailbox, 'delete', '')); + $temp = array(&$mailbox, 'delete', ''); + do_hook('rename_or_delete_folder', $temp); removePref($data_dir, $username, "thread_$mailbox"); removePref($data_dir, $username, "collapse_folder_$mailbox"); } @@ -541,7 +595,8 @@ function sqimap_mailbox_rename( $imap_stream, $old_name, $new_name ) { sqimap_subscribe($imap_stream, $new_name.$postfix); setPref($data_dir, $username, 'thread_'.$new_name.$postfix, $oldpref_thread); setPref($data_dir, $username, 'collapse_folder_'.$new_name.$postfix, $oldpref_collapse); - do_hook_function('rename_or_delete_folder',$args = array($old_name, 'rename', $new_name)); + $temp = array(&$old_name, 'rename', &$new_name); + do_hook('rename_or_delete_folder', $temp); $l = strlen( $old_name ) + 1; $p = 'unformatted'; @@ -567,8 +622,8 @@ function sqimap_mailbox_rename( $imap_stream, $old_name, $new_name ) { } setPref($data_dir, $username, 'thread_'.$new_sub, $oldpref_thread); setPref($data_dir, $username, 'collapse_folder_'.$new_sub, $oldpref_collapse); - do_hook_function('rename_or_delete_folder', - $args = array($box[$p], 'rename', $new_sub)); + $temp = array(&$box[$p], 'rename', &$new_sub); + do_hook('rename_or_delete_folder', $temp); } } } @@ -647,8 +702,7 @@ function sqimap_mailbox_parse ($line) { $boxesall[$g]['id'] = $g; $boxesall[$g]['flags'] = array(); - if (isset($line[$g])) { - ereg("\(([^)]*)\)",$line[$g],$regs); + if (isset($line[$g]) && preg_match('/\(([^)]*)\)/',$line[$g],$regs) ) { /** * Since 1.5.1 flags are stored with RFC3501 naming * and also the old way for backwards compatibility @@ -687,7 +741,7 @@ function sqimap_mailbox_option_array($imap_stream, $folder_skip = 0, $boxes = 0, if ( $use_long_format ) { $shorten_box_names = 0; } else { - $shorten_box_names = getPref($data_dir, $username, 'mailbox_select_style', SMPREF_OFF); + $shorten_box_names = getPref($data_dir, $username, 'mailbox_select_style', SMPREF_MAILBOX_SELECT_INDENTED); } if ($boxes == 0) { @@ -712,7 +766,7 @@ function sqimap_mailbox_option_array($imap_stream, $folder_skip = 0, $boxes = 0, } else { switch ($shorten_box_names) { - case 2: /* delimited, style = 2 */ + case SMPREF_MAILBOX_SELECT_DELIMITED: if ($translate_special_folders && $boxes_part['unformatted-dm']==$sent_folder) { /* * calculate pad level from number of delimiters. do it inside if control in order @@ -733,7 +787,7 @@ function sqimap_mailbox_option_array($imap_stream, $folder_skip = 0, $boxes = 0, $box2 = str_replace('&nbsp;&nbsp;', '. ', htmlspecialchars($boxes_part['formatted'])); } break; - case 1: /* indent, style = 1 */ + case SMPREF_MAILBOX_SELECT_INDENTED: if ($translate_special_folders && $boxes_part['unformatted-dm']==$sent_folder) { $pad = str_pad('',12 * (count(explode($delimiter,$boxes_part['unformatted-dm']))-1),'  '); $box2 = $pad . _("Sent"); @@ -1381,7 +1435,7 @@ function sqimap_get_status_mbx_tree($imap_stream,&$mbx_tree) { { $hook_status['MAILBOX']=$oMbx->mailboxname_full; $hook_status['CALLER']='sqimap_get_status_mbx_tree'; // helps w/ debugging - do_hook_function('folder_status',$hook_status); + do_hook('folder_status', $hook_status); } } }