Merge branch 'refs/heads/t/immediate-si-update'
[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 static int dump_commands(int fd)
220 {
221 char *buf = para_strdup(""), *tmp = NULL;
222 int i;
223 ssize_t ret;
224
225 FOR_EACH_COMMAND(i) {
226 tmp = make_message("%s%s\t%s\n", buf, audiod_cmds[i].name,
227 audiod_cmds[i].description);
228 free(buf);
229 buf = tmp;
230 }
231 ret = client_write(fd, buf);
232 free(buf);
233 return ret;
234 }
235
236 /*
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.
240 */
241
242 static int com_help(int fd, int argc, char **argv)
243 {
244 int i, ret;
245 char *buf;
246 const char *dflt = "No such command. Available commands:\n";
247
248 if (argc < 2) {
249 ret = dump_commands(fd);
250 goto out;
251 }
252 FOR_EACH_COMMAND(i) {
253 if (strcmp(audiod_cmds[i].name, argv[1]))
254 continue;
255 buf = make_message(
256 "NAME\n\t%s -- %s\n"
257 "SYNOPSIS\n\tpara_audioc %s\n"
258 "DESCRIPTION\n%s\n",
259 argv[1],
260 audiod_cmds[i].description,
261 audiod_cmds[i].usage,
262 audiod_cmds[i].help
263 );
264 ret = client_write(fd, buf);
265 free(buf);
266 goto out;
267 }
268 ret = client_write(fd, dflt);
269 if (ret > 0)
270 ret = dump_commands(fd);
271 out:
272 if (ret >= 0)
273 close(fd);
274 return ret;
275 }
276
277 static int com_tasks(int fd, __a_unused int argc, __a_unused char **argv)
278 {
279 char *tl = get_task_list(&sched);
280 int ret = 1;
281 if (tl)
282 ret = client_write(fd, tl);
283 free(tl);
284 if (ret > 0)
285 close(fd);
286 return ret;
287 }
288
289 static int com_stat(int fd, int argc, char **argv)
290 {
291 int i, ret, parser_friendly = 0;
292 uint64_t mask = 0;
293 const uint64_t one = 1;
294 struct para_buffer b = {.flags = 0};
295
296 ret = mark_fd_nonblocking(fd);
297 if (ret < 0)
298 return ret;
299 for (i = 1; i < argc; i++) {
300 const char *arg = argv[i];
301 if (arg[0] != '-')
302 break;
303 if (!strcmp(arg, "--")) {
304 i++;
305 break;
306 }
307 if (!strncmp(arg, "-p", 2)) {
308 parser_friendly = 1;
309 b.flags = PBF_SIZE_PREFIX;
310 }
311 }
312 if (i >= argc)
313 mask--; /* set all bits */
314 for (; i < argc; i++) {
315 ret = stat_item_valid(argv[i]);
316 if (ret < 0)
317 return ret;
318 mask |= (one << ret);
319 }
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))
324 continue;
325 (void)WRITE_STATUS_ITEM(&b, i, "%s\n", item? item : "");
326 }
327 ret = client_write(fd, b.buf);
328 if (ret >= 0)
329 ret = stat_client_add(fd, mask, parser_friendly);
330 free(b.buf);
331 return ret;
332 }
333
334 static int com_grab(int fd, int argc, char **argv)
335 {
336 return grab_client_new(fd, argc, argv, &sched);
337 }
338
339 static int com_term(int fd, __a_unused int argc, __a_unused char **argv)
340 {
341 close(fd);
342 return -E_AUDIOD_TERM;
343 }
344
345 static int com_on(int fd, __a_unused int argc, __a_unused char **argv)
346 {
347 audiod_status = AUDIOD_ON;
348 close(fd);
349 return 1;
350 }
351
352 static int com_off(int fd, __a_unused int argc, __a_unused char **argv)
353 {
354 audiod_status = AUDIOD_OFF;
355 close(fd);
356 return 1;
357 }
358
359 static int com_sb(int fd, __a_unused int argc, __a_unused char **argv)
360 {
361 audiod_status = AUDIOD_STANDBY;
362 close(fd);
363 return 1;
364 }
365
366 static int com_cycle(int fd, int argc, char **argv)
367 {
368 switch (audiod_status) {
369 case AUDIOD_ON:
370 return com_sb(fd, argc, argv);
371 break;
372 case AUDIOD_OFF:
373 return com_on(fd, argc, argv);
374 break;
375 case AUDIOD_STANDBY:
376 return com_off(fd, argc, argv);
377 break;
378 }
379 close(fd);
380 return 1;
381 }
382
383 static int com_version(int fd, int argc, char **argv)
384 {
385 int ret;
386 char *msg;
387
388 if (argc > 1 && strcmp(argv[1], "-v") == 0)
389 msg = make_message("%s", version_text("audiod"));
390 else
391 msg = make_message("%s\n", version_single_line("audiod"));
392 ret = client_write(fd, msg);
393 free(msg);
394 if (ret >= 0)
395 close(fd);
396 return ret;
397 }
398
399 static int check_perms(uid_t uid)
400 {
401 int i;
402
403 if (!conf.user_allow_given)
404 return 1;
405 for (i = 0; i < conf.user_allow_given; i++)
406 if (uid == conf.user_allow_arg[i])
407 return 1;
408 return -E_UCRED_PERM;
409 }
410
411 /**
412 * Handle arriving connections on the local socket.
413 *
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.
416 *
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.
422 *
423 * \return Positive on success, negative on errors, zero if there was no
424 * connection to accept.
425 *
426 * \sa para_accept(), recv_cred_buffer()
427 * */
428 int handle_connect(int accept_fd, fd_set *rfds)
429 {
430 int i, argc, ret, clifd;
431 char buf[MAXLINE], **argv = NULL;
432 struct sockaddr_un unix_addr;
433 uid_t uid;
434
435 ret = para_accept(accept_fd, rfds, &unix_addr, sizeof(struct sockaddr_un), &clifd);
436 if (ret <= 0)
437 return ret;
438 ret = recv_cred_buffer(clifd, buf, sizeof(buf) - 1);
439 if (ret < 0)
440 goto out;
441 uid = ret;
442 PARA_INFO_LOG("connection from user %i, buf: %s\n", ret, buf);
443 ret = check_perms(uid);
444 if (ret < 0)
445 goto out;
446 ret = create_argv(buf, "\n", &argv);
447 if (ret <= 0)
448 goto out;
449 argc = ret;
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]))
453 continue;
454 ret = audiod_cmds[i].handler(clifd, argc, argv);
455 goto out;
456 }
457 ret = -E_INVALID_AUDIOD_CMD;
458 out:
459 free_argv(argv);
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);
463 free(tmp);
464 close(clifd);
465 }
466 return ret;
467 }
468
469 /**
470 * Send the current audiod status to all connected stat clients.
471 *
472 * \param force Whether to write unchanged items.
473 */
474 void audiod_status_dump(bool force)
475 {
476 char *old, *new;
477
478 old = stat_item_values[SI_PLAY_TIME];
479 new = get_time_string();
480 if (new) {
481 if (force || !old || strcmp(old, new)) {
482 free(old);
483 stat_item_values[SI_PLAY_TIME] = new;
484 stat_client_write_item(SI_PLAY_TIME);
485 } else
486 free(new);
487 }
488
489 new = daemon_get_uptime_str(now);
490 old = stat_item_values[SI_AUDIOD_UPTIME];
491 if (force || !old || strcmp(old, new)) {
492 free(old);
493 stat_item_values[SI_AUDIOD_UPTIME] = new;
494 stat_client_write_item(SI_AUDIOD_UPTIME);
495 } else
496 free(new);
497
498 old = stat_item_values[SI_AUDIOD_STATUS];
499 new = audiod_status_string();
500 if (force || !old || strcmp(old, new)) {
501 free(old);
502 stat_item_values[SI_AUDIOD_STATUS] = new;
503 stat_client_write_item(SI_AUDIOD_STATUS);
504 } else
505 free(new);
506
507 old = stat_item_values[SI_DECODER_FLAGS];
508 new = audiod_get_decoder_flags();
509 if (force || !old || strcmp(old, new)) {
510 free(old);
511 stat_item_values[SI_DECODER_FLAGS] = new;
512 stat_client_write_item(SI_DECODER_FLAGS);
513 } else
514 free(new);
515 }
516
517 /**
518 * Flush and send all status items.
519 *
520 * Send to each connected client the full status item list
521 * with empty values.
522 */
523 void clear_and_dump_items(void)
524 {
525 int i;
526
527 FOR_EACH_STATUS_ITEM(i) {
528 free(stat_item_values[i]);
529 stat_item_values[i] = NULL;
530 stat_client_write_item(i);
531 }
532 }