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