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.
11 #include <lib-lib/lib-lib.h>
15 #include <lib-sys/unix.h>
16 #include <lib-mime/mime.h>
17 #include <lib-ui/sidebar.h>
30 #include <imap/imap.h>
31 #include <imap/mx_imap.h>
34 #include <pop/mx_pop.h>
37 #include "nntp/nntp.h"
38 #include "nntp/mx_nntp.h"
45 #include <lib-crypt/crypt.h>
49 static list2_t* MailboxFormats = NULL;
50 #define MX_COMMAND(idx,cmd) ((mx_t*) MailboxFormats->data[idx])->cmd
51 #define MX_IDX(idx) (idx >= 0 && idx < MailboxFormats->length)
53 #define mutt_is_spool(s) (m_strcmp(Spoolfile, s) == 0)
58 * retry - should retry if unable to lock?
61 static int invoke_dotlock (const char *path, int dummy, int flags, int retry)
63 char cmd[LONG_STRING + _POSIX_PATH_MAX];
64 char f[SHORT_STRING + _POSIX_PATH_MAX];
67 if (flags & DL_FL_RETRY)
68 snprintf (r, sizeof (r), "-r %d ", retry ? MAXLOCKATTEMPT : 0);
70 mutt_quote_filename (f, sizeof (f), path);
72 snprintf (cmd, sizeof (cmd),
75 flags & DL_FL_TRY ? "-t " : "",
76 flags & DL_FL_UNLOCK ? "-u " : "",
77 flags & DL_FL_USEPRIV ? "-p " : "",
78 flags & DL_FL_FORCE ? "-f " : "",
79 flags & DL_FL_UNLINK ? "-d " : "",
80 flags & DL_FL_RETRY ? r : "", f);
82 return mutt_system (cmd);
85 static int dotlock_file (const char *path, int fd, int retry)
88 int flags = DL_FL_USEPRIV | DL_FL_RETRY;
94 if ((r = invoke_dotlock (path, fd, flags, retry)) == DL_EX_EXIST) {
95 if (!option (OPTNOCURSES)) {
96 char msg[LONG_STRING];
98 snprintf (msg, sizeof (msg),
99 _("Lock count exceeded, remove lock for %s?"), path);
100 if (retry && mutt_yesorno (msg, M_YES) == M_YES) {
101 flags |= DL_FL_FORCE;
108 mutt_error (_("Can't dotlock %s.\n"), path);
111 return (r == DL_EX_OK ? 0 : -1);
114 static int undotlock_file (const char *path, int fd)
116 return (invoke_dotlock (path, fd, DL_FL_USEPRIV | DL_FL_UNLOCK, 0) ==
120 #endif /* USE_DOTLOCK */
122 /* looks up index of type for path in MailboxFormats */
123 static int mx_get_idx (const char* path) {
127 /* first, test all non-local folders to avoid stat() call */
128 for (i = 0; i < MailboxFormats->length; i++) {
129 if (!MX_COMMAND(i,local))
130 t = MX_COMMAND(i,mx_is_magic)(path, NULL);
134 if (stat (path, &st) == 0) {
135 /* if stat() succeeded, keep testing until success and
136 * pass stat() info so that we only need to do it once */
137 for (i = 0; i < MailboxFormats->length; i++) {
138 if (MX_COMMAND(i,local))
139 t = MX_COMMAND(i,mx_is_magic)(path, &st);
148 * excl if excl != 0, request an exclusive lock
149 * dot if dot != 0, try to dotlock the file
150 * time_out should retry locking?
152 int mx_lock_file (const char *path, int fd, int excl, int dot, int time_out)
154 #if defined (USE_FCNTL) || defined (USE_FLOCK)
166 lck.l_type = excl ? F_WRLCK : F_RDLCK;
167 lck.l_whence = SEEK_SET;
172 while (fcntl (fd, F_SETLK, &lck) == -1) {
175 if (errno != EAGAIN && errno != EACCES) {
176 mutt_perror ("fcntl");
180 if (fstat (fd, &sb) != 0)
186 /* only unlock file if it is unchanged */
187 if (prev_sb.st_size == sb.st_size
188 && ++count >= (time_out ? MAXLOCKATTEMPT : 0)) {
190 mutt_error _("Timeout exceeded while attempting fcntl lock!");
197 mutt_message (_("Waiting for fcntl lock... %d"), ++attempt);
200 #endif /* USE_FCNTL */
205 while (flock (fd, (excl ? LOCK_EX : LOCK_SH) | LOCK_NB) == -1) {
208 if (errno != EWOULDBLOCK) {
209 mutt_perror ("flock");
214 if (fstat (fd, &sb) != 0)
220 /* only unlock file if it is unchanged */
221 if (prev_sb.st_size == sb.st_size
222 && ++count >= (time_out ? MAXLOCKATTEMPT : 0)) {
224 mutt_error _("Timeout exceeded while attempting flock lock!");
232 mutt_message (_("Waiting for flock attempt... %d"), ++attempt);
235 #endif /* USE_FLOCK */
239 r = dotlock_file (path, fd, time_out);
240 #endif /* USE_DOTLOCK */
243 /* release any other locks obtained in this routine */
246 lck.l_type = F_UNLCK;
247 fcntl (fd, F_SETLK, &lck);
248 #endif /* USE_FCNTL */
252 #endif /* USE_FLOCK */
260 int mx_unlock_file (const char *path, int fd, int dot)
263 struct flock unlockit;
265 p_clear(&unlockit, 1);
266 unlockit.l_type = F_UNLCK;
267 unlockit.l_whence = SEEK_SET;
268 fcntl (fd, F_SETLK, &unlockit);
277 undotlock_file (path, fd);
283 void mx_unlink_empty (const char *path)
291 if ((fd = open (path, O_RDWR)) == -1)
294 if (mx_lock_file (path, fd, 1, 0, 1) == -1) {
300 invoke_dotlock (path, fd, DL_FL_UNLINK, 1);
302 if (fstat (fd, &sb) == 0 && sb.st_size == 0)
306 mx_unlock_file (path, fd, 0);
310 /* try to figure out what type of mailbox ``path'' is */
311 int mx_get_magic (const char *path) {
314 if (m_strlen(path) == 0)
316 if ((i = mx_get_idx (path)) >= 0)
317 return (MX_COMMAND(i,type));
321 int mx_is_local (int m) {
324 return (MX_COMMAND(m,local));
328 * set DefaultMagic to the given value
330 int mx_set_magic (const char *s)
332 if (ascii_strcasecmp (s, "mbox") == 0)
333 DefaultMagic = M_MBOX;
334 else if (ascii_strcasecmp (s, "mmdf") == 0)
335 DefaultMagic = M_MMDF;
336 else if (ascii_strcasecmp (s, "mh") == 0)
338 else if (ascii_strcasecmp (s, "maildir") == 0)
339 DefaultMagic = M_MAILDIR;
346 /* mx_access: Wrapper for access, checks permissions on a given mailbox.
347 * We may be interested in using ACL-style flags at some point, currently
348 * we use the normal access() flags. */
349 int mx_access (const char *path, int flags)
353 if ((i = mx_get_idx (path)) >= 0 && MX_COMMAND(i,mx_access))
354 return (MX_COMMAND(i,mx_access)(path,flags));
358 static int mx_open_mailbox_append (CONTEXT * ctx, int flags)
362 /* special case for appending to compressed folders -
363 * even if we can not open them for reading */
364 if (mutt_can_append_compressed (ctx->path))
365 mutt_open_append_compressed (ctx);
369 if (mx_get_magic (ctx->path) == M_IMAP)
370 return imap_open_mailbox_append (ctx);
372 if (stat (ctx->path, &sb) == 0) {
373 ctx->magic = mx_get_magic (ctx->path);
375 switch (ctx->magic) {
377 mutt_error (_("%s is not a mailbox."), ctx->path);
383 else if (errno == ENOENT) {
384 ctx->magic = DefaultMagic;
386 if (ctx->magic == M_MH || ctx->magic == M_MAILDIR) {
387 char tmp[_POSIX_PATH_MAX];
389 if (mkdir (ctx->path, S_IRWXU)) {
390 mutt_perror (ctx->path);
394 if (ctx->magic == M_MAILDIR) {
395 snprintf (tmp, sizeof (tmp), "%s/cur", ctx->path);
396 if (mkdir (tmp, S_IRWXU)) {
402 snprintf (tmp, sizeof (tmp), "%s/new", ctx->path);
403 if (mkdir (tmp, S_IRWXU)) {
405 snprintf (tmp, sizeof (tmp), "%s/cur", ctx->path);
410 snprintf (tmp, sizeof (tmp), "%s/tmp", ctx->path);
411 if (mkdir (tmp, S_IRWXU)) {
413 snprintf (tmp, sizeof (tmp), "%s/cur", ctx->path);
415 snprintf (tmp, sizeof (tmp), "%s/new", ctx->path);
424 snprintf (tmp, sizeof (tmp), "%s/.mh_sequences", ctx->path);
425 if ((i = creat (tmp, S_IRWXU)) == -1) {
435 mutt_perror (ctx->path);
439 switch (ctx->magic) {
443 safe_fopen (ctx->path, flags & M_NEWFOLDER ? "w" : "a")) == NULL
444 || mbox_lock_mailbox (ctx, 1, 1) != 0) {
446 mutt_perror (ctx->path);
448 mutt_error (_("Couldn't lock %s\n"), ctx->path);
449 safe_fclose (&ctx->fp);
453 fseeko (ctx->fp, 0, 2);
469 * open a mailbox and parse it
472 * flags M_NOSORT do not sort mailbox
473 * M_APPEND open mailbox for appending
474 * M_READONLY open mailbox in read-only mode
475 * M_QUIET only print error messages
476 * ctx if non-null, context struct to use
478 CONTEXT *mx_open_mailbox (const char *path, int flags, CONTEXT * pctx)
484 ctx = p_new(CONTEXT, 1);
486 ctx->path = m_strdup(path);
488 ctx->msgnotreadyet = -1;
493 if (flags & M_READONLY)
498 if (flags & (M_APPEND | M_NEWFOLDER)) {
499 if (mx_open_mailbox_append (ctx, flags) != 0) {
500 mx_fastclose_mailbox (ctx);
508 if (!MX_IDX(ctx->magic-1))
509 ctx->magic = mx_get_magic (path);
511 if (ctx->magic == M_COMPRESSED)
512 mutt_open_read_compressed (ctx);
515 mutt_error (_("%s is not a mailbox."), path);
517 if (ctx->magic == -1)
520 if (ctx->magic <= 0) {
521 mx_fastclose_mailbox (ctx);
527 /* if the user has a `push' command in their .muttrc, or in a folder-hook,
528 * it will cause the progress messages not to be displayed because
529 * mutt_refresh() will think we are in the middle of a macro. so set a
530 * flag to indicate that we should really refresh the screen.
532 set_option (OPTFORCEREFRESH);
535 mutt_message (_("Reading %s..."), ctx->path);
537 rc = MX_COMMAND(ctx->magic-1,mx_open_mailbox)(ctx);
540 if ((flags & M_NOSORT) == 0) {
541 /* avoid unnecessary work since the mailbox is completely unthreaded
543 unset_option (OPTSORTSUBTHREADS);
544 unset_option (OPTNEEDRESCORE);
545 mutt_sort_headers (ctx, 1);
551 mx_fastclose_mailbox (ctx);
556 unset_option (OPTFORCEREFRESH);
560 /* free up memory associated with the mailbox context */
561 void mx_fastclose_mailbox (CONTEXT * ctx)
568 if (MX_IDX(ctx->magic-1) && MX_COMMAND(ctx->magic-1,mx_fastclose_mailbox))
569 MX_COMMAND(ctx->magic-1,mx_fastclose_mailbox(ctx));
571 hash_destroy (&ctx->subj_hash, NULL);
573 hash_destroy (&ctx->id_hash, NULL);
574 mutt_clear_threads (ctx);
575 for (i = 0; i < ctx->msgcount; i++)
576 header_delete(&ctx->hdrs[i]);
577 p_delete(&ctx->hdrs);
580 if (ctx->compressinfo)
581 mutt_fast_close_compressed (ctx);
583 p_delete(&ctx->path);
584 p_delete(&ctx->pattern);
585 if (ctx->limit_pattern)
586 mutt_pattern_free (&ctx->limit_pattern);
587 safe_fclose (&ctx->fp);
591 /* save changes to disk */
592 static int sync_mailbox (CONTEXT * ctx, int *index_hint)
597 mutt_message (_("Writing %s..."), ctx->path);
599 if (MX_IDX(ctx->magic-1))
600 /* the 1 is only of interest for IMAP and means EXPUNGE */
601 rc = MX_COMMAND(ctx->magic-1,mx_sync_mailbox(ctx,1,index_hint));
603 if (rc == 0 && ctx->compressinfo)
604 return mutt_sync_compressed (ctx);
609 /* move deleted mails to the trash folder */
610 static int trash_append (CONTEXT * ctx)
616 if (!TrashPath || !ctx->deleted ||
617 (ctx->magic == M_MAILDIR && option (OPTMAILDIRTRASH)))
620 for (; i < ctx->msgcount && (!ctx->hdrs[i]->deleted ||
621 ctx->hdrs[i]->appended); i++);
622 if (i == ctx->msgcount)
623 return 0; /* nothing to be done */
625 if (mutt_save_confirm (TrashPath, &st) != 0) {
626 mutt_error _("message(s) not deleted");
631 if (lstat (ctx->path, &stc) == 0 && stc.st_ino == st.st_ino
632 && stc.st_dev == st.st_dev && stc.st_rdev == st.st_rdev)
633 return 0; /* we are in the trash folder: simple sync */
635 if ((ctx_trash = mx_open_mailbox (TrashPath, M_APPEND, NULL)) != NULL) {
636 for (i = 0; i < ctx->msgcount; i++)
637 if (ctx->hdrs[i]->deleted && !ctx->hdrs[i]->appended
638 && !ctx->hdrs[i]->purged
639 && mutt_append_message (ctx_trash, ctx, ctx->hdrs[i], 0, 0) == -1) {
640 mx_close_mailbox (ctx_trash, NULL);
644 mx_close_mailbox (ctx_trash, NULL);
647 mutt_error _("Can't open trash folder");
655 /* save changes and close mailbox */
656 static int _mx_close_mailbox (CONTEXT * ctx, int *index_hint)
658 int i, move_messages = 0, purge = 1, read_msgs = 0;
662 char mbox[_POSIX_PATH_MAX];
663 char buf[SHORT_STRING];
671 if (ctx->magic == M_NNTP) {
674 ret = nntp_close_mailbox (ctx);
675 mx_fastclose_mailbox (ctx);
679 if (ctx->readonly || ctx->dontwrite) {
680 /* mailbox is readonly or we don't want to write */
681 mx_fastclose_mailbox (ctx);
686 /* mailbox was opened in write-mode */
687 if (ctx->magic == M_MBOX || ctx->magic == M_MMDF)
688 mbox_close_mailbox (ctx);
690 mx_fastclose_mailbox (ctx);
694 for (i = 0; i < ctx->msgcount; i++) {
695 if (!ctx->hdrs[i]->deleted && ctx->hdrs[i]->read
696 && !(ctx->hdrs[i]->flagged && option (OPTKEEPFLAGGED)))
700 if (read_msgs && quadoption (OPT_MOVE) != M_NO) {
703 if ((p = mutt_find_hook (M_MBOXHOOK, ctx->path))) {
705 m_strcpy(mbox, sizeof(mbox), p);
708 m_strcpy(mbox, sizeof(mbox), NONULL(Inbox));
709 isSpool = mutt_is_spool (ctx->path) && !mutt_is_spool (mbox);
711 mutt_expand_path (mbox, sizeof (mbox));
714 snprintf (buf, sizeof (buf), _("Move read messages to %s?"), mbox);
715 if ((move_messages = query_quadoption (OPT_MOVE, buf)) == -1) {
723 * There is no point in asking whether or not to purge if we are
724 * just marking messages as "trash".
726 if (ctx->deleted && !(ctx->magic == M_MAILDIR && option (OPTMAILDIRTRASH))) {
727 snprintf (buf, sizeof (buf), ctx->deleted == 1
728 ? _("Purge %d deleted message?") :
729 _("Purge %d deleted messages?"), ctx->deleted);
730 if ((purge = query_quadoption (OPT_DELETE, buf)) < 0) {
736 /* IMAP servers manage the OLD flag themselves */
737 if (ctx->magic != M_IMAP)
738 if (option (OPTMARKOLD)) {
739 for (i = 0; i < ctx->msgcount; i++) {
740 if (!ctx->hdrs[i]->deleted && !ctx->hdrs[i]->old)
741 mutt_set_flag (ctx, ctx->hdrs[i], M_OLD, 1);
746 mutt_message (_("Moving read messages to %s..."), mbox);
748 /* try to use server-side copy first */
751 if (ctx->magic == M_IMAP && imap_is_magic (mbox, NULL) == M_IMAP) {
752 /* tag messages for moving, and clear old tags, if any */
753 for (i = 0; i < ctx->msgcount; i++)
754 if (ctx->hdrs[i]->read && !ctx->hdrs[i]->deleted
755 && !(ctx->hdrs[i]->flagged && option (OPTKEEPFLAGGED)))
756 ctx->hdrs[i]->tagged = 1;
758 ctx->hdrs[i]->tagged = 0;
760 i = imap_copy_messages (ctx, NULL, mbox, 1);
763 if (i == 0) /* success */
765 else if (i == -1) { /* horrible error, bail */
769 else /* use regular append-copy mode */
771 if (mx_open_mailbox (mbox, M_APPEND, &f) == NULL) {
776 for (i = 0; i < ctx->msgcount; i++) {
777 if (ctx->hdrs[i]->read && !ctx->hdrs[i]->deleted
778 && !(ctx->hdrs[i]->flagged && option (OPTKEEPFLAGGED))) {
779 if (mutt_append_message (&f, ctx, ctx->hdrs[i], 0, CH_UPDATE_LEN) ==
781 mutt_set_flag (ctx, ctx->hdrs[i], M_DELETE, 1);
782 mutt_set_flag (ctx, ctx->hdrs[i], M_APPENDED, 1);
785 mx_close_mailbox (&f, NULL);
792 mx_close_mailbox (&f, NULL);
796 else if (!ctx->changed && ctx->deleted == 0) {
797 mutt_message _("Mailbox is unchanged.");
799 mx_fastclose_mailbox (ctx);
803 /* copy mails to the trash before expunging */
804 if (purge && ctx->deleted)
805 if (trash_append (ctx) != 0) {
810 /* allow IMAP to preserve the deleted flag across sessions */
811 if (ctx->magic == M_IMAP) {
812 if ((check = imap_sync_mailbox (ctx, purge, index_hint)) != 0) {
820 for (i = 0; i < ctx->msgcount; i++)
821 ctx->hdrs[i]->deleted = 0;
825 if (ctx->changed || ctx->deleted) {
826 if ((check = sync_mailbox (ctx, index_hint)) != 0) {
834 mutt_message (_("%d kept, %d moved, %d deleted."),
835 ctx->msgcount - ctx->deleted, read_msgs, ctx->deleted);
837 mutt_message (_("%d kept, %d deleted."),
838 ctx->msgcount - ctx->deleted, ctx->deleted);
840 if (ctx->msgcount == ctx->deleted &&
841 (ctx->magic == M_MMDF || ctx->magic == M_MBOX) &&
842 !mutt_is_spool (ctx->path) && !option (OPTSAVEEMPTY))
843 mx_unlink_empty (ctx->path);
845 if (ctx->compressinfo && mutt_slow_close_compressed (ctx))
848 mx_fastclose_mailbox (ctx);
853 int mx_close_mailbox (CONTEXT * ctx, int *index_hint) {
857 ret = _mx_close_mailbox (ctx, index_hint);
858 sidebar_set_buffystats (ctx);
862 /* update a Context structure's internal tables. */
864 void mx_update_tables (CONTEXT * ctx, int committing)
868 /* update memory to reflect the new state of the mailbox */
877 #define this_body ctx->hdrs[j]->content
878 for (i = 0, j = 0; i < ctx->msgcount; i++) {
879 if ((committing && (!ctx->hdrs[i]->deleted ||
880 (ctx->magic == M_MAILDIR
881 && option (OPTMAILDIRTRASH)))) || (!committing
885 ctx->hdrs[j] = ctx->hdrs[i];
888 ctx->hdrs[j]->msgno = j;
889 if (ctx->hdrs[j]->virtual != -1) {
890 ctx->v2r[ctx->vcount] = j;
891 ctx->hdrs[j]->virtual = ctx->vcount++;
892 ctx->vsize += this_body->length + this_body->offset -
893 this_body->hdr_offset;
897 ctx->hdrs[j]->changed = 0;
898 else if (ctx->hdrs[j]->changed)
902 || (ctx->magic == M_MAILDIR && option (OPTMAILDIRTRASH))) {
903 if (ctx->hdrs[j]->deleted)
907 if (ctx->hdrs[j]->tagged)
909 if (ctx->hdrs[j]->flagged)
911 if (!ctx->hdrs[j]->read) {
913 if (!ctx->hdrs[j]->old)
920 if (ctx->magic == M_MH || ctx->magic == M_MAILDIR)
921 ctx->size -= (ctx->hdrs[i]->content->length +
922 ctx->hdrs[i]->content->offset -
923 ctx->hdrs[i]->content->hdr_offset);
924 /* remove message from the hash tables */
925 if (ctx->subj_hash && ctx->hdrs[i]->env->real_subj)
926 hash_delete (ctx->subj_hash, ctx->hdrs[i]->env->real_subj,
928 if (ctx->id_hash && ctx->hdrs[i]->env->message_id)
929 hash_delete (ctx->id_hash, ctx->hdrs[i]->env->message_id,
931 header_delete(&ctx->hdrs[i]);
937 /* update sidebar count */
938 sidebar_set_buffystats (ctx);
942 /* save changes to mailbox
948 static int _mx_sync_mailbox (CONTEXT * ctx, int *index_hint)
952 int msgcount, deleted;
954 if (ctx->dontwrite) {
955 char buf[STRING], tmp[STRING];
957 if (km_expand_key (buf, sizeof (buf),
958 km_find_func (MENU_MAIN, OP_TOGGLE_WRITE)))
959 snprintf (tmp, sizeof (tmp), _(" Press '%s' to toggle write"), buf);
961 m_strcpy(tmp, sizeof(tmp), _("Use 'toggle-write' to re-enable write!"));
963 mutt_error (_("Mailbox is marked unwritable. %s"), tmp);
966 else if (ctx->readonly) {
967 mutt_error _("Mailbox is read-only.");
972 if (!ctx->changed && !ctx->deleted) {
973 mutt_message _("Mailbox is unchanged.");
979 char buf[SHORT_STRING];
981 snprintf (buf, sizeof (buf), ctx->deleted == 1
982 ? _("Purge %d deleted message?") :
983 _("Purge %d deleted messages?"), ctx->deleted);
984 if ((purge = query_quadoption (OPT_DELETE, buf)) < 0)
986 else if (purge == M_NO) {
988 return 0; /* nothing to do! */
989 /* let IMAP servers hold on to D flags */
990 if (ctx->magic != M_IMAP)
992 for (i = 0; i < ctx->msgcount; i++)
993 ctx->hdrs[i]->deleted = 0;
997 else if (ctx->last_tag && ctx->last_tag->deleted)
998 ctx->last_tag = NULL; /* reset last tagged msg now useless */
1001 /* really only for IMAP - imap_sync_mailbox results in a call to
1002 * mx_update_tables, so ctx->deleted is 0 when it comes back */
1003 msgcount = ctx->msgcount;
1004 deleted = ctx->deleted;
1006 if (purge && ctx->deleted) {
1007 if (trash_append (ctx) == -1)
1011 if (ctx->magic == M_IMAP)
1012 rc = imap_sync_mailbox (ctx, purge, index_hint);
1014 rc = sync_mailbox (ctx, index_hint);
1016 if (ctx->magic == M_IMAP && !purge)
1017 mutt_message (_("Mailbox checkpointed."));
1020 mutt_message (_("%d kept, %d deleted."), msgcount - deleted, deleted);
1024 if (ctx->msgcount == ctx->deleted &&
1025 (ctx->magic == M_MBOX || ctx->magic == M_MMDF) &&
1026 !mutt_is_spool (ctx->path) && !option (OPTSAVEEMPTY)) {
1028 mx_fastclose_mailbox (ctx);
1032 /* if we haven't deleted any messages, we don't need to resort */
1033 /* ... except for certain folder formats which need "unsorted"
1034 * sort order in order to synchronize folders.
1036 * MH and maildir are safe. mbox-style seems to need re-sorting,
1037 * at least with the new threading code.
1039 if (purge || (ctx->magic != M_MAILDIR && ctx->magic != M_MH)) {
1040 /* IMAP does this automatically after handling EXPUNGE */
1041 if (ctx->magic != M_IMAP)
1043 mx_update_tables (ctx, 1);
1044 mutt_sort_headers (ctx, 1); /* rethread from scratch */
1052 int mx_sync_mailbox (CONTEXT* ctx, int* index_hint) {
1053 int ret = _mx_sync_mailbox (ctx, index_hint);
1054 sidebar_set_buffystats (ctx);
1059 * dest destintation mailbox
1060 * hdr message being copied (required for maildir support, because
1061 * the filename depends on the message flags)
1063 MESSAGE *mx_open_new_message (CONTEXT * dest, HEADER * hdr, int flags)
1066 address_t *p = NULL;
1068 if (!MX_IDX(dest->magic-1)) {
1072 msg = p_new(MESSAGE, 1);
1073 msg->magic = dest->magic;
1077 msg->flags.flagged = hdr->flagged;
1078 msg->flags.replied = hdr->replied;
1079 msg->flags.read = hdr->read;
1080 msg->received = hdr->received;
1083 if (msg->received == 0)
1084 time (&msg->received);
1086 if (MX_COMMAND(dest->magic-1,mx_open_new_message)(msg, dest, hdr) == 0) {
1087 if (dest->magic == M_MMDF)
1088 fputs (MMDF_SEP, msg->fp);
1090 if ((msg->magic == M_MBOX || msg->magic == M_MMDF) && flags & M_ADD_FROM) {
1092 if (hdr->env->return_path)
1093 p = hdr->env->return_path;
1094 else if (hdr->env->sender)
1095 p = hdr->env->sender;
1100 fprintf (msg->fp, "From %s %s", p ? p->mailbox : NONULL (Username),
1101 ctime (&msg->received));
1110 /* check for new mail */
1111 int mx_check_mailbox (CONTEXT * ctx, int *index_hint, int lock) {
1112 if (ctx->compressinfo)
1113 return mutt_check_mailbox_compressed (ctx);
1118 if (MX_IDX(ctx->magic-1) && MX_COMMAND(ctx->magic-1,mx_check_mailbox))
1119 return (MX_COMMAND(ctx->magic-1,mx_check_mailbox)(ctx, index_hint, lock));
1125 /* return a stream pointer for a message */
1126 MESSAGE *mx_open_message (CONTEXT * ctx, int msgno)
1130 msg = p_new(MESSAGE, 1);
1131 switch (msg->magic = ctx->magic) {
1140 HEADER *cur = ctx->hdrs[msgno];
1141 char path[_POSIX_PATH_MAX];
1143 snprintf (path, sizeof (path), "%s/%s", ctx->path, cur->path);
1145 if ((msg->fp = fopen (path, "r")) == NULL && errno == ENOENT &&
1146 ctx->magic == M_MAILDIR)
1147 msg->fp = maildir_open_find_message (ctx->path, cur->path);
1149 if (msg->fp == NULL) {
1158 if (imap_fetch_message (msg, ctx, msgno) != 0)
1165 if (pop_fetch_message (msg, ctx, msgno) != 0)
1173 if (nntp_fetch_message (msg, ctx, msgno) != 0)
1177 #endif /* USE_NNTP */
1186 /* commit a message to a folder */
1188 int mx_commit_message (MESSAGE * msg, CONTEXT * ctx) {
1189 if (!(msg->write && ctx->append)) {
1192 if (!ctx || !MX_IDX(ctx->magic-1) || !MX_COMMAND(ctx->magic-1,mx_commit_message))
1194 return (MX_COMMAND(ctx->magic-1,mx_commit_message) (msg, ctx));
1197 /* close a pointer to a message */
1198 int mx_close_message (MESSAGE ** msg)
1202 if ((*msg)->magic == M_MH || (*msg)->magic == M_MAILDIR
1203 || (*msg)->magic == M_IMAP
1204 || (*msg)->magic == M_POP
1206 || (*msg)->magic == M_NNTP
1209 r = safe_fclose (&(*msg)->fp);
1215 unlink ((*msg)->path);
1216 p_delete(&(*msg)->path);
1223 void mx_alloc_memory (CONTEXT * ctx)
1226 size_t s = MAX (sizeof (HEADER *), sizeof (int));
1228 if ((ctx->hdrmax + 25) * s < ctx->hdrmax * s) {
1229 mutt_error _("Integer overflow -- can't allocate memory.");
1236 p_realloc(&ctx->hdrs, ctx->hdrmax += 25);
1237 p_realloc(&ctx->v2r, ctx->hdrmax);
1240 ctx->hdrs = p_new(HEADER *, (ctx->hdrmax += 25));
1241 ctx->v2r = p_new(int, ctx->hdrmax);
1243 for (i = ctx->msgcount; i < ctx->hdrmax; i++) {
1244 ctx->hdrs[i] = NULL;
1249 /* this routine is called to update the counts in the context structure for
1250 * the last message header parsed.
1252 void mx_update_context (CONTEXT * ctx, int new_messages)
1257 for (msgno = ctx->msgcount - new_messages; msgno < ctx->msgcount; msgno++) {
1258 h = ctx->hdrs[msgno];
1260 /* NOTE: this _must_ be done before the check for mailcap! */
1261 h->security = crypt_query (h->content);
1263 if (!ctx->pattern) {
1264 ctx->v2r[ctx->vcount] = msgno;
1265 h->virtual = ctx->vcount++;
1271 if (h->env->supersedes) {
1275 ctx->id_hash = mutt_make_id_hash (ctx);
1277 h2 = hash_find (ctx->id_hash, h->env->supersedes);
1279 /* p_delete(&h->env->supersedes); should I ? */
1282 if (!ctx->counting && option (OPTSCORE))
1283 mutt_score_message (ctx, h2, 1);
1287 /* add this message to the hash tables */
1288 if (ctx->id_hash && h->env->message_id)
1289 hash_insert (ctx->id_hash, h->env->message_id, h, 0);
1290 if (!ctx->counting) {
1291 if (ctx->subj_hash && h->env->real_subj)
1292 hash_insert (ctx->subj_hash, h->env->real_subj, h, 1);
1294 if (option (OPTSCORE))
1295 mutt_score_message (ctx, h, 0);
1310 /* update sidebar count */
1311 sidebar_set_buffystats (ctx);
1316 * 1 if the specified mailbox contains 0 messages.
1317 * 0 if the mailbox contains messages
1320 int mx_check_empty (const char *path)
1323 if ((i = mx_get_idx (path)) >= 0 && MX_COMMAND(i,mx_check_empty))
1324 return (MX_COMMAND(i,mx_check_empty)(path));
1329 int mx_acl_check (CONTEXT* ctx, int flag) {
1330 if (!ctx || !MX_IDX(ctx->magic-1))
1332 /* if no acl_check defined for module, assume permission is granted */
1333 if (!MX_COMMAND(ctx->magic-1,mx_acl_check))
1335 return (MX_COMMAND(ctx->magic-1,mx_acl_check)(ctx,flag));
1338 void mx_init (void) {
1339 list_push_back (&MailboxFormats, (void*) mbox_reg_mx ());
1340 list_push_back (&MailboxFormats, (void*) mmdf_reg_mx ());
1341 list_push_back (&MailboxFormats, (void*) mh_reg_mx ());
1342 list_push_back (&MailboxFormats, (void*) maildir_reg_mx ());
1343 list_push_back (&MailboxFormats, (void*) imap_reg_mx ());
1344 list_push_back (&MailboxFormats, (void*) pop_reg_mx ());
1346 list_push_back (&MailboxFormats, (void*) nntp_reg_mx ());
1348 list_push_back (&MailboxFormats, (void*) compress_reg_mx ());
1351 int mx_rebuild_cache (void) {
1353 mutt_error (_("Support for header caching was not build in."));
1356 int i = 0, magic = 0;
1357 CONTEXT* ctx = NULL;
1360 if (list_empty(Incoming)) {
1361 mutt_error (_("No mailboxes defined."));
1365 for (i = 0; i < Incoming->length; i++) {
1366 b = (BUFFY*) Incoming->data[i];
1367 magic = mx_get_magic (b->path);
1368 if (magic != M_MAILDIR && magic != M_MH && magic != M_IMAP)
1370 sidebar_set_current (b->path);
1371 sidebar_draw (CurrentMenu);
1372 if ((ctx = mx_open_mailbox (b->path,
1373 M_READONLY | M_NOSORT | M_COUNT,
1375 mx_close_mailbox (ctx, 0);
1377 mutt_clear_error ();
1379 if (Context && Context->path)
1380 sidebar_set_current (Context->path);
1381 sidebar_draw (CurrentMenu);
1387 void mutt_parse_mime_message (CONTEXT * ctx, HEADER * cur)
1393 if (cur->content->type != TYPEMESSAGE
1394 && cur->content->type != TYPEMULTIPART)
1395 break; /* nothing to do */
1397 if (cur->content->parts)
1398 break; /* The message was parsed earlier. */
1400 if ((msg = mx_open_message (ctx, cur->msgno))) {
1401 mutt_parse_part (msg->fp, cur->content);
1403 cur->security = crypt_query (cur->content);
1405 mx_close_message (&msg);
1408 mutt_count_body_parts (cur, flags | M_PARTS_RECOUNT);