| 1 | /* |
| 2 | * This file is part of DisOrder |
| 3 | * Copyright (C) 2008-2012 Richard Kettlewell |
| 4 | * |
| 5 | * This program is free software: you can redistribute it and/or modify |
| 6 | * it under the terms of the GNU General Public License as published by |
| 7 | * the Free Software Foundation, either version 3 of the License, or |
| 8 | * (at your option) any later version. |
| 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 | * |
| 15 | * You should have received a copy of the GNU General Public License |
| 16 | * along with this program. If not, see <http://www.gnu.org/licenses/>. |
| 17 | */ |
| 18 | /** @file server/disorder-server.h |
| 19 | * @brief Definitions for server and allied utilities |
| 20 | */ |
| 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> |
| 45 | #include <sys/resource.h> |
| 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" |
| 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" |
| 83 | #include "uaudio.h" |
| 84 | #include "unicode.h" |
| 85 | #include "user.h" |
| 86 | #include "vector.h" |
| 87 | #include "version.h" |
| 88 | #include "wstat.h" |
| 89 | |
| 90 | extern const struct uaudio *api; |
| 91 | |
| 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 | |
| 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 |
| 112 | |
| 113 | void dbparams_check(void); |
| 114 | |
| 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, |
| 137 | int where, const char *target, |
| 138 | enum track_origin origin); |
| 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 */ |
| 142 | #define WHERE_AFTER 3 /* After the target */ |
| 143 | #define WHERE_NOWHERE 4 /* Don't add to queue at all */ |
| 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 | |
| 182 | /** @brief Return true if @p represents a true flag */ |
| 183 | int flag_enabled(const char *s); |
| 184 | |
| 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 | |
| 191 | void disable_playing(const char *who, ev_source *ev); |
| 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 | |
| 200 | void disable_random(const char *who, ev_source *ev); |
| 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, |
| 237 | const char *name, |
| 238 | int privileged); |
| 239 | /* start listening. Return the fd. */ |
| 240 | |
| 241 | int server_stop(ev_source *ev, int fd); |
| 242 | /* Stop listening on @fd@ */ |
| 243 | |
| 244 | void rtp_request(const struct sockaddr_storage *sa); |
| 245 | void rtp_request_cancel(const struct sockaddr_storage *sa); |
| 246 | |
| 247 | extern int volume_left, volume_right; /* last known volume */ |
| 248 | |
| 249 | extern int wideopen; /* blindly accept all logins */ |
| 250 | |
| 251 | /* plugins */ |
| 252 | |
| 253 | struct plugin; |
| 254 | |
| 255 | typedef void *plugin_handle; |
| 256 | typedef void function_t(void); |
| 257 | |
| 258 | const struct plugin *open_plugin(const char *name, |
| 259 | unsigned flags); |
| 260 | #define PLUGIN_FATAL 0x0001 /* fatal() on error */ |
| 261 | /* Open a plugin. Returns a null pointer on error or a handle to it |
| 262 | * on success. */ |
| 263 | |
| 264 | function_t *get_plugin_function(const struct plugin *handle, |
| 265 | const char *symbol); |
| 266 | const void *get_plugin_object(const struct plugin *handle, |
| 267 | const char *symbol); |
| 268 | /* Look up a function or an object in a plugin */ |
| 269 | |
| 270 | /* track length computation ***************************************************/ |
| 271 | |
| 272 | long tracklength(const char *plugin, const char *track, const char *path); |
| 273 | |
| 274 | /* collection interface *******************************************************/ |
| 275 | |
| 276 | void scan(const char *module, const char *root); |
| 277 | /* write a list of path names below @root@ to standard output. */ |
| 278 | |
| 279 | int check(const char *module, const char *root, const char *path); |
| 280 | /* Recheck a track, given its root and path name. Return 1 if it |
| 281 | * exists, 0 if it does not exist and -1 if an error occurred. */ |
| 282 | |
| 283 | /* notification interface *****************************************************/ |
| 284 | |
| 285 | void notify_play(const char *track, |
| 286 | const char *submitter); |
| 287 | /* we're going to play @track@. It was submitted by @submitter@ |
| 288 | * (might be a null pointer) */ |
| 289 | |
| 290 | void notify_scratch(const char *track, |
| 291 | const char *submitter, |
| 292 | const char *scratcher, |
| 293 | int seconds); |
| 294 | /* @scratcher@ scratched @track@ after @seconds@. It was submitted by |
| 295 | * @submitter@ (might be a null pointer) */ |
| 296 | |
| 297 | void notify_not_scratched(const char *track, |
| 298 | const char *submitter); |
| 299 | /* @track@ (submitted by @submitter@, which might be a null pointer) |
| 300 | * was not scratched. */ |
| 301 | |
| 302 | void notify_queue(const char *track, |
| 303 | const char *submitter); |
| 304 | /* @track@ was queued by @submitter@ */ |
| 305 | |
| 306 | void notify_queue_remove(const char *track, |
| 307 | const char *remover); |
| 308 | /* @track@ removed from the queue by @remover@ (never a null pointer) */ |
| 309 | |
| 310 | void notify_queue_move(const char *track, |
| 311 | const char *mover); |
| 312 | /* @track@ moved in the queue by @mover@ (never a null pointer) */ |
| 313 | |
| 314 | void notify_pause(const char *track, |
| 315 | const char *pauser); |
| 316 | /* TRACK was paused by PAUSER (might be a null pointer) */ |
| 317 | |
| 318 | void notify_resume(const char *track, |
| 319 | const char *resumer); |
| 320 | /* TRACK was resumed by PAUSER (might be a null pointer) */ |
| 321 | |
| 322 | /* track playing **************************************************************/ |
| 323 | |
| 324 | unsigned long play_get_type(const struct plugin *pl); |
| 325 | /* Get the type word for this plugin */ |
| 326 | |
| 327 | void *play_prefork(const struct plugin *pl, |
| 328 | const char *track); |
| 329 | /* Call the prefork function for PL and return the user data */ |
| 330 | |
| 331 | void play_track(const struct plugin *pl, |
| 332 | const char *const *parameters, |
| 333 | int nparameters, |
| 334 | const char *path, |
| 335 | const char *track); |
| 336 | /* play a track. Called inside a fork. */ |
| 337 | |
| 338 | void play_cleanup(const struct plugin *pl, void *data); |
| 339 | /* Call the cleanup function for PL if necessary */ |
| 340 | |
| 341 | int play_pause(const struct plugin *pl, long *playedp, void *data); |
| 342 | /* Pause track. */ |
| 343 | |
| 344 | void play_resume(const struct plugin *pl, void *data); |
| 345 | /* Resume track. */ |
| 346 | |
| 347 | /* background process support *************************************************/ |
| 348 | |
| 349 | /** @brief Child process parameters */ |
| 350 | struct pbgc_params { |
| 351 | /** @brief Length of player command */ |
| 352 | int argc; |
| 353 | /** @brief Player command */ |
| 354 | const char **argv; |
| 355 | /** @brief Raw track name */ |
| 356 | const char *rawpath; |
| 357 | }; |
| 358 | |
| 359 | /** @brief Callback to play or prepare a track |
| 360 | * @param q Track to play or decode |
| 361 | * @param bgdata User data pointer |
| 362 | * @return Exit code |
| 363 | */ |
| 364 | typedef int play_background_child_fn(struct queue_entry *q, |
| 365 | const struct pbgc_params *params, |
| 366 | void *bgdata); |
| 367 | |
| 368 | int play_background(ev_source *ev, |
| 369 | const struct stringlist *player, |
| 370 | struct queue_entry *q, |
| 371 | play_background_child_fn *child, |
| 372 | void *bgdata); |
| 373 | |
| 374 | /* Return values from start(), prepare() and play_background() */ |
| 375 | |
| 376 | #define START_OK 0 /**< @brief Succeeded. */ |
| 377 | #define START_HARDFAIL 1 /**< @brief Track is broken. */ |
| 378 | #define START_SOFTFAIL 2 /**< @brief Track OK, system (temporarily?) broken */ |
| 379 | |
| 380 | void periodic_mount_check(ev_source *ev_); |
| 381 | |
| 382 | /** @brief How often to check for new (or old) filesystems */ |
| 383 | # define MOUNT_CHECK_INTERVAL 5 /* seconds */ |
| 384 | |
| 385 | #endif /* DISORDER_SERVER_H */ |
| 386 | |
| 387 | /* |
| 388 | Local Variables: |
| 389 | c-basic-offset:2 |
| 390 | comment-column:40 |
| 391 | fill-column:79 |
| 392 | indent-tabs-mode:nil |
| 393 | End: |
| 394 | */ |