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