Commit | Line | Data |
---|---|---|
460b9539 | 1 | /* |
2 | * This file is part of DisOrder. | |
b50cfb8a | 3 | * Copyright (C) 2004-2009 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 | ||
71 | struct namepart { | |
72 | char *part; /* part */ | |
05b75f8d | 73 | pcre *re; /* regexp */ |
460b9539 | 74 | char *replace; /* replacement string */ |
75 | char *context; /* context glob */ | |
76 | unsigned reflags; /* regexp flags */ | |
77 | }; | |
78 | ||
79 | struct namepartlist { | |
80 | int n; | |
81 | struct namepart *s; | |
82 | }; | |
83 | ||
84 | struct transform { | |
85 | char *type; /* track or dir */ | |
86 | char *context; /* sort or choose */ | |
87 | char *replace; /* substitution string */ | |
05b75f8d | 88 | pcre *re; /* compiled re */ |
460b9539 | 89 | unsigned flags; /* regexp flags */ |
90 | }; | |
91 | ||
92 | struct transformlist { | |
93 | int n; | |
94 | struct transform *t; | |
95 | }; | |
96 | ||
3f3bb97b | 97 | /** @brief System configuration */ |
460b9539 | 98 | struct config { |
99 | /* server config */ | |
3f3bb97b | 100 | |
637fdea3 RK |
101 | /** @brief Authorization algorithm */ |
102 | char *authorization_algorithm; | |
103 | ||
3f3bb97b RK |
104 | /** @brief All players */ |
105 | struct stringlistlist player; | |
106 | ||
62dc3748 RK |
107 | /** @brief All tracklength plugins */ |
108 | struct stringlistlist tracklength; | |
109 | ||
3f3bb97b RK |
110 | /** @brief Allowed users */ |
111 | struct stringlistlist allow; | |
112 | ||
113 | /** @brief Scratch tracks */ | |
114 | struct stringlist scratch; | |
115 | ||
116 | /** @brief Gap between tracks in seconds */ | |
117 | long gap; | |
118 | ||
119 | /** @brief Maximum number of recent tracks to record in history */ | |
120 | long history; | |
121 | ||
2a10b70b RK |
122 | /** @brief Expiry limit for noticed.db */ |
123 | long noticed_history; | |
124 | ||
3f3bb97b RK |
125 | /** @brief Trusted users */ |
126 | struct stringlist trust; | |
127 | ||
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 | ||
155 | long prefsync; /* preflog sync interval */ | |
156 | ||
157 | /** @brief Secondary listen address */ | |
80dc2c5f | 158 | struct netaddress listen; |
3f3bb97b RK |
159 | |
160 | /** @brief Alias format string */ | |
161 | const char *alias; | |
162 | ||
163 | /** @brief Enable server locking */ | |
164 | int lock; | |
165 | ||
166 | /** @brief Nice value for server */ | |
167 | long nice_server; | |
168 | ||
169 | /** @brief Nice value for speaker */ | |
170 | long nice_speaker; | |
171 | ||
172 | /** @brief Command execute by speaker to play audio */ | |
173 | const char *speaker_command; | |
174 | ||
f75ab9d3 RK |
175 | /** @brief Pause mode for command backend */ |
176 | const char *pause_mode; | |
177 | ||
3f3bb97b | 178 | /** @brief Target sample format */ |
6d2d327c | 179 | struct stream_header sample_format; |
3f3bb97b RK |
180 | |
181 | /** @brief Sox syntax generation */ | |
182 | long sox_generation; | |
183 | ||
b50cfb8a RK |
184 | /** @brief API used to play sound */ |
185 | const char *api; | |
3c499fe7 | 186 | |
3f3bb97b RK |
187 | /** @brief Home directory for state files */ |
188 | const char *home; | |
189 | ||
190 | /** @brief Login username */ | |
191 | const char *username; | |
192 | ||
193 | /** @brief Login password */ | |
194 | const char *password; | |
195 | ||
196 | /** @brief Address to connect to */ | |
e41a9999 | 197 | struct netaddress connect; |
3f3bb97b RK |
198 | |
199 | /** @brief Directories to search for web templates */ | |
200 | struct stringlist templates; | |
201 | ||
202 | /** @brief Canonical URL of web interface */ | |
b64c2805 | 203 | char *url; |
3f3bb97b | 204 | |
61507e3c RK |
205 | /** @brief Short display limit */ |
206 | long short_display; | |
207 | ||
3f3bb97b RK |
208 | /** @brief Maximum refresh interval for web interface (seconds) */ |
209 | long refresh; | |
210 | ||
211 | /** @brief Facilities restricted to trusted users | |
212 | * | |
213 | * A bitmap of @ref RESTRICT_SCRATCH, @ref RESTRICT_REMOVE and @ref | |
214 | * RESTRICT_MOVE. | |
215 | */ | |
460b9539 | 216 | unsigned restrictions; /* restrictions */ |
3f3bb97b RK |
217 | #define RESTRICT_SCRATCH 1 /**< Restrict scratching */ |
218 | #define RESTRICT_REMOVE 2 /**< Restrict removal */ | |
219 | #define RESTRICT_MOVE 4 /**< Restrict rearrangement */ | |
220 | ||
221 | /** @brief Target queue length */ | |
222 | long queue_pad; | |
223 | ||
cebe3127 RK |
224 | /** @brief Minimum time between a track being played again */ |
225 | long replay_min; | |
226 | ||
460b9539 | 227 | struct namepartlist namepart; /* transformations */ |
3f3bb97b RK |
228 | |
229 | /** @brief Termination signal for subprocesses */ | |
230 | int signal; | |
231 | ||
232 | /** @brief ALSA output device */ | |
233 | const char *device; | |
460b9539 | 234 | struct transformlist transform; /* path name transformations */ |
235 | ||
23205f9c | 236 | /** @brief Address to send audio data to */ |
76e72f65 | 237 | struct netaddress broadcast; |
23205f9c RK |
238 | |
239 | /** @brief Source address for network audio transmission */ | |
76e72f65 | 240 | struct netaddress broadcast_from; |
23205f9c | 241 | |
ba70caca RK |
242 | /** @brief RTP delay threshold */ |
243 | long rtp_delay_threshold; | |
244 | ||
23205f9c RK |
245 | /** @brief TTL for multicast packets */ |
246 | long multicast_ttl; | |
e83d0967 | 247 | |
61941295 RK |
248 | /** @brief Whether to loop back multicast packets */ |
249 | int multicast_loop; | |
b12be54a RK |
250 | |
251 | /** @brief Login lifetime in seconds */ | |
252 | long cookie_login_lifetime; | |
253 | ||
254 | /** @brief Signing key lifetime in seconds */ | |
255 | long cookie_key_lifetime; | |
04e1fa7c RK |
256 | |
257 | /** @brief Default rights for a new user */ | |
0f55e905 | 258 | char *default_rights; |
bb6ae3fb | 259 | |
2eee4b0c RK |
260 | /** @brief Path to sendmail executable */ |
261 | char *sendmail; | |
262 | ||
bb6ae3fb | 263 | /** @brief SMTP server for sending mail */ |
264 | char *smtp_server; | |
265 | ||
266 | /** @brief Origin address for outbound mail */ | |
267 | char *mail_sender; | |
d742bb47 RK |
268 | |
269 | /** @brief Maximum number of tracks in response to 'new' */ | |
270 | long new_max; | |
6207d2f3 | 271 | |
272 | /** @brief Minimum interval between password reminder emails */ | |
273 | long reminder_interval; | |
810b8083 RK |
274 | |
275 | /** @brief Whether to allow user management over TCP */ | |
276 | int remote_userman; | |
05dcfac6 RK |
277 | |
278 | /** @brief Maximum age of biased-up tracks */ | |
279 | long new_bias_age; | |
280 | ||
281 | /** @brief Maximum bias */ | |
282 | long new_bias; | |
61941295 | 283 | |
460b9539 | 284 | /* derived values: */ |
285 | int nparts; /* number of distinct name parts */ | |
286 | char **parts; /* name part list */ | |
8818b7fc RK |
287 | |
288 | /* undocumented, for testing only */ | |
289 | long dbversion; | |
460b9539 | 290 | }; |
291 | ||
292 | extern struct config *config; | |
293 | /* the current configuration */ | |
294 | ||
c00fce3a | 295 | int config_read(int server); |
460b9539 | 296 | /* re-read config, return 0 on success or non-0 on error. |
297 | * Only updates @config@ if the new configuration is valid. */ | |
298 | ||
319d7107 | 299 | char *config_get_file2(struct config *c, const char *name); |
460b9539 | 300 | char *config_get_file(const char *name); |
301 | /* get a filename within the home directory */ | |
302 | ||
303 | struct passwd; | |
304 | ||
305 | char *config_userconf(const char *home, const struct passwd *pw); | |
306 | /* get the user's own private conffile, assuming their home dir is | |
307 | * @home@ if not null and using @pw@ otherwise */ | |
308 | ||
309 | char *config_usersysconf(const struct passwd *pw ); | |
310 | /* get the user's conffile in /etc */ | |
311 | ||
312 | char *config_private(void); | |
313 | /* get the private config file */ | |
314 | ||
315 | extern char *configfile; | |
63ad732f | 316 | extern int config_per_user; |
460b9539 | 317 | |
b50cfb8a RK |
318 | extern const struct uaudio *const *config_uaudio_apis; |
319 | ||
460b9539 | 320 | #endif /* CONFIGURATION_H */ |
321 | ||
322 | /* | |
323 | Local Variables: | |
324 | c-basic-offset:2 | |
325 | comment-column:40 | |
326 | End: | |
327 | */ |