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
16 #include <lib-lib/lib-lib.h>
19 #include <lib-ui/lib-ui.h>
34 unsigned header_parsed:1;
38 typedef struct mh_sequences {
43 /* mh_sequences support */
44 #define MH_SEQ_UNSEEN (1 << 0)
45 #define MH_SEQ_REPLIED (1 << 1)
46 #define MH_SEQ_FLAGGED (1 << 2)
49 static int maildir_check_empty (const char*);
50 static int maildir_check_mailbox (CONTEXT*, int*, int);
51 static int mh_check_mailbox (CONTEXT*, int*, int);
53 static mh_sequences *mhs_new(void)
55 mh_sequences *res = xmalloc(sizeof(mh_sequences) + 128);
60 static void mhs_ensure(mh_sequences *mhs, int i)
63 xrealloc((void *)&mhs, sizeof(mh_sequences) + mhs->size + 128);
64 p_clear(mhs->flags + mhs->size, 128);
69 static void mhs_delete(mh_sequences **mhs)
74 static short mhs_check (struct mh_sequences *mhs, int i)
76 return i > mhs->size ? 0 : mhs->flags[i];
79 static short mhs_set (struct mh_sequences *mhs, int i, short f)
86 static void mh_read_token (char *t, int *first, int *last)
90 if ((p = strchr (t, '-'))) {
96 *first = *last = atoi (t);
99 static void mh_read_sequences (struct mh_sequences *mhs, const char *path)
110 char pathname[_POSIX_PATH_MAX];
112 snprintf (pathname, sizeof (pathname), "%s/.mh_sequences", path);
114 if (!(fp = fopen (pathname, "r")))
117 while ((buff = mutt_read_line (buff, &sz, fp, &line))) {
118 if (!(t = strtok (buff, " \t:")))
121 if (!m_strcmp(t, MhUnseen))
123 else if (!m_strcmp(t, MhFlagged))
125 else if (!m_strcmp(t, MhReplied))
127 else /* unknown sequence */
130 while ((t = strtok (NULL, " \t:"))) {
131 mh_read_token (t, &first, &last);
132 for (; first <= last; first++)
133 mhs_set (mhs, first, f);
141 int mh_buffy (const char *path)
143 mh_sequences *mhs = mhs_new();
146 mh_read_sequences(mhs, path);
147 for (i = 0; i <= mhs->size; i++) {
148 if (mhs_check(mhs, i) & MH_SEQ_UNSEEN) {
158 static int mh_mkstemp (CONTEXT * dest, FILE ** fp, char **tgt)
160 static int Counter = 0;
162 char path[_POSIX_PATH_MAX];
165 snprintf (path, _POSIX_PATH_MAX, "%s/.mutt-%s-%d-%d",
166 dest->path, NONULL(mod_core.shorthost), (int) getpid (), Counter++);
168 if ((fd = open (path, O_WRONLY | O_EXCL | O_CREAT, 0666)) == -1) {
169 if (errno != EEXIST) {
175 *tgt = m_strdup(path);
180 if ((*fp = fdopen (fd, "w")) == NULL) {
190 static void mhs_write_one_sequence(FILE * fp, struct mh_sequences *mhs,
191 short f, const char *tag)
196 fprintf (fp, "%s:", tag);
201 for (i = 0; i <= mhs->size; i++) {
202 if ((mhs_check (mhs, i) & f)) {
208 else if (first >= 0) {
210 fprintf (fp, " %d", first);
212 fprintf (fp, " %d-%d", first, last);
221 fprintf (fp, " %d", first);
223 fprintf (fp, " %d-%d", first, last);
229 /* XXX - we don't currently remove deleted messages from sequences we don't know. Should we? */
231 static void mh_update_sequences (CONTEXT * ctx)
235 char sequences[_POSIX_PATH_MAX];
247 char seq_unseen[STRING];
248 char seq_replied[STRING];
249 char seq_flagged[STRING];
250 mh_sequences *mhs = mhs_new();
252 snprintf(seq_unseen, sizeof(seq_unseen), "%s:", NONULL(MhUnseen));
253 snprintf(seq_replied, sizeof(seq_replied), "%s:", NONULL(MhReplied));
254 snprintf(seq_flagged, sizeof(seq_flagged), "%s:", NONULL(MhFlagged));
256 if (mh_mkstemp (ctx, &nfp, &tmpfname) != 0) {
261 snprintf (sequences, sizeof (sequences), "%s/.mh_sequences", ctx->path);
264 /* first, copy unknown sequences */
265 if ((ofp = fopen (sequences, "r"))) {
266 while ((buff = mutt_read_line (buff, &s, ofp, &l))) {
267 if (!m_strncmp(buff, seq_unseen, m_strlen(seq_unseen)))
269 if (!m_strncmp(buff, seq_flagged, m_strlen(seq_flagged)))
271 if (!m_strncmp(buff, seq_replied, m_strlen(seq_replied)))
274 fprintf (nfp, "%s\n", buff);
279 /* now, update our unseen, flagged, and replied sequences */
280 for (l = 0; l < ctx->msgcount; l++) {
281 if (ctx->hdrs[l]->deleted)
284 if ((p = strrchr (ctx->hdrs[l]->path, '/')))
287 p = ctx->hdrs[l]->path;
291 if (!ctx->hdrs[l]->read) {
292 mhs_set(mhs, i, MH_SEQ_UNSEEN);
295 if (ctx->hdrs[l]->flagged) {
296 mhs_set(mhs, i, MH_SEQ_FLAGGED);
299 if (ctx->hdrs[l]->replied) {
300 mhs_set(mhs, i, MH_SEQ_REPLIED);
305 /* write out the new sequences */
307 mhs_write_one_sequence(nfp, mhs, MH_SEQ_UNSEEN, NONULL (MhUnseen));
309 mhs_write_one_sequence(nfp, mhs, MH_SEQ_FLAGGED, NONULL (MhFlagged));
311 mhs_write_one_sequence(nfp, mhs, MH_SEQ_REPLIED, NONULL (MhReplied));
315 /* try to commit the changes - no guarantee here */
319 if (safe_rename (tmpfname, sequences) != 0) {
320 /* report an error? */
327 static void mh_sequences_add_one (CONTEXT * ctx, int n, short unseen,
328 short flagged, short replied)
330 short unseen_done = 0;
331 short flagged_done = 0;
332 short replied_done = 0;
334 FILE *ofp = NULL, *nfp = NULL;
337 char sequences[_POSIX_PATH_MAX];
339 char seq_unseen[STRING];
340 char seq_replied[STRING];
341 char seq_flagged[STRING];
347 if (mh_mkstemp (ctx, &nfp, &tmpfname) == -1)
350 snprintf (seq_unseen, sizeof (seq_unseen), "%s:", NONULL (MhUnseen));
351 snprintf (seq_replied, sizeof (seq_replied), "%s:", NONULL (MhReplied));
352 snprintf (seq_flagged, sizeof (seq_flagged), "%s:", NONULL (MhFlagged));
354 snprintf (sequences, sizeof (sequences), "%s/.mh_sequences", ctx->path);
355 if ((ofp = fopen (sequences, "r"))) {
356 while ((buff = mutt_read_line (buff, &sz, ofp, &line))) {
357 if (unseen && !m_strncmp (buff, seq_unseen, m_strlen(seq_unseen))) {
358 fprintf (nfp, "%s %d\n", buff, n);
362 && !m_strncmp (buff, seq_flagged, m_strlen(seq_flagged))) {
363 fprintf (nfp, "%s %d\n", buff, n);
367 && !m_strncmp (buff, seq_replied, m_strlen(seq_replied))) {
368 fprintf (nfp, "%s %d\n", buff, n);
372 fprintf (nfp, "%s\n", buff);
378 if (!unseen_done && unseen)
379 fprintf (nfp, "%s: %d\n", NONULL (MhUnseen), n);
380 if (!flagged_done && flagged)
381 fprintf (nfp, "%s: %d\n", NONULL (MhFlagged), n);
382 if (!replied_done && replied)
383 fprintf (nfp, "%s: %d\n", NONULL (MhReplied), n);
388 if (safe_rename (tmpfname, sequences) != 0)
394 static void mh_update_maildir (struct maildir *md, struct mh_sequences *mhs)
400 for (; md; md = md->next) {
401 if ((p = strrchr (md->h->path, '/')))
407 f = mhs_check (mhs, i);
409 md->h->read = (f & MH_SEQ_UNSEEN) ? 0 : 1;
410 md->h->flagged = (f & MH_SEQ_FLAGGED) ? 1 : 0;
411 md->h->replied = (f & MH_SEQ_REPLIED) ? 1 : 0;
415 /* maildir support */
417 static void maildir_free_entry (struct maildir **md)
422 p_delete(&(*md)->canon_fname);
424 header_delete(&(*md)->h);
429 static void maildir_free_maildir (struct maildir **md)
431 struct maildir *p, *q;
436 for (p = *md; p; p = q) {
438 maildir_free_entry (&p);
442 static void maildir_parse_flags (HEADER * h, const char *path)
450 if ((p = strrchr (path, ':')) != NULL && m_strncmp(p + 1, "2,", 2) == 0) {
453 m_strreplace(&h->maildir_flags, p);
454 q = h->maildir_flags;
468 case 'R': /* replied */
473 case 'T': /* trashed */
486 if (q == h->maildir_flags)
487 p_delete(&h->maildir_flags);
492 static void maildir_update_mtime (CONTEXT * ctx)
494 char buf[_POSIX_PATH_MAX];
497 if (ctx->magic == M_MAILDIR) {
498 snprintf (buf, sizeof (buf), "%s/%s", ctx->path, "cur");
499 if (stat (buf, &st) == 0)
500 ctx->mtime_cur = st.st_mtime;
501 snprintf (buf, sizeof (buf), "%s/%s", ctx->path, "new");
504 snprintf (buf, sizeof (buf), "%s/.mh_sequences", ctx->path);
505 if (stat (buf, &st) == 0)
506 ctx->mtime_cur = st.st_mtime;
508 m_strcpy(buf, sizeof(buf), ctx->path);
511 if (stat (buf, &st) == 0)
512 ctx->mtime = st.st_mtime;
516 * Actually parse a maildir message. This may also be used to fill
517 * out a fake header structure generated by lazy maildir parsing.
519 static HEADER *maildir_parse_message (int magic, const char *fname,
520 int is_old, HEADER * _h)
526 if ((f = fopen (fname, "r")) != NULL) {
529 h->env = mutt_read_rfc822_header (f, h, 0, 0);
531 fstat (fileno (f), &st);
535 h->received = h->date_sent;
537 if (h->content->length <= 0)
538 h->content->length = st.st_size - h->content->offset;
542 if (magic == M_MAILDIR) {
544 * maildir stores its flags in the filename, so ignore the
545 * flags in the header of the message
549 maildir_parse_flags (h, fname);
557 * Note that this routine will _not_ modify the context given by
560 * It's used in the first parsing pass on maildir and MH folders.
561 * In the MH case, this means full parsing of the folder. In the
562 * maildir case, it means that we only look at flags, and create a
563 * fake HEADER structure, which may later be filled in by
564 * maildir_parse_message(), when called from
565 * maildir_delayed_parsing().
569 static int maildir_parse_entry (CONTEXT * ctx, struct maildir ***last,
570 const char *subdir, const char *fname,
571 int *count, int is_old, ino_t inode __attribute__ ((unused)))
573 struct maildir *entry;
575 char buf[_POSIX_PATH_MAX];
578 snprintf (buf, sizeof (buf), "%s/%s/%s", ctx->path, subdir, fname);
580 snprintf (buf, sizeof (buf), "%s/%s", ctx->path, fname);
582 if (ctx->magic == M_MH)
583 h = maildir_parse_message (ctx->magic, buf, is_old, NULL);
587 maildir_parse_flags (h, buf);
593 if (!ctx->quiet && ReadInc && ((*count % ReadInc) == 0 || *count == 1))
594 mutt_message (_("Reading %s... %d"), ctx->path, *count);
598 snprintf (buf, sizeof (buf), "%s/%s", subdir, fname);
599 h->path = m_strdup(buf);
602 h->path = m_strdup(fname);
604 entry = p_new(struct maildir, 1);
606 entry->header_parsed = (ctx->magic == M_MH);
608 *last = &entry->next;
618 /* Ignore the garbage files. A valid MH message consists of only
619 * digits. Deleted message get moved to a filename with a comma before
623 int mh_valid_message (const char *s)
626 if (!isdigit ((unsigned char) *s))
632 static int maildir_parse_dir (CONTEXT * ctx, struct maildir ***last,
633 const char *subdir, int *count)
637 char buf[_POSIX_PATH_MAX];
641 snprintf (buf, sizeof (buf), "%s/%s", ctx->path, subdir);
642 is_old = (m_strcmp("cur", subdir) == 0);
645 m_strcpy(buf, sizeof(buf), ctx->path);
647 if ((dirp = opendir (buf)) == NULL)
650 while ((de = readdir (dirp)) != NULL) {
652 if ((ctx->magic == M_MH && !mh_valid_message (de->d_name))
653 || (ctx->magic == M_MAILDIR && *de->d_name == '.'))
656 /* FOO - really ignore the return value? */
658 maildir_parse_entry (ctx, last, subdir, de->d_name, count, is_old,
659 #ifdef HAVE_DIRENT_D_INO
671 static int maildir_add_to_context (CONTEXT * ctx, struct maildir *md)
673 int oldmsgcount = ctx->msgcount;
678 if (ctx->msgcount == ctx->hdrmax)
679 mx_alloc_memory (ctx);
681 ctx->hdrs[ctx->msgcount] = md->h;
682 ctx->hdrs[ctx->msgcount]->index = ctx->msgcount;
684 md->h->content->length + md->h->content->offset -
685 md->h->content->hdr_offset;
693 if (ctx->msgcount > oldmsgcount) {
694 mx_update_context (ctx, ctx->msgcount - oldmsgcount);
700 static int maildir_move_to_context (CONTEXT * ctx, struct maildir **md)
704 r = maildir_add_to_context (ctx, *md);
705 maildir_free_maildir (md);
710 static ssize_t maildir_hcache_keylen (const char *fn)
712 return m_strchrnul(fn, ':') - fn;
717 * This function does the second parsing pass for a maildir-style
720 static void maildir_delayed_parsing (CONTEXT * ctx, struct maildir *md)
723 char fn[_POSIX_PATH_MAX];
729 struct timeval *when = NULL;
730 struct stat lastchanged;
733 hc = mutt_hcache_open(ctx->path);
736 for (p = md, count = 0; p; p = p->next, count++) {
737 if (!(p && p->h && !p->header_parsed))
741 data = mutt_hcache_fetch (hc, p->h->path + 3, &maildir_hcache_keylen);
742 when = (struct timeval *) data;
745 if (!ctx->quiet && ReadInc && ((count % ReadInc) == 0 || count == 1))
746 mutt_message (_("Reading %s... %d"), ctx->path, count);
747 snprintf (fn, sizeof (fn), "%s/%s", ctx->path, p->h->path);
750 ret = stat(fn, &lastchanged);
751 if (data && !ret && lastchanged.st_mtime <= when->tv_sec) {
752 p->h = mutt_hcache_restore(data, &p->h);
753 maildir_parse_flags (p->h, fn);
756 if (maildir_parse_message (ctx->magic, fn, p->h->old, p->h)) {
757 p->header_parsed = 1;
758 maildir_parse_flags (p->h, fn);
760 mutt_hcache_store (hc, p->h->path + 3, p->h, 0, &maildir_hcache_keylen);
763 header_delete(&p->h);
770 mutt_hcache_close (&hc);
774 /* Read a MH/maildir style mailbox.
777 * ctx [IN/OUT] context for this mailbox
778 * subdir [IN] NULL for MH mailboxes, otherwise the subdir of the
779 * maildir mailbox to read from
781 static int _mh_read_dir (CONTEXT * ctx, const char *subdir)
783 struct maildir *md = NULL, **last = &md;
786 maildir_update_mtime (ctx);
788 if (maildir_parse_dir (ctx, &last, subdir, &count) == -1)
791 if (ctx->magic == M_MH) {
792 mh_sequences *mhs = mhs_new();
793 mh_read_sequences(mhs, ctx->path);
794 mh_update_maildir(md, mhs);
798 if (ctx->magic == M_MAILDIR)
799 maildir_delayed_parsing (ctx, md);
801 maildir_move_to_context (ctx, &md);
805 static int mh_read_dir (CONTEXT* ctx) {
806 return _mh_read_dir (ctx, NULL);
809 /* read a maildir style mailbox */
810 static int maildir_read_dir (CONTEXT * ctx)
812 /* maildir looks sort of like MH, except that there are two subdirectories
813 * of the main folder path from which to read messages
815 if (_mh_read_dir (ctx, "new") == -1 || _mh_read_dir (ctx, "cur") == -1)
822 * Open a new (temporary) message in an MH folder.
825 static int mh_open_new_message (MESSAGE * msg, CONTEXT * dest, HEADER * hdr __attribute__ ((unused)))
827 return mh_mkstemp (dest, &msg->fp, &msg->path);
830 static int ch_compar (const void *a, const void *b)
832 return (int) (*((const char *) a) - *((const char *) b));
835 static void maildir_flags (char *dest, ssize_t destlen, HEADER * hdr)
840 * The maildir specification requires that all files in the cur
841 * subdirectory have the :unique string appeneded, regardless of whether
842 * or not there are any flags. If .old is set, we know that this message
843 * will end up in the cur directory, so we include it in the following
844 * test even though there is no associated flag.
848 && (hdr->flagged || hdr->replied || hdr->read || hdr->deleted
849 || hdr->old || hdr->maildir_flags)) {
850 char tmp[LONG_STRING];
852 snprintf (tmp, sizeof (tmp),
854 hdr->flagged ? "F" : "",
855 hdr->replied ? "R" : "",
856 hdr->read ? "S" : "", hdr->deleted ? "T" : "",
857 NONULL (hdr->maildir_flags));
858 if (hdr->maildir_flags)
859 qsort (tmp, m_strlen(tmp), 1, ch_compar);
860 snprintf (dest, destlen, ":2,%s", tmp);
866 * Open a new (temporary) message in a maildir folder.
868 * Note that this uses _almost_ the maildir file name format, but
869 * with a {cur,new} prefix.
873 static int maildir_open_new_message (MESSAGE * msg, CONTEXT * dest, HEADER * hdr)
875 static int Counter = 0;
877 char path[_POSIX_PATH_MAX];
882 short deleted = hdr->deleted;
886 maildir_flags (suffix, sizeof (suffix), hdr);
888 hdr->deleted = deleted;
893 if (hdr && (hdr->read || hdr->old))
894 m_strcpy(subdir, sizeof(subdir), "cur");
896 m_strcpy(subdir, sizeof(subdir), "new");
899 snprintf (path, _POSIX_PATH_MAX, "%s/tmp/%s.%ld.%u_%d.%s%s",
900 dest->path, subdir, (long) time (NULL),
901 (unsigned int) getpid (), Counter++, NONULL (mod_core.shorthost), suffix);
904 if ((fd = open (path, O_WRONLY | O_EXCL | O_CREAT, 0666)) == -1) {
905 if (errno != EEXIST) {
910 msg->path = m_strdup(path);
915 if ((msg->fp = fdopen (fd, "w")) == NULL) {
916 p_delete(&msg->path);
925 static int maildir_open_message(MESSAGE *msg, CONTEXT *ctx, int msgno)
927 HEADER *cur = ctx->hdrs[msgno];
928 char path[_POSIX_PATH_MAX];
930 snprintf (path, sizeof (path), "%s/%s", ctx->path, cur->path);
932 if ((msg->fp = fopen(path, "r")) == NULL
933 && errno == ENOENT && ctx->magic == M_MAILDIR) {
934 msg->fp = maildir_open_find_message (ctx->path, cur->path);
937 if (msg->fp == NULL) {
945 * Commit a message to a maildir folder.
947 * msg->path contains the file name of a file in tmp/. We take the
948 * flags from this file's name.
950 * ctx is the mail folder we commit to.
952 * hdr is a header structure to which we write the message's new
953 * file name. This is used in the mh and maildir folder synch
954 * routines. When this routine is invoked from mx_commit_message,
957 * msg->path looks like this:
959 * tmp/{cur,new}.mutt-HOSTNAME-PID-COUNTER:flags
961 * See also maildir_open_new_message().
965 static int maildir_commit_message (MESSAGE * msg, CONTEXT * ctx, HEADER * hdr)
967 static int Counter = 0;
970 char path[_POSIX_PATH_MAX];
971 char full[_POSIX_PATH_MAX];
974 if (m_fclose(&msg->fp) != 0)
977 /* extract the subdir */
978 s = strrchr (msg->path, '/') + 1;
979 m_strcpy(subdir, sizeof(subdir), s);
981 /* extract the flags */
982 if ((s = strchr (s, ':')))
983 m_strcpy(suffix, sizeof(suffix), s);
987 /* construct a new file name. */
989 snprintf (path, _POSIX_PATH_MAX, "%s/%ld.%u_%d.%s%s", subdir,
990 (long) time (NULL), (unsigned int) getpid (), Counter++,
991 NONULL (mod_core.shorthost), suffix);
992 snprintf (full, _POSIX_PATH_MAX, "%s/%s", ctx->path, path);
994 if (safe_rename (msg->path, full) == 0) {
996 m_strreplace(&hdr->path, path);
997 p_delete(&msg->path);
1000 * Adjust the mtime on the file to match the time at which this
1001 * message was received. Currently this is only set when copying
1002 * messages between mailboxes, so we test to ensure that it is
1005 if (msg->received) {
1008 ut.actime = msg->received;
1009 ut.modtime = msg->received;
1010 if (utime (full, &ut)) {
1012 ("maildir_commit_message(): unable to set time on file"));
1019 else if (errno != EEXIST) {
1020 mutt_perror (ctx->path);
1027 * commit a message to an MH folder.
1032 static int _mh_commit_message (MESSAGE * msg, CONTEXT * ctx, HEADER * hdr,
1038 unsigned int n, hi = 0;
1039 char path[_POSIX_PATH_MAX];
1042 if (m_fclose(&msg->fp) != 0)
1045 if ((dirp = opendir (ctx->path)) == NULL) {
1046 mutt_perror (ctx->path);
1050 /* figure out what the next message number is */
1051 while ((de = readdir (dirp)) != NULL) {
1057 if (!isdigit ((unsigned char) *cp))
1070 * Now try to rename the file to the proper name.
1072 * Note: We may have to try multiple times, until we find a free
1078 snprintf (tmp, sizeof (tmp), "%d", hi);
1079 snprintf (path, sizeof (path), "%s/%s", ctx->path, tmp);
1080 if (safe_rename (msg->path, path) == 0) {
1082 m_strreplace(&hdr->path, tmp);
1083 p_delete(&msg->path);
1086 else if (errno != EEXIST) {
1087 mutt_perror (ctx->path);
1092 mh_sequences_add_one (ctx, hi, !msg->flags.read, msg->flags.flagged,
1093 msg->flags.replied);
1097 static int mh_commit_message (MESSAGE * msg, CONTEXT * ctx, HEADER * hdr) {
1098 return _mh_commit_message (msg, ctx, hdr, 1);
1101 /* Sync a message in an MH folder.
1103 * This code is also used for attachment deletion in maildir
1107 static int mh_rewrite_message (CONTEXT * ctx, int msgno)
1109 HEADER *h = ctx->hdrs[msgno];
1114 char oldpath[_POSIX_PATH_MAX];
1115 char newpath[_POSIX_PATH_MAX];
1116 char partpath[_POSIX_PATH_MAX];
1118 long old_body_offset = h->content->offset;
1119 long old_body_length = h->content->length;
1120 long old_hdr_lines = h->lines;
1122 if ((dest = mx_open_new_message (ctx, h, 0)) == NULL)
1125 if ((rc = mutt_copy_message (dest->fp, ctx, h,
1126 M_CM_UPDATE, CH_UPDATE | CH_UPDATE_LEN)) == 0)
1128 snprintf (oldpath, sizeof(oldpath), "%s/%s", ctx->path, h->path);
1129 m_strcpy(partpath, sizeof(partpath), h->path);
1131 if (ctx->magic == M_MAILDIR)
1132 rc = maildir_commit_message (dest, ctx, h);
1134 rc = _mh_commit_message (dest, ctx, h, 0);
1136 mx_close_message (&dest);
1144 * Try to move the new message to the old place.
1147 * This is important when we are just updating flags.
1149 * Note that there is a race condition against programs which
1150 * use the first free slot instead of the maximum message
1151 * number. Mutt does _not_ behave like this.
1153 * Anyway, if this fails, the message is in the folder, so
1154 * all what happens is that a concurrently runnung mutt will
1155 * lose flag modifications.
1158 if (ctx->magic == M_MH && rc == 0) {
1159 snprintf (newpath, _POSIX_PATH_MAX, "%s/%s", ctx->path, h->path);
1160 if ((rc = safe_rename (newpath, oldpath)) == 0)
1161 m_strreplace(&h->path, partpath);
1165 mx_close_message (&dest);
1167 if (rc == -1 && restore) {
1168 h->content->offset = old_body_offset;
1169 h->content->length = old_body_length;
1170 h->lines = old_hdr_lines;
1173 body_list_wipe(&h->content->parts);
1177 static int mh_sync_message (CONTEXT * ctx, int msgno)
1179 HEADER *h = ctx->hdrs[msgno];
1181 if (h->attach_del ||
1182 (h->env && (h->env->refs_changed || h->env->irt_changed)))
1183 if (mh_rewrite_message (ctx, msgno) != 0)
1189 static int maildir_sync_message (CONTEXT * ctx, int msgno)
1191 HEADER *h = ctx->hdrs[msgno];
1193 if (h->attach_del ||
1194 (h->env && (h->env->refs_changed || h->env->irt_changed))) {
1195 /* when doing attachment deletion/rethreading, fall back to the MH case. */
1196 if (mh_rewrite_message (ctx, msgno) != 0)
1200 /* we just have to rename the file. */
1202 char newpath[_POSIX_PATH_MAX];
1203 char partpath[_POSIX_PATH_MAX];
1204 char fullpath[_POSIX_PATH_MAX];
1205 char oldpath[_POSIX_PATH_MAX];
1209 if ((p = strrchr (h->path, '/')) == NULL) {
1213 m_strcpy(newpath, sizeof(newpath), p);
1215 /* kill the previous flags */
1216 if ((p = strchr (newpath, ':')) != NULL)
1219 maildir_flags (suffix, sizeof (suffix), h);
1221 snprintf (partpath, sizeof (partpath), "%s/%s%s",
1222 (h->read || h->old) ? "cur" : "new", newpath, suffix);
1223 snprintf (fullpath, sizeof (fullpath), "%s/%s", ctx->path, partpath);
1224 snprintf (oldpath, sizeof (oldpath), "%s/%s", ctx->path, h->path);
1226 if (m_strcmp(fullpath, oldpath) == 0) {
1227 /* message hasn't really changed */
1231 /* record that the message is possibly marked as trashed on disk */
1232 h->trash = h->deleted;
1234 if (rename (oldpath, fullpath) != 0) {
1235 mutt_perror ("rename");
1238 m_strreplace(&h->path, partpath);
1243 static int mh_sync_mailbox (CONTEXT * ctx, int unused __attribute__ ((unused)), int *index_hint)
1245 char path[_POSIX_PATH_MAX], tmp[_POSIX_PATH_MAX];
1249 hcache_t *hc = NULL;
1250 #endif /* USE_HCACHE */
1252 if (ctx->magic == M_MH)
1253 i = mh_check_mailbox (ctx, index_hint, 0);
1255 i = maildir_check_mailbox (ctx, index_hint, 0);
1261 if (ctx->magic == M_MAILDIR)
1262 hc = mutt_hcache_open(ctx->path);
1263 #endif /* USE_HCACHE */
1265 for (i = 0; i < ctx->msgcount; i++) {
1266 if (ctx->hdrs[i]->deleted
1267 && (ctx->magic != M_MAILDIR || !option (OPTMAILDIRTRASH))) {
1268 snprintf (path, sizeof (path), "%s/%s", ctx->path, ctx->hdrs[i]->path);
1269 if (ctx->magic == M_MAILDIR
1270 || (option (OPTMHPURGE) && ctx->magic == M_MH)) {
1272 if (ctx->magic == M_MAILDIR)
1273 mutt_hcache_delete (hc, ctx->hdrs[i]->path + 3,
1274 &maildir_hcache_keylen);
1275 #endif /* USE_HCACHE */
1278 else if (ctx->magic == M_MH) {
1279 /* MH just moves files out of the way when you delete them */
1280 if (*ctx->hdrs[i]->path != ',') {
1281 snprintf (tmp, sizeof (tmp), "%s/,%s", ctx->path,
1282 ctx->hdrs[i]->path);
1289 else if (ctx->hdrs[i]->changed || ctx->hdrs[i]->attach_del ||
1290 (ctx->magic == M_MAILDIR
1291 && (option (OPTMAILDIRTRASH) || ctx->hdrs[i]->trash)
1292 && (ctx->hdrs[i]->deleted != ctx->hdrs[i]->trash))) {
1293 if (ctx->magic == M_MAILDIR) {
1294 if (maildir_sync_message (ctx, i) == -1)
1298 if (mh_sync_message (ctx, i) == -1)
1305 if (ctx->magic == M_MAILDIR)
1306 mutt_hcache_close (&hc);
1307 #endif /* USE_HCACHE */
1309 if (ctx->magic == M_MH)
1310 mh_update_sequences (ctx);
1312 /* XXX race condition? */
1314 maildir_update_mtime (ctx);
1316 /* adjust indices */
1319 for (i = 0, j = 0; i < ctx->msgcount; i++) {
1320 if (!ctx->hdrs[i]->deleted
1321 || (ctx->magic == M_MAILDIR && option (OPTMAILDIRTRASH)))
1322 ctx->hdrs[i]->index = j++;
1330 if (ctx->magic == M_MAILDIR)
1331 mutt_hcache_close (&hc);
1332 #endif /* USE_HCACHE */
1336 static char *maildir_canon_filename (char *dest, const char *src, ssize_t l)
1340 if ((t = strrchr (src, '/')))
1343 m_strcpy(dest, l, src);
1344 if ((u = strrchr (dest, ':')))
1350 static void maildir_update_tables (CONTEXT * ctx, int *index_hint)
1356 if (Sort != SORT_ORDER) {
1359 mutt_sort_headers (ctx, 1);
1363 old_count = ctx->msgcount;
1364 for (i = 0, j = 0; i < old_count; i++) {
1365 if (ctx->hdrs[i]->active && index_hint && *index_hint == i)
1368 if (ctx->hdrs[i]->active)
1369 ctx->hdrs[i]->index = j++;
1372 mx_update_tables (ctx, 0);
1373 mutt_clear_threads (ctx);
1376 static void maildir_update_flags (CONTEXT * ctx, HEADER * o, HEADER * n)
1378 /* save the global state here so we can reset it at the
1379 * end of list block if required.
1381 int context_changed = ctx->changed;
1383 /* user didn't modify this message. alter the flags to
1384 * match the current state on disk. This may not actually
1385 * do anything, but we can't tell right now. mutt_set_flag()
1386 * will just ignore the call if the status bits are
1387 * already properly set.
1389 mutt_set_flag (ctx, o, M_FLAG, n->flagged);
1390 mutt_set_flag (ctx, o, M_REPLIED, n->replied);
1391 mutt_set_flag (ctx, o, M_READ, n->read);
1392 mutt_set_flag (ctx, o, M_OLD, n->old);
1394 /* mutt_set_flag() will set this, but we don't need to
1395 * sync the changes we made because we just updated the
1396 * context to match the current on-disk state of the
1401 /* if the mailbox was not modified before we made these
1402 * changes, unset the changed flag since nothing needs to
1405 if (!context_changed)
1410 /* This function handles arrival of new mail and reopening of
1411 * maildir folders. The basic idea here is we check to see if either
1412 * the new or cur subdirectories have changed, and if so, we scan them
1413 * for the list of files. We check for newly added messages, and
1414 * then merge the flags messages we already knew about. We don't treat
1415 * either subdirectory differently, as mail could be copied directly into
1416 * the cur directory from another agent.
1418 static int maildir_check_mailbox (CONTEXT * ctx, int *index_hint, int unused __attribute__ ((unused)))
1420 struct stat st_new; /* status of the "new" subdirectory */
1421 struct stat st_cur; /* status of the "cur" subdirectory */
1422 char buf[_POSIX_PATH_MAX];
1423 int changed = 0; /* bitmask representing which subdirectories
1424 have changed. 0x1 = new, 0x2 = cur */
1425 int occult = 0; /* messages were removed from the mailbox */
1426 int have_new = 0; /* messages were added to the mailbox */
1427 struct maildir *md; /* list of messages in the mailbox */
1428 struct maildir **last, *p;
1430 hash_t *fnames; /* hash table for quickly looking up the base filename
1431 for a maildir message */
1433 if (!option (OPTCHECKNEW))
1436 snprintf (buf, sizeof (buf), "%s/new", ctx->path);
1437 if (stat (buf, &st_new) == -1)
1440 snprintf (buf, sizeof (buf), "%s/cur", ctx->path);
1441 if (stat (buf, &st_cur) == -1)
1444 /* determine which subdirectories need to be scanned */
1445 if (st_new.st_mtime > ctx->mtime)
1447 if (st_cur.st_mtime > ctx->mtime_cur)
1451 return 0; /* nothing to do */
1453 /* update the modification times on the mailbox */
1454 ctx->mtime_cur = st_cur.st_mtime;
1455 ctx->mtime = st_new.st_mtime;
1457 /* do a fast scan of just the filenames in
1458 * the subdirectories that have changed.
1463 maildir_parse_dir (ctx, &last, "new", NULL);
1465 maildir_parse_dir (ctx, &last, "cur", NULL);
1467 /* we create a hash table keyed off the canonical (sans flags) filename
1468 * of each message we scanned. This is used in the loop over the
1469 * existing messages below to do some correlation.
1471 fnames = hash_new (1031, 0);
1473 for (p = md; p; p = p->next) {
1474 maildir_canon_filename (buf, p->h->path, sizeof (buf));
1475 p->canon_fname = m_strdup(buf);
1476 hash_insert (fnames, p->canon_fname, p);
1479 /* check for modifications and adjust flags */
1480 for (i = 0; i < ctx->msgcount; i++) {
1481 ctx->hdrs[i]->active = 0;
1482 maildir_canon_filename (buf, ctx->hdrs[i]->path, sizeof (buf));
1483 p = hash_find (fnames, buf);
1485 /* message already exists, merge flags */
1486 ctx->hdrs[i]->active = 1;
1488 /* check to see if the message has moved to a different
1489 * subdirectory. If so, update the associated filename.
1491 if (m_strcmp(ctx->hdrs[i]->path, p->h->path))
1492 m_strreplace(&ctx->hdrs[i]->path, p->h->path);
1494 /* if the user hasn't modified the flags on this message, update
1495 * the flags we just detected.
1497 if (!ctx->hdrs[i]->changed)
1498 maildir_update_flags (ctx, ctx->hdrs[i], p->h);
1500 if (ctx->hdrs[i]->deleted == ctx->hdrs[i]->trash)
1501 ctx->hdrs[i]->deleted = p->h->deleted;
1502 ctx->hdrs[i]->trash = p->h->trash;
1504 /* this is a duplicate of an existing header, so remove it */
1505 header_delete(&p->h);
1507 /* This message was not in the list of messages we just scanned.
1508 * Check to see if we have enough information to know if the
1509 * message has disappeared out from underneath us.
1511 else if (((changed & 1) && (!m_strncmp (ctx->hdrs[i]->path, "new/", 4))) ||
1512 ((changed & 2) && (!m_strncmp (ctx->hdrs[i]->path, "cur/", 4)))) {
1513 /* This message disappeared, so we need to simulate a "reopen"
1514 * event. We know it disappeared because we just scanned the
1515 * subdirectory it used to reside in.
1520 /* This message resides in a subdirectory which was not
1521 * modified, so we assume that it is still present and
1524 ctx->hdrs[i]->active = 1;
1528 /* destroy the file name hash */
1529 hash_delete (&fnames, NULL);
1531 /* If we didn't just get new mail, update the tables. */
1533 maildir_update_tables (ctx, index_hint);
1535 /* do any delayed parsing we need to do. */
1536 maildir_delayed_parsing (ctx, md);
1538 /* Incorporate new messages */
1539 have_new = maildir_move_to_context (ctx, &md);
1541 return occult ? M_REOPENED : (have_new ? M_NEW_MAIL : 0);
1545 * This function handles arrival of new mail and reopening of
1546 * mh/maildir folders. Things are getting rather complex because we
1547 * don't have a well-defined "mailbox order", so the tricks from
1548 * mbox.c and mx.c won't work here.
1550 * Don't change this code unless you _really_ understand what
1555 static int mh_check_mailbox (CONTEXT * ctx, int *index_hint, int unused __attribute__ ((unused)))
1557 char buf[_POSIX_PATH_MAX];
1558 struct stat st, st_cur;
1559 short modified = 0, have_new = 0, occult = 0;
1560 struct maildir *md = NULL, **last = &md, *p;
1565 if (!option (OPTCHECKNEW))
1568 m_strcpy(buf, sizeof(buf), ctx->path);
1569 if (stat (buf, &st) == -1)
1572 /* create .mh_sequences when there isn't one. */
1573 snprintf (buf, sizeof (buf), "%s/.mh_sequences", ctx->path);
1574 if ((i = stat (buf, &st_cur) == -1) && errno == ENOENT) {
1578 if (mh_mkstemp (ctx, &fp, &tmp) == 0) {
1580 if (safe_rename (tmp, buf) == -1)
1586 if (i == -1 && stat (buf, &st_cur) == -1)
1589 if (st.st_mtime > ctx->mtime || st_cur.st_mtime > ctx->mtime_cur)
1595 ctx->mtime_cur = st_cur.st_mtime;
1596 ctx->mtime = st.st_mtime;
1598 maildir_parse_dir (ctx, &last, NULL, NULL);
1600 mh_read_sequences(mhs, ctx->path);
1601 mh_update_maildir(md, mhs);
1604 /* check for modifications and adjust flags */
1605 fnames = hash_new (1031, 0);
1607 for (p = md; p; p = p->next)
1608 hash_insert (fnames, p->h->path, p);
1610 for (i = 0; i < ctx->msgcount; i++) {
1611 ctx->hdrs[i]->active = 0;
1613 if ((p = hash_find (fnames, ctx->hdrs[i]->path)) && p->h &&
1614 (mutt_cmp_header (ctx->hdrs[i], p->h))) {
1615 ctx->hdrs[i]->active = 1;
1616 /* found the right message */
1617 if (!ctx->hdrs[i]->changed)
1618 maildir_update_flags (ctx, ctx->hdrs[i], p->h);
1620 header_delete(&p->h);
1622 else /* message has disappeared */
1626 /* destroy the file name hash */
1628 hash_delete (&fnames, NULL);
1630 /* If we didn't just get new mail, update the tables. */
1632 maildir_update_tables (ctx, index_hint);
1634 /* Incorporate new messages */
1635 have_new = maildir_move_to_context (ctx, &md);
1637 return occult ? M_REOPENED : (have_new ? M_NEW_MAIL : 0);
1642 * These functions try to find a message in a maildir folder when it
1643 * has moved under our feet. Note that this code is rather expensive, but
1644 * then again, it's called rarely.
1646 static FILE *_maildir_open_find_message(const char *folder, const char *unique,
1647 const char *subfolder)
1649 char dir[_POSIX_PATH_MAX];
1650 char tunique[_POSIX_PATH_MAX];
1651 char fname[_POSIX_PATH_MAX];
1659 snprintf (dir, sizeof (dir), "%s/%s", folder, subfolder);
1661 if ((dp = opendir (dir)) == NULL) {
1666 while ((de = readdir (dp))) {
1667 maildir_canon_filename (tunique, de->d_name, sizeof (tunique));
1669 if (!m_strcmp(tunique, unique)) {
1670 snprintf (fname, sizeof (fname), "%s/%s/%s", folder, subfolder,
1672 fp = fopen(fname, "r");
1684 FILE *maildir_open_find_message (const char *folder, const char *msg)
1686 char unique[_POSIX_PATH_MAX];
1689 static unsigned int new_hits = 0, cur_hits = 0; /* simple dynamic optimization */
1691 maildir_canon_filename (unique, msg, sizeof (unique));
1694 _maildir_open_find_message (folder, unique,
1695 new_hits > cur_hits ? "new" : "cur"))
1696 || errno != ENOENT) {
1697 if (new_hits < UINT_MAX && cur_hits < UINT_MAX) {
1698 new_hits += (new_hits > cur_hits ? 1 : 0);
1699 cur_hits += (new_hits > cur_hits ? 0 : 1);
1705 _maildir_open_find_message (folder, unique,
1706 new_hits > cur_hits ? "cur" : "new"))
1707 || errno != ENOENT) {
1708 if (new_hits < UINT_MAX && cur_hits < UINT_MAX) {
1709 new_hits += (new_hits > cur_hits ? 0 : 1);
1710 cur_hits += (new_hits > cur_hits ? 1 : 0);
1722 * 1 if there are no messages in the mailbox
1723 * 0 if there are messages in the mailbox
1726 static int maildir_check_empty (const char *path)
1730 int r = 1; /* assume empty until we find a message */
1731 char frealpath[_POSIX_PATH_MAX];
1734 /* Strategy here is to look for any file not beginning with a period */
1737 /* we do "cur" on the first iteration since its more likely that we'll
1738 * find old messages without having to scan both subdirs
1740 snprintf (frealpath, sizeof (frealpath), "%s/%s", path,
1741 iter == 0 ? "cur" : "new");
1742 if ((dp = opendir (frealpath)) == NULL)
1744 while ((de = readdir (dp))) {
1745 if (*de->d_name != '.') {
1752 } while (r && iter < 2);
1759 * 1 if there are no messages in the mailbox
1760 * 0 if there are messages in the mailbox
1763 static int mh_check_empty (const char *path)
1767 int r = 1; /* assume empty until we find a message */
1769 if ((dp = opendir (path)) == NULL)
1771 while ((de = readdir (dp))) {
1772 if (mh_valid_message (de->d_name)) {
1782 static int mh_is_magic(const char *path, struct stat *st)
1784 static char const * const files[] = {
1785 ".mh_sequences", ".xmhcache", ".mew_cache",
1786 ".mew-cache", ".sylpheed_cache",
1789 if (S_ISDIR(st->st_mode)) {
1790 for (int i = 0; i < countof(files); i++) {
1791 char tmp[_POSIX_PATH_MAX];
1793 snprintf(tmp, sizeof(tmp), "%s/%s", path, files[i]);
1794 if (access(tmp, F_OK) == 0)
1802 static int maildir_is_magic (const char *path, struct stat *st)
1804 if (S_ISDIR(st->st_mode)) {
1805 char tmp[_POSIX_PATH_MAX];
1808 snprintf(tmp, sizeof(tmp), "%s/cur", path);
1809 if (stat(tmp, &sb) == 0 && S_ISDIR(sb.st_mode))
1816 static int mh_commit (MESSAGE* msg, CONTEXT* ctx) {
1817 return (mh_commit_message (msg, ctx, NULL));
1820 static int maildir_commit (MESSAGE* msg, CONTEXT* ctx) {
1821 return (maildir_commit_message (msg, ctx, NULL));
1824 mx_t const maildir_mx = {
1828 maildir_check_empty,
1831 maildir_open_new_message,
1832 maildir_open_message,
1834 maildir_check_mailbox,
1840 mx_t const mh_mx = {
1847 mh_open_new_message,
1848 maildir_open_message,