plugins/expire/expire-plugin.c

	expire-plugin.c revision e34d170f8f0e084bd94bfbc1a7085ece67e508df
45312f52ff3a3d4c137447be4c7556500c2f8bf2Timo Sirainen/* Copyright (c) 2006-2012 Dovecot authors, see the included COPYING file */
55a7410569737197afb302b07b488973324b0cc5Timo Sirainen
55a7410569737197afb302b07b488973324b0cc5Timo Sirainen#include "lib.h"
def516ea503a60f20d510c14d5070b7ff5bbddf4Timo Sirainen#include "ioloop.h"
55a7410569737197afb302b07b488973324b0cc5Timo Sirainen#include "array.h"
e5b8b3a57993ab957d389e1c7253698bcd1e6cb1Timo Sirainen#include "str.h"
d43bed2d458520fd01c28229ce2b178a4593a4a7Timo Sirainen#include "master-service.h"
55a7410569737197afb302b07b488973324b0cc5Timo Sirainen#include "dict.h"
c0435c854a0e7246373b9752d163095cc4fbe985Timo Sirainen#include "mail-namespace.h"
c0435c854a0e7246373b9752d163095cc4fbe985Timo Sirainen#include "index-mail.h"
55a7410569737197afb302b07b488973324b0cc5Timo Sirainen#include "index-storage.h"
c0435c854a0e7246373b9752d163095cc4fbe985Timo Sirainen#include "expire-set.h"
55a7410569737197afb302b07b488973324b0cc5Timo Sirainen#include "expire-plugin.h"
c0435c854a0e7246373b9752d163095cc4fbe985Timo Sirainen
a0c453a8edaec90fb0d945c874de0b1845bc7d7eTimo Sirainen#include <stdlib.h>
a0c453a8edaec90fb0d945c874de0b1845bc7d7eTimo Sirainen
a0c453a8edaec90fb0d945c874de0b1845bc7d7eTimo Sirainen#define EXPIRE_CONTEXT(obj) \
a0c453a8edaec90fb0d945c874de0b1845bc7d7eTimo Sirainen    MODULE_CONTEXT(obj, expire_storage_module)
a0c453a8edaec90fb0d945c874de0b1845bc7d7eTimo Sirainen#define EXPIRE_MAIL_CONTEXT(obj) \
a0c453a8edaec90fb0d945c874de0b1845bc7d7eTimo Sirainen    MODULE_CONTEXT(obj, expire_mail_module)
a0c453a8edaec90fb0d945c874de0b1845bc7d7eTimo Sirainen#define EXPIRE_USER_CONTEXT(obj) \
a0c453a8edaec90fb0d945c874de0b1845bc7d7eTimo Sirainen    MODULE_CONTEXT(obj, expire_mail_user_module)
a0c453a8edaec90fb0d945c874de0b1845bc7d7eTimo Sirainen
a0c453a8edaec90fb0d945c874de0b1845bc7d7eTimo Sirainenstruct expire_mail_user {
55a7410569737197afb302b07b488973324b0cc5Timo Sirainen    union mail_user_module_context module_ctx;
55a7410569737197afb302b07b488973324b0cc5Timo Sirainen
a04cd96888653891272a512f7735121193af7b35Timo Sirainen    struct dict *db;
f1e9611e93dcb3b745c1904029084fa81644e1b3Timo Sirainen    struct expire_set *set;
f1e9611e93dcb3b745c1904029084fa81644e1b3Timo Sirainen};
a04cd96888653891272a512f7735121193af7b35Timo Sirainen
55a7410569737197afb302b07b488973324b0cc5Timo Sirainenstruct expire_mailbox {
a04cd96888653891272a512f7735121193af7b35Timo Sirainen    union mailbox_module_context module_ctx;
a04cd96888653891272a512f7735121193af7b35Timo Sirainen};
828edf966ee46f65ec5d907f310cab270e7e1088Timo Sirainen
55a7410569737197afb302b07b488973324b0cc5Timo Sirainenstruct expire_transaction_context {
63946971b08cfb1eec698c28569e1c4aa237852dTimo Sirainen    union mailbox_transaction_module_context module_ctx;
63946971b08cfb1eec698c28569e1c4aa237852dTimo Sirainen
e60a349c641bb2f4723e4a395a25f55531682d2bTimo Sirainen    unsigned int saves:1;
a04cd96888653891272a512f7735121193af7b35Timo Sirainen    unsigned int first_expunged:1;
63946971b08cfb1eec698c28569e1c4aa237852dTimo Sirainen};
63946971b08cfb1eec698c28569e1c4aa237852dTimo Sirainen
828edf966ee46f65ec5d907f310cab270e7e1088Timo Sirainenconst char *expire_plugin_version = DOVECOT_VERSION;
a04cd96888653891272a512f7735121193af7b35Timo Sirainen
a04cd96888653891272a512f7735121193af7b35Timo Sirainenstatic MODULE_CONTEXT_DEFINE_INIT(expire_storage_module,
4525c4a8f8d1a6365e4469c0c8f46575400a9a67Timo Sirainen                  &mail_storage_module_register);
55a7410569737197afb302b07b488973324b0cc5Timo Sirainenstatic MODULE_CONTEXT_DEFINE_INIT(expire_mail_module, &mail_module_register);
828edf966ee46f65ec5d907f310cab270e7e1088Timo Sirainenstatic MODULE_CONTEXT_DEFINE_INIT(expire_mail_user_module,
828edf966ee46f65ec5d907f310cab270e7e1088Timo Sirainen                  &mail_user_module_register);
a04cd96888653891272a512f7735121193af7b35Timo Sirainen
a04cd96888653891272a512f7735121193af7b35Timo Sirainenstatic struct mailbox_transaction_context *
a04cd96888653891272a512f7735121193af7b35Timo Sirainenexpire_mailbox_transaction_begin(struct mailbox *box,
a04cd96888653891272a512f7735121193af7b35Timo Sirainen                 enum mailbox_transaction_flags flags)
55a7410569737197afb302b07b488973324b0cc5Timo Sirainen{
55a7410569737197afb302b07b488973324b0cc5Timo Sirainen    struct expire_mailbox *xpr_box = EXPIRE_CONTEXT(box);
55a7410569737197afb302b07b488973324b0cc5Timo Sirainen    struct mailbox_transaction_context *t;
55a7410569737197afb302b07b488973324b0cc5Timo Sirainen    struct expire_transaction_context *xt;
55a7410569737197afb302b07b488973324b0cc5Timo Sirainen
55a7410569737197afb302b07b488973324b0cc5Timo Sirainen    t = xpr_box->module_ctx.super.transaction_begin(box, flags);
e60a349c641bb2f4723e4a395a25f55531682d2bTimo Sirainen    xt = i_new(struct expire_transaction_context, 1);
55a7410569737197afb302b07b488973324b0cc5Timo Sirainen
a04cd96888653891272a512f7735121193af7b35Timo Sirainen    MODULE_CONTEXT_SET(t, expire_storage_module, xt);
55a7410569737197afb302b07b488973324b0cc5Timo Sirainen    return t;
55a7410569737197afb302b07b488973324b0cc5Timo Sirainen}
a04cd96888653891272a512f7735121193af7b35Timo Sirainen
a04cd96888653891272a512f7735121193af7b35Timo Sirainenstatic void first_nonexpunged_timestamp(struct mailbox_transaction_context *t,
a04cd96888653891272a512f7735121193af7b35Timo Sirainen                    time_t *stamp_r)
a04cd96888653891272a512f7735121193af7b35Timo Sirainen{
a04cd96888653891272a512f7735121193af7b35Timo Sirainen    struct mail_index_view *view = t->view;
a04cd96888653891272a512f7735121193af7b35Timo Sirainen    const struct mail_index_header *hdr;
a04cd96888653891272a512f7735121193af7b35Timo Sirainen    struct mail *mail;
a04cd96888653891272a512f7735121193af7b35Timo Sirainen    uint32_t seq;
a04cd96888653891272a512f7735121193af7b35Timo Sirainen
a04cd96888653891272a512f7735121193af7b35Timo Sirainen    mail = mail_alloc(t, 0, NULL);
55a7410569737197afb302b07b488973324b0cc5Timo Sirainen
828edf966ee46f65ec5d907f310cab270e7e1088Timo Sirainen    /* find the first non-expunged mail. we're here because the first
828edf966ee46f65ec5d907f310cab270e7e1088Timo Sirainen       mail was expunged, so don't bother checking it. */
828edf966ee46f65ec5d907f310cab270e7e1088Timo Sirainen    hdr = mail_index_get_header(view);
828edf966ee46f65ec5d907f310cab270e7e1088Timo Sirainen    for (seq = 2; seq <= hdr->messages_count; seq++) {
a04cd96888653891272a512f7735121193af7b35Timo Sirainen        if (!mail_index_is_expunged(view, seq)) {
55a7410569737197afb302b07b488973324b0cc5Timo Sirainen            mail_set_seq(mail, seq);
55a7410569737197afb302b07b488973324b0cc5Timo Sirainen            if (mail_get_save_date(mail, stamp_r) == 0)
e60a349c641bb2f4723e4a395a25f55531682d2bTimo Sirainen                break;
55a7410569737197afb302b07b488973324b0cc5Timo Sirainen        }
a04cd96888653891272a512f7735121193af7b35Timo Sirainen    }
55a7410569737197afb302b07b488973324b0cc5Timo Sirainen    mail_free(&mail);
55a7410569737197afb302b07b488973324b0cc5Timo Sirainen
a04cd96888653891272a512f7735121193af7b35Timo Sirainen    if (seq > hdr->messages_count) {
55a7410569737197afb302b07b488973324b0cc5Timo Sirainen        /* everything expunged */
55a7410569737197afb302b07b488973324b0cc5Timo Sirainen        *stamp_r = 0;
6ef7e31619edfaa17ed044b45861d106a86191efTimo Sirainen    }
55a7410569737197afb302b07b488973324b0cc5Timo Sirainen}
d43bed2d458520fd01c28229ce2b178a4593a4a7Timo Sirainen
c4b376dd6e0c423006d7ac83a39253bcaf8e7c47Timo Sirainenstatic void first_save_timestamp(struct mailbox *box, time_t *stamp_r)
d43bed2d458520fd01c28229ce2b178a4593a4a7Timo Sirainen{
f1e9611e93dcb3b745c1904029084fa81644e1b3Timo Sirainen    struct mailbox_transaction_context *t;
97cfe59cd16ce624e58e8d9b6003d1e29d75b3d2Timo Sirainen    const struct mail_index_header *hdr;
97cfe59cd16ce624e58e8d9b6003d1e29d75b3d2Timo Sirainen    struct mail *mail;
55a7410569737197afb302b07b488973324b0cc5Timo Sirainen
2f25f180578a4c280c9f5fda1cb9f22410084a1eTimo Sirainen    *stamp_r = ioloop_time;
55a7410569737197afb302b07b488973324b0cc5Timo Sirainen
55a7410569737197afb302b07b488973324b0cc5Timo Sirainen    t = mailbox_transaction_begin(box, 0);
e60a349c641bb2f4723e4a395a25f55531682d2bTimo Sirainen    mail = mail_alloc(t, 0, NULL);
55a7410569737197afb302b07b488973324b0cc5Timo Sirainen
55a7410569737197afb302b07b488973324b0cc5Timo Sirainen    /* find the first non-expunged mail. we're here because the first
55a7410569737197afb302b07b488973324b0cc5Timo Sirainen       mail was expunged, so don't bother checking it. */
55a7410569737197afb302b07b488973324b0cc5Timo Sirainen    hdr = mail_index_get_header(box->view);
e60a349c641bb2f4723e4a395a25f55531682d2bTimo Sirainen    if (hdr->messages_count > 0) {
55a7410569737197afb302b07b488973324b0cc5Timo Sirainen        mail_set_seq(mail, 1);
55a7410569737197afb302b07b488973324b0cc5Timo Sirainen        (void)mail_get_save_date(mail, stamp_r);
55a7410569737197afb302b07b488973324b0cc5Timo Sirainen    }
d43bed2d458520fd01c28229ce2b178a4593a4a7Timo Sirainen    mail_free(&mail);
55a7410569737197afb302b07b488973324b0cc5Timo Sirainen    (void)mailbox_transaction_commit(&t);
55a7410569737197afb302b07b488973324b0cc5Timo Sirainen}
55a7410569737197afb302b07b488973324b0cc5Timo Sirainen
55a7410569737197afb302b07b488973324b0cc5Timo Sirainenstatic int
55a7410569737197afb302b07b488973324b0cc5Timo Sirainenexpire_mailbox_transaction_commit(struct mailbox_transaction_context *t,
e60a349c641bb2f4723e4a395a25f55531682d2bTimo Sirainen                  struct mail_transaction_commit_changes *changes_r)
55a7410569737197afb302b07b488973324b0cc5Timo Sirainen{
fd4632d0060b2e9eef513b544ccff1e26d1fc222Timo Sirainen    struct mail_user *user = t->box->storage->user;
55a7410569737197afb302b07b488973324b0cc5Timo Sirainen    struct expire_mail_user *euser = EXPIRE_USER_CONTEXT(user);
4525c4a8f8d1a6365e4469c0c8f46575400a9a67Timo Sirainen    struct expire_mailbox *xpr_box = EXPIRE_CONTEXT(t->box);
55a7410569737197afb302b07b488973324b0cc5Timo Sirainen    struct expire_transaction_context *xt = EXPIRE_CONTEXT(t);
55a7410569737197afb302b07b488973324b0cc5Timo Sirainen    struct mailbox *box = t->box;
d43bed2d458520fd01c28229ce2b178a4593a4a7Timo Sirainen    time_t new_stamp = 0;
d43bed2d458520fd01c28229ce2b178a4593a4a7Timo Sirainen    bool update_dict = FALSE;
d43bed2d458520fd01c28229ce2b178a4593a4a7Timo Sirainen    int ret;
d43bed2d458520fd01c28229ce2b178a4593a4a7Timo Sirainen
d43bed2d458520fd01c28229ce2b178a4593a4a7Timo Sirainen    if (xt->first_expunged) {
d43bed2d458520fd01c28229ce2b178a4593a4a7Timo Sirainen        /* first mail expunged. dict needs updating. */
d43bed2d458520fd01c28229ce2b178a4593a4a7Timo Sirainen        first_nonexpunged_timestamp(t, &new_stamp);
d43bed2d458520fd01c28229ce2b178a4593a4a7Timo Sirainen        if (new_stamp == 0 && xt->saves) {
c4b376dd6e0c423006d7ac83a39253bcaf8e7c47Timo Sirainen            /* everything was expunged, but also within this
97cfe59cd16ce624e58e8d9b6003d1e29d75b3d2Timo Sirainen               transaction a new message was saved */
97cfe59cd16ce624e58e8d9b6003d1e29d75b3d2Timo Sirainen            new_stamp = ioloop_time;
97cfe59cd16ce624e58e8d9b6003d1e29d75b3d2Timo Sirainen        }
d43bed2d458520fd01c28229ce2b178a4593a4a7Timo Sirainen        if (user->mail_debug) {
55a7410569737197afb302b07b488973324b0cc5Timo Sirainen            i_debug("expire: Expunging first message in %s, "
                "updating timestamp to %ld",
                box->vname, (long)new_stamp);
        }
        update_dict = TRUE;
    }

    if (xpr_box->module_ctx.super.transaction_commit(t, changes_r) < 0) {
        i_free(xt);
        return -1;
    }
    /* transaction is freed now */
    t = NULL;

    if (xt->first_expunged || xt->saves) T_BEGIN {
        const char *key, *value;

        key = t_strconcat(DICT_EXPIRE_PREFIX,
                  box->storage->user->username, "/",
                  mailbox_get_vname(box), NULL);
        if (xt->first_expunged) {
            /* new_stamp is already set */
        } else {
            i_assert(xt->saves);
            /* saved new mails. dict needs to be updated only if
               this is the first mail in the database */
            ret = dict_lookup(euser->db, pool_datastack_create(),
                      key, &value);
            if (ret <= 0) {
                /* first time saving here with expire enabled.
                   also handle lookup errors by just assuming
                   it didn't exist */
                if (ret < 0) {
                    i_warning("expire: dict lookup failed, "
                          "assuming update is needed");
                }
                first_save_timestamp(box, &new_stamp);
                update_dict = TRUE;
            } else if (strcmp(value, "0") == 0) {
                /* we're saving the first mail to this mailbox.
                   ioloop_time may not be exactly the first
                   message's save time, but a few seconds
                   difference doesn't matter */
                new_stamp = ioloop_time;
                update_dict = TRUE;
            } else {
                /* already exists */
            }
            if (user->mail_debug && update_dict) {
                i_debug("expire: Saving first message to %s, "
                    "updating timestamp to %ld",
                    box->vname, (long)new_stamp);
            }
        }

        if (update_dict) {
            struct dict_transaction_context *dctx;

            dctx = dict_transaction_begin(euser->db);
            dict_set(dctx, key, dec2str(new_stamp));
            if (dict_transaction_commit(&dctx) < 0)
                i_error("expire: dict commit failed");
        }
    } T_END;
    i_free(xt);
    return 0;
}

