X-Git-Url: https://vcs.fsf.org/?a=blobdiff_plain;f=functions%2Fimap_asearch.php;h=dbea4d6a92a5b09d931ff05ed4e61474ddb6b3da;hb=10bf80c009d938fc0cf85a70d0a6b3834365b146;hp=0d32c93f2c9a988474e5ba5212b0b4b85385645d;hpb=696155b5d8538efeaae7b7da7d74d8128f79880b;p=squirrelmail.git diff --git a/functions/imap_asearch.php b/functions/imap_asearch.php index 0d32c93f..dbea4d6a 100644 --- a/functions/imap_asearch.php +++ b/functions/imap_asearch.php @@ -1,38 +1,38 @@ + * @copyright © 1999-2005 The SquirrelMail Project Team + * @license http://opensource.org/licenses/gpl-license.php GNU Public License + * @version $Id$ + * @package squirrelmail + * @subpackage imap + * @see search.php + * @link http://www.ietf.org/rfc/rfc3501.txt + */ /** 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 -* @global bool $imap_asearch_debug_dump -*/ +/** 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 SEARCH keys + * @global array $imap_asearch_opcodes + */ +global $imap_asearch_opcodes; $imap_asearch_opcodes = array( -/* => 'asequence', */ // Special handling, @see sqimap_asearch_build_criteria() +/* => 'asequence', */ // Special handling, @see sqimap_asearch_build_criteria() /*'ALL' is binary operator */ 'ANSWERED' => '', 'BCC' => 'astring', @@ -43,7 +43,7 @@ $imap_asearch_opcodes = array( 'DRAFT' => '', 'FLAGGED' => '', 'FROM' => 'astring', - 'HEADER' => 'afield', // Special syntax for this one, @see sqimap_asearch_build_criteria() + 'HEADER' => 'afield', // Special syntax for this one, @see sqimap_asearch_build_criteria() 'KEYWORD' => 'akeyword', 'LARGER' => 'anum', 'NEW' => '', @@ -70,9 +70,9 @@ $imap_asearch_opcodes = array( 'UNSEEN' => '' ); -/** Imap SEARCH month names encoding -* @global array $imap_asearch_months -*/ +/** IMAP SEARCH month names encoding + * @global array $imap_asearch_months + */ $imap_asearch_months = array( '01' => 'jan', '02' => 'feb', @@ -88,65 +88,64 @@ $imap_asearch_months = array( '12' => 'dec' ); -/** 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 -*/ + * 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; + global $color; + // Error message titles according to IMAP server returned code + $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.") + ); + if (!array_key_exists($response, $imap_error_titles)) - $title = _("ERROR : Unknown imap response."); + $title = _("ERROR: Unknown IMAP response."); else $title = $imap_error_titles[$response]; if ($link == '') - $message_title = _("Reason Given: "); + $message_title = _("Reason Given:"); else - $message_title = _("Possible reason : "); + $message_title = _("Possible reason:"); + $message_title .= ' '; 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 + 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 = "\n" . $title . "
\n"; + $string = "\n" . $title . "
\n"; if ($query != '') - $string .= _("Query:") . ' ' . htmlspecialchars($query) . '
'; + $string .= _("Query:") . ' ' . htmlspecialchars($query) . '
'; if ($message_title != '') $string .= $message_title; if ($message != '') $string .= htmlspecialchars($message); if ($link != '') $string .= $link; - $string .= "
\n"; + $string .= "
\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 -*/ + * 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)) @@ -155,34 +154,38 @@ function asearch_nz(&$var, $def = '') } /** -* 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 -*/ + * 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 &#; entities */ + for ($i=127; $i<255; $i++) /* Add &#; entities */ $trans_tbl['&#' . $i . ';'] = chr($i); return strtr($string, $trans_tbl); /* I think the one above is quicker, though it should be benchmarked $string = strtr($string, array_flip(get_html_translation_table(HTML_ENTITIES))); return preg_replace("/&#([0-9]+);/E", "chr('\\1')", $string); -*/ + */ } /** -* 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 -*/ + * 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 + * @deprecated contains workarounds for 1.4.0 and older code. + * code without workarounds uses regular sm 1.4.2+ functions. + * it is not compatible with 1.4.1 + * @todo remove debugging function + */ function s_debug_dump($var_name, $var_var) { global $imap_asearch_debug_dump; 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 ;) + 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 '
';
             echo htmlentities($var_name);
@@ -193,36 +196,36 @@ function s_debug_dump($var_name, $var_var)
 }
 
 /** 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
-*/
+ *
+ * -  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($charset) == 'ISO-2022-JP')	// This should be now handled in imap_utf7_local?
+    if (strtoupper($charset) == 'ISO-2022-JP')    // This should be now handled in imap_utf7_local?
         $what = mb_convert_encoding($what, 'JIS', 'auto');
     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
