2 * Copyright (C) 2005 Andre Noll <maan@tuebingen.mpg.de>
4 * Licensed under the GPL v2. For licencing details see COPYING.
7 /** \file audiod_command.c Commands for para_audiod. */
9 #include <netinet/in.h>
10 #include <sys/socket.h>
12 #include <sys/types.h>
13 #include <arpa/inet.h>
18 #include "audiod.cmdline.h"
22 #include "buffer_tree.h"
24 #include "grab_client.h"
33 #include "audiod.command_list.h"
35 extern struct sched sched;
36 extern char *stat_item_values[NUM_STAT_ITEMS];
39 static struct audiod_command audiod_cmds[] = {DEFINE_AUDIOD_CMD_ARRAY};
41 /** Iterate over the array of all audiod commands. */
42 #define FOR_EACH_COMMAND(c) for (c = 0; audiod_cmds[c].name; c++)
44 /** The maximal number of simultaneous connections. */
45 #define MAX_STAT_CLIENTS 50
47 /** Flags used for the stat command of para_audiod. */
48 enum stat_client_flags {
49 /** Enable parser-friendly output. */
50 SCF_PARSER_FRIENDLY = 1,
54 * Describes a status client of para_audiod.
56 * There's one such structure per audiod client that sent the 'stat' command.
58 * A status client is identified by its file descriptor. para_audiod
59 * keeps a list of connected status clients.
62 /** The stat client's file descriptor. */
64 /** Bitmask of those status items the client is interested in. */
66 /** See \ref stat_client flags. s*/
68 /** Its entry in the list of stat clients. */
69 struct list_head node;
72 static INITIALIZED_LIST_HEAD(client_list);
73 static int num_clients;
75 /** The list of all status items used by para_{server,audiod,gui}. */
76 const char *status_item_list[] = {STATUS_ITEM_ARRAY};
78 static void dump_stat_client_list(void)
80 struct stat_client *sc;
82 list_for_each_entry(sc, &client_list, node)
83 PARA_INFO_LOG("stat client on fd %d\n", sc->fd);
86 * Add a status client to the list.
88 * \param fd The file descriptor of the client.
89 * \param mask Bitfield of status items for this client.
90 * \param parser_friendly Enable parser-friendly output mode.
92 * Only those status items having the bit set in \a mask will be
95 * \return Positive value on success, or -E_TOO_MANY_CLIENTS if
96 * the number of connected clients exceeds #MAX_STAT_CLIENTS.
98 static int stat_client_add(int fd, uint64_t mask, int parser_friendly)
100 struct stat_client *new_client;
102 if (num_clients >= MAX_STAT_CLIENTS) {
103 PARA_ERROR_LOG("maximal number of stat clients (%d) exceeded\n",
105 return -E_TOO_MANY_CLIENTS;
107 PARA_INFO_LOG("adding client on fd %d\n", fd);
108 new_client = para_calloc(sizeof(struct stat_client));
110 new_client->item_mask = mask;
112 new_client->flags = SCF_PARSER_FRIENDLY;
113 para_list_add(&new_client->node, &client_list);
114 dump_stat_client_list();
119 static void close_stat_client(struct stat_client *sc)
121 PARA_INFO_LOG("closing client fd %d\n", sc->fd);
129 * Empty the status clients list.
131 * This iterates over the list of connected status clients, closes each client
132 * file descriptor and frees the resources.
134 void close_stat_clients(void)
136 struct stat_client *sc, *tmp;
138 list_for_each_entry_safe(sc, tmp, &client_list, node)
139 close_stat_client(sc);
140 assert(num_clients == 0);
144 * Write a message to all connected status clients.
146 * \param item_num The number of the status item of \a msg.
148 * On write errors, remove the status client from the client list and close its
151 void stat_client_write_item(int item_num)
153 struct stat_client *sc, *tmp;
154 struct para_buffer pb = {.flags = 0};
155 struct para_buffer pfpb = {.flags = PBF_SIZE_PREFIX};
156 const uint64_t one = 1;
157 char *msg = stat_item_values[item_num];
158 struct para_buffer *b;
160 list_for_each_entry_safe(sc, tmp, &client_list, node) {
163 if (!((one << item_num) & sc->item_mask))
165 b = (sc->flags & SCF_PARSER_FRIENDLY)? &pfpb : &pb;
167 (void)WRITE_STATUS_ITEM(b, item_num, "%s\n",
169 ret = write(sc->fd, b->buf, b->offset);
170 if (ret == b->offset)
172 /* write error or short write */
173 close_stat_client(sc);
174 dump_stat_client_list();
181 * Check if string is a known status item.
183 * \param item Buffer containing the text to check.
185 * \return If \a item is a valid status item, the number of that status item is
186 * returned. Otherwise, this function returns \p -E_UNKNOWN_STAT_ITEM.
188 static int stat_item_valid(const char *item)
191 if (!item || !*item) {
192 PARA_ERROR_LOG("%s\n", "no item");
193 return -E_UNKNOWN_STAT_ITEM;
195 FOR_EACH_STATUS_ITEM(i)
196 if (!strcmp(status_item_list[i], item))
198 PARA_ERROR_LOG("invalid stat item: %s\n", item);
199 return -E_UNKNOWN_STAT_ITEM;
202 static int client_write(int fd, const char *buf)
209 return write(fd, buf, len) != len? -E_CLIENT_WRITE: 1;
212 __malloc static char *audiod_status_string(void)
214 const char *status = (audiod_status == AUDIOD_ON)?
215 "on" : (audiod_status == AUDIOD_OFF)? "off": "sb";
216 return para_strdup(status);
219 static int dump_commands(int fd)
221 char *buf = para_strdup(""), *tmp = NULL;
225 FOR_EACH_COMMAND(i) {
226 tmp = make_message("%s%s\t%s\n", buf, audiod_cmds[i].name,
227 audiod_cmds[i].description);
231 ret = client_write(fd, buf);
237 * command handlers don't close their fd on errors (ret < 0) so that
238 * its caller can send an error message. Otherwise (ret >= 0) it's up
239 * to each individual command to close the fd if necessary.
242 static int com_help(int fd, int argc, char **argv)
246 const char *dflt = "No such command. Available commands:\n";
249 ret = dump_commands(fd);
252 FOR_EACH_COMMAND(i) {
253 if (strcmp(audiod_cmds[i].name, argv[1]))
257 "SYNOPSIS\n\tpara_audioc %s\n"
260 audiod_cmds[i].description,
261 audiod_cmds[i].usage,
264 ret = client_write(fd, buf);
268 ret = client_write(fd, dflt);
270 ret = dump_commands(fd);
277 static int com_tasks(int fd, __a_unused int argc, __a_unused char **argv)
279 char *tl = get_task_list(&sched);
282 ret = client_write(fd, tl);
289 static int com_stat(int fd, int argc, char **argv)
291 int i, ret, parser_friendly = 0;
293 const uint64_t one = 1;
294 struct para_buffer b = {.flags = 0};
296 ret = mark_fd_nonblocking(fd);
299 for (i = 1; i < argc; i++) {
300 const char *arg = argv[i];
303 if (!strcmp(arg, "--")) {
307 if (!strncmp(arg, "-p", 2)) {
309 b.flags = PBF_SIZE_PREFIX;
313 mask--; /* set all bits */
314 for (; i < argc; i++) {
315 ret = stat_item_valid(argv[i]);
318 mask |= (one << ret);
320 PARA_INFO_LOG("mask: 0x%llx\n", (long long unsigned)mask);
321 FOR_EACH_STATUS_ITEM(i) {
322 char *item = stat_item_values[i];
323 if (!((one << i) & mask))
325 (void)WRITE_STATUS_ITEM(&b, i, "%s\n", item? item : "");
327 ret = client_write(fd, b.buf);
329 ret = stat_client_add(fd, mask, parser_friendly);
334 static int com_grab(int fd, int argc, char **argv)
336 return grab_client_new(fd, argc, argv, &sched);
339 static int com_term(int fd, __a_unused int argc, __a_unused char **argv)
342 return -E_AUDIOD_TERM;
345 static int com_on(int fd, __a_unused int argc, __a_unused char **argv)
347 audiod_status = AUDIOD_ON;
352 static int com_off(int fd, __a_unused int argc, __a_unused char **argv)
354 audiod_status = AUDIOD_OFF;
359 static int com_sb(int fd, __a_unused int argc, __a_unused char **argv)
361 audiod_status = AUDIOD_STANDBY;
366 static int com_cycle(int fd, int argc, char **argv)
368 switch (audiod_status) {
370 return com_sb(fd, argc, argv);
373 return com_on(fd, argc, argv);
376 return com_off(fd, argc, argv);
383 static int com_version(int fd, int argc, char **argv)
388 if (argc > 1 && strcmp(argv[1], "-v") == 0)
389 msg = make_message("%s", version_text("audiod"));
391 msg = make_message("%s\n", version_single_line("audiod"));
392 ret = client_write(fd, msg);
399 static int check_perms(uid_t uid)
403 if (!conf.user_allow_given)
405 for (i = 0; i < conf.user_allow_given; i++)
406 if (uid == conf.user_allow_arg[i])
408 return -E_UCRED_PERM;
412 * Handle arriving connections on the local socket.
414 * \param accept_fd The fd to accept connections on.
415 * \param rfds If \a accept_fd is not set in \a rfds, do nothing.
417 * This is called in each iteration of the select loop. If there is an incoming
418 * connection on \a accept_fd, this function reads the command sent by the peer,
419 * checks the connecting user's permissions by using unix socket credentials
420 * (if supported by the OS) and calls the corresponding command handler if
421 * permissions are OK.
423 * \return Positive on success, negative on errors, zero if there was no
424 * connection to accept.
426 * \sa para_accept(), recv_cred_buffer()
428 int handle_connect(int accept_fd, fd_set *rfds)
430 int i, argc, ret, clifd;
431 char buf[MAXLINE], **argv = NULL;
432 struct sockaddr_un unix_addr;
435 ret = para_accept(accept_fd, rfds, &unix_addr, sizeof(struct sockaddr_un), &clifd);
438 ret = recv_cred_buffer(clifd, buf, sizeof(buf) - 1);
442 PARA_INFO_LOG("connection from user %i, buf: %s\n", ret, buf);
443 ret = check_perms(uid);
446 ret = create_argv(buf, "\n", &argv);
450 //PARA_INFO_LOG("argv[0]: %s, argc = %d\n", argv[0], argc);
451 FOR_EACH_COMMAND(i) {
452 if (strcmp(audiod_cmds[i].name, argv[0]))
454 ret = audiod_cmds[i].handler(clifd, argc, argv);
457 ret = -E_INVALID_AUDIOD_CMD;
460 if (clifd > 0 && ret < 0 && ret != -E_CLIENT_WRITE) {
461 char *tmp = make_message("%s\n", para_strerror(-ret));
462 client_write(clifd, tmp);
470 * Send the current audiod status to all connected stat clients.
472 * \param force Whether to write unchanged items.
474 void audiod_status_dump(bool force)
478 old = stat_item_values[SI_PLAY_TIME];
479 new = get_time_string();
481 if (force || !old || strcmp(old, new)) {
483 stat_item_values[SI_PLAY_TIME] = new;
484 stat_client_write_item(SI_PLAY_TIME);
489 new = daemon_get_uptime_str(now);
490 old = stat_item_values[SI_AUDIOD_UPTIME];
491 if (force || !old || strcmp(old, new)) {
493 stat_item_values[SI_AUDIOD_UPTIME] = new;
494 stat_client_write_item(SI_AUDIOD_UPTIME);
498 old = stat_item_values[SI_AUDIOD_STATUS];
499 new = audiod_status_string();
500 if (force || !old || strcmp(old, new)) {
502 stat_item_values[SI_AUDIOD_STATUS] = new;
503 stat_client_write_item(SI_AUDIOD_STATUS);
507 old = stat_item_values[SI_DECODER_FLAGS];
508 new = audiod_get_decoder_flags();
509 if (force || !old || strcmp(old, new)) {
511 stat_item_values[SI_DECODER_FLAGS] = new;
512 stat_client_write_item(SI_DECODER_FLAGS);
518 * Flush and send all status items.
520 * Send to each connected client the full status item list
523 void clear_and_dump_items(void)
527 FOR_EACH_STATUS_ITEM(i) {
528 free(stat_item_values[i]);
529 stat_item_values[i] = NULL;
530 stat_client_write_item(i);