index/dbox-common/dbox-mail.c

	dbox-mail.c revision a81b240cfe84231eac64084efd5b0e1e91a9e817
32c2612514a404ebc226f32bb88f28d76ceb1db1Aki Tuomi/* Copyright (c) 2007-2010 Dovecot authors, see the included COPYING file */
32c2612514a404ebc226f32bb88f28d76ceb1db1Aki Tuomi
32c2612514a404ebc226f32bb88f28d76ceb1db1Aki Tuomi#include "lib.h"
32c2612514a404ebc226f32bb88f28d76ceb1db1Aki Tuomi#include "istream.h"
32c2612514a404ebc226f32bb88f28d76ceb1db1Aki Tuomi#include "str.h"
32c2612514a404ebc226f32bb88f28d76ceb1db1Aki Tuomi#include "index-storage.h"
32c2612514a404ebc226f32bb88f28d76ceb1db1Aki Tuomi#include "index-mail.h"
32c2612514a404ebc226f32bb88f28d76ceb1db1Aki Tuomi#include "dbox-storage.h"
32c2612514a404ebc226f32bb88f28d76ceb1db1Aki Tuomi#include "dbox-file.h"
32c2612514a404ebc226f32bb88f28d76ceb1db1Aki Tuomi#include "dbox-mail.h"
32c2612514a404ebc226f32bb88f28d76ceb1db1Aki Tuomi
32c2612514a404ebc226f32bb88f28d76ceb1db1Aki Tuomi#include <stdlib.h>
32c2612514a404ebc226f32bb88f28d76ceb1db1Aki Tuomi
32c2612514a404ebc226f32bb88f28d76ceb1db1Aki Tuomistruct mail *
32c2612514a404ebc226f32bb88f28d76ceb1db1Aki Tuomidbox_mail_alloc(struct mailbox_transaction_context *t,
32c2612514a404ebc226f32bb88f28d76ceb1db1Aki Tuomi        enum mail_fetch_field wanted_fields,
32c2612514a404ebc226f32bb88f28d76ceb1db1Aki Tuomi        struct mailbox_header_lookup_ctx *wanted_headers)
32c2612514a404ebc226f32bb88f28d76ceb1db1Aki Tuomi{
32c2612514a404ebc226f32bb88f28d76ceb1db1Aki Tuomi    struct dbox_mail *mail;
32c2612514a404ebc226f32bb88f28d76ceb1db1Aki Tuomi    pool_t pool;
32c2612514a404ebc226f32bb88f28d76ceb1db1Aki Tuomi
32c2612514a404ebc226f32bb88f28d76ceb1db1Aki Tuomi    pool = pool_alloconly_create("mail", 2048);
32c2612514a404ebc226f32bb88f28d76ceb1db1Aki Tuomi    mail = p_new(pool, struct dbox_mail, 1);
32c2612514a404ebc226f32bb88f28d76ceb1db1Aki Tuomi    mail->imail.mail.pool = pool;
32c2612514a404ebc226f32bb88f28d76ceb1db1Aki Tuomi
32c2612514a404ebc226f32bb88f28d76ceb1db1Aki Tuomi    index_mail_init(&mail->imail, t, wanted_fields, wanted_headers);
32c2612514a404ebc226f32bb88f28d76ceb1db1Aki Tuomi    return &mail->imail.mail.mail;
32c2612514a404ebc226f32bb88f28d76ceb1db1Aki Tuomi}
32c2612514a404ebc226f32bb88f28d76ceb1db1Aki Tuomi
32c2612514a404ebc226f32bb88f28d76ceb1db1Aki Tuomivoid dbox_mail_close(struct mail *_mail)
32c2612514a404ebc226f32bb88f28d76ceb1db1Aki Tuomi{
32c2612514a404ebc226f32bb88f28d76ceb1db1Aki Tuomi    struct dbox_mail *mail = (struct dbox_mail *)_mail;
32c2612514a404ebc226f32bb88f28d76ceb1db1Aki Tuomi
32c2612514a404ebc226f32bb88f28d76ceb1db1Aki Tuomi    if (mail->open_file != NULL)
32c2612514a404ebc226f32bb88f28d76ceb1db1Aki Tuomi        dbox_file_unref(&mail->open_file);
32c2612514a404ebc226f32bb88f28d76ceb1db1Aki Tuomi    index_mail_close(_mail);
32c2612514a404ebc226f32bb88f28d76ceb1db1Aki Tuomi}
32c2612514a404ebc226f32bb88f28d76ceb1db1Aki Tuomi
32c2612514a404ebc226f32bb88f28d76ceb1db1Aki Tuomiint dbox_mail_metadata_read(struct dbox_mail *mail, struct dbox_file **file_r)
32c2612514a404ebc226f32bb88f28d76ceb1db1Aki Tuomi{
32c2612514a404ebc226f32bb88f28d76ceb1db1Aki Tuomi    struct dbox_storage *storage =
32c2612514a404ebc226f32bb88f28d76ceb1db1Aki Tuomi        (struct dbox_storage *)mail->imail.mail.mail.box->storage;
32c2612514a404ebc226f32bb88f28d76ceb1db1Aki Tuomi    uoff_t offset;
32c2612514a404ebc226f32bb88f28d76ceb1db1Aki Tuomi
32c2612514a404ebc226f32bb88f28d76ceb1db1Aki Tuomi    if (storage->v.mail_open(mail, &offset, file_r) < 0)
32c2612514a404ebc226f32bb88f28d76ceb1db1Aki Tuomi        return -1;
32c2612514a404ebc226f32bb88f28d76ceb1db1Aki Tuomi
32c2612514a404ebc226f32bb88f28d76ceb1db1Aki Tuomi    if (dbox_file_seek(*file_r, offset) <= 0)
32c2612514a404ebc226f32bb88f28d76ceb1db1Aki Tuomi        return -1;
32c2612514a404ebc226f32bb88f28d76ceb1db1Aki Tuomi    if (dbox_file_metadata_read(*file_r) <= 0)
32c2612514a404ebc226f32bb88f28d76ceb1db1Aki Tuomi        return -1;
32c2612514a404ebc226f32bb88f28d76ceb1db1Aki Tuomi
32c2612514a404ebc226f32bb88f28d76ceb1db1Aki Tuomi    if (mail->imail.data.stream != NULL) {
32c2612514a404ebc226f32bb88f28d76ceb1db1Aki Tuomi        /* we just messed up mail's input stream by reading metadata */
32c2612514a404ebc226f32bb88f28d76ceb1db1Aki Tuomi        i_stream_seek((*file_r)->input, offset);
32c2612514a404ebc226f32bb88f28d76ceb1db1Aki Tuomi        i_stream_sync(mail->imail.data.stream);
32c2612514a404ebc226f32bb88f28d76ceb1db1Aki Tuomi    }
32c2612514a404ebc226f32bb88f28d76ceb1db1Aki Tuomi    return 0;
32c2612514a404ebc226f32bb88f28d76ceb1db1Aki Tuomi}
32c2612514a404ebc226f32bb88f28d76ceb1db1Aki Tuomi
32c2612514a404ebc226f32bb88f28d76ceb1db1Aki Tuomistatic int
32c2612514a404ebc226f32bb88f28d76ceb1db1Aki Tuomidbox_mail_metadata_get(struct dbox_mail *mail, enum dbox_metadata_key key,
32c2612514a404ebc226f32bb88f28d76ceb1db1Aki Tuomi               const char **value_r)
32c2612514a404ebc226f32bb88f28d76ceb1db1Aki Tuomi{
32c2612514a404ebc226f32bb88f28d76ceb1db1Aki Tuomi    struct dbox_file *file;
32c2612514a404ebc226f32bb88f28d76ceb1db1Aki Tuomi
32c2612514a404ebc226f32bb88f28d76ceb1db1Aki Tuomi    if (dbox_mail_metadata_read(mail, &file) < 0)
32c2612514a404ebc226f32bb88f28d76ceb1db1Aki Tuomi        return -1;
32c2612514a404ebc226f32bb88f28d76ceb1db1Aki Tuomi
32c2612514a404ebc226f32bb88f28d76ceb1db1Aki Tuomi    *value_r = dbox_file_metadata_get(file, key);
32c2612514a404ebc226f32bb88f28d76ceb1db1Aki Tuomi    return 0;
32c2612514a404ebc226f32bb88f28d76ceb1db1Aki Tuomi}
32c2612514a404ebc226f32bb88f28d76ceb1db1Aki Tuomi
32c2612514a404ebc226f32bb88f28d76ceb1db1Aki Tuomiint dbox_mail_get_physical_size(struct mail *_mail, uoff_t *size_r)
32c2612514a404ebc226f32bb88f28d76ceb1db1Aki Tuomi{
32c2612514a404ebc226f32bb88f28d76ceb1db1Aki Tuomi    struct dbox_mail *mail = (struct dbox_mail *)_mail;
32c2612514a404ebc226f32bb88f28d76ceb1db1Aki Tuomi    struct index_mail_data *data = &mail->imail.data;
32c2612514a404ebc226f32bb88f28d76ceb1db1Aki Tuomi    struct dbox_file *file;
32c2612514a404ebc226f32bb88f28d76ceb1db1Aki Tuomi    const char *value;
32c2612514a404ebc226f32bb88f28d76ceb1db1Aki Tuomi
32c2612514a404ebc226f32bb88f28d76ceb1db1Aki Tuomi    if (index_mail_get_physical_size(_mail, size_r) == 0)
32c2612514a404ebc226f32bb88f28d76ceb1db1Aki Tuomi        return 0;
32c2612514a404ebc226f32bb88f28d76ceb1db1Aki Tuomi
32c2612514a404ebc226f32bb88f28d76ceb1db1Aki Tuomi    /* see if we have it in metadata */
32c2612514a404ebc226f32bb88f28d76ceb1db1Aki Tuomi    if (dbox_mail_metadata_read(mail, &file) < 0)
32c2612514a404ebc226f32bb88f28d76ceb1db1Aki Tuomi        return -1;
32c2612514a404ebc226f32bb88f28d76ceb1db1Aki Tuomi
32c2612514a404ebc226f32bb88f28d76ceb1db1Aki Tuomi    value = dbox_file_metadata_get(file, DBOX_METADATA_PHYSICAL_SIZE);
32c2612514a404ebc226f32bb88f28d76ceb1db1Aki Tuomi    if (value != NULL)
32c2612514a404ebc226f32bb88f28d76ceb1db1Aki Tuomi        data->physical_size = strtoul(value, NULL, 16);
32c2612514a404ebc226f32bb88f28d76ceb1db1Aki Tuomi    else {
32c2612514a404ebc226f32bb88f28d76ceb1db1Aki Tuomi        /* no. that means we can use the size in the header */
32c2612514a404ebc226f32bb88f28d76ceb1db1Aki Tuomi        data->physical_size = file->cur_physical_size;
32c2612514a404ebc226f32bb88f28d76ceb1db1Aki Tuomi    }
32c2612514a404ebc226f32bb88f28d76ceb1db1Aki Tuomi    *size_r = data->physical_size;
32c2612514a404ebc226f32bb88f28d76ceb1db1Aki Tuomi    return 0;
32c2612514a404ebc226f32bb88f28d76ceb1db1Aki Tuomi}
32c2612514a404ebc226f32bb88f28d76ceb1db1Aki Tuomi
32c2612514a404ebc226f32bb88f28d76ceb1db1Aki Tuomiint dbox_mail_get_virtual_size(struct mail *_mail, uoff_t *size_r)
32c2612514a404ebc226f32bb88f28d76ceb1db1Aki Tuomi{
32c2612514a404ebc226f32bb88f28d76ceb1db1Aki Tuomi    struct dbox_mail *mail = (struct dbox_mail *)_mail;
32c2612514a404ebc226f32bb88f28d76ceb1db1Aki Tuomi    struct index_mail_data *data = &mail->imail.data;
32c2612514a404ebc226f32bb88f28d76ceb1db1Aki Tuomi    const char *value;
32c2612514a404ebc226f32bb88f28d76ceb1db1Aki Tuomi
32c2612514a404ebc226f32bb88f28d76ceb1db1Aki Tuomi    if (index_mail_get_cached_virtual_size(&mail->imail, size_r))
32c2612514a404ebc226f32bb88f28d76ceb1db1Aki Tuomi        return 0;
32c2612514a404ebc226f32bb88f28d76ceb1db1Aki Tuomi
32c2612514a404ebc226f32bb88f28d76ceb1db1Aki Tuomi    if (dbox_mail_metadata_get(mail, DBOX_METADATA_VIRTUAL_SIZE,
32c2612514a404ebc226f32bb88f28d76ceb1db1Aki Tuomi                   &value) < 0)
32c2612514a404ebc226f32bb88f28d76ceb1db1Aki Tuomi        return -1;
32c2612514a404ebc226f32bb88f28d76ceb1db1Aki Tuomi    if (value == NULL)
32c2612514a404ebc226f32bb88f28d76ceb1db1Aki Tuomi        return index_mail_get_virtual_size(_mail, size_r);
32c2612514a404ebc226f32bb88f28d76ceb1db1Aki Tuomi
2437015089814f398b717725915009878b3f45aaAki Tuomi    data->virtual_size = strtoul(value, NULL, 16);
32c2612514a404ebc226f32bb88f28d76ceb1db1Aki Tuomi    *size_r = data->virtual_size;
32c2612514a404ebc226f32bb88f28d76ceb1db1Aki Tuomi    return 0;
32c2612514a404ebc226f32bb88f28d76ceb1db1Aki Tuomi}
32c2612514a404ebc226f32bb88f28d76ceb1db1Aki Tuomi
32c2612514a404ebc226f32bb88f28d76ceb1db1Aki Tuomiint dbox_mail_get_received_date(struct mail *_mail, time_t *date_r)
32c2612514a404ebc226f32bb88f28d76ceb1db1Aki Tuomi{
32c2612514a404ebc226f32bb88f28d76ceb1db1Aki Tuomi    struct dbox_mail *mail = (struct dbox_mail *)_mail;
32c2612514a404ebc226f32bb88f28d76ceb1db1Aki Tuomi    struct index_mail_data *data = &mail->imail.data;
32c2612514a404ebc226f32bb88f28d76ceb1db1Aki Tuomi    const char *value;
32c2612514a404ebc226f32bb88f28d76ceb1db1Aki Tuomi
32c2612514a404ebc226f32bb88f28d76ceb1db1Aki Tuomi    if (index_mail_get_received_date(_mail, date_r) == 0)
32c2612514a404ebc226f32bb88f28d76ceb1db1Aki Tuomi        return 0;
32c2612514a404ebc226f32bb88f28d76ceb1db1Aki Tuomi
32c2612514a404ebc226f32bb88f28d76ceb1db1Aki Tuomi    if (dbox_mail_metadata_get(mail, DBOX_METADATA_RECEIVED_TIME,
                   &value) < 0)
        return -1;

    data->received_date = value == NULL ? 0 : strtoul(value, NULL, 16);
    *date_r = data->received_date;
    return 0;
}

