X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~mdw/git/disorder/blobdiff_plain/e83d0967d4c0965eb8036248acc20d1bf12ad1d8..0e843521df080e255a855565e210b7e0caa64511:/lib/configuration.c?ds=sidebyside diff --git a/lib/configuration.c b/lib/configuration.c index 5881f87..35ed090 100644 --- a/lib/configuration.c +++ b/lib/configuration.c @@ -17,6 +17,9 @@ * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 * USA */ +/** @file lib/configuration.c + * @brief Configuration file support + */ #include #include "types.h" @@ -48,33 +51,53 @@ #include "printf.h" #include "regsub.h" #include "signame.h" +#include "authhash.h" +/** @brief Path to config file + * + * set_configfile() sets the deafult if it is null. + */ char *configfile; +/** @brief Config file parser state */ struct config_state { + /** @brief Filename */ const char *path; + /** @brief Line number */ int line; + /** @brief Configuration object under construction */ struct config *config; }; +/** @brief Current configuration */ struct config *config; +/** @brief One configuration item */ struct conf { + /** @brief Name as it appears in the config file */ const char *name; + /** @brief Offset in @ref config structure */ size_t offset; + /** @brief Pointer to item type */ const struct conftype *type; + /** @brief Pointer to item-specific validation routine */ int (*validate)(const struct config_state *cs, int nvec, char **vec); }; +/** @brief Type of a configuration item */ struct conftype { + /** @brief Pointer to function to set item */ int (*set)(const struct config_state *cs, const struct conf *whoami, int nvec, char **vec); + /** @brief Pointer to function to free item */ void (*free)(struct config *c, const struct conf *whoami); }; +/** @brief Compute the address of an item */ #define ADDRESS(C, TYPE) ((TYPE *)((char *)(C) + whoami->offset)) +/** @brief Return the value of an item */ #define VALUE(C, TYPE) (*ADDRESS(C, TYPE)) static int set_signal(const struct config_state *cs, @@ -256,61 +279,61 @@ static int set_restrict(const struct config_state *cs, } static int parse_sample_format(const struct config_state *cs, - ao_sample_format *ao, + struct stream_header *format, int nvec, char **vec) { char *p = vec[0]; long t; - if (nvec != 1) { + if(nvec != 1) { error(0, "%s:%d: wrong number of arguments", cs->path, cs->line); return -1; } - if (xstrtol(&t, p, &p, 0)) { + if(xstrtol(&t, p, &p, 0)) { error(errno, "%s:%d: converting bits-per-sample", cs->path, cs->line); return -1; } - if (t != 8 && t != 16) { + if(t != 8 && t != 16) { error(0, "%s:%d: bad bite-per-sample (%ld)", cs->path, cs->line, t); return -1; } - if (ao) ao->bits = t; + if(format) format->bits = t; switch (*p) { - case 'l': case 'L': t = AO_FMT_LITTLE; p++; break; - case 'b': case 'B': t = AO_FMT_BIG; p++; break; - default: t = AO_FMT_NATIVE; break; + case 'l': case 'L': t = ENDIAN_LITTLE; p++; break; + case 'b': case 'B': t = ENDIAN_BIG; p++; break; + default: t = ENDIAN_NATIVE; break; } - if (ao) ao->byte_format = t; - if (*p != '/') { + if(format) format->endian = t; + if(*p != '/') { error(errno, "%s:%d: expected `/' after bits-per-sample", cs->path, cs->line); return -1; } p++; - if (xstrtol(&t, p, &p, 0)) { + if(xstrtol(&t, p, &p, 0)) { error(errno, "%s:%d: converting sample-rate", cs->path, cs->line); return -1; } - if (t < 1 || t > INT_MAX) { + if(t < 1 || t > INT_MAX) { error(0, "%s:%d: silly sample-rate (%ld)", cs->path, cs->line, t); return -1; } - if (ao) ao->rate = t; - if (*p != '/') { + if(format) format->rate = t; + if(*p != '/') { error(0, "%s:%d: expected `/' after sample-rate", cs->path, cs->line); return -1; } p++; - if (xstrtol(&t, p, &p, 0)) { + if(xstrtol(&t, p, &p, 0)) { error(errno, "%s:%d: converting channels", cs->path, cs->line); return -1; } - if (t < 1 || t > 8) { + if(t < 1 || t > 8) { error(0, "%s:%d: silly number (%ld) of channels", cs->path, cs->line, t); return -1; } - if (ao) ao->channels = t; - if (*p) { + if(format) format->channels = t; + if(*p) { error(0, "%s:%d: junk after channels", cs->path, cs->line); return -1; } @@ -320,7 +343,7 @@ static int parse_sample_format(const struct config_state *cs, static int set_sample_format(const struct config_state *cs, const struct conf *whoami, int nvec, char **vec) { - return parse_sample_format(cs, ADDRESS(cs->config, ao_sample_format), + return parse_sample_format(cs, ADDRESS(cs->config, struct stream_header), nvec, vec); } @@ -416,7 +439,7 @@ static int set_backend(const struct config_state *cs, return -1; } if(!strcmp(vec[0], "alsa")) { -#if API_ALSA +#if HAVE_ALSA_ASOUNDLIB_H *valuep = BACKEND_ALSA; #else error(0, "%s:%d: ALSA is not available on this platform", @@ -427,7 +450,23 @@ static int set_backend(const struct config_state *cs, *valuep = BACKEND_COMMAND; else if(!strcmp(vec[0], "network")) *valuep = BACKEND_NETWORK; - else { + else if(!strcmp(vec[0], "coreaudio")) { +#if HAVE_COREAUDIO_AUDIOHARDWARE_H + *valuep = BACKEND_COREAUDIO; +#else + error(0, "%s:%d: Core Audio is not available on this platform", + cs->path, cs->line); + return -1; +#endif + } else if(!strcmp(vec[0], "oss")) { +#if HAVE_SYS_SOUNDCARD_H + *valuep = BACKEND_OSS; +#else + error(0, "%s:%d: OSS is not available on this platform", + cs->path, cs->line); + return -1; +#endif + } else { error(0, "%s:%d: invalid '%s' value '%s'", cs->path, cs->line, whoami->name, vec[0]); return -1; @@ -554,6 +593,19 @@ static const struct conftype } \ } while(0) +static int validate_isabspath(const struct config_state *cs, + int nvec, char **vec) { + int n; + + for(n = 0; n < nvec; ++n) + if(vec[n][0] != '/') { + error(errno, "%s:%d: %s: not an absolute path", + cs->path, cs->line, vec[n]); + return -1; + } + return 0; +} + static int validate_isdir(const struct config_state *cs, int nvec, char **vec) { VALIDATE_FILE(S_ISDIR, "directory"); @@ -583,6 +635,17 @@ static int validate_player(const struct config_state *cs, return 0; } +static int validate_tracklength(const struct config_state *cs, + int nvec, + char attribute((unused)) **vec) { + if(nvec < 2) { + error(0, "%s:%d: should be at least 'tracklength PATTERN MODULE'", + cs->path, cs->line); + return -1; + } + return 0; +} + static int validate_allow(const struct config_state *cs, int nvec, char attribute((unused)) **vec) { @@ -772,7 +835,7 @@ static int validate_addrport(const struct config_state attribute((unused)) *cs, } } -static int validate_address(const struct config_state attribute((unused)) *cs, +static int validate_port(const struct config_state attribute((unused)) *cs, int nvec, char attribute((unused)) **vec) { switch(nvec) { @@ -784,22 +847,38 @@ static int validate_address(const struct config_state attribute((unused)) *cs, case 2: return 0; default: - error(0, "%s:%d: expected ADDRESS PORT", + error(0, "%s:%d: expected [ADDRESS] PORT", cs->path, cs->line); return -1; } } -/* configuration table */ +static int validate_algo(const struct config_state attribute((unused)) *cs, + int nvec, + char **vec) { + if(nvec != 1) { + error(0, "%s:%d: invalid algorithm specification", cs->path, cs->line); + return -1; + } + if(!valid_authhash(vec[0])) { + error(0, "%s:%d: unsuported algorithm '%s'", cs->path, cs->line, vec[0]); + return -1; + } + return 0; +} +/** @brief Item name and and offset */ #define C(x) #x, offsetof(struct config, x) +/** @brief Item name and and offset */ #define C2(x,y) #x, offsetof(struct config, y) +/** @brief All configuration items */ static const struct conf conf[] = { { C(alias), &type_string, validate_alias }, { C(allow), &type_stringlist_accum, validate_allow }, + { C(authorization_algorithm), &type_string, validate_algo }, { C(broadcast), &type_stringlist, validate_addrport }, - { C(broadcast_from), &type_stringlist, validate_address }, + { C(broadcast_from), &type_stringlist, validate_addrport }, { C(channel), &type_string, validate_channel }, { C(checkpoint_kbyte), &type_integer, validate_non_negative }, { C(checkpoint_min), &type_integer, validate_non_negative }, @@ -808,15 +887,17 @@ static const struct conf conf[] = { { C(device), &type_string, validate_any }, { C(gap), &type_integer, validate_non_negative }, { C(history), &type_integer, validate_positive }, - { C(home), &type_string, validate_isdir }, - { C(listen), &type_stringlist, validate_addrport }, + { C(home), &type_string, validate_isabspath }, + { C(listen), &type_stringlist, validate_port }, { C(lock), &type_boolean, validate_any }, { C(mixer), &type_string, validate_ischr }, + { C(multicast_ttl), &type_integer, validate_non_negative }, { C(namepart), &type_namepart, validate_any }, { C2(nice, nice_rescan), &type_integer, validate_non_negative }, { C(nice_rescan), &type_integer, validate_non_negative }, { C(nice_server), &type_integer, validate_any }, { C(nice_speaker), &type_integer, validate_any }, + { C(noticed_history), &type_integer, validate_positive }, { C(password), &type_string, validate_any }, { C(player), &type_stringlist_accum, validate_player }, { C(plugins), &type_string_accum, validate_isdir }, @@ -826,12 +907,14 @@ static const struct conf conf[] = { { C2(restrict, restrictions), &type_restrict, validate_any }, { C(sample_format), &type_sample_format, validate_sample_format }, { C(scratch), &type_string_accum, validate_isreg }, + { C(short_display), &type_integer, validate_positive }, { C(signal), &type_signal, validate_any }, { C(sox_generation), &type_integer, validate_non_negative }, { C(speaker_backend), &type_backend, validate_any }, { C(speaker_command), &type_string, validate_any }, { C(stopword), &type_string_accum, validate_any }, { C(templates), &type_string_accum, validate_isdir }, + { C(tracklength), &type_stringlist_accum, validate_tracklength }, { C(transform), &type_transform, validate_any }, { C(trust), &type_string_accum, validate_any }, { C(url), &type_string, validate_url }, @@ -839,7 +922,7 @@ static const struct conf conf[] = { { C(username), &type_string, validate_any }, }; -/* find a configuration item's definition by key */ +/** @brief Find a configuration item's definition by key */ static const struct conf *find(const char *key) { int n; @@ -848,7 +931,7 @@ static const struct conf *find(const char *key) { return &conf[n]; } -/* set a new configuration value */ +/** @brief Set a new configuration value */ static int config_set(const struct config_state *cs, int nvec, char **vec) { const struct conf *which; @@ -863,13 +946,14 @@ static int config_set(const struct config_state *cs, || which->type->set(cs, which, nvec - 1, vec + 1)); } +/** @brief Error callback used by config_include() */ static void config_error(const char *msg, void *u) { const struct config_state *cs = u; error(0, "%s:%d: %s", cs->path, cs->line, msg); } -/* include a file by name */ +/** @brief Include a file by name */ static int config_include(struct config *c, const char *path) { FILE *fp; char *buffer, *inputbuffer, **vec; @@ -921,7 +1005,7 @@ static int config_include(struct config *c, const char *path) { return ret; } -/* make a new default config */ +/** @brief Make a new default configuration */ static struct config *config_default(void) { struct config *c = xmalloc(sizeof *c); const char *logname; @@ -946,9 +1030,15 @@ static struct config *config_default(void) { c->sample_format.bits = 16; c->sample_format.rate = 44100; c->sample_format.channels = 2; - c->sample_format.byte_format = AO_FMT_NATIVE; + c->sample_format.endian = ENDIAN_NATIVE; c->queue_pad = 10; c->speaker_backend = -1; + c->multicast_ttl = 1; + c->authorization_algorithm = xstrdup("sha1"); + c->noticed_history = 31; + c->short_display = 32; + c->mixer = xstrdup("/dev/mixer"); + c->channel = xstrdup("pcm"); return c; } @@ -959,12 +1049,13 @@ static char *get_file(struct config *c, const char *name) { return s; } +/** @brief Set the default configuration file */ static void set_configfile(void) { if(!configfile) byte_xasprintf(&configfile, "%s/config", pkgconfdir); } -/* free the config file */ +/** @brief Free a configuration object */ static void config_free(struct config *c) { int n; @@ -978,13 +1069,15 @@ static void config_free(struct config *c) { } } -static void config_postdefaults(struct config *c) { +/** @brief Set post-parse defaults */ +static void config_postdefaults(struct config *c, + int server) { struct config_state cs; const struct conf *whoami; int n; static const char *namepart[][4] = { - { "title", "/([0-9]+:)?([^/]+)\\.[a-zA-Z0-9]+$", "$2", "display" }, + { "title", "/([0-9]+ *[-:] *)?([^/]+)\\.[a-zA-Z0-9]+$", "$2", "display" }, { "title", "/([^/]+)\\.[a-zA-Z0-9]+$", "$1", "sort" }, { "album", "/([^/]+)/[^/]+$", "$1", "*" }, { "artist", "/([^/]+)/[^/]+/[^/]+$", "$1", "*" }, @@ -993,7 +1086,7 @@ static void config_postdefaults(struct config *c) { #define NNAMEPART (int)(sizeof namepart / sizeof *namepart) static const char *transform[][5] = { - { "track", "^.*/([0-9]+:)?([^/]+)\\.[a-zA-Z0-9]+$", "$2", "display", "" }, + { "track", "^.*/([0-9]+ *[-:] *)?([^/]+)\\.[a-zA-Z0-9]+$", "$2", "display", "" }, { "track", "^.*/([^/]+)\\.[a-zA-Z0-9]+$", "$1", "sort", "" }, { "dir", "^.*/([^/]+)$", "$1", "*", "" }, { "dir", "^(the) ([^/]*)", "$2, $1", "sort", "i", }, @@ -1020,29 +1113,54 @@ static void config_postdefaults(struct config *c) { else if(c->broadcast.n) c->speaker_backend = BACKEND_NETWORK; else { -#if API_ALSA +#if HAVE_ALSA_ASOUNDLIB_H c->speaker_backend = BACKEND_ALSA; +#elif HAVE_SYS_SOUNDCARD_H + c->speaker_backend = BACKEND_OSS; +#elif HAVE_COREAUDIO_AUDIOHARDWARE_H + c->speaker_backend = BACKEND_COREAUDIO; #else c->speaker_backend = BACKEND_COMMAND; #endif } } - if(c->speaker_backend == BACKEND_COMMAND && !c->speaker_command) - fatal(0, "speaker_backend is command but speaker_command is not set"); - if(c->speaker_backend == BACKEND_NETWORK && !c->broadcast.n) - fatal(0, "speaker_backend is network but broadcast is not set"); + if(server) { + if(c->speaker_backend == BACKEND_COMMAND && !c->speaker_command) + fatal(0, "speaker_backend is command but speaker_command is not set"); + if(c->speaker_backend == BACKEND_NETWORK && !c->broadcast.n) + fatal(0, "speaker_backend is network but broadcast is not set"); + } + /* Override sample format */ + switch(c->speaker_backend) { + case BACKEND_NETWORK: + c->sample_format.rate = 44100; + c->sample_format.channels = 2; + c->sample_format.bits = 16; + c->sample_format.endian = ENDIAN_BIG; + break; + case BACKEND_COREAUDIO: + c->sample_format.rate = 44100; + c->sample_format.channels = 2; + c->sample_format.bits = 16; + c->sample_format.endian = ENDIAN_NATIVE; + break; + } } -/* re-read the config file */ -int config_read() { +/** @brief (Re-)read the config file + * @param server If set, do extra checking + */ +int config_read(int server) { struct config *c; char *privconf; struct passwd *pw; set_configfile(); c = config_default(); - if(config_include(c, configfile)) - return -1; + /* standalone Disobedience installs might not have a global config file */ + if(access(configfile, F_OK) == 0) + if(config_include(c, configfile)) + return -1; /* if we can read the private config file, do */ if((privconf = config_private()) && access(privconf, R_OK) == 0 @@ -1064,13 +1182,14 @@ int config_read() { return -1; xfree(privconf); /* install default namepart and transform settings */ - config_postdefaults(c); + config_postdefaults(c, server); /* everything is good so we shall use the new config */ config_free(config); config = c; return 0; } +/** @brief Return the path to the private configuration file */ char *config_private(void) { char *s; @@ -1079,14 +1198,18 @@ char *config_private(void) { return s; } +/** @brief Return the path to user's personal configuration file */ char *config_userconf(const char *home, const struct passwd *pw) { char *s; + if(!home && !pw && !(pw = getpwuid(getuid()))) + fatal(0, "cannot determine our username"); byte_xasprintf(&s, "%s/.disorder/passwd", home ? home : pw->pw_dir); return s; } -char *config_usersysconf(const struct passwd *pw ) { +/** @brief Return the path to user-specific system configuration */ +char *config_usersysconf(const struct passwd *pw) { char *s; set_configfile();