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>
31 #include <imap/imap.h>
35 #include <nntp/nntp.h>
38 #include <lib-crypt/crypt.h>
40 static mx_t const *mxfmts[] = {
53 #define MX_IDX(idx) (idx >= 0 && idx < countof(mxfmts))
54 #define mutt_is_spool(s) (m_strcmp(Spoolfile, s) == 0)
58 * retry - should retry if unable to lock?
60 static int invoke_dotlock (const char *path, int flags, int retry)
62 char cmd[LONG_STRING + _POSIX_PATH_MAX];
63 char f[SHORT_STRING + _POSIX_PATH_MAX];
66 if (flags & DL_FL_RETRY)
67 snprintf (r, sizeof (r), "-r %d ", retry ? MAXLOCKATTEMPT : 0);
69 mutt_quote_filename (f, sizeof (f), path);
71 snprintf (cmd, sizeof (cmd),
74 flags & DL_FL_TRY ? "-t " : "",
75 flags & DL_FL_UNLOCK ? "-u " : "",
76 flags & DL_FL_USEPRIV ? "-p " : "",
77 flags & DL_FL_FORCE ? "-f " : "",
78 flags & DL_FL_UNLINK ? "-d " : "",
79 flags & DL_FL_RETRY ? r : "", f);
81 return mutt_system (cmd);
84 static int dotlock_file (const char *path, int retry)
87 int flags = DL_FL_USEPRIV | DL_FL_RETRY;
93 if ((r = invoke_dotlock (path, flags, retry)) == DL_EX_EXIST) {
94 if (!option (OPTNOCURSES)) {
95 char msg[LONG_STRING];
97 snprintf (msg, sizeof (msg),
98 _("Lock count exceeded, remove lock for %s?"), path);
99 if (retry && mutt_yesorno (msg, M_YES) == M_YES) {
100 flags |= DL_FL_FORCE;
107 mutt_error (_("Can't dotlock %s.\n"), path);
110 return (r == DL_EX_OK ? 0 : -1);
113 static int undotlock_file (const char *path)
115 return (invoke_dotlock (path, DL_FL_USEPRIV | DL_FL_UNLOCK, 0) ==
119 /* looks up index of type for path in mxfmts */
120 static int mx_get_idx (const char* path) {
124 /* first, test all non-local folders to avoid stat() call */
125 for (i = 0; i < countof(mxfmts); i++) {
126 if (!mxfmts[i]->local)
127 t = mxfmts[i]->mx_is_magic(path, NULL);
131 if (stat (path, &st) == 0) {
132 /* if stat() succeeded, keep testing until success and
133 * pass stat() info so that we only need to do it once */
134 for (i = 0; i < countof(mxfmts); i++) {
135 if (mxfmts[i]->local)
136 t = mxfmts[i]->mx_is_magic(path, &st);
145 * excl if excl != 0, request an exclusive lock
146 * dot if dot != 0, try to dotlock the file
147 * time_out should retry locking?
149 int mx_lock_file (const char *path, int fd, int excl, int dot, int time_out)
151 #if defined (USE_FCNTL) || defined (USE_FLOCK)
163 lck.l_type = excl ? F_WRLCK : F_RDLCK;
164 lck.l_whence = SEEK_SET;
169 while (fcntl (fd, F_SETLK, &lck) == -1) {
172 if (errno != EAGAIN && errno != EACCES) {
173 mutt_perror ("fcntl");
177 if (fstat (fd, &sb) != 0)
183 /* only unlock file if it is unchanged */
184 if (prev_sb.st_size == sb.st_size
185 && ++count >= (time_out ? MAXLOCKATTEMPT : 0)) {
187 mutt_error _("Timeout exceeded while attempting fcntl lock!");
194 mutt_message (_("Waiting for fcntl lock... %d"), ++attempt);
197 #endif /* USE_FCNTL */
202 while (flock (fd, (excl ? LOCK_EX : LOCK_SH) | LOCK_NB) == -1) {
205 if (errno != EWOULDBLOCK) {
206 mutt_perror ("flock");
211 if (fstat (fd, &sb) != 0)
217 /* only unlock file if it is unchanged */
218 if (prev_sb.st_size == sb.st_size
219 && ++count >= (time_out ? MAXLOCKATTEMPT : 0)) {
221 mutt_error _("Timeout exceeded while attempting flock lock!");
229 mutt_message (_("Waiting for flock attempt... %d"), ++attempt);
232 #endif /* USE_FLOCK */
235 r = dotlock_file (path, time_out);
238 /* release any other locks obtained in this routine */
241 lck.l_type = F_UNLCK;
242 fcntl (fd, F_SETLK, &lck);
243 #endif /* USE_FCNTL */
247 #endif /* USE_FLOCK */
255 int mx_unlock_file (const char *path, int fd, int dot)
258 struct flock unlockit;
260 p_clear(&unlockit, 1);
261 unlockit.l_type = F_UNLCK;
262 unlockit.l_whence = SEEK_SET;
263 fcntl (fd, F_SETLK, &unlockit);
271 undotlock_file (path);
276 static void mx_unlink_empty (const char *path)
280 if ((fd = open (path, O_RDWR)) == -1)
283 if (mx_lock_file (path, fd, 1, 0, 1) == -1) {
288 invoke_dotlock(path, DL_FL_UNLINK, 1);
290 mx_unlock_file (path, fd, 0);
294 /* try to figure out what type of mailbox ``path'' is */
295 int mx_get_magic (const char *path) {
298 if (m_strlen(path) == 0)
300 if ((i = mx_get_idx (path)) >= 0)
301 return (mxfmts[i]->type);
305 int mx_is_local (int m) {
308 return (mxfmts[m]->local);
312 * set DefaultMagic to the given value
314 int mx_set_magic (const char *s)
316 if (ascii_strcasecmp (s, "mbox") == 0)
317 DefaultMagic = M_MBOX;
318 else if (ascii_strcasecmp (s, "mmdf") == 0)
319 DefaultMagic = M_MMDF;
320 else if (ascii_strcasecmp (s, "mh") == 0)
322 else if (ascii_strcasecmp (s, "maildir") == 0)
323 DefaultMagic = M_MAILDIR;
330 /* mx_access: Wrapper for access, checks permissions on a given mailbox.
331 * We may be interested in using ACL-style flags at some point, currently
332 * we use the normal access() flags. */
333 int mx_access (const char *path, int flags)
337 if ((i = mx_get_idx (path)) >= 0 && mxfmts[i]->mx_access)
338 return (mxfmts[i]->mx_access(path,flags));
342 static int mx_open_mailbox_append (CONTEXT * ctx, int flags)
346 /* special case for appending to compressed folders -
347 * even if we can not open them for reading */
348 if (mutt_can_append_compressed (ctx->path))
349 mutt_open_append_compressed (ctx);
353 if (mx_get_magic (ctx->path) == M_IMAP)
354 return imap_open_mailbox_append (ctx);
356 if (stat (ctx->path, &sb) == 0) {
357 ctx->magic = mx_get_magic (ctx->path);
359 switch (ctx->magic) {
361 mutt_error (_("%s is not a mailbox."), ctx->path);
367 else if (errno == ENOENT) {
368 ctx->magic = DefaultMagic;
370 if (ctx->magic == M_MH || ctx->magic == M_MAILDIR) {
371 char tmp[_POSIX_PATH_MAX];
373 if (mkdir (ctx->path, S_IRWXU)) {
374 mutt_perror (ctx->path);
378 if (ctx->magic == M_MAILDIR) {
379 snprintf (tmp, sizeof (tmp), "%s/cur", ctx->path);
380 if (mkdir (tmp, S_IRWXU)) {
386 snprintf (tmp, sizeof (tmp), "%s/new", ctx->path);
387 if (mkdir (tmp, S_IRWXU)) {
389 snprintf (tmp, sizeof (tmp), "%s/cur", ctx->path);
394 snprintf (tmp, sizeof (tmp), "%s/tmp", ctx->path);
395 if (mkdir (tmp, S_IRWXU)) {
397 snprintf (tmp, sizeof (tmp), "%s/cur", ctx->path);
399 snprintf (tmp, sizeof (tmp), "%s/new", ctx->path);
408 snprintf (tmp, sizeof (tmp), "%s/.mh_sequences", ctx->path);
409 if ((i = creat (tmp, S_IRWXU)) == -1) {
419 mutt_perror (ctx->path);
423 switch (ctx->magic) {
427 safe_fopen (ctx->path, flags & M_NEWFOLDER ? "w" : "a")) == NULL
428 || mbox_lock_mailbox (ctx, 1, 1) != 0) {
430 mutt_perror (ctx->path);
432 mutt_error (_("Couldn't lock %s\n"), ctx->path);
437 fseeko (ctx->fp, 0, 2);
453 * open a mailbox and parse it
456 * flags M_NOSORT do not sort mailbox
457 * M_APPEND open mailbox for appending
458 * M_READONLY open mailbox in read-only mode
459 * M_QUIET only print error messages
460 * ctx if non-null, context struct to use
462 CONTEXT *mx_open_mailbox (const char *path, int flags, CONTEXT * pctx)
468 ctx = p_new(CONTEXT, 1);
470 ctx->path = m_strdup(path);
472 ctx->msgnotreadyet = -1;
477 if (flags & M_READONLY)
482 if (flags & (M_APPEND | M_NEWFOLDER)) {
483 if (mx_open_mailbox_append (ctx, flags) != 0) {
484 mx_fastclose_mailbox (ctx);
492 if (!MX_IDX(ctx->magic-1))
493 ctx->magic = mx_get_magic (path);
495 if (ctx->magic == M_COMPRESSED)
496 mutt_open_read_compressed (ctx);
499 mutt_error (_("%s is not a mailbox."), path);
501 if (ctx->magic == -1)
504 if (ctx->magic <= 0) {
505 mx_fastclose_mailbox (ctx);
511 /* if the user has a `push' command in their .muttrc, or in a folder-hook,
512 * it will cause the progress messages not to be displayed because
513 * mutt_refresh() will think we are in the middle of a macro. so set a
514 * flag to indicate that we should really refresh the screen.
516 set_option (OPTFORCEREFRESH);
519 mutt_message (_("Reading %s..."), ctx->path);
521 rc = mxfmts[ctx->magic-1]->mx_open_mailbox(ctx);
524 if ((flags & M_NOSORT) == 0) {
525 /* avoid unnecessary work since the mailbox is completely unthreaded
527 unset_option (OPTSORTSUBTHREADS);
528 unset_option (OPTNEEDRESCORE);
529 mutt_sort_headers (ctx, 1);
535 mx_fastclose_mailbox (ctx);
540 unset_option (OPTFORCEREFRESH);
544 /* free up memory associated with the mailbox context */
545 void mx_fastclose_mailbox (CONTEXT * ctx)
552 if (MX_IDX(ctx->magic-1) && mxfmts[ctx->magic-1]->mx_fastclose_mailbox)
553 mxfmts[ctx->magic-1]->mx_fastclose_mailbox(ctx);
555 hash_destroy (&ctx->subj_hash, NULL);
557 hash_destroy (&ctx->id_hash, NULL);
558 mutt_clear_threads (ctx);
559 for (i = 0; i < ctx->msgcount; i++)
560 header_delete(&ctx->hdrs[i]);
561 p_delete(&ctx->hdrs);
565 mutt_fast_close_compressed (ctx);
567 p_delete(&ctx->path);
568 p_delete(&ctx->pattern);
569 if (ctx->limit_pattern)
570 mutt_pattern_free (&ctx->limit_pattern);
575 /* save changes to disk */
576 static int sync_mailbox (CONTEXT * ctx, int *index_hint)
581 mutt_message (_("Writing %s..."), ctx->path);
583 if (MX_IDX(ctx->magic-1))
584 /* the 1 is only of interest for IMAP and means EXPUNGE */
585 rc = mxfmts[ctx->magic-1]->mx_sync_mailbox(ctx,1,index_hint);
587 if (rc == 0 && ctx->cinfo)
588 return mutt_sync_compressed (ctx);
593 /* move deleted mails to the trash folder */
594 static int trash_append (CONTEXT * ctx)
600 if (!TrashPath || !ctx->deleted ||
601 (ctx->magic == M_MAILDIR && option (OPTMAILDIRTRASH)))
604 for (; i < ctx->msgcount && (!ctx->hdrs[i]->deleted ||
605 ctx->hdrs[i]->appended); i++);
606 if (i == ctx->msgcount)
607 return 0; /* nothing to be done */
609 if (mutt_save_confirm (TrashPath, &st) != 0) {
610 mutt_error _("message(s) not deleted");
615 if (lstat (ctx->path, &stc) == 0 && stc.st_ino == st.st_ino
616 && stc.st_dev == st.st_dev && stc.st_rdev == st.st_rdev)
617 return 0; /* we are in the trash folder: simple sync */
619 if ((ctx_trash = mx_open_mailbox (TrashPath, M_APPEND, NULL)) != NULL) {
620 for (i = 0; i < ctx->msgcount; i++)
621 if (ctx->hdrs[i]->deleted && !ctx->hdrs[i]->appended
622 && !ctx->hdrs[i]->purged
623 && mutt_append_message (ctx_trash, ctx, ctx->hdrs[i], 0, 0) == -1) {
624 mx_close_mailbox (ctx_trash, NULL);
628 mx_close_mailbox (ctx_trash, NULL);
631 mutt_error _("Can't open trash folder");
639 /* save changes and close mailbox */
640 static int _mx_close_mailbox (CONTEXT * ctx, int *index_hint)
642 int i, move_messages = 0, purge = 1, read_msgs = 0;
646 char mbox[_POSIX_PATH_MAX];
647 char buf[SHORT_STRING];
655 if (ctx->magic == M_NNTP) {
658 ret = nntp_close_mailbox (ctx);
659 mx_fastclose_mailbox (ctx);
663 if (ctx->readonly || ctx->dontwrite) {
664 /* mailbox is readonly or we don't want to write */
665 mx_fastclose_mailbox (ctx);
670 /* mailbox was opened in write-mode */
671 if (ctx->magic == M_MBOX || ctx->magic == M_MMDF)
672 mbox_close_mailbox (ctx);
674 mx_fastclose_mailbox (ctx);
678 for (i = 0; i < ctx->msgcount; i++) {
679 if (!ctx->hdrs[i]->deleted && ctx->hdrs[i]->read
680 && !(ctx->hdrs[i]->flagged && option (OPTKEEPFLAGGED)))
684 if (read_msgs && quadoption (OPT_MOVE) != M_NO) {
687 if ((p = mutt_find_hook (M_MBOXHOOK, ctx->path))) {
689 m_strcpy(mbox, sizeof(mbox), p);
692 m_strcpy(mbox, sizeof(mbox), NONULL(Inbox));
693 isSpool = mutt_is_spool (ctx->path) && !mutt_is_spool (mbox);
695 mutt_expand_path (mbox, sizeof (mbox));
698 snprintf (buf, sizeof (buf), _("Move read messages to %s?"), mbox);
699 if ((move_messages = query_quadoption (OPT_MOVE, buf)) == -1) {
707 * There is no point in asking whether or not to purge if we are
708 * just marking messages as "trash".
710 if (ctx->deleted && !(ctx->magic == M_MAILDIR && option (OPTMAILDIRTRASH))) {
711 snprintf (buf, sizeof (buf), ctx->deleted == 1
712 ? _("Purge %d deleted message?") :
713 _("Purge %d deleted messages?"), ctx->deleted);
714 if ((purge = query_quadoption (OPT_DELETE, buf)) < 0) {
720 /* IMAP servers manage the OLD flag themselves */
721 if (ctx->magic != M_IMAP)
722 if (option (OPTMARKOLD)) {
723 for (i = 0; i < ctx->msgcount; i++) {
724 if (!ctx->hdrs[i]->deleted && !ctx->hdrs[i]->old)
725 mutt_set_flag (ctx, ctx->hdrs[i], M_OLD, 1);
730 mutt_message (_("Moving read messages to %s..."), mbox);
732 /* try to use server-side copy first */
735 if (ctx->magic == M_IMAP && imap_is_magic (mbox, NULL) == M_IMAP) {
736 /* tag messages for moving, and clear old tags, if any */
737 for (i = 0; i < ctx->msgcount; i++)
738 if (ctx->hdrs[i]->read && !ctx->hdrs[i]->deleted
739 && !(ctx->hdrs[i]->flagged && option (OPTKEEPFLAGGED)))
740 ctx->hdrs[i]->tagged = 1;
742 ctx->hdrs[i]->tagged = 0;
744 i = imap_copy_messages (ctx, NULL, mbox, 1);
747 if (i == 0) /* success */
749 else if (i == -1) { /* horrible error, bail */
753 else /* use regular append-copy mode */
755 if (mx_open_mailbox (mbox, M_APPEND, &f) == NULL) {
760 for (i = 0; i < ctx->msgcount; i++) {
761 if (ctx->hdrs[i]->read && !ctx->hdrs[i]->deleted
762 && !(ctx->hdrs[i]->flagged && option (OPTKEEPFLAGGED))) {
763 if (mutt_append_message (&f, ctx, ctx->hdrs[i], 0, CH_UPDATE_LEN) ==
765 mutt_set_flag (ctx, ctx->hdrs[i], M_DELETE, 1);
766 mutt_set_flag (ctx, ctx->hdrs[i], M_APPENDED, 1);
769 mx_close_mailbox (&f, NULL);
776 mx_close_mailbox (&f, NULL);
780 else if (!ctx->changed && ctx->deleted == 0) {
781 mutt_message _("Mailbox is unchanged.");
783 mx_fastclose_mailbox (ctx);
787 /* copy mails to the trash before expunging */
788 if (purge && ctx->deleted)
789 if (trash_append (ctx) != 0) {
794 /* allow IMAP to preserve the deleted flag across sessions */
795 if (ctx->magic == M_IMAP) {
796 if ((check = imap_sync_mailbox (ctx, purge, index_hint)) != 0) {
804 for (i = 0; i < ctx->msgcount; i++)
805 ctx->hdrs[i]->deleted = 0;
809 if (ctx->changed || ctx->deleted) {
810 if ((check = sync_mailbox (ctx, index_hint)) != 0) {
818 mutt_message (_("%d kept, %d moved, %d deleted."),
819 ctx->msgcount - ctx->deleted, read_msgs, ctx->deleted);
821 mutt_message (_("%d kept, %d deleted."),
822 ctx->msgcount - ctx->deleted, ctx->deleted);
824 if (ctx->msgcount == ctx->deleted &&
825 (ctx->magic == M_MMDF || ctx->magic == M_MBOX) &&
826 !mutt_is_spool (ctx->path) && !option (OPTSAVEEMPTY))
827 mx_unlink_empty (ctx->path);
829 if (ctx->cinfo && mutt_slow_close_compressed (ctx))
832 mx_fastclose_mailbox (ctx);
837 int mx_close_mailbox (CONTEXT * ctx, int *index_hint) {
841 ret = _mx_close_mailbox (ctx, index_hint);
842 sidebar_set_buffystats (ctx);
846 /* update a Context structure's internal tables. */
848 void mx_update_tables (CONTEXT * ctx, int committing)
852 /* update memory to reflect the new state of the mailbox */
861 #define this_body ctx->hdrs[j]->content
862 for (i = 0, j = 0; i < ctx->msgcount; i++) {
863 if ((committing && (!ctx->hdrs[i]->deleted ||
864 (ctx->magic == M_MAILDIR
865 && option (OPTMAILDIRTRASH)))) || (!committing
869 ctx->hdrs[j] = ctx->hdrs[i];
872 ctx->hdrs[j]->msgno = j;
873 if (ctx->hdrs[j]->virtual != -1) {
874 ctx->v2r[ctx->vcount] = j;
875 ctx->hdrs[j]->virtual = ctx->vcount++;
876 ctx->vsize += this_body->length + this_body->offset -
877 this_body->hdr_offset;
881 ctx->hdrs[j]->changed = 0;
882 else if (ctx->hdrs[j]->changed)
886 || (ctx->magic == M_MAILDIR && option (OPTMAILDIRTRASH))) {
887 if (ctx->hdrs[j]->deleted)
891 if (ctx->hdrs[j]->tagged)
893 if (ctx->hdrs[j]->flagged)
895 if (!ctx->hdrs[j]->read) {
897 if (!ctx->hdrs[j]->old)
904 if (ctx->magic == M_MH || ctx->magic == M_MAILDIR)
905 ctx->size -= (ctx->hdrs[i]->content->length +
906 ctx->hdrs[i]->content->offset -
907 ctx->hdrs[i]->content->hdr_offset);
908 /* remove message from the hash tables */
909 if (ctx->subj_hash && ctx->hdrs[i]->env->real_subj)
910 hash_delete (ctx->subj_hash, ctx->hdrs[i]->env->real_subj,
912 if (ctx->id_hash && ctx->hdrs[i]->env->message_id)
913 hash_delete (ctx->id_hash, ctx->hdrs[i]->env->message_id,
915 header_delete(&ctx->hdrs[i]);
921 /* update sidebar count */
922 sidebar_set_buffystats (ctx);
926 /* save changes to mailbox
932 static int _mx_sync_mailbox (CONTEXT * ctx, int *index_hint)
936 int msgcount, deleted;
938 if (ctx->dontwrite) {
939 char buf[STRING], tmp[STRING];
941 if (km_expand_key (buf, sizeof (buf),
942 km_find_func (MENU_MAIN, OP_TOGGLE_WRITE)))
943 snprintf (tmp, sizeof (tmp), _(" Press '%s' to toggle write"), buf);
945 m_strcpy(tmp, sizeof(tmp), _("Use 'toggle-write' to re-enable write!"));
947 mutt_error (_("Mailbox is marked unwritable. %s"), tmp);
950 else if (ctx->readonly) {
951 mutt_error _("Mailbox is read-only.");
956 if (!ctx->changed && !ctx->deleted) {
957 mutt_message _("Mailbox is unchanged.");
963 char buf[SHORT_STRING];
965 snprintf (buf, sizeof (buf), ctx->deleted == 1
966 ? _("Purge %d deleted message?") :
967 _("Purge %d deleted messages?"), ctx->deleted);
968 if ((purge = query_quadoption (OPT_DELETE, buf)) < 0)
970 else if (purge == M_NO) {
972 return 0; /* nothing to do! */
973 /* let IMAP servers hold on to D flags */
974 if (ctx->magic != M_IMAP)
976 for (i = 0; i < ctx->msgcount; i++)
977 ctx->hdrs[i]->deleted = 0;
981 else if (ctx->last_tag && ctx->last_tag->deleted)
982 ctx->last_tag = NULL; /* reset last tagged msg now useless */
985 /* really only for IMAP - imap_sync_mailbox results in a call to
986 * mx_update_tables, so ctx->deleted is 0 when it comes back */
987 msgcount = ctx->msgcount;
988 deleted = ctx->deleted;
990 if (purge && ctx->deleted) {
991 if (trash_append (ctx) == -1)
995 if (ctx->magic == M_IMAP)
996 rc = imap_sync_mailbox (ctx, purge, index_hint);
998 rc = sync_mailbox (ctx, index_hint);
1000 if (ctx->magic == M_IMAP && !purge)
1001 mutt_message (_("Mailbox checkpointed."));
1004 mutt_message (_("%d kept, %d deleted."), msgcount - deleted, deleted);
1008 if (ctx->msgcount == ctx->deleted &&
1009 (ctx->magic == M_MBOX || ctx->magic == M_MMDF) &&
1010 !mutt_is_spool (ctx->path) && !option (OPTSAVEEMPTY)) {
1012 mx_fastclose_mailbox (ctx);
1016 /* if we haven't deleted any messages, we don't need to resort */
1017 /* ... except for certain folder formats which need "unsorted"
1018 * sort order in order to synchronize folders.
1020 * MH and maildir are safe. mbox-style seems to need re-sorting,
1021 * at least with the new threading code.
1023 if (purge || (ctx->magic != M_MAILDIR && ctx->magic != M_MH)) {
1024 /* IMAP does this automatically after handling EXPUNGE */
1025 if (ctx->magic != M_IMAP)
1027 mx_update_tables (ctx, 1);
1028 mutt_sort_headers (ctx, 1); /* rethread from scratch */
1036 int mx_sync_mailbox (CONTEXT* ctx, int* index_hint) {
1037 int ret = _mx_sync_mailbox (ctx, index_hint);
1038 sidebar_set_buffystats (ctx);
1043 * dest destintation mailbox
1044 * hdr message being copied (required for maildir support, because
1045 * the filename depends on the message flags)
1047 MESSAGE *mx_open_new_message (CONTEXT * dest, HEADER * hdr, int flags)
1050 address_t *p = NULL;
1052 if (!MX_IDX(dest->magic-1)) {
1056 msg = p_new(MESSAGE, 1);
1057 msg->magic = dest->magic;
1061 msg->flags.flagged = hdr->flagged;
1062 msg->flags.replied = hdr->replied;
1063 msg->flags.read = hdr->read;
1064 msg->received = hdr->received;
1067 if (msg->received == 0)
1068 time (&msg->received);
1070 if (mxfmts[dest->magic-1]->mx_open_new_message(msg, dest, hdr) == 0) {
1071 if (dest->magic == M_MMDF)
1072 fputs (MMDF_SEP, msg->fp);
1074 if ((msg->magic == M_MBOX || msg->magic == M_MMDF) && flags & M_ADD_FROM) {
1076 if (hdr->env->return_path)
1077 p = hdr->env->return_path;
1078 else if (hdr->env->sender)
1079 p = hdr->env->sender;
1084 fprintf (msg->fp, "From %s %s", p ? p->mailbox : NONULL (Username),
1085 ctime (&msg->received));
1094 /* check for new mail */
1095 int mx_check_mailbox (CONTEXT * ctx, int *index_hint, int lock) {
1097 return mutt_check_mailbox_compressed (ctx);
1102 if (MX_IDX(ctx->magic-1) && mxfmts[ctx->magic-1]->mx_check_mailbox)
1103 return (mxfmts[ctx->magic-1]->mx_check_mailbox(ctx, index_hint, lock));
1109 /* return a stream pointer for a message */
1110 MESSAGE *mx_open_message (CONTEXT * ctx, int msgno)
1114 msg = p_new(MESSAGE, 1);
1115 switch (msg->magic = ctx->magic) {
1124 HEADER *cur = ctx->hdrs[msgno];
1125 char path[_POSIX_PATH_MAX];
1127 snprintf (path, sizeof (path), "%s/%s", ctx->path, cur->path);
1129 if ((msg->fp = fopen (path, "r")) == NULL && errno == ENOENT &&
1130 ctx->magic == M_MAILDIR)
1131 msg->fp = maildir_open_find_message (ctx->path, cur->path);
1133 if (msg->fp == NULL) {
1142 if (imap_fetch_message (msg, ctx, msgno) != 0)
1149 if (pop_fetch_message (msg, ctx, msgno) != 0)
1157 if (nntp_fetch_message (msg, ctx, msgno) != 0)
1161 #endif /* USE_NNTP */
1170 /* commit a message to a folder */
1172 int mx_commit_message (MESSAGE * msg, CONTEXT * ctx) {
1173 if (!(msg->write && ctx->append)) {
1176 if (!ctx || !MX_IDX(ctx->magic-1) || !mxfmts[ctx->magic-1]->mx_commit_message)
1178 return (mxfmts[ctx->magic-1]->mx_commit_message (msg, ctx));
1181 /* close a pointer to a message */
1182 int mx_close_message (MESSAGE ** msg)
1186 if ((*msg)->magic == M_MH || (*msg)->magic == M_MAILDIR
1187 || (*msg)->magic == M_IMAP
1188 || (*msg)->magic == M_POP
1190 || (*msg)->magic == M_NNTP
1193 r = m_fclose(&(*msg)->fp);
1199 unlink ((*msg)->path);
1200 p_delete(&(*msg)->path);
1207 void mx_alloc_memory (CONTEXT * ctx)
1210 size_t s = MAX (sizeof (HEADER *), sizeof (int));
1212 if ((ctx->hdrmax + 25) * s < ctx->hdrmax * s) {
1213 mutt_error _("Integer overflow -- can't allocate memory.");
1220 p_realloc(&ctx->hdrs, ctx->hdrmax += 25);
1221 p_realloc(&ctx->v2r, ctx->hdrmax);
1224 ctx->hdrs = p_new(HEADER *, (ctx->hdrmax += 25));
1225 ctx->v2r = p_new(int, ctx->hdrmax);
1227 for (i = ctx->msgcount; i < ctx->hdrmax; i++) {
1228 ctx->hdrs[i] = NULL;
1233 /* this routine is called to update the counts in the context structure for
1234 * the last message header parsed.
1236 void mx_update_context (CONTEXT * ctx, int new_messages)
1241 for (msgno = ctx->msgcount - new_messages; msgno < ctx->msgcount; msgno++) {
1242 h = ctx->hdrs[msgno];
1244 /* NOTE: this _must_ be done before the check for mailcap! */
1245 h->security = crypt_query (h->content);
1247 if (!ctx->pattern) {
1248 ctx->v2r[ctx->vcount] = msgno;
1249 h->virtual = ctx->vcount++;
1255 if (h->env->supersedes) {
1259 ctx->id_hash = mutt_make_id_hash (ctx);
1261 h2 = hash_find (ctx->id_hash, h->env->supersedes);
1263 /* p_delete(&h->env->supersedes); should I ? */
1266 if (!ctx->counting && option (OPTSCORE))
1267 mutt_score_message (ctx, h2, 1);
1271 /* add this message to the hash tables */
1272 if (ctx->id_hash && h->env->message_id)
1273 hash_insert (ctx->id_hash, h->env->message_id, h, 0);
1274 if (!ctx->counting) {
1275 if (ctx->subj_hash && h->env->real_subj)
1276 hash_insert (ctx->subj_hash, h->env->real_subj, h, 1);
1278 if (option (OPTSCORE))
1279 mutt_score_message (ctx, h, 0);
1294 /* update sidebar count */
1295 sidebar_set_buffystats (ctx);
1300 * 1 if the specified mailbox contains 0 messages.
1301 * 0 if the mailbox contains messages
1304 int mx_check_empty (const char *path)
1307 if ((i = mx_get_idx (path)) >= 0 && mxfmts[i]->mx_check_empty)
1308 return (mxfmts[i]->mx_check_empty(path));
1313 int mx_acl_check (CONTEXT* ctx, int flag) {
1314 if (!ctx || !MX_IDX(ctx->magic-1))
1316 /* if no acl_check defined for module, assume permission is granted */
1317 if (!mxfmts[ctx->magic-1]->mx_acl_check)
1319 return (mxfmts[ctx->magic-1]->mx_acl_check(ctx,flag));
1322 int mx_rebuild_cache (void) {
1324 mutt_error (_("Support for header caching was not build in."));
1327 int i = 0, magic = 0;
1328 CONTEXT* ctx = NULL;
1331 if (!Incoming.len) {
1332 mutt_error (_("No mailboxes defined."));
1336 for (i = 0; i < Incoming.len; i++) {
1337 b = Incoming.arr[i];
1338 magic = mx_get_magic (b->path);
1339 if (magic != M_MAILDIR && magic != M_MH && magic != M_IMAP)
1341 sidebar_set_current (b->path);
1343 if ((ctx = mx_open_mailbox (b->path,
1344 M_READONLY | M_NOSORT | M_COUNT,
1346 mx_close_mailbox (ctx, 0);
1348 mutt_clear_error ();
1350 if (Context && Context->path)
1351 sidebar_set_current (Context->path);
1358 void mutt_parse_mime_message (CONTEXT * ctx, HEADER * cur)
1364 if (cur->content->type != TYPEMESSAGE
1365 && cur->content->type != TYPEMULTIPART)
1366 break; /* nothing to do */
1368 if (cur->content->parts)
1369 break; /* The message was parsed earlier. */
1371 if ((msg = mx_open_message (ctx, cur->msgno))) {
1372 mutt_parse_part (msg->fp, cur->content);
1374 cur->security = crypt_query (cur->content);
1376 mx_close_message (&msg);
1379 mutt_count_body_parts (cur, flags | M_PARTS_RECOUNT);