Merge branch 'maint'
[paraslash.git] / afs.c
1 /*
2 * Copyright (C) 2007 Andre Noll <maan@tuebingen.mpg.de>
3 *
4 * Licensed under the GPL v2. For licencing details see COPYING.
5 */
6
7 /** \file afs.c Paraslash's audio file selector. */
8
9 #include <netinet/in.h>
10 #include <sys/socket.h>
11 #include <regex.h>
12 #include <signal.h>
13 #include <fnmatch.h>
14 #include <osl.h>
15 #include <arpa/inet.h>
16 #include <sys/un.h>
17 #include <netdb.h>
18
19 #include "server.cmdline.h"
20 #include "para.h"
21 #include "error.h"
22 #include "crypt.h"
23 #include "string.h"
24 #include "afh.h"
25 #include "afs.h"
26 #include "server.h"
27 #include "net.h"
28 #include "ipc.h"
29 #include "list.h"
30 #include "sched.h"
31 #include "fd.h"
32 #include "signal.h"
33 #include "mood.h"
34 #include "sideband.h"
35 #include "command.h"
36
37 /** The osl tables used by afs. \sa blob.c. */
38 enum afs_table_num {
39 /** Contains audio file information. See aft.c. */
40 TBLNUM_AUDIO_FILES,
41 /** The table for the paraslash attributes. See attribute.c. */
42 TBLNUM_ATTRIBUTES,
43 /**
44 * Paraslash's scoring system is based on Gaussian normal
45 * distributions, and the relevant data is stored in the rbtrees of an
46 * osl table containing only volatile columns. See score.c for
47 * details.
48 */
49 TBLNUM_SCORES,
50 /**
51 * A standard blob table containing the mood definitions. For details
52 * see mood.c.
53 */
54 TBLNUM_MOODS,
55 /** A blob table containing lyrics on a per-song basis. */
56 TBLNUM_LYRICS,
57 /** Another blob table for images (for example album cover art). */
58 TBLNUM_IMAGES,
59 /** Yet another blob table for storing standard playlists. */
60 TBLNUM_PLAYLIST,
61 /** How many tables are in use? */
62 NUM_AFS_TABLES
63 };
64
65 static struct afs_table afs_tables[NUM_AFS_TABLES] = {
66 [TBLNUM_AUDIO_FILES] = {.init = aft_init, .name = "audio_files"},
67 [TBLNUM_ATTRIBUTES] = {.init = attribute_init, .name = "attributes"},
68 [TBLNUM_SCORES] = {.init = score_init, .name = "scores"},
69 [TBLNUM_MOODS] = {.init = moods_init, .name = "moods"},
70 [TBLNUM_LYRICS] = {.init = lyrics_init, .name = "lyrics"},
71 [TBLNUM_IMAGES] = {.init = images_init, .name = "images"},
72 [TBLNUM_PLAYLIST] = {.init = playlists_init, .name = "playlists"},
73 };
74
75 struct command_task {
76 /** The file descriptor for the local socket. */
77 int fd;
78 /**
79 * Value sent by the command handlers to identify themselves as
80 * children of the running para_server.
81 */
82 uint32_t cookie;
83 /** The associated task structure. */
84 struct task *task;
85 };
86
87 extern int mmd_mutex;
88 extern struct misc_meta_data *mmd;
89
90 static int server_socket;
91 static struct command_task command_task_struct;
92 static struct signal_task *signal_task;
93
94 static enum play_mode current_play_mode;
95 static char *current_mop; /* mode or playlist specifier. NULL means dummy mood */
96
97 /**
98 * A random number used to "authenticate" the connection.
99 *
100 * para_server picks this number by random before forking the afs process. The
101 * command handlers write this number together with the id of the shared memory
102 * area containing the query. This way, a malicious local user has to know this
103 * number to be able to cause the afs process to crash by sending fake queries.
104 */
105 extern uint32_t afs_socket_cookie;
106
107 /**
108 * Struct to let command handlers execute a callback in afs context.
109 *
110 * Commands that need to change the state of afs can't change the relevant data
111 * structures directly because commands are executed in a child process, i.e.
112 * they get their own virtual address space.
113 *
114 * This structure is used by \p send_callback_request() (executed from handler
115 * context) in order to let the afs process call the specified function. An
116 * instance of that structure is written to a shared memory area together with
117 * the arguments to the callback function. The identifier of the shared memory
118 * area is written to the command socket.
119 *
120 * The afs process accepts connections on the command socket and reads the
121 * shared memory id, attaches the corresponding area, calls the given handler to
122 * perform the desired action and to optionally compute a result.
123 *
124 * The result and a \p callback_result structure is then written to another
125 * shared memory area. The identifier for that area is written to the handler's
126 * command socket, so that the handler process can read the id, attach the
127 * shared memory area and use the result.
128 *
129 * \sa struct callback_result.
130 */
131 struct callback_query {
132 /** The function to be called. */
133 callback_function *handler;
134 /** The number of bytes of the query */
135 size_t query_size;
136 };
137
138 /**
139 * Structure embedded in the result of a callback.
140 *
141 * If the callback produced a result, an instance of that structure is embedded
142 * into the shared memory area holding the result, mainly to let the command
143 * handler know the size of the result.
144 *
145 * \sa struct callback_query.
146 */
147 struct callback_result {
148 /** The number of bytes of the result. */
149 size_t result_size;
150 /** The band designator (loglevel for the result). */
151 uint8_t band;
152 };
153
154 static int dispatch_result(int result_shmid, callback_result_handler *handler,
155 void *private_result_data)
156 {
157 struct osl_object result;
158 void *result_shm;
159 /* must attach r/w as result.data might get encrypted in-place. */
160 int ret2, ret = shm_attach(result_shmid, ATTACH_RW, &result_shm);
161 struct callback_result *cr = result_shm;
162
163 if (ret < 0) {
164 PARA_ERROR_LOG("attach failed: %s\n", para_strerror(-ret));
165 return ret;
166 }
167 result.size = cr->result_size;
168 result.data = result_shm + sizeof(*cr);
169 if (result.size) {
170 assert(handler);
171 ret = handler(&result, cr->band, private_result_data);
172 if (ret < 0)
173 PARA_NOTICE_LOG("result handler error: %s\n",
174 para_strerror(-ret));
175 }
176 ret2 = shm_detach(result_shm);
177 if (ret2 < 0) {
178 PARA_ERROR_LOG("detach failed: %s\n", para_strerror(-ret2));
179 if (ret >= 0)
180 ret = ret2;
181 }
182 return ret;
183 }
184
185 /**
186 * Ask the afs process to call a given function.
187 *
188 * \param f The function to be called.
189 * \param query Pointer to arbitrary data for the callback.
190 * \param result_handler Called for each shm area sent by the callback.
191 * \param private_result_data Passed verbatim to \a result_handler.
192 *
193 * This function creates a socket for communication with the afs process and a
194 * shared memory area (sma) to which the buffer pointed to by \a query is
195 * copied. It then notifies the afs process that the callback function \a f
196 * should be executed by sending the shared memory identifier (shmid) to the
197 * socket.
198 *
199 * If the callback produces a result, it sends any number of shared memory
200 * identifiers back via the socket. For each such identifier received, \a
201 * result_handler is called. The contents of the sma identified by the received
202 * shmid are passed to that function as an osl object. The private_result_data
203 * pointer is passed as the second argument to \a result_handler.
204 *
205 * \return Number of shared memory areas dispatched on success, negative on errors.
206 *
207 * \sa send_option_arg_callback_request(), send_standard_callback_request().
208 */
209 int send_callback_request(callback_function *f, struct osl_object *query,
210 callback_result_handler *result_handler,
211 void *private_result_data)
212 {
213 struct callback_query *cq;
214 int ret, fd = -1, query_shmid, result_shmid;
215 void *query_shm;
216 char buf[sizeof(afs_socket_cookie) + sizeof(int)];
217 size_t query_shm_size = sizeof(*cq);
218 int dispatch_error = 0, num_dispatched = 0;
219
220 if (query)
221 query_shm_size += query->size;
222 ret = shm_new(query_shm_size);
223 if (ret < 0)
224 return ret;
225 query_shmid = ret;
226 ret = shm_attach(query_shmid, ATTACH_RW, &query_shm);
227 if (ret < 0)
228 goto out;
229 cq = query_shm;
230 cq->handler = f;
231 cq->query_size = query_shm_size - sizeof(*cq);
232
233 if (query)
234 memcpy(query_shm + sizeof(*cq), query->data, query->size);
235 ret = shm_detach(query_shm);
236 if (ret < 0)
237 goto out;
238
239 *(uint32_t *)buf = afs_socket_cookie;
240 *(int *)(buf + sizeof(afs_socket_cookie)) = query_shmid;
241
242 ret = connect_local_socket(conf.afs_socket_arg);
243 if (ret < 0)
244 goto out;
245 fd = ret;
246 ret = write_all(fd, buf, sizeof(buf));
247 if (ret < 0)
248 goto out;
249 /*
250 * Read all shmids from afs.
251 *
252 * Even if the dispatcher returns an error we _must_ continue to read
253 * shmids from fd so that we can destroy all shared memory areas that
254 * have been created for us by the afs process.
255 */
256 for (;;) {
257 ret = recv_bin_buffer(fd, buf, sizeof(int));
258 if (ret <= 0)
259 goto out;
260 assert(ret == sizeof(int));
261 ret = *(int *) buf;
262 assert(ret > 0);
263 result_shmid = ret;
264 if (!dispatch_error) {
265 ret = dispatch_result(result_shmid, result_handler,
266 private_result_data);
267 if (ret < 0)
268 dispatch_error = 1;
269 }
270 ret = shm_destroy(result_shmid);
271 if (ret < 0)
272 PARA_CRIT_LOG("destroy result failed: %s\n",
273 para_strerror(-ret));
274 num_dispatched++;
275 }
276 out:
277 if (shm_destroy(query_shmid) < 0)
278 PARA_CRIT_LOG("shm destroy error\n");
279 if (fd >= 0)
280 close(fd);
281 // PARA_DEBUG_LOG("callback_ret: %d\n", ret);
282 return ret < 0? ret : num_dispatched;
283 }
284
285 /**
286 * Send a callback request passing an options structure and an argument vector.
287 *
288 * \param options pointer to an arbitrary data structure.
289 * \param argc Argument count.
290 * \param argv Standard argument vector.
291 * \param f The callback function.
292 * \param result_handler See \ref send_callback_request.
293 * \param private_result_data See \ref send_callback_request.
294 *
295 * Some command handlers pass command-specific options to a callback, together
296 * with a list of further arguments (often a list of audio files). This
297 * function allows to pass an arbitrary structure (given as an osl object) and
298 * a usual argument vector to the specified callback.
299 *
300 * \return The return value of the underlying call to \ref
301 * send_callback_request().
302 *
303 * \sa send_standard_callback_request(), send_callback_request().
304 */
305 int send_option_arg_callback_request(struct osl_object *options,
306 int argc, char * const * const argv, callback_function *f,
307 callback_result_handler *result_handler,
308 void *private_result_data)
309 {
310 char *p;
311 int i, ret;
312 struct osl_object query = {.size = options? options->size : 0};
313
314 for (i = 0; i < argc; i++)
315 query.size += strlen(argv[i]) + 1;
316 query.data = para_malloc(query.size);
317 p = query.data;
318 if (options) {
319 memcpy(query.data, options->data, options->size);
320 p += options->size;
321 }
322 for (i = 0; i < argc; i++) {
323 strcpy(p, argv[i]); /* OK */
324 p += strlen(argv[i]) + 1;
325 }
326 ret = send_callback_request(f, &query, result_handler,
327 private_result_data);
328 free(query.data);
329 return ret;
330 }
331
332 /**
333 * Send a callback request with an argument vector only.
334 *
335 * \param argc The same meaning as in send_option_arg_callback_request().
336 * \param argv The same meaning as in send_option_arg_callback_request().
337 * \param f The same meaning as in send_option_arg_callback_request().
338 * \param result_handler See \ref send_callback_request.
339 * \param private_result_data See \ref send_callback_request.
340 *
341 * This is similar to send_option_arg_callback_request(), but no options buffer
342 * is passed to the parent process.
343 *
344 * \return The return value of the underlying call to
345 * send_option_arg_callback_request().
346 */
347 int send_standard_callback_request(int argc, char * const * const argv,
348 callback_function *f, callback_result_handler *result_handler,
349 void *private_result_data)
350 {
351 return send_option_arg_callback_request(NULL, argc, argv, f, result_handler,
352 private_result_data);
353 }
354
355 static int action_if_pattern_matches(struct osl_row *row, void *data)
356 {
357 struct pattern_match_data *pmd = data;
358 struct osl_object name_obj;
359 const char *p, *name;
360 int ret = osl(osl_get_object(pmd->table, row, pmd->match_col_num, &name_obj));
361 const char *pattern_txt = (const char *)pmd->patterns.data;
362
363 if (ret < 0)
364 return ret;
365 name = (char *)name_obj.data;
366 if ((!name || !*name) && (pmd->pm_flags & PM_SKIP_EMPTY_NAME))
367 return 1;
368 if (!pmd->patterns.size && (pmd->pm_flags & PM_NO_PATTERN_MATCHES_EVERYTHING))
369 return pmd->action(pmd->table, row, name, pmd->data);
370 for (p = pattern_txt; p < pattern_txt + pmd->patterns.size;
371 p += strlen(p) + 1) {
372 ret = fnmatch(p, name, pmd->fnmatch_flags);
373 if (ret == FNM_NOMATCH)
374 continue;
375 if (ret)
376 return -E_FNMATCH;
377 ret = pmd->action(pmd->table, row, name, pmd->data);
378 if (ret >= 0)
379 pmd->num_matches++;
380 return ret;
381 }
382 return 1;
383 }
384
385 /**
386 * Execute the given function for each matching row.
387 *
388 * \param pmd Describes what to match and how.
389 *
390 * \return Standard.
391 */
392 int for_each_matching_row(struct pattern_match_data *pmd)
393 {
394 if (pmd->pm_flags & PM_REVERSE_LOOP)
395 return osl(osl_rbtree_loop_reverse(pmd->table, pmd->loop_col_num, pmd,
396 action_if_pattern_matches));
397 return osl(osl_rbtree_loop(pmd->table, pmd->loop_col_num, pmd,
398 action_if_pattern_matches));
399 }
400
401 /**
402 * Compare two osl objects of string type.
403 *
404 * \param obj1 Pointer to the first object.
405 * \param obj2 Pointer to the second object.
406 *
407 * In any case, only \p MIN(obj1->size, obj2->size) characters of each string
408 * are taken into account.
409 *
410 * \return It returns an integer less than, equal to, or greater than zero if
411 * \a obj1 is found, respectively, to be less than, to match, or be greater than
412 * obj2.
413 *
414 * \sa strcmp(3), strncmp(3), osl_compare_func.
415 */
416 int string_compare(const struct osl_object *obj1, const struct osl_object *obj2)
417 {
418 const char *str1 = (const char *)obj1->data;
419 const char *str2 = (const char *)obj2->data;
420 return strncmp(str1, str2, PARA_MIN(obj1->size, obj2->size));
421 }
422
423 static int pass_afd(int fd, char *buf, size_t size)
424 {
425 struct msghdr msg = {.msg_iov = NULL};
426 struct cmsghdr *cmsg;
427 char control[255];
428 int ret;
429 struct iovec iov;
430
431 iov.iov_base = buf;
432 iov.iov_len = size;
433
434 msg.msg_iov = &iov;
435 msg.msg_iovlen = 1;
436
437 msg.msg_control = control;
438 msg.msg_controllen = sizeof(control);
439
440 cmsg = CMSG_FIRSTHDR(&msg);
441 cmsg->cmsg_level = SOL_SOCKET;
442 cmsg->cmsg_type = SCM_RIGHTS;
443 cmsg->cmsg_len = CMSG_LEN(sizeof(int));
444 *(int *)CMSG_DATA(cmsg) = fd;
445
446 /* Sum of the length of all control messages in the buffer */
447 msg.msg_controllen = cmsg->cmsg_len;
448 PARA_DEBUG_LOG("passing %zu bytes and fd %d\n", size, fd);
449 ret = sendmsg(server_socket, &msg, 0);
450 if (ret < 0) {
451 ret = -ERRNO_TO_PARA_ERROR(errno);
452 return ret;
453 }
454 return 1;
455 }
456
457 /**
458 * Pass the fd of the next audio file to the server process.
459 *
460 * This stores all information for streaming the "best" audio file in a shared
461 * memory area. The id of that area and an open file descriptor for the next
462 * audio file are passed to the server process.
463 *
464 * \return Standard.
465 *
466 * \sa open_and_update_audio_file().
467 */
468 static int open_next_audio_file(void)
469 {
470 struct audio_file_data afd;
471 int ret, shmid;
472 char buf[8];
473
474 ret = open_and_update_audio_file(&afd);
475 if (ret < 0) {
476 PARA_ERROR_LOG("%s\n", para_strerror(-ret));
477 goto no_admissible_files;
478 }
479 shmid = ret;
480 if (!write_ok(server_socket)) {
481 ret = -E_AFS_SOCKET;
482 goto destroy;
483 }
484 *(uint32_t *)buf = NEXT_AUDIO_FILE;
485 *(uint32_t *)(buf + 4) = (uint32_t)shmid;
486 ret = pass_afd(afd.fd, buf, 8);
487 close(afd.fd);
488 if (ret >= 0)
489 return ret;
490 destroy:
491 shm_destroy(shmid);
492 return ret;
493 no_admissible_files:
494 *(uint32_t *)buf = NO_ADMISSIBLE_FILES;
495 *(uint32_t *)(buf + 4) = (uint32_t)0;
496 return write_all(server_socket, buf, 8);
497 }
498
499 /* Never fails if arg == NULL */
500 static int activate_mood_or_playlist(char *arg, int *num_admissible)
501 {
502 enum play_mode mode;
503 int ret;
504
505 if (!arg) {
506 ret = change_current_mood(NULL); /* always successful */
507 mode = PLAY_MODE_MOOD;
508 } else {
509 if (!strncmp(arg, "p/", 2)) {
510 ret = playlist_open(arg + 2);
511 mode = PLAY_MODE_PLAYLIST;
512 } else if (!strncmp(arg, "m/", 2)) {
513 ret = change_current_mood(arg + 2);
514 mode = PLAY_MODE_MOOD;
515 } else
516 return -E_AFS_SYNTAX;
517 if (ret < 0)
518 return ret;
519 }
520 if (num_admissible)
521 *num_admissible = ret;
522 current_play_mode = mode;
523 if (arg != current_mop) {
524 free(current_mop);
525 if (arg) {
526 current_mop = para_strdup(arg);
527 mutex_lock(mmd_mutex);
528 strncpy(mmd->afs_mode_string, arg,
529 sizeof(mmd->afs_mode_string));
530 mmd->afs_mode_string[sizeof(mmd->afs_mode_string) - 1] = '\0';
531 mutex_unlock(mmd_mutex);
532 } else {
533 mutex_lock(mmd_mutex);
534 strcpy(mmd->afs_mode_string, "dummy");
535 mutex_unlock(mmd_mutex);
536 current_mop = NULL;
537 }
538 }
539 return 1;
540 }
541
542 /**
543 * Result handler for sending data to the para_client process.
544 *
545 * \param result The data to be sent.
546 * \param band The band designator.
547 * \param private Pointer to the command context.
548 *
549 * \return The return value of the underlying call to \ref command.c::send_sb.
550 *
551 * \sa \ref callback_result_handler, \ref command.c::send_sb.
552 */
553 int afs_cb_result_handler(struct osl_object *result, uint8_t band,
554 void *private)
555 {
556 struct command_context *cc = private;
557
558 assert(cc);
559 if (!result->size)
560 return 1;
561 return send_sb(&cc->scc, result->data, result->size, band, true);
562 }
563
564 static void com_select_callback(int fd, const struct osl_object *query)
565 {
566 struct para_buffer pb = {
567 .max_size = shm_get_shmmax(),
568 .private_data = &(struct afs_max_size_handler_data) {
569 .fd = fd,
570 .band = SBD_OUTPUT
571 },
572 .max_size_handler = afs_max_size_handler,
573 };
574 char *arg = query->data;
575 int num_admissible, ret, ret2;
576
577 ret = clear_score_table();
578 if (ret < 0) {
579 ret2 = para_printf(&pb, "%s\n", para_strerror(-ret));
580 goto out;
581 }
582 if (current_play_mode == PLAY_MODE_MOOD)
583 close_current_mood();
584 else
585 playlist_close();
586 ret = activate_mood_or_playlist(arg, &num_admissible);
587 if (ret < 0) {
588 ret2 = para_printf(&pb, "%s\nswitching back to %s\n",
589 para_strerror(-ret), current_mop?
590 current_mop : "dummy");
591 ret = activate_mood_or_playlist(current_mop, &num_admissible);
592 if (ret < 0) {
593 if (ret2 >= 0)
594 ret2 = para_printf(&pb, "failed, switching to dummy\n");
595 activate_mood_or_playlist(NULL, &num_admissible);
596 }
597 } else
598 ret2 = para_printf(&pb, "activated %s (%d admissible files)\n",
599 current_mop? current_mop : "dummy mood",
600 num_admissible);
601 out:
602 if (ret2 >= 0 && pb.offset)
603 pass_buffer_as_shm(fd, SBD_OUTPUT, pb.buf, pb.offset);
604 free(pb.buf);
605 }
606
607 int com_select(struct command_context *cc)
608 {
609 struct osl_object query;
610
611 if (cc->argc != 2)
612 return -E_AFS_SYNTAX;
613 query.data = cc->argv[1];
614 query.size = strlen(cc->argv[1]) + 1;
615 return send_callback_request(com_select_callback, &query,
616 &afs_cb_result_handler, cc);
617 }
618
619 static void init_admissible_files(char *arg)
620 {
621 if (activate_mood_or_playlist(arg, NULL) < 0)
622 activate_mood_or_playlist(NULL, NULL); /* always successful */
623 }
624
625 static int setup_command_socket_or_die(void)
626 {
627 int ret, socket_fd;
628 char *socket_name = conf.afs_socket_arg;
629
630 unlink(socket_name);
631 ret = create_local_socket(socket_name, 0);
632 if (ret < 0) {
633 ret = create_local_socket(socket_name,
634 S_IRUSR | S_IWUSR | S_IRGRP | S_IWGRP | S_IWOTH);
635 if (ret < 0) {
636 PARA_EMERG_LOG("%s: %s\n", para_strerror(-ret),
637 socket_name);
638 exit(EXIT_FAILURE);
639 }
640 }
641 socket_fd = ret;
642 PARA_INFO_LOG("listening on socket %s (fd %d)\n", socket_name,
643 socket_fd);
644 return socket_fd;
645 }
646
647 static void close_afs_tables(void)
648 {
649 int i;
650 PARA_NOTICE_LOG("closing afs_tables\n");
651 for (i = 0; i < NUM_AFS_TABLES; i++)
652 afs_tables[i].close();
653 }
654
655 static char *database_dir;
656
657 static void get_database_dir(void)
658 {
659 if (!database_dir) {
660 if (conf.afs_database_dir_given)
661 database_dir = para_strdup(conf.afs_database_dir_arg);
662 else {
663 char *home = para_homedir();
664 database_dir = make_message(
665 "%s/.paraslash/afs_database-0.4", home);
666 free(home);
667 }
668 }
669 PARA_INFO_LOG("afs_database dir %s\n", database_dir);
670 }
671
672 static int make_database_dir(void)
673 {
674 int ret;
675
676 get_database_dir();
677 ret = para_mkdir(database_dir, 0777);
678 if (ret >= 0 || is_errno(-ret, EEXIST))
679 return 1;
680 return ret;
681 }
682
683 static int open_afs_tables(void)
684 {
685 int i, ret;
686
687 get_database_dir();
688 PARA_NOTICE_LOG("opening %u osl tables in %s\n", NUM_AFS_TABLES,
689 database_dir);
690 for (i = 0; i < NUM_AFS_TABLES; i++) {
691 ret = afs_tables[i].open(database_dir);
692 if (ret >= 0)
693 continue;
694 PARA_ERROR_LOG("%s init: %s\n", afs_tables[i].name,
695 para_strerror(-ret));
696 break;
697 }
698 if (ret >= 0)
699 return ret;
700 while (i)
701 afs_tables[--i].close();
702 return ret;
703 }
704
705 static int afs_signal_post_select(struct sched *s, __a_unused void *context)
706 {
707 int signum, ret;
708
709 if (getppid() == 1) {
710 PARA_EMERG_LOG("para_server died\n");
711 goto shutdown;
712 }
713 signum = para_next_signal(&s->rfds);
714 if (signum == 0)
715 return 0;
716 if (signum == SIGHUP) {
717 close_afs_tables();
718 parse_config_or_die(1);
719 ret = open_afs_tables();
720 if (ret < 0)
721 return ret;
722 init_admissible_files(current_mop);
723 return 0;
724 }
725 PARA_EMERG_LOG("terminating on signal %d\n", signum);
726 shutdown:
727 task_notify_all(s, E_AFS_SIGNAL);
728 return -E_AFS_SIGNAL;
729 }
730
731 static void register_signal_task(struct sched *s)
732 {
733 para_sigaction(SIGPIPE, SIG_IGN);
734 signal_task = signal_init_or_die();
735 para_install_sighandler(SIGINT);
736 para_install_sighandler(SIGTERM);
737 para_install_sighandler(SIGHUP);
738
739 signal_task->task = task_register(&(struct task_info) {
740 .name = "signal",
741 .pre_select = signal_pre_select,
742 .post_select = afs_signal_post_select,
743 .context = signal_task,
744
745 }, s);
746 }
747
748 static struct list_head afs_client_list;
749
750 /** Describes one connected afs client. */
751 struct afs_client {
752 /** Position in the afs client list. */
753 struct list_head node;
754 /** The socket file descriptor for this client. */
755 int fd;
756 /** The time the client connected. */
757 struct timeval connect_time;
758 };
759
760 static void command_pre_select(struct sched *s, void *context)
761 {
762 struct command_task *ct = context;
763 struct afs_client *client;
764
765 para_fd_set(server_socket, &s->rfds, &s->max_fileno);
766 para_fd_set(ct->fd, &s->rfds, &s->max_fileno);
767 list_for_each_entry(client, &afs_client_list, node)
768 para_fd_set(client->fd, &s->rfds, &s->max_fileno);
769 }
770
771 /**
772 * Send data as shared memory to a file descriptor.
773 *
774 * \param fd File descriptor to send the shmid to.
775 * \param band The band designator for this data.
776 * \param buf The buffer holding the data to be sent.
777 * \param size The size of \a buf.
778 *
779 * This function creates a shared memory area large enough to hold
780 * the content given by \a buf and \a size and sends the identifier
781 * of this area to the file descriptor \a fd.
782 *
783 * It is called by the AFS max_size handler as well as directly by the AFS
784 * command callbacks to send command output to the command handlers.
785 *
786 * \return Zero if \a buf is \p NULL or \a size is zero. Negative on errors,
787 * and positive on success.
788 */
789 int pass_buffer_as_shm(int fd, uint8_t band, const char *buf, size_t size)
790 {
791 int ret, shmid;
792 void *shm;
793 struct callback_result *cr;
794
795 if (!buf || !size)
796 return 0;
797 ret = shm_new(size + sizeof(*cr));
798 if (ret < 0)
799 return ret;
800 shmid = ret;
801 ret = shm_attach(shmid, ATTACH_RW, &shm);
802 if (ret < 0)
803 goto err;
804 cr = shm;
805 cr->result_size = size;
806 cr->band = band;
807 memcpy(shm + sizeof(*cr), buf, size);
808 ret = shm_detach(shm);
809 if (ret < 0)
810 goto err;
811 ret = write_all(fd, (char *)&shmid, sizeof(int));
812 if (ret >= 0)
813 return ret;
814 err:
815 if (shm_destroy(shmid) < 0)
816 PARA_ERROR_LOG("destroy result failed\n");
817 return ret;
818 }
819
820 /*
821 * On errors, negative value is written to fd.
822 * On success: If query produced a result, the result_shmid is written to fd.
823 * Otherwise, zero is written.
824 */
825 static int call_callback(int fd, int query_shmid)
826 {
827 void *query_shm;
828 struct callback_query *cq;
829 struct osl_object query;
830 int ret;
831
832 ret = shm_attach(query_shmid, ATTACH_RW, &query_shm);
833 if (ret < 0)
834 return ret;
835 cq = query_shm;
836 query.data = (char *)query_shm + sizeof(*cq);
837 query.size = cq->query_size;
838 cq->handler(fd, &query);
839 return shm_detach(query_shm);
840 }
841
842 static int execute_server_command(fd_set *rfds)
843 {
844 char buf[8];
845 size_t n;
846 int ret = read_nonblock(server_socket, buf, sizeof(buf) - 1, rfds, &n);
847
848 if (ret < 0 || n == 0)
849 return ret;
850 buf[n] = '\0';
851 if (strcmp(buf, "new"))
852 return -E_BAD_CMD;
853 return open_next_audio_file();
854 }
855
856 /* returns 0 if no data available, 1 else */
857 static int execute_afs_command(int fd, fd_set *rfds, uint32_t expected_cookie)
858 {
859 uint32_t cookie;
860 int query_shmid;
861 char buf[sizeof(cookie) + sizeof(query_shmid)];
862 size_t n;
863 int ret = read_nonblock(fd, buf, sizeof(buf), rfds, &n);
864
865 if (ret < 0)
866 goto err;
867 if (n == 0)
868 return 0;
869 if (n != sizeof(buf)) {
870 PARA_NOTICE_LOG("short read (%d bytes, expected %lu)\n",
871 ret, (long unsigned) sizeof(buf));
872 return 1;
873 }
874 cookie = *(uint32_t *)buf;
875 if (cookie != expected_cookie) {
876 PARA_NOTICE_LOG("received invalid cookie (got %u, expected %u)\n",
877 (unsigned)cookie, (unsigned)expected_cookie);
878 return 1;
879 }
880 query_shmid = *(int *)(buf + sizeof(cookie));
881 if (query_shmid < 0) {
882 PARA_WARNING_LOG("received invalid query shmid %d)\n",
883 query_shmid);
884 return 1;
885 }
886 ret = call_callback(fd, query_shmid);
887 if (ret >= 0)
888 return 1;
889 err:
890 PARA_NOTICE_LOG("%s\n", para_strerror(-ret));
891 return 1;
892 }
893
894 /** Shutdown connection if query has not arrived until this many seconds. */
895 #define AFS_CLIENT_TIMEOUT 3
896
897 static int command_post_select(struct sched *s, void *context)
898 {
899 struct command_task *ct = context;
900 struct sockaddr_un unix_addr;
901 struct afs_client *client, *tmp;
902 int fd, ret;
903
904 ret = task_get_notification(ct->task);
905 if (ret < 0)
906 return ret;
907 ret = execute_server_command(&s->rfds);
908 if (ret < 0) {
909 PARA_EMERG_LOG("%s\n", para_strerror(-ret));
910 task_notify_all(s, -ret);
911 return ret;
912 }
913 /* Check the list of connected clients. */
914 list_for_each_entry_safe(client, tmp, &afs_client_list, node) {
915 ret = execute_afs_command(client->fd, &s->rfds, ct->cookie);
916 if (ret == 0) { /* prevent bogus connection flooding */
917 struct timeval diff;
918 tv_diff(now, &client->connect_time, &diff);
919 if (diff.tv_sec < AFS_CLIENT_TIMEOUT)
920 continue;
921 PARA_WARNING_LOG("connection timeout\n");
922 }
923 close(client->fd);
924 list_del(&client->node);
925 free(client);
926 }
927 /* Accept connections on the local socket. */
928 ret = para_accept(ct->fd, &s->rfds, &unix_addr, sizeof(unix_addr), &fd);
929 if (ret < 0)
930 PARA_NOTICE_LOG("%s\n", para_strerror(-ret));
931 if (ret <= 0)
932 return 0;
933 ret = mark_fd_nonblocking(fd);
934 if (ret < 0) {
935 PARA_NOTICE_LOG("%s\n", para_strerror(-ret));
936 close(fd);
937 return 0;
938 }
939 client = para_malloc(sizeof(*client));
940 client->fd = fd;
941 client->connect_time = *now;
942 para_list_add(&client->node, &afs_client_list);
943 return 0;
944 }
945
946 static void register_command_task(uint32_t cookie, struct sched *s)
947 {
948 struct command_task *ct = &command_task_struct;
949 ct->fd = setup_command_socket_or_die();
950 ct->cookie = cookie;
951
952 ct->task = task_register(&(struct task_info) {
953 .name = "afs command",
954 .pre_select = command_pre_select,
955 .post_select = command_post_select,
956 .context = ct,
957 }, s);
958 }
959
960 /**
961 * Initialize the audio file selector process.
962 *
963 * \param cookie The value used for "authentication".
964 * \param socket_fd File descriptor used for communication with the server.
965 */
966 __noreturn void afs_init(uint32_t cookie, int socket_fd)
967 {
968 static struct sched s;
969 int i, ret;
970
971 register_signal_task(&s);
972 INIT_LIST_HEAD(&afs_client_list);
973 for (i = 0; i < NUM_AFS_TABLES; i++)
974 afs_tables[i].init(&afs_tables[i]);
975 ret = open_afs_tables();
976 if (ret < 0)
977 goto out;
978 server_socket = socket_fd;
979 ret = mark_fd_nonblocking(server_socket);
980 if (ret < 0)
981 goto out_close;
982 PARA_INFO_LOG("server_socket: %d, afs_socket_cookie: %u\n",
983 server_socket, (unsigned) cookie);
984 init_admissible_files(conf.afs_initial_mode_arg);
985 register_command_task(cookie, &s);
986 s.default_timeout.tv_sec = 0;
987 s.default_timeout.tv_usec = 999 * 1000;
988 ret = schedule(&s);
989 sched_shutdown(&s);
990 out_close:
991 close_afs_tables();
992 out:
993 if (ret < 0)
994 PARA_EMERG_LOG("%s\n", para_strerror(-ret));
995 exit(EXIT_FAILURE);
996 }
997
998 static void create_tables_callback(int fd, const struct osl_object *query)
999 {
1000 uint32_t table_mask = *(uint32_t *)query->data;
1001 int i, ret;
1002 struct para_buffer pb = {
1003 .max_size = shm_get_shmmax(),
1004 .private_data = &(struct afs_max_size_handler_data) {
1005 .fd = fd,
1006 .band = SBD_OUTPUT
1007 }
1008 };
1009
1010 close_afs_tables();
1011 for (i = 0; i < NUM_AFS_TABLES; i++) {
1012 struct afs_table *t = &afs_tables[i];
1013
1014 if (!(table_mask & (1 << i)))
1015 continue;
1016 if (!t->create)
1017 continue;
1018 ret = t->create(database_dir);
1019 if (ret < 0)
1020 goto out;
1021 para_printf(&pb, "successfully created %s table\n", t->name);
1022 }
1023 ret = open_afs_tables();
1024 out:
1025 if (ret < 0)
1026 para_printf(&pb, "%s\n", para_strerror(-ret));
1027 if (pb.buf)
1028 pass_buffer_as_shm(fd, SBD_OUTPUT, pb.buf, pb.offset);
1029 free(pb.buf);
1030 }
1031
1032 int com_init(struct command_context *cc)
1033 {
1034 int i, j, ret;
1035 uint32_t table_mask = (1 << (NUM_AFS_TABLES + 1)) - 1;
1036 struct osl_object query = {.data = &table_mask,
1037 .size = sizeof(table_mask)};
1038
1039 ret = make_database_dir();
1040 if (ret < 0)
1041 return ret;
1042 if (cc->argc != 1) {
1043 table_mask = 0;
1044 for (i = 1; i < cc->argc; i++) {
1045 for (j = 0; j < NUM_AFS_TABLES; j++) {
1046 struct afs_table *t = &afs_tables[j];
1047
1048 if (strcmp(cc->argv[i], t->name))
1049 continue;
1050 table_mask |= (1 << j);
1051 break;
1052 }
1053 if (j == NUM_AFS_TABLES)
1054 return -E_BAD_TABLE_NAME;
1055 }
1056 }
1057 ret = send_callback_request(create_tables_callback, &query,
1058 afs_cb_result_handler, cc);
1059 return ret;
1060 }
1061
1062 /**
1063 * Flags for the check command.
1064 *
1065 * \sa com_check().
1066 */
1067 enum com_check_flags {
1068 /** Check the audio file table. */
1069 CHECK_AFT = 1,
1070 /** Check the mood table. */
1071 CHECK_MOODS = 2,
1072 /** Check the playlist table. */
1073 CHECK_PLAYLISTS = 4
1074 };
1075
1076 int com_check(struct command_context *cc)
1077 {
1078 unsigned flags = 0;
1079 int i, ret;
1080
1081 for (i = 1; i < cc->argc; i++) {
1082 const char *arg = cc->argv[i];
1083 if (arg[0] != '-')
1084 break;
1085 if (!strcmp(arg, "--")) {
1086 i++;
1087 break;
1088 }
1089 if (!strcmp(arg, "-a")) {
1090 flags |= CHECK_AFT;
1091 continue;
1092 }
1093 if (!strcmp(arg, "-p")) {
1094 flags |= CHECK_PLAYLISTS;
1095 continue;
1096 }
1097 if (!strcmp(arg, "-m")) {
1098 flags |= CHECK_MOODS;
1099 continue;
1100 }
1101 return -E_AFS_SYNTAX;
1102 }
1103 if (i < cc->argc)
1104 return -E_AFS_SYNTAX;
1105 if (!flags)
1106 flags = ~0U;
1107 if (flags & CHECK_AFT) {
1108 ret = send_callback_request(aft_check_callback, NULL,
1109 afs_cb_result_handler, cc);
1110 if (ret < 0)
1111 return ret;
1112 }
1113 if (flags & CHECK_PLAYLISTS) {
1114 ret = send_callback_request(playlist_check_callback,
1115 NULL, afs_cb_result_handler, cc);
1116 if (ret < 0)
1117 return ret;
1118 }
1119 if (flags & CHECK_MOODS) {
1120 ret = send_callback_request(mood_check_callback, NULL,
1121 afs_cb_result_handler, cc);
1122 if (ret < 0)
1123 return ret;
1124 }
1125 return 1;
1126 }
1127
1128 /**
1129 * The afs event dispatcher.
1130 *
1131 * \param event Type of the event.
1132 * \param pb May be \p NULL.
1133 * \param data Type depends on \a event.
1134 *
1135 * This function calls the table handlers of all tables and passes \a pb and \a
1136 * data verbatim. It's up to the handlers to interpret the \a data pointer.
1137 */
1138 void afs_event(enum afs_events event, struct para_buffer *pb,
1139 void *data)
1140 {
1141 int i, ret;
1142
1143 for (i = 0; i < NUM_AFS_TABLES; i++) {
1144 struct afs_table *t = &afs_tables[i];
1145 if (!t->event_handler)
1146 continue;
1147 ret = t->event_handler(event, pb, data);
1148 if (ret < 0)
1149 PARA_CRIT_LOG("table %s, event %d: %s\n", t->name,
1150 event, para_strerror(-ret));
1151 }
1152 }
1153
1154 /**
1155 * Dummy event handler for the images table.
1156 *
1157 * \param event Unused.
1158 * \param pb Unused.
1159 * \param data Unused.
1160 *
1161 * \return The images table does not honor events, so this handler always
1162 * returns success.
1163 */
1164 __a_const int images_event_handler(__a_unused enum afs_events event,
1165 __a_unused struct para_buffer *pb, __a_unused void *data)
1166 {
1167 return 1;
1168 }
1169
1170 /**
1171 * Dummy event handler for the lyrics table.
1172 *
1173 * \param event Unused.
1174 * \param pb Unused.
1175 * \param data Unused.
1176 *
1177 * \return The lyrics table does not honor events, so this handler always
1178 * returns success.
1179 */
1180 __a_const int lyrics_event_handler(__a_unused enum afs_events event,
1181 __a_unused struct para_buffer *pb, __a_unused void *data)
1182 {
1183 return 1;
1184 }