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-2005 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 if (function_exists('sqimap_error_box'))
125 sqimap_error_box($title, $query, $message_title, $message, $link);
126 else { //Straight copy of 1.5 imap_general.php:sqimap_error_box(). Can be removed at a later time
128 require_once(SM_PATH
. 'functions/display_messages.php');
129 $string = "<font color=\"$color[2]\"><b>\n" . $title . "</b><br />\n";
131 $string .= _("Query:") . ' ' . htmlspecialchars($query) . '<br />';
132 if ($message_title != '')
133 $string .= $message_title;
135 $string .= htmlspecialchars($message);
138 $string .= "</font><br />\n";
139 error_box($string,$color);
144 * This is a convenient way to avoid spreading if (isset(... all over the code
145 * @param mixed $var any variable (reference)
146 * @param mixed $def default value to return if unset (default is zls (''), pass 0 or array() when appropriate)
147 * @return mixed $def if $var is unset, otherwise $var
149 function asearch_nz(&$var, $def = '')
157 * This should give the same results as PHP 4 >= 4.3.0's html_entity_decode(),
158 * except it doesn't handle hex constructs
159 * @param string $string string to unhtmlentity()
160 * @return string decoded string
162 function asearch_unhtmlentities($string) {
163 $trans_tbl = array_flip(get_html_translation_table(HTML_ENTITIES
));
164 for ($i=127; $i<255; $i++
) /* Add &#<dec>; entities */
165 $trans_tbl['&#' . $i . ';'] = chr($i);
166 return strtr($string, $trans_tbl);
167 /* I think the one above is quicker, though it should be benchmarked
168 $string = strtr($string, array_flip(get_html_translation_table(HTML_ENTITIES)));
169 return preg_replace("/&#([0-9]+);/E", "chr('\\1')", $string);
174 * Provide an easy way to dump the IMAP dialogue if $imap_asearch_debug_dump is TRUE
175 * @global bool imap_asearch_debug_dump
176 * @param string $var_name
177 * @param string $var_var
178 * @deprecated contains workarounds for 1.4.0 and older code.
179 * code without workarounds uses regular sm 1.4.2+ functions.
180 * it is not compatible with 1.4.1
181 * @todo remove debugging function
183 function s_debug_dump($var_name, $var_var)
185 global $imap_asearch_debug_dump;
186 if ($imap_asearch_debug_dump) {
187 if (function_exists('sm_print_r')) //Only exists since 1.4.2
188 sm_print_r($var_name, $var_var); //Better be the 'varargs' version ;)
191 echo htmlentities($var_name);
198 /** Encode a string to quoted or literal as defined in rfc 3501
201 * A quoted string is a sequence of zero or more 7-bit characters,
202 * excluding CR and LF, with double quote (<">) characters at each end.
203 * - 9. Formal Syntax:
204 * quoted-specials = DQUOTE / "\"
205 * @param string $what string to encode
206 * @param string $charset search charset used
207 * @return string encoded string
209 function sqimap_asearch_encode_string($what, $charset)
211 if (strtoupper($charset) == 'ISO-2022-JP') // This should be now handled in imap_utf7_local?
212 $what = mb_convert_encoding($what, 'JIS', 'auto');
213 if (preg_match('/["\\\\\r\n\x80-\xff]/', $what))
214 return '{' . strlen($what) . "}\r\n" . $what; // 4.3 literal form
215 return '"' . $what . '"'; // 4.3 quoted string form
219 * Parses a user date string into an rfc 3501 date string
220 * Handles space, slash, backslash, dot and comma as separators (and dash of course ;=)
221 * @global array imap_asearch_months
222 * @param string user date
223 * @return array a preg_match-style array:
224 * - [0] = fully formatted rfc 3501 date string (<day number>-<US month TLA>-<4 digit year>)
229 function sqimap_asearch_parse_date($what)
231 global $imap_asearch_months;
234 $what = ereg_replace('[ /\\.,]+', '-', $what);
236 preg_match('/^([0-9]+)-+([^\-]+)-+([0-9]+)$/', $what, $what_parts);
237 if (count($what_parts) == 4) {
238 $what_month = strtolower(asearch_unhtmlentities($what_parts[2]));
239 /* if (!in_array($what_month, $imap_asearch_months)) {*/
240 foreach ($imap_asearch_months as $month_number => $month_code) {
241 if (($what_month == $month_number)
242 ||
($what_month == $month_code)
243 ||
($what_month == strtolower(asearch_unhtmlentities(getMonthName($month_number))))
244 ||
($what_month == strtolower(asearch_unhtmlentities(getMonthAbrv($month_number))))
246 $what_parts[2] = $month_number;
247 $what_parts[0] = $what_parts[1] . '-' . $month_code . '-' . $what_parts[3];
255 $what_parts = array();
260 * Build one criteria sequence
261 * @global array imap_asearch_opcodes
262 * @param string $opcode search opcode
263 * @param string $what opcode argument
264 * @param string $charset search charset
265 * @return string one full criteria sequence
267 function sqimap_asearch_build_criteria($opcode, $what, $charset)
269 global $imap_asearch_opcodes;
272 switch ($imap_asearch_opcodes[$opcode]) {
275 $what = str_replace(' ', '', $what);
276 $what = ereg_replace('[^0-9]+[^KMG]$', '', strtoupper($what));
278 switch (substr($what, -1)) {
280 $what = substr($what, 0, -1) << 30;
283 $what = substr($what, 0, -1) << 20;
286 $what = substr($what, 0, -1) << 10;
289 $criteria = $opcode . ' ' . $what . ' ';
293 $criteria = $opcode . ' ';
295 case 'afield': /* HEADER field-name: field-body */
296 preg_match('/^([^:]+):(.*)$/', $what, $what_parts);
297 if (count($what_parts) == 3)
298 $criteria = $opcode . ' ' .
299 sqimap_asearch_encode_string($what_parts[1], $charset) . ' ' .
300 sqimap_asearch_encode_string($what_parts[2], $charset) . ' ';
303 $what_parts = sqimap_asearch_parse_date($what);
304 if (isset($what_parts[0]))
305 $criteria = $opcode . ' ' . $what_parts[0] . ' ';
309 $criteria = $opcode . ' ' . sqimap_asearch_encode_string($what, $charset) . ' ';
312 $what = ereg_replace('[^0-9:\(\)]+', '', $what);
314 $criteria = $opcode . ' ' . $what . ' ';
321 * Another way to do array_values(array_unique(array_merge($to, $from)));
322 * @param array $to to array (reference)
323 * @param array $from from array
324 * @return array uniquely merged array
326 function sqimap_array_merge_unique(&$to, $from)
330 $count = count($from);
331 for ($i = 0; $i < $count; $i++
) {
332 if (!in_array($from[$i], $to))
339 * Run the IMAP SEARCH command as defined in rfc 3501
340 * @link http://www.ietf.org/rfc/rfc3501.txt
341 * @param resource $imapConnection the current imap stream
342 * @param string $search_string the full search expression eg "ALL RECENT"
343 * @param string $search_charset charset to use or zls ('')
344 * @return array an IDs or UIDs array of matching messages or an empty array
347 function sqimap_run_search($imapConnection, $search_string, $search_charset)
349 //For some reason, this seems to happen and forbids searching servers not allowing OPTIONAL [CHARSET]
350 if (strtoupper($search_charset) == 'US-ASCII')
351 $search_charset = '';
352 /* 6.4.4 try OPTIONAL [CHARSET] specification first */
353 if ($search_charset != '')
354 $query = 'SEARCH CHARSET "' . strtoupper($search_charset) . '" ' . $search_string;
356 $query = 'SEARCH ' . $search_string;
357 s_debug_dump('C:', $query);
358 $readin = sqimap_run_command($imapConnection, $query, false, $response, $message, TRUE);
360 /* 6.4.4 try US-ASCII charset if we tried an OPTIONAL [CHARSET] and received a tagged NO response (SHOULD be [BADCHARSET]) */
361 if (($search_charset != '') && (strtoupper($response) == 'NO')) {
362 $query = 'SEARCH CHARSET US-ASCII ' . $search_string;
363 s_debug_dump('C:', $query);
364 $readin = sqimap_run_command($imapConnection, $query, false, $response, $message, TRUE);
366 if (strtoupper($response) != 'OK') {
367 sqimap_asearch_error_box($response, $query, $message);
370 $messagelist = parseUidList($readin,'SEARCH');
372 if (empty($messagelist)) //Empty search response, ie '* SEARCH'
375 $cnt = count($messagelist);
376 for ($q = 0; $q < $cnt; $q++
)
377 $id[$q] = trim($messagelist[$q]);
382 * @global bool allow_charset_search user setting
383 * @global array languages sm languages array
384 * @global string squirrelmail_language user language setting
385 * @return string the user defined charset if $allow_charset_search is TRUE else zls ('')
387 function sqimap_asearch_get_charset()
389 global $allow_charset_search, $languages, $squirrelmail_language;
391 if ($allow_charset_search)
392 return $languages[$squirrelmail_language]['CHARSET'];
397 * Convert SquirrelMail internal sort to IMAP sort taking care of:
398 * - user defined date sorting (ARRIVAL vs DATE)
399 * - if the searched mailbox is the sent folder then TO is being used instead of FROM
400 * - reverse order by using REVERSE
401 * @param string $mailbox mailbox name to sort
402 * @param integer $sort_by sm sort criteria index
403 * @global bool internal_date_sort sort by arrival date instead of message date
404 * @global string sent_folder sent folder name
405 * @return string imap sort criteria
407 function sqimap_asearch_get_sort_criteria($mailbox, $sort_by)
409 global $internal_date_sort, $sent_folder;
411 $sort_opcodes = array ('DATE', 'FROM', 'SUBJECT', 'SIZE');
412 if ($internal_date_sort == true)
413 $sort_opcodes[0] = 'ARRIVAL';
414 // if (handleAsSent($mailbox))
415 // if (isSentFolder($mailbox))
416 if ($mailbox == $sent_folder)
417 $sort_opcodes[1] = 'TO';
418 return (($sort_by %
2) ?
'' : 'REVERSE ') . $sort_opcodes[($sort_by >> 1) & 3];
422 * @param string $cur_mailbox unformatted mailbox name
423 * @param array $boxes_unformatted selectable mailbox unformatted names array (reference)
424 * @return array sub mailboxes unformatted names
426 function sqimap_asearch_get_sub_mailboxes($cur_mailbox, &$mboxes_array)
428 $sub_mboxes_array = array();
429 $boxcount = count($mboxes_array);
430 for ($boxnum=0; $boxnum < $boxcount; $boxnum++
) {
431 if (isBoxBelow($mboxes_array[$boxnum], $cur_mailbox))
432 $sub_mboxes_array[] = $mboxes_array[$boxnum];
434 return $sub_mboxes_array;
438 * Create the search query strings for all given criteria and merge results for every mailbox
439 * @param resource $imapConnection
440 * @param array $mailbox_array (reference)
441 * @param array $biop_array (reference)
442 * @param array $unop_array (reference)
443 * @param array $where_array (reference)
444 * @param array $what_array (reference)
445 * @param array $exclude_array (reference)
446 * @param array $sub_array (reference)
447 * @param array $mboxes_array selectable unformatted mailboxes names (reference)
448 * @return array array(mailbox => array(UIDs))
450 function sqimap_asearch($imapConnection, &$mailbox_array, &$biop_array, &$unop_array, &$where_array, &$what_array, &$exclude_array, &$sub_array, &$mboxes_array)
453 $search_charset = sqimap_asearch_get_charset();
454 $mbox_search = array();
456 $cur_mailbox = $mailbox_array[0];
457 $cur_biop = ''; /* Start with ALL */
458 /* We loop one more time than the real array count, so the last search gets fired */
459 for ($cur_crit=0,$iCnt=count($where_array); $cur_crit <= $iCnt; ++
$cur_crit) {
460 if (empty($exclude_array[$cur_crit])) {
461 $next_mailbox = (isset($mailbox_array[$cur_crit])) ?
$mailbox_array[$cur_crit] : false;
462 if ($next_mailbox != $cur_mailbox) {
463 $search_string = trim($search_string); /* Trim out last space */
464 if ($cur_mailbox == 'All Folders')
465 $search_mboxes = $mboxes_array;
466 else if ((!empty($sub_array[$cur_crit - 1])) ||
(!in_array($cur_mailbox, $mboxes_array)))
467 $search_mboxes = sqimap_asearch_get_sub_mailboxes($cur_mailbox, $mboxes_array);
469 $search_mboxes = array($cur_mailbox);
470 foreach ($search_mboxes as $cur_mailbox) {
471 if (isset($mbox_search[$cur_mailbox])) {
472 $mbox_search[$cur_mailbox]['search'] .= ' ' . $search_string;
474 $mbox_search[$cur_mailbox]['search'] = $search_string;
476 $mbox_search[$cur_mailbox]['charset'] = $search_charset;
478 $cur_mailbox = $next_mailbox;
481 if (isset($where_array[$cur_crit]) && empty($exclude_array[$cur_crit])) {
482 for ($crit = $cur_crit; $crit < count($where_array); $crit++
) {
483 $criteria = trim(sqimap_asearch_build_criteria($where_array[$crit], $what_array[$crit], $search_charset));
484 if (!empty($criteria) && empty($exclude_array[$crit])) {
485 if (asearch_nz($mailbox_array[$crit]) == $cur_mailbox) {
486 $unop = $unop_array[$crit];
488 $criteria = $unop . ' ' . $criteria;
490 $aCriteria[] = array($biop_array[$crit], $criteria);
494 $exclude_array[$crit] = true;
497 for($i=0,$iCnt=count($aCriteria);$i<$iCnt;++
$i) {
498 $cur_biop = $aCriteria[$i][0];
499 $next_biop = (isset($aCriteria[$i+
1][0])) ?
$aCriteria[$i+
1][0] : false;
500 if ($next_biop != $cur_biop && $next_biop == 'OR') {
501 $aSearch[] = 'OR '.$aCriteria[$i][1];
502 } else if ($cur_biop != 'OR') {
503 $aSearch[] = 'ALL '.$aCriteria[$i][1];
504 } else { // OR only supports 2 search keys so we need to create a parenthesized list
505 $prev_biop = (isset($aCriteria[$i-1][0])) ?
$aCriteria[$i-1][0] : false;
506 if ($prev_biop == $cur_biop) {
507 $last = $aSearch[$i-1];
508 if (!substr($last,-1) == ')') {
509 $aSearch[$i-1] = "(OR $last";
510 $aSearch[] = $aCriteria[$i][1].')';
513 while ($last && substr($last,-1) == ')') {
514 $last = substr($last,0,-1);
517 $aSearch[$i-1] = "(OR $last";
518 $aSearch[] = $aCriteria[$i][1].$sEnd.')';
521 $aSearch[] = $aCriteria[$i][1];
525 $search_string .= implode(' ',$aSearch);
529 return ($mbox_search);