lib-storage/index/index-storage.h

	index-storage.h revision 29e945d8550f297707f3a5f627a938401046c0cc
#ifndef __INDEX_STORAGE_H
#define __INDEX_STORAGE_H

#include "file-dotlock.h"
#include "mail-storage-private.h"
#include "mail-index.h"
#include "index-mail.h"

/* Max. mmap()ed size for a message */
#define MAIL_MMAP_BLOCK_SIZE (1024*256)
/* Block size when read()ing message. */
#define MAIL_READ_BLOCK_SIZE (1024*8)

#define MAILBOX_FULL_SYNC_INTERVAL 5

enum mailbox_lock_notify_type {
    MAILBOX_LOCK_NOTIFY_NONE,

    /* Mailbox is locked, will abort in secs_left */
    MAILBOX_LOCK_NOTIFY_MAILBOX_ABORT,
    /* Mailbox lock looks stale, will override in secs_left */
    MAILBOX_LOCK_NOTIFY_MAILBOX_OVERRIDE
};

struct index_storage {
    struct mail_storage storage;

    char *dir; /* root directory */
    char *index_dir;
    char *control_dir;
    char *inbox_path; /* INBOX location */
        char *temp_prefix; /* prefix for temporary files */

    char *user; /* name of user accessing the storage */

    struct mail_storage_callbacks *callbacks;
    void *callback_context;
};

struct index_mailbox {
    struct mailbox box;
    struct index_storage *storage;
    char *path, *control_dir;

    struct mail_index *index;
    struct mail_index_view *view;
    struct mail_cache *cache;
    struct mail *mail_interface;

    int (*is_recent)(struct index_mailbox *ibox, uint32_t uid);

    struct timeout *notify_to;
    struct index_notify_file *notify_files;
        struct index_notify_io *notify_ios;
    time_t notify_last_check, notify_last_sent;
    unsigned int min_notify_interval;
    mailbox_notify_callback_t *notify_callback;
    void *notify_context;

    time_t next_lock_notify; /* temporary */
    enum mailbox_lock_notify_type last_notify_type;

    uint32_t commit_log_file_seq;
    uoff_t commit_log_file_offset;

    struct mail_cache_field *cache_fields;
    buffer_t *recent_flags;
    uint32_t recent_flags_start_seq, recent_flags_count;
    uint32_t synced_recent_count;
    time_t sync_last_check;

    /* mbox: */
    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;
    int mbox_readonly;
    time_t mbox_dirty_stamp;
    off_t mbox_dirty_size;

    uint32_t mbox_ext_idx, md5hdr_ext_idx;

    /* maildir sync: */
    struct maildir_uidlist *uidlist;
    time_t last_new_mtime, last_cur_mtime, last_new_sync_time;
    time_t dirty_cur_time;

        mode_t mail_create_mode;
    unsigned int private_flags_mask;

    unsigned int readonly:1;
    unsigned int keep_recent:1;
    unsigned int recent_flags_synced:1;
    unsigned int sent_diskspace_warning:1;
    unsigned int sent_readonly_flags_warning:1;
    unsigned int notify_pending:1;
    unsigned int mail_read_mmaped:1;
    unsigned int syncing_commit: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;
};

struct index_transaction_context {
    struct mailbox_transaction_context mailbox_ctx;
    struct index_mailbox *ibox;

    struct mail_index_transaction *trans;
    struct mail_index_view *trans_view;
    struct mail_cache_view *cache_view;
    struct mail_cache_transaction_ctx *cache_trans;

    struct index_mail fetch_mail; /* for index_storage_fetch() */
    unsigned int cache_trans_failed:1;
};

int mail_storage_set_index_error(struct index_mailbox *ibox);

void index_storage_lock_notify(struct index_mailbox *ibox,
                   enum mailbox_lock_notify_type notify_type,
                   unsigned int secs_left);
void index_storage_lock_notify_reset(struct index_mailbox *ibox);

struct mail_index *
index_storage_alloc(const char *index_dir, const char *mailbox_path,
            const char *prefix);
void index_storage_unref(struct mail_index *index);
void index_storage_destroy_unrefed(void);

void index_storage_init(struct index_storage *storage);
void index_storage_deinit(struct index_storage *storage);

struct index_mailbox *
index_storage_mailbox_init(struct index_storage *storage, struct mailbox *box,
               struct mail_index *index, const char *name,
               enum mailbox_open_flags flags);
void index_storage_mailbox_free(struct mailbox *box);

int index_storage_is_readonly(struct mailbox *box);
int index_storage_allow_new_keywords(struct mailbox *box);
int index_storage_is_inconsistent(struct mailbox *box);

int index_mailbox_fix_keywords(struct index_mailbox *ibox,
                   enum mail_flags *flags,
                   const char *keywords[],
                   unsigned int keywords_count);

void index_mailbox_set_recent(struct index_mailbox *ibox, uint32_t seq);
int index_mailbox_is_recent(struct index_mailbox *ibox, uint32_t seq);

unsigned int index_storage_get_recent_count(struct mail_index_view *view);

void index_mailbox_check_add(struct index_mailbox *ibox,
                 const char *path, int dir);
void index_mailbox_check_remove_all(struct index_mailbox *ibox);

struct mailbox_sync_context *
index_mailbox_sync_init(struct mailbox *box, enum mailbox_sync_flags flags,
            int failed);
int index_mailbox_sync_next(struct mailbox_sync_context *ctx,
                struct mailbox_sync_rec *sync_rec_r);
int index_mailbox_sync_deinit(struct mailbox_sync_context *ctx,
                  struct mailbox_status *status_r);

int index_storage_sync(struct mailbox *box, enum mailbox_sync_flags flags);

void index_storage_set_callbacks(struct mail_storage *storage,
                 struct mail_storage_callbacks *callbacks,
                 void *context);
const char *index_storage_get_last_error(struct mail_storage *storage,
                     int *syntax_error_r);
int index_storage_get_status(struct mailbox *box,
                 enum mailbox_status_items items,
                 struct mailbox_status *status);
int index_storage_get_status_locked(struct index_mailbox *ibox,
                    enum mailbox_status_items items,
                    struct mailbox_status *status_r);

struct mail *
index_storage_fetch(struct mailbox_transaction_context *t, uint32_t seq,
            enum mail_fetch_field wanted_fields);
int index_storage_get_uids(struct mailbox *box, uint32_t uid1, uint32_t uid2,
               uint32_t *seq1_r, uint32_t *seq2_r);

struct mailbox_header_lookup_ctx *
index_header_lookup_init(struct mailbox *box, const char *const headers[]);
void index_header_lookup_deinit(struct mailbox_header_lookup_ctx *ctx);

int index_storage_search_get_sorting(struct mailbox *box,
                     enum mail_sort_type *sort_program);
struct mail_search_context *
index_storage_search_init(struct mailbox_transaction_context *t,
              const char *charset, struct mail_search_arg *args,
              const enum mail_sort_type *sort_program,
              enum mail_fetch_field wanted_fields,
              struct mailbox_header_lookup_ctx *wanted_headers);
int index_storage_search_deinit(struct mail_search_context *ctx);
struct mail *index_storage_search_next(struct mail_search_context *ctx);

void index_transaction_init(struct index_transaction_context *t,
                struct index_mailbox *ibox, int hide);
int index_transaction_commit(struct mailbox_transaction_context *t);
void index_transaction_rollback(struct mailbox_transaction_context *t);

#endif