Add btr support to the oggdec filter.
[paraslash.git] / audiod_command.c
1 /*
2 * Copyright (C) 2005-2009 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 <dirent.h>
12 #include <stdbool.h>
13
14 #include "para.h"
15 #include "audiod.cmdline.h"
16 #include "list.h"
17 #include "sched.h"
18 #include "ggo.h"
19 #include "buffer_tree.h"
20 #include "filter.h"
21 #include "grab_client.h"
22 #include "error.h"
23 #include "audiod.h"
24 #include "net.h"
25 #include "daemon.h"
26 #include "string.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 = -1;
196
197 FOR_EACH_SLOT(i) {
198 struct slot_info *s = &slot[i];
199 if (!s->wng)
200 continue;
201 if (oldest >= 0 && tv_diff(&s->wstime, &slot[oldest].wstime,
202 NULL) > 0)
203 continue;
204 oldest = i;
205 }
206 return oldest;
207 }
208
209 __malloc static char *decoder_flags(void)
210 {
211 int i;
212 char flags[MAX_STREAM_SLOTS + 1];
213
214 FOR_EACH_SLOT(i) {
215 struct slot_info *s = &slot[i];
216 char flag = '0';
217 if (s->receiver_node)
218 flag += 1;
219 if (s->fc)
220 flag += 2;
221 if (s->wng)
222 flag += 4;
223 flags[i] = flag;
224 }
225 flags[MAX_STREAM_SLOTS] = '\0';
226 return para_strdup(flags);
227 }
228
229 static int dump_commands(int fd)
230 {
231 char *buf = para_strdup(""), *tmp = NULL;
232 int i;
233 ssize_t ret;
234
235 FOR_EACH_COMMAND(i) {
236 tmp = make_message("%s%s\t%s\n", buf, audiod_cmds[i].name,
237 audiod_cmds[i].description);
238 free(buf);
239 buf = tmp;
240 }
241 ret = client_write(fd, buf);
242 free(buf);
243 return ret;
244 }
245
246 /*
247 * command handlers don't close their fd on errors (ret < 0) so that
248 * its caller can send an error message. Otherwise (ret >= 0) it's up
249 * to each individual command to close the fd if necessary.
250 */
251
252 int com_help(int fd, int argc, char **argv)
253 {
254 int i, ret;
255 char *buf;
256 const char *dflt = "No such command. Available commands:\n";
257
258 if (argc < 2) {
259 ret = dump_commands(fd);
260 goto out;
261 }
262 FOR_EACH_COMMAND(i) {
263 if (strcmp(audiod_cmds[i].name, argv[1]))
264 continue;
265 buf = make_message(
266 "NAME\n\t%s -- %s\n"
267 "SYNOPSIS\n\tpara_audioc %s\n"
268 "DESCRIPTION\n%s\n",
269 argv[1],
270 audiod_cmds[i].description,
271 audiod_cmds[i].usage,
272 audiod_cmds[i].help
273 );
274 ret = client_write(fd, buf);
275 free(buf);
276 goto out;
277 }
278 ret = client_write(fd, dflt);
279 if (ret > 0)
280 ret = dump_commands(fd);
281 out:
282 if (ret >= 0)
283 close(fd);
284 return ret;
285 }
286
287 int com_tasks(int fd, __a_unused int argc, __a_unused char **argv)
288 {
289 char *tl = get_task_list();
290 int ret = 1;
291 if (tl)
292 ret = client_write(fd, tl);
293 free(tl);
294 if (ret > 0)
295 close(fd);
296 return ret;
297 }
298
299 int com_kill(int fd, int argc, char **argv)
300 {
301 int i, ret = 1;
302 if (argc < 2)
303 return -E_AUDIOD_SYNTAX;
304 for (i = 1; i < argc; i++) {
305 ret = kill_task(argv[i]);
306 if (ret < 0)
307 break;
308 }
309 if (ret > 0)
310 close(fd);
311 return ret;
312 }
313
314 int com_stat(int fd, int argc, char **argv)
315 {
316 int i, ret, parser_friendly = 0;
317 uint64_t mask = 0;
318 const uint64_t one = 1;
319 struct para_buffer b = {.flags = 0};
320
321 for (i = 1; i < argc; i++) {
322 const char *arg = argv[i];
323 if (arg[0] != '-')
324 break;
325 if (!strcmp(arg, "--")) {
326 i++;
327 break;
328 }
329 if (!strncmp(arg, "-p", 2)) {
330 parser_friendly = 1;
331 b.flags = PBF_SIZE_PREFIX;
332 continue;
333 }
334 }
335 if (i >= argc)
336 mask--; /* set all bits */
337 for (; i < argc; i++) {
338 ret = stat_item_valid(argv[i]);
339 if (ret < 0)
340 return ret;
341 mask |= (one << ret);
342 }
343 PARA_INFO_LOG("mask: 0x%llx\n", (long long unsigned)mask);
344 FOR_EACH_STATUS_ITEM(i) {
345 char *item = stat_item_values[i];
346 if (!((one << i) & mask))
347 continue;
348 WRITE_STATUS_ITEM(&b, i, "%s\n", item? item : "");
349 }
350 ret = client_write(fd, b.buf);
351 if (ret >= 0)
352 ret = stat_client_add(fd, mask, parser_friendly);
353 free(b.buf);
354 return ret;
355 }
356
357 int com_grab(int fd, int argc, char **argv)
358 {
359 return grab_client_new(fd, argc, argv);
360 }
361
362 __noreturn int com_term(int fd, __a_unused int argc, __a_unused char **argv)
363 {
364 close(fd);
365 clean_exit(EXIT_SUCCESS, "terminating on user request");
366 }
367
368 int com_on(int fd, __a_unused int argc, __a_unused char **argv)
369 {
370 audiod_status = AUDIOD_ON;
371 close(fd);
372 return 1;
373 }
374
375 int com_off(int fd, __a_unused int argc, __a_unused char **argv)
376 {
377 audiod_status = AUDIOD_OFF;
378 close(fd);
379 return 1;
380 }
381
382 int com_sb(int fd, __a_unused int argc, __a_unused char **argv)
383 {
384 audiod_status = AUDIOD_STANDBY;
385 close(fd);
386 return 1;
387 }
388
389 int com_cycle(int fd, int argc, char **argv)
390 {
391 switch (audiod_status) {
392 case AUDIOD_ON:
393 return com_sb(fd, argc, argv);
394 break;
395 case AUDIOD_OFF:
396 return com_on(fd, argc, argv);
397 break;
398 case AUDIOD_STANDBY:
399 return com_off(fd, argc, argv);
400 break;
401 }
402 close(fd);
403 return 1;
404 }
405
406 static int check_perms(uid_t uid)
407 {
408 int i;
409
410 if (!conf.user_allow_given)
411 return 1;
412 for (i = 0; i < conf.user_allow_given; i++)
413 if (uid == conf.user_allow_arg[i])
414 return 1;
415 return -E_UCRED_PERM;
416 }
417
418 /**
419 * handle arriving connections on the local socket
420 *
421 * \param accept_fd the fd to call accept() on
422 *
423 * This is called whenever para_audiod's main task detects an incoming
424 * connection by the readability of \a accept_fd. This function reads the
425 * command sent by the peer, checks the connecting user's permissions by using
426 * unix socket credentials (if supported by the OS) and calls the corresponding
427 * command handler if permissions are OK.
428 *
429 * \return positive on success, negative on errors
430 *
431 * \sa para_accept(), recv_cred_buffer()
432 * */
433 int handle_connect(int accept_fd)
434 {
435 int i, argc, ret, clifd = -1;
436 char buf[MAXLINE], **argv = NULL;
437 struct sockaddr_un unix_addr;
438 uid_t uid;
439
440 ret = para_accept(accept_fd, &unix_addr, sizeof(struct sockaddr_un));
441 if (ret < 0)
442 goto out;
443 clifd = ret;
444 ret = recv_cred_buffer(clifd, buf, sizeof(buf) - 1);
445 if (ret < 0)
446 goto out;
447 uid = ret;
448 PARA_INFO_LOG("connection from user %i, buf: %s\n", ret, buf);
449 ret = check_perms(uid);
450 if (ret < 0)
451 goto out;
452 ret = create_argv(buf, "\n", &argv);
453 if (ret < 0)
454 goto out;
455 argc = ret;
456 //PARA_INFO_LOG("argv[0]: %s, argc = %d\n", argv[0], argc);
457 FOR_EACH_COMMAND(i) {
458 if (strcmp(audiod_cmds[i].name, argv[0]))
459 continue;
460 ret = audiod_cmds[i].handler(clifd, argc, argv);
461 goto out;
462 }
463 ret = -E_INVALID_AUDIOD_CMD;
464 out:
465 free_argv(argv);
466 if (clifd > 0 && ret < 0 && ret != -E_CLIENT_WRITE) {
467 char *tmp = make_message("%s\n", para_strerror(-ret));
468 client_write(clifd, tmp);
469 free(tmp);
470 close(clifd);
471 }
472 return ret;
473 }
474
475 /**
476 * Send the current audiod status to all connected stat clients.
477 */
478 void audiod_status_dump(void)
479 {
480 int slot_num = get_play_time_slot_num();
481 char *old, *new;
482
483 old = stat_item_values[SI_PLAY_TIME];
484 new = get_time_string(slot_num);
485 if (new) {
486 if (!old || strcmp(old, new)) {
487 free(old);
488 stat_item_values[SI_PLAY_TIME] = new;
489 stat_client_write_item(SI_PLAY_TIME);
490 } else
491 free(new);
492 }
493
494 new = uptime_str();
495 old = stat_item_values[SI_AUDIOD_UPTIME];
496 if (!old || strcmp(old, new)) {
497 free(old);
498 stat_item_values[SI_AUDIOD_UPTIME] = new;
499 stat_client_write_item(SI_AUDIOD_UPTIME);
500 } else
501 free(new);
502
503 old = stat_item_values[SI_AUDIOD_STATUS];
504 new = audiod_status_string();
505 if (!old || strcmp(old, new)) {
506 free(old);
507 stat_item_values[SI_AUDIOD_STATUS] = new;
508 stat_client_write_item(SI_AUDIOD_STATUS);
509 } else
510 free(new);
511
512 old = stat_item_values[SI_DECODER_FLAGS];
513 new = decoder_flags();
514 if (!old || strcmp(old, new)) {
515 free(old);
516 stat_item_values[SI_DECODER_FLAGS] = new;
517 stat_client_write_item(SI_DECODER_FLAGS);
518 } else
519 free(new);
520 }
521
522 /**
523 * Flush and send all status items.
524 *
525 * Send to each connected client the full status item list
526 * with empty values.
527 */
528 void clear_and_dump_items(void)
529 {
530 int i;
531
532 FOR_EACH_STATUS_ITEM(i) {
533 free(stat_item_values[i]);
534 stat_item_values[i] = NULL;
535 stat_client_write_item(i);
536 }
537 }