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 */
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 error(0, "%s:%d: '%s' requires one argument",
146 cs
->path
, cs
->line
, whoami
->name
);
149 if((n
= find_signal(vec
[0])) == -1) {
150 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 error(0, "%s:%d: '%s' requires at least one argument",
182 cs
->path
, cs
->line
, whoami
->name
);
185 error(0, "%s:%d: '%s' requires at most three arguments",
186 cs
->path
, cs
->line
, whoami
->name
);
189 /* Sanity check root */
191 error(0, "%s:%d: collection root must start with '/'",
195 if(root
[1] && root
[strlen(root
)-1] == '/') {
196 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 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 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 error(0, "%s:%d: '%s' takes only one argument",
240 cs
->path
, cs
->line
, whoami
->name
);
243 VALUE(cs
->config
, char *) = xstrdup(vec
[0]);
247 static int set_stringlist(const struct config_state
*cs
,
248 const struct conf
*whoami
,
249 int nvec
, char **vec
) {
251 struct stringlist
*sl
;
253 sl
= ADDRESS(cs
->config
, struct stringlist
);
255 for(n
= 0; n
< nvec
; ++n
) {
257 sl
->s
= xrealloc(sl
->s
, (sl
->n
* sizeof (char *)));
258 sl
->s
[sl
->n
- 1] = xstrdup(vec
[n
]);
263 static int set_integer(const struct config_state
*cs
,
264 const struct conf
*whoami
,
265 int nvec
, char **vec
) {
269 error(0, "%s:%d: '%s' takes only one argument",
270 cs
->path
, cs
->line
, whoami
->name
);
273 if(xstrtol(ADDRESS(cs
->config
, long), vec
[0], &e
, 0)) {
274 error(errno
, "%s:%d: converting integer", cs
->path
, cs
->line
);
278 error(0, "%s:%d: invalid integer syntax", cs
->path
, cs
->line
);
284 static int set_stringlist_accum(const struct config_state
*cs
,
285 const struct conf
*whoami
,
286 int nvec
, char **vec
) {
288 struct stringlist
*s
;
289 struct stringlistlist
*sll
;
291 sll
= ADDRESS(cs
->config
, struct stringlistlist
);
297 sll
->s
= xrealloc(sll
->s
, (sll
->n
* sizeof (struct stringlist
)));
298 s
= &sll
->s
[sll
->n
- 1];
300 s
->s
= xmalloc((nvec
+ 1) * sizeof (char *));
301 for(n
= 0; n
< nvec
; ++n
)
302 s
->s
[n
] = xstrdup(vec
[n
]);
306 static int set_string_accum(const struct config_state
*cs
,
307 const struct conf
*whoami
,
308 int nvec
, char **vec
) {
310 struct stringlist
*sl
;
312 sl
= ADDRESS(cs
->config
, struct stringlist
);
317 for(n
= 0; n
< nvec
; ++n
) {
319 sl
->s
= xrealloc(sl
->s
, (sl
->n
* sizeof (char *)));
320 sl
->s
[sl
->n
- 1] = xstrdup(vec
[n
]);
325 static int set_restrict(const struct config_state
*cs
,
326 const struct conf
*whoami
,
327 int nvec
, char **vec
) {
331 static const struct restriction
{
335 { "remove", RESTRICT_REMOVE
},
336 { "scratch", RESTRICT_SCRATCH
},
337 { "move", RESTRICT_MOVE
},
340 for(n
= 0; n
< nvec
; ++n
) {
341 if((i
= TABLE_FIND(restrictions
, name
, vec
[n
])) < 0) {
342 error(0, "%s:%d: invalid restriction '%s'",
343 cs
->path
, cs
->line
, vec
[n
]);
346 r
|= restrictions
[i
].bit
;
348 VALUE(cs
->config
, unsigned) = r
;
352 static int parse_sample_format(const struct config_state
*cs
,
353 struct stream_header
*format
,
354 int nvec
, char **vec
) {
359 error(0, "%s:%d: wrong number of arguments", cs
->path
, cs
->line
);
362 if(xstrtol(&t
, p
, &p
, 0)) {
363 error(errno
, "%s:%d: converting bits-per-sample", cs
->path
, cs
->line
);
366 if(t
!= 8 && t
!= 16) {
367 error(0, "%s:%d: bad bite-per-sample (%ld)", cs
->path
, cs
->line
, t
);
370 if(format
) format
->bits
= t
;
372 case 'l': case 'L': t
= ENDIAN_LITTLE
; p
++; break;
373 case 'b': case 'B': t
= ENDIAN_BIG
; p
++; break;
374 default: t
= ENDIAN_NATIVE
; break;
376 if(format
) format
->endian
= t
;
378 error(errno
, "%s:%d: expected `/' after bits-per-sample",
383 if(xstrtol(&t
, p
, &p
, 0)) {
384 error(errno
, "%s:%d: converting sample-rate", cs
->path
, cs
->line
);
387 if(t
< 1 || t
> INT_MAX
) {
388 error(0, "%s:%d: silly sample-rate (%ld)", cs
->path
, cs
->line
, t
);
391 if(format
) format
->rate
= t
;
393 error(0, "%s:%d: expected `/' after sample-rate",
398 if(xstrtol(&t
, p
, &p
, 0)) {
399 error(errno
, "%s:%d: converting channels", cs
->path
, cs
->line
);
403 error(0, "%s:%d: silly number (%ld) of channels", cs
->path
, cs
->line
, t
);
406 if(format
) format
->channels
= t
;
408 error(0, "%s:%d: junk after channels", cs
->path
, cs
->line
);
414 static int set_sample_format(const struct config_state
*cs
,
415 const struct conf
*whoami
,
416 int nvec
, char **vec
) {
417 return parse_sample_format(cs
, ADDRESS(cs
->config
, struct stream_header
),
421 static int set_namepart(const struct config_state
*cs
,
422 const struct conf
*whoami
,
423 int nvec
, char **vec
) {
424 struct namepartlist
*npl
= ADDRESS(cs
->config
, struct namepartlist
);
431 error(0, "%s:%d: namepart needs at least 3 arguments", cs
->path
, cs
->line
);
435 error(0, "%s:%d: namepart needs at most 5 arguments", cs
->path
, cs
->line
);
438 reflags
= nvec
>= 5 ?
regsub_flags(vec
[4]) : 0;
439 if(!(re
= pcre_compile(vec
[1],
441 |regsub_compile_options(reflags
),
442 &errstr
, &erroffset
, 0))) {
443 error(0, "%s:%d: error compiling regexp /%s/: %s (offset %d)",
444 cs
->path
, cs
->line
, vec
[1], errstr
, erroffset
);
447 npl
->s
= xrealloc(npl
->s
, (npl
->n
+ 1) * sizeof (struct namepart
));
448 npl
->s
[npl
->n
].part
= xstrdup(vec
[0]);
449 npl
->s
[npl
->n
].re
= re
;
450 npl
->s
[npl
->n
].res
= xstrdup(vec
[1]);
451 npl
->s
[npl
->n
].replace
= xstrdup(vec
[2]);
452 npl
->s
[npl
->n
].context
= xstrdup(vec
[3]);
453 npl
->s
[npl
->n
].reflags
= reflags
;
455 /* XXX a bit of a bodge; relies on there being very few parts. */
456 for(n
= 0; (n
< cs
->config
->nparts
457 && strcmp(cs
->config
->parts
[n
], vec
[0])); ++n
)
459 if(n
>= cs
->config
->nparts
) {
460 cs
->config
->parts
= xrealloc(cs
->config
->parts
,
461 (cs
->config
->nparts
+ 1) * sizeof (char *));
462 cs
->config
->parts
[cs
->config
->nparts
++] = xstrdup(vec
[0]);
467 static int set_transform(const struct config_state
*cs
,
468 const struct conf
*whoami
,
469 int nvec
, char **vec
) {
470 struct transformlist
*tl
= ADDRESS(cs
->config
, struct transformlist
);
477 error(0, "%s:%d: transform needs at least 3 arguments", cs
->path
, cs
->line
);
481 error(0, "%s:%d: transform needs at most 5 arguments", cs
->path
, cs
->line
);
484 reflags
= (nvec
>= 5 ?
regsub_flags(vec
[4]) : 0);
485 if(!(re
= pcre_compile(vec
[1],
487 |regsub_compile_options(reflags
),
488 &errstr
, &erroffset
, 0))) {
489 error(0, "%s:%d: error compiling regexp /%s/: %s (offset %d)",
490 cs
->path
, cs
->line
, vec
[1], errstr
, erroffset
);
493 tl
->t
= xrealloc(tl
->t
, (tl
->n
+ 1) * sizeof (struct namepart
));
494 tl
->t
[tl
->n
].type
= xstrdup(vec
[0]);
495 tl
->t
[tl
->n
].context
= xstrdup(vec
[3] ? vec
[3] : "*");
496 tl
->t
[tl
->n
].re
= re
;
497 tl
->t
[tl
->n
].replace
= xstrdup(vec
[2]);
498 tl
->t
[tl
->n
].flags
= reflags
;
503 static int set_rights(const struct config_state
*cs
,
504 const struct conf
*whoami
,
505 int nvec
, char **vec
) {
507 error(0, "%s:%d: '%s' requires one argument",
508 cs
->path
, cs
->line
, whoami
->name
);
511 if(parse_rights(vec
[0], 0, 1)) {
512 error(0, "%s:%d: invalid rights string '%s'",
513 cs
->path
, cs
->line
, vec
[0]);
516 *ADDRESS(cs
->config
, char *) = vec
[0];
520 static int set_netaddress(const struct config_state
*cs
,
521 const struct conf
*whoami
,
522 int nvec
, char **vec
) {
523 struct netaddress
*na
= ADDRESS(cs
->config
, struct netaddress
);
525 if(netaddress_parse(na
, nvec
, vec
)) {
526 error(0, "%s:%d: invalid network address", cs
->path
, cs
->line
);
534 static void free_none(struct config
attribute((unused
)) *c
,
535 const struct conf
attribute((unused
)) *whoami
) {
538 static void free_string(struct config
*c
,
539 const struct conf
*whoami
) {
540 xfree(VALUE(c
, char *));
541 VALUE(c
, char *) = 0;
544 static void free_stringlist(struct config
*c
,
545 const struct conf
*whoami
) {
547 struct stringlist
*sl
= ADDRESS(c
, struct stringlist
);
549 for(n
= 0; n
< sl
->n
; ++n
)
554 static void free_stringlistlist(struct config
*c
,
555 const struct conf
*whoami
) {
557 struct stringlistlist
*sll
= ADDRESS(c
, struct stringlistlist
);
558 struct stringlist
*sl
;
560 for(n
= 0; n
< sll
->n
; ++n
) {
562 for(m
= 0; m
< sl
->n
; ++m
)
569 static void free_collectionlist(struct config
*c
,
570 const struct conf
*whoami
) {
571 struct collectionlist
*cll
= ADDRESS(c
, struct collectionlist
);
572 struct collection
*cl
;
575 for(n
= 0; n
< cll
->n
; ++n
) {
584 static void free_namepartlist(struct config
*c
,
585 const struct conf
*whoami
) {
586 struct namepartlist
*npl
= ADDRESS(c
, struct namepartlist
);
590 for(n
= 0; n
< npl
->n
; ++n
) {
593 pcre_free(np
->re
); /* ...whatever pcre_free is set to. */
601 static void free_transformlist(struct config
*c
,
602 const struct conf
*whoami
) {
603 struct transformlist
*tl
= ADDRESS(c
, struct transformlist
);
607 for(n
= 0; n
< tl
->n
; ++n
) {
610 pcre_free(t
->re
); /* ...whatever pcre_free is set to. */
617 static void free_netaddress(struct config
*c
,
618 const struct conf
*whoami
) {
619 struct netaddress
*na
= ADDRESS(c
, struct netaddress
);
624 /* configuration types */
626 static const struct conftype
627 type_signal
= { set_signal
, free_none
},
628 type_collections
= { set_collections
, free_collectionlist
},
629 type_boolean
= { set_boolean
, free_none
},
630 type_string
= { set_string
, free_string
},
631 type_stringlist
= { set_stringlist
, free_stringlist
},
632 type_integer
= { set_integer
, free_none
},
633 type_stringlist_accum
= { set_stringlist_accum
, free_stringlistlist
},
634 type_string_accum
= { set_string_accum
, free_stringlist
},
635 type_sample_format
= { set_sample_format
, free_none
},
636 type_restrict
= { set_restrict
, free_none
},
637 type_namepart
= { set_namepart
, free_namepartlist
},
638 type_transform
= { set_transform
, free_transformlist
},
639 type_netaddress
= { set_netaddress
, free_netaddress
},
640 type_rights
= { set_rights
, free_none
};
642 /* specific validation routine */
644 /** @brief Perform a test on a filename
645 * @param test Test function to call on mode bits
646 * @param what Type of file sought
648 * If @p test returns 0 then the file is not a @p what and an error
649 * is reported and -1 is returned.
651 #define VALIDATE_FILE(test, what) do { \
655 for(n = 0; n < nvec; ++n) { \
656 if(stat(vec[n], &sb) < 0) { \
657 error(errno, "%s:%d: %s", cs->path, cs->line, vec[n]); \
660 if(!test(sb.st_mode)) { \
661 error(0, "%s:%d: %s is not a %s", \
662 cs->path, cs->line, vec[n], what); \
668 /** @brief Validate an absolute path
669 * @param cs Configuration state
670 * @param nvec Length of (proposed) new value
671 * @param vec Elements of new value
672 * @return 0 on success, non-0 on error
674 static int validate_isabspath(const struct config_state
*cs
,
675 int nvec
, char **vec
) {
678 for(n
= 0; n
< nvec
; ++n
)
679 if(vec
[n
][0] != '/') {
680 error(errno
, "%s:%d: %s: not an absolute path",
681 cs
->path
, cs
->line
, vec
[n
]);
687 /** @brief Validate an existing directory
688 * @param cs Configuration state
689 * @param nvec Length of (proposed) new value
690 * @param vec Elements of new value
691 * @return 0 on success, non-0 on error
693 static int validate_isdir(const struct config_state
*cs
,
694 int nvec
, char **vec
) {
695 VALIDATE_FILE(S_ISDIR
, "directory");
699 /** @brief Validate an existing regular file
700 * @param cs Configuration state
701 * @param nvec Length of (proposed) new value
702 * @param vec Elements of new value
703 * @return 0 on success, non-0 on error
705 static int validate_isreg(const struct config_state
*cs
,
706 int nvec
, char **vec
) {
707 VALIDATE_FILE(S_ISREG
, "regular file");
711 /** @brief Validate a player pattern
712 * @param cs Configuration state
713 * @param nvec Length of (proposed) new value
714 * @param vec Elements of new value
715 * @return 0 on success, non-0 on error
717 static int validate_player(const struct config_state
*cs
,
719 char attribute((unused
)) **vec
) {
721 error(0, "%s:%d: should be at least 'player PATTERN MODULE'",
728 /** @brief Validate a track length pattern
729 * @param cs Configuration state
730 * @param nvec Length of (proposed) new value
731 * @param vec Elements of new value
732 * @return 0 on success, non-0 on error
734 static int validate_tracklength(const struct config_state
*cs
,
736 char attribute((unused
)) **vec
) {
738 error(0, "%s:%d: should be at least 'tracklength PATTERN MODULE'",
745 /** @brief Validate an allow directive
746 * @param cs Configuration state
747 * @param nvec Length of (proposed) new value
748 * @param vec Elements of new value
749 * @return 0 on success, non-0 on error
751 * Obsolete - only used for parsing legacy configuration.
753 static int validate_allow(const struct config_state
*cs
,
755 char attribute((unused
)) **vec
) {
757 error(0, "%s:%d: must be 'allow NAME PASS'", cs
->path
, cs
->line
);
763 /** @brief Validate a non-negative (@c long) integer
764 * @param cs Configuration state
765 * @param nvec Length of (proposed) new value
766 * @param vec Elements of new value
767 * @return 0 on success, non-0 on error
769 static int validate_non_negative(const struct config_state
*cs
,
770 int nvec
, char **vec
) {
774 error(0, "%s:%d: missing argument", cs
->path
, cs
->line
);
778 error(0, "%s:%d: too many arguments", cs
->path
, cs
->line
);
781 if(xstrtol(&n
, vec
[0], 0, 0)) {
782 error(0, "%s:%d: %s", cs
->path
, cs
->line
, strerror(errno
));
786 error(0, "%s:%d: must not be negative", cs
->path
, cs
->line
);
792 /** @brief Validate a positive (@c long) integer
793 * @param cs Configuration state
794 * @param nvec Length of (proposed) new value
795 * @param vec Elements of new value
796 * @return 0 on success, non-0 on error
798 static int validate_positive(const struct config_state
*cs
,
799 int nvec
, char **vec
) {
803 error(0, "%s:%d: missing argument", cs
->path
, cs
->line
);
807 error(0, "%s:%d: too many arguments", cs
->path
, cs
->line
);
810 if(xstrtol(&n
, vec
[0], 0, 0)) {
811 error(0, "%s:%d: %s", cs
->path
, cs
->line
, strerror(errno
));
815 error(0, "%s:%d: must be positive", cs
->path
, cs
->line
);
821 /** @brief Validate a system username
822 * @param cs Configuration state
823 * @param nvec Length of (proposed) new value
824 * @param vec Elements of new value
825 * @return 0 on success, non-0 on error
827 static int validate_isauser(const struct config_state
*cs
,
828 int attribute((unused
)) nvec
,
832 if(!(pw
= getpwnam(vec
[0]))) {
833 error(0, "%s:%d: no such user as '%s'", cs
->path
, cs
->line
, vec
[0]);
839 /** @brief Validate a sample format string
840 * @param cs Configuration state
841 * @param nvec Length of (proposed) new value
842 * @param vec Elements of new value
843 * @return 0 on success, non-0 on error
845 static int validate_sample_format(const struct config_state
*cs
,
846 int attribute((unused
)) nvec
,
848 return parse_sample_format(cs
, 0, nvec
, vec
);
851 /** @brief Validate anything
852 * @param cs Configuration state
853 * @param nvec Length of (proposed) new value
854 * @param vec Elements of new value
857 static int validate_any(const struct config_state
attribute((unused
)) *cs
,
858 int attribute((unused
)) nvec
,
859 char attribute((unused
)) **vec
) {
863 /** @brief Validate a URL
864 * @param cs Configuration state
865 * @param nvec Length of (proposed) new value
866 * @param vec Elements of new value
867 * @return 0 on success, non-0 on error
871 static int validate_url(const struct config_state
attribute((unused
)) *cs
,
872 int attribute((unused
)) nvec
,
876 /* absoluteURI = scheme ":" ( hier_part | opaque_part )
877 scheme = alpha *( alpha | digit | "+" | "-" | "." ) */
879 n
= strspn(s
, ("abcdefghijklmnopqrstuvwxyz"
880 "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
883 error(0, "%s:%d: invalid url '%s'", cs
->path
, cs
->line
, vec
[0]);
886 if(!strncmp(s
, "http:", 5)
887 || !strncmp(s
, "https:", 6)) {
889 /* we only do a rather cursory check */
890 if(strncmp(s
, "//", 2)) {
891 error(0, "%s:%d: invalid url '%s'", cs
->path
, cs
->line
, vec
[0]);
898 /** @brief Validate an alias pattern
899 * @param cs Configuration state
900 * @param nvec Length of (proposed) new value
901 * @param vec Elements of new value
902 * @return 0 on success, non-0 on error
904 static int validate_alias(const struct config_state
*cs
,
908 int in_brackets
= 0, c
;
911 error(0, "%s:%d: missing argument", cs
->path
, cs
->line
);
915 error(0, "%s:%d: too many arguments", cs
->path
, cs
->line
);
919 while((c
= (unsigned char)*s
++)) {
923 else if(!isalnum(c
)) {
924 error(0, "%s:%d: invalid part name in alias expansion in '%s'",
925 cs
->path
, cs
->line
, vec
[0]);
933 } else if(c
== '\\') {
934 if(!(c
= (unsigned char)*s
++)) {
935 error(0, "%s:%d: unterminated escape in alias expansion in '%s'",
936 cs
->path
, cs
->line
, vec
[0]);
938 } else if(c
!= '\\' && c
!= '{') {
939 error(0, "%s:%d: invalid escape in alias expansion in '%s'",
940 cs
->path
, cs
->line
, vec
[0]);
948 error(0, "%s:%d: unterminated part name in alias expansion in '%s'",
949 cs
->path
, cs
->line
, vec
[0]);
955 /** @brief Validate a hash algorithm name
956 * @param cs Configuration state
957 * @param nvec Length of (proposed) new value
958 * @param vec Elements of new value
959 * @return 0 on success, non-0 on error
961 static int validate_algo(const struct config_state
attribute((unused
)) *cs
,
965 error(0, "%s:%d: invalid algorithm specification", cs
->path
, cs
->line
);
968 if(!valid_authhash(vec
[0])) {
969 error(0, "%s:%d: unsuported algorithm '%s'", cs
->path
, cs
->line
, vec
[0]);
975 /** @brief Validate a playback backend name
976 * @param cs Configuration state
977 * @param nvec Length of (proposed) new value
978 * @param vec Elements of new value
979 * @return 0 on success, non-0 on error
981 static int validate_backend(const struct config_state
attribute((unused
)) *cs
,
986 error(0, "%s:%d: invalid sound API specification", cs
->path
, cs
->line
);
989 if(!strcmp(vec
[0], "network")) {
990 error(0, "'api network' is deprecated; use 'api rtp'");
993 if(config_uaudio_apis
) {
994 for(n
= 0; config_uaudio_apis
[n
]; ++n
)
995 if(!strcmp(vec
[0], config_uaudio_apis
[n
]->name
))
997 error(0, "%s:%d: unrecognized sound API '%s'", cs
->path
, cs
->line
, vec
[0]);
1000 /* In non-server processes we have no idea what's valid */
1004 /** @brief Validate a pause mode string
1005 * @param cs Configuration state
1006 * @param nvec Length of (proposed) new value
1007 * @param vec Elements of new value
1008 * @return 0 on success, non-0 on error
1010 static int validate_pausemode(const struct config_state
attribute((unused
)) *cs
,
1013 if(nvec
== 1 && (!strcmp(vec
[0], "silence") || !strcmp(vec
[0], "suspend")))
1015 error(0, "%s:%d: invalid pause mode", cs
->path
, cs
->line
);
1019 /** @brief Validate a destination network address
1020 * @param cs Configuration state
1021 * @param nvec Length of (proposed) new value
1022 * @param vec Elements of new value
1023 * @return 0 on success, non-0 on error
1025 * By a destination address, it is meant that it must not be a wildcard
1028 static int validate_destaddr(const struct config_state
attribute((unused
)) *cs
,
1031 struct netaddress na
[1];
1033 if(netaddress_parse(na
, nvec
, vec
)) {
1034 error(0, "%s:%d: invalid network address", cs
->path
, cs
->line
);
1038 error(0, "%s:%d: destination address required", cs
->path
, cs
->line
);
1044 /** @brief Item name and and offset */
1045 #define C(x) #x, offsetof(struct config, x)
1046 /** @brief Item name and and offset */
1047 #define C2(x,y) #x, offsetof(struct config, y)
1049 /** @brief All configuration items */
1050 static const struct conf conf
[] = {
1051 { C(alias
), &type_string
, validate_alias
},
1052 { C(allow
), &type_stringlist_accum
, validate_allow
},
1053 { C(api
), &type_string
, validate_backend
},
1054 { C(authorization_algorithm
), &type_string
, validate_algo
},
1055 { C(broadcast
), &type_netaddress
, validate_destaddr
},
1056 { C(broadcast_from
), &type_netaddress
, validate_any
},
1057 { C(channel
), &type_string
, validate_any
},
1058 { C(checkpoint_kbyte
), &type_integer
, validate_non_negative
},
1059 { C(checkpoint_min
), &type_integer
, validate_non_negative
},
1060 { C(collection
), &type_collections
, validate_any
},
1061 { C(connect
), &type_netaddress
, validate_destaddr
},
1062 { C(cookie_login_lifetime
), &type_integer
, validate_positive
},
1063 { C(cookie_key_lifetime
), &type_integer
, validate_positive
},
1064 { C(dbversion
), &type_integer
, validate_positive
},
1065 { C(default_rights
), &type_rights
, validate_any
},
1066 { C(device
), &type_string
, validate_any
},
1067 { C(gap
), &type_integer
, validate_non_negative
},
1068 { C(history
), &type_integer
, validate_positive
},
1069 { C(home
), &type_string
, validate_isabspath
},
1070 { C(listen
), &type_netaddress
, validate_any
},
1071 { C(lock
), &type_boolean
, validate_any
},
1072 { C(mail_sender
), &type_string
, validate_any
},
1073 { C(mixer
), &type_string
, validate_any
},
1074 { C(multicast_loop
), &type_boolean
, validate_any
},
1075 { C(multicast_ttl
), &type_integer
, validate_non_negative
},
1076 { C(namepart
), &type_namepart
, validate_any
},
1077 { C(new_bias
), &type_integer
, validate_positive
},
1078 { C(new_bias_age
), &type_integer
, validate_positive
},
1079 { C(new_max
), &type_integer
, validate_positive
},
1080 { C2(nice
, nice_rescan
), &type_integer
, validate_non_negative
},
1081 { C(nice_rescan
), &type_integer
, validate_non_negative
},
1082 { C(nice_server
), &type_integer
, validate_any
},
1083 { C(nice_speaker
), &type_integer
, validate_any
},
1084 { C(noticed_history
), &type_integer
, validate_positive
},
1085 { C(password
), &type_string
, validate_any
},
1086 { C(pause_mode
), &type_string
, validate_pausemode
},
1087 { C(player
), &type_stringlist_accum
, validate_player
},
1088 { C(playlist_lock_timeout
), &type_integer
, validate_positive
},
1089 { C(playlist_max
) , &type_integer
, validate_positive
},
1090 { C(plugins
), &type_string_accum
, validate_isdir
},
1091 { C(prefsync
), &type_integer
, validate_positive
},
1092 { C(queue_pad
), &type_integer
, validate_positive
},
1093 { C(replay_min
), &type_integer
, validate_non_negative
},
1094 { C(refresh
), &type_integer
, validate_positive
},
1095 { C(reminder_interval
), &type_integer
, validate_positive
},
1096 { C(remote_userman
), &type_boolean
, validate_any
},
1097 { C2(restrict
, restrictions
), &type_restrict
, validate_any
},
1098 { C(rtp_delay_threshold
), &type_integer
, validate_positive
},
1099 { C(sample_format
), &type_sample_format
, validate_sample_format
},
1100 { C(scratch
), &type_string_accum
, validate_isreg
},
1101 { C(sendmail
), &type_string
, validate_isabspath
},
1102 { C(short_display
), &type_integer
, validate_positive
},
1103 { C(signal
), &type_signal
, validate_any
},
1104 { C(smtp_server
), &type_string
, validate_any
},
1105 { C(sox_generation
), &type_integer
, validate_non_negative
},
1106 { C2(speaker_backend
, api
), &type_string
, validate_backend
},
1107 { C(speaker_command
), &type_string
, validate_any
},
1108 { C(stopword
), &type_string_accum
, validate_any
},
1109 { C(templates
), &type_string_accum
, validate_isdir
},
1110 { C(tracklength
), &type_stringlist_accum
, validate_tracklength
},
1111 { C(transform
), &type_transform
, validate_any
},
1112 { C(trust
), &type_string_accum
, validate_any
},
1113 { C(url
), &type_string
, validate_url
},
1114 { C(user
), &type_string
, validate_isauser
},
1115 { C(username
), &type_string
, validate_any
},
1118 /** @brief Find a configuration item's definition by key */
1119 static const struct conf
*find(const char *key
) {
1122 if((n
= TABLE_FIND(conf
, name
, key
)) < 0)
1127 /** @brief Set a new configuration value
1128 * @param cs Configuration state
1129 * @param nvec Length of @p vec
1130 * @param vec Name and new value
1131 * @return 0 on success, non-0 on error.
1133 * @c vec[0] is the name, the rest is the value.
1135 static int config_set(const struct config_state
*cs
,
1136 int nvec
, char **vec
) {
1137 const struct conf
*which
;
1139 D(("config_set %s", vec
[0]));
1140 if(!(which
= find(vec
[0]))) {
1141 error(0, "%s:%d: unknown configuration key '%s'",
1142 cs
->path
, cs
->line
, vec
[0]);
1145 return (which
->validate(cs
, nvec
- 1, vec
+ 1)
1146 || which
->type
->set(cs
, which
, nvec
- 1, vec
+ 1));
1149 /** @brief Set a configuration item from parameters
1150 * @param cs Configuration state
1151 * @param which Item to set
1152 * @param ... Value as strings, terminated by (char *)NULL
1153 * @return 0 on success, non-0 on error
1155 static int config_set_args(const struct config_state
*cs
,
1156 const char *which
, ...) {
1162 vector_append(v
, (char *)which
);
1163 va_start(ap
, which
);
1164 while((s
= va_arg(ap
, char *)))
1165 vector_append(v
, s
);
1167 vector_terminate(v
);
1168 return config_set(cs
, v
->nvec
, v
->vec
);
1171 /** @brief Error callback used by config_include()
1172 * @param msg Error message
1173 * @param u User data (@ref config_state)
1175 static void config_error(const char *msg
, void *u
) {
1176 const struct config_state
*cs
= u
;
1178 error(0, "%s:%d: %s", cs
->path
, cs
->line
, msg
);
1181 /** @brief Include a file by name
1182 * @param c Configuration to update
1183 * @param path Path to read
1184 * @return 0 on success, non-0 on error
1186 static int config_include(struct config
*c
, const char *path
) {
1188 char *buffer
, *inputbuffer
, **vec
;
1190 struct config_state cs
;
1195 D(("%s: reading configuration", path
));
1196 if(!(fp
= fopen(path
, "r"))) {
1197 error(errno
, "error opening %s", path
);
1200 while(!inputline(path
, fp
, &inputbuffer
, '\n')) {
1202 if(!(buffer
= mb2utf8(inputbuffer
))) {
1203 error(errno
, "%s:%d: cannot convert to UTF-8", cs
.path
, cs
.line
);
1209 if(!(vec
= split(buffer
, &n
, SPLIT_COMMENTS
|SPLIT_QUOTES
,
1210 config_error
, &cs
))) {
1216 /* 'include' is special-cased */
1217 if(!strcmp(vec
[0], "include")) {
1219 error(0, "%s:%d: must be 'include PATH'", cs
.path
, cs
.line
);
1222 config_include(c
, vec
[1]);
1224 ret
|= config_set(&cs
, n
, vec
);
1226 for(n
= 0; vec
[n
]; ++n
) xfree(vec
[n
]);
1231 error(errno
, "error reading %s", path
);
1238 /** @brief Default stopword setting */
1239 static const char *const default_stopwords
[] = {
1298 #define NDEFAULT_STOPWORDS (sizeof default_stopwords / sizeof *default_stopwords)
1300 /** @brief Default player patterns */
1301 static const char *const default_players
[] = {
1307 #define NDEFAULT_PLAYERS (sizeof default_players / sizeof *default_players)
1309 /** @brief Make a new default configuration
1310 * @return New configuration
1312 static struct config
*config_default(void) {
1313 struct config
*c
= xmalloc(sizeof *c
);
1314 const char *logname
;
1316 struct config_state cs
;
1319 cs
.path
= "<internal>";
1322 /* Strings had better be xstrdup'd as they will get freed at some point. */
1325 c
->home
= xstrdup(pkgstatedir
);
1326 if(!(pw
= getpwuid(getuid())))
1327 fatal(0, "cannot determine our username");
1328 logname
= pw
->pw_name
;
1329 c
->username
= xstrdup(logname
);
1332 c
->signal
= SIGKILL
;
1333 c
->alias
= xstrdup("{/artist}{/album}{/title}{ext}");
1335 c
->device
= xstrdup("default");
1336 c
->nice_rescan
= 10;
1337 c
->speaker_command
= 0;
1338 c
->sample_format
.bits
= 16;
1339 c
->sample_format
.rate
= 44100;
1340 c
->sample_format
.channels
= 2;
1341 c
->sample_format
.endian
= ENDIAN_NATIVE
;
1343 c
->replay_min
= 8 * 3600;
1345 c
->multicast_ttl
= 1;
1346 c
->multicast_loop
= 1;
1347 c
->authorization_algorithm
= xstrdup("sha1");
1348 c
->noticed_history
= 31;
1349 c
->short_display
= 32;
1353 c
->cookie_login_lifetime
= 86400;
1354 c
->cookie_key_lifetime
= 86400 * 7;
1355 if(sendmail_binary
[0] && strcmp(sendmail_binary
, "none"))
1356 c
->sendmail
= xstrdup(sendmail_binary
);
1357 c
->smtp_server
= xstrdup("127.0.0.1");
1359 c
->reminder_interval
= 600; /* 10m */
1360 c
->new_bias_age
= 7 * 86400; /* 1 week */
1361 c
->new_bias
= 4500000; /* 50 times the base weight */
1362 c
->sox_generation
= DEFAULT_SOX_GENERATION
;
1363 c
->playlist_max
= INT_MAX
; /* effectively no limit */
1364 c
->playlist_lock_timeout
= 10; /* 10s */
1365 /* Default stopwords */
1366 if(config_set(&cs
, (int)NDEFAULT_STOPWORDS
, (char **)default_stopwords
))
1368 /* Default player configuration */
1369 for(n
= 0; n
< NDEFAULT_PLAYERS
; ++n
) {
1370 if(config_set_args(&cs
, "player",
1371 default_players
[n
], "execraw", "disorder-decode", (char *)0))
1373 if(config_set_args(&cs
, "tracklength",
1374 default_players
[n
], "disorder-tracklength", (char *)0))
1377 c
->broadcast
.af
= -1;
1378 c
->broadcast_from
.af
= -1;
1384 /** @brief Construct a filename
1385 * @param c Configuration
1386 * @param name Base filename
1387 * @return Full filename
1389 * Usually use config_get_file() instead.
1391 char *config_get_file2(struct config
*c
, const char *name
) {
1394 byte_xasprintf(&s
, "%s/%s", c
->home
, name
);
1398 /** @brief Set the default configuration file */
1399 static void set_configfile(void) {
1401 byte_xasprintf(&configfile
, "%s/config", pkgconfdir
);
1404 /** @brief Free a configuration object
1405 * @param c Configuration to free
1407 * @p c is indeterminate after this function is called.
1409 static void config_free(struct config
*c
) {
1413 for(n
= 0; n
< (int)(sizeof conf
/ sizeof *conf
); ++n
)
1414 conf
[n
].type
->free(c
, &conf
[n
]);
1415 for(n
= 0; n
< c
->nparts
; ++n
)
1422 /** @brief Set post-parse defaults
1423 * @param c Configuration to update
1424 * @param server True when running in the server
1426 * If @p server is set then certain parts of the configuration are more
1427 * strictly validated.
1429 static void config_postdefaults(struct config
*c
,
1431 struct config_state cs
;
1432 const struct conf
*whoami
;
1435 static const char *namepart
[][4] = {
1436 { "title", "/([0-9]+ *[-:]? *)?([^/]+)\\.[a-zA-Z0-9]+$", "$2", "display" },
1437 { "title", "/([^/]+)\\.[a-zA-Z0-9]+$", "$1", "sort" },
1438 { "album", "/([^/]+)/[^/]+$", "$1", "*" },
1439 { "artist", "/([^/]+)/[^/]+/[^/]+$", "$1", "*" },
1440 { "ext", "(\\.[a-zA-Z0-9]+)$", "$1", "*" },
1442 #define NNAMEPART (int)(sizeof namepart / sizeof *namepart)
1444 static const char *transform
[][5] = {
1445 { "track", "^.*/([0-9]+ *[-:]? *)?([^/]+)\\.[a-zA-Z0-9]+$", "$2", "display", "" },
1446 { "track", "^.*/([^/]+)\\.[a-zA-Z0-9]+$", "$1", "sort", "" },
1447 { "dir", "^.*/([^/]+)$", "$1", "*", "" },
1448 { "dir", "^(the) ([^/]*)", "$2, $1", "sort", "i", },
1449 { "dir", "[[:punct:]]", "", "sort", "g", }
1451 #define NTRANSFORM (int)(sizeof transform / sizeof *transform)
1453 cs
.path
= "<internal>";
1456 if(!c
->namepart
.n
) {
1457 whoami
= find("namepart");
1458 for(n
= 0; n
< NNAMEPART
; ++n
)
1459 set_namepart(&cs
, whoami
, 4, (char **)namepart
[n
]);
1461 if(!c
->transform
.n
) {
1462 whoami
= find("transform");
1463 for(n
= 0; n
< NTRANSFORM
; ++n
)
1464 set_transform(&cs
, whoami
, 5, (char **)transform
[n
]);
1467 if(c
->speaker_command
)
1468 c
->api
= xstrdup("command");
1469 else if(c
->broadcast
.af
!= -1)
1470 c
->api
= xstrdup("rtp");
1471 else if(config_uaudio_apis
)
1472 c
->api
= xstrdup(config_uaudio_apis
[0]->name
);
1474 c
->api
= xstrdup("<none>");
1476 if(!strcmp(c
->api
, "network"))
1477 c
->api
= xstrdup("rtp");
1479 if(!strcmp(c
->api
, "command") && !c
->speaker_command
)
1480 fatal(0, "'api command' but speaker_command is not set");
1481 if((!strcmp(c
->api
, "rtp")) && c
->broadcast
.af
== -1)
1482 fatal(0, "'api rtp' but broadcast is not set");
1484 /* Override sample format */
1485 if(!strcmp(c
->api
, "rtp")) {
1486 c
->sample_format
.rate
= 44100;
1487 c
->sample_format
.channels
= 2;
1488 c
->sample_format
.bits
= 16;
1489 c
->sample_format
.endian
= ENDIAN_NATIVE
;
1491 if(!strcmp(c
->api
, "coreaudio")) {
1492 c
->sample_format
.rate
= 44100;
1493 c
->sample_format
.channels
= 2;
1494 c
->sample_format
.bits
= 16;
1495 c
->sample_format
.endian
= ENDIAN_NATIVE
;
1497 if(!c
->default_rights
) {
1498 rights_type r
= RIGHTS__MASK
& ~(RIGHT_ADMIN
|RIGHT_REGISTER
1500 |RIGHT_SCRATCH__MASK
1501 |RIGHT_REMOVE__MASK
);
1502 /* The idea is to approximate the meaning of the old 'restrict' directive
1503 * in the default rights if they are not overridden. */
1504 if(c
->restrictions
& RESTRICT_SCRATCH
)
1505 r
|= RIGHT_SCRATCH_MINE
|RIGHT_SCRATCH_RANDOM
;
1507 r
|= RIGHT_SCRATCH_ANY
;
1508 if(!(c
->restrictions
& RESTRICT_MOVE
))
1509 r
|= RIGHT_MOVE_ANY
;
1510 if(c
->restrictions
& RESTRICT_REMOVE
)
1511 r
|= RIGHT_REMOVE_MINE
;
1513 r
|= RIGHT_REMOVE_ANY
;
1514 c
->default_rights
= rights_string(r
);
1518 /** @brief (Re-)read the config file
1519 * @param server If set, do extra checking
1520 * @param oldconfig Old configuration for compatibility check
1521 * @return 0 on success, non-0 on error
1523 * If @p oldconfig is set, then certain compatibility checks are done between
1524 * the old and new configurations.
1526 int config_read(int server
,
1527 const struct config
*oldconfig
) {
1533 c
= config_default();
1534 /* standalone Disobedience installs might not have a global config file */
1535 if(access(configfile
, F_OK
) == 0)
1536 if(config_include(c
, configfile
))
1538 /* if we can read the private config file, do */
1539 if((privconf
= config_private())
1540 && access(privconf
, R_OK
) == 0
1541 && config_include(c
, privconf
))
1544 /* if there's a per-user system config file for this user, read it */
1545 if(config_per_user
) {
1546 if(!(pw
= getpwuid(getuid())))
1547 fatal(0, "cannot determine our username");
1548 if((privconf
= config_usersysconf(pw
))
1549 && access(privconf
, F_OK
) == 0
1550 && config_include(c
, privconf
))
1553 /* if we have a password file, read it */
1554 if((privconf
= config_userconf(0, pw
))
1555 && access(privconf
, F_OK
) == 0
1556 && config_include(c
, privconf
))
1560 /* install default namepart and transform settings */
1561 config_postdefaults(c
, server
);
1564 if(strcmp(c
->home
, oldconfig
->home
)) {
1565 error(0, "'home' cannot be changed without a restart");
1568 if(strcmp(c
->alias
, oldconfig
->alias
)) {
1569 error(0, "'alias' cannot be changed without a restart");
1572 if(strcmp(c
->user
, oldconfig
->user
)) {
1573 error(0, "'user' cannot be changed without a restart");
1576 if(c
->nice_speaker
!= oldconfig
->nice_speaker
) {
1577 error(0, "'nice_speaker' cannot be changed without a restart");
1578 /* ...but we accept the new config anyway */
1580 if(c
->nice_server
!= oldconfig
->nice_server
) {
1581 error(0, "'nice_server' cannot be changed without a restart");
1582 /* ...but we accept the new config anyway */
1584 if(namepartlist_compare(&c
->namepart
, &oldconfig
->namepart
)) {
1585 error(0, "'namepart' settings cannot be changed without a restart");
1588 if(stringlist_compare(&c
->stopword
, &oldconfig
->stopword
)) {
1589 error(0, "'stopword' settings cannot be changed without a restart");
1593 error(0, "not installing incompatible new configuration");
1597 /* everything is good so we shall use the new config */
1598 config_free(config
);
1599 /* warn about obsolete directives */
1601 error(0, "'restrict' will be removed in a future version");
1603 error(0, "'allow' will be removed in a future version");
1605 error(0, "'trust' will be removed in a future version");
1607 error(0, "'lock' will be removed in a future version");
1609 error(0, "'gap' will be removed in a future version");
1611 error(0, "'prefsync' will be removed in a future version");
1616 /** @brief Return the path to the private configuration file */
1617 char *config_private(void) {
1621 byte_xasprintf(&s
, "%s.private", configfile
);
1625 /** @brief Return the path to user's personal configuration file */
1626 char *config_userconf(const char *home
, const struct passwd
*pw
) {
1629 if(!home
&& !pw
&& !(pw
= getpwuid(getuid())))
1630 fatal(0, "cannot determine our username");
1631 byte_xasprintf(&s
, "%s/.disorder/passwd", home ? home
: pw
->pw_dir
);
1635 /** @brief Return the path to user-specific system configuration */
1636 char *config_usersysconf(const struct passwd
*pw
) {
1640 if(!strchr(pw
->pw_name
, '/')) {
1641 byte_xasprintf(&s
, "%s.%s", configfile
, pw
->pw_name
);
1647 /** @brief Get a filename within the home directory
1648 * @param name Relative name
1651 char *config_get_file(const char *name
) {
1652 return config_get_file2(config
, name
);
1655 /** @brief Order two stringlists
1656 * @param a First stringlist
1657 * @param b Second stringlist
1658 * @return <0, 0 or >0 if a<b, a=b or a>b
1660 static int stringlist_compare(const struct stringlist
*a
,
1661 const struct stringlist
*b
) {
1664 while(n
< a
->n
&& n
< b
->n
) {
1665 if((c
= strcmp(a
->s
[n
], b
->s
[n
])))
1671 else if(a
->n
> b
->n
)
1677 /** @brief Order two namepart definitions
1678 * @param a First namepart definition
1679 * @param b Second namepart definition
1680 * @return <0, 0 or >0 if a<b, a=b or a>b
1682 static int namepart_compare(const struct namepart
*a
,
1683 const struct namepart
*b
) {
1686 if((c
= strcmp(a
->part
, b
->part
)))
1688 if((c
= strcmp(a
->res
, b
->res
)))
1690 if((c
= strcmp(a
->replace
, b
->replace
)))
1692 if((c
= strcmp(a
->context
, b
->context
)))
1694 if(a
->reflags
> b
->reflags
)
1696 if(a
->reflags
< b
->reflags
)
1701 /** @brief Order two lists of namepart definitions
1702 * @param a First list of namepart definitions
1703 * @param b Second list of namepart definitions
1704 * @return <0, 0 or >0 if a<b, a=b or a>b
1706 static int namepartlist_compare(const struct namepartlist
*a
,
1707 const struct namepartlist
*b
) {
1710 while(n
< a
->n
&& n
< b
->n
) {
1711 if((c
= namepart_compare(&a
->s
[n
], &b
->s
[n
])))
1717 else if(a
->n
< b
->n
)