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)
89 static void mh_read_token (char *t, int *first, int *last)
93 if ((p = strchr (t, '-'))) {
99 *first = *last = atoi (t);
102 static void mh_read_sequences (struct mh_sequences *mhs, const char *path)
113 char pathname[_POSIX_PATH_MAX];
115 snprintf (pathname, sizeof (pathname), "%s/.mh_sequences", path);
117 if (!(fp = fopen (pathname, "r")))
120 while ((buff = mutt_read_line (buff, &sz, fp, &line))) {
121 if (!(t = strtok (buff, " \t:")))
124 if (!m_strcmp(t, MhUnseen))
126 else if (!m_strcmp(t, MhFlagged))
128 else if (!m_strcmp(t, MhReplied))
130 else /* unknown sequence */
133 while ((t = strtok (NULL, " \t:"))) {
134 mh_read_token (t, &first, &last);
135 for (; first <= last; first++)
136 mhs_set (mhs, first, f);
144 int mh_buffy (const char *path)
147 struct mh_sequences mhs;
151 mh_read_sequences (&mhs, path);
152 for (i = 0; !r && i <= mhs.max; i++)
153 if (mhs_check (&mhs, i) & MH_SEQ_UNSEEN)
155 mhs_free_sequences (&mhs);
159 static int mh_mkstemp (CONTEXT * dest, FILE ** fp, char **tgt)
161 static int Counter = 0;
163 char path[_POSIX_PATH_MAX];
166 snprintf (path, _POSIX_PATH_MAX, "%s/.mutt-%s-%d-%d",
167 dest->path, NONULL (Hostname), (int) getpid (), Counter++);
169 if ((fd = open (path, O_WRONLY | O_EXCL | O_CREAT, 0666)) == -1) {
170 if (errno != EEXIST) {
176 *tgt = m_strdup(path);
181 if ((*fp = fdopen (fd, "w")) == NULL) {
191 static void mhs_write_one_sequence (FILE * fp, struct mh_sequences *mhs,
192 short f, const char *tag)
197 fprintf (fp, "%s:", tag);
202 for (i = 0; i <= mhs->max; i++) {
203 if ((mhs_check (mhs, i) & f)) {
209 else if (first >= 0) {
211 fprintf (fp, " %d", first);
213 fprintf (fp, " %d-%d", first, last);
222 fprintf (fp, " %d", first);
224 fprintf (fp, " %d-%d", first, last);
230 /* XXX - we don't currently remove deleted messages from sequences we don't know. Should we? */
232 static void mh_update_sequences (CONTEXT * ctx)
236 char sequences[_POSIX_PATH_MAX];
248 char seq_unseen[STRING];
249 char seq_replied[STRING];
250 char seq_flagged[STRING];
253 struct mh_sequences mhs;
257 snprintf (seq_unseen, sizeof (seq_unseen), "%s:", NONULL (MhUnseen));
258 snprintf (seq_replied, sizeof (seq_replied), "%s:", NONULL (MhReplied));
259 snprintf (seq_flagged, sizeof (seq_flagged), "%s:", NONULL (MhFlagged));
261 if (mh_mkstemp (ctx, &nfp, &tmpfname) != 0) {
266 snprintf (sequences, sizeof (sequences), "%s/.mh_sequences", ctx->path);
269 /* first, copy unknown sequences */
270 if ((ofp = fopen (sequences, "r"))) {
271 while ((buff = mutt_read_line (buff, &s, ofp, &l))) {
272 if (!m_strncmp(buff, seq_unseen, m_strlen(seq_unseen)))
274 if (!m_strncmp(buff, seq_flagged, m_strlen(seq_flagged)))
276 if (!m_strncmp(buff, seq_replied, m_strlen(seq_replied)))
279 fprintf (nfp, "%s\n", buff);
284 /* now, update our unseen, flagged, and replied sequences */
285 for (l = 0; l < ctx->msgcount; l++) {
286 if (ctx->hdrs[l]->deleted)
289 if ((p = strrchr (ctx->hdrs[l]->path, '/')))
292 p = ctx->hdrs[l]->path;
296 if (!ctx->hdrs[l]->read) {
297 mhs_set (&mhs, i, MH_SEQ_UNSEEN);
300 if (ctx->hdrs[l]->flagged) {
301 mhs_set (&mhs, i, MH_SEQ_FLAGGED);
304 if (ctx->hdrs[l]->replied) {
305 mhs_set (&mhs, i, MH_SEQ_REPLIED);
310 /* write out the new sequences */
312 mhs_write_one_sequence (nfp, &mhs, MH_SEQ_UNSEEN, NONULL (MhUnseen));
314 mhs_write_one_sequence (nfp, &mhs, MH_SEQ_FLAGGED, NONULL (MhFlagged));
316 mhs_write_one_sequence (nfp, &mhs, MH_SEQ_REPLIED, NONULL (MhReplied));
318 mhs_free_sequences (&mhs);
321 /* try to commit the changes - no guarantee here */
325 if (safe_rename (tmpfname, sequences) != 0) {
326 /* report an error? */
333 static void mh_sequences_add_one (CONTEXT * ctx, int n, short unseen,
334 short flagged, short replied)
336 short unseen_done = 0;
337 short flagged_done = 0;
338 short replied_done = 0;
340 FILE *ofp = NULL, *nfp = NULL;
343 char sequences[_POSIX_PATH_MAX];
345 char seq_unseen[STRING];
346 char seq_replied[STRING];
347 char seq_flagged[STRING];
353 if (mh_mkstemp (ctx, &nfp, &tmpfname) == -1)
356 snprintf (seq_unseen, sizeof (seq_unseen), "%s:", NONULL (MhUnseen));
357 snprintf (seq_replied, sizeof (seq_replied), "%s:", NONULL (MhReplied));
358 snprintf (seq_flagged, sizeof (seq_flagged), "%s:", NONULL (MhFlagged));
360 snprintf (sequences, sizeof (sequences), "%s/.mh_sequences", ctx->path);
361 if ((ofp = fopen (sequences, "r"))) {
362 while ((buff = mutt_read_line (buff, &sz, ofp, &line))) {
363 if (unseen && !m_strncmp (buff, seq_unseen, m_strlen(seq_unseen))) {
364 fprintf (nfp, "%s %d\n", buff, n);
368 && !m_strncmp (buff, seq_flagged, m_strlen(seq_flagged))) {
369 fprintf (nfp, "%s %d\n", buff, n);
373 && !m_strncmp (buff, seq_replied, m_strlen(seq_replied))) {
374 fprintf (nfp, "%s %d\n", buff, n);
378 fprintf (nfp, "%s\n", buff);
384 if (!unseen_done && unseen)
385 fprintf (nfp, "%s: %d\n", NONULL (MhUnseen), n);
386 if (!flagged_done && flagged)
387 fprintf (nfp, "%s: %d\n", NONULL (MhFlagged), n);
388 if (!replied_done && replied)
389 fprintf (nfp, "%s: %d\n", NONULL (MhReplied), n);
394 if (safe_rename (tmpfname, sequences) != 0)
400 static void mh_update_maildir (struct maildir *md, struct mh_sequences *mhs)
406 for (; md; md = md->next) {
407 if ((p = strrchr (md->h->path, '/')))
413 f = mhs_check (mhs, i);
415 md->h->read = (f & MH_SEQ_UNSEEN) ? 0 : 1;
416 md->h->flagged = (f & MH_SEQ_FLAGGED) ? 1 : 0;
417 md->h->replied = (f & MH_SEQ_REPLIED) ? 1 : 0;
421 /* maildir support */
423 static void maildir_free_entry (struct maildir **md)
428 p_delete(&(*md)->canon_fname);
430 header_delete(&(*md)->h);
435 static void maildir_free_maildir (struct maildir **md)
437 struct maildir *p, *q;
442 for (p = *md; p; p = q) {
444 maildir_free_entry (&p);
448 static void maildir_parse_flags (HEADER * h, const char *path)
456 if ((p = strrchr (path, ':')) != NULL && m_strncmp(p + 1, "2,", 2) == 0) {
459 m_strreplace(&h->maildir_flags, p);
460 q = h->maildir_flags;
474 case 'R': /* replied */
479 case 'T': /* trashed */
492 if (q == h->maildir_flags)
493 p_delete(&h->maildir_flags);
498 static void maildir_update_mtime (CONTEXT * ctx)
500 char buf[_POSIX_PATH_MAX];
503 if (ctx->magic == M_MAILDIR) {
504 snprintf (buf, sizeof (buf), "%s/%s", ctx->path, "cur");
505 if (stat (buf, &st) == 0)
506 ctx->mtime_cur = st.st_mtime;
507 snprintf (buf, sizeof (buf), "%s/%s", ctx->path, "new");
510 snprintf (buf, sizeof (buf), "%s/.mh_sequences", ctx->path);
511 if (stat (buf, &st) == 0)
512 ctx->mtime_cur = st.st_mtime;
514 m_strcpy(buf, sizeof(buf), ctx->path);
517 if (stat (buf, &st) == 0)
518 ctx->mtime = st.st_mtime;
522 * Actually parse a maildir message. This may also be used to fill
523 * out a fake header structure generated by lazy maildir parsing.
525 static HEADER *maildir_parse_message (int magic, const char *fname,
526 int is_old, HEADER * _h)
532 if ((f = fopen (fname, "r")) != NULL) {
535 h->env = mutt_read_rfc822_header (f, h, 0, 0);
537 fstat (fileno (f), &st);
541 h->received = h->date_sent;
543 if (h->content->length <= 0)
544 h->content->length = st.st_size - h->content->offset;
548 if (magic == M_MAILDIR) {
550 * maildir stores its flags in the filename, so ignore the
551 * flags in the header of the message
555 maildir_parse_flags (h, fname);
563 * Note that this routine will _not_ modify the context given by
566 * It's used in the first parsing pass on maildir and MH folders.
567 * In the MH case, this means full parsing of the folder. In the
568 * maildir case, it means that we only look at flags, and create a
569 * fake HEADER structure, which may later be filled in by
570 * maildir_parse_message(), when called from
571 * maildir_delayed_parsing().
575 static int maildir_parse_entry (CONTEXT * ctx, struct maildir ***last,
576 const char *subdir, const char *fname,
577 int *count, int is_old, ino_t inode __attribute__ ((unused)))
579 struct maildir *entry;
581 char buf[_POSIX_PATH_MAX];
584 snprintf (buf, sizeof (buf), "%s/%s/%s", ctx->path, subdir, fname);
586 snprintf (buf, sizeof (buf), "%s/%s", ctx->path, fname);
588 if (ctx->magic == M_MH)
589 h = maildir_parse_message (ctx->magic, buf, is_old, NULL);
593 maildir_parse_flags (h, buf);
599 if (!ctx->quiet && ReadInc && ((*count % ReadInc) == 0 || *count == 1))
600 mutt_message (_("Reading %s... %d"), ctx->path, *count);
604 snprintf (buf, sizeof (buf), "%s/%s", subdir, fname);
605 h->path = m_strdup(buf);
608 h->path = m_strdup(fname);
610 entry = p_new(struct maildir, 1);
612 entry->header_parsed = (ctx->magic == M_MH);
614 *last = &entry->next;
624 /* Ignore the garbage files. A valid MH message consists of only
625 * digits. Deleted message get moved to a filename with a comma before
629 int mh_valid_message (const char *s)
632 if (!isdigit ((unsigned char) *s))
638 static int maildir_parse_dir (CONTEXT * ctx, struct maildir ***last,
639 const char *subdir, int *count)
643 char buf[_POSIX_PATH_MAX];
647 snprintf (buf, sizeof (buf), "%s/%s", ctx->path, subdir);
648 is_old = (m_strcmp("cur", subdir) == 0);
651 m_strcpy(buf, sizeof(buf), ctx->path);
653 if ((dirp = opendir (buf)) == NULL)
656 while ((de = readdir (dirp)) != NULL) {
658 if ((ctx->magic == M_MH && !mh_valid_message (de->d_name))
659 || (ctx->magic == M_MAILDIR && *de->d_name == '.'))
662 /* FOO - really ignore the return value? */
664 maildir_parse_entry (ctx, last, subdir, de->d_name, count, is_old,
665 #if HAVE_DIRENT_D_INO
677 static int maildir_add_to_context (CONTEXT * ctx, struct maildir *md)
679 int oldmsgcount = ctx->msgcount;
684 if (ctx->msgcount == ctx->hdrmax)
685 mx_alloc_memory (ctx);
687 ctx->hdrs[ctx->msgcount] = md->h;
688 ctx->hdrs[ctx->msgcount]->index = ctx->msgcount;
690 md->h->content->length + md->h->content->offset -
691 md->h->content->hdr_offset;
699 if (ctx->msgcount > oldmsgcount) {
700 mx_update_context (ctx, ctx->msgcount - oldmsgcount);
706 static int maildir_move_to_context (CONTEXT * ctx, struct maildir **md)
710 r = maildir_add_to_context (ctx, *md);
711 maildir_free_maildir (md);
716 static ssize_t maildir_hcache_keylen (const char *fn)
718 return m_strchrnul(fn, ':') - fn;
723 * This function does the second parsing pass for a maildir-style
726 static void maildir_delayed_parsing (CONTEXT * ctx, struct maildir *md)
729 char fn[_POSIX_PATH_MAX];
735 struct timeval *when = NULL;
736 struct stat lastchanged;
739 hc = mutt_hcache_open (HeaderCache, ctx->path);
742 for (p = md, count = 0; p; p = p->next, count++) {
743 if (!(p && p->h && !p->header_parsed))
747 data = mutt_hcache_fetch (hc, p->h->path + 3, &maildir_hcache_keylen);
748 when = (struct timeval *) data;
751 if (!ctx->quiet && ReadInc && ((count % ReadInc) == 0 || count == 1))
752 mutt_message (_("Reading %s... %d"), ctx->path, count);
753 snprintf (fn, sizeof (fn), "%s/%s", ctx->path, p->h->path);
756 if (option (OPTHCACHEVERIFY)) {
757 ret = stat (fn, &lastchanged);
760 lastchanged.st_mtime = 0;
764 if (data != NULL && !ret && lastchanged.st_mtime <= when->tv_sec) {
765 p->h = mutt_hcache_restore ((unsigned char *) data, &p->h);
766 maildir_parse_flags (p->h, fn);
770 if (maildir_parse_message (ctx->magic, fn, p->h->old, p->h)) {
771 p->header_parsed = 1;
772 maildir_parse_flags (p->h, fn);
774 mutt_hcache_store (hc, p->h->path + 3, p->h, 0, &maildir_hcache_keylen);
778 header_delete(&p->h);
784 mutt_hcache_close (hc);
788 /* Read a MH/maildir style mailbox.
791 * ctx [IN/OUT] context for this mailbox
792 * subdir [IN] NULL for MH mailboxes, otherwise the subdir of the
793 * maildir mailbox to read from
795 static int _mh_read_dir (CONTEXT * ctx, const char *subdir)
798 struct mh_sequences mhs;
799 struct maildir **last;
805 maildir_update_mtime (ctx);
810 if (maildir_parse_dir (ctx, &last, subdir, &count) == -1)
813 if (ctx->magic == M_MH) {
814 mh_read_sequences (&mhs, ctx->path);
815 mh_update_maildir (md, &mhs);
816 mhs_free_sequences (&mhs);
819 if (ctx->magic == M_MAILDIR)
820 maildir_delayed_parsing (ctx, md);
822 maildir_move_to_context (ctx, &md);
826 static int mh_read_dir (CONTEXT* ctx) {
827 return (_mh_read_dir (ctx, NULL));
830 /* read a maildir style mailbox */
831 static int maildir_read_dir (CONTEXT * ctx)
833 /* maildir looks sort of like MH, except that there are two subdirectories
834 * of the main folder path from which to read messages
836 if (_mh_read_dir (ctx, "new") == -1 || _mh_read_dir (ctx, "cur") == -1)
843 * Open a new (temporary) message in an MH folder.
846 static int mh_open_new_message (MESSAGE * msg, CONTEXT * dest, HEADER * hdr __attribute__ ((unused)))
848 return mh_mkstemp (dest, &msg->fp, &msg->path);
851 static int ch_compar (const void *a, const void *b)
853 return (int) (*((const char *) a) - *((const char *) b));
856 static void maildir_flags (char *dest, ssize_t destlen, HEADER * hdr)
861 * The maildir specification requires that all files in the cur
862 * subdirectory have the :unique string appeneded, regardless of whether
863 * or not there are any flags. If .old is set, we know that this message
864 * will end up in the cur directory, so we include it in the following
865 * test even though there is no associated flag.
869 && (hdr->flagged || hdr->replied || hdr->read || hdr->deleted
870 || hdr->old || hdr->maildir_flags)) {
871 char tmp[LONG_STRING];
873 snprintf (tmp, sizeof (tmp),
875 hdr->flagged ? "F" : "",
876 hdr->replied ? "R" : "",
877 hdr->read ? "S" : "", hdr->deleted ? "T" : "",
878 NONULL (hdr->maildir_flags));
879 if (hdr->maildir_flags)
880 qsort (tmp, m_strlen(tmp), 1, ch_compar);
881 snprintf (dest, destlen, ":2,%s", tmp);
887 * Open a new (temporary) message in a maildir folder.
889 * Note that this uses _almost_ the maildir file name format, but
890 * with a {cur,new} prefix.
894 static int maildir_open_new_message (MESSAGE * msg, CONTEXT * dest, HEADER * hdr)
896 static int Counter = 0;
898 char path[_POSIX_PATH_MAX];
903 short deleted = hdr->deleted;
907 maildir_flags (suffix, sizeof (suffix), hdr);
909 hdr->deleted = deleted;
914 if (hdr && (hdr->read || hdr->old))
915 m_strcpy(subdir, sizeof(subdir), "cur");
917 m_strcpy(subdir, sizeof(subdir), "new");
920 snprintf (path, _POSIX_PATH_MAX, "%s/tmp/%s.%ld.%u_%d.%s%s",
921 dest->path, subdir, (long) time (NULL),
922 (unsigned int) getpid (), Counter++, NONULL (Hostname), suffix);
925 if ((fd = open (path, O_WRONLY | O_EXCL | O_CREAT, 0666)) == -1) {
926 if (errno != EEXIST) {
931 msg->path = m_strdup(path);
936 if ((msg->fp = fdopen (fd, "w")) == NULL) {
937 p_delete(&msg->path);
949 * Commit a message to a maildir folder.
951 * msg->path contains the file name of a file in tmp/. We take the
952 * flags from this file's name.
954 * ctx is the mail folder we commit to.
956 * hdr is a header structure to which we write the message's new
957 * file name. This is used in the mh and maildir folder synch
958 * routines. When this routine is invoked from mx_commit_message,
961 * msg->path looks like this:
963 * tmp/{cur,new}.mutt-HOSTNAME-PID-COUNTER:flags
965 * See also maildir_open_new_message().
969 static int maildir_commit_message (MESSAGE * msg, CONTEXT * ctx, HEADER * hdr)
971 static int Counter = 0;
974 char path[_POSIX_PATH_MAX];
975 char full[_POSIX_PATH_MAX];
978 if (m_fclose(&msg->fp) != 0)
981 /* extract the subdir */
982 s = strrchr (msg->path, '/') + 1;
983 m_strcpy(subdir, sizeof(subdir), s);
985 /* extract the flags */
986 if ((s = strchr (s, ':')))
987 m_strcpy(suffix, sizeof(suffix), s);
991 /* construct a new file name. */
993 snprintf (path, _POSIX_PATH_MAX, "%s/%ld.%u_%d.%s%s", subdir,
994 (long) time (NULL), (unsigned int) getpid (), Counter++,
995 NONULL (Hostname), suffix);
996 snprintf (full, _POSIX_PATH_MAX, "%s/%s", ctx->path, path);
998 if (safe_rename (msg->path, full) == 0) {
1000 m_strreplace(&hdr->path, path);
1001 p_delete(&msg->path);
1004 * Adjust the mtime on the file to match the time at which this
1005 * message was received. Currently this is only set when copying
1006 * messages between mailboxes, so we test to ensure that it is
1009 if (msg->received) {
1012 ut.actime = msg->received;
1013 ut.modtime = msg->received;
1014 if (utime (full, &ut)) {
1016 ("maildir_commit_message(): unable to set time on file"));
1023 else if (errno != EEXIST) {
1024 mutt_perror (ctx->path);
1031 * commit a message to an MH folder.
1036 static int _mh_commit_message (MESSAGE * msg, CONTEXT * ctx, HEADER * hdr,
1042 unsigned int n, hi = 0;
1043 char path[_POSIX_PATH_MAX];
1046 if (m_fclose(&msg->fp) != 0)
1049 if ((dirp = opendir (ctx->path)) == NULL) {
1050 mutt_perror (ctx->path);
1054 /* figure out what the next message number is */
1055 while ((de = readdir (dirp)) != NULL) {
1061 if (!isdigit ((unsigned char) *cp))
1074 * Now try to rename the file to the proper name.
1076 * Note: We may have to try multiple times, until we find a free
1082 snprintf (tmp, sizeof (tmp), "%d", hi);
1083 snprintf (path, sizeof (path), "%s/%s", ctx->path, tmp);
1084 if (safe_rename (msg->path, path) == 0) {
1086 m_strreplace(&hdr->path, tmp);
1087 p_delete(&msg->path);
1090 else if (errno != EEXIST) {
1091 mutt_perror (ctx->path);
1096 mh_sequences_add_one (ctx, hi, !msg->flags.read, msg->flags.flagged,
1097 msg->flags.replied);
1101 static int mh_commit_message (MESSAGE * msg, CONTEXT * ctx, HEADER * hdr) {
1102 return _mh_commit_message (msg, ctx, hdr, 1);
1105 /* Sync a message in an MH folder.
1107 * This code is also used for attachment deletion in maildir
1111 static int mh_rewrite_message (CONTEXT * ctx, int msgno)
1113 HEADER *h = ctx->hdrs[msgno];
1118 char oldpath[_POSIX_PATH_MAX];
1119 char newpath[_POSIX_PATH_MAX];
1120 char partpath[_POSIX_PATH_MAX];
1122 long old_body_offset = h->content->offset;
1123 long old_body_length = h->content->length;
1124 long old_hdr_lines = h->lines;
1126 if ((dest = mx_open_new_message (ctx, h, 0)) == NULL)
1129 if ((rc = mutt_copy_message (dest->fp, ctx, h,
1130 M_CM_UPDATE, CH_UPDATE | CH_UPDATE_LEN)) == 0)
1132 snprintf (oldpath, sizeof(oldpath), "%s/%s", ctx->path, h->path);
1133 m_strcpy(partpath, sizeof(partpath), h->path);
1135 if (ctx->magic == M_MAILDIR)
1136 rc = maildir_commit_message (dest, ctx, h);
1138 rc = _mh_commit_message (dest, ctx, h, 0);
1140 mx_close_message (&dest);
1148 * Try to move the new message to the old place.
1151 * This is important when we are just updating flags.
1153 * Note that there is a race condition against programs which
1154 * use the first free slot instead of the maximum message
1155 * number. Mutt does _not_ behave like this.
1157 * Anyway, if this fails, the message is in the folder, so
1158 * all what happens is that a concurrently runnung mutt will
1159 * lose flag modifications.
1162 if (ctx->magic == M_MH && rc == 0) {
1163 snprintf (newpath, _POSIX_PATH_MAX, "%s/%s", ctx->path, h->path);
1164 if ((rc = safe_rename (newpath, oldpath)) == 0)
1165 m_strreplace(&h->path, partpath);
1169 mx_close_message (&dest);
1171 if (rc == -1 && restore) {
1172 h->content->offset = old_body_offset;
1173 h->content->length = old_body_length;
1174 h->lines = old_hdr_lines;
1177 body_list_wipe(&h->content->parts);
1181 static int mh_sync_message (CONTEXT * ctx, int msgno)
1183 HEADER *h = ctx->hdrs[msgno];
1185 if (h->attach_del ||
1186 (h->env && (h->env->refs_changed || h->env->irt_changed)))
1187 if (mh_rewrite_message (ctx, msgno) != 0)
1193 static int maildir_sync_message (CONTEXT * ctx, int msgno)
1195 HEADER *h = ctx->hdrs[msgno];
1197 if (h->attach_del ||
1198 (h->env && (h->env->refs_changed || h->env->irt_changed))) {
1199 /* when doing attachment deletion/rethreading, fall back to the MH case. */
1200 if (mh_rewrite_message (ctx, msgno) != 0)
1204 /* we just have to rename the file. */
1206 char newpath[_POSIX_PATH_MAX];
1207 char partpath[_POSIX_PATH_MAX];
1208 char fullpath[_POSIX_PATH_MAX];
1209 char oldpath[_POSIX_PATH_MAX];
1213 if ((p = strrchr (h->path, '/')) == NULL) {
1217 m_strcpy(newpath, sizeof(newpath), p);
1219 /* kill the previous flags */
1220 if ((p = strchr (newpath, ':')) != NULL)
1223 maildir_flags (suffix, sizeof (suffix), h);
1225 snprintf (partpath, sizeof (partpath), "%s/%s%s",
1226 (h->read || h->old) ? "cur" : "new", newpath, suffix);
1227 snprintf (fullpath, sizeof (fullpath), "%s/%s", ctx->path, partpath);
1228 snprintf (oldpath, sizeof (oldpath), "%s/%s", ctx->path, h->path);
1230 if (m_strcmp(fullpath, oldpath) == 0) {
1231 /* message hasn't really changed */
1235 /* record that the message is possibly marked as trashed on disk */
1236 h->trash = h->deleted;
1238 if (rename (oldpath, fullpath) != 0) {
1239 mutt_perror ("rename");
1242 m_strreplace(&h->path, partpath);
1247 static int mh_sync_mailbox (CONTEXT * ctx, int unused __attribute__ ((unused)), int *index_hint)
1249 char path[_POSIX_PATH_MAX], tmp[_POSIX_PATH_MAX];
1254 #endif /* USE_HCACHE */
1256 if (ctx->magic == M_MH)
1257 i = mh_check_mailbox (ctx, index_hint, 0);
1259 i = maildir_check_mailbox (ctx, index_hint, 0);
1265 if (ctx->magic == M_MAILDIR)
1266 hc = mutt_hcache_open (HeaderCache, ctx->path);
1267 #endif /* USE_HCACHE */
1269 for (i = 0; i < ctx->msgcount; i++) {
1270 if (ctx->hdrs[i]->deleted
1271 && (ctx->magic != M_MAILDIR || !option (OPTMAILDIRTRASH))) {
1272 snprintf (path, sizeof (path), "%s/%s", ctx->path, ctx->hdrs[i]->path);
1273 if (ctx->magic == M_MAILDIR
1274 || (option (OPTMHPURGE) && ctx->magic == M_MH)) {
1276 if (ctx->magic == M_MAILDIR)
1277 mutt_hcache_delete (hc, ctx->hdrs[i]->path + 3,
1278 &maildir_hcache_keylen);
1279 #endif /* USE_HCACHE */
1282 else if (ctx->magic == M_MH) {
1283 /* MH just moves files out of the way when you delete them */
1284 if (*ctx->hdrs[i]->path != ',') {
1285 snprintf (tmp, sizeof (tmp), "%s/,%s", ctx->path,
1286 ctx->hdrs[i]->path);
1293 else if (ctx->hdrs[i]->changed || ctx->hdrs[i]->attach_del ||
1294 (ctx->magic == M_MAILDIR
1295 && (option (OPTMAILDIRTRASH) || ctx->hdrs[i]->trash)
1296 && (ctx->hdrs[i]->deleted != ctx->hdrs[i]->trash))) {
1297 if (ctx->magic == M_MAILDIR) {
1298 if (maildir_sync_message (ctx, i) == -1)
1302 if (mh_sync_message (ctx, i) == -1)
1309 if (ctx->magic == M_MAILDIR)
1310 mutt_hcache_close (hc);
1311 #endif /* USE_HCACHE */
1313 if (ctx->magic == M_MH)
1314 mh_update_sequences (ctx);
1316 /* XXX race condition? */
1318 maildir_update_mtime (ctx);
1320 /* adjust indices */
1323 for (i = 0, j = 0; i < ctx->msgcount; i++) {
1324 if (!ctx->hdrs[i]->deleted
1325 || (ctx->magic == M_MAILDIR && option (OPTMAILDIRTRASH)))
1326 ctx->hdrs[i]->index = j++;
1334 if (ctx->magic == M_MAILDIR)
1335 mutt_hcache_close (hc);
1336 #endif /* USE_HCACHE */
1340 static char *maildir_canon_filename (char *dest, const char *src, ssize_t l)
1344 if ((t = strrchr (src, '/')))
1347 m_strcpy(dest, l, src);
1348 if ((u = strrchr (dest, ':')))
1354 static void maildir_update_tables (CONTEXT * ctx, int *index_hint)
1360 if (Sort != SORT_ORDER) {
1363 mutt_sort_headers (ctx, 1);
1367 old_count = ctx->msgcount;
1368 for (i = 0, j = 0; i < old_count; i++) {
1369 if (ctx->hdrs[i]->active && index_hint && *index_hint == i)
1372 if (ctx->hdrs[i]->active)
1373 ctx->hdrs[i]->index = j++;
1376 mx_update_tables (ctx, 0);
1377 mutt_clear_threads (ctx);
1380 static void maildir_update_flags (CONTEXT * ctx, HEADER * o, HEADER * n)
1382 /* save the global state here so we can reset it at the
1383 * end of list block if required.
1385 int context_changed = ctx->changed;
1387 /* user didn't modify this message. alter the flags to
1388 * match the current state on disk. This may not actually
1389 * do anything, but we can't tell right now. mutt_set_flag()
1390 * will just ignore the call if the status bits are
1391 * already properly set.
1393 mutt_set_flag (ctx, o, M_FLAG, n->flagged);
1394 mutt_set_flag (ctx, o, M_REPLIED, n->replied);
1395 mutt_set_flag (ctx, o, M_READ, n->read);
1396 mutt_set_flag (ctx, o, M_OLD, n->old);
1398 /* mutt_set_flag() will set this, but we don't need to
1399 * sync the changes we made because we just updated the
1400 * context to match the current on-disk state of the
1405 /* if the mailbox was not modified before we made these
1406 * changes, unset the changed flag since nothing needs to
1409 if (!context_changed)
1414 /* This function handles arrival of new mail and reopening of
1415 * maildir folders. The basic idea here is we check to see if either
1416 * the new or cur subdirectories have changed, and if so, we scan them
1417 * for the list of files. We check for newly added messages, and
1418 * then merge the flags messages we already knew about. We don't treat
1419 * either subdirectory differently, as mail could be copied directly into
1420 * the cur directory from another agent.
1422 static int maildir_check_mailbox (CONTEXT * ctx, int *index_hint, int unused __attribute__ ((unused)))
1424 struct stat st_new; /* status of the "new" subdirectory */
1425 struct stat st_cur; /* status of the "cur" subdirectory */
1426 char buf[_POSIX_PATH_MAX];
1427 int changed = 0; /* bitmask representing which subdirectories
1428 have changed. 0x1 = new, 0x2 = cur */
1429 int occult = 0; /* messages were removed from the mailbox */
1430 int have_new = 0; /* messages were added to the mailbox */
1431 struct maildir *md; /* list of messages in the mailbox */
1432 struct maildir **last, *p;
1434 hash_t *fnames; /* hash table for quickly looking up the base filename
1435 for a maildir message */
1437 if (!option (OPTCHECKNEW))
1440 snprintf (buf, sizeof (buf), "%s/new", ctx->path);
1441 if (stat (buf, &st_new) == -1)
1444 snprintf (buf, sizeof (buf), "%s/cur", ctx->path);
1445 if (stat (buf, &st_cur) == -1)
1448 /* determine which subdirectories need to be scanned */
1449 if (st_new.st_mtime > ctx->mtime)
1451 if (st_cur.st_mtime > ctx->mtime_cur)
1455 return 0; /* nothing to do */
1457 /* update the modification times on the mailbox */
1458 ctx->mtime_cur = st_cur.st_mtime;
1459 ctx->mtime = st_new.st_mtime;
1461 /* do a fast scan of just the filenames in
1462 * the subdirectories that have changed.
1467 maildir_parse_dir (ctx, &last, "new", NULL);
1469 maildir_parse_dir (ctx, &last, "cur", NULL);
1471 /* we create a hash table keyed off the canonical (sans flags) filename
1472 * of each message we scanned. This is used in the loop over the
1473 * existing messages below to do some correlation.
1475 fnames = hash_new (1031, 0);
1477 for (p = md; p; p = p->next) {
1478 maildir_canon_filename (buf, p->h->path, sizeof (buf));
1479 p->canon_fname = m_strdup(buf);
1480 hash_insert (fnames, p->canon_fname, p);
1483 /* check for modifications and adjust flags */
1484 for (i = 0; i < ctx->msgcount; i++) {
1485 ctx->hdrs[i]->active = 0;
1486 maildir_canon_filename (buf, ctx->hdrs[i]->path, sizeof (buf));
1487 p = hash_find (fnames, buf);
1489 /* message already exists, merge flags */
1490 ctx->hdrs[i]->active = 1;
1492 /* check to see if the message has moved to a different
1493 * subdirectory. If so, update the associated filename.
1495 if (m_strcmp(ctx->hdrs[i]->path, p->h->path))
1496 m_strreplace(&ctx->hdrs[i]->path, p->h->path);
1498 /* if the user hasn't modified the flags on this message, update
1499 * the flags we just detected.
1501 if (!ctx->hdrs[i]->changed)
1502 maildir_update_flags (ctx, ctx->hdrs[i], p->h);
1504 if (ctx->hdrs[i]->deleted == ctx->hdrs[i]->trash)
1505 ctx->hdrs[i]->deleted = p->h->deleted;
1506 ctx->hdrs[i]->trash = p->h->trash;
1508 /* this is a duplicate of an existing header, so remove it */
1509 header_delete(&p->h);
1511 /* This message was not in the list of messages we just scanned.
1512 * Check to see if we have enough information to know if the
1513 * message has disappeared out from underneath us.
1515 else if (((changed & 1) && (!m_strncmp (ctx->hdrs[i]->path, "new/", 4))) ||
1516 ((changed & 2) && (!m_strncmp (ctx->hdrs[i]->path, "cur/", 4)))) {
1517 /* This message disappeared, so we need to simulate a "reopen"
1518 * event. We know it disappeared because we just scanned the
1519 * subdirectory it used to reside in.
1524 /* This message resides in a subdirectory which was not
1525 * modified, so we assume that it is still present and
1528 ctx->hdrs[i]->active = 1;
1532 /* destroy the file name hash */
1533 hash_delete (&fnames, NULL);
1535 /* If we didn't just get new mail, update the tables. */
1537 maildir_update_tables (ctx, index_hint);
1539 /* do any delayed parsing we need to do. */
1540 maildir_delayed_parsing (ctx, md);
1542 /* Incorporate new messages */
1543 have_new = maildir_move_to_context (ctx, &md);
1545 return occult ? M_REOPENED : (have_new ? M_NEW_MAIL : 0);
1549 * This function handles arrival of new mail and reopening of
1550 * mh/maildir folders. Things are getting rather complex because we
1551 * don't have a well-defined "mailbox order", so the tricks from
1552 * mbox.c and mx.c won't work here.
1554 * Don't change this code unless you _really_ understand what
1559 static int mh_check_mailbox (CONTEXT * ctx, int *index_hint, int unused __attribute__ ((unused)))
1561 char buf[_POSIX_PATH_MAX];
1562 struct stat st, st_cur;
1563 short modified = 0, have_new = 0, occult = 0;
1564 struct maildir *md, *p;
1565 struct maildir **last = NULL;
1566 struct mh_sequences mhs;
1570 if (!option (OPTCHECKNEW))
1573 m_strcpy(buf, sizeof(buf), ctx->path);
1574 if (stat (buf, &st) == -1)
1577 /* create .mh_sequences when there isn't one. */
1578 snprintf (buf, sizeof (buf), "%s/.mh_sequences", ctx->path);
1579 if ((i = stat (buf, &st_cur) == -1) && errno == ENOENT) {
1583 if (mh_mkstemp (ctx, &fp, &tmp) == 0) {
1585 if (safe_rename (tmp, buf) == -1)
1591 if (i == -1 && stat (buf, &st_cur) == -1)
1594 if (st.st_mtime > ctx->mtime || st_cur.st_mtime > ctx->mtime_cur)
1600 ctx->mtime_cur = st_cur.st_mtime;
1601 ctx->mtime = st.st_mtime;
1607 maildir_parse_dir (ctx, &last, NULL, NULL);
1608 mh_read_sequences (&mhs, ctx->path);
1609 mh_update_maildir (md, &mhs);
1610 mhs_free_sequences (&mhs);
1612 /* check for modifications and adjust flags */
1613 fnames = hash_new (1031, 0);
1615 for (p = md; p; p = p->next)
1616 hash_insert (fnames, p->h->path, p);
1618 for (i = 0; i < ctx->msgcount; i++) {
1619 ctx->hdrs[i]->active = 0;
1621 if ((p = hash_find (fnames, ctx->hdrs[i]->path)) && p->h &&
1622 (mutt_cmp_header (ctx->hdrs[i], p->h))) {
1623 ctx->hdrs[i]->active = 1;
1624 /* found the right message */
1625 if (!ctx->hdrs[i]->changed)
1626 maildir_update_flags (ctx, ctx->hdrs[i], p->h);
1628 header_delete(&p->h);
1630 else /* message has disappeared */
1634 /* destroy the file name hash */
1636 hash_delete (&fnames, NULL);
1638 /* If we didn't just get new mail, update the tables. */
1640 maildir_update_tables (ctx, index_hint);
1642 /* Incorporate new messages */
1643 have_new = maildir_move_to_context (ctx, &md);
1645 return occult ? M_REOPENED : (have_new ? M_NEW_MAIL : 0);
1652 * These functions try to find a message in a maildir folder when it
1653 * has moved under our feet. Note that this code is rather expensive, but
1654 * then again, it's called rarely.
1657 static FILE *_maildir_open_find_message (const char *folder, const char *unique,
1658 const char *subfolder)
1660 char dir[_POSIX_PATH_MAX];
1661 char tunique[_POSIX_PATH_MAX];
1662 char fname[_POSIX_PATH_MAX];
1670 snprintf (dir, sizeof (dir), "%s/%s", folder, subfolder);
1672 if ((dp = opendir (dir)) == NULL) {
1677 while ((de = readdir (dp))) {
1678 maildir_canon_filename (tunique, de->d_name, sizeof (tunique));
1680 if (!m_strcmp(tunique, unique)) {
1681 snprintf (fname, sizeof (fname), "%s/%s/%s", folder, subfolder,
1683 fp = fopen(fname, "r");
1695 FILE *maildir_open_find_message (const char *folder, const char *msg)
1697 char unique[_POSIX_PATH_MAX];
1700 static unsigned int new_hits = 0, cur_hits = 0; /* simple dynamic optimization */
1702 maildir_canon_filename (unique, msg, sizeof (unique));
1705 _maildir_open_find_message (folder, unique,
1706 new_hits > cur_hits ? "new" : "cur"))
1707 || errno != ENOENT) {
1708 if (new_hits < UINT_MAX && cur_hits < UINT_MAX) {
1709 new_hits += (new_hits > cur_hits ? 1 : 0);
1710 cur_hits += (new_hits > cur_hits ? 0 : 1);
1716 _maildir_open_find_message (folder, unique,
1717 new_hits > cur_hits ? "cur" : "new"))
1718 || errno != ENOENT) {
1719 if (new_hits < UINT_MAX && cur_hits < UINT_MAX) {
1720 new_hits += (new_hits > cur_hits ? 0 : 1);
1721 cur_hits += (new_hits > cur_hits ? 1 : 0);
1733 * 1 if there are no messages in the mailbox
1734 * 0 if there are messages in the mailbox
1737 static int maildir_check_empty (const char *path)
1741 int r = 1; /* assume empty until we find a message */
1742 char frealpath[_POSIX_PATH_MAX];
1745 /* Strategy here is to look for any file not beginning with a period */
1748 /* we do "cur" on the first iteration since its more likely that we'll
1749 * find old messages without having to scan both subdirs
1751 snprintf (frealpath, sizeof (frealpath), "%s/%s", path,
1752 iter == 0 ? "cur" : "new");
1753 if ((dp = opendir (frealpath)) == NULL)
1755 while ((de = readdir (dp))) {
1756 if (*de->d_name != '.') {
1763 } while (r && iter < 2);
1770 * 1 if there are no messages in the mailbox
1771 * 0 if there are messages in the mailbox
1774 static int mh_check_empty (const char *path)
1778 int r = 1; /* assume empty until we find a message */
1780 if ((dp = opendir (path)) == NULL)
1782 while ((de = readdir (dp))) {
1783 if (mh_valid_message (de->d_name)) {
1793 static int mh_is_magic (const char* path, struct stat* st) {
1794 char tmp[_POSIX_PATH_MAX];
1796 if (S_ISDIR (st->st_mode)) {
1797 snprintf (tmp, sizeof (tmp), "%s/.mh_sequences", path);
1798 if (access (tmp, F_OK) == 0)
1801 snprintf (tmp, sizeof (tmp), "%s/.xmhcache", path);
1802 if (access (tmp, F_OK) == 0)
1805 snprintf (tmp, sizeof (tmp), "%s/.mew_cache", path);
1806 if (access (tmp, F_OK) == 0)
1809 snprintf (tmp, sizeof (tmp), "%s/.mew-cache", path);
1810 if (access (tmp, F_OK) == 0)
1813 snprintf (tmp, sizeof (tmp), "%s/.sylpheed_cache", path);
1814 if (access (tmp, F_OK) == 0)
1818 * ok, this isn't an mh folder, but mh mode can be used to read
1819 * Usenet news from the spool. ;-)
1822 snprintf (tmp, sizeof (tmp), "%s/.overview", path);
1823 if (access (tmp, F_OK) == 0)
1829 static int maildir_is_magic (const char* path, struct stat* st) {
1831 char tmp[_POSIX_PATH_MAX];
1833 if (S_ISDIR (st->st_mode)) {
1834 snprintf (tmp, sizeof (tmp), "%s/cur", path);
1835 if (stat (tmp, &sb) == 0 && S_ISDIR (sb.st_mode))
1841 static int mh_commit (MESSAGE* msg, CONTEXT* ctx) {
1842 return (mh_commit_message (msg, ctx, NULL));
1845 static int maildir_commit (MESSAGE* msg, CONTEXT* ctx) {
1846 return (maildir_commit_message (msg, ctx, NULL));
1849 mx_t const maildir_mx = {
1853 maildir_check_empty,
1856 maildir_open_new_message,
1858 maildir_check_mailbox,
1864 mx_t const mh_mx = {
1871 mh_open_new_message,