Commit | Line | Data |
---|---|---|
460b9539 | 1 | /* |
2 | * This file is part of DisOrder. | |
cca89d7c | 3 | * Copyright (C) 2004-2011, 2013 Richard Kettlewell |
460b9539 | 4 | * |
e7eb3a27 | 5 | * This program is free software: you can redistribute it and/or modify |
460b9539 | 6 | * it under the terms of the GNU General Public License as published by |
e7eb3a27 | 7 | * the Free Software Foundation, either version 3 of the License, or |
460b9539 | 8 | * (at your option) any later version. |
e7eb3a27 RK |
9 | * |
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. | |
14 | * | |
460b9539 | 15 | * You should have received a copy of the GNU General Public License |
e7eb3a27 | 16 | * along with this program. If not, see <http://www.gnu.org/licenses/>. |
460b9539 | 17 | */ |
0e4472a0 | 18 | /** @file lib/configuration.h |
19 | * @brief Configuration file support | |
20 | */ | |
460b9539 | 21 | |
22 | #ifndef CONFIGURATION_H | |
23 | #define CONFIGURATION_H | |
24 | ||
cca89d7c RK |
25 | #if HAVE_PCRE_H |
26 | # include <pcre.h> | |
27 | #endif | |
05b75f8d | 28 | |
6d2d327c | 29 | #include "speaker-protocol.h" |
04e1fa7c | 30 | #include "rights.h" |
76e72f65 | 31 | #include "addr.h" |
9d5da576 | 32 | |
b50cfb8a RK |
33 | struct uaudio; |
34 | ||
460b9539 | 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. | |
37 | */ | |
38 | ||
3f3bb97b | 39 | /** @brief A list of strings */ |
460b9539 | 40 | struct stringlist { |
3f3bb97b | 41 | /** @brief Number of strings */ |
460b9539 | 42 | int n; |
3f3bb97b | 43 | /** @brief Array of strings */ |
460b9539 | 44 | char **s; |
45 | }; | |
46 | ||
3f3bb97b | 47 | /** @brief A list of list of strings */ |
460b9539 | 48 | struct stringlistlist { |
3f3bb97b | 49 | /** @brief Number of string lists */ |
460b9539 | 50 | int n; |
3f3bb97b | 51 | /** @brief Array of string lists */ |
460b9539 | 52 | struct stringlist *s; |
53 | }; | |
54 | ||
3f3bb97b | 55 | /** @brief A collection of tracks */ |
460b9539 | 56 | struct collection { |
3f3bb97b | 57 | /** @brief Module that supports this collection */ |
460b9539 | 58 | char *module; |
3f3bb97b | 59 | /** @brief Filename encoding */ |
460b9539 | 60 | char *encoding; |
3f3bb97b | 61 | /** @brief Root directory */ |
460b9539 | 62 | char *root; |
63 | }; | |
64 | ||
3f3bb97b | 65 | /** @brief A list of collections */ |
460b9539 | 66 | struct collectionlist { |
3f3bb97b | 67 | /** @brief Number of collections */ |
460b9539 | 68 | int n; |
3f3bb97b | 69 | /** @brief Array of collections */ |
460b9539 | 70 | struct collection *s; |
71 | }; | |
72 | ||
cca89d7c | 73 | #if HAVE_PCRE_H |
598b07b7 | 74 | /** @brief A track name part */ |
460b9539 | 75 | struct namepart { |
76 | char *part; /* part */ | |
9417e1a3 RK |
77 | pcre *re; /* compiled regexp */ |
78 | char *res; /* regexp as a string */ | |
460b9539 | 79 | char *replace; /* replacement string */ |
80 | char *context; /* context glob */ | |
81 | unsigned reflags; /* regexp flags */ | |
82 | }; | |
83 | ||
598b07b7 | 84 | /** @brief A list of track name parts */ |
460b9539 | 85 | struct namepartlist { |
86 | int n; | |
87 | struct namepart *s; | |
88 | }; | |
89 | ||
598b07b7 | 90 | /** @brief A track name transform */ |
460b9539 | 91 | struct transform { |
92 | char *type; /* track or dir */ | |
93 | char *context; /* sort or choose */ | |
94 | char *replace; /* substitution string */ | |
05b75f8d | 95 | pcre *re; /* compiled re */ |
460b9539 | 96 | unsigned flags; /* regexp flags */ |
97 | }; | |
98 | ||
598b07b7 | 99 | /** @brief A list of track name transforms */ |
460b9539 | 100 | struct transformlist { |
101 | int n; | |
102 | struct transform *t; | |
103 | }; | |
cca89d7c | 104 | #endif |
460b9539 | 105 | |
3f3bb97b | 106 | /** @brief System configuration */ |
460b9539 | 107 | struct config { |
108 | /* server config */ | |
3f3bb97b | 109 | |
637fdea3 RK |
110 | /** @brief Authorization algorithm */ |
111 | char *authorization_algorithm; | |
112 | ||
3f3bb97b RK |
113 | /** @brief All players */ |
114 | struct stringlistlist player; | |
115 | ||
62dc3748 RK |
116 | /** @brief All tracklength plugins */ |
117 | struct stringlistlist tracklength; | |
118 | ||
3f3bb97b RK |
119 | /** @brief Scratch tracks */ |
120 | struct stringlist scratch; | |
121 | ||
3f3bb97b RK |
122 | /** @brief Maximum number of recent tracks to record in history */ |
123 | long history; | |
124 | ||
2a10b70b RK |
125 | /** @brief Expiry limit for noticed.db */ |
126 | long noticed_history; | |
127 | ||
3f3bb97b RK |
128 | /** @brief User for server to run as */ |
129 | const char *user; | |
130 | ||
131 | /** @brief Nice value for rescan subprocess */ | |
132 | long nice_rescan; | |
133 | ||
134 | /** @brief Paths to search for plugins */ | |
135 | struct stringlist plugins; | |
136 | ||
137 | /** @brief List of stopwords */ | |
138 | struct stringlist stopword; | |
139 | ||
140 | /** @brief List of collections */ | |
141 | struct collectionlist collection; | |
142 | ||
143 | /** @brief Database checkpoint byte limit */ | |
460b9539 | 144 | long checkpoint_kbyte; |
3f3bb97b RK |
145 | |
146 | /** @brief Databsase checkpoint minimum */ | |
460b9539 | 147 | long checkpoint_min; |
3f3bb97b RK |
148 | |
149 | /** @brief Path to mixer device */ | |
150 | char *mixer; | |
151 | ||
152 | /** @brief Mixer channel to use */ | |
153 | char *channel; | |
154 | ||
3f3bb97b | 155 | /** @brief Secondary listen address */ |
80dc2c5f | 156 | struct netaddress listen; |
3f3bb97b RK |
157 | |
158 | /** @brief Alias format string */ | |
159 | const char *alias; | |
160 | ||
3f3bb97b RK |
161 | /** @brief Nice value for server */ |
162 | long nice_server; | |
163 | ||
164 | /** @brief Nice value for speaker */ | |
165 | long nice_speaker; | |
166 | ||
167 | /** @brief Command execute by speaker to play audio */ | |
168 | const char *speaker_command; | |
169 | ||
f75ab9d3 RK |
170 | /** @brief Pause mode for command backend */ |
171 | const char *pause_mode; | |
172 | ||
3f3bb97b | 173 | /** @brief Target sample format */ |
6d2d327c | 174 | struct stream_header sample_format; |
3f3bb97b RK |
175 | |
176 | /** @brief Sox syntax generation */ | |
177 | long sox_generation; | |
178 | ||
b50cfb8a RK |
179 | /** @brief API used to play sound */ |
180 | const char *api; | |
3c499fe7 | 181 | |
2563dc1f RK |
182 | /** @brief Maximum size of a playlist */ |
183 | long playlist_max; | |
184 | ||
ddbf05c8 RK |
185 | /** @brief Maximum lifetime of a playlist lock */ |
186 | long playlist_lock_timeout; | |
187 | ||
3f3bb97b RK |
188 | /** @brief Home directory for state files */ |
189 | const char *home; | |
190 | ||
191 | /** @brief Login username */ | |
47854c5f | 192 | char *username; |
3f3bb97b RK |
193 | |
194 | /** @brief Login password */ | |
47854c5f | 195 | char *password; |
3f3bb97b RK |
196 | |
197 | /** @brief Address to connect to */ | |
e41a9999 | 198 | struct netaddress connect; |
3f3bb97b RK |
199 | |
200 | /** @brief Directories to search for web templates */ | |
201 | struct stringlist templates; | |
202 | ||
203 | /** @brief Canonical URL of web interface */ | |
b64c2805 | 204 | char *url; |
3f3bb97b | 205 | |
61507e3c RK |
206 | /** @brief Short display limit */ |
207 | long short_display; | |
208 | ||
3f3bb97b RK |
209 | /** @brief Maximum refresh interval for web interface (seconds) */ |
210 | long refresh; | |
211 | ||
533272be RK |
212 | /** @brief Minimum refresh interval for web interface (seconds) */ |
213 | long refresh_min; | |
214 | ||
3f3bb97b RK |
215 | /** @brief Target queue length */ |
216 | long queue_pad; | |
217 | ||
cebe3127 RK |
218 | /** @brief Minimum time between a track being played again */ |
219 | long replay_min; | |
220 | ||
cca89d7c | 221 | #if HAVE_PCRE_H |
460b9539 | 222 | struct namepartlist namepart; /* transformations */ |
cca89d7c | 223 | #endif |
3f3bb97b RK |
224 | |
225 | /** @brief Termination signal for subprocesses */ | |
226 | int signal; | |
227 | ||
228 | /** @brief ALSA output device */ | |
229 | const char *device; | |
cca89d7c RK |
230 | |
231 | #if HAVE_PCRE_H | |
460b9539 | 232 | struct transformlist transform; /* path name transformations */ |
cca89d7c | 233 | #endif |
460b9539 | 234 | |
23205f9c | 235 | /** @brief Address to send audio data to */ |
76e72f65 | 236 | struct netaddress broadcast; |
23205f9c RK |
237 | |
238 | /** @brief Source address for network audio transmission */ | |
76e72f65 | 239 | struct netaddress broadcast_from; |
23205f9c | 240 | |
ba70caca RK |
241 | /** @brief RTP delay threshold */ |
242 | long rtp_delay_threshold; | |
87864f77 RK |
243 | |
244 | /** @brief Verbose RTP transmission logging */ | |
245 | int rtp_verbose; | |
ba70caca | 246 | |
23205f9c RK |
247 | /** @brief TTL for multicast packets */ |
248 | long multicast_ttl; | |
e83d0967 | 249 | |
61941295 RK |
250 | /** @brief Whether to loop back multicast packets */ |
251 | int multicast_loop; | |
b12be54a RK |
252 | |
253 | /** @brief Login lifetime in seconds */ | |
254 | long cookie_login_lifetime; | |
255 | ||
256 | /** @brief Signing key lifetime in seconds */ | |
257 | long cookie_key_lifetime; | |
04e1fa7c RK |
258 | |
259 | /** @brief Default rights for a new user */ | |
0f55e905 | 260 | char *default_rights; |
bb6ae3fb | 261 | |
2eee4b0c RK |
262 | /** @brief Path to sendmail executable */ |
263 | char *sendmail; | |
264 | ||
bb6ae3fb | 265 | /** @brief SMTP server for sending mail */ |
266 | char *smtp_server; | |
267 | ||
268 | /** @brief Origin address for outbound mail */ | |
269 | char *mail_sender; | |
d742bb47 RK |
270 | |
271 | /** @brief Maximum number of tracks in response to 'new' */ | |
272 | long new_max; | |
6207d2f3 | 273 | |
274 | /** @brief Minimum interval between password reminder emails */ | |
275 | long reminder_interval; | |
810b8083 RK |
276 | |
277 | /** @brief Whether to allow user management over TCP */ | |
278 | int remote_userman; | |
05dcfac6 RK |
279 | |
280 | /** @brief Maximum age of biased-up tracks */ | |
281 | long new_bias_age; | |
282 | ||
283 | /** @brief Maximum bias */ | |
284 | long new_bias; | |
8488cf7d RK |
285 | |
286 | /** @brief Rescan on (un)mount */ | |
287 | int mount_rescan; | |
288 | ||
b0116b5c RK |
289 | /** @brief RTP mode */ |
290 | const char *rtp_mode; | |
291 | ||
460b9539 | 292 | /* derived values: */ |
293 | int nparts; /* number of distinct name parts */ | |
294 | char **parts; /* name part list */ | |
8818b7fc RK |
295 | |
296 | /* undocumented, for testing only */ | |
297 | long dbversion; | |
460b9539 | 298 | }; |
299 | ||
300 | extern struct config *config; | |
301 | /* the current configuration */ | |
302 | ||
02ba7921 RK |
303 | int config_read(int server, |
304 | const struct config *oldconfig); | |
460b9539 | 305 | /* re-read config, return 0 on success or non-0 on error. |
306 | * Only updates @config@ if the new configuration is valid. */ | |
307 | ||
319d7107 | 308 | char *config_get_file2(struct config *c, const char *name); |
460b9539 | 309 | char *config_get_file(const char *name); |
310 | /* get a filename within the home directory */ | |
311 | ||
312 | struct passwd; | |
313 | ||
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 */ | |
317 | ||
318 | char *config_usersysconf(const struct passwd *pw ); | |
319 | /* get the user's conffile in /etc */ | |
320 | ||
321 | char *config_private(void); | |
322 | /* get the private config file */ | |
323 | ||
2a1c84fb RK |
324 | int config_verify(void); |
325 | ||
47854c5f RK |
326 | void config_free(struct config *c); |
327 | ||
460b9539 | 328 | extern char *configfile; |
63ad732f | 329 | extern int config_per_user; |
460b9539 | 330 | |
b50cfb8a RK |
331 | extern const struct uaudio *const *config_uaudio_apis; |
332 | ||
460b9539 | 333 | #endif /* CONFIGURATION_H */ |
334 | ||
335 | /* | |
336 | Local Variables: | |
337 | c-basic-offset:2 | |
338 | comment-column:40 | |
339 | End: | |
340 | */ |