2 * This file is part of DisOrder.
3 * Copyright (C) 2004-2009 Richard Kettlewell
4 * Portions copyright (C) 2007 Mark Wooding
6 * This program is free software: you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation, either version 3 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program. If not, see <http://www.gnu.org/licenses/>.
19 /** @file lib/configuration.c
20 * @brief Configuration file support
26 #include <sys/types.h>
37 #include "configuration.h"
43 #include "inputline.h"
53 /** @brief Path to config file
55 * set_configfile() sets the deafult if it is null.
59 /** @brief Read user configuration
61 * If clear, the user-specific configuration is not read.
63 int config_per_user = 1;
65 /** @brief Table of audio APIs
67 * Only set in server processes.
69 const struct uaudio *const *config_uaudio_apis;
71 /** @brief Config file parser state */
73 /** @brief Filename */
75 /** @brief Line number */
77 /** @brief Configuration object under construction */
78 struct config *config;
81 /** @brief Current configuration */
82 struct config *config;
84 /** @brief One configuration item */
86 /** @brief Name as it appears in the config file */
88 /** @brief Offset in @ref config structure */
90 /** @brief Pointer to item type */
91 const struct conftype *type;
92 /** @brief Pointer to item-specific validation routine */
93 int (*validate)(const struct config_state *cs,
94 int nvec, char **vec);
97 /** @brief Type of a configuration item */
99 /** @brief Pointer to function to set item */
100 int (*set)(const struct config_state *cs,
101 const struct conf *whoami,
102 int nvec, char **vec);
103 /** @brief Pointer to function to free item */
104 void (*free)(struct config *c, const struct conf *whoami);
107 /** @brief Compute the address of an item */
108 #define ADDRESS(C, TYPE) ((TYPE *)((char *)(C) + whoami->offset))
109 /** @brief Return the value of an item */
110 #define VALUE(C, TYPE) (*ADDRESS(C, TYPE))
112 static int set_signal(const struct config_state *cs,
113 const struct conf *whoami,
114 int nvec, char **vec) {
118 error(0, "%s:%d: '%s' requires one argument",
119 cs->path, cs->line, whoami->name);
122 if((n = find_signal(vec[0])) == -1) {
123 error(0, "%s:%d: unknown signal '%s'",
124 cs->path, cs->line, vec[0]);
127 VALUE(cs->config, int) = n;
131 static int set_collections(const struct config_state *cs,
132 const struct conf *whoami,
133 int nvec, char **vec) {
134 struct collectionlist *cl;
135 const char *root, *encoding, *module;
154 error(0, "%s:%d: '%s' requires at least one argument",
155 cs->path, cs->line, whoami->name);
158 error(0, "%s:%d: '%s' requires at most three arguments",
159 cs->path, cs->line, whoami->name);
162 /* Sanity check root */
164 error(0, "%s:%d: collection root must start with '/'",
168 if(root[1] && root[strlen(root)-1] == '/') {
169 error(0, "%s:%d: collection root must not end with '/'",
177 encoding = nl_langinfo(CODESET);
178 cl = ADDRESS(cs->config, struct collectionlist);
180 cl->s = xrealloc(cl->s, cl->n * sizeof (struct collection));
181 cl->s[cl->n - 1].module = xstrdup(module);
182 cl->s[cl->n - 1].encoding = xstrdup(encoding);
183 cl->s[cl->n - 1].root = xstrdup(root);
187 static int set_boolean(const struct config_state *cs,
188 const struct conf *whoami,
189 int nvec, char **vec) {
193 error(0, "%s:%d: '%s' takes only one argument",
194 cs->path, cs->line, whoami->name);
197 if(!strcmp(vec[0], "yes")) state = 1;
198 else if(!strcmp(vec[0], "no")) state = 0;
200 error(0, "%s:%d: argument to '%s' must be 'yes' or 'no'",
201 cs->path, cs->line, whoami->name);
204 VALUE(cs->config, int) = state;
208 static int set_string(const struct config_state *cs,
209 const struct conf *whoami,
210 int nvec, char **vec) {
212 error(0, "%s:%d: '%s' takes only one argument",
213 cs->path, cs->line, whoami->name);
216 VALUE(cs->config, char *) = xstrdup(vec[0]);
220 static int set_stringlist(const struct config_state *cs,
221 const struct conf *whoami,
222 int nvec, char **vec) {
224 struct stringlist *sl;
226 sl = ADDRESS(cs->config, struct stringlist);
228 for(n = 0; n < nvec; ++n) {
230 sl->s = xrealloc(sl->s, (sl->n * sizeof (char *)));
231 sl->s[sl->n - 1] = xstrdup(vec[n]);
236 static int set_integer(const struct config_state *cs,
237 const struct conf *whoami,
238 int nvec, char **vec) {
242 error(0, "%s:%d: '%s' takes only one argument",
243 cs->path, cs->line, whoami->name);
246 if(xstrtol(ADDRESS(cs->config, long), vec[0], &e, 0)) {
247 error(errno, "%s:%d: converting integer", cs->path, cs->line);
251 error(0, "%s:%d: invalid integer syntax", cs->path, cs->line);
257 static int set_stringlist_accum(const struct config_state *cs,
258 const struct conf *whoami,
259 int nvec, char **vec) {
261 struct stringlist *s;
262 struct stringlistlist *sll;
264 sll = ADDRESS(cs->config, struct stringlistlist);
270 sll->s = xrealloc(sll->s, (sll->n * sizeof (struct stringlist)));
271 s = &sll->s[sll->n - 1];
273 s->s = xmalloc((nvec + 1) * sizeof (char *));
274 for(n = 0; n < nvec; ++n)
275 s->s[n] = xstrdup(vec[n]);
279 static int set_string_accum(const struct config_state *cs,
280 const struct conf *whoami,
281 int nvec, char **vec) {
283 struct stringlist *sl;
285 sl = ADDRESS(cs->config, struct stringlist);
290 for(n = 0; n < nvec; ++n) {
292 sl->s = xrealloc(sl->s, (sl->n * sizeof (char *)));
293 sl->s[sl->n - 1] = xstrdup(vec[n]);
298 static int set_restrict(const struct config_state *cs,
299 const struct conf *whoami,
300 int nvec, char **vec) {
304 static const struct restriction {
308 { "remove", RESTRICT_REMOVE },
309 { "scratch", RESTRICT_SCRATCH },
310 { "move", RESTRICT_MOVE },
313 for(n = 0; n < nvec; ++n) {
314 if((i = TABLE_FIND(restrictions, name, vec[n])) < 0) {
315 error(0, "%s:%d: invalid restriction '%s'",
316 cs->path, cs->line, vec[n]);
319 r |= restrictions[i].bit;
321 VALUE(cs->config, unsigned) = r;
325 static int parse_sample_format(const struct config_state *cs,
326 struct stream_header *format,
327 int nvec, char **vec) {
332 error(0, "%s:%d: wrong number of arguments", cs->path, cs->line);
335 if(xstrtol(&t, p, &p, 0)) {
336 error(errno, "%s:%d: converting bits-per-sample", cs->path, cs->line);
339 if(t != 8 && t != 16) {
340 error(0, "%s:%d: bad bite-per-sample (%ld)", cs->path, cs->line, t);
343 if(format) format->bits = t;
345 case 'l': case 'L': t = ENDIAN_LITTLE; p++; break;
346 case 'b': case 'B': t = ENDIAN_BIG; p++; break;
347 default: t = ENDIAN_NATIVE; break;
349 if(format) format->endian = t;
351 error(errno, "%s:%d: expected `/' after bits-per-sample",
356 if(xstrtol(&t, p, &p, 0)) {
357 error(errno, "%s:%d: converting sample-rate", cs->path, cs->line);
360 if(t < 1 || t > INT_MAX) {
361 error(0, "%s:%d: silly sample-rate (%ld)", cs->path, cs->line, t);
364 if(format) format->rate = t;
366 error(0, "%s:%d: expected `/' after sample-rate",
371 if(xstrtol(&t, p, &p, 0)) {
372 error(errno, "%s:%d: converting channels", cs->path, cs->line);
376 error(0, "%s:%d: silly number (%ld) of channels", cs->path, cs->line, t);
379 if(format) format->channels = t;
381 error(0, "%s:%d: junk after channels", cs->path, cs->line);
387 static int set_sample_format(const struct config_state *cs,
388 const struct conf *whoami,
389 int nvec, char **vec) {
390 return parse_sample_format(cs, ADDRESS(cs->config, struct stream_header),
394 static int set_namepart(const struct config_state *cs,
395 const struct conf *whoami,
396 int nvec, char **vec) {
397 struct namepartlist *npl = ADDRESS(cs->config, struct namepartlist);
404 error(0, "%s:%d: namepart needs at least 3 arguments", cs->path, cs->line);
408 error(0, "%s:%d: namepart needs at most 5 arguments", cs->path, cs->line);
411 reflags = nvec >= 5 ? regsub_flags(vec[4]) : 0;
412 if(!(re = pcre_compile(vec[1],
414 |regsub_compile_options(reflags),
415 &errstr, &erroffset, 0))) {
416 error(0, "%s:%d: error compiling regexp /%s/: %s (offset %d)",
417 cs->path, cs->line, vec[1], errstr, erroffset);
420 npl->s = xrealloc(npl->s, (npl->n + 1) * sizeof (struct namepart));
421 npl->s[npl->n].part = xstrdup(vec[0]);
422 npl->s[npl->n].re = re;
423 npl->s[npl->n].replace = xstrdup(vec[2]);
424 npl->s[npl->n].context = xstrdup(vec[3]);
425 npl->s[npl->n].reflags = reflags;
427 /* XXX a bit of a bodge; relies on there being very few parts. */
428 for(n = 0; (n < cs->config->nparts
429 && strcmp(cs->config->parts[n], vec[0])); ++n)
431 if(n >= cs->config->nparts) {
432 cs->config->parts = xrealloc(cs->config->parts,
433 (cs->config->nparts + 1) * sizeof (char *));
434 cs->config->parts[cs->config->nparts++] = xstrdup(vec[0]);
439 static int set_transform(const struct config_state *cs,
440 const struct conf *whoami,
441 int nvec, char **vec) {
442 struct transformlist *tl = ADDRESS(cs->config, struct transformlist);
449 error(0, "%s:%d: transform needs at least 3 arguments", cs->path, cs->line);
453 error(0, "%s:%d: transform needs at most 5 arguments", cs->path, cs->line);
456 reflags = (nvec >= 5 ? regsub_flags(vec[4]) : 0);
457 if(!(re = pcre_compile(vec[1],
459 |regsub_compile_options(reflags),
460 &errstr, &erroffset, 0))) {
461 error(0, "%s:%d: error compiling regexp /%s/: %s (offset %d)",
462 cs->path, cs->line, vec[1], errstr, erroffset);
465 tl->t = xrealloc(tl->t, (tl->n + 1) * sizeof (struct namepart));
466 tl->t[tl->n].type = xstrdup(vec[0]);
467 tl->t[tl->n].context = xstrdup(vec[3] ? vec[3] : "*");
468 tl->t[tl->n].re = re;
469 tl->t[tl->n].replace = xstrdup(vec[2]);
470 tl->t[tl->n].flags = reflags;
475 static int set_rights(const struct config_state *cs,
476 const struct conf *whoami,
477 int nvec, char **vec) {
479 error(0, "%s:%d: '%s' requires one argument",
480 cs->path, cs->line, whoami->name);
483 if(parse_rights(vec[0], 0, 1)) {
484 error(0, "%s:%d: invalid rights string '%s'",
485 cs->path, cs->line, vec[0]);
488 *ADDRESS(cs->config, char *) = vec[0];
492 static int set_netaddress(const struct config_state *cs,
493 const struct conf *whoami,
494 int nvec, char **vec) {
495 struct netaddress *na = ADDRESS(cs->config, struct netaddress);
497 if(netaddress_parse(na, nvec, vec)) {
498 error(0, "%s:%d: invalid network address", cs->path, cs->line);
506 static void free_none(struct config attribute((unused)) *c,
507 const struct conf attribute((unused)) *whoami) {
510 static void free_string(struct config *c,
511 const struct conf *whoami) {
512 xfree(VALUE(c, char *));
513 VALUE(c, char *) = 0;
516 static void free_stringlist(struct config *c,
517 const struct conf *whoami) {
519 struct stringlist *sl = ADDRESS(c, struct stringlist);
521 for(n = 0; n < sl->n; ++n)
526 static void free_stringlistlist(struct config *c,
527 const struct conf *whoami) {
529 struct stringlistlist *sll = ADDRESS(c, struct stringlistlist);
530 struct stringlist *sl;
532 for(n = 0; n < sll->n; ++n) {
534 for(m = 0; m < sl->n; ++m)
541 static void free_collectionlist(struct config *c,
542 const struct conf *whoami) {
543 struct collectionlist *cll = ADDRESS(c, struct collectionlist);
544 struct collection *cl;
547 for(n = 0; n < cll->n; ++n) {
556 static void free_namepartlist(struct config *c,
557 const struct conf *whoami) {
558 struct namepartlist *npl = ADDRESS(c, struct namepartlist);
562 for(n = 0; n < npl->n; ++n) {
565 pcre_free(np->re); /* ...whatever pcre_free is set to. */
572 static void free_transformlist(struct config *c,
573 const struct conf *whoami) {
574 struct transformlist *tl = ADDRESS(c, struct transformlist);
578 for(n = 0; n < tl->n; ++n) {
581 pcre_free(t->re); /* ...whatever pcre_free is set to. */
588 static void free_netaddress(struct config *c,
589 const struct conf *whoami) {
590 struct netaddress *na = ADDRESS(c, struct netaddress);
595 /* configuration types */
597 static const struct conftype
598 type_signal = { set_signal, free_none },
599 type_collections = { set_collections, free_collectionlist },
600 type_boolean = { set_boolean, free_none },
601 type_string = { set_string, free_string },
602 type_stringlist = { set_stringlist, free_stringlist },
603 type_integer = { set_integer, free_none },
604 type_stringlist_accum = { set_stringlist_accum, free_stringlistlist },
605 type_string_accum = { set_string_accum, free_stringlist },
606 type_sample_format = { set_sample_format, free_none },
607 type_restrict = { set_restrict, free_none },
608 type_namepart = { set_namepart, free_namepartlist },
609 type_transform = { set_transform, free_transformlist },
610 type_netaddress = { set_netaddress, free_netaddress },
611 type_rights = { set_rights, free_none };
613 /* specific validation routine */
615 #define VALIDATE_FILE(test, what) do { \
619 for(n = 0; n < nvec; ++n) { \
620 if(stat(vec[n], &sb) < 0) { \
621 error(errno, "%s:%d: %s", cs->path, cs->line, vec[n]); \
624 if(!test(sb.st_mode)) { \
625 error(0, "%s:%d: %s is not a %s", \
626 cs->path, cs->line, vec[n], what); \
632 static int validate_isabspath(const struct config_state *cs,
633 int nvec, char **vec) {
636 for(n = 0; n < nvec; ++n)
637 if(vec[n][0] != '/') {
638 error(errno, "%s:%d: %s: not an absolute path",
639 cs->path, cs->line, vec[n]);
645 static int validate_isdir(const struct config_state *cs,
646 int nvec, char **vec) {
647 VALIDATE_FILE(S_ISDIR, "directory");
651 static int validate_isreg(const struct config_state *cs,
652 int nvec, char **vec) {
653 VALIDATE_FILE(S_ISREG, "regular file");
657 static int validate_player(const struct config_state *cs,
659 char attribute((unused)) **vec) {
661 error(0, "%s:%d: should be at least 'player PATTERN MODULE'",
668 static int validate_tracklength(const struct config_state *cs,
670 char attribute((unused)) **vec) {
672 error(0, "%s:%d: should be at least 'tracklength PATTERN MODULE'",
679 static int validate_allow(const struct config_state *cs,
681 char attribute((unused)) **vec) {
683 error(0, "%s:%d: must be 'allow NAME PASS'", cs->path, cs->line);
689 static int validate_non_negative(const struct config_state *cs,
690 int nvec, char **vec) {
694 error(0, "%s:%d: missing argument", cs->path, cs->line);
698 error(0, "%s:%d: too many arguments", cs->path, cs->line);
701 if(xstrtol(&n, vec[0], 0, 0)) {
702 error(0, "%s:%d: %s", cs->path, cs->line, strerror(errno));
706 error(0, "%s:%d: must not be negative", cs->path, cs->line);
712 static int validate_positive(const struct config_state *cs,
713 int nvec, char **vec) {
717 error(0, "%s:%d: missing argument", cs->path, cs->line);
721 error(0, "%s:%d: too many arguments", cs->path, cs->line);
724 if(xstrtol(&n, vec[0], 0, 0)) {
725 error(0, "%s:%d: %s", cs->path, cs->line, strerror(errno));
729 error(0, "%s:%d: must be positive", cs->path, cs->line);
735 static int validate_isauser(const struct config_state *cs,
736 int attribute((unused)) nvec,
740 if(!(pw = getpwnam(vec[0]))) {
741 error(0, "%s:%d: no such user as '%s'", cs->path, cs->line, vec[0]);
747 static int validate_sample_format(const struct config_state *cs,
748 int attribute((unused)) nvec,
750 return parse_sample_format(cs, 0, nvec, vec);
753 static int validate_any(const struct config_state attribute((unused)) *cs,
754 int attribute((unused)) nvec,
755 char attribute((unused)) **vec) {
759 static int validate_url(const struct config_state attribute((unused)) *cs,
760 int attribute((unused)) nvec,
764 /* absoluteURI = scheme ":" ( hier_part | opaque_part )
765 scheme = alpha *( alpha | digit | "+" | "-" | "." ) */
767 n = strspn(s, ("abcdefghijklmnopqrstuvwxyz"
768 "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
771 error(0, "%s:%d: invalid url '%s'", cs->path, cs->line, vec[0]);
774 if(!strncmp(s, "http:", 5)
775 || !strncmp(s, "https:", 6)) {
777 /* we only do a rather cursory check */
778 if(strncmp(s, "//", 2)) {
779 error(0, "%s:%d: invalid url '%s'", cs->path, cs->line, vec[0]);
786 static int validate_alias(const struct config_state *cs,
790 int in_brackets = 0, c;
793 error(0, "%s:%d: missing argument", cs->path, cs->line);
797 error(0, "%s:%d: too many arguments", cs->path, cs->line);
801 while((c = (unsigned char)*s++)) {
805 else if(!isalnum(c)) {
806 error(0, "%s:%d: invalid part name in alias expansion in '%s'",
807 cs->path, cs->line, vec[0]);
815 } else if(c == '\\') {
816 if(!(c = (unsigned char)*s++)) {
817 error(0, "%s:%d: unterminated escape in alias expansion in '%s'",
818 cs->path, cs->line, vec[0]);
820 } else if(c != '\\' && c != '{') {
821 error(0, "%s:%d: invalid escape in alias expansion in '%s'",
822 cs->path, cs->line, vec[0]);
830 error(0, "%s:%d: unterminated part name in alias expansion in '%s'",
831 cs->path, cs->line, vec[0]);
837 static int validate_algo(const struct config_state attribute((unused)) *cs,
841 error(0, "%s:%d: invalid algorithm specification", cs->path, cs->line);
844 if(!valid_authhash(vec[0])) {
845 error(0, "%s:%d: unsuported algorithm '%s'", cs->path, cs->line, vec[0]);
851 static int validate_backend(const struct config_state attribute((unused)) *cs,
856 error(0, "%s:%d: invalid sound API specification", cs->path, cs->line);
859 if(!strcmp(vec[0], "network")) {
860 error(0, "'api network' is deprecated; use 'api rtp'");
863 if(config_uaudio_apis) {
864 for(n = 0; config_uaudio_apis[n]; ++n)
865 if(!strcmp(vec[0], config_uaudio_apis[n]->name))
867 error(0, "%s:%d: unrecognized sound API '%s'", cs->path, cs->line, vec[0]);
870 /* In non-server processes we have no idea what's valid */
874 static int validate_pausemode(const struct config_state attribute((unused)) *cs,
877 if(nvec == 1 && (!strcmp(vec[0], "silence") || !strcmp(vec[0], "suspend")))
879 error(0, "%s:%d: invalid pause mode", cs->path, cs->line);
883 static int validate_destaddr(const struct config_state attribute((unused)) *cs,
886 struct netaddress na[1];
888 if(netaddress_parse(na, nvec, vec)) {
889 error(0, "%s:%d: invalid network address", cs->path, cs->line);
893 error(0, "%s:%d: destination address required", cs->path, cs->line);
899 /** @brief Item name and and offset */
900 #define C(x) #x, offsetof(struct config, x)
901 /** @brief Item name and and offset */
902 #define C2(x,y) #x, offsetof(struct config, y)
904 /** @brief All configuration items */
905 static const struct conf conf[] = {
906 { C(alias), &type_string, validate_alias },
907 { C(allow), &type_stringlist_accum, validate_allow },
908 { C(api), &type_string, validate_backend },
909 { C(authorization_algorithm), &type_string, validate_algo },
910 { C(broadcast), &type_netaddress, validate_destaddr },
911 { C(broadcast_from), &type_netaddress, validate_any },
912 { C(channel), &type_string, validate_any },
913 { C(checkpoint_kbyte), &type_integer, validate_non_negative },
914 { C(checkpoint_min), &type_integer, validate_non_negative },
915 { C(collection), &type_collections, validate_any },
916 { C(connect), &type_netaddress, validate_destaddr },
917 { C(cookie_login_lifetime), &type_integer, validate_positive },
918 { C(cookie_key_lifetime), &type_integer, validate_positive },
919 { C(dbversion), &type_integer, validate_positive },
920 { C(default_rights), &type_rights, validate_any },
921 { C(device), &type_string, validate_any },
922 { C(gap), &type_integer, validate_non_negative },
923 { C(history), &type_integer, validate_positive },
924 { C(home), &type_string, validate_isabspath },
925 { C(listen), &type_netaddress, validate_any },
926 { C(lock), &type_boolean, validate_any },
927 { C(mail_sender), &type_string, validate_any },
928 { C(mixer), &type_string, validate_any },
929 { C(multicast_loop), &type_boolean, validate_any },
930 { C(multicast_ttl), &type_integer, validate_non_negative },
931 { C(namepart), &type_namepart, validate_any },
932 { C(new_bias), &type_integer, validate_positive },
933 { C(new_bias_age), &type_integer, validate_positive },
934 { C(new_max), &type_integer, validate_positive },
935 { C2(nice, nice_rescan), &type_integer, validate_non_negative },
936 { C(nice_rescan), &type_integer, validate_non_negative },
937 { C(nice_server), &type_integer, validate_any },
938 { C(nice_speaker), &type_integer, validate_any },
939 { C(noticed_history), &type_integer, validate_positive },
940 { C(password), &type_string, validate_any },
941 { C(pause_mode), &type_string, validate_pausemode },
942 { C(player), &type_stringlist_accum, validate_player },
943 { C(plugins), &type_string_accum, validate_isdir },
944 { C(prefsync), &type_integer, validate_positive },
945 { C(queue_pad), &type_integer, validate_positive },
946 { C(replay_min), &type_integer, validate_non_negative },
947 { C(refresh), &type_integer, validate_positive },
948 { C(reminder_interval), &type_integer, validate_positive },
949 { C(remote_userman), &type_boolean, validate_any },
950 { C2(restrict, restrictions), &type_restrict, validate_any },
951 { C(rtp_delay_threshold), &type_integer, validate_positive },
952 { C(sample_format), &type_sample_format, validate_sample_format },
953 { C(scratch), &type_string_accum, validate_isreg },
954 { C(sendmail), &type_string, validate_isabspath },
955 { C(short_display), &type_integer, validate_positive },
956 { C(signal), &type_signal, validate_any },
957 { C(smtp_server), &type_string, validate_any },
958 { C(sox_generation), &type_integer, validate_non_negative },
959 { C2(speaker_backend, api), &type_string, validate_backend },
960 { C(speaker_command), &type_string, validate_any },
961 { C(stopword), &type_string_accum, validate_any },
962 { C(templates), &type_string_accum, validate_isdir },
963 { C(tracklength), &type_stringlist_accum, validate_tracklength },
964 { C(transform), &type_transform, validate_any },
965 { C(trust), &type_string_accum, validate_any },
966 { C(url), &type_string, validate_url },
967 { C(user), &type_string, validate_isauser },
968 { C(username), &type_string, validate_any },
971 /** @brief Find a configuration item's definition by key */
972 static const struct conf *find(const char *key) {
975 if((n = TABLE_FIND(conf, name, key)) < 0)
980 /** @brief Set a new configuration value */
981 static int config_set(const struct config_state *cs,
982 int nvec, char **vec) {
983 const struct conf *which;
985 D(("config_set %s", vec[0]));
986 if(!(which = find(vec[0]))) {
987 error(0, "%s:%d: unknown configuration key '%s'",
988 cs->path, cs->line, vec[0]);
991 return (which->validate(cs, nvec - 1, vec + 1)
992 || which->type->set(cs, which, nvec - 1, vec + 1));
995 static int config_set_args(const struct config_state *cs,
996 const char *which, ...) {
1002 vector_append(v, (char *)which);
1003 va_start(ap, which);
1004 while((s = va_arg(ap, char *)))
1005 vector_append(v, s);
1007 vector_terminate(v);
1008 return config_set(cs, v->nvec, v->vec);
1011 /** @brief Error callback used by config_include() */
1012 static void config_error(const char *msg, void *u) {
1013 const struct config_state *cs = u;
1015 error(0, "%s:%d: %s", cs->path, cs->line, msg);
1018 /** @brief Include a file by name */
1019 static int config_include(struct config *c, const char *path) {
1021 char *buffer, *inputbuffer, **vec;
1023 struct config_state cs;
1028 D(("%s: reading configuration", path));
1029 if(!(fp = fopen(path, "r"))) {
1030 error(errno, "error opening %s", path);
1033 while(!inputline(path, fp, &inputbuffer, '\n')) {
1035 if(!(buffer = mb2utf8(inputbuffer))) {
1036 error(errno, "%s:%d: cannot convert to UTF-8", cs.path, cs.line);
1042 if(!(vec = split(buffer, &n, SPLIT_COMMENTS|SPLIT_QUOTES,
1043 config_error, &cs))) {
1049 if(!strcmp(vec[0], "include")) {
1051 error(0, "%s:%d: must be 'include PATH'", cs.path, cs.line);
1054 config_include(c, vec[1]);
1056 ret |= config_set(&cs, n, vec);
1058 for(n = 0; vec[n]; ++n) xfree(vec[n]);
1063 error(errno, "error reading %s", path);
1070 static const char *const default_stopwords[] = {
1129 #define NDEFAULT_STOPWORDS (sizeof default_stopwords / sizeof *default_stopwords)
1131 static const char *const default_players[] = {
1137 #define NDEFAULT_PLAYERS (sizeof default_players / sizeof *default_players)
1139 /** @brief Make a new default configuration */
1140 static struct config *config_default(void) {
1141 struct config *c = xmalloc(sizeof *c);
1142 const char *logname;
1144 struct config_state cs;
1147 cs.path = "<internal>";
1150 /* Strings had better be xstrdup'd as they will get freed at some point. */
1153 c->home = xstrdup(pkgstatedir);
1154 if(!(pw = getpwuid(getuid())))
1155 fatal(0, "cannot determine our username");
1156 logname = pw->pw_name;
1157 c->username = xstrdup(logname);
1160 c->signal = SIGKILL;
1161 c->alias = xstrdup("{/artist}{/album}{/title}{ext}");
1163 c->device = xstrdup("default");
1164 c->nice_rescan = 10;
1165 c->speaker_command = 0;
1166 c->sample_format.bits = 16;
1167 c->sample_format.rate = 44100;
1168 c->sample_format.channels = 2;
1169 c->sample_format.endian = ENDIAN_NATIVE;
1171 c->replay_min = 8 * 3600;
1173 c->multicast_ttl = 1;
1174 c->multicast_loop = 1;
1175 c->authorization_algorithm = xstrdup("sha1");
1176 c->noticed_history = 31;
1177 c->short_display = 32;
1181 c->cookie_login_lifetime = 86400;
1182 c->cookie_key_lifetime = 86400 * 7;
1183 if(sendmail_binary[0] && strcmp(sendmail_binary, "none"))
1184 c->sendmail = xstrdup(sendmail_binary);
1185 c->smtp_server = xstrdup("127.0.0.1");
1187 c->reminder_interval = 600; /* 10m */
1188 c->new_bias_age = 7 * 86400; /* 1 week */
1189 c->new_bias = 4500000; /* 50 times the base weight */
1190 c->sox_generation = DEFAULT_SOX_GENERATION;
1191 /* Default stopwords */
1192 if(config_set(&cs, (int)NDEFAULT_STOPWORDS, (char **)default_stopwords))
1194 /* Default player configuration */
1195 for(n = 0; n < NDEFAULT_PLAYERS; ++n) {
1196 if(config_set_args(&cs, "player",
1197 default_players[n], "execraw", "disorder-decode", (char *)0))
1199 if(config_set_args(&cs, "tracklength",
1200 default_players[n], "disorder-tracklength", (char *)0))
1203 c->broadcast.af = -1;
1204 c->broadcast_from.af = -1;
1210 char *config_get_file2(struct config *c, const char *name) {
1213 byte_xasprintf(&s, "%s/%s", c->home, name);
1217 /** @brief Set the default configuration file */
1218 static void set_configfile(void) {
1220 byte_xasprintf(&configfile, "%s/config", pkgconfdir);
1223 /** @brief Free a configuration object */
1224 static void config_free(struct config *c) {
1228 for(n = 0; n < (int)(sizeof conf / sizeof *conf); ++n)
1229 conf[n].type->free(c, &conf[n]);
1230 for(n = 0; n < c->nparts; ++n)
1237 /** @brief Set post-parse defaults */
1238 static void config_postdefaults(struct config *c,
1240 struct config_state cs;
1241 const struct conf *whoami;
1244 static const char *namepart[][4] = {
1245 { "title", "/([0-9]+ *[-:]? *)?([^/]+)\\.[a-zA-Z0-9]+$", "$2", "display" },
1246 { "title", "/([^/]+)\\.[a-zA-Z0-9]+$", "$1", "sort" },
1247 { "album", "/([^/]+)/[^/]+$", "$1", "*" },
1248 { "artist", "/([^/]+)/[^/]+/[^/]+$", "$1", "*" },
1249 { "ext", "(\\.[a-zA-Z0-9]+)$", "$1", "*" },
1251 #define NNAMEPART (int)(sizeof namepart / sizeof *namepart)
1253 static const char *transform[][5] = {
1254 { "track", "^.*/([0-9]+ *[-:]? *)?([^/]+)\\.[a-zA-Z0-9]+$", "$2", "display", "" },
1255 { "track", "^.*/([^/]+)\\.[a-zA-Z0-9]+$", "$1", "sort", "" },
1256 { "dir", "^.*/([^/]+)$", "$1", "*", "" },
1257 { "dir", "^(the) ([^/]*)", "$2, $1", "sort", "i", },
1258 { "dir", "[[:punct:]]", "", "sort", "g", }
1260 #define NTRANSFORM (int)(sizeof transform / sizeof *transform)
1262 cs.path = "<internal>";
1265 if(!c->namepart.n) {
1266 whoami = find("namepart");
1267 for(n = 0; n < NNAMEPART; ++n)
1268 set_namepart(&cs, whoami, 4, (char **)namepart[n]);
1270 if(!c->transform.n) {
1271 whoami = find("transform");
1272 for(n = 0; n < NTRANSFORM; ++n)
1273 set_transform(&cs, whoami, 5, (char **)transform[n]);
1276 if(c->speaker_command)
1277 c->api = xstrdup("command");
1278 else if(c->broadcast.af != -1)
1279 c->api = xstrdup("rtp");
1280 else if(config_uaudio_apis)
1281 c->api = xstrdup(config_uaudio_apis[0]->name);
1283 c->api = xstrdup("<none>");
1285 if(!strcmp(c->api, "network"))
1286 c->api = xstrdup("rtp");
1288 if(!strcmp(c->api, "command") && !c->speaker_command)
1289 fatal(0, "'api command' but speaker_command is not set");
1290 if((!strcmp(c->api, "rtp")) && c->broadcast.af == -1)
1291 fatal(0, "'api rtp' but broadcast is not set");
1293 /* Override sample format */
1294 if(!strcmp(c->api, "rtp")) {
1295 c->sample_format.rate = 44100;
1296 c->sample_format.channels = 2;
1297 c->sample_format.bits = 16;
1298 c->sample_format.endian = ENDIAN_NATIVE;
1300 if(!strcmp(c->api, "coreaudio")) {
1301 c->sample_format.rate = 44100;
1302 c->sample_format.channels = 2;
1303 c->sample_format.bits = 16;
1304 c->sample_format.endian = ENDIAN_NATIVE;
1306 if(!c->default_rights) {
1307 rights_type r = RIGHTS__MASK & ~(RIGHT_ADMIN|RIGHT_REGISTER
1309 |RIGHT_SCRATCH__MASK
1310 |RIGHT_REMOVE__MASK);
1311 /* The idea is to approximate the meaning of the old 'restrict' directive
1312 * in the default rights if they are not overridden. */
1313 if(c->restrictions & RESTRICT_SCRATCH)
1314 r |= RIGHT_SCRATCH_MINE|RIGHT_SCRATCH_RANDOM;
1316 r |= RIGHT_SCRATCH_ANY;
1317 if(!(c->restrictions & RESTRICT_MOVE))
1318 r |= RIGHT_MOVE_ANY;
1319 if(c->restrictions & RESTRICT_REMOVE)
1320 r |= RIGHT_REMOVE_MINE;
1322 r |= RIGHT_REMOVE_ANY;
1323 c->default_rights = rights_string(r);
1327 /** @brief (Re-)read the config file
1328 * @param server If set, do extra checking
1329 * @param oldconfig Old configuration for compatibility check
1330 * @return 0 on success, non-0 on error
1332 * If @p oldconfig is set, then certain compatibility checks are done between
1333 * the old and new configurations.
1335 int config_read(int server,
1336 const struct config *oldconfig) {
1342 c = config_default();
1343 /* standalone Disobedience installs might not have a global config file */
1344 if(access(configfile, F_OK) == 0)
1345 if(config_include(c, configfile))
1347 /* if we can read the private config file, do */
1348 if((privconf = config_private())
1349 && access(privconf, R_OK) == 0
1350 && config_include(c, privconf))
1353 /* if there's a per-user system config file for this user, read it */
1354 if(config_per_user) {
1355 if(!(pw = getpwuid(getuid())))
1356 fatal(0, "cannot determine our username");
1357 if((privconf = config_usersysconf(pw))
1358 && access(privconf, F_OK) == 0
1359 && config_include(c, privconf))
1362 /* if we have a password file, read it */
1363 if((privconf = config_userconf(0, pw))
1364 && access(privconf, F_OK) == 0
1365 && config_include(c, privconf))
1369 /* install default namepart and transform settings */
1370 config_postdefaults(c, server);
1373 if(strcmp(c->home, oldconfig->home)) {
1374 error(0, "'home' cannot be changed without a restart");
1377 if(strcmp(c->alias, oldconfig->alias)) {
1378 error(0, "'alias' cannot be changed without a restart");
1381 if(strcmp(c->user, oldconfig->user)) {
1382 error(0, "'user' cannot be changed without a restart");
1385 if(c->nice_speaker != oldconfig->nice_speaker) {
1386 error(0, "'nice_speaker' cannot be changed without a restart");
1387 /* ...but we accept the new config anyway */
1392 error(0, "not installing incompatible new configuration");
1396 /* everything is good so we shall use the new config */
1397 config_free(config);
1398 /* warn about obsolete directives */
1400 error(0, "'restrict' will be removed in a future version");
1402 error(0, "'allow' will be removed in a future version");
1404 error(0, "'trust' will be removed in a future version");
1406 error(0, "'lock' will be removed in a future version");
1408 error(0, "'gap' will be removed in a future version");
1410 error(0, "'prefsync' will be removed in a future version");
1415 /** @brief Return the path to the private configuration file */
1416 char *config_private(void) {
1420 byte_xasprintf(&s, "%s.private", configfile);
1424 /** @brief Return the path to user's personal configuration file */
1425 char *config_userconf(const char *home, const struct passwd *pw) {
1428 if(!home && !pw && !(pw = getpwuid(getuid())))
1429 fatal(0, "cannot determine our username");
1430 byte_xasprintf(&s, "%s/.disorder/passwd", home ? home : pw->pw_dir);
1434 /** @brief Return the path to user-specific system configuration */
1435 char *config_usersysconf(const struct passwd *pw) {
1439 if(!strchr(pw->pw_name, '/')) {
1440 byte_xasprintf(&s, "%s.%s", configfile, pw->pw_name);
1446 char *config_get_file(const char *name) {
1447 return config_get_file2(config, name);