|
0
|
1 <?php
|
|
|
2
|
|
|
3 /**
|
|
|
4 +-----------------------------------------------------------------------+
|
|
|
5 | This file is part of the Roundcube Webmail client |
|
|
|
6 | Copyright (C) 2005-2011, The Roundcube Dev Team |
|
|
|
7 | Copyright (C) 2011, Kolab Systems AG |
|
|
|
8 | |
|
|
|
9 | Licensed under the GNU General Public License version 3 or |
|
|
|
10 | any later version with exceptions for skins & plugins. |
|
|
|
11 | See the README file for a full license statement. |
|
|
|
12 | |
|
|
|
13 | PURPOSE: |
|
|
|
14 | THREAD response handler |
|
|
|
15 +-----------------------------------------------------------------------+
|
|
|
16 | Author: Thomas Bruederli <roundcube@gmail.com> |
|
|
|
17 | Author: Aleksander Machniak <alec@alec.pl> |
|
|
|
18 +-----------------------------------------------------------------------+
|
|
|
19 */
|
|
|
20
|
|
|
21 /**
|
|
|
22 * Class for accessing IMAP's THREAD result
|
|
|
23 *
|
|
|
24 * @package Framework
|
|
|
25 * @subpackage Storage
|
|
|
26 */
|
|
|
27 class rcube_result_thread
|
|
|
28 {
|
|
|
29 public $incomplete = false;
|
|
|
30
|
|
|
31 protected $raw_data;
|
|
|
32 protected $mailbox;
|
|
|
33 protected $meta = array();
|
|
|
34 protected $order = 'ASC';
|
|
|
35
|
|
|
36 const SEPARATOR_ELEMENT = ' ';
|
|
|
37 const SEPARATOR_ITEM = '~';
|
|
|
38 const SEPARATOR_LEVEL = ':';
|
|
|
39
|
|
|
40
|
|
|
41 /**
|
|
|
42 * Object constructor.
|
|
|
43 */
|
|
|
44 public function __construct($mailbox = null, $data = null)
|
|
|
45 {
|
|
|
46 $this->mailbox = $mailbox;
|
|
|
47 $this->init($data);
|
|
|
48 }
|
|
|
49
|
|
|
50 /**
|
|
|
51 * Initializes object with IMAP command response
|
|
|
52 *
|
|
|
53 * @param string $data IMAP response string
|
|
|
54 */
|
|
|
55 public function init($data = null)
|
|
|
56 {
|
|
|
57 $this->meta = array();
|
|
|
58
|
|
|
59 $data = explode('*', (string)$data);
|
|
|
60
|
|
|
61 // ...skip unilateral untagged server responses
|
|
|
62 for ($i=0, $len=count($data); $i<$len; $i++) {
|
|
|
63 if (preg_match('/^ THREAD/i', $data[$i])) {
|
|
|
64 // valid response, initialize raw_data for is_error()
|
|
|
65 $this->raw_data = '';
|
|
|
66 $data[$i] = substr($data[$i], 7);
|
|
|
67 break;
|
|
|
68 }
|
|
|
69
|
|
|
70 unset($data[$i]);
|
|
|
71 }
|
|
|
72
|
|
|
73 if (empty($data)) {
|
|
|
74 return;
|
|
|
75 }
|
|
|
76
|
|
25
|
77 $data = array_shift($data);
|
|
0
|
78 $data = trim($data);
|
|
|
79 $data = preg_replace('/[\r\n]/', '', $data);
|
|
|
80 $data = preg_replace('/\s+/', ' ', $data);
|
|
|
81
|
|
23
|
82 $this->raw_data = empty($data) ? '' : $this->parse_thread($data);
|
|
0
|
83 }
|
|
|
84
|
|
|
85 /**
|
|
|
86 * Checks the result from IMAP command
|
|
|
87 *
|
|
|
88 * @return bool True if the result is an error, False otherwise
|
|
|
89 */
|
|
|
90 public function is_error()
|
|
|
91 {
|
|
|
92 return $this->raw_data === null;
|
|
|
93 }
|
|
|
94
|
|
|
95 /**
|
|
|
96 * Checks if the result is empty
|
|
|
97 *
|
|
|
98 * @return bool True if the result is empty, False otherwise
|
|
|
99 */
|
|
|
100 public function is_empty()
|
|
|
101 {
|
|
|
102 return empty($this->raw_data);
|
|
|
103 }
|
|
|
104
|
|
|
105 /**
|
|
|
106 * Returns number of elements (threads) in the result
|
|
|
107 *
|
|
|
108 * @return int Number of elements
|
|
|
109 */
|
|
|
110 public function count()
|
|
|
111 {
|
|
19
|
112 if (!empty($this->meta['count'])) {
|
|
0
|
113 return $this->meta['count'];
|
|
19
|
114 }
|
|
0
|
115 if (empty($this->raw_data)) {
|
|
|
116 $this->meta['count'] = 0;
|
|
|
117 }
|
|
|
118 else {
|
|
|
119 $this->meta['count'] = 1 + substr_count($this->raw_data, self::SEPARATOR_ELEMENT);
|
|
|
120 }
|
|
|
121
|
|
|
122 if (!$this->meta['count'])
|
|
|
123 $this->meta['messages'] = 0;
|
|
|
124
|
|
|
125 return $this->meta['count'];
|
|
|
126 }
|
|
|
127
|
|
|
128 /**
|
|
|
129 * Returns number of all messages in the result
|
|
|
130 *
|
|
|
131 * @return int Number of elements
|
|
|
132 */
|
|
|
133 public function count_messages()
|
|
|
134 {
|
|
23
|
135 if (!empty($this->meta['messages'])) {
|
|
0
|
136 return $this->meta['messages'];
|
|
23
|
137 }
|
|
0
|
138
|
|
|
139 if (empty($this->raw_data)) {
|
|
|
140 $this->meta['messages'] = 0;
|
|
|
141 }
|
|
|
142 else {
|
|
|
143 $this->meta['messages'] = 1
|
|
|
144 + substr_count($this->raw_data, self::SEPARATOR_ELEMENT)
|
|
|
145 + substr_count($this->raw_data, self::SEPARATOR_ITEM);
|
|
|
146 }
|
|
|
147
|
|
|
148 if ($this->meta['messages'] == 0 || $this->meta['messages'] == 1)
|
|
|
149 $this->meta['count'] = $this->meta['messages'];
|
|
|
150
|
|
|
151 return $this->meta['messages'];
|
|
|
152 }
|
|
|
153
|
|
|
154 /**
|
|
|
155 * Returns maximum message identifier in the result
|
|
|
156 *
|
|
23
|
157 * @return int|null Maximum message identifier
|
|
0
|
158 */
|
|
|
159 public function max()
|
|
|
160 {
|
|
23
|
161 if ($this->is_empty()) {
|
|
|
162 return null;
|
|
|
163 }
|
|
|
164
|
|
0
|
165 if (!isset($this->meta['max'])) {
|
|
|
166 $this->meta['max'] = (int) @max($this->get());
|
|
|
167 }
|
|
|
168 return $this->meta['max'];
|
|
|
169 }
|
|
|
170
|
|
|
171 /**
|
|
|
172 * Returns minimum message identifier in the result
|
|
|
173 *
|
|
23
|
174 * @return int|null Minimum message identifier
|
|
0
|
175 */
|
|
|
176 public function min()
|
|
|
177 {
|
|
23
|
178 if ($this->is_empty()) {
|
|
|
179 return null;
|
|
|
180 }
|
|
|
181
|
|
0
|
182 if (!isset($this->meta['min'])) {
|
|
|
183 $this->meta['min'] = (int) @min($this->get());
|
|
|
184 }
|
|
|
185 return $this->meta['min'];
|
|
|
186 }
|
|
|
187
|
|
|
188 /**
|
|
|
189 * Slices data set.
|
|
|
190 *
|
|
23
|
191 * @param int $offset Offset (as for PHP's array_slice())
|
|
|
192 * @param int $length Number of elements (as for PHP's array_slice())
|
|
0
|
193 */
|
|
|
194 public function slice($offset, $length)
|
|
|
195 {
|
|
|
196 $data = explode(self::SEPARATOR_ELEMENT, $this->raw_data);
|
|
|
197 $data = array_slice($data, $offset, $length);
|
|
|
198
|
|
|
199 $this->meta = array();
|
|
|
200 $this->meta['count'] = count($data);
|
|
|
201 $this->raw_data = implode(self::SEPARATOR_ELEMENT, $data);
|
|
|
202 }
|
|
|
203
|
|
|
204 /**
|
|
|
205 * Filters data set. Removes threads not listed in $roots list.
|
|
|
206 *
|
|
|
207 * @param array $roots List of IDs of thread roots.
|
|
|
208 */
|
|
|
209 public function filter($roots)
|
|
|
210 {
|
|
|
211 $datalen = strlen($this->raw_data);
|
|
|
212 $roots = array_flip($roots);
|
|
|
213 $result = '';
|
|
|
214 $start = 0;
|
|
|
215
|
|
|
216 $this->meta = array();
|
|
|
217 $this->meta['count'] = 0;
|
|
|
218
|
|
23
|
219 while ($start < $datalen
|
|
|
220 && (($pos = strpos($this->raw_data, self::SEPARATOR_ELEMENT, $start)) !== false
|
|
|
221 || ($pos = $datalen))
|
|
0
|
222 ) {
|
|
|
223 $len = $pos - $start;
|
|
|
224 $elem = substr($this->raw_data, $start, $len);
|
|
|
225 $start = $pos + 1;
|
|
|
226
|
|
|
227 // extract root message ID
|
|
|
228 if ($npos = strpos($elem, self::SEPARATOR_ITEM)) {
|
|
|
229 $root = (int) substr($elem, 0, $npos);
|
|
|
230 }
|
|
|
231 else {
|
|
|
232 $root = $elem;
|
|
|
233 }
|
|
|
234
|
|
|
235 if (isset($roots[$root])) {
|
|
|
236 $this->meta['count']++;
|
|
|
237 $result .= self::SEPARATOR_ELEMENT . $elem;
|
|
|
238 }
|
|
|
239 }
|
|
|
240
|
|
|
241 $this->raw_data = ltrim($result, self::SEPARATOR_ELEMENT);
|
|
|
242 }
|
|
|
243
|
|
|
244 /**
|
|
|
245 * Reverts order of elements in the result
|
|
|
246 */
|
|
|
247 public function revert()
|
|
|
248 {
|
|
|
249 $this->order = $this->order == 'ASC' ? 'DESC' : 'ASC';
|
|
|
250
|
|
|
251 if (empty($this->raw_data)) {
|
|
|
252 return;
|
|
|
253 }
|
|
|
254
|
|
|
255 $data = explode(self::SEPARATOR_ELEMENT, $this->raw_data);
|
|
|
256 $data = array_reverse($data);
|
|
|
257 $this->raw_data = implode(self::SEPARATOR_ELEMENT, $data);
|
|
|
258
|
|
|
259 $this->meta['pos'] = array();
|
|
|
260 }
|
|
|
261
|
|
|
262 /**
|
|
|
263 * Check if the given message ID exists in the object
|
|
|
264 *
|
|
|
265 * @param int $msgid Message ID
|
|
|
266 * @param bool $get_index When enabled element's index will be returned.
|
|
|
267 * Elements are indexed starting with 0
|
|
|
268 *
|
|
|
269 * @return boolean True on success, False if message ID doesn't exist
|
|
|
270 */
|
|
|
271 public function exists($msgid, $get_index = false)
|
|
|
272 {
|
|
|
273 $msgid = (int) $msgid;
|
|
|
274 $begin = implode('|', array(
|
|
|
275 '^',
|
|
|
276 preg_quote(self::SEPARATOR_ELEMENT, '/'),
|
|
|
277 preg_quote(self::SEPARATOR_LEVEL, '/'),
|
|
|
278 ));
|
|
|
279 $end = implode('|', array(
|
|
|
280 '$',
|
|
|
281 preg_quote(self::SEPARATOR_ELEMENT, '/'),
|
|
|
282 preg_quote(self::SEPARATOR_ITEM, '/'),
|
|
|
283 ));
|
|
|
284
|
|
|
285 if (preg_match("/($begin)$msgid($end)/", $this->raw_data, $m,
|
|
23
|
286 $get_index ? PREG_OFFSET_CAPTURE : 0)
|
|
0
|
287 ) {
|
|
|
288 if ($get_index) {
|
|
|
289 $idx = 0;
|
|
|
290 if ($m[0][1]) {
|
|
|
291 $idx = substr_count($this->raw_data, self::SEPARATOR_ELEMENT, 0, $m[0][1]+1)
|
|
|
292 + substr_count($this->raw_data, self::SEPARATOR_ITEM, 0, $m[0][1]+1);
|
|
|
293 }
|
|
|
294 // cache position of this element, so we can use it in get_element()
|
|
|
295 $this->meta['pos'][$idx] = (int)$m[0][1];
|
|
|
296
|
|
|
297 return $idx;
|
|
|
298 }
|
|
|
299 return true;
|
|
|
300 }
|
|
|
301
|
|
|
302 return false;
|
|
|
303 }
|
|
|
304
|
|
|
305 /**
|
|
|
306 * Return IDs of all messages in the result. Threaded data will be flattened.
|
|
|
307 *
|
|
|
308 * @return array List of message identifiers
|
|
|
309 */
|
|
|
310 public function get()
|
|
|
311 {
|
|
|
312 if (empty($this->raw_data)) {
|
|
|
313 return array();
|
|
|
314 }
|
|
|
315
|
|
|
316 $regexp = '/(' . preg_quote(self::SEPARATOR_ELEMENT, '/')
|
|
|
317 . '|' . preg_quote(self::SEPARATOR_ITEM, '/') . '[0-9]+' . preg_quote(self::SEPARATOR_LEVEL, '/')
|
|
|
318 .')/';
|
|
|
319
|
|
|
320 return preg_split($regexp, $this->raw_data);
|
|
|
321 }
|
|
|
322
|
|
|
323 /**
|
|
|
324 * Return all messages in the result.
|
|
|
325 *
|
|
|
326 * @return array List of message identifiers
|
|
|
327 */
|
|
|
328 public function get_compressed()
|
|
|
329 {
|
|
|
330 if (empty($this->raw_data)) {
|
|
|
331 return '';
|
|
|
332 }
|
|
|
333
|
|
|
334 return rcube_imap_generic::compressMessageSet($this->get());
|
|
|
335 }
|
|
|
336
|
|
|
337 /**
|
|
|
338 * Return result element at specified index (all messages, not roots)
|
|
|
339 *
|
|
|
340 * @param int|string $index Element's index or "FIRST" or "LAST"
|
|
|
341 *
|
|
|
342 * @return int Element value
|
|
|
343 */
|
|
|
344 public function get_element($index)
|
|
|
345 {
|
|
|
346 $count = $this->count();
|
|
|
347
|
|
|
348 if (!$count) {
|
|
|
349 return null;
|
|
|
350 }
|
|
|
351
|
|
|
352 // first element
|
|
|
353 if ($index === 0 || $index === '0' || $index === 'FIRST') {
|
|
|
354 preg_match('/^([0-9]+)/', $this->raw_data, $m);
|
|
|
355 $result = (int) $m[1];
|
|
|
356 return $result;
|
|
|
357 }
|
|
|
358
|
|
|
359 // last element
|
|
|
360 if ($index === 'LAST' || $index == $count-1) {
|
|
|
361 preg_match('/([0-9]+)$/', $this->raw_data, $m);
|
|
|
362 $result = (int) $m[1];
|
|
|
363 return $result;
|
|
|
364 }
|
|
|
365
|
|
|
366 // do we know the position of the element or the neighbour of it?
|
|
|
367 if (!empty($this->meta['pos'])) {
|
|
|
368 $element = preg_quote(self::SEPARATOR_ELEMENT, '/');
|
|
|
369 $item = preg_quote(self::SEPARATOR_ITEM, '/') . '[0-9]+' . preg_quote(self::SEPARATOR_LEVEL, '/') .'?';
|
|
|
370 $regexp = '(' . $element . '|' . $item . ')';
|
|
|
371
|
|
|
372 if (isset($this->meta['pos'][$index])) {
|
|
23
|
373 if (preg_match('/([0-9]+)/', $this->raw_data, $m, 0, $this->meta['pos'][$index])) {
|
|
0
|
374 $result = $m[1];
|
|
23
|
375 }
|
|
0
|
376 }
|
|
|
377 else if (isset($this->meta['pos'][$index-1])) {
|
|
|
378 // get chunk of data after previous element
|
|
|
379 $data = substr($this->raw_data, $this->meta['pos'][$index-1]+1, 50);
|
|
|
380 $data = preg_replace('/^[0-9]+/', '', $data); // remove UID at $index position
|
|
|
381 $data = preg_replace("/^$regexp/", '', $data); // remove separator
|
|
|
382 if (preg_match('/^([0-9]+)/', $data, $m))
|
|
|
383 $result = $m[1];
|
|
|
384 }
|
|
|
385 else if (isset($this->meta['pos'][$index+1])) {
|
|
|
386 // get chunk of data before next element
|
|
|
387 $pos = max(0, $this->meta['pos'][$index+1] - 50);
|
|
|
388 $len = min(50, $this->meta['pos'][$index+1]);
|
|
|
389 $data = substr($this->raw_data, $pos, $len);
|
|
|
390 $data = preg_replace("/$regexp\$/", '', $data); // remove separator
|
|
|
391
|
|
|
392 if (preg_match('/([0-9]+)$/', $data, $m))
|
|
|
393 $result = $m[1];
|
|
|
394 }
|
|
|
395
|
|
|
396 if (isset($result)) {
|
|
|
397 return (int) $result;
|
|
|
398 }
|
|
|
399 }
|
|
|
400
|
|
|
401 // Finally use less effective method
|
|
|
402 $data = $this->get();
|
|
|
403
|
|
23
|
404 return $data[$index] ?? null;
|
|
0
|
405 }
|
|
|
406
|
|
|
407 /**
|
|
|
408 * Returns response parameters e.g. MAILBOX, ORDER
|
|
|
409 *
|
|
|
410 * @param string $param Parameter name
|
|
|
411 *
|
|
|
412 * @return array|string Response parameters or parameter value
|
|
|
413 */
|
|
|
414 public function get_parameters($param=null)
|
|
|
415 {
|
|
|
416 $params = array();
|
|
|
417 $params['MAILBOX'] = $this->mailbox;
|
|
|
418 $params['ORDER'] = $this->order;
|
|
|
419
|
|
|
420 if ($param !== null) {
|
|
|
421 return $params[$param];
|
|
|
422 }
|
|
|
423
|
|
|
424 return $params;
|
|
|
425 }
|
|
|
426
|
|
|
427 /**
|
|
|
428 * THREAD=REFS sorting implementation (based on provided index)
|
|
|
429 *
|
|
|
430 * @param rcube_result_index $index Sorted message identifiers
|
|
|
431 */
|
|
|
432 public function sort($index)
|
|
|
433 {
|
|
23
|
434 $this->order = $index->get_parameters('ORDER');
|
|
0
|
435
|
|
|
436 if (empty($this->raw_data)) {
|
|
|
437 return;
|
|
|
438 }
|
|
|
439
|
|
|
440 // when sorting search result it's good to make the index smaller
|
|
|
441 if ($index->count() != $this->count_messages()) {
|
|
|
442 $index->filter($this->get());
|
|
|
443 }
|
|
|
444
|
|
|
445 $result = array_fill_keys($index->get(), null);
|
|
|
446 $datalen = strlen($this->raw_data);
|
|
|
447 $start = 0;
|
|
|
448
|
|
|
449 // Here we're parsing raw_data twice, we want only one big array
|
|
|
450 // in memory at a time
|
|
|
451
|
|
|
452 // Assign roots
|
|
23
|
453 while (
|
|
|
454 ($start < $datalen && ($pos = strpos($this->raw_data, self::SEPARATOR_ELEMENT, $start)))
|
|
|
455 || ($start < $datalen && ($pos = $datalen))
|
|
0
|
456 ) {
|
|
|
457 $len = $pos - $start;
|
|
|
458 $elem = substr($this->raw_data, $start, $len);
|
|
|
459 $start = $pos + 1;
|
|
|
460
|
|
|
461 $items = explode(self::SEPARATOR_ITEM, $elem);
|
|
|
462 $root = (int) array_shift($items);
|
|
|
463
|
|
|
464 if ($root) {
|
|
|
465 $result[$root] = $root;
|
|
|
466 foreach ($items as $item) {
|
|
|
467 list($lv, $id) = explode(self::SEPARATOR_LEVEL, $item);
|
|
|
468 $result[$id] = $root;
|
|
|
469 }
|
|
|
470 }
|
|
|
471 }
|
|
|
472
|
|
|
473 // get only unique roots
|
|
|
474 $result = array_filter($result); // make sure there are no nulls
|
|
|
475 $result = array_unique($result);
|
|
|
476
|
|
|
477 // Re-sort raw data
|
|
|
478 $result = array_fill_keys($result, null);
|
|
|
479 $start = 0;
|
|
|
480
|
|
23
|
481 while (
|
|
|
482 ($start < $datalen && ($pos = strpos($this->raw_data, self::SEPARATOR_ELEMENT, $start)))
|
|
|
483 || ($start < $datalen && ($pos = $datalen))
|
|
0
|
484 ) {
|
|
|
485 $len = $pos - $start;
|
|
|
486 $elem = substr($this->raw_data, $start, $len);
|
|
|
487 $start = $pos + 1;
|
|
|
488
|
|
|
489 $npos = strpos($elem, self::SEPARATOR_ITEM);
|
|
|
490 $root = (int) ($npos ? substr($elem, 0, $npos) : $elem);
|
|
|
491
|
|
|
492 $result[$root] = $elem;
|
|
|
493 }
|
|
|
494
|
|
|
495 $this->raw_data = implode(self::SEPARATOR_ELEMENT, $result);
|
|
|
496 }
|
|
|
497
|
|
|
498 /**
|
|
|
499 * Returns data as tree
|
|
|
500 *
|
|
|
501 * @return array Data tree
|
|
|
502 */
|
|
|
503 public function get_tree()
|
|
|
504 {
|
|
|
505 $datalen = strlen($this->raw_data);
|
|
|
506 $result = array();
|
|
|
507 $start = 0;
|
|
|
508
|
|
23
|
509 while ($start < $datalen
|
|
|
510 && (($pos = strpos($this->raw_data, self::SEPARATOR_ELEMENT, $start)) !== false
|
|
|
511 || ($pos = $datalen))
|
|
0
|
512 ) {
|
|
|
513 $len = $pos - $start;
|
|
|
514 $elem = substr($this->raw_data, $start, $len);
|
|
|
515 $items = explode(self::SEPARATOR_ITEM, $elem);
|
|
|
516 $result[array_shift($items)] = $this->build_thread($items);
|
|
|
517 $start = $pos + 1;
|
|
|
518 }
|
|
|
519
|
|
|
520 return $result;
|
|
|
521 }
|
|
|
522
|
|
|
523 /**
|
|
|
524 * Returns thread depth and children data
|
|
|
525 *
|
|
|
526 * @return array Thread data
|
|
|
527 */
|
|
|
528 public function get_thread_data()
|
|
|
529 {
|
|
|
530 $data = $this->get_tree();
|
|
|
531 $depth = array();
|
|
|
532 $children = array();
|
|
|
533
|
|
|
534 $this->build_thread_data($data, $depth, $children);
|
|
|
535
|
|
|
536 return array($depth, $children);
|
|
|
537 }
|
|
|
538
|
|
|
539 /**
|
|
|
540 * Creates 'depth' and 'children' arrays from stored thread 'tree' data.
|
|
|
541 */
|
|
|
542 protected function build_thread_data($data, &$depth, &$children, $level = 0)
|
|
|
543 {
|
|
|
544 foreach ((array)$data as $key => $val) {
|
|
|
545 $empty = empty($val) || !is_array($val);
|
|
|
546 $children[$key] = !$empty;
|
|
|
547 $depth[$key] = $level;
|
|
|
548 if (!$empty) {
|
|
|
549 $this->build_thread_data($val, $depth, $children, $level + 1);
|
|
|
550 }
|
|
|
551 }
|
|
|
552 }
|
|
|
553
|
|
|
554 /**
|
|
|
555 * Converts part of the raw thread into an array
|
|
|
556 */
|
|
|
557 protected function build_thread($items, $level = 1, &$pos = 0)
|
|
|
558 {
|
|
|
559 $result = array();
|
|
|
560
|
|
|
561 for ($len=count($items); $pos < $len; $pos++) {
|
|
|
562 list($lv, $id) = explode(self::SEPARATOR_LEVEL, $items[$pos]);
|
|
|
563 if ($level == $lv) {
|
|
|
564 $pos++;
|
|
|
565 $result[$id] = $this->build_thread($items, $level+1, $pos);
|
|
|
566 }
|
|
|
567 else {
|
|
|
568 $pos--;
|
|
|
569 break;
|
|
|
570 }
|
|
|
571 }
|
|
|
572
|
|
|
573 return $result;
|
|
|
574 }
|
|
|
575
|
|
|
576 /**
|
|
|
577 * IMAP THREAD response parser
|
|
|
578 */
|
|
|
579 protected function parse_thread($str, $begin = 0, $end = 0, $depth = 0)
|
|
|
580 {
|
|
|
581 // Don't be tempted to change $str to pass by reference to speed this up - it will slow it down by about
|
|
23
|
582 // 7 times instead :-) See comments on https://www.php.net/references and this article:
|
|
|
583 // https://derickrethans.nl/files/phparch-php-variables-article.pdf
|
|
0
|
584 $node = '';
|
|
|
585 if (!$end) {
|
|
|
586 $end = strlen($str);
|
|
|
587 }
|
|
|
588
|
|
23
|
589 // Let's try to store data in max. compacted structure as a string,
|
|
0
|
590 // arrays handling is much more expensive
|
|
23
|
591 // For the following structure: THREAD (2)(3 6 (4 23)(44 7 96))((11)(12))
|
|
0
|
592 // -- 2
|
|
|
593 // -- 3
|
|
|
594 // \-- 6
|
|
|
595 // |-- 4
|
|
|
596 // | \-- 23
|
|
|
597 // |
|
|
|
598 // \-- 44
|
|
|
599 // \-- 7
|
|
|
600 // \-- 96
|
|
23
|
601 // -- 11
|
|
|
602 // \-- 12
|
|
0
|
603 //
|
|
23
|
604 // The output will be: 2 3~1:6~2:4~3:23~2:44~3:7~4:96 11~1:12
|
|
|
605 // Note: The "11" thread has no root, we use the first message as root
|
|
0
|
606
|
|
|
607 if ($str[$begin] != '(') {
|
|
|
608 // find next bracket
|
|
|
609 $stop = $begin + strcspn($str, '()', $begin, $end - $begin);
|
|
|
610 $messages = explode(' ', trim(substr($str, $begin, $stop - $begin)));
|
|
|
611
|
|
|
612 if (empty($messages)) {
|
|
|
613 return $node;
|
|
|
614 }
|
|
|
615
|
|
|
616 foreach ($messages as $msg) {
|
|
|
617 if ($msg) {
|
|
|
618 $node .= ($depth ? self::SEPARATOR_ITEM.$depth.self::SEPARATOR_LEVEL : '').$msg;
|
|
19
|
619 if (isset($this->meta['messages'])) {
|
|
|
620 $this->meta['messages']++;
|
|
|
621 }
|
|
|
622 else {
|
|
|
623 $this->meta['messages'] = 1;
|
|
|
624 }
|
|
0
|
625 $depth++;
|
|
|
626 }
|
|
|
627 }
|
|
|
628
|
|
|
629 if ($stop < $end) {
|
|
|
630 $node .= $this->parse_thread($str, $stop, $end, $depth);
|
|
|
631 }
|
|
|
632 }
|
|
|
633 else {
|
|
|
634 $off = $begin;
|
|
|
635 while ($off < $end) {
|
|
|
636 $start = $off;
|
|
|
637 $off++;
|
|
|
638 $n = 1;
|
|
|
639 while ($n > 0) {
|
|
|
640 $p = strpos($str, ')', $off);
|
|
|
641 if ($p === false) {
|
|
|
642 // error, wrong structure, mismatched brackets in IMAP THREAD response
|
|
|
643 // @TODO: write error to the log or maybe set $this->raw_data = null;
|
|
|
644 return $node;
|
|
|
645 }
|
|
|
646 $p1 = strpos($str, '(', $off);
|
|
|
647 if ($p1 !== false && $p1 < $p) {
|
|
|
648 $off = $p1 + 1;
|
|
|
649 $n++;
|
|
|
650 }
|
|
|
651 else {
|
|
|
652 $off = $p + 1;
|
|
|
653 $n--;
|
|
|
654 }
|
|
|
655 }
|
|
|
656
|
|
23
|
657 // Handle threads with missing parent by using first message as root
|
|
|
658 if (substr_compare($str, '((', $start, 2) === 0) {
|
|
|
659 // Extract the current thread, e.g. "((1)(2))"
|
|
|
660 $thread = substr($str, $start, $off - $start);
|
|
|
661 // Length of the first token, e.g. "(1)"
|
|
|
662 $len = strspn($thread, '(0123456789', 1) + 1;
|
|
|
663 // Extract the token and modify it to look like a thread root
|
|
|
664 $token = substr($thread, 1, $len);
|
|
|
665 // Warning: The order is important
|
|
|
666 $token = str_replace('(', '', $token);
|
|
|
667 $token = str_replace(' ', ' (', $token);
|
|
|
668 $token = str_replace(')', ' ', $token);
|
|
|
669 $thread = substr_replace($thread, $token, 1, $len);
|
|
|
670 // Parse the thread
|
|
|
671 $thread = $this->parse_thread($thread, 0, 0, $depth);
|
|
|
672 }
|
|
|
673 else {
|
|
|
674 $thread = $this->parse_thread($str, $start + 1, $off - 1, $depth);
|
|
|
675 }
|
|
|
676
|
|
0
|
677 if ($thread) {
|
|
|
678 if (!$depth) {
|
|
|
679 if ($node) {
|
|
|
680 $node .= self::SEPARATOR_ELEMENT;
|
|
|
681 }
|
|
|
682 }
|
|
|
683 $node .= $thread;
|
|
|
684 }
|
|
|
685 }
|
|
|
686 }
|
|
|
687
|
|
|
688 return $node;
|
|
|
689 }
|
|
|
690 }
|
