cd33ec11 |
1 | <?php |
2 | |
3 | /** |
4 | * imap_search.php |
5 | * |
6 | * Copyright (c) 1999-2003 The SquirrelMail Project Team |
7 | * Licensed under the GNU GPL. For full terms see the file COPYING. |
8 | * |
9 | * IMAP asearch routines |
10 | * Alex Lemaresquier - Brainstorm - alex at brainstorm.fr |
11 | * See README file for infos. |
12 | * |
13 | */ |
14 | |
ff6f916c |
15 | require_once(SM_PATH . 'functions/imap_general.php'); |
cd33ec11 |
16 | require_once(SM_PATH . 'functions/date.php'); |
17 | |
18 | /* Set to TRUE to dump the imap dialogue */ |
19 | $imap_asearch_debug_dump = FALSE; |
20 | |
21 | $imap_asearch_opcodes = array( |
22 | /* <message set> => 'asequence', */ |
23 | /*'ALL' is binary operator */ |
24 | 'ANSWERED' => '', |
25 | 'BCC' => 'astring', |
26 | 'BEFORE' => 'adate', |
27 | 'BODY' => 'astring', |
28 | 'CC' => 'astring', |
29 | 'DELETED' => '', |
30 | 'DRAFT' => '', |
31 | 'FLAGGED' => '', |
32 | 'FROM' => 'astring', |
33 | 'HEADER' => 'afield', /* Special syntax for this one, see below */ |
34 | 'KEYWORD' => 'akeyword', |
35 | 'LARGER' => 'anum', |
36 | 'NEW' => '', |
37 | /*'NOT' is unary operator */ |
38 | 'OLD' => '', |
39 | 'ON' => 'adate', |
40 | /*'OR' is binary operator */ |
41 | 'RECENT' => '', |
42 | 'SEEN' => '', |
43 | 'SENTBEFORE' => 'adate', |
44 | 'SENTON' => 'adate', |
45 | 'SENTSINCE' => 'adate', |
46 | 'SINCE' => 'adate', |
47 | 'SMALLER' => 'anum', |
48 | 'SUBJECT' => 'astring', |
49 | 'TEXT' => 'astring', |
50 | 'TO' => 'astring', |
51 | 'UID' => 'asequence', |
52 | 'UNANSWERED' => '', |
53 | 'UNDELETED' => '', |
54 | 'UNDRAFT' => '', |
55 | 'UNFLAGGED' => '', |
56 | 'UNKEYWORD' => 'akeyword', |
57 | 'UNSEEN' => '' |
58 | ); |
59 | |
60 | $imap_asearch_months = array( |
61 | '01' => 'jan', |
62 | '02' => 'feb', |
63 | '03' => 'mar', |
64 | '04' => 'apr', |
65 | '05' => 'may', |
66 | '06' => 'jun', |
67 | '07' => 'jul', |
68 | '08' => 'aug', |
69 | '09' => 'sep', |
70 | '10' => 'oct', |
71 | '11' => 'nov', |
72 | '12' => 'dec' |
73 | ); |
74 | |
ff6f916c |
75 | $imap_error_titles = array( |
76 | 'OK' => '', |
77 | 'NO' => _("ERROR : Could not complete request."), |
78 | 'BAD' => _("ERROR : Bad or malformed request."), |
79 | 'BYE' => _("ERROR : Imap server closed the connection.") |
80 | ); |
81 | |
82 | function sqimap_asearch_error_box($response, $query, $message) |
83 | { |
84 | global $imap_error_titles; |
85 | |
86 | //if (!array_key_exists($response, $imap_error_titles)) //php 4.0.6 compatibility |
87 | if (!in_array($response, array_keys($imap_error_titles))) |
88 | $title = _("ERROR : Unknown imap response."); |
89 | else |
90 | $title = $imap_error_titles[$response]; |
91 | sqimap_error_box($title, $query, _("Reason Given: "), $message); |
92 | } |
93 | |
cd33ec11 |
94 | /* This is to avoid the E_NOTICE warnings signaled by marc AT squirrelmail.org. Thanks Marc! */ |
95 | function asearch_nz(&$var) |
96 | { |
97 | if (isset($var)) |
98 | return $var; |
99 | return ''; |
100 | } |
101 | |
102 | /* This should give the same results as PHP 4 >= 4.3.0's html_entity_decode() */ |
103 | function asearch_unhtmlentities($string) { |
104 | $trans_tbl = array_flip(get_html_translation_table(HTML_ENTITIES)); |
105 | for ($i=127; $i<255; $i++) /* Add &#<dec>; entities */ |
106 | $trans_tbl['&#' . $i . ';'] = chr($i); |
107 | return strtr($string, $trans_tbl); |
108 | /* I think the one above is quicker, though it should be benchmarked |
109 | $string = strtr($string, array_flip(get_html_translation_table(HTML_ENTITIES))); |
110 | return preg_replace("/&#([0-9]+);/E", "chr('\\1')", $string); |
111 | */ |
112 | } |
113 | |
ff6f916c |
114 | function s_debug_dump($var_name, $var_var) |
cd33ec11 |
115 | { |
116 | global $imap_asearch_debug_dump; |
f9fb0d38 |
117 | if ($imap_asearch_debug_dump) { |
118 | if (function_exists('sm_print_r')) |
119 | sm_print_r($var_name, $var_var); //Better be the 'varargs' version ;) |
120 | else { |
121 | echo '<pre>'; |
122 | echo htmlentities($var_name); |
123 | print_r($var_var); |
124 | echo '</pre>'; |
125 | } |
126 | } |
cd33ec11 |
127 | } |
128 | |
375b552d |
129 | /* |
130 | 4.3 String: |
131 | A quoted string is a sequence of zero or more 7-bit characters, |
132 | excluding CR and LF, with double quote (<">) characters at each end. |
133 | 9. Formal Syntax: |
134 | quoted-specials = DQUOTE / "\" |
135 | */ |
cd33ec11 |
136 | function sqimap_asearch_encode_string($what, $search_charset) |
137 | { |
138 | if (strtoupper($search_charset) == 'ISO-2022-JP') |
139 | $what = mb_convert_encoding($what, 'JIS', 'auto'); |
ff6f916c |
140 | //if (ereg("[\"\\\r\n\x80-\xff]", $what)) |
141 | if (preg_match('/["\\\\\r\n\x80-\xff]/', $what)) |
cd33ec11 |
142 | return '{' . strlen($what) . "}\r\n" . $what; /* 4.3 literal form */ |
143 | return '"' . $what . '"'; /* 4.3 quoted string form */ |
144 | } |
145 | |
146 | /* |
147 | Parses a user date string into an rfc2060 date string (<day number>-<US month TLA>-<4 digit year>) |
148 | Returns a preg_match-style array: [0]: fully formatted date, [1]: day, [2]: month, [3]: year |
375b552d |
149 | Handles space, slash, backslash, dot and comma as separators (and dash of course ;=) |
cd33ec11 |
150 | */ |
151 | function sqimap_asearch_parse_date($what) |
152 | { |
153 | global $imap_asearch_months; |
154 | |
155 | $what = trim($what); |
375b552d |
156 | $what = ereg_replace('[ /\\.,]+', '-', $what); |
cd33ec11 |
157 | if ($what) { |
375b552d |
158 | preg_match('/^([0-9]+)-+([^\-]+)-+([0-9]+)$/', $what, $what_parts); |
cd33ec11 |
159 | if (count($what_parts) == 4) { |
160 | $what_month = strtolower(asearch_unhtmlentities($what_parts[2])); |
161 | /* if (!in_array($what_month, $imap_asearch_months)) {*/ |
162 | foreach ($imap_asearch_months as $month_number => $month_code) { |
163 | if (($what_month == $month_number) |
164 | || ($what_month == $month_code) |
165 | || ($what_month == strtolower(asearch_unhtmlentities(getMonthName($month_number)))) |
166 | || ($what_month == strtolower(asearch_unhtmlentities(getMonthAbrv($month_number)))) |
167 | ) { |
168 | $what_parts[2] = $month_number; |
169 | $what_parts[0] = $what_parts[1] . '-' . $month_code . '-' . $what_parts[3]; |
170 | break; |
171 | } |
172 | } |
173 | /* }*/ |
174 | } |
175 | } |
176 | else |
177 | $what_parts = array(); |
178 | return $what_parts; |
179 | } |
180 | |
181 | function sqimap_asearch_build_criteria($opcode, $what, $search_charset) |
182 | { |
183 | global $imap_asearch_opcodes; |
184 | |
375b552d |
185 | $criteria = ''; |
cd33ec11 |
186 | switch ($imap_asearch_opcodes[$opcode]) { |
187 | default: |
188 | case 'anum': |
189 | /* $what = str_replace(' ', '', $what);*/ |
190 | $what = ereg_replace('[^0-9]+', '', $what); |
191 | if ($what != '') |
192 | $criteria = $opcode . ' ' . $what . ' '; |
193 | break; |
194 | case '': /* aflag */ |
195 | $criteria = $opcode . ' '; |
196 | break; |
197 | case 'afield': /* HEADER field-name: field-body */ |
198 | preg_match('/^([^:]+):(.*)$/', $what, $what_parts); |
199 | if (count($what_parts) == 3) |
200 | $criteria = $opcode . ' ' . |
201 | sqimap_asearch_encode_string($what_parts[1], $search_charset) . ' ' . |
202 | sqimap_asearch_encode_string($what_parts[2], $search_charset) . ' '; |
203 | break; |
204 | case 'adate': |
205 | $what_parts = sqimap_asearch_parse_date($what); |
375b552d |
206 | if (isset($what_parts[0])) |
cd33ec11 |
207 | $criteria = $opcode . ' ' . $what_parts[0] . ' '; |
208 | break; |
209 | case 'akeyword': |
210 | case 'astring': |
211 | $criteria = $opcode . ' ' . sqimap_asearch_encode_string($what, $search_charset) . ' '; |
212 | break; |
213 | case 'asequence': |
214 | $what = ereg_replace('[^0-9:\(\)]+', '', $what); |
215 | if ($what != '') |
216 | $criteria = $opcode . ' ' . $what . ' '; |
217 | break; |
218 | } |
219 | return $criteria; |
220 | } |
221 | |
222 | function sqimap_run_search($imapConnection, $search_string, $search_charset) |
223 | { |
224 | global $allow_charset_search, $uid_support; |
225 | |
226 | /* 6.4.4 try OPTIONAL [CHARSET] specification first */ |
227 | if ($allow_charset_search && (!empty($search_charset))) |
ff6f916c |
228 | $query = 'SEARCH CHARSET ' . strtoupper($search_charset) . ' ALL ' . $search_string; |
cd33ec11 |
229 | else |
ff6f916c |
230 | $query = 'SEARCH ALL ' . $search_string; |
231 | s_debug_dump('C:', $query); |
cd33ec11 |
232 | |
233 | /* read data back from IMAP */ |
ff6f916c |
234 | $readin = sqimap_run_command($imapConnection, $query, false, $response, $message, $uid_support); |
cd33ec11 |
235 | |
236 | /* 6.4.4 try US-ASCII charset if we receive a tagged NO response */ |
ff6f916c |
237 | if ((!empty($charset)) && (strtoupper($response) == 'NO')) { |
238 | $query = 'SEARCH CHARSET "US-ASCII" ALL ' . $search_string; |
239 | s_debug_dump('C:', $query); |
240 | $readin = sqimap_run_command ($imapConnection, $query, false, $response, $message, $uid_support); /* added $uid_support */ |
241 | } |
242 | if (strtoupper($response) != 'OK') { |
243 | sqimap_asearch_error_box($response, $query, $message); |
244 | return array(); |
cd33ec11 |
245 | } |
246 | |
247 | unset($messagelist); |
248 | |
249 | /* Keep going till we find the SEARCH response */ |
250 | foreach ($readin as $readin_part) { |
ff6f916c |
251 | s_debug_dump('S:', $readin_part); |
cd33ec11 |
252 | /* Check to see if a SEARCH response was received */ |
253 | if (substr($readin_part, 0, 9) == '* SEARCH ') { |
254 | $messagelist = preg_split("/ /", substr($readin_part, 9)); |
ff6f916c |
255 | break; // Should be the last anyway |
cd33ec11 |
256 | } |
ff6f916c |
257 | /* else { |
258 | if (isset($errors)) |
259 | $errors = $errors . $readin_part; |
260 | else |
261 | $errors = $readin_part; |
262 | }*/ |
cd33ec11 |
263 | } |
264 | |
265 | /* If nothing is found * SEARCH should be the first error else echo errors */ |
ff6f916c |
266 | /*if (isset($errors)) { |
cd33ec11 |
267 | if (strstr($errors,'* SEARCH')) |
268 | return array(); |
269 | echo '<!-- ' . htmlspecialchars($errors) . ' -->'; |
ff6f916c |
270 | }*/ |
cd33ec11 |
271 | |
ff6f916c |
272 | if (empty($messagelist)) //Empty search response, ie '* SEARCH' |
3f075f6c |
273 | return array(); |
274 | |
cd33ec11 |
275 | $cnt = count($messagelist); |
276 | for ($q = 0; $q < $cnt; $q++) |
277 | $id[$q] = trim($messagelist[$q]); |
278 | return $id; |
279 | } |
280 | |
281 | /* replaces $mbox_msgs[$search_mailbox] = array_values(array_unique(array_merge($mbox_msgs[$search_mailbox], sqimap_run_search($imapConnection, $search_string, $search_charset))));*/ |
282 | function sqimap_array_merge_unique($to, $from) |
283 | { |
284 | if (empty($to)) |
285 | return $from; |
286 | for ($i=0; $i<count($from); $i++) { |
287 | if (!in_array($from[$i], $to)) |
288 | $to[] = $from[$i]; |
289 | } |
290 | return $to; |
291 | } |
292 | |
293 | function sqimap_asearch($imapConnection, $mailbox_array, $biop_array, $unop_array, $where_array, $what_array, $exclude_array, $mboxes_array) |
294 | { |
295 | global $languages, $squirrelmail_language; |
296 | |
297 | /* ??? what are those for ?? */ |
298 | /* $pos = $search_position;*/ |
299 | |
300 | $mbox_msgs = array(); |
301 | $search_charset = $languages[$squirrelmail_language]['CHARSET']; |
302 | $search_string = ''; |
303 | $cur_mailbox = $mailbox_array[0]; |
304 | $cur_biop = ''; /* Start with ALL */ |
305 | /* We loop one more time than the real array count, so the last search gets fired */ |
306 | for ($cur_crit = 0; $cur_crit <= count($where_array); $cur_crit++) { |
307 | if (empty($exclude_array[$cur_crit])) { |
308 | $next_mailbox = $mailbox_array[$cur_crit]; |
309 | if ($next_mailbox != $cur_mailbox) { |
310 | $search_string = trim($search_string); /* Trim out last space */ |
311 | if (($cur_mailbox == 'All Folders') && (!empty($mboxes_array))) |
312 | $search_mboxes = $mboxes_array; |
313 | else |
314 | $search_mboxes = array($cur_mailbox); |
315 | foreach ($search_mboxes as $cur_mailbox) { |
ff6f916c |
316 | s_debug_dump('C:SELECT:', $cur_mailbox); |
27907482 |
317 | sqimap_mailbox_select($imapConnection, $cur_mailbox); |
5ab3c3fe |
318 | if (isset($mbox_msgs[$cur_mailbox])) { |
319 | if ($cur_biop == 'OR') /* Merge with previous results */ |
320 | $mbox_msgs[$cur_mailbox] = sqimap_array_merge_unique($mbox_msgs[$cur_mailbox], sqimap_run_search($imapConnection, $search_string, $search_charset)); |
321 | else /* Intersect previous results */ |
cd33ec11 |
322 | $mbox_msgs[$cur_mailbox] = array_values(array_intersect(sqimap_run_search($imapConnection, $search_string, $search_charset), $mbox_msgs[$cur_mailbox])); |
323 | } |
5ab3c3fe |
324 | else /* No previous results */ |
325 | $mbox_msgs[$cur_mailbox] = sqimap_run_search($imapConnection, $search_string, $search_charset); |
cd33ec11 |
326 | if (empty($mbox_msgs[$cur_mailbox])) /* Can happen with intersect, and we need at the end a contiguous array */ |
327 | unset($mbox_msgs[$cur_mailbox]); |
328 | } |
329 | $cur_mailbox = $next_mailbox; |
330 | $search_string = ''; |
331 | } |
332 | if (isset($where_array[$cur_crit])) { |
333 | $criteria = sqimap_asearch_build_criteria($where_array[$cur_crit], $what_array[$cur_crit], $search_charset); |
334 | if (!empty($criteria)) { |
335 | $unop = $unop_array[$cur_crit]; |
336 | if (!empty($unop)) |
337 | $criteria = $unop . ' ' . $criteria; |
338 | /* We need to infix the next non-excluded criteria's biop if it's the same mailbox */ |
339 | $next_biop = ''; |
340 | for ($next_crit = $cur_crit+1; $next_crit <= count($where_array); $next_crit++) { |
341 | if (empty($exclude_array[$next_crit])) { |
342 | if (asearch_nz($mailbox_array[$next_crit]) == $cur_mailbox) |
5ab3c3fe |
343 | $next_biop = asearch_nz($biop_array[$next_crit]); |
cd33ec11 |
344 | break; |
345 | } |
346 | } |
347 | if ($next_biop == 'OR') |
348 | $criteria = $next_biop . ' ' . $criteria; |
349 | $search_string .= $criteria; |
350 | $cur_biop = asearch_nz($biop_array[$cur_crit]); |
351 | } |
352 | } |
353 | } |
354 | } |
355 | return $mbox_msgs; |
356 | } |
357 | |
358 | ?> |