2 * Copyright (C) 2005-2009 Andre Noll <maan@systemlinux.org>
4 * Licensed under the GPL v2. For licencing details see COPYING.
7 /** \file audiod_command.c commands for para_audiod */
10 #include <sys/types.h>
14 #include "audiod.cmdline.h"
19 #include "grab_client.h"
26 #include "audiod_command_list.h"
28 extern char *stat_item_values
[NUM_STAT_ITEMS
];
30 /** Iterate over the array of all audiod commands. */
31 #define FOR_EACH_COMMAND(c) for (c = 0; audiod_cmds[c].name; c++)
33 /** The maximal number of simultaneous connections. */
34 #define MAX_STAT_CLIENTS 50
36 /** Flags used for the stat command of para_audiod. */
37 enum stat_client_flags
{
38 /** Enable parser-friendly output. */
39 SCF_PARSER_FRIENDLY
= 1,
43 * Describes a status client of para_audiod.
45 * There's one such structure per audiod client that sent the 'stat' command.
47 * A status client is identified by its file descriptor. para_audiod
48 * keeps a list of connected status clients.
51 /** The stat client's file descriptor. */
53 /** Bitmask of those status items the client is interested in. */
55 /** See \ref stat_client flags. s*/
57 /** Its entry in the list of stat clients. */
58 struct list_head node
;
61 static struct list_head client_list
;
62 static int client_list_initialized
;
63 static int num_clients
;
65 /** The list of all status items used by para_{server,audiod,gui}. */
66 const char *status_item_list
[] = {STATUS_ITEM_ARRAY
};
68 static void dump_stat_client_list(void)
70 struct stat_client
*sc
;
72 if (!client_list_initialized
)
74 list_for_each_entry(sc
, &client_list
, node
)
75 PARA_INFO_LOG("stat client on fd %d\n", sc
->fd
);
78 * Add a status client to the list.
80 * \param fd The file descriptor of the client.
81 * \param mask Bitfield of status items for this client.
82 * \param parser_friendly Enable parser-friendly output mode.
84 * Only those status items having the bit set in \a mask will be
87 * \return Positive value on success, or -E_TOO_MANY_CLIENTS if
88 * the number of connected clients exceeds #MAX_STAT_CLIENTS.
90 static int stat_client_add(int fd
, uint64_t mask
, int parser_friendly
)
92 struct stat_client
*new_client
;
94 if (num_clients
>= MAX_STAT_CLIENTS
) {
95 PARA_ERROR_LOG("maximal number of stat clients (%d) exceeded\n",
97 return -E_TOO_MANY_CLIENTS
;
99 if (!client_list_initialized
) {
100 INIT_LIST_HEAD(&client_list
);
101 client_list_initialized
= 1;
103 PARA_INFO_LOG("adding client on fd %d\n", fd
);
104 new_client
= para_calloc(sizeof(struct stat_client
));
106 new_client
->item_mask
= mask
;
108 new_client
->flags
= SCF_PARSER_FRIENDLY
;
109 para_list_add(&new_client
->node
, &client_list
);
110 dump_stat_client_list();
115 * Write a message to all connected status clients.
117 * \param item_num The number of the status item of \a msg.
119 * On write errors, remove the status client from the client list and close its
122 void stat_client_write_item(int item_num
)
124 struct stat_client
*sc
, *tmp
;
125 struct para_buffer pb
= {.flags
= 0};
126 struct para_buffer pfpb
= {.flags
= PBF_SIZE_PREFIX
};
127 const uint64_t one
= 1;
129 if (!client_list_initialized
)
131 list_for_each_entry_safe(sc
, tmp
, &client_list
, node
) {
132 int fd
= sc
->fd
, ret
;
134 if (!((one
<< item_num
) & sc
->item_mask
))
136 if (write_ok(fd
) > 0) {
137 struct para_buffer
*b
=
138 (sc
->flags
& SCF_PARSER_FRIENDLY
)? &pfpb
: &pb
;
139 char *msg
= stat_item_values
[item_num
];
141 WRITE_STATUS_ITEM(b
, item_num
, "%s\n",
143 ret
= write(fd
, b
->buf
, b
->offset
);
144 if (ret
== b
->offset
)
147 /* write error or fd not ready for writing */
150 PARA_INFO_LOG("deleting client on fd %d\n", fd
);
153 dump_stat_client_list();
158 // PARA_DEBUG_LOG("%d client(s)\n", num_clients);
162 * Check if string is a known status item.
164 * \param item Buffer containing the text to check.
166 * \return If \a item is a valid status item, the number of that status item is
167 * returned. Otherwise, this function returns \p -E_UNKNOWN_STAT_ITEM.
169 static int stat_item_valid(const char *item
)
172 if (!item
|| !*item
) {
173 PARA_ERROR_LOG("%s\n", "no item");
174 return -E_UNKNOWN_STAT_ITEM
;
176 FOR_EACH_STATUS_ITEM(i
)
177 if (!strcmp(status_item_list
[i
], item
))
179 PARA_ERROR_LOG("invalid stat item: %s\n", item
);
180 return -E_UNKNOWN_STAT_ITEM
;
183 static int client_write(int fd
, const char *buf
)
190 return write(fd
, buf
, len
) != len
? -E_CLIENT_WRITE
: 1;
193 __malloc
static char *audiod_status_string(void)
195 const char *status
= (audiod_status
== AUDIOD_ON
)?
196 "on" : (audiod_status
== AUDIOD_OFF
)? "off": "sb";
197 return para_strdup(status
);
200 static int get_play_time_slot_num(void)
205 struct slot_info
*s
= &slot
[i
];
208 if (oldest
>= 0 && tv_diff(&s
->wstime
, &slot
[oldest
].wstime
,
216 __malloc
static char *decoder_flags(void)
219 char flags
[MAX_STREAM_SLOTS
+ 1];
222 struct slot_info
*s
= &slot
[i
];
224 if (s
->receiver_node
)
232 flags
[MAX_STREAM_SLOTS
] = '\0';
233 return para_strdup(flags
);
236 static int dump_commands(int fd
)
238 char *buf
= para_strdup(""), *tmp
= NULL
;
242 FOR_EACH_COMMAND(i
) {
243 tmp
= make_message("%s%s\t%s\n", buf
, audiod_cmds
[i
].name
,
244 audiod_cmds
[i
].description
);
248 ret
= client_write(fd
, buf
);
254 * command handlers don't close their fd on errors (ret < 0) so that
255 * its caller can send an error message. Otherwise (ret >= 0) it's up
256 * to each individual command to close the fd if necessary.
259 int com_help(int fd
, int argc
, char **argv
)
263 const char *dflt
= "No such command. Available commands:\n";
266 ret
= dump_commands(fd
);
269 FOR_EACH_COMMAND(i
) {
270 if (strcmp(audiod_cmds
[i
].name
, argv
[1]))
274 "SYNOPSIS\n\tpara_audioc %s\n"
277 audiod_cmds
[i
].description
,
278 audiod_cmds
[i
].usage
,
281 ret
= client_write(fd
, buf
);
285 ret
= client_write(fd
, dflt
);
287 ret
= dump_commands(fd
);
294 int com_tasks(int fd
, __a_unused
int argc
, __a_unused
char **argv
)
296 char *tl
= get_task_list();
299 ret
= client_write(fd
, tl
);
306 int com_kill(int fd
, int argc
, char **argv
)
310 return -E_AUDIOD_SYNTAX
;
311 for (i
= 1; i
< argc
; i
++) {
312 ret
= kill_task(argv
[i
]);
321 int com_stat(int fd
, int argc
, char **argv
)
323 int i
, ret
, parser_friendly
= 0;
325 const uint64_t one
= 1;
326 struct para_buffer b
= {.flags
= 0};
328 for (i
= 1; i
< argc
; i
++) {
329 const char *arg
= argv
[i
];
332 if (!strcmp(arg
, "--")) {
336 if (!strncmp(arg
, "-p", 2)) {
338 b
.flags
= PBF_SIZE_PREFIX
;
343 mask
--; /* set all bits */
344 for (; i
< argc
; i
++) {
345 ret
= stat_item_valid(argv
[i
]);
348 mask
|= (one
<< ret
);
350 PARA_INFO_LOG("mask: 0x%llx\n", (long long unsigned)mask
);
351 FOR_EACH_STATUS_ITEM(i
) {
352 char *item
= stat_item_values
[i
];
353 if (!((one
<< i
) & mask
))
355 WRITE_STATUS_ITEM(&b
, i
, "%s\n", item
? item
: "");
357 ret
= client_write(fd
, b
.buf
);
359 ret
= stat_client_add(fd
, mask
, parser_friendly
);
364 int com_grab(int fd
, int argc
, char **argv
)
366 return grab_client_new(fd
, argc
, argv
);
369 __noreturn
int com_term(int fd
, __a_unused
int argc
, __a_unused
char **argv
)
372 clean_exit(EXIT_SUCCESS
, "terminating on user request");
375 int com_on(int fd
, __a_unused
int argc
, __a_unused
char **argv
)
377 audiod_status
= AUDIOD_ON
;
382 int com_off(int fd
, __a_unused
int argc
, __a_unused
char **argv
)
384 audiod_status
= AUDIOD_OFF
;
389 int com_sb(int fd
, __a_unused
int argc
, __a_unused
char **argv
)
391 audiod_status
= AUDIOD_STANDBY
;
396 int com_cycle(int fd
, int argc
, char **argv
)
398 switch (audiod_status
) {
400 return com_sb(fd
, argc
, argv
);
403 return com_on(fd
, argc
, argv
);
406 return com_off(fd
, argc
, argv
);
413 static int check_perms(uid_t uid
)
417 if (!conf
.user_allow_given
)
419 for (i
= 0; i
< conf
.user_allow_given
; i
++)
420 if (uid
== conf
.user_allow_arg
[i
])
422 return -E_UCRED_PERM
;
426 * handle arriving connections on the local socket
428 * \param accept_fd the fd to call accept() on
430 * This is called whenever para_audiod's main task detects an incoming
431 * connection by the readability of \a accept_fd. This function reads the
432 * command sent by the peer, checks the connecting user's permissions by using
433 * unix socket credentials (if supported by the OS) and calls the corresponding
434 * command handler if permissions are OK.
436 * \return positive on success, negative on errors
438 * \sa para_accept(), recv_cred_buffer()
440 int handle_connect(int accept_fd
)
442 int i
, argc
, ret
, clifd
= -1;
443 char buf
[MAXLINE
], **argv
= NULL
;
444 struct sockaddr_un unix_addr
;
447 ret
= para_accept(accept_fd
, &unix_addr
, sizeof(struct sockaddr_un
));
451 ret
= recv_cred_buffer(clifd
, buf
, sizeof(buf
) - 1);
455 PARA_INFO_LOG("connection from user %i, buf: %s\n", ret
, buf
);
456 ret
= check_perms(uid
);
459 ret
= create_argv(buf
, "\n", &argv
);
463 //PARA_INFO_LOG("argv[0]: %s, argc = %d\n", argv[0], argc);
464 FOR_EACH_COMMAND(i
) {
465 if (strcmp(audiod_cmds
[i
].name
, argv
[0]))
467 ret
= audiod_cmds
[i
].handler(clifd
, argc
, argv
);
470 ret
= -E_INVALID_AUDIOD_CMD
;
473 if (clifd
> 0 && ret
< 0 && ret
!= -E_CLIENT_WRITE
) {
474 char *tmp
= make_message("%s\n", para_strerror(-ret
));
475 client_write(clifd
, tmp
);
483 * Send the current audiod status to all connected stat clients.
485 void audiod_status_dump(void)
487 int slot_num
= get_play_time_slot_num();
490 old
= stat_item_values
[SI_PLAY_TIME
];
491 new = get_time_string(slot_num
);
493 if (!old
|| strcmp(old
, new)) {
495 stat_item_values
[SI_PLAY_TIME
] = new;
496 stat_client_write_item(SI_PLAY_TIME
);
502 old
= stat_item_values
[SI_AUDIOD_UPTIME
];
503 if (!old
|| strcmp(old
, new)) {
505 stat_item_values
[SI_AUDIOD_UPTIME
] = new;
506 stat_client_write_item(SI_AUDIOD_UPTIME
);
510 old
= stat_item_values
[SI_AUDIOD_STATUS
];
511 new = audiod_status_string();
512 if (!old
|| strcmp(old
, new)) {
514 stat_item_values
[SI_AUDIOD_STATUS
] = new;
515 stat_client_write_item(SI_AUDIOD_STATUS
);
519 old
= stat_item_values
[SI_DECODER_FLAGS
];
520 new = decoder_flags();
521 if (!old
|| strcmp(old
, new)) {
523 stat_item_values
[SI_DECODER_FLAGS
] = new;
524 stat_client_write_item(SI_DECODER_FLAGS
);
530 * Flush and send all status items.
532 * Send to each connected client the full status item list
535 void clear_and_dump_items(void)
539 FOR_EACH_STATUS_ITEM(i
) {
540 free(stat_item_values
[i
]);
541 stat_item_values
[i
] = NULL
;
542 stat_client_write_item(i
);