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