mx.c

   1 /*
   2  * Copyright notice from original mutt:
   3  * Copyright (C) 1996-2002 Michael R. Elkins <me@mutt.org>
   4  * Copyright (C) 1999-2000 Thomas Roessler <roessler@does-not-exist.org>
   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 #if HAVE_CONFIG_H
  12 # include "config.h"
  13 #endif
  14
  15 #include <lib-lib/mem.h>
  16 #include <lib-lib/ascii.h>
  17 #include <lib-lib/str.h>
  18 #include <lib-lib/macros.h>
  19 #include <lib-lib/file.h>
  20
  21 #include <lib-mime/mime.h>
  22
  23 #include "mutt.h"
  24 #include "buffy.h"
  25 #include "mx.h"
  26 #include "mbox.h"
  27 #include "mh.h"
  28 #include "sort.h"
  29 #include "thread.h"
  30 #include "copy.h"
  31 #include "keymap.h"
  32 #include "url.h"
  33 #include "sidebar.h"
  34 #include "compress.h"
  35
  36 #ifdef USE_IMAP
  37 #include "imap/imap.h"
  38 #include "imap/mx_imap.h"
  39 #endif
  40
  41 #include <pop/pop.h>
  42 #include <pop/mx_pop.h>
  43
  44 #ifdef USE_NNTP
  45 #include "nntp/nntp.h"
  46 #include "nntp/mx_nntp.h"
  47 #endif
  48
  49 #ifdef USE_DOTLOCK
  50 #include "dotlock.h"
  51 #endif
  52
  53 #include "mutt_crypt.h"
  54
  55 #include "lib/list.h"
  56 #include "lib/debug.h"
  57
  58 #include <dirent.h>
  59 #include <fcntl.h>
  60 #include <sys/file.h>
  61 #include <sys/stat.h>
  62 #include <errno.h>
  63 #include <unistd.h>
  64 #include <stdlib.h>
  65 #include <string.h>
  66 #include <ctype.h>
  67 #include <utime.h>
  68
  69 static list2_t* MailboxFormats = NULL;
  70 #define MX_COMMAND(idx,cmd) ((mx_t*) MailboxFormats->data[idx])->cmd
  71 #define MX_IDX(idx) (idx >= 0 && idx < MailboxFormats->length)
  72
  73 #define mutt_is_spool(s)  (m_strcmp(Spoolfile, s) == 0)
  74
  75 #ifdef USE_DOTLOCK
  76 /* parameters:
  77  * path - file to lock
  78  * retry - should retry if unable to lock?
  79  */
  80
  81 static int invoke_dotlock (const char *path, int dummy, int flags, int retry)
  82 {
  83   char cmd[LONG_STRING + _POSIX_PATH_MAX];
  84   char f[SHORT_STRING + _POSIX_PATH_MAX];
  85   char r[SHORT_STRING];
  86
  87   if (flags & DL_FL_RETRY)
  88     snprintf (r, sizeof (r), "-r %d ", retry ? MAXLOCKATTEMPT : 0);
  89
  90   mutt_quote_filename (f, sizeof (f), path);
  91
  92   snprintf (cmd, sizeof (cmd),
  93             "%s %s%s%s%s%s%s%s",
  94             NONULL (MuttDotlock),
  95             flags & DL_FL_TRY ? "-t " : "",
  96             flags & DL_FL_UNLOCK ? "-u " : "",
  97             flags & DL_FL_USEPRIV ? "-p " : "",
  98             flags & DL_FL_FORCE ? "-f " : "",
  99             flags & DL_FL_UNLINK ? "-d " : "",
 100             flags & DL_FL_RETRY ? r : "", f);
 101
 102   return mutt_system (cmd);
 103 }
 104
 105 static int dotlock_file (const char *path, int fd, int retry)
 106 {
 107   int r;
 108   int flags = DL_FL_USEPRIV | DL_FL_RETRY;
 109
 110   if (retry)
 111     retry = 1;
 112
 113 retry_lock:
 114   if ((r = invoke_dotlock (path, fd, flags, retry)) == DL_EX_EXIST) {
 115     if (!option (OPTNOCURSES)) {
 116       char msg[LONG_STRING];
 117
 118       snprintf (msg, sizeof (msg),
 119                 _("Lock count exceeded, remove lock for %s?"), path);
 120       if (retry && mutt_yesorno (msg, M_YES) == M_YES) {
 121         flags |= DL_FL_FORCE;
 122         retry--;
 123         mutt_clear_error ();
 124         goto retry_lock;
 125       }
 126     }
 127     else {
 128       mutt_error (_("Can't dotlock %s.\n"), path);
 129     }
 130   }
 131   return (r == DL_EX_OK ? 0 : -1);
 132 }
 133
 134 static int undotlock_file (const char *path, int fd)
 135 {
 136   return (invoke_dotlock (path, fd, DL_FL_USEPRIV | DL_FL_UNLOCK, 0) ==
 137           DL_EX_OK ? 0 : -1);
 138 }
 139
 140 #endif /* USE_DOTLOCK */
 141
 142 /* looks up index of type for path in MailboxFormats */
 143 static int mx_get_idx (const char* path) {
 144   int i = 0, t = 0;
 145   struct stat st;
 146
 147   /* first, test all non-local folders to avoid stat() call */
 148   for (i = 0; i < MailboxFormats->length; i++) {
 149     if (!MX_COMMAND(i,local))
 150       t = MX_COMMAND(i,mx_is_magic)(path, NULL);
 151     if (t >= 1)
 152       return (t-1);
 153   }
 154   if (stat (path, &st) == 0) {
 155     /* if stat() succeeded, keep testing until success and
 156      * pass stat() info so that we only need to do it once */
 157     for (i = 0; i < MailboxFormats->length; i++) {
 158       if (MX_COMMAND(i,local))
 159         t = MX_COMMAND(i,mx_is_magic)(path, &st);
 160       if (t >= 1)
 161         return (t-1);
 162     }
 163   }
 164   return (-1);
 165 }
 166
 167 /* Args:
 168  *      excl            if excl != 0, request an exclusive lock
 169  *      dot             if dot != 0, try to dotlock the file
 170  *      timeout         should retry locking?
 171  */
 172 int mx_lock_file (const char *path, int fd, int excl, int dot, int timeout)
 173 {
 174 #if defined (USE_FCNTL) || defined (USE_FLOCK)
 175   int count;
 176   int attempt;
 177   struct stat prev_sb;
 178 #endif
 179   int r = 0;
 180
 181 #ifdef USE_FCNTL
 182   struct flock lck;
 183
 184
 185   p_clear(&lck, 1);
 186   lck.l_type = excl ? F_WRLCK : F_RDLCK;
 187   lck.l_whence = SEEK_SET;
 188
 189   count = 0;
 190   attempt = 0;
 191   prev_sb.st_size = 0;
 192   while (fcntl (fd, F_SETLK, &lck) == -1) {
 193     struct stat sb;
 194
 195     debug_print (1, ("fcntl errno %d.\n", errno));
 196     if (errno != EAGAIN && errno != EACCES) {
 197       mutt_perror ("fcntl");
 198       return (-1);
 199     }
 200
 201     if (fstat (fd, &sb) != 0)
 202       sb.st_size = 0;
 203
 204     if (count == 0)
 205       prev_sb = sb;
 206
 207     /* only unlock file if it is unchanged */
 208     if (prev_sb.st_size == sb.st_size
 209         && ++count >= (timeout ? MAXLOCKATTEMPT : 0)) {
 210       if (timeout)
 211         mutt_error _("Timeout exceeded while attempting fcntl lock!");
 212
 213       return (-1);
 214     }
 215
 216     prev_sb = sb;
 217
 218     mutt_message (_("Waiting for fcntl lock... %d"), ++attempt);
 219     sleep (1);
 220   }
 221 #endif /* USE_FCNTL */
 222
 223 #ifdef USE_FLOCK
 224   count = 0;
 225   attempt = 0;
 226   while (flock (fd, (excl ? LOCK_EX : LOCK_SH) | LOCK_NB) == -1) {
 227     struct stat sb;
 228
 229     if (errno != EWOULDBLOCK) {
 230       mutt_perror ("flock");
 231       r = -1;
 232       break;
 233     }
 234
 235     if (fstat (fd, &sb) != 0)
 236       sb.st_size = 0;
 237
 238     if (count == 0)
 239       prev_sb = sb;
 240
 241     /* only unlock file if it is unchanged */
 242     if (prev_sb.st_size == sb.st_size
 243         && ++count >= (timeout ? MAXLOCKATTEMPT : 0)) {
 244       if (timeout)
 245         mutt_error _("Timeout exceeded while attempting flock lock!");
 246
 247       r = -1;
 248       break;
 249     }
 250
 251     prev_sb = sb;
 252
 253     mutt_message (_("Waiting for flock attempt... %d"), ++attempt);
 254     sleep (1);
 255   }
 256 #endif /* USE_FLOCK */
 257
 258 #ifdef USE_DOTLOCK
 259   if (r == 0 && dot)
 260     r = dotlock_file (path, fd, timeout);
 261 #endif /* USE_DOTLOCK */
 262
 263   if (r == -1) {
 264     /* release any other locks obtained in this routine */
 265
 266 #ifdef USE_FCNTL
 267     lck.l_type = F_UNLCK;
 268     fcntl (fd, F_SETLK, &lck);
 269 #endif /* USE_FCNTL */
 270
 271 #ifdef USE_FLOCK
 272     flock (fd, LOCK_UN);
 273 #endif /* USE_FLOCK */
 274
 275     return (-1);
 276   }
 277
 278   return 0;
 279 }
 280
 281 int mx_unlock_file (const char *path, int fd, int dot)
 282 {
 283 #ifdef USE_FCNTL
 284   struct flock unlockit;
 285
 286   p_clear(&unlockit, 1);
 287   unlockit.l_type = F_UNLCK;
 288   unlockit.l_whence = SEEK_SET;
 289   fcntl (fd, F_SETLK, &unlockit);
 290 #endif
 291
 292 #ifdef USE_FLOCK
 293   flock (fd, LOCK_UN);
 294 #endif
 295
 296 #ifdef USE_DOTLOCK
 297   if (dot)
 298     undotlock_file (path, fd);
 299 #endif
 300
 301   return 0;
 302 }
 303
 304 void mx_unlink_empty (const char *path)
 305 {
 306   int fd;
 307
 308 #ifndef USE_DOTLOCK
 309   struct stat sb;
 310 #endif
 311
 312   if ((fd = open (path, O_RDWR)) == -1)
 313     return;
 314
 315   if (mx_lock_file (path, fd, 1, 0, 1) == -1) {
 316     close (fd);
 317     return;
 318   }
 319
 320 #ifdef USE_DOTLOCK
 321   invoke_dotlock (path, fd, DL_FL_UNLINK, 1);
 322 #else
 323   if (fstat (fd, &sb) == 0 && sb.st_size == 0)
 324     unlink (path);
 325 #endif
 326
 327   mx_unlock_file (path, fd, 0);
 328   close (fd);
 329 }
 330
 331 /* try to figure out what type of mailbox ``path'' is */
 332 int mx_get_magic (const char *path) {
 333   int i = 0;
 334
 335   if (m_strlen(path) == 0)
 336     return (-1);
 337   if ((i = mx_get_idx (path)) >= 0)
 338     return (MX_COMMAND(i,type));
 339   return (-1);
 340 }
 341
 342 int mx_is_local (int m) {
 343   if (!MX_IDX(m))
 344     return (0);
 345   return (MX_COMMAND(m,local));
 346 }
 347
 348 /*
 349  * set DefaultMagic to the given value
 350  */
 351 int mx_set_magic (const char *s)
 352 {
 353   if (ascii_strcasecmp (s, "mbox") == 0)
 354     DefaultMagic = M_MBOX;
 355   else if (ascii_strcasecmp (s, "mmdf") == 0)
 356     DefaultMagic = M_MMDF;
 357   else if (ascii_strcasecmp (s, "mh") == 0)
 358     DefaultMagic = M_MH;
 359   else if (ascii_strcasecmp (s, "maildir") == 0)
 360     DefaultMagic = M_MAILDIR;
 361   else
 362     return (-1);
 363
 364   return 0;
 365 }
 366
 367 /* mx_access: Wrapper for access, checks permissions on a given mailbox.
 368  *   We may be interested in using ACL-style flags at some point, currently
 369  *   we use the normal access() flags. */
 370 int mx_access (const char *path, int flags)
 371 {
 372   int i = 0;
 373
 374   if ((i = mx_get_idx (path)) >= 0 && MX_COMMAND(i,mx_access))
 375     return (MX_COMMAND(i,mx_access)(path,flags));
 376   return (0);
 377 }
 378
 379 static int mx_open_mailbox_append (CONTEXT * ctx, int flags)
 380 {
 381   struct stat sb;
 382
 383   /* special case for appending to compressed folders -
 384    * even if we can not open them for reading */
 385   if (mutt_can_append_compressed (ctx->path))
 386     mutt_open_append_compressed (ctx);
 387
 388   ctx->append = 1;
 389
 390 #ifdef USE_IMAP
 391
 392   if (mx_get_magic (ctx->path) == M_IMAP)
 393     return imap_open_mailbox_append (ctx);
 394
 395 #endif
 396
 397   if (stat (ctx->path, &sb) == 0) {
 398     ctx->magic = mx_get_magic (ctx->path);
 399
 400     switch (ctx->magic) {
 401     case 0:
 402       mutt_error (_("%s is not a mailbox."), ctx->path);
 403       /* fall through */
 404     case -1:
 405       return (-1);
 406     }
 407   }
 408   else if (errno == ENOENT) {
 409     ctx->magic = DefaultMagic;
 410
 411     if (ctx->magic == M_MH || ctx->magic == M_MAILDIR) {
 412       char tmp[_POSIX_PATH_MAX];
 413
 414       if (mkdir (ctx->path, S_IRWXU)) {
 415         mutt_perror (ctx->path);
 416         return (-1);
 417       }
 418
 419       if (ctx->magic == M_MAILDIR) {
 420         snprintf (tmp, sizeof (tmp), "%s/cur", ctx->path);
 421         if (mkdir (tmp, S_IRWXU)) {
 422           mutt_perror (tmp);
 423           rmdir (ctx->path);
 424           return (-1);
 425         }
 426
 427         snprintf (tmp, sizeof (tmp), "%s/new", ctx->path);
 428         if (mkdir (tmp, S_IRWXU)) {
 429           mutt_perror (tmp);
 430           snprintf (tmp, sizeof (tmp), "%s/cur", ctx->path);
 431           rmdir (tmp);
 432           rmdir (ctx->path);
 433           return (-1);
 434         }
 435         snprintf (tmp, sizeof (tmp), "%s/tmp", ctx->path);
 436         if (mkdir (tmp, S_IRWXU)) {
 437           mutt_perror (tmp);
 438           snprintf (tmp, sizeof (tmp), "%s/cur", ctx->path);
 439           rmdir (tmp);
 440           snprintf (tmp, sizeof (tmp), "%s/new", ctx->path);
 441           rmdir (tmp);
 442           rmdir (ctx->path);
 443           return (-1);
 444         }
 445       }
 446       else {
 447         int i;
 448
 449         snprintf (tmp, sizeof (tmp), "%s/.mh_sequences", ctx->path);
 450         if ((i = creat (tmp, S_IRWXU)) == -1) {
 451           mutt_perror (tmp);
 452           rmdir (ctx->path);
 453           return (-1);
 454         }
 455         close (i);
 456       }
 457     }
 458   }
 459   else {
 460     mutt_perror (ctx->path);
 461     return (-1);
 462   }
 463
 464   switch (ctx->magic) {
 465   case M_MBOX:
 466   case M_MMDF:
 467     if ((ctx->fp =
 468          safe_fopen (ctx->path, flags & M_NEWFOLDER ? "w" : "a")) == NULL
 469         || mbox_lock_mailbox (ctx, 1, 1) != 0) {
 470       if (!ctx->fp)
 471         mutt_perror (ctx->path);
 472       else {
 473         mutt_error (_("Couldn't lock %s\n"), ctx->path);
 474         safe_fclose (&ctx->fp);
 475       }
 476       return (-1);
 477     }
 478     fseeko (ctx->fp, 0, 2);
 479     break;
 480
 481   case M_MH:
 482   case M_MAILDIR:
 483     /* nothing to do */
 484     break;
 485
 486   default:
 487     return (-1);
 488   }
 489
 490   return 0;
 491 }
 492
 493 /*
 494  * open a mailbox and parse it
 495  *
 496  * Args:
 497  *      flags   M_NOSORT        do not sort mailbox
 498  *              M_APPEND        open mailbox for appending
 499  *              M_READONLY      open mailbox in read-only mode
 500  *              M_QUIET         only print error messages
 501  *      ctx     if non-null, context struct to use
 502  */
 503 CONTEXT *mx_open_mailbox (const char *path, int flags, CONTEXT * pctx)
 504 {
 505   CONTEXT *ctx = pctx;
 506   int rc;
 507
 508   if (!ctx)
 509     ctx = p_new(CONTEXT, 1);
 510   p_clear(ctx, 1);
 511   ctx->path = m_strdup(path);
 512
 513   ctx->msgnotreadyet = -1;
 514   ctx->collapsed = 0;
 515
 516   if (flags & M_QUIET)
 517     ctx->quiet = 1;
 518   if (flags & M_READONLY)
 519     ctx->readonly = 1;
 520   if (flags & M_COUNT)
 521     ctx->counting = 1;
 522
 523   if (flags & (M_APPEND | M_NEWFOLDER)) {
 524     if (mx_open_mailbox_append (ctx, flags) != 0) {
 525       mx_fastclose_mailbox (ctx);
 526       if (!pctx)
 527         p_delete(&ctx);
 528       return NULL;
 529     }
 530     return ctx;
 531   }
 532
 533   if (!MX_IDX(ctx->magic-1))
 534     ctx->magic = mx_get_magic (path);
 535
 536   if (ctx->magic == M_COMPRESSED)
 537     mutt_open_read_compressed (ctx);
 538
 539   if (ctx->magic == 0)
 540     mutt_error (_("%s is not a mailbox."), path);
 541
 542   if (ctx->magic == -1)
 543     mutt_perror (path);
 544
 545   if (ctx->magic <= 0) {
 546     mx_fastclose_mailbox (ctx);
 547     if (!pctx)
 548       p_delete(&ctx);
 549     return (NULL);
 550   }
 551
 552   /* if the user has a `push' command in their .muttrc, or in a folder-hook,
 553    * it will cause the progress messages not to be displayed because
 554    * mutt_refresh() will think we are in the middle of a macro.  so set a
 555    * flag to indicate that we should really refresh the screen.
 556    */
 557   set_option (OPTFORCEREFRESH);
 558
 559   if (!ctx->quiet)
 560     mutt_message (_("Reading %s..."), ctx->path);
 561
 562   rc = MX_COMMAND(ctx->magic-1,mx_open_mailbox)(ctx);
 563
 564   if (rc == 0) {
 565     if ((flags & M_NOSORT) == 0) {
 566       /* avoid unnecessary work since the mailbox is completely unthreaded
 567          to begin with */
 568       unset_option (OPTSORTSUBTHREADS);
 569       unset_option (OPTNEEDRESCORE);
 570       mutt_sort_headers (ctx, 1);
 571     }
 572     if (!ctx->quiet)
 573       mutt_clear_error ();
 574   }
 575   else {
 576     mx_fastclose_mailbox (ctx);
 577     if (!pctx)
 578       p_delete(&ctx);
 579   }
 580
 581   unset_option (OPTFORCEREFRESH);
 582   return (ctx);
 583 }
 584
 585 /* free up memory associated with the mailbox context */
 586 void mx_fastclose_mailbox (CONTEXT * ctx)
 587 {
 588   int i;
 589
 590   if (!ctx)
 591     return;
 592
 593   if (MX_IDX(ctx->magic-1) && MX_COMMAND(ctx->magic-1,mx_fastclose_mailbox))
 594     MX_COMMAND(ctx->magic-1,mx_fastclose_mailbox(ctx));
 595   if (ctx->subj_hash)
 596     hash_destroy (&ctx->subj_hash, NULL);
 597   if (ctx->id_hash)
 598     hash_destroy (&ctx->id_hash, NULL);
 599   mutt_clear_threads (ctx);
 600   for (i = 0; i < ctx->msgcount; i++)
 601     mutt_free_header (&ctx->hdrs[i]);
 602   p_delete(&ctx->hdrs);
 603   p_delete(&ctx->v2r);
 604
 605   if (ctx->compressinfo)
 606     mutt_fast_close_compressed (ctx);
 607
 608   p_delete(&ctx->path);
 609   p_delete(&ctx->pattern);
 610   if (ctx->limit_pattern)
 611     mutt_pattern_free (&ctx->limit_pattern);
 612   safe_fclose (&ctx->fp);
 613   p_clear(ctx, 1);
 614 }
 615
 616 /* save changes to disk */
 617 static int sync_mailbox (CONTEXT * ctx, int *index_hint)
 618 {
 619   int rc = -1;
 620
 621   if (!ctx->quiet)
 622     mutt_message (_("Writing %s..."), ctx->path);
 623
 624   if (MX_IDX(ctx->magic-1))
 625     /* the 1 is only of interest for IMAP and means EXPUNGE */
 626     rc = MX_COMMAND(ctx->magic-1,mx_sync_mailbox(ctx,1,index_hint));
 627
 628   if (rc == 0 && ctx->compressinfo)
 629     return mutt_sync_compressed (ctx);
 630
 631   return rc;
 632 }
 633
 634 /* move deleted mails to the trash folder */
 635 static int trash_append (CONTEXT * ctx)
 636 {
 637   CONTEXT *ctx_trash;
 638   int i = 0;
 639   struct stat st, stc;
 640
 641   if (!TrashPath || !ctx->deleted ||
 642       (ctx->magic == M_MAILDIR && option (OPTMAILDIRTRASH)))
 643     return 0;
 644
 645   for (; i < ctx->msgcount && (!ctx->hdrs[i]->deleted ||
 646                                ctx->hdrs[i]->appended); i++);
 647   if (i == ctx->msgcount)
 648     return 0;                   /* nothing to be done */
 649
 650   if (mutt_save_confirm (TrashPath, &st) != 0) {
 651     mutt_error _("message(s) not deleted");
 652
 653     return -1;
 654   }
 655
 656   if (lstat (ctx->path, &stc) == 0 && stc.st_ino == st.st_ino
 657       && stc.st_dev == st.st_dev && stc.st_rdev == st.st_rdev)
 658     return 0;                   /* we are in the trash folder: simple sync */
 659
 660   if ((ctx_trash = mx_open_mailbox (TrashPath, M_APPEND, NULL)) != NULL) {
 661     for (i = 0; i < ctx->msgcount; i++)
 662       if (ctx->hdrs[i]->deleted && !ctx->hdrs[i]->appended
 663           && !ctx->hdrs[i]->purged
 664           && mutt_append_message (ctx_trash, ctx, ctx->hdrs[i], 0, 0) == -1) {
 665         mx_close_mailbox (ctx_trash, NULL);
 666         return -1;
 667       }
 668
 669     mx_close_mailbox (ctx_trash, NULL);
 670   }
 671   else {
 672     mutt_error _("Can't open trash folder");
 673
 674     return -1;
 675   }
 676
 677   return 0;
 678 }
 679
 680 /* save changes and close mailbox */
 681 static int _mx_close_mailbox (CONTEXT * ctx, int *index_hint)
 682 {
 683   int i, move_messages = 0, purge = 1, read_msgs = 0;
 684   int check;
 685   int isSpool = 0;
 686   CONTEXT f;
 687   char mbox[_POSIX_PATH_MAX];
 688   char buf[SHORT_STRING];
 689
 690   if (!ctx)
 691     return 0;
 692
 693   ctx->closing = 1;
 694
 695 #ifdef USE_NNTP
 696   if (ctx->magic == M_NNTP) {
 697     int ret;
 698
 699     ret = nntp_close_mailbox (ctx);
 700     mx_fastclose_mailbox (ctx);
 701     return ret;
 702   }
 703 #endif
 704   if (ctx->readonly || ctx->dontwrite) {
 705     /* mailbox is readonly or we don't want to write */
 706     mx_fastclose_mailbox (ctx);
 707     return 0;
 708   }
 709
 710   if (ctx->append) {
 711     /* mailbox was opened in write-mode */
 712     if (ctx->magic == M_MBOX || ctx->magic == M_MMDF)
 713       mbox_close_mailbox (ctx);
 714     else
 715       mx_fastclose_mailbox (ctx);
 716     return 0;
 717   }
 718
 719   for (i = 0; i < ctx->msgcount; i++) {
 720     if (!ctx->hdrs[i]->deleted && ctx->hdrs[i]->read
 721         && !(ctx->hdrs[i]->flagged && option (OPTKEEPFLAGGED)))
 722       read_msgs++;
 723   }
 724
 725   if (read_msgs && quadoption (OPT_MOVE) != M_NO) {
 726     char *p;
 727
 728     if ((p = mutt_find_hook (M_MBOXHOOK, ctx->path))) {
 729       isSpool = 1;
 730       m_strcpy(mbox, sizeof(mbox), p);
 731     }
 732     else {
 733       m_strcpy(mbox, sizeof(mbox), NONULL(Inbox));
 734       isSpool = mutt_is_spool (ctx->path) && !mutt_is_spool (mbox);
 735     }
 736     mutt_expand_path (mbox, sizeof (mbox));
 737
 738     if (isSpool) {
 739       snprintf (buf, sizeof (buf), _("Move read messages to %s?"), mbox);
 740       if ((move_messages = query_quadoption (OPT_MOVE, buf)) == -1) {
 741         ctx->closing = 0;
 742         return (-1);
 743       }
 744     }
 745   }
 746
 747   /*
 748    * There is no point in asking whether or not to purge if we are
 749    * just marking messages as "trash".
 750    */
 751   if (ctx->deleted && !(ctx->magic == M_MAILDIR && option (OPTMAILDIRTRASH))) {
 752     snprintf (buf, sizeof (buf), ctx->deleted == 1
 753               ? _("Purge %d deleted message?") :
 754               _("Purge %d deleted messages?"), ctx->deleted);
 755     if ((purge = query_quadoption (OPT_DELETE, buf)) < 0) {
 756       ctx->closing = 0;
 757       return (-1);
 758     }
 759   }
 760
 761 #ifdef USE_IMAP
 762   /* IMAP servers manage the OLD flag themselves */
 763   if (ctx->magic != M_IMAP)
 764 #endif
 765     if (option (OPTMARKOLD)) {
 766       for (i = 0; i < ctx->msgcount; i++) {
 767         if (!ctx->hdrs[i]->deleted && !ctx->hdrs[i]->old)
 768           mutt_set_flag (ctx, ctx->hdrs[i], M_OLD, 1);
 769       }
 770     }
 771
 772   if (move_messages) {
 773     mutt_message (_("Moving read messages to %s..."), mbox);
 774
 775 #ifdef USE_IMAP
 776     /* try to use server-side copy first */
 777     i = 1;
 778
 779     if (ctx->magic == M_IMAP && imap_is_magic (mbox, NULL) == M_IMAP) {
 780       /* tag messages for moving, and clear old tags, if any */
 781       for (i = 0; i < ctx->msgcount; i++)
 782         if (ctx->hdrs[i]->read && !ctx->hdrs[i]->deleted
 783             && !(ctx->hdrs[i]->flagged && option (OPTKEEPFLAGGED)))
 784           ctx->hdrs[i]->tagged = 1;
 785         else
 786           ctx->hdrs[i]->tagged = 0;
 787
 788       i = imap_copy_messages (ctx, NULL, mbox, 1);
 789     }
 790
 791     if (i == 0)                 /* success */
 792       mutt_clear_error ();
 793     else if (i == -1) {         /* horrible error, bail */
 794       ctx->closing = 0;
 795       return -1;
 796     }
 797     else                        /* use regular append-copy mode */
 798 #endif
 799     {
 800       if (mx_open_mailbox (mbox, M_APPEND, &f) == NULL) {
 801         ctx->closing = 0;
 802         return -1;
 803       }
 804
 805       for (i = 0; i < ctx->msgcount; i++) {
 806         if (ctx->hdrs[i]->read && !ctx->hdrs[i]->deleted
 807             && !(ctx->hdrs[i]->flagged && option (OPTKEEPFLAGGED))) {
 808           if (mutt_append_message (&f, ctx, ctx->hdrs[i], 0, CH_UPDATE_LEN) ==
 809               0) {
 810             mutt_set_flag (ctx, ctx->hdrs[i], M_DELETE, 1);
 811             mutt_set_flag (ctx, ctx->hdrs[i], M_APPENDED, 1);
 812           }
 813           else {
 814             mx_close_mailbox (&f, NULL);
 815             ctx->closing = 0;
 816             return -1;
 817           }
 818         }
 819       }
 820
 821       mx_close_mailbox (&f, NULL);
 822     }
 823
 824   }
 825   else if (!ctx->changed && ctx->deleted == 0) {
 826     mutt_message _("Mailbox is unchanged.");
 827
 828     mx_fastclose_mailbox (ctx);
 829     return 0;
 830   }
 831
 832   /* copy mails to the trash before expunging */
 833   if (purge && ctx->deleted)
 834     if (trash_append (ctx) != 0) {
 835       ctx->closing = 0;
 836       return -1;
 837     }
 838
 839 #ifdef USE_IMAP
 840   /* allow IMAP to preserve the deleted flag across sessions */
 841   if (ctx->magic == M_IMAP) {
 842     if ((check = imap_sync_mailbox (ctx, purge, index_hint)) != 0) {
 843       ctx->closing = 0;
 844       return check;
 845     }
 846   }
 847   else
 848 #endif
 849   {
 850     if (!purge) {
 851       for (i = 0; i < ctx->msgcount; i++)
 852         ctx->hdrs[i]->deleted = 0;
 853       ctx->deleted = 0;
 854     }
 855
 856     if (ctx->changed || ctx->deleted) {
 857       if ((check = sync_mailbox (ctx, index_hint)) != 0) {
 858         ctx->closing = 0;
 859         return check;
 860       }
 861     }
 862   }
 863
 864   if (move_messages)
 865     mutt_message (_("%d kept, %d moved, %d deleted."),
 866                   ctx->msgcount - ctx->deleted, read_msgs, ctx->deleted);
 867   else
 868     mutt_message (_("%d kept, %d deleted."),
 869                   ctx->msgcount - ctx->deleted, ctx->deleted);
 870
 871   if (ctx->msgcount == ctx->deleted &&
 872       (ctx->magic == M_MMDF || ctx->magic == M_MBOX) &&
 873       !mutt_is_spool (ctx->path) && !option (OPTSAVEEMPTY))
 874     mx_unlink_empty (ctx->path);
 875
 876   if (ctx->compressinfo && mutt_slow_close_compressed (ctx))
 877     return (-1);
 878
 879   mx_fastclose_mailbox (ctx);
 880
 881   return 0;
 882 }
 883
 884 int mx_close_mailbox (CONTEXT * ctx, int *index_hint) {
 885   int ret = 0;
 886   if (!ctx)
 887     return (0);
 888   ret = _mx_close_mailbox (ctx, index_hint);
 889   sidebar_set_buffystats (ctx);
 890   return (ret);
 891 }
 892
 893 /* update a Context structure's internal tables. */
 894
 895 void mx_update_tables (CONTEXT * ctx, int committing)
 896 {
 897   int i, j;
 898
 899   /* update memory to reflect the new state of the mailbox */
 900   ctx->vcount = 0;
 901   ctx->vsize = 0;
 902   ctx->tagged = 0;
 903   ctx->deleted = 0;
 904   ctx->new = 0;
 905   ctx->unread = 0;
 906   ctx->changed = 0;
 907   ctx->flagged = 0;
 908 #define this_body ctx->hdrs[j]->content
 909   for (i = 0, j = 0; i < ctx->msgcount; i++) {
 910     if ((committing && (!ctx->hdrs[i]->deleted ||
 911                         (ctx->magic == M_MAILDIR
 912                          && option (OPTMAILDIRTRASH)))) || (!committing
 913                                                             && ctx->hdrs[i]->
 914                                                             active)) {
 915       if (i != j) {
 916         ctx->hdrs[j] = ctx->hdrs[i];
 917         ctx->hdrs[i] = NULL;
 918       }
 919       ctx->hdrs[j]->msgno = j;
 920       if (ctx->hdrs[j]->virtual != -1) {
 921         ctx->v2r[ctx->vcount] = j;
 922         ctx->hdrs[j]->virtual = ctx->vcount++;
 923         ctx->vsize += this_body->length + this_body->offset -
 924           this_body->hdr_offset;
 925       }
 926
 927       if (committing)
 928         ctx->hdrs[j]->changed = 0;
 929       else if (ctx->hdrs[j]->changed)
 930         ctx->changed++;
 931
 932       if (!committing
 933           || (ctx->magic == M_MAILDIR && option (OPTMAILDIRTRASH))) {
 934         if (ctx->hdrs[j]->deleted)
 935           ctx->deleted++;
 936       }
 937
 938       if (ctx->hdrs[j]->tagged)
 939         ctx->tagged++;
 940       if (ctx->hdrs[j]->flagged)
 941         ctx->flagged++;
 942       if (!ctx->hdrs[j]->read) {
 943         ctx->unread++;
 944         if (!ctx->hdrs[j]->old)
 945           ctx->new++;
 946       }
 947
 948       j++;
 949     }
 950     else {
 951       if (ctx->magic == M_MH || ctx->magic == M_MAILDIR)
 952         ctx->size -= (ctx->hdrs[i]->content->length +
 953                       ctx->hdrs[i]->content->offset -
 954                       ctx->hdrs[i]->content->hdr_offset);
 955       /* remove message from the hash tables */
 956       if (ctx->subj_hash && ctx->hdrs[i]->env->real_subj)
 957         hash_delete (ctx->subj_hash, ctx->hdrs[i]->env->real_subj,
 958                      ctx->hdrs[i], NULL);
 959       if (ctx->id_hash && ctx->hdrs[i]->env->message_id)
 960         hash_delete (ctx->id_hash, ctx->hdrs[i]->env->message_id,
 961                      ctx->hdrs[i], NULL);
 962       mutt_free_header (&ctx->hdrs[i]);
 963     }
 964   }
 965 #undef this_body
 966   ctx->msgcount = j;
 967
 968   /* update sidebar count */
 969   sidebar_set_buffystats (ctx);
 970 }
 971
 972
 973 /* save changes to mailbox
 974  *
 975  * return values:
 976  *      0               success
 977  *      -1              error
 978  */
 979 static int _mx_sync_mailbox (CONTEXT * ctx, int *index_hint)
 980 {
 981   int rc, i;
 982   int purge = 1;
 983   int msgcount, deleted;
 984
 985   if (ctx->dontwrite) {
 986     char buf[STRING], tmp[STRING];
 987
 988     if (km_expand_key (buf, sizeof (buf),
 989                        km_find_func (MENU_MAIN, OP_TOGGLE_WRITE)))
 990       snprintf (tmp, sizeof (tmp), _(" Press '%s' to toggle write"), buf);
 991     else
 992       m_strcpy(tmp, sizeof(tmp), _("Use 'toggle-write' to re-enable write!"));
 993
 994     mutt_error (_("Mailbox is marked unwritable. %s"), tmp);
 995     return -1;
 996   }
 997   else if (ctx->readonly) {
 998     mutt_error _("Mailbox is read-only.");
 999
1000     return -1;
1001   }
1002
1003   if (!ctx->changed && !ctx->deleted) {
1004     mutt_message _("Mailbox is unchanged.");
1005
1006     return (0);
1007   }
1008
1009   if (ctx->deleted) {
1010     char buf[SHORT_STRING];
1011
1012     snprintf (buf, sizeof (buf), ctx->deleted == 1
1013               ? _("Purge %d deleted message?") :
1014               _("Purge %d deleted messages?"), ctx->deleted);
1015     if ((purge = query_quadoption (OPT_DELETE, buf)) < 0)
1016       return (-1);
1017     else if (purge == M_NO) {
1018       if (!ctx->changed)
1019         return 0;               /* nothing to do! */
1020 #ifdef USE_IMAP
1021       /* let IMAP servers hold on to D flags */
1022       if (ctx->magic != M_IMAP)
1023 #endif
1024       {
1025         for (i = 0; i < ctx->msgcount; i++)
1026           ctx->hdrs[i]->deleted = 0;
1027         ctx->deleted = 0;
1028       }
1029     }
1030     else if (ctx->last_tag && ctx->last_tag->deleted)
1031       ctx->last_tag = NULL;     /* reset last tagged msg now useless */
1032   }
1033
1034   /* really only for IMAP - imap_sync_mailbox results in a call to
1035    * mx_update_tables, so ctx->deleted is 0 when it comes back */
1036   msgcount = ctx->msgcount;
1037   deleted = ctx->deleted;
1038
1039   if (purge && ctx->deleted) {
1040     if (trash_append (ctx) == -1)
1041       return -1;
1042   }
1043
1044 #ifdef USE_IMAP
1045   if (ctx->magic == M_IMAP)
1046     rc = imap_sync_mailbox (ctx, purge, index_hint);
1047   else
1048 #endif
1049     rc = sync_mailbox (ctx, index_hint);
1050   if (rc == 0) {
1051 #ifdef USE_IMAP
1052     if (ctx->magic == M_IMAP && !purge)
1053       mutt_message (_("Mailbox checkpointed."));
1054
1055     else
1056 #endif
1057       mutt_message (_("%d kept, %d deleted."), msgcount - deleted, deleted);
1058
1059     mutt_sleep (0);
1060
1061     if (ctx->msgcount == ctx->deleted &&
1062         (ctx->magic == M_MBOX || ctx->magic == M_MMDF) &&
1063         !mutt_is_spool (ctx->path) && !option (OPTSAVEEMPTY)) {
1064       unlink (ctx->path);
1065       mx_fastclose_mailbox (ctx);
1066       return 0;
1067     }
1068
1069     /* if we haven't deleted any messages, we don't need to resort */
1070     /* ... except for certain folder formats which need "unsorted"
1071      * sort order in order to synchronize folders.
1072      *
1073      * MH and maildir are safe.  mbox-style seems to need re-sorting,
1074      * at least with the new threading code.
1075      */
1076     if (purge || (ctx->magic != M_MAILDIR && ctx->magic != M_MH)) {
1077 #ifdef USE_IMAP
1078       /* IMAP does this automatically after handling EXPUNGE */
1079       if (ctx->magic != M_IMAP)
1080 #endif
1081       {
1082         mx_update_tables (ctx, 1);
1083         mutt_sort_headers (ctx, 1);     /* rethread from scratch */
1084       }
1085     }
1086   }
1087
1088   return (rc);
1089 }
1090
1091 int mx_sync_mailbox (CONTEXT* ctx, int* index_hint) {
1092   int ret = _mx_sync_mailbox (ctx, index_hint);
1093   sidebar_set_buffystats (ctx);
1094   return (ret);
1095 }
1096
1097 /* args:
1098  *      dest    destintation mailbox
1099  *      hdr     message being copied (required for maildir support, because
1100  *              the filename depends on the message flags)
1101  */
1102 MESSAGE *mx_open_new_message (CONTEXT * dest, HEADER * hdr, int flags)
1103 {
1104   MESSAGE *msg;
1105   address_t *p = NULL;
1106
1107   if (!MX_IDX(dest->magic-1)) {
1108     debug_print (1, ("function unimplemented for mailbox type %d.\n", dest->magic));
1109     return (NULL);
1110   }
1111
1112   msg = p_new(MESSAGE, 1);
1113   msg->magic = dest->magic;
1114   msg->write = 1;
1115
1116   if (hdr) {
1117     msg->flags.flagged = hdr->flagged;
1118     msg->flags.replied = hdr->replied;
1119     msg->flags.read = hdr->read;
1120     msg->received = hdr->received;
1121   }
1122
1123   if (msg->received == 0)
1124     time (&msg->received);
1125
1126   if (MX_COMMAND(dest->magic-1,mx_open_new_message)(msg, dest, hdr) == 0) {
1127     if (dest->magic == M_MMDF)
1128       fputs (MMDF_SEP, msg->fp);
1129
1130     if ((msg->magic == M_MBOX || msg->magic == M_MMDF) && flags & M_ADD_FROM) {
1131       if (hdr) {
1132         if (hdr->env->return_path)
1133           p = hdr->env->return_path;
1134         else if (hdr->env->sender)
1135           p = hdr->env->sender;
1136         else
1137           p = hdr->env->from;
1138       }
1139
1140       fprintf (msg->fp, "From %s %s", p ? p->mailbox : NONULL (Username),
1141                ctime (&msg->received));
1142     }
1143   }
1144   else
1145     p_delete(&msg);
1146
1147   return msg;
1148 }
1149
1150 /* check for new mail */
1151 int mx_check_mailbox (CONTEXT * ctx, int *index_hint, int lock) {
1152   if (ctx->compressinfo)
1153     return mutt_check_mailbox_compressed (ctx);
1154
1155   if (ctx) {
1156     if (ctx->locked)
1157       lock = 0;
1158     if (MX_IDX(ctx->magic-1) && MX_COMMAND(ctx->magic-1,mx_check_mailbox))
1159       return (MX_COMMAND(ctx->magic-1,mx_check_mailbox)(ctx, index_hint, lock));
1160   }
1161
1162   debug_print (1, ("null or invalid context.\n"));
1163   return (-1);
1164
1165 }
1166
1167 /* return a stream pointer for a message */
1168 MESSAGE *mx_open_message (CONTEXT * ctx, int msgno)
1169 {
1170   MESSAGE *msg;
1171
1172   msg = p_new(MESSAGE, 1);
1173   switch (msg->magic = ctx->magic) {
1174   case M_MBOX:
1175   case M_MMDF:
1176     msg->fp = ctx->fp;
1177     break;
1178
1179   case M_MH:
1180   case M_MAILDIR:
1181     {
1182       HEADER *cur = ctx->hdrs[msgno];
1183       char path[_POSIX_PATH_MAX];
1184
1185       snprintf (path, sizeof (path), "%s/%s", ctx->path, cur->path);
1186
1187       if ((msg->fp = fopen (path, "r")) == NULL && errno == ENOENT &&
1188           ctx->magic == M_MAILDIR)
1189         msg->fp = maildir_open_find_message (ctx->path, cur->path);
1190
1191       if (msg->fp == NULL) {
1192         mutt_perror (path);
1193         debug_print (1, ("fopen: %s: %s (errno %d).\n", path, strerror (errno), errno));
1194         p_delete(&msg);
1195       }
1196     }
1197     break;
1198
1199 #ifdef USE_IMAP
1200   case M_IMAP:
1201     {
1202       if (imap_fetch_message (msg, ctx, msgno) != 0)
1203         p_delete(&msg);
1204       break;
1205     }
1206 #endif /* USE_IMAP */
1207
1208   case M_POP:
1209     {
1210       if (pop_fetch_message (msg, ctx, msgno) != 0)
1211         p_delete(&msg);
1212       break;
1213     }
1214
1215 #ifdef USE_NNTP
1216   case M_NNTP:
1217     {
1218       if (nntp_fetch_message (msg, ctx, msgno) != 0)
1219         p_delete(&msg);
1220       break;
1221     }
1222 #endif /* USE_NNTP */
1223
1224   default:
1225     debug_print (1, ("function not implemented for mailbox type %d.\n", ctx->magic));
1226     p_delete(&msg);
1227     break;
1228   }
1229   return (msg);
1230 }
1231
1232 /* commit a message to a folder */
1233
1234 int mx_commit_message (MESSAGE * msg, CONTEXT * ctx) {
1235   if (!(msg->write && ctx->append)) {
1236     debug_print (1, ("msg->write = %d, ctx->append = %d\n", msg->write, ctx->append));
1237     return -1;
1238   }
1239   if (!ctx || !MX_IDX(ctx->magic-1) || !MX_COMMAND(ctx->magic-1,mx_commit_message))
1240     return (-1);
1241   return (MX_COMMAND(ctx->magic-1,mx_commit_message) (msg, ctx));
1242 }
1243
1244 /* close a pointer to a message */
1245 int mx_close_message (MESSAGE ** msg)
1246 {
1247   int r = 0;
1248
1249   if ((*msg)->magic == M_MH || (*msg)->magic == M_MAILDIR
1250 #ifdef USE_IMAP
1251       || (*msg)->magic == M_IMAP
1252 #endif
1253       || (*msg)->magic == M_POP
1254 #ifdef USE_NNTP
1255       || (*msg)->magic == M_NNTP
1256 #endif
1257     ) {
1258     r = safe_fclose (&(*msg)->fp);
1259   }
1260   else
1261     (*msg)->fp = NULL;
1262
1263   if ((*msg)->path) {
1264     debug_print (1, ("unlinking %s\n", (*msg)->path));
1265     unlink ((*msg)->path);
1266     p_delete(&(*msg)->path);
1267   }
1268
1269   p_delete(msg);
1270   return (r);
1271 }
1272
1273 void mx_alloc_memory (CONTEXT * ctx)
1274 {
1275   int i;
1276   size_t s = MAX (sizeof (HEADER *), sizeof (int));
1277
1278   if ((ctx->hdrmax + 25) * s < ctx->hdrmax * s) {
1279     mutt_error _("Integer overflow -- can't allocate memory.");
1280
1281     sleep (1);
1282     mutt_exit (1);
1283   }
1284
1285   if (ctx->hdrs) {
1286     p_realloc(&ctx->hdrs, ctx->hdrmax += 25);
1287     p_realloc(&ctx->v2r, ctx->hdrmax);
1288   }
1289   else {
1290     ctx->hdrs = p_new(HEADER *, (ctx->hdrmax += 25));
1291     ctx->v2r = p_new(int, ctx->hdrmax);
1292   }
1293   for (i = ctx->msgcount; i < ctx->hdrmax; i++) {
1294     ctx->hdrs[i] = NULL;
1295     ctx->v2r[i] = -1;
1296   }
1297 }
1298
1299 /* this routine is called to update the counts in the context structure for
1300  * the last message header parsed.
1301  */
1302 void mx_update_context (CONTEXT * ctx, int new_messages)
1303 {
1304   HEADER *h;
1305   int msgno;
1306
1307   for (msgno = ctx->msgcount - new_messages; msgno < ctx->msgcount; msgno++) {
1308     h = ctx->hdrs[msgno];
1309
1310     /* NOTE: this _must_ be done before the check for mailcap! */
1311     h->security = crypt_query (h->content);
1312
1313     if (!ctx->pattern) {
1314       ctx->v2r[ctx->vcount] = msgno;
1315       h->virtual = ctx->vcount++;
1316     }
1317     else
1318       h->virtual = -1;
1319     h->msgno = msgno;
1320
1321     if (h->env->supersedes) {
1322       HEADER *h2;
1323
1324       if (!ctx->id_hash)
1325         ctx->id_hash = mutt_make_id_hash (ctx);
1326
1327       h2 = hash_find (ctx->id_hash, h->env->supersedes);
1328
1329       /* p_delete(&h->env->supersedes); should I ? */
1330       if (h2) {
1331         h2->superseded = 1;
1332         if (!ctx->counting && option (OPTSCORE))
1333           mutt_score_message (ctx, h2, 1);
1334       }
1335     }
1336
1337     /* add this message to the hash tables */
1338     if (ctx->id_hash && h->env->message_id)
1339       hash_insert (ctx->id_hash, h->env->message_id, h, 0);
1340     if (!ctx->counting) {
1341       if (ctx->subj_hash && h->env->real_subj)
1342         hash_insert (ctx->subj_hash, h->env->real_subj, h, 1);
1343
1344       if (option (OPTSCORE))
1345         mutt_score_message (ctx, h, 0);
1346     }
1347
1348     if (h->changed)
1349       ctx->changed = 1;
1350     if (h->flagged)
1351       ctx->flagged++;
1352     if (h->deleted)
1353       ctx->deleted++;
1354     if (!h->read) {
1355       ctx->unread++;
1356       if (!h->old)
1357         ctx->new++;
1358     }
1359   }
1360   /* update sidebar count */
1361   sidebar_set_buffystats (ctx);
1362 }
1363
1364 /*
1365  * Return:
1366  * 1 if the specified mailbox contains 0 messages.
1367  * 0 if the mailbox contains messages
1368  * -1 on error
1369  */
1370 int mx_check_empty (const char *path)
1371 {
1372   int i = 0;
1373   if ((i = mx_get_idx (path)) >= 0 && MX_COMMAND(i,mx_check_empty))
1374     return (MX_COMMAND(i,mx_check_empty)(path));
1375   errno = EINVAL;
1376   return (-1);
1377 }
1378
1379 int mx_acl_check (CONTEXT* ctx, int flag) {
1380   if (!ctx || !MX_IDX(ctx->magic-1))
1381     return (0);
1382   /* if no acl_check defined for module, assume permission is granted */
1383   if (!MX_COMMAND(ctx->magic-1,mx_acl_check))
1384     return (1);
1385   return (MX_COMMAND(ctx->magic-1,mx_acl_check)(ctx,flag));
1386 }
1387
1388 void mx_init (void) {
1389 #ifdef DEBUG
1390   int i = 0;
1391 #endif
1392   list_push_back (&MailboxFormats, (void*) mbox_reg_mx ());
1393   list_push_back (&MailboxFormats, (void*) mmdf_reg_mx ());
1394   list_push_back (&MailboxFormats, (void*) mh_reg_mx ());
1395   list_push_back (&MailboxFormats, (void*) maildir_reg_mx ());
1396 #ifdef USE_IMAP
1397   list_push_back (&MailboxFormats, (void*) imap_reg_mx ());
1398 #endif
1399   list_push_back (&MailboxFormats, (void*) pop_reg_mx ());
1400 #ifdef USE_NNTP
1401   list_push_back (&MailboxFormats, (void*) nntp_reg_mx ());
1402 #endif
1403   list_push_back (&MailboxFormats, (void*) compress_reg_mx ());
1404 #ifdef DEBUG
1405   /* check module registration for completeness with debug versions */
1406 #define EXITWITHERR(m) do { fprintf(stderr, "error: incomplete mx module: %s is missing for type %i\n",m,i);exit(1); } while (0)
1407   for (i = 0; i < MailboxFormats->length; i++) {
1408     if (MX_COMMAND(i,type) < 1)         EXITWITHERR("type");
1409     if (!MX_COMMAND(i,mx_is_magic))     EXITWITHERR("mx_is_magic");
1410     if (!MX_COMMAND(i,mx_open_mailbox)) EXITWITHERR("mx_open_mailbox");
1411 /*    if (!MX_COMMAND(i,mx_sync_mailbox)) EXITWITHERR("mx_sync_mailbox");*/
1412   }
1413 #undef EXITWITHERR
1414 #endif /* DEBUG */
1415 }
1416
1417 int mx_rebuild_cache (void) {
1418 #ifndef USE_HCACHE
1419   mutt_error (_("Support for header caching was not build in."));
1420   return (1);
1421 #else
1422   int i = 0, magic = 0;
1423   CONTEXT* ctx = NULL;
1424   BUFFY* b = NULL;
1425
1426   if (list_empty(Incoming)) {
1427     mutt_error (_("No mailboxes defined."));
1428     return (1);
1429   }
1430
1431   for (i = 0; i < Incoming->length; i++) {
1432     b = (BUFFY*) Incoming->data[i];
1433     magic = mx_get_magic (b->path);
1434     if (magic != M_MAILDIR && magic != M_MH
1435 #ifdef USE_IMAP
1436         && magic != M_IMAP
1437 #endif
1438     )
1439       continue;
1440     sidebar_set_current (b->path);
1441     sidebar_draw (CurrentMenu);
1442     if ((ctx = mx_open_mailbox (b->path,
1443                                 M_READONLY | M_NOSORT | M_COUNT,
1444                                 NULL)) != NULL)
1445       mx_close_mailbox (ctx, 0);
1446   }
1447   mutt_clear_error ();
1448
1449   if (Context && Context->path)
1450     sidebar_set_current (Context->path);
1451   sidebar_draw (CurrentMenu);
1452
1453   return (0);
1454 #endif
1455 }