mailbox-list-private.h revision 77b5fd56e5a06d624f3ab92198272287333114f4
a8c5a86d183db25a57bf193c06b41e092ec2e151Timo Sirainen#ifndef MAILBOX_LIST_PRIVATE_H
7ef3553585e556f35d5919589cfdc1de3329e4bbTimo Sirainen#define MAILBOX_LIST_PRIVATE_H
7ef3553585e556f35d5919589cfdc1de3329e4bbTimo Sirainen
7ef3553585e556f35d5919589cfdc1de3329e4bbTimo Sirainen#include "mail-namespace.h"
7ef3553585e556f35d5919589cfdc1de3329e4bbTimo Sirainen#include "mailbox-list.h"
c3c07d6527ad28c8546cbbf84c257d178e23c184Timo Sirainen#include "mail-storage-settings.h"
c3c07d6527ad28c8546cbbf84c257d178e23c184Timo Sirainen
c3c07d6527ad28c8546cbbf84c257d178e23c184Timo Sirainen#define MAILBOX_LIST_NAME_MAILDIRPLUSPLUS "maildir++"
c3c07d6527ad28c8546cbbf84c257d178e23c184Timo Sirainen#define MAILBOX_LIST_NAME_IMAPDIR "imapdir"
7ef3553585e556f35d5919589cfdc1de3329e4bbTimo Sirainen#define MAILBOX_LIST_NAME_FS "fs"
7ef3553585e556f35d5919589cfdc1de3329e4bbTimo Sirainen
7ef3553585e556f35d5919589cfdc1de3329e4bbTimo Sirainen#define MAILBOX_LOG_FILE_NAME "dovecot.mailbox.log"
7ef3553585e556f35d5919589cfdc1de3329e4bbTimo Sirainen
7ef3553585e556f35d5919589cfdc1de3329e4bbTimo Sirainenenum mailbox_log_record_type;
7ef3553585e556f35d5919589cfdc1de3329e4bbTimo Sirainenstruct stat;
7ef3553585e556f35d5919589cfdc1de3329e4bbTimo Sirainenstruct dirent;
7ef3553585e556f35d5919589cfdc1de3329e4bbTimo Sirainenstruct imap_match_glob;
7ef3553585e556f35d5919589cfdc1de3329e4bbTimo Sirainenstruct mailbox_tree_context;
7ef3553585e556f35d5919589cfdc1de3329e4bbTimo Sirainen
7ef3553585e556f35d5919589cfdc1de3329e4bbTimo Sirainen#define MAILBOX_INFO_FLAGS_FINISHED(flags) \
7ef3553585e556f35d5919589cfdc1de3329e4bbTimo Sirainen (((flags) & (MAILBOX_SELECT | MAILBOX_NOSELECT | \
7ef3553585e556f35d5919589cfdc1de3329e4bbTimo Sirainen MAILBOX_NONEXISTENT)) != 0)
e28b88ee83b47dc2257140600f491482704c7b79Stephan Bosch
e28b88ee83b47dc2257140600f491482704c7b79Stephan Boschenum mailbox_dir_create_type {
e28b88ee83b47dc2257140600f491482704c7b79Stephan Bosch /* Creating a mailbox */
e28b88ee83b47dc2257140600f491482704c7b79Stephan Bosch MAILBOX_DIR_CREATE_TYPE_MAILBOX,
e28b88ee83b47dc2257140600f491482704c7b79Stephan Bosch /* Create a \Noselect or a mailbox */
e28b88ee83b47dc2257140600f491482704c7b79Stephan Bosch MAILBOX_DIR_CREATE_TYPE_TRY_NOSELECT,
e28b88ee83b47dc2257140600f491482704c7b79Stephan Bosch /* Create a \Noselect or fail */
e28b88ee83b47dc2257140600f491482704c7b79Stephan Bosch MAILBOX_DIR_CREATE_TYPE_ONLY_NOSELECT
e28b88ee83b47dc2257140600f491482704c7b79Stephan Bosch};
e28b88ee83b47dc2257140600f491482704c7b79Stephan Bosch
e28b88ee83b47dc2257140600f491482704c7b79Stephan Boschstruct mailbox_list_vfuncs {
e28b88ee83b47dc2257140600f491482704c7b79Stephan Bosch struct mailbox_list *(*alloc)(void);
e28b88ee83b47dc2257140600f491482704c7b79Stephan Bosch void (*deinit)(struct mailbox_list *list);
e28b88ee83b47dc2257140600f491482704c7b79Stephan Bosch
e28b88ee83b47dc2257140600f491482704c7b79Stephan Bosch int (*get_storage)(struct mailbox_list **list, const char *vname,
7ef3553585e556f35d5919589cfdc1de3329e4bbTimo Sirainen struct mail_storage **storage_r);
7ef3553585e556f35d5919589cfdc1de3329e4bbTimo Sirainen bool (*is_valid_pattern)(struct mailbox_list *list,
2f2244332687187931e9541e5ff312aa6c5aa705Timo Sirainen const char *pattern);
7ef3553585e556f35d5919589cfdc1de3329e4bbTimo Sirainen bool (*is_valid_existing_name)(struct mailbox_list *list,
7ef3553585e556f35d5919589cfdc1de3329e4bbTimo Sirainen const char *name);
7ef3553585e556f35d5919589cfdc1de3329e4bbTimo Sirainen bool (*is_valid_create_name)(struct mailbox_list *list,
7ef3553585e556f35d5919589cfdc1de3329e4bbTimo Sirainen const char *name);
7ef3553585e556f35d5919589cfdc1de3329e4bbTimo Sirainen
7ef3553585e556f35d5919589cfdc1de3329e4bbTimo Sirainen char (*get_hierarchy_sep)(struct mailbox_list *list);
7ef3553585e556f35d5919589cfdc1de3329e4bbTimo Sirainen const char *(*get_vname)(struct mailbox_list *list,
7ef3553585e556f35d5919589cfdc1de3329e4bbTimo Sirainen const char *storage_name);
7ef3553585e556f35d5919589cfdc1de3329e4bbTimo Sirainen const char *(*get_storage_name)(struct mailbox_list *list,
7ef3553585e556f35d5919589cfdc1de3329e4bbTimo Sirainen const char *vname);
7ef3553585e556f35d5919589cfdc1de3329e4bbTimo Sirainen const char *(*get_path)(struct mailbox_list *list, const char *name,
2f2244332687187931e9541e5ff312aa6c5aa705Timo Sirainen enum mailbox_list_path_type type);
7ef3553585e556f35d5919589cfdc1de3329e4bbTimo Sirainen
7ef3553585e556f35d5919589cfdc1de3329e4bbTimo Sirainen const char *(*get_temp_prefix)(struct mailbox_list *list, bool global);
1384fac439fea3026b16a9d8d24954200e413bccTimo Sirainen const char *(*join_refpattern)(struct mailbox_list *list,
7ef3553585e556f35d5919589cfdc1de3329e4bbTimo Sirainen const char *ref, const char *pattern);
c3c07d6527ad28c8546cbbf84c257d178e23c184Timo Sirainen
c3c07d6527ad28c8546cbbf84c257d178e23c184Timo Sirainen struct mailbox_list_iterate_context *
c3c07d6527ad28c8546cbbf84c257d178e23c184Timo Sirainen (*iter_init)(struct mailbox_list *list,
c3c07d6527ad28c8546cbbf84c257d178e23c184Timo Sirainen const char *const *patterns,
c3c07d6527ad28c8546cbbf84c257d178e23c184Timo Sirainen enum mailbox_list_iter_flags flags);
c3c07d6527ad28c8546cbbf84c257d178e23c184Timo Sirainen const struct mailbox_info *
c3c07d6527ad28c8546cbbf84c257d178e23c184Timo Sirainen (*iter_next)(struct mailbox_list_iterate_context *ctx);
c3c07d6527ad28c8546cbbf84c257d178e23c184Timo Sirainen int (*iter_deinit)(struct mailbox_list_iterate_context *ctx);
c3c07d6527ad28c8546cbbf84c257d178e23c184Timo Sirainen
c3c07d6527ad28c8546cbbf84c257d178e23c184Timo Sirainen int (*get_mailbox_flags)(struct mailbox_list *list,
c3c07d6527ad28c8546cbbf84c257d178e23c184Timo Sirainen const char *dir, const char *fname,
c3c07d6527ad28c8546cbbf84c257d178e23c184Timo Sirainen enum mailbox_list_file_type type,
c3c07d6527ad28c8546cbbf84c257d178e23c184Timo Sirainen enum mailbox_info_flags *flags_r);
c3c07d6527ad28c8546cbbf84c257d178e23c184Timo Sirainen /* Returns TRUE if name is mailbox's internal file/directory.
c3c07d6527ad28c8546cbbf84c257d178e23c184Timo Sirainen If it does, mailbox deletion assumes it can safely delete it. */
c3c07d6527ad28c8546cbbf84c257d178e23c184Timo Sirainen bool (*is_internal_name)(struct mailbox_list *list, const char *name);
c3c07d6527ad28c8546cbbf84c257d178e23c184Timo Sirainen
/* Read subscriptions from src_list, but place them into
dest_list->subscriptions. Set errors to dest_list. */
int (*subscriptions_refresh)(struct mailbox_list *src_list,
struct mailbox_list *dest_list);
int (*set_subscribed)(struct mailbox_list *list,
const char *name, bool set);
int (*create_mailbox_dir)(struct mailbox_list *list, const char *name,
enum mailbox_dir_create_type type);
int (*delete_mailbox)(struct mailbox_list *list, const char *name);
int (*delete_dir)(struct mailbox_list *list, const char *name);
int (*delete_symlink)(struct mailbox_list *list, const char *name);
int (*rename_mailbox)(struct mailbox_list *oldlist, const char *oldname,
struct mailbox_list *newlist, const char *newname,
bool rename_children);
};
struct mailbox_list_module_register {
unsigned int id;
};
union mailbox_list_module_context {
struct mailbox_list_vfuncs super;
struct mailbox_list_module_register *reg;
};
struct mailbox_list {
const char *name;
enum mailbox_list_properties props;
size_t mailbox_name_max_length;
struct mailbox_list_vfuncs v, *vlast;
/* private: */
pool_t pool;
struct mail_namespace *ns;
struct mailbox_list_settings set;
const struct mail_storage_settings *mail_set;
enum mailbox_list_flags flags;
/* -1 if not set yet. use mailbox_list_get_permissions() to set them */
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;
struct mailbox_tree_context *subscriptions;
time_t subscriptions_mtime, subscriptions_read_time;
struct mailbox_log *changelog;
time_t changelog_timestamp;
pool_t guid_cache_pool;
struct hash_table *guid_cache;
bool guid_cache_errors;
char *error_string;
enum mail_error error;
bool temporary_error;
ARRAY_DEFINE(module_contexts, union mailbox_list_module_context *);
unsigned int index_root_dir_created:1;
};
union mailbox_list_iterate_module_context {
struct mailbox_list_module_register *reg;
};
struct mailbox_list_iterate_context {
struct mailbox_list *list;
pool_t pool;
enum mailbox_list_iter_flags flags;
bool failed;
struct imap_match_glob *glob;
struct mailbox_list_autocreate_iterate_context *autocreate_ctx;
struct mailbox_info specialuse_info;
ARRAY_DEFINE(module_contexts,
union mailbox_list_iterate_module_context *);
};
struct mailbox_list_iter_update_context {
struct mailbox_list_iterate_context *iter_ctx;
struct mailbox_tree_context *tree_ctx;
struct imap_match_glob *glob;
enum mailbox_info_flags leaf_flags, parent_flags;
unsigned int update_only:1;
unsigned int match_parents:1;
};
/* Modules should use do "my_id = mailbox_list_module_id++" and
use objects' module_contexts[id] for their own purposes. */
extern struct mailbox_list_module_register mailbox_list_module_register;
void mailbox_lists_init(void);
void mailbox_lists_deinit(void);
int mailbox_list_settings_parse(struct mail_user *user, const char *data,
struct mailbox_list_settings *set_r,
const char **error_r);
const char *mailbox_list_default_get_storage_name(struct mailbox_list *list,
const char *vname);
const char *mailbox_list_default_get_vname(struct mailbox_list *list,
const char *storage_name);
const char *mailbox_list_get_unexpanded_path(struct mailbox_list *list,
enum mailbox_list_path_type type);
const char *
mailbox_list_get_root_path(const struct mailbox_list_settings *set,
enum mailbox_list_path_type type);
int mailbox_list_delete_index_control(struct mailbox_list *list,
const char *name);
void mailbox_list_iter_update(struct mailbox_list_iter_update_context *ctx,
const char *name);
bool mailbox_list_name_is_too_large(const char *name, char sep);
enum mailbox_list_file_type mailbox_list_get_file_type(const struct dirent *d);
int mailbox_list_dirent_is_alias_symlink(struct mailbox_list *list,
const char *dir_path,
const struct dirent *d);
bool mailbox_list_try_get_absolute_path(struct mailbox_list *list,
const char **name);
int mailbox_list_create_missing_index_dir(struct mailbox_list *list,
const char *name);
void mailbox_list_add_change(struct mailbox_list *list,
enum mailbox_log_record_type type,
const guid_128_t guid_128);
int mailbox_list_get_guid_path(struct mailbox_list *list, const char *path,
guid_128_t guid_128_r);
void mailbox_name_get_sha128(const char *name, guid_128_t guid_128_r);
void mailbox_list_clear_error(struct mailbox_list *list);
void mailbox_list_set_error(struct mailbox_list *list,
enum mail_error error, const char *string);
void mailbox_list_set_critical(struct mailbox_list *list, const char *fmt, ...)
ATTR_FORMAT(2, 3);
void mailbox_list_set_internal_error(struct mailbox_list *list);
bool mailbox_list_set_error_from_errno(struct mailbox_list *list);
#endif