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