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