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"
32 /* Configuration is kept in a @struct config@; the live configuration
33 * is always pointed to by @config@. Values in @config@ are UTF-8 encoded.
36 /** @brief A list of strings */
38 /** @brief Number of strings */
40 /** @brief Array of strings */
44 /** @brief A list of list of strings */
45 struct stringlistlist
{
46 /** @brief Number of string lists */
48 /** @brief Array of string lists */
52 /** @brief A collection of tracks */
54 /** @brief Module that supports this collection */
56 /** @brief Filename encoding */
58 /** @brief Root directory */
62 /** @brief A list of collections */
63 struct collectionlist
{
64 /** @brief Number of collections */
66 /** @brief Array of collections */
71 char *part
; /* part */
72 pcre
*re
; /* regexp */
73 char *replace
; /* replacement string */
74 char *context
; /* context glob */
75 unsigned reflags
; /* regexp flags */
84 char *type
; /* track or dir */
85 char *context
; /* sort or choose */
86 char *replace
; /* substitution string */
87 pcre
*re
; /* compiled re */
88 unsigned flags
; /* regexp flags */
91 struct transformlist
{
96 /** @brief System configuration */
100 /** @brief Authorization algorithm */
101 char *authorization_algorithm
;
103 /** @brief All players */
104 struct stringlistlist player
;
106 /** @brief All tracklength plugins */
107 struct stringlistlist tracklength
;
109 /** @brief Allowed users */
110 struct stringlistlist allow
;
112 /** @brief Scratch tracks */
113 struct stringlist scratch
;
115 /** @brief Gap between tracks in seconds */
118 /** @brief Maximum number of recent tracks to record in history */
121 /** @brief Expiry limit for noticed.db */
122 long noticed_history
;
124 /** @brief Trusted users */
125 struct stringlist trust
;
127 /** @brief User for server to run as */
130 /** @brief Nice value for rescan subprocess */
133 /** @brief Paths to search for plugins */
134 struct stringlist plugins
;
136 /** @brief List of stopwords */
137 struct stringlist stopword
;
139 /** @brief List of collections */
140 struct collectionlist collection
;
142 /** @brief Database checkpoint byte limit */
143 long checkpoint_kbyte
;
145 /** @brief Databsase checkpoint minimum */
148 /** @brief Path to mixer device */
151 /** @brief Mixer channel to use */
154 long prefsync
; /* preflog sync interval */
156 /** @brief Secondary listen address */
157 struct stringlist listen
;
159 /** @brief Alias format string */
162 /** @brief Enable server locking */
165 /** @brief Nice value for server */
168 /** @brief Nice value for speaker */
171 /** @brief Command execute by speaker to play audio */
172 const char *speaker_command
;
174 /** @brief Target sample format */
175 struct stream_header sample_format
;
177 /** @brief Sox syntax generation */
180 /** @brief API used to play sound */
183 /** @brief Home directory for state files */
186 /** @brief Login username */
187 const char *username
;
189 /** @brief Login password */
190 const char *password
;
192 /** @brief Address to connect to */
193 struct stringlist connect
;
195 /** @brief Directories to search for web templates */
196 struct stringlist templates
;
198 /** @brief Canonical URL of web interface */
201 /** @brief Short display limit */
204 /** @brief Maximum refresh interval for web interface (seconds) */
207 /** @brief Facilities restricted to trusted users
209 * A bitmap of @ref RESTRICT_SCRATCH, @ref RESTRICT_REMOVE and @ref
212 unsigned restrictions
; /* restrictions */
213 #define RESTRICT_SCRATCH 1 /**< Restrict scratching */
214 #define RESTRICT_REMOVE 2 /**< Restrict removal */
215 #define RESTRICT_MOVE 4 /**< Restrict rearrangement */
217 /** @brief Target queue length */
220 /** @brief Minimum time between a track being played again */
223 struct namepartlist namepart
; /* transformations */
225 /** @brief Termination signal for subprocesses */
228 /** @brief ALSA output device */
230 struct transformlist transform
; /* path name transformations */
232 /** @brief Address to send audio data to */
233 struct stringlist broadcast
;
235 /** @brief Source address for network audio transmission */
236 struct stringlist broadcast_from
;
238 /** @brief RTP delay threshold */
239 long rtp_delay_threshold
;
241 /** @brief TTL for multicast packets */
244 /** @brief Whether to loop back multicast packets */
247 /** @brief Login lifetime in seconds */
248 long cookie_login_lifetime
;
250 /** @brief Signing key lifetime in seconds */
251 long cookie_key_lifetime
;
253 /** @brief Default rights for a new user */
254 char *default_rights
;
256 /** @brief Path to sendmail executable */
259 /** @brief SMTP server for sending mail */
262 /** @brief Origin address for outbound mail */
265 /** @brief Maximum number of tracks in response to 'new' */
268 /** @brief Minimum interval between password reminder emails */
269 long reminder_interval
;
271 /** @brief Whether to allow user management over TCP */
274 /** @brief Maximum age of biased-up tracks */
277 /** @brief Maximum bias */
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 /* re-read config, return 0 on success or non-0 on error.
293 * Only updates @config@ if the new configuration is valid. */
295 char *config_get_file2(struct config
*c
, const char *name
);
296 char *config_get_file(const char *name
);
297 /* get a filename within the home directory */
301 char *config_userconf(const char *home
, const struct passwd
*pw
);
302 /* get the user's own private conffile, assuming their home dir is
303 * @home@ if not null and using @pw@ otherwise */
305 char *config_usersysconf(const struct passwd
*pw
);
306 /* get the user's conffile in /etc */
308 char *config_private(void);
309 /* get the private config file */
311 extern char *configfile
;
312 extern int config_per_user
;
314 extern const struct uaudio
*const *config_uaudio_apis
;
316 #endif /* CONFIGURATION_H */