Removed ereg and ereg_replace calls. Using simple string manipulation.
[squirrelmail.git] / functions / imap_mailbox.php
CommitLineData
59177427 1<?php
8e9e8afa 2 /**
3 ** imap_mailbox.php
4 **
5 ** This impliments all functions that manipulate mailboxes
245a6892 6 **
7 ** $Id$
8e9e8afa 8 **/
9
10 /******************************************************************************
11 ** Expunges a mailbox
12 ******************************************************************************/
a7f3c40d 13 function sqimap_mailbox_expunge ($imap_stream, $mailbox,$handle_errors = true) {
8e9e8afa 14 sqimap_mailbox_select ($imap_stream, $mailbox);
15 fputs ($imap_stream, "a001 EXPUNGE\r\n");
8cf653ad 16 $read = sqimap_read_data($imap_stream, "a001", $handle_errors, $response, $message);
8e9e8afa 17 }
18
19
20 /******************************************************************************
21 ** Checks whether or not the specified mailbox exists
22 ******************************************************************************/
23 function sqimap_mailbox_exists ($imap_stream, $mailbox) {
26511b3e 24 fputs ($imap_stream, "a001 LIST \"\" \"$mailbox\"\r\n");
25 $mbx = sqimap_read_data($imap_stream, "a001", true, $response, $message);
23fd3c8e 26 if (isset($mailbox) && isset($mbx[0])) {
f9b3e5d9 27 return !!(ereg ("$mailbox", $mbx[0])); // To force into true/false
8e9e8afa 28 }
8e9e8afa 29 }
30
a2790a61 31 /******************************************************************************
8e9e8afa 32 ** Selects a mailbox
33 ******************************************************************************/
04632dbc 34 function sqimap_mailbox_select ($imap_stream, $mailbox, $hide=true, $recent=false) {
3751dc7f 35 global $auto_expunge;
36
8e9e8afa 37 fputs ($imap_stream, "a001 SELECT \"$mailbox\"\r\n");
2752bb16 38 $read = sqimap_read_data($imap_stream, "a001", true, $response, $message);
04632dbc 39 if ($recent) {
40 for ($i=0; $i<count($read); $i++) {
41 if (strpos(strtolower($read[$i]), "recent")) {
42 $r = explode(" ", $read[$i]);
43 }
44 }
45 return $r[1];
46 }
3751dc7f 47 if ($auto_expunge) {
48 fputs ($imap_stream, "a001 EXPUNGE\r\n");
8cf653ad 49 $tmp = sqimap_read_data($imap_stream, "a001", false, $a, $b);
3751dc7f 50 }
8e9e8afa 51 }
52
53
54
55 /******************************************************************************
56 ** Creates a folder
57 ******************************************************************************/
58 function sqimap_mailbox_create ($imap_stream, $mailbox, $type) {
59 if (strtolower($type) == "noselect") {
60 $dm = sqimap_get_delimiter($imap_stream);
61 $mailbox = $mailbox.$dm;
62 }
63 fputs ($imap_stream, "a001 CREATE \"$mailbox\"\r\n");
64 $read_ary = sqimap_read_data($imap_stream, "a001", true, $response, $message);
65
66 sqimap_subscribe ($imap_stream, $mailbox);
67 }
68
69
70
71 /******************************************************************************
72 ** Subscribes to an existing folder
73 ******************************************************************************/
74 function sqimap_subscribe ($imap_stream, $mailbox) {
75 fputs ($imap_stream, "a001 SUBSCRIBE \"$mailbox\"\r\n");
76 $read_ary = sqimap_read_data($imap_stream, "a001", true, $response, $message);
77 }
78
79
80
81
82 /******************************************************************************
83 ** Unsubscribes to an existing folder
84 ******************************************************************************/
85 function sqimap_unsubscribe ($imap_stream, $mailbox) {
2752bb16 86 global $imap_server_type;
cbdc5621 87
8e9e8afa 88 fputs ($imap_stream, "a001 UNSUBSCRIBE \"$mailbox\"\r\n");
89 $read_ary = sqimap_read_data($imap_stream, "a001", true, $response, $message);
90 }
91
92
93
94
95 /******************************************************************************
96 ** This function simply deletes the given folder
97 ******************************************************************************/
98 function sqimap_mailbox_delete ($imap_stream, $mailbox) {
99 fputs ($imap_stream, "a001 DELETE \"$mailbox\"\r\n");
100 $read_ary = sqimap_read_data($imap_stream, "a001", true, $response, $message);
101 sqimap_unsubscribe ($imap_stream, $mailbox);
102 }
103
104
105 /******************************************************************************
106 ** Formats a mailbox into 4 parts for the $boxes array
5bdd7223 107 **
108 ** The four parts are:
109 **
110 ** raw - Raw LIST/LSUB response from the IMAP server
111 ** formatted - nicely formatted folder name
112 ** unformatted - unformatted, but with delimiter at end removed
113 ** unformatted-dm - folder name as it appears in raw response
18a148f0 114 ** unformatted-disp - unformatted without $folder_prefix
5bdd7223 115 **
8e9e8afa 116 ******************************************************************************/
16530f8b 117 function sqimap_mailbox_parse ($line, $line_lsub, $dm) {
5bdd7223 118 global $folder_prefix;
119
120 // Process each folder line
8e9e8afa 121 for ($g=0; $g < count($line); $g++) {
5bdd7223 122
2752bb16 123 // Store the raw IMAP reply
8e9e8afa 124 $boxes[$g]["raw"] = $line[$g];
5bdd7223 125
2752bb16 126 // Count number of delimiters ($dm) in folder name
6477eb2d 127 $mailbox = trim($line_lsub[$g]);
8e9e8afa 128 $dm_count = countCharInString($mailbox, $dm);
129 if (substr($mailbox, -1) == $dm)
5bdd7223 130 $dm_count--; // If name ends in delimiter - decrement count by one
131
2752bb16 132 // Format folder name, but only if it's a INBOX.* or have
133 // a parent.
134 $boxesbyname[$mailbox] = $g;
135 $parentfolder = readMailboxParent($mailbox, $dm);
136 if((eregi("^inbox".quotemeta($dm), $mailbox)) ||
18a148f0 137 (ereg("^".$folder_prefix, $mailbox)) ||
2752bb16 138 ( isset($boxesbyname[$parentfolder]) && (strlen($parentfolder) > 0) ) ) {
139 $indent = $dm_count - (countCharInString($folder_prefix, $dm));
0debfed6 140 if ($indent)
141 $boxes[$g]["formatted"] = str_repeat("&nbsp;&nbsp;", $indent);
142 else
143 $boxes[$g]["formatted"] = '';
2752bb16 144 $boxes[$g]["formatted"] .= readShortMailboxName($mailbox, $dm);
145 } else {
146 $boxes[$g]["formatted"] = $mailbox;
147 }
8e9e8afa 148
149 $boxes[$g]["unformatted-dm"] = $mailbox;
150 if (substr($mailbox, -1) == $dm)
151 $mailbox = substr($mailbox, 0, strlen($mailbox) - 1);
152 $boxes[$g]["unformatted"] = $mailbox;
2752bb16 153 $boxes[$g]["unformatted-disp"] = ereg_replace("^" . $folder_prefix, "", $mailbox);
8e9e8afa 154 $boxes[$g]["id"] = $g;
155
f9b3e5d9 156 ereg("\(([^)]*)\)",$line[$g],$regs);
157 $flags = trim(strtolower(str_replace("\\", "",$regs[1])));
8e9e8afa 158 if ($flags) {
159 $boxes[$g]["flags"] = explode(" ", $flags);
160 }
8e9e8afa 161 }
5bdd7223 162
8e9e8afa 163 return $boxes;
164 }
1071ae95 165
166 /* Apparently you must call a user function with usort instead
167 * of calling a built-in directly. Stupid.
168 * Patch from dave_michmerhuizen@yahoo.com
169 * Allows case insensitivity when sorting folders
170 */
171 function user_strcasecmp($a, $b)
172 {
173 return strcasecmp($a, $b);
174 }
10359c65 175
6b8a49c9 176
8e9e8afa 177 /******************************************************************************
178 ** Returns sorted mailbox lists in several different ways.
5bdd7223 179 ** See comment on sqimap_mailbox_parse() for info about the returned array.
8e9e8afa 180 ******************************************************************************/
181 function sqimap_mailbox_list ($imap_stream) {
5bdd7223 182 global $load_prefs_php, $prefs_php, $config_php;
183 global $data_dir, $username, $list_special_folders_first;
6477eb2d 184 global $trash_folder, $sent_folder;
f9b3e5d9 185 global $move_to_trash, $move_to_sent;
8e9e8afa 186
1590a668 187 $inbox_in_list = false;
188 $inbox_subscribed = false;
189
8e9e8afa 190 if (!isset($load_prefs_php)) include "../src/load_prefs.php";
191 else global $folder_prefix;
192 if (!function_exists ("ary_sort")) include "../functions/array.php";
193
194 $dm = sqimap_get_delimiter ($imap_stream);
195
8e9e8afa 196 /** LSUB array **/
197 $inbox_subscribed = false;
6477eb2d 198 fputs ($imap_stream, "a001 LSUB \"\" \"*\"\r\n");
8e9e8afa 199 $lsub_ary = sqimap_read_data ($imap_stream, "a001", true, $response, $message);
6477eb2d 200
18a148f0 201 /** OS: we don't want to parse last element of array, 'cause it is OK command, so we unset it **/
202 /** LUKE: This introduced errors.. do a check first **/
203 if (substr($lsub_ary[count($lsub_ary)-1], 0, 4) == "* OK") {
204 unset($lsub_ary[count($lsub_ary)-1]);
205 }
a3db804c 206
8e9e8afa 207 for ($i=0;$i < count($lsub_ary); $i++) {
208 $sorted_lsub_ary[$i] = find_mailbox_name($lsub_ary[$i]);
8e9e8afa 209 if ($sorted_lsub_ary[$i] == "INBOX")
210 $inbox_subscribed = true;
211 }
ee62ce13 212 $new_ary = array();
213 for ($i=0; $i < count($sorted_lsub_ary); $i++) {
214 if (!in_array($sorted_lsub_ary[$i], $new_ary)) {
215 $new_ary[] = $sorted_lsub_ary[$i];
216 }
217 }
218 $sorted_lsub_ary = $new_ary;
8e9e8afa 219 if (isset($sorted_lsub_ary)) {
1071ae95 220 usort($sorted_lsub_ary, "user_strcasecmp");
10359c65 221 //sort($sorted_lsub_ary);
8e9e8afa 222 }
223
3cb866d7 224 /** LIST array **/
f9b3e5d9 225 for ($i=0; $i < count($sorted_lsub_ary); $i++) {
226 if (substr($sorted_lsub_ary[$i], -1) == $dm)
227 $mbx = substr($sorted_lsub_ary[$i], 0, strlen($sorted_lsub_ary[$i])-1);
228 else
229 $mbx = $sorted_lsub_ary[$i];
230
231 fputs ($imap_stream, "a001 LIST \"\" \"$mbx\"\r\n");
232 $read = sqimap_read_data ($imap_stream, "a001", true, $response, $message);
233 $sorted_list_ary[$i] = $read[0];
3cb866d7 234 if (find_mailbox_name($sorted_list_ary[$i]) == "INBOX")
235 $inbox_in_list = true;
f9b3e5d9 236 }
2752bb16 237
8e9e8afa 238 /** Just in case they're not subscribed to their inbox, we'll get it for them anyway **/
239 if ($inbox_subscribed == false || $inbox_in_list == false) {
240 fputs ($imap_stream, "a001 LIST \"\" \"INBOX\"\r\n");
241 $inbox_ary = sqimap_read_data ($imap_stream, "a001", true, $response, $message);
591000ec 242
243 $pos = count($sorted_list_ary);
244 $sorted_list_ary[$pos] = $inbox_ary[0];
245
246 $pos = count($sorted_lsub_ary);
247 $sorted_lsub_ary[$pos] = find_mailbox_name($inbox_ary[0]);
8e9e8afa 248 }
249
f9b3e5d9 250 $boxes = sqimap_mailbox_parse ($sorted_list_ary, $sorted_lsub_ary, $dm);
251
5bdd7223 252
f9b3e5d9 253 /** Now, lets sort for special folders **/
5bdd7223 254
255 $boxesnew = Array();
256
257 // Find INBOX
8e9e8afa 258 for ($i = 0; $i < count($boxes); $i++) {
1e0628fb 259 if (strtolower($boxes[$i]["unformatted"]) == "inbox") {
5bdd7223 260 $boxesnew[] = $boxes[$i];
283db905 261 $used[$i] = true;
2752bb16 262 $i = count($boxes);
8e9e8afa 263 }
264 }
aed206bf 265
8e9e8afa 266 if ($list_special_folders_first == true) {
5bdd7223 267
2752bb16 268 // Then list special folders and their subfolders
245a6892 269 for ($i = 0 ; $i < count($boxes) ; $i++) {
23ed73eb 270 if ($move_to_trash &&
18a148f0 271 eregi("^" . quotemeta($trash_folder) . "(" .
272 quotemeta($dm) . ".*)?$", $boxes[$i]["unformatted"])) {
5bdd7223 273 $boxesnew[] = $boxes[$i];
283db905 274 $used[$i] = true;
1e0628fb 275 }
23ed73eb 276 elseif ($move_to_sent &&
18a148f0 277 eregi("^" . quotemeta($sent_folder) . "(" .
278 quotemeta($dm) . ".*)?$", $boxes[$i]["unformatted"])) {
5bdd7223 279 $boxesnew[] = $boxes[$i];
283db905 280 $used[$i] = true;
8e9e8afa 281 }
282 }
5bdd7223 283
2752bb16 284 // Put INBOX.* folders ahead of the rest
245a6892 285 for ($i = 0; $i < count($boxes); $i++) {
2752bb16 286 if (eregi("^inbox\.", $boxes[$i]["unformatted"]) &&
283db905 287 (!isset($used[$i]) || $used[$i] == false)) {
2752bb16 288 $boxesnew[] = $boxes[$i];
283db905 289 $used[$i] = true;
2752bb16 290 }
291 }
5bdd7223 292
8e9e8afa 293 }
c5eb2c03 294
5bdd7223 295 // Rest of the folders
8e9e8afa 296 for ($i = 0; $i < count($boxes); $i++) {
1e0628fb 297 if ((strtolower($boxes[$i]["unformatted"]) != "inbox") &&
283db905 298 (!isset($used[$i]) || $used[$i] == false)) {
5bdd7223 299 $boxesnew[] = $boxes[$i];
283db905 300 $used[$i] = true;
8e9e8afa 301 }
302 }
303
304 return $boxesnew;
305 }
8e9e8afa 306
307 /******************************************************************************
308 ** Returns a list of all folders, subscribed or not
309 ******************************************************************************/
310 function sqimap_mailbox_list_all ($imap_stream) {
1e0628fb 311 global $list_special_folders_first, $folder_prefix;
8e9e8afa 312
313 if (!function_exists ("ary_sort"))
314 include ("../functions/array.php");
315
316 $dm = sqimap_get_delimiter ($imap_stream);
317
318 fputs ($imap_stream, "a001 LIST \"$folder_prefix\" *\r\n");
319 $read_ary = sqimap_read_data ($imap_stream, "a001", true, $response, $message);
320 $g = 0;
321 $phase = "inbox";
5bdd7223 322
8e9e8afa 323 for ($i = 0; $i < count($read_ary); $i++) {
324 if (substr ($read_ary[$i], 0, 4) != "a001") {
5bdd7223 325
2752bb16 326 // Store the raw IMAP reply
8e9e8afa 327 $boxes[$g]["raw"] = $read_ary[$i];
328
2752bb16 329 // Count number of delimiters ($dm) in folder name
8e9e8afa 330 $mailbox = find_mailbox_name($read_ary[$i]);
331 $dm_count = countCharInString($mailbox, $dm);
332 if (substr($mailbox, -1) == $dm)
5bdd7223 333 $dm_count--; // If name ends in delimiter - decrement count by one
2752bb16 334
335 // Format folder name, but only if it's a INBOX.* or have
336 // a parent.
337 $boxesbyname[$mailbox] = $g;
338 $parentfolder = readMailboxParent($mailbox, $dm);
339 if((eregi("^inbox".quotemeta($dm), $mailbox)) ||
340 (ereg("^".$folder_prefix, $mailbox)) ||
341 ( isset($boxesbyname[$parentfolder]) && (strlen($parentfolder) > 0) ) ) {
0debfed6 342 if ($dm_count)
343 $boxes[$g]["formatted"] = str_repeat("&nbsp;&nbsp;", $dm_count);
344 else
345 $boxes[$g]["formatted"] = '';
2752bb16 346 $boxes[$g]["formatted"] .= readShortMailboxName($mailbox, $dm);
347 } else {
348 $boxes[$g]["formatted"] = $mailbox;
349 }
8e9e8afa 350
351 $boxes[$g]["unformatted-dm"] = $mailbox;
352 if (substr($mailbox, -1) == $dm)
353 $mailbox = substr($mailbox, 0, strlen($mailbox) - 1);
354 $boxes[$g]["unformatted"] = $mailbox;
2752bb16 355 $boxes[$g]["unformatted-disp"] = ereg_replace("^" . $folder_prefix, "", $mailbox);
8e9e8afa 356 $boxes[$g]["id"] = $g;
357
358 /** Now lets get the flags for this mailbox **/
359 fputs ($imap_stream, "a002 LIST \"\" \"$mailbox\"\r\n");
360 $read_mlbx = sqimap_read_data ($imap_stream, "a002", true, $response, $message);
361
362 $flags = substr($read_mlbx[0], strpos($read_mlbx[0], "(")+1);
363 $flags = substr($flags, 0, strpos($flags, ")"));
364 $flags = str_replace("\\", "", $flags);
365 $flags = trim(strtolower($flags));
366 if ($flags) {
367 $boxes[$g]["flags"] = explode(" ", $flags);
368 }
369 }
370 $g++;
371 }
5bdd7223 372 if(is_array($boxes)) {
591000ec 373 $boxes = ary_sort ($boxes, "unformatted", 1);
374 }
5bdd7223 375
8e9e8afa 376 return $boxes;
377 }
378
052e0c26 379?>