1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569
|
/* Copyright (c) 2002-2013 Pigeonhole authors, see the included COPYING file
*/
#include "lib.h"
#include "ioloop.h"
#include "mempool.h"
#include "array.h"
#include "str.h"
#include "str-sanitize.h"
#include "istream.h"
#include "mail-storage.h"
#include "mail-user.h"
#include "master-service.h"
#include "master-service-settings.h"
#include "raw-storage.h"
#include "edit-mail.h"
#include "sieve-common.h"
#include "sieve-stringlist.h"
#include "sieve-error.h"
#include "sieve-extensions.h"
#include "sieve-runtime.h"
#include "sieve-runtime-trace.h"
#include "sieve-address.h"
#include "sieve-message.h"
/*
* Message transmission
*/
const char *sieve_message_get_new_id(const struct sieve_instance *svinst)
{
static int count = 0;
return t_strdup_printf("<dovecot-sieve-%s-%s-%d@%s>",
dec2str(ioloop_timeval.tv_sec), dec2str(ioloop_timeval.tv_usec),
count++, svinst->hostname);
}
/*
* Message context
*/
struct sieve_message_version {
struct mail *mail;
struct mailbox *box;
struct mailbox_transaction_context *trans;
struct edit_mail *edit_mail;
};
struct sieve_message_context {
pool_t pool;
pool_t context_pool;
int refcount;
struct sieve_instance *svinst;
struct mail_user *mail_user;
const struct sieve_message_data *msgdata;
/* Normalized envelope addresses */
bool envelope_parsed;
const struct sieve_address *envelope_sender;
const struct sieve_address *envelope_orig_recipient;
const struct sieve_address *envelope_final_recipient;
/* Message versioning */
struct mail_user *raw_mail_user;
ARRAY(struct sieve_message_version) versions;
/* Context data for extensions */
ARRAY(void *) ext_contexts;
unsigned int edit_snapshot:1;
unsigned int substitute_snapshot:1;
};
/*
* Message versions
*/
static inline struct sieve_message_version *sieve_message_version_new
(struct sieve_message_context *msgctx)
{
return array_append_space(&msgctx->versions);
}
static inline struct sieve_message_version *sieve_message_version_get
(struct sieve_message_context *msgctx)
{
struct sieve_message_version *versions;
unsigned int count;
versions = array_get_modifiable(&msgctx->versions, &count);
if ( count == 0 )
return array_append_space(&msgctx->versions);
return &versions[count-1];
}
static inline void sieve_message_version_free
(struct sieve_message_version *version)
{
if ( version->edit_mail != NULL ) {
edit_mail_unwrap(&version->edit_mail);
version->edit_mail = NULL;
}
if ( version->mail != NULL ) {
mail_free(&version->mail);
mailbox_transaction_rollback(&version->trans);
mailbox_free(&version->box);
version->mail = NULL;
}
}
/*
* Message context object
*/
struct sieve_message_context *sieve_message_context_create
(struct sieve_instance *svinst, struct mail_user *mail_user,
const struct sieve_message_data *msgdata)
{
struct sieve_message_context *msgctx;
msgctx = i_new(struct sieve_message_context, 1);
msgctx->refcount = 1;
msgctx->svinst = svinst;
msgctx->mail_user = mail_user;
msgctx->msgdata = msgdata;
sieve_message_context_reset(msgctx);
return msgctx;
}
void sieve_message_context_ref(struct sieve_message_context *msgctx)
{
msgctx->refcount++;
}
static void sieve_message_context_clear(struct sieve_message_context *msgctx)
{
struct sieve_message_version *versions;
unsigned int count, i;
if ( msgctx->pool != NULL ) {
versions = array_get_modifiable(&msgctx->versions, &count);
for ( i = 0; i < count; i++ ) {
sieve_message_version_free(&versions[i]);
}
pool_unref(&(msgctx->pool));
}
msgctx->envelope_orig_recipient = NULL;
msgctx->envelope_final_recipient = NULL;
msgctx->envelope_sender = NULL;
msgctx->envelope_parsed = FALSE;
}
void sieve_message_context_unref(struct sieve_message_context **msgctx)
{
i_assert((*msgctx)->refcount > 0);
if (--(*msgctx)->refcount != 0)
return;
if ( (*msgctx)->raw_mail_user != NULL )
mail_user_unref(&(*msgctx)->raw_mail_user);
sieve_message_context_clear(*msgctx);
if ( (*msgctx)->context_pool != NULL )
pool_unref(&((*msgctx)->context_pool));
i_free(*msgctx);
*msgctx = NULL;
}
static void sieve_message_context_flush(struct sieve_message_context *msgctx)
{
if ( msgctx->context_pool != NULL )
pool_unref(&(msgctx->context_pool));
msgctx->context_pool =
pool_alloconly_create("sieve_message_context_data", 1024);
p_array_init(&msgctx->ext_contexts, msgctx->context_pool,
sieve_extensions_get_count(msgctx->svinst));
}
void sieve_message_context_reset(struct sieve_message_context *msgctx)
{
sieve_message_context_clear(msgctx);
msgctx->pool = pool_alloconly_create("sieve_message_context", 1024);
p_array_init(&msgctx->versions, msgctx->pool, 4);
sieve_message_context_flush(msgctx);
}
pool_t sieve_message_context_pool(struct sieve_message_context *msgctx)
{
return msgctx->context_pool;
}
/* Extension support */
void sieve_message_context_extension_set
(struct sieve_message_context *msgctx, const struct sieve_extension *ext,
void *context)
{
if ( ext->id < 0 ) return;
array_idx_set(&msgctx->ext_contexts, (unsigned int) ext->id, &context);
}
const void *sieve_message_context_extension_get
(struct sieve_message_context *msgctx, const struct sieve_extension *ext)
{
void * const *ctx;
if ( ext->id < 0 || ext->id >= (int) array_count(&msgctx->ext_contexts) )
return NULL;
ctx = array_idx(&msgctx->ext_contexts, (unsigned int) ext->id);
return *ctx;
}
/* Envelope */
static void sieve_message_envelope_parse(struct sieve_message_context *msgctx)
{
const struct sieve_message_data *msgdata = msgctx->msgdata;
struct sieve_instance *svinst = msgctx->svinst;
/* FIXME: log parse problems properly; logs only 'failure' now */
msgctx->envelope_orig_recipient = sieve_address_parse_envelope_path
(msgctx->pool, msgdata->orig_envelope_to);
if ( msgctx->envelope_orig_recipient == NULL ) {
sieve_sys_error(svinst,
"original envelope recipient address '%s' is unparsable",
msgdata->orig_envelope_to);
} else if ( msgctx->envelope_orig_recipient->local_part == NULL ) {
sieve_sys_error(svinst,
"original envelope recipient address '%s' is a null path",
msgdata->orig_envelope_to);
}
msgctx->envelope_final_recipient = sieve_address_parse_envelope_path
(msgctx->pool, msgdata->final_envelope_to);
if ( msgctx->envelope_final_recipient == NULL ) {
if ( msgctx->envelope_orig_recipient != NULL ) {
sieve_sys_error(svinst,
"final envelope recipient address '%s' is unparsable",
msgdata->final_envelope_to);
}
} else if ( msgctx->envelope_final_recipient->local_part == NULL ) {
if ( strcmp(msgdata->orig_envelope_to, msgdata->final_envelope_to) != 0 ) {
sieve_sys_error(svinst,
"final envelope recipient address '%s' is a null path",
msgdata->final_envelope_to);
}
}
msgctx->envelope_sender = sieve_address_parse_envelope_path
(msgctx->pool, msgdata->return_path);
if ( msgctx->envelope_sender == NULL ) {
sieve_sys_error(svinst,
"envelope sender address '%s' is unparsable",
msgdata->return_path);
}
msgctx->envelope_parsed = TRUE;
}
const struct sieve_address *sieve_message_get_orig_recipient_address
(struct sieve_message_context *msgctx)
{
if ( !msgctx->envelope_parsed )
sieve_message_envelope_parse(msgctx);
return msgctx->envelope_orig_recipient;
}
const struct sieve_address *sieve_message_get_final_recipient_address
(struct sieve_message_context *msgctx)
{
if ( !msgctx->envelope_parsed )
sieve_message_envelope_parse(msgctx);
return msgctx->envelope_final_recipient;
}
const struct sieve_address *sieve_message_get_sender_address
(struct sieve_message_context *msgctx)
{
if ( !msgctx->envelope_parsed )
sieve_message_envelope_parse(msgctx);
return msgctx->envelope_sender;
}
const char *sieve_message_get_orig_recipient
(struct sieve_message_context *msgctx)
{
if ( !msgctx->envelope_parsed )
sieve_message_envelope_parse(msgctx);
return sieve_address_to_string(msgctx->envelope_orig_recipient);
}
const char *sieve_message_get_final_recipient
(struct sieve_message_context *msgctx)
{
if ( !msgctx->envelope_parsed )
sieve_message_envelope_parse(msgctx);
return sieve_address_to_string(msgctx->envelope_final_recipient);
}
const char *sieve_message_get_sender
(struct sieve_message_context *msgctx)
{
if ( !msgctx->envelope_parsed )
sieve_message_envelope_parse(msgctx);
return sieve_address_to_string(msgctx->envelope_sender);
}
/*
* Mail
*/
int sieve_message_substitute
(struct sieve_message_context *msgctx, struct istream *input)
{
static const char *wanted_headers[] = {
"From", "Message-ID", "Subject", "Return-Path", NULL
};
struct mail_user *mail_user = msgctx->mail_user;
struct sieve_message_version *version;
struct mailbox_header_lookup_ctx *headers_ctx;
struct mailbox *box = NULL;
const char *sender;
int ret;
if ( msgctx->raw_mail_user == NULL ) {
void **sets = master_service_settings_get_others(master_service);
msgctx->raw_mail_user =
raw_storage_create_from_set(mail_user->set_info, sets[0]);
}
i_stream_seek(input, 0);
sender = sieve_message_get_sender(msgctx);
sender = (sender == NULL ? DEFAULT_ENVELOPE_SENDER : sender );
ret = raw_mailbox_alloc_stream(msgctx->raw_mail_user, input, (time_t)-1,
sender, &box);
if ( ret < 0 ) {
sieve_sys_error(msgctx->svinst, "can't open substituted mail as raw: %s",
mailbox_get_last_error(box, NULL));
return -1;
}
if ( msgctx->substitute_snapshot ) {
version = sieve_message_version_new(msgctx);
} else {
version = sieve_message_version_get(msgctx);
sieve_message_version_free(version);
}
version->box = box;
version->trans = mailbox_transaction_begin(box, 0);
headers_ctx = mailbox_header_lookup_init(box, wanted_headers);
version->mail = mail_alloc(version->trans, 0, headers_ctx);
mailbox_header_lookup_unref(&headers_ctx);
mail_set_seq(version->mail, 1);
sieve_message_context_flush(msgctx);
msgctx->substitute_snapshot = FALSE;
msgctx->edit_snapshot = FALSE;
return 1;
}
struct mail *sieve_message_get_mail
(struct sieve_message_context *msgctx)
{
const struct sieve_message_version *versions;
unsigned int count;
versions = array_get(&msgctx->versions, &count);
if ( count == 0 )
return msgctx->msgdata->mail;
if ( versions[count-1].edit_mail != NULL )
return edit_mail_get_mail(versions[count-1].edit_mail);
return versions[count-1].mail;
}
struct edit_mail *sieve_message_edit
(struct sieve_message_context *msgctx)
{
struct sieve_message_version *version;
version = sieve_message_version_get(msgctx);
if ( version->edit_mail == NULL ) {
version->edit_mail = edit_mail_wrap
(( version->mail == NULL ? msgctx->msgdata->mail : version->mail ));
} else if ( msgctx->edit_snapshot ) {
version->edit_mail = edit_mail_snapshot(version->edit_mail);
}
msgctx->edit_snapshot = FALSE;
return version->edit_mail;
}
void sieve_message_snapshot
(struct sieve_message_context *msgctx)
{
msgctx->edit_snapshot = TRUE;
msgctx->substitute_snapshot = TRUE;
}
/*
* Header stringlist
*/
/* Forward declarations */
static int sieve_message_header_stringlist_next_item
(struct sieve_stringlist *_strlist, string_t **str_r);
static void sieve_message_header_stringlist_reset
(struct sieve_stringlist *_strlist);
/* String list object */
struct sieve_message_header_stringlist {
struct sieve_stringlist strlist;
struct sieve_stringlist *field_names;
const char *const *headers;
int headers_index;
unsigned int mime_decode:1;
};
struct sieve_stringlist *sieve_message_header_stringlist_create
(const struct sieve_runtime_env *renv, struct sieve_stringlist *field_names,
bool mime_decode)
{
struct sieve_message_header_stringlist *strlist;
strlist = t_new(struct sieve_message_header_stringlist, 1);
strlist->strlist.runenv = renv;
strlist->strlist.exec_status = SIEVE_EXEC_OK;
strlist->strlist.next_item = sieve_message_header_stringlist_next_item;
strlist->strlist.reset = sieve_message_header_stringlist_reset;
strlist->field_names = field_names;
strlist->mime_decode = mime_decode;
return &strlist->strlist;
}
static inline string_t *_header_right_trim(const char *raw)
{
string_t *result;
int i;
for ( i = strlen(raw)-1; i >= 0; i-- ) {
if ( raw[i] != ' ' && raw[i] != '\t' ) break;
}
result = t_str_new(i+1);
str_append_n(result, raw, i + 1);
return result;
}
/* String list implementation */
static int sieve_message_header_stringlist_next_item
(struct sieve_stringlist *_strlist, string_t **str_r)
{
struct sieve_message_header_stringlist *strlist =
(struct sieve_message_header_stringlist *) _strlist;
const struct sieve_runtime_env *renv = _strlist->runenv;
struct mail *mail = sieve_message_get_mail(renv->msgctx);
*str_r = NULL;
/* Check for end of current header list */
if ( strlist->headers == NULL ) {
strlist->headers_index = 0;
} else if ( strlist->headers[strlist->headers_index] == NULL ) {
strlist->headers = NULL;
strlist->headers_index = 0;
}
/* Fetch next header */
while ( strlist->headers == NULL ) {
string_t *hdr_item = NULL;
int ret;
/* Read next header name from source list */
if ( (ret=sieve_stringlist_next_item(strlist->field_names, &hdr_item))
<= 0 )
return ret;
if ( _strlist->trace ) {
sieve_runtime_trace(renv, 0,
"extracting `%s' headers from message",
str_sanitize(str_c(hdr_item), 80));
}
/* Fetch all matching headers from the e-mail */
if ( strlist->mime_decode ) {
if ( mail_get_headers_utf8(mail, str_c(hdr_item), &strlist->headers) < 0 ||
( strlist->headers != NULL && strlist->headers[0] == NULL ) ) {
/* Try next item when this fails somehow */
strlist->headers = NULL;
continue;
}
} else {
if ( mail_get_headers(mail, str_c(hdr_item), &strlist->headers) < 0 ||
( strlist->headers != NULL && strlist->headers[0] == NULL ) ) {
/* Try next item when this fails somehow */
strlist->headers = NULL;
continue;
}
}
}
/* Return next item */
*str_r = _header_right_trim(strlist->headers[strlist->headers_index++]);
return 1;
}
static void sieve_message_header_stringlist_reset
(struct sieve_stringlist *_strlist)
{
struct sieve_message_header_stringlist *strlist =
(struct sieve_message_header_stringlist *) _strlist;
strlist->headers = NULL;
strlist->headers_index = 0;
sieve_stringlist_reset(strlist->field_names);
}
|