index/mbox/mbox-sync-private.h

	mbox-sync-private.h revision d0e5f8252516c4d4df2fbcdae4d37f9e5f931199
#ifndef __MBOX_SYNC_PRIVATE_H
#define __MBOX_SYNC_PRIVATE_H

#include "md5.h"
#include "mail-index.h"

enum mbox_sync_flags {
    MBOX_SYNC_LAST_COMMIT   = 0x01,
    MBOX_SYNC_HEADER    = 0x02,
    MBOX_SYNC_LOCK_READING  = 0x04,
    MBOX_SYNC_UNDIRTY   = 0x08
};

struct mbox_flag_type {
    char chr;
    enum mail_flags flag;
};

enum header_position {
    MBOX_HDR_STATUS,
    MBOX_HDR_X_IMAPBASE,
    MBOX_HDR_X_KEYWORDS,
    MBOX_HDR_X_STATUS,
    MBOX_HDR_X_UID,

        MBOX_HDR_COUNT
};

#define MBOX_NONRECENT MAIL_RECENT /* kludgy */
#define MBOX_EXPUNGED 0x40
#define MBOX_DIRTY_SPACE 0x80

#define STATUS_FLAGS_MASK (MAIL_SEEN|MBOX_NONRECENT)
#define XSTATUS_FLAGS_MASK (MAIL_ANSWERED|MAIL_FLAGGED|MAIL_DRAFT|MAIL_DELETED)
extern struct mbox_flag_type mbox_status_flags[];
extern struct mbox_flag_type mbox_xstatus_flags[];

struct mbox_sync_mail {
    uint32_t uid;
    uint32_t idx_seq;
    uint8_t flags;
    keywords_mask_t keywords;

    uoff_t from_offset;
    uoff_t body_size;

    /* following variables have a bit overloaded functionality:

       a) space <= 0 : offset points to beginning of headers. space is the
          amount of space missing that is required to be able to rewrite
          the headers
       b) space > 0 : offset points to beginning of whitespace that can
          be removed. space is the amount of data that can be removed from
          there. note that the message may contain more whitespace
          elsewhere. */
    uoff_t offset;
    off_t space;
};

struct mbox_sync_mail_context {
    struct mbox_sync_context *sync_ctx;
    struct mbox_sync_mail mail;

    uint32_t seq;
    uoff_t hdr_offset, body_offset;

    size_t header_first_change, header_last_change;
    string_t *header, *uidl;

    struct md5_context hdr_md5_ctx;
    unsigned char hdr_md5_sum[16];

    uoff_t content_length;

    size_t hdr_pos[MBOX_HDR_COUNT];
    uint32_t parsed_uid;

    unsigned int have_eoh:1;
    unsigned int need_rewrite:1;
    unsigned int seen_imapbase:1;
    unsigned int pseudo:1;
    unsigned int updated:1;
    unsigned int recent:1;
    unsigned int seen_received_hdr:1;
};

struct mbox_sync_context {
    struct index_mailbox *ibox;
    struct istream *input, *file_input;
    int fd;

    struct mail_index_sync_ctx *index_sync_ctx;
    struct mail_index_view *sync_view;
    struct mail_index_transaction *t;
    const struct mail_index_header *hdr;

    string_t *header, *uidl, *from_line;

    /* header state: */
    uint32_t base_uid_validity, base_uid_last;
    uint32_t update_base_uid_last;

    /* mail state: */
    buffer_t *mails, *syncs;
    struct mail_index_sync_rec sync_rec;

    uint32_t prev_msg_uid, next_uid;
    uint32_t seq, idx_seq, need_space_seq, need_space_idx_seq;
    off_t expunged_space, space_diff;

    unsigned int dest_first_mail:1;
    unsigned int seen_first_mail:1;
};

int mbox_sync(struct index_mailbox *ibox, enum mbox_sync_flags flags);
int mbox_sync_has_changed(struct index_mailbox *ibox, int leave_dirty);

void mbox_sync_parse_next_mail(struct istream *input,
                   struct mbox_sync_mail_context *ctx);
int mbox_sync_parse_match_mail(struct index_mailbox *ibox,
                   struct mail_index_view *view, uint32_t seq);

void mbox_sync_update_header(struct mbox_sync_mail_context *ctx,
                 buffer_t *syncs_buf);
void mbox_sync_update_header_from(struct mbox_sync_mail_context *ctx,
                  const struct mbox_sync_mail *mail);
int mbox_sync_try_rewrite(struct mbox_sync_mail_context *ctx, off_t move_diff,
              int leave_space_hole);
int mbox_sync_rewrite(struct mbox_sync_context *sync_ctx, uoff_t extra_space,
              uint32_t first_seq, uint32_t last_seq);

int mbox_sync_seek(struct mbox_sync_context *sync_ctx, uoff_t from_offset);
int mbox_move(struct mbox_sync_context *sync_ctx,
          uoff_t dest, uoff_t source, uoff_t size);
void mbox_sync_move_buffer(struct mbox_sync_mail_context *ctx,
               size_t pos, size_t need, size_t have);

#endif