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