2 * This file is part of DisOrder.
3 * Copyright (C) 2004-2010 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; /* compiled regexp */
74 char *res; /* regexp as a string */
75 char *replace; /* replacement string */
76 char *context; /* context glob */
77 unsigned reflags; /* regexp flags */
86 char *type; /* track or dir */
87 char *context; /* sort or choose */
88 char *replace; /* substitution string */
89 pcre *re; /* compiled re */
90 unsigned flags; /* regexp flags */
93 struct transformlist {
98 /** @brief System configuration */
102 /** @brief Authorization algorithm */
103 char *authorization_algorithm;
105 /** @brief All players */
106 struct stringlistlist player;
108 /** @brief All tracklength plugins */
109 struct stringlistlist tracklength;
111 /** @brief Allowed users */
112 struct stringlistlist allow;
114 /** @brief Scratch tracks */
115 struct stringlist scratch;
117 /** @brief Gap between tracks in seconds */
120 /** @brief Maximum number of recent tracks to record in history */
123 /** @brief Expiry limit for noticed.db */
124 long noticed_history;
126 /** @brief Trusted users */
127 struct stringlist trust;
129 /** @brief User for server to run as */
132 /** @brief Nice value for rescan subprocess */
135 /** @brief Paths to search for plugins */
136 struct stringlist plugins;
138 /** @brief List of stopwords */
139 struct stringlist stopword;
141 /** @brief List of collections */
142 struct collectionlist collection;
144 /** @brief Database checkpoint byte limit */
145 long checkpoint_kbyte;
147 /** @brief Databsase checkpoint minimum */
150 /** @brief Path to mixer device */
153 /** @brief Mixer channel to use */
156 long prefsync; /* preflog sync interval */
158 /** @brief Secondary listen address */
159 struct netaddress listen;
161 /** @brief Alias format string */
164 /** @brief Enable server locking */
167 /** @brief Nice value for server */
170 /** @brief Nice value for speaker */
173 /** @brief Command execute by speaker to play audio */
174 const char *speaker_command;
176 /** @brief Pause mode for command backend */
177 const char *pause_mode;
179 /** @brief Target sample format */
180 struct stream_header sample_format;
182 /** @brief Sox syntax generation */
185 /** @brief API used to play sound */
188 /** @brief Maximum size of a playlist */
191 /** @brief Maximum lifetime of a playlist lock */
192 long playlist_lock_timeout;
194 /** @brief Home directory for state files */
197 /** @brief Login username */
200 /** @brief Login password */
203 /** @brief Address to connect to */
204 struct netaddress connect;
206 /** @brief Directories to search for web templates */
207 struct stringlist templates;
209 /** @brief Canonical URL of web interface */
212 /** @brief Short display limit */
215 /** @brief Maximum refresh interval for web interface (seconds) */
218 /** @brief Minimum refresh interval for web interface (seconds) */
221 /** @brief Facilities restricted to trusted users
223 * A bitmap of @ref RESTRICT_SCRATCH, @ref RESTRICT_REMOVE and @ref
226 unsigned restrictions; /* restrictions */
227 #define RESTRICT_SCRATCH 1 /**< Restrict scratching */
228 #define RESTRICT_REMOVE 2 /**< Restrict removal */
229 #define RESTRICT_MOVE 4 /**< Restrict rearrangement */
231 /** @brief Target queue length */
234 /** @brief Minimum time between a track being played again */
237 struct namepartlist namepart; /* transformations */
239 /** @brief Termination signal for subprocesses */
242 /** @brief ALSA output device */
244 struct transformlist transform; /* path name transformations */
246 /** @brief Address to send audio data to */
247 struct netaddress broadcast;
249 /** @brief Source address for network audio transmission */
250 struct netaddress broadcast_from;
252 /** @brief RTP delay threshold */
253 long rtp_delay_threshold;
255 /** @brief Verbose RTP transmission logging */
258 /** @brief TTL for multicast packets */
261 /** @brief Whether to loop back multicast packets */
264 /** @brief Login lifetime in seconds */
265 long cookie_login_lifetime;
267 /** @brief Signing key lifetime in seconds */
268 long cookie_key_lifetime;
270 /** @brief Default rights for a new user */
271 char *default_rights;
273 /** @brief Path to sendmail executable */
276 /** @brief SMTP server for sending mail */
279 /** @brief Origin address for outbound mail */
282 /** @brief Maximum number of tracks in response to 'new' */
285 /** @brief Minimum interval between password reminder emails */
286 long reminder_interval;
288 /** @brief Whether to allow user management over TCP */
291 /** @brief Maximum age of biased-up tracks */
294 /** @brief Maximum bias */
297 /** @brief Rescan on (un)mount */
300 /* derived values: */
301 int nparts; /* number of distinct name parts */
302 char **parts; /* name part list */
304 /* undocumented, for testing only */
308 extern struct config *config;
309 /* the current configuration */
311 int config_read(int server,
312 const struct config *oldconfig);
313 /* re-read config, return 0 on success or non-0 on error.
314 * Only updates @config@ if the new configuration is valid. */
316 char *config_get_file2(struct config *c, const char *name);
317 char *config_get_file(const char *name);
318 /* get a filename within the home directory */
322 char *config_userconf(const char *home, const struct passwd *pw);
323 /* get the user's own private conffile, assuming their home dir is
324 * @home@ if not null and using @pw@ otherwise */
326 char *config_usersysconf(const struct passwd *pw );
327 /* get the user's conffile in /etc */
329 char *config_private(void);
330 /* get the private config file */
332 int config_verify(void);
334 void config_free(struct config *c);
336 extern char *configfile;
337 extern int config_per_user;
339 extern const struct uaudio *const *config_uaudio_apis;
341 #endif /* CONFIGURATION_H */