mirror of
https://github.com/djcb/mu.git
synced 2024-06-28 07:41:04 +02:00
604 lines
13 KiB
C
604 lines
13 KiB
C
/*
|
|
** Copyright (C) 2010 Dirk-Jan C. Binnema <djcb@djcbsoftware.nl>
|
|
**
|
|
** 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 3, 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.
|
|
**
|
|
*/
|
|
|
|
#include "config.h"
|
|
|
|
#include <unistd.h>
|
|
#include <sys/types.h>
|
|
#include <sys/stat.h>
|
|
#include <fcntl.h>
|
|
#include <dirent.h>
|
|
|
|
#include <string.h>
|
|
#include <errno.h>
|
|
#include <glib/gprintf.h>
|
|
|
|
#include "mu-util.h"
|
|
#include "mu-maildir.h"
|
|
|
|
|
|
#define MU_MAILDIR_WALK_MAX_FILE_SIZE (32*1000*1000)
|
|
#define MU_MAILDIR_NOINDEX_FILE ".noindex"
|
|
#define MU_MAILDIR_CACHE_FILE ".mu.cache"
|
|
|
|
/* note: this function is *not* re-entrant, it returns a static buffer */
|
|
const char*
|
|
fullpath_s (const char* path, const char* name)
|
|
{
|
|
static char buf[4096];
|
|
|
|
snprintf (buf, sizeof(buf), "%s%c%s",
|
|
path, G_DIR_SEPARATOR,
|
|
name ? name : "");
|
|
|
|
return buf;
|
|
}
|
|
|
|
|
|
static gboolean
|
|
create_maildir (const char *path, int mode)
|
|
{
|
|
int i;
|
|
const gchar* subdirs[] = {"new", "cur", "tmp"};
|
|
|
|
/* make sure it does not exist yet */
|
|
if (access (path, F_OK) == 0)
|
|
errno = EEXIST;
|
|
if (errno != ENOENT) {
|
|
g_warning ("%s", strerror (errno));
|
|
return FALSE;
|
|
}
|
|
|
|
for (i = 0; i != G_N_ELEMENTS(subdirs); ++i) {
|
|
|
|
const char *fullpath;
|
|
int rv;
|
|
|
|
/* static buffer */
|
|
fullpath = fullpath_s (path, subdirs[i]);
|
|
|
|
rv = g_mkdir_with_parents (fullpath, mode);
|
|
if (rv != 0) {
|
|
g_warning ("g_mkdir_with_parents failed: %s",
|
|
strerror (errno));
|
|
return FALSE;
|
|
}
|
|
}
|
|
|
|
return TRUE;
|
|
}
|
|
|
|
static gboolean
|
|
create_noindex (const char *path)
|
|
{
|
|
/* create a noindex file if requested */
|
|
int fd;
|
|
const char *noindexpath;
|
|
|
|
/* static buffer */
|
|
noindexpath = fullpath_s (path, MU_MAILDIR_NOINDEX_FILE);
|
|
|
|
fd = creat (noindexpath, 0644);
|
|
|
|
if (fd < 0 || close (fd) != 0) {
|
|
g_warning ("error in create_noindex: %s",
|
|
strerror (errno));
|
|
return FALSE;
|
|
}
|
|
|
|
return TRUE;
|
|
}
|
|
|
|
gboolean
|
|
mu_maildir_mkmdir (const char* path, mode_t mode, gboolean noindex)
|
|
{
|
|
g_return_val_if_fail (path, FALSE);
|
|
|
|
MU_WRITE_LOG ("mu_maildir_mkdir (%s, %o, %s)",
|
|
path, mode, noindex ?"TRUE":"FALSE");
|
|
|
|
if (!create_maildir (path, mode))
|
|
return FALSE;
|
|
|
|
if (noindex && !create_noindex (path))
|
|
return FALSE;
|
|
|
|
return TRUE;
|
|
}
|
|
|
|
/* determine whether the source message is in 'new' or in 'cur';
|
|
* we ignore messages in 'tmp' for obvious reasons */
|
|
static gboolean
|
|
check_subdir (const char *src, gboolean *in_cur)
|
|
{
|
|
gchar *srcpath;
|
|
|
|
srcpath = g_path_get_dirname (src);
|
|
|
|
if (g_str_has_suffix (srcpath, "new"))
|
|
*in_cur = FALSE;
|
|
else if (g_str_has_suffix (srcpath, "cur"))
|
|
*in_cur = TRUE;
|
|
else {
|
|
g_warning ("%s", "Invalid source message");
|
|
return FALSE;
|
|
}
|
|
g_free (srcpath);
|
|
|
|
return TRUE;
|
|
}
|
|
|
|
static gchar*
|
|
get_target_fullpath (const char* src, const gchar *targetpath)
|
|
{
|
|
gchar *targetfullpath, *srcfile, *srcpath, *c;
|
|
gboolean in_cur;
|
|
|
|
if (!check_subdir (src, &in_cur))
|
|
return NULL;
|
|
|
|
/* note: make the filename *cough* unique by making the pathname
|
|
* part of the file name. This helps if there are copies of a
|
|
* message (which all have the same basename)*/
|
|
c = srcpath = g_path_get_dirname (src);
|
|
while (c && *c) {
|
|
if (*c == G_DIR_SEPARATOR)
|
|
*c = '_';
|
|
++c;
|
|
}
|
|
srcfile = g_path_get_basename (src);
|
|
|
|
/* create & test targetpath */
|
|
targetfullpath = g_strdup_printf ("%s%c%s%c%s_%s",
|
|
targetpath,
|
|
G_DIR_SEPARATOR,
|
|
in_cur ? "cur" : "new",
|
|
G_DIR_SEPARATOR,
|
|
srcpath,
|
|
srcfile);
|
|
g_free (srcfile);
|
|
g_free (srcpath);
|
|
|
|
return targetfullpath;
|
|
}
|
|
|
|
|
|
gboolean
|
|
mu_maildir_link (const char* src, const char *targetpath)
|
|
{
|
|
gchar *targetfullpath;
|
|
int rv;
|
|
|
|
g_return_val_if_fail (src, FALSE);
|
|
g_return_val_if_fail (targetpath, FALSE);
|
|
|
|
targetfullpath = get_target_fullpath (src, targetpath);
|
|
if (!targetfullpath)
|
|
return FALSE;
|
|
|
|
rv = symlink (src, targetfullpath);
|
|
|
|
if (rv != 0) {
|
|
g_warning ("Error creating link %s => %s: %s",
|
|
targetfullpath, src,
|
|
strerror (errno));
|
|
g_free (targetfullpath);
|
|
return FALSE;
|
|
}
|
|
|
|
g_free (targetfullpath);
|
|
return TRUE;
|
|
}
|
|
|
|
|
|
static MuResult process_dir (const char* path,
|
|
MuMaildirWalkMsgCallback msg_cb,
|
|
MuMaildirWalkDirCallback dir_cb, void *data);
|
|
|
|
static MuResult
|
|
process_file (const char* fullpath, MuMaildirWalkMsgCallback msg_cb,
|
|
void *data)
|
|
{
|
|
MuResult result;
|
|
struct stat statbuf;
|
|
|
|
if (!msg_cb)
|
|
return MU_OK;
|
|
|
|
if (G_UNLIKELY(access(fullpath, R_OK) != 0)) {
|
|
g_warning ("cannot access %s: %s", fullpath,
|
|
strerror(errno));
|
|
return MU_ERROR;
|
|
}
|
|
|
|
if (G_UNLIKELY(stat (fullpath, &statbuf) != 0)) {
|
|
g_warning ("cannot stat %s: %s", fullpath, strerror(errno));
|
|
return MU_ERROR;
|
|
}
|
|
|
|
if (G_UNLIKELY(statbuf.st_size > MU_MAILDIR_WALK_MAX_FILE_SIZE)) {
|
|
g_warning ("ignoring because bigger than %d bytes: %s",
|
|
MU_MAILDIR_WALK_MAX_FILE_SIZE, fullpath);
|
|
return MU_OK; /* not an error */
|
|
}
|
|
|
|
/*
|
|
* use the ctime, so any status change will be visible (perms,
|
|
* filename etc.)
|
|
*/
|
|
result = (msg_cb)(fullpath, statbuf.st_ctime, data);
|
|
if (result == MU_STOP)
|
|
g_debug ("callback said 'MU_STOP' for %s", fullpath);
|
|
else if (result == MU_ERROR)
|
|
g_warning ("%s: failed %d in callback (%s)",
|
|
__FUNCTION__, result, fullpath);
|
|
return result;
|
|
}
|
|
|
|
|
|
/*
|
|
* determine if path is a maildir leaf-dir; ie. if it's 'cur' or 'new'
|
|
* (we're skipping 'tmp' for obvious reasons)
|
|
*/
|
|
G_GNUC_CONST static gboolean
|
|
is_maildir_new_or_cur (const char *path)
|
|
{
|
|
size_t len;
|
|
const char *sfx;
|
|
|
|
/* path is the full path; it cannot possibly be shorter
|
|
* than 4 for a maildir (/cur or /new)
|
|
*/
|
|
if (!path||(len = strlen(path)) < 4)
|
|
return FALSE;
|
|
|
|
sfx = &path[len - 4];
|
|
|
|
if (sfx[0] != G_DIR_SEPARATOR) /* small optimization */
|
|
return FALSE;
|
|
else if (sfx[1] != 'c' && sfx[1] != 'n')
|
|
return FALSE; /* optimization */
|
|
else
|
|
return (strcmp (sfx + 1, "cur") == 0 ||
|
|
strcmp (sfx + 1, "new") == 0);
|
|
}
|
|
|
|
/* check if there is a noindex file (MU_WALK_NOINDEX_FILE) in this dir; */
|
|
static gboolean
|
|
has_noindex_file (const char *path)
|
|
{
|
|
const char* noindexpath;
|
|
|
|
/* static buffer */
|
|
noindexpath = fullpath_s (path, MU_MAILDIR_NOINDEX_FILE);
|
|
|
|
if (access (noindexpath, F_OK) == 0)
|
|
return TRUE;
|
|
|
|
else if (errno != ENOENT)
|
|
g_warning ("error testing for noindex file %s: %s",
|
|
noindexpath, strerror(errno));
|
|
|
|
return FALSE;
|
|
}
|
|
|
|
|
|
/* do readdir, and of file systems that do not support ->_dtype, fill it
|
|
* using stat -- much slower, but it works.
|
|
*/
|
|
static struct dirent*
|
|
readdir_with_stat_fallback (DIR* dir, const char* path)
|
|
{
|
|
struct dirent *entry;
|
|
|
|
errno = 0;
|
|
entry = readdir (dir);
|
|
|
|
if (!entry) {
|
|
if (errno)
|
|
g_warning ("readdir failed in %s: %s",
|
|
path, strerror (errno));
|
|
return NULL;
|
|
}
|
|
|
|
/* XFS, ReiserFS and some other FSs don't support d_type, and
|
|
* always set it to NULL; we use (slow) stat instead then */
|
|
if (G_UNLIKELY(entry->d_type == DT_UNKNOWN)) {
|
|
|
|
struct stat statbuf;
|
|
const char* fullpath;
|
|
|
|
/* note, fullpath_s returns a static buffer */
|
|
fullpath = fullpath_s (path, entry->d_name);
|
|
if (stat (fullpath, &statbuf) != 0) {
|
|
g_warning ("stat failed on %s: %s", fullpath,
|
|
strerror(errno));
|
|
return FALSE;
|
|
}
|
|
|
|
/* we only care about dirs, regular files and links */
|
|
if (S_ISREG (statbuf.st_mode))
|
|
entry->d_type = DT_REG;
|
|
else if (S_ISDIR (statbuf.st_mode))
|
|
entry->d_type = DT_DIR;
|
|
else if (S_ISLNK (statbuf.st_mode))
|
|
entry->d_type = DT_LNK;
|
|
}
|
|
|
|
return entry;
|
|
}
|
|
|
|
static gboolean
|
|
ignore_dir_entry (struct dirent *entry)
|
|
{
|
|
const char *name;
|
|
|
|
/* if it's not a dir and not a file, ignore it.
|
|
* note, this means also symlinks (DT_LNK) are ignored,
|
|
* maybe make this optional. Also note that entry->d_type is
|
|
* defined on Linux, BSDs is not part of POSIX; this needs a
|
|
* configure check */
|
|
if (entry->d_type != DT_REG &&
|
|
entry->d_type != DT_DIR)
|
|
return TRUE;
|
|
|
|
name = entry->d_name;
|
|
|
|
if (name[0] != '.')
|
|
return FALSE;
|
|
|
|
/* ignore . and .. */
|
|
if (name[1] == '\0' ||
|
|
(name[1] == '.' && name[2] == '\0'))
|
|
return TRUE;
|
|
|
|
/* ignore .notmuch, .nnmaildir */
|
|
if ((name[1] == 'n') && /* optimization */
|
|
(strcmp (name, ".notmuch") == 0 ||
|
|
strcmp (name, ".nnmaildir") == 0))
|
|
return TRUE;
|
|
|
|
return FALSE;
|
|
}
|
|
|
|
static MuResult
|
|
process_dir_entry (const char* path, struct dirent *entry,
|
|
MuMaildirWalkMsgCallback cb_msg,
|
|
MuMaildirWalkDirCallback cb_dir,
|
|
void *data)
|
|
{
|
|
const char *fp;
|
|
char* fullpath;
|
|
|
|
/* ignore special dirs: */
|
|
if (ignore_dir_entry (entry))
|
|
return MU_OK;
|
|
|
|
/* we have to copy the buffer from fullpath_s, because it
|
|
* returns a static buffer */
|
|
fp = fullpath_s (path, entry->d_name);
|
|
fullpath = g_newa (char, strlen(fp) + 1);
|
|
strcpy (fullpath, fp);
|
|
|
|
switch (entry->d_type) {
|
|
case DT_REG:
|
|
/* we only want files in cur/ and new/ */
|
|
if (!is_maildir_new_or_cur (path))
|
|
return MU_OK;
|
|
|
|
return process_file (fullpath, cb_msg, data);
|
|
|
|
case DT_DIR: {
|
|
/* if it has a noindex file, we ignore this dir */
|
|
if (has_noindex_file (fullpath)) {
|
|
g_debug ("ignoring dir %s", fullpath);
|
|
return MU_OK;
|
|
}
|
|
|
|
return process_dir (fullpath, cb_msg, cb_dir, data);
|
|
}
|
|
|
|
default:
|
|
return MU_OK; /* ignore other types */
|
|
}
|
|
}
|
|
|
|
|
|
static struct dirent*
|
|
dirent_copy (struct dirent *entry)
|
|
{
|
|
struct dirent *d = g_slice_new (struct dirent);
|
|
/* NOTE: simply memcpy'ing sizeof(struct dirent) bytes will
|
|
* give memory errors*/
|
|
return (struct dirent*)memcpy (d, entry, entry->d_reclen);
|
|
}
|
|
|
|
static void
|
|
dirent_destroy (struct dirent *entry)
|
|
{
|
|
g_slice_free(struct dirent, entry);
|
|
}
|
|
|
|
#ifdef HAVE_STRUCT_DIRENT_D_INO
|
|
static gint
|
|
dirent_cmp (struct dirent *d1, struct dirent *d2)
|
|
{
|
|
return d1->d_ino - d2->d_ino;
|
|
}
|
|
#endif /*HAVE_STRUCT_DIRENT_D_INO*/
|
|
|
|
static MuResult
|
|
process_dir (const char* path, MuMaildirWalkMsgCallback msg_cb,
|
|
MuMaildirWalkDirCallback dir_cb, void *data)
|
|
{
|
|
MuResult result;
|
|
GList *lst, *c;
|
|
struct dirent *entry;
|
|
DIR* dir;
|
|
|
|
dir = opendir (path);
|
|
if (G_UNLIKELY(!dir)) {
|
|
g_warning ("%s: ignoring %s: %s", path,
|
|
__FUNCTION__, strerror(errno));
|
|
return MU_OK;
|
|
}
|
|
|
|
if (dir_cb) {
|
|
MuResult rv = dir_cb (path, TRUE, data);
|
|
if (rv != MU_OK) {
|
|
closedir (dir);
|
|
return rv;
|
|
}
|
|
}
|
|
|
|
/* we sort the inodes if the FS's dirent has them. It makes
|
|
* file-access much faster on some filesystems, such as
|
|
* ext3,4. readdir_with_stat_fallback is a wrapper for readdir
|
|
* that falls back to (slow) stats if the FS does not support
|
|
* entry->d_type
|
|
*/
|
|
lst = NULL;
|
|
while ((entry = readdir_with_stat_fallback (dir, path)))
|
|
lst = g_list_prepend (lst, dirent_copy(entry));
|
|
|
|
#if HAVE_STRUCT_DIRENT_D_INO
|
|
c = lst = g_list_sort (lst, (GCompareFunc)dirent_cmp);
|
|
#endif /*HAVE_STRUCT_DIRENT_D_INO*/
|
|
|
|
for (c = lst, result = MU_OK; c && result == MU_OK; c = c->next) {
|
|
result = process_dir_entry (path, (struct dirent*)c->data,
|
|
msg_cb, dir_cb, data);
|
|
/* hmmm, break on MU_ERROR as well? */
|
|
if (result == MU_STOP)
|
|
break;
|
|
}
|
|
|
|
g_list_foreach (lst, (GFunc)dirent_destroy, NULL);
|
|
g_list_free (lst);
|
|
|
|
closedir (dir);
|
|
|
|
if (dir_cb)
|
|
return dir_cb (path, FALSE, data);
|
|
|
|
return result;
|
|
}
|
|
|
|
|
|
MuResult
|
|
mu_maildir_walk (const char *path, MuMaildirWalkMsgCallback cb_msg,
|
|
MuMaildirWalkDirCallback cb_dir, void *data)
|
|
{
|
|
struct stat statbuf;
|
|
|
|
g_return_val_if_fail (path && cb_msg, MU_ERROR);
|
|
|
|
if (stat (path, &statbuf) != 0) {
|
|
g_warning ("cannot stat %s: %s", path, strerror(errno));
|
|
return MU_ERROR;
|
|
}
|
|
|
|
if (S_ISREG(statbuf.st_mode))
|
|
return process_file (path, cb_msg, data);
|
|
|
|
if (S_ISDIR(statbuf.st_mode)) {
|
|
/* skip the final slash from dirnames */
|
|
MuResult rv;
|
|
char *mypath = g_strdup (path);
|
|
|
|
/* strip the final / or \ */
|
|
if (mypath[strlen(mypath)-1] == G_DIR_SEPARATOR)
|
|
mypath[strlen(mypath)-1] = '\0';
|
|
|
|
rv = process_dir (mypath, cb_msg, cb_dir, data);
|
|
g_free (mypath);
|
|
|
|
return rv;
|
|
}
|
|
|
|
g_warning ("%s: unsupported file type for %s",
|
|
__FUNCTION__, path);
|
|
|
|
return MU_ERROR;
|
|
}
|
|
|
|
|
|
static gboolean
|
|
clear_links (const gchar* dirname, DIR *dir)
|
|
{
|
|
struct dirent *entry;
|
|
gboolean rv;
|
|
|
|
rv = TRUE;
|
|
while ((entry = readdir_with_stat_fallback (dir, dirname))) {
|
|
|
|
const char *fp;
|
|
char *fullpath;
|
|
|
|
/* ignore empty, dot thingies */
|
|
if (!entry->d_name || entry->d_name[0] == '.')
|
|
continue;
|
|
|
|
/* ignore non-links / non-dirs */
|
|
if (entry->d_type != DT_LNK && entry->d_type != DT_DIR)
|
|
continue;
|
|
|
|
/* we have to copy the buffer from fullpath_s, because it
|
|
* returns a static buffer and we are recursive*/
|
|
fp = fullpath_s (dirname, entry->d_name);
|
|
fullpath = g_newa (char, strlen(fp) + 1);
|
|
strcpy (fullpath, fp);
|
|
|
|
if (entry->d_type == DT_LNK) {
|
|
if (unlink (fullpath) != 0) {
|
|
g_warning ("error unlinking %s: %s",
|
|
fullpath, strerror(errno));
|
|
rv = FALSE;
|
|
}
|
|
} else /* DT_DIR, see check before*/
|
|
rv = mu_maildir_clear_links (fullpath);
|
|
}
|
|
|
|
return rv;
|
|
}
|
|
|
|
|
|
gboolean
|
|
mu_maildir_clear_links (const gchar* path)
|
|
{
|
|
DIR *dir;
|
|
gboolean rv;
|
|
|
|
g_return_val_if_fail (path, FALSE);
|
|
|
|
dir = opendir (path);
|
|
if (!dir) {
|
|
g_warning ("failed to open %s: %s", path,
|
|
strerror(errno));
|
|
return FALSE;
|
|
}
|
|
|
|
g_debug ("remove symlinks from %s", path);
|
|
|
|
rv = clear_links (path, dir);
|
|
closedir (dir);
|
|
|
|
return rv;
|
|
}
|