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.
26 #include <lib-lib/mem.h>
27 #include <lib-lib/ascii.h>
28 #include <lib-lib/str.h>
29 #include <lib-lib/macros.h>
30 #include <lib-lib/file.h>
31 #include <lib-lib/debug.h>
32 #include <lib-lib/url.h>
34 #include <lib-sys/unix.h>
36 #include <lib-mime/mime.h>
50 #include <imap/imap.h>
51 #include <imap/mx_imap.h>
54 #include <pop/mx_pop.h>
57 #include "nntp/nntp.h"
58 #include "nntp/mx_nntp.h"
65 #include <lib-crypt/crypt.h>
69 static list2_t* MailboxFormats = NULL;
70 #define MX_COMMAND(idx,cmd) ((mx_t*) MailboxFormats->data[idx])->cmd
71 #define MX_IDX(idx) (idx >= 0 && idx < MailboxFormats->length)
73 #define mutt_is_spool(s) (m_strcmp(Spoolfile, s) == 0)
78 * retry - should retry if unable to lock?
81 static int invoke_dotlock (const char *path, int dummy, int flags, int retry)
83 char cmd[LONG_STRING + _POSIX_PATH_MAX];
84 char f[SHORT_STRING + _POSIX_PATH_MAX];
87 if (flags & DL_FL_RETRY)
88 snprintf (r, sizeof (r), "-r %d ", retry ? MAXLOCKATTEMPT : 0);
90 mutt_quote_filename (f, sizeof (f), path);
92 snprintf (cmd, sizeof (cmd),
95 flags & DL_FL_TRY ? "-t " : "",
96 flags & DL_FL_UNLOCK ? "-u " : "",
97 flags & DL_FL_USEPRIV ? "-p " : "",
98 flags & DL_FL_FORCE ? "-f " : "",
99 flags & DL_FL_UNLINK ? "-d " : "",
100 flags & DL_FL_RETRY ? r : "", f);
102 return mutt_system (cmd);
105 static int dotlock_file (const char *path, int fd, int retry)
108 int flags = DL_FL_USEPRIV | DL_FL_RETRY;
114 if ((r = invoke_dotlock (path, fd, flags, retry)) == DL_EX_EXIST) {
115 if (!option (OPTNOCURSES)) {
116 char msg[LONG_STRING];
118 snprintf (msg, sizeof (msg),
119 _("Lock count exceeded, remove lock for %s?"), path);
120 if (retry && mutt_yesorno (msg, M_YES) == M_YES) {
121 flags |= DL_FL_FORCE;
128 mutt_error (_("Can't dotlock %s.\n"), path);
131 return (r == DL_EX_OK ? 0 : -1);
134 static int undotlock_file (const char *path, int fd)
136 return (invoke_dotlock (path, fd, DL_FL_USEPRIV | DL_FL_UNLOCK, 0) ==
140 #endif /* USE_DOTLOCK */
142 /* looks up index of type for path in MailboxFormats */
143 static int mx_get_idx (const char* path) {
147 /* first, test all non-local folders to avoid stat() call */
148 for (i = 0; i < MailboxFormats->length; i++) {
149 if (!MX_COMMAND(i,local))
150 t = MX_COMMAND(i,mx_is_magic)(path, NULL);
154 if (stat (path, &st) == 0) {
155 /* if stat() succeeded, keep testing until success and
156 * pass stat() info so that we only need to do it once */
157 for (i = 0; i < MailboxFormats->length; i++) {
158 if (MX_COMMAND(i,local))
159 t = MX_COMMAND(i,mx_is_magic)(path, &st);
168 * excl if excl != 0, request an exclusive lock
169 * dot if dot != 0, try to dotlock the file
170 * time_out should retry locking?
172 int mx_lock_file (const char *path, int fd, int excl, int dot, int time_out)
174 #if defined (USE_FCNTL) || defined (USE_FLOCK)
186 lck.l_type = excl ? F_WRLCK : F_RDLCK;
187 lck.l_whence = SEEK_SET;
192 while (fcntl (fd, F_SETLK, &lck) == -1) {
195 debug_print (1, ("fcntl errno %d.\n", errno));
196 if (errno != EAGAIN && errno != EACCES) {
197 mutt_perror ("fcntl");
201 if (fstat (fd, &sb) != 0)
207 /* only unlock file if it is unchanged */
208 if (prev_sb.st_size == sb.st_size
209 && ++count >= (time_out ? MAXLOCKATTEMPT : 0)) {
211 mutt_error _("Timeout exceeded while attempting fcntl lock!");
218 mutt_message (_("Waiting for fcntl lock... %d"), ++attempt);
221 #endif /* USE_FCNTL */
226 while (flock (fd, (excl ? LOCK_EX : LOCK_SH) | LOCK_NB) == -1) {
229 if (errno != EWOULDBLOCK) {
230 mutt_perror ("flock");
235 if (fstat (fd, &sb) != 0)
241 /* only unlock file if it is unchanged */
242 if (prev_sb.st_size == sb.st_size
243 && ++count >= (time_out ? MAXLOCKATTEMPT : 0)) {
245 mutt_error _("Timeout exceeded while attempting flock lock!");
253 mutt_message (_("Waiting for flock attempt... %d"), ++attempt);
256 #endif /* USE_FLOCK */
260 r = dotlock_file (path, fd, time_out);
261 #endif /* USE_DOTLOCK */
264 /* release any other locks obtained in this routine */
267 lck.l_type = F_UNLCK;
268 fcntl (fd, F_SETLK, &lck);
269 #endif /* USE_FCNTL */
273 #endif /* USE_FLOCK */
281 int mx_unlock_file (const char *path, int fd, int dot)
284 struct flock unlockit;
286 p_clear(&unlockit, 1);
287 unlockit.l_type = F_UNLCK;
288 unlockit.l_whence = SEEK_SET;
289 fcntl (fd, F_SETLK, &unlockit);
298 undotlock_file (path, fd);
304 void mx_unlink_empty (const char *path)
312 if ((fd = open (path, O_RDWR)) == -1)
315 if (mx_lock_file (path, fd, 1, 0, 1) == -1) {
321 invoke_dotlock (path, fd, DL_FL_UNLINK, 1);
323 if (fstat (fd, &sb) == 0 && sb.st_size == 0)
327 mx_unlock_file (path, fd, 0);
331 /* try to figure out what type of mailbox ``path'' is */
332 int mx_get_magic (const char *path) {
335 if (m_strlen(path) == 0)
337 if ((i = mx_get_idx (path)) >= 0)
338 return (MX_COMMAND(i,type));
342 int mx_is_local (int m) {
345 return (MX_COMMAND(m,local));
349 * set DefaultMagic to the given value
351 int mx_set_magic (const char *s)
353 if (ascii_strcasecmp (s, "mbox") == 0)
354 DefaultMagic = M_MBOX;
355 else if (ascii_strcasecmp (s, "mmdf") == 0)
356 DefaultMagic = M_MMDF;
357 else if (ascii_strcasecmp (s, "mh") == 0)
359 else if (ascii_strcasecmp (s, "maildir") == 0)
360 DefaultMagic = M_MAILDIR;
367 /* mx_access: Wrapper for access, checks permissions on a given mailbox.
368 * We may be interested in using ACL-style flags at some point, currently
369 * we use the normal access() flags. */
370 int mx_access (const char *path, int flags)
374 if ((i = mx_get_idx (path)) >= 0 && MX_COMMAND(i,mx_access))
375 return (MX_COMMAND(i,mx_access)(path,flags));
379 static int mx_open_mailbox_append (CONTEXT * ctx, int flags)
383 /* special case for appending to compressed folders -
384 * even if we can not open them for reading */
385 if (mutt_can_append_compressed (ctx->path))
386 mutt_open_append_compressed (ctx);
390 if (mx_get_magic (ctx->path) == M_IMAP)
391 return imap_open_mailbox_append (ctx);
393 if (stat (ctx->path, &sb) == 0) {
394 ctx->magic = mx_get_magic (ctx->path);
396 switch (ctx->magic) {
398 mutt_error (_("%s is not a mailbox."), ctx->path);
404 else if (errno == ENOENT) {
405 ctx->magic = DefaultMagic;
407 if (ctx->magic == M_MH || ctx->magic == M_MAILDIR) {
408 char tmp[_POSIX_PATH_MAX];
410 if (mkdir (ctx->path, S_IRWXU)) {
411 mutt_perror (ctx->path);
415 if (ctx->magic == M_MAILDIR) {
416 snprintf (tmp, sizeof (tmp), "%s/cur", ctx->path);
417 if (mkdir (tmp, S_IRWXU)) {
423 snprintf (tmp, sizeof (tmp), "%s/new", ctx->path);
424 if (mkdir (tmp, S_IRWXU)) {
426 snprintf (tmp, sizeof (tmp), "%s/cur", ctx->path);
431 snprintf (tmp, sizeof (tmp), "%s/tmp", ctx->path);
432 if (mkdir (tmp, S_IRWXU)) {
434 snprintf (tmp, sizeof (tmp), "%s/cur", ctx->path);
436 snprintf (tmp, sizeof (tmp), "%s/new", ctx->path);
445 snprintf (tmp, sizeof (tmp), "%s/.mh_sequences", ctx->path);
446 if ((i = creat (tmp, S_IRWXU)) == -1) {
456 mutt_perror (ctx->path);
460 switch (ctx->magic) {
464 safe_fopen (ctx->path, flags & M_NEWFOLDER ? "w" : "a")) == NULL
465 || mbox_lock_mailbox (ctx, 1, 1) != 0) {
467 mutt_perror (ctx->path);
469 mutt_error (_("Couldn't lock %s\n"), ctx->path);
470 safe_fclose (&ctx->fp);
474 fseeko (ctx->fp, 0, 2);
490 * open a mailbox and parse it
493 * flags M_NOSORT do not sort mailbox
494 * M_APPEND open mailbox for appending
495 * M_READONLY open mailbox in read-only mode
496 * M_QUIET only print error messages
497 * ctx if non-null, context struct to use
499 CONTEXT *mx_open_mailbox (const char *path, int flags, CONTEXT * pctx)
505 ctx = p_new(CONTEXT, 1);
507 ctx->path = m_strdup(path);
509 ctx->msgnotreadyet = -1;
514 if (flags & M_READONLY)
519 if (flags & (M_APPEND | M_NEWFOLDER)) {
520 if (mx_open_mailbox_append (ctx, flags) != 0) {
521 mx_fastclose_mailbox (ctx);
529 if (!MX_IDX(ctx->magic-1))
530 ctx->magic = mx_get_magic (path);
532 if (ctx->magic == M_COMPRESSED)
533 mutt_open_read_compressed (ctx);
536 mutt_error (_("%s is not a mailbox."), path);
538 if (ctx->magic == -1)
541 if (ctx->magic <= 0) {
542 mx_fastclose_mailbox (ctx);
548 /* if the user has a `push' command in their .muttrc, or in a folder-hook,
549 * it will cause the progress messages not to be displayed because
550 * mutt_refresh() will think we are in the middle of a macro. so set a
551 * flag to indicate that we should really refresh the screen.
553 set_option (OPTFORCEREFRESH);
556 mutt_message (_("Reading %s..."), ctx->path);
558 rc = MX_COMMAND(ctx->magic-1,mx_open_mailbox)(ctx);
561 if ((flags & M_NOSORT) == 0) {
562 /* avoid unnecessary work since the mailbox is completely unthreaded
564 unset_option (OPTSORTSUBTHREADS);
565 unset_option (OPTNEEDRESCORE);
566 mutt_sort_headers (ctx, 1);
572 mx_fastclose_mailbox (ctx);
577 unset_option (OPTFORCEREFRESH);
581 /* free up memory associated with the mailbox context */
582 void mx_fastclose_mailbox (CONTEXT * ctx)
589 if (MX_IDX(ctx->magic-1) && MX_COMMAND(ctx->magic-1,mx_fastclose_mailbox))
590 MX_COMMAND(ctx->magic-1,mx_fastclose_mailbox(ctx));
592 hash_destroy (&ctx->subj_hash, NULL);
594 hash_destroy (&ctx->id_hash, NULL);
595 mutt_clear_threads (ctx);
596 for (i = 0; i < ctx->msgcount; i++)
597 header_delete(&ctx->hdrs[i]);
598 p_delete(&ctx->hdrs);
601 if (ctx->compressinfo)
602 mutt_fast_close_compressed (ctx);
604 p_delete(&ctx->path);
605 p_delete(&ctx->pattern);
606 if (ctx->limit_pattern)
607 mutt_pattern_free (&ctx->limit_pattern);
608 safe_fclose (&ctx->fp);
612 /* save changes to disk */
613 static int sync_mailbox (CONTEXT * ctx, int *index_hint)
618 mutt_message (_("Writing %s..."), ctx->path);
620 if (MX_IDX(ctx->magic-1))
621 /* the 1 is only of interest for IMAP and means EXPUNGE */
622 rc = MX_COMMAND(ctx->magic-1,mx_sync_mailbox(ctx,1,index_hint));
624 if (rc == 0 && ctx->compressinfo)
625 return mutt_sync_compressed (ctx);
630 /* move deleted mails to the trash folder */
631 static int trash_append (CONTEXT * ctx)
637 if (!TrashPath || !ctx->deleted ||
638 (ctx->magic == M_MAILDIR && option (OPTMAILDIRTRASH)))
641 for (; i < ctx->msgcount && (!ctx->hdrs[i]->deleted ||
642 ctx->hdrs[i]->appended); i++);
643 if (i == ctx->msgcount)
644 return 0; /* nothing to be done */
646 if (mutt_save_confirm (TrashPath, &st) != 0) {
647 mutt_error _("message(s) not deleted");
652 if (lstat (ctx->path, &stc) == 0 && stc.st_ino == st.st_ino
653 && stc.st_dev == st.st_dev && stc.st_rdev == st.st_rdev)
654 return 0; /* we are in the trash folder: simple sync */
656 if ((ctx_trash = mx_open_mailbox (TrashPath, M_APPEND, NULL)) != NULL) {
657 for (i = 0; i < ctx->msgcount; i++)
658 if (ctx->hdrs[i]->deleted && !ctx->hdrs[i]->appended
659 && !ctx->hdrs[i]->purged
660 && mutt_append_message (ctx_trash, ctx, ctx->hdrs[i], 0, 0) == -1) {
661 mx_close_mailbox (ctx_trash, NULL);
665 mx_close_mailbox (ctx_trash, NULL);
668 mutt_error _("Can't open trash folder");
676 /* save changes and close mailbox */
677 static int _mx_close_mailbox (CONTEXT * ctx, int *index_hint)
679 int i, move_messages = 0, purge = 1, read_msgs = 0;
683 char mbox[_POSIX_PATH_MAX];
684 char buf[SHORT_STRING];
692 if (ctx->magic == M_NNTP) {
695 ret = nntp_close_mailbox (ctx);
696 mx_fastclose_mailbox (ctx);
700 if (ctx->readonly || ctx->dontwrite) {
701 /* mailbox is readonly or we don't want to write */
702 mx_fastclose_mailbox (ctx);
707 /* mailbox was opened in write-mode */
708 if (ctx->magic == M_MBOX || ctx->magic == M_MMDF)
709 mbox_close_mailbox (ctx);
711 mx_fastclose_mailbox (ctx);
715 for (i = 0; i < ctx->msgcount; i++) {
716 if (!ctx->hdrs[i]->deleted && ctx->hdrs[i]->read
717 && !(ctx->hdrs[i]->flagged && option (OPTKEEPFLAGGED)))
721 if (read_msgs && quadoption (OPT_MOVE) != M_NO) {
724 if ((p = mutt_find_hook (M_MBOXHOOK, ctx->path))) {
726 m_strcpy(mbox, sizeof(mbox), p);
729 m_strcpy(mbox, sizeof(mbox), NONULL(Inbox));
730 isSpool = mutt_is_spool (ctx->path) && !mutt_is_spool (mbox);
732 mutt_expand_path (mbox, sizeof (mbox));
735 snprintf (buf, sizeof (buf), _("Move read messages to %s?"), mbox);
736 if ((move_messages = query_quadoption (OPT_MOVE, buf)) == -1) {
744 * There is no point in asking whether or not to purge if we are
745 * just marking messages as "trash".
747 if (ctx->deleted && !(ctx->magic == M_MAILDIR && option (OPTMAILDIRTRASH))) {
748 snprintf (buf, sizeof (buf), ctx->deleted == 1
749 ? _("Purge %d deleted message?") :
750 _("Purge %d deleted messages?"), ctx->deleted);
751 if ((purge = query_quadoption (OPT_DELETE, buf)) < 0) {
757 /* IMAP servers manage the OLD flag themselves */
758 if (ctx->magic != M_IMAP)
759 if (option (OPTMARKOLD)) {
760 for (i = 0; i < ctx->msgcount; i++) {
761 if (!ctx->hdrs[i]->deleted && !ctx->hdrs[i]->old)
762 mutt_set_flag (ctx, ctx->hdrs[i], M_OLD, 1);
767 mutt_message (_("Moving read messages to %s..."), mbox);
769 /* try to use server-side copy first */
772 if (ctx->magic == M_IMAP && imap_is_magic (mbox, NULL) == M_IMAP) {
773 /* tag messages for moving, and clear old tags, if any */
774 for (i = 0; i < ctx->msgcount; i++)
775 if (ctx->hdrs[i]->read && !ctx->hdrs[i]->deleted
776 && !(ctx->hdrs[i]->flagged && option (OPTKEEPFLAGGED)))
777 ctx->hdrs[i]->tagged = 1;
779 ctx->hdrs[i]->tagged = 0;
781 i = imap_copy_messages (ctx, NULL, mbox, 1);
784 if (i == 0) /* success */
786 else if (i == -1) { /* horrible error, bail */
790 else /* use regular append-copy mode */
792 if (mx_open_mailbox (mbox, M_APPEND, &f) == NULL) {
797 for (i = 0; i < ctx->msgcount; i++) {
798 if (ctx->hdrs[i]->read && !ctx->hdrs[i]->deleted
799 && !(ctx->hdrs[i]->flagged && option (OPTKEEPFLAGGED))) {
800 if (mutt_append_message (&f, ctx, ctx->hdrs[i], 0, CH_UPDATE_LEN) ==
802 mutt_set_flag (ctx, ctx->hdrs[i], M_DELETE, 1);
803 mutt_set_flag (ctx, ctx->hdrs[i], M_APPENDED, 1);
806 mx_close_mailbox (&f, NULL);
813 mx_close_mailbox (&f, NULL);
817 else if (!ctx->changed && ctx->deleted == 0) {
818 mutt_message _("Mailbox is unchanged.");
820 mx_fastclose_mailbox (ctx);
824 /* copy mails to the trash before expunging */
825 if (purge && ctx->deleted)
826 if (trash_append (ctx) != 0) {
831 /* allow IMAP to preserve the deleted flag across sessions */
832 if (ctx->magic == M_IMAP) {
833 if ((check = imap_sync_mailbox (ctx, purge, index_hint)) != 0) {
841 for (i = 0; i < ctx->msgcount; i++)
842 ctx->hdrs[i]->deleted = 0;
846 if (ctx->changed || ctx->deleted) {
847 if ((check = sync_mailbox (ctx, index_hint)) != 0) {
855 mutt_message (_("%d kept, %d moved, %d deleted."),
856 ctx->msgcount - ctx->deleted, read_msgs, ctx->deleted);
858 mutt_message (_("%d kept, %d deleted."),
859 ctx->msgcount - ctx->deleted, ctx->deleted);
861 if (ctx->msgcount == ctx->deleted &&
862 (ctx->magic == M_MMDF || ctx->magic == M_MBOX) &&
863 !mutt_is_spool (ctx->path) && !option (OPTSAVEEMPTY))
864 mx_unlink_empty (ctx->path);
866 if (ctx->compressinfo && mutt_slow_close_compressed (ctx))
869 mx_fastclose_mailbox (ctx);
874 int mx_close_mailbox (CONTEXT * ctx, int *index_hint) {
878 ret = _mx_close_mailbox (ctx, index_hint);
879 sidebar_set_buffystats (ctx);
883 /* update a Context structure's internal tables. */
885 void mx_update_tables (CONTEXT * ctx, int committing)
889 /* update memory to reflect the new state of the mailbox */
898 #define this_body ctx->hdrs[j]->content
899 for (i = 0, j = 0; i < ctx->msgcount; i++) {
900 if ((committing && (!ctx->hdrs[i]->deleted ||
901 (ctx->magic == M_MAILDIR
902 && option (OPTMAILDIRTRASH)))) || (!committing
906 ctx->hdrs[j] = ctx->hdrs[i];
909 ctx->hdrs[j]->msgno = j;
910 if (ctx->hdrs[j]->virtual != -1) {
911 ctx->v2r[ctx->vcount] = j;
912 ctx->hdrs[j]->virtual = ctx->vcount++;
913 ctx->vsize += this_body->length + this_body->offset -
914 this_body->hdr_offset;
918 ctx->hdrs[j]->changed = 0;
919 else if (ctx->hdrs[j]->changed)
923 || (ctx->magic == M_MAILDIR && option (OPTMAILDIRTRASH))) {
924 if (ctx->hdrs[j]->deleted)
928 if (ctx->hdrs[j]->tagged)
930 if (ctx->hdrs[j]->flagged)
932 if (!ctx->hdrs[j]->read) {
934 if (!ctx->hdrs[j]->old)
941 if (ctx->magic == M_MH || ctx->magic == M_MAILDIR)
942 ctx->size -= (ctx->hdrs[i]->content->length +
943 ctx->hdrs[i]->content->offset -
944 ctx->hdrs[i]->content->hdr_offset);
945 /* remove message from the hash tables */
946 if (ctx->subj_hash && ctx->hdrs[i]->env->real_subj)
947 hash_delete (ctx->subj_hash, ctx->hdrs[i]->env->real_subj,
949 if (ctx->id_hash && ctx->hdrs[i]->env->message_id)
950 hash_delete (ctx->id_hash, ctx->hdrs[i]->env->message_id,
952 header_delete(&ctx->hdrs[i]);
958 /* update sidebar count */
959 sidebar_set_buffystats (ctx);
963 /* save changes to mailbox
969 static int _mx_sync_mailbox (CONTEXT * ctx, int *index_hint)
973 int msgcount, deleted;
975 if (ctx->dontwrite) {
976 char buf[STRING], tmp[STRING];
978 if (km_expand_key (buf, sizeof (buf),
979 km_find_func (MENU_MAIN, OP_TOGGLE_WRITE)))
980 snprintf (tmp, sizeof (tmp), _(" Press '%s' to toggle write"), buf);
982 m_strcpy(tmp, sizeof(tmp), _("Use 'toggle-write' to re-enable write!"));
984 mutt_error (_("Mailbox is marked unwritable. %s"), tmp);
987 else if (ctx->readonly) {
988 mutt_error _("Mailbox is read-only.");
993 if (!ctx->changed && !ctx->deleted) {
994 mutt_message _("Mailbox is unchanged.");
1000 char buf[SHORT_STRING];
1002 snprintf (buf, sizeof (buf), ctx->deleted == 1
1003 ? _("Purge %d deleted message?") :
1004 _("Purge %d deleted messages?"), ctx->deleted);
1005 if ((purge = query_quadoption (OPT_DELETE, buf)) < 0)
1007 else if (purge == M_NO) {
1009 return 0; /* nothing to do! */
1010 /* let IMAP servers hold on to D flags */
1011 if (ctx->magic != M_IMAP)
1013 for (i = 0; i < ctx->msgcount; i++)
1014 ctx->hdrs[i]->deleted = 0;
1018 else if (ctx->last_tag && ctx->last_tag->deleted)
1019 ctx->last_tag = NULL; /* reset last tagged msg now useless */
1022 /* really only for IMAP - imap_sync_mailbox results in a call to
1023 * mx_update_tables, so ctx->deleted is 0 when it comes back */
1024 msgcount = ctx->msgcount;
1025 deleted = ctx->deleted;
1027 if (purge && ctx->deleted) {
1028 if (trash_append (ctx) == -1)
1032 if (ctx->magic == M_IMAP)
1033 rc = imap_sync_mailbox (ctx, purge, index_hint);
1035 rc = sync_mailbox (ctx, index_hint);
1037 if (ctx->magic == M_IMAP && !purge)
1038 mutt_message (_("Mailbox checkpointed."));
1041 mutt_message (_("%d kept, %d deleted."), msgcount - deleted, deleted);
1045 if (ctx->msgcount == ctx->deleted &&
1046 (ctx->magic == M_MBOX || ctx->magic == M_MMDF) &&
1047 !mutt_is_spool (ctx->path) && !option (OPTSAVEEMPTY)) {
1049 mx_fastclose_mailbox (ctx);
1053 /* if we haven't deleted any messages, we don't need to resort */
1054 /* ... except for certain folder formats which need "unsorted"
1055 * sort order in order to synchronize folders.
1057 * MH and maildir are safe. mbox-style seems to need re-sorting,
1058 * at least with the new threading code.
1060 if (purge || (ctx->magic != M_MAILDIR && ctx->magic != M_MH)) {
1061 /* IMAP does this automatically after handling EXPUNGE */
1062 if (ctx->magic != M_IMAP)
1064 mx_update_tables (ctx, 1);
1065 mutt_sort_headers (ctx, 1); /* rethread from scratch */
1073 int mx_sync_mailbox (CONTEXT* ctx, int* index_hint) {
1074 int ret = _mx_sync_mailbox (ctx, index_hint);
1075 sidebar_set_buffystats (ctx);
1080 * dest destintation mailbox
1081 * hdr message being copied (required for maildir support, because
1082 * the filename depends on the message flags)
1084 MESSAGE *mx_open_new_message (CONTEXT * dest, HEADER * hdr, int flags)
1087 address_t *p = NULL;
1089 if (!MX_IDX(dest->magic-1)) {
1090 debug_print (1, ("function unimplemented for mailbox type %d.\n", dest->magic));
1094 msg = p_new(MESSAGE, 1);
1095 msg->magic = dest->magic;
1099 msg->flags.flagged = hdr->flagged;
1100 msg->flags.replied = hdr->replied;
1101 msg->flags.read = hdr->read;
1102 msg->received = hdr->received;
1105 if (msg->received == 0)
1106 time (&msg->received);
1108 if (MX_COMMAND(dest->magic-1,mx_open_new_message)(msg, dest, hdr) == 0) {
1109 if (dest->magic == M_MMDF)
1110 fputs (MMDF_SEP, msg->fp);
1112 if ((msg->magic == M_MBOX || msg->magic == M_MMDF) && flags & M_ADD_FROM) {
1114 if (hdr->env->return_path)
1115 p = hdr->env->return_path;
1116 else if (hdr->env->sender)
1117 p = hdr->env->sender;
1122 fprintf (msg->fp, "From %s %s", p ? p->mailbox : NONULL (Username),
1123 ctime (&msg->received));
1132 /* check for new mail */
1133 int mx_check_mailbox (CONTEXT * ctx, int *index_hint, int lock) {
1134 if (ctx->compressinfo)
1135 return mutt_check_mailbox_compressed (ctx);
1140 if (MX_IDX(ctx->magic-1) && MX_COMMAND(ctx->magic-1,mx_check_mailbox))
1141 return (MX_COMMAND(ctx->magic-1,mx_check_mailbox)(ctx, index_hint, lock));
1144 debug_print (1, ("null or invalid context.\n"));
1149 /* return a stream pointer for a message */
1150 MESSAGE *mx_open_message (CONTEXT * ctx, int msgno)
1154 msg = p_new(MESSAGE, 1);
1155 switch (msg->magic = ctx->magic) {
1164 HEADER *cur = ctx->hdrs[msgno];
1165 char path[_POSIX_PATH_MAX];
1167 snprintf (path, sizeof (path), "%s/%s", ctx->path, cur->path);
1169 if ((msg->fp = fopen (path, "r")) == NULL && errno == ENOENT &&
1170 ctx->magic == M_MAILDIR)
1171 msg->fp = maildir_open_find_message (ctx->path, cur->path);
1173 if (msg->fp == NULL) {
1175 debug_print (1, ("fopen: %s: %s (errno %d).\n", path, strerror (errno), errno));
1183 if (imap_fetch_message (msg, ctx, msgno) != 0)
1190 if (pop_fetch_message (msg, ctx, msgno) != 0)
1198 if (nntp_fetch_message (msg, ctx, msgno) != 0)
1202 #endif /* USE_NNTP */
1205 debug_print (1, ("function not implemented for mailbox type %d.\n", ctx->magic));
1212 /* commit a message to a folder */
1214 int mx_commit_message (MESSAGE * msg, CONTEXT * ctx) {
1215 if (!(msg->write && ctx->append)) {
1216 debug_print (1, ("msg->write = %d, ctx->append = %d\n", msg->write, ctx->append));
1219 if (!ctx || !MX_IDX(ctx->magic-1) || !MX_COMMAND(ctx->magic-1,mx_commit_message))
1221 return (MX_COMMAND(ctx->magic-1,mx_commit_message) (msg, ctx));
1224 /* close a pointer to a message */
1225 int mx_close_message (MESSAGE ** msg)
1229 if ((*msg)->magic == M_MH || (*msg)->magic == M_MAILDIR
1230 || (*msg)->magic == M_IMAP
1231 || (*msg)->magic == M_POP
1233 || (*msg)->magic == M_NNTP
1236 r = safe_fclose (&(*msg)->fp);
1242 debug_print (1, ("unlinking %s\n", (*msg)->path));
1243 unlink ((*msg)->path);
1244 p_delete(&(*msg)->path);
1251 void mx_alloc_memory (CONTEXT * ctx)
1254 size_t s = MAX (sizeof (HEADER *), sizeof (int));
1256 if ((ctx->hdrmax + 25) * s < ctx->hdrmax * s) {
1257 mutt_error _("Integer overflow -- can't allocate memory.");
1264 p_realloc(&ctx->hdrs, ctx->hdrmax += 25);
1265 p_realloc(&ctx->v2r, ctx->hdrmax);
1268 ctx->hdrs = p_new(HEADER *, (ctx->hdrmax += 25));
1269 ctx->v2r = p_new(int, ctx->hdrmax);
1271 for (i = ctx->msgcount; i < ctx->hdrmax; i++) {
1272 ctx->hdrs[i] = NULL;
1277 /* this routine is called to update the counts in the context structure for
1278 * the last message header parsed.
1280 void mx_update_context (CONTEXT * ctx, int new_messages)
1285 for (msgno = ctx->msgcount - new_messages; msgno < ctx->msgcount; msgno++) {
1286 h = ctx->hdrs[msgno];
1288 /* NOTE: this _must_ be done before the check for mailcap! */
1289 h->security = crypt_query (h->content);
1291 if (!ctx->pattern) {
1292 ctx->v2r[ctx->vcount] = msgno;
1293 h->virtual = ctx->vcount++;
1299 if (h->env->supersedes) {
1303 ctx->id_hash = mutt_make_id_hash (ctx);
1305 h2 = hash_find (ctx->id_hash, h->env->supersedes);
1307 /* p_delete(&h->env->supersedes); should I ? */
1310 if (!ctx->counting && option (OPTSCORE))
1311 mutt_score_message (ctx, h2, 1);
1315 /* add this message to the hash tables */
1316 if (ctx->id_hash && h->env->message_id)
1317 hash_insert (ctx->id_hash, h->env->message_id, h, 0);
1318 if (!ctx->counting) {
1319 if (ctx->subj_hash && h->env->real_subj)
1320 hash_insert (ctx->subj_hash, h->env->real_subj, h, 1);
1322 if (option (OPTSCORE))
1323 mutt_score_message (ctx, h, 0);
1338 /* update sidebar count */
1339 sidebar_set_buffystats (ctx);
1344 * 1 if the specified mailbox contains 0 messages.
1345 * 0 if the mailbox contains messages
1348 int mx_check_empty (const char *path)
1351 if ((i = mx_get_idx (path)) >= 0 && MX_COMMAND(i,mx_check_empty))
1352 return (MX_COMMAND(i,mx_check_empty)(path));
1357 int mx_acl_check (CONTEXT* ctx, int flag) {
1358 if (!ctx || !MX_IDX(ctx->magic-1))
1360 /* if no acl_check defined for module, assume permission is granted */
1361 if (!MX_COMMAND(ctx->magic-1,mx_acl_check))
1363 return (MX_COMMAND(ctx->magic-1,mx_acl_check)(ctx,flag));
1366 void mx_init (void) {
1370 list_push_back (&MailboxFormats, (void*) mbox_reg_mx ());
1371 list_push_back (&MailboxFormats, (void*) mmdf_reg_mx ());
1372 list_push_back (&MailboxFormats, (void*) mh_reg_mx ());
1373 list_push_back (&MailboxFormats, (void*) maildir_reg_mx ());
1374 list_push_back (&MailboxFormats, (void*) imap_reg_mx ());
1375 list_push_back (&MailboxFormats, (void*) pop_reg_mx ());
1377 list_push_back (&MailboxFormats, (void*) nntp_reg_mx ());
1379 list_push_back (&MailboxFormats, (void*) compress_reg_mx ());
1381 /* check module registration for completeness with debug versions */
1382 #define EXITWITHERR(m) do { fprintf(stderr, "error: incomplete mx module: %s is missing for type %i\n",m,i);exit(1); } while (0)
1383 for (i = 0; i < MailboxFormats->length; i++) {
1384 if (MX_COMMAND(i,type) < 1) EXITWITHERR("type");
1385 if (!MX_COMMAND(i,mx_is_magic)) EXITWITHERR("mx_is_magic");
1386 if (!MX_COMMAND(i,mx_open_mailbox)) EXITWITHERR("mx_open_mailbox");
1387 /* if (!MX_COMMAND(i,mx_sync_mailbox)) EXITWITHERR("mx_sync_mailbox");*/
1393 int mx_rebuild_cache (void) {
1395 mutt_error (_("Support for header caching was not build in."));
1398 int i = 0, magic = 0;
1399 CONTEXT* ctx = NULL;
1402 if (list_empty(Incoming)) {
1403 mutt_error (_("No mailboxes defined."));
1407 for (i = 0; i < Incoming->length; i++) {
1408 b = (BUFFY*) Incoming->data[i];
1409 magic = mx_get_magic (b->path);
1410 if (magic != M_MAILDIR && magic != M_MH && magic != M_IMAP)
1412 sidebar_set_current (b->path);
1413 sidebar_draw (CurrentMenu);
1414 if ((ctx = mx_open_mailbox (b->path,
1415 M_READONLY | M_NOSORT | M_COUNT,
1417 mx_close_mailbox (ctx, 0);
1419 mutt_clear_error ();
1421 if (Context && Context->path)
1422 sidebar_set_current (Context->path);
1423 sidebar_draw (CurrentMenu);
1429 void mutt_parse_mime_message (CONTEXT * ctx, HEADER * cur)
1435 if (cur->content->type != TYPEMESSAGE
1436 && cur->content->type != TYPEMULTIPART)
1437 break; /* nothing to do */
1439 if (cur->content->parts)
1440 break; /* The message was parsed earlier. */
1442 if ((msg = mx_open_message (ctx, cur->msgno))) {
1443 mutt_parse_part (msg->fp, cur->content);
1445 cur->security = crypt_query (cur->content);
1447 mx_close_message (&msg);
1450 mutt_count_body_parts (cur, flags | M_PARTS_RECOUNT);