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/url.h>
33 #include <lib-sys/unix.h>
35 #include <lib-mime/mime.h>
37 #include <lib-ui/sidebar.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 if (errno != EAGAIN && errno != EACCES) {
196 mutt_perror ("fcntl");
200 if (fstat (fd, &sb) != 0)
206 /* only unlock file if it is unchanged */
207 if (prev_sb.st_size == sb.st_size
208 && ++count >= (time_out ? MAXLOCKATTEMPT : 0)) {
210 mutt_error _("Timeout exceeded while attempting fcntl lock!");
217 mutt_message (_("Waiting for fcntl lock... %d"), ++attempt);
220 #endif /* USE_FCNTL */
225 while (flock (fd, (excl ? LOCK_EX : LOCK_SH) | LOCK_NB) == -1) {
228 if (errno != EWOULDBLOCK) {
229 mutt_perror ("flock");
234 if (fstat (fd, &sb) != 0)
240 /* only unlock file if it is unchanged */
241 if (prev_sb.st_size == sb.st_size
242 && ++count >= (time_out ? MAXLOCKATTEMPT : 0)) {
244 mutt_error _("Timeout exceeded while attempting flock lock!");
252 mutt_message (_("Waiting for flock attempt... %d"), ++attempt);
255 #endif /* USE_FLOCK */
259 r = dotlock_file (path, fd, time_out);
260 #endif /* USE_DOTLOCK */
263 /* release any other locks obtained in this routine */
266 lck.l_type = F_UNLCK;
267 fcntl (fd, F_SETLK, &lck);
268 #endif /* USE_FCNTL */
272 #endif /* USE_FLOCK */
280 int mx_unlock_file (const char *path, int fd, int dot)
283 struct flock unlockit;
285 p_clear(&unlockit, 1);
286 unlockit.l_type = F_UNLCK;
287 unlockit.l_whence = SEEK_SET;
288 fcntl (fd, F_SETLK, &unlockit);
297 undotlock_file (path, fd);
303 void mx_unlink_empty (const char *path)
311 if ((fd = open (path, O_RDWR)) == -1)
314 if (mx_lock_file (path, fd, 1, 0, 1) == -1) {
320 invoke_dotlock (path, fd, DL_FL_UNLINK, 1);
322 if (fstat (fd, &sb) == 0 && sb.st_size == 0)
326 mx_unlock_file (path, fd, 0);
330 /* try to figure out what type of mailbox ``path'' is */
331 int mx_get_magic (const char *path) {
334 if (m_strlen(path) == 0)
336 if ((i = mx_get_idx (path)) >= 0)
337 return (MX_COMMAND(i,type));
341 int mx_is_local (int m) {
344 return (MX_COMMAND(m,local));
348 * set DefaultMagic to the given value
350 int mx_set_magic (const char *s)
352 if (ascii_strcasecmp (s, "mbox") == 0)
353 DefaultMagic = M_MBOX;
354 else if (ascii_strcasecmp (s, "mmdf") == 0)
355 DefaultMagic = M_MMDF;
356 else if (ascii_strcasecmp (s, "mh") == 0)
358 else if (ascii_strcasecmp (s, "maildir") == 0)
359 DefaultMagic = M_MAILDIR;
366 /* mx_access: Wrapper for access, checks permissions on a given mailbox.
367 * We may be interested in using ACL-style flags at some point, currently
368 * we use the normal access() flags. */
369 int mx_access (const char *path, int flags)
373 if ((i = mx_get_idx (path)) >= 0 && MX_COMMAND(i,mx_access))
374 return (MX_COMMAND(i,mx_access)(path,flags));
378 static int mx_open_mailbox_append (CONTEXT * ctx, int flags)
382 /* special case for appending to compressed folders -
383 * even if we can not open them for reading */
384 if (mutt_can_append_compressed (ctx->path))
385 mutt_open_append_compressed (ctx);
389 if (mx_get_magic (ctx->path) == M_IMAP)
390 return imap_open_mailbox_append (ctx);
392 if (stat (ctx->path, &sb) == 0) {
393 ctx->magic = mx_get_magic (ctx->path);
395 switch (ctx->magic) {
397 mutt_error (_("%s is not a mailbox."), ctx->path);
403 else if (errno == ENOENT) {
404 ctx->magic = DefaultMagic;
406 if (ctx->magic == M_MH || ctx->magic == M_MAILDIR) {
407 char tmp[_POSIX_PATH_MAX];
409 if (mkdir (ctx->path, S_IRWXU)) {
410 mutt_perror (ctx->path);
414 if (ctx->magic == M_MAILDIR) {
415 snprintf (tmp, sizeof (tmp), "%s/cur", ctx->path);
416 if (mkdir (tmp, S_IRWXU)) {
422 snprintf (tmp, sizeof (tmp), "%s/new", ctx->path);
423 if (mkdir (tmp, S_IRWXU)) {
425 snprintf (tmp, sizeof (tmp), "%s/cur", ctx->path);
430 snprintf (tmp, sizeof (tmp), "%s/tmp", ctx->path);
431 if (mkdir (tmp, S_IRWXU)) {
433 snprintf (tmp, sizeof (tmp), "%s/cur", ctx->path);
435 snprintf (tmp, sizeof (tmp), "%s/new", ctx->path);
444 snprintf (tmp, sizeof (tmp), "%s/.mh_sequences", ctx->path);
445 if ((i = creat (tmp, S_IRWXU)) == -1) {
455 mutt_perror (ctx->path);
459 switch (ctx->magic) {
463 safe_fopen (ctx->path, flags & M_NEWFOLDER ? "w" : "a")) == NULL
464 || mbox_lock_mailbox (ctx, 1, 1) != 0) {
466 mutt_perror (ctx->path);
468 mutt_error (_("Couldn't lock %s\n"), ctx->path);
469 safe_fclose (&ctx->fp);
473 fseeko (ctx->fp, 0, 2);
489 * open a mailbox and parse it
492 * flags M_NOSORT do not sort mailbox
493 * M_APPEND open mailbox for appending
494 * M_READONLY open mailbox in read-only mode
495 * M_QUIET only print error messages
496 * ctx if non-null, context struct to use
498 CONTEXT *mx_open_mailbox (const char *path, int flags, CONTEXT * pctx)
504 ctx = p_new(CONTEXT, 1);
506 ctx->path = m_strdup(path);
508 ctx->msgnotreadyet = -1;
513 if (flags & M_READONLY)
518 if (flags & (M_APPEND | M_NEWFOLDER)) {
519 if (mx_open_mailbox_append (ctx, flags) != 0) {
520 mx_fastclose_mailbox (ctx);
528 if (!MX_IDX(ctx->magic-1))
529 ctx->magic = mx_get_magic (path);
531 if (ctx->magic == M_COMPRESSED)
532 mutt_open_read_compressed (ctx);
535 mutt_error (_("%s is not a mailbox."), path);
537 if (ctx->magic == -1)
540 if (ctx->magic <= 0) {
541 mx_fastclose_mailbox (ctx);
547 /* if the user has a `push' command in their .muttrc, or in a folder-hook,
548 * it will cause the progress messages not to be displayed because
549 * mutt_refresh() will think we are in the middle of a macro. so set a
550 * flag to indicate that we should really refresh the screen.
552 set_option (OPTFORCEREFRESH);
555 mutt_message (_("Reading %s..."), ctx->path);
557 rc = MX_COMMAND(ctx->magic-1,mx_open_mailbox)(ctx);
560 if ((flags & M_NOSORT) == 0) {
561 /* avoid unnecessary work since the mailbox is completely unthreaded
563 unset_option (OPTSORTSUBTHREADS);
564 unset_option (OPTNEEDRESCORE);
565 mutt_sort_headers (ctx, 1);
571 mx_fastclose_mailbox (ctx);
576 unset_option (OPTFORCEREFRESH);
580 /* free up memory associated with the mailbox context */
581 void mx_fastclose_mailbox (CONTEXT * ctx)
588 if (MX_IDX(ctx->magic-1) && MX_COMMAND(ctx->magic-1,mx_fastclose_mailbox))
589 MX_COMMAND(ctx->magic-1,mx_fastclose_mailbox(ctx));
591 hash_destroy (&ctx->subj_hash, NULL);
593 hash_destroy (&ctx->id_hash, NULL);
594 mutt_clear_threads (ctx);
595 for (i = 0; i < ctx->msgcount; i++)
596 header_delete(&ctx->hdrs[i]);
597 p_delete(&ctx->hdrs);
600 if (ctx->compressinfo)
601 mutt_fast_close_compressed (ctx);
603 p_delete(&ctx->path);
604 p_delete(&ctx->pattern);
605 if (ctx->limit_pattern)
606 mutt_pattern_free (&ctx->limit_pattern);
607 safe_fclose (&ctx->fp);
611 /* save changes to disk */
612 static int sync_mailbox (CONTEXT * ctx, int *index_hint)
617 mutt_message (_("Writing %s..."), ctx->path);
619 if (MX_IDX(ctx->magic-1))
620 /* the 1 is only of interest for IMAP and means EXPUNGE */
621 rc = MX_COMMAND(ctx->magic-1,mx_sync_mailbox(ctx,1,index_hint));
623 if (rc == 0 && ctx->compressinfo)
624 return mutt_sync_compressed (ctx);
629 /* move deleted mails to the trash folder */
630 static int trash_append (CONTEXT * ctx)
636 if (!TrashPath || !ctx->deleted ||
637 (ctx->magic == M_MAILDIR && option (OPTMAILDIRTRASH)))
640 for (; i < ctx->msgcount && (!ctx->hdrs[i]->deleted ||
641 ctx->hdrs[i]->appended); i++);
642 if (i == ctx->msgcount)
643 return 0; /* nothing to be done */
645 if (mutt_save_confirm (TrashPath, &st) != 0) {
646 mutt_error _("message(s) not deleted");
651 if (lstat (ctx->path, &stc) == 0 && stc.st_ino == st.st_ino
652 && stc.st_dev == st.st_dev && stc.st_rdev == st.st_rdev)
653 return 0; /* we are in the trash folder: simple sync */
655 if ((ctx_trash = mx_open_mailbox (TrashPath, M_APPEND, NULL)) != NULL) {
656 for (i = 0; i < ctx->msgcount; i++)
657 if (ctx->hdrs[i]->deleted && !ctx->hdrs[i]->appended
658 && !ctx->hdrs[i]->purged
659 && mutt_append_message (ctx_trash, ctx, ctx->hdrs[i], 0, 0) == -1) {
660 mx_close_mailbox (ctx_trash, NULL);
664 mx_close_mailbox (ctx_trash, NULL);
667 mutt_error _("Can't open trash folder");
675 /* save changes and close mailbox */
676 static int _mx_close_mailbox (CONTEXT * ctx, int *index_hint)
678 int i, move_messages = 0, purge = 1, read_msgs = 0;
682 char mbox[_POSIX_PATH_MAX];
683 char buf[SHORT_STRING];
691 if (ctx->magic == M_NNTP) {
694 ret = nntp_close_mailbox (ctx);
695 mx_fastclose_mailbox (ctx);
699 if (ctx->readonly || ctx->dontwrite) {
700 /* mailbox is readonly or we don't want to write */
701 mx_fastclose_mailbox (ctx);
706 /* mailbox was opened in write-mode */
707 if (ctx->magic == M_MBOX || ctx->magic == M_MMDF)
708 mbox_close_mailbox (ctx);
710 mx_fastclose_mailbox (ctx);
714 for (i = 0; i < ctx->msgcount; i++) {
715 if (!ctx->hdrs[i]->deleted && ctx->hdrs[i]->read
716 && !(ctx->hdrs[i]->flagged && option (OPTKEEPFLAGGED)))
720 if (read_msgs && quadoption (OPT_MOVE) != M_NO) {
723 if ((p = mutt_find_hook (M_MBOXHOOK, ctx->path))) {
725 m_strcpy(mbox, sizeof(mbox), p);
728 m_strcpy(mbox, sizeof(mbox), NONULL(Inbox));
729 isSpool = mutt_is_spool (ctx->path) && !mutt_is_spool (mbox);
731 mutt_expand_path (mbox, sizeof (mbox));
734 snprintf (buf, sizeof (buf), _("Move read messages to %s?"), mbox);
735 if ((move_messages = query_quadoption (OPT_MOVE, buf)) == -1) {
743 * There is no point in asking whether or not to purge if we are
744 * just marking messages as "trash".
746 if (ctx->deleted && !(ctx->magic == M_MAILDIR && option (OPTMAILDIRTRASH))) {
747 snprintf (buf, sizeof (buf), ctx->deleted == 1
748 ? _("Purge %d deleted message?") :
749 _("Purge %d deleted messages?"), ctx->deleted);
750 if ((purge = query_quadoption (OPT_DELETE, buf)) < 0) {
756 /* IMAP servers manage the OLD flag themselves */
757 if (ctx->magic != M_IMAP)
758 if (option (OPTMARKOLD)) {
759 for (i = 0; i < ctx->msgcount; i++) {
760 if (!ctx->hdrs[i]->deleted && !ctx->hdrs[i]->old)
761 mutt_set_flag (ctx, ctx->hdrs[i], M_OLD, 1);
766 mutt_message (_("Moving read messages to %s..."), mbox);
768 /* try to use server-side copy first */
771 if (ctx->magic == M_IMAP && imap_is_magic (mbox, NULL) == M_IMAP) {
772 /* tag messages for moving, and clear old tags, if any */
773 for (i = 0; i < ctx->msgcount; i++)
774 if (ctx->hdrs[i]->read && !ctx->hdrs[i]->deleted
775 && !(ctx->hdrs[i]->flagged && option (OPTKEEPFLAGGED)))
776 ctx->hdrs[i]->tagged = 1;
778 ctx->hdrs[i]->tagged = 0;
780 i = imap_copy_messages (ctx, NULL, mbox, 1);
783 if (i == 0) /* success */
785 else if (i == -1) { /* horrible error, bail */
789 else /* use regular append-copy mode */
791 if (mx_open_mailbox (mbox, M_APPEND, &f) == NULL) {
796 for (i = 0; i < ctx->msgcount; i++) {
797 if (ctx->hdrs[i]->read && !ctx->hdrs[i]->deleted
798 && !(ctx->hdrs[i]->flagged && option (OPTKEEPFLAGGED))) {
799 if (mutt_append_message (&f, ctx, ctx->hdrs[i], 0, CH_UPDATE_LEN) ==
801 mutt_set_flag (ctx, ctx->hdrs[i], M_DELETE, 1);
802 mutt_set_flag (ctx, ctx->hdrs[i], M_APPENDED, 1);
805 mx_close_mailbox (&f, NULL);
812 mx_close_mailbox (&f, NULL);
816 else if (!ctx->changed && ctx->deleted == 0) {
817 mutt_message _("Mailbox is unchanged.");
819 mx_fastclose_mailbox (ctx);
823 /* copy mails to the trash before expunging */
824 if (purge && ctx->deleted)
825 if (trash_append (ctx) != 0) {
830 /* allow IMAP to preserve the deleted flag across sessions */
831 if (ctx->magic == M_IMAP) {
832 if ((check = imap_sync_mailbox (ctx, purge, index_hint)) != 0) {
840 for (i = 0; i < ctx->msgcount; i++)
841 ctx->hdrs[i]->deleted = 0;
845 if (ctx->changed || ctx->deleted) {
846 if ((check = sync_mailbox (ctx, index_hint)) != 0) {
854 mutt_message (_("%d kept, %d moved, %d deleted."),
855 ctx->msgcount - ctx->deleted, read_msgs, ctx->deleted);
857 mutt_message (_("%d kept, %d deleted."),
858 ctx->msgcount - ctx->deleted, ctx->deleted);
860 if (ctx->msgcount == ctx->deleted &&
861 (ctx->magic == M_MMDF || ctx->magic == M_MBOX) &&
862 !mutt_is_spool (ctx->path) && !option (OPTSAVEEMPTY))
863 mx_unlink_empty (ctx->path);
865 if (ctx->compressinfo && mutt_slow_close_compressed (ctx))
868 mx_fastclose_mailbox (ctx);
873 int mx_close_mailbox (CONTEXT * ctx, int *index_hint) {
877 ret = _mx_close_mailbox (ctx, index_hint);
878 sidebar_set_buffystats (ctx);
882 /* update a Context structure's internal tables. */
884 void mx_update_tables (CONTEXT * ctx, int committing)
888 /* update memory to reflect the new state of the mailbox */
897 #define this_body ctx->hdrs[j]->content
898 for (i = 0, j = 0; i < ctx->msgcount; i++) {
899 if ((committing && (!ctx->hdrs[i]->deleted ||
900 (ctx->magic == M_MAILDIR
901 && option (OPTMAILDIRTRASH)))) || (!committing
905 ctx->hdrs[j] = ctx->hdrs[i];
908 ctx->hdrs[j]->msgno = j;
909 if (ctx->hdrs[j]->virtual != -1) {
910 ctx->v2r[ctx->vcount] = j;
911 ctx->hdrs[j]->virtual = ctx->vcount++;
912 ctx->vsize += this_body->length + this_body->offset -
913 this_body->hdr_offset;
917 ctx->hdrs[j]->changed = 0;
918 else if (ctx->hdrs[j]->changed)
922 || (ctx->magic == M_MAILDIR && option (OPTMAILDIRTRASH))) {
923 if (ctx->hdrs[j]->deleted)
927 if (ctx->hdrs[j]->tagged)
929 if (ctx->hdrs[j]->flagged)
931 if (!ctx->hdrs[j]->read) {
933 if (!ctx->hdrs[j]->old)
940 if (ctx->magic == M_MH || ctx->magic == M_MAILDIR)
941 ctx->size -= (ctx->hdrs[i]->content->length +
942 ctx->hdrs[i]->content->offset -
943 ctx->hdrs[i]->content->hdr_offset);
944 /* remove message from the hash tables */
945 if (ctx->subj_hash && ctx->hdrs[i]->env->real_subj)
946 hash_delete (ctx->subj_hash, ctx->hdrs[i]->env->real_subj,
948 if (ctx->id_hash && ctx->hdrs[i]->env->message_id)
949 hash_delete (ctx->id_hash, ctx->hdrs[i]->env->message_id,
951 header_delete(&ctx->hdrs[i]);
957 /* update sidebar count */
958 sidebar_set_buffystats (ctx);
962 /* save changes to mailbox
968 static int _mx_sync_mailbox (CONTEXT * ctx, int *index_hint)
972 int msgcount, deleted;
974 if (ctx->dontwrite) {
975 char buf[STRING], tmp[STRING];
977 if (km_expand_key (buf, sizeof (buf),
978 km_find_func (MENU_MAIN, OP_TOGGLE_WRITE)))
979 snprintf (tmp, sizeof (tmp), _(" Press '%s' to toggle write"), buf);
981 m_strcpy(tmp, sizeof(tmp), _("Use 'toggle-write' to re-enable write!"));
983 mutt_error (_("Mailbox is marked unwritable. %s"), tmp);
986 else if (ctx->readonly) {
987 mutt_error _("Mailbox is read-only.");
992 if (!ctx->changed && !ctx->deleted) {
993 mutt_message _("Mailbox is unchanged.");
999 char buf[SHORT_STRING];
1001 snprintf (buf, sizeof (buf), ctx->deleted == 1
1002 ? _("Purge %d deleted message?") :
1003 _("Purge %d deleted messages?"), ctx->deleted);
1004 if ((purge = query_quadoption (OPT_DELETE, buf)) < 0)
1006 else if (purge == M_NO) {
1008 return 0; /* nothing to do! */
1009 /* let IMAP servers hold on to D flags */
1010 if (ctx->magic != M_IMAP)
1012 for (i = 0; i < ctx->msgcount; i++)
1013 ctx->hdrs[i]->deleted = 0;
1017 else if (ctx->last_tag && ctx->last_tag->deleted)
1018 ctx->last_tag = NULL; /* reset last tagged msg now useless */
1021 /* really only for IMAP - imap_sync_mailbox results in a call to
1022 * mx_update_tables, so ctx->deleted is 0 when it comes back */
1023 msgcount = ctx->msgcount;
1024 deleted = ctx->deleted;
1026 if (purge && ctx->deleted) {
1027 if (trash_append (ctx) == -1)
1031 if (ctx->magic == M_IMAP)
1032 rc = imap_sync_mailbox (ctx, purge, index_hint);
1034 rc = sync_mailbox (ctx, index_hint);
1036 if (ctx->magic == M_IMAP && !purge)
1037 mutt_message (_("Mailbox checkpointed."));
1040 mutt_message (_("%d kept, %d deleted."), msgcount - deleted, deleted);
1044 if (ctx->msgcount == ctx->deleted &&
1045 (ctx->magic == M_MBOX || ctx->magic == M_MMDF) &&
1046 !mutt_is_spool (ctx->path) && !option (OPTSAVEEMPTY)) {
1048 mx_fastclose_mailbox (ctx);
1052 /* if we haven't deleted any messages, we don't need to resort */
1053 /* ... except for certain folder formats which need "unsorted"
1054 * sort order in order to synchronize folders.
1056 * MH and maildir are safe. mbox-style seems to need re-sorting,
1057 * at least with the new threading code.
1059 if (purge || (ctx->magic != M_MAILDIR && ctx->magic != M_MH)) {
1060 /* IMAP does this automatically after handling EXPUNGE */
1061 if (ctx->magic != M_IMAP)
1063 mx_update_tables (ctx, 1);
1064 mutt_sort_headers (ctx, 1); /* rethread from scratch */
1072 int mx_sync_mailbox (CONTEXT* ctx, int* index_hint) {
1073 int ret = _mx_sync_mailbox (ctx, index_hint);
1074 sidebar_set_buffystats (ctx);
1079 * dest destintation mailbox
1080 * hdr message being copied (required for maildir support, because
1081 * the filename depends on the message flags)
1083 MESSAGE *mx_open_new_message (CONTEXT * dest, HEADER * hdr, int flags)
1086 address_t *p = NULL;
1088 if (!MX_IDX(dest->magic-1)) {
1092 msg = p_new(MESSAGE, 1);
1093 msg->magic = dest->magic;
1097 msg->flags.flagged = hdr->flagged;
1098 msg->flags.replied = hdr->replied;
1099 msg->flags.read = hdr->read;
1100 msg->received = hdr->received;
1103 if (msg->received == 0)
1104 time (&msg->received);
1106 if (MX_COMMAND(dest->magic-1,mx_open_new_message)(msg, dest, hdr) == 0) {
1107 if (dest->magic == M_MMDF)
1108 fputs (MMDF_SEP, msg->fp);
1110 if ((msg->magic == M_MBOX || msg->magic == M_MMDF) && flags & M_ADD_FROM) {
1112 if (hdr->env->return_path)
1113 p = hdr->env->return_path;
1114 else if (hdr->env->sender)
1115 p = hdr->env->sender;
1120 fprintf (msg->fp, "From %s %s", p ? p->mailbox : NONULL (Username),
1121 ctime (&msg->received));
1130 /* check for new mail */
1131 int mx_check_mailbox (CONTEXT * ctx, int *index_hint, int lock) {
1132 if (ctx->compressinfo)
1133 return mutt_check_mailbox_compressed (ctx);
1138 if (MX_IDX(ctx->magic-1) && MX_COMMAND(ctx->magic-1,mx_check_mailbox))
1139 return (MX_COMMAND(ctx->magic-1,mx_check_mailbox)(ctx, index_hint, lock));
1145 /* return a stream pointer for a message */
1146 MESSAGE *mx_open_message (CONTEXT * ctx, int msgno)
1150 msg = p_new(MESSAGE, 1);
1151 switch (msg->magic = ctx->magic) {
1160 HEADER *cur = ctx->hdrs[msgno];
1161 char path[_POSIX_PATH_MAX];
1163 snprintf (path, sizeof (path), "%s/%s", ctx->path, cur->path);
1165 if ((msg->fp = fopen (path, "r")) == NULL && errno == ENOENT &&
1166 ctx->magic == M_MAILDIR)
1167 msg->fp = maildir_open_find_message (ctx->path, cur->path);
1169 if (msg->fp == NULL) {
1178 if (imap_fetch_message (msg, ctx, msgno) != 0)
1185 if (pop_fetch_message (msg, ctx, msgno) != 0)
1193 if (nntp_fetch_message (msg, ctx, msgno) != 0)
1197 #endif /* USE_NNTP */
1206 /* commit a message to a folder */
1208 int mx_commit_message (MESSAGE * msg, CONTEXT * ctx) {
1209 if (!(msg->write && ctx->append)) {
1212 if (!ctx || !MX_IDX(ctx->magic-1) || !MX_COMMAND(ctx->magic-1,mx_commit_message))
1214 return (MX_COMMAND(ctx->magic-1,mx_commit_message) (msg, ctx));
1217 /* close a pointer to a message */
1218 int mx_close_message (MESSAGE ** msg)
1222 if ((*msg)->magic == M_MH || (*msg)->magic == M_MAILDIR
1223 || (*msg)->magic == M_IMAP
1224 || (*msg)->magic == M_POP
1226 || (*msg)->magic == M_NNTP
1229 r = safe_fclose (&(*msg)->fp);
1235 unlink ((*msg)->path);
1236 p_delete(&(*msg)->path);
1243 void mx_alloc_memory (CONTEXT * ctx)
1246 size_t s = MAX (sizeof (HEADER *), sizeof (int));
1248 if ((ctx->hdrmax + 25) * s < ctx->hdrmax * s) {
1249 mutt_error _("Integer overflow -- can't allocate memory.");
1256 p_realloc(&ctx->hdrs, ctx->hdrmax += 25);
1257 p_realloc(&ctx->v2r, ctx->hdrmax);
1260 ctx->hdrs = p_new(HEADER *, (ctx->hdrmax += 25));
1261 ctx->v2r = p_new(int, ctx->hdrmax);
1263 for (i = ctx->msgcount; i < ctx->hdrmax; i++) {
1264 ctx->hdrs[i] = NULL;
1269 /* this routine is called to update the counts in the context structure for
1270 * the last message header parsed.
1272 void mx_update_context (CONTEXT * ctx, int new_messages)
1277 for (msgno = ctx->msgcount - new_messages; msgno < ctx->msgcount; msgno++) {
1278 h = ctx->hdrs[msgno];
1280 /* NOTE: this _must_ be done before the check for mailcap! */
1281 h->security = crypt_query (h->content);
1283 if (!ctx->pattern) {
1284 ctx->v2r[ctx->vcount] = msgno;
1285 h->virtual = ctx->vcount++;
1291 if (h->env->supersedes) {
1295 ctx->id_hash = mutt_make_id_hash (ctx);
1297 h2 = hash_find (ctx->id_hash, h->env->supersedes);
1299 /* p_delete(&h->env->supersedes); should I ? */
1302 if (!ctx->counting && option (OPTSCORE))
1303 mutt_score_message (ctx, h2, 1);
1307 /* add this message to the hash tables */
1308 if (ctx->id_hash && h->env->message_id)
1309 hash_insert (ctx->id_hash, h->env->message_id, h, 0);
1310 if (!ctx->counting) {
1311 if (ctx->subj_hash && h->env->real_subj)
1312 hash_insert (ctx->subj_hash, h->env->real_subj, h, 1);
1314 if (option (OPTSCORE))
1315 mutt_score_message (ctx, h, 0);
1330 /* update sidebar count */
1331 sidebar_set_buffystats (ctx);
1336 * 1 if the specified mailbox contains 0 messages.
1337 * 0 if the mailbox contains messages
1340 int mx_check_empty (const char *path)
1343 if ((i = mx_get_idx (path)) >= 0 && MX_COMMAND(i,mx_check_empty))
1344 return (MX_COMMAND(i,mx_check_empty)(path));
1349 int mx_acl_check (CONTEXT* ctx, int flag) {
1350 if (!ctx || !MX_IDX(ctx->magic-1))
1352 /* if no acl_check defined for module, assume permission is granted */
1353 if (!MX_COMMAND(ctx->magic-1,mx_acl_check))
1355 return (MX_COMMAND(ctx->magic-1,mx_acl_check)(ctx,flag));
1358 void mx_init (void) {
1359 list_push_back (&MailboxFormats, (void*) mbox_reg_mx ());
1360 list_push_back (&MailboxFormats, (void*) mmdf_reg_mx ());
1361 list_push_back (&MailboxFormats, (void*) mh_reg_mx ());
1362 list_push_back (&MailboxFormats, (void*) maildir_reg_mx ());
1363 list_push_back (&MailboxFormats, (void*) imap_reg_mx ());
1364 list_push_back (&MailboxFormats, (void*) pop_reg_mx ());
1366 list_push_back (&MailboxFormats, (void*) nntp_reg_mx ());
1368 list_push_back (&MailboxFormats, (void*) compress_reg_mx ());
1371 int mx_rebuild_cache (void) {
1373 mutt_error (_("Support for header caching was not build in."));
1376 int i = 0, magic = 0;
1377 CONTEXT* ctx = NULL;
1380 if (list_empty(Incoming)) {
1381 mutt_error (_("No mailboxes defined."));
1385 for (i = 0; i < Incoming->length; i++) {
1386 b = (BUFFY*) Incoming->data[i];
1387 magic = mx_get_magic (b->path);
1388 if (magic != M_MAILDIR && magic != M_MH && magic != M_IMAP)
1390 sidebar_set_current (b->path);
1391 sidebar_draw (CurrentMenu);
1392 if ((ctx = mx_open_mailbox (b->path,
1393 M_READONLY | M_NOSORT | M_COUNT,
1395 mx_close_mailbox (ctx, 0);
1397 mutt_clear_error ();
1399 if (Context && Context->path)
1400 sidebar_set_current (Context->path);
1401 sidebar_draw (CurrentMenu);
1407 void mutt_parse_mime_message (CONTEXT * ctx, HEADER * cur)
1413 if (cur->content->type != TYPEMESSAGE
1414 && cur->content->type != TYPEMULTIPART)
1415 break; /* nothing to do */
1417 if (cur->content->parts)
1418 break; /* The message was parsed earlier. */
1420 if ((msg = mx_open_message (ctx, cur->msgno))) {
1421 mutt_parse_part (msg->fp, cur->content);
1423 cur->security = crypt_query (cur->content);
1425 mx_close_message (&msg);
1428 mutt_count_body_parts (cur, flags | M_PARTS_RECOUNT);