mail-storage-hooks.c revision da5c7f6eb2250089c74e00d3dc6284d43949f744
e59faf65ce864fe95dc00f5d52b8323cdbd0608aTimo Sirainen/* Copyright (c) 2009-2017 Dovecot authors, see the included COPYING file */
315ce5be539bfe8bc7777ab0654499c49583cea2Timo Sirainen
315ce5be539bfe8bc7777ab0654499c49583cea2Timo Sirainen#include "lib.h"
315ce5be539bfe8bc7777ab0654499c49583cea2Timo Sirainen#include "array.h"
315ce5be539bfe8bc7777ab0654499c49583cea2Timo Sirainen#include "llist.h"
dd3ccdbb29dad006f7781ea138a5ba39727963c4Timo Sirainen#include "module-dir.h"
a338794c56fc9674121e262fcb67c3dc1da31436Timo Sirainen#include "mail-user.h"
419be6cd72f6e11705576bbba683b29c32eaa762Timo Sirainen#include "mail-namespace.h"
315ce5be539bfe8bc7777ab0654499c49583cea2Timo Sirainen#include "mail-storage-private.h"
eed03830015b7138b9d4522e72bef650aa24b45fTimo Sirainen#include "mailbox-list-private.h"
dd3ccdbb29dad006f7781ea138a5ba39727963c4Timo Sirainen
c4390dad33b03dd51ba2a475f550347c86ebdb9aTimo Sirainenstruct mail_storage_module_hooks {
dd3ccdbb29dad006f7781ea138a5ba39727963c4Timo Sirainen struct module *module;
c2ebc8f28b5504f280cd5d4adfe57ed70f9a7d83Timo Sirainen const struct mail_storage_hooks *hooks;
eed03830015b7138b9d4522e72bef650aa24b45fTimo Sirainen bool forced;
eed03830015b7138b9d4522e72bef650aa24b45fTimo Sirainen};
c2ebc8f28b5504f280cd5d4adfe57ed70f9a7d83Timo Sirainen
315ce5be539bfe8bc7777ab0654499c49583cea2Timo Sirainenstruct hook_stack {
315ce5be539bfe8bc7777ab0654499c49583cea2Timo Sirainen struct hook_stack *prev, *next;
315ce5be539bfe8bc7777ab0654499c49583cea2Timo Sirainen
458acd7b39c84bae0d18c36ff9ddff9a49b4ae4aTimo Sirainen /* Pointer to vfuncs struct. This assumes that a struct containing
78a5b3e697af5db96fe0dffed600b0d6370bb8e5Timo Sirainen function pointers equals to an array of function pointers. Not
315ce5be539bfe8bc7777ab0654499c49583cea2Timo Sirainen ANSI-C, but should work in all OSes supported by Dovecot. Much
315ce5be539bfe8bc7777ab0654499c49583cea2Timo Sirainen easier anyway than doing this work manually.. */
315ce5be539bfe8bc7777ab0654499c49583cea2Timo Sirainen void (**vfuncs)();
315ce5be539bfe8bc7777ab0654499c49583cea2Timo Sirainen /* nonzero in the areas where vfuncs has been changed */
c2ebc8f28b5504f280cd5d4adfe57ed70f9a7d83Timo Sirainen void (**mask)();
315ce5be539bfe8bc7777ab0654499c49583cea2Timo Sirainen};
c2ebc8f28b5504f280cd5d4adfe57ed70f9a7d83Timo Sirainen
c2ebc8f28b5504f280cd5d4adfe57ed70f9a7d83Timo Sirainenstruct hook_build_context {
c2ebc8f28b5504f280cd5d4adfe57ed70f9a7d83Timo Sirainen pool_t pool;
3b22894b8805b186c73d8b754001e8d7e944be85Timo Sirainen /* size of the vfuncs struct */
3b22894b8805b186c73d8b754001e8d7e944be85Timo Sirainen size_t size;
3b22894b8805b186c73d8b754001e8d7e944be85Timo Sirainen /* number of function pointers in the struct */
315ce5be539bfe8bc7777ab0654499c49583cea2Timo Sirainen unsigned int count;
eed0a07ecb946ec9d021f5b413fb33eb36e135fdTimo Sirainen
eed0a07ecb946ec9d021f5b413fb33eb36e135fdTimo Sirainen struct hook_stack *head, *tail;
eed03830015b7138b9d4522e72bef650aa24b45fTimo Sirainen};
315ce5be539bfe8bc7777ab0654499c49583cea2Timo Sirainen
eed03830015b7138b9d4522e72bef650aa24b45fTimo Sirainenstatic ARRAY(struct mail_storage_module_hooks) module_hooks = ARRAY_INIT;
eed03830015b7138b9d4522e72bef650aa24b45fTimo Sirainenstatic ARRAY(const struct mail_storage_hooks *) internal_hooks = ARRAY_INIT;
eed03830015b7138b9d4522e72bef650aa24b45fTimo Sirainen
89502bb187e8285b2a155559894ca80374ac3ae7Timo Sirainenvoid mail_storage_hooks_init(void)
eed03830015b7138b9d4522e72bef650aa24b45fTimo Sirainen{
eed03830015b7138b9d4522e72bef650aa24b45fTimo Sirainen if (!array_is_created(&module_hooks))
eed03830015b7138b9d4522e72bef650aa24b45fTimo Sirainen i_array_init(&module_hooks, 32);
eed03830015b7138b9d4522e72bef650aa24b45fTimo Sirainen i_array_init(&internal_hooks, 8);
eed03830015b7138b9d4522e72bef650aa24b45fTimo Sirainen}
eed03830015b7138b9d4522e72bef650aa24b45fTimo Sirainen
eed03830015b7138b9d4522e72bef650aa24b45fTimo Sirainenvoid mail_storage_hooks_deinit(void)
eed03830015b7138b9d4522e72bef650aa24b45fTimo Sirainen{
eed03830015b7138b9d4522e72bef650aa24b45fTimo Sirainen /* allow calling this even if mail_storage_hooks_init() hasn't been
eed03830015b7138b9d4522e72bef650aa24b45fTimo Sirainen called, because e.g. doveadm plugins could call
eed03830015b7138b9d4522e72bef650aa24b45fTimo Sirainen mail_storage_hooks_add() even though mail storage is never
eed03830015b7138b9d4522e72bef650aa24b45fTimo Sirainen initialized. */
eed03830015b7138b9d4522e72bef650aa24b45fTimo Sirainen if (array_is_created(&internal_hooks))
eed03830015b7138b9d4522e72bef650aa24b45fTimo Sirainen array_free(&internal_hooks);
eed03830015b7138b9d4522e72bef650aa24b45fTimo Sirainen if (array_is_created(&module_hooks))
eed03830015b7138b9d4522e72bef650aa24b45fTimo Sirainen array_free(&module_hooks);
eed03830015b7138b9d4522e72bef650aa24b45fTimo Sirainen}
eed03830015b7138b9d4522e72bef650aa24b45fTimo Sirainen
eed03830015b7138b9d4522e72bef650aa24b45fTimo Sirainenvoid mail_storage_hooks_add(struct module *module,
eed03830015b7138b9d4522e72bef650aa24b45fTimo Sirainen const struct mail_storage_hooks *hooks)
eed03830015b7138b9d4522e72bef650aa24b45fTimo Sirainen{
eed03830015b7138b9d4522e72bef650aa24b45fTimo Sirainen struct mail_storage_module_hooks new_hook;
eed03830015b7138b9d4522e72bef650aa24b45fTimo Sirainen
eed03830015b7138b9d4522e72bef650aa24b45fTimo Sirainen i_zero(&new_hook);
315ce5be539bfe8bc7777ab0654499c49583cea2Timo Sirainen new_hook.module = module;
315ce5be539bfe8bc7777ab0654499c49583cea2Timo Sirainen new_hook.hooks = hooks;
315ce5be539bfe8bc7777ab0654499c49583cea2Timo Sirainen
315ce5be539bfe8bc7777ab0654499c49583cea2Timo Sirainen /* allow adding hooks before mail_storage_hooks_init() */
315ce5be539bfe8bc7777ab0654499c49583cea2Timo Sirainen if (!array_is_created(&module_hooks))
eed03830015b7138b9d4522e72bef650aa24b45fTimo Sirainen i_array_init(&module_hooks, 32);
eed03830015b7138b9d4522e72bef650aa24b45fTimo Sirainen array_append(&module_hooks, &new_hook, 1);
315ce5be539bfe8bc7777ab0654499c49583cea2Timo Sirainen}
315ce5be539bfe8bc7777ab0654499c49583cea2Timo Sirainen
315ce5be539bfe8bc7777ab0654499c49583cea2Timo Sirainenvoid mail_storage_hooks_add_forced(struct module *module,
315ce5be539bfe8bc7777ab0654499c49583cea2Timo Sirainen const struct mail_storage_hooks *hooks)
315ce5be539bfe8bc7777ab0654499c49583cea2Timo Sirainen{
65514ab6ccc1889e1667211fddb0cca4b51017dfTimo Sirainen struct mail_storage_module_hooks *hook;
315ce5be539bfe8bc7777ab0654499c49583cea2Timo Sirainen
315ce5be539bfe8bc7777ab0654499c49583cea2Timo Sirainen mail_storage_hooks_add(module, hooks);
315ce5be539bfe8bc7777ab0654499c49583cea2Timo Sirainen hook = array_idx_modifiable(&module_hooks,
315ce5be539bfe8bc7777ab0654499c49583cea2Timo Sirainen array_count(&module_hooks)-1);
315ce5be539bfe8bc7777ab0654499c49583cea2Timo Sirainen hook->forced = TRUE;
315ce5be539bfe8bc7777ab0654499c49583cea2Timo Sirainen}
315ce5be539bfe8bc7777ab0654499c49583cea2Timo Sirainen
65514ab6ccc1889e1667211fddb0cca4b51017dfTimo Sirainenvoid mail_storage_hooks_remove(const struct mail_storage_hooks *hooks)
ad5130b3afda4cf30e6272d96d818f84d3ae4e55Timo Sirainen{
315ce5be539bfe8bc7777ab0654499c49583cea2Timo Sirainen const struct mail_storage_module_hooks *module_hook;
315ce5be539bfe8bc7777ab0654499c49583cea2Timo Sirainen unsigned int idx = UINT_MAX;
315ce5be539bfe8bc7777ab0654499c49583cea2Timo Sirainen
315ce5be539bfe8bc7777ab0654499c49583cea2Timo Sirainen array_foreach(&module_hooks, module_hook) {
315ce5be539bfe8bc7777ab0654499c49583cea2Timo Sirainen if (module_hook->hooks == hooks) {
315ce5be539bfe8bc7777ab0654499c49583cea2Timo Sirainen idx = array_foreach_idx(&module_hooks, module_hook);
ad5130b3afda4cf30e6272d96d818f84d3ae4e55Timo Sirainen break;
c2ebc8f28b5504f280cd5d4adfe57ed70f9a7d83Timo Sirainen }
e93ab1b206e3792a8dabc460ad2ee60aaf6830b1Timo Sirainen }
c2ebc8f28b5504f280cd5d4adfe57ed70f9a7d83Timo Sirainen i_assert(idx != UINT_MAX);
e93ab1b206e3792a8dabc460ad2ee60aaf6830b1Timo Sirainen
c2ebc8f28b5504f280cd5d4adfe57ed70f9a7d83Timo Sirainen array_delete(&module_hooks, idx, 1);
65514ab6ccc1889e1667211fddb0cca4b51017dfTimo Sirainen}
65514ab6ccc1889e1667211fddb0cca4b51017dfTimo Sirainen
65514ab6ccc1889e1667211fddb0cca4b51017dfTimo Sirainenvoid mail_storage_hooks_add_internal(const struct mail_storage_hooks *hooks)
65514ab6ccc1889e1667211fddb0cca4b51017dfTimo Sirainen{
315ce5be539bfe8bc7777ab0654499c49583cea2Timo Sirainen array_append(&internal_hooks, &hooks, 1);
315ce5be539bfe8bc7777ab0654499c49583cea2Timo Sirainen}
315ce5be539bfe8bc7777ab0654499c49583cea2Timo Sirainen
315ce5be539bfe8bc7777ab0654499c49583cea2Timo Sirainenvoid mail_storage_hooks_remove_internal(const struct mail_storage_hooks *hooks)
315ce5be539bfe8bc7777ab0654499c49583cea2Timo Sirainen{
315ce5be539bfe8bc7777ab0654499c49583cea2Timo Sirainen const struct mail_storage_hooks *const *old_hooks;
315ce5be539bfe8bc7777ab0654499c49583cea2Timo Sirainen unsigned int idx = UINT_MAX;
315ce5be539bfe8bc7777ab0654499c49583cea2Timo Sirainen
315ce5be539bfe8bc7777ab0654499c49583cea2Timo Sirainen array_foreach(&internal_hooks, old_hooks) {
c2ebc8f28b5504f280cd5d4adfe57ed70f9a7d83Timo Sirainen if (*old_hooks == hooks) {
c2ebc8f28b5504f280cd5d4adfe57ed70f9a7d83Timo Sirainen idx = array_foreach_idx(&internal_hooks, old_hooks);
c2ebc8f28b5504f280cd5d4adfe57ed70f9a7d83Timo Sirainen break;
c2ebc8f28b5504f280cd5d4adfe57ed70f9a7d83Timo Sirainen }
c2ebc8f28b5504f280cd5d4adfe57ed70f9a7d83Timo Sirainen }
eed0a07ecb946ec9d021f5b413fb33eb36e135fdTimo Sirainen i_assert(idx != UINT_MAX);
c2ebc8f28b5504f280cd5d4adfe57ed70f9a7d83Timo Sirainen
c2ebc8f28b5504f280cd5d4adfe57ed70f9a7d83Timo Sirainen array_delete(&internal_hooks, idx, 1);
c2ebc8f28b5504f280cd5d4adfe57ed70f9a7d83Timo Sirainen}
c2ebc8f28b5504f280cd5d4adfe57ed70f9a7d83Timo Sirainen
c2ebc8f28b5504f280cd5d4adfe57ed70f9a7d83Timo Sirainenstatic int
c2ebc8f28b5504f280cd5d4adfe57ed70f9a7d83Timo Sirainenmail_storage_module_hooks_cmp(const struct mail_storage_module_hooks *h1,
c2ebc8f28b5504f280cd5d4adfe57ed70f9a7d83Timo Sirainen const struct mail_storage_module_hooks *h2)
c2ebc8f28b5504f280cd5d4adfe57ed70f9a7d83Timo Sirainen{
c2ebc8f28b5504f280cd5d4adfe57ed70f9a7d83Timo Sirainen const char *s1 = h1->module->path, *s2 = h2->module->path;
c2ebc8f28b5504f280cd5d4adfe57ed70f9a7d83Timo Sirainen const char *p;
c2ebc8f28b5504f280cd5d4adfe57ed70f9a7d83Timo Sirainen
c2ebc8f28b5504f280cd5d4adfe57ed70f9a7d83Timo Sirainen p = strrchr(s1, '/');
c2ebc8f28b5504f280cd5d4adfe57ed70f9a7d83Timo Sirainen if (p != NULL) s1 = p+1;
c2ebc8f28b5504f280cd5d4adfe57ed70f9a7d83Timo Sirainen p = strrchr(s2, '/');
c2ebc8f28b5504f280cd5d4adfe57ed70f9a7d83Timo Sirainen if (p != NULL) s2 = p+1;
eed0a07ecb946ec9d021f5b413fb33eb36e135fdTimo Sirainen
c2ebc8f28b5504f280cd5d4adfe57ed70f9a7d83Timo Sirainen if (strncmp(s1, "lib", 3) == 0)
eed0a07ecb946ec9d021f5b413fb33eb36e135fdTimo Sirainen s1 += 3;
eed0a07ecb946ec9d021f5b413fb33eb36e135fdTimo Sirainen if (strncmp(s2, "lib", 3) == 0)
eed0a07ecb946ec9d021f5b413fb33eb36e135fdTimo Sirainen s2 += 3;
eed0a07ecb946ec9d021f5b413fb33eb36e135fdTimo Sirainen
eed0a07ecb946ec9d021f5b413fb33eb36e135fdTimo Sirainen return strcmp(s1, s2);
eed0a07ecb946ec9d021f5b413fb33eb36e135fdTimo Sirainen}
eed0a07ecb946ec9d021f5b413fb33eb36e135fdTimo Sirainen
eed0a07ecb946ec9d021f5b413fb33eb36e135fdTimo Sirainenstatic void mail_user_add_plugin_hooks(struct mail_user *user)
eed0a07ecb946ec9d021f5b413fb33eb36e135fdTimo Sirainen{
eed0a07ecb946ec9d021f5b413fb33eb36e135fdTimo Sirainen const struct mail_storage_module_hooks *module_hook;
eed0a07ecb946ec9d021f5b413fb33eb36e135fdTimo Sirainen ARRAY(struct mail_storage_module_hooks) tmp_hooks;
eed0a07ecb946ec9d021f5b413fb33eb36e135fdTimo Sirainen const char *const *plugins, *name;
eed0a07ecb946ec9d021f5b413fb33eb36e135fdTimo Sirainen
eed0a07ecb946ec9d021f5b413fb33eb36e135fdTimo Sirainen /* first get all hooks wanted by the user */
d2a2e0b6d302c17c33638a6fd48bd665a1c81e46Timo Sirainen t_array_init(&tmp_hooks, array_count(&module_hooks));
d2a2e0b6d302c17c33638a6fd48bd665a1c81e46Timo Sirainen plugins = t_strsplit_spaces(user->set->mail_plugins, ", ");
c2ebc8f28b5504f280cd5d4adfe57ed70f9a7d83Timo Sirainen array_foreach(&module_hooks, module_hook) {
c2ebc8f28b5504f280cd5d4adfe57ed70f9a7d83Timo Sirainen if (!module_hook->forced) {
c2ebc8f28b5504f280cd5d4adfe57ed70f9a7d83Timo Sirainen name = module_get_plugin_name(module_hook->module);
c2ebc8f28b5504f280cd5d4adfe57ed70f9a7d83Timo Sirainen if (!str_array_find(plugins, name))
c2ebc8f28b5504f280cd5d4adfe57ed70f9a7d83Timo Sirainen continue;
c2ebc8f28b5504f280cd5d4adfe57ed70f9a7d83Timo Sirainen }
c2ebc8f28b5504f280cd5d4adfe57ed70f9a7d83Timo Sirainen array_append(&tmp_hooks, module_hook, 1);
c2ebc8f28b5504f280cd5d4adfe57ed70f9a7d83Timo Sirainen }
c2ebc8f28b5504f280cd5d4adfe57ed70f9a7d83Timo Sirainen
c2ebc8f28b5504f280cd5d4adfe57ed70f9a7d83Timo Sirainen /* next we have to sort them by the modules' priority (based on name) */
c2ebc8f28b5504f280cd5d4adfe57ed70f9a7d83Timo Sirainen array_sort(&tmp_hooks, mail_storage_module_hooks_cmp);
c2ebc8f28b5504f280cd5d4adfe57ed70f9a7d83Timo Sirainen
c2ebc8f28b5504f280cd5d4adfe57ed70f9a7d83Timo Sirainen /* now that we have them in order, save them to user's hooks */
c2ebc8f28b5504f280cd5d4adfe57ed70f9a7d83Timo Sirainen p_array_init(&user->hooks, user->pool,
c2ebc8f28b5504f280cd5d4adfe57ed70f9a7d83Timo Sirainen array_count(&tmp_hooks) + array_count(&internal_hooks));
c2ebc8f28b5504f280cd5d4adfe57ed70f9a7d83Timo Sirainen array_foreach(&tmp_hooks, module_hook)
c2ebc8f28b5504f280cd5d4adfe57ed70f9a7d83Timo Sirainen array_append(&user->hooks, &module_hook->hooks, 1);
c2ebc8f28b5504f280cd5d4adfe57ed70f9a7d83Timo Sirainen array_append_array(&user->hooks, &internal_hooks);
c2ebc8f28b5504f280cd5d4adfe57ed70f9a7d83Timo Sirainen}
c2ebc8f28b5504f280cd5d4adfe57ed70f9a7d83Timo Sirainen
c2ebc8f28b5504f280cd5d4adfe57ed70f9a7d83Timo Sirainenstatic void hook_build_append(struct hook_build_context *ctx, void (**vfuncs)())
c2ebc8f28b5504f280cd5d4adfe57ed70f9a7d83Timo Sirainen{
c2ebc8f28b5504f280cd5d4adfe57ed70f9a7d83Timo Sirainen struct hook_stack *stack;
c2ebc8f28b5504f280cd5d4adfe57ed70f9a7d83Timo Sirainen
c2ebc8f28b5504f280cd5d4adfe57ed70f9a7d83Timo Sirainen stack = p_new(ctx->pool, struct hook_stack, 1);
c2ebc8f28b5504f280cd5d4adfe57ed70f9a7d83Timo Sirainen stack->vfuncs = vfuncs;
c2ebc8f28b5504f280cd5d4adfe57ed70f9a7d83Timo Sirainen stack->mask = p_malloc(ctx->pool, ctx->size);
c2ebc8f28b5504f280cd5d4adfe57ed70f9a7d83Timo Sirainen DLLIST2_APPEND(&ctx->head, &ctx->tail, stack);
c2ebc8f28b5504f280cd5d4adfe57ed70f9a7d83Timo Sirainen}
d2a2e0b6d302c17c33638a6fd48bd665a1c81e46Timo Sirainen
d2a2e0b6d302c17c33638a6fd48bd665a1c81e46Timo Sirainenstatic struct hook_build_context *
d2a2e0b6d302c17c33638a6fd48bd665a1c81e46Timo Sirainenhook_build_init(void (**vfuncs)(), size_t size)
d2a2e0b6d302c17c33638a6fd48bd665a1c81e46Timo Sirainen{
d2a2e0b6d302c17c33638a6fd48bd665a1c81e46Timo Sirainen struct hook_build_context *ctx;
d2a2e0b6d302c17c33638a6fd48bd665a1c81e46Timo Sirainen pool_t pool;
d2a2e0b6d302c17c33638a6fd48bd665a1c81e46Timo Sirainen
d2a2e0b6d302c17c33638a6fd48bd665a1c81e46Timo Sirainen i_assert((size % sizeof(void (*)())) == 0);
d2a2e0b6d302c17c33638a6fd48bd665a1c81e46Timo Sirainen
d2a2e0b6d302c17c33638a6fd48bd665a1c81e46Timo Sirainen pool = pool_alloconly_create("hook build context", 2048);
d2a2e0b6d302c17c33638a6fd48bd665a1c81e46Timo Sirainen ctx = p_new(pool, struct hook_build_context, 1);
d2a2e0b6d302c17c33638a6fd48bd665a1c81e46Timo Sirainen ctx->pool = pool;
d2a2e0b6d302c17c33638a6fd48bd665a1c81e46Timo Sirainen ctx->size = size;
d2a2e0b6d302c17c33638a6fd48bd665a1c81e46Timo Sirainen ctx->count = size / sizeof(void (*)());
d2a2e0b6d302c17c33638a6fd48bd665a1c81e46Timo Sirainen hook_build_append(ctx, vfuncs);
d2a2e0b6d302c17c33638a6fd48bd665a1c81e46Timo Sirainen return ctx;
9a935c34e98ba7a9cc90784ceb63b2fbdab4105fTimo Sirainen}
d2a2e0b6d302c17c33638a6fd48bd665a1c81e46Timo Sirainen
c2ebc8f28b5504f280cd5d4adfe57ed70f9a7d83Timo Sirainenstatic void
c2ebc8f28b5504f280cd5d4adfe57ed70f9a7d83Timo Sirainenhook_update_mask(struct hook_build_context *ctx, struct hook_stack *stack,
c2ebc8f28b5504f280cd5d4adfe57ed70f9a7d83Timo Sirainen void (**vlast)())
c2ebc8f28b5504f280cd5d4adfe57ed70f9a7d83Timo Sirainen{
86fafb22c02f4b85a9d59f2b60059a48286286fbTimo Sirainen unsigned int i;
3b22894b8805b186c73d8b754001e8d7e944be85Timo Sirainen
c2ebc8f28b5504f280cd5d4adfe57ed70f9a7d83Timo Sirainen for (i = 0; i < ctx->count; i++) {
c2ebc8f28b5504f280cd5d4adfe57ed70f9a7d83Timo Sirainen if (stack->vfuncs[i] != vlast[i]) {
c2ebc8f28b5504f280cd5d4adfe57ed70f9a7d83Timo Sirainen i_assert(stack->vfuncs[i] != NULL);
86fafb22c02f4b85a9d59f2b60059a48286286fbTimo Sirainen stack->mask[i] = stack->vfuncs[i];
86fafb22c02f4b85a9d59f2b60059a48286286fbTimo Sirainen }
86fafb22c02f4b85a9d59f2b60059a48286286fbTimo Sirainen }
86fafb22c02f4b85a9d59f2b60059a48286286fbTimo Sirainen}
c2ebc8f28b5504f280cd5d4adfe57ed70f9a7d83Timo Sirainen
c2ebc8f28b5504f280cd5d4adfe57ed70f9a7d83Timo Sirainenstatic void
c2ebc8f28b5504f280cd5d4adfe57ed70f9a7d83Timo Sirainenhook_copy_stack(struct hook_build_context *ctx, struct hook_stack *stack)
c2ebc8f28b5504f280cd5d4adfe57ed70f9a7d83Timo Sirainen{
c2ebc8f28b5504f280cd5d4adfe57ed70f9a7d83Timo Sirainen unsigned int i;
c2ebc8f28b5504f280cd5d4adfe57ed70f9a7d83Timo Sirainen
c2ebc8f28b5504f280cd5d4adfe57ed70f9a7d83Timo Sirainen i_assert(stack->next != NULL);
c2ebc8f28b5504f280cd5d4adfe57ed70f9a7d83Timo Sirainen
4da8c6cdefabd31262318c32da3c13de1d9ea953Timo Sirainen for (i = 0; i < ctx->count; i++) {
9a935c34e98ba7a9cc90784ceb63b2fbdab4105fTimo Sirainen if (stack->mask[i] == NULL) {
c2ebc8f28b5504f280cd5d4adfe57ed70f9a7d83Timo Sirainen stack->vfuncs[i] = stack->next->vfuncs[i];
c2ebc8f28b5504f280cd5d4adfe57ed70f9a7d83Timo Sirainen stack->mask[i] = stack->next->mask[i];
3b22894b8805b186c73d8b754001e8d7e944be85Timo Sirainen }
3b22894b8805b186c73d8b754001e8d7e944be85Timo Sirainen }
c2ebc8f28b5504f280cd5d4adfe57ed70f9a7d83Timo Sirainen}
c2ebc8f28b5504f280cd5d4adfe57ed70f9a7d83Timo Sirainen
3b22894b8805b186c73d8b754001e8d7e944be85Timo Sirainenstatic void hook_build_update(struct hook_build_context *ctx, void *_vlast)
c2ebc8f28b5504f280cd5d4adfe57ed70f9a7d83Timo Sirainen{
c2ebc8f28b5504f280cd5d4adfe57ed70f9a7d83Timo Sirainen void (**vlast)() = _vlast;
c2ebc8f28b5504f280cd5d4adfe57ed70f9a7d83Timo Sirainen struct hook_stack *stack;
c2ebc8f28b5504f280cd5d4adfe57ed70f9a7d83Timo Sirainen
c2ebc8f28b5504f280cd5d4adfe57ed70f9a7d83Timo Sirainen if (ctx->tail->vfuncs == vlast) {
c2ebc8f28b5504f280cd5d4adfe57ed70f9a7d83Timo Sirainen /* no vfuncs overridden */
c2ebc8f28b5504f280cd5d4adfe57ed70f9a7d83Timo Sirainen return;
c2ebc8f28b5504f280cd5d4adfe57ed70f9a7d83Timo Sirainen }
c2ebc8f28b5504f280cd5d4adfe57ed70f9a7d83Timo Sirainen
eed0a07ecb946ec9d021f5b413fb33eb36e135fdTimo Sirainen /* ctx->vfuncs_stack->vfuncs points to the root vfuncs,
eed0a07ecb946ec9d021f5b413fb33eb36e135fdTimo Sirainen ctx->vfuncs_stack->next->vfuncs points to the first super function
eed0a07ecb946ec9d021f5b413fb33eb36e135fdTimo Sirainen that is being called, and so on.
9a935c34e98ba7a9cc90784ceb63b2fbdab4105fTimo Sirainen
c2ebc8f28b5504f280cd5d4adfe57ed70f9a7d83Timo Sirainen the previous plugin added its vfuncs to the stack tail.
c2ebc8f28b5504f280cd5d4adfe57ed70f9a7d83Timo Sirainen vlast contains the previous plugin's super vfuncs, which is where
c2ebc8f28b5504f280cd5d4adfe57ed70f9a7d83Timo Sirainen the next plugin should put its own vfuncs.
c2ebc8f28b5504f280cd5d4adfe57ed70f9a7d83Timo Sirainen
d2a2e0b6d302c17c33638a6fd48bd665a1c81e46Timo Sirainen first we'll need to figure out what vfuncs the previous plugin
d2a2e0b6d302c17c33638a6fd48bd665a1c81e46Timo Sirainen changed and update the mask */
d2a2e0b6d302c17c33638a6fd48bd665a1c81e46Timo Sirainen hook_update_mask(ctx, ctx->tail, vlast);
d2a2e0b6d302c17c33638a6fd48bd665a1c81e46Timo Sirainen
d2a2e0b6d302c17c33638a6fd48bd665a1c81e46Timo Sirainen /* now go up in the stack as long as the mask isn't set,
d2a2e0b6d302c17c33638a6fd48bd665a1c81e46Timo Sirainen and update the vfuncs */
d2a2e0b6d302c17c33638a6fd48bd665a1c81e46Timo Sirainen for (stack = ctx->tail->prev; stack != NULL; stack = stack->prev)
9a935c34e98ba7a9cc90784ceb63b2fbdab4105fTimo Sirainen hook_copy_stack(ctx, stack);
9a935c34e98ba7a9cc90784ceb63b2fbdab4105fTimo Sirainen
9a935c34e98ba7a9cc90784ceb63b2fbdab4105fTimo Sirainen /* add vlast to stack */
c2ebc8f28b5504f280cd5d4adfe57ed70f9a7d83Timo Sirainen hook_build_append(ctx, vlast);
7aa2dd189748ed57c2fb8d8d9b7cb3c4ac2f7ea5Timo Sirainen}
c2ebc8f28b5504f280cd5d4adfe57ed70f9a7d83Timo Sirainen
c2ebc8f28b5504f280cd5d4adfe57ed70f9a7d83Timo Sirainenvoid hook_mail_user_created(struct mail_user *user)
7aa2dd189748ed57c2fb8d8d9b7cb3c4ac2f7ea5Timo Sirainen{
7aa2dd189748ed57c2fb8d8d9b7cb3c4ac2f7ea5Timo Sirainen const struct mail_storage_hooks *const *hooks;
7aa2dd189748ed57c2fb8d8d9b7cb3c4ac2f7ea5Timo Sirainen struct hook_build_context *ctx;
7aa2dd189748ed57c2fb8d8d9b7cb3c4ac2f7ea5Timo Sirainen
7aa2dd189748ed57c2fb8d8d9b7cb3c4ac2f7ea5Timo Sirainen mail_user_add_plugin_hooks(user);
7aa2dd189748ed57c2fb8d8d9b7cb3c4ac2f7ea5Timo Sirainen
7aa2dd189748ed57c2fb8d8d9b7cb3c4ac2f7ea5Timo Sirainen ctx = hook_build_init((void *)&user->v, sizeof(user->v));
c2ebc8f28b5504f280cd5d4adfe57ed70f9a7d83Timo Sirainen user->vlast = &user->v;
c2ebc8f28b5504f280cd5d4adfe57ed70f9a7d83Timo Sirainen array_foreach(&user->hooks, hooks) {
98720d3b830e8ec762e9bdde94a71c0ef184595dTimo Sirainen if ((*hooks)->mail_user_created != NULL) T_BEGIN {
c2ebc8f28b5504f280cd5d4adfe57ed70f9a7d83Timo Sirainen (*hooks)->mail_user_created(user);
e93ab1b206e3792a8dabc460ad2ee60aaf6830b1Timo Sirainen hook_build_update(ctx, user->vlast);
c2ebc8f28b5504f280cd5d4adfe57ed70f9a7d83Timo Sirainen } T_END;
e93ab1b206e3792a8dabc460ad2ee60aaf6830b1Timo Sirainen }
c2ebc8f28b5504f280cd5d4adfe57ed70f9a7d83Timo Sirainen pool_unref(&ctx->pool);
c2ebc8f28b5504f280cd5d4adfe57ed70f9a7d83Timo Sirainen}
c2ebc8f28b5504f280cd5d4adfe57ed70f9a7d83Timo Sirainen
c2ebc8f28b5504f280cd5d4adfe57ed70f9a7d83Timo Sirainenvoid hook_mail_namespace_storage_added(struct mail_namespace *ns)
c2ebc8f28b5504f280cd5d4adfe57ed70f9a7d83Timo Sirainen{
c2ebc8f28b5504f280cd5d4adfe57ed70f9a7d83Timo Sirainen const struct mail_storage_hooks *const *hooks;
c2ebc8f28b5504f280cd5d4adfe57ed70f9a7d83Timo Sirainen
c2ebc8f28b5504f280cd5d4adfe57ed70f9a7d83Timo Sirainen array_foreach(&ns->user->hooks, hooks) {
c2ebc8f28b5504f280cd5d4adfe57ed70f9a7d83Timo Sirainen if ((*hooks)->mail_namespace_storage_added != NULL) T_BEGIN {
c2ebc8f28b5504f280cd5d4adfe57ed70f9a7d83Timo Sirainen (*hooks)->mail_namespace_storage_added(ns);
c2ebc8f28b5504f280cd5d4adfe57ed70f9a7d83Timo Sirainen } T_END;
c2ebc8f28b5504f280cd5d4adfe57ed70f9a7d83Timo Sirainen }
c2ebc8f28b5504f280cd5d4adfe57ed70f9a7d83Timo Sirainen}
c2ebc8f28b5504f280cd5d4adfe57ed70f9a7d83Timo Sirainen
a338794c56fc9674121e262fcb67c3dc1da31436Timo Sirainenvoid hook_mail_namespaces_created(struct mail_namespace *namespaces)
a338794c56fc9674121e262fcb67c3dc1da31436Timo Sirainen{
a338794c56fc9674121e262fcb67c3dc1da31436Timo Sirainen const struct mail_storage_hooks *const *hooks;
a338794c56fc9674121e262fcb67c3dc1da31436Timo Sirainen
a338794c56fc9674121e262fcb67c3dc1da31436Timo Sirainen array_foreach(&namespaces->user->hooks, hooks) {
a338794c56fc9674121e262fcb67c3dc1da31436Timo Sirainen if (namespaces->user->error != NULL)
a338794c56fc9674121e262fcb67c3dc1da31436Timo Sirainen break;
a338794c56fc9674121e262fcb67c3dc1da31436Timo Sirainen if ((*hooks)->mail_namespaces_created != NULL) T_BEGIN {
a338794c56fc9674121e262fcb67c3dc1da31436Timo Sirainen (*hooks)->mail_namespaces_created(namespaces);
a338794c56fc9674121e262fcb67c3dc1da31436Timo Sirainen } T_END;
a338794c56fc9674121e262fcb67c3dc1da31436Timo Sirainen }
a338794c56fc9674121e262fcb67c3dc1da31436Timo Sirainen}
a338794c56fc9674121e262fcb67c3dc1da31436Timo Sirainen
a338794c56fc9674121e262fcb67c3dc1da31436Timo Sirainenvoid hook_mail_namespaces_added(struct mail_namespace *namespaces)
a338794c56fc9674121e262fcb67c3dc1da31436Timo Sirainen{
a338794c56fc9674121e262fcb67c3dc1da31436Timo Sirainen const struct mail_storage_hooks *const *hooks;
a338794c56fc9674121e262fcb67c3dc1da31436Timo Sirainen
a338794c56fc9674121e262fcb67c3dc1da31436Timo Sirainen array_foreach(&namespaces->user->hooks, hooks) {
a338794c56fc9674121e262fcb67c3dc1da31436Timo Sirainen if (namespaces->user->error != NULL)
a338794c56fc9674121e262fcb67c3dc1da31436Timo Sirainen break;
a338794c56fc9674121e262fcb67c3dc1da31436Timo Sirainen if ((*hooks)->mail_namespaces_added != NULL) T_BEGIN {
a338794c56fc9674121e262fcb67c3dc1da31436Timo Sirainen (*hooks)->mail_namespaces_added(namespaces);
a338794c56fc9674121e262fcb67c3dc1da31436Timo Sirainen } T_END;
a338794c56fc9674121e262fcb67c3dc1da31436Timo Sirainen }
a338794c56fc9674121e262fcb67c3dc1da31436Timo Sirainen}
a338794c56fc9674121e262fcb67c3dc1da31436Timo Sirainen
a338794c56fc9674121e262fcb67c3dc1da31436Timo Sirainenvoid hook_mail_storage_created(struct mail_storage *storage)
a338794c56fc9674121e262fcb67c3dc1da31436Timo Sirainen{
a338794c56fc9674121e262fcb67c3dc1da31436Timo Sirainen const struct mail_storage_hooks *const *hooks;
a338794c56fc9674121e262fcb67c3dc1da31436Timo Sirainen struct hook_build_context *ctx;
a338794c56fc9674121e262fcb67c3dc1da31436Timo Sirainen
a338794c56fc9674121e262fcb67c3dc1da31436Timo Sirainen ctx = hook_build_init((void *)&storage->v, sizeof(storage->v));
a338794c56fc9674121e262fcb67c3dc1da31436Timo Sirainen storage->vlast = &storage->v;
9a935c34e98ba7a9cc90784ceb63b2fbdab4105fTimo Sirainen array_foreach(&storage->user->hooks, hooks) {
9a935c34e98ba7a9cc90784ceb63b2fbdab4105fTimo Sirainen if ((*hooks)->mail_storage_created != NULL) T_BEGIN {
9a935c34e98ba7a9cc90784ceb63b2fbdab4105fTimo Sirainen (*hooks)->mail_storage_created(storage);
7b22071c71a99bcb71ee9fcfbb83ed5bf5e08a2dTimo Sirainen hook_build_update(ctx, storage->vlast);
9a935c34e98ba7a9cc90784ceb63b2fbdab4105fTimo Sirainen } T_END;
9a935c34e98ba7a9cc90784ceb63b2fbdab4105fTimo Sirainen }
9a935c34e98ba7a9cc90784ceb63b2fbdab4105fTimo Sirainen pool_unref(&ctx->pool);
9a935c34e98ba7a9cc90784ceb63b2fbdab4105fTimo Sirainen}
9a935c34e98ba7a9cc90784ceb63b2fbdab4105fTimo Sirainen
9a935c34e98ba7a9cc90784ceb63b2fbdab4105fTimo Sirainenvoid hook_mailbox_list_created(struct mailbox_list *list)
9a935c34e98ba7a9cc90784ceb63b2fbdab4105fTimo Sirainen{
7b22071c71a99bcb71ee9fcfbb83ed5bf5e08a2dTimo Sirainen const struct mail_storage_hooks *const *hooks;
f74f4098ee674df8e207e2bc3467e40c55d3b415Timo Sirainen struct hook_build_context *ctx;
7b22071c71a99bcb71ee9fcfbb83ed5bf5e08a2dTimo Sirainen
9a935c34e98ba7a9cc90784ceb63b2fbdab4105fTimo Sirainen ctx = hook_build_init((void *)&list->v, sizeof(list->v));
9a935c34e98ba7a9cc90784ceb63b2fbdab4105fTimo Sirainen list->vlast = &list->v;
7b22071c71a99bcb71ee9fcfbb83ed5bf5e08a2dTimo Sirainen array_foreach(&list->ns->user->hooks, hooks) {
9a935c34e98ba7a9cc90784ceb63b2fbdab4105fTimo Sirainen if ((*hooks)->mailbox_list_created != NULL) T_BEGIN {
9a935c34e98ba7a9cc90784ceb63b2fbdab4105fTimo Sirainen (*hooks)->mailbox_list_created(list);
7b22071c71a99bcb71ee9fcfbb83ed5bf5e08a2dTimo Sirainen hook_build_update(ctx, list->vlast);
7b22071c71a99bcb71ee9fcfbb83ed5bf5e08a2dTimo Sirainen } T_END;
9a935c34e98ba7a9cc90784ceb63b2fbdab4105fTimo Sirainen }
9a935c34e98ba7a9cc90784ceb63b2fbdab4105fTimo Sirainen pool_unref(&ctx->pool);
9a935c34e98ba7a9cc90784ceb63b2fbdab4105fTimo Sirainen}
9a935c34e98ba7a9cc90784ceb63b2fbdab4105fTimo Sirainen
315ce5be539bfe8bc7777ab0654499c49583cea2Timo Sirainenvoid hook_mailbox_allocated(struct mailbox *box)
315ce5be539bfe8bc7777ab0654499c49583cea2Timo Sirainen{
315ce5be539bfe8bc7777ab0654499c49583cea2Timo Sirainen const struct mail_storage_hooks *const *hooks;
d1fff80640050631b06bfab904a34b2ad24601e8Timo Sirainen struct hook_build_context *ctx;
3b22894b8805b186c73d8b754001e8d7e944be85Timo Sirainen
9a935c34e98ba7a9cc90784ceb63b2fbdab4105fTimo Sirainen ctx = hook_build_init((void *)&box->v, sizeof(box->v));
315ce5be539bfe8bc7777ab0654499c49583cea2Timo Sirainen box->vlast = &box->v;
c2ebc8f28b5504f280cd5d4adfe57ed70f9a7d83Timo Sirainen array_foreach(&box->storage->user->hooks, hooks) {
315ce5be539bfe8bc7777ab0654499c49583cea2Timo Sirainen if ((*hooks)->mailbox_allocated != NULL) T_BEGIN {
315ce5be539bfe8bc7777ab0654499c49583cea2Timo Sirainen (*hooks)->mailbox_allocated(box);
315ce5be539bfe8bc7777ab0654499c49583cea2Timo Sirainen hook_build_update(ctx, box->vlast);
315ce5be539bfe8bc7777ab0654499c49583cea2Timo Sirainen } T_END;
315ce5be539bfe8bc7777ab0654499c49583cea2Timo Sirainen }
315ce5be539bfe8bc7777ab0654499c49583cea2Timo Sirainen pool_unref(&ctx->pool);
65514ab6ccc1889e1667211fddb0cca4b51017dfTimo Sirainen}
ad5130b3afda4cf30e6272d96d818f84d3ae4e55Timo Sirainen
9a935c34e98ba7a9cc90784ceb63b2fbdab4105fTimo Sirainenvoid hook_mailbox_opened(struct mailbox *box)
9a935c34e98ba7a9cc90784ceb63b2fbdab4105fTimo Sirainen{
315ce5be539bfe8bc7777ab0654499c49583cea2Timo Sirainen const struct mail_storage_hooks *const *hooks;
315ce5be539bfe8bc7777ab0654499c49583cea2Timo Sirainen
315ce5be539bfe8bc7777ab0654499c49583cea2Timo Sirainen array_foreach(&box->storage->user->hooks, hooks) {
ad5130b3afda4cf30e6272d96d818f84d3ae4e55Timo Sirainen if ((*hooks)->mailbox_opened != NULL) T_BEGIN {
315ce5be539bfe8bc7777ab0654499c49583cea2Timo Sirainen (*hooks)->mailbox_opened(box);
315ce5be539bfe8bc7777ab0654499c49583cea2Timo Sirainen } T_END;
9a935c34e98ba7a9cc90784ceb63b2fbdab4105fTimo Sirainen }
315ce5be539bfe8bc7777ab0654499c49583cea2Timo Sirainen}
65514ab6ccc1889e1667211fddb0cca4b51017dfTimo Sirainen
65514ab6ccc1889e1667211fddb0cca4b51017dfTimo Sirainenvoid hook_mail_allocated(struct mail *mail)
65514ab6ccc1889e1667211fddb0cca4b51017dfTimo Sirainen{
65514ab6ccc1889e1667211fddb0cca4b51017dfTimo Sirainen const struct mail_storage_hooks *const *hooks;
9a935c34e98ba7a9cc90784ceb63b2fbdab4105fTimo Sirainen struct mail_private *pmail = (struct mail_private *)mail;
65514ab6ccc1889e1667211fddb0cca4b51017dfTimo Sirainen struct hook_build_context *ctx;
458acd7b39c84bae0d18c36ff9ddff9a49b4ae4aTimo Sirainen
d2a2e0b6d302c17c33638a6fd48bd665a1c81e46Timo Sirainen ctx = hook_build_init((void *)&pmail->v, sizeof(pmail->v));
c2ebc8f28b5504f280cd5d4adfe57ed70f9a7d83Timo Sirainen pmail->vlast = &pmail->v;
c2ebc8f28b5504f280cd5d4adfe57ed70f9a7d83Timo Sirainen array_foreach(&mail->box->storage->user->hooks, hooks) {
c2ebc8f28b5504f280cd5d4adfe57ed70f9a7d83Timo Sirainen if ((*hooks)->mail_allocated != NULL) T_BEGIN {
7aa2dd189748ed57c2fb8d8d9b7cb3c4ac2f7ea5Timo Sirainen (*hooks)->mail_allocated(mail);
7aa2dd189748ed57c2fb8d8d9b7cb3c4ac2f7ea5Timo Sirainen hook_build_update(ctx, pmail->vlast);
7aa2dd189748ed57c2fb8d8d9b7cb3c4ac2f7ea5Timo Sirainen } T_END;
7aa2dd189748ed57c2fb8d8d9b7cb3c4ac2f7ea5Timo Sirainen }
7aa2dd189748ed57c2fb8d8d9b7cb3c4ac2f7ea5Timo Sirainen pool_unref(&ctx->pool);
7aa2dd189748ed57c2fb8d8d9b7cb3c4ac2f7ea5Timo Sirainen}
7aa2dd189748ed57c2fb8d8d9b7cb3c4ac2f7ea5Timo Sirainen