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