2 * This file is part of DisOrder.
3 * Copyright (C) 2004-2010 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 default 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 */
76 /** @brief Line number */
79 /** @brief Configuration object under construction */
80 struct config *config;
83 /** @brief Current configuration */
84 struct config *config;
86 /** @brief One configuration item */
88 /** @brief Name as it appears in the config file */
91 /** @brief Offset in @ref config structure */
94 /** @brief Pointer to item type */
95 const struct conftype *type;
97 /** @brief Pointer to item-specific validation routine
98 * @param cs Configuration state
99 * @param nvec Length of (proposed) new value
100 * @param vec Elements of new value
101 * @return 0 on success, non-0 on error
103 * The validate function should report any error it detects.
105 int (*validate)(const struct config_state *cs,
106 int nvec, char **vec);
109 /** @brief Type of a configuration item */
111 /** @brief Pointer to function to set item
112 * @param cs Configuration state
113 * @param whoami Configuration item to set
114 * @param nvec Length of new value
115 * @param vec New value
116 * @return 0 on success, non-0 on error
118 int (*set)(const struct config_state *cs,
119 const struct conf *whoami,
120 int nvec, char **vec);
122 /** @brief Pointer to function to free item
123 * @param c Configuration structure to free an item of
124 * @param whoami Configuration item to free
126 void (*free)(struct config *c, const struct conf *whoami);
129 /** @brief Compute the address of an item */
130 #define ADDRESS(C, TYPE) ((TYPE *)((char *)(C) + whoami->offset))
131 /** @brief Return the value of an item */
132 #define VALUE(C, TYPE) (*ADDRESS(C, TYPE))
134 static int stringlist_compare(const struct stringlist *a,
135 const struct stringlist *b);
136 static int namepartlist_compare(const struct namepartlist *a,
137 const struct namepartlist *b);
139 static int set_signal(const struct config_state *cs,
140 const struct conf *whoami,
141 int nvec, char **vec) {
145 disorder_error(0, "%s:%d: '%s' requires one argument",
146 cs->path, cs->line, whoami->name);
149 if((n = find_signal(vec[0])) == -1) {
150 disorder_error(0, "%s:%d: unknown signal '%s'",
151 cs->path, cs->line, vec[0]);
154 VALUE(cs->config, int) = n;
158 static int set_collections(const struct config_state *cs,
159 const struct conf *whoami,
160 int nvec, char **vec) {
161 struct collectionlist *cl;
162 const char *root, *encoding, *module;
181 disorder_error(0, "%s:%d: '%s' requires at least one argument",
182 cs->path, cs->line, whoami->name);
185 disorder_error(0, "%s:%d: '%s' requires at most three arguments",
186 cs->path, cs->line, whoami->name);
189 /* Sanity check root */
191 disorder_error(0, "%s:%d: collection root must start with '/'",
195 if(root[1] && root[strlen(root)-1] == '/') {
196 disorder_error(0, "%s:%d: collection root must not end with '/'",
204 encoding = nl_langinfo(CODESET);
205 cl = ADDRESS(cs->config, struct collectionlist);
207 cl->s = xrealloc(cl->s, cl->n * sizeof (struct collection));
208 cl->s[cl->n - 1].module = xstrdup(module);
209 cl->s[cl->n - 1].encoding = xstrdup(encoding);
210 cl->s[cl->n - 1].root = xstrdup(root);
214 static int set_boolean(const struct config_state *cs,
215 const struct conf *whoami,
216 int nvec, char **vec) {
220 disorder_error(0, "%s:%d: '%s' takes only one argument",
221 cs->path, cs->line, whoami->name);
224 if(!strcmp(vec[0], "yes")) state = 1;
225 else if(!strcmp(vec[0], "no")) state = 0;
227 disorder_error(0, "%s:%d: argument to '%s' must be 'yes' or 'no'",
228 cs->path, cs->line, whoami->name);
231 VALUE(cs->config, int) = state;
235 static int set_string(const struct config_state *cs,
236 const struct conf *whoami,
237 int nvec, char **vec) {
239 disorder_error(0, "%s:%d: '%s' takes only one argument",
240 cs->path, cs->line, whoami->name);
243 xfree(VALUE(cs->config, char *));
244 VALUE(cs->config, char *) = xstrdup(vec[0]);
248 static int set_stringlist(const struct config_state *cs,
249 const struct conf *whoami,
250 int nvec, char **vec) {
252 struct stringlist *sl;
254 sl = ADDRESS(cs->config, struct stringlist);
256 for(n = 0; n < nvec; ++n) {
258 sl->s = xrealloc(sl->s, (sl->n * sizeof (char *)));
259 sl->s[sl->n - 1] = xstrdup(vec[n]);
264 static int set_integer(const struct config_state *cs,
265 const struct conf *whoami,
266 int nvec, char **vec) {
270 disorder_error(0, "%s:%d: '%s' takes only one argument",
271 cs->path, cs->line, whoami->name);
274 if(xstrtol(ADDRESS(cs->config, long), vec[0], &e, 0)) {
275 disorder_error(errno, "%s:%d: converting integer", cs->path, cs->line);
279 disorder_error(0, "%s:%d: invalid integer syntax", cs->path, cs->line);
285 static int set_stringlist_accum(const struct config_state *cs,
286 const struct conf *whoami,
287 int nvec, char **vec) {
289 struct stringlist *s;
290 struct stringlistlist *sll;
292 sll = ADDRESS(cs->config, struct stringlistlist);
298 sll->s = xrealloc(sll->s, (sll->n * sizeof (struct stringlist)));
299 s = &sll->s[sll->n - 1];
301 s->s = xmalloc((nvec + 1) * sizeof (char *));
302 for(n = 0; n < nvec; ++n)
303 s->s[n] = xstrdup(vec[n]);
307 static int set_string_accum(const struct config_state *cs,
308 const struct conf *whoami,
309 int nvec, char **vec) {
311 struct stringlist *sl;
313 sl = ADDRESS(cs->config, struct stringlist);
318 for(n = 0; n < nvec; ++n) {
320 sl->s = xrealloc(sl->s, (sl->n * sizeof (char *)));
321 sl->s[sl->n - 1] = xstrdup(vec[n]);
326 static int set_restrict(const struct config_state *cs,
327 const struct conf *whoami,
328 int nvec, char **vec) {
332 static const struct restriction {
336 { "remove", RESTRICT_REMOVE },
337 { "scratch", RESTRICT_SCRATCH },
338 { "move", RESTRICT_MOVE },
341 for(n = 0; n < nvec; ++n) {
342 if((i = TABLE_FIND(restrictions, name, vec[n])) < 0) {
343 disorder_error(0, "%s:%d: invalid restriction '%s'",
344 cs->path, cs->line, vec[n]);
347 r |= restrictions[i].bit;
349 VALUE(cs->config, unsigned) = r;
353 static int parse_sample_format(const struct config_state *cs,
354 struct stream_header *format,
355 int nvec, char **vec) {
360 disorder_error(0, "%s:%d: wrong number of arguments", cs->path, cs->line);
363 if(xstrtol(&t, p, &p, 0)) {
364 disorder_error(errno, "%s:%d: converting bits-per-sample",
368 if(t != 8 && t != 16) {
369 disorder_error(0, "%s:%d: bad bits-per-sample (%ld)",
370 cs->path, cs->line, t);
373 if(format) format->bits = t;
375 case 'l': case 'L': t = ENDIAN_LITTLE; p++; break;
376 case 'b': case 'B': t = ENDIAN_BIG; p++; break;
377 default: t = ENDIAN_NATIVE; break;
379 if(format) format->endian = t;
381 disorder_error(errno, "%s:%d: expected `/' after bits-per-sample",
386 if(xstrtol(&t, p, &p, 0)) {
387 disorder_error(errno, "%s:%d: converting sample-rate", cs->path, cs->line);
390 if(t < 1 || t > INT_MAX) {
391 disorder_error(0, "%s:%d: silly sample-rate (%ld)", cs->path, cs->line, t);
394 if(format) format->rate = t;
396 disorder_error(0, "%s:%d: expected `/' after sample-rate",
401 if(xstrtol(&t, p, &p, 0)) {
402 disorder_error(errno, "%s:%d: converting channels", cs->path, cs->line);
406 disorder_error(0, "%s:%d: silly number (%ld) of channels",
407 cs->path, cs->line, t);
410 if(format) format->channels = t;
412 disorder_error(0, "%s:%d: junk after channels", cs->path, cs->line);
418 static int set_sample_format(const struct config_state *cs,
419 const struct conf *whoami,
420 int nvec, char **vec) {
421 return parse_sample_format(cs, ADDRESS(cs->config, struct stream_header),
425 static int set_namepart(const struct config_state *cs,
426 const struct conf *whoami,
427 int nvec, char **vec) {
428 struct namepartlist *npl = ADDRESS(cs->config, struct namepartlist);
435 disorder_error(0, "%s:%d: namepart needs at least 3 arguments",
440 disorder_error(0, "%s:%d: namepart needs at most 5 arguments",
444 reflags = nvec >= 5 ? regsub_flags(vec[4]) : 0;
445 if(!(re = pcre_compile(vec[1],
447 |regsub_compile_options(reflags),
448 &errstr, &erroffset, 0))) {
449 disorder_error(0, "%s:%d: compiling regexp /%s/: %s (offset %d)",
450 cs->path, cs->line, vec[1], errstr, erroffset);
453 npl->s = xrealloc(npl->s, (npl->n + 1) * sizeof (struct namepart));
454 npl->s[npl->n].part = xstrdup(vec[0]);
455 npl->s[npl->n].re = re;
456 npl->s[npl->n].res = xstrdup(vec[1]);
457 npl->s[npl->n].replace = xstrdup(vec[2]);
458 npl->s[npl->n].context = xstrdup(vec[3]);
459 npl->s[npl->n].reflags = reflags;
461 /* XXX a bit of a bodge; relies on there being very few parts. */
462 for(n = 0; (n < cs->config->nparts
463 && strcmp(cs->config->parts[n], vec[0])); ++n)
465 if(n >= cs->config->nparts) {
466 cs->config->parts = xrealloc(cs->config->parts,
467 (cs->config->nparts + 1) * sizeof (char *));
468 cs->config->parts[cs->config->nparts++] = xstrdup(vec[0]);
473 static int set_transform(const struct config_state *cs,
474 const struct conf *whoami,
475 int nvec, char **vec) {
476 struct transformlist *tl = ADDRESS(cs->config, struct transformlist);
483 disorder_error(0, "%s:%d: transform needs at least 3 arguments",
488 disorder_error(0, "%s:%d: transform needs at most 5 arguments",
492 reflags = (nvec >= 5 ? regsub_flags(vec[4]) : 0);
493 if(!(re = pcre_compile(vec[1],
495 |regsub_compile_options(reflags),
496 &errstr, &erroffset, 0))) {
497 disorder_error(0, "%s:%d: compiling regexp /%s/: %s (offset %d)",
498 cs->path, cs->line, vec[1], errstr, erroffset);
501 tl->t = xrealloc(tl->t, (tl->n + 1) * sizeof (struct namepart));
502 tl->t[tl->n].type = xstrdup(vec[0]);
503 tl->t[tl->n].context = xstrdup(vec[3] ? vec[3] : "*");
504 tl->t[tl->n].re = re;
505 tl->t[tl->n].replace = xstrdup(vec[2]);
506 tl->t[tl->n].flags = reflags;
511 static int set_rights(const struct config_state *cs,
512 const struct conf *whoami,
513 int nvec, char **vec) {
515 disorder_error(0, "%s:%d: '%s' requires one argument",
516 cs->path, cs->line, whoami->name);
519 if(parse_rights(vec[0], 0, 1)) {
520 disorder_error(0, "%s:%d: invalid rights string '%s'",
521 cs->path, cs->line, vec[0]);
524 return set_string(cs, whoami, nvec, vec);
527 static int set_netaddress(const struct config_state *cs,
528 const struct conf *whoami,
529 int nvec, char **vec) {
530 struct netaddress *na = ADDRESS(cs->config, struct netaddress);
532 if(netaddress_parse(na, nvec, vec)) {
533 disorder_error(0, "%s:%d: invalid network address", cs->path, cs->line);
541 static void free_none(struct config attribute((unused)) *c,
542 const struct conf attribute((unused)) *whoami) {
545 static void free_string(struct config *c,
546 const struct conf *whoami) {
547 xfree(VALUE(c, char *));
548 VALUE(c, char *) = 0;
551 static void free_stringlist(struct config *c,
552 const struct conf *whoami) {
554 struct stringlist *sl = ADDRESS(c, struct stringlist);
556 for(n = 0; n < sl->n; ++n)
561 static void free_stringlistlist(struct config *c,
562 const struct conf *whoami) {
564 struct stringlistlist *sll = ADDRESS(c, struct stringlistlist);
565 struct stringlist *sl;
567 for(n = 0; n < sll->n; ++n) {
569 for(m = 0; m < sl->n; ++m)
576 static void free_collectionlist(struct config *c,
577 const struct conf *whoami) {
578 struct collectionlist *cll = ADDRESS(c, struct collectionlist);
579 struct collection *cl;
582 for(n = 0; n < cll->n; ++n) {
591 static void free_namepartlist(struct config *c,
592 const struct conf *whoami) {
593 struct namepartlist *npl = ADDRESS(c, struct namepartlist);
597 for(n = 0; n < npl->n; ++n) {
600 pcre_free(np->re); /* ...whatever pcre_free is set to. */
608 static void free_transformlist(struct config *c,
609 const struct conf *whoami) {
610 struct transformlist *tl = ADDRESS(c, struct transformlist);
614 for(n = 0; n < tl->n; ++n) {
617 pcre_free(t->re); /* ...whatever pcre_free is set to. */
624 static void free_netaddress(struct config *c,
625 const struct conf *whoami) {
626 struct netaddress *na = ADDRESS(c, struct netaddress);
631 /* configuration types */
633 static const struct conftype
634 type_signal = { set_signal, free_none },
635 type_collections = { set_collections, free_collectionlist },
636 type_boolean = { set_boolean, free_none },
637 type_string = { set_string, free_string },
638 type_stringlist = { set_stringlist, free_stringlist },
639 type_integer = { set_integer, free_none },
640 type_stringlist_accum = { set_stringlist_accum, free_stringlistlist },
641 type_string_accum = { set_string_accum, free_stringlist },
642 type_sample_format = { set_sample_format, free_none },
643 type_restrict = { set_restrict, free_none },
644 type_namepart = { set_namepart, free_namepartlist },
645 type_transform = { set_transform, free_transformlist },
646 type_netaddress = { set_netaddress, free_netaddress },
647 type_rights = { set_rights, free_string };
649 /* specific validation routine */
651 /** @brief Perform a test on a filename
652 * @param test Test function to call on mode bits
653 * @param what Type of file sought
655 * If @p test returns 0 then the file is not a @p what and an error
656 * is reported and -1 is returned.
658 #define VALIDATE_FILE(test, what) do { \
662 for(n = 0; n < nvec; ++n) { \
663 if(stat(vec[n], &sb) < 0) { \
664 disorder_error(errno, "%s:%d: %s", \
665 cs->path, cs->line, vec[n]); \
668 if(!test(sb.st_mode)) { \
669 disorder_error(0, "%s:%d: %s is not a %s", \
670 cs->path, cs->line, vec[n], what); \
676 /** @brief Validate an absolute path
677 * @param cs Configuration state
678 * @param nvec Length of (proposed) new value
679 * @param vec Elements of new value
680 * @return 0 on success, non-0 on error
682 static int validate_isabspath(const struct config_state *cs,
683 int nvec, char **vec) {
686 for(n = 0; n < nvec; ++n)
687 if(vec[n][0] != '/') {
688 disorder_error(errno, "%s:%d: %s: not an absolute path",
689 cs->path, cs->line, vec[n]);
695 /** @brief Validate an existing directory
696 * @param cs Configuration state
697 * @param nvec Length of (proposed) new value
698 * @param vec Elements of new value
699 * @return 0 on success, non-0 on error
701 static int validate_isdir(const struct config_state *cs,
702 int nvec, char **vec) {
703 VALIDATE_FILE(S_ISDIR, "directory");
707 /** @brief Validate an existing regular file
708 * @param cs Configuration state
709 * @param nvec Length of (proposed) new value
710 * @param vec Elements of new value
711 * @return 0 on success, non-0 on error
713 static int validate_isreg(const struct config_state *cs,
714 int nvec, char **vec) {
715 VALIDATE_FILE(S_ISREG, "regular file");
719 /** @brief Validate a player pattern
720 * @param cs Configuration state
721 * @param nvec Length of (proposed) new value
722 * @param vec Elements of new value
723 * @return 0 on success, non-0 on error
725 static int validate_player(const struct config_state *cs,
727 char attribute((unused)) **vec) {
729 disorder_error(0, "%s:%d: should be at least 'player PATTERN MODULE'",
736 /** @brief Validate a track length pattern
737 * @param cs Configuration state
738 * @param nvec Length of (proposed) new value
739 * @param vec Elements of new value
740 * @return 0 on success, non-0 on error
742 static int validate_tracklength(const struct config_state *cs,
744 char attribute((unused)) **vec) {
746 disorder_error(0, "%s:%d: should be at least 'tracklength PATTERN MODULE'",
753 /** @brief Validate an allow directive
754 * @param cs Configuration state
755 * @param nvec Length of (proposed) new value
756 * @param vec Elements of new value
757 * @return 0 on success, non-0 on error
759 * Obsolete - only used for parsing legacy configuration.
761 static int validate_allow(const struct config_state *cs,
763 char attribute((unused)) **vec) {
765 disorder_error(0, "%s:%d: must be 'allow NAME PASS'", cs->path, cs->line);
771 /** @brief Validate a non-negative (@c long) integer
772 * @param cs Configuration state
773 * @param nvec Length of (proposed) new value
774 * @param vec Elements of new value
775 * @return 0 on success, non-0 on error
777 static int validate_non_negative(const struct config_state *cs,
778 int nvec, char **vec) {
782 disorder_error(0, "%s:%d: missing argument", cs->path, cs->line);
786 disorder_error(0, "%s:%d: too many arguments", cs->path, cs->line);
789 if(xstrtol(&n, vec[0], 0, 0)) {
790 disorder_error(0, "%s:%d: %s", cs->path, cs->line, strerror(errno));
794 disorder_error(0, "%s:%d: must not be negative", cs->path, cs->line);
800 /** @brief Validate a positive (@c long) integer
801 * @param cs Configuration state
802 * @param nvec Length of (proposed) new value
803 * @param vec Elements of new value
804 * @return 0 on success, non-0 on error
806 static int validate_positive(const struct config_state *cs,
807 int nvec, char **vec) {
811 disorder_error(0, "%s:%d: missing argument", cs->path, cs->line);
815 disorder_error(0, "%s:%d: too many arguments", cs->path, cs->line);
818 if(xstrtol(&n, vec[0], 0, 0)) {
819 disorder_error(0, "%s:%d: %s", cs->path, cs->line, strerror(errno));
823 disorder_error(0, "%s:%d: must be positive", cs->path, cs->line);
829 /** @brief Validate a system username
830 * @param cs Configuration state
831 * @param nvec Length of (proposed) new value
832 * @param vec Elements of new value
833 * @return 0 on success, non-0 on error
835 static int validate_isauser(const struct config_state *cs,
836 int attribute((unused)) nvec,
838 if(!getpwnam(vec[0])) {
839 disorder_error(0, "%s:%d: no such user as '%s'", cs->path, cs->line, vec[0]);
845 /** @brief Validate a sample format string
846 * @param cs Configuration state
847 * @param nvec Length of (proposed) new value
848 * @param vec Elements of new value
849 * @return 0 on success, non-0 on error
851 static int validate_sample_format(const struct config_state *cs,
852 int attribute((unused)) nvec,
854 return parse_sample_format(cs, 0, nvec, vec);
857 /** @brief Validate anything
858 * @param cs Configuration state
859 * @param nvec Length of (proposed) new value
860 * @param vec Elements of new value
863 static int validate_any(const struct config_state attribute((unused)) *cs,
864 int attribute((unused)) nvec,
865 char attribute((unused)) **vec) {
869 /** @brief Validate a URL
870 * @param cs Configuration state
871 * @param nvec Length of (proposed) new value
872 * @param vec Elements of new value
873 * @return 0 on success, non-0 on error
877 static int validate_url(const struct config_state attribute((unused)) *cs,
878 int attribute((unused)) nvec,
882 /* absoluteURI = scheme ":" ( hier_part | opaque_part )
883 scheme = alpha *( alpha | digit | "+" | "-" | "." ) */
885 n = strspn(s, ("abcdefghijklmnopqrstuvwxyz"
886 "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
889 disorder_error(0, "%s:%d: invalid url '%s'", cs->path, cs->line, vec[0]);
892 if(!strncmp(s, "http:", 5)
893 || !strncmp(s, "https:", 6)) {
895 /* we only do a rather cursory check */
896 if(strncmp(s, "//", 2)) {
897 disorder_error(0, "%s:%d: invalid url '%s'", cs->path, cs->line, vec[0]);
904 /** @brief Validate an alias pattern
905 * @param cs Configuration state
906 * @param nvec Length of (proposed) new value
907 * @param vec Elements of new value
908 * @return 0 on success, non-0 on error
910 static int validate_alias(const struct config_state *cs,
914 int in_brackets = 0, c;
917 disorder_error(0, "%s:%d: missing argument", cs->path, cs->line);
921 disorder_error(0, "%s:%d: too many arguments", cs->path, cs->line);
925 while((c = (unsigned char)*s++)) {
929 else if(!isalnum(c)) {
930 disorder_error(0, "%s:%d: invalid part name in alias expansion in '%s'",
931 cs->path, cs->line, vec[0]);
939 } else if(c == '\\') {
940 if(!(c = (unsigned char)*s++)) {
941 disorder_error(0, "%s:%d: unterminated escape in alias expansion in '%s'",
942 cs->path, cs->line, vec[0]);
944 } else if(c != '\\' && c != '{') {
945 disorder_error(0, "%s:%d: invalid escape in alias expansion in '%s'",
946 cs->path, cs->line, vec[0]);
955 "%s:%d: unterminated part name in alias expansion in '%s'",
956 cs->path, cs->line, vec[0]);
962 /** @brief Validate a hash algorithm name
963 * @param cs Configuration state
964 * @param nvec Length of (proposed) new value
965 * @param vec Elements of new value
966 * @return 0 on success, non-0 on error
968 static int validate_algo(const struct config_state attribute((unused)) *cs,
972 disorder_error(0, "%s:%d: invalid algorithm specification", cs->path, cs->line);
975 if(!valid_authhash(vec[0])) {
976 disorder_error(0, "%s:%d: unsuported algorithm '%s'", cs->path, cs->line, vec[0]);
982 /** @brief Validate a playback backend name
983 * @param cs Configuration state
984 * @param nvec Length of (proposed) new value
985 * @param vec Elements of new value
986 * @return 0 on success, non-0 on error
988 static int validate_backend(const struct config_state attribute((unused)) *cs,
993 disorder_error(0, "%s:%d: invalid sound API specification", cs->path, cs->line);
996 if(!strcmp(vec[0], "network")) {
997 disorder_error(0, "'api network' is deprecated; use 'api rtp'");
1000 if(config_uaudio_apis) {
1001 for(n = 0; config_uaudio_apis[n]; ++n)
1002 if(!strcmp(vec[0], config_uaudio_apis[n]->name))
1004 disorder_error(0, "%s:%d: unrecognized sound API '%s'", cs->path, cs->line, vec[0]);
1007 /* In non-server processes we have no idea what's valid */
1011 /** @brief Validate a pause mode string
1012 * @param cs Configuration state
1013 * @param nvec Length of (proposed) new value
1014 * @param vec Elements of new value
1015 * @return 0 on success, non-0 on error
1017 static int validate_pausemode(const struct config_state attribute((unused)) *cs,
1020 if(nvec == 1 && (!strcmp(vec[0], "silence") || !strcmp(vec[0], "suspend")))
1022 disorder_error(0, "%s:%d: invalid pause mode", cs->path, cs->line);
1026 /** @brief Validate a destination network address
1027 * @param cs Configuration state
1028 * @param nvec Length of (proposed) new value
1029 * @param vec Elements of new value
1030 * @return 0 on success, non-0 on error
1032 * By a destination address, it is meant that it must not be a wildcard
1035 static int validate_destaddr(const struct config_state attribute((unused)) *cs,
1038 struct netaddress na[1];
1040 if(netaddress_parse(na, nvec, vec)) {
1041 disorder_error(0, "%s:%d: invalid network address", cs->path, cs->line);
1045 disorder_error(0, "%s:%d: destination address required", cs->path, cs->line);
1052 /** @brief Item name and and offset */
1053 #define C(x) #x, offsetof(struct config, x)
1054 /** @brief Item name and and offset */
1055 #define C2(x,y) #x, offsetof(struct config, y)
1057 /** @brief All configuration items */
1058 static const struct conf conf[] = {
1059 { C(alias), &type_string, validate_alias },
1060 { C(allow), &type_stringlist_accum, validate_allow },
1061 { C(api), &type_string, validate_backend },
1062 { C(authorization_algorithm), &type_string, validate_algo },
1063 { C(broadcast), &type_netaddress, validate_destaddr },
1064 { C(broadcast_from), &type_netaddress, validate_any },
1065 { C(channel), &type_string, validate_any },
1066 { C(checkpoint_kbyte), &type_integer, validate_non_negative },
1067 { C(checkpoint_min), &type_integer, validate_non_negative },
1068 { C(collection), &type_collections, validate_any },
1069 { C(connect), &type_netaddress, validate_destaddr },
1070 { C(cookie_key_lifetime), &type_integer, validate_positive },
1071 { C(cookie_login_lifetime), &type_integer, validate_positive },
1072 { C(dbversion), &type_integer, validate_positive },
1073 { C(default_rights), &type_rights, validate_any },
1074 { C(device), &type_string, validate_any },
1075 { C(gap), &type_integer, validate_non_negative },
1076 { C(history), &type_integer, validate_positive },
1077 { C(home), &type_string, validate_isabspath },
1078 { C(listen), &type_netaddress, validate_any },
1079 { C(lock), &type_boolean, validate_any },
1080 { C(mail_sender), &type_string, validate_any },
1081 { C(mixer), &type_string, validate_any },
1082 { C(mount_rescan), &type_boolean, validate_any },
1083 { C(multicast_loop), &type_boolean, validate_any },
1084 { C(multicast_ttl), &type_integer, validate_non_negative },
1085 { C(namepart), &type_namepart, validate_any },
1086 { C(new_bias), &type_integer, validate_positive },
1087 { C(new_bias_age), &type_integer, validate_positive },
1088 { C(new_max), &type_integer, validate_positive },
1089 { C2(nice, nice_rescan), &type_integer, validate_non_negative },
1090 { C(nice_rescan), &type_integer, validate_non_negative },
1091 { C(nice_server), &type_integer, validate_any },
1092 { C(nice_speaker), &type_integer, validate_any },
1093 { C(noticed_history), &type_integer, validate_positive },
1094 { C(password), &type_string, validate_any },
1095 { C(pause_mode), &type_string, validate_pausemode },
1096 { C(player), &type_stringlist_accum, validate_player },
1097 { C(playlist_lock_timeout), &type_integer, validate_positive },
1098 { C(playlist_max) , &type_integer, validate_positive },
1099 { C(plugins), &type_string_accum, validate_isdir },
1100 { C(prefsync), &type_integer, validate_positive },
1101 { C(queue_pad), &type_integer, validate_positive },
1102 { C(refresh), &type_integer, validate_positive },
1103 { C(refresh_min), &type_integer, validate_non_negative },
1104 { C(reminder_interval), &type_integer, validate_positive },
1105 { C(remote_userman), &type_boolean, validate_any },
1106 { C(replay_min), &type_integer, validate_non_negative },
1107 { C2(restrict, restrictions), &type_restrict, validate_any },
1108 { C(rtp_delay_threshold), &type_integer, validate_positive },
1109 { C(rtp_verbose), &type_boolean, validate_any },
1110 { C(sample_format), &type_sample_format, validate_sample_format },
1111 { C(scratch), &type_string_accum, validate_isreg },
1112 { C(sendmail), &type_string, validate_isabspath },
1113 { C(short_display), &type_integer, validate_positive },
1114 { C(signal), &type_signal, validate_any },
1115 { C(smtp_server), &type_string, validate_any },
1116 { C(sox_generation), &type_integer, validate_non_negative },
1117 { C2(speaker_backend, api), &type_string, validate_backend },
1118 { C(speaker_command), &type_string, validate_any },
1119 { C(stopword), &type_string_accum, validate_any },
1120 { C(templates), &type_string_accum, validate_isdir },
1121 { C(tracklength), &type_stringlist_accum, validate_tracklength },
1122 { C(transform), &type_transform, validate_any },
1123 { C(trust), &type_string_accum, validate_any },
1124 { C(url), &type_string, validate_url },
1125 { C(user), &type_string, validate_isauser },
1126 { C(username), &type_string, validate_any },
1129 /** @brief Find a configuration item's definition by key */
1130 static const struct conf *find(const char *key) {
1133 if((n = TABLE_FIND(conf, name, key)) < 0)
1138 /** @brief Set a new configuration value
1139 * @param cs Configuration state
1140 * @param nvec Length of @p vec
1141 * @param vec Name and new value
1142 * @return 0 on success, non-0 on error.
1144 * @c vec[0] is the name, the rest is the value.
1146 static int config_set(const struct config_state *cs,
1147 int nvec, char **vec) {
1148 const struct conf *which;
1150 D(("config_set %s", vec[0]));
1151 if(!(which = find(vec[0]))) {
1152 disorder_error(0, "%s:%d: unknown configuration key '%s'",
1153 cs->path, cs->line, vec[0]);
1156 return (which->validate(cs, nvec - 1, vec + 1)
1157 || which->type->set(cs, which, nvec - 1, vec + 1));
1160 /** @brief Set a configuration item from parameters
1161 * @param cs Configuration state
1162 * @param which Item to set
1163 * @param ... Value as strings, terminated by (char *)NULL
1164 * @return 0 on success, non-0 on error
1166 static int config_set_args(const struct config_state *cs,
1167 const char *which, ...) {
1173 vector_append(v, (char *)which);
1174 va_start(ap, which);
1175 while((s = va_arg(ap, char *)))
1176 vector_append(v, s);
1178 vector_terminate(v);
1179 int rc = config_set(cs, v->nvec, v->vec);
1184 /** @brief Error callback used by config_include()
1185 * @param msg Error message
1186 * @param u User data (@ref config_state)
1188 static void config_error(const char *msg, void *u) {
1189 const struct config_state *cs = u;
1191 disorder_error(0, "%s:%d: %s", cs->path, cs->line, msg);
1194 /** @brief Include a file by name
1195 * @param c Configuration to update
1196 * @param path Path to read
1197 * @return 0 on success, non-0 on error
1199 static int config_include(struct config *c, const char *path) {
1201 char *buffer, *inputbuffer, **vec;
1203 struct config_state cs;
1208 D(("%s: reading configuration", path));
1209 if(!(fp = fopen(path, "r"))) {
1210 disorder_error(errno, "error opening %s", path);
1213 while(!inputline(path, fp, &inputbuffer, '\n')) {
1215 if(!(buffer = mb2utf8(inputbuffer))) {
1216 disorder_error(errno, "%s:%d: cannot convert to UTF-8", cs.path, cs.line);
1222 if(!(vec = split(buffer, &n, SPLIT_COMMENTS|SPLIT_QUOTES,
1223 config_error, &cs))) {
1229 /* 'include' is special-cased */
1230 if(!strcmp(vec[0], "include")) {
1232 disorder_error(0, "%s:%d: must be 'include PATH'", cs.path, cs.line);
1235 config_include(c, vec[1]);
1237 ret |= config_set(&cs, n, vec);
1239 for(n = 0; vec[n]; ++n) xfree(vec[n]);
1244 disorder_error(errno, "error reading %s", path);
1251 /** @brief Default stopword setting */
1252 static const char *const default_stopwords[] = {
1311 #define NDEFAULT_STOPWORDS (sizeof default_stopwords / sizeof *default_stopwords)
1313 /** @brief Default player patterns */
1314 static const char *const default_players[] = {
1320 #define NDEFAULT_PLAYERS (sizeof default_players / sizeof *default_players)
1322 /** @brief Make a new default configuration
1323 * @return New configuration
1325 static struct config *config_default(void) {
1326 struct config *c = xmalloc(sizeof *c);
1327 const char *logname;
1329 struct config_state cs;
1332 cs.path = "<internal>";
1335 /* Strings had better be xstrdup'd as they will get freed at some point. */
1338 c->home = xstrdup(pkgstatedir);
1339 if(!(pw = getpwuid(getuid())))
1340 disorder_fatal(0, "cannot determine our username");
1341 logname = pw->pw_name;
1342 c->username = xstrdup(logname);
1346 c->signal = SIGKILL;
1347 c->alias = xstrdup("{/artist}{/album}{/title}{ext}");
1349 c->device = xstrdup("default");
1350 c->nice_rescan = 10;
1351 c->speaker_command = 0;
1352 c->sample_format.bits = 16;
1353 c->sample_format.rate = 44100;
1354 c->sample_format.channels = 2;
1355 c->sample_format.endian = ENDIAN_NATIVE;
1357 c->replay_min = 8 * 3600;
1359 c->multicast_ttl = 1;
1360 c->multicast_loop = 1;
1361 c->authorization_algorithm = xstrdup("sha1");
1362 c->noticed_history = 31;
1363 c->short_display = 32;
1367 c->cookie_login_lifetime = 86400;
1368 c->cookie_key_lifetime = 86400 * 7;
1369 if(sendmail_binary[0] && strcmp(sendmail_binary, "none"))
1370 c->sendmail = xstrdup(sendmail_binary);
1371 c->smtp_server = xstrdup("127.0.0.1");
1373 c->reminder_interval = 600; /* 10m */
1374 c->new_bias_age = 7 * 86400; /* 1 week */
1375 c->new_bias = 4500000; /* 50 times the base weight */
1376 c->sox_generation = DEFAULT_SOX_GENERATION;
1377 c->playlist_max = INT_MAX; /* effectively no limit */
1378 c->playlist_lock_timeout = 10; /* 10s */
1379 c->mount_rescan = 1;
1380 /* Default stopwords */
1381 if(config_set(&cs, (int)NDEFAULT_STOPWORDS, (char **)default_stopwords))
1383 /* Default player configuration */
1384 for(n = 0; n < NDEFAULT_PLAYERS; ++n) {
1385 if(config_set_args(&cs, "player",
1386 default_players[n], "execraw", "disorder-decode", (char *)0))
1388 if(config_set_args(&cs, "tracklength",
1389 default_players[n], "disorder-tracklength", (char *)0))
1392 c->broadcast.af = -1;
1393 c->broadcast_from.af = -1;
1399 /** @brief Construct a filename
1400 * @param c Configuration
1401 * @param name Base filename
1402 * @return Full filename
1404 * Usually use config_get_file() instead.
1406 char *config_get_file2(struct config *c, const char *name) {
1409 byte_xasprintf(&s, "%s/%s", c->home, name);
1413 /** @brief Set the default configuration file */
1414 static void set_configfile(void) {
1416 byte_xasprintf(&configfile, "%s/config", pkgconfdir);
1419 /** @brief Free a configuration object
1420 * @param c Configuration to free
1422 * @p c is indeterminate after this function is called.
1424 void config_free(struct config *c) {
1428 for(n = 0; n < (int)(sizeof conf / sizeof *conf); ++n)
1429 conf[n].type->free(c, &conf[n]);
1430 for(n = 0; n < c->nparts; ++n)
1437 /** @brief Set post-parse defaults
1438 * @param c Configuration to update
1439 * @param server True when running in the server
1441 * If @p server is set then certain parts of the configuration are more
1442 * strictly validated.
1444 static void config_postdefaults(struct config *c,
1446 struct config_state cs;
1447 const struct conf *whoami;
1450 static const char *namepart[][4] = {
1451 { "title", "/([0-9]+ *[-:]? *)?([^/]+)\\.[a-zA-Z0-9]+$", "$2", "display" },
1452 { "title", "/([^/]+)\\.[a-zA-Z0-9]+$", "$1", "sort" },
1453 { "album", "/([^/]+)/[^/]+$", "$1", "*" },
1454 { "artist", "/([^/]+)/[^/]+/[^/]+$", "$1", "*" },
1455 { "ext", "(\\.[a-zA-Z0-9]+)$", "$1", "*" },
1457 #define NNAMEPART (int)(sizeof namepart / sizeof *namepart)
1459 static const char *transform[][5] = {
1460 { "track", "^.*/([0-9]+ *[-:]? *)?([^/]+)\\.[a-zA-Z0-9]+$", "$2", "display", "" },
1461 { "track", "^.*/([^/]+)\\.[a-zA-Z0-9]+$", "$1", "sort", "" },
1462 { "dir", "^.*/([^/]+)$", "$1", "*", "" },
1463 { "dir", "^(the) ([^/]*)", "$2, $1", "sort", "i", },
1464 { "dir", "[[:punct:]]", "", "sort", "g", }
1466 #define NTRANSFORM (int)(sizeof transform / sizeof *transform)
1468 cs.path = "<internal>";
1471 if(!c->namepart.n) {
1472 whoami = find("namepart");
1473 for(n = 0; n < NNAMEPART; ++n)
1474 set_namepart(&cs, whoami, 4, (char **)namepart[n]);
1476 if(!c->transform.n) {
1477 whoami = find("transform");
1478 for(n = 0; n < NTRANSFORM; ++n)
1479 set_transform(&cs, whoami, 5, (char **)transform[n]);
1482 if(c->speaker_command)
1483 c->api = xstrdup("command");
1484 else if(c->broadcast.af != -1)
1485 c->api = xstrdup("rtp");
1486 else if(config_uaudio_apis)
1487 c->api = xstrdup(config_uaudio_apis[0]->name);
1489 c->api = xstrdup("<none>");
1491 if(!strcmp(c->api, "network"))
1492 c->api = xstrdup("rtp");
1494 if(!strcmp(c->api, "command") && !c->speaker_command)
1495 disorder_fatal(0, "'api command' but speaker_command is not set");
1496 if((!strcmp(c->api, "rtp")) && c->broadcast.af == -1)
1497 disorder_fatal(0, "'api rtp' but broadcast is not set");
1499 /* Override sample format */
1500 if(!strcmp(c->api, "rtp")) {
1501 c->sample_format.rate = 44100;
1502 c->sample_format.channels = 2;
1503 c->sample_format.bits = 16;
1504 c->sample_format.endian = ENDIAN_NATIVE;
1506 if(!strcmp(c->api, "coreaudio")) {
1507 c->sample_format.rate = 44100;
1508 c->sample_format.channels = 2;
1509 c->sample_format.bits = 16;
1510 c->sample_format.endian = ENDIAN_NATIVE;
1512 if(!c->default_rights) {
1513 rights_type r = RIGHTS__MASK & ~(RIGHT_ADMIN|RIGHT_REGISTER
1515 |RIGHT_SCRATCH__MASK
1516 |RIGHT_REMOVE__MASK);
1517 /* The idea is to approximate the meaning of the old 'restrict' directive
1518 * in the default rights if they are not overridden. */
1519 if(c->restrictions & RESTRICT_SCRATCH)
1520 r |= RIGHT_SCRATCH_MINE|RIGHT_SCRATCH_RANDOM;
1522 r |= RIGHT_SCRATCH_ANY;
1523 if(!(c->restrictions & RESTRICT_MOVE))
1524 r |= RIGHT_MOVE_ANY;
1525 if(c->restrictions & RESTRICT_REMOVE)
1526 r |= RIGHT_REMOVE_MINE;
1528 r |= RIGHT_REMOVE_ANY;
1529 c->default_rights = rights_string(r);
1533 /** @brief (Re-)read the config file
1534 * @param server If set, do extra checking
1535 * @param oldconfig Old configuration for compatibility check
1536 * @return 0 on success, non-0 on error
1538 * If @p oldconfig is set, then certain compatibility checks are done between
1539 * the old and new configurations.
1541 int config_read(int server,
1542 const struct config *oldconfig) {
1548 c = config_default();
1549 /* standalone Disobedience installs might not have a global config file */
1550 if(access(configfile, F_OK) == 0)
1551 if(config_include(c, configfile))
1553 /* if we can read the private config file, do */
1554 if((privconf = config_private())
1555 && access(privconf, R_OK) == 0
1556 && config_include(c, privconf))
1559 /* if there's a per-user system config file for this user, read it */
1560 if(config_per_user) {
1561 if(!(pw = getpwuid(getuid())))
1562 disorder_fatal(0, "cannot determine our username");
1563 if((privconf = config_usersysconf(pw))
1564 && access(privconf, F_OK) == 0
1565 && config_include(c, privconf))
1568 /* if we have a password file, read it */
1569 if((privconf = config_userconf(0, pw))
1570 && access(privconf, F_OK) == 0
1571 && config_include(c, privconf))
1575 /* install default namepart and transform settings */
1576 config_postdefaults(c, server);
1579 if(strcmp(c->home, oldconfig->home)) {
1580 disorder_error(0, "'home' cannot be changed without a restart");
1583 if(strcmp(c->alias, oldconfig->alias)) {
1584 disorder_error(0, "'alias' cannot be changed without a restart");
1587 if(strcmp(c->user, oldconfig->user)) {
1588 disorder_error(0, "'user' cannot be changed without a restart");
1591 if(c->nice_speaker != oldconfig->nice_speaker) {
1592 disorder_error(0, "'nice_speaker' cannot be changed without a restart");
1593 /* ...but we accept the new config anyway */
1595 if(c->nice_server != oldconfig->nice_server) {
1596 disorder_error(0, "'nice_server' cannot be changed without a restart");
1597 /* ...but we accept the new config anyway */
1599 if(namepartlist_compare(&c->namepart, &oldconfig->namepart)) {
1600 disorder_error(0, "'namepart' settings cannot be changed without a restart");
1603 if(stringlist_compare(&c->stopword, &oldconfig->stopword)) {
1604 disorder_error(0, "'stopword' settings cannot be changed without a restart");
1608 disorder_error(0, "not installing incompatible new configuration");
1612 /* everything is good so we shall use the new config */
1613 config_free(config);
1614 /* warn about obsolete directives */
1616 disorder_error(0, "'restrict' will be removed in a future version");
1618 disorder_error(0, "'allow' will be removed in a future version");
1620 disorder_error(0, "'trust' will be removed in a future version");
1622 disorder_error(0, "'lock' will be removed in a future version");
1624 disorder_error(0, "'gap' will be removed in a future version");
1626 disorder_error(0, "'prefsync' will be removed in a future version");
1631 /** @brief Return the path to the private configuration file */
1632 char *config_private(void) {
1636 byte_xasprintf(&s, "%s.private", configfile);
1640 /** @brief Return the path to user's personal configuration file */
1641 char *config_userconf(const char *home, const struct passwd *pw) {
1644 if(!home && !pw && !(pw = getpwuid(getuid())))
1645 disorder_fatal(0, "cannot determine our username");
1646 byte_xasprintf(&s, "%s/.disorder/passwd", home ? home : pw->pw_dir);
1650 /** @brief Return the path to user-specific system configuration */
1651 char *config_usersysconf(const struct passwd *pw) {
1655 if(!strchr(pw->pw_name, '/')) {
1656 byte_xasprintf(&s, "%s.%s", configfile, pw->pw_name);
1662 /** @brief Get a filename within the home directory
1663 * @param name Relative name
1666 char *config_get_file(const char *name) {
1667 return config_get_file2(config, name);
1670 /** @brief Order two stringlists
1671 * @param a First stringlist
1672 * @param b Second stringlist
1673 * @return <0, 0 or >0 if a<b, a=b or a>b
1675 static int stringlist_compare(const struct stringlist *a,
1676 const struct stringlist *b) {
1679 while(n < a->n && n < b->n) {
1680 if((c = strcmp(a->s[n], b->s[n])))
1686 else if(a->n > b->n)
1692 /** @brief Order two namepart definitions
1693 * @param a First namepart definition
1694 * @param b Second namepart definition
1695 * @return <0, 0 or >0 if a<b, a=b or a>b
1697 static int namepart_compare(const struct namepart *a,
1698 const struct namepart *b) {
1701 if((c = strcmp(a->part, b->part)))
1703 if((c = strcmp(a->res, b->res)))
1705 if((c = strcmp(a->replace, b->replace)))
1707 if((c = strcmp(a->context, b->context)))
1709 if(a->reflags > b->reflags)
1711 if(a->reflags < b->reflags)
1716 /** @brief Order two lists of namepart definitions
1717 * @param a First list of namepart definitions
1718 * @param b Second list of namepart definitions
1719 * @return <0, 0 or >0 if a<b, a=b or a>b
1721 static int namepartlist_compare(const struct namepartlist *a,
1722 const struct namepartlist *b) {
1725 while(n < a->n && n < b->n) {
1726 if((c = namepart_compare(&a->s[n], &b->s[n])))
1732 else if(a->n < b->n)
1738 /** @brief Verify configuration table.
1739 * @return The number of problems found
1741 int config_verify(void) {
1743 for(size_t n = 1; n < sizeof conf / sizeof *conf; ++n)
1744 if(strcmp(conf[n-1].name, conf[n].name) >= 0) {
1745 fprintf(stderr, "%s >= %s\n", conf[n-1].name, conf[n].name);