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>
33 #include <lib-mime/mime.h>
48 #include <imap/imap.h>
49 #include <imap/mx_imap.h>
52 #include <pop/mx_pop.h>
55 #include "nntp/nntp.h"
56 #include "nntp/mx_nntp.h"
63 #include <lib-crypt/crypt.h>
67 static list2_t* MailboxFormats = NULL;
68 #define MX_COMMAND(idx,cmd) ((mx_t*) MailboxFormats->data[idx])->cmd
69 #define MX_IDX(idx) (idx >= 0 && idx < MailboxFormats->length)
71 #define mutt_is_spool(s) (m_strcmp(Spoolfile, s) == 0)
76 * retry - should retry if unable to lock?
79 static int invoke_dotlock (const char *path, int dummy, int flags, int retry)
81 char cmd[LONG_STRING + _POSIX_PATH_MAX];
82 char f[SHORT_STRING + _POSIX_PATH_MAX];
85 if (flags & DL_FL_RETRY)
86 snprintf (r, sizeof (r), "-r %d ", retry ? MAXLOCKATTEMPT : 0);
88 mutt_quote_filename (f, sizeof (f), path);
90 snprintf (cmd, sizeof (cmd),
93 flags & DL_FL_TRY ? "-t " : "",
94 flags & DL_FL_UNLOCK ? "-u " : "",
95 flags & DL_FL_USEPRIV ? "-p " : "",
96 flags & DL_FL_FORCE ? "-f " : "",
97 flags & DL_FL_UNLINK ? "-d " : "",
98 flags & DL_FL_RETRY ? r : "", f);
100 return mutt_system (cmd);
103 static int dotlock_file (const char *path, int fd, int retry)
106 int flags = DL_FL_USEPRIV | DL_FL_RETRY;
112 if ((r = invoke_dotlock (path, fd, flags, retry)) == DL_EX_EXIST) {
113 if (!option (OPTNOCURSES)) {
114 char msg[LONG_STRING];
116 snprintf (msg, sizeof (msg),
117 _("Lock count exceeded, remove lock for %s?"), path);
118 if (retry && mutt_yesorno (msg, M_YES) == M_YES) {
119 flags |= DL_FL_FORCE;
126 mutt_error (_("Can't dotlock %s.\n"), path);
129 return (r == DL_EX_OK ? 0 : -1);
132 static int undotlock_file (const char *path, int fd)
134 return (invoke_dotlock (path, fd, DL_FL_USEPRIV | DL_FL_UNLOCK, 0) ==
138 #endif /* USE_DOTLOCK */
140 /* looks up index of type for path in MailboxFormats */
141 static int mx_get_idx (const char* path) {
145 /* first, test all non-local folders to avoid stat() call */
146 for (i = 0; i < MailboxFormats->length; i++) {
147 if (!MX_COMMAND(i,local))
148 t = MX_COMMAND(i,mx_is_magic)(path, NULL);
152 if (stat (path, &st) == 0) {
153 /* if stat() succeeded, keep testing until success and
154 * pass stat() info so that we only need to do it once */
155 for (i = 0; i < MailboxFormats->length; i++) {
156 if (MX_COMMAND(i,local))
157 t = MX_COMMAND(i,mx_is_magic)(path, &st);
166 * excl if excl != 0, request an exclusive lock
167 * dot if dot != 0, try to dotlock the file
168 * timeout should retry locking?
170 int mx_lock_file (const char *path, int fd, int excl, int dot, int timeout)
172 #if defined (USE_FCNTL) || defined (USE_FLOCK)
184 lck.l_type = excl ? F_WRLCK : F_RDLCK;
185 lck.l_whence = SEEK_SET;
190 while (fcntl (fd, F_SETLK, &lck) == -1) {
193 debug_print (1, ("fcntl errno %d.\n", errno));
194 if (errno != EAGAIN && errno != EACCES) {
195 mutt_perror ("fcntl");
199 if (fstat (fd, &sb) != 0)
205 /* only unlock file if it is unchanged */
206 if (prev_sb.st_size == sb.st_size
207 && ++count >= (timeout ? MAXLOCKATTEMPT : 0)) {
209 mutt_error _("Timeout exceeded while attempting fcntl lock!");
216 mutt_message (_("Waiting for fcntl lock... %d"), ++attempt);
219 #endif /* USE_FCNTL */
224 while (flock (fd, (excl ? LOCK_EX : LOCK_SH) | LOCK_NB) == -1) {
227 if (errno != EWOULDBLOCK) {
228 mutt_perror ("flock");
233 if (fstat (fd, &sb) != 0)
239 /* only unlock file if it is unchanged */
240 if (prev_sb.st_size == sb.st_size
241 && ++count >= (timeout ? MAXLOCKATTEMPT : 0)) {
243 mutt_error _("Timeout exceeded while attempting flock lock!");
251 mutt_message (_("Waiting for flock attempt... %d"), ++attempt);
254 #endif /* USE_FLOCK */
258 r = dotlock_file (path, fd, timeout);
259 #endif /* USE_DOTLOCK */
262 /* release any other locks obtained in this routine */
265 lck.l_type = F_UNLCK;
266 fcntl (fd, F_SETLK, &lck);
267 #endif /* USE_FCNTL */
271 #endif /* USE_FLOCK */
279 int mx_unlock_file (const char *path, int fd, int dot)
282 struct flock unlockit;
284 p_clear(&unlockit, 1);
285 unlockit.l_type = F_UNLCK;
286 unlockit.l_whence = SEEK_SET;
287 fcntl (fd, F_SETLK, &unlockit);
296 undotlock_file (path, fd);
302 void mx_unlink_empty (const char *path)
310 if ((fd = open (path, O_RDWR)) == -1)
313 if (mx_lock_file (path, fd, 1, 0, 1) == -1) {
319 invoke_dotlock (path, fd, DL_FL_UNLINK, 1);
321 if (fstat (fd, &sb) == 0 && sb.st_size == 0)
325 mx_unlock_file (path, fd, 0);
329 /* try to figure out what type of mailbox ``path'' is */
330 int mx_get_magic (const char *path) {
333 if (m_strlen(path) == 0)
335 if ((i = mx_get_idx (path)) >= 0)
336 return (MX_COMMAND(i,type));
340 int mx_is_local (int m) {
343 return (MX_COMMAND(m,local));
347 * set DefaultMagic to the given value
349 int mx_set_magic (const char *s)
351 if (ascii_strcasecmp (s, "mbox") == 0)
352 DefaultMagic = M_MBOX;
353 else if (ascii_strcasecmp (s, "mmdf") == 0)
354 DefaultMagic = M_MMDF;
355 else if (ascii_strcasecmp (s, "mh") == 0)
357 else if (ascii_strcasecmp (s, "maildir") == 0)
358 DefaultMagic = M_MAILDIR;
365 /* mx_access: Wrapper for access, checks permissions on a given mailbox.
366 * We may be interested in using ACL-style flags at some point, currently
367 * we use the normal access() flags. */
368 int mx_access (const char *path, int flags)
372 if ((i = mx_get_idx (path)) >= 0 && MX_COMMAND(i,mx_access))
373 return (MX_COMMAND(i,mx_access)(path,flags));
377 static int mx_open_mailbox_append (CONTEXT * ctx, int flags)
381 /* special case for appending to compressed folders -
382 * even if we can not open them for reading */
383 if (mutt_can_append_compressed (ctx->path))
384 mutt_open_append_compressed (ctx);
388 if (mx_get_magic (ctx->path) == M_IMAP)
389 return imap_open_mailbox_append (ctx);
391 if (stat (ctx->path, &sb) == 0) {
392 ctx->magic = mx_get_magic (ctx->path);
394 switch (ctx->magic) {
396 mutt_error (_("%s is not a mailbox."), ctx->path);
402 else if (errno == ENOENT) {
403 ctx->magic = DefaultMagic;
405 if (ctx->magic == M_MH || ctx->magic == M_MAILDIR) {
406 char tmp[_POSIX_PATH_MAX];
408 if (mkdir (ctx->path, S_IRWXU)) {
409 mutt_perror (ctx->path);
413 if (ctx->magic == M_MAILDIR) {
414 snprintf (tmp, sizeof (tmp), "%s/cur", ctx->path);
415 if (mkdir (tmp, S_IRWXU)) {
421 snprintf (tmp, sizeof (tmp), "%s/new", ctx->path);
422 if (mkdir (tmp, S_IRWXU)) {
424 snprintf (tmp, sizeof (tmp), "%s/cur", ctx->path);
429 snprintf (tmp, sizeof (tmp), "%s/tmp", ctx->path);
430 if (mkdir (tmp, S_IRWXU)) {
432 snprintf (tmp, sizeof (tmp), "%s/cur", ctx->path);
434 snprintf (tmp, sizeof (tmp), "%s/new", ctx->path);
443 snprintf (tmp, sizeof (tmp), "%s/.mh_sequences", ctx->path);
444 if ((i = creat (tmp, S_IRWXU)) == -1) {
454 mutt_perror (ctx->path);
458 switch (ctx->magic) {
462 safe_fopen (ctx->path, flags & M_NEWFOLDER ? "w" : "a")) == NULL
463 || mbox_lock_mailbox (ctx, 1, 1) != 0) {
465 mutt_perror (ctx->path);
467 mutt_error (_("Couldn't lock %s\n"), ctx->path);
468 safe_fclose (&ctx->fp);
472 fseeko (ctx->fp, 0, 2);
488 * open a mailbox and parse it
491 * flags M_NOSORT do not sort mailbox
492 * M_APPEND open mailbox for appending
493 * M_READONLY open mailbox in read-only mode
494 * M_QUIET only print error messages
495 * ctx if non-null, context struct to use
497 CONTEXT *mx_open_mailbox (const char *path, int flags, CONTEXT * pctx)
503 ctx = p_new(CONTEXT, 1);
505 ctx->path = m_strdup(path);
507 ctx->msgnotreadyet = -1;
512 if (flags & M_READONLY)
517 if (flags & (M_APPEND | M_NEWFOLDER)) {
518 if (mx_open_mailbox_append (ctx, flags) != 0) {
519 mx_fastclose_mailbox (ctx);
527 if (!MX_IDX(ctx->magic-1))
528 ctx->magic = mx_get_magic (path);
530 if (ctx->magic == M_COMPRESSED)
531 mutt_open_read_compressed (ctx);
534 mutt_error (_("%s is not a mailbox."), path);
536 if (ctx->magic == -1)
539 if (ctx->magic <= 0) {
540 mx_fastclose_mailbox (ctx);
546 /* if the user has a `push' command in their .muttrc, or in a folder-hook,
547 * it will cause the progress messages not to be displayed because
548 * mutt_refresh() will think we are in the middle of a macro. so set a
549 * flag to indicate that we should really refresh the screen.
551 set_option (OPTFORCEREFRESH);
554 mutt_message (_("Reading %s..."), ctx->path);
556 rc = MX_COMMAND(ctx->magic-1,mx_open_mailbox)(ctx);
559 if ((flags & M_NOSORT) == 0) {
560 /* avoid unnecessary work since the mailbox is completely unthreaded
562 unset_option (OPTSORTSUBTHREADS);
563 unset_option (OPTNEEDRESCORE);
564 mutt_sort_headers (ctx, 1);
570 mx_fastclose_mailbox (ctx);
575 unset_option (OPTFORCEREFRESH);
579 /* free up memory associated with the mailbox context */
580 void mx_fastclose_mailbox (CONTEXT * ctx)
587 if (MX_IDX(ctx->magic-1) && MX_COMMAND(ctx->magic-1,mx_fastclose_mailbox))
588 MX_COMMAND(ctx->magic-1,mx_fastclose_mailbox(ctx));
590 hash_destroy (&ctx->subj_hash, NULL);
592 hash_destroy (&ctx->id_hash, NULL);
593 mutt_clear_threads (ctx);
594 for (i = 0; i < ctx->msgcount; i++)
595 header_delete(&ctx->hdrs[i]);
596 p_delete(&ctx->hdrs);
599 if (ctx->compressinfo)
600 mutt_fast_close_compressed (ctx);
602 p_delete(&ctx->path);
603 p_delete(&ctx->pattern);
604 if (ctx->limit_pattern)
605 mutt_pattern_free (&ctx->limit_pattern);
606 safe_fclose (&ctx->fp);
610 /* save changes to disk */
611 static int sync_mailbox (CONTEXT * ctx, int *index_hint)
616 mutt_message (_("Writing %s..."), ctx->path);
618 if (MX_IDX(ctx->magic-1))
619 /* the 1 is only of interest for IMAP and means EXPUNGE */
620 rc = MX_COMMAND(ctx->magic-1,mx_sync_mailbox(ctx,1,index_hint));
622 if (rc == 0 && ctx->compressinfo)
623 return mutt_sync_compressed (ctx);
628 /* move deleted mails to the trash folder */
629 static int trash_append (CONTEXT * ctx)
635 if (!TrashPath || !ctx->deleted ||
636 (ctx->magic == M_MAILDIR && option (OPTMAILDIRTRASH)))
639 for (; i < ctx->msgcount && (!ctx->hdrs[i]->deleted ||
640 ctx->hdrs[i]->appended); i++);
641 if (i == ctx->msgcount)
642 return 0; /* nothing to be done */
644 if (mutt_save_confirm (TrashPath, &st) != 0) {
645 mutt_error _("message(s) not deleted");
650 if (lstat (ctx->path, &stc) == 0 && stc.st_ino == st.st_ino
651 && stc.st_dev == st.st_dev && stc.st_rdev == st.st_rdev)
652 return 0; /* we are in the trash folder: simple sync */
654 if ((ctx_trash = mx_open_mailbox (TrashPath, M_APPEND, NULL)) != NULL) {
655 for (i = 0; i < ctx->msgcount; i++)
656 if (ctx->hdrs[i]->deleted && !ctx->hdrs[i]->appended
657 && !ctx->hdrs[i]->purged
658 && mutt_append_message (ctx_trash, ctx, ctx->hdrs[i], 0, 0) == -1) {
659 mx_close_mailbox (ctx_trash, NULL);
663 mx_close_mailbox (ctx_trash, NULL);
666 mutt_error _("Can't open trash folder");
674 /* save changes and close mailbox */
675 static int _mx_close_mailbox (CONTEXT * ctx, int *index_hint)
677 int i, move_messages = 0, purge = 1, read_msgs = 0;
681 char mbox[_POSIX_PATH_MAX];
682 char buf[SHORT_STRING];
690 if (ctx->magic == M_NNTP) {
693 ret = nntp_close_mailbox (ctx);
694 mx_fastclose_mailbox (ctx);
698 if (ctx->readonly || ctx->dontwrite) {
699 /* mailbox is readonly or we don't want to write */
700 mx_fastclose_mailbox (ctx);
705 /* mailbox was opened in write-mode */
706 if (ctx->magic == M_MBOX || ctx->magic == M_MMDF)
707 mbox_close_mailbox (ctx);
709 mx_fastclose_mailbox (ctx);
713 for (i = 0; i < ctx->msgcount; i++) {
714 if (!ctx->hdrs[i]->deleted && ctx->hdrs[i]->read
715 && !(ctx->hdrs[i]->flagged && option (OPTKEEPFLAGGED)))
719 if (read_msgs && quadoption (OPT_MOVE) != M_NO) {
722 if ((p = mutt_find_hook (M_MBOXHOOK, ctx->path))) {
724 m_strcpy(mbox, sizeof(mbox), p);
727 m_strcpy(mbox, sizeof(mbox), NONULL(Inbox));
728 isSpool = mutt_is_spool (ctx->path) && !mutt_is_spool (mbox);
730 mutt_expand_path (mbox, sizeof (mbox));
733 snprintf (buf, sizeof (buf), _("Move read messages to %s?"), mbox);
734 if ((move_messages = query_quadoption (OPT_MOVE, buf)) == -1) {
742 * There is no point in asking whether or not to purge if we are
743 * just marking messages as "trash".
745 if (ctx->deleted && !(ctx->magic == M_MAILDIR && option (OPTMAILDIRTRASH))) {
746 snprintf (buf, sizeof (buf), ctx->deleted == 1
747 ? _("Purge %d deleted message?") :
748 _("Purge %d deleted messages?"), ctx->deleted);
749 if ((purge = query_quadoption (OPT_DELETE, buf)) < 0) {
755 /* IMAP servers manage the OLD flag themselves */
756 if (ctx->magic != M_IMAP)
757 if (option (OPTMARKOLD)) {
758 for (i = 0; i < ctx->msgcount; i++) {
759 if (!ctx->hdrs[i]->deleted && !ctx->hdrs[i]->old)
760 mutt_set_flag (ctx, ctx->hdrs[i], M_OLD, 1);
765 mutt_message (_("Moving read messages to %s..."), mbox);
767 /* try to use server-side copy first */
770 if (ctx->magic == M_IMAP && imap_is_magic (mbox, NULL) == M_IMAP) {
771 /* tag messages for moving, and clear old tags, if any */
772 for (i = 0; i < ctx->msgcount; i++)
773 if (ctx->hdrs[i]->read && !ctx->hdrs[i]->deleted
774 && !(ctx->hdrs[i]->flagged && option (OPTKEEPFLAGGED)))
775 ctx->hdrs[i]->tagged = 1;
777 ctx->hdrs[i]->tagged = 0;
779 i = imap_copy_messages (ctx, NULL, mbox, 1);
782 if (i == 0) /* success */
784 else if (i == -1) { /* horrible error, bail */
788 else /* use regular append-copy mode */
790 if (mx_open_mailbox (mbox, M_APPEND, &f) == NULL) {
795 for (i = 0; i < ctx->msgcount; i++) {
796 if (ctx->hdrs[i]->read && !ctx->hdrs[i]->deleted
797 && !(ctx->hdrs[i]->flagged && option (OPTKEEPFLAGGED))) {
798 if (mutt_append_message (&f, ctx, ctx->hdrs[i], 0, CH_UPDATE_LEN) ==
800 mutt_set_flag (ctx, ctx->hdrs[i], M_DELETE, 1);
801 mutt_set_flag (ctx, ctx->hdrs[i], M_APPENDED, 1);
804 mx_close_mailbox (&f, NULL);
811 mx_close_mailbox (&f, NULL);
815 else if (!ctx->changed && ctx->deleted == 0) {
816 mutt_message _("Mailbox is unchanged.");
818 mx_fastclose_mailbox (ctx);
822 /* copy mails to the trash before expunging */
823 if (purge && ctx->deleted)
824 if (trash_append (ctx) != 0) {
829 /* allow IMAP to preserve the deleted flag across sessions */
830 if (ctx->magic == M_IMAP) {
831 if ((check = imap_sync_mailbox (ctx, purge, index_hint)) != 0) {
839 for (i = 0; i < ctx->msgcount; i++)
840 ctx->hdrs[i]->deleted = 0;
844 if (ctx->changed || ctx->deleted) {
845 if ((check = sync_mailbox (ctx, index_hint)) != 0) {
853 mutt_message (_("%d kept, %d moved, %d deleted."),
854 ctx->msgcount - ctx->deleted, read_msgs, ctx->deleted);
856 mutt_message (_("%d kept, %d deleted."),
857 ctx->msgcount - ctx->deleted, ctx->deleted);
859 if (ctx->msgcount == ctx->deleted &&
860 (ctx->magic == M_MMDF || ctx->magic == M_MBOX) &&
861 !mutt_is_spool (ctx->path) && !option (OPTSAVEEMPTY))
862 mx_unlink_empty (ctx->path);
864 if (ctx->compressinfo && mutt_slow_close_compressed (ctx))
867 mx_fastclose_mailbox (ctx);
872 int mx_close_mailbox (CONTEXT * ctx, int *index_hint) {
876 ret = _mx_close_mailbox (ctx, index_hint);
877 sidebar_set_buffystats (ctx);
881 /* update a Context structure's internal tables. */
883 void mx_update_tables (CONTEXT * ctx, int committing)
887 /* update memory to reflect the new state of the mailbox */
896 #define this_body ctx->hdrs[j]->content
897 for (i = 0, j = 0; i < ctx->msgcount; i++) {
898 if ((committing && (!ctx->hdrs[i]->deleted ||
899 (ctx->magic == M_MAILDIR
900 && option (OPTMAILDIRTRASH)))) || (!committing
904 ctx->hdrs[j] = ctx->hdrs[i];
907 ctx->hdrs[j]->msgno = j;
908 if (ctx->hdrs[j]->virtual != -1) {
909 ctx->v2r[ctx->vcount] = j;
910 ctx->hdrs[j]->virtual = ctx->vcount++;
911 ctx->vsize += this_body->length + this_body->offset -
912 this_body->hdr_offset;
916 ctx->hdrs[j]->changed = 0;
917 else if (ctx->hdrs[j]->changed)
921 || (ctx->magic == M_MAILDIR && option (OPTMAILDIRTRASH))) {
922 if (ctx->hdrs[j]->deleted)
926 if (ctx->hdrs[j]->tagged)
928 if (ctx->hdrs[j]->flagged)
930 if (!ctx->hdrs[j]->read) {
932 if (!ctx->hdrs[j]->old)
939 if (ctx->magic == M_MH || ctx->magic == M_MAILDIR)
940 ctx->size -= (ctx->hdrs[i]->content->length +
941 ctx->hdrs[i]->content->offset -
942 ctx->hdrs[i]->content->hdr_offset);
943 /* remove message from the hash tables */
944 if (ctx->subj_hash && ctx->hdrs[i]->env->real_subj)
945 hash_delete (ctx->subj_hash, ctx->hdrs[i]->env->real_subj,
947 if (ctx->id_hash && ctx->hdrs[i]->env->message_id)
948 hash_delete (ctx->id_hash, ctx->hdrs[i]->env->message_id,
950 header_delete(&ctx->hdrs[i]);
956 /* update sidebar count */
957 sidebar_set_buffystats (ctx);
961 /* save changes to mailbox
967 static int _mx_sync_mailbox (CONTEXT * ctx, int *index_hint)
971 int msgcount, deleted;
973 if (ctx->dontwrite) {
974 char buf[STRING], tmp[STRING];
976 if (km_expand_key (buf, sizeof (buf),
977 km_find_func (MENU_MAIN, OP_TOGGLE_WRITE)))
978 snprintf (tmp, sizeof (tmp), _(" Press '%s' to toggle write"), buf);
980 m_strcpy(tmp, sizeof(tmp), _("Use 'toggle-write' to re-enable write!"));
982 mutt_error (_("Mailbox is marked unwritable. %s"), tmp);
985 else if (ctx->readonly) {
986 mutt_error _("Mailbox is read-only.");
991 if (!ctx->changed && !ctx->deleted) {
992 mutt_message _("Mailbox is unchanged.");
998 char buf[SHORT_STRING];
1000 snprintf (buf, sizeof (buf), ctx->deleted == 1
1001 ? _("Purge %d deleted message?") :
1002 _("Purge %d deleted messages?"), ctx->deleted);
1003 if ((purge = query_quadoption (OPT_DELETE, buf)) < 0)
1005 else if (purge == M_NO) {
1007 return 0; /* nothing to do! */
1008 /* let IMAP servers hold on to D flags */
1009 if (ctx->magic != M_IMAP)
1011 for (i = 0; i < ctx->msgcount; i++)
1012 ctx->hdrs[i]->deleted = 0;
1016 else if (ctx->last_tag && ctx->last_tag->deleted)
1017 ctx->last_tag = NULL; /* reset last tagged msg now useless */
1020 /* really only for IMAP - imap_sync_mailbox results in a call to
1021 * mx_update_tables, so ctx->deleted is 0 when it comes back */
1022 msgcount = ctx->msgcount;
1023 deleted = ctx->deleted;
1025 if (purge && ctx->deleted) {
1026 if (trash_append (ctx) == -1)
1030 if (ctx->magic == M_IMAP)
1031 rc = imap_sync_mailbox (ctx, purge, index_hint);
1033 rc = sync_mailbox (ctx, index_hint);
1035 if (ctx->magic == M_IMAP && !purge)
1036 mutt_message (_("Mailbox checkpointed."));
1039 mutt_message (_("%d kept, %d deleted."), msgcount - deleted, deleted);
1043 if (ctx->msgcount == ctx->deleted &&
1044 (ctx->magic == M_MBOX || ctx->magic == M_MMDF) &&
1045 !mutt_is_spool (ctx->path) && !option (OPTSAVEEMPTY)) {
1047 mx_fastclose_mailbox (ctx);
1051 /* if we haven't deleted any messages, we don't need to resort */
1052 /* ... except for certain folder formats which need "unsorted"
1053 * sort order in order to synchronize folders.
1055 * MH and maildir are safe. mbox-style seems to need re-sorting,
1056 * at least with the new threading code.
1058 if (purge || (ctx->magic != M_MAILDIR && ctx->magic != M_MH)) {
1059 /* IMAP does this automatically after handling EXPUNGE */
1060 if (ctx->magic != M_IMAP)
1062 mx_update_tables (ctx, 1);
1063 mutt_sort_headers (ctx, 1); /* rethread from scratch */
1071 int mx_sync_mailbox (CONTEXT* ctx, int* index_hint) {
1072 int ret = _mx_sync_mailbox (ctx, index_hint);
1073 sidebar_set_buffystats (ctx);
1078 * dest destintation mailbox
1079 * hdr message being copied (required for maildir support, because
1080 * the filename depends on the message flags)
1082 MESSAGE *mx_open_new_message (CONTEXT * dest, HEADER * hdr, int flags)
1085 address_t *p = NULL;
1087 if (!MX_IDX(dest->magic-1)) {
1088 debug_print (1, ("function unimplemented for mailbox type %d.\n", dest->magic));
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));
1142 debug_print (1, ("null or invalid context.\n"));
1147 /* return a stream pointer for a message */
1148 MESSAGE *mx_open_message (CONTEXT * ctx, int msgno)
1152 msg = p_new(MESSAGE, 1);
1153 switch (msg->magic = ctx->magic) {
1162 HEADER *cur = ctx->hdrs[msgno];
1163 char path[_POSIX_PATH_MAX];
1165 snprintf (path, sizeof (path), "%s/%s", ctx->path, cur->path);
1167 if ((msg->fp = fopen (path, "r")) == NULL && errno == ENOENT &&
1168 ctx->magic == M_MAILDIR)
1169 msg->fp = maildir_open_find_message (ctx->path, cur->path);
1171 if (msg->fp == NULL) {
1173 debug_print (1, ("fopen: %s: %s (errno %d).\n", path, strerror (errno), errno));
1181 if (imap_fetch_message (msg, ctx, msgno) != 0)
1188 if (pop_fetch_message (msg, ctx, msgno) != 0)
1196 if (nntp_fetch_message (msg, ctx, msgno) != 0)
1200 #endif /* USE_NNTP */
1203 debug_print (1, ("function not implemented for mailbox type %d.\n", ctx->magic));
1210 /* commit a message to a folder */
1212 int mx_commit_message (MESSAGE * msg, CONTEXT * ctx) {
1213 if (!(msg->write && ctx->append)) {
1214 debug_print (1, ("msg->write = %d, ctx->append = %d\n", msg->write, ctx->append));
1217 if (!ctx || !MX_IDX(ctx->magic-1) || !MX_COMMAND(ctx->magic-1,mx_commit_message))
1219 return (MX_COMMAND(ctx->magic-1,mx_commit_message) (msg, ctx));
1222 /* close a pointer to a message */
1223 int mx_close_message (MESSAGE ** msg)
1227 if ((*msg)->magic == M_MH || (*msg)->magic == M_MAILDIR
1228 || (*msg)->magic == M_IMAP
1229 || (*msg)->magic == M_POP
1231 || (*msg)->magic == M_NNTP
1234 r = safe_fclose (&(*msg)->fp);
1240 debug_print (1, ("unlinking %s\n", (*msg)->path));
1241 unlink ((*msg)->path);
1242 p_delete(&(*msg)->path);
1249 void mx_alloc_memory (CONTEXT * ctx)
1252 size_t s = MAX (sizeof (HEADER *), sizeof (int));
1254 if ((ctx->hdrmax + 25) * s < ctx->hdrmax * s) {
1255 mutt_error _("Integer overflow -- can't allocate memory.");
1262 p_realloc(&ctx->hdrs, ctx->hdrmax += 25);
1263 p_realloc(&ctx->v2r, ctx->hdrmax);
1266 ctx->hdrs = p_new(HEADER *, (ctx->hdrmax += 25));
1267 ctx->v2r = p_new(int, ctx->hdrmax);
1269 for (i = ctx->msgcount; i < ctx->hdrmax; i++) {
1270 ctx->hdrs[i] = NULL;
1275 /* this routine is called to update the counts in the context structure for
1276 * the last message header parsed.
1278 void mx_update_context (CONTEXT * ctx, int new_messages)
1283 for (msgno = ctx->msgcount - new_messages; msgno < ctx->msgcount; msgno++) {
1284 h = ctx->hdrs[msgno];
1286 /* NOTE: this _must_ be done before the check for mailcap! */
1287 h->security = crypt_query (h->content);
1289 if (!ctx->pattern) {
1290 ctx->v2r[ctx->vcount] = msgno;
1291 h->virtual = ctx->vcount++;
1297 if (h->env->supersedes) {
1301 ctx->id_hash = mutt_make_id_hash (ctx);
1303 h2 = hash_find (ctx->id_hash, h->env->supersedes);
1305 /* p_delete(&h->env->supersedes); should I ? */
1308 if (!ctx->counting && option (OPTSCORE))
1309 mutt_score_message (ctx, h2, 1);
1313 /* add this message to the hash tables */
1314 if (ctx->id_hash && h->env->message_id)
1315 hash_insert (ctx->id_hash, h->env->message_id, h, 0);
1316 if (!ctx->counting) {
1317 if (ctx->subj_hash && h->env->real_subj)
1318 hash_insert (ctx->subj_hash, h->env->real_subj, h, 1);
1320 if (option (OPTSCORE))
1321 mutt_score_message (ctx, h, 0);
1336 /* update sidebar count */
1337 sidebar_set_buffystats (ctx);
1342 * 1 if the specified mailbox contains 0 messages.
1343 * 0 if the mailbox contains messages
1346 int mx_check_empty (const char *path)
1349 if ((i = mx_get_idx (path)) >= 0 && MX_COMMAND(i,mx_check_empty))
1350 return (MX_COMMAND(i,mx_check_empty)(path));
1355 int mx_acl_check (CONTEXT* ctx, int flag) {
1356 if (!ctx || !MX_IDX(ctx->magic-1))
1358 /* if no acl_check defined for module, assume permission is granted */
1359 if (!MX_COMMAND(ctx->magic-1,mx_acl_check))
1361 return (MX_COMMAND(ctx->magic-1,mx_acl_check)(ctx,flag));
1364 void mx_init (void) {
1368 list_push_back (&MailboxFormats, (void*) mbox_reg_mx ());
1369 list_push_back (&MailboxFormats, (void*) mmdf_reg_mx ());
1370 list_push_back (&MailboxFormats, (void*) mh_reg_mx ());
1371 list_push_back (&MailboxFormats, (void*) maildir_reg_mx ());
1372 list_push_back (&MailboxFormats, (void*) imap_reg_mx ());
1373 list_push_back (&MailboxFormats, (void*) pop_reg_mx ());
1375 list_push_back (&MailboxFormats, (void*) nntp_reg_mx ());
1377 list_push_back (&MailboxFormats, (void*) compress_reg_mx ());
1379 /* check module registration for completeness with debug versions */
1380 #define EXITWITHERR(m) do { fprintf(stderr, "error: incomplete mx module: %s is missing for type %i\n",m,i);exit(1); } while (0)
1381 for (i = 0; i < MailboxFormats->length; i++) {
1382 if (MX_COMMAND(i,type) < 1) EXITWITHERR("type");
1383 if (!MX_COMMAND(i,mx_is_magic)) EXITWITHERR("mx_is_magic");
1384 if (!MX_COMMAND(i,mx_open_mailbox)) EXITWITHERR("mx_open_mailbox");
1385 /* if (!MX_COMMAND(i,mx_sync_mailbox)) EXITWITHERR("mx_sync_mailbox");*/
1391 int mx_rebuild_cache (void) {
1393 mutt_error (_("Support for header caching was not build in."));
1396 int i = 0, magic = 0;
1397 CONTEXT* ctx = NULL;
1400 if (list_empty(Incoming)) {
1401 mutt_error (_("No mailboxes defined."));
1405 for (i = 0; i < Incoming->length; i++) {
1406 b = (BUFFY*) Incoming->data[i];
1407 magic = mx_get_magic (b->path);
1408 if (magic != M_MAILDIR && magic != M_MH && magic != M_IMAP)
1410 sidebar_set_current (b->path);
1411 sidebar_draw (CurrentMenu);
1412 if ((ctx = mx_open_mailbox (b->path,
1413 M_READONLY | M_NOSORT | M_COUNT,
1415 mx_close_mailbox (ctx, 0);
1417 mutt_clear_error ();
1419 if (Context && Context->path)
1420 sidebar_set_current (Context->path);
1421 sidebar_draw (CurrentMenu);
1427 void mutt_parse_mime_message (CONTEXT * ctx, HEADER * cur)
1433 if (cur->content->type != TYPEMESSAGE
1434 && cur->content->type != TYPEMULTIPART)
1435 break; /* nothing to do */
1437 if (cur->content->parts)
1438 break; /* The message was parsed earlier. */
1440 if ((msg = mx_open_message (ctx, cur->msgno))) {
1441 mutt_parse_part (msg->fp, cur->content);
1443 cur->security = crypt_query (cur->content);
1445 mx_close_message (&msg);
1448 mutt_count_body_parts (cur, flags | M_PARTS_RECOUNT);