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
21 #include <sys/types.h>
38 #include <lib-lib/mem.h>
39 #include <lib-lib/str.h>
40 #include <lib-lib/macros.h>
41 #include <lib-lib/file.h>
42 #include <lib-lib/debug.h>
57 unsigned header_parsed:1;
66 /* mh_sequences support */
68 #define MH_SEQ_UNSEEN (1 << 0)
69 #define MH_SEQ_REPLIED (1 << 1)
70 #define MH_SEQ_FLAGGED (1 << 2)
73 static int maildir_check_empty (const char*);
74 static int maildir_check_mailbox (CONTEXT*, int*, int);
75 static int mh_check_mailbox (CONTEXT*, int*, int);
77 static void mhs_alloc (struct mh_sequences *mhs, int i)
82 if (i > mhs->max || !mhs->flags) {
84 p_realloc(&mhs->flags, newmax + 1);
85 for (j = mhs->max + 1; j <= newmax; j++)
92 static void mhs_free_sequences (struct mh_sequences *mhs)
94 p_delete(&mhs->flags);
97 static short mhs_check (struct mh_sequences *mhs, int i)
99 if (!mhs->flags || i > mhs->max)
102 return mhs->flags[i];
105 static short mhs_set (struct mh_sequences *mhs, int i, short f)
109 return mhs->flags[i];
116 static short mhs_unset (struct mh_sequences *mhs, int i, short f)
120 return mhs->flags[i];
125 static void mh_read_token (char *t, int *first, int *last)
129 if ((p = strchr (t, '-'))) {
135 *first = *last = atoi (t);
138 static void mh_read_sequences (struct mh_sequences *mhs, const char *path)
149 char pathname[_POSIX_PATH_MAX];
151 snprintf (pathname, sizeof (pathname), "%s/.mh_sequences", path);
153 if (!(fp = fopen (pathname, "r")))
156 while ((buff = mutt_read_line (buff, &sz, fp, &line))) {
157 if (!(t = strtok (buff, " \t:")))
160 if (!m_strcmp(t, MhUnseen))
162 else if (!m_strcmp(t, MhFlagged))
164 else if (!m_strcmp(t, MhReplied))
166 else /* unknown sequence */
169 while ((t = strtok (NULL, " \t:"))) {
170 mh_read_token (t, &first, &last);
171 for (; first <= last; first++)
172 mhs_set (mhs, first, f);
180 int mh_buffy (const char *path)
183 struct mh_sequences mhs;
187 mh_read_sequences (&mhs, path);
188 for (i = 0; !r && i <= mhs.max; i++)
189 if (mhs_check (&mhs, i) & MH_SEQ_UNSEEN)
191 mhs_free_sequences (&mhs);
195 static int mh_mkstemp (CONTEXT * dest, FILE ** fp, char **tgt)
198 char path[_POSIX_PATH_MAX];
201 snprintf (path, _POSIX_PATH_MAX, "%s/.mutt-%s-%d-%d",
202 dest->path, NONULL (Hostname), (int) getpid (), Counter++);
204 if ((fd = open (path, O_WRONLY | O_EXCL | O_CREAT, 0666)) == -1) {
205 if (errno != EEXIST) {
211 *tgt = m_strdup(path);
216 if ((*fp = fdopen (fd, "w")) == NULL) {
226 static void mhs_write_one_sequence (FILE * fp, struct mh_sequences *mhs,
227 short f, const char *tag)
232 fprintf (fp, "%s:", tag);
237 for (i = 0; i <= mhs->max; i++) {
238 if ((mhs_check (mhs, i) & f)) {
244 else if (first >= 0) {
246 fprintf (fp, " %d", first);
248 fprintf (fp, " %d-%d", first, last);
257 fprintf (fp, " %d", first);
259 fprintf (fp, " %d-%d", first, last);
265 /* XXX - we don't currently remove deleted messages from sequences we don't know. Should we? */
267 void mh_update_sequences (CONTEXT * ctx)
271 char sequences[_POSIX_PATH_MAX];
283 char seq_unseen[STRING];
284 char seq_replied[STRING];
285 char seq_flagged[STRING];
288 struct mh_sequences mhs;
292 snprintf (seq_unseen, sizeof (seq_unseen), "%s:", NONULL (MhUnseen));
293 snprintf (seq_replied, sizeof (seq_replied), "%s:", NONULL (MhReplied));
294 snprintf (seq_flagged, sizeof (seq_flagged), "%s:", NONULL (MhFlagged));
296 if (mh_mkstemp (ctx, &nfp, &tmpfname) != 0) {
301 snprintf (sequences, sizeof (sequences), "%s/.mh_sequences", ctx->path);
304 /* first, copy unknown sequences */
305 if ((ofp = fopen (sequences, "r"))) {
306 while ((buff = mutt_read_line (buff, &s, ofp, &l))) {
307 if (!m_strncmp(buff, seq_unseen, m_strlen(seq_unseen)))
309 if (!m_strncmp(buff, seq_flagged, m_strlen(seq_flagged)))
311 if (!m_strncmp(buff, seq_replied, m_strlen(seq_replied)))
314 fprintf (nfp, "%s\n", buff);
319 /* now, update our unseen, flagged, and replied sequences */
320 for (l = 0; l < ctx->msgcount; l++) {
321 if (ctx->hdrs[l]->deleted)
324 if ((p = strrchr (ctx->hdrs[l]->path, '/')))
327 p = ctx->hdrs[l]->path;
331 if (!ctx->hdrs[l]->read) {
332 mhs_set (&mhs, i, MH_SEQ_UNSEEN);
335 if (ctx->hdrs[l]->flagged) {
336 mhs_set (&mhs, i, MH_SEQ_FLAGGED);
339 if (ctx->hdrs[l]->replied) {
340 mhs_set (&mhs, i, MH_SEQ_REPLIED);
345 /* write out the new sequences */
347 mhs_write_one_sequence (nfp, &mhs, MH_SEQ_UNSEEN, NONULL (MhUnseen));
349 mhs_write_one_sequence (nfp, &mhs, MH_SEQ_FLAGGED, NONULL (MhFlagged));
351 mhs_write_one_sequence (nfp, &mhs, MH_SEQ_REPLIED, NONULL (MhReplied));
353 mhs_free_sequences (&mhs);
356 /* try to commit the changes - no guarantee here */
360 if (safe_rename (tmpfname, sequences) != 0) {
361 /* report an error? */
368 static void mh_sequences_add_one (CONTEXT * ctx, int n, short unseen,
369 short flagged, short replied)
371 short unseen_done = 0;
372 short flagged_done = 0;
373 short replied_done = 0;
375 FILE *ofp = NULL, *nfp = NULL;
378 char sequences[_POSIX_PATH_MAX];
380 char seq_unseen[STRING];
381 char seq_replied[STRING];
382 char seq_flagged[STRING];
388 if (mh_mkstemp (ctx, &nfp, &tmpfname) == -1)
391 snprintf (seq_unseen, sizeof (seq_unseen), "%s:", NONULL (MhUnseen));
392 snprintf (seq_replied, sizeof (seq_replied), "%s:", NONULL (MhReplied));
393 snprintf (seq_flagged, sizeof (seq_flagged), "%s:", NONULL (MhFlagged));
395 snprintf (sequences, sizeof (sequences), "%s/.mh_sequences", ctx->path);
396 if ((ofp = fopen (sequences, "r"))) {
397 while ((buff = mutt_read_line (buff, &sz, ofp, &line))) {
398 if (unseen && !strncmp (buff, seq_unseen, m_strlen(seq_unseen))) {
399 fprintf (nfp, "%s %d\n", buff, n);
403 && !strncmp (buff, seq_flagged, m_strlen(seq_flagged))) {
404 fprintf (nfp, "%s %d\n", buff, n);
408 && !strncmp (buff, seq_replied, m_strlen(seq_replied))) {
409 fprintf (nfp, "%s %d\n", buff, n);
413 fprintf (nfp, "%s\n", buff);
419 if (!unseen_done && unseen)
420 fprintf (nfp, "%s: %d\n", NONULL (MhUnseen), n);
421 if (!flagged_done && flagged)
422 fprintf (nfp, "%s: %d\n", NONULL (MhFlagged), n);
423 if (!replied_done && replied)
424 fprintf (nfp, "%s: %d\n", NONULL (MhReplied), n);
429 if (safe_rename (tmpfname, sequences) != 0)
435 static void mh_update_maildir (struct maildir *md, struct mh_sequences *mhs)
441 for (; md; md = md->next) {
442 if ((p = strrchr (md->h->path, '/')))
448 f = mhs_check (mhs, i);
450 md->h->read = (f & MH_SEQ_UNSEEN) ? 0 : 1;
451 md->h->flagged = (f & MH_SEQ_FLAGGED) ? 1 : 0;
452 md->h->replied = (f & MH_SEQ_REPLIED) ? 1 : 0;
456 /* maildir support */
458 static void maildir_free_entry (struct maildir **md)
463 p_delete(&(*md)->canon_fname);
465 header_delete(&(*md)->h);
470 static void maildir_free_maildir (struct maildir **md)
472 struct maildir *p, *q;
477 for (p = *md; p; p = q) {
479 maildir_free_entry (&p);
483 static void maildir_parse_flags (HEADER * h, const char *path)
491 if ((p = strrchr (path, ':')) != NULL && m_strncmp(p + 1, "2,", 2) == 0) {
494 m_strreplace(&h->maildir_flags, p);
495 q = h->maildir_flags;
509 case 'R': /* replied */
514 case 'T': /* trashed */
527 if (q == h->maildir_flags)
528 p_delete(&h->maildir_flags);
533 static void maildir_update_mtime (CONTEXT * ctx)
535 char buf[_POSIX_PATH_MAX];
538 if (ctx->magic == M_MAILDIR) {
539 snprintf (buf, sizeof (buf), "%s/%s", ctx->path, "cur");
540 if (stat (buf, &st) == 0)
541 ctx->mtime_cur = st.st_mtime;
542 snprintf (buf, sizeof (buf), "%s/%s", ctx->path, "new");
545 snprintf (buf, sizeof (buf), "%s/.mh_sequences", ctx->path);
546 if (stat (buf, &st) == 0)
547 ctx->mtime_cur = st.st_mtime;
549 m_strcpy(buf, sizeof(buf), ctx->path);
552 if (stat (buf, &st) == 0)
553 ctx->mtime = st.st_mtime;
557 * Actually parse a maildir message. This may also be used to fill
558 * out a fake header structure generated by lazy maildir parsing.
560 static HEADER *maildir_parse_message (int magic, const char *fname,
561 int is_old, HEADER * _h)
567 if ((f = fopen (fname, "r")) != NULL) {
570 h->env = mutt_read_rfc822_header (f, h, 0, 0);
572 fstat (fileno (f), &st);
576 h->received = h->date_sent;
578 if (h->content->length <= 0)
579 h->content->length = st.st_size - h->content->offset;
583 if (magic == M_MAILDIR) {
585 * maildir stores its flags in the filename, so ignore the
586 * flags in the header of the message
590 maildir_parse_flags (h, fname);
598 * Note that this routine will _not_ modify the context given by
601 * It's used in the first parsing pass on maildir and MH folders.
602 * In the MH case, this means full parsing of the folder. In the
603 * maildir case, it means that we only look at flags, and create a
604 * fake HEADER structure, which may later be filled in by
605 * maildir_parse_message(), when called from
606 * maildir_delayed_parsing().
610 static int maildir_parse_entry (CONTEXT * ctx, struct maildir ***last,
611 const char *subdir, const char *fname,
612 int *count, int is_old, ino_t inode __attribute__ ((unused)))
614 struct maildir *entry;
616 char buf[_POSIX_PATH_MAX];
619 snprintf (buf, sizeof (buf), "%s/%s/%s", ctx->path, subdir, fname);
621 snprintf (buf, sizeof (buf), "%s/%s", ctx->path, fname);
623 if (ctx->magic == M_MH)
624 h = maildir_parse_message (ctx->magic, buf, is_old, NULL);
628 maildir_parse_flags (h, buf);
634 if (!ctx->quiet && ReadInc && ((*count % ReadInc) == 0 || *count == 1))
635 mutt_message (_("Reading %s... %d"), ctx->path, *count);
639 snprintf (buf, sizeof (buf), "%s/%s", subdir, fname);
640 h->path = m_strdup(buf);
643 h->path = m_strdup(fname);
645 entry = p_new(struct maildir, 1);
647 entry->header_parsed = (ctx->magic == M_MH);
649 *last = &entry->next;
659 /* Ignore the garbage files. A valid MH message consists of only
660 * digits. Deleted message get moved to a filename with a comma before
664 int mh_valid_message (const char *s)
667 if (!isdigit ((unsigned char) *s))
673 static int maildir_parse_dir (CONTEXT * ctx, struct maildir ***last,
674 const char *subdir, int *count)
678 char buf[_POSIX_PATH_MAX];
682 snprintf (buf, sizeof (buf), "%s/%s", ctx->path, subdir);
683 is_old = (m_strcmp("cur", subdir) == 0);
686 m_strcpy(buf, sizeof(buf), ctx->path);
688 if ((dirp = opendir (buf)) == NULL)
691 while ((de = readdir (dirp)) != NULL) {
693 if ((ctx->magic == M_MH && !mh_valid_message (de->d_name))
694 || (ctx->magic == M_MAILDIR && *de->d_name == '.'))
697 /* FOO - really ignore the return value? */
699 debug_print (2, ("parsing %s\n", de->d_name));
700 maildir_parse_entry (ctx, last, subdir, de->d_name, count, is_old,
701 #if HAVE_DIRENT_D_INO
713 static int maildir_add_to_context (CONTEXT * ctx, struct maildir *md)
715 int oldmsgcount = ctx->msgcount;
719 debug_print (2, ("considering %s\n", NONULL (md->canon_fname)));
722 debug_print (2, ("flags: %s%s%s%s%s\n", md->h->flagged ? "f" : "",
723 md->h->deleted ? "D" : "", md->h->replied ? "r" : "",
724 md->h->old ? "O" : "", md->h->read ? "R" : ""));
725 if (ctx->msgcount == ctx->hdrmax)
726 mx_alloc_memory (ctx);
728 ctx->hdrs[ctx->msgcount] = md->h;
729 ctx->hdrs[ctx->msgcount]->index = ctx->msgcount;
731 md->h->content->length + md->h->content->offset -
732 md->h->content->hdr_offset;
740 if (ctx->msgcount > oldmsgcount) {
741 mx_update_context (ctx, ctx->msgcount - oldmsgcount);
747 static int maildir_move_to_context (CONTEXT * ctx, struct maildir **md)
751 r = maildir_add_to_context (ctx, *md);
752 maildir_free_maildir (md);
757 static size_t maildir_hcache_keylen (const char *fn)
759 const char *p = strchr (fn, ':');
761 return p ? (size_t) (p - fn) : m_strlen(fn);
766 * This function does the second parsing pass for a maildir-style
769 void maildir_delayed_parsing (CONTEXT * ctx, struct maildir *md)
772 char fn[_POSIX_PATH_MAX];
778 struct timeval *when = NULL;
779 struct stat lastchanged;
782 hc = mutt_hcache_open (HeaderCache, ctx->path);
785 for (p = md, count = 0; p; p = p->next, count++) {
786 if (!(p && p->h && !p->header_parsed))
790 data = mutt_hcache_fetch (hc, p->h->path + 3, &maildir_hcache_keylen);
791 when = (struct timeval *) data;
794 if (!ctx->quiet && ReadInc && ((count % ReadInc) == 0 || count == 1))
795 mutt_message (_("Reading %s... %d"), ctx->path, count);
796 snprintf (fn, sizeof (fn), "%s/%s", ctx->path, p->h->path);
799 if (option (OPTHCACHEVERIFY)) {
800 ret = stat (fn, &lastchanged);
803 lastchanged.st_mtime = 0;
807 if (data != NULL && !ret && lastchanged.st_mtime <= when->tv_sec) {
808 p->h = mutt_hcache_restore ((unsigned char *) data, &p->h);
809 maildir_parse_flags (p->h, fn);
813 if (maildir_parse_message (ctx->magic, fn, p->h->old, p->h)) {
814 p->header_parsed = 1;
815 maildir_parse_flags (p->h, fn);
817 mutt_hcache_store (hc, p->h->path + 3, p->h, 0, &maildir_hcache_keylen);
821 header_delete(&p->h);
827 mutt_hcache_close (hc);
831 /* Read a MH/maildir style mailbox.
834 * ctx [IN/OUT] context for this mailbox
835 * subdir [IN] NULL for MH mailboxes, otherwise the subdir of the
836 * maildir mailbox to read from
838 static int _mh_read_dir (CONTEXT * ctx, const char *subdir)
841 struct mh_sequences mhs;
842 struct maildir **last;
848 maildir_update_mtime (ctx);
853 if (maildir_parse_dir (ctx, &last, subdir, &count) == -1)
856 if (ctx->magic == M_MH) {
857 mh_read_sequences (&mhs, ctx->path);
858 mh_update_maildir (md, &mhs);
859 mhs_free_sequences (&mhs);
862 if (ctx->magic == M_MAILDIR)
863 maildir_delayed_parsing (ctx, md);
865 maildir_move_to_context (ctx, &md);
869 static int mh_read_dir (CONTEXT* ctx) {
870 return (_mh_read_dir (ctx, NULL));
873 /* read a maildir style mailbox */
874 static int maildir_read_dir (CONTEXT * ctx)
876 /* maildir looks sort of like MH, except that there are two subdirectories
877 * of the main folder path from which to read messages
879 if (_mh_read_dir (ctx, "new") == -1 || _mh_read_dir (ctx, "cur") == -1)
886 * Open a new (temporary) message in an MH folder.
889 static int mh_open_new_message (MESSAGE * msg, CONTEXT * dest, HEADER * hdr __attribute__ ((unused)))
891 return mh_mkstemp (dest, &msg->fp, &msg->path);
894 int ch_compar (const void *a, const void *b)
896 return (int) (*((const char *) a) - *((const char *) b));
899 static void maildir_flags (char *dest, size_t destlen, HEADER * hdr)
904 * The maildir specification requires that all files in the cur
905 * subdirectory have the :unique string appeneded, regardless of whether
906 * or not there are any flags. If .old is set, we know that this message
907 * will end up in the cur directory, so we include it in the following
908 * test even though there is no associated flag.
912 && (hdr->flagged || hdr->replied || hdr->read || hdr->deleted
913 || hdr->old || hdr->maildir_flags)) {
914 char tmp[LONG_STRING];
916 snprintf (tmp, sizeof (tmp),
918 hdr->flagged ? "F" : "",
919 hdr->replied ? "R" : "",
920 hdr->read ? "S" : "", hdr->deleted ? "T" : "",
921 NONULL (hdr->maildir_flags));
922 if (hdr->maildir_flags)
923 qsort (tmp, m_strlen(tmp), 1, ch_compar);
924 snprintf (dest, destlen, ":2,%s", tmp);
930 * Open a new (temporary) message in a maildir folder.
932 * Note that this uses _almost_ the maildir file name format, but
933 * with a {cur,new} prefix.
937 static int maildir_open_new_message (MESSAGE * msg, CONTEXT * dest, HEADER * hdr)
940 char path[_POSIX_PATH_MAX];
945 short deleted = hdr->deleted;
949 maildir_flags (suffix, sizeof (suffix), hdr);
951 hdr->deleted = deleted;
956 if (hdr && (hdr->read || hdr->old))
957 m_strcpy(subdir, sizeof(subdir), "cur");
959 m_strcpy(subdir, sizeof(subdir), "new");
962 snprintf (path, _POSIX_PATH_MAX, "%s/tmp/%s.%ld.%u_%d.%s%s",
963 dest->path, subdir, (long) time (NULL),
964 (unsigned int) getpid (), Counter++, NONULL (Hostname), suffix);
966 debug_print (2, ("trying %s.\n", path));
969 if ((fd = open (path, O_WRONLY | O_EXCL | O_CREAT, 0666)) == -1) {
970 if (errno != EEXIST) {
976 debug_print (2, ("success.\n"));
977 msg->path = m_strdup(path);
982 if ((msg->fp = fdopen (fd, "w")) == NULL) {
983 p_delete(&msg->path);
995 * Commit a message to a maildir folder.
997 * msg->path contains the file name of a file in tmp/. We take the
998 * flags from this file's name.
1000 * ctx is the mail folder we commit to.
1002 * hdr is a header structure to which we write the message's new
1003 * file name. This is used in the mh and maildir folder synch
1004 * routines. When this routine is invoked from mx_commit_message,
1007 * msg->path looks like this:
1009 * tmp/{cur,new}.mutt-HOSTNAME-PID-COUNTER:flags
1011 * See also maildir_open_new_message().
1015 static int maildir_commit_message (MESSAGE * msg, CONTEXT * ctx, HEADER * hdr)
1019 char path[_POSIX_PATH_MAX];
1020 char full[_POSIX_PATH_MAX];
1023 if (safe_fclose (&msg->fp) != 0)
1026 /* extract the subdir */
1027 s = strrchr (msg->path, '/') + 1;
1028 m_strcpy(subdir, sizeof(subdir), s);
1030 /* extract the flags */
1031 if ((s = strchr (s, ':')))
1032 m_strcpy(suffix, sizeof(suffix), s);
1036 /* construct a new file name. */
1038 snprintf (path, _POSIX_PATH_MAX, "%s/%ld.%u_%d.%s%s", subdir,
1039 (long) time (NULL), (unsigned int) getpid (), Counter++,
1040 NONULL (Hostname), suffix);
1041 snprintf (full, _POSIX_PATH_MAX, "%s/%s", ctx->path, path);
1043 debug_print (2, ("renaming %s to %s.\n", msg->path, full));
1045 if (safe_rename (msg->path, full) == 0) {
1047 m_strreplace(&hdr->path, path);
1048 p_delete(&msg->path);
1051 * Adjust the mtime on the file to match the time at which this
1052 * message was received. Currently this is only set when copying
1053 * messages between mailboxes, so we test to ensure that it is
1056 if (msg->received) {
1059 ut.actime = msg->received;
1060 ut.modtime = msg->received;
1061 if (utime (full, &ut)) {
1063 ("maildir_commit_message(): unable to set time on file"));
1070 else if (errno != EEXIST) {
1071 mutt_perror (ctx->path);
1078 * commit a message to an MH folder.
1083 static int _mh_commit_message (MESSAGE * msg, CONTEXT * ctx, HEADER * hdr,
1089 unsigned int n, hi = 0;
1090 char path[_POSIX_PATH_MAX];
1093 if (safe_fclose (&msg->fp) != 0)
1096 if ((dirp = opendir (ctx->path)) == NULL) {
1097 mutt_perror (ctx->path);
1101 /* figure out what the next message number is */
1102 while ((de = readdir (dirp)) != NULL) {
1108 if (!isdigit ((unsigned char) *cp))
1121 * Now try to rename the file to the proper name.
1123 * Note: We may have to try multiple times, until we find a free
1129 snprintf (tmp, sizeof (tmp), "%d", hi);
1130 snprintf (path, sizeof (path), "%s/%s", ctx->path, tmp);
1131 if (safe_rename (msg->path, path) == 0) {
1133 m_strreplace(&hdr->path, tmp);
1134 p_delete(&msg->path);
1137 else if (errno != EEXIST) {
1138 mutt_perror (ctx->path);
1143 mh_sequences_add_one (ctx, hi, !msg->flags.read, msg->flags.flagged,
1144 msg->flags.replied);
1148 static int mh_commit_message (MESSAGE * msg, CONTEXT * ctx, HEADER * hdr) {
1149 return _mh_commit_message (msg, ctx, hdr, 1);
1152 /* Sync a message in an MH folder.
1154 * This code is also used for attachment deletion in maildir
1158 static int mh_rewrite_message (CONTEXT * ctx, int msgno)
1160 HEADER *h = ctx->hdrs[msgno];
1165 char oldpath[_POSIX_PATH_MAX];
1166 char newpath[_POSIX_PATH_MAX];
1167 char partpath[_POSIX_PATH_MAX];
1169 long old_body_offset = h->content->offset;
1170 long old_body_length = h->content->length;
1171 long old_hdr_lines = h->lines;
1173 if ((dest = mx_open_new_message (ctx, h, 0)) == NULL)
1176 if ((rc = mutt_copy_message (dest->fp, ctx, h,
1177 M_CM_UPDATE, CH_UPDATE | CH_UPDATE_LEN)) == 0)
1179 snprintf (oldpath, sizeof(oldpath), "%s/%s", ctx->path, h->path);
1180 m_strcpy(partpath, sizeof(partpath), h->path);
1182 if (ctx->magic == M_MAILDIR)
1183 rc = maildir_commit_message (dest, ctx, h);
1185 rc = _mh_commit_message (dest, ctx, h, 0);
1187 mx_close_message (&dest);
1195 * Try to move the new message to the old place.
1198 * This is important when we are just updating flags.
1200 * Note that there is a race condition against programs which
1201 * use the first free slot instead of the maximum message
1202 * number. Mutt does _not_ behave like this.
1204 * Anyway, if this fails, the message is in the folder, so
1205 * all what happens is that a concurrently runnung mutt will
1206 * lose flag modifications.
1209 if (ctx->magic == M_MH && rc == 0) {
1210 snprintf (newpath, _POSIX_PATH_MAX, "%s/%s", ctx->path, h->path);
1211 if ((rc = safe_rename (newpath, oldpath)) == 0)
1212 m_strreplace(&h->path, partpath);
1216 mx_close_message (&dest);
1218 if (rc == -1 && restore) {
1219 h->content->offset = old_body_offset;
1220 h->content->length = old_body_length;
1221 h->lines = old_hdr_lines;
1224 mutt_free_body (&h->content->parts);
1228 static int mh_sync_message (CONTEXT * ctx, int msgno)
1230 HEADER *h = ctx->hdrs[msgno];
1232 if (h->attach_del ||
1233 (h->env && (h->env->refs_changed || h->env->irt_changed)))
1234 if (mh_rewrite_message (ctx, msgno) != 0)
1240 static int maildir_sync_message (CONTEXT * ctx, int msgno)
1242 HEADER *h = ctx->hdrs[msgno];
1244 if (h->attach_del ||
1245 (h->env && (h->env->refs_changed || h->env->irt_changed))) {
1246 /* when doing attachment deletion/rethreading, fall back to the MH case. */
1247 if (mh_rewrite_message (ctx, msgno) != 0)
1251 /* we just have to rename the file. */
1253 char newpath[_POSIX_PATH_MAX];
1254 char partpath[_POSIX_PATH_MAX];
1255 char fullpath[_POSIX_PATH_MAX];
1256 char oldpath[_POSIX_PATH_MAX];
1260 if ((p = strrchr (h->path, '/')) == NULL) {
1261 debug_print (1, ("%s: unable to find subdir!\n", h->path));
1265 m_strcpy(newpath, sizeof(newpath), p);
1267 /* kill the previous flags */
1268 if ((p = strchr (newpath, ':')) != NULL)
1271 maildir_flags (suffix, sizeof (suffix), h);
1273 snprintf (partpath, sizeof (partpath), "%s/%s%s",
1274 (h->read || h->old) ? "cur" : "new", newpath, suffix);
1275 snprintf (fullpath, sizeof (fullpath), "%s/%s", ctx->path, partpath);
1276 snprintf (oldpath, sizeof (oldpath), "%s/%s", ctx->path, h->path);
1278 if (m_strcmp(fullpath, oldpath) == 0) {
1279 /* message hasn't really changed */
1283 /* record that the message is possibly marked as trashed on disk */
1284 h->trash = h->deleted;
1286 if (rename (oldpath, fullpath) != 0) {
1287 mutt_perror ("rename");
1290 m_strreplace(&h->path, partpath);
1295 static int mh_sync_mailbox (CONTEXT * ctx, int unused __attribute__ ((unused)), int *index_hint)
1297 char path[_POSIX_PATH_MAX], tmp[_POSIX_PATH_MAX];
1302 #endif /* USE_HCACHE */
1304 if (ctx->magic == M_MH)
1305 i = mh_check_mailbox (ctx, index_hint, 0);
1307 i = maildir_check_mailbox (ctx, index_hint, 0);
1313 if (ctx->magic == M_MAILDIR)
1314 hc = mutt_hcache_open (HeaderCache, ctx->path);
1315 #endif /* USE_HCACHE */
1317 for (i = 0; i < ctx->msgcount; i++) {
1318 if (ctx->hdrs[i]->deleted
1319 && (ctx->magic != M_MAILDIR || !option (OPTMAILDIRTRASH))) {
1320 snprintf (path, sizeof (path), "%s/%s", ctx->path, ctx->hdrs[i]->path);
1321 if (ctx->magic == M_MAILDIR
1322 || (option (OPTMHPURGE) && ctx->magic == M_MH)) {
1324 if (ctx->magic == M_MAILDIR)
1325 mutt_hcache_delete (hc, ctx->hdrs[i]->path + 3,
1326 &maildir_hcache_keylen);
1327 #endif /* USE_HCACHE */
1330 else if (ctx->magic == M_MH) {
1331 /* MH just moves files out of the way when you delete them */
1332 if (*ctx->hdrs[i]->path != ',') {
1333 snprintf (tmp, sizeof (tmp), "%s/,%s", ctx->path,
1334 ctx->hdrs[i]->path);
1341 else if (ctx->hdrs[i]->changed || ctx->hdrs[i]->attach_del ||
1342 (ctx->magic == M_MAILDIR
1343 && (option (OPTMAILDIRTRASH) || ctx->hdrs[i]->trash)
1344 && (ctx->hdrs[i]->deleted != ctx->hdrs[i]->trash))) {
1345 if (ctx->magic == M_MAILDIR) {
1346 if (maildir_sync_message (ctx, i) == -1)
1350 if (mh_sync_message (ctx, i) == -1)
1357 if (ctx->magic == M_MAILDIR)
1358 mutt_hcache_close (hc);
1359 #endif /* USE_HCACHE */
1361 if (ctx->magic == M_MH)
1362 mh_update_sequences (ctx);
1364 /* XXX race condition? */
1366 maildir_update_mtime (ctx);
1368 /* adjust indices */
1371 for (i = 0, j = 0; i < ctx->msgcount; i++) {
1372 if (!ctx->hdrs[i]->deleted
1373 || (ctx->magic == M_MAILDIR && option (OPTMAILDIRTRASH)))
1374 ctx->hdrs[i]->index = j++;
1382 if (ctx->magic == M_MAILDIR)
1383 mutt_hcache_close (hc);
1384 #endif /* USE_HCACHE */
1388 static char *maildir_canon_filename (char *dest, const char *src, size_t l)
1392 if ((t = strrchr (src, '/')))
1395 m_strcpy(dest, l, src);
1396 if ((u = strrchr (dest, ':')))
1402 static void maildir_update_tables (CONTEXT * ctx, int *index_hint)
1408 if (Sort != SORT_ORDER) {
1411 mutt_sort_headers (ctx, 1);
1415 old_count = ctx->msgcount;
1416 for (i = 0, j = 0; i < old_count; i++) {
1417 if (ctx->hdrs[i]->active && index_hint && *index_hint == i)
1420 if (ctx->hdrs[i]->active)
1421 ctx->hdrs[i]->index = j++;
1424 mx_update_tables (ctx, 0);
1425 mutt_clear_threads (ctx);
1428 static void maildir_update_flags (CONTEXT * ctx, HEADER * o, HEADER * n)
1430 /* save the global state here so we can reset it at the
1431 * end of list block if required.
1433 int context_changed = ctx->changed;
1435 /* user didn't modify this message. alter the flags to
1436 * match the current state on disk. This may not actually
1437 * do anything, but we can't tell right now. mutt_set_flag()
1438 * will just ignore the call if the status bits are
1439 * already properly set.
1441 mutt_set_flag (ctx, o, M_FLAG, n->flagged);
1442 mutt_set_flag (ctx, o, M_REPLIED, n->replied);
1443 mutt_set_flag (ctx, o, M_READ, n->read);
1444 mutt_set_flag (ctx, o, M_OLD, n->old);
1446 /* mutt_set_flag() will set this, but we don't need to
1447 * sync the changes we made because we just updated the
1448 * context to match the current on-disk state of the
1453 /* if the mailbox was not modified before we made these
1454 * changes, unset the changed flag since nothing needs to
1457 if (!context_changed)
1462 /* This function handles arrival of new mail and reopening of
1463 * maildir folders. The basic idea here is we check to see if either
1464 * the new or cur subdirectories have changed, and if so, we scan them
1465 * for the list of files. We check for newly added messages, and
1466 * then merge the flags messages we already knew about. We don't treat
1467 * either subdirectory differently, as mail could be copied directly into
1468 * the cur directory from another agent.
1470 static int maildir_check_mailbox (CONTEXT * ctx, int *index_hint, int unused __attribute__ ((unused)))
1472 struct stat st_new; /* status of the "new" subdirectory */
1473 struct stat st_cur; /* status of the "cur" subdirectory */
1474 char buf[_POSIX_PATH_MAX];
1475 int changed = 0; /* bitmask representing which subdirectories
1476 have changed. 0x1 = new, 0x2 = cur */
1477 int occult = 0; /* messages were removed from the mailbox */
1478 int have_new = 0; /* messages were added to the mailbox */
1479 struct maildir *md; /* list of messages in the mailbox */
1480 struct maildir **last, *p;
1482 HASH *fnames; /* hash table for quickly looking up the base filename
1483 for a maildir message */
1485 if (!option (OPTCHECKNEW))
1488 snprintf (buf, sizeof (buf), "%s/new", ctx->path);
1489 if (stat (buf, &st_new) == -1)
1492 snprintf (buf, sizeof (buf), "%s/cur", ctx->path);
1493 if (stat (buf, &st_cur) == -1)
1496 /* determine which subdirectories need to be scanned */
1497 if (st_new.st_mtime > ctx->mtime)
1499 if (st_cur.st_mtime > ctx->mtime_cur)
1503 return 0; /* nothing to do */
1505 /* update the modification times on the mailbox */
1506 ctx->mtime_cur = st_cur.st_mtime;
1507 ctx->mtime = st_new.st_mtime;
1509 /* do a fast scan of just the filenames in
1510 * the subdirectories that have changed.
1515 maildir_parse_dir (ctx, &last, "new", NULL);
1517 maildir_parse_dir (ctx, &last, "cur", NULL);
1519 /* we create a hash table keyed off the canonical (sans flags) filename
1520 * of each message we scanned. This is used in the loop over the
1521 * existing messages below to do some correlation.
1523 fnames = hash_create (1031);
1525 for (p = md; p; p = p->next) {
1526 maildir_canon_filename (buf, p->h->path, sizeof (buf));
1527 p->canon_fname = m_strdup(buf);
1528 hash_insert (fnames, p->canon_fname, p, 0);
1531 /* check for modifications and adjust flags */
1532 for (i = 0; i < ctx->msgcount; i++) {
1533 ctx->hdrs[i]->active = 0;
1534 maildir_canon_filename (buf, ctx->hdrs[i]->path, sizeof (buf));
1535 p = hash_find (fnames, buf);
1537 /* message already exists, merge flags */
1538 ctx->hdrs[i]->active = 1;
1540 /* check to see if the message has moved to a different
1541 * subdirectory. If so, update the associated filename.
1543 if (m_strcmp(ctx->hdrs[i]->path, p->h->path))
1544 m_strreplace(&ctx->hdrs[i]->path, p->h->path);
1546 /* if the user hasn't modified the flags on this message, update
1547 * the flags we just detected.
1549 if (!ctx->hdrs[i]->changed)
1550 maildir_update_flags (ctx, ctx->hdrs[i], p->h);
1552 if (ctx->hdrs[i]->deleted == ctx->hdrs[i]->trash)
1553 ctx->hdrs[i]->deleted = p->h->deleted;
1554 ctx->hdrs[i]->trash = p->h->trash;
1556 /* this is a duplicate of an existing header, so remove it */
1557 header_delete(&p->h);
1559 /* This message was not in the list of messages we just scanned.
1560 * Check to see if we have enough information to know if the
1561 * message has disappeared out from underneath us.
1563 else if (((changed & 1) && (!strncmp (ctx->hdrs[i]->path, "new/", 4))) ||
1564 ((changed & 2) && (!strncmp (ctx->hdrs[i]->path, "cur/", 4)))) {
1565 /* This message disappeared, so we need to simulate a "reopen"
1566 * event. We know it disappeared because we just scanned the
1567 * subdirectory it used to reside in.
1572 /* This message resides in a subdirectory which was not
1573 * modified, so we assume that it is still present and
1576 ctx->hdrs[i]->active = 1;
1580 /* destroy the file name hash */
1581 hash_destroy (&fnames, NULL);
1583 /* If we didn't just get new mail, update the tables. */
1585 maildir_update_tables (ctx, index_hint);
1587 /* do any delayed parsing we need to do. */
1588 maildir_delayed_parsing (ctx, md);
1590 /* Incorporate new messages */
1591 have_new = maildir_move_to_context (ctx, &md);
1593 return occult ? M_REOPENED : (have_new ? M_NEW_MAIL : 0);
1597 * This function handles arrival of new mail and reopening of
1598 * mh/maildir folders. Things are getting rather complex because we
1599 * don't have a well-defined "mailbox order", so the tricks from
1600 * mbox.c and mx.c won't work here.
1602 * Don't change this code unless you _really_ understand what
1607 static int mh_check_mailbox (CONTEXT * ctx, int *index_hint, int unused __attribute__ ((unused)))
1609 char buf[_POSIX_PATH_MAX];
1610 struct stat st, st_cur;
1611 short modified = 0, have_new = 0, occult = 0;
1612 struct maildir *md, *p;
1613 struct maildir **last = NULL;
1614 struct mh_sequences mhs;
1618 if (!option (OPTCHECKNEW))
1621 m_strcpy(buf, sizeof(buf), ctx->path);
1622 if (stat (buf, &st) == -1)
1625 /* create .mh_sequences when there isn't one. */
1626 snprintf (buf, sizeof (buf), "%s/.mh_sequences", ctx->path);
1627 if ((i = stat (buf, &st_cur) == -1) && errno == ENOENT) {
1631 if (mh_mkstemp (ctx, &fp, &tmp) == 0) {
1633 if (safe_rename (tmp, buf) == -1)
1639 if (i == -1 && stat (buf, &st_cur) == -1)
1642 if (st.st_mtime > ctx->mtime || st_cur.st_mtime > ctx->mtime_cur)
1648 ctx->mtime_cur = st_cur.st_mtime;
1649 ctx->mtime = st.st_mtime;
1655 maildir_parse_dir (ctx, &last, NULL, NULL);
1656 mh_read_sequences (&mhs, ctx->path);
1657 mh_update_maildir (md, &mhs);
1658 mhs_free_sequences (&mhs);
1660 /* check for modifications and adjust flags */
1661 fnames = hash_create (1031);
1663 for (p = md; p; p = p->next)
1664 hash_insert (fnames, p->h->path, p, 0);
1666 for (i = 0; i < ctx->msgcount; i++) {
1667 ctx->hdrs[i]->active = 0;
1669 if ((p = hash_find (fnames, ctx->hdrs[i]->path)) && p->h &&
1670 (mutt_cmp_header (ctx->hdrs[i], p->h))) {
1671 ctx->hdrs[i]->active = 1;
1672 /* found the right message */
1673 if (!ctx->hdrs[i]->changed)
1674 maildir_update_flags (ctx, ctx->hdrs[i], p->h);
1676 header_delete(&p->h);
1678 else /* message has disappeared */
1682 /* destroy the file name hash */
1684 hash_destroy (&fnames, NULL);
1686 /* If we didn't just get new mail, update the tables. */
1688 maildir_update_tables (ctx, index_hint);
1690 /* Incorporate new messages */
1691 have_new = maildir_move_to_context (ctx, &md);
1693 return occult ? M_REOPENED : (have_new ? M_NEW_MAIL : 0);
1700 * These functions try to find a message in a maildir folder when it
1701 * has moved under our feet. Note that this code is rather expensive, but
1702 * then again, it's called rarely.
1705 FILE *_maildir_open_find_message (const char *folder, const char *unique,
1706 const char *subfolder)
1708 char dir[_POSIX_PATH_MAX];
1709 char tunique[_POSIX_PATH_MAX];
1710 char fname[_POSIX_PATH_MAX];
1718 snprintf (dir, sizeof (dir), "%s/%s", folder, subfolder);
1720 if ((dp = opendir (dir)) == NULL) {
1725 while ((de = readdir (dp))) {
1726 maildir_canon_filename (tunique, de->d_name, sizeof (tunique));
1728 if (!m_strcmp(tunique, unique)) {
1729 snprintf (fname, sizeof (fname), "%s/%s/%s", folder, subfolder,
1731 fp = fopen (fname, "r"); /* __FOPEN_CHECKED__ */
1743 FILE *maildir_open_find_message (const char *folder, const char *msg)
1745 char unique[_POSIX_PATH_MAX];
1748 static unsigned int new_hits = 0, cur_hits = 0; /* simple dynamic optimization */
1750 maildir_canon_filename (unique, msg, sizeof (unique));
1753 _maildir_open_find_message (folder, unique,
1754 new_hits > cur_hits ? "new" : "cur"))
1755 || errno != ENOENT) {
1756 if (new_hits < UINT_MAX && cur_hits < UINT_MAX) {
1757 new_hits += (new_hits > cur_hits ? 1 : 0);
1758 cur_hits += (new_hits > cur_hits ? 0 : 1);
1764 _maildir_open_find_message (folder, unique,
1765 new_hits > cur_hits ? "cur" : "new"))
1766 || errno != ENOENT) {
1767 if (new_hits < UINT_MAX && cur_hits < UINT_MAX) {
1768 new_hits += (new_hits > cur_hits ? 0 : 1);
1769 cur_hits += (new_hits > cur_hits ? 1 : 0);
1781 * 1 if there are no messages in the mailbox
1782 * 0 if there are messages in the mailbox
1785 static int maildir_check_empty (const char *path)
1789 int r = 1; /* assume empty until we find a message */
1790 char frealpath[_POSIX_PATH_MAX];
1793 /* Strategy here is to look for any file not beginning with a period */
1796 /* we do "cur" on the first iteration since its more likely that we'll
1797 * find old messages without having to scan both subdirs
1799 snprintf (frealpath, sizeof (frealpath), "%s/%s", path,
1800 iter == 0 ? "cur" : "new");
1801 if ((dp = opendir (frealpath)) == NULL)
1803 while ((de = readdir (dp))) {
1804 if (*de->d_name != '.') {
1811 } while (r && iter < 2);
1818 * 1 if there are no messages in the mailbox
1819 * 0 if there are messages in the mailbox
1822 int mh_check_empty (const char *path)
1826 int r = 1; /* assume empty until we find a message */
1828 if ((dp = opendir (path)) == NULL)
1830 while ((de = readdir (dp))) {
1831 if (mh_valid_message (de->d_name)) {
1841 static int mh_is_magic (const char* path, struct stat* st) {
1842 char tmp[_POSIX_PATH_MAX];
1844 if (S_ISDIR (st->st_mode)) {
1845 snprintf (tmp, sizeof (tmp), "%s/.mh_sequences", path);
1846 if (access (tmp, F_OK) == 0)
1849 snprintf (tmp, sizeof (tmp), "%s/.xmhcache", path);
1850 if (access (tmp, F_OK) == 0)
1853 snprintf (tmp, sizeof (tmp), "%s/.mew_cache", path);
1854 if (access (tmp, F_OK) == 0)
1857 snprintf (tmp, sizeof (tmp), "%s/.mew-cache", path);
1858 if (access (tmp, F_OK) == 0)
1861 snprintf (tmp, sizeof (tmp), "%s/.sylpheed_cache", path);
1862 if (access (tmp, F_OK) == 0)
1866 * ok, this isn't an mh folder, but mh mode can be used to read
1867 * Usenet news from the spool. ;-)
1870 snprintf (tmp, sizeof (tmp), "%s/.overview", path);
1871 if (access (tmp, F_OK) == 0)
1877 static int maildir_is_magic (const char* path, struct stat* st) {
1879 char tmp[_POSIX_PATH_MAX];
1881 if (S_ISDIR (st->st_mode)) {
1882 snprintf (tmp, sizeof (tmp), "%s/cur", path);
1883 if (stat (tmp, &sb) == 0 && S_ISDIR (sb.st_mode))
1889 /* routines common to maildir and mh */
1890 static mx_t* reg_mx (void) {
1891 mx_t* fmt = p_new(mx_t, 1);
1893 fmt->mx_access = access;
1894 fmt->mx_sync_mailbox = mh_sync_mailbox;
1898 static int mh_commit (MESSAGE* msg, CONTEXT* ctx) {
1899 return (mh_commit_message (msg, ctx, NULL));
1902 static int maildir_commit (MESSAGE* msg, CONTEXT* ctx) {
1903 return (maildir_commit_message (msg, ctx, NULL));
1906 mx_t* mh_reg_mx (void) {
1907 mx_t* fmt = reg_mx ();
1909 fmt->mx_check_empty = mh_check_empty;
1910 fmt->mx_is_magic = mh_is_magic;
1911 fmt->mx_open_mailbox = mh_read_dir;
1912 fmt->mx_open_new_message = mh_open_new_message;
1913 fmt->mx_check_mailbox = mh_check_mailbox;
1914 fmt->mx_commit_message = mh_commit;
1918 mx_t* maildir_reg_mx (void) {
1919 mx_t* fmt = reg_mx ();
1920 fmt->type = M_MAILDIR;
1921 fmt->mx_check_empty = maildir_check_empty;
1922 fmt->mx_is_magic = maildir_is_magic;
1923 fmt->mx_open_mailbox = maildir_read_dir;
1924 fmt->mx_open_new_message = maildir_open_new_message;
1925 fmt->mx_check_mailbox = maildir_check_mailbox;
1926 fmt->mx_commit_message = maildir_commit;