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