audiod: Move get_play_time_slot_num() to audiod.c.
[paraslash.git] / audiod_command.c
1 /*
2 * Copyright (C) 2005 Andre Noll <maan@tuebingen.mpg.de>
3 *
4 * Licensed under the GPL v2. For licencing details see COPYING.
5 */
6
7 /** \file audiod_command.c Commands for para_audiod. */
8
9 #include <netinet/in.h>
10 #include <sys/socket.h>
11 #include <regex.h>
12 #include <sys/types.h>
13 #include <arpa/inet.h>
14 #include <sys/un.h>
15 #include <netdb.h>
16
17 #include "para.h"
18 #include "audiod.cmdline.h"
19 #include "list.h"
20 #include "sched.h"
21 #include "ggo.h"
22 #include "buffer_tree.h"
23 #include "filter.h"
24 #include "grab_client.h"
25 #include "error.h"
26 #include "audiod.h"
27 #include "net.h"
28 #include "daemon.h"
29 #include "string.h"
30 #include "write.h"
31 #include "fd.h"
32 #include "version.h"
33 #include "audiod.command_list.h"
34
35 extern struct sched sched;
36 extern char *stat_item_values[NUM_STAT_ITEMS];
37
38
39 static struct audiod_command audiod_cmds[] = {DEFINE_AUDIOD_CMD_ARRAY};
40
41 /** Iterate over the array of all audiod commands. */
42 #define FOR_EACH_COMMAND(c) for (c = 0; audiod_cmds[c].name; c++)
43
44 /** The maximal number of simultaneous connections. */
45 #define MAX_STAT_CLIENTS 50
46
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,
51 };
52
53 /**
54 * Describes a status client of para_audiod.
55 *
56 * There's one such structure per audiod client that sent the 'stat' command.
57 *
58 * A status client is identified by its file descriptor. para_audiod
59 * keeps a list of connected status clients.
60 */
61 struct stat_client {
62 /** The stat client's file descriptor. */
63 int fd;
64 /** Bitmask of those status items the client is interested in. */
65 uint64_t item_mask;
66 /** See \ref stat_client flags. s*/
67 unsigned flags;
68 /** Its entry in the list of stat clients. */
69 struct list_head node;
70 };
71
72 static INITIALIZED_LIST_HEAD(client_list);
73 static int num_clients;
74
75 /** The list of all status items used by para_{server,audiod,gui}. */
76 const char *status_item_list[] = {STATUS_ITEM_ARRAY};
77
78 static void dump_stat_client_list(void)
79 {
80 struct stat_client *sc;
81
82 list_for_each_entry(sc, &client_list, node)
83 PARA_INFO_LOG("stat client on fd %d\n", sc->fd);
84 }
85 /**
86 * Add a status client to the list.
87 *
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.
91 *
92 * Only those status items having the bit set in \a mask will be
93 * sent to the client.
94 *
95 * \return Positive value on success, or -E_TOO_MANY_CLIENTS if
96 * the number of connected clients exceeds #MAX_STAT_CLIENTS.
97 */
98 static int stat_client_add(int fd, uint64_t mask, int parser_friendly)
99 {
100 struct stat_client *new_client;
101
102 if (num_clients >= MAX_STAT_CLIENTS) {
103 PARA_ERROR_LOG("maximal number of stat clients (%d) exceeded\n",
104 MAX_STAT_CLIENTS);
105 return -E_TOO_MANY_CLIENTS;
106 }
107 PARA_INFO_LOG("adding client on fd %d\n", fd);
108 new_client = para_calloc(sizeof(struct stat_client));
109 new_client->fd = fd;
110 new_client->item_mask = mask;
111 if (parser_friendly)
112 new_client->flags = SCF_PARSER_FRIENDLY;
113 para_list_add(&new_client->node, &client_list);
114 dump_stat_client_list();
115 num_clients++;
116 return 1;
117 }
118
119 static void close_stat_client(struct stat_client *sc)
120 {
121 PARA_INFO_LOG("closing client fd %d\n", sc->fd);
122 close(sc->fd);
123 list_del(&sc->node);
124 free(sc);
125 num_clients--;
126 }
127
128 /**
129 * Empty the status clients list.
130 *
131 * This iterates over the list of connected status clients, closes each client
132 * file descriptor and frees the resources.
133 */
134 void close_stat_clients(void)
135 {
136 struct stat_client *sc, *tmp;
137
138 list_for_each_entry_safe(sc, tmp, &client_list, node)
139 close_stat_client(sc);
140 assert(num_clients == 0);
141 }
142
143 /**
144 * Write a message to all connected status clients.
145 *
146 * \param item_num The number of the status item of \a msg.
147 *
148 * On write errors, remove the status client from the client list and close its
149 * file descriptor.
150 */
151 void stat_client_write_item(int item_num)
152 {
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;
159
160 list_for_each_entry_safe(sc, tmp, &client_list, node) {
161 int ret;
162
163 if (!((one << item_num) & sc->item_mask))
164 continue;
165 b = (sc->flags & SCF_PARSER_FRIENDLY)? &pfpb : &pb;
166 if (!b->buf)
167 (void)WRITE_STATUS_ITEM(b, item_num, "%s\n",
168 msg? msg : "");
169 ret = write(sc->fd, b->buf, b->offset);
170 if (ret == b->offset)
171 continue;
172 /* write error or short write */
173 close_stat_client(sc);
174 dump_stat_client_list();
175 }
176 free(pb.buf);
177 free(pfpb.buf);
178 }
179
180 /**
181 * Check if string is a known status item.
182 *
183 * \param item Buffer containing the text to check.
184 *
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.
187 */
188 static int stat_item_valid(const char *item)
189 {
190 int i;
191 if (!item || !*item) {
192 PARA_ERROR_LOG("%s\n", "no item");
193 return -E_UNKNOWN_STAT_ITEM;
194 }
195 FOR_EACH_STATUS_ITEM(i)
196 if (!strcmp(status_item_list[i], item))
197 return i;
198 PARA_ERROR_LOG("invalid stat item: %s\n", item);
199 return -E_UNKNOWN_STAT_ITEM;
200 }
201
202 static int client_write(int fd, const char *buf)
203 {
204 size_t len;
205
206 if (!buf)
207 return 0;
208 len = strlen(buf);
209 return write(fd, buf, len) != len? -E_CLIENT_WRITE: 1;
210 }
211
212 __malloc static char *audiod_status_string(void)
213 {
214 const char *status = (audiod_status == AUDIOD_ON)?
215 "on" : (audiod_status == AUDIOD_OFF)? "off": "sb";
216 return para_strdup(status);
217 }
218
219 __malloc static char *decoder_flags(void)
220 {
221 int i;
222 char flags[MAX_STREAM_SLOTS + 1];
223
224 FOR_EACH_SLOT(i) {
225 struct slot_info *s = &slot[i];
226 char flag = '0';
227 if (s->receiver_node)
228 flag += 1;
229 if (s->fns)
230 flag += 2;
231 if (s->wns)
232 flag += 4;
233 flags[i] = flag;
234 }
235 flags[MAX_STREAM_SLOTS] = '\0';
236 return para_strdup(flags);
237 }
238
239 static int dump_commands(int fd)
240 {
241 char *buf = para_strdup(""), *tmp = NULL;
242 int i;
243 ssize_t ret;
244
245 FOR_EACH_COMMAND(i) {
246 tmp = make_message("%s%s\t%s\n", buf, audiod_cmds[i].name,
247 audiod_cmds[i].description);
248 free(buf);
249 buf = tmp;
250 }
251 ret = client_write(fd, buf);
252 free(buf);
253 return ret;
254 }
255
256 /*
257 * command handlers don't close their fd on errors (ret < 0) so that
258 * its caller can send an error message. Otherwise (ret >= 0) it's up
259 * to each individual command to close the fd if necessary.
260 */
261
262 static int com_help(int fd, int argc, char **argv)
263 {
264 int i, ret;
265 char *buf;
266 const char *dflt = "No such command. Available commands:\n";
267
268 if (argc < 2) {
269 ret = dump_commands(fd);
270 goto out;
271 }
272 FOR_EACH_COMMAND(i) {
273 if (strcmp(audiod_cmds[i].name, argv[1]))
274 continue;
275 buf = make_message(
276 "NAME\n\t%s -- %s\n"
277 "SYNOPSIS\n\tpara_audioc %s\n"
278 "DESCRIPTION\n%s\n",
279 argv[1],
280 audiod_cmds[i].description,
281 audiod_cmds[i].usage,
282 audiod_cmds[i].help
283 );
284 ret = client_write(fd, buf);
285 free(buf);
286 goto out;
287 }
288 ret = client_write(fd, dflt);
289 if (ret > 0)
290 ret = dump_commands(fd);
291 out:
292 if (ret >= 0)
293 close(fd);
294 return ret;
295 }
296
297 static int com_tasks(int fd, __a_unused int argc, __a_unused char **argv)
298 {
299 char *tl = get_task_list(&sched);
300 int ret = 1;
301 if (tl)
302 ret = client_write(fd, tl);
303 free(tl);
304 if (ret > 0)
305 close(fd);
306 return ret;
307 }
308
309 static int com_stat(int fd, int argc, char **argv)
310 {
311 int i, ret, parser_friendly = 0;
312 uint64_t mask = 0;
313 const uint64_t one = 1;
314 struct para_buffer b = {.flags = 0};
315
316 ret = mark_fd_nonblocking(fd);
317 if (ret < 0)
318 return ret;
319 for (i = 1; i < argc; i++) {
320 const char *arg = argv[i];
321 if (arg[0] != '-')
322 break;
323 if (!strcmp(arg, "--")) {
324 i++;
325 break;
326 }
327 if (!strncmp(arg, "-p", 2)) {
328 parser_friendly = 1;
329 b.flags = PBF_SIZE_PREFIX;
330 }
331 }
332 if (i >= argc)
333 mask--; /* set all bits */
334 for (; i < argc; i++) {
335 ret = stat_item_valid(argv[i]);
336 if (ret < 0)
337 return ret;
338 mask |= (one << ret);
339 }
340 PARA_INFO_LOG("mask: 0x%llx\n", (long long unsigned)mask);
341 FOR_EACH_STATUS_ITEM(i) {
342 char *item = stat_item_values[i];
343 if (!((one << i) & mask))
344 continue;
345 (void)WRITE_STATUS_ITEM(&b, i, "%s\n", item? item : "");
346 }
347 ret = client_write(fd, b.buf);
348 if (ret >= 0)
349 ret = stat_client_add(fd, mask, parser_friendly);
350 free(b.buf);
351 return ret;
352 }
353
354 static int com_grab(int fd, int argc, char **argv)
355 {
356 return grab_client_new(fd, argc, argv, &sched);
357 }
358
359 static int com_term(int fd, __a_unused int argc, __a_unused char **argv)
360 {
361 close(fd);
362 return -E_AUDIOD_TERM;
363 }
364
365 static int com_on(int fd, __a_unused int argc, __a_unused char **argv)
366 {
367 audiod_status = AUDIOD_ON;
368 close(fd);
369 return 1;
370 }
371
372 static int com_off(int fd, __a_unused int argc, __a_unused char **argv)
373 {
374 audiod_status = AUDIOD_OFF;
375 close(fd);
376 return 1;
377 }
378
379 static int com_sb(int fd, __a_unused int argc, __a_unused char **argv)
380 {
381 audiod_status = AUDIOD_STANDBY;
382 close(fd);
383 return 1;
384 }
385
386 static int com_cycle(int fd, int argc, char **argv)
387 {
388 switch (audiod_status) {
389 case AUDIOD_ON:
390 return com_sb(fd, argc, argv);
391 break;
392 case AUDIOD_OFF:
393 return com_on(fd, argc, argv);
394 break;
395 case AUDIOD_STANDBY:
396 return com_off(fd, argc, argv);
397 break;
398 }
399 close(fd);
400 return 1;
401 }
402
403 static int com_version(int fd, int argc, char **argv)
404 {
405 int ret;
406 char *msg;
407
408 if (argc > 1 && strcmp(argv[1], "-v") == 0)
409 msg = make_message("%s", version_text("audiod"));
410 else
411 msg = make_message("%s\n", version_single_line("audiod"));
412 ret = client_write(fd, msg);
413 free(msg);
414 if (ret >= 0)
415 close(fd);
416 return ret;
417 }
418
419 static int check_perms(uid_t uid)
420 {
421 int i;
422
423 if (!conf.user_allow_given)
424 return 1;
425 for (i = 0; i < conf.user_allow_given; i++)
426 if (uid == conf.user_allow_arg[i])
427 return 1;
428 return -E_UCRED_PERM;
429 }
430
431 /**
432 * Handle arriving connections on the local socket.
433 *
434 * \param accept_fd The fd to accept connections on.
435 * \param rfds If \a accept_fd is not set in \a rfds, do nothing.
436 *
437 * This is called in each iteration of the select loop. If there is an incoming
438 * connection on \a accept_fd, this function reads the command sent by the peer,
439 * checks the connecting user's permissions by using unix socket credentials
440 * (if supported by the OS) and calls the corresponding command handler if
441 * permissions are OK.
442 *
443 * \return Positive on success, negative on errors, zero if there was no
444 * connection to accept.
445 *
446 * \sa para_accept(), recv_cred_buffer()
447 * */
448 int handle_connect(int accept_fd, fd_set *rfds)
449 {
450 int i, argc, ret, clifd;
451 char buf[MAXLINE], **argv = NULL;
452 struct sockaddr_un unix_addr;
453 uid_t uid;
454
455 ret = para_accept(accept_fd, rfds, &unix_addr, sizeof(struct sockaddr_un), &clifd);
456 if (ret <= 0)
457 return ret;
458 ret = recv_cred_buffer(clifd, buf, sizeof(buf) - 1);
459 if (ret < 0)
460 goto out;
461 uid = ret;
462 PARA_INFO_LOG("connection from user %i, buf: %s\n", ret, buf);
463 ret = check_perms(uid);
464 if (ret < 0)
465 goto out;
466 ret = create_argv(buf, "\n", &argv);
467 if (ret <= 0)
468 goto out;
469 argc = ret;
470 //PARA_INFO_LOG("argv[0]: %s, argc = %d\n", argv[0], argc);
471 FOR_EACH_COMMAND(i) {
472 if (strcmp(audiod_cmds[i].name, argv[0]))
473 continue;
474 ret = audiod_cmds[i].handler(clifd, argc, argv);
475 goto out;
476 }
477 ret = -E_INVALID_AUDIOD_CMD;
478 out:
479 free_argv(argv);
480 if (clifd > 0 && ret < 0 && ret != -E_CLIENT_WRITE) {
481 char *tmp = make_message("%s\n", para_strerror(-ret));
482 client_write(clifd, tmp);
483 free(tmp);
484 close(clifd);
485 }
486 return ret;
487 }
488
489 /**
490 * Send the current audiod status to all connected stat clients.
491 *
492 * \param force Whether to write unchanged items.
493 */
494 void audiod_status_dump(bool force)
495 {
496 char *old, *new;
497
498 old = stat_item_values[SI_PLAY_TIME];
499 new = get_time_string();
500 if (new) {
501 if (force || !old || strcmp(old, new)) {
502 free(old);
503 stat_item_values[SI_PLAY_TIME] = new;
504 stat_client_write_item(SI_PLAY_TIME);
505 } else
506 free(new);
507 }
508
509 new = daemon_get_uptime_str(now);
510 old = stat_item_values[SI_AUDIOD_UPTIME];
511 if (force || !old || strcmp(old, new)) {
512 free(old);
513 stat_item_values[SI_AUDIOD_UPTIME] = new;
514 stat_client_write_item(SI_AUDIOD_UPTIME);
515 } else
516 free(new);
517
518 old = stat_item_values[SI_AUDIOD_STATUS];
519 new = audiod_status_string();
520 if (force || !old || strcmp(old, new)) {
521 free(old);
522 stat_item_values[SI_AUDIOD_STATUS] = new;
523 stat_client_write_item(SI_AUDIOD_STATUS);
524 } else
525 free(new);
526
527 old = stat_item_values[SI_DECODER_FLAGS];
528 new = decoder_flags();
529 if (force || !old || strcmp(old, new)) {
530 free(old);
531 stat_item_values[SI_DECODER_FLAGS] = new;
532 stat_client_write_item(SI_DECODER_FLAGS);
533 } else
534 free(new);
535 }
536
537 /**
538 * Flush and send all status items.
539 *
540 * Send to each connected client the full status item list
541 * with empty values.
542 */
543 void clear_and_dump_items(void)
544 {
545 int i;
546
547 FOR_EACH_STATUS_ITEM(i) {
548 free(stat_item_values[i]);
549 stat_item_values[i] = NULL;
550 stat_client_write_item(i);
551 }
552 }