mail-user.h revision 5231ae561283595a73e9d838bdf4eb5d1b074679
#ifndef MAIL_USER_H
#define MAIL_USER_H
#include "unichar.h"
#include "mail-storage-settings.h"
struct module;
struct stats;
struct fs_settings;
struct ssl_iostream_settings;
struct mail_user;
struct mail_user_vfuncs {
};
struct mail_user {
struct mail_user_vfuncs v, *vlast;
int refcount;
/* User's creator if such exists. For example for autocreated shared
mailbox users their creator is the logged in user. */
/* Set if user was created via mail_storage_service. */
struct mail_storage_service_user *_service_user;
const char *username;
/* don't access the home directly. It may be set lazily. */
const char *_home;
const char *service;
const char *session_id;
const char *auth_token, *auth_user;
const char *const *userdb_fields;
/* Timestamp when this session was initially created. Most importantly
this stays the same after IMAP client is hibernated and restored. */
const struct var_expand_table *var_expand_table;
/* If non-NULL, fail the user initialization with this error.
This could be set by plugins that need to fail the initialization. */
const char *error;
const struct setting_parser_info *set_info;
const struct mail_user_settings *unexpanded_set;
struct mail_user_settings *set;
struct mail_namespace *namespaces;
struct mail_storage *storages;
/* Filled lazily by mailbox_attribute_*() when accessing attributes. */
struct dict *_attr_dict;
/* Module-specific contexts. See mail_storage_module_id. */
/* User doesn't exist (as reported by userdb lookup when looking
up home) */
bool nonexistent:1;
/* Either home is set or there is no home for the user. */
bool home_looked_up:1;
/* User is anonymous */
bool anonymous:1;
/* This is an autocreated user (e.g. for shared namespace or
lda raw storage) */
bool autocreated:1;
/* mail_user_init() has been called */
bool initialized:1;
/* The initial namespaces have been created and
hook_mail_namespaces_created() has been called. */
bool namespaces_created:1;
/* SET_STR_VARS in user's all settings have been expanded.
This happens near the beginning of the user initialization,
so this is rarely needed to be checked. */
bool settings_expanded:1;
/* Shortcut to mail_storage_settings.mail_debug */
bool mail_debug:1;
/* If INBOX can't be opened, log an error, but only once. */
bool inbox_open_error_logged:1;
/* Fuzzy search works for this user (FTS enabled) */
bool fuzzy_search:1;
/* We're running dsync */
bool dsyncing:1;
/* Failed to create attribute dict, don't try again */
bool attr_dict_failed:1;
/* We're deinitializing the user */
bool deinitializing:1;
/* Enable administrator user commands for the user */
bool admin:1;
/* Enable all statistics gathering */
bool stats_enabled:1;
/* This session was restored (e.g. IMAP unhibernation) */
bool session_restored:1;
};
struct mail_user_module_register {
unsigned int id;
};
union mail_user_module_context {
struct mail_user_vfuncs super;
struct mail_user_module_register *reg;
};
extern struct mail_user_module_register mail_user_module_register;
extern struct auth_master_connection *mail_user_auth_master_conn;
extern const struct var_expand_func_table *mail_user_var_expand_func_table;
const struct setting_parser_info *set_info,
const struct mail_user_settings *set);
struct mail_user *
mail_user_alloc_nodup_set(const char *username,
const struct setting_parser_info *set_info,
const struct mail_user_settings *set);
/* Returns -1 if settings were invalid. */
/* Duplicate a mail_user. mail_user_init() and mail_namespaces_init() need to
be called before the user is usable. */
/* Find another user from the given user's namespaces. */
/* Specify mail location %variable expansion data. */
/* Return %variable expansion table for the user. */
const struct var_expand_table *
/* Specify the user's home directory. This should be called also when it's
known that the user doesn't have a home directory to avoid the internal
lookup. */
/* Get the home directory for the user. Returns 1 if home directory looked up
successfully, 0 if there is no home directory (either user doesn't exist or
has no home directory) or -1 if lookup failed. */
/* Appends path + file prefix for creating a temporary file.
The file prefix doesn't contain any uniqueness. */
const struct mail_user_settings *set);
/* Returns TRUE if plugin is loaded for the user. */
/* If name exists in plugin_envs, return its value. */
const char *name);
const char *name);
/* Add more namespaces to user's namespaces. The ->next pointers may be
changed, so the namespaces pointer will be updated to user->namespaces. */
struct mail_namespace **namespaces);
/* Drop autocreated shared namespaces that don't have any "usable" mailboxes. */
/* Replace ~/ at the beginning of the path with the user's home directory. */
/* Returns 0 if ok, -1 if home directory isn't set. */
/* Returns unique user+ip identifier for anvil. */
/* Basically the same as mail_storage_find_class(), except automatically load
storage plugins when needed. */
struct mail_storage *
/* Initialize SSL client settings from mail_user settings. */
struct ssl_iostream_settings *ssl_set);
/* Initialize fs_settings from mail_user settings. */
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. */
#endif