aft.c

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