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