src/pop3/pop3-settings.c

/* Copyright (c) 2005-2018 Dovecot authors, see the included COPYING file */

#include "lib.h"
#include "buffer.h"
#include "settings-parser.h"
#include "service-settings.h"
#include "mail-storage-settings.h"
#include "pop3-settings.h"

#include <stddef.h>
#include <unistd.h>

static bool pop3_settings_verify(void *_set, pool_t pool,
                 const char **error_r);

/* <settings checks> */
static struct file_listener_settings pop3_unix_listeners_array[] = {
    { "login/pop3", 0666, "", "" }
};
static struct file_listener_settings *pop3_unix_listeners[] = {
    &pop3_unix_listeners_array[0]
};
static buffer_t pop3_unix_listeners_buf = {
    pop3_unix_listeners, sizeof(pop3_unix_listeners), { NULL, }
};
/* </settings checks> */

struct service_settings pop3_service_settings = {
    .name = "pop3",
    .protocol = "pop3",
    .type = "",
    .executable = "pop3",
    .user = "",
    .group = "",
    .privileged_group = "",
    .extra_groups = "$default_internal_group",
    .chroot = "",

    .drop_priv_before_exec = FALSE,

    .process_min_avail = 0,
    .process_limit = 1024,
    .client_limit = 1,
    .service_count = 1,
    .idle_kill = 0,
    .vsz_limit = (uoff_t)-1,

    .unix_listeners = { { &pop3_unix_listeners_buf,
                  sizeof(pop3_unix_listeners[0]) } },
    .fifo_listeners = ARRAY_INIT,
    .inet_listeners = ARRAY_INIT
};

#undef DEF
#undef DEFLIST
#define DEF(type, name) \
    { type, #name, offsetof(struct pop3_settings, name), NULL }
#define DEFLIST(field, name, defines) \
    { SET_DEFLIST, name, offsetof(struct pop3_settings, field), defines }

static const struct setting_define pop3_setting_defines[] = {
    DEF(SET_BOOL, verbose_proctitle),
    DEF(SET_STR_VARS, rawlog_dir),

    DEF(SET_BOOL, pop3_no_flag_updates),
    DEF(SET_BOOL, pop3_enable_last),
    DEF(SET_BOOL, pop3_reuse_xuidl),
    DEF(SET_BOOL, pop3_save_uidl),
    DEF(SET_BOOL, pop3_lock_session),
    DEF(SET_BOOL, pop3_fast_size_lookups),
    DEF(SET_STR, pop3_client_workarounds),
    DEF(SET_STR, pop3_logout_format),
    DEF(SET_ENUM, pop3_uidl_duplicates),
    DEF(SET_STR, pop3_deleted_flag),
    DEF(SET_ENUM, pop3_delete_type),

    SETTING_DEFINE_LIST_END
};

static const struct pop3_settings pop3_default_settings = {
    .verbose_proctitle = FALSE,
    .rawlog_dir = "",

    .pop3_no_flag_updates = FALSE,
    .pop3_enable_last = FALSE,
    .pop3_reuse_xuidl = FALSE,
    .pop3_save_uidl = FALSE,
    .pop3_lock_session = FALSE,
    .pop3_fast_size_lookups = FALSE,
    .pop3_client_workarounds = "",
    .pop3_logout_format = "top=%t/%p, retr=%r/%b, del=%d/%m, size=%s",
    .pop3_uidl_duplicates = "allow:rename",
    .pop3_deleted_flag = "",
    .pop3_delete_type = "default:expunge:flag"
};

static const struct setting_parser_info *pop3_setting_dependencies[] = {
    &mail_user_setting_parser_info,
    NULL
};

const struct setting_parser_info pop3_setting_parser_info = {
    .module_name = "pop3",
    .defines = pop3_setting_defines,
    .defaults = &pop3_default_settings,

    .type_offset = (size_t)-1,
    .struct_size = sizeof(struct pop3_settings),

    .parent_offset = (size_t)-1,

    .check_func = pop3_settings_verify,
    .dependencies = pop3_setting_dependencies
};

/* <settings checks> */
struct pop3_client_workaround_list {
    const char *name;
    enum pop3_client_workarounds num;
};

static const struct pop3_client_workaround_list pop3_client_workaround_list[] = {
    { "outlook-no-nuls", WORKAROUND_OUTLOOK_NO_NULS },
    { "oe-ns-eoh", WORKAROUND_OE_NS_EOH },
    { NULL, 0 }
};

static int
pop3_settings_parse_workarounds(struct pop3_settings *set,
                const char **error_r)
{
        enum pop3_client_workarounds client_workarounds = 0;
    const struct pop3_client_workaround_list *list;
    const char *const *str;

        str = t_strsplit_spaces(set->pop3_client_workarounds, " ,");
    for (; *str != NULL; str++) {
        list = pop3_client_workaround_list;
        for (; list->name != NULL; list++) {
            if (strcasecmp(*str, list->name) == 0) {
                client_workarounds |= list->num;
                break;
            }
        }
        if (list->name == NULL) {
            *error_r = t_strdup_printf("pop3_client_workarounds: "
                "Unknown workaround: %s", *str);
            return -1;
        }
    }
    set->parsed_workarounds = client_workarounds;
    return 0;
}

static bool
pop3_settings_verify(void *_set, pool_t pool ATTR_UNUSED, const char **error_r)
{
    struct pop3_settings *set = _set;

    if (pop3_settings_parse_workarounds(set, error_r) < 0)
        return FALSE;
    if (strcmp(set->pop3_delete_type, "default") == 0) {
        if (set->pop3_deleted_flag[0] == '\0')
            set->parsed_delete_type = POP3_DELETE_TYPE_EXPUNGE;
        else
            set->parsed_delete_type = POP3_DELETE_TYPE_FLAG;
    } else if (strcmp(set->pop3_delete_type, "expunge") == 0) {
        set->parsed_delete_type = POP3_DELETE_TYPE_EXPUNGE;
    } else if (strcmp(set->pop3_delete_type, "flag") == 0) {
        if (set->pop3_deleted_flag[0] == '\0') {
            *error_r = "pop3_delete_type=flag, but pop3_deleted_flag not set";
            return FALSE;
        }
        set->parsed_delete_type = POP3_DELETE_TYPE_FLAG;
    } else {
        *error_r = t_strdup_printf("pop3_delete_type: Unknown value '%s'",
                       set->pop3_delete_type);
        return FALSE;
    }
    return TRUE;
}
/* </settings checks> */