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 "ipc.h"
  28 #include "list.h"
  29 #include "sched.h"
  30 #include "fd.h"
  31 #include "signal.h"
  32 #include "mood.h"
  33 #include "sideband.h"
  34 #include "command.h"
  35
  36 /** The osl tables used by afs. \sa \ref blob.c. */
  37 enum afs_table_num {
  38         /** Contains audio file information. See \ref aft.c. */
  39         TBLNUM_AUDIO_FILES,
  40         /** The table for the paraslash attributes. See \ref attribute.c. */
  41         TBLNUM_ATTRIBUTES,
  42         /**
  43          * Paraslash's scoring system is based on Gaussian normal
  44          * distributions, and the relevant data is stored in the rbtrees of an
  45          * osl table containing only volatile columns. See \ref score.c for
  46          * details.
  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  * Struct to let command handlers execute a callback in afs context.
  95  *
  96  * Commands that need to change the state of afs can't change the relevant data
  97  * structures directly because commands are executed in a child process, i.e.
  98  * they get their own virtual address space.
  99  *
 100  * This structure is used by \p send_callback_request() (executed from handler
 101  * context) in order to let the afs process call the specified function. An
 102  * instance of that structure is written to a shared memory area together with
 103  * the arguments to the callback function. The identifier of the shared memory
 104  * area is written to the command socket.
 105  *
 106  * The afs process accepts connections on the command socket and reads the
 107  * shared memory id, attaches the corresponding area, calls the given handler to
 108  * perform the desired action and to optionally compute a result.
 109  *
 110  * The result and a \p callback_result structure is then written to another
 111  * shared memory area. The identifier for that area is written to the handler's
 112  * command socket, so that the handler process can read the id, attach the
 113  * shared memory area and use the result.
 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         if (arg != current_mop) {
 486                 free(current_mop);
 487                 if (arg) {
 488                         current_mop = para_strdup(arg);
 489                         mutex_lock(mmd_mutex);
 490                         strncpy(mmd->afs_mode_string, arg,
 491                                 sizeof(mmd->afs_mode_string));
 492                         mmd->afs_mode_string[sizeof(mmd->afs_mode_string) - 1] = '\0';
 493                         mmd->events++;
 494                         mutex_unlock(mmd_mutex);
 495                 } else {
 496                         mutex_lock(mmd_mutex);
 497                         strcpy(mmd->afs_mode_string, "dummy");
 498                         mmd->events++;
 499                         mutex_unlock(mmd_mutex);
 500                         current_mop = NULL;
 501                 }
 502         }
 503         return 1;
 504 }
 505
 506 /**
 507  * Result handler for sending data to the para_client process.
 508  *
 509  * \param result The data to be sent.
 510  * \param band The band designator.
 511  * \param private Pointer to the command context.
 512  *
 513  * \return The return value of the underlying call to \ref command.c::send_sb.
 514  *
 515  * \sa \ref callback_result_handler, \ref command.c::send_sb.
 516  */
 517 int afs_cb_result_handler(struct osl_object *result, uint8_t band,
 518                 void *private)
 519 {
 520         struct command_context *cc = private;
 521
 522         assert(cc);
 523         switch (band) {
 524         case SBD_OUTPUT:
 525         case SBD_DEBUG_LOG:
 526         case SBD_INFO_LOG:
 527         case SBD_NOTICE_LOG:
 528         case SBD_WARNING_LOG:
 529         case SBD_ERROR_LOG:
 530         case SBD_CRIT_LOG:
 531         case SBD_EMERG_LOG:
 532                 assert(result->size > 0);
 533                 return send_sb(&cc->scc, result->data, result->size, band, true);
 534         case SBD_AFS_CB_FAILURE:
 535                 return *(int *)(result->data);
 536         default:
 537                 return -E_BAD_BAND;
 538         }
 539 }
 540
 541 static void flush_and_free_pb(struct para_buffer *pb)
 542 {
 543         int ret;
 544         struct afs_max_size_handler_data *amshd = pb->private_data;
 545
 546         if (pb->buf && pb->size > 0) {
 547                 ret = pass_buffer_as_shm(amshd->fd, amshd->band, pb->buf,
 548                         pb->offset);
 549                 if (ret < 0)
 550                         PARA_ERROR_LOG("%s\n", para_strerror(-ret));
 551         }
 552         free(pb->buf);
 553 }
 554
 555 static int com_select_callback(struct afs_callback_arg *aca)
 556 {
 557         const struct lls_command *cmd = SERVER_CMD_CMD_PTR(SELECT);
 558         const char *arg;
 559         int num_admissible, ret;
 560         char *errmsg;
 561
 562         ret = lls_deserialize_parse_result(aca->query.data, cmd, &aca->lpr);
 563         assert(ret >= 0);
 564         arg = lls_input(0, aca->lpr);
 565         ret = clear_score_table();
 566         if (ret < 0) {
 567                 para_printf(&aca->pbout, "could not clear score table\n");
 568                 goto free_lpr;
 569         }
 570         if (current_play_mode == PLAY_MODE_MOOD)
 571                 close_current_mood();
 572         else
 573                 playlist_close();
 574         ret = activate_mood_or_playlist(arg, &num_admissible, &errmsg);
 575         if (ret >= 0)
 576                 goto out;
 577         /* ignore subsequent errors (but log them) */
 578         para_printf(&aca->pbout, "%s\n", errmsg);
 579         free(errmsg);
 580         para_printf(&aca->pbout, "could not activate %s\n", arg);
 581         if (current_mop && strcmp(current_mop, arg) != 0) {
 582                 int ret2;
 583                 para_printf(&aca->pbout, "switching back to %s\n", current_mop);
 584                 ret2 = activate_mood_or_playlist(current_mop, &num_admissible,
 585                         &errmsg);
 586                 if (ret2 >= 0)
 587                         goto out;
 588                 para_printf(&aca->pbout, "%s\n", errmsg);
 589                 free(errmsg);
 590                 para_printf(&aca->pbout, "could not reactivate %s: %s\n",
 591                         current_mop, para_strerror(-ret2));
 592         }
 593         para_printf(&aca->pbout, "activating dummy mood\n");
 594         activate_mood_or_playlist(NULL, &num_admissible, NULL);
 595 out:
 596         para_printf(&aca->pbout, "activated %s (%d admissible file%s)\n",
 597                 current_mop? current_mop : "dummy mood", num_admissible,
 598                         num_admissible == 1? "" : "s");
 599 free_lpr:
 600         lls_free_parse_result(aca->lpr, cmd);
 601         return ret;
 602 }
 603
 604 static int com_select(struct command_context *cc, struct lls_parse_result *lpr)
 605 {
 606         const struct lls_command *cmd = SERVER_CMD_CMD_PTR(SELECT);
 607         char *errctx;
 608         int ret = lls(lls_check_arg_count(lpr, 1, 1, &errctx));
 609
 610         if (ret < 0) {
 611                 send_errctx(cc, errctx);
 612                 return ret;
 613         }
 614         return send_lls_callback_request(com_select_callback, cmd, lpr, cc);
 615 }
 616 EXPORT_SERVER_CMD_HANDLER(select);
 617
 618 static void init_admissible_files(const char *arg)
 619 {
 620         int ret = activate_mood_or_playlist(arg, NULL, NULL);
 621         if (ret < 0) {
 622                 PARA_WARNING_LOG("could not activate %s: %s\n", arg,
 623                         para_strerror(-ret));
 624                 if (arg)
 625                         activate_mood_or_playlist(NULL, NULL, NULL);
 626         }
 627 }
 628
 629 static int setup_command_socket_or_die(void)
 630 {
 631         int ret, socket_fd;
 632         const char *socket_name = OPT_STRING_VAL(AFS_SOCKET);
 633
 634         unlink(socket_name);
 635         ret = create_local_socket(socket_name);
 636         if (ret < 0) {
 637                 PARA_EMERG_LOG("%s: %s\n", para_strerror(-ret), socket_name);
 638                 exit(EXIT_FAILURE);
 639         }
 640         socket_fd = ret;
 641         PARA_INFO_LOG("listening on socket %s (fd %d)\n", socket_name,
 642                 socket_fd);
 643         return socket_fd;
 644 }
 645
 646 static char *database_dir;
 647
 648 static void close_afs_tables(void)
 649 {
 650         int i;
 651         PARA_NOTICE_LOG("closing afs_tables\n");
 652         for (i = 0; i < NUM_AFS_TABLES; i++)
 653                 afs_tables[i].close();
 654         free(database_dir);
 655         database_dir = NULL;
 656 }
 657
 658 static void get_database_dir(void)
 659 {
 660         if (!database_dir) {
 661                 if (OPT_GIVEN(AFS_DATABASE_DIR))
 662                         database_dir = para_strdup(OPT_STRING_VAL(AFS_DATABASE_DIR));
 663                 else {
 664                         char *home = para_homedir();
 665                         database_dir = make_message(
 666                                 "%s/.paraslash/afs_database-0.4", home);
 667                         free(home);
 668                 }
 669         }
 670         PARA_INFO_LOG("afs_database dir %s\n", database_dir);
 671 }
 672
 673 static int make_database_dir(void)
 674 {
 675         int ret;
 676
 677         get_database_dir();
 678         ret = para_mkdir(database_dir, 0777);
 679         if (ret >= 0 || ret == -ERRNO_TO_PARA_ERROR(EEXIST))
 680                 return 1;
 681         return ret;
 682 }
 683
 684 static int open_afs_tables(void)
 685 {
 686         int i, ret;
 687
 688         get_database_dir();
 689         PARA_NOTICE_LOG("opening %d osl tables in %s\n", NUM_AFS_TABLES,
 690                 database_dir);
 691         for (i = 0; i < NUM_AFS_TABLES; i++) {
 692                 ret = afs_tables[i].open(database_dir);
 693                 if (ret >= 0)
 694                         continue;
 695                 PARA_ERROR_LOG("could not open %s\n", afs_tables[i].name);
 696                 break;
 697         }
 698         if (ret >= 0)
 699                 return ret;
 700         while (i)
 701                 afs_tables[--i].close();
 702         return ret;
 703 }
 704
 705 static int afs_signal_post_select(struct sched *s, __a_unused void *context)
 706 {
 707         int signum, ret;
 708
 709         if (getppid() == 1) {
 710                 PARA_EMERG_LOG("para_server died\n");
 711                 goto shutdown;
 712         }
 713         signum = para_next_signal(&s->rfds);
 714         if (signum == 0)
 715                 return 0;
 716         if (signum == SIGHUP) {
 717                 close_afs_tables();
 718                 parse_config_or_die(1);
 719                 ret = open_afs_tables();
 720                 if (ret < 0)
 721                         return ret;
 722                 init_admissible_files(current_mop);
 723                 return 0;
 724         }
 725         PARA_EMERG_LOG("terminating on signal %d\n", signum);
 726 shutdown:
 727         task_notify_all(s, E_AFS_SIGNAL);
 728         return -E_AFS_SIGNAL;
 729 }
 730
 731 static void register_signal_task(struct sched *s)
 732 {
 733         para_sigaction(SIGPIPE, SIG_IGN);
 734         signal_task = signal_init_or_die();
 735         para_install_sighandler(SIGINT);
 736         para_install_sighandler(SIGTERM);
 737         para_install_sighandler(SIGHUP);
 738
 739         signal_task->task = task_register(&(struct task_info) {
 740                 .name = "signal",
 741                 .pre_select = signal_pre_select,
 742                 .post_select = afs_signal_post_select,
 743                 .context = signal_task,
 744
 745         }, s);
 746 }
 747
 748 static struct list_head afs_client_list;
 749
 750 /** Describes one connected afs client. */
 751 struct afs_client {
 752         /** Position in the afs client list. */
 753         struct list_head node;
 754         /** The socket file descriptor for this client. */
 755         int fd;
 756         /** The time the client connected. */
 757         struct timeval connect_time;
 758 };
 759
 760 static void command_pre_select(struct sched *s, void *context)
 761 {
 762         struct command_task *ct = context;
 763         struct afs_client *client;
 764
 765         para_fd_set(server_socket, &s->rfds, &s->max_fileno);
 766         para_fd_set(ct->fd, &s->rfds, &s->max_fileno);
 767         list_for_each_entry(client, &afs_client_list, node)
 768                 para_fd_set(client->fd, &s->rfds, &s->max_fileno);
 769 }
 770
 771 /**
 772  * Send data as shared memory to a file descriptor.
 773  *
 774  * \param fd File descriptor to send the shmid to.
 775  * \param band The band designator for this data.
 776  * \param buf The buffer holding the data to be sent.
 777  * \param size The size of \a buf.
 778  *
 779  * This function creates a shared memory area large enough to hold
 780  * the content given by \a buf and \a size and sends the identifier
 781  * of this area to the file descriptor \a fd.
 782  *
 783  * It is called by the AFS max_size handler as well as directly by the AFS
 784  * command callbacks to send command output to the command handlers.
 785  *
 786  * \return Zero if \a buf is \p NULL or \a size is zero. Negative on errors,
 787  * and positive on success.
 788  */
 789 int pass_buffer_as_shm(int fd, uint8_t band, const char *buf, size_t size)
 790 {
 791         int ret, shmid;
 792         void *shm;
 793         struct callback_result *cr;
 794
 795         if (size == 0)
 796                 assert(band != SBD_OUTPUT);
 797         ret = shm_new(size + sizeof(*cr));
 798         if (ret < 0)
 799                 return ret;
 800         shmid = ret;
 801         ret = shm_attach(shmid, ATTACH_RW, &shm);
 802         if (ret < 0)
 803                 goto err;
 804         cr = shm;
 805         cr->result_size = size;
 806         cr->band = band;
 807         if (size > 0)
 808                 memcpy(shm + sizeof(*cr), buf, size);
 809         ret = shm_detach(shm);
 810         if (ret < 0)
 811                 goto err;
 812         ret = write_all(fd, (char *)&shmid, sizeof(int));
 813         if (ret >= 0)
 814                 return ret;
 815 err:
 816         if (shm_destroy(shmid) < 0)
 817                 PARA_ERROR_LOG("destroy result failed\n");
 818         return ret;
 819 }
 820
 821 static int call_callback(int fd, int query_shmid)
 822 {
 823         void *query_shm;
 824         struct callback_query *cq;
 825         int ret, ret2;
 826         struct afs_callback_arg aca = {.fd = fd};
 827
 828         ret = shm_attach(query_shmid, ATTACH_RW, &query_shm);
 829         if (ret < 0)
 830                 return ret;
 831         cq = query_shm;
 832         aca.query.data = (char *)query_shm + sizeof(*cq);
 833         aca.query.size = cq->query_size;
 834         aca.pbout.max_size = shm_get_shmmax();
 835         aca.pbout.max_size_handler = afs_max_size_handler;
 836         aca.pbout.private_data = &(struct afs_max_size_handler_data) {
 837                 .fd = fd,
 838                 .band = SBD_OUTPUT
 839         };
 840         ret = cq->handler(&aca);
 841         ret2 = shm_detach(query_shm);
 842         if (ret2 < 0) {
 843                 if (ret < 0) /* ignore (but log) detach error */
 844                         PARA_ERROR_LOG("could not detach sma: %s\n",
 845                                 para_strerror(-ret2));
 846                 else
 847                         ret = ret2;
 848         }
 849         flush_and_free_pb(&aca.pbout);
 850         if (ret < 0) {
 851                 ret2 = pass_buffer_as_shm(fd, SBD_AFS_CB_FAILURE,
 852                         (const char *)&ret, sizeof(ret));
 853                 if (ret2 < 0)
 854                         PARA_ERROR_LOG("could not pass cb failure packet: %s\n",
 855                                 para_strerror(-ret));
 856         }
 857         return ret;
 858 }
 859
 860 static int execute_server_command(fd_set *rfds)
 861 {
 862         char buf[8];
 863         size_t n;
 864         int ret = read_nonblock(server_socket, buf, sizeof(buf) - 1, rfds, &n);
 865
 866         if (ret < 0 || n == 0)
 867                 return ret;
 868         buf[n] = '\0';
 869         if (strcmp(buf, "new"))
 870                 return -ERRNO_TO_PARA_ERROR(EINVAL);
 871         return open_next_audio_file();
 872 }
 873
 874 /* returns 0 if no data available, 1 else */
 875 static int execute_afs_command(int fd, fd_set *rfds)
 876 {
 877         uint32_t cookie;
 878         int query_shmid;
 879         char buf[sizeof(cookie) + sizeof(query_shmid)];
 880         size_t n;
 881         int ret = read_nonblock(fd, buf, sizeof(buf), rfds, &n);
 882
 883         if (ret < 0)
 884                 goto err;
 885         if (n == 0)
 886                 return 0;
 887         if (n != sizeof(buf)) {
 888                 PARA_NOTICE_LOG("short read (%d bytes, expected %lu)\n",
 889                         ret, (long unsigned) sizeof(buf));
 890                 return 1;
 891         }
 892         cookie = *(uint32_t *)buf;
 893         if (cookie != afs_socket_cookie) {
 894                 PARA_NOTICE_LOG("received invalid cookie (got %u, expected %u)\n",
 895                         (unsigned)cookie, (unsigned)afs_socket_cookie);
 896                 return 1;
 897         }
 898         query_shmid = *(int *)(buf + sizeof(cookie));
 899         if (query_shmid < 0) {
 900                 PARA_WARNING_LOG("received invalid query shmid %d)\n",
 901                         query_shmid);
 902                 return 1;
 903         }
 904         ret = call_callback(fd, query_shmid);
 905         if (ret >= 0)
 906                 return 1;
 907 err:
 908         PARA_NOTICE_LOG("%s\n", para_strerror(-ret));
 909         return 1;
 910 }
 911
 912 /** Shutdown connection if query has not arrived until this many seconds. */
 913 #define AFS_CLIENT_TIMEOUT 3
 914
 915 static int command_post_select(struct sched *s, void *context)
 916 {
 917         struct command_task *ct = context;
 918         struct sockaddr_un unix_addr;
 919         struct afs_client *client, *tmp;
 920         int fd, ret;
 921
 922         ret = task_get_notification(ct->task);
 923         if (ret < 0)
 924                 return ret;
 925         ret = execute_server_command(&s->rfds);
 926         if (ret < 0) {
 927                 PARA_EMERG_LOG("%s\n", para_strerror(-ret));
 928                 task_notify_all(s, -ret);
 929                 return ret;
 930         }
 931         /* Check the list of connected clients. */
 932         list_for_each_entry_safe(client, tmp, &afs_client_list, node) {
 933                 ret = execute_afs_command(client->fd, &s->rfds);
 934                 if (ret == 0) { /* prevent bogus connection flooding */
 935                         struct timeval diff;
 936                         tv_diff(now, &client->connect_time, &diff);
 937                         if (diff.tv_sec < AFS_CLIENT_TIMEOUT)
 938                                 continue;
 939                         PARA_WARNING_LOG("connection timeout\n");
 940                 }
 941                 close(client->fd);
 942                 list_del(&client->node);
 943                 free(client);
 944         }
 945         /* Accept connections on the local socket. */
 946         ret = para_accept(ct->fd, &s->rfds, &unix_addr, sizeof(unix_addr), &fd);
 947         if (ret < 0)
 948                 PARA_NOTICE_LOG("%s\n", para_strerror(-ret));
 949         if (ret <= 0)
 950                 return 0;
 951         ret = mark_fd_nonblocking(fd);
 952         if (ret < 0) {
 953                 PARA_NOTICE_LOG("%s\n", para_strerror(-ret));
 954                 close(fd);
 955                 return 0;
 956         }
 957         client = para_malloc(sizeof(*client));
 958         client->fd = fd;
 959         client->connect_time = *now;
 960         para_list_add(&client->node, &afs_client_list);
 961         return 0;
 962 }
 963
 964 static void register_command_task(struct sched *s)
 965 {
 966         struct command_task *ct = &command_task_struct;
 967         ct->fd = setup_command_socket_or_die();
 968
 969         ct->task = task_register(&(struct task_info) {
 970                 .name = "afs command",
 971                 .pre_select = command_pre_select,
 972                 .post_select = command_post_select,
 973                 .context = ct,
 974         }, s);
 975 }
 976
 977 /**
 978  * Initialize the audio file selector process.
 979  *
 980  * \param socket_fd File descriptor used for communication with the server.
 981  */
 982 __noreturn void afs_init(int socket_fd)
 983 {
 984         static struct sched s;
 985         int i, ret;
 986
 987         register_signal_task(&s);
 988         INIT_LIST_HEAD(&afs_client_list);
 989         for (i = 0; i < NUM_AFS_TABLES; i++)
 990                 afs_tables[i].init(&afs_tables[i]);
 991         ret = open_afs_tables();
 992         if (ret < 0)
 993                 goto out;
 994         server_socket = socket_fd;
 995         ret = mark_fd_nonblocking(server_socket);
 996         if (ret < 0)
 997                 goto out_close;
 998         PARA_INFO_LOG("server_socket: %d\n", server_socket);
 999         init_admissible_files(OPT_STRING_VAL(AFS_INITIAL_MODE));
1000         register_command_task(&s);
1001         s.default_timeout.tv_sec = 0;
1002         s.default_timeout.tv_usec = 999 * 1000;
1003         ret = write(socket_fd, "\0", 1);
1004         if (ret != 1) {
1005                 if (ret == 0)
1006                         errno = EINVAL;
1007                 ret = -ERRNO_TO_PARA_ERROR(errno);
1008                 goto out_close;
1009         }
1010         ret = schedule(&s);
1011         sched_shutdown(&s);
1012         close_current_mood();
1013 out_close:
1014         close_afs_tables();
1015 out:
1016         signal_shutdown(signal_task);
1017         free_status_items();
1018         free(current_mop);
1019         free_lpr();
1020         if (ret < 0)
1021                 PARA_EMERG_LOG("%s\n", para_strerror(-ret));
1022         exit(EXIT_FAILURE);
1023 }
1024
1025 static int com_init_callback(struct afs_callback_arg *aca)
1026 {
1027         uint32_t table_mask = *(uint32_t *)aca->query.data;
1028         int i, ret;
1029
1030         close_afs_tables();
1031         get_database_dir();
1032         for (i = 0; i < NUM_AFS_TABLES; i++) {
1033                 struct afs_table *t = &afs_tables[i];
1034
1035                 if (!(table_mask & (1 << i)))
1036                         continue;
1037                 if (!t->create)
1038                         continue;
1039                 ret = t->create(database_dir);
1040                 if (ret < 0) {
1041                         para_printf(&aca->pbout, "cannot create table %s\n",
1042                                 t->name);
1043                         goto out;
1044                 }
1045                 para_printf(&aca->pbout, "successfully created %s table\n",
1046                         t->name);
1047         }
1048         ret = open_afs_tables();
1049         if (ret < 0)
1050                 para_printf(&aca->pbout, "cannot open afs tables: %s\n",
1051                         para_strerror(-ret));
1052 out:
1053         return ret;
1054 }
1055
1056 static int com_init(struct command_context *cc, struct lls_parse_result *lpr)
1057 {
1058         int i, j, ret;
1059         uint32_t table_mask = (1 << (NUM_AFS_TABLES + 1)) - 1;
1060         struct osl_object query = {.data = &table_mask,
1061                 .size = sizeof(table_mask)};
1062         unsigned num_inputs = lls_num_inputs(lpr);
1063
1064         ret = make_database_dir();
1065         if (ret < 0)
1066                 return ret;
1067         if (num_inputs > 0) {
1068                 table_mask = 0;
1069                 for (i = 0; i < num_inputs; i++) {
1070                         for (j = 0; j < NUM_AFS_TABLES; j++) {
1071                                 struct afs_table *t = &afs_tables[j];
1072
1073                                 if (strcmp(lls_input(i, lpr), t->name))
1074                                         continue;
1075                                 table_mask |= (1 << j);
1076                                 break;
1077                         }
1078                         if (j == NUM_AFS_TABLES)
1079                                 return -E_BAD_TABLE_NAME;
1080                 }
1081         }
1082         return send_callback_request(com_init_callback, &query,
1083                 afs_cb_result_handler, cc);
1084 }
1085 EXPORT_SERVER_CMD_HANDLER(init);
1086
1087 static int com_check(struct command_context *cc, struct lls_parse_result *lpr)
1088 {
1089         const struct lls_opt_result *r_a = SERVER_CMD_OPT_RESULT(CHECK, AFT, lpr);
1090         const struct lls_opt_result *r_A = SERVER_CMD_OPT_RESULT(CHECK, ATTRIBUTE, lpr);
1091         const struct lls_opt_result *r_m = SERVER_CMD_OPT_RESULT(CHECK, MOOD, lpr);
1092         const struct lls_opt_result *r_p = SERVER_CMD_OPT_RESULT(CHECK, PLAYLIST, lpr);
1093         bool noopt = !lls_opt_given(r_a) && !lls_opt_given(r_A)
1094                 && !lls_opt_given(r_m) && !lls_opt_given(r_p);
1095         int ret;
1096
1097         if (noopt || lls_opt_given(r_a)) {
1098                 ret = send_callback_request(aft_check_callback, NULL,
1099                         afs_cb_result_handler, cc);
1100                 if (ret < 0)
1101                         return ret;
1102         }
1103         if (noopt || lls_opt_given(r_A)) {
1104                 ret = send_callback_request(attribute_check_callback, NULL,
1105                         afs_cb_result_handler, cc);
1106                 if (ret < 0)
1107                         return ret;
1108         }
1109         if (noopt || lls_opt_given(r_p)) {
1110                 ret = send_callback_request(playlist_check_callback,
1111                         NULL, afs_cb_result_handler, cc);
1112                 if (ret < 0)
1113                         return ret;
1114         }
1115         if (noopt || lls_opt_given(r_m)) {
1116                 ret = send_callback_request(mood_check_callback, NULL,
1117                         afs_cb_result_handler, cc);
1118                 if (ret < 0)
1119                         return ret;
1120         }
1121         return 1;
1122 }
1123 EXPORT_SERVER_CMD_HANDLER(check);
1124
1125 /**
1126  * The afs event dispatcher.
1127  *
1128  * \param event Type of the event.
1129  * \param pb May be \p NULL.
1130  * \param data Type depends on \a event.
1131  *
1132  * This function calls each table event handler, passing \a pb and \a data
1133  * verbatim. It's up to the handlers to interpret the \a data pointer. If a
1134  * handler returns negative, the loop is aborted.
1135  *
1136  * \return The (negative) error code of the first handler that failed, or non-negative
1137  * if all handlers succeeded.
1138  */
1139 __must_check int afs_event(enum afs_events event, struct para_buffer *pb,
1140                 void *data)
1141 {
1142         int i, ret;
1143
1144         for (i = 0; i < NUM_AFS_TABLES; i++) {
1145                 struct afs_table *t = &afs_tables[i];
1146                 if (!t->event_handler)
1147                         continue;
1148                 ret = t->event_handler(event, pb, data);
1149                 if (ret < 0) {
1150                         PARA_CRIT_LOG("table %s, event %u: %s\n", t->name,
1151                                 event, para_strerror(-ret));
1152                         return ret;
1153                 }
1154         }
1155         return 1;
1156 }
1157
1158 /**
1159  * Dummy event handler for the images table.
1160  *
1161  * \param event Unused.
1162  * \param pb Unused.
1163  * \param data Unused.
1164  *
1165  * \return The images table does not honor events, so this handler always
1166  * returns success.
1167  */
1168 __a_const int images_event_handler(__a_unused enum afs_events event,
1169         __a_unused  struct para_buffer *pb, __a_unused void *data)
1170 {
1171         return 1;
1172 }
1173
1174 /**
1175  * Dummy event handler for the lyrics table.
1176  *
1177  * \param event Unused.
1178  * \param pb Unused.
1179  * \param data Unused.
1180  *
1181  * \return The lyrics table does not honor events, so this handler always
1182  * returns success.
1183  */
1184 __a_const int lyrics_event_handler(__a_unused enum afs_events event,
1185         __a_unused struct para_buffer *pb, __a_unused void *data)
1186 {
1187         return 1;
1188 }