imap/message.c

   1 /*
   2  * Copyright notice from original mutt:
   3  * Copyright (C) 1996-9 Brandon Long <blong@fiction.net>
   4  * Copyright (C) 1999-2002 Brendan Cully <brendan@kublai.com>
   5  *
   6  * This file is part of mutt-ng, see http://www.muttng.org/.
   7  * It's licensed under the GNU General Public License,
   8  * please see the file GPL in the top level source directory.
   9  */
  10
  11 /* message parsing/updating functions */
  12
  13 #if HAVE_CONFIG_H
  14 # include "config.h"
  15 #endif
  16
  17 #include <stdlib.h>
  18 #include <ctype.h>
  19
  20 #include "mutt.h"
  21 #include "ascii.h"
  22 #include "buffer.h"
  23 #include "mutt_curses.h"
  24 #include "imap_private.h"
  25 #include "message.h"
  26 #include "mx.h"
  27 #include "hcache.h"
  28
  29 #ifdef HAVE_PGP
  30 #include "pgp.h"
  31 #endif
  32
  33 #include "lib/mem.h"
  34 #include "lib/intl.h"
  35 #include "lib/str.h"
  36 #include "lib/debug.h"
  37
  38 #if HAVE_STDINT_H
  39 #include <stdint.h>
  40 #elif HAVE_INTTYPES_H
  41 #include <inttypes.h>
  42 #endif
  43
  44 static void flush_buffer (char *buf, size_t * len, CONNECTION * conn);
  45 static int msg_fetch_header (CONTEXT * ctx, IMAP_HEADER * h, char *buf,
  46                              FILE * fp);
  47 static int msg_has_flag (LIST * flag_list, const char *flag);
  48 static int msg_parse_fetch (IMAP_HEADER * h, char *s);
  49 static char *msg_parse_flags (IMAP_HEADER * h, char *s);
  50
  51 #if USE_HCACHE
  52 static int msg_fetch_header_fetch (CONTEXT * ctx, IMAP_HEADER * h, char *buf,
  53                                    FILE * fp);
  54 static size_t imap_hcache_keylen (const char *fn);
  55 #endif /* USE_HCACHE */
  56
  57 /* imap_read_headers:
  58  * Changed to read many headers instead of just one. It will return the
  59  * msgno of the last message read. It will return a value other than
  60  * msgend if mail comes in while downloading headers (in theory).
  61  */
  62 int imap_read_headers (IMAP_DATA * idata, int msgbegin, int msgend)
  63 {
  64   CONTEXT *ctx;
  65   char buf[LONG_STRING];
  66   char hdrreq[STRING];
  67   FILE *fp;
  68   char tempfile[_POSIX_PATH_MAX];
  69   int msgno;
  70   IMAP_HEADER h;
  71   int rc, mfhrc, oldmsgcount;
  72   int fetchlast = 0;
  73   const char *want_headers =
  74     "DATE FROM SUBJECT TO CC MESSAGE-ID REFERENCES CONTENT-TYPE CONTENT-DESCRIPTION IN-REPLY-TO REPLY-TO LINES LIST-POST X-LABEL";
  75
  76 #if USE_HCACHE
  77   void *hc = NULL;
  78   unsigned long *uid_validity = NULL;
  79   char uid_buf[64];
  80 #endif /* USE_HCACHE */
  81
  82   ctx = idata->ctx;
  83
  84   if (mutt_bit_isset (idata->capabilities, IMAP4REV1)) {
  85     snprintf (hdrreq, sizeof (hdrreq), "BODY.PEEK[HEADER.FIELDS (%s%s%s)]",
  86               want_headers, ImapHeaders ? " " : "",
  87               ImapHeaders ? ImapHeaders : "");
  88   }
  89   else if (mutt_bit_isset (idata->capabilities, IMAP4)) {
  90     snprintf (hdrreq, sizeof (hdrreq), "RFC822.HEADER.LINES (%s%s%s)",
  91               want_headers, ImapHeaders ? " " : "",
  92               ImapHeaders ? ImapHeaders : "");
  93   }
  94   else {                        /* Unable to fetch headers for lower versions */
  95     mutt_error _("Unable to fetch headers from this IMAP server version.");
  96
  97     mutt_sleep (2);             /* pause a moment to let the user see the error */
  98     return -1;
  99   }
 100
 101   /* instead of downloading all headers and then parsing them, we parse them
 102    * as they come in. */
 103   mutt_mktemp (tempfile);
 104   if (!(fp = safe_fopen (tempfile, "w+"))) {
 105     mutt_error (_("Could not create temporary file %s"), tempfile);
 106     mutt_sleep (2);
 107     return -1;
 108   }
 109   unlink (tempfile);
 110
 111   /* make sure context has room to hold the mailbox */
 112   while ((msgend) >= idata->ctx->hdrmax)
 113     mx_alloc_memory (idata->ctx);
 114
 115   oldmsgcount = ctx->msgcount;
 116   idata->reopen &= ~IMAP_NEWMAIL_PENDING;
 117   idata->newMailCount = 0;
 118
 119 #if USE_HCACHE
 120   hc = mutt_hcache_open (HeaderCache, ctx->path);
 121
 122   snprintf (buf, sizeof (buf),
 123             "FETCH %d:%d (UID FLAGS)", msgbegin + 1, msgend + 1);
 124   fetchlast = msgend + 1;
 125
 126   imap_cmd_start (idata, buf);
 127
 128   for (msgno = msgbegin; msgno <= msgend; msgno++) {
 129     if (ReadInc && (!msgno || ((msgno + 1) % ReadInc == 0)))
 130       mutt_message (_("Evaluating cache... [%d/%d]"), msgno + 1, msgend + 1);
 131
 132     rewind (fp);
 133     memset (&h, 0, sizeof (h));
 134     h.data = mem_calloc (1, sizeof (IMAP_HEADER_DATA));
 135     do {
 136       mfhrc = 0;
 137
 138       rc = imap_cmd_step (idata);
 139       if (rc != IMAP_CMD_CONTINUE)
 140         break;
 141
 142       if ((mfhrc =
 143            msg_fetch_header_fetch (idata->ctx, &h, idata->cmd.buf, fp)) == -1)
 144         continue;
 145       else if (mfhrc < 0)
 146         break;
 147
 148       /* make sure we don't get remnants from older larger message headers */
 149       fputs ("\n\n", fp);
 150
 151       sprintf (uid_buf, "/%u", h.data->uid);    /* XXX --tg 21:41 04-07-11 */
 152       uid_validity =
 153         (unsigned long *) mutt_hcache_fetch (hc, uid_buf, &imap_hcache_keylen);
 154
 155       if (uid_validity != NULL && *uid_validity == idata->uid_validity) {
 156         ctx->hdrs[msgno] = mutt_hcache_restore((unsigned char *) uid_validity, 0);
 157         ctx->hdrs[msgno]->index = h.sid - 1;
 158         if (h.sid != ctx->msgcount + 1)
 159           debug_print (1, ("imap_read_headers: msgcount and sequence ID are inconsistent!"));
 160         /* messages which have not been expunged are ACTIVE (borrowed from mh
 161          * folders) */
 162         ctx->hdrs[msgno]->active = 1;
 163         ctx->hdrs[msgno]->read = h.read;
 164         ctx->hdrs[msgno]->old = h.old;
 165         ctx->hdrs[msgno]->deleted = h.deleted;
 166         ctx->hdrs[msgno]->flagged = h.flagged;
 167         ctx->hdrs[msgno]->replied = h.replied;
 168         ctx->hdrs[msgno]->changed = h.changed;
 169         /*  ctx->hdrs[msgno]->received is restored from mutt_hcache_restore */
 170         ctx->hdrs[msgno]->data = (void *) (h.data);
 171
 172         ctx->msgcount++;
 173       }
 174
 175       rewind (fp);
 176
 177       mem_free (&uid_validity);
 178
 179     }
 180     while ((rc != IMAP_CMD_OK) && ((mfhrc == -1) ||
 181                                    ((msgno + 1) >= fetchlast)));
 182
 183     if ((mfhrc < -1) || ((rc != IMAP_CMD_CONTINUE) && (rc != IMAP_CMD_OK))) {
 184       imap_free_header_data ((void **) &h.data);
 185       fclose (fp);
 186       mutt_hcache_close (hc);
 187       return -1;
 188     }
 189   }
 190
 191   fetchlast = msgbegin;
 192 #endif /* USE_HCACHE */
 193
 194   for (msgno = msgbegin; msgno <= msgend; msgno++) {
 195     if (ReadInc && (!msgno || ((msgno + 1) % ReadInc == 0)))
 196       mutt_message (_("Fetching message headers... [%d/%d]"), msgno + 1,
 197                     msgend + 1);
 198
 199     if (ctx->hdrs[msgno])
 200       continue;
 201
 202     if (msgno + 1 > fetchlast) {
 203       fetchlast = msgno + 1;
 204       while ((fetchlast <= msgend) && (!ctx->hdrs[fetchlast]))
 205         fetchlast++;
 206
 207       /*
 208        * Make one request for everything. This makes fetching headers an
 209        * order of magnitude faster if you have a large mailbox.
 210        *
 211        * If we get more messages while doing this, we make another
 212        * request for all the new messages.
 213        */
 214       snprintf (buf, sizeof (buf),
 215                 "FETCH %d:%d (UID FLAGS INTERNALDATE RFC822.SIZE %s)",
 216                 msgno + 1, fetchlast, hdrreq);
 217
 218       imap_cmd_start (idata, buf);
 219     }
 220
 221     /* freshen fp, h */
 222     rewind (fp);
 223     memset (&h, 0, sizeof (h));
 224     h.data = mem_calloc (1, sizeof (IMAP_HEADER_DATA));
 225
 226     /* this DO loop does two things:
 227      * 1. handles untagged messages, so we can try again on the same msg
 228      * 2. fetches the tagged response at the end of the last message.
 229      */
 230     do {
 231       mfhrc = 0;
 232
 233       rc = imap_cmd_step (idata);
 234       if (rc != IMAP_CMD_CONTINUE)
 235         break;
 236
 237       if ((mfhrc =
 238            msg_fetch_header (idata->ctx, &h, idata->cmd.buf, fp)) == -1)
 239         continue;
 240       else if (mfhrc < 0)
 241         break;
 242
 243       /* make sure we don't get remnants from older larger message headers */
 244       fputs ("\n\n", fp);
 245
 246       /* update context with message header */
 247       ctx->hdrs[msgno] = mutt_new_header ();
 248
 249       ctx->hdrs[msgno]->index = h.sid - 1;
 250       if (h.sid != ctx->msgcount + 1)
 251         debug_print (1, ("msgcount and sequence ID are inconsistent!\n"));
 252       /* messages which have not been expunged are ACTIVE (borrowed from mh
 253        * folders) */
 254       ctx->hdrs[msgno]->active = 1;
 255       ctx->hdrs[msgno]->read = h.read;
 256       ctx->hdrs[msgno]->old = h.old;
 257       ctx->hdrs[msgno]->deleted = h.deleted;
 258       ctx->hdrs[msgno]->flagged = h.flagged;
 259       ctx->hdrs[msgno]->replied = h.replied;
 260       ctx->hdrs[msgno]->changed = h.changed;
 261       ctx->hdrs[msgno]->received = h.received;
 262       ctx->hdrs[msgno]->data = (void *) (h.data);
 263
 264       rewind (fp);
 265       /* NOTE: if Date: header is missing, mutt_read_rfc822_header depends
 266        *   on h.received being set */
 267       ctx->hdrs[msgno]->env = mutt_read_rfc822_header (fp, ctx->hdrs[msgno],
 268                                                        0, 0);
 269       /* content built as a side-effect of mutt_read_rfc822_header */
 270       ctx->hdrs[msgno]->content->length = h.content_length;
 271
 272 #if USE_HCACHE
 273       sprintf (uid_buf, "/%u", h.data->uid);
 274       mutt_hcache_store (hc, uid_buf, ctx->hdrs[msgno], idata->uid_validity,
 275                          &imap_hcache_keylen);
 276 #endif /* USE_HCACHE */
 277
 278       ctx->msgcount++;
 279     }
 280     while ((rc != IMAP_CMD_OK) && ((mfhrc == -1) ||
 281                                    ((msgno + 1) >= fetchlast)));
 282
 283     if ((mfhrc < -1) || ((rc != IMAP_CMD_CONTINUE) && (rc != IMAP_CMD_OK))) {
 284       imap_free_header_data ((void **) &h.data);
 285       fclose (fp);
 286 #if USE_HCACHE
 287       mutt_hcache_close (hc);
 288 #endif /* USE_HCACHE */
 289       return -1;
 290     }
 291
 292     /* in case we get new mail while fetching the headers */
 293     if (idata->reopen & IMAP_NEWMAIL_PENDING) {
 294       msgend = idata->newMailCount - 1;
 295       while ((msgend) >= ctx->hdrmax)
 296         mx_alloc_memory (ctx);
 297       idata->reopen &= ~IMAP_NEWMAIL_PENDING;
 298       idata->newMailCount = 0;
 299     }
 300   }
 301
 302 #if USE_HCACHE
 303   mutt_hcache_close (hc);
 304 #endif /* USE_HCACHE */
 305
 306   fclose (fp);
 307
 308   if (ctx->msgcount > oldmsgcount)
 309     mx_update_context (ctx, ctx->msgcount - oldmsgcount);
 310
 311   return msgend;
 312 }
 313
 314 int imap_fetch_message (MESSAGE * msg, CONTEXT * ctx, int msgno)
 315 {
 316   IMAP_DATA *idata;
 317   HEADER *h;
 318   ENVELOPE* newenv;
 319   char buf[LONG_STRING];
 320   char path[_POSIX_PATH_MAX];
 321   char *pc;
 322   long bytes;
 323   int uid;
 324   int cacheno;
 325   IMAP_CACHE *cache;
 326   int read;
 327   int rc;
 328
 329   /* Sam's weird courier server returns an OK response even when FETCH
 330    * fails. Thanks Sam. */
 331   short fetched = 0;
 332
 333   idata = (IMAP_DATA *) ctx->data;
 334   h = ctx->hdrs[msgno];
 335
 336   /* see if we already have the message in our cache */
 337   cacheno = HEADER_DATA (h)->uid % IMAP_CACHE_LEN;
 338   cache = &idata->cache[cacheno];
 339
 340   if (cache->path) {
 341     /* don't treat cache errors as fatal, just fall back. */
 342     if (cache->uid == HEADER_DATA(h)->uid && (msg->fp = fopen (cache->path, "r")))
 343       return 0;
 344     else {
 345       unlink (cache->path);
 346       mem_free (&cache->path);
 347     }
 348   }
 349
 350   if (!isendwin ())
 351     mutt_message _("Fetching message...");
 352
 353   cache->uid = HEADER_DATA (h)->uid;
 354   mutt_mktemp (path);
 355   cache->path = str_dup (path);
 356   if (!(msg->fp = safe_fopen (path, "w+"))) {
 357     mem_free (&cache->path);
 358     return -1;
 359   }
 360
 361   /* mark this header as currently inactive so the command handler won't
 362    * also try to update it. HACK until all this code can be moved into the
 363    * command handler */
 364   h->active = 0;
 365
 366   snprintf (buf, sizeof (buf), "UID FETCH %u %s", HEADER_DATA (h)->uid,
 367             (mutt_bit_isset (idata->capabilities, IMAP4REV1) ?
 368              (option (OPTIMAPPEEK) ? "BODY.PEEK[]" : "BODY[]") : "RFC822"));
 369
 370   imap_cmd_start (idata, buf);
 371   do {
 372     if ((rc = imap_cmd_step (idata)) != IMAP_CMD_CONTINUE)
 373       break;
 374
 375     pc = idata->cmd.buf;
 376     pc = imap_next_word (pc);
 377     pc = imap_next_word (pc);
 378
 379     if (!ascii_strncasecmp ("FETCH", pc, 5)) {
 380       while (*pc) {
 381         pc = imap_next_word (pc);
 382         if (pc[0] == '(')
 383           pc++;
 384         if (ascii_strncasecmp ("UID", pc, 3) == 0) {
 385           pc = imap_next_word (pc);
 386           uid = atoi (pc);
 387           if (uid != HEADER_DATA (h)->uid)
 388             mutt_error (_
 389                         ("The message index is incorrect. Try reopening the mailbox."));
 390         }
 391         else if ((ascii_strncasecmp ("RFC822", pc, 6) == 0) ||
 392                  (ascii_strncasecmp ("BODY[]", pc, 6) == 0)) {
 393           pc = imap_next_word (pc);
 394           if (imap_get_literal_count (pc, &bytes) < 0) {
 395             imap_error ("imap_fetch_message()", buf);
 396             goto bail;
 397           }
 398           if (imap_read_literal (msg->fp, idata, bytes) < 0)
 399             goto bail;
 400           /* pick up trailing line */
 401           if ((rc = imap_cmd_step (idata)) != IMAP_CMD_CONTINUE)
 402             goto bail;
 403           pc = idata->cmd.buf;
 404
 405           fetched = 1;
 406         }
 407         /* UW-IMAP will provide a FLAGS update here if the FETCH causes a
 408          * change (eg from \Unseen to \Seen).
 409          * Uncommitted changes in mutt take precedence. If we decide to
 410          * incrementally update flags later, this won't stop us syncing */
 411         else if ((ascii_strncasecmp ("FLAGS", pc, 5) == 0) && !h->changed) {
 412           if ((pc = imap_set_flags (idata, h, pc)) == NULL)
 413             goto bail;
 414         }
 415       }
 416     }
 417   }
 418   while (rc == IMAP_CMD_CONTINUE);
 419
 420   /* see comment before command start. */
 421   h->active = 1;
 422
 423   fflush (msg->fp);
 424   if (ferror (msg->fp)) {
 425     mutt_perror (cache->path);
 426     goto bail;
 427   }
 428
 429   if (rc != IMAP_CMD_OK)
 430     goto bail;
 431
 432   if (!fetched || !imap_code (idata->cmd.buf))
 433     goto bail;
 434
 435   /* Update the header information.  Previously, we only downloaded a
 436    * portion of the headers, those required for the main display.
 437    */
 438   rewind (msg->fp);
 439   /* It may be that the Status header indicates a message is read, but the
 440    * IMAP server doesn't know the message has been \Seen. So we capture
 441    * the server's notion of 'read' and if it differs from the message info
 442    * picked up in mutt_read_rfc822_header, we mark the message (and context
 443    * changed). Another possiblity: ignore Status on IMAP?*/
 444   read = h->read;
 445   newenv = mutt_read_rfc822_header (msg->fp, h, 0, 0);
 446   mutt_merge_envelopes(h->env, &newenv);
 447
 448   /* see above. We want the new status in h->read, so we unset it manually
 449    * and let mutt_set_flag set it correctly, updating context. */
 450   if (read != h->read) {
 451     h->read = read;
 452     mutt_set_flag (ctx, h, M_NEW, read);
 453   }
 454
 455   h->lines = 0;
 456   fgets (buf, sizeof (buf), msg->fp);
 457   while (!feof (msg->fp)) {
 458     h->lines++;
 459     fgets (buf, sizeof (buf), msg->fp);
 460   }
 461
 462   h->content->length = ftell (msg->fp) - h->content->offset;
 463
 464   /* This needs to be done in case this is a multipart message */
 465 #if defined(HAVE_PGP) || defined(HAVE_SMIME)
 466   h->security = crypt_query (h->content);
 467 #endif
 468
 469   mutt_clear_error ();
 470   rewind (msg->fp);
 471
 472   return 0;
 473
 474 bail:
 475   safe_fclose (&msg->fp);
 476   if (cache->path) {
 477     unlink (cache->path);
 478     mem_free (&cache->path);
 479   }
 480
 481   return -1;
 482 }
 483
 484 int imap_append_message (CONTEXT * ctx, MESSAGE * msg)
 485 {
 486   IMAP_DATA *idata;
 487   FILE *fp;
 488   char buf[LONG_STRING];
 489   char mbox[LONG_STRING];
 490   char mailbox[LONG_STRING];
 491   size_t len;
 492   int c, last;
 493   IMAP_MBOX mx;
 494   int rc;
 495
 496   idata = (IMAP_DATA *) ctx->data;
 497
 498   if (imap_parse_path (ctx->path, &mx))
 499     return -1;
 500
 501   imap_fix_path (idata, mx.mbox, mailbox, sizeof (mailbox));
 502
 503   if ((fp = fopen (msg->path, "r")) == NULL) {
 504     mutt_perror (msg->path);
 505     goto fail;
 506   }
 507
 508   /* currently we set the \Seen flag on all messages, but probably we
 509    * should scan the message Status header for flag info. Since we're
 510    * already rereading the whole file for length it isn't any more
 511    * expensive (it'd be nice if we had the file size passed in already
 512    * by the code that writes the file, but that's a lot of changes.
 513    * Ideally we'd have a HEADER structure with flag info here... */
 514   for (last = EOF, len = 0; (c = fgetc (fp)) != EOF; last = c) {
 515     if (c == '\n' && last != '\r')
 516       len++;
 517
 518     len++;
 519   }
 520   rewind (fp);
 521
 522   imap_munge_mbox_name (mbox, sizeof (mbox), mailbox);
 523   snprintf (buf, sizeof (buf), "APPEND %s (%s%s%s%s%s) {%lu}", mbox,
 524             msg->flags.read ? "\\Seen" : "",
 525             msg->flags.read && (msg->flags.replied
 526                                 || msg->flags.flagged) ? " " : "",
 527             msg->flags.replied ? "\\Answered" : "", msg->flags.replied
 528             && msg->flags.flagged ? " " : "",
 529             msg->flags.flagged ? "\\Flagged" : "", (unsigned long) len);
 530
 531   imap_cmd_start (idata, buf);
 532
 533   do
 534     rc = imap_cmd_step (idata);
 535   while (rc == IMAP_CMD_CONTINUE);
 536
 537   if (rc != IMAP_CMD_RESPOND) {
 538     char *pc;
 539
 540     debug_print (1, ("command failed: %s\n", idata->cmd.buf));
 541
 542     pc = idata->cmd.buf + SEQLEN;
 543     SKIPWS (pc);
 544     pc = imap_next_word (pc);
 545     mutt_error ("%s", pc);
 546     mutt_sleep (1);
 547     fclose (fp);
 548     goto fail;
 549   }
 550
 551   mutt_message _("Uploading message ...");
 552
 553   for (last = EOF, len = 0; (c = fgetc (fp)) != EOF; last = c) {
 554     if (c == '\n' && last != '\r')
 555       buf[len++] = '\r';
 556
 557     buf[len++] = c;
 558
 559     if (len > sizeof (buf) - 3)
 560       flush_buffer (buf, &len, idata->conn);
 561   }
 562
 563   if (len)
 564     flush_buffer (buf, &len, idata->conn);
 565
 566   mutt_socket_write (idata->conn, "\r\n");
 567   fclose (fp);
 568
 569   do
 570     rc = imap_cmd_step (idata);
 571   while (rc == IMAP_CMD_CONTINUE);
 572
 573   if (!imap_code (idata->cmd.buf)) {
 574     char *pc;
 575
 576     debug_print (1, ("command failed: %s\n", idata->cmd.buf));
 577     pc = idata->cmd.buf + SEQLEN;
 578     SKIPWS (pc);
 579     pc = imap_next_word (pc);
 580     mutt_error ("%s", pc);
 581     mutt_sleep (1);
 582     goto fail;
 583   }
 584
 585   mem_free (&mx.mbox);
 586   return 0;
 587
 588 fail:
 589   mem_free (&mx.mbox);
 590   return -1;
 591 }
 592
 593 /* imap_copy_messages: use server COPY command to copy messages to another
 594  *   folder.
 595  *   Return codes:
 596  *      -1: error
 597  *       0: success
 598  *       1: non-fatal error - try fetch/append */
 599 int imap_copy_messages (CONTEXT * ctx, HEADER * h, char *dest, int delete)
 600 {
 601   IMAP_DATA *idata;
 602   BUFFER cmd, sync_cmd;
 603   char uid[11];
 604   char mbox[LONG_STRING];
 605   char mmbox[LONG_STRING];
 606   int rc;
 607   int n;
 608   IMAP_MBOX mx;
 609   int err_continue = M_NO;
 610
 611   idata = (IMAP_DATA *) ctx->data;
 612
 613   if (imap_parse_path (dest, &mx)) {
 614     debug_print (1, ("bad destination %s\n", dest));
 615     return -1;
 616   }
 617
 618   /* check that the save-to folder is in the same account */
 619   if (!mutt_account_match (&(CTX_DATA->conn->account), &(mx.account))) {
 620     debug_print (3, ("%s not same server as %s\n", dest, ctx->path));
 621     return 1;
 622   }
 623
 624   if (h && h->attach_del) {
 625     debug_print (3, ("Message contains attachments to be deleted\n"));
 626     return 1;
 627   }
 628
 629   imap_fix_path (idata, mx.mbox, mbox, sizeof (mbox));
 630
 631   memset (&sync_cmd, 0, sizeof (sync_cmd));
 632   memset (&cmd, 0, sizeof (cmd));
 633   mutt_buffer_addstr (&cmd, "UID COPY ");
 634
 635   /* Null HEADER* means copy tagged messages */
 636   if (!h) {
 637     /* if any messages have attachments to delete, fall through to FETCH
 638      * and APPEND. TODO: Copy what we can with COPY, fall through for the
 639      * remainder. */
 640     for (n = 0; n < ctx->msgcount; n++) {
 641       if (ctx->hdrs[n]->tagged && ctx->hdrs[n]->attach_del) {
 642         debug_print (3, ("Message contains attachments to be deleted\n"));
 643         return 1;
 644       }
 645
 646       if (ctx->hdrs[n]->tagged && ctx->hdrs[n]->active &&
 647           ctx->hdrs[n]->changed)
 648       {
 649         rc = imap_sync_message (idata, ctx->hdrs[n], &sync_cmd, &err_continue);
 650         if (rc < 0)
 651         {
 652           debug_print (1, ("could not sync\n"));
 653           goto fail;
 654         }
 655       }
 656     }
 657
 658     rc = imap_make_msg_set (idata, &cmd, M_TAG, 0);
 659     if (!rc) {
 660       debug_print (1, ("No messages tagged\n"));
 661       goto fail;
 662     }
 663     mutt_message (_("Copying %d messages to %s..."), rc, mbox);
 664   }
 665   else {
 666     mutt_message (_("Copying message %d to %s..."), h->index + 1, mbox);
 667     snprintf (uid, sizeof (uid), "%u", HEADER_DATA (h)->uid);
 668     mutt_buffer_addstr (&cmd, uid);
 669
 670     if (h->active && h->changed)
 671     {
 672       rc = imap_sync_message (idata, h, &sync_cmd, &err_continue);
 673       if (rc < 0)
 674       {
 675         debug_print (1, ("could not sync\n"));
 676         goto fail;
 677       }
 678     }
 679   }
 680
 681   /* let's get it on */
 682   mutt_buffer_addstr (&cmd, " ");
 683   imap_munge_mbox_name (mmbox, sizeof (mmbox), mbox);
 684   mutt_buffer_addstr (&cmd, mmbox);
 685
 686   rc = imap_exec (idata, cmd.data, IMAP_CMD_FAIL_OK);
 687   if (rc == -2) {
 688     /* bail out if command failed for reasons other than nonexistent target */
 689     if (ascii_strncasecmp
 690         (imap_get_qualifier (idata->cmd.buf), "[TRYCREATE]", 11)) {
 691       imap_error ("imap_copy_messages", idata->cmd.buf);
 692       goto fail;
 693     }
 694     debug_print (2, ("server suggests TRYCREATE\n"));
 695     snprintf (mmbox, sizeof (mmbox), _("Create %s?"), mbox);
 696     if (option (OPTCONFIRMCREATE) && mutt_yesorno (mmbox, 1) < 1) {
 697       mutt_clear_error ();
 698       goto fail;
 699     }
 700     if (imap_create_mailbox (idata, mbox) < 0)
 701       goto fail;
 702
 703     /* try again */
 704     rc = imap_exec (idata, cmd.data, 0);
 705   }
 706   if (rc != 0) {
 707     imap_error ("imap_copy_messages", idata->cmd.buf);
 708     goto fail;
 709   }
 710
 711   /* cleanup */
 712   if (delete) {
 713     if (!h)
 714       for (n = 0; n < ctx->msgcount; n++) {
 715         if (ctx->hdrs[n]->tagged) {
 716           mutt_set_flag (ctx, ctx->hdrs[n], M_DELETE, 1);
 717           mutt_set_flag (ctx, ctx->hdrs[n], M_APPENDED, 1);
 718           if (option (OPTDELETEUNTAG))
 719             mutt_set_flag (ctx, ctx->hdrs[n], M_TAG, 0);
 720         }
 721       }
 722     else {
 723       mutt_set_flag (ctx, h, M_DELETE, 1);
 724       mutt_set_flag (ctx, h, M_APPENDED, 1);
 725       if (option (OPTDELETEUNTAG))
 726         mutt_set_flag (ctx, h, M_TAG, 0);
 727     }
 728   }
 729
 730   if (cmd.data)
 731     mem_free (&cmd.data);
 732   if (sync_cmd.data)
 733     mem_free (&sync_cmd.data);
 734   mem_free (&mx.mbox);
 735   return 0;
 736
 737 fail:
 738   if (cmd.data)
 739     mem_free (&cmd.data);
 740   if (sync_cmd.data)
 741     mem_free (&sync_cmd.data);
 742   mem_free (&mx.mbox);
 743   return -1;
 744 }
 745
 746 /* imap_add_keywords: concatenate custom IMAP tags to list, if they
 747  *   appear in the folder flags list. Why wouldn't they? */
 748 void imap_add_keywords (char *s, HEADER * h, LIST * mailbox_flags,
 749                         size_t slen)
 750 {
 751   LIST *keywords;
 752
 753   if (!mailbox_flags || !HEADER_DATA (h) || !HEADER_DATA (h)->keywords)
 754     return;
 755
 756   keywords = HEADER_DATA (h)->keywords->next;
 757
 758   while (keywords) {
 759     if (msg_has_flag (mailbox_flags, keywords->data)) {
 760       str_cat (s, slen, keywords->data);
 761       str_cat (s, slen, " ");
 762     }
 763     keywords = keywords->next;
 764   }
 765 }
 766
 767 /* imap_free_header_data: free IMAP_HEADER structure */
 768 void imap_free_header_data (void **data)
 769 {
 770   /* this should be safe even if the list wasn't used */
 771   mutt_free_list (&(((IMAP_HEADER_DATA *) * data)->keywords));
 772
 773   mem_free (data);
 774 }
 775
 776 /* imap_set_flags: fill out the message header according to the flags from
 777  *   the server. Expects a flags line of the form "FLAGS (flag flag ...)" */
 778 char *imap_set_flags (IMAP_DATA * idata, HEADER * h, char *s)
 779 {
 780   CONTEXT *ctx = idata->ctx;
 781   IMAP_HEADER newh;
 782   unsigned char readonly;
 783
 784   memset (&newh, 0, sizeof (newh));
 785   newh.data = mem_calloc (1, sizeof (IMAP_HEADER_DATA));
 786
 787   debug_print (2, ("parsing FLAGS\n"));
 788   if ((s = msg_parse_flags (&newh, s)) == NULL) {
 789     mem_free (&newh.data);
 790     return NULL;
 791   }
 792
 793   /* YAUH (yet another ugly hack): temporarily set context to
 794    * read-write even if it's read-only, so *server* updates of
 795    * flags can be processed by mutt_set_flag. ctx->changed must
 796    * be restored afterwards */
 797   readonly = ctx->readonly;
 798   ctx->readonly = 0;
 799
 800   mutt_set_flag (ctx, h, M_NEW, !(newh.read || newh.old));
 801   mutt_set_flag (ctx, h, M_OLD, newh.old);
 802   mutt_set_flag (ctx, h, M_READ, newh.read);
 803   mutt_set_flag (ctx, h, M_DELETE, newh.deleted);
 804   mutt_set_flag (ctx, h, M_FLAG, newh.flagged);
 805   mutt_set_flag (ctx, h, M_REPLIED, newh.replied);
 806
 807   /* this message is now definitively *not* changed (mutt_set_flag
 808    * marks things changed as a side-effect) */
 809   h->changed = 0;
 810   ctx->changed &= ~readonly;
 811   ctx->readonly = readonly;
 812
 813   mutt_free_list (&(HEADER_DATA (h)->keywords));
 814   HEADER_DATA (h)->keywords = newh.data->keywords;
 815   mem_free (&newh.data);
 816
 817   return s;
 818 }
 819
 820
 821 /* msg_fetch_header: import IMAP FETCH response into an IMAP_HEADER.
 822  *   Expects string beginning with * n FETCH.
 823  *   Returns:
 824  *      0 on success
 825  *     -1 if the string is not a fetch response
 826  *     -2 if the string is a corrupt fetch response */
 827 static int msg_fetch_header (CONTEXT * ctx, IMAP_HEADER * h, char *buf,
 828                              FILE * fp)
 829 {
 830   IMAP_DATA *idata;
 831   long bytes;
 832   int rc = -1;                  /* default now is that string isn't FETCH response */
 833
 834   idata = (IMAP_DATA *) ctx->data;
 835
 836   if (buf[0] != '*')
 837     return rc;
 838
 839   /* skip to message number */
 840   buf = imap_next_word (buf);
 841   h->sid = atoi (buf);
 842
 843   /* find FETCH tag */
 844   buf = imap_next_word (buf);
 845   if (ascii_strncasecmp ("FETCH", buf, 5))
 846     return rc;
 847
 848   rc = -2;                      /* we've got a FETCH response, for better or worse */
 849   if (!(buf = strchr (buf, '(')))
 850     return rc;
 851   buf++;
 852
 853   /* FIXME: current implementation - call msg_parse_fetch - if it returns -2,
 854    *   read header lines and call it again. Silly. */
 855   if (msg_parse_fetch (h, buf) != -2)
 856     return rc;
 857
 858   if (imap_get_literal_count (buf, &bytes) == 0) {
 859     imap_read_literal (fp, idata, bytes);
 860
 861     /* we may have other fields of the FETCH _after_ the literal
 862      * (eg Domino puts FLAGS here). Nothing wrong with that, either.
 863      * This all has to go - we should accept literals and nonliterals
 864      * interchangeably at any time. */
 865     if (imap_cmd_step (idata) != IMAP_CMD_CONTINUE)
 866       return rc;
 867
 868     if (msg_parse_fetch (h, idata->cmd.buf) == -1)
 869       return rc;
 870   }
 871
 872   rc = 0;                       /* success */
 873
 874   /* subtract headers from message size - unfortunately only the subset of
 875    * headers we've requested. */
 876   h->content_length -= bytes;
 877
 878   return rc;
 879 }
 880
 881 #if USE_HCACHE
 882 static size_t imap_hcache_keylen (const char *fn)
 883 {
 884   return str_len (fn);
 885 }
 886
 887 /* msg_fetch_header: import IMAP FETCH response into an IMAP_HEADER.
 888  *   Expects string beginning with * n FETCH.
 889  *   Returns:
 890  *      0 on success
 891  *     -1 if the string is not a fetch response
 892  *     -2 if the string is a corrupt fetch response */
 893 static int msg_fetch_header_fetch (CONTEXT * ctx, IMAP_HEADER * h, char *buf,
 894                                    FILE * fp)
 895 {
 896   IMAP_DATA *idata;
 897   int rc = -1;                  /* default now is that string isn't FETCH response */
 898
 899   idata = (IMAP_DATA *) ctx->data;
 900
 901   if (buf[0] != '*')
 902     return rc;
 903
 904   /* skip to message number */
 905   buf = imap_next_word (buf);
 906   h->sid = atoi (buf);
 907
 908   /* find FETCH tag */
 909   buf = imap_next_word (buf);
 910   if (ascii_strncasecmp ("FETCH", buf, 5))
 911     return rc;
 912
 913   rc = -2;                      /* we've got a FETCH response, for better or worse */
 914   if (!(buf = strchr (buf, '(')))
 915     return rc;
 916   buf++;
 917
 918   if (msg_parse_fetch (h, buf) < 0) {
 919     return -2;
 920   }
 921
 922   if (!(buf = strchr (buf, ')')))
 923     return rc;
 924   buf++;
 925
 926   return 0;
 927 }
 928 #endif /* USE_HCACHE */
 929
 930
 931 /* msg_has_flag: do a caseless comparison of the flag against a flag list,
 932  *   return 1 if found or flag list has '\*', 0 otherwise */
 933 static int msg_has_flag (LIST * flag_list, const char *flag)
 934 {
 935   if (!flag_list)
 936     return 0;
 937
 938   flag_list = flag_list->next;
 939   while (flag_list) {
 940     if (!ascii_strncasecmp (flag_list->data, flag, str_len (flag_list->data)))
 941       return 1;
 942
 943     flag_list = flag_list->next;
 944   }
 945
 946   return 0;
 947 }
 948
 949 /* msg_parse_fetch: handle headers returned from header fetch */
 950 static int msg_parse_fetch (IMAP_HEADER * h, char *s)
 951 {
 952   char tmp[SHORT_STRING];
 953   char *ptmp;
 954
 955   if (!s)
 956     return -1;
 957
 958   while (*s) {
 959     SKIPWS (s);
 960
 961     if (ascii_strncasecmp ("FLAGS", s, 5) == 0) {
 962       if ((s = msg_parse_flags (h, s)) == NULL)
 963         return -1;
 964     }
 965     else if (ascii_strncasecmp ("UID", s, 3) == 0) {
 966       s += 3;
 967       SKIPWS (s);
 968       h->data->uid = (unsigned int) atoi (s);
 969
 970       s = imap_next_word (s);
 971     }
 972     else if (ascii_strncasecmp ("INTERNALDATE", s, 12) == 0) {
 973       s += 12;
 974       SKIPWS (s);
 975       if (*s != '\"') {
 976         debug_print (1, ("bogus INTERNALDATE entry: %s\n", s));
 977         return -1;
 978       }
 979       s++;
 980       ptmp = tmp;
 981       while (*s && *s != '\"')
 982         *ptmp++ = *s++;
 983       if (*s != '\"')
 984         return -1;
 985       s++;                      /* skip past the trailing " */
 986       *ptmp = 0;
 987       h->received = imap_parse_date (tmp);
 988     }
 989     else if (ascii_strncasecmp ("RFC822.SIZE", s, 11) == 0) {
 990       s += 11;
 991       SKIPWS (s);
 992       ptmp = tmp;
 993       while (isdigit ((unsigned char) *s))
 994         *ptmp++ = *s++;
 995       *ptmp = 0;
 996       h->content_length = atoi (tmp);
 997     }
 998     else if (!ascii_strncasecmp ("BODY", s, 4) ||
 999              !ascii_strncasecmp ("RFC822.HEADER", s, 13)) {
1000       /* handle above, in msg_fetch_header */
1001       return -2;
1002     }
1003     else if (*s == ')')
1004       s++;                      /* end of request */
1005     else if (*s) {
1006       /* got something i don't understand */
1007       imap_error ("msg_parse_fetch", s);
1008       return -1;
1009     }
1010   }
1011
1012   return 0;
1013 }
1014
1015 /* msg_parse_flags: read a FLAGS token into an IMAP_HEADER */
1016 static char *msg_parse_flags (IMAP_HEADER * h, char *s)
1017 {
1018   int recent = 0;
1019
1020   /* sanity-check string */
1021   if (ascii_strncasecmp ("FLAGS", s, 5) != 0) {
1022     debug_print (1, ("not a FLAGS response: %s\n", s));
1023     return NULL;
1024   }
1025   s += 5;
1026   SKIPWS (s);
1027   if (*s != '(') {
1028     debug_print (1, ("bogus FLAGS response: %s\n", s));
1029     return NULL;
1030   }
1031   s++;
1032
1033   /* start parsing */
1034   while (*s && *s != ')') {
1035     if (ascii_strncasecmp ("\\deleted", s, 8) == 0) {
1036       s += 8;
1037       h->deleted = 1;
1038     }
1039     else if (ascii_strncasecmp ("\\flagged", s, 8) == 0) {
1040       s += 8;
1041       h->flagged = 1;
1042     }
1043     else if (ascii_strncasecmp ("\\answered", s, 9) == 0) {
1044       s += 9;
1045       h->replied = 1;
1046     }
1047     else if (ascii_strncasecmp ("\\seen", s, 5) == 0) {
1048       s += 5;
1049       h->read = 1;
1050     }
1051     else if (ascii_strncasecmp ("\\recent", s, 5) == 0) {
1052       s += 7;
1053       recent = 1;
1054     }
1055     else {
1056       /* store custom flags as well */
1057       char ctmp;
1058       char *flag_word = s;
1059
1060       if (!h->data->keywords)
1061         h->data->keywords = mutt_new_list ();
1062
1063       while (*s && !ISSPACE (*s) && *s != ')')
1064         s++;
1065       ctmp = *s;
1066       *s = '\0';
1067       mutt_add_list (h->data->keywords, flag_word);
1068       *s = ctmp;
1069     }
1070     SKIPWS (s);
1071   }
1072
1073   /* wrap up, or note bad flags response */
1074   if (*s == ')') {
1075     /* if a message is neither seen nor recent, it is OLD. */
1076     if (option (OPTMARKOLD) && !recent && !(h->read))
1077       h->old = 1;
1078     s++;
1079   }
1080   else {
1081     debug_print (1, ("Unterminated FLAGS response: %s\n", s));
1082     return NULL;
1083   }
1084
1085   return s;
1086 }
1087
1088 static void flush_buffer (char *buf, size_t * len, CONNECTION * conn)
1089 {
1090   buf[*len] = '\0';
1091   mutt_socket_write (conn, buf);
1092   *len = 0;
1093 }