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; /* 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 Home directory for state files */
191 /** @brief Login username */
192 const char *username;
194 /** @brief Login password */
195 const char *password;
197 /** @brief Address to connect to */
198 struct netaddress connect;
200 /** @brief Directories to search for web templates */
201 struct stringlist templates;
203 /** @brief Canonical URL of web interface */
206 /** @brief Short display limit */
209 /** @brief Maximum refresh interval for web interface (seconds) */
212 /** @brief Facilities restricted to trusted users
214 * A bitmap of @ref RESTRICT_SCRATCH, @ref RESTRICT_REMOVE and @ref
217 unsigned restrictions; /* restrictions */
218 #define RESTRICT_SCRATCH 1 /**< Restrict scratching */
219 #define RESTRICT_REMOVE 2 /**< Restrict removal */
220 #define RESTRICT_MOVE 4 /**< Restrict rearrangement */
222 /** @brief Target queue length */
225 /** @brief Minimum time between a track being played again */
228 struct namepartlist namepart; /* transformations */
230 /** @brief Termination signal for subprocesses */
233 /** @brief ALSA output device */
235 struct transformlist transform; /* path name transformations */
237 /** @brief Address to send audio data to */
238 struct netaddress broadcast;
240 /** @brief Source address for network audio transmission */
241 struct netaddress broadcast_from;
243 /** @brief RTP delay threshold */
244 long rtp_delay_threshold;
246 /** @brief TTL for multicast packets */
249 /** @brief Whether to loop back multicast packets */
252 /** @brief Login lifetime in seconds */
253 long cookie_login_lifetime;
255 /** @brief Signing key lifetime in seconds */
256 long cookie_key_lifetime;
258 /** @brief Default rights for a new user */
259 char *default_rights;
261 /** @brief Path to sendmail executable */
264 /** @brief SMTP server for sending mail */
267 /** @brief Origin address for outbound mail */
270 /** @brief Maximum number of tracks in response to 'new' */
273 /** @brief Minimum interval between password reminder emails */
274 long reminder_interval;
276 /** @brief Whether to allow user management over TCP */
279 /** @brief Maximum age of biased-up tracks */
282 /** @brief Maximum bias */
285 /* derived values: */
286 int nparts; /* number of distinct name parts */
287 char **parts; /* name part list */
289 /* undocumented, for testing only */
293 extern struct config *config;
294 /* the current configuration */
296 int config_read(int server,
297 const struct config *oldconfig);
298 /* re-read config, return 0 on success or non-0 on error.
299 * Only updates @config@ if the new configuration is valid. */
301 char *config_get_file2(struct config *c, const char *name);
302 char *config_get_file(const char *name);
303 /* get a filename within the home directory */
307 char *config_userconf(const char *home, const struct passwd *pw);
308 /* get the user's own private conffile, assuming their home dir is
309 * @home@ if not null and using @pw@ otherwise */
311 char *config_usersysconf(const struct passwd *pw );
312 /* get the user's conffile in /etc */
314 char *config_private(void);
315 /* get the private config file */
317 extern char *configfile;
318 extern int config_per_user;
320 extern const struct uaudio *const *config_uaudio_apis;
322 #endif /* CONFIGURATION_H */