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