Commit | Line | Data |
---|---|---|
05b75f8d RK |
1 | /* |
2 | * This file is part of DisOrder | |
8a886602 | 3 | * Copyright (C) 2008-2012 Richard Kettlewell |
05b75f8d | 4 | * |
e7eb3a27 | 5 | * This program is free software: you can redistribute it and/or modify |
05b75f8d | 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 |
05b75f8d RK |
8 | * (at your option) any later version. |
9 | * | |
e7eb3a27 RK |
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 | * | |
05b75f8d | 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/>. |
05b75f8d | 17 | */ |
132a5a4a RK |
18 | /** @file server/disorder-server.h |
19 | * @brief Definitions for server and allied utilities | |
20 | */ | |
05b75f8d RK |
21 | |
22 | #ifndef DISORDER_SERVER_H | |
23 | #define DISORDER_SERVER_H | |
24 | ||
25 | #include "common.h" | |
26 | ||
27 | #include <db.h> | |
28 | #include <errno.h> | |
29 | #include <fcntl.h> | |
30 | #include <fnmatch.h> | |
31 | #include <gcrypt.h> | |
32 | #include <getopt.h> | |
33 | #include <grp.h> | |
34 | #include <locale.h> | |
35 | #include <netinet/in.h> | |
36 | #include <pcre.h> | |
37 | #include <pwd.h> | |
38 | #include <signal.h> | |
39 | #include <stddef.h> | |
40 | #include <sys/socket.h> | |
41 | #include <sys/stat.h> | |
42 | #include <sys/time.h> | |
43 | #include <sys/types.h> | |
44 | #include <sys/un.h> | |
31e2a93e | 45 | #include <sys/resource.h> |
05b75f8d RK |
46 | #include <syslog.h> |
47 | #include <time.h> | |
48 | #include <unistd.h> | |
49 | ||
50 | #include "addr.h" | |
51 | #include "authhash.h" | |
52 | #include "base64.h" | |
53 | #include "cache.h" | |
54 | #include "charset.h" | |
55 | #include "configuration.h" | |
56 | #include "cookies.h" | |
57 | #include "defs.h" | |
58 | #include "disorder.h" | |
59 | #include "event.h" | |
60 | #include "eventlog.h" | |
61 | #include "eventlog.h" | |
62 | #include "hash.h" | |
63 | #include "hex.h" | |
64 | #include "inputline.h" | |
65 | #include "kvp.h" | |
66 | #include "log.h" | |
67 | #include "logfd.h" | |
68 | #include "mem.h" | |
69 | #include "mime.h" | |
05b75f8d RK |
70 | #include "printf.h" |
71 | #include "queue.h" | |
72 | #include "random.h" | |
73 | #include "rights.h" | |
74 | #include "sendmail.h" | |
75 | #include "sink.h" | |
76 | #include "speaker-protocol.h" | |
77 | #include "split.h" | |
78 | #include "syscalls.h" | |
79 | #include "table.h" | |
80 | #include "trackdb-int.h" | |
81 | #include "trackdb.h" | |
82 | #include "trackname.h" | |
b50cfb8a | 83 | #include "uaudio.h" |
05b75f8d RK |
84 | #include "unicode.h" |
85 | #include "user.h" | |
86 | #include "vector.h" | |
87 | #include "version.h" | |
88 | #include "wstat.h" | |
89 | ||
b50cfb8a RK |
90 | extern const struct uaudio *api; |
91 | ||
05b75f8d RK |
92 | void daemonize(const char *tag, int fac, const char *pidfile); |
93 | /* Go into background. Send stdout/stderr to syslog. | |
94 | * If @pri@ is non-null, it should be "facility.level" | |
95 | * If @tag@ is non-null, it is used as a tag to each message | |
96 | * If @pidfile@ is non-null, the PID is written to that file. | |
97 | */ | |
98 | ||
99 | void quit(ev_source *ev) attribute((noreturn)); | |
100 | /* terminate the daemon */ | |
101 | ||
37f29ce9 RK |
102 | int reconfigure(ev_source *ev, unsigned flags); |
103 | /* reconfigure */ | |
104 | ||
105 | void reset_sockets(ev_source *ev); | |
106 | ||
107 | /** @brief Set when starting server */ | |
108 | #define RECONFIGURE_FIRST 0x0001 | |
109 | ||
110 | /** @brief Set when reloading after SIGHUP etc */ | |
111 | #define RECONFIGURE_RELOADING 0x0002 | |
05b75f8d | 112 | |
74f77840 RK |
113 | void dbparams_check(void); |
114 | ||
05b75f8d RK |
115 | extern struct queue_entry qhead; |
116 | /* queue of things yet to be played. the head will be played | |
117 | * soonest. */ | |
118 | ||
119 | extern struct queue_entry phead; | |
120 | /* things that have been played in the past. the head is the oldest. */ | |
121 | ||
122 | extern long pcount; | |
123 | ||
124 | void queue_read(void); | |
125 | /* read the queue in. Calls @fatal@ on error. */ | |
126 | ||
127 | void queue_write(void); | |
128 | /* write the queue out. Calls @fatal@ on error. */ | |
129 | ||
130 | void recent_read(void); | |
131 | /* read the recently played list in. Calls @fatal@ on error. */ | |
132 | ||
133 | void recent_write(void); | |
134 | /* write the recently played list out. Calls @fatal@ on error. */ | |
135 | ||
136 | struct queue_entry *queue_add(const char *track, const char *submitter, | |
7a853280 RK |
137 | int where, const char *target, |
138 | enum track_origin origin); | |
05b75f8d RK |
139 | #define WHERE_START 0 /* Add to head of queue */ |
140 | #define WHERE_END 1 /* Add to end of queue */ | |
141 | #define WHERE_BEFORE_RANDOM 2 /* End, or before random track */ | |
7a853280 | 142 | #define WHERE_AFTER 3 /* After the target */ |
4857234e | 143 | #define WHERE_NOWHERE 4 /* Don't add to queue at all */ |
05b75f8d RK |
144 | /* add an entry to the queue. Return a pointer to the new entry. */ |
145 | ||
146 | void queue_remove(struct queue_entry *q, const char *who); | |
147 | /* remove an from the queue */ | |
148 | ||
149 | struct queue_entry *queue_find(const char *key); | |
150 | /* find a track in the queue by name or ID */ | |
151 | ||
152 | void queue_played(struct queue_entry *q); | |
153 | /* add @q@ to the played list */ | |
154 | ||
155 | int queue_move(struct queue_entry *q, int delta, const char *who); | |
156 | /* move element @q@ in the queue towards the front (@delta@ > 0) or towards the | |
157 | * back (@delta@ < 0). The return value is the leftover delta once we've hit | |
158 | * the end in whichever direction we were going. */ | |
159 | ||
160 | void queue_moveafter(struct queue_entry *target, | |
161 | int nqs, struct queue_entry **qs, const char *who); | |
162 | /* Move all the elements QS to just after TARGET, or to the head if | |
163 | * TARGET=0. */ | |
164 | ||
165 | void queue_fix_sofar(struct queue_entry *q); | |
166 | /* Fix up the sofar field for standalone players */ | |
167 | ||
168 | void schedule_init(ev_source *ev); | |
169 | const char *schedule_add(ev_source *ev, | |
170 | struct kvp *actiondata); | |
171 | int schedule_del(const char *id); | |
172 | struct kvp *schedule_get(const char *id); | |
173 | char **schedule_list(int *neventsp); | |
174 | ||
175 | extern struct queue_entry *playing; /* playing track or 0 */ | |
176 | extern int paused; /* non-0 if paused */ | |
177 | ||
178 | void play(ev_source *ev); | |
179 | /* try to play something, if playing is enabled and nothing is playing | |
180 | * already */ | |
181 | ||
9439cdab RK |
182 | /** @brief Return true if @p represents a true flag */ |
183 | int flag_enabled(const char *s); | |
184 | ||
05b75f8d RK |
185 | int playing_is_enabled(void); |
186 | /* return true iff playing is enabled */ | |
187 | ||
188 | void enable_playing(const char *who, ev_source *ev); | |
189 | /* enable playing */ | |
190 | ||
9439cdab | 191 | void disable_playing(const char *who, ev_source *ev); |
05b75f8d RK |
192 | /* disable playing. */ |
193 | ||
194 | int random_is_enabled(void); | |
195 | /* return true iff random play is enabled */ | |
196 | ||
197 | void enable_random(const char *who, ev_source *ev); | |
198 | /* enable random play */ | |
199 | ||
9439cdab | 200 | void disable_random(const char *who, ev_source *ev); |
05b75f8d RK |
201 | /* disable random play */ |
202 | ||
203 | void scratch(const char *who, const char *id); | |
204 | /* scratch the playing track. @who@ identifies the scratcher. @id@ is | |
205 | * the ID or a null pointer. */ | |
206 | ||
207 | void quitting(ev_source *ev); | |
208 | /* called to terminate current track and shut down speaker process | |
209 | * when quitting */ | |
210 | ||
211 | void speaker_setup(ev_source *ev); | |
212 | /* set up the speaker subprocess */ | |
213 | ||
214 | void speaker_reload(void); | |
215 | /* Tell the speaker process to reload its configuration. */ | |
216 | ||
217 | int pause_playing(const char *who); | |
218 | /* Pause the current track. Return 0 on success, -1 on error. WHO | |
219 | * can be 0. */ | |
220 | ||
221 | void resume_playing(const char *who); | |
222 | /* Resume after a pause. WHO can be 0. */ | |
223 | ||
224 | int prepare(ev_source *ev, | |
225 | struct queue_entry *q); | |
226 | /* Prepare to play Q */ | |
227 | ||
228 | void abandon(ev_source *ev, | |
229 | struct queue_entry *q); | |
230 | /* Abandon a possibly-prepared track. */ | |
231 | ||
232 | void add_random_track(ev_source *ev); | |
233 | /* If random play is enabled then try to add a track to the queue. */ | |
234 | ||
235 | int server_start(ev_source *ev, int pf, | |
236 | size_t socklen, const struct sockaddr *sa, | |
de37b640 RK |
237 | const char *name, |
238 | int privileged); | |
05b75f8d RK |
239 | /* start listening. Return the fd. */ |
240 | ||
241 | int server_stop(ev_source *ev, int fd); | |
242 | /* Stop listening on @fd@ */ | |
243 | ||
244 | extern int volume_left, volume_right; /* last known volume */ | |
245 | ||
246 | extern int wideopen; /* blindly accept all logins */ | |
247 | ||
248 | /* plugins */ | |
249 | ||
250 | struct plugin; | |
251 | ||
252 | typedef void *plugin_handle; | |
253 | typedef void function_t(void); | |
254 | ||
255 | const struct plugin *open_plugin(const char *name, | |
256 | unsigned flags); | |
257 | #define PLUGIN_FATAL 0x0001 /* fatal() on error */ | |
258 | /* Open a plugin. Returns a null pointer on error or a handle to it | |
259 | * on success. */ | |
260 | ||
261 | function_t *get_plugin_function(const struct plugin *handle, | |
262 | const char *symbol); | |
263 | const void *get_plugin_object(const struct plugin *handle, | |
264 | const char *symbol); | |
265 | /* Look up a function or an object in a plugin */ | |
266 | ||
267 | /* track length computation ***************************************************/ | |
268 | ||
269 | long tracklength(const char *plugin, const char *track, const char *path); | |
270 | ||
271 | /* collection interface *******************************************************/ | |
272 | ||
273 | void scan(const char *module, const char *root); | |
274 | /* write a list of path names below @root@ to standard output. */ | |
275 | ||
276 | int check(const char *module, const char *root, const char *path); | |
277 | /* Recheck a track, given its root and path name. Return 1 if it | |
278 | * exists, 0 if it does not exist and -1 if an error occurred. */ | |
279 | ||
280 | /* notification interface *****************************************************/ | |
281 | ||
282 | void notify_play(const char *track, | |
283 | const char *submitter); | |
284 | /* we're going to play @track@. It was submitted by @submitter@ | |
285 | * (might be a null pointer) */ | |
286 | ||
287 | void notify_scratch(const char *track, | |
288 | const char *submitter, | |
289 | const char *scratcher, | |
290 | int seconds); | |
291 | /* @scratcher@ scratched @track@ after @seconds@. It was submitted by | |
292 | * @submitter@ (might be a null pointer) */ | |
293 | ||
294 | void notify_not_scratched(const char *track, | |
295 | const char *submitter); | |
296 | /* @track@ (submitted by @submitter@, which might be a null pointer) | |
297 | * was not scratched. */ | |
298 | ||
299 | void notify_queue(const char *track, | |
300 | const char *submitter); | |
301 | /* @track@ was queued by @submitter@ */ | |
302 | ||
303 | void notify_queue_remove(const char *track, | |
304 | const char *remover); | |
305 | /* @track@ removed from the queue by @remover@ (never a null pointer) */ | |
306 | ||
307 | void notify_queue_move(const char *track, | |
308 | const char *mover); | |
309 | /* @track@ moved in the queue by @mover@ (never a null pointer) */ | |
310 | ||
311 | void notify_pause(const char *track, | |
312 | const char *pauser); | |
313 | /* TRACK was paused by PAUSER (might be a null pointer) */ | |
314 | ||
315 | void notify_resume(const char *track, | |
316 | const char *resumer); | |
317 | /* TRACK was resumed by PAUSER (might be a null pointer) */ | |
318 | ||
319 | /* track playing **************************************************************/ | |
320 | ||
321 | unsigned long play_get_type(const struct plugin *pl); | |
322 | /* Get the type word for this plugin */ | |
323 | ||
324 | void *play_prefork(const struct plugin *pl, | |
325 | const char *track); | |
326 | /* Call the prefork function for PL and return the user data */ | |
327 | ||
328 | void play_track(const struct plugin *pl, | |
329 | const char *const *parameters, | |
330 | int nparameters, | |
331 | const char *path, | |
332 | const char *track); | |
333 | /* play a track. Called inside a fork. */ | |
334 | ||
335 | void play_cleanup(const struct plugin *pl, void *data); | |
336 | /* Call the cleanup function for PL if necessary */ | |
337 | ||
338 | int play_pause(const struct plugin *pl, long *playedp, void *data); | |
339 | /* Pause track. */ | |
340 | ||
341 | void play_resume(const struct plugin *pl, void *data); | |
342 | /* Resume track. */ | |
343 | ||
5bac5b78 RK |
344 | /* background process support *************************************************/ |
345 | ||
346 | /** @brief Child process parameters */ | |
347 | struct pbgc_params { | |
348 | /** @brief Length of player command */ | |
349 | int argc; | |
350 | /** @brief Player command */ | |
351 | const char **argv; | |
5bac5b78 RK |
352 | /** @brief Raw track name */ |
353 | const char *rawpath; | |
354 | }; | |
355 | ||
356 | /** @brief Callback to play or prepare a track | |
357 | * @param q Track to play or decode | |
358 | * @param bgdata User data pointer | |
359 | * @return Exit code | |
360 | */ | |
361 | typedef int play_background_child_fn(struct queue_entry *q, | |
362 | const struct pbgc_params *params, | |
363 | void *bgdata); | |
364 | ||
365 | int play_background(ev_source *ev, | |
366 | const struct stringlist *player, | |
367 | struct queue_entry *q, | |
368 | play_background_child_fn *child, | |
369 | void *bgdata); | |
370 | ||
371 | /* Return values from start(), prepare() and play_background() */ | |
372 | ||
373 | #define START_OK 0 /**< @brief Succeeded. */ | |
374 | #define START_HARDFAIL 1 /**< @brief Track is broken. */ | |
375 | #define START_SOFTFAIL 2 /**< @brief Track OK, system (temporarily?) broken */ | |
376 | ||
18f94073 RK |
377 | void periodic_mount_check(ev_source *ev_); |
378 | ||
8138da17 RK |
379 | /** @brief How often to check for new (or old) filesystems */ |
380 | # define MOUNT_CHECK_INTERVAL 5 /* seconds */ | |
18f94073 | 381 | |
05b75f8d RK |
382 | #endif /* DISORDER_SERVER_H */ |
383 | ||
384 | /* | |
385 | Local Variables: | |
386 | c-basic-offset:2 | |
387 | comment-column:40 | |
388 | fill-column:79 | |
389 | indent-tabs-mode:nil | |
390 | End: | |
391 | */ |