3 * This file is part of DisOrder.
4 * Copyright (C) 2004-2008 Richard Kettlewell
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful, but
12 * WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
21 /** @file lib/configuration.h
22 * @brief Configuration file support
25 #ifndef CONFIGURATION_H
26 #define CONFIGURATION_H
28 #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 struct real_pcre
*re
; /* regexp */
74 char *replace
; /* replacement string */
75 char *context
; /* context glob */
76 unsigned reflags
; /* regexp flags */
85 char *type
; /* track or dir */
86 char *context
; /* sort or choose */
87 char *replace
; /* substitution string */
88 struct real_pcre
*re
; /* compiled re */
89 unsigned flags
; /* regexp flags */
92 struct transformlist
{
97 /** @brief System configuration */
101 /** @brief Authorization algorithm */
102 char *authorization_algorithm
;
104 /** @brief All players */
105 struct stringlistlist player
;
107 /** @brief All tracklength plugins */
108 struct stringlistlist tracklength
;
110 /** @brief Allowed users */
111 struct stringlistlist allow
;
113 /** @brief Scratch tracks */
114 struct stringlist scratch
;
116 /** @brief Gap between tracks in seconds */
119 /** @brief Maximum number of recent tracks to record in history */
122 /** @brief Expiry limit for noticed.db */
123 long noticed_history
;
125 /** @brief Trusted users */
126 struct stringlist trust
;
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 long prefsync
; /* preflog sync interval */
157 /** @brief Secondary listen address */
158 struct stringlist listen
;
160 /** @brief Alias format string */
163 /** @brief Enable server locking */
166 /** @brief Nice value for server */
169 /** @brief Nice value for speaker */
172 /** @brief Command execute by speaker to play audio */
173 const char *speaker_command
;
175 /** @brief Target sample format */
176 struct stream_header sample_format
;
178 /** @brief Sox syntax generation */
181 /** @brief API used to play sound
183 * Choices are @ref BACKEND_ALSA, @ref BACKEND_COMMAND or @ref
188 /* These values had better be non-negative */
189 #define BACKEND_ALSA 0 /**< Use ALSA (Linux only) */
190 #define BACKEND_COMMAND 1 /**< Execute a command */
191 #define BACKEND_NETWORK 2 /**< Transmit RTP */
192 #define BACKEND_COREAUDIO 3 /**< Use Core Audio (Mac only) */
193 #define BACKEND_OSS 4 /**< Use OSS */
195 #if HAVE_ALSA_ASOUNDLIB_H
196 # define DEFAULT_BACKEND BACKEND_ALSA
197 #elif HAVE_SYS_SOUNDCARD_H || EMPEG_HOST
198 # define DEFAULT_BACKEND BACKEND_OSS
199 #elif HAVE_COREAUDIO_AUDIOHARDWARE_H
200 # define DEFAULT_BACKEND BACKEND_COREAUDIO
202 # error Cannot choose a default backend
205 /** @brief Home directory for state files */
208 /** @brief Login username */
209 const char *username
;
211 /** @brief Login password */
212 const char *password
;
214 /** @brief Address to connect to */
215 struct stringlist connect
;
217 /** @brief Directories to search for web templates */
218 struct stringlist templates
;
220 /** @brief Canonical URL of web interface */
223 /** @brief Short display limit */
226 /** @brief Maximum refresh interval for web interface (seconds) */
229 /** @brief Facilities restricted to trusted users
231 * A bitmap of @ref RESTRICT_SCRATCH, @ref RESTRICT_REMOVE and @ref
234 unsigned restrictions
; /* restrictions */
235 #define RESTRICT_SCRATCH 1 /**< Restrict scratching */
236 #define RESTRICT_REMOVE 2 /**< Restrict removal */
237 #define RESTRICT_MOVE 4 /**< Restrict rearrangement */
239 /** @brief Target queue length */
242 /** @brief Minimum time between a track being played again */
245 struct namepartlist namepart
; /* transformations */
247 /** @brief Termination signal for subprocesses */
250 /** @brief ALSA output device */
252 struct transformlist transform
; /* path name transformations */
254 /** @brief Address to send audio data to */
255 struct stringlist broadcast
;
257 /** @brief Source address for network audio transmission */
258 struct stringlist broadcast_from
;
260 /** @brief TTL for multicast packets */
263 /** @brief Whether to loop back multicast packets */
266 /** @brief Login lifetime in seconds */
267 long cookie_login_lifetime
;
269 /** @brief Signing key lifetime in seconds */
270 long cookie_key_lifetime
;
272 /** @brief Default rights for a new user */
273 char *default_rights
;
275 /** @brief SMTP server for sending mail */
278 /** @brief Origin address for outbound mail */
281 /** @brief Maximum number of tracks in response to 'new' */
284 /** @brief Minimum interval between password reminder emails */
285 long reminder_interval
;
287 /** @brief Whether to allow user management over TCP */
290 /** @brief Maximum age of biased-up tracks */
293 /** @brief Maximum bias */
296 /* derived values: */
297 int nparts
; /* number of distinct name parts */
298 char **parts
; /* name part list */
300 /* undocumented, for testing only */
304 extern struct config
*config
;
305 /* the current configuration */
307 int config_read(int server
);
308 /* re-read config, return 0 on success or non-0 on error.
309 * Only updates @config@ if the new configuration is valid. */
311 char *config_get_file(const char *name
);
312 /* get a filename within the home directory */
316 char *config_userconf(const char *home
, const struct passwd
*pw
);
317 /* get the user's own private conffile, assuming their home dir is
318 * @home@ if not null and using @pw@ otherwise */
320 char *config_usersysconf(const struct passwd
*pw
);
321 /* get the user's conffile in /etc */
323 char *config_private(void);
324 /* get the private config file */
326 extern char *configfile
;
327 extern int config_per_user
;
329 #endif /* CONFIGURATION_H */