2 * This file is part of DisOrder.
3 * Copyright (C) 2004-2009 Richard Kettlewell
5 * This program is free software: you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation, either version 3 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License
16 * along with this program. If not, see <http://www.gnu.org/licenses/>.
18 /** @file lib/configuration.h
19 * @brief Configuration file support
22 #ifndef CONFIGURATION_H
23 #define CONFIGURATION_H
27 #include "speaker-protocol.h"
33 /* Configuration is kept in a @struct config@; the live configuration
34 * is always pointed to by @config@. Values in @config@ are UTF-8 encoded.
37 /** @brief A list of strings */
39 /** @brief Number of strings */
41 /** @brief Array of strings */
45 /** @brief A list of list of strings */
46 struct stringlistlist {
47 /** @brief Number of string lists */
49 /** @brief Array of string lists */
53 /** @brief A collection of tracks */
55 /** @brief Module that supports this collection */
57 /** @brief Filename encoding */
59 /** @brief Root directory */
63 /** @brief A list of collections */
64 struct collectionlist {
65 /** @brief Number of collections */
67 /** @brief Array of collections */
72 char *part; /* part */
73 pcre *re; /* regexp */
74 char *replace; /* replacement string */
75 char *context; /* context glob */
76 unsigned reflags; /* regexp flags */
85 char *type; /* track or dir */
86 char *context; /* sort or choose */
87 char *replace; /* substitution string */
88 pcre *re; /* compiled re */
89 unsigned flags; /* regexp flags */
92 struct transformlist {
97 /** @brief System configuration */
101 /** @brief Authorization algorithm */
102 char *authorization_algorithm;
104 /** @brief All players */
105 struct stringlistlist player;
107 /** @brief All tracklength plugins */
108 struct stringlistlist tracklength;
110 /** @brief Allowed users */
111 struct stringlistlist allow;
113 /** @brief Scratch tracks */
114 struct stringlist scratch;
116 /** @brief Gap between tracks in seconds */
119 /** @brief Maximum number of recent tracks to record in history */
122 /** @brief Expiry limit for noticed.db */
123 long noticed_history;
125 /** @brief Trusted users */
126 struct stringlist trust;
128 /** @brief User for server to run as */
131 /** @brief Nice value for rescan subprocess */
134 /** @brief Paths to search for plugins */
135 struct stringlist plugins;
137 /** @brief List of stopwords */
138 struct stringlist stopword;
140 /** @brief List of collections */
141 struct collectionlist collection;
143 /** @brief Database checkpoint byte limit */
144 long checkpoint_kbyte;
146 /** @brief Databsase checkpoint minimum */
149 /** @brief Path to mixer device */
152 /** @brief Mixer channel to use */
155 long prefsync; /* preflog sync interval */
157 /** @brief Secondary listen address */
158 struct netaddress listen;
160 /** @brief Alias format string */
163 /** @brief Enable server locking */
166 /** @brief Nice value for server */
169 /** @brief Nice value for speaker */
172 /** @brief Command execute by speaker to play audio */
173 const char *speaker_command;
175 /** @brief Pause mode for command backend */
176 const char *pause_mode;
178 /** @brief Target sample format */
179 struct stream_header sample_format;
181 /** @brief Sox syntax generation */
184 /** @brief API used to play sound */
187 /** @brief Home directory for state files */
190 /** @brief Login username */
191 const char *username;
193 /** @brief Login password */
194 const char *password;
196 /** @brief Address to connect to */
197 struct netaddress connect;
199 /** @brief Directories to search for web templates */
200 struct stringlist templates;
202 /** @brief Canonical URL of web interface */
205 /** @brief Short display limit */
208 /** @brief Maximum refresh interval for web interface (seconds) */
211 /** @brief Facilities restricted to trusted users
213 * A bitmap of @ref RESTRICT_SCRATCH, @ref RESTRICT_REMOVE and @ref
216 unsigned restrictions; /* restrictions */
217 #define RESTRICT_SCRATCH 1 /**< Restrict scratching */
218 #define RESTRICT_REMOVE 2 /**< Restrict removal */
219 #define RESTRICT_MOVE 4 /**< Restrict rearrangement */
221 /** @brief Target queue length */
224 /** @brief Minimum time between a track being played again */
227 struct namepartlist namepart; /* transformations */
229 /** @brief Termination signal for subprocesses */
232 /** @brief ALSA output device */
234 struct transformlist transform; /* path name transformations */
236 /** @brief Address to send audio data to */
237 struct netaddress broadcast;
239 /** @brief Source address for network audio transmission */
240 struct netaddress broadcast_from;
242 /** @brief RTP delay threshold */
243 long rtp_delay_threshold;
245 /** @brief TTL for multicast packets */
248 /** @brief Whether to loop back multicast packets */
251 /** @brief Login lifetime in seconds */
252 long cookie_login_lifetime;
254 /** @brief Signing key lifetime in seconds */
255 long cookie_key_lifetime;
257 /** @brief Default rights for a new user */
258 char *default_rights;
260 /** @brief Path to sendmail executable */
263 /** @brief SMTP server for sending mail */
266 /** @brief Origin address for outbound mail */
269 /** @brief Maximum number of tracks in response to 'new' */
272 /** @brief Minimum interval between password reminder emails */
273 long reminder_interval;
275 /** @brief Whether to allow user management over TCP */
278 /** @brief Maximum age of biased-up tracks */
281 /** @brief Maximum bias */
284 /* derived values: */
285 int nparts; /* number of distinct name parts */
286 char **parts; /* name part list */
288 /* undocumented, for testing only */
292 extern struct config *config;
293 /* the current configuration */
295 int config_read(int server);
296 /* re-read config, return 0 on success or non-0 on error.
297 * Only updates @config@ if the new configuration is valid. */
299 char *config_get_file2(struct config *c, const char *name);
300 char *config_get_file(const char *name);
301 /* get a filename within the home directory */
305 char *config_userconf(const char *home, const struct passwd *pw);
306 /* get the user's own private conffile, assuming their home dir is
307 * @home@ if not null and using @pw@ otherwise */
309 char *config_usersysconf(const struct passwd *pw );
310 /* get the user's conffile in /etc */
312 char *config_private(void);
313 /* get the private config file */
315 extern char *configfile;
316 extern int config_per_user;
318 extern const struct uaudio *const *config_uaudio_apis;
320 #endif /* CONFIGURATION_H */