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