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>
40 #include "imap/imap.h"
41 #include "imap/mx_imap.h"
46 #include "pop/mx_pop.h"
50 #include "nntp/nntp.h"
51 #include "nntp/mx_nntp.h"
58 #include "mutt_crypt.h"
61 #include "lib/debug.h"
74 static list2_t* MailboxFormats = NULL;
75 #define MX_COMMAND(idx,cmd) ((mx_t*) MailboxFormats->data[idx])->cmd
76 #define MX_IDX(idx) (idx >= 0 && idx < MailboxFormats->length)
78 #define mutt_is_spool(s) (m_strcmp(Spoolfile, s) == 0)
83 * 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);
110 static int dotlock_file (const char *path, int fd, int retry)
113 int flags = DL_FL_USEPRIV | DL_FL_RETRY;
119 if ((r = invoke_dotlock (path, fd, flags, retry)) == DL_EX_EXIST) {
120 if (!option (OPTNOCURSES)) {
121 char msg[LONG_STRING];
123 snprintf (msg, sizeof (msg),
124 _("Lock count exceeded, remove lock for %s?"), path);
125 if (retry && mutt_yesorno (msg, M_YES) == M_YES) {
126 flags |= DL_FL_FORCE;
133 mutt_error (_("Can't dotlock %s.\n"), path);
136 return (r == DL_EX_OK ? 0 : -1);
139 static int undotlock_file (const char *path, int fd)
141 return (invoke_dotlock (path, fd, DL_FL_USEPRIV | DL_FL_UNLOCK, 0) ==
145 #endif /* USE_DOTLOCK */
147 /* looks up index of type for path in MailboxFormats */
148 static int mx_get_idx (const char* path) {
152 /* first, test all non-local folders to avoid stat() call */
153 for (i = 0; i < MailboxFormats->length; i++) {
154 if (!MX_COMMAND(i,local))
155 t = MX_COMMAND(i,mx_is_magic)(path, NULL);
159 if (stat (path, &st) == 0) {
160 /* if stat() succeeded, keep testing until success and
161 * pass stat() info so that we only need to do it once */
162 for (i = 0; i < MailboxFormats->length; i++) {
163 if (MX_COMMAND(i,local))
164 t = MX_COMMAND(i,mx_is_magic)(path, &st);
173 * excl if excl != 0, request an exclusive lock
174 * dot if dot != 0, try to dotlock the file
175 * timeout should retry locking?
177 int mx_lock_file (const char *path, int fd, int excl, int dot, int timeout)
179 #if defined (USE_FCNTL) || defined (USE_FLOCK)
191 lck.l_type = excl ? F_WRLCK : F_RDLCK;
192 lck.l_whence = SEEK_SET;
197 while (fcntl (fd, F_SETLK, &lck) == -1) {
200 debug_print (1, ("fcntl errno %d.\n", errno));
201 if (errno != EAGAIN && errno != EACCES) {
202 mutt_perror ("fcntl");
206 if (fstat (fd, &sb) != 0)
212 /* only unlock file if it is unchanged */
213 if (prev_sb.st_size == sb.st_size
214 && ++count >= (timeout ? MAXLOCKATTEMPT : 0)) {
216 mutt_error _("Timeout exceeded while attempting fcntl lock!");
223 mutt_message (_("Waiting for fcntl lock... %d"), ++attempt);
226 #endif /* USE_FCNTL */
231 while (flock (fd, (excl ? LOCK_EX : LOCK_SH) | LOCK_NB) == -1) {
234 if (errno != EWOULDBLOCK) {
235 mutt_perror ("flock");
240 if (fstat (fd, &sb) != 0)
246 /* only unlock file if it is unchanged */
247 if (prev_sb.st_size == sb.st_size
248 && ++count >= (timeout ? MAXLOCKATTEMPT : 0)) {
250 mutt_error _("Timeout exceeded while attempting flock lock!");
258 mutt_message (_("Waiting for flock attempt... %d"), ++attempt);
261 #endif /* USE_FLOCK */
265 r = dotlock_file (path, fd, timeout);
266 #endif /* USE_DOTLOCK */
269 /* release any other locks obtained in this routine */
272 lck.l_type = F_UNLCK;
273 fcntl (fd, F_SETLK, &lck);
274 #endif /* USE_FCNTL */
278 #endif /* USE_FLOCK */
286 int mx_unlock_file (const char *path, int fd, int dot)
289 struct flock unlockit;
291 p_clear(&unlockit, 1);
292 unlockit.l_type = F_UNLCK;
293 unlockit.l_whence = SEEK_SET;
294 fcntl (fd, F_SETLK, &unlockit);
303 undotlock_file (path, fd);
309 void mx_unlink_empty (const char *path)
317 if ((fd = open (path, O_RDWR)) == -1)
320 if (mx_lock_file (path, fd, 1, 0, 1) == -1) {
326 invoke_dotlock (path, fd, DL_FL_UNLINK, 1);
328 if (fstat (fd, &sb) == 0 && sb.st_size == 0)
332 mx_unlock_file (path, fd, 0);
336 /* try to figure out what type of mailbox ``path'' is */
337 int mx_get_magic (const char *path) {
340 if (m_strlen(path) == 0)
342 if ((i = mx_get_idx (path)) >= 0)
343 return (MX_COMMAND(i,type));
347 int mx_is_local (int m) {
350 return (MX_COMMAND(m,local));
354 * set DefaultMagic to the given value
356 int mx_set_magic (const char *s)
358 if (ascii_strcasecmp (s, "mbox") == 0)
359 DefaultMagic = M_MBOX;
360 else if (ascii_strcasecmp (s, "mmdf") == 0)
361 DefaultMagic = M_MMDF;
362 else if (ascii_strcasecmp (s, "mh") == 0)
364 else if (ascii_strcasecmp (s, "maildir") == 0)
365 DefaultMagic = M_MAILDIR;
372 /* mx_access: Wrapper for access, checks permissions on a given mailbox.
373 * We may be interested in using ACL-style flags at some point, currently
374 * we use the normal access() flags. */
375 int mx_access (const char *path, int flags)
379 if ((i = mx_get_idx (path)) >= 0 && MX_COMMAND(i,mx_access))
380 return (MX_COMMAND(i,mx_access)(path,flags));
384 static int mx_open_mailbox_append (CONTEXT * ctx, int flags)
388 #ifdef USE_COMPRESSED
389 /* special case for appending to compressed folders -
390 * even if we can not open them for reading */
391 if (mutt_can_append_compressed (ctx->path))
392 mutt_open_append_compressed (ctx);
399 if (mx_get_magic (ctx->path) == M_IMAP)
400 return imap_open_mailbox_append (ctx);
404 if (stat (ctx->path, &sb) == 0) {
405 ctx->magic = mx_get_magic (ctx->path);
407 switch (ctx->magic) {
409 mutt_error (_("%s is not a mailbox."), ctx->path);
415 else if (errno == ENOENT) {
416 ctx->magic = DefaultMagic;
418 if (ctx->magic == M_MH || ctx->magic == M_MAILDIR) {
419 char tmp[_POSIX_PATH_MAX];
421 if (mkdir (ctx->path, S_IRWXU)) {
422 mutt_perror (ctx->path);
426 if (ctx->magic == M_MAILDIR) {
427 snprintf (tmp, sizeof (tmp), "%s/cur", ctx->path);
428 if (mkdir (tmp, S_IRWXU)) {
434 snprintf (tmp, sizeof (tmp), "%s/new", ctx->path);
435 if (mkdir (tmp, S_IRWXU)) {
437 snprintf (tmp, sizeof (tmp), "%s/cur", ctx->path);
442 snprintf (tmp, sizeof (tmp), "%s/tmp", ctx->path);
443 if (mkdir (tmp, S_IRWXU)) {
445 snprintf (tmp, sizeof (tmp), "%s/cur", ctx->path);
447 snprintf (tmp, sizeof (tmp), "%s/new", ctx->path);
456 snprintf (tmp, sizeof (tmp), "%s/.mh_sequences", ctx->path);
457 if ((i = creat (tmp, S_IRWXU)) == -1) {
467 mutt_perror (ctx->path);
471 switch (ctx->magic) {
475 safe_fopen (ctx->path, flags & M_NEWFOLDER ? "w" : "a")) == NULL
476 || mbox_lock_mailbox (ctx, 1, 1) != 0) {
478 mutt_perror (ctx->path);
480 mutt_error (_("Couldn't lock %s\n"), ctx->path);
481 safe_fclose (&ctx->fp);
485 fseeko (ctx->fp, 0, 2);
501 * open a mailbox and parse it
504 * flags M_NOSORT do not sort mailbox
505 * M_APPEND open mailbox for appending
506 * M_READONLY open mailbox in read-only mode
507 * M_QUIET only print error messages
508 * ctx if non-null, context struct to use
510 CONTEXT *mx_open_mailbox (const char *path, int flags, CONTEXT * pctx)
516 ctx = p_new(CONTEXT, 1);
518 ctx->path = m_strdup(path);
520 ctx->msgnotreadyet = -1;
525 if (flags & M_READONLY)
530 if (flags & (M_APPEND | M_NEWFOLDER)) {
531 if (mx_open_mailbox_append (ctx, flags) != 0) {
532 mx_fastclose_mailbox (ctx);
540 if (!MX_IDX(ctx->magic-1))
541 ctx->magic = mx_get_magic (path);
543 #ifdef USE_COMPRESSED
544 if (ctx->magic == M_COMPRESSED)
545 mutt_open_read_compressed (ctx);
549 mutt_error (_("%s is not a mailbox."), path);
551 if (ctx->magic == -1)
554 if (ctx->magic <= 0) {
555 mx_fastclose_mailbox (ctx);
561 /* if the user has a `push' command in their .muttrc, or in a folder-hook,
562 * it will cause the progress messages not to be displayed because
563 * mutt_refresh() will think we are in the middle of a macro. so set a
564 * flag to indicate that we should really refresh the screen.
566 set_option (OPTFORCEREFRESH);
569 mutt_message (_("Reading %s..."), ctx->path);
571 rc = MX_COMMAND(ctx->magic-1,mx_open_mailbox)(ctx);
574 if ((flags & M_NOSORT) == 0) {
575 /* avoid unnecessary work since the mailbox is completely unthreaded
577 unset_option (OPTSORTSUBTHREADS);
578 unset_option (OPTNEEDRESCORE);
579 mutt_sort_headers (ctx, 1);
585 mx_fastclose_mailbox (ctx);
590 unset_option (OPTFORCEREFRESH);
594 /* free up memory associated with the mailbox context */
595 void mx_fastclose_mailbox (CONTEXT * ctx)
602 if (MX_IDX(ctx->magic-1) && MX_COMMAND(ctx->magic-1,mx_fastclose_mailbox))
603 MX_COMMAND(ctx->magic-1,mx_fastclose_mailbox(ctx));
605 hash_destroy (&ctx->subj_hash, NULL);
607 hash_destroy (&ctx->id_hash, NULL);
608 mutt_clear_threads (ctx);
609 for (i = 0; i < ctx->msgcount; i++)
610 mutt_free_header (&ctx->hdrs[i]);
611 p_delete(&ctx->hdrs);
613 #ifdef USE_COMPRESSED
614 if (ctx->compressinfo)
615 mutt_fast_close_compressed (ctx);
617 p_delete(&ctx->path);
618 p_delete(&ctx->pattern);
619 if (ctx->limit_pattern)
620 mutt_pattern_free (&ctx->limit_pattern);
621 safe_fclose (&ctx->fp);
625 /* save changes to disk */
626 static int sync_mailbox (CONTEXT * ctx, int *index_hint)
631 mutt_message (_("Writing %s..."), ctx->path);
633 if (MX_IDX(ctx->magic-1))
634 /* the 1 is only of interest for IMAP and means EXPUNGE */
635 rc = MX_COMMAND(ctx->magic-1,mx_sync_mailbox(ctx,1,index_hint));
637 #ifdef USE_COMPRESSED
638 if (rc == 0 && ctx->compressinfo)
639 return mutt_sync_compressed (ctx);
645 /* move deleted mails to the trash folder */
646 static int trash_append (CONTEXT * ctx)
652 if (!TrashPath || !ctx->deleted ||
653 (ctx->magic == M_MAILDIR && option (OPTMAILDIRTRASH)))
656 for (; i < ctx->msgcount && (!ctx->hdrs[i]->deleted ||
657 ctx->hdrs[i]->appended); i++);
658 if (i == ctx->msgcount)
659 return 0; /* nothing to be done */
661 if (mutt_save_confirm (TrashPath, &st) != 0) {
662 mutt_error _("message(s) not deleted");
667 if (lstat (ctx->path, &stc) == 0 && stc.st_ino == st.st_ino
668 && stc.st_dev == st.st_dev && stc.st_rdev == st.st_rdev)
669 return 0; /* we are in the trash folder: simple sync */
671 if ((ctx_trash = mx_open_mailbox (TrashPath, M_APPEND, NULL)) != NULL) {
672 for (i = 0; i < ctx->msgcount; i++)
673 if (ctx->hdrs[i]->deleted && !ctx->hdrs[i]->appended
674 && !ctx->hdrs[i]->purged
675 && mutt_append_message (ctx_trash, ctx, ctx->hdrs[i], 0, 0) == -1) {
676 mx_close_mailbox (ctx_trash, NULL);
680 mx_close_mailbox (ctx_trash, NULL);
683 mutt_error _("Can't open trash folder");
691 /* save changes and close mailbox */
692 static int _mx_close_mailbox (CONTEXT * ctx, int *index_hint)
694 int i, move_messages = 0, purge = 1, read_msgs = 0;
698 char mbox[_POSIX_PATH_MAX];
699 char buf[SHORT_STRING];
707 if (ctx->magic == M_NNTP) {
710 ret = nntp_close_mailbox (ctx);
711 mx_fastclose_mailbox (ctx);
715 if (ctx->readonly || ctx->dontwrite) {
716 /* mailbox is readonly or we don't want to write */
717 mx_fastclose_mailbox (ctx);
722 /* mailbox was opened in write-mode */
723 if (ctx->magic == M_MBOX || ctx->magic == M_MMDF)
724 mbox_close_mailbox (ctx);
726 mx_fastclose_mailbox (ctx);
730 for (i = 0; i < ctx->msgcount; i++) {
731 if (!ctx->hdrs[i]->deleted && ctx->hdrs[i]->read
732 && !(ctx->hdrs[i]->flagged && option (OPTKEEPFLAGGED)))
736 if (read_msgs && quadoption (OPT_MOVE) != M_NO) {
739 if ((p = mutt_find_hook (M_MBOXHOOK, ctx->path))) {
741 m_strcpy(mbox, sizeof(mbox), p);
744 m_strcpy(mbox, sizeof(mbox), NONULL(Inbox));
745 isSpool = mutt_is_spool (ctx->path) && !mutt_is_spool (mbox);
747 mutt_expand_path (mbox, sizeof (mbox));
750 snprintf (buf, sizeof (buf), _("Move read messages to %s?"), mbox);
751 if ((move_messages = query_quadoption (OPT_MOVE, buf)) == -1) {
759 * There is no point in asking whether or not to purge if we are
760 * just marking messages as "trash".
762 if (ctx->deleted && !(ctx->magic == M_MAILDIR && option (OPTMAILDIRTRASH))) {
763 snprintf (buf, sizeof (buf), ctx->deleted == 1
764 ? _("Purge %d deleted message?") :
765 _("Purge %d deleted messages?"), ctx->deleted);
766 if ((purge = query_quadoption (OPT_DELETE, buf)) < 0) {
773 /* IMAP servers manage the OLD flag themselves */
774 if (ctx->magic != M_IMAP)
776 if (option (OPTMARKOLD)) {
777 for (i = 0; i < ctx->msgcount; i++) {
778 if (!ctx->hdrs[i]->deleted && !ctx->hdrs[i]->old)
779 mutt_set_flag (ctx, ctx->hdrs[i], M_OLD, 1);
784 mutt_message (_("Moving read messages to %s..."), mbox);
787 /* try to use server-side copy first */
790 if (ctx->magic == M_IMAP && imap_is_magic (mbox, NULL) == M_IMAP) {
791 /* tag messages for moving, and clear old tags, if any */
792 for (i = 0; i < ctx->msgcount; i++)
793 if (ctx->hdrs[i]->read && !ctx->hdrs[i]->deleted
794 && !(ctx->hdrs[i]->flagged && option (OPTKEEPFLAGGED)))
795 ctx->hdrs[i]->tagged = 1;
797 ctx->hdrs[i]->tagged = 0;
799 i = imap_copy_messages (ctx, NULL, mbox, 1);
802 if (i == 0) /* success */
804 else if (i == -1) { /* horrible error, bail */
808 else /* use regular append-copy mode */
811 if (mx_open_mailbox (mbox, M_APPEND, &f) == NULL) {
816 for (i = 0; i < ctx->msgcount; i++) {
817 if (ctx->hdrs[i]->read && !ctx->hdrs[i]->deleted
818 && !(ctx->hdrs[i]->flagged && option (OPTKEEPFLAGGED))) {
819 if (mutt_append_message (&f, ctx, ctx->hdrs[i], 0, CH_UPDATE_LEN) ==
821 mutt_set_flag (ctx, ctx->hdrs[i], M_DELETE, 1);
822 mutt_set_flag (ctx, ctx->hdrs[i], M_APPENDED, 1);
825 mx_close_mailbox (&f, NULL);
832 mx_close_mailbox (&f, NULL);
836 else if (!ctx->changed && ctx->deleted == 0) {
837 mutt_message _("Mailbox is unchanged.");
839 mx_fastclose_mailbox (ctx);
843 /* copy mails to the trash before expunging */
844 if (purge && ctx->deleted)
845 if (trash_append (ctx) != 0) {
851 /* allow IMAP to preserve the deleted flag across sessions */
852 if (ctx->magic == M_IMAP) {
853 if ((check = imap_sync_mailbox (ctx, purge, index_hint)) != 0) {
862 for (i = 0; i < ctx->msgcount; i++)
863 ctx->hdrs[i]->deleted = 0;
867 if (ctx->changed || ctx->deleted) {
868 if ((check = sync_mailbox (ctx, index_hint)) != 0) {
876 mutt_message (_("%d kept, %d moved, %d deleted."),
877 ctx->msgcount - ctx->deleted, read_msgs, ctx->deleted);
879 mutt_message (_("%d kept, %d deleted."),
880 ctx->msgcount - ctx->deleted, ctx->deleted);
882 if (ctx->msgcount == ctx->deleted &&
883 (ctx->magic == M_MMDF || ctx->magic == M_MBOX) &&
884 !mutt_is_spool (ctx->path) && !option (OPTSAVEEMPTY))
885 mx_unlink_empty (ctx->path);
887 #ifdef USE_COMPRESSED
888 if (ctx->compressinfo && mutt_slow_close_compressed (ctx))
892 mx_fastclose_mailbox (ctx);
897 int mx_close_mailbox (CONTEXT * ctx, int *index_hint) {
901 ret = _mx_close_mailbox (ctx, index_hint);
902 sidebar_set_buffystats (ctx);
906 /* update a Context structure's internal tables. */
908 void mx_update_tables (CONTEXT * ctx, int committing)
912 /* update memory to reflect the new state of the mailbox */
921 #define this_body ctx->hdrs[j]->content
922 for (i = 0, j = 0; i < ctx->msgcount; i++) {
923 if ((committing && (!ctx->hdrs[i]->deleted ||
924 (ctx->magic == M_MAILDIR
925 && option (OPTMAILDIRTRASH)))) || (!committing
929 ctx->hdrs[j] = ctx->hdrs[i];
932 ctx->hdrs[j]->msgno = j;
933 if (ctx->hdrs[j]->virtual != -1) {
934 ctx->v2r[ctx->vcount] = j;
935 ctx->hdrs[j]->virtual = ctx->vcount++;
936 ctx->vsize += this_body->length + this_body->offset -
937 this_body->hdr_offset;
941 ctx->hdrs[j]->changed = 0;
942 else if (ctx->hdrs[j]->changed)
946 || (ctx->magic == M_MAILDIR && option (OPTMAILDIRTRASH))) {
947 if (ctx->hdrs[j]->deleted)
951 if (ctx->hdrs[j]->tagged)
953 if (ctx->hdrs[j]->flagged)
955 if (!ctx->hdrs[j]->read) {
957 if (!ctx->hdrs[j]->old)
964 if (ctx->magic == M_MH || ctx->magic == M_MAILDIR)
965 ctx->size -= (ctx->hdrs[i]->content->length +
966 ctx->hdrs[i]->content->offset -
967 ctx->hdrs[i]->content->hdr_offset);
968 /* remove message from the hash tables */
969 if (ctx->subj_hash && ctx->hdrs[i]->env->real_subj)
970 hash_delete (ctx->subj_hash, ctx->hdrs[i]->env->real_subj,
972 if (ctx->id_hash && ctx->hdrs[i]->env->message_id)
973 hash_delete (ctx->id_hash, ctx->hdrs[i]->env->message_id,
975 mutt_free_header (&ctx->hdrs[i]);
981 /* update sidebar count */
982 sidebar_set_buffystats (ctx);
986 /* save changes to mailbox
992 static int _mx_sync_mailbox (CONTEXT * ctx, int *index_hint)
996 int msgcount, deleted;
998 if (ctx->dontwrite) {
999 char buf[STRING], tmp[STRING];
1001 if (km_expand_key (buf, sizeof (buf),
1002 km_find_func (MENU_MAIN, OP_TOGGLE_WRITE)))
1003 snprintf (tmp, sizeof (tmp), _(" Press '%s' to toggle write"), buf);
1005 m_strcpy(tmp, sizeof(tmp), _("Use 'toggle-write' to re-enable write!"));
1007 mutt_error (_("Mailbox is marked unwritable. %s"), tmp);
1010 else if (ctx->readonly) {
1011 mutt_error _("Mailbox is read-only.");
1016 if (!ctx->changed && !ctx->deleted) {
1017 mutt_message _("Mailbox is unchanged.");
1023 char buf[SHORT_STRING];
1025 snprintf (buf, sizeof (buf), ctx->deleted == 1
1026 ? _("Purge %d deleted message?") :
1027 _("Purge %d deleted messages?"), ctx->deleted);
1028 if ((purge = query_quadoption (OPT_DELETE, buf)) < 0)
1030 else if (purge == M_NO) {
1032 return 0; /* nothing to do! */
1034 /* let IMAP servers hold on to D flags */
1035 if (ctx->magic != M_IMAP)
1038 for (i = 0; i < ctx->msgcount; i++)
1039 ctx->hdrs[i]->deleted = 0;
1043 else if (ctx->last_tag && ctx->last_tag->deleted)
1044 ctx->last_tag = NULL; /* reset last tagged msg now useless */
1047 /* really only for IMAP - imap_sync_mailbox results in a call to
1048 * mx_update_tables, so ctx->deleted is 0 when it comes back */
1049 msgcount = ctx->msgcount;
1050 deleted = ctx->deleted;
1052 if (purge && ctx->deleted) {
1053 if (trash_append (ctx) == -1)
1058 if (ctx->magic == M_IMAP)
1059 rc = imap_sync_mailbox (ctx, purge, index_hint);
1062 rc = sync_mailbox (ctx, index_hint);
1065 if (ctx->magic == M_IMAP && !purge)
1066 mutt_message (_("Mailbox checkpointed."));
1070 mutt_message (_("%d kept, %d deleted."), msgcount - deleted, deleted);
1074 if (ctx->msgcount == ctx->deleted &&
1075 (ctx->magic == M_MBOX || ctx->magic == M_MMDF) &&
1076 !mutt_is_spool (ctx->path) && !option (OPTSAVEEMPTY)) {
1078 mx_fastclose_mailbox (ctx);
1082 /* if we haven't deleted any messages, we don't need to resort */
1083 /* ... except for certain folder formats which need "unsorted"
1084 * sort order in order to synchronize folders.
1086 * MH and maildir are safe. mbox-style seems to need re-sorting,
1087 * at least with the new threading code.
1089 if (purge || (ctx->magic != M_MAILDIR && ctx->magic != M_MH)) {
1091 /* IMAP does this automatically after handling EXPUNGE */
1092 if (ctx->magic != M_IMAP)
1095 mx_update_tables (ctx, 1);
1096 mutt_sort_headers (ctx, 1); /* rethread from scratch */
1104 int mx_sync_mailbox (CONTEXT* ctx, int* index_hint) {
1105 int ret = _mx_sync_mailbox (ctx, index_hint);
1106 sidebar_set_buffystats (ctx);
1111 * dest destintation mailbox
1112 * hdr message being copied (required for maildir support, because
1113 * the filename depends on the message flags)
1115 MESSAGE *mx_open_new_message (CONTEXT * dest, HEADER * hdr, int flags)
1118 address_t *p = NULL;
1120 if (!MX_IDX(dest->magic-1)) {
1121 debug_print (1, ("function unimplemented for mailbox type %d.\n", dest->magic));
1125 msg = p_new(MESSAGE, 1);
1126 msg->magic = dest->magic;
1130 msg->flags.flagged = hdr->flagged;
1131 msg->flags.replied = hdr->replied;
1132 msg->flags.read = hdr->read;
1133 msg->received = hdr->received;
1136 if (msg->received == 0)
1137 time (&msg->received);
1139 if (MX_COMMAND(dest->magic-1,mx_open_new_message)(msg, dest, hdr) == 0) {
1140 if (dest->magic == M_MMDF)
1141 fputs (MMDF_SEP, msg->fp);
1143 if ((msg->magic == M_MBOX || msg->magic == M_MMDF) && flags & M_ADD_FROM) {
1145 if (hdr->env->return_path)
1146 p = hdr->env->return_path;
1147 else if (hdr->env->sender)
1148 p = hdr->env->sender;
1153 fprintf (msg->fp, "From %s %s", p ? p->mailbox : NONULL (Username),
1154 ctime (&msg->received));
1163 /* check for new mail */
1164 int mx_check_mailbox (CONTEXT * ctx, int *index_hint, int lock) {
1165 #ifdef USE_COMPRESSED
1166 if (ctx->compressinfo)
1167 return mutt_check_mailbox_compressed (ctx);
1173 if (MX_IDX(ctx->magic-1) && MX_COMMAND(ctx->magic-1,mx_check_mailbox))
1174 return (MX_COMMAND(ctx->magic-1,mx_check_mailbox)(ctx, index_hint, lock));
1177 debug_print (1, ("null or invalid context.\n"));
1182 /* return a stream pointer for a message */
1183 MESSAGE *mx_open_message (CONTEXT * ctx, int msgno)
1187 msg = p_new(MESSAGE, 1);
1188 switch (msg->magic = ctx->magic) {
1197 HEADER *cur = ctx->hdrs[msgno];
1198 char path[_POSIX_PATH_MAX];
1200 snprintf (path, sizeof (path), "%s/%s", ctx->path, cur->path);
1202 if ((msg->fp = fopen (path, "r")) == NULL && errno == ENOENT &&
1203 ctx->magic == M_MAILDIR)
1204 msg->fp = maildir_open_find_message (ctx->path, cur->path);
1206 if (msg->fp == NULL) {
1208 debug_print (1, ("fopen: %s: %s (errno %d).\n", path, strerror (errno), errno));
1217 if (imap_fetch_message (msg, ctx, msgno) != 0)
1221 #endif /* USE_IMAP */
1226 if (pop_fetch_message (msg, ctx, msgno) != 0)
1230 #endif /* USE_POP */
1235 if (nntp_fetch_message (msg, ctx, msgno) != 0)
1239 #endif /* USE_NNTP */
1242 debug_print (1, ("function not implemented for mailbox type %d.\n", ctx->magic));
1249 /* commit a message to a folder */
1251 int mx_commit_message (MESSAGE * msg, CONTEXT * ctx) {
1252 if (!(msg->write && ctx->append)) {
1253 debug_print (1, ("msg->write = %d, ctx->append = %d\n", msg->write, ctx->append));
1256 if (!ctx || !MX_IDX(ctx->magic-1) || !MX_COMMAND(ctx->magic-1,mx_commit_message))
1258 return (MX_COMMAND(ctx->magic-1,mx_commit_message) (msg, ctx));
1261 /* close a pointer to a message */
1262 int mx_close_message (MESSAGE ** msg)
1266 if ((*msg)->magic == M_MH || (*msg)->magic == M_MAILDIR
1268 || (*msg)->magic == M_IMAP
1271 || (*msg)->magic == M_POP
1274 || (*msg)->magic == M_NNTP
1277 r = safe_fclose (&(*msg)->fp);
1283 debug_print (1, ("unlinking %s\n", (*msg)->path));
1284 unlink ((*msg)->path);
1285 p_delete(&(*msg)->path);
1292 void mx_alloc_memory (CONTEXT * ctx)
1295 size_t s = MAX (sizeof (HEADER *), sizeof (int));
1297 if ((ctx->hdrmax + 25) * s < ctx->hdrmax * s) {
1298 mutt_error _("Integer overflow -- can't allocate memory.");
1305 p_realloc(&ctx->hdrs, ctx->hdrmax += 25);
1306 p_realloc(&ctx->v2r, ctx->hdrmax);
1309 ctx->hdrs = p_new(HEADER *, (ctx->hdrmax += 25));
1310 ctx->v2r = p_new(int, ctx->hdrmax);
1312 for (i = ctx->msgcount; i < ctx->hdrmax; i++) {
1313 ctx->hdrs[i] = NULL;
1318 /* this routine is called to update the counts in the context structure for
1319 * the last message header parsed.
1321 void mx_update_context (CONTEXT * ctx, int new_messages)
1326 for (msgno = ctx->msgcount - new_messages; msgno < ctx->msgcount; msgno++) {
1327 h = ctx->hdrs[msgno];
1330 /* NOTE: this _must_ be done before the check for mailcap! */
1331 h->security = crypt_query (h->content);
1334 if (!ctx->pattern) {
1335 ctx->v2r[ctx->vcount] = msgno;
1336 h->virtual = ctx->vcount++;
1342 if (h->env->supersedes) {
1346 ctx->id_hash = mutt_make_id_hash (ctx);
1348 h2 = hash_find (ctx->id_hash, h->env->supersedes);
1350 /* p_delete(&h->env->supersedes); should I ? */
1353 if (!ctx->counting && option (OPTSCORE))
1354 mutt_score_message (ctx, h2, 1);
1358 /* add this message to the hash tables */
1359 if (ctx->id_hash && h->env->message_id)
1360 hash_insert (ctx->id_hash, h->env->message_id, h, 0);
1361 if (!ctx->counting) {
1362 if (ctx->subj_hash && h->env->real_subj)
1363 hash_insert (ctx->subj_hash, h->env->real_subj, h, 1);
1365 if (option (OPTSCORE))
1366 mutt_score_message (ctx, h, 0);
1381 /* update sidebar count */
1382 sidebar_set_buffystats (ctx);
1387 * 1 if the specified mailbox contains 0 messages.
1388 * 0 if the mailbox contains messages
1391 int mx_check_empty (const char *path)
1394 if ((i = mx_get_idx (path)) >= 0 && MX_COMMAND(i,mx_check_empty))
1395 return (MX_COMMAND(i,mx_check_empty)(path));
1400 int mx_acl_check (CONTEXT* ctx, int flag) {
1401 if (!ctx || !MX_IDX(ctx->magic-1))
1403 /* if no acl_check defined for module, assume permission is granted */
1404 if (!MX_COMMAND(ctx->magic-1,mx_acl_check))
1406 return (MX_COMMAND(ctx->magic-1,mx_acl_check)(ctx,flag));
1409 void mx_init (void) {
1413 list_push_back (&MailboxFormats, (void*) mbox_reg_mx ());
1414 list_push_back (&MailboxFormats, (void*) mmdf_reg_mx ());
1415 list_push_back (&MailboxFormats, (void*) mh_reg_mx ());
1416 list_push_back (&MailboxFormats, (void*) maildir_reg_mx ());
1418 list_push_back (&MailboxFormats, (void*) imap_reg_mx ());
1421 list_push_back (&MailboxFormats, (void*) pop_reg_mx ());
1424 list_push_back (&MailboxFormats, (void*) nntp_reg_mx ());
1426 #ifdef USE_COMPRESSED
1427 list_push_back (&MailboxFormats, (void*) compress_reg_mx ());
1430 /* check module registration for completeness with debug versions */
1431 #define EXITWITHERR(m) do { fprintf(stderr, "error: incomplete mx module: %s is missing for type %i\n",m,i);exit(1); } while (0)
1432 for (i = 0; i < MailboxFormats->length; i++) {
1433 if (MX_COMMAND(i,type) < 1) EXITWITHERR("type");
1434 if (!MX_COMMAND(i,mx_is_magic)) EXITWITHERR("mx_is_magic");
1435 if (!MX_COMMAND(i,mx_open_mailbox)) EXITWITHERR("mx_open_mailbox");
1436 /* if (!MX_COMMAND(i,mx_sync_mailbox)) EXITWITHERR("mx_sync_mailbox");*/
1442 int mx_rebuild_cache (void) {
1444 mutt_error (_("Support for header caching was not build in."));
1447 int i = 0, magic = 0;
1448 CONTEXT* ctx = NULL;
1451 if (list_empty(Incoming)) {
1452 mutt_error (_("No mailboxes defined."));
1456 for (i = 0; i < Incoming->length; i++) {
1457 b = (BUFFY*) Incoming->data[i];
1458 magic = mx_get_magic (b->path);
1459 if (magic != M_MAILDIR && magic != M_MH
1465 sidebar_set_current (b->path);
1466 sidebar_draw (CurrentMenu);
1467 if ((ctx = mx_open_mailbox (b->path,
1468 M_READONLY | M_NOSORT | M_COUNT,
1470 mx_close_mailbox (ctx, 0);
1472 mutt_clear_error ();
1474 if (Context && Context->path)
1475 sidebar_set_current (Context->path);
1476 sidebar_draw (CurrentMenu);