afs.c

   1 /* Copyright (C) 2007 Andre Noll <maan@tuebingen.mpg.de>, see file COPYING. */
   2
   3 /** \file afs.c Paraslash's audio file selector. */
   4
   5 #include <netinet/in.h>
   6 #include <sys/socket.h>
   7 #include <regex.h>
   8 #include <signal.h>
   9 #include <fnmatch.h>
  10 #include <osl.h>
  11 #include <lopsub.h>
  12 #include <arpa/inet.h>
  13 #include <sys/un.h>
  14 #include <netdb.h>
  15 #include <lopsub.h>
  16
  17 #include "server.lsg.h"
  18 #include "server_cmd.lsg.h"
  19 #include "para.h"
  20 #include "error.h"
  21 #include "crypt.h"
  22 #include "string.h"
  23 #include "afh.h"
  24 #include "afs.h"
  25 #include "net.h"
  26 #include "server.h"
  27 #include "daemon.h"
  28 #include "ipc.h"
  29 #include "list.h"
  30 #include "sched.h"
  31 #include "fd.h"
  32 #include "signal.h"
  33 #include "sideband.h"
  34 #include "command.h"
  35
  36 /**
  37  * The array of tables of the audio file selector.
  38  *
  39  * We organize them in an array to be able to loop over all tables.
  40  */
  41 static const struct afs_table {
  42         /** The name is no table operation, so define it here. */
  43         const char * const name;
  44         /** The only way to invoke the ops is via this pointer. */
  45         const struct afs_table_operations *ops;
  46 } afs_tables[] = {
  47         {.name = "audio_files", .ops = &aft_ops},
  48         {.name = "attributes", .ops = &attr_ops},
  49         {.name = "scores", .ops = &score_ops},
  50         {.name = "moods", .ops = &moods_ops},
  51         {.name = "lyrics", .ops = &lyrics_ops},
  52         {.name = "images", .ops = &images_ops},
  53         {.name = "playlists", .ops = &playlists_ops},
  54 };
  55 /** Used to loop over the afs tables. */
  56 #define NUM_AFS_TABLES ARRAY_SIZE(afs_tables)
  57
  58 struct command_task {
  59         /** The file descriptor for the local socket. */
  60         int fd;
  61         /** The associated task structure. */
  62         struct task *task;
  63 };
  64
  65 extern int mmd_mutex;
  66 extern struct misc_meta_data *mmd;
  67
  68 static int server_socket;
  69 static struct command_task command_task_struct;
  70 static struct signal_task *signal_task;
  71
  72 static enum play_mode current_play_mode;
  73 static char *current_mop; /* mode or playlist specifier. NULL means dummy mood */
  74
  75 extern uint32_t afs_socket_cookie;
  76
  77 /**
  78  * Passed from command handlers to afs.
  79  *
  80  * Command handlers cannot change the afs database directly because they run in
  81  * a separate process. The callback query structure circumvents this
  82  * restriction as follows. To instruct the afs process to execute a particular
  83  * function, the command hander writes an instance of this structure to a
  84  * shared memory area, along with the arguments to the callback function. The
  85  * identifier of the shared memory area is transferred to the afs process via
  86  * the command socket.
  87  *
  88  * The afs process reads the shared memory id from the command socket, attaches
  89  * the corresponding area, and calls the callback function whose address is
  90  * stored in the area.
  91  *
  92  * The command output, if any, is transferred back to the command handler in
  93  * the same way: The afs process writes the output to a second shared memory
  94  * area together with a fixed size metadata header whose format corresponds to
  95  * the \ref callback_result structure. The identifier of this area is sent back
  96  * to the command handler which attaches the area and forwards the output to
  97  * the remote client.
  98  *
  99  * \sa \ref struct callback_result.
 100  */
 101 struct callback_query {
 102         /** The function to be called. */
 103         afs_callback *cb;
 104         /** The number of bytes of the query */
 105         size_t query_size;
 106 };
 107
 108 /**
 109  * Structure embedded in the result of a callback.
 110  *
 111  * If the callback produced a result, an instance of that structure is embedded
 112  * into the shared memory area holding the result, mainly to let the command
 113  * handler know the size of the result.
 114  *
 115  * \sa \ref struct callback_query.
 116  */
 117 struct callback_result {
 118         /** The number of bytes of the result. */
 119         size_t result_size;
 120         /** The band designator (loglevel for the result). */
 121         uint8_t band;
 122 };
 123
 124 static int dispatch_result(int result_shmid, callback_result_handler *handler,
 125                 void *private_result_data)
 126 {
 127         struct osl_object result;
 128         void *result_shm;
 129         /* must attach r/w as result.data might get encrypted in-place. */
 130         int ret2, ret = shm_attach(result_shmid, ATTACH_RW, &result_shm);
 131         struct callback_result *cr = result_shm;
 132
 133         if (ret < 0) {
 134                 PARA_ERROR_LOG("attach failed: %s\n", para_strerror(-ret));
 135                 return ret;
 136         }
 137         result.size = cr->result_size;
 138         result.data = result_shm + sizeof(*cr);
 139         assert(handler);
 140         ret = handler(&result, cr->band, private_result_data);
 141         ret2 = shm_detach(result_shm);
 142         if (ret2 < 0) {
 143                 PARA_ERROR_LOG("detach failed: %s\n", para_strerror(-ret2));
 144                 if (ret >= 0)
 145                         ret = ret2;
 146         }
 147         return ret;
 148 }
 149
 150 /**
 151  * Ask the afs process to call a given function.
 152  *
 153  * \param f The function to be called.
 154  * \param query Pointer to arbitrary data for the callback.
 155  * \param result_handler Called for each shm area sent by the callback.
 156  * \param private_result_data Passed verbatim to \a result_handler.
 157  *
 158  * This function creates a socket for communication with the afs process and a
 159  * shared memory area (sma) to which the buffer pointed to by \a query is
 160  * copied.  It then notifies the afs process that the callback function \a f
 161  * should be executed by sending the shared memory identifier (shmid) to the
 162  * socket.
 163  *
 164  * If the callback produces a result, it sends any number of shared memory
 165  * identifiers back via the socket. For each such identifier received, \a
 166  * result_handler is called. The contents of the sma identified by the received
 167  * shmid are passed to that function as an osl object. The private_result_data
 168  * pointer is passed as the second argument to \a result_handler.
 169  *
 170  * \return Number of shared memory areas dispatched on success, negative on
 171  * errors.
 172  */
 173 int send_callback_request(afs_callback *f, struct osl_object *query,
 174                 callback_result_handler *result_handler,
 175                 void *private_result_data)
 176 {
 177         struct callback_query *cq;
 178         int ret, fd = -1, query_shmid, result_shmid;
 179         void *query_shm;
 180         char buf[sizeof(afs_socket_cookie) + sizeof(int)];
 181         size_t query_shm_size = sizeof(*cq);
 182         int dispatch_error = 0, num_dispatched = 0;
 183
 184         if (query)
 185                 query_shm_size += query->size;
 186         ret = shm_new(query_shm_size);
 187         if (ret < 0)
 188                 return ret;
 189         query_shmid = ret;
 190         ret = shm_attach(query_shmid, ATTACH_RW, &query_shm);
 191         if (ret < 0)
 192                 goto out;
 193         cq = query_shm;
 194         cq->cb = f;
 195         cq->query_size = query_shm_size - sizeof(*cq);
 196
 197         if (query)
 198                 memcpy(query_shm + sizeof(*cq), query->data, query->size);
 199         ret = shm_detach(query_shm);
 200         if (ret < 0)
 201                 goto out;
 202
 203         *(uint32_t *)buf = afs_socket_cookie;
 204         *(int *)(buf + sizeof(afs_socket_cookie)) = query_shmid;
 205
 206         ret = connect_local_socket(OPT_STRING_VAL(AFS_SOCKET));
 207         if (ret < 0)
 208                 goto out;
 209         fd = ret;
 210         ret = write_all(fd, buf, sizeof(buf));
 211         if (ret < 0)
 212                 goto out;
 213         /*
 214          * Read all shmids from afs.
 215          *
 216          * Even if the dispatcher returns an error we _must_ continue to read
 217          * shmids from fd so that we can destroy all shared memory areas that
 218          * have been created for us by the afs process.
 219          */
 220         for (;;) {
 221                 ret = recv_bin_buffer(fd, buf, sizeof(int));
 222                 if (ret <= 0)
 223                         goto out;
 224                 assert(ret == sizeof(int));
 225                 ret = *(int *) buf;
 226                 assert(ret > 0);
 227                 result_shmid = ret;
 228                 ret = dispatch_result(result_shmid, result_handler,
 229                         private_result_data);
 230                 if (ret < 0 && dispatch_error >= 0)
 231                         dispatch_error = ret;
 232                 ret = shm_destroy(result_shmid);
 233                 if (ret < 0)
 234                         PARA_CRIT_LOG("destroy result failed: %s\n",
 235                                 para_strerror(-ret));
 236                 num_dispatched++;
 237         }
 238 out:
 239         if (shm_destroy(query_shmid) < 0)
 240                 PARA_CRIT_LOG("shm destroy error\n");
 241         if (fd >= 0)
 242                 close(fd);
 243         if (dispatch_error < 0)
 244                 return dispatch_error;
 245         if (ret < 0)
 246                 return ret;
 247         return num_dispatched;
 248 }
 249
 250 /**
 251  * Wrapper for send_callback_request() which passes a lopsub parse result.
 252  *
 253  * \param f The callback function.
 254  * \param cmd Needed for (de-)serialization.
 255  * \param lpr Must match cmd.
 256  * \param private_result_data Passed to send_callback_request().
 257  *
 258  * This function serializes the parse result given by the lpr pointer into a
 259  * buffer. The buffer is sent as the query to the afs process with the callback
 260  * mechanism.
 261  *
 262  * \return The return value of the underlying call to send_callback_request().
 263  */
 264 int send_lls_callback_request(afs_callback *f,
 265                 const struct lls_command * const cmd,
 266                 struct lls_parse_result *lpr, void *private_result_data)
 267 {
 268         struct osl_object query;
 269         char *buf = NULL;
 270         int ret = lls_serialize_parse_result(lpr, cmd, &buf, &query.size);
 271
 272         assert(ret >= 0);
 273         query.data = buf;
 274         ret = send_callback_request(f, &query, afs_cb_result_handler,
 275                 private_result_data);
 276         free(buf);
 277         return ret;
 278 }
 279
 280 static int action_if_pattern_matches(struct osl_row *row, void *data)
 281 {
 282         struct pattern_match_data *pmd = data;
 283         struct osl_object name_obj;
 284         const char *p, *name;
 285         int i, ret;
 286
 287         ret = osl(osl_get_object(pmd->table, row, pmd->match_col_num,
 288                 &name_obj));
 289         if (ret < 0)
 290                 return ret;
 291         name = (char *)name_obj.data;
 292         if ((!name || !*name) && (pmd->pm_flags & PM_SKIP_EMPTY_NAME))
 293                 return 1;
 294         if (lls_num_inputs(pmd->lpr) == 0) {
 295                 if (pmd->pm_flags & PM_NO_PATTERN_MATCHES_EVERYTHING) {
 296                         pmd->num_matches++;
 297                         return pmd->action(pmd->table, row, name, pmd->data);
 298                 }
 299         }
 300         i = pmd->input_skip;
 301         for (;;) {
 302                 if (i >= lls_num_inputs(pmd->lpr))
 303                         break;
 304                 p = lls_input(i, pmd->lpr);
 305                 ret = fnmatch(p, name, pmd->fnmatch_flags);
 306                 if (ret != FNM_NOMATCH) {
 307                         if (ret != 0)
 308                                 return -E_FNMATCH;
 309                         ret = pmd->action(pmd->table, row, name, pmd->data);
 310                         if (ret >= 0)
 311                                 pmd->num_matches++;
 312                         return ret;
 313
 314                 }
 315                 i++;
 316         }
 317         return 1;
 318 }
 319
 320 /**
 321  * Execute the given function for each matching row.
 322  *
 323  * \param pmd Describes what to match and how.
 324  *
 325  * \return Standard.
 326  */
 327 int for_each_matching_row(struct pattern_match_data *pmd)
 328 {
 329         if (pmd->pm_flags & PM_REVERSE_LOOP)
 330                 return osl(osl_rbtree_loop_reverse(pmd->table, pmd->loop_col_num, pmd,
 331                         action_if_pattern_matches));
 332         return osl(osl_rbtree_loop(pmd->table, pmd->loop_col_num, pmd,
 333                         action_if_pattern_matches));
 334 }
 335
 336 /**
 337  * Compare two osl objects of string type.
 338  *
 339  * \param obj1 Pointer to the first object.
 340  * \param obj2 Pointer to the second object.
 341  *
 342  * In any case, only \p MIN(obj1->size, obj2->size) characters of each string
 343  * are taken into account.
 344  *
 345  * \return It returns an integer less than, equal to, or greater than zero if
 346  * \a obj1 is found, respectively, to be less than, to match, or be greater than
 347  * obj2.
 348  *
 349  * \sa strcmp(3), strncmp(3).
 350  */
 351 int string_compare(const struct osl_object *obj1, const struct osl_object *obj2)
 352 {
 353         const char *str1 = obj1->data;
 354         const char *str2 = obj2->data;
 355         return strncmp(str1, str2, PARA_MIN(obj1->size, obj2->size));
 356 }
 357
 358 static int pass_afd(int fd, char *buf, size_t size)
 359 {
 360         struct msghdr msg = {.msg_iov = NULL};
 361         struct cmsghdr *cmsg;
 362         char control[255] __a_aligned(8);
 363         int ret;
 364         struct iovec iov;
 365
 366         iov.iov_base = buf;
 367         iov.iov_len  = size;
 368
 369         msg.msg_iov = &iov;
 370         msg.msg_iovlen = 1;
 371
 372         msg.msg_control = control;
 373         msg.msg_controllen = sizeof(control);
 374
 375         cmsg = CMSG_FIRSTHDR(&msg);
 376         cmsg->cmsg_level = SOL_SOCKET;
 377         cmsg->cmsg_type = SCM_RIGHTS;
 378         cmsg->cmsg_len = CMSG_LEN(sizeof(int));
 379         *(int *)CMSG_DATA(cmsg) = fd;
 380
 381         /* Sum of the length of all control messages in the buffer */
 382         msg.msg_controllen = cmsg->cmsg_len;
 383         PARA_DEBUG_LOG("passing %zu bytes and fd %d\n", size, fd);
 384         ret = sendmsg(server_socket, &msg, 0);
 385         if (ret < 0) {
 386                 ret = -ERRNO_TO_PARA_ERROR(errno);
 387                 return ret;
 388         }
 389         return 1;
 390 }
 391
 392 /**
 393  * Pass the fd of the next audio file to the server process.
 394  *
 395  * This stores all information for streaming the "best" audio file in a shared
 396  * memory area. The id of that area and an open file descriptor for the next
 397  * audio file are passed to the server process.
 398  *
 399  * \return Standard.
 400  *
 401  * \sa \ref open_and_update_audio_file().
 402  */
 403 static int open_next_audio_file(void)
 404 {
 405         int ret, shmid, fd;
 406         char buf[8];
 407
 408         ret = open_and_update_audio_file(&fd);
 409         if (ret < 0) {
 410                 if (ret != -OSL_ERRNO_TO_PARA_ERROR(E_OSL_RB_KEY_NOT_FOUND))
 411                         PARA_ERROR_LOG("%s\n", para_strerror(-ret));
 412                 goto no_admissible_files;
 413         }
 414         shmid = ret;
 415         if (!write_ok(server_socket)) {
 416                 ret = -E_AFS_SOCKET;
 417                 goto destroy;
 418         }
 419         *(uint32_t *)buf = NEXT_AUDIO_FILE;
 420         *(uint32_t *)(buf + 4) = (uint32_t)shmid;
 421         ret = pass_afd(fd, buf, 8);
 422         close(fd);
 423         if (ret >= 0)
 424                 return ret;
 425 destroy:
 426         shm_destroy(shmid);
 427         return ret;
 428 no_admissible_files:
 429         *(uint32_t *)buf = NO_ADMISSIBLE_FILES;
 430         *(uint32_t *)(buf + 4) = (uint32_t)0;
 431         return write_all(server_socket, buf, 8);
 432 }
 433
 434 static int activate_mood_or_playlist(const char *arg, struct para_buffer *pb)
 435 {
 436         enum play_mode mode;
 437         int ret;
 438         char *msg;
 439
 440         if (!arg) { /* load dummy mood */
 441                 ret = mood_load(NULL, NULL, &msg);
 442                 mode = PLAY_MODE_MOOD;
 443         } else if (!strncmp(arg, "p/", 2)) {
 444                 ret = playlist_load(arg + 2, NULL, &msg);
 445                 mode = PLAY_MODE_PLAYLIST;
 446         } else if (!strncmp(arg, "m/", 2)) {
 447                 ret = mood_load(arg + 2, NULL, &msg);
 448                 mode = PLAY_MODE_MOOD;
 449         } else {
 450                 ret = -ERRNO_TO_PARA_ERROR(EINVAL);
 451                 msg = make_message("%s: parse error\n", arg);
 452         }
 453         if (pb)
 454                 para_printf(pb, "%s", msg);
 455         free(msg);
 456         if (ret < 0)
 457                 return ret;
 458         current_play_mode = mode;
 459         /*
 460          * We get called with arg == current_mop from the signal dispatcher
 461          * after SIGHUP and from the error path of the select command to
 462          * re-select the current mood or playlist. In this case the assignment
 463          * to current_mop below would result in a use-after-free condition.
 464          */
 465         if (arg != current_mop) {
 466                 free(current_mop);
 467                 current_mop = arg? para_strdup(arg) : NULL;
 468         }
 469         /* Notify the server about the mood/playlist change. */
 470         mutex_lock(mmd_mutex);
 471         strncpy(mmd->afs_mode_string, arg? arg: "dummy",
 472                 sizeof(mmd->afs_mode_string));
 473         mmd->afs_mode_string[sizeof(mmd->afs_mode_string) - 1] = '\0';
 474         mmd->events++;
 475         mutex_unlock(mmd_mutex);
 476         return 1;
 477 }
 478
 479 /**
 480  * Result handler for sending data to the para_client process.
 481  *
 482  * \param result The data to be sent.
 483  * \param band The band designator.
 484  * \param private Pointer to the command context.
 485  *
 486  * \return The return value of the underlying call to \ref command.c::send_sb.
 487  *
 488  * \sa \ref callback_result_handler, \ref command.c::send_sb.
 489  */
 490 int afs_cb_result_handler(struct osl_object *result, uint8_t band,
 491                 void *private)
 492 {
 493         struct command_context *cc = private;
 494
 495         assert(cc);
 496         switch (band) {
 497         case SBD_OUTPUT:
 498         case SBD_DEBUG_LOG:
 499         case SBD_INFO_LOG:
 500         case SBD_NOTICE_LOG:
 501         case SBD_WARNING_LOG:
 502         case SBD_ERROR_LOG:
 503         case SBD_CRIT_LOG:
 504         case SBD_EMERG_LOG:
 505                 assert(result->size > 0);
 506                 return send_sb(&cc->scc, result->data, result->size, band, true);
 507         case SBD_AFS_CB_FAILURE:
 508                 return *(int *)(result->data);
 509         default:
 510                 return -E_BAD_BAND;
 511         }
 512 }
 513
 514 static void flush_and_free_pb(struct para_buffer *pb)
 515 {
 516         int ret;
 517         struct afs_max_size_handler_data *amshd = pb->private_data;
 518
 519         if (pb->buf && pb->size > 0) {
 520                 ret = pass_buffer_as_shm(amshd->fd, amshd->band, pb->buf,
 521                         pb->offset);
 522                 if (ret < 0)
 523                         PARA_ERROR_LOG("%s\n", para_strerror(-ret));
 524         }
 525         free(pb->buf);
 526 }
 527
 528 static void init_admissible_files(const char *arg)
 529 {
 530         int ret = activate_mood_or_playlist(arg, NULL);
 531         if (ret < 0) {
 532                 PARA_WARNING_LOG("could not activate %s: %s\n", arg?
 533                         arg : "dummy", para_strerror(-ret));
 534                 if (arg)
 535                         activate_mood_or_playlist(NULL, NULL);
 536         }
 537 }
 538
 539 static int setup_command_socket_or_die(void)
 540 {
 541         int ret, socket_fd;
 542         const char *socket_name = OPT_STRING_VAL(AFS_SOCKET);
 543
 544         unlink(socket_name);
 545         ret = create_local_socket(socket_name);
 546         if (ret < 0) {
 547                 PARA_EMERG_LOG("%s: %s\n", para_strerror(-ret), socket_name);
 548                 exit(EXIT_FAILURE);
 549         }
 550         socket_fd = ret;
 551         PARA_INFO_LOG("listening on socket %s (fd %d)\n", socket_name,
 552                 socket_fd);
 553         return socket_fd;
 554 }
 555
 556 static char *database_dir;
 557
 558 static void close_afs_tables(void)
 559 {
 560         int i;
 561         PARA_NOTICE_LOG("closing afs tables\n");
 562         for (i = 0; i < NUM_AFS_TABLES; i++)
 563                 afs_tables[i].ops->close();
 564         free(database_dir);
 565         database_dir = NULL;
 566 }
 567
 568 static void get_database_dir(void)
 569 {
 570         if (!database_dir) {
 571                 database_dir = OPT_GIVEN(AFS_DATABASE_DIR)?
 572                         para_strdup(OPT_STRING_VAL(AFS_DATABASE_DIR)) :
 573                         make_message("%s/afs_database-0.7", get_confdir());
 574         }
 575         PARA_INFO_LOG("afs_database dir %s\n", database_dir);
 576 }
 577
 578 static int open_afs_tables(void)
 579 {
 580         int i, ret;
 581
 582         get_database_dir();
 583         PARA_NOTICE_LOG("opening %zu osl tables in %s\n", NUM_AFS_TABLES,
 584                 database_dir);
 585         for (i = 0; i < NUM_AFS_TABLES; i++) {
 586                 ret = afs_tables[i].ops->open(database_dir);
 587                 if (ret >= 0)
 588                         continue;
 589                 PARA_ERROR_LOG("could not open %s\n", afs_tables[i].name);
 590                 break;
 591         }
 592         if (ret >= 0)
 593                 return ret;
 594         while (i)
 595                 afs_tables[--i].ops->close();
 596         return ret;
 597 }
 598
 599 static int afs_signal_post_monitor(struct sched *s, __a_unused void *context)
 600 {
 601         int signum, ret;
 602
 603         if (getppid() == 1) {
 604                 PARA_EMERG_LOG("para_server died\n");
 605                 goto shutdown;
 606         }
 607         signum = para_next_signal();
 608         if (signum == 0)
 609                 return 0;
 610         if (signum == SIGHUP) {
 611                 close_afs_tables();
 612                 parse_config_or_die(1);
 613                 ret = open_afs_tables();
 614                 if (ret < 0)
 615                         return ret;
 616                 init_admissible_files(current_mop);
 617                 return 0;
 618         }
 619         PARA_EMERG_LOG("terminating on signal %d\n", signum);
 620 shutdown:
 621         task_notify_all(s, E_AFS_SIGNAL);
 622         return -E_AFS_SIGNAL;
 623 }
 624
 625 static void register_signal_task(struct sched *s)
 626 {
 627         para_sigaction(SIGPIPE, SIG_IGN);
 628         signal_task = signal_init_or_die();
 629         para_install_sighandler(SIGINT);
 630         para_install_sighandler(SIGTERM);
 631         para_install_sighandler(SIGHUP);
 632
 633         signal_task->task = task_register(&(struct task_info) {
 634                 .name = "signal",
 635                 .pre_monitor = signal_pre_monitor,
 636                 .post_monitor = afs_signal_post_monitor,
 637                 .context = signal_task,
 638
 639         }, s);
 640 }
 641
 642 static struct list_head afs_client_list;
 643
 644 /** Describes one connected afs client. */
 645 struct afs_client {
 646         /** Position in the afs client list. */
 647         struct list_head node;
 648         /** The socket file descriptor for this client. */
 649         int fd;
 650         /** The time the client connected. */
 651         struct timeval connect_time;
 652 };
 653
 654 static void command_pre_monitor(struct sched *s, void *context)
 655 {
 656         struct command_task *ct = context;
 657         struct afs_client *client;
 658
 659         sched_monitor_readfd(server_socket, s);
 660         sched_monitor_readfd(ct->fd, s);
 661         list_for_each_entry(client, &afs_client_list, node)
 662                 sched_monitor_readfd(client->fd, s);
 663 }
 664
 665 /**
 666  * Send data as shared memory to a file descriptor.
 667  *
 668  * \param fd File descriptor to send the shmid to.
 669  * \param band The band designator for this data.
 670  * \param buf The buffer holding the data to be sent.
 671  * \param size The size of \a buf.
 672  *
 673  * This function creates a shared memory area large enough to hold
 674  * the content given by \a buf and \a size and sends the identifier
 675  * of this area to the file descriptor \a fd.
 676  *
 677  * It is called by the AFS max_size handler as well as directly by the AFS
 678  * command callbacks to send command output to the command handlers.
 679  *
 680  * \return Zero if \a buf is \p NULL or \a size is zero. Negative on errors,
 681  * and positive on success.
 682  */
 683 int pass_buffer_as_shm(int fd, uint8_t band, const char *buf, size_t size)
 684 {
 685         int ret, shmid;
 686         void *shm;
 687         struct callback_result *cr;
 688
 689         if (size == 0)
 690                 assert(band != SBD_OUTPUT);
 691         ret = shm_new(size + sizeof(*cr));
 692         if (ret < 0)
 693                 return ret;
 694         shmid = ret;
 695         ret = shm_attach(shmid, ATTACH_RW, &shm);
 696         if (ret < 0)
 697                 goto err;
 698         cr = shm;
 699         cr->result_size = size;
 700         cr->band = band;
 701         if (size > 0)
 702                 memcpy(shm + sizeof(*cr), buf, size);
 703         ret = shm_detach(shm);
 704         if (ret < 0)
 705                 goto err;
 706         ret = write_all(fd, (char *)&shmid, sizeof(int));
 707         if (ret >= 0)
 708                 return ret;
 709 err:
 710         if (shm_destroy(shmid) < 0)
 711                 PARA_ERROR_LOG("destroy result failed\n");
 712         return ret;
 713 }
 714
 715 /**
 716  * Format and send an error message to the command handler.
 717  *
 718  * To pass an error message from the callback of an afs command to the client,
 719  * this function should be called. It formats the message into a buffer which
 720  * is passed as a shared memory area to the command handler from where it
 721  * propagates to the client.
 722  *
 723  * The message will be tagged with the ERROR_LOG sideband designator so that
 724  * the client writes it to its stderr stream rather than to stdout as with
 725  * aca->pbout. In analogy to the default Unix semantics of stderr, the message
 726  * is sent without buffering.
 727  *
 728  * If sending the error message fails, an error is logged on the server side,
 729  * but no other action is taken.
 730  *
 731  * \param aca Used to obtain the fd to send the shmid to.
 732  * \param fmt Usual format string.
 733  */
 734 __printf_2_3 void afs_error(const struct afs_callback_arg *aca,
 735                 const char *fmt,...)
 736 {
 737         va_list argp;
 738         char *msg;
 739         unsigned n;
 740         int ret;
 741
 742         va_start(argp, fmt);
 743         n = xvasprintf(&msg, fmt, argp);
 744         va_end(argp);
 745         ret = pass_buffer_as_shm(aca->fd, SBD_ERROR_LOG, msg, n + 1);
 746         if (ret < 0)
 747                 PARA_ERROR_LOG("Could not send %s: %s\n", msg,
 748                         para_strerror(-ret));
 749         free(msg);
 750 }
 751
 752 static int call_callback(int fd, int query_shmid)
 753 {
 754         void *query_shm;
 755         struct callback_query *cq;
 756         int ret, ret2;
 757         struct afs_callback_arg aca = {.fd = fd};
 758
 759         ret = shm_attach(query_shmid, ATTACH_RW, &query_shm);
 760         if (ret < 0)
 761                 return ret;
 762         cq = query_shm;
 763         aca.query.data = (char *)query_shm + sizeof(*cq);
 764         aca.query.size = cq->query_size;
 765         aca.pbout.max_size = shm_get_shmmax();
 766         aca.pbout.max_size_handler = afs_max_size_handler;
 767         aca.pbout.private_data = &(struct afs_max_size_handler_data) {
 768                 .fd = fd,
 769                 .band = SBD_OUTPUT
 770         };
 771         ret = cq->cb(&aca);
 772         ret2 = shm_detach(query_shm);
 773         if (ret2 < 0) {
 774                 if (ret < 0) /* ignore (but log) detach error */
 775                         PARA_ERROR_LOG("could not detach sma: %s\n",
 776                                 para_strerror(-ret2));
 777                 else
 778                         ret = ret2;
 779         }
 780         flush_and_free_pb(&aca.pbout);
 781         if (ret < 0) {
 782                 ret2 = pass_buffer_as_shm(fd, SBD_AFS_CB_FAILURE,
 783                         (const char *)&ret, sizeof(ret));
 784                 if (ret2 < 0)
 785                         PARA_ERROR_LOG("could not pass cb failure packet: %s\n",
 786                                 para_strerror(-ret));
 787         }
 788         return ret;
 789 }
 790
 791 static int execute_server_command(void)
 792 {
 793         char buf[8];
 794         size_t n;
 795         int ret = read_nonblock(server_socket, buf, sizeof(buf) - 1, &n);
 796
 797         if (ret < 0 || n == 0)
 798                 return ret;
 799         buf[n] = '\0';
 800         if (strcmp(buf, "new"))
 801                 return -ERRNO_TO_PARA_ERROR(EINVAL);
 802         return open_next_audio_file();
 803 }
 804
 805 /* returns 0 if no data available, 1 else */
 806 static int execute_afs_command(int fd)
 807 {
 808         uint32_t cookie;
 809         int query_shmid;
 810         char buf[sizeof(cookie) + sizeof(query_shmid)];
 811         size_t n;
 812         int ret = read_nonblock(fd, buf, sizeof(buf), &n);
 813
 814         if (ret < 0)
 815                 goto err;
 816         if (n == 0)
 817                 return 0;
 818         if (n != sizeof(buf)) {
 819                 PARA_NOTICE_LOG("short read (%d bytes, expected %lu)\n",
 820                         ret, (long unsigned) sizeof(buf));
 821                 return 1;
 822         }
 823         cookie = *(uint32_t *)buf;
 824         if (cookie != afs_socket_cookie) {
 825                 PARA_NOTICE_LOG("received invalid cookie (got %u, expected %u)\n",
 826                         (unsigned)cookie, (unsigned)afs_socket_cookie);
 827                 return 1;
 828         }
 829         query_shmid = *(int *)(buf + sizeof(cookie));
 830         if (query_shmid < 0) {
 831                 PARA_WARNING_LOG("received invalid query shmid %d)\n",
 832                         query_shmid);
 833                 return 1;
 834         }
 835         ret = call_callback(fd, query_shmid);
 836         if (ret >= 0)
 837                 return 1;
 838 err:
 839         PARA_NOTICE_LOG("%s\n", para_strerror(-ret));
 840         return 1;
 841 }
 842
 843 /** Shutdown connection if query has not arrived until this many seconds. */
 844 #define AFS_CLIENT_TIMEOUT 3
 845
 846 static int command_post_monitor(struct sched *s, void *context)
 847 {
 848         struct command_task *ct = context;
 849         struct sockaddr_un unix_addr;
 850         struct afs_client *client, *tmp;
 851         int fd, ret;
 852
 853         ret = task_get_notification(ct->task);
 854         if (ret < 0)
 855                 return ret;
 856         ret = execute_server_command();
 857         if (ret < 0) {
 858                 PARA_EMERG_LOG("%s\n", para_strerror(-ret));
 859                 task_notify_all(s, -ret);
 860                 return ret;
 861         }
 862         /* Check the list of connected clients. */
 863         list_for_each_entry_safe(client, tmp, &afs_client_list, node) {
 864                 ret = execute_afs_command(client->fd);
 865                 if (ret == 0) { /* prevent bogus connection flooding */
 866                         struct timeval diff;
 867                         tv_diff(now, &client->connect_time, &diff);
 868                         if (diff.tv_sec < AFS_CLIENT_TIMEOUT)
 869                                 continue;
 870                         PARA_WARNING_LOG("connection timeout\n");
 871                 }
 872                 close(client->fd);
 873                 list_del(&client->node);
 874                 free(client);
 875         }
 876         /* Accept connections on the local socket. */
 877         ret = para_accept(ct->fd, &unix_addr, sizeof(unix_addr), &fd);
 878         if (ret < 0)
 879                 PARA_NOTICE_LOG("%s\n", para_strerror(-ret));
 880         if (ret <= 0)
 881                 return 0;
 882         ret = mark_fd_nonblocking(fd);
 883         if (ret < 0) {
 884                 PARA_NOTICE_LOG("%s\n", para_strerror(-ret));
 885                 close(fd);
 886                 return 0;
 887         }
 888         client = alloc(sizeof(*client));
 889         client->fd = fd;
 890         client->connect_time = *now;
 891         para_list_add(&client->node, &afs_client_list);
 892         return 0;
 893 }
 894
 895 static void register_command_task(struct sched *s)
 896 {
 897         struct command_task *ct = &command_task_struct;
 898         ct->fd = setup_command_socket_or_die();
 899
 900         ct->task = task_register(&(struct task_info) {
 901                 .name = "afs command",
 902                 .pre_monitor = command_pre_monitor,
 903                 .post_monitor = command_post_monitor,
 904                 .context = ct,
 905         }, s);
 906 }
 907
 908 static int afs_poll(struct pollfd *fds, nfds_t nfds, int timeout)
 909 {
 910         mutex_lock(mmd_mutex);
 911         daemon_set_loglevel(mmd->loglevel);
 912         mutex_unlock(mmd_mutex);
 913         return xpoll(fds, nfds, timeout);
 914 }
 915
 916 /**
 917  * Initialize the audio file selector process.
 918  *
 919  * \param socket_fd File descriptor used for communication with the server.
 920  */
 921 __noreturn void afs_init(int socket_fd)
 922 {
 923         static struct sched s;
 924         int ret;
 925
 926         register_signal_task(&s);
 927         init_list_head(&afs_client_list);
 928         ret = open_afs_tables();
 929         if (ret < 0)
 930                 goto out;
 931         server_socket = socket_fd;
 932         ret = mark_fd_nonblocking(server_socket);
 933         if (ret < 0)
 934                 goto out_close;
 935         PARA_INFO_LOG("server_socket: %d\n", server_socket);
 936         init_admissible_files(OPT_STRING_VAL(AFS_INITIAL_MODE));
 937         register_command_task(&s);
 938         s.default_timeout = 1000;
 939         s.poll_function = afs_poll;
 940         ret = write(socket_fd, "\0", 1);
 941         if (ret != 1) {
 942                 if (ret == 0)
 943                         errno = EINVAL;
 944                 ret = -ERRNO_TO_PARA_ERROR(errno);
 945                 goto out_close;
 946         }
 947         ret = schedule(&s);
 948         sched_shutdown(&s);
 949         mood_unload(NULL);
 950         playlist_unload(NULL);
 951 out_close:
 952         close_afs_tables();
 953 out:
 954         signal_shutdown(signal_task);
 955         free_status_items();
 956         free(current_mop);
 957         free_lpr();
 958         if (ret < 0)
 959                 PARA_EMERG_LOG("%s\n", para_strerror(-ret));
 960         exit(EXIT_FAILURE);
 961 }
 962
 963 static int com_select_callback(struct afs_callback_arg *aca)
 964 {
 965         const struct lls_command *cmd = SERVER_CMD_CMD_PTR(SELECT);
 966         const char *arg;
 967         int ret;
 968         struct para_buffer *pbout;
 969
 970         ret = lls_deserialize_parse_result(aca->query.data, cmd, &aca->lpr);
 971         assert(ret >= 0);
 972         arg = lls_input(0, aca->lpr);
 973         pbout = SERVER_CMD_OPT_GIVEN(SELECT, VERBOSE, aca->lpr)?
 974                 &aca->pbout : NULL;
 975         score_clear();
 976         if (current_play_mode == PLAY_MODE_MOOD)
 977                 mood_unload(NULL);
 978         else
 979                 playlist_unload(NULL);
 980         ret = activate_mood_or_playlist(arg, pbout);
 981         if (ret >= 0)
 982                 goto free_lpr;
 983         /* ignore subsequent errors (but log them) */
 984         if (current_mop && strcmp(current_mop, arg) != 0) {
 985                 int ret2;
 986                 afs_error(aca, "switching back to %s\n", current_mop);
 987                 ret2 = activate_mood_or_playlist(current_mop, pbout);
 988                 if (ret2 >= 0)
 989                         goto free_lpr;
 990                 afs_error(aca, "could not reactivate %s: %s\n", current_mop,
 991                         para_strerror(-ret2));
 992         }
 993         activate_mood_or_playlist(NULL, pbout);
 994 free_lpr:
 995         lls_free_parse_result(aca->lpr, cmd);
 996         return ret;
 997 }
 998
 999 static int com_select(struct command_context *cc, struct lls_parse_result *lpr)
