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*);
75 static void mhs_alloc (struct mh_sequences *mhs, int i)
80 if (i > mhs->max || !mhs->flags) {
82 safe_realloc (&mhs->flags, sizeof (mhs->flags[0]) * (newmax + 1));
83 for (j = mhs->max + 1; j <= newmax; j++)
90 static void mhs_free_sequences (struct mh_sequences *mhs)
95 static short mhs_check (struct mh_sequences *mhs, int i)
97 if (!mhs->flags || i > mhs->max)
100 return mhs->flags[i];
103 static short mhs_set (struct mh_sequences *mhs, int i, short f)
107 return mhs->flags[i];
114 static short mhs_unset (struct mh_sequences *mhs, int i, short f)
118 return mhs->flags[i];
123 static void mh_read_token (char *t, int *first, int *last)
127 if ((p = strchr (t, '-'))) {
133 *first = *last = atoi (t);
136 static void mh_read_sequences (struct mh_sequences *mhs, const char *path)
147 char pathname[_POSIX_PATH_MAX];
149 snprintf (pathname, sizeof (pathname), "%s/.mh_sequences", path);
151 if (!(fp = fopen (pathname, "r")))
154 while ((buff = mutt_read_line (buff, &sz, fp, &line))) {
155 if (!(t = strtok (buff, " \t:")))
158 if (!safe_strcmp (t, MhUnseen))
160 else if (!safe_strcmp (t, MhFlagged))
162 else if (!safe_strcmp (t, MhReplied))
164 else /* unknown sequence */
167 while ((t = strtok (NULL, " \t:"))) {
168 mh_read_token (t, &first, &last);
169 for (; first <= last; first++)
170 mhs_set (mhs, first, f);
178 int mh_buffy (const char *path)
181 struct mh_sequences mhs;
183 memset (&mhs, 0, sizeof (mhs));
185 mh_read_sequences (&mhs, path);
186 for (i = 0; !r && i <= mhs.max; i++)
187 if (mhs_check (&mhs, i) & MH_SEQ_UNSEEN)
189 mhs_free_sequences (&mhs);
193 static int mh_mkstemp (CONTEXT * dest, FILE ** fp, char **tgt)
196 char path[_POSIX_PATH_MAX];
199 snprintf (path, _POSIX_PATH_MAX, "%s/.mutt-%s-%d-%d",
200 dest->path, NONULL (Hostname), (int) getpid (), Counter++);
202 if ((fd = open (path, O_WRONLY | O_EXCL | O_CREAT, 0666)) == -1) {
203 if (errno != EEXIST) {
209 *tgt = safe_strdup (path);
214 if ((*fp = fdopen (fd, "w")) == NULL) {
224 static void mhs_write_one_sequence (FILE * fp, struct mh_sequences *mhs,
225 short f, const char *tag)
230 fprintf (fp, "%s:", tag);
235 for (i = 0; i <= mhs->max; i++) {
236 if ((mhs_check (mhs, i) & f)) {
242 else if (first >= 0) {
244 fprintf (fp, " %d", first);
246 fprintf (fp, " %d-%d", first, last);
255 fprintf (fp, " %d", first);
257 fprintf (fp, " %d-%d", first, last);
263 /* XXX - we don't currently remove deleted messages from sequences we don't know. Should we? */
265 void mh_update_sequences (CONTEXT * ctx)
269 char sequences[_POSIX_PATH_MAX];
281 char seq_unseen[STRING];
282 char seq_replied[STRING];
283 char seq_flagged[STRING];
286 struct mh_sequences mhs;
288 memset (&mhs, 0, sizeof (mhs));
290 snprintf (seq_unseen, sizeof (seq_unseen), "%s:", NONULL (MhUnseen));
291 snprintf (seq_replied, sizeof (seq_replied), "%s:", NONULL (MhReplied));
292 snprintf (seq_flagged, sizeof (seq_flagged), "%s:", NONULL (MhFlagged));
294 if (mh_mkstemp (ctx, &nfp, &tmpfname) != 0) {
299 snprintf (sequences, sizeof (sequences), "%s/.mh_sequences", ctx->path);
302 /* first, copy unknown sequences */
303 if ((ofp = fopen (sequences, "r"))) {
304 while ((buff = mutt_read_line (buff, &s, ofp, &l))) {
305 if (!safe_strncmp (buff, seq_unseen, safe_strlen (seq_unseen)))
307 if (!safe_strncmp (buff, seq_flagged, safe_strlen (seq_flagged)))
309 if (!safe_strncmp (buff, seq_replied, safe_strlen (seq_replied)))
312 fprintf (nfp, "%s\n", buff);
317 /* now, update our unseen, flagged, and replied sequences */
318 for (l = 0; l < ctx->msgcount; l++) {
319 if (ctx->hdrs[l]->deleted)
322 if ((p = strrchr (ctx->hdrs[l]->path, '/')))
325 p = ctx->hdrs[l]->path;
329 if (!ctx->hdrs[l]->read) {
330 mhs_set (&mhs, i, MH_SEQ_UNSEEN);
333 if (ctx->hdrs[l]->flagged) {
334 mhs_set (&mhs, i, MH_SEQ_FLAGGED);
337 if (ctx->hdrs[l]->replied) {
338 mhs_set (&mhs, i, MH_SEQ_REPLIED);
343 /* write out the new sequences */
345 mhs_write_one_sequence (nfp, &mhs, MH_SEQ_UNSEEN, NONULL (MhUnseen));
347 mhs_write_one_sequence (nfp, &mhs, MH_SEQ_FLAGGED, NONULL (MhFlagged));
349 mhs_write_one_sequence (nfp, &mhs, MH_SEQ_REPLIED, NONULL (MhReplied));
351 mhs_free_sequences (&mhs);
354 /* try to commit the changes - no guarantee here */
358 if (safe_rename (tmpfname, sequences) != 0) {
359 /* report an error? */
366 static void mh_sequences_add_one (CONTEXT * ctx, int n, short unseen,
367 short flagged, short replied)
369 short unseen_done = 0;
370 short flagged_done = 0;
371 short replied_done = 0;
373 FILE *ofp = NULL, *nfp = NULL;
376 char sequences[_POSIX_PATH_MAX];
378 char seq_unseen[STRING];
379 char seq_replied[STRING];
380 char seq_flagged[STRING];
386 if (mh_mkstemp (ctx, &nfp, &tmpfname) == -1)
389 snprintf (seq_unseen, sizeof (seq_unseen), "%s:", NONULL (MhUnseen));
390 snprintf (seq_replied, sizeof (seq_replied), "%s:", NONULL (MhReplied));
391 snprintf (seq_flagged, sizeof (seq_flagged), "%s:", NONULL (MhFlagged));
393 snprintf (sequences, sizeof (sequences), "%s/.mh_sequences", ctx->path);
394 if ((ofp = fopen (sequences, "r"))) {
395 while ((buff = mutt_read_line (buff, &sz, ofp, &line))) {
396 if (unseen && !strncmp (buff, seq_unseen, safe_strlen (seq_unseen))) {
397 fprintf (nfp, "%s %d\n", buff, n);
401 && !strncmp (buff, seq_flagged, safe_strlen (seq_flagged))) {
402 fprintf (nfp, "%s %d\n", buff, n);
406 && !strncmp (buff, seq_replied, safe_strlen (seq_replied))) {
407 fprintf (nfp, "%s %d\n", buff, n);
411 fprintf (nfp, "%s\n", buff);
417 if (!unseen_done && unseen)
418 fprintf (nfp, "%s: %d\n", NONULL (MhUnseen), n);
419 if (!flagged_done && flagged)
420 fprintf (nfp, "%s: %d\n", NONULL (MhFlagged), n);
421 if (!replied_done && replied)
422 fprintf (nfp, "%s: %d\n", NONULL (MhReplied), n);
427 if (safe_rename (tmpfname, sequences) != 0)
433 static void mh_update_maildir (struct maildir *md, struct mh_sequences *mhs)
439 for (; md; md = md->next) {
440 if ((p = strrchr (md->h->path, '/')))
446 f = mhs_check (mhs, i);
448 md->h->read = (f & MH_SEQ_UNSEEN) ? 0 : 1;
449 md->h->flagged = (f & MH_SEQ_FLAGGED) ? 1 : 0;
450 md->h->replied = (f & MH_SEQ_REPLIED) ? 1 : 0;
454 /* maildir support */
456 static void maildir_free_entry (struct maildir **md)
461 FREE (&(*md)->canon_fname);
463 mutt_free_header (&(*md)->h);
468 static void maildir_free_maildir (struct maildir **md)
470 struct maildir *p, *q;
475 for (p = *md; p; p = q) {
477 maildir_free_entry (&p);
481 static void maildir_parse_flags (HEADER * h, const char *path)
489 if ((p = strrchr (path, ':')) != NULL && safe_strncmp (p + 1, "2,", 2) == 0) {
492 str_replace (&h->maildir_flags, p);
493 q = h->maildir_flags;
507 case 'R': /* replied */
512 case 'T': /* trashed */
525 if (q == h->maildir_flags)
526 FREE (&h->maildir_flags);
531 static void maildir_update_mtime (CONTEXT * ctx)
533 char buf[_POSIX_PATH_MAX];
536 if (ctx->magic == M_MAILDIR) {
537 snprintf (buf, sizeof (buf), "%s/%s", ctx->path, "cur");
538 if (stat (buf, &st) == 0)
539 ctx->mtime_cur = st.st_mtime;
540 snprintf (buf, sizeof (buf), "%s/%s", ctx->path, "new");
543 snprintf (buf, sizeof (buf), "%s/.mh_sequences", ctx->path);
544 if (stat (buf, &st) == 0)
545 ctx->mtime_cur = st.st_mtime;
547 strfcpy (buf, ctx->path, sizeof (buf));
550 if (stat (buf, &st) == 0)
551 ctx->mtime = st.st_mtime;
555 * Actually parse a maildir message. This may also be used to fill
556 * out a fake header structure generated by lazy maildir parsing.
558 static HEADER *maildir_parse_message (int magic, const char *fname,
559 int is_old, HEADER * _h)
565 if ((f = fopen (fname, "r")) != NULL) {
567 h = mutt_new_header ();
568 h->env = mutt_read_rfc822_header (f, h, 0, 0);
570 fstat (fileno (f), &st);
574 h->received = h->date_sent;
576 if (h->content->length <= 0)
577 h->content->length = st.st_size - h->content->offset;
581 if (magic == M_MAILDIR) {
583 * maildir stores its flags in the filename, so ignore the
584 * flags in the header of the message
588 maildir_parse_flags (h, fname);
596 * Note that this routine will _not_ modify the context given by
599 * It's used in the first parsing pass on maildir and MH folders.
600 * In the MH case, this means full parsing of the folder. In the
601 * maildir case, it means that we only look at flags, and create a
602 * fake HEADER structure, which may later be filled in by
603 * maildir_parse_message(), when called from
604 * maildir_delayed_parsing().
608 static int maildir_parse_entry (CONTEXT * ctx, struct maildir ***last,
609 const char *subdir, const char *fname,
610 int *count, int is_old, ino_t inode)
612 struct maildir *entry;
614 char buf[_POSIX_PATH_MAX];
617 snprintf (buf, sizeof (buf), "%s/%s/%s", ctx->path, subdir, fname);
619 snprintf (buf, sizeof (buf), "%s/%s", ctx->path, fname);
621 if (ctx->magic == M_MH)
622 h = maildir_parse_message (ctx->magic, buf, is_old, NULL);
624 h = mutt_new_header ();
626 maildir_parse_flags (h, buf);
632 if (!ctx->quiet && ReadInc && ((*count % ReadInc) == 0 || *count == 1))
633 mutt_message (_("Reading %s... %d"), ctx->path, *count);
637 snprintf (buf, sizeof (buf), "%s/%s", subdir, fname);
638 h->path = safe_strdup (buf);
641 h->path = safe_strdup (fname);
643 entry = safe_calloc (sizeof (struct maildir), 1);
645 entry->header_parsed = (ctx->magic == M_MH);
647 entry->inode = inode;
648 #endif /* USE_INODESORT */
650 *last = &entry->next;
660 /* Ignore the garbage files. A valid MH message consists of only
661 * digits. Deleted message get moved to a filename with a comma before
665 int mh_valid_message (const char *s)
668 if (!isdigit ((unsigned char) *s))
674 static int maildir_parse_dir (CONTEXT * ctx, struct maildir ***last,
675 const char *subdir, int *count)
679 char buf[_POSIX_PATH_MAX];
683 snprintf (buf, sizeof (buf), "%s/%s", ctx->path, subdir);
684 is_old = (safe_strcmp ("cur", subdir) == 0);
687 strfcpy (buf, ctx->path, sizeof (buf));
689 if ((dirp = opendir (buf)) == NULL)
692 while ((de = readdir (dirp)) != NULL) {
694 if ((ctx->magic == M_MH && !mh_valid_message (de->d_name))
695 || (ctx->magic == M_MAILDIR && *de->d_name == '.'))
698 /* FOO - really ignore the return value? */
700 debug_print (2, ("parsing %s\n", de->d_name));
701 maildir_parse_entry (ctx, last, subdir, de->d_name, count, is_old,
709 static int maildir_add_to_context (CONTEXT * ctx, struct maildir *md)
711 int oldmsgcount = ctx->msgcount;
715 debug_print (2, ("considering %s\n", NONULL (md->canon_fname)));
718 debug_print (2, ("flags: %s%s%s%s%s\n", md->h->flagged ? "f" : "",
719 md->h->deleted ? "D" : "", md->h->replied ? "r" : "",
720 md->h->old ? "O" : "", md->h->read ? "R" : ""));
721 if (ctx->msgcount == ctx->hdrmax)
722 mx_alloc_memory (ctx);
724 ctx->hdrs[ctx->msgcount] = md->h;
725 ctx->hdrs[ctx->msgcount]->index = ctx->msgcount;
727 md->h->content->length + md->h->content->offset -
728 md->h->content->hdr_offset;
736 if (ctx->msgcount > oldmsgcount) {
737 mx_update_context (ctx, ctx->msgcount - oldmsgcount);
743 static int maildir_move_to_context (CONTEXT * ctx, struct maildir **md)
747 r = maildir_add_to_context (ctx, *md);
748 maildir_free_maildir (md);
754 * Merge two maildir lists according to the inode numbers.
756 static struct maildir *maildir_merge_inode (struct maildir *left,
757 struct maildir *right)
759 struct maildir *head;
760 struct maildir *tail;
763 if (left->inode < right->inode) {
781 while (left && right) {
782 if (left->inode < right->inode) {
804 * Sort maildir list according to inode.
806 static struct maildir *maildir_sort_inode (struct maildir *list)
808 struct maildir *left = list;
809 struct maildir *right = list;
811 if (!list || !list->next) {
816 while (list && list->next) {
818 list = list->next->next;
825 left = maildir_sort_inode (left);
826 right = maildir_sort_inode (right);
827 return maildir_merge_inode (left, right);
829 #endif /* USE_INODESORT */
832 static size_t maildir_hcache_keylen (const char *fn)
834 const char *p = strchr (fn, ':');
836 return p ? (size_t) (p - fn) : safe_strlen (fn);
841 * This function does the second parsing pass for a maildir-style
844 void maildir_delayed_parsing (CONTEXT * ctx, struct maildir *md)
847 char fn[_POSIX_PATH_MAX];
853 struct timeval *when = NULL;
854 struct stat lastchanged;
857 hc = mutt_hcache_open (HeaderCache, ctx->path);
860 for (p = md, count = 0; p; p = p->next, count++) {
861 if (!(p && p->h && !p->header_parsed))
865 data = mutt_hcache_fetch (hc, p->h->path + 3, &maildir_hcache_keylen);
866 when = (struct timeval *) data;
869 if (!ctx->quiet && ReadInc && ((count % ReadInc) == 0 || count == 1))
870 mutt_message (_("Reading %s... %d"), ctx->path, count);
871 snprintf (fn, sizeof (fn), "%s/%s", ctx->path, p->h->path);
874 if (option (OPTHCACHEVERIFY)) {
875 ret = stat (fn, &lastchanged);
878 lastchanged.st_mtime = 0;
882 if (data != NULL && !ret && lastchanged.st_mtime <= when->tv_sec) {
883 p->h = mutt_hcache_restore ((unsigned char *) data, &p->h);
884 maildir_parse_flags (p->h, fn);
888 if (maildir_parse_message (ctx->magic, fn, p->h->old, p->h)) {
889 p->header_parsed = 1;
890 maildir_parse_flags (p->h, fn);
892 mutt_hcache_store (hc, p->h->path + 3, p->h, 0, &maildir_hcache_keylen);
896 mutt_free_header (&p->h);
902 mutt_hcache_close (hc);
906 /* Read a MH/maildir style mailbox.
909 * ctx [IN/OUT] context for this mailbox
910 * subdir [IN] NULL for MH mailboxes, otherwise the subdir of the
911 * maildir mailbox to read from
913 static int _mh_read_dir (CONTEXT * ctx, const char *subdir)
916 struct mh_sequences mhs;
917 struct maildir **last;
921 memset (&mhs, 0, sizeof (mhs));
923 maildir_update_mtime (ctx);
928 if (maildir_parse_dir (ctx, &last, subdir, &count) == -1)
931 if (ctx->magic == M_MH) {
932 mh_read_sequences (&mhs, ctx->path);
933 mh_update_maildir (md, &mhs);
934 mhs_free_sequences (&mhs);
938 md = maildir_sort_inode (md);
939 #endif /* USE_INODESORT */
941 if (ctx->magic == M_MAILDIR)
942 maildir_delayed_parsing (ctx, md);
944 maildir_move_to_context (ctx, &md);
948 static int mh_read_dir (CONTEXT* ctx) {
949 return (_mh_read_dir (ctx, NULL));
952 /* read a maildir style mailbox */
953 static int maildir_read_dir (CONTEXT * ctx)
955 /* maildir looks sort of like MH, except that there are two subdirectories
956 * of the main folder path from which to read messages
958 if (_mh_read_dir (ctx, "new") == -1 || _mh_read_dir (ctx, "cur") == -1)
965 * Open a new (temporary) message in an MH folder.
968 static int mh_open_new_message (MESSAGE * msg, CONTEXT * dest, HEADER * hdr)
970 return mh_mkstemp (dest, &msg->fp, &msg->path);
973 int ch_compar (const void *a, const void *b)
975 return (int) (*((const char *) a) - *((const char *) b));
978 static void maildir_flags (char *dest, size_t destlen, HEADER * hdr)
983 * The maildir specification requires that all files in the cur
984 * subdirectory have the :unique string appeneded, regardless of whether
985 * or not there are any flags. If .old is set, we know that this message
986 * will end up in the cur directory, so we include it in the following
987 * test even though there is no associated flag.
991 && (hdr->flagged || hdr->replied || hdr->read || hdr->deleted
992 || hdr->old || hdr->maildir_flags)) {
993 char tmp[LONG_STRING];
995 snprintf (tmp, sizeof (tmp),
997 hdr->flagged ? "F" : "",
998 hdr->replied ? "R" : "",
999 hdr->read ? "S" : "", hdr->deleted ? "T" : "",
1000 NONULL (hdr->maildir_flags));
1001 if (hdr->maildir_flags)
1002 qsort (tmp, safe_strlen (tmp), 1, ch_compar);
1003 snprintf (dest, destlen, ":2,%s", tmp);
1009 * Open a new (temporary) message in a maildir folder.
1011 * Note that this uses _almost_ the maildir file name format, but
1012 * with a {cur,new} prefix.
1016 static int maildir_open_new_message (MESSAGE * msg, CONTEXT * dest, HEADER * hdr)
1019 char path[_POSIX_PATH_MAX];
1024 short deleted = hdr->deleted;
1028 maildir_flags (suffix, sizeof (suffix), hdr);
1030 hdr->deleted = deleted;
1035 if (hdr && (hdr->read || hdr->old))
1036 strfcpy (subdir, "cur", sizeof (subdir));
1038 strfcpy (subdir, "new", sizeof (subdir));
1041 snprintf (path, _POSIX_PATH_MAX, "%s/tmp/%s.%ld.%u_%d.%s%s",
1042 dest->path, subdir, (long) time (NULL),
1043 (unsigned int) getpid (), Counter++, NONULL (Hostname), suffix);
1045 debug_print (2, ("trying %s.\n", path));
1048 if ((fd = open (path, O_WRONLY | O_EXCL | O_CREAT, 0666)) == -1) {
1049 if (errno != EEXIST) {
1055 debug_print (2, ("success.\n"));
1056 msg->path = safe_strdup (path);
1061 if ((msg->fp = fdopen (fd, "w")) == NULL) {
1074 * Commit a message to a maildir folder.
1076 * msg->path contains the file name of a file in tmp/. We take the
1077 * flags from this file's name.
1079 * ctx is the mail folder we commit to.
1081 * hdr is a header structure to which we write the message's new
1082 * file name. This is used in the mh and maildir folder synch
1083 * routines. When this routine is invoked from mx_commit_message,
1086 * msg->path looks like this:
1088 * tmp/{cur,new}.mutt-HOSTNAME-PID-COUNTER:flags
1090 * See also maildir_open_new_message().
1094 int maildir_commit_message (CONTEXT * ctx, MESSAGE * msg, HEADER * hdr)
1098 char path[_POSIX_PATH_MAX];
1099 char full[_POSIX_PATH_MAX];
1102 if (safe_fclose (&msg->fp) != 0)
1105 /* extract the subdir */
1106 s = strrchr (msg->path, '/') + 1;
1107 strfcpy (subdir, s, 4);
1109 /* extract the flags */
1110 if ((s = strchr (s, ':')))
1111 strfcpy (suffix, s, sizeof (suffix));
1115 /* construct a new file name. */
1117 snprintf (path, _POSIX_PATH_MAX, "%s/%ld.%u_%d.%s%s", subdir,
1118 (long) time (NULL), (unsigned int) getpid (), Counter++,
1119 NONULL (Hostname), suffix);
1120 snprintf (full, _POSIX_PATH_MAX, "%s/%s", ctx->path, path);
1122 debug_print (2, ("renaming %s to %s.\n", msg->path, full));
1124 if (safe_rename (msg->path, full) == 0) {
1126 str_replace (&hdr->path, path);
1130 * Adjust the mtime on the file to match the time at which this
1131 * message was received. Currently this is only set when copying
1132 * messages between mailboxes, so we test to ensure that it is
1135 if (msg->received) {
1138 ut.actime = msg->received;
1139 ut.modtime = msg->received;
1140 if (utime (full, &ut)) {
1142 ("maildir_commit_message(): unable to set time on file"));
1149 else if (errno != EEXIST) {
1150 mutt_perror (ctx->path);
1157 * commit a message to an MH folder.
1162 static int _mh_commit_message (CONTEXT * ctx, MESSAGE * msg, HEADER * hdr,
1168 unsigned int n, hi = 0;
1169 char path[_POSIX_PATH_MAX];
1172 if (safe_fclose (&msg->fp) != 0)
1175 if ((dirp = opendir (ctx->path)) == NULL) {
1176 mutt_perror (ctx->path);
1180 /* figure out what the next message number is */
1181 while ((de = readdir (dirp)) != NULL) {
1187 if (!isdigit ((unsigned char) *cp))
1200 * Now try to rename the file to the proper name.
1202 * Note: We may have to try multiple times, until we find a free
1208 snprintf (tmp, sizeof (tmp), "%d", hi);
1209 snprintf (path, sizeof (path), "%s/%s", ctx->path, tmp);
1210 if (safe_rename (msg->path, path) == 0) {
1212 str_replace (&hdr->path, tmp);
1216 else if (errno != EEXIST) {
1217 mutt_perror (ctx->path);
1222 mh_sequences_add_one (ctx, hi, !msg->flags.read, msg->flags.flagged,
1223 msg->flags.replied);
1227 int mh_commit_message (CONTEXT * ctx, MESSAGE * msg, HEADER * hdr)
1229 return _mh_commit_message (ctx, msg, 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 (ctx, dest, h);
1266 rc = _mh_commit_message (ctx, dest, 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 || h->refs_changed || h->irt_changed)
1314 if (mh_rewrite_message (ctx, msgno) != 0)
1320 static int maildir_sync_message (CONTEXT * ctx, int msgno)
1322 HEADER *h = ctx->hdrs[msgno];
1324 if (h->attach_del || h->refs_changed || h->irt_changed) {
1325 /* when doing attachment deletion/rethreading, fall back to the MH case. */
1326 if (mh_rewrite_message (ctx, msgno) != 0)
1330 /* we just have to rename the file. */
1332 char newpath[_POSIX_PATH_MAX];
1333 char partpath[_POSIX_PATH_MAX];
1334 char fullpath[_POSIX_PATH_MAX];
1335 char oldpath[_POSIX_PATH_MAX];
1339 if ((p = strrchr (h->path, '/')) == NULL) {
1340 debug_print (1, ("%s: unable to find subdir!\n", h->path));
1344 strfcpy (newpath, p, sizeof (newpath));
1346 /* kill the previous flags */
1347 if ((p = strchr (newpath, ':')) != NULL)
1350 maildir_flags (suffix, sizeof (suffix), h);
1352 snprintf (partpath, sizeof (partpath), "%s/%s%s",
1353 (h->read || h->old) ? "cur" : "new", newpath, suffix);
1354 snprintf (fullpath, sizeof (fullpath), "%s/%s", ctx->path, partpath);
1355 snprintf (oldpath, sizeof (oldpath), "%s/%s", ctx->path, h->path);
1357 if (safe_strcmp (fullpath, oldpath) == 0) {
1358 /* message hasn't really changed */
1362 /* record that the message is possibly marked as trashed on disk */
1363 h->trash = h->deleted;
1365 if (rename (oldpath, fullpath) != 0) {
1366 mutt_perror ("rename");
1369 str_replace (&h->path, partpath);
1374 static int mh_sync_mailbox (CONTEXT * ctx, int unused, int *index_hint)
1376 char path[_POSIX_PATH_MAX], tmp[_POSIX_PATH_MAX];
1381 #endif /* USE_HCACHE */
1383 if (ctx->magic == M_MH)
1384 i = mh_check_mailbox (ctx, index_hint);
1386 i = maildir_check_mailbox (ctx, index_hint);
1392 if (ctx->magic == M_MAILDIR)
1393 hc = mutt_hcache_open (HeaderCache, ctx->path);
1394 #endif /* USE_HCACHE */
1396 for (i = 0; i < ctx->msgcount; i++) {
1397 if (ctx->hdrs[i]->deleted
1398 && (ctx->magic != M_MAILDIR || !option (OPTMAILDIRTRASH))) {
1399 snprintf (path, sizeof (path), "%s/%s", ctx->path, ctx->hdrs[i]->path);
1400 if (ctx->magic == M_MAILDIR
1401 || (option (OPTMHPURGE) && ctx->magic == M_MH)) {
1403 if (ctx->magic == M_MAILDIR)
1404 mutt_hcache_delete (hc, ctx->hdrs[i]->path + 3,
1405 &maildir_hcache_keylen);
1406 #endif /* USE_HCACHE */
1409 else if (ctx->magic == M_MH) {
1410 /* MH just moves files out of the way when you delete them */
1411 if (*ctx->hdrs[i]->path != ',') {
1412 snprintf (tmp, sizeof (tmp), "%s/,%s", ctx->path,
1413 ctx->hdrs[i]->path);
1420 else if (ctx->hdrs[i]->changed || ctx->hdrs[i]->attach_del ||
1421 (ctx->magic == M_MAILDIR
1422 && (option (OPTMAILDIRTRASH) || ctx->hdrs[i]->trash)
1423 && (ctx->hdrs[i]->deleted != ctx->hdrs[i]->trash))) {
1424 if (ctx->magic == M_MAILDIR) {
1425 if (maildir_sync_message (ctx, i) == -1)
1429 if (mh_sync_message (ctx, i) == -1)
1436 if (ctx->magic == M_MAILDIR)
1437 mutt_hcache_close (hc);
1438 #endif /* USE_HCACHE */
1440 if (ctx->magic == M_MH)
1441 mh_update_sequences (ctx);
1443 /* XXX race condition? */
1445 maildir_update_mtime (ctx);
1447 /* adjust indices */
1450 for (i = 0, j = 0; i < ctx->msgcount; i++) {
1451 if (!ctx->hdrs[i]->deleted
1452 || (ctx->magic == M_MAILDIR && option (OPTMAILDIRTRASH)))
1453 ctx->hdrs[i]->index = j++;
1461 if (ctx->magic == M_MAILDIR)
1462 mutt_hcache_close (hc);
1463 #endif /* USE_HCACHE */
1467 static char *maildir_canon_filename (char *dest, const char *src, size_t l)
1471 if ((t = strrchr (src, '/')))
1474 strfcpy (dest, src, l);
1475 if ((u = strrchr (dest, ':')))
1481 static void maildir_update_tables (CONTEXT * ctx, int *index_hint)
1487 if (Sort != SORT_ORDER) {
1490 mutt_sort_headers (ctx, 1);
1494 old_count = ctx->msgcount;
1495 for (i = 0, j = 0; i < old_count; i++) {
1496 if (ctx->hdrs[i]->active && index_hint && *index_hint == i)
1499 if (ctx->hdrs[i]->active)
1500 ctx->hdrs[i]->index = j++;
1503 mx_update_tables (ctx, 0);
1504 mutt_clear_threads (ctx);
1507 static void maildir_update_flags (CONTEXT * ctx, HEADER * o, HEADER * n)
1509 /* save the global state here so we can reset it at the
1510 * end of list block if required.
1512 int context_changed = ctx->changed;
1514 /* user didn't modify this message. alter the flags to
1515 * match the current state on disk. This may not actually
1516 * do anything, but we can't tell right now. mutt_set_flag()
1517 * will just ignore the call if the status bits are
1518 * already properly set.
1520 mutt_set_flag (ctx, o, M_FLAG, n->flagged);
1521 mutt_set_flag (ctx, o, M_REPLIED, n->replied);
1522 mutt_set_flag (ctx, o, M_READ, n->read);
1523 mutt_set_flag (ctx, o, M_OLD, n->old);
1525 /* mutt_set_flag() will set this, but we don't need to
1526 * sync the changes we made because we just updated the
1527 * context to match the current on-disk state of the
1532 /* if the mailbox was not modified before we made these
1533 * changes, unset the changed flag since nothing needs to
1536 if (!context_changed)
1541 /* This function handles arrival of new mail and reopening of
1542 * maildir folders. The basic idea here is we check to see if either
1543 * the new or cur subdirectories have changed, and if so, we scan them
1544 * for the list of files. We check for newly added messages, and
1545 * then merge the flags messages we already knew about. We don't treat
1546 * either subdirectory differently, as mail could be copied directly into
1547 * the cur directory from another agent.
1549 int maildir_check_mailbox (CONTEXT * ctx, int *index_hint)
1551 struct stat st_new; /* status of the "new" subdirectory */
1552 struct stat st_cur; /* status of the "cur" subdirectory */
1553 char buf[_POSIX_PATH_MAX];
1554 int changed = 0; /* bitmask representing which subdirectories
1555 have changed. 0x1 = new, 0x2 = cur */
1556 int occult = 0; /* messages were removed from the mailbox */
1557 int have_new = 0; /* messages were added to the mailbox */
1558 struct maildir *md; /* list of messages in the mailbox */
1559 struct maildir **last, *p;
1561 HASH *fnames; /* hash table for quickly looking up the base filename
1562 for a maildir message */
1564 /* XXX seems like this check belongs in mx_check_mailbox()
1567 if (!option (OPTCHECKNEW))
1570 snprintf (buf, sizeof (buf), "%s/new", ctx->path);
1571 if (stat (buf, &st_new) == -1)
1574 snprintf (buf, sizeof (buf), "%s/cur", ctx->path);
1575 if (stat (buf, &st_cur) == -1)
1578 /* determine which subdirectories need to be scanned */
1579 if (st_new.st_mtime > ctx->mtime)
1581 if (st_cur.st_mtime > ctx->mtime_cur)
1585 return 0; /* nothing to do */
1587 /* update the modification times on the mailbox */
1588 ctx->mtime_cur = st_cur.st_mtime;
1589 ctx->mtime = st_new.st_mtime;
1591 /* do a fast scan of just the filenames in
1592 * the subdirectories that have changed.
1597 maildir_parse_dir (ctx, &last, "new", NULL);
1599 maildir_parse_dir (ctx, &last, "cur", NULL);
1601 /* we create a hash table keyed off the canonical (sans flags) filename
1602 * of each message we scanned. This is used in the loop over the
1603 * existing messages below to do some correlation.
1605 fnames = hash_create (1031);
1607 for (p = md; p; p = p->next) {
1608 maildir_canon_filename (buf, p->h->path, sizeof (buf));
1609 p->canon_fname = safe_strdup (buf);
1610 hash_insert (fnames, p->canon_fname, p, 0);
1613 /* check for modifications and adjust flags */
1614 for (i = 0; i < ctx->msgcount; i++) {
1615 ctx->hdrs[i]->active = 0;
1616 maildir_canon_filename (buf, ctx->hdrs[i]->path, sizeof (buf));
1617 p = hash_find (fnames, buf);
1619 /* message already exists, merge flags */
1620 ctx->hdrs[i]->active = 1;
1622 /* check to see if the message has moved to a different
1623 * subdirectory. If so, update the associated filename.
1625 if (safe_strcmp (ctx->hdrs[i]->path, p->h->path))
1626 str_replace (&ctx->hdrs[i]->path, p->h->path);
1628 /* if the user hasn't modified the flags on this message, update
1629 * the flags we just detected.
1631 if (!ctx->hdrs[i]->changed)
1632 maildir_update_flags (ctx, ctx->hdrs[i], p->h);
1634 if (ctx->hdrs[i]->deleted == ctx->hdrs[i]->trash)
1635 ctx->hdrs[i]->deleted = p->h->deleted;
1636 ctx->hdrs[i]->trash = p->h->trash;
1638 /* this is a duplicate of an existing header, so remove it */
1639 mutt_free_header (&p->h);
1641 /* This message was not in the list of messages we just scanned.
1642 * Check to see if we have enough information to know if the
1643 * message has disappeared out from underneath us.
1645 else if (((changed & 1) && (!strncmp (ctx->hdrs[i]->path, "new/", 4))) ||
1646 ((changed & 2) && (!strncmp (ctx->hdrs[i]->path, "cur/", 4)))) {
1647 /* This message disappeared, so we need to simulate a "reopen"
1648 * event. We know it disappeared because we just scanned the
1649 * subdirectory it used to reside in.
1654 /* This message resides in a subdirectory which was not
1655 * modified, so we assume that it is still present and
1658 ctx->hdrs[i]->active = 1;
1662 /* destroy the file name hash */
1663 hash_destroy (&fnames, NULL);
1665 /* If we didn't just get new mail, update the tables. */
1667 maildir_update_tables (ctx, index_hint);
1669 /* do any delayed parsing we need to do. */
1670 maildir_delayed_parsing (ctx, md);
1672 /* Incorporate new messages */
1673 have_new = maildir_move_to_context (ctx, &md);
1675 return occult ? M_REOPENED : (have_new ? M_NEW_MAIL : 0);
1679 * This function handles arrival of new mail and reopening of
1680 * mh/maildir folders. Things are getting rather complex because we
1681 * don't have a well-defined "mailbox order", so the tricks from
1682 * mbox.c and mx.c won't work here.
1684 * Don't change this code unless you _really_ understand what
1689 int mh_check_mailbox (CONTEXT * ctx, int *index_hint)
1691 char buf[_POSIX_PATH_MAX];
1692 struct stat st, st_cur;
1693 short modified = 0, have_new = 0, occult = 0;
1694 struct maildir *md, *p;
1695 struct maildir **last = NULL;
1696 struct mh_sequences mhs;
1700 if (!option (OPTCHECKNEW))
1703 strfcpy (buf, ctx->path, sizeof (buf));
1704 if (stat (buf, &st) == -1)
1707 /* create .mh_sequences when there isn't one. */
1708 snprintf (buf, sizeof (buf), "%s/.mh_sequences", ctx->path);
1709 if ((i = stat (buf, &st_cur) == -1) && errno == ENOENT) {
1713 if (mh_mkstemp (ctx, &fp, &tmp) == 0) {
1715 if (safe_rename (tmp, buf) == -1)
1721 if (i == -1 && stat (buf, &st_cur) == -1)
1724 if (st.st_mtime > ctx->mtime || st_cur.st_mtime > ctx->mtime_cur)
1730 ctx->mtime_cur = st_cur.st_mtime;
1731 ctx->mtime = st.st_mtime;
1733 memset (&mhs, 0, sizeof (mhs));
1737 maildir_parse_dir (ctx, &last, NULL, NULL);
1738 mh_read_sequences (&mhs, ctx->path);
1739 mh_update_maildir (md, &mhs);
1740 mhs_free_sequences (&mhs);
1742 /* check for modifications and adjust flags */
1743 fnames = hash_create (1031);
1745 for (p = md; p; p = p->next)
1746 hash_insert (fnames, p->h->path, p, 0);
1748 for (i = 0; i < ctx->msgcount; i++) {
1749 ctx->hdrs[i]->active = 0;
1751 if ((p = hash_find (fnames, ctx->hdrs[i]->path)) && p->h &&
1752 (mbox_strict_cmp_headers (ctx->hdrs[i], p->h))) {
1753 ctx->hdrs[i]->active = 1;
1754 /* found the right message */
1755 if (!ctx->hdrs[i]->changed)
1756 maildir_update_flags (ctx, ctx->hdrs[i], p->h);
1758 mutt_free_header (&p->h);
1760 else /* message has disappeared */
1764 /* destroy the file name hash */
1766 hash_destroy (&fnames, NULL);
1768 /* If we didn't just get new mail, update the tables. */
1770 maildir_update_tables (ctx, index_hint);
1772 /* Incorporate new messages */
1773 have_new = maildir_move_to_context (ctx, &md);
1775 return occult ? M_REOPENED : (have_new ? M_NEW_MAIL : 0);
1782 * These functions try to find a message in a maildir folder when it
1783 * has moved under our feet. Note that this code is rather expensive, but
1784 * then again, it's called rarely.
1787 FILE *_maildir_open_find_message (const char *folder, const char *unique,
1788 const char *subfolder)
1790 char dir[_POSIX_PATH_MAX];
1791 char tunique[_POSIX_PATH_MAX];
1792 char fname[_POSIX_PATH_MAX];
1800 snprintf (dir, sizeof (dir), "%s/%s", folder, subfolder);
1802 if ((dp = opendir (dir)) == NULL) {
1807 while ((de = readdir (dp))) {
1808 maildir_canon_filename (tunique, de->d_name, sizeof (tunique));
1810 if (!safe_strcmp (tunique, unique)) {
1811 snprintf (fname, sizeof (fname), "%s/%s/%s", folder, subfolder,
1813 fp = fopen (fname, "r"); /* __FOPEN_CHECKED__ */
1825 FILE *maildir_open_find_message (const char *folder, const char *msg)
1827 char unique[_POSIX_PATH_MAX];
1830 static unsigned int new_hits = 0, cur_hits = 0; /* simple dynamic optimization */
1832 maildir_canon_filename (unique, msg, sizeof (unique));
1835 _maildir_open_find_message (folder, unique,
1836 new_hits > cur_hits ? "new" : "cur"))
1837 || errno != ENOENT) {
1838 if (new_hits < UINT_MAX && cur_hits < UINT_MAX) {
1839 new_hits += (new_hits > cur_hits ? 1 : 0);
1840 cur_hits += (new_hits > cur_hits ? 0 : 1);
1846 _maildir_open_find_message (folder, unique,
1847 new_hits > cur_hits ? "cur" : "new"))
1848 || errno != ENOENT) {
1849 if (new_hits < UINT_MAX && cur_hits < UINT_MAX) {
1850 new_hits += (new_hits > cur_hits ? 0 : 1);
1851 cur_hits += (new_hits > cur_hits ? 1 : 0);
1863 * 1 if there are no messages in the mailbox
1864 * 0 if there are messages in the mailbox
1867 static int maildir_check_empty (const char *path)
1871 int r = 1; /* assume empty until we find a message */
1872 char realpath[_POSIX_PATH_MAX];
1875 /* Strategy here is to look for any file not beginning with a period */
1878 /* we do "cur" on the first iteration since its more likely that we'll
1879 * find old messages without having to scan both subdirs
1881 snprintf (realpath, sizeof (realpath), "%s/%s", path,
1882 iter == 0 ? "cur" : "new");
1883 if ((dp = opendir (realpath)) == NULL)
1885 while ((de = readdir (dp))) {
1886 if (*de->d_name != '.') {
1893 } while (r && iter < 2);
1900 * 1 if there are no messages in the mailbox
1901 * 0 if there are messages in the mailbox
1904 int mh_check_empty (const char *path)
1908 int r = 1; /* assume empty until we find a message */
1910 if ((dp = opendir (path)) == NULL)
1912 while ((de = readdir (dp))) {
1913 if (mh_valid_message (de->d_name)) {
1923 static int mh_is_magic (const char* path, struct stat* st) {
1924 char tmp[_POSIX_PATH_MAX];
1926 if (S_ISDIR (st->st_mode)) {
1927 snprintf (tmp, sizeof (tmp), "%s/.mh_sequences", path);
1928 if (access (tmp, F_OK) == 0)
1931 snprintf (tmp, sizeof (tmp), "%s/.xmhcache", path);
1932 if (access (tmp, F_OK) == 0)
1935 snprintf (tmp, sizeof (tmp), "%s/.mew_cache", path);
1936 if (access (tmp, F_OK) == 0)
1939 snprintf (tmp, sizeof (tmp), "%s/.mew-cache", path);
1940 if (access (tmp, F_OK) == 0)
1943 snprintf (tmp, sizeof (tmp), "%s/.sylpheed_cache", path);
1944 if (access (tmp, F_OK) == 0)
1948 * ok, this isn't an mh folder, but mh mode can be used to read
1949 * Usenet news from the spool. ;-)
1952 snprintf (tmp, sizeof (tmp), "%s/.overview", path);
1953 if (access (tmp, F_OK) == 0)
1959 static int maildir_is_magic (const char* path, struct stat* st) {
1961 char tmp[_POSIX_PATH_MAX];
1963 if (S_ISDIR (st->st_mode)) {
1964 snprintf (tmp, sizeof (tmp), "%s/cur", path);
1965 if (stat (tmp, &sb) == 0 && S_ISDIR (sb.st_mode))
1971 /* routines common to maildir and mh */
1972 static mx_t* reg_mx (void) {
1973 mx_t* fmt = safe_calloc (1, sizeof (mx_t));
1975 fmt->mx_access = access;
1976 fmt->mx_sync_mailbox = mh_sync_mailbox;
1980 mx_t* mh_reg_mx (void) {
1981 mx_t* fmt = reg_mx ();
1983 fmt->mx_check_empty = mh_check_empty;
1984 fmt->mx_is_magic = mh_is_magic;
1985 fmt->mx_open_mailbox = mh_read_dir;
1986 fmt->mx_open_new_message = mh_open_new_message;
1990 mx_t* maildir_reg_mx (void) {
1991 mx_t* fmt = reg_mx ();
1992 fmt->type = M_MAILDIR;
1993 fmt->mx_check_empty = maildir_check_empty;
1994 fmt->mx_is_magic = maildir_is_magic;
1995 fmt->mx_open_mailbox = maildir_read_dir;
1996 fmt->mx_open_new_message = maildir_open_new_message;