6 * IMAP asearch routines
8 * Subfolder search idea from Patch #806075 by Thomas Pohl xraven at users.sourceforge.net. Thanks Thomas!
10 * @author Alex Lemaresquier - Brainstorm <alex at brainstorm.fr>
11 * @copyright © 1999-2007 The SquirrelMail Project Team
12 * @license http://opensource.org/licenses/gpl-license.php GNU Public License
14 * @package squirrelmail
17 * @link http://www.ietf.org/rfc/rfc3501.txt
20 /** This functionality requires the IMAP and date functions
22 //require_once(SM_PATH . 'functions/imap_general.php');
23 //require_once(SM_PATH . 'functions/date.php');
25 /** Set to TRUE to dump the IMAP dialogue
26 * @global bool $imap_asearch_debug_dump
28 $imap_asearch_debug_dump = FALSE;
31 * @global array $imap_asearch_opcodes
33 global $imap_asearch_opcodes;
34 $imap_asearch_opcodes = array(
35 /* <sequence-set> => 'asequence', */ // Special handling, @see sqimap_asearch_build_criteria()
36 /*'ALL' is binary operator */
46 'HEADER' => 'afield', // Special syntax for this one, @see sqimap_asearch_build_criteria()
47 'KEYWORD' => 'akeyword',
50 /*'NOT' is unary operator */
53 /*'OR' is binary operator */
56 'SENTBEFORE' => 'adate',
58 'SENTSINCE' => 'adate',
61 'SUBJECT' => 'astring',
69 'UNKEYWORD' => 'akeyword',
73 /** IMAP SEARCH month names encoding
74 * @global array $imap_asearch_months
76 $imap_asearch_months = array(
92 * Function to display an error related to an IMAP query.
93 * We need to do our own error management since we may receive NO responses on purpose (even BAD with SORT or THREAD)
94 * so we call sqimap_error_box() if the function exists (sm >= 1.5) or use our own embedded code
95 * @global array imap_error_titles
96 * @param string $response the imap server response code
97 * @param string $query the failed query
98 * @param string $message an optional error message
99 * @param string $link an optional link to try again
101 //@global array color sm colors array
102 function sqimap_asearch_error_box($response, $query, $message, $link = '')
105 // Error message titles according to IMAP server returned code
106 $imap_error_titles = array(
108 'NO' => _("ERROR: Could not complete request."),
109 'BAD' => _("ERROR: Bad or malformed request."),
110 'BYE' => _("ERROR: IMAP server closed the connection."),
111 '' => _("ERROR: Connection dropped by IMAP server.")
115 if (!array_key_exists($response, $imap_error_titles))
116 $title = _("ERROR: Unknown IMAP response.");
118 $title = $imap_error_titles[$response];
120 $message_title = _("Reason Given:");
122 $message_title = _("Possible reason:");
123 $message_title .= ' ';
124 sqimap_error_box($title, $query, $message_title, $message, $link);
128 * This is a convenient way to avoid spreading if (isset(... all over the code
129 * @param mixed $var any variable (reference)
130 * @param mixed $def default value to return if unset (default is zls (''), pass 0 or array() when appropriate)
131 * @return mixed $def if $var is unset, otherwise $var
133 function asearch_nz(&$var, $def = '')
141 * This should give the same results as PHP 4 >= 4.3.0's html_entity_decode(),
142 * except it doesn't handle hex constructs
143 * @param string $string string to unhtmlentity()
144 * @return string decoded string
146 function asearch_unhtmlentities($string) {
147 $trans_tbl = array_flip(get_html_translation_table(HTML_ENTITIES
));
148 for ($i=127; $i<255; $i++
) /* Add &#<dec>; entities */
149 $trans_tbl['&#' . $i . ';'] = chr($i);
150 return strtr($string, $trans_tbl);
151 /* I think the one above is quicker, though it should be benchmarked
152 $string = strtr($string, array_flip(get_html_translation_table(HTML_ENTITIES)));
153 return preg_replace("/&#([0-9]+);/E", "chr('\\1')", $string);
157 /** Encode a string to quoted or literal as defined in rfc 3501
160 * A quoted string is a sequence of zero or more 7-bit characters,
161 * excluding CR and LF, with double quote (<">) characters at each end.
162 * - 9. Formal Syntax:
163 * quoted-specials = DQUOTE / "\"
164 * @param string $what string to encode
165 * @param string $charset search charset used
166 * @return string encoded string
168 function sqimap_asearch_encode_string($what, $charset)
170 if (strtoupper($charset) == 'ISO-2022-JP') // This should be now handled in imap_utf7_local?
171 $what = mb_convert_encoding($what, 'JIS', 'auto');
172 if (preg_match('/["\\\\\r\n\x80-\xff]/', $what))
173 return '{' . strlen($what) . "}\r\n" . $what; // 4.3 literal form
174 return '"' . $what . '"'; // 4.3 quoted string form
178 * Parses a user date string into an rfc 3501 date string
179 * Handles space, slash, backslash, dot and comma as separators (and dash of course ;=)
180 * @global array imap_asearch_months
181 * @param string user date
182 * @return array a preg_match-style array:
183 * - [0] = fully formatted rfc 3501 date string (<day number>-<US month TLA>-<4 digit year>)
188 function sqimap_asearch_parse_date($what)
190 global $imap_asearch_months;
193 $what = ereg_replace('[ /\\.,]+', '-', $what);
195 preg_match('/^([0-9]+)-+([^\-]+)-+([0-9]+)$/', $what, $what_parts);
196 if (count($what_parts) == 4) {
197 $what_month = strtolower(asearch_unhtmlentities($what_parts[2]));
198 /* if (!in_array($what_month, $imap_asearch_months)) {*/
199 foreach ($imap_asearch_months as $month_number => $month_code) {
200 if (($what_month == $month_number)
201 ||
($what_month == $month_code)
202 ||
($what_month == strtolower(asearch_unhtmlentities(getMonthName($month_number))))
203 ||
($what_month == strtolower(asearch_unhtmlentities(getMonthAbrv($month_number))))
205 $what_parts[2] = $month_number;
206 $what_parts[0] = $what_parts[1] . '-' . $month_code . '-' . $what_parts[3];
214 $what_parts = array();
219 * Build one criteria sequence
220 * @global array imap_asearch_opcodes
221 * @param string $opcode search opcode
222 * @param string $what opcode argument
223 * @param string $charset search charset
224 * @return string one full criteria sequence
226 function sqimap_asearch_build_criteria($opcode, $what, $charset)
228 global $imap_asearch_opcodes;
231 switch ($imap_asearch_opcodes[$opcode]) {
234 $what = str_replace(' ', '', $what);
235 $what = ereg_replace('[^0-9]+[^KMG]$', '', strtoupper($what));
237 switch (substr($what, -1)) {
239 $what = substr($what, 0, -1) << 30;
242 $what = substr($what, 0, -1) << 20;
245 $what = substr($what, 0, -1) << 10;
248 $criteria = $opcode . ' ' . $what . ' ';
252 $criteria = $opcode . ' ';
254 case 'afield': /* HEADER field-name: field-body */
255 preg_match('/^([^:]+):(.*)$/', $what, $what_parts);
256 if (count($what_parts) == 3)
257 $criteria = $opcode . ' ' .
258 sqimap_asearch_encode_string($what_parts[1], $charset) . ' ' .
259 sqimap_asearch_encode_string($what_parts[2], $charset) . ' ';
262 $what_parts = sqimap_asearch_parse_date($what);
263 if (isset($what_parts[0]))
264 $criteria = $opcode . ' ' . $what_parts[0] . ' ';
268 $criteria = $opcode . ' ' . sqimap_asearch_encode_string($what, $charset) . ' ';
271 $what = ereg_replace('[^0-9:\(\)]+', '', $what);
273 $criteria = $opcode . ' ' . $what . ' ';
280 * Another way to do array_values(array_unique(array_merge($to, $from)));
281 * @param array $to to array (reference)
282 * @param array $from from array
283 * @return array uniquely merged array
285 function sqimap_array_merge_unique(&$to, $from)
289 $count = count($from);
290 for ($i = 0; $i < $count; $i++
) {
291 if (!in_array($from[$i], $to))
298 * Run the IMAP SEARCH command as defined in rfc 3501
299 * @link http://www.ietf.org/rfc/rfc3501.txt
300 * @param resource $imapConnection the current imap stream
301 * @param string $search_string the full search expression eg "ALL RECENT"
302 * @param string $search_charset charset to use or zls ('')
303 * @return array an IDs or UIDs array of matching messages or an empty array
306 function sqimap_run_search($imapConnection, $search_string, $search_charset)
308 //For some reason, this seems to happen and forbids searching servers not allowing OPTIONAL [CHARSET]
309 if (strtoupper($search_charset) == 'US-ASCII')
310 $search_charset = '';
311 /* 6.4.4 try OPTIONAL [CHARSET] specification first */
312 if ($search_charset != '')
313 $query = 'SEARCH CHARSET "' . strtoupper($search_charset) . '" ' . $search_string;
315 $query = 'SEARCH ' . $search_string;
316 $readin = sqimap_run_command_list($imapConnection, $query, false, $response, $message, TRUE);
318 /* 6.4.4 try US-ASCII charset if we tried an OPTIONAL [CHARSET] and received a tagged NO response (SHOULD be [BADCHARSET]) */
319 if (($search_charset != '') && (strtoupper($response) == 'NO')) {
320 $query = 'SEARCH CHARSET US-ASCII ' . $search_string;
321 $readin = sqimap_run_command_list($imapConnection, $query, false, $response, $message, TRUE);
323 if (strtoupper($response) != 'OK') {
324 sqimap_asearch_error_box($response, $query, $message);
327 $messagelist = parseUidList($readin,'SEARCH');
329 if (empty($messagelist)) //Empty search response, ie '* SEARCH'
332 $cnt = count($messagelist);
333 for ($q = 0; $q < $cnt; $q++
)
334 $id[$q] = trim($messagelist[$q]);
339 * @global bool allow_charset_search user setting
340 * @global array languages sm languages array
341 * @global string squirrelmail_language user language setting
342 * @return string the user defined charset if $allow_charset_search is TRUE else zls ('')
344 function sqimap_asearch_get_charset()
346 global $allow_charset_search, $languages, $squirrelmail_language;
348 if ($allow_charset_search)
349 return $languages[$squirrelmail_language]['CHARSET'];
354 * Convert SquirrelMail internal sort to IMAP sort taking care of:
355 * - user defined date sorting (ARRIVAL vs DATE)
356 * - if the searched mailbox is the sent folder then TO is being used instead of FROM
357 * - reverse order by using REVERSE
358 * @param string $mailbox mailbox name to sort
359 * @param integer $sort_by sm sort criteria index
360 * @global bool internal_date_sort sort by arrival date instead of message date
361 * @global string sent_folder sent folder name
362 * @return string imap sort criteria
364 function sqimap_asearch_get_sort_criteria($mailbox, $sort_by)
366 global $internal_date_sort, $sent_folder;
368 $sort_opcodes = array ('DATE', 'FROM', 'SUBJECT', 'SIZE');
369 if ($internal_date_sort == true)
370 $sort_opcodes[0] = 'ARRIVAL';
371 // if (handleAsSent($mailbox))
372 // if (isSentFolder($mailbox))
373 if ($mailbox == $sent_folder)
374 $sort_opcodes[1] = 'TO';
375 return (($sort_by %
2) ?
'' : 'REVERSE ') . $sort_opcodes[($sort_by >> 1) & 3];
379 * @param string $cur_mailbox unformatted mailbox name
380 * @param array $boxes_unformatted selectable mailbox unformatted names array (reference)
381 * @return array sub mailboxes unformatted names
383 function sqimap_asearch_get_sub_mailboxes($cur_mailbox, &$mboxes_array)
385 $sub_mboxes_array = array();
386 $boxcount = count($mboxes_array);
387 for ($boxnum=0; $boxnum < $boxcount; $boxnum++
) {
388 if (isBoxBelow($mboxes_array[$boxnum], $cur_mailbox))
389 $sub_mboxes_array[] = $mboxes_array[$boxnum];
391 return $sub_mboxes_array;
395 * Create the search query strings for all given criteria and merge results for every mailbox
396 * @param resource $imapConnection
397 * @param array $mailbox_array (reference)
398 * @param array $biop_array (reference)
399 * @param array $unop_array (reference)
400 * @param array $where_array (reference)
401 * @param array $what_array (reference)
402 * @param array $exclude_array (reference)
403 * @param array $sub_array (reference)
404 * @param array $mboxes_array selectable unformatted mailboxes names (reference)
405 * @return array array(mailbox => array(UIDs))
407 function sqimap_asearch($imapConnection, &$mailbox_array, &$biop_array, &$unop_array, &$where_array, &$what_array, &$exclude_array, &$sub_array, &$mboxes_array)
410 $search_charset = sqimap_asearch_get_charset();
411 $mbox_search = array();
413 $cur_mailbox = $mailbox_array[0];
414 $cur_biop = ''; /* Start with ALL */
415 /* We loop one more time than the real array count, so the last search gets fired */
416 for ($cur_crit=0,$iCnt=count($where_array); $cur_crit <= $iCnt; ++
$cur_crit) {
417 if (empty($exclude_array[$cur_crit])) {
418 $next_mailbox = (isset($mailbox_array[$cur_crit])) ?
$mailbox_array[$cur_crit] : false;
419 if ($next_mailbox != $cur_mailbox) {
420 $search_string = trim($search_string); /* Trim out last space */
421 if ($cur_mailbox == 'All Folders')
422 $search_mboxes = $mboxes_array;
423 else if ((!empty($sub_array[$cur_crit - 1])) ||
(!in_array($cur_mailbox, $mboxes_array)))
424 $search_mboxes = sqimap_asearch_get_sub_mailboxes($cur_mailbox, $mboxes_array);
426 $search_mboxes = array($cur_mailbox);
427 foreach ($search_mboxes as $cur_mailbox) {
428 if (isset($mbox_search[$cur_mailbox])) {
429 $mbox_search[$cur_mailbox]['search'] .= ' ' . $search_string;
431 $mbox_search[$cur_mailbox]['search'] = $search_string;
433 $mbox_search[$cur_mailbox]['charset'] = $search_charset;
435 $cur_mailbox = $next_mailbox;
438 if (isset($where_array[$cur_crit]) && empty($exclude_array[$cur_crit])) {
439 $aCriteria = array();
440 for ($crit = $cur_crit; $crit < count($where_array); $crit++
) {
441 $criteria = trim(sqimap_asearch_build_criteria($where_array[$crit], $what_array[$crit], $search_charset));
442 if (!empty($criteria) && empty($exclude_array[$crit])) {
443 if (asearch_nz($mailbox_array[$crit]) == $cur_mailbox) {
444 $unop = $unop_array[$crit];
446 $criteria = $unop . ' ' . $criteria;
448 $aCriteria[] = array($biop_array[$crit], $criteria);
452 $exclude_array[$crit] = true;
455 for($i=0,$iCnt=count($aCriteria);$i<$iCnt;++
$i) {
456 $cur_biop = $aCriteria[$i][0];
457 $next_biop = (isset($aCriteria[$i+
1][0])) ?
$aCriteria[$i+
1][0] : false;
458 if ($next_biop != $cur_biop && $next_biop == 'OR') {
459 $aSearch[] = 'OR '.$aCriteria[$i][1];
460 } else if ($cur_biop != 'OR') {
461 $aSearch[] = 'ALL '.$aCriteria[$i][1];
462 } else { // OR only supports 2 search keys so we need to create a parenthesized list
463 $prev_biop = (isset($aCriteria[$i-1][0])) ?
$aCriteria[$i-1][0] : false;
464 if ($prev_biop == $cur_biop) {
465 $last = $aSearch[$i-1];
466 if (!substr($last,-1) == ')') {
467 $aSearch[$i-1] = "(OR $last";
468 $aSearch[] = $aCriteria[$i][1].')';
471 while ($last && substr($last,-1) == ')') {
472 $last = substr($last,0,-1);
475 $aSearch[$i-1] = "(OR $last";
476 $aSearch[] = $aCriteria[$i][1].$sEnd.')';
479 $aSearch[] = $aCriteria[$i][1];
483 $search_string .= implode(' ',$aSearch);
487 return ($mbox_search);