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