audiod_command.c

   1 /*
   2  * Copyright (C) 2005-2007 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 <sys/types.h>
  10 #include <dirent.h>
  11
  12 #include "para.h"
  13 #include "audiod.cmdline.h"
  14 #include "list.h"
  15 #include "close_on_fork.h"
  16 #include "sched.h"
  17 #include "filter.h"
  18 #include "grab_client.cmdline.h"
  19 #include "grab_client.h"
  20
  21 #include "error.h"
  22 #include "audiod.h"
  23 #include "net.h"
  24 #include "daemon.h"
  25 #include "string.h"
  26 #include "fd.h"
  27 #include "audiod_command_list.h"
  28
  29 /** iterate over the array of all audiod commands */
  30 #define FOR_EACH_COMMAND(c) for (c = 0; audiod_cmds[c].name; c++)
  31
  32 static int client_write(int fd, const char *buf)
  33 {
  34         size_t len = strlen(buf);
  35         return write(fd, buf, len) != len? -E_CLIENT_WRITE: 1;
  36 }
  37
  38 static char *get_time_string(struct timeval *newest_stime)
  39 {
  40         struct timeval diff, adj_stream_start, tmp;
  41         int total = 0, use_server_time = 1,
  42                 length_seconds = stat_task->length_seconds;
  43
  44         if (!stat_task->playing) {
  45                 if (length_seconds)
  46                         return NULL;
  47                 return make_message("%s:\n", status_item_list[SI_PLAY_TIME]);
  48         }
  49         if (audiod_status == AUDIOD_OFF)
  50                 goto out;
  51         if (stat_task->sa_time_diff_sign > 0)
  52                 tv_diff(&stat_task->server_stream_start, &stat_task->sa_time_diff,
  53                         &adj_stream_start);
  54         else
  55                 tv_add(&stat_task->server_stream_start, &stat_task->sa_time_diff,
  56                         &adj_stream_start);
  57         tmp = adj_stream_start;
  58         if (newest_stime && audiod_status == AUDIOD_ON) {
  59                 tv_diff(newest_stime, &adj_stream_start, &diff);
  60                 if (tv2ms(&diff) < 5000) {
  61                         tmp = *newest_stime;
  62                         use_server_time = 0;
  63                 }
  64         }
  65         tv_diff(now, &tmp, &diff);
  66         total = diff.tv_sec + stat_task->offset_seconds;
  67         if (total > length_seconds)
  68                 total = length_seconds;
  69         if (total < 0)
  70                 total = 0;
  71 out:
  72         return make_message(
  73                 "%s: %s%d:%02d [%d:%02d] (%d%%/%d:%02d)\n",
  74                 status_item_list[SI_PLAY_TIME],
  75                 use_server_time? "~" : "",
  76                 total / 60,
  77                 total % 60,
  78                 (length_seconds - total) / 60,
  79                 (length_seconds - total) % 60,
  80                 length_seconds? (total * 100 + length_seconds / 2) /
  81                         length_seconds : 0,
  82                 length_seconds / 60,
  83                 length_seconds % 60
  84         );
  85 }
  86
  87 __malloc static char *audiod_status_string(void)
  88 {
  89         const char *status = (audiod_status == AUDIOD_ON)?
  90                 "on" : (audiod_status == AUDIOD_OFF)? "off": "sb";
  91         return make_message("%s: %s\n", status_item_list[SI_AUDIOD_STATUS], status);
  92 }
  93
  94 static struct timeval *wstime(void)
  95 {
  96         int i;
  97         struct timeval *max = NULL;
  98         FOR_EACH_SLOT(i) {
  99                 struct slot_info *s = &slot[i];
 100                 if (!s->wng)
 101                         continue;
 102                 if (max && tv_diff(&s->wstime, max, NULL) <= 0)
 103                         continue;
 104                 max = &s->wstime;
 105         }
 106         return max;
 107 }
 108 __malloc static char *decoder_flags(void)
 109 {
 110         int i;
 111         char flags[MAX_STREAM_SLOTS + 1];
 112
 113         FOR_EACH_SLOT(i) {
 114                 struct slot_info *s = &slot[i];
 115                 char flag = '0';
 116                 if (s->receiver_node)
 117                         flag += 1;
 118                 if (s->wng)
 119                         flag += 2;
 120                 flags[i] = flag;
 121         }
 122         flags[MAX_STREAM_SLOTS] = '\0';
 123         return make_message("%s: %s\n", status_item_list[SI_DECODER_FLAGS],
 124                 flags);
 125 }
 126
 127 static int dump_commands(int fd)
 128 {
 129         char *buf = para_strdup(""), *tmp = NULL;
 130         int i;
 131         ssize_t ret;
 132
 133         FOR_EACH_COMMAND(i) {
 134                 tmp = make_message("%s%s\t%s\n", buf, audiod_cmds[i].name,
 135                         audiod_cmds[i].description);
 136                 free(buf);
 137                 buf = tmp;
 138         }
 139         ret = client_write(fd, buf);
 140         free(buf);
 141         return ret;
 142 }
 143
 144 /*
 145  * command handlers don't close their fd on errors (ret < 0) so that
 146  * its caller can send an error message. Otherwise (ret >= 0) it's up
 147  * to each individual command to close the fd if necessary.
 148  */
 149
 150 int com_help(int fd, int argc, char **argv)
 151 {
 152         int i, ret;
 153         char *buf;
 154         const char *dflt = "No such command. Available commands:\n";
 155
 156         if (argc < 2) {
 157                 ret = dump_commands(fd);
 158                 goto out;
 159         }
 160         FOR_EACH_COMMAND(i) {
 161                 if (strcmp(audiod_cmds[i].name, argv[1]))
 162                         continue;
 163                 buf = make_message(
 164                         "NAME\n\t%s -- %s\n"
 165                         "SYNOPSIS\n\tpara_audioc %s\n"
 166                         "DESCRIPTION\n%s\n",
 167                         argv[1],
 168                         audiod_cmds[i].description,
 169                         audiod_cmds[i].usage,
 170                         audiod_cmds[i].help
 171                 );
 172                 ret = client_write(fd, buf);
 173                 free(buf);
 174                 goto out;
 175         }
 176         ret = client_write(fd, dflt);
 177         if (ret > 0)
 178                 ret = dump_commands(fd);
 179 out:
 180         if (ret >= 0)
 181                 close(fd);
 182         return ret;
 183 }
 184
 185 int com_tasks(int fd, __a_unused int argc, __a_unused char **argv)
 186 {
 187         char *tl = get_task_list();
 188         int ret = 1;
 189         if (tl)
 190                 ret = client_write(fd, tl);
 191         free(tl);
 192         if (ret > 0)
 193                 close(fd);
 194         return ret;
 195 }
 196
 197 int com_kill(int fd, int argc, char **argv)
 198 {
 199         int i, ret = 1;
 200         if (argc < 2)
 201                 return -E_AUDIOD_SYNTAX;
 202         for (i = 1; i < argc; i++) {
 203                 ret = kill_task(argv[i]);
 204                 if (ret < 0)
 205                         break;
 206         }
 207         if (ret > 0)
 208                 close(fd);
 209         return ret;
 210 }
 211
 212 int com_stat(int fd, __a_unused int argc, __a_unused char **argv)
 213 {
 214         int i, ret;
 215         char *buf = NULL;
 216         long unsigned mask = ~0LU;
 217
 218         if (argc > 1) {
 219                 mask = 0;
 220                 for (i = 1; i < argc; i++) {
 221                         ret = stat_item_valid(argv[i]);
 222                         if (ret < 0)
 223                                 return ret;
 224                         mask |= (1 << ret);
 225                 }
 226         }
 227         PARA_INFO_LOG("mask: 0x%lx\n", mask);
 228         if (mask & (1 << SI_PLAY_TIME)) {
 229                 struct timeval *t = wstime();
 230                 char *ts = get_time_string(t);
 231                 if (ts) {
 232                         ret = client_write(fd, ts);
 233                         if (ret < 0)
 234                                 goto out;
 235                         free(ts);
 236                 }
 237         }
 238         if (mask & (1 << SI_AUDIOD_UPTIME)) {
 239                 char *tmp, *us = uptime_str();
 240                 tmp = make_message("%s: %s\n",
 241                         status_item_list[SI_AUDIOD_UPTIME], us);
 242                 free(us);
 243                 ret = client_write(fd, tmp);
 244                 if (ret < 0)
 245                         goto out;
 246                 free(tmp);
 247         }
 248         if (mask & (1 << SI_AUDIOD_STATUS)) {
 249                 char *s = audiod_status_string();
 250                 ret = client_write(fd, s);
 251                 if (ret < 0)
 252                         goto out;
 253                 free(s);
 254         }
 255         if (mask & (1 << SI_DECODER_FLAGS)) {
 256                 char *df = decoder_flags();
 257                 ret = client_write(fd, df);
 258                 if (ret < 0)
 259                         goto out;
 260                 free(df);
 261         }
 262         FOR_EACH_STATUS_ITEM(i) {
 263                 char *tmp, *v;
 264                 if (!((1 << i) & mask))
 265                         continue;
 266                 v = stat_task->stat_item_values[i];
 267                 tmp = make_message("%s%s%s", buf? buf: "",
 268                         v? v : "", v? "\n" : "");
 269                 free(buf);
 270                 buf = tmp;
 271         }
 272         ret = client_write(fd, buf);
 273 out:
 274         if (ret > 0)
 275                 ret = stat_client_add(fd, mask);
 276         free(buf);
 277         return ret;
 278 }
 279
 280 static struct filter_node *find_filter_node(int slot_num, int format, int filternum)
 281 {
 282         struct filter_node *fn;
 283         int i, j;
 284
 285         FOR_EACH_SLOT(i) {
 286                 struct slot_info *s = &slot[i];
 287                 if (s->format < 0 || !s->fc)
 288                         continue;
 289                 if (slot_num >= 0 && slot_num != i)
 290                         continue;
 291                 if (format >= 0 && s->format != format)
 292                         continue;
 293                 if (num_filters(i) < filternum)
 294                         continue;
 295                 /* success */
 296                 j = 1;
 297                 list_for_each_entry(fn, &s->fc->filters, node)
 298                         if (filternum <= 0 || j++ == filternum)
 299                                 break;
 300                 return fn;
 301         }
 302         return NULL;
 303 }
 304
 305 int com_grab(int fd, char *cmdline)
 306 {
 307         struct grab_client *gc;
 308         struct filter_node *fn;
 309         int i, err;
 310         char *msg;
 311
 312         gc = grab_client_new(fd, cmdline, &err);
 313         if (!gc)
 314                 goto err_out;
 315         fn = find_filter_node(gc->conf->slot_arg, gc->audio_format_num, gc->conf->filter_num_arg);
 316         if (fn)
 317                 activate_grab_client(gc, fn);
 318         return 1;
 319 err_out:
 320         if (err != -E_GC_HELP_GIVEN && err != -E_GC_VERSION_GIVEN)
 321                 return err;
 322         if (err == -E_GC_HELP_GIVEN) {
 323                 msg = make_message("%s\n\n", grab_client_args_info_usage);
 324                 for (i = 0; grab_client_args_info_help[i]; i++) {
 325                         char *tmp = make_message("%s%s\n", msg,
 326                                 grab_client_args_info_help[i]);
 327                         free(msg);
 328                         msg = tmp;
 329                 }
 330         } else
 331                 msg = make_message("%s %s\n",
 332                         GRAB_CLIENT_CMDLINE_PARSER_PACKAGE,
 333                         GRAB_CLIENT_CMDLINE_PARSER_VERSION);
 334         err = client_write(fd, msg);
 335         free(msg);
 336         if (err < 0)
 337                 return err;
 338         close(fd);
 339         return 1;
 340 }
 341
 342 __noreturn int com_term(int fd, __a_unused int argc, __a_unused char **argv)
 343 {
 344         close(fd);
 345         clean_exit(EXIT_SUCCESS, "terminating on user request");
 346 }
 347
 348 int com_on(int fd, __a_unused int argc, __a_unused char **argv)
 349 {
 350         audiod_status = AUDIOD_ON;
 351         close(fd);
 352         return 1;
 353 }
 354
 355 int com_off(int fd, __a_unused int argc, __a_unused char **argv)
 356 {
 357         audiod_status = AUDIOD_OFF;
 358         close(fd);
 359         return 1;
 360 }
 361
 362 int com_sb(int fd, __a_unused int argc, __a_unused char **argv)
 363 {
 364         audiod_status = AUDIOD_STANDBY;
 365         close(fd);
 366         return 1;
 367 }
 368
 369 int com_cycle(int fd, int argc, char **argv)
 370 {
 371         switch (audiod_status) {
 372                 case  AUDIOD_ON:
 373                         return com_sb(fd, argc, argv);
 374                         break;
 375                 case  AUDIOD_OFF:
 376                         return com_on(fd, argc, argv);
 377                         break;
 378                 case  AUDIOD_STANDBY:
 379                         return com_off(fd, argc, argv);
 380                         break;
 381         }
 382         close(fd);
 383         return 1;
 384 }
 385
 386 static int check_perms(uid_t uid)
 387 {
 388         int i;
 389
 390         if (!conf.user_allow_given)
 391                 return 1;
 392         for (i = 0; i < conf.user_allow_given; i++)
 393                 if (uid == conf.user_allow_arg[i])
 394                         return 1;
 395         return -E_UCRED_PERM;
 396 }
 397
 398 /**
 399  * handle arriving connections on the local socket
 400  *
 401  * \param accept_fd the fd to call accept() on
 402  *
 403  * This is called whenever para_audiod's main task detects an incoming
 404  * connection by the readability of \a accept_fd. This function reads the
 405  * command sent by the peer, checks the connecting user's permissions by using
 406  * unix socket credentials (if supported by the OS) and calls the corresponding
 407  * command handler if permissions are OK.
 408  *
 409  * \return positive on success, negative on errors
 410  *
 411  * \sa para_accept(), recv_cred_buffer()
 412  * */
 413 int handle_connect(int accept_fd)
 414 {
 415         int i, argc, ret, clifd = -1;
 416         char *cmd = NULL, *p, *buf = para_calloc(MAXLINE), **argv = NULL;
 417         struct sockaddr_un unix_addr;
 418         uid_t uid;
 419
 420         ret = para_accept(accept_fd, &unix_addr, sizeof(struct sockaddr_un));
 421         if (ret < 0)
 422                 goto out;
 423         clifd = ret;
 424         ret = recv_cred_buffer(clifd, buf, MAXLINE - 1);
 425         if (ret < 0)
 426                 goto out;
 427         uid = ret;
 428         PARA_INFO_LOG("connection from user %i, buf: %s\n",  ret, buf);
 429         ret = check_perms(uid);
 430         if (ret < 0)
 431                 goto out;
 432         ret = -E_INVALID_AUDIOD_CMD;
 433         cmd = para_strdup(buf);
 434         p = strchr(cmd, '\n');
 435         if (!p)
 436                 p = "";
 437         else {
 438                 *p = '\0';
 439                 p++;
 440         }
 441         for (i = 0; audiod_cmds[i].name; i++) {
 442                 int j;
 443                 if (strcmp(audiod_cmds[i].name, cmd))
 444                         continue;
 445                 if (audiod_cmds[i].handler) {
 446                         argc = split_args(buf, &argv, "\n");
 447                         PARA_INFO_LOG("argv[0]: %s, argc= %d\n", argv[0], argc);
 448                         ret = audiod_cmds[i].handler(clifd, argc, argv);
 449                         goto out;
 450                 }
 451                 for (j = 0; p[j]; j++)
 452                         if (p[j] == '\n')
 453                                 p[j] = ' ';
 454                 PARA_INFO_LOG("cmd: %s, options: %s\n", cmd, p);
 455                 ret = audiod_cmds[i].line_handler(clifd, p);
 456                 goto out;
 457         }
 458         ret = -E_INVALID_AUDIOD_CMD;
 459 out:
 460         free(cmd);
 461         free(buf);
 462         free(argv);
 463         if (clifd > 0 && ret < 0 && ret != -E_CLIENT_WRITE) {
 464                 char *tmp = make_message("%s\n", PARA_STRERROR(-ret));
 465                 client_write(clifd, tmp);
 466                 free(tmp);
 467                 close(clifd);
 468         }
 469         return ret;
 470 }
 471 /**
 472  * send the current audiod status to all connected stat clients
 473  */
 474 void audiod_status_dump(void)
 475 {
 476         struct timeval *t = wstime();
 477         char *old, *new, *tmp;
 478
 479         old = stat_task->stat_item_values[SI_PLAY_TIME];
 480         new = get_time_string(t);
 481         if (new) {
 482                 if (!old || strcmp(old, new)) {
 483                         free(old);
 484                         stat_client_write(new, SI_PLAY_TIME);
 485                         stat_task->stat_item_values[SI_PLAY_TIME] = new;
 486                 } else
 487                         free(new);
 488         }
 489
 490         new = uptime_str();
 491         old = stat_task->stat_item_values[SI_AUDIOD_UPTIME];
 492         if (!old || strcmp(old, new)) {
 493                 free(old);
 494                 tmp = make_message("%s: %s\n",
 495                         status_item_list[SI_AUDIOD_UPTIME], new);
 496                 stat_client_write(tmp, SI_AUDIOD_UPTIME);
 497                 free(tmp);
 498                 stat_task->stat_item_values[SI_AUDIOD_UPTIME] = new;
 499         } else
 500                 free(new);
 501
 502         old = stat_task->stat_item_values[SI_AUDIOD_STATUS];
 503         new = audiod_status_string();
 504         if (!old || strcmp(old, new)) {
 505                 free(old);
 506                 stat_client_write(new, SI_AUDIOD_STATUS);
 507                 stat_task->stat_item_values[SI_AUDIOD_STATUS] = new;
 508         } else
 509                 free(new);
 510
 511         old = stat_task->stat_item_values[SI_DECODER_FLAGS];
 512         new = decoder_flags();
 513         if (!old || strcmp(old, new)) {
 514                 free(old);
 515                 stat_client_write(new, SI_DECODER_FLAGS);
 516                 stat_task->stat_item_values[SI_DECODER_FLAGS] = new;
 517         } else
 518                 free(new);
 519 }
 520
 521 /**
 522  * send empty status list
 523  *
 524  * Send to  each connected client the full status item list
 525  * with empty values.
 526  */
 527 void dump_empty_status(void)
 528 {
 529         int i;
 530
 531         FOR_EACH_STATUS_ITEM(i) {
 532                 char *tmp = make_message("%s:\n", status_item_list[i]);
 533                 stat_client_write(tmp, i);
 534                 free(tmp);
 535                 free(stat_task->stat_item_values[i]);
 536                 stat_task->stat_item_values[i] = NULL;
 537         }
 538 }