mailbox-list-private.h revision 4d84348ffcbb60de566108562c95ad64629e7a53
c25356d5978632df6203437e1953bcb29e0c736fTimo Sirainen#ifndef MAILBOX_LIST_PRIVATE_H
c25356d5978632df6203437e1953bcb29e0c736fTimo Sirainen#define MAILBOX_LIST_PRIVATE_H
a27e065f1a1f91c7fbdf7c2ea1c387441af0cbb3Timo Sirainen
2423da95ee20fd4b3c260c1389cf2952d25f099cTimo Sirainen#include "mail-namespace.h"
a27e065f1a1f91c7fbdf7c2ea1c387441af0cbb3Timo Sirainen#include "mailbox-list.h"
a64adf62fa33f2463a86f990217b0c9078531a40Timo Sirainen#include "mail-storage-settings.h"
a27e065f1a1f91c7fbdf7c2ea1c387441af0cbb3Timo Sirainen
2615df45a8027948a474abe5e817b34b0499c171Timo Sirainen#define MAILBOX_LIST_NAME_MAILDIRPLUSPLUS "maildir++"
2615df45a8027948a474abe5e817b34b0499c171Timo Sirainen#define MAILBOX_LIST_NAME_IMAPDIR "imapdir"
2615df45a8027948a474abe5e817b34b0499c171Timo Sirainen#define MAILBOX_LIST_NAME_FS "fs"
2615df45a8027948a474abe5e817b34b0499c171Timo Sirainen
37847ec8eaec9ad55c9df10ae109efe7b37ac573Timo Sirainen#define MAILBOX_LOG_FILE_NAME "dovecot.mailbox.log"
37847ec8eaec9ad55c9df10ae109efe7b37ac573Timo Sirainen
37847ec8eaec9ad55c9df10ae109efe7b37ac573Timo Sirainenenum mailbox_log_record_type;
dca6d617a23e3f93af3b8df59acb46478179fe55Timo Sirainenstruct stat;
a27e065f1a1f91c7fbdf7c2ea1c387441af0cbb3Timo Sirainenstruct dirent;
ef50336eefcb9ba99f73c6af37420eaf8857a39bTimo Sirainenstruct imap_match_glob;
ef50336eefcb9ba99f73c6af37420eaf8857a39bTimo Sirainenstruct mailbox_tree_context;
a27e065f1a1f91c7fbdf7c2ea1c387441af0cbb3Timo Sirainen
dca6d617a23e3f93af3b8df59acb46478179fe55Timo Sirainen#define MAILBOX_INFO_FLAGS_FINISHED(flags) \
dca6d617a23e3f93af3b8df59acb46478179fe55Timo Sirainen (((flags) & (MAILBOX_SELECT | MAILBOX_NOSELECT | \
dca6d617a23e3f93af3b8df59acb46478179fe55Timo Sirainen MAILBOX_NONEXISTENT)) != 0)
dca6d617a23e3f93af3b8df59acb46478179fe55Timo Sirainen
dca6d617a23e3f93af3b8df59acb46478179fe55Timo Sirainen
a27e065f1a1f91c7fbdf7c2ea1c387441af0cbb3Timo Sirainenstruct mailbox_list_vfuncs {
a27e065f1a1f91c7fbdf7c2ea1c387441af0cbb3Timo Sirainen struct mailbox_list *(*alloc)(void);
a27e065f1a1f91c7fbdf7c2ea1c387441af0cbb3Timo Sirainen void (*deinit)(struct mailbox_list *list);
a27e065f1a1f91c7fbdf7c2ea1c387441af0cbb3Timo Sirainen
2615df45a8027948a474abe5e817b34b0499c171Timo Sirainen int (*get_storage)(struct mailbox_list **list, const char **name,
2615df45a8027948a474abe5e817b34b0499c171Timo Sirainen struct mail_storage **storage_r);
533bfba437e4120aa29dd45bca2aa87e30ee28a2Timo Sirainen bool (*is_valid_pattern)(struct mailbox_list *list,
533bfba437e4120aa29dd45bca2aa87e30ee28a2Timo Sirainen const char *pattern);
a27e065f1a1f91c7fbdf7c2ea1c387441af0cbb3Timo Sirainen bool (*is_valid_existing_name)(struct mailbox_list *list,
a27e065f1a1f91c7fbdf7c2ea1c387441af0cbb3Timo Sirainen const char *name);
a27e065f1a1f91c7fbdf7c2ea1c387441af0cbb3Timo Sirainen bool (*is_valid_create_name)(struct mailbox_list *list,
a27e065f1a1f91c7fbdf7c2ea1c387441af0cbb3Timo Sirainen const char *name);
a27e065f1a1f91c7fbdf7c2ea1c387441af0cbb3Timo Sirainen
a27e065f1a1f91c7fbdf7c2ea1c387441af0cbb3Timo Sirainen const char *(*get_path)(struct mailbox_list *list, const char *name,
a27e065f1a1f91c7fbdf7c2ea1c387441af0cbb3Timo Sirainen enum mailbox_list_path_type type);
a27e065f1a1f91c7fbdf7c2ea1c387441af0cbb3Timo Sirainen int (*get_mailbox_name_status)(struct mailbox_list *list,
a27e065f1a1f91c7fbdf7c2ea1c387441af0cbb3Timo Sirainen const char *name,
a27e065f1a1f91c7fbdf7c2ea1c387441af0cbb3Timo Sirainen enum mailbox_name_status *status);
a27e065f1a1f91c7fbdf7c2ea1c387441af0cbb3Timo Sirainen
c040ee67d0ac0fb7375bb543965bf67dcae6affaTimo Sirainen const char *(*get_temp_prefix)(struct mailbox_list *list, bool global);
533bfba437e4120aa29dd45bca2aa87e30ee28a2Timo Sirainen const char *(*join_refpattern)(struct mailbox_list *list,
533bfba437e4120aa29dd45bca2aa87e30ee28a2Timo Sirainen const char *ref, const char *pattern);
a27e065f1a1f91c7fbdf7c2ea1c387441af0cbb3Timo Sirainen
a27e065f1a1f91c7fbdf7c2ea1c387441af0cbb3Timo Sirainen struct mailbox_list_iterate_context *
d92f33f13830ba23d814342bf3ea8db721a15bb1Timo Sirainen (*iter_init)(struct mailbox_list *list,
d92f33f13830ba23d814342bf3ea8db721a15bb1Timo Sirainen const char *const *patterns,
a27e065f1a1f91c7fbdf7c2ea1c387441af0cbb3Timo Sirainen enum mailbox_list_iter_flags flags);
61e84692827b6a64912343f515c984853021483aTimo Sirainen const struct mailbox_info *
a27e065f1a1f91c7fbdf7c2ea1c387441af0cbb3Timo Sirainen (*iter_next)(struct mailbox_list_iterate_context *ctx);
a27e065f1a1f91c7fbdf7c2ea1c387441af0cbb3Timo Sirainen int (*iter_deinit)(struct mailbox_list_iterate_context *ctx);
a27e065f1a1f91c7fbdf7c2ea1c387441af0cbb3Timo Sirainen
dca6d617a23e3f93af3b8df59acb46478179fe55Timo Sirainen int (*get_mailbox_flags)(struct mailbox_list *list,
dca6d617a23e3f93af3b8df59acb46478179fe55Timo Sirainen const char *dir, const char *fname,
dca6d617a23e3f93af3b8df59acb46478179fe55Timo Sirainen enum mailbox_list_file_type type,
dca6d617a23e3f93af3b8df59acb46478179fe55Timo Sirainen struct stat *st_r,
dca6d617a23e3f93af3b8df59acb46478179fe55Timo Sirainen enum mailbox_info_flags *flags_r);
dca6d617a23e3f93af3b8df59acb46478179fe55Timo Sirainen /* Returns TRUE if name is mailbox's internal file/directory.
61b0637759146621cbb7edcbd0b03a71cfd66dfeTimo Sirainen If it does, mailbox deletion assumes it can safely delete it. */
dca6d617a23e3f93af3b8df59acb46478179fe55Timo Sirainen bool (*is_internal_name)(struct mailbox_list *list, const char *name);
b039dabf4c53f72454e795930e7643b6e0e625f9Timo Sirainen
a27e065f1a1f91c7fbdf7c2ea1c387441af0cbb3Timo Sirainen int (*set_subscribed)(struct mailbox_list *list,
a27e065f1a1f91c7fbdf7c2ea1c387441af0cbb3Timo Sirainen const char *name, bool set);
3c493c276f599d9b9cd10764876d648003046954Timo Sirainen int (*create_mailbox_dir)(struct mailbox_list *list, const char *name,
3c493c276f599d9b9cd10764876d648003046954Timo Sirainen bool directory);
b039dabf4c53f72454e795930e7643b6e0e625f9Timo Sirainen int (*delete_mailbox)(struct mailbox_list *list, const char *name);
2f30b72d49fbff0c4096125c139e4bdfef45669cTimo Sirainen int (*delete_dir)(struct mailbox_list *list, const char *name);
91b203fd2132510a47a4b34252c0ae0efd688a19Timo Sirainen int (*rename_mailbox)(struct mailbox_list *oldlist, const char *oldname,
91b203fd2132510a47a4b34252c0ae0efd688a19Timo Sirainen struct mailbox_list *newlist, const char *newname,
91b203fd2132510a47a4b34252c0ae0efd688a19Timo Sirainen bool rename_children);
a27e065f1a1f91c7fbdf7c2ea1c387441af0cbb3Timo Sirainen};
a27e065f1a1f91c7fbdf7c2ea1c387441af0cbb3Timo Sirainen
8e371a3ce32bd64288786855b8ce0cb63f19f7d1Timo Sirainenstruct mailbox_list_module_register {
8e371a3ce32bd64288786855b8ce0cb63f19f7d1Timo Sirainen unsigned int id;
8e371a3ce32bd64288786855b8ce0cb63f19f7d1Timo Sirainen};
8e371a3ce32bd64288786855b8ce0cb63f19f7d1Timo Sirainen
8e371a3ce32bd64288786855b8ce0cb63f19f7d1Timo Sirainenunion mailbox_list_module_context {
8e371a3ce32bd64288786855b8ce0cb63f19f7d1Timo Sirainen struct mailbox_list_vfuncs super;
8e371a3ce32bd64288786855b8ce0cb63f19f7d1Timo Sirainen struct mailbox_list_module_register *reg;
8e371a3ce32bd64288786855b8ce0cb63f19f7d1Timo Sirainen};
8e371a3ce32bd64288786855b8ce0cb63f19f7d1Timo Sirainen
a27e065f1a1f91c7fbdf7c2ea1c387441af0cbb3Timo Sirainenstruct mailbox_list {
a27e065f1a1f91c7fbdf7c2ea1c387441af0cbb3Timo Sirainen const char *name;
a27e065f1a1f91c7fbdf7c2ea1c387441af0cbb3Timo Sirainen char hierarchy_sep;
bbd0a870f8639767e4e4011d2aedadac08d5c66fTimo Sirainen enum mailbox_list_properties props;
a27e065f1a1f91c7fbdf7c2ea1c387441af0cbb3Timo Sirainen size_t mailbox_name_max_length;
a27e065f1a1f91c7fbdf7c2ea1c387441af0cbb3Timo Sirainen
539977f9257bd8985be5a8093658da266ae9cd19Timo Sirainen struct mailbox_list_vfuncs v, *vlast;
a27e065f1a1f91c7fbdf7c2ea1c387441af0cbb3Timo Sirainen
a27e065f1a1f91c7fbdf7c2ea1c387441af0cbb3Timo Sirainen/* private: */
a27e065f1a1f91c7fbdf7c2ea1c387441af0cbb3Timo Sirainen pool_t pool;
c58906589cafc32df4c04ffbef933baadd3f2276Timo Sirainen struct mail_namespace *ns;
a27e065f1a1f91c7fbdf7c2ea1c387441af0cbb3Timo Sirainen struct mailbox_list_settings set;
a64adf62fa33f2463a86f990217b0c9078531a40Timo Sirainen const struct mail_storage_settings *mail_set;
a27e065f1a1f91c7fbdf7c2ea1c387441af0cbb3Timo Sirainen enum mailbox_list_flags flags;
a27e065f1a1f91c7fbdf7c2ea1c387441af0cbb3Timo Sirainen
d02d34e138e32b4266f5a403d6c51d7803bf322fTimo Sirainen /* -1 if not set yet. use mailbox_list_get_permissions() to set them */
106b804c819443791f1324f8bbe34429eeea6a13Timo Sirainen mode_t file_create_mode, dir_create_mode;
d02d34e138e32b4266f5a403d6c51d7803bf322fTimo Sirainen gid_t file_create_gid;
e156adefc1260d31a145df2f5e9b3c82050d4163Timo Sirainen /* origin (e.g. path) where the file_create_gid was got from */
e156adefc1260d31a145df2f5e9b3c82050d4163Timo Sirainen const char *file_create_gid_origin;
5694eeb99b69dea8033ca77ad69743c6b4871370Timo Sirainen
37847ec8eaec9ad55c9df10ae109efe7b37ac573Timo Sirainen struct mailbox_log *changelog;
3fe67ec75ccae1230bb9eb9f16affc48377f6441Timo Sirainen time_t changelog_timestamp;
37847ec8eaec9ad55c9df10ae109efe7b37ac573Timo Sirainen
ff7056842f14fd3b30a2d327dfab165b9d15dd30Timo Sirainen char *error_string;
ff7056842f14fd3b30a2d327dfab165b9d15dd30Timo Sirainen enum mail_error error;
a27e065f1a1f91c7fbdf7c2ea1c387441af0cbb3Timo Sirainen bool temporary_error;
a27e065f1a1f91c7fbdf7c2ea1c387441af0cbb3Timo Sirainen
8e371a3ce32bd64288786855b8ce0cb63f19f7d1Timo Sirainen ARRAY_DEFINE(module_contexts, union mailbox_list_module_context *);
4d84348ffcbb60de566108562c95ad64629e7a53Timo Sirainen
4d84348ffcbb60de566108562c95ad64629e7a53Timo Sirainen unsigned int index_root_dir_created:1;
a27e065f1a1f91c7fbdf7c2ea1c387441af0cbb3Timo Sirainen};
a27e065f1a1f91c7fbdf7c2ea1c387441af0cbb3Timo Sirainen
a27e065f1a1f91c7fbdf7c2ea1c387441af0cbb3Timo Sirainenstruct mailbox_list_iterate_context {
a27e065f1a1f91c7fbdf7c2ea1c387441af0cbb3Timo Sirainen struct mailbox_list *list;
a27e065f1a1f91c7fbdf7c2ea1c387441af0cbb3Timo Sirainen enum mailbox_list_iter_flags flags;
a27e065f1a1f91c7fbdf7c2ea1c387441af0cbb3Timo Sirainen bool failed;
a27e065f1a1f91c7fbdf7c2ea1c387441af0cbb3Timo Sirainen};
a27e065f1a1f91c7fbdf7c2ea1c387441af0cbb3Timo Sirainen
4366a21968093172d9b757fe6894b1ee8916434eTimo Sirainenstruct mailbox_list_iter_update_context {
4366a21968093172d9b757fe6894b1ee8916434eTimo Sirainen struct mailbox_list_iterate_context *iter_ctx;
4366a21968093172d9b757fe6894b1ee8916434eTimo Sirainen struct mailbox_tree_context *tree_ctx;
4366a21968093172d9b757fe6894b1ee8916434eTimo Sirainen
4366a21968093172d9b757fe6894b1ee8916434eTimo Sirainen struct imap_match_glob *glob;
4366a21968093172d9b757fe6894b1ee8916434eTimo Sirainen enum mailbox_info_flags leaf_flags, parent_flags;
4366a21968093172d9b757fe6894b1ee8916434eTimo Sirainen
4366a21968093172d9b757fe6894b1ee8916434eTimo Sirainen unsigned int update_only:1;
4366a21968093172d9b757fe6894b1ee8916434eTimo Sirainen unsigned int match_parents:1;
4366a21968093172d9b757fe6894b1ee8916434eTimo Sirainen};
4366a21968093172d9b757fe6894b1ee8916434eTimo Sirainen
a27e065f1a1f91c7fbdf7c2ea1c387441af0cbb3Timo Sirainen/* Modules should use do "my_id = mailbox_list_module_id++" and
a27e065f1a1f91c7fbdf7c2ea1c387441af0cbb3Timo Sirainen use objects' module_contexts[id] for their own purposes. */
8e371a3ce32bd64288786855b8ce0cb63f19f7d1Timo Sirainenextern struct mailbox_list_module_register mailbox_list_module_register;
a27e065f1a1f91c7fbdf7c2ea1c387441af0cbb3Timo Sirainen
8a0ad174adb1eb5108511b90e97f4e5f9089b0eeTimo Sirainenvoid mailbox_lists_init(void);
8a0ad174adb1eb5108511b90e97f4e5f9089b0eeTimo Sirainenvoid mailbox_lists_deinit(void);
8a0ad174adb1eb5108511b90e97f4e5f9089b0eeTimo Sirainen
b365bd121cdc87f63e1dd47c5085a27091118e00Timo Sirainenint mailbox_list_settings_parse(struct mail_user *user, const char *data,
b365bd121cdc87f63e1dd47c5085a27091118e00Timo Sirainen struct mailbox_list_settings *set_r,
4645cc6c911a95991d7af43b40f88e99506ea5e9Timo Sirainen const char **error_r);
0b4e1043e596bfb36d999dacbf1d4d63ee96d75fTimo Sirainenconst char *mailbox_list_get_unexpanded_path(struct mailbox_list *list,
0b4e1043e596bfb36d999dacbf1d4d63ee96d75fTimo Sirainen enum mailbox_list_path_type type);
e0ca8f2484847b57e20798a9f9c7040708696a90Timo Sirainenconst char *
e0ca8f2484847b57e20798a9f9c7040708696a90Timo Sirainenmailbox_list_get_root_path(const struct mailbox_list_settings *set,
e0ca8f2484847b57e20798a9f9c7040708696a90Timo Sirainen enum mailbox_list_path_type type);
0b4e1043e596bfb36d999dacbf1d4d63ee96d75fTimo Sirainenint mailbox_list_mkdir(struct mailbox_list *list, const char *path,
0b4e1043e596bfb36d999dacbf1d4d63ee96d75fTimo Sirainen enum mailbox_list_path_type type);
adb6413686e52e00dded4932babcc08ff041876bTimo Sirainen
b039dabf4c53f72454e795930e7643b6e0e625f9Timo Sirainenint mailbox_list_delete_index_control(struct mailbox_list *list,
b039dabf4c53f72454e795930e7643b6e0e625f9Timo Sirainen const char *name);
b039dabf4c53f72454e795930e7643b6e0e625f9Timo Sirainen
4366a21968093172d9b757fe6894b1ee8916434eTimo Sirainenvoid mailbox_list_iter_update(struct mailbox_list_iter_update_context *ctx,
4366a21968093172d9b757fe6894b1ee8916434eTimo Sirainen const char *name);
ef50336eefcb9ba99f73c6af37420eaf8857a39bTimo Sirainen
a27e065f1a1f91c7fbdf7c2ea1c387441af0cbb3Timo Sirainenbool mailbox_list_name_is_too_large(const char *name, char sep);
a27e065f1a1f91c7fbdf7c2ea1c387441af0cbb3Timo Sirainenenum mailbox_list_file_type mailbox_list_get_file_type(const struct dirent *d);
96f2533c48ce5def0004931606a2fdf275578880Timo Sirainenbool mailbox_list_try_get_absolute_path(struct mailbox_list *list,
96f2533c48ce5def0004931606a2fdf275578880Timo Sirainen const char **name);
4d84348ffcbb60de566108562c95ad64629e7a53Timo Sirainenint mailbox_list_create_missing_index_dir(struct mailbox_list *list,
4d84348ffcbb60de566108562c95ad64629e7a53Timo Sirainen const char *name);
a27e065f1a1f91c7fbdf7c2ea1c387441af0cbb3Timo Sirainen
37847ec8eaec9ad55c9df10ae109efe7b37ac573Timo Sirainenvoid mailbox_list_add_change(struct mailbox_list *list,
37847ec8eaec9ad55c9df10ae109efe7b37ac573Timo Sirainen enum mailbox_log_record_type type,
37847ec8eaec9ad55c9df10ae109efe7b37ac573Timo Sirainen const uint8_t mailbox_guid[MAIL_GUID_128_SIZE]);
0185427dd52fddec6fc76d6e99c7659620d4366eTimo Sirainenint mailbox_list_get_guid_path(struct mailbox_list *list, const char *path,
0185427dd52fddec6fc76d6e99c7659620d4366eTimo Sirainen uint8_t mailbox_guid[MAIL_GUID_128_SIZE]);
9c66dd5c3e2ba484a5c7cdb98a139bda31fdfaa4Timo Sirainenvoid mailbox_name_get_sha128(const char *name,
9c66dd5c3e2ba484a5c7cdb98a139bda31fdfaa4Timo Sirainen uint8_t guid[MAIL_GUID_128_SIZE]);
37847ec8eaec9ad55c9df10ae109efe7b37ac573Timo Sirainen
a27e065f1a1f91c7fbdf7c2ea1c387441af0cbb3Timo Sirainenvoid mailbox_list_clear_error(struct mailbox_list *list);
ff7056842f14fd3b30a2d327dfab165b9d15dd30Timo Sirainenvoid mailbox_list_set_error(struct mailbox_list *list,
ff7056842f14fd3b30a2d327dfab165b9d15dd30Timo Sirainen enum mail_error error, const char *string);
a27e065f1a1f91c7fbdf7c2ea1c387441af0cbb3Timo Sirainenvoid mailbox_list_set_critical(struct mailbox_list *list, const char *fmt, ...)
43d32cbe60fdaef2699d99f1ca259053e9350411Timo Sirainen ATTR_FORMAT(2, 3);
5fb3bff645380804c9db2510940c41db6b8fdb01Timo Sirainenvoid mailbox_list_set_internal_error(struct mailbox_list *list);
ff7056842f14fd3b30a2d327dfab165b9d15dd30Timo Sirainenbool mailbox_list_set_error_from_errno(struct mailbox_list *list);
a27e065f1a1f91c7fbdf7c2ea1c387441af0cbb3Timo Sirainen
a27e065f1a1f91c7fbdf7c2ea1c387441af0cbb3Timo Sirainen#endif