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
31 #include "lib/debug.h"
34 #include <sys/types.h>
54 unsigned header_parsed:1;
57 #endif /* USE_INODESORT */
66 /* mh_sequences support */
68 #define MH_SEQ_UNSEEN (1 << 0)
69 #define MH_SEQ_REPLIED (1 << 1)
70 #define MH_SEQ_FLAGGED (1 << 2)
73 static int maildir_check_empty (const char*);
74 static int maildir_check_mailbox (CONTEXT*, int*, int);
75 static int mh_check_mailbox (CONTEXT*, int*, int);
77 static void mhs_alloc (struct mh_sequences *mhs, int i)
82 if (i > mhs->max || !mhs->flags) {
84 safe_realloc (&mhs->flags, sizeof (mhs->flags[0]) * (newmax + 1));
85 for (j = mhs->max + 1; j <= newmax; j++)
92 static void mhs_free_sequences (struct mh_sequences *mhs)
97 static short mhs_check (struct mh_sequences *mhs, int i)
99 if (!mhs->flags || i > mhs->max)
102 return mhs->flags[i];
105 static short mhs_set (struct mh_sequences *mhs, int i, short f)
109 return mhs->flags[i];
116 static short mhs_unset (struct mh_sequences *mhs, int i, short f)
120 return mhs->flags[i];
125 static void mh_read_token (char *t, int *first, int *last)
129 if ((p = strchr (t, '-'))) {
135 *first = *last = atoi (t);
138 static void mh_read_sequences (struct mh_sequences *mhs, const char *path)
149 char pathname[_POSIX_PATH_MAX];
151 snprintf (pathname, sizeof (pathname), "%s/.mh_sequences", path);
153 if (!(fp = fopen (pathname, "r")))
156 while ((buff = mutt_read_line (buff, &sz, fp, &line))) {
157 if (!(t = strtok (buff, " \t:")))
160 if (!mutt_strcmp (t, MhUnseen))
162 else if (!mutt_strcmp (t, MhFlagged))
164 else if (!mutt_strcmp (t, MhReplied))
166 else /* unknown sequence */
169 while ((t = strtok (NULL, " \t:"))) {
170 mh_read_token (t, &first, &last);
171 for (; first <= last; first++)
172 mhs_set (mhs, first, f);
180 int mh_buffy (const char *path)
183 struct mh_sequences mhs;
185 memset (&mhs, 0, sizeof (mhs));
187 mh_read_sequences (&mhs, path);
188 for (i = 0; !r && i <= mhs.max; i++)
189 if (mhs_check (&mhs, i) & MH_SEQ_UNSEEN)
191 mhs_free_sequences (&mhs);
195 static int mh_mkstemp (CONTEXT * dest, FILE ** fp, char **tgt)
198 char path[_POSIX_PATH_MAX];
201 snprintf (path, _POSIX_PATH_MAX, "%s/.mutt-%s-%d-%d",
202 dest->path, NONULL (Hostname), (int) getpid (), Counter++);
204 if ((fd = open (path, O_WRONLY | O_EXCL | O_CREAT, 0666)) == -1) {
205 if (errno != EEXIST) {
211 *tgt = safe_strdup (path);
216 if ((*fp = fdopen (fd, "w")) == NULL) {
226 static void mhs_write_one_sequence (FILE * fp, struct mh_sequences *mhs,
227 short f, const char *tag)
232 fprintf (fp, "%s:", tag);
237 for (i = 0; i <= mhs->max; i++) {
238 if ((mhs_check (mhs, i) & f)) {
244 else if (first >= 0) {
246 fprintf (fp, " %d", first);
248 fprintf (fp, " %d-%d", first, last);
257 fprintf (fp, " %d", first);
259 fprintf (fp, " %d-%d", first, last);
265 /* XXX - we don't currently remove deleted messages from sequences we don't know. Should we? */
267 void mh_update_sequences (CONTEXT * ctx)
271 char sequences[_POSIX_PATH_MAX];
283 char seq_unseen[STRING];
284 char seq_replied[STRING];
285 char seq_flagged[STRING];
288 struct mh_sequences mhs;
290 memset (&mhs, 0, sizeof (mhs));
292 snprintf (seq_unseen, sizeof (seq_unseen), "%s:", NONULL (MhUnseen));
293 snprintf (seq_replied, sizeof (seq_replied), "%s:", NONULL (MhReplied));
294 snprintf (seq_flagged, sizeof (seq_flagged), "%s:", NONULL (MhFlagged));
296 if (mh_mkstemp (ctx, &nfp, &tmpfname) != 0) {
301 snprintf (sequences, sizeof (sequences), "%s/.mh_sequences", ctx->path);
304 /* first, copy unknown sequences */
305 if ((ofp = fopen (sequences, "r"))) {
306 while ((buff = mutt_read_line (buff, &s, ofp, &l))) {
307 if (!safe_strncmp (buff, seq_unseen, mutt_strlen (seq_unseen)))
309 if (!safe_strncmp (buff, seq_flagged, mutt_strlen (seq_flagged)))
311 if (!safe_strncmp (buff, seq_replied, mutt_strlen (seq_replied)))
314 fprintf (nfp, "%s\n", buff);
319 /* now, update our unseen, flagged, and replied sequences */
320 for (l = 0; l < ctx->msgcount; l++) {
321 if (ctx->hdrs[l]->deleted)
324 if ((p = strrchr (ctx->hdrs[l]->path, '/')))
327 p = ctx->hdrs[l]->path;
331 if (!ctx->hdrs[l]->read) {
332 mhs_set (&mhs, i, MH_SEQ_UNSEEN);
335 if (ctx->hdrs[l]->flagged) {
336 mhs_set (&mhs, i, MH_SEQ_FLAGGED);
339 if (ctx->hdrs[l]->replied) {
340 mhs_set (&mhs, i, MH_SEQ_REPLIED);
345 /* write out the new sequences */
347 mhs_write_one_sequence (nfp, &mhs, MH_SEQ_UNSEEN, NONULL (MhUnseen));
349 mhs_write_one_sequence (nfp, &mhs, MH_SEQ_FLAGGED, NONULL (MhFlagged));
351 mhs_write_one_sequence (nfp, &mhs, MH_SEQ_REPLIED, NONULL (MhReplied));
353 mhs_free_sequences (&mhs);
356 /* try to commit the changes - no guarantee here */
360 if (safe_rename (tmpfname, sequences) != 0) {
361 /* report an error? */
368 static void mh_sequences_add_one (CONTEXT * ctx, int n, short unseen,
369 short flagged, short replied)
371 short unseen_done = 0;
372 short flagged_done = 0;
373 short replied_done = 0;
375 FILE *ofp = NULL, *nfp = NULL;
378 char sequences[_POSIX_PATH_MAX];
380 char seq_unseen[STRING];
381 char seq_replied[STRING];
382 char seq_flagged[STRING];
388 if (mh_mkstemp (ctx, &nfp, &tmpfname) == -1)
391 snprintf (seq_unseen, sizeof (seq_unseen), "%s:", NONULL (MhUnseen));
392 snprintf (seq_replied, sizeof (seq_replied), "%s:", NONULL (MhReplied));
393 snprintf (seq_flagged, sizeof (seq_flagged), "%s:", NONULL (MhFlagged));
395 snprintf (sequences, sizeof (sequences), "%s/.mh_sequences", ctx->path);
396 if ((ofp = fopen (sequences, "r"))) {
397 while ((buff = mutt_read_line (buff, &sz, ofp, &line))) {
398 if (unseen && !strncmp (buff, seq_unseen, mutt_strlen (seq_unseen))) {
399 fprintf (nfp, "%s %d\n", buff, n);
403 && !strncmp (buff, seq_flagged, mutt_strlen (seq_flagged))) {
404 fprintf (nfp, "%s %d\n", buff, n);
408 && !strncmp (buff, seq_replied, mutt_strlen (seq_replied))) {
409 fprintf (nfp, "%s %d\n", buff, n);
413 fprintf (nfp, "%s\n", buff);
419 if (!unseen_done && unseen)
420 fprintf (nfp, "%s: %d\n", NONULL (MhUnseen), n);
421 if (!flagged_done && flagged)
422 fprintf (nfp, "%s: %d\n", NONULL (MhFlagged), n);
423 if (!replied_done && replied)
424 fprintf (nfp, "%s: %d\n", NONULL (MhReplied), n);
429 if (safe_rename (tmpfname, sequences) != 0)
435 static void mh_update_maildir (struct maildir *md, struct mh_sequences *mhs)
441 for (; md; md = md->next) {
442 if ((p = strrchr (md->h->path, '/')))
448 f = mhs_check (mhs, i);
450 md->h->read = (f & MH_SEQ_UNSEEN) ? 0 : 1;
451 md->h->flagged = (f & MH_SEQ_FLAGGED) ? 1 : 0;
452 md->h->replied = (f & MH_SEQ_REPLIED) ? 1 : 0;
456 /* maildir support */
458 static void maildir_free_entry (struct maildir **md)
463 FREE (&(*md)->canon_fname);
465 mutt_free_header (&(*md)->h);
470 static void maildir_free_maildir (struct maildir **md)
472 struct maildir *p, *q;
477 for (p = *md; p; p = q) {
479 maildir_free_entry (&p);
483 static void maildir_parse_flags (HEADER * h, const char *path)
491 if ((p = strrchr (path, ':')) != NULL && safe_strncmp (p + 1, "2,", 2) == 0) {
494 str_replace (&h->maildir_flags, p);
495 q = h->maildir_flags;
509 case 'R': /* replied */
514 case 'T': /* trashed */
527 if (q == h->maildir_flags)
528 FREE (&h->maildir_flags);
533 static void maildir_update_mtime (CONTEXT * ctx)
535 char buf[_POSIX_PATH_MAX];
538 if (ctx->magic == M_MAILDIR) {
539 snprintf (buf, sizeof (buf), "%s/%s", ctx->path, "cur");
540 if (stat (buf, &st) == 0)
541 ctx->mtime_cur = st.st_mtime;
542 snprintf (buf, sizeof (buf), "%s/%s", ctx->path, "new");
545 snprintf (buf, sizeof (buf), "%s/.mh_sequences", ctx->path);
546 if (stat (buf, &st) == 0)
547 ctx->mtime_cur = st.st_mtime;
549 strfcpy (buf, ctx->path, sizeof (buf));
552 if (stat (buf, &st) == 0)
553 ctx->mtime = st.st_mtime;
557 * Actually parse a maildir message. This may also be used to fill
558 * out a fake header structure generated by lazy maildir parsing.
560 static HEADER *maildir_parse_message (int magic, const char *fname,
561 int is_old, HEADER * _h)
567 if ((f = fopen (fname, "r")) != NULL) {
569 h = mutt_new_header ();
570 h->env = mutt_read_rfc822_header (f, h, 0, 0);
572 fstat (fileno (f), &st);
576 h->received = h->date_sent;
578 if (h->content->length <= 0)
579 h->content->length = st.st_size - h->content->offset;
583 if (magic == M_MAILDIR) {
585 * maildir stores its flags in the filename, so ignore the
586 * flags in the header of the message
590 maildir_parse_flags (h, fname);
598 * Note that this routine will _not_ modify the context given by
601 * It's used in the first parsing pass on maildir and MH folders.
602 * In the MH case, this means full parsing of the folder. In the
603 * maildir case, it means that we only look at flags, and create a
604 * fake HEADER structure, which may later be filled in by
605 * maildir_parse_message(), when called from
606 * maildir_delayed_parsing().
610 static int maildir_parse_entry (CONTEXT * ctx, struct maildir ***last,
611 const char *subdir, const char *fname,
612 int *count, int is_old, ino_t inode)
614 struct maildir *entry;
616 char buf[_POSIX_PATH_MAX];
619 snprintf (buf, sizeof (buf), "%s/%s/%s", ctx->path, subdir, fname);
621 snprintf (buf, sizeof (buf), "%s/%s", ctx->path, fname);
623 if (ctx->magic == M_MH)
624 h = maildir_parse_message (ctx->magic, buf, is_old, NULL);
626 h = mutt_new_header ();
628 maildir_parse_flags (h, buf);
634 if (!ctx->quiet && ReadInc && ((*count % ReadInc) == 0 || *count == 1))
635 mutt_message (_("Reading %s... %d"), ctx->path, *count);
639 snprintf (buf, sizeof (buf), "%s/%s", subdir, fname);
640 h->path = safe_strdup (buf);
643 h->path = safe_strdup (fname);
645 entry = safe_calloc (sizeof (struct maildir), 1);
647 entry->header_parsed = (ctx->magic == M_MH);
649 entry->inode = inode;
650 #endif /* USE_INODESORT */
652 *last = &entry->next;
662 /* Ignore the garbage files. A valid MH message consists of only
663 * digits. Deleted message get moved to a filename with a comma before
667 int mh_valid_message (const char *s)
670 if (!isdigit ((unsigned char) *s))
676 static int maildir_parse_dir (CONTEXT * ctx, struct maildir ***last,
677 const char *subdir, int *count)
681 char buf[_POSIX_PATH_MAX];
685 snprintf (buf, sizeof (buf), "%s/%s", ctx->path, subdir);
686 is_old = (mutt_strcmp ("cur", subdir) == 0);
689 strfcpy (buf, ctx->path, sizeof (buf));
691 if ((dirp = opendir (buf)) == NULL)
694 while ((de = readdir (dirp)) != NULL) {
696 if ((ctx->magic == M_MH && !mh_valid_message (de->d_name))
697 || (ctx->magic == M_MAILDIR && *de->d_name == '.'))
700 /* FOO - really ignore the return value? */
702 debug_print (2, ("parsing %s\n", de->d_name));
703 maildir_parse_entry (ctx, last, subdir, de->d_name, count, is_old,
711 static int maildir_add_to_context (CONTEXT * ctx, struct maildir *md)
713 int oldmsgcount = ctx->msgcount;
717 debug_print (2, ("considering %s\n", NONULL (md->canon_fname)));
720 debug_print (2, ("flags: %s%s%s%s%s\n", md->h->flagged ? "f" : "",
721 md->h->deleted ? "D" : "", md->h->replied ? "r" : "",
722 md->h->old ? "O" : "", md->h->read ? "R" : ""));
723 if (ctx->msgcount == ctx->hdrmax)
724 mx_alloc_memory (ctx);
726 ctx->hdrs[ctx->msgcount] = md->h;
727 ctx->hdrs[ctx->msgcount]->index = ctx->msgcount;
729 md->h->content->length + md->h->content->offset -
730 md->h->content->hdr_offset;
738 if (ctx->msgcount > oldmsgcount) {
739 mx_update_context (ctx, ctx->msgcount - oldmsgcount);
745 static int maildir_move_to_context (CONTEXT * ctx, struct maildir **md)
749 r = maildir_add_to_context (ctx, *md);
750 maildir_free_maildir (md);
756 * Merge two maildir lists according to the inode numbers.
758 static struct maildir *maildir_merge_inode (struct maildir *left,
759 struct maildir *right)
761 struct maildir *head;
762 struct maildir *tail;
765 if (left->inode < right->inode) {
783 while (left && right) {
784 if (left->inode < right->inode) {
806 * Sort maildir list according to inode.
808 static struct maildir *maildir_sort_inode (struct maildir *list)
810 struct maildir *left = list;
811 struct maildir *right = list;
813 if (!list || !list->next) {
818 while (list && list->next) {
820 list = list->next->next;
827 left = maildir_sort_inode (left);
828 right = maildir_sort_inode (right);
829 return maildir_merge_inode (left, right);
831 #endif /* USE_INODESORT */
834 static size_t maildir_hcache_keylen (const char *fn)
836 const char *p = strchr (fn, ':');
838 return p ? (size_t) (p - fn) : mutt_strlen (fn);
843 * This function does the second parsing pass for a maildir-style
846 void maildir_delayed_parsing (CONTEXT * ctx, struct maildir *md)
849 char fn[_POSIX_PATH_MAX];
855 struct timeval *when = NULL;
856 struct stat lastchanged;
859 hc = mutt_hcache_open (HeaderCache, ctx->path);
862 for (p = md, count = 0; p; p = p->next, count++) {
863 if (!(p && p->h && !p->header_parsed))
867 data = mutt_hcache_fetch (hc, p->h->path + 3, &maildir_hcache_keylen);
868 when = (struct timeval *) data;
871 if (!ctx->quiet && ReadInc && ((count % ReadInc) == 0 || count == 1))
872 mutt_message (_("Reading %s... %d"), ctx->path, count);
873 snprintf (fn, sizeof (fn), "%s/%s", ctx->path, p->h->path);
876 if (option (OPTHCACHEVERIFY)) {
877 ret = stat (fn, &lastchanged);
880 lastchanged.st_mtime = 0;
884 if (data != NULL && !ret && lastchanged.st_mtime <= when->tv_sec) {
885 p->h = mutt_hcache_restore ((unsigned char *) data, &p->h);
886 maildir_parse_flags (p->h, fn);
890 if (maildir_parse_message (ctx->magic, fn, p->h->old, p->h)) {
891 p->header_parsed = 1;
892 maildir_parse_flags (p->h, fn);
894 mutt_hcache_store (hc, p->h->path + 3, p->h, 0, &maildir_hcache_keylen);
898 mutt_free_header (&p->h);
904 mutt_hcache_close (hc);
908 /* Read a MH/maildir style mailbox.
911 * ctx [IN/OUT] context for this mailbox
912 * subdir [IN] NULL for MH mailboxes, otherwise the subdir of the
913 * maildir mailbox to read from
915 static int _mh_read_dir (CONTEXT * ctx, const char *subdir)
918 struct mh_sequences mhs;
919 struct maildir **last;
923 memset (&mhs, 0, sizeof (mhs));
925 maildir_update_mtime (ctx);
930 if (maildir_parse_dir (ctx, &last, subdir, &count) == -1)
933 if (ctx->magic == M_MH) {
934 mh_read_sequences (&mhs, ctx->path);
935 mh_update_maildir (md, &mhs);
936 mhs_free_sequences (&mhs);
940 md = maildir_sort_inode (md);
941 #endif /* USE_INODESORT */
943 if (ctx->magic == M_MAILDIR)
944 maildir_delayed_parsing (ctx, md);
946 maildir_move_to_context (ctx, &md);
950 static int mh_read_dir (CONTEXT* ctx) {
951 return (_mh_read_dir (ctx, NULL));
954 /* read a maildir style mailbox */
955 static int maildir_read_dir (CONTEXT * ctx)
957 /* maildir looks sort of like MH, except that there are two subdirectories
958 * of the main folder path from which to read messages
960 if (_mh_read_dir (ctx, "new") == -1 || _mh_read_dir (ctx, "cur") == -1)
967 * Open a new (temporary) message in an MH folder.
970 static int mh_open_new_message (MESSAGE * msg, CONTEXT * dest, HEADER * hdr)
972 return mh_mkstemp (dest, &msg->fp, &msg->path);
975 int ch_compar (const void *a, const void *b)
977 return (int) (*((const char *) a) - *((const char *) b));
980 static void maildir_flags (char *dest, size_t destlen, HEADER * hdr)
985 * The maildir specification requires that all files in the cur
986 * subdirectory have the :unique string appeneded, regardless of whether
987 * or not there are any flags. If .old is set, we know that this message
988 * will end up in the cur directory, so we include it in the following
989 * test even though there is no associated flag.
993 && (hdr->flagged || hdr->replied || hdr->read || hdr->deleted
994 || hdr->old || hdr->maildir_flags)) {
995 char tmp[LONG_STRING];
997 snprintf (tmp, sizeof (tmp),
999 hdr->flagged ? "F" : "",
1000 hdr->replied ? "R" : "",
1001 hdr->read ? "S" : "", hdr->deleted ? "T" : "",
1002 NONULL (hdr->maildir_flags));
1003 if (hdr->maildir_flags)
1004 qsort (tmp, mutt_strlen (tmp), 1, ch_compar);
1005 snprintf (dest, destlen, ":2,%s", tmp);
1011 * Open a new (temporary) message in a maildir folder.
1013 * Note that this uses _almost_ the maildir file name format, but
1014 * with a {cur,new} prefix.
1018 static int maildir_open_new_message (MESSAGE * msg, CONTEXT * dest, HEADER * hdr)
1021 char path[_POSIX_PATH_MAX];
1026 short deleted = hdr->deleted;
1030 maildir_flags (suffix, sizeof (suffix), hdr);
1032 hdr->deleted = deleted;
1037 if (hdr && (hdr->read || hdr->old))
1038 strfcpy (subdir, "cur", sizeof (subdir));
1040 strfcpy (subdir, "new", sizeof (subdir));
1043 snprintf (path, _POSIX_PATH_MAX, "%s/tmp/%s.%ld.%u_%d.%s%s",
1044 dest->path, subdir, (long) time (NULL),
1045 (unsigned int) getpid (), Counter++, NONULL (Hostname), suffix);
1047 debug_print (2, ("trying %s.\n", path));
1050 if ((fd = open (path, O_WRONLY | O_EXCL | O_CREAT, 0666)) == -1) {
1051 if (errno != EEXIST) {
1057 debug_print (2, ("success.\n"));
1058 msg->path = safe_strdup (path);
1063 if ((msg->fp = fdopen (fd, "w")) == NULL) {
1076 * Commit a message to a maildir folder.
1078 * msg->path contains the file name of a file in tmp/. We take the
1079 * flags from this file's name.
1081 * ctx is the mail folder we commit to.
1083 * hdr is a header structure to which we write the message's new
1084 * file name. This is used in the mh and maildir folder synch
1085 * routines. When this routine is invoked from mx_commit_message,
1088 * msg->path looks like this:
1090 * tmp/{cur,new}.mutt-HOSTNAME-PID-COUNTER:flags
1092 * See also maildir_open_new_message().
1096 static int maildir_commit_message (MESSAGE * msg, CONTEXT * ctx, HEADER * hdr)
1100 char path[_POSIX_PATH_MAX];
1101 char full[_POSIX_PATH_MAX];
1104 if (safe_fclose (&msg->fp) != 0)
1107 /* extract the subdir */
1108 s = strrchr (msg->path, '/') + 1;
1109 strfcpy (subdir, s, 4);
1111 /* extract the flags */
1112 if ((s = strchr (s, ':')))
1113 strfcpy (suffix, s, sizeof (suffix));
1117 /* construct a new file name. */
1119 snprintf (path, _POSIX_PATH_MAX, "%s/%ld.%u_%d.%s%s", subdir,
1120 (long) time (NULL), (unsigned int) getpid (), Counter++,
1121 NONULL (Hostname), suffix);
1122 snprintf (full, _POSIX_PATH_MAX, "%s/%s", ctx->path, path);
1124 debug_print (2, ("renaming %s to %s.\n", msg->path, full));
1126 if (safe_rename (msg->path, full) == 0) {
1128 str_replace (&hdr->path, path);
1132 * Adjust the mtime on the file to match the time at which this
1133 * message was received. Currently this is only set when copying
1134 * messages between mailboxes, so we test to ensure that it is
1137 if (msg->received) {
1140 ut.actime = msg->received;
1141 ut.modtime = msg->received;
1142 if (utime (full, &ut)) {
1144 ("maildir_commit_message(): unable to set time on file"));
1151 else if (errno != EEXIST) {
1152 mutt_perror (ctx->path);
1159 * commit a message to an MH folder.
1164 static int _mh_commit_message (MESSAGE * msg, CONTEXT * ctx, HEADER * hdr,
1170 unsigned int n, hi = 0;
1171 char path[_POSIX_PATH_MAX];
1174 if (safe_fclose (&msg->fp) != 0)
1177 if ((dirp = opendir (ctx->path)) == NULL) {
1178 mutt_perror (ctx->path);
1182 /* figure out what the next message number is */
1183 while ((de = readdir (dirp)) != NULL) {
1189 if (!isdigit ((unsigned char) *cp))
1202 * Now try to rename the file to the proper name.
1204 * Note: We may have to try multiple times, until we find a free
1210 snprintf (tmp, sizeof (tmp), "%d", hi);
1211 snprintf (path, sizeof (path), "%s/%s", ctx->path, tmp);
1212 if (safe_rename (msg->path, path) == 0) {
1214 str_replace (&hdr->path, tmp);
1218 else if (errno != EEXIST) {
1219 mutt_perror (ctx->path);
1224 mh_sequences_add_one (ctx, hi, !msg->flags.read, msg->flags.flagged,
1225 msg->flags.replied);
1229 static int mh_commit_message (MESSAGE * msg, CONTEXT * ctx, HEADER * hdr) {
1230 return _mh_commit_message (msg, ctx, hdr, 1);
1233 /* Sync a message in an MH folder.
1235 * This code is also used for attachment deletion in maildir
1239 static int mh_rewrite_message (CONTEXT * ctx, int msgno)
1241 HEADER *h = ctx->hdrs[msgno];
1246 char oldpath[_POSIX_PATH_MAX];
1247 char newpath[_POSIX_PATH_MAX];
1248 char partpath[_POSIX_PATH_MAX];
1250 long old_body_offset = h->content->offset;
1251 long old_body_length = h->content->length;
1252 long old_hdr_lines = h->lines;
1254 if ((dest = mx_open_new_message (ctx, h, 0)) == NULL)
1257 if ((rc = mutt_copy_message (dest->fp, ctx, h,
1258 M_CM_UPDATE, CH_UPDATE | CH_UPDATE_LEN)) == 0)
1260 snprintf (oldpath, _POSIX_PATH_MAX, "%s/%s", ctx->path, h->path);
1261 strfcpy (partpath, h->path, _POSIX_PATH_MAX);
1263 if (ctx->magic == M_MAILDIR)
1264 rc = maildir_commit_message (dest, ctx, h);
1266 rc = _mh_commit_message (dest, ctx, h, 0);
1268 mx_close_message (&dest);
1276 * Try to move the new message to the old place.
1279 * This is important when we are just updating flags.
1281 * Note that there is a race condition against programs which
1282 * use the first free slot instead of the maximum message
1283 * number. Mutt does _not_ behave like this.
1285 * Anyway, if this fails, the message is in the folder, so
1286 * all what happens is that a concurrently runnung mutt will
1287 * lose flag modifications.
1290 if (ctx->magic == M_MH && rc == 0) {
1291 snprintf (newpath, _POSIX_PATH_MAX, "%s/%s", ctx->path, h->path);
1292 if ((rc = safe_rename (newpath, oldpath)) == 0)
1293 str_replace (&h->path, partpath);
1297 mx_close_message (&dest);
1299 if (rc == -1 && restore) {
1300 h->content->offset = old_body_offset;
1301 h->content->length = old_body_length;
1302 h->lines = old_hdr_lines;
1305 mutt_free_body (&h->content->parts);
1309 static int mh_sync_message (CONTEXT * ctx, int msgno)
1311 HEADER *h = ctx->hdrs[msgno];
1313 if (h->attach_del ||
1314 (h->env && (h->env->refs_changed || h->env->irt_changed)))
1315 if (mh_rewrite_message (ctx, msgno) != 0)
1321 static int maildir_sync_message (CONTEXT * ctx, int msgno)
1323 HEADER *h = ctx->hdrs[msgno];
1325 if (h->attach_del ||
1326 (h->env && (h->env->refs_changed || h->env->irt_changed))) {
1327 /* when doing attachment deletion/rethreading, fall back to the MH case. */
1328 if (mh_rewrite_message (ctx, msgno) != 0)
1332 /* we just have to rename the file. */
1334 char newpath[_POSIX_PATH_MAX];
1335 char partpath[_POSIX_PATH_MAX];
1336 char fullpath[_POSIX_PATH_MAX];
1337 char oldpath[_POSIX_PATH_MAX];
1341 if ((p = strrchr (h->path, '/')) == NULL) {
1342 debug_print (1, ("%s: unable to find subdir!\n", h->path));
1346 strfcpy (newpath, p, sizeof (newpath));
1348 /* kill the previous flags */
1349 if ((p = strchr (newpath, ':')) != NULL)
1352 maildir_flags (suffix, sizeof (suffix), h);
1354 snprintf (partpath, sizeof (partpath), "%s/%s%s",
1355 (h->read || h->old) ? "cur" : "new", newpath, suffix);
1356 snprintf (fullpath, sizeof (fullpath), "%s/%s", ctx->path, partpath);
1357 snprintf (oldpath, sizeof (oldpath), "%s/%s", ctx->path, h->path);
1359 if (mutt_strcmp (fullpath, oldpath) == 0) {
1360 /* message hasn't really changed */
1364 /* record that the message is possibly marked as trashed on disk */
1365 h->trash = h->deleted;
1367 if (rename (oldpath, fullpath) != 0) {
1368 mutt_perror ("rename");
1371 str_replace (&h->path, partpath);
1376 static int mh_sync_mailbox (CONTEXT * ctx, int unused, int *index_hint)
1378 char path[_POSIX_PATH_MAX], tmp[_POSIX_PATH_MAX];
1383 #endif /* USE_HCACHE */
1385 if (ctx->magic == M_MH)
1386 i = mh_check_mailbox (ctx, index_hint, 0);
1388 i = maildir_check_mailbox (ctx, index_hint, 0);
1394 if (ctx->magic == M_MAILDIR)
1395 hc = mutt_hcache_open (HeaderCache, ctx->path);
1396 #endif /* USE_HCACHE */
1398 for (i = 0; i < ctx->msgcount; i++) {
1399 if (ctx->hdrs[i]->deleted
1400 && (ctx->magic != M_MAILDIR || !option (OPTMAILDIRTRASH))) {
1401 snprintf (path, sizeof (path), "%s/%s", ctx->path, ctx->hdrs[i]->path);
1402 if (ctx->magic == M_MAILDIR
1403 || (option (OPTMHPURGE) && ctx->magic == M_MH)) {
1405 if (ctx->magic == M_MAILDIR)
1406 mutt_hcache_delete (hc, ctx->hdrs[i]->path + 3,
1407 &maildir_hcache_keylen);
1408 #endif /* USE_HCACHE */
1411 else if (ctx->magic == M_MH) {
1412 /* MH just moves files out of the way when you delete them */
1413 if (*ctx->hdrs[i]->path != ',') {
1414 snprintf (tmp, sizeof (tmp), "%s/,%s", ctx->path,
1415 ctx->hdrs[i]->path);
1422 else if (ctx->hdrs[i]->changed || ctx->hdrs[i]->attach_del ||
1423 (ctx->magic == M_MAILDIR
1424 && (option (OPTMAILDIRTRASH) || ctx->hdrs[i]->trash)
1425 && (ctx->hdrs[i]->deleted != ctx->hdrs[i]->trash))) {
1426 if (ctx->magic == M_MAILDIR) {
1427 if (maildir_sync_message (ctx, i) == -1)
1431 if (mh_sync_message (ctx, i) == -1)
1438 if (ctx->magic == M_MAILDIR)
1439 mutt_hcache_close (hc);
1440 #endif /* USE_HCACHE */
1442 if (ctx->magic == M_MH)
1443 mh_update_sequences (ctx);
1445 /* XXX race condition? */
1447 maildir_update_mtime (ctx);
1449 /* adjust indices */
1452 for (i = 0, j = 0; i < ctx->msgcount; i++) {
1453 if (!ctx->hdrs[i]->deleted
1454 || (ctx->magic == M_MAILDIR && option (OPTMAILDIRTRASH)))
1455 ctx->hdrs[i]->index = j++;
1463 if (ctx->magic == M_MAILDIR)
1464 mutt_hcache_close (hc);
1465 #endif /* USE_HCACHE */
1469 static char *maildir_canon_filename (char *dest, const char *src, size_t l)
1473 if ((t = strrchr (src, '/')))
1476 strfcpy (dest, src, l);
1477 if ((u = strrchr (dest, ':')))
1483 static void maildir_update_tables (CONTEXT * ctx, int *index_hint)
1489 if (Sort != SORT_ORDER) {
1492 mutt_sort_headers (ctx, 1);
1496 old_count = ctx->msgcount;
1497 for (i = 0, j = 0; i < old_count; i++) {
1498 if (ctx->hdrs[i]->active && index_hint && *index_hint == i)
1501 if (ctx->hdrs[i]->active)
1502 ctx->hdrs[i]->index = j++;
1505 mx_update_tables (ctx, 0);
1506 mutt_clear_threads (ctx);
1509 static void maildir_update_flags (CONTEXT * ctx, HEADER * o, HEADER * n)
1511 /* save the global state here so we can reset it at the
1512 * end of list block if required.
1514 int context_changed = ctx->changed;
1516 /* user didn't modify this message. alter the flags to
1517 * match the current state on disk. This may not actually
1518 * do anything, but we can't tell right now. mutt_set_flag()
1519 * will just ignore the call if the status bits are
1520 * already properly set.
1522 mutt_set_flag (ctx, o, M_FLAG, n->flagged);
1523 mutt_set_flag (ctx, o, M_REPLIED, n->replied);
1524 mutt_set_flag (ctx, o, M_READ, n->read);
1525 mutt_set_flag (ctx, o, M_OLD, n->old);
1527 /* mutt_set_flag() will set this, but we don't need to
1528 * sync the changes we made because we just updated the
1529 * context to match the current on-disk state of the
1534 /* if the mailbox was not modified before we made these
1535 * changes, unset the changed flag since nothing needs to
1538 if (!context_changed)
1543 /* This function handles arrival of new mail and reopening of
1544 * maildir folders. The basic idea here is we check to see if either
1545 * the new or cur subdirectories have changed, and if so, we scan them
1546 * for the list of files. We check for newly added messages, and
1547 * then merge the flags messages we already knew about. We don't treat
1548 * either subdirectory differently, as mail could be copied directly into
1549 * the cur directory from another agent.
1551 static int maildir_check_mailbox (CONTEXT * ctx, int *index_hint, int unused)
1553 struct stat st_new; /* status of the "new" subdirectory */
1554 struct stat st_cur; /* status of the "cur" subdirectory */
1555 char buf[_POSIX_PATH_MAX];
1556 int changed = 0; /* bitmask representing which subdirectories
1557 have changed. 0x1 = new, 0x2 = cur */
1558 int occult = 0; /* messages were removed from the mailbox */
1559 int have_new = 0; /* messages were added to the mailbox */
1560 struct maildir *md; /* list of messages in the mailbox */
1561 struct maildir **last, *p;
1563 HASH *fnames; /* hash table for quickly looking up the base filename
1564 for a maildir message */
1566 if (!option (OPTCHECKNEW))
1569 snprintf (buf, sizeof (buf), "%s/new", ctx->path);
1570 if (stat (buf, &st_new) == -1)
1573 snprintf (buf, sizeof (buf), "%s/cur", ctx->path);
1574 if (stat (buf, &st_cur) == -1)
1577 /* determine which subdirectories need to be scanned */
1578 if (st_new.st_mtime > ctx->mtime)
1580 if (st_cur.st_mtime > ctx->mtime_cur)
1584 return 0; /* nothing to do */
1586 /* update the modification times on the mailbox */
1587 ctx->mtime_cur = st_cur.st_mtime;
1588 ctx->mtime = st_new.st_mtime;
1590 /* do a fast scan of just the filenames in
1591 * the subdirectories that have changed.
1596 maildir_parse_dir (ctx, &last, "new", NULL);
1598 maildir_parse_dir (ctx, &last, "cur", NULL);
1600 /* we create a hash table keyed off the canonical (sans flags) filename
1601 * of each message we scanned. This is used in the loop over the
1602 * existing messages below to do some correlation.
1604 fnames = hash_create (1031);
1606 for (p = md; p; p = p->next) {
1607 maildir_canon_filename (buf, p->h->path, sizeof (buf));
1608 p->canon_fname = safe_strdup (buf);
1609 hash_insert (fnames, p->canon_fname, p, 0);
1612 /* check for modifications and adjust flags */
1613 for (i = 0; i < ctx->msgcount; i++) {
1614 ctx->hdrs[i]->active = 0;
1615 maildir_canon_filename (buf, ctx->hdrs[i]->path, sizeof (buf));
1616 p = hash_find (fnames, buf);
1618 /* message already exists, merge flags */
1619 ctx->hdrs[i]->active = 1;
1621 /* check to see if the message has moved to a different
1622 * subdirectory. If so, update the associated filename.
1624 if (mutt_strcmp (ctx->hdrs[i]->path, p->h->path))
1625 str_replace (&ctx->hdrs[i]->path, p->h->path);
1627 /* if the user hasn't modified the flags on this message, update
1628 * the flags we just detected.
1630 if (!ctx->hdrs[i]->changed)
1631 maildir_update_flags (ctx, ctx->hdrs[i], p->h);
1633 if (ctx->hdrs[i]->deleted == ctx->hdrs[i]->trash)
1634 ctx->hdrs[i]->deleted = p->h->deleted;
1635 ctx->hdrs[i]->trash = p->h->trash;
1637 /* this is a duplicate of an existing header, so remove it */
1638 mutt_free_header (&p->h);
1640 /* This message was not in the list of messages we just scanned.
1641 * Check to see if we have enough information to know if the
1642 * message has disappeared out from underneath us.
1644 else if (((changed & 1) && (!strncmp (ctx->hdrs[i]->path, "new/", 4))) ||
1645 ((changed & 2) && (!strncmp (ctx->hdrs[i]->path, "cur/", 4)))) {
1646 /* This message disappeared, so we need to simulate a "reopen"
1647 * event. We know it disappeared because we just scanned the
1648 * subdirectory it used to reside in.
1653 /* This message resides in a subdirectory which was not
1654 * modified, so we assume that it is still present and
1657 ctx->hdrs[i]->active = 1;
1661 /* destroy the file name hash */
1662 hash_destroy (&fnames, NULL);
1664 /* If we didn't just get new mail, update the tables. */
1666 maildir_update_tables (ctx, index_hint);
1668 /* do any delayed parsing we need to do. */
1669 maildir_delayed_parsing (ctx, md);
1671 /* Incorporate new messages */
1672 have_new = maildir_move_to_context (ctx, &md);
1674 return occult ? M_REOPENED : (have_new ? M_NEW_MAIL : 0);
1678 * This function handles arrival of new mail and reopening of
1679 * mh/maildir folders. Things are getting rather complex because we
1680 * don't have a well-defined "mailbox order", so the tricks from
1681 * mbox.c and mx.c won't work here.
1683 * Don't change this code unless you _really_ understand what
1688 static int mh_check_mailbox (CONTEXT * ctx, int *index_hint, int unused)
1690 char buf[_POSIX_PATH_MAX];
1691 struct stat st, st_cur;
1692 short modified = 0, have_new = 0, occult = 0;
1693 struct maildir *md, *p;
1694 struct maildir **last = NULL;
1695 struct mh_sequences mhs;
1699 if (!option (OPTCHECKNEW))
1702 strfcpy (buf, ctx->path, sizeof (buf));
1703 if (stat (buf, &st) == -1)
1706 /* create .mh_sequences when there isn't one. */
1707 snprintf (buf, sizeof (buf), "%s/.mh_sequences", ctx->path);
1708 if ((i = stat (buf, &st_cur) == -1) && errno == ENOENT) {
1712 if (mh_mkstemp (ctx, &fp, &tmp) == 0) {
1714 if (safe_rename (tmp, buf) == -1)
1720 if (i == -1 && stat (buf, &st_cur) == -1)
1723 if (st.st_mtime > ctx->mtime || st_cur.st_mtime > ctx->mtime_cur)
1729 ctx->mtime_cur = st_cur.st_mtime;
1730 ctx->mtime = st.st_mtime;
1732 memset (&mhs, 0, sizeof (mhs));
1736 maildir_parse_dir (ctx, &last, NULL, NULL);
1737 mh_read_sequences (&mhs, ctx->path);
1738 mh_update_maildir (md, &mhs);
1739 mhs_free_sequences (&mhs);
1741 /* check for modifications and adjust flags */
1742 fnames = hash_create (1031);
1744 for (p = md; p; p = p->next)
1745 hash_insert (fnames, p->h->path, p, 0);
1747 for (i = 0; i < ctx->msgcount; i++) {
1748 ctx->hdrs[i]->active = 0;
1750 if ((p = hash_find (fnames, ctx->hdrs[i]->path)) && p->h &&
1751 (mutt_cmp_header (ctx->hdrs[i], p->h))) {
1752 ctx->hdrs[i]->active = 1;
1753 /* found the right message */
1754 if (!ctx->hdrs[i]->changed)
1755 maildir_update_flags (ctx, ctx->hdrs[i], p->h);
1757 mutt_free_header (&p->h);
1759 else /* message has disappeared */
1763 /* destroy the file name hash */
1765 hash_destroy (&fnames, NULL);
1767 /* If we didn't just get new mail, update the tables. */
1769 maildir_update_tables (ctx, index_hint);
1771 /* Incorporate new messages */
1772 have_new = maildir_move_to_context (ctx, &md);
1774 return occult ? M_REOPENED : (have_new ? M_NEW_MAIL : 0);
1781 * These functions try to find a message in a maildir folder when it
1782 * has moved under our feet. Note that this code is rather expensive, but
1783 * then again, it's called rarely.
1786 FILE *_maildir_open_find_message (const char *folder, const char *unique,
1787 const char *subfolder)
1789 char dir[_POSIX_PATH_MAX];
1790 char tunique[_POSIX_PATH_MAX];
1791 char fname[_POSIX_PATH_MAX];
1799 snprintf (dir, sizeof (dir), "%s/%s", folder, subfolder);
1801 if ((dp = opendir (dir)) == NULL) {
1806 while ((de = readdir (dp))) {
1807 maildir_canon_filename (tunique, de->d_name, sizeof (tunique));
1809 if (!mutt_strcmp (tunique, unique)) {
1810 snprintf (fname, sizeof (fname), "%s/%s/%s", folder, subfolder,
1812 fp = fopen (fname, "r"); /* __FOPEN_CHECKED__ */
1824 FILE *maildir_open_find_message (const char *folder, const char *msg)
1826 char unique[_POSIX_PATH_MAX];
1829 static unsigned int new_hits = 0, cur_hits = 0; /* simple dynamic optimization */
1831 maildir_canon_filename (unique, msg, sizeof (unique));
1834 _maildir_open_find_message (folder, unique,
1835 new_hits > cur_hits ? "new" : "cur"))
1836 || errno != ENOENT) {
1837 if (new_hits < UINT_MAX && cur_hits < UINT_MAX) {
1838 new_hits += (new_hits > cur_hits ? 1 : 0);
1839 cur_hits += (new_hits > cur_hits ? 0 : 1);
1845 _maildir_open_find_message (folder, unique,
1846 new_hits > cur_hits ? "cur" : "new"))
1847 || errno != ENOENT) {
1848 if (new_hits < UINT_MAX && cur_hits < UINT_MAX) {
1849 new_hits += (new_hits > cur_hits ? 0 : 1);
1850 cur_hits += (new_hits > cur_hits ? 1 : 0);
1862 * 1 if there are no messages in the mailbox
1863 * 0 if there are messages in the mailbox
1866 static int maildir_check_empty (const char *path)
1870 int r = 1; /* assume empty until we find a message */
1871 char realpath[_POSIX_PATH_MAX];
1874 /* Strategy here is to look for any file not beginning with a period */
1877 /* we do "cur" on the first iteration since its more likely that we'll
1878 * find old messages without having to scan both subdirs
1880 snprintf (realpath, sizeof (realpath), "%s/%s", path,
1881 iter == 0 ? "cur" : "new");
1882 if ((dp = opendir (realpath)) == NULL)
1884 while ((de = readdir (dp))) {
1885 if (*de->d_name != '.') {
1892 } while (r && iter < 2);
1899 * 1 if there are no messages in the mailbox
1900 * 0 if there are messages in the mailbox
1903 int mh_check_empty (const char *path)
1907 int r = 1; /* assume empty until we find a message */
1909 if ((dp = opendir (path)) == NULL)
1911 while ((de = readdir (dp))) {
1912 if (mh_valid_message (de->d_name)) {
1922 static int mh_is_magic (const char* path, struct stat* st) {
1923 char tmp[_POSIX_PATH_MAX];
1925 if (S_ISDIR (st->st_mode)) {
1926 snprintf (tmp, sizeof (tmp), "%s/.mh_sequences", path);
1927 if (access (tmp, F_OK) == 0)
1930 snprintf (tmp, sizeof (tmp), "%s/.xmhcache", path);
1931 if (access (tmp, F_OK) == 0)
1934 snprintf (tmp, sizeof (tmp), "%s/.mew_cache", path);
1935 if (access (tmp, F_OK) == 0)
1938 snprintf (tmp, sizeof (tmp), "%s/.mew-cache", path);
1939 if (access (tmp, F_OK) == 0)
1942 snprintf (tmp, sizeof (tmp), "%s/.sylpheed_cache", path);
1943 if (access (tmp, F_OK) == 0)
1947 * ok, this isn't an mh folder, but mh mode can be used to read
1948 * Usenet news from the spool. ;-)
1951 snprintf (tmp, sizeof (tmp), "%s/.overview", path);
1952 if (access (tmp, F_OK) == 0)
1958 static int maildir_is_magic (const char* path, struct stat* st) {
1960 char tmp[_POSIX_PATH_MAX];
1962 if (S_ISDIR (st->st_mode)) {
1963 snprintf (tmp, sizeof (tmp), "%s/cur", path);
1964 if (stat (tmp, &sb) == 0 && S_ISDIR (sb.st_mode))
1970 /* routines common to maildir and mh */
1971 static mx_t* reg_mx (void) {
1972 mx_t* fmt = safe_calloc (1, sizeof (mx_t));
1974 fmt->mx_access = access;
1975 fmt->mx_sync_mailbox = mh_sync_mailbox;
1979 static int mh_commit (MESSAGE* msg, CONTEXT* ctx) {
1980 return (mh_commit_message (msg, ctx, NULL));
1983 static int maildir_commit (MESSAGE* msg, CONTEXT* ctx) {
1984 return (maildir_commit_message (msg, ctx, NULL));
1987 mx_t* mh_reg_mx (void) {
1988 mx_t* fmt = reg_mx ();
1990 fmt->mx_check_empty = mh_check_empty;
1991 fmt->mx_is_magic = mh_is_magic;
1992 fmt->mx_open_mailbox = mh_read_dir;
1993 fmt->mx_open_new_message = mh_open_new_message;
1994 fmt->mx_check_mailbox = mh_check_mailbox;
1995 fmt->mx_commit_message = mh_commit;
1999 mx_t* maildir_reg_mx (void) {
2000 mx_t* fmt = reg_mx ();
2001 fmt->type = M_MAILDIR;
2002 fmt->mx_check_empty = maildir_check_empty;
2003 fmt->mx_is_magic = maildir_is_magic;
2004 fmt->mx_open_mailbox = maildir_read_dir;
2005 fmt->mx_open_new_message = maildir_open_new_message;
2006 fmt->mx_check_mailbox = maildir_check_mailbox;
2007 fmt->mx_commit_message = maildir_commit;