mailbox-list-private.h revision 37847ec8eaec9ad55c9df10ae109efe7b37ac573
76b43e4417bab52e913da39b5f5bc2a130d3f149Timo Sirainen#ifndef MAILBOX_LIST_PRIVATE_H
33ca6b017b6ebbd048651b5e3d16915001dbc291Timo Sirainen#define MAILBOX_LIST_PRIVATE_H
33ca6b017b6ebbd048651b5e3d16915001dbc291Timo Sirainen
33ca6b017b6ebbd048651b5e3d16915001dbc291Timo Sirainen#include "mail-namespace.h"
5dd05e966ffd69181ab3067f6939b03ced68ebc3Timo Sirainen#include "mailbox-list.h"
33ca6b017b6ebbd048651b5e3d16915001dbc291Timo Sirainen#include "mail-storage-settings.h"
33ca6b017b6ebbd048651b5e3d16915001dbc291Timo Sirainen
33ca6b017b6ebbd048651b5e3d16915001dbc291Timo Sirainen#define MAILBOX_LIST_NAME_MAILDIRPLUSPLUS "maildir++"
33ca6b017b6ebbd048651b5e3d16915001dbc291Timo Sirainen#define MAILBOX_LIST_NAME_IMAPDIR "imapdir"
c0435c854a0e7246373b9752d163095cc4fbe985Timo Sirainen#define MAILBOX_LIST_NAME_FS "fs"
33ca6b017b6ebbd048651b5e3d16915001dbc291Timo Sirainen
4b058f90f9e8a2c6b2eed275de4eb8cc5195a71dTimo Sirainen#define MAILBOX_LOG_FILE_NAME "dovecot.mailbox.log"
33ca6b017b6ebbd048651b5e3d16915001dbc291Timo Sirainen
33ca6b017b6ebbd048651b5e3d16915001dbc291Timo Sirainenenum mailbox_log_record_type;
d6af1e63bc7824f1cc5b9b73a1c5f8f8789788d6Timo Sirainenstruct dirent;
d6af1e63bc7824f1cc5b9b73a1c5f8f8789788d6Timo Sirainenstruct imap_match_glob;
d6af1e63bc7824f1cc5b9b73a1c5f8f8789788d6Timo Sirainenstruct mailbox_tree_context;
d6af1e63bc7824f1cc5b9b73a1c5f8f8789788d6Timo Sirainen
d6af1e63bc7824f1cc5b9b73a1c5f8f8789788d6Timo Sirainenstruct mailbox_list_vfuncs {
d6af1e63bc7824f1cc5b9b73a1c5f8f8789788d6Timo Sirainen struct mailbox_list *(*alloc)(void);
d6af1e63bc7824f1cc5b9b73a1c5f8f8789788d6Timo Sirainen void (*deinit)(struct mailbox_list *list);
d6af1e63bc7824f1cc5b9b73a1c5f8f8789788d6Timo Sirainen
d6af1e63bc7824f1cc5b9b73a1c5f8f8789788d6Timo Sirainen int (*get_storage)(struct mailbox_list **list, const char **name,
d6af1e63bc7824f1cc5b9b73a1c5f8f8789788d6Timo Sirainen struct mail_storage **storage_r);
c0435c854a0e7246373b9752d163095cc4fbe985Timo Sirainen bool (*is_valid_pattern)(struct mailbox_list *list,
33ca6b017b6ebbd048651b5e3d16915001dbc291Timo Sirainen const char *pattern);
cd466fe7b84b0223735a6469c7f7bc225f65996dTimo Sirainen bool (*is_valid_existing_name)(struct mailbox_list *list,
33ca6b017b6ebbd048651b5e3d16915001dbc291Timo Sirainen const char *name);
33ca6b017b6ebbd048651b5e3d16915001dbc291Timo Sirainen bool (*is_valid_create_name)(struct mailbox_list *list,
0e3f8c6edad565112d91f0a53568c0313d657e48Timo Sirainen const char *name);
0e3f8c6edad565112d91f0a53568c0313d657e48Timo Sirainen
0e3f8c6edad565112d91f0a53568c0313d657e48Timo Sirainen const char *(*get_path)(struct mailbox_list *list, const char *name,
0e3f8c6edad565112d91f0a53568c0313d657e48Timo Sirainen enum mailbox_list_path_type type);
0e3f8c6edad565112d91f0a53568c0313d657e48Timo Sirainen int (*get_mailbox_name_status)(struct mailbox_list *list,
d5cebe7f98e63d4e2822863ef2faa4971e8b3a5dTimo Sirainen const char *name,
d56384d5226c8860079d0d0b08b83404e8c42986Timo Sirainen enum mailbox_name_status *status);
0f66f12eb4cdbf47670975044c88d8f388bf92dfTimo Sirainen
d56384d5226c8860079d0d0b08b83404e8c42986Timo Sirainen const char *(*get_temp_prefix)(struct mailbox_list *list, bool global);
d56384d5226c8860079d0d0b08b83404e8c42986Timo Sirainen const char *(*join_refpattern)(struct mailbox_list *list,
4b058f90f9e8a2c6b2eed275de4eb8cc5195a71dTimo Sirainen const char *ref, const char *pattern);
33ca6b017b6ebbd048651b5e3d16915001dbc291Timo Sirainen
d6af1e63bc7824f1cc5b9b73a1c5f8f8789788d6Timo Sirainen struct mailbox_list_iterate_context *
d6af1e63bc7824f1cc5b9b73a1c5f8f8789788d6Timo Sirainen (*iter_init)(struct mailbox_list *list,
d6af1e63bc7824f1cc5b9b73a1c5f8f8789788d6Timo Sirainen const char *const *patterns,
33ca6b017b6ebbd048651b5e3d16915001dbc291Timo Sirainen enum mailbox_list_iter_flags flags);
d6af1e63bc7824f1cc5b9b73a1c5f8f8789788d6Timo Sirainen const struct mailbox_info *
d6af1e63bc7824f1cc5b9b73a1c5f8f8789788d6Timo Sirainen (*iter_next)(struct mailbox_list_iterate_context *ctx);
d6af1e63bc7824f1cc5b9b73a1c5f8f8789788d6Timo Sirainen int (*iter_deinit)(struct mailbox_list_iterate_context *ctx);
d6af1e63bc7824f1cc5b9b73a1c5f8f8789788d6Timo Sirainen
d6af1e63bc7824f1cc5b9b73a1c5f8f8789788d6Timo Sirainen /* Returns -1 if error, 0 if it's not a valid mailbox, 1 if it is.
33ca6b017b6ebbd048651b5e3d16915001dbc291Timo Sirainen flags may be updated (especially the children flags). */
33ca6b017b6ebbd048651b5e3d16915001dbc291Timo Sirainen int (*iter_is_mailbox)(struct mailbox_list_iterate_context *ctx,
d5cebe7f98e63d4e2822863ef2faa4971e8b3a5dTimo Sirainen const char *dir, const char *fname,
6a9f9a5101b665fd2ef80c9e048a5eace78e01efTimo Sirainen const char *mailbox_name,
d5cebe7f98e63d4e2822863ef2faa4971e8b3a5dTimo Sirainen enum mailbox_list_file_type type,
0f66f12eb4cdbf47670975044c88d8f388bf92dfTimo Sirainen enum mailbox_info_flags *flags_r);
6a9f9a5101b665fd2ef80c9e048a5eace78e01efTimo Sirainen
6a9f9a5101b665fd2ef80c9e048a5eace78e01efTimo Sirainen int (*set_subscribed)(struct mailbox_list *list,
c0435c854a0e7246373b9752d163095cc4fbe985Timo Sirainen const char *name, bool set);
33ca6b017b6ebbd048651b5e3d16915001dbc291Timo Sirainen int (*delete_mailbox)(struct mailbox_list *list, const char *name);
4b058f90f9e8a2c6b2eed275de4eb8cc5195a71dTimo Sirainen int (*rename_mailbox)(struct mailbox_list *oldlist, const char *oldname,
33ca6b017b6ebbd048651b5e3d16915001dbc291Timo Sirainen struct mailbox_list *newlist, const char *newname,
33ca6b017b6ebbd048651b5e3d16915001dbc291Timo Sirainen bool rename_children);
33ca6b017b6ebbd048651b5e3d16915001dbc291Timo Sirainen /* called by rename_mailbox() just before running the actual rename() */
c0435c854a0e7246373b9752d163095cc4fbe985Timo Sirainen int (*rename_mailbox_pre)(struct mailbox_list *oldlist,
a3ea111cfdbfd4f32baeb0bd7f1d72568c60a023Timo Sirainen const char *oldname,
a3ea111cfdbfd4f32baeb0bd7f1d72568c60a023Timo Sirainen struct mailbox_list *newlist,
a3ea111cfdbfd4f32baeb0bd7f1d72568c60a023Timo Sirainen const char *newname);
a3ea111cfdbfd4f32baeb0bd7f1d72568c60a023Timo Sirainen};
8d80659e504ffb34bb0c6a633184fece35751b18Timo Sirainen
33ca6b017b6ebbd048651b5e3d16915001dbc291Timo Sirainenstruct mailbox_list_module_register {
4b058f90f9e8a2c6b2eed275de4eb8cc5195a71dTimo Sirainen unsigned int id;
8d80659e504ffb34bb0c6a633184fece35751b18Timo Sirainen};
33ca6b017b6ebbd048651b5e3d16915001dbc291Timo Sirainen
33ca6b017b6ebbd048651b5e3d16915001dbc291Timo Sirainenunion mailbox_list_module_context {
c0435c854a0e7246373b9752d163095cc4fbe985Timo Sirainen struct mailbox_list_vfuncs super;
33ca6b017b6ebbd048651b5e3d16915001dbc291Timo Sirainen struct mailbox_list_module_register *reg;
33ca6b017b6ebbd048651b5e3d16915001dbc291Timo Sirainen};
33ca6b017b6ebbd048651b5e3d16915001dbc291Timo Sirainen
33ca6b017b6ebbd048651b5e3d16915001dbc291Timo Sirainenstruct mailbox_list {
1f57716285d4c5bc9bf2fd5569e3c85fd496afd9Timo Sirainen const char *name;
1f57716285d4c5bc9bf2fd5569e3c85fd496afd9Timo Sirainen char hierarchy_sep;
1f57716285d4c5bc9bf2fd5569e3c85fd496afd9Timo Sirainen enum mailbox_list_properties props;
1f57716285d4c5bc9bf2fd5569e3c85fd496afd9Timo Sirainen size_t mailbox_name_max_length;
1f57716285d4c5bc9bf2fd5569e3c85fd496afd9Timo Sirainen
1f57716285d4c5bc9bf2fd5569e3c85fd496afd9Timo Sirainen struct mailbox_list_vfuncs v;
1f57716285d4c5bc9bf2fd5569e3c85fd496afd9Timo Sirainen
1f57716285d4c5bc9bf2fd5569e3c85fd496afd9Timo Sirainen/* private: */
c0435c854a0e7246373b9752d163095cc4fbe985Timo Sirainen pool_t pool;
33ca6b017b6ebbd048651b5e3d16915001dbc291Timo Sirainen struct mail_namespace *ns;
33ca6b017b6ebbd048651b5e3d16915001dbc291Timo Sirainen struct mailbox_list_settings set;
33ca6b017b6ebbd048651b5e3d16915001dbc291Timo Sirainen const struct mail_storage_settings *mail_set;
33ca6b017b6ebbd048651b5e3d16915001dbc291Timo Sirainen enum mailbox_list_flags flags;
c0435c854a0e7246373b9752d163095cc4fbe985Timo Sirainen
33ca6b017b6ebbd048651b5e3d16915001dbc291Timo Sirainen /* -1 if not set yet. use mailbox_list_get_permissions() to set them */
33ca6b017b6ebbd048651b5e3d16915001dbc291Timo Sirainen mode_t file_create_mode, dir_create_mode;
33ca6b017b6ebbd048651b5e3d16915001dbc291Timo Sirainen gid_t file_create_gid;
33ca6b017b6ebbd048651b5e3d16915001dbc291Timo Sirainen /* origin (e.g. path) where the file_create_gid was got from */
a3ea111cfdbfd4f32baeb0bd7f1d72568c60a023Timo Sirainen const char *file_create_gid_origin;
33ca6b017b6ebbd048651b5e3d16915001dbc291Timo Sirainen
33ca6b017b6ebbd048651b5e3d16915001dbc291Timo Sirainen struct mailbox_log *changelog;
33ca6b017b6ebbd048651b5e3d16915001dbc291Timo Sirainen
33ca6b017b6ebbd048651b5e3d16915001dbc291Timo Sirainen char *error_string;
33ca6b017b6ebbd048651b5e3d16915001dbc291Timo Sirainen enum mail_error error;
a29a5b7520f7b8d6cdaf97e66d184b6a9e4f4ecfTimo Sirainen bool temporary_error;
33ca6b017b6ebbd048651b5e3d16915001dbc291Timo Sirainen
33ca6b017b6ebbd048651b5e3d16915001dbc291Timo Sirainen ARRAY_DEFINE(module_contexts, union mailbox_list_module_context *);
33ca6b017b6ebbd048651b5e3d16915001dbc291Timo Sirainen};
33ca6b017b6ebbd048651b5e3d16915001dbc291Timo Sirainen
c0435c854a0e7246373b9752d163095cc4fbe985Timo Sirainenstruct mailbox_list_iterate_context {
33ca6b017b6ebbd048651b5e3d16915001dbc291Timo Sirainen struct mailbox_list *list;
33ca6b017b6ebbd048651b5e3d16915001dbc291Timo Sirainen enum mailbox_list_iter_flags flags;
33ca6b017b6ebbd048651b5e3d16915001dbc291Timo Sirainen bool failed;
33ca6b017b6ebbd048651b5e3d16915001dbc291Timo Sirainen};
33ca6b017b6ebbd048651b5e3d16915001dbc291Timo Sirainen
33ca6b017b6ebbd048651b5e3d16915001dbc291Timo Sirainenstruct mailbox_list_iter_update_context {
33ca6b017b6ebbd048651b5e3d16915001dbc291Timo Sirainen struct mailbox_list_iterate_context *iter_ctx;
33ca6b017b6ebbd048651b5e3d16915001dbc291Timo Sirainen struct mailbox_tree_context *tree_ctx;
c0435c854a0e7246373b9752d163095cc4fbe985Timo Sirainen
33ca6b017b6ebbd048651b5e3d16915001dbc291Timo Sirainen struct imap_match_glob *glob;
33ca6b017b6ebbd048651b5e3d16915001dbc291Timo Sirainen enum mailbox_info_flags leaf_flags, parent_flags;
33ca6b017b6ebbd048651b5e3d16915001dbc291Timo Sirainen
33ca6b017b6ebbd048651b5e3d16915001dbc291Timo Sirainen unsigned int update_only:1;
33ca6b017b6ebbd048651b5e3d16915001dbc291Timo Sirainen unsigned int match_parents:1;
33ca6b017b6ebbd048651b5e3d16915001dbc291Timo Sirainen};
33ca6b017b6ebbd048651b5e3d16915001dbc291Timo Sirainen
33ca6b017b6ebbd048651b5e3d16915001dbc291Timo Sirainen/* Modules should use do "my_id = mailbox_list_module_id++" and
c0435c854a0e7246373b9752d163095cc4fbe985Timo Sirainen use objects' module_contexts[id] for their own purposes. */
33ca6b017b6ebbd048651b5e3d16915001dbc291Timo Sirainenextern struct mailbox_list_module_register mailbox_list_module_register;
b09be485e9373be4288f5615bbce6ebed65a425aTimo Sirainen
b09be485e9373be4288f5615bbce6ebed65a425aTimo Sirainenextern void (*hook_mailbox_list_created)(struct mailbox_list *list);
b09be485e9373be4288f5615bbce6ebed65a425aTimo Sirainen
b09be485e9373be4288f5615bbce6ebed65a425aTimo Sirainenvoid mailbox_lists_init(void);
b09be485e9373be4288f5615bbce6ebed65a425aTimo Sirainenvoid mailbox_lists_deinit(void);
b09be485e9373be4288f5615bbce6ebed65a425aTimo Sirainen
b09be485e9373be4288f5615bbce6ebed65a425aTimo Sirainenint mailbox_list_settings_parse(const char *data,
b09be485e9373be4288f5615bbce6ebed65a425aTimo Sirainen struct mailbox_list_settings *set,
b09be485e9373be4288f5615bbce6ebed65a425aTimo Sirainen struct mail_namespace *ns,
b09be485e9373be4288f5615bbce6ebed65a425aTimo Sirainen const char **error_r);
b09be485e9373be4288f5615bbce6ebed65a425aTimo Sirainen
b09be485e9373be4288f5615bbce6ebed65a425aTimo Sirainenint mailbox_list_delete_index_control(struct mailbox_list *list,
b09be485e9373be4288f5615bbce6ebed65a425aTimo Sirainen const char *name);
b09be485e9373be4288f5615bbce6ebed65a425aTimo Sirainen
b09be485e9373be4288f5615bbce6ebed65a425aTimo Sirainenvoid mailbox_list_iter_update(struct mailbox_list_iter_update_context *ctx,
b09be485e9373be4288f5615bbce6ebed65a425aTimo Sirainen const char *name);
b09be485e9373be4288f5615bbce6ebed65a425aTimo Sirainen
b09be485e9373be4288f5615bbce6ebed65a425aTimo Sirainenbool mailbox_list_name_is_too_large(const char *name, char sep);
b09be485e9373be4288f5615bbce6ebed65a425aTimo Sirainenenum mailbox_list_file_type mailbox_list_get_file_type(const struct dirent *d);
b09be485e9373be4288f5615bbce6ebed65a425aTimo Sirainenbool mailbox_list_try_get_absolute_path(struct mailbox_list *list,
b09be485e9373be4288f5615bbce6ebed65a425aTimo Sirainen const char **name);
b09be485e9373be4288f5615bbce6ebed65a425aTimo Sirainen
b09be485e9373be4288f5615bbce6ebed65a425aTimo Sirainenvoid mailbox_list_add_change(struct mailbox_list *list,
b09be485e9373be4288f5615bbce6ebed65a425aTimo Sirainen enum mailbox_log_record_type type,
b09be485e9373be4288f5615bbce6ebed65a425aTimo Sirainen const uint8_t mailbox_guid[MAIL_GUID_128_SIZE]);
b09be485e9373be4288f5615bbce6ebed65a425aTimo Sirainen
5dd05e966ffd69181ab3067f6939b03ced68ebc3Timo Sirainenvoid mailbox_list_clear_error(struct mailbox_list *list);
b09be485e9373be4288f5615bbce6ebed65a425aTimo Sirainenvoid mailbox_list_set_error(struct mailbox_list *list,
b09be485e9373be4288f5615bbce6ebed65a425aTimo Sirainen enum mail_error error, const char *string);
b09be485e9373be4288f5615bbce6ebed65a425aTimo Sirainenvoid mailbox_list_set_critical(struct mailbox_list *list, const char *fmt, ...)
33ca6b017b6ebbd048651b5e3d16915001dbc291Timo Sirainen ATTR_FORMAT(2, 3);
33ca6b017b6ebbd048651b5e3d16915001dbc291Timo Sirainenvoid mailbox_list_set_internal_error(struct mailbox_list *list);
9453e8d75cfd8fab2232cf772e9b120f308fb3eeTimo Sirainenbool mailbox_list_set_error_from_errno(struct mailbox_list *list);
9453e8d75cfd8fab2232cf772e9b120f308fb3eeTimo Sirainen
9453e8d75cfd8fab2232cf772e9b120f308fb3eeTimo Sirainen#endif
9453e8d75cfd8fab2232cf772e9b120f308fb3eeTimo Sirainen