2 * Copyright notice from original mutt:
3 * Copyright (C) 1996-2002 Michael R. Elkins <me@mutt.org>
4 * Copyright (C) 1999-2002 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.
12 * This file contains routines specific to MH and ``maildir'' style
20 #include <lib-lib/mem.h>
21 #include <lib-lib/macros.h>
34 #include "lib/debug.h"
37 #include <sys/types.h>
57 unsigned header_parsed:1;
60 #endif /* USE_INODESORT */
69 /* mh_sequences support */
71 #define MH_SEQ_UNSEEN (1 << 0)
72 #define MH_SEQ_REPLIED (1 << 1)
73 #define MH_SEQ_FLAGGED (1 << 2)
76 static int maildir_check_empty (const char*);
77 static int maildir_check_mailbox (CONTEXT*, int*, int);
78 static int mh_check_mailbox (CONTEXT*, int*, int);
80 static void mhs_alloc (struct mh_sequences *mhs, int i)
85 if (i > mhs->max || !mhs->flags) {
87 p_realloc(&mhs->flags, newmax + 1);
88 for (j = mhs->max + 1; j <= newmax; j++)
95 static void mhs_free_sequences (struct mh_sequences *mhs)
97 p_delete(&mhs->flags);
100 static short mhs_check (struct mh_sequences *mhs, int i)
102 if (!mhs->flags || i > mhs->max)
105 return mhs->flags[i];
108 static short mhs_set (struct mh_sequences *mhs, int i, short f)
112 return mhs->flags[i];
119 static short mhs_unset (struct mh_sequences *mhs, int i, short f)
123 return mhs->flags[i];
128 static void mh_read_token (char *t, int *first, int *last)
132 if ((p = strchr (t, '-'))) {
138 *first = *last = atoi (t);
141 static void mh_read_sequences (struct mh_sequences *mhs, const char *path)
152 char pathname[_POSIX_PATH_MAX];
154 snprintf (pathname, sizeof (pathname), "%s/.mh_sequences", path);
156 if (!(fp = fopen (pathname, "r")))
159 while ((buff = mutt_read_line (buff, &sz, fp, &line))) {
160 if (!(t = strtok (buff, " \t:")))
163 if (!str_cmp (t, MhUnseen))
165 else if (!str_cmp (t, MhFlagged))
167 else if (!str_cmp (t, MhReplied))
169 else /* unknown sequence */
172 while ((t = strtok (NULL, " \t:"))) {
173 mh_read_token (t, &first, &last);
174 for (; first <= last; first++)
175 mhs_set (mhs, first, f);
183 int mh_buffy (const char *path)
186 struct mh_sequences mhs;
188 memset (&mhs, 0, sizeof (mhs));
190 mh_read_sequences (&mhs, path);
191 for (i = 0; !r && i <= mhs.max; i++)
192 if (mhs_check (&mhs, i) & MH_SEQ_UNSEEN)
194 mhs_free_sequences (&mhs);
198 static int mh_mkstemp (CONTEXT * dest, FILE ** fp, char **tgt)
201 char path[_POSIX_PATH_MAX];
204 snprintf (path, _POSIX_PATH_MAX, "%s/.mutt-%s-%d-%d",
205 dest->path, NONULL (Hostname), (int) getpid (), Counter++);
207 if ((fd = open (path, O_WRONLY | O_EXCL | O_CREAT, 0666)) == -1) {
208 if (errno != EEXIST) {
214 *tgt = str_dup (path);
219 if ((*fp = fdopen (fd, "w")) == NULL) {
229 static void mhs_write_one_sequence (FILE * fp, struct mh_sequences *mhs,
230 short f, const char *tag)
235 fprintf (fp, "%s:", tag);
240 for (i = 0; i <= mhs->max; i++) {
241 if ((mhs_check (mhs, i) & f)) {
247 else if (first >= 0) {
249 fprintf (fp, " %d", first);
251 fprintf (fp, " %d-%d", first, last);
260 fprintf (fp, " %d", first);
262 fprintf (fp, " %d-%d", first, last);
268 /* XXX - we don't currently remove deleted messages from sequences we don't know. Should we? */
270 void mh_update_sequences (CONTEXT * ctx)
274 char sequences[_POSIX_PATH_MAX];
286 char seq_unseen[STRING];
287 char seq_replied[STRING];
288 char seq_flagged[STRING];
291 struct mh_sequences mhs;
293 memset (&mhs, 0, sizeof (mhs));
295 snprintf (seq_unseen, sizeof (seq_unseen), "%s:", NONULL (MhUnseen));
296 snprintf (seq_replied, sizeof (seq_replied), "%s:", NONULL (MhReplied));
297 snprintf (seq_flagged, sizeof (seq_flagged), "%s:", NONULL (MhFlagged));
299 if (mh_mkstemp (ctx, &nfp, &tmpfname) != 0) {
304 snprintf (sequences, sizeof (sequences), "%s/.mh_sequences", ctx->path);
307 /* first, copy unknown sequences */
308 if ((ofp = fopen (sequences, "r"))) {
309 while ((buff = mutt_read_line (buff, &s, ofp, &l))) {
310 if (!str_ncmp (buff, seq_unseen, str_len (seq_unseen)))
312 if (!str_ncmp (buff, seq_flagged, str_len (seq_flagged)))
314 if (!str_ncmp (buff, seq_replied, str_len (seq_replied)))
317 fprintf (nfp, "%s\n", buff);
322 /* now, update our unseen, flagged, and replied sequences */
323 for (l = 0; l < ctx->msgcount; l++) {
324 if (ctx->hdrs[l]->deleted)
327 if ((p = strrchr (ctx->hdrs[l]->path, '/')))
330 p = ctx->hdrs[l]->path;
334 if (!ctx->hdrs[l]->read) {
335 mhs_set (&mhs, i, MH_SEQ_UNSEEN);
338 if (ctx->hdrs[l]->flagged) {
339 mhs_set (&mhs, i, MH_SEQ_FLAGGED);
342 if (ctx->hdrs[l]->replied) {
343 mhs_set (&mhs, i, MH_SEQ_REPLIED);
348 /* write out the new sequences */
350 mhs_write_one_sequence (nfp, &mhs, MH_SEQ_UNSEEN, NONULL (MhUnseen));
352 mhs_write_one_sequence (nfp, &mhs, MH_SEQ_FLAGGED, NONULL (MhFlagged));
354 mhs_write_one_sequence (nfp, &mhs, MH_SEQ_REPLIED, NONULL (MhReplied));
356 mhs_free_sequences (&mhs);
359 /* try to commit the changes - no guarantee here */
363 if (safe_rename (tmpfname, sequences) != 0) {
364 /* report an error? */
371 static void mh_sequences_add_one (CONTEXT * ctx, int n, short unseen,
372 short flagged, short replied)
374 short unseen_done = 0;
375 short flagged_done = 0;
376 short replied_done = 0;
378 FILE *ofp = NULL, *nfp = NULL;
381 char sequences[_POSIX_PATH_MAX];
383 char seq_unseen[STRING];
384 char seq_replied[STRING];
385 char seq_flagged[STRING];
391 if (mh_mkstemp (ctx, &nfp, &tmpfname) == -1)
394 snprintf (seq_unseen, sizeof (seq_unseen), "%s:", NONULL (MhUnseen));
395 snprintf (seq_replied, sizeof (seq_replied), "%s:", NONULL (MhReplied));
396 snprintf (seq_flagged, sizeof (seq_flagged), "%s:", NONULL (MhFlagged));
398 snprintf (sequences, sizeof (sequences), "%s/.mh_sequences", ctx->path);
399 if ((ofp = fopen (sequences, "r"))) {
400 while ((buff = mutt_read_line (buff, &sz, ofp, &line))) {
401 if (unseen && !strncmp (buff, seq_unseen, str_len (seq_unseen))) {
402 fprintf (nfp, "%s %d\n", buff, n);
406 && !strncmp (buff, seq_flagged, str_len (seq_flagged))) {
407 fprintf (nfp, "%s %d\n", buff, n);
411 && !strncmp (buff, seq_replied, str_len (seq_replied))) {
412 fprintf (nfp, "%s %d\n", buff, n);
416 fprintf (nfp, "%s\n", buff);
422 if (!unseen_done && unseen)
423 fprintf (nfp, "%s: %d\n", NONULL (MhUnseen), n);
424 if (!flagged_done && flagged)
425 fprintf (nfp, "%s: %d\n", NONULL (MhFlagged), n);
426 if (!replied_done && replied)
427 fprintf (nfp, "%s: %d\n", NONULL (MhReplied), n);
432 if (safe_rename (tmpfname, sequences) != 0)
438 static void mh_update_maildir (struct maildir *md, struct mh_sequences *mhs)
444 for (; md; md = md->next) {
445 if ((p = strrchr (md->h->path, '/')))
451 f = mhs_check (mhs, i);
453 md->h->read = (f & MH_SEQ_UNSEEN) ? 0 : 1;
454 md->h->flagged = (f & MH_SEQ_FLAGGED) ? 1 : 0;
455 md->h->replied = (f & MH_SEQ_REPLIED) ? 1 : 0;
459 /* maildir support */
461 static void maildir_free_entry (struct maildir **md)
466 p_delete(&(*md)->canon_fname);
468 mutt_free_header (&(*md)->h);
473 static void maildir_free_maildir (struct maildir **md)
475 struct maildir *p, *q;
480 for (p = *md; p; p = q) {
482 maildir_free_entry (&p);
486 static void maildir_parse_flags (HEADER * h, const char *path)
494 if ((p = strrchr (path, ':')) != NULL && str_ncmp (p + 1, "2,", 2) == 0) {
497 str_replace (&h->maildir_flags, p);
498 q = h->maildir_flags;
512 case 'R': /* replied */
517 case 'T': /* trashed */
530 if (q == h->maildir_flags)
531 p_delete(&h->maildir_flags);
536 static void maildir_update_mtime (CONTEXT * ctx)
538 char buf[_POSIX_PATH_MAX];
541 if (ctx->magic == M_MAILDIR) {
542 snprintf (buf, sizeof (buf), "%s/%s", ctx->path, "cur");
543 if (stat (buf, &st) == 0)
544 ctx->mtime_cur = st.st_mtime;
545 snprintf (buf, sizeof (buf), "%s/%s", ctx->path, "new");
548 snprintf (buf, sizeof (buf), "%s/.mh_sequences", ctx->path);
549 if (stat (buf, &st) == 0)
550 ctx->mtime_cur = st.st_mtime;
552 strfcpy (buf, ctx->path, sizeof (buf));
555 if (stat (buf, &st) == 0)
556 ctx->mtime = st.st_mtime;
560 * Actually parse a maildir message. This may also be used to fill
561 * out a fake header structure generated by lazy maildir parsing.
563 static HEADER *maildir_parse_message (int magic, const char *fname,
564 int is_old, HEADER * _h)
570 if ((f = fopen (fname, "r")) != NULL) {
572 h = mutt_new_header ();
573 h->env = mutt_read_rfc822_header (f, h, 0, 0);
575 fstat (fileno (f), &st);
579 h->received = h->date_sent;
581 if (h->content->length <= 0)
582 h->content->length = st.st_size - h->content->offset;
586 if (magic == M_MAILDIR) {
588 * maildir stores its flags in the filename, so ignore the
589 * flags in the header of the message
593 maildir_parse_flags (h, fname);
601 * Note that this routine will _not_ modify the context given by
604 * It's used in the first parsing pass on maildir and MH folders.
605 * In the MH case, this means full parsing of the folder. In the
606 * maildir case, it means that we only look at flags, and create a
607 * fake HEADER structure, which may later be filled in by
608 * maildir_parse_message(), when called from
609 * maildir_delayed_parsing().
613 static int maildir_parse_entry (CONTEXT * ctx, struct maildir ***last,
614 const char *subdir, const char *fname,
615 int *count, int is_old, ino_t inode)
617 struct maildir *entry;
619 char buf[_POSIX_PATH_MAX];
622 snprintf (buf, sizeof (buf), "%s/%s/%s", ctx->path, subdir, fname);
624 snprintf (buf, sizeof (buf), "%s/%s", ctx->path, fname);
626 if (ctx->magic == M_MH)
627 h = maildir_parse_message (ctx->magic, buf, is_old, NULL);
629 h = mutt_new_header ();
631 maildir_parse_flags (h, buf);
637 if (!ctx->quiet && ReadInc && ((*count % ReadInc) == 0 || *count == 1))
638 mutt_message (_("Reading %s... %d"), ctx->path, *count);
642 snprintf (buf, sizeof (buf), "%s/%s", subdir, fname);
643 h->path = str_dup (buf);
646 h->path = str_dup (fname);
648 entry = p_new(struct maildir, 1);
650 entry->header_parsed = (ctx->magic == M_MH);
652 entry->inode = inode;
653 #endif /* USE_INODESORT */
655 *last = &entry->next;
665 /* Ignore the garbage files. A valid MH message consists of only
666 * digits. Deleted message get moved to a filename with a comma before
670 int mh_valid_message (const char *s)
673 if (!isdigit ((unsigned char) *s))
679 static int maildir_parse_dir (CONTEXT * ctx, struct maildir ***last,
680 const char *subdir, int *count)
684 char buf[_POSIX_PATH_MAX];
688 snprintf (buf, sizeof (buf), "%s/%s", ctx->path, subdir);
689 is_old = (str_cmp ("cur", subdir) == 0);
692 strfcpy (buf, ctx->path, sizeof (buf));
694 if ((dirp = opendir (buf)) == NULL)
697 while ((de = readdir (dirp)) != NULL) {
699 if ((ctx->magic == M_MH && !mh_valid_message (de->d_name))
700 || (ctx->magic == M_MAILDIR && *de->d_name == '.'))
703 /* FOO - really ignore the return value? */
705 debug_print (2, ("parsing %s\n", de->d_name));
706 maildir_parse_entry (ctx, last, subdir, de->d_name, count, is_old,
707 #if HAVE_DIRENT_D_INO
719 static int maildir_add_to_context (CONTEXT * ctx, struct maildir *md)
721 int oldmsgcount = ctx->msgcount;
725 debug_print (2, ("considering %s\n", NONULL (md->canon_fname)));
728 debug_print (2, ("flags: %s%s%s%s%s\n", md->h->flagged ? "f" : "",
729 md->h->deleted ? "D" : "", md->h->replied ? "r" : "",
730 md->h->old ? "O" : "", md->h->read ? "R" : ""));
731 if (ctx->msgcount == ctx->hdrmax)
732 mx_alloc_memory (ctx);
734 ctx->hdrs[ctx->msgcount] = md->h;
735 ctx->hdrs[ctx->msgcount]->index = ctx->msgcount;
737 md->h->content->length + md->h->content->offset -
738 md->h->content->hdr_offset;
746 if (ctx->msgcount > oldmsgcount) {
747 mx_update_context (ctx, ctx->msgcount - oldmsgcount);
753 static int maildir_move_to_context (CONTEXT * ctx, struct maildir **md)
757 r = maildir_add_to_context (ctx, *md);
758 maildir_free_maildir (md);
764 * Merge two maildir lists according to the inode numbers.
766 static struct maildir *maildir_merge_inode (struct maildir *left,
767 struct maildir *right)
769 struct maildir *head;
770 struct maildir *tail;
773 if (left->inode < right->inode) {
791 while (left && right) {
792 if (left->inode < right->inode) {
814 * Sort maildir list according to inode.
816 static struct maildir *maildir_sort_inode (struct maildir *list)
818 struct maildir *left = list;
819 struct maildir *right = list;
821 if (!list || !list->next) {
826 while (list && list->next) {
828 list = list->next->next;
835 left = maildir_sort_inode (left);
836 right = maildir_sort_inode (right);
837 return maildir_merge_inode (left, right);
839 #endif /* USE_INODESORT */
842 static size_t maildir_hcache_keylen (const char *fn)
844 const char *p = strchr (fn, ':');
846 return p ? (size_t) (p - fn) : str_len (fn);
851 * This function does the second parsing pass for a maildir-style
854 void maildir_delayed_parsing (CONTEXT * ctx, struct maildir *md)
857 char fn[_POSIX_PATH_MAX];
863 struct timeval *when = NULL;
864 struct stat lastchanged;
867 hc = mutt_hcache_open (HeaderCache, ctx->path);
870 for (p = md, count = 0; p; p = p->next, count++) {
871 if (!(p && p->h && !p->header_parsed))
875 data = mutt_hcache_fetch (hc, p->h->path + 3, &maildir_hcache_keylen);
876 when = (struct timeval *) data;
879 if (!ctx->quiet && ReadInc && ((count % ReadInc) == 0 || count == 1))
880 mutt_message (_("Reading %s... %d"), ctx->path, count);
881 snprintf (fn, sizeof (fn), "%s/%s", ctx->path, p->h->path);
884 if (option (OPTHCACHEVERIFY)) {
885 ret = stat (fn, &lastchanged);
888 lastchanged.st_mtime = 0;
892 if (data != NULL && !ret && lastchanged.st_mtime <= when->tv_sec) {
893 p->h = mutt_hcache_restore ((unsigned char *) data, &p->h);
894 maildir_parse_flags (p->h, fn);
898 if (maildir_parse_message (ctx->magic, fn, p->h->old, p->h)) {
899 p->header_parsed = 1;
900 maildir_parse_flags (p->h, fn);
902 mutt_hcache_store (hc, p->h->path + 3, p->h, 0, &maildir_hcache_keylen);
906 mutt_free_header (&p->h);
912 mutt_hcache_close (hc);
916 /* Read a MH/maildir style mailbox.
919 * ctx [IN/OUT] context for this mailbox
920 * subdir [IN] NULL for MH mailboxes, otherwise the subdir of the
921 * maildir mailbox to read from
923 static int _mh_read_dir (CONTEXT * ctx, const char *subdir)
926 struct mh_sequences mhs;
927 struct maildir **last;
931 memset (&mhs, 0, sizeof (mhs));
933 maildir_update_mtime (ctx);
938 if (maildir_parse_dir (ctx, &last, subdir, &count) == -1)
941 if (ctx->magic == M_MH) {
942 mh_read_sequences (&mhs, ctx->path);
943 mh_update_maildir (md, &mhs);
944 mhs_free_sequences (&mhs);
948 md = maildir_sort_inode (md);
949 #endif /* USE_INODESORT */
951 if (ctx->magic == M_MAILDIR)
952 maildir_delayed_parsing (ctx, md);
954 maildir_move_to_context (ctx, &md);
958 static int mh_read_dir (CONTEXT* ctx) {
959 return (_mh_read_dir (ctx, NULL));
962 /* read a maildir style mailbox */
963 static int maildir_read_dir (CONTEXT * ctx)
965 /* maildir looks sort of like MH, except that there are two subdirectories
966 * of the main folder path from which to read messages
968 if (_mh_read_dir (ctx, "new") == -1 || _mh_read_dir (ctx, "cur") == -1)
975 * Open a new (temporary) message in an MH folder.
978 static int mh_open_new_message (MESSAGE * msg, CONTEXT * dest, HEADER * hdr)
980 return mh_mkstemp (dest, &msg->fp, &msg->path);
983 int ch_compar (const void *a, const void *b)
985 return (int) (*((const char *) a) - *((const char *) b));
988 static void maildir_flags (char *dest, size_t destlen, HEADER * hdr)
993 * The maildir specification requires that all files in the cur
994 * subdirectory have the :unique string appeneded, regardless of whether
995 * or not there are any flags. If .old is set, we know that this message
996 * will end up in the cur directory, so we include it in the following
997 * test even though there is no associated flag.
1001 && (hdr->flagged || hdr->replied || hdr->read || hdr->deleted
1002 || hdr->old || hdr->maildir_flags)) {
1003 char tmp[LONG_STRING];
1005 snprintf (tmp, sizeof (tmp),
1007 hdr->flagged ? "F" : "",
1008 hdr->replied ? "R" : "",
1009 hdr->read ? "S" : "", hdr->deleted ? "T" : "",
1010 NONULL (hdr->maildir_flags));
1011 if (hdr->maildir_flags)
1012 qsort (tmp, str_len (tmp), 1, ch_compar);
1013 snprintf (dest, destlen, ":2,%s", tmp);
1019 * Open a new (temporary) message in a maildir folder.
1021 * Note that this uses _almost_ the maildir file name format, but
1022 * with a {cur,new} prefix.
1026 static int maildir_open_new_message (MESSAGE * msg, CONTEXT * dest, HEADER * hdr)
1029 char path[_POSIX_PATH_MAX];
1034 short deleted = hdr->deleted;
1038 maildir_flags (suffix, sizeof (suffix), hdr);
1040 hdr->deleted = deleted;
1045 if (hdr && (hdr->read || hdr->old))
1046 strfcpy (subdir, "cur", sizeof (subdir));
1048 strfcpy (subdir, "new", sizeof (subdir));
1051 snprintf (path, _POSIX_PATH_MAX, "%s/tmp/%s.%ld.%u_%d.%s%s",
1052 dest->path, subdir, (long) time (NULL),
1053 (unsigned int) getpid (), Counter++, NONULL (Hostname), suffix);
1055 debug_print (2, ("trying %s.\n", path));
1058 if ((fd = open (path, O_WRONLY | O_EXCL | O_CREAT, 0666)) == -1) {
1059 if (errno != EEXIST) {
1065 debug_print (2, ("success.\n"));
1066 msg->path = str_dup (path);
1071 if ((msg->fp = fdopen (fd, "w")) == NULL) {
1072 p_delete(&msg->path);
1084 * Commit a message to a maildir folder.
1086 * msg->path contains the file name of a file in tmp/. We take the
1087 * flags from this file's name.
1089 * ctx is the mail folder we commit to.
1091 * hdr is a header structure to which we write the message's new
1092 * file name. This is used in the mh and maildir folder synch
1093 * routines. When this routine is invoked from mx_commit_message,
1096 * msg->path looks like this:
1098 * tmp/{cur,new}.mutt-HOSTNAME-PID-COUNTER:flags
1100 * See also maildir_open_new_message().
1104 static int maildir_commit_message (MESSAGE * msg, CONTEXT * ctx, HEADER * hdr)
1108 char path[_POSIX_PATH_MAX];
1109 char full[_POSIX_PATH_MAX];
1112 if (safe_fclose (&msg->fp) != 0)
1115 /* extract the subdir */
1116 s = strrchr (msg->path, '/') + 1;
1117 strfcpy (subdir, s, 4);
1119 /* extract the flags */
1120 if ((s = strchr (s, ':')))
1121 strfcpy (suffix, s, sizeof (suffix));
1125 /* construct a new file name. */
1127 snprintf (path, _POSIX_PATH_MAX, "%s/%ld.%u_%d.%s%s", subdir,
1128 (long) time (NULL), (unsigned int) getpid (), Counter++,
1129 NONULL (Hostname), suffix);
1130 snprintf (full, _POSIX_PATH_MAX, "%s/%s", ctx->path, path);
1132 debug_print (2, ("renaming %s to %s.\n", msg->path, full));
1134 if (safe_rename (msg->path, full) == 0) {
1136 str_replace (&hdr->path, path);
1137 p_delete(&msg->path);
1140 * Adjust the mtime on the file to match the time at which this
1141 * message was received. Currently this is only set when copying
1142 * messages between mailboxes, so we test to ensure that it is
1145 if (msg->received) {
1148 ut.actime = msg->received;
1149 ut.modtime = msg->received;
1150 if (utime (full, &ut)) {
1152 ("maildir_commit_message(): unable to set time on file"));
1159 else if (errno != EEXIST) {
1160 mutt_perror (ctx->path);
1167 * commit a message to an MH folder.
1172 static int _mh_commit_message (MESSAGE * msg, CONTEXT * ctx, HEADER * hdr,
1178 unsigned int n, hi = 0;
1179 char path[_POSIX_PATH_MAX];
1182 if (safe_fclose (&msg->fp) != 0)
1185 if ((dirp = opendir (ctx->path)) == NULL) {
1186 mutt_perror (ctx->path);
1190 /* figure out what the next message number is */
1191 while ((de = readdir (dirp)) != NULL) {
1197 if (!isdigit ((unsigned char) *cp))
1210 * Now try to rename the file to the proper name.
1212 * Note: We may have to try multiple times, until we find a free
1218 snprintf (tmp, sizeof (tmp), "%d", hi);
1219 snprintf (path, sizeof (path), "%s/%s", ctx->path, tmp);
1220 if (safe_rename (msg->path, path) == 0) {
1222 str_replace (&hdr->path, tmp);
1223 p_delete(&msg->path);
1226 else if (errno != EEXIST) {
1227 mutt_perror (ctx->path);
1232 mh_sequences_add_one (ctx, hi, !msg->flags.read, msg->flags.flagged,
1233 msg->flags.replied);
1237 static int mh_commit_message (MESSAGE * msg, CONTEXT * ctx, HEADER * hdr) {
1238 return _mh_commit_message (msg, ctx, hdr, 1);
1241 /* Sync a message in an MH folder.
1243 * This code is also used for attachment deletion in maildir
1247 static int mh_rewrite_message (CONTEXT * ctx, int msgno)
1249 HEADER *h = ctx->hdrs[msgno];
1254 char oldpath[_POSIX_PATH_MAX];
1255 char newpath[_POSIX_PATH_MAX];
1256 char partpath[_POSIX_PATH_MAX];
1258 long old_body_offset = h->content->offset;
1259 long old_body_length = h->content->length;
1260 long old_hdr_lines = h->lines;
1262 if ((dest = mx_open_new_message (ctx, h, 0)) == NULL)
1265 if ((rc = mutt_copy_message (dest->fp, ctx, h,
1266 M_CM_UPDATE, CH_UPDATE | CH_UPDATE_LEN)) == 0)
1268 snprintf (oldpath, _POSIX_PATH_MAX, "%s/%s", ctx->path, h->path);
1269 strfcpy (partpath, h->path, _POSIX_PATH_MAX);
1271 if (ctx->magic == M_MAILDIR)
1272 rc = maildir_commit_message (dest, ctx, h);
1274 rc = _mh_commit_message (dest, ctx, h, 0);
1276 mx_close_message (&dest);
1284 * Try to move the new message to the old place.
1287 * This is important when we are just updating flags.
1289 * Note that there is a race condition against programs which
1290 * use the first free slot instead of the maximum message
1291 * number. Mutt does _not_ behave like this.
1293 * Anyway, if this fails, the message is in the folder, so
1294 * all what happens is that a concurrently runnung mutt will
1295 * lose flag modifications.
1298 if (ctx->magic == M_MH && rc == 0) {
1299 snprintf (newpath, _POSIX_PATH_MAX, "%s/%s", ctx->path, h->path);
1300 if ((rc = safe_rename (newpath, oldpath)) == 0)
1301 str_replace (&h->path, partpath);
1305 mx_close_message (&dest);
1307 if (rc == -1 && restore) {
1308 h->content->offset = old_body_offset;
1309 h->content->length = old_body_length;
1310 h->lines = old_hdr_lines;
1313 mutt_free_body (&h->content->parts);
1317 static int mh_sync_message (CONTEXT * ctx, int msgno)
1319 HEADER *h = ctx->hdrs[msgno];
1321 if (h->attach_del ||
1322 (h->env && (h->env->refs_changed || h->env->irt_changed)))
1323 if (mh_rewrite_message (ctx, msgno) != 0)
1329 static int maildir_sync_message (CONTEXT * ctx, int msgno)
1331 HEADER *h = ctx->hdrs[msgno];
1333 if (h->attach_del ||
1334 (h->env && (h->env->refs_changed || h->env->irt_changed))) {
1335 /* when doing attachment deletion/rethreading, fall back to the MH case. */
1336 if (mh_rewrite_message (ctx, msgno) != 0)
1340 /* we just have to rename the file. */
1342 char newpath[_POSIX_PATH_MAX];
1343 char partpath[_POSIX_PATH_MAX];
1344 char fullpath[_POSIX_PATH_MAX];
1345 char oldpath[_POSIX_PATH_MAX];
1349 if ((p = strrchr (h->path, '/')) == NULL) {
1350 debug_print (1, ("%s: unable to find subdir!\n", h->path));
1354 strfcpy (newpath, p, sizeof (newpath));
1356 /* kill the previous flags */
1357 if ((p = strchr (newpath, ':')) != NULL)
1360 maildir_flags (suffix, sizeof (suffix), h);
1362 snprintf (partpath, sizeof (partpath), "%s/%s%s",
1363 (h->read || h->old) ? "cur" : "new", newpath, suffix);
1364 snprintf (fullpath, sizeof (fullpath), "%s/%s", ctx->path, partpath);
1365 snprintf (oldpath, sizeof (oldpath), "%s/%s", ctx->path, h->path);
1367 if (str_cmp (fullpath, oldpath) == 0) {
1368 /* message hasn't really changed */
1372 /* record that the message is possibly marked as trashed on disk */
1373 h->trash = h->deleted;
1375 if (rename (oldpath, fullpath) != 0) {
1376 mutt_perror ("rename");
1379 str_replace (&h->path, partpath);
1384 static int mh_sync_mailbox (CONTEXT * ctx, int unused, int *index_hint)
1386 char path[_POSIX_PATH_MAX], tmp[_POSIX_PATH_MAX];
1391 #endif /* USE_HCACHE */
1393 if (ctx->magic == M_MH)
1394 i = mh_check_mailbox (ctx, index_hint, 0);
1396 i = maildir_check_mailbox (ctx, index_hint, 0);
1402 if (ctx->magic == M_MAILDIR)
1403 hc = mutt_hcache_open (HeaderCache, ctx->path);
1404 #endif /* USE_HCACHE */
1406 for (i = 0; i < ctx->msgcount; i++) {
1407 if (ctx->hdrs[i]->deleted
1408 && (ctx->magic != M_MAILDIR || !option (OPTMAILDIRTRASH))) {
1409 snprintf (path, sizeof (path), "%s/%s", ctx->path, ctx->hdrs[i]->path);
1410 if (ctx->magic == M_MAILDIR
1411 || (option (OPTMHPURGE) && ctx->magic == M_MH)) {
1413 if (ctx->magic == M_MAILDIR)
1414 mutt_hcache_delete (hc, ctx->hdrs[i]->path + 3,
1415 &maildir_hcache_keylen);
1416 #endif /* USE_HCACHE */
1419 else if (ctx->magic == M_MH) {
1420 /* MH just moves files out of the way when you delete them */
1421 if (*ctx->hdrs[i]->path != ',') {
1422 snprintf (tmp, sizeof (tmp), "%s/,%s", ctx->path,
1423 ctx->hdrs[i]->path);
1430 else if (ctx->hdrs[i]->changed || ctx->hdrs[i]->attach_del ||
1431 (ctx->magic == M_MAILDIR
1432 && (option (OPTMAILDIRTRASH) || ctx->hdrs[i]->trash)
1433 && (ctx->hdrs[i]->deleted != ctx->hdrs[i]->trash))) {
1434 if (ctx->magic == M_MAILDIR) {
1435 if (maildir_sync_message (ctx, i) == -1)
1439 if (mh_sync_message (ctx, i) == -1)
1446 if (ctx->magic == M_MAILDIR)
1447 mutt_hcache_close (hc);
1448 #endif /* USE_HCACHE */
1450 if (ctx->magic == M_MH)
1451 mh_update_sequences (ctx);
1453 /* XXX race condition? */
1455 maildir_update_mtime (ctx);
1457 /* adjust indices */
1460 for (i = 0, j = 0; i < ctx->msgcount; i++) {
1461 if (!ctx->hdrs[i]->deleted
1462 || (ctx->magic == M_MAILDIR && option (OPTMAILDIRTRASH)))
1463 ctx->hdrs[i]->index = j++;
1471 if (ctx->magic == M_MAILDIR)
1472 mutt_hcache_close (hc);
1473 #endif /* USE_HCACHE */
1477 static char *maildir_canon_filename (char *dest, const char *src, size_t l)
1481 if ((t = strrchr (src, '/')))
1484 strfcpy (dest, src, l);
1485 if ((u = strrchr (dest, ':')))
1491 static void maildir_update_tables (CONTEXT * ctx, int *index_hint)
1497 if (Sort != SORT_ORDER) {
1500 mutt_sort_headers (ctx, 1);
1504 old_count = ctx->msgcount;
1505 for (i = 0, j = 0; i < old_count; i++) {
1506 if (ctx->hdrs[i]->active && index_hint && *index_hint == i)
1509 if (ctx->hdrs[i]->active)
1510 ctx->hdrs[i]->index = j++;
1513 mx_update_tables (ctx, 0);
1514 mutt_clear_threads (ctx);
1517 static void maildir_update_flags (CONTEXT * ctx, HEADER * o, HEADER * n)
1519 /* save the global state here so we can reset it at the
1520 * end of list block if required.
1522 int context_changed = ctx->changed;
1524 /* user didn't modify this message. alter the flags to
1525 * match the current state on disk. This may not actually
1526 * do anything, but we can't tell right now. mutt_set_flag()
1527 * will just ignore the call if the status bits are
1528 * already properly set.
1530 mutt_set_flag (ctx, o, M_FLAG, n->flagged);
1531 mutt_set_flag (ctx, o, M_REPLIED, n->replied);
1532 mutt_set_flag (ctx, o, M_READ, n->read);
1533 mutt_set_flag (ctx, o, M_OLD, n->old);
1535 /* mutt_set_flag() will set this, but we don't need to
1536 * sync the changes we made because we just updated the
1537 * context to match the current on-disk state of the
1542 /* if the mailbox was not modified before we made these
1543 * changes, unset the changed flag since nothing needs to
1546 if (!context_changed)
1551 /* This function handles arrival of new mail and reopening of
1552 * maildir folders. The basic idea here is we check to see if either
1553 * the new or cur subdirectories have changed, and if so, we scan them
1554 * for the list of files. We check for newly added messages, and
1555 * then merge the flags messages we already knew about. We don't treat
1556 * either subdirectory differently, as mail could be copied directly into
1557 * the cur directory from another agent.
1559 static int maildir_check_mailbox (CONTEXT * ctx, int *index_hint, int unused)
1561 struct stat st_new; /* status of the "new" subdirectory */
1562 struct stat st_cur; /* status of the "cur" subdirectory */
1563 char buf[_POSIX_PATH_MAX];
1564 int changed = 0; /* bitmask representing which subdirectories
1565 have changed. 0x1 = new, 0x2 = cur */
1566 int occult = 0; /* messages were removed from the mailbox */
1567 int have_new = 0; /* messages were added to the mailbox */
1568 struct maildir *md; /* list of messages in the mailbox */
1569 struct maildir **last, *p;
1571 HASH *fnames; /* hash table for quickly looking up the base filename
1572 for a maildir message */
1574 if (!option (OPTCHECKNEW))
1577 snprintf (buf, sizeof (buf), "%s/new", ctx->path);
1578 if (stat (buf, &st_new) == -1)
1581 snprintf (buf, sizeof (buf), "%s/cur", ctx->path);
1582 if (stat (buf, &st_cur) == -1)
1585 /* determine which subdirectories need to be scanned */
1586 if (st_new.st_mtime > ctx->mtime)
1588 if (st_cur.st_mtime > ctx->mtime_cur)
1592 return 0; /* nothing to do */
1594 /* update the modification times on the mailbox */
1595 ctx->mtime_cur = st_cur.st_mtime;
1596 ctx->mtime = st_new.st_mtime;
1598 /* do a fast scan of just the filenames in
1599 * the subdirectories that have changed.
1604 maildir_parse_dir (ctx, &last, "new", NULL);
1606 maildir_parse_dir (ctx, &last, "cur", NULL);
1608 /* we create a hash table keyed off the canonical (sans flags) filename
1609 * of each message we scanned. This is used in the loop over the
1610 * existing messages below to do some correlation.
1612 fnames = hash_create (1031);
1614 for (p = md; p; p = p->next) {
1615 maildir_canon_filename (buf, p->h->path, sizeof (buf));
1616 p->canon_fname = str_dup (buf);
1617 hash_insert (fnames, p->canon_fname, p, 0);
1620 /* check for modifications and adjust flags */
1621 for (i = 0; i < ctx->msgcount; i++) {
1622 ctx->hdrs[i]->active = 0;
1623 maildir_canon_filename (buf, ctx->hdrs[i]->path, sizeof (buf));
1624 p = hash_find (fnames, buf);
1626 /* message already exists, merge flags */
1627 ctx->hdrs[i]->active = 1;
1629 /* check to see if the message has moved to a different
1630 * subdirectory. If so, update the associated filename.
1632 if (str_cmp (ctx->hdrs[i]->path, p->h->path))
1633 str_replace (&ctx->hdrs[i]->path, p->h->path);
1635 /* if the user hasn't modified the flags on this message, update
1636 * the flags we just detected.
1638 if (!ctx->hdrs[i]->changed)
1639 maildir_update_flags (ctx, ctx->hdrs[i], p->h);
1641 if (ctx->hdrs[i]->deleted == ctx->hdrs[i]->trash)
1642 ctx->hdrs[i]->deleted = p->h->deleted;
1643 ctx->hdrs[i]->trash = p->h->trash;
1645 /* this is a duplicate of an existing header, so remove it */
1646 mutt_free_header (&p->h);
1648 /* This message was not in the list of messages we just scanned.
1649 * Check to see if we have enough information to know if the
1650 * message has disappeared out from underneath us.
1652 else if (((changed & 1) && (!strncmp (ctx->hdrs[i]->path, "new/", 4))) ||
1653 ((changed & 2) && (!strncmp (ctx->hdrs[i]->path, "cur/", 4)))) {
1654 /* This message disappeared, so we need to simulate a "reopen"
1655 * event. We know it disappeared because we just scanned the
1656 * subdirectory it used to reside in.
1661 /* This message resides in a subdirectory which was not
1662 * modified, so we assume that it is still present and
1665 ctx->hdrs[i]->active = 1;
1669 /* destroy the file name hash */
1670 hash_destroy (&fnames, NULL);
1672 /* If we didn't just get new mail, update the tables. */
1674 maildir_update_tables (ctx, index_hint);
1676 /* do any delayed parsing we need to do. */
1677 maildir_delayed_parsing (ctx, md);
1679 /* Incorporate new messages */
1680 have_new = maildir_move_to_context (ctx, &md);
1682 return occult ? M_REOPENED : (have_new ? M_NEW_MAIL : 0);
1686 * This function handles arrival of new mail and reopening of
1687 * mh/maildir folders. Things are getting rather complex because we
1688 * don't have a well-defined "mailbox order", so the tricks from
1689 * mbox.c and mx.c won't work here.
1691 * Don't change this code unless you _really_ understand what
1696 static int mh_check_mailbox (CONTEXT * ctx, int *index_hint, int unused)
1698 char buf[_POSIX_PATH_MAX];
1699 struct stat st, st_cur;
1700 short modified = 0, have_new = 0, occult = 0;
1701 struct maildir *md, *p;
1702 struct maildir **last = NULL;
1703 struct mh_sequences mhs;
1707 if (!option (OPTCHECKNEW))
1710 strfcpy (buf, ctx->path, sizeof (buf));
1711 if (stat (buf, &st) == -1)
1714 /* create .mh_sequences when there isn't one. */
1715 snprintf (buf, sizeof (buf), "%s/.mh_sequences", ctx->path);
1716 if ((i = stat (buf, &st_cur) == -1) && errno == ENOENT) {
1720 if (mh_mkstemp (ctx, &fp, &tmp) == 0) {
1722 if (safe_rename (tmp, buf) == -1)
1728 if (i == -1 && stat (buf, &st_cur) == -1)
1731 if (st.st_mtime > ctx->mtime || st_cur.st_mtime > ctx->mtime_cur)
1737 ctx->mtime_cur = st_cur.st_mtime;
1738 ctx->mtime = st.st_mtime;
1740 memset (&mhs, 0, sizeof (mhs));
1744 maildir_parse_dir (ctx, &last, NULL, NULL);
1745 mh_read_sequences (&mhs, ctx->path);
1746 mh_update_maildir (md, &mhs);
1747 mhs_free_sequences (&mhs);
1749 /* check for modifications and adjust flags */
1750 fnames = hash_create (1031);
1752 for (p = md; p; p = p->next)
1753 hash_insert (fnames, p->h->path, p, 0);
1755 for (i = 0; i < ctx->msgcount; i++) {
1756 ctx->hdrs[i]->active = 0;
1758 if ((p = hash_find (fnames, ctx->hdrs[i]->path)) && p->h &&
1759 (mutt_cmp_header (ctx->hdrs[i], p->h))) {
1760 ctx->hdrs[i]->active = 1;
1761 /* found the right message */
1762 if (!ctx->hdrs[i]->changed)
1763 maildir_update_flags (ctx, ctx->hdrs[i], p->h);
1765 mutt_free_header (&p->h);
1767 else /* message has disappeared */
1771 /* destroy the file name hash */
1773 hash_destroy (&fnames, NULL);
1775 /* If we didn't just get new mail, update the tables. */
1777 maildir_update_tables (ctx, index_hint);
1779 /* Incorporate new messages */
1780 have_new = maildir_move_to_context (ctx, &md);
1782 return occult ? M_REOPENED : (have_new ? M_NEW_MAIL : 0);
1789 * These functions try to find a message in a maildir folder when it
1790 * has moved under our feet. Note that this code is rather expensive, but
1791 * then again, it's called rarely.
1794 FILE *_maildir_open_find_message (const char *folder, const char *unique,
1795 const char *subfolder)
1797 char dir[_POSIX_PATH_MAX];
1798 char tunique[_POSIX_PATH_MAX];
1799 char fname[_POSIX_PATH_MAX];
1807 snprintf (dir, sizeof (dir), "%s/%s", folder, subfolder);
1809 if ((dp = opendir (dir)) == NULL) {
1814 while ((de = readdir (dp))) {
1815 maildir_canon_filename (tunique, de->d_name, sizeof (tunique));
1817 if (!str_cmp (tunique, unique)) {
1818 snprintf (fname, sizeof (fname), "%s/%s/%s", folder, subfolder,
1820 fp = fopen (fname, "r"); /* __FOPEN_CHECKED__ */
1832 FILE *maildir_open_find_message (const char *folder, const char *msg)
1834 char unique[_POSIX_PATH_MAX];
1837 static unsigned int new_hits = 0, cur_hits = 0; /* simple dynamic optimization */
1839 maildir_canon_filename (unique, msg, sizeof (unique));
1842 _maildir_open_find_message (folder, unique,
1843 new_hits > cur_hits ? "new" : "cur"))
1844 || errno != ENOENT) {
1845 if (new_hits < UINT_MAX && cur_hits < UINT_MAX) {
1846 new_hits += (new_hits > cur_hits ? 1 : 0);
1847 cur_hits += (new_hits > cur_hits ? 0 : 1);
1853 _maildir_open_find_message (folder, unique,
1854 new_hits > cur_hits ? "cur" : "new"))
1855 || errno != ENOENT) {
1856 if (new_hits < UINT_MAX && cur_hits < UINT_MAX) {
1857 new_hits += (new_hits > cur_hits ? 0 : 1);
1858 cur_hits += (new_hits > cur_hits ? 1 : 0);
1870 * 1 if there are no messages in the mailbox
1871 * 0 if there are messages in the mailbox
1874 static int maildir_check_empty (const char *path)
1878 int r = 1; /* assume empty until we find a message */
1879 char realpath[_POSIX_PATH_MAX];
1882 /* Strategy here is to look for any file not beginning with a period */
1885 /* we do "cur" on the first iteration since its more likely that we'll
1886 * find old messages without having to scan both subdirs
1888 snprintf (realpath, sizeof (realpath), "%s/%s", path,
1889 iter == 0 ? "cur" : "new");
1890 if ((dp = opendir (realpath)) == NULL)
1892 while ((de = readdir (dp))) {
1893 if (*de->d_name != '.') {
1900 } while (r && iter < 2);
1907 * 1 if there are no messages in the mailbox
1908 * 0 if there are messages in the mailbox
1911 int mh_check_empty (const char *path)
1915 int r = 1; /* assume empty until we find a message */
1917 if ((dp = opendir (path)) == NULL)
1919 while ((de = readdir (dp))) {
1920 if (mh_valid_message (de->d_name)) {
1930 static int mh_is_magic (const char* path, struct stat* st) {
1931 char tmp[_POSIX_PATH_MAX];
1933 if (S_ISDIR (st->st_mode)) {
1934 snprintf (tmp, sizeof (tmp), "%s/.mh_sequences", path);
1935 if (access (tmp, F_OK) == 0)
1938 snprintf (tmp, sizeof (tmp), "%s/.xmhcache", path);
1939 if (access (tmp, F_OK) == 0)
1942 snprintf (tmp, sizeof (tmp), "%s/.mew_cache", path);
1943 if (access (tmp, F_OK) == 0)
1946 snprintf (tmp, sizeof (tmp), "%s/.mew-cache", path);
1947 if (access (tmp, F_OK) == 0)
1950 snprintf (tmp, sizeof (tmp), "%s/.sylpheed_cache", path);
1951 if (access (tmp, F_OK) == 0)
1955 * ok, this isn't an mh folder, but mh mode can be used to read
1956 * Usenet news from the spool. ;-)
1959 snprintf (tmp, sizeof (tmp), "%s/.overview", path);
1960 if (access (tmp, F_OK) == 0)
1966 static int maildir_is_magic (const char* path, struct stat* st) {
1968 char tmp[_POSIX_PATH_MAX];
1970 if (S_ISDIR (st->st_mode)) {
1971 snprintf (tmp, sizeof (tmp), "%s/cur", path);
1972 if (stat (tmp, &sb) == 0 && S_ISDIR (sb.st_mode))
1978 /* routines common to maildir and mh */
1979 static mx_t* reg_mx (void) {
1980 mx_t* fmt = p_new(mx_t, 1);
1982 fmt->mx_access = access;
1983 fmt->mx_sync_mailbox = mh_sync_mailbox;
1987 static int mh_commit (MESSAGE* msg, CONTEXT* ctx) {
1988 return (mh_commit_message (msg, ctx, NULL));
1991 static int maildir_commit (MESSAGE* msg, CONTEXT* ctx) {
1992 return (maildir_commit_message (msg, ctx, NULL));
1995 mx_t* mh_reg_mx (void) {
1996 mx_t* fmt = reg_mx ();
1998 fmt->mx_check_empty = mh_check_empty;
1999 fmt->mx_is_magic = mh_is_magic;
2000 fmt->mx_open_mailbox = mh_read_dir;
2001 fmt->mx_open_new_message = mh_open_new_message;
2002 fmt->mx_check_mailbox = mh_check_mailbox;
2003 fmt->mx_commit_message = mh_commit;
2007 mx_t* maildir_reg_mx (void) {
2008 mx_t* fmt = reg_mx ();
2009 fmt->type = M_MAILDIR;
2010 fmt->mx_check_empty = maildir_check_empty;
2011 fmt->mx_is_magic = maildir_is_magic;
2012 fmt->mx_open_mailbox = maildir_read_dir;
2013 fmt->mx_open_new_message = maildir_open_new_message;
2014 fmt->mx_check_mailbox = maildir_check_mailbox;
2015 fmt->mx_commit_message = maildir_commit;