src/lib-storage/mailbox-list-private.h

	mailbox-list-private.h revision a91bd6256b33729531c33ff8bc66ee1ae95840f9
30d2f45dd260208f0fb882dde134a249318524b9Lubos Kosco#ifndef MAILBOX_LIST_PRIVATE_H
14a41f02433890d19b2f871156271e3388cd0845Jens Elkner#define MAILBOX_LIST_PRIVATE_H
14a41f02433890d19b2f871156271e3388cd0845Jens Elkner
30d2f45dd260208f0fb882dde134a249318524b9Lubos Kosco#include "mail-namespace.h"
30d2f45dd260208f0fb882dde134a249318524b9Lubos Kosco#include "mailbox-list.h"
30d2f45dd260208f0fb882dde134a249318524b9Lubos Kosco#include "mail-storage-settings.h"
30d2f45dd260208f0fb882dde134a249318524b9Lubos Kosco
30d2f45dd260208f0fb882dde134a249318524b9Lubos Kosco#define MAILBOX_LIST_NAME_MAILDIRPLUSPLUS "maildir++"
30d2f45dd260208f0fb882dde134a249318524b9Lubos Kosco#define MAILBOX_LIST_NAME_IMAPDIR "imapdir"
30d2f45dd260208f0fb882dde134a249318524b9Lubos Kosco#define MAILBOX_LIST_NAME_FS "fs"
30d2f45dd260208f0fb882dde134a249318524b9Lubos Kosco
30d2f45dd260208f0fb882dde134a249318524b9Lubos Kosco#define MAILBOX_LOG_FILE_NAME "dovecot.mailbox.log"
30d2f45dd260208f0fb882dde134a249318524b9Lubos Kosco
30d2f45dd260208f0fb882dde134a249318524b9Lubos Koscoenum mailbox_log_record_type;
30d2f45dd260208f0fb882dde134a249318524b9Lubos Koscostruct stat;
30d2f45dd260208f0fb882dde134a249318524b9Lubos Koscostruct dirent;
30d2f45dd260208f0fb882dde134a249318524b9Lubos Koscostruct imap_match_glob;
30d2f45dd260208f0fb882dde134a249318524b9Lubos Koscostruct mailbox_tree_context;
30d2f45dd260208f0fb882dde134a249318524b9Lubos Kosco
30d2f45dd260208f0fb882dde134a249318524b9Lubos Kosco#define MAILBOX_INFO_FLAGS_FINISHED(flags) \
30d2f45dd260208f0fb882dde134a249318524b9Lubos Kosco    (((flags) & (MAILBOX_SELECT | MAILBOX_NOSELECT | \
30d2f45dd260208f0fb882dde134a249318524b9Lubos Kosco             MAILBOX_NONEXISTENT)) != 0)
30d2f45dd260208f0fb882dde134a249318524b9Lubos Kosco
14a41f02433890d19b2f871156271e3388cd0845Jens Elknerenum mailbox_dir_create_type {
30d2f45dd260208f0fb882dde134a249318524b9Lubos Kosco    /* Creating a mailbox */
14a41f02433890d19b2f871156271e3388cd0845Jens Elkner    MAILBOX_DIR_CREATE_TYPE_MAILBOX,
14a41f02433890d19b2f871156271e3388cd0845Jens Elkner    /* Create a \Noselect or a mailbox */
14a41f02433890d19b2f871156271e3388cd0845Jens Elkner    MAILBOX_DIR_CREATE_TYPE_TRY_NOSELECT,
14a41f02433890d19b2f871156271e3388cd0845Jens Elkner    /* Create a \Noselect or fail */
14a41f02433890d19b2f871156271e3388cd0845Jens Elkner    MAILBOX_DIR_CREATE_TYPE_ONLY_NOSELECT
14a41f02433890d19b2f871156271e3388cd0845Jens Elkner};
14a41f02433890d19b2f871156271e3388cd0845Jens Elkner
d2b27f3d647af6fca607f14cb9296cc61c64b5b7Knut Anders Hatlenstruct mailbox_list_vfuncs {
14a41f02433890d19b2f871156271e3388cd0845Jens Elkner    struct mailbox_list *(*alloc)(void);
d2b27f3d647af6fca607f14cb9296cc61c64b5b7Knut Anders Hatlen    void (*deinit)(struct mailbox_list *list);
14a41f02433890d19b2f871156271e3388cd0845Jens Elkner
14a41f02433890d19b2f871156271e3388cd0845Jens Elkner    int (*get_storage)(struct mailbox_list **list, const char **name,
14a41f02433890d19b2f871156271e3388cd0845Jens Elkner               struct mail_storage **storage_r);
14a41f02433890d19b2f871156271e3388cd0845Jens Elkner    bool (*is_valid_pattern)(struct mailbox_list *list,
14a41f02433890d19b2f871156271e3388cd0845Jens Elkner                 const char *pattern);
14a41f02433890d19b2f871156271e3388cd0845Jens Elkner    bool (*is_valid_existing_name)(struct mailbox_list *list,
14a41f02433890d19b2f871156271e3388cd0845Jens Elkner                       const char *name);
14a41f02433890d19b2f871156271e3388cd0845Jens Elkner    bool (*is_valid_create_name)(struct mailbox_list *list,
14a41f02433890d19b2f871156271e3388cd0845Jens Elkner                     const char *name);
14a41f02433890d19b2f871156271e3388cd0845Jens Elkner
14a41f02433890d19b2f871156271e3388cd0845Jens Elkner    const char *(*get_path)(struct mailbox_list *list, const char *name,
14a41f02433890d19b2f871156271e3388cd0845Jens Elkner                enum mailbox_list_path_type type);
14a41f02433890d19b2f871156271e3388cd0845Jens Elkner    int (*get_mailbox_name_status)(struct mailbox_list *list,
14a41f02433890d19b2f871156271e3388cd0845Jens Elkner                       const char *name,
14a41f02433890d19b2f871156271e3388cd0845Jens Elkner                       enum mailbox_name_status *status);
14a41f02433890d19b2f871156271e3388cd0845Jens Elkner
14a41f02433890d19b2f871156271e3388cd0845Jens Elkner    const char *(*get_temp_prefix)(struct mailbox_list *list, bool global);
14a41f02433890d19b2f871156271e3388cd0845Jens Elkner    const char *(*join_refpattern)(struct mailbox_list *list,
14a41f02433890d19b2f871156271e3388cd0845Jens Elkner                       const char *ref, const char *pattern);
14a41f02433890d19b2f871156271e3388cd0845Jens Elkner
14a41f02433890d19b2f871156271e3388cd0845Jens Elkner    struct mailbox_list_iterate_context *
14a41f02433890d19b2f871156271e3388cd0845Jens Elkner        (*iter_init)(struct mailbox_list *list,
14a41f02433890d19b2f871156271e3388cd0845Jens Elkner                 const char *const *patterns,
14a41f02433890d19b2f871156271e3388cd0845Jens Elkner                 enum mailbox_list_iter_flags flags);
14a41f02433890d19b2f871156271e3388cd0845Jens Elkner    const struct mailbox_info *
14a41f02433890d19b2f871156271e3388cd0845Jens Elkner        (*iter_next)(struct mailbox_list_iterate_context *ctx);
14a41f02433890d19b2f871156271e3388cd0845Jens Elkner    int (*iter_deinit)(struct mailbox_list_iterate_context *ctx);
14a41f02433890d19b2f871156271e3388cd0845Jens Elkner
30d2f45dd260208f0fb882dde134a249318524b9Lubos Kosco    int (*get_mailbox_flags)(struct mailbox_list *list,
30d2f45dd260208f0fb882dde134a249318524b9Lubos Kosco                 const char *dir, const char *fname,
14a41f02433890d19b2f871156271e3388cd0845Jens Elkner                 enum mailbox_list_file_type type,
14a41f02433890d19b2f871156271e3388cd0845Jens Elkner                 struct stat *st_r,
14a41f02433890d19b2f871156271e3388cd0845Jens Elkner                 enum mailbox_info_flags *flags_r);
14a41f02433890d19b2f871156271e3388cd0845Jens Elkner    /* Returns TRUE if name is mailbox's internal file/directory.
14a41f02433890d19b2f871156271e3388cd0845Jens Elkner       If it does, mailbox deletion assumes it can safely delete it. */
9e84bb8ea80d12f1495640752b10ecbdabfe8a3aKnut Anders Hatlen    bool (*is_internal_name)(struct mailbox_list *list, const char *name);
30d2f45dd260208f0fb882dde134a249318524b9Lubos Kosco
14a41f02433890d19b2f871156271e3388cd0845Jens Elkner    int (*set_subscribed)(struct mailbox_list *list,
14a41f02433890d19b2f871156271e3388cd0845Jens Elkner                  const char *name, bool set);
14a41f02433890d19b2f871156271e3388cd0845Jens Elkner    int (*create_mailbox_dir)(struct mailbox_list *list, const char *name,
14a41f02433890d19b2f871156271e3388cd0845Jens Elkner                  enum mailbox_dir_create_type type);
    int (*delete_mailbox)(struct mailbox_list *list, const char *name);
    int (*delete_dir)(struct mailbox_list *list, const char *name);
    int (*rename_mailbox)(struct mailbox_list *oldlist, const char *oldname,
                  struct mailbox_list *newlist, const char *newname,
                  bool rename_children);
};

