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