index/mbox/mbox-sync-private.h

#ifndef MBOX_SYNC_PRIVATE_H
#define MBOX_SYNC_PRIVATE_H

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

#include <sys/stat.h>

enum mbox_sync_flags {
    MBOX_SYNC_HEADER    = 0x02,
    MBOX_SYNC_LOCK_READING  = 0x04,
    MBOX_SYNC_UNDIRTY   = 0x08,
    MBOX_SYNC_REWRITE   = 0x10,
    MBOX_SYNC_FORCE_SYNC    = 0x20,
    MBOX_SYNC_READONLY  = 0x40
};

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
};

/* kludgy. swap MAIL_RECENT with MBOX_NONRECENT_KLUDGE when writing Status
   header, because 'O' flag means non-recent but internally we want to use
   recent flag. */
#define MBOX_NONRECENT_KLUDGE MAIL_RECENT

#define STATUS_FLAGS_MASK (MAIL_SEEN|MBOX_NONRECENT_KLUDGE)
#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 {
    /* uid=0 can mean that this mail describes an expunged area or that
       this is a pseudo message */
    uint32_t uid;
    uint32_t idx_seq;

    ARRAY_TYPE(keyword_indexes) keywords;
    uint8_t flags;

    bool uid_broken:1;
    bool expunged:1;
    bool pseudo:1;
    bool status_broken:1;
    bool xstatus_broken:1;

    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;

    unsigned char hdr_md5_sum[16];

    uoff_t content_length;

    size_t hdr_pos[MBOX_HDR_COUNT];
    uint32_t parsed_uid, last_uid_updated_value;
    unsigned int last_uid_value_start_pos;

    bool have_eoh:1;
    bool need_rewrite:1;
    bool seen_imapbase:1;
    bool updated:1;
    bool recent:1;
    bool dirty:1;
    bool imapbase_rewrite:1;
    bool imapbase_updated:1;
};

struct mbox_sync_context {
    struct mbox_mailbox *mbox;
        enum mbox_sync_flags flags;
    struct istream *input, *file_input;
    int write_fd;

    time_t orig_mtime, orig_atime;
    uoff_t orig_size;
    struct stat last_stat;

    struct mail_index_sync_ctx *index_sync_ctx;
    struct mail_index_view *sync_view;
    struct mail_index_transaction *t;

    struct mail_index_header reset_hdr;
    const struct mail_index_header *hdr;

    string_t *header, *from_line;

    /* header state: */
    uint32_t base_uid_validity, base_uid_last;
    uoff_t base_uid_last_offset;

    /* mail state: */
    ARRAY(struct mbox_sync_mail) mails;
    struct index_sync_changes_context *sync_changes;

    /* per-mail pool */
    pool_t mail_keyword_pool;
    /* used for mails[].keywords */
    pool_t saved_keywords_pool;

    uint32_t prev_msg_uid, next_uid, idx_next_uid;
    uint32_t seq, idx_seq, need_space_seq;
    uint32_t last_nonrecent_uid;
    off_t expunged_space, space_diff;

    bool dest_first_mail:1;
    bool first_mail_crlf_expunged:1;

    /* global flags: */
    bool keep_recent:1;
    bool readonly:1;
    bool delay_writes:1;
    bool renumber_uids:1;
    bool moved_offsets:1;
    bool ext_modified:1;
    bool index_reset:1;
    bool errors:1;
};

int mbox_sync_header_refresh(struct mbox_mailbox *mbox);
int mbox_sync(struct mbox_mailbox *mbox, enum mbox_sync_flags flags);
int mbox_sync_has_changed(struct mbox_mailbox *mbox, bool leave_dirty);
void mbox_sync_set_critical(struct mbox_sync_context *sync_ctx,
                const char *fmt, ...) ATTR_FORMAT(2, 3);

int mbox_sync_parse_next_mail(struct istream *input,
                  struct mbox_sync_mail_context *ctx);
bool mbox_sync_parse_match_mail(struct mbox_mailbox *mbox,
                struct mail_index_view *view, uint32_t seq);

void mbox_sync_update_header(struct mbox_sync_mail_context *ctx);
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 mbox_sync_rewrite(struct mbox_sync_context *sync_ctx,
                      struct mbox_sync_mail_context *mail_ctx,
              uoff_t end_offset, off_t move_diff, 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);
void mbox_sync_file_update_ext_modified(struct mbox_sync_context *sync_ctx);
void mbox_sync_file_updated(struct mbox_sync_context *sync_ctx, bool dirty);
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);
void mbox_sync_headers_add_space(struct mbox_sync_mail_context *ctx,
                 size_t size);
int mbox_sync_get_guid(struct mbox_mailbox *mbox);

int mbox_list_index_has_changed(struct mailbox *box,
                struct mail_index_view *list_view,
                uint32_t seq, bool quick);
void mbox_list_index_update_sync(struct mailbox *box,
                 struct mail_index_transaction *trans,
                 uint32_t seq);

#endif