struct mailbox_list_module_register {
    unsigned int id;
};

union mailbox_list_module_context {
    struct mailbox_list_vfuncs super;
    struct mailbox_list_module_register *reg;
};

struct mailbox_list {
    const char *name;
    char hierarchy_sep;
    enum mailbox_list_properties props;
    size_t mailbox_name_max_length;

    struct mailbox_list_vfuncs v, *vlast;

/* private: */
    pool_t pool;
    struct mail_namespace *ns;
    struct mailbox_list_settings set;
    const struct mail_storage_settings *mail_set;
    enum mailbox_list_flags flags;

    /* -1 if not set yet. use mailbox_list_get_permissions() to set them */
    mode_t file_create_mode, dir_create_mode;
    gid_t file_create_gid;
    /* origin (e.g. path) where the file_create_gid was got from */
    const char *file_create_gid_origin;

    struct mailbox_log *changelog;
    time_t changelog_timestamp;

    char *error_string;
    enum mail_error error;
    bool temporary_error;

    ARRAY_DEFINE(module_contexts, union mailbox_list_module_context *);

    unsigned int index_root_dir_created:1;
};

struct mailbox_list_iterate_context {
    struct mailbox_list *list;
    enum mailbox_list_iter_flags flags;
    bool failed;
};

struct mailbox_list_iter_update_context {
    struct mailbox_list_iterate_context *iter_ctx;
    struct mailbox_tree_context *tree_ctx;

