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 */
71 /** @brief A track name part */
73 char *part; /* part */
74 pcre *re; /* compiled regexp */
75 char *res; /* regexp as a string */
76 char *replace; /* replacement string */
77 char *context; /* context glob */
78 unsigned reflags; /* regexp flags */
81 /** @brief A list of track name parts */
87 /** @brief A track name transform */
89 char *type; /* track or dir */
90 char *context; /* sort or choose */
91 char *replace; /* substitution string */
92 pcre *re; /* compiled re */
93 unsigned flags; /* regexp flags */
96 /** @brief A list of track name transforms */
97 struct transformlist {
102 /** @brief System configuration */
106 /** @brief Authorization algorithm */
107 char *authorization_algorithm;
109 /** @brief All players */
110 struct stringlistlist player;
112 /** @brief All tracklength plugins */
113 struct stringlistlist tracklength;
115 /** @brief Scratch tracks */
116 struct stringlist scratch;
118 /** @brief Maximum number of recent tracks to record in history */
121 /** @brief Expiry limit for noticed.db */
122 long noticed_history;
124 /** @brief User for server to run as */
127 /** @brief Nice value for rescan subprocess */
130 /** @brief Paths to search for plugins */
131 struct stringlist plugins;
133 /** @brief List of stopwords */
134 struct stringlist stopword;
136 /** @brief List of collections */
137 struct collectionlist collection;
139 /** @brief Database checkpoint byte limit */
140 long checkpoint_kbyte;
142 /** @brief Databsase checkpoint minimum */
145 /** @brief Path to mixer device */
148 /** @brief Mixer channel to use */
151 /** @brief Secondary listen address */
152 struct netaddress listen;
154 /** @brief Alias format string */
157 /** @brief Nice value for server */
160 /** @brief Nice value for speaker */
163 /** @brief Command execute by speaker to play audio */
164 const char *speaker_command;
166 /** @brief Pause mode for command backend */
167 const char *pause_mode;
169 /** @brief Target sample format */
170 struct stream_header sample_format;
172 /** @brief Sox syntax generation */
175 /** @brief API used to play sound */
178 /** @brief Maximum size of a playlist */
181 /** @brief Maximum lifetime of a playlist lock */
182 long playlist_lock_timeout;
184 /** @brief Home directory for state files */
187 /** @brief Login username */
190 /** @brief Login password */
193 /** @brief Address to connect to */
194 struct netaddress connect;
196 /** @brief Directories to search for web templates */
197 struct stringlist templates;
199 /** @brief Canonical URL of web interface */
202 /** @brief Short display limit */
205 /** @brief Maximum refresh interval for web interface (seconds) */
208 /** @brief Minimum refresh interval for web interface (seconds) */
211 /** @brief Target queue length */
214 /** @brief Minimum time between a track being played again */
217 struct namepartlist namepart; /* transformations */
219 /** @brief Termination signal for subprocesses */
222 /** @brief ALSA output device */
224 struct transformlist transform; /* path name transformations */
226 /** @brief Address to send audio data to */
227 struct netaddress broadcast;
229 /** @brief Source address for network audio transmission */
230 struct netaddress broadcast_from;
232 /** @brief RTP delay threshold */
233 long rtp_delay_threshold;
235 /** @brief Verbose RTP transmission logging */
238 /** @brief TTL for multicast packets */
241 /** @brief Whether to loop back multicast packets */
244 /** @brief Login lifetime in seconds */
245 long cookie_login_lifetime;
247 /** @brief Signing key lifetime in seconds */
248 long cookie_key_lifetime;
250 /** @brief Default rights for a new user */
251 char *default_rights;
253 /** @brief Path to sendmail executable */
256 /** @brief SMTP server for sending mail */
259 /** @brief Origin address for outbound mail */
262 /** @brief Maximum number of tracks in response to 'new' */
265 /** @brief Minimum interval between password reminder emails */
266 long reminder_interval;
268 /** @brief Whether to allow user management over TCP */
271 /** @brief Maximum age of biased-up tracks */
274 /** @brief Maximum bias */
277 /** @brief Rescan on (un)mount */
280 /* derived values: */
281 int nparts; /* number of distinct name parts */
282 char **parts; /* name part list */
284 /* undocumented, for testing only */
288 extern struct config *config;
289 /* the current configuration */
291 int config_read(int server,
292 const struct config *oldconfig);
293 /* re-read config, return 0 on success or non-0 on error.
294 * Only updates @config@ if the new configuration is valid. */
296 char *config_get_file2(struct config *c, const char *name);
297 char *config_get_file(const char *name);
298 /* get a filename within the home directory */
302 char *config_userconf(const char *home, const struct passwd *pw);
303 /* get the user's own private conffile, assuming their home dir is
304 * @home@ if not null and using @pw@ otherwise */
306 char *config_usersysconf(const struct passwd *pw );
307 /* get the user's conffile in /etc */
309 char *config_private(void);
310 /* get the private config file */
312 int config_verify(void);
314 void config_free(struct config *c);
316 extern char *configfile;
317 extern int config_per_user;
319 extern const struct uaudio *const *config_uaudio_apis;
321 #endif /* CONFIGURATION_H */