2 * Copyright (C) 2007-2014 Andre Noll <maan@tuebingen.mpg.de>
4 * Licensed under the GPL v2. For licencing details see COPYING.
7 /** \file afs.c Paraslash's audio file selector. */
9 #include <netinet/in.h>
10 #include <sys/socket.h>
15 #include <arpa/inet.h>
19 #include "server.cmdline.h"
37 /** The osl tables used by afs. \sa blob.c. */
39 /** Contains audio file information. See aft.c. */
41 /** The table for the paraslash attributes. See attribute.c. */
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
51 * A standard blob table containing the mood definitions. For details
55 /** A blob table containing lyrics on a per-song basis. */
57 /** Another blob table for images (for example album cover art). */
59 /** Yet another blob table for storing standard playlists. */
61 /** How many tables are in use? */
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"},
76 /** The file descriptor for the local socket. */
79 * Value sent by the command handlers to identify themselves as
80 * children of the running para_server.
83 /** The associated task structure. */
88 extern struct misc_meta_data
*mmd
;
90 static int server_socket
;
91 static struct command_task command_task_struct
;
92 static struct signal_task signal_task_struct
;
94 static enum play_mode current_play_mode
;
95 static char *current_mop
; /* mode or playlist specifier. NULL means dummy mood */
98 * A random number used to "authenticate" the connection.
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.
105 extern uint32_t afs_socket_cookie
;
108 * Struct to let command handlers execute a callback in afs context.
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.
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.
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.
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.
129 * \sa struct callback_result.
131 struct callback_query
{
132 /** The function to be called. */
133 callback_function
*handler
;
134 /** The number of bytes of the query */
139 * Structure embedded in the result of a callback.
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.
145 * \sa struct callback_query.
147 struct callback_result
{
148 /** The number of bytes of the result. */
150 /** The band designator (loglevel for the result). */
154 static int dispatch_result(int result_shmid
, callback_result_handler
*handler
,
155 void *private_result_data
)
157 struct osl_object result
;
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
;
164 PARA_ERROR_LOG("attach failed: %s\n", para_strerror(-ret
));
167 result
.size
= cr
->result_size
;
168 result
.data
= result_shm
+ sizeof(*cr
);
171 ret
= handler(&result
, cr
->band
, private_result_data
);
173 PARA_NOTICE_LOG("result handler error: %s\n",
174 para_strerror(-ret
));
176 ret2
= shm_detach(result_shm
);
178 PARA_ERROR_LOG("detach failed: %s\n", para_strerror(-ret2
));
186 * Ask the afs process to call a given function.
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.
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
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.
205 * \return Number of shared memory areas dispatched on success, negative on errors.
207 * \sa send_option_arg_callback_request(), send_standard_callback_request().
209 int send_callback_request(callback_function
*f
, struct osl_object
*query
,
210 callback_result_handler
*result_handler
,
211 void *private_result_data
)
213 struct callback_query
*cq
;
214 int ret
, fd
= -1, query_shmid
, result_shmid
;
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;
221 query_shm_size
+= query
->size
;
222 ret
= shm_new(query_shm_size
);
226 ret
= shm_attach(query_shmid
, ATTACH_RW
, &query_shm
);
231 cq
->query_size
= query_shm_size
- sizeof(*cq
);
234 memcpy(query_shm
+ sizeof(*cq
), query
->data
, query
->size
);
235 ret
= shm_detach(query_shm
);
239 *(uint32_t *) buf
= afs_socket_cookie
;
240 *(int *) (buf
+ sizeof(afs_socket_cookie
)) = query_shmid
;
242 ret
= connect_local_socket(conf
.afs_socket_arg
);
246 ret
= write_all(fd
, buf
, sizeof(buf
));
250 * Read all shmids from afs.
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.
257 ret
= recv_bin_buffer(fd
, buf
, sizeof(int));
260 assert(ret
== sizeof(int));
264 if (!dispatch_error
) {
265 ret
= dispatch_result(result_shmid
, result_handler
,
266 private_result_data
);
270 ret
= shm_destroy(result_shmid
);
272 PARA_CRIT_LOG("destroy result failed: %s\n",
273 para_strerror(-ret
));
277 if (shm_destroy(query_shmid
) < 0)
278 PARA_CRIT_LOG("shm destroy error\n");
281 // PARA_DEBUG_LOG("callback_ret: %d\n", ret);
282 return ret
< 0? ret
: num_dispatched
;
286 * Send a callback request passing an options structure and an argument vector.
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.
295 * Some commands have a couple of options that are parsed in child context for
296 * syntactic correctness and are stored in a special options structure for that
297 * command. This function allows to pass such a structure together with a list
298 * of further arguments (often a list of audio files) to the parent process.
300 * \return The return value of the underlying call to \ref
301 * send_callback_request().
303 * \sa send_standard_callback_request(), send_callback_request().
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
)
312 struct osl_object query
= {.size
= options
? options
->size
: 0};
314 for (i
= 0; i
< argc
; i
++)
315 query
.size
+= strlen(argv
[i
]) + 1;
316 query
.data
= para_malloc(query
.size
);
319 memcpy(query
.data
, options
->data
, options
->size
);
322 for (i
= 0; i
< argc
; i
++) {
323 strcpy(p
, argv
[i
]); /* OK */
324 p
+= strlen(argv
[i
]) + 1;
326 ret
= send_callback_request(f
, &query
, result_handler
,
327 private_result_data
);
333 * Send a callback request with an argument vector only.
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.
341 * This is similar to send_option_arg_callback_request(), but no options buffer
342 * is passed to the parent process.
344 * \return The return value of the underlying call to
345 * send_option_arg_callback_request().
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
)
351 return send_option_arg_callback_request(NULL
, argc
, argv
, f
, result_handler
,
352 private_result_data
);
355 static int action_if_pattern_matches(struct osl_row
*row
, void *data
)
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
;
365 name
= (char *)name_obj
.data
;
366 if ((!name
|| !*name
) && (pmd
->pm_flags
& PM_SKIP_EMPTY_NAME
))
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
)
377 ret
= pmd
->action(pmd
->table
, row
, name
, pmd
->data
);
386 * Execute the given function for each matching row.
388 * \param pmd Describes what to match and how.
392 int for_each_matching_row(struct pattern_match_data
*pmd
)
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
));
402 * Compare two osl objects of string type.
404 * \param obj1 Pointer to the first object.
405 * \param obj2 Pointer to the second object.
407 * In any case, only \p MIN(obj1->size, obj2->size) characters of each string
408 * are taken into account.
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
414 * \sa strcmp(3), strncmp(3), osl_compare_func.
416 int string_compare(const struct osl_object
*obj1
, const struct osl_object
*obj2
)
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
));
423 static int pass_afd(int fd
, char *buf
, size_t size
)
425 struct msghdr msg
= {.msg_iov
= NULL
};
426 struct cmsghdr
*cmsg
;
437 msg
.msg_control
= control
;
438 msg
.msg_controllen
= sizeof(control
);
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
;
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);
451 ret
= -ERRNO_TO_PARA_ERROR(errno
);
458 * Open the audio file with highest score.
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.
466 * \sa open_and_update_audio_file().
468 static int open_next_audio_file(void)
470 struct osl_row
*aft_row
;
471 struct audio_file_data afd
;
476 PARA_NOTICE_LOG("getting next audio file\n");
477 ret
= score_get_best(&aft_row
, &score
);
479 PARA_ERROR_LOG("%s\n", para_strerror(-ret
));
480 goto no_admissible_files
;
482 ret
= open_and_update_audio_file(aft_row
, score
, &afd
);
484 ret
= score_delete(aft_row
);
486 PARA_ERROR_LOG("%s\n", para_strerror(-ret
));
487 goto no_admissible_files
;
492 if (!write_ok(server_socket
)) {
496 *(uint32_t *)buf
= NEXT_AUDIO_FILE
;
497 *(uint32_t *)(buf
+ 4) = (uint32_t)shmid
;
498 ret
= pass_afd(afd
.fd
, buf
, 8);
506 *(uint32_t *)buf
= NO_ADMISSIBLE_FILES
;
507 *(uint32_t *)(buf
+ 4) = (uint32_t)0;
508 return write_all(server_socket
, buf
, 8);
511 /* Never fails if arg == NULL */
512 static int activate_mood_or_playlist(char *arg
, int *num_admissible
)
518 ret
= change_current_mood(NULL
); /* always successful */
519 mode
= PLAY_MODE_MOOD
;
521 if (!strncmp(arg
, "p/", 2)) {
522 ret
= playlist_open(arg
+ 2);
523 mode
= PLAY_MODE_PLAYLIST
;
524 } else if (!strncmp(arg
, "m/", 2)) {
525 ret
= change_current_mood(arg
+ 2);
526 mode
= PLAY_MODE_MOOD
;
528 return -E_AFS_SYNTAX
;
533 *num_admissible
= ret
;
534 current_play_mode
= mode
;
535 if (arg
!= current_mop
) {
538 current_mop
= para_strdup(arg
);
539 mutex_lock(mmd_mutex
);
540 strncpy(mmd
->afs_mode_string
, arg
,
541 sizeof(mmd
->afs_mode_string
));
542 mmd
->afs_mode_string
[sizeof(mmd
->afs_mode_string
) - 1] = '\0';
543 mutex_unlock(mmd_mutex
);
545 mutex_lock(mmd_mutex
);
546 strcpy(mmd
->afs_mode_string
, "dummy");
547 mutex_unlock(mmd_mutex
);
555 * Result handler for sending data to the para_client process.
557 * \param result The data to be sent.
558 * \param band The band designator.
559 * \param private Pointer to the command context.
561 * \return The return value of the underlying call to \ref command.c::send_sb.
563 * \sa \ref callback_result_handler, \ref command.c::send_sb.
565 int afs_cb_result_handler(struct osl_object
*result
, uint8_t band
,
568 struct command_context
*cc
= private;
573 return send_sb(&cc
->scc
, result
->data
, result
->size
, band
, true);
576 static void com_select_callback(int fd
, const struct osl_object
*query
)
578 struct para_buffer pb
= {
579 .max_size
= shm_get_shmmax(),
580 .private_data
= &(struct afs_max_size_handler_data
) {
584 .max_size_handler
= afs_max_size_handler
,
586 char *arg
= query
->data
;
587 int num_admissible
, ret
, ret2
;
589 ret
= clear_score_table();
591 ret2
= para_printf(&pb
, "%s\n", para_strerror(-ret
));
594 if (current_play_mode
== PLAY_MODE_MOOD
)
595 close_current_mood();
598 ret
= activate_mood_or_playlist(arg
, &num_admissible
);
600 ret2
= para_printf(&pb
, "%s\nswitching back to %s\n",
601 para_strerror(-ret
), current_mop
?
602 current_mop
: "dummy");
603 ret
= activate_mood_or_playlist(current_mop
, &num_admissible
);
606 ret2
= para_printf(&pb
, "failed, switching to dummy\n");
607 activate_mood_or_playlist(NULL
, &num_admissible
);
610 ret2
= para_printf(&pb
, "activated %s (%d admissible files)\n", current_mop
?
611 current_mop
: "dummy mood", num_admissible
);
613 if (ret2
>= 0 && pb
.offset
)
614 pass_buffer_as_shm(fd
, SBD_OUTPUT
, pb
.buf
, pb
.offset
);
618 int com_select(struct command_context
*cc
)
620 struct osl_object query
;
623 return -E_AFS_SYNTAX
;
624 query
.data
= cc
->argv
[1];
625 query
.size
= strlen(cc
->argv
[1]) + 1;
626 return send_callback_request(com_select_callback
, &query
,
627 &afs_cb_result_handler
, cc
);
630 static void init_admissible_files(char *arg
)
632 if (activate_mood_or_playlist(arg
, NULL
) < 0)
633 activate_mood_or_playlist(NULL
, NULL
); /* always successful */
636 static int setup_command_socket_or_die(void)
639 char *socket_name
= conf
.afs_socket_arg
;
640 struct sockaddr_un unix_addr
;
643 ret
= create_local_socket(socket_name
, &unix_addr
,
644 S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
| S_IWOTH
);
646 PARA_EMERG_LOG("%s: %s\n", para_strerror(-ret
), socket_name
);
650 if (listen(socket_fd
, 5) < 0) {
651 PARA_EMERG_LOG("can not listen on socket\n");
654 ret
= mark_fd_nonblocking(socket_fd
);
659 PARA_INFO_LOG("listening on socket %s (fd %d)\n", socket_name
,
664 static void close_afs_tables(void)
667 PARA_NOTICE_LOG("closing afs_tables\n");
668 for (i
= 0; i
< NUM_AFS_TABLES
; i
++)
669 afs_tables
[i
].close();
672 static char *database_dir
;
674 static void get_database_dir(void)
677 if (conf
.afs_database_dir_given
)
678 database_dir
= para_strdup(conf
.afs_database_dir_arg
);
680 char *home
= para_homedir();
681 database_dir
= make_message(
682 "%s/.paraslash/afs_database-0.4", home
);
686 PARA_INFO_LOG("afs_database dir %s\n", database_dir
);
689 static int make_database_dir(void)
694 ret
= para_mkdir(database_dir
, 0777);
695 if (ret
>= 0 || is_errno(-ret
, EEXIST
))
700 static int open_afs_tables(void)
705 PARA_NOTICE_LOG("opening %u osl tables in %s\n", NUM_AFS_TABLES
,
707 for (i
= 0; i
< NUM_AFS_TABLES
; i
++) {
708 ret
= afs_tables
[i
].open(database_dir
);
711 PARA_ERROR_LOG("%s init: %s\n", afs_tables
[i
].name
,
712 para_strerror(-ret
));
718 afs_tables
[--i
].close();
722 static void signal_pre_select(struct sched
*s
, void *context
)
724 struct signal_task
*st
= context
;
725 para_fd_set(st
->fd
, &s
->rfds
, &s
->max_fileno
);
728 static int afs_signal_post_select(struct sched
*s
, __a_unused
void *context
)
732 if (getppid() == 1) {
733 PARA_EMERG_LOG("para_server died\n");
736 signum
= para_next_signal(&s
->rfds
);
739 if (signum
== SIGHUP
) {
741 parse_config_or_die(1);
742 ret
= open_afs_tables();
745 init_admissible_files(current_mop
);
748 PARA_EMERG_LOG("terminating on signal %d\n", signum
);
750 task_notify_all(s
, E_AFS_SIGNAL
);
751 return -E_AFS_SIGNAL
;
754 static void register_signal_task(struct sched
*s
)
756 struct signal_task
*st
= &signal_task_struct
;
758 para_sigaction(SIGPIPE
, SIG_IGN
);
759 st
->fd
= para_signal_init();
760 PARA_INFO_LOG("signal pipe: fd %d\n", st
->fd
);
761 para_install_sighandler(SIGINT
);
762 para_install_sighandler(SIGTERM
);
763 para_install_sighandler(SIGHUP
);
765 st
->task
= task_register(&(struct task_info
) {
767 .pre_select
= signal_pre_select
,
768 .post_select
= afs_signal_post_select
,
774 static struct list_head afs_client_list
;
776 /** Describes on connected afs client. */
778 /** Position in the afs client list. */
779 struct list_head node
;
780 /** The socket file descriptor for this client. */
782 /** The time the client connected. */
783 struct timeval connect_time
;
786 static void command_pre_select(struct sched
*s
, void *context
)
788 struct command_task
*ct
= context
;
789 struct afs_client
*client
;
791 para_fd_set(server_socket
, &s
->rfds
, &s
->max_fileno
);
792 para_fd_set(ct
->fd
, &s
->rfds
, &s
->max_fileno
);
793 list_for_each_entry(client
, &afs_client_list
, node
)
794 para_fd_set(client
->fd
, &s
->rfds
, &s
->max_fileno
);
798 * Send data as shared memory to a file descriptor.
800 * \param fd File descriptor to send the shmid to.
801 * \param band The band designator for this data.
802 * \param buf The buffer holding the data to be sent.
803 * \param size The size of \a buf.
805 * This function creates a shared memory area large enough to hold
806 * the content given by \a buf and \a size and sends the identifier
807 * of this area to the file descriptor \a fd.
809 * It is called by the AFS max_size handler as well as directly by the AFS
810 * command callbacks to send command output to the command handlers.
812 * \return Zero if \a buf is \p NULL or \a size is zero. Negative on errors,
813 * and positive on success.
815 int pass_buffer_as_shm(int fd
, uint8_t band
, const char *buf
, size_t size
)
819 struct callback_result
*cr
;
823 ret
= shm_new(size
+ sizeof(*cr
));
827 ret
= shm_attach(shmid
, ATTACH_RW
, &shm
);
831 cr
->result_size
= size
;
833 memcpy(shm
+ sizeof(*cr
), buf
, size
);
834 ret
= shm_detach(shm
);
837 ret
= write_all(fd
, (char *)&shmid
, sizeof(int));
841 if (shm_destroy(shmid
) < 0)
842 PARA_ERROR_LOG("destroy result failed\n");
847 * On errors, negative value is written to fd.
848 * On success: If query produced a result, the result_shmid is written to fd.
849 * Otherwise, zero is written.
851 static int call_callback(int fd
, int query_shmid
)
854 struct callback_query
*cq
;
855 struct osl_object query
;
858 ret
= shm_attach(query_shmid
, ATTACH_RW
, &query_shm
);
862 query
.data
= (char *)query_shm
+ sizeof(*cq
);
863 query
.size
= cq
->query_size
;
864 cq
->handler(fd
, &query
);
865 return shm_detach(query_shm
);
868 static int execute_server_command(fd_set
*rfds
)
872 int ret
= read_nonblock(server_socket
, buf
, sizeof(buf
) - 1, rfds
, &n
);
874 if (ret
< 0 || n
== 0)
877 if (strcmp(buf
, "new"))
879 return open_next_audio_file();
882 /* returns 0 if no data available, 1 else */
883 static int execute_afs_command(int fd
, fd_set
*rfds
, uint32_t expected_cookie
)
887 char buf
[sizeof(cookie
) + sizeof(query_shmid
)];
889 int ret
= read_nonblock(fd
, buf
, sizeof(buf
), rfds
, &n
);
895 if (n
!= sizeof(buf
)) {
896 PARA_NOTICE_LOG("short read (%d bytes, expected %lu)\n",
897 ret
, (long unsigned) sizeof(buf
));
900 cookie
= *(uint32_t *)buf
;
901 if (cookie
!= expected_cookie
) {
902 PARA_NOTICE_LOG("received invalid cookie (got %u, expected %u)\n",
903 (unsigned)cookie
, (unsigned)expected_cookie
);
906 query_shmid
= *(int *)(buf
+ sizeof(cookie
));
907 if (query_shmid
< 0) {
908 PARA_WARNING_LOG("received invalid query shmid %d)\n",
912 ret
= call_callback(fd
, query_shmid
);
916 PARA_NOTICE_LOG("%s\n", para_strerror(-ret
));
920 /** Shutdown connection if query has not arrived until this many seconds. */
921 #define AFS_CLIENT_TIMEOUT 3
923 static int command_post_select(struct sched
*s
, void *context
)
925 struct command_task
*ct
= context
;
926 struct sockaddr_un unix_addr
;
927 struct afs_client
*client
, *tmp
;
930 ret
= task_get_notification(ct
->task
);
933 ret
= execute_server_command(&s
->rfds
);
935 PARA_EMERG_LOG("%s\n", para_strerror(-ret
));
936 task_notify_all(s
, -ret
);
939 /* Check the list of connected clients. */
940 list_for_each_entry_safe(client
, tmp
, &afs_client_list
, node
) {
941 ret
= execute_afs_command(client
->fd
, &s
->rfds
, ct
->cookie
);
942 if (ret
== 0) { /* prevent bogus connection flooding */
944 tv_diff(now
, &client
->connect_time
, &diff
);
945 if (diff
.tv_sec
< AFS_CLIENT_TIMEOUT
)
947 PARA_WARNING_LOG("connection timeout\n");
950 list_del(&client
->node
);
953 /* Accept connections on the local socket. */
954 ret
= para_accept(ct
->fd
, &s
->rfds
, &unix_addr
, sizeof(unix_addr
), &fd
);
956 PARA_NOTICE_LOG("%s\n", para_strerror(-ret
));
959 ret
= mark_fd_nonblocking(fd
);
961 PARA_NOTICE_LOG("%s\n", para_strerror(-ret
));
965 client
= para_malloc(sizeof(*client
));
967 client
->connect_time
= *now
;
968 para_list_add(&client
->node
, &afs_client_list
);
972 static void register_command_task(uint32_t cookie
, struct sched
*s
)
974 struct command_task
*ct
= &command_task_struct
;
975 ct
->fd
= setup_command_socket_or_die();
978 ct
->task
= task_register(&(struct task_info
) {
979 .name
= "afs command",
980 .pre_select
= command_pre_select
,
981 .post_select
= command_post_select
,
987 * Initialize the audio file selector process.
989 * \param cookie The value used for "authentication".
990 * \param socket_fd File descriptor used for communication with the server.
992 __noreturn
void afs_init(uint32_t cookie
, int socket_fd
)
994 static struct sched s
;
997 register_signal_task(&s
);
998 INIT_LIST_HEAD(&afs_client_list
);
999 for (i
= 0; i
< NUM_AFS_TABLES
; i
++)
1000 afs_tables
[i
].init(&afs_tables
[i
]);
1001 ret
= open_afs_tables();
1004 server_socket
= socket_fd
;
1005 ret
= mark_fd_nonblocking(server_socket
);
1008 PARA_INFO_LOG("server_socket: %d, afs_socket_cookie: %u\n",
1009 server_socket
, (unsigned) cookie
);
1010 init_admissible_files(conf
.afs_initial_mode_arg
);
1011 register_command_task(cookie
, &s
);
1012 s
.default_timeout
.tv_sec
= 0;
1013 s
.default_timeout
.tv_usec
= 999 * 1000;
1020 PARA_EMERG_LOG("%s\n", para_strerror(-ret
));
1024 static void create_tables_callback(int fd
, const struct osl_object
*query
)
1026 uint32_t table_mask
= *(uint32_t *)query
->data
;
1028 struct para_buffer pb
= {.buf
= NULL
};
1031 for (i
= 0; i
< NUM_AFS_TABLES
; i
++) {
1032 struct afs_table
*t
= &afs_tables
[i
];
1034 if (!(table_mask
& (1 << i
)))
1038 ret
= t
->create(database_dir
);
1041 para_printf(&pb
, "successfully created %s table\n", t
->name
);
1043 ret
= open_afs_tables();
1046 para_printf(&pb
, "%s\n", para_strerror(-ret
));
1048 pass_buffer_as_shm(fd
, SBD_OUTPUT
, pb
.buf
, pb
.offset
);
1052 int com_init(struct command_context
*cc
)
1055 uint32_t table_mask
= (1 << (NUM_AFS_TABLES
+ 1)) - 1;
1056 struct osl_object query
= {.data
= &table_mask
,
1057 .size
= sizeof(table_mask
)};
1059 ret
= make_database_dir();
1062 if (cc
->argc
!= 1) {
1064 for (i
= 1; i
< cc
->argc
; i
++) {
1065 for (j
= 0; j
< NUM_AFS_TABLES
; j
++) {
1066 struct afs_table
*t
= &afs_tables
[j
];
1068 if (strcmp(cc
->argv
[i
], t
->name
))
1070 table_mask
|= (1 << j
);
1073 if (j
== NUM_AFS_TABLES
)
1074 return -E_BAD_TABLE_NAME
;
1077 ret
= send_callback_request(create_tables_callback
, &query
,
1078 afs_cb_result_handler
, cc
);
1083 * Flags for the check command.
1087 enum com_check_flags
{
1088 /** Check the audio file table. */
1090 /** Check the mood table. */
1092 /** Check the playlist table. */
1096 int com_check(struct command_context
*cc
)
1101 for (i
= 1; i
< cc
->argc
; i
++) {
1102 const char *arg
= cc
->argv
[i
];
1105 if (!strcmp(arg
, "--")) {
1109 if (!strcmp(arg
, "-a")) {
1113 if (!strcmp(arg
, "-p")) {
1114 flags
|= CHECK_PLAYLISTS
;
1117 if (!strcmp(arg
, "-m")) {
1118 flags
|= CHECK_MOODS
;
1121 return -E_AFS_SYNTAX
;
1124 return -E_AFS_SYNTAX
;
1127 if (flags
& CHECK_AFT
) {
1128 ret
= send_callback_request(aft_check_callback
, NULL
,
1129 afs_cb_result_handler
, cc
);
1133 if (flags
& CHECK_PLAYLISTS
) {
1134 ret
= send_callback_request(playlist_check_callback
,
1135 NULL
, afs_cb_result_handler
, cc
);
1139 if (flags
& CHECK_MOODS
) {
1140 ret
= send_callback_request(mood_check_callback
, NULL
,
1141 afs_cb_result_handler
, cc
);
1149 * The afs event dispatcher.
1151 * \param event Type of the event.
1152 * \param pb May be \p NULL.
1153 * \param data Type depends on \a event.
1155 * This function calls the table handlers of all tables and passes \a pb and \a
1156 * data verbatim. It's up to the handlers to interpret the \a data pointer.
1158 void afs_event(enum afs_events event
, struct para_buffer
*pb
,
1163 for (i
= 0; i
< NUM_AFS_TABLES
; i
++) {
1164 struct afs_table
*t
= &afs_tables
[i
];
1165 if (!t
->event_handler
)
1167 ret
= t
->event_handler(event
, pb
, data
);
1169 PARA_CRIT_LOG("table %s, event %d: %s\n", t
->name
,
1170 event
, para_strerror(-ret
));
1175 * Dummy event handler for the images table.
1177 * \param event Unused.
1179 * \param data Unused.
1181 * \return The images table does not honor events, so this handler always
1184 __a_const
int images_event_handler(__a_unused
enum afs_events event
,
1185 __a_unused
struct para_buffer
*pb
, __a_unused
void *data
)
1191 * Dummy event handler for the lyrics table.
1193 * \param event Unused.
1195 * \param data Unused.
1197 * \return The lyrics table does not honor events, so this handler always
1200 __a_const
int lyrics_event_handler(__a_unused
enum afs_events event
,
1201 __a_unused
struct para_buffer
*pb
, __a_unused
void *data
)