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