2 * Copyright notice from original mutt:
3 * Copyright (C) 1996-2002 Michael R. Elkins <me@mutt.org>
5 * This file is part of mutt-ng, see http://www.muttng.org/.
6 * It's licensed under the GNU General Public License,
7 * please see the file GPL in the top level source directory.
10 /* This file contains code to parse ``mbox'' style mailboxes */
12 #include <lib-lib/lib-lib.h>
14 #include <lib-ui/lib-ui.h>
15 #include <lib-sys/mutt_signal.h>
26 /* struct used by mutt_sync_mailbox() to store new offsets */
35 static int mbox_open_new_message(MESSAGE *msg, CONTEXT *dest, HEADER *hdr)
42 static int mbox_reopen_mailbox (CONTEXT*, int*);
45 * ctx - context to lock
46 * excl - exclusive lock?
47 * retry - should retry if unable to lock?
49 int mbox_lock_mailbox(CONTEXT *ctx, int excl, int retry)
53 if ((r = mx_lock_file(ctx->path, fileno(ctx->fp), excl, 1, retry)) == 0)
55 else if (retry && !excl) {
63 static void mbox_unlock_mailbox (CONTEXT * ctx)
68 mx_unlock_file (ctx->path, fileno (ctx->fp), 1);
73 /* Note that this function is also called when new mail is appended to the
74 * currently open folder, and NOT just when the mailbox is initially read.
76 * NOTE: it is assumed that the mailbox being read has been locked before
77 * this routine gets called. Strange things could happen if it's not!
79 static int mbox_parse_mailbox (CONTEXT * ctx)
82 char buf[HUGE_STRING], return_path[STRING];
85 int count = 0, lines = 0;
88 /* Save information about the folder at the time we opened it. */
89 if (stat (ctx->path, &sb) == -1) {
90 mutt_perror (ctx->path);
94 ctx->size = sb.st_size;
95 ctx->mtime = sb.st_mtime;
98 ctx->readonly = access (ctx->path, W_OK) ? 1 : 0;
100 /* precompute the local timezone to speed up calculation of the
103 time_t t = time(NULL);
104 tz = localtime(&t)->tm_gmtoff;
107 loc = ftello (ctx->fp);
108 while (fgets (buf, sizeof (buf), ctx->fp) != NULL) {
109 if (is_from (buf, return_path, sizeof (return_path), &t)) {
110 /* Save the Content-Length of the previous message */
112 #define PREV ctx->hdrs[ctx->msgcount-1]
114 if (PREV->content->length < 0) {
115 PREV->content->length = loc - PREV->content->offset - 1;
116 if (PREV->content->length < 0)
117 PREV->content->length = 0;
120 PREV->lines = lines ? lines - 1 : 0;
125 if (!ctx->quiet && ReadInc && ((count % ReadInc == 0) || count == 1))
126 mutt_message (_("Reading %s... %d (%d%%)"), ctx->path, count,
127 (int) (ftello (ctx->fp) / (ctx->size / 100 + 1)));
129 if (ctx->msgcount == ctx->hdrmax)
130 mx_alloc_memory (ctx);
132 curhdr = ctx->hdrs[ctx->msgcount] = header_new();
133 curhdr->received = t - tz;
134 curhdr->offset = loc;
135 curhdr->index = ctx->msgcount;
137 curhdr->env = mutt_read_rfc822_header (ctx->fp, curhdr, 0, 0);
139 /* if we know how long this message is, either just skip over the body,
140 * or if we don't know how many lines there are, count them now (this will
141 * save time by not having to search for the next message marker).
143 if (curhdr->content->length > 0) {
146 loc = ftello (ctx->fp);
147 tmploc = loc + curhdr->content->length + 1;
149 if (0 < tmploc && tmploc < ctx->size) {
151 * check to see if the content-length looks valid. we expect to
152 * to see a valid message separator at this point in the stream
154 if (fseeko (ctx->fp, tmploc, SEEK_SET) != 0 ||
155 fgets (buf, sizeof (buf), ctx->fp) == NULL ||
156 m_strncmp("From ", buf, 5) != 0) {
157 fseeko (ctx->fp, loc, SEEK_SET); /* nope, return the previous position */
158 curhdr->content->length = -1;
161 else if (tmploc != ctx->size) {
162 /* content-length would put us past the end of the file, so it
165 curhdr->content->length = -1;
168 if (curhdr->content->length != -1) {
169 /* good content-length. check to see if we know how many lines
170 * are in this message.
172 if (curhdr->lines == 0) {
173 int cl = curhdr->content->length;
175 /* count the number of lines in this message */
176 fseeko (ctx->fp, loc, SEEK_SET);
178 if (fgetc (ctx->fp) == '\n')
183 /* return to the offset of the next message separator */
184 fseeko(ctx->fp, tmploc, SEEK_SET);
190 if (!curhdr->env->return_path && return_path[0])
191 curhdr->env->return_path =
192 rfc822_parse_adrlist (curhdr->env->return_path, return_path);
194 if (!curhdr->env->from)
195 curhdr->env->from = address_list_dup (curhdr->env->return_path);
202 loc = ftello (ctx->fp);
206 * Only set the content-length of the previous message if we have read more
207 * than one message during _this_ invocation. If this routine is called
208 * when new mail is received, we need to make sure not to clobber what
209 * previously was the last message since the headers may be sorted.
212 if (PREV->content->length < 0) {
213 PREV->content->length = ftello (ctx->fp) - PREV->content->offset - 1;
214 if (PREV->content->length < 0)
215 PREV->content->length = 0;
219 PREV->lines = lines ? lines - 1 : 0;
221 mx_update_context (ctx, count);
229 /* open a mbox style mailbox */
230 static int mbox_open_mailbox (CONTEXT * ctx)
234 if (!(ctx->fp = fopen(ctx->path, "r"))) {
235 mutt_perror(ctx->path);
239 mutt_block_signals();
240 if (mbox_lock_mailbox(ctx, 0, 1) < 0) {
241 mutt_unblock_signals();
245 rc = ctx->magic == M_MBOX ? mbox_parse_mailbox(ctx) : -1;
247 mbox_unlock_mailbox(ctx);
248 mutt_unblock_signals();
252 /* check to see if the mailbox has changed on disk.
255 * M_REOPENED mailbox has been reopened
256 * M_NEW_MAIL new mail has arrived!
257 * M_LOCKED couldn't lock the file
261 static int _mbox_check_mailbox (CONTEXT * ctx, int *index_hint)
264 char buffer[LONG_STRING];
268 if (stat (ctx->path, &st) == 0) {
269 if (st.st_mtime == ctx->mtime && st.st_size == ctx->size)
272 if (st.st_size == ctx->size) {
273 /* the file was touched, but it is still the same length, so just exit */
274 ctx->mtime = st.st_mtime;
278 if (st.st_size > ctx->size) {
279 /* lock the file if it isn't already */
281 mutt_block_signals ();
282 if (mbox_lock_mailbox (ctx, 0, 0) == -1) {
283 mutt_unblock_signals ();
284 /* we couldn't lock the mailbox, but nothing serious happened:
285 * probably the new mail arrived: no reason to wait till we can
286 * parse it: we'll get it on the next pass
294 * Check to make sure that the only change to the mailbox is that
295 * message(s) were appended to this file. My heuristic is that we should
296 * see the message separator at *exactly* what used to be the end of the
299 fseeko (ctx->fp, ctx->size, SEEK_SET);
300 if (fgets (buffer, sizeof (buffer), ctx->fp) != NULL) {
301 if (ctx->magic == M_MBOX && m_strncmp("From ", buffer, 5) == 0) {
302 fseeko (ctx->fp, ctx->size, SEEK_SET);
303 mbox_parse_mailbox (ctx);
305 /* Only unlock the folder if it was locked inside of this routine.
306 * It may have been locked elsewhere, like in
307 * mutt_checkpoint_mailbox().
311 mbox_unlock_mailbox (ctx);
312 mutt_unblock_signals ();
315 return (M_NEW_MAIL); /* signal that new mail arrived */
328 if (mbox_reopen_mailbox (ctx, index_hint) != -1) {
330 mbox_unlock_mailbox (ctx);
331 mutt_unblock_signals ();
339 mbox_unlock_mailbox (ctx);
340 mx_fastclose_mailbox (ctx);
341 mutt_unblock_signals ();
342 mutt_error _("Mailbox was corrupted!");
347 static int mbox_check_mailbox(CONTEXT *ctx, int *index_hint, int lock)
352 mutt_block_signals();
353 if (mbox_lock_mailbox(ctx, 0, 0) < 0) {
354 mutt_unblock_signals();
359 rc = _mbox_check_mailbox(ctx, index_hint);
362 mutt_unblock_signals ();
363 mbox_unlock_mailbox (ctx);
372 static int mbox_sync_mailbox (CONTEXT * ctx, int unused __attribute__ ((unused)), int *index_hint)
374 char tempfile[_POSIX_PATH_MAX];
376 int i, j, save_sort = SORT_ORDER;
378 int need_sort = 0; /* flag to resort mailbox if new mail arrives */
379 int first = -1; /* first message to be written */
380 off_t offset; /* location in mailbox to write changed messages */
382 struct utimbuf utimebuf;
383 struct m_update_t *newOffset = NULL;
384 struct m_update_t *oldOffset = NULL;
387 /* sort message by their position in the mailbox on disk */
388 if (Sort != SORT_ORDER) {
391 mutt_sort_headers (ctx, 0);
396 /* need to open the file for writing in such a way that it does not truncate
397 * the file, so use read-write mode.
399 if ((ctx->fp = freopen (ctx->path, "r+", ctx->fp)) == NULL) {
400 mx_fastclose_mailbox (ctx);
401 mutt_error _("Fatal error! Could not reopen mailbox!");
406 mutt_block_signals ();
408 if (mbox_lock_mailbox (ctx, 1, 1) == -1) {
409 mutt_unblock_signals ();
410 mutt_error _("Unable to lock mailbox!");
415 /* Check to make sure that the file hasn't changed on disk */
416 if ((i = _mbox_check_mailbox (ctx, index_hint)) == M_NEW_MAIL
417 || i == M_REOPENED) {
418 /* new mail arrived, or mailbox reopened */
427 /* Create a temporary file to write the new version of the mailbox in. */
428 fp = m_tempfile(tempfile, _POSIX_PATH_MAX, NONULL(mod_core.tmpdir), NULL);
430 mutt_error _("Could not create temporary file!");
435 /* find the first deleted/changed message. we save a lot of time by only
436 * rewriting the mailbox from the point where it has actually changed.
438 for (i = 0; i < ctx->msgcount && !ctx->hdrs[i]->deleted &&
439 !ctx->hdrs[i]->changed && !ctx->hdrs[i]->attach_del; i++);
440 if (i == ctx->msgcount) {
441 /* this means ctx->changed or ctx->deleted was set, but no
442 * messages were found to be changed or deleted. This should
443 * never happen, is we presume it is a bug in mutt.
446 _("sync: mbox modified, but no modified messages! (report this bug)");
447 mutt_sleep (5); /* the mutt_error /will/ get cleared! */
452 /* save the index of the first changed/deleted message */
454 /* where to start overwriting */
455 offset = ctx->hdrs[i]->offset;
457 /* allocate space for the new offsets */
458 newOffset = p_new(struct m_update_t, ctx->msgcount - first);
459 oldOffset = p_new(struct m_update_t, ctx->msgcount - first);
461 for (i = first, j = 0; i < ctx->msgcount; i++) {
463 * back up some information which is needed to restore offsets when
467 oldOffset[i - first].valid = 1;
468 oldOffset[i - first].hdr = ctx->hdrs[i]->offset;
469 oldOffset[i - first].body = ctx->hdrs[i]->content->offset;
470 oldOffset[i - first].lines = ctx->hdrs[i]->lines;
471 oldOffset[i - first].length = ctx->hdrs[i]->content->length;
473 if (!ctx->hdrs[i]->deleted) {
475 if (!ctx->quiet && WriteInc && ((i % WriteInc) == 0 || j == 1))
476 mutt_message (_("Writing messages... %d (%d%%)"), i,
477 (int) (ftello (ctx->fp) / (ctx->size / 100 + 1)));
479 /* save the new offset for this message. we add `offset' because the
480 * temporary file only contains saved message which are located after
481 * `offset' in the real mailbox
483 newOffset[i - first].hdr = ftello (fp) + offset;
485 if (mutt_copy_message
486 (fp, ctx, ctx->hdrs[i], M_CM_UPDATE,
487 CH_FROM | CH_UPDATE | CH_UPDATE_LEN) == -1) {
488 mutt_perror (_("Can't create temporary file"));
494 /* Since messages could have been deleted, the offsets stored in memory
495 * will be wrong, so update what we can, which is the offset of this
496 * message, and the offset of the body. If this is a multipart message,
497 * we just flush the in memory cache so that the message will be reparsed
498 * if the user accesses it later.
500 newOffset[i - first].body =
501 ftello (fp) - ctx->hdrs[i]->content->length + offset;
502 body_list_wipe(&ctx->hdrs[i]->content->parts);
504 if (fputs ("\n", fp) == EOF) {
505 mutt_perror (_("Can't create temporary file"));
513 if (m_fclose(&fp) != 0) {
515 mutt_perror (_("Can't create temporary file"));
520 /* Save the state of this folder. */
521 if (stat (ctx->path, &statbuf) == -1) {
522 mutt_perror (ctx->path);
528 if ((fp = fopen (tempfile, "r")) == NULL) {
529 mutt_unblock_signals ();
530 mx_fastclose_mailbox (ctx);
531 mutt_perror (_("Can't create temporary file"));
536 if (fseeko (ctx->fp, offset, SEEK_SET) != 0 /* seek the append location */
537 /* do a sanity check to make sure the mailbox looks ok */
538 || fgets (buf, sizeof (buf), ctx->fp) == NULL
539 || (ctx->magic == M_MBOX && m_strncmp("From ", buf, 5) != 0))
544 if (fseeko (ctx->fp, offset, SEEK_SET) != 0) { /* return to proper offset */
547 /* copy the temp mailbox back into place starting at the first
548 * change/deleted message
550 mutt_message _("Committing changes...");
552 i = mutt_copy_stream (fp, ctx->fp);
554 if (ferror (ctx->fp))
558 ctx->size = ftello (ctx->fp); /* update the size of the mailbox */
559 ftruncate (fileno (ctx->fp), ctx->size);
564 mbox_unlock_mailbox (ctx);
566 if (m_fclose(&ctx->fp) != 0 || i == -1) {
567 /* error occured while writing the mailbox back, so keep the temp copy
571 char savefile[_POSIX_PATH_MAX];
573 snprintf(savefile, sizeof (savefile), "%s/mutt.%s-%u",
574 NONULL(mod_core.tmpdir), NONULL(mod_core.username), (unsigned int)getpid());
575 rename (tempfile, savefile);
576 mutt_unblock_signals ();
577 mx_fastclose_mailbox (ctx);
578 mutt_pretty_mailbox (savefile);
579 mutt_error (_("Write failed! Saved partial mailbox to %s"), savefile);
584 /* Restore the previous access/modification times */
585 utimebuf.actime = statbuf.st_atime;
586 utimebuf.modtime = statbuf.st_mtime;
587 utime (ctx->path, &utimebuf);
589 /* reopen the mailbox in read-only mode */
590 if ((ctx->fp = fopen (ctx->path, "r")) == NULL) {
592 mutt_unblock_signals ();
593 mx_fastclose_mailbox (ctx);
594 mutt_error _("Fatal error! Could not reopen mailbox!");
598 /* update the offsets of the rewritten messages */
599 for (i = first, j = first; i < ctx->msgcount; i++) {
600 if (!ctx->hdrs[i]->deleted) {
601 ctx->hdrs[i]->offset = newOffset[i - first].hdr;
602 ctx->hdrs[i]->content->hdr_offset = newOffset[i - first].hdr;
603 ctx->hdrs[i]->content->offset = newOffset[i - first].body;
604 ctx->hdrs[i]->index = j++;
607 p_delete(&newOffset);
608 p_delete(&oldOffset);
609 unlink (tempfile); /* remove partial copy of the mailbox */
610 mutt_unblock_signals ();
612 return (0); /* signal success */
614 bail: /* Come here in case of disaster */
618 /* restore offsets, as far as they are valid */
619 if (first >= 0 && oldOffset) {
620 for (i = first; i < ctx->msgcount && oldOffset[i - first].valid; i++) {
621 ctx->hdrs[i]->offset = oldOffset[i - first].hdr;
622 ctx->hdrs[i]->content->hdr_offset = oldOffset[i - first].hdr;
623 ctx->hdrs[i]->content->offset = oldOffset[i - first].body;
624 ctx->hdrs[i]->lines = oldOffset[i - first].lines;
625 ctx->hdrs[i]->content->length = oldOffset[i - first].length;
629 /* this is ok to call even if we haven't locked anything */
630 mbox_unlock_mailbox (ctx);
632 mutt_unblock_signals ();
633 p_delete(&newOffset);
634 p_delete(&oldOffset);
636 if ((ctx->fp = freopen (ctx->path, "r", ctx->fp)) == NULL) {
637 mutt_error _("Could not reopen mailbox!");
639 mx_fastclose_mailbox (ctx);
644 /* if the mailbox was reopened, the thread tree will be invalid so make
645 * sure to start threading from scratch. */
646 mutt_sort_headers (ctx, (need_sort == M_REOPENED));
651 /* close a mailbox opened in write-mode */
652 int mbox_close_mailbox (CONTEXT * ctx)
654 mx_unlock_file (ctx->path, fileno (ctx->fp), 1);
657 mutt_slow_close_compressed (ctx);
659 mutt_unblock_signals ();
660 mx_fastclose_mailbox (ctx);
664 static int mbox_reopen_mailbox (CONTEXT * ctx, int *index_hint)
666 int (*cmp_headers) (const HEADER *, const HEADER *) = NULL;
674 /* silent operations */
677 mutt_message _("Reopening mailbox...");
679 /* our heuristics require the old mailbox to be unsorted */
680 if (Sort != SORT_ORDER) {
685 mutt_sort_headers (ctx, 1);
692 /* simulate a close */
694 hash_delete (&ctx->id_hash, NULL);
696 hash_delete (&ctx->subj_hash, NULL);
697 mutt_clear_threads (ctx);
700 for (i = 0; i < ctx->msgcount; i++)
701 header_delete(&(ctx->hdrs[i])); /* nothing to do! */
702 p_delete(&ctx->hdrs);
705 /* save the old headers */
706 old_msgcount = ctx->msgcount;
707 old_hdrs = ctx->hdrs;
711 ctx->hdrmax = 0; /* force allocation of new headers */
721 ctx->subj_hash = NULL;
723 if (ctx->magic == M_MBOX && !fseeko(ctx->fp, 0, SEEK_SET)) {
724 cmp_headers = mutt_cmp_header;
725 rc = mbox_parse_mailbox (ctx);
731 /* free the old headers */
732 for (j = 0; j < old_msgcount; j++)
733 header_delete(&(old_hdrs[j]));
740 /* now try to recover the old flags */
742 index_hint_set = (index_hint == NULL);
744 if (!ctx->readonly) {
745 for (i = 0; i < ctx->msgcount; i++) {
748 /* some messages have been deleted, and new messages have been
749 * appended at the end; the heuristic is that old messages have then
750 * "advanced" towards the beginning of the folder, so we begin the
751 * search at index "i"
753 for (j = i; j < old_msgcount; j++) {
754 if (old_hdrs[j] == NULL)
756 if (cmp_headers (ctx->hdrs[i], old_hdrs[j])) {
762 for (j = 0; j < i && j < old_msgcount; j++) {
763 if (old_hdrs[j] == NULL)
765 if (cmp_headers (ctx->hdrs[i], old_hdrs[j])) {
773 /* this is best done here */
774 if (!index_hint_set && *index_hint == j)
777 if (old_hdrs[j]->changed) {
778 /* Only update the flags if the old header was changed;
779 * otherwise, the header may have been modified externally,
780 * and we don't want to lose _those_ changes
782 mutt_set_flag (ctx, ctx->hdrs[i], M_FLAG, old_hdrs[j]->flagged);
783 mutt_set_flag (ctx, ctx->hdrs[i], M_REPLIED, old_hdrs[j]->replied);
784 mutt_set_flag (ctx, ctx->hdrs[i], M_OLD, old_hdrs[j]->old);
785 mutt_set_flag (ctx, ctx->hdrs[i], M_READ, old_hdrs[j]->read);
787 mutt_set_flag (ctx, ctx->hdrs[i], M_DELETE, old_hdrs[j]->deleted);
788 mutt_set_flag (ctx, ctx->hdrs[i], M_TAG, old_hdrs[j]->tagged);
790 /* we don't need this header any more */
791 header_delete(&(old_hdrs[j]));
795 /* free the remaining old headers */
796 for (j = 0; j < old_msgcount; j++) {
798 header_delete(&(old_hdrs[j]));
807 return ((ctx->changed || msg_mod) ? M_REOPENED : M_NEW_MAIL);
812 * 1 if the mailbox is not empty
813 * 0 if the mailbox is empty
816 int mbox_check_empty (const char *path)
820 if (stat (path, &st) == -1)
823 return ((st.st_size == 0));
826 int mbox_is_magic (const char* path, struct stat* st)
830 char tmp[_POSIX_PATH_MAX];
832 if (S_ISDIR(st->st_mode))
835 if (st->st_size == 0) {
838 else if ((f = fopen (path, "r")) != NULL) {
839 struct utimbuf times;
841 fgets (tmp, sizeof (tmp), f);
842 if (m_strncmp("From ", tmp, 5) == 0)
846 /* need to restore the times here, the file was not really accessed,
847 * only the type was accessed. This is important, because detection
848 * of "new mail" depends on those times set correctly.
850 times.actime = st->st_atime;
851 times.modtime = st->st_mtime;
852 utime (path, ×);
855 return (-1); /* fopen failed */
858 if (magic == -1 && mutt_can_read_compressed (path))
859 return (M_COMPRESSED);
863 static int mbox_commit_message (MESSAGE* msg, CONTEXT* ctx) {
864 if (fputc ('\n', msg->fp) == EOF)
866 if ((fflush (msg->fp) == EOF || fsync (fileno (msg->fp)) == -1)) {
867 mutt_perror (_("Can't write message"));
873 mx_t const mbox_mx = {
880 mbox_open_new_message,