2 * Copyright (C) 1996-9 Brandon Long <blong@fiction.net>
3 * Copyright (C) 1999-2002 Brendan Cully <brendan@kublai.com>
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the Free Software
17 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111, USA.
20 /* Mutt browser support routines */
30 #include "imap_private.h"
32 /* -- forward declarations -- */
33 static int browse_add_list_result (IMAP_DATA* idata, const char* cmd,
34 struct browser_state* state, short isparent);
35 static void imap_add_folder (char delim, char *folder, int noselect,
36 int noinferiors, struct browser_state *state, short isparent);
37 static int compare_names(struct folder_file *a, struct folder_file *b);
38 static int browse_get_namespace (IMAP_DATA *idata, char *nsbuf, int nsblen,
39 IMAP_NAMESPACE_INFO *nsi, int nsilen, int *nns);
40 static int browse_verify_namespace (IMAP_DATA* idata,
41 IMAP_NAMESPACE_INFO* nsi, int nns);
43 /* imap_browse: IMAP hook into the folder browser, fills out browser_state,
44 * given a current folder to browse */
45 int imap_browse (char* path, struct browser_state* state)
48 char buf[LONG_STRING];
49 char buf2[LONG_STRING];
50 char nsbuf[LONG_STRING];
51 char mbox[LONG_STRING];
53 IMAP_NAMESPACE_INFO nsi[16];
54 int home_namespace = 0;
61 short showparents = 0;
66 if (imap_parse_path (path, &mx))
68 mutt_error (_("%s is an invalid IMAP path"), path);
72 strfcpy (list_cmd, option (OPTIMAPLSUB) ? "LSUB" : "LIST", sizeof (list_cmd));
74 if (!(idata = imap_conn_find (&(mx.account), 0)))
80 mbox[0] = '\0'; /* Do not replace "" with "INBOX" here */
81 mx.mbox = safe_strdup(ImapHomeNamespace);
83 if (mutt_bit_isset(idata->capabilities,NAMESPACE))
85 mutt_message _("Getting namespaces...");
86 if (browse_get_namespace (idata, nsbuf, sizeof (nsbuf),
87 nsi, sizeof (nsi), &nns) != 0)
89 if (browse_verify_namespace (idata, nsi, nns) != 0)
94 mutt_message _("Getting folder list...");
96 /* skip check for parents when at the root */
97 if (mx.mbox && mx.mbox[0] != '\0')
99 imap_fix_path (idata, mx.mbox, mbox, sizeof (mbox));
100 imap_munge_mbox_name (buf, sizeof (buf), mbox);
101 imap_unquote_string(buf); /* As kludgy as it gets */
102 mbox[sizeof (mbox) - 1] = '\0';
103 strncpy (mbox, buf, sizeof (mbox) - 1);
104 n = mutt_strlen (mbox);
106 dprint (3, (debugfile, "imap_browse: mbox: %s\n", mbox));
108 /* if our target exists and has inferiors, enter it if we
109 * aren't already going to */
110 if (mbox[n-1] != idata->delim)
112 snprintf (buf, sizeof (buf), "%s \"\" \"%s\"", list_cmd, mbox);
113 imap_cmd_start (idata, buf);
116 if (imap_parse_list_response (idata, &cur_folder, &noselect,
117 &noinferiors, &idata->delim) != 0)
122 imap_unmunge_mbox_name (cur_folder);
124 if (!noinferiors && cur_folder[0] &&
125 (n = strlen (mbox)) < LONG_STRING-1)
127 mbox[n++] = idata->delim;
132 while (ascii_strncmp (idata->cmd.buf, idata->cmd.seq, SEQLEN));
135 /* if we're descending a folder, mark it as current in browser_state */
136 if (mbox[n-1] == idata->delim)
138 /* don't show parents in the home namespace */
141 imap_qualify_path (buf, sizeof (buf), &mx, mbox);
142 state->folder = safe_strdup (buf);
146 /* Find superiors to list
147 * Note: UW-IMAP servers return folder + delimiter when asked to list
148 * folder + delimiter. Cyrus servers don't. So we ask for folder,
149 * and tack on delimiter ourselves.
150 * Further note: UW-IMAP servers return nothing when asked for
151 * NAMESPACES without delimiters at the end. Argh! */
152 for (n--; n >= 0 && mbox[n] != idata->delim ; n--);
153 if (n > 0) /* "aaaa/bbbb/" -> "aaaa" */
155 /* forget the check, it is too delicate (see above). Have we ever
156 * had the parent not exist? */
162 dprint (3, (debugfile, "imap_init_browse: adding parent %s\n", mbox));
163 imap_add_folder (idata->delim, mbox, 1, 0, state, 1);
166 /* if our target isn't a folder, we are in our superior */
169 /* store folder with delimiter */
173 imap_qualify_path (buf, sizeof (buf), &mx, mbox);
174 state->folder = safe_strdup (buf);
178 /* "/bbbb/" -> add "/", "aaaa/" -> add "" */
182 /* folder may be "/" */
183 snprintf (relpath, sizeof (relpath), "%c" , n < 0 ? '\0' : idata->delim);
185 imap_add_folder (idata->delim, relpath, 1, 0, state, 1);
188 imap_qualify_path (buf, sizeof (buf), &mx, relpath);
189 state->folder = safe_strdup (buf);
194 /* no namespace, no folder: set folder to host only */
197 imap_qualify_path (buf, sizeof (buf), &mx, NULL);
198 state->folder = safe_strdup (buf);
201 if (home_namespace && mbox[0] != '\0')
203 /* Listing the home namespace, so INBOX should be included. Home
204 * namespace is not "", so we have to list it explicitly. We ask the
205 * server to see if it has descendants. */
206 dprint (3, (debugfile, "imap_browse: adding INBOX\n"));
207 if (browse_add_list_result (idata, "LIST \"\" \"INBOX\"", state, 0))
211 nsup = state->entrylen;
213 dprint (3, (debugfile, "imap_browse: Quoting mailbox scan: %s -> ", mbox));
214 snprintf (buf, sizeof (buf), "%s%%", mbox);
215 imap_quote_string (buf2, sizeof (buf2), buf);
216 dprint (3, (debugfile, "%s\n", buf2));
217 snprintf (buf, sizeof (buf), "%s \"\" %s", list_cmd, buf2);
218 if (browse_add_list_result (idata, buf, state, 0))
221 if (!state->entrylen)
223 mutt_error _("No such folder");
229 qsort(&(state->entry[nsup]),state->entrylen-nsup,sizeof(state->entry[0]),
230 (int (*)(const void*,const void*)) compare_names);
232 { /* List additional namespaces */
233 for (i = 0; i < nns; i++)
234 if (nsi[i].listable && !nsi[i].home_namespace) {
235 imap_add_folder(nsi[i].delim, nsi[i].prefix, nsi[i].noselect,
236 nsi[i].noinferiors, state, 0);
237 dprint (3, (debugfile, "imap_browse: adding namespace: %s\n",
250 /* imap_mailbox_create: Prompt for a new mailbox name, and try to create it */
251 int imap_mailbox_create (const char* folder)
255 char buf[LONG_STRING];
258 if (imap_parse_path (folder, &mx) < 0)
260 dprint (1, (debugfile, "imap_mailbox_create: Bad starting path %s\n",
265 if (!(idata = imap_conn_find (&mx.account, M_IMAP_CONN_NONEW)))
267 dprint (1, (debugfile, "imap_mailbox_create: Couldn't find open connection to %s", mx.account.host));
271 strfcpy (buf, NONULL (mx.mbox), sizeof (buf));
273 /* append a delimiter if necessary */
274 n = mutt_strlen (buf);
275 if (n && (n < sizeof (buf) - 1) && (buf[n-1] != idata->delim))
277 buf[n++] = idata->delim;
281 if (mutt_get_field (_("Create mailbox: "), buf, sizeof (buf), M_FILE) < 0)
284 if (!mutt_strlen (buf))
286 mutt_error (_("Mailbox must have a name."));
291 if (imap_create_mailbox (idata, buf) < 0)
294 mutt_message _("Mailbox created.");
305 static int browse_add_list_result (IMAP_DATA* idata, const char* cmd,
306 struct browser_state* state, short isparent)
313 if (imap_parse_path (state->folder, &mx))
315 dprint (2, (debugfile,
316 "browse_add_list_result: current folder %s makes no sense\n", state->folder));
320 imap_cmd_start (idata, cmd);
324 if (imap_parse_list_response(idata, &name, &noselect, &noinferiors,
333 /* Let a parent folder never be selectable for navigation */
336 /* prune current folder from output */
337 if (isparent || mutt_strncmp (name, mx.mbox, strlen (name)))
338 imap_add_folder (idata->delim, name, noselect, noinferiors, state,
342 while ((ascii_strncmp (idata->cmd.buf, idata->cmd.seq, SEQLEN) != 0));
348 /* imap_add_folder: add a folder name to the browser list, formatting it as
350 static void imap_add_folder (char delim, char *folder, int noselect,
351 int noinferiors, struct browser_state *state, short isparent)
353 char tmp[LONG_STRING];
354 char relpath[LONG_STRING];
357 if (imap_parse_path (state->folder, &mx))
360 imap_unmunge_mbox_name (folder);
362 if (state->entrylen + 1 == state->entrymax)
364 safe_realloc (&state->entry,
365 sizeof (struct folder_file) * (state->entrymax += 256));
366 memset (state->entry + state->entrylen, 0,
367 (sizeof (struct folder_file) * (state->entrymax - state->entrylen)));
370 /* render superiors as unix-standard ".." */
372 strfcpy (relpath, "../", sizeof (relpath));
373 /* strip current folder from target, to render a relative path */
374 else if (!mutt_strncmp (mx.mbox, folder, mutt_strlen (mx.mbox)))
375 strfcpy (relpath, folder + mutt_strlen (mx.mbox), sizeof (relpath));
377 strfcpy (relpath, folder, sizeof (relpath));
379 /* apply filemask filter. This should really be done at menu setup rather
380 * than at scan, since it's so expensive to scan. But that's big changes
382 if (!((regexec (Mask.rx, relpath, 0, NULL, 0) == 0) ^ Mask.not))
388 imap_qualify_path (tmp, sizeof (tmp), &mx, folder);
389 (state->entry)[state->entrylen].name = safe_strdup (tmp);
391 /* mark desc with delim in browser if it can have subfolders */
392 if (!isparent && !noinferiors && strlen (relpath) < sizeof (relpath) - 1)
394 relpath[strlen (relpath) + 1] = '\0';
395 relpath[strlen (relpath)] = delim;
398 (state->entry)[state->entrylen].desc = safe_strdup (relpath);
400 (state->entry)[state->entrylen].imap = 1;
401 /* delimiter at the root is useless. */
402 if (folder[0] == '\0')
404 (state->entry)[state->entrylen].delim = delim;
405 (state->entry)[state->entrylen].selectable = !noselect;
406 (state->entry)[state->entrylen].inferiors = !noinferiors;
412 static int compare_names(struct folder_file *a, struct folder_file *b)
414 return mutt_strcmp(a->name, b->name);
417 static int browse_get_namespace (IMAP_DATA* idata, char* nsbuf, int nsblen,
418 IMAP_NAMESPACE_INFO* nsi, int nsilen, int* nns)
422 char ns[LONG_STRING];
429 nsbuf[nsblen-1] = '\0';
431 imap_cmd_start (idata, "NAMESPACE");
435 if ((rc = imap_cmd_step (idata)) != IMAP_CMD_CONTINUE)
438 s = imap_next_word (idata->cmd.buf);
439 if (ascii_strncasecmp ("NAMESPACE", s, 9) == 0)
441 /* There are three sections to the response, User, Other, Shared,
442 * and maybe more by extension */
443 for (type = IMAP_NS_PERSONAL; *s; type++)
445 s = imap_next_word (s);
446 if (*s && ascii_strncasecmp (s, "NIL", 3))
449 while (*s && *s != ')')
459 while (*s && *s != '\"')
470 while (*s && !ISSPACE (*s))
477 s = imap_next_word (s);
478 /* delimiter is meaningless if namespace is "". Why does
479 * Cyrus provide one?! */
480 if (n && *s && *s == '\"')
482 if (s[1] && s[2] == '\"')
484 else if (s[1] && s[1] == '\\' && s[2] && s[3] == '\"')
487 /* skip "" namespaces, they are already listed at the root */
488 if ((ns[0] != '\0') && (nsbused < nsblen) && (*nns < nsilen))
490 dprint (3, (debugfile, "browse_get_namespace: adding %s\n", ns));
492 /* Cyrus doesn't append the delimiter to the namespace,
493 * but UW-IMAP does. We'll strip it here and add it back
494 * as if it were a normal directory, from the browser */
495 if (n && (ns[n-1] == delim))
497 strncpy (nsbuf+nsbused,ns,nsblen-nsbused-1);
498 nsi->prefix = nsbuf+nsbused;
504 while (*s && *s != ')')
513 while (rc == IMAP_CMD_CONTINUE);
515 if (rc != IMAP_CMD_OK)
521 /* Check which namespaces have contents */
522 static int browse_verify_namespace (IMAP_DATA* idata,
523 IMAP_NAMESPACE_INFO *nsi, int nns)
525 char buf[LONG_STRING];
530 for (i = 0; i < nns; i++, nsi++)
532 /* Cyrus gives back nothing if the % isn't added. This may return lots
533 * of data in some cases, I guess, but I currently feel that's better
534 * than invisible namespaces */
536 snprintf (buf, sizeof (buf), "%s \"\" \"%s%c%%\"",
537 option (OPTIMAPLSUB) ? "LSUB" : "LIST", nsi->prefix,
540 snprintf (buf, sizeof (buf), "%s \"\" \"%s%%\"",
541 option (OPTIMAPLSUB) ? "LSUB" : "LIST", nsi->prefix);
543 imap_cmd_start (idata, buf);
546 nsi->home_namespace = 0;
549 if (imap_parse_list_response(idata, &name, &nsi->noselect,
550 &nsi->noinferiors, &delim) != 0)
552 nsi->listable |= (name != NULL);
554 while ((ascii_strncmp (idata->cmd.buf, idata->cmd.seq, SEQLEN) != 0));