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