Tomas Kuliavas
[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 */
b68edc75 13require_once(SM_PATH . 'functions/imap_utf7_encode_local.php');
14require_once(SM_PATH . '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
79e07c7e 78function find_mailbox_name ($mailbox) {
d42310bd 79 if (preg_match('/\*.+\"([^\r\n\"]*)\"[\s\r\n]*$/', $mailbox, $regs))
80 return $regs[1];
79e07c7e 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];
f73348a3 85}
86
87function check_is_noselect ($lsub_line) {
88 return preg_match("/^\* LSUB \([^\)]*\\Noselect[^\)]*\)/i", $lsub_line);
79e07c7e 89}
90
97b1248c 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 */
96function 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
1e18bf95 112function isBoxBelow( $box2, $box1 ) {
1e18bf95 113 global $delimiter, $folder_prefix, $imap_server_type;
90de1755 114
fdc05b69 115 if ( $imap_server_type == 'uw' ) {
1e18bf95 116 $boxs = $box2;
117 $i = strpos( $box1, $delimiter, strlen( $folder_prefix ) );
3411d4ec 118 if ( $i === false ) {
1e18bf95 119 $i = strlen( $box2 );
fdc05b69 120 }
121 } else {
1e18bf95 122 $boxs = $box2 . $delimiter;
3411d4ec 123 /* Skip next second delimiter */
1e18bf95 124 $i = strpos( $box1, $delimiter );
125 $i = strpos( $box1, $delimiter, $i + 1 );
3411d4ec 126 if ( $i === false ) {
1e18bf95 127 $i = strlen( $box2 );
72b9aff9 128 } else {
fdc05b69 129 $i++;
4d6bd355 130 }
7980d569 131 }
72b9aff9 132
3411d4ec 133 return ( substr( $box1, 0, $i ) == substr( $boxs, 0, $i ) );
1e18bf95 134}
135
3411d4ec 136/* Defines special mailboxes */
1e18bf95 137function isSpecialMailbox( $box ) {
1e18bf95 138 global $trash_folder, $sent_folder, $draft_folder,
65c3ec94 139 $move_to_trash, $move_to_sent, $save_as_draft;
1e18bf95 140
90de1755 141 $ret = ( (strtolower($box) == 'inbox') ||
1e18bf95 142 ( $move_to_trash && isBoxBelow( $box, $trash_folder ) ) ||
143 ( $move_to_sent && isBoxBelow( $box, $sent_folder )) ||
ce628f00 144 ($save_as_draft && $box == $draft_folder ) );
90de1755 145
2586d588 146 if ( !$ret ) {
31524bcd 147 $ret = do_hook_function( 'special_mailbox', $box );
2586d588 148 }
149
3411d4ec 150 return $ret;
90de1755 151}
152
3411d4ec 153/* Expunges a mailbox */
8f6505f6 154function sqimap_mailbox_expunge ($imap_stream, $mailbox, $handle_errors = true, $id='') {
63240b90 155 global $uid_support;
06b5c3ff 156 if ($id) {
8f6505f6 157 if (is_array($id)) {
158 $id = sqimap_message_list_squisher($id);
159 }
160 $id = ' '.$id;
06b5c3ff 161 $uid = $uid_support;
162 } else {
163 $uid = false;
8f6505f6 164 }
06b5c3ff 165 $read = sqimap_run_command($imap_stream, 'EXPUNGE'.$id, $handle_errors,
166 $response, $message, $uid);
63240b90 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 }
8f6505f6 175 }
176 return $cnt;
43b698c7 177}
178
3411d4ec 179/* Checks whether or not the specified mailbox exists */
1da22cda 180function sqimap_mailbox_exists ($imap_stream, $mailbox) {
43b698c7 181 if (! isset($mailbox)) {
182 return false;
183 }
1c72b151 184 $mbx = sqimap_run_command($imap_stream, "LIST \"\" \"$mailbox\"",
3411d4ec 185 true, $response, $message);
43b698c7 186 return isset($mbx[0]);
187}
188
3411d4ec 189/* Selects a mailbox */
e4c6fe41 190function sqimap_mailbox_select ($imap_stream, $mailbox) {
43b698c7 191 global $auto_expunge;
f69feefe 192
43b698c7 193 if ( $mailbox == 'None' ) {
194 return;
195 }
f69feefe 196
1c72b151 197 $read = sqimap_run_command($imap_stream, "SELECT \"$mailbox\"",
3411d4ec 198 true, $response, $message);
e4c6fe41 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 {
f69feefe 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])) ;
1da22cda 212 $result['FLAGS'] = $regs[1];
f69feefe 213 }
e4c6fe41 214 }
215 }
216 if (preg_match('/^\[(.+)\]/',$message, $regs)) {
217 $result['RIGHTS']=$regs[1];
218 }
f69feefe 219
e4c6fe41 220 if ($auto_expunge) {
221 $tmp = sqimap_run_command($imap_stream, 'EXPUNGE', false, $a, $b);
43b698c7 222 }
e4c6fe41 223 return $result;
43b698c7 224}
225
3411d4ec 226/* Creates a folder */
227function sqimap_mailbox_create ($imap_stream, $mailbox, $type) {
43b698c7 228 global $delimiter;
229 if (strtolower($type) == 'noselect') {
3411d4ec 230 $mailbox .= $delimiter;
43b698c7 231 }
447b2166 232 $mailbox = imap_utf7_encode_local($mailbox);
1c72b151 233 $read_ary = sqimap_run_command($imap_stream, "CREATE \"$mailbox\"",
3411d4ec 234 true, $response, $message);
43b698c7 235 sqimap_subscribe ($imap_stream, $mailbox);
236}
237
3411d4ec 238/* Subscribes to an existing folder */
239function sqimap_subscribe ($imap_stream, $mailbox) {
1a16af11 240 $read_ary = sqimap_run_command($imap_stream, "SUBSCRIBE \"$mailbox\"",
3411d4ec 241 true, $response, $message);
43b698c7 242}
243
3411d4ec 244/* Unsubscribes to an existing folder */
245function sqimap_unsubscribe ($imap_stream, $mailbox) {
43b698c7 246 global $imap_server_type;
1a16af11 247 $read_ary = sqimap_run_command($imap_stream, "UNSUBSCRIBE \"$mailbox\"",
3411d4ec 248 true, $response, $message);
43b698c7 249}
250
3411d4ec 251/* Deletes the given folder */
252function sqimap_mailbox_delete ($imap_stream, $mailbox) {
78cc4b12 253 global $data_dir, $username;
1c72b151 254 $read_ary = sqimap_run_command($imap_stream, "DELETE \"$mailbox\"",
3411d4ec 255 true, $response, $message);
43b698c7 256 sqimap_unsubscribe ($imap_stream, $mailbox);
3411d4ec 257 do_hook_function("rename_or_delete_folder", $args = array($mailbox, 'delete', ''));
78cc4b12 258 removePref($data_dir, $username, "thread_$mailbox");
43b698c7 259}
260
3411d4ec 261/* Determines if the user is subscribed to the folder or not */
1da22cda 262function sqimap_mailbox_is_subscribed($imap_stream, $folder) {
1da22cda 263 $boxesall = sqimap_mailbox_list ($imap_stream);
264 foreach ($boxesall as $ref) {
43b698c7 265 if ($ref['unformatted'] == $folder) {
3411d4ec 266 return true;
43b698c7 267 }
268 }
269 return false;
270}
271
3411d4ec 272/* Renames a mailbox */
1c52ba77 273function sqimap_mailbox_rename( $imap_stream, $old_name, $new_name ) {
3411d4ec 274 if ( $old_name != $new_name ) {
78cc4b12 275 global $delimiter, $imap_server_type, $data_dir, $username;
1c52ba77 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;
1c52ba77 280 } else {
281 $postfix = '';
1c52ba77 282 }
648713af 283 $boxesall = sqimap_mailbox_list($imap_stream);
1c72b151 284 $cmd = 'RENAME "' . quoteIMAP($old_name) . '" "' . quoteIMAP($new_name) . '"';
3411d4ec 285 $data = sqimap_run_command($imap_stream, $cmd, true, $response, $message);
1c52ba77 286 sqimap_unsubscribe($imap_stream, $old_name.$postfix);
78cc4b12 287 $oldpref = getPref($data_dir, $username, "thread_".$old_name.$postfix);
288 removePref($data_dir, $username, "thread_".$old_name.$postfix);
1c52ba77 289 sqimap_subscribe($imap_stream, $new_name.$postfix);
78cc4b12 290 setPref($data_dir, $username, "thread_".$new_name.$postfix, $oldpref);
f5ab1fb9 291 do_hook_function("rename_or_delete_folder",$args = array($old_name, 'rename', $new_name));
648713af 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) . '"';
3411d4ec 299 $data = sqimap_run_command($imap_stream, $cmd, true,
648713af 300 $response, $message);
1c52ba77 301 }
648713af 302 sqimap_unsubscribe($imap_stream, $box[$p]);
78cc4b12 303 $oldpref = getPref($data_dir, $username, "thread_".$box[$p]);
304 removePref($data_dir, $username, "thread_".$box[$p]);
648713af 305 sqimap_subscribe($imap_stream, $new_sub);
78cc4b12 306 setPref($data_dir, $username, "thread_".$new_sub, $oldpref);
3411d4ec 307 do_hook_function("rename_or_delete_folder",
308 $args = array($box[$p], 'rename', $new_sub));
1c52ba77 309 }
310 }
1c52ba77 311 }
1c52ba77 312}
43b698c7 313
3411d4ec 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 */
325function sqimap_mailbox_parse ($line, $line_lsub) {
43b698c7 326 global $folder_prefix, $delimiter;
3411d4ec 327
43b698c7 328 /* Process each folder line */
329 for ($g=0; $g < count($line); $g++) {
3411d4ec 330
43b698c7 331 /* Store the raw IMAP reply */
332 if (isset($line[$g])) {
1da22cda 333 $boxesall[$g]["raw"] = $line[$g];
43b698c7 334 }
335 else {
3411d4ec 336 $boxesall[$g]["raw"] = '';
43b698c7 337 }
3411d4ec 338
339
43b698c7 340 /* Count number of delimiters ($delimiter) in folder name */
341 $mailbox = trim($line_lsub[$g]);
602e1431 342 $dm_count = substr_count($mailbox, $delimiter);
43b698c7 343 if (substr($mailbox, -1) == $delimiter) {
3411d4ec 344 /* If name ends in delimiter, decrement count by one */
345 $dm_count--;
43b698c7 346 }
3411d4ec 347
348 /* Format folder name, but only if it's a INBOX.* or has a parent. */
1da22cda 349 $boxesallbyname[$mailbox] = $g;
43b698c7 350 $parentfolder = readMailboxParent($mailbox, $delimiter);
351 if ( (strtolower(substr($mailbox, 0, 5)) == "inbox") ||
352 (substr($mailbox, 0, strlen($folder_prefix)) == $folder_prefix) ||
1da22cda 353 ( isset($boxesallbyname[$parentfolder]) &&
43b698c7 354 (strlen($parentfolder) > 0) ) ) {
602e1431 355 $indent = $dm_count - ( substr_count($folder_prefix, $delimiter));
43b698c7 356 if ($indent > 0) {
3411d4ec 357 $boxesall[$g]['formatted'] = str_repeat('&nbsp;&nbsp;', $indent);
43b698c7 358 }
359 else {
1da22cda 360 $boxesall[$g]['formatted'] = '';
43b698c7 361 }
447b2166 362 $boxesall[$g]['formatted'] .= imap_utf7_decode_local(readShortMailboxName($mailbox, $delimiter));
43b698c7 363 }
364 else {
447b2166 365 $boxesall[$g]['formatted'] = imap_utf7_decode_local($mailbox);
43b698c7 366 }
90de1755 367
1da22cda 368 $boxesall[$g]['unformatted-dm'] = $mailbox;
43b698c7 369 if (substr($mailbox, -1) == $delimiter) {
8e9e8afa 370 $mailbox = substr($mailbox, 0, strlen($mailbox) - 1);
43b698c7 371 }
1da22cda 372 $boxesall[$g]['unformatted'] = $mailbox;
43b698c7 373 if (substr($mailbox,0,strlen($folder_prefix))==$folder_prefix) {
631b9da3 374 $mailbox = substr($mailbox, strlen($folder_prefix));
43b698c7 375 }
1da22cda 376 $boxesall[$g]['unformatted-disp'] = $mailbox;
377 $boxesall[$g]['id'] = $g;
90de1755 378
1da22cda 379 $boxesall[$g]['flags'] = array();
43b698c7 380 if (isset($line[$g])) {
36dfb0c9 381 ereg("\(([^)]*)\)",$line[$g],$regs);
1a7e1e97 382 $flags = trim(strtolower(str_replace('\\', '',$regs[1])));
43b698c7 383 if ($flags) {
1da22cda 384 $boxesall[$g]['flags'] = explode(' ', $flags);
43b698c7 385 }
386 }
387 }
90de1755 388
1da22cda 389 return $boxesall;
43b698c7 390}
391
3411d4ec 392/*
a3439b27 393 * Sorting function used to sort mailbox names.
3411d4ec 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 :)
43b698c7 403 */
a3439b27 404function user_strcasecmp($a, $b) {
405 global $delimiter;
406
d42310bd 407 return strnatcasecmp($a, $b);
408
a3439b27 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. */
d42310bd 416 $result = 0;
a3439b27 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)) {
a3439b27 425 $result = -1;
c64c33f4 426 } else if (($a_del != $delimiter) && ($b_del == $delimiter)) {
427 $result = 1;
a3439b27 428 } else {
429 $result = strcasecmp($a{$c}, $b{$c});
430 }
431
432 if ($result != 0) {
433 break;
434 }
435 }
90de1755 436
a3439b27 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
3411d4ec 446 return $result;
43b698c7 447}
448
be2d5495 449/*
450 * Returns list of options (to be echoed into select statement
451 * based on available mailboxes and separators
452 * Caller should surround options with <SELECT..> </SELECT> and
453 * any formatting.
454 * $imap_stream - $imapConnection to query for mailboxes
455 * $show_selected - array containing list of mailboxes to pre-select (0 if none)
456 * $folder_skip - array of folders to keep out of option list (compared in lower)
457 * $boxes - list of already fetched boxes (for places like folder panel, where
458 * you know these options will be shown 3 times in a row.. (most often unset).
459 */
460function sqimap_mailbox_option_list($imap_stream, $show_selected = 0, $folder_skip = 0, $boxes = 0 ) {
461 global $username, $data_dir;
462 $mbox_options = '';
463
464 $shorten_box_names = getPref($data_dir, $username, 'mailbox_select_style', SMPREF_OFF);
465
466 if ( $boxes == 0 ) {
467 $boxes = sqimap_mailbox_list($imap_stream);
468 }
469 foreach ($boxes as $boxes_part) {
470 if (!in_array('noselect', $boxes_part['flags'])) {
471 $box = $boxes_part['unformatted'];
472 $lowerbox = strtolower($box);
473
474 if ( $folder_skip != 0 && in_array($lowerbox, $folder_skip) ) {
475 continue;
476 }
477 if ($lowerbox == 'inbox'){
478 $box2 = _("INBOX");
479 } else if ( $shorten_box_names == 2 ) { /* delimited, style = 2 */
480 $box2 = str_replace('&nbsp;&nbsp;', '.&nbsp;', $boxes_part['formatted']);
481 } else if ( $shorten_box_names == 1 ) { /* indent, style = 1 */
482 $box2 = $boxes_part['formatted'];
483 } else { /* default, long names, style = 0 */
484 $box2 = str_replace(' ', '&nbsp;', imap_utf7_decode_local($boxes_part['unformatted-disp']));
485 }
486 if ($show_selected != 0 && in_array($lowerbox, $show_selected) ) {
487 $mbox_options .= '<OPTION VALUE="'.$box.'" SELECTED>'.$box2.'</OPTION>' . "\n";
488 } else {
489 $mbox_options .= '<OPTION VALUE="'.$box.'">'.$box2.'</OPTION>' . "\n";
490 }
491 }
492 }
493 return $mbox_options;
494}
43b698c7 495
3411d4ec 496/*
497 * Returns sorted mailbox lists in several different ways.
498 * See comment on sqimap_mailbox_parse() for info about the returned array.
499 */
1da22cda 500function sqimap_mailbox_list($imap_stream) {
4b2fe13a 501 global $default_folder_prefix;
7e235a1a 502
503 if ( !isset( $boxesnew ) ) {
504
3411d4ec 505 global $data_dir, $username, $list_special_folders_first,
7e235a1a 506 $folder_prefix, $trash_folder, $sent_folder, $draft_folder,
507 $move_to_trash, $move_to_sent, $save_as_draft,
ca85aabe 508 $delimiter, $noselect_fix_enable;
7e235a1a 509
3411d4ec 510 $inbox_in_list = false;
511 $inbox_subscribed = false;
7e235a1a 512
08185f2a 513 require_once(SM_PATH . 'include/load_prefs.php');
b68edc75 514 require_once(SM_PATH . 'functions/array.php');
7e235a1a 515
ca85aabe 516 if ($noselect_fix_enable) {
517 $lsub_args = "LSUB \"$folder_prefix\" \"*%\"";
518 }
519 else {
520 $lsub_args = "LSUB \"$folder_prefix\" \"*\"";
521 }
3411d4ec 522 /* LSUB array */
ca85aabe 523 $lsub_ary = sqimap_run_command ($imap_stream, $lsub_args,
3411d4ec 524 true, $response, $message);
7e235a1a 525
ca85aabe 526
3411d4ec 527 /*
528 * Section about removing the last element was removed
529 * We don't return "* OK" anymore from sqimap_read_data
530 */
7e235a1a 531
532 $sorted_lsub_ary = array();
533 for ($i=0;$i < count($lsub_ary); $i++) {
3411d4ec 534 /*
535 * Workaround for EIMS
536 * Doesn't work if the mailbox name is multiple lines
537 */
7e235a1a 538 if (isset($lsub_ary[$i + 1]) &&
539 ereg("^(\\* [A-Z]+.*)\\{[0-9]+\\}([ \n\r\t]*)$",
540 $lsub_ary[$i], $regs)) {
541 $i ++;
3411d4ec 542 $lsub_ary[$i] = $regs[1] . '"' . addslashes(trim($lsub_ary[$i])) . '"' . $regs[2];
7e235a1a 543 }
544 $temp_mailbox_name = find_mailbox_name($lsub_ary[$i]);
545 $sorted_lsub_ary[] = $temp_mailbox_name;
546 if (strtoupper($temp_mailbox_name) == 'INBOX') {
3411d4ec 547 $inbox_subscribed = true;
7e235a1a 548 }
549 }
550 $new_ary = array();
551 for ($i=0; $i < count($sorted_lsub_ary); $i++) {
552 if (!in_array($sorted_lsub_ary[$i], $new_ary)) {
553 $new_ary[] = $sorted_lsub_ary[$i];
554 }
555 }
556 $sorted_lsub_ary = $new_ary;
557 if (isset($sorted_lsub_ary)) {
558 usort($sorted_lsub_ary, 'user_strcasecmp');
559 }
d42310bd 560 $sorted_list_ary = $sorted_lsub_ary;
3411d4ec 561 /* LIST array */
d42310bd 562// $sorted_list_ary = array();
563// for ($i=0; $i < count($sorted_lsub_ary); $i++) {
564 if (false) {
7e235a1a 565 if (substr($sorted_lsub_ary[$i], -1) == $delimiter) {
566 $mbx = substr($sorted_lsub_ary[$i], 0, strlen($sorted_lsub_ary[$i])-1);
567 }
568 else {
569 $mbx = $sorted_lsub_ary[$i];
570 }
571
572 $read = sqimap_run_command ($imap_stream, "LIST \"\" \"$mbx\"",
3411d4ec 573 true, $response, $message);
7e235a1a 574 /* Another workaround for EIMS */
575 if (isset($read[1]) &&
576 ereg("^(\\* [A-Z]+.*)\\{[0-9]+\\}([ \n\r\t]*)$",
577 $read[0], $regs)) {
3411d4ec 578 $read[0] = $regs[1] . '"' . addslashes(trim($read[1])) . '"' . $regs[2];
7e235a1a 579 }
580
581 if (isset($sorted_list_ary[$i])) {
582 $sorted_list_ary[$i] = '';
583 }
584
585 if (isset($read[0])) {
586 $sorted_list_ary[$i] = $read[0];
587 }
588 else {
589 $sorted_list_ary[$i] = '';
590 }
591
592 if (isset($sorted_list_ary[$i]) &&
593 strtoupper(find_mailbox_name($sorted_list_ary[$i])) == 'INBOX') {
3411d4ec 594 $inbox_in_list = true;
7e235a1a 595 }
596 }
d42310bd 597// $inbox_in_list = true;
3411d4ec 598 /*
7e235a1a 599 * Just in case they're not subscribed to their inbox,
600 * we'll get it for them anyway
601 */
d42310bd 602 if (!$inbox_subscribed) {// || !$inbox_in_list) {
7e235a1a 603 $inbox_ary = sqimap_run_command ($imap_stream, "LIST \"\" \"INBOX\"",
3411d4ec 604 true, $response, $message);
7e235a1a 605 /* Another workaround for EIMS */
606 if (isset($inbox_ary[1]) &&
607 ereg("^(\\* [A-Z]+.*)\\{[0-9]+\\}([ \n\r\t]*)$",
608 $inbox_ary[0], $regs)) {
609 $inbox_ary[0] = $regs[1] . '"' . addslashes(trim($inbox_ary[1])) .
610 '"' . $regs[2];
611 }
612
613 $sorted_list_ary[] = $inbox_ary[0];
614 $sorted_lsub_ary[] = find_mailbox_name($inbox_ary[0]);
615 }
616
617 $boxesall = sqimap_mailbox_parse ($sorted_list_ary, $sorted_lsub_ary);
618
3411d4ec 619 /* Now, lets sort for special folders */
7e235a1a 620 $boxesnew = $used = array();
621
622 /* Find INBOX */
623 foreach ( $boxesall as $k => $box ) {
624 if ( strtolower($box['unformatted']) == 'inbox') {
625 $boxesnew[] = $box;
3411d4ec 626 $used[$k] = true;
7e235a1a 627 } else {
3411d4ec 628 $used[$k] = false;
7e235a1a 629 }
630 }
7e235a1a 631 /* List special folders and their subfolders, if requested. */
3411d4ec 632 if ($list_special_folders_first) {
7e235a1a 633 foreach ( $boxesall as $k => $box ) {
3411d4ec 634 if ( !$used[$k] && isSpecialMailbox( $box['unformatted'] ) ) {
7e235a1a 635 $boxesnew[] = $box;
3411d4ec 636 $used[$k] = true;
7e235a1a 637 }
6f369100 638 $spec_sub = str_replace('&nbsp;', '', $box['formatted']);
51aa728e 639 $spec_sub = preg_replace("/(\*|\[|\]|\(|\)|\?|\+|\{|\}|\^|\\$)/", '\\\\'.'\\1', $spec_sub);
3d1560e7 640
641 /* In case of problems with preg
642 here is a ereg version
643 if (!$used[$k] && ereg("^$default_folder_prefix(Sent|Drafts|Trash).{1}$spec_sub$", $box['unformatted']) ) { */
644
645 if (!$used[$k] && preg_match("?^$default_folder_prefix(Sent|Drafts|Trash).{1}$spec_sub$?", $box['unformatted']) ) {
7ce96393 646 $boxesnew[] = $box;
647 $used[$k] = true;
648 }
7e235a1a 649 }
650
651 }
7e235a1a 652 /* Rest of the folders */
653 foreach ( $boxesall as $k => $box ) {
654 if ( !$used[$k] ) {
655 $boxesnew[] = $box;
656 }
657 }
43b698c7 658 }
3411d4ec 659 return $boxesnew;
43b698c7 660}
661
90de1755 662/*
663 * Returns a list of all folders, subscribed or not
664 */
1da22cda 665function sqimap_mailbox_list_all($imap_stream) {
3411d4ec 666 global $list_special_folders_first, $folder_prefix, $delimiter;
90de1755 667
b68edc75 668 require_once(SM_PATH . 'functions/array.php');
90de1755 669
43b698c7 670 $ssid = sqimap_session_id();
90de1755 671 $lsid = strlen( $ssid );
43b698c7 672 fputs ($imap_stream, $ssid . " LIST \"$folder_prefix\" *\r\n");
3411d4ec 673 $read_ary = sqimap_read_data ($imap_stream, $ssid, true, $response, $message);
43b698c7 674 $g = 0;
90de1755 675 $phase = 'inbox';
7d82bceb 676 $fld_pre_length = strlen($folder_prefix);
90de1755 677
43b698c7 678 for ($i = 0; $i < count($read_ary); $i++) {
679 /* Another workaround for EIMS */
680 if (isset($read_ary[$i + 1]) &&
90de1755 681 ereg("^(\\* [A-Z]+.*)\\{[0-9]+\\}([ \n\r\t]*)$",
43b698c7 682 $read_ary[$i], $regs)) {
683 $i ++;
3411d4ec 684 $read_ary[$i] = $regs[1] . '"' . addslashes(trim($read_ary[$i])) . '"' . $regs[2];
43b698c7 685 }
90de1755 686 if (substr($read_ary[$i], 0, $lsid) != $ssid ) {
43b698c7 687 /* Store the raw IMAP reply */
65c3ec94 688 $boxes[$g]['raw'] = $read_ary[$i];
1c52ba77 689
43b698c7 690 /* Count number of delimiters ($delimiter) in folder name */
8e9e8afa 691 $mailbox = find_mailbox_name($read_ary[$i]);
602e1431 692 $dm_count = substr_count($mailbox, $delimiter);
43b698c7 693 if (substr($mailbox, -1) == $delimiter) {
0cfd745a 694 /* If name ends in delimiter - decrement count by one */
90de1755 695 $dm_count--;
43b698c7 696 }
90de1755 697
3411d4ec 698 /* Format folder name, but only if it's a INBOX.* or has a parent. */
1da22cda 699 $boxesallbyname[$mailbox] = $g;
525b7ae6 700 $parentfolder = readMailboxParent($mailbox, $delimiter);
90de1755 701 if((eregi('^inbox'.quotemeta($delimiter), $mailbox)) ||
146e0c45 702 (ereg('^'.$folder_prefix, $mailbox)) ||
1da22cda 703 ( isset($boxesallbyname[$parentfolder]) && (strlen($parentfolder) > 0) ) ) {
43b698c7 704 if ($dm_count) {
90de1755 705 $boxes[$g]['formatted'] = str_repeat('&nbsp;&nbsp;', $dm_count);
43b698c7 706 }
707 else {
90de1755 708 $boxes[$g]['formatted'] = '';
43b698c7 709 }
447b2166 710 $boxes[$g]['formatted'] .= imap_utf7_decode_local(readShortMailboxName($mailbox, $delimiter));
2752bb16 711 }
43b698c7 712 else {
447b2166 713 $boxes[$g]['formatted'] = imap_utf7_decode_local($mailbox);
43b698c7 714 }
90de1755 715
1da22cda 716 $boxes[$g]['unformatted-dm'] = $mailbox;
43b698c7 717 if (substr($mailbox, -1) == $delimiter) {
718 $mailbox = substr($mailbox, 0, strlen($mailbox) - 1);
719 }
90de1755 720 $boxes[$g]['unformatted'] = $mailbox;
7d82bceb 721 $boxes[$g]['unformatted-disp'] = substr($mailbox,$fld_pre_length);
722
90de1755 723 $boxes[$g]['id'] = $g;
724
3411d4ec 725 /* Now lets get the flags for this mailbox */
7d82bceb 726 $read_mlbx = $read_ary[$i];
727
728// $read_mlbx = sqimap_run_command ($imap_stream, "LIST \"\" \"$mailbox\"",
729// true, $response, $message);
90de1755 730
43b698c7 731 /* Another workaround for EIMS */
7d82bceb 732// if (isset($read_mlbx[1]) &&
733// ereg("^(\\* [A-Z]+.*)\\{[0-9]+\\}([ \n\r\t]*)$", $read_mlbx[0], $regs)) {
734// $read_mlbx[0] = $regs[1] . '"' . addslashes(trim($read_mlbx[1])) . '"' . $regs[2];
735// }
736// echo $read_mlbx[0] .' raw 2 <br>';
90de1755 737
7d82bceb 738 $flags = substr($read_mlbx, strpos($read_mlbx, '(')+1);
90de1755 739 $flags = substr($flags, 0, strpos($flags, ')'));
146e0c45 740 $flags = str_replace('\\', '', $flags);
8e9e8afa 741 $flags = trim(strtolower($flags));
742 if ($flags) {
1c52ba77 743 $boxes[$g]['flags'] = explode(' ', $flags);
90de1755 744 } else {
43b698c7 745 $boxes[$g]['flags'] = array();
12d61439 746 }
43b698c7 747 }
748 $g++;
749 }
750 if(is_array($boxes)) {
1c52ba77 751 $boxes = ary_sort ($boxes, 'unformatted', 1);
43b698c7 752 }
90de1755 753
43b698c7 754 return $boxes;
755}
5bdd7223 756
60b5724d 757function sqimap_mailbox_tree($imap_stream) {
758 global $boxesnew, $default_folder_prefix, $unseen_notify, $unseen_type;
759 if ( !isset( $boxesnew ) ) {
760
761 global $data_dir, $username, $list_special_folders_first,
e4c6fe41 762 $folder_prefix, $delimiter, $trash_folder, $move_to_trash;
60b5724d 763
764
765 $inbox_in_list = false;
766 $inbox_subscribed = false;
767
08185f2a 768 require_once(SM_PATH . 'include/load_prefs.php');
b68edc75 769 require_once(SM_PATH . 'functions/array.php');
60b5724d 770
771 /* LSUB array */
2c617aa5 772 $lsub_ary = sqimap_run_command ($imap_stream, "LSUB \"$folder_prefix\" \"*\"",
60b5724d 773 true, $response, $message);
774
775 /*
776 * Section about removing the last element was removed
777 * We don't return "* OK" anymore from sqimap_read_data
778 */
779 $sorted_lsub_ary = array();
e4c6fe41 780 $cnt = count($lsub_ary);
781 for ($i=0;$i < $cnt; $i++) {
60b5724d 782 /*
783 * Workaround for EIMS
784 * Doesn't work if the mailbox name is multiple lines
785 */
786 if (isset($lsub_ary[$i + 1]) &&
787 ereg("^(\\* [A-Z]+.*)\\{[0-9]+\\}([ \n\r\t]*)$",
788 $lsub_ary[$i], $regs)) {
789 $i ++;
790 $lsub_ary[$i] = $regs[1] . '"' . addslashes(trim($lsub_ary[$i])) . '"' . $regs[2];
791 }
792
c388554f 793// if (preg_match("/^\*\s+LSUB\s+\((.*)\)\s+\"(.*)\"\s+\"?(.+(?=\")|.+).*$/",$lsub_ary[$i],$regs)) {
794// $flag = $regs[1];
795// $mbx = trim($regs[3]);
796// $sorted_lsub_ary[] = array ('mbx' => $mbx, 'flag' => $flag);
797// }
798 $mbx = find_mailbox_name($lsub_ary[$i]);
f73348a3 799 $noselect = check_is_noselect($lsub_ary[$i]);
c388554f 800 if (substr($mbx, -1) == $delimiter) {
801 $mbx = substr($mbx, 0, strlen($mbx) - 1);
802 }
f73348a3 803 $sorted_lsub_ary[] = array ('mbx' => $mbx, 'noselect' => $noselect);
60b5724d 804 }
e4c6fe41 805 array_multisort($sorted_lsub_ary, SORT_ASC, SORT_REGULAR);
60b5724d 806
807 foreach ($sorted_lsub_ary as $mbx) {
808 if ($mbx['mbx'] == 'INBOX') {
809 $inbox_in_list = true;
810 break;
811 }
812 }
813
814 /*
815 * Just in case they're not subscribed to their inbox,
816 * we'll get it for them anyway
817 */
818 if (!$inbox_in_list) {
819 $inbox_ary = sqimap_run_command ($imap_stream, "LIST \"\" \"INBOX\"",
820 true, $response, $message);
821 /* Another workaround for EIMS */
822 if (isset($inbox_ary[1]) &&
823 ereg("^(\\* [A-Z]+.*)\\{[0-9]+\\}([ \n\r\t]*)$",
824 $inbox_ary[0], $regs)) {
825 $inbox_ary[0] = $regs[1] . '"' . addslashes(trim($inbox_ary[1])) .
826 '"' . $regs[2];
827 }
c388554f 828 $mbx = find_mailbox_name($inbox_ary[0]);
829 if (substr($mbx, -1) == $delimiter) {
830 $mbx = substr($mbx, 0, strlen($mbx) - 1);
831 }
832 if ( $mbx == 'INBOX') {
833 $sorted_lsub_ary[] = array ('mbx' => $mbx, 'flag' => '');
834 sqimap_subscribe($imap_stream, 'INBOX');
835 }
836
837// if (preg_match("/^\*\s+LIST\s+\((.*)\)\s+\"(.*)\"\s+\"?(.+(?=\")|.+).*$/",$inbox_ary[0],$regs)) {
838// $flag = $regs[1];
839// $mbx = trim($regs[3]);
840// if (substr($mbx, -1) == $delimiter) {
841// $mbx = substr($mbx, 0, strlen($mbx) - 1);
842// }
843// $sorted_lsub_ary[] = array ('mbx' => $mbx, 'flag' => $flag);
844// }
60b5724d 845 }
e4c6fe41 846 $cnt = count($sorted_lsub_ary);
847 for ($i=0 ; $i < $cnt; $i++) {
848 $mbx = $sorted_lsub_ary[$i]['mbx'];
849 if (($unseen_notify == 2 && $mbx == 'INBOX')
60b5724d 850 || $unseen_notify == 3
e4c6fe41 851 || ($move_to_trash && ($mbx == $trash_folder))) {
407ec6bc 852 $sorted_lsub_ary[$i]['unseen'] =
853 $sorted_lsub_ary[$i]['noselect'] ?
854 0 : sqimap_unseen_messages($imap_stream, $mbx);
60b5724d 855 if ($unseen_type == 2 || ($move_to_trash
e4c6fe41 856 && ($mbx == $trash_folder) )) {
13cc3259 857 $sorted_lsub_ary[$i]['nummessages'] =
858 $sorted_lsub_ary[$i]['noselect'] ?
859 0 : sqimap_get_num_messages($imap_stream, $mbx);
60b5724d 860 }
e4c6fe41 861 if ($mbx == $trash_folder) {
13cc3259 862 $sorted_lsub_ary[$i]['nummessages'] =
863 $sorted_lsub_ary[$i]['noselect'] ?
864 0 : sqimap_get_num_messages($imap_stream, $mbx);
e4c6fe41 865 }
60b5724d 866 }
867 }
60b5724d 868 $boxesnew = sqimap_fill_mailbox_tree($sorted_lsub_ary);
869 return $boxesnew;
870 }
871}
872
873
874function sqimap_fill_mailbox_tree($mbx_ary, $mbxs=false) {
875 global $data_dir, $username, $list_special_folders_first,
876 $folder_prefix, $trash_folder, $sent_folder, $draft_folder,
877 $move_to_trash, $move_to_sent, $save_as_draft,
878 $delimiter;
879
880 $special_folders = array ('INBOX', $sent_folder, $draft_folder, $trash_folder);
881
882 /* create virtual root node */
883 $mailboxes= new mailboxes();
884 $mailboxes->is_root = true;
885 $trail_del = false;
886 if (isset($folder_prefix) && $folder_prefix != '') {
887 $start = substr_count($folder_prefix,$delimiter);
888 if (strrpos($folder_prefix, $delimiter) == (strlen($folder_prefix)-1)) {
889 $trail_del = true;
890 $mailboxes->mailboxname_full = substr($folder_prefix,0, (strlen($folder_prefix)-1));
891 } else {
892 $mailboxes->mailboxname_full = $folder_prefix;
893 $start++;
894 }
895 $mailboxes->mailboxname_sub = $mailboxes->mailboxname_full;
896 } else $start = 0;
e4c6fe41 897 $cnt = count($mbx_ary);
898 for ($i=0; $i < $cnt; $i++) {
60b5724d 899 if ($mbx_ary[$i]['mbx'] !='' ) {
900 $mbx = new mailboxes();
901 $mailbox = $mbx_ary[$i]['mbx'];
902 switch ($mailbox) {
903 case 'INBOX':
904 $mbx->is_inbox = true;
905 $mbx->is_special = true;
906 break;
907 case $trash_folder:
908 $mbx->is_trash = true;
909 $mbx->is_special = true;
910 break;
911 case $sent_folder:
912 $mbx->is_sent = true;
913 $mbx->is_special = true;
914 break;
915 case $draft_folder:
916 $mbx->is_draft = true;
917 $mbx->is_special = true;
918 break;
919 }
920
921 if (isset($mbx_ary[$i]['unseen'])) {
922 $mbx->unseen = $mbx_ary[$i]['unseen'];
923 }
924 if (isset($mbx_ary[$i]['nummessages'])) {
925 $mbx->total = $mbx_ary[$i]['nummessages'];
926 }
f73348a3 927
928 $mbx->is_noselect = $mbx_ary[$i]['noselect'];
60b5724d 929
930 $r_del_pos = strrpos($mbx_ary[$i]['mbx'], $delimiter);
931 if ($r_del_pos) {
932 $mbx->mailboxname_sub = substr($mbx_ary[$i]['mbx'],$r_del_pos+1);
933 } else { /* mailbox is root folder */
934 $mbx->mailboxname_sub = $mbx_ary[$i]['mbx'];
935 }
936 $mbx->mailboxname_full = $mbx_ary[$i]['mbx'];
937 $mailboxes->addMbx($mbx, $delimiter, $start, $list_special_folders_first);
938 }
939 }
940
941 return $mailboxes;
942}
943
944
648713af 945?>