Mercurial > dovecot > original-hg > dovecot-1.2
view src/lib-storage/mail-storage.c @ 4891:6ab2712f1a93 HEAD
Only imap binary was actually working.
author | Timo Sirainen <tss@iki.fi> |
---|---|
date | Sun, 10 Dec 2006 14:35:02 +0200 |
parents | f1d77064884c |
children | 5b4c9b20eba0 |
line wrap: on
line source
/* Copyright (C) 2002-2006 Timo Sirainen */ #include "lib.h" #include "ioloop.h" #include "array.h" #include "var-expand.h" #include "mail-index-private.h" #include "mail-storage-private.h" #include <stdlib.h> #include <time.h> #include <ctype.h> /* Message to show to users when critical error occurs */ #define CRITICAL_MSG \ "Internal error occurred. Refer to server log for more information." #define CRITICAL_MSG_STAMP CRITICAL_MSG " [%Y-%m-%d %H:%M:%S]" unsigned int mail_storage_module_id = 0; unsigned int mail_storage_mail_index_module_id = 0; void (*hook_mail_storage_created)(struct mail_storage *storage); void (*hook_mailbox_opened)(struct mailbox *box) = NULL; static ARRAY_DEFINE(storages, struct mail_storage *); void mail_storage_init(void) { i_array_init(&storages, 8); mail_storage_mail_index_module_id = mail_index_module_id++; } void mail_storage_deinit(void) { if (array_is_created(&storages)) array_free(&storages); } void mail_storage_class_register(struct mail_storage *storage_class) { if (storage_class->v.class_init != NULL) storage_class->v.class_init(); /* append it after the list, so the autodetection order is correct */ array_append(&storages, &storage_class, 1); } void mail_storage_class_unregister(struct mail_storage *storage_class) { struct mail_storage *const *classes; unsigned int i, count; classes = array_get(&storages, &count); for (i = 0; i < count; i++) { if (classes[i] == storage_class) { array_delete(&storages, i, 1); break; } } storage_class->v.class_deinit(); } void mail_storage_parse_env(enum mail_storage_flags *flags_r, enum file_lock_method *lock_method_r) { const char *str; *flags_r = 0; if (getenv("FULL_FILESYSTEM_ACCESS") != NULL) *flags_r |= MAIL_STORAGE_FLAG_FULL_FS_ACCESS; if (getenv("DEBUG") != NULL) *flags_r |= MAIL_STORAGE_FLAG_DEBUG; if (getenv("MMAP_DISABLE") != NULL) *flags_r |= MAIL_STORAGE_FLAG_MMAP_DISABLE; if (getenv("MMAP_NO_WRITE") != NULL) *flags_r |= MAIL_STORAGE_FLAG_MMAP_NO_WRITE; if (getenv("MAIL_READ_MMAPED") != NULL) *flags_r |= MAIL_STORAGE_FLAG_MMAP_MAILS; if (getenv("MAIL_SAVE_CRLF") != NULL) *flags_r |= MAIL_STORAGE_FLAG_SAVE_CRLF; str = getenv("POP3_UIDL_FORMAT"); if (str != NULL && (str = strchr(str, '%')) != NULL && str != NULL && var_get_key(str + 1) == 'm') *flags_r |= MAIL_STORAGE_FLAG_KEEP_HEADER_MD5; str = getenv("LOCK_METHOD"); if (str == NULL || strcmp(str, "fcntl") == 0) *lock_method_r = FILE_LOCK_METHOD_FCNTL; else if (strcmp(str, "flock") == 0) *lock_method_r = FILE_LOCK_METHOD_FLOCK; else if (strcmp(str, "dotlock") == 0) *lock_method_r = FILE_LOCK_METHOD_DOTLOCK; else i_fatal("Unknown lock_method: %s", str); } static struct mail_storage *mail_storage_find(const char *name) { struct mail_storage *const *classes; unsigned int i, count; i_assert(name != NULL); classes = array_get(&storages, &count); for (i = 0; i < count; i++) { if (strcasecmp(classes[i]->name, name) == 0) return classes[i]; } return NULL; } struct mail_storage * mail_storage_create(const char *driver, const char *data, const char *user, enum mail_storage_flags flags, enum file_lock_method lock_method) { struct mail_storage *storage; storage = mail_storage_find(driver); if (storage == NULL) return NULL; storage = storage->v.create(data, user, flags, lock_method); if (hook_mail_storage_created != NULL && storage != NULL) hook_mail_storage_created(storage); return storage; } static struct mail_storage * mail_storage_create_default(const char *user, enum mail_storage_flags flags, enum file_lock_method lock_method) { struct mail_storage *const *classes; struct mail_storage *storage; unsigned int i, count; classes = array_get(&storages, &count); for (i = 0; i < count; i++) { storage = classes[i]->v.create(NULL, user, flags, lock_method); if (storage != NULL) { if (hook_mail_storage_created != NULL) hook_mail_storage_created(storage); return storage; } } return NULL; } static struct mail_storage * mail_storage_autodetect(const char *data, enum mail_storage_flags flags) { struct mail_storage *const *classes; unsigned int i, count; classes = array_get(&storages, &count); for (i = 0; i < count; i++) { if (classes[i]->v.autodetect(data, flags)) return classes[i]; } return NULL; } struct mail_storage * mail_storage_create_with_data(const char *data, const char *user, enum mail_storage_flags flags, enum file_lock_method lock_method) { struct mail_storage *storage; const char *p, *name; if (data == NULL || *data == '\0') return mail_storage_create_default(user, flags, lock_method); /* check if we're in the form of mailformat:data (eg. maildir:Maildir) */ p = data; while (i_isalnum(*p)) p++; if (*p == ':') { /* no autodetection if the storage format is given. */ flags |= MAIL_STORAGE_FLAG_NO_AUTODETECTION; name = t_strdup_until(data, p); return mail_storage_create(name, p+1, user, flags, lock_method); } storage = mail_storage_autodetect(data, flags); if (storage == NULL) { i_error("Ambiguous mail location setting, " "don't know what to do with it: %s " "(try prefixing it with mbox: or maildir:)", data); } else { storage = storage->v.create(data, user, flags, lock_method); } if (hook_mail_storage_created != NULL && storage != NULL) hook_mail_storage_created(storage); return storage; } void mail_storage_destroy(struct mail_storage **_storage) { struct mail_storage *storage = *_storage; i_assert(storage != NULL); *_storage = NULL; storage->v.destroy(storage); } void mail_storage_clear_error(struct mail_storage *storage) { i_free(storage->error); storage->error = NULL; storage->syntax_error = FALSE; storage->temporary_error = FALSE; } void mail_storage_set_error(struct mail_storage *storage, const char *fmt, ...) { va_list va; mail_storage_clear_error(storage); if (fmt != NULL) { va_start(va, fmt); storage->error = i_strdup_vprintf(fmt, va); va_end(va); } } void mail_storage_set_syntax_error(struct mail_storage *storage, const char *fmt, ...) { va_list va; mail_storage_clear_error(storage); if (fmt != NULL) { va_start(va, fmt); storage->error = i_strdup_vprintf(fmt, va); storage->syntax_error = TRUE; va_end(va); } } void mail_storage_set_internal_error(struct mail_storage *storage) { struct tm *tm; char str[256]; tm = localtime(&ioloop_time); i_free(storage->error); storage->error = strftime(str, sizeof(str), CRITICAL_MSG_STAMP, tm) > 0 ? i_strdup(str) : i_strdup(CRITICAL_MSG); storage->syntax_error = FALSE; storage->temporary_error = TRUE; } void mail_storage_set_list_error(struct mail_storage *storage) { bool temp; i_free(storage->error); storage->error = i_strdup(mailbox_list_get_last_error(storage->list, &temp)); storage->syntax_error = FALSE; storage->temporary_error = temp; } void mail_storage_set_critical(struct mail_storage *storage, const char *fmt, ...) { va_list va; mail_storage_clear_error(storage); if (fmt != NULL) { va_start(va, fmt); i_error("%s", t_strdup_vprintf(fmt, va)); va_end(va); /* critical errors may contain sensitive data, so let user see only "Internal error" with a timestamp to make it easier to look from log files the actual error message. */ mail_storage_set_internal_error(storage); } } char mail_storage_get_hierarchy_sep(struct mail_storage *storage) { return mailbox_list_get_hierarchy_sep(storage->list); } struct mailbox_list *mail_storage_get_list(struct mail_storage *storage) { return storage->list; } void mail_storage_set_callbacks(struct mail_storage *storage, struct mail_storage_callbacks *callbacks, void *context) { storage->v.set_callbacks(storage, callbacks, context); } int mail_storage_mailbox_create(struct mail_storage *storage, const char *name, bool directory) { return storage->v.mailbox_create(storage, name, directory); } int mail_storage_mailbox_delete(struct mail_storage *storage, const char *name) { return storage->v.mailbox_delete(storage, name); } int mail_storage_mailbox_rename(struct mail_storage *storage, const char *oldname, const char *newname) { return storage->v.mailbox_rename(storage, oldname, newname); } const char *mail_storage_get_last_error(struct mail_storage *storage, bool *syntax_error_r, bool *temporary_error_r) { return storage->v.get_last_error(storage, syntax_error_r, temporary_error_r); } const char *mail_storage_get_mailbox_path(struct mail_storage *storage, const char *name, bool *is_file_r) { *is_file_r = storage->mailbox_is_file; if (*name == '\0') name = NULL; return mailbox_list_get_path(storage->list, name, MAILBOX_LIST_PATH_TYPE_MAILBOX); } const char *mail_storage_get_mailbox_control_dir(struct mail_storage *storage, const char *name) { if (*name == '\0') name = NULL; return mailbox_list_get_path(storage->list, name, MAILBOX_LIST_PATH_TYPE_CONTROL); } const char *mail_storage_get_mailbox_index_dir(struct mail_storage *storage, const char *name) { if (*name == '\0') name = NULL; return mailbox_list_get_path(storage->list, name, MAILBOX_LIST_PATH_TYPE_INDEX); } enum mailbox_list_flags mail_storage_get_list_flags(enum mail_storage_flags storage_flags) { enum mailbox_list_flags list_flags = 0; if ((storage_flags & MAIL_STORAGE_FLAG_DEBUG) != 0) list_flags |= MAILBOX_LIST_FLAG_DEBUG; if ((storage_flags & MAIL_STORAGE_FLAG_HAS_INBOX) != 0) list_flags |= MAILBOX_LIST_FLAG_INBOX; if ((storage_flags & MAIL_STORAGE_FLAG_FULL_FS_ACCESS) != 0) list_flags |= MAILBOX_LIST_FLAG_FULL_FS_ACCESS; return list_flags; } int mailbox_storage_list_is_mailbox(const char *dir, const char *fname, enum mailbox_list_file_type type, enum mailbox_list_iter_flags iter_flags, enum mailbox_info_flags *flags, void *context) { struct mail_storage *storage = context; return mail_storage_is_mailbox(storage, dir, fname, iter_flags, flags, type); } int mail_storage_is_mailbox(struct mail_storage *storage, const char *dir, const char *fname, enum mailbox_list_iter_flags iter_flags, enum mailbox_info_flags *flags, enum mailbox_list_file_type type) { return storage->v.is_mailbox(storage, dir, fname, iter_flags, flags, type); } struct mailbox *mailbox_open(struct mail_storage *storage, const char *name, struct istream *input, enum mailbox_open_flags flags) { struct mailbox *box; box = storage->v.mailbox_open(storage, name, input, flags); if (hook_mailbox_opened != NULL && box != NULL) hook_mailbox_opened(box); return box; } int mailbox_close(struct mailbox **_box) { struct mailbox *box = *_box; *_box = NULL; return box->v.close(box); } struct mail_storage *mailbox_get_storage(struct mailbox *box) { return box->storage; } const char *mailbox_get_name(struct mailbox *box) { return box->name; } bool mailbox_is_readonly(struct mailbox *box) { return box->v.is_readonly(box); } bool mailbox_allow_new_keywords(struct mailbox *box) { return box->v.allow_new_keywords(box); } int mailbox_get_status(struct mailbox *box, enum mailbox_status_items items, struct mailbox_status *status) { return box->v.get_status(box, items, status); } struct mailbox_sync_context * mailbox_sync_init(struct mailbox *box, enum mailbox_sync_flags flags) { return box->v.sync_init(box, flags); } int mailbox_sync_next(struct mailbox_sync_context *ctx, struct mailbox_sync_rec *sync_rec_r) { return ctx->box->v.sync_next(ctx, sync_rec_r); } int mailbox_sync_deinit(struct mailbox_sync_context **_ctx, enum mailbox_status_items status_items, struct mailbox_status *status_r) { struct mailbox_sync_context *ctx = *_ctx; *_ctx = NULL; return ctx->box->v.sync_deinit(ctx, status_items, status_r); } void mailbox_notify_changes(struct mailbox *box, unsigned int min_interval, mailbox_notify_callback_t *callback, void *context) { box->v.notify_changes(box, min_interval, callback, context); } struct mail_keywords * mailbox_keywords_create(struct mailbox_transaction_context *t, const char *const keywords[]) { return t->box->v.keywords_create(t, keywords); } void mailbox_keywords_free(struct mailbox_transaction_context *t, struct mail_keywords **_keywords) { struct mail_keywords *keywords = *_keywords; *_keywords = NULL; t->box->v.keywords_free(t, keywords); } int mailbox_get_uids(struct mailbox *box, uint32_t uid1, uint32_t uid2, uint32_t *seq1_r, uint32_t *seq2_r) { return box->v.get_uids(box, uid1, uid2, seq1_r, seq2_r); } struct mailbox_header_lookup_ctx * mailbox_header_lookup_init(struct mailbox *box, const char *const headers[]) { return box->v.header_lookup_init(box, headers); } void mailbox_header_lookup_deinit(struct mailbox_header_lookup_ctx **_ctx) { struct mailbox_header_lookup_ctx *ctx = *_ctx; *_ctx = NULL; ctx->box->v.header_lookup_deinit(ctx); } struct mail_search_context * mailbox_search_init(struct mailbox_transaction_context *t, const char *charset, struct mail_search_arg *args, const enum mail_sort_type *sort_program) { return t->box->v.search_init(t, charset, args, sort_program); } int mailbox_search_deinit(struct mail_search_context **_ctx) { struct mail_search_context *ctx = *_ctx; *_ctx = NULL; return ctx->transaction->box->v.search_deinit(ctx); } int mailbox_search_next(struct mail_search_context *ctx, struct mail *mail) { return ctx->transaction->box->v.search_next(ctx, mail); } struct mailbox_transaction_context * mailbox_transaction_begin(struct mailbox *box, enum mailbox_transaction_flags flags) { return box->v.transaction_begin(box, flags); } int mailbox_transaction_commit(struct mailbox_transaction_context **_t, enum mailbox_sync_flags flags) { struct mailbox_transaction_context *t = *_t; *_t = NULL; return t->box->v.transaction_commit(t, flags); } void mailbox_transaction_rollback(struct mailbox_transaction_context **_t) { struct mailbox_transaction_context *t = *_t; *_t = NULL; t->box->v.transaction_rollback(t); } int mailbox_save_init(struct mailbox_transaction_context *t, enum mail_flags flags, struct mail_keywords *keywords, time_t received_date, int timezone_offset, const char *from_envelope, struct istream *input, struct mail *dest_mail, struct mail_save_context **ctx_r) { if (t->box->v.save_init(t, flags, keywords, received_date, timezone_offset, from_envelope, input, dest_mail, ctx_r) < 0) return -1; (*ctx_r)->dest_mail = dest_mail; return 0; } int mailbox_save_continue(struct mail_save_context *ctx) { return ctx->transaction->box->v.save_continue(ctx); } int mailbox_save_finish(struct mail_save_context **_ctx) { struct mail_save_context *ctx = *_ctx; *_ctx = NULL; return ctx->transaction->box->v.save_finish(ctx); } void mailbox_save_cancel(struct mail_save_context **_ctx) { struct mail_save_context *ctx = *_ctx; *_ctx = NULL; ctx->transaction->box->v.save_cancel(ctx); } int mailbox_copy(struct mailbox_transaction_context *t, struct mail *mail, enum mail_flags flags, struct mail_keywords *keywords, struct mail *dest_mail) { return t->box->v.copy(t, mail, flags, keywords, dest_mail); } bool mailbox_is_inconsistent(struct mailbox *box) { return box->v.is_inconsistent(box); }