emacs
/
mu
mirror of https://github.com/djcb/mu.git
1
0
Fork 0
Code Issues Releases Wiki Activity

lib: Update mu-maildir for modern times 

Update the good-old mu-maildir to be a bit more... modern.
This commit is contained in:
Dirk-Jan C. Binnema 2022-02-16 22:59:03 +02:00
parent 1db70c05e6
commit abd2a4a8f1
2 changed files with 438 additions and 562 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

824
lib/mu-maildir.cc
View File

@ -1,5 +1,5 @@
/*
** Copyright (C) 2008-2020 Dirk-Jan C. Binnema <djcb@djcbsoftware.nl>
** Copyright (C) 2008-2022 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
@ -19,6 +19,8 @@
#include "config.h"
#include <optional>
#include <string>
#include <unistd.h>
#include <sys/types.h>
#include <sys/stat.h>
@ -30,8 +32,11 @@
#include <glib/gprintf.h>
#include <gio/gio.h>
#include "glibconfig.h"
#include "mu-maildir.hh"
#include "utils/mu-str.h"
#include "mu-message-flags.hh"
#include "utils/mu-utils.hh"
#include "utils/mu-util.h"
using namespace Mu;
@ -45,7 +50,7 @@ using namespace Mu;
* and return it in the d_type parameter
*/
static unsigned char
get_dtype(struct dirent* dentry, const char* path, gboolean use_lstat)
get_dtype(struct dirent* dentry, const std::string& path, bool use_lstat)
{
#ifdef HAVE_STRUCT_DIRENT_D_TYPE
@ -58,612 +63,505 @@ get_dtype(struct dirent* dentry, const char* path, gboolean use_lstat)
slowpath:
#endif /*HAVE_STRUCT_DIRENT_D_TYPE*/
return mu_util_get_dtype(path, use_lstat);
return mu_util_get_dtype(path.c_str(), use_lstat);
}
static gboolean
create_maildir(const char* path, mode_t mode, GError** err)
static Mu::Result<void>
create_maildir(const std::string& path, mode_t mode)
{
int i;
const char* subdirs[] = {"new", "cur", "tmp"};
std::array<std::string,3> subdirs = {"new", "cur", "tmp"};
for (auto&& subdir: subdirs) {
for (i = 0; i != G_N_ELEMENTS(subdirs); ++i) {
const char* fullpath;
int rv;
/* static buffer */
fullpath = mu_str_fullpath_s(path, subdirs[i]);
const auto fullpath{path + G_DIR_SEPARATOR_S + subdir};
/* if subdir already exists, don't try to re-create
* it */
if (mu_util_check_dir(fullpath, TRUE, TRUE))
if (mu_util_check_dir(fullpath.c_str(), TRUE, TRUE))
continue;
rv = g_mkdir_with_parents(fullpath, (int)mode);
int rv{g_mkdir_with_parents(fullpath.c_str(), static_cast<int>(mode))};
/* note, g_mkdir_with_parents won't detect an error if
* there's already such a dir, but with the wrong
* permissions; so we need to check */
if (rv != 0 || !mu_util_check_dir(fullpath, TRUE, TRUE))
return mu_util_g_set_error(err,
MU_ERROR_FILE_CANNOT_MKDIR,
if (rv != 0 || !mu_util_check_dir(fullpath.c_str(), TRUE, TRUE))
return Err(Error{Error::Code::File,
"creating dir failed for %s: %s",
fullpath,
g_strerror(errno));
fullpath.c_str(), g_strerror(errno)});
}
return TRUE;
return Ok();
}
static gboolean
create_noindex(const char* path, GError** err)
static Mu::Result<void> /* create a noindex file if requested */
create_noindex(const std::string& path)
{
/* create a noindex file if requested */
int fd;
const char* noindexpath;
const auto noindexpath{path + G_DIR_SEPARATOR_S MU_MAILDIR_NOINDEX_FILE};
/* static buffer */
noindexpath = mu_str_fullpath_s(path, MU_MAILDIR_NOINDEX_FILE);
fd = creat(noindexpath, 0644);
/* note, if the 'close' failed, creation may still have
* succeeded...*/
if (fd < 0 || close(fd) != 0)
return mu_util_g_set_error(err,
MU_ERROR_FILE_CANNOT_CREATE,
"error in create_noindex: %s",
g_strerror(errno));
return TRUE;
/* note, if the 'close' failed, creation may still have succeeded...*/
int fd = ::creat(noindexpath.c_str(), 0644);
if (fd < 0 || ::close(fd) != 0)
return Err(Error{Error::Code::File,
"error creating .noindex: %s", g_strerror(errno)});
else
return Ok();
}
gboolean
Mu::mu_maildir_mkdir(const char* path, mode_t mode, gboolean noindex, GError** err)
Mu::Result<void>
Mu::mu_maildir_mkdir(const std::string& path, mode_t mode, bool noindex)
{
g_return_val_if_fail(path, FALSE);
if (auto&& created{create_maildir(path, mode)}; !created)
return created; // fail.
else if (!noindex)
return Ok();
if (!create_maildir(path, mode, err))
return FALSE;
if (auto&& created{create_noindex(path)}; !created)
return created; //fail
if (noindex && !create_noindex(path, err))
return FALSE;
return TRUE;
return Ok();
}
/* 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, GError** err)
static Mu::Result<void>
check_subdir(const std::string& src, bool& in_cur)
{
gboolean rv;
char* srcpath;
srcpath = g_path_get_dirname(src);
*in_cur = FALSE;
rv = TRUE;
char *srcpath{g_path_get_dirname(src.c_str())};
bool invalid{};
if (g_str_has_suffix(srcpath, "cur"))
*in_cur = TRUE;
else if (!g_str_has_suffix(srcpath, "new"))
rv = mu_util_g_set_error(err,
MU_ERROR_FILE_INVALID_SOURCE,
"invalid source message '%s'",
src);
in_cur = true;
else if (g_str_has_suffix(srcpath, "new"))
in_cur = false;
else
invalid = true;
g_free(srcpath);
return rv;
if (invalid)
return Err(Error{Error::Code::File, "invalid source message '%s'",
src.c_str()});
else
return Ok();
}
static char*
get_target_fullpath(const char* src, const char* targetpath, GError** err)
static Mu::Result<std::string>
get_target_fullpath(const std::string& src, const std::string& targetpath)
{
char * targetfullpath, *srcfile;
gboolean in_cur;
bool in_cur{};
if (auto&& res = check_subdir(src, in_cur); !res)
return Err(std::move(res.error()));
if (!check_subdir(src, &in_cur, err))
return NULL;
char *srcfile{g_path_get_basename(src.c_str())};
srcfile = g_path_get_basename(src);
/* create targetpath; note: make the filename *cough* unique
* by including a hash of the srcname in the targetname. This
* helps if there are copies of a message (which all have the
* same basename)
/* create targetpath; note: make the filename *cough* unique by
* including a hash of the srcname in the targetname. This helps if
* there are copies of a message (which all have the same basename)
*/
targetfullpath = g_strdup_printf("%s%c%s%c%u_%s",
targetpath,
auto targetfullpath = format("%s%c%s%c%u_%s",
targetpath.c_str(),
G_DIR_SEPARATOR, in_cur ? "cur" : "new",
G_DIR_SEPARATOR,
in_cur ? "cur" : "new",
G_DIR_SEPARATOR,
g_str_hash(src),
g_str_hash(src.c_str()),
srcfile);
g_free(srcfile);
return targetfullpath;
}
gboolean
Mu::mu_maildir_link(const char* src, const char* targetpath, GError** err)
Result<void>
Mu::mu_maildir_link(const std::string& src, const std::string& targetpath)
{
char* targetfullpath;
int rv;
g_return_val_if_fail(src, FALSE);
g_return_val_if_fail(targetpath, FALSE);
targetfullpath = get_target_fullpath(src, targetpath, err);
if (!targetfullpath)
return FALSE;
rv = symlink(src, targetfullpath);
auto path_res{get_target_fullpath(src, targetpath)};
if (!path_res)
return Err(std::move(path_res.error()));
auto rv{::symlink(src.c_str(), path_res->c_str())};
if (rv != 0)
mu_util_g_set_error(err,
MU_ERROR_FILE_CANNOT_LINK,
return Err(Error{Error::Code::File,
"error creating link %s => %s: %s",
targetfullpath,
src,
g_strerror(errno));
g_free(targetfullpath);
path_res->c_str(),
src.c_str(),
g_strerror(errno)});
return rv == 0 ? TRUE : FALSE;
return Ok();
}
/*
* determine if path is a maildir leaf-dir; ie. if it's 'cur' or 'new'
* (we're skipping 'tmp' for obvious reasons)
*/
gboolean
Mu::mu_maildir_is_leaf_dir(const char* path)
static bool
clear_links(const std::string& path, DIR* dir)
{
size_t len;
/* path is the full path; it cannot possibly be shorter
* than 4 for a maildir (/cur or /new) */
len = path ? strlen(path) : 0;
if (G_UNLIKELY(len < 4))
return FALSE;
/* optimization; one further idea would be cast the 4 bytes to an
* integer and compare that -- need to think about alignment,
* endianness */
if (path[len - 4] == G_DIR_SEPARATOR && path[len - 3] == 'c' && path[len - 2] == 'u' &&
path[len - 1] == 'r')
return TRUE;
if (path[len - 4] == G_DIR_SEPARATOR && path[len - 3] == 'n' && path[len - 2] == 'e' &&
path[len - 1] == 'w')
return TRUE;
return FALSE;
}
static gboolean
clear_links(const char* path, DIR* dir)
{
gboolean rv;
bool res;
struct dirent* dentry;
rv = TRUE;
res = true;
errno = 0;
while ((dentry = readdir(dir))) {
guint8 d_type;
char* fullpath;
while ((dentry = ::readdir(dir))) {
if (dentry->d_name[0] == '.')
continue; /* ignore .,.. other dotdirs */
fullpath = g_build_path("/", path, dentry->d_name, NULL);
d_type = get_dtype(dentry, fullpath, TRUE /*lstat*/);
if (d_type == DT_LNK) {
if (unlink(fullpath) != 0) {
g_warning("error unlinking %s: %s", fullpath, g_strerror(errno));
rv = FALSE;
const auto fullpath{
format("%s" G_DIR_SEPARATOR_S "%s",path.c_str(), dentry->d_name)};
const auto d_type = get_dtype(dentry, fullpath.c_str(), true/*lstat*/);
switch(d_type) {
case DT_LNK:
if (::unlink(fullpath.c_str()) != 0) {
g_warning("error unlinking %s: %s",
fullpath.c_str(), g_strerror(errno));
res = false;
}
} else if (d_type == DT_DIR) {
DIR* subdir;
subdir = opendir(fullpath);
break;
case DT_DIR: {
DIR* subdir{::opendir(fullpath.c_str())};
if (!subdir) {
g_warning("failed to open dir %s: %s", fullpath, g_strerror(errno));
rv = FALSE;
goto next;
}
if (!clear_links(fullpath, subdir))
rv = FALSE;
closedir(subdir);
}
next:
g_free(fullpath);
}
return rv;
}
gboolean
Mu::mu_maildir_clear_links(const char* path, GError** err)
{
DIR* dir;
gboolean rv;
g_return_val_if_fail(path, FALSE);
dir = opendir(path);
if (!dir) {
g_set_error(err,
MU_ERROR_DOMAIN,
MU_ERROR_FILE_CANNOT_OPEN,
"failed to open %s: %s",
path,
g_warning("failed to open dir %s: %s", fullpath.c_str(),
g_strerror(errno));
return FALSE;
res = false;
}
if (!clear_links(fullpath, subdir))
res = false;
::closedir(subdir);
}
break;
default:
break;
}
}
rv = clear_links(path, dir);
closedir(dir);
return rv;
return res;
}
MuFlags
Mu::mu_maildir_get_flags_from_path(const char* path)
Mu::Result<void>
Mu::mu_maildir_clear_links(const std::string& path)
{
g_return_val_if_fail(path, MU_FLAG_INVALID);
const auto dir{::opendir(path.c_str())};
if (!dir)
return Err(Error{Error::Code::File, "failed to open %s: %s",
path.c_str(), g_strerror(errno)});
/* try to find the info part */
/* note that we can use either the ':', ';', or '!' as separator;
* the former is the official, but as it does not work on e.g. VFAT
* file systems, some Maildir implementations use the latter instead
* (or both). For example, Tinymail/modest does this. The python
* documentation at http://docs.python.org/lib/mailbox-maildir.html
* mentions the '!' as well as a 'popular choice'. Isync uses ';' by
* default on Windows.
*/
clear_links(path, dir);
::closedir(dir);
/* we check the dir -- */
if (strstr(path, G_DIR_SEPARATOR_S "new" G_DIR_SEPARATOR_S)) {
char * dir, *dir2;
MuFlags flags;
dir = g_path_get_dirname(path);
dir2 = g_path_get_basename(dir);
flags = MU_FLAG_NONE;
if (g_strcmp0(dir2, "new") == 0)
flags = MU_FLAG_NEW;
g_free(dir);
g_free(dir2);
/* NOTE: new/ message should not have :2,-stuff, as
* per http://cr.yp.to/proto/maildir.html. If they, do
* we ignore it
*/
if (flags == MU_FLAG_NEW)
return flags;
return Ok();
}
/* get the file flags */
{
const char* info;
info = strrchr(path, '2');
if (!info || info == path ||
(info[-1] != ':' && info[-1] != '!' && info[-1] != ';') || (info[1] != ','))
return MU_FLAG_NONE;
else
return mu_flags_from_str(&info[2],
MU_FLAG_TYPE_MAILFILE,
TRUE /*ignore invalid */);
}
}
/*
* take an existing message path, and return a new path, based on
* whether it should be in 'new' or 'cur'; ie.
*
* /home/user/Maildir/foo/bar/cur/abc:2,F and flags == MU_FLAG_NEW
* => /home/user/Maildir/foo/bar/new
* and
* /home/user/Maildir/foo/bar/new/abc and flags == MU_FLAG_REPLIED
* => /home/user/Maildir/foo/bar/cur
*
* so the difference is whether MU_FLAG_NEW is set or not; and in the
* latter case, no other flags are allowed.
*
* The file-components, ie.
* 1631819685.fb7b279bbb0a7b66.evergrey:2,RS
* => {
* "1631819685.fb7b279bbb0a7b66.evergrey",
* ':',
* "2,",
* "RS"
* }
*/
static char*
get_new_path(const char* mdir,
const char* mfile,
MuFlags flags,
const char* custom_flags,
char flags_sep)
struct FileParts {
std::string base;
char separator;
std::string flags_suffix;;
};
static FileParts
message_file_parts(const std::string& file)
{
if (flags & MU_FLAG_NEW)
return g_strdup_printf("%s%cnew%c%s",
mdir,
G_DIR_SEPARATOR,
G_DIR_SEPARATOR,
mfile);
else {
const char* flagstr;
flagstr = mu_flags_to_str_s(flags, MU_FLAG_TYPE_MAILFILE);
const auto pos{file.find_last_of(":!;")};
return g_strdup_printf("%s%ccur%c%s%c2,%s%s",
mdir,
G_DIR_SEPARATOR,
G_DIR_SEPARATOR,
mfile,
flags_sep,
flagstr,
custom_flags ? custom_flags : "");
}
/* no suffix at all? */
if (pos == std::string::npos ||
pos >= file.length() - 3 ||
file[pos + 1] != '2' ||
file[pos + 2] != ',')
return FileParts{ file, ':', {}};
return FileParts {
file.substr(0, pos),
file[pos],
file.substr(pos + 3)
};
}
char*
Mu::mu_maildir_get_maildir_from_path(const char* path)
struct DirFile {
std::string dir;
std::string file;
bool is_new;
};
static Result<DirFile>
base_message_dir_file(const std::string& path)
{
char* mdir;
constexpr auto newdir{ G_DIR_SEPARATOR_S "new"};
/* determine the maildir */
mdir = g_path_get_dirname(path);
if (!g_str_has_suffix(mdir, "cur") &&
char *dirname{g_path_get_dirname(path.c_str())};
bool is_new{!!g_str_has_suffix(dirname, newdir)};
!g_str_has_suffix(mdir, "new")) {
g_warning("%s: not a valid maildir path: %s", __func__, path);
g_free(mdir);
return NULL;
std::string mdir{dirname, ::strlen(dirname) - 4};
g_free(dirname);
char *basename{g_path_get_basename(path.c_str())};
std::string bname{basename};
g_free(basename);
return Ok(DirFile{std::move(mdir), std::move(bname), is_new});
}
/* remove the 'cur' or 'new' */
mdir[strlen(mdir) - 4] = '\0';
return mdir;
Mu::Result<Mu::MessageFlags>
Mu::mu_maildir_flags_from_path(const std::string& path)
{ /*
* this gets us the source maildir filesystem path, the directory
* in which new/ & cur/ lives, and the source file
*/
auto dirfile{base_message_dir_file(path)};
if (!dirfile)
return Err(std::move(dirfile.error()));
/* a message under new/ is just.. New. Filename is not considered */
if (dirfile->is_new)
return Ok(MessageFlags::New);
/* it's cur/ message, so parse the file name */
const auto parts{message_file_parts(dirfile->file)};
auto flags{message_flags_from_absolute_expr(parts.flags_suffix,
true/*ignore invalid*/)};
if (!flags)
return Err(Error{Error::Code::InvalidArgument,
"invalid flags ('%s')", parts.flags_suffix.c_str()});
else
return Ok(std::move(flags.value()));
}
static char*
get_new_basename(void)
{
return g_strdup_printf("%u.%08x%08x.%s",
(guint)time(NULL),
g_random_int(),
(gint32)g_get_monotonic_time(),
g_get_host_name());
}
static char*
find_path_separator(const char* path)
{
const char* cur;
for (cur = &path[strlen(path) - 1]; cur > path; --cur) {
if ((*cur == ':' || *cur == '!' || *cur == ';') &&
(cur[1] == '2' && cur[2] == ',')) {
return (char*)cur;
}
}
return NULL;
}
char*
Mu::mu_maildir_get_new_path(const char* oldpath,
const char* new_mdir,
MuFlags newflags,
gboolean new_name)
{
char *mfile, *mdir, *custom_flags, *cur, *newpath, flags_sep = ':';
g_return_val_if_fail(oldpath, NULL);
mfile = newpath = custom_flags = NULL;
/* determine the maildir */
mdir = mu_maildir_get_maildir_from_path(oldpath);
if (!mdir)
return NULL;
/* determine the name of the location of the flag separator */
if (new_name) {
mfile = get_new_basename();
cur = find_path_separator(oldpath);
if (cur) {
/* preserve the existing flags separator
* in the new file name */
flags_sep = *cur;
}
} else {
mfile = g_path_get_basename(oldpath);
cur = find_path_separator(mfile);
if (cur) {
/* get the custom flags (if any) */
custom_flags = mu_flags_custom_from_str(cur + 3);
/* preserve the existing flags separator
* in the new file name */
flags_sep = *cur;
cur[0] = '\0'; /* strip the flags */
}
}
newpath =
get_new_path(new_mdir ? new_mdir : mdir, mfile, newflags, custom_flags, flags_sep);
g_free(mfile);
g_free(mdir);
g_free(custom_flags);
return newpath;
}
static gint64
get_file_size(const char* path)
static size_t
get_file_size(const std::string& path)
{
int rv;
struct stat statbuf;
rv = stat(path, &statbuf);
rv = ::stat(path.c_str(), &statbuf);
if (rv != 0) {
/* g_warning ("error: %s", g_strerror (errno)); */
return -1;
}
return (gint64)statbuf.st_size;
return static_cast<size_t>(statbuf.st_size);
}
static gboolean
msg_move_check_pre(const char* src, const char* dst, GError** err)
static Mu::Result<void>
msg_move_check_pre(const std::string& src, const std::string& dst)
{
gint size1, size2;
if (::access(src.c_str(), R_OK) != 0)
return Err(Error{Error::Code::File, "cannot read %s", src.c_str()});
if (!g_path_is_absolute(src))
return mu_util_g_set_error(err,
MU_ERROR_FILE,
"source is not an absolute path: '%s'",
src);
if (!g_path_is_absolute(dst))
return mu_util_g_set_error(err,
MU_ERROR_FILE,
"target is not an absolute path: '%s'",
dst);
if (access(src, R_OK) != 0)
return mu_util_g_set_error(err, MU_ERROR_FILE, "cannot read %s", src);
if (access(dst, F_OK) != 0)
return TRUE;
if (::access(dst.c_str(), F_OK) != 0)
return Ok();
/* target exist; we simply overwrite it, unless target has a different
* size. ignore the exceedingly rare case where have duplicate message
* file names with different content yet the same length. (md5 etc. is a
* bit slow) */
size1 = get_file_size(src);
size2 = get_file_size(dst);
if (size1 != size2)
return mu_util_g_set_error(err, MU_ERROR_FILE, "%s already exists", dst);
if (get_file_size(src) != get_file_size(dst))
return Err(Error{Error::Code::File, "%s already exists", dst.c_str()});
return TRUE;
return Ok();
}
static gboolean
msg_move_check_post(const char* src, const char* dst, GError** err)
static Mu::Result<void>
msg_move_check_post(const std::string& src, const std::string& dst)
{
/* double check -- is the target really there? */
if (access(dst, F_OK) != 0)
return mu_util_g_set_error(err,
MU_ERROR_FILE,
if (::access(dst.c_str(), F_OK) != 0)
return Err(Error{Error::Code::File,
"can't find target (%s->%s)",
src,
dst);
src.c_str(), dst.c_str()});
if (access(src, F_OK) == 0) {
if (g_strcmp0(src, dst) == 0) {
g_warning("moved %s to itself", src);
return TRUE;
if (::access(src.c_str(), F_OK) == 0) {
if (src == dst) {
g_warning("moved %s to itself", src.c_str());
}
/* this could happen if some other tool (for mail syncing) is
* interfering */
g_debug("the source is still there (%s->%s)", src, dst);
g_debug("the source is still there (%s->%s)", src.c_str(), dst.c_str());
}
return TRUE;
return Ok();
}
/* use GIO to move files; this is slower than rename() so only use
* this when needed: when moving across filesystems */
static gboolean
msg_move_g_file(const char* src, const char* dst, GError** err)
static Mu::Result<void>
msg_move_g_file(const std::string& src, const std::string& dst)
{
GFile * srcfile, *dstfile;
gboolean res;
GFile *srcfile{g_file_new_for_path(src.c_str())};
GFile *dstfile{g_file_new_for_path(dst.c_str())};
srcfile = g_file_new_for_path(src);
dstfile = g_file_new_for_path(dst);
res = g_file_move(srcfile, dstfile, G_FILE_COPY_NONE, NULL, NULL, NULL, err);
GError* err{};
auto res = g_file_move(srcfile, dstfile, G_FILE_COPY_NONE,
NULL, NULL, NULL, &err);
g_clear_object(&srcfile);
g_clear_object(&dstfile);
return res;
if (res)
return Ok();
else
return Err(Error{Error::Code::File, &err,
"error moving %s -> %s",
src.c_str(), dst.c_str()});
}
static gboolean
msg_move(const char* src, const char* dst, GError** err)
static Mu::Result<void>
msg_move(const std::string& src, const std::string& dst)
{
if (!msg_move_check_pre(src, dst, err))
return FALSE;
if (auto&& res = msg_move_check_pre(src, dst); !res)
return res;
if (rename(src, dst) == 0) /* seems it worked. */
return msg_move_check_post(src, dst, err);
if (::rename(src.c_str(), dst.c_str()) == 0) /* seems it worked; double-check */
return msg_move_check_post(src, dst);
if (errno != EXDEV) /* some unrecoverable error occurred */
return mu_util_g_set_error(err, MU_ERROR_FILE, "error moving %s -> %s", src, dst);
return Err(Error{Error::Code::File, "error moving %s -> %s",
src.c_str(), dst.c_str()});
/* he EXDEV case -- source and target live on different filesystems */
return msg_move_g_file(src, dst, err);
/* the EXDEV case -- source and target live on different filesystems */
return msg_move_g_file(src, dst);
}
char*
Mu::mu_maildir_move_message(const char* oldpath,
const char* targetmdir,
MuFlags newflags,
gboolean ignore_dups,
gboolean new_name,
GError** err)
Mu::Result<void>
Mu::mu_maildir_move_message(const std::string& oldpath,
const std::string& newpath,
bool ignore_dups)
{
char* newfullpath;
gboolean rv;
gboolean src_is_target;
g_return_val_if_fail(oldpath, FALSE);
/* first try *without* changing the name (as per new_name), since
* src_is_target shouldn't use a changed name */
newfullpath = mu_maildir_get_new_path(oldpath, targetmdir, newflags, FALSE);
if (!newfullpath) {
mu_util_g_set_error(err, MU_ERROR_FILE, "failed to determine targetpath");
return NULL;
if (oldpath == newpath) {
if (ignore_dups)
return Ok();
else
return Err(Error{Error::Code::InvalidArgument,
"target equals source"});
}
src_is_target = (g_strcmp0(oldpath, newfullpath) == 0);
if (!ignore_dups && src_is_target) {
mu_util_g_set_error(err,
MU_ERROR_FILE_TARGET_EQUALS_SOURCE,
"target equals source");
return NULL;
g_debug("moving %s --> %s", oldpath.c_str(), newpath.c_str());
return msg_move(oldpath, newpath);
}
/* if we generated file is not the same (modulo flags), create a fully
* new name in the new_name case */
if (!src_is_target && new_name) {
g_free(newfullpath);
newfullpath = mu_maildir_get_new_path(oldpath, targetmdir, newflags, new_name);
if (!newfullpath) {
mu_util_g_set_error(err, MU_ERROR_FILE, "failed to determine targetpath");
return NULL;
}
static std::string
reinvent_filename_base()
{
return format("%u.%08x%08x.%s",
static_cast<unsigned>(::time(NULL)),
g_random_int(),
static_cast<uint32_t>(g_get_monotonic_time()),
g_get_host_name());
}
if (!src_is_target) {
g_debug("moving %s (%s, %x, %d) --> %s",
oldpath,
targetmdir,
newflags,
new_name,
newfullpath);
rv = msg_move(oldpath, newfullpath, err);
if (!rv) {
g_free(newfullpath);
return NULL;
}
/**
* Determine the destination filename
*
* @param file a filename
* @param flags flags for the destination
* @param new_name whether to change the basename
*
* @return the destion filename.
*/
static std::string
determine_dst_filename(const std::string& file, MessageFlags flags,
bool new_name)
{
/* Recalculate a unique new base file name */
auto&& parts{message_file_parts(file)};
if (new_name)
parts.base = reinvent_filename_base();
/* for a New message, there are no flags etc.; so we only return the
* name sans suffix */
if (any_of(flags & MessageFlags::New))
return std::move(parts.base);
const auto flagstr{
message_flags_to_string(
message_flags_filter(
flags, MessageFlagCategory::Mailfile))};
return parts.base + parts.separator + "2," + flagstr;
}
return newfullpath;
/*
* sanity checks
*/
static Mu::Result<void>
check_determine_target_params (const std::string& old_path,
const std::string& root_maildir_path,
const std::string& target_maildir,
MessageFlags newflags)
{
if (!g_path_is_absolute(old_path.c_str()))
return Err(Error{Error::Code::File,
"old_path is not absolute (%s)", old_path.c_str()});
if (!g_path_is_absolute(root_maildir_path.c_str()))
return Err(Error{Error::Code::File,
"root maildir path is not absolute",
root_maildir_path.c_str()});
if (!target_maildir.empty() && target_maildir[0] != '/')
return Err(Error{Error::Code::File,
"target maildir must be empty or start with / (%s)",
target_maildir.c_str()});
if (old_path.find(root_maildir_path) != 0)
return Err(Error{Error::Code::File,
"old-path must be below root-maildir (%s) (%s)",
old_path.c_str(), root_maildir_path.c_str()});
if (any_of(newflags & MessageFlags::New) && newflags != MessageFlags::New)
return Err(Error{Error::Code::File,
"if ::New is specified, "
"it must be the only flag"});
return Ok();
}
Mu::Result<std::string>
Mu::mu_maildir_determine_target(const std::string& old_path,
const std::string& root_maildir_path,
const std::string& target_maildir,
MessageFlags newflags,
bool new_name)
{
/* sanity checks */
if (const auto checked{check_determine_target_params(
old_path, root_maildir_path, target_maildir, newflags)}; !checked)
return Err(Error{std::move(checked.error())});
/*
* this gets us the source maildir filesystem path, the directory
* in which new/ & cur/ lives, and the source file
*/
const auto src{base_message_dir_file(old_path)};
if (!src)
return Err(src.error());
const auto& [src_mdir, src_file, is_new] = *src;
/* if target_mdir is empty, we use the src_dir does not change
* (though cur/ maybe become new or vice-versa) */
const auto dst_mdir{target_maildir.empty() ? src_mdir :
root_maildir_path + target_maildir};
/* now calculate the message name (incl. its immediate parent dir) */
const auto dst_file{determine_dst_filename(src_file, newflags, new_name)};
/* and the complete path name. */
const auto subdir = std::invoke([&]()->std::string {
if (none_of(newflags & MessageFlags::New))
return "cur";
else
return "new";
});
return dst_mdir + G_DIR_SEPARATOR_S + subdir + G_DIR_SEPARATOR_S + dst_file;
}

156
lib/mu-maildir.hh
View File

@ -1,5 +1,5 @@
/*
** Copyright (C) 2008-2020 Dirk-Jan C. Binnema <djcb@djcbsoftware.nl>
** Copyright (C) 2008-2022 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
@ -20,106 +20,68 @@
#ifndef MU_MAILDIR_HH__
#define MU_MAILDIR_HH__
#include <string>
#include <optional>
#include <utils/mu-result.hh>
#include <glib.h>
#include <time.h>
#include <sys/types.h> /* for mode_t */
#include <utils/mu-util.h>
#include <mu-flags.hh>
#include <mu-message-flags.hh>
namespace Mu {
/**
* create a new maildir. if parts of the maildir already exists, those
* will simply be ignored. IOW, if you try to create the same maildir
* twice, the second will simply be a no-op (without any errors).
* Note, if the function fails 'halfway', it will *not* try to remove
* the parts the were created. it *will* create any parent dirs that
* are not yet existent.
* Create a new maildir. if parts of the maildir already exists, those will
* simply be ignored.
*
* IOW, if you try to create the same maildir twice, the second will simply be a
* no-op (without any errors). Note, if the function fails 'halfway', it will
* *not* try to remove the parts the were created. it *will* create any parent
* dirs that are not yet existent.
*
* @param path the path (missing components will be created, as in 'mkdir -p')
* @param mode the file mode (e.g., 0755)
* @param noindex add a .noindex file to the maildir, so it will be excluded
* from indexing by 'mu index'
* @param err if function returns FALSE, receives error
* information. err may be NULL.
*
* @return TRUE if creation succeeded (or already existed), FALSE otherwise
* @return a valid result (!!result) or an Error
*/
gboolean mu_maildir_mkdir(const char* path, mode_t mode, gboolean noindex, GError** err);
Result<void> mu_maildir_mkdir(const std::string& path, mode_t mode, bool noindex);
/**
* create a symbolic link to a mail message
* Create a symbolic link to a mail message
*
* @param src the full path to the source message
* @param targetpath the path to the target maildir; ie., *not*
* MyMaildir/cur, but just MyMaildir/. The function will figure out
* the correct subdir then.
* @param err if function returns FALSE, err may contain extra
* information. if err is NULL, does nothing
*
* @return
* @return a valid result (!!result) or an Error
*/
gboolean mu_maildir_link(const char* src, const char* targetpath, GError** err);
Result<void> mu_maildir_link(const std::string& src, const std::string& targetpath);
/**
* recursively delete all the symbolic links in a directory tree
* Recursively delete all the symbolic links in a directory tree
*
* @param dir top dir
* @param err if function returns FALSE, err may contain extra
* information. if err is NULL, does nothing
*
* @return TRUE if it worked, FALSE in case of error
* @return a valid result (!!result) or an Error
*/
gboolean mu_maildir_clear_links(const char* dir, GError** err);
Result<void> mu_maildir_clear_links(const std::string& dir);
/**
* whether the directory path ends in '/cur/' or '/new/'
*
* @param path some path
*/
gboolean mu_maildir_is_leaf_dir(const char* path);
/**
* get the Maildir flags from the full path of a mailfile. The flags
* are as specified in http://cr.yp.to/proto/maildir.html, plus
* MU_MSG_FLAG_NEW for new messages, ie the ones that live in
* new/. The flags are logically OR'ed. Note that the file does not
* have to exist; the flags are based on the path only.
* Get the Maildir flags from the full path of a mailfile. The flags are as
* specified in http://cr.yp.to/proto/maildir.html, plus MU_MSG_FLAG_NEW for new
* messages, ie the ones that live in new/. The flags are logically OR'ed. Note
* that the file does not have to exist; the flags are based on the path only.
*
* @param pathname of a mailfile; it does not have to refer to an
* actual message
*
* @return the flags, or MU_MSG_FILE_FLAG_UNKNOWN in case of error
* @return the message flags or an error
*/
MuFlags mu_maildir_get_flags_from_path(const char* pathname);
/**
* get the new pathname for a message, based on the old path and the
* new flags and (optionally) a new maildir. Note that
* setting/removing the MU_FLAG_NEW will change the directory in which
* a message lives. The flags are as specified in
* http://cr.yp.to/proto/maildir.html, plus MU_FLAG_NEW for new
* messages, ie the ones that live in new/. The flags are logically
* OR'ed. Note that the file does not have to exist; the flags are
* based on the path only.
*
*
* @param oldpath the old (current) full path to the message
* (including the filename)
* @param new_mdir the new maildir for this message, or NULL to keep
* it in the current one. The maildir is the absolute file system
* path, without the 'cur' or 'new'
* @param new_flags the new flags for this message
* @param new_name whether to create a new unique name, or keep the
* old one
*
* @return a new path name; use g_free when done with. NULL in case of
* error.
*/
char* mu_maildir_get_new_path(const char* oldpath,
const char* new_mdir,
MuFlags new_flags,
gboolean new_name) G_GNUC_WARN_UNUSED_RESULT;
Result<MessageFlags> mu_maildir_flags_from_path(const std::string& pathname);
/**
* get the maildir for a certain message path, ie, the path *before*
@ -127,38 +89,54 @@ char* mu_maildir_get_new_path(const char* oldpath,
*
* @param path path for some message
*
* @return the maildir (free with g_free), or NULL in case of error
* @return the maildir or an Error
*/
char* mu_maildir_get_maildir_from_path(const char* path) G_GNUC_WARN_UNUSED_RESULT;
Result<std::string> mu_maildir_from_path(const std::string& path);
/**
* move a message file to another maildir; the function returns the full path to
* the new message. if the target file already exists, it is overwritten.
* Move a message file to another maildir. If the target file already exists, it
* is overwritten.
*
* @param msgpath an absolute file system path to an existing message in an
* @param oldpath an absolute file system path to an existing message in an
* actual maildir
* @param targetmdir the target maildir; note that this the base-level
* Maildir, ie. /home/user/Maildir/archive, and must _not_ include the
* 'cur' or 'new' part. Note that the target maildir must be on the
* same filesystem. If you specify NULL for targetmdir, only the flags
* of the message are affected; note that this may still involve a
* moved to another directory (say, from new/ to cur/)
* @param flags to set for the target (influences the filename, path)
* @param ignore_dups whether to silently ignore the src=target case
* (and return TRUE)
* @param new_name whether to create a new unique name, or keep the
* old one
* @param newpath the absolete full path to the target file
* @param ignore_dups whether to silently ignore the src==target case
* (and return @true)
* @param err receives error information
*
* @return return the full path name of the target file (g_free) if
* the move succeeded, NULL otherwise
* @return * @return a valid result (!!result) or an Error
*/
char* mu_maildir_move_message(const char* oldpath,
const char* targetmdir,
MuFlags newflags,
gboolean ignore_dups,
gboolean new_name,
GError** err) G_GNUC_WARN_UNUSED_RESULT;
Result<void> mu_maildir_move_message(const std::string& oldpath,
const std::string& targetmdir,
bool ignore_dups);
/**
* Determine the target path for a to-be-moved message; i.e. this does not
* actually move the message, only calculate the path.
*
* @param old_path an absolute file system path to an existing message in an
* actual maildir
* @param root_maildir_path the absolete file system path under which
* all maidlirs live.
* @param target_maildir the target maildir; note that this the base-level
* Maildir, ie. /home/user/Maildir/archive, and must _not_ include the
* 'cur' or 'new' part. Note that the target maildir must be on the
* same filesystem. Can be empty if the message should not be moved to
* a different maildir; note that this may still involve a
* move to another directory (say, from new/ to cur/)
* @param flags to set for the target (influences the filename, path).
* @param new_name whether to change the basename of the file
* @param err receives error information
*
* @return Full path name of the target file or std::nullopt in case
* of error
*/
Result<std::string>
mu_maildir_determine_target(const std::string& old_path,
const std::string& root_maildir_path,
const std::string& target_maildir,
MessageFlags newflags,
bool new_name);
} // namespace Mu