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>
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.
33 #include "imap/imap.h"
34 #include "imap/mx_imap.h"
39 #include "pop/mx_pop.h"
43 #include "nntp/nntp.h"
44 #include "nntp/mx_nntp.h"
55 #include "mutt_crypt.h"
61 #include "lib/debug.h"
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)
78 #define mutt_is_spool(s) (str_cmp (Spoolfile, s) == 0)
83 * retry - should retry if unable to lock?
88 static int invoke_dotlock (const char *path, int dummy, int flags, int retry)
90 char cmd[LONG_STRING + _POSIX_PATH_MAX];
91 char f[SHORT_STRING + _POSIX_PATH_MAX];
94 if (flags & DL_FL_RETRY)
95 snprintf (r, sizeof (r), "-r %d ", retry ? MAXLOCKATTEMPT : 0);
97 mutt_quote_filename (f, sizeof (f), path);
99 snprintf (cmd, sizeof (cmd),
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);
109 return mutt_system (cmd);
114 #define invoke_dotlock dotlock_invoke
118 static int dotlock_file (const char *path, int fd, int retry)
121 int flags = DL_FL_USEPRIV | DL_FL_RETRY;
127 if ((r = invoke_dotlock (path, fd, flags, retry)) == DL_EX_EXIST) {
128 if (!option (OPTNOCURSES)) {
129 char msg[LONG_STRING];
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;
141 mutt_error (_("Can't dotlock %s.\n"), path);
144 return (r == DL_EX_OK ? 0 : -1);
147 static int undotlock_file (const char *path, int fd)
149 return (invoke_dotlock (path, fd, DL_FL_USEPRIV | DL_FL_UNLOCK, 0) ==
153 #endif /* USE_DOTLOCK */
155 /* looks up index of type for path in MailboxFormats */
156 static int mx_get_idx (const char* path) {
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);
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);
181 * excl if excl != 0, request an exclusive lock
182 * dot if dot != 0, try to dotlock the file
183 * timeout should retry locking?
185 int mx_lock_file (const char *path, int fd, int excl, int dot, int timeout)
187 #if defined (USE_FCNTL) || defined (USE_FLOCK)
198 memset (&lck, 0, sizeof (struct flock));
199 lck.l_type = excl ? F_WRLCK : F_RDLCK;
200 lck.l_whence = SEEK_SET;
204 while (fcntl (fd, F_SETLK, &lck) == -1) {
207 debug_print (1, ("fcntl errno %d.\n", errno));
208 if (errno != EAGAIN && errno != EACCES) {
209 mutt_perror ("fcntl");
213 if (fstat (fd, &sb) != 0)
219 /* only unlock file if it is unchanged */
220 if (prev_sb.st_size == sb.st_size
221 && ++count >= (timeout ? MAXLOCKATTEMPT : 0)) {
223 mutt_error _("Timeout exceeded while attempting fcntl lock!");
230 mutt_message (_("Waiting for fcntl lock... %d"), ++attempt);
233 #endif /* USE_FCNTL */
238 while (flock (fd, (excl ? LOCK_EX : LOCK_SH) | LOCK_NB) == -1) {
241 if (errno != EWOULDBLOCK) {
242 mutt_perror ("flock");
247 if (fstat (fd, &sb) != 0)
253 /* only unlock file if it is unchanged */
254 if (prev_sb.st_size == sb.st_size
255 && ++count >= (timeout ? MAXLOCKATTEMPT : 0)) {
257 mutt_error _("Timeout exceeded while attempting flock lock!");
265 mutt_message (_("Waiting for flock attempt... %d"), ++attempt);
268 #endif /* USE_FLOCK */
272 r = dotlock_file (path, fd, timeout);
273 #endif /* USE_DOTLOCK */
276 /* release any other locks obtained in this routine */
279 lck.l_type = F_UNLCK;
280 fcntl (fd, F_SETLK, &lck);
281 #endif /* USE_FCNTL */
285 #endif /* USE_FLOCK */
293 int mx_unlock_file (const char *path, int fd, int dot)
296 struct flock unlockit = { F_UNLCK, 0, 0, 0 };
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);
310 undotlock_file (path, fd);
316 void mx_unlink_empty (const char *path)
324 if ((fd = open (path, O_RDWR)) == -1)
327 if (mx_lock_file (path, fd, 1, 0, 1) == -1) {
333 invoke_dotlock (path, fd, DL_FL_UNLINK, 1);
335 if (fstat (fd, &sb) == 0 && sb.st_size == 0)
339 mx_unlock_file (path, fd, 0);
343 /* try to figure out what type of mailbox ``path'' is */
344 int mx_get_magic (const char *path) {
347 if (str_len (path) == 0)
349 if ((i = mx_get_idx (path)) >= 0)
350 return (MX_COMMAND(i,type));
354 int mx_is_local (int m) {
357 return (MX_COMMAND(m,local));
361 * set DefaultMagic to the given value
363 int mx_set_magic (const char *s)
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)
371 else if (ascii_strcasecmp (s, "maildir") == 0)
372 DefaultMagic = M_MAILDIR;
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)
386 if ((i = mx_get_idx (path)) >= 0 && MX_COMMAND(i,mx_access))
387 return (MX_COMMAND(i,mx_access)(path,flags));
391 static int mx_open_mailbox_append (CONTEXT * ctx, int flags)
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);
406 if (mx_get_magic (ctx->path) == M_IMAP)
407 return imap_open_mailbox_append (ctx);
411 if (stat (ctx->path, &sb) == 0) {
412 ctx->magic = mx_get_magic (ctx->path);
414 switch (ctx->magic) {
416 mutt_error (_("%s is not a mailbox."), ctx->path);
422 else if (errno == ENOENT) {
423 ctx->magic = DefaultMagic;
425 if (ctx->magic == M_MH || ctx->magic == M_MAILDIR) {
426 char tmp[_POSIX_PATH_MAX];
428 if (mkdir (ctx->path, S_IRWXU)) {
429 mutt_perror (ctx->path);
433 if (ctx->magic == M_MAILDIR) {
434 snprintf (tmp, sizeof (tmp), "%s/cur", ctx->path);
435 if (mkdir (tmp, S_IRWXU)) {
441 snprintf (tmp, sizeof (tmp), "%s/new", ctx->path);
442 if (mkdir (tmp, S_IRWXU)) {
444 snprintf (tmp, sizeof (tmp), "%s/cur", ctx->path);
449 snprintf (tmp, sizeof (tmp), "%s/tmp", ctx->path);
450 if (mkdir (tmp, S_IRWXU)) {
452 snprintf (tmp, sizeof (tmp), "%s/cur", ctx->path);
454 snprintf (tmp, sizeof (tmp), "%s/new", ctx->path);
463 snprintf (tmp, sizeof (tmp), "%s/.mh_sequences", ctx->path);
464 if ((i = creat (tmp, S_IRWXU)) == -1) {
474 mutt_perror (ctx->path);
478 switch (ctx->magic) {
482 safe_fopen (ctx->path, flags & M_NEWFOLDER ? "w" : "a")) == NULL
483 || mbox_lock_mailbox (ctx, 1, 1) != 0) {
485 mutt_perror (ctx->path);
487 mutt_error (_("Couldn't lock %s\n"), ctx->path);
488 safe_fclose (&ctx->fp);
492 fseek (ctx->fp, 0, 2);
508 * open a mailbox and parse it
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
517 CONTEXT *mx_open_mailbox (const char *path, int flags, CONTEXT * pctx)
523 ctx = mem_malloc (sizeof (CONTEXT));
524 memset (ctx, 0, sizeof (CONTEXT));
525 ctx->path = str_dup (path);
527 ctx->msgnotreadyet = -1;
532 if (flags & M_READONLY)
537 if (flags & (M_APPEND | M_NEWFOLDER)) {
538 if (mx_open_mailbox_append (ctx, flags) != 0) {
539 mx_fastclose_mailbox (ctx);
547 if (!MX_IDX(ctx->magic-1))
548 ctx->magic = mx_get_magic (path);
550 #ifdef USE_COMPRESSED
551 if (ctx->magic == M_COMPRESSED)
552 mutt_open_read_compressed (ctx);
556 mutt_error (_("%s is not a mailbox."), path);
558 if (ctx->magic == -1)
561 if (ctx->magic <= 0) {
562 mx_fastclose_mailbox (ctx);
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.
573 set_option (OPTFORCEREFRESH);
576 mutt_message (_("Reading %s..."), ctx->path);
578 rc = MX_COMMAND(ctx->magic-1,mx_open_mailbox)(ctx);
581 if ((flags & M_NOSORT) == 0) {
582 /* avoid unnecessary work since the mailbox is completely unthreaded
584 unset_option (OPTSORTSUBTHREADS);
585 unset_option (OPTNEEDRESCORE);
586 mutt_sort_headers (ctx, 1);
592 mx_fastclose_mailbox (ctx);
597 unset_option (OPTFORCEREFRESH);
601 /* free up memory associated with the mailbox context */
602 void mx_fastclose_mailbox (CONTEXT * ctx)
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));
612 hash_destroy (&ctx->subj_hash, NULL);
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 mem_free (&ctx->hdrs);
619 mem_free (&ctx->v2r);
620 #ifdef USE_COMPRESSED
621 if (ctx->compressinfo)
622 mutt_fast_close_compressed (ctx);
624 mem_free (&ctx->path);
625 mem_free (&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));
632 /* save changes to disk */
633 static int sync_mailbox (CONTEXT * ctx, int *index_hint)
638 mutt_message (_("Writing %s..."), ctx->path);
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));
644 #ifdef USE_COMPRESSED
645 if (rc == 0 && ctx->compressinfo)
646 return mutt_sync_compressed (ctx);
652 /* move deleted mails to the trash folder */
653 static int trash_append (CONTEXT * ctx)
659 if (!TrashPath || !ctx->deleted ||
660 (ctx->magic == M_MAILDIR && option (OPTMAILDIRTRASH)))
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 */
668 if (mutt_save_confirm (TrashPath, &st) != 0) {
669 mutt_error _("message(s) not deleted");
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 */
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);
687 mx_close_mailbox (ctx_trash, NULL);
690 mutt_error _("Can't open trash folder");
698 /* save changes and close mailbox */
699 int mx_close_mailbox (CONTEXT * ctx, int *index_hint)
701 int i, move_messages = 0, purge = 1, read_msgs = 0;
705 char mbox[_POSIX_PATH_MAX];
706 char buf[SHORT_STRING];
714 if (ctx->magic == M_NNTP) {
717 ret = nntp_close_mailbox (ctx);
718 mx_fastclose_mailbox (ctx);
722 if (ctx->readonly || ctx->dontwrite) {
723 /* mailbox is readonly or we don't want to write */
724 mx_fastclose_mailbox (ctx);
729 /* mailbox was opened in write-mode */
730 if (ctx->magic == M_MBOX || ctx->magic == M_MMDF)
731 mbox_close_mailbox (ctx);
733 mx_fastclose_mailbox (ctx);
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)))
743 if (read_msgs && quadoption (OPT_MOVE) != M_NO) {
746 if ((p = mutt_find_hook (M_MBOXHOOK, ctx->path))) {
748 strfcpy (mbox, p, sizeof (mbox));
751 strfcpy (mbox, NONULL (Inbox), sizeof (mbox));
752 isSpool = mutt_is_spool (ctx->path) && !mutt_is_spool (mbox);
754 mutt_expand_path (mbox, sizeof (mbox));
757 snprintf (buf, sizeof (buf), _("Move read messages to %s?"), mbox);
758 if ((move_messages = query_quadoption (OPT_MOVE, buf)) == -1) {
766 * There is no point in asking whether or not to purge if we are
767 * just marking messages as "trash".
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) {
780 /* IMAP servers manage the OLD flag themselves */
781 if (ctx->magic != M_IMAP)
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);
791 mutt_message (_("Moving read messages to %s..."), mbox);
794 /* try to use server-side copy first */
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;
804 ctx->hdrs[i]->tagged = 0;
806 i = imap_copy_messages (ctx, NULL, mbox, 1);
809 if (i == 0) /* success */
811 else if (i == -1) { /* horrible error, bail */
815 else /* use regular append-copy mode */
818 if (mx_open_mailbox (mbox, M_APPEND, &f) == NULL) {
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) ==
828 mutt_set_flag (ctx, ctx->hdrs[i], M_DELETE, 1);
829 mutt_set_flag (ctx, ctx->hdrs[i], M_APPENDED, 1);
832 mx_close_mailbox (&f, NULL);
839 mx_close_mailbox (&f, NULL);
843 else if (!ctx->changed && ctx->deleted == 0) {
844 mutt_message _("Mailbox is unchanged.");
846 mx_fastclose_mailbox (ctx);
850 /* copy mails to the trash before expunging */
851 if (purge && ctx->deleted)
852 if (trash_append (ctx) != 0) {
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) {
869 for (i = 0; i < ctx->msgcount; i++)
870 ctx->hdrs[i]->deleted = 0;
874 if (ctx->changed || ctx->deleted) {
875 if ((check = sync_mailbox (ctx, index_hint)) != 0) {
883 mutt_message (_("%d kept, %d moved, %d deleted."),
884 ctx->msgcount - ctx->deleted, read_msgs, ctx->deleted);
886 mutt_message (_("%d kept, %d deleted."),
887 ctx->msgcount - ctx->deleted, ctx->deleted);
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);
894 #ifdef USE_COMPRESSED
895 if (ctx->compressinfo && mutt_slow_close_compressed (ctx))
899 mx_fastclose_mailbox (ctx);
905 /* update a Context structure's internal tables. */
907 void mx_update_tables (CONTEXT * ctx, int committing)
911 /* update memory to reflect the new state of the mailbox */
920 #define this_body ctx->hdrs[j]->content
921 for (i = 0, j = 0; i < ctx->msgcount; i++) {
922 if ((committing && (!ctx->hdrs[i]->deleted ||
923 (ctx->magic == M_MAILDIR
924 && option (OPTMAILDIRTRASH)))) || (!committing
928 ctx->hdrs[j] = ctx->hdrs[i];
931 ctx->hdrs[j]->msgno = j;
932 if (ctx->hdrs[j]->virtual != -1) {
933 ctx->v2r[ctx->vcount] = j;
934 ctx->hdrs[j]->virtual = ctx->vcount++;
935 ctx->vsize += this_body->length + this_body->offset -
936 this_body->hdr_offset;
940 ctx->hdrs[j]->changed = 0;
941 else if (ctx->hdrs[j]->changed)
945 || (ctx->magic == M_MAILDIR && option (OPTMAILDIRTRASH))) {
946 if (ctx->hdrs[j]->deleted)
950 if (ctx->hdrs[j]->tagged)
952 if (ctx->hdrs[j]->flagged)
954 if (!ctx->hdrs[j]->read) {
956 if (!ctx->hdrs[j]->old)
963 if (ctx->magic == M_MH || ctx->magic == M_MAILDIR)
964 ctx->size -= (ctx->hdrs[i]->content->length +
965 ctx->hdrs[i]->content->offset -
966 ctx->hdrs[i]->content->hdr_offset);
967 /* remove message from the hash tables */
968 if (ctx->subj_hash && ctx->hdrs[i]->env->real_subj)
969 hash_delete (ctx->subj_hash, ctx->hdrs[i]->env->real_subj,
971 if (ctx->id_hash && ctx->hdrs[i]->env->message_id)
972 hash_delete (ctx->id_hash, ctx->hdrs[i]->env->message_id,
974 mutt_free_header (&ctx->hdrs[i]);
980 /* update sidebar count */
981 sidebar_set_buffystats (ctx);
985 /* save changes to mailbox
991 int mx_sync_mailbox (CONTEXT * ctx, int *index_hint)
995 int msgcount, deleted;
997 if (ctx->dontwrite) {
998 char buf[STRING], tmp[STRING];
1000 if (km_expand_key (buf, sizeof (buf),
1001 km_find_func (MENU_MAIN, OP_TOGGLE_WRITE)))
1002 snprintf (tmp, sizeof (tmp), _(" Press '%s' to toggle write"), buf);
1004 strfcpy (tmp, _("Use 'toggle-write' to re-enable write!"),
1007 mutt_error (_("Mailbox is marked unwritable. %s"), tmp);
1010 else if (ctx->readonly) {
1011 mutt_error _("Mailbox is read-only.");
1016 if (!ctx->changed && !ctx->deleted) {
1017 mutt_message _("Mailbox is unchanged.");
1023 char buf[SHORT_STRING];
1025 snprintf (buf, sizeof (buf), ctx->deleted == 1
1026 ? _("Purge %d deleted message?") :
1027 _("Purge %d deleted messages?"), ctx->deleted);
1028 if ((purge = query_quadoption (OPT_DELETE, buf)) < 0)
1030 else if (purge == M_NO) {
1032 return 0; /* nothing to do! */
1034 /* let IMAP servers hold on to D flags */
1035 if (ctx->magic != M_IMAP)
1038 for (i = 0; i < ctx->msgcount; i++)
1039 ctx->hdrs[i]->deleted = 0;
1043 else if (ctx->last_tag && ctx->last_tag->deleted)
1044 ctx->last_tag = NULL; /* reset last tagged msg now useless */
1047 /* really only for IMAP - imap_sync_mailbox results in a call to
1048 * mx_update_tables, so ctx->deleted is 0 when it comes back */
1049 msgcount = ctx->msgcount;
1050 deleted = ctx->deleted;
1052 if (purge && ctx->deleted) {
1053 if (trash_append (ctx) == -1)
1058 if (ctx->magic == M_IMAP)
1059 rc = imap_sync_mailbox (ctx, purge, index_hint);
1062 rc = sync_mailbox (ctx, index_hint);
1065 if (ctx->magic == M_IMAP && !purge)
1066 mutt_message (_("Mailbox checkpointed."));
1070 mutt_message (_("%d kept, %d deleted."), msgcount - deleted, deleted);
1074 if (ctx->msgcount == ctx->deleted &&
1075 (ctx->magic == M_MBOX || ctx->magic == M_MMDF) &&
1076 !mutt_is_spool (ctx->path) && !option (OPTSAVEEMPTY)) {
1078 mx_fastclose_mailbox (ctx);
1082 /* update sidebar counts */
1083 sidebar_set_buffystats (ctx);
1085 /* if we haven't deleted any messages, we don't need to resort */
1086 /* ... except for certain folder formats which need "unsorted"
1087 * sort order in order to synchronize folders.
1089 * MH and maildir are safe. mbox-style seems to need re-sorting,
1090 * at least with the new threading code.
1092 if (purge || (ctx->magic != M_MAILDIR && ctx->magic != M_MH)) {
1094 /* IMAP does this automatically after handling EXPUNGE */
1095 if (ctx->magic != M_IMAP)
1098 mx_update_tables (ctx, 1);
1099 mutt_sort_headers (ctx, 1); /* rethread from scratch */
1108 * dest destintation mailbox
1109 * hdr message being copied (required for maildir support, because
1110 * the filename depends on the message flags)
1112 MESSAGE *mx_open_new_message (CONTEXT * dest, HEADER * hdr, int flags)
1117 if (!MX_IDX(dest->magic-1)) {
1118 debug_print (1, ("function unimplemented for mailbox type %d.\n", dest->magic));
1122 msg = mem_calloc (1, sizeof (MESSAGE));
1123 msg->magic = dest->magic;
1127 msg->flags.flagged = hdr->flagged;
1128 msg->flags.replied = hdr->replied;
1129 msg->flags.read = hdr->read;
1130 msg->received = hdr->received;
1133 if (msg->received == 0)
1134 time (&msg->received);
1136 if (MX_COMMAND(dest->magic-1,mx_open_new_message)(msg, dest, hdr) == 0) {
1137 if (dest->magic == M_MMDF)
1138 fputs (MMDF_SEP, msg->fp);
1140 if ((msg->magic == M_MBOX || msg->magic == M_MMDF) && flags & M_ADD_FROM) {
1142 if (hdr->env->return_path)
1143 p = hdr->env->return_path;
1144 else if (hdr->env->sender)
1145 p = hdr->env->sender;
1150 fprintf (msg->fp, "From %s %s", p ? p->mailbox : NONULL (Username),
1151 ctime (&msg->received));
1160 /* check for new mail */
1161 int mx_check_mailbox (CONTEXT * ctx, int *index_hint, int lock) {
1162 #ifdef USE_COMPRESSED
1163 if (ctx->compressinfo)
1164 return mutt_check_mailbox_compressed (ctx);
1170 if (MX_IDX(ctx->magic-1) && MX_COMMAND(ctx->magic-1,mx_check_mailbox))
1171 return (MX_COMMAND(ctx->magic-1,mx_check_mailbox)(ctx, index_hint, lock));
1174 debug_print (1, ("null or invalid context.\n"));
1179 /* return a stream pointer for a message */
1180 MESSAGE *mx_open_message (CONTEXT * ctx, int msgno)
1184 msg = mem_calloc (1, sizeof (MESSAGE));
1185 switch (msg->magic = ctx->magic) {
1194 HEADER *cur = ctx->hdrs[msgno];
1195 char path[_POSIX_PATH_MAX];
1197 snprintf (path, sizeof (path), "%s/%s", ctx->path, cur->path);
1199 if ((msg->fp = fopen (path, "r")) == NULL && errno == ENOENT &&
1200 ctx->magic == M_MAILDIR)
1201 msg->fp = maildir_open_find_message (ctx->path, cur->path);
1203 if (msg->fp == NULL) {
1205 debug_print (1, ("fopen: %s: %s (errno %d).\n", path, strerror (errno), errno));
1214 if (imap_fetch_message (msg, ctx, msgno) != 0)
1218 #endif /* USE_IMAP */
1223 if (pop_fetch_message (msg, ctx, msgno) != 0)
1227 #endif /* USE_POP */
1232 if (nntp_fetch_message (msg, ctx, msgno) != 0)
1236 #endif /* USE_NNTP */
1239 debug_print (1, ("function not implemented for mailbox type %d.\n", ctx->magic));
1246 /* commit a message to a folder */
1248 int mx_commit_message (MESSAGE * msg, CONTEXT * ctx) {
1249 if (!(msg->write && ctx->append)) {
1250 debug_print (1, ("msg->write = %d, ctx->append = %d\n", msg->write, ctx->append));
1253 if (!ctx || !MX_IDX(ctx->magic-1) || !MX_COMMAND(ctx->magic-1,mx_commit_message))
1255 return (MX_COMMAND(ctx->magic-1,mx_commit_message) (msg, ctx));
1258 /* close a pointer to a message */
1259 int mx_close_message (MESSAGE ** msg)
1263 if ((*msg)->magic == M_MH || (*msg)->magic == M_MAILDIR
1265 || (*msg)->magic == M_IMAP
1268 || (*msg)->magic == M_POP
1271 || (*msg)->magic == M_NNTP
1274 r = safe_fclose (&(*msg)->fp);
1280 debug_print (1, ("unlinking %s\n", (*msg)->path));
1281 unlink ((*msg)->path);
1282 mem_free (&(*msg)->path);
1289 void mx_alloc_memory (CONTEXT * ctx)
1292 size_t s = MAX (sizeof (HEADER *), sizeof (int));
1294 if ((ctx->hdrmax + 25) * s < ctx->hdrmax * s) {
1295 mutt_error _("Integer overflow -- can't allocate memory.");
1302 mem_realloc (&ctx->hdrs, sizeof (HEADER *) * (ctx->hdrmax += 25));
1303 mem_realloc (&ctx->v2r, sizeof (int) * ctx->hdrmax);
1306 ctx->hdrs = mem_calloc ((ctx->hdrmax += 25), sizeof (HEADER *));
1307 ctx->v2r = mem_calloc (ctx->hdrmax, sizeof (int));
1309 for (i = ctx->msgcount; i < ctx->hdrmax; i++) {
1310 ctx->hdrs[i] = NULL;
1315 /* this routine is called to update the counts in the context structure for
1316 * the last message header parsed.
1318 void mx_update_context (CONTEXT * ctx, int new_messages)
1323 for (msgno = ctx->msgcount - new_messages; msgno < ctx->msgcount; msgno++) {
1324 h = ctx->hdrs[msgno];
1327 /* NOTE: this _must_ be done before the check for mailcap! */
1328 h->security = crypt_query (h->content);
1331 if (!ctx->pattern) {
1332 ctx->v2r[ctx->vcount] = msgno;
1333 h->virtual = ctx->vcount++;
1339 if (h->env->supersedes) {
1343 ctx->id_hash = mutt_make_id_hash (ctx);
1345 h2 = hash_find (ctx->id_hash, h->env->supersedes);
1347 /* mem_free (&h->env->supersedes); should I ? */
1350 if (!ctx->counting && option (OPTSCORE))
1351 mutt_score_message (ctx, h2, 1);
1355 /* add this message to the hash tables */
1356 if (ctx->id_hash && h->env->message_id)
1357 hash_insert (ctx->id_hash, h->env->message_id, h, 0);
1358 if (!ctx->counting) {
1359 if (ctx->subj_hash && h->env->real_subj)
1360 hash_insert (ctx->subj_hash, h->env->real_subj, h, 1);
1362 if (option (OPTSCORE))
1363 mutt_score_message (ctx, h, 0);
1378 /* update sidebar count */
1379 sidebar_set_buffystats (ctx);
1384 * 1 if the specified mailbox contains 0 messages.
1385 * 0 if the mailbox contains messages
1388 int mx_check_empty (const char *path)
1391 if ((i = mx_get_idx (path)) >= 0 && MX_COMMAND(i,mx_check_empty))
1392 return (MX_COMMAND(i,mx_check_empty)(path));
1397 int mx_acl_check (CONTEXT* ctx, int flag) {
1398 if (!ctx || !MX_IDX(ctx->magic-1))
1400 /* if no acl_check defined for module, assume permission is granted */
1401 if (!MX_COMMAND(ctx->magic-1,mx_acl_check))
1403 return (MX_COMMAND(ctx->magic-1,mx_acl_check)(ctx,flag));
1406 void mx_init (void) {
1410 list_push_back (&MailboxFormats, (void*) mbox_reg_mx ());
1411 list_push_back (&MailboxFormats, (void*) mmdf_reg_mx ());
1412 list_push_back (&MailboxFormats, (void*) mh_reg_mx ());
1413 list_push_back (&MailboxFormats, (void*) maildir_reg_mx ());
1415 list_push_back (&MailboxFormats, (void*) imap_reg_mx ());
1418 list_push_back (&MailboxFormats, (void*) pop_reg_mx ());
1421 list_push_back (&MailboxFormats, (void*) nntp_reg_mx ());
1423 #ifdef USE_COMPRESSED
1424 list_push_back (&MailboxFormats, (void*) compress_reg_mx ());
1427 /* check module registration for completeness with debug versions */
1428 #define EXITWITHERR(m) do { fprintf(stderr, "error: incomplete mx module: %s is missing for type %i\n",m,i);exit(1); } while (0)
1429 for (i = 0; i < MailboxFormats->length; i++) {
1430 if (MX_COMMAND(i,type) < 1) EXITWITHERR("type");
1431 if (!MX_COMMAND(i,mx_is_magic)) EXITWITHERR("mx_is_magic");
1432 if (!MX_COMMAND(i,mx_open_mailbox)) EXITWITHERR("mx_open_mailbox");
1433 /* if (!MX_COMMAND(i,mx_sync_mailbox)) EXITWITHERR("mx_sync_mailbox");*/