mailbox-list-private.h revision 8e371a3ce32bd64288786855b8ce0cb63f19f7d1
a27e065f1a1f91c7fbdf7c2ea1c387441af0cbb3Timo Sirainen#ifndef __MAILBOX_LIST_PRIVATE_H
a27e065f1a1f91c7fbdf7c2ea1c387441af0cbb3Timo Sirainen#define __MAILBOX_LIST_PRIVATE_H
a27e065f1a1f91c7fbdf7c2ea1c387441af0cbb3Timo Sirainen
b039dabf4c53f72454e795930e7643b6e0e625f9Timo Sirainen/* Some error strings that should be used everywhere to avoid
b039dabf4c53f72454e795930e7643b6e0e625f9Timo Sirainen permissions checks from revealing mailbox's existence */
b039dabf4c53f72454e795930e7643b6e0e625f9Timo Sirainen#define MAILBOX_LIST_ERR_MAILBOX_NOT_FOUND "Mailbox doesn't exist: %s"
b039dabf4c53f72454e795930e7643b6e0e625f9Timo Sirainen#define MAILBOX_LIST_ERR_NO_PERMISSION "Permission denied"
b039dabf4c53f72454e795930e7643b6e0e625f9Timo Sirainen
a27e065f1a1f91c7fbdf7c2ea1c387441af0cbb3Timo Sirainen#include "mailbox-list.h"
a27e065f1a1f91c7fbdf7c2ea1c387441af0cbb3Timo Sirainen
a27e065f1a1f91c7fbdf7c2ea1c387441af0cbb3Timo Sirainenstruct dirent;
a27e065f1a1f91c7fbdf7c2ea1c387441af0cbb3Timo Sirainen
a27e065f1a1f91c7fbdf7c2ea1c387441af0cbb3Timo Sirainenstruct mailbox_list_vfuncs {
a27e065f1a1f91c7fbdf7c2ea1c387441af0cbb3Timo Sirainen struct mailbox_list *(*alloc)(void);
a27e065f1a1f91c7fbdf7c2ea1c387441af0cbb3Timo Sirainen void (*deinit)(struct mailbox_list *list);
a27e065f1a1f91c7fbdf7c2ea1c387441af0cbb3Timo Sirainen
a27e065f1a1f91c7fbdf7c2ea1c387441af0cbb3Timo Sirainen bool (*is_valid_mask)(struct mailbox_list *list, const char *mask);
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
a27e065f1a1f91c7fbdf7c2ea1c387441af0cbb3Timo Sirainen const char *(*get_temp_prefix)(struct mailbox_list *list);
5fb3bff645380804c9db2510940c41db6b8fdb01Timo Sirainen const char *(*join_refmask)(struct mailbox_list *list,
5fb3bff645380804c9db2510940c41db6b8fdb01Timo Sirainen const char *ref, const char *mask);
a27e065f1a1f91c7fbdf7c2ea1c387441af0cbb3Timo Sirainen
a27e065f1a1f91c7fbdf7c2ea1c387441af0cbb3Timo Sirainen struct mailbox_list_iterate_context *
5fb3bff645380804c9db2510940c41db6b8fdb01Timo Sirainen (*iter_init)(struct mailbox_list *list, const char *mask,
a27e065f1a1f91c7fbdf7c2ea1c387441af0cbb3Timo Sirainen enum mailbox_list_iter_flags flags);
a27e065f1a1f91c7fbdf7c2ea1c387441af0cbb3Timo Sirainen 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,
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);
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;
a27e065f1a1f91c7fbdf7c2ea1c387441af0cbb3Timo Sirainen struct mailbox_list_settings set;
a27e065f1a1f91c7fbdf7c2ea1c387441af0cbb3Timo Sirainen enum mailbox_list_flags flags;
a27e065f1a1f91c7fbdf7c2ea1c387441af0cbb3Timo Sirainen
a27e065f1a1f91c7fbdf7c2ea1c387441af0cbb3Timo Sirainen char *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
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
b039dabf4c53f72454e795930e7643b6e0e625f9Timo Sirainenint mailbox_list_delete_index_control(struct mailbox_list *list,
b039dabf4c53f72454e795930e7643b6e0e625f9Timo Sirainen const char *name);
b039dabf4c53f72454e795930e7643b6e0e625f9Timo 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);
a27e065f1a1f91c7fbdf7c2ea1c387441af0cbb3Timo Sirainen
a27e065f1a1f91c7fbdf7c2ea1c387441af0cbb3Timo Sirainenvoid mailbox_list_clear_error(struct mailbox_list *list);
a27e065f1a1f91c7fbdf7c2ea1c387441af0cbb3Timo Sirainenvoid mailbox_list_set_error(struct mailbox_list *list, const char *error);
a27e065f1a1f91c7fbdf7c2ea1c387441af0cbb3Timo Sirainenvoid mailbox_list_set_critical(struct mailbox_list *list, const char *fmt, ...)
a27e065f1a1f91c7fbdf7c2ea1c387441af0cbb3Timo Sirainen __attr_format__(2, 3);
5fb3bff645380804c9db2510940c41db6b8fdb01Timo Sirainenvoid mailbox_list_set_internal_error(struct mailbox_list *list);
a27e065f1a1f91c7fbdf7c2ea1c387441af0cbb3Timo Sirainen
a27e065f1a1f91c7fbdf7c2ea1c387441af0cbb3Timo Sirainen#endif