a2088a6c5f58f0e593676176f0c0dd75a69ed1ce
[squirrelmail.git] / functions / imap_mailbox.php
1 <?php
2
3 /**
4 * imap_mailbox.php
5 *
6 * Copyright (c) 1999-2002 The SquirrelMail Project Team
7 * Licensed under the GNU GPL. For full terms see the file COPYING.
8 *
9 * This impliments all functions that manipulate mailboxes
10 *
11 * $Id$
12 */
13 require_once(SM_PATH . 'functions/imap_utf7_encode_local.php');
14 require_once(SM_PATH . 'functions/imap_utf7_decode_local.php');
15 global $boxesnew;
16
17 class mailboxes {
18 var $mailboxname_full = '', $mailboxname_sub= '', $is_noselect = false,
19 $is_special = false, $is_root = false, $is_inbox = false, $is_sent = false,
20 $is_trash = false, $is_draft = false, $mbxs = array(),
21 $unseen = false, $total = false;
22
23 function addMbx($mbx, $delimiter, $start, $specialfirst) {
24 $ary = explode($delimiter, $mbx->mailboxname_full);
25 $mbx_parent = &$this;
26 for ($i=$start; $i < (count($ary) -1); $i++) {
27 $mbx_childs = &$mbx_parent->mbxs;
28 $found = false;
29 if ($mbx_childs) {
30 foreach ($mbx_childs as $key => $parent) {
31 if ($parent->mailboxname_sub == $ary[$i]) {
32 $mbx_parent = &$mbx_parent->mbxs[$key];
33 $found = true;
34 }
35 }
36 }
37 if (!$found) {
38 $no_select_mbx = new mailboxes();
39 if (isset($mbx_parent->mailboxname_full) && $mbx_parent->mailboxname_full != '') {
40 $no_select_mbx->mailboxname_full = $mbx_parent->mailboxname_full.$delimiter.$ary[$i];
41 } else {
42 $no_select_mbx->mailboxname_full = $ary[$i];
43 }
44 $no_select_mbx->mailboxname_sub = $ary[$i];
45 $no_select_mbx->is_noselect = true;
46 $mbx_parent->mbxs[] = $no_select_mbx;
47 $i--;
48 }
49
50 }
51 $mbx_parent->mbxs[] = $mbx;
52 if ($mbx->is_special && $specialfirst) {
53 usort($mbx_parent->mbxs, 'sortSpecialMbx');
54 }
55
56 }
57 }
58
59 function sortSpecialMbx($a, $b) {
60 if ($a->is_inbox) {
61 $acmp = '0'. $a->mailboxname_full;
62 } else if ($a->is_special) {
63 $acmp = '1'. $a->mailboxname_full;
64 } else {
65 $acmp = '2' . $a->mailboxname_full;
66 }
67 if ($b->is_inbox) {
68 $bcmp = '0'. $b->mailboxname_full;
69 }else if ($b->is_special) {
70 $bcmp = '1' . $b->mailboxname_full;
71 } else {
72 $bcmp = '2' . $b->mailboxname_full;
73 }
74 if ($acmp == $bcmp) return 0;
75 return ($acmp>$bcmp) ? 1: -1;
76 }
77
78 function find_mailbox_name ($mailbox) {
79 if (preg_match('/\*.+\"([^\r\n\"]*)\"[\s\r\n]*$/', $mailbox, $regs))
80 return $regs[1];
81 if (ereg(" *\"([^\r\n\"]*)\"[ \r\n]*$", $mailbox, $regs))
82 return $regs[1];
83 ereg(" *([^ \r\n\"]*)[ \r\n]*$",$mailbox,$regs);
84 return $regs[1];
85 }
86
87 function check_is_noselect ($lsub_line) {
88 return preg_match("/^\* LSUB \([^\)]*\\Noselect[^\)]*\)/i", $lsub_line);
89 }
90
91 /**
92 * If $haystack is a full mailbox name, and $needle is the mailbox
93 * separator character, returns the second last part of the full
94 * mailbox name (i.e. the mailbox's parent mailbox)
95 */
96 function readMailboxParent($haystack, $needle) {
97
98 if ($needle == '') {
99 $ret = '';
100 } else {
101 $parts = explode($needle, $haystack);
102 $elem = array_pop($parts);
103 while ($elem == '' && count($parts)) {
104 $elem = array_pop($parts);
105 }
106 $ret = join($needle, $parts);
107 }
108 return( $ret );
109 }
110
111
112 function isBoxBelow( $box2, $box1 ) {
113 global $delimiter, $folder_prefix, $imap_server_type;
114
115 if ( $imap_server_type == 'uw' ) {
116 $boxs = $box2;
117 $i = strpos( $box1, $delimiter, strlen( $folder_prefix ) );
118 if ( $i === false ) {
119 $i = strlen( $box2 );
120 }
121 } else {
122 $boxs = $box2 . $delimiter;
123 /* Skip next second delimiter */
124 $i = strpos( $box1, $delimiter );
125 $i = strpos( $box1, $delimiter, $i + 1 );
126 if ( $i === false ) {
127 $i = strlen( $box2 );
128 } else {
129 $i++;
130 }
131 }
132
133 return ( substr( $box1, 0, $i ) == substr( $boxs, 0, $i ) );
134 }
135
136 /* Defines special mailboxes */
137 function isSpecialMailbox( $box ) {
138 global $trash_folder, $sent_folder, $draft_folder,
139 $move_to_trash, $move_to_sent, $save_as_draft;
140
141 $ret = ( (strtolower($box) == 'inbox') ||
142 ( $move_to_trash && isBoxBelow( $box, $trash_folder ) ) ||
143 ( $move_to_sent && isBoxBelow( $box, $sent_folder )) ||
144 ($save_as_draft && $box == $draft_folder ) );
145
146 if ( !$ret ) {
147 $ret = do_hook_function( 'special_mailbox', $box );
148 }
149
150 return $ret;
151 }
152
153 /* Expunges a mailbox */
154 function sqimap_mailbox_expunge ($imap_stream, $mailbox, $handle_errors = true, $id='') {
155 global $uid_support;
156 if ($id) {
157 if (is_array($id)) {
158 $id = sqimap_message_list_squisher($id);
159 }
160 $id = ' '.$id;
161 $uid = $uid_support;
162 } else {
163 $uid = false;
164 }
165 $read = sqimap_run_command($imap_stream, 'EXPUNGE'.$id, $handle_errors,
166 $response, $message, $uid);
167 $cnt = 0;
168
169 if ( is_array( $read ) ) {
170 foreach ($read as $r) {
171 if (preg_match('/^\*\s[0-9]+\sEXPUNGE/AUi',$r,$regs)) {
172 $cnt++;
173 }
174 }
175 }
176 return $cnt;
177 }
178
179 /* Checks whether or not the specified mailbox exists */
180 function sqimap_mailbox_exists ($imap_stream, $mailbox) {
181 if (! isset($mailbox)) {
182 return false;
183 }
184 $mbx = sqimap_run_command($imap_stream, "LIST \"\" \"$mailbox\"",
185 true, $response, $message);
186 return isset($mbx[0]);
187 }
188
189 /* Selects a mailbox */
190 function sqimap_mailbox_select ($imap_stream, $mailbox) {
191 global $auto_expunge;
192
193 if ( $mailbox == 'None' ) {
194 return;
195 }
196
197 $read = sqimap_run_command($imap_stream, "SELECT \"$mailbox\"",
198 true, $response, $message);
199 $result = array();
200 for ($i=0; $i<count($read); $i++) {
201 if (preg_match('/^\*\s+OK\s\[(\w+)\s(\w+)\]/',$read[$i], $regs)) {
202 $result[strtoupper($regs[1])] = $regs[2];
203 } else if (preg_match('/^\*\s([0-9]+)\s(\w+)/',$read[$i], $regs)) {
204 $result[strtoupper($regs[2])] = $regs[1];
205 } else {
206 if (preg_match("/PERMANENTFLAGS(.*)/i",$read[$i], $regs)) {
207 $regs[1]=trim(preg_replace ( array ("/\(/","/\)/","/\]/") ,'', $regs[1])) ;
208 $result['PERMANENTFLAGS'] = $regs[1];
209 }
210 else if (preg_match("/FLAGS(.*)/i",$read[$i], $regs)) {
211 $regs[1]=trim(preg_replace ( array ("/\(/","/\)/") ,'', $regs[1])) ;
212 $result['FLAGS'] = $regs[1];
213 }
214 }
215 }
216 if (preg_match('/^\[(.+)\]/',$message, $regs)) {
217 $result['RIGHTS']=$regs[1];
218 }
219
220 if ($auto_expunge) {
221 $tmp = sqimap_run_command($imap_stream, 'EXPUNGE', false, $a, $b);
222 }
223 return $result;
224 }
225
226 /* Creates a folder */
227 function sqimap_mailbox_create ($imap_stream, $mailbox, $type) {
228 global $delimiter;
229 if (strtolower($type) == 'noselect') {
230 $mailbox .= $delimiter;
231 }
232 $mailbox = imap_utf7_encode_local($mailbox);
233 $read_ary = sqimap_run_command($imap_stream, "CREATE \"$mailbox\"",
234 true, $response, $message);
235 sqimap_subscribe ($imap_stream, $mailbox);
236 }
237
238 /* Subscribes to an existing folder */
239 function sqimap_subscribe ($imap_stream, $mailbox) {
240 $read_ary = sqimap_run_command($imap_stream, "SUBSCRIBE \"$mailbox\"",
241 true, $response, $message);
242 }
243
244 /* Unsubscribes to an existing folder */
245 function sqimap_unsubscribe ($imap_stream, $mailbox) {
246 global $imap_server_type;
247 $read_ary = sqimap_run_command($imap_stream, "UNSUBSCRIBE \"$mailbox\"",
248 true, $response, $message);
249 }
250
251 /* Deletes the given folder */
252 function sqimap_mailbox_delete ($imap_stream, $mailbox) {
253 global $data_dir, $username;
254 $read_ary = sqimap_run_command($imap_stream, "DELETE \"$mailbox\"",
255 true, $response, $message);
256 sqimap_unsubscribe ($imap_stream, $mailbox);
257 do_hook_function("rename_or_delete_folder", $args = array($mailbox, 'delete', ''));
258 removePref($data_dir, $username, "thread_$mailbox");
259 }
260
261 /* Determines if the user is subscribed to the folder or not */
262 function sqimap_mailbox_is_subscribed($imap_stream, $folder) {
263 $boxesall = sqimap_mailbox_list ($imap_stream);
264 foreach ($boxesall as $ref) {
265 if ($ref['unformatted'] == $folder) {
266 return true;
267 }
268 }
269 return false;
270 }
271
272 /* Renames a mailbox */
273 function sqimap_mailbox_rename( $imap_stream, $old_name, $new_name ) {
274 if ( $old_name != $new_name ) {
275 global $delimiter, $imap_server_type, $data_dir, $username;
276 if ( substr( $old_name, -1 ) == $delimiter ) {
277 $old_name = substr( $old_name, 0, strlen( $old_name ) - 1 );
278 $new_name = substr( $new_name, 0, strlen( $new_name ) - 1 );
279 $postfix = $delimiter;
280 } else {
281 $postfix = '';
282 }
283 $boxesall = sqimap_mailbox_list($imap_stream);
284 $cmd = 'RENAME "' . quoteIMAP($old_name) . '" "' . quoteIMAP($new_name) . '"';
285 $data = sqimap_run_command($imap_stream, $cmd, true, $response, $message);
286 sqimap_unsubscribe($imap_stream, $old_name.$postfix);
287 $oldpref = getPref($data_dir, $username, "thread_".$old_name.$postfix);
288 removePref($data_dir, $username, "thread_".$old_name.$postfix);
289 sqimap_subscribe($imap_stream, $new_name.$postfix);
290 setPref($data_dir, $username, "thread_".$new_name.$postfix, $oldpref);
291 do_hook_function("rename_or_delete_folder",$args = array($old_name, 'rename', $new_name));
292 $l = strlen( $old_name ) + 1;
293 $p = 'unformatted';
294 foreach ( $boxesall as $box ) {
295 if ( substr( $box[$p], 0, $l ) == $old_name . $delimiter ) {
296 $new_sub = $new_name . $delimiter . substr($box[$p], $l);
297 if ($imap_server_type == 'cyrus') {
298 $cmd = 'RENAME "' . quoteIMAP($box[$p]) . '" "' . quoteIMAP($new_sub) . '"';
299 $data = sqimap_run_command($imap_stream, $cmd, true,
300 $response, $message);
301 }
302 sqimap_unsubscribe($imap_stream, $box[$p]);
303 $oldpref = getPref($data_dir, $username, "thread_".$box[$p]);
304 removePref($data_dir, $username, "thread_".$box[$p]);
305 sqimap_subscribe($imap_stream, $new_sub);
306 setPref($data_dir, $username, "thread_".$new_sub, $oldpref);
307 do_hook_function("rename_or_delete_folder",
308 $args = array($box[$p], 'rename', $new_sub));
309 }
310 }
311 }
312 }
313
314 /*
315 * Formats a mailbox into 4 parts for the $boxesall array
316 *
317 * The four parts are:
318 *
319 * raw - Raw LIST/LSUB response from the IMAP server
320 * formatted - nicely formatted folder name
321 * unformatted - unformatted, but with delimiter at end removed
322 * unformatted-dm - folder name as it appears in raw response
323 * unformatted-disp - unformatted without $folder_prefix
324 */
325 function sqimap_mailbox_parse ($line, $line_lsub) {
326 global $folder_prefix, $delimiter;
327
328 /* Process each folder line */
329 for ($g=0; $g < count($line); $g++) {
330
331 /* Store the raw IMAP reply */
332 if (isset($line[$g])) {
333 $boxesall[$g]["raw"] = $line[$g];
334 }
335 else {
336 $boxesall[$g]["raw"] = '';
337 }
338
339
340 /* Count number of delimiters ($delimiter) in folder name */
341 $mailbox = trim($line_lsub[$g]);
342 $dm_count = substr_count($mailbox, $delimiter);
343 if (substr($mailbox, -1) == $delimiter) {
344 /* If name ends in delimiter, decrement count by one */
345 $dm_count--;
346 }
347
348 /* Format folder name, but only if it's a INBOX.* or has a parent. */
349 $boxesallbyname[$mailbox] = $g;
350 $parentfolder = readMailboxParent($mailbox, $delimiter);
351 if ( (strtolower(substr($mailbox, 0, 5)) == "inbox") ||
352 (substr($mailbox, 0, strlen($folder_prefix)) == $folder_prefix) ||
353 ( isset($boxesallbyname[$parentfolder]) &&
354 (strlen($parentfolder) > 0) ) ) {
355 $indent = $dm_count - ( substr_count($folder_prefix, $delimiter));
356 if ($indent > 0) {
357 $boxesall[$g]['formatted'] = str_repeat('&nbsp;&nbsp;', $indent);
358 }
359 else {
360 $boxesall[$g]['formatted'] = '';
361 }
362 $boxesall[$g]['formatted'] .= imap_utf7_decode_local(readShortMailboxName($mailbox, $delimiter));
363 }
364 else {
365 $boxesall[$g]['formatted'] = imap_utf7_decode_local($mailbox);
366 }
367
368 $boxesall[$g]['unformatted-dm'] = $mailbox;
369 if (substr($mailbox, -1) == $delimiter) {
370 $mailbox = substr($mailbox, 0, strlen($mailbox) - 1);
371 }
372 $boxesall[$g]['unformatted'] = $mailbox;
373 if (substr($mailbox,0,strlen($folder_prefix))==$folder_prefix) {
374 $mailbox = substr($mailbox, strlen($folder_prefix));
375 }
376 $boxesall[$g]['unformatted-disp'] = $mailbox;
377 $boxesall[$g]['id'] = $g;
378
379 $boxesall[$g]['flags'] = array();
380 if (isset($line[$g])) {
381 ereg("\(([^)]*)\)",$line[$g],$regs);
382 $flags = trim(strtolower(str_replace('\\', '',$regs[1])));
383 if ($flags) {
384 $boxesall[$g]['flags'] = explode(' ', $flags);
385 }
386 }
387 }
388
389 return $boxesall;
390 }
391
392 /*
393 * Sorting function used to sort mailbox names.
394 * + Original patch from dave_michmerhuizen@yahoo.com
395 * + Allows case insensitivity when sorting folders
396 * + Takes care of the delimiter being sorted to the end, causing
397 * subfolders to be listed in below folders that are prefixed
398 * with their parent folders name.
399 *
400 * For example: INBOX.foo, INBOX.foobar, and INBOX.foo.bar
401 * Without special sort function: foobar between foo and foo.bar
402 * With special sort function: foobar AFTER foo and foo.bar :)
403 */
404 function user_strcasecmp($a, $b) {
405 global $delimiter;
406
407 return strnatcasecmp($a, $b);
408
409 /* Calculate the length of some strings. */
410 $a_length = strlen($a);
411 $b_length = strlen($b);
412 $min_length = min($a_length, $b_length);
413 $delimiter_length = strlen($delimiter);
414
415 /* Set the initial result value. */
416 $result = 0;
417 /* Check the strings... */
418 for ($c = 0; $c < $min_length; ++$c) {
419 $a_del = substr($a, $c, $delimiter_length);
420 $b_del = substr($b, $c, $delimiter_length);
421
422 if (($a_del == $delimiter) && ($b_del == $delimiter)) {
423 $result = 0;
424 } else if (($a_del == $delimiter) && ($b_del != $delimiter)) {
425 $result = -1;
426 } else if (($a_del != $delimiter) && ($b_del == $delimiter)) {
427 $result = 1;
428 } else {
429 $result = strcasecmp($a{$c}, $b{$c});
430 }
431
432 if ($result != 0) {
433 break;
434 }
435 }
436
437 /* If one string is a prefix of the other... */
438 if ($result == 0) {
439 if ($a_length < $b_length) {
440 $result = -1;
441 } else if ($a_length > $b_length) {
442 $result = 1;
443 }
444 }
445
446 return $result;
447 }
448
449
450 /*
451 * Returns sorted mailbox lists in several different ways.
452 * See comment on sqimap_mailbox_parse() for info about the returned array.
453 */
454 function sqimap_mailbox_list($imap_stream) {
455 global $default_folder_prefix;
456
457 if ( !isset( $boxesnew ) ) {
458
459 global $data_dir, $username, $list_special_folders_first,
460 $folder_prefix, $trash_folder, $sent_folder, $draft_folder,
461 $move_to_trash, $move_to_sent, $save_as_draft,
462 $delimiter, $noselect_fix_enable;
463
464 $inbox_in_list = false;
465 $inbox_subscribed = false;
466
467 require_once(SM_PATH . 'include/load_prefs.php');
468 require_once(SM_PATH . 'functions/array.php');
469
470 if ($noselect_fix_enable) {
471 $lsub_args = "LSUB \"$folder_prefix\" \"*%\"";
472 }
473 else {
474 $lsub_args = "LSUB \"$folder_prefix\" \"*\"";
475 }
476 /* LSUB array */
477 $lsub_ary = sqimap_run_command ($imap_stream, $lsub_args,
478 true, $response, $message);
479
480
481 /*
482 * Section about removing the last element was removed
483 * We don't return "* OK" anymore from sqimap_read_data
484 */
485
486 $sorted_lsub_ary = array();
487 for ($i=0;$i < count($lsub_ary); $i++) {
488 /*
489 * Workaround for EIMS
490 * Doesn't work if the mailbox name is multiple lines
491 */
492 if (isset($lsub_ary[$i + 1]) &&
493 ereg("^(\\* [A-Z]+.*)\\{[0-9]+\\}([ \n\r\t]*)$",
494 $lsub_ary[$i], $regs)) {
495 $i ++;
496 $lsub_ary[$i] = $regs[1] . '"' . addslashes(trim($lsub_ary[$i])) . '"' . $regs[2];
497 }
498 $temp_mailbox_name = find_mailbox_name($lsub_ary[$i]);
499 $sorted_lsub_ary[] = $temp_mailbox_name;
500 if (strtoupper($temp_mailbox_name) == 'INBOX') {
501 $inbox_subscribed = true;
502 }
503 }
504 $new_ary = array();
505 for ($i=0; $i < count($sorted_lsub_ary); $i++) {
506 if (!in_array($sorted_lsub_ary[$i], $new_ary)) {
507 $new_ary[] = $sorted_lsub_ary[$i];
508 }
509 }
510 $sorted_lsub_ary = $new_ary;
511 if (isset($sorted_lsub_ary)) {
512 usort($sorted_lsub_ary, 'user_strcasecmp');
513 }
514 $sorted_list_ary = $sorted_lsub_ary;
515 /* LIST array */
516 // $sorted_list_ary = array();
517 // for ($i=0; $i < count($sorted_lsub_ary); $i++) {
518 if (false) {
519 if (substr($sorted_lsub_ary[$i], -1) == $delimiter) {
520 $mbx = substr($sorted_lsub_ary[$i], 0, strlen($sorted_lsub_ary[$i])-1);
521 }
522 else {
523 $mbx = $sorted_lsub_ary[$i];
524 }
525
526 $read = sqimap_run_command ($imap_stream, "LIST \"\" \"$mbx\"",
527 true, $response, $message);
528 /* Another workaround for EIMS */
529 if (isset($read[1]) &&
530 ereg("^(\\* [A-Z]+.*)\\{[0-9]+\\}([ \n\r\t]*)$",
531 $read[0], $regs)) {
532 $read[0] = $regs[1] . '"' . addslashes(trim($read[1])) . '"' . $regs[2];
533 }
534
535 if (isset($sorted_list_ary[$i])) {
536 $sorted_list_ary[$i] = '';
537 }
538
539 if (isset($read[0])) {
540 $sorted_list_ary[$i] = $read[0];
541 }
542 else {
543 $sorted_list_ary[$i] = '';
544 }
545
546 if (isset($sorted_list_ary[$i]) &&
547 strtoupper(find_mailbox_name($sorted_list_ary[$i])) == 'INBOX') {
548 $inbox_in_list = true;
549 }
550 }
551 // $inbox_in_list = true;
552 /*
553 * Just in case they're not subscribed to their inbox,
554 * we'll get it for them anyway
555 */
556 if (!$inbox_subscribed) {// || !$inbox_in_list) {
557 $inbox_ary = sqimap_run_command ($imap_stream, "LIST \"\" \"INBOX\"",
558 true, $response, $message);
559 /* Another workaround for EIMS */
560 if (isset($inbox_ary[1]) &&
561 ereg("^(\\* [A-Z]+.*)\\{[0-9]+\\}([ \n\r\t]*)$",
562 $inbox_ary[0], $regs)) {
563 $inbox_ary[0] = $regs[1] . '"' . addslashes(trim($inbox_ary[1])) .
564 '"' . $regs[2];
565 }
566
567 $sorted_list_ary[] = $inbox_ary[0];
568 $sorted_lsub_ary[] = find_mailbox_name($inbox_ary[0]);
569 }
570
571 $boxesall = sqimap_mailbox_parse ($sorted_list_ary, $sorted_lsub_ary);
572
573 /* Now, lets sort for special folders */
574 $boxesnew = $used = array();
575
576 /* Find INBOX */
577 foreach ( $boxesall as $k => $box ) {
578 if ( strtolower($box['unformatted']) == 'inbox') {
579 $boxesnew[] = $box;
580 $used[$k] = true;
581 } else {
582 $used[$k] = false;
583 }
584 }
585 /* List special folders and their subfolders, if requested. */
586 if ($list_special_folders_first) {
587 foreach ( $boxesall as $k => $box ) {
588 if ( !$used[$k] && isSpecialMailbox( $box['unformatted'] ) ) {
589 $boxesnew[] = $box;
590 $used[$k] = true;
591 }
592 $spec_sub = str_replace('&nbsp;', '', $box['formatted']);
593 $spec_sub = preg_replace("/(\*|\[|\]|\(|\)|\?|\+|\{|\}|\^|\\$)/", '\\\\'.'\\1', $spec_sub);
594
595 /* In case of problems with preg
596 here is a ereg version
597 if (!$used[$k] && ereg("^$default_folder_prefix(Sent|Drafts|Trash).{1}$spec_sub$", $box['unformatted']) ) { */
598
599 if (!$used[$k] && preg_match("?^$default_folder_prefix(Sent|Drafts|Trash).{1}$spec_sub$?", $box['unformatted']) ) {
600 $boxesnew[] = $box;
601 $used[$k] = true;
602 }
603 }
604
605 }
606 /* Rest of the folders */
607 foreach ( $boxesall as $k => $box ) {
608 if ( !$used[$k] ) {
609 $boxesnew[] = $box;
610 }
611 }
612 }
613 return $boxesnew;
614 }
615
616 /*
617 * Returns a list of all folders, subscribed or not
618 */
619 function sqimap_mailbox_list_all($imap_stream) {
620 global $list_special_folders_first, $folder_prefix, $delimiter;
621
622 require_once(SM_PATH . 'functions/array.php');
623
624 $ssid = sqimap_session_id();
625 $lsid = strlen( $ssid );
626 fputs ($imap_stream, $ssid . " LIST \"$folder_prefix\" *\r\n");
627 $read_ary = sqimap_read_data ($imap_stream, $ssid, true, $response, $message);
628 $g = 0;
629 $phase = 'inbox';
630 $fld_pre_length = strlen($folder_prefix);
631
632 for ($i = 0; $i < count($read_ary); $i++) {
633 /* Another workaround for EIMS */
634 if (isset($read_ary[$i + 1]) &&
635 ereg("^(\\* [A-Z]+.*)\\{[0-9]+\\}([ \n\r\t]*)$",
636 $read_ary[$i], $regs)) {
637 $i ++;
638 $read_ary[$i] = $regs[1] . '"' . addslashes(trim($read_ary[$i])) . '"' . $regs[2];
639 }
640 if (substr($read_ary[$i], 0, $lsid) != $ssid ) {
641 /* Store the raw IMAP reply */
642 $boxes[$g]['raw'] = $read_ary[$i];
643
644 /* Count number of delimiters ($delimiter) in folder name */
645 $mailbox = find_mailbox_name($read_ary[$i]);
646 $dm_count = substr_count($mailbox, $delimiter);
647 if (substr($mailbox, -1) == $delimiter) {
648 /* If name ends in delimiter - decrement count by one */
649 $dm_count--;
650 }
651
652 /* Format folder name, but only if it's a INBOX.* or has a parent. */
653 $boxesallbyname[$mailbox] = $g;
654 $parentfolder = readMailboxParent($mailbox, $delimiter);
655 if((eregi('^inbox'.quotemeta($delimiter), $mailbox)) ||
656 (ereg('^'.$folder_prefix, $mailbox)) ||
657 ( isset($boxesallbyname[$parentfolder]) && (strlen($parentfolder) > 0) ) ) {
658 if ($dm_count) {
659 $boxes[$g]['formatted'] = str_repeat('&nbsp;&nbsp;', $dm_count);
660 }
661 else {
662 $boxes[$g]['formatted'] = '';
663 }
664 $boxes[$g]['formatted'] .= imap_utf7_decode_local(readShortMailboxName($mailbox, $delimiter));
665 }
666 else {
667 $boxes[$g]['formatted'] = imap_utf7_decode_local($mailbox);
668 }
669
670 $boxes[$g]['unformatted-dm'] = $mailbox;
671 if (substr($mailbox, -1) == $delimiter) {
672 $mailbox = substr($mailbox, 0, strlen($mailbox) - 1);
673 }
674 $boxes[$g]['unformatted'] = $mailbox;
675 $boxes[$g]['unformatted-disp'] = substr($mailbox,$fld_pre_length);
676
677 $boxes[$g]['id'] = $g;
678
679 /* Now lets get the flags for this mailbox */
680 $read_mlbx = $read_ary[$i];
681
682 // $read_mlbx = sqimap_run_command ($imap_stream, "LIST \"\" \"$mailbox\"",
683 // true, $response, $message);
684
685 /* Another workaround for EIMS */
686 // if (isset($read_mlbx[1]) &&
687 // ereg("^(\\* [A-Z]+.*)\\{[0-9]+\\}([ \n\r\t]*)$", $read_mlbx[0], $regs)) {
688 // $read_mlbx[0] = $regs[1] . '"' . addslashes(trim($read_mlbx[1])) . '"' . $regs[2];
689 // }
690 // echo $read_mlbx[0] .' raw 2 <br>';
691
692 $flags = substr($read_mlbx, strpos($read_mlbx, '(')+1);
693 $flags = substr($flags, 0, strpos($flags, ')'));
694 $flags = str_replace('\\', '', $flags);
695 $flags = trim(strtolower($flags));
696 if ($flags) {
697 $boxes[$g]['flags'] = explode(' ', $flags);
698 } else {
699 $boxes[$g]['flags'] = array();
700 }
701 }
702 $g++;
703 }
704 if(is_array($boxes)) {
705 $boxes = ary_sort ($boxes, 'unformatted', 1);
706 }
707
708 return $boxes;
709 }
710
711 function sqimap_mailbox_tree($imap_stream) {
712 global $boxesnew, $default_folder_prefix, $unseen_notify, $unseen_type;
713 if ( !isset( $boxesnew ) ) {
714
715 global $data_dir, $username, $list_special_folders_first,
716 $folder_prefix, $delimiter, $trash_folder, $move_to_trash;
717
718
719 $inbox_in_list = false;
720 $inbox_subscribed = false;
721
722 require_once(SM_PATH . 'include/load_prefs.php');
723 require_once(SM_PATH . 'functions/array.php');
724
725 /* LSUB array */
726 $lsub_ary = sqimap_run_command ($imap_stream, "LSUB \"$folder_prefix\" \"*\"",
727 true, $response, $message);
728
729 /*
730 * Section about removing the last element was removed
731 * We don't return "* OK" anymore from sqimap_read_data
732 */
733 $sorted_lsub_ary = array();
734 $cnt = count($lsub_ary);
735 for ($i=0;$i < $cnt; $i++) {
736 /*
737 * Workaround for EIMS
738 * Doesn't work if the mailbox name is multiple lines
739 */
740 if (isset($lsub_ary[$i + 1]) &&
741 ereg("^(\\* [A-Z]+.*)\\{[0-9]+\\}([ \n\r\t]*)$",
742 $lsub_ary[$i], $regs)) {
743 $i ++;
744 $lsub_ary[$i] = $regs[1] . '"' . addslashes(trim($lsub_ary[$i])) . '"' . $regs[2];
745 }
746
747 // if (preg_match("/^\*\s+LSUB\s+\((.*)\)\s+\"(.*)\"\s+\"?(.+(?=\")|.+).*$/",$lsub_ary[$i],$regs)) {
748 // $flag = $regs[1];
749 // $mbx = trim($regs[3]);
750 // $sorted_lsub_ary[] = array ('mbx' => $mbx, 'flag' => $flag);
751 // }
752 $mbx = find_mailbox_name($lsub_ary[$i]);
753 $noselect = check_is_noselect($lsub_ary[$i]);
754 if (substr($mbx, -1) == $delimiter) {
755 $mbx = substr($mbx, 0, strlen($mbx) - 1);
756 }
757 $sorted_lsub_ary[] = array ('mbx' => $mbx, 'noselect' => $noselect);
758 }
759 array_multisort($sorted_lsub_ary, SORT_ASC, SORT_REGULAR);
760
761 foreach ($sorted_lsub_ary as $mbx) {
762 if ($mbx['mbx'] == 'INBOX') {
763 $inbox_in_list = true;
764 break;
765 }
766 }
767
768 /*
769 * Just in case they're not subscribed to their inbox,
770 * we'll get it for them anyway
771 */
772 if (!$inbox_in_list) {
773 $inbox_ary = sqimap_run_command ($imap_stream, "LIST \"\" \"INBOX\"",
774 true, $response, $message);
775 /* Another workaround for EIMS */
776 if (isset($inbox_ary[1]) &&
777 ereg("^(\\* [A-Z]+.*)\\{[0-9]+\\}([ \n\r\t]*)$",
778 $inbox_ary[0], $regs)) {
779 $inbox_ary[0] = $regs[1] . '"' . addslashes(trim($inbox_ary[1])) .
780 '"' . $regs[2];
781 }
782 $mbx = find_mailbox_name($inbox_ary[0]);
783 if (substr($mbx, -1) == $delimiter) {
784 $mbx = substr($mbx, 0, strlen($mbx) - 1);
785 }
786 if ( $mbx == 'INBOX') {
787 $sorted_lsub_ary[] = array ('mbx' => $mbx, 'flag' => '');
788 sqimap_subscribe($imap_stream, 'INBOX');
789 }
790
791 // if (preg_match("/^\*\s+LIST\s+\((.*)\)\s+\"(.*)\"\s+\"?(.+(?=\")|.+).*$/",$inbox_ary[0],$regs)) {
792 // $flag = $regs[1];
793 // $mbx = trim($regs[3]);
794 // if (substr($mbx, -1) == $delimiter) {
795 // $mbx = substr($mbx, 0, strlen($mbx) - 1);
796 // }
797 // $sorted_lsub_ary[] = array ('mbx' => $mbx, 'flag' => $flag);
798 // }
799 }
800 $cnt = count($sorted_lsub_ary);
801 for ($i=0 ; $i < $cnt; $i++) {
802 $mbx = $sorted_lsub_ary[$i]['mbx'];
803 if (($unseen_notify == 2 && $mbx == 'INBOX')
804 || $unseen_notify == 3
805 || ($move_to_trash && ($mbx == $trash_folder))) {
806 $sorted_lsub_ary[$i]['unseen'] =
807 $sorted_lsub_ary[$i]['noselect'] ?
808 0 : sqimap_unseen_messages($imap_stream, $mbx);
809 if ($unseen_type == 2 || ($move_to_trash
810 && ($mbx == $trash_folder) )) {
811 $sorted_lsub_ary[$i]['nummessages'] =
812 $sorted_lsub_ary[$i]['noselect'] ?
813 0 : sqimap_get_num_messages($imap_stream, $mbx);
814 }
815 if ($mbx == $trash_folder) {
816 $sorted_lsub_ary[$i]['nummessages'] =
817 $sorted_lsub_ary[$i]['noselect'] ?
818 0 : sqimap_get_num_messages($imap_stream, $mbx);
819 }
820 }
821 }
822 $boxesnew = sqimap_fill_mailbox_tree($sorted_lsub_ary);
823 return $boxesnew;
824 }
825 }
826
827
828 function sqimap_fill_mailbox_tree($mbx_ary, $mbxs=false) {
829 global $data_dir, $username, $list_special_folders_first,
830 $folder_prefix, $trash_folder, $sent_folder, $draft_folder,
831 $move_to_trash, $move_to_sent, $save_as_draft,
832 $delimiter;
833
834 $special_folders = array ('INBOX', $sent_folder, $draft_folder, $trash_folder);
835
836 /* create virtual root node */
837 $mailboxes= new mailboxes();
838 $mailboxes->is_root = true;
839 $trail_del = false;
840 if (isset($folder_prefix) && $folder_prefix != '') {
841 $start = substr_count($folder_prefix,$delimiter);
842 if (strrpos($folder_prefix, $delimiter) == (strlen($folder_prefix)-1)) {
843 $trail_del = true;
844 $mailboxes->mailboxname_full = substr($folder_prefix,0, (strlen($folder_prefix)-1));
845 } else {
846 $mailboxes->mailboxname_full = $folder_prefix;
847 $start++;
848 }
849 $mailboxes->mailboxname_sub = $mailboxes->mailboxname_full;
850 } else $start = 0;
851 $cnt = count($mbx_ary);
852 for ($i=0; $i < $cnt; $i++) {
853 if ($mbx_ary[$i]['mbx'] !='' ) {
854 $mbx = new mailboxes();
855 $mailbox = $mbx_ary[$i]['mbx'];
856 switch ($mailbox) {
857 case 'INBOX':
858 $mbx->is_inbox = true;
859 $mbx->is_special = true;
860 break;
861 case $trash_folder:
862 $mbx->is_trash = true;
863 $mbx->is_special = true;
864 break;
865 case $sent_folder:
866 $mbx->is_sent = true;
867 $mbx->is_special = true;
868 break;
869 case $draft_folder:
870 $mbx->is_draft = true;
871 $mbx->is_special = true;
872 break;
873 }
874
875 if (isset($mbx_ary[$i]['unseen'])) {
876 $mbx->unseen = $mbx_ary[$i]['unseen'];
877 }
878 if (isset($mbx_ary[$i]['nummessages'])) {
879 $mbx->total = $mbx_ary[$i]['nummessages'];
880 }
881
882 $mbx->is_noselect = $mbx_ary[$i]['noselect'];
883
884 $r_del_pos = strrpos($mbx_ary[$i]['mbx'], $delimiter);
885 if ($r_del_pos) {
886 $mbx->mailboxname_sub = substr($mbx_ary[$i]['mbx'],$r_del_pos+1);
887 } else { /* mailbox is root folder */
888 $mbx->mailboxname_sub = $mbx_ary[$i]['mbx'];
889 }
890 $mbx->mailboxname_full = $mbx_ary[$i]['mbx'];
891 $mailboxes->addMbx($mbx, $delimiter, $start, $list_special_folders_first);
892 }
893 }
894
895 return $mailboxes;
896 }
897
898
899 ?>