afs: Improve error diagnostics if no admissible files are found.
[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, size_t bufsize,
725                 struct ls_options *opts)
726 {
727         unsigned hours = seconds / 3600, mins = (seconds % 3600) / 60;
728         short unsigned max_width;
729
730         if (!hours) { /* m:ss or mm:ss */
731                 max_width = opts->mode == LS_MODE_LONG?
732                         opts->widths.duration_width : 4;
733                 assert(max_width < bufsize - 1);
734                 sprintf(buf, "%*u:%02d", max_width - 3, mins, seconds % 60);
735         } else { /* more than one hour => h:mm:ss, hh:mm:ss, hhh:mm:ss, ... */
736                 max_width = opts->mode == LS_MODE_LONG?
737                         opts->widths.duration_width : 7;
738                 assert(max_width < bufsize - 1);
739                 sprintf(buf, "%*u:%02u:%02d", max_width - 6, hours, mins,
740                         seconds % 60);
741         }
742 }
743
744 static int write_attribute_items(struct para_buffer *b,
745                 const char *att_bitmap, struct afs_info *afsi)
746 {
747         char *att_text;
748         int ret;
749
750         WRITE_STATUS_ITEM(b, SI_attributes_bitmap, "%s\n", att_bitmap);
751         ret = get_attribute_text(&afsi->attributes, " ", &att_text);
752         if (ret < 0)
753                 return ret;
754         WRITE_STATUS_ITEM(b, SI_attributes_txt, "%s\n", att_text);
755         free(att_text);
756         return ret;
757 }
758
759 static void write_lyrics_items(struct para_buffer *b, struct afs_info *afsi)
760 {
761         char *lyrics_name;
762
763         WRITE_STATUS_ITEM(b, SI_lyrics_id, "%u\n", afsi->lyrics_id);
764         lyr_get_name_by_id(afsi->lyrics_id, &lyrics_name);
765         WRITE_STATUS_ITEM(b, SI_lyrics_name, "%s\n", lyrics_name?
766                 lyrics_name : "(none)");
767 }
768
769 static void write_image_items(struct para_buffer *b, struct afs_info *afsi)
770 {
771         char *image_name;
772
773         WRITE_STATUS_ITEM(b, SI_image_id, "%u\n", afsi->image_id);
774         img_get_name_by_id(afsi->image_id, &image_name);
775         WRITE_STATUS_ITEM(b, SI_image_name, "%s\n", image_name?
776                 image_name : "(none)");
777 }
778
779 static void write_filename_items(struct para_buffer *b, const char *path,
780                 bool basename)
781 {
782         char *val;
783
784         if (basename) {
785                 WRITE_STATUS_ITEM(b, SI_basename, "%s\n", path);
786                 return;
787         }
788         WRITE_STATUS_ITEM(b, SI_path, "%s\n", path);
789         val = para_basename(path);
790         WRITE_STATUS_ITEM(b, SI_basename, "%s\n", val? val : "");
791         val = para_dirname(path);
792         WRITE_STATUS_ITEM(b, SI_directory, "%s\n", val? val : "");
793         free(val);
794 }
795
796 static int print_chunk_table(struct ls_data *d, struct para_buffer *b)
797 {
798         struct osl_object chunk_table_obj;
799         struct osl_row *aft_row;
800         int ret, i;
801         char *buf;
802
803         ret = aft_get_row_of_hash(d->hash, &aft_row);
804         if (ret < 0)
805                 return ret;
806         ret = osl(osl_open_disk_object(audio_file_table, aft_row,
807                 AFTCOL_CHUNKS, &chunk_table_obj));
808         if (ret < 0)
809                 return ret;
810         para_printf(b, "%s\n"
811                 "chunk_time: %lu:%lu\nchunk_offsets: ",
812                 d->path,
813                 (long unsigned) d->afhi.chunk_tv.tv_sec,
814                 (long unsigned) d->afhi.chunk_tv.tv_usec
815         );
816         buf = chunk_table_obj.data;
817         for (
818                 i = 0;
819                 i <= d->afhi.chunks_total && 4 * i + 3 < chunk_table_obj.size;
820                 i++
821         )
822                 para_printf(b, "%u ", (unsigned) read_u32(buf + 4 * i));
823         para_printf(b, "\n");
824         ret = 1;
825         osl_close_disk_object(&chunk_table_obj);
826         return ret;
827 }
828
829 static int print_list_item(struct ls_data *d, struct ls_options *opts,
830         struct para_buffer *b, time_t current_time)
831 {
832         const struct lls_opt_result *r_a = SERVER_CMD_OPT_RESULT(LS, ADMISSIBLE, opts->lpr);
833         const struct lls_opt_result *r_b = SERVER_CMD_OPT_RESULT(LS, BASENAME, opts->lpr);
834         const struct lls_opt_result *r_d = SERVER_CMD_OPT_RESULT(LS, UNIX_DATE, opts->lpr);
835         int ret;
836         char att_buf[65];
837         char last_played_time[30];
838         char duration_buf[30]; /* nobody has an audio file long enough to overflow this */
839         struct afs_info *afsi = &d->afsi;
840         struct afh_info *afhi = &d->afhi;
841         char asc_hash[2 * HASH_SIZE + 1];
842
843         if (opts->mode == LS_MODE_SHORT) {
844                 para_printf(b, "%s\n", d->path);
845                 ret = 1;
846                 goto out;
847         }
848         if (opts->mode == LS_MODE_CHUNKS) {
849                 ret = print_chunk_table(d, b);
850                 goto out;
851         }
852         get_attribute_bitmap(&afsi->attributes, att_buf);
853         if (lls_opt_given(r_d))
854                 sprintf(last_played_time, "%llu",
855                         (long long unsigned)afsi->last_played);
856         else {
857                 ret = get_local_time(&afsi->last_played, last_played_time,
858                         sizeof(last_played_time), current_time, opts->mode);
859                 if (ret < 0)
860                         goto out;
861         }
862         get_duration_buf(afhi->seconds_total, duration_buf,
863                 sizeof(duration_buf), opts);
864         if (opts->mode == LS_MODE_LONG) {
865                 struct ls_widths *w = &opts->widths;
866                 if (lls_opt_given(r_a))
867                         para_printf(b, "%*li ", opts->widths.score_width,
868                                 d->score);
869                 para_printf(b,
870                         "%s "   /* attributes */
871                         "%*u "  /* amp */
872                         "%*u "  /* image_id  */
873                         "%*u "  /* lyrics_id */
874                         "%*u "  /* bitrate */
875                         "%*s "  /* audio format */
876                         "%*u "  /* frequency */
877                         "%u "   /* channels */
878                         "%s "   /* duration */
879                         "%*u "  /* num_played */
880                         "%s "   /* last_played */
881                         "%s\n", /* path */
882                         att_buf,
883                         w->amp_width, afsi->amp,
884                         w->image_id_width, afsi->image_id,
885                         w->lyrics_id_width, afsi->lyrics_id,
886                         w->bitrate_width, afhi->bitrate,
887                         w->audio_format_width,
888                         audio_format_name(afsi->audio_format_id),
889                         w->frequency_width, afhi->frequency,
890                         afhi->channels,
891                         duration_buf,
892                         w->num_played_width, afsi->num_played,
893                         last_played_time,
894                         d->path
895                 );
896                 ret = 1;
897                 goto out;
898         }
899         if (opts->mode == LS_MODE_MBOX) {
900                 const char *bn = para_basename(d->path);
901                 para_printf(b,
902                         "From foo@localhost %s\n"
903                         "Received: from\nTo: bar\nFrom: a\n"
904                         "Subject: %s\n\n",
905                         last_played_time,
906                         bn? bn : "?");
907         }
908         write_filename_items(b, d->path, lls_opt_given(r_b));
909         if (lls_opt_given(r_a))
910                 WRITE_STATUS_ITEM(b, SI_score, "%li\n", d->score);
911         ret = write_attribute_items(b, att_buf, afsi);
912         if (ret < 0)
913                 goto out;
914         write_image_items(b, afsi);
915         write_lyrics_items(b, afsi);
916         hash_to_asc(d->hash, asc_hash);
917         WRITE_STATUS_ITEM(b, SI_hash, "%s\n", asc_hash);
918         WRITE_STATUS_ITEM(b, SI_bitrate, "%dkbit/s\n", afhi->bitrate);
919         WRITE_STATUS_ITEM(b, SI_format, "%s\n",
920                 audio_format_name(afsi->audio_format_id));
921         WRITE_STATUS_ITEM(b, SI_frequency, "%dHz\n", afhi->frequency);
922         WRITE_STATUS_ITEM(b, SI_channels, "%d\n", afhi->channels);
923         WRITE_STATUS_ITEM(b, SI_duration, "%s\n", duration_buf);
924         WRITE_STATUS_ITEM(b, SI_seconds_total, "%" PRIu32 "\n",
925                 afhi->seconds_total);
926         WRITE_STATUS_ITEM(b, SI_last_played, "%s\n", last_played_time);
927         WRITE_STATUS_ITEM(b, SI_num_played, "%u\n", afsi->num_played);
928         WRITE_STATUS_ITEM(b, SI_amplification, "%u\n", afsi->amp);
929         WRITE_STATUS_ITEM(b, SI_chunk_time, "%lu\n", tv2ms(&afhi->chunk_tv));
930         WRITE_STATUS_ITEM(b, SI_num_chunks, "%" PRIu32 "\n",
931                 afhi->chunks_total);
932         WRITE_STATUS_ITEM(b, SI_max_chunk_size, "%" PRIu32 "\n",
933                 afhi->max_chunk_size);
934         WRITE_STATUS_ITEM(b, SI_techinfo, "%s\n", afhi->techinfo);
935         WRITE_STATUS_ITEM(b, SI_artist, "%s\n", afhi->tags.artist);
936         WRITE_STATUS_ITEM(b, SI_title, "%s\n", afhi->tags.title);
937         WRITE_STATUS_ITEM(b, SI_year, "%s\n", afhi->tags.year);
938         WRITE_STATUS_ITEM(b, SI_album, "%s\n", afhi->tags.album);
939         WRITE_STATUS_ITEM(b, SI_comment, "%s\n", afhi->tags.comment);
940         if (opts->mode == LS_MODE_MBOX) {
941                 struct osl_object lyrics_def;
942                 lyr_get_def_by_id(afsi->lyrics_id, &lyrics_def);
943                 if (lyrics_def.data) {
944                         para_printf(b, "Lyrics:\n~~~~~~~\n%s",
945                                 (char *)lyrics_def.data);
946                         osl_close_disk_object(&lyrics_def);
947                 }
948         }
949 out:
950         return ret;
951 }
952
953 static void make_inode_status_items(struct para_buffer *pb)
954 {
955         struct stat statbuf = {.st_size = 0};
956         char *path, mtime_str[30] = "\0";
957         struct tm mtime_tm;
958         int ret;
959
960         ret = get_audio_file_path_of_row(current_aft_row, &path);
961         if (ret < 0)
962                 goto out;
963         ret = stat(path, &statbuf);
964         if (ret < 0)
965                 goto out;
966         localtime_r(&statbuf.st_mtime, &mtime_tm);
967         ret = strftime(mtime_str, 29, "%b %d %Y", &mtime_tm);
968         assert(ret > 0); /* number of bytes placed in mtime_str */
969 out:
970         WRITE_STATUS_ITEM(pb, SI_mtime, "%s\n", mtime_str);
971         WRITE_STATUS_ITEM(pb, SI_file_size, "%ld\n", statbuf.st_size / 1024);
972 }
973
974 /**
975  * Deallocate and invalidate the status item strings.
976  *
977  * This needs to be a public function so that afs.c can call it on shutdown.
978  */
979 void free_status_items(void)
980 {
981         freep(&status_items);
982         freep(&parser_friendly_status_items);
983 }
984
985 static void make_status_items(void)
986 {
987         const struct lls_command *cmd = SERVER_CMD_CMD_PTR(LS);
988         char *argv[] = {"ls", "--admissible", "--listing-mode=verbose"};
989         struct ls_options opts = {.mode = LS_MODE_VERBOSE};
990         struct para_buffer pb = {.max_size = shm_get_shmmax() - 1};
991         time_t current_time;
992         int ret;
993
994         free_status_items();
995         if (!status_item_ls_data.path) /* no audio file open */
996                 return;
997         ret = lls_parse(ARRAY_SIZE(argv), argv, cmd, &opts.lpr, NULL);
998         assert(ret >= 0);
999         time(&current_time);
1000         ret = print_list_item(&status_item_ls_data, &opts, &pb, current_time);
1001         if (ret < 0)
1002                 goto out;
1003         make_inode_status_items(&pb);
1004         status_items = pb.buf;
1005
1006         memset(&pb, 0, sizeof(pb));
1007         pb.max_size = shm_get_shmmax() - 1;
1008         pb.flags = PBF_SIZE_PREFIX;
1009         ret = print_list_item(&status_item_ls_data, &opts, &pb, current_time);
1010         if (ret < 0)
1011                 goto out;
1012         make_inode_status_items(&pb);
1013         parser_friendly_status_items = pb.buf;
1014         ret = 1;
1015 out:
1016         if (ret < 0) {
1017                 PARA_WARNING_LOG("could not create status items: %s\n",
1018                         para_strerror(-ret));
1019                 free_status_items();
1020         }
1021         lls_free_parse_result(opts.lpr, cmd);
1022 }
1023
1024 /**
1025  * Open the audio file with highest score and set up an afd structure.
1026  *
1027  * \param afd Result pointer.
1028  *
1029  * On success, the numplayed field of the audio file selector info is increased
1030  * and the lastplayed time is set to the current time. Finally, the score of
1031  * the audio file is updated.
1032  *
1033  * \return Positive shmid on success, negative on errors.
1034  */
1035 int open_and_update_audio_file(struct audio_file_data *afd)
1036 {
1037         unsigned char file_hash[HASH_SIZE];
1038         struct osl_object afsi_obj;
1039         struct afs_info new_afsi;
1040         int ret;
1041         struct afsi_change_event_data aced;
1042         struct osl_object map, chunk_table_obj;
1043         struct ls_data *d = &status_item_ls_data;
1044         unsigned char *tmp_hash;
1045 again:
1046         ret = score_get_best(&current_aft_row, &d->score);
1047         if (ret < 0)
1048                 return ret;
1049         /*
1050          * get_hash_of_row() and get_audio_file_path_of_row() initialize
1051          * their pointer argument to point to memory-mapped files. These pointers
1052          * become stale after a new audio file has been added or after the
1053          * server process received SIGHUP. For in both cases libosl unmaps and
1054          * remaps the underlying database files, and this remapping may well
1055          * change the starting address of the mapping. To avoid stale pointer
1056          * references we create copies on the heap.
1057          */
1058         ret = get_hash_of_row(current_aft_row, &tmp_hash);
1059         if (ret < 0)
1060                 return ret;
1061         if (!d->hash)
1062                 d->hash = para_malloc(HASH_SIZE);
1063         memcpy(d->hash, tmp_hash, HASH_SIZE);
1064         free(d->path);
1065         ret = get_audio_file_path_of_row(current_aft_row, &d->path);
1066         if (ret < 0)
1067                 return ret;
1068         PARA_NOTICE_LOG("%s\n", d->path);
1069         d->path = para_strdup(d->path);
1070
1071         ret = get_afsi_object_of_row(current_aft_row, &afsi_obj);
1072         if (ret < 0)
1073                 return ret;
1074         ret = load_afsi(&d->afsi, &afsi_obj);
1075         if (ret < 0)
1076                 return ret;
1077         ret = get_afhi_of_row(current_aft_row, &afd->afhi);
1078         if (ret < 0)
1079                 return ret;
1080         d->afhi = afd->afhi;
1081         d->afhi.chunk_table = afd->afhi.chunk_table = NULL;
1082         ret = osl(osl_open_disk_object(audio_file_table, current_aft_row,
1083                 AFTCOL_CHUNKS, &chunk_table_obj));
1084         if (ret < 0) {
1085                 if (!afh_supports_dynamic_chunks(d->afsi.audio_format_id))
1086                         return ret;
1087                 PARA_INFO_LOG("no chunk table for %s\n", d->path);
1088                 chunk_table_obj.data = NULL;
1089                 chunk_table_obj.size = 0;
1090         } else {
1091                 PARA_INFO_LOG("chunk table: %zu bytes\n", chunk_table_obj.size);
1092         }
1093         ret = mmap_full_file(d->path, O_RDONLY, &map.data, &map.size, &afd->fd);
1094         if (ret < 0)
1095                 goto out;
1096         hash_function(map.data, map.size, file_hash);
1097         ret = hash_compare(file_hash, d->hash);
1098         para_munmap(map.data, map.size);
1099         if (ret) {
1100                 ret = -E_HASH_MISMATCH;
1101                 goto out;
1102         }
1103         new_afsi = d->afsi;
1104         new_afsi.num_played++;
1105         new_afsi.last_played = time(NULL);
1106         save_afsi(&new_afsi, &afsi_obj); /* in-place update */
1107
1108         afd->audio_format_id = d->afsi.audio_format_id;
1109         load_chunk_table(&afd->afhi, &chunk_table_obj);
1110         aced.aft_row = current_aft_row;
1111         aced.old_afsi = &d->afsi;
1112         /*
1113          * No need to update the status items as the AFSI_CHANGE event will
1114          * recreate them.
1115          */
1116         ret = afs_event(AFSI_CHANGE, NULL, &aced);
1117         if (ret < 0)
1118                 goto out;
1119         ret = save_afd(afd);
1120 out:
1121         free(afd->afhi.chunk_table);
1122         if (chunk_table_obj.data)
1123                 osl_close_disk_object(&chunk_table_obj);
1124         if (ret < 0) {
1125                 PARA_ERROR_LOG("%s: %s\n", d->path, para_strerror(-ret));
1126                 ret = score_delete(current_aft_row);
1127                 if (ret >= 0)
1128                         goto again;
1129         }
1130         return ret;
1131 }
1132
1133 static int ls_hash_compare(const void *a, const void *b)
1134 {
1135         struct ls_data *d1 = *(struct ls_data **)a, *d2 = *(struct ls_data **)b;
1136         return memcmp(d1->hash, d2->hash, HASH_SIZE);
1137 }
1138
1139 static int ls_audio_format_compare(const void *a, const void *b)
1140 {
1141         struct ls_data *d1 = *(struct ls_data **)a, *d2 = *(struct ls_data **)b;
1142         return NUM_COMPARE(d1->afsi.audio_format_id, d2->afsi.audio_format_id);
1143 }
1144
1145 static int ls_duration_compare(const void *a, const void *b)
1146 {
1147         struct ls_data *d1 = *(struct ls_data **)a, *d2 = *(struct ls_data **)b;
1148         return NUM_COMPARE(d1->afhi.seconds_total, d2->afhi.seconds_total);
1149 }
1150
1151 static int ls_bitrate_compare(const void *a, const void *b)
1152 {
1153         struct ls_data *d1 = *(struct ls_data **)a, *d2 = *(struct ls_data **)b;
1154         return NUM_COMPARE(d1->afhi.bitrate, d2->afhi.bitrate);
1155 }
1156
1157 static int ls_lyrics_id_compare(const void *a, const void *b)
1158 {
1159         struct ls_data *d1 = *(struct ls_data **)a, *d2 = *(struct ls_data **)b;
1160         return NUM_COMPARE(d1->afsi.lyrics_id, d2->afsi.lyrics_id);
1161 }
1162
1163 static int ls_image_id_compare(const void *a, const void *b)
1164 {
1165         struct ls_data *d1 = *(struct ls_data **)a, *d2 = *(struct ls_data **)b;
1166         return NUM_COMPARE(d1->afsi.image_id, d2->afsi.image_id);
1167 }
1168
1169 static int ls_channels_compare(const void *a, const void *b)
1170 {
1171         struct ls_data *d1 = *(struct ls_data **)a, *d2 = *(struct ls_data **)b;
1172         return NUM_COMPARE(d1->afhi.channels, d2->afhi.channels);
1173 }
1174
1175 static int ls_frequency_compare(const void *a, const void *b)
1176 {
1177         struct ls_data *d1 = *(struct ls_data **)a, *d2 = *(struct ls_data **)b;
1178         return NUM_COMPARE(d1->afhi.frequency, d2->afhi.frequency);
1179 }
1180
1181 static int ls_num_played_compare(const void *a, const void *b)
1182 {
1183         struct ls_data *d1 = *(struct ls_data **)a, *d2 = *(struct ls_data **)b;
1184         return NUM_COMPARE(d1->afsi.num_played, d2->afsi.num_played);
1185 }
1186
1187 static int ls_last_played_compare(const void *a, const void *b)
1188 {
1189         struct ls_data *d1 = *(struct ls_data **)a, *d2 = *(struct ls_data **)b;
1190         return NUM_COMPARE(d1->afsi.last_played, d2->afsi.last_played);
1191 }
1192
1193 static int ls_score_compare(const void *a, const void *b)
1194 {
1195         struct ls_data *d1 = *(struct ls_data **)a, *d2 = *(struct ls_data **)b;
1196         return NUM_COMPARE(d1->score, d2->score);
1197 }
1198
1199 static int ls_path_compare(const void *a, const void *b)
1200 {
1201         struct ls_data *d1 = *(struct ls_data **)a, *d2 = *(struct ls_data **)b;
1202         return strcmp(d1->path, d2->path);
1203 }
1204
1205 static inline bool admissible_only(struct ls_options *opts)
1206 {
1207         return SERVER_CMD_OPT_GIVEN(LS, ADMISSIBLE, opts->lpr)
1208                 || opts->sorting == LS_SORT_BY_SCORE;
1209 }
1210
1211 static int sort_matching_paths(struct ls_options *options)
1212 {
1213         const struct lls_opt_result *r_b = SERVER_CMD_OPT_RESULT(LS, BASENAME,
1214                 options->lpr);
1215         size_t nmemb = options->num_matching_paths;
1216         size_t size = sizeof(*options->data_ptr);
1217         int (*compar)(const void *, const void *);
1218         int i;
1219
1220         options->data_ptr = para_malloc(nmemb * sizeof(*options->data_ptr));
1221         for (i = 0; i < nmemb; i++)
1222                 options->data_ptr[i] = options->data + i;
1223
1224         /* In these cases the array is already sorted */
1225         if (admissible_only(options)) {
1226                 if (options->sorting == LS_SORT_BY_SCORE)
1227                         return 1;
1228         } else {
1229                 if (options->sorting == LS_SORT_BY_PATH && !lls_opt_given(r_b))
1230                         return 1;
1231         }
1232
1233         switch (options->sorting) {
1234         case LS_SORT_BY_PATH:
1235                 compar = ls_path_compare; break;
1236         case LS_SORT_BY_SCORE:
1237                 compar = ls_score_compare; break;
1238         case LS_SORT_BY_LAST_PLAYED:
1239                 compar = ls_last_played_compare; break;
1240         case LS_SORT_BY_NUM_PLAYED:
1241                 compar = ls_num_played_compare; break;
1242         case LS_SORT_BY_FREQUENCY:
1243                 compar = ls_frequency_compare; break;
1244         case LS_SORT_BY_CHANNELS:
1245                 compar = ls_channels_compare; break;
1246         case LS_SORT_BY_IMAGE_ID:
1247                 compar = ls_image_id_compare; break;
1248         case LS_SORT_BY_LYRICS_ID:
1249                 compar = ls_lyrics_id_compare; break;
1250         case LS_SORT_BY_BITRATE:
1251                 compar = ls_bitrate_compare; break;
1252         case LS_SORT_BY_DURATION:
1253                 compar = ls_duration_compare; break;
1254         case LS_SORT_BY_AUDIO_FORMAT:
1255                 compar = ls_audio_format_compare; break;
1256         case LS_SORT_BY_HASH:
1257                 compar = ls_hash_compare; break;
1258         default:
1259                 return -E_BAD_SORT;
1260         }
1261         qsort(options->data_ptr, nmemb, size, compar);
1262         return 1;
1263 }
1264
1265 /* row is either an aft_row or a row of the score table */
1266 /* TODO: Only compute widths if we need them */
1267 static int prepare_ls_row(struct osl_row *row, void *ls_opts)
1268 {
1269         int ret, i;
1270         struct ls_options *options = ls_opts;
1271         bool basename_given = SERVER_CMD_OPT_GIVEN(LS, BASENAME, options->lpr);
1272         struct ls_data *d;
1273         struct ls_widths *w;
1274         unsigned short num_digits;
1275         unsigned tmp, num_inputs;
1276         struct osl_row *aft_row;
1277         long score;
1278         char *path;
1279
1280         if (admissible_only(options)) {
1281                 ret = get_score_and_aft_row(row, &score, &aft_row);
1282                 if (ret < 0)
1283                         return ret;
1284         } else {
1285                 aft_row = row;
1286                 score = 0;
1287         }
1288         ret = get_audio_file_path_of_row(aft_row, &path);
1289         if (ret < 0)
1290                 return ret;
1291         if (basename_given) {
1292                 char *p = strrchr(path, '/');
1293                 if (p)
1294                         path = p + 1;
1295         }
1296         num_inputs = lls_num_inputs(options->lpr);
1297         if (num_inputs > 0) {
1298                 for (i = 0; i < num_inputs; i++) {
1299                         ret = fnmatch(lls_input(i, options->lpr), path, 0);
1300                         if (!ret)
1301                                 break;
1302                         if (ret == FNM_NOMATCH)
1303                                 continue;
1304                         return -E_FNMATCH;
1305                 }
1306                 if (i >= num_inputs) /* no match */
1307                         return 1;
1308         }
1309         tmp = options->num_matching_paths++;
1310         if (options->num_matching_paths > options->array_size) {
1311                 options->array_size++;
1312                 options->array_size *= 2;
1313                 options->data = para_realloc(options->data, options->array_size
1314                         * sizeof(*options->data));
1315         }
1316         d = options->data + tmp;
1317         ret = get_afsi_of_row(aft_row, &d->afsi);
1318         if (ret < 0)
1319                 return ret;
1320         ret = get_afhi_of_row(aft_row, &d->afhi);
1321         if (ret < 0)
1322                 return ret;
1323         d->path = path;
1324         ret = get_hash_of_row(aft_row, &d->hash);
1325         if (ret < 0)
1326                 goto err;
1327         w = &options->widths;
1328         GET_NUM_DIGITS(d->afsi.image_id, &num_digits);
1329         w->image_id_width = PARA_MAX(w->image_id_width, num_digits);
1330         GET_NUM_DIGITS(d->afsi.lyrics_id, &num_digits);
1331         w->lyrics_id_width = PARA_MAX(w->lyrics_id_width, num_digits);
1332         GET_NUM_DIGITS(d->afhi.bitrate, &num_digits);
1333         w->bitrate_width = PARA_MAX(w->bitrate_width, num_digits);
1334         GET_NUM_DIGITS(d->afhi.frequency, &num_digits);
1335         w->frequency_width = PARA_MAX(w->frequency_width, num_digits);
1336         GET_NUM_DIGITS(d->afsi.num_played, &num_digits);
1337         w->num_played_width = PARA_MAX(w->num_played_width, num_digits);
1338         /* get the number of chars to print this amount of time */
1339         num_digits = get_duration_width(d->afhi.seconds_total);
1340         w->duration_width = PARA_MAX(w->duration_width, num_digits);
1341         GET_NUM_DIGITS(d->afsi.amp, &num_digits);
1342         w->amp_width = PARA_MAX(w->amp_width, num_digits);
1343         num_digits = strlen(audio_format_name(d->afsi.audio_format_id));
1344         w->audio_format_width = PARA_MAX(w->audio_format_width, num_digits);
1345         if (admissible_only(options)) {
1346                 GET_NUM_DIGITS(score, &num_digits);
1347                 num_digits++; /* add one for the sign (space or "-") */
1348                 w->score_width = PARA_MAX(w->score_width, num_digits);
1349                 d->score = score;
1350         }
1351         return 1;
1352 err:
1353         return ret;
1354 }
1355
1356 static int com_ls_callback(struct afs_callback_arg *aca)
1357 {
1358         const struct lls_command *cmd = SERVER_CMD_CMD_PTR(LS);
1359         struct ls_options *opts = aca->query.data;
1360         int i = 0, ret;
1361         time_t current_time;
1362         const struct lls_opt_result *r_r;
1363
1364         ret = lls_deserialize_parse_result(
1365                 (char *)aca->query.data + sizeof(*opts), cmd, &opts->lpr);
1366         assert(ret >= 0);
1367         r_r = SERVER_CMD_OPT_RESULT(LS, REVERSE, opts->lpr);
1368
1369         aca->pbout.flags = (opts->mode == LS_MODE_PARSER)? PBF_SIZE_PREFIX : 0;
1370         if (admissible_only(opts))
1371                 ret = admissible_file_loop(opts, prepare_ls_row);
1372         else
1373                 ret = osl(osl_rbtree_loop(audio_file_table, AFTCOL_PATH, opts,
1374                         prepare_ls_row));
1375         if (ret < 0)
1376                 goto out;
1377         if (opts->num_matching_paths == 0) {
1378                 ret = lls_num_inputs(opts->lpr) > 0? -E_NO_MATCH : 0;
1379                 goto out;
1380         }
1381         ret = sort_matching_paths(opts);
1382         if (ret < 0)
1383                 goto out;
1384         time(&current_time);
1385         if (lls_opt_given(r_r))
1386                 for (i = opts->num_matching_paths - 1; i >= 0; i--) {
1387                         ret = print_list_item(opts->data_ptr[i], opts,
1388                                 &aca->pbout, current_time);
1389                         if (ret < 0)
1390                                 goto out;
1391                 }
1392         else
1393                 for (i = 0; i < opts->num_matching_paths; i++) {
1394                         ret = print_list_item(opts->data_ptr[i], opts,
1395                                 &aca->pbout, current_time);
1396                         if (ret < 0)
1397                                 goto out;
1398                 }
1399 out:
1400         lls_free_parse_result(opts->lpr, cmd);
1401         free(opts->data);
1402         free(opts->data_ptr);
1403         return ret;
1404 }
1405
1406 static int com_ls(struct command_context *cc, struct lls_parse_result *lpr)
1407 {
1408         const struct lls_command *cmd = SERVER_CMD_CMD_PTR(LS);
1409         struct ls_options *opts;
1410         struct osl_object query;
1411         const struct lls_opt_result *r_l = SERVER_CMD_OPT_RESULT(LS, LISTING_MODE,
1412                 lpr);
1413         const struct lls_opt_result *r_s = SERVER_CMD_OPT_RESULT(LS, SORT, lpr);
1414         int ret;
1415         char *slpr;
1416
1417         ret = lls_serialize_parse_result(lpr, cmd, NULL, &query.size);
1418         assert(ret >= 0);
1419         query.size += sizeof(*opts);
1420         query.data = para_malloc(query.size);
1421         opts = query.data;
1422         memset(opts, 0, sizeof(*opts));
1423         slpr = query.data + sizeof(*opts);
1424         ret = lls_serialize_parse_result(lpr, cmd, &slpr, NULL);
1425         assert(ret >= 0);
1426         opts->mode = LS_MODE_SHORT;
1427         opts->sorting = LS_SORT_BY_PATH;
1428         if (lls_opt_given(r_l)) {
1429                 const char *val = lls_string_val(0, r_l);
1430                 if (!strcmp(val, "l") || !strcmp(val, "long"))
1431                         opts->mode = LS_MODE_LONG;
1432                 else if (!strcmp(val, "s") || !strcmp(val, "short"))
1433                         opts->mode = LS_MODE_SHORT;
1434                 else if (!strcmp(val, "v") || !strcmp(val, "verbose"))
1435                         opts->mode = LS_MODE_VERBOSE;
1436                 else if (!strcmp(val, "m") || !strcmp(val, "mbox"))
1437                         opts->mode = LS_MODE_MBOX;
1438                 else if (!strcmp(val, "c") || !strcmp(val, "chunk-table"))
1439                         opts->mode = LS_MODE_MBOX;
1440                 else if (!strcmp(val, "p") || !strcmp(val, "parser-friendly"))
1441                         opts->mode = LS_MODE_PARSER;
1442                 else {
1443                         ret = -E_AFT_SYNTAX;
1444                         goto out;
1445                 }
1446         }
1447         if (lls_opt_given(r_s)) {
1448                 const char *val = lls_string_val(0, r_s);
1449                 if (!strcmp(val, "p") || !strcmp(val, "path"))
1450                         opts->sorting = LS_SORT_BY_PATH;
1451                 else if (!strcmp(val, "s") || !strcmp(val, "score"))
1452                         opts->sorting = LS_SORT_BY_SCORE;
1453                 else if (!strcmp(val, "l") || !strcmp(val, "lastplayed"))
1454                         opts->sorting = LS_SORT_BY_LAST_PLAYED;
1455                 else if (!strcmp(val, "n") || !strcmp(val, "numplayed"))
1456                         opts->sorting = LS_SORT_BY_NUM_PLAYED;
1457                 else if (!strcmp(val, "f") || !strcmp(val, "frquency"))
1458                         opts->sorting = LS_SORT_BY_FREQUENCY;
1459                 else if (!strcmp(val, "c") || !strcmp(val, "channels"))
1460                         opts->sorting = LS_SORT_BY_CHANNELS;
1461                 else if (!strcmp(val, "i") || !strcmp(val, "image-id"))
1462                         opts->sorting = LS_SORT_BY_IMAGE_ID;
1463                 else if (!strcmp(val, "y") || !strcmp(val, "lyrics-id"))
1464                         opts->sorting = LS_SORT_BY_LYRICS_ID;
1465                 else if (!strcmp(val, "b") || !strcmp(val, "bitrate"))
1466                         opts->sorting = LS_SORT_BY_BITRATE;
1467                 else if (!strcmp(val, "d") || !strcmp(val, "duration"))
1468                         opts->sorting = LS_SORT_BY_DURATION;
1469                 else if (!strcmp(val, "a") || !strcmp(val, "audio-format"))
1470                         opts->sorting = LS_SORT_BY_AUDIO_FORMAT;
1471                 else if (!strcmp(val, "h") || !strcmp(val, "hash"))
1472                         opts->sorting = LS_SORT_BY_HASH;
1473                 else {
1474                         ret = -E_AFT_SYNTAX;
1475                         goto out;
1476                 }
1477         }
1478         ret = send_callback_request(com_ls_callback, &query,
1479                 afs_cb_result_handler, cc);
1480 out:
1481         free(query.data);
1482         return ret;
1483 }
1484 EXPORT_SERVER_CMD_HANDLER(ls);
1485
1486 /**
1487  * Call the given function for each file in the audio file table.
1488  *
1489  * \param private_data An arbitrary data pointer, passed to \a func.
1490  * \param func The custom function to be called.
1491  *
1492  * \return Standard.
1493  */
1494 int audio_file_loop(void *private_data, osl_rbtree_loop_func *func)
1495 {
1496         return osl(osl_rbtree_loop(audio_file_table, AFTCOL_HASH, private_data,
1497                 func));
1498 }
1499
1500 static int find_hash_sister(unsigned char *hash, struct osl_row **result)
1501 {
1502         int ret = aft_get_row_of_hash(hash, result);
1503
1504         if (ret == -OSL_ERRNO_TO_PARA_ERROR(E_OSL_RB_KEY_NOT_FOUND))
1505                 return 0;
1506         return ret;
1507 }
1508
1509 static int find_path_brother(const char *path, struct osl_row **result)
1510 {
1511         int ret = aft_get_row_of_path(path, result);
1512
1513         if (ret == -OSL_ERRNO_TO_PARA_ERROR(E_OSL_RB_KEY_NOT_FOUND))
1514                 return 0;
1515         return ret;
1516 }
1517
1518 /** The format of the data stored by save_audio_file_data(). */
1519 enum com_add_buffer_offsets {
1520         /* afhi (if present) starts at this offset. */
1521         CAB_AFHI_OFFSET_POS = 0,
1522         /** Start of the chunk table (if present). */
1523         CAB_CHUNKS_OFFSET_POS = 4,
1524         /** Start of the (serialized) lopsub parse result. */
1525         CAB_LPR_OFFSET = 8,
1526         /** Audio format id. */
1527         CAB_AUDIO_FORMAT_ID_OFFSET = 12,
1528         /** The hash of the audio file being added. */
1529         CAB_HASH_OFFSET = 13,
1530         /** Start of the path of the audio file. */
1531         CAB_PATH_OFFSET = (CAB_HASH_OFFSET + HASH_SIZE),
1532 };
1533
1534 /*
1535  * Store the given data to a single buffer. Doesn't need the audio file selector
1536  * info struct as the server knows it as well.
1537  *
1538  * It's OK to call this with afhi == NULL. In this case, the audio format
1539  * handler info won't be stored in the buffer.
1540  */
1541 static void save_add_callback_buffer(unsigned char *hash, const char *path,
1542                 struct afh_info *afhi, const char *slpr, size_t slpr_size,
1543                 uint8_t audio_format_num, struct osl_object *obj)
1544 {
1545         size_t path_len = strlen(path) + 1;
1546         size_t afhi_size = sizeof_afhi_buf(afhi);
1547         size_t size = CAB_PATH_OFFSET + path_len + afhi_size
1548                 + sizeof_chunk_table(afhi) + slpr_size;
1549         char *buf = para_malloc(size);
1550         uint32_t pos;
1551
1552         assert(size <= ~(uint32_t)0);
1553         write_u8(buf + CAB_AUDIO_FORMAT_ID_OFFSET, audio_format_num);
1554         memcpy(buf + CAB_HASH_OFFSET, hash, HASH_SIZE);
1555         strcpy(buf + CAB_PATH_OFFSET, path);
1556         pos = CAB_PATH_OFFSET + path_len;
1557         write_u32(buf + CAB_AFHI_OFFSET_POS, pos);
1558         save_afhi(afhi, buf + pos);
1559         pos += afhi_size;
1560         write_u32(buf + CAB_CHUNKS_OFFSET_POS, pos);
1561         if (afhi) {
1562                 save_chunk_table(afhi, buf + pos);
1563                 pos += sizeof_chunk_table(afhi);
1564         }
1565         write_u32(buf + CAB_LPR_OFFSET, pos);
1566         memcpy(buf + pos, slpr, slpr_size);
1567         assert(pos + slpr_size == size);
1568         obj->data = buf;
1569         obj->size = size;
1570 }
1571
1572 /*
1573
1574 Overview of the add command.
1575
1576 Input: What was passed to the callback by the command handler.
1577 ~~~~~~
1578 HS:     Hash sister. Whether an audio file with identical hash
1579         already exists in the osl database.
1580
1581 PB:     Path brother. Whether a file with the given path exists
1582         in the table.
1583
1584 F:      Force flag given. Whether add was called with -f.
1585
1586 output: Action performed by the callback.
1587 ~~~~~~~
1588 AFHI:   Whether afhi and chunk table are computed and sent.
1589 ACTION: Table modifications to be done by the callback.
1590
1591 +----+----+---+------+---------------------------------------------------+
1592 | HS | PB | F | AFHI | ACTION
1593 +----+----+---+------+---------------------------------------------------+
1594 | Y  |  Y | Y |  Y   | if HS != PB: remove PB. HS: force afhi update,
1595 |                    | update path, keep afsi
1596 +----+----+---+------+---------------------------------------------------+
1597 | Y  |  Y | N |  N   | if HS == PB: do not send callback request at all.
1598 |                    | otherwise: remove PB, HS: update path, keep afhi,
1599 |                    | afsi.
1600 +----+----+---+------+---------------------------------------------------+
1601 | Y  |  N | Y |  Y   | (rename) force afhi update of HS, update path of
1602 |                    | HS, keep afsi
1603 +----+----+---+------+---------------------------------------------------+
1604 | Y  |  N | N |  N   | (file rename) update path of HS, keep afsi, afhi
1605 +----+----+---+------+---------------------------------------------------+
1606 | N  |  Y | Y |  Y   | (file change) update afhi, hash, of PB, keep afsi
1607 |                    | (force has no effect)
1608 +----+----+---+------+---------------------------------------------------+
1609 | N  |  Y | N |  Y   | (file change) update afhi, hash of PB, keep afsi
1610 +----+----+---+------+---------------------------------------------------+
1611 | N  |  N | Y |  Y   | (new file) create new entry (force has no effect)
1612 +----+----+---+------+---------------------------------------------------+
1613 | N  |  N | N |  Y   | (new file) create new entry
1614 +----+----+---+------+---------------------------------------------------+
1615
1616 Notes:
1617
1618         afhi <=> force or no HS
1619         F => AFHI
1620
1621 */
1622
1623 static int com_add_callback(struct afs_callback_arg *aca)
1624 {
1625         char *buf = aca->query.data, *path;
1626         struct osl_row *pb, *aft_row;
1627         struct osl_row *hs;
1628         struct osl_object objs[NUM_AFT_COLUMNS];
1629         unsigned char *hash;
1630         char asc[2 * HASH_SIZE + 1];
1631         int ret;
1632         char afsi_buf[AFSI_SIZE];
1633         char *slpr = buf + read_u32(buf + CAB_LPR_OFFSET);
1634         struct afs_info default_afsi = {.last_played = 0};
1635         uint16_t afhi_offset, chunks_offset;
1636         const struct lls_command *cmd = SERVER_CMD_CMD_PTR(ADD);
1637         const struct lls_opt_result *r_f, *r_v;
1638
1639         ret = lls_deserialize_parse_result(slpr, cmd, &aca->lpr);
1640         assert(ret >= 0);
1641         r_f = SERVER_CMD_OPT_RESULT(ADD, FORCE, aca->lpr);
1642         r_v = SERVER_CMD_OPT_RESULT(ADD, VERBOSE, aca->lpr);
1643
1644         hash = (unsigned char *)buf + CAB_HASH_OFFSET;
1645         hash_to_asc(hash, asc);
1646         objs[AFTCOL_HASH].data = buf + CAB_HASH_OFFSET;
1647         objs[AFTCOL_HASH].size = HASH_SIZE;
1648
1649         path = buf + CAB_PATH_OFFSET;
1650         objs[AFTCOL_PATH].data = path;
1651         objs[AFTCOL_PATH].size = strlen(path) + 1;
1652
1653         PARA_INFO_LOG("request to add %s\n", path);
1654         ret = find_hash_sister(hash, &hs);
1655         if (ret < 0)
1656                 goto out;
1657         ret = find_path_brother(path, &pb);
1658         if (ret < 0)
1659                 goto out;
1660         if (hs && pb && hs == pb && !lls_opt_given(r_f)) {
1661                 if (lls_opt_given(r_v))
1662                         para_printf(&aca->pbout, "ignoring duplicate\n");
1663                 ret = 1;
1664                 goto out;
1665         }
1666         if (hs && hs != pb) {
1667                 struct osl_object obj;
1668                 if (pb) { /* hs trumps pb, remove pb */
1669                         if (lls_opt_given(r_v))
1670                                 para_printf(&aca->pbout, "removing %s\n", path);
1671                         ret = afs_event(AUDIO_FILE_REMOVE, &aca->pbout, pb);
1672                         if (ret < 0)
1673                                 goto out;
1674                         ret = osl(osl_del_row(audio_file_table, pb));
1675                         if (ret < 0)
1676                                 goto out;
1677                         pb = NULL;
1678                 }
1679                 /* file rename, update hs' path */
1680                 if (lls_opt_given(r_v)) {
1681                         ret = osl(osl_get_object(audio_file_table, hs,
1682                                 AFTCOL_PATH, &obj));
1683                         if (ret < 0)
1684                                 goto out;
1685                         para_printf(&aca->pbout, "renamed from %s\n",
1686                                 (char *)obj.data);
1687                 }
1688                 ret = osl(osl_update_object(audio_file_table, hs, AFTCOL_PATH,
1689                         &objs[AFTCOL_PATH]));
1690                 if (ret < 0)
1691                         goto out;
1692                 ret = afs_event(AUDIO_FILE_RENAME, &aca->pbout, hs);
1693                 if (ret < 0)
1694                         goto out;
1695                 if (!lls_opt_given(r_f))
1696                         goto out;
1697         }
1698         /* no hs or force mode, child must have sent afhi */
1699         afhi_offset = read_u32(buf + CAB_AFHI_OFFSET_POS);
1700         chunks_offset = read_u32(buf + CAB_CHUNKS_OFFSET_POS);
1701
1702         objs[AFTCOL_AFHI].data = buf + afhi_offset;
1703         objs[AFTCOL_AFHI].size = chunks_offset - afhi_offset;
1704         ret = -E_NO_AFHI;
1705         if (!objs[AFTCOL_AFHI].size) /* "impossible" */
1706                 goto out;
1707         objs[AFTCOL_CHUNKS].data = buf + chunks_offset;
1708         objs[AFTCOL_CHUNKS].size = aca->query.size - chunks_offset;
1709         if (pb && !hs) { /* update pb's hash */
1710                 char old_asc[2 * HASH_SIZE + 1];
1711                 unsigned char *old_hash;
1712                 ret = get_hash_of_row(pb, &old_hash);
1713                 if (ret < 0)
1714                         goto out;
1715                 hash_to_asc(old_hash, old_asc);
1716                 if (lls_opt_given(r_v))
1717                         para_printf(&aca->pbout, "file change: %s -> %s\n",
1718                                 old_asc, asc);
1719                 ret = osl(osl_update_object(audio_file_table, pb, AFTCOL_HASH,
1720                         &objs[AFTCOL_HASH]));
1721                 if (ret < 0)
1722                         goto out;
1723         }
1724         if (hs || pb) { /* (hs != NULL and pb != NULL) implies hs == pb */
1725                 struct osl_row *row = pb? pb : hs;
1726                 /* update afhi and chunk_table */
1727                 if (lls_opt_given(r_v))
1728                         para_printf(&aca->pbout,
1729                                 "updating afhi and chunk table\n");
1730                 ret = osl(osl_update_object(audio_file_table, row, AFTCOL_AFHI,
1731                         &objs[AFTCOL_AFHI]));
1732                 if (ret < 0)
1733                         goto out;
1734                 /* truncate the file to size zero if there is no chunk table */
1735                 ret = osl(osl_update_object(audio_file_table, row, AFTCOL_CHUNKS,
1736                         &objs[AFTCOL_CHUNKS]));
1737                 if (ret < 0)
1738                         goto out;
1739                 ret = afs_event(AFHI_CHANGE, &aca->pbout, row);
1740                 goto out;
1741         }
1742         /* new entry, use default afsi */
1743         if (lls_opt_given(r_v))
1744                 para_printf(&aca->pbout, "new file\n");
1745         default_afsi.last_played = time(NULL) - 365 * 24 * 60 * 60;
1746         default_afsi.audio_format_id = read_u8(buf + CAB_AUDIO_FORMAT_ID_OFFSET);
1747
1748         objs[AFTCOL_AFSI].data = &afsi_buf;
1749         objs[AFTCOL_AFSI].size = AFSI_SIZE;
1750         save_afsi(&default_afsi, &objs[AFTCOL_AFSI]);
1751         ret = osl(osl_add_and_get_row(audio_file_table, objs, &aft_row));
1752         if (ret < 0)
1753                 goto out;
1754         ret = afs_event(AUDIO_FILE_ADD, &aca->pbout, aft_row);
1755 out:
1756         if (ret < 0)
1757                 para_printf(&aca->pbout, "could not add %s\n", path);
1758         lls_free_parse_result(aca->lpr, cmd);
1759         return ret;
1760 }
1761
1762 /* Used by com_add(). */
1763 struct private_add_data {
1764         /* The pointer passed to the original command handler. */
1765         struct command_context *cc;
1766         /* Contains the flags given at the command line. */
1767         struct lls_parse_result *lpr;
1768         /* Serialized lopsub parse result. */
1769         char *slpr;
1770         /* Number of bytes. */
1771         size_t slpr_size;
1772 };
1773
1774 static int path_brother_callback(struct afs_callback_arg *aca)
1775 {
1776         char *path = aca->query.data;
1777         struct osl_row *path_brother;
1778         int ret = find_path_brother(path, &path_brother);
1779         if (ret <= 0)
1780                 return ret;
1781         return pass_buffer_as_shm(aca->fd, SBD_OUTPUT, (char *)&path_brother,
1782                 sizeof(path_brother));
1783 }
1784
1785 static int hash_sister_callback(struct afs_callback_arg *aca)
1786 {
1787         unsigned char *hash = aca->query.data;
1788         struct osl_row *hash_sister;
1789         int ret = find_hash_sister(hash, &hash_sister);
1790
1791         if (ret <= 0)
1792                 return ret;
1793         return pass_buffer_as_shm(aca->fd, SBD_OUTPUT, (char *)&hash_sister,
1794                 sizeof(hash_sister));
1795 }
1796
1797 static int get_row_pointer_from_result(struct osl_object *result,
1798                 __a_unused uint8_t band, void *private)
1799 {
1800         struct osl_row **row = private;
1801
1802         if (band == SBD_OUTPUT)
1803                 *row = *(struct osl_row **)(result->data);
1804         return 1;
1805 }
1806
1807 static int add_one_audio_file(const char *path, void *private_data)
1808 {
1809         int ret, send_ret = 1, fd;
1810         uint8_t format_num = -1;
1811         struct private_add_data *pad = private_data;
1812         struct afh_info afhi, *afhi_ptr = NULL;
1813         struct osl_row *pb = NULL, *hs = NULL; /* path brother/hash sister */
1814         struct osl_object map, obj = {.data = NULL}, query;
1815         unsigned char hash[HASH_SIZE];
1816         bool a_given = SERVER_CMD_OPT_GIVEN(ADD, ALL, pad->lpr);
1817         bool f_given = SERVER_CMD_OPT_GIVEN(ADD, FORCE, pad->lpr);
1818         bool l_given = SERVER_CMD_OPT_GIVEN(ADD, LAZY, pad->lpr);
1819         bool v_given = SERVER_CMD_OPT_GIVEN(ADD, VERBOSE, pad->lpr);
1820
1821         ret = guess_audio_format(path);
1822         if (ret < 0 && !a_given) {
1823                 ret = 0;
1824                 goto out_free;
1825         }
1826         query.data = (char *)path;
1827         query.size = strlen(path) + 1;
1828         ret = send_callback_request(path_brother_callback, &query,
1829                 get_row_pointer_from_result, &pb);
1830         if (ret < 0 && ret != -OSL_ERRNO_TO_PARA_ERROR(E_OSL_RB_KEY_NOT_FOUND))
1831                 goto out_free;
1832         ret = 1;
1833         if (pb && l_given) { /* lazy is really cheap */
1834                 if (v_given)
1835                         send_ret = send_sb_va(&pad->cc->scc, SBD_OUTPUT,
1836                                 "lazy-ignore: %s\n", path);
1837                 goto out_free;
1838         }
1839         /* We still want to add this file. Compute its hash. */
1840         ret = mmap_full_file(path, O_RDONLY, &map.data, &map.size, &fd);
1841         if (ret < 0)
1842                 goto out_free;
1843         hash_function(map.data, map.size, hash);
1844
1845         /* Check whether the database contains a file with the same hash. */
1846         query.data = hash;
1847         query.size = HASH_SIZE;
1848         ret = send_callback_request(hash_sister_callback, &query,
1849                 get_row_pointer_from_result, &hs);
1850         if (ret < 0)
1851                 goto out_unmap;
1852         /* Return success if we already know this file. */
1853         ret = 1;
1854         if (pb && hs && hs == pb && !f_given) {
1855                 if (v_given)
1856                         send_ret = send_sb_va(&pad->cc->scc, SBD_OUTPUT,
1857                                 "%s exists, not forcing update\n", path);
1858                 goto out_unmap;
1859         }
1860         /*
1861          * We won't recalculate the audio format info and the chunk table if
1862          * there is a hash sister and FORCE was not given.
1863          */
1864         if (!hs || f_given) {
1865                 ret = compute_afhi(path, map.data, map.size, fd, &afhi);
1866                 if (ret < 0)
1867                         goto out_unmap;
1868                 format_num = ret;
1869                 afhi_ptr = &afhi;
1870         }
1871         munmap(map.data, map.size);
1872         close(fd);
1873         if (v_given) {
1874                 send_ret = send_sb_va(&pad->cc->scc, SBD_OUTPUT,
1875                         "adding %s\n", path);
1876                 if (send_ret < 0)
1877                         goto out_free;
1878         }
1879         save_add_callback_buffer(hash, path, afhi_ptr, pad->slpr,
1880                 pad->slpr_size, format_num, &obj);
1881         /* Ask afs to consider this entry for adding. */
1882         ret = send_callback_request(com_add_callback, &obj,
1883                 afs_cb_result_handler, pad->cc);
1884         goto out_free;
1885
1886 out_unmap:
1887         close(fd);
1888         munmap(map.data, map.size);
1889 out_free:
1890         if (ret < 0 && send_ret >= 0)
1891                 send_ret = send_sb_va(&pad->cc->scc, SBD_ERROR_LOG,
1892                         "failed to add %s (%s)\n", path, para_strerror(-ret));
1893         free(obj.data);
1894         clear_afhi(afhi_ptr);
1895         /* Stop adding files only on send errors. */
1896         return send_ret;
1897 }
1898
1899 static int com_add(struct command_context *cc, struct lls_parse_result *lpr)
1900 {
1901         int i, ret;
1902         struct private_add_data pad = {.cc = cc, .lpr = lpr};
1903         const struct lls_command *cmd = SERVER_CMD_CMD_PTR(ADD);
1904         unsigned num_inputs;
1905         char *errctx;
1906
1907         ret = lls(lls_check_arg_count(lpr, 1, INT_MAX, &errctx));
1908         if (ret < 0) {
1909                 send_errctx(cc, errctx);
1910                 return ret;
1911         }
1912         ret = lls_serialize_parse_result(lpr, cmd, &pad.slpr, &pad.slpr_size);
1913         assert(ret >= 0);
1914         num_inputs = lls_num_inputs(lpr);
1915         for (i = 0; i < num_inputs; i++) {
1916                 char *path;
1917                 ret = verify_path(lls_input(i, lpr), &path);
1918                 if (ret < 0) {
1919                         ret = send_sb_va(&cc->scc, SBD_ERROR_LOG, "%s: %s\n",
1920                                 lls_input(i, lpr), para_strerror(-ret));
1921                         if (ret < 0)
1922                                 goto out;
1923                         continue;
1924                 }
1925                 if (ret == 1) /* directory */
1926                         ret = for_each_file_in_dir(path, add_one_audio_file,
1927                                 &pad);
1928                 else /* regular file */
1929                         ret = add_one_audio_file(path, &pad);
1930                 if (ret < 0) {
1931                         send_sb_va(&cc->scc, SBD_OUTPUT, "%s: %s\n", path,
1932                                 para_strerror(-ret));
1933                         free(path);
1934                         return ret;
1935                 }
1936                 free(path);
1937         }
1938         ret = 1;
1939 out:
1940         free(pad.slpr);
1941         return ret;
1942 }
1943 EXPORT_SERVER_CMD_HANDLER(add);
1944
1945 /** Flags used by the touch command. */
1946 enum touch_flags {
1947         /** Whether the \p FNM_PATHNAME flag should be passed to fnmatch(). */
1948         TOUCH_FLAG_FNM_PATHNAME = 1,
1949         /** Activates verbose mode. */
1950         TOUCH_FLAG_VERBOSE = 2
1951 };
1952
1953 static int touch_audio_file(__a_unused struct osl_table *table,
1954                 struct osl_row *row, const char *name, void *data)
1955 {
1956         struct afs_callback_arg *aca = data;
1957         bool v_given = SERVER_CMD_OPT_GIVEN(TOUCH, VERBOSE, aca->lpr);
1958         const struct lls_opt_result *r_n, *r_l, *r_i, *r_y, *r_a;
1959         int ret;
1960         struct osl_object obj;
1961         struct afs_info old_afsi, new_afsi;
1962         bool no_options;
1963         struct afsi_change_event_data aced;
1964
1965         r_n = SERVER_CMD_OPT_RESULT(TOUCH, NUMPLAYED, aca->lpr);
1966         r_l = SERVER_CMD_OPT_RESULT(TOUCH, LASTPLAYED, aca->lpr);
1967         r_i = SERVER_CMD_OPT_RESULT(TOUCH, IMAGE_ID, aca->lpr);
1968         r_y = SERVER_CMD_OPT_RESULT(TOUCH, LYRICS_ID, aca->lpr);
1969         r_a = SERVER_CMD_OPT_RESULT(TOUCH, AMP, aca->lpr);
1970         no_options = !lls_opt_given(r_n) && !lls_opt_given(r_l) && !lls_opt_given(r_i)
1971                 && !lls_opt_given(r_y) && !lls_opt_given(r_a);
1972
1973         ret = get_afsi_object_of_row(row, &obj);
1974         if (ret < 0) {
1975                 para_printf(&aca->pbout, "cannot touch %s\n", name);
1976                 return ret;
1977         }
1978         ret = load_afsi(&old_afsi, &obj);
1979         if (ret < 0) {
1980                 para_printf(&aca->pbout, "cannot touch %s\n", name);
1981                 return ret;
1982         }
1983         new_afsi = old_afsi;
1984         if (no_options) {
1985                 new_afsi.num_played++;
1986                 new_afsi.last_played = time(NULL);
1987                 if (v_given)
1988                         para_printf(&aca->pbout, "%s: num_played = %u, "
1989                                 "last_played = now()\n", name,
1990                                 new_afsi.num_played);
1991         } else {
1992                 if (lls_opt_given(r_l))
1993                         new_afsi.last_played = lls_uint64_val(0, r_l);
1994                 if (lls_opt_given(r_n))
1995                         new_afsi.num_played = lls_uint32_val(0, r_n);
1996                 if (lls_opt_given(r_i))
1997                         new_afsi.image_id = lls_uint32_val(0, r_i);
1998                 if (lls_opt_given(r_y))
1999                         new_afsi.lyrics_id = lls_uint32_val(0, r_y);
2000                 if (lls_opt_given(r_a))
2001                         new_afsi.amp = lls_uint32_val(0, r_a);
2002                 if (v_given)
2003                         para_printf(&aca->pbout, "touching %s\n", name);
2004         }
2005         save_afsi(&new_afsi, &obj); /* in-place update */
2006         aced.aft_row = row;
2007         aced.old_afsi = &old_afsi;
2008         return afs_event(AFSI_CHANGE, &aca->pbout, &aced);
2009 }
2010
2011 static int com_touch_callback(struct afs_callback_arg *aca)
2012 {
2013         const struct lls_command *cmd = SERVER_CMD_CMD_PTR(TOUCH);
2014         bool p_given;
2015         const struct lls_opt_result *r_i, *r_y;
2016         int ret;
2017         struct pattern_match_data pmd = {
2018                 .table = audio_file_table,
2019                 .loop_col_num = AFTCOL_HASH,
2020                 .match_col_num = AFTCOL_PATH,
2021                 .data = aca,
2022                 .action = touch_audio_file
2023         };
2024
2025         ret = lls_deserialize_parse_result(aca->query.data, cmd, &aca->lpr);
2026         assert(ret >= 0);
2027         pmd.lpr = aca->lpr;
2028
2029         r_i = SERVER_CMD_OPT_RESULT(TOUCH, IMAGE_ID, aca->lpr);
2030         if (lls_opt_given(r_i)) {
2031                 uint32_t id = lls_uint32_val(0, r_i);
2032                 ret = img_get_name_by_id(id, NULL);
2033                 if (ret < 0) {
2034                         para_printf(&aca->pbout, "invalid image ID: %u\n", id);
2035                         return ret;
2036                 }
2037         }
2038         r_y = SERVER_CMD_OPT_RESULT(TOUCH, LYRICS_ID, aca->lpr);
2039         if (lls_opt_given(r_y)) {
2040                 uint32_t id = lls_uint32_val(0, r_y);
2041                 ret = lyr_get_name_by_id(id, NULL);
2042                 if (ret < 0) {
2043                         para_printf(&aca->pbout, "invalid lyrics ID: %u\n", id);
2044                         return ret;
2045                 }
2046         }
2047         p_given = SERVER_CMD_OPT_GIVEN(TOUCH, PATHNAME_MATCH, aca->lpr);
2048         if (p_given)
2049                 pmd.fnmatch_flags |= FNM_PATHNAME;
2050         ret = for_each_matching_row(&pmd);
2051         if (ret >= 0 && pmd.num_matches == 0)
2052                 ret = -E_NO_MATCH;
2053         lls_free_parse_result(aca->lpr, cmd);
2054         return ret;
2055 }
2056
2057 static int com_touch(struct command_context *cc, struct lls_parse_result *lpr)
2058 {
2059         const struct lls_command *cmd = SERVER_CMD_CMD_PTR(TOUCH);
2060         int ret;
2061         char *errctx;
2062
2063         ret = lls(lls_check_arg_count(lpr, 1, INT_MAX, &errctx));
2064         if (ret < 0) {
2065                 send_errctx(cc, errctx);
2066                 return ret;
2067         }
2068         return send_lls_callback_request(com_touch_callback, cmd, lpr, cc);
2069 }
2070 EXPORT_SERVER_CMD_HANDLER(touch);
2071
2072 static int remove_audio_file(__a_unused struct osl_table *table,
2073                 struct osl_row *row, const char *name, void *data)
2074 {
2075         struct afs_callback_arg *aca = data;
2076         bool v_given = SERVER_CMD_OPT_GIVEN(RM, VERBOSE, aca->lpr);
2077         int ret;
2078
2079         if (v_given)
2080                 para_printf(&aca->pbout, "removing %s\n", name);
2081         ret = afs_event(AUDIO_FILE_REMOVE, &aca->pbout, row);
2082         if (ret < 0)
2083                 return ret;
2084         ret = osl(osl_del_row(audio_file_table, row));
2085         if (ret < 0)
2086                 para_printf(&aca->pbout, "cannot remove %s\n", name);
2087         return ret;
2088 }
2089
2090 static int com_rm_callback(struct afs_callback_arg *aca)
2091 {
2092         const struct lls_command *cmd = SERVER_CMD_CMD_PTR(RM);
2093         int ret;
2094         struct pattern_match_data pmd = {
2095                 .table = audio_file_table,
2096                 .loop_col_num = AFTCOL_HASH,
2097                 .match_col_num = AFTCOL_PATH,
2098                 .data = aca,
2099                 .action = remove_audio_file
2100         };
2101         bool v_given, p_given, f_given;
2102
2103         ret = lls_deserialize_parse_result(aca->query.data, cmd, &aca->lpr);
2104         assert(ret >= 0);
2105         pmd.lpr = aca->lpr;
2106         v_given = SERVER_CMD_OPT_GIVEN(RM, VERBOSE, aca->lpr);
2107         p_given = SERVER_CMD_OPT_GIVEN(RM, PATHNAME_MATCH, aca->lpr);
2108         f_given = SERVER_CMD_OPT_GIVEN(RM, FORCE, aca->lpr);
2109
2110         if (p_given)
2111                 pmd.fnmatch_flags |= FNM_PATHNAME;
2112         ret = for_each_matching_row(&pmd);
2113         if (ret < 0)
2114                 goto out;
2115         if (pmd.num_matches == 0) {
2116                 if (!f_given)
2117                         ret = -E_NO_MATCH;
2118         } else if (v_given)
2119                 para_printf(&aca->pbout, "removed %u file(s)\n",
2120                         pmd.num_matches);
2121 out:
2122         lls_free_parse_result(aca->lpr, cmd);
2123         return ret;
2124 }
2125
2126 /* TODO options: -r (recursive) */
2127 static int com_rm(struct command_context *cc, struct lls_parse_result *lpr)
2128 {
2129         const struct lls_command *cmd = SERVER_CMD_CMD_PTR(RM);
2130         char *errctx;
2131         int ret;
2132
2133         ret = lls(lls_check_arg_count(lpr, 1, INT_MAX, &errctx));
2134         if (ret < 0) {
2135                 send_errctx(cc, errctx);
2136                 return ret;
2137         }
2138         return send_lls_callback_request(com_rm_callback, cmd, lpr, cc);
2139 }
2140 EXPORT_SERVER_CMD_HANDLER(rm);
2141
2142 /** Data passed to the action handler of com_cpsi(). */
2143 struct cpsi_action_data {
2144         /** Values are copied from here. */
2145         struct afs_info source_afsi;
2146         /** What was passed to com_cpsi_callback(). */
2147         struct afs_callback_arg *aca;
2148         bool copy_all;
2149 };
2150
2151 static int copy_selector_info(__a_unused struct osl_table *table,
2152                 struct osl_row *row, const char *name, void *data)
2153 {
2154         struct cpsi_action_data *cad = data;
2155         struct osl_object target_afsi_obj;
2156         int ret;
2157         struct afs_info old_afsi, target_afsi;
2158         struct afsi_change_event_data aced;
2159         bool a_given, y_given, i_given, l_given, n_given, v_given;
2160
2161         a_given = SERVER_CMD_OPT_GIVEN(CPSI, ATTRIBUTE_BITMAP, cad->aca->lpr);
2162         y_given = SERVER_CMD_OPT_GIVEN(CPSI, LYRICS_ID, cad->aca->lpr);
2163         i_given = SERVER_CMD_OPT_GIVEN(CPSI, IMAGE_ID, cad->aca->lpr);
2164         l_given = SERVER_CMD_OPT_GIVEN(CPSI, LASTPLAYED, cad->aca->lpr);
2165         n_given = SERVER_CMD_OPT_GIVEN(CPSI, NUMPLAYED, cad->aca->lpr);
2166         v_given = SERVER_CMD_OPT_GIVEN(CPSI, VERBOSE, cad->aca->lpr);
2167
2168         ret = get_afsi_object_of_row(row, &target_afsi_obj);
2169         if (ret < 0)
2170                 return ret;
2171         ret = load_afsi(&target_afsi, &target_afsi_obj);
2172         if (ret < 0)
2173                 return ret;
2174         old_afsi = target_afsi;
2175         if (cad->copy_all || y_given)
2176                 target_afsi.lyrics_id = cad->source_afsi.lyrics_id;
2177         if (cad->copy_all || i_given)
2178                 target_afsi.image_id = cad->source_afsi.image_id;
2179         if (cad->copy_all || l_given)
2180                 target_afsi.last_played = cad->source_afsi.last_played;
2181         if (cad->copy_all || n_given)
2182                 target_afsi.num_played = cad->source_afsi.num_played;
2183         if (cad->copy_all || a_given)
2184                 target_afsi.attributes = cad->source_afsi.attributes;
2185         save_afsi(&target_afsi, &target_afsi_obj); /* in-place update */
2186         if (v_given)
2187                 para_printf(&cad->aca->pbout, "copied afsi to %s\n", name);
2188         aced.aft_row = row;
2189         aced.old_afsi = &old_afsi;
2190         return afs_event(AFSI_CHANGE, &cad->aca->pbout, &aced);
2191 }
2192
2193 static int com_cpsi_callback(struct afs_callback_arg *aca)
2194 {
2195         const struct lls_command *cmd = SERVER_CMD_CMD_PTR(CPSI);
2196         bool a_given, y_given, i_given, l_given, n_given, v_given;
2197         struct cpsi_action_data cad = {.aca = aca};
2198         int ret;
2199         struct pattern_match_data pmd = {
2200                 .table = audio_file_table,
2201                 .loop_col_num = AFTCOL_HASH,
2202                 .match_col_num = AFTCOL_PATH,
2203                 .input_skip = 1, /* skip first argument (source file) */
2204                 .data = &cad,
2205                 .action = copy_selector_info
2206         };
2207
2208         ret = lls_deserialize_parse_result(aca->query.data, cmd, &aca->lpr);
2209         assert(ret >= 0);
2210         pmd.lpr = aca->lpr;
2211
2212         a_given = SERVER_CMD_OPT_GIVEN(CPSI, ATTRIBUTE_BITMAP, aca->lpr);
2213         y_given = SERVER_CMD_OPT_GIVEN(CPSI, LYRICS_ID, aca->lpr);
2214         i_given = SERVER_CMD_OPT_GIVEN(CPSI, IMAGE_ID, aca->lpr);
2215         l_given = SERVER_CMD_OPT_GIVEN(CPSI, LASTPLAYED, aca->lpr);
2216         n_given = SERVER_CMD_OPT_GIVEN(CPSI, NUMPLAYED, aca->lpr);
2217         v_given = SERVER_CMD_OPT_GIVEN(CPSI, VERBOSE, aca->lpr);
2218         cad.copy_all = !a_given && !y_given && !i_given && !l_given && !n_given;
2219
2220         ret = get_afsi_of_path(lls_input(0, aca->lpr), &cad.source_afsi);
2221         if (ret < 0)
2222                 goto out;
2223         ret = for_each_matching_row(&pmd);
2224         if (ret < 0)
2225                 goto out;
2226         if (pmd.num_matches > 0) {
2227                 if (v_given)
2228                         para_printf(&aca->pbout, "updated afsi of %u file(s)\n",
2229                                 pmd.num_matches);
2230         } else
2231                 ret = -E_NO_MATCH;
2232 out:
2233         lls_free_parse_result(aca->lpr, cmd);
2234         return ret;
2235 }
2236
2237 static int com_cpsi(struct command_context *cc, struct lls_parse_result *lpr)
2238 {
2239         const struct lls_command *cmd = SERVER_CMD_CMD_PTR(CPSI);
2240         char *errctx;
2241         int ret = lls(lls_check_arg_count(lpr, 2, INT_MAX, &errctx));
2242         if (ret < 0) {
2243                 send_errctx(cc, errctx);
2244                 return ret;
2245         }
2246         return send_lls_callback_request(com_cpsi_callback, cmd, lpr, cc);
2247 }
2248 EXPORT_SERVER_CMD_HANDLER(cpsi);
2249
2250 struct change_atts_data {
2251         uint64_t add_mask, del_mask;
2252         struct afs_callback_arg *aca;
2253 };
2254
2255 static int change_atts(__a_unused struct osl_table *table,
2256                 struct osl_row *row, __a_unused const char *name, void *data)
2257 {
2258         int ret;
2259         struct osl_object obj;
2260         struct afs_info old_afsi, new_afsi;
2261         struct afsi_change_event_data aced = {
2262                 .aft_row = row,
2263                 .old_afsi = &old_afsi
2264         };
2265         struct change_atts_data *cad = data;
2266
2267         ret = get_afsi_object_of_row(row, &obj);
2268         if (ret < 0)
2269                 return ret;
2270         ret = load_afsi(&old_afsi, &obj);
2271         if (ret < 0)
2272                 return ret;
2273         new_afsi = old_afsi;
2274         new_afsi.attributes |= cad->add_mask;
2275         new_afsi.attributes &= ~cad->del_mask;
2276         save_afsi(&new_afsi, &obj); /* in-place update */
2277         return afs_event(AFSI_CHANGE, &cad->aca->pbout, &aced);
2278 }
2279
2280 static int com_setatt_callback(struct afs_callback_arg *aca)
2281 {
2282         const struct lls_command *cmd = SERVER_CMD_CMD_PTR(SETATT);
2283         int i, ret;
2284         struct change_atts_data cad = {.aca = aca};
2285         struct pattern_match_data pmd = {
2286                 .table = audio_file_table,
2287                 .loop_col_num = AFTCOL_HASH,
2288                 .match_col_num = AFTCOL_PATH,
2289                 .pm_flags = PM_SKIP_EMPTY_NAME,
2290                 .data = &cad,
2291                 .action = change_atts
2292         };
2293         unsigned num_inputs;
2294
2295         ret = lls_deserialize_parse_result(aca->query.data, cmd, &aca->lpr);
2296         assert(ret >= 0);
2297         pmd.lpr = aca->lpr;
2298
2299         num_inputs = lls_num_inputs(aca->lpr);
2300         for (i = 0; i < num_inputs; i++) {
2301                 unsigned char bitnum;
2302                 uint64_t one = 1;
2303                 const char *arg = lls_input(i, aca->lpr);
2304                 char c, *p;
2305                 size_t len = strlen(arg);
2306
2307                 ret = -E_ATTR_SYNTAX;
2308                 if (len == 0)
2309                         goto out;
2310                 c = arg[len - 1];
2311                 if (c != '+' && c != '-') {
2312                         if (cad.add_mask == 0 && cad.del_mask == 0)
2313                                 goto out; /* no attribute modifier given */
2314                         goto set_atts;
2315                 }
2316                 p = para_malloc(len);
2317                 memcpy(p, arg, len - 1);
2318                 p[len - 1] = '\0';
2319                 ret = get_attribute_bitnum_by_name(p, &bitnum);
2320                 free(p);
2321                 if (ret < 0) {
2322                         para_printf(&aca->pbout, "invalid argument: %s\n", arg);
2323                         goto out;
2324                 }
2325                 if (c == '+')
2326                         cad.add_mask |= (one << bitnum);
2327                 else
2328                         cad.del_mask |= (one << bitnum);
2329         }
2330         /* no pattern given */
2331         ret = -E_ATTR_SYNTAX;
2332         goto out;
2333 set_atts:
2334         pmd.input_skip = i;
2335         ret = for_each_matching_row(&pmd);
2336         if (ret >= 0 && pmd.num_matches == 0)
2337                 ret = -E_NO_MATCH;
2338 out:
2339         lls_free_parse_result(aca->lpr, cmd);
2340         return ret;
2341 }
2342
2343 static int com_setatt(struct command_context *cc, struct lls_parse_result *lpr)
2344 {
2345         const struct lls_command *cmd = SERVER_CMD_CMD_PTR(SETATT);
2346         char *errctx;
2347         int ret = lls(lls_check_arg_count(lpr, 2, INT_MAX, &errctx));
2348
2349         if (ret < 0) {
2350                 send_errctx(cc, errctx);
2351                 return ret;
2352         }
2353         return send_lls_callback_request(com_setatt_callback, cmd, lpr, cc);
2354 }
2355 EXPORT_SERVER_CMD_HANDLER(setatt);
2356
2357 static int afs_stat_callback(struct afs_callback_arg *aca)
2358 {
2359         int *parser_friendly = aca->query.data;
2360         char *buf = *parser_friendly?
2361                 parser_friendly_status_items : status_items;
2362
2363         if (!buf)
2364                 return 0;
2365         return pass_buffer_as_shm(aca->fd, SBD_OUTPUT, buf, strlen(buf));
2366 }
2367
2368 /**
2369  * Get the current afs status items from the afs process and send it.
2370  *
2371  * \param cc The command context, used e.g. for data encryption.
2372  * \param parser_friendly Whether parser-friendly output format should be used.
2373  *
2374  * As the contents of the afs status items change in time and the command
2375  * handler only has a COW version created at fork time, it can not send
2376  * up-to-date afs status items directly. Therefore the usual callback mechanism
2377  * is used to pass the status items from the afs process to the command handler
2378  * via a shared memory area and a pipe.
2379  *
2380  * \return The return value of the underlying call to \ref send_callback_request().
2381  */
2382 int send_afs_status(struct command_context *cc, int parser_friendly)
2383 {
2384         struct osl_object query = {.data = &parser_friendly,
2385                 .size = sizeof(parser_friendly)};
2386
2387         return send_callback_request(afs_stat_callback, &query,
2388                 afs_cb_result_handler, cc);
2389 }
2390
2391 /* returns success on non-fatal errors to keep the loop going */
2392 static int check_audio_file(struct osl_row *row, void *data)
2393 {
2394         char *path;
2395         struct para_buffer *pb = data;
2396         struct stat statbuf;
2397         int ret = get_audio_file_path_of_row(row, &path);
2398         struct afs_info afsi;
2399         char *blob_name;
2400
2401         if (ret < 0) {
2402                 para_printf(pb, "%s\n", para_strerror(-ret));
2403                 return ret;
2404         }
2405         if (stat(path, &statbuf) < 0)
2406                 para_printf(pb, "%s: stat error (%s)\n", path, strerror(errno));
2407         else if (!S_ISREG(statbuf.st_mode))
2408                 para_printf(pb, "%s: not a regular file\n", path);
2409         ret = get_afsi_of_row(row, &afsi);
2410         if (ret < 0) {
2411                 para_printf(pb, "%s: %s\n", path, para_strerror(-ret));
2412                 return 1;
2413         }
2414         ret = lyr_get_name_by_id(afsi.lyrics_id, &blob_name);
2415         if (ret < 0)
2416                 para_printf(pb, "%s lyrics id %u: %s\n", path, afsi.lyrics_id,
2417                         para_strerror(-ret));
2418         ret = img_get_name_by_id(afsi.image_id, &blob_name);
2419         if (ret < 0)
2420                 para_printf(pb, "%s image id %u: %s\n", path, afsi.image_id,
2421                         para_strerror(-ret));
2422         return 0;
2423 }
2424
2425 /**
2426  * Check the audio file table for inconsistencies.
2427  *
2428  * \param aca Only ->pbout is used for diagnostics.
2429  *
2430  * \return Standard. Inconsistencies are reported but not regarded as an error.
2431  */
2432 int aft_check_callback(struct afs_callback_arg *aca)
2433 {
2434         para_printf(&aca->pbout, "checking audio file table...\n");
2435         return audio_file_loop(&aca->pbout, check_audio_file);
2436 }
2437
2438 struct aft_check_atts_data {
2439         uint64_t att_mask;
2440         struct para_buffer *pb;
2441 };
2442
2443 static int check_atts_of_audio_file(struct osl_row *row, void *data)
2444 {
2445         struct aft_check_atts_data *acad = data;
2446         int ret;
2447         struct afs_info afsi;
2448         char *path;
2449         uint64_t bad_bits;
2450
2451         ret = get_afsi_of_row(row, &afsi);
2452         if (ret < 0) {
2453                 para_printf(acad->pb, "cannot get afsi\n");
2454                 return ret;
2455         }
2456         bad_bits = afsi.attributes & ~acad->att_mask;
2457         if (bad_bits == 0) /* OK */
2458                 return 0;
2459         ret = get_audio_file_path_of_row(row, &path);
2460         if (ret < 0) {
2461                 para_printf(acad->pb, "cannot get path\n");
2462                 return ret;
2463         }
2464         para_printf(acad->pb, "invalid attribute bits (%" PRIu64 "): %s\n",
2465                 bad_bits, path);
2466         /* return success to keep looping */
2467         return 1;
2468 }
2469
2470 /**
2471  * Iterate over all audio files and check the attribute bit mask.
2472  *
2473  * \param att_mask The mask of all valid attributes.
2474  * \param pb Used for reporting inconsistencies.
2475  *
2476  * This reads the attribute bit mask of each audio file from the afs info
2477  * structure stored in the audio file table and verifies that all set bits are
2478  * also turned on in \a att_mask, i.e., correspond to an attribute of the
2479  * attribute table. Audio files for which this is not the case are reported via
2480  * \a pb.
2481  *
2482  * \return Standard. Inconsistencies are not regarded as errors.
2483  *
2484  * \sa \ref attribute_check_callback().
2485  */
2486 int aft_check_attributes(uint64_t att_mask, struct para_buffer *pb)
2487 {
2488         struct aft_check_atts_data acad = {.att_mask = att_mask, .pb = pb};
2489
2490         para_printf(pb, "checking attributes, mask: %" PRIx64 "\n", att_mask);
2491         return audio_file_loop(&acad, check_atts_of_audio_file);
2492 }
2493
2494 /*
2495  * This sets audio_file_table to NULL, but leaves current_aft_row unmodified,
2496  * though stale (pointing to unmapped memory). If the table is being closed
2497  * because we received SIGHUP, the table will be reopened after the config file
2498  * has been reloaded. We remember the hash of the current audio file here so
2499  * that aft_open() can initialize current_aft_row by looking up the saved hash.
2500  */
2501 static void aft_close(void)
2502 {
2503         int ret;
2504         unsigned char *p;
2505
2506         if (current_aft_row) {
2507                 ret = get_hash_of_row(current_aft_row, &p);
2508                 if (ret < 0) {
2509                         PARA_WARNING_LOG("hash lookup failure\n");
2510                         current_aft_row = NULL;
2511                 } else
2512                         memcpy(current_hash, p, HASH_SIZE);
2513         }
2514         osl_close_table(audio_file_table, OSL_MARK_CLEAN);
2515         audio_file_table = NULL;
2516 }
2517
2518 static int aft_open(const char *dir)
2519 {
2520         int ret;
2521
2522         audio_file_table_desc.dir = dir;
2523         ret = osl(osl_open_table(&audio_file_table_desc, &audio_file_table));
2524         if (ret >= 0) {
2525                 unsigned num;
2526                 osl_get_num_rows(audio_file_table, &num);
2527                 PARA_INFO_LOG("audio file table contains %u files\n", num);
2528                 if (!current_aft_row) {
2529                         PARA_DEBUG_LOG("no current aft row\n");
2530                         return 1;
2531                 }
2532                 /* SIGHUP case, update current_aft_row */
2533                 ret = aft_get_row_of_hash(current_hash, &current_aft_row);
2534                 if (ret < 0) { /* not fatal */
2535                         PARA_WARNING_LOG("current hash lookup failure: %s\n",
2536                                 para_strerror(-ret));
2537                         current_aft_row = NULL;
2538                         return 1;
2539                 }
2540                 PARA_NOTICE_LOG("current audio file hash lookup: success\n");
2541                 return 1;
2542         }
2543         audio_file_table = NULL;
2544         if (ret == -OSL_ERRNO_TO_PARA_ERROR(E_OSL_NOENT)) {
2545                 PARA_WARNING_LOG("no audio file table\n");
2546                 return 1;
2547         }
2548         PARA_NOTICE_LOG("failed to open audio file table\n");
2549         return ret;
2550 }
2551
2552 static int aft_create(const char *dir)
2553 {
2554         audio_file_table_desc.dir = dir;
2555         return osl(osl_create_table(&audio_file_table_desc));
2556 }
2557
2558 static int clear_attribute(struct osl_row *row, void *data)
2559 {
2560         struct rmatt_event_data *red = data;
2561         struct afs_info afsi;
2562         struct osl_object obj;
2563         int ret = get_afsi_object_of_row(row, &obj);
2564         uint64_t mask = ~(1ULL << red->bitnum);
2565
2566         if (ret < 0)
2567                 return ret;
2568         ret = load_afsi(&afsi, &obj);
2569         if (ret < 0)
2570                 return ret;
2571         afsi.attributes &= mask;
2572         save_afsi(&afsi, &obj);
2573         return 1;
2574 }
2575
2576 static int aft_event_handler(enum afs_events event, struct para_buffer *pb,
2577                 void *data)
2578 {
2579         int ret;
2580
2581         switch (event) {
2582         case ATTRIBUTE_REMOVE: {
2583                 const struct rmatt_event_data *red = data;
2584                 para_printf(pb, "clearing attribute %s (bit %u) from all "
2585                         "entries in the audio file table\n", red->name,
2586                         red->bitnum);
2587                 return audio_file_loop(data, clear_attribute);
2588         } case AFSI_CHANGE: {
2589                 struct afsi_change_event_data *aced = data;
2590                 uint64_t old_last_played = status_item_ls_data.afsi.last_played;
2591                 if (aced->aft_row != current_aft_row)
2592                         return 0;
2593                 ret = get_afsi_of_row(aced->aft_row, &status_item_ls_data.afsi);
2594                 if (ret < 0)
2595                         return ret;
2596                 status_item_ls_data.afsi.last_played = old_last_played;
2597                 make_status_items();
2598                 return 1;
2599         } case AUDIO_FILE_RENAME: {
2600                 char *path;
2601                 if (data != current_aft_row)
2602                         return 0;
2603                 ret = get_audio_file_path_of_row(current_aft_row, &path);
2604                 if (ret < 0)
2605                         return ret;
2606                 free(status_item_ls_data.path);
2607                 status_item_ls_data.path = para_strdup(path);
2608                 make_status_items();
2609                 return 1;
2610         } case AFHI_CHANGE: {
2611                 if (data != current_aft_row)
2612                         return 0;
2613                 ret = get_afhi_of_row(data, &status_item_ls_data.afhi);
2614                 if (ret < 0)
2615                         return ret;
2616                 make_status_items();
2617                 return 1;
2618         } case AUDIO_FILE_REMOVE: {
2619                 if (data == current_aft_row)
2620                         current_aft_row = NULL;
2621                 return 0;
2622         }
2623         case BLOB_RENAME:
2624         case BLOB_REMOVE:
2625         case BLOB_ADD: {
2626                 /*
2627                  * These events are rare. We don't bother to check whether the
2628                  * current status items are affected and simply recreate them
2629                  * whenever an audio file is open.
2630                  */
2631                 if (!current_aft_row)
2632                         return 0;
2633                 ret = get_afhi_of_row(current_aft_row,
2634                         &status_item_ls_data.afhi);
2635                 if (ret < 0)
2636                         return ret;
2637                 make_status_items();
2638                 return 0;
2639         } default:
2640                 return 0;
2641         }
2642 }
2643
2644 /**
2645  * Initialize the audio file table.
2646  *
2647  * \param t Pointer to the structure to be initialized.
2648  */
2649 void aft_init(struct afs_table *t)
2650 {
2651         t->open = aft_open;
2652         t->close = aft_close;
2653         t->create = aft_create;
2654         t->event_handler = aft_event_handler;
2655 }