59177427 |
1 | <?php |
7350889b |
2 | |
35586184 |
3 | /** |
258d61ed |
4 | * imap_messages.php |
5 | * |
6c84ba1e |
6 | * Copyright (c) 1999-2005 The SquirrelMail Project Team |
258d61ed |
7 | * Licensed under the GNU GPL. For full terms see the file COPYING. |
8 | * |
9 | * This implements functions that manipulate messages |
10 | * NOTE: Quite a few functions in this file are obsolete |
11 | * |
12 | * @version $Id$ |
13 | * @package squirrelmail |
14 | * @subpackage imap |
15 | */ |
052e0c26 |
16 | |
97f7ddf2 |
17 | |
7c3e0802 |
18 | /** |
8315c94c |
19 | * Copy a set of messages ($id) to another mailbox ($mailbox) |
258d61ed |
20 | * @param int $imap_stream The resource ID for the IMAP socket |
21 | * @param string $id The list of messages to copy |
22 | * @param string $mailbox The destination to copy to |
4e6e5d2d |
23 | * @param bool $handle_errors Show error messages in case of a NO, BAD or BYE response |
91c27aee |
24 | * @return bool If the copy completed without errors |
258d61ed |
25 | */ |
4e6e5d2d |
26 | function sqimap_msgs_list_copy($imap_stream, $id, $mailbox, $handle_errors = true) { |
1c198ef7 |
27 | $msgs_id = sqimap_message_list_squisher($id); |
4e6e5d2d |
28 | $read = sqimap_run_command ($imap_stream, "COPY $msgs_id " . sqimap_encode_mailbox_name($mailbox), $handle_errors, $response, $message, TRUE); |
324ac3c5 |
29 | if ($response == 'OK') { |
30 | return true; |
31 | } else { |
32 | return false; |
33 | } |
7c3e0802 |
34 | } |
35 | |
8315c94c |
36 | |
7c3e0802 |
37 | /** |
8315c94c |
38 | * Move a set of messages ($id) to another mailbox. Deletes the originals. |
258d61ed |
39 | * @param int $imap_stream The resource ID for the IMAP socket |
40 | * @param string $id The list of messages to move |
41 | * @param string $mailbox The destination to move to |
4e6e5d2d |
42 | * @param bool $handle_errors Show error messages in case of a NO, BAD or BYE response |
43 | * @return bool If the move completed without errors |
258d61ed |
44 | */ |
4e6e5d2d |
45 | function sqimap_msgs_list_move($imap_stream, $id, $mailbox, $handle_errors = true) { |
7c3e0802 |
46 | $msgs_id = sqimap_message_list_squisher($id); |
4e6e5d2d |
47 | if (sqimap_msgs_list_copy ($imap_stream, $id, $mailbox, $handle_errors)) { |
324ac3c5 |
48 | return sqimap_toggle_flag($imap_stream, $id, '\\Deleted', true, true); |
49 | } else { |
50 | return false; |
51 | } |
034fddf9 |
52 | } |
53 | |
54 | |
d6c32258 |
55 | /** |
258d61ed |
56 | * Deletes a message and move it to trash or expunge the mailbox |
57 | * @param resource imap connection |
58 | * @param string $mailbox mailbox, used for checking if it concerns the trash_folder |
59 | * @param array $id list with uid's |
83246804 |
60 | * @param bool $bypass_trash (since 1.5.0) skip copy to trash |
258d61ed |
61 | * @return array $aMessageList array with messages containing the new flags and UID @see parseFetch |
83246804 |
62 | * @since 1.4.0 |
258d61ed |
63 | */ |
8315c94c |
64 | function sqimap_msgs_list_delete($imap_stream, $mailbox, $id, $bypass_trash=false) { |
324ac3c5 |
65 | // FIX ME, remove globals by introducing an associative array with properties |
66 | // as 4th argument as replacement for the bypass_trash var |
6201339c |
67 | global $move_to_trash, $trash_folder; |
324ac3c5 |
68 | $bRes = true; |
abafb676 |
69 | if (($move_to_trash == true) && ($bypass_trash != true) && |
70 | (sqimap_mailbox_exists($imap_stream, $trash_folder) && ($mailbox != $trash_folder)) ) { |
324ac3c5 |
71 | $bRes = sqimap_msgs_list_copy ($imap_stream, $id, $trash_folder); |
72 | } |
73 | if ($bRes) { |
74 | return sqimap_toggle_flag($imap_stream, $id, '\\Deleted', true, true); |
75 | } else { |
76 | return false; |
034fddf9 |
77 | } |
034fddf9 |
78 | } |
79 | |
80 | |
258d61ed |
81 | /** |
82 | * Set a flag on the provided uid list |
83 | * @param resource imap connection |
84 | * @param array $id list with uid's |
85 | * @param string $flag Flags to set/unset flags can be i.e.'\Seen', '\Answered', '\Seen \Answered' |
86 | * @param bool $set add (true) or remove (false) the provided flag |
87 | * @param bool $handle_errors Show error messages in case of a NO, BAD or BYE response |
88 | * @return array $aMessageList array with messages containing the new flags and UID @see parseFetch |
89 | */ |
034fddf9 |
90 | function sqimap_toggle_flag($imap_stream, $id, $flag, $set, $handle_errors) { |
034fddf9 |
91 | $msgs_id = sqimap_message_list_squisher($id); |
92 | $set_string = ($set ? '+' : '-'); |
324ac3c5 |
93 | $aResponse = sqimap_run_command_list($imap_stream, "STORE $msgs_id ".$set_string."FLAGS ($flag)", $handle_errors, $response, $message, TRUE); |
94 | // parse the fetch response |
95 | return parseFetch($aResponse); |
034fddf9 |
96 | } |
97 | |
8315c94c |
98 | |
48af4b64 |
99 | /** |
258d61ed |
100 | * Sort the message list and crunch to be as small as possible |
101 | * (overflow could happen, so make it small if possible) |
102 | */ |
97f7ddf2 |
103 | function sqimap_message_list_squisher($messages_array) { |
104 | if( !is_array( $messages_array ) ) { |
fe70ae27 |
105 | return $messages_array; |
97f7ddf2 |
106 | } |
2d34da11 |
107 | |
97f7ddf2 |
108 | sort($messages_array, SORT_NUMERIC); |
109 | $msgs_str = ''; |
110 | while ($messages_array) { |
111 | $start = array_shift($messages_array); |
112 | $end = $start; |
113 | while (isset($messages_array[0]) && $messages_array[0] == $end + 1) { |
114 | $end = array_shift($messages_array); |
115 | } |
116 | if ($msgs_str != '') { |
117 | $msgs_str .= ','; |
118 | } |
119 | $msgs_str .= $start; |
120 | if ($start != $end) { |
121 | $msgs_str .= ':' . $end; |
122 | } |
123 | } |
97f7ddf2 |
124 | return $msgs_str; |
3411d4ec |
125 | } |
97f7ddf2 |
126 | |
8315c94c |
127 | |
48af4b64 |
128 | /** |
8315c94c |
129 | * Retrieves an array with a sorted uid list. Sorting is done on the imap server |
130 | * @link http://www.ietf.org/internet-drafts/draft-ietf-imapext-sort-17.txt |
131 | * @param resource $imap_stream IMAP socket connection |
132 | * @param string $sSortField Field to sort on |
133 | * @param bool $reverse Reverse order search |
134 | * @return array $id sorted uid list |
135 | */ |
136 | function sqimap_get_sort_order($imap_stream, $sSortField, $reverse, $search='ALL') { |
ce68b76b |
137 | global $default_charset; |
2d34da11 |
138 | |
ffb776c4 |
139 | if ($sSortField) { |
140 | if ($reverse) { |
141 | $sSortField = 'REVERSE '.$sSortField; |
142 | } |
324ac3c5 |
143 | $query = "SORT ($sSortField) ".strtoupper($default_charset)." $search"; |
144 | // FIX ME sqimap_run_command should return the parsed data accessible by $aDATA['SORT'] |
145 | $aData = sqimap_run_command ($imap_stream, $query, false, $response, $message, TRUE); |
146 | /* fallback to default charset */ |
147 | if ($response == 'NO' && strpos($message,'[BADCHARSET]') !== false) { |
148 | $query = "SORT ($sSortField) US-ASCII $search"; |
149 | $aData = sqimap_run_command ($imap_stream, $query, true, $response, $message, TRUE); |
cdca177a |
150 | } |
0fdc2fb6 |
151 | } |
324ac3c5 |
152 | |
153 | if ($response == 'OK') { |
154 | return parseUidList($aData,'SORT'); |
ffb776c4 |
155 | } else { |
324ac3c5 |
156 | return false; |
157 | } |
158 | } |
159 | |
258d61ed |
160 | |
161 | /** |
8315c94c |
162 | * Parses a UID list returned on a SORT or SEARCH request |
163 | * @param array $aData imap response |
164 | * @param string $sCommand issued imap command (SEARCH or SORT) |
165 | * @return array $aUid uid list |
166 | */ |
324ac3c5 |
167 | function parseUidList($aData,$sCommand) { |
168 | $aUid = array(); |
169 | if (isset($aData) && count($aData)) { |
170 | for ($i=0,$iCnt=count($aData);$i<$iCnt;++$i) { |
171 | if (preg_match("/^\* $sCommand (.+)$/", $aData[$i], $aMatch)) { |
172 | $aUid += preg_split("/ /", trim($aMatch[1])); |
173 | } |
174 | } |
cdca177a |
175 | } |
324ac3c5 |
176 | return array_unique($aUid); |
aa0da530 |
177 | } |
2d34da11 |
178 | |
26b22b20 |
179 | /** |
258d61ed |
180 | * Retrieves an array with a sorted uid list. Sorting is done by SquirrelMail |
181 | * |
182 | * @param resource $imap_stream IMAP socket connection |
183 | * @param string $sSortField Field to sort on |
184 | * @param bool $reverse Reverse order search |
185 | * @param array $aUid limit the search to the provided array with uid's default sqimap_get_small_headers uses 1:* |
186 | * @return array $aUid sorted uid list |
187 | */ |
8315c94c |
188 | function get_squirrel_sort($imap_stream, $sSortField, $reverse = false, $aUid = NULL) { |
e0e30169 |
189 | if ($sSortField != 'RFC822.SIZE' && $sSortField != 'INTERNALDATE') { |
324ac3c5 |
190 | $msgs = sqimap_get_small_header_list($imap_stream, $aUid, |
e0e30169 |
191 | array($sSortField), array()); |
ffb776c4 |
192 | } else { |
324ac3c5 |
193 | $msgs = sqimap_get_small_header_list($imap_stream, $aUid, |
e0e30169 |
194 | array(), array($sSortField)); |
ffb776c4 |
195 | } |
c2e29558 |
196 | $aUid = array(); |
76f29d49 |
197 | $walk = false; |
ffb776c4 |
198 | switch ($sSortField) { |
76f29d49 |
199 | // natcasesort section |
ffb776c4 |
200 | case 'FROM': |
ffb776c4 |
201 | case 'TO': |
76f29d49 |
202 | case 'CC': |
203 | if(!$walk) { |
204 | array_walk($msgs, create_function('&$v,&$k,$f', |
205 | '$v[$f] = (isset($v[$f])) ? $v[$f] : ""; |
544ab9e2 |
206 | $addr = reset(parseRFC822Address($v[$f],1)); |
207 | $sPersonal = (isset($addr[SQM_ADDR_PERSONAL]) && $addr[SQM_ADDR_PERSONAL]) ? |
208 | $addr[SQM_ADDR_PERSONAL] : ""; |
209 | $sEmail = ($addr[SQM_ADDR_HOST]) ? |
204f909c |
210 | $addr[SQM_ADDR_MAILBOX] . "@".$addr[SQM_ADDR_HOST] : |
544ab9e2 |
211 | $addr[SQM_ADDR_HOST]; |
212 | $v[$f] = ($sPersonal) ? decodeHeader($sPersonal):$sEmail;'),$sSortField); |
76f29d49 |
213 | $walk = true; |
cdca177a |
214 | } |
76f29d49 |
215 | // nobreak |
ffb776c4 |
216 | case 'SUBJECT': |
76f29d49 |
217 | if(!$walk) { |
218 | array_walk($msgs, create_function('&$v,&$k,$f', |
219 | '$v[$f] = (isset($v[$f])) ? $v[$f] : ""; |
220 | $v[$f] = strtolower(decodeHeader(trim($v[$f]))); |
221 | $v[$f] = (preg_match("/^(vedr|sv|re|aw|\[\w\]):\s*(.*)$/si", $v[$f], $matches)) ? |
222 | $matches[2] : $v[$f];'),$sSortField); |
223 | $walk = true; |
224 | } |
ffb776c4 |
225 | foreach ($msgs as $item) { |
324ac3c5 |
226 | $aUid[$item['UID']] = $item[$sSortField]; |
ffb776c4 |
227 | } |
76f29d49 |
228 | natcasesort($aUid); |
229 | $aUid = array_keys($aUid); |
ffb776c4 |
230 | if ($reverse) { |
e432a21c |
231 | $aUid = array_reverse($aUid); |
ffb776c4 |
232 | } |
233 | break; |
76f29d49 |
234 | // \natcasesort section |
235 | // sort_numeric section |
ffb776c4 |
236 | case 'DATE': |
76f29d49 |
237 | case 'INTERNALDATE': |
238 | if(!$walk) { |
239 | array_walk($msgs, create_function('&$v,$k,$f', |
240 | '$v[$f] = (isset($v[$f])) ? $v[$f] : ""; |
241 | $v[$f] = getTimeStamp(explode(" ",$v[$f]));'),$sSortField); |
242 | $walk = true; |
ffb776c4 |
243 | } |
76f29d49 |
244 | // nobreak; |
ffb776c4 |
245 | case 'RFC822.SIZE': |
c2e29558 |
246 | if(!$walk) { |
247 | // redefine $sSortField to maintain the same namespace between |
598294a7 |
248 | // server-side sorting and SquirrelMail sorting |
c2e29558 |
249 | $sSortField = 'SIZE'; |
250 | } |
ffb776c4 |
251 | foreach ($msgs as $item) { |
324ac3c5 |
252 | $aUid[$item['UID']] = (isset($item[$sSortField])) ? $item[$sSortField] : 0; |
ffb776c4 |
253 | } |
254 | if ($reverse) { |
76f29d49 |
255 | arsort($aUid,SORT_NUMERIC); |
ffb776c4 |
256 | } else { |
76f29d49 |
257 | asort($aUid, SORT_NUMERIC); |
ffb776c4 |
258 | } |
76f29d49 |
259 | $aUid = array_keys($aUid); |
ffb776c4 |
260 | break; |
76f29d49 |
261 | // \sort_numeric section |
ffb776c4 |
262 | case 'UID': |
76f29d49 |
263 | $aUid = array_reverse($msgs); |
ffb776c4 |
264 | break; |
6201339c |
265 | } |
76f29d49 |
266 | return $aUid; |
cdca177a |
267 | } |
268 | |
8315c94c |
269 | |
48af4b64 |
270 | /** |
258d61ed |
271 | * Returns an indent array for printMessageinfo() |
272 | * This represents the amount of indent needed (value), |
273 | * for this message number (key) |
274 | */ |
76f29d49 |
275 | |
276 | /* |
277 | * Notes for future work: |
278 | * indent_array should contain: indent_level, parent and flags, |
279 | * sibling notes .. |
280 | * To achieve that we need to define the following flags: |
281 | * 0: hasnochildren |
282 | * 1: haschildren |
283 | * 2: is first |
284 | * 4: is last |
285 | * a node has sibling nodes if it's not the last node |
286 | * a node has no sibling nodes if it's the last node |
287 | * By using binary comparations we can store the flag in one var |
288 | * |
289 | * example: |
290 | * -1 par = 0, level = 0, flag = 1 + 2 + 4 = 7 (haschildren, isfirst, islast) |
291 | * \-2 par = 1, level = 1, flag = 0 + 2 = 2 (hasnochildren, isfirst) |
292 | * |-3 par = 1, level = 1, flag = 1 + 4 = 5 (haschildren, islast) |
293 | * \-4 par = 3, level = 2, flag = 1 + 2 + 4 = 7 (haschildren, isfirst, islast) |
294 | * \-5 par = 4, level = 3, flag = 0 + 2 + 4 = 6 (hasnochildren, isfirst, islast) |
295 | */ |
8315c94c |
296 | function get_parent_level($thread_new) { |
48af4b64 |
297 | $parent = ''; |
298 | $child = ''; |
299 | $cutoff = 0; |
cdca177a |
300 | |
76f29d49 |
301 | /* |
302 | * loop through the threads and take unwanted characters out |
303 | * of the thread string then chop it up |
304 | */ |
7c612fdd |
305 | for ($i=0;$i<count($thread_new);$i++) { |
306 | $thread_new[$i] = preg_replace("/\s\(/", "(", $thread_new[$i]); |
307 | $thread_new[$i] = preg_replace("/(\d+)/", "$1|", $thread_new[$i]); |
308 | $thread_new[$i] = preg_split("/\|/", $thread_new[$i], -1, PREG_SPLIT_NO_EMPTY); |
1c198ef7 |
309 | } |
7c612fdd |
310 | $indent_array = array(); |
76f29d49 |
311 | if (!$thread_new) { |
312 | $thread_new = array(); |
313 | } |
288bbce0 |
314 | /* looping through the parts of one message thread */ |
cdca177a |
315 | |
7c612fdd |
316 | for ($i=0;$i<count($thread_new);$i++) { |
76f29d49 |
317 | /* first grab the parent, it does not indent */ |
cdca177a |
318 | |
7c612fdd |
319 | if (isset($thread_new[$i][0])) { |
288bbce0 |
320 | if (preg_match("/(\d+)/", $thread_new[$i][0], $regs)) { |
321 | $parent = $regs[1]; |
322 | } |
7c612fdd |
323 | } |
324 | $indent_array[$parent] = 0; |
288bbce0 |
325 | |
76f29d49 |
326 | /* |
327 | * now the children, checking each thread portion for |
328 | * ),(, and space, adjusting the level and space values |
329 | * to get the indent level |
330 | */ |
288bbce0 |
331 | $level = 0; |
474528eb |
332 | $spaces = array(); |
333 | $spaces_total = 0; |
7c612fdd |
334 | $indent = 0; |
288bbce0 |
335 | $fake = FALSE; |
76f29d49 |
336 | for ($k=1,$iCnt=count($thread_new[$i])-1;$k<$iCnt;++$k) { |
7c612fdd |
337 | $chars = count_chars($thread_new[$i][$k], 1); |
288bbce0 |
338 | if (isset($chars['40'])) { /* testing for ( */ |
76f29d49 |
339 | $level += $chars['40']; |
7c612fdd |
340 | } |
288bbce0 |
341 | if (isset($chars['41'])) { /* testing for ) */ |
76f29d49 |
342 | $level -= $chars['41']; |
474528eb |
343 | $spaces[$level] = 0; |
288bbce0 |
344 | /* if we were faking lets stop, this portion |
76f29d49 |
345 | * of the thread is over |
346 | */ |
288bbce0 |
347 | if ($level == $cutoff) { |
348 | $fake = FALSE; |
7c612fdd |
349 | } |
350 | } |
288bbce0 |
351 | if (isset($chars['32'])) { /* testing for space */ |
474528eb |
352 | if (!isset($spaces[$level])) { |
353 | $spaces[$level] = 0; |
354 | } |
76f29d49 |
355 | $spaces[$level] += $chars['32']; |
474528eb |
356 | } |
357 | for ($x=0;$x<=$level;$x++) { |
358 | if (isset($spaces[$x])) { |
76f29d49 |
359 | $spaces_total += $spaces[$x]; |
474528eb |
360 | } |
288bbce0 |
361 | } |
474528eb |
362 | $indent = $level + $spaces_total; |
288bbce0 |
363 | /* must have run into a message that broke the thread |
76f29d49 |
364 | * so we are adjusting for that portion |
365 | */ |
288bbce0 |
366 | if ($fake == TRUE) { |
367 | $indent = $indent +1; |
7c612fdd |
368 | } |
369 | if (preg_match("/(\d+)/", $thread_new[$i][$k], $regs)) { |
370 | $child = $regs[1]; |
371 | } |
288bbce0 |
372 | /* the thread must be broken if $indent == 0 |
76f29d49 |
373 | * so indent the message once and start faking it |
374 | */ |
288bbce0 |
375 | if ($indent == 0) { |
376 | $indent = 1; |
377 | $fake = TRUE; |
378 | $cutoff = $level; |
379 | } |
380 | /* dont need abs but if indent was negative |
76f29d49 |
381 | * errors would occur |
382 | */ |
383 | $indent_array[$child] = ($indent < 0) ? 0 : $indent; |
474528eb |
384 | $spaces_total = 0; |
cdca177a |
385 | } |
7c612fdd |
386 | } |
387 | return $indent_array; |
388 | } |
389 | |
390 | |
48af4b64 |
391 | /** |
258d61ed |
392 | * Returns an array with each element as a string representing one |
393 | * message-thread as returned by the IMAP server. |
394 | * @link http://www.ietf.org/internet-drafts/draft-ietf-imapext-sort-13.txt |
395 | */ |
8315c94c |
396 | function get_thread_sort($imap_stream, $search='ALL') { |
ffb776c4 |
397 | global $thread_new, $sort_by_ref, $default_charset, $server_sort_array, $indent_array; |
324ac3c5 |
398 | |
7c612fdd |
399 | $thread_temp = array (); |
400 | if ($sort_by_ref == 1) { |
401 | $sort_type = 'REFERENCES'; |
76f29d49 |
402 | } else { |
7c612fdd |
403 | $sort_type = 'ORDEREDSUBJECT'; |
404 | } |
324ac3c5 |
405 | $query = "THREAD $sort_type ".strtoupper($default_charset)." $search"; |
406 | |
407 | $thread_test = sqimap_run_command ($imap_stream, $query, false, $response, $message, TRUE); |
408 | /* fallback to default charset */ |
409 | if ($response == 'NO' && strpos($message,'[BADCHARSET]') !== false) { |
410 | $query = "THREAD $sort_type US-ASCII $search"; |
411 | $thread_test = sqimap_run_command ($imap_stream, $query, true, $response, $message, TRUE); |
412 | } |
2728fa19 |
413 | if (isset($thread_test[0])) { |
9978560b |
414 | for ($i=0,$iCnt=count($thread_test);$i<$iCnt;++$i) { |
76f29d49 |
415 | if (preg_match("/^\* THREAD (.+)$/", $thread_test[$i], $regs)) { |
416 | $thread_list = trim($regs[1]); |
417 | break; |
418 | } |
1c198ef7 |
419 | } |
76f29d49 |
420 | } else { |
421 | $thread_list = ""; |
7c612fdd |
422 | } |
26eca02e |
423 | if (!preg_match("/OK/", $response)) { |
76f29d49 |
424 | $server_sort_array = 'no'; |
425 | return $server_sort_array; |
cdca177a |
426 | } |
474528eb |
427 | if (isset($thread_list)) { |
428 | $thread_temp = preg_split("//", $thread_list, -1, PREG_SPLIT_NO_EMPTY); |
429 | } |
76f29d49 |
430 | |
7c612fdd |
431 | $counter = 0; |
432 | $thread_new = array(); |
433 | $k = 0; |
434 | $thread_new[0] = ""; |
76f29d49 |
435 | /* |
436 | * parse the thread response into separate threads |
437 | * |
438 | * example: |
439 | * [0] => (540) |
440 | * [1] => (1386) |
441 | * [2] => (1599 759 959 37) |
442 | * [3] => (492 1787) |
443 | * [4] => ((933)(1891)) |
444 | * [5] => (1030 (1497)(845)(1637)) |
445 | */ |
446 | for ($i=0,$iCnt=count($thread_temp);$i<$iCnt;$i++) { |
ffb776c4 |
447 | if ($thread_temp[$i] != ')' && $thread_temp[$i] != '(') { |
8315c94c |
448 | $thread_new[$k] = $thread_new[$k] . $thread_temp[$i]; |
76f29d49 |
449 | } elseif ($thread_temp[$i] == '(') { |
8315c94c |
450 | $thread_new[$k] .= $thread_temp[$i]; |
451 | $counter++; |
76f29d49 |
452 | } elseif ($thread_temp[$i] == ')') { |
453 | if ($counter > 1) { |
454 | $thread_new[$k] .= $thread_temp[$i]; |
455 | $counter = $counter - 1; |
456 | } else { |
457 | $thread_new[$k] .= $thread_temp[$i]; |
458 | $k++; |
459 | $thread_new[$k] = ""; |
460 | $counter = $counter - 1; |
461 | } |
ffb776c4 |
462 | } |
7c612fdd |
463 | } |
324ac3c5 |
464 | |
7c612fdd |
465 | $thread_new = array_reverse($thread_new); |
76f29d49 |
466 | /* place the threads after each other in one string */ |
7c612fdd |
467 | $thread_list = implode(" ", $thread_new); |
468 | $thread_list = str_replace("(", " ", $thread_list); |
469 | $thread_list = str_replace(")", " ", $thread_list); |
470 | $thread_list = preg_split("/\s/", $thread_list, -1, PREG_SPLIT_NO_EMPTY); |
60a3e687 |
471 | $server_sort_array = $thread_list; |
ffb776c4 |
472 | |
473 | $indent_array = get_parent_level ($thread_new); |
324ac3c5 |
474 | return array($thread_list,$indent_array); |
7c612fdd |
475 | } |
476 | |
034fddf9 |
477 | |
7b07404c |
478 | function elapsedTime($start) { |
0fdc2fb6 |
479 | $stop = gettimeofday(); |
480 | $timepassed = 1000000 * ($stop['sec'] - $start['sec']) + $stop['usec'] - $start['usec']; |
481 | return $timepassed; |
7b07404c |
482 | } |
7c612fdd |
483 | |
8315c94c |
484 | |
9b935fea |
485 | /** |
486 | * Normalise the different Priority headers into a uniform value, |
487 | * namely that of the X-Priority header (1, 3, 5). Supports: |
488 | * Prioirty, X-Priority, Importance. |
489 | * X-MS-Mail-Priority is not parsed because it always coincides |
490 | * with one of the other headers. |
491 | * |
492 | * DUPLICATE CODE ALERT: |
493 | * NOTE: this is actually a duplicate from the function in |
494 | * class/mime/Rfc822Header.php. |
495 | */ |
bddb3448 |
496 | function parsePriority($value) { |
497 | $value = strtolower(array_shift(split('/\w/',trim($value)))); |
498 | if ( is_numeric($value) ) { |
499 | return $value; |
500 | } |
501 | if ( $value == 'urgent' || $value == 'high' ) { |
502 | return 1; |
503 | } elseif ( $value == 'non-urgent' || $value == 'low' ) { |
504 | return 5; |
505 | } |
506 | return 3; |
507 | } |
508 | |
258d61ed |
509 | /** |
510 | * Parses a string in an imap response. String starts with " or { which means it |
511 | * can handle double quoted strings and literal strings |
512 | * |
513 | * @param string $read imap response |
514 | * @param integer $i (reference) offset in string |
515 | * @return string $s parsed string without the double quotes or literal count |
516 | */ |
a18594b2 |
517 | function parseString($read,&$i) { |
518 | $char = $read{$i}; |
519 | $s = ''; |
520 | if ($char == '"') { |
0fdc2fb6 |
521 | $iPos = ++$i; |
522 | while (true) { |
523 | $iPos = strpos($read,'"',$iPos); |
524 | if (!$iPos) break; |
8315c94c |
525 | if ($iPos && $read{$iPos -1} != '\\') { |
526 | $s = substr($read,$i,($iPos-$i)); |
527 | $i = $iPos; |
528 | break; |
529 | } |
530 | $iPos++; |
531 | if ($iPos > strlen($read)) { |
532 | break; |
533 | } |
0fdc2fb6 |
534 | } |
a18594b2 |
535 | } else if ($char == '{') { |
536 | $lit_cnt = ''; |
537 | ++$i; |
538 | $iPos = strpos($read,'}',$i); |
539 | if ($iPos) { |
8315c94c |
540 | $lit_cnt = substr($read, $i, $iPos - $i); |
541 | $i += strlen($lit_cnt) + 3; /* skip } + \r + \n */ |
542 | /* Now read the literal */ |
543 | $s = ($lit_cnt ? substr($read,$i,$lit_cnt): ''); |
544 | $i += $lit_cnt; |
545 | /* temp bugfix (SM 1.5 will have a working clean version) |
546 | too much work to implement that version right now */ |
547 | --$i; |
0fdc2fb6 |
548 | } else { /* should never happen */ |
a18594b2 |
549 | $i += 3; /* } + \r + \n */ |
550 | $s = ''; |
0fdc2fb6 |
551 | } |
a18594b2 |
552 | } else { |
0fdc2fb6 |
553 | return false; |
a18594b2 |
554 | } |
555 | ++$i; |
556 | return $s; |
557 | } |
558 | |
8315c94c |
559 | |
258d61ed |
560 | /** |
561 | * Parses a string containing an array from an imap response. String starts with ( and end with ) |
562 | * |
563 | * @param string $read imap response |
564 | * @param integer $i (reference) offset in string |
565 | * @return array $a |
566 | */ |
a18594b2 |
567 | function parseArray($read,&$i) { |
568 | $i = strpos($read,'(',$i); |
569 | $i_pos = strpos($read,')',$i); |
570 | $s = substr($read,$i+1,$i_pos - $i -1); |
571 | $a = explode(' ',$s); |
572 | if ($i_pos) { |
573 | $i = $i_pos+1; |
574 | return $a; |
575 | } else { |
576 | return false; |
577 | } |
578 | } |
8315c94c |
579 | |
580 | |
258d61ed |
581 | /** |
582 | * Retrieves a list with headers, flags, size or internaldate from the imap server |
4d7369b0 |
583 | * |
91c27aee |
584 | * WARNING: function is not portable between SquirrelMail 1.2.x, 1.4.x and 1.5.x. |
4d7369b0 |
585 | * Output format, third argument and $msg_list array format requirements differ. |
586 | * @param stream $imap_stream imap connection |
587 | * @param array $msg_list array with id's to create a msgs set from |
588 | * @param array $aHeaderFields (since 1.5.0) requested header fields |
589 | * @param array $aFetchItems (since 1.5.0) requested other fetch items like FLAGS, RFC822.SIZE |
9a3d9100 |
590 | * @return array $aMessages associative array with messages. Key is the UID, value is an associative array |
4d7369b0 |
591 | * @since 1.1.3 |
258d61ed |
592 | */ |
8315c94c |
593 | function sqimap_get_small_header_list($imap_stream, $msg_list, |
91c27aee |
594 | $aHeaderFields = array('Date', 'To', 'Cc', 'From', 'Subject', 'X-Priority', 'Content-Type'), |
8cc8ec79 |
595 | $aFetchItems = array('FLAGS', 'RFC822.SIZE', 'INTERNALDATE')) { |
ffb776c4 |
596 | |
324ac3c5 |
597 | $aMessageList = array(); |
ffb776c4 |
598 | |
91c27aee |
599 | /** |
600 | * Catch other priority headers as well |
601 | */ |
602 | if (in_array('X-Priority',$aHeaderFields,true)) { |
603 | $aHeaderFields[] = 'Importance'; |
604 | $aHeaderFields[] = 'Priority'; |
605 | } |
606 | |
c075fcfe |
607 | $bUidFetch = ! in_array('UID', $aFetchItems, true); |
8cc8ec79 |
608 | |
97f7ddf2 |
609 | /* Get the small headers for each message in $msg_list */ |
258d61ed |
610 | if ($msg_list !== NULL) { |
a18594b2 |
611 | $msgs_str = sqimap_message_list_squisher($msg_list); |
ffb776c4 |
612 | /* |
613 | * We need to return the data in the same order as the caller supplied |
614 | * in $msg_list, but IMAP servers are free to return responses in |
615 | * whatever order they wish... So we need to re-sort manually |
616 | */ |
8cc8ec79 |
617 | if ($bUidFetch) { |
618 | for ($i = 0; $i < sizeof($msg_list); $i++) { |
324ac3c5 |
619 | $aMessageList["$msg_list[$i]"] = array(); |
8cc8ec79 |
620 | } |
ffb776c4 |
621 | } |
1c198ef7 |
622 | } else { |
a18594b2 |
623 | $msgs_str = '1:*'; |
624 | } |
ffb776c4 |
625 | |
3411d4ec |
626 | /* |
ffb776c4 |
627 | * Create the query |
628 | */ |
cdca177a |
629 | |
ffb776c4 |
630 | $sFetchItems = ''; |
631 | $query = "FETCH $msgs_str ("; |
632 | if (count($aFetchItems)) { |
633 | $sFetchItems = implode(' ',$aFetchItems); |
634 | } |
635 | if (count($aHeaderFields)) { |
636 | $sHeaderFields = implode(' ',$aHeaderFields); |
637 | $sFetchItems .= ' BODY.PEEK[HEADER.FIELDS ('.$sHeaderFields.')]'; |
7b07404c |
638 | } |
ffb776c4 |
639 | $query .= trim($sFetchItems) . ')'; |
324ac3c5 |
640 | $aResponse = sqimap_run_command_list ($imap_stream, $query, true, $response, $message, $bUidFetch); |
641 | $aMessages = parseFetch($aResponse,$aMessageList); |
642 | array_reverse($aMessages); |
643 | return $aMessages; |
644 | } |
8cc8ec79 |
645 | |
8315c94c |
646 | |
258d61ed |
647 | /** |
648 | * Parses a fetch response, currently it can hande FLAGS, HEADERS, RFC822.SIZE, INTERNALDATE and UID |
649 | * @param array $aResponse Imap response |
650 | * @param array $aMessageList Placeholder array for results. The keys of the |
651 | * placeholder array should be the UID so we can reconstruct the order. |
652 | * @return array $aMessageList associative array with messages. Key is the UID, value is an associative array |
653 | * @author Marc Groot Koerkamp |
654 | */ |
324ac3c5 |
655 | function parseFetch($aResponse,$aMessageList = array()) { |
91c27aee |
656 | for ($j=0,$iCnt=count($aResponse);$j<$iCnt;++$j) { |
657 | $aMsg = array(); |
a18594b2 |
658 | |
91c27aee |
659 | $read = implode('',$aResponse[$j]); |
660 | // free up memmory |
661 | unset($aResponse[$j]); /* unset does not reindex the array. the for loop is safe */ |
1c198ef7 |
662 | /* |
91c27aee |
663 | * #id<space>FETCH<space>( |
664 | */ |
1c198ef7 |
665 | |
a18594b2 |
666 | /* extract the message id */ |
91c27aee |
667 | $i_space = strpos($read,' ',2);/* position 2ed <space> */ |
668 | $id = substr($read,2/* skip "*<space>" */,$i_space -2); |
669 | $aMsg['ID'] = $id; |
a18594b2 |
670 | $fetch = substr($read,$i_space+1,5); |
671 | if (!is_numeric($id) && $fetch !== 'FETCH') { |
91c27aee |
672 | $aMsg['ERROR'] = $read; // htmlspecialchars should be done just before display. this is backend code |
8cc8ec79 |
673 | break; |
a18594b2 |
674 | } |
675 | $i = strpos($read,'(',$i_space+5); |
676 | $read = substr($read,$i+1); |
677 | $i_len = strlen($read); |
678 | $i = 0; |
679 | while ($i < $i_len && $i !== false) { |
680 | /* get argument */ |
681 | $read = trim(substr($read,$i)); |
682 | $i_len = strlen($read); |
683 | $i = strpos($read,' '); |
684 | $arg = substr($read,0,$i); |
685 | ++$i; |
91c27aee |
686 | /* |
687 | * use allcaps for imap items and lowcaps for headers as key for the $aMsg array |
688 | */ |
a18594b2 |
689 | switch ($arg) |
690 | { |
691 | case 'UID': |
692 | $i_pos = strpos($read,' ',$i); |
693 | if (!$i_pos) { |
694 | $i_pos = strpos($read,')',$i); |
cdca177a |
695 | } |
a18594b2 |
696 | if ($i_pos) { |
697 | $unique_id = substr($read,$i,$i_pos-$i); |
698 | $i = $i_pos+1; |
699 | } else { |
700 | break 3; |
cdca177a |
701 | } |
a18594b2 |
702 | break; |
703 | case 'FLAGS': |
704 | $flags = parseArray($read,$i); |
705 | if (!$flags) break 3; |
ffb776c4 |
706 | $aFlags = array(); |
a18594b2 |
707 | foreach ($flags as $flag) { |
708 | $flag = strtolower($flag); |
ffb776c4 |
709 | $aFlags[$flag] = true; |
cdca177a |
710 | } |
91c27aee |
711 | $aMsg['FLAGS'] = $aFlags; |
a18594b2 |
712 | break; |
713 | case 'RFC822.SIZE': |
714 | $i_pos = strpos($read,' ',$i); |
715 | if (!$i_pos) { |
716 | $i_pos = strpos($read,')',$i); |
cdca177a |
717 | } |
a18594b2 |
718 | if ($i_pos) { |
91c27aee |
719 | $aMsg['SIZE'] = substr($read,$i,$i_pos-$i); |
a18594b2 |
720 | $i = $i_pos+1; |
721 | } else { |
722 | break 3; |
723 | } |
8cc8ec79 |
724 | break; |
725 | case 'ENVELOPE': |
91c27aee |
726 | // sqimap_parse_address($read,$i,$aMsg); |
727 | break; // to be implemented, moving imap code out of the Message class |
8cc8ec79 |
728 | case 'BODYSTRUCTURE': |
91c27aee |
729 | break; // to be implemented, moving imap code out of the Message class |
a18594b2 |
730 | case 'INTERNALDATE': |
91c27aee |
731 | $aMsg['INTERNALDATE'] = trim(str_replace(' ', ' ',parseString($read,$i))); |
a18594b2 |
732 | break; |
733 | case 'BODY.PEEK[HEADER.FIELDS': |
734 | case 'BODY[HEADER.FIELDS': |
91c27aee |
735 | $i = strpos($read,'{',$i); // header is always returned as literal because it contain \n characters |
a18594b2 |
736 | $header = parseString($read,$i); |
92a52cda |
737 | if ($header === false) break 2; |
2a9b0fad |
738 | /* First we replace all \r\n by \n, and unfold the header */ |
739 | $hdr = trim(str_replace(array("\r\n", "\n\t", "\n "),array("\n", ' ', ' '), $header)); |
91c27aee |
740 | /* Now we can make a new header array with |
741 | each element representing a headerline */ |
742 | $aHdr = explode("\n" , $hdr); |
2714d4ff |
743 | $aReceived = array(); |
91c27aee |
744 | foreach ($aHdr as $line) { |
a18594b2 |
745 | $pos = strpos($line, ':'); |
746 | if ($pos > 0) { |
747 | $field = strtolower(substr($line, 0, $pos)); |
748 | if (!strstr($field,' ')) { /* valid field */ |
749 | $value = trim(substr($line, $pos+1)); |
91c27aee |
750 | switch($field) { |
751 | case 'date': |
752 | $aMsg['date'] = trim(str_replace(' ', ' ', $value)); |
753 | break; |
754 | case 'x-priority': $aMsg['x-priority'] = ($value) ? (int) $value{0} : 3; break; |
755 | case 'priority': |
756 | case 'importance': |
757 | if (!isset($aMsg['x-priority'])) { |
758 | $value = strtolower(array_shift(split('/\w/',trim($value)))); |
759 | if (is_numeric($value)) { |
760 | $value = (int) $value; |
761 | } elseif ( $value == 'non-urgent' || $value == 'low' ) { |
762 | $value = 3; |
763 | } elseif ( $value == 'urgent' || $value == 'high' ) { |
764 | $value = 1; |
765 | } else { |
766 | // default is normal priority |
767 | $value = 3; |
768 | } |
769 | $aMsg['x-priority'] = $value; |
770 | } |
771 | break; |
772 | case 'content-type': |
773 | $type = $value; |
774 | if ($pos = strpos($type, ";")) { |
775 | $type = substr($type, 0, $pos); |
776 | } |
777 | $type = explode("/", $type); |
778 | if(!is_array($type) || count($type) < 2) { |
779 | $aMsg['content-type'] = array('text','plain'); |
780 | } else { |
781 | $aMsg['content-type'] = array(strtolower($type[0]),strtolower($type[1])); |
782 | } |
783 | break; |
784 | case 'received': |
785 | $aMsg['received'][] = $value; |
786 | break; |
787 | default: |
788 | $aMsg[$field] = $value; |
789 | break; |
a18594b2 |
790 | } |
cdca177a |
791 | } |
792 | } |
793 | } |
a18594b2 |
794 | break; |
795 | default: |
796 | ++$i; |
797 | break; |
cdca177a |
798 | } |
cdca177a |
799 | } |
6201339c |
800 | $msgi ="$unique_id"; |
324ac3c5 |
801 | $msg['UID'] = $unique_id; |
91c27aee |
802 | $aMessageList[$msgi] = $aMsg; |
97f7ddf2 |
803 | } |
324ac3c5 |
804 | return $aMessageList; |
97f7ddf2 |
805 | } |
806 | |
258d61ed |
807 | /** |
808 | * Work in process |
809 | * @private |
810 | * @author Marc Groot Koerkamp |
811 | */ |
8cc8ec79 |
812 | function sqimap_parse_envelope($read, &$i, &$msg) { |
813 | $arg_no = 0; |
814 | $arg_a = array(); |
815 | ++$i; |
816 | for ($cnt = strlen($read); ($i < $cnt) && ($read{$i} != ')'); ++$i) { |
817 | $char = strtoupper($read{$i}); |
818 | switch ($char) { |
819 | case '{': |
820 | case '"': |
821 | $arg_a[] = parseString($read,$i); |
822 | ++$arg_no; |
823 | break; |
824 | case 'N': |
825 | /* probably NIL argument */ |
826 | if (strtoupper(substr($read, $i, 3)) == 'NIL') { |
827 | $arg_a[] = ''; |
828 | ++$arg_no; |
829 | $i += 2; |
830 | } |
831 | break; |
832 | case '(': |
833 | /* Address structure (with group support) |
834 | * Note: Group support is useless on SMTP connections |
835 | * because the protocol doesn't support it |
836 | */ |
837 | $addr_a = array(); |
838 | $group = ''; |
839 | $a=0; |
840 | for (; $i < $cnt && $read{$i} != ')'; ++$i) { |
841 | if ($read{$i} == '(') { |
842 | $addr = sqimap_parse_address($read, $i); |
843 | if (($addr[3] == '') && ($addr[2] != '')) { |
844 | /* start of group */ |
845 | $group = $addr[2]; |
846 | $group_addr = $addr; |
847 | $j = $a; |
848 | } else if ($group && ($addr[3] == '') && ($addr[2] == '')) { |
849 | /* end group */ |
850 | if ($a == ($j+1)) { /* no group members */ |
851 | $group_addr[4] = $group; |
852 | $group_addr[2] = ''; |
853 | $group_addr[0] = "$group: Undisclosed recipients;"; |
854 | $addr_a[] = $group_addr; |
855 | $group =''; |
856 | } |
857 | } else { |
858 | $addr[4] = $group; |
859 | $addr_a[] = $addr; |
860 | } |
861 | ++$a; |
862 | } |
863 | } |
864 | $arg_a[] = $addr_a; |
865 | break; |
866 | default: break; |
867 | } |
868 | } |
869 | |
870 | if (count($arg_a) > 9) { |
871 | $d = strtr($arg_a[0], array(' ' => ' ')); |
872 | $d = explode(' ', $d); |
cf92500b |
873 | if (!$arg_a[1]) $arg_a[1] = ''; |
8cc8ec79 |
874 | $msg['DATE'] = $d; /* argument 1: date */ |
875 | $msg['SUBJECT'] = $arg_a[1]; /* argument 2: subject */ |
876 | $msg['FROM'] = is_array($arg_a[2]) ? $arg_a[2][0] : ''; /* argument 3: from */ |
877 | $msg['SENDER'] = is_array($arg_a[3]) ? $arg_a[3][0] : ''; /* argument 4: sender */ |
878 | $msg['REPLY-TO'] = is_array($arg_a[4]) ? $arg_a[4][0] : ''; /* argument 5: reply-to */ |
879 | $msg['TO'] = $arg_a[5]; /* argument 6: to */ |
880 | $msg['CC'] = $arg_a[6]; /* argument 7: cc */ |
881 | $msg['BCC'] = $arg_a[7]; /* argument 8: bcc */ |
882 | $msg['IN-REPLY-TO'] = $arg_a[8]; /* argument 9: in-reply-to */ |
883 | $msg['MESSAGE-ID'] = $arg_a[9]; /* argument 10: message-id */ |
884 | } |
885 | } |
886 | |
8315c94c |
887 | |
258d61ed |
888 | /** |
889 | * Work in process |
890 | * @private |
891 | * @author Marc Groot Koerkamp |
892 | */ |
8cc8ec79 |
893 | function sqimap_parse_address($read, &$i) { |
894 | $arg_a = array(); |
895 | for (; $read{$i} != ')'; ++$i) { |
896 | $char = strtoupper($read{$i}); |
897 | switch ($char) { |
898 | case '{': |
899 | case '"': $arg_a[] = parseString($read,$i); break; |
900 | case 'n': |
901 | case 'N': |
902 | if (strtoupper(substr($read, $i, 3)) == 'NIL') { |
903 | $arg_a[] = ''; |
904 | $i += 2; |
905 | } |
906 | break; |
907 | default: break; |
908 | } |
909 | } |
910 | |
911 | if (count($arg_a) == 4) { |
912 | return $arg_a; |
913 | |
914 | // $adr = new AddressStructure(); |
915 | // $adr->personal = $arg_a[0]; |
916 | // $adr->adl = $arg_a[1]; |
917 | // $adr->mailbox = $arg_a[2]; |
918 | // $adr->host = $arg_a[3]; |
919 | } else { |
920 | $adr = ''; |
921 | } |
922 | return $adr; |
923 | } |
924 | |
8315c94c |
925 | |
48af4b64 |
926 | /** |
258d61ed |
927 | * Returns a message array with all the information about a message. |
928 | * See the documentation folder for more information about this array. |
929 | * |
930 | * @param resource $imap_stream imap connection |
931 | * @param integer $id uid of the message |
932 | * @param string $mailbox used for error handling, can be removed because we should return an error code and generate the message elsewhere |
933 | * @return Message Message object |
934 | */ |
8315c94c |
935 | function sqimap_get_message($imap_stream, $id, $mailbox) { |
461eda6c |
936 | // typecast to int to prohibit 1:* msgs sets |
937 | $id = (int) $id; |
2d34da11 |
938 | $flags = array(); |
8315c94c |
939 | $read = sqimap_run_command($imap_stream, "FETCH $id (FLAGS BODYSTRUCTURE)", true, $response, $message, TRUE); |
114f2a24 |
940 | if ($read) { |
b69a13a4 |
941 | if (preg_match('/.+FLAGS\s\((.*)\)\s/AUi',$read[0],$regs)) { |
942 | if (trim($regs[1])) { |
943 | $flags = preg_split('/ /', $regs[1],-1,'PREG_SPLIT_NI_EMPTY'); |
944 | } |
945 | } |
114f2a24 |
946 | } else { |
b69a13a4 |
947 | /* the message was not found, maybe the mailbox was modified? */ |
948 | global $sort, $startMessage, $color; |
949 | |
950 | $errmessage = _("The server couldn't find the message you requested.") . |
0fdc2fb6 |
951 | '<p>'._("Most probably your message list was out of date and the message has been moved away or deleted (perhaps by another program accessing the same mailbox)."); |
b69a13a4 |
952 | /* this will include a link back to the message list */ |
461eda6c |
953 | error_message($errmessage, $mailbox, $sort, (int) $startMessage, $color); |
b69a13a4 |
954 | exit; |
1c198ef7 |
955 | } |
2d34da11 |
956 | $bodystructure = implode('',$read); |
957 | $msg = mime_structure($bodystructure,$flags); |
8315c94c |
958 | $read = sqimap_run_command($imap_stream, "FETCH $id BODY[HEADER]", true, $response, $message, TRUE); |
19d470aa |
959 | $rfc822_header = new Rfc822Header(); |
767ace1f |
960 | $rfc822_header->parseHeader($read); |
961 | $msg->rfc822_header = $rfc822_header; |
2d34da11 |
962 | return $msg; |
97f7ddf2 |
963 | } |
964 | |
9b935fea |
965 | ?> |