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