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