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