2 * This file is part of DisOrder.
3 * Copyright (C) 2004-2011, 2013 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
29 #include "speaker-protocol.h"
35 /* Configuration is kept in a @struct config@; the live configuration
36 * is always pointed to by @config@. Values in @config@ are UTF-8 encoded.
39 /** @brief A list of strings */
41 /** @brief Number of strings */
43 /** @brief Array of strings */
47 /** @brief A list of list of strings */
48 struct stringlistlist
{
49 /** @brief Number of string lists */
51 /** @brief Array of string lists */
55 /** @brief A collection of tracks */
57 /** @brief Module that supports this collection */
59 /** @brief Filename encoding */
61 /** @brief Root directory */
65 /** @brief A list of collections */
66 struct collectionlist
{
67 /** @brief Number of collections */
69 /** @brief Array of collections */
74 /** @brief A track name part */
76 char *part
; /* part */
77 pcre
*re
; /* compiled regexp */
78 char *res
; /* regexp as a string */
79 char *replace
; /* replacement string */
80 char *context
; /* context glob */
81 unsigned reflags
; /* regexp flags */
84 /** @brief A list of track name parts */
90 /** @brief A track name transform */
92 char *type
; /* track or dir */
93 char *context
; /* sort or choose */
94 char *replace
; /* substitution string */
95 pcre
*re
; /* compiled re */
96 unsigned flags
; /* regexp flags */
99 /** @brief A list of track name transforms */
100 struct transformlist
{
106 /** @brief System configuration */
110 /** @brief Authorization algorithm */
111 char *authorization_algorithm
;
113 /** @brief All players */
114 struct stringlistlist player
;
116 /** @brief All tracklength plugins */
117 struct stringlistlist tracklength
;
119 /** @brief Scratch tracks */
120 struct stringlist scratch
;
122 /** @brief Maximum number of recent tracks to record in history */
125 /** @brief Expiry limit for noticed.db */
126 long noticed_history
;
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 /** @brief Secondary listen address */
156 struct netaddress listen
;
158 /** @brief Alias format string */
161 /** @brief Nice value for server */
164 /** @brief Nice value for speaker */
167 /** @brief Command execute by speaker to play audio */
168 const char *speaker_command
;
170 /** @brief Pause mode for command backend */
171 const char *pause_mode
;
173 /** @brief Target sample format */
174 struct stream_header sample_format
;
176 /** @brief Sox syntax generation */
179 /** @brief API used to play sound */
182 /** @brief Maximum size of a playlist */
185 /** @brief Maximum lifetime of a playlist lock */
186 long playlist_lock_timeout
;
188 /** @brief Home directory for state files */
191 /** @brief Login username */
194 /** @brief Login 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 Minimum refresh interval for web interface (seconds) */
215 /** @brief Target queue length */
218 /** @brief Minimum time between a track being played again */
222 struct namepartlist namepart
; /* transformations */
225 /** @brief Termination signal for subprocesses */
228 /** @brief ALSA output device */
232 struct transformlist transform
; /* path name transformations */
235 /** @brief Address to send audio data to */
236 struct netaddress broadcast
;
238 /** @brief Source address for network audio transmission */
239 struct netaddress broadcast_from
;
241 /** @brief RTP delay threshold */
242 long rtp_delay_threshold
;
244 /** @brief Verbose RTP transmission logging */
247 /** @brief TTL for multicast packets */
250 /** @brief Whether to loop back multicast packets */
253 /** @brief Login lifetime in seconds */
254 long cookie_login_lifetime
;
256 /** @brief Signing key lifetime in seconds */
257 long cookie_key_lifetime
;
259 /** @brief Default rights for a new user */
260 char *default_rights
;
262 /** @brief Path to sendmail executable */
265 /** @brief SMTP server for sending mail */
268 /** @brief Origin address for outbound mail */
271 /** @brief Maximum number of tracks in response to 'new' */
274 /** @brief Minimum interval between password reminder emails */
275 long reminder_interval
;
277 /** @brief Whether to allow user management over TCP */
280 /** @brief Maximum age of biased-up tracks */
283 /** @brief Maximum bias */
286 /** @brief Rescan on (un)mount */
289 /** @brief RTP mode */
290 const char *rtp_mode
;
292 /* derived values: */
293 int nparts
; /* number of distinct name parts */
294 char **parts
; /* name part list */
296 /* undocumented, for testing only */
300 extern struct config
*config
;
301 /* the current configuration */
303 int config_read(int server
,
304 const struct config
*oldconfig
);
305 /* re-read config, return 0 on success or non-0 on error.
306 * Only updates @config@ if the new configuration is valid. */
308 char *config_get_file2(struct config
*c
, const char *name
);
309 char *config_get_file(const char *name
);
310 /* get a filename within the home directory */
314 char *config_userconf(const char *home
, const struct passwd
*pw
);
315 /* get the user's own private conffile, assuming their home dir is
316 * @home@ if not null and using @pw@ otherwise */
318 char *config_usersysconf(const struct passwd
*pw
);
319 /* get the user's conffile in /etc */
321 char *config_private(void);
322 /* get the private config file */
324 int config_verify(void);
326 void config_free(struct config
*c
);
328 extern char *configfile
;
329 extern int config_per_user
;
331 extern const struct uaudio
*const *config_uaudio_apis
;
333 #endif /* CONFIGURATION_H */