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