int dbox_mail_get_save_date(struct mail *_mail, time_t *date_r)
{
    struct dbox_storage *storage =
        (struct dbox_storage *)_mail->box->storage;
    struct dbox_mail *mail = (struct dbox_mail *)_mail;
    struct index_mail_data *data = &mail->imail.data;
    struct dbox_file *file;
    struct stat st;
    uoff_t offset;

    if (index_mail_get_save_date(_mail, date_r) == 0)
        return 0;

    if (storage->v.mail_open(mail, &offset, &file) < 0)
        return -1;

    mail->imail.mail.stats_fstat_lookup_count++;
    if (dbox_file_stat(file, &st) < 0) {
        if (errno == ENOENT)
            mail_set_expunged(_mail);
        return -1;
    }
    *date_r = data->save_date = st.st_ctime;
    return 0;
}

static int
dbox_get_cached_metadata(struct dbox_mail *mail, enum dbox_metadata_key key,
             enum index_cache_field cache_field,
             const char **value_r)
{
    struct index_mail *imail = &mail->imail;
    struct index_mailbox_context *ibox =
        INDEX_STORAGE_CONTEXT(imail->mail.mail.box);
    const char *value;
    string_t *str;

    str = str_new(imail->data_pool, 64);
    if (mail_cache_lookup_field(imail->trans->cache_view, str,
                    imail->mail.mail.seq,
                    ibox->cache_fields[cache_field].idx) > 0) {
        *value_r = str_c(str);
        return 0;
    }

    if (dbox_mail_metadata_get(mail, key, &value) < 0)
        return -1;

    if (value == NULL)
        value = "";
    index_mail_cache_add_idx(imail, ibox->cache_fields[cache_field].idx,
                 value, strlen(value)+1);
    *value_r = value;
    return 0;
}