+        return '{' . strlen($what) . "}\r\n" . $what;    // 4.3 literal form
+    return '"' . $what . '"';    // 4.3 quoted string form
 }
 
 /**
-* 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 (--<4 digit year>)
-*  - [1] = day
-*  - [2] = month
-*  - [3] = year
-*/
+ * 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 (--<4 digit year>)
+ *  - [1] = day
+ *  - [2] = month
+ *  - [3] = year
+ */
 function sqimap_asearch_parse_date($what)
 {
     global $imap_asearch_months;
@@ -233,7 +236,7 @@ function sqimap_asearch_parse_date($what)
         preg_match('/^([0-9]+)-+([^\-]+)-+([0-9]+)$/', $what, $what_parts);
         if (count($what_parts) == 4) {
             $what_month = strtolower(asearch_unhtmlentities($what_parts[2]));
-/*		if (!in_array($what_month, $imap_asearch_months)) {*/
+/*                if (!in_array($what_month, $imap_asearch_months)) {*/
                 foreach ($imap_asearch_months as $month_number => $month_code) {
                     if (($what_month == $month_number)
                     || ($what_month == $month_code)
@@ -245,7 +248,7 @@ function sqimap_asearch_parse_date($what)
                         break;
                     }
                 }
-/*		}*/
+/*                }*/
         }
     }
     else
@@ -254,13 +257,13 @@ function sqimap_asearch_parse_date($what)
 }
 
 /**
-* 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
-*/
+ * 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;
@@ -286,10 +289,10 @@ function sqimap_asearch_build_criteria($opcode, $what, $charset)
                 $criteria = $opcode . ' ' . $what . ' ';
             }
         break;
-        case '':	//aflag
+        case '':    //aflag
             $criteria = $opcode . ' ';
         break;
-        case 'afield':	/* HEADER field-name: field-body */
+        case 'afield':    /* HEADER field-name: field-body */
             preg_match('/^([^:]+):(.*)$/', $what, $what_parts);
             if (count($what_parts) == 3)
                 $criteria = $opcode . ' ' .
@@ -315,11 +318,11 @@ function sqimap_asearch_build_criteria($opcode, $what, $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
-*/
+ * 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)
 {
     if (empty($to))
@@ -333,13 +336,14 @@ function sqimap_array_merge_unique(&$to, $from)
 }
 
 /**
-* 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
-*/
+ * 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
+ * @since 1.5.0
+ */
 function sqimap_run_search($imapConnection, $search_string, $search_charset)
 {
     //For some reason, this seems to happen and forbids searching servers not allowing OPTIONAL [CHARSET]
@@ -365,7 +369,7 @@ function sqimap_run_search($imapConnection, $search_string, $search_charset)
     }
     $messagelist = parseUidList($readin,'SEARCH');
 
-    if (empty($messagelist))	//Empty search response, ie '* SEARCH'
+    if (empty($messagelist))    //Empty search response, ie '* SEARCH'
         return array();
 
     $cnt = count($messagelist);
@@ -375,11 +379,11 @@ function sqimap_run_search($imapConnection, $search_string, $search_charset)
 }
 
 /**
-* @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 ('')
-*/
+ * @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 $allow_charset_search, $languages, $squirrelmail_language;
@@ -390,16 +394,16 @@ function sqimap_asearch_get_charset()
 }
 
 /**
-* 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
-*/
+ * Convert SquirrelMail 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;
@@ -407,18 +411,18 @@ function sqimap_asearch_get_sort_criteria($mailbox, $sort_by)
     $sort_opcodes = array ('DATE', 'FROM', 'SUBJECT', 'SIZE');
     if ($internal_date_sort == true)
         $sort_opcodes[0] = 'ARRIVAL';
-//	if (handleAsSent($mailbox))
-//	if (isSentFolder($mailbox))
+//        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
-*/
+ * @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();
@@ -431,33 +435,32 @@ function sqimap_asearch_get_sub_mailboxes($cur_mailbox, &$mboxes_array)
 }
 
 /**
-* Create the search query strings for all given criteria and merge 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)
-* @return array array(mailbox => array(UIDs))
-*/
+ * Create the search query strings for all given criteria and merge 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)
+ * @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)
 {
 
     $search_charset = sqimap_asearch_get_charset();
-    $mbox_msgs = array();
     $mbox_search = array();
     $search_string = '';
     $cur_mailbox = $mailbox_array[0];
-    $cur_biop = '';	/* Start with ALL */
+    $cur_biop = '';    /* Start with ALL */
     /* We loop one more time than the real array count, so the last search gets fired */
     for ($cur_crit=0,$iCnt=count($where_array); $cur_crit <= $iCnt; ++$cur_crit) {
         if (empty($exclude_array[$cur_crit])) {
             $next_mailbox = (isset($mailbox_array[$cur_crit])) ? $mailbox_array[$cur_crit] : false;
             if ($next_mailbox != $cur_mailbox) {
-                $search_string = trim($search_string);	/* Trim out last space */
+                $search_string = trim($search_string);    /* Trim out last space */
                 if ($cur_mailbox == 'All Folders')
                     $search_mboxes = $mboxes_array;
                 else if ((!empty($sub_array[$cur_crit - 1])) || (!in_array($cur_mailbox, $mboxes_array)))
@@ -526,4 +529,4 @@ function sqimap_asearch($imapConnection, &$mailbox_array, &$biop_array, &$unop_a
     return ($mbox_search);
 }
 
-?>
+?>
\ No newline at end of file