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.
30 #include "imap/imap.h"
31 #include "imap/mx_imap.h"
36 #include "pop/mx_pop.h"
40 #include "nntp/nntp.h"
41 #include "nntp/mx_nntp.h"
52 #include "mutt_crypt.h"
72 static list2_t* MailboxFormats = NULL;
73 #define MX_COMMAND(idx,cmd) ((mx_t*) MailboxFormats->data[idx])->cmd
74 #define MX_IDX(idx) (idx >= 0 && idx < MailboxFormats->length)
76 #define mutt_is_spool(s) (safe_strcmp (Spoolfile, s) == 0)
81 * retry - should retry if unable to lock?
86 static int invoke_dotlock (const char *path, int dummy, int flags, int retry)
88 char cmd[LONG_STRING + _POSIX_PATH_MAX];
89 char f[SHORT_STRING + _POSIX_PATH_MAX];
92 if (flags & DL_FL_RETRY)
93 snprintf (r, sizeof (r), "-r %d ", retry ? MAXLOCKATTEMPT : 0);
95 mutt_quote_filename (f, sizeof (f), path);
97 snprintf (cmd, sizeof (cmd),
100 flags & DL_FL_TRY ? "-t " : "",
101 flags & DL_FL_UNLOCK ? "-u " : "",
102 flags & DL_FL_USEPRIV ? "-p " : "",
103 flags & DL_FL_FORCE ? "-f " : "",
104 flags & DL_FL_UNLINK ? "-d " : "",
105 flags & DL_FL_RETRY ? r : "", f);
107 return mutt_system (cmd);
112 #define invoke_dotlock dotlock_invoke
116 static int dotlock_file (const char *path, int fd, int retry)
119 int flags = DL_FL_USEPRIV | DL_FL_RETRY;
125 if ((r = invoke_dotlock (path, fd, flags, retry)) == DL_EX_EXIST) {
126 if (!option (OPTNOCURSES)) {
127 char msg[LONG_STRING];
129 snprintf (msg, sizeof (msg),
130 _("Lock count exceeded, remove lock for %s?"), path);
131 if (retry && mutt_yesorno (msg, M_YES) == M_YES) {
132 flags |= DL_FL_FORCE;
139 mutt_error (_("Can't dotlock %s.\n"), path);
142 return (r == DL_EX_OK ? 0 : -1);
145 static int undotlock_file (const char *path, int fd)
147 return (invoke_dotlock (path, fd, DL_FL_USEPRIV | DL_FL_UNLOCK, 0) ==
151 #endif /* USE_DOTLOCK */
153 /* looks up index of type for path in MailboxFormats */
154 static int mx_get_idx (const char* path) {
158 /* first, test all non-local folders to avoid stat() call */
159 for (i = 0; i < MailboxFormats->length; i++) {
160 if (!MX_COMMAND(i,local))
161 t = MX_COMMAND(i,mx_is_magic)(path, NULL);
165 if (stat (path, &st) == 0) {
166 /* if stat() succeeded, keep testing until success and
167 * pass stat() info so that we only need to do it once */
168 for (i = 0; i < MailboxFormats->length; i++) {
169 if (MX_COMMAND(i,local))
170 t = MX_COMMAND(i,mx_is_magic)(path, &st);
179 * excl if excl != 0, request an exclusive lock
180 * dot if dot != 0, try to dotlock the file
181 * timeout should retry locking?
183 int mx_lock_file (const char *path, int fd, int excl, int dot, int timeout)
185 #if defined (USE_FCNTL) || defined (USE_FLOCK)
196 memset (&lck, 0, sizeof (struct flock));
197 lck.l_type = excl ? F_WRLCK : F_RDLCK;
198 lck.l_whence = SEEK_SET;
202 while (fcntl (fd, F_SETLK, &lck) == -1) {
205 dprint (1, (debugfile, "mx_lock_file(): fcntl errno %d.\n", errno));
206 if (errno != EAGAIN && errno != EACCES) {
207 mutt_perror ("fcntl");
211 if (fstat (fd, &sb) != 0)
217 /* only unlock file if it is unchanged */
218 if (prev_sb.st_size == sb.st_size
219 && ++count >= (timeout ? MAXLOCKATTEMPT : 0)) {
221 mutt_error _("Timeout exceeded while attempting fcntl lock!");
228 mutt_message (_("Waiting for fcntl lock... %d"), ++attempt);
231 #endif /* USE_FCNTL */
236 while (flock (fd, (excl ? LOCK_EX : LOCK_SH) | LOCK_NB) == -1) {
239 if (errno != EWOULDBLOCK) {
240 mutt_perror ("flock");
245 if (fstat (fd, &sb) != 0)
251 /* only unlock file if it is unchanged */
252 if (prev_sb.st_size == sb.st_size
253 && ++count >= (timeout ? MAXLOCKATTEMPT : 0)) {
255 mutt_error _("Timeout exceeded while attempting flock lock!");
263 mutt_message (_("Waiting for flock attempt... %d"), ++attempt);
266 #endif /* USE_FLOCK */
270 r = dotlock_file (path, fd, timeout);
271 #endif /* USE_DOTLOCK */
274 /* release any other locks obtained in this routine */
277 lck.l_type = F_UNLCK;
278 fcntl (fd, F_SETLK, &lck);
279 #endif /* USE_FCNTL */
283 #endif /* USE_FLOCK */
291 int mx_unlock_file (const char *path, int fd, int dot)
294 struct flock unlockit = { F_UNLCK, 0, 0, 0 };
296 memset (&unlockit, 0, sizeof (struct flock));
297 unlockit.l_type = F_UNLCK;
298 unlockit.l_whence = SEEK_SET;
299 fcntl (fd, F_SETLK, &unlockit);
308 undotlock_file (path, fd);
314 void mx_unlink_empty (const char *path)
322 if ((fd = open (path, O_RDWR)) == -1)
325 if (mx_lock_file (path, fd, 1, 0, 1) == -1) {
331 invoke_dotlock (path, fd, DL_FL_UNLINK, 1);
333 if (fstat (fd, &sb) == 0 && sb.st_size == 0)
337 mx_unlock_file (path, fd, 0);
341 /* try to figure out what type of mailbox ``path'' is */
342 int mx_get_magic (const char *path) {
345 if (safe_strlen (path) == 0)
347 if ((i = mx_get_idx (path)) >= 0)
348 return (MX_COMMAND(i,type));
352 int mx_is_local (int m) {
355 return (MX_COMMAND(m,local));
359 * set DefaultMagic to the given value
361 int mx_set_magic (const char *s)
363 if (ascii_strcasecmp (s, "mbox") == 0)
364 DefaultMagic = M_MBOX;
365 else if (ascii_strcasecmp (s, "mmdf") == 0)
366 DefaultMagic = M_MMDF;
367 else if (ascii_strcasecmp (s, "mh") == 0)
369 else if (ascii_strcasecmp (s, "maildir") == 0)
370 DefaultMagic = M_MAILDIR;
377 /* mx_access: Wrapper for access, checks permissions on a given mailbox.
378 * We may be interested in using ACL-style flags at some point, currently
379 * we use the normal access() flags. */
380 int mx_access (const char *path, int flags)
384 if ((i = mx_get_idx (path)) >= 0 && MX_COMMAND(i,mx_access))
385 return (MX_COMMAND(i,mx_access)(path,flags));
389 static int mx_open_mailbox_append (CONTEXT * ctx, int flags)
393 #ifdef USE_COMPRESSED
394 /* special case for appending to compressed folders -
395 * even if we can not open them for reading */
396 if (mutt_can_append_compressed (ctx->path))
397 mutt_open_append_compressed (ctx);
404 if (mx_get_magic (ctx->path) == M_IMAP)
405 return imap_open_mailbox_append (ctx);
409 if (stat (ctx->path, &sb) == 0) {
410 ctx->magic = mx_get_magic (ctx->path);
412 switch (ctx->magic) {
414 mutt_error (_("%s is not a mailbox."), ctx->path);
420 else if (errno == ENOENT) {
421 ctx->magic = DefaultMagic;
423 if (ctx->magic == M_MH || ctx->magic == M_MAILDIR) {
424 char tmp[_POSIX_PATH_MAX];
426 if (mkdir (ctx->path, S_IRWXU)) {
427 mutt_perror (ctx->path);
431 if (ctx->magic == M_MAILDIR) {
432 snprintf (tmp, sizeof (tmp), "%s/cur", ctx->path);
433 if (mkdir (tmp, S_IRWXU)) {
439 snprintf (tmp, sizeof (tmp), "%s/new", ctx->path);
440 if (mkdir (tmp, S_IRWXU)) {
442 snprintf (tmp, sizeof (tmp), "%s/cur", ctx->path);
447 snprintf (tmp, sizeof (tmp), "%s/tmp", ctx->path);
448 if (mkdir (tmp, S_IRWXU)) {
450 snprintf (tmp, sizeof (tmp), "%s/cur", ctx->path);
452 snprintf (tmp, sizeof (tmp), "%s/new", ctx->path);
461 snprintf (tmp, sizeof (tmp), "%s/.mh_sequences", ctx->path);
462 if ((i = creat (tmp, S_IRWXU)) == -1) {
472 mutt_perror (ctx->path);
476 switch (ctx->magic) {
480 safe_fopen (ctx->path, flags & M_NEWFOLDER ? "w" : "a")) == NULL
481 || mbox_lock_mailbox (ctx, 1, 1) != 0) {
483 mutt_perror (ctx->path);
485 mutt_error (_("Couldn't lock %s\n"), ctx->path);
486 safe_fclose (&ctx->fp);
490 fseek (ctx->fp, 0, 2);
506 * open a mailbox and parse it
509 * flags M_NOSORT do not sort mailbox
510 * M_APPEND open mailbox for appending
511 * M_READONLY open mailbox in read-only mode
512 * M_QUIET only print error messages
513 * ctx if non-null, context struct to use
515 CONTEXT *mx_open_mailbox (const char *path, int flags, CONTEXT * pctx)
521 ctx = safe_malloc (sizeof (CONTEXT));
522 memset (ctx, 0, sizeof (CONTEXT));
523 ctx->path = safe_strdup (path);
525 ctx->msgnotreadyet = -1;
530 if (flags & M_READONLY)
533 if (flags & (M_APPEND | M_NEWFOLDER)) {
534 if (mx_open_mailbox_append (ctx, flags) != 0) {
535 mx_fastclose_mailbox (ctx);
543 if (!MX_IDX(ctx->magic-1))
544 ctx->magic = mx_get_magic (path);
546 #ifdef USE_COMPRESSED
547 if (ctx->magic == M_COMPRESSED)
548 mutt_open_read_compressed (ctx);
552 mutt_error (_("%s is not a mailbox."), path);
554 if (ctx->magic == -1)
557 if (ctx->magic <= 0) {
558 mx_fastclose_mailbox (ctx);
564 /* if the user has a `push' command in their .muttrc, or in a folder-hook,
565 * it will cause the progress messages not to be displayed because
566 * mutt_refresh() will think we are in the middle of a macro. so set a
567 * flag to indicate that we should really refresh the screen.
569 set_option (OPTFORCEREFRESH);
572 mutt_message (_("Reading %s..."), ctx->path);
574 rc = MX_COMMAND(ctx->magic-1,mx_open_mailbox)(ctx);
577 if ((flags & M_NOSORT) == 0) {
578 /* avoid unnecessary work since the mailbox is completely unthreaded
580 unset_option (OPTSORTSUBTHREADS);
581 unset_option (OPTNEEDRESCORE);
582 mutt_sort_headers (ctx, 1);
588 mx_fastclose_mailbox (ctx);
593 unset_option (OPTFORCEREFRESH);
597 /* free up memory associated with the mailbox context */
598 void mx_fastclose_mailbox (CONTEXT * ctx)
606 if (ctx->magic == M_IMAP)
607 imap_close_mailbox (ctx);
608 #endif /* USE_IMAP */
610 if (ctx->magic == M_POP)
611 pop_close_mailbox (ctx);
614 if (ctx->magic == M_NNTP)
615 nntp_fastclose_mailbox (ctx);
616 #endif /* USE_NNTP */
618 hash_destroy (&ctx->subj_hash, NULL);
620 hash_destroy (&ctx->id_hash, NULL);
621 mutt_clear_threads (ctx);
622 for (i = 0; i < ctx->msgcount; i++)
623 mutt_free_header (&ctx->hdrs[i]);
626 #ifdef USE_COMPRESSED
627 if (ctx->compressinfo)
628 mutt_fast_close_compressed (ctx);
631 FREE (&ctx->pattern);
632 if (ctx->limit_pattern)
633 mutt_pattern_free (&ctx->limit_pattern);
634 safe_fclose (&ctx->fp);
635 memset (ctx, 0, sizeof (CONTEXT));
638 /* save changes to disk */
639 static int sync_mailbox (CONTEXT * ctx, int *index_hint)
647 mutt_message (_("Writing %s..."), ctx->path);
649 switch (ctx->magic) {
652 rc = mbox_sync_mailbox (ctx, index_hint);
654 tmp = mutt_find_mailbox (ctx->path);
660 rc = mh_sync_mailbox (ctx, index_hint);
665 /* extra argument means EXPUNGE */
666 rc = imap_sync_mailbox (ctx, 1, index_hint);
668 #endif /* USE_IMAP */
672 rc = pop_sync_mailbox (ctx, index_hint);
678 rc = nntp_sync_mailbox (ctx);
680 #endif /* USE_NNTP */
684 if (!ctx->quiet && !ctx->shutup && rc == -1)
685 mutt_error (_("Could not synchronize mailbox %s!"), ctx->path);
689 if (tmp && tmp->new == 0)
690 mutt_update_mailbox (tmp);
693 #ifdef USE_COMPRESSED
694 if (rc == 0 && ctx->compressinfo)
695 return mutt_sync_compressed (ctx);
701 /* move deleted mails to the trash folder */
702 static int trash_append (CONTEXT * ctx)
708 if (!TrashPath || !ctx->deleted ||
709 (ctx->magic == M_MAILDIR && option (OPTMAILDIRTRASH)))
712 for (; i < ctx->msgcount && (!ctx->hdrs[i]->deleted ||
713 ctx->hdrs[i]->appended); i++);
714 if (i == ctx->msgcount)
715 return 0; /* nothing to be done */
717 if (mutt_save_confirm (TrashPath, &st) != 0) {
718 mutt_error _("message(s) not deleted");
723 if (lstat (ctx->path, &stc) == 0 && stc.st_ino == st.st_ino
724 && stc.st_dev == st.st_dev && stc.st_rdev == st.st_rdev)
725 return 0; /* we are in the trash folder: simple sync */
727 if ((ctx_trash = mx_open_mailbox (TrashPath, M_APPEND, NULL)) != NULL) {
728 for (i = 0; i < ctx->msgcount; i++)
729 if (ctx->hdrs[i]->deleted && !ctx->hdrs[i]->appended
730 && !ctx->hdrs[i]->purged
731 && mutt_append_message (ctx_trash, ctx, ctx->hdrs[i], 0, 0) == -1) {
732 mx_close_mailbox (ctx_trash, NULL);
736 mx_close_mailbox (ctx_trash, NULL);
739 mutt_error _("Can't open trash folder");
747 /* save changes and close mailbox */
748 int mx_close_mailbox (CONTEXT * ctx, int *index_hint)
750 int i, move_messages = 0, purge = 1, read_msgs = 0;
754 char mbox[_POSIX_PATH_MAX];
755 char buf[SHORT_STRING];
763 if (ctx->magic == M_NNTP) {
766 ret = nntp_close_mailbox (ctx);
767 mx_fastclose_mailbox (ctx);
771 if (ctx->readonly || ctx->dontwrite) {
772 /* mailbox is readonly or we don't want to write */
773 mx_fastclose_mailbox (ctx);
778 /* mailbox was opened in write-mode */
779 if (ctx->magic == M_MBOX || ctx->magic == M_MMDF)
780 mbox_close_mailbox (ctx);
782 mx_fastclose_mailbox (ctx);
786 for (i = 0; i < ctx->msgcount; i++) {
787 if (!ctx->hdrs[i]->deleted && ctx->hdrs[i]->read
788 && !(ctx->hdrs[i]->flagged && option (OPTKEEPFLAGGED)))
792 if (read_msgs && quadoption (OPT_MOVE) != M_NO) {
795 if ((p = mutt_find_hook (M_MBOXHOOK, ctx->path))) {
797 strfcpy (mbox, p, sizeof (mbox));
800 strfcpy (mbox, NONULL (Inbox), sizeof (mbox));
801 isSpool = mutt_is_spool (ctx->path) && !mutt_is_spool (mbox);
803 mutt_expand_path (mbox, sizeof (mbox));
806 snprintf (buf, sizeof (buf), _("Move read messages to %s?"), mbox);
807 if ((move_messages = query_quadoption (OPT_MOVE, buf)) == -1) {
815 * There is no point in asking whether or not to purge if we are
816 * just marking messages as "trash".
818 if (ctx->deleted && !(ctx->magic == M_MAILDIR && option (OPTMAILDIRTRASH))) {
819 snprintf (buf, sizeof (buf), ctx->deleted == 1
820 ? _("Purge %d deleted message?") :
821 _("Purge %d deleted messages?"), ctx->deleted);
822 if ((purge = query_quadoption (OPT_DELETE, buf)) < 0) {
829 /* IMAP servers manage the OLD flag themselves */
830 if (ctx->magic != M_IMAP)
832 if (option (OPTMARKOLD)) {
833 for (i = 0; i < ctx->msgcount; i++) {
834 if (!ctx->hdrs[i]->deleted && !ctx->hdrs[i]->old)
835 mutt_set_flag (ctx, ctx->hdrs[i], M_OLD, 1);
840 mutt_message (_("Moving read messages to %s..."), mbox);
843 /* try to use server-side copy first */
846 if (ctx->magic == M_IMAP && imap_is_magic (mbox, NULL) == M_IMAP) {
847 /* tag messages for moving, and clear old tags, if any */
848 for (i = 0; i < ctx->msgcount; i++)
849 if (ctx->hdrs[i]->read && !ctx->hdrs[i]->deleted
850 && !(ctx->hdrs[i]->flagged && option (OPTKEEPFLAGGED)))
851 ctx->hdrs[i]->tagged = 1;
853 ctx->hdrs[i]->tagged = 0;
855 i = imap_copy_messages (ctx, NULL, mbox, 1);
858 if (i == 0) /* success */
860 else if (i == -1) { /* horrible error, bail */
864 else /* use regular append-copy mode */
867 if (mx_open_mailbox (mbox, M_APPEND, &f) == NULL) {
872 for (i = 0; i < ctx->msgcount; i++) {
873 if (ctx->hdrs[i]->read && !ctx->hdrs[i]->deleted
874 && !(ctx->hdrs[i]->flagged && option (OPTKEEPFLAGGED))) {
875 if (mutt_append_message (&f, ctx, ctx->hdrs[i], 0, CH_UPDATE_LEN) ==
877 mutt_set_flag (ctx, ctx->hdrs[i], M_DELETE, 1);
878 mutt_set_flag (ctx, ctx->hdrs[i], M_APPENDED, 1);
881 mx_close_mailbox (&f, NULL);
888 mx_close_mailbox (&f, NULL);
892 else if (!ctx->changed && ctx->deleted == 0) {
893 mutt_message _("Mailbox is unchanged.");
895 mx_fastclose_mailbox (ctx);
899 /* copy mails to the trash before expunging */
900 if (purge && ctx->deleted)
901 if (trash_append (ctx) != 0) {
907 /* allow IMAP to preserve the deleted flag across sessions */
908 if (ctx->magic == M_IMAP) {
909 if ((check = imap_sync_mailbox (ctx, purge, index_hint)) != 0) {
918 for (i = 0; i < ctx->msgcount; i++)
919 ctx->hdrs[i]->deleted = 0;
923 if (ctx->changed || ctx->deleted) {
924 if ((check = sync_mailbox (ctx, index_hint)) != 0) {
932 mutt_message (_("%d kept, %d moved, %d deleted."),
933 ctx->msgcount - ctx->deleted, read_msgs, ctx->deleted);
935 mutt_message (_("%d kept, %d deleted."),
936 ctx->msgcount - ctx->deleted, ctx->deleted);
938 if (ctx->msgcount == ctx->deleted &&
939 (ctx->magic == M_MMDF || ctx->magic == M_MBOX) &&
940 !mutt_is_spool (ctx->path) && !option (OPTSAVEEMPTY))
941 mx_unlink_empty (ctx->path);
943 #ifdef USE_COMPRESSED
944 if (ctx->compressinfo && mutt_slow_close_compressed (ctx))
948 mx_fastclose_mailbox (ctx);
954 /* update a Context structure's internal tables. */
956 void mx_update_tables (CONTEXT * ctx, int committing)
960 /* update memory to reflect the new state of the mailbox */
969 #define this_body ctx->hdrs[j]->content
970 for (i = 0, j = 0; i < ctx->msgcount; i++) {
971 if ((committing && (!ctx->hdrs[i]->deleted ||
972 (ctx->magic == M_MAILDIR
973 && option (OPTMAILDIRTRASH)))) || (!committing
977 ctx->hdrs[j] = ctx->hdrs[i];
980 ctx->hdrs[j]->msgno = j;
981 if (ctx->hdrs[j]->virtual != -1) {
982 ctx->v2r[ctx->vcount] = j;
983 ctx->hdrs[j]->virtual = ctx->vcount++;
984 ctx->vsize += this_body->length + this_body->offset -
985 this_body->hdr_offset;
989 ctx->hdrs[j]->changed = 0;
990 else if (ctx->hdrs[j]->changed)
994 || (ctx->magic == M_MAILDIR && option (OPTMAILDIRTRASH))) {
995 if (ctx->hdrs[j]->deleted)
999 if (ctx->hdrs[j]->tagged)
1001 if (ctx->hdrs[j]->flagged)
1003 if (!ctx->hdrs[j]->read) {
1005 if (!ctx->hdrs[j]->old)
1012 if (ctx->magic == M_MH || ctx->magic == M_MAILDIR)
1013 ctx->size -= (ctx->hdrs[i]->content->length +
1014 ctx->hdrs[i]->content->offset -
1015 ctx->hdrs[i]->content->hdr_offset);
1016 /* remove message from the hash tables */
1017 if (ctx->subj_hash && ctx->hdrs[i]->env->real_subj)
1018 hash_delete (ctx->subj_hash, ctx->hdrs[i]->env->real_subj,
1019 ctx->hdrs[i], NULL);
1020 if (ctx->id_hash && ctx->hdrs[i]->env->message_id)
1021 hash_delete (ctx->id_hash, ctx->hdrs[i]->env->message_id,
1022 ctx->hdrs[i], NULL);
1023 mutt_free_header (&ctx->hdrs[i]);
1031 /* save changes to mailbox
1037 int mx_sync_mailbox (CONTEXT * ctx, int *index_hint)
1041 int msgcount, deleted;
1043 if (ctx->dontwrite) {
1044 char buf[STRING], tmp[STRING];
1046 if (km_expand_key (buf, sizeof (buf),
1047 km_find_func (MENU_MAIN, OP_TOGGLE_WRITE)))
1048 snprintf (tmp, sizeof (tmp), _(" Press '%s' to toggle write"), buf);
1050 strfcpy (tmp, _("Use 'toggle-write' to re-enable write!"),
1053 mutt_error (_("Mailbox is marked unwritable. %s"), tmp);
1056 else if (ctx->readonly) {
1057 mutt_error _("Mailbox is read-only.");
1062 if (!ctx->changed && !ctx->deleted) {
1063 mutt_message _("Mailbox is unchanged.");
1069 char buf[SHORT_STRING];
1071 snprintf (buf, sizeof (buf), ctx->deleted == 1
1072 ? _("Purge %d deleted message?") :
1073 _("Purge %d deleted messages?"), ctx->deleted);
1074 if ((purge = query_quadoption (OPT_DELETE, buf)) < 0)
1076 else if (purge == M_NO) {
1078 return 0; /* nothing to do! */
1080 /* let IMAP servers hold on to D flags */
1081 if (ctx->magic != M_IMAP)
1084 for (i = 0; i < ctx->msgcount; i++)
1085 ctx->hdrs[i]->deleted = 0;
1089 else if (ctx->last_tag && ctx->last_tag->deleted)
1090 ctx->last_tag = NULL; /* reset last tagged msg now useless */
1093 /* really only for IMAP - imap_sync_mailbox results in a call to
1094 * mx_update_tables, so ctx->deleted is 0 when it comes back */
1095 msgcount = ctx->msgcount;
1096 deleted = ctx->deleted;
1098 if (purge && ctx->deleted) {
1099 if (trash_append (ctx) == -1)
1104 if (ctx->magic == M_IMAP)
1105 rc = imap_sync_mailbox (ctx, purge, index_hint);
1108 rc = sync_mailbox (ctx, index_hint);
1111 if (ctx->magic == M_IMAP && !purge)
1112 mutt_message (_("Mailbox checkpointed."));
1116 mutt_message (_("%d kept, %d deleted."), msgcount - deleted, deleted);
1120 if (ctx->msgcount == ctx->deleted &&
1121 (ctx->magic == M_MBOX || ctx->magic == M_MMDF) &&
1122 !mutt_is_spool (ctx->path) && !option (OPTSAVEEMPTY)) {
1124 mx_fastclose_mailbox (ctx);
1128 /* if we haven't deleted any messages, we don't need to resort */
1129 /* ... except for certain folder formats which need "unsorted"
1130 * sort order in order to synchronize folders.
1132 * MH and maildir are safe. mbox-style seems to need re-sorting,
1133 * at least with the new threading code.
1135 if (purge || (ctx->magic != M_MAILDIR && ctx->magic != M_MH)) {
1137 /* IMAP does this automatically after handling EXPUNGE */
1138 if (ctx->magic != M_IMAP)
1141 mx_update_tables (ctx, 1);
1142 mutt_sort_headers (ctx, 1); /* rethread from scratch */
1151 int imap_open_new_message (MESSAGE * msg, CONTEXT * dest, HEADER * hdr)
1153 char tmp[_POSIX_PATH_MAX];
1156 if ((msg->fp = safe_fopen (tmp, "w")) == NULL)
1158 msg->path = safe_strdup (tmp);
1164 * dest destintation mailbox
1165 * hdr message being copied (required for maildir support, because
1166 * the filename depends on the message flags)
1168 MESSAGE *mx_open_new_message (CONTEXT * dest, HEADER * hdr, int flags)
1171 int (*func) (MESSAGE *, CONTEXT *, HEADER *);
1174 switch (dest->magic) {
1177 func = mbox_open_new_message;
1180 func = maildir_open_new_message;
1183 func = mh_open_new_message;
1187 func = imap_open_new_message;
1193 "mx_open_new_message(): function unimplemented for mailbox type %d.\n",
1198 msg = safe_calloc (1, sizeof (MESSAGE));
1199 msg->magic = dest->magic;
1203 msg->flags.flagged = hdr->flagged;
1204 msg->flags.replied = hdr->replied;
1205 msg->flags.read = hdr->read;
1206 msg->received = hdr->received;
1209 if (msg->received == 0)
1210 time (&msg->received);
1212 if (func (msg, dest, hdr) == 0) {
1213 if (dest->magic == M_MMDF)
1214 fputs (MMDF_SEP, msg->fp);
1216 if ((msg->magic == M_MBOX || msg->magic == M_MMDF) && flags & M_ADD_FROM) {
1218 if (hdr->env->return_path)
1219 p = hdr->env->return_path;
1220 else if (hdr->env->sender)
1221 p = hdr->env->sender;
1226 fprintf (msg->fp, "From %s %s", p ? p->mailbox : NONULL (Username),
1227 ctime (&msg->received));
1236 /* check for new mail */
1237 int mx_check_mailbox (CONTEXT * ctx, int *index_hint, int lock)
1241 #ifdef USE_COMPRESSED
1242 if (ctx->compressinfo)
1243 return mutt_check_mailbox_compressed (ctx);
1250 switch (ctx->magic) {
1255 mutt_block_signals ();
1256 if (mbox_lock_mailbox (ctx, 0, 0) == -1) {
1257 mutt_unblock_signals ();
1262 rc = mbox_check_mailbox (ctx, index_hint);
1265 mutt_unblock_signals ();
1266 mbox_unlock_mailbox (ctx);
1273 return (mh_check_mailbox (ctx, index_hint));
1275 return (maildir_check_mailbox (ctx, index_hint));
1279 return (imap_check_mailbox (ctx, index_hint, 0));
1280 #endif /* USE_IMAP */
1284 return (pop_check_mailbox (ctx, index_hint));
1285 #endif /* USE_POP */
1289 return (nntp_check_mailbox (ctx));
1290 #endif /* USE_NNTP */
1294 dprint (1, (debugfile, "mx_check_mailbox: null or invalid context.\n"));
1298 /* return a stream pointer for a message */
1299 MESSAGE *mx_open_message (CONTEXT * ctx, int msgno)
1303 msg = safe_calloc (1, sizeof (MESSAGE));
1304 switch (msg->magic = ctx->magic) {
1313 HEADER *cur = ctx->hdrs[msgno];
1314 char path[_POSIX_PATH_MAX];
1316 snprintf (path, sizeof (path), "%s/%s", ctx->path, cur->path);
1318 if ((msg->fp = fopen (path, "r")) == NULL && errno == ENOENT &&
1319 ctx->magic == M_MAILDIR)
1320 msg->fp = maildir_open_find_message (ctx->path, cur->path);
1322 if (msg->fp == NULL) {
1324 dprint (1, (debugfile, "mx_open_message: fopen: %s: %s (errno %d).\n",
1325 path, strerror (errno), errno));
1334 if (imap_fetch_message (msg, ctx, msgno) != 0)
1338 #endif /* USE_IMAP */
1343 if (pop_fetch_message (msg, ctx, msgno) != 0)
1347 #endif /* USE_POP */
1352 if (nntp_fetch_message (msg, ctx, msgno) != 0)
1356 #endif /* USE_NNTP */
1361 "mx_open_message(): function not implemented for mailbox type %d.\n",
1369 /* commit a message to a folder */
1371 int mx_commit_message (MESSAGE * msg, CONTEXT * ctx)
1375 if (!(msg->write && ctx->append)) {
1378 "mx_commit_message(): msg->write = %d, ctx->append = %d\n",
1379 msg->write, ctx->append));
1383 switch (msg->magic) {
1386 if (fputs (MMDF_SEP, msg->fp) == EOF)
1393 if (fputc ('\n', msg->fp) == EOF)
1401 if ((r = safe_fclose (&msg->fp)) == 0)
1402 r = imap_append_message (ctx, msg);
1409 r = maildir_commit_message (ctx, msg, NULL);
1415 r = mh_commit_message (ctx, msg, NULL);
1420 if (r == 0 && (ctx->magic == M_MBOX || ctx->magic == M_MMDF)
1421 && (fflush (msg->fp) == EOF || fsync (fileno (msg->fp)) == -1)) {
1422 mutt_perror (_("Can't write message"));
1430 /* close a pointer to a message */
1431 int mx_close_message (MESSAGE ** msg)
1435 if ((*msg)->magic == M_MH || (*msg)->magic == M_MAILDIR
1437 || (*msg)->magic == M_IMAP
1440 || (*msg)->magic == M_POP
1443 || (*msg)->magic == M_NNTP
1446 r = safe_fclose (&(*msg)->fp);
1452 dprint (1, (debugfile, "mx_close_message (): unlinking %s\n",
1454 unlink ((*msg)->path);
1455 FREE (&(*msg)->path);
1462 void mx_alloc_memory (CONTEXT * ctx)
1465 size_t s = MAX (sizeof (HEADER *), sizeof (int));
1467 if ((ctx->hdrmax + 25) * s < ctx->hdrmax * s) {
1468 mutt_error _("Integer overflow -- can't allocate memory.");
1475 safe_realloc (&ctx->hdrs, sizeof (HEADER *) * (ctx->hdrmax += 25));
1476 safe_realloc (&ctx->v2r, sizeof (int) * ctx->hdrmax);
1479 ctx->hdrs = safe_calloc ((ctx->hdrmax += 25), sizeof (HEADER *));
1480 ctx->v2r = safe_calloc (ctx->hdrmax, sizeof (int));
1482 for (i = ctx->msgcount; i < ctx->hdrmax; i++) {
1483 ctx->hdrs[i] = NULL;
1488 /* this routine is called to update the counts in the context structure for
1489 * the last message header parsed.
1491 void mx_update_context (CONTEXT * ctx, int new_messages)
1496 for (msgno = ctx->msgcount - new_messages; msgno < ctx->msgcount; msgno++) {
1497 h = ctx->hdrs[msgno];
1500 /* NOTE: this _must_ be done before the check for mailcap! */
1501 h->security = crypt_query (h->content);
1504 if (!ctx->pattern) {
1505 ctx->v2r[ctx->vcount] = msgno;
1506 h->virtual = ctx->vcount++;
1512 if (h->env->supersedes) {
1516 ctx->id_hash = mutt_make_id_hash (ctx);
1518 h2 = hash_find (ctx->id_hash, h->env->supersedes);
1520 /* FREE (&h->env->supersedes); should I ? */
1523 if (option (OPTSCORE))
1524 mutt_score_message (ctx, h2, 1);
1528 /* add this message to the hash tables */
1529 if (ctx->id_hash && h->env->message_id)
1530 hash_insert (ctx->id_hash, h->env->message_id, h, 0);
1531 if (ctx->subj_hash && h->env->real_subj)
1532 hash_insert (ctx->subj_hash, h->env->real_subj, h, 1);
1534 if (option (OPTSCORE))
1535 mutt_score_message (ctx, h, 0);
1553 * 1 if the specified mailbox contains 0 messages.
1554 * 0 if the mailbox contains messages
1557 int mx_check_empty (const char *path)
1560 if ((i = mx_get_idx (path)) >= 0 && MX_COMMAND(i,mx_check_empty))
1561 return (MX_COMMAND(i,mx_check_empty)(path));
1566 int mx_acl_check (CONTEXT* ctx, int flag) {
1567 if (!ctx || !MX_IDX(ctx->magic-1))
1569 /* if no acl_check defined for module, assume permission is granted */
1570 if (!MX_COMMAND(ctx->magic-1,mx_acl_check))
1572 return (MX_COMMAND(ctx->magic-1,mx_acl_check)(ctx,flag));
1575 void mx_init (void) {
1579 list_push_back (&MailboxFormats, (void*) mbox_reg_mx ());
1580 list_push_back (&MailboxFormats, (void*) mmdf_reg_mx ());
1581 list_push_back (&MailboxFormats, (void*) mh_reg_mx ());
1582 list_push_back (&MailboxFormats, (void*) maildir_reg_mx ());
1584 list_push_back (&MailboxFormats, (void*) imap_reg_mx ());
1587 list_push_back (&MailboxFormats, (void*) pop_reg_mx ());
1590 list_push_back (&MailboxFormats, (void*) nntp_reg_mx ());
1592 #ifdef USE_COMPRESSED
1593 list_push_back (&MailboxFormats, (void*) compress_reg_mx ());
1596 /* check module registration for completeness with debug versions */
1597 #define EXITWITHERR(m) do { fprintf(stderr, "error: incomplete mx module: %s is missing for type %i\n",m,i);exit(1); } while (0)
1598 for (i = 0; i < MailboxFormats->length; i++) {
1599 if (MX_COMMAND(i,type) < 1) EXITWITHERR("type");
1600 if (!MX_COMMAND(i,mx_is_magic)) EXITWITHERR("mx_is_magic");
1601 if (!MX_COMMAND(i,mx_open_mailbox)) EXITWITHERR("mx_open_mailbox");