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/curses.h>
34 unsigned header_parsed:1;
43 /* mh_sequences support */
45 #define MH_SEQ_UNSEEN (1 << 0)
46 #define MH_SEQ_REPLIED (1 << 1)
47 #define MH_SEQ_FLAGGED (1 << 2)
50 static int maildir_check_empty (const char*);
51 static int maildir_check_mailbox (CONTEXT*, int*, int);
52 static int mh_check_mailbox (CONTEXT*, int*, int);
54 static void mhs_alloc (struct mh_sequences *mhs, int i)
59 if (i > mhs->max || !mhs->flags) {
61 p_realloc(&mhs->flags, newmax + 1);
62 for (j = mhs->max + 1; j <= newmax; j++)
69 static void mhs_free_sequences (struct mh_sequences *mhs)
71 p_delete(&mhs->flags);
74 static short mhs_check (struct mh_sequences *mhs, int i)
76 if (!mhs->flags || i > mhs->max)
82 static short mhs_set (struct mh_sequences *mhs, int i, short f)
93 static short mhs_unset (struct mh_sequences *mhs, int i, short f)
102 static void mh_read_token (char *t, int *first, int *last)
106 if ((p = strchr (t, '-'))) {
112 *first = *last = atoi (t);
115 static void mh_read_sequences (struct mh_sequences *mhs, const char *path)
126 char pathname[_POSIX_PATH_MAX];
128 snprintf (pathname, sizeof (pathname), "%s/.mh_sequences", path);
130 if (!(fp = fopen (pathname, "r")))
133 while ((buff = mutt_read_line (buff, &sz, fp, &line))) {
134 if (!(t = strtok (buff, " \t:")))
137 if (!m_strcmp(t, MhUnseen))
139 else if (!m_strcmp(t, MhFlagged))
141 else if (!m_strcmp(t, MhReplied))
143 else /* unknown sequence */
146 while ((t = strtok (NULL, " \t:"))) {
147 mh_read_token (t, &first, &last);
148 for (; first <= last; first++)
149 mhs_set (mhs, first, f);
157 int mh_buffy (const char *path)
160 struct mh_sequences mhs;
164 mh_read_sequences (&mhs, path);
165 for (i = 0; !r && i <= mhs.max; i++)
166 if (mhs_check (&mhs, i) & MH_SEQ_UNSEEN)
168 mhs_free_sequences (&mhs);
172 static int mh_mkstemp (CONTEXT * dest, FILE ** fp, char **tgt)
175 char path[_POSIX_PATH_MAX];
178 snprintf (path, _POSIX_PATH_MAX, "%s/.mutt-%s-%d-%d",
179 dest->path, NONULL (Hostname), (int) getpid (), Counter++);
181 if ((fd = open (path, O_WRONLY | O_EXCL | O_CREAT, 0666)) == -1) {
182 if (errno != EEXIST) {
188 *tgt = m_strdup(path);
193 if ((*fp = fdopen (fd, "w")) == NULL) {
203 static void mhs_write_one_sequence (FILE * fp, struct mh_sequences *mhs,
204 short f, const char *tag)
209 fprintf (fp, "%s:", tag);
214 for (i = 0; i <= mhs->max; i++) {
215 if ((mhs_check (mhs, i) & f)) {
221 else if (first >= 0) {
223 fprintf (fp, " %d", first);
225 fprintf (fp, " %d-%d", first, last);
234 fprintf (fp, " %d", first);
236 fprintf (fp, " %d-%d", first, last);
242 /* XXX - we don't currently remove deleted messages from sequences we don't know. Should we? */
244 static void mh_update_sequences (CONTEXT * ctx)
248 char sequences[_POSIX_PATH_MAX];
260 char seq_unseen[STRING];
261 char seq_replied[STRING];
262 char seq_flagged[STRING];
265 struct mh_sequences mhs;
269 snprintf (seq_unseen, sizeof (seq_unseen), "%s:", NONULL (MhUnseen));
270 snprintf (seq_replied, sizeof (seq_replied), "%s:", NONULL (MhReplied));
271 snprintf (seq_flagged, sizeof (seq_flagged), "%s:", NONULL (MhFlagged));
273 if (mh_mkstemp (ctx, &nfp, &tmpfname) != 0) {
278 snprintf (sequences, sizeof (sequences), "%s/.mh_sequences", ctx->path);
281 /* first, copy unknown sequences */
282 if ((ofp = fopen (sequences, "r"))) {
283 while ((buff = mutt_read_line (buff, &s, ofp, &l))) {
284 if (!m_strncmp(buff, seq_unseen, m_strlen(seq_unseen)))
286 if (!m_strncmp(buff, seq_flagged, m_strlen(seq_flagged)))
288 if (!m_strncmp(buff, seq_replied, m_strlen(seq_replied)))
291 fprintf (nfp, "%s\n", buff);
296 /* now, update our unseen, flagged, and replied sequences */
297 for (l = 0; l < ctx->msgcount; l++) {
298 if (ctx->hdrs[l]->deleted)
301 if ((p = strrchr (ctx->hdrs[l]->path, '/')))
304 p = ctx->hdrs[l]->path;
308 if (!ctx->hdrs[l]->read) {
309 mhs_set (&mhs, i, MH_SEQ_UNSEEN);
312 if (ctx->hdrs[l]->flagged) {
313 mhs_set (&mhs, i, MH_SEQ_FLAGGED);
316 if (ctx->hdrs[l]->replied) {
317 mhs_set (&mhs, i, MH_SEQ_REPLIED);
322 /* write out the new sequences */
324 mhs_write_one_sequence (nfp, &mhs, MH_SEQ_UNSEEN, NONULL (MhUnseen));
326 mhs_write_one_sequence (nfp, &mhs, MH_SEQ_FLAGGED, NONULL (MhFlagged));
328 mhs_write_one_sequence (nfp, &mhs, MH_SEQ_REPLIED, NONULL (MhReplied));
330 mhs_free_sequences (&mhs);
333 /* try to commit the changes - no guarantee here */
337 if (safe_rename (tmpfname, sequences) != 0) {
338 /* report an error? */
345 static void mh_sequences_add_one (CONTEXT * ctx, int n, short unseen,
346 short flagged, short replied)
348 short unseen_done = 0;
349 short flagged_done = 0;
350 short replied_done = 0;
352 FILE *ofp = NULL, *nfp = NULL;
355 char sequences[_POSIX_PATH_MAX];
357 char seq_unseen[STRING];
358 char seq_replied[STRING];
359 char seq_flagged[STRING];
365 if (mh_mkstemp (ctx, &nfp, &tmpfname) == -1)
368 snprintf (seq_unseen, sizeof (seq_unseen), "%s:", NONULL (MhUnseen));
369 snprintf (seq_replied, sizeof (seq_replied), "%s:", NONULL (MhReplied));
370 snprintf (seq_flagged, sizeof (seq_flagged), "%s:", NONULL (MhFlagged));
372 snprintf (sequences, sizeof (sequences), "%s/.mh_sequences", ctx->path);
373 if ((ofp = fopen (sequences, "r"))) {
374 while ((buff = mutt_read_line (buff, &sz, ofp, &line))) {
375 if (unseen && !strncmp (buff, seq_unseen, m_strlen(seq_unseen))) {
376 fprintf (nfp, "%s %d\n", buff, n);
380 && !strncmp (buff, seq_flagged, m_strlen(seq_flagged))) {
381 fprintf (nfp, "%s %d\n", buff, n);
385 && !strncmp (buff, seq_replied, m_strlen(seq_replied))) {
386 fprintf (nfp, "%s %d\n", buff, n);
390 fprintf (nfp, "%s\n", buff);
396 if (!unseen_done && unseen)
397 fprintf (nfp, "%s: %d\n", NONULL (MhUnseen), n);
398 if (!flagged_done && flagged)
399 fprintf (nfp, "%s: %d\n", NONULL (MhFlagged), n);
400 if (!replied_done && replied)
401 fprintf (nfp, "%s: %d\n", NONULL (MhReplied), n);
406 if (safe_rename (tmpfname, sequences) != 0)
412 static void mh_update_maildir (struct maildir *md, struct mh_sequences *mhs)
418 for (; md; md = md->next) {
419 if ((p = strrchr (md->h->path, '/')))
425 f = mhs_check (mhs, i);
427 md->h->read = (f & MH_SEQ_UNSEEN) ? 0 : 1;
428 md->h->flagged = (f & MH_SEQ_FLAGGED) ? 1 : 0;
429 md->h->replied = (f & MH_SEQ_REPLIED) ? 1 : 0;
433 /* maildir support */
435 static void maildir_free_entry (struct maildir **md)
440 p_delete(&(*md)->canon_fname);
442 header_delete(&(*md)->h);
447 static void maildir_free_maildir (struct maildir **md)
449 struct maildir *p, *q;
454 for (p = *md; p; p = q) {
456 maildir_free_entry (&p);
460 static void maildir_parse_flags (HEADER * h, const char *path)
468 if ((p = strrchr (path, ':')) != NULL && m_strncmp(p + 1, "2,", 2) == 0) {
471 m_strreplace(&h->maildir_flags, p);
472 q = h->maildir_flags;
486 case 'R': /* replied */
491 case 'T': /* trashed */
504 if (q == h->maildir_flags)
505 p_delete(&h->maildir_flags);
510 static void maildir_update_mtime (CONTEXT * ctx)
512 char buf[_POSIX_PATH_MAX];
515 if (ctx->magic == M_MAILDIR) {
516 snprintf (buf, sizeof (buf), "%s/%s", ctx->path, "cur");
517 if (stat (buf, &st) == 0)
518 ctx->mtime_cur = st.st_mtime;
519 snprintf (buf, sizeof (buf), "%s/%s", ctx->path, "new");
522 snprintf (buf, sizeof (buf), "%s/.mh_sequences", ctx->path);
523 if (stat (buf, &st) == 0)
524 ctx->mtime_cur = st.st_mtime;
526 m_strcpy(buf, sizeof(buf), ctx->path);
529 if (stat (buf, &st) == 0)
530 ctx->mtime = st.st_mtime;
534 * Actually parse a maildir message. This may also be used to fill
535 * out a fake header structure generated by lazy maildir parsing.
537 static HEADER *maildir_parse_message (int magic, const char *fname,
538 int is_old, HEADER * _h)
544 if ((f = fopen (fname, "r")) != NULL) {
547 h->env = mutt_read_rfc822_header (f, h, 0, 0);
549 fstat (fileno (f), &st);
553 h->received = h->date_sent;
555 if (h->content->length <= 0)
556 h->content->length = st.st_size - h->content->offset;
560 if (magic == M_MAILDIR) {
562 * maildir stores its flags in the filename, so ignore the
563 * flags in the header of the message
567 maildir_parse_flags (h, fname);
575 * Note that this routine will _not_ modify the context given by
578 * It's used in the first parsing pass on maildir and MH folders.
579 * In the MH case, this means full parsing of the folder. In the
580 * maildir case, it means that we only look at flags, and create a
581 * fake HEADER structure, which may later be filled in by
582 * maildir_parse_message(), when called from
583 * maildir_delayed_parsing().
587 static int maildir_parse_entry (CONTEXT * ctx, struct maildir ***last,
588 const char *subdir, const char *fname,
589 int *count, int is_old, ino_t inode __attribute__ ((unused)))
591 struct maildir *entry;
593 char buf[_POSIX_PATH_MAX];
596 snprintf (buf, sizeof (buf), "%s/%s/%s", ctx->path, subdir, fname);
598 snprintf (buf, sizeof (buf), "%s/%s", ctx->path, fname);
600 if (ctx->magic == M_MH)
601 h = maildir_parse_message (ctx->magic, buf, is_old, NULL);
605 maildir_parse_flags (h, buf);
611 if (!ctx->quiet && ReadInc && ((*count % ReadInc) == 0 || *count == 1))
612 mutt_message (_("Reading %s... %d"), ctx->path, *count);
616 snprintf (buf, sizeof (buf), "%s/%s", subdir, fname);
617 h->path = m_strdup(buf);
620 h->path = m_strdup(fname);
622 entry = p_new(struct maildir, 1);
624 entry->header_parsed = (ctx->magic == M_MH);
626 *last = &entry->next;
636 /* Ignore the garbage files. A valid MH message consists of only
637 * digits. Deleted message get moved to a filename with a comma before
641 int mh_valid_message (const char *s)
644 if (!isdigit ((unsigned char) *s))
650 static int maildir_parse_dir (CONTEXT * ctx, struct maildir ***last,
651 const char *subdir, int *count)
655 char buf[_POSIX_PATH_MAX];
659 snprintf (buf, sizeof (buf), "%s/%s", ctx->path, subdir);
660 is_old = (m_strcmp("cur", subdir) == 0);
663 m_strcpy(buf, sizeof(buf), ctx->path);
665 if ((dirp = opendir (buf)) == NULL)
668 while ((de = readdir (dirp)) != NULL) {
670 if ((ctx->magic == M_MH && !mh_valid_message (de->d_name))
671 || (ctx->magic == M_MAILDIR && *de->d_name == '.'))
674 /* FOO - really ignore the return value? */
676 maildir_parse_entry (ctx, last, subdir, de->d_name, count, is_old,
677 #if HAVE_DIRENT_D_INO
689 static int maildir_add_to_context (CONTEXT * ctx, struct maildir *md)
691 int oldmsgcount = ctx->msgcount;
696 if (ctx->msgcount == ctx->hdrmax)
697 mx_alloc_memory (ctx);
699 ctx->hdrs[ctx->msgcount] = md->h;
700 ctx->hdrs[ctx->msgcount]->index = ctx->msgcount;
702 md->h->content->length + md->h->content->offset -
703 md->h->content->hdr_offset;
711 if (ctx->msgcount > oldmsgcount) {
712 mx_update_context (ctx, ctx->msgcount - oldmsgcount);
718 static int maildir_move_to_context (CONTEXT * ctx, struct maildir **md)
722 r = maildir_add_to_context (ctx, *md);
723 maildir_free_maildir (md);
728 static ssize_t maildir_hcache_keylen (const char *fn)
730 return m_strchrnul(fn, ':') - fn;
735 * This function does the second parsing pass for a maildir-style
738 static void maildir_delayed_parsing (CONTEXT * ctx, struct maildir *md)
741 char fn[_POSIX_PATH_MAX];
747 struct timeval *when = NULL;
748 struct stat lastchanged;
751 hc = mutt_hcache_open (HeaderCache, ctx->path);
754 for (p = md, count = 0; p; p = p->next, count++) {
755 if (!(p && p->h && !p->header_parsed))
759 data = mutt_hcache_fetch (hc, p->h->path + 3, &maildir_hcache_keylen);
760 when = (struct timeval *) data;
763 if (!ctx->quiet && ReadInc && ((count % ReadInc) == 0 || count == 1))
764 mutt_message (_("Reading %s... %d"), ctx->path, count);
765 snprintf (fn, sizeof (fn), "%s/%s", ctx->path, p->h->path);
768 if (option (OPTHCACHEVERIFY)) {
769 ret = stat (fn, &lastchanged);
772 lastchanged.st_mtime = 0;
776 if (data != NULL && !ret && lastchanged.st_mtime <= when->tv_sec) {
777 p->h = mutt_hcache_restore ((unsigned char *) data, &p->h);
778 maildir_parse_flags (p->h, fn);
782 if (maildir_parse_message (ctx->magic, fn, p->h->old, p->h)) {
783 p->header_parsed = 1;
784 maildir_parse_flags (p->h, fn);
786 mutt_hcache_store (hc, p->h->path + 3, p->h, 0, &maildir_hcache_keylen);
790 header_delete(&p->h);
796 mutt_hcache_close (hc);
800 /* Read a MH/maildir style mailbox.
803 * ctx [IN/OUT] context for this mailbox
804 * subdir [IN] NULL for MH mailboxes, otherwise the subdir of the
805 * maildir mailbox to read from
807 static int _mh_read_dir (CONTEXT * ctx, const char *subdir)
810 struct mh_sequences mhs;
811 struct maildir **last;
817 maildir_update_mtime (ctx);
822 if (maildir_parse_dir (ctx, &last, subdir, &count) == -1)
825 if (ctx->magic == M_MH) {
826 mh_read_sequences (&mhs, ctx->path);
827 mh_update_maildir (md, &mhs);
828 mhs_free_sequences (&mhs);
831 if (ctx->magic == M_MAILDIR)
832 maildir_delayed_parsing (ctx, md);
834 maildir_move_to_context (ctx, &md);
838 static int mh_read_dir (CONTEXT* ctx) {
839 return (_mh_read_dir (ctx, NULL));
842 /* read a maildir style mailbox */
843 static int maildir_read_dir (CONTEXT * ctx)
845 /* maildir looks sort of like MH, except that there are two subdirectories
846 * of the main folder path from which to read messages
848 if (_mh_read_dir (ctx, "new") == -1 || _mh_read_dir (ctx, "cur") == -1)
855 * Open a new (temporary) message in an MH folder.
858 static int mh_open_new_message (MESSAGE * msg, CONTEXT * dest, HEADER * hdr __attribute__ ((unused)))
860 return mh_mkstemp (dest, &msg->fp, &msg->path);
863 static int ch_compar (const void *a, const void *b)
865 return (int) (*((const char *) a) - *((const char *) b));
868 static void maildir_flags (char *dest, ssize_t destlen, HEADER * hdr)
873 * The maildir specification requires that all files in the cur
874 * subdirectory have the :unique string appeneded, regardless of whether
875 * or not there are any flags. If .old is set, we know that this message
876 * will end up in the cur directory, so we include it in the following
877 * test even though there is no associated flag.
881 && (hdr->flagged || hdr->replied || hdr->read || hdr->deleted
882 || hdr->old || hdr->maildir_flags)) {
883 char tmp[LONG_STRING];
885 snprintf (tmp, sizeof (tmp),
887 hdr->flagged ? "F" : "",
888 hdr->replied ? "R" : "",
889 hdr->read ? "S" : "", hdr->deleted ? "T" : "",
890 NONULL (hdr->maildir_flags));
891 if (hdr->maildir_flags)
892 qsort (tmp, m_strlen(tmp), 1, ch_compar);
893 snprintf (dest, destlen, ":2,%s", tmp);
899 * Open a new (temporary) message in a maildir folder.
901 * Note that this uses _almost_ the maildir file name format, but
902 * with a {cur,new} prefix.
906 static int maildir_open_new_message (MESSAGE * msg, CONTEXT * dest, HEADER * hdr)
909 char path[_POSIX_PATH_MAX];
914 short deleted = hdr->deleted;
918 maildir_flags (suffix, sizeof (suffix), hdr);
920 hdr->deleted = deleted;
925 if (hdr && (hdr->read || hdr->old))
926 m_strcpy(subdir, sizeof(subdir), "cur");
928 m_strcpy(subdir, sizeof(subdir), "new");
931 snprintf (path, _POSIX_PATH_MAX, "%s/tmp/%s.%ld.%u_%d.%s%s",
932 dest->path, subdir, (long) time (NULL),
933 (unsigned int) getpid (), Counter++, NONULL (Hostname), suffix);
936 if ((fd = open (path, O_WRONLY | O_EXCL | O_CREAT, 0666)) == -1) {
937 if (errno != EEXIST) {
942 msg->path = m_strdup(path);
947 if ((msg->fp = fdopen (fd, "w")) == NULL) {
948 p_delete(&msg->path);
960 * Commit a message to a maildir folder.
962 * msg->path contains the file name of a file in tmp/. We take the
963 * flags from this file's name.
965 * ctx is the mail folder we commit to.
967 * hdr is a header structure to which we write the message's new
968 * file name. This is used in the mh and maildir folder synch
969 * routines. When this routine is invoked from mx_commit_message,
972 * msg->path looks like this:
974 * tmp/{cur,new}.mutt-HOSTNAME-PID-COUNTER:flags
976 * See also maildir_open_new_message().
980 static int maildir_commit_message (MESSAGE * msg, CONTEXT * ctx, HEADER * hdr)
984 char path[_POSIX_PATH_MAX];
985 char full[_POSIX_PATH_MAX];
988 if (safe_fclose (&msg->fp) != 0)
991 /* extract the subdir */
992 s = strrchr (msg->path, '/') + 1;
993 m_strcpy(subdir, sizeof(subdir), s);
995 /* extract the flags */
996 if ((s = strchr (s, ':')))
997 m_strcpy(suffix, sizeof(suffix), s);
1001 /* construct a new file name. */
1003 snprintf (path, _POSIX_PATH_MAX, "%s/%ld.%u_%d.%s%s", subdir,
1004 (long) time (NULL), (unsigned int) getpid (), Counter++,
1005 NONULL (Hostname), suffix);
1006 snprintf (full, _POSIX_PATH_MAX, "%s/%s", ctx->path, path);
1008 if (safe_rename (msg->path, full) == 0) {
1010 m_strreplace(&hdr->path, path);
1011 p_delete(&msg->path);
1014 * Adjust the mtime on the file to match the time at which this
1015 * message was received. Currently this is only set when copying
1016 * messages between mailboxes, so we test to ensure that it is
1019 if (msg->received) {
1022 ut.actime = msg->received;
1023 ut.modtime = msg->received;
1024 if (utime (full, &ut)) {
1026 ("maildir_commit_message(): unable to set time on file"));
1033 else if (errno != EEXIST) {
1034 mutt_perror (ctx->path);
1041 * commit a message to an MH folder.
1046 static int _mh_commit_message (MESSAGE * msg, CONTEXT * ctx, HEADER * hdr,
1052 unsigned int n, hi = 0;
1053 char path[_POSIX_PATH_MAX];
1056 if (safe_fclose (&msg->fp) != 0)
1059 if ((dirp = opendir (ctx->path)) == NULL) {
1060 mutt_perror (ctx->path);
1064 /* figure out what the next message number is */
1065 while ((de = readdir (dirp)) != NULL) {
1071 if (!isdigit ((unsigned char) *cp))
1084 * Now try to rename the file to the proper name.
1086 * Note: We may have to try multiple times, until we find a free
1092 snprintf (tmp, sizeof (tmp), "%d", hi);
1093 snprintf (path, sizeof (path), "%s/%s", ctx->path, tmp);
1094 if (safe_rename (msg->path, path) == 0) {
1096 m_strreplace(&hdr->path, tmp);
1097 p_delete(&msg->path);
1100 else if (errno != EEXIST) {
1101 mutt_perror (ctx->path);
1106 mh_sequences_add_one (ctx, hi, !msg->flags.read, msg->flags.flagged,
1107 msg->flags.replied);
1111 static int mh_commit_message (MESSAGE * msg, CONTEXT * ctx, HEADER * hdr) {
1112 return _mh_commit_message (msg, ctx, hdr, 1);
1115 /* Sync a message in an MH folder.
1117 * This code is also used for attachment deletion in maildir
1121 static int mh_rewrite_message (CONTEXT * ctx, int msgno)
1123 HEADER *h = ctx->hdrs[msgno];
1128 char oldpath[_POSIX_PATH_MAX];
1129 char newpath[_POSIX_PATH_MAX];
1130 char partpath[_POSIX_PATH_MAX];
1132 long old_body_offset = h->content->offset;
1133 long old_body_length = h->content->length;
1134 long old_hdr_lines = h->lines;
1136 if ((dest = mx_open_new_message (ctx, h, 0)) == NULL)
1139 if ((rc = mutt_copy_message (dest->fp, ctx, h,
1140 M_CM_UPDATE, CH_UPDATE | CH_UPDATE_LEN)) == 0)
1142 snprintf (oldpath, sizeof(oldpath), "%s/%s", ctx->path, h->path);
1143 m_strcpy(partpath, sizeof(partpath), h->path);
1145 if (ctx->magic == M_MAILDIR)
1146 rc = maildir_commit_message (dest, ctx, h);
1148 rc = _mh_commit_message (dest, ctx, h, 0);
1150 mx_close_message (&dest);
1158 * Try to move the new message to the old place.
1161 * This is important when we are just updating flags.
1163 * Note that there is a race condition against programs which
1164 * use the first free slot instead of the maximum message
1165 * number. Mutt does _not_ behave like this.
1167 * Anyway, if this fails, the message is in the folder, so
1168 * all what happens is that a concurrently runnung mutt will
1169 * lose flag modifications.
1172 if (ctx->magic == M_MH && rc == 0) {
1173 snprintf (newpath, _POSIX_PATH_MAX, "%s/%s", ctx->path, h->path);
1174 if ((rc = safe_rename (newpath, oldpath)) == 0)
1175 m_strreplace(&h->path, partpath);
1179 mx_close_message (&dest);
1181 if (rc == -1 && restore) {
1182 h->content->offset = old_body_offset;
1183 h->content->length = old_body_length;
1184 h->lines = old_hdr_lines;
1187 body_list_wipe(&h->content->parts);
1191 static int mh_sync_message (CONTEXT * ctx, int msgno)
1193 HEADER *h = ctx->hdrs[msgno];
1195 if (h->attach_del ||
1196 (h->env && (h->env->refs_changed || h->env->irt_changed)))
1197 if (mh_rewrite_message (ctx, msgno) != 0)
1203 static int maildir_sync_message (CONTEXT * ctx, int msgno)
1205 HEADER *h = ctx->hdrs[msgno];
1207 if (h->attach_del ||
1208 (h->env && (h->env->refs_changed || h->env->irt_changed))) {
1209 /* when doing attachment deletion/rethreading, fall back to the MH case. */
1210 if (mh_rewrite_message (ctx, msgno) != 0)
1214 /* we just have to rename the file. */
1216 char newpath[_POSIX_PATH_MAX];
1217 char partpath[_POSIX_PATH_MAX];
1218 char fullpath[_POSIX_PATH_MAX];
1219 char oldpath[_POSIX_PATH_MAX];
1223 if ((p = strrchr (h->path, '/')) == NULL) {
1227 m_strcpy(newpath, sizeof(newpath), p);
1229 /* kill the previous flags */
1230 if ((p = strchr (newpath, ':')) != NULL)
1233 maildir_flags (suffix, sizeof (suffix), h);
1235 snprintf (partpath, sizeof (partpath), "%s/%s%s",
1236 (h->read || h->old) ? "cur" : "new", newpath, suffix);
1237 snprintf (fullpath, sizeof (fullpath), "%s/%s", ctx->path, partpath);
1238 snprintf (oldpath, sizeof (oldpath), "%s/%s", ctx->path, h->path);
1240 if (m_strcmp(fullpath, oldpath) == 0) {
1241 /* message hasn't really changed */
1245 /* record that the message is possibly marked as trashed on disk */
1246 h->trash = h->deleted;
1248 if (rename (oldpath, fullpath) != 0) {
1249 mutt_perror ("rename");
1252 m_strreplace(&h->path, partpath);
1257 static int mh_sync_mailbox (CONTEXT * ctx, int unused __attribute__ ((unused)), int *index_hint)
1259 char path[_POSIX_PATH_MAX], tmp[_POSIX_PATH_MAX];
1264 #endif /* USE_HCACHE */
1266 if (ctx->magic == M_MH)
1267 i = mh_check_mailbox (ctx, index_hint, 0);
1269 i = maildir_check_mailbox (ctx, index_hint, 0);
1275 if (ctx->magic == M_MAILDIR)
1276 hc = mutt_hcache_open (HeaderCache, ctx->path);
1277 #endif /* USE_HCACHE */
1279 for (i = 0; i < ctx->msgcount; i++) {
1280 if (ctx->hdrs[i]->deleted
1281 && (ctx->magic != M_MAILDIR || !option (OPTMAILDIRTRASH))) {
1282 snprintf (path, sizeof (path), "%s/%s", ctx->path, ctx->hdrs[i]->path);
1283 if (ctx->magic == M_MAILDIR
1284 || (option (OPTMHPURGE) && ctx->magic == M_MH)) {
1286 if (ctx->magic == M_MAILDIR)
1287 mutt_hcache_delete (hc, ctx->hdrs[i]->path + 3,
1288 &maildir_hcache_keylen);
1289 #endif /* USE_HCACHE */
1292 else if (ctx->magic == M_MH) {
1293 /* MH just moves files out of the way when you delete them */
1294 if (*ctx->hdrs[i]->path != ',') {
1295 snprintf (tmp, sizeof (tmp), "%s/,%s", ctx->path,
1296 ctx->hdrs[i]->path);
1303 else if (ctx->hdrs[i]->changed || ctx->hdrs[i]->attach_del ||
1304 (ctx->magic == M_MAILDIR
1305 && (option (OPTMAILDIRTRASH) || ctx->hdrs[i]->trash)
1306 && (ctx->hdrs[i]->deleted != ctx->hdrs[i]->trash))) {
1307 if (ctx->magic == M_MAILDIR) {
1308 if (maildir_sync_message (ctx, i) == -1)
1312 if (mh_sync_message (ctx, i) == -1)
1319 if (ctx->magic == M_MAILDIR)
1320 mutt_hcache_close (hc);
1321 #endif /* USE_HCACHE */
1323 if (ctx->magic == M_MH)
1324 mh_update_sequences (ctx);
1326 /* XXX race condition? */
1328 maildir_update_mtime (ctx);
1330 /* adjust indices */
1333 for (i = 0, j = 0; i < ctx->msgcount; i++) {
1334 if (!ctx->hdrs[i]->deleted
1335 || (ctx->magic == M_MAILDIR && option (OPTMAILDIRTRASH)))
1336 ctx->hdrs[i]->index = j++;
1344 if (ctx->magic == M_MAILDIR)
1345 mutt_hcache_close (hc);
1346 #endif /* USE_HCACHE */
1350 static char *maildir_canon_filename (char *dest, const char *src, ssize_t l)
1354 if ((t = strrchr (src, '/')))
1357 m_strcpy(dest, l, src);
1358 if ((u = strrchr (dest, ':')))
1364 static void maildir_update_tables (CONTEXT * ctx, int *index_hint)
1370 if (Sort != SORT_ORDER) {
1373 mutt_sort_headers (ctx, 1);
1377 old_count = ctx->msgcount;
1378 for (i = 0, j = 0; i < old_count; i++) {
1379 if (ctx->hdrs[i]->active && index_hint && *index_hint == i)
1382 if (ctx->hdrs[i]->active)
1383 ctx->hdrs[i]->index = j++;
1386 mx_update_tables (ctx, 0);
1387 mutt_clear_threads (ctx);
1390 static void maildir_update_flags (CONTEXT * ctx, HEADER * o, HEADER * n)
1392 /* save the global state here so we can reset it at the
1393 * end of list block if required.
1395 int context_changed = ctx->changed;
1397 /* user didn't modify this message. alter the flags to
1398 * match the current state on disk. This may not actually
1399 * do anything, but we can't tell right now. mutt_set_flag()
1400 * will just ignore the call if the status bits are
1401 * already properly set.
1403 mutt_set_flag (ctx, o, M_FLAG, n->flagged);
1404 mutt_set_flag (ctx, o, M_REPLIED, n->replied);
1405 mutt_set_flag (ctx, o, M_READ, n->read);
1406 mutt_set_flag (ctx, o, M_OLD, n->old);
1408 /* mutt_set_flag() will set this, but we don't need to
1409 * sync the changes we made because we just updated the
1410 * context to match the current on-disk state of the
1415 /* if the mailbox was not modified before we made these
1416 * changes, unset the changed flag since nothing needs to
1419 if (!context_changed)
1424 /* This function handles arrival of new mail and reopening of
1425 * maildir folders. The basic idea here is we check to see if either
1426 * the new or cur subdirectories have changed, and if so, we scan them
1427 * for the list of files. We check for newly added messages, and
1428 * then merge the flags messages we already knew about. We don't treat
1429 * either subdirectory differently, as mail could be copied directly into
1430 * the cur directory from another agent.
1432 static int maildir_check_mailbox (CONTEXT * ctx, int *index_hint, int unused __attribute__ ((unused)))
1434 struct stat st_new; /* status of the "new" subdirectory */
1435 struct stat st_cur; /* status of the "cur" subdirectory */
1436 char buf[_POSIX_PATH_MAX];
1437 int changed = 0; /* bitmask representing which subdirectories
1438 have changed. 0x1 = new, 0x2 = cur */
1439 int occult = 0; /* messages were removed from the mailbox */
1440 int have_new = 0; /* messages were added to the mailbox */
1441 struct maildir *md; /* list of messages in the mailbox */
1442 struct maildir **last, *p;
1444 HASH *fnames; /* hash table for quickly looking up the base filename
1445 for a maildir message */
1447 if (!option (OPTCHECKNEW))
1450 snprintf (buf, sizeof (buf), "%s/new", ctx->path);
1451 if (stat (buf, &st_new) == -1)
1454 snprintf (buf, sizeof (buf), "%s/cur", ctx->path);
1455 if (stat (buf, &st_cur) == -1)
1458 /* determine which subdirectories need to be scanned */
1459 if (st_new.st_mtime > ctx->mtime)
1461 if (st_cur.st_mtime > ctx->mtime_cur)
1465 return 0; /* nothing to do */
1467 /* update the modification times on the mailbox */
1468 ctx->mtime_cur = st_cur.st_mtime;
1469 ctx->mtime = st_new.st_mtime;
1471 /* do a fast scan of just the filenames in
1472 * the subdirectories that have changed.
1477 maildir_parse_dir (ctx, &last, "new", NULL);
1479 maildir_parse_dir (ctx, &last, "cur", NULL);
1481 /* we create a hash table keyed off the canonical (sans flags) filename
1482 * of each message we scanned. This is used in the loop over the
1483 * existing messages below to do some correlation.
1485 fnames = hash_create (1031);
1487 for (p = md; p; p = p->next) {
1488 maildir_canon_filename (buf, p->h->path, sizeof (buf));
1489 p->canon_fname = m_strdup(buf);
1490 hash_insert (fnames, p->canon_fname, p, 0);
1493 /* check for modifications and adjust flags */
1494 for (i = 0; i < ctx->msgcount; i++) {
1495 ctx->hdrs[i]->active = 0;
1496 maildir_canon_filename (buf, ctx->hdrs[i]->path, sizeof (buf));
1497 p = hash_find (fnames, buf);
1499 /* message already exists, merge flags */
1500 ctx->hdrs[i]->active = 1;
1502 /* check to see if the message has moved to a different
1503 * subdirectory. If so, update the associated filename.
1505 if (m_strcmp(ctx->hdrs[i]->path, p->h->path))
1506 m_strreplace(&ctx->hdrs[i]->path, p->h->path);
1508 /* if the user hasn't modified the flags on this message, update
1509 * the flags we just detected.
1511 if (!ctx->hdrs[i]->changed)
1512 maildir_update_flags (ctx, ctx->hdrs[i], p->h);
1514 if (ctx->hdrs[i]->deleted == ctx->hdrs[i]->trash)
1515 ctx->hdrs[i]->deleted = p->h->deleted;
1516 ctx->hdrs[i]->trash = p->h->trash;
1518 /* this is a duplicate of an existing header, so remove it */
1519 header_delete(&p->h);
1521 /* This message was not in the list of messages we just scanned.
1522 * Check to see if we have enough information to know if the
1523 * message has disappeared out from underneath us.
1525 else if (((changed & 1) && (!strncmp (ctx->hdrs[i]->path, "new/", 4))) ||
1526 ((changed & 2) && (!strncmp (ctx->hdrs[i]->path, "cur/", 4)))) {
1527 /* This message disappeared, so we need to simulate a "reopen"
1528 * event. We know it disappeared because we just scanned the
1529 * subdirectory it used to reside in.
1534 /* This message resides in a subdirectory which was not
1535 * modified, so we assume that it is still present and
1538 ctx->hdrs[i]->active = 1;
1542 /* destroy the file name hash */
1543 hash_destroy (&fnames, NULL);
1545 /* If we didn't just get new mail, update the tables. */
1547 maildir_update_tables (ctx, index_hint);
1549 /* do any delayed parsing we need to do. */
1550 maildir_delayed_parsing (ctx, md);
1552 /* Incorporate new messages */
1553 have_new = maildir_move_to_context (ctx, &md);
1555 return occult ? M_REOPENED : (have_new ? M_NEW_MAIL : 0);
1559 * This function handles arrival of new mail and reopening of
1560 * mh/maildir folders. Things are getting rather complex because we
1561 * don't have a well-defined "mailbox order", so the tricks from
1562 * mbox.c and mx.c won't work here.
1564 * Don't change this code unless you _really_ understand what
1569 static int mh_check_mailbox (CONTEXT * ctx, int *index_hint, int unused __attribute__ ((unused)))
1571 char buf[_POSIX_PATH_MAX];
1572 struct stat st, st_cur;
1573 short modified = 0, have_new = 0, occult = 0;
1574 struct maildir *md, *p;
1575 struct maildir **last = NULL;
1576 struct mh_sequences mhs;
1580 if (!option (OPTCHECKNEW))
1583 m_strcpy(buf, sizeof(buf), ctx->path);
1584 if (stat (buf, &st) == -1)
1587 /* create .mh_sequences when there isn't one. */
1588 snprintf (buf, sizeof (buf), "%s/.mh_sequences", ctx->path);
1589 if ((i = stat (buf, &st_cur) == -1) && errno == ENOENT) {
1593 if (mh_mkstemp (ctx, &fp, &tmp) == 0) {
1595 if (safe_rename (tmp, buf) == -1)
1601 if (i == -1 && stat (buf, &st_cur) == -1)
1604 if (st.st_mtime > ctx->mtime || st_cur.st_mtime > ctx->mtime_cur)
1610 ctx->mtime_cur = st_cur.st_mtime;
1611 ctx->mtime = st.st_mtime;
1617 maildir_parse_dir (ctx, &last, NULL, NULL);
1618 mh_read_sequences (&mhs, ctx->path);
1619 mh_update_maildir (md, &mhs);
1620 mhs_free_sequences (&mhs);
1622 /* check for modifications and adjust flags */
1623 fnames = hash_create (1031);
1625 for (p = md; p; p = p->next)
1626 hash_insert (fnames, p->h->path, p, 0);
1628 for (i = 0; i < ctx->msgcount; i++) {
1629 ctx->hdrs[i]->active = 0;
1631 if ((p = hash_find (fnames, ctx->hdrs[i]->path)) && p->h &&
1632 (mutt_cmp_header (ctx->hdrs[i], p->h))) {
1633 ctx->hdrs[i]->active = 1;
1634 /* found the right message */
1635 if (!ctx->hdrs[i]->changed)
1636 maildir_update_flags (ctx, ctx->hdrs[i], p->h);
1638 header_delete(&p->h);
1640 else /* message has disappeared */
1644 /* destroy the file name hash */
1646 hash_destroy (&fnames, NULL);
1648 /* If we didn't just get new mail, update the tables. */
1650 maildir_update_tables (ctx, index_hint);
1652 /* Incorporate new messages */
1653 have_new = maildir_move_to_context (ctx, &md);
1655 return occult ? M_REOPENED : (have_new ? M_NEW_MAIL : 0);
1662 * These functions try to find a message in a maildir folder when it
1663 * has moved under our feet. Note that this code is rather expensive, but
1664 * then again, it's called rarely.
1667 static FILE *_maildir_open_find_message (const char *folder, const char *unique,
1668 const char *subfolder)
1670 char dir[_POSIX_PATH_MAX];
1671 char tunique[_POSIX_PATH_MAX];
1672 char fname[_POSIX_PATH_MAX];
1680 snprintf (dir, sizeof (dir), "%s/%s", folder, subfolder);
1682 if ((dp = opendir (dir)) == NULL) {
1687 while ((de = readdir (dp))) {
1688 maildir_canon_filename (tunique, de->d_name, sizeof (tunique));
1690 if (!m_strcmp(tunique, unique)) {
1691 snprintf (fname, sizeof (fname), "%s/%s/%s", folder, subfolder,
1693 fp = fopen (fname, "r"); /* __FOPEN_CHECKED__ */
1705 FILE *maildir_open_find_message (const char *folder, const char *msg)
1707 char unique[_POSIX_PATH_MAX];
1710 static unsigned int new_hits = 0, cur_hits = 0; /* simple dynamic optimization */
1712 maildir_canon_filename (unique, msg, sizeof (unique));
1715 _maildir_open_find_message (folder, unique,
1716 new_hits > cur_hits ? "new" : "cur"))
1717 || errno != ENOENT) {
1718 if (new_hits < UINT_MAX && cur_hits < UINT_MAX) {
1719 new_hits += (new_hits > cur_hits ? 1 : 0);
1720 cur_hits += (new_hits > cur_hits ? 0 : 1);
1726 _maildir_open_find_message (folder, unique,
1727 new_hits > cur_hits ? "cur" : "new"))
1728 || errno != ENOENT) {
1729 if (new_hits < UINT_MAX && cur_hits < UINT_MAX) {
1730 new_hits += (new_hits > cur_hits ? 0 : 1);
1731 cur_hits += (new_hits > cur_hits ? 1 : 0);
1743 * 1 if there are no messages in the mailbox
1744 * 0 if there are messages in the mailbox
1747 static int maildir_check_empty (const char *path)
1751 int r = 1; /* assume empty until we find a message */
1752 char frealpath[_POSIX_PATH_MAX];
1755 /* Strategy here is to look for any file not beginning with a period */
1758 /* we do "cur" on the first iteration since its more likely that we'll
1759 * find old messages without having to scan both subdirs
1761 snprintf (frealpath, sizeof (frealpath), "%s/%s", path,
1762 iter == 0 ? "cur" : "new");
1763 if ((dp = opendir (frealpath)) == NULL)
1765 while ((de = readdir (dp))) {
1766 if (*de->d_name != '.') {
1773 } while (r && iter < 2);
1780 * 1 if there are no messages in the mailbox
1781 * 0 if there are messages in the mailbox
1784 static int mh_check_empty (const char *path)
1788 int r = 1; /* assume empty until we find a message */
1790 if ((dp = opendir (path)) == NULL)
1792 while ((de = readdir (dp))) {
1793 if (mh_valid_message (de->d_name)) {
1803 static int mh_is_magic (const char* path, struct stat* st) {
1804 char tmp[_POSIX_PATH_MAX];
1806 if (S_ISDIR (st->st_mode)) {
1807 snprintf (tmp, sizeof (tmp), "%s/.mh_sequences", path);
1808 if (access (tmp, F_OK) == 0)
1811 snprintf (tmp, sizeof (tmp), "%s/.xmhcache", path);
1812 if (access (tmp, F_OK) == 0)
1815 snprintf (tmp, sizeof (tmp), "%s/.mew_cache", path);
1816 if (access (tmp, F_OK) == 0)
1819 snprintf (tmp, sizeof (tmp), "%s/.mew-cache", path);
1820 if (access (tmp, F_OK) == 0)
1823 snprintf (tmp, sizeof (tmp), "%s/.sylpheed_cache", path);
1824 if (access (tmp, F_OK) == 0)
1828 * ok, this isn't an mh folder, but mh mode can be used to read
1829 * Usenet news from the spool. ;-)
1832 snprintf (tmp, sizeof (tmp), "%s/.overview", path);
1833 if (access (tmp, F_OK) == 0)
1839 static int maildir_is_magic (const char* path, struct stat* st) {
1841 char tmp[_POSIX_PATH_MAX];
1843 if (S_ISDIR (st->st_mode)) {
1844 snprintf (tmp, sizeof (tmp), "%s/cur", path);
1845 if (stat (tmp, &sb) == 0 && S_ISDIR (sb.st_mode))
1851 static int mh_commit (MESSAGE* msg, CONTEXT* ctx) {
1852 return (mh_commit_message (msg, ctx, NULL));
1855 static int maildir_commit (MESSAGE* msg, CONTEXT* ctx) {
1856 return (maildir_commit_message (msg, ctx, NULL));
1859 mx_t const maildir_mx = {
1863 maildir_check_empty,
1866 maildir_open_new_message,
1868 maildir_check_mailbox,
1874 mx_t const mh_mx = {
1881 mh_open_new_message,