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-lua/lib-lua.h>
16 #include <lib-sys/unix.h>
17 #include <lib-mime/mime.h>
18 #include <lib-ui/sidebar.h>
19 #include <lib-crypt/crypt.h>
34 #include <imap/imap.h>
38 #include <nntp/nntp.h>
41 static mx_t const *mxfmts[] = {
54 #define MX_IDX(idx) (idx >= 0 && idx < countof(mxfmts))
55 #define mutt_is_spool(s) (m_strcmp(Spoolfile, s) == 0)
59 * retry - should retry if unable to lock?
61 static int invoke_dotlock (const char *path, int flags, int retry)
63 char cmd[LONG_STRING + _POSIX_PATH_MAX];
64 char f[STRING + _POSIX_PATH_MAX];
68 if (flags & DL_FL_RETRY)
69 snprintf (r, sizeof (r), "-r %d ", retry ? MAXLOCKATTEMPT : 0);
71 mutt_quote_filename (f, sizeof (f), path);
73 pos = mlua_value(cmd, sizeof(cmd), "madmutt", "dotlock");
75 snprintf(cmd + pos, sizeof(cmd) - pos,
77 flags & DL_FL_TRY ? "-t " : "",
78 flags & DL_FL_UNLOCK ? "-u " : "",
79 flags & DL_FL_USEPRIV ? "-p " : "",
80 flags & DL_FL_FORCE ? "-f " : "",
81 flags & DL_FL_UNLINK ? "-d " : "",
82 flags & DL_FL_RETRY ? r : "", f);
84 return mutt_system (cmd);
87 static int dotlock_file (const char *path, int retry)
90 int flags = DL_FL_USEPRIV | DL_FL_RETRY;
96 if ((r = invoke_dotlock (path, flags, retry)) == DL_EX_EXIST) {
97 if (!option (OPTNOCURSES)) {
98 char msg[LONG_STRING];
100 snprintf (msg, sizeof (msg),
101 _("Lock count exceeded, remove lock for %s?"), path);
102 if (retry && mutt_yesorno (msg, M_YES) == M_YES) {
103 flags |= DL_FL_FORCE;
110 mutt_error (_("Can't dotlock %s.\n"), path);
113 return (r == DL_EX_OK ? 0 : -1);
116 static int undotlock_file (const char *path)
118 return (invoke_dotlock (path, DL_FL_USEPRIV | DL_FL_UNLOCK, 0) ==
122 /* looks up index of type for path in mxfmts */
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 < countof(mxfmts); i++) {
129 if (!mxfmts[i]->local)
130 t = mxfmts[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 < countof(mxfmts); i++) {
138 if (mxfmts[i]->local)
139 t = mxfmts[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 */
238 r = dotlock_file (path, time_out);
241 /* release any other locks obtained in this routine */
244 lck.l_type = F_UNLCK;
245 fcntl (fd, F_SETLK, &lck);
246 #endif /* USE_FCNTL */
250 #endif /* USE_FLOCK */
258 int mx_unlock_file (const char *path, int fd, int dot)
261 struct flock unlockit;
263 p_clear(&unlockit, 1);
264 unlockit.l_type = F_UNLCK;
265 unlockit.l_whence = SEEK_SET;
266 fcntl (fd, F_SETLK, &unlockit);
274 undotlock_file (path);
279 static void mx_unlink_empty (const char *path)
283 if ((fd = open (path, O_RDWR)) == -1)
286 if (mx_lock_file (path, fd, 1, 0, 1) == -1) {
291 invoke_dotlock(path, DL_FL_UNLINK, 1);
293 mx_unlock_file (path, fd, 0);
297 /* try to figure out what type of mailbox ``path'' is */
298 int mx_get_magic (const char *path) {
301 if (m_strlen(path) == 0)
303 if ((i = mx_get_idx (path)) >= 0)
304 return (mxfmts[i]->type);
308 int mx_is_local (int m) {
311 return (mxfmts[m]->local);
315 * set DefaultMagic to the given value
317 int mx_set_magic (const char *s)
319 if (ascii_strcasecmp (s, "mbox") == 0)
320 DefaultMagic = M_MBOX;
321 else if (ascii_strcasecmp (s, "mmdf") == 0)
322 DefaultMagic = M_MMDF;
323 else if (ascii_strcasecmp (s, "mh") == 0)
325 else if (ascii_strcasecmp (s, "maildir") == 0)
326 DefaultMagic = M_MAILDIR;
333 /* mx_access: Wrapper for access, checks permissions on a given mailbox.
334 * We may be interested in using ACL-style flags at some point, currently
335 * we use the normal access() flags. */
336 int mx_access (const char *path, int flags)
340 if ((i = mx_get_idx (path)) >= 0 && mxfmts[i]->mx_access)
341 return (mxfmts[i]->mx_access(path,flags));
345 static int mx_open_mailbox_append (CONTEXT * ctx, int flags)
349 /* special case for appending to compressed folders -
350 * even if we can not open them for reading */
351 if (mutt_can_append_compressed (ctx->path))
352 mutt_open_append_compressed (ctx);
356 if (mx_get_magic (ctx->path) == M_IMAP)
357 return imap_open_mailbox_append (ctx);
359 if (stat (ctx->path, &sb) == 0) {
360 ctx->magic = mx_get_magic (ctx->path);
362 switch (ctx->magic) {
364 mutt_error (_("%s is not a mailbox."), ctx->path);
370 else if (errno == ENOENT) {
371 ctx->magic = DefaultMagic;
373 if (ctx->magic == M_MH || ctx->magic == M_MAILDIR) {
374 char tmp[_POSIX_PATH_MAX];
376 if (mkdir (ctx->path, S_IRWXU)) {
377 mutt_perror (ctx->path);
381 if (ctx->magic == M_MAILDIR) {
382 snprintf (tmp, sizeof (tmp), "%s/cur", ctx->path);
383 if (mkdir (tmp, S_IRWXU)) {
389 snprintf (tmp, sizeof (tmp), "%s/new", ctx->path);
390 if (mkdir (tmp, S_IRWXU)) {
392 snprintf (tmp, sizeof (tmp), "%s/cur", ctx->path);
397 snprintf (tmp, sizeof (tmp), "%s/tmp", ctx->path);
398 if (mkdir (tmp, S_IRWXU)) {
400 snprintf (tmp, sizeof (tmp), "%s/cur", ctx->path);
402 snprintf (tmp, sizeof (tmp), "%s/new", ctx->path);
411 snprintf (tmp, sizeof (tmp), "%s/.mh_sequences", ctx->path);
412 if ((i = creat (tmp, S_IRWXU)) == -1) {
422 mutt_perror (ctx->path);
426 switch (ctx->magic) {
430 safe_fopen (ctx->path, flags & M_NEWFOLDER ? "w" : "a")) == NULL
431 || mbox_lock_mailbox (ctx, 1, 1) != 0) {
433 mutt_perror (ctx->path);
435 mutt_error (_("Couldn't lock %s\n"), ctx->path);
440 fseeko (ctx->fp, 0, 2);
456 * open a mailbox and parse it
459 * flags M_NOSORT do not sort mailbox
460 * M_APPEND open mailbox for appending
461 * M_READONLY open mailbox in read-only mode
462 * M_QUIET only print error messages
463 * ctx if non-null, context struct to use
465 CONTEXT *mx_open_mailbox (const char *path, int flags, CONTEXT * pctx)
471 ctx = p_new(CONTEXT, 1);
473 ctx->path = m_strdup(path);
475 ctx->msgnotreadyet = -1;
480 if (flags & M_READONLY)
485 if (flags & (M_APPEND | M_NEWFOLDER)) {
486 if (mx_open_mailbox_append (ctx, flags) != 0) {
487 mx_fastclose_mailbox (ctx);
495 if (!MX_IDX(ctx->magic-1))
496 ctx->magic = mx_get_magic (path);
498 if (ctx->magic == M_COMPRESSED)
499 mutt_open_read_compressed (ctx);
502 mutt_error (_("%s is not a mailbox."), path);
504 if (ctx->magic == -1)
507 if (ctx->magic <= 0) {
508 mx_fastclose_mailbox (ctx);
514 /* if the user has a `push' command in their .muttrc, or in a folder-hook,
515 * it will cause the progress messages not to be displayed because
516 * mutt_refresh() will think we are in the middle of a macro. so set a
517 * flag to indicate that we should really refresh the screen.
519 set_option (OPTFORCEREFRESH);
522 mutt_message (_("Reading %s..."), ctx->path);
524 rc = mxfmts[ctx->magic-1]->mx_open_mailbox(ctx);
527 if ((flags & M_NOSORT) == 0) {
528 /* avoid unnecessary work since the mailbox is completely unthreaded
530 unset_option (OPTSORTSUBTHREADS);
531 unset_option (OPTNEEDRESCORE);
532 mutt_sort_headers (ctx, 1);
538 mx_fastclose_mailbox (ctx);
543 unset_option (OPTFORCEREFRESH);
547 /* free up memory associated with the mailbox context */
548 void mx_fastclose_mailbox (CONTEXT * ctx)
555 if (MX_IDX(ctx->magic-1) && mxfmts[ctx->magic-1]->mx_fastclose_mailbox)
556 mxfmts[ctx->magic-1]->mx_fastclose_mailbox(ctx);
558 hash_destroy (&ctx->subj_hash, NULL);
560 hash_destroy (&ctx->id_hash, NULL);
561 mutt_clear_threads (ctx);
562 for (i = 0; i < ctx->msgcount; i++)
563 header_delete(&ctx->hdrs[i]);
564 p_delete(&ctx->hdrs);
568 mutt_fast_close_compressed (ctx);
570 p_delete(&ctx->path);
571 p_delete(&ctx->pattern);
572 pattern_list_wipe(&ctx->limit_pattern);
577 /* save changes to disk */
578 static int sync_mailbox (CONTEXT * ctx, int *index_hint)
583 mutt_message (_("Writing %s..."), ctx->path);
585 if (MX_IDX(ctx->magic-1))
586 /* the 1 is only of interest for IMAP and means EXPUNGE */
587 rc = mxfmts[ctx->magic-1]->mx_sync_mailbox(ctx,1,index_hint);
589 if (rc == 0 && ctx->cinfo)
590 return mutt_sync_compressed (ctx);
595 /* move deleted mails to the trash folder */
596 static int trash_append (CONTEXT * ctx)
602 if (!TrashPath || !ctx->deleted ||
603 (ctx->magic == M_MAILDIR && option (OPTMAILDIRTRASH)))
606 for (; i < ctx->msgcount && (!ctx->hdrs[i]->deleted ||
607 ctx->hdrs[i]->appended); i++);
608 if (i == ctx->msgcount)
609 return 0; /* nothing to be done */
611 if (mutt_save_confirm (TrashPath, &st) != 0) {
612 mutt_error _("message(s) not deleted");
617 if (lstat (ctx->path, &stc) == 0 && stc.st_ino == st.st_ino
618 && stc.st_dev == st.st_dev && stc.st_rdev == st.st_rdev)
619 return 0; /* we are in the trash folder: simple sync */
621 if ((ctx_trash = mx_open_mailbox (TrashPath, M_APPEND, NULL)) != NULL) {
622 for (i = 0; i < ctx->msgcount; i++)
623 if (ctx->hdrs[i]->deleted && !ctx->hdrs[i]->appended
624 && !ctx->hdrs[i]->purged
625 && mutt_append_message (ctx_trash, ctx, ctx->hdrs[i], 0, 0) == -1) {
626 mx_close_mailbox (ctx_trash, NULL);
630 mx_close_mailbox (ctx_trash, NULL);
633 mutt_error _("Can't open trash folder");
641 /* save changes and close mailbox */
642 static int _mx_close_mailbox (CONTEXT * ctx, int *index_hint)
644 int i, move_messages = 0, purge = 1, read_msgs = 0;
648 char mbox[_POSIX_PATH_MAX];
657 if (ctx->magic == M_NNTP) {
660 ret = nntp_close_mailbox (ctx);
661 mx_fastclose_mailbox (ctx);
665 if (ctx->readonly || ctx->dontwrite) {
666 /* mailbox is readonly or we don't want to write */
667 mx_fastclose_mailbox (ctx);
672 /* mailbox was opened in write-mode */
673 if (ctx->magic == M_MBOX || ctx->magic == M_MMDF)
674 mbox_close_mailbox (ctx);
676 mx_fastclose_mailbox (ctx);
680 for (i = 0; i < ctx->msgcount; i++) {
681 if (!ctx->hdrs[i]->deleted && ctx->hdrs[i]->read
682 && !(ctx->hdrs[i]->flagged && option (OPTKEEPFLAGGED)))
686 if (read_msgs && quadoption (OPT_MOVE) != M_NO) {
689 if ((p = mutt_find_hook (M_MBOXHOOK, ctx->path))) {
691 m_strcpy(mbox, sizeof(mbox), p);
694 m_strcpy(mbox, sizeof(mbox), NONULL(Inbox));
695 isSpool = mutt_is_spool (ctx->path) && !mutt_is_spool (mbox);
697 mutt_expand_path (mbox, sizeof (mbox));
700 snprintf (buf, sizeof (buf), _("Move read messages to %s?"), mbox);
701 if ((move_messages = query_quadoption (OPT_MOVE, buf)) == -1) {
709 * There is no point in asking whether or not to purge if we are
710 * just marking messages as "trash".
712 if (ctx->deleted && !(ctx->magic == M_MAILDIR && option (OPTMAILDIRTRASH))) {
713 snprintf (buf, sizeof (buf), ctx->deleted == 1
714 ? _("Purge %d deleted message?") :
715 _("Purge %d deleted messages?"), ctx->deleted);
716 if ((purge = query_quadoption (OPT_DELETE, buf)) < 0) {
722 /* IMAP servers manage the OLD flag themselves */
723 if (ctx->magic != M_IMAP)
724 if (option (OPTMARKOLD)) {
725 for (i = 0; i < ctx->msgcount; i++) {
726 if (!ctx->hdrs[i]->deleted && !ctx->hdrs[i]->old)
727 mutt_set_flag (ctx, ctx->hdrs[i], M_OLD, 1);
732 mutt_message (_("Moving read messages to %s..."), mbox);
734 /* try to use server-side copy first */
737 if (ctx->magic == M_IMAP && imap_is_magic (mbox, NULL) == M_IMAP) {
738 /* tag messages for moving, and clear old tags, if any */
739 for (i = 0; i < ctx->msgcount; i++)
740 if (ctx->hdrs[i]->read && !ctx->hdrs[i]->deleted
741 && !(ctx->hdrs[i]->flagged && option (OPTKEEPFLAGGED)))
742 ctx->hdrs[i]->tagged = 1;
744 ctx->hdrs[i]->tagged = 0;
746 i = imap_copy_messages (ctx, NULL, mbox, 1);
749 if (i == 0) /* success */
751 else if (i == -1) { /* horrible error, bail */
755 else /* use regular append-copy mode */
757 if (mx_open_mailbox (mbox, M_APPEND, &f) == NULL) {
762 for (i = 0; i < ctx->msgcount; i++) {
763 if (ctx->hdrs[i]->read && !ctx->hdrs[i]->deleted
764 && !(ctx->hdrs[i]->flagged && option (OPTKEEPFLAGGED))) {
765 if (mutt_append_message (&f, ctx, ctx->hdrs[i], 0, CH_UPDATE_LEN) ==
767 mutt_set_flag (ctx, ctx->hdrs[i], M_DELETE, 1);
768 mutt_set_flag (ctx, ctx->hdrs[i], M_APPENDED, 1);
771 mx_close_mailbox (&f, NULL);
778 mx_close_mailbox (&f, NULL);
782 else if (!ctx->changed && ctx->deleted == 0) {
783 mutt_message _("Mailbox is unchanged.");
785 mx_fastclose_mailbox (ctx);
789 /* copy mails to the trash before expunging */
790 if (purge && ctx->deleted)
791 if (trash_append (ctx) != 0) {
796 /* allow IMAP to preserve the deleted flag across sessions */
797 if (ctx->magic == M_IMAP) {
798 if ((check = imap_sync_mailbox (ctx, purge, index_hint)) != 0) {
806 for (i = 0; i < ctx->msgcount; i++)
807 ctx->hdrs[i]->deleted = 0;
811 if (ctx->changed || ctx->deleted) {
812 if ((check = sync_mailbox (ctx, index_hint)) != 0) {
820 mutt_message (_("%d kept, %d moved, %d deleted."),
821 ctx->msgcount - ctx->deleted, read_msgs, ctx->deleted);
823 mutt_message (_("%d kept, %d deleted."),
824 ctx->msgcount - ctx->deleted, ctx->deleted);
826 if (ctx->msgcount == ctx->deleted &&
827 (ctx->magic == M_MMDF || ctx->magic == M_MBOX) &&
828 !mutt_is_spool (ctx->path) && !option (OPTSAVEEMPTY))
829 mx_unlink_empty (ctx->path);
831 if (ctx->cinfo && mutt_slow_close_compressed (ctx))
834 mx_fastclose_mailbox (ctx);
839 int mx_close_mailbox (CONTEXT * ctx, int *index_hint) {
843 ret = _mx_close_mailbox (ctx, index_hint);
844 sidebar_set_buffystats (ctx);
848 /* update a Context structure's internal tables. */
850 void mx_update_tables (CONTEXT * ctx, int committing)
854 /* update memory to reflect the new state of the mailbox */
863 #define this_body ctx->hdrs[j]->content
864 for (i = 0, j = 0; i < ctx->msgcount; i++) {
865 if ((committing && (!ctx->hdrs[i]->deleted ||
866 (ctx->magic == M_MAILDIR
867 && option (OPTMAILDIRTRASH)))) || (!committing
871 ctx->hdrs[j] = ctx->hdrs[i];
874 ctx->hdrs[j]->msgno = j;
875 if (ctx->hdrs[j]->virtual != -1) {
876 ctx->v2r[ctx->vcount] = j;
877 ctx->hdrs[j]->virtual = ctx->vcount++;
878 ctx->vsize += this_body->length + this_body->offset -
879 this_body->hdr_offset;
883 ctx->hdrs[j]->changed = 0;
884 else if (ctx->hdrs[j]->changed)
888 || (ctx->magic == M_MAILDIR && option (OPTMAILDIRTRASH))) {
889 if (ctx->hdrs[j]->deleted)
893 if (ctx->hdrs[j]->tagged)
895 if (ctx->hdrs[j]->flagged)
897 if (!ctx->hdrs[j]->read) {
899 if (!ctx->hdrs[j]->old)
906 if (ctx->magic == M_MH || ctx->magic == M_MAILDIR)
907 ctx->size -= (ctx->hdrs[i]->content->length +
908 ctx->hdrs[i]->content->offset -
909 ctx->hdrs[i]->content->hdr_offset);
910 /* remove message from the hash tables */
911 if (ctx->subj_hash && ctx->hdrs[i]->env->real_subj)
912 hash_delete (ctx->subj_hash, ctx->hdrs[i]->env->real_subj,
914 if (ctx->id_hash && ctx->hdrs[i]->env->message_id)
915 hash_delete (ctx->id_hash, ctx->hdrs[i]->env->message_id,
917 header_delete(&ctx->hdrs[i]);
923 /* update sidebar count */
924 sidebar_set_buffystats (ctx);
928 /* save changes to mailbox
934 static int _mx_sync_mailbox (CONTEXT * ctx, int *index_hint)
938 int msgcount, deleted;
940 if (ctx->dontwrite) {
941 char buf[STRING], tmp[STRING];
943 if (km_expand_key (buf, sizeof (buf),
944 km_find_func (MENU_MAIN, OP_TOGGLE_WRITE)))
945 snprintf (tmp, sizeof (tmp), _(" Press '%s' to toggle write"), buf);
947 m_strcpy(tmp, sizeof(tmp), _("Use 'toggle-write' to re-enable write!"));
949 mutt_error (_("Mailbox is marked unwritable. %s"), tmp);
952 else if (ctx->readonly) {
953 mutt_error _("Mailbox is read-only.");
958 if (!ctx->changed && !ctx->deleted) {
959 mutt_message _("Mailbox is unchanged.");
967 snprintf (buf, sizeof (buf), ctx->deleted == 1
968 ? _("Purge %d deleted message?") :
969 _("Purge %d deleted messages?"), ctx->deleted);
970 if ((purge = query_quadoption (OPT_DELETE, buf)) < 0)
972 else if (purge == M_NO) {
974 return 0; /* nothing to do! */
975 /* let IMAP servers hold on to D flags */
976 if (ctx->magic != M_IMAP)
978 for (i = 0; i < ctx->msgcount; i++)
979 ctx->hdrs[i]->deleted = 0;
983 else if (ctx->last_tag && ctx->last_tag->deleted)
984 ctx->last_tag = NULL; /* reset last tagged msg now useless */
987 /* really only for IMAP - imap_sync_mailbox results in a call to
988 * mx_update_tables, so ctx->deleted is 0 when it comes back */
989 msgcount = ctx->msgcount;
990 deleted = ctx->deleted;
992 if (purge && ctx->deleted) {
993 if (trash_append (ctx) == -1)
997 if (ctx->magic == M_IMAP)
998 rc = imap_sync_mailbox (ctx, purge, index_hint);
1000 rc = sync_mailbox (ctx, index_hint);
1002 if (ctx->magic == M_IMAP && !purge)
1003 mutt_message (_("Mailbox checkpointed."));
1006 mutt_message (_("%d kept, %d deleted."), msgcount - deleted, deleted);
1010 if (ctx->msgcount == ctx->deleted &&
1011 (ctx->magic == M_MBOX || ctx->magic == M_MMDF) &&
1012 !mutt_is_spool (ctx->path) && !option (OPTSAVEEMPTY)) {
1014 mx_fastclose_mailbox (ctx);
1018 /* if we haven't deleted any messages, we don't need to resort */
1019 /* ... except for certain folder formats which need "unsorted"
1020 * sort order in order to synchronize folders.
1022 * MH and maildir are safe. mbox-style seems to need re-sorting,
1023 * at least with the new threading code.
1025 if (purge || (ctx->magic != M_MAILDIR && ctx->magic != M_MH)) {
1026 /* IMAP does this automatically after handling EXPUNGE */
1027 if (ctx->magic != M_IMAP)
1029 mx_update_tables (ctx, 1);
1030 mutt_sort_headers (ctx, 1); /* rethread from scratch */
1038 int mx_sync_mailbox (CONTEXT* ctx, int* index_hint) {
1039 int ret = _mx_sync_mailbox (ctx, index_hint);
1040 sidebar_set_buffystats (ctx);
1045 * dest destintation mailbox
1046 * hdr message being copied (required for maildir support, because
1047 * the filename depends on the message flags)
1049 MESSAGE *mx_open_new_message (CONTEXT * dest, HEADER * hdr, int flags)
1052 address_t *p = NULL;
1054 if (!MX_IDX(dest->magic-1)) {
1058 msg = p_new(MESSAGE, 1);
1059 msg->magic = dest->magic;
1063 msg->flags.flagged = hdr->flagged;
1064 msg->flags.replied = hdr->replied;
1065 msg->flags.read = hdr->read;
1066 msg->received = hdr->received;
1069 if (msg->received == 0)
1070 time (&msg->received);
1072 if (mxfmts[dest->magic-1]->mx_open_new_message(msg, dest, hdr) == 0) {
1073 if (dest->magic == M_MMDF)
1074 fputs (MMDF_SEP, msg->fp);
1076 if ((msg->magic == M_MBOX || msg->magic == M_MMDF) && flags & M_ADD_FROM) {
1078 if (hdr->env->return_path)
1079 p = hdr->env->return_path;
1080 else if (hdr->env->sender)
1081 p = hdr->env->sender;
1086 fprintf (msg->fp, "From %s %s", p ? p->mailbox : NONULL (Username),
1087 ctime (&msg->received));
1096 /* check for new mail */
1097 int mx_check_mailbox (CONTEXT * ctx, int *index_hint, int lock) {
1099 return mutt_check_mailbox_compressed (ctx);
1104 if (MX_IDX(ctx->magic-1) && mxfmts[ctx->magic-1]->mx_check_mailbox)
1105 return (mxfmts[ctx->magic-1]->mx_check_mailbox(ctx, index_hint, lock));
1111 /* return a stream pointer for a message */
1112 MESSAGE *mx_open_message (CONTEXT * ctx, int msgno)
1116 msg = p_new(MESSAGE, 1);
1117 switch (msg->magic = ctx->magic) {
1126 HEADER *cur = ctx->hdrs[msgno];
1127 char path[_POSIX_PATH_MAX];
1129 snprintf (path, sizeof (path), "%s/%s", ctx->path, cur->path);
1131 if ((msg->fp = fopen (path, "r")) == NULL && errno == ENOENT &&
1132 ctx->magic == M_MAILDIR)
1133 msg->fp = maildir_open_find_message (ctx->path, cur->path);
1135 if (msg->fp == NULL) {
1144 if (imap_fetch_message (msg, ctx, msgno) != 0)
1151 if (pop_fetch_message (msg, ctx, msgno) != 0)
1159 if (nntp_fetch_message (msg, ctx, msgno) != 0)
1163 #endif /* USE_NNTP */
1172 /* commit a message to a folder */
1174 int mx_commit_message (MESSAGE * msg, CONTEXT * ctx) {
1175 if (!(msg->write && ctx->append)) {
1178 if (!ctx || !MX_IDX(ctx->magic-1) || !mxfmts[ctx->magic-1]->mx_commit_message)
1180 return (mxfmts[ctx->magic-1]->mx_commit_message (msg, ctx));
1183 /* close a pointer to a message */
1184 int mx_close_message (MESSAGE ** msg)
1188 if ((*msg)->magic == M_MH || (*msg)->magic == M_MAILDIR
1189 || (*msg)->magic == M_IMAP
1190 || (*msg)->magic == M_POP
1192 || (*msg)->magic == M_NNTP
1195 r = m_fclose(&(*msg)->fp);
1201 unlink ((*msg)->path);
1202 p_delete(&(*msg)->path);
1209 void mx_alloc_memory (CONTEXT * ctx)
1212 size_t s = MAX (sizeof (HEADER *), sizeof (int));
1214 if ((ctx->hdrmax + 25) * s < ctx->hdrmax * s) {
1215 mutt_error _("Integer overflow -- can't allocate memory.");
1222 p_realloc(&ctx->hdrs, ctx->hdrmax += 25);
1223 p_realloc(&ctx->v2r, ctx->hdrmax);
1226 ctx->hdrs = p_new(HEADER *, (ctx->hdrmax += 25));
1227 ctx->v2r = p_new(int, ctx->hdrmax);
1229 for (i = ctx->msgcount; i < ctx->hdrmax; i++) {
1230 ctx->hdrs[i] = NULL;
1235 /* this routine is called to update the counts in the context structure for
1236 * the last message header parsed.
1238 void mx_update_context (CONTEXT * ctx, int new_messages)
1243 for (msgno = ctx->msgcount - new_messages; msgno < ctx->msgcount; msgno++) {
1244 h = ctx->hdrs[msgno];
1246 /* NOTE: this _must_ be done before the check for mailcap! */
1247 h->security = crypt_query (h->content);
1249 if (!ctx->pattern) {
1250 ctx->v2r[ctx->vcount] = msgno;
1251 h->virtual = ctx->vcount++;
1257 if (h->env->supersedes) {
1261 ctx->id_hash = mutt_make_id_hash (ctx);
1263 h2 = hash_find (ctx->id_hash, h->env->supersedes);
1265 /* p_delete(&h->env->supersedes); should I ? */
1268 if (!ctx->counting && option (OPTSCORE))
1269 mutt_score_message (ctx, h2, 1);
1273 /* add this message to the hash tables */
1274 if (ctx->id_hash && h->env->message_id)
1275 hash_insert (ctx->id_hash, h->env->message_id, h, 0);
1276 if (!ctx->counting) {
1277 if (ctx->subj_hash && h->env->real_subj)
1278 hash_insert (ctx->subj_hash, h->env->real_subj, h, 1);
1280 if (option (OPTSCORE))
1281 mutt_score_message (ctx, h, 0);
1296 /* update sidebar count */
1297 sidebar_set_buffystats (ctx);
1302 * 1 if the specified mailbox contains 0 messages.
1303 * 0 if the mailbox contains messages
1306 int mx_check_empty (const char *path)
1309 if ((i = mx_get_idx (path)) >= 0 && mxfmts[i]->mx_check_empty)
1310 return (mxfmts[i]->mx_check_empty(path));
1315 int mx_acl_check (CONTEXT* ctx, int flag) {
1316 if (!ctx || !MX_IDX(ctx->magic-1))
1318 /* if no acl_check defined for module, assume permission is granted */
1319 if (!mxfmts[ctx->magic-1]->mx_acl_check)
1321 return (mxfmts[ctx->magic-1]->mx_acl_check(ctx,flag));
1324 int mx_rebuild_cache (void) {
1326 mutt_error (_("Support for header caching was not build in."));
1329 int i = 0, magic = 0;
1330 CONTEXT* ctx = NULL;
1333 if (!Incoming.len) {
1334 mutt_error (_("No mailboxes defined."));
1338 for (i = 0; i < Incoming.len; i++) {
1339 b = Incoming.arr[i];
1340 magic = mx_get_magic (b->path);
1341 if (magic != M_MAILDIR && magic != M_MH && magic != M_IMAP)
1343 sidebar_set_current (b->path);
1345 if ((ctx = mx_open_mailbox (b->path,
1346 M_READONLY | M_NOSORT | M_COUNT,
1348 mx_close_mailbox (ctx, 0);
1350 mutt_clear_error ();
1352 if (Context && Context->path)
1353 sidebar_set_current (Context->path);
1360 void mutt_parse_mime_message (CONTEXT * ctx, HEADER * cur)
1366 if (cur->content->type != TYPEMESSAGE
1367 && cur->content->type != TYPEMULTIPART)
1368 break; /* nothing to do */
1370 if (cur->content->parts)
1371 break; /* The message was parsed earlier. */
1373 if ((msg = mx_open_message (ctx, cur->msgno))) {
1374 mutt_parse_part (msg->fp, cur->content);
1376 cur->security = crypt_query (cur->content);
1378 mx_close_message (&msg);
1381 mutt_count_body_parts (cur, flags | M_PARTS_RECOUNT);