imap/imap.c

   1 /*
   2  * Copyright notice from original mutt:
   3  * Copyright (C) 1996-8 Michael R. Elkins <me@mutt.org>
   4  * Copyright (C) 1996-9 Brandon Long <blong@fiction.net>
   5  * Copyright (C) 1999-2005 Brendan Cully <brendan@kublai.com>
   6  *
   7  * This file is part of mutt-ng, see http://www.muttng.org/.
   8  * It's licensed under the GNU General Public License,
   9  * please see the file GPL in the top level source directory.
  10  */
  11
  12 /* Support for IMAP4rev1, with the occasional nod to IMAP 4. */
  13
  14 #if HAVE_CONFIG_H
  15 # include "config.h"
  16 #endif
  17
  18 #include "mutt.h"
  19 #include "ascii.h"
  20 #include "buffer.h"
  21 #include "mx.h"
  22 #include "globals.h"
  23 #include "sort.h"
  24 #include "browser.h"
  25 #include "message.h"
  26 #include "imap_private.h"
  27 #if defined(USE_SSL) || defined(USE_GNUTLS)
  28 # include "mutt_ssl.h"
  29 #endif
  30 #include "buffy.h"
  31
  32 #include "lib/mem.h"
  33 #include "lib/intl.h"
  34 #include "lib/str.h"
  35 #include "lib/debug.h"
  36
  37 #include <unistd.h>
  38 #include <ctype.h>
  39 #include <string.h>
  40 #include <stdlib.h>
  41 #include <sys/types.h>
  42 #include <sys/stat.h>
  43
  44 /* imap forward declarations */
  45 static int imap_get_delim (IMAP_DATA * idata);
  46 static char *imap_get_flags (LIST ** hflags, char *s);
  47 static int imap_check_acl (IMAP_DATA * idata);
  48 static int imap_check_capabilities (IMAP_DATA * idata);
  49 static void imap_set_flag (IMAP_DATA * idata, int aclbit, int flag,
  50                            const char *str, char *flags, size_t flsize);
  51
  52 /* imap_access: Check permissions on an IMAP mailbox.
  53  * TODO: ACL checks. Right now we assume if it exists we can
  54  * mess with it. */
  55 int imap_access (const char *path, int flags)
  56 {
  57   IMAP_DATA *idata;
  58   IMAP_MBOX mx;
  59   char buf[LONG_STRING];
  60   char mailbox[LONG_STRING];
  61   char mbox[LONG_STRING];
  62
  63   if (imap_parse_path (path, &mx))
  64     return -1;
  65
  66   if (!(idata = imap_conn_find (&mx.account,
  67                                 option (OPTIMAPPASSIVE) ? M_IMAP_CONN_NONEW :
  68                                 0))) {
  69     mem_free (&mx.mbox);
  70     return -1;
  71   }
  72
  73   imap_fix_path (idata, mx.mbox, mailbox, sizeof (mailbox));
  74
  75   /* we may already be in the folder we're checking */
  76   if (!ascii_strcmp(idata->mailbox, mx.mbox)) {
  77     mem_free (&mx.mbox);
  78     return 0;
  79   }
  80
  81   mem_free (&mx.mbox);
  82   imap_munge_mbox_name (mbox, sizeof (mbox), mailbox);
  83
  84   if (mutt_bit_isset (idata->capabilities, IMAP4REV1))
  85     snprintf (buf, sizeof (buf), "STATUS %s (UIDVALIDITY)", mbox);
  86   else if (mutt_bit_isset (idata->capabilities, STATUS))
  87     snprintf (buf, sizeof (buf), "STATUS %s (UID-VALIDITY)", mbox);
  88   else {
  89     debug_print (2, ("STATUS not supported?\n"));
  90     return -1;
  91   }
  92
  93   if (imap_exec (idata, buf, IMAP_CMD_FAIL_OK) < 0) {
  94     debug_print (1, ("Can't check STATUS of %s\n", mbox));
  95     return -1;
  96   }
  97
  98   return 0;
  99 }
 100
 101 int imap_create_mailbox (IMAP_DATA * idata, char *mailbox)
 102 {
 103   char buf[LONG_STRING], mbox[LONG_STRING];
 104
 105   imap_munge_mbox_name (mbox, sizeof (mbox), mailbox);
 106   snprintf (buf, sizeof (buf), "CREATE %s", mbox);
 107
 108   if (imap_exec (idata, buf, 0) != 0)
 109     return -1;
 110
 111   return 0;
 112 }
 113
 114 int imap_rename_mailbox (IMAP_DATA * idata, IMAP_MBOX * mx,
 115                          const char *newname)
 116 {
 117   char oldmbox[LONG_STRING];
 118   char newmbox[LONG_STRING];
 119   char buf[LONG_STRING];
 120
 121   imap_munge_mbox_name (oldmbox, sizeof (oldmbox), mx->mbox);
 122   imap_munge_mbox_name (newmbox, sizeof (newmbox), newname);
 123
 124   snprintf (buf, sizeof (buf), "RENAME %s %s", oldmbox, newmbox);
 125
 126   if (imap_exec (idata, buf, 0) != 0)
 127     return -1;
 128
 129   return 0;
 130 }
 131
 132 int imap_delete_mailbox (CONTEXT * ctx, IMAP_MBOX mx)
 133 {
 134   char buf[LONG_STRING], mbox[LONG_STRING];
 135   IMAP_DATA *idata;
 136
 137   if (!ctx || !ctx->data) {
 138     if (!(idata = imap_conn_find (&mx.account,
 139                                   option (OPTIMAPPASSIVE) ? M_IMAP_CONN_NONEW
 140                                   : 0))) {
 141       mem_free (&mx.mbox);
 142       return -1;
 143     }
 144   }
 145   else {
 146     idata = ctx->data;
 147   }
 148
 149   imap_munge_mbox_name (mbox, sizeof (mbox), mx.mbox);
 150   snprintf (buf, sizeof (buf), "DELETE %s", mbox);
 151
 152   if (imap_exec ((IMAP_DATA *) idata, buf, 0) != 0)
 153     return -1;
 154
 155   return 0;
 156 }
 157
 158 /* imap_logout_all: close all open connections. Quick and dirty until we can
 159  *   make sure we've got all the context we need. */
 160 void imap_logout_all (void)
 161 {
 162   CONNECTION *conn;
 163   CONNECTION *tmp;
 164
 165   conn = mutt_socket_head ();
 166
 167   while (conn) {
 168     tmp = conn->next;
 169
 170     if (conn->account.type == M_ACCT_TYPE_IMAP && conn->fd >= 0) {
 171       mutt_message (_("Closing connection to %s..."), conn->account.host);
 172       imap_logout ((IMAP_DATA *) conn->data);
 173       mutt_clear_error ();
 174       mutt_socket_close (conn);
 175       mutt_socket_free (conn);
 176     }
 177
 178     conn = tmp;
 179   }
 180 }
 181
 182 /* imap_read_literal: read bytes bytes from server into file. Not explicitly
 183  *   buffered, relies on FILE buffering. NOTE: strips \r from \r\n.
 184  *   Apparently even literals use \r\n-terminated strings ?! */
 185 int imap_read_literal (FILE * fp, IMAP_DATA * idata, long bytes, progress_t* bar)
 186 {
 187   long pos;
 188   char c;
 189
 190   int r = 0;
 191
 192   debug_print (2, ("reading %ld bytes\n", bytes));
 193
 194   for (pos = 0; pos < bytes; pos++) {
 195     if (mutt_socket_readchar (idata->conn, &c) != 1) {
 196       debug_print (1, ("error during read, %ld bytes read\n", pos));
 197       idata->status = IMAP_FATAL;
 198
 199       return -1;
 200     }
 201
 202 #if 1
 203     if (r == 1 && c != '\n')
 204       fputc ('\r', fp);
 205
 206     if (c == '\r') {
 207       r = 1;
 208       continue;
 209     }
 210     else
 211       r = 0;
 212 #endif
 213     fputc (c, fp);
 214 #ifdef USE_SOCKET
 215     if (bar && pos % 1024)
 216       mutt_progress_bar (bar, pos);
 217 #endif
 218 #ifdef DEBUG
 219     if (DebugLevel >= IMAP_LOG_LTRL)
 220       fputc (c, DebugFile);
 221 #endif
 222   }
 223
 224   return 0;
 225 }
 226
 227 /* imap_expunge_mailbox: Purge IMAP portion of expunged messages from the
 228  *   context. Must not be done while something has a handle on any headers
 229  *   (eg inside pager or editor). That is, check IMAP_REOPEN_ALLOW. */
 230 void imap_expunge_mailbox (IMAP_DATA * idata)
 231 {
 232   HEADER *h;
 233   int i, cacheno;
 234
 235   for (i = 0; i < idata->ctx->msgcount; i++) {
 236     h = idata->ctx->hdrs[i];
 237
 238     if (h->index == -1) {
 239       debug_print (2, ("Expunging message UID %d.\n", HEADER_DATA (h)->uid));
 240
 241       h->active = 0;
 242
 243       /* free cached body from disk, if neccessary */
 244       cacheno = HEADER_DATA (h)->uid % IMAP_CACHE_LEN;
 245       if (idata->cache[cacheno].uid == HEADER_DATA (h)->uid &&
 246           idata->cache[cacheno].path) {
 247         unlink (idata->cache[cacheno].path);
 248         mem_free (&idata->cache[cacheno].path);
 249       }
 250
 251       imap_free_header_data (&h->data);
 252     }
 253   }
 254
 255   /* We may be called on to expunge at any time. We can't rely on the caller
 256    * to always know to rethread */
 257   mx_update_tables (idata->ctx, 0);
 258   mutt_sort_headers (idata->ctx, 1);
 259 }
 260
 261 static int imap_get_delim (IMAP_DATA * idata)
 262 {
 263   char *s;
 264   int rc;
 265
 266   /* assume that the delim is /.  If this fails, we're in bigger trouble
 267    * than getting the delim wrong */
 268   idata->delim = '/';
 269
 270   imap_cmd_start (idata, "LIST \"\" \"\"");
 271
 272   do {
 273     if ((rc = imap_cmd_step (idata)) != IMAP_CMD_CONTINUE)
 274       break;
 275
 276     s = imap_next_word (idata->cmd.buf);
 277     if (ascii_strncasecmp ("LIST", s, 4) == 0) {
 278       s = imap_next_word (s);
 279       s = imap_next_word (s);
 280       if (s && s[0] == '\"' && s[1] && s[2] == '\"')
 281         idata->delim = s[1];
 282       else if (s && s[0] == '\"' && s[1] && s[1] == '\\' && s[2]
 283                && s[3] == '\"')
 284         idata->delim = s[2];
 285     }
 286   }
 287   while (rc == IMAP_CMD_CONTINUE);
 288
 289   if (rc != IMAP_CMD_OK) {
 290     debug_print (1, ("failed.\n"));
 291     return -1;
 292   }
 293
 294   debug_print (2, ("Delimiter: %c\n", idata->delim));
 295
 296   return -1;
 297 }
 298
 299 /* get rights for folder, let imap_handle_untagged do the rest */
 300 static int imap_check_acl (IMAP_DATA * idata)
 301 {
 302   char buf[LONG_STRING];
 303   char mbox[LONG_STRING];
 304
 305   imap_munge_mbox_name (mbox, sizeof (mbox), idata->mailbox);
 306   snprintf (buf, sizeof (buf), "MYRIGHTS %s", mbox);
 307   if (imap_exec (idata, buf, 0) != 0) {
 308     imap_error ("imap_check_acl", buf);
 309     return -1;
 310   }
 311   return 0;
 312 }
 313
 314 /* imap_check_capabilities: make sure we can log in to this server. */
 315 static int imap_check_capabilities (IMAP_DATA * idata)
 316 {
 317   if (imap_exec (idata, "CAPABILITY", 0) != 0) {
 318     imap_error ("imap_check_capabilities", idata->cmd.buf);
 319     return -1;
 320   }
 321
 322   if (!(mutt_bit_isset (idata->capabilities, IMAP4)
 323         || mutt_bit_isset (idata->capabilities, IMAP4REV1))) {
 324     mutt_error _("This IMAP server is ancient. Mutt does not work with it.");
 325
 326     mutt_sleep (2);             /* pause a moment to let the user see the error */
 327
 328     return -1;
 329   }
 330
 331   return 0;
 332 }
 333
 334 /* imap_conn_find: Find an open IMAP connection matching account, or open
 335  *   a new one if none can be found. */
 336 IMAP_DATA *imap_conn_find (const ACCOUNT * account, int flags)
 337 {
 338   CONNECTION *conn;
 339   IMAP_DATA *idata;
 340   ACCOUNT *creds;
 341   int new = 0;
 342
 343   if (!(conn = mutt_conn_find (NULL, account)))
 344     return NULL;
 345
 346   /* if opening a new UNSELECTED connection, preserve existing creds */
 347   creds = &(conn->account);
 348
 349   /* make sure this connection is not in SELECTED state, if neccessary */
 350   if (flags & M_IMAP_CONN_NOSELECT)
 351     while (conn->data && ((IMAP_DATA *) conn->data)->state == IMAP_SELECTED) {
 352       if (!(conn = mutt_conn_find (conn, account)))
 353         return NULL;
 354       memcpy (&(conn->account), creds, sizeof (ACCOUNT));
 355     }
 356
 357   idata = (IMAP_DATA *) conn->data;
 358
 359   /* don't open a new connection if one isn't wanted */
 360   if (flags & M_IMAP_CONN_NONEW) {
 361     if (!idata) {
 362       mutt_socket_free (conn);
 363       return NULL;
 364     }
 365     if (idata->state < IMAP_AUTHENTICATED)
 366       return NULL;
 367   }
 368
 369   if (!idata) {
 370     /* The current connection is a new connection */
 371     if (!(idata = imap_new_idata ())) {
 372       mutt_socket_free (conn);
 373       return NULL;
 374     }
 375
 376     conn->data = idata;
 377     idata->conn = conn;
 378     new = 1;
 379   }
 380
 381   if (idata->state == IMAP_DISCONNECTED)
 382     imap_open_connection (idata);
 383   if (idata->state == IMAP_CONNECTED) {
 384     if (!imap_authenticate (idata)) {
 385       idata->state = IMAP_AUTHENTICATED;
 386       if (idata->conn->ssf)
 387         debug_print (2, ("Communication encrypted at %d bits\n", idata->conn->ssf));
 388     }
 389     else
 390       mutt_account_unsetpass (&idata->conn->account);
 391
 392     mem_free (&idata->capstr);
 393   }
 394   if (new && idata->state == IMAP_AUTHENTICATED) {
 395     imap_get_delim (idata);
 396     if (option (OPTIMAPCHECKSUBSCRIBED)) {
 397       mutt_message _("Checking mailbox subscriptions");
 398       imap_exec (idata, "LSUB \"\" \"*\"", 0);
 399     }
 400   }
 401
 402   return idata;
 403 }
 404
 405 int imap_open_connection (IMAP_DATA * idata)
 406 {
 407   char buf[LONG_STRING];
 408
 409   if (mutt_socket_open (idata->conn) < 0)
 410     return -1;
 411
 412   idata->state = IMAP_CONNECTED;
 413
 414   if (imap_cmd_step (idata) != IMAP_CMD_CONTINUE) {
 415     mutt_socket_close (idata->conn);
 416     idata->state = IMAP_DISCONNECTED;
 417     return -1;
 418   }
 419
 420   if (ascii_strncasecmp ("* OK", idata->cmd.buf, 4) == 0) {
 421     /* TODO: Parse new tagged CAPABILITY data (* OK [CAPABILITY...]) */
 422     if (imap_check_capabilities (idata))
 423       goto bail;
 424 #if defined(USE_SSL) || defined(USE_GNUTLS)
 425     /* Attempt STARTTLS if available and desired. */
 426     if (!idata->conn->ssf && (option(OPTSSLFORCETLS) ||
 427                               mutt_bit_isset (idata->capabilities, STARTTLS))) {
 428       int rc;
 429
 430       if (option (OPTSSLFORCETLS))
 431         rc = M_YES;
 432       else if ((rc = query_quadoption (OPT_SSLSTARTTLS,
 433                                        _("Secure connection with TLS?"))) == -1)
 434         goto err_close_conn;
 435       if (rc == M_YES) {
 436         if ((rc = imap_exec (idata, "STARTTLS", IMAP_CMD_FAIL_OK)) == -1)
 437           goto bail;
 438         if (rc != -2) {
 439 #if defined (USE_SSL) || defined (USE_GNUTLS)
 440           if (mutt_ssl_starttls (idata->conn))
 441 #endif
 442           {
 443             mutt_error (_("Could not negotiate TLS connection"));
 444             mutt_sleep (1);
 445             goto err_close_conn;
 446           }
 447           else {
 448             /* RFC 2595 demands we recheck CAPABILITY after TLS completes. */
 449             if (imap_exec (idata, "CAPABILITY", 0))
 450               goto bail;
 451           }
 452         }
 453       }
 454     }
 455
 456     if (option(OPTSSLFORCETLS) && ! idata->conn->ssf) {
 457       mutt_error _("Encrypted connection unavailable");
 458       mutt_sleep (1);
 459       goto err_close_conn;
 460     }
 461 #endif
 462   }
 463   else if (ascii_strncasecmp ("* PREAUTH", idata->cmd.buf, 9) == 0) {
 464     idata->state = IMAP_AUTHENTICATED;
 465     if (imap_check_capabilities (idata) != 0)
 466       goto bail;
 467     mem_free (&idata->capstr);
 468   }
 469   else {
 470     imap_error ("imap_open_connection()", buf);
 471     goto bail;
 472   }
 473
 474   return 0;
 475
 476 err_close_conn:
 477   mutt_socket_close (idata->conn);
 478   idata->state = IMAP_DISCONNECTED;
 479 bail:
 480   mem_free (&idata->capstr);
 481   return -1;
 482 }
 483
 484 /* imap_get_flags: Make a simple list out of a FLAGS response.
 485  *   return stream following FLAGS response */
 486 static char *imap_get_flags (LIST ** hflags, char *s)
 487 {
 488   LIST *flags;
 489   char *flag_word;
 490   char ctmp;
 491
 492   /* sanity-check string */
 493   if (ascii_strncasecmp ("FLAGS", s, 5) != 0) {
 494     debug_print (1, ("not a FLAGS response: %s\n", s));
 495     return NULL;
 496   }
 497   s += 5;
 498   SKIPWS (s);
 499   if (*s != '(') {
 500     debug_print (1, ("bogus FLAGS response: %s\n", s));
 501     return NULL;
 502   }
 503
 504   /* create list, update caller's flags handle */
 505   flags = mutt_new_list ();
 506   *hflags = flags;
 507
 508   while (*s && *s != ')') {
 509     s++;
 510     SKIPWS (s);
 511     flag_word = s;
 512     while (*s && (*s != ')') && !ISSPACE (*s))
 513       s++;
 514     ctmp = *s;
 515     *s = '\0';
 516     if (*flag_word)
 517       mutt_add_list (flags, flag_word);
 518     *s = ctmp;
 519   }
 520
 521   /* note bad flags response */
 522   if (*s != ')') {
 523     debug_print (1, ("Unterminated FLAGS response: %s\n", s));
 524     mutt_free_list (hflags);
 525
 526     return NULL;
 527   }
 528
 529   s++;
 530
 531   return s;
 532 }
 533
 534 int imap_open_mailbox (CONTEXT * ctx)
 535 {
 536   CONNECTION *conn;
 537   IMAP_DATA *idata;
 538   char buf[LONG_STRING];
 539   char bufout[LONG_STRING];
 540   int count = 0;
 541   IMAP_MBOX mx;
 542   int rc;
 543
 544   if (imap_parse_path (ctx->path, &mx)) {
 545     mutt_error (_("%s is an invalid IMAP path"), ctx->path);
 546     return -1;
 547   }
 548
 549   /* we require a connection which isn't currently in IMAP_SELECTED state */
 550   if (!(idata = imap_conn_find (&(mx.account), M_IMAP_CONN_NOSELECT)))
 551     goto fail_noidata;
 552   if (idata->state < IMAP_AUTHENTICATED)
 553     goto fail;
 554
 555   conn = idata->conn;
 556
 557   /* once again the context is new */
 558   ctx->data = idata;
 559
 560   /* Clean up path and replace the one in the ctx */
 561   imap_fix_path (idata, mx.mbox, buf, sizeof (buf));
 562   mem_free (&(idata->mailbox));
 563   idata->mailbox = str_dup (buf);
 564   imap_qualify_path (buf, sizeof (buf), &mx, idata->mailbox);
 565
 566   mem_free (&(ctx->path));
 567   ctx->path = str_dup (buf);
 568
 569   idata->ctx = ctx;
 570
 571   /* clear mailbox status */
 572   idata->status = 0;
 573   memset (idata->rights, 0, (RIGHTSMAX + 7) / 8);
 574   idata->newMailCount = 0;
 575
 576   mutt_message (_("Selecting %s..."), idata->mailbox);
 577   imap_munge_mbox_name (buf, sizeof (buf), idata->mailbox);
 578   snprintf (bufout, sizeof (bufout), "%s %s",
 579             ctx->readonly ? "EXAMINE" : "SELECT", buf);
 580
 581   idata->state = IMAP_SELECTED;
 582
 583   imap_cmd_start (idata, bufout);
 584
 585   do {
 586     char *pc;
 587
 588     if ((rc = imap_cmd_step (idata)) != IMAP_CMD_CONTINUE)
 589       break;
 590
 591     pc = idata->cmd.buf + 2;
 592
 593     /* Obtain list of available flags here, may be overridden by a
 594      * PERMANENTFLAGS tag in the OK response */
 595     if (ascii_strncasecmp ("FLAGS", pc, 5) == 0) {
 596       /* don't override PERMANENTFLAGS */
 597       if (!idata->flags) {
 598         debug_print (2, ("Getting mailbox FLAGS\n"));
 599         if ((pc = imap_get_flags (&(idata->flags), pc)) == NULL)
 600           goto fail;
 601       }
 602     }
 603     /* PERMANENTFLAGS are massaged to look like FLAGS, then override FLAGS */
 604     else if (ascii_strncasecmp ("OK [PERMANENTFLAGS", pc, 18) == 0) {
 605       debug_print (2, ("Getting mailbox PERMANENTFLAGS\n"));
 606       /* safe to call on NULL */
 607       mutt_free_list (&(idata->flags));
 608       /* skip "OK [PERMANENT" so syntax is the same as FLAGS */
 609       pc += 13;
 610       if ((pc = imap_get_flags (&(idata->flags), pc)) == NULL)
 611         goto fail;
 612     }
 613 #ifdef USE_HCACHE
 614     /* save UIDVALIDITY for the header cache */
 615     else if (ascii_strncasecmp ("OK [UIDVALIDITY", pc, 14) == 0) {
 616       debug_print (2, ("Getting mailbox UIDVALIDITY\n"));
 617       pc += 3;
 618       pc = imap_next_word (pc);
 619
 620       sscanf (pc, "%lu", &(idata->uid_validity));
 621     }
 622 #endif
 623     else {
 624       pc = imap_next_word (pc);
 625       if (!ascii_strncasecmp ("EXISTS", pc, 6)) {
 626         count = idata->newMailCount;
 627         idata->newMailCount = 0;
 628       }
 629     }
 630   }
 631   while (rc == IMAP_CMD_CONTINUE);
 632
 633   if (rc == IMAP_CMD_NO) {
 634     char *s;
 635
 636     s = imap_next_word (idata->cmd.buf);        /* skip seq */
 637     s = imap_next_word (s);     /* Skip response */
 638     mutt_error ("%s", s);
 639     mutt_sleep (2);
 640     goto fail;
 641   }
 642
 643   if (rc != IMAP_CMD_OK)
 644     goto fail;
 645
 646   /* check for READ-ONLY notification */
 647   if (!ascii_strncasecmp
 648       (imap_get_qualifier (idata->cmd.buf), "[READ-ONLY]", 11)
 649       && !mutt_bit_isset (idata->capabilities, ACL)) {
 650     debug_print (2, ("Mailbox is read-only.\n"));
 651     ctx->readonly = 1;
 652   }
 653
 654 #ifdef DEBUG
 655   /* dump the mailbox flags we've found */
 656   if (DebugLevel > 2) {
 657     if (!idata->flags)
 658       debug_print (3, ("No folder flags found\n"));
 659     else {
 660       LIST *t = idata->flags;
 661
 662       debug_print (3, ("Mailbox flags:\n"));
 663
 664       t = t->next;
 665       while (t) {
 666         debug_print (3, ("[%s]\n", t->data));
 667         t = t->next;
 668       }
 669     }
 670   }
 671 #endif
 672
 673   if (mutt_bit_isset (idata->capabilities, ACL)) {
 674     if (imap_check_acl (idata))
 675       goto fail;
 676     if (!(mutt_bit_isset (idata->rights, ACL_DELETE) ||
 677           mutt_bit_isset (idata->rights, ACL_SEEN) ||
 678           mutt_bit_isset (idata->rights, ACL_WRITE) ||
 679           mutt_bit_isset (idata->rights, ACL_INSERT)))
 680       ctx->readonly = 1;
 681   }
 682   /* assume we have all rights if ACL is unavailable */
 683   else {
 684     mutt_bit_set (idata->rights, ACL_LOOKUP);
 685     mutt_bit_set (idata->rights, ACL_READ);
 686     mutt_bit_set (idata->rights, ACL_SEEN);
 687     mutt_bit_set (idata->rights, ACL_WRITE);
 688     mutt_bit_set (idata->rights, ACL_INSERT);
 689     mutt_bit_set (idata->rights, ACL_POST);
 690     mutt_bit_set (idata->rights, ACL_CREATE);
 691     mutt_bit_set (idata->rights, ACL_DELETE);
 692   }
 693
 694   ctx->hdrmax = count;
 695   ctx->hdrs = mem_calloc (count, sizeof (HEADER *));
 696   ctx->v2r = mem_calloc (count, sizeof (int));
 697   ctx->msgcount = 0;
 698   if (count && (imap_read_headers (idata, 0, count - 1) < 0)) {
 699     mutt_error _("Error opening mailbox");
 700
 701     mutt_sleep (1);
 702     goto fail;
 703   }
 704
 705   debug_print (2, ("msgcount is %d\n", ctx->msgcount));
 706   mem_free (&mx.mbox);
 707   return 0;
 708
 709 fail:
 710   if (idata->state == IMAP_SELECTED)
 711     idata->state = IMAP_AUTHENTICATED;
 712 fail_noidata:
 713   mem_free (&mx.mbox);
 714   return -1;
 715 }
 716
 717 int imap_open_mailbox_append (CONTEXT * ctx)
 718 {
 719   CONNECTION *conn;
 720   IMAP_DATA *idata;
 721   char buf[LONG_STRING];
 722   char mailbox[LONG_STRING];
 723   IMAP_MBOX mx;
 724
 725   if (imap_parse_path (ctx->path, &mx))
 726     return -1;
 727
 728   /* in APPEND mode, we appear to hijack an existing IMAP connection -
 729    * ctx is brand new and mostly empty */
 730
 731   if (!(idata = imap_conn_find (&(mx.account), 0))) {
 732     mem_free(&mx.mbox);
 733     return (-1);
 734   }
 735   conn = idata->conn;
 736
 737   ctx->magic = M_IMAP;
 738   ctx->data = idata;
 739
 740   imap_fix_path (idata, mx.mbox, mailbox, sizeof (mailbox));
 741
 742   mem_free(&mx.mbox);
 743
 744   /* really we should also check for W_OK */
 745   if (!imap_access (ctx->path, F_OK))
 746     return 0;
 747
 748   snprintf (buf, sizeof (buf), _("Create %s?"), mailbox);
 749   if (option (OPTCONFIRMCREATE) && mutt_yesorno (buf, 1) < 1)
 750     return -1;
 751
 752   if (imap_create_mailbox (idata, mailbox) < 0)
 753     return -1;
 754
 755   return (0);
 756 }
 757
 758 /* imap_logout: Gracefully log out of server. */
 759 void imap_logout (IMAP_DATA * idata)
 760 {
 761   /* we set status here to let imap_handle_untagged know we _expect_ to
 762    * receive a bye response (so it doesn't freak out and close the conn) */
 763   idata->status = IMAP_BYE;
 764   imap_cmd_start (idata, "LOGOUT");
 765   while (imap_cmd_step (idata) == IMAP_CMD_CONTINUE);
 766   mem_free (&idata->cmd.buf);
 767   mem_free (&idata);
 768 }
 769
 770 /*
 771 int imap_close_connection (CONTEXT *ctx)
 772 {
 773   debug_print (1, (debugfile, "imap_close_connection(): closing connection\n"));
 774   if (CTX_DATA->status != IMAP_BYE)
 775   {
 776     mutt_message _("Closing connection to IMAP server...");
 777     imap_logout (CTX_DATA);
 778     mutt_clear_error ();
 779   }
 780   mutt_socket_close (CTX_DATA->conn);
 781   CTX_DATA->state = IMAP_DISCONNECTED;
 782   CTX_DATA->conn->data = NULL;
 783   return 0;
 784 }
 785 */
 786
 787 /* imap_set_flag: append str to flags if we currently have permission
 788  *   according to aclbit */
 789 static void imap_set_flag (IMAP_DATA * idata, int aclbit, int flag,
 790                            const char *str, char *flags, size_t flsize)
 791 {
 792   if (mutt_bit_isset (idata->rights, aclbit))
 793     if (flag)
 794       str_cat (flags, flsize, str);
 795 }
 796
 797 /* imap_make_msg_set: make an IMAP4rev1 UID message set out of a set of
 798  *   headers, given a flag enum to filter on.
 799  * Params: idata: IMAP_DATA containing context containing header set
 800  *         buf: to write message set into
 801  *         buflen: length of buffer
 802  *         flag: enum of flag type on which to filter
 803  *         changed: include only changed messages in message set
 804  * Returns: number of messages in message set (0 if no matches) */
 805 int imap_make_msg_set (IMAP_DATA * idata, BUFFER * buf, int flag, int changed)
 806 {
 807   HEADER **hdrs;                /* sorted local copy */
 808   int count = 0;                /* number of messages in message set */
 809   int match = 0;                /* whether current message matches flag condition */
 810   unsigned int setstart = 0;    /* start of current message range */
 811   int n;
 812   short oldsort;                /* we clobber reverse, must restore it */
 813
 814   /* assuming 32-bit UIDs */
 815   char uid[12];
 816   int started = 0;
 817
 818   /* make copy of header pointers to sort in natural order */
 819   hdrs = mem_calloc (idata->ctx->msgcount, sizeof (HEADER *));
 820   memcpy (hdrs, idata->ctx->hdrs, idata->ctx->msgcount * sizeof (HEADER *));
 821
 822   if (Sort != SORT_ORDER) {
 823     oldsort = Sort;
 824     Sort = SORT_ORDER;
 825     qsort ((void *) hdrs, idata->ctx->msgcount, sizeof (HEADER *),
 826            mutt_get_sort_func (SORT_ORDER));
 827     Sort = oldsort;
 828   }
 829
 830   for (n = 0; n < idata->ctx->msgcount; n++) {
 831     match = 0;
 832     /* don't include pending expunged messages */
 833     if (hdrs[n]->active)
 834       switch (flag) {
 835       case M_DELETE:
 836         if (hdrs[n]->deleted)
 837           match = 1;
 838         break;
 839       case M_TAG:
 840         if (hdrs[n]->tagged)
 841           match = 1;
 842         break;
 843       }
 844
 845     if (match && (!changed || hdrs[n]->changed)) {
 846       count++;
 847       if (setstart == 0) {
 848         setstart = HEADER_DATA (hdrs[n])->uid;
 849         if (started == 0) {
 850           snprintf (uid, sizeof (uid), "%u", HEADER_DATA (hdrs[n])->uid);
 851           mutt_buffer_addstr (buf, uid);
 852           started = 1;
 853         }
 854         else {
 855           snprintf (uid, sizeof (uid), ",%u", HEADER_DATA (hdrs[n])->uid);
 856           mutt_buffer_addstr (buf, uid);
 857         }
 858       }
 859       /* tie up if the last message also matches */
 860       else if (n == idata->ctx->msgcount - 1) {
 861         snprintf (uid, sizeof (uid), ":%u", HEADER_DATA (hdrs[n])->uid);
 862         mutt_buffer_addstr (buf, uid);
 863       }
 864     }
 865     /* this message is not expunged and doesn't match. End current set. */
 866     else if (setstart && hdrs[n]->active) {
 867       if (HEADER_DATA (hdrs[n - 1])->uid > setstart) {
 868         snprintf (uid, sizeof (uid), ":%u", HEADER_DATA (hdrs[n - 1])->uid);
 869         mutt_buffer_addstr (buf, uid);
 870       }
 871       setstart = 0;
 872     }
 873   }
 874
 875   mem_free (&hdrs);
 876
 877   return count;
 878 }
 879
 880 /* Update the IMAP server to reflect the flags a single message.  */
 881
 882 int imap_sync_message (IMAP_DATA *idata, HEADER *hdr, BUFFER *cmd,
 883                        int *err_continue)
 884 {
 885   char flags[LONG_STRING];
 886   char uid[11];
 887
 888   hdr->changed = 0;
 889
 890   snprintf (uid, sizeof (uid), "%u", HEADER_DATA(hdr)->uid);
 891   cmd->dptr = cmd->data;
 892   mutt_buffer_addstr (cmd, "UID STORE ");
 893   mutt_buffer_addstr (cmd, uid);
 894
 895   flags[0] = '\0';
 896
 897   imap_set_flag (idata, ACL_SEEN, hdr->read, "\\Seen ",
 898                  flags, sizeof (flags));
 899   imap_set_flag (idata, ACL_WRITE, hdr->flagged,
 900                  "\\Flagged ", flags, sizeof (flags));
 901   imap_set_flag (idata, ACL_WRITE, hdr->replied,
 902                  "\\Answered ", flags, sizeof (flags));
 903   imap_set_flag (idata, ACL_DELETE, hdr->deleted,
 904                  "\\Deleted ", flags, sizeof (flags));
 905
 906   /* now make sure we don't lose custom tags */
 907   if (mutt_bit_isset (idata->rights, ACL_WRITE))
 908     imap_add_keywords (flags, hdr, idata->flags, sizeof (flags));
 909
 910   str_skip_trailws (flags);
 911
 912   /* UW-IMAP is OK with null flags, Cyrus isn't. The only solution is to
 913    * explicitly revoke all system flags (if we have permission) */
 914   if (!*flags)
 915   {
 916     imap_set_flag (idata, ACL_SEEN, 1, "\\Seen ", flags, sizeof (flags));
 917     imap_set_flag (idata, ACL_WRITE, 1, "\\Flagged ", flags, sizeof (flags));
 918     imap_set_flag (idata, ACL_WRITE, 1, "\\Answered ", flags, sizeof (flags));
 919     imap_set_flag (idata, ACL_DELETE, 1, "\\Deleted ", flags, sizeof (flags));
 920
 921     str_skip_trailws (flags);
 922
 923     mutt_buffer_addstr (cmd, " -FLAGS.SILENT (");
 924   } else
 925     mutt_buffer_addstr (cmd, " FLAGS.SILENT (");
 926
 927   mutt_buffer_addstr (cmd, flags);
 928   mutt_buffer_addstr (cmd, ")");
 929
 930   /* dumb hack for bad UW-IMAP 4.7 servers spurious FLAGS updates */
 931   hdr->active = 0;
 932
 933   /* after all this it's still possible to have no flags, if you
 934    * have no ACL rights */
 935   if (*flags && (imap_exec (idata, cmd->data, 0) != 0) &&
 936       err_continue && (*err_continue != M_YES))
 937   {
 938     *err_continue = imap_continue ("imap_sync_message: STORE failed",
 939                                    idata->cmd.buf);
 940     if (*err_continue != M_YES)
 941       return -1;
 942   }
 943
 944   hdr->active = 1;
 945   idata->ctx->changed--;
 946
 947   return 0;
 948 }
 949
 950 /* update the IMAP server to reflect message changes done within mutt.
 951  * Arguments
 952  *   ctx: the current context
 953  *   expunge: 0 or 1 - do expunge?
 954  */
 955
 956 int imap_sync_mailbox (CONTEXT * ctx, int expunge, int *index_hint)
 957 {
 958   IMAP_DATA *idata;
 959   CONTEXT *appendctx = NULL;
 960   BUFFER cmd;
 961   int deleted;
 962   int n;
 963   int err_continue = M_NO;      /* continue on error? */
 964   int rc;
 965
 966   idata = (IMAP_DATA *) ctx->data;
 967
 968   if (idata->state != IMAP_SELECTED) {
 969     debug_print (2, ("no mailbox selected\n"));
 970     return -1;
 971   }
 972
 973   /* This function is only called when the calling code expects the context
 974    * to be changed. */
 975   imap_allow_reopen (ctx);
 976
 977   if ((rc = imap_check_mailbox (ctx, index_hint, 0)) != 0)
 978     return rc;
 979
 980   memset (&cmd, 0, sizeof (cmd));
 981
 982   /* if we are expunging anyway, we can do deleted messages very quickly... */
 983   if (expunge && mutt_bit_isset (idata->rights, ACL_DELETE)) {
 984     mutt_buffer_addstr (&cmd, "UID STORE ");
 985     deleted = imap_make_msg_set (idata, &cmd, M_DELETE, 1);
 986
 987     /* if we have a message set, then let's delete */
 988     if (deleted) {
 989       mutt_message (_("Marking %d messages deleted..."), deleted);
 990       mutt_buffer_addstr (&cmd, " +FLAGS.SILENT (\\Deleted)");
 991       /* mark these messages as unchanged so second pass ignores them. Done
 992        * here so BOGUS UW-IMAP 4.7 SILENT FLAGS updates are ignored. */
 993       for (n = 0; n < ctx->msgcount; n++)
 994         if (ctx->hdrs[n]->deleted && ctx->hdrs[n]->changed)
 995           ctx->hdrs[n]->active = 0;
 996       if (imap_exec (idata, cmd.data, 0) != 0) {
 997         mutt_error (_("Expunge failed"));
 998         mutt_sleep (1);
 999         rc = -1;
1000         goto out;
1001       }
1002     }
1003   }
1004
1005   /* save status changes */
1006   for (n = 0; n < ctx->msgcount; n++) {
1007     if (ctx->hdrs[n]->active && ctx->hdrs[n]->changed) {
1008
1009       mutt_message (_("Saving message status flags... [%d/%d]"), n + 1,
1010                     ctx->msgcount);
1011
1012       /* if the message has been rethreaded or attachments have been deleted
1013        * we delete the message and reupload it.
1014        * This works better if we're expunging, of course. */
1015       if ((ctx->hdrs[n]->env && (ctx->hdrs[n]->env->refs_changed || ctx->hdrs[n]->env->irt_changed)) ||
1016           ctx->hdrs[n]->attach_del) {
1017         debug_print (3, ("Attachments to be deleted, falling back to _mutt_save_message\n"));
1018         if (!appendctx)
1019           appendctx = mx_open_mailbox (ctx->path, M_APPEND | M_QUIET, NULL);
1020         if (!appendctx) {
1021           debug_print (1, ("Error opening mailbox in append mode\n"));
1022         }
1023         else
1024           _mutt_save_message (ctx->hdrs[n], appendctx, 1, 0, 0);
1025       }
1026
1027       if (imap_sync_message (idata, ctx->hdrs[n], &cmd, &err_continue) < 0) {
1028         rc = -1;
1029         goto out;
1030       }
1031     }
1032   }
1033   ctx->changed = 0;
1034
1035   /* We must send an EXPUNGE command if we're not closing. */
1036   if (expunge && !(ctx->closing) &&
1037       mutt_bit_isset (idata->rights, ACL_DELETE)) {
1038     mutt_message _("Expunging messages from server...");
1039
1040     /* Set expunge bit so we don't get spurious reopened messages */
1041     idata->reopen |= IMAP_EXPUNGE_EXPECTED;
1042     if (imap_exec (idata, "EXPUNGE", 0) != 0) {
1043       imap_error (_("imap_sync_mailbox: EXPUNGE failed"), idata->cmd.buf);
1044       rc = imap_reconnect (ctx);
1045       goto out;
1046     }
1047   }
1048
1049   if (expunge && ctx->closing) {
1050     if (imap_exec (idata, "CLOSE", 0))
1051       mutt_error (_("CLOSE failed"));
1052     idata->state = IMAP_AUTHENTICATED;
1053   }
1054
1055   rc = 0;
1056 out:
1057   if (cmd.data)
1058     mem_free (&cmd.data);
1059   if (appendctx) {
1060     mx_fastclose_mailbox (appendctx);
1061     mem_free (&appendctx);
1062   }
1063   return rc;
1064 }
1065
1066 /* imap_close_mailbox: clean up IMAP data in CONTEXT */
1067 void imap_close_mailbox (CONTEXT * ctx)
1068 {
1069   IMAP_DATA *idata;
1070   int i;
1071
1072   idata = (IMAP_DATA *) ctx->data;
1073   /* Check to see if the mailbox is actually open */
1074   if (!idata)
1075     return;
1076
1077   if (ctx == idata->ctx) {
1078     if (idata->state != IMAP_FATAL && idata->state == IMAP_SELECTED) {
1079       /* mx_close_mailbox won't sync if there are no deleted messages
1080       * and the mailbox is unchanged, so we may have to close here */
1081       if (!ctx->deleted && imap_exec (idata, "CLOSE", 0))
1082         mutt_error (_("CLOSE failed"));
1083       idata->state = IMAP_AUTHENTICATED;
1084     }
1085
1086     idata->reopen &= IMAP_REOPEN_ALLOW;
1087     mem_free (&(idata->mailbox));
1088     mutt_free_list (&idata->flags);
1089     idata->ctx = NULL;
1090   }
1091
1092   /* free IMAP part of headers */
1093   for (i = 0; i < ctx->msgcount; i++)
1094     imap_free_header_data (&(ctx->hdrs[i]->data));
1095
1096   for (i = 0; i < IMAP_CACHE_LEN; i++) {
1097     if (idata->cache[i].path) {
1098       unlink (idata->cache[i].path);
1099       mem_free (&idata->cache[i].path);
1100     }
1101   }
1102 }
1103
1104 /* use the NOOP command to poll for new mail
1105  *
1106  * return values:
1107  *      M_REOPENED      mailbox has been externally modified
1108  *      M_NEW_MAIL      new mail has arrived!
1109  *      0               no change
1110  *      -1              error
1111  */
1112 int imap_check_mailbox (CONTEXT * ctx, int *index_hint, int force)
1113 {
1114   /* overload keyboard timeout to avoid many mailbox checks in a row.
1115    * Most users don't like having to wait exactly when they press a key. */
1116   IMAP_DATA *idata;
1117   int result = 0;
1118
1119   idata = (IMAP_DATA *) ctx->data;
1120
1121   if ((force || time (NULL) >= idata->lastread + Timeout)
1122       && imap_exec (idata, "NOOP", 0) != 0)
1123     return -1;
1124
1125   /* We call this even when we haven't run NOOP in case we have pending
1126    * changes to process, since we can reopen here. */
1127   imap_cmd_finish (idata);
1128
1129   if (idata->check_status & IMAP_EXPUNGE_PENDING)
1130     result = M_REOPENED;
1131   else if (idata->check_status & IMAP_NEWMAIL_PENDING)
1132     result = M_NEW_MAIL;
1133   else if (idata->check_status & IMAP_FLAGS_PENDING)
1134     result = M_FLAGS;
1135
1136   idata->check_status = 0;
1137
1138   return result;
1139 }
1140
1141 /* returns count of recent messages if new = 1, else count of total messages.
1142  * (useful for at least postponed function)
1143  * Question of taste: use RECENT or UNSEEN for new?
1144  *   0+   number of messages in mailbox
1145  *  -1    error while polling mailboxes
1146  */
1147 int imap_mailbox_check (char *path, int new)
1148 {
1149   CONNECTION *conn;
1150   IMAP_DATA *idata;
1151   char buf[LONG_STRING];
1152   char mbox[LONG_STRING];
1153   char mbox_unquoted[LONG_STRING];
1154   char *s;
1155   int msgcount = 0;
1156   int connflags = 0;
1157   IMAP_MBOX mx;
1158   int rc;
1159
1160   if (imap_parse_path (path, &mx))
1161     return -1;
1162
1163   /* If imap_passive is set, don't open a connection to check for new mail */
1164   if (option (OPTIMAPPASSIVE))
1165     connflags = M_IMAP_CONN_NONEW;
1166
1167   if (!(idata = imap_conn_find (&(mx.account), connflags))) {
1168     mem_free (&mx.mbox);
1169     return -1;
1170   }
1171   conn = idata->conn;
1172
1173   imap_fix_path (idata, mx.mbox, buf, sizeof (buf));
1174   mem_free (&mx.mbox);
1175
1176   imap_munge_mbox_name (mbox, sizeof (mbox), buf);
1177   strfcpy (mbox_unquoted, buf, sizeof (mbox_unquoted));
1178
1179   /* The draft IMAP implementor's guide warns againts using the STATUS
1180    * command on a mailbox that you have selected
1181    */
1182
1183   if (str_cmp (mbox_unquoted, idata->mailbox) == 0
1184       || (ascii_strcasecmp (mbox_unquoted, "INBOX") == 0
1185           && str_casecmp (mbox_unquoted, idata->mailbox) == 0)) {
1186     strfcpy (buf, "NOOP", sizeof (buf));
1187   }
1188   else if (mutt_bit_isset (idata->capabilities, IMAP4REV1) ||
1189            mutt_bit_isset (idata->capabilities, STATUS)) {
1190     snprintf (buf, sizeof (buf), "STATUS %s (%s)", mbox,
1191               new ? "RECENT" : "MESSAGES");
1192   }
1193   else
1194     /* Server does not support STATUS, and this is not the current mailbox.
1195      * There is no lightweight way to check recent arrivals */
1196     return -1;
1197
1198   imap_cmd_start (idata, buf);
1199
1200   do {
1201     if ((rc = imap_cmd_step (idata)) != IMAP_CMD_CONTINUE)
1202       break;
1203
1204     s = imap_next_word (idata->cmd.buf);
1205     if (ascii_strncasecmp ("STATUS", s, 6) == 0) {
1206       s = imap_next_word (s);
1207       /* The mailbox name may or may not be quoted here. We could try to
1208        * munge the server response and compare with quoted (or vise versa)
1209        * but it is probably more efficient to just strncmp against both. */
1210       if (str_ncmp (mbox_unquoted, s, str_len (mbox_unquoted)) == 0
1211           || str_ncmp (mbox, s, str_len (mbox)) == 0) {
1212         s = imap_next_word (s);
1213         s = imap_next_word (s);
1214         if (isdigit ((unsigned char) *s)) {
1215           if (*s != '0') {
1216             msgcount = atoi (s);
1217             debug_print (2, ("%d new messages in %s\n", msgcount, path));
1218           }
1219         }
1220       }
1221       else
1222         debug_print (1, ("STATUS response doesn't match requested mailbox.\n"));
1223     }
1224   }
1225   while (rc == IMAP_CMD_CONTINUE);
1226
1227   return msgcount;
1228 }
1229
1230 /* returns number of patterns in the search that should be done server-side
1231  * (eg are full-text) */
1232 static int do_search (const pattern_t* search, int allpats)
1233 {
1234   int rc = 0;
1235   const pattern_t* pat;
1236
1237   for (pat = search; pat; pat = pat->next) {
1238     switch (pat->op) {
1239       case M_BODY:
1240       case M_HEADER:
1241       case M_WHOLE_MSG:
1242         if (pat->stringmatch)
1243           rc++;
1244         break;
1245       default:
1246       if (pat->child && do_search (pat->child, 1))
1247         rc++;
1248     }
1249
1250     if (!allpats)
1251       break;
1252   }
1253
1254   return rc;
1255 }
1256
1257 /* convert mutt pattern_t to IMAP SEARCH command containing only elements
1258 * that require full-text search (mutt already has what it needs for most
1259 * match types, and does a better job (eg server doesn't support regexps). */
1260 static int imap_compile_search (const pattern_t* pat, BUFFER* buf)
1261 {
1262   char term[STRING];
1263
1264   if (! do_search (pat, 0))
1265     return 0;
1266
1267   if (pat->not)
1268     mutt_buffer_addstr (buf, "NOT ");
1269
1270   if (pat->child) {
1271     int clauses;
1272
1273     if ((clauses = do_search (pat->child, 1)) > 0) {
1274       const pattern_t* clause = pat->child;
1275
1276       mutt_buffer_addch (buf, '(');
1277
1278       while (clauses) {
1279         if (do_search (clause, 0)) {
1280           if (pat->op == M_OR && clauses > 1)
1281             mutt_buffer_addstr (buf, "OR ");
1282           clauses--;
1283           if (imap_compile_search (clause, buf) < 0)
1284             return -1;
1285
1286           if (clauses)
1287             mutt_buffer_addch (buf, ' ');
1288
1289           clause = clause->next;
1290         }
1291       }
1292
1293       mutt_buffer_addch (buf, ')');
1294     }
1295   } else {
1296     char *delim;
1297
1298     switch (pat->op) {
1299       case M_HEADER:
1300         mutt_buffer_addstr (buf, "HEADER ");
1301
1302         /* extract header name */
1303         if (! (delim = strchr (pat->str, ':'))) {
1304           mutt_error (_("Header search without header name: %s"), pat->str);
1305           return -1;
1306         }
1307         *delim = '\0';
1308         imap_quote_string (term, sizeof (term), pat->str);
1309         mutt_buffer_addstr (buf, term);
1310         mutt_buffer_addch (buf, ' ');
1311
1312         /* and field */
1313         *delim = ':';
1314         delim++;
1315         SKIPWS(delim);
1316         imap_quote_string (term, sizeof (term), delim);
1317         mutt_buffer_addstr (buf, term);
1318         break;
1319
1320       case M_BODY:
1321         mutt_buffer_addstr (buf, "BODY ");
1322         imap_quote_string (term, sizeof (term), pat->str);
1323         mutt_buffer_addstr (buf, term);
1324         break;
1325
1326       case M_WHOLE_MSG:
1327         mutt_buffer_addstr (buf, "TEXT ");
1328         imap_quote_string (term, sizeof (term), pat->str);
1329         mutt_buffer_addstr (buf, term);
1330       break;
1331     }
1332   }
1333
1334   return 0;
1335 }
1336
1337 int imap_search (CONTEXT* ctx, const pattern_t* pat) {
1338   BUFFER buf;
1339   IMAP_DATA* idata = (IMAP_DATA*)ctx->data;
1340   int i;
1341
1342   for (i = 0; i < ctx->msgcount; i++)
1343     ctx->hdrs[i]->matched = 0;
1344
1345   if (!do_search (pat, 1))
1346     return 0;
1347
1348   memset (&buf, 0, sizeof (buf));
1349   mutt_buffer_addstr (&buf, "UID SEARCH ");
1350   if (imap_compile_search (pat, &buf) < 0) {
1351     mem_free (&buf.data);
1352     return -1;
1353   }
1354   if (imap_exec (idata, buf.data, 0) < 0) {
1355     mem_free (&buf.data);
1356     return -1;
1357   }
1358
1359   mem_free (&buf.data);
1360   return 0;
1361 }
1362
1363 /* all this listing/browsing is a mess. I don't like that name is a pointer
1364  *   into idata->buf (used to be a pointer into the passed in buffer, just
1365  *   as bad), nor do I like the fact that the fetch is done here. This
1366  *   code can't possibly handle non-LIST untagged responses properly.
1367  *   FIXME. ?! */
1368 int imap_parse_list_response (IMAP_DATA * idata, char **name, int *noselect,
1369                               int *noinferiors, char *delim)
1370 {
1371   char *s;
1372   long bytes;
1373   int rc;
1374
1375   *name = NULL;
1376
1377   rc = imap_cmd_step (idata);
1378   if (rc == IMAP_CMD_OK)
1379     return 0;
1380   if (rc != IMAP_CMD_CONTINUE)
1381     return -1;
1382
1383   s = imap_next_word (idata->cmd.buf);
1384   if ((ascii_strncasecmp ("LIST", s, 4) == 0) ||
1385       (ascii_strncasecmp ("LSUB", s, 4) == 0)) {
1386     *noselect = 0;
1387     *noinferiors = 0;
1388
1389     s = imap_next_word (s);     /* flags */
1390     if (*s == '(') {
1391       char *ep;
1392
1393       s++;
1394       ep = s;
1395       while (*ep && *ep != ')')
1396         ep++;
1397       do {
1398         if (!ascii_strncasecmp (s, "\\NoSelect", 9))
1399           *noselect = 1;
1400         if (!ascii_strncasecmp (s, "\\NoInferiors", 12))
1401           *noinferiors = 1;
1402         /* See draft-gahrns-imap-child-mailbox-?? */
1403         if (!ascii_strncasecmp (s, "\\HasNoChildren", 14))
1404           *noinferiors = 1;
1405         if (*s != ')')
1406           s++;
1407         while (*s && *s != '\\' && *s != ')')
1408           s++;
1409       } while (s != ep);
1410     }
1411     else
1412       return 0;
1413     s = imap_next_word (s);     /* delim */
1414     /* Reset the delimiter, this can change */
1415     if (ascii_strncasecmp (s, "NIL", 3)) {
1416       if (s && s[0] == '\"' && s[1] && s[2] == '\"')
1417         *delim = s[1];
1418       else if (s && s[0] == '\"' && s[1] && s[1] == '\\' && s[2]
1419                && s[3] == '\"')
1420         *delim = s[2];
1421     }
1422     s = imap_next_word (s);     /* name */
1423     if (s && *s == '{') {       /* Literal */
1424       if (imap_get_literal_count (idata->cmd.buf, &bytes) < 0)
1425         return -1;
1426       if (imap_cmd_step (idata) != IMAP_CMD_CONTINUE)
1427         return -1;
1428       *name = idata->cmd.buf;
1429     }
1430     else
1431       *name = s;
1432   }
1433
1434   return 0;
1435 }
1436
1437 int imap_subscribe (char *path, int subscribe)
1438 {
1439   CONNECTION *conn;
1440   IMAP_DATA *idata;
1441   char buf[LONG_STRING];
1442   char mbox[LONG_STRING];
1443   char errstr[STRING];
1444   BUFFER err, token;
1445   IMAP_MBOX mx;
1446
1447   if (mx_get_magic (path) == M_IMAP || imap_parse_path (path, &mx)) {
1448     mutt_error (_("Bad mailbox name"));
1449     return -1;
1450   }
1451
1452   if (!(idata = imap_conn_find (&(mx.account), 0)))
1453     goto fail;
1454
1455   conn = idata->conn;
1456
1457   imap_fix_path (idata, mx.mbox, buf, sizeof (buf));
1458
1459   if (option (OPTIMAPCHECKSUBSCRIBED)) {
1460     memset (&token, 0, sizeof (token));
1461     err.data = errstr;
1462     err.dsize = sizeof (errstr);
1463     snprintf (mbox, sizeof (mbox), "%smailboxes \"%s\"",
1464               subscribe ? "" : "un", path);
1465     if (mutt_parse_rc_line (mbox, &token, &err))
1466       debug_print (1, ("Error adding subscribed mailbox: %s\n", errstr));
1467     mem_free (&token.data);
1468   }
1469
1470   if (subscribe)
1471     mutt_message (_("Subscribing to %s..."), buf);
1472   else
1473     mutt_message (_("Unsubscribing to %s..."), buf);
1474   imap_munge_mbox_name (mbox, sizeof (mbox), buf);
1475
1476   snprintf (buf, sizeof (buf), "%sSUBSCRIBE %s", subscribe ? "" : "UN", mbox);
1477
1478   if (imap_exec (idata, buf, 0) < 0)
1479     goto fail;
1480
1481   mem_free (&mx.mbox);
1482   return 0;
1483
1484 fail:
1485   mem_free (&mx.mbox);
1486   return -1;
1487 }
1488
1489 /* trim dest to the length of the longest prefix it shares with src,
1490  * returning the length of the trimmed string */
1491 static int longest_common_prefix (char *dest, const char* src,
1492                                   int start, size_t dlen) {
1493   int pos = start;
1494
1495   while (pos < dlen && dest[pos] && dest[pos] == src[pos])
1496     pos++;
1497   dest[pos] = '\0';
1498
1499   return pos;
1500 }
1501
1502 /* look for IMAP URLs to complete from defined mailboxes. Could be extended
1503  * to complete over open connections and account/folder hooks too. */
1504 static int imap_complete_hosts (char *dest, size_t len) {
1505   BUFFY* mailbox;
1506   CONNECTION* conn;
1507   int rc = -1;
1508   int matchlen;
1509   int i = 0;
1510
1511   matchlen = str_len (dest);
1512   if (list_empty (Incoming))
1513     return (-1);
1514   for (i = 0; i < Incoming->length; i++) {
1515     mailbox = (BUFFY*) Incoming->data[i];
1516     if (!str_ncmp (dest, mailbox->path, matchlen)) {
1517       if (rc) {
1518         strfcpy (dest, mailbox->path, len);
1519         rc = 0;
1520       } else
1521         longest_common_prefix (dest, mailbox->path, matchlen, len);
1522     }
1523   }
1524
1525   for (conn = mutt_socket_head (); conn->next; conn = conn->next) {
1526     ciss_url_t url;
1527     char urlstr[LONG_STRING];
1528
1529     if (conn->account.type != M_ACCT_TYPE_IMAP)
1530       continue;
1531
1532     mutt_account_tourl (&conn->account, &url);
1533     /* FIXME: how to handle multiple users on the same host? */
1534     url.user = NULL;
1535     url.path = NULL;
1536     url_ciss_tostring (&url, urlstr, sizeof (urlstr), 0);
1537     if (!str_ncmp (dest, urlstr, matchlen)) {
1538       if (rc) {
1539         strfcpy (dest, urlstr, len);
1540         rc = 0;
1541       } else
1542         longest_common_prefix (dest, urlstr, matchlen, len);
1543     }
1544   }
1545
1546   return rc;
1547 }
1548
1549 /* imap_complete: given a partial IMAP folder path, return a string which
1550  *   adds as much to the path as is unique */
1551 int imap_complete (char *dest, size_t dlen, char *path) {
1552   CONNECTION *conn;
1553   IMAP_DATA *idata;
1554   char list[LONG_STRING];
1555   char buf[LONG_STRING];
1556   char *list_word = NULL;
1557   int noselect, noinferiors;
1558   char delim;
1559   char completion[LONG_STRING];
1560   int clen, matchlen = 0;
1561   int completions = 0;
1562   IMAP_MBOX mx;
1563
1564   if (imap_parse_path (path, &mx) || !mx.mbox) {
1565     strfcpy (dest, path, dlen);
1566     return imap_complete_hosts (dest, dlen);
1567   }
1568
1569   /* don't open a new socket just for completion. Instead complete over
1570    * known mailboxes/hooks/etc */
1571   if (!(idata = imap_conn_find (&(mx.account), M_IMAP_CONN_NONEW))) {
1572     mem_free (&mx.mbox);
1573     strfcpy (dest, path, dlen);
1574     return imap_complete_hosts (dest, dlen);
1575   }
1576   conn = idata->conn;
1577
1578   /* reformat path for IMAP list, and append wildcard */
1579   /* don't use INBOX in place of "" */
1580   if (mx.mbox && mx.mbox[0])
1581     imap_fix_path (idata, mx.mbox, list, sizeof (list));
1582   else
1583     list[0] = '\0';
1584
1585   /* fire off command */
1586   snprintf (buf, sizeof (buf), "%s \"\" \"%s%%\"",
1587             option (OPTIMAPLSUB) ? "LSUB" : "LIST", list);
1588
1589   imap_cmd_start (idata, buf);
1590
1591   /* and see what the results are */
1592   strfcpy (completion, NONULL (mx.mbox), sizeof (completion));
1593   do {
1594     if (imap_parse_list_response (idata, &list_word, &noselect, &noinferiors,
1595                                   &delim))
1596       break;
1597
1598     if (list_word) {
1599       /* store unquoted */
1600       imap_unmunge_mbox_name (list_word);
1601
1602       /* if the folder isn't selectable, append delimiter to force browse
1603        * to enter it on second tab. */
1604       if (noselect) {
1605         clen = str_len (list_word);
1606         list_word[clen++] = delim;
1607         list_word[clen] = '\0';
1608       }
1609       /* copy in first word */
1610       if (!completions) {
1611         strfcpy (completion, list_word, sizeof (completion));
1612         matchlen = str_len (completion);
1613         completions++;
1614         continue;
1615       }
1616
1617       matchlen = longest_common_prefix (completion, list_word, 0, matchlen);
1618       completions++;
1619     }
1620   }
1621   while (ascii_strncmp (idata->cmd.seq, idata->cmd.buf, SEQLEN));
1622
1623   if (completions) {
1624     /* reformat output */
1625     imap_qualify_path (dest, dlen, &mx, completion);
1626     mutt_pretty_mailbox (dest);
1627
1628     mem_free (&mx.mbox);
1629     return 0;
1630   }
1631
1632   return -1;
1633 }
1634
1635 /* reconnect if connection was lost */
1636 int imap_reconnect (CONTEXT * ctx)
1637 {
1638   IMAP_DATA *imap_data;
1639
1640   if (!ctx)
1641     return (-1);
1642
1643   imap_data = (IMAP_DATA *) ctx->data;
1644
1645   if (imap_data) {
1646     if (imap_data->status == IMAP_CONNECTED)
1647       return -1;
1648   }
1649
1650   if (query_quadoption
1651       (OPT_IMAPRECONNECT,
1652        _("Connection lost. Reconnect to IMAP server?")) != M_YES)
1653     return -1;
1654
1655   mx_open_mailbox (ctx->path, 0, ctx);
1656   return 0;
1657 }