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