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