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 stringlist_compare(const struct stringlist
*a
,
113 const struct stringlist
*b
);
114 static int namepartlist_compare(const struct namepartlist
*a
,
115 const struct namepartlist
*b
);
117 static int set_signal(const struct config_state
*cs
,
118 const struct conf
*whoami
,
119 int nvec
, char **vec
) {
123 error(0, "%s:%d: '%s' requires one argument",
124 cs
->path
, cs
->line
, whoami
->name
);
127 if((n
= find_signal(vec
[0])) == -1) {
128 error(0, "%s:%d: unknown signal '%s'",
129 cs
->path
, cs
->line
, vec
[0]);
132 VALUE(cs
->config
, int) = n
;
136 static int set_collections(const struct config_state
*cs
,
137 const struct conf
*whoami
,
138 int nvec
, char **vec
) {
139 struct collectionlist
*cl
;
140 const char *root
, *encoding
, *module
;
159 error(0, "%s:%d: '%s' requires at least one argument",
160 cs
->path
, cs
->line
, whoami
->name
);
163 error(0, "%s:%d: '%s' requires at most three arguments",
164 cs
->path
, cs
->line
, whoami
->name
);
167 /* Sanity check root */
169 error(0, "%s:%d: collection root must start with '/'",
173 if(root
[1] && root
[strlen(root
)-1] == '/') {
174 error(0, "%s:%d: collection root must not end with '/'",
182 encoding
= nl_langinfo(CODESET
);
183 cl
= ADDRESS(cs
->config
, struct collectionlist
);
185 cl
->s
= xrealloc(cl
->s
, cl
->n
* sizeof (struct collection
));
186 cl
->s
[cl
->n
- 1].module
= xstrdup(module
);
187 cl
->s
[cl
->n
- 1].encoding
= xstrdup(encoding
);
188 cl
->s
[cl
->n
- 1].root
= xstrdup(root
);
192 static int set_boolean(const struct config_state
*cs
,
193 const struct conf
*whoami
,
194 int nvec
, char **vec
) {
198 error(0, "%s:%d: '%s' takes only one argument",
199 cs
->path
, cs
->line
, whoami
->name
);
202 if(!strcmp(vec
[0], "yes")) state
= 1;
203 else if(!strcmp(vec
[0], "no")) state
= 0;
205 error(0, "%s:%d: argument to '%s' must be 'yes' or 'no'",
206 cs
->path
, cs
->line
, whoami
->name
);
209 VALUE(cs
->config
, int) = state
;
213 static int set_string(const struct config_state
*cs
,
214 const struct conf
*whoami
,
215 int nvec
, char **vec
) {
217 error(0, "%s:%d: '%s' takes only one argument",
218 cs
->path
, cs
->line
, whoami
->name
);
221 VALUE(cs
->config
, char *) = xstrdup(vec
[0]);
225 static int set_stringlist(const struct config_state
*cs
,
226 const struct conf
*whoami
,
227 int nvec
, char **vec
) {
229 struct stringlist
*sl
;
231 sl
= ADDRESS(cs
->config
, struct stringlist
);
233 for(n
= 0; n
< nvec
; ++n
) {
235 sl
->s
= xrealloc(sl
->s
, (sl
->n
* sizeof (char *)));
236 sl
->s
[sl
->n
- 1] = xstrdup(vec
[n
]);
241 static int set_integer(const struct config_state
*cs
,
242 const struct conf
*whoami
,
243 int nvec
, char **vec
) {
247 error(0, "%s:%d: '%s' takes only one argument",
248 cs
->path
, cs
->line
, whoami
->name
);
251 if(xstrtol(ADDRESS(cs
->config
, long), vec
[0], &e
, 0)) {
252 error(errno
, "%s:%d: converting integer", cs
->path
, cs
->line
);
256 error(0, "%s:%d: invalid integer syntax", cs
->path
, cs
->line
);
262 static int set_stringlist_accum(const struct config_state
*cs
,
263 const struct conf
*whoami
,
264 int nvec
, char **vec
) {
266 struct stringlist
*s
;
267 struct stringlistlist
*sll
;
269 sll
= ADDRESS(cs
->config
, struct stringlistlist
);
275 sll
->s
= xrealloc(sll
->s
, (sll
->n
* sizeof (struct stringlist
)));
276 s
= &sll
->s
[sll
->n
- 1];
278 s
->s
= xmalloc((nvec
+ 1) * sizeof (char *));
279 for(n
= 0; n
< nvec
; ++n
)
280 s
->s
[n
] = xstrdup(vec
[n
]);
284 static int set_string_accum(const struct config_state
*cs
,
285 const struct conf
*whoami
,
286 int nvec
, char **vec
) {
288 struct stringlist
*sl
;
290 sl
= ADDRESS(cs
->config
, struct stringlist
);
295 for(n
= 0; n
< nvec
; ++n
) {
297 sl
->s
= xrealloc(sl
->s
, (sl
->n
* sizeof (char *)));
298 sl
->s
[sl
->n
- 1] = xstrdup(vec
[n
]);
303 static int set_restrict(const struct config_state
*cs
,
304 const struct conf
*whoami
,
305 int nvec
, char **vec
) {
309 static const struct restriction
{
313 { "remove", RESTRICT_REMOVE
},
314 { "scratch", RESTRICT_SCRATCH
},
315 { "move", RESTRICT_MOVE
},
318 for(n
= 0; n
< nvec
; ++n
) {
319 if((i
= TABLE_FIND(restrictions
, name
, vec
[n
])) < 0) {
320 error(0, "%s:%d: invalid restriction '%s'",
321 cs
->path
, cs
->line
, vec
[n
]);
324 r
|= restrictions
[i
].bit
;
326 VALUE(cs
->config
, unsigned) = r
;
330 static int parse_sample_format(const struct config_state
*cs
,
331 struct stream_header
*format
,
332 int nvec
, char **vec
) {
337 error(0, "%s:%d: wrong number of arguments", cs
->path
, cs
->line
);
340 if(xstrtol(&t
, p
, &p
, 0)) {
341 error(errno
, "%s:%d: converting bits-per-sample", cs
->path
, cs
->line
);
344 if(t
!= 8 && t
!= 16) {
345 error(0, "%s:%d: bad bite-per-sample (%ld)", cs
->path
, cs
->line
, t
);
348 if(format
) format
->bits
= t
;
350 case 'l': case 'L': t
= ENDIAN_LITTLE
; p
++; break;
351 case 'b': case 'B': t
= ENDIAN_BIG
; p
++; break;
352 default: t
= ENDIAN_NATIVE
; break;
354 if(format
) format
->endian
= t
;
356 error(errno
, "%s:%d: expected `/' after bits-per-sample",
361 if(xstrtol(&t
, p
, &p
, 0)) {
362 error(errno
, "%s:%d: converting sample-rate", cs
->path
, cs
->line
);
365 if(t
< 1 || t
> INT_MAX
) {
366 error(0, "%s:%d: silly sample-rate (%ld)", cs
->path
, cs
->line
, t
);
369 if(format
) format
->rate
= t
;
371 error(0, "%s:%d: expected `/' after sample-rate",
376 if(xstrtol(&t
, p
, &p
, 0)) {
377 error(errno
, "%s:%d: converting channels", cs
->path
, cs
->line
);
381 error(0, "%s:%d: silly number (%ld) of channels", cs
->path
, cs
->line
, t
);
384 if(format
) format
->channels
= t
;
386 error(0, "%s:%d: junk after channels", cs
->path
, cs
->line
);
392 static int set_sample_format(const struct config_state
*cs
,
393 const struct conf
*whoami
,
394 int nvec
, char **vec
) {
395 return parse_sample_format(cs
, ADDRESS(cs
->config
, struct stream_header
),
399 static int set_namepart(const struct config_state
*cs
,
400 const struct conf
*whoami
,
401 int nvec
, char **vec
) {
402 struct namepartlist
*npl
= ADDRESS(cs
->config
, struct namepartlist
);
409 error(0, "%s:%d: namepart needs at least 3 arguments", cs
->path
, cs
->line
);
413 error(0, "%s:%d: namepart needs at most 5 arguments", cs
->path
, cs
->line
);
416 reflags
= nvec
>= 5 ?
regsub_flags(vec
[4]) : 0;
417 if(!(re
= pcre_compile(vec
[1],
419 |regsub_compile_options(reflags
),
420 &errstr
, &erroffset
, 0))) {
421 error(0, "%s:%d: error compiling regexp /%s/: %s (offset %d)",
422 cs
->path
, cs
->line
, vec
[1], errstr
, erroffset
);
425 npl
->s
= xrealloc(npl
->s
, (npl
->n
+ 1) * sizeof (struct namepart
));
426 npl
->s
[npl
->n
].part
= xstrdup(vec
[0]);
427 npl
->s
[npl
->n
].re
= re
;
428 npl
->s
[npl
->n
].res
= xstrdup(vec
[1]);
429 npl
->s
[npl
->n
].replace
= xstrdup(vec
[2]);
430 npl
->s
[npl
->n
].context
= xstrdup(vec
[3]);
431 npl
->s
[npl
->n
].reflags
= reflags
;
433 /* XXX a bit of a bodge; relies on there being very few parts. */
434 for(n
= 0; (n
< cs
->config
->nparts
435 && strcmp(cs
->config
->parts
[n
], vec
[0])); ++n
)
437 if(n
>= cs
->config
->nparts
) {
438 cs
->config
->parts
= xrealloc(cs
->config
->parts
,
439 (cs
->config
->nparts
+ 1) * sizeof (char *));
440 cs
->config
->parts
[cs
->config
->nparts
++] = xstrdup(vec
[0]);
445 static int set_transform(const struct config_state
*cs
,
446 const struct conf
*whoami
,
447 int nvec
, char **vec
) {
448 struct transformlist
*tl
= ADDRESS(cs
->config
, struct transformlist
);
455 error(0, "%s:%d: transform needs at least 3 arguments", cs
->path
, cs
->line
);
459 error(0, "%s:%d: transform needs at most 5 arguments", cs
->path
, cs
->line
);
462 reflags
= (nvec
>= 5 ?
regsub_flags(vec
[4]) : 0);
463 if(!(re
= pcre_compile(vec
[1],
465 |regsub_compile_options(reflags
),
466 &errstr
, &erroffset
, 0))) {
467 error(0, "%s:%d: error compiling regexp /%s/: %s (offset %d)",
468 cs
->path
, cs
->line
, vec
[1], errstr
, erroffset
);
471 tl
->t
= xrealloc(tl
->t
, (tl
->n
+ 1) * sizeof (struct namepart
));
472 tl
->t
[tl
->n
].type
= xstrdup(vec
[0]);
473 tl
->t
[tl
->n
].context
= xstrdup(vec
[3] ? vec
[3] : "*");
474 tl
->t
[tl
->n
].re
= re
;
475 tl
->t
[tl
->n
].replace
= xstrdup(vec
[2]);
476 tl
->t
[tl
->n
].flags
= reflags
;
481 static int set_rights(const struct config_state
*cs
,
482 const struct conf
*whoami
,
483 int nvec
, char **vec
) {
485 error(0, "%s:%d: '%s' requires one argument",
486 cs
->path
, cs
->line
, whoami
->name
);
489 if(parse_rights(vec
[0], 0, 1)) {
490 error(0, "%s:%d: invalid rights string '%s'",
491 cs
->path
, cs
->line
, vec
[0]);
494 *ADDRESS(cs
->config
, char *) = vec
[0];
498 static int set_netaddress(const struct config_state
*cs
,
499 const struct conf
*whoami
,
500 int nvec
, char **vec
) {
501 struct netaddress
*na
= ADDRESS(cs
->config
, struct netaddress
);
503 if(netaddress_parse(na
, nvec
, vec
)) {
504 error(0, "%s:%d: invalid network address", cs
->path
, cs
->line
);
512 static void free_none(struct config
attribute((unused
)) *c
,
513 const struct conf
attribute((unused
)) *whoami
) {
516 static void free_string(struct config
*c
,
517 const struct conf
*whoami
) {
518 xfree(VALUE(c
, char *));
519 VALUE(c
, char *) = 0;
522 static void free_stringlist(struct config
*c
,
523 const struct conf
*whoami
) {
525 struct stringlist
*sl
= ADDRESS(c
, struct stringlist
);
527 for(n
= 0; n
< sl
->n
; ++n
)
532 static void free_stringlistlist(struct config
*c
,
533 const struct conf
*whoami
) {
535 struct stringlistlist
*sll
= ADDRESS(c
, struct stringlistlist
);
536 struct stringlist
*sl
;
538 for(n
= 0; n
< sll
->n
; ++n
) {
540 for(m
= 0; m
< sl
->n
; ++m
)
547 static void free_collectionlist(struct config
*c
,
548 const struct conf
*whoami
) {
549 struct collectionlist
*cll
= ADDRESS(c
, struct collectionlist
);
550 struct collection
*cl
;
553 for(n
= 0; n
< cll
->n
; ++n
) {
562 static void free_namepartlist(struct config
*c
,
563 const struct conf
*whoami
) {
564 struct namepartlist
*npl
= ADDRESS(c
, struct namepartlist
);
568 for(n
= 0; n
< npl
->n
; ++n
) {
571 pcre_free(np
->re
); /* ...whatever pcre_free is set to. */
579 static void free_transformlist(struct config
*c
,
580 const struct conf
*whoami
) {
581 struct transformlist
*tl
= ADDRESS(c
, struct transformlist
);
585 for(n
= 0; n
< tl
->n
; ++n
) {
588 pcre_free(t
->re
); /* ...whatever pcre_free is set to. */
595 static void free_netaddress(struct config
*c
,
596 const struct conf
*whoami
) {
597 struct netaddress
*na
= ADDRESS(c
, struct netaddress
);
602 /* configuration types */
604 static const struct conftype
605 type_signal
= { set_signal
, free_none
},
606 type_collections
= { set_collections
, free_collectionlist
},
607 type_boolean
= { set_boolean
, free_none
},
608 type_string
= { set_string
, free_string
},
609 type_stringlist
= { set_stringlist
, free_stringlist
},
610 type_integer
= { set_integer
, free_none
},
611 type_stringlist_accum
= { set_stringlist_accum
, free_stringlistlist
},
612 type_string_accum
= { set_string_accum
, free_stringlist
},
613 type_sample_format
= { set_sample_format
, free_none
},
614 type_restrict
= { set_restrict
, free_none
},
615 type_namepart
= { set_namepart
, free_namepartlist
},
616 type_transform
= { set_transform
, free_transformlist
},
617 type_netaddress
= { set_netaddress
, free_netaddress
},
618 type_rights
= { set_rights
, free_none
};
620 /* specific validation routine */
622 #define VALIDATE_FILE(test, what) do { \
626 for(n = 0; n < nvec; ++n) { \
627 if(stat(vec[n], &sb) < 0) { \
628 error(errno, "%s:%d: %s", cs->path, cs->line, vec[n]); \
631 if(!test(sb.st_mode)) { \
632 error(0, "%s:%d: %s is not a %s", \
633 cs->path, cs->line, vec[n], what); \
639 static int validate_isabspath(const struct config_state
*cs
,
640 int nvec
, char **vec
) {
643 for(n
= 0; n
< nvec
; ++n
)
644 if(vec
[n
][0] != '/') {
645 error(errno
, "%s:%d: %s: not an absolute path",
646 cs
->path
, cs
->line
, vec
[n
]);
652 static int validate_isdir(const struct config_state
*cs
,
653 int nvec
, char **vec
) {
654 VALIDATE_FILE(S_ISDIR
, "directory");
658 static int validate_isreg(const struct config_state
*cs
,
659 int nvec
, char **vec
) {
660 VALIDATE_FILE(S_ISREG
, "regular file");
664 static int validate_player(const struct config_state
*cs
,
666 char attribute((unused
)) **vec
) {
668 error(0, "%s:%d: should be at least 'player PATTERN MODULE'",
675 static int validate_tracklength(const struct config_state
*cs
,
677 char attribute((unused
)) **vec
) {
679 error(0, "%s:%d: should be at least 'tracklength PATTERN MODULE'",
686 static int validate_allow(const struct config_state
*cs
,
688 char attribute((unused
)) **vec
) {
690 error(0, "%s:%d: must be 'allow NAME PASS'", cs
->path
, cs
->line
);
696 static int validate_non_negative(const struct config_state
*cs
,
697 int nvec
, char **vec
) {
701 error(0, "%s:%d: missing argument", cs
->path
, cs
->line
);
705 error(0, "%s:%d: too many arguments", cs
->path
, cs
->line
);
708 if(xstrtol(&n
, vec
[0], 0, 0)) {
709 error(0, "%s:%d: %s", cs
->path
, cs
->line
, strerror(errno
));
713 error(0, "%s:%d: must not be negative", cs
->path
, cs
->line
);
719 static int validate_positive(const struct config_state
*cs
,
720 int nvec
, char **vec
) {
724 error(0, "%s:%d: missing argument", cs
->path
, cs
->line
);
728 error(0, "%s:%d: too many arguments", cs
->path
, cs
->line
);
731 if(xstrtol(&n
, vec
[0], 0, 0)) {
732 error(0, "%s:%d: %s", cs
->path
, cs
->line
, strerror(errno
));
736 error(0, "%s:%d: must be positive", cs
->path
, cs
->line
);
742 static int validate_isauser(const struct config_state
*cs
,
743 int attribute((unused
)) nvec
,
747 if(!(pw
= getpwnam(vec
[0]))) {
748 error(0, "%s:%d: no such user as '%s'", cs
->path
, cs
->line
, vec
[0]);
754 static int validate_sample_format(const struct config_state
*cs
,
755 int attribute((unused
)) nvec
,
757 return parse_sample_format(cs
, 0, nvec
, vec
);
760 static int validate_any(const struct config_state
attribute((unused
)) *cs
,
761 int attribute((unused
)) nvec
,
762 char attribute((unused
)) **vec
) {
766 static int validate_url(const struct config_state
attribute((unused
)) *cs
,
767 int attribute((unused
)) nvec
,
771 /* absoluteURI = scheme ":" ( hier_part | opaque_part )
772 scheme = alpha *( alpha | digit | "+" | "-" | "." ) */
774 n
= strspn(s
, ("abcdefghijklmnopqrstuvwxyz"
775 "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
778 error(0, "%s:%d: invalid url '%s'", cs
->path
, cs
->line
, vec
[0]);
781 if(!strncmp(s
, "http:", 5)
782 || !strncmp(s
, "https:", 6)) {
784 /* we only do a rather cursory check */
785 if(strncmp(s
, "//", 2)) {
786 error(0, "%s:%d: invalid url '%s'", cs
->path
, cs
->line
, vec
[0]);
793 static int validate_alias(const struct config_state
*cs
,
797 int in_brackets
= 0, c
;
800 error(0, "%s:%d: missing argument", cs
->path
, cs
->line
);
804 error(0, "%s:%d: too many arguments", cs
->path
, cs
->line
);
808 while((c
= (unsigned char)*s
++)) {
812 else if(!isalnum(c
)) {
813 error(0, "%s:%d: invalid part name in alias expansion in '%s'",
814 cs
->path
, cs
->line
, vec
[0]);
822 } else if(c
== '\\') {
823 if(!(c
= (unsigned char)*s
++)) {
824 error(0, "%s:%d: unterminated escape in alias expansion in '%s'",
825 cs
->path
, cs
->line
, vec
[0]);
827 } else if(c
!= '\\' && c
!= '{') {
828 error(0, "%s:%d: invalid escape in alias expansion in '%s'",
829 cs
->path
, cs
->line
, vec
[0]);
837 error(0, "%s:%d: unterminated part name in alias expansion in '%s'",
838 cs
->path
, cs
->line
, vec
[0]);
844 static int validate_algo(const struct config_state
attribute((unused
)) *cs
,
848 error(0, "%s:%d: invalid algorithm specification", cs
->path
, cs
->line
);
851 if(!valid_authhash(vec
[0])) {
852 error(0, "%s:%d: unsuported algorithm '%s'", cs
->path
, cs
->line
, vec
[0]);
858 static int validate_backend(const struct config_state
attribute((unused
)) *cs
,
863 error(0, "%s:%d: invalid sound API specification", cs
->path
, cs
->line
);
866 if(!strcmp(vec
[0], "network")) {
867 error(0, "'api network' is deprecated; use 'api rtp'");
870 if(config_uaudio_apis
) {
871 for(n
= 0; config_uaudio_apis
[n
]; ++n
)
872 if(!strcmp(vec
[0], config_uaudio_apis
[n
]->name
))
874 error(0, "%s:%d: unrecognized sound API '%s'", cs
->path
, cs
->line
, vec
[0]);
877 /* In non-server processes we have no idea what's valid */
881 static int validate_pausemode(const struct config_state
attribute((unused
)) *cs
,
884 if(nvec
== 1 && (!strcmp(vec
[0], "silence") || !strcmp(vec
[0], "suspend")))
886 error(0, "%s:%d: invalid pause mode", cs
->path
, cs
->line
);
890 static int validate_destaddr(const struct config_state
attribute((unused
)) *cs
,
893 struct netaddress na
[1];
895 if(netaddress_parse(na
, nvec
, vec
)) {
896 error(0, "%s:%d: invalid network address", cs
->path
, cs
->line
);
900 error(0, "%s:%d: destination address required", cs
->path
, cs
->line
);
906 /** @brief Item name and and offset */
907 #define C(x) #x, offsetof(struct config, x)
908 /** @brief Item name and and offset */
909 #define C2(x,y) #x, offsetof(struct config, y)
911 /** @brief All configuration items */
912 static const struct conf conf
[] = {
913 { C(alias
), &type_string
, validate_alias
},
914 { C(allow
), &type_stringlist_accum
, validate_allow
},
915 { C(api
), &type_string
, validate_backend
},
916 { C(authorization_algorithm
), &type_string
, validate_algo
},
917 { C(broadcast
), &type_netaddress
, validate_destaddr
},
918 { C(broadcast_from
), &type_netaddress
, validate_any
},
919 { C(channel
), &type_string
, validate_any
},
920 { C(checkpoint_kbyte
), &type_integer
, validate_non_negative
},
921 { C(checkpoint_min
), &type_integer
, validate_non_negative
},
922 { C(collection
), &type_collections
, validate_any
},
923 { C(connect
), &type_netaddress
, validate_destaddr
},
924 { C(cookie_login_lifetime
), &type_integer
, validate_positive
},
925 { C(cookie_key_lifetime
), &type_integer
, validate_positive
},
926 { C(dbversion
), &type_integer
, validate_positive
},
927 { C(default_rights
), &type_rights
, validate_any
},
928 { C(device
), &type_string
, validate_any
},
929 { C(gap
), &type_integer
, validate_non_negative
},
930 { C(history
), &type_integer
, validate_positive
},
931 { C(home
), &type_string
, validate_isabspath
},
932 { C(listen
), &type_netaddress
, validate_any
},
933 { C(lock
), &type_boolean
, validate_any
},
934 { C(mail_sender
), &type_string
, validate_any
},
935 { C(mixer
), &type_string
, validate_any
},
936 { C(multicast_loop
), &type_boolean
, validate_any
},
937 { C(multicast_ttl
), &type_integer
, validate_non_negative
},
938 { C(namepart
), &type_namepart
, validate_any
},
939 { C(new_bias
), &type_integer
, validate_positive
},
940 { C(new_bias_age
), &type_integer
, validate_positive
},
941 { C(new_max
), &type_integer
, validate_positive
},
942 { C2(nice
, nice_rescan
), &type_integer
, validate_non_negative
},
943 { C(nice_rescan
), &type_integer
, validate_non_negative
},
944 { C(nice_server
), &type_integer
, validate_any
},
945 { C(nice_speaker
), &type_integer
, validate_any
},
946 { C(noticed_history
), &type_integer
, validate_positive
},
947 { C(password
), &type_string
, validate_any
},
948 { C(pause_mode
), &type_string
, validate_pausemode
},
949 { C(player
), &type_stringlist_accum
, validate_player
},
950 { C(plugins
), &type_string_accum
, validate_isdir
},
951 { C(prefsync
), &type_integer
, validate_positive
},
952 { C(queue_pad
), &type_integer
, validate_positive
},
953 { C(replay_min
), &type_integer
, validate_non_negative
},
954 { C(refresh
), &type_integer
, validate_positive
},
955 { C(reminder_interval
), &type_integer
, validate_positive
},
956 { C(remote_userman
), &type_boolean
, validate_any
},
957 { C2(restrict
, restrictions
), &type_restrict
, validate_any
},
958 { C(rtp_delay_threshold
), &type_integer
, validate_positive
},
959 { C(sample_format
), &type_sample_format
, validate_sample_format
},
960 { C(scratch
), &type_string_accum
, validate_isreg
},
961 { C(sendmail
), &type_string
, validate_isabspath
},
962 { C(short_display
), &type_integer
, validate_positive
},
963 { C(signal
), &type_signal
, validate_any
},
964 { C(smtp_server
), &type_string
, validate_any
},
965 { C(sox_generation
), &type_integer
, validate_non_negative
},
966 { C2(speaker_backend
, api
), &type_string
, validate_backend
},
967 { C(speaker_command
), &type_string
, validate_any
},
968 { C(stopword
), &type_string_accum
, validate_any
},
969 { C(templates
), &type_string_accum
, validate_isdir
},
970 { C(tracklength
), &type_stringlist_accum
, validate_tracklength
},
971 { C(transform
), &type_transform
, validate_any
},
972 { C(trust
), &type_string_accum
, validate_any
},
973 { C(url
), &type_string
, validate_url
},
974 { C(user
), &type_string
, validate_isauser
},
975 { C(username
), &type_string
, validate_any
},
978 /** @brief Find a configuration item's definition by key */
979 static const struct conf
*find(const char *key
) {
982 if((n
= TABLE_FIND(conf
, name
, key
)) < 0)
987 /** @brief Set a new configuration value */
988 static int config_set(const struct config_state
*cs
,
989 int nvec
, char **vec
) {
990 const struct conf
*which
;
992 D(("config_set %s", vec
[0]));
993 if(!(which
= find(vec
[0]))) {
994 error(0, "%s:%d: unknown configuration key '%s'",
995 cs
->path
, cs
->line
, vec
[0]);
998 return (which
->validate(cs
, nvec
- 1, vec
+ 1)
999 || which
->type
->set(cs
, which
, nvec
- 1, vec
+ 1));
1002 static int config_set_args(const struct config_state
*cs
,
1003 const char *which
, ...) {
1009 vector_append(v
, (char *)which
);
1010 va_start(ap
, which
);
1011 while((s
= va_arg(ap
, char *)))
1012 vector_append(v
, s
);
1014 vector_terminate(v
);
1015 return config_set(cs
, v
->nvec
, v
->vec
);
1018 /** @brief Error callback used by config_include() */
1019 static void config_error(const char *msg
, void *u
) {
1020 const struct config_state
*cs
= u
;
1022 error(0, "%s:%d: %s", cs
->path
, cs
->line
, msg
);
1025 /** @brief Include a file by name */
1026 static int config_include(struct config
*c
, const char *path
) {
1028 char *buffer
, *inputbuffer
, **vec
;
1030 struct config_state cs
;
1035 D(("%s: reading configuration", path
));
1036 if(!(fp
= fopen(path
, "r"))) {
1037 error(errno
, "error opening %s", path
);
1040 while(!inputline(path
, fp
, &inputbuffer
, '\n')) {
1042 if(!(buffer
= mb2utf8(inputbuffer
))) {
1043 error(errno
, "%s:%d: cannot convert to UTF-8", cs
.path
, cs
.line
);
1049 if(!(vec
= split(buffer
, &n
, SPLIT_COMMENTS
|SPLIT_QUOTES
,
1050 config_error
, &cs
))) {
1056 if(!strcmp(vec
[0], "include")) {
1058 error(0, "%s:%d: must be 'include PATH'", cs
.path
, cs
.line
);
1061 config_include(c
, vec
[1]);
1063 ret
|= config_set(&cs
, n
, vec
);
1065 for(n
= 0; vec
[n
]; ++n
) xfree(vec
[n
]);
1070 error(errno
, "error reading %s", path
);
1077 static const char *const default_stopwords
[] = {
1136 #define NDEFAULT_STOPWORDS (sizeof default_stopwords / sizeof *default_stopwords)
1138 static const char *const default_players
[] = {
1144 #define NDEFAULT_PLAYERS (sizeof default_players / sizeof *default_players)
1146 /** @brief Make a new default configuration */
1147 static struct config
*config_default(void) {
1148 struct config
*c
= xmalloc(sizeof *c
);
1149 const char *logname
;
1151 struct config_state cs
;
1154 cs
.path
= "<internal>";
1157 /* Strings had better be xstrdup'd as they will get freed at some point. */
1160 c
->home
= xstrdup(pkgstatedir
);
1161 if(!(pw
= getpwuid(getuid())))
1162 fatal(0, "cannot determine our username");
1163 logname
= pw
->pw_name
;
1164 c
->username
= xstrdup(logname
);
1167 c
->signal
= SIGKILL
;
1168 c
->alias
= xstrdup("{/artist}{/album}{/title}{ext}");
1170 c
->device
= xstrdup("default");
1171 c
->nice_rescan
= 10;
1172 c
->speaker_command
= 0;
1173 c
->sample_format
.bits
= 16;
1174 c
->sample_format
.rate
= 44100;
1175 c
->sample_format
.channels
= 2;
1176 c
->sample_format
.endian
= ENDIAN_NATIVE
;
1178 c
->replay_min
= 8 * 3600;
1180 c
->multicast_ttl
= 1;
1181 c
->multicast_loop
= 1;
1182 c
->authorization_algorithm
= xstrdup("sha1");
1183 c
->noticed_history
= 31;
1184 c
->short_display
= 32;
1188 c
->cookie_login_lifetime
= 86400;
1189 c
->cookie_key_lifetime
= 86400 * 7;
1190 if(sendmail_binary
[0] && strcmp(sendmail_binary
, "none"))
1191 c
->sendmail
= xstrdup(sendmail_binary
);
1192 c
->smtp_server
= xstrdup("127.0.0.1");
1194 c
->reminder_interval
= 600; /* 10m */
1195 c
->new_bias_age
= 7 * 86400; /* 1 week */
1196 c
->new_bias
= 4500000; /* 50 times the base weight */
1197 c
->sox_generation
= DEFAULT_SOX_GENERATION
;
1198 /* Default stopwords */
1199 if(config_set(&cs
, (int)NDEFAULT_STOPWORDS
, (char **)default_stopwords
))
1201 /* Default player configuration */
1202 for(n
= 0; n
< NDEFAULT_PLAYERS
; ++n
) {
1203 if(config_set_args(&cs
, "player",
1204 default_players
[n
], "execraw", "disorder-decode", (char *)0))
1206 if(config_set_args(&cs
, "tracklength",
1207 default_players
[n
], "disorder-tracklength", (char *)0))
1210 c
->broadcast
.af
= -1;
1211 c
->broadcast_from
.af
= -1;
1217 char *config_get_file2(struct config
*c
, const char *name
) {
1220 byte_xasprintf(&s
, "%s/%s", c
->home
, name
);
1224 /** @brief Set the default configuration file */
1225 static void set_configfile(void) {
1227 byte_xasprintf(&configfile
, "%s/config", pkgconfdir
);
1230 /** @brief Free a configuration object */
1231 static void config_free(struct config
*c
) {
1235 for(n
= 0; n
< (int)(sizeof conf
/ sizeof *conf
); ++n
)
1236 conf
[n
].type
->free(c
, &conf
[n
]);
1237 for(n
= 0; n
< c
->nparts
; ++n
)
1244 /** @brief Set post-parse defaults */
1245 static void config_postdefaults(struct config
*c
,
1247 struct config_state cs
;
1248 const struct conf
*whoami
;
1251 static const char *namepart
[][4] = {
1252 { "title", "/([0-9]+ *[-:]? *)?([^/]+)\\.[a-zA-Z0-9]+$", "$2", "display" },
1253 { "title", "/([^/]+)\\.[a-zA-Z0-9]+$", "$1", "sort" },
1254 { "album", "/([^/]+)/[^/]+$", "$1", "*" },
1255 { "artist", "/([^/]+)/[^/]+/[^/]+$", "$1", "*" },
1256 { "ext", "(\\.[a-zA-Z0-9]+)$", "$1", "*" },
1258 #define NNAMEPART (int)(sizeof namepart / sizeof *namepart)
1260 static const char *transform
[][5] = {
1261 { "track", "^.*/([0-9]+ *[-:]? *)?([^/]+)\\.[a-zA-Z0-9]+$", "$2", "display", "" },
1262 { "track", "^.*/([^/]+)\\.[a-zA-Z0-9]+$", "$1", "sort", "" },
1263 { "dir", "^.*/([^/]+)$", "$1", "*", "" },
1264 { "dir", "^(the) ([^/]*)", "$2, $1", "sort", "i", },
1265 { "dir", "[[:punct:]]", "", "sort", "g", }
1267 #define NTRANSFORM (int)(sizeof transform / sizeof *transform)
1269 cs
.path
= "<internal>";
1272 if(!c
->namepart
.n
) {
1273 whoami
= find("namepart");
1274 for(n
= 0; n
< NNAMEPART
; ++n
)
1275 set_namepart(&cs
, whoami
, 4, (char **)namepart
[n
]);
1277 if(!c
->transform
.n
) {
1278 whoami
= find("transform");
1279 for(n
= 0; n
< NTRANSFORM
; ++n
)
1280 set_transform(&cs
, whoami
, 5, (char **)transform
[n
]);
1283 if(c
->speaker_command
)
1284 c
->api
= xstrdup("command");
1285 else if(c
->broadcast
.af
!= -1)
1286 c
->api
= xstrdup("rtp");
1287 else if(config_uaudio_apis
)
1288 c
->api
= xstrdup(config_uaudio_apis
[0]->name
);
1290 c
->api
= xstrdup("<none>");
1292 if(!strcmp(c
->api
, "network"))
1293 c
->api
= xstrdup("rtp");
1295 if(!strcmp(c
->api
, "command") && !c
->speaker_command
)
1296 fatal(0, "'api command' but speaker_command is not set");
1297 if((!strcmp(c
->api
, "rtp")) && c
->broadcast
.af
== -1)
1298 fatal(0, "'api rtp' but broadcast is not set");
1300 /* Override sample format */
1301 if(!strcmp(c
->api
, "rtp")) {
1302 c
->sample_format
.rate
= 44100;
1303 c
->sample_format
.channels
= 2;
1304 c
->sample_format
.bits
= 16;
1305 c
->sample_format
.endian
= ENDIAN_NATIVE
;
1307 if(!strcmp(c
->api
, "coreaudio")) {
1308 c
->sample_format
.rate
= 44100;
1309 c
->sample_format
.channels
= 2;
1310 c
->sample_format
.bits
= 16;
1311 c
->sample_format
.endian
= ENDIAN_NATIVE
;
1313 if(!c
->default_rights
) {
1314 rights_type r
= RIGHTS__MASK
& ~(RIGHT_ADMIN
|RIGHT_REGISTER
1316 |RIGHT_SCRATCH__MASK
1317 |RIGHT_REMOVE__MASK
);
1318 /* The idea is to approximate the meaning of the old 'restrict' directive
1319 * in the default rights if they are not overridden. */
1320 if(c
->restrictions
& RESTRICT_SCRATCH
)
1321 r
|= RIGHT_SCRATCH_MINE
|RIGHT_SCRATCH_RANDOM
;
1323 r
|= RIGHT_SCRATCH_ANY
;
1324 if(!(c
->restrictions
& RESTRICT_MOVE
))
1325 r
|= RIGHT_MOVE_ANY
;
1326 if(c
->restrictions
& RESTRICT_REMOVE
)
1327 r
|= RIGHT_REMOVE_MINE
;
1329 r
|= RIGHT_REMOVE_ANY
;
1330 c
->default_rights
= rights_string(r
);
1334 /** @brief (Re-)read the config file
1335 * @param server If set, do extra checking
1336 * @param oldconfig Old configuration for compatibility check
1337 * @return 0 on success, non-0 on error
1339 * If @p oldconfig is set, then certain compatibility checks are done between
1340 * the old and new configurations.
1342 int config_read(int server
,
1343 const struct config
*oldconfig
) {
1349 c
= config_default();
1350 /* standalone Disobedience installs might not have a global config file */
1351 if(access(configfile
, F_OK
) == 0)
1352 if(config_include(c
, configfile
))
1354 /* if we can read the private config file, do */
1355 if((privconf
= config_private())
1356 && access(privconf
, R_OK
) == 0
1357 && config_include(c
, privconf
))
1360 /* if there's a per-user system config file for this user, read it */
1361 if(config_per_user
) {
1362 if(!(pw
= getpwuid(getuid())))
1363 fatal(0, "cannot determine our username");
1364 if((privconf
= config_usersysconf(pw
))
1365 && access(privconf
, F_OK
) == 0
1366 && config_include(c
, privconf
))
1369 /* if we have a password file, read it */
1370 if((privconf
= config_userconf(0, pw
))
1371 && access(privconf
, F_OK
) == 0
1372 && config_include(c
, privconf
))
1376 /* install default namepart and transform settings */
1377 config_postdefaults(c
, server
);
1380 if(strcmp(c
->home
, oldconfig
->home
)) {
1381 error(0, "'home' cannot be changed without a restart");
1384 if(strcmp(c
->alias
, oldconfig
->alias
)) {
1385 error(0, "'alias' cannot be changed without a restart");
1388 if(strcmp(c
->user
, oldconfig
->user
)) {
1389 error(0, "'user' cannot be changed without a restart");
1392 if(c
->nice_speaker
!= oldconfig
->nice_speaker
) {
1393 error(0, "'nice_speaker' cannot be changed without a restart");
1394 /* ...but we accept the new config anyway */
1396 if(c
->nice_server
!= oldconfig
->nice_server
) {
1397 error(0, "'nice_server' cannot be changed without a restart");
1398 /* ...but we accept the new config anyway */
1400 if(namepartlist_compare(&c
->namepart
, &oldconfig
->namepart
)) {
1401 error(0, "'namepart' settings cannot be changed without a restart");
1404 if(stringlist_compare(&c
->stopword
, &oldconfig
->stopword
)) {
1405 error(0, "'stopword' settings cannot be changed without a restart");
1409 error(0, "not installing incompatible new configuration");
1413 /* everything is good so we shall use the new config */
1414 config_free(config
);
1415 /* warn about obsolete directives */
1417 error(0, "'restrict' will be removed in a future version");
1419 error(0, "'allow' will be removed in a future version");
1421 error(0, "'trust' will be removed in a future version");
1423 error(0, "'lock' will be removed in a future version");
1425 error(0, "'gap' will be removed in a future version");
1427 error(0, "'prefsync' will be removed in a future version");
1432 /** @brief Return the path to the private configuration file */
1433 char *config_private(void) {
1437 byte_xasprintf(&s
, "%s.private", configfile
);
1441 /** @brief Return the path to user's personal configuration file */
1442 char *config_userconf(const char *home
, const struct passwd
*pw
) {
1445 if(!home
&& !pw
&& !(pw
= getpwuid(getuid())))
1446 fatal(0, "cannot determine our username");
1447 byte_xasprintf(&s
, "%s/.disorder/passwd", home ? home
: pw
->pw_dir
);
1451 /** @brief Return the path to user-specific system configuration */
1452 char *config_usersysconf(const struct passwd
*pw
) {
1456 if(!strchr(pw
->pw_name
, '/')) {
1457 byte_xasprintf(&s
, "%s.%s", configfile
, pw
->pw_name
);
1463 char *config_get_file(const char *name
) {
1464 return config_get_file2(config
, name
);
1467 static int stringlist_compare(const struct stringlist
*a
,
1468 const struct stringlist
*b
) {
1471 while(n
< a
->n
&& n
< b
->n
) {
1472 if((c
= strcmp(a
->s
[n
], b
->s
[n
])))
1478 else if(a
->n
> b
->n
)
1484 static int namepart_compare(const struct namepart
*a
,
1485 const struct namepart
*b
) {
1488 if((c
= strcmp(a
->part
, b
->part
)))
1490 if((c
= strcmp(a
->res
, b
->res
)))
1492 if((c
= strcmp(a
->replace
, b
->replace
)))
1494 if((c
= strcmp(a
->context
, b
->context
)))
1496 if(a
->reflags
> b
->reflags
)
1498 if(a
->reflags
< b
->reflags
)
1503 static int namepartlist_compare(const struct namepartlist
*a
,
1504 const struct namepartlist
*b
) {
1507 while(n
< a
->n
&& n
< b
->n
) {
1508 if((c
= namepart_compare(&a
->s
[n
], &b
->s
[n
])))
1514 else if(a
->n
< b
->n
)