mail-user.h revision 287b5ba23f182fd98e7a6ba3a63669c1572f2ca4
e59faf65ce864fe95dc00f5d52b8323cdbd0608aTimo Sirainen#ifndef MAIL_USER_H
25757faf029c369a8318349dafe952e2358df1d8Timo Sirainen#define MAIL_USER_H
08d6658a4e2ec8104cd1307f6baa75fdb07a24f8Mark Washenberger
d5abbb932a0a598f002da39a8b3326643b1b5efcTimo Sirainen#include "unichar.h"
25757faf029c369a8318349dafe952e2358df1d8Timo Sirainen#include "mail-storage-settings.h"
25757faf029c369a8318349dafe952e2358df1d8Timo Sirainen
25757faf029c369a8318349dafe952e2358df1d8Timo Sirainenstruct module;
43d3ea2780b5f8557ede7b4c039e8f56cb8d357dTimo Sirainenstruct stats;
40eb305d9b12cf48400fe3806a8a15ad6d372952Timo Sirainenstruct fs_settings;
25757faf029c369a8318349dafe952e2358df1d8Timo Sirainenstruct ssl_iostream_settings;
25757faf029c369a8318349dafe952e2358df1d8Timo Sirainenstruct mail_user;
25757faf029c369a8318349dafe952e2358df1d8Timo Sirainen
c5383a0ed56a188a7d5efaaa4c6f8243af432d65Timo Sirainenstruct mail_user_vfuncs {
c5383a0ed56a188a7d5efaaa4c6f8243af432d65Timo Sirainen void (*deinit)(struct mail_user *user);
40eb305d9b12cf48400fe3806a8a15ad6d372952Timo Sirainen void (*stats_fill)(struct mail_user *user, struct stats *stats);
40eb305d9b12cf48400fe3806a8a15ad6d372952Timo Sirainen};
40eb305d9b12cf48400fe3806a8a15ad6d372952Timo Sirainen
40eb305d9b12cf48400fe3806a8a15ad6d372952Timo Sirainenstruct mail_user {
40eb305d9b12cf48400fe3806a8a15ad6d372952Timo Sirainen pool_t pool;
43d3ea2780b5f8557ede7b4c039e8f56cb8d357dTimo Sirainen struct mail_user_vfuncs v, *vlast;
43d3ea2780b5f8557ede7b4c039e8f56cb8d357dTimo Sirainen int refcount;
43d3ea2780b5f8557ede7b4c039e8f56cb8d357dTimo Sirainen
43d3ea2780b5f8557ede7b4c039e8f56cb8d357dTimo Sirainen /* User's creator if such exists. For example for autocreated shared
43d3ea2780b5f8557ede7b4c039e8f56cb8d357dTimo Sirainen mailbox users their creator is the logged in user. */
43d3ea2780b5f8557ede7b4c039e8f56cb8d357dTimo Sirainen struct mail_user *creator;
43d3ea2780b5f8557ede7b4c039e8f56cb8d357dTimo Sirainen /* Set if user was created via mail_storage_service. */
43d3ea2780b5f8557ede7b4c039e8f56cb8d357dTimo Sirainen struct mail_storage_service_user *_service_user;
3b94ff5951db4d4eddb7a80ed4e3f61207202635Timo Sirainen
66d2db642fe24d555d113ba463e446b038d476efTimo Sirainen const char *username;
25757faf029c369a8318349dafe952e2358df1d8Timo Sirainen /* don't access the home directly. It may be set lazily. */
40eb305d9b12cf48400fe3806a8a15ad6d372952Timo Sirainen const char *_home;
40eb305d9b12cf48400fe3806a8a15ad6d372952Timo Sirainen
40eb305d9b12cf48400fe3806a8a15ad6d372952Timo Sirainen uid_t uid;
25757faf029c369a8318349dafe952e2358df1d8Timo Sirainen gid_t gid;
25757faf029c369a8318349dafe952e2358df1d8Timo Sirainen const char *service;
00bde9ae9eab9e720462bf6ec9a4dd85e88c3bbfTimo Sirainen const char *session_id;
00bde9ae9eab9e720462bf6ec9a4dd85e88c3bbfTimo Sirainen struct ip_addr *local_ip, *remote_ip;
3b94ff5951db4d4eddb7a80ed4e3f61207202635Timo Sirainen const char *auth_token, *auth_user;
25757faf029c369a8318349dafe952e2358df1d8Timo Sirainen const char *const *userdb_fields;
49e513d090753ccbf95560b2f3a21f081a5b6c51Timo Sirainen
6fabfb7bbfd88d0c1de66981e52850f26067623bTimo Sirainen const struct var_expand_table *var_expand_table;
22535a9e685e29214082878e37a267157044618eTimo Sirainen /* If non-NULL, fail the user initialization with this error.
25757faf029c369a8318349dafe952e2358df1d8Timo Sirainen This could be set by plugins that need to fail the initialization. */
25757faf029c369a8318349dafe952e2358df1d8Timo Sirainen const char *error;
6fabfb7bbfd88d0c1de66981e52850f26067623bTimo Sirainen
137ea7ca34005345aa2304a940149b7f3774d727Timo Sirainen const struct setting_parser_info *set_info;
6fabfb7bbfd88d0c1de66981e52850f26067623bTimo Sirainen const struct mail_user_settings *unexpanded_set;
40eb305d9b12cf48400fe3806a8a15ad6d372952Timo Sirainen struct mail_user_settings *set;
40eb305d9b12cf48400fe3806a8a15ad6d372952Timo Sirainen struct mail_namespace *namespaces;
312d3129573fc63ba0d39105b68daccfab9f0c8fTimo Sirainen struct mail_storage *storages;
312d3129573fc63ba0d39105b68daccfab9f0c8fTimo Sirainen ARRAY(const struct mail_storage_hooks *) hooks;
312d3129573fc63ba0d39105b68daccfab9f0c8fTimo Sirainen
40eb305d9b12cf48400fe3806a8a15ad6d372952Timo Sirainen normalizer_func_t *default_normalizer;
312d3129573fc63ba0d39105b68daccfab9f0c8fTimo Sirainen /* Filled lazily by mailbox_attribute_*() when accessing attributes. */
312d3129573fc63ba0d39105b68daccfab9f0c8fTimo Sirainen struct dict *_attr_dict;
40eb305d9b12cf48400fe3806a8a15ad6d372952Timo Sirainen
40eb305d9b12cf48400fe3806a8a15ad6d372952Timo Sirainen /* Module-specific contexts. See mail_storage_module_id. */
40eb305d9b12cf48400fe3806a8a15ad6d372952Timo Sirainen ARRAY(union mail_user_module_context *) module_contexts;
40eb305d9b12cf48400fe3806a8a15ad6d372952Timo Sirainen
40eb305d9b12cf48400fe3806a8a15ad6d372952Timo Sirainen /* User doesn't exist (as reported by userdb lookup when looking
40eb305d9b12cf48400fe3806a8a15ad6d372952Timo Sirainen up home) */
40eb305d9b12cf48400fe3806a8a15ad6d372952Timo Sirainen bool nonexistent:1;
40eb305d9b12cf48400fe3806a8a15ad6d372952Timo Sirainen /* Either home is set or there is no home for the user. */
40eb305d9b12cf48400fe3806a8a15ad6d372952Timo Sirainen bool home_looked_up:1;
40eb305d9b12cf48400fe3806a8a15ad6d372952Timo Sirainen /* User is anonymous */
40eb305d9b12cf48400fe3806a8a15ad6d372952Timo Sirainen bool anonymous:1;
6fabfb7bbfd88d0c1de66981e52850f26067623bTimo Sirainen /* This is an autocreated user (e.g. for shared namespace or
6fabfb7bbfd88d0c1de66981e52850f26067623bTimo Sirainen lda raw storage) */
25757faf029c369a8318349dafe952e2358df1d8Timo Sirainen bool autocreated:1;
25757faf029c369a8318349dafe952e2358df1d8Timo Sirainen /* mail_user_init() has been called */
43d3ea2780b5f8557ede7b4c039e8f56cb8d357dTimo Sirainen bool initialized:1;
849969f639a00eab26791db3cb1b66430420c0cdTimo Sirainen /* SET_STR_VARS in user's all settings have been expanded.
43d3ea2780b5f8557ede7b4c039e8f56cb8d357dTimo Sirainen This happens near the beginning of the user initialization,
43d3ea2780b5f8557ede7b4c039e8f56cb8d357dTimo Sirainen so this is rarely needed to be checked. */
43d3ea2780b5f8557ede7b4c039e8f56cb8d357dTimo Sirainen bool settings_expanded:1;
43d3ea2780b5f8557ede7b4c039e8f56cb8d357dTimo Sirainen /* Shortcut to mail_storage_settings.mail_debug */
43d3ea2780b5f8557ede7b4c039e8f56cb8d357dTimo Sirainen bool mail_debug:1;
849969f639a00eab26791db3cb1b66430420c0cdTimo Sirainen /* If INBOX can't be opened, log an error, but only once. */
43d3ea2780b5f8557ede7b4c039e8f56cb8d357dTimo Sirainen bool inbox_open_error_logged:1;
43d3ea2780b5f8557ede7b4c039e8f56cb8d357dTimo Sirainen /* Fuzzy search works for this user (FTS enabled) */
43d3ea2780b5f8557ede7b4c039e8f56cb8d357dTimo Sirainen bool fuzzy_search:1;
43d3ea2780b5f8557ede7b4c039e8f56cb8d357dTimo Sirainen /* We're running dsync */
43d3ea2780b5f8557ede7b4c039e8f56cb8d357dTimo Sirainen bool dsyncing:1;
43d3ea2780b5f8557ede7b4c039e8f56cb8d357dTimo Sirainen /* Failed to create attribute dict, don't try again */
43d3ea2780b5f8557ede7b4c039e8f56cb8d357dTimo Sirainen bool attr_dict_failed:1;
43d3ea2780b5f8557ede7b4c039e8f56cb8d357dTimo Sirainen /* We're deinitializing the user */
43d3ea2780b5f8557ede7b4c039e8f56cb8d357dTimo Sirainen bool deinitializing:1;
43d3ea2780b5f8557ede7b4c039e8f56cb8d357dTimo Sirainen /* Enable administrator user commands for the user */
43d3ea2780b5f8557ede7b4c039e8f56cb8d357dTimo Sirainen bool admin:1;
43d3ea2780b5f8557ede7b4c039e8f56cb8d357dTimo Sirainen /* Enable all statistics gathering */
43d3ea2780b5f8557ede7b4c039e8f56cb8d357dTimo Sirainen bool stats_enabled:1;
43d3ea2780b5f8557ede7b4c039e8f56cb8d357dTimo Sirainen /* Enable autoexpunging at deinit. */
43d3ea2780b5f8557ede7b4c039e8f56cb8d357dTimo Sirainen bool autoexpunge_enabled:1;
43d3ea2780b5f8557ede7b4c039e8f56cb8d357dTimo Sirainen};
43d3ea2780b5f8557ede7b4c039e8f56cb8d357dTimo Sirainen
43d3ea2780b5f8557ede7b4c039e8f56cb8d357dTimo Sirainenstruct mail_user_module_register {
43d3ea2780b5f8557ede7b4c039e8f56cb8d357dTimo Sirainen unsigned int id;
43d3ea2780b5f8557ede7b4c039e8f56cb8d357dTimo Sirainen};
43d3ea2780b5f8557ede7b4c039e8f56cb8d357dTimo Sirainen
43d3ea2780b5f8557ede7b4c039e8f56cb8d357dTimo Sirainenunion mail_user_module_context {
43d3ea2780b5f8557ede7b4c039e8f56cb8d357dTimo Sirainen struct mail_user_vfuncs super;
43d3ea2780b5f8557ede7b4c039e8f56cb8d357dTimo Sirainen struct mail_user_module_register *reg;
43d3ea2780b5f8557ede7b4c039e8f56cb8d357dTimo Sirainen};
43d3ea2780b5f8557ede7b4c039e8f56cb8d357dTimo Sirainenextern struct mail_user_module_register mail_user_module_register;
43d3ea2780b5f8557ede7b4c039e8f56cb8d357dTimo Sirainenextern struct auth_master_connection *mail_user_auth_master_conn;
43d3ea2780b5f8557ede7b4c039e8f56cb8d357dTimo Sirainenextern const struct var_expand_func_table *mail_user_var_expand_func_table;
43d3ea2780b5f8557ede7b4c039e8f56cb8d357dTimo Sirainen
43d3ea2780b5f8557ede7b4c039e8f56cb8d357dTimo Sirainenstruct mail_user *mail_user_alloc(const char *username,
43d3ea2780b5f8557ede7b4c039e8f56cb8d357dTimo Sirainen const struct setting_parser_info *set_info,
43d3ea2780b5f8557ede7b4c039e8f56cb8d357dTimo Sirainen const struct mail_user_settings *set);
43d3ea2780b5f8557ede7b4c039e8f56cb8d357dTimo Sirainen/* Returns -1 if settings were invalid. */
43d3ea2780b5f8557ede7b4c039e8f56cb8d357dTimo Sirainenint mail_user_init(struct mail_user *user, const char **error_r);
43d3ea2780b5f8557ede7b4c039e8f56cb8d357dTimo Sirainen
43d3ea2780b5f8557ede7b4c039e8f56cb8d357dTimo Sirainenvoid mail_user_ref(struct mail_user *user);
43d3ea2780b5f8557ede7b4c039e8f56cb8d357dTimo Sirainenvoid mail_user_unref(struct mail_user **user);
43d3ea2780b5f8557ede7b4c039e8f56cb8d357dTimo Sirainen
43d3ea2780b5f8557ede7b4c039e8f56cb8d357dTimo Sirainen/* Duplicate a mail_user. mail_user_init() and mail_namespaces_init() need to
43d3ea2780b5f8557ede7b4c039e8f56cb8d357dTimo Sirainen be called before the user is usable. */
43d3ea2780b5f8557ede7b4c039e8f56cb8d357dTimo Sirainenstruct mail_user *mail_user_dup(struct mail_user *user);
43d3ea2780b5f8557ede7b4c039e8f56cb8d357dTimo Sirainen
43d3ea2780b5f8557ede7b4c039e8f56cb8d357dTimo Sirainen/* Find another user from the given user's namespaces. */
43d3ea2780b5f8557ede7b4c039e8f56cb8d357dTimo Sirainenstruct mail_user *mail_user_find(struct mail_user *user, const char *name);
43d3ea2780b5f8557ede7b4c039e8f56cb8d357dTimo Sirainen
43d3ea2780b5f8557ede7b4c039e8f56cb8d357dTimo Sirainen/* Specify mail location %variable expansion data. */
43d3ea2780b5f8557ede7b4c039e8f56cb8d357dTimo Sirainenvoid mail_user_set_vars(struct mail_user *user, const char *service,
43d3ea2780b5f8557ede7b4c039e8f56cb8d357dTimo Sirainen const struct ip_addr *local_ip,
43d3ea2780b5f8557ede7b4c039e8f56cb8d357dTimo Sirainen const struct ip_addr *remote_ip);
43d3ea2780b5f8557ede7b4c039e8f56cb8d357dTimo Sirainen/* Return %variable expansion table for the user. */
43d3ea2780b5f8557ede7b4c039e8f56cb8d357dTimo Sirainenconst struct var_expand_table *
43d3ea2780b5f8557ede7b4c039e8f56cb8d357dTimo Sirainenmail_user_var_expand_table(struct mail_user *user);
43d3ea2780b5f8557ede7b4c039e8f56cb8d357dTimo Sirainen
43d3ea2780b5f8557ede7b4c039e8f56cb8d357dTimo Sirainen/* Specify the user's home directory. This should be called also when it's
43d3ea2780b5f8557ede7b4c039e8f56cb8d357dTimo Sirainen known that the user doesn't have a home directory to avoid the internal
43d3ea2780b5f8557ede7b4c039e8f56cb8d357dTimo Sirainen lookup. */
43d3ea2780b5f8557ede7b4c039e8f56cb8d357dTimo Sirainenvoid mail_user_set_home(struct mail_user *user, const char *home);
43d3ea2780b5f8557ede7b4c039e8f56cb8d357dTimo Sirainen/* Get the home directory for the user. Returns 1 if home directory looked up
40eb305d9b12cf48400fe3806a8a15ad6d372952Timo Sirainen successfully, 0 if there is no home directory (either user doesn't exist or
849969f639a00eab26791db3cb1b66430420c0cdTimo Sirainen has no home directory) or -1 if lookup failed. */
c5383a0ed56a188a7d5efaaa4c6f8243af432d65Timo Sirainenint mail_user_get_home(struct mail_user *user, const char **home_r);
40eb305d9b12cf48400fe3806a8a15ad6d372952Timo Sirainen/* Appends path + file prefix for creating a temporary file.
40eb305d9b12cf48400fe3806a8a15ad6d372952Timo Sirainen The file prefix doesn't contain any uniqueness. */
40eb305d9b12cf48400fe3806a8a15ad6d372952Timo Sirainenvoid mail_user_set_get_temp_prefix(string_t *dest,
849969f639a00eab26791db3cb1b66430420c0cdTimo Sirainen const struct mail_user_settings *set);
40eb305d9b12cf48400fe3806a8a15ad6d372952Timo Sirainen
849969f639a00eab26791db3cb1b66430420c0cdTimo Sirainen/* Returns TRUE if plugin is loaded for the user. */
40eb305d9b12cf48400fe3806a8a15ad6d372952Timo Sirainenbool mail_user_is_plugin_loaded(struct mail_user *user, struct module *module);
40eb305d9b12cf48400fe3806a8a15ad6d372952Timo Sirainen/* If name exists in plugin_envs, return its value. */
40eb305d9b12cf48400fe3806a8a15ad6d372952Timo Sirainenconst char *mail_user_plugin_getenv(struct mail_user *user, const char *name);
40eb305d9b12cf48400fe3806a8a15ad6d372952Timo Sirainenbool mail_user_plugin_getenv_bool(struct mail_user *user, const char *name);
40eb305d9b12cf48400fe3806a8a15ad6d372952Timo Sirainenconst char *mail_user_set_plugin_getenv(const struct mail_user_settings *set,
40eb305d9b12cf48400fe3806a8a15ad6d372952Timo Sirainen const char *name);
40eb305d9b12cf48400fe3806a8a15ad6d372952Timo Sirainenbool mail_user_set_plugin_getenv_bool(const struct mail_user_settings *set,
c5383a0ed56a188a7d5efaaa4c6f8243af432d65Timo Sirainen const char *name);
c5383a0ed56a188a7d5efaaa4c6f8243af432d65Timo Sirainen
b42f37ae6f65ed986315b6885568d32115e589b1Timo Sirainen/* Add more namespaces to user's namespaces. The ->next pointers may be
1f1e81aab38d833d1c9cdc244c91fd762e0080d4Timo Sirainen changed, so the namespaces pointer will be updated to user->namespaces. */
1f1e81aab38d833d1c9cdc244c91fd762e0080d4Timo Sirainenvoid mail_user_add_namespace(struct mail_user *user,
40eb305d9b12cf48400fe3806a8a15ad6d372952Timo Sirainen struct mail_namespace **namespaces);
c5383a0ed56a188a7d5efaaa4c6f8243af432d65Timo Sirainen/* Drop autocreated shared namespaces that don't have any "usable" mailboxes. */
c5383a0ed56a188a7d5efaaa4c6f8243af432d65Timo Sirainenvoid mail_user_drop_useless_namespaces(struct mail_user *user);
c5383a0ed56a188a7d5efaaa4c6f8243af432d65Timo Sirainen
43d3ea2780b5f8557ede7b4c039e8f56cb8d357dTimo Sirainen/* Replace ~/ at the beginning of the path with the user's home directory. */
43d3ea2780b5f8557ede7b4c039e8f56cb8d357dTimo Sirainenconst char *mail_user_home_expand(struct mail_user *user, const char *path);
43d3ea2780b5f8557ede7b4c039e8f56cb8d357dTimo Sirainen/* Returns 0 if ok, -1 if home directory isn't set. */
43d3ea2780b5f8557ede7b4c039e8f56cb8d357dTimo Sirainenint mail_user_try_home_expand(struct mail_user *user, const char **path);
43d3ea2780b5f8557ede7b4c039e8f56cb8d357dTimo Sirainen/* Returns unique user+ip identifier for anvil. */
25757faf029c369a8318349dafe952e2358df1d8Timo Sirainenconst char *mail_user_get_anvil_userip_ident(struct mail_user *user);
d5abbb932a0a598f002da39a8b3326643b1b5efcTimo Sirainen
d5abbb932a0a598f002da39a8b3326643b1b5efcTimo Sirainen/* Basically the same as mail_storage_find_class(), except automatically load
7bafda1813454621e03615e83d55bccfa7cc56bdTimo Sirainen storage plugins when needed. */
d5abbb932a0a598f002da39a8b3326643b1b5efcTimo Sirainenstruct mail_storage *
25757faf029c369a8318349dafe952e2358df1d8Timo Sirainenmail_user_get_storage_class(struct mail_user *user, const char *name);
/* Initialize fs_settings from mail_user settings. */
void mail_user_init_fs_settings(struct mail_user *user,
struct fs_settings *fs_set,
struct ssl_iostream_settings *ssl_set);
/* Fill statistics for user. By default there are no statistics, so stats
plugin must be loaded to have anything filled. */
void mail_user_stats_fill(struct mail_user *user, struct stats *stats);
#endif