aft.c

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