afs.c

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