afs.c

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