/*
* Copyright (C) 1996-2002,2007,2009 Michael R. Elkins <me@mutt.org>
* Copyright (C) 1999-2005 Thomas Roessler <roessler@does-not-exist.org>
* Copyright (C) 2010,2013 Michael R. Elkins <me@mutt.org>
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*/
/*
* This file contains routines specific to MH and ``maildir'' style
* mailboxes.
*/
#if HAVE_CONFIG_H
# include "config.h"
#endif
#include "mutt.h"
#include "mailbox.h"
#include "mx.h"
#include "copy.h"
#include "sort.h"
#if USE_HCACHE
#include "hcache.h"
#endif
#include "mutt_curses.h"
#include "buffy.h"
#ifdef USE_INOTIFY
#include "monitor.h"
#endif
#include <sys/stat.h>
#include <sys/types.h>
#include <dirent.h>
#include <limits.h>
#include <unistd.h>
#include <fcntl.h>
#include <stdio.h>
#include <stdlib.h>
#include <ctype.h>
#include <errno.h>
#include <string.h>
#include <utime.h>
#if HAVE_SYS_TIME_H
#include <sys/time.h>
#endif
#define INS_SORT_THRESHOLD 6
static int maildir_check_mailbox (CONTEXT * ctx, int *index_hint);
static int mh_check_mailbox (CONTEXT * ctx, int *index_hint);
struct maildir
{
HEADER *h;
char *canon_fname;
unsigned header_parsed:1;
#ifdef HAVE_DIRENT_D_INO
ino_t inode;
#endif /* HAVE_DIRENT_D_INO */
struct maildir *next;
};
struct mh_sequences
{
int max;
short *flags;
};
struct mh_data
{
struct timespec mtime_cur;
mode_t mh_umask;
};
/* mh_sequences support */
#define MH_SEQ_UNSEEN (1 << 0)
#define MH_SEQ_REPLIED (1 << 1)
#define MH_SEQ_FLAGGED (1 << 2)
static inline struct mh_data *mh_data (CONTEXT *ctx)
{
return (struct mh_data*)ctx->data;
}
static void mhs_alloc (struct mh_sequences *mhs, int i)
{
int j;
int newmax;
if (i > mhs->max || !mhs->flags)
{
newmax = i + 128;
j = mhs->flags ? mhs->max + 1 : 0;
safe_realloc (&mhs->flags, sizeof (mhs->flags[0]) * (newmax + 1));
while (j <= newmax)
mhs->flags[j++] = 0;
mhs->max = newmax;
}
}
static void mhs_free_sequences (struct mh_sequences *mhs)
{
FREE (&mhs->flags);
}
static short mhs_check (struct mh_sequences *mhs, int i)
{
if (!mhs->flags || i > mhs->max)
return 0;
else
return mhs->flags[i];
}
static short mhs_set (struct mh_sequences *mhs, int i, short f)
{
mhs_alloc (mhs, i);
mhs->flags[i] |= f;
return mhs->flags[i];
}
#if 0
/* unused */
static short mhs_unset (struct mh_sequences *mhs, int i, short f)
{
mhs_alloc (mhs, i);
mhs->flags[i] &= ~f;
return mhs->flags[i];
}
#endif
static int mh_read_token (char *t, int *first, int *last)
{
char *p;
if ((p = strchr (t, '-')))
{
*p++ = '\0';
if (mutt_atoi (t, first, 0) < 0 || mutt_atoi (p, last, 0) < 0)
return -1;
}
else
{
if (mutt_atoi (t, first, 0) < 0)
return -1;
*last = *first;
}
return 0;
}
static int mh_read_sequences (struct mh_sequences *mhs, const char *path)
{
FILE *fp = NULL;
int line = 1;
char *buff = NULL;
char *t;
size_t sz = 0;
short f;
int first, last, rc = 0;
BUFFER *pathname = mutt_buffer_pool_get ();
mutt_buffer_printf (pathname, "%s/.mh_sequences", path);
if (!(fp = fopen (mutt_b2s (pathname), "r")))
goto out; /* yes, ask callers to silently ignore the error */
while ((buff = mutt_read_line (buff, &sz, fp, &line, 0)))
{
if (!(t = strtok (buff, " \t:")))
continue;
if (!mutt_strcmp (t, MhUnseen))
f = MH_SEQ_UNSEEN;
else if (!mutt_strcmp (t, MhFlagged))
f = MH_SEQ_FLAGGED;
else if (!mutt_strcmp (t, MhReplied))
f = MH_SEQ_REPLIED;
else /* unknown sequence */
continue;
while ((t = strtok (NULL, " \t:")))
{
if (mh_read_token (t, &first, &last) < 0)
{
mhs_free_sequences (mhs);
rc = -1;
goto out;
}
for (; first <= last; first++)
mhs_set (mhs, first, f);
}
}
rc = 0;
out:
mutt_buffer_pool_release (&pathname);
FREE (&buff);
safe_fclose (&fp);
return rc;
}
static inline mode_t mh_umask (CONTEXT* ctx)
{
struct stat st;
struct mh_data* data = mh_data (ctx);
if (data && data->mh_umask)
return data->mh_umask;
if (stat (ctx->path, &st))
{
dprint (1, (debugfile, "stat failed on %s\n", ctx->path));
return 077;
}
return 0777 & ~st.st_mode;
}
/*
* Returns 1 if the .mh_sequences last modification time is more recent than the last visit to this mailbox
* Returns 0 if the modifcation time is older
* Returns -1 on error
*/
static int mh_sequences_changed(BUFFY *b)
{
BUFFER *path = NULL;
struct stat sb;
int rc = -1;
path = mutt_buffer_pool_get ();
mutt_buffer_printf (path, "%s/.mh_sequences", mutt_b2s (b->pathbuf));
if (stat (mutt_b2s (path), &sb) == 0)
rc = (mutt_stat_timespec_compare (&sb, MUTT_STAT_MTIME, &b->last_visited) > 0);
mutt_buffer_pool_release (&path);
return rc;
}
/*
* Returns 1 if the modification time on the message file is older than the last visit to this mailbox
* Returns 0 if the modtime is newer
* Returns -1 on error
*/
static int mh_already_notified(BUFFY *b, int msgno)
{
BUFFER *path = NULL;
struct stat sb;
int rc = -1;
path = mutt_buffer_pool_get ();
mutt_buffer_printf (path, "%s/%d", mutt_b2s (b->pathbuf), msgno);
if (stat (mutt_b2s (path), &sb) == 0)
rc = (mutt_stat_timespec_compare (&sb, MUTT_STAT_MTIME, &b->last_visited) <= 0);
mutt_buffer_pool_release (&path);
return rc;
}
/* Checks new mail for a mh mailbox.
* check_stats: if true, also count total, new, and flagged messages.
* Returns 1 if the mailbox has new mail.
*/
int mh_buffy (BUFFY *mailbox, int check_stats)
{
int i;
struct mh_sequences mhs;
int check_new = 1;
int rc = 0;
DIR *dirp;
struct dirent *de;
/* when $mail_check_recent is set and the .mh_sequences file hasn't changed
* since the last mailbox visit, there is no "new mail" */
if (option(OPTMAILCHECKRECENT) && mh_sequences_changed(mailbox) <= 0)
{
rc = 0;
check_new = 0;
}
if (! (check_new || check_stats))
return rc;
memset (&mhs, 0, sizeof (mhs));
if (mh_read_sequences (&mhs, mutt_b2s (mailbox->pathbuf)) < 0)
return 0;
if (check_stats)
{
mailbox->msg_count = 0;
mailbox->msg_unread = 0;
mailbox->msg_flagged = 0;
}
for (i = mhs.max; i > 0; i--)
{
if (check_stats &&
(mhs_check (&mhs, i) & MH_SEQ_FLAGGED))
mailbox->msg_flagged++;
if (mhs_check (&mhs, i) & MH_SEQ_UNSEEN)
{
if (check_stats)
mailbox->msg_unread++;
if (check_new)
{
/* if the first unseen message we encounter was in the mailbox during the
last visit, don't notify about it */
if (!option(OPTMAILCHECKRECENT) || mh_already_notified(mailbox, i) == 0)
{
mailbox->new = 1;
rc = 1;
}
/* Because we are traversing from high to low, we can stop
* checking for new mail after the first unseen message.
* Whether it resulted in "new mail" or not. */
check_new = 0;
if (!check_stats)
break;
}
}
}
mhs_free_sequences (&mhs);
if (check_stats)
{
if ((dirp = opendir (mutt_b2s (mailbox->pathbuf))) != NULL)
{
while ((de = readdir (dirp)) != NULL)
{
if (*de->d_name == '.')
continue;
if (mh_valid_message (de->d_name))
mailbox->msg_count++;
}
closedir (dirp);
}
}
return rc;
}
static int mh_mkstemp (CONTEXT * dest, FILE ** fp, char **tgt)
{
int fd;
BUFFER *path = NULL;
mode_t omask;
int rc = 0;
path = mutt_buffer_pool_get ();
omask = umask (mh_umask (dest));
FOREVER
{
mutt_buffer_printf (path, "%s/.mutt-%s-%d-%d",
dest->path, NONULL (Hostname), (int) getpid (), Counter++);
if ((fd = open (mutt_b2s (path), O_WRONLY | O_EXCL | O_CREAT, 0666)) == -1)
{
if (errno != EEXIST)
{
mutt_perror (mutt_b2s (path));
umask (omask);
rc = -1;
goto out;
}
}
else
{
*tgt = safe_strdup (mutt_b2s (path));
break;
}
}
umask (omask);
if ((*fp = fdopen (fd, "w")) == NULL)
{
FREE (tgt); /* __FREE_CHECKED__ */
close (fd);
unlink (mutt_b2s (path));
rc = -1;
goto out;
}
out:
mutt_buffer_pool_release (&path);
return rc;
}
static void mhs_write_one_sequence (FILE * fp, struct mh_sequences *mhs,
short f, const char *tag)
{
int i;
int first, last;
fprintf (fp, "%s:", tag);
first = -1;
last = -1;
for (i = 0; i <= mhs->max; i++)
{
if ((mhs_check (mhs, i) & f))
{
if (first < 0)
first = i;
else
last = i;
}
else if (first >= 0)
{
if (last < 0)
fprintf (fp, " %d", first);
else
fprintf (fp, " %d-%d", first, last);
first = -1;
last = -1;
}
}
if (first >= 0)
{
if (last < 0)
fprintf (fp, " %d", first);
else
fprintf (fp, " %d-%d", first, last);
}
fputc ('\n', fp);
}
/* XXX - we don't currently remove deleted messages from sequences we don't know. Should we? */
static void mh_update_sequences (CONTEXT * ctx)
{
FILE *ofp, *nfp;
BUFFER *sequences = NULL;
char *tmpfname;
char *buff = NULL;
char *p;
size_t s;
int l = 0;
int i;
int unseen = 0;
int flagged = 0;
int replied = 0;
char seq_unseen[STRING];
char seq_replied[STRING];
char seq_flagged[STRING];
struct mh_sequences mhs;
memset (&mhs, 0, sizeof (mhs));
snprintf (seq_unseen, sizeof (seq_unseen), "%s:", NONULL (MhUnseen));
snprintf (seq_replied, sizeof (seq_replied), "%s:", NONULL (MhReplied));
snprintf (seq_flagged, sizeof (seq_flagged), "%s:", NONULL (MhFlagged));
if (mh_mkstemp (ctx, &nfp, &tmpfname) != 0)
{
/* error message? */
return;
}
sequences = mutt_buffer_pool_get ();
mutt_buffer_printf (sequences, "%s/.mh_sequences", ctx->path);
/* first, copy unknown sequences */
if ((ofp = fopen (mutt_b2s (sequences), "r")))
{
while ((buff = mutt_read_line (buff, &s, ofp, &l, 0)))
{
if (!mutt_strncmp (buff, seq_unseen, mutt_strlen (seq_unseen)))
continue;
if (!mutt_strncmp (buff, seq_flagged, mutt_strlen (seq_flagged)))
continue;
if (!mutt_strncmp (buff, seq_replied, mutt_strlen (seq_replied)))
continue;
fprintf (nfp, "%s\n", buff);
}
}
safe_fclose (&ofp);
/* now, update our unseen, flagged, and replied sequences */
for (l = 0; l < ctx->msgcount; l++)
{
if (ctx->hdrs[l]->deleted)
continue;
if ((p = strrchr (ctx->hdrs[l]->path, '/')))
p++;
else
p = ctx->hdrs[l]->path;
if (mutt_atoi (p, &i, 0) < 0)
continue;
if (!ctx->hdrs[l]->read)
{
mhs_set (&mhs, i, MH_SEQ_UNSEEN);
unseen++;
}
if (ctx->hdrs[l]->flagged)
{
mhs_set (&mhs, i, MH_SEQ_FLAGGED);
flagged++;
}
if (ctx->hdrs[l]->replied)
{
mhs_set (&mhs, i, MH_SEQ_REPLIED);
replied++;
}
}
/* write out the new sequences */
if (unseen)
mhs_write_one_sequence (nfp, &mhs, MH_SEQ_UNSEEN, NONULL (MhUnseen));
if (flagged)
mhs_write_one_sequence (nfp, &mhs, MH_SEQ_FLAGGED, NONULL (MhFlagged));
if (replied)
mhs_write_one_sequence (nfp, &mhs, MH_SEQ_REPLIED, NONULL (MhReplied));
mhs_free_sequences (&mhs);
/* try to commit the changes - no guarantee here */
safe_fclose (&nfp);
unlink (mutt_b2s (sequences));
if (safe_rename (tmpfname, mutt_b2s (sequences)) != 0)
{
/* report an error? */
unlink (tmpfname);
}
mutt_buffer_pool_release (&sequences);
FREE (&tmpfname);
}
static void mh_sequences_add_one (CONTEXT * ctx, int n, short unseen,
short flagged, short replied)
{
short unseen_done = 0;
short flagged_done = 0;
short replied_done = 0;
FILE *ofp = NULL, *nfp = NULL;
char *tmpfname;
BUFFER *sequences = NULL;
char seq_unseen[STRING];
char seq_replied[STRING];
char seq_flagged[STRING];
char *buff = NULL;
int line;
size_t sz;
if (mh_mkstemp (ctx, &nfp, &tmpfname) == -1)
return;
snprintf (seq_unseen, sizeof (seq_unseen), "%s:", NONULL (MhUnseen));
snprintf (seq_replied, sizeof (seq_replied), "%s:", NONULL (MhReplied));
snprintf (seq_flagged, sizeof (seq_flagged), "%s:", NONULL (MhFlagged));
sequences = mutt_buffer_pool_get ();
mutt_buffer_printf (sequences, "%s/.mh_sequences", ctx->path);
if ((ofp = fopen (mutt_b2s (sequences), "r")))
{
while ((buff = mutt_read_line (buff, &sz, ofp, &line, 0)))
{
if (unseen && !strncmp (buff, seq_unseen, mutt_strlen (seq_unseen)))
{
fprintf (nfp, "%s %d\n", buff, n);
unseen_done = 1;
}
else if (flagged
&& !strncmp (buff, seq_flagged, mutt_strlen (seq_flagged)))
{
fprintf (nfp, "%s %d\n", buff, n);
flagged_done = 1;
}
else if (replied
&& !strncmp (buff, seq_replied, mutt_strlen (seq_replied)))
{
fprintf (nfp, "%s %d\n", buff, n);
replied_done = 1;
}
else
fprintf (nfp, "%s\n", buff);
}
}
safe_fclose (&ofp);
FREE (&buff);
if (!unseen_done && unseen)
fprintf (nfp, "%s: %d\n", NONULL (MhUnseen), n);
if (!flagged_done && flagged)
fprintf (nfp, "%s: %d\n", NONULL (MhFlagged), n);
if (!replied_done && replied)
fprintf (nfp, "%s: %d\n", NONULL (MhReplied), n);
safe_fclose (&nfp);
unlink (mutt_b2s (sequences));
if (safe_rename (tmpfname, mutt_b2s (sequences)) != 0)
unlink (tmpfname);
mutt_buffer_pool_release (&sequences);
FREE (&tmpfname);
}
static void mh_update_maildir (struct maildir *md, struct mh_sequences *mhs)
{
int i;
short f;
char *p;
for (; md; md = md->next)
{
if ((p = strrchr (md->h->path, '/')))
p++;
else
p = md->h->path;
if (mutt_atoi (p, &i, 0) < 0)
continue;
f = mhs_check (mhs, i);
md->h->read = (f & MH_SEQ_UNSEEN) ? 0 : 1;
md->h->flagged = (f & MH_SEQ_FLAGGED) ? 1 : 0;
md->h->replied = (f & MH_SEQ_REPLIED) ? 1 : 0;
}
}
/* maildir support */
static void maildir_free_entry (struct maildir **md)
{
if (!md || !*md)
return;
FREE (&(*md)->canon_fname);
if ((*md)->h)
mutt_free_header (&(*md)->h);
FREE (md); /* __FREE_CHECKED__ */
}
static void maildir_free_maildir (struct maildir **md)
{
struct maildir *p, *q;
if (!md || !*md)
return;
for (p = *md; p; p = q)
{
q = p->next;
maildir_free_entry (&p);
}
}
static void maildir_parse_flags (HEADER * h, const char *path)
{
char *p, *q = NULL;
h->flagged = 0;
h->read = 0;
h->replied = 0;
if ((p = strrchr (path, ':')) != NULL && mutt_strncmp (p + 1, "2,", 2) == 0)
{
p += 3;
mutt_str_replace (&h->maildir_flags, p);
q = h->maildir_flags;
while (*p)
{
switch (*p)
{
case 'F':
h->flagged = 1;
break;
case 'S': /* seen */
h->read = 1;
break;
case 'R': /* replied */
h->replied = 1;
break;
case 'T': /* trashed */
if (!h->flagged || !option(OPTFLAGSAFE))
{
h->trash = 1;
h->deleted = 1;
}
break;
default:
*q++ = *p;
break;
}
p++;
}
}
if (q == h->maildir_flags)
FREE (&h->maildir_flags);
else if (q)
*q = '\0';
}
static void maildir_update_mtime (CONTEXT * ctx)
{
BUFFER *buf = NULL;
struct stat st;
struct mh_data *data = mh_data (ctx);
buf = mutt_buffer_pool_get ();
if (ctx->magic == MUTT_MAILDIR)
{
mutt_buffer_printf (buf, "%s/%s", ctx->path, "cur");
if (stat (mutt_b2s (buf), &st) == 0)
mutt_get_stat_timespec (&data->mtime_cur, &st, MUTT_STAT_MTIME);
mutt_buffer_printf (buf, "%s/%s", ctx->path, "new");
}
else
{
mutt_buffer_printf (buf, "%s/.mh_sequences", ctx->path);
if (stat (mutt_b2s (buf), &st) == 0)
mutt_get_stat_timespec (&data->mtime_cur, &st, MUTT_STAT_MTIME);
mutt_buffer_strcpy (buf, ctx->path);
}
if (stat (mutt_b2s (buf), &st) == 0)
mutt_get_stat_timespec (&ctx->mtime, &st, MUTT_STAT_MTIME);
mutt_buffer_pool_release (&buf);
}
/*
* Actually parse a maildir message. This may also be used to fill
* out a fake header structure generated by lazy maildir parsing.
*/
static HEADER *maildir_parse_message (int magic, const char *fname,
int is_old, HEADER * _h)
{
FILE *f;
HEADER *h = _h;
struct stat st;
if ((f = fopen (fname, "r")) != NULL)
{
if (!h)
h = mutt_new_header ();
h->env = mutt_read_rfc822_header (f, h, 0, 0);
fstat (fileno (f), &st);
safe_fclose (&f);
if (!h->received)
h->received = h->date_sent;
/* always update the length since we have fresh information available. */
h->content->length = st.st_size - h->content->offset;
h->index = -1;
if (magic == MUTT_MAILDIR)
{
/*
* maildir stores its flags in the filename, so ignore the
* flags in the header of the message
*/
h->old = is_old;
maildir_parse_flags (h, fname);
}
return h;
}
return NULL;
}
/* Ignore the garbage files. A valid MH message consists of only
* digits. Deleted message get moved to a filename with a comma before
* it.
*/
int mh_valid_message (const char *s)
{
for (; *s; s++)
{
if (!isdigit ((unsigned char) *s))
return 0;
}
return 1;
}
static int maildir_parse_dir (CONTEXT * ctx, struct maildir ***last,
const char *subdir, int *count,
progress_t *progress)
{
DIR *dirp;
struct dirent *de;
BUFFER *buf = NULL;
int rc = 0, is_old = 0;
struct maildir *entry;
HEADER *h;
buf = mutt_buffer_pool_get ();
if (subdir)
{
mutt_buffer_printf (buf, "%s/%s", ctx->path, subdir);
is_old = (mutt_strcmp ("cur", subdir) == 0);
}
else
mutt_buffer_strcpy (buf, ctx->path);
if ((dirp = opendir (mutt_b2s (buf))) == NULL)
{
rc = -1;
goto cleanup;
}
while ((de = readdir (dirp)) != NULL)
{
if ((ctx->magic == MUTT_MH && !mh_valid_message (de->d_name))
|| (ctx->magic == MUTT_MAILDIR && *de->d_name == '.'))
continue;
/* FOO - really ignore the return value? */
dprint (2,
(debugfile, "%s:%d: queueing %s\n", __FILE__, __LINE__,
de->d_name));
h = mutt_new_header ();
h->old = is_old;
if (ctx->magic == MUTT_MAILDIR)
maildir_parse_flags (h, de->d_name);
if (count)
{
(*count)++;
if (!ctx->quiet && progress)
mutt_progress_update (progress, *count, -1);
}
if (subdir)
{
mutt_buffer_printf (buf, "%s/%s", subdir, de->d_name);
h->path = safe_strdup (mutt_b2s (buf));
}
else
h->path = safe_strdup (de->d_name);
entry = safe_calloc (sizeof (struct maildir), 1);
entry->h = h;
#ifdef HAVE_DIRENT_D_INO
entry->inode = de->d_ino;
#endif /* HAVE_DIRENT_D_INO */
**last = entry;
*last = &entry->next;
}
closedir (dirp);
cleanup:
mutt_buffer_pool_release (&buf);
return rc;
}
static int maildir_add_to_context (CONTEXT * ctx, struct maildir *md)
{
int oldmsgcount = ctx->msgcount;
while (md)
{
dprint (2, (debugfile, "%s:%d maildir_add_to_context(): Considering %s\n",
__FILE__, __LINE__, NONULL (md->canon_fname)));
if (md->h)
{
dprint (2,
(debugfile,
"%s:%d Adding header structure. Flags: %s%s%s%s%s\n", __FILE__,
__LINE__, md->h->flagged ? "f" : "", md->h->deleted ? "D" : "",
md->h->replied ? "r" : "", md->h->old ? "O" : "",
md->h->read ? "R" : ""));
if (ctx->msgcount == ctx->hdrmax)
mx_alloc_memory (ctx);
ctx->hdrs[ctx->msgcount] = md->h;
ctx->hdrs[ctx->msgcount]->index = ctx->msgcount;
ctx->size +=
md->h->content->length + md->h->content->offset -
md->h->content->hdr_offset;
md->h = NULL;
ctx->msgcount++;
}
md = md->next;
}
if (ctx->msgcount > oldmsgcount)
{
mx_update_context (ctx, ctx->msgcount - oldmsgcount);
return 1;
}
return 0;
}
static int maildir_move_to_context (CONTEXT * ctx, struct maildir **md)
{
int r;
r = maildir_add_to_context (ctx, *md);
maildir_free_maildir (md);
return r;
}
#if USE_HCACHE
static size_t maildir_hcache_keylen (const char *fn)
{
const char * p = strrchr (fn, ':');
return p ? (size_t) (p - fn) : mutt_strlen(fn);
}
#endif
#if HAVE_DIRENT_D_INO
static int md_cmp_inode (struct maildir *a, struct maildir *b)
{
return a->inode - b->inode;
}
#endif
static int md_cmp_path (struct maildir *a, struct maildir *b)
{
return strcmp (a->h->path, b->h->path);
}
/*
* Merge two maildir lists according to the inode numbers.
*/
static struct maildir* maildir_merge_lists (struct maildir *left,
struct maildir *right,
int (*cmp) (struct maildir *,
struct maildir *))
{
struct maildir* head;
struct maildir* tail;
if (left && right)
{
if (cmp (left, right) < 0)
{
head = left;
left = left->next;
}
else
{
head = right;
right = right->next;
}
}
else
{
if (left)
return left;
else
return right;
}
tail = head;
while (left && right)
{
if (cmp (left, right) < 0)
{
tail->next = left;
left = left->next;
}
else
{
tail->next = right;
right = right->next;
}
tail = tail->next;
}
if (left)
{
tail->next = left;
}
else
{
tail->next = right;
}
return head;
}
static struct maildir* maildir_ins_sort (struct maildir* list,
int (*cmp) (struct maildir *,
struct maildir *))
{
struct maildir *tmp, *last, *ret = NULL, *back;
ret = list;
list = list->next;
ret->next = NULL;
while (list)
{
last = NULL;
back = list->next;
for (tmp = ret; tmp && cmp (tmp, list) <= 0; tmp = tmp->next)
last = tmp;
list->next = tmp;
if (last)
last->next = list;
else
ret = list;
list = back;
}
return ret;
}
/*
* Sort maildir list according to inode.
*/
static struct maildir* maildir_sort (struct maildir* list, size_t len,
int (*cmp) (struct maildir *,
struct maildir *))
{
struct maildir* left = list;
struct maildir* right = list;
size_t c = 0;
if (!list || !list->next)
{
return list;
}
if (len != (size_t)(-1) && len <= INS_SORT_THRESHOLD)
return maildir_ins_sort (list, cmp);
list = list->next;
while (list && list->next)
{
right = right->next;
list = list->next->next;
c++;
}
list = right;
right = right->next;
list->next = 0;
left = maildir_sort (left, c, cmp);
right = maildir_sort (right, c, cmp);
return maildir_merge_lists (left, right, cmp);
}
/* Sorts mailbox into it's natural order.
* Currently only defined for MH where files are numbered.
*/
static void mh_sort_natural (CONTEXT *ctx, struct maildir **md)
{
if (!ctx || !md || !*md || ctx->magic != MUTT_MH || Sort != SORT_ORDER)
return;
dprint (4, (debugfile, "maildir: sorting %s into natural order\n",
ctx->path));
*md = maildir_sort (*md, (size_t) -1, md_cmp_path);
}
#if HAVE_DIRENT_D_INO
static struct maildir *skip_duplicates (struct maildir *p, struct maildir **last)
{
/*
* Skip ahead to the next non-duplicate message.
*
* p should never reach NULL, because we couldn't have reached this point unless
* there was a message that needed to be parsed.
*
* the check for p->header_parsed is likely unnecessary since the dupes will most
* likely be at the head of the list. but it is present for consistency with
* the check at the top of the for() loop in maildir_delayed_parsing().
*/
while (!p->h || p->header_parsed)
{
*last = p;
p = p->next;
}
return p;
}
#endif
/*
* This function does the second parsing pass
*/
static void maildir_delayed_parsing (CONTEXT * ctx, struct maildir **md,
progress_t *progress)
{
struct maildir *p, *last = NULL;
BUFFER *fn = NULL;
int count;
#if HAVE_DIRENT_D_INO
int sort = 0;
#endif
#if USE_HCACHE
header_cache_t *hc = NULL;
void *data;
struct timeval when;
struct stat lastchanged;
int ret;
#endif
#if HAVE_DIRENT_D_INO
#define DO_SORT() \
do \
{ \
if (!sort) \
{ \
dprint (4, (debugfile, "maildir: need to sort %s by inode\n", ctx->path)); \
p = maildir_sort (p, (size_t) -1, md_cmp_inode); \
if (!last) \
*md = p; \
else \
last->next = p; \
sort = 1; \
p = skip_duplicates (p, &last); \
mutt_buffer_printf (fn, "%s/%s", ctx->path, p->h->path); \
} \
} while (0)
#else
#define DO_SORT() /* nothing */
#endif
#if USE_HCACHE
hc = mutt_hcache_open (HeaderCache, ctx->path, NULL);
#endif
fn = mutt_buffer_pool_get ();
for (p = *md, count = 0; p; p = p->next, count++)
{
if (! (p && p->h && !p->header_parsed))
{
last = p;
continue;
}
if (!ctx->quiet && progress)
mutt_progress_update (progress, count, -1);
DO_SORT();
mutt_buffer_printf (fn, "%s/%s", ctx->path, p->h->path);
#if USE_HCACHE
if (option(OPTHCACHEVERIFY))
{
ret = stat(mutt_b2s (fn), &lastchanged);
}
else
{
lastchanged.st_mtime = 0;
ret = 0;
}
if (ctx->magic == MUTT_MH)
data = mutt_hcache_fetch (hc, p->h->path, strlen);
else
data = mutt_hcache_fetch (hc, p->h->path + 3, &maildir_hcache_keylen);
if (data)
memcpy (&when, data, sizeof(struct timeval));
if (data != NULL && !ret && lastchanged.st_mtime <= when.tv_sec)
{
p->h = mutt_hcache_restore ((unsigned char *)data, &p->h);
if (ctx->magic == MUTT_MAILDIR)
maildir_parse_flags (p->h, mutt_b2s (fn));
}
else
{
#endif /* USE_HCACHE */
if (maildir_parse_message (ctx->magic, mutt_b2s (fn), p->h->old, p->h))
{
p->header_parsed = 1;
#if USE_HCACHE
if (ctx->magic == MUTT_MH)
mutt_hcache_store (hc, p->h->path, p->h, 0, strlen, MUTT_GENERATE_UIDVALIDITY);
else
mutt_hcache_store (hc, p->h->path + 3, p->h, 0, &maildir_hcache_keylen, MUTT_GENERATE_UIDVALIDITY);
#endif
}
else
mutt_free_header (&p->h);
#if USE_HCACHE
}
mutt_hcache_free (&data);
#endif
last = p;
}
#if USE_HCACHE
mutt_hcache_close (hc);
#endif
mutt_buffer_pool_release (&fn);
#undef DO_SORT
mh_sort_natural (ctx, md);
}
static int mh_close_mailbox (CONTEXT *ctx)
{
FREE (&ctx->data);
return 0;
}
/* Read a MH/maildir style mailbox.
*
* args:
* ctx [IN/OUT] context for this mailbox
* subdir [IN] NULL for MH mailboxes, otherwise the subdir of the
* maildir mailbox to read from
*/
static int mh_read_dir (CONTEXT * ctx, const char *subdir)
{
struct maildir *md;
struct mh_sequences mhs;
struct maildir **last;
struct mh_data *data;
int count;
char msgbuf[STRING];
progress_t progress;
size_t pathlen;
/* Clean up the path */
pathlen = mutt_strlen (ctx->path);
while ((pathlen > 1) && ctx->path[pathlen - 1] == '/')
ctx->path[--pathlen] = '\0';
memset (&mhs, 0, sizeof (mhs));
if (!ctx->quiet)
{
snprintf (msgbuf, sizeof (msgbuf), _("Scanning %s..."), ctx->path);
mutt_progress_init (&progress, msgbuf, MUTT_PROGRESS_MSG, ReadInc, 0);
}
if (!ctx->data)
{
ctx->data = safe_calloc(sizeof (struct mh_data), 1);
}
data = mh_data (ctx);
maildir_update_mtime (ctx);
md = NULL;
last = &md;
count = 0;
if (maildir_parse_dir (ctx, &last, subdir, &count, &progress) == -1)
return -1;
if (!ctx->quiet)
{
snprintf (msgbuf, sizeof (msgbuf), _("Reading %s..."), ctx->path);
mutt_progress_init (&progress, msgbuf, MUTT_PROGRESS_MSG, ReadInc, count);
}
maildir_delayed_parsing (ctx, &md, &progress);
if (ctx->magic == MUTT_MH)
{
if (mh_read_sequences (&mhs, ctx->path) < 0)
{
maildir_free_maildir (&md);
return -1;
}
mh_update_maildir (md, &mhs);
mhs_free_sequences (&mhs);
}
maildir_move_to_context (ctx, &md);
if (!data->mh_umask)
data->mh_umask = mh_umask (ctx);
return 0;
}
/* read a maildir style mailbox */
static int maildir_read_dir (CONTEXT * ctx)
{
/* maildir looks sort of like MH, except that there are two subdirectories
* of the main folder path from which to read messages
*/
if (mh_read_dir (ctx, "new") == -1 || mh_read_dir (ctx, "cur") == -1)
return (-1);
return 0;
}
static int maildir_open_mailbox (CONTEXT *ctx)
{
return maildir_read_dir (ctx);
}
static int maildir_open_mailbox_append (CONTEXT *ctx, int flags)
{
BUFFER *tmp = NULL;
int rc = -1;
tmp = mutt_buffer_pool_get ();
if (flags & MUTT_APPENDNEW)
{
if (mkdir (ctx->path, S_IRWXU))
{
mutt_perror (ctx->path);
goto out;
}
mutt_buffer_printf (tmp, "%s/cur", ctx->path);
if (mkdir (mutt_b2s (tmp), S_IRWXU))
{
mutt_perror (mutt_b2s (tmp));
rmdir (ctx->path);
goto out;
}
mutt_buffer_printf (tmp, "%s/new", ctx->path);
if (mkdir (mutt_b2s (tmp), S_IRWXU))
{
mutt_perror (mutt_b2s (tmp));
mutt_buffer_printf (tmp, "%s/cur", ctx->path);
rmdir (mutt_b2s (tmp));
rmdir (ctx->path);
goto out;
}
mutt_buffer_printf (tmp, "%s/tmp", ctx->path);
if (mkdir (mutt_b2s (tmp), S_IRWXU))
{
mutt_perror (mutt_b2s (tmp));
mutt_buffer_printf (tmp, "%s/cur", ctx->path);
rmdir (mutt_b2s (tmp));
mutt_buffer_printf (tmp, "%s/new", ctx->path);
rmdir (mutt_b2s (tmp));
rmdir (ctx->path);
goto out;
}
}
rc = 0;
out:
mutt_buffer_pool_release (&tmp);
return rc;
}
static int mh_open_mailbox (CONTEXT *ctx)
{
return mh_read_dir (ctx, NULL);
}
static int mh_open_mailbox_append (CONTEXT *ctx, int flags)
{
BUFFER *tmp = NULL;
int i;
if (flags & MUTT_APPENDNEW)
{
if (mkdir (ctx->path, S_IRWXU))
{
mutt_perror (ctx->path);
return (-1);
}
tmp = mutt_buffer_pool_get ();
mutt_buffer_printf (tmp, "%s/.mh_sequences", ctx->path);
if ((i = creat (mutt_b2s (tmp), S_IRWXU)) == -1)
{
mutt_perror (mutt_b2s (tmp));
rmdir (ctx->path);
mutt_buffer_pool_release (&tmp);
return (-1);
}
close (i);
mutt_buffer_pool_release (&tmp);
}
return 0;
}
/*
* Open a new (temporary) message in an MH folder.
*/
static int mh_open_new_message (MESSAGE * msg, CONTEXT * dest, HEADER * hdr)
{
return mh_mkstemp (dest, &msg->fp, &msg->path);
}
static int ch_compar (const void *a, const void *b)
{
return (int)( *((const char *) a) - *((const char *) b));
}
static void maildir_flags (char *dest, size_t destlen, HEADER * hdr)
{
*dest = '\0';
/*
* The maildir specification requires that all files in the cur
* subdirectory have the :unique string appended, regardless of whether
* or not there are any flags. If .old is set, we know that this message
* will end up in the cur directory, so we include it in the following
* test even though there is no associated flag.
*/
if (hdr && (hdr->flagged || hdr->replied || hdr->read || hdr->deleted || hdr->old || hdr->maildir_flags))
{
char tmp[LONG_STRING];
snprintf (tmp, sizeof (tmp),
"%s%s%s%s%s",
hdr->flagged ? "F" : "",
hdr->replied ? "R" : "",
hdr->read ? "S" : "", hdr->deleted ? "T" : "",
NONULL(hdr->maildir_flags));
if (hdr->maildir_flags)
qsort (tmp, strlen (tmp), 1, ch_compar);
snprintf (dest, destlen, ":2,%s", tmp);
}
}
static int maildir_mh_open_message (CONTEXT *ctx, MESSAGE *msg, int msgno,
int is_maildir)
{
HEADER *cur = ctx->hdrs[msgno];
BUFFER *path = NULL;
int rc = 0;
path = mutt_buffer_pool_get ();
mutt_buffer_printf (path, "%s/%s", ctx->path, cur->path);
msg->fp = fopen (mutt_b2s (path), "r");
if (msg->fp == NULL && errno == ENOENT && is_maildir)
msg->fp = maildir_open_find_message (ctx->path, cur->path);
if (!msg->fp)
{
mutt_perror (mutt_b2s (path));
dprint (1, (debugfile, "maildir_mh_open_message: fopen: %s: %s (errno %d).\n",
mutt_b2s (path), strerror (errno), errno));
rc = -1;
}
mutt_buffer_pool_release (&path);
return rc;
}
static int maildir_open_message (CONTEXT *ctx, MESSAGE *msg, int msgno, int headers)
{
return maildir_mh_open_message (ctx, msg, msgno, 1);
}
static int mh_open_message (CONTEXT *ctx, MESSAGE *msg, int msgno, int headers)
{
return maildir_mh_open_message (ctx, msg, msgno, 0);
}
static int mh_close_message (CONTEXT *ctx, MESSAGE *msg)
{
return safe_fclose (&msg->fp);
}
/*
* Open a new (temporary) message in a maildir folder.
*
* Note that this uses _almost_ the maildir file name format, but
* with a {cur,new} prefix.
*
*/
static int maildir_open_new_message (MESSAGE * msg, CONTEXT * dest, HEADER * hdr)
{
int fd, rc = 0;
BUFFER *path = NULL;
char suffix[16];
char subdir[16];
mode_t omask;
path = mutt_buffer_pool_get ();
if (hdr)
{
short deleted = hdr->deleted;
hdr->deleted = 0;
maildir_flags (suffix, sizeof (suffix), hdr);
hdr->deleted = deleted;
}
else
*suffix = '\0';
if (hdr && (hdr->read || hdr->old))
strfcpy (subdir, "cur", sizeof (subdir));
else
strfcpy (subdir, "new", sizeof (subdir));
omask = umask (mh_umask (dest));
FOREVER
{
mutt_buffer_printf (path, "%s/tmp/%s.%lld.%u_%d.%s%s",
dest->path, subdir, (long long)time (NULL), (unsigned int)getpid (),
Counter++, NONULL (Hostname), suffix);
dprint (2, (debugfile, "maildir_open_new_message (): Trying %s.\n",
mutt_b2s (path)));
if ((fd = open (mutt_b2s (path), O_WRONLY | O_EXCL | O_CREAT, 0666)) == -1)
{
if (errno != EEXIST)
{
umask (omask);
mutt_perror (mutt_b2s (path));
rc = -1;
goto out;
}
}
else
{
dprint (2, (debugfile, "maildir_open_new_message (): Success.\n"));
msg->path = safe_strdup (mutt_b2s (path));
break;
}
}
umask (omask);
if ((msg->fp = fdopen (fd, "w")) == NULL)
{
FREE (&msg->path);
close (fd);
unlink (mutt_b2s (path));
rc = -1;
goto out;
}
out:
mutt_buffer_pool_release (&path);
return rc;
}
/*
* Commit a message to a maildir folder.
*
* msg->path contains the file name of a file in tmp/. We take the
* flags from this file's name.
*
* ctx is the mail folder we commit to.
*
* hdr is a header structure to which we write the message's new
* file name. This is used in the mh and maildir folder synch
* routines. When this routine is invoked from mx_commit_message,
* hdr is NULL.
*
* msg->path looks like this:
*
* tmp/{cur,new}.mutt-HOSTNAME-PID-COUNTER:flags
*
* See also maildir_open_new_message().
*
*/
static int _maildir_commit_message (CONTEXT * ctx, MESSAGE * msg, HEADER * hdr)
{
char subdir[4];
char suffix[16];
int rc = 0;
BUFFER *path = NULL, *full = NULL;
char *s;
if (safe_fsync_close (&msg->fp))
{
mutt_perror (_("Could not flush message to disk"));
return -1;
}
/* extract the subdir */
s = strrchr (msg->path, '/') + 1;
strfcpy (subdir, s, 4);
/* extract the flags */
if ((s = strchr (s, ':')))
strfcpy (suffix, s, sizeof (suffix));
else
suffix[0] = '\0';
/* construct a new file name. */
path = mutt_buffer_pool_get ();
full = mutt_buffer_pool_get ();
FOREVER
{
mutt_buffer_printf (path, "%s/%lld.%u_%d.%s%s", subdir,
(long long)time (NULL), (unsigned int)getpid (), Counter++,
NONULL (Hostname), suffix);
mutt_buffer_printf (full, "%s/%s", ctx->path, mutt_b2s (path));
dprint (2, (debugfile, "_maildir_commit_message (): renaming %s to %s.\n",
msg->path, mutt_b2s (full)));
if (safe_rename (msg->path, mutt_b2s (full)) == 0)
{
if (hdr)
mutt_str_replace (&hdr->path, mutt_b2s (path));
FREE (&msg->path);
/*
* Adjust the mtime on the file to match the time at which this
* message was received. Currently this is only set when copying
* messages between mailboxes, so we test to ensure that it is
* actually set.
*/
if (msg->received)
{
struct utimbuf ut;
int utime_rc;
ut.actime = msg->received;
ut.modtime = msg->received;
do
utime_rc = utime (mutt_b2s (full), &ut);
while (utime_rc == -1 && errno == EINTR);
if (utime_rc == -1)
{
mutt_perror (_("_maildir_commit_message(): unable to set time on file"));
rc = -1;
}
}
goto cleanup;
}
else if (errno != EEXIST)
{
mutt_perror (ctx->path);
rc = -1;
goto cleanup;
}
}
cleanup:
mutt_buffer_pool_release (&path);
mutt_buffer_pool_release (&full);
return rc;
}
static int maildir_commit_message (CONTEXT * ctx, MESSAGE * msg)
{
return _maildir_commit_message (ctx, msg, NULL);
}
/*
* commit a message to an MH folder.
*
*/
static int _mh_commit_message (CONTEXT * ctx, MESSAGE * msg, HEADER * hdr,
short updseq)
{
DIR *dirp;
struct dirent *de;
char *cp, *dep;
unsigned int n, hi = 0;
BUFFER *path = NULL;
char tmp[16];
int rc = 0;
if (safe_fsync_close (&msg->fp))
{
mutt_perror (_("Could not flush message to disk"));
return -1;
}
if ((dirp = opendir (ctx->path)) == NULL)
{
mutt_perror (ctx->path);
return (-1);
}
/* figure out what the next message number is */
while ((de = readdir (dirp)) != NULL)
{
dep = de->d_name;
if (*dep == ',')
dep++;
cp = dep;
while (*cp)
{
if (!isdigit ((unsigned char) *cp))
break;
cp++;
}
if (!*cp)
{
n = atoi (dep);
if (n > hi)
hi = n;
}
}
closedir (dirp);
/*
* Now try to rename the file to the proper name.
*
* Note: We may have to try multiple times, until we find a free
* slot.
*/
path = mutt_buffer_pool_get ();
FOREVER
{
hi++;
snprintf (tmp, sizeof (tmp), "%d", hi);
mutt_buffer_printf (path, "%s/%s", ctx->path, tmp);
if (safe_rename (msg->path, mutt_b2s (path)) == 0)
{
if (hdr)
mutt_str_replace (&hdr->path, tmp);
FREE (&msg->path);
break;
}
else if (errno != EEXIST)
{
mutt_perror (ctx->path);
rc = -1;
goto out;
}
}
if (updseq)
mh_sequences_add_one (ctx, hi, !msg->flags.read, msg->flags.flagged,
msg->flags.replied);
out:
mutt_buffer_pool_release (&path);
return rc;
}
static int mh_commit_message (CONTEXT * ctx, MESSAGE * msg)
{
return _mh_commit_message (ctx, msg, NULL, 1);
}
/* Sync a message in an MH folder.
*
* This code is also used for attachment deletion in maildir
* folders.
*/
static int mh_rewrite_message (CONTEXT * ctx, int msgno)
{
HEADER *h = ctx->hdrs[msgno];
MESSAGE *dest;
int rc;
short restore = 1;
BUFFER *oldpath = NULL;
BUFFER *newpath = NULL;
BUFFER *partpath = NULL;
LOFF_T old_body_offset = h->content->offset;
LOFF_T old_body_length = h->content->length;
long old_hdr_lines = h->lines;
if ((dest = mx_open_new_message (ctx, h, 0)) == NULL)
return -1;
if ((rc = mutt_copy_message (dest->fp, ctx, h,
MUTT_CM_UPDATE, CH_UPDATE | CH_UPDATE_LEN)) == 0)
{
oldpath = mutt_buffer_pool_get ();
partpath = mutt_buffer_pool_get ();
mutt_buffer_printf (oldpath, "%s/%s", ctx->path, h->path);
mutt_buffer_strcpy (partpath, h->path);
if (ctx->magic == MUTT_MAILDIR)
rc = _maildir_commit_message (ctx, dest, h);
else
rc = _mh_commit_message (ctx, dest, h, 0);
mx_close_message (ctx, &dest);
if (rc == 0)
{
unlink (mutt_b2s (oldpath));
restore = 0;
}
/*
* Try to move the new message to the old place.
* (MH only.)
*
* This is important when we are just updating flags.
*
* Note that there is a race condition against programs which
* use the first free slot instead of the maximum message
* number. Mutt does _not_ behave like this.
*
* Anyway, if this fails, the message is in the folder, so
* all what happens is that a concurrently running mutt will
* lose flag modifications.
*/
if (ctx->magic == MUTT_MH && rc == 0)
{
newpath = mutt_buffer_pool_get ();
mutt_buffer_printf (newpath, "%s/%s", ctx->path, h->path);
if ((rc = safe_rename (mutt_b2s (newpath), mutt_b2s (oldpath))) == 0)
mutt_str_replace (&h->path, mutt_b2s (partpath));
mutt_buffer_pool_release (&newpath);
}
mutt_buffer_pool_release (&oldpath);
mutt_buffer_pool_release (&partpath);
}
else
mx_close_message (ctx, &dest);
if (rc == -1 && restore)
{
h->content->offset = old_body_offset;
h->content->length = old_body_length;
h->lines = old_hdr_lines;
}
mutt_free_body (&h->content->parts);
return rc;
}
static int mh_sync_message (CONTEXT * ctx, int msgno)
{
HEADER *h = ctx->hdrs[msgno];
/* TODO: why the h->env check? */
if (h->attach_del || (h->env && h->env->changed))
{
if (mh_rewrite_message (ctx, msgno) != 0)
return -1;
/* TODO: why the env check? */
if (h->env)
h->env->changed = 0;
}
return 0;
}
static int maildir_sync_message (CONTEXT * ctx, int msgno)
{
HEADER *h = ctx->hdrs[msgno];
BUFFER *newpath = NULL,
*partpath = NULL,
*fullpath = NULL,
*oldpath = NULL;
char suffix[16];
char *p;
int rc = 0;
/* TODO: why the h->env check? */
if (h->attach_del || (h->env && h->env->changed))
{
/* when doing attachment deletion/rethreading, fall back to the MH case. */
if (mh_rewrite_message (ctx, msgno) != 0)
return (-1);
/* TODO: why the env check? */
if (h->env)
h->env->changed = 0;
}
else
{
/* we just have to rename the file. */
if ((p = strrchr (h->path, '/')) == NULL)
{
dprint (1,
(debugfile,
"maildir_sync_message: %s: unable to find subdir!\n",
h->path));
return (-1);
}
p++;
newpath = mutt_buffer_pool_get ();
partpath = mutt_buffer_pool_get ();
fullpath = mutt_buffer_pool_get ();
oldpath = mutt_buffer_pool_get ();
mutt_buffer_strcpy (newpath, p);
/* kill the previous flags. */
if ((p = strchr (newpath->data, ':')) != NULL)
{
*p = 0;
newpath->dptr = p; /* fix buffer up, just to be safe */
}
maildir_flags (suffix, sizeof (suffix), h);
mutt_buffer_printf (partpath, "%s/%s%s",
(h->read || h->old) ? "cur" : "new",
mutt_b2s (newpath), suffix);
mutt_buffer_printf (fullpath, "%s/%s", ctx->path, mutt_b2s (partpath));
mutt_buffer_printf (oldpath, "%s/%s", ctx->path, h->path);
if (mutt_strcmp (mutt_b2s (fullpath), mutt_b2s (oldpath)) == 0)
{
/* message hasn't really changed */
goto cleanup;
}
/* record that the message is possibly marked as trashed on disk */
h->trash = h->deleted;
if (rename (mutt_b2s (oldpath), mutt_b2s (fullpath)) != 0)
{
mutt_perror ("rename");
rc = -1;
goto cleanup;
}
mutt_str_replace (&h->path, mutt_b2s (partpath));
}
cleanup:
mutt_buffer_pool_release (&newpath);
mutt_buffer_pool_release (&partpath);
mutt_buffer_pool_release (&fullpath);
mutt_buffer_pool_release (&oldpath);
return (rc);
}
int mh_sync_mailbox (CONTEXT * ctx, int *index_hint)
{
BUFFER *path = NULL, *tmp = NULL;
int i, j;
#if USE_HCACHE
header_cache_t *hc = NULL;
#endif /* USE_HCACHE */
char msgbuf[STRING];
progress_t progress;
if (ctx->magic == MUTT_MH)
i = mh_check_mailbox (ctx, index_hint);
else
i = maildir_check_mailbox (ctx, index_hint);
if (i != 0)
return i;
#if USE_HCACHE
if (ctx->magic == MUTT_MAILDIR || ctx->magic == MUTT_MH)
hc = mutt_hcache_open(HeaderCache, ctx->path, NULL);
#endif /* USE_HCACHE */
if (!ctx->quiet)
{
snprintf (msgbuf, sizeof (msgbuf), _("Writing %s..."), ctx->path);
mutt_progress_init (&progress, msgbuf, MUTT_PROGRESS_MSG, WriteInc, ctx->msgcount);
}
path = mutt_buffer_pool_get ();
tmp = mutt_buffer_pool_get ();
for (i = 0; i < ctx->msgcount; i++)
{
if (!ctx->quiet)
mutt_progress_update (&progress, i, -1);
if (ctx->hdrs[i]->deleted
&& (ctx->magic != MUTT_MAILDIR || !option (OPTMAILDIRTRASH)))
{
mutt_buffer_printf (path, "%s/%s", ctx->path, ctx->hdrs[i]->path);
if (ctx->magic == MUTT_MAILDIR
|| (option (OPTMHPURGE) && ctx->magic == MUTT_MH))
{
#if USE_HCACHE
if (ctx->magic == MUTT_MAILDIR)
mutt_hcache_delete (hc, ctx->hdrs[i]->path + 3, &maildir_hcache_keylen);
else if (ctx->magic == MUTT_MH)
mutt_hcache_delete (hc, ctx->hdrs[i]->path, strlen);
#endif /* USE_HCACHE */
unlink (mutt_b2s (path));
}
else if (ctx->magic == MUTT_MH)
{
/* MH just moves files out of the way when you delete them */
if (*ctx->hdrs[i]->path != ',')
{
mutt_buffer_printf (tmp, "%s/,%s", ctx->path,
ctx->hdrs[i]->path);
unlink (mutt_b2s (tmp));
rename (mutt_b2s (path), mutt_b2s (tmp));
}
}
}
else if (ctx->hdrs[i]->changed || ctx->hdrs[i]->attach_del ||
(ctx->magic == MUTT_MAILDIR
&& (option (OPTMAILDIRTRASH) || ctx->hdrs[i]->trash)
&& (ctx->hdrs[i]->deleted != ctx->hdrs[i]->trash)))
{
if (ctx->magic == MUTT_MAILDIR)
{
if (maildir_sync_message (ctx, i) == -1)
goto err;
}
else
{
if (mh_sync_message (ctx, i) == -1)
goto err;
}
}
#if USE_HCACHE
if (ctx->hdrs[i]->changed)
{
if (ctx->magic == MUTT_MAILDIR)
mutt_hcache_store (hc, ctx->hdrs[i]->path + 3, ctx->hdrs[i],
0, &maildir_hcache_keylen, MUTT_GENERATE_UIDVALIDITY);
else if (ctx->magic == MUTT_MH)
mutt_hcache_store (hc, ctx->hdrs[i]->path, ctx->hdrs[i], 0, strlen, MUTT_GENERATE_UIDVALIDITY);
}
#endif
}
mutt_buffer_pool_release (&path);
mutt_buffer_pool_release (&tmp);
#if USE_HCACHE
if (ctx->magic == MUTT_MAILDIR || ctx->magic == MUTT_MH)
mutt_hcache_close (hc);
#endif /* USE_HCACHE */
if (ctx->magic == MUTT_MH)
mh_update_sequences (ctx);
/* XXX race condition? */
maildir_update_mtime (ctx);
/* adjust indices */
if (ctx->deleted)
{
for (i = 0, j = 0; i < ctx->msgcount; i++)
{
if (!ctx->hdrs[i]->deleted
|| (ctx->magic == MUTT_MAILDIR && option (OPTMAILDIRTRASH)))
ctx->hdrs[i]->index = j++;
}
}
return 0;
err:
mutt_buffer_pool_release (&path);
mutt_buffer_pool_release (&tmp);
#if USE_HCACHE
if (ctx->magic == MUTT_MAILDIR || ctx->magic == MUTT_MH)
mutt_hcache_close (hc);
#endif /* USE_HCACHE */
return -1;
}
static void maildir_canon_filename (BUFFER *dest, const char *src)
{
char *t, *u;
if ((t = strrchr (src, '/')))
src = t + 1;
mutt_buffer_strcpy (dest, src);
if ((u = strrchr (dest->data, ':')))
{
*u = '\0';
dest->dptr = u;
}
}
static void maildir_update_tables (CONTEXT *ctx, int *index_hint)
{
short old_sort;
int old_count;
int i, j;
if (Sort != SORT_ORDER)
{
old_sort = Sort;
Sort = SORT_ORDER;
mutt_sort_headers (ctx, 1);
Sort = old_sort;
}
old_count = ctx->msgcount;
for (i = 0, j = 0; i < old_count; i++)
{
if (ctx->hdrs[i]->active && index_hint && *index_hint == i)
*index_hint = j;
if (ctx->hdrs[i]->active)
ctx->hdrs[i]->index = j++;
}
mx_update_tables (ctx, 0);
mutt_clear_threads (ctx);
}
static int maildir_update_flags (CONTEXT *ctx, HEADER *o, HEADER *n)
{
/* save the global state here so we can reset it at the
* end of list block if required.
*/
int context_changed = ctx->changed;
int header_changed;
/* user didn't modify this message. alter the flags to match the
* current state on disk. This may not actually do
* anything. mutt_set_flag() will just ignore the call if the status
* bits are already properly set, but it is still faster not to pass
* through it */
if (o->flagged != n->flagged)
mutt_set_flag (ctx, o, MUTT_FLAG, n->flagged);
if (o->replied != n->replied)
mutt_set_flag (ctx, o, MUTT_REPLIED, n->replied);
if (o->read != n->read)
mutt_set_flag (ctx, o, MUTT_READ, n->read);
if (o->old != n->old)
mutt_set_flag (ctx, o, MUTT_OLD, n->old);
/* mutt_set_flag() will set this, but we don't need to
* sync the changes we made because we just updated the
* context to match the current on-disk state of the
* message.
*/
header_changed = o->changed;
o->changed = 0;
/* if the mailbox was not modified before we made these
* changes, unset the changed flag since nothing needs to
* be synchronized.
*/
if (!context_changed)
ctx->changed = 0;
return header_changed;
}
/* This function handles arrival of new mail and reopening of
* maildir folders. The basic idea here is we check to see if either
* the new or cur subdirectories have changed, and if so, we scan them
* for the list of files. We check for newly added messages, and
* then merge the flags messages we already knew about. We don't treat
* either subdirectory differently, as mail could be copied directly into
* the cur directory from another agent.
*/
static int maildir_check_mailbox (CONTEXT * ctx, int *index_hint)
{
struct stat st_new; /* status of the "new" subdirectory */
struct stat st_cur; /* status of the "cur" subdirectory */
BUFFER *buf = NULL;
int changed = 0; /* bitmask representing which subdirectories
have changed. 0x1 = new, 0x2 = cur */
int occult = 0; /* messages were removed from the mailbox */
int have_new = 0; /* messages were added to the mailbox */
int flags_changed = 0; /* message flags were changed in the mailbox */
struct maildir *md; /* list of messages in the mailbox */
struct maildir **last, *p;
int i;
int count = 0;
HASH *fnames; /* hash table for quickly looking up the base filename
for a maildir message */
struct mh_data *data = mh_data (ctx);
/* XXX seems like this check belongs in mx_check_mailbox()
* rather than here.
*/
if (!option (OPTCHECKNEW))
return 0;
buf = mutt_buffer_pool_get ();
mutt_buffer_printf (buf, "%s/new", ctx->path);
if (stat (mutt_b2s (buf), &st_new) == -1)
{
mutt_buffer_pool_release (&buf);
return -1;
}
mutt_buffer_printf (buf, "%s/cur", ctx->path);
if (stat (mutt_b2s (buf), &st_cur) == -1)
{
mutt_buffer_pool_release (&buf);
return -1;
}
/* determine which subdirectories need to be scanned */
if (mutt_stat_timespec_compare (&st_new, MUTT_STAT_MTIME, &ctx->mtime) > 0)
changed = 1;
if (mutt_stat_timespec_compare (&st_cur, MUTT_STAT_MTIME, &data->mtime_cur) > 0)
changed |= 2;
if (!changed)
{
mutt_buffer_pool_release (&buf);
return 0; /* nothing to do */
}
/* Update the modification times on the mailbox.
*
* The monitor code notices changes in the open mailbox too quickly.
* In practice, this sometimes leads to all the new messages not being
* noticed during the SAME group of mtime stat updates. To work around
* the problem, don't update the stat times for a monitor caused check. */
#ifdef USE_INOTIFY
if (MonitorContextChanged)
MonitorContextChanged = 0;
else
#endif
{
mutt_get_stat_timespec (&data->mtime_cur, &st_cur, MUTT_STAT_MTIME);
mutt_get_stat_timespec (&ctx->mtime, &st_new, MUTT_STAT_MTIME);
}
/* do a fast scan of just the filenames in
* the subdirectories that have changed.
*/
md = NULL;
last = &md;
if (changed & 1)
maildir_parse_dir (ctx, &last, "new", &count, NULL);
if (changed & 2)
maildir_parse_dir (ctx, &last, "cur", &count, NULL);
/* we create a hash table keyed off the canonical (sans flags) filename
* of each message we scanned. This is used in the loop over the
* existing messages below to do some correlation.
*/
fnames = hash_create (count, 0);
for (p = md; p; p = p->next)
{
maildir_canon_filename (buf, p->h->path);
p->canon_fname = safe_strdup (mutt_b2s (buf));
hash_insert (fnames, p->canon_fname, p);
}
/* check for modifications and adjust flags */
for (i = 0; i < ctx->msgcount; i++)
{
ctx->hdrs[i]->active = 0;
maildir_canon_filename (buf, ctx->hdrs[i]->path);
p = hash_find (fnames, mutt_b2s (buf));
if (p && p->h)
{
/* message already exists, merge flags */
ctx->hdrs[i]->active = 1;
/* check to see if the message has moved to a different
* subdirectory. If so, update the associated filename.
*/
if (mutt_strcmp (ctx->hdrs[i]->path, p->h->path))
mutt_str_replace (&ctx->hdrs[i]->path, p->h->path);
/* if the user hasn't modified the flags on this message, update
* the flags we just detected.
*/
if (!ctx->hdrs[i]->changed)
if (maildir_update_flags (ctx, ctx->hdrs[i], p->h))
flags_changed = 1;
if (ctx->hdrs[i]->deleted == ctx->hdrs[i]->trash)
if (ctx->hdrs[i]->deleted != p->h->deleted)
{
ctx->hdrs[i]->deleted = p->h->deleted;
if (ctx->hdrs[i]->deleted)
ctx->deleted++;
else
ctx->deleted--;
flags_changed = 1;
}
if (ctx->hdrs[i]->trash != p->h->trash)
{
ctx->hdrs[i]->trash = p->h->trash;
if (ctx->hdrs[i]->trash)
ctx->trashed++;
else
ctx->trashed--;
}
/* this is a duplicate of an existing header, so remove it */
mutt_free_header (&p->h);
}
/* This message was not in the list of messages we just scanned.
* Check to see if we have enough information to know if the
* message has disappeared out from underneath us.
*/
else if (((changed & 1) && (!strncmp (ctx->hdrs[i]->path, "new/", 4))) ||
((changed & 2) && (!strncmp (ctx->hdrs[i]->path, "cur/", 4))))
{
/* This message disappeared, so we need to simulate a "reopen"
* event. We know it disappeared because we just scanned the
* subdirectory it used to reside in.
*/
occult = 1;
}
else
{
/* This message resides in a subdirectory which was not
* modified, so we assume that it is still present and
* unchanged.
*/
ctx->hdrs[i]->active = 1;
}
}
/* destroy the file name hash */
hash_destroy (&fnames, NULL);
/* If we didn't just get new mail, update the tables. */
if (occult)
maildir_update_tables (ctx, index_hint);
/* do any delayed parsing we need to do. */
maildir_delayed_parsing (ctx, &md, NULL);
/* Incorporate new messages */
have_new = maildir_move_to_context (ctx, &md);
mutt_buffer_pool_release (&buf);
if (occult)
return MUTT_REOPENED;
if (have_new)
return MUTT_NEW_MAIL;
if (flags_changed)
return MUTT_FLAGS;
return 0;
}
/*
* This function handles arrival of new mail and reopening of
* mh/maildir folders. Things are getting rather complex because we
* don't have a well-defined "mailbox order", so the tricks from
* mbox.c and mx.c won't work here.
*
* Don't change this code unless you _really_ understand what
* happens.
*
*/
static int mh_check_mailbox (CONTEXT * ctx, int *index_hint)
{
BUFFER *buf = NULL;
struct stat st, st_cur;
short modified = 0, have_new = 0, occult = 0, flags_changed = 0;;
struct maildir *md, *p;
struct maildir **last = NULL;
struct mh_sequences mhs;
int count = 0;
HASH *fnames;
int i;
struct mh_data *data = mh_data (ctx);
if (!option (OPTCHECKNEW))
return 0;
buf = mutt_buffer_pool_get ();
mutt_buffer_strcpy (buf, ctx->path);
if (stat (mutt_b2s (buf), &st) == -1)
{
mutt_buffer_pool_release (&buf);
return -1;
}
/* create .mh_sequences when there isn't one. */
mutt_buffer_printf (buf, "%s/.mh_sequences", ctx->path);
if ((i = stat (mutt_b2s (buf), &st_cur)) == -1 && errno == ENOENT)
{
char *tmp;
FILE *fp = NULL;
if (mh_mkstemp (ctx, &fp, &tmp) == 0)
{
safe_fclose (&fp);
if (safe_rename (tmp, mutt_b2s (buf)) == -1)
unlink (tmp);
FREE (&tmp);
}
}
if (i == -1 && stat (mutt_b2s (buf), &st_cur) == -1)
modified = 1;
mutt_buffer_pool_release (&buf);
if ((mutt_stat_timespec_compare (&st, MUTT_STAT_MTIME, &ctx->mtime) > 0) ||
(mutt_stat_timespec_compare (&st_cur, MUTT_STAT_MTIME, &data->mtime_cur) > 0))
modified = 1;
if (!modified)
return 0;
/* Update the modification times on the mailbox.
*
* The monitor code notices changes in the open mailbox too quickly.
* In practice, this sometimes leads to all the new messages not being
* noticed during the SAME group of mtime stat updates. To work around
* the problem, don't update the stat times for a monitor caused check. */
#ifdef USE_INOTIFY
if (MonitorContextChanged)
MonitorContextChanged = 0;
else
#endif
{
mutt_get_stat_timespec (&data->mtime_cur, &st_cur, MUTT_STAT_MTIME);
mutt_get_stat_timespec (&ctx->mtime, &st, MUTT_STAT_MTIME);
}
memset (&mhs, 0, sizeof (mhs));
md = NULL;
last = &md;
maildir_parse_dir (ctx, &last, NULL, &count, NULL);
maildir_delayed_parsing (ctx, &md, NULL);
if (mh_read_sequences (&mhs, ctx->path) < 0)
return -1;
mh_update_maildir (md, &mhs);
mhs_free_sequences (&mhs);
/* check for modifications and adjust flags */
fnames = hash_create (count, 0);
for (p = md; p; p = p->next)
{
/* the hash key must survive past the header, which is freed below. */
p->canon_fname = safe_strdup (p->h->path);
hash_insert (fnames, p->canon_fname, p);
}
for (i = 0; i < ctx->msgcount; i++)
{
ctx->hdrs[i]->active = 0;
if ((p = hash_find (fnames, ctx->hdrs[i]->path)) && p->h &&
(mbox_strict_cmp_headers (ctx->hdrs[i], p->h)))
{
ctx->hdrs[i]->active = 1;
/* found the right message */
if (!ctx->hdrs[i]->changed)
if (maildir_update_flags (ctx, ctx->hdrs[i], p->h))
flags_changed = 1;
mutt_free_header (&p->h);
}
else /* message has disappeared */
occult = 1;
}
/* destroy the file name hash */
hash_destroy (&fnames, NULL);
/* If we didn't just get new mail, update the tables. */
if (occult)
maildir_update_tables (ctx, index_hint);
/* Incorporate new messages */
have_new = maildir_move_to_context (ctx, &md);
if (occult)
return MUTT_REOPENED;
if (have_new)
return MUTT_NEW_MAIL;
if (flags_changed)
return MUTT_FLAGS;
return 0;
}
static int maildir_save_to_header_cache (CONTEXT *ctx, HEADER *h)
{
int rc = 0;
#if USE_HCACHE
header_cache_t *hc;
hc = mutt_hcache_open (HeaderCache, ctx->path, NULL);
rc = mutt_hcache_store (hc, h->path + 3, h, 0, &maildir_hcache_keylen,
MUTT_GENERATE_UIDVALIDITY);
mutt_hcache_close (hc);
#endif
return rc;
}
static int mh_save_to_header_cache (CONTEXT *ctx, HEADER *h)
{
int rc = 0;
#if USE_HCACHE
header_cache_t *hc;
hc = mutt_hcache_open (HeaderCache, ctx->path, NULL);
rc = mutt_hcache_store (hc, h->path, h, 0, strlen, MUTT_GENERATE_UIDVALIDITY);
mutt_hcache_close (hc);
#endif
return rc;
}
/*
* These functions try to find a message in a maildir folder when it
* has moved under our feet. Note that this code is rather expensive, but
* then again, it's called rarely.
*/
static FILE *_maildir_open_find_message (const char *folder, const char *unique,
const char *subfolder)
{
BUFFER *dir = mutt_buffer_pool_get ();
BUFFER *tunique = mutt_buffer_pool_get ();
BUFFER *fname = mutt_buffer_pool_get ();
DIR *dp;
struct dirent *de;
FILE *fp = NULL;
int oe = ENOENT;
mutt_buffer_printf (dir, "%s/%s", folder, subfolder);
if ((dp = opendir (mutt_b2s (dir))) == NULL)
{
errno = ENOENT;
goto cleanup;
}
while ((de = readdir (dp)))
{
maildir_canon_filename (tunique, de->d_name);
if (!mutt_strcmp (mutt_b2s (tunique), unique))
{
mutt_buffer_printf (fname, "%s/%s/%s", folder, subfolder,
de->d_name);
fp = fopen (mutt_b2s (fname), "r"); /* __FOPEN_CHECKED__ */
oe = errno;
break;
}
}
closedir (dp);
errno = oe;
cleanup:
mutt_buffer_pool_release (&dir);
mutt_buffer_pool_release (&tunique);
mutt_buffer_pool_release (&fname);
return fp;
}
FILE *maildir_open_find_message (const char *folder, const char *msg)
{
BUFFER *unique = NULL;
FILE *fp = NULL;
static unsigned int new_hits = 0, cur_hits = 0; /* simple dynamic optimization */
unique = mutt_buffer_pool_get ();
maildir_canon_filename (unique, msg);
if ((fp = _maildir_open_find_message (folder, mutt_b2s (unique),
new_hits > cur_hits ? "new" : "cur"))
|| errno != ENOENT)
{
if (new_hits < UINT_MAX && cur_hits < UINT_MAX)
{
new_hits += (new_hits > cur_hits ? 1 : 0);
cur_hits += (new_hits > cur_hits ? 0 : 1);
}
goto cleanup;
}
if ((fp = _maildir_open_find_message (folder, mutt_b2s (unique),
new_hits > cur_hits ? "cur" : "new"))
|| errno != ENOENT)
{
if (new_hits < UINT_MAX && cur_hits < UINT_MAX)
{
new_hits += (new_hits > cur_hits ? 0 : 1);
cur_hits += (new_hits > cur_hits ? 1 : 0);
}
goto cleanup;
}
fp = NULL;
cleanup:
mutt_buffer_pool_release (&unique);
return fp;
}
/*
* Returns:
* 1 if there are no messages in the mailbox
* 0 if there are messages in the mailbox
* -1 on error
*/
int maildir_check_empty (const char *path)
{
DIR *dp;
struct dirent *de;
int r = 1; /* assume empty until we find a message */
BUFFER *realpath = NULL;
int iter = 0;
/* Strategy here is to look for any file not beginning with a period */
realpath = mutt_buffer_pool_get ();
do
{
/* we do "cur" on the first iteration since its more likely that we'll
* find old messages without having to scan both subdirs
*/
mutt_buffer_printf (realpath, "%s/%s", path,
iter == 0 ? "cur" : "new");
if ((dp = opendir (mutt_b2s (realpath))) == NULL)
{
r = -1;
goto out;
}
while ((de = readdir (dp)))
{
if (*de->d_name != '.')
{
r = 0;
break;
}
}
closedir (dp);
iter++;
} while (r && iter < 2);
out:
mutt_buffer_pool_release (&realpath);
return r;
}
/*
* Returns:
* 1 if there are no messages in the mailbox
* 0 if there are messages in the mailbox
* -1 on error
*/
int mh_check_empty (const char *path)
{
DIR *dp;
struct dirent *de;
int r = 1; /* assume empty until we find a message */
if ((dp = opendir (path)) == NULL)
return -1;
while ((de = readdir (dp)))
{
if (mh_valid_message (de->d_name))
{
r = 0;
break;
}
}
closedir (dp);
return r;
}
int mx_is_maildir (const char *path)
{
BUFFER *tmp = NULL;
struct stat st;
int rc = 0;
tmp = mutt_buffer_pool_get ();
mutt_buffer_printf (tmp, "%s/cur", path);
if (stat (mutt_b2s (tmp), &st) == 0 && S_ISDIR (st.st_mode))
rc = 1;
mutt_buffer_pool_release (&tmp);
return rc;
}
int mx_is_mh (const char *path)
{
BUFFER *tmp = NULL;
int rc = 1;
tmp = mutt_buffer_pool_get ();
mutt_buffer_printf (tmp, "%s/.mh_sequences", path);
if (access (mutt_b2s (tmp), F_OK) == 0)
goto out;
mutt_buffer_printf (tmp, "%s/.xmhcache", path);
if (access (mutt_b2s (tmp), F_OK) == 0)
goto out;
mutt_buffer_printf (tmp, "%s/.mew_cache", path);
if (access (mutt_b2s (tmp), F_OK) == 0)
goto out;
mutt_buffer_printf (tmp, "%s/.mew-cache", path);
if (access (mutt_b2s (tmp), F_OK) == 0)
goto out;
mutt_buffer_printf (tmp, "%s/.sylpheed_cache", path);
if (access (mutt_b2s (tmp), F_OK) == 0)
goto out;
/*
* ok, this isn't an mh folder, but mh mode can be used to read
* Usenet news from the spool. ;-)
*/
mutt_buffer_printf (tmp, "%s/.overview", path);
if (access (mutt_b2s (tmp), F_OK) == 0)
goto out;
rc = 0;
out:
mutt_buffer_pool_release (&tmp);
return rc;
}
struct mx_ops mx_maildir_ops = {
.open = maildir_open_mailbox,
.open_append = maildir_open_mailbox_append,
.close = mh_close_mailbox,
.open_msg = maildir_open_message,
.close_msg = mh_close_message,
.commit_msg = maildir_commit_message,
.open_new_msg = maildir_open_new_message,
.check = maildir_check_mailbox,
.sync = mh_sync_mailbox,
.save_to_header_cache = maildir_save_to_header_cache,
};
struct mx_ops mx_mh_ops = {
.open = mh_open_mailbox,
.open_append = mh_open_mailbox_append,
.close = mh_close_mailbox,
.open_msg = mh_open_message,
.close_msg = mh_close_message,
.commit_msg = mh_commit_message,
.open_new_msg = mh_open_new_message,
.check = mh_check_mailbox,
.sync = mh_sync_mailbox,
.save_to_header_cache = mh_save_to_header_cache,
};
