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