diff options
Diffstat (limited to 'src/ConfigFile.cxx')
| -rw-r--r-- | src/ConfigFile.cxx | 677 |
1 files changed, 677 insertions, 0 deletions
diff --git a/src/ConfigFile.cxx b/src/ConfigFile.cxx new file mode 100644 index 000000000..fd08f52b1 --- /dev/null +++ b/src/ConfigFile.cxx @@ -0,0 +1,677 @@ +/* + * Copyright (C) 2003-2013 The Music Player Daemon Project + * http://www.musicpd.org + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation; either version 2 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License along + * with this program; if not, write to the Free Software Foundation, Inc., + * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. + */ + +#include "config.h" +#include "conf.h" + +extern "C" { +#include "utils.h" +#include "string_util.h" +#include "tokenizer.h" +} + +#include "path.h" +#include "mpd_error.h" + +#include <glib.h> + +#include <assert.h> +#include <string.h> +#include <stdio.h> +#include <stdlib.h> +#include <errno.h> + +#undef G_LOG_DOMAIN +#define G_LOG_DOMAIN "config" + +#define MAX_STRING_SIZE MPD_PATH_MAX+80 + +#define CONF_COMMENT '#' + +struct config_entry { + const char *const name; + const bool repeatable; + const bool block; + + GSList *params; + + constexpr config_entry(const char *_name, + bool _repeatable, bool _block) + :name(_name), repeatable(_repeatable), block(_block), + params(nullptr) {} +}; + +static struct config_entry config_entries[] = { + { CONF_MUSIC_DIR, false, false }, + { CONF_PLAYLIST_DIR, false, false }, + { CONF_FOLLOW_INSIDE_SYMLINKS, false, false }, + { CONF_FOLLOW_OUTSIDE_SYMLINKS, false, false }, + { CONF_DB_FILE, false, false }, + { CONF_STICKER_FILE, false, false }, + { CONF_LOG_FILE, false, false }, + { CONF_PID_FILE, false, false }, + { CONF_STATE_FILE, false, false }, + { "restore_paused", false, false }, + { CONF_USER, false, false }, + { CONF_GROUP, false, false }, + { CONF_BIND_TO_ADDRESS, true, false }, + { CONF_PORT, false, false }, + { CONF_LOG_LEVEL, false, false }, + { CONF_ZEROCONF_NAME, false, false }, + { CONF_ZEROCONF_ENABLED, false, false }, + { CONF_PASSWORD, true, false }, + { CONF_DEFAULT_PERMS, false, false }, + { CONF_AUDIO_OUTPUT, true, true }, + { CONF_AUDIO_OUTPUT_FORMAT, false, false }, + { CONF_MIXER_TYPE, false, false }, + { CONF_REPLAYGAIN, false, false }, + { CONF_REPLAYGAIN_PREAMP, false, false }, + { CONF_REPLAYGAIN_MISSING_PREAMP, false, false }, + { CONF_REPLAYGAIN_LIMIT, false, false }, + { CONF_VOLUME_NORMALIZATION, false, false }, + { CONF_SAMPLERATE_CONVERTER, false, false }, + { CONF_AUDIO_BUFFER_SIZE, false, false }, + { CONF_BUFFER_BEFORE_PLAY, false, false }, + { CONF_HTTP_PROXY_HOST, false, false }, + { CONF_HTTP_PROXY_PORT, false, false }, + { CONF_HTTP_PROXY_USER, false, false }, + { CONF_HTTP_PROXY_PASSWORD, false, false }, + { CONF_CONN_TIMEOUT, false, false }, + { CONF_MAX_CONN, false, false }, + { CONF_MAX_PLAYLIST_LENGTH, false, false }, + { CONF_MAX_COMMAND_LIST_SIZE, false, false }, + { CONF_MAX_OUTPUT_BUFFER_SIZE, false, false }, + { CONF_FS_CHARSET, false, false }, + { CONF_ID3V1_ENCODING, false, false }, + { CONF_METADATA_TO_USE, false, false }, + { CONF_SAVE_ABSOLUTE_PATHS, false, false }, + { CONF_DECODER, true, true }, + { CONF_INPUT, true, true }, + { CONF_GAPLESS_MP3_PLAYBACK, false, false }, + { CONF_PLAYLIST_PLUGIN, true, true }, + { CONF_AUTO_UPDATE, false, false }, + { CONF_AUTO_UPDATE_DEPTH, false, false }, + { CONF_DESPOTIFY_USER, false, false }, + { CONF_DESPOTIFY_PASSWORD, false, false}, + { CONF_DESPOTIFY_HIGH_BITRATE, false, false }, + { "filter", true, true }, + { "database", false, true }, +}; + +static bool +get_bool(const char *value, bool *value_r) +{ + static const char *t[] = { "yes", "true", "1", NULL }; + static const char *f[] = { "no", "false", "0", NULL }; + + if (string_array_contains(t, value)) { + *value_r = true; + return true; + } + + if (string_array_contains(f, value)) { + *value_r = false; + return true; + } + + return false; +} + +struct config_param * +config_new_param(const char *value, int line) +{ + struct config_param *ret = g_new(struct config_param, 1); + + if (!value) + ret->value = NULL; + else + ret->value = g_strdup(value); + + ret->line = line; + + ret->num_block_params = 0; + ret->block_params = NULL; + ret->used = false; + + return ret; +} + +void +config_param_free(struct config_param *param) +{ + g_free(param->value); + + for (unsigned i = 0; i < param->num_block_params; i++) { + g_free(param->block_params[i].name); + g_free(param->block_params[i].value); + } + + if (param->num_block_params) + g_free(param->block_params); + + g_free(param); +} + +static void +config_param_free_callback(gpointer data, G_GNUC_UNUSED gpointer user_data) +{ + struct config_param *param = (struct config_param *)data; + + config_param_free(param); +} + +static struct config_entry * +config_entry_get(const char *name) +{ + for (unsigned i = 0; i < G_N_ELEMENTS(config_entries); ++i) { + struct config_entry *entry = &config_entries[i]; + if (strcmp(entry->name, name) == 0) + return entry; + } + + return NULL; +} + +void config_global_finish(void) +{ + for (unsigned i = 0; i < G_N_ELEMENTS(config_entries); ++i) { + struct config_entry *entry = &config_entries[i]; + + g_slist_foreach(entry->params, + config_param_free_callback, NULL); + g_slist_free(entry->params); + } +} + +void config_global_init(void) +{ +} + +static void +config_param_check(gpointer data, G_GNUC_UNUSED gpointer user_data) +{ + struct config_param *param = (struct config_param *)data; + + if (!param->used) + /* this whole config_param was not queried at all - + the feature might be disabled at compile time? + Silently ignore it here. */ + return; + + for (unsigned i = 0; i < param->num_block_params; i++) { + struct block_param *bp = ¶m->block_params[i]; + + if (!bp->used) + g_warning("option '%s' on line %i was not recognized", + bp->name, bp->line); + } +} + +void config_global_check(void) +{ + for (unsigned i = 0; i < G_N_ELEMENTS(config_entries); ++i) { + struct config_entry *entry = &config_entries[i]; + + g_slist_foreach(entry->params, config_param_check, NULL); + } +} + +void +config_add_block_param(struct config_param * param, const char *name, + const char *value, int line) +{ + struct block_param *bp; + + assert(config_get_block_param(param, name) == NULL); + + param->num_block_params++; + + param->block_params = (struct block_param *) + g_realloc(param->block_params, + param->num_block_params * + sizeof(param->block_params[0])); + + bp = ¶m->block_params[param->num_block_params - 1]; + + bp->name = g_strdup(name); + bp->value = g_strdup(value); + bp->line = line; + bp->used = false; +} + +static bool +config_read_name_value(struct config_param *param, char *input, unsigned line, + GError **error_r) +{ + const char *name = tokenizer_next_word(&input, error_r); + if (name == NULL) { + assert(*input != 0); + return false; + } + + const char *value = tokenizer_next_string(&input, error_r); + if (value == NULL) { + if (*input == 0) { + assert(error_r == NULL || *error_r == NULL); + g_set_error(error_r, config_quark(), 0, + "Value missing"); + } else { + assert(error_r == NULL || *error_r != NULL); + } + + return false; + } + + if (*input != 0 && *input != CONF_COMMENT) { + g_set_error(error_r, config_quark(), 0, + "Unknown tokens after value"); + return false; + } + + const struct block_param *bp = config_get_block_param(param, name); + if (bp != NULL) { + g_set_error(error_r, config_quark(), 0, + "\"%s\" is duplicate, first defined on line %i", + name, bp->line); + return false; + } + + config_add_block_param(param, name, value, line); + return true; +} + +static struct config_param * +config_read_block(FILE *fp, int *count, char *string, GError **error_r) +{ + struct config_param *ret = config_new_param(NULL, *count); + GError *error = NULL; + + while (true) { + char *line; + + line = fgets(string, MAX_STRING_SIZE, fp); + if (line == NULL) { + config_param_free(ret); + g_set_error(error_r, config_quark(), 0, + "Expected '}' before end-of-file"); + return NULL; + } + + (*count)++; + line = strchug_fast(line); + if (*line == 0 || *line == CONF_COMMENT) + continue; + + if (*line == '}') { + /* end of this block; return from the function + (and from this "while" loop) */ + + line = strchug_fast(line + 1); + if (*line != 0 && *line != CONF_COMMENT) { + config_param_free(ret); + g_set_error(error_r, config_quark(), 0, + "line %i: Unknown tokens after '}'", + *count); + return nullptr; + } + + return ret; + } + + /* parse name and value */ + + if (!config_read_name_value(ret, line, *count, &error)) { + assert(*line != 0); + config_param_free(ret); + g_propagate_prefixed_error(error_r, error, + "line %i: ", *count); + return NULL; + } + } +} + +bool +config_read_file(const char *file, GError **error_r) +{ + FILE *fp; + char string[MAX_STRING_SIZE + 1]; + int count = 0; + struct config_entry *entry; + struct config_param *param; + + g_debug("loading file %s", file); + + if (!(fp = fopen(file, "r"))) { + g_set_error(error_r, config_quark(), errno, + "Failed to open %s: %s", + file, g_strerror(errno)); + return false; + } + + while (fgets(string, MAX_STRING_SIZE, fp)) { + char *line; + const char *name, *value; + GError *error = NULL; + + count++; + + line = strchug_fast(string); + if (*line == 0 || *line == CONF_COMMENT) + continue; + + /* the first token in each line is the name, followed + by either the value or '{' */ + + name = tokenizer_next_word(&line, &error); + if (name == NULL) { + assert(*line != 0); + g_propagate_prefixed_error(error_r, error, + "line %i: ", count); + fclose(fp); + return false; + } + + /* get the definition of that option, and check the + "repeatable" flag */ + + entry = config_entry_get(name); + if (entry == NULL) { + g_set_error(error_r, config_quark(), 0, + "unrecognized parameter in config file at " + "line %i: %s\n", count, name); + fclose(fp); + return false; + } + + if (entry->params != NULL && !entry->repeatable) { + param = (struct config_param *)entry->params->data; + g_set_error(error_r, config_quark(), 0, + "config parameter \"%s\" is first defined " + "on line %i and redefined on line %i\n", + name, param->line, count); + fclose(fp); + return false; + } + + /* now parse the block or the value */ + + if (entry->block) { + /* it's a block, call config_read_block() */ + + if (*line != '{') { + g_set_error(error_r, config_quark(), 0, + "line %i: '{' expected", count); + fclose(fp); + return false; + } + + line = strchug_fast(line + 1); + if (*line != 0 && *line != CONF_COMMENT) { + g_set_error(error_r, config_quark(), 0, + "line %i: Unknown tokens after '{'", + count); + fclose(fp); + return false; + } + + param = config_read_block(fp, &count, string, error_r); + if (param == NULL) { + fclose(fp); + return false; + } + } else { + /* a string value */ + + value = tokenizer_next_string(&line, &error); + if (value == NULL) { + if (*line == 0) + g_set_error(error_r, config_quark(), 0, + "line %i: Value missing", + count); + else { + g_set_error(error_r, config_quark(), 0, + "line %i: %s", count, + error->message); + g_error_free(error); + } + + fclose(fp); + return false; + } + + if (*line != 0 && *line != CONF_COMMENT) { + g_set_error(error_r, config_quark(), 0, + "line %i: Unknown tokens after value", + count); + fclose(fp); + return false; + } + + param = config_new_param(value, count); + } + + entry->params = g_slist_append(entry->params, param); + } + fclose(fp); + + return true; +} + +const struct config_param * +config_get_next_param(const char *name, const struct config_param * last) +{ + struct config_entry *entry; + GSList *node; + struct config_param *param; + + entry = config_entry_get(name); + if (entry == NULL) + return NULL; + + node = entry->params; + + if (last) { + node = g_slist_find(node, last); + if (node == NULL) + return NULL; + + node = g_slist_next(node); + } + + if (node == NULL) + return NULL; + + param = (struct config_param *)node->data; + param->used = true; + return param; +} + +const char * +config_get_string(const char *name, const char *default_value) +{ + const struct config_param *param = config_get_param(name); + + if (param == NULL) + return default_value; + + return param->value; +} + +char * +config_dup_path(const char *name, GError **error_r) +{ + assert(error_r != NULL); + assert(*error_r == NULL); + + const struct config_param *param = config_get_param(name); + if (param == NULL) + return NULL; + + char *path = parsePath(param->value, error_r); + if (G_UNLIKELY(path == NULL)) + g_prefix_error(error_r, + "Invalid path in \"%s\" at line %i: ", + name, param->line); + + return path; +} + +unsigned +config_get_unsigned(const char *name, unsigned default_value) +{ + const struct config_param *param = config_get_param(name); + long value; + char *endptr; + + if (param == NULL) + return default_value; + + value = strtol(param->value, &endptr, 0); + if (*endptr != 0 || value < 0) + MPD_ERROR("Not a valid non-negative number in line %i", + param->line); + + return (unsigned)value; +} + +unsigned +config_get_positive(const char *name, unsigned default_value) +{ + const struct config_param *param = config_get_param(name); + long value; + char *endptr; + + if (param == NULL) + return default_value; + + value = strtol(param->value, &endptr, 0); + if (*endptr != 0) + MPD_ERROR("Not a valid number in line %i", param->line); + + if (value <= 0) + MPD_ERROR("Not a positive number in line %i", param->line); + + return (unsigned)value; +} + +const struct block_param * +config_get_block_param(const struct config_param * param, const char *name) +{ + if (param == NULL) + return NULL; + + for (unsigned i = 0; i < param->num_block_params; i++) { + if (0 == strcmp(name, param->block_params[i].name)) { + struct block_param *bp = ¶m->block_params[i]; + bp->used = true; + return bp; + } + } + + return NULL; +} + +bool config_get_bool(const char *name, bool default_value) +{ + const struct config_param *param = config_get_param(name); + bool success, value; + + if (param == NULL) + return default_value; + + success = get_bool(param->value, &value); + if (!success) + MPD_ERROR("%s is not a boolean value (yes, true, 1) or " + "(no, false, 0) on line %i\n", + name, param->line); + + return value; +} + +const char * +config_get_block_string(const struct config_param *param, const char *name, + const char *default_value) +{ + const struct block_param *bp = config_get_block_param(param, name); + + if (bp == NULL) + return default_value; + + return bp->value; +} + +char * +config_dup_block_path(const struct config_param *param, const char *name, + GError **error_r) +{ + assert(error_r != NULL); + assert(*error_r == NULL); + + const struct block_param *bp = config_get_block_param(param, name); + if (bp == NULL) + return NULL; + + char *path = parsePath(bp->value, error_r); + if (G_UNLIKELY(path == NULL)) + g_prefix_error(error_r, + "Invalid path in \"%s\" at line %i: ", + name, bp->line); + + return path; +} + +unsigned +config_get_block_unsigned(const struct config_param *param, const char *name, + unsigned default_value) +{ + const struct block_param *bp = config_get_block_param(param, name); + long value; + char *endptr; + + if (bp == NULL) + return default_value; + + value = strtol(bp->value, &endptr, 0); + if (*endptr != 0) + MPD_ERROR("Not a valid number in line %i", bp->line); + + if (value < 0) + MPD_ERROR("Not a positive number in line %i", bp->line); + + return (unsigned)value; +} + +bool +config_get_block_bool(const struct config_param *param, const char *name, + bool default_value) +{ + const struct block_param *bp = config_get_block_param(param, name); + bool success, value; + + if (bp == NULL) + return default_value; + + success = get_bool(bp->value, &value); + if (!success) + MPD_ERROR("%s is not a boolean value (yes, true, 1) or " + "(no, false, 0) on line %i\n", + name, bp->line); + + return value; +} |