imap/browse.c

   1 /*
   2  * Copyright (C) 1996-9 Brandon Long <blong@fiction.net>
   3  * Copyright (C) 1999-2008 Brendan Cully <brendan@kublai.com>
   4  *
   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.
   9  *
  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.
  14  *
  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., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  18  */
  19
  20 /* Mutt browser support routines */
  21
  22 #if HAVE_CONFIG_H
  23 # include "config.h"
  24 #endif
  25
  26 #include <stdlib.h>
  27 #include <ctype.h>
  28
  29 #include "mutt.h"
  30 #include "imap_private.h"
  31
  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
  39 /* imap_browse: IMAP hook into the folder browser, fills out browser_state,
  40  *   given a current folder to browse */
  41 int imap_browse (char* path, struct browser_state* state)
  42 {
  43   IMAP_DATA* idata;
  44   IMAP_LIST list;
  45   char buf[LONG_STRING];
  46   char buf2[LONG_STRING];
  47   char mbox[LONG_STRING];
  48   char list_cmd[5];
  49   int n;
  50   int nsup;
  51   char ctmp;
  52   short showparents = 0;
  53   int save_lsub;
  54   IMAP_MBOX mx;
  55
  56   if (imap_parse_path (path, &mx))
  57   {
  58     mutt_error (_("%s is an invalid IMAP path"), path);
  59     return -1;
  60   }
  61
  62   save_lsub = option (OPTIMAPCHECKSUBSCRIBED);
  63   unset_option (OPTIMAPCHECKSUBSCRIBED);
  64   strfcpy (list_cmd, option (OPTIMAPLSUB) ? "LSUB" : "LIST", sizeof (list_cmd));
  65
  66   if (!(idata = imap_conn_find (&(mx.account), 0)))
  67     goto fail;
  68
  69   mutt_message _("Getting folder list...");
  70
  71   /* skip check for parents when at the root */
  72   if (mx.mbox && mx.mbox[0] != '\0')
  73   {
  74     int rc;
  75     imap_fix_path (idata, mx.mbox, mbox, sizeof (mbox));
  76     imap_munge_mbox_name (buf, sizeof (buf), mbox);
  77     imap_unquote_string(buf); /* As kludgy as it gets */
  78     mbox[sizeof (mbox) - 1] = '\0';
  79     strncpy (mbox, buf, sizeof (mbox) - 1);
  80     n = mutt_strlen (mbox);
  81
  82     dprint (3, (debugfile, "imap_browse: mbox: %s\n", mbox));
  83
  84     /* if our target exists and has inferiors, enter it if we
  85      * aren't already going to */
  86     if (mbox[n-1] != idata->delim)
  87     {
  88       snprintf (buf, sizeof (buf), "%s \"\" \"%s\"", list_cmd, mbox);
  89       imap_cmd_start (idata, buf);
  90       idata->cmdtype = IMAP_CT_LIST;
  91       idata->cmddata = &list;
  92       do
  93       {
  94         list.name = 0;
  95         rc = imap_cmd_step (idata);
  96         if (rc == IMAP_CMD_CONTINUE && list.name)
  97         {
  98           if (!list.noinferiors && list.name[0] &&
  99               !imap_mxcmp (list.name, mbox) &&
 100             (n = strlen (mbox)) < sizeof (mbox) - 1)
 101           {
 102             mbox[n++] = list.delim;
 103             mbox[n] = '\0';
 104           }
 105         }
 106       }
 107       while (rc == IMAP_CMD_CONTINUE);
 108       idata->cmddata = NULL;
 109     }
 110
 111     /* if we're descending a folder, mark it as current in browser_state */
 112     if (mbox[n-1] == list.delim)
 113     {
 114       showparents = 1;
 115       imap_qualify_path (buf, sizeof (buf), &mx, mbox);
 116       state->folder = safe_strdup (buf);
 117       n--;
 118     }
 119
 120     /* Find superiors to list
 121      * Note: UW-IMAP servers return folder + delimiter when asked to list
 122      *  folder + delimiter. Cyrus servers don't. So we ask for folder,
 123      *  and tack on delimiter ourselves.
 124      * Further note: UW-IMAP servers return nothing when asked for
 125      *  NAMESPACES without delimiters at the end. Argh! */
 126     for (n--; n >= 0 && mbox[n] != list.delim ; n--);
 127     if (n > 0)                  /* "aaaa/bbbb/" -> "aaaa" */
 128     {
 129       /* forget the check, it is too delicate (see above). Have we ever
 130        * had the parent not exist? */
 131       ctmp = mbox[n];
 132       mbox[n] = '\0';
 133
 134       if (showparents)
 135       {
 136         dprint (3, (debugfile, "imap_init_browse: adding parent %s\n", mbox));
 137         imap_add_folder (list.delim, mbox, 1, 0, state, 1);
 138       }
 139
 140       /* if our target isn't a folder, we are in our superior */
 141       if (!state->folder)
 142       {
 143         /* store folder with delimiter */
 144         mbox[n++] = ctmp;
 145         ctmp = mbox[n];
 146         mbox[n] = '\0';
 147         imap_qualify_path (buf, sizeof (buf), &mx, mbox);
 148         state->folder = safe_strdup (buf);
 149       }
 150       mbox[n] = ctmp;
 151     }
 152     /* "/bbbb/" -> add  "/", "aaaa/" -> add "" */
 153     else
 154     {
 155       char relpath[2];
 156       /* folder may be "/" */
 157       snprintf (relpath, sizeof (relpath), "%c" , n < 0 ? '\0' : idata->delim);
 158       if (showparents)
 159         imap_add_folder (idata->delim, relpath, 1, 0, state, 1);
 160       if (!state->folder)
 161       {
 162         imap_qualify_path (buf, sizeof (buf), &mx, relpath);
 163         state->folder = safe_strdup (buf);
 164       }
 165     }
 166   }
 167   else
 168     mbox[0] = '\0';
 169
 170   /* no namespace, no folder: set folder to host only */
 171   if (!state->folder)
 172   {
 173     imap_qualify_path (buf, sizeof (buf), &mx, NULL);
 174     state->folder = safe_strdup (buf);
 175   }
 176
 177   nsup = state->entrylen;
 178
 179   dprint (3, (debugfile, "imap_browse: Quoting mailbox scan: %s -> ", mbox));
 180   snprintf (buf, sizeof (buf), "%s%%", mbox);
 181   imap_quote_string (buf2, sizeof (buf2), buf);
 182   dprint (3, (debugfile, "%s\n", buf2));
 183   snprintf (buf, sizeof (buf), "%s \"\" %s", list_cmd, buf2);
 184   if (browse_add_list_result (idata, buf, state, 0))
 185     goto fail;
 186
 187   if (!state->entrylen)
 188   {
 189     mutt_error _("No such folder");
 190     goto fail;
 191   }
 192
 193   mutt_clear_error ();
 194
 195   qsort(&(state->entry[nsup]),state->entrylen-nsup,sizeof(state->entry[0]),
 196         (int (*)(const void*,const void*)) compare_names);
 197
 198   if (save_lsub)
 199     set_option (OPTIMAPCHECKSUBSCRIBED);
 200
 201   FREE (&mx.mbox);
 202   return 0;
 203
 204  fail:
 205   if (save_lsub)
 206     set_option (OPTIMAPCHECKSUBSCRIBED);
 207   FREE (&mx.mbox);
 208   return -1;
 209 }
 210
 211 int imap_mailbox_state (const char* path, struct mailbox_state* state)
 212 {
 213   IMAP_DATA* idata;
 214   IMAP_MBOX mx;
 215   IMAP_STATUS* status;
 216
 217   memset (state, 0, sizeof (*state));
 218   if (imap_parse_path (path, &mx) < 0)
 219   {
 220     dprint (1, (debugfile, "imap_mailbox_state: bad path %s\n", path));
 221     return -1;
 222   }
 223   if (!(idata = imap_conn_find (&mx.account, M_IMAP_CONN_NONEW)))
 224   {
 225     dprint (2, (debugfile, "imap_mailbox_state: no open connection for %s\n",
 226                 path));
 227     FREE (&mx.mbox);
 228     return -1;
 229   }
 230
 231   if (idata->ctx && !imap_mxcmp(mx.mbox, idata->mailbox))
 232   {
 233     state->new = idata->ctx->new;
 234     state->messages = idata->ctx->msgcount;
 235   }
 236   else if ((status = imap_mboxcache_get (idata, mx.mbox, 0)))
 237   {
 238     state->new = status->unseen;
 239     state->messages = status->messages;
 240   }
 241
 242   FREE (&mx.mbox);
 243
 244   return 0;
 245 }
 246
 247 /* imap_mailbox_create: Prompt for a new mailbox name, and try to create it */
 248 int imap_mailbox_create (const char* folder)
 249 {
 250   IMAP_DATA* idata;
 251   IMAP_MBOX mx;
 252   char buf[LONG_STRING];
 253   short n;
 254
 255   if (imap_parse_path (folder, &mx) < 0)
 256   {
 257     dprint (1, (debugfile, "imap_mailbox_create: Bad starting path %s\n",
 258       folder));
 259     return -1;
 260   }
 261
 262   if (!(idata = imap_conn_find (&mx.account, M_IMAP_CONN_NONEW)))
 263   {
 264     dprint (1, (debugfile, "imap_mailbox_create: Couldn't find open connection to %s", mx.account.host));
 265     goto fail;
 266   }
 267
 268   strfcpy (buf, NONULL (mx.mbox), sizeof (buf));
 269
 270   /* append a delimiter if necessary */
 271   n = mutt_strlen (buf);
 272   if (n && (n < sizeof (buf) - 1) && (buf[n-1] != idata->delim))
 273   {
 274     buf[n++] = idata->delim;
 275     buf[n] = '\0';
 276   }
 277
 278   if (mutt_get_field (_("Create mailbox: "), buf, sizeof (buf), M_FILE) < 0)
 279     goto fail;
 280
 281   if (!mutt_strlen (buf))
 282   {
 283     mutt_error (_("Mailbox must have a name."));
 284     mutt_sleep(1);
 285     goto fail;
 286   }
 287
 288   if (imap_create_mailbox (idata, buf) < 0)
 289     goto fail;
 290
 291   mutt_message _("Mailbox created.");
 292   mutt_sleep (0);
 293
 294   FREE (&mx.mbox);
 295   return 0;
 296
 297  fail:
 298   FREE (&mx.mbox);
 299   return -1;
 300 }
 301
 302 int imap_mailbox_rename(const char* mailbox)
 303 {
 304   IMAP_DATA* idata;
 305   IMAP_MBOX mx;
 306   char buf[LONG_STRING];
 307   char newname[SHORT_STRING];
 308
 309   if (imap_parse_path (mailbox, &mx) < 0)
 310   {
 311     dprint (1, (debugfile, "imap_mailbox_rename: Bad source mailbox %s\n",
 312       mailbox));
 313     return -1;
 314   }
 315
 316   if (!(idata = imap_conn_find (&mx.account, M_IMAP_CONN_NONEW)))
 317   {
 318     dprint (1, (debugfile, "imap_mailbox_rename: Couldn't find open connection to %s", mx.account.host));
 319     goto fail;
 320   }
 321
 322   snprintf(buf, sizeof (buf), _("Rename mailbox %s to: "), mx.mbox);
 323
 324  if (mutt_get_field (buf, newname, sizeof (newname), M_FILE) < 0)
 325     goto fail;
 326
 327   if (!mutt_strlen (newname))
 328   {
 329     mutt_error (_("Mailbox must have a name."));
 330     mutt_sleep (1);
 331     goto fail;
 332   }
 333
 334   imap_fix_path (idata, newname, buf, sizeof (buf));
 335
 336   if (imap_rename_mailbox (idata, &mx, buf) < 0) {
 337     mutt_error (_("Rename failed: %s"), imap_get_qualifier (idata->buf));
 338     mutt_sleep (1);
 339     goto fail;
 340   }
 341
 342   mutt_message (_("Mailbox renamed."));
 343   mutt_sleep (0);
 344
 345   FREE (&mx.mbox);
 346   return 0;
 347
 348  fail:
 349   FREE (&mx.mbox);
 350   return -1;
 351 }
 352
 353 static int browse_add_list_result (IMAP_DATA* idata, const char* cmd,
 354   struct browser_state* state, short isparent)
 355 {
 356   IMAP_LIST list;
 357   IMAP_MBOX mx;
 358   int rc;
 359
 360   if (imap_parse_path (state->folder, &mx))
 361   {
 362     dprint (2, (debugfile,
 363       "browse_add_list_result: current folder %s makes no sense\n", state->folder));
 364     return -1;
 365   }
 366
 367   imap_cmd_start (idata, cmd);
 368   idata->cmdtype = IMAP_CT_LIST;
 369   idata->cmddata = &list;
 370   do
 371   {
 372     list.name = NULL;
 373     rc = imap_cmd_step (idata);
 374
 375     if (rc == IMAP_CMD_CONTINUE && list.name)
 376     {
 377       /* Let a parent folder never be selectable for navigation */
 378       if (isparent)
 379         list.noselect = 1;
 380       /* prune current folder from output */
 381       if (isparent || mutt_strncmp (list.name, mx.mbox, strlen (list.name)))
 382         imap_add_folder (list.delim, list.name, list.noselect, list.noinferiors,
 383                          state, isparent);
 384     }
 385   }
 386   while (rc == IMAP_CMD_CONTINUE);
 387   idata->cmddata = NULL;
 388
 389   FREE (&mx.mbox);
 390   return rc == IMAP_CMD_OK ? 0 : -1;
 391 }
 392
 393 /* imap_add_folder: add a folder name to the browser list, formatting it as
 394  *   necessary. */
 395 static void imap_add_folder (char delim, char *folder, int noselect,
 396   int noinferiors, struct browser_state *state, short isparent)
 397 {
 398   char tmp[LONG_STRING];
 399   char relpath[LONG_STRING];
 400   IMAP_MBOX mx;
 401
 402   if (imap_parse_path (state->folder, &mx))
 403     return;
 404
 405   imap_unmunge_mbox_name (folder);
 406
 407   if (state->entrylen + 1 == state->entrymax)
 408   {
 409     safe_realloc (&state->entry,
 410       sizeof (struct folder_file) * (state->entrymax += 256));
 411     memset (state->entry + state->entrylen, 0,
 412       (sizeof (struct folder_file) * (state->entrymax - state->entrylen)));
 413   }
 414
 415   /* render superiors as unix-standard ".." */
 416   if (isparent)
 417     strfcpy (relpath, "../", sizeof (relpath));
 418   /* strip current folder from target, to render a relative path */
 419   else if (!mutt_strncmp (mx.mbox, folder, mutt_strlen (mx.mbox)))
 420     strfcpy (relpath, folder + mutt_strlen (mx.mbox), sizeof (relpath));
 421   else
 422     strfcpy (relpath, folder, sizeof (relpath));
 423
 424   /* apply filemask filter. This should really be done at menu setup rather
 425    * than at scan, since it's so expensive to scan. But that's big changes
 426    * to browser.c */
 427   if (!((regexec (Mask.rx, relpath, 0, NULL, 0) == 0) ^ Mask.not))
 428   {
 429     FREE (&mx.mbox);
 430     return;
 431   }
 432
 433   imap_qualify_path (tmp, sizeof (tmp), &mx, folder);
 434   (state->entry)[state->entrylen].name = safe_strdup (tmp);
 435
 436   /* mark desc with delim in browser if it can have subfolders */
 437   if (!isparent && !noinferiors && strlen (relpath) < sizeof (relpath) - 1)
 438   {
 439     relpath[strlen (relpath) + 1] = '\0';
 440     relpath[strlen (relpath)] = delim;
 441   }
 442
 443   (state->entry)[state->entrylen].desc = safe_strdup (relpath);
 444
 445   (state->entry)[state->entrylen].imap = 1;
 446   /* delimiter at the root is useless. */
 447   if (folder[0] == '\0')
 448     delim = '\0';
 449   (state->entry)[state->entrylen].delim = delim;
 450   (state->entry)[state->entrylen].selectable = !noselect;
 451   (state->entry)[state->entrylen].inferiors = !noinferiors;
 452   (state->entrylen)++;
 453
 454   FREE (&mx.mbox);
 455 }
 456
 457 static int compare_names(struct folder_file *a, struct folder_file *b)
 458 {
 459   return mutt_strcmp(a->name, b->name);
 460 }