static void
expire_mailbox_transaction_rollback(struct mailbox_transaction_context *t)
{
    struct expire_mailbox *xpr_box = EXPIRE_CONTEXT(t->box);
    struct expire_transaction_context *xt = EXPIRE_CONTEXT(t);

    xpr_box->module_ctx.super.transaction_rollback(t);
    i_free(xt);
}

static void expire_mail_expunge(struct mail *_mail)
{
    struct mail_private *mail = (struct mail_private *)_mail;
    union mail_module_context *xpr_mail = EXPIRE_MAIL_CONTEXT(mail);
    struct expire_transaction_context *xt =
        EXPIRE_CONTEXT(_mail->transaction);

    if (_mail->seq == 1) {
        /* first mail expunged, database needs to be updated */
        xt->first_expunged = TRUE;
    }
    xpr_mail->super.expunge(_mail);
}

static void expire_mail_allocated(struct mail *_mail)
{
    struct expire_mailbox *xpr_box = EXPIRE_CONTEXT(_mail->box);
    struct mail_private *mail = (struct mail_private *)_mail;
    struct mail_vfuncs *v = mail->vlast;
    union mail_module_context *xpr_mail;

    if (xpr_box == NULL)
        return;

    xpr_mail = p_new(mail->pool, union mail_module_context, 1);
    xpr_mail->super = *v;
    mail->vlast = &xpr_mail->super;

    v->expunge = expire_mail_expunge;
    MODULE_CONTEXT_SET_SELF(mail, expire_mail_module, xpr_mail);
}

static int expire_save_finish(struct mail_save_context *ctx)
{
    struct expire_transaction_context *xt =
        EXPIRE_CONTEXT(ctx->transaction);
    struct expire_mailbox *xpr_box = EXPIRE_CONTEXT(ctx->transaction->box);

    xt->saves = TRUE;
    return xpr_box->module_ctx.super.save_finish(ctx);
}

static int
expire_copy(struct mail_save_context *ctx, struct mail *mail)
{
    struct expire_transaction_context *xt =
        EXPIRE_CONTEXT(ctx->transaction);
    struct expire_mailbox *xpr_box = EXPIRE_CONTEXT(ctx->transaction->box);

    xt->saves = TRUE;
    return xpr_box->module_ctx.super.copy(ctx, mail);
}

static void expire_mailbox_allocate_init(struct mailbox *box)
{
    struct mailbox_vfuncs *v = box->vlast;
    struct expire_mailbox *xpr_box;

    xpr_box = p_new(box->pool, struct expire_mailbox, 1);
    xpr_box->module_ctx.super = *v;
    box->vlast = &xpr_box->module_ctx.super;

    v->transaction_begin = expire_mailbox_transaction_begin;
    v->transaction_commit = expire_mailbox_transaction_commit;
    v->transaction_rollback = expire_mailbox_transaction_rollback;
    v->save_finish = expire_save_finish;
    v->copy = expire_copy;

    MODULE_CONTEXT_SET(box, expire_storage_module, xpr_box);
}

static void expire_mailbox_allocated(struct mailbox *box)
{
    struct expire_mail_user *euser =
        EXPIRE_USER_CONTEXT(box->storage->user);

    if (euser != NULL && expire_set_lookup(euser->set, box->vname))
        expire_mailbox_allocate_init(box);
}

static void expire_mail_user_deinit(struct mail_user *user)
{
    struct expire_mail_user *euser = EXPIRE_USER_CONTEXT(user);

    dict_deinit(&euser->db);
    expire_set_deinit(&euser->set);

    euser->module_ctx.super.deinit(user);
}

static const char *const *expire_get_patterns(struct mail_user *user)
{
    ARRAY_TYPE(const_string) patterns;
    const char *str;
    char set_name[6+MAX_INT_STRLEN+1];
    unsigned int i;

    t_array_init(&patterns, 16);
    str = mail_user_set_plugin_getenv(user->set, "expire");
    for (i = 2; str != NULL; i++) {
        array_append(&patterns, &str, 1);

        if (i_snprintf(set_name, sizeof(set_name), "expire%u", i) < 0)
            i_unreached();
        str = mail_user_set_plugin_getenv(user->set, set_name);
    }
    (void)array_append_space(&patterns);
    return array_idx(&patterns, 0);
}

static void expire_mail_namespaces_created(struct mail_namespace *ns)
{
    struct mail_user *user = ns->user;
    struct expire_mail_user *euser;
    const char *dict_uri;

    dict_uri = mail_user_plugin_getenv(user, "expire_dict");
    if (mail_user_plugin_getenv(user, "expire") == NULL) {
        if (user->mail_debug)
            i_debug("expire: No expire setting - plugin disabled");
    } else if (dict_uri == NULL) {
        i_error("expire plugin: expire_dict setting missing");
    } else {
        struct mail_user_vfuncs *v = user->vlast;

        euser = p_new(user->pool, struct expire_mail_user, 1);
        euser->module_ctx.super = *v;
        user->vlast = &euser->module_ctx.super;
        v->deinit = expire_mail_user_deinit;

        euser->set = expire_set_init(expire_get_patterns(user));
        /* we're using only shared dictionary, the username
           doesn't matter. */
        euser->db = dict_init(dict_uri, DICT_DATA_TYPE_UINT32, "",
                      user->set->base_dir);
        if (euser->db == NULL)
            i_error("expire plugin: dict_init(%s) failed", dict_uri);
        else
            MODULE_CONTEXT_SET(user, expire_mail_user_module, euser);
    }
}

static struct mail_storage_hooks expire_mail_storage_hooks = {
    .mail_namespaces_created = expire_mail_namespaces_created,
    .mailbox_allocated = expire_mailbox_allocated,
    .mail_allocated = expire_mail_allocated
};

void expire_plugin_init(struct module *module)
{
    mail_storage_hooks_add(module, &expire_mail_storage_hooks);
}

void expire_plugin_deinit(void)
{
    mail_storage_hooks_remove(&expire_mail_storage_hooks);
}