PageRenderTime 31ms CodeModel.GetById 2ms app.highlight 22ms RepoModel.GetById 1ms app.codeStats 0ms

/branches/DEVEL_MARC/squirrelmail/functions/imap_asearch.php

#
PHP | 527 lines | 344 code | 29 blank | 154 comment | 100 complexity | 7554bb60bcaf4980466a7d3314514b9c MD5 | raw file
  1<?php
  2
  3/**
  4* imap_search.php
  5*
  6* Copyright (c) 1999-2004 The SquirrelMail Project Team
  7* Licensed under the GNU GPL. For full terms see the file COPYING.
  8*
  9* IMAP asearch routines
 10*
 11* Subfolder search idea from Patch #806075 by Thomas Pohl xraven at users.sourceforge.net. Thanks Thomas!
 12*
 13* @version $Id: imap_asearch.php 8458 2004-12-22 23:04:46Z stekkel $
 14* @package squirrelmail
 15* @subpackage imap
 16* @see search.php
 17* @link http://www.ietf.org/rfc/rfc3501.txt
 18* @author Alex Lemaresquier - Brainstorm - alex at brainstorm.fr
 19*/
 20
 21/** This functionality requires the IMAP and date functions
 22*/
 23require_once(SM_PATH . 'functions/imap_general.php');
 24require_once(SM_PATH . 'functions/date.php');
 25
 26/** Set to TRUE to dump the imap dialogue
 27* @global bool $imap_asearch_debug_dump
 28*/
 29$imap_asearch_debug_dump = FALSE;
 30
 31/** Imap SEARCH keys
 32* @global array $imap_asearch_opcodes
 33*/
 34global $imap_asearch_opcodes;
 35$imap_asearch_opcodes = array(
 36/* <sequence-set> => 'asequence', */    // Special handling, @see sqimap_asearch_build_criteria()
 37/*'ALL' is binary operator */
 38    'ANSWERED' => '',
 39    'BCC' => 'astring',
 40    'BEFORE' => 'adate',
 41    'BODY' => 'astring',
 42    'CC' => 'astring',
 43    'DELETED' => '',
 44    'DRAFT' => '',
 45    'FLAGGED' => '',
 46    'FROM' => 'astring',
 47    'HEADER' => 'afield',    // Special syntax for this one, @see sqimap_asearch_build_criteria()
 48    'KEYWORD' => 'akeyword',
 49    'LARGER' => 'anum',
 50    'NEW' => '',
 51/*'NOT' is unary operator */
 52    'OLD' => '',
 53    'ON' => 'adate',
 54/*'OR' is binary operator */
 55    'RECENT' => '',
 56    'SEEN' => '',
 57    'SENTBEFORE' => 'adate',
 58    'SENTON' => 'adate',
 59    'SENTSINCE' => 'adate',
 60    'SINCE' => 'adate',
 61    'SMALLER' => 'anum',
 62    'SUBJECT' => 'astring',
 63    'TEXT' => 'astring',
 64    'TO' => 'astring',
 65    'UID' => 'asequence',
 66    'UNANSWERED' => '',
 67    'UNDELETED' => '',
 68    'UNDRAFT' => '',
 69    'UNFLAGGED' => '',
 70    'UNKEYWORD' => 'akeyword',
 71    'UNSEEN' => ''
 72);
 73
 74/** Imap SEARCH month names encoding
 75* @global array $imap_asearch_months
 76*/
 77$imap_asearch_months = array(
 78    '01' => 'jan',
 79    '02' => 'feb',
 80    '03' => 'mar',
 81    '04' => 'apr',
 82    '05' => 'may',
 83    '06' => 'jun',
 84    '07' => 'jul',
 85    '08' => 'aug',
 86    '09' => 'sep',
 87    '10' => 'oct',
 88    '11' => 'nov',
 89    '12' => 'dec'
 90);
 91
 92/**
 93* Function to display an error related to an IMAP-query.
 94* We need to do our own error management since we may receive NO responses on purpose (even BAD with SORT or THREAD)
 95* so we call sqimap_error_box() if the function exists (sm >= 1.5) or use our own embedded code
 96* @global array imap_error_titles
 97* @param string $response the imap server response code
 98* @param string $query the failed query
 99* @param string $message an optional error message
100* @param string $link an optional link to try again
101*/
102//@global array color sm colors array
103function sqimap_asearch_error_box($response, $query, $message, $link = '')
104{
105    global $color;
106    // Error message titles according to imap server returned code
107    $imap_error_titles = array(
108        'OK' => '',
109        'NO' => _("ERROR : Could not complete request."),
110        'BAD' => _("ERROR : Bad or malformed request."),
111        'BYE' => _("ERROR : Imap server closed the connection."),
112        '' => _("ERROR : Connection dropped by imap-server.")
113    );
114
115
116    if (!array_key_exists($response, $imap_error_titles))
117        $title = _("ERROR : Unknown imap response.");
118    else
119        $title = $imap_error_titles[$response];
120    if ($link == '')
121        $message_title = _("Reason Given: ");
122    else
123        $message_title = _("Possible reason : ");
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
127        global $color;
128    require_once(SM_PATH . 'functions/display_messages.php');
129    $string = "<font color=\"$color[2]\"><b>\n" . $title . "</b><br />\n";
130    if ($query != '')
131        $string .= _("Query:") . ' ' . htmlspecialchars($query) . '<br />';
132    if ($message_title != '')
133        $string .= $message_title;
134    if ($message != '')
135        $string .= htmlspecialchars($message);
136    if ($link != '')
137        $string .= $link;
138    $string .= "</font><br />\n";
139    error_box($string,$color);
140    }
141}
142
143/**
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
148*/
149function asearch_nz(&$var, $def = '')
150{
151    if (isset($var))
152        return $var;
153    return $def;
154}
155
156/**
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
161*/
162function 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);
170*/
171}
172
173/**
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*/
179function s_debug_dump($var_name, $var_var)
180{
181    global $imap_asearch_debug_dump;
182    if ($imap_asearch_debug_dump) {
183        if (function_exists('sm_print_r'))      //Only exists since 1.4.2
184            sm_print_r($var_name, $var_var);    //Better be the 'varargs' version ;)
185        else {
186            echo '<pre>';
187            echo htmlentities($var_name);
188            print_r($var_var);
189            echo '</pre>';
190        }
191    }
192}
193
194/** Encode a string to quoted or literal as defined in rfc 3501
195*
196* -  4.3 String:
197*        A quoted string is a sequence of zero or more 7-bit characters,
198*         excluding CR and LF, with double quote (<">) characters at each end.
199* -  9. Formal Syntax:
200*        quoted-specials = DQUOTE / "\"
201* @param string $what string to encode
202* @param string $charset search charset used
203* @return string encoded string
204*/
205function sqimap_asearch_encode_string($what, $charset)
206{
207    if (strtoupper($charset) == 'ISO-2022-JP')    // This should be now handled in imap_utf7_local?
208        $what = mb_convert_encoding($what, 'JIS', 'auto');
209    if (preg_match('/["\\\\\r\n\x80-\xff]/', $what))
210        return '{' . strlen($what) . "}\r\n" . $what;    // 4.3 literal form
211    return '"' . $what . '"';    // 4.3 quoted string form
212}
213
214/**
215* Parses a user date string into an rfc 3501 date string
216* Handles space, slash, backslash, dot and comma as separators (and dash of course ;=)
217* @global array imap_asearch_months
218* @param string user date
219* @return array a preg_match-style array:
220*  - [0] = fully formatted rfc 3501 date string (<day number>-<US month TLA>-<4 digit year>)
221*  - [1] = day
222*  - [2] = month
223*  - [3] = year
224*/
225function sqimap_asearch_parse_date($what)
226{
227    global $imap_asearch_months;
228
229    $what = trim($what);
230    $what = ereg_replace('[ /\\.,]+', '-', $what);
231    if ($what) {
232        preg_match('/^([0-9]+)-+([^\-]+)-+([0-9]+)$/', $what, $what_parts);
233        if (count($what_parts) == 4) {
234            $what_month = strtolower(asearch_unhtmlentities($what_parts[2]));
235/*                if (!in_array($what_month, $imap_asearch_months)) {*/
236                foreach ($imap_asearch_months as $month_number => $month_code) {
237                    if (($what_month == $month_number)
238                    || ($what_month == $month_code)
239                    || ($what_month == strtolower(asearch_unhtmlentities(getMonthName($month_number))))
240                    || ($what_month == strtolower(asearch_unhtmlentities(getMonthAbrv($month_number))))
241                    ) {
242                        $what_parts[2] = $month_number;
243                        $what_parts[0] = $what_parts[1] . '-' . $month_code . '-' . $what_parts[3];
244                        break;
245                    }
246                }
247/*                }*/
248        }
249    }
250    else
251        $what_parts = array();
252    return $what_parts;
253}
254
255/**
256* Build one criteria sequence
257* @global array imap_asearch_opcodes
258* @param string $opcode search opcode
259* @param string $what opcode argument
260* @param string $charset search charset
261* @return string one full criteria sequence
262*/
263function sqimap_asearch_build_criteria($opcode, $what, $charset)
264{
265    global $imap_asearch_opcodes;
266
267    $criteria = '';
268    switch ($imap_asearch_opcodes[$opcode]) {
269        default:
270        case 'anum':
271            $what = str_replace(' ', '', $what);
272            $what = ereg_replace('[^0-9]+[^KMG]$', '', strtoupper($what));
273            if ($what != '') {
274                switch (substr($what, -1)) {
275                    case 'G':
276                        $what = substr($what, 0, -1) << 30;
277                    break;
278                    case 'M':
279                        $what = substr($what, 0, -1) << 20;
280                    break;
281                    case 'K':
282                        $what = substr($what, 0, -1) << 10;
283                    break;
284                }
285                $criteria = $opcode . ' ' . $what . ' ';
286            }
287        break;
288        case '':    //aflag
289            $criteria = $opcode . ' ';
290        break;
291        case 'afield':    /* HEADER field-name: field-body */
292            preg_match('/^([^:]+):(.*)$/', $what, $what_parts);
293            if (count($what_parts) == 3)
294                $criteria = $opcode . ' ' .
295                    sqimap_asearch_encode_string($what_parts[1], $charset) . ' ' .
296                    sqimap_asearch_encode_string($what_parts[2], $charset) . ' ';
297        break;
298        case 'adate':
299            $what_parts = sqimap_asearch_parse_date($what);
300            if (isset($what_parts[0]))
301                $criteria = $opcode . ' ' . $what_parts[0] . ' ';
302        break;
303        case 'akeyword':
304        case 'astring':
305            $criteria = $opcode . ' ' . sqimap_asearch_encode_string($what, $charset) . ' ';
306        break;
307        case 'asequence':
308            $what = ereg_replace('[^0-9:\(\)]+', '', $what);
309            if ($what != '')
310                $criteria = $opcode . ' ' . $what . ' ';
311        break;
312    }
313    return $criteria;
314}
315
316/**
317* Another way to do array_values(array_unique(array_merge($to, $from)));
318* @param array $to to array (reference)
319* @param array $from from array
320* @return array uniquely merged array
321*/
322function sqimap_array_merge_unique(&$to, $from)
323{
324    if (empty($to))
325        return $from;
326    $count = count($from);
327    for ($i = 0; $i < $count; $i++) {
328        if (!in_array($from[$i], $to))
329            $to[] = $from[$i];
330    }
331    return $to;
332}
333
334/**
335* Run the imap SEARCH command as defined in rfc 3501
336* @link http://www.ietf.org/rfc/rfc3501.txt
337* @param resource $imapConnection the current imap stream
338* @param string $search_string the full search expression eg "ALL RECENT"
339* @param string $search_charset charset to use or zls ('')
340* @return array an IDs or UIDs array of matching messages or an empty array
341*/
342function sqimap_run_search($imapConnection, $search_string, $search_charset)
343{
344    //For some reason, this seems to happen and forbids searching servers not allowing OPTIONAL [CHARSET]
345    if (strtoupper($search_charset) == 'US-ASCII')
346        $search_charset = '';
347    /* 6.4.4 try OPTIONAL [CHARSET] specification first */
348    if ($search_charset != '')
349        $query = 'SEARCH CHARSET "' . strtoupper($search_charset) . '" ' . $search_string;
350    else
351        $query = 'SEARCH ' . $search_string;
352    s_debug_dump('C:', $query);
353    $readin = sqimap_run_command($imapConnection, $query, false, $response, $message, TRUE);
354
355    /* 6.4.4 try US-ASCII charset if we tried an OPTIONAL [CHARSET] and received a tagged NO response (SHOULD be [BADCHARSET]) */
356    if (($search_charset != '')  && (strtoupper($response) == 'NO')) {
357        $query = 'SEARCH CHARSET US-ASCII ' . $search_string;
358        s_debug_dump('C:', $query);
359        $readin = sqimap_run_command($imapConnection, $query, false, $response, $message, TRUE);
360    }
361    if (strtoupper($response) != 'OK') {
362        sqimap_asearch_error_box($response, $query, $message);
363        return array();
364    }
365    $messagelist = parseUidList($readin,'SEARCH');
366
367    if (empty($messagelist))    //Empty search response, ie '* SEARCH'
368        return array();
369
370    $cnt = count($messagelist);
371    for ($q = 0; $q < $cnt; $q++)
372        $id[$q] = trim($messagelist[$q]);
373    return $id;
374}
375
376/**
377* @global bool allow_charset_search user setting
378* @global array languages sm languages array
379* @global string squirrelmail_language user language setting
380* @return string the user defined charset if $allow_charset_search is TRUE else zls ('')
381*/
382function sqimap_asearch_get_charset()
383{
384    global $allow_charset_search, $languages, $squirrelmail_language;
385
386    if ($allow_charset_search)
387        return $languages[$squirrelmail_language]['CHARSET'];
388    return '';
389}
390
391/**
392* Convert sm internal sort to imap sort taking care of:
393* - user defined date sorting (ARRIVAL vs DATE)
394* - if the searched mailbox is the sent folder then TO is being used instead of FROM
395* - reverse order by using REVERSE
396* @param string $mailbox mailbox name to sort
397* @param integer $sort_by sm sort criteria index
398* @global bool internal_date_sort sort by arrival date instead of message date
399* @global string sent_folder sent folder name
400* @return string imap sort criteria
401*/
402function sqimap_asearch_get_sort_criteria($mailbox, $sort_by)
403{
404    global $internal_date_sort, $sent_folder;
405
406    $sort_opcodes = array ('DATE', 'FROM', 'SUBJECT', 'SIZE');
407    if ($internal_date_sort == true)
408        $sort_opcodes[0] = 'ARRIVAL';
409//	if (handleAsSent($mailbox))
410//	if (isSentFolder($mailbox))
411    if ($mailbox == $sent_folder)
412        $sort_opcodes[1] = 'TO';
413    return (($sort_by % 2) ? '' : 'REVERSE ') . $sort_opcodes[($sort_by >> 1) & 3];
414}
415
416/**
417* @param string $cur_mailbox unformatted mailbox name
418* @param array $boxes_unformatted selectable mailbox unformatted names array (reference)
419* @return array sub mailboxes unformatted names
420*/
421function sqimap_asearch_get_sub_mailboxes($cur_mailbox, &$mboxes_array)
422{
423    $sub_mboxes_array = array();
424    $boxcount = count($mboxes_array);
425    for ($boxnum=0; $boxnum < $boxcount; $boxnum++) {
426        if (isBoxBelow($mboxes_array[$boxnum], $cur_mailbox))
427            $sub_mboxes_array[] = $mboxes_array[$boxnum];
428    }
429    return $sub_mboxes_array;
430}
431
432/**
433* Create the search query strings for all given criteria and merge results for every mailbox
434* @param resource $imapConnection
435* @param array $mailbox_array (reference)
436* @param array $biop_array (reference)
437* @param array $unop_array (reference)
438* @param array $where_array (reference)
439* @param array $what_array (reference)
440* @param array $exclude_array (reference)
441* @param array $sub_array (reference)
442* @param array $mboxes_array selectable unformatted mailboxes names (reference)
443* @return array array(mailbox => array(UIDs))
444*/
445function sqimap_asearch($imapConnection, &$mailbox_array, &$biop_array, &$unop_array, &$where_array, &$what_array, &$exclude_array, &$sub_array, &$mboxes_array)
446{
447
448    $search_charset = sqimap_asearch_get_charset();
449    $mbox_search = array();
450    $search_string = '';
451    $cur_mailbox = $mailbox_array[0];
452    $cur_biop = '';    /* Start with ALL */
453    /* We loop one more time than the real array count, so the last search gets fired */
454    for ($cur_crit=0,$iCnt=count($where_array); $cur_crit <= $iCnt; ++$cur_crit) {
455        if (empty($exclude_array[$cur_crit])) {
456            $next_mailbox = (isset($mailbox_array[$cur_crit])) ? $mailbox_array[$cur_crit] : false;
457            if ($next_mailbox != $cur_mailbox) {
458                $search_string = trim($search_string);    /* Trim out last space */
459                if ($cur_mailbox == 'All Folders')
460                    $search_mboxes = $mboxes_array;
461                else if ((!empty($sub_array[$cur_crit - 1])) || (!in_array($cur_mailbox, $mboxes_array)))
462                    $search_mboxes = sqimap_asearch_get_sub_mailboxes($cur_mailbox, $mboxes_array);
463                else
464                    $search_mboxes = array($cur_mailbox);
465                foreach ($search_mboxes as $cur_mailbox) {
466                    if (isset($mbox_search[$cur_mailbox])) {
467                        $mbox_search[$cur_mailbox]['search'] .= ' ' . $search_string;
468                    } else {
469                        $mbox_search[$cur_mailbox]['search'] = $search_string;
470                    }
471                    $mbox_search[$cur_mailbox]['charset'] = $search_charset;
472                }
473                $cur_mailbox = $next_mailbox;
474                $search_string = '';
475            }
476            if (isset($where_array[$cur_crit]) && empty($exclude_array[$cur_crit])) {
477                for ($crit = $cur_crit; $crit < count($where_array); $crit++) {
478                    $criteria = trim(sqimap_asearch_build_criteria($where_array[$crit], $what_array[$crit], $search_charset));
479                    if (!empty($criteria) && empty($exclude_array[$crit])) {
480                        if (asearch_nz($mailbox_array[$crit]) == $cur_mailbox) {
481                            $unop = $unop_array[$crit];
482                            if (!empty($unop)) {
483                                $criteria = $unop . ' ' . $criteria;
484                            }
485                            $aCriteria[] = array($biop_array[$crit], $criteria);
486                        }
487                    }
488                    // unset something
489                    $exclude_array[$crit] = true;
490                }
491                $aSearch = array();
492                for($i=0,$iCnt=count($aCriteria);$i<$iCnt;++$i) {
493                    $cur_biop = $aCriteria[$i][0];
494                    $next_biop = (isset($aCriteria[$i+1][0])) ? $aCriteria[$i+1][0] : false;
495                    if ($next_biop != $cur_biop && $next_biop == 'OR') {
496                        $aSearch[] = 'OR '.$aCriteria[$i][1];
497                    } else if ($cur_biop != 'OR') {
498                        $aSearch[] = 'ALL '.$aCriteria[$i][1];
499                    } else { // OR only supports 2 search keys so we need to create a parenthesized list
500                        $prev_biop = (isset($aCriteria[$i-1][0])) ? $aCriteria[$i-1][0] : false;
501                        if ($prev_biop == $cur_biop) {
502                            $last = $aSearch[$i-1];
503                            if (!substr($last,-1) == ')') {
504                                $aSearch[$i-1] = "(OR $last";
505                                $aSearch[] = $aCriteria[$i][1].')';
506                            } else {
507                                $sEnd = '';
508                                while ($last && substr($last,-1) == ')') {
509                                    $last = substr($last,0,-1);
510                                    $sEnd .= ')';
511                                }
512                                $aSearch[$i-1] = "(OR $last";
513                                $aSearch[] = $aCriteria[$i][1].$sEnd.')';
514                            }
515                        } else {
516                            $aSearch[] = $aCriteria[$i][1];
517                        }
518                    }
519                }
520                $search_string .= implode(' ',$aSearch);
521            }
522        }
523    }
524    return ($mbox_search);
525}
526
527?>