mail-storage-private.h revision 420040a5930a2b497e79ff0b5f59ba4b764a5b39
2ronwalf#ifndef MAIL_STORAGE_PRIVATE_H
2ronwalf#define MAIL_STORAGE_PRIVATE_H
2ronwalf
2ronwalf#include "module-context.h"
2ronwalf#include "file-lock.h"
2ronwalf#include "mail-storage.h"
2ronwalf#include "mail-storage-hooks.h"
2ronwalf#include "mail-storage-settings.h"
38daenzerorama#include "mail-index-private.h"
2ronwalf
2ronwalf/* Block size when read()ing message header. */
2ronwalf#define MAIL_READ_HDR_BLOCK_SIZE (1024*4)
2ronwalf/* Block size when read()ing message (header and) body. */
2ronwalf#define MAIL_READ_FULL_BLOCK_SIZE (1024*8)
2ronwalf
38daenzeroramastruct mail_storage_module_register {
2ronwalf unsigned int id;
2ronwalf};
2ronwalf
2ronwalfstruct mail_module_register {
2ronwalf unsigned int id;
2ronwalf};
2ronwalf
2ronwalfstruct mail_storage_vfuncs {
2ronwalf const struct setting_parser_info *(*get_setting_parser_info)(void);
2ronwalf
2ronwalf struct mail_storage *(*alloc)(void);
2ronwalf int (*create)(struct mail_storage *storage, struct mail_namespace *ns,
2ronwalf const char **error_r);
2ronwalf void (*destroy)(struct mail_storage *storage);
2ronwalf void (*add_list)(struct mail_storage *storage,
2ronwalf struct mailbox_list *list);
2ronwalf
2ronwalf void (*get_list_settings)(const struct mail_namespace *ns,
2ronwalf struct mailbox_list_settings *set);
2ronwalf bool (*autodetect)(const struct mail_namespace *ns,
2ronwalf struct mailbox_list_settings *set);
2ronwalf
2ronwalf struct mailbox *(*mailbox_alloc)(struct mail_storage *storage,
2ronwalf struct mailbox_list *list,
2ronwalf const char *name,
2ronwalf enum mailbox_flags flags);
2ronwalf int (*purge)(struct mail_storage *storage);
2ronwalf};
2ronwalf
2ronwalfunion mail_storage_module_context {
2ronwalf struct mail_storage_vfuncs super;
2ronwalf struct mail_storage_module_register *reg;
2ronwalf};
2ronwalf
2ronwalfenum mail_storage_class_flags {
2ronwalf /* mailboxes are files, not directories */
2ronwalf MAIL_STORAGE_CLASS_FLAG_MAILBOX_IS_FILE = 0x01,
2ronwalf /* root_dir points to a unique directory */
2ronwalf MAIL_STORAGE_CLASS_FLAG_UNIQUE_ROOT = 0x02,
2ronwalf /* mailbox_open_stream() is supported */
2ronwalf MAIL_STORAGE_CLASS_FLAG_OPEN_STREAMS = 0x04
2ronwalf};
2ronwalf
2ronwalfstruct mail_storage {
2ronwalf const char *name;
2ronwalf enum mail_storage_class_flags class_flags;
2ronwalf
2ronwalf struct mail_storage_vfuncs v;
2ronwalf
2ronwalf/* private: */
2ronwalf pool_t pool;
2ronwalf struct mail_storage *prev, *next;
2ronwalf /* counting number of times mail_storage_create() has returned this
2ronwalf same storage. */
2ronwalf int refcount;
2ronwalf /* counting number of objects (e.g. mailbox) that have a pointer
2ronwalf to this storage. */
2ronwalf int obj_refcount;
2ronwalf const char *unique_root_dir;
2ronwalf
2ronwalf char *error_string;
2ronwalf enum mail_error error;
2ronwalf
2ronwalf const struct mail_storage *storage_class;
2ronwalf struct mail_user *user;
2ronwalf const char *temp_path_prefix;
2ronwalf const struct mail_storage_settings *set;
2ronwalf
2ronwalf enum mail_storage_flags flags;
2ronwalf
2ronwalf struct mail_storage_callbacks callbacks;
2ronwalf void *callback_context;
2ronwalf
2ronwalf /* Module-specific contexts. See mail_storage_module_id. */
2ronwalf ARRAY_DEFINE(module_contexts, union mail_storage_module_context *);
2ronwalf};
2ronwalf
2ronwalfstruct mailbox_vfuncs {
2ronwalf bool (*is_readonly)(struct mailbox *box);
2ronwalf bool (*allow_new_keywords)(struct mailbox *box);
2ronwalf
2ronwalf int (*enable)(struct mailbox *box, enum mailbox_feature features);
2ronwalf int (*open)(struct mailbox *box);
2ronwalf void (*close)(struct mailbox *box);
2ronwalf void (*free)(struct mailbox *box);
2ronwalf
2ronwalf int (*create)(struct mailbox *box, const struct mailbox_update *update,
2ronwalf bool directory);
2ronwalf int (*update)(struct mailbox *box, const struct mailbox_update *update);
2ronwalf int (*delete)(struct mailbox *box);
2ronwalf int (*rename)(struct mailbox *src, struct mailbox *dest,
2ronwalf bool rename_children);
2ronwalf
2ronwalf void (*get_status)(struct mailbox *box, enum mailbox_status_items items,
2ronwalf struct mailbox_status *status_r);
2ronwalf int (*get_guid)(struct mailbox *box, uint8_t guid[MAIL_GUID_128_SIZE]);
2ronwalf
2ronwalf /* Lookup sync extension record and figure out if it mailbox has
2ronwalf changed since. Returns 1 = yes, 0 = no, -1 = error. */
2ronwalf int (*list_index_has_changed)(struct mailbox *box,
2ronwalf struct mail_index_view *list_view,
2ronwalf uint32_t seq);
2ronwalf /* Update the sync extension record. Returns 0 = ok, -1 = error. */
2ronwalf int (*list_index_update_sync)(struct mailbox *box,
2ronwalf struct mail_index_transaction *trans,
2ronwalf uint32_t seq);
2ronwalf
2ronwalf struct mailbox_sync_context *
2ronwalf (*sync_init)(struct mailbox *box,
2ronwalf enum mailbox_sync_flags flags);
2ronwalf bool (*sync_next)(struct mailbox_sync_context *ctx,
2ronwalf struct mailbox_sync_rec *sync_rec_r);
2ronwalf int (*sync_deinit)(struct mailbox_sync_context *ctx,
2ronwalf struct mailbox_sync_status *status_r);
2ronwalf
2ronwalf /* Called once for each expunge. Called one or more times for
2ronwalf flag/keyword changes. Once the sync is finished, called with
2ronwalf uid=0 and sync_type=0. */
2ronwalf void (*sync_notify)(struct mailbox *box, uint32_t uid,
2ronwalf enum mailbox_sync_type sync_type);
2ronwalf
2ronwalf void (*notify_changes)(struct mailbox *box);
2ronwalf
2ronwalf struct mailbox_transaction_context *
2ronwalf (*transaction_begin)(struct mailbox *box,
2ronwalf enum mailbox_transaction_flags flags);
2ronwalf int (*transaction_commit)(struct mailbox_transaction_context *t,
2ronwalf struct mail_transaction_commit_changes *changes_r);
2ronwalf void (*transaction_rollback)(struct mailbox_transaction_context *t);
2ronwalf void (*transaction_set_max_modseq)(struct mailbox_transaction_context *t,
2ronwalf uint64_t max_modseq,
2ronwalf ARRAY_TYPE(seq_range) *seqs);
2ronwalf
2ronwalf int (*keywords_create)(struct mailbox *box,
2ronwalf const char *const keywords[],
2ronwalf struct mail_keywords **keywords_r,
2ronwalf bool skip_invalid);
2ronwalf struct mail_keywords *
2ronwalf (*keywords_create_from_indexes)(struct mailbox *box,
2ronwalf const ARRAY_TYPE(keyword_indexes) *idx);
2ronwalf void (*keywords_ref)(struct mail_keywords *keywords);
2ronwalf void (*keywords_unref)(struct mail_keywords *keywords);
2ronwalf bool (*keyword_is_valid)(struct mailbox *box, const char *keyword,
2ronwalf const char **error_r);
2ronwalf
2ronwalf void (*get_seq_range)(struct mailbox *box, uint32_t uid1, uint32_t uid2,
2ronwalf uint32_t *seq1_r, uint32_t *seq2_r);
38daenzerorama void (*get_uid_range)(struct mailbox *box,
38daenzerorama const ARRAY_TYPE(seq_range) *seqs,
38daenzerorama ARRAY_TYPE(seq_range) *uids);
38daenzerorama bool (*get_expunges)(struct mailbox *box, uint64_t prev_modseq,
38daenzerorama const ARRAY_TYPE(seq_range) *uids_filter,
38daenzerorama ARRAY_TYPE(mailbox_expunge_rec) *expunges);
38daenzerorama bool (*get_virtual_uid)(struct mailbox *box,
38daenzerorama const char *backend_mailbox,
38daenzerorama uint32_t backend_uidvalidity,
2ronwalf uint32_t backend_uid, uint32_t *uid_r);
void (*get_virtual_backend_boxes)(struct mailbox *box,
ARRAY_TYPE(mailboxes) *mailboxes,
bool only_with_msgs);
void (*get_virtual_box_patterns)(struct mailbox *box,
ARRAY_TYPE(mailbox_virtual_patterns) *includes,
ARRAY_TYPE(mailbox_virtual_patterns) *excludes);
struct mail *
(*mail_alloc)(struct mailbox_transaction_context *t,
enum mail_fetch_field wanted_fields,
struct mailbox_header_lookup_ctx *wanted_headers);
struct mailbox_header_lookup_ctx *
(*header_lookup_init)(struct mailbox *box,
const char *const headers[]);
void (*header_lookup_deinit)(struct mailbox_header_lookup_ctx *ctx);
struct mail_search_context *
(*search_init)(struct mailbox_transaction_context *t,
struct mail_search_args *args,
const enum mail_sort_type *sort_program);
int (*search_deinit)(struct mail_search_context *ctx);
bool (*search_next_nonblock)(struct mail_search_context *ctx,
struct mail *mail, bool *tryagain_r);
/* Internal search function which updates ctx->seq */
bool (*search_next_update_seq)(struct mail_search_context *ctx);
struct mail_save_context *
(*save_alloc)(struct mailbox_transaction_context *t);
int (*save_begin)(struct mail_save_context *ctx, struct istream *input);
int (*save_continue)(struct mail_save_context *ctx);
int (*save_finish)(struct mail_save_context *ctx);
void (*save_cancel)(struct mail_save_context *ctx);
int (*copy)(struct mail_save_context *ctx, struct mail *mail);
bool (*is_inconsistent)(struct mailbox *box);
};
union mailbox_module_context {
struct mailbox_vfuncs super;
struct mail_storage_module_register *reg;
};
struct mailbox {
const char *name;
struct mail_storage *storage;
struct mailbox_list *list;
struct mailbox_vfuncs v;
/* private: */
pool_t pool;
struct mail_index *index;
struct mail_index_view *view;
struct mail_cache *cache;
/* default vfuncs for new struct mails. */
const struct mail_vfuncs *mail_vfuncs;
/* mailbox's MAILBOX_LIST_PATH_TYPE_MAILBOX */
const char *path;
/* mailbox's virtual name (from mail_namespace_get_vname()) */
const char *vname;
struct istream *input;
enum mailbox_flags flags;
unsigned int transaction_count;
enum mailbox_feature enabled_features;
/* User's private flags if this is a shared mailbox */
enum mail_flags private_flags_mask;
/* mode and GID to use for newly created files/dirs */
mode_t file_create_mode, dir_create_mode;
gid_t file_create_gid;
/* origin (e.g. path) where the file_create_gid was got from */
const char *file_create_gid_origin;
/* Mailbox notification settings: */
unsigned int notify_min_interval;
mailbox_notify_callback_t *notify_callback;
void *notify_context;
/* Saved search results */
ARRAY_DEFINE(search_results, struct mail_search_result *);
/* Module-specific contexts. See mail_storage_module_id. */
ARRAY_DEFINE(module_contexts, union mailbox_module_context *);
/* When FAST open flag is used, the mailbox isn't actually opened until
it's synced for the first time. */
unsigned int opened:1;
/* Mailbox was deleted while we had it open. */
unsigned int mailbox_deleted:1;
/* we've discovered there aren't enough permissions to modify mailbox */
unsigned int backend_readonly:1;
/* Mailbox is being deleted */
unsigned int deleting:1;
/* TRUE if this is the INBOX */
unsigned int inbox:1;
};
struct mail_vfuncs {
void (*close)(struct mail *mail);
void (*free)(struct mail *mail);
void (*set_seq)(struct mail *mail, uint32_t seq);
bool (*set_uid)(struct mail *mail, uint32_t uid);
void (*set_uid_cache_updates)(struct mail *mail, bool set);
enum mail_flags (*get_flags)(struct mail *mail);
const char *const *(*get_keywords)(struct mail *mail);
const ARRAY_TYPE(keyword_indexes) *
(*get_keyword_indexes)(struct mail *mail);
uint64_t (*get_modseq)(struct mail *mail);
int (*get_parts)(struct mail *mail,
struct message_part **parts_r);
int (*get_date)(struct mail *mail, time_t *date_r, int *timezone_r);
int (*get_received_date)(struct mail *mail, time_t *date_r);
int (*get_save_date)(struct mail *mail, time_t *date_r);
int (*get_virtual_size)(struct mail *mail, uoff_t *size_r);
int (*get_physical_size)(struct mail *mail, uoff_t *size_r);
int (*get_first_header)(struct mail *mail, const char *field,
bool decode_to_utf8, const char **value_r);
int (*get_headers)(struct mail *mail, const char *field,
bool decode_to_utf8, const char *const **value_r);
int (*get_header_stream)(struct mail *mail,
struct mailbox_header_lookup_ctx *headers,
struct istream **stream_r);
int (*get_stream)(struct mail *mail, struct message_size *hdr_size,
struct message_size *body_size,
struct istream **stream_r);
int (*get_special)(struct mail *mail, enum mail_fetch_field field,
const char **value_r);
void (*update_flags)(struct mail *mail, enum modify_type modify_type,
enum mail_flags flags);
void (*update_keywords)(struct mail *mail, enum modify_type modify_type,
struct mail_keywords *keywords);
void (*update_modseq)(struct mail *mail, uint64_t min_modseq);
void (*update_uid)(struct mail *mail, uint32_t new_uid);
void (*update_pop3_uidl)(struct mail *mail, const char *uidl);
void (*expunge)(struct mail *mail);
void (*set_cache_corrupted)(struct mail *mail,
enum mail_fetch_field field);
struct index_mail *(*get_index_mail)(struct mail *mail);
};
union mail_module_context {
struct mail_vfuncs super;
struct mail_module_register *reg;
};
struct mail_private {
struct mail mail;
struct mail_vfuncs v;
enum mail_fetch_field wanted_fields;
struct mailbox_header_lookup_ctx *wanted_headers;
pool_t pool;
ARRAY_DEFINE(module_contexts, union mail_module_context *);
/* these statistics are never reset by mail-storage API: */
unsigned long stats_open_lookup_count;
unsigned long stats_stat_lookup_count;
unsigned long stats_fstat_lookup_count;
/* number of files we've opened and read */
unsigned long stats_files_read_count;
/* number of bytes we've had to read from files */
unsigned long long stats_files_read_bytes;
/* number of cache lookup hits */
unsigned long stats_cache_hit_count;
/* Set to TRUE to update stats_* fields */
unsigned int stats_track:1;
};
struct mailbox_list_context {
struct mail_storage *storage;
enum mailbox_list_flags flags;
bool failed;
};
union mailbox_transaction_module_context {
struct mail_storage_module_register *reg;
};
struct mailbox_transaction_context {
struct mailbox *box;
enum mailbox_transaction_flags flags;
struct mail_index_transaction *itrans;
/* view contains all changes done within this transaction */
struct mail_index_view *view;
struct mail_transaction_commit_changes *changes;
ARRAY_DEFINE(module_contexts,
union mailbox_transaction_module_context *);
struct mail_save_context *save_ctx;
};
union mail_search_module_context {
struct mail_storage_module_register *reg;
};
struct mail_search_context {
struct mailbox_transaction_context *transaction;
struct mail_search_args *args;
struct mail_search_sort_program *sort_program;
/* if non-NULL, specifies that a search resulting is being updated.
this can be used as a search optimization: if searched message
already exists in search result, it's not necessary to check if
static data matches. */
struct mail_search_result *update_result;
/* add matches to these search results */
ARRAY_DEFINE(results, struct mail_search_result *);
uint32_t seq;
uint32_t progress_cur, progress_max;
ARRAY_DEFINE(module_contexts, union mail_search_module_context *);
unsigned int seen_lost_data:1;
unsigned int progress_hidden:1;
};
struct mail_save_context {
struct mailbox_transaction_context *transaction;
struct mail *dest_mail;
enum mail_flags flags;
struct mail_keywords *keywords;
uint64_t min_modseq;
time_t received_date, save_date;
int received_tz_offset;
uint32_t uid;
char *guid, *pop3_uidl, *from_envelope;
struct ostream *output;
/* if non-zero, overrides the physical size that should be saved.
for example when using zlib plugin, this would contain the mail's
uncompressed size. */
uoff_t saved_physical_size;
/* we came here from mailbox_copy() */
unsigned int copying:1;
};
struct mailbox_sync_context {
struct mailbox *box;
};
struct mailbox_header_lookup_ctx {
struct mailbox *box;
const char *const *headers;
int refcount;
};
/* Modules should use do "my_id = mail_storage_module_id++" and
use objects' module_contexts[id] for their own purposes. */
extern struct mail_storage_module_register mail_storage_module_register;
/* Storage's module_id for mail_index. */
extern struct mail_module_register mail_module_register;
#define MAIL_STORAGE_CONTEXT(obj) \
MODULE_CONTEXT(obj, mail_storage_mail_index_module)
extern MODULE_CONTEXT_DEFINE(mail_storage_mail_index_module,
&mail_index_module_register);
void mail_storage_obj_ref(struct mail_storage *storage);
void mail_storage_obj_unref(struct mail_storage *storage);
/* Set error message in storage. Critical errors are logged with i_error(),
but user sees only "internal error" message. */
void mail_storage_clear_error(struct mail_storage *storage);
void mail_storage_set_error(struct mail_storage *storage,
enum mail_error error, const char *string);
void mail_storage_set_critical(struct mail_storage *storage,
const char *fmt, ...) ATTR_FORMAT(2, 3);
void mail_storage_set_internal_error(struct mail_storage *storage);
void mail_storage_set_index_error(struct mailbox *box);
bool mail_storage_set_error_from_errno(struct mail_storage *storage);
void mail_storage_copy_list_error(struct mail_storage *storage,
struct mailbox_list *list);
int mail_set_aborted(struct mail *mail);
void mail_set_expunged(struct mail *mail);
void mailbox_set_deleted(struct mailbox *box);
void mailbox_refresh_permissions(struct mailbox *box);
/* Returns -1 if error, 0 if failed with EEXIST, 1 if ok */
int mailbox_create_fd(struct mailbox *box, const char *path, int flags,
int *fd_r);
#endif