mbox-rewrite.c revision 74a02d35d21807b9f9069964514d8c09e3631ea4
6ae6496c225238a2c55a8cd96744ad976c44a726Stephan Bosch/* Copyright (C) 2002 Timo Sirainen */
6ae6496c225238a2c55a8cd96744ad976c44a726Stephan Boschtypedef struct {
6ae6496c225238a2c55a8cd96744ad976c44a726Stephan Bosch unsigned int seq;
6ae6496c225238a2c55a8cd96744ad976c44a726Stephan Bosch/* Remove dirty flag from all messages */
6ae6496c225238a2c55a8cd96744ad976c44a726Stephan Boschstatic void reset_dirty_flags(MailIndex *index)
6ae6496c225238a2c55a8cd96744ad976c44a726Stephan Bosch index->header->flags &= ~MAIL_INDEX_FLAG_DIRTY_MESSAGES;
6ae6496c225238a2c55a8cd96744ad976c44a726Stephan Boschstatic int mbox_write(MailIndex *index, IOBuffer *inbuf, IOBuffer *outbuf,
6ae6496c225238a2c55a8cd96744ad976c44a726Stephan Bosch /* fsck should have noticed it.. */
6ae6496c225238a2c55a8cd96744ad976c44a726Stephan Bosch index_set_error(index, "Error rewriting mbox file %s: "
6ae6496c225238a2c55a8cd96744ad976c44a726Stephan Boschstatic const char *strip_chars(const char *value, size_t value_len,
6ae6496c225238a2c55a8cd96744ad976c44a726Stephan Bosch /* leave only unknown flags, very likely none */
6ae6496c225238a2c55a8cd96744ad976c44a726Stephan Bosch unsigned int i;
6ae6496c225238a2c55a8cd96744ad976c44a726Stephan Bosch for (i = 0; i < value_len; i++) {
6ae6496c225238a2c55a8cd96744ad976c44a726Stephan Boschstatic void update_stripped_custom_flags(const char *value, size_t len,
6ae6496c225238a2c55a8cd96744ad976c44a726Stephan Bosch /* not found, keep it */
6ae6496c225238a2c55a8cd96744ad976c44a726Stephan Boschstatic const char *strip_custom_flags(const char *value, size_t len,
6ae6496c225238a2c55a8cd96744ad976c44a726Stephan Bosch mbox_keywords_parse(value, len, ctx->custom_flags,
6ae6496c225238a2c55a8cd96744ad976c44a726Stephan Boschstatic void header_func(MessagePart *part __attr_unused__,
6ae6496c225238a2c55a8cd96744ad976c44a726Stephan Bosch if (name_len == 6 && strncasecmp(name, "Status", 6) == 0)
6ae6496c225238a2c55a8cd96744ad976c44a726Stephan Bosch ctx->status = strip_chars(value, value_len, "RO");
6ae6496c225238a2c55a8cd96744ad976c44a726Stephan Bosch else if (name_len == 8 && strncasecmp(name, "X-Status", 8) == 0)
6ae6496c225238a2c55a8cd96744ad976c44a726Stephan Bosch ctx->x_status = strip_chars(value, value_len, "ADFT");
6ae6496c225238a2c55a8cd96744ad976c44a726Stephan Bosch else if (name_len == 10 && strncasecmp(name, "X-Keywords", 10) == 0)
6ae6496c225238a2c55a8cd96744ad976c44a726Stephan Bosch ctx->x_keywords = strip_custom_flags(value, value_len, ctx);
6ae6496c225238a2c55a8cd96744ad976c44a726Stephan Bosch else if (name_len == 10 && strncasecmp(name, "X-IMAPbase", 10) == 0) {
6ae6496c225238a2c55a8cd96744ad976c44a726Stephan Bosch /* temporarily copy the value to make sure we
6ae6496c225238a2c55a8cd96744ad976c44a726Stephan Bosch don't overflow it */
6ae6496c225238a2c55a8cd96744ad976c44a726Stephan Bosch /* save this header */
6ae6496c225238a2c55a8cd96744ad976c44a726Stephan Bosch (void)io_buffer_send(ctx->outbuf, name, name_len);
6ae6496c225238a2c55a8cd96744ad976c44a726Stephan Bosch (void)io_buffer_send(ctx->outbuf, value, value_len);
6ae6496c225238a2c55a8cd96744ad976c44a726Stephan Bosch /* We need to update fields that define message flags. Standard fields
6ae6496c225238a2c55a8cd96744ad976c44a726Stephan Bosch are stored in Status and X-Status. For custom flags we use
6ae6496c225238a2c55a8cd96744ad976c44a726Stephan Bosch uw-imapd compatible format, by first listing them in first message's
6ae6496c225238a2c55a8cd96744ad976c44a726Stephan Bosch X-IMAPbase field and actually defining them in X-Keywords field.
6ae6496c225238a2c55a8cd96744ad976c44a726Stephan Bosch Format of X-IMAPbase is: <UID validity> <last used UID> <flag names>
6ae6496c225238a2c55a8cd96744ad976c44a726Stephan Bosch We don't want to sync our UIDs with the mbox file, so the UID
6ae6496c225238a2c55a8cd96744ad976c44a726Stephan Bosch validity is always kept different from our internal UID validity.
6ae6496c225238a2c55a8cd96744ad976c44a726Stephan Bosch Last used UID is also not updated, and set to 0 initially.
6ae6496c225238a2c55a8cd96744ad976c44a726Stephan Bosch unsigned int field;
6ae6496c225238a2c55a8cd96744ad976c44a726Stephan Bosch /* fsck should have noticed it.. */
6ae6496c225238a2c55a8cd96744ad976c44a726Stephan Bosch index_set_error(index, "Error rewriting mbox file %s: "
6ae6496c225238a2c55a8cd96744ad976c44a726Stephan Bosch custom_flags = mail_custom_flags_list_get(index->custom_flags);
6ae6496c225238a2c55a8cd96744ad976c44a726Stephan Bosch /* parse the header, write the fields we don't want to change */
6ae6496c225238a2c55a8cd96744ad976c44a726Stephan Bosch message_parse_header(NULL, inbuf, &hdr_size, header_func, &ctx);
6ae6496c225238a2c55a8cd96744ad976c44a726Stephan Bosch i_assert(hdr_size.physical_size == rec->header_size);
6ae6496c225238a2c55a8cd96744ad976c44a726Stephan Bosch /* append the flag fields */
6ae6496c225238a2c55a8cd96744ad976c44a726Stephan Bosch /* write X-IMAPbase header to first message */
6ae6496c225238a2c55a8cd96744ad976c44a726Stephan Bosch ctx.uid_validity = index->header->uid_validity-1;
6ae6496c225238a2c55a8cd96744ad976c44a726Stephan Bosch (void)io_buffer_send(outbuf, str, strlen(str));
6ae6496c225238a2c55a8cd96744ad976c44a726Stephan Bosch for (i = 0; i < MAIL_CUSTOM_FLAGS_COUNT; i++) {
6ae6496c225238a2c55a8cd96744ad976c44a726Stephan Bosch if ((rec->msg_flags & MAIL_CUSTOM_FLAGS_MASK) ||
6ae6496c225238a2c55a8cd96744ad976c44a726Stephan Bosch /* write X-Keywords header containing custom flags */
6ae6496c225238a2c55a8cd96744ad976c44a726Stephan Bosch (void)io_buffer_send(outbuf, "X-Keywords:", 11);
6ae6496c225238a2c55a8cd96744ad976c44a726Stephan Bosch for (i = 0; i < MAIL_CUSTOM_FLAGS_COUNT; i++, field <<= 1) {
6ae6496c225238a2c55a8cd96744ad976c44a726Stephan Bosch if (ctx.x_keywords != NULL && ctx.x_keywords[0] != '\0') {
6ae6496c225238a2c55a8cd96744ad976c44a726Stephan Bosch /* X-Keywords that aren't custom flags */
6ae6496c225238a2c55a8cd96744ad976c44a726Stephan Bosch /* Status field */
6ae6496c225238a2c55a8cd96744ad976c44a726Stephan Bosch flags = (rec->msg_flags & MAIL_SEEN) ? "Status: RO" : "Status: O";
6ae6496c225238a2c55a8cd96744ad976c44a726Stephan Bosch (void)io_buffer_send(outbuf, flags, strlen(flags));
6ae6496c225238a2c55a8cd96744ad976c44a726Stephan Bosch /* X-Status field */
6ae6496c225238a2c55a8cd96744ad976c44a726Stephan Bosch if ((rec->msg_flags & (MAIL_SYSTEM_FLAGS_MASK^MAIL_SEEN)) != 0 ||
6ae6496c225238a2c55a8cd96744ad976c44a726Stephan Bosch (void)io_buffer_send(outbuf, flags, strlen(flags));
6ae6496c225238a2c55a8cd96744ad976c44a726Stephan Bosch mail_custom_flags_list_unref(index->custom_flags);
6ae6496c225238a2c55a8cd96744ad976c44a726Stephan Bosch /* empty line ends headers */
6ae6496c225238a2c55a8cd96744ad976c44a726Stephan Bosch /* Write it to temp file and then rename() to real file.
6ae6496c225238a2c55a8cd96744ad976c44a726Stephan Bosch easier and much safer than moving data inside the file.
6ae6496c225238a2c55a8cd96744ad976c44a726Stephan Bosch This rewriting relies quite a lot on valid header/body sizes
6ae6496c225238a2c55a8cd96744ad976c44a726Stephan Bosch which fsck() should have ensured. */
6ae6496c225238a2c55a8cd96744ad976c44a726Stephan Bosch unsigned int seq;
6ae6496c225238a2c55a8cd96744ad976c44a726Stephan Bosch i_assert(index->lock_type == MAIL_LOCK_EXCLUSIVE);
6ae6496c225238a2c55a8cd96744ad976c44a726Stephan Bosch if ((index->header->flags & MAIL_INDEX_FLAG_DIRTY_MESSAGES) == 0) {
6ae6496c225238a2c55a8cd96744ad976c44a726Stephan Bosch /* no need to rewrite */
6ae6496c225238a2c55a8cd96744ad976c44a726Stephan Bosch return mbox_set_syscall_error(index, "open()");
6ae6496c225238a2c55a8cd96744ad976c44a726Stephan Bosch inbuf = io_buffer_create_mmap(in_fd, default_pool,
6ae6496c225238a2c55a8cd96744ad976c44a726Stephan Bosch out_fd = mail_index_create_temp_file(index, &path);
6ae6496c225238a2c55a8cd96744ad976c44a726Stephan Bosch outbuf = io_buffer_create_file(out_fd, default_pool, 8192);
6ae6496c225238a2c55a8cd96744ad976c44a726Stephan Bosch /* get offset to beginning of mail headers */
6ae6496c225238a2c55a8cd96744ad976c44a726Stephan Bosch if (!mbox_mail_get_start_offset(index, rec, &offset)) {
6ae6496c225238a2c55a8cd96744ad976c44a726Stephan Bosch /* fsck should have fixed it */
6ae6496c225238a2c55a8cd96744ad976c44a726Stephan Bosch if (offset + rec->header_size + rec->body_size > inbuf->size) {
6ae6496c225238a2c55a8cd96744ad976c44a726Stephan Bosch index_set_corrupted(index, "Invalid message size");
6ae6496c225238a2c55a8cd96744ad976c44a726Stephan Bosch /* write the From-line */
6ae6496c225238a2c55a8cd96744ad976c44a726Stephan Bosch if (!mbox_write(index, inbuf, outbuf, offset)) {
6ae6496c225238a2c55a8cd96744ad976c44a726Stephan Bosch /* write header, updating flag fields */
6ae6496c225238a2c55a8cd96744ad976c44a726Stephan Bosch if (!mbox_write_header(index, rec, seq, inbuf, outbuf,
6ae6496c225238a2c55a8cd96744ad976c44a726Stephan Bosch /* write body */
6ae6496c225238a2c55a8cd96744ad976c44a726Stephan Bosch if (!mbox_write(index, inbuf, outbuf, offset)) {
6ae6496c225238a2c55a8cd96744ad976c44a726Stephan Bosch /* always end with a \n */
6ae6496c225238a2c55a8cd96744ad976c44a726Stephan Bosch /* all ok, we need to fsck the index next time.
6ae6496c225238a2c55a8cd96744ad976c44a726Stephan Bosch use set_flags because set_lock() would remove it
6ae6496c225238a2c55a8cd96744ad976c44a726Stephan Bosch if we modified it directly */
6ae6496c225238a2c55a8cd96744ad976c44a726Stephan Bosch index_set_error(index, "rename(%s, %s) failed: %m",