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