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