index/mbox/mbox-storage.h

	mbox-storage.h revision e5afebd2df1d4990f7bec2a839260ff2e6d78168
#ifndef MBOX_STORAGE_H
#define MBOX_STORAGE_H

/* Padding to leave in X-Keywords header when rewriting mbox */
#define MBOX_HEADER_PADDING 50
/* Don't write Content-Length header unless it's value is larger than this. */
#define MBOX_MIN_CONTENT_LENGTH_SIZE 1024

#define MBOX_STORAGE_NAME "mbox"
#define MBOX_SUBSCRIPTION_FILE_NAME ".subscriptions"
#define MBOX_INDEX_PREFIX "dovecot.index"
#define MBOX_INDEX_DIR_NAME ".imap"

#include "index-storage.h"
#include "mailbox-list-private.h"

struct mbox_storage {
    struct mail_storage storage;

    union mailbox_list_module_context list_module_ctx;
};

struct mbox_mailbox {
    struct index_mailbox ibox;
    struct mbox_storage *storage;

    const char *path;

    int mbox_fd;
    struct istream *mbox_stream, *mbox_file_stream;
    int mbox_lock_type;
    dev_t mbox_dev;
    ino_t mbox_ino;
    unsigned int mbox_excl_locks, mbox_shared_locks;
    struct dotlock *mbox_dotlock;
    unsigned int mbox_lock_id, mbox_global_lock_id;
    struct timeout *keep_lock_to;
    bool mbox_readonly, mbox_writeonly;
    time_t mbox_dirty_stamp;
    off_t mbox_dirty_size;

    uint32_t mbox_ext_idx;

    unsigned int no_mbox_file:1;
    unsigned int invalid_mbox_file:1;
    unsigned int mbox_sync_dirty:1;
    unsigned int mbox_do_dirty_syncs:1;
    unsigned int mbox_very_dirty_syncs:1;
    unsigned int mbox_save_md5:1;
    unsigned int mbox_dotlocked:1;
    unsigned int mbox_used_privileges:1;
    unsigned int mbox_privileged_locking:1;
    unsigned int syncing:1;
};

struct mbox_transaction_context {
    struct index_transaction_context ictx;
    union mail_index_transaction_module_context module_ctx;

    struct mbox_save_context *save_ctx;
    unsigned int mbox_lock_id;
    unsigned int mails_saved:1;
};

extern struct mail_vfuncs mbox_mail_vfuncs;
extern const char *mbox_hide_headers[], *mbox_save_drop_headers[];
extern unsigned int mbox_hide_headers_count, mbox_save_drop_headers_count;

int mbox_set_syscall_error(struct mbox_mailbox *mbox, const char *function);

void mbox_transaction_class_init(void);
void mbox_transaction_class_deinit(void);

struct mailbox_sync_context *
mbox_storage_sync_init(struct mailbox *box, enum mailbox_sync_flags flags);

struct mail_save_context *
mbox_save_alloc(struct mailbox_transaction_context *_t);
int mbox_save_begin(struct mail_save_context *ctx, struct istream *input);
int mbox_save_continue(struct mail_save_context *ctx);
int mbox_save_finish(struct mail_save_context *ctx);
void mbox_save_cancel(struct mail_save_context *ctx);

int mbox_transaction_save_commit(struct mbox_save_context *ctx);
void mbox_transaction_save_rollback(struct mbox_save_context *ctx);

#endif