aft.c

   1 /*
   2  * Copyright (C) 2007-2010 Andre Noll <maan@systemlinux.org>
   3  *
   4  * Licensed under the GPL v2. For licencing details see COPYING.
   5  */
   6
   7 /** \file aft.c Audio file table functions. */
   8
   9 #include <regex.h>
  10 #include <dirent.h> /* readdir() */
  11 #include <openssl/rc4.h>
  12 #include <sys/mman.h>
  13 #include <fnmatch.h>
  14 #include <sys/shm.h>
  15 #include <osl.h>
  16
  17 #include "para.h"
  18 #include "error.h"
  19 #include "crypt.h"
  20 #include "string.h"
  21 #include "afh.h"
  22 #include "afs.h"
  23 #include "net.h"
  24 #include "vss.h"
  25 #include "fd.h"
  26 #include "ipc.h"
  27 #include "portable_io.h"
  28
  29 static struct osl_table *audio_file_table;
  30 static char *status_items;
  31 static char *parser_friendly_status_items;
  32
  33 /** The different sorting methods of the ls command. */
  34 enum ls_sorting_method {
  35         /** -sp (default) */
  36         LS_SORT_BY_PATH,
  37         /** -ss */
  38         LS_SORT_BY_SCORE,
  39         /** -sl */
  40         LS_SORT_BY_LAST_PLAYED,
  41         /** -sn */
  42         LS_SORT_BY_NUM_PLAYED,
  43         /** -sf */
  44         LS_SORT_BY_FREQUENCY,
  45         /** -sc */
  46         LS_SORT_BY_CHANNELS,
  47         /** -si */
  48         LS_SORT_BY_IMAGE_ID,
  49         /** -sy */
  50         LS_SORT_BY_LYRICS_ID,
  51         /** -sb */
  52         LS_SORT_BY_BITRATE,
  53         /** -sd */
  54         LS_SORT_BY_DURATION,
  55         /** -sa */
  56         LS_SORT_BY_AUDIO_FORMAT,
  57         /** -sh */
  58         LS_SORT_BY_HASH,
  59 };
  60
  61 /** The different listing modes of the ls command. */
  62 enum ls_listing_mode {
  63         /** Default listing mode. */
  64         LS_MODE_SHORT,
  65         /** -l or -ll */
  66         LS_MODE_LONG,
  67         /** -lv */
  68         LS_MODE_VERBOSE,
  69         /** -lm */
  70         LS_MODE_MBOX,
  71         /** -lc */
  72         LS_MODE_CHUNKS,
  73         /** -lp */
  74         LS_MODE_PARSER,
  75 };
  76
  77 /** The flags accepted by the ls command. */
  78 enum ls_flags {
  79         /** -p */
  80         LS_FLAG_FULL_PATH = 1,
  81         /** -a */
  82         LS_FLAG_ADMISSIBLE_ONLY = 2,
  83         /** -r */
  84         LS_FLAG_REVERSE = 4,
  85         /** -d */
  86         LS_FLAG_UNIXDATE = 8,
  87 };
  88
  89 /**
  90  * The size of the individual output fields of the ls command.
  91  *
  92  * These depend on the actual content being listed. If, for instance only files
  93  * with duration less than an hour are being listed, then the duration with is
  94  * made smaller because then the duration is listed as mm:ss rather than
  95  * hh:mm:ss.
  96  */
  97 struct ls_widths {
  98         /** size of the score field. */
  99         unsigned short score_width;
 100         /** size of the image id field. */
 101         unsigned short image_id_width;
 102         /** size of the lyrics id field. */
 103         unsigned short lyrics_id_width;
 104         /** size of the bitrate field. */
 105         unsigned short bitrate_width;
 106         /** size of the frequency field. */
 107         unsigned short frequency_width;
 108         /** size of the duration field. */
 109         unsigned short duration_width;
 110         /** size of the num played field. */
 111         unsigned short num_played_width;
 112         /** size of the amp field. */
 113         unsigned short amp_width;
 114 };
 115
 116 /** Data passed from the ls command handler to its callback function. */
 117 struct ls_options {
 118         /** The given command line flags. */
 119         unsigned flags;
 120         /** The sorting method given at the command line. */
 121         enum ls_sorting_method sorting;
 122         /** The given listing mode (short, long, verbose, mbox). */
 123         enum ls_listing_mode mode;
 124         /** The arguments passed to the ls command. */
 125         char **patterns;
 126         /** Number of non-option arguments. */
 127         int num_patterns;
 128         /** Used for long listing mode to align the output fields. */
 129         struct ls_widths widths;
 130         /** Size of the \a data array. */
 131         uint32_t array_size;
 132         /** Number of used entries in the data array. */
 133         uint32_t num_matching_paths;
 134         /** Array of matching entries. */
 135         struct ls_data *data;
 136         /** Used to sort the array. */
 137         struct ls_data **data_ptr;
 138 };
 139
 140 /**
 141  * Describes the layout of the mmapped-afs info struct.
 142  *
 143  * \sa struct afs_info.
 144  */
 145 enum afsi_offsets {
 146         /** Where .last_played is stored. */
 147         AFSI_LAST_PLAYED_OFFSET = 0,
 148         /** Storage position of the attributes bitmap. */
 149         AFSI_ATTRIBUTES_OFFSET = 8,
 150         /** Storage position of the .num_played field. */
 151         AFSI_NUM_PLAYED_OFFSET = 16,
 152         /** Storage position of the .image_id field. */
 153         AFSI_IMAGE_ID_OFFSET = 20,
 154         /** Storage position of the .lyrics_id field. */
 155         AFSI_LYRICS_ID_OFFSET = 24,
 156         /** Storage position of the .audio_format_id field. */
 157         AFSI_AUDIO_FORMAT_ID_OFFSET = 28,
 158         /** Storage position of the amplification field. */
 159         AFSI_AMP_OFFSET = 29,
 160         /** 2 bytes reserved space for future usage. */
 161         AFSI_AUDIO_FORMAT_UNUSED_OFFSET = 30,
 162         /** On-disk storage space needed. */
 163         AFSI_SIZE = 32
 164 };
 165
 166 /**
 167  * Convert a struct afs_info to an osl object.
 168  *
 169  * \param afsi Pointer to the audio file info to be converted.
 170  * \param obj Result pointer.
 171  *
 172  * \sa load_afsi().
 173  */
 174 void save_afsi(struct afs_info *afsi, struct osl_object *obj)
 175 {
 176         char *buf = obj->data;
 177
 178         write_u64(buf + AFSI_LAST_PLAYED_OFFSET, afsi->last_played);
 179         write_u64(buf + AFSI_ATTRIBUTES_OFFSET, afsi->attributes);
 180         write_u32(buf + AFSI_NUM_PLAYED_OFFSET, afsi->num_played);
 181         write_u32(buf + AFSI_IMAGE_ID_OFFSET, afsi->image_id);
 182         write_u32(buf + AFSI_LYRICS_ID_OFFSET, afsi->lyrics_id);
 183         write_u8(buf + AFSI_AUDIO_FORMAT_ID_OFFSET,
 184                 afsi->audio_format_id);
 185         write_u8(buf + AFSI_AMP_OFFSET, afsi->amp);
 186         memset(buf + AFSI_AUDIO_FORMAT_UNUSED_OFFSET, 0, 2);
 187 }
 188
 189 /**
 190  *  Get the audio file selector info struct stored in an osl object.
 191  *
 192  * \param afsi Points to the audio_file info structure to be filled in.
 193  * \param obj The osl object holding the data.
 194  *
 195  * \return Positive on success, negative on errors. Possible errors: \p E_BAD_AFS.
 196  *
 197  * \sa save_afsi().
 198  */
 199 int load_afsi(struct afs_info *afsi, struct osl_object *obj)
 200 {
 201         char *buf = obj->data;
 202         if (obj->size < AFSI_SIZE)
 203                 return -E_BAD_AFSI;
 204         afsi->last_played = read_u64(buf + AFSI_LAST_PLAYED_OFFSET);
 205         afsi->attributes = read_u64(buf + AFSI_ATTRIBUTES_OFFSET);
 206         afsi->num_played = read_u32(buf + AFSI_NUM_PLAYED_OFFSET);
 207         afsi->image_id = read_u32(buf + AFSI_IMAGE_ID_OFFSET);
 208         afsi->lyrics_id = read_u32(buf + AFSI_LYRICS_ID_OFFSET);
 209         afsi->audio_format_id = read_u8(buf +
 210                 AFSI_AUDIO_FORMAT_ID_OFFSET);
 211         afsi->amp = read_u8(buf + AFSI_AMP_OFFSET);
 212         return 1;
 213 }
 214
 215 /** The columns of the audio file table. */
 216 enum audio_file_table_columns {
 217         /** The hash on the content of the audio file. */
 218         AFTCOL_HASH,
 219         /** The full path in the filesystem. */
 220         AFTCOL_PATH,
 221         /** The audio file selector info. */
 222         AFTCOL_AFSI,
 223         /** The audio format handler info. */
 224         AFTCOL_AFHI,
 225         /** The chunk table info and the chunk table of the audio file. */
 226         AFTCOL_CHUNKS,
 227         /** The number of columns of this table. */
 228         NUM_AFT_COLUMNS
 229 };
 230
 231 /**
 232  * Compare two osl objects pointing to hash values.
 233  *
 234  * \param obj1 Pointer to the first hash object.
 235  * \param obj2 Pointer to the second hash object.
 236  *
 237  * \return The values required for an osl compare function.
 238  *
 239  * \sa osl_compare_func, uint32_compare().
 240  */
 241 static int aft_hash_compare(const struct osl_object *obj1, const struct osl_object *obj2)
 242 {
 243         return hash_compare((HASH_TYPE *)obj1->data, (HASH_TYPE *)obj2->data);
 244 }
 245
 246 static struct osl_column_description aft_cols[] = {
 247         [AFTCOL_HASH] = {
 248                 .storage_type = OSL_MAPPED_STORAGE,
 249                 .storage_flags = OSL_RBTREE | OSL_FIXED_SIZE | OSL_UNIQUE,
 250                 .name = "hash",
 251                 .compare_function = aft_hash_compare,
 252                 .data_size = HASH_SIZE
 253         },
 254         [AFTCOL_PATH] = {
 255                 .storage_type = OSL_MAPPED_STORAGE,
 256                 .storage_flags = OSL_RBTREE | OSL_UNIQUE,
 257                 .name = "path",
 258                 .compare_function = string_compare,
 259         },
 260         [AFTCOL_AFSI] = {
 261                 .storage_type = OSL_MAPPED_STORAGE,
 262                 .storage_flags = OSL_FIXED_SIZE,
 263                 .name = "afs_info",
 264                 .data_size = AFSI_SIZE
 265         },
 266         [AFTCOL_AFHI] = {
 267                 .storage_type = OSL_MAPPED_STORAGE,
 268                 .name = "afh_info",
 269         },
 270         [AFTCOL_CHUNKS] = {
 271                 .storage_type = OSL_DISK_STORAGE,
 272                 .name = "chunks",
 273         }
 274 };
 275
 276 static struct osl_table_description audio_file_table_desc = {
 277         .name = "audio_files",
 278         .num_columns = NUM_AFT_COLUMNS,
 279         .flags = OSL_LARGE_TABLE,
 280         .column_descriptions = aft_cols
 281 };
 282
 283 /* We don't want * dot or dot-dot anywhere. */
 284 static int verify_dotfile(const char *rest)
 285 {
 286         /*
 287          * The first character was '.', but that has already been discarded, we
 288          * now test the rest.
 289          */
 290         switch (*rest) {
 291         case '\0': case '/': /* /foo/. and /foo/./bar are not ok */
 292                 return -1;
 293         case '.': /* path start with /foo/.. */
 294                 if (rest[1] == '\0' || rest[1] == '/')
 295                         return -1; /* /foo/.. or /foo/../bar are not ok */
 296                 /* /foo/..bar is ok */
 297         }
 298         return 1;
 299 }
 300
 301 /*
 302  * We fundamentally don't like some paths: We don't want double slashes or
 303  * slashes at the end that can make pathnames ambiguous.
 304  */
 305 static int verify_path(const char *orig_path, char **resolved_path)
 306 {
 307         char c;
 308         size_t len;
 309         char *path;
 310
 311         if (*orig_path != '/') /* we only accept absolute paths */
 312                 return -E_BAD_PATH;
 313         len = strlen(orig_path);
 314         *resolved_path = para_strdup(orig_path);
 315         path = *resolved_path;
 316         while (len > 1 && path[--len] == '/')
 317                 path[len] = '\0'; /* remove slash at the end */
 318         c = *path++;
 319         while (c) {
 320                 if (c == '/') {
 321                         c = *path++;
 322                         switch (c) {
 323                         case '/': /* double slash */
 324                                 goto bad_path;
 325                         case '.':
 326                                 if (verify_dotfile(path) < 0)
 327                                         goto bad_path;
 328                         default:
 329                                 continue;
 330                         }
 331                 }
 332                 c = *path++;
 333         }
 334         return 1;
 335 bad_path:
 336         free(*resolved_path);
 337         return -E_BAD_PATH;
 338 }
 339
 340 /** The on-disk layout of a afhi struct. */
 341 enum afhi_offsets {
 342         /** Where the number of seconds is stored. */
 343         AFHI_SECONDS_TOTAL_OFFSET = 0,
 344         /** Position of the bitrate. */
 345         AFHI_BITRATE_OFFSET = 4,
 346         /** Position of the frequency. */
 347         AFHI_FREQUENCY_OFFSET = 8,
 348         /** Location of the audio file header. */
 349         AFHI_HEADER_OFFSET_OFFSET = 12,
 350         /* Length of the audio file header. Zero means: No header. */
 351         AFHI_HEADER_LEN_OFFSET = 16,
 352         /** The total number of chunks (4 bytes). */
 353         CHUNKS_TOTAL_OFFSET = 20,
 354         /** The length of the audio file header (4 bytes). */
 355         HEADER_LEN_OFFSET = 24,
 356         /** The start of the audio file header (4 bytes). */
 357         HEADER_OFFSET_OFFSET = 28,
 358         /** The seconds part of the chunk time (4 bytes). */
 359         CHUNK_TV_TV_SEC_OFFSET = 32,
 360         /** The microseconds part of the chunk time (4 bytes). */
 361         CHUNK_TV_TV_USEC_OFFSET = 36,
 362         /** Number of channels is stored here. (1 byte) */
 363         AFHI_CHANNELS_OFFSET = 40,
 364         /** The tag info position. */
 365         AFHI_INFO_STRING_OFFSET = 41,
 366         /** Minimal on-disk size of a valid afhi struct. */
 367         MIN_AFHI_SIZE = 47, /* at least 6 null bytes for techinfo/tags */
 368 };
 369
 370 static unsigned sizeof_afhi_buf(const struct afh_info *afhi)
 371 {
 372         if (!afhi)
 373                 return 0;
 374         return MIN_AFHI_SIZE
 375                 + strlen(afhi->techinfo)
 376                 + strlen(afhi->tags.artist)
 377                 + strlen(afhi->tags.title)
 378                 + strlen(afhi->tags.year)
 379                 + strlen(afhi->tags.album)
 380                 + strlen(afhi->tags.comment);
 381 }
 382
 383 static void save_afhi(struct afh_info *afhi, char *buf)
 384 {
 385         char *p;
 386
 387         if (!afhi)
 388                 return;
 389         write_u32(buf + AFHI_SECONDS_TOTAL_OFFSET, afhi->seconds_total);
 390         write_u32(buf + AFHI_BITRATE_OFFSET, afhi->bitrate);
 391         write_u32(buf + AFHI_FREQUENCY_OFFSET, afhi->frequency);
 392         write_u32(buf + AFHI_HEADER_OFFSET_OFFSET, afhi->header_offset);
 393         write_u32(buf + AFHI_HEADER_LEN_OFFSET, afhi->header_len);
 394         write_u8(buf + AFHI_CHANNELS_OFFSET, afhi->channels);
 395         write_u32(buf + CHUNKS_TOTAL_OFFSET, afhi->chunks_total);
 396         write_u32(buf + HEADER_LEN_OFFSET, afhi->header_len);
 397         write_u32(buf + HEADER_OFFSET_OFFSET, afhi->header_offset);
 398         write_u32(buf + CHUNK_TV_TV_SEC_OFFSET, afhi->chunk_tv.tv_sec);
 399         write_u32(buf + CHUNK_TV_TV_USEC_OFFSET, afhi->chunk_tv.tv_usec);
 400         p = buf + AFHI_INFO_STRING_OFFSET;
 401         /* The sprintf's below are OK as our caller made sure that buf is large enough */
 402         p += sprintf(p, "%s", afhi->techinfo) + 1;
 403         p += sprintf(p, "%s", afhi->tags.artist) + 1;
 404         p += sprintf(p, "%s", afhi->tags.title) + 1;
 405         p += sprintf(p, "%s", afhi->tags.year) + 1;
 406         p += sprintf(p, "%s", afhi->tags.album) + 1;
 407         sprintf(p, "%s", afhi->tags.comment);
 408 }
 409
 410 static void load_afhi(const char *buf, struct afh_info *afhi)
 411 {
 412         afhi->seconds_total = read_u32(buf + AFHI_SECONDS_TOTAL_OFFSET);
 413         afhi->bitrate = read_u32(buf + AFHI_BITRATE_OFFSET);
 414         afhi->frequency = read_u32(buf + AFHI_FREQUENCY_OFFSET);
 415         afhi->header_offset = read_u32(buf + AFHI_HEADER_OFFSET_OFFSET);
 416         afhi->header_len = read_u32(buf + AFHI_HEADER_LEN_OFFSET);
 417         afhi->channels = read_u8(buf + AFHI_CHANNELS_OFFSET);
 418         afhi->chunks_total = read_u32(buf + CHUNKS_TOTAL_OFFSET);
 419         afhi->header_len = read_u32(buf + HEADER_LEN_OFFSET);
 420         afhi->header_offset = read_u32(buf + HEADER_OFFSET_OFFSET);
 421         afhi->chunk_tv.tv_sec = read_u32(buf + CHUNK_TV_TV_SEC_OFFSET);
 422         afhi->chunk_tv.tv_usec = read_u32(buf + CHUNK_TV_TV_USEC_OFFSET);
 423         afhi->techinfo = (char *)buf + AFHI_INFO_STRING_OFFSET;
 424         afhi->tags.artist = afhi->techinfo + strlen(afhi->techinfo) + 1;
 425         afhi->tags.title = afhi->tags.artist + strlen(afhi->tags.artist) + 1;
 426         afhi->tags.year = afhi->tags.title + strlen(afhi->tags.title) + 1;
 427         afhi->tags.album = afhi->tags.year + strlen(afhi->tags.year) + 1;
 428         afhi->tags.comment = afhi->tags.album + strlen(afhi->tags.album) + 1;
 429 }
 430
 431 static unsigned sizeof_chunk_table(struct afh_info *afhi)
 432 {
 433         if (!afhi)
 434                 return 0;
 435         return 4 * (afhi->chunks_total + 1);
 436 }
 437
 438 static void save_chunk_table(struct afh_info *afhi, char *buf)
 439 {
 440         int i;
 441
 442         for (i = 0; i <= afhi->chunks_total; i++)
 443                 write_u32(buf + 4 * i, afhi->chunk_table[i]);
 444 }
 445
 446 static void load_chunk_table(struct afh_info *afhi, char *buf)
 447 {
 448         int i;
 449
 450         afhi->chunk_table = para_malloc(sizeof_chunk_table(afhi));
 451         for (i = 0; i <= afhi->chunks_total; i++)
 452                 afhi->chunk_table[i] = read_u32(buf + 4 * i);
 453 }
 454
 455 /**
 456  * Get the row of the audio file table corresponding to the given path.
 457  *
 458  * \param path The full path of the audio file.
 459  * \param row Result pointer.
 460  *
 461  * \return Standard.
 462  */
 463 int aft_get_row_of_path(const char *path, struct osl_row **row)
 464 {
 465         struct osl_object obj = {.data = (char *)path, .size = strlen(path) + 1};
 466
 467         return osl(osl_get_row(audio_file_table, AFTCOL_PATH, &obj, row));
 468 }
 469
 470 /**
 471  * Get the row of the audio file table corresponding to the given hash value.
 472  *
 473  * \param hash The hash value of the desired audio file.
 474  * \param row Result pointer.
 475  *
 476  * \return Standard.
 477  */
 478 static int aft_get_row_of_hash(HASH_TYPE *hash, struct osl_row **row)
 479 {
 480         const struct osl_object obj = {.data = hash, .size = HASH_SIZE};
 481         return osl(osl_get_row(audio_file_table, AFTCOL_HASH, &obj, row));
 482 }
 483
 484 /**
 485  * Get the osl object holding the audio file selector info of a row.
 486  *
 487  * \param row Pointer to a row in the audio file table.
 488  * \param obj Result pointer.
 489  *
 490  * \return Standard.
 491  */
 492 int get_afsi_object_of_row(const struct osl_row *row, struct osl_object *obj)
 493 {
 494         return osl(osl_get_object(audio_file_table, row, AFTCOL_AFSI, obj));
 495 }
 496
 497 /**
 498  * Get the osl object holding the audio file selector info, given a path.
 499  *
 500  *
 501  * \param path The full path of the audio file.
 502  * \param obj Result pointer.
 503  *
 504  * \return Positive on success, negative on errors.
 505  */
 506 static int get_afsi_object_of_path(const char *path, struct osl_object *obj)
 507 {
 508         struct osl_row *row;
 509         int ret = aft_get_row_of_path(path, &row);
 510         if (ret < 0)
 511                 return ret;
 512         return get_afsi_object_of_row(row, obj);
 513 }
 514
 515 /**
 516  * Get the audio file selector info, given a row of the audio file table.
 517  *
 518  * \param row Pointer to a row in the audio file table.
 519  * \param afsi Result pointer.
 520  *
 521  * \return Positive on success, negative on errors.
 522  */
 523 int get_afsi_of_row(const struct osl_row *row, struct afs_info *afsi)
 524 {
 525         struct osl_object obj;
 526         int ret = get_afsi_object_of_row(row, &obj);
 527         if (ret < 0)
 528                 return ret;
 529         return load_afsi(afsi, &obj);
 530 }
 531
 532 /**
 533  * Get the audio file selector info, given the path of an audio table.
 534  *
 535  * \param path The full path of the audio file.
 536  * \param afsi Result pointer.
 537  *
 538  * \return Positive on success, negative on errors.
 539  */
 540 int get_afsi_of_path(const char *path, struct afs_info *afsi)
 541 {
 542         struct osl_object obj;
 543         int ret = get_afsi_object_of_path(path, &obj);
 544         if (ret < 0)
 545                 return ret;
 546         return load_afsi(afsi, &obj);
 547 }
 548
 549 /**
 550  * Get the path of an audio file, given a row of the audio file table.
 551  *
 552  * \param row Pointer to a row in the audio file table.
 553  * \param path Result pointer.
 554  *
 555  * The result is a pointer to mmapped data. The caller must not attempt
 556  * to free it.
 557  *
 558  * \return Standard.
 559  */
 560 int get_audio_file_path_of_row(const struct osl_row *row, char **path)
 561 {
 562         struct osl_object path_obj;
 563         int ret = osl(osl_get_object(audio_file_table, row, AFTCOL_PATH,
 564                 &path_obj));
 565         if (ret < 0)
 566                 return ret;
 567         *path = path_obj.data;
 568         return 1;
 569 }
 570
 571 /**
 572  * Get the object containing the hash value of an audio file, given a row.
 573  *
 574  * \param row Pointer to a row of the audio file table.
 575  * \param obj Result pointer.
 576  *
 577  * \return The return value of the underlying call to osl_get_object().
 578  *
 579  * \sa get_hash_of_row().
 580  */
 581 static int get_hash_object_of_aft_row(const struct osl_row *row,
 582                 struct osl_object *obj)
 583 {
 584         return osl(osl_get_object(audio_file_table, row, AFTCOL_HASH, obj));
 585 }
 586
 587 /**
 588  * Get the hash value of an audio file, given a row of the audio file table.
 589  *
 590  * \param row Pointer to a row of the audio file table.
 591  * \param hash Result pointer.
 592  *
 593  * \a hash points to mapped data and must not be freed by the caller.
 594  *
 595  * \return The return value of the underlying call to
 596  * get_hash_object_of_aft_row().
 597  */
 598 static int get_hash_of_row(const struct osl_row *row, HASH_TYPE **hash)
 599 {
 600         struct osl_object obj;
 601         int ret = get_hash_object_of_aft_row(row, &obj);
 602
 603         if (ret < 0)
 604                 return ret;
 605         *hash = obj.data;
 606         return 1;
 607 }
 608
 609 /**
 610  * Get the audio format handler info, given a row of the audio file table.
 611  *
 612  * \param row Pointer to a row of the audio file table.
 613  * \param afhi Result pointer.
 614  *
 615  * \return The return value of the underlying call to osl_get_object().
 616  *
 617  * \sa get_chunk_table_of_row().
 618  */
 619 int get_afhi_of_row(const struct osl_row *row, struct afh_info *afhi)
 620 {
 621         struct osl_object obj;
 622         int ret = osl(osl_get_object(audio_file_table, row, AFTCOL_AFHI,
 623                 &obj));
 624         if (ret < 0)
 625                 return ret;
 626         load_afhi(obj.data, afhi);
 627         return 1;
 628 }
 629
 630 /* returns shmid on success */
 631 static int save_afd(struct audio_file_data *afd)
 632 {
 633         size_t size = sizeof(*afd) + sizeof_chunk_table(&afd->afhi);
 634         int shmid, ret = shm_new(size);
 635         void *shm_afd;
 636         char *buf;
 637
 638         if (ret < 0)
 639                 return ret;
 640         shmid = ret;
 641         ret = shm_attach(shmid, ATTACH_RW, &shm_afd);
 642         if (ret < 0)
 643                 goto err;
 644         *(struct audio_file_data *)shm_afd = *afd;
 645         buf = shm_afd;
 646         buf += sizeof(*afd);
 647         save_chunk_table(&afd->afhi, buf);
 648         shm_detach(shm_afd);
 649         return shmid;
 650 err:
 651         shm_destroy(shmid);
 652         return ret;
 653 }
 654
 655 /**
 656  * Extract a afd stored in a shared memory area.
 657  *
 658  * Attach the shared memory area given by \a shmid, load the audio file data
 659  * stored therein and detach the area afterwards.  Called by vss, after
 660  * receiving a positive response to the request for the next audio file.
 661  +
 662  * \param shmid The identifier of the shared memory area containing the afd.
 663  * \param afd Result pointer.
 664  *
 665  * \return Standard.
 666  */
 667 int load_afd(int shmid, struct audio_file_data *afd)
 668 {
 669         void *shm_afd;
 670         char *buf;
 671         int ret;
 672
 673         ret = shm_attach(shmid, ATTACH_RO, &shm_afd);
 674         if (ret < 0)
 675                 return ret;
 676         *afd = *(struct audio_file_data *)shm_afd;
 677         buf = shm_afd;
 678         buf += sizeof(*afd);
 679         load_chunk_table(&afd->afhi, buf);
 680         shm_detach(shm_afd);
 681         return 1;
 682 }
 683
 684 static int get_local_time(uint64_t *seconds, char *buf, size_t size,
 685         time_t current_time, enum ls_listing_mode lm)
 686 {
 687         struct tm t;
 688
 689         if (!localtime_r((time_t *)seconds, &t))
 690                 return -E_LOCALTIME;
 691         if (lm == LS_MODE_MBOX) {
 692                 if (!strftime(buf, size, "%c", &t))
 693                         return -E_STRFTIME;
 694                 return 1;
 695         }
 696         if (*seconds + 6 * 30 * 24 * 3600 > current_time) {
 697                 if (!strftime(buf, size, "%b %e %k:%M", &t))
 698                         return -E_STRFTIME;
 699                 return 1;
 700         }
 701         if (!strftime(buf, size, "%b %e  %Y", &t))
 702                 return -E_STRFTIME;
 703         return 1;
 704 }
 705
 706 /** Compute the number of (decimal) digits of a number. */
 707 #define GET_NUM_DIGITS(x, num) { \
 708         typeof((x)) _tmp = PARA_ABS(x); \
 709         *num = 1; \
 710         if ((_tmp)) \
 711                 while ((_tmp) > 9) { \
 712                         (_tmp) /= 10; \
 713                         (*num)++; \
 714                 } \
 715         }
 716
 717 static short unsigned get_duration_width(int seconds)
 718 {
 719         short unsigned width;
 720         unsigned hours = seconds / 3600, mins = (seconds % 3600) / 60;
 721
 722         if (!hours) /* less than one hour => m:ss or mm:ss => 4 or 5 digits */
 723                 return 4 + (mins > 9);
 724         /* more than one hour => h:mm:ss, hh:mm:ss, hhh:mm:ss, ... */
 725         GET_NUM_DIGITS(hours, &width);
 726         return width + 6;
 727 }
 728
 729 static void get_duration_buf(int seconds, char *buf, struct ls_options *opts)
 730 {
 731         unsigned hours = seconds / 3600, mins = (seconds % 3600) / 60;
 732         short unsigned max_width;
 733
 734         if (!hours) { /* m:ss or mm:ss */
 735                 max_width = opts->mode == LS_MODE_LONG?
 736                         opts->widths.duration_width : 4;
 737                 sprintf(buf, "%*u:%02u", max_width - 3, mins, seconds % 60);
 738         } else { /* more than one hour => h:mm:ss, hh:mm:ss, hhh:mm:ss, ... */
 739                 max_width = opts->mode == LS_MODE_LONG?
 740                         opts->widths.duration_width : 7;
 741                 sprintf(buf, "%*u:%02u:%02u", max_width - 6, hours, mins,
 742                         seconds % 60);
 743         }
 744 }
 745
 746
 747 static int write_attribute_items(struct para_buffer *b,
 748                 const char *att_bitmap, struct afs_info *afsi)
 749 {
 750         char *att_text;
 751         int ret;
 752
 753         ret = WRITE_STATUS_ITEM(b, SI_ATTRIBUTES_BITMAP, "%s\n", att_bitmap);
 754         if (ret < 0)
 755                 return ret;
 756         ret = get_attribute_text(&afsi->attributes, " ", &att_text);
 757         if (ret < 0)
 758                 return ret;
 759         ret = WRITE_STATUS_ITEM(b, SI_ATTRIBUTES_TXT, "%s\n", att_text);
 760         free(att_text);
 761         return ret;
 762 }
 763
 764 static int write_lyrics_items(struct para_buffer *b, struct afs_info *afsi)
 765 {
 766         char *lyrics_name;
 767         int ret;
 768
 769         ret = WRITE_STATUS_ITEM(b, SI_LYRICS_ID, "%u\n", afsi->lyrics_id);
 770         if (ret < 0)
 771                 return ret;
 772         lyr_get_name_by_id(afsi->lyrics_id, &lyrics_name);
 773         return WRITE_STATUS_ITEM(b, SI_LYRICS_NAME, "%s\n", lyrics_name?
 774                 lyrics_name : "(none)");
 775 }
 776
 777 static int write_image_items(struct para_buffer *b, struct afs_info *afsi)
 778 {
 779         char *image_name;
 780         int ret;
 781
 782         ret = WRITE_STATUS_ITEM(b, SI_IMAGE_ID, "%u\n", afsi->image_id);
 783         if (ret < 0)
 784                 return ret;
 785         img_get_name_by_id(afsi->image_id, &image_name);
 786         return WRITE_STATUS_ITEM(b, SI_IMAGE_NAME, "%s\n", image_name?
 787                 image_name : "(none)");
 788 }
 789
 790 static int write_filename_items(struct para_buffer *b, const char *path,
 791                 unsigned flags)
 792 {
 793         char *val;
 794         int ret;
 795
 796         if (!(flags & LS_FLAG_FULL_PATH))
 797                 return WRITE_STATUS_ITEM(b, SI_BASENAME, "%s\n", path);
 798         ret = WRITE_STATUS_ITEM(b, SI_PATH, "%s\n", path);
 799         if (ret < 0)
 800                 return ret;
 801         val = para_basename(path);
 802         ret = WRITE_STATUS_ITEM(b, SI_BASENAME, "%s\n", val? val : "");
 803         if (ret < 0)
 804                 return ret;
 805         val = para_dirname(path);
 806         ret = WRITE_STATUS_ITEM(b, SI_DIRECTORY, "%s\n", val? val : "");
 807         free(val);
 808         return ret;
 809 }
 810
 811 static int print_chunk_table(struct ls_data *d, struct para_buffer *b)
 812 {
 813         struct osl_object chunk_table_obj;
 814         struct osl_row *aft_row;
 815         int ret, i;
 816         char *buf;
 817
 818         ret = aft_get_row_of_hash(d->hash, &aft_row);
 819         if (ret < 0)
 820                 return ret;
 821         ret = osl_open_disk_object(audio_file_table, aft_row,
 822                 AFTCOL_CHUNKS, &chunk_table_obj);
 823         if (ret < 0)
 824                 return ret;
 825         ret = para_printf(b, "%s\n"
 826                 "chunk_time: %lu:%lu\nchunk_offsets: ",
 827                 d->path,
 828                 (long unsigned) d->afhi.chunk_tv.tv_sec,
 829                 (long unsigned) d->afhi.chunk_tv.tv_usec
 830         );
 831         if (ret < 0)
 832                 goto out;
 833         buf = chunk_table_obj.data;
 834         for (i = 0; i <= d->afhi.chunks_total; i++) {
 835                 ret = para_printf(b, "%u ", (unsigned) read_u32(buf + 4 * i));
 836                 if (ret < 0)
 837                         goto out;
 838         }
 839         ret = para_printf(b, "\n");
 840 out:
 841         osl_close_disk_object(&chunk_table_obj);
 842         return ret;
 843 }
 844
 845 static int write_score(struct para_buffer *b, struct ls_data *d,
 846                 struct ls_options *opts)
 847 {
 848         if (!(opts->flags & LS_FLAG_ADMISSIBLE_ONLY)) /* no score*/
 849                 return 0;
 850         return WRITE_STATUS_ITEM(b, SI_SCORE, "%li\n", d->score);
 851 }
 852
 853 static int print_list_item(struct ls_data *d, struct ls_options *opts,
 854         struct para_buffer *b, time_t current_time)
 855 {
 856         int ret;
 857         char att_buf[65];
 858         char last_played_time[30];
 859         char duration_buf[30]; /* nobody has an audio file long enough to overflow this */
 860         struct afs_info *afsi = &d->afsi;
 861         struct afh_info *afhi = &d->afhi;
 862         char asc_hash[2 * HASH_SIZE + 1];
 863
 864         if (opts->mode == LS_MODE_SHORT) {
 865                 ret = para_printf(b, "%s\n", d->path);
 866                 goto out;
 867         }
 868         if (opts->mode == LS_MODE_CHUNKS) {
 869                 ret = print_chunk_table(d, b);
 870                 goto out;
 871         }
 872         get_attribute_bitmap(&afsi->attributes, att_buf);
 873         if (opts->flags & LS_FLAG_UNIXDATE)
 874                 sprintf(last_played_time, "%llu",
 875                         (long long unsigned)afsi->last_played);
 876         else {
 877                 ret = get_local_time(&afsi->last_played, last_played_time,
 878                         sizeof(last_played_time), current_time, opts->mode);
 879                 if (ret < 0)
 880                         goto out;
 881         }
 882         get_duration_buf(afhi->seconds_total, duration_buf, opts);
 883         if (opts->mode == LS_MODE_LONG) {
 884                 struct ls_widths *w = &opts->widths;
 885                 if (opts->flags & LS_FLAG_ADMISSIBLE_ONLY) {
 886                         ret = para_printf(b, "%*li ",
 887                                 opts->widths.score_width, d->score);
 888                         if (ret < 0)
 889                                 goto out;
 890                 }
 891                 ret = para_printf(b,
 892                         "%s "   /* attributes */
 893                         "%*u "  /* amp */
 894                         "%*d "  /* image_id  */
 895                         "%*d "  /* lyrics_id */
 896                         "%*d "  /* bitrate */
 897                         "%s "   /* audio format */
 898                         "%*d "  /* frequency */
 899                         "%d "   /* channels */
 900                         "%s "   /* duration */
 901                         "%*d "  /* num_played */
 902                         "%s "   /* last_played */
 903                         "%s\n", /* path */
 904                         att_buf,
 905                         w->amp_width, afsi->amp,
 906                         w->image_id_width, afsi->image_id,
 907                         w->lyrics_id_width, afsi->lyrics_id,
 908                         w->bitrate_width, afhi->bitrate,
 909                         audio_format_name(afsi->audio_format_id),
 910                         w->frequency_width, afhi->frequency,
 911                         afhi->channels,
 912                         duration_buf,
 913                         w->num_played_width, afsi->num_played,
 914                         last_played_time,
 915                         d->path
 916                 );
 917                 goto out;
 918         }
 919         if (opts->mode == LS_MODE_MBOX) {
 920                 const char *bn = para_basename(d->path);
 921                 ret = para_printf(b,
 922                         "From foo@localhost %s\n"
 923                         "Received: from\nTo: bar\nFrom: a\n"
 924                         "Subject: %s\n\n",
 925                         last_played_time,
 926                         bn? bn : "?");
 927                 if (ret < 0)
 928                         goto out;
 929         }
 930         ret = write_filename_items(b, d->path, opts->flags);
 931         if (ret < 0)
 932                 goto out;
 933         ret = write_score(b, d, opts);
 934         if (ret < 0)
 935                 goto out;
 936         ret = write_attribute_items(b, att_buf, afsi);
 937         if (ret < 0)
 938                 goto out;
 939         ret = write_image_items(b, afsi);
 940         if (ret < 0)
 941                 goto out;
 942         ret = write_lyrics_items(b, afsi);
 943         if (ret < 0)
 944                 goto out;
 945         hash_to_asc(d->hash, asc_hash);
 946         ret = WRITE_STATUS_ITEM(b, SI_HASH, "%s\n", asc_hash);
 947         if (ret < 0)
 948                 goto out;
 949         ret = WRITE_STATUS_ITEM(b, SI_BITRATE, "%dkbit/s\n", afhi->bitrate);
 950         if (ret < 0)
 951                 goto out;
 952         ret = WRITE_STATUS_ITEM(b, SI_FORMAT, "%s\n",
 953                 audio_format_name(afsi->audio_format_id));
 954         if (ret < 0)
 955                 goto out;
 956         ret = WRITE_STATUS_ITEM(b, SI_FREQUENCY, "%dHz\n", afhi->frequency);
 957         if (ret < 0)
 958                 goto out;
 959         ret = WRITE_STATUS_ITEM(b, SI_CHANNELS, "%d\n", afhi->channels);
 960         if (ret < 0)
 961                 goto out;
 962         ret = WRITE_STATUS_ITEM(b, SI_DURATION, "%s\n", duration_buf);
 963         if (ret < 0)
 964                 goto out;
 965         ret = WRITE_STATUS_ITEM(b, SI_SECONDS_TOTAL, "%lu\n",
 966                 afhi->seconds_total);
 967         if (ret < 0)
 968                 goto out;
 969         ret = WRITE_STATUS_ITEM(b, SI_LAST_PLAYED, "%s\n", last_played_time);
 970         if (ret < 0)
 971                 goto out;
 972         ret = WRITE_STATUS_ITEM(b, SI_NUM_PLAYED, "%d\n", afsi->num_played);
 973         if (ret < 0)
 974                 goto out;
 975         ret = WRITE_STATUS_ITEM(b, SI_AMPLIFICATION, "%u\n", afsi->amp);
 976         if (ret < 0)
 977                 goto out;
 978         ret = WRITE_STATUS_ITEM(b, SI_CHUNK_TIME, "%lu\n",
 979                 tv2ms(&afhi->chunk_tv));
 980         if (ret < 0)
 981                 goto out;
 982         ret = WRITE_STATUS_ITEM(b, SI_NUM_CHUNKS, "%lu\n",
 983                 afhi->chunks_total);
 984         if (ret < 0)
 985                 goto out;
 986         ret = WRITE_STATUS_ITEM(b, SI_TECHINFO, "%s\n", afhi->techinfo);
 987         if (ret < 0)
 988                 goto out;
 989         ret = WRITE_STATUS_ITEM(b, SI_ARTIST, "%s\n", afhi->tags.artist);
 990         if (ret < 0)
 991                 goto out;
 992         ret = WRITE_STATUS_ITEM(b, SI_TITLE, "%s\n", afhi->tags.title);
 993         if (ret < 0)
 994                 goto out;
 995         ret = WRITE_STATUS_ITEM(b, SI_YEAR, "%s\n", afhi->tags.year);
 996         if (ret < 0)
 997                 goto out;
 998         ret = WRITE_STATUS_ITEM(b, SI_ALBUM, "%s\n", afhi->tags.album);
 999         if (ret < 0)
1000                 goto out;
1001         ret = WRITE_STATUS_ITEM(b, SI_COMMENT, "%s\n", afhi->tags.comment);
1002         if (ret < 0)
1003                 goto out;
1004         if (opts->mode == LS_MODE_MBOX) {
1005                 struct osl_object lyrics_def;
1006                 lyr_get_def_by_id(afsi->lyrics_id, &lyrics_def);
1007                 if (lyrics_def.data) {
1008                         ret = para_printf(b, "Lyrics:\n~~~~~~~\n%s",
1009                                 (char *)lyrics_def.data);
1010                         osl_close_disk_object(&lyrics_def);
1011                 }
1012         }
1013 out:
1014         return ret;
1015 }
1016
1017 static int make_status_items(struct audio_file_data *afd,
1018                 struct afs_info *afsi, char *path, long score,
1019                 HASH_TYPE *hash)
1020 {
1021         struct ls_data d = {
1022                 .afhi = afd->afhi,
1023                 .afsi = *afsi,
1024                 .path = path,
1025                 .score = score,
1026                 .hash = hash
1027         };
1028         struct ls_options opts = {
1029                 .flags = LS_FLAG_FULL_PATH | LS_FLAG_ADMISSIBLE_ONLY,
1030                 .mode = LS_MODE_VERBOSE,
1031         };
1032         struct para_buffer pb = {.max_size = SHMMAX - 1};
1033         time_t current_time;
1034         int ret;
1035
1036         time(&current_time);
1037         ret = print_list_item(&d, &opts, &pb, current_time);
1038         if (ret < 0)
1039                 return ret;
1040         free(status_items);
1041         status_items = pb.buf;
1042         memset(&pb, 0, sizeof(pb));
1043         pb.max_size = SHMMAX - 1;
1044         pb.flags = PBF_SIZE_PREFIX;
1045         ret = print_list_item(&d, &opts, &pb, current_time);
1046         if (ret < 0) {
1047                 free(status_items);
1048                 status_items = NULL;
1049                 return ret;
1050         }
1051         free(parser_friendly_status_items);
1052         parser_friendly_status_items = pb.buf;
1053         return 1;
1054 }
1055
1056 /**
1057  * Mmap the given audio file and update statistics.
1058  *
1059  * \param aft_row Determines the audio file to be opened and updated.
1060  * \param score The score of the audio file.
1061  * \param afd Result pointer.
1062  *
1063  * On success, the numplayed field of the audio file selector info is increased
1064  * and the lastplayed time is set to the current time. Finally, the score of
1065  * the audio file is updated.
1066  *
1067  * \return Positive shmid on success, negative on errors.
1068  */
1069 int open_and_update_audio_file(struct osl_row *aft_row, long score,
1070         struct audio_file_data *afd)
1071 {
1072         HASH_TYPE *aft_hash, file_hash[HASH_SIZE];
1073         struct osl_object afsi_obj;
1074         struct afs_info old_afsi, new_afsi;
1075         int ret = get_hash_of_row(aft_row, &aft_hash);
1076         struct afsi_change_event_data aced;
1077         struct osl_object map, chunk_table_obj;
1078         char *path;
1079
1080         if (ret < 0)
1081                 return ret;
1082         ret = get_audio_file_path_of_row(aft_row, &path);
1083         if (ret < 0)
1084                 return ret;
1085         PARA_NOTICE_LOG("%s\n", path);
1086         ret = get_afsi_object_of_row(aft_row, &afsi_obj);
1087         if (ret < 0)
1088                 return ret;
1089         ret = load_afsi(&old_afsi, &afsi_obj);
1090         if (ret < 0)
1091                 return ret;
1092         ret = get_afhi_of_row(aft_row, &afd->afhi);
1093         if (ret < 0)
1094                 return ret;
1095         afd->afhi.chunk_table = NULL;
1096         ret = osl_open_disk_object(audio_file_table, aft_row,
1097                 AFTCOL_CHUNKS, &chunk_table_obj);
1098         if (ret < 0)
1099                 goto err;
1100         ret = mmap_full_file(path, O_RDONLY, &map.data,
1101                 &map.size, &afd->fd);
1102         if (ret < 0)
1103                 goto err;
1104         hash_function(map.data, map.size, file_hash);
1105         ret = hash_compare(file_hash, aft_hash);
1106         para_munmap(map.data, map.size);
1107         if (ret) {
1108                 ret = -E_HASH_MISMATCH;
1109                 goto err;
1110         }
1111         new_afsi = old_afsi;
1112         new_afsi.num_played++;
1113         new_afsi.last_played = time(NULL);
1114         save_afsi(&new_afsi, &afsi_obj); /* in-place update */
1115
1116         load_chunk_table(&afd->afhi, chunk_table_obj.data);
1117         ret = make_status_items(afd, &old_afsi, path, score, file_hash);
1118         if (ret < 0)
1119                 goto err;
1120         aced.aft_row = aft_row;
1121         aced.old_afsi = &old_afsi;
1122         afs_event(AFSI_CHANGE, NULL, &aced);
1123         ret = save_afd(afd);
1124 err:
1125         free(afd->afhi.chunk_table);
1126         osl_close_disk_object(&chunk_table_obj);
1127         return ret;
1128 }
1129
1130 static int ls_audio_format_compare(const void *a, const void *b)
1131 {
1132         struct ls_data *d1 = *(struct ls_data **)a, *d2 = *(struct ls_data **)b;
1133         return NUM_COMPARE(d1->afsi.audio_format_id, d2->afsi.audio_format_id);
1134 }
1135
1136 static int ls_duration_compare(const void *a, const void *b)
1137 {
1138         struct ls_data *d1 = *(struct ls_data **)a, *d2 = *(struct ls_data **)b;
1139         return NUM_COMPARE(d1->afhi.seconds_total, d2->afhi.seconds_total);
1140 }
1141
1142 static int ls_bitrate_compare(const void *a, const void *b)
1143 {
1144         struct ls_data *d1 = *(struct ls_data **)a, *d2 = *(struct ls_data **)b;
1145         return NUM_COMPARE(d1->afhi.bitrate, d2->afhi.bitrate);
1146 }
1147
1148 static int ls_lyrics_id_compare(const void *a, const void *b)
1149 {
1150         struct ls_data *d1 = *(struct ls_data **)a, *d2 = *(struct ls_data **)b;
1151         return NUM_COMPARE(d1->afsi.lyrics_id, d2->afsi.lyrics_id);
1152 }
1153
1154 static int ls_image_id_compare(const void *a, const void *b)
1155 {
1156         struct ls_data *d1 = *(struct ls_data **)a, *d2 = *(struct ls_data **)b;
1157         return NUM_COMPARE(d1->afsi.image_id, d2->afsi.image_id);
1158 }
1159
1160 static int ls_channels_compare(const void *a, const void *b)
1161 {
1162         struct ls_data *d1 = *(struct ls_data **)a, *d2 = *(struct ls_data **)b;
1163         return NUM_COMPARE(d1->afhi.channels, d2->afhi.channels);
1164 }
1165
1166 static int ls_frequency_compare(const void *a, const void *b)
1167 {
1168         struct ls_data *d1 = *(struct ls_data **)a, *d2 = *(struct ls_data **)b;
1169         return NUM_COMPARE(d1->afhi.frequency, d2->afhi.frequency);
1170 }
1171
1172 static int ls_num_played_compare(const void *a, const void *b)
1173 {
1174         struct ls_data *d1 = *(struct ls_data **)a, *d2 = *(struct ls_data **)b;
1175         return NUM_COMPARE(d1->afsi.num_played, d2->afsi.num_played);
1176 }
1177
1178 static int ls_last_played_compare(const void *a, const void *b)
1179 {
1180         struct ls_data *d1 = *(struct ls_data **)a, *d2 = *(struct ls_data **)b;
1181         return NUM_COMPARE(d1->afsi.last_played, d2->afsi.last_played);
1182 }
1183
1184 static int ls_score_compare(const void *a, const void *b)
1185 {
1186         struct ls_data *d1 = *(struct ls_data **)a, *d2 = *(struct ls_data **)b;
1187         return NUM_COMPARE(d1->score, d2->score);
1188 }
1189
1190 static int ls_path_compare(const void *a, const void *b)
1191 {
1192         struct ls_data *d1 = *(struct ls_data **)a, *d2 = *(struct ls_data **)b;
1193         return strcmp(d1->path, d2->path);
1194 }
1195
1196 static int sort_matching_paths(struct ls_options *options)
1197 {
1198         size_t nmemb = options->num_matching_paths;
1199         size_t size = sizeof(*options->data_ptr);
1200         int (*compar)(const void *, const void *);
1201         int i;
1202
1203         options->data_ptr = para_malloc(nmemb * sizeof(*options->data_ptr));
1204         for (i = 0; i < nmemb; i++)
1205                 options->data_ptr[i] = options->data + i;
1206
1207         /* In these cases the array is already sorted */
1208         if (options->sorting == LS_SORT_BY_PATH
1209                 && !(options->flags & LS_FLAG_ADMISSIBLE_ONLY)
1210                 && (options->flags & LS_FLAG_FULL_PATH))
1211                 return 1;
1212         if (options->sorting == LS_SORT_BY_SCORE &&
1213                         options->flags & LS_FLAG_ADMISSIBLE_ONLY)
1214                 return 1;
1215
1216         switch (options->sorting) {
1217         case LS_SORT_BY_PATH:
1218                 compar = ls_path_compare; break;
1219         case LS_SORT_BY_SCORE:
1220                 compar = ls_score_compare; break;
1221         case LS_SORT_BY_LAST_PLAYED:
1222                 compar = ls_last_played_compare; break;
1223         case LS_SORT_BY_NUM_PLAYED:
1224                 compar = ls_num_played_compare; break;
1225         case LS_SORT_BY_FREQUENCY:
1226                 compar = ls_frequency_compare; break;
1227         case LS_SORT_BY_CHANNELS:
1228                 compar = ls_channels_compare; break;
1229         case LS_SORT_BY_IMAGE_ID:
1230                 compar = ls_image_id_compare; break;
1231         case LS_SORT_BY_LYRICS_ID:
1232                 compar = ls_lyrics_id_compare; break;
1233         case LS_SORT_BY_BITRATE:
1234                 compar = ls_bitrate_compare; break;
1235         case LS_SORT_BY_DURATION:
1236                 compar = ls_duration_compare; break;
1237         case LS_SORT_BY_AUDIO_FORMAT:
1238                 compar = ls_audio_format_compare; break;
1239         default:
1240                 return -E_BAD_SORT;
1241         }
1242         qsort(options->data_ptr, nmemb, size, compar);
1243         return 1;
1244 }
1245
1246 /* row is either an aft_row or a row of the score table */
1247 /* TODO: Only compute widths if we need them */
1248 static int prepare_ls_row(struct osl_row *row, void *ls_opts)
1249 {
1250         int ret, i;
1251         struct ls_options *options = ls_opts;
1252         struct ls_data *d;
1253         struct ls_widths *w;
1254         unsigned short num_digits;
1255         unsigned tmp;
1256         struct osl_row *aft_row;
1257         long score;
1258         char *path;
1259
1260         if (options->flags & LS_FLAG_ADMISSIBLE_ONLY) {
1261                 ret = get_score_and_aft_row(row, &score, &aft_row);
1262                 if (ret < 0)
1263                         return ret;
1264         } else
1265                 aft_row = row;
1266         ret = get_audio_file_path_of_row(aft_row, &path);
1267         if (ret < 0)
1268                 return ret;
1269         if (!(options->flags & LS_FLAG_FULL_PATH)) {
1270                 char *p = strrchr(path, '/');
1271                 if (p)
1272                         path = p + 1;
1273         }
1274         if (options->num_patterns) {
1275                 for (i = 0; i < options->num_patterns; i++) {
1276                         ret = fnmatch(options->patterns[i], path, 0);
1277                         if (!ret)
1278                                 break;
1279                         if (ret == FNM_NOMATCH)
1280                                 continue;
1281                         return -E_FNMATCH;
1282                 }
1283                 if (i >= options->num_patterns) /* no match */
1284                         return 1;
1285         }
1286         tmp = options->num_matching_paths++;
1287         if (options->num_matching_paths > options->array_size) {
1288                 options->array_size++;
1289                 options->array_size *= 2;
1290                 options->data = para_realloc(options->data, options->array_size
1291                         * sizeof(*options->data));
1292         }
1293         d = options->data + tmp;
1294         ret = get_afsi_of_row(aft_row, &d->afsi);
1295         if (ret < 0)
1296                 return ret;
1297         ret = get_afhi_of_row(aft_row, &d->afhi);
1298         if (ret < 0)
1299                 return ret;
1300         d->path = path;
1301         ret = get_hash_of_row(aft_row, &d->hash);
1302         if (ret < 0)
1303                 goto err;
1304         w = &options->widths;
1305         GET_NUM_DIGITS(d->afsi.image_id, &num_digits);
1306         w->image_id_width = PARA_MAX(w->image_id_width, num_digits);
1307         GET_NUM_DIGITS(d->afsi.lyrics_id, &num_digits);
1308         w->lyrics_id_width = PARA_MAX(w->lyrics_id_width, num_digits);
1309         GET_NUM_DIGITS(d->afhi.bitrate, &num_digits);
1310         w->bitrate_width = PARA_MAX(w->bitrate_width, num_digits);
1311         GET_NUM_DIGITS(d->afhi.frequency, &num_digits);
1312         w->frequency_width = PARA_MAX(w->frequency_width, num_digits);
1313         GET_NUM_DIGITS(d->afsi.num_played, &num_digits);
1314         w->num_played_width = PARA_MAX(w->num_played_width, num_digits);
1315         /* get the number of chars to print this amount of time */
1316         num_digits = get_duration_width(d->afhi.seconds_total);
1317         w->duration_width = PARA_MAX(w->duration_width, num_digits);
1318         GET_NUM_DIGITS(d->afsi.amp, &num_digits);
1319         w->amp_width = PARA_MAX(w->amp_width, num_digits);
1320         if (options->flags & LS_FLAG_ADMISSIBLE_ONLY) {
1321                 GET_NUM_DIGITS(score, &num_digits);
1322                 num_digits++; /* add one for the sign (space or "-") */
1323                 w->score_width = PARA_MAX(w->score_width, num_digits);
1324                 d->score = score;
1325         }
1326         return 1;
1327 err:
1328         return ret;
1329 }
1330
1331 static void com_ls_callback(int fd, const struct osl_object *query)
1332 {
1333         struct ls_options *opts = query->data;
1334         char *p, *pattern_start = (char *)query->data + sizeof(*opts);
1335         struct para_buffer b = {.max_size = SHMMAX,
1336                 .flags = (opts->mode == LS_MODE_PARSER)? PBF_SIZE_PREFIX : 0,
1337                 .max_size_handler = pass_buffer_as_shm, .private_data = &fd};
1338         int i = 0, ret;
1339         time_t current_time;
1340
1341         if (opts->num_patterns) {
1342                 opts->patterns = para_malloc(opts->num_patterns * sizeof(char *));
1343                 for (i = 0, p = pattern_start; i < opts->num_patterns; i++) {
1344                         opts->patterns[i] = p;
1345                         p += strlen(p) + 1;
1346                 }
1347         } else
1348                 opts->patterns = NULL;
1349         if (opts->flags & LS_FLAG_ADMISSIBLE_ONLY)
1350                 ret = admissible_file_loop(opts, prepare_ls_row);
1351         else
1352                 ret = osl(osl_rbtree_loop(audio_file_table, AFTCOL_PATH, opts,
1353                         prepare_ls_row));
1354         if (ret < 0)
1355                 goto out;
1356         if (!opts->num_matching_paths)
1357                 goto out;
1358         ret = sort_matching_paths(opts);
1359         if (ret < 0)
1360                 goto out;
1361         time(&current_time);
1362         if (opts->flags & LS_FLAG_REVERSE)
1363                 for (i = opts->num_matching_paths - 1; i >= 0; i--) {
1364                         ret = print_list_item(opts->data_ptr[i], opts, &b, current_time);
1365                         if (ret < 0)
1366                                 goto out;
1367                 }
1368         else
1369                 for (i = 0; i < opts->num_matching_paths; i++) {
1370                         ret = print_list_item(opts->data_ptr[i], opts, &b, current_time);
1371                         if (ret < 0)
1372                                 goto out;
1373                 }
1374 out:
1375         if (b.offset)
1376                 pass_buffer_as_shm(b.buf, b.offset, &fd);
1377         free(b.buf);
1378         free(opts->data);
1379         free(opts->data_ptr);
1380         free(opts->patterns);
1381 }
1382
1383 /*
1384  * TODO: flags -h (sort by hash)
1385  */
1386 int com_ls(struct rc4_context *rc4c, int argc, char * const * const argv)
1387 {
1388         int i, ret;
1389         unsigned flags = 0;
1390         enum ls_sorting_method sort = LS_SORT_BY_PATH;
1391         enum ls_listing_mode mode = LS_MODE_SHORT;
1392         struct ls_options opts = {.patterns = NULL};
1393         struct osl_object query = {.data = &opts, .size = sizeof(opts)};
1394
1395         for (i = 1; i < argc; i++) {
1396                 const char *arg = argv[i];
1397                 if (arg[0] != '-')
1398                         break;
1399                 if (!strcmp(arg, "--")) {
1400                         i++;
1401                         break;
1402                 }
1403                 if (!strncmp(arg, "-l", 2)) {
1404                         if (!*(arg + 2)) {
1405                                 mode = LS_MODE_LONG;
1406                                 continue;
1407                         }
1408                         if (*(arg + 3))
1409                                 return -E_AFT_SYNTAX;
1410                         switch(*(arg + 2)) {
1411                         case 's':
1412                                 mode = LS_MODE_SHORT;
1413                                 continue;
1414                         case 'l':
1415                                 mode = LS_MODE_LONG;
1416                                 continue;
1417                         case 'v':
1418                                 mode = LS_MODE_VERBOSE;
1419                                 continue;
1420                         case 'm':
1421                                 mode = LS_MODE_MBOX;
1422                                 continue;
1423                         case 'c':
1424                                 mode = LS_MODE_CHUNKS;
1425                                 continue;
1426                         case 'p':
1427                                 mode = LS_MODE_PARSER;
1428                                 continue;
1429                         default:
1430                                 return -E_AFT_SYNTAX;
1431                         }
1432                 }
1433                 if (!strcmp(arg, "-p")) {
1434                         flags |= LS_FLAG_FULL_PATH;
1435                         continue;
1436                 }
1437                 if (!strcmp(arg, "-a")) {
1438                         flags |= LS_FLAG_ADMISSIBLE_ONLY;
1439                         continue;
1440                 }
1441                 if (!strcmp(arg, "-r")) {
1442                         flags |= LS_FLAG_REVERSE;
1443                         continue;
1444                 }
1445                 if (!strcmp(arg, "-d")) {
1446                         flags |= LS_FLAG_UNIXDATE;
1447                         continue;
1448                 }
1449                 if (!strncmp(arg, "-s", 2)) {
1450                         if (!*(arg + 2) || *(arg + 3))
1451                                 return -E_AFT_SYNTAX;
1452                         switch(*(arg + 2)) {
1453                         case 'p':
1454                                 sort = LS_SORT_BY_PATH;
1455                                 continue;
1456                         case 's': /* -ss implies -a */
1457                                 sort = LS_SORT_BY_SCORE;
1458                                 flags |= LS_FLAG_ADMISSIBLE_ONLY;
1459                                 continue;
1460                         case 'l':
1461                                 sort = LS_SORT_BY_LAST_PLAYED;
1462                                 continue;
1463                         case 'n':
1464                                 sort = LS_SORT_BY_NUM_PLAYED;
1465                                 continue;
1466                         case 'f':
1467                                 sort = LS_SORT_BY_FREQUENCY;
1468                                 continue;
1469                         case 'c':
1470                                 sort = LS_SORT_BY_CHANNELS;
1471                                 continue;
1472                         case 'i':
1473                                 sort = LS_SORT_BY_IMAGE_ID;
1474                                 continue;
1475                         case 'y':
1476                                 sort = LS_SORT_BY_LYRICS_ID;
1477                                 continue;
1478                         case 'b':
1479                                 sort = LS_SORT_BY_BITRATE;
1480                                 continue;
1481                         case 'd':
1482                                 sort = LS_SORT_BY_DURATION;
1483                                 continue;
1484                         case 'a':
1485                                 sort = LS_SORT_BY_AUDIO_FORMAT;
1486                                 continue;
1487                         default:
1488                                 return -E_AFT_SYNTAX;
1489                         }
1490                 }
1491                 return -E_AFT_SYNTAX;
1492         }
1493         opts.flags = flags;
1494         opts.sorting = sort;
1495         opts.mode = mode;
1496         opts.num_patterns = argc - i;
1497         ret = send_option_arg_callback_request(&query, opts.num_patterns,
1498                 argv + i, com_ls_callback, rc4_send_result, rc4c);
1499         return ret;
1500 }
1501
1502 /**
1503  * Call the given function for each file in the audio file table.
1504  *
1505  * \param private_data An arbitrary data pointer, passed to \a func.
1506  * \param func The custom function to be called.
1507  *
1508  * \return Standard.
1509  */
1510 int audio_file_loop(void *private_data, osl_rbtree_loop_func *func)
1511 {
1512         return osl(osl_rbtree_loop(audio_file_table, AFTCOL_HASH, private_data,
1513                 func));
1514 }
1515
1516 static struct osl_row *find_hash_sister(HASH_TYPE *hash)
1517 {
1518         const struct osl_object obj = {.data = hash, .size = HASH_SIZE};
1519         struct osl_row *row;
1520
1521         osl_get_row(audio_file_table, AFTCOL_HASH, &obj, &row);
1522         return row;
1523 }
1524
1525 /** The format of the data stored by save_audio_file_data(). */
1526 enum com_add_buffer_offsets {
1527         /** afhi (if present) starts here. */
1528         CAB_AFHI_OFFSET_POS = 0,
1529         /** Start of the chunk table (if present). */
1530         CAB_CHUNKS_OFFSET_POS = 2,
1531         /** Audio format id. */
1532         CAB_AUDIO_FORMAT_OFFSET = 4,
1533         /** Flags given to the add command. */
1534         CAB_FLAGS_OFFSET = 5,
1535         /** The hash of the audio file being added. */
1536         CAB_HASH_OFFSET = 9,
1537         /** Start of the path of the audio file. */
1538         CAB_PATH_OFFSET = (CAB_HASH_OFFSET + HASH_SIZE),
1539 };
1540
1541 /*
1542  * Store the given data to a single buffer. Doesn't need the audio file selector
1543  * info struct as the server knows it as well.
1544  *
1545  * It's OK to call this with afhi == NULL. In this case, the audio format
1546  * handler info won't be stored in the buffer.
1547  */
1548 static void save_add_callback_buffer(HASH_TYPE *hash, const char *path,
1549                 struct afh_info *afhi, uint32_t flags,
1550                 uint8_t audio_format_num, struct osl_object *obj)
1551 {
1552         size_t path_len = strlen(path) + 1;
1553         size_t afhi_size = sizeof_afhi_buf(afhi);
1554         size_t size = CAB_PATH_OFFSET + path_len + afhi_size
1555                 + sizeof_chunk_table(afhi);
1556         char *buf = para_malloc(size);
1557         uint16_t pos;
1558
1559         write_u8(buf + CAB_AUDIO_FORMAT_OFFSET, audio_format_num);
1560         write_u32(buf + CAB_FLAGS_OFFSET, flags);
1561
1562         memcpy(buf + CAB_HASH_OFFSET, hash, HASH_SIZE);
1563         strcpy(buf + CAB_PATH_OFFSET, path);
1564
1565         pos = CAB_PATH_OFFSET + path_len;
1566         PARA_DEBUG_LOG("size: %zu, afhi starts at %d\n", size, pos);
1567         PARA_DEBUG_LOG("last afhi byte: %p, pos %zu\n", buf + pos + afhi_size - 1,
1568                 pos + afhi_size - 1);
1569         write_u16(buf + CAB_AFHI_OFFSET_POS, pos);
1570         save_afhi(afhi, buf + pos);
1571
1572         pos += afhi_size;
1573         PARA_DEBUG_LOG("size: %zu, chunks start at %d\n", size, pos);
1574         write_u16(buf + CAB_CHUNKS_OFFSET_POS, pos);
1575         if (afhi)
1576                 save_chunk_table(afhi, buf + pos);
1577         PARA_DEBUG_LOG("last byte in buf: %p\n", buf + size - 1);
1578         obj->data = buf;
1579         obj->size = size;
1580 }
1581
1582 /*
1583
1584 Overview of the add command.
1585
1586 Input: What was passed to the callback by the command handler.
1587 ~~~~~~
1588 HS:     Hash sister. Whether an audio file with identical hash
1589         already exists in the osl database.
1590
1591 PB:     Path brother. Whether a file with the given path exists
1592         in the table.
1593
1594 F:      Force flag given. Whether add was called with -f.
1595
1596 output: Action performed by the callback.
1597 ~~~~~~~
1598 AFHI:   Whether afhi and chunk table are computed and sent.
1599 ACTION: Table modifications to be done by the callback.
1600
1601 +----+----+---+------+---------------------------------------------------+
1602 | HS | PB | F | AFHI | ACTION
1603 +----+----+---+------+---------------------------------------------------+
1604 | Y  |  Y | Y |  Y   | if HS != PB: remove PB. HS: force afhi update,
1605 |                    | update path, keep afsi
1606 +----+----+---+------+---------------------------------------------------+
1607 | Y  |  Y | N |  N   | if HS == PB: do not send callback request at all.
1608 |                    | otherwise: remove PB, HS: update path, keep afhi,
1609 |                    | afsi.
1610 +----+----+---+------+---------------------------------------------------+
1611 | Y  |  N | Y |  Y   | (rename) force afhi update of HS, update path of
1612 |                    | HS, keep afsi
1613 +----+----+---+------+---------------------------------------------------+
1614 | Y  |  N | N |  N   | (file rename) update path of HS, keep afsi, afhi
1615 +----+----+---+------+---------------------------------------------------+
1616 | N  |  Y | Y |  Y   | (file change) update afhi, hash, of PB, keep afsi
1617 |                    | (force has no effect)
1618 +----+----+---+------+---------------------------------------------------+
1619 | N  |  Y | N |  Y   | (file change) update afhi, hash of PB, keep afsi
1620 +----+----+---+------+---------------------------------------------------+
1621 | N  |  N | Y |  Y   | (new file) create new entry (force has no effect)
1622 +----+----+---+------+---------------------------------------------------+
1623 |  N |  N | N |  Y   | (new file) create new entry
1624 +----+----+---+------+---------------------------------------------------+
1625
1626 Notes:
1627
1628         afhi <=> force or no HS
1629         F => AFHI
1630
1631 */
1632
1633 /** Flags passed to the add command. */
1634 enum com_add_flags {
1635         /** Skip paths that exist already. */
1636         ADD_FLAG_LAZY = 1,
1637         /** Force adding. */
1638         ADD_FLAG_FORCE = 2,
1639         /** Print what is being done. */
1640         ADD_FLAG_VERBOSE = 4,
1641         /** Try to add files with unknown suffixes. */
1642         ADD_FLAG_ALL = 8,
1643 };
1644
1645 static void com_add_callback(int fd, const struct osl_object *query)
1646 {
1647         char *buf = query->data, *path;
1648         struct osl_row *pb, *aft_row;
1649         struct osl_row *hs;
1650         struct osl_object objs[NUM_AFT_COLUMNS];
1651         HASH_TYPE *hash;
1652         char asc[2 * HASH_SIZE + 1];
1653         int ret;
1654         char afsi_buf[AFSI_SIZE];
1655         uint32_t flags = read_u32(buf + CAB_FLAGS_OFFSET);
1656         struct afs_info default_afsi = {.last_played = 0};
1657         struct para_buffer msg = {.max_size = SHMMAX,
1658                 .max_size_handler = pass_buffer_as_shm, .private_data = &fd};
1659         uint16_t afhi_offset, chunks_offset;
1660
1661         hash = (HASH_TYPE *)buf + CAB_HASH_OFFSET;
1662         hash_to_asc(hash, asc);;
1663         objs[AFTCOL_HASH].data = buf + CAB_HASH_OFFSET;
1664         objs[AFTCOL_HASH].size = HASH_SIZE;
1665
1666         path = buf + CAB_PATH_OFFSET;
1667         objs[AFTCOL_PATH].data = path;
1668         objs[AFTCOL_PATH].size = strlen(path) + 1;
1669
1670         PARA_INFO_LOG("request to add %s\n", path);
1671         hs = find_hash_sister(hash);
1672         ret = aft_get_row_of_path(path, &pb);
1673         if (ret < 0 && ret != -OSL_ERRNO_TO_PARA_ERROR(E_OSL_RB_KEY_NOT_FOUND))
1674                 goto out;
1675         if (hs && pb && hs == pb && !(flags & ADD_FLAG_FORCE)) {
1676                 if (flags & ADD_FLAG_VERBOSE)
1677                         ret = para_printf(&msg, "ignoring duplicate\n");
1678                 else
1679                         ret = 1;
1680                 goto out;
1681         }
1682         if (hs && hs != pb) {
1683                 struct osl_object obj;
1684                 if (pb) { /* hs trumps pb, remove pb */
1685                         if (flags & ADD_FLAG_VERBOSE) {
1686                                 ret = para_printf(&msg, "removing path brother\n");
1687                                 if (ret < 0)
1688                                         goto out;
1689                         }
1690                         ret = osl(osl_del_row(audio_file_table, pb));
1691                         if (ret < 0)
1692                                 goto out;
1693                         pb = NULL;
1694                 }
1695                 /* file rename, update hs' path */
1696                 if (flags & ADD_FLAG_VERBOSE) {
1697                         ret = osl(osl_get_object(audio_file_table, hs,
1698                                 AFTCOL_PATH, &obj));
1699                         if (ret < 0)
1700                                 goto out;
1701                         ret = para_printf(&msg, "renamed from %s\n", (char *)obj.data);
1702                         if (ret < 0)
1703                                 goto out;
1704                 }
1705                 ret = osl(osl_update_object(audio_file_table, hs, AFTCOL_PATH,
1706                         &objs[AFTCOL_PATH]));
1707                 if (ret < 0)
1708                         goto out;
1709                 afs_event(AUDIO_FILE_RENAME, &msg, hs);
1710                 if (!(flags & ADD_FLAG_FORCE))
1711                         goto out;
1712         }
1713         /* no hs or force mode, child must have sent afhi */
1714         afhi_offset = read_u16(buf + CAB_AFHI_OFFSET_POS);
1715         chunks_offset = read_u16(buf + CAB_CHUNKS_OFFSET_POS);
1716
1717         objs[AFTCOL_AFHI].data = buf + afhi_offset;
1718         objs[AFTCOL_AFHI].size = chunks_offset - afhi_offset;
1719         ret = -E_NO_AFHI;
1720         if (!objs[AFTCOL_AFHI].size) /* "impossible" */
1721                 goto out;
1722         objs[AFTCOL_CHUNKS].data = buf + chunks_offset;
1723         objs[AFTCOL_CHUNKS].size = query->size - chunks_offset;
1724         if (pb && !hs) { /* update pb's hash */
1725                 char old_asc[2 * HASH_SIZE + 1];
1726                 HASH_TYPE *old_hash;
1727                 ret = get_hash_of_row(pb, &old_hash);
1728                 if (ret < 0)
1729                         goto out;
1730                 hash_to_asc(old_hash, old_asc);
1731                 if (flags & ADD_FLAG_VERBOSE) {
1732                         ret = para_printf(&msg, "file change: %s -> %s\n",
1733                                 old_asc, asc);
1734                         if (ret < 0)
1735                                 goto out;
1736                 }
1737                 ret = osl_update_object(audio_file_table, pb, AFTCOL_HASH,
1738                         &objs[AFTCOL_HASH]);
1739                 if (ret < 0)
1740                         goto out;
1741         }
1742         if (hs || pb) { /* (hs != NULL and pb != NULL) implies hs == pb */
1743                 struct osl_row *row = pb? pb : hs;
1744                 /* update afhi and chunk_table */
1745                 if (flags & ADD_FLAG_VERBOSE) {
1746                         ret = para_printf(&msg, "updating afhi and chunk table\n");
1747                         if (ret < 0)
1748                                 goto out;
1749                 }
1750                 ret = osl(osl_update_object(audio_file_table, row, AFTCOL_AFHI,
1751                         &objs[AFTCOL_AFHI]));
1752                 if (ret < 0)
1753                         goto out;
1754                 ret = osl(osl_update_object(audio_file_table, row, AFTCOL_CHUNKS,
1755                         &objs[AFTCOL_CHUNKS]));
1756                 if (ret < 0)
1757                         goto out;
1758                 afs_event(AFHI_CHANGE, &msg, row);
1759                 goto out;
1760         }
1761         /* new entry, use default afsi */
1762         if (flags & ADD_FLAG_VERBOSE) {
1763                 ret = para_printf(&msg, "new file\n");
1764                 if (ret < 0)
1765                         goto out;
1766         }
1767         default_afsi.last_played = time(NULL) - 365 * 24 * 60 * 60;
1768         default_afsi.audio_format_id = read_u8(buf + CAB_AUDIO_FORMAT_OFFSET);
1769
1770         objs[AFTCOL_AFSI].data = &afsi_buf;
1771         objs[AFTCOL_AFSI].size = AFSI_SIZE;
1772         save_afsi(&default_afsi, &objs[AFTCOL_AFSI]);
1773         ret = osl(osl_add_and_get_row(audio_file_table, objs, &aft_row));
1774         afs_event(AUDIO_FILE_ADD, &msg, aft_row);
1775 out:
1776         if (ret < 0)
1777                 para_printf(&msg, "%s\n", para_strerror(-ret));
1778         if (msg.offset)
1779                 pass_buffer_as_shm(msg.buf, msg.offset, &fd);
1780         free(msg.buf);
1781 }
1782
1783 /** Used by com_add(). */
1784 struct private_add_data {
1785         /** The socket file descriptor, including rc4 keys. */
1786         struct rc4_context *rc4c;
1787         /** The given add flags. */
1788         uint32_t flags;
1789 };
1790
1791 static void path_brother_callback(int fd, const struct osl_object *query)
1792 {
1793         char *path = query->data;
1794         struct osl_row *path_brother;
1795         int ret = aft_get_row_of_path(path, &path_brother);
1796         if (ret < 0)
1797                 return;
1798         pass_buffer_as_shm((char *)&path_brother, sizeof(path_brother), &fd);
1799 }
1800
1801 static void hash_sister_callback(int fd, const struct osl_object *query)
1802 {
1803         HASH_TYPE *hash = query->data;
1804         struct osl_row *hash_sister;
1805
1806         hash_sister = find_hash_sister(hash);
1807         if (!hash_sister)
1808                 return;
1809         pass_buffer_as_shm((char *)&hash_sister, sizeof(hash_sister), &fd);
1810 }
1811
1812 static int get_row_pointer_from_result(struct osl_object *result, void *private)
1813 {
1814         struct osl_row **row = private;
1815         *row = result->data;
1816         return 1;
1817 }
1818
1819 static int add_one_audio_file(const char *path, void *private_data)
1820 {
1821         int ret, send_ret = 1, fd;
1822         uint8_t format_num = -1;
1823         struct private_add_data *pad = private_data;
1824         struct afh_info afhi, *afhi_ptr = NULL;
1825         struct osl_row *pb = NULL, *hs = NULL; /* path brother/hash sister */
1826         struct osl_object map, obj = {.data = NULL}, query;
1827         HASH_TYPE hash[HASH_SIZE];
1828
1829         ret = guess_audio_format(path);
1830         if (ret < 0 && !(pad->flags & ADD_FLAG_ALL))
1831                 goto out_free;
1832         query.data = (char *)path;
1833         query.size = strlen(path) + 1;
1834         ret = send_callback_request(path_brother_callback, &query,
1835                 get_row_pointer_from_result, &pb);
1836         if (ret < 0 && ret != -OSL_ERRNO_TO_PARA_ERROR(E_OSL_RB_KEY_NOT_FOUND))
1837                 goto out_free;
1838         ret = 1;
1839         if (pb && (pad->flags & ADD_FLAG_LAZY)) { /* lazy is really cheap */
1840                 if (pad->flags & ADD_FLAG_VERBOSE)
1841                         send_ret = rc4_send_va_buffer(pad->rc4c,
1842                                 "lazy-ignore: %s\n", path);
1843                 goto out_free;
1844         }
1845         /* We still want to add this file. Compute its hash. */
1846         ret = mmap_full_file(path, O_RDONLY, &map.data, &map.size, &fd);
1847         if (ret < 0)
1848                 goto out_free;
1849         hash_function(map.data, map.size, hash);
1850
1851         /* Check whether the database contains a file with the same hash. */
1852         query.data = hash;
1853         query.size = HASH_SIZE;
1854         ret = send_callback_request(hash_sister_callback, &query,
1855                 get_row_pointer_from_result, &hs);
1856         if (ret < 0)
1857                 goto out_unmap;
1858         /* Return success if we already know this file. */
1859         ret = 1;
1860         if (pb && hs && hs == pb && !(pad->flags & ADD_FLAG_FORCE)) {
1861                 if (pad->flags & ADD_FLAG_VERBOSE)
1862                         send_ret = rc4_send_va_buffer(pad->rc4c,
1863                                 "%s exists, not forcing update\n", path);
1864                 goto out_unmap;
1865         }
1866         /*
1867          * We won't recalculate the audio format info and the chunk table if
1868          * there is a hash sister and FORCE was not given.
1869          */
1870         if (!hs || (pad->flags & ADD_FLAG_FORCE)) {
1871                 ret = compute_afhi(path, map.data, map.size, fd, &afhi);
1872                 if (ret < 0)
1873                         goto out_unmap;
1874                 format_num = ret;
1875                 afhi_ptr = &afhi;
1876         }
1877         munmap(map.data, map.size);
1878         close(fd);
1879         if (pad->flags & ADD_FLAG_VERBOSE) {
1880                 send_ret = rc4_send_va_buffer(pad->rc4c, "adding %s\n", path);
1881                 if (send_ret < 0)
1882                         goto out_free;
1883         }
1884         save_add_callback_buffer(hash, path, afhi_ptr, pad->flags, format_num, &obj);
1885         /* Ask afs to consider this entry for adding. */
1886         ret = send_callback_request(com_add_callback, &obj, rc4_send_result, pad->rc4c);
1887         goto out_free;
1888
1889 out_unmap:
1890         close(fd);
1891         munmap(map.data, map.size);
1892 out_free:
1893         if (ret < 0 && send_ret >= 0)
1894                 send_ret = rc4_send_va_buffer(pad->rc4c,
1895                         "failed to add %s (%s)\n", path, para_strerror(-ret));
1896         free(obj.data);
1897         if (afhi_ptr) {
1898                 free(afhi_ptr->chunk_table);
1899                 free(afhi_ptr->techinfo);
1900                 free(afhi_ptr->tags.artist);
1901                 free(afhi_ptr->tags.title);
1902                 free(afhi_ptr->tags.year);
1903                 free(afhi_ptr->tags.album);
1904                 free(afhi_ptr->tags.comment);
1905         }
1906         /* Stop adding files only on send errors. */
1907         return send_ret;
1908 }
1909
1910 int com_add(struct rc4_context *rc4c, int argc, char * const * const argv)
1911 {
1912         int i, ret;
1913         struct private_add_data pad = {.rc4c = rc4c, .flags = 0};
1914         struct stat statbuf;
1915
1916         for (i = 1; i < argc; i++) {
1917                 const char *arg = argv[i];
1918                 if (arg[0] != '-')
1919                         break;
1920                 if (!strcmp(arg, "--")) {
1921                         i++;
1922                         break;
1923                 }
1924                 if (!strcmp(arg, "-a")) {
1925                         pad.flags |= ADD_FLAG_ALL;
1926                         continue;
1927                 }
1928                 if (!strcmp(arg, "-l")) {
1929                         pad.flags |= ADD_FLAG_LAZY;
1930                         continue;
1931                 }
1932                 if (!strcmp(arg, "-f")) {
1933                         pad.flags |= ADD_FLAG_FORCE;
1934                         continue;
1935                 }
1936                 if (!strcmp(arg, "-v")) {
1937                         pad.flags |= ADD_FLAG_VERBOSE;
1938                         continue;
1939                 }
1940         }
1941         if (argc <= i)
1942                 return -E_AFT_SYNTAX;
1943         for (; i < argc; i++) {
1944                 char *path;
1945                 ret = verify_path(argv[i], &path);
1946                 if (ret < 0) {
1947                         ret = rc4_send_va_buffer(rc4c, "%s: %s\n", argv[i],
1948                                 para_strerror(-ret));
1949                         if (ret < 0)
1950                                 return ret;
1951                         continue;
1952                 }
1953                 ret = stat(path, &statbuf);
1954                 if (ret < 0) {
1955                         ret = rc4_send_va_buffer(rc4c, "failed to stat %s (%s)\n", path,
1956                                 strerror(errno));
1957                         free(path);
1958                         if (ret < 0)
1959                                 return ret;
1960                         continue;
1961                 }
1962                 if (S_ISDIR(statbuf.st_mode))
1963                         ret = for_each_file_in_dir(path, add_one_audio_file,
1964                                 &pad);
1965                 else
1966                         ret = add_one_audio_file(path, &pad);
1967                 if (ret < 0) {
1968                         rc4_send_va_buffer(rc4c, "%s: %s\n", path, para_strerror(-ret));
1969                         free(path);
1970                         return ret;
1971                 }
1972                 free(path);
1973         }
1974         return 1;
1975
1976 }
1977
1978 /**
1979  * Flags used by the touch command.
1980  *
1981  * \sa com_touch().
1982  */
1983 enum touch_flags {
1984         /** Whether the \p FNM_PATHNAME flag should be passed to fnmatch(). */
1985         TOUCH_FLAG_FNM_PATHNAME = 1,
1986         /** Activates verbose mode. */
1987         TOUCH_FLAG_VERBOSE = 2
1988 };
1989
1990 /** Options used by com_touch(). */
1991 struct com_touch_options {
1992         /** New num_played value. */
1993         int32_t num_played;
1994         /** New last played count. */
1995         int64_t last_played;
1996         /** New lyrics id. */
1997         int32_t lyrics_id;
1998         /** New image id. */
1999         int32_t image_id;
2000         /** New amplification value. */
2001         int32_t amp;
2002         /** Command line flags (see \ref touch_flags). */
2003         unsigned flags;
2004 };
2005
2006 /** Data passed to the action handler of com_touch(). */
2007 struct touch_action_data {
2008         /** Command line options (see \ref com_touch_options). */
2009         struct com_touch_options *cto;
2010         /** Message buffer. */
2011         struct para_buffer pb;
2012         /** How many audio files matched the given pattern. */
2013         unsigned num_matches;
2014 };
2015
2016 static int touch_audio_file(__a_unused struct osl_table *table,
2017                 struct osl_row *row, const char *name, void *data)
2018 {
2019         struct touch_action_data *tad = data;
2020         struct osl_object obj;
2021         struct afs_info old_afsi, new_afsi;
2022         int ret, no_options = tad->cto->num_played < 0 && tad->cto->last_played < 0 &&
2023                 tad->cto->lyrics_id < 0 && tad->cto->image_id < 0 && tad->cto->amp < 0;
2024         struct afsi_change_event_data aced;
2025
2026         ret = get_afsi_object_of_row(row, &obj);
2027         if (ret < 0)
2028                 return para_printf(&tad->pb, "%s: %s\n", name, para_strerror(-ret));
2029         ret = load_afsi(&old_afsi, &obj);
2030         if (ret < 0)
2031                 return para_printf(&tad->pb, "%s: %s\n", name, para_strerror(-ret));
2032         new_afsi = old_afsi;
2033         if (no_options) {
2034                 new_afsi.num_played++;
2035                 new_afsi.last_played = time(NULL);
2036                 if (tad->cto->flags & TOUCH_FLAG_VERBOSE) {
2037                         ret = para_printf(&tad->pb, "%s: num_played = %u, "
2038                                 "last_played = now()\n", name,
2039                                 new_afsi.num_played);
2040                         if (ret < 0)
2041                                 return ret;
2042                 }
2043         } else {
2044                 if (tad->cto->flags & TOUCH_FLAG_VERBOSE) {
2045                         ret = para_printf(&tad->pb, "touching %s\n", name);
2046                         if (ret < 0)
2047                                 return ret;
2048                 }
2049                 if (tad->cto->lyrics_id >= 0)
2050                         new_afsi.lyrics_id = tad->cto->lyrics_id;
2051                 if (tad->cto->image_id >= 0)
2052                         new_afsi.image_id = tad->cto->image_id;
2053                 if (tad->cto->num_played >= 0)
2054                         new_afsi.num_played = tad->cto->num_played;
2055                 if (tad->cto->last_played >= 0)
2056                         new_afsi.last_played = tad->cto->last_played;
2057                 if (tad->cto->amp >= 0)
2058                         new_afsi.amp = tad->cto->amp;
2059         }
2060         tad->num_matches++;
2061         save_afsi(&new_afsi, &obj); /* in-place update */
2062         aced.aft_row = row;
2063         aced.old_afsi = &old_afsi;
2064         afs_event(AFSI_CHANGE, &tad->pb, &aced);
2065         return 1;
2066 }
2067
2068 static void com_touch_callback(int fd, const struct osl_object *query)
2069 {
2070         struct touch_action_data tad = {.cto = query->data,
2071                 .pb = {
2072                         .max_size = SHMMAX,
2073                         .private_data = &fd,
2074                         .max_size_handler = pass_buffer_as_shm
2075                 }
2076         };
2077         int ret, ret2 = 0;
2078         struct pattern_match_data pmd = {
2079                 .table = audio_file_table,
2080                 .loop_col_num = AFTCOL_HASH,
2081                 .match_col_num = AFTCOL_PATH,
2082                 .patterns = {.data = (char *)query->data + sizeof(*tad.cto),
2083                         .size = query->size - sizeof(*tad.cto)},
2084                 .data = &tad,
2085                 .action = touch_audio_file
2086         };
2087         if (tad.cto->flags & TOUCH_FLAG_FNM_PATHNAME)
2088                 pmd.fnmatch_flags |= FNM_PATHNAME;
2089         ret = for_each_matching_row(&pmd);
2090         if (ret < 0)
2091                 ret2 = para_printf(&tad.pb, "%s\n", para_strerror(-ret));
2092         else
2093                 if (!tad.num_matches)
2094                         ret2 = para_printf(&tad.pb, "no matches\n");
2095         if (ret2 >= 0 && tad.pb.offset)
2096                 pass_buffer_as_shm(tad.pb.buf, tad.pb.offset, &fd);
2097         free(tad.pb.buf);
2098 }
2099
2100 int com_touch(struct rc4_context *rc4c, int argc, char * const * const argv)
2101 {
2102         struct com_touch_options cto = {
2103                 .num_played = -1,
2104                 .last_played = -1,
2105                 .lyrics_id = -1,
2106                 .image_id = -1,
2107                 .amp = -1,
2108         };
2109         struct osl_object query = {.data = &cto, .size = sizeof(cto)};
2110         int i, ret;
2111
2112
2113         for (i = 1; i < argc; i++) {
2114                 const char *arg = argv[i];
2115                 if (arg[0] != '-')
2116                         break;
2117                 if (!strcmp(arg, "--")) {
2118                         i++;
2119                         break;
2120                 }
2121                 if (!strncmp(arg, "-n=", 3)) {
2122                         ret = para_atoi32(arg + 3, &cto.num_played);
2123                         if (ret < 0)
2124                                 return ret;
2125                         continue;
2126                 }
2127                 if (!strncmp(arg, "-l=", 3)) {
2128                         ret = para_atoi64(arg + 3, &cto.last_played);
2129                         if (ret < 0)
2130                                 return ret;
2131                         continue;
2132                 }
2133                 if (!strncmp(arg, "-y=", 3)) {
2134                         ret = para_atoi32(arg + 3, &cto.lyrics_id);
2135                         if (ret < 0)
2136                                 return ret;
2137                         continue;
2138                 }
2139                 if (!strncmp(arg, "-i=", 3)) {
2140                         ret = para_atoi32(arg + 3, &cto.image_id);
2141                         if (ret < 0)
2142                                 return ret;
2143                         continue;
2144                 }
2145                 if (!strncmp(arg, "-a=", 3)) {
2146                         int32_t val;
2147                         ret = para_atoi32(arg + 3, &val);
2148                         if (ret < 0)
2149                                 return ret;
2150                         if (val < 0 || val > 255)
2151                                 return -ERRNO_TO_PARA_ERROR(EINVAL);
2152                         cto.amp = val;
2153                         continue;
2154                 }
2155                 if (!strcmp(arg, "-p")) {
2156                         cto.flags |= TOUCH_FLAG_FNM_PATHNAME;
2157                         continue;
2158                 }
2159                 if (!strcmp(arg, "-v")) {
2160                         cto.flags |= TOUCH_FLAG_VERBOSE;
2161                         continue;
2162                 }
2163                 break; /* non-option starting with dash */
2164         }
2165         if (i >= argc)
2166                 return -E_AFT_SYNTAX;
2167         ret = send_option_arg_callback_request(&query, argc - i,
2168                 argv + i, com_touch_callback, rc4_send_result, rc4c);
2169         if (ret < 0)
2170                 rc4_send_va_buffer(rc4c, "%s\n", para_strerror(-ret));
2171         return ret;
2172 }
2173
2174 /** Flags for com_rm(). */
2175 enum rm_flags {
2176         /** -v */
2177         RM_FLAG_VERBOSE = 1,
2178         /** -f */
2179         RM_FLAG_FORCE = 2,
2180         /** -p */
2181         RM_FLAG_FNM_PATHNAME = 4
2182 };
2183
2184 /** Data passed to the action handler of com_rm(). */
2185 struct com_rm_action_data {
2186         /** Command line flags ((see \ref rm_flags). */
2187         uint32_t flags;
2188         /** Message buffer. */
2189         struct para_buffer pb;
2190         /** Number of audio files removed. */
2191         unsigned num_removed;
2192 };
2193
2194 static int remove_audio_file(__a_unused struct osl_table *table,
2195                 struct osl_row *row, const char *name, void *data)
2196 {
2197         struct com_rm_action_data *crd = data;
2198         int ret;
2199
2200         if (crd->flags & RM_FLAG_VERBOSE) {
2201                 ret = para_printf(&crd->pb, "removing %s\n", name);
2202                 if (ret < 0)
2203                         return ret;
2204         }
2205         afs_event(AUDIO_FILE_REMOVE, &crd->pb, row);
2206         ret = osl(osl_del_row(audio_file_table, row));
2207         if (ret < 0)
2208                 para_printf(&crd->pb, "%s: %s\n", name, para_strerror(-ret));
2209         else
2210                 crd->num_removed++;
2211         return ret;
2212 }
2213
2214 static void com_rm_callback(int fd, const struct osl_object *query)
2215 {
2216         struct com_rm_action_data crd = {.flags = *(uint32_t *)query->data,
2217                 .pb = {
2218                         .max_size = SHMMAX,
2219                         .private_data = &fd,
2220                         .max_size_handler = pass_buffer_as_shm
2221                 }
2222         };
2223         int ret;
2224         struct pattern_match_data pmd = {
2225                 .table = audio_file_table,
2226                 .loop_col_num = AFTCOL_HASH,
2227                 .match_col_num = AFTCOL_PATH,
2228                 .patterns = {.data = (char *)query->data + sizeof(uint32_t),
2229                         .size = query->size - sizeof(uint32_t)},
2230                 .data = &crd,
2231                 .action = remove_audio_file
2232         };
2233         if (crd.flags & RM_FLAG_FNM_PATHNAME)
2234                 pmd.fnmatch_flags |= FNM_PATHNAME;
2235         ret = for_each_matching_row(&pmd);
2236         if (ret < 0) {
2237                 para_printf(&crd.pb, "%s\n", para_strerror(-ret));
2238                 return;
2239         }
2240         if (!crd.num_removed && !(crd.flags & RM_FLAG_FORCE))
2241                 ret = para_printf(&crd.pb, "no matches -- nothing removed\n");
2242         else {
2243                 if (crd.flags & RM_FLAG_VERBOSE)
2244                         ret = para_printf(&crd.pb, "removed %u files\n", crd.num_removed);
2245         }
2246         if (ret >= 0 && crd.pb.offset)
2247                 pass_buffer_as_shm(crd.pb.buf, crd.pb.offset, &fd);
2248         free(crd.pb.buf);
2249 }
2250
2251 /* TODO options: -r (recursive) */
2252 int com_rm(struct rc4_context *rc4c, int argc,  char * const * const argv)
2253 {
2254         uint32_t flags = 0;
2255         struct osl_object query = {.data = &flags, .size = sizeof(flags)};
2256         int i, ret;
2257
2258         for (i = 1; i < argc; i++) {
2259                 const char *arg = argv[i];
2260                 if (arg[0] != '-')
2261                         break;
2262                 if (!strcmp(arg, "--")) {
2263                         i++;
2264                         break;
2265                 }
2266                 if (!strcmp(arg, "-f")) {
2267                         flags |= RM_FLAG_FORCE;
2268                         continue;
2269                 }
2270                 if (!strcmp(arg, "-p")) {
2271                         flags |= RM_FLAG_FNM_PATHNAME;
2272                         continue;
2273                 }
2274                 if (!strcmp(arg, "-v")) {
2275                         flags |= RM_FLAG_VERBOSE;
2276                         continue;
2277                 }
2278                 break;
2279         }
2280         if (i >= argc)
2281                 return -E_AFT_SYNTAX;
2282         ret = send_option_arg_callback_request(&query, argc - i, argv + i,
2283                 com_rm_callback, rc4_send_result, rc4c);
2284         if (ret < 0)
2285                 rc4_send_va_buffer(rc4c, "%s\n", para_strerror(-ret));
2286         return ret;
2287 }
2288
2289 /**
2290  * Flags used by the cpsi command.
2291  *
2292  * \sa com_cpsi().
2293  */
2294 enum cpsi_flags {
2295         /** Whether the lyrics id should be copied. */
2296         CPSI_FLAG_COPY_LYRICS_ID = 1,
2297         /** Whether the image id should be copied. */
2298         CPSI_FLAG_COPY_IMAGE_ID = 2,
2299         /** Whether the lastplayed time should be copied. */
2300         CPSI_FLAG_COPY_LASTPLAYED = 4,
2301         /** Whether the numplayed count should be copied. */
2302         CPSI_FLAG_COPY_NUMPLAYED = 8,
2303         /** Whether the attributes should be copied. */
2304         CPSI_FLAG_COPY_ATTRIBUTES = 16,
2305         /** Activates verbose mode. */
2306         CPSI_FLAG_VERBOSE = 32,
2307 };
2308
2309 /** Data passed to the action handler of com_cpsi(). */
2310 struct cpsi_action_data {
2311         /** command line flags (see \ref cpsi_flags). */
2312         unsigned flags;
2313         /** Number of audio files changed. */
2314         unsigned num_copied;
2315         /** Message buffer. */
2316         struct para_buffer pb;
2317         /** Values are copied from here. */
2318         struct afs_info source_afsi;
2319 };
2320
2321 static int copy_selector_info(__a_unused struct osl_table *table,
2322                 struct osl_row *row, const char *name, void *data)
2323 {
2324         struct cpsi_action_data *cad = data;
2325         struct osl_object target_afsi_obj;
2326         int ret;
2327         struct afs_info old_afsi, target_afsi;
2328         struct afsi_change_event_data aced;
2329
2330         ret = get_afsi_object_of_row(row, &target_afsi_obj);
2331         if (ret < 0)
2332                 return ret;
2333         load_afsi(&target_afsi, &target_afsi_obj);
2334         old_afsi = target_afsi;
2335         if (cad->flags & CPSI_FLAG_COPY_LYRICS_ID)
2336                 target_afsi.lyrics_id = cad->source_afsi.lyrics_id;
2337         if (cad->flags & CPSI_FLAG_COPY_IMAGE_ID)
2338                 target_afsi.image_id = cad->source_afsi.image_id;
2339         if (cad->flags & CPSI_FLAG_COPY_LASTPLAYED)
2340                 target_afsi.last_played = cad->source_afsi.last_played;
2341         if (cad->flags & CPSI_FLAG_COPY_NUMPLAYED)
2342                 target_afsi.num_played = cad->source_afsi.num_played;
2343         if (cad->flags & CPSI_FLAG_COPY_ATTRIBUTES)
2344                 target_afsi.attributes = cad->source_afsi.attributes;
2345         save_afsi(&target_afsi, &target_afsi_obj); /* in-place update */
2346         cad->num_copied++;
2347         if (cad->flags & CPSI_FLAG_VERBOSE) {
2348                 ret = para_printf(&cad->pb, "copied afsi to %s\n", name);
2349                 if (ret < 0)
2350                         return ret;
2351         }
2352         aced.aft_row = row;
2353         aced.old_afsi = &old_afsi;
2354         afs_event(AFSI_CHANGE, &cad->pb, &aced);
2355         return 1;
2356 }
2357
2358 static void com_cpsi_callback(int fd, const struct osl_object *query)
2359 {
2360         struct cpsi_action_data cad = {
2361                 .flags = *(unsigned *)query->data,
2362                 .pb = {
2363                         .max_size = SHMMAX,
2364                         .private_data = &fd,
2365                         .max_size_handler = pass_buffer_as_shm
2366                 }
2367         };
2368         int ret;
2369         char *source_path = (char *)query->data + sizeof(cad.flags);
2370         struct pattern_match_data pmd = {
2371                 .table = audio_file_table,
2372                 .loop_col_num = AFTCOL_HASH,
2373                 .match_col_num = AFTCOL_PATH,
2374                 .patterns = {.data = source_path + strlen(source_path) + 1,
2375                         .size = query->size - sizeof(cad.flags)
2376                                 - strlen(source_path) - 1},
2377                 .data = &cad,
2378                 .action = copy_selector_info
2379         };
2380
2381         ret = get_afsi_of_path(source_path, &cad.source_afsi);
2382         if (ret < 0)
2383                 goto out;
2384         ret = for_each_matching_row(&pmd);
2385 out:
2386         if (ret < 0)
2387                 para_printf(&cad.pb, "%s\n", para_strerror(-ret));
2388         else if (cad.flags & CPSI_FLAG_VERBOSE) {
2389                 if (cad.num_copied)
2390                         para_printf(&cad.pb, "copied requested afsi from %s "
2391                                 "to %u files\n", source_path, cad.num_copied);
2392                 else
2393                         para_printf(&cad.pb, "nothing copied\n");
2394         }
2395         if (cad.pb.offset)
2396                 pass_buffer_as_shm(cad.pb.buf, cad.pb.offset, &fd);
2397         free(cad.pb.buf);
2398 }
2399
2400 int com_cpsi(struct rc4_context *rc4c, int argc,  char * const * const argv)
2401 {
2402         unsigned flags = 0;
2403         int i, ret;
2404         struct osl_object options = {.data = &flags, .size = sizeof(flags)};
2405
2406         for (i = 1; i < argc; i++) {
2407                 const char *arg = argv[i];
2408                 if (arg[0] != '-')
2409                         break;
2410                 if (!strcmp(arg, "--")) {
2411                         i++;
2412                         break;
2413                 }
2414                 if (!strcmp(arg, "-y")) {
2415                         flags |= CPSI_FLAG_COPY_LYRICS_ID;
2416                         continue;
2417                 }
2418                 if (!strcmp(arg, "-i")) {
2419                         flags |= CPSI_FLAG_COPY_IMAGE_ID;
2420                         continue;
2421                 }
2422                 if (!strcmp(arg, "-l")) {
2423                         flags |= CPSI_FLAG_COPY_LASTPLAYED;
2424                         continue;
2425                 }
2426                 if (!strcmp(arg, "-n")) {
2427                         flags |= CPSI_FLAG_COPY_NUMPLAYED;
2428                         continue;
2429                 }
2430                 if (!strcmp(arg, "-a")) {
2431                         flags |= CPSI_FLAG_COPY_ATTRIBUTES;
2432                         continue;
2433                 }
2434                 if (!strcmp(arg, "-v")) {
2435                         flags |= CPSI_FLAG_VERBOSE;
2436                         continue;
2437                 }
2438                 break;
2439         }
2440         if (i + 1 >= argc) /* need at least source file and pattern */
2441                 return -E_AFT_SYNTAX;
2442         if (!(flags & ~CPSI_FLAG_VERBOSE)) /* no copy flags given */
2443                 flags = ~(unsigned)CPSI_FLAG_VERBOSE | flags;
2444         ret = send_option_arg_callback_request(&options, argc - i, argv + i,
2445                 com_cpsi_callback, rc4_send_result, rc4c);
2446         if (ret < 0)
2447                 rc4_send_va_buffer(rc4c, "%s\n", para_strerror(-ret));
2448         return ret;
2449 }
2450
2451 static void afs_stat_callback(int fd, const struct osl_object *query)
2452 {
2453         int *parser_friendly = query->data;
2454         char *buf = *parser_friendly?
2455                 parser_friendly_status_items : status_items;
2456
2457         if (!buf)
2458                 return;
2459         pass_buffer_as_shm(buf, strlen(buf), &fd);
2460 }
2461
2462 /**
2463  * Get the current afs status items from the afs process and send it using RC4.
2464  *
2465  * \param rc4c The rc4 context for data encryption.
2466  * \param parser_friendly Whether parser-friendly output format should be used.
2467  *
2468  * As the contents of the afs status items change in time and the command
2469  * handler only has a COW version created at fork time, it can not send
2470  * up-to-date afs status items directly. Therefore the usual callback mechanism
2471  * is used to pass the status items from the afs process to the command handler
2472  * via a shared memory area and a pipe.
2473  */
2474 int send_afs_status(struct rc4_context *rc4c, int parser_friendly)
2475 {
2476         struct osl_object query = {.data = &parser_friendly,
2477                 .size = sizeof(parser_friendly)};
2478
2479         return send_callback_request(afs_stat_callback, &query, rc4_send_result, rc4c);
2480 }
2481
2482 /* TODO: optionally fix problems by removing offending rows */
2483 static int check_audio_file(struct osl_row *row, void *data)
2484 {
2485         char *path;
2486         struct para_buffer *pb = data;
2487         struct stat statbuf;
2488         int ret = get_audio_file_path_of_row(row, &path);
2489         struct afs_info afsi;
2490         char *blob_name;
2491
2492         if (ret < 0)
2493                 return para_printf(pb, "%s\n", para_strerror(-ret));
2494         if (stat(path, &statbuf) < 0) {
2495                 ret = para_printf(pb, "%s: stat error (%s)\n", path, strerror(errno));
2496                 if (ret < 0)
2497                         return ret;
2498         } else {
2499                 if (!S_ISREG(statbuf.st_mode)) {
2500                         ret = para_printf(pb, "%s: not a regular file\n", path);
2501                         if (ret < 0)
2502                                 return ret;
2503                 }
2504         }
2505         ret = get_afsi_of_row(row, &afsi);
2506         if (ret < 0)
2507                 return para_printf(pb, "%s: %s\n", path, para_strerror(-ret));
2508         ret = lyr_get_name_by_id(afsi.lyrics_id, &blob_name);
2509         if (ret < 0) {
2510                 ret = para_printf(pb, "%s lyrics id %u: %s\n", path, afsi.lyrics_id,
2511                         para_strerror(-ret));
2512                 if (ret < 0)
2513                         return ret;
2514         }
2515         ret = img_get_name_by_id(afsi.image_id, &blob_name);
2516         if (ret < 0)
2517                 ret = para_printf(pb, "%s image id %u: %s\n", path, afsi.image_id,
2518                         para_strerror(-ret));
2519         return ret;
2520 }
2521
2522 /**
2523  * Check the audio file table for inconsistencies.
2524  *
2525  * \param fd The afs socket.
2526  * \param query Unused.
2527  *
2528  * This function always succeeds.
2529  *
2530  * \sa com_check().
2531  */
2532 void aft_check_callback(int fd, __a_unused const struct osl_object *query)
2533 {
2534         struct para_buffer pb = {
2535                 .max_size = SHMMAX,
2536                 .private_data = &fd,
2537                 .max_size_handler = pass_buffer_as_shm
2538         };
2539         int ret = para_printf(&pb, "checking audio file table...\n");
2540
2541         if (ret < 0)
2542                 return;
2543         audio_file_loop(&pb, check_audio_file);
2544         if (pb.offset)
2545                 pass_buffer_as_shm(pb.buf, pb.offset, &fd);
2546         free(pb.buf);
2547 }
2548
2549 /**
2550  * Close the audio file table.
2551  *
2552  * \param flags Usual flags that are passed to osl_close_table().
2553  *
2554  * \sa osl_close_table().
2555  */
2556 static void aft_close(void)
2557 {
2558         osl_close_table(audio_file_table, OSL_MARK_CLEAN);
2559         audio_file_table = NULL;
2560         free(status_items);
2561         status_items = NULL;
2562         free(parser_friendly_status_items);
2563         parser_friendly_status_items = NULL;
2564 }
2565
2566 /**
2567  * Open the audio file table.
2568  *
2569  * \param dir The database directory.
2570  *
2571  * \return Standard.
2572  *
2573  * \sa osl_open_table().
2574  */
2575 static int aft_open(const char *dir)
2576 {
2577         int ret;
2578
2579         audio_file_table_desc.dir = dir;
2580         ret = osl(osl_open_table(&audio_file_table_desc, &audio_file_table));
2581         if (ret >= 0) {
2582                 unsigned num;
2583                 osl_get_num_rows(audio_file_table, &num);
2584                 PARA_INFO_LOG("audio file table contains %d files\n", num);
2585                 return ret;
2586         }
2587         PARA_INFO_LOG("failed to open audio file table\n");
2588         audio_file_table = NULL;
2589         if (ret >= 0 || ret == -OSL_ERRNO_TO_PARA_ERROR(E_OSL_NOENT))
2590                 return 1;
2591         return ret;
2592 }
2593
2594 static int aft_create(const char *dir)
2595 {
2596         audio_file_table_desc.dir = dir;
2597         return osl(osl_create_table(&audio_file_table_desc));
2598 }
2599
2600 static int clear_attribute(struct osl_row *row, void *data)
2601 {
2602         struct rmatt_event_data *red = data;
2603         struct afs_info afsi;
2604         struct osl_object obj;
2605         int ret = get_afsi_object_of_row(row, &obj);
2606         uint64_t mask = ~(1ULL << red->bitnum);
2607
2608         if (ret < 0)
2609                 return ret;
2610         ret = load_afsi(&afsi, &obj);
2611         if (ret < 0)
2612                 return ret;
2613         afsi.attributes &= mask;
2614         save_afsi(&afsi, &obj);
2615         return 1;
2616 }
2617
2618 static int aft_event_handler(enum afs_events event, struct para_buffer *pb,
2619                 void *data)
2620 {
2621         int ret;
2622
2623         switch(event) {
2624         case ATTRIBUTE_REMOVE: {
2625                 const struct rmatt_event_data *red = data;
2626                 ret = para_printf(pb, "clearing attribute %s (bit %u) from all "
2627                         "entries in the audio file table\n", red->name,
2628                         red->bitnum);
2629                 if (ret < 0)
2630                         return ret;
2631                 return audio_file_loop(data, clear_attribute);
2632                 }
2633         default:
2634                 return 1;
2635         }
2636 }
2637
2638 /**
2639  * Initialize the audio file table.
2640  *
2641  * \param t Pointer to the structure to be initialized.
2642  */
2643 void aft_init(struct afs_table *t)
2644 {
2645         t->open = aft_open;
2646         t->close = aft_close;
2647         t->create = aft_create;
2648         t->event_handler = aft_event_handler;
2649 }