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
33 #include <sys/types.h>
53 unsigned header_parsed:1;
56 #endif /* USE_INODESORT */
65 /* mh_sequences support */
67 #define MH_SEQ_UNSEEN (1 << 0)
68 #define MH_SEQ_REPLIED (1 << 1)
69 #define MH_SEQ_FLAGGED (1 << 2)
71 static void mhs_alloc (struct mh_sequences *mhs, int i)
76 if (i > mhs->max || !mhs->flags) {
78 safe_realloc (&mhs->flags, sizeof (mhs->flags[0]) * (newmax + 1));
79 for (j = mhs->max + 1; j <= newmax; j++)
86 static void mhs_free_sequences (struct mh_sequences *mhs)
91 static short mhs_check (struct mh_sequences *mhs, int i)
93 if (!mhs->flags || i > mhs->max)
99 static short mhs_set (struct mh_sequences *mhs, int i, short f)
103 return mhs->flags[i];
110 static short mhs_unset (struct mh_sequences *mhs, int i, short f)
114 return mhs->flags[i];
119 static void mh_read_token (char *t, int *first, int *last)
123 if ((p = strchr (t, '-'))) {
129 *first = *last = atoi (t);
132 static void mh_read_sequences (struct mh_sequences *mhs, const char *path)
143 char pathname[_POSIX_PATH_MAX];
145 snprintf (pathname, sizeof (pathname), "%s/.mh_sequences", path);
147 if (!(fp = fopen (pathname, "r")))
150 while ((buff = mutt_read_line (buff, &sz, fp, &line))) {
151 if (!(t = strtok (buff, " \t:")))
154 if (!safe_strcmp (t, MhUnseen))
156 else if (!safe_strcmp (t, MhFlagged))
158 else if (!safe_strcmp (t, MhReplied))
160 else /* unknown sequence */
163 while ((t = strtok (NULL, " \t:"))) {
164 mh_read_token (t, &first, &last);
165 for (; first <= last; first++)
166 mhs_set (mhs, first, f);
174 int mh_buffy (const char *path)
177 struct mh_sequences mhs;
179 memset (&mhs, 0, sizeof (mhs));
181 mh_read_sequences (&mhs, path);
182 for (i = 0; !r && i <= mhs.max; i++)
183 if (mhs_check (&mhs, i) & MH_SEQ_UNSEEN)
185 mhs_free_sequences (&mhs);
189 static int mh_mkstemp (CONTEXT * dest, FILE ** fp, char **tgt)
192 char path[_POSIX_PATH_MAX];
195 snprintf (path, _POSIX_PATH_MAX, "%s/.mutt-%s-%d-%d",
196 dest->path, NONULL (Hostname), (int) getpid (), Counter++);
198 if ((fd = open (path, O_WRONLY | O_EXCL | O_CREAT, 0666)) == -1) {
199 if (errno != EEXIST) {
205 *tgt = safe_strdup (path);
210 if ((*fp = fdopen (fd, "w")) == NULL) {
220 static void mhs_write_one_sequence (FILE * fp, struct mh_sequences *mhs,
221 short f, const char *tag)
226 fprintf (fp, "%s:", tag);
231 for (i = 0; i <= mhs->max; i++) {
232 if ((mhs_check (mhs, i) & f)) {
238 else if (first >= 0) {
240 fprintf (fp, " %d", first);
242 fprintf (fp, " %d-%d", first, last);
251 fprintf (fp, " %d", first);
253 fprintf (fp, " %d-%d", first, last);
259 /* XXX - we don't currently remove deleted messages from sequences we don't know. Should we? */
261 void mh_update_sequences (CONTEXT * ctx)
265 char sequences[_POSIX_PATH_MAX];
277 char seq_unseen[STRING];
278 char seq_replied[STRING];
279 char seq_flagged[STRING];
282 struct mh_sequences mhs;
284 memset (&mhs, 0, sizeof (mhs));
286 snprintf (seq_unseen, sizeof (seq_unseen), "%s:", NONULL (MhUnseen));
287 snprintf (seq_replied, sizeof (seq_replied), "%s:", NONULL (MhReplied));
288 snprintf (seq_flagged, sizeof (seq_flagged), "%s:", NONULL (MhFlagged));
290 if (mh_mkstemp (ctx, &nfp, &tmpfname) != 0) {
295 snprintf (sequences, sizeof (sequences), "%s/.mh_sequences", ctx->path);
298 /* first, copy unknown sequences */
299 if ((ofp = fopen (sequences, "r"))) {
300 while ((buff = mutt_read_line (buff, &s, ofp, &l))) {
301 if (!safe_strncmp (buff, seq_unseen, safe_strlen (seq_unseen)))
303 if (!safe_strncmp (buff, seq_flagged, safe_strlen (seq_flagged)))
305 if (!safe_strncmp (buff, seq_replied, safe_strlen (seq_replied)))
308 fprintf (nfp, "%s\n", buff);
313 /* now, update our unseen, flagged, and replied sequences */
314 for (l = 0; l < ctx->msgcount; l++) {
315 if (ctx->hdrs[l]->deleted)
318 if ((p = strrchr (ctx->hdrs[l]->path, '/')))
321 p = ctx->hdrs[l]->path;
325 if (!ctx->hdrs[l]->read) {
326 mhs_set (&mhs, i, MH_SEQ_UNSEEN);
329 if (ctx->hdrs[l]->flagged) {
330 mhs_set (&mhs, i, MH_SEQ_FLAGGED);
333 if (ctx->hdrs[l]->replied) {
334 mhs_set (&mhs, i, MH_SEQ_REPLIED);
339 /* write out the new sequences */
341 mhs_write_one_sequence (nfp, &mhs, MH_SEQ_UNSEEN, NONULL (MhUnseen));
343 mhs_write_one_sequence (nfp, &mhs, MH_SEQ_FLAGGED, NONULL (MhFlagged));
345 mhs_write_one_sequence (nfp, &mhs, MH_SEQ_REPLIED, NONULL (MhReplied));
347 mhs_free_sequences (&mhs);
350 /* try to commit the changes - no guarantee here */
354 if (safe_rename (tmpfname, sequences) != 0) {
355 /* report an error? */
362 static void mh_sequences_add_one (CONTEXT * ctx, int n, short unseen,
363 short flagged, short replied)
365 short unseen_done = 0;
366 short flagged_done = 0;
367 short replied_done = 0;
369 FILE *ofp = NULL, *nfp = NULL;
372 char sequences[_POSIX_PATH_MAX];
374 char seq_unseen[STRING];
375 char seq_replied[STRING];
376 char seq_flagged[STRING];
382 if (mh_mkstemp (ctx, &nfp, &tmpfname) == -1)
385 snprintf (seq_unseen, sizeof (seq_unseen), "%s:", NONULL (MhUnseen));
386 snprintf (seq_replied, sizeof (seq_replied), "%s:", NONULL (MhReplied));
387 snprintf (seq_flagged, sizeof (seq_flagged), "%s:", NONULL (MhFlagged));
389 snprintf (sequences, sizeof (sequences), "%s/.mh_sequences", ctx->path);
390 if ((ofp = fopen (sequences, "r"))) {
391 while ((buff = mutt_read_line (buff, &sz, ofp, &line))) {
392 if (unseen && !strncmp (buff, seq_unseen, safe_strlen (seq_unseen))) {
393 fprintf (nfp, "%s %d\n", buff, n);
397 && !strncmp (buff, seq_flagged, safe_strlen (seq_flagged))) {
398 fprintf (nfp, "%s %d\n", buff, n);
402 && !strncmp (buff, seq_replied, safe_strlen (seq_replied))) {
403 fprintf (nfp, "%s %d\n", buff, n);
407 fprintf (nfp, "%s\n", buff);
413 if (!unseen_done && unseen)
414 fprintf (nfp, "%s: %d\n", NONULL (MhUnseen), n);
415 if (!flagged_done && flagged)
416 fprintf (nfp, "%s: %d\n", NONULL (MhFlagged), n);
417 if (!replied_done && replied)
418 fprintf (nfp, "%s: %d\n", NONULL (MhReplied), n);
423 if (safe_rename (tmpfname, sequences) != 0)
429 static void mh_update_maildir (struct maildir *md, struct mh_sequences *mhs)
435 for (; md; md = md->next) {
436 if ((p = strrchr (md->h->path, '/')))
442 f = mhs_check (mhs, i);
444 md->h->read = (f & MH_SEQ_UNSEEN) ? 0 : 1;
445 md->h->flagged = (f & MH_SEQ_FLAGGED) ? 1 : 0;
446 md->h->replied = (f & MH_SEQ_REPLIED) ? 1 : 0;
450 /* maildir support */
452 static void maildir_free_entry (struct maildir **md)
457 FREE (&(*md)->canon_fname);
459 mutt_free_header (&(*md)->h);
464 static void maildir_free_maildir (struct maildir **md)
466 struct maildir *p, *q;
471 for (p = *md; p; p = q) {
473 maildir_free_entry (&p);
477 static void maildir_parse_flags (HEADER * h, const char *path)
485 if ((p = strrchr (path, ':')) != NULL && safe_strncmp (p + 1, "2,", 2) == 0) {
488 str_replace (&h->maildir_flags, p);
489 q = h->maildir_flags;
503 case 'R': /* replied */
508 case 'T': /* trashed */
521 if (q == h->maildir_flags)
522 FREE (&h->maildir_flags);
527 static void maildir_update_mtime (CONTEXT * ctx)
529 char buf[_POSIX_PATH_MAX];
532 if (ctx->magic == M_MAILDIR) {
533 snprintf (buf, sizeof (buf), "%s/%s", ctx->path, "cur");
534 if (stat (buf, &st) == 0)
535 ctx->mtime_cur = st.st_mtime;
536 snprintf (buf, sizeof (buf), "%s/%s", ctx->path, "new");
539 snprintf (buf, sizeof (buf), "%s/.mh_sequences", ctx->path);
540 if (stat (buf, &st) == 0)
541 ctx->mtime_cur = st.st_mtime;
543 strfcpy (buf, ctx->path, sizeof (buf));
546 if (stat (buf, &st) == 0)
547 ctx->mtime = st.st_mtime;
551 * Actually parse a maildir message. This may also be used to fill
552 * out a fake header structure generated by lazy maildir parsing.
554 static HEADER *maildir_parse_message (int magic, const char *fname,
555 int is_old, HEADER * _h)
561 if ((f = fopen (fname, "r")) != NULL) {
563 h = mutt_new_header ();
564 h->env = mutt_read_rfc822_header (f, h, 0, 0);
566 fstat (fileno (f), &st);
570 h->received = h->date_sent;
572 if (h->content->length <= 0)
573 h->content->length = st.st_size - h->content->offset;
577 if (magic == M_MAILDIR) {
579 * maildir stores its flags in the filename, so ignore the
580 * flags in the header of the message
584 maildir_parse_flags (h, fname);
592 * Note that this routine will _not_ modify the context given by
595 * It's used in the first parsing pass on maildir and MH folders.
596 * In the MH case, this means full parsing of the folder. In the
597 * maildir case, it means that we only look at flags, and create a
598 * fake HEADER structure, which may later be filled in by
599 * maildir_parse_message(), when called from
600 * maildir_delayed_parsing().
604 static int maildir_parse_entry (CONTEXT * ctx, struct maildir ***last,
605 const char *subdir, const char *fname,
606 int *count, int is_old, ino_t inode)
608 struct maildir *entry;
610 char buf[_POSIX_PATH_MAX];
613 snprintf (buf, sizeof (buf), "%s/%s/%s", ctx->path, subdir, fname);
615 snprintf (buf, sizeof (buf), "%s/%s", ctx->path, fname);
617 if (ctx->magic == M_MH)
618 h = maildir_parse_message (ctx->magic, buf, is_old, NULL);
620 h = mutt_new_header ();
622 maildir_parse_flags (h, buf);
628 if (!ctx->quiet && ReadInc && ((*count % ReadInc) == 0 || *count == 1))
629 mutt_message (_("Reading %s... %d"), ctx->path, *count);
633 snprintf (buf, sizeof (buf), "%s/%s", subdir, fname);
634 h->path = safe_strdup (buf);
637 h->path = safe_strdup (fname);
639 entry = safe_calloc (sizeof (struct maildir), 1);
641 entry->header_parsed = (ctx->magic == M_MH);
643 entry->inode = inode;
644 #endif /* USE_INODESORT */
646 *last = &entry->next;
656 /* Ignore the garbage files. A valid MH message consists of only
657 * digits. Deleted message get moved to a filename with a comma before
661 int mh_valid_message (const char *s)
664 if (!isdigit ((unsigned char) *s))
670 static int maildir_parse_dir (CONTEXT * ctx, struct maildir ***last,
671 const char *subdir, int *count)
675 char buf[_POSIX_PATH_MAX];
679 snprintf (buf, sizeof (buf), "%s/%s", ctx->path, subdir);
680 is_old = (safe_strcmp ("cur", subdir) == 0);
683 strfcpy (buf, ctx->path, sizeof (buf));
685 if ((dirp = opendir (buf)) == NULL)
688 while ((de = readdir (dirp)) != NULL) {
690 if ((ctx->magic == M_MH && !mh_valid_message (de->d_name))
691 || (ctx->magic == M_MAILDIR && *de->d_name == '.'))
694 /* FOO - really ignore the return value? */
697 (debugfile, "%s:%d: parsing %s\n", __FILE__, __LINE__,
699 maildir_parse_entry (ctx, last, subdir, de->d_name, count, is_old,
707 static int maildir_add_to_context (CONTEXT * ctx, struct maildir *md)
709 int oldmsgcount = ctx->msgcount;
713 dprint (2, (debugfile, "%s:%d maildir_add_to_context(): Considering %s\n",
714 __FILE__, __LINE__, NONULL (md->canon_fname)));
719 "%s:%d Adding header structure. Flags: %s%s%s%s%s\n", __FILE__,
720 __LINE__, md->h->flagged ? "f" : "", md->h->deleted ? "D" : "",
721 md->h->replied ? "r" : "", md->h->old ? "O" : "",
722 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) : safe_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 int mh_read_dir (CONTEXT* ctx) {
951 return (_mh_read_dir (ctx, NULL));
954 /* read a maildir style mailbox */
955 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 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, safe_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 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 dprint (2, (debugfile, "maildir_open_new_message (): Trying %s.\n",
1051 if ((fd = open (path, O_WRONLY | O_EXCL | O_CREAT, 0666)) == -1) {
1052 if (errno != EEXIST) {
1058 dprint (2, (debugfile, "maildir_open_new_message (): Success.\n"));
1059 msg->path = safe_strdup (path);
1064 if ((msg->fp = fdopen (fd, "w")) == NULL) {
1077 * Commit a message to a maildir folder.
1079 * msg->path contains the file name of a file in tmp/. We take the
1080 * flags from this file's name.
1082 * ctx is the mail folder we commit to.
1084 * hdr is a header structure to which we write the message's new
1085 * file name. This is used in the mh and maildir folder synch
1086 * routines. When this routine is invoked from mx_commit_message,
1089 * msg->path looks like this:
1091 * tmp/{cur,new}.mutt-HOSTNAME-PID-COUNTER:flags
1093 * See also maildir_open_new_message().
1097 int maildir_commit_message (CONTEXT * ctx, MESSAGE * msg, HEADER * hdr)
1101 char path[_POSIX_PATH_MAX];
1102 char full[_POSIX_PATH_MAX];
1105 if (safe_fclose (&msg->fp) != 0)
1108 /* extract the subdir */
1109 s = strrchr (msg->path, '/') + 1;
1110 strfcpy (subdir, s, 4);
1112 /* extract the flags */
1113 if ((s = strchr (s, ':')))
1114 strfcpy (suffix, s, sizeof (suffix));
1118 /* construct a new file name. */
1120 snprintf (path, _POSIX_PATH_MAX, "%s/%ld.%u_%d.%s%s", subdir,
1121 (long) time (NULL), (unsigned int) getpid (), Counter++,
1122 NONULL (Hostname), suffix);
1123 snprintf (full, _POSIX_PATH_MAX, "%s/%s", ctx->path, path);
1125 dprint (2, (debugfile, "maildir_commit_message (): renaming %s to %s.\n",
1128 if (safe_rename (msg->path, full) == 0) {
1130 str_replace (&hdr->path, path);
1134 * Adjust the mtime on the file to match the time at which this
1135 * message was received. Currently this is only set when copying
1136 * messages between mailboxes, so we test to ensure that it is
1139 if (msg->received) {
1142 ut.actime = msg->received;
1143 ut.modtime = msg->received;
1144 if (utime (full, &ut)) {
1146 ("maildir_commit_message(): unable to set time on file"));
1153 else if (errno != EEXIST) {
1154 mutt_perror (ctx->path);
1161 * commit a message to an MH folder.
1166 static int _mh_commit_message (CONTEXT * ctx, MESSAGE * msg, HEADER * hdr,
1172 unsigned int n, hi = 0;
1173 char path[_POSIX_PATH_MAX];
1176 if (safe_fclose (&msg->fp) != 0)
1179 if ((dirp = opendir (ctx->path)) == NULL) {
1180 mutt_perror (ctx->path);
1184 /* figure out what the next message number is */
1185 while ((de = readdir (dirp)) != NULL) {
1191 if (!isdigit ((unsigned char) *cp))
1204 * Now try to rename the file to the proper name.
1206 * Note: We may have to try multiple times, until we find a free
1212 snprintf (tmp, sizeof (tmp), "%d", hi);
1213 snprintf (path, sizeof (path), "%s/%s", ctx->path, tmp);
1214 if (safe_rename (msg->path, path) == 0) {
1216 str_replace (&hdr->path, tmp);
1220 else if (errno != EEXIST) {
1221 mutt_perror (ctx->path);
1226 mh_sequences_add_one (ctx, hi, !msg->flags.read, msg->flags.flagged,
1227 msg->flags.replied);
1231 int mh_commit_message (CONTEXT * ctx, MESSAGE * msg, HEADER * hdr)
1233 return _mh_commit_message (ctx, msg, hdr, 1);
1237 /* Sync a message in an MH folder.
1239 * This code is also used for attachment deletion in maildir
1243 static int mh_rewrite_message (CONTEXT * ctx, int msgno)
1245 HEADER *h = ctx->hdrs[msgno];
1250 char oldpath[_POSIX_PATH_MAX];
1251 char newpath[_POSIX_PATH_MAX];
1252 char partpath[_POSIX_PATH_MAX];
1254 long old_body_offset = h->content->offset;
1255 long old_body_length = h->content->length;
1256 long old_hdr_lines = h->lines;
1258 if ((dest = mx_open_new_message (ctx, h, 0)) == NULL)
1261 if ((rc = mutt_copy_message (dest->fp, ctx, h,
1262 M_CM_UPDATE, CH_UPDATE | CH_UPDATE_LEN)) == 0)
1264 snprintf (oldpath, _POSIX_PATH_MAX, "%s/%s", ctx->path, h->path);
1265 strfcpy (partpath, h->path, _POSIX_PATH_MAX);
1267 if (ctx->magic == M_MAILDIR)
1268 rc = maildir_commit_message (ctx, dest, h);
1270 rc = _mh_commit_message (ctx, dest, h, 0);
1272 mx_close_message (&dest);
1280 * Try to move the new message to the old place.
1283 * This is important when we are just updating flags.
1285 * Note that there is a race condition against programs which
1286 * use the first free slot instead of the maximum message
1287 * number. Mutt does _not_ behave like this.
1289 * Anyway, if this fails, the message is in the folder, so
1290 * all what happens is that a concurrently runnung mutt will
1291 * lose flag modifications.
1294 if (ctx->magic == M_MH && rc == 0) {
1295 snprintf (newpath, _POSIX_PATH_MAX, "%s/%s", ctx->path, h->path);
1296 if ((rc = safe_rename (newpath, oldpath)) == 0)
1297 str_replace (&h->path, partpath);
1301 mx_close_message (&dest);
1303 if (rc == -1 && restore) {
1304 h->content->offset = old_body_offset;
1305 h->content->length = old_body_length;
1306 h->lines = old_hdr_lines;
1309 mutt_free_body (&h->content->parts);
1313 static int mh_sync_message (CONTEXT * ctx, int msgno)
1315 HEADER *h = ctx->hdrs[msgno];
1317 if (h->attach_del || h->refs_changed || h->irt_changed)
1318 if (mh_rewrite_message (ctx, msgno) != 0)
1324 static int maildir_sync_message (CONTEXT * ctx, int msgno)
1326 HEADER *h = ctx->hdrs[msgno];
1328 if (h->attach_del || h->refs_changed || h->irt_changed) {
1329 /* when doing attachment deletion/rethreading, fall back to the MH case. */
1330 if (mh_rewrite_message (ctx, msgno) != 0)
1334 /* we just have to rename the file. */
1336 char newpath[_POSIX_PATH_MAX];
1337 char partpath[_POSIX_PATH_MAX];
1338 char fullpath[_POSIX_PATH_MAX];
1339 char oldpath[_POSIX_PATH_MAX];
1343 if ((p = strrchr (h->path, '/')) == NULL) {
1346 "maildir_sync_message: %s: unable to find subdir!\n",
1351 strfcpy (newpath, p, sizeof (newpath));
1353 /* kill the previous flags */
1354 if ((p = strchr (newpath, ':')) != NULL)
1357 maildir_flags (suffix, sizeof (suffix), h);
1359 snprintf (partpath, sizeof (partpath), "%s/%s%s",
1360 (h->read || h->old) ? "cur" : "new", newpath, suffix);
1361 snprintf (fullpath, sizeof (fullpath), "%s/%s", ctx->path, partpath);
1362 snprintf (oldpath, sizeof (oldpath), "%s/%s", ctx->path, h->path);
1364 if (safe_strcmp (fullpath, oldpath) == 0) {
1365 /* message hasn't really changed */
1369 /* record that the message is possibly marked as trashed on disk */
1370 h->trash = h->deleted;
1372 if (rename (oldpath, fullpath) != 0) {
1373 mutt_perror ("rename");
1376 str_replace (&h->path, partpath);
1381 int mh_sync_mailbox (CONTEXT * ctx, int *index_hint)
1383 char path[_POSIX_PATH_MAX], tmp[_POSIX_PATH_MAX];
1388 #endif /* USE_HCACHE */
1390 if (ctx->magic == M_MH)
1391 i = mh_check_mailbox (ctx, index_hint);
1393 i = maildir_check_mailbox (ctx, index_hint);
1399 if (ctx->magic == M_MAILDIR)
1400 hc = mutt_hcache_open (HeaderCache, ctx->path);
1401 #endif /* USE_HCACHE */
1403 for (i = 0; i < ctx->msgcount; i++) {
1404 if (ctx->hdrs[i]->deleted
1405 && (ctx->magic != M_MAILDIR || !option (OPTMAILDIRTRASH))) {
1406 snprintf (path, sizeof (path), "%s/%s", ctx->path, ctx->hdrs[i]->path);
1407 if (ctx->magic == M_MAILDIR
1408 || (option (OPTMHPURGE) && ctx->magic == M_MH)) {
1410 if (ctx->magic == M_MAILDIR)
1411 mutt_hcache_delete (hc, ctx->hdrs[i]->path + 3,
1412 &maildir_hcache_keylen);
1413 #endif /* USE_HCACHE */
1416 else if (ctx->magic == M_MH) {
1417 /* MH just moves files out of the way when you delete them */
1418 if (*ctx->hdrs[i]->path != ',') {
1419 snprintf (tmp, sizeof (tmp), "%s/,%s", ctx->path,
1420 ctx->hdrs[i]->path);
1427 else if (ctx->hdrs[i]->changed || ctx->hdrs[i]->attach_del ||
1428 (ctx->magic == M_MAILDIR
1429 && (option (OPTMAILDIRTRASH) || ctx->hdrs[i]->trash)
1430 && (ctx->hdrs[i]->deleted != ctx->hdrs[i]->trash))) {
1431 if (ctx->magic == M_MAILDIR) {
1432 if (maildir_sync_message (ctx, i) == -1)
1436 if (mh_sync_message (ctx, i) == -1)
1443 if (ctx->magic == M_MAILDIR)
1444 mutt_hcache_close (hc);
1445 #endif /* USE_HCACHE */
1447 if (ctx->magic == M_MH)
1448 mh_update_sequences (ctx);
1450 /* XXX race condition? */
1452 maildir_update_mtime (ctx);
1454 /* adjust indices */
1457 for (i = 0, j = 0; i < ctx->msgcount; i++) {
1458 if (!ctx->hdrs[i]->deleted
1459 || (ctx->magic == M_MAILDIR && option (OPTMAILDIRTRASH)))
1460 ctx->hdrs[i]->index = j++;
1468 if (ctx->magic == M_MAILDIR)
1469 mutt_hcache_close (hc);
1470 #endif /* USE_HCACHE */
1474 static char *maildir_canon_filename (char *dest, const char *src, size_t l)
1478 if ((t = strrchr (src, '/')))
1481 strfcpy (dest, src, l);
1482 if ((u = strrchr (dest, ':')))
1488 static void maildir_update_tables (CONTEXT * ctx, int *index_hint)
1494 if (Sort != SORT_ORDER) {
1497 mutt_sort_headers (ctx, 1);
1501 old_count = ctx->msgcount;
1502 for (i = 0, j = 0; i < old_count; i++) {
1503 if (ctx->hdrs[i]->active && index_hint && *index_hint == i)
1506 if (ctx->hdrs[i]->active)
1507 ctx->hdrs[i]->index = j++;
1510 mx_update_tables (ctx, 0);
1511 mutt_clear_threads (ctx);
1514 static void maildir_update_flags (CONTEXT * ctx, HEADER * o, HEADER * n)
1516 /* save the global state here so we can reset it at the
1517 * end of list block if required.
1519 int context_changed = ctx->changed;
1521 /* user didn't modify this message. alter the flags to
1522 * match the current state on disk. This may not actually
1523 * do anything, but we can't tell right now. mutt_set_flag()
1524 * will just ignore the call if the status bits are
1525 * already properly set.
1527 mutt_set_flag (ctx, o, M_FLAG, n->flagged);
1528 mutt_set_flag (ctx, o, M_REPLIED, n->replied);
1529 mutt_set_flag (ctx, o, M_READ, n->read);
1530 mutt_set_flag (ctx, o, M_OLD, n->old);
1532 /* mutt_set_flag() will set this, but we don't need to
1533 * sync the changes we made because we just updated the
1534 * context to match the current on-disk state of the
1539 /* if the mailbox was not modified before we made these
1540 * changes, unset the changed flag since nothing needs to
1543 if (!context_changed)
1548 /* This function handles arrival of new mail and reopening of
1549 * maildir folders. The basic idea here is we check to see if either
1550 * the new or cur subdirectories have changed, and if so, we scan them
1551 * for the list of files. We check for newly added messages, and
1552 * then merge the flags messages we already knew about. We don't treat
1553 * either subdirectory differently, as mail could be copied directly into
1554 * the cur directory from another agent.
1556 int maildir_check_mailbox (CONTEXT * ctx, int *index_hint)
1558 struct stat st_new; /* status of the "new" subdirectory */
1559 struct stat st_cur; /* status of the "cur" subdirectory */
1560 char buf[_POSIX_PATH_MAX];
1561 int changed = 0; /* bitmask representing which subdirectories
1562 have changed. 0x1 = new, 0x2 = cur */
1563 int occult = 0; /* messages were removed from the mailbox */
1564 int have_new = 0; /* messages were added to the mailbox */
1565 struct maildir *md; /* list of messages in the mailbox */
1566 struct maildir **last, *p;
1568 HASH *fnames; /* hash table for quickly looking up the base filename
1569 for a maildir message */
1571 /* XXX seems like this check belongs in mx_check_mailbox()
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 = safe_strdup (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 (safe_strcmp (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 int mh_check_mailbox (CONTEXT * ctx, int *index_hint)
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 (mbox_strict_cmp_headers (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 (!safe_strcmp (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 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 int mh_is_magic (const char* path) {
1932 char tmp[_POSIX_PATH_MAX];
1934 if (stat (path, &st) == -1)
1937 if (S_ISDIR (st.st_mode)) {
1938 snprintf (tmp, sizeof (tmp), "%s/.mh_sequences", path);
1939 if (access (tmp, F_OK) == 0)
1942 snprintf (tmp, sizeof (tmp), "%s/.xmhcache", 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/.mew-cache", path);
1951 if (access (tmp, F_OK) == 0)
1954 snprintf (tmp, sizeof (tmp), "%s/.sylpheed_cache", path);
1955 if (access (tmp, F_OK) == 0)
1959 * ok, this isn't an mh folder, but mh mode can be used to read
1960 * Usenet news from the spool. ;-)
1963 snprintf (tmp, sizeof (tmp), "%s/.overview", path);
1964 if (access (tmp, F_OK) == 0)
1970 int maildir_is_magic (const char* path) {
1972 char tmp[_POSIX_PATH_MAX];
1974 if (stat (path, &st) == -1)
1976 if (S_ISDIR (st.st_mode)) {
1977 snprintf (tmp, sizeof (tmp), "%s/cur", path);
1978 if (stat (tmp, &st) == 0 && S_ISDIR (st.st_mode))
1984 /* routines common to maildir and mh */
1985 static mx_t* reg_mx (void) {
1986 mx_t* fmt = safe_calloc (1, sizeof (mx_t));
1988 fmt->mx_access = access;
1992 mx_t* mh_reg_mx (void) {
1993 mx_t* fmt = reg_mx ();
1995 fmt->mx_check_empty = mh_check_empty;
1996 fmt->mx_is_magic = mh_is_magic;
1997 fmt->mx_open_mailbox = mh_read_dir;
2001 mx_t* maildir_reg_mx (void) {
2002 mx_t* fmt = reg_mx ();
2003 fmt->type = M_MAILDIR;
2004 fmt->mx_check_empty = maildir_check_empty;
2005 fmt->mx_is_magic = maildir_is_magic;
2006 fmt->mx_open_mailbox = maildir_read_dir;