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