doveadm-mail-fetch.c revision 50859db1fd7dd99d94091a05550090ac3a7b3db7
3236N/A/* Copyright (c) 2010 Dovecot authors, see the included COPYING file */
3236N/A
3236N/A#include "lib.h"
3236N/A#include "array.h"
3236N/A#include "istream.h"
3236N/A#include "ostream.h"
3236N/A#include "str.h"
3236N/A#include "message-size.h"
3236N/A#include "imap-utf7.h"
3236N/A#include "imap-util.h"
3236N/A#include "mail-user.h"
3236N/A#include "mail-storage.h"
3236N/A#include "mail-search.h"
3236N/A#include "mail-namespace.h"
3236N/A#include "doveadm-print.h"
3236N/A#include "doveadm-mail.h"
3236N/A#include "doveadm-mail-list-iter.h"
3236N/A#include "doveadm-mail-iter.h"
3236N/A
3236N/A#include <stdio.h>
3236N/A
3236N/Astruct fetch_cmd_context {
3236N/A struct doveadm_mail_cmd_context ctx;
3236N/A
3236N/A struct ostream *output;
3236N/A struct mail *mail;
3236N/A
3236N/A ARRAY_DEFINE(fields, const struct fetch_field);
3236N/A ARRAY_TYPE(const_string) header_fields;
3236N/A enum mail_fetch_field wanted_fields;
3236N/A
3236N/A const struct fetch_field *cur_field;
3236N/A};
3236N/A
3236N/Astruct fetch_field {
3236N/A const char *name;
3236N/A enum mail_fetch_field wanted_fields;
3236N/A int (*print)(struct fetch_cmd_context *ctx);
3236N/A};
3236N/A
3236N/Astatic int fetch_user(struct fetch_cmd_context *ctx)
3236N/A{
3236N/A doveadm_print(ctx->ctx.cur_mail_user->username);
3236N/A return 0;
3236N/A}
3236N/A
3236N/Astatic int fetch_mailbox(struct fetch_cmd_context *ctx)
3236N/A{
3236N/A const char *value;
3236N/A string_t *str = t_str_new(128);
3236N/A
3236N/A if (mail_get_special(ctx->mail, MAIL_FETCH_MAILBOX_NAME, &value) < 0)
3236N/A return -1;
3236N/A
3236N/A if (imap_utf7_to_utf8(value, str) == 0)
3236N/A doveadm_print(str_c(str));
3236N/A else {
3236N/A /* not a valid mUTF-7 name, fallback to showing it as-is */
3236N/A doveadm_print(value);
3236N/A }
3236N/A return 0;
3236N/A}
3236N/A
3236N/Astatic int fetch_mailbox_guid(struct fetch_cmd_context *ctx)
3236N/A{
3236N/A uint8_t guid[MAIL_GUID_128_SIZE];
3236N/A
3236N/A if (mailbox_get_guid(ctx->mail->box, guid) < 0)
3236N/A return -1;
3236N/A doveadm_print(mail_guid_128_to_string(guid));
3236N/A return 0;
3236N/A}
4008N/A
4008N/Astatic int fetch_seq(struct fetch_cmd_context *ctx)
3236N/A{
3236N/A doveadm_print_num(ctx->mail->seq);
3236N/A return 0;
3236N/A}
3236N/A
static int fetch_uid(struct fetch_cmd_context *ctx)
{
doveadm_print_num(ctx->mail->seq);
return 0;
}
static int fetch_guid(struct fetch_cmd_context *ctx)
{
const char *value;
if (mail_get_special(ctx->mail, MAIL_FETCH_GUID, &value) < 0)
return -1;
doveadm_print(value);
return 0;
}
static int fetch_flags(struct fetch_cmd_context *ctx)
{
string_t *str = t_str_new(64);
imap_write_flags(str, mail_get_flags(ctx->mail),
mail_get_keywords(ctx->mail));
doveadm_print(str_c(str));
return 0;
}
static int fetch_hdr(struct fetch_cmd_context *ctx)
{
struct istream *input;
struct message_size hdr_size;
const unsigned char *data;
size_t size;
int ret = 0;
if (mail_get_stream(ctx->mail, &hdr_size, NULL, &input) < 0)
return -1;
input = i_stream_create_limit(input, hdr_size.physical_size);
while (!i_stream_is_eof(input)) {
if (i_stream_read_data(input, &data, &size, 0) == -1)
break;
if (size == 0)
break;
doveadm_print_stream(data, size);
i_stream_skip(input, size);
}
if (input->stream_errno != 0) {
i_error("read() failed: %m");
ret = -1;
}
i_stream_unref(&input);
doveadm_print_stream(NULL, 0);
return ret;
}
static int fetch_hdr_field(struct fetch_cmd_context *ctx)
{
const char *const *value;
string_t *str = t_str_new(256);
bool add_lf = FALSE;
if (mail_get_headers(ctx->mail, ctx->cur_field->name, &value) < 0)
return -1;
for (; *value != NULL; value++) {
if (add_lf)
str_append_c(str, '\n');
str_append(str, *value);
add_lf = TRUE;
}
doveadm_print(str_c(str));
return 0;
}
static int fetch_body(struct fetch_cmd_context *ctx)
{
struct istream *input;
struct message_size hdr_size;
const unsigned char *data;
size_t size;
int ret = 0;
if (mail_get_stream(ctx->mail, &hdr_size, NULL, &input) < 0)
return -1;
i_stream_skip(input, hdr_size.physical_size);
while (!i_stream_is_eof(input)) {
if (i_stream_read_data(input, &data, &size, 0) == -1)
break;
if (size == 0)
break;
doveadm_print_stream(data, size);
i_stream_skip(input, size);
}
if (input->stream_errno != 0) {
i_error("read() failed: %m");
ret = -1;
}
doveadm_print_stream(NULL, 0);
return ret;
}
static int fetch_text(struct fetch_cmd_context *ctx)
{
struct istream *input;
const unsigned char *data;
size_t size;
int ret = 0;
if (mail_get_stream(ctx->mail, NULL, NULL, &input) < 0)
return -1;
while (!i_stream_is_eof(input)) {
if (i_stream_read_data(input, &data, &size, 0) == -1)
break;
if (size == 0)
break;
doveadm_print_stream(data, size);
i_stream_skip(input, size);
}
if (input->stream_errno != 0) {
i_error("read() failed: %m");
ret = -1;
}
doveadm_print_stream(NULL, 0);
return ret;
}
static int fetch_size_physical(struct fetch_cmd_context *ctx)
{
uoff_t size;
if (mail_get_physical_size(ctx->mail, &size) < 0)
return -1;
doveadm_print_num(size);
return 0;
}
static int fetch_size_virtual(struct fetch_cmd_context *ctx)
{
uoff_t size;
if (mail_get_virtual_size(ctx->mail, &size) < 0)
return -1;
doveadm_print_num(size);
return 0;
}
static int fetch_date_received(struct fetch_cmd_context *ctx)
{
time_t t;
if (mail_get_received_date(ctx->mail, &t) < 0)
return -1;
doveadm_print(unixdate2str(t));
return 0;
}
static int fetch_date_sent(struct fetch_cmd_context *ctx)
{
time_t t;
int tz;
char chr;
if (mail_get_date(ctx->mail, &t, &tz) < 0)
return -1;
chr = tz < 0 ? '-' : '+';
if (tz < 0) tz = -tz;
doveadm_print(t_strdup_printf("%s (%c%02u%02u)", unixdate2str(t),
chr, tz/60, tz%60));
return 0;
}
static int fetch_date_saved(struct fetch_cmd_context *ctx)
{
time_t t;
if (mail_get_save_date(ctx->mail, &t) < 0)
return -1;
doveadm_print(unixdate2str(t));
return 0;
}
static int fetch_imap_envelope(struct fetch_cmd_context *ctx)
{
const char *value;
if (mail_get_special(ctx->mail, MAIL_FETCH_IMAP_ENVELOPE, &value) < 0)
return -1;
doveadm_print(value);
return 0;
}
static int fetch_imap_body(struct fetch_cmd_context *ctx)
{
const char *value;
if (mail_get_special(ctx->mail, MAIL_FETCH_IMAP_BODY, &value) < 0)
return -1;
doveadm_print(value);
return 0;
}
static int fetch_imap_bodystructure(struct fetch_cmd_context *ctx)
{
const char *value;
if (mail_get_special(ctx->mail, MAIL_FETCH_IMAP_BODYSTRUCTURE, &value) < 0)
return -1;
doveadm_print(value);
return 0;
}
static const struct fetch_field fetch_fields[] = {
{ "user", 0, fetch_user },
{ "mailbox", 0, fetch_mailbox },
{ "mailbox-guid", 0, fetch_mailbox_guid },
{ "seq", 0, fetch_seq },
{ "uid", 0, fetch_uid },
{ "guid", 0, fetch_guid },
{ "flags", MAIL_FETCH_FLAGS, fetch_flags },
{ "hdr", MAIL_FETCH_STREAM_HEADER, fetch_hdr },
{ "body", MAIL_FETCH_STREAM_BODY, fetch_body },
{ "text", MAIL_FETCH_STREAM_HEADER |
MAIL_FETCH_STREAM_BODY, fetch_text },
{ "size.physical", MAIL_FETCH_PHYSICAL_SIZE, fetch_size_physical },
{ "size.virtual", MAIL_FETCH_VIRTUAL_SIZE, fetch_size_virtual },
{ "date.received", MAIL_FETCH_RECEIVED_DATE, fetch_date_received },
{ "date.sent", MAIL_FETCH_DATE, fetch_date_sent },
{ "date.saved", MAIL_FETCH_SAVE_DATE, fetch_date_saved },
{ "imap.envelope", MAIL_FETCH_IMAP_ENVELOPE, fetch_imap_envelope },
{ "imap.body", MAIL_FETCH_IMAP_BODY, fetch_imap_body },
{ "imap.bodystructure", MAIL_FETCH_IMAP_BODYSTRUCTURE, fetch_imap_bodystructure }
};
static const struct fetch_field *fetch_field_find(const char *name)
{
unsigned int i;
for (i = 0; i < N_ELEMENTS(fetch_fields); i++) {
if (strcmp(fetch_fields[i].name, name) == 0)
return &fetch_fields[i];
}
return NULL;
}
static void print_fetch_fields(void)
{
unsigned int i;
fprintf(stderr, "Available fetch fields: %s", fetch_fields[0].name);
for (i = 1; i < N_ELEMENTS(fetch_fields); i++)
fprintf(stderr, " %s", fetch_fields[i].name);
fprintf(stderr, "\n");
}
static void parse_fetch_fields(struct fetch_cmd_context *ctx, const char *str)
{
const char *const *fields, *name;
const struct fetch_field *field;
struct fetch_field hdr_field;
memset(&hdr_field, 0, sizeof(hdr_field));
hdr_field.print = fetch_hdr_field;
t_array_init(&ctx->fields, 32);
t_array_init(&ctx->header_fields, 32);
fields = t_strsplit_spaces(str, " ");
for (; *fields != NULL; fields++) {
name = t_str_lcase(*fields);
doveadm_print_header_simple(name);
if (strncmp(name, "hdr.", 4) == 0) {
name += 4;
hdr_field.name = name;
array_append(&ctx->fields, &hdr_field, 1);
array_append(&ctx->header_fields, &name, 1);
} else {
field = fetch_field_find(name);
if (field == NULL) {
print_fetch_fields();
i_fatal("Unknown fetch field: %s", name);
}
ctx->wanted_fields |= field->wanted_fields;
array_append(&ctx->fields, field, 1);
}
}
(void)array_append_space(&ctx->header_fields);
}
static void cmd_fetch_mail(struct fetch_cmd_context *ctx)
{
const struct fetch_field *field;
struct mail *mail = ctx->mail;
array_foreach(&ctx->fields, field) {
ctx->cur_field = field;
if (field->print(ctx) < 0) {
struct mail_storage *storage =
mailbox_get_storage(mail->box);
i_error("fetch(%s) failed for box=%s uid=%u: %s",
field->name, mailbox_get_vname(mail->box),
mail->uid, mail_storage_get_last_error(storage, NULL));
}
}
}
static int
cmd_fetch_box(struct fetch_cmd_context *ctx, const struct mailbox_info *info)
{
struct doveadm_mail_iter *iter;
struct mailbox_transaction_context *trans;
struct mail *mail;
struct mailbox_header_lookup_ctx *headers = NULL;
if (doveadm_mail_iter_init(info, ctx->ctx.search_args,
&trans, &iter) < 0)
return -1;
if (array_count(&ctx->header_fields) > 1) {
headers = mailbox_header_lookup_init(
mailbox_transaction_get_mailbox(trans),
array_idx(&ctx->header_fields, 0));
}
mail = mail_alloc(trans, ctx->wanted_fields, headers);
if (headers != NULL)
mailbox_header_lookup_unref(&headers);
while (doveadm_mail_iter_next(iter, mail)) {
ctx->mail = mail;
T_BEGIN {
cmd_fetch_mail(ctx);
} T_END;
ctx->mail = NULL;
}
mail_free(&mail);
return doveadm_mail_iter_deinit(&iter);
}
static void
cmd_fetch_run(struct doveadm_mail_cmd_context *_ctx, struct mail_user *user)
{
struct fetch_cmd_context *ctx = (struct fetch_cmd_context *)_ctx;
const enum mailbox_list_iter_flags iter_flags =
MAILBOX_LIST_ITER_VIRTUAL_NAMES |
MAILBOX_LIST_ITER_NO_AUTO_INBOX |
MAILBOX_LIST_ITER_RETURN_NO_FLAGS;
struct doveadm_mail_list_iter *iter;
const struct mailbox_info *info;
iter = doveadm_mail_list_iter_init(user, _ctx->search_args, iter_flags);
while ((info = doveadm_mail_list_iter_next(iter)) != NULL) T_BEGIN {
(void)cmd_fetch_box(ctx, info);
} T_END;
doveadm_mail_list_iter_deinit(&iter);
}
static void cmd_fetch_deinit(struct doveadm_mail_cmd_context *_ctx)
{
struct fetch_cmd_context *ctx = (struct fetch_cmd_context *)_ctx;
o_stream_unref(&ctx->output);
}
static void cmd_fetch_init(struct doveadm_mail_cmd_context *_ctx,
const char *const args[])
{
struct fetch_cmd_context *ctx = (struct fetch_cmd_context *)_ctx;
const char *fetch_fields = args[0];
if (fetch_fields == NULL || args[1] == NULL)
doveadm_mail_help_name("fetch");
parse_fetch_fields(ctx, fetch_fields);
_ctx->search_args = doveadm_mail_build_search_args(args + 1);
ctx->output = o_stream_create_fd(STDOUT_FILENO, 0, FALSE);
}
static struct doveadm_mail_cmd_context *cmd_fetch_alloc(void)
{
struct fetch_cmd_context *ctx;
ctx = doveadm_mail_cmd_alloc(struct fetch_cmd_context);
ctx->ctx.v.init = cmd_fetch_init;
ctx->ctx.v.run = cmd_fetch_run;
ctx->ctx.v.deinit = cmd_fetch_deinit;
doveadm_print_init("pager");
return &ctx->ctx;
}
struct doveadm_mail_cmd cmd_fetch = {
cmd_fetch_alloc, "fetch", "<fields> <search query>"
};