    struct imap_match_glob *glob;
    enum mailbox_info_flags leaf_flags, parent_flags;

    unsigned int update_only:1;
    unsigned int match_parents:1;
};

/* Modules should use do "my_id = mailbox_list_module_id++" and
   use objects' module_contexts[id] for their own purposes. */
extern struct mailbox_list_module_register mailbox_list_module_register;

void mailbox_lists_init(void);
void mailbox_lists_deinit(void);

int mailbox_list_settings_parse(struct mail_user *user, const char *data,
                struct mailbox_list_settings *set_r,
                const char **error_r);
const char *mailbox_list_get_unexpanded_path(struct mailbox_list *list,
                         enum mailbox_list_path_type type);
const char *
mailbox_list_get_root_path(const struct mailbox_list_settings *set,
               enum mailbox_list_path_type type);
int mailbox_list_mkdir(struct mailbox_list *list, const char *path,
               enum mailbox_list_path_type type);

int mailbox_list_delete_index_control(struct mailbox_list *list,
                      const char *name);

void mailbox_list_iter_update(struct mailbox_list_iter_update_context *ctx,
                  const char *name);

bool mailbox_list_name_is_too_large(const char *name, char sep);
enum mailbox_list_file_type mailbox_list_get_file_type(const struct dirent *d);
bool mailbox_list_try_get_absolute_path(struct mailbox_list *list,
                    const char **name);
int mailbox_list_create_missing_index_dir(struct mailbox_list *list,
                      const char *name);

void mailbox_list_add_change(struct mailbox_list *list,
                 enum mailbox_log_record_type type,
                 const uint8_t mailbox_guid[MAIL_GUID_128_SIZE]);
int mailbox_list_get_guid_path(struct mailbox_list *list, const char *path,
                   uint8_t mailbox_guid[MAIL_GUID_128_SIZE]);
void mailbox_name_get_sha128(const char *name,
                 uint8_t guid[MAIL_GUID_128_SIZE]);

void mailbox_list_clear_error(struct mailbox_list *list);
void mailbox_list_set_error(struct mailbox_list *list,
                enum mail_error error, const char *string);
void mailbox_list_set_critical(struct mailbox_list *list, const char *fmt, ...)
    ATTR_FORMAT(2, 3);
void mailbox_list_set_internal_error(struct mailbox_list *list);
bool mailbox_list_set_error_from_errno(struct mailbox_list *list);

#endif