1000 {
1001         const struct lls_command *cmd = SERVER_CMD_CMD_PTR(SELECT);
1002         char *errctx;
1003         int ret = lls(lls_check_arg_count(lpr, 1, 1, &errctx));
1004
1005         if (ret < 0) {
1006                 send_errctx(cc, errctx);
1007                 return ret;
1008         }
1009         ret = send_lls_callback_request(com_select_callback, cmd, lpr, cc);
1010         return ret == osl(-E_OSL_RB_KEY_NOT_FOUND)? -E_BAD_MOP : ret;
1011 }
1012 EXPORT_SERVER_CMD_HANDLER(select);
1013
1014 static int com_init_callback(struct afs_callback_arg *aca)
1015 {
1016         uint32_t table_mask = *(uint32_t *)aca->query.data;
1017         int i, ret;
1018
1019         close_afs_tables();
1020         get_database_dir();
1021         for (i = 0; i < NUM_AFS_TABLES; i++) {
1022                 const struct afs_table *t = afs_tables + i;
1023
1024                 if (!(table_mask & (1 << i)))
1025                         continue;
1026                 if (!t->ops->create)
1027                         continue;
1028                 ret = t->ops->create(database_dir);
1029                 if (ret < 0) {
1030                         afs_error(aca, "cannot create table %s\n", t->name);
1031                         goto out;
1032                 }
1033                 para_printf(&aca->pbout, "successfully created %s table\n",
1034                         t->name);
1035         }
1036         ret = open_afs_tables();
1037         if (ret < 0)
1038                 afs_error(aca, "cannot open afs tables: %s\n",
1039                         para_strerror(-ret));
1040 out:
1041         return ret;
1042 }
1043
1044 static int com_init(struct command_context *cc, struct lls_parse_result *lpr)
1045 {
1046         int i, j, ret;
1047         uint32_t table_mask = (1 << (NUM_AFS_TABLES + 1)) - 1;
1048         struct osl_object query = {.data = &table_mask,
1049                 .size = sizeof(table_mask)};
1050         unsigned num_inputs = lls_num_inputs(lpr);
1051
1052         get_database_dir();
1053         ret = para_mkdir(database_dir);
1054         if (ret < 0)
1055                 return ret;
1056         if (num_inputs > 0) {
1057                 table_mask = 0;
1058                 for (i = 0; i < num_inputs; i++) {
1059                         for (j = 0; j < NUM_AFS_TABLES; j++) {
1060                                 const struct afs_table *t = afs_tables + j;
1061
1062                                 if (strcmp(lls_input(i, lpr), t->name))
1063                                         continue;
1064                                 table_mask |= (1 << j);
1065                                 break;
1066                         }
1067                         if (j == NUM_AFS_TABLES)
1068                                 return -E_BAD_TABLE_NAME;
1069                 }
1070         }
1071         return send_callback_request(com_init_callback, &query,
1072                 afs_cb_result_handler, cc);
1073 }
1074 EXPORT_SERVER_CMD_HANDLER(init);
1075
1076 static int com_check(struct command_context *cc, struct lls_parse_result *lpr)
1077 {
1078         const struct lls_opt_result *r_a = SERVER_CMD_OPT_RESULT(CHECK, AFT, lpr);
1079         const struct lls_opt_result *r_A = SERVER_CMD_OPT_RESULT(CHECK, ATTRIBUTE, lpr);
1080         const struct lls_opt_result *r_m = SERVER_CMD_OPT_RESULT(CHECK, MOOD, lpr);
1081         const struct lls_opt_result *r_p = SERVER_CMD_OPT_RESULT(CHECK, PLAYLIST, lpr);
1082         bool noopt = !lls_opt_given(r_a) && !lls_opt_given(r_A)
1083                 && !lls_opt_given(r_m) && !lls_opt_given(r_p);
1084         int ret;
1085
1086         if (noopt || lls_opt_given(r_a)) {
1087                 ret = send_callback_request(aft_check_callback, NULL,
1088                         afs_cb_result_handler, cc);
1089                 if (ret < 0)
1090                         return ret;
1091         }
1092         if (noopt || lls_opt_given(r_A)) {
1093                 ret = send_callback_request(attribute_check_callback, NULL,
1094                         afs_cb_result_handler, cc);
1095                 if (ret < 0)
1096                         return ret;
1097         }
1098         if (noopt || lls_opt_given(r_p)) {
1099                 ret = send_callback_request(playlist_check_callback,
1100                         NULL, afs_cb_result_handler, cc);
1101                 if (ret < 0)
1102                         return ret;
1103         }
1104         if (noopt || lls_opt_given(r_m)) {
1105                 ret = send_callback_request(mood_check_callback, NULL,
1106                         afs_cb_result_handler, cc);
1107                 if (ret < 0)
1108                         return ret;
1109         }
1110         return 1;
1111 }
1112 EXPORT_SERVER_CMD_HANDLER(check);
1113
1114 /**
1115  * The afs event dispatcher.
1116  *
1117  * \param event Type of the event.
1118  * \param pb May be \p NULL.
1119  * \param data Type depends on \a event.
1120  *
1121  * This function calls each table event handler, passing \a pb and \a data
1122  * verbatim. It's up to the handlers to interpret the \a data pointer. If a
1123  * handler returns negative, the loop is aborted.
1124  *
1125  * \return The (negative) error code of the first handler that failed, or non-negative
1126  * if all handlers succeeded.
1127  */
1128 __must_check int afs_event(enum afs_events event, struct para_buffer *pb,
1129                 void *data)
1130 {
1131         int i, ret;
1132
1133         for (i = 0; i < NUM_AFS_TABLES; i++) {
1134                 const struct afs_table *t = afs_tables + i;
1135                 if (!t->ops->event_handler)
1136                         continue;
1137                 ret = t->ops->event_handler(event, pb, data);
1138                 if (ret < 0) {
1139                         PARA_CRIT_LOG("table %s, event %u: %s\n", t->name,
1140                                 event, para_strerror(-ret));
1141                         return ret;
1142                 }
1143         }
1144         return 1;
1145 }
1146
1147 /**
1148  * Dummy event handler for the images table.
1149  *
1150  * \param event Unused.
1151  * \param pb Unused.
1152  * \param data Unused.
1153  *
1154  * \return The images table does not honor events, so this handler always
1155  * returns success.
1156  */
1157 __a_const int images_event_handler(__a_unused enum afs_events event,
1158         __a_unused  struct para_buffer *pb, __a_unused void *data)
1159 {
1160         return 1;
1161 }
1162
1163 /**
1164  * Dummy event handler for the lyrics table.
1165  *
1166  * \param event Unused.
1167  * \param pb Unused.
1168  * \param data Unused.
1169  *
1170  * \return The lyrics table does not honor events, so this handler always
1171  * returns success.
1172  */
1173 __a_const int lyrics_event_handler(__a_unused enum afs_events event,
1174         __a_unused struct para_buffer *pb, __a_unused void *data)
1175 {
1176         return 1;
1177 }