int dbox_mail_get_special(struct mail *_mail, enum mail_fetch_field field,
              const char **value_r)
{
    struct dbox_mail *mail = (struct dbox_mail *)_mail;

    /* keep the UIDL in cache file, otherwise POP3 would open all
       mail files and read the metadata. same for GUIDs if they're
       used. */
    switch (field) {
    case MAIL_FETCH_UIDL_BACKEND:
        return dbox_get_cached_metadata(mail, DBOX_METADATA_POP3_UIDL,
                        MAIL_CACHE_POP3_UIDL, value_r);
    case MAIL_FETCH_GUID:
        return dbox_get_cached_metadata(mail, DBOX_METADATA_GUID,
                        MAIL_CACHE_GUID, value_r);
    default:
        break;
    }

    return index_mail_get_special(_mail, field, value_r);
}

int dbox_mail_get_stream(struct mail *_mail, struct message_size *hdr_size,
             struct message_size *body_size,
             struct istream **stream_r)
{
    struct dbox_storage *storage =
        (struct dbox_storage *)_mail->box->storage;
    struct dbox_mail *mail = (struct dbox_mail *)_mail;
    struct index_mail_data *data = &mail->imail.data;
    struct istream *input;
    uoff_t offset;
    int ret;

    if (data->stream == NULL) {
        if (storage->v.mail_open(mail, &offset, &mail->open_file) < 0)
            return -1;

        ret = dbox_file_get_mail_stream(mail->open_file, offset,
                        &input);
        if (ret <= 0) {
            if (ret < 0)
                return -1;
            dbox_file_set_corrupted(mail->open_file,
                "uid=%u points to broken data at offset="
                "%"PRIuUOFF_T, _mail->uid, offset);
            return -1;
        }
        data->stream = input;
    }

    return index_mail_init_stream(&mail->imail, hdr_size, body_size,
                      stream_r);
}