imap-settings.c revision a8284e999d091cd29210fa75ecdc8076376a7345
25757faf029c369a8318349dafe952e2358df1d8Timo Sirainen/* Copyright (c) 2005-2009 Dovecot authors, see the included COPYING file */
25757faf029c369a8318349dafe952e2358df1d8Timo Sirainen
25757faf029c369a8318349dafe952e2358df1d8Timo Sirainen#include "lib.h"
25757faf029c369a8318349dafe952e2358df1d8Timo Sirainen#include "settings-parser.h"
70cb37c37e4dce8f57cd3f882f7444e76b918befTimo Sirainen#include "mail-storage-settings.h"
25757faf029c369a8318349dafe952e2358df1d8Timo Sirainen#include "imap-settings.h"
25757faf029c369a8318349dafe952e2358df1d8Timo Sirainen
25757faf029c369a8318349dafe952e2358df1d8Timo Sirainen#include <stddef.h>
25757faf029c369a8318349dafe952e2358df1d8Timo Sirainen#include <stdlib.h>
70cb37c37e4dce8f57cd3f882f7444e76b918befTimo Sirainen#include <unistd.h>
70cb37c37e4dce8f57cd3f882f7444e76b918befTimo Sirainen
70cb37c37e4dce8f57cd3f882f7444e76b918befTimo Sirainenstatic bool imap_settings_verify(void *_set, pool_t pool,
70cb37c37e4dce8f57cd3f882f7444e76b918befTimo Sirainen const char **error_r);
25757faf029c369a8318349dafe952e2358df1d8Timo Sirainen
25757faf029c369a8318349dafe952e2358df1d8Timo Sirainen#undef DEF
473080c7c0d25ddfdf77e7dfa0ba8f73c6c669d5Timo Sirainen#undef DEFLIST
473080c7c0d25ddfdf77e7dfa0ba8f73c6c669d5Timo Sirainen#define DEF(type, name) \
25757faf029c369a8318349dafe952e2358df1d8Timo Sirainen { type, #name, offsetof(struct imap_settings, name), NULL }
25757faf029c369a8318349dafe952e2358df1d8Timo Sirainen#define DEFLIST(field, name, defines) \
e82af44fe25ca9b88210f313548dc08538e4a677Timo Sirainen { SET_DEFLIST, name, offsetof(struct imap_settings, field), defines }
e82af44fe25ca9b88210f313548dc08538e4a677Timo Sirainen
25757faf029c369a8318349dafe952e2358df1d8Timo Sirainenstatic struct setting_define imap_setting_defines[] = {
473080c7c0d25ddfdf77e7dfa0ba8f73c6c669d5Timo Sirainen DEF(SET_BOOL, mail_debug),
e82af44fe25ca9b88210f313548dc08538e4a677Timo Sirainen DEF(SET_BOOL, shutdown_clients),
473080c7c0d25ddfdf77e7dfa0ba8f73c6c669d5Timo Sirainen
25757faf029c369a8318349dafe952e2358df1d8Timo Sirainen DEF(SET_UINT, imap_max_line_length),
473080c7c0d25ddfdf77e7dfa0ba8f73c6c669d5Timo Sirainen DEF(SET_UINT, imap_idle_notify_interval),
25757faf029c369a8318349dafe952e2358df1d8Timo Sirainen DEF(SET_STR, imap_capability),
25757faf029c369a8318349dafe952e2358df1d8Timo Sirainen DEF(SET_STR, imap_client_workarounds),
25757faf029c369a8318349dafe952e2358df1d8Timo Sirainen DEF(SET_STR, imap_logout_format),
25757faf029c369a8318349dafe952e2358df1d8Timo Sirainen DEF(SET_STR, imap_id_send),
25757faf029c369a8318349dafe952e2358df1d8Timo Sirainen DEF(SET_STR, imap_id_log),
473080c7c0d25ddfdf77e7dfa0ba8f73c6c669d5Timo Sirainen
473080c7c0d25ddfdf77e7dfa0ba8f73c6c669d5Timo Sirainen SETTING_DEFINE_LIST_END
473080c7c0d25ddfdf77e7dfa0ba8f73c6c669d5Timo Sirainen};
473080c7c0d25ddfdf77e7dfa0ba8f73c6c669d5Timo Sirainen
473080c7c0d25ddfdf77e7dfa0ba8f73c6c669d5Timo Sirainenstatic struct imap_settings imap_default_settings = {
473080c7c0d25ddfdf77e7dfa0ba8f73c6c669d5Timo Sirainen MEMBER(mail_debug) FALSE,
473080c7c0d25ddfdf77e7dfa0ba8f73c6c669d5Timo Sirainen MEMBER(shutdown_clients) FALSE,
473080c7c0d25ddfdf77e7dfa0ba8f73c6c669d5Timo Sirainen
473080c7c0d25ddfdf77e7dfa0ba8f73c6c669d5Timo Sirainen /* RFC-2683 recommends at least 8000 bytes. Some clients however don't
473080c7c0d25ddfdf77e7dfa0ba8f73c6c669d5Timo Sirainen break large message sets to multiple commands, so we're pretty
473080c7c0d25ddfdf77e7dfa0ba8f73c6c669d5Timo Sirainen liberal by default. */
473080c7c0d25ddfdf77e7dfa0ba8f73c6c669d5Timo Sirainen MEMBER(imap_max_line_length) 65536,
473080c7c0d25ddfdf77e7dfa0ba8f73c6c669d5Timo Sirainen MEMBER(imap_idle_notify_interval) 120,
473080c7c0d25ddfdf77e7dfa0ba8f73c6c669d5Timo Sirainen MEMBER(imap_capability) "",
473080c7c0d25ddfdf77e7dfa0ba8f73c6c669d5Timo Sirainen MEMBER(imap_client_workarounds) "outlook-idle",
473080c7c0d25ddfdf77e7dfa0ba8f73c6c669d5Timo Sirainen MEMBER(imap_logout_format) "bytes=%i/%o",
473080c7c0d25ddfdf77e7dfa0ba8f73c6c669d5Timo Sirainen MEMBER(imap_id_send) "",
473080c7c0d25ddfdf77e7dfa0ba8f73c6c669d5Timo Sirainen MEMBER(imap_id_log) ""
473080c7c0d25ddfdf77e7dfa0ba8f73c6c669d5Timo Sirainen};
473080c7c0d25ddfdf77e7dfa0ba8f73c6c669d5Timo Sirainen
473080c7c0d25ddfdf77e7dfa0ba8f73c6c669d5Timo Sirainenstatic struct setting_parser_info *imap_setting_dependencies[] = {
473080c7c0d25ddfdf77e7dfa0ba8f73c6c669d5Timo Sirainen &mail_user_setting_parser_info,
473080c7c0d25ddfdf77e7dfa0ba8f73c6c669d5Timo Sirainen NULL
473080c7c0d25ddfdf77e7dfa0ba8f73c6c669d5Timo Sirainen};
473080c7c0d25ddfdf77e7dfa0ba8f73c6c669d5Timo Sirainen
473080c7c0d25ddfdf77e7dfa0ba8f73c6c669d5Timo Sirainenstruct setting_parser_info imap_setting_parser_info = {
473080c7c0d25ddfdf77e7dfa0ba8f73c6c669d5Timo Sirainen MEMBER(defines) imap_setting_defines,
473080c7c0d25ddfdf77e7dfa0ba8f73c6c669d5Timo Sirainen MEMBER(defaults) &imap_default_settings,
473080c7c0d25ddfdf77e7dfa0ba8f73c6c669d5Timo Sirainen
473080c7c0d25ddfdf77e7dfa0ba8f73c6c669d5Timo Sirainen MEMBER(parent) NULL,
473080c7c0d25ddfdf77e7dfa0ba8f73c6c669d5Timo Sirainen MEMBER(dynamic_parsers) NULL,
25757faf029c369a8318349dafe952e2358df1d8Timo Sirainen
25757faf029c369a8318349dafe952e2358df1d8Timo Sirainen MEMBER(parent_offset) (size_t)-1,
25757faf029c369a8318349dafe952e2358df1d8Timo Sirainen MEMBER(type_offset) (size_t)-1,
25757faf029c369a8318349dafe952e2358df1d8Timo Sirainen MEMBER(struct_size) sizeof(struct imap_settings),
25757faf029c369a8318349dafe952e2358df1d8Timo Sirainen MEMBER(check_func) imap_settings_verify,
25757faf029c369a8318349dafe952e2358df1d8Timo Sirainen MEMBER(dependencies) imap_setting_dependencies
25757faf029c369a8318349dafe952e2358df1d8Timo Sirainen};
25757faf029c369a8318349dafe952e2358df1d8Timo Sirainen
25757faf029c369a8318349dafe952e2358df1d8Timo Sirainen/* <settings checks> */
25757faf029c369a8318349dafe952e2358df1d8Timo Sirainenstruct imap_client_workaround_list {
965ed6ea3fc8f7637bd0d159d2fdb283a191ce34Timo Sirainen const char *name;
965ed6ea3fc8f7637bd0d159d2fdb283a191ce34Timo Sirainen enum imap_client_workarounds num;
965ed6ea3fc8f7637bd0d159d2fdb283a191ce34Timo Sirainen};
25757faf029c369a8318349dafe952e2358df1d8Timo Sirainen
25757faf029c369a8318349dafe952e2358df1d8Timo Sirainenstatic struct imap_client_workaround_list imap_client_workaround_list[] = {
25757faf029c369a8318349dafe952e2358df1d8Timo Sirainen { "delay-newmail", WORKAROUND_DELAY_NEWMAIL },
25757faf029c369a8318349dafe952e2358df1d8Timo Sirainen { "outlook-idle", 0 }, /* only for backwards compatibility */
25757faf029c369a8318349dafe952e2358df1d8Timo Sirainen { "netscape-eoh", WORKAROUND_NETSCAPE_EOH },
25757faf029c369a8318349dafe952e2358df1d8Timo Sirainen { "tb-extra-mailbox-sep", WORKAROUND_TB_EXTRA_MAILBOX_SEP },
25757faf029c369a8318349dafe952e2358df1d8Timo Sirainen { NULL, 0 }
25757faf029c369a8318349dafe952e2358df1d8Timo Sirainen};
25757faf029c369a8318349dafe952e2358df1d8Timo Sirainen
25757faf029c369a8318349dafe952e2358df1d8Timo Sirainenstatic int
25757faf029c369a8318349dafe952e2358df1d8Timo Sirainenimap_settings_parse_workarounds(struct imap_settings *set,
25757faf029c369a8318349dafe952e2358df1d8Timo Sirainen const char **error_r)
25757faf029c369a8318349dafe952e2358df1d8Timo Sirainen{
25757faf029c369a8318349dafe952e2358df1d8Timo Sirainen enum imap_client_workarounds client_workarounds = 0;
25757faf029c369a8318349dafe952e2358df1d8Timo Sirainen struct imap_client_workaround_list *list;
25757faf029c369a8318349dafe952e2358df1d8Timo Sirainen const char *const *str;
25757faf029c369a8318349dafe952e2358df1d8Timo Sirainen
25757faf029c369a8318349dafe952e2358df1d8Timo Sirainen str = t_strsplit_spaces(set->imap_client_workarounds, " ,");
25757faf029c369a8318349dafe952e2358df1d8Timo Sirainen for (; *str != NULL; str++) {
25757faf029c369a8318349dafe952e2358df1d8Timo Sirainen list = imap_client_workaround_list;
ae13f46498f5890e9c83830309d0dde7d56f419bTimo Sirainen for (; list->name != NULL; list++) {
e82af44fe25ca9b88210f313548dc08538e4a677Timo Sirainen if (strcasecmp(*str, list->name) == 0) {
e82af44fe25ca9b88210f313548dc08538e4a677Timo Sirainen client_workarounds |= list->num;
e82af44fe25ca9b88210f313548dc08538e4a677Timo Sirainen break;
70cb37c37e4dce8f57cd3f882f7444e76b918befTimo Sirainen }
70cb37c37e4dce8f57cd3f882f7444e76b918befTimo Sirainen }
70cb37c37e4dce8f57cd3f882f7444e76b918befTimo Sirainen if (list->name == NULL) {
70cb37c37e4dce8f57cd3f882f7444e76b918befTimo Sirainen *error_r = t_strdup_printf("imap_client_workarounds: "
70cb37c37e4dce8f57cd3f882f7444e76b918befTimo Sirainen "Unknown workaround: %s", *str);
70cb37c37e4dce8f57cd3f882f7444e76b918befTimo Sirainen return -1;
70cb37c37e4dce8f57cd3f882f7444e76b918befTimo Sirainen }
25757faf029c369a8318349dafe952e2358df1d8Timo Sirainen }
25757faf029c369a8318349dafe952e2358df1d8Timo Sirainen set->parsed_workarounds = client_workarounds;
25757faf029c369a8318349dafe952e2358df1d8Timo Sirainen return 0;
25757faf029c369a8318349dafe952e2358df1d8Timo Sirainen}
25757faf029c369a8318349dafe952e2358df1d8Timo Sirainen
965ed6ea3fc8f7637bd0d159d2fdb283a191ce34Timo Sirainen
965ed6ea3fc8f7637bd0d159d2fdb283a191ce34Timo Sirainenstatic bool
25757faf029c369a8318349dafe952e2358df1d8Timo Sirainenimap_settings_verify(void *_set, pool_t pool ATTR_UNUSED, const char **error_r)
25757faf029c369a8318349dafe952e2358df1d8Timo Sirainen{
25757faf029c369a8318349dafe952e2358df1d8Timo Sirainen struct imap_settings *set = _set;
25757faf029c369a8318349dafe952e2358df1d8Timo Sirainen
25757faf029c369a8318349dafe952e2358df1d8Timo Sirainen if (imap_settings_parse_workarounds(set, error_r) < 0)
25757faf029c369a8318349dafe952e2358df1d8Timo Sirainen return FALSE;
25757faf029c369a8318349dafe952e2358df1d8Timo Sirainen return TRUE;
25757faf029c369a8318349dafe952e2358df1d8Timo Sirainen}
25757faf029c369a8318349dafe952e2358df1d8Timo Sirainen/* </settings checks> */
25757faf029c369a8318349dafe952e2358df1d8Timo Sirainen