/**
* imap_search.php
*
- * Copyright (c) 1999-2003 The SquirrelMail Project Team
+ * Copyright (c) 1999-2004 The SquirrelMail Project Team
* Licensed under the GNU GPL. For full terms see the file COPYING.
*
* IMAP asearch routines
- * Alex Lemaresquier - Brainstorm - alex at brainstorm.fr
- * See README file for infos.
*
+ * Subfolder search idea from Patch #806075 by Thomas Pohl xraven at users.sourceforge.net. Thanks Thomas!
+ *
+ * @version $Id$
+ * @package squirrelmail
+ * @subpackage imap
+ * @see search.php
+ * @link http://www.ietf.org/rfc/rfc3501.txt
+ * @author Alex Lemaresquier - Brainstorm - alex at brainstorm.fr
*/
-require_once(SM_PATH . 'functions/imap.php');
+/** This functionality requires the IMAP and date functions
+ */
+require_once(SM_PATH . 'functions/imap_general.php');
require_once(SM_PATH . 'functions/date.php');
-/* Set to TRUE to dump the imap dialogue */
+/** Set to TRUE to dump the imap dialogue
+ * @global bool $imap_asearch_debug_dump
+ */
$imap_asearch_debug_dump = FALSE;
+/** Imap SEARCH keys
+ * @global array $imap_asearch_opcodes
+ */
$imap_asearch_opcodes = array(
-/* <message set> => 'asequence', */
+/* <sequence-set> => 'asequence', */ // Special handling, @see sqimap_asearch_build_criteria()
/*'ALL' is binary operator */
'ANSWERED' => '',
'BCC' => 'astring',
'DRAFT' => '',
'FLAGGED' => '',
'FROM' => 'astring',
- 'HEADER' => 'afield', /* Special syntax for this one, see below */
+ 'HEADER' => 'afield', // Special syntax for this one, @see sqimap_asearch_build_criteria()
'KEYWORD' => 'akeyword',
'LARGER' => 'anum',
'NEW' => '',
'UNSEEN' => ''
);
+/** Imap SEARCH month names encoding
+ * @global array $imap_asearch_months
+ */
$imap_asearch_months = array(
'01' => 'jan',
'02' => 'feb',
'12' => 'dec'
);
-/* This is to avoid the E_NOTICE warnings signaled by marc AT squirrelmail.org. Thanks Marc! */
-function asearch_nz(&$var)
+/** Error message titles according to imap server returned code
+ * @global array $imap_error_titles
+ */
+$imap_error_titles = array(
+ 'OK' => '',
+ 'NO' => _("ERROR : Could not complete request."),
+ 'BAD' => _("ERROR : Bad or malformed request."),
+ 'BYE' => _("ERROR : Imap server closed the connection."),
+ '' => _("ERROR : Connection dropped by imap-server.")
+);
+
+/**
+ * Function to display an error related to an IMAP-query.
+ * We need to do our own error management since we may receive NO responses on purpose (even BAD with SORT or THREAD)
+ * so we call sqimap_error_box() if the function exists (sm >= 1.5) or use our own embedded code
+ * @global array imap_error_titles
+ * @param string $response the imap server response code
+ * @param string $query the failed query
+ * @param string $message an optional error message
+ * @param string $link an optional link to try again
+ */
+//@global array color sm colors array
+function sqimap_asearch_error_box($response, $query, $message, $link = '')
+{
+ global $imap_error_titles;
+
+ if (!array_key_exists($response, $imap_error_titles))
+ $title = _("ERROR : Unknown imap response.");
+ else
+ $title = $imap_error_titles[$response];
+ if ($link == '')
+ $message_title = _("Reason Given: ");
+ else
+ $message_title = _("Possible reason : ");
+ if (function_exists('sqimap_error_box'))
+ sqimap_error_box($title, $query, $message_title, $message, $link);
+ else { //Straight copy of 1.5 imap_general.php:sqimap_error_box(). Can be removed at a later time
+ global $color;
+ require_once(SM_PATH . 'functions/display_messages.php');
+ $string = "<font color=$color[2]><b>\n" . $title . "</b><br>\n";
+ if ($query != '')
+ $string .= _("Query:") . ' ' . htmlspecialchars($query) . '<br>';
+ if ($message_title != '')
+ $string .= $message_title;
+ if ($message != '')
+ $string .= htmlspecialchars($message);
+ if ($link != '')
+ $string .= $link;
+ $string .= "</font><br>\n";
+ error_box($string,$color);
+ }
+}
+
+/**
+ * This is a convenient way to avoid spreading if (isset(... all over the code
+ * @param mixed $var any variable (reference)
+ * @param mixed $def default value to return if unset (default is zls (''), pass 0 or array() when appropriate)
+ * @return mixed $def if $var is unset, otherwise $var
+ */
+function asearch_nz(&$var, $def = '')
{
if (isset($var))
return $var;
- return '';
+ return $def;
}
-/* This should give the same results as PHP 4 >= 4.3.0's html_entity_decode() */
+/**
+ * This should give the same results as PHP 4 >= 4.3.0's html_entity_decode(),
+ * except it doesn't handle hex constructs
+ * @param string $string string to unhtmlentity()
+ * @return string decoded string
+ */
function asearch_unhtmlentities($string) {
$trans_tbl = array_flip(get_html_translation_table(HTML_ENTITIES));
for ($i=127; $i<255; $i++) /* Add &#<dec>; entities */
*/
}
-function s_dump($var_name, $var_var, $compact = FALSE)
-{
- if (!$compact)
- echo '<PRE>';
- echo htmlentities($var_name) . '=';
- print_r($var_var);
- if ($compact)
- echo "<BR>\n";
- else
- echo "</PRE>\n";
-}
-
-function s_debug_dump($var_name, $var_var, $compact = FALSE)
+/**
+ * Provide an easy way to dump the imap dialogue if $imap_asearch_debug_dump is TRUE
+ * @global bool imap_asearch_debug_dump
+ * @param string $var_name
+ * @param string $var_var
+ */
+function s_debug_dump($var_name, $var_var)
{
global $imap_asearch_debug_dump;
- if ($imap_asearch_debug_dump)
- s_dump($var_name, $var_var, $compact);
+ if ($imap_asearch_debug_dump) {
+ if (function_exists('sm_print_r')) //Only exists since 1.4.2
+ sm_print_r($var_name, $var_var); //Better be the 'varargs' version ;)
+ else {
+ echo '<pre>';
+ echo htmlentities($var_name);
+ print_r($var_var);
+ echo '</pre>';
+ }
+ }
}
-/*
-4.3 String:
- A quoted string is a sequence of zero or more 7-bit characters,
- excluding CR and LF, with double quote (<">) characters at each end.
-9. Formal Syntax:
- quoted-specials = DQUOTE / "\"
-*/
-function sqimap_asearch_encode_string($what, $search_charset)
+/** Encode a string to quoted or literal as defined in rfc 3501
+ *
+ * - § 4.3 String:
+ * A quoted string is a sequence of zero or more 7-bit characters,
+ * excluding CR and LF, with double quote (<">) characters at each end.
+ * - § 9. Formal Syntax:
+ * quoted-specials = DQUOTE / "\"
+ * @param string $what string to encode
+ * @param string $charset search charset used
+ * @return string encoded string
+ */
+function sqimap_asearch_encode_string($what, $charset)
{
- if (strtoupper($search_charset) == 'ISO-2022-JP')
+ if (strtoupper($charset) == 'ISO-2022-JP') // This should be now handled in imap_utf7_local?
$what = mb_convert_encoding($what, 'JIS', 'auto');
- if (ereg("[\"\\\r\n]", $what))
- return '{' . strlen($what) . "}\r\n" . $what; /* 4.3 literal form */
- return '"' . $what . '"'; /* 4.3 quoted string form */
+//if (ereg("[\"\\\r\n\x80-\xff]", $what))
+ if (preg_match('/["\\\\\r\n\x80-\xff]/', $what))
+ return '{' . strlen($what) . "}\r\n" . $what; // 4.3 literal form
+ return '"' . $what . '"'; // 4.3 quoted string form
}
-/*
- Parses a user date string into an rfc2060 date string (<day number>-<US month TLA>-<4 digit year>)
- Returns a preg_match-style array: [0]: fully formatted date, [1]: day, [2]: month, [3]: year
- Handles space, slash, backslash, dot and comma as separators (and dash of course ;=)
-*/
+/**
+ * Parses a user date string into an rfc 3501 date string
+ * Handles space, slash, backslash, dot and comma as separators (and dash of course ;=)
+ * @global array imap_asearch_months
+ * @param string user date
+ * @return array a preg_match-style array:
+ * - [0] = fully formatted rfc 3501 date string (<day number>-<US month TLA>-<4 digit year>)
+ * - [1] = day
+ * - [2] = month
+ * - [3] = year
+ */
function sqimap_asearch_parse_date($what)
{
global $imap_asearch_months;
return $what_parts;
}
-function sqimap_asearch_build_criteria($opcode, $what, $search_charset)
+/**
+ * Build one criteria sequence
+ * @global array imap_asearch_opcodes
+ * @param string $opcode search opcode
+ * @param string $what opcode argument
+ * @param string $charset search charset
+ * @return string one full criteria sequence
+ */
+function sqimap_asearch_build_criteria($opcode, $what, $charset)
{
global $imap_asearch_opcodes;
switch ($imap_asearch_opcodes[$opcode]) {
default:
case 'anum':
-/* $what = str_replace(' ', '', $what);*/
- $what = ereg_replace('[^0-9]+', '', $what);
- if ($what != '')
+ $what = str_replace(' ', '', $what);
+ $what = ereg_replace('[^0-9]+[^KMG]$', '', strtoupper($what));
+ if ($what != '') {
+ switch (substr($what, -1)) {
+ case 'G':
+ $what = substr($what, 0, -1) << 30;
+ break;
+ case 'M':
+ $what = substr($what, 0, -1) << 20;
+ break;
+ case 'K':
+ $what = substr($what, 0, -1) << 10;
+ break;
+ }
$criteria = $opcode . ' ' . $what . ' ';
+ }
break;
- case '': /* aflag */
+ case '': //aflag
$criteria = $opcode . ' ';
break;
case 'afield': /* HEADER field-name: field-body */
preg_match('/^([^:]+):(.*)$/', $what, $what_parts);
if (count($what_parts) == 3)
$criteria = $opcode . ' ' .
- sqimap_asearch_encode_string($what_parts[1], $search_charset) . ' ' .
- sqimap_asearch_encode_string($what_parts[2], $search_charset) . ' ';
+ sqimap_asearch_encode_string($what_parts[1], $charset) . ' ' .
+ sqimap_asearch_encode_string($what_parts[2], $charset) . ' ';
break;
case 'adate':
$what_parts = sqimap_asearch_parse_date($what);
break;
case 'akeyword':
case 'astring':
- $criteria = $opcode . ' ' . sqimap_asearch_encode_string($what, $search_charset) . ' ';
+ $criteria = $opcode . ' ' . sqimap_asearch_encode_string($what, $charset) . ' ';
break;
case 'asequence':
$what = ereg_replace('[^0-9:\(\)]+', '', $what);
return $criteria;
}
-function sqimap_run_search($imapConnection, $search_string, $search_charset)
+/**
+ * Another way to do array_values(array_unique(array_merge($to, $from)));
+ * @param array $to to array (reference)
+ * @param array $from from array
+ * @return array uniquely merged array
+ */
+function sqimap_array_merge_unique(&$to, $from)
{
- global $allow_charset_search, $uid_support;
+ if (empty($to))
+ return $from;
+ $count = count($from);
+ for ($i = 0; $i < $count; $i++) {
+ if (!in_array($from[$i], $to))
+ $to[] = $from[$i];
+ }
+ return $to;
+}
+/**
+ * Run the imap SEARCH command as defined in rfc 3501
+ * @link http://www.ietf.org/rfc/rfc3501.txt
+ * @param resource $imapConnection the current imap stream
+ * @param string $search_string the full search expression eg "ALL RECENT"
+ * @param string $search_charset charset to use or zls ('')
+ * @return array an IDs or UIDs array of matching messages or an empty array
+ */
+function sqimap_run_search($imapConnection, $search_string, $search_charset)
+{
+ //For some reason, this seems to happen and forbids searching servers not allowing OPTIONAL [CHARSET]
+ if (strtoupper($search_charset) == 'US-ASCII')
+ $search_charset = '';
/* 6.4.4 try OPTIONAL [CHARSET] specification first */
- if ($allow_charset_search && (!empty($search_charset)))
- $ss = 'SEARCH CHARSET ' . strtoupper($search_charset) . ' ALL ' . $search_string;
+ if ($search_charset != '')
+ $query = 'SEARCH CHARSET "' . strtoupper($search_charset) . '" ALL ' . $search_string;
else
- $ss = 'SEARCH ALL ' . $search_string;
- s_debug_dump('O', $ss);
-
- /* read data back from IMAP */
- $readin = sqimap_run_command($imapConnection, $ss, false, $result, $message, $uid_support);
+ $query = 'SEARCH ALL ' . $search_string;
+ s_debug_dump('C:', $query);
+ $readin = sqimap_run_command($imapConnection, $query, false, $response, $message, TRUE);
- /* 6.4.4 try US-ASCII charset if we receive a tagged NO response */
- if (!empty($charset) && strtolower($result) == 'no') {
- $ss = 'SEARCH CHARSET "US-ASCII" ALL ' . $search_string;
- s_debug_dump('O', $ss);
- $readin = sqimap_run_command ($imapConnection, $ss, true, $result, $message); /* no $uid_support? */
+ /* 6.4.4 try US-ASCII charset if we tried an OPTIONAL [CHARSET] and received a tagged NO response (SHOULD be [BADCHARSET]) */
+ if (($search_charset != '') && (strtoupper($response) == 'NO')) {
+ $query = 'SEARCH CHARSET US-ASCII ALL ' . $search_string;
+ s_debug_dump('C:', $query);
+ $readin = sqimap_run_command($imapConnection, $query, false, $response, $message, TRUE);
+ }
+ if (strtoupper($response) != 'OK') {
+ sqimap_asearch_error_box($response, $query, $message);
+ return array();
}
- unset($messagelist);
-
- /* Keep going till we find the SEARCH response */
+ // Keep going till we find the * SEARCH response
foreach ($readin as $readin_part) {
- s_debug_dump('I', $readin_part);
- /* Check to see if a SEARCH response was received */
+ s_debug_dump('S:', $readin_part);
if (substr($readin_part, 0, 9) == '* SEARCH ') {
- $messagelist = preg_split("/ /", substr($readin_part, 9));
- } else if (isset($errors)) {
- $errors = $errors . $readin_part;
- } else {
- $errors = $readin_part;
+ //EIMS returns multiple SEARCH responses, and this allowed according to Mark Crispin
+ $messagelist = sqimap_array_merge_unique($messagelist, preg_split("/ /", substr($readin_part, 9)));
}
}
- /* If nothing is found * SEARCH should be the first error else echo errors */
- if (isset($errors)) {
- if (strstr($errors,'* SEARCH'))
- return array();
- echo '<!-- ' . htmlspecialchars($errors) . ' -->';
+ if (empty($messagelist)) //Empty search response, ie '* SEARCH'
+ return array();
+
+ $cnt = count($messagelist);
+ for ($q = 0; $q < $cnt; $q++)
+ $id[$q] = trim($messagelist[$q]);
+ return $id;
+}
+
+/**
+ * Run the imap SORT command as defined in
+ * @link http://www.ietf.org/internet-drafts/draft-ietf-imapext-sort-13.txt
+ * @param resource $imapConnection the current imap stream
+ * @param string $search_string the full search expression as defined in rfc 3501
+ * @param string $search_charset mandatory charset
+ * @param string $sort_criteria the full sort criteria expression eg "SUBJECT REVERSE DATE"
+ * @return array an IDs or UIDs array of matching messages or an empty array
+ */
+function sqimap_run_sort($imapConnection, $search_string, $search_charset, $sort_criteria)
+{
+ if ($search_charset == '')
+ $search_charset = 'US-ASCII';
+ $query = 'SORT (' . $sort_criteria . ') "' . strtoupper($search_charset) . '" ALL ' . $search_string;
+ s_debug_dump('C:', $query);
+ $readin = sqimap_run_command($imapConnection, $query, false, $response, $message, TRUE);
+ s_debug_dump('S:', $response);
+
+ /* 6.4 try US-ASCII charset if we received a tagged NO response (SHOULD be [BADCHARSET]) */
+ if (($search_charset != 'US-ASCII') && (strtoupper($response) == 'NO')) {
+ s_debug_dump('S:', $readin);
+ $query = 'SORT (' . $sort_criteria . ') US-ASCII ALL ' . $search_string;
+ s_debug_dump('C:', $query);
+ $readin = sqimap_run_command($imapConnection, $query, false, $response, $message, TRUE);
+ s_debug_dump('S:', $response);
+ }
+
+ if (strtoupper($response) != 'OK') {
+ s_debug_dump('S:', $readin);
+// sqimap_asearch_error_box($response, $query, $message);
+// return array();
+ return sqimap_run_search($imapConnection, $search_string, $search_charset); // Fell back to standard search
+ }
+
+ /* Keep going till we find the * SORT response */
+ foreach ($readin as $readin_part) {
+ s_debug_dump('S:', $readin_part);
+ if (substr($readin_part, 0, 7) == '* SORT ') {
+ //SORT returns untagged responses
+ $messagelist = sqimap_array_merge_unique($messagelist, preg_split("/ /", substr($readin_part, 7)));
+ }
}
- if (empty($messagelist))
+ if (empty($messagelist)) //Empty search response, ie '* SORT'
return array();
$cnt = count($messagelist);
return $id;
}
-/* replaces $mbox_msgs[$search_mailbox] = array_values(array_unique(array_merge($mbox_msgs[$search_mailbox], sqimap_run_search($imapConnection, $search_string, $search_charset))));*/
-function sqimap_array_merge_unique($to, $from)
+/**
+ * Run the imap THREAD command as defined in
+ * @link http://www.ietf.org/internet-drafts/draft-ietf-imapext-sort-13.txt
+ * @param resource $imapConnection the current imap stream
+ * @param string $search_string the full search expression as defined in rfc 3501
+ * @param string $search_charset mandatory charset
+ * @param string $thread_algorithm the threading algorithm "ORDEREDSUBJECT" or "REFERENCES"
+ * @return array an IDs or UIDs array of matching messages or an empty array
+ * @global array thread_new will be used by thread view in mailbox_display
+ * @global array server_sort_array will be used by thread view in mailbox_display
+ */
+function sqimap_run_thread($imapConnection, $search_string, $search_charset, $thread_algorithm)
{
- if (empty($to))
- return $from;
- for ($i=0; $i<count($from); $i++) {
- if (!in_array($from[$i], $to))
- $to[] = $from[$i];
+ global $thread_new, $server_sort_array;
+
+ if (sqsession_is_registered('thread_new'))
+ sqsession_unregister('thread_new');
+ if (sqsession_is_registered('server_sort_array'))
+ sqsession_unregister('server_sort_array');
+
+ $thread_new = array();
+ $thread_new[0] = "";
+
+ $server_sort_array = array();
+
+ if ($search_charset == '')
+ $search_charset = 'US-ASCII';
+ $query = 'THREAD ' . $thread_algorithm . ' "' . strtoupper($search_charset) . '" ALL ' . $search_string;
+ s_debug_dump('C:', $query);
+ $readin = sqimap_run_command($imapConnection, $query, false, $response, $message, TRUE);
+ s_debug_dump('S:', $response);
+
+ /* 6.4 try US-ASCII charset if we received a tagged NO response (SHOULD be [BADCHARSET]) */
+ if (($search_charset != 'US-ASCII') && (strtoupper($response) == 'NO')) {
+ s_debug_dump('S:', $readin);
+ $query = 'THREAD ' . $thread_algorithm . ' US-ASCII ALL ' . $search_string;
+ s_debug_dump('C:', $query);
+ $readin = sqimap_run_command($imapConnection, $query, false, $response, $message, TRUE);
+ s_debug_dump('S:', $response);
}
- return $to;
+
+ if (strtoupper($response) != 'OK') {
+ s_debug_dump('S:', $readin);
+ if (empty($response)) { //imap server closed connection. We can't go further.
+/* we should at this point:
+ - warn the user that the THREAD call has failed
+ - (offer him a way to) disconnect it permanently in the prefs
+ - perform the regular search instead or provide a way to do it in one click
+*/
+ global $sort, $mailbox, $php_self;
+ $message = _("The imap server failed to handle threading.");
+ $unthread = _("Click here to unset thread view for this mailbox and start again.");
+ if (preg_match('/^(.+)\?.+$/', $php_self, $regs))
+ $source_url = $regs[1];
+ else
+ $source_url = $php_self;
+ $link = '<a href=' . $source_url . '?sort=' . $sort . '&start_messages=1&set_thread=0&mailbox=' . urlencode($mailbox) . '>' . $unthread . '</a>';
+ sqimap_asearch_error_box($response, $query, $message, $link);
+ return array();
+ }
+ return sqimap_run_search($imapConnection, $search_string, $search_charset); // Fell back to standard search
+ }
+
+ /* Keep going till we find the * THREAD response */
+ foreach ($readin as $readin_part) {
+ s_debug_dump('S:', $readin_part);
+ if (substr($readin_part, 0, 9) == '* THREAD ') {
+ $thread_temp = preg_split("//", substr($readin_part, 9), -1, PREG_SPLIT_NO_EMPTY);
+ break; // Should be the last anyway
+ }
+ }
+
+ if (empty($thread_temp)) //Empty search response, ie '* THREAD'
+ return array();
+
+ $char_count = count($thread_temp);
+ $counter = 0;
+ $k = 0;
+ for ($i=0;$i<$char_count;$i++) {
+ if ($thread_temp[$i] != ')' && $thread_temp[$i] != '(') {
+ $thread_new[$k] = $thread_new[$k] . $thread_temp[$i];
+ }
+ elseif ($thread_temp[$i] == '(') {
+ $thread_new[$k] .= $thread_temp[$i];
+ $counter++;
+ }
+ elseif ($thread_temp[$i] == ')') {
+ if ($counter > 1) {
+ $thread_new[$k] .= $thread_temp[$i];
+ $counter = $counter - 1;
+ }
+ else {
+ $thread_new[$k] .= $thread_temp[$i];
+ $k++;
+ $thread_new[$k] = "";
+ $counter = $counter - 1;
+ }
+ }
+ }
+ sqsession_register($thread_new, 'thread_new');
+ $thread_new = array_reverse($thread_new);
+ $thread_list = implode(" ", $thread_new);
+ $thread_list = str_replace("(", " ", $thread_list);
+ $thread_list = str_replace(")", " ", $thread_list);
+ $thread_list = preg_split("/\s/", $thread_list, -1, PREG_SPLIT_NO_EMPTY);
+ $server_sort_array = $thread_list;
+ sqsession_register($server_sort_array, 'server_sort_array');
+ return $thread_list;
}
-function sqimap_asearch($imapConnection, $mailbox_array, $biop_array, $unop_array, $where_array, $what_array, $exclude_array, $mboxes_array)
+/**
+ * @global bool allow_charset_search user setting
+ * @global array languages sm languages array
+ * @global string squirrelmail_language user language setting
+ * @return string the user defined charset if $allow_charset_search is TRUE else zls ('')
+ */
+function sqimap_asearch_get_charset()
{
- global $languages, $squirrelmail_language;
+ global $allow_charset_search, $languages, $squirrelmail_language;
-/* ??? what are those for ?? */
-/* $pos = $search_position;*/
+ if ($allow_charset_search)
+ return $languages[$squirrelmail_language]['CHARSET'];
+ return '';
+}
+/**
+ * Convert sm internal sort to imap sort taking care of:
+ * - user defined date sorting (ARRIVAL vs DATE)
+ * - if the searched mailbox is the sent folder then TO is being used instead of FROM
+ * - reverse order by using REVERSE
+ * @param string $mailbox mailbox name to sort
+ * @param integer $sort_by sm sort criteria index
+ * @global bool internal_date_sort sort by arrival date instead of message date
+ * @global string sent_folder sent folder name
+ * @return string imap sort criteria
+ */
+function sqimap_asearch_get_sort_criteria($mailbox, $sort_by)
+{
+ global $internal_date_sort, $sent_folder;
+
+ $sort_opcodes = array ('DATE', 'FROM', 'SUBJECT', 'SIZE');
+ if ($internal_date_sort == true)
+ $sort_opcodes[0] = 'ARRIVAL';
+// if (handleAsSent($mailbox))
+// if (isSentFolder($mailbox))
+ if ($mailbox == $sent_folder)
+ $sort_opcodes[1] = 'TO';
+ return (($sort_by % 2) ? '' : 'REVERSE ') . $sort_opcodes[($sort_by >> 1) & 3];
+}
+
+/**
+ * @param string $cur_mailbox unformatted mailbox name
+ * @param array $boxes_unformatted selectable mailbox unformatted names array (reference)
+ * @return array sub mailboxes unformatted names
+ */
+function sqimap_asearch_get_sub_mailboxes($cur_mailbox, &$mboxes_array)
+{
+ $sub_mboxes_array = array();
+ $boxcount = count($mboxes_array);
+ for ($boxnum=0; $boxnum < $boxcount; $boxnum++) {
+ if (isBoxBelow($mboxes_array[$boxnum], $cur_mailbox))
+ $sub_mboxes_array[] = $mboxes_array[$boxnum];
+ }
+ return $sub_mboxes_array;
+}
+
+/**
+ * Performs the search, given all the criteria, merging results for every mailbox
+ * @param resource $imapConnection
+ * @param array $mailbox_array (reference)
+ * @param array $biop_array (reference)
+ * @param array $unop_array (reference)
+ * @param array $where_array (reference)
+ * @param array $what_array (reference)
+ * @param array $exclude_array (reference)
+ * @param array $sub_array (reference)
+ * @param array $mboxes_array selectable unformatted mailboxes names (reference)
+ * @global bool allow_server_sort comes from config.php
+ * @global integer sort sm internal sort order
+ * @global bool allow_thread_sort comes from config.php
+ * @global bool thread_sort_messages does it really need to global?
+ * @global integer sort_by_ref thread by references
+ * @global string data_dir
+ * @global string username
+ * @return array array(mailbox => array(UIDs))
+ */
+function sqimap_asearch($imapConnection, &$mailbox_array, &$biop_array, &$unop_array, &$where_array, &$what_array, &$exclude_array, &$sub_array, &$mboxes_array)
+{
+ global $allow_server_sort, $sort, $allow_thread_sort, $thread_sort_messages, $sort_by_ref;
+ global $data_dir, $username;
+
+ $search_charset = sqimap_asearch_get_charset();
$mbox_msgs = array();
- $search_charset = $languages[$squirrelmail_language]['CHARSET'];
$search_string = '';
$cur_mailbox = $mailbox_array[0];
$cur_biop = ''; /* Start with ALL */
$next_mailbox = $mailbox_array[$cur_crit];
if ($next_mailbox != $cur_mailbox) {
$search_string = trim($search_string); /* Trim out last space */
- if (($cur_mailbox == 'All Folders') && (!empty($mboxes_array)))
- $search_mboxes = $mboxes_array;
+ if ($cur_mailbox == 'All Folders')
+ $search_mboxes = $mboxes_array;
+ else if ((!empty($sub_array[$cur_crit - 1])) || (!in_array($cur_mailbox, $mboxes_array)))
+ $search_mboxes = sqimap_asearch_get_sub_mailboxes($cur_mailbox, $mboxes_array);
else
$search_mboxes = array($cur_mailbox);
foreach ($search_mboxes as $cur_mailbox) {
+ s_debug_dump('C:SELECT:', $cur_mailbox);
sqimap_mailbox_select($imapConnection, $cur_mailbox);
- s_debug_dump('SELECT',$cur_mailbox);
+ $thread_sort_messages = $allow_thread_sort && getPref($data_dir, $username, 'thread_' . $cur_mailbox);
+ if ($thread_sort_messages) {
+ if ($sort_by_ref == 1)
+ $thread_algorithm = 'REFERENCES';
+ else
+ $thread_algorithm = 'ORDEREDSUBJECT';
+ $found_msgs = sqimap_run_thread($imapConnection, $search_string, $search_charset, $thread_algorithm);
+ }
+ else
+ if (($allow_server_sort) && ($sort < 6)) {
+ $sort_criteria = sqimap_asearch_get_sort_criteria($cur_mailbox, $sort);
+ $found_msgs = sqimap_run_sort($imapConnection, $search_string, $search_charset, $sort_criteria);
+ }
+ else
+ $found_msgs = sqimap_run_search($imapConnection, $search_string, $search_charset);
if (isset($mbox_msgs[$cur_mailbox])) {
if ($cur_biop == 'OR') /* Merge with previous results */
- $mbox_msgs[$cur_mailbox] = sqimap_array_merge_unique($mbox_msgs[$cur_mailbox], sqimap_run_search($imapConnection, $search_string, $search_charset));
+ $mbox_msgs[$cur_mailbox] = sqimap_array_merge_unique($mbox_msgs[$cur_mailbox], $found_msgs);
else /* Intersect previous results */
- $mbox_msgs[$cur_mailbox] = array_values(array_intersect(sqimap_run_search($imapConnection, $search_string, $search_charset), $mbox_msgs[$cur_mailbox]));
+ $mbox_msgs[$cur_mailbox] = array_values(array_intersect($found_msgs, $mbox_msgs[$cur_mailbox]));
}
else /* No previous results */
- $mbox_msgs[$cur_mailbox] = sqimap_run_search($imapConnection, $search_string, $search_charset);
+ $mbox_msgs[$cur_mailbox] = $found_msgs;
if (empty($mbox_msgs[$cur_mailbox])) /* Can happen with intersect, and we need at the end a contiguous array */
unset($mbox_msgs[$cur_mailbox]);
}
return $mbox_msgs;
}
-?>
\ No newline at end of file
+?>