imap-quota-plugin.c revision 2c719bcb92302f45df4badb71d1d97f57235d0cc
22daenzerorama/* Copyright (c) 2005-2017 Dovecot authors, see the included COPYING file */
22daenzerorama
22daenzerorama#include "imap-common.h"
22daenzerorama#include "str.h"
22daenzerorama#include "ostream.h"
22daenzerorama#include "imap-quote.h"
22daenzerorama#include "mail-namespace.h"
22daenzerorama#include "imap-commands.h"
22daenzerorama#include "quota.h"
22daenzerorama#include "quota-plugin.h"
22daenzerorama#include "imap-quota-plugin.h"
22daenzerorama
22daenzerorama
22daenzerorama#define QUOTA_USER_SEPARATOR ':'
22daenzerorama
22daenzeroramaconst char *imap_quota_plugin_version = DOVECOT_ABI_VERSION;
22daenzerorama
22daenzeroramastatic struct module *imap_quota_module;
22daenzeroramastatic imap_client_created_func_t *next_hook_client_created;
22daenzerorama
22daenzeroramastatic const char *
22daenzeroramaimap_quota_root_get_name(struct mail_user *user, struct mail_user *owner,
22daenzerorama struct quota_root *root)
22daenzerorama{
22daenzerorama const char *name;
22daenzerorama
22daenzerorama name = quota_root_get_name(root);
22daenzerorama if (user == owner || owner == NULL)
22daenzerorama return name;
22daenzerorama return t_strdup_printf("%s%c%s", owner->username,
22daenzerorama QUOTA_USER_SEPARATOR, name);
22daenzerorama}
22daenzerorama
22daenzeroramastatic void
22daenzeroramaquota_reply_write(string_t *str, struct mail_user *user,
22daenzerorama struct mail_user *owner, struct quota_root *root)
22daenzerorama{
22daenzerorama const char *name, *const *list;
22daenzerorama unsigned int i;
22daenzerorama uint64_t value, limit;
22daenzerorama int ret = 0;
22daenzerorama
22daenzerorama str_append(str, "* QUOTA ");
22daenzerorama name = imap_quota_root_get_name(user, owner, root);
22daenzerorama imap_append_astring(str, name);
22daenzerorama
22daenzerorama str_append(str, " (");
22daenzerorama list = quota_root_get_resources(root);
22daenzerorama for (i = 0; *list != NULL; list++) {
22daenzerorama ret = quota_get_resource(root, "", *list, &value, &limit);
22daenzerorama if (ret < 0)
22daenzerorama break;
22daenzerorama if (ret > 0) {
22daenzerorama if (i > 0)
22daenzerorama str_append_c(str, ' ');
22daenzerorama str_printfa(str, "%s %llu %llu", *list,
22daenzerorama (unsigned long long)value,
22daenzerorama (unsigned long long)limit);
22daenzerorama i++;
22daenzerorama }
22daenzerorama }
22daenzerorama str_append(str, ")\r\n");
22daenzerorama
22daenzerorama if (ret < 0)
22daenzerorama str_append(str, "* BAD Internal quota calculation error\r\n");
22daenzerorama}
22daenzerorama
22daenzeroramastatic bool cmd_getquotaroot(struct client_command_context *cmd)
22daenzerorama{
22daenzerorama struct client *client = cmd->client;
22daenzerorama struct quota_user *quser = QUOTA_USER_CONTEXT(client->user);
22daenzerorama struct mail_namespace *ns;
22daenzerorama struct mailbox *box;
22daenzerorama struct quota_root_iter *iter;
22daenzerorama struct quota_root *root;
22daenzerorama const char *mailbox, *orig_mailbox, *name;
22daenzerorama string_t *quotaroot_reply, *quota_reply;
22daenzerorama
22daenzerorama /* <mailbox> */
22daenzerorama if (!client_read_string_args(cmd, 1, &mailbox))
22daenzerorama return FALSE;
22daenzerorama orig_mailbox = mailbox;
22daenzerorama
22daenzerorama ns = client_find_namespace(cmd, &mailbox);
22daenzerorama if (ns == NULL)
22daenzerorama return TRUE;
22daenzerorama
22daenzerorama if (quser == NULL) {
22daenzerorama client_send_tagline(cmd, "OK No quota.");
22daenzerorama return TRUE;
22daenzerorama }
22daenzerorama if (ns->owner != NULL && ns->owner != client->user) {
22daenzerorama client_send_tagline(cmd, "NO Not showing other users' quota.");
22daenzerorama return TRUE;
22daenzerorama }
22daenzerorama
22daenzerorama box = mailbox_alloc(ns->list, mailbox, MAILBOX_FLAG_READONLY);
22daenzerorama
22daenzerorama /* build QUOTAROOT reply and QUOTA reply for all quota roots */
22daenzerorama quotaroot_reply = t_str_new(128);
22daenzerorama quota_reply = t_str_new(256);
22daenzerorama str_append(quotaroot_reply, "* QUOTAROOT ");
22daenzerorama imap_append_astring(quotaroot_reply, orig_mailbox);
22daenzerorama
22daenzerorama iter = quota_root_iter_init(box);
22daenzerorama while ((root = quota_root_iter_next(iter)) != NULL) {
22daenzerorama if (quota_root_is_hidden(root))
22daenzerorama continue;
22daenzerorama str_append_c(quotaroot_reply, ' ');
22daenzerorama name = imap_quota_root_get_name(client->user, ns->owner, root);
22daenzerorama imap_append_astring(quotaroot_reply, name);
22daenzerorama
22daenzerorama quota_reply_write(quota_reply, client->user, ns->owner, root);
22daenzerorama }
22daenzerorama quota_root_iter_deinit(&iter);
22daenzerorama mailbox_free(&box);
22daenzerorama
22daenzerorama /* send replies */
22daenzerorama if (str_len(quota_reply) == 0)
client_send_tagline(cmd, "OK No quota.");
else {
client_send_line(client, str_c(quotaroot_reply));
o_stream_nsend(client->output, str_data(quota_reply),
str_len(quota_reply));
client_send_tagline(cmd, "OK Getquotaroot completed.");
}
return TRUE;
}
static bool
parse_quota_root(struct mail_user *user, const char *root_name,
struct mail_user **owner_r, struct quota_root **root_r)
{
const char *p;
*owner_r = user;
*root_r = quota_root_lookup(user, root_name);
if (*root_r != NULL || !user->admin)
return *root_r != NULL;
/* we're an admin. see if there's a quota root for another user. */
p = strchr(root_name, QUOTA_USER_SEPARATOR);
if (p != NULL) {
*owner_r = mail_user_find(user, t_strdup_until(root_name, p));
*root_r = *owner_r == NULL ? NULL :
quota_root_lookup(*owner_r, p + 1);
}
return *root_r != NULL;
}
static bool cmd_getquota(struct client_command_context *cmd)
{
struct mail_user *owner;
struct quota_root *root;
const char *root_name;
string_t *quota_reply;
/* <quota root> */
if (!client_read_string_args(cmd, 1, &root_name))
return FALSE;
if (!parse_quota_root(cmd->client->user, root_name, &owner, &root)) {
client_send_tagline(cmd, "NO Quota root doesn't exist.");
return TRUE;
}
quota_reply = t_str_new(128);
quota_reply_write(quota_reply, cmd->client->user, owner, root);
o_stream_nsend(cmd->client->output, str_data(quota_reply),
str_len(quota_reply));
client_send_tagline(cmd, "OK Getquota completed.");
return TRUE;
}
static bool cmd_setquota(struct client_command_context *cmd)
{
struct quota_root *root;
struct mail_user *owner;
const struct imap_arg *args, *list_args;
const char *root_name, *name, *value_str, *error;
uint64_t value;
/* <quota root> <resource limits> */
if (!client_read_args(cmd, 2, 0, &args))
return FALSE;
if (!imap_arg_get_astring(&args[0], &root_name) ||
!imap_arg_get_list(&args[1], &list_args)) {
client_send_command_error(cmd, "Invalid arguments.");
return TRUE;
}
if (!cmd->client->user->admin) {
client_send_tagline(cmd, "NO Quota can be changed only by admin.");
return TRUE;
}
if (!parse_quota_root(cmd->client->user, root_name, &owner, &root)) {
client_send_tagline(cmd, "NO Quota root doesn't exist.");
return TRUE;
}
for (; !IMAP_ARG_IS_EOL(list_args); list_args += 2) {
if (!imap_arg_get_atom(&list_args[0], &name) ||
!imap_arg_get_atom(&list_args[1], &value_str) ||
str_to_uint64(value_str, &value) < 0) {
client_send_command_error(cmd, "Invalid arguments.");
return TRUE;
}
if (quota_set_resource(root, name, value, &error) < 0) {
client_send_command_error(cmd, error);
return TRUE;
}
}
client_send_tagline(cmd, "OK Setquota completed.");
return TRUE;
}
static void imap_quota_client_created(struct client **client)
{
if (mail_user_is_plugin_loaded((*client)->user, imap_quota_module))
client_add_capability(*client, "QUOTA");
if (next_hook_client_created != NULL)
next_hook_client_created(client);
}
void imap_quota_plugin_init(struct module *module)
{
command_register("GETQUOTAROOT", cmd_getquotaroot, 0);
command_register("GETQUOTA", cmd_getquota, 0);
command_register("SETQUOTA", cmd_setquota, 0);
imap_quota_module = module;
next_hook_client_created =
imap_client_created_hook_set(imap_quota_client_created);
}
void imap_quota_plugin_deinit(void)
{
command_unregister("GETQUOTAROOT");
command_unregister("GETQUOTA");
command_unregister("SETQUOTA");
imap_client_created_hook_set(next_hook_client_created);
}
const char *imap_quota_plugin_dependencies[] = { "quota", NULL };
const char imap_quota_plugin_binary_dependency[] = "imap";