2 * This file is part of DisOrder.
3 * Copyright (C) 2004-2011, 2013 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 <langinfo.h>
45 #include "configuration.h"
51 #include "inputline.h"
63 /** @brief Path to config file
65 * set_configfile() sets the default if it is null.
69 /** @brief Read user configuration
71 * If clear, the user-specific configuration is not read.
73 int config_per_user
= 1;
75 /** @brief Table of audio APIs
77 * Only set in server processes.
79 const struct uaudio
*const *config_uaudio_apis
;
81 /** @brief Config file parser state */
83 /** @brief Filename */
86 /** @brief Line number */
89 /** @brief Configuration object under construction */
90 struct config
*config
;
93 /** @brief Current configuration */
94 struct config
*config
;
96 /** @brief One configuration item */
98 /** @brief Name as it appears in the config file */
101 /** @brief Offset in @ref config structure */
104 /** @brief Pointer to item type */
105 const struct conftype
*type
;
107 /** @brief Pointer to item-specific validation routine
108 * @param cs Configuration state
109 * @param nvec Length of (proposed) new value
110 * @param vec Elements of new value
111 * @return 0 on success, non-0 on error
113 * The validate function should report any error it detects.
115 int (*validate
)(const struct config_state
*cs
,
116 int nvec
, char **vec
);
119 /** @brief Type of a configuration item */
121 /** @brief Pointer to function to set item
122 * @param cs Configuration state
123 * @param whoami Configuration item to set
124 * @param nvec Length of new value
125 * @param vec New value
126 * @return 0 on success, non-0 on error
128 int (*set
)(const struct config_state
*cs
,
129 const struct conf
*whoami
,
130 int nvec
, char **vec
);
132 /** @brief Pointer to function to free item
133 * @param c Configuration structure to free an item of
134 * @param whoami Configuration item to free
136 void (*free
)(struct config
*c
, const struct conf
*whoami
);
139 /** @brief Compute the address of an item */
140 #define ADDRESS(C, TYPE) ((TYPE *)((char *)(C) + whoami->offset))
141 /** @brief Return the value of an item */
142 #define VALUE(C, TYPE) (*ADDRESS(C, TYPE))
144 static int stringlist_compare(const struct stringlist
*a
,
145 const struct stringlist
*b
);
146 static int namepartlist_compare(const struct namepartlist
*a
,
147 const struct namepartlist
*b
);
149 static int set_signal(const struct config_state
*cs
,
150 const struct conf
*whoami
,
151 int nvec
, char **vec
) {
155 disorder_error(0, "%s:%d: '%s' requires one argument",
156 cs
->path
, cs
->line
, whoami
->name
);
159 if((n
= find_signal(vec
[0])) == -1) {
160 disorder_error(0, "%s:%d: unknown signal '%s'",
161 cs
->path
, cs
->line
, vec
[0]);
164 VALUE(cs
->config
, int) = n
;
168 static int set_collections(const struct config_state
*cs
,
169 const struct conf
*whoami
,
170 int nvec
, char **vec
) {
171 struct collectionlist
*cl
;
172 const char *root
, *encoding
, *module
;
191 disorder_error(0, "%s:%d: '%s' requires at least one argument",
192 cs
->path
, cs
->line
, whoami
->name
);
195 disorder_error(0, "%s:%d: '%s' requires at most three arguments",
196 cs
->path
, cs
->line
, whoami
->name
);
199 /* Sanity check root */
201 disorder_error(0, "%s:%d: collection root must start with '/'",
205 if(root
[1] && root
[strlen(root
)-1] == '/') {
206 disorder_error(0, "%s:%d: collection root must not end with '/'",
215 encoding
= nl_langinfo(CODESET
);
220 cl
= ADDRESS(cs
->config
, struct collectionlist
);
222 cl
->s
= xrealloc(cl
->s
, cl
->n
* sizeof (struct collection
));
223 cl
->s
[cl
->n
- 1].module
= xstrdup(module
);
224 cl
->s
[cl
->n
- 1].encoding
= xstrdup(encoding
);
225 cl
->s
[cl
->n
- 1].root
= xstrdup(root
);
229 static int set_boolean(const struct config_state
*cs
,
230 const struct conf
*whoami
,
231 int nvec
, char **vec
) {
235 disorder_error(0, "%s:%d: '%s' takes only one argument",
236 cs
->path
, cs
->line
, whoami
->name
);
239 if(!strcmp(vec
[0], "yes")) state
= 1;
240 else if(!strcmp(vec
[0], "no")) state
= 0;
242 disorder_error(0, "%s:%d: argument to '%s' must be 'yes' or 'no'",
243 cs
->path
, cs
->line
, whoami
->name
);
246 VALUE(cs
->config
, int) = state
;
250 static int set_string(const struct config_state
*cs
,
251 const struct conf
*whoami
,
252 int nvec
, char **vec
) {
254 disorder_error(0, "%s:%d: '%s' takes only one argument",
255 cs
->path
, cs
->line
, whoami
->name
);
258 xfree(VALUE(cs
->config
, char *));
259 VALUE(cs
->config
, char *) = xstrdup(vec
[0]);
263 static int set_stringlist(const struct config_state
*cs
,
264 const struct conf
*whoami
,
265 int nvec
, char **vec
) {
267 struct stringlist
*sl
;
269 sl
= ADDRESS(cs
->config
, struct stringlist
);
271 for(n
= 0; n
< nvec
; ++n
) {
273 sl
->s
= xrealloc(sl
->s
, (sl
->n
* sizeof (char *)));
274 sl
->s
[sl
->n
- 1] = xstrdup(vec
[n
]);
279 static int set_integer(const struct config_state
*cs
,
280 const struct conf
*whoami
,
281 int nvec
, char **vec
) {
285 disorder_error(0, "%s:%d: '%s' takes only one argument",
286 cs
->path
, cs
->line
, whoami
->name
);
289 if(xstrtol(ADDRESS(cs
->config
, long), vec
[0], &e
, 0)) {
290 disorder_error(errno
, "%s:%d: converting integer", cs
->path
, cs
->line
);
294 disorder_error(0, "%s:%d: invalid integer syntax", cs
->path
, cs
->line
);
300 static int set_stringlist_accum(const struct config_state
*cs
,
301 const struct conf
*whoami
,
302 int nvec
, char **vec
) {
304 struct stringlist
*s
;
305 struct stringlistlist
*sll
;
307 sll
= ADDRESS(cs
->config
, struct stringlistlist
);
313 sll
->s
= xrealloc(sll
->s
, (sll
->n
* sizeof (struct stringlist
)));
314 s
= &sll
->s
[sll
->n
- 1];
316 s
->s
= xmalloc((nvec
+ 1) * sizeof (char *));
317 for(n
= 0; n
< nvec
; ++n
)
318 s
->s
[n
] = xstrdup(vec
[n
]);
322 static int set_string_accum(const struct config_state
*cs
,
323 const struct conf
*whoami
,
324 int nvec
, char **vec
) {
326 struct stringlist
*sl
;
328 sl
= ADDRESS(cs
->config
, struct stringlist
);
333 for(n
= 0; n
< nvec
; ++n
) {
335 sl
->s
= xrealloc(sl
->s
, (sl
->n
* sizeof (char *)));
336 sl
->s
[sl
->n
- 1] = xstrdup(vec
[n
]);
341 static int parse_sample_format(const struct config_state
*cs
,
342 struct stream_header
*format
,
343 int nvec
, char **vec
) {
348 disorder_error(0, "%s:%d: wrong number of arguments", cs
->path
, cs
->line
);
351 if(xstrtol(&t
, p
, &p
, 0)) {
352 disorder_error(errno
, "%s:%d: converting bits-per-sample",
356 if(t
!= 8 && t
!= 16) {
357 disorder_error(0, "%s:%d: bad bits-per-sample (%ld)",
358 cs
->path
, cs
->line
, t
);
361 if(format
) format
->bits
= t
;
363 case 'l': case 'L': t
= ENDIAN_LITTLE
; p
++; break;
364 case 'b': case 'B': t
= ENDIAN_BIG
; p
++; break;
365 default: t
= ENDIAN_NATIVE
; break;
367 if(format
) format
->endian
= t
;
369 disorder_error(errno
, "%s:%d: expected `/' after bits-per-sample",
374 if(xstrtol(&t
, p
, &p
, 0)) {
375 disorder_error(errno
, "%s:%d: converting sample-rate", cs
->path
, cs
->line
);
378 if(t
< 1 || t
> INT_MAX
) {
379 disorder_error(0, "%s:%d: silly sample-rate (%ld)", cs
->path
, cs
->line
, t
);
382 if(format
) format
->rate
= t
;
384 disorder_error(0, "%s:%d: expected `/' after sample-rate",
389 if(xstrtol(&t
, p
, &p
, 0)) {
390 disorder_error(errno
, "%s:%d: converting channels", cs
->path
, cs
->line
);
394 disorder_error(0, "%s:%d: silly number (%ld) of channels",
395 cs
->path
, cs
->line
, t
);
398 if(format
) format
->channels
= t
;
400 disorder_error(0, "%s:%d: junk after channels", cs
->path
, cs
->line
);
406 static int set_sample_format(const struct config_state
*cs
,
407 const struct conf
*whoami
,
408 int nvec
, char **vec
) {
409 return parse_sample_format(cs
, ADDRESS(cs
->config
, struct stream_header
),
414 static int set_namepart(const struct config_state
*cs
,
415 const struct conf
*whoami
,
416 int nvec
, char **vec
) {
417 struct namepartlist
*npl
= ADDRESS(cs
->config
, struct namepartlist
);
424 disorder_error(0, "%s:%d: namepart needs at least 3 arguments",
429 disorder_error(0, "%s:%d: namepart needs at most 5 arguments",
433 reflags
= nvec
>= 5 ?
regsub_flags(vec
[4]) : 0;
434 if(!(re
= pcre_compile(vec
[1],
436 |regsub_compile_options(reflags
),
437 &errstr
, &erroffset
, 0))) {
438 disorder_error(0, "%s:%d: compiling regexp /%s/: %s (offset %d)",
439 cs
->path
, cs
->line
, vec
[1], errstr
, erroffset
);
442 npl
->s
= xrealloc(npl
->s
, (npl
->n
+ 1) * sizeof (struct namepart
));
443 npl
->s
[npl
->n
].part
= xstrdup(vec
[0]);
444 npl
->s
[npl
->n
].re
= re
;
445 npl
->s
[npl
->n
].res
= xstrdup(vec
[1]);
446 npl
->s
[npl
->n
].replace
= xstrdup(vec
[2]);
447 npl
->s
[npl
->n
].context
= xstrdup(vec
[3]);
448 npl
->s
[npl
->n
].reflags
= reflags
;
450 /* XXX a bit of a bodge; relies on there being very few parts. */
451 for(n
= 0; (n
< cs
->config
->nparts
452 && strcmp(cs
->config
->parts
[n
], vec
[0])); ++n
)
454 if(n
>= cs
->config
->nparts
) {
455 cs
->config
->parts
= xrealloc(cs
->config
->parts
,
456 (cs
->config
->nparts
+ 1) * sizeof (char *));
457 cs
->config
->parts
[cs
->config
->nparts
++] = xstrdup(vec
[0]);
462 static int set_transform(const struct config_state
*cs
,
463 const struct conf
*whoami
,
464 int nvec
, char **vec
) {
465 struct transformlist
*tl
= ADDRESS(cs
->config
, struct transformlist
);
472 disorder_error(0, "%s:%d: transform needs at least 3 arguments",
477 disorder_error(0, "%s:%d: transform needs at most 5 arguments",
481 reflags
= (nvec
>= 5 ?
regsub_flags(vec
[4]) : 0);
482 if(!(re
= pcre_compile(vec
[1],
484 |regsub_compile_options(reflags
),
485 &errstr
, &erroffset
, 0))) {
486 disorder_error(0, "%s:%d: compiling regexp /%s/: %s (offset %d)",
487 cs
->path
, cs
->line
, vec
[1], errstr
, erroffset
);
490 tl
->t
= xrealloc(tl
->t
, (tl
->n
+ 1) * sizeof (struct namepart
));
491 tl
->t
[tl
->n
].type
= xstrdup(vec
[0]);
492 tl
->t
[tl
->n
].context
= xstrdup(vec
[3] ? vec
[3] : "*");
493 tl
->t
[tl
->n
].re
= re
;
494 tl
->t
[tl
->n
].replace
= xstrdup(vec
[2]);
495 tl
->t
[tl
->n
].flags
= reflags
;
501 static int set_rights(const struct config_state
*cs
,
502 const struct conf
*whoami
,
503 int nvec
, char **vec
) {
505 disorder_error(0, "%s:%d: '%s' requires one argument",
506 cs
->path
, cs
->line
, whoami
->name
);
509 if(parse_rights(vec
[0], 0, 1)) {
510 disorder_error(0, "%s:%d: invalid rights string '%s'",
511 cs
->path
, cs
->line
, vec
[0]);
514 return set_string(cs
, whoami
, nvec
, vec
);
517 static int set_netaddress(const struct config_state
*cs
,
518 const struct conf
*whoami
,
519 int nvec
, char **vec
) {
520 struct netaddress
*na
= ADDRESS(cs
->config
, struct netaddress
);
522 if(netaddress_parse(na
, nvec
, vec
)) {
523 disorder_error(0, "%s:%d: invalid network address", cs
->path
, cs
->line
);
531 static void free_none(struct config
attribute((unused
)) *c
,
532 const struct conf
attribute((unused
)) *whoami
) {
535 static void free_string(struct config
*c
,
536 const struct conf
*whoami
) {
537 xfree(VALUE(c
, char *));
538 VALUE(c
, char *) = 0;
541 static void free_stringlist(struct config
*c
,
542 const struct conf
*whoami
) {
544 struct stringlist
*sl
= ADDRESS(c
, struct stringlist
);
546 for(n
= 0; n
< sl
->n
; ++n
)
551 static void free_stringlistlist(struct config
*c
,
552 const struct conf
*whoami
) {
554 struct stringlistlist
*sll
= ADDRESS(c
, struct stringlistlist
);
555 struct stringlist
*sl
;
557 for(n
= 0; n
< sll
->n
; ++n
) {
559 for(m
= 0; m
< sl
->n
; ++m
)
566 static void free_collectionlist(struct config
*c
,
567 const struct conf
*whoami
) {
568 struct collectionlist
*cll
= ADDRESS(c
, struct collectionlist
);
569 struct collection
*cl
;
572 for(n
= 0; n
< cll
->n
; ++n
) {
582 static void free_namepartlist(struct config
*c
,
583 const struct conf
*whoami
) {
584 struct namepartlist
*npl
= ADDRESS(c
, struct namepartlist
);
588 for(n
= 0; n
< npl
->n
; ++n
) {
591 pcre_free(np
->re
); /* ...whatever pcre_free is set to. */
599 static void free_transformlist(struct config
*c
,
600 const struct conf
*whoami
) {
601 struct transformlist
*tl
= ADDRESS(c
, struct transformlist
);
605 for(n
= 0; n
< tl
->n
; ++n
) {
608 pcre_free(t
->re
); /* ...whatever pcre_free is set to. */
616 static void free_netaddress(struct config
*c
,
617 const struct conf
*whoami
) {
618 struct netaddress
*na
= ADDRESS(c
, struct netaddress
);
623 /* configuration types */
625 static const struct conftype
626 type_signal
= { set_signal
, free_none
},
627 type_collections
= { set_collections
, free_collectionlist
},
628 type_boolean
= { set_boolean
, free_none
},
629 type_string
= { set_string
, free_string
},
630 type_stringlist
= { set_stringlist
, free_stringlist
},
631 type_integer
= { set_integer
, free_none
},
632 type_stringlist_accum
= { set_stringlist_accum
, free_stringlistlist
},
633 type_string_accum
= { set_string_accum
, free_stringlist
},
634 type_sample_format
= { set_sample_format
, free_none
},
635 type_namepart
= { set_namepart
, free_namepartlist
},
636 type_transform
= { set_transform
, free_transformlist
},
637 type_netaddress
= { set_netaddress
, free_netaddress
},
638 type_rights
= { set_rights
, free_string
};
640 /* specific validation routine */
642 /** @brief Perform a test on a filename
643 * @param test Test function to call on mode bits
644 * @param what Type of file sought
646 * If @p test returns 0 then the file is not a @p what and an error
647 * is reported and -1 is returned.
649 #define VALIDATE_FILE(test, what) do { \
653 for(n = 0; n < nvec; ++n) { \
654 if(stat(vec[n], &sb) < 0) { \
655 disorder_error(errno, "%s:%d: %s", \
656 cs->path, cs->line, vec[n]); \
659 if(!test(sb.st_mode)) { \
660 disorder_error(0, "%s:%d: %s is not a %s", \
661 cs->path, cs->line, vec[n], what); \
667 /** @brief Validate an absolute path
668 * @param cs Configuration state
669 * @param nvec Length of (proposed) new value
670 * @param vec Elements of new value
671 * @return 0 on success, non-0 on error
673 static int validate_isabspath(const struct config_state
*cs
,
674 int nvec
, char **vec
) {
677 for(n
= 0; n
< nvec
; ++n
)
678 if(vec
[n
][0] != '/') {
679 disorder_error(errno
, "%s:%d: %s: not an absolute path",
680 cs
->path
, cs
->line
, vec
[n
]);
686 /** @brief Validate an existing directory
687 * @param cs Configuration state
688 * @param nvec Length of (proposed) new value
689 * @param vec Elements of new value
690 * @return 0 on success, non-0 on error
692 static int validate_isdir(const struct config_state
*cs
,
693 int nvec
, char **vec
) {
694 VALIDATE_FILE(S_ISDIR
, "directory");
698 /** @brief Validate an existing regular file
699 * @param cs Configuration state
700 * @param nvec Length of (proposed) new value
701 * @param vec Elements of new value
702 * @return 0 on success, non-0 on error
704 static int validate_isreg(const struct config_state
*cs
,
705 int nvec
, char **vec
) {
706 VALIDATE_FILE(S_ISREG
, "regular file");
710 /** @brief Validate a player pattern
711 * @param cs Configuration state
712 * @param nvec Length of (proposed) new value
713 * @param vec Elements of new value
714 * @return 0 on success, non-0 on error
716 static int validate_player(const struct config_state
*cs
,
718 char attribute((unused
)) **vec
) {
719 if(nvec
&& nvec
< 2) {
720 disorder_error(0, "%s:%d: should be at least 'player PATTERN MODULE'",
727 /** @brief Validate a track length pattern
728 * @param cs Configuration state
729 * @param nvec Length of (proposed) new value
730 * @param vec Elements of new value
731 * @return 0 on success, non-0 on error
733 static int validate_tracklength(const struct config_state
*cs
,
735 char attribute((unused
)) **vec
) {
736 if(nvec
&& nvec
< 2) {
737 disorder_error(0, "%s:%d: should be at least 'tracklength PATTERN MODULE'",
744 /** @brief Validate a non-negative (@c long) integer
745 * @param cs Configuration state
746 * @param nvec Length of (proposed) new value
747 * @param vec Elements of new value
748 * @return 0 on success, non-0 on error
750 static int validate_non_negative(const struct config_state
*cs
,
751 int nvec
, char **vec
) {
755 disorder_error(0, "%s:%d: missing argument", cs
->path
, cs
->line
);
759 disorder_error(0, "%s:%d: too many arguments", cs
->path
, cs
->line
);
762 if(xstrtol(&n
, vec
[0], 0, 0)) {
763 disorder_error(0, "%s:%d: %s", cs
->path
, cs
->line
, strerror(errno
));
767 disorder_error(0, "%s:%d: must not be negative", cs
->path
, cs
->line
);
773 /** @brief Validate a positive (@c long) integer
774 * @param cs Configuration state
775 * @param nvec Length of (proposed) new value
776 * @param vec Elements of new value
777 * @return 0 on success, non-0 on error
779 static int validate_positive(const struct config_state
*cs
,
780 int nvec
, char **vec
) {
784 disorder_error(0, "%s:%d: missing argument", cs
->path
, cs
->line
);
788 disorder_error(0, "%s:%d: too many arguments", cs
->path
, cs
->line
);
791 if(xstrtol(&n
, vec
[0], 0, 0)) {
792 disorder_error(0, "%s:%d: %s", cs
->path
, cs
->line
, strerror(errno
));
796 disorder_error(0, "%s:%d: must be positive", cs
->path
, cs
->line
);
802 /** @brief Validate a system username
803 * @param cs Configuration state
804 * @param nvec Length of (proposed) new value
805 * @param vec Elements of new value
806 * @return 0 on success, non-0 on error
808 static int validate_isauser(const struct config_state
*cs
,
809 int attribute((unused
)) nvec
,
811 if(!getpwnam(vec
[0])) {
812 disorder_error(0, "%s:%d: no such user as '%s'", cs
->path
, cs
->line
, vec
[0]);
818 /** @brief Validate a sample format string
819 * @param cs Configuration state
820 * @param nvec Length of (proposed) new value
821 * @param vec Elements of new value
822 * @return 0 on success, non-0 on error
824 static int validate_sample_format(const struct config_state
*cs
,
825 int attribute((unused
)) nvec
,
827 return parse_sample_format(cs
, 0, nvec
, vec
);
830 /** @brief Validate anything
831 * @param cs Configuration state
832 * @param nvec Length of (proposed) new value
833 * @param vec Elements of new value
836 static int validate_any(const struct config_state
attribute((unused
)) *cs
,
837 int attribute((unused
)) nvec
,
838 char attribute((unused
)) **vec
) {
842 /** @brief Validate a URL
843 * @param cs Configuration state
844 * @param nvec Length of (proposed) new value
845 * @param vec Elements of new value
846 * @return 0 on success, non-0 on error
850 static int validate_url(const struct config_state
attribute((unused
)) *cs
,
851 int attribute((unused
)) nvec
,
855 /* absoluteURI = scheme ":" ( hier_part | opaque_part )
856 scheme = alpha *( alpha | digit | "+" | "-" | "." ) */
858 n
= strspn(s
, ("abcdefghijklmnopqrstuvwxyz"
859 "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
862 disorder_error(0, "%s:%d: invalid url '%s'", cs
->path
, cs
->line
, vec
[0]);
865 if(!strncmp(s
, "http:", 5)
866 || !strncmp(s
, "https:", 6)) {
868 /* we only do a rather cursory check */
869 if(strncmp(s
, "//", 2)) {
870 disorder_error(0, "%s:%d: invalid url '%s'", cs
->path
, cs
->line
, vec
[0]);
877 /** @brief Validate an alias pattern
878 * @param cs Configuration state
879 * @param nvec Length of (proposed) new value
880 * @param vec Elements of new value
881 * @return 0 on success, non-0 on error
883 static int validate_alias(const struct config_state
*cs
,
887 int in_brackets
= 0, c
;
890 disorder_error(0, "%s:%d: missing argument", cs
->path
, cs
->line
);
894 disorder_error(0, "%s:%d: too many arguments", cs
->path
, cs
->line
);
898 while((c
= (unsigned char)*s
++)) {
902 else if(!isalnum(c
)) {
903 disorder_error(0, "%s:%d: invalid part name in alias expansion in '%s'",
904 cs
->path
, cs
->line
, vec
[0]);
912 } else if(c
== '\\') {
913 if(!(c
= (unsigned char)*s
++)) {
914 disorder_error(0, "%s:%d: unterminated escape in alias expansion in '%s'",
915 cs
->path
, cs
->line
, vec
[0]);
917 } else if(c
!= '\\' && c
!= '{') {
918 disorder_error(0, "%s:%d: invalid escape in alias expansion in '%s'",
919 cs
->path
, cs
->line
, vec
[0]);
928 "%s:%d: unterminated part name in alias expansion in '%s'",
929 cs
->path
, cs
->line
, vec
[0]);
935 /** @brief Validate a hash algorithm name
936 * @param cs Configuration state
937 * @param nvec Length of (proposed) new value
938 * @param vec Elements of new value
939 * @return 0 on success, non-0 on error
941 static int validate_algo(const struct config_state
attribute((unused
)) *cs
,
945 disorder_error(0, "%s:%d: invalid algorithm specification", cs
->path
, cs
->line
);
948 if(!valid_authhash(vec
[0])) {
949 disorder_error(0, "%s:%d: unsuported algorithm '%s'", cs
->path
, cs
->line
, vec
[0]);
955 /** @brief Validate a playback backend 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_backend(const struct config_state
attribute((unused
)) *cs
,
966 disorder_error(0, "%s:%d: invalid sound API specification", cs
->path
, cs
->line
);
969 if(!strcmp(vec
[0], "network")) {
970 disorder_error(0, "'api network' is deprecated; use 'api rtp'");
973 if(config_uaudio_apis
) {
974 for(n
= 0; config_uaudio_apis
[n
]; ++n
)
975 if(!strcmp(vec
[0], config_uaudio_apis
[n
]->name
))
977 disorder_error(0, "%s:%d: unrecognized sound API '%s'", cs
->path
, cs
->line
, vec
[0]);
980 /* In non-server processes we have no idea what's valid */
984 /** @brief Validate a pause mode string
985 * @param cs Configuration state
986 * @param nvec Length of (proposed) new value
987 * @param vec Elements of new value
988 * @return 0 on success, non-0 on error
990 static int validate_pausemode(const struct config_state
attribute((unused
)) *cs
,
993 if(nvec
== 1 && (!strcmp(vec
[0], "silence") || !strcmp(vec
[0], "suspend")))
995 disorder_error(0, "%s:%d: invalid pause mode", cs
->path
, cs
->line
);
999 /** @brief Validate a destination network address
1000 * @param cs Configuration state
1001 * @param nvec Length of (proposed) new value
1002 * @param vec Elements of new value
1003 * @return 0 on success, non-0 on error
1005 * By a destination address, it is meant that it must not be a wildcard
1008 static int validate_destaddr(const struct config_state
attribute((unused
)) *cs
,
1011 struct netaddress na
[1];
1013 if(netaddress_parse(na
, nvec
, vec
)) {
1014 disorder_error(0, "%s:%d: invalid network address", cs
->path
, cs
->line
);
1018 disorder_error(0, "%s:%d: destination address required", cs
->path
, cs
->line
);
1025 /** @brief Item name and and offset */
1026 #define C(x) #x, offsetof(struct config, x)
1027 /** @brief Item name and and offset */
1028 #define C2(x,y) #x, offsetof(struct config, y)
1030 /** @brief All configuration items */
1031 static const struct conf conf
[] = {
1032 { C(alias
), &type_string
, validate_alias
},
1033 { C(api
), &type_string
, validate_backend
},
1034 { C(authorization_algorithm
), &type_string
, validate_algo
},
1035 { C(broadcast
), &type_netaddress
, validate_destaddr
},
1036 { C(broadcast_from
), &type_netaddress
, validate_any
},
1037 { C(channel
), &type_string
, validate_any
},
1038 { C(checkpoint_kbyte
), &type_integer
, validate_non_negative
},
1039 { C(checkpoint_min
), &type_integer
, validate_non_negative
},
1040 { C(collection
), &type_collections
, validate_any
},
1041 { C(connect
), &type_netaddress
, validate_destaddr
},
1042 { C(cookie_key_lifetime
), &type_integer
, validate_positive
},
1043 { C(cookie_login_lifetime
), &type_integer
, validate_positive
},
1044 { C(dbversion
), &type_integer
, validate_positive
},
1045 { C(default_rights
), &type_rights
, validate_any
},
1046 { C(device
), &type_string
, validate_any
},
1047 { C(history
), &type_integer
, validate_positive
},
1048 { C(home
), &type_string
, validate_isabspath
},
1049 { C(listen
), &type_netaddress
, validate_any
},
1050 { C(mail_sender
), &type_string
, validate_any
},
1051 { C(mixer
), &type_string
, validate_any
},
1052 { C(mount_rescan
), &type_boolean
, validate_any
},
1053 { C(multicast_loop
), &type_boolean
, validate_any
},
1054 { C(multicast_ttl
), &type_integer
, validate_non_negative
},
1056 { C(namepart
), &type_namepart
, validate_any
},
1058 { C(new_bias
), &type_integer
, validate_positive
},
1059 { C(new_bias_age
), &type_integer
, validate_positive
},
1060 { C(new_max
), &type_integer
, validate_positive
},
1061 { C2(nice
, nice_rescan
), &type_integer
, validate_non_negative
},
1062 { C(nice_rescan
), &type_integer
, validate_non_negative
},
1063 { C(nice_server
), &type_integer
, validate_any
},
1064 { C(nice_speaker
), &type_integer
, validate_any
},
1065 { C(noticed_history
), &type_integer
, validate_positive
},
1066 { C(password
), &type_string
, validate_any
},
1067 { C(pause_mode
), &type_string
, validate_pausemode
},
1068 { C(player
), &type_stringlist_accum
, validate_player
},
1069 { C(playlist_lock_timeout
), &type_integer
, validate_positive
},
1070 { C(playlist_max
) , &type_integer
, validate_positive
},
1071 { C(plugins
), &type_string_accum
, validate_isdir
},
1072 { C(queue_pad
), &type_integer
, validate_positive
},
1073 { C(refresh
), &type_integer
, validate_positive
},
1074 { C(refresh_min
), &type_integer
, validate_non_negative
},
1075 { C(reminder_interval
), &type_integer
, validate_positive
},
1076 { C(remote_userman
), &type_boolean
, validate_any
},
1077 { C(replay_min
), &type_integer
, validate_non_negative
},
1078 { C(rtp_delay_threshold
), &type_integer
, validate_positive
},
1079 { C(rtp_mode
), &type_string
, validate_any
},
1080 { C(rtp_verbose
), &type_boolean
, validate_any
},
1081 { C(sample_format
), &type_sample_format
, validate_sample_format
},
1082 { C(scratch
), &type_string_accum
, validate_isreg
},
1083 { C(sendmail
), &type_string
, validate_isabspath
},
1084 { C(short_display
), &type_integer
, validate_positive
},
1085 { C(signal
), &type_signal
, validate_any
},
1086 { C(smtp_server
), &type_string
, validate_any
},
1087 { C(sox_generation
), &type_integer
, validate_non_negative
},
1088 { C2(speaker_backend
, api
), &type_string
, validate_backend
},
1089 { C(speaker_command
), &type_string
, validate_any
},
1090 { C(stopword
), &type_string_accum
, validate_any
},
1091 { C(templates
), &type_string_accum
, validate_isdir
},
1092 { C(tracklength
), &type_stringlist_accum
, validate_tracklength
},
1094 { C(transform
), &type_transform
, validate_any
},
1096 { C(url
), &type_string
, validate_url
},
1097 { C(user
), &type_string
, validate_isauser
},
1098 { C(username
), &type_string
, validate_any
},
1101 /** @brief Find a configuration item's definition by key */
1102 static const struct conf
*find(const char *key
) {
1105 if((n
= TABLE_FIND(conf
, name
, key
)) < 0)
1110 /** @brief Set a new configuration value
1111 * @param cs Configuration state
1112 * @param nvec Length of @p vec
1113 * @param vec Name and new value
1114 * @return 0 on success, non-0 on error.
1116 * @c vec[0] is the name, the rest is the value.
1118 static int config_set(const struct config_state
*cs
,
1119 int nvec
, char **vec
) {
1120 const struct conf
*which
;
1122 D(("config_set %s", vec
[0]));
1123 if(!(which
= find(vec
[0]))) {
1124 disorder_error(0, "%s:%d: unknown configuration key '%s'",
1125 cs
->path
, cs
->line
, vec
[0]);
1128 return (which
->validate(cs
, nvec
- 1, vec
+ 1)
1129 || which
->type
->set(cs
, which
, nvec
- 1, vec
+ 1));
1132 /** @brief Set a configuration item from parameters
1133 * @param cs Configuration state
1134 * @param which Item to set
1135 * @param ... Value as strings, terminated by (char *)NULL
1136 * @return 0 on success, non-0 on error
1138 static int config_set_args(const struct config_state
*cs
,
1139 const char *which
, ...) {
1146 vector_append(v
, (char *)which
);
1147 va_start(ap
, which
);
1148 while((s
= va_arg(ap
, char *)))
1149 vector_append(v
, s
);
1151 vector_terminate(v
);
1152 rc
= config_set(cs
, v
->nvec
, v
->vec
);
1157 /** @brief Error callback used by config_include()
1158 * @param msg Error message
1159 * @param u User data (@ref config_state)
1161 static void config_error(const char *msg
, void *u
) {
1162 const struct config_state
*cs
= u
;
1164 disorder_error(0, "%s:%d: %s", cs
->path
, cs
->line
, msg
);
1167 /** @brief Include a file by name
1168 * @param c Configuration to update
1169 * @param path Path to read
1170 * @return 0 on success, non-0 on error
1172 static int config_include(struct config
*c
, const char *path
) {
1174 char *buffer
, *inputbuffer
, **vec
;
1176 struct config_state cs
;
1181 D(("%s: reading configuration", path
));
1182 if(!(fp
= fopen(path
, "r"))) {
1183 disorder_error(errno
, "error opening %s", path
);
1186 while(!inputline(path
, fp
, &inputbuffer
, '\n')) {
1188 if(!(buffer
= mb2utf8(inputbuffer
))) {
1189 disorder_error(errno
, "%s:%d: cannot convert to UTF-8", cs
.path
, cs
.line
);
1195 if(!(vec
= split(buffer
, &n
, SPLIT_COMMENTS
|SPLIT_QUOTES
,
1196 config_error
, &cs
))) {
1202 /* 'include' is special-cased */
1203 if(!strcmp(vec
[0], "include")) {
1205 disorder_error(0, "%s:%d: must be 'include PATH'", cs
.path
, cs
.line
);
1208 config_include(c
, vec
[1]);
1210 ret
|= config_set(&cs
, n
, vec
);
1212 for(n
= 0; vec
[n
]; ++n
) xfree(vec
[n
]);
1217 disorder_error(errno
, "error reading %s", path
);
1224 /** @brief Default stopword setting */
1225 static const char *const default_stopwords
[] = {
1284 #define NDEFAULT_STOPWORDS (sizeof default_stopwords / sizeof *default_stopwords)
1286 /** @brief Default player patterns */
1287 static const char *const default_players
[] = {
1293 #define NDEFAULT_PLAYERS (sizeof default_players / sizeof *default_players)
1295 /** @brief Make a new default configuration
1296 * @return New configuration
1298 static struct config
*config_default(void) {
1299 struct config
*c
= xmalloc(sizeof *c
);
1300 const char *logname
;
1302 struct config_state cs
;
1305 cs
.path
= "<internal>";
1308 /* Strings had better be xstrdup'd as they will get freed at some point. */
1310 c
->home
= xstrdup(pkgstatedir
);
1311 if(!(pw
= getpwuid(getuid())))
1312 disorder_fatal(0, "cannot determine our username");
1313 logname
= pw
->pw_name
;
1314 c
->username
= xstrdup(logname
);
1317 c
->signal
= SIGKILL
;
1318 c
->alias
= xstrdup("{/artist}{/album}{/title}{ext}");
1319 c
->device
= xstrdup("default");
1320 c
->nice_rescan
= 10;
1321 c
->speaker_command
= 0;
1322 c
->sample_format
.bits
= 16;
1323 c
->sample_format
.rate
= 44100;
1324 c
->sample_format
.channels
= 2;
1325 c
->sample_format
.endian
= ENDIAN_NATIVE
;
1327 c
->replay_min
= 8 * 3600;
1329 c
->multicast_ttl
= 1;
1330 c
->multicast_loop
= 1;
1331 c
->authorization_algorithm
= xstrdup("sha1");
1332 c
->noticed_history
= 31;
1333 c
->short_display
= 32;
1337 c
->cookie_login_lifetime
= 86400;
1338 c
->cookie_key_lifetime
= 86400 * 7;
1339 if(sendmail_binary
[0] && strcmp(sendmail_binary
, "none"))
1340 c
->sendmail
= xstrdup(sendmail_binary
);
1341 c
->smtp_server
= xstrdup("127.0.0.1");
1343 c
->reminder_interval
= 600; /* 10m */
1344 c
->new_bias_age
= 7 * 86400; /* 1 week */
1345 c
->new_bias
= 4500000; /* 50 times the base weight */
1346 c
->sox_generation
= DEFAULT_SOX_GENERATION
;
1347 c
->playlist_max
= INT_MAX
; /* effectively no limit */
1348 c
->playlist_lock_timeout
= 10; /* 10s */
1349 c
->mount_rescan
= 1;
1350 /* Default stopwords */
1351 if(config_set(&cs
, (int)NDEFAULT_STOPWORDS
, (char **)default_stopwords
))
1353 /* Default player configuration */
1354 for(n
= 0; n
< NDEFAULT_PLAYERS
; ++n
) {
1355 if(config_set_args(&cs
, "player",
1356 default_players
[n
], "execraw", "disorder-decode", (char *)0))
1358 if(config_set_args(&cs
, "tracklength",
1359 default_players
[n
], "disorder-tracklength", (char *)0))
1362 c
->broadcast
.af
= -1;
1363 c
->broadcast_from
.af
= -1;
1366 c
->rtp_mode
= xstrdup("auto");
1370 /** @brief Construct a filename
1371 * @param c Configuration
1372 * @param name Base filename
1373 * @return Full filename
1375 * Usually use config_get_file() instead.
1377 char *config_get_file2(struct config
*c
, const char *name
) {
1380 byte_xasprintf(&s
, "%s/%s", c
->home
, name
);
1384 /** @brief Set the default configuration file */
1385 static void set_configfile(void) {
1387 byte_xasprintf(&configfile
, "%s/config", pkgconfdir
);
1390 /** @brief Free a configuration object
1391 * @param c Configuration to free
1393 * @p c is indeterminate after this function is called.
1395 void config_free(struct config
*c
) {
1399 for(n
= 0; n
< (int)(sizeof conf
/ sizeof *conf
); ++n
)
1400 conf
[n
].type
->free(c
, &conf
[n
]);
1401 for(n
= 0; n
< c
->nparts
; ++n
)
1408 /** @brief Set post-parse defaults
1409 * @param c Configuration to update
1410 * @param server True when running in the server
1412 * If @p server is set then certain parts of the configuration are more
1413 * strictly validated.
1415 static void config_postdefaults(struct config
*c
,
1417 struct config_state cs
;
1419 const struct conf
*whoami
;
1424 static const char *namepart
[][4] = {
1425 { "title", "/([0-9]+ *[-:]? *)?([^/]+)\\.[a-zA-Z0-9]+$", "$2", "display" },
1426 { "title", "/([^/]+)\\.[a-zA-Z0-9]+$", "$1", "sort" },
1427 { "album", "/([^/]+)/[^/]+$", "$1", "*" },
1428 { "artist", "/([^/]+)/[^/]+/[^/]+$", "$1", "*" },
1429 { "ext", "(\\.[a-zA-Z0-9]+)$", "$1", "*" },
1431 #define NNAMEPART (int)(sizeof namepart / sizeof *namepart)
1433 static const char *transform
[][5] = {
1434 { "track", "^.*/([0-9]+ *[-:]? *)?([^/]+)\\.[a-zA-Z0-9]+$", "$2", "display", "" },
1435 { "track", "^.*/([^/]+)\\.[a-zA-Z0-9]+$", "$1", "sort", "" },
1436 { "dir", "^.*/([^/]+)$", "$1", "*", "" },
1437 { "dir", "^(the) ([^/]*)", "$2, $1", "sort", "i", },
1438 { "dir", "[[:punct:]]", "", "sort", "g", }
1440 #define NTRANSFORM (int)(sizeof transform / sizeof *transform)
1443 cs
.path
= "<internal>";
1447 if(!c
->namepart
.n
) {
1448 whoami
= find("namepart");
1449 for(n
= 0; n
< NNAMEPART
; ++n
)
1450 set_namepart(&cs
, whoami
, 4, (char **)namepart
[n
]);
1452 if(!c
->transform
.n
) {
1453 whoami
= find("transform");
1454 for(n
= 0; n
< NTRANSFORM
; ++n
)
1455 set_transform(&cs
, whoami
, 5, (char **)transform
[n
]);
1459 if(c
->speaker_command
)
1460 c
->api
= xstrdup("command");
1461 else if(c
->broadcast
.af
!= -1)
1462 c
->api
= xstrdup("rtp");
1463 else if(config_uaudio_apis
)
1464 c
->api
= xstrdup(uaudio_default(config_uaudio_apis
,
1465 UAUDIO_API_SERVER
)->name
);
1467 c
->api
= xstrdup("<none>");
1469 if(!strcmp(c
->api
, "network"))
1470 c
->api
= xstrdup("rtp");
1472 if(!strcmp(c
->api
, "command") && !c
->speaker_command
)
1473 disorder_fatal(0, "'api command' but speaker_command is not set");
1474 if((!strcmp(c
->api
, "rtp")) && c
->broadcast
.af
== -1)
1475 disorder_fatal(0, "'api rtp' but broadcast is not set");
1477 /* Override sample format */
1478 if(!strcmp(c
->api
, "rtp")) {
1479 c
->sample_format
.rate
= 44100;
1480 c
->sample_format
.channels
= 2;
1481 c
->sample_format
.bits
= 16;
1482 c
->sample_format
.endian
= ENDIAN_NATIVE
;
1484 if(!strcmp(c
->api
, "coreaudio")) {
1485 c
->sample_format
.rate
= 44100;
1486 c
->sample_format
.channels
= 2;
1487 c
->sample_format
.bits
= 16;
1488 c
->sample_format
.endian
= ENDIAN_NATIVE
;
1490 if(!c
->default_rights
) {
1491 rights_type r
= RIGHTS__MASK
& ~(RIGHT_ADMIN
|RIGHT_REGISTER
1493 |RIGHT_SCRATCH__MASK
1494 |RIGHT_REMOVE__MASK
);
1495 r
|= RIGHT_SCRATCH_ANY
|RIGHT_MOVE_ANY
|RIGHT_REMOVE_ANY
;
1496 c
->default_rights
= rights_string(r
);
1500 /** @brief (Re-)read the config file
1501 * @param server If set, do extra checking
1502 * @param oldconfig Old configuration for compatibility check
1503 * @return 0 on success, non-0 on error
1505 * If @p oldconfig is set, then certain compatibility checks are done between
1506 * the old and new configurations.
1508 int config_read(int server
,
1509 const struct config
*oldconfig
) {
1515 c
= config_default();
1516 /* standalone Disobedience installs might not have a global config file */
1517 if(access(configfile
, F_OK
) == 0)
1518 if(config_include(c
, configfile
))
1520 /* if we can read the private config file, do */
1521 if((privconf
= config_private())
1522 && access(privconf
, R_OK
) == 0
1523 && config_include(c
, privconf
))
1526 /* if there's a per-user system config file for this user, read it */
1527 if(config_per_user
) {
1528 if(!(pw
= getpwuid(getuid())))
1529 disorder_fatal(0, "cannot determine our username");
1530 if((privconf
= config_usersysconf(pw
))
1531 && access(privconf
, F_OK
) == 0
1532 && config_include(c
, privconf
))
1535 /* if we have a password file, read it */
1536 if((privconf
= config_userconf(0, pw
))
1537 && access(privconf
, F_OK
) == 0
1538 && config_include(c
, privconf
))
1542 /* install default namepart and transform settings */
1543 config_postdefaults(c
, server
);
1546 if(strcmp(c
->home
, oldconfig
->home
)) {
1547 disorder_error(0, "'home' cannot be changed without a restart");
1550 if(strcmp(c
->alias
, oldconfig
->alias
)) {
1551 disorder_error(0, "'alias' cannot be changed without a restart");
1554 if(strcmp(c
->user
, oldconfig
->user
)) {
1555 disorder_error(0, "'user' cannot be changed without a restart");
1558 if(c
->nice_speaker
!= oldconfig
->nice_speaker
) {
1559 disorder_error(0, "'nice_speaker' cannot be changed without a restart");
1560 /* ...but we accept the new config anyway */
1562 if(c
->nice_server
!= oldconfig
->nice_server
) {
1563 disorder_error(0, "'nice_server' cannot be changed without a restart");
1564 /* ...but we accept the new config anyway */
1567 if(namepartlist_compare(&c
->namepart
, &oldconfig
->namepart
)) {
1568 disorder_error(0, "'namepart' settings cannot be changed without a restart");
1572 if(stringlist_compare(&c
->stopword
, &oldconfig
->stopword
)) {
1573 disorder_error(0, "'stopword' settings cannot be changed without a restart");
1577 disorder_error(0, "not installing incompatible new configuration");
1581 /* everything is good so we shall use the new config */
1582 config_free(config
);
1583 /* warn about obsolete directives */
1588 /** @brief Return the path to the private configuration file */
1589 char *config_private(void) {
1593 byte_xasprintf(&s
, "%s.private", configfile
);
1597 /** @brief Return the path to user's personal configuration file */
1598 char *config_userconf(const char *home
, const struct passwd
*pw
) {
1601 if(!home
&& !pw
&& !(pw
= getpwuid(getuid())))
1602 disorder_fatal(0, "cannot determine our username");
1603 byte_xasprintf(&s
, "%s/.disorder/passwd", home ? home
: pw
->pw_dir
);
1607 /** @brief Return the path to user-specific system configuration */
1608 char *config_usersysconf(const struct passwd
*pw
) {
1612 if(!strchr(pw
->pw_name
, '/')) {
1613 byte_xasprintf(&s
, "%s.%s", configfile
, pw
->pw_name
);
1619 /** @brief Get a filename within the home directory
1620 * @param name Relative name
1623 char *config_get_file(const char *name
) {
1624 return config_get_file2(config
, name
);
1627 /** @brief Order two stringlists
1628 * @param a First stringlist
1629 * @param b Second stringlist
1630 * @return <0, 0 or >0 if a<b, a=b or a>b
1632 static int stringlist_compare(const struct stringlist
*a
,
1633 const struct stringlist
*b
) {
1636 while(n
< a
->n
&& n
< b
->n
) {
1637 if((c
= strcmp(a
->s
[n
], b
->s
[n
])))
1643 else if(a
->n
> b
->n
)
1650 /** @brief Order two namepart definitions
1651 * @param a First namepart definition
1652 * @param b Second namepart definition
1653 * @return <0, 0 or >0 if a<b, a=b or a>b
1655 static int namepart_compare(const struct namepart
*a
,
1656 const struct namepart
*b
) {
1659 if((c
= strcmp(a
->part
, b
->part
)))
1661 if((c
= strcmp(a
->res
, b
->res
)))
1663 if((c
= strcmp(a
->replace
, b
->replace
)))
1665 if((c
= strcmp(a
->context
, b
->context
)))
1667 if(a
->reflags
> b
->reflags
)
1669 if(a
->reflags
< b
->reflags
)
1674 /** @brief Order two lists of namepart definitions
1675 * @param a First list of namepart definitions
1676 * @param b Second list of namepart definitions
1677 * @return <0, 0 or >0 if a<b, a=b or a>b
1679 static int namepartlist_compare(const struct namepartlist
*a
,
1680 const struct namepartlist
*b
) {
1683 while(n
< a
->n
&& n
< b
->n
) {
1684 if((c
= namepart_compare(&a
->s
[n
], &b
->s
[n
])))
1690 else if(a
->n
< b
->n
)
1697 /** @brief Verify configuration table.
1698 * @return The number of problems found
1700 int config_verify(void) {
1703 for(n
= 1; n
< sizeof conf
/ sizeof *conf
; ++n
)
1704 if(strcmp(conf
[n
-1].name
, conf
[n
].name
) >= 0) {
1705 fprintf(stderr
, "%s >= %s\n", conf
[n
-1].name
, conf
[n
].name
);