mailbox-list-private.h revision 2f30b72d49fbff0c4096125c139e4bdfef45669c
5a580c3a38ced62d4bcc95b8ac7c4f2935b5d294Timo Sirainen#ifndef MAILBOX_LIST_PRIVATE_H
25757faf029c369a8318349dafe952e2358df1d8Timo Sirainen#define MAILBOX_LIST_PRIVATE_H
08d6658a4e2ec8104cd1307f6baa75fdb07a24f8Mark Washenberger
43a66a0b16299bd4f7615acd85e98bd3832c54d5Timo Sirainen#include "mail-namespace.h"
ff487c974815bdaa2d05a3b834f4c2c841f4cc34Timo Sirainen#include "mailbox-list.h"
66d2db642fe24d555d113ba463e446b038d476efTimo Sirainen#include "mail-storage-settings.h"
04052d7cacaa866a3f00afb4e104fa46c04c1dd7Timo Sirainen
25757faf029c369a8318349dafe952e2358df1d8Timo Sirainen#define MAILBOX_LIST_NAME_MAILDIRPLUSPLUS "maildir++"
25757faf029c369a8318349dafe952e2358df1d8Timo Sirainen#define MAILBOX_LIST_NAME_IMAPDIR "imapdir"
25757faf029c369a8318349dafe952e2358df1d8Timo Sirainen#define MAILBOX_LIST_NAME_FS "fs"
25757faf029c369a8318349dafe952e2358df1d8Timo Sirainen
4ee00532a265bdfb38539d811fcd12d51210ac35Timo Sirainen#define MAILBOX_LOG_FILE_NAME "dovecot.mailbox.log"
4ee00532a265bdfb38539d811fcd12d51210ac35Timo Sirainen
b321df9603081896b70ec44635af96d674a9839aTimo Sirainenenum mailbox_log_record_type;
9d75363d3fbabc2fbc2d80f06672e3ed8965804aTimo Sirainenstruct dirent;
9d75363d3fbabc2fbc2d80f06672e3ed8965804aTimo Sirainenstruct imap_match_glob;
9d75363d3fbabc2fbc2d80f06672e3ed8965804aTimo Sirainenstruct mailbox_tree_context;
9d75363d3fbabc2fbc2d80f06672e3ed8965804aTimo Sirainen
43a66a0b16299bd4f7615acd85e98bd3832c54d5Timo Sirainenstruct mailbox_list_vfuncs {
43a66a0b16299bd4f7615acd85e98bd3832c54d5Timo Sirainen struct mailbox_list *(*alloc)(void);
43a66a0b16299bd4f7615acd85e98bd3832c54d5Timo Sirainen void (*deinit)(struct mailbox_list *list);
43a66a0b16299bd4f7615acd85e98bd3832c54d5Timo Sirainen
7bd72e4deca3cbf757dd1ea298486d9f3bc24226Timo Sirainen int (*get_storage)(struct mailbox_list **list, const char **name,
7bd72e4deca3cbf757dd1ea298486d9f3bc24226Timo Sirainen struct mail_storage **storage_r);
7bd72e4deca3cbf757dd1ea298486d9f3bc24226Timo Sirainen bool (*is_valid_pattern)(struct mailbox_list *list,
7bd72e4deca3cbf757dd1ea298486d9f3bc24226Timo Sirainen const char *pattern);
7bd72e4deca3cbf757dd1ea298486d9f3bc24226Timo Sirainen bool (*is_valid_existing_name)(struct mailbox_list *list,
43a66a0b16299bd4f7615acd85e98bd3832c54d5Timo Sirainen const char *name);
43a66a0b16299bd4f7615acd85e98bd3832c54d5Timo Sirainen bool (*is_valid_create_name)(struct mailbox_list *list,
43a66a0b16299bd4f7615acd85e98bd3832c54d5Timo Sirainen const char *name);
43a66a0b16299bd4f7615acd85e98bd3832c54d5Timo Sirainen
43a66a0b16299bd4f7615acd85e98bd3832c54d5Timo Sirainen const char *(*get_path)(struct mailbox_list *list, const char *name,
43a66a0b16299bd4f7615acd85e98bd3832c54d5Timo Sirainen enum mailbox_list_path_type type);
5c99eaa4e3e07ee065580d163240b4ce95b66befTimo Sirainen int (*get_mailbox_name_status)(struct mailbox_list *list,
5c99eaa4e3e07ee065580d163240b4ce95b66befTimo Sirainen const char *name,
5c99eaa4e3e07ee065580d163240b4ce95b66befTimo Sirainen enum mailbox_name_status *status);
5c99eaa4e3e07ee065580d163240b4ce95b66befTimo Sirainen
5c99eaa4e3e07ee065580d163240b4ce95b66befTimo Sirainen const char *(*get_temp_prefix)(struct mailbox_list *list, bool global);
5c99eaa4e3e07ee065580d163240b4ce95b66befTimo Sirainen const char *(*join_refpattern)(struct mailbox_list *list,
5c99eaa4e3e07ee065580d163240b4ce95b66befTimo Sirainen const char *ref, const char *pattern);
43a66a0b16299bd4f7615acd85e98bd3832c54d5Timo Sirainen
43a66a0b16299bd4f7615acd85e98bd3832c54d5Timo Sirainen struct mailbox_list_iterate_context *
43a66a0b16299bd4f7615acd85e98bd3832c54d5Timo Sirainen (*iter_init)(struct mailbox_list *list,
43a66a0b16299bd4f7615acd85e98bd3832c54d5Timo Sirainen const char *const *patterns,
43a66a0b16299bd4f7615acd85e98bd3832c54d5Timo Sirainen enum mailbox_list_iter_flags flags);
43a66a0b16299bd4f7615acd85e98bd3832c54d5Timo Sirainen const struct mailbox_info *
43a66a0b16299bd4f7615acd85e98bd3832c54d5Timo Sirainen (*iter_next)(struct mailbox_list_iterate_context *ctx);
43a66a0b16299bd4f7615acd85e98bd3832c54d5Timo Sirainen int (*iter_deinit)(struct mailbox_list_iterate_context *ctx);
43a66a0b16299bd4f7615acd85e98bd3832c54d5Timo Sirainen
7bd72e4deca3cbf757dd1ea298486d9f3bc24226Timo Sirainen /* Returns -1 if error, 0 if it's not a valid mailbox, 1 if it is.
43a66a0b16299bd4f7615acd85e98bd3832c54d5Timo Sirainen flags may be updated (especially the children flags). */
7bd72e4deca3cbf757dd1ea298486d9f3bc24226Timo Sirainen int (*iter_is_mailbox)(struct mailbox_list_iterate_context *ctx,
7bd72e4deca3cbf757dd1ea298486d9f3bc24226Timo Sirainen const char *dir, const char *fname,
7bd72e4deca3cbf757dd1ea298486d9f3bc24226Timo Sirainen const char *mailbox_name,
7bd72e4deca3cbf757dd1ea298486d9f3bc24226Timo Sirainen enum mailbox_list_file_type type,
43a66a0b16299bd4f7615acd85e98bd3832c54d5Timo Sirainen enum mailbox_info_flags *flags_r);
43a66a0b16299bd4f7615acd85e98bd3832c54d5Timo Sirainen
43a66a0b16299bd4f7615acd85e98bd3832c54d5Timo Sirainen int (*set_subscribed)(struct mailbox_list *list,
43a66a0b16299bd4f7615acd85e98bd3832c54d5Timo Sirainen const char *name, bool set);
43a66a0b16299bd4f7615acd85e98bd3832c54d5Timo Sirainen int (*delete_mailbox)(struct mailbox_list *list, const char *name);
1f1e81aab38d833d1c9cdc244c91fd762e0080d4Timo Sirainen int (*delete_dir)(struct mailbox_list *list, const char *name);
b44650b0f48a4b5f0dc240ed836833a00b643b9fTimo Sirainen int (*rename_mailbox)(struct mailbox_list *oldlist, const char *oldname,
b44650b0f48a4b5f0dc240ed836833a00b643b9fTimo Sirainen struct mailbox_list *newlist, const char *newname,
b44650b0f48a4b5f0dc240ed836833a00b643b9fTimo Sirainen bool rename_children);
473080c7c0d25ddfdf77e7dfa0ba8f73c6c669d5Timo Sirainen /* called by rename_mailbox() just before running the actual rename() */
a8e132559a7ebe54c8269d79ce29fa3338c76199Timo Sirainen int (*rename_mailbox_pre)(struct mailbox_list *oldlist,
ce6c2809b8a1673372a683716566d973efd2f6eeTimo Sirainen const char *oldname,
b44650b0f48a4b5f0dc240ed836833a00b643b9fTimo Sirainen struct mailbox_list *newlist,
473080c7c0d25ddfdf77e7dfa0ba8f73c6c669d5Timo Sirainen const char *newname);
430c0b0c370bebeeceba2e206be76bc134742f41Timo Sirainen};
430c0b0c370bebeeceba2e206be76bc134742f41Timo Sirainen
430c0b0c370bebeeceba2e206be76bc134742f41Timo Sirainenstruct mailbox_list_module_register {
430c0b0c370bebeeceba2e206be76bc134742f41Timo Sirainen unsigned int id;
430c0b0c370bebeeceba2e206be76bc134742f41Timo Sirainen};
430c0b0c370bebeeceba2e206be76bc134742f41Timo Sirainen
430c0b0c370bebeeceba2e206be76bc134742f41Timo Sirainenunion mailbox_list_module_context {
ce6c2809b8a1673372a683716566d973efd2f6eeTimo Sirainen struct mailbox_list_vfuncs super;
ce6c2809b8a1673372a683716566d973efd2f6eeTimo Sirainen struct mailbox_list_module_register *reg;
b44650b0f48a4b5f0dc240ed836833a00b643b9fTimo Sirainen};
b44650b0f48a4b5f0dc240ed836833a00b643b9fTimo Sirainen
b44650b0f48a4b5f0dc240ed836833a00b643b9fTimo Sirainenstruct mailbox_list {
ce6c2809b8a1673372a683716566d973efd2f6eeTimo Sirainen const char *name;
ce6c2809b8a1673372a683716566d973efd2f6eeTimo Sirainen char hierarchy_sep;
b44650b0f48a4b5f0dc240ed836833a00b643b9fTimo Sirainen enum mailbox_list_properties props;
b44650b0f48a4b5f0dc240ed836833a00b643b9fTimo Sirainen size_t mailbox_name_max_length;
b44650b0f48a4b5f0dc240ed836833a00b643b9fTimo Sirainen
b44650b0f48a4b5f0dc240ed836833a00b643b9fTimo Sirainen struct mailbox_list_vfuncs v;
b44650b0f48a4b5f0dc240ed836833a00b643b9fTimo Sirainen
b44650b0f48a4b5f0dc240ed836833a00b643b9fTimo Sirainen/* private: */
b44650b0f48a4b5f0dc240ed836833a00b643b9fTimo Sirainen pool_t pool;
b4f2560c29dacd066ba89e782d95ceed7ac473a3Timo Sirainen struct mail_namespace *ns;
b4f2560c29dacd066ba89e782d95ceed7ac473a3Timo Sirainen struct mailbox_list_settings set;
b4f2560c29dacd066ba89e782d95ceed7ac473a3Timo Sirainen const struct mail_storage_settings *mail_set;
b4f2560c29dacd066ba89e782d95ceed7ac473a3Timo Sirainen enum mailbox_list_flags flags;
1479a685cdb1641783ac02ba135450929f5c2658Timo Sirainen
b4f2560c29dacd066ba89e782d95ceed7ac473a3Timo Sirainen /* -1 if not set yet. use mailbox_list_get_permissions() to set them */
b4f2560c29dacd066ba89e782d95ceed7ac473a3Timo Sirainen mode_t file_create_mode, dir_create_mode;
b4f2560c29dacd066ba89e782d95ceed7ac473a3Timo Sirainen gid_t file_create_gid;
b44650b0f48a4b5f0dc240ed836833a00b643b9fTimo Sirainen /* origin (e.g. path) where the file_create_gid was got from */
b44650b0f48a4b5f0dc240ed836833a00b643b9fTimo Sirainen const char *file_create_gid_origin;
ac713658d206e8d001fef7c0e36945793f2eb942Timo Sirainen
49e513d090753ccbf95560b2f3a21f081a5b6c51Timo Sirainen struct mailbox_log *changelog;
b44650b0f48a4b5f0dc240ed836833a00b643b9fTimo Sirainen time_t changelog_timestamp;
9ed2951bd0bb1878a27437d7c00611b2baadd614Timo Sirainen
ac713658d206e8d001fef7c0e36945793f2eb942Timo Sirainen char *error_string;
ac713658d206e8d001fef7c0e36945793f2eb942Timo Sirainen enum mail_error error;
ac713658d206e8d001fef7c0e36945793f2eb942Timo Sirainen bool temporary_error;
ac713658d206e8d001fef7c0e36945793f2eb942Timo Sirainen
ac713658d206e8d001fef7c0e36945793f2eb942Timo Sirainen ARRAY_DEFINE(module_contexts, union mailbox_list_module_context *);
b44650b0f48a4b5f0dc240ed836833a00b643b9fTimo Sirainen};
473080c7c0d25ddfdf77e7dfa0ba8f73c6c669d5Timo Sirainen
517d1e7142d57299c733b30423e35e7e1f8d01d6Timo Sirainenstruct mailbox_list_iterate_context {
517d1e7142d57299c733b30423e35e7e1f8d01d6Timo Sirainen struct mailbox_list *list;
b44650b0f48a4b5f0dc240ed836833a00b643b9fTimo Sirainen enum mailbox_list_iter_flags flags;
446e518e4fe86ff40e33543445f4e99edf840a21Timo Sirainen bool failed;
446e518e4fe86ff40e33543445f4e99edf840a21Timo Sirainen};
446e518e4fe86ff40e33543445f4e99edf840a21Timo Sirainen
446e518e4fe86ff40e33543445f4e99edf840a21Timo Sirainenstruct mailbox_list_iter_update_context {
446e518e4fe86ff40e33543445f4e99edf840a21Timo Sirainen struct mailbox_list_iterate_context *iter_ctx;
446e518e4fe86ff40e33543445f4e99edf840a21Timo Sirainen struct mailbox_tree_context *tree_ctx;
446e518e4fe86ff40e33543445f4e99edf840a21Timo Sirainen
9ed2951bd0bb1878a27437d7c00611b2baadd614Timo Sirainen struct imap_match_glob *glob;
e5acc283bf030b0b5c79ca4e52d315c516a299faPascal Volk enum mailbox_info_flags leaf_flags, parent_flags;
446e518e4fe86ff40e33543445f4e99edf840a21Timo Sirainen
446e518e4fe86ff40e33543445f4e99edf840a21Timo Sirainen unsigned int update_only:1;
d368bfd671ae6d04a69eb7f418521d49b8bbf77aTimo Sirainen unsigned int match_parents:1;
446e518e4fe86ff40e33543445f4e99edf840a21Timo Sirainen};
b44650b0f48a4b5f0dc240ed836833a00b643b9fTimo Sirainen
b44650b0f48a4b5f0dc240ed836833a00b643b9fTimo Sirainen/* Modules should use do "my_id = mailbox_list_module_id++" and
b44650b0f48a4b5f0dc240ed836833a00b643b9fTimo Sirainen use objects' module_contexts[id] for their own purposes. */
b44650b0f48a4b5f0dc240ed836833a00b643b9fTimo Sirainenextern struct mailbox_list_module_register mailbox_list_module_register;
b44650b0f48a4b5f0dc240ed836833a00b643b9fTimo Sirainen
473080c7c0d25ddfdf77e7dfa0ba8f73c6c669d5Timo Sirainenvoid mailbox_lists_init(void);
473080c7c0d25ddfdf77e7dfa0ba8f73c6c669d5Timo Sirainenvoid mailbox_lists_deinit(void);
b44650b0f48a4b5f0dc240ed836833a00b643b9fTimo Sirainen
a3dd97fb6d92a89c3de0597fed2d4b044c7aeb84Timo Sirainenint mailbox_list_settings_parse(const char *data,
a3dd97fb6d92a89c3de0597fed2d4b044c7aeb84Timo Sirainen struct mailbox_list_settings *set,
f968e62caa52a8924bd05ebf76ff515b5c18e17bTimo Sirainen struct mail_namespace *ns,
a3dd97fb6d92a89c3de0597fed2d4b044c7aeb84Timo Sirainen const char **error_r);
a3dd97fb6d92a89c3de0597fed2d4b044c7aeb84Timo Sirainen
a3dd97fb6d92a89c3de0597fed2d4b044c7aeb84Timo Sirainenint mailbox_list_delete_index_control(struct mailbox_list *list,
a3dd97fb6d92a89c3de0597fed2d4b044c7aeb84Timo Sirainen const char *name);
5367840b91df098e016f382960c391691c8d33ffTimo Sirainen
b44650b0f48a4b5f0dc240ed836833a00b643b9fTimo Sirainenvoid mailbox_list_iter_update(struct mailbox_list_iter_update_context *ctx,
b44650b0f48a4b5f0dc240ed836833a00b643b9fTimo Sirainen const char *name);
f968e62caa52a8924bd05ebf76ff515b5c18e17bTimo Sirainen
b44650b0f48a4b5f0dc240ed836833a00b643b9fTimo Sirainenbool mailbox_list_name_is_too_large(const char *name, char sep);
f968e62caa52a8924bd05ebf76ff515b5c18e17bTimo Sirainenenum mailbox_list_file_type mailbox_list_get_file_type(const struct dirent *d);
f968e62caa52a8924bd05ebf76ff515b5c18e17bTimo Sirainenbool mailbox_list_try_get_absolute_path(struct mailbox_list *list,
a3dd97fb6d92a89c3de0597fed2d4b044c7aeb84Timo Sirainen const char **name);
b24ffea8baa472d9b542e54ed3f9939eefd020adTimo Sirainen
b24ffea8baa472d9b542e54ed3f9939eefd020adTimo Sirainenvoid mailbox_list_add_change(struct mailbox_list *list,
b24ffea8baa472d9b542e54ed3f9939eefd020adTimo Sirainen enum mailbox_log_record_type type,
b24ffea8baa472d9b542e54ed3f9939eefd020adTimo Sirainen const uint8_t mailbox_guid[MAIL_GUID_128_SIZE]);
b24ffea8baa472d9b542e54ed3f9939eefd020adTimo Sirainenint mailbox_list_get_guid_path(struct mailbox_list *list, const char *path,
b24ffea8baa472d9b542e54ed3f9939eefd020adTimo Sirainen uint8_t mailbox_guid[MAIL_GUID_128_SIZE]);
b24ffea8baa472d9b542e54ed3f9939eefd020adTimo Sirainenvoid mailbox_name_get_sha128(const char *name,
b24ffea8baa472d9b542e54ed3f9939eefd020adTimo Sirainen uint8_t guid[MAIL_GUID_128_SIZE]);
4ed1b49d815ec41a5e4b6a23d23e94b958da1923Timo Sirainen
4ed1b49d815ec41a5e4b6a23d23e94b958da1923Timo Sirainenvoid mailbox_list_clear_error(struct mailbox_list *list);
4ed1b49d815ec41a5e4b6a23d23e94b958da1923Timo Sirainenvoid mailbox_list_set_error(struct mailbox_list *list,
a3dd97fb6d92a89c3de0597fed2d4b044c7aeb84Timo Sirainen enum mail_error error, const char *string);
4ed1b49d815ec41a5e4b6a23d23e94b958da1923Timo Sirainenvoid mailbox_list_set_critical(struct mailbox_list *list, const char *fmt, ...)
b44650b0f48a4b5f0dc240ed836833a00b643b9fTimo Sirainen ATTR_FORMAT(2, 3);
b44650b0f48a4b5f0dc240ed836833a00b643b9fTimo Sirainenvoid mailbox_list_set_internal_error(struct mailbox_list *list);
473080c7c0d25ddfdf77e7dfa0ba8f73c6c669d5Timo Sirainenbool mailbox_list_set_error_from_errno(struct mailbox_list *list);
473080c7c0d25ddfdf77e7dfa0ba8f73c6c669d5Timo Sirainen
9ed2951bd0bb1878a27437d7c00611b2baadd614Timo Sirainen#endif
9ed2951bd0bb1878a27437d7c00611b2baadd614Timo Sirainen