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.
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>
21 #include <lib-mime/mime.h>
37 #include "imap/imap.h"
38 #include "imap/mx_imap.h"
43 #include "pop/mx_pop.h"
47 #include "nntp/nntp.h"
48 #include "nntp/mx_nntp.h"
55 #include "mutt_crypt.h"
58 #include "lib/debug.h"
71 static list2_t* MailboxFormats = NULL;
72 #define MX_COMMAND(idx,cmd) ((mx_t*) MailboxFormats->data[idx])->cmd
73 #define MX_IDX(idx) (idx >= 0 && idx < MailboxFormats->length)
75 #define mutt_is_spool(s) (m_strcmp(Spoolfile, s) == 0)
80 * retry - should retry if unable to lock?
83 static int invoke_dotlock (const char *path, int dummy, int flags, int retry)
85 char cmd[LONG_STRING + _POSIX_PATH_MAX];
86 char f[SHORT_STRING + _POSIX_PATH_MAX];
89 if (flags & DL_FL_RETRY)
90 snprintf (r, sizeof (r), "-r %d ", retry ? MAXLOCKATTEMPT : 0);
92 mutt_quote_filename (f, sizeof (f), path);
94 snprintf (cmd, sizeof (cmd),
97 flags & DL_FL_TRY ? "-t " : "",
98 flags & DL_FL_UNLOCK ? "-u " : "",
99 flags & DL_FL_USEPRIV ? "-p " : "",
100 flags & DL_FL_FORCE ? "-f " : "",
101 flags & DL_FL_UNLINK ? "-d " : "",
102 flags & DL_FL_RETRY ? r : "", f);
104 return mutt_system (cmd);
107 static int dotlock_file (const char *path, int fd, int retry)
110 int flags = DL_FL_USEPRIV | DL_FL_RETRY;
116 if ((r = invoke_dotlock (path, fd, flags, retry)) == DL_EX_EXIST) {
117 if (!option (OPTNOCURSES)) {
118 char msg[LONG_STRING];
120 snprintf (msg, sizeof (msg),
121 _("Lock count exceeded, remove lock for %s?"), path);
122 if (retry && mutt_yesorno (msg, M_YES) == M_YES) {
123 flags |= DL_FL_FORCE;
130 mutt_error (_("Can't dotlock %s.\n"), path);
133 return (r == DL_EX_OK ? 0 : -1);
136 static int undotlock_file (const char *path, int fd)
138 return (invoke_dotlock (path, fd, DL_FL_USEPRIV | DL_FL_UNLOCK, 0) ==
142 #endif /* USE_DOTLOCK */
144 /* looks up index of type for path in MailboxFormats */
145 static int mx_get_idx (const char* path) {
149 /* first, test all non-local folders to avoid stat() call */
150 for (i = 0; i < MailboxFormats->length; i++) {
151 if (!MX_COMMAND(i,local))
152 t = MX_COMMAND(i,mx_is_magic)(path, NULL);
156 if (stat (path, &st) == 0) {
157 /* if stat() succeeded, keep testing until success and
158 * pass stat() info so that we only need to do it once */
159 for (i = 0; i < MailboxFormats->length; i++) {
160 if (MX_COMMAND(i,local))
161 t = MX_COMMAND(i,mx_is_magic)(path, &st);
170 * excl if excl != 0, request an exclusive lock
171 * dot if dot != 0, try to dotlock the file
172 * timeout should retry locking?
174 int mx_lock_file (const char *path, int fd, int excl, int dot, int timeout)
176 #if defined (USE_FCNTL) || defined (USE_FLOCK)
188 lck.l_type = excl ? F_WRLCK : F_RDLCK;
189 lck.l_whence = SEEK_SET;
194 while (fcntl (fd, F_SETLK, &lck) == -1) {
197 debug_print (1, ("fcntl errno %d.\n", errno));
198 if (errno != EAGAIN && errno != EACCES) {
199 mutt_perror ("fcntl");
203 if (fstat (fd, &sb) != 0)
209 /* only unlock file if it is unchanged */
210 if (prev_sb.st_size == sb.st_size
211 && ++count >= (timeout ? MAXLOCKATTEMPT : 0)) {
213 mutt_error _("Timeout exceeded while attempting fcntl lock!");
220 mutt_message (_("Waiting for fcntl lock... %d"), ++attempt);
223 #endif /* USE_FCNTL */
228 while (flock (fd, (excl ? LOCK_EX : LOCK_SH) | LOCK_NB) == -1) {
231 if (errno != EWOULDBLOCK) {
232 mutt_perror ("flock");
237 if (fstat (fd, &sb) != 0)
243 /* only unlock file if it is unchanged */
244 if (prev_sb.st_size == sb.st_size
245 && ++count >= (timeout ? MAXLOCKATTEMPT : 0)) {
247 mutt_error _("Timeout exceeded while attempting flock lock!");
255 mutt_message (_("Waiting for flock attempt... %d"), ++attempt);
258 #endif /* USE_FLOCK */
262 r = dotlock_file (path, fd, timeout);
263 #endif /* USE_DOTLOCK */
266 /* release any other locks obtained in this routine */
269 lck.l_type = F_UNLCK;
270 fcntl (fd, F_SETLK, &lck);
271 #endif /* USE_FCNTL */
275 #endif /* USE_FLOCK */
283 int mx_unlock_file (const char *path, int fd, int dot)
286 struct flock unlockit;
288 p_clear(&unlockit, 1);
289 unlockit.l_type = F_UNLCK;
290 unlockit.l_whence = SEEK_SET;
291 fcntl (fd, F_SETLK, &unlockit);
300 undotlock_file (path, fd);
306 void mx_unlink_empty (const char *path)
314 if ((fd = open (path, O_RDWR)) == -1)
317 if (mx_lock_file (path, fd, 1, 0, 1) == -1) {
323 invoke_dotlock (path, fd, DL_FL_UNLINK, 1);
325 if (fstat (fd, &sb) == 0 && sb.st_size == 0)
329 mx_unlock_file (path, fd, 0);
333 /* try to figure out what type of mailbox ``path'' is */
334 int mx_get_magic (const char *path) {
337 if (m_strlen(path) == 0)
339 if ((i = mx_get_idx (path)) >= 0)
340 return (MX_COMMAND(i,type));
344 int mx_is_local (int m) {
347 return (MX_COMMAND(m,local));
351 * set DefaultMagic to the given value
353 int mx_set_magic (const char *s)
355 if (ascii_strcasecmp (s, "mbox") == 0)
356 DefaultMagic = M_MBOX;
357 else if (ascii_strcasecmp (s, "mmdf") == 0)
358 DefaultMagic = M_MMDF;
359 else if (ascii_strcasecmp (s, "mh") == 0)
361 else if (ascii_strcasecmp (s, "maildir") == 0)
362 DefaultMagic = M_MAILDIR;
369 /* mx_access: Wrapper for access, checks permissions on a given mailbox.
370 * We may be interested in using ACL-style flags at some point, currently
371 * we use the normal access() flags. */
372 int mx_access (const char *path, int flags)
376 if ((i = mx_get_idx (path)) >= 0 && MX_COMMAND(i,mx_access))
377 return (MX_COMMAND(i,mx_access)(path,flags));
381 static int mx_open_mailbox_append (CONTEXT * ctx, int flags)
385 /* special case for appending to compressed folders -
386 * even if we can not open them for reading */
387 if (mutt_can_append_compressed (ctx->path))
388 mutt_open_append_compressed (ctx);
394 if (mx_get_magic (ctx->path) == M_IMAP)
395 return imap_open_mailbox_append (ctx);
399 if (stat (ctx->path, &sb) == 0) {
400 ctx->magic = mx_get_magic (ctx->path);
402 switch (ctx->magic) {
404 mutt_error (_("%s is not a mailbox."), ctx->path);
410 else if (errno == ENOENT) {
411 ctx->magic = DefaultMagic;
413 if (ctx->magic == M_MH || ctx->magic == M_MAILDIR) {
414 char tmp[_POSIX_PATH_MAX];
416 if (mkdir (ctx->path, S_IRWXU)) {
417 mutt_perror (ctx->path);
421 if (ctx->magic == M_MAILDIR) {
422 snprintf (tmp, sizeof (tmp), "%s/cur", ctx->path);
423 if (mkdir (tmp, S_IRWXU)) {
429 snprintf (tmp, sizeof (tmp), "%s/new", ctx->path);
430 if (mkdir (tmp, S_IRWXU)) {
432 snprintf (tmp, sizeof (tmp), "%s/cur", ctx->path);
437 snprintf (tmp, sizeof (tmp), "%s/tmp", ctx->path);
438 if (mkdir (tmp, S_IRWXU)) {
440 snprintf (tmp, sizeof (tmp), "%s/cur", ctx->path);
442 snprintf (tmp, sizeof (tmp), "%s/new", ctx->path);
451 snprintf (tmp, sizeof (tmp), "%s/.mh_sequences", ctx->path);
452 if ((i = creat (tmp, S_IRWXU)) == -1) {
462 mutt_perror (ctx->path);
466 switch (ctx->magic) {
470 safe_fopen (ctx->path, flags & M_NEWFOLDER ? "w" : "a")) == NULL
471 || mbox_lock_mailbox (ctx, 1, 1) != 0) {
473 mutt_perror (ctx->path);
475 mutt_error (_("Couldn't lock %s\n"), ctx->path);
476 safe_fclose (&ctx->fp);
480 fseeko (ctx->fp, 0, 2);
496 * open a mailbox and parse it
499 * flags M_NOSORT do not sort mailbox
500 * M_APPEND open mailbox for appending
501 * M_READONLY open mailbox in read-only mode
502 * M_QUIET only print error messages
503 * ctx if non-null, context struct to use
505 CONTEXT *mx_open_mailbox (const char *path, int flags, CONTEXT * pctx)
511 ctx = p_new(CONTEXT, 1);
513 ctx->path = m_strdup(path);
515 ctx->msgnotreadyet = -1;
520 if (flags & M_READONLY)
525 if (flags & (M_APPEND | M_NEWFOLDER)) {
526 if (mx_open_mailbox_append (ctx, flags) != 0) {
527 mx_fastclose_mailbox (ctx);
535 if (!MX_IDX(ctx->magic-1))
536 ctx->magic = mx_get_magic (path);
538 if (ctx->magic == M_COMPRESSED)
539 mutt_open_read_compressed (ctx);
542 mutt_error (_("%s is not a mailbox."), path);
544 if (ctx->magic == -1)
547 if (ctx->magic <= 0) {
548 mx_fastclose_mailbox (ctx);
554 /* if the user has a `push' command in their .muttrc, or in a folder-hook,
555 * it will cause the progress messages not to be displayed because
556 * mutt_refresh() will think we are in the middle of a macro. so set a
557 * flag to indicate that we should really refresh the screen.
559 set_option (OPTFORCEREFRESH);
562 mutt_message (_("Reading %s..."), ctx->path);
564 rc = MX_COMMAND(ctx->magic-1,mx_open_mailbox)(ctx);
567 if ((flags & M_NOSORT) == 0) {
568 /* avoid unnecessary work since the mailbox is completely unthreaded
570 unset_option (OPTSORTSUBTHREADS);
571 unset_option (OPTNEEDRESCORE);
572 mutt_sort_headers (ctx, 1);
578 mx_fastclose_mailbox (ctx);
583 unset_option (OPTFORCEREFRESH);
587 /* free up memory associated with the mailbox context */
588 void mx_fastclose_mailbox (CONTEXT * ctx)
595 if (MX_IDX(ctx->magic-1) && MX_COMMAND(ctx->magic-1,mx_fastclose_mailbox))
596 MX_COMMAND(ctx->magic-1,mx_fastclose_mailbox(ctx));
598 hash_destroy (&ctx->subj_hash, NULL);
600 hash_destroy (&ctx->id_hash, NULL);
601 mutt_clear_threads (ctx);
602 for (i = 0; i < ctx->msgcount; i++)
603 mutt_free_header (&ctx->hdrs[i]);
604 p_delete(&ctx->hdrs);
607 if (ctx->compressinfo)
608 mutt_fast_close_compressed (ctx);
610 p_delete(&ctx->path);
611 p_delete(&ctx->pattern);
612 if (ctx->limit_pattern)
613 mutt_pattern_free (&ctx->limit_pattern);
614 safe_fclose (&ctx->fp);
618 /* save changes to disk */
619 static int sync_mailbox (CONTEXT * ctx, int *index_hint)
624 mutt_message (_("Writing %s..."), ctx->path);
626 if (MX_IDX(ctx->magic-1))
627 /* the 1 is only of interest for IMAP and means EXPUNGE */
628 rc = MX_COMMAND(ctx->magic-1,mx_sync_mailbox(ctx,1,index_hint));
630 if (rc == 0 && ctx->compressinfo)
631 return mutt_sync_compressed (ctx);
636 /* move deleted mails to the trash folder */
637 static int trash_append (CONTEXT * ctx)
643 if (!TrashPath || !ctx->deleted ||
644 (ctx->magic == M_MAILDIR && option (OPTMAILDIRTRASH)))
647 for (; i < ctx->msgcount && (!ctx->hdrs[i]->deleted ||
648 ctx->hdrs[i]->appended); i++);
649 if (i == ctx->msgcount)
650 return 0; /* nothing to be done */
652 if (mutt_save_confirm (TrashPath, &st) != 0) {
653 mutt_error _("message(s) not deleted");
658 if (lstat (ctx->path, &stc) == 0 && stc.st_ino == st.st_ino
659 && stc.st_dev == st.st_dev && stc.st_rdev == st.st_rdev)
660 return 0; /* we are in the trash folder: simple sync */
662 if ((ctx_trash = mx_open_mailbox (TrashPath, M_APPEND, NULL)) != NULL) {
663 for (i = 0; i < ctx->msgcount; i++)
664 if (ctx->hdrs[i]->deleted && !ctx->hdrs[i]->appended
665 && !ctx->hdrs[i]->purged
666 && mutt_append_message (ctx_trash, ctx, ctx->hdrs[i], 0, 0) == -1) {
667 mx_close_mailbox (ctx_trash, NULL);
671 mx_close_mailbox (ctx_trash, NULL);
674 mutt_error _("Can't open trash folder");
682 /* save changes and close mailbox */
683 static int _mx_close_mailbox (CONTEXT * ctx, int *index_hint)
685 int i, move_messages = 0, purge = 1, read_msgs = 0;
689 char mbox[_POSIX_PATH_MAX];
690 char buf[SHORT_STRING];
698 if (ctx->magic == M_NNTP) {
701 ret = nntp_close_mailbox (ctx);
702 mx_fastclose_mailbox (ctx);
706 if (ctx->readonly || ctx->dontwrite) {
707 /* mailbox is readonly or we don't want to write */
708 mx_fastclose_mailbox (ctx);
713 /* mailbox was opened in write-mode */
714 if (ctx->magic == M_MBOX || ctx->magic == M_MMDF)
715 mbox_close_mailbox (ctx);
717 mx_fastclose_mailbox (ctx);
721 for (i = 0; i < ctx->msgcount; i++) {
722 if (!ctx->hdrs[i]->deleted && ctx->hdrs[i]->read
723 && !(ctx->hdrs[i]->flagged && option (OPTKEEPFLAGGED)))
727 if (read_msgs && quadoption (OPT_MOVE) != M_NO) {
730 if ((p = mutt_find_hook (M_MBOXHOOK, ctx->path))) {
732 m_strcpy(mbox, sizeof(mbox), p);
735 m_strcpy(mbox, sizeof(mbox), NONULL(Inbox));
736 isSpool = mutt_is_spool (ctx->path) && !mutt_is_spool (mbox);
738 mutt_expand_path (mbox, sizeof (mbox));
741 snprintf (buf, sizeof (buf), _("Move read messages to %s?"), mbox);
742 if ((move_messages = query_quadoption (OPT_MOVE, buf)) == -1) {
750 * There is no point in asking whether or not to purge if we are
751 * just marking messages as "trash".
753 if (ctx->deleted && !(ctx->magic == M_MAILDIR && option (OPTMAILDIRTRASH))) {
754 snprintf (buf, sizeof (buf), ctx->deleted == 1
755 ? _("Purge %d deleted message?") :
756 _("Purge %d deleted messages?"), ctx->deleted);
757 if ((purge = query_quadoption (OPT_DELETE, buf)) < 0) {
764 /* IMAP servers manage the OLD flag themselves */
765 if (ctx->magic != M_IMAP)
767 if (option (OPTMARKOLD)) {
768 for (i = 0; i < ctx->msgcount; i++) {
769 if (!ctx->hdrs[i]->deleted && !ctx->hdrs[i]->old)
770 mutt_set_flag (ctx, ctx->hdrs[i], M_OLD, 1);
775 mutt_message (_("Moving read messages to %s..."), mbox);
778 /* try to use server-side copy first */
781 if (ctx->magic == M_IMAP && imap_is_magic (mbox, NULL) == M_IMAP) {
782 /* tag messages for moving, and clear old tags, if any */
783 for (i = 0; i < ctx->msgcount; i++)
784 if (ctx->hdrs[i]->read && !ctx->hdrs[i]->deleted
785 && !(ctx->hdrs[i]->flagged && option (OPTKEEPFLAGGED)))
786 ctx->hdrs[i]->tagged = 1;
788 ctx->hdrs[i]->tagged = 0;
790 i = imap_copy_messages (ctx, NULL, mbox, 1);
793 if (i == 0) /* success */
795 else if (i == -1) { /* horrible error, bail */
799 else /* use regular append-copy mode */
802 if (mx_open_mailbox (mbox, M_APPEND, &f) == NULL) {
807 for (i = 0; i < ctx->msgcount; i++) {
808 if (ctx->hdrs[i]->read && !ctx->hdrs[i]->deleted
809 && !(ctx->hdrs[i]->flagged && option (OPTKEEPFLAGGED))) {
810 if (mutt_append_message (&f, ctx, ctx->hdrs[i], 0, CH_UPDATE_LEN) ==
812 mutt_set_flag (ctx, ctx->hdrs[i], M_DELETE, 1);
813 mutt_set_flag (ctx, ctx->hdrs[i], M_APPENDED, 1);
816 mx_close_mailbox (&f, NULL);
823 mx_close_mailbox (&f, NULL);
827 else if (!ctx->changed && ctx->deleted == 0) {
828 mutt_message _("Mailbox is unchanged.");
830 mx_fastclose_mailbox (ctx);
834 /* copy mails to the trash before expunging */
835 if (purge && ctx->deleted)
836 if (trash_append (ctx) != 0) {
842 /* allow IMAP to preserve the deleted flag across sessions */
843 if (ctx->magic == M_IMAP) {
844 if ((check = imap_sync_mailbox (ctx, purge, index_hint)) != 0) {
853 for (i = 0; i < ctx->msgcount; i++)
854 ctx->hdrs[i]->deleted = 0;
858 if (ctx->changed || ctx->deleted) {
859 if ((check = sync_mailbox (ctx, index_hint)) != 0) {
867 mutt_message (_("%d kept, %d moved, %d deleted."),
868 ctx->msgcount - ctx->deleted, read_msgs, ctx->deleted);
870 mutt_message (_("%d kept, %d deleted."),
871 ctx->msgcount - ctx->deleted, ctx->deleted);
873 if (ctx->msgcount == ctx->deleted &&
874 (ctx->magic == M_MMDF || ctx->magic == M_MBOX) &&
875 !mutt_is_spool (ctx->path) && !option (OPTSAVEEMPTY))
876 mx_unlink_empty (ctx->path);
878 if (ctx->compressinfo && mutt_slow_close_compressed (ctx))
881 mx_fastclose_mailbox (ctx);
886 int mx_close_mailbox (CONTEXT * ctx, int *index_hint) {
890 ret = _mx_close_mailbox (ctx, index_hint);
891 sidebar_set_buffystats (ctx);
895 /* update a Context structure's internal tables. */
897 void mx_update_tables (CONTEXT * ctx, int committing)
901 /* update memory to reflect the new state of the mailbox */
910 #define this_body ctx->hdrs[j]->content
911 for (i = 0, j = 0; i < ctx->msgcount; i++) {
912 if ((committing && (!ctx->hdrs[i]->deleted ||
913 (ctx->magic == M_MAILDIR
914 && option (OPTMAILDIRTRASH)))) || (!committing
918 ctx->hdrs[j] = ctx->hdrs[i];
921 ctx->hdrs[j]->msgno = j;
922 if (ctx->hdrs[j]->virtual != -1) {
923 ctx->v2r[ctx->vcount] = j;
924 ctx->hdrs[j]->virtual = ctx->vcount++;
925 ctx->vsize += this_body->length + this_body->offset -
926 this_body->hdr_offset;
930 ctx->hdrs[j]->changed = 0;
931 else if (ctx->hdrs[j]->changed)
935 || (ctx->magic == M_MAILDIR && option (OPTMAILDIRTRASH))) {
936 if (ctx->hdrs[j]->deleted)
940 if (ctx->hdrs[j]->tagged)
942 if (ctx->hdrs[j]->flagged)
944 if (!ctx->hdrs[j]->read) {
946 if (!ctx->hdrs[j]->old)
953 if (ctx->magic == M_MH || ctx->magic == M_MAILDIR)
954 ctx->size -= (ctx->hdrs[i]->content->length +
955 ctx->hdrs[i]->content->offset -
956 ctx->hdrs[i]->content->hdr_offset);
957 /* remove message from the hash tables */
958 if (ctx->subj_hash && ctx->hdrs[i]->env->real_subj)
959 hash_delete (ctx->subj_hash, ctx->hdrs[i]->env->real_subj,
961 if (ctx->id_hash && ctx->hdrs[i]->env->message_id)
962 hash_delete (ctx->id_hash, ctx->hdrs[i]->env->message_id,
964 mutt_free_header (&ctx->hdrs[i]);
970 /* update sidebar count */
971 sidebar_set_buffystats (ctx);
975 /* save changes to mailbox
981 static int _mx_sync_mailbox (CONTEXT * ctx, int *index_hint)
985 int msgcount, deleted;
987 if (ctx->dontwrite) {
988 char buf[STRING], tmp[STRING];
990 if (km_expand_key (buf, sizeof (buf),
991 km_find_func (MENU_MAIN, OP_TOGGLE_WRITE)))
992 snprintf (tmp, sizeof (tmp), _(" Press '%s' to toggle write"), buf);
994 m_strcpy(tmp, sizeof(tmp), _("Use 'toggle-write' to re-enable write!"));
996 mutt_error (_("Mailbox is marked unwritable. %s"), tmp);
999 else if (ctx->readonly) {
1000 mutt_error _("Mailbox is read-only.");
1005 if (!ctx->changed && !ctx->deleted) {
1006 mutt_message _("Mailbox is unchanged.");
1012 char buf[SHORT_STRING];
1014 snprintf (buf, sizeof (buf), ctx->deleted == 1
1015 ? _("Purge %d deleted message?") :
1016 _("Purge %d deleted messages?"), ctx->deleted);
1017 if ((purge = query_quadoption (OPT_DELETE, buf)) < 0)
1019 else if (purge == M_NO) {
1021 return 0; /* nothing to do! */
1023 /* let IMAP servers hold on to D flags */
1024 if (ctx->magic != M_IMAP)
1027 for (i = 0; i < ctx->msgcount; i++)
1028 ctx->hdrs[i]->deleted = 0;
1032 else if (ctx->last_tag && ctx->last_tag->deleted)
1033 ctx->last_tag = NULL; /* reset last tagged msg now useless */
1036 /* really only for IMAP - imap_sync_mailbox results in a call to
1037 * mx_update_tables, so ctx->deleted is 0 when it comes back */
1038 msgcount = ctx->msgcount;
1039 deleted = ctx->deleted;
1041 if (purge && ctx->deleted) {
1042 if (trash_append (ctx) == -1)
1047 if (ctx->magic == M_IMAP)
1048 rc = imap_sync_mailbox (ctx, purge, index_hint);
1051 rc = sync_mailbox (ctx, index_hint);
1054 if (ctx->magic == M_IMAP && !purge)
1055 mutt_message (_("Mailbox checkpointed."));
1059 mutt_message (_("%d kept, %d deleted."), msgcount - deleted, deleted);
1063 if (ctx->msgcount == ctx->deleted &&
1064 (ctx->magic == M_MBOX || ctx->magic == M_MMDF) &&
1065 !mutt_is_spool (ctx->path) && !option (OPTSAVEEMPTY)) {
1067 mx_fastclose_mailbox (ctx);
1071 /* if we haven't deleted any messages, we don't need to resort */
1072 /* ... except for certain folder formats which need "unsorted"
1073 * sort order in order to synchronize folders.
1075 * MH and maildir are safe. mbox-style seems to need re-sorting,
1076 * at least with the new threading code.
1078 if (purge || (ctx->magic != M_MAILDIR && ctx->magic != M_MH)) {
1080 /* IMAP does this automatically after handling EXPUNGE */
1081 if (ctx->magic != M_IMAP)
1084 mx_update_tables (ctx, 1);
1085 mutt_sort_headers (ctx, 1); /* rethread from scratch */
1093 int mx_sync_mailbox (CONTEXT* ctx, int* index_hint) {
1094 int ret = _mx_sync_mailbox (ctx, index_hint);
1095 sidebar_set_buffystats (ctx);
1100 * dest destintation mailbox
1101 * hdr message being copied (required for maildir support, because
1102 * the filename depends on the message flags)
1104 MESSAGE *mx_open_new_message (CONTEXT * dest, HEADER * hdr, int flags)
1107 address_t *p = NULL;
1109 if (!MX_IDX(dest->magic-1)) {
1110 debug_print (1, ("function unimplemented for mailbox type %d.\n", dest->magic));
1114 msg = p_new(MESSAGE, 1);
1115 msg->magic = dest->magic;
1119 msg->flags.flagged = hdr->flagged;
1120 msg->flags.replied = hdr->replied;
1121 msg->flags.read = hdr->read;
1122 msg->received = hdr->received;
1125 if (msg->received == 0)
1126 time (&msg->received);
1128 if (MX_COMMAND(dest->magic-1,mx_open_new_message)(msg, dest, hdr) == 0) {
1129 if (dest->magic == M_MMDF)
1130 fputs (MMDF_SEP, msg->fp);
1132 if ((msg->magic == M_MBOX || msg->magic == M_MMDF) && flags & M_ADD_FROM) {
1134 if (hdr->env->return_path)
1135 p = hdr->env->return_path;
1136 else if (hdr->env->sender)
1137 p = hdr->env->sender;
1142 fprintf (msg->fp, "From %s %s", p ? p->mailbox : NONULL (Username),
1143 ctime (&msg->received));
1152 /* check for new mail */
1153 int mx_check_mailbox (CONTEXT * ctx, int *index_hint, int lock) {
1154 if (ctx->compressinfo)
1155 return mutt_check_mailbox_compressed (ctx);
1160 if (MX_IDX(ctx->magic-1) && MX_COMMAND(ctx->magic-1,mx_check_mailbox))
1161 return (MX_COMMAND(ctx->magic-1,mx_check_mailbox)(ctx, index_hint, lock));
1164 debug_print (1, ("null or invalid context.\n"));
1169 /* return a stream pointer for a message */
1170 MESSAGE *mx_open_message (CONTEXT * ctx, int msgno)
1174 msg = p_new(MESSAGE, 1);
1175 switch (msg->magic = ctx->magic) {
1184 HEADER *cur = ctx->hdrs[msgno];
1185 char path[_POSIX_PATH_MAX];
1187 snprintf (path, sizeof (path), "%s/%s", ctx->path, cur->path);
1189 if ((msg->fp = fopen (path, "r")) == NULL && errno == ENOENT &&
1190 ctx->magic == M_MAILDIR)
1191 msg->fp = maildir_open_find_message (ctx->path, cur->path);
1193 if (msg->fp == NULL) {
1195 debug_print (1, ("fopen: %s: %s (errno %d).\n", path, strerror (errno), errno));
1204 if (imap_fetch_message (msg, ctx, msgno) != 0)
1208 #endif /* USE_IMAP */
1213 if (pop_fetch_message (msg, ctx, msgno) != 0)
1217 #endif /* USE_POP */
1222 if (nntp_fetch_message (msg, ctx, msgno) != 0)
1226 #endif /* USE_NNTP */
1229 debug_print (1, ("function not implemented for mailbox type %d.\n", ctx->magic));
1236 /* commit a message to a folder */
1238 int mx_commit_message (MESSAGE * msg, CONTEXT * ctx) {
1239 if (!(msg->write && ctx->append)) {
1240 debug_print (1, ("msg->write = %d, ctx->append = %d\n", msg->write, ctx->append));
1243 if (!ctx || !MX_IDX(ctx->magic-1) || !MX_COMMAND(ctx->magic-1,mx_commit_message))
1245 return (MX_COMMAND(ctx->magic-1,mx_commit_message) (msg, ctx));
1248 /* close a pointer to a message */
1249 int mx_close_message (MESSAGE ** msg)
1253 if ((*msg)->magic == M_MH || (*msg)->magic == M_MAILDIR
1255 || (*msg)->magic == M_IMAP
1258 || (*msg)->magic == M_POP
1261 || (*msg)->magic == M_NNTP
1264 r = safe_fclose (&(*msg)->fp);
1270 debug_print (1, ("unlinking %s\n", (*msg)->path));
1271 unlink ((*msg)->path);
1272 p_delete(&(*msg)->path);
1279 void mx_alloc_memory (CONTEXT * ctx)
1282 size_t s = MAX (sizeof (HEADER *), sizeof (int));
1284 if ((ctx->hdrmax + 25) * s < ctx->hdrmax * s) {
1285 mutt_error _("Integer overflow -- can't allocate memory.");
1292 p_realloc(&ctx->hdrs, ctx->hdrmax += 25);
1293 p_realloc(&ctx->v2r, ctx->hdrmax);
1296 ctx->hdrs = p_new(HEADER *, (ctx->hdrmax += 25));
1297 ctx->v2r = p_new(int, ctx->hdrmax);
1299 for (i = ctx->msgcount; i < ctx->hdrmax; i++) {
1300 ctx->hdrs[i] = NULL;
1305 /* this routine is called to update the counts in the context structure for
1306 * the last message header parsed.
1308 void mx_update_context (CONTEXT * ctx, int new_messages)
1313 for (msgno = ctx->msgcount - new_messages; msgno < ctx->msgcount; msgno++) {
1314 h = ctx->hdrs[msgno];
1316 /* NOTE: this _must_ be done before the check for mailcap! */
1317 h->security = crypt_query (h->content);
1319 if (!ctx->pattern) {
1320 ctx->v2r[ctx->vcount] = msgno;
1321 h->virtual = ctx->vcount++;
1327 if (h->env->supersedes) {
1331 ctx->id_hash = mutt_make_id_hash (ctx);
1333 h2 = hash_find (ctx->id_hash, h->env->supersedes);
1335 /* p_delete(&h->env->supersedes); should I ? */
1338 if (!ctx->counting && option (OPTSCORE))
1339 mutt_score_message (ctx, h2, 1);
1343 /* add this message to the hash tables */
1344 if (ctx->id_hash && h->env->message_id)
1345 hash_insert (ctx->id_hash, h->env->message_id, h, 0);
1346 if (!ctx->counting) {
1347 if (ctx->subj_hash && h->env->real_subj)
1348 hash_insert (ctx->subj_hash, h->env->real_subj, h, 1);
1350 if (option (OPTSCORE))
1351 mutt_score_message (ctx, h, 0);
1366 /* update sidebar count */
1367 sidebar_set_buffystats (ctx);
1372 * 1 if the specified mailbox contains 0 messages.
1373 * 0 if the mailbox contains messages
1376 int mx_check_empty (const char *path)
1379 if ((i = mx_get_idx (path)) >= 0 && MX_COMMAND(i,mx_check_empty))
1380 return (MX_COMMAND(i,mx_check_empty)(path));
1385 int mx_acl_check (CONTEXT* ctx, int flag) {
1386 if (!ctx || !MX_IDX(ctx->magic-1))
1388 /* if no acl_check defined for module, assume permission is granted */
1389 if (!MX_COMMAND(ctx->magic-1,mx_acl_check))
1391 return (MX_COMMAND(ctx->magic-1,mx_acl_check)(ctx,flag));
1394 void mx_init (void) {
1398 list_push_back (&MailboxFormats, (void*) mbox_reg_mx ());
1399 list_push_back (&MailboxFormats, (void*) mmdf_reg_mx ());
1400 list_push_back (&MailboxFormats, (void*) mh_reg_mx ());
1401 list_push_back (&MailboxFormats, (void*) maildir_reg_mx ());
1403 list_push_back (&MailboxFormats, (void*) imap_reg_mx ());
1406 list_push_back (&MailboxFormats, (void*) pop_reg_mx ());
1409 list_push_back (&MailboxFormats, (void*) nntp_reg_mx ());
1411 list_push_back (&MailboxFormats, (void*) compress_reg_mx ());
1413 /* check module registration for completeness with debug versions */
1414 #define EXITWITHERR(m) do { fprintf(stderr, "error: incomplete mx module: %s is missing for type %i\n",m,i);exit(1); } while (0)
1415 for (i = 0; i < MailboxFormats->length; i++) {
1416 if (MX_COMMAND(i,type) < 1) EXITWITHERR("type");
1417 if (!MX_COMMAND(i,mx_is_magic)) EXITWITHERR("mx_is_magic");
1418 if (!MX_COMMAND(i,mx_open_mailbox)) EXITWITHERR("mx_open_mailbox");
1419 /* if (!MX_COMMAND(i,mx_sync_mailbox)) EXITWITHERR("mx_sync_mailbox");*/
1425 int mx_rebuild_cache (void) {
1427 mutt_error (_("Support for header caching was not build in."));
1430 int i = 0, magic = 0;
1431 CONTEXT* ctx = NULL;
1434 if (list_empty(Incoming)) {
1435 mutt_error (_("No mailboxes defined."));
1439 for (i = 0; i < Incoming->length; i++) {
1440 b = (BUFFY*) Incoming->data[i];
1441 magic = mx_get_magic (b->path);
1442 if (magic != M_MAILDIR && magic != M_MH
1448 sidebar_set_current (b->path);
1449 sidebar_draw (CurrentMenu);
1450 if ((ctx = mx_open_mailbox (b->path,
1451 M_READONLY | M_NOSORT | M_COUNT,
1453 mx_close_mailbox (ctx, 0);
1455 mutt_clear_error ();
1457 if (Context && Context->path)
1458 sidebar_set_current (Context->path);
1459 sidebar_draw (CurrentMenu);