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/str.h>
22 #include <lib-lib/macros.h>
23 #include <lib-lib/file.h>
35 #include "lib/debug.h"
38 #include <sys/types.h>
58 unsigned header_parsed:1;
61 #endif /* USE_INODESORT */
70 /* mh_sequences support */
72 #define MH_SEQ_UNSEEN (1 << 0)
73 #define MH_SEQ_REPLIED (1 << 1)
74 #define MH_SEQ_FLAGGED (1 << 2)
77 static int maildir_check_empty (const char*);
78 static int maildir_check_mailbox (CONTEXT*, int*, int);
79 static int mh_check_mailbox (CONTEXT*, int*, int);
81 static void mhs_alloc (struct mh_sequences *mhs, int i)
86 if (i > mhs->max || !mhs->flags) {
88 p_realloc(&mhs->flags, newmax + 1);
89 for (j = mhs->max + 1; j <= newmax; j++)
96 static void mhs_free_sequences (struct mh_sequences *mhs)
98 p_delete(&mhs->flags);
101 static short mhs_check (struct mh_sequences *mhs, int i)
103 if (!mhs->flags || i > mhs->max)
106 return mhs->flags[i];
109 static short mhs_set (struct mh_sequences *mhs, int i, short f)
113 return mhs->flags[i];
120 static short mhs_unset (struct mh_sequences *mhs, int i, short f)
124 return mhs->flags[i];
129 static void mh_read_token (char *t, int *first, int *last)
133 if ((p = strchr (t, '-'))) {
139 *first = *last = atoi (t);
142 static void mh_read_sequences (struct mh_sequences *mhs, const char *path)
153 char pathname[_POSIX_PATH_MAX];
155 snprintf (pathname, sizeof (pathname), "%s/.mh_sequences", path);
157 if (!(fp = fopen (pathname, "r")))
160 while ((buff = mutt_read_line (buff, &sz, fp, &line))) {
161 if (!(t = strtok (buff, " \t:")))
164 if (!m_strcmp(t, MhUnseen))
166 else if (!m_strcmp(t, MhFlagged))
168 else if (!m_strcmp(t, MhReplied))
170 else /* unknown sequence */
173 while ((t = strtok (NULL, " \t:"))) {
174 mh_read_token (t, &first, &last);
175 for (; first <= last; first++)
176 mhs_set (mhs, first, f);
184 int mh_buffy (const char *path)
187 struct mh_sequences mhs;
191 mh_read_sequences (&mhs, path);
192 for (i = 0; !r && i <= mhs.max; i++)
193 if (mhs_check (&mhs, i) & MH_SEQ_UNSEEN)
195 mhs_free_sequences (&mhs);
199 static int mh_mkstemp (CONTEXT * dest, FILE ** fp, char **tgt)
202 char path[_POSIX_PATH_MAX];
205 snprintf (path, _POSIX_PATH_MAX, "%s/.mutt-%s-%d-%d",
206 dest->path, NONULL (Hostname), (int) getpid (), Counter++);
208 if ((fd = open (path, O_WRONLY | O_EXCL | O_CREAT, 0666)) == -1) {
209 if (errno != EEXIST) {
215 *tgt = m_strdup(path);
220 if ((*fp = fdopen (fd, "w")) == NULL) {
230 static void mhs_write_one_sequence (FILE * fp, struct mh_sequences *mhs,
231 short f, const char *tag)
236 fprintf (fp, "%s:", tag);
241 for (i = 0; i <= mhs->max; i++) {
242 if ((mhs_check (mhs, i) & f)) {
248 else if (first >= 0) {
250 fprintf (fp, " %d", first);
252 fprintf (fp, " %d-%d", first, last);
261 fprintf (fp, " %d", first);
263 fprintf (fp, " %d-%d", first, last);
269 /* XXX - we don't currently remove deleted messages from sequences we don't know. Should we? */
271 void mh_update_sequences (CONTEXT * ctx)
275 char sequences[_POSIX_PATH_MAX];
287 char seq_unseen[STRING];
288 char seq_replied[STRING];
289 char seq_flagged[STRING];
292 struct mh_sequences mhs;
296 snprintf (seq_unseen, sizeof (seq_unseen), "%s:", NONULL (MhUnseen));
297 snprintf (seq_replied, sizeof (seq_replied), "%s:", NONULL (MhReplied));
298 snprintf (seq_flagged, sizeof (seq_flagged), "%s:", NONULL (MhFlagged));
300 if (mh_mkstemp (ctx, &nfp, &tmpfname) != 0) {
305 snprintf (sequences, sizeof (sequences), "%s/.mh_sequences", ctx->path);
308 /* first, copy unknown sequences */
309 if ((ofp = fopen (sequences, "r"))) {
310 while ((buff = mutt_read_line (buff, &s, ofp, &l))) {
311 if (!str_ncmp (buff, seq_unseen, m_strlen(seq_unseen)))
313 if (!str_ncmp (buff, seq_flagged, m_strlen(seq_flagged)))
315 if (!str_ncmp (buff, seq_replied, m_strlen(seq_replied)))
318 fprintf (nfp, "%s\n", buff);
323 /* now, update our unseen, flagged, and replied sequences */
324 for (l = 0; l < ctx->msgcount; l++) {
325 if (ctx->hdrs[l]->deleted)
328 if ((p = strrchr (ctx->hdrs[l]->path, '/')))
331 p = ctx->hdrs[l]->path;
335 if (!ctx->hdrs[l]->read) {
336 mhs_set (&mhs, i, MH_SEQ_UNSEEN);
339 if (ctx->hdrs[l]->flagged) {
340 mhs_set (&mhs, i, MH_SEQ_FLAGGED);
343 if (ctx->hdrs[l]->replied) {
344 mhs_set (&mhs, i, MH_SEQ_REPLIED);
349 /* write out the new sequences */
351 mhs_write_one_sequence (nfp, &mhs, MH_SEQ_UNSEEN, NONULL (MhUnseen));
353 mhs_write_one_sequence (nfp, &mhs, MH_SEQ_FLAGGED, NONULL (MhFlagged));
355 mhs_write_one_sequence (nfp, &mhs, MH_SEQ_REPLIED, NONULL (MhReplied));
357 mhs_free_sequences (&mhs);
360 /* try to commit the changes - no guarantee here */
364 if (safe_rename (tmpfname, sequences) != 0) {
365 /* report an error? */
372 static void mh_sequences_add_one (CONTEXT * ctx, int n, short unseen,
373 short flagged, short replied)
375 short unseen_done = 0;
376 short flagged_done = 0;
377 short replied_done = 0;
379 FILE *ofp = NULL, *nfp = NULL;
382 char sequences[_POSIX_PATH_MAX];
384 char seq_unseen[STRING];
385 char seq_replied[STRING];
386 char seq_flagged[STRING];
392 if (mh_mkstemp (ctx, &nfp, &tmpfname) == -1)
395 snprintf (seq_unseen, sizeof (seq_unseen), "%s:", NONULL (MhUnseen));
396 snprintf (seq_replied, sizeof (seq_replied), "%s:", NONULL (MhReplied));
397 snprintf (seq_flagged, sizeof (seq_flagged), "%s:", NONULL (MhFlagged));
399 snprintf (sequences, sizeof (sequences), "%s/.mh_sequences", ctx->path);
400 if ((ofp = fopen (sequences, "r"))) {
401 while ((buff = mutt_read_line (buff, &sz, ofp, &line))) {
402 if (unseen && !strncmp (buff, seq_unseen, m_strlen(seq_unseen))) {
403 fprintf (nfp, "%s %d\n", buff, n);
407 && !strncmp (buff, seq_flagged, m_strlen(seq_flagged))) {
408 fprintf (nfp, "%s %d\n", buff, n);
412 && !strncmp (buff, seq_replied, m_strlen(seq_replied))) {
413 fprintf (nfp, "%s %d\n", buff, n);
417 fprintf (nfp, "%s\n", buff);
423 if (!unseen_done && unseen)
424 fprintf (nfp, "%s: %d\n", NONULL (MhUnseen), n);
425 if (!flagged_done && flagged)
426 fprintf (nfp, "%s: %d\n", NONULL (MhFlagged), n);
427 if (!replied_done && replied)
428 fprintf (nfp, "%s: %d\n", NONULL (MhReplied), n);
433 if (safe_rename (tmpfname, sequences) != 0)
439 static void mh_update_maildir (struct maildir *md, struct mh_sequences *mhs)
445 for (; md; md = md->next) {
446 if ((p = strrchr (md->h->path, '/')))
452 f = mhs_check (mhs, i);
454 md->h->read = (f & MH_SEQ_UNSEEN) ? 0 : 1;
455 md->h->flagged = (f & MH_SEQ_FLAGGED) ? 1 : 0;
456 md->h->replied = (f & MH_SEQ_REPLIED) ? 1 : 0;
460 /* maildir support */
462 static void maildir_free_entry (struct maildir **md)
467 p_delete(&(*md)->canon_fname);
469 mutt_free_header (&(*md)->h);
474 static void maildir_free_maildir (struct maildir **md)
476 struct maildir *p, *q;
481 for (p = *md; p; p = q) {
483 maildir_free_entry (&p);
487 static void maildir_parse_flags (HEADER * h, const char *path)
495 if ((p = strrchr (path, ':')) != NULL && str_ncmp (p + 1, "2,", 2) == 0) {
498 str_replace (&h->maildir_flags, p);
499 q = h->maildir_flags;
513 case 'R': /* replied */
518 case 'T': /* trashed */
531 if (q == h->maildir_flags)
532 p_delete(&h->maildir_flags);
537 static void maildir_update_mtime (CONTEXT * ctx)
539 char buf[_POSIX_PATH_MAX];
542 if (ctx->magic == M_MAILDIR) {
543 snprintf (buf, sizeof (buf), "%s/%s", ctx->path, "cur");
544 if (stat (buf, &st) == 0)
545 ctx->mtime_cur = st.st_mtime;
546 snprintf (buf, sizeof (buf), "%s/%s", ctx->path, "new");
549 snprintf (buf, sizeof (buf), "%s/.mh_sequences", ctx->path);
550 if (stat (buf, &st) == 0)
551 ctx->mtime_cur = st.st_mtime;
553 strfcpy (buf, ctx->path, sizeof (buf));
556 if (stat (buf, &st) == 0)
557 ctx->mtime = st.st_mtime;
561 * Actually parse a maildir message. This may also be used to fill
562 * out a fake header structure generated by lazy maildir parsing.
564 static HEADER *maildir_parse_message (int magic, const char *fname,
565 int is_old, HEADER * _h)
571 if ((f = fopen (fname, "r")) != NULL) {
573 h = mutt_new_header ();
574 h->env = mutt_read_rfc822_header (f, h, 0, 0);
576 fstat (fileno (f), &st);
580 h->received = h->date_sent;
582 if (h->content->length <= 0)
583 h->content->length = st.st_size - h->content->offset;
587 if (magic == M_MAILDIR) {
589 * maildir stores its flags in the filename, so ignore the
590 * flags in the header of the message
594 maildir_parse_flags (h, fname);
602 * Note that this routine will _not_ modify the context given by
605 * It's used in the first parsing pass on maildir and MH folders.
606 * In the MH case, this means full parsing of the folder. In the
607 * maildir case, it means that we only look at flags, and create a
608 * fake HEADER structure, which may later be filled in by
609 * maildir_parse_message(), when called from
610 * maildir_delayed_parsing().
614 static int maildir_parse_entry (CONTEXT * ctx, struct maildir ***last,
615 const char *subdir, const char *fname,
616 int *count, int is_old, ino_t inode)
618 struct maildir *entry;
620 char buf[_POSIX_PATH_MAX];
623 snprintf (buf, sizeof (buf), "%s/%s/%s", ctx->path, subdir, fname);
625 snprintf (buf, sizeof (buf), "%s/%s", ctx->path, fname);
627 if (ctx->magic == M_MH)
628 h = maildir_parse_message (ctx->magic, buf, is_old, NULL);
630 h = mutt_new_header ();
632 maildir_parse_flags (h, buf);
638 if (!ctx->quiet && ReadInc && ((*count % ReadInc) == 0 || *count == 1))
639 mutt_message (_("Reading %s... %d"), ctx->path, *count);
643 snprintf (buf, sizeof (buf), "%s/%s", subdir, fname);
644 h->path = m_strdup(buf);
647 h->path = m_strdup(fname);
649 entry = p_new(struct maildir, 1);
651 entry->header_parsed = (ctx->magic == M_MH);
653 entry->inode = inode;
654 #endif /* USE_INODESORT */
656 *last = &entry->next;
666 /* Ignore the garbage files. A valid MH message consists of only
667 * digits. Deleted message get moved to a filename with a comma before
671 int mh_valid_message (const char *s)
674 if (!isdigit ((unsigned char) *s))
680 static int maildir_parse_dir (CONTEXT * ctx, struct maildir ***last,
681 const char *subdir, int *count)
685 char buf[_POSIX_PATH_MAX];
689 snprintf (buf, sizeof (buf), "%s/%s", ctx->path, subdir);
690 is_old = (m_strcmp("cur", subdir) == 0);
693 strfcpy (buf, ctx->path, sizeof (buf));
695 if ((dirp = opendir (buf)) == NULL)
698 while ((de = readdir (dirp)) != NULL) {
700 if ((ctx->magic == M_MH && !mh_valid_message (de->d_name))
701 || (ctx->magic == M_MAILDIR && *de->d_name == '.'))
704 /* FOO - really ignore the return value? */
706 debug_print (2, ("parsing %s\n", de->d_name));
707 maildir_parse_entry (ctx, last, subdir, de->d_name, count, is_old,
708 #if HAVE_DIRENT_D_INO
720 static int maildir_add_to_context (CONTEXT * ctx, struct maildir *md)
722 int oldmsgcount = ctx->msgcount;
726 debug_print (2, ("considering %s\n", NONULL (md->canon_fname)));
729 debug_print (2, ("flags: %s%s%s%s%s\n", md->h->flagged ? "f" : "",
730 md->h->deleted ? "D" : "", md->h->replied ? "r" : "",
731 md->h->old ? "O" : "", md->h->read ? "R" : ""));
732 if (ctx->msgcount == ctx->hdrmax)
733 mx_alloc_memory (ctx);
735 ctx->hdrs[ctx->msgcount] = md->h;
736 ctx->hdrs[ctx->msgcount]->index = ctx->msgcount;
738 md->h->content->length + md->h->content->offset -
739 md->h->content->hdr_offset;
747 if (ctx->msgcount > oldmsgcount) {
748 mx_update_context (ctx, ctx->msgcount - oldmsgcount);
754 static int maildir_move_to_context (CONTEXT * ctx, struct maildir **md)
758 r = maildir_add_to_context (ctx, *md);
759 maildir_free_maildir (md);
765 * Merge two maildir lists according to the inode numbers.
767 static struct maildir *maildir_merge_inode (struct maildir *left,
768 struct maildir *right)
770 struct maildir *head;
771 struct maildir *tail;
774 if (left->inode < right->inode) {
792 while (left && right) {
793 if (left->inode < right->inode) {
815 * Sort maildir list according to inode.
817 static struct maildir *maildir_sort_inode (struct maildir *list)
819 struct maildir *left = list;
820 struct maildir *right = list;
822 if (!list || !list->next) {
827 while (list && list->next) {
829 list = list->next->next;
836 left = maildir_sort_inode (left);
837 right = maildir_sort_inode (right);
838 return maildir_merge_inode (left, right);
840 #endif /* USE_INODESORT */
843 static size_t maildir_hcache_keylen (const char *fn)
845 const char *p = strchr (fn, ':');
847 return p ? (size_t) (p - fn) : m_strlen(fn);
852 * This function does the second parsing pass for a maildir-style
855 void maildir_delayed_parsing (CONTEXT * ctx, struct maildir *md)
858 char fn[_POSIX_PATH_MAX];
864 struct timeval *when = NULL;
865 struct stat lastchanged;
868 hc = mutt_hcache_open (HeaderCache, ctx->path);
871 for (p = md, count = 0; p; p = p->next, count++) {
872 if (!(p && p->h && !p->header_parsed))
876 data = mutt_hcache_fetch (hc, p->h->path + 3, &maildir_hcache_keylen);
877 when = (struct timeval *) data;
880 if (!ctx->quiet && ReadInc && ((count % ReadInc) == 0 || count == 1))
881 mutt_message (_("Reading %s... %d"), ctx->path, count);
882 snprintf (fn, sizeof (fn), "%s/%s", ctx->path, p->h->path);
885 if (option (OPTHCACHEVERIFY)) {
886 ret = stat (fn, &lastchanged);
889 lastchanged.st_mtime = 0;
893 if (data != NULL && !ret && lastchanged.st_mtime <= when->tv_sec) {
894 p->h = mutt_hcache_restore ((unsigned char *) data, &p->h);
895 maildir_parse_flags (p->h, fn);
899 if (maildir_parse_message (ctx->magic, fn, p->h->old, p->h)) {
900 p->header_parsed = 1;
901 maildir_parse_flags (p->h, fn);
903 mutt_hcache_store (hc, p->h->path + 3, p->h, 0, &maildir_hcache_keylen);
907 mutt_free_header (&p->h);
913 mutt_hcache_close (hc);
917 /* Read a MH/maildir style mailbox.
920 * ctx [IN/OUT] context for this mailbox
921 * subdir [IN] NULL for MH mailboxes, otherwise the subdir of the
922 * maildir mailbox to read from
924 static int _mh_read_dir (CONTEXT * ctx, const char *subdir)
927 struct mh_sequences mhs;
928 struct maildir **last;
934 maildir_update_mtime (ctx);
939 if (maildir_parse_dir (ctx, &last, subdir, &count) == -1)
942 if (ctx->magic == M_MH) {
943 mh_read_sequences (&mhs, ctx->path);
944 mh_update_maildir (md, &mhs);
945 mhs_free_sequences (&mhs);
949 md = maildir_sort_inode (md);
950 #endif /* USE_INODESORT */
952 if (ctx->magic == M_MAILDIR)
953 maildir_delayed_parsing (ctx, md);
955 maildir_move_to_context (ctx, &md);
959 static int mh_read_dir (CONTEXT* ctx) {
960 return (_mh_read_dir (ctx, NULL));
963 /* read a maildir style mailbox */
964 static int maildir_read_dir (CONTEXT * ctx)
966 /* maildir looks sort of like MH, except that there are two subdirectories
967 * of the main folder path from which to read messages
969 if (_mh_read_dir (ctx, "new") == -1 || _mh_read_dir (ctx, "cur") == -1)
976 * Open a new (temporary) message in an MH folder.
979 static int mh_open_new_message (MESSAGE * msg, CONTEXT * dest, HEADER * hdr)
981 return mh_mkstemp (dest, &msg->fp, &msg->path);
984 int ch_compar (const void *a, const void *b)
986 return (int) (*((const char *) a) - *((const char *) b));
989 static void maildir_flags (char *dest, size_t destlen, HEADER * hdr)
994 * The maildir specification requires that all files in the cur
995 * subdirectory have the :unique string appeneded, regardless of whether
996 * or not there are any flags. If .old is set, we know that this message
997 * will end up in the cur directory, so we include it in the following
998 * test even though there is no associated flag.
1002 && (hdr->flagged || hdr->replied || hdr->read || hdr->deleted
1003 || hdr->old || hdr->maildir_flags)) {
1004 char tmp[LONG_STRING];
1006 snprintf (tmp, sizeof (tmp),
1008 hdr->flagged ? "F" : "",
1009 hdr->replied ? "R" : "",
1010 hdr->read ? "S" : "", hdr->deleted ? "T" : "",
1011 NONULL (hdr->maildir_flags));
1012 if (hdr->maildir_flags)
1013 qsort (tmp, m_strlen(tmp), 1, ch_compar);
1014 snprintf (dest, destlen, ":2,%s", tmp);
1020 * Open a new (temporary) message in a maildir folder.
1022 * Note that this uses _almost_ the maildir file name format, but
1023 * with a {cur,new} prefix.
1027 static int maildir_open_new_message (MESSAGE * msg, CONTEXT * dest, HEADER * hdr)
1030 char path[_POSIX_PATH_MAX];
1035 short deleted = hdr->deleted;
1039 maildir_flags (suffix, sizeof (suffix), hdr);
1041 hdr->deleted = deleted;
1046 if (hdr && (hdr->read || hdr->old))
1047 strfcpy (subdir, "cur", sizeof (subdir));
1049 strfcpy (subdir, "new", sizeof (subdir));
1052 snprintf (path, _POSIX_PATH_MAX, "%s/tmp/%s.%ld.%u_%d.%s%s",
1053 dest->path, subdir, (long) time (NULL),
1054 (unsigned int) getpid (), Counter++, NONULL (Hostname), suffix);
1056 debug_print (2, ("trying %s.\n", path));
1059 if ((fd = open (path, O_WRONLY | O_EXCL | O_CREAT, 0666)) == -1) {
1060 if (errno != EEXIST) {
1066 debug_print (2, ("success.\n"));
1067 msg->path = m_strdup(path);
1072 if ((msg->fp = fdopen (fd, "w")) == NULL) {
1073 p_delete(&msg->path);
1085 * Commit a message to a maildir folder.
1087 * msg->path contains the file name of a file in tmp/. We take the
1088 * flags from this file's name.
1090 * ctx is the mail folder we commit to.
1092 * hdr is a header structure to which we write the message's new
1093 * file name. This is used in the mh and maildir folder synch
1094 * routines. When this routine is invoked from mx_commit_message,
1097 * msg->path looks like this:
1099 * tmp/{cur,new}.mutt-HOSTNAME-PID-COUNTER:flags
1101 * See also maildir_open_new_message().
1105 static int maildir_commit_message (MESSAGE * msg, CONTEXT * ctx, HEADER * hdr)
1109 char path[_POSIX_PATH_MAX];
1110 char full[_POSIX_PATH_MAX];
1113 if (safe_fclose (&msg->fp) != 0)
1116 /* extract the subdir */
1117 s = strrchr (msg->path, '/') + 1;
1118 strfcpy (subdir, s, 4);
1120 /* extract the flags */
1121 if ((s = strchr (s, ':')))
1122 strfcpy (suffix, s, sizeof (suffix));
1126 /* construct a new file name. */
1128 snprintf (path, _POSIX_PATH_MAX, "%s/%ld.%u_%d.%s%s", subdir,
1129 (long) time (NULL), (unsigned int) getpid (), Counter++,
1130 NONULL (Hostname), suffix);
1131 snprintf (full, _POSIX_PATH_MAX, "%s/%s", ctx->path, path);
1133 debug_print (2, ("renaming %s to %s.\n", msg->path, full));
1135 if (safe_rename (msg->path, full) == 0) {
1137 str_replace (&hdr->path, path);
1138 p_delete(&msg->path);
1141 * Adjust the mtime on the file to match the time at which this
1142 * message was received. Currently this is only set when copying
1143 * messages between mailboxes, so we test to ensure that it is
1146 if (msg->received) {
1149 ut.actime = msg->received;
1150 ut.modtime = msg->received;
1151 if (utime (full, &ut)) {
1153 ("maildir_commit_message(): unable to set time on file"));
1160 else if (errno != EEXIST) {
1161 mutt_perror (ctx->path);
1168 * commit a message to an MH folder.
1173 static int _mh_commit_message (MESSAGE * msg, CONTEXT * ctx, HEADER * hdr,
1179 unsigned int n, hi = 0;
1180 char path[_POSIX_PATH_MAX];
1183 if (safe_fclose (&msg->fp) != 0)
1186 if ((dirp = opendir (ctx->path)) == NULL) {
1187 mutt_perror (ctx->path);
1191 /* figure out what the next message number is */
1192 while ((de = readdir (dirp)) != NULL) {
1198 if (!isdigit ((unsigned char) *cp))
1211 * Now try to rename the file to the proper name.
1213 * Note: We may have to try multiple times, until we find a free
1219 snprintf (tmp, sizeof (tmp), "%d", hi);
1220 snprintf (path, sizeof (path), "%s/%s", ctx->path, tmp);
1221 if (safe_rename (msg->path, path) == 0) {
1223 str_replace (&hdr->path, tmp);
1224 p_delete(&msg->path);
1227 else if (errno != EEXIST) {
1228 mutt_perror (ctx->path);
1233 mh_sequences_add_one (ctx, hi, !msg->flags.read, msg->flags.flagged,
1234 msg->flags.replied);
1238 static int mh_commit_message (MESSAGE * msg, CONTEXT * ctx, HEADER * hdr) {
1239 return _mh_commit_message (msg, ctx, hdr, 1);
1242 /* Sync a message in an MH folder.
1244 * This code is also used for attachment deletion in maildir
1248 static int mh_rewrite_message (CONTEXT * ctx, int msgno)
1250 HEADER *h = ctx->hdrs[msgno];
1255 char oldpath[_POSIX_PATH_MAX];
1256 char newpath[_POSIX_PATH_MAX];
1257 char partpath[_POSIX_PATH_MAX];
1259 long old_body_offset = h->content->offset;
1260 long old_body_length = h->content->length;
1261 long old_hdr_lines = h->lines;
1263 if ((dest = mx_open_new_message (ctx, h, 0)) == NULL)
1266 if ((rc = mutt_copy_message (dest->fp, ctx, h,
1267 M_CM_UPDATE, CH_UPDATE | CH_UPDATE_LEN)) == 0)
1269 snprintf (oldpath, _POSIX_PATH_MAX, "%s/%s", ctx->path, h->path);
1270 strfcpy (partpath, h->path, _POSIX_PATH_MAX);
1272 if (ctx->magic == M_MAILDIR)
1273 rc = maildir_commit_message (dest, ctx, h);
1275 rc = _mh_commit_message (dest, ctx, h, 0);
1277 mx_close_message (&dest);
1285 * Try to move the new message to the old place.
1288 * This is important when we are just updating flags.
1290 * Note that there is a race condition against programs which
1291 * use the first free slot instead of the maximum message
1292 * number. Mutt does _not_ behave like this.
1294 * Anyway, if this fails, the message is in the folder, so
1295 * all what happens is that a concurrently runnung mutt will
1296 * lose flag modifications.
1299 if (ctx->magic == M_MH && rc == 0) {
1300 snprintf (newpath, _POSIX_PATH_MAX, "%s/%s", ctx->path, h->path);
1301 if ((rc = safe_rename (newpath, oldpath)) == 0)
1302 str_replace (&h->path, partpath);
1306 mx_close_message (&dest);
1308 if (rc == -1 && restore) {
1309 h->content->offset = old_body_offset;
1310 h->content->length = old_body_length;
1311 h->lines = old_hdr_lines;
1314 mutt_free_body (&h->content->parts);
1318 static int mh_sync_message (CONTEXT * ctx, int msgno)
1320 HEADER *h = ctx->hdrs[msgno];
1322 if (h->attach_del ||
1323 (h->env && (h->env->refs_changed || h->env->irt_changed)))
1324 if (mh_rewrite_message (ctx, msgno) != 0)
1330 static int maildir_sync_message (CONTEXT * ctx, int msgno)
1332 HEADER *h = ctx->hdrs[msgno];
1334 if (h->attach_del ||
1335 (h->env && (h->env->refs_changed || h->env->irt_changed))) {
1336 /* when doing attachment deletion/rethreading, fall back to the MH case. */
1337 if (mh_rewrite_message (ctx, msgno) != 0)
1341 /* we just have to rename the file. */
1343 char newpath[_POSIX_PATH_MAX];
1344 char partpath[_POSIX_PATH_MAX];
1345 char fullpath[_POSIX_PATH_MAX];
1346 char oldpath[_POSIX_PATH_MAX];
1350 if ((p = strrchr (h->path, '/')) == NULL) {
1351 debug_print (1, ("%s: unable to find subdir!\n", h->path));
1355 strfcpy (newpath, p, sizeof (newpath));
1357 /* kill the previous flags */
1358 if ((p = strchr (newpath, ':')) != NULL)
1361 maildir_flags (suffix, sizeof (suffix), h);
1363 snprintf (partpath, sizeof (partpath), "%s/%s%s",
1364 (h->read || h->old) ? "cur" : "new", newpath, suffix);
1365 snprintf (fullpath, sizeof (fullpath), "%s/%s", ctx->path, partpath);
1366 snprintf (oldpath, sizeof (oldpath), "%s/%s", ctx->path, h->path);
1368 if (m_strcmp(fullpath, oldpath) == 0) {
1369 /* message hasn't really changed */
1373 /* record that the message is possibly marked as trashed on disk */
1374 h->trash = h->deleted;
1376 if (rename (oldpath, fullpath) != 0) {
1377 mutt_perror ("rename");
1380 str_replace (&h->path, partpath);
1385 static int mh_sync_mailbox (CONTEXT * ctx, int unused, int *index_hint)
1387 char path[_POSIX_PATH_MAX], tmp[_POSIX_PATH_MAX];
1392 #endif /* USE_HCACHE */
1394 if (ctx->magic == M_MH)
1395 i = mh_check_mailbox (ctx, index_hint, 0);
1397 i = maildir_check_mailbox (ctx, index_hint, 0);
1403 if (ctx->magic == M_MAILDIR)
1404 hc = mutt_hcache_open (HeaderCache, ctx->path);
1405 #endif /* USE_HCACHE */
1407 for (i = 0; i < ctx->msgcount; i++) {
1408 if (ctx->hdrs[i]->deleted
1409 && (ctx->magic != M_MAILDIR || !option (OPTMAILDIRTRASH))) {
1410 snprintf (path, sizeof (path), "%s/%s", ctx->path, ctx->hdrs[i]->path);
1411 if (ctx->magic == M_MAILDIR
1412 || (option (OPTMHPURGE) && ctx->magic == M_MH)) {
1414 if (ctx->magic == M_MAILDIR)
1415 mutt_hcache_delete (hc, ctx->hdrs[i]->path + 3,
1416 &maildir_hcache_keylen);
1417 #endif /* USE_HCACHE */
1420 else if (ctx->magic == M_MH) {
1421 /* MH just moves files out of the way when you delete them */
1422 if (*ctx->hdrs[i]->path != ',') {
1423 snprintf (tmp, sizeof (tmp), "%s/,%s", ctx->path,
1424 ctx->hdrs[i]->path);
1431 else if (ctx->hdrs[i]->changed || ctx->hdrs[i]->attach_del ||
1432 (ctx->magic == M_MAILDIR
1433 && (option (OPTMAILDIRTRASH) || ctx->hdrs[i]->trash)
1434 && (ctx->hdrs[i]->deleted != ctx->hdrs[i]->trash))) {
1435 if (ctx->magic == M_MAILDIR) {
1436 if (maildir_sync_message (ctx, i) == -1)
1440 if (mh_sync_message (ctx, i) == -1)
1447 if (ctx->magic == M_MAILDIR)
1448 mutt_hcache_close (hc);
1449 #endif /* USE_HCACHE */
1451 if (ctx->magic == M_MH)
1452 mh_update_sequences (ctx);
1454 /* XXX race condition? */
1456 maildir_update_mtime (ctx);
1458 /* adjust indices */
1461 for (i = 0, j = 0; i < ctx->msgcount; i++) {
1462 if (!ctx->hdrs[i]->deleted
1463 || (ctx->magic == M_MAILDIR && option (OPTMAILDIRTRASH)))
1464 ctx->hdrs[i]->index = j++;
1472 if (ctx->magic == M_MAILDIR)
1473 mutt_hcache_close (hc);
1474 #endif /* USE_HCACHE */
1478 static char *maildir_canon_filename (char *dest, const char *src, size_t l)
1482 if ((t = strrchr (src, '/')))
1485 strfcpy (dest, src, l);
1486 if ((u = strrchr (dest, ':')))
1492 static void maildir_update_tables (CONTEXT * ctx, int *index_hint)
1498 if (Sort != SORT_ORDER) {
1501 mutt_sort_headers (ctx, 1);
1505 old_count = ctx->msgcount;
1506 for (i = 0, j = 0; i < old_count; i++) {
1507 if (ctx->hdrs[i]->active && index_hint && *index_hint == i)
1510 if (ctx->hdrs[i]->active)
1511 ctx->hdrs[i]->index = j++;
1514 mx_update_tables (ctx, 0);
1515 mutt_clear_threads (ctx);
1518 static void maildir_update_flags (CONTEXT * ctx, HEADER * o, HEADER * n)
1520 /* save the global state here so we can reset it at the
1521 * end of list block if required.
1523 int context_changed = ctx->changed;
1525 /* user didn't modify this message. alter the flags to
1526 * match the current state on disk. This may not actually
1527 * do anything, but we can't tell right now. mutt_set_flag()
1528 * will just ignore the call if the status bits are
1529 * already properly set.
1531 mutt_set_flag (ctx, o, M_FLAG, n->flagged);
1532 mutt_set_flag (ctx, o, M_REPLIED, n->replied);
1533 mutt_set_flag (ctx, o, M_READ, n->read);
1534 mutt_set_flag (ctx, o, M_OLD, n->old);
1536 /* mutt_set_flag() will set this, but we don't need to
1537 * sync the changes we made because we just updated the
1538 * context to match the current on-disk state of the
1543 /* if the mailbox was not modified before we made these
1544 * changes, unset the changed flag since nothing needs to
1547 if (!context_changed)
1552 /* This function handles arrival of new mail and reopening of
1553 * maildir folders. The basic idea here is we check to see if either
1554 * the new or cur subdirectories have changed, and if so, we scan them
1555 * for the list of files. We check for newly added messages, and
1556 * then merge the flags messages we already knew about. We don't treat
1557 * either subdirectory differently, as mail could be copied directly into
1558 * the cur directory from another agent.
1560 static int maildir_check_mailbox (CONTEXT * ctx, int *index_hint, int unused)
1562 struct stat st_new; /* status of the "new" subdirectory */
1563 struct stat st_cur; /* status of the "cur" subdirectory */
1564 char buf[_POSIX_PATH_MAX];
1565 int changed = 0; /* bitmask representing which subdirectories
1566 have changed. 0x1 = new, 0x2 = cur */
1567 int occult = 0; /* messages were removed from the mailbox */
1568 int have_new = 0; /* messages were added to the mailbox */
1569 struct maildir *md; /* list of messages in the mailbox */
1570 struct maildir **last, *p;
1572 HASH *fnames; /* hash table for quickly looking up the base filename
1573 for a maildir message */
1575 if (!option (OPTCHECKNEW))
1578 snprintf (buf, sizeof (buf), "%s/new", ctx->path);
1579 if (stat (buf, &st_new) == -1)
1582 snprintf (buf, sizeof (buf), "%s/cur", ctx->path);
1583 if (stat (buf, &st_cur) == -1)
1586 /* determine which subdirectories need to be scanned */
1587 if (st_new.st_mtime > ctx->mtime)
1589 if (st_cur.st_mtime > ctx->mtime_cur)
1593 return 0; /* nothing to do */
1595 /* update the modification times on the mailbox */
1596 ctx->mtime_cur = st_cur.st_mtime;
1597 ctx->mtime = st_new.st_mtime;
1599 /* do a fast scan of just the filenames in
1600 * the subdirectories that have changed.
1605 maildir_parse_dir (ctx, &last, "new", NULL);
1607 maildir_parse_dir (ctx, &last, "cur", NULL);
1609 /* we create a hash table keyed off the canonical (sans flags) filename
1610 * of each message we scanned. This is used in the loop over the
1611 * existing messages below to do some correlation.
1613 fnames = hash_create (1031);
1615 for (p = md; p; p = p->next) {
1616 maildir_canon_filename (buf, p->h->path, sizeof (buf));
1617 p->canon_fname = m_strdup(buf);
1618 hash_insert (fnames, p->canon_fname, p, 0);
1621 /* check for modifications and adjust flags */
1622 for (i = 0; i < ctx->msgcount; i++) {
1623 ctx->hdrs[i]->active = 0;
1624 maildir_canon_filename (buf, ctx->hdrs[i]->path, sizeof (buf));
1625 p = hash_find (fnames, buf);
1627 /* message already exists, merge flags */
1628 ctx->hdrs[i]->active = 1;
1630 /* check to see if the message has moved to a different
1631 * subdirectory. If so, update the associated filename.
1633 if (m_strcmp(ctx->hdrs[i]->path, p->h->path))
1634 str_replace (&ctx->hdrs[i]->path, p->h->path);
1636 /* if the user hasn't modified the flags on this message, update
1637 * the flags we just detected.
1639 if (!ctx->hdrs[i]->changed)
1640 maildir_update_flags (ctx, ctx->hdrs[i], p->h);
1642 if (ctx->hdrs[i]->deleted == ctx->hdrs[i]->trash)
1643 ctx->hdrs[i]->deleted = p->h->deleted;
1644 ctx->hdrs[i]->trash = p->h->trash;
1646 /* this is a duplicate of an existing header, so remove it */
1647 mutt_free_header (&p->h);
1649 /* This message was not in the list of messages we just scanned.
1650 * Check to see if we have enough information to know if the
1651 * message has disappeared out from underneath us.
1653 else if (((changed & 1) && (!strncmp (ctx->hdrs[i]->path, "new/", 4))) ||
1654 ((changed & 2) && (!strncmp (ctx->hdrs[i]->path, "cur/", 4)))) {
1655 /* This message disappeared, so we need to simulate a "reopen"
1656 * event. We know it disappeared because we just scanned the
1657 * subdirectory it used to reside in.
1662 /* This message resides in a subdirectory which was not
1663 * modified, so we assume that it is still present and
1666 ctx->hdrs[i]->active = 1;
1670 /* destroy the file name hash */
1671 hash_destroy (&fnames, NULL);
1673 /* If we didn't just get new mail, update the tables. */
1675 maildir_update_tables (ctx, index_hint);
1677 /* do any delayed parsing we need to do. */
1678 maildir_delayed_parsing (ctx, md);
1680 /* Incorporate new messages */
1681 have_new = maildir_move_to_context (ctx, &md);
1683 return occult ? M_REOPENED : (have_new ? M_NEW_MAIL : 0);
1687 * This function handles arrival of new mail and reopening of
1688 * mh/maildir folders. Things are getting rather complex because we
1689 * don't have a well-defined "mailbox order", so the tricks from
1690 * mbox.c and mx.c won't work here.
1692 * Don't change this code unless you _really_ understand what
1697 static int mh_check_mailbox (CONTEXT * ctx, int *index_hint, int unused)
1699 char buf[_POSIX_PATH_MAX];
1700 struct stat st, st_cur;
1701 short modified = 0, have_new = 0, occult = 0;
1702 struct maildir *md, *p;
1703 struct maildir **last = NULL;
1704 struct mh_sequences mhs;
1708 if (!option (OPTCHECKNEW))
1711 strfcpy (buf, ctx->path, sizeof (buf));
1712 if (stat (buf, &st) == -1)
1715 /* create .mh_sequences when there isn't one. */
1716 snprintf (buf, sizeof (buf), "%s/.mh_sequences", ctx->path);
1717 if ((i = stat (buf, &st_cur) == -1) && errno == ENOENT) {
1721 if (mh_mkstemp (ctx, &fp, &tmp) == 0) {
1723 if (safe_rename (tmp, buf) == -1)
1729 if (i == -1 && stat (buf, &st_cur) == -1)
1732 if (st.st_mtime > ctx->mtime || st_cur.st_mtime > ctx->mtime_cur)
1738 ctx->mtime_cur = st_cur.st_mtime;
1739 ctx->mtime = st.st_mtime;
1745 maildir_parse_dir (ctx, &last, NULL, NULL);
1746 mh_read_sequences (&mhs, ctx->path);
1747 mh_update_maildir (md, &mhs);
1748 mhs_free_sequences (&mhs);
1750 /* check for modifications and adjust flags */
1751 fnames = hash_create (1031);
1753 for (p = md; p; p = p->next)
1754 hash_insert (fnames, p->h->path, p, 0);
1756 for (i = 0; i < ctx->msgcount; i++) {
1757 ctx->hdrs[i]->active = 0;
1759 if ((p = hash_find (fnames, ctx->hdrs[i]->path)) && p->h &&
1760 (mutt_cmp_header (ctx->hdrs[i], p->h))) {
1761 ctx->hdrs[i]->active = 1;
1762 /* found the right message */
1763 if (!ctx->hdrs[i]->changed)
1764 maildir_update_flags (ctx, ctx->hdrs[i], p->h);
1766 mutt_free_header (&p->h);
1768 else /* message has disappeared */
1772 /* destroy the file name hash */
1774 hash_destroy (&fnames, NULL);
1776 /* If we didn't just get new mail, update the tables. */
1778 maildir_update_tables (ctx, index_hint);
1780 /* Incorporate new messages */
1781 have_new = maildir_move_to_context (ctx, &md);
1783 return occult ? M_REOPENED : (have_new ? M_NEW_MAIL : 0);
1790 * These functions try to find a message in a maildir folder when it
1791 * has moved under our feet. Note that this code is rather expensive, but
1792 * then again, it's called rarely.
1795 FILE *_maildir_open_find_message (const char *folder, const char *unique,
1796 const char *subfolder)
1798 char dir[_POSIX_PATH_MAX];
1799 char tunique[_POSIX_PATH_MAX];
1800 char fname[_POSIX_PATH_MAX];
1808 snprintf (dir, sizeof (dir), "%s/%s", folder, subfolder);
1810 if ((dp = opendir (dir)) == NULL) {
1815 while ((de = readdir (dp))) {
1816 maildir_canon_filename (tunique, de->d_name, sizeof (tunique));
1818 if (!m_strcmp(tunique, unique)) {
1819 snprintf (fname, sizeof (fname), "%s/%s/%s", folder, subfolder,
1821 fp = fopen (fname, "r"); /* __FOPEN_CHECKED__ */
1833 FILE *maildir_open_find_message (const char *folder, const char *msg)
1835 char unique[_POSIX_PATH_MAX];
1838 static unsigned int new_hits = 0, cur_hits = 0; /* simple dynamic optimization */
1840 maildir_canon_filename (unique, msg, sizeof (unique));
1843 _maildir_open_find_message (folder, unique,
1844 new_hits > cur_hits ? "new" : "cur"))
1845 || errno != ENOENT) {
1846 if (new_hits < UINT_MAX && cur_hits < UINT_MAX) {
1847 new_hits += (new_hits > cur_hits ? 1 : 0);
1848 cur_hits += (new_hits > cur_hits ? 0 : 1);
1854 _maildir_open_find_message (folder, unique,
1855 new_hits > cur_hits ? "cur" : "new"))
1856 || errno != ENOENT) {
1857 if (new_hits < UINT_MAX && cur_hits < UINT_MAX) {
1858 new_hits += (new_hits > cur_hits ? 0 : 1);
1859 cur_hits += (new_hits > cur_hits ? 1 : 0);
1871 * 1 if there are no messages in the mailbox
1872 * 0 if there are messages in the mailbox
1875 static int maildir_check_empty (const char *path)
1879 int r = 1; /* assume empty until we find a message */
1880 char realpath[_POSIX_PATH_MAX];
1883 /* Strategy here is to look for any file not beginning with a period */
1886 /* we do "cur" on the first iteration since its more likely that we'll
1887 * find old messages without having to scan both subdirs
1889 snprintf (realpath, sizeof (realpath), "%s/%s", path,
1890 iter == 0 ? "cur" : "new");
1891 if ((dp = opendir (realpath)) == NULL)
1893 while ((de = readdir (dp))) {
1894 if (*de->d_name != '.') {
1901 } while (r && iter < 2);
1908 * 1 if there are no messages in the mailbox
1909 * 0 if there are messages in the mailbox
1912 int mh_check_empty (const char *path)
1916 int r = 1; /* assume empty until we find a message */
1918 if ((dp = opendir (path)) == NULL)
1920 while ((de = readdir (dp))) {
1921 if (mh_valid_message (de->d_name)) {
1931 static int mh_is_magic (const char* path, struct stat* st) {
1932 char tmp[_POSIX_PATH_MAX];
1934 if (S_ISDIR (st->st_mode)) {
1935 snprintf (tmp, sizeof (tmp), "%s/.mh_sequences", path);
1936 if (access (tmp, F_OK) == 0)
1939 snprintf (tmp, sizeof (tmp), "%s/.xmhcache", path);
1940 if (access (tmp, F_OK) == 0)
1943 snprintf (tmp, sizeof (tmp), "%s/.mew_cache", path);
1944 if (access (tmp, F_OK) == 0)
1947 snprintf (tmp, sizeof (tmp), "%s/.mew-cache", path);
1948 if (access (tmp, F_OK) == 0)
1951 snprintf (tmp, sizeof (tmp), "%s/.sylpheed_cache", path);
1952 if (access (tmp, F_OK) == 0)
1956 * ok, this isn't an mh folder, but mh mode can be used to read
1957 * Usenet news from the spool. ;-)
1960 snprintf (tmp, sizeof (tmp), "%s/.overview", path);
1961 if (access (tmp, F_OK) == 0)
1967 static int maildir_is_magic (const char* path, struct stat* st) {
1969 char tmp[_POSIX_PATH_MAX];
1971 if (S_ISDIR (st->st_mode)) {
1972 snprintf (tmp, sizeof (tmp), "%s/cur", path);
1973 if (stat (tmp, &sb) == 0 && S_ISDIR (sb.st_mode))
1979 /* routines common to maildir and mh */
1980 static mx_t* reg_mx (void) {
1981 mx_t* fmt = p_new(mx_t, 1);
1983 fmt->mx_access = access;
1984 fmt->mx_sync_mailbox = mh_sync_mailbox;
1988 static int mh_commit (MESSAGE* msg, CONTEXT* ctx) {
1989 return (mh_commit_message (msg, ctx, NULL));
1992 static int maildir_commit (MESSAGE* msg, CONTEXT* ctx) {
1993 return (maildir_commit_message (msg, ctx, NULL));
1996 mx_t* mh_reg_mx (void) {
1997 mx_t* fmt = reg_mx ();
1999 fmt->mx_check_empty = mh_check_empty;
2000 fmt->mx_is_magic = mh_is_magic;
2001 fmt->mx_open_mailbox = mh_read_dir;
2002 fmt->mx_open_new_message = mh_open_new_message;
2003 fmt->mx_check_mailbox = mh_check_mailbox;
2004 fmt->mx_commit_message = mh_commit;
2008 mx_t* maildir_reg_mx (void) {
2009 mx_t* fmt = reg_mx ();
2010 fmt->type = M_MAILDIR;
2011 fmt->mx_check_empty = maildir_check_empty;
2012 fmt->mx_is_magic = maildir_is_magic;
2013 fmt->mx_open_mailbox = maildir_read_dir;
2014 fmt->mx_open_new_message = maildir_open_new_message;
2015 fmt->mx_check_mailbox = maildir_check_mailbox;
2016 fmt->mx_commit_message = maildir_commit;