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>
46 #include "configuration.h"
52 #include "inputline.h"
65 /** @brief Path to config file
67 * set_configfile() sets the default if it is null.
71 /** @brief Read user configuration
73 * If clear, the user-specific configuration is not read.
75 int config_per_user
= 1;
78 /** @brief Table of audio APIs
80 * Only set in server processes.
82 const struct uaudio
*const *config_uaudio_apis
;
85 /** @brief Config file parser state */
87 /** @brief Filename */
90 /** @brief Line number */
93 /** @brief Configuration object under construction */
94 struct config
*config
;
97 /** @brief Current configuration */
98 struct config
*config
;
100 /** @brief One configuration item */
102 /** @brief Name as it appears in the config file */
105 /** @brief Offset in @ref config structure */
108 /** @brief Pointer to item type */
109 const struct conftype
*type
;
111 /** @brief Pointer to item-specific validation routine
112 * @param cs Configuration state
113 * @param nvec Length of (proposed) new value
114 * @param vec Elements of new value
115 * @return 0 on success, non-0 on error
117 * The validate function should report any error it detects.
119 int (*validate
)(const struct config_state
*cs
,
120 int nvec
, char **vec
);
123 /** @brief Type of a configuration item */
125 /** @brief Pointer to function to set item
126 * @param cs Configuration state
127 * @param whoami Configuration item to set
128 * @param nvec Length of new value
129 * @param vec New value
130 * @return 0 on success, non-0 on error
132 int (*set
)(const struct config_state
*cs
,
133 const struct conf
*whoami
,
134 int nvec
, char **vec
);
136 /** @brief Pointer to function to free item
137 * @param c Configuration structure to free an item of
138 * @param whoami Configuration item to free
140 void (*free
)(struct config
*c
, const struct conf
*whoami
);
143 /** @brief Compute the address of an item */
144 #define ADDRESS(C, TYPE) ((TYPE *)((char *)(C) + whoami->offset))
145 /** @brief Return the value of an item */
146 #define VALUE(C, TYPE) (*ADDRESS(C, TYPE))
148 static int stringlist_compare(const struct stringlist
*a
,
149 const struct stringlist
*b
);
150 static int namepartlist_compare(const struct namepartlist
*a
,
151 const struct namepartlist
*b
);
153 static int set_signal(const struct config_state
*cs
,
154 const struct conf
*whoami
,
155 int nvec
, char **vec
) {
159 disorder_error(0, "%s:%d: '%s' requires one argument",
160 cs
->path
, cs
->line
, whoami
->name
);
163 if((n
= find_signal(vec
[0])) == -1) {
164 disorder_error(0, "%s:%d: unknown signal '%s'",
165 cs
->path
, cs
->line
, vec
[0]);
168 VALUE(cs
->config
, int) = n
;
172 static int set_collections(const struct config_state
*cs
,
173 const struct conf
*whoami
,
174 int nvec
, char **vec
) {
175 struct collectionlist
*cl
;
176 const char *root
, *encoding
, *module
;
195 disorder_error(0, "%s:%d: '%s' requires at least one argument",
196 cs
->path
, cs
->line
, whoami
->name
);
199 disorder_error(0, "%s:%d: '%s' requires at most three arguments",
200 cs
->path
, cs
->line
, whoami
->name
);
203 /* Sanity check root */
205 disorder_error(0, "%s:%d: collection root must start with '/'",
209 if(root
[1] && root
[strlen(root
)-1] == '/') {
210 disorder_error(0, "%s:%d: collection root must not end with '/'",
219 encoding
= nl_langinfo(CODESET
);
224 cl
= ADDRESS(cs
->config
, struct collectionlist
);
226 cl
->s
= xrealloc(cl
->s
, cl
->n
* sizeof (struct collection
));
227 cl
->s
[cl
->n
- 1].module
= xstrdup(module
);
228 cl
->s
[cl
->n
- 1].encoding
= xstrdup(encoding
);
229 cl
->s
[cl
->n
- 1].root
= xstrdup(root
);
233 static int set_boolean(const struct config_state
*cs
,
234 const struct conf
*whoami
,
235 int nvec
, char **vec
) {
239 disorder_error(0, "%s:%d: '%s' takes only one argument",
240 cs
->path
, cs
->line
, whoami
->name
);
243 if(!strcmp(vec
[0], "yes")) state
= 1;
244 else if(!strcmp(vec
[0], "no")) state
= 0;
246 disorder_error(0, "%s:%d: argument to '%s' must be 'yes' or 'no'",
247 cs
->path
, cs
->line
, whoami
->name
);
250 VALUE(cs
->config
, int) = state
;
254 static int set_string(const struct config_state
*cs
,
255 const struct conf
*whoami
,
256 int nvec
, char **vec
) {
258 disorder_error(0, "%s:%d: '%s' takes only one argument",
259 cs
->path
, cs
->line
, whoami
->name
);
262 xfree(VALUE(cs
->config
, char *));
263 VALUE(cs
->config
, char *) = xstrdup(vec
[0]);
267 static int set_integer(const struct config_state
*cs
,
268 const struct conf
*whoami
,
269 int nvec
, char **vec
) {
273 disorder_error(0, "%s:%d: '%s' takes only one argument",
274 cs
->path
, cs
->line
, whoami
->name
);
277 if(xstrtol(ADDRESS(cs
->config
, long), vec
[0], &e
, 0)) {
278 disorder_error(errno
, "%s:%d: converting integer", cs
->path
, cs
->line
);
282 disorder_error(0, "%s:%d: invalid integer syntax", cs
->path
, cs
->line
);
288 static int set_stringlist_accum(const struct config_state
*cs
,
289 const struct conf
*whoami
,
290 int nvec
, char **vec
) {
292 struct stringlist
*s
;
293 struct stringlistlist
*sll
;
295 sll
= ADDRESS(cs
->config
, struct stringlistlist
);
301 sll
->s
= xrealloc(sll
->s
, (sll
->n
* sizeof (struct stringlist
)));
302 s
= &sll
->s
[sll
->n
- 1];
304 s
->s
= xmalloc((nvec
+ 1) * sizeof (char *));
305 for(n
= 0; n
< nvec
; ++n
)
306 s
->s
[n
] = xstrdup(vec
[n
]);
310 static int set_string_accum(const struct config_state
*cs
,
311 const struct conf
*whoami
,
312 int nvec
, char **vec
) {
314 struct stringlist
*sl
;
316 sl
= ADDRESS(cs
->config
, struct stringlist
);
321 for(n
= 0; n
< nvec
; ++n
) {
323 sl
->s
= xrealloc(sl
->s
, (sl
->n
* sizeof (char *)));
324 sl
->s
[sl
->n
- 1] = xstrdup(vec
[n
]);
329 static int parse_sample_format(const struct config_state
*cs
,
330 struct stream_header
*format
,
331 int nvec
, char **vec
) {
336 disorder_error(0, "%s:%d: wrong number of arguments", cs
->path
, cs
->line
);
339 if(xstrtol(&t
, p
, &p
, 0)) {
340 disorder_error(errno
, "%s:%d: converting bits-per-sample",
344 if(t
!= 8 && t
!= 16) {
345 disorder_error(0, "%s:%d: bad bits-per-sample (%ld)",
346 cs
->path
, cs
->line
, t
);
349 if(format
) format
->bits
= (uint8_t)t
;
351 case 'l': case 'L': t
= ENDIAN_LITTLE
; p
++; break;
352 case 'b': case 'B': t
= ENDIAN_BIG
; p
++; break;
353 default: t
= ENDIAN_NATIVE
; break;
355 if(format
) format
->endian
= (uint8_t)t
;
357 disorder_error(errno
, "%s:%d: expected `/' after bits-per-sample",
362 if(xstrtol(&t
, p
, &p
, 0)) {
363 disorder_error(errno
, "%s:%d: converting sample-rate", cs
->path
, cs
->line
);
366 if(t
< 1 || t
> INT_MAX
) {
367 disorder_error(0, "%s:%d: silly sample-rate (%ld)", cs
->path
, cs
->line
, t
);
370 if(format
) format
->rate
= t
;
372 disorder_error(0, "%s:%d: expected `/' after sample-rate",
377 if(xstrtol(&t
, p
, &p
, 0)) {
378 disorder_error(errno
, "%s:%d: converting channels", cs
->path
, cs
->line
);
382 disorder_error(0, "%s:%d: silly number (%ld) of channels",
383 cs
->path
, cs
->line
, t
);
386 if(format
) format
->channels
= (uint8_t)t
;
388 disorder_error(0, "%s:%d: junk after channels", cs
->path
, cs
->line
);
394 static int set_sample_format(const struct config_state
*cs
,
395 const struct conf
*whoami
,
396 int nvec
, char **vec
) {
397 return parse_sample_format(cs
, ADDRESS(cs
->config
, struct stream_header
),
401 static int set_namepart(const struct config_state
*cs
,
402 const struct conf
*whoami
,
403 int nvec
, char **vec
) {
404 struct namepartlist
*npl
= ADDRESS(cs
->config
, struct namepartlist
);
407 char errstr
[RXCERR_LEN
];
412 disorder_error(0, "%s:%d: namepart needs at least 3 arguments",
417 disorder_error(0, "%s:%d: namepart needs at most 5 arguments",
421 reflags
= nvec
>= 5 ?
regsub_flags(vec
[4]) : 0;
422 if(!(re
= regexp_compile(vec
[1], regsub_compile_options(reflags
),
423 errstr
, sizeof(errstr
), &erroffset
)))
425 disorder_error(0, "%s:%d: compiling regexp /%s/: %s (offset %zu)",
426 cs
->path
, cs
->line
, vec
[1], errstr
, erroffset
);
429 npl
->s
= xrealloc(npl
->s
, (npl
->n
+ 1) * sizeof (struct namepart
));
430 npl
->s
[npl
->n
].part
= xstrdup(vec
[0]);
431 npl
->s
[npl
->n
].re
= re
;
432 npl
->s
[npl
->n
].res
= xstrdup(vec
[1]);
433 npl
->s
[npl
->n
].replace
= xstrdup(vec
[2]);
434 npl
->s
[npl
->n
].context
= xstrdup(vec
[3]);
435 npl
->s
[npl
->n
].reflags
= reflags
;
437 /* XXX a bit of a bodge; relies on there being very few parts. */
438 for(n
= 0; (n
< cs
->config
->nparts
439 && strcmp(cs
->config
->parts
[n
], vec
[0])); ++n
)
441 if(n
>= cs
->config
->nparts
) {
442 cs
->config
->parts
= xrealloc(cs
->config
->parts
,
443 (cs
->config
->nparts
+ 1) * sizeof (char *));
444 cs
->config
->parts
[cs
->config
->nparts
++] = xstrdup(vec
[0]);
449 static int set_transform(const struct config_state
*cs
,
450 const struct conf
*whoami
,
451 int nvec
, char **vec
) {
452 struct transformlist
*tl
= ADDRESS(cs
->config
, struct transformlist
);
454 char errstr
[RXCERR_LEN
];
459 disorder_error(0, "%s:%d: transform needs at least 3 arguments",
464 disorder_error(0, "%s:%d: transform needs at most 5 arguments",
468 reflags
= (nvec
>= 5 ?
regsub_flags(vec
[4]) : 0);
469 if(!(re
= regexp_compile(vec
[1], regsub_compile_options(reflags
),
470 errstr
, sizeof(errstr
), &erroffset
)))
472 disorder_error(0, "%s:%d: compiling regexp /%s/: %s (offset %zu)",
473 cs
->path
, cs
->line
, vec
[1], errstr
, erroffset
);
476 tl
->t
= xrealloc(tl
->t
, (tl
->n
+ 1) * sizeof (struct namepart
));
477 tl
->t
[tl
->n
].type
= xstrdup(vec
[0]);
478 tl
->t
[tl
->n
].context
= xstrdup(vec
[3] ? vec
[3] : "*");
479 tl
->t
[tl
->n
].re
= re
;
480 tl
->t
[tl
->n
].replace
= xstrdup(vec
[2]);
481 tl
->t
[tl
->n
].flags
= reflags
;
486 static int set_rights(const struct config_state
*cs
,
487 const struct conf
*whoami
,
488 int nvec
, char **vec
) {
490 disorder_error(0, "%s:%d: '%s' requires one argument",
491 cs
->path
, cs
->line
, whoami
->name
);
494 if(parse_rights(vec
[0], 0, 1)) {
495 disorder_error(0, "%s:%d: invalid rights string '%s'",
496 cs
->path
, cs
->line
, vec
[0]);
499 return set_string(cs
, whoami
, nvec
, vec
);
502 static int set_netaddress(const struct config_state
*cs
,
503 const struct conf
*whoami
,
504 int nvec
, char **vec
) {
505 struct netaddress
*na
= ADDRESS(cs
->config
, struct netaddress
);
507 if(netaddress_parse(na
, nvec
, vec
)) {
508 disorder_error(0, "%s:%d: invalid network address", cs
->path
, cs
->line
);
516 static void free_none(struct config
attribute((unused
)) *c
,
517 const struct conf
attribute((unused
)) *whoami
) {
520 static void free_string(struct config
*c
,
521 const struct conf
*whoami
) {
522 xfree(VALUE(c
, char *));
523 VALUE(c
, char *) = 0;
526 static void free_stringlist(struct config
*c
,
527 const struct conf
*whoami
) {
529 struct stringlist
*sl
= ADDRESS(c
, struct stringlist
);
531 for(n
= 0; n
< sl
->n
; ++n
)
536 static void free_stringlistlist(struct config
*c
,
537 const struct conf
*whoami
) {
539 struct stringlistlist
*sll
= ADDRESS(c
, struct stringlistlist
);
540 struct stringlist
*sl
;
542 for(n
= 0; n
< sll
->n
; ++n
) {
544 for(m
= 0; m
< sl
->n
; ++m
)
551 static void free_collectionlist(struct config
*c
,
552 const struct conf
*whoami
) {
553 struct collectionlist
*cll
= ADDRESS(c
, struct collectionlist
);
554 struct collection
*cl
;
557 for(n
= 0; n
< cll
->n
; ++n
) {
566 static void free_namepartlist(struct config
*c
,
567 const struct conf
*whoami
) {
568 struct namepartlist
*npl
= ADDRESS(c
, struct namepartlist
);
572 for(n
= 0; n
< npl
->n
; ++n
) {
583 static void free_transformlist(struct config
*c
,
584 const struct conf
*whoami
) {
585 struct transformlist
*tl
= ADDRESS(c
, struct transformlist
);
589 for(n
= 0; n
< tl
->n
; ++n
) {
599 static void free_netaddress(struct config
*c
,
600 const struct conf
*whoami
) {
601 struct netaddress
*na
= ADDRESS(c
, struct netaddress
);
606 /* configuration types */
608 static const struct conftype
609 type_signal
= { set_signal
, free_none
},
610 type_collections
= { set_collections
, free_collectionlist
},
611 type_boolean
= { set_boolean
, free_none
},
612 type_string
= { set_string
, free_string
},
613 type_integer
= { set_integer
, free_none
},
614 type_stringlist_accum
= { set_stringlist_accum
, free_stringlistlist
},
615 type_string_accum
= { set_string_accum
, free_stringlist
},
616 type_sample_format
= { set_sample_format
, free_none
},
617 type_namepart
= { set_namepart
, free_namepartlist
},
618 type_transform
= { set_transform
, free_transformlist
},
619 type_netaddress
= { set_netaddress
, free_netaddress
},
620 type_rights
= { set_rights
, free_string
};
622 /* specific validation routine */
624 /** @brief Perform a test on a filename
625 * @param test Test function to call on mode bits
626 * @param what Type of file sought
628 * If @p test returns 0 then the file is not a @p what and an error
629 * is reported and -1 is returned.
631 #define VALIDATE_FILE(test, what) do { \
635 for(n = 0; n < nvec; ++n) { \
636 if(stat(vec[n], &sb) < 0) { \
637 disorder_error(errno, "%s:%d: %s", \
638 cs->path, cs->line, vec[n]); \
641 if(!test(sb.st_mode)) { \
642 disorder_error(0, "%s:%d: %s is not a %s", \
643 cs->path, cs->line, vec[n], what); \
649 /** @brief Validate an absolute path
650 * @param cs Configuration state
651 * @param nvec Length of (proposed) new value
652 * @param vec Elements of new value
653 * @return 0 on success, non-0 on error
655 static int validate_isabspath(const struct config_state
*cs
,
656 int nvec
, char **vec
) {
659 for(n
= 0; n
< nvec
; ++n
)
660 if(vec
[n
][0] != '/') {
661 disorder_error(0, "%s:%d: %s: not an absolute path",
662 cs
->path
, cs
->line
, vec
[n
]);
668 /** @brief Validate an existing directory
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_isdir(const struct config_state
*cs
,
675 int nvec
, char **vec
) {
676 VALIDATE_FILE(S_ISDIR
, "directory");
680 /** @brief Validate an existing regular file
681 * @param cs Configuration state
682 * @param nvec Length of (proposed) new value
683 * @param vec Elements of new value
684 * @return 0 on success, non-0 on error
686 static int validate_isreg(const struct config_state
*cs
,
687 int nvec
, char **vec
) {
688 VALIDATE_FILE(S_ISREG
, "regular file");
692 /** @brief Validate a player pattern
693 * @param cs Configuration state
694 * @param nvec Length of (proposed) new value
695 * @param vec Elements of new value
696 * @return 0 on success, non-0 on error
698 static int validate_player(const struct config_state
*cs
,
700 char attribute((unused
)) **vec
) {
701 if(nvec
&& nvec
< 2) {
702 disorder_error(0, "%s:%d: should be at least 'player PATTERN MODULE'",
709 /** @brief Validate a track length pattern
710 * @param cs Configuration state
711 * @param nvec Length of (proposed) new value
712 * @param vec Elements of new value
713 * @return 0 on success, non-0 on error
715 static int validate_tracklength(const struct config_state
*cs
,
717 char attribute((unused
)) **vec
) {
718 if(nvec
&& nvec
< 2) {
719 disorder_error(0, "%s:%d: should be at least 'tracklength PATTERN MODULE'",
726 /** @brief Validate a non-negative (@c long) integer
727 * @param cs Configuration state
728 * @param nvec Length of (proposed) new value
729 * @param vec Elements of new value
730 * @return 0 on success, non-0 on error
732 static int validate_non_negative(const struct config_state
*cs
,
733 int nvec
, char **vec
) {
738 disorder_error(0, "%s:%d: missing argument", cs
->path
, cs
->line
);
742 disorder_error(0, "%s:%d: too many arguments", cs
->path
, cs
->line
);
745 if(xstrtol(&n
, vec
[0], 0, 0)) {
746 disorder_error(0, "%s:%d: %s", cs
->path
, cs
->line
,
747 format_error(ec_errno
, errno
, errbuf
, sizeof errbuf
));
751 disorder_error(0, "%s:%d: must not be negative", cs
->path
, cs
->line
);
757 /** @brief Validate a positive (@c long) integer
758 * @param cs Configuration state
759 * @param nvec Length of (proposed) new value
760 * @param vec Elements of new value
761 * @return 0 on success, non-0 on error
763 static int validate_positive(const struct config_state
*cs
,
764 int nvec
, char **vec
) {
769 disorder_error(0, "%s:%d: missing argument", cs
->path
, cs
->line
);
773 disorder_error(0, "%s:%d: too many arguments", cs
->path
, cs
->line
);
776 if(xstrtol(&n
, vec
[0], 0, 0)) {
777 disorder_error(0, "%s:%d: %s", cs
->path
, cs
->line
,
778 format_error(ec_errno
, errno
, errbuf
, sizeof errbuf
));
782 disorder_error(0, "%s:%d: must be positive", cs
->path
, cs
->line
);
789 /** @brief Validate a system username
790 * @param cs Configuration state
791 * @param nvec Length of (proposed) new value
792 * @param vec Elements of new value
793 * @return 0 on success, non-0 on error
795 static int validate_isauser(const struct config_state
*cs
,
796 int attribute((unused
)) nvec
,
798 if(!getpwnam(vec
[0])) {
799 disorder_error(0, "%s:%d: no such user as '%s'", cs
->path
, cs
->line
, vec
[0]);
806 /** @brief Validate a sample format string
807 * @param cs Configuration state
808 * @param nvec Length of (proposed) new value
809 * @param vec Elements of new value
810 * @return 0 on success, non-0 on error
812 static int validate_sample_format(const struct config_state
*cs
,
813 int attribute((unused
)) nvec
,
815 return parse_sample_format(cs
, 0, nvec
, vec
);
818 /** @brief Validate anything
819 * @param cs Configuration state
820 * @param nvec Length of (proposed) new value
821 * @param vec Elements of new value
824 static int validate_any(const struct config_state
attribute((unused
)) *cs
,
825 int attribute((unused
)) nvec
,
826 char attribute((unused
)) **vec
) {
830 /** @brief Validate a URL
831 * @param cs Configuration state
832 * @param nvec Length of (proposed) new value
833 * @param vec Elements of new value
834 * @return 0 on success, non-0 on error
838 static int validate_url(const struct config_state
attribute((unused
)) *cs
,
839 int attribute((unused
)) nvec
,
843 /* absoluteURI = scheme ":" ( hier_part | opaque_part )
844 scheme = alpha *( alpha | digit | "+" | "-" | "." ) */
846 n
= strspn(s
, ("abcdefghijklmnopqrstuvwxyz"
847 "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
850 disorder_error(0, "%s:%d: invalid url '%s'", cs
->path
, cs
->line
, vec
[0]);
853 if(!strncmp(s
, "http:", 5)
854 || !strncmp(s
, "https:", 6)) {
856 /* we only do a rather cursory check */
857 if(strncmp(s
, "//", 2)) {
858 disorder_error(0, "%s:%d: invalid url '%s'", cs
->path
, cs
->line
, vec
[0]);
865 /** @brief Validate an alias pattern
866 * @param cs Configuration state
867 * @param nvec Length of (proposed) new value
868 * @param vec Elements of new value
869 * @return 0 on success, non-0 on error
871 static int validate_alias(const struct config_state
*cs
,
875 int in_brackets
= 0, c
;
878 disorder_error(0, "%s:%d: missing argument", cs
->path
, cs
->line
);
882 disorder_error(0, "%s:%d: too many arguments", cs
->path
, cs
->line
);
886 while((c
= (unsigned char)*s
++)) {
890 else if(!isalnum(c
)) {
891 disorder_error(0, "%s:%d: invalid part name in alias expansion in '%s'",
892 cs
->path
, cs
->line
, vec
[0]);
900 } else if(c
== '\\') {
901 if(!(c
= (unsigned char)*s
++)) {
902 disorder_error(0, "%s:%d: unterminated escape in alias expansion in '%s'",
903 cs
->path
, cs
->line
, vec
[0]);
905 } else if(c
!= '\\' && c
!= '{') {
906 disorder_error(0, "%s:%d: invalid escape in alias expansion in '%s'",
907 cs
->path
, cs
->line
, vec
[0]);
916 "%s:%d: unterminated part name in alias expansion in '%s'",
917 cs
->path
, cs
->line
, vec
[0]);
923 /** @brief Validate a hash algorithm name
924 * @param cs Configuration state
925 * @param nvec Length of (proposed) new value
926 * @param vec Elements of new value
927 * @return 0 on success, non-0 on error
929 static int validate_algo(const struct config_state
attribute((unused
)) *cs
,
933 disorder_error(0, "%s:%d: invalid algorithm specification", cs
->path
, cs
->line
);
936 if(!valid_authhash(vec
[0])) {
937 disorder_error(0, "%s:%d: unsuported algorithm '%s'", cs
->path
, cs
->line
, vec
[0]);
944 /** @brief Validate a playback backend name
945 * @param cs Configuration state
946 * @param nvec Length of (proposed) new value
947 * @param vec Elements of new value
948 * @return 0 on success, non-0 on error
950 static int validate_backend(const struct config_state
attribute((unused
)) *cs
,
955 disorder_error(0, "%s:%d: invalid sound API specification", cs
->path
, cs
->line
);
958 if(!strcmp(vec
[0], "network")) {
959 disorder_error(0, "'api network' is deprecated; use 'api rtp'");
962 if(config_uaudio_apis
) {
963 for(n
= 0; config_uaudio_apis
[n
]; ++n
)
964 if(!strcmp(vec
[0], config_uaudio_apis
[n
]->name
))
966 disorder_error(0, "%s:%d: unrecognized sound API '%s'", cs
->path
, cs
->line
, vec
[0]);
969 /* In non-server processes we have no idea what's valid */
974 /** @brief Validate a pause mode string
975 * @param cs Configuration state
976 * @param nvec Length of (proposed) new value
977 * @param vec Elements of new value
978 * @return 0 on success, non-0 on error
980 static int validate_pausemode(const struct config_state
attribute((unused
)) *cs
,
983 if(nvec
== 1 && (!strcmp(vec
[0], "silence") || !strcmp(vec
[0], "suspend")))
985 disorder_error(0, "%s:%d: invalid pause mode", cs
->path
, cs
->line
);
989 /** @brief Validate a destination network address
990 * @param cs Configuration state
991 * @param nvec Length of (proposed) new value
992 * @param vec Elements of new value
993 * @return 0 on success, non-0 on error
995 * By a destination address, it is meant that it must not be a wildcard
998 static int validate_destaddr(const struct config_state
attribute((unused
)) *cs
,
1001 struct netaddress na
[1];
1003 if(netaddress_parse(na
, nvec
, vec
)) {
1004 disorder_error(0, "%s:%d: invalid network address", cs
->path
, cs
->line
);
1008 disorder_error(0, "%s:%d: destination address required", cs
->path
, cs
->line
);
1015 /** @brief Item name and and offset */
1016 #define C(x) #x, offsetof(struct config, x)
1017 /** @brief Item name and and offset */
1018 #define C2(x,y) #x, offsetof(struct config, y)
1020 /** @brief All configuration items */
1021 static const struct conf conf
[] = {
1022 { C(alias
), &type_string
, validate_alias
},
1024 { C(api
), &type_string
, validate_backend
},
1026 { C(authorization_algorithm
), &type_string
, validate_algo
},
1027 { C(broadcast
), &type_netaddress
, validate_destaddr
},
1028 { C(broadcast_from
), &type_netaddress
, validate_any
},
1029 { C(channel
), &type_string
, validate_any
},
1030 { C(checkpoint_kbyte
), &type_integer
, validate_non_negative
},
1031 { C(checkpoint_min
), &type_integer
, validate_non_negative
},
1032 { C(collection
), &type_collections
, validate_any
},
1033 { C(connect
), &type_netaddress
, validate_destaddr
},
1034 { C(cookie_key_lifetime
), &type_integer
, validate_positive
},
1035 { C(cookie_login_lifetime
), &type_integer
, validate_positive
},
1036 { C(dbversion
), &type_integer
, validate_positive
},
1037 { C(default_rights
), &type_rights
, validate_any
},
1038 { C(device
), &type_string
, validate_any
},
1039 { C(history
), &type_integer
, validate_positive
},
1041 { C(home
), &type_string
, validate_isabspath
},
1043 { C(listen
), &type_netaddress
, validate_any
},
1044 { C(mail_sender
), &type_string
, validate_any
},
1045 { C(mixer
), &type_string
, validate_any
},
1046 { C(mount_rescan
), &type_boolean
, validate_any
},
1047 { C(multicast_loop
), &type_boolean
, validate_any
},
1048 { C(multicast_ttl
), &type_integer
, validate_non_negative
},
1049 { C(namepart
), &type_namepart
, validate_any
},
1050 { C(new_bias
), &type_integer
, validate_positive
},
1051 { C(new_bias_age
), &type_integer
, validate_positive
},
1052 { C(new_max
), &type_integer
, validate_positive
},
1053 { C2(nice
, nice_rescan
), &type_integer
, validate_non_negative
},
1054 { C(nice_rescan
), &type_integer
, validate_non_negative
},
1055 { C(nice_server
), &type_integer
, validate_any
},
1056 { C(nice_speaker
), &type_integer
, validate_any
},
1057 { C(noticed_history
), &type_integer
, validate_positive
},
1058 { C(password
), &type_string
, validate_any
},
1059 { C(pause_mode
), &type_string
, validate_pausemode
},
1060 { C(player
), &type_stringlist_accum
, validate_player
},
1061 { C(playlist_lock_timeout
), &type_integer
, validate_positive
},
1062 { C(playlist_max
) , &type_integer
, validate_positive
},
1063 { C(plugins
), &type_string_accum
, validate_isdir
},
1064 { C(queue_pad
), &type_integer
, validate_positive
},
1065 { C(refresh
), &type_integer
, validate_positive
},
1066 { C(refresh_min
), &type_integer
, validate_non_negative
},
1067 { C(reminder_interval
), &type_integer
, validate_positive
},
1068 { C(remote_userman
), &type_boolean
, validate_any
},
1069 { C(replay_min
), &type_integer
, validate_non_negative
},
1070 { C(rtp_delay_threshold
), &type_integer
, validate_positive
},
1071 { C(rtp_mode
), &type_string
, validate_any
},
1072 { C(rtp_verbose
), &type_boolean
, validate_any
},
1073 { C(sample_format
), &type_sample_format
, validate_sample_format
},
1074 { C(scratch
), &type_string_accum
, validate_isreg
},
1076 { C(sendmail
), &type_string
, validate_isabspath
},
1078 { C(short_display
), &type_integer
, validate_positive
},
1079 { C(signal
), &type_signal
, validate_any
},
1080 { C(smtp_server
), &type_string
, validate_any
},
1081 { C(sox_generation
), &type_integer
, validate_non_negative
},
1083 { C2(speaker_backend
, api
), &type_string
, validate_backend
},
1085 { C(speaker_command
), &type_string
, validate_any
},
1086 { C(stopword
), &type_string_accum
, validate_any
},
1087 { C(templates
), &type_string_accum
, validate_isdir
},
1088 { C(tracklength
), &type_stringlist_accum
, validate_tracklength
},
1089 { C(transform
), &type_transform
, validate_any
},
1090 { C(url
), &type_string
, validate_url
},
1092 { C(user
), &type_string
, validate_isauser
},
1094 { C(username
), &type_string
, validate_any
},
1097 /** @brief Find a configuration item's definition by key */
1098 static const struct conf
*find(const char *key
) {
1101 if((n
= TABLE_FIND(conf
, name
, key
)) < 0)
1106 /** @brief Set a new configuration value
1107 * @param cs Configuration state
1108 * @param nvec Length of @p vec
1109 * @param vec Name and new value
1110 * @return 0 on success, non-0 on error.
1112 * @c vec[0] is the name, the rest is the value.
1114 static int config_set(const struct config_state
*cs
,
1115 int nvec
, char **vec
) {
1116 const struct conf
*which
;
1118 D(("config_set %s", vec
[0]));
1119 if(!(which
= find(vec
[0]))) {
1120 disorder_error(0, "%s:%d: unknown configuration key '%s'",
1121 cs
->path
, cs
->line
, vec
[0]);
1124 return (which
->validate(cs
, nvec
- 1, vec
+ 1)
1125 || which
->type
->set(cs
, which
, nvec
- 1, vec
+ 1));
1128 /** @brief Set a configuration item from parameters
1129 * @param cs Configuration state
1130 * @param which Item to set
1131 * @param ... Value as strings, terminated by (char *)NULL
1132 * @return 0 on success, non-0 on error
1134 static int config_set_args(const struct config_state
*cs
,
1135 const char *which
, ...) {
1142 vector_append(v
, (char *)which
);
1143 va_start(ap
, which
);
1144 while((s
= va_arg(ap
, char *)))
1145 vector_append(v
, s
);
1147 vector_terminate(v
);
1148 rc
= config_set(cs
, v
->nvec
, v
->vec
);
1153 /** @brief Error callback used by config_include()
1154 * @param msg Error message
1155 * @param u User data (@ref config_state)
1157 static void config_error(const char *msg
, void *u
) {
1158 const struct config_state
*cs
= u
;
1160 disorder_error(0, "%s:%d: %s", cs
->path
, cs
->line
, msg
);
1163 /** @brief Include a file by name
1164 * @param c Configuration to update
1165 * @param path Path to read
1166 * @return 0 on success, non-0 on error
1168 static int config_include(struct config
*c
, const char *path
) {
1170 char *buffer
, *inputbuffer
, **vec
;
1172 struct config_state cs
;
1177 D(("%s: reading configuration", path
));
1178 if(!(fp
= fopen(path
, "r"))) {
1179 disorder_error(errno
, "error opening %s", path
);
1182 while(!inputline(path
, fp
, &inputbuffer
, '\n')) {
1184 if(!(buffer
= mb2utf8(inputbuffer
))) {
1185 disorder_error(errno
, "%s:%d: cannot convert to UTF-8", cs
.path
, cs
.line
);
1191 if(!(vec
= split(buffer
, &n
, SPLIT_COMMENTS
|SPLIT_QUOTES
,
1192 config_error
, &cs
))) {
1198 /* 'include' is special-cased */
1199 if(!strcmp(vec
[0], "include")) {
1201 disorder_error(0, "%s:%d: must be 'include PATH'", cs
.path
, cs
.line
);
1204 config_include(c
, vec
[1]);
1206 ret
|= config_set(&cs
, n
, vec
);
1208 for(n
= 0; vec
[n
]; ++n
) xfree(vec
[n
]);
1213 disorder_error(errno
, "error reading %s", path
);
1220 /** @brief Default stopword setting */
1221 static const char *const default_stopwords
[] = {
1280 #define NDEFAULT_STOPWORDS (sizeof default_stopwords / sizeof *default_stopwords)
1282 /** @brief Default player patterns */
1283 static const char *const default_players
[] = {
1289 #define NDEFAULT_PLAYERS (sizeof default_players / sizeof *default_players)
1291 /** @brief Make a new default configuration
1292 * @return New configuration
1294 static struct config
*config_default(void) {
1295 struct config
*c
= xmalloc(sizeof *c
);
1297 const char *logname
;
1300 struct config_state cs
;
1303 cs
.path
= "<internal>";
1306 /* Strings had better be xstrdup'd as they will get freed at some point. */
1309 c
->home
= xstrdup(pkgstatedir
);
1314 DWORD bufsize
= sizeof buffer
;
1315 if(!GetUserNameA(buffer
, &bufsize
))
1316 disorder_fatal(0, "cannot determine our username");
1317 c
->username
= xstrdup(buffer
);
1320 if(!(pw
= getpwuid(getuid())))
1321 disorder_fatal(0, "cannot determine our username");
1322 logname
= pw
->pw_name
;
1323 c
->username
= xstrdup(logname
);
1328 c
->signal
= SIGKILL
;
1330 c
->signal
= SIGTERM
;
1332 c
->alias
= xstrdup("{/artist}{/album}{/title}{ext}");
1333 c
->device
= xstrdup("default");
1334 c
->nice_rescan
= 10;
1335 c
->speaker_command
= 0;
1336 c
->sample_format
.bits
= 16;
1337 c
->sample_format
.rate
= 44100;
1338 c
->sample_format
.channels
= 2;
1339 c
->sample_format
.endian
= ENDIAN_NATIVE
;
1341 c
->replay_min
= 8 * 3600;
1343 c
->multicast_ttl
= 1;
1344 c
->multicast_loop
= 1;
1345 c
->authorization_algorithm
= xstrdup("sha1");
1346 c
->noticed_history
= 31;
1347 c
->short_display
= 32;
1351 c
->cookie_login_lifetime
= 86400;
1352 c
->cookie_key_lifetime
= 86400 * 7;
1354 if(sendmail_binary
[0] && strcmp(sendmail_binary
, "none"))
1355 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 c
->mount_rescan
= 1;
1366 /* Default stopwords */
1367 if(config_set(&cs
, (int)NDEFAULT_STOPWORDS
, (char **)default_stopwords
))
1369 /* Default player configuration */
1370 for(n
= 0; n
< NDEFAULT_PLAYERS
; ++n
) {
1371 if(config_set_args(&cs
, "player",
1372 default_players
[n
], "execraw", "disorder-decode", (char *)0))
1374 if(config_set_args(&cs
, "tracklength",
1375 default_players
[n
], "disorder-tracklength", (char *)0))
1378 c
->broadcast
.af
= -1;
1379 c
->broadcast_from
.af
= -1;
1382 c
->rtp_mode
= xstrdup("auto");
1387 /** @brief Construct a filename
1388 * @param c Configuration
1389 * @param name Base filename
1390 * @return Full filename
1392 * Usually use config_get_file() instead.
1394 char *config_get_file2(struct config
*c
, const char *name
) {
1397 byte_xasprintf(&s
, "%s/%s", c
->home
, name
);
1402 /** @brief Set the default configuration file */
1403 static void set_configfile(void) {
1406 byte_xasprintf(&configfile
, "%s/config", pkgconfdir
);
1410 /** @brief Free a configuration object
1411 * @param c Configuration to free
1413 * @p c is indeterminate after this function is called.
1415 void config_free(struct config
*c
) {
1419 for(n
= 0; n
< (int)(sizeof conf
/ sizeof *conf
); ++n
)
1420 conf
[n
].type
->free(c
, &conf
[n
]);
1421 for(n
= 0; n
< c
->nparts
; ++n
)
1428 /** @brief Set post-parse defaults
1429 * @param c Configuration to update
1430 * @param server True when running in the server
1432 * If @p server is set then certain parts of the configuration are more
1433 * strictly validated.
1435 static void config_postdefaults(struct config
*c
,
1437 struct config_state cs
;
1438 const struct conf
*whoami
;
1441 static const char *namepart
[][4] = {
1442 { "title", "/([0-9]+ *[-:]? *)?([^/]+)\\.[a-zA-Z0-9]+$", "$2", "display" },
1443 { "title", "/([^/]+)\\.[a-zA-Z0-9]+$", "$1", "sort" },
1444 { "album", "/([^/]+)/[^/]+$", "$1", "*" },
1445 { "artist", "/([^/]+)/[^/]+/[^/]+$", "$1", "*" },
1446 { "ext", "(\\.[a-zA-Z0-9]+)$", "$1", "*" },
1448 #define NNAMEPART (int)(sizeof namepart / sizeof *namepart)
1450 static const char *transform
[][5] = {
1451 { "track", "^.*/([0-9]+ *[-:]? *)?([^/]+)\\.[a-zA-Z0-9]+$", "$2", "display", "" },
1452 { "track", "^.*/([^/]+)\\.[a-zA-Z0-9]+$", "$1", "sort", "" },
1453 { "dir", "^.*/([^/]+)$", "$1", "*", "" },
1454 { "dir", "^(the) ([^/]*)", "$2, $1", "sort", "i", },
1455 { "dir", "[[:punct:]]", "", "sort", "g", }
1457 #define NTRANSFORM (int)(sizeof transform / sizeof *transform)
1459 cs
.path
= "<internal>";
1462 if(!c
->namepart
.n
) {
1463 whoami
= find("namepart");
1464 for(n
= 0; n
< NNAMEPART
; ++n
)
1465 set_namepart(&cs
, whoami
, 4, (char **)namepart
[n
]);
1467 if(!c
->transform
.n
) {
1468 whoami
= find("transform");
1469 for(n
= 0; n
< NTRANSFORM
; ++n
)
1470 set_transform(&cs
, whoami
, 5, (char **)transform
[n
]);
1473 if(c
->speaker_command
)
1474 c
->api
= xstrdup("command");
1475 else if(c
->broadcast
.af
!= -1)
1476 c
->api
= xstrdup("rtp");
1478 else if(config_uaudio_apis
)
1479 c
->api
= xstrdup(uaudio_default(config_uaudio_apis
,
1480 UAUDIO_API_SERVER
)->name
);
1483 c
->api
= xstrdup("<none>");
1485 if(!strcmp(c
->api
, "network"))
1486 c
->api
= xstrdup("rtp");
1488 if(!strcmp(c
->api
, "command") && !c
->speaker_command
)
1489 disorder_fatal(0, "'api command' but speaker_command is not set");
1490 if((!strcmp(c
->api
, "rtp")) && c
->broadcast
.af
== -1)
1491 disorder_fatal(0, "'api rtp' but broadcast is not set");
1493 /* Override sample format */
1494 if(!strcmp(c
->api
, "rtp")) {
1495 c
->sample_format
.rate
= 44100;
1496 c
->sample_format
.channels
= 2;
1497 c
->sample_format
.bits
= 16;
1498 c
->sample_format
.endian
= ENDIAN_NATIVE
;
1500 if(!strcmp(c
->api
, "coreaudio")) {
1501 c
->sample_format
.rate
= 44100;
1502 c
->sample_format
.channels
= 2;
1503 c
->sample_format
.bits
= 16;
1504 c
->sample_format
.endian
= ENDIAN_NATIVE
;
1506 if(!c
->default_rights
) {
1507 rights_type r
= RIGHTS__MASK
& ~(RIGHT_ADMIN
|RIGHT_REGISTER
1509 |RIGHT_SCRATCH__MASK
1510 |RIGHT_REMOVE__MASK
);
1511 r
|= RIGHT_SCRATCH_ANY
|RIGHT_MOVE_ANY
|RIGHT_REMOVE_ANY
;
1512 c
->default_rights
= rights_string(r
);
1516 /** @brief (Re-)read the config file
1517 * @param server If set, do extra checking
1518 * @param oldconfig Old configuration for compatibility check
1519 * @return 0 on success, non-0 on error
1521 * If @p oldconfig is set, then certain compatibility checks are done between
1522 * the old and new configurations.
1524 int config_read(int server
,
1525 const struct config
*oldconfig
) {
1528 struct passwd
*pw
= NULL
;
1531 c
= config_default();
1532 /* standalone client installs might not have a global config file */
1534 if(access(configfile
, F_OK
) == 0)
1535 if(config_include(c
, configfile
))
1537 /* if we can read the private config file, do */
1538 if((privconf
= config_private())
1539 && access(privconf
, R_OK
) == 0
1540 && config_include(c
, privconf
))
1543 /* if there's a per-user system config file for this user, read it */
1544 if(config_per_user
) {
1546 if(!(pw
= getpwuid(getuid())))
1547 disorder_fatal(0, "cannot determine our username");
1548 if((privconf
= config_usersysconf(pw
))
1549 && access(privconf
, F_OK
) == 0
1550 && config_include(c
, privconf
))
1554 /* if we have a password file, read it */
1555 if((privconf
= config_userconf(0, pw
))
1556 && access(privconf
, F_OK
) == 0
1557 && config_include(c
, privconf
))
1561 /* install default namepart and transform settings */
1562 config_postdefaults(c
, server
);
1566 if(strcmp(c
->home
, oldconfig
->home
)) {
1567 disorder_error(0, "'home' cannot be changed without a restart");
1571 if(strcmp(c
->alias
, oldconfig
->alias
)) {
1572 disorder_error(0, "'alias' cannot be changed without a restart");
1575 if(strcmp(c
->user
, oldconfig
->user
)) {
1576 disorder_error(0, "'user' cannot be changed without a restart");
1579 if(c
->nice_speaker
!= oldconfig
->nice_speaker
) {
1580 disorder_error(0, "'nice_speaker' cannot be changed without a restart");
1581 /* ...but we accept the new config anyway */
1583 if(c
->nice_server
!= oldconfig
->nice_server
) {
1584 disorder_error(0, "'nice_server' cannot be changed without a restart");
1585 /* ...but we accept the new config anyway */
1587 if(namepartlist_compare(&c
->namepart
, &oldconfig
->namepart
)) {
1588 disorder_error(0, "'namepart' settings cannot be changed without a restart");
1591 if(stringlist_compare(&c
->stopword
, &oldconfig
->stopword
)) {
1592 disorder_error(0, "'stopword' settings cannot be changed without a restart");
1596 disorder_error(0, "not installing incompatible new configuration");
1600 /* everything is good so we shall use the new config */
1601 config_free(config
);
1602 /* warn about obsolete directives */
1607 /** @brief Return the path to the private configuration file */
1608 char *config_private(void) {
1615 byte_xasprintf(&s
, "%s.private", configfile
);
1620 /** @brief Return the path to user's personal configuration file */
1621 char *config_userconf(const char *home
, const struct passwd
*pw
) {
1626 if(SHGetKnownFolderPath(&FOLDERID_RoamingAppData
, 0, NULL
, &wpath
) != S_OK
)
1627 disorder_fatal(0, "error calling SHGetKnownFolderPath");
1628 appdata
= win_wtomb(wpath
);
1629 CoTaskMemFree(wpath
);
1630 byte_xasprintf(&s
, "%s\\DisOrder\\passwd", appdata
);
1632 if(!home
&& !pw
&& !(pw
= getpwuid(getuid())))
1633 disorder_fatal(0, "cannot determine our username");
1634 byte_xasprintf(&s
, "%s/.disorder/passwd", home ? home
: pw
->pw_dir
);
1640 /** @brief Return the path to user-specific system configuration */
1641 char *config_usersysconf(const struct passwd
*pw
) {
1645 if(!strchr(pw
->pw_name
, '/')) {
1646 byte_xasprintf(&s
, "%s.%s", configfile
, pw
->pw_name
);
1652 /** @brief Get a filename within the home directory
1653 * @param name Relative name
1656 char *config_get_file(const char *name
) {
1657 return config_get_file2(config
, name
);
1661 /** @brief Order two stringlists
1662 * @param a First stringlist
1663 * @param b Second stringlist
1664 * @return <0, 0 or >0 if a<b, a=b or a>b
1666 static int stringlist_compare(const struct stringlist
*a
,
1667 const struct stringlist
*b
) {
1670 while(n
< a
->n
&& n
< b
->n
) {
1671 if((c
= strcmp(a
->s
[n
], b
->s
[n
])))
1677 else if(a
->n
> b
->n
)
1683 /** @brief Order two namepart definitions
1684 * @param a First namepart definition
1685 * @param b Second namepart definition
1686 * @return <0, 0 or >0 if a<b, a=b or a>b
1688 static int namepart_compare(const struct namepart
*a
,
1689 const struct namepart
*b
) {
1692 if((c
= strcmp(a
->part
, b
->part
)))
1694 if((c
= strcmp(a
->res
, b
->res
)))
1696 if((c
= strcmp(a
->replace
, b
->replace
)))
1698 if((c
= strcmp(a
->context
, b
->context
)))
1700 if(a
->reflags
> b
->reflags
)
1702 if(a
->reflags
< b
->reflags
)
1707 /** @brief Order two lists of namepart definitions
1708 * @param a First list of namepart definitions
1709 * @param b Second list of namepart definitions
1710 * @return <0, 0 or >0 if a<b, a=b or a>b
1712 static int namepartlist_compare(const struct namepartlist
*a
,
1713 const struct namepartlist
*b
) {
1716 while(n
< a
->n
&& n
< b
->n
) {
1717 if((c
= namepart_compare(&a
->s
[n
], &b
->s
[n
])))
1723 else if(a
->n
< b
->n
)
1729 /** @brief Verify configuration table.
1730 * @return The number of problems found
1732 int config_verify(void) {
1735 for(n
= 1; n
< sizeof conf
/ sizeof *conf
; ++n
)
1736 if(strcmp(conf
[n
-1].name
, conf
[n
].name
) >= 0) {
1737 fprintf(stderr
, "%s >= %s\n", conf
[n
-1].name
, conf
[n
].name
);