mailbox-list-private.h revision 96f2533c48ce5def0004931606a2fdf275578880
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"
a27e065f1a1f91c7fbdf7c2ea1c387441af0cbb3Timo Sirainen
a27e065f1a1f91c7fbdf7c2ea1c387441af0cbb3Timo Sirainenstruct dirent;
ef50336eefcb9ba99f73c6af37420eaf8857a39bTimo Sirainenstruct imap_match_glob;
ef50336eefcb9ba99f73c6af37420eaf8857a39bTimo Sirainenstruct mailbox_tree_context;
a27e065f1a1f91c7fbdf7c2ea1c387441af0cbb3Timo Sirainen
a27e065f1a1f91c7fbdf7c2ea1c387441af0cbb3Timo Sirainenstruct mailbox_list_vfuncs {
a27e065f1a1f91c7fbdf7c2ea1c387441af0cbb3Timo Sirainen struct mailbox_list *(*alloc)(void);
a27e065f1a1f91c7fbdf7c2ea1c387441af0cbb3Timo Sirainen void (*deinit)(struct mailbox_list *list);
a27e065f1a1f91c7fbdf7c2ea1c387441af0cbb3Timo Sirainen
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
b039dabf4c53f72454e795930e7643b6e0e625f9Timo Sirainen /* Returns -1 if error, 0 if it's not a valid mailbox, 1 if it is.
b039dabf4c53f72454e795930e7643b6e0e625f9Timo Sirainen flags may be updated (especially the children flags). */
b039dabf4c53f72454e795930e7643b6e0e625f9Timo Sirainen int (*iter_is_mailbox)(struct mailbox_list_iterate_context *ctx,
b039dabf4c53f72454e795930e7643b6e0e625f9Timo Sirainen const char *dir, const char *fname,
7230352f1177a8ed2b924c6992e751fd2ab9bc27Timo Sirainen const char *mailbox_name,
b039dabf4c53f72454e795930e7643b6e0e625f9Timo Sirainen enum mailbox_list_file_type type,
b039dabf4c53f72454e795930e7643b6e0e625f9Timo Sirainen enum mailbox_info_flags *flags_r);
b039dabf4c53f72454e795930e7643b6e0e625f9Timo Sirainen
a27e065f1a1f91c7fbdf7c2ea1c387441af0cbb3Timo Sirainen int (*set_subscribed)(struct mailbox_list *list,
a27e065f1a1f91c7fbdf7c2ea1c387441af0cbb3Timo Sirainen const char *name, bool set);
b039dabf4c53f72454e795930e7643b6e0e625f9Timo Sirainen int (*delete_mailbox)(struct mailbox_list *list, const char *name);
b039dabf4c53f72454e795930e7643b6e0e625f9Timo Sirainen int (*rename_mailbox)(struct mailbox_list *list, const char *oldname,
b039dabf4c53f72454e795930e7643b6e0e625f9Timo Sirainen const char *newname);
0e5f8c4589cfeccb752307c8ac35a2f1633e4ecaTimo Sirainen /* called by rename_mailbox() just before running the actual rename() */
0e5f8c4589cfeccb752307c8ac35a2f1633e4ecaTimo Sirainen int (*rename_mailbox_pre)(struct mailbox_list *list,
0e5f8c4589cfeccb752307c8ac35a2f1633e4ecaTimo Sirainen const char *oldname, const char *newname);
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;
a27e065f1a1f91c7fbdf7c2ea1c387441af0cbb3Timo Sirainen size_t mailbox_name_max_length;
a27e065f1a1f91c7fbdf7c2ea1c387441af0cbb3Timo Sirainen
a27e065f1a1f91c7fbdf7c2ea1c387441af0cbb3Timo Sirainen struct mailbox_list_vfuncs v;
a27e065f1a1f91c7fbdf7c2ea1c387441af0cbb3Timo Sirainen
a27e065f1a1f91c7fbdf7c2ea1c387441af0cbb3Timo Sirainen/* private: */
a27e065f1a1f91c7fbdf7c2ea1c387441af0cbb3Timo Sirainen pool_t pool;
c58906589cafc32df4c04ffbef933baadd3f2276Timo Sirainen struct mail_namespace *ns;
a27e065f1a1f91c7fbdf7c2ea1c387441af0cbb3Timo Sirainen struct mailbox_list_settings 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 */
d02d34e138e32b4266f5a403d6c51d7803bf322fTimo Sirainen mode_t file_create_mode;
d02d34e138e32b4266f5a403d6c51d7803bf322fTimo Sirainen gid_t file_create_gid;
5694eeb99b69dea8033ca77ad69743c6b4871370Timo 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 *);
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
a27e065f1a1f91c7fbdf7c2ea1c387441af0cbb3Timo Sirainenextern void (*hook_mailbox_list_created)(struct mailbox_list *list);
a27e065f1a1f91c7fbdf7c2ea1c387441af0cbb3Timo Sirainen
8a0ad174adb1eb5108511b90e97f4e5f9089b0eeTimo Sirainenvoid mailbox_lists_init(void);
8a0ad174adb1eb5108511b90e97f4e5f9089b0eeTimo Sirainenvoid mailbox_lists_deinit(void);
8a0ad174adb1eb5108511b90e97f4e5f9089b0eeTimo Sirainen
adb6413686e52e00dded4932babcc08ff041876bTimo Sirainenint mailbox_list_settings_parse(const char *data,
adb6413686e52e00dded4932babcc08ff041876bTimo Sirainen struct mailbox_list_settings *set,
96f2533c48ce5def0004931606a2fdf275578880Timo Sirainen struct mail_namespace *ns,
4645cc6c911a95991d7af43b40f88e99506ea5e9Timo Sirainen const char **layout, const char **alt_dir_r,
4645cc6c911a95991d7af43b40f88e99506ea5e9Timo Sirainen const char **error_r);
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);
a27e065f1a1f91c7fbdf7c2ea1c387441af0cbb3Timo 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