X-Git-Url: https://vcs.fsf.org/?p=squirrelmail.git;a=blobdiff_plain;f=functions%2Fimap_mailbox.php;h=985d4d54a54f50f8c84307ebd7a38493be566b02;hp=e9f9d6a48cd3a5684be0882934bdbb49d0d36478;hb=3a634ed1d9902d54edf6921ee3c1b1c5e7b40db8;hpb=ceb7ad3c6c336213e89b7144a025b752c29a2f6c;ds=sidebyside
diff --git a/functions/imap_mailbox.php b/functions/imap_mailbox.php
index e9f9d6a4..985d4d54 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-2016 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,12 +414,30 @@ 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;
}
+
// cleanup $mailbox in order to prevent IMAP injection attacks
$mailbox = str_replace(array("\r","\n"), array("",""),$mailbox);
+
+ /**
+ * Default UW IMAP server configuration allows to access other files
+ * on server. $imap_server_type is not checked because interface can
+ * be used with 'other' or any other server type setting. $mailbox
+ * variable can be modified in any script that uses variable from GET
+ * or POST. This code blocks all standard SquirrelMail IMAP API requests
+ * that use mailbox with full path (/etc/passwd) or with ../ characters
+ * in path (../../etc/passwd)
+ */
+ if (strstr($mailbox, '../') || substr($mailbox, 0, 1) == '/') {
+ global $oTemplate;
+ error_box(sprintf(_("Invalid mailbox name: %s"),sm_encode_html_special_chars($mailbox)));
+ sqimap_logout($imap_stream);
+ $oTemplate->display('footer.tpl');
+ die();
+ }
+
$read = sqimap_run_command($imap_stream, 'SELECT ' . sqimap_encode_mailbox_name($mailbox),
true, $response, $message);
$result = array();
@@ -467,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");
}
@@ -522,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';
@@ -548,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);
}
}
}
@@ -582,7 +656,10 @@ function sqimap_mailbox_parse ($line) {
global $folder_prefix, $delimiter;
/* Process each folder line */
- for ($g = 0, $cnt = count($line); $g < $cnt; ++$g) {
+ ksort($line); // get physical ordering same as alphabetical sort we did before now (might be a better place for this)
+ foreach ($line as $g => $l)
+ // was this but array not guaranteed to be contiguous: for ($g = 0, $cnt = count($line); $g < $cnt; ++$g)
+ {
/* Store the raw IMAP reply */
if (isset($line[$g])) {
$boxesall[$g]['raw'] = $line[$g];
@@ -628,8 +705,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
@@ -651,26 +727,13 @@ function sqimap_mailbox_parse ($line) {
}
/**
- * Returns list of options (to be echoed into select statement
- * based on available mailboxes and separators
- * Caller should surround options with and
- * any formatting.
- * @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).
- * @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
- * @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
+ * Returns an array of mailboxes available. Separated from sqimap_mailbox_option_list()
+ * below for template development.
+ *
+ * @author Steve Brown
+ * @since 1.5.2
*/
-function sqimap_mailbox_option_list($imap_stream, $show_selected = 0, $folder_skip = 0, $boxes = 0,
+function sqimap_mailbox_option_array($imap_stream, $folder_skip = 0, $boxes = 0,
$flag = 'noselect', $use_long_format = false ) {
global $username, $data_dir, $translate_special_folders, $sent_folder,
$trash_folder, $draft_folder;
@@ -681,13 +744,14 @@ function sqimap_mailbox_option_list($imap_stream, $show_selected = 0, $folder_sk
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) {
$boxes = sqimap_mailbox_list($imap_stream);
}
+ $a = array();
foreach ($boxes as $boxes_part) {
if ($flag == NULL || (is_array($boxes_part['flags'])
&& !in_array($flag, $boxes_part['flags']))) {
@@ -705,7 +769,7 @@ function sqimap_mailbox_option_list($imap_stream, $show_selected = 0, $folder_sk
} 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
@@ -723,10 +787,10 @@ function sqimap_mailbox_option_list($imap_stream, $show_selected = 0, $folder_sk
// i18n: Name of Drafts folder
$box2 = $pad . _("Drafts");
} else {
- $box2 = str_replace(' ', '. ', htmlspecialchars($boxes_part['formatted']));
+ $box2 = str_replace(' ', '. ', sm_encode_html_special_chars($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");
@@ -737,22 +801,66 @@ function sqimap_mailbox_option_list($imap_stream, $show_selected = 0, $folder_sk
$pad = str_pad('',12 * (count(explode($delimiter,$boxes_part['unformatted-dm']))-1),' ');
$box2 = $pad . _("Drafts");
} else {
- $box2 = str_replace(' ', ' ', htmlspecialchars($boxes_part['formatted']));
+ $box2 = str_replace(' ', ' ', sm_encode_html_special_chars($boxes_part['formatted']));
}
break;
default: /* default, long names, style = 0 */
- $box2 = str_replace(' ', ' ', htmlspecialchars(imap_utf7_decode_local($boxes_part['unformatted-disp'])));
+ $box2 = str_replace(' ', ' ', sm_encode_html_special_chars(imap_utf7_decode_local($boxes_part['unformatted-disp'])));
break;
}
}
- if ($show_selected != 0 && in_array($lowerbox, $show_selected) ) {
- $mbox_options .= '' . "\n";
- } else {
- $mbox_options .= '' . "\n";
+
+ $a[sm_encode_html_special_chars($box)] = $box2;
+ }
+ }
+
+ return $a;
+}
+
+/**
+ * Returns list of options (to be echoed into select statement
+ * based on available mailboxes and separators
+ * Caller should surround options with and
+ * any formatting.
+ * @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).
+ * @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
+ * @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 ) {
+ global $username, $data_dir, $translate_special_folders, $sent_folder,
+ $trash_folder, $draft_folder;
+
+ $boxes = sqimap_mailbox_option_array($imap_stream, $folder_skip, $boxes, $flag, $use_long_format);
+
+ $str = '';
+ foreach ($boxes as $value=>$option) {
+ $lowerbox = strtolower(sm_encode_html_special_chars($value));
+ $sel = false;
+ if ($show_selected != 0) {
+ reset($show_selected);
+ while (!$sel && (list($x, $val) = each($show_selected))) {
+ if (strtolower($value) == strtolower(sm_encode_html_special_chars($val))) {
+ $sel = true;
+ }
}
}
+
+ $str .= '\n";
}
- return $mbox_options;
+
+ return $str;
}
/**
@@ -983,7 +1091,9 @@ function sqimap_get_mailboxes($imap_stream,$force=false,$show_only_subscribed=tr
$cnt = count($boxesall);
$used = array_pad($used,$cnt,false);
$has_inbox = false;
- for($k = 0; $k < $cnt; ++$k) {
+ foreach ($boxesall as $k => $b)
+ // was this but array not guaranteed to be contiguous: for($k = 0; $k < $cnt; ++$k)
+ {
if (strtoupper($boxesall[$k]['unformatted']) == 'INBOX') {
$boxesnew[] = $boxesall[$k];
$used[$k] = true;
@@ -1012,7 +1122,9 @@ function sqimap_get_mailboxes($imap_stream,$force=false,$show_only_subscribed=tr
/* List special folders and their subfolders, if requested. */
if ($list_special_folders_first) {
- for($k = 0; $k < $cnt; ++$k) {
+ foreach ($boxesall as $k => $b)
+ // was this but array not guaranteed to be contiguous: for($k = 0; $k < $cnt; ++$k)
+ {
if (!$used[$k] && isSpecialMailbox($boxesall[$k]['unformatted'])) {
$boxesnew[] = $boxesall[$k];
$used[$k] = true;
@@ -1021,7 +1133,9 @@ function sqimap_get_mailboxes($imap_stream,$force=false,$show_only_subscribed=tr
}
/* Find INBOX's children */
- for($k = 0; $k < $cnt; ++$k) {
+ foreach ($boxesall as $k => $b)
+ // was this but array not guaranteed to be contiguous: for($k = 0; $k < $cnt; ++$k)
+ {
$isboxbelow=isBoxBelow(strtoupper($boxesall[$k]['unformatted']),'INBOX');
if (strtoupper($boxesall[$k]['unformatted']) == 'INBOX') {
$is_inbox=1;
@@ -1036,7 +1150,9 @@ function sqimap_get_mailboxes($imap_stream,$force=false,$show_only_subscribed=tr
}
/* Rest of the folders */
- for($k = 0; $k < $cnt; $k++) {
+ foreach ($boxesall as $k => $b)
+ // was this but array not guaranteed to be contiguous: for($k = 0; $k < $cnt; ++$k)
+ {
if (!$used[$k]) {
$boxesnew[] = $boxesall[$k];
}
@@ -1330,7 +1446,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);
}
}
}