quota-clone-plugin.c revision bb11a1957aefbd2a2edf7ae25af4032899c34c41
2058N/A/* Copyright (c) 2015-2017 Dovecot authors, see the included COPYING file */
2058N/A
2058N/A#include "lib.h"
2058N/A#include "module-context.h"
2058N/A#include "ioloop.h"
2058N/A#include "dict.h"
2058N/A#include "mail-storage-private.h"
2058N/A#include "quota.h"
2058N/A#include "quota-clone-plugin.h"
2058N/A
2058N/A/* If mailbox is kept open for this many milliseconds after quota update,
2058N/A flush quota-clone. */
2058N/A#define QUOTA_CLONE_FLUSH_DELAY_MSECS (10*1000)
2058N/A
2058N/A#define DICT_QUOTA_CLONE_PATH DICT_PATH_PRIVATE"quota/"
2058N/A#define DICT_QUOTA_CLONE_BYTES_PATH DICT_QUOTA_CLONE_PATH"storage"
2058N/A#define DICT_QUOTA_CLONE_COUNT_PATH DICT_QUOTA_CLONE_PATH"messages"
2058N/A
2058N/A#define QUOTA_CLONE_USER_CONTEXT(obj) \
2058N/A MODULE_CONTEXT(obj, quota_clone_user_module)
2058N/A#define QUOTA_CLONE_CONTEXT(obj) \
2058N/A MODULE_CONTEXT(obj, quota_clone_storage_module)
2058N/A
2058N/Astatic MODULE_CONTEXT_DEFINE_INIT(quota_clone_user_module,
2058N/A &mail_user_module_register);
2058N/Astatic MODULE_CONTEXT_DEFINE_INIT(quota_clone_storage_module,
2058N/A &mail_storage_module_register);
2058N/A
2058N/Astruct quota_clone_user {
2058N/A union mail_user_module_context module_ctx;
2058N/A struct dict *dict;
2058N/A bool quota_flushing;
2058N/A};
2058N/A
2058N/Astruct quota_clone_mailbox {
2058N/A union mailbox_module_context module_ctx;
2058N/A struct timeout *to_quota_flush;
2058N/A bool quota_changed;
2058N/A};
2058N/A
2058N/Astatic void quota_clone_flush_real(struct mailbox *box)
2058N/A{
2058N/A struct quota_clone_mailbox *qbox = QUOTA_CLONE_CONTEXT(box);
2058N/A struct quota_clone_user *quser =
2058N/A QUOTA_CLONE_USER_CONTEXT(box->storage->user);
2058N/A struct dict_transaction_context *trans;
2058N/A struct quota_root_iter *iter;
2058N/A struct quota_root *root;
2058N/A uint64_t bytes_value, count_value, limit;
2058N/A const char *error;
2058N/A enum quota_get_result bytes_res, count_res;
2058N/A
2058N/A /* we'll clone the first quota root */
2058N/A iter = quota_root_iter_init(box);
root = quota_root_iter_next(iter);
quota_root_iter_deinit(&iter);
if (root == NULL) {
/* no quota roots defined for this mailbox - ignore */
qbox->quota_changed = FALSE;
return;
}
/* get new values first */
bytes_res = quota_get_resource(root, "", QUOTA_NAME_STORAGE_BYTES,
&bytes_value, &limit, &error);
if (bytes_res == QUOTA_GET_RESULT_INTERNAL_ERROR) {
i_error("quota_clone_plugin: "
"Failed to get quota resource "QUOTA_NAME_STORAGE_BYTES": %s",
error);
return;
}
count_res = quota_get_resource(root, "", QUOTA_NAME_MESSAGES,
&count_value, &limit, &error);
if (count_res == QUOTA_GET_RESULT_INTERNAL_ERROR) {
i_error("quota_clone_plugin: "
"Failed to get quota resource "QUOTA_NAME_MESSAGES": %s",
error);
return;
}
if (bytes_res == QUOTA_GET_RESULT_UNKNOWN_RESOURCE &&
count_res == QUOTA_GET_RESULT_UNKNOWN_RESOURCE) {
/* quota resources don't exist - no point in updating it */
return;
}
/* Then update the resources that exist. The resources' existence can't
change unless the quota backend is changed, so we don't worry about
the special case of lookup changing from
RESULT_LIMITED/RESULT_UNLIMITED to RESULT_UNKNOWN_RESOURCE, which
leaves the old value unchanged. */
trans = dict_transaction_begin(quser->dict);
if (bytes_res == QUOTA_GET_RESULT_LIMITED ||
bytes_res == QUOTA_GET_RESULT_UNLIMITED) {
dict_set(trans, DICT_QUOTA_CLONE_BYTES_PATH,
t_strdup_printf("%"PRIu64, bytes_value));
}
if (count_res == QUOTA_GET_RESULT_LIMITED ||
count_res == QUOTA_GET_RESULT_UNLIMITED) {
dict_set(trans, DICT_QUOTA_CLONE_COUNT_PATH,
t_strdup_printf("%"PRIu64, count_value));
}
if (dict_transaction_commit(&trans, &error) < 0)
i_error("quota_clone_plugin: Failed to commit dict update: %s", error);
else
qbox->quota_changed = FALSE;
}
static void quota_clone_flush(struct mailbox *box)
{
struct quota_clone_mailbox *qbox = QUOTA_CLONE_CONTEXT(box);
struct quota_clone_user *quser =
QUOTA_CLONE_USER_CONTEXT(box->storage->user);
timeout_remove(&qbox->to_quota_flush);
if (quser->quota_flushing) {
/* recursing back from quota recalculation */
} else if (qbox->quota_changed) {
quser->quota_flushing = TRUE;
quota_clone_flush_real(box);
quser->quota_flushing = FALSE;
}
}
static void quota_clone_changed(struct mailbox *box)
{
struct quota_clone_mailbox *qbox = QUOTA_CLONE_CONTEXT(box);
qbox->quota_changed = TRUE;
if (qbox->to_quota_flush == NULL) {
qbox->to_quota_flush = timeout_add(QUOTA_CLONE_FLUSH_DELAY_MSECS,
quota_clone_flush, box);
}
}
static int quota_clone_save_finish(struct mail_save_context *ctx)
{
struct quota_clone_mailbox *qbox =
QUOTA_CLONE_CONTEXT(ctx->transaction->box);
quota_clone_changed(ctx->transaction->box);
return qbox->module_ctx.super.save_finish(ctx);
}
static int
quota_clone_copy(struct mail_save_context *ctx, struct mail *mail)
{
struct quota_clone_mailbox *qbox =
QUOTA_CLONE_CONTEXT(ctx->transaction->box);
quota_clone_changed(ctx->transaction->box);
return qbox->module_ctx.super.copy(ctx, mail);
}
static void
quota_clone_mailbox_sync_notify(struct mailbox *box, uint32_t uid,
enum mailbox_sync_type sync_type)
{
struct quota_clone_mailbox *qbox = QUOTA_CLONE_CONTEXT(box);
if (qbox->module_ctx.super.sync_notify != NULL)
qbox->module_ctx.super.sync_notify(box, uid, sync_type);
if (sync_type == MAILBOX_SYNC_TYPE_EXPUNGE)
quota_clone_changed(box);
}
static void quota_clone_mailbox_close(struct mailbox *box)
{
struct quota_clone_mailbox *qbox = QUOTA_CLONE_CONTEXT(box);
qbox->module_ctx.super.close(box);
quota_clone_flush(box);
}
static void quota_clone_mailbox_allocated(struct mailbox *box)
{
struct quota_clone_user *quser =
QUOTA_CLONE_USER_CONTEXT(box->storage->user);
struct mailbox_vfuncs *v = box->vlast;
struct quota_clone_mailbox *qbox;
if (quser == NULL)
return;
qbox = p_new(box->pool, struct quota_clone_mailbox, 1);
qbox->module_ctx.super = *v;
box->vlast = &qbox->module_ctx.super;
v->save_finish = quota_clone_save_finish;
v->copy = quota_clone_copy;
v->sync_notify = quota_clone_mailbox_sync_notify;
v->close = quota_clone_mailbox_close;
MODULE_CONTEXT_SET(box, quota_clone_storage_module, qbox);
}
static void quota_clone_mail_user_deinit(struct mail_user *user)
{
struct quota_clone_user *quser = QUOTA_CLONE_USER_CONTEXT(user);
dict_deinit(&quser->dict);
quser->module_ctx.super.deinit(user);
}
static void quota_clone_mail_user_created(struct mail_user *user)
{
struct quota_clone_user *quser;
struct mail_user_vfuncs *v = user->vlast;
struct dict_settings dict_set;
struct dict *dict;
const char *uri, *error;
uri = mail_user_plugin_getenv(user, "quota_clone_dict");
if (uri == NULL || uri[0] == '\0') {
if (user->mail_debug) {
i_debug("The quota_clone_dict setting is missing from configuration");
}
return;
}
i_zero(&dict_set);
dict_set.username = user->username;
dict_set.base_dir = user->set->base_dir;
(void)mail_user_get_home(user, &dict_set.home_dir);
if (dict_init(uri, &dict_set, &dict, &error) < 0) {
i_error("quota_clone_dict: Failed to initialize '%s': %s",
uri, error);
return;
}
quser = p_new(user->pool, struct quota_clone_user, 1);
quser->module_ctx.super = *v;
user->vlast = &quser->module_ctx.super;
v->deinit = quota_clone_mail_user_deinit;
quser->dict = dict;
MODULE_CONTEXT_SET(user, quota_clone_user_module, quser);
}
static struct mail_storage_hooks quota_clone_mail_storage_hooks = {
.mailbox_allocated = quota_clone_mailbox_allocated,
.mail_user_created = quota_clone_mail_user_created
};
void quota_clone_plugin_init(struct module *module ATTR_UNUSED)
{
mail_storage_hooks_add(module, &quota_clone_mail_storage_hooks);
}
void quota_clone_plugin_deinit(void)
{
mail_storage_hooks_remove(&quota_clone_mail_storage_hooks);
}
const char *quota_clone_plugin_dependencies[] = { "quota", NULL };