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
  35 #ifdef USE_COMPRESSED
  36 #include "compress.h"
  37 #endif
  38
  39 #ifdef USE_IMAP
  40 #include "imap/imap.h"
  41 #include "imap/mx_imap.h"
  42 #endif
  43
  44 #ifdef USE_POP
  45 #include "pop/pop.h"
  46 #include "pop/mx_pop.h"
  47 #endif
  48
  49 #ifdef USE_NNTP
  50 #include "nntp/nntp.h"
  51 #include "nntp/mx_nntp.h"
  52 #endif
  53
  54 #ifdef USE_DOTLOCK
  55 #include "dotlock.h"
  56 #endif
  57
  58 #include "mutt_crypt.h"
  59
  60 #include "lib/list.h"
  61 #include "lib/debug.h"
  62
  63 #include <dirent.h>
  64 #include <fcntl.h>
  65 #include <sys/file.h>
  66 #include <sys/stat.h>
  67 #include <errno.h>
  68 #include <unistd.h>
  69 #include <stdlib.h>
  70 #include <string.h>
  71 #include <ctype.h>
  72 #include <utime.h>
  73
  74 static list2_t* MailboxFormats = NULL;
  75 #define MX_COMMAND(idx,cmd) ((mx_t*) MailboxFormats->data[idx])->cmd
  76 #define MX_IDX(idx) (idx >= 0 && idx < MailboxFormats->length)
  77
  78 #define mutt_is_spool(s)  (m_strcmp(Spoolfile, s) == 0)
  79
  80 #ifdef USE_DOTLOCK
  81 /* parameters:
  82  * path - file to lock
  83  * retry - should retry if unable to lock?
  84  */
  85
  86 #ifdef DL_STANDALONE
  87
  88 static int invoke_dotlock (const char *path, int dummy, int flags, int retry)
  89 {
  90   char cmd[LONG_STRING + _POSIX_PATH_MAX];
  91   char f[SHORT_STRING + _POSIX_PATH_MAX];
  92   char r[SHORT_STRING];
  93
  94   if (flags & DL_FL_RETRY)
  95     snprintf (r, sizeof (r), "-r %d ", retry ? MAXLOCKATTEMPT : 0);
  96
  97   mutt_quote_filename (f, sizeof (f), path);
  98
  99   snprintf (cmd, sizeof (cmd),
 100             "%s %s%s%s%s%s%s%s",
 101             NONULL (MuttDotlock),
 102             flags & DL_FL_TRY ? "-t " : "",
 103             flags & DL_FL_UNLOCK ? "-u " : "",
 104             flags & DL_FL_USEPRIV ? "-p " : "",
 105             flags & DL_FL_FORCE ? "-f " : "",
 106             flags & DL_FL_UNLINK ? "-d " : "",
 107             flags & DL_FL_RETRY ? r : "", f);
 108
 109   return mutt_system (cmd);
 110 }
 111
 112 #else
 113
 114 #define invoke_dotlock dotlock_invoke
 115
 116 #endif
 117
 118 static int dotlock_file (const char *path, int fd, int retry)
 119 {
 120   int r;
 121   int flags = DL_FL_USEPRIV | DL_FL_RETRY;
 122
 123   if (retry)
 124     retry = 1;
 125
 126 retry_lock:
 127   if ((r = invoke_dotlock (path, fd, flags, retry)) == DL_EX_EXIST) {
 128     if (!option (OPTNOCURSES)) {
 129       char msg[LONG_STRING];
 130
 131       snprintf (msg, sizeof (msg),
 132                 _("Lock count exceeded, remove lock for %s?"), path);
 133       if (retry && mutt_yesorno (msg, M_YES) == M_YES) {
 134         flags |= DL_FL_FORCE;
 135         retry--;
 136         mutt_clear_error ();
 137         goto retry_lock;
 138       }
 139     }
 140     else {
 141       mutt_error (_("Can't dotlock %s.\n"), path);
 142     }
 143   }
 144   return (r == DL_EX_OK ? 0 : -1);
 145 }
 146
 147 static int undotlock_file (const char *path, int fd)
 148 {
 149   return (invoke_dotlock (path, fd, DL_FL_USEPRIV | DL_FL_UNLOCK, 0) ==
 150           DL_EX_OK ? 0 : -1);
 151 }
 152
 153 #endif /* USE_DOTLOCK */
 154
 155 /* looks up index of type for path in MailboxFormats */
 156 static int mx_get_idx (const char* path) {
 157   int i = 0, t = 0;
 158   struct stat st;
 159
 160   /* first, test all non-local folders to avoid stat() call */
 161   for (i = 0; i < MailboxFormats->length; i++) {
 162     if (!MX_COMMAND(i,local))
 163       t = MX_COMMAND(i,mx_is_magic)(path, NULL);
 164     if (t >= 1)
 165       return (t-1);
 166   }
 167   if (stat (path, &st) == 0) {
 168     /* if stat() succeeded, keep testing until success and
 169      * pass stat() info so that we only need to do it once */
 170     for (i = 0; i < MailboxFormats->length; i++) {
 171       if (MX_COMMAND(i,local))
 172         t = MX_COMMAND(i,mx_is_magic)(path, &st);
 173       if (t >= 1)
 174         return (t-1);
 175     }
 176   }
 177   return (-1);
 178 }
 179
 180 /* Args:
 181  *      excl            if excl != 0, request an exclusive lock
 182  *      dot             if dot != 0, try to dotlock the file
 183  *      timeout         should retry locking?
 184  */
 185 int mx_lock_file (const char *path, int fd, int excl, int dot, int timeout)
 186 {
 187 #if defined (USE_FCNTL) || defined (USE_FLOCK)
 188   int count;
 189   int attempt;
 190   struct stat prev_sb;
 191 #endif
 192   int r = 0;
 193
 194 #ifdef USE_FCNTL
 195   struct flock lck;
 196
 197
 198   p_clear(&lck, 1);
 199   lck.l_type = excl ? F_WRLCK : F_RDLCK;
 200   lck.l_whence = SEEK_SET;
 201
 202   count = 0;
 203   attempt = 0;
 204   prev_sb.st_size = 0;
 205   while (fcntl (fd, F_SETLK, &lck) == -1) {
 206     struct stat sb;
 207
 208     debug_print (1, ("fcntl errno %d.\n", errno));
 209     if (errno != EAGAIN && errno != EACCES) {
 210       mutt_perror ("fcntl");
 211       return (-1);
 212     }
 213
 214     if (fstat (fd, &sb) != 0)
 215       sb.st_size = 0;
 216
 217     if (count == 0)
 218       prev_sb = sb;
 219
 220     /* only unlock file if it is unchanged */
 221     if (prev_sb.st_size == sb.st_size
 222         && ++count >= (timeout ? MAXLOCKATTEMPT : 0)) {
 223       if (timeout)
 224         mutt_error _("Timeout exceeded while attempting fcntl lock!");
 225
 226       return (-1);
 227     }
 228
 229     prev_sb = sb;
 230
 231     mutt_message (_("Waiting for fcntl lock... %d"), ++attempt);
 232     sleep (1);
 233   }
 234 #endif /* USE_FCNTL */
 235
 236 #ifdef USE_FLOCK
 237   count = 0;
 238   attempt = 0;
 239   while (flock (fd, (excl ? LOCK_EX : LOCK_SH) | LOCK_NB) == -1) {
 240     struct stat sb;
 241
 242     if (errno != EWOULDBLOCK) {
 243       mutt_perror ("flock");
 244       r = -1;
 245       break;
 246     }
 247
 248     if (fstat (fd, &sb) != 0)
 249       sb.st_size = 0;
 250
 251     if (count == 0)
 252       prev_sb = sb;
 253
 254     /* only unlock file if it is unchanged */
 255     if (prev_sb.st_size == sb.st_size
 256         && ++count >= (timeout ? MAXLOCKATTEMPT : 0)) {
 257       if (timeout)
 258         mutt_error _("Timeout exceeded while attempting flock lock!");
 259
 260       r = -1;
 261       break;
 262     }
 263
 264     prev_sb = sb;
 265
 266     mutt_message (_("Waiting for flock attempt... %d"), ++attempt);
 267     sleep (1);
 268   }
 269 #endif /* USE_FLOCK */
 270
 271 #ifdef USE_DOTLOCK
 272   if (r == 0 && dot)
 273     r = dotlock_file (path, fd, timeout);
 274 #endif /* USE_DOTLOCK */
 275
 276   if (r == -1) {
 277     /* release any other locks obtained in this routine */
 278
 279 #ifdef USE_FCNTL
 280     lck.l_type = F_UNLCK;
 281     fcntl (fd, F_SETLK, &lck);
 282 #endif /* USE_FCNTL */
 283
 284 #ifdef USE_FLOCK
 285     flock (fd, LOCK_UN);
 286 #endif /* USE_FLOCK */
 287
 288     return (-1);
 289   }
 290
 291   return 0;
 292 }
 293
 294 int mx_unlock_file (const char *path, int fd, int dot)
 295 {
 296 #ifdef USE_FCNTL
 297   struct flock unlockit;
 298
 299   p_clear(&unlockit, 1);
 300   unlockit.l_type = F_UNLCK;
 301   unlockit.l_whence = SEEK_SET;
 302   fcntl (fd, F_SETLK, &unlockit);
 303 #endif
 304
 305 #ifdef USE_FLOCK
 306   flock (fd, LOCK_UN);
 307 #endif
 308
 309 #ifdef USE_DOTLOCK
 310   if (dot)
 311     undotlock_file (path, fd);
 312 #endif
 313
 314   return 0;
 315 }
 316
 317 void mx_unlink_empty (const char *path)
 318 {
 319   int fd;
 320
 321 #ifndef USE_DOTLOCK
 322   struct stat sb;
 323 #endif
 324
 325   if ((fd = open (path, O_RDWR)) == -1)
 326     return;
 327
 328   if (mx_lock_file (path, fd, 1, 0, 1) == -1) {
 329     close (fd);
 330     return;
 331   }
 332
 333 #ifdef USE_DOTLOCK
 334   invoke_dotlock (path, fd, DL_FL_UNLINK, 1);
 335 #else
 336   if (fstat (fd, &sb) == 0 && sb.st_size == 0)
 337     unlink (path);
 338 #endif
 339
 340   mx_unlock_file (path, fd, 0);
 341   close (fd);
 342 }
 343
 344 /* try to figure out what type of mailbox ``path'' is */
 345 int mx_get_magic (const char *path) {
 346   int i = 0;
 347
 348   if (m_strlen(path) == 0)
 349     return (-1);
 350   if ((i = mx_get_idx (path)) >= 0)
 351     return (MX_COMMAND(i,type));
 352   return (-1);
 353 }
 354
 355 int mx_is_local (int m) {
 356   if (!MX_IDX(m))
 357     return (0);
 358   return (MX_COMMAND(m,local));
 359 }
 360
 361 /*
 362  * set DefaultMagic to the given value
 363  */
 364 int mx_set_magic (const char *s)
 365 {
 366   if (ascii_strcasecmp (s, "mbox") == 0)
 367     DefaultMagic = M_MBOX;
 368   else if (ascii_strcasecmp (s, "mmdf") == 0)
 369     DefaultMagic = M_MMDF;
 370   else if (ascii_strcasecmp (s, "mh") == 0)
 371     DefaultMagic = M_MH;
 372   else if (ascii_strcasecmp (s, "maildir") == 0)
 373     DefaultMagic = M_MAILDIR;
 374   else
 375     return (-1);
 376
 377   return 0;
 378 }
 379
 380 /* mx_access: Wrapper for access, checks permissions on a given mailbox.
 381  *   We may be interested in using ACL-style flags at some point, currently
 382  *   we use the normal access() flags. */
 383 int mx_access (const char *path, int flags)
 384 {
 385   int i = 0;
 386
 387   if ((i = mx_get_idx (path)) >= 0 && MX_COMMAND(i,mx_access))
 388     return (MX_COMMAND(i,mx_access)(path,flags));
 389   return (0);
 390 }
 391
 392 static int mx_open_mailbox_append (CONTEXT * ctx, int flags)
 393 {
 394   struct stat sb;
 395
 396 #ifdef USE_COMPRESSED
 397   /* special case for appending to compressed folders -
 398    * even if we can not open them for reading */
 399   if (mutt_can_append_compressed (ctx->path))
 400     mutt_open_append_compressed (ctx);
 401 #endif
 402
 403   ctx->append = 1;
 404
 405 #ifdef USE_IMAP
 406
 407   if (mx_get_magic (ctx->path) == M_IMAP)
 408     return imap_open_mailbox_append (ctx);
 409
 410 #endif
 411
 412   if (stat (ctx->path, &sb) == 0) {
 413     ctx->magic = mx_get_magic (ctx->path);
 414
 415     switch (ctx->magic) {
 416     case 0:
 417       mutt_error (_("%s is not a mailbox."), ctx->path);
 418       /* fall through */
 419     case -1:
 420       return (-1);
 421     }
 422   }
 423   else if (errno == ENOENT) {
 424     ctx->magic = DefaultMagic;
 425
 426     if (ctx->magic == M_MH || ctx->magic == M_MAILDIR) {
 427       char tmp[_POSIX_PATH_MAX];
 428
 429       if (mkdir (ctx->path, S_IRWXU)) {
 430         mutt_perror (ctx->path);
 431         return (-1);
 432       }
 433
 434       if (ctx->magic == M_MAILDIR) {
 435         snprintf (tmp, sizeof (tmp), "%s/cur", ctx->path);
 436         if (mkdir (tmp, S_IRWXU)) {
 437           mutt_perror (tmp);
 438           rmdir (ctx->path);
 439           return (-1);
 440         }
 441
 442         snprintf (tmp, sizeof (tmp), "%s/new", ctx->path);
 443         if (mkdir (tmp, S_IRWXU)) {
 444           mutt_perror (tmp);
 445           snprintf (tmp, sizeof (tmp), "%s/cur", ctx->path);
 446           rmdir (tmp);
 447           rmdir (ctx->path);
 448           return (-1);
 449         }
 450         snprintf (tmp, sizeof (tmp), "%s/tmp", ctx->path);
 451         if (mkdir (tmp, S_IRWXU)) {
 452           mutt_perror (tmp);
 453           snprintf (tmp, sizeof (tmp), "%s/cur", ctx->path);
 454           rmdir (tmp);
 455           snprintf (tmp, sizeof (tmp), "%s/new", ctx->path);
 456           rmdir (tmp);
 457           rmdir (ctx->path);
 458           return (-1);
 459         }
 460       }
 461       else {
 462         int i;
 463
 464         snprintf (tmp, sizeof (tmp), "%s/.mh_sequences", ctx->path);
 465         if ((i = creat (tmp, S_IRWXU)) == -1) {
 466           mutt_perror (tmp);
 467           rmdir (ctx->path);
 468           return (-1);
 469         }
 470         close (i);
 471       }
 472     }
 473   }
 474   else {
 475     mutt_perror (ctx->path);
 476     return (-1);
 477   }
 478
 479   switch (ctx->magic) {
 480   case M_MBOX:
 481   case M_MMDF:
 482     if ((ctx->fp =
 483          safe_fopen (ctx->path, flags & M_NEWFOLDER ? "w" : "a")) == NULL
 484         || mbox_lock_mailbox (ctx, 1, 1) != 0) {
 485       if (!ctx->fp)
 486         mutt_perror (ctx->path);
 487       else {
 488         mutt_error (_("Couldn't lock %s\n"), ctx->path);
 489         safe_fclose (&ctx->fp);
 490       }
 491       return (-1);
 492     }
 493     fseeko (ctx->fp, 0, 2);
 494     break;
 495
 496   case M_MH:
 497   case M_MAILDIR:
 498     /* nothing to do */
 499     break;
 500
 501   default:
 502     return (-1);
 503   }
 504
 505   return 0;
 506 }
 507
 508 /*
 509  * open a mailbox and parse it
 510  *
 511  * Args:
 512  *      flags   M_NOSORT        do not sort mailbox
 513  *              M_APPEND        open mailbox for appending
 514  *              M_READONLY      open mailbox in read-only mode
 515  *              M_QUIET         only print error messages
 516  *      ctx     if non-null, context struct to use
 517  */
 518 CONTEXT *mx_open_mailbox (const char *path, int flags, CONTEXT * pctx)
 519 {
 520   CONTEXT *ctx = pctx;
 521   int rc;
 522
 523   if (!ctx)
 524     ctx = p_new(CONTEXT, 1);
 525   p_clear(ctx, 1);
 526   ctx->path = m_strdup(path);
 527
 528   ctx->msgnotreadyet = -1;
 529   ctx->collapsed = 0;
 530
 531   if (flags & M_QUIET)
 532     ctx->quiet = 1;
 533   if (flags & M_READONLY)
 534     ctx->readonly = 1;
 535   if (flags & M_COUNT)
 536     ctx->counting = 1;
 537
 538   if (flags & (M_APPEND | M_NEWFOLDER)) {
 539     if (mx_open_mailbox_append (ctx, flags) != 0) {
 540       mx_fastclose_mailbox (ctx);
 541       if (!pctx)
 542         p_delete(&ctx);
 543       return NULL;
 544     }
 545     return ctx;
 546   }
 547
 548   if (!MX_IDX(ctx->magic-1))
 549     ctx->magic = mx_get_magic (path);
 550
 551 #ifdef USE_COMPRESSED
 552   if (ctx->magic == M_COMPRESSED)
 553     mutt_open_read_compressed (ctx);
 554 #endif
 555
 556   if (ctx->magic == 0)
 557     mutt_error (_("%s is not a mailbox."), path);
 558
 559   if (ctx->magic == -1)
 560     mutt_perror (path);
 561
 562   if (ctx->magic <= 0) {
 563     mx_fastclose_mailbox (ctx);
 564     if (!pctx)
 565       p_delete(&ctx);
 566     return (NULL);
 567   }
 568
 569   /* if the user has a `push' command in their .muttrc, or in a folder-hook,
 570    * it will cause the progress messages not to be displayed because
 571    * mutt_refresh() will think we are in the middle of a macro.  so set a
 572    * flag to indicate that we should really refresh the screen.
 573    */
 574   set_option (OPTFORCEREFRESH);
 575
 576   if (!ctx->quiet)
 577     mutt_message (_("Reading %s..."), ctx->path);
 578
 579   rc = MX_COMMAND(ctx->magic-1,mx_open_mailbox)(ctx);
 580
 581   if (rc == 0) {
 582     if ((flags & M_NOSORT) == 0) {
 583       /* avoid unnecessary work since the mailbox is completely unthreaded
 584          to begin with */
 585       unset_option (OPTSORTSUBTHREADS);
 586       unset_option (OPTNEEDRESCORE);
 587       mutt_sort_headers (ctx, 1);
 588     }
 589     if (!ctx->quiet)
 590       mutt_clear_error ();
 591   }
 592   else {
 593     mx_fastclose_mailbox (ctx);
 594     if (!pctx)
 595       p_delete(&ctx);
 596   }
 597
 598   unset_option (OPTFORCEREFRESH);
 599   return (ctx);
 600 }
 601
 602 /* free up memory associated with the mailbox context */
 603 void mx_fastclose_mailbox (CONTEXT * ctx)
 604 {
 605   int i;
 606
 607   if (!ctx)
 608     return;
 609
 610   if (MX_IDX(ctx->magic-1) && MX_COMMAND(ctx->magic-1,mx_fastclose_mailbox))
 611     MX_COMMAND(ctx->magic-1,mx_fastclose_mailbox(ctx));
 612   if (ctx->subj_hash)
 613     hash_destroy (&ctx->subj_hash, NULL);
 614   if (ctx->id_hash)
 615     hash_destroy (&ctx->id_hash, NULL);
 616   mutt_clear_threads (ctx);
 617   for (i = 0; i < ctx->msgcount; i++)
 618     mutt_free_header (&ctx->hdrs[i]);
 619   p_delete(&ctx->hdrs);
 620   p_delete(&ctx->v2r);
 621 #ifdef USE_COMPRESSED
 622   if (ctx->compressinfo)
 623     mutt_fast_close_compressed (ctx);
 624 #endif
 625   p_delete(&ctx->path);
 626   p_delete(&ctx->pattern);
 627   if (ctx->limit_pattern)
 628     mutt_pattern_free (&ctx->limit_pattern);
 629   safe_fclose (&ctx->fp);
 630   p_clear(ctx, 1);
 631 }
 632
 633 /* save changes to disk */
 634 static int sync_mailbox (CONTEXT * ctx, int *index_hint)
 635 {
 636   int rc = -1;
 637
 638   if (!ctx->quiet)
 639     mutt_message (_("Writing %s..."), ctx->path);
 640
 641   if (MX_IDX(ctx->magic-1))
 642     /* the 1 is only of interest for IMAP and means EXPUNGE */
 643     rc = MX_COMMAND(ctx->magic-1,mx_sync_mailbox(ctx,1,index_hint));
 644
 645 #ifdef USE_COMPRESSED
 646   if (rc == 0 && ctx->compressinfo)
 647     return mutt_sync_compressed (ctx);
 648 #endif
 649
 650   return rc;
 651 }
 652
 653 /* move deleted mails to the trash folder */
 654 static int trash_append (CONTEXT * ctx)
 655 {
 656   CONTEXT *ctx_trash;
 657   int i = 0;
 658   struct stat st, stc;
 659
 660   if (!TrashPath || !ctx->deleted ||
 661       (ctx->magic == M_MAILDIR && option (OPTMAILDIRTRASH)))
 662     return 0;
 663
 664   for (; i < ctx->msgcount && (!ctx->hdrs[i]->deleted ||
 665                                ctx->hdrs[i]->appended); i++);
 666   if (i == ctx->msgcount)
 667     return 0;                   /* nothing to be done */
 668
 669   if (mutt_save_confirm (TrashPath, &st) != 0) {
 670     mutt_error _("message(s) not deleted");
 671
 672     return -1;
 673   }
 674
 675   if (lstat (ctx->path, &stc) == 0 && stc.st_ino == st.st_ino
 676       && stc.st_dev == st.st_dev && stc.st_rdev == st.st_rdev)
 677     return 0;                   /* we are in the trash folder: simple sync */
 678
 679   if ((ctx_trash = mx_open_mailbox (TrashPath, M_APPEND, NULL)) != NULL) {
 680     for (i = 0; i < ctx->msgcount; i++)
 681       if (ctx->hdrs[i]->deleted && !ctx->hdrs[i]->appended
 682           && !ctx->hdrs[i]->purged
 683           && mutt_append_message (ctx_trash, ctx, ctx->hdrs[i], 0, 0) == -1) {
 684         mx_close_mailbox (ctx_trash, NULL);
 685         return -1;
 686       }
 687
 688     mx_close_mailbox (ctx_trash, NULL);
 689   }
 690   else {
 691     mutt_error _("Can't open trash folder");
 692
 693     return -1;
 694   }
 695
 696   return 0;
 697 }
 698
 699 /* save changes and close mailbox */
 700 static int _mx_close_mailbox (CONTEXT * ctx, int *index_hint)
 701 {
 702   int i, move_messages = 0, purge = 1, read_msgs = 0;
 703   int check;
 704   int isSpool = 0;
 705   CONTEXT f;
 706   char mbox[_POSIX_PATH_MAX];
 707   char buf[SHORT_STRING];
 708
 709   if (!ctx)
 710     return 0;
 711
 712   ctx->closing = 1;
 713
 714 #ifdef USE_NNTP
 715   if (ctx->magic == M_NNTP) {
 716     int ret;
 717
 718     ret = nntp_close_mailbox (ctx);
 719     mx_fastclose_mailbox (ctx);
 720     return ret;
 721   }
 722 #endif
 723   if (ctx->readonly || ctx->dontwrite) {
 724     /* mailbox is readonly or we don't want to write */
 725     mx_fastclose_mailbox (ctx);
 726     return 0;
 727   }
 728
 729   if (ctx->append) {
 730     /* mailbox was opened in write-mode */
 731     if (ctx->magic == M_MBOX || ctx->magic == M_MMDF)
 732       mbox_close_mailbox (ctx);
 733     else
 734       mx_fastclose_mailbox (ctx);
 735     return 0;
 736   }
 737
 738   for (i = 0; i < ctx->msgcount; i++) {
 739     if (!ctx->hdrs[i]->deleted && ctx->hdrs[i]->read
 740         && !(ctx->hdrs[i]->flagged && option (OPTKEEPFLAGGED)))
 741       read_msgs++;
 742   }
 743
 744   if (read_msgs && quadoption (OPT_MOVE) != M_NO) {
 745     char *p;
 746
 747     if ((p = mutt_find_hook (M_MBOXHOOK, ctx->path))) {
 748       isSpool = 1;
 749       m_strcpy(mbox, sizeof(mbox), p);
 750     }
 751     else {
 752       m_strcpy(mbox, sizeof(mbox), NONULL(Inbox));
 753       isSpool = mutt_is_spool (ctx->path) && !mutt_is_spool (mbox);
 754     }
 755     mutt_expand_path (mbox, sizeof (mbox));
 756
 757     if (isSpool) {
 758       snprintf (buf, sizeof (buf), _("Move read messages to %s?"), mbox);
 759       if ((move_messages = query_quadoption (OPT_MOVE, buf)) == -1) {
 760         ctx->closing = 0;
 761         return (-1);
 762       }
 763     }
 764   }
 765
 766   /*
 767    * There is no point in asking whether or not to purge if we are
 768    * just marking messages as "trash".
 769    */
 770   if (ctx->deleted && !(ctx->magic == M_MAILDIR && option (OPTMAILDIRTRASH))) {
 771     snprintf (buf, sizeof (buf), ctx->deleted == 1
 772               ? _("Purge %d deleted message?") :
 773               _("Purge %d deleted messages?"), ctx->deleted);
 774     if ((purge = query_quadoption (OPT_DELETE, buf)) < 0) {
 775       ctx->closing = 0;
 776       return (-1);
 777     }
 778   }
 779
 780 #ifdef USE_IMAP
 781   /* IMAP servers manage the OLD flag themselves */
 782   if (ctx->magic != M_IMAP)
 783 #endif
 784     if (option (OPTMARKOLD)) {
 785       for (i = 0; i < ctx->msgcount; i++) {
 786         if (!ctx->hdrs[i]->deleted && !ctx->hdrs[i]->old)
 787           mutt_set_flag (ctx, ctx->hdrs[i], M_OLD, 1);
 788       }
 789     }
 790
 791   if (move_messages) {
 792     mutt_message (_("Moving read messages to %s..."), mbox);
 793
 794 #ifdef USE_IMAP
 795     /* try to use server-side copy first */
 796     i = 1;
 797
 798     if (ctx->magic == M_IMAP && imap_is_magic (mbox, NULL) == M_IMAP) {
 799       /* tag messages for moving, and clear old tags, if any */
 800       for (i = 0; i < ctx->msgcount; i++)
 801         if (ctx->hdrs[i]->read && !ctx->hdrs[i]->deleted
 802             && !(ctx->hdrs[i]->flagged && option (OPTKEEPFLAGGED)))
 803           ctx->hdrs[i]->tagged = 1;
 804         else
 805           ctx->hdrs[i]->tagged = 0;
 806
 807       i = imap_copy_messages (ctx, NULL, mbox, 1);
 808     }
 809
 810     if (i == 0)                 /* success */
 811       mutt_clear_error ();
 812     else if (i == -1) {         /* horrible error, bail */
 813       ctx->closing = 0;
 814       return -1;
 815     }
 816     else                        /* use regular append-copy mode */
 817 #endif
 818     {
 819       if (mx_open_mailbox (mbox, M_APPEND, &f) == NULL) {
 820         ctx->closing = 0;
 821         return -1;
 822       }
 823
 824       for (i = 0; i < ctx->msgcount; i++) {
 825         if (ctx->hdrs[i]->read && !ctx->hdrs[i]->deleted
 826             && !(ctx->hdrs[i]->flagged && option (OPTKEEPFLAGGED))) {
 827           if (mutt_append_message (&f, ctx, ctx->hdrs[i], 0, CH_UPDATE_LEN) ==
 828               0) {
 829             mutt_set_flag (ctx, ctx->hdrs[i], M_DELETE, 1);
 830             mutt_set_flag (ctx, ctx->hdrs[i], M_APPENDED, 1);
 831           }
 832           else {
 833             mx_close_mailbox (&f, NULL);
 834             ctx->closing = 0;
 835             return -1;
 836           }
 837         }
 838       }
 839
 840       mx_close_mailbox (&f, NULL);
 841     }
 842
 843   }
 844   else if (!ctx->changed && ctx->deleted == 0) {
 845     mutt_message _("Mailbox is unchanged.");
 846
 847     mx_fastclose_mailbox (ctx);
 848     return 0;
 849   }
 850
 851   /* copy mails to the trash before expunging */
 852   if (purge && ctx->deleted)
 853     if (trash_append (ctx) != 0) {
 854       ctx->closing = 0;
 855       return -1;
 856     }
 857
 858 #ifdef USE_IMAP
 859   /* allow IMAP to preserve the deleted flag across sessions */
 860   if (ctx->magic == M_IMAP) {
 861     if ((check = imap_sync_mailbox (ctx, purge, index_hint)) != 0) {
 862       ctx->closing = 0;
 863       return check;
 864     }
 865   }
 866   else
 867 #endif
 868   {
 869     if (!purge) {
 870       for (i = 0; i < ctx->msgcount; i++)
 871         ctx->hdrs[i]->deleted = 0;
 872       ctx->deleted = 0;
 873     }
 874
 875     if (ctx->changed || ctx->deleted) {
 876       if ((check = sync_mailbox (ctx, index_hint)) != 0) {
 877         ctx->closing = 0;
 878         return check;
 879       }
 880     }
 881   }
 882
 883   if (move_messages)
 884     mutt_message (_("%d kept, %d moved, %d deleted."),
 885                   ctx->msgcount - ctx->deleted, read_msgs, ctx->deleted);
 886   else
 887     mutt_message (_("%d kept, %d deleted."),
 888                   ctx->msgcount - ctx->deleted, ctx->deleted);
 889
 890   if (ctx->msgcount == ctx->deleted &&
 891       (ctx->magic == M_MMDF || ctx->magic == M_MBOX) &&
 892       !mutt_is_spool (ctx->path) && !option (OPTSAVEEMPTY))
 893     mx_unlink_empty (ctx->path);
 894
 895 #ifdef USE_COMPRESSED
 896   if (ctx->compressinfo && mutt_slow_close_compressed (ctx))
 897     return (-1);
 898 #endif
 899
 900   mx_fastclose_mailbox (ctx);
 901
 902   return 0;
 903 }
 904
 905 int mx_close_mailbox (CONTEXT * ctx, int *index_hint) {
 906   int ret = 0;
 907   if (!ctx)
 908     return (0);
 909   ret = _mx_close_mailbox (ctx, index_hint);
 910   sidebar_set_buffystats (ctx);
 911   return (ret);
 912 }
 913
 914 /* update a Context structure's internal tables. */
 915
 916 void mx_update_tables (CONTEXT * ctx, int committing)
 917 {
 918   int i, j;
 919
 920   /* update memory to reflect the new state of the mailbox */
 921   ctx->vcount = 0;
 922   ctx->vsize = 0;
 923   ctx->tagged = 0;
 924   ctx->deleted = 0;
 925   ctx->new = 0;
 926   ctx->unread = 0;
 927   ctx->changed = 0;
 928   ctx->flagged = 0;
 929 #define this_body ctx->hdrs[j]->content
 930   for (i = 0, j = 0; i < ctx->msgcount; i++) {
 931     if ((committing && (!ctx->hdrs[i]->deleted ||
 932                         (ctx->magic == M_MAILDIR
 933                          && option (OPTMAILDIRTRASH)))) || (!committing
 934                                                             && ctx->hdrs[i]->
 935                                                             active)) {
 936       if (i != j) {
 937         ctx->hdrs[j] = ctx->hdrs[i];
 938         ctx->hdrs[i] = NULL;
 939       }
 940       ctx->hdrs[j]->msgno = j;
 941       if (ctx->hdrs[j]->virtual != -1) {
 942         ctx->v2r[ctx->vcount] = j;
 943         ctx->hdrs[j]->virtual = ctx->vcount++;
 944         ctx->vsize += this_body->length + this_body->offset -
 945           this_body->hdr_offset;
 946       }
 947
 948       if (committing)
 949         ctx->hdrs[j]->changed = 0;
 950       else if (ctx->hdrs[j]->changed)
 951         ctx->changed++;
 952
 953       if (!committing
 954           || (ctx->magic == M_MAILDIR && option (OPTMAILDIRTRASH))) {
 955         if (ctx->hdrs[j]->deleted)
 956           ctx->deleted++;
 957       }
 958
 959       if (ctx->hdrs[j]->tagged)
 960         ctx->tagged++;
 961       if (ctx->hdrs[j]->flagged)
 962         ctx->flagged++;
 963       if (!ctx->hdrs[j]->read) {
 964         ctx->unread++;
 965         if (!ctx->hdrs[j]->old)
 966           ctx->new++;
 967       }
 968
 969       j++;
 970     }
 971     else {
 972       if (ctx->magic == M_MH || ctx->magic == M_MAILDIR)
 973         ctx->size -= (ctx->hdrs[i]->content->length +
 974                       ctx->hdrs[i]->content->offset -
 975                       ctx->hdrs[i]->content->hdr_offset);
 976       /* remove message from the hash tables */
 977       if (ctx->subj_hash && ctx->hdrs[i]->env->real_subj)
 978         hash_delete (ctx->subj_hash, ctx->hdrs[i]->env->real_subj,
 979                      ctx->hdrs[i], NULL);
 980       if (ctx->id_hash && ctx->hdrs[i]->env->message_id)
 981         hash_delete (ctx->id_hash, ctx->hdrs[i]->env->message_id,
 982                      ctx->hdrs[i], NULL);
 983       mutt_free_header (&ctx->hdrs[i]);
 984     }
 985   }
 986 #undef this_body
 987   ctx->msgcount = j;
 988
 989   /* update sidebar count */
 990   sidebar_set_buffystats (ctx);
 991 }
 992
 993
 994 /* save changes to mailbox
 995  *
 996  * return values:
 997  *      0               success
 998  *      -1              error
 999  */
1000 static int _mx_sync_mailbox (CONTEXT * ctx, int *index_hint)
1001 {
1002   int rc, i;
1003   int purge = 1;
1004   int msgcount, deleted;
1005
1006   if (ctx->dontwrite) {
1007     char buf[STRING], tmp[STRING];
1008
1009     if (km_expand_key (buf, sizeof (buf),
1010                        km_find_func (MENU_MAIN, OP_TOGGLE_WRITE)))
1011       snprintf (tmp, sizeof (tmp), _(" Press '%s' to toggle write"), buf);
1012     else
1013       m_strcpy(tmp, sizeof(tmp), _("Use 'toggle-write' to re-enable write!"));
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_t *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     p_realloc(&ctx->hdrs, ctx->hdrmax += 25);
1314     p_realloc(&ctx->v2r, 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 }