2 * Copyright (C) 2007-2014 Andre Noll <maan@systemlinux.org>
4 * Licensed under the GPL v2. For licencing details see COPYING.
7 /** \file aft.c Audio file table functions. */
23 #include "portable_io.h"
27 static struct osl_table *audio_file_table;
28 static char *status_items;
29 static char *parser_friendly_status_items;
31 /** The different sorting methods of the ls command. */
32 enum ls_sorting_method {
38 LS_SORT_BY_LAST_PLAYED,
40 LS_SORT_BY_NUM_PLAYED,
54 LS_SORT_BY_AUDIO_FORMAT,
59 /** The different listing modes of the ls command. */
60 enum ls_listing_mode {
61 /** Default listing mode. */
75 /** The flags accepted by the ls command. */
78 LS_FLAG_FULL_PATH = 1,
80 LS_FLAG_ADMISSIBLE_ONLY = 2,
88 * The size of the individual output fields of the ls command.
90 * These depend on the actual content being listed. If, for instance only files
91 * with duration less than an hour are being listed, then the duration with is
92 * made smaller because then the duration is listed as mm:ss rather than
96 /** size of the score field. */
97 unsigned short score_width;
98 /** size of the image id field. */
99 unsigned short image_id_width;
100 /** size of the lyrics id field. */
101 unsigned short lyrics_id_width;
102 /** size of the bitrate field. */
103 unsigned short bitrate_width;
104 /** size of the frequency field. */
105 unsigned short frequency_width;
106 /** size of the duration field. */
107 unsigned short duration_width;
108 /** size of the num played field. */
109 unsigned short num_played_width;
110 /** size of the amp field. */
111 unsigned short amp_width;
112 /** size of the audio format field. */
113 unsigned short audio_format_width;
116 /** Data passed from the ls command handler to its callback function. */
118 /** The given command line flags. */
120 /** The sorting method given at the command line. */
121 enum ls_sorting_method sorting;
122 /** The given listing mode (short, long, verbose, mbox). */
123 enum ls_listing_mode mode;
124 /** The arguments passed to the ls command. */
126 /** Number of non-option arguments. */
128 /** Used for long listing mode to align the output fields. */
129 struct ls_widths widths;
130 /** Size of the \a data array. */
132 /** Number of used entries in the data array. */
133 uint32_t num_matching_paths;
134 /** Array of matching entries. */
135 struct ls_data *data;
136 /** Used to sort the array. */
137 struct ls_data **data_ptr;
141 * Describes the layout of the mmapped-afs info struct.
143 * \sa struct afs_info.
146 /** Where .last_played is stored. */
147 AFSI_LAST_PLAYED_OFFSET = 0,
148 /** Storage position of the attributes bitmap. */
149 AFSI_ATTRIBUTES_OFFSET = 8,
150 /** Storage position of the .num_played field. */
151 AFSI_NUM_PLAYED_OFFSET = 16,
152 /** Storage position of the .image_id field. */
153 AFSI_IMAGE_ID_OFFSET = 20,
154 /** Storage position of the .lyrics_id field. */
155 AFSI_LYRICS_ID_OFFSET = 24,
156 /** Storage position of the .audio_format_id field. */
157 AFSI_AUDIO_FORMAT_ID_OFFSET = 28,
158 /** Storage position of the amplification field. */
159 AFSI_AMP_OFFSET = 29,
160 /** 2 bytes reserved space for future usage. */
161 AFSI_AUDIO_FORMAT_UNUSED_OFFSET = 30,
162 /** On-disk storage space needed. */
167 * Convert a struct afs_info to an osl object.
169 * \param afsi Pointer to the audio file info to be converted.
170 * \param obj Result pointer.
174 static void save_afsi(struct afs_info *afsi, struct osl_object *obj)
176 char *buf = obj->data;
178 write_u64(buf + AFSI_LAST_PLAYED_OFFSET, afsi->last_played);
179 write_u64(buf + AFSI_ATTRIBUTES_OFFSET, afsi->attributes);
180 write_u32(buf + AFSI_NUM_PLAYED_OFFSET, afsi->num_played);
181 write_u32(buf + AFSI_IMAGE_ID_OFFSET, afsi->image_id);
182 write_u32(buf + AFSI_LYRICS_ID_OFFSET, afsi->lyrics_id);
183 write_u8(buf + AFSI_AUDIO_FORMAT_ID_OFFSET,
184 afsi->audio_format_id);
185 write_u8(buf + AFSI_AMP_OFFSET, afsi->amp);
186 memset(buf + AFSI_AUDIO_FORMAT_UNUSED_OFFSET, 0, 2);
190 * Get the audio file selector info struct stored in an osl object.
192 * \param afsi Points to the audio_file info structure to be filled in.
193 * \param obj The osl object holding the data.
199 static int load_afsi(struct afs_info *afsi, struct osl_object *obj)
201 char *buf = obj->data;
202 if (obj->size < AFSI_SIZE)
204 afsi->last_played = read_u64(buf + AFSI_LAST_PLAYED_OFFSET);
205 afsi->attributes = read_u64(buf + AFSI_ATTRIBUTES_OFFSET);
206 afsi->num_played = read_u32(buf + AFSI_NUM_PLAYED_OFFSET);
207 afsi->image_id = read_u32(buf + AFSI_IMAGE_ID_OFFSET);
208 afsi->lyrics_id = read_u32(buf + AFSI_LYRICS_ID_OFFSET);
209 afsi->audio_format_id = read_u8(buf +
210 AFSI_AUDIO_FORMAT_ID_OFFSET);
211 afsi->amp = read_u8(buf + AFSI_AMP_OFFSET);
215 /** The columns of the audio file table. */
216 enum audio_file_table_columns {
217 /** The hash on the content of the audio file. */
219 /** The full path in the filesystem. */
221 /** The audio file selector info. */
223 /** The audio format handler info. */
225 /** The chunk table info and the chunk table of the audio file. */
227 /** The number of columns of this table. */
232 * Compare two osl objects pointing to hash values.
234 * \param obj1 Pointer to the first hash object.
235 * \param obj2 Pointer to the second hash object.
237 * \return The values required for an osl compare function.
239 * \sa osl_compare_func, uint32_compare().
241 static int aft_hash_compare(const struct osl_object *obj1, const struct osl_object *obj2)
243 return hash_compare((unsigned char *)obj1->data, (unsigned char *)obj2->data);
246 static struct osl_column_description aft_cols[] = {
248 .storage_type = OSL_MAPPED_STORAGE,
249 .storage_flags = OSL_RBTREE | OSL_FIXED_SIZE | OSL_UNIQUE,
251 .compare_function = aft_hash_compare,
252 .data_size = HASH_SIZE
255 .storage_type = OSL_MAPPED_STORAGE,
256 .storage_flags = OSL_RBTREE | OSL_UNIQUE,
258 .compare_function = string_compare,
261 .storage_type = OSL_MAPPED_STORAGE,
262 .storage_flags = OSL_FIXED_SIZE,
264 .data_size = AFSI_SIZE
267 .storage_type = OSL_MAPPED_STORAGE,
271 .storage_type = OSL_DISK_STORAGE,
276 static struct osl_table_description audio_file_table_desc = {
277 .name = "audio_files",
278 .num_columns = NUM_AFT_COLUMNS,
279 .flags = OSL_LARGE_TABLE,
280 .column_descriptions = aft_cols
283 /* We don't want dot or dot-dot anywhere. */
284 static int verify_dotfile(const char *rest)
287 * The first character was '.', but that has already been discarded, we
291 case '\0': case '/': /* /foo/. and /foo/./bar are not ok */
293 case '.': /* path start with /foo/.. */
294 if (rest[1] == '\0' || rest[1] == '/')
295 return -1; /* /foo/.. or /foo/../bar are not ok */
296 /* /foo/..bar is ok */
302 * We fundamentally don't like some paths: We don't want double slashes or
303 * slashes at the end that can make pathnames ambiguous.
305 static int verify_path(const char *orig_path, char **resolved_path)
311 if (*orig_path != '/') /* we only accept absolute paths */
313 len = strlen(orig_path);
314 *resolved_path = para_strdup(orig_path);
315 path = *resolved_path;
316 while (len > 1 && path[--len] == '/')
317 path[len] = '\0'; /* remove slash at the end */
323 case '/': /* double slash */
326 if (verify_dotfile(path) < 0)
336 free(*resolved_path);
340 /** The on-disk layout of a afhi struct. */
342 /** Where the number of seconds is stored. */
343 AFHI_SECONDS_TOTAL_OFFSET = 0,
344 /** Position of the bitrate. */
345 AFHI_BITRATE_OFFSET = 4,
346 /** Position of the frequency. */
347 AFHI_FREQUENCY_OFFSET = 8,
348 /** Was: Location of the audio file header. */
349 AFHI_UNUSED1_OFFSET = 12,
350 /* Length of the audio file header. Zero means: No header. */
351 AFHI_HEADER_LEN_OFFSET = 16,
352 /** The total number of chunks (4 bytes). */
353 CHUNKS_TOTAL_OFFSET = 20,
354 /** The length of the audio file header (4 bytes). */
355 HEADER_LEN_OFFSET = 24,
356 /** Was: The start of the audio file header (4 bytes). */
357 AFHI_UNUSED2_OFFSET = 28,
358 /** The seconds part of the chunk time (4 bytes). */
359 CHUNK_TV_TV_SEC_OFFSET = 32,
360 /** The microseconds part of the chunk time (4 bytes). */
361 CHUNK_TV_TV_USEC_OFFSET = 36,
362 /** Number of channels is stored here. (1 byte) */
363 AFHI_CHANNELS_OFFSET = 40,
364 /** The tag info position. */
365 AFHI_INFO_STRING_OFFSET = 41,
366 /** Minimal on-disk size of a valid afhi struct. */
367 MIN_AFHI_SIZE = 47, /* at least 6 null bytes for techinfo/tags */
370 static unsigned sizeof_afhi_buf(const struct afh_info *afhi)
375 + strlen(afhi->techinfo)
376 + strlen(afhi->tags.artist)
377 + strlen(afhi->tags.title)
378 + strlen(afhi->tags.year)
379 + strlen(afhi->tags.album)
380 + strlen(afhi->tags.comment);
383 static void save_afhi(struct afh_info *afhi, char *buf)
389 write_u32(buf + AFHI_SECONDS_TOTAL_OFFSET, afhi->seconds_total);
390 write_u32(buf + AFHI_BITRATE_OFFSET, afhi->bitrate);
391 write_u32(buf + AFHI_FREQUENCY_OFFSET, afhi->frequency);
392 write_u32(buf + AFHI_UNUSED1_OFFSET, 0);
393 write_u32(buf + AFHI_HEADER_LEN_OFFSET, afhi->header_len);
394 write_u8(buf + AFHI_CHANNELS_OFFSET, afhi->channels);
395 write_u32(buf + CHUNKS_TOTAL_OFFSET, afhi->chunks_total);
396 write_u32(buf + HEADER_LEN_OFFSET, afhi->header_len);
397 write_u32(buf + AFHI_UNUSED2_OFFSET, 0);
398 write_u32(buf + CHUNK_TV_TV_SEC_OFFSET, afhi->chunk_tv.tv_sec);
399 write_u32(buf + CHUNK_TV_TV_USEC_OFFSET, afhi->chunk_tv.tv_usec);
400 p = buf + AFHI_INFO_STRING_OFFSET;
401 /* The sprintf's below are OK as our caller made sure that buf is large enough */
402 p += sprintf(p, "%s", afhi->techinfo) + 1;
403 p += sprintf(p, "%s", afhi->tags.artist) + 1;
404 p += sprintf(p, "%s", afhi->tags.title) + 1;
405 p += sprintf(p, "%s", afhi->tags.year) + 1;
406 p += sprintf(p, "%s", afhi->tags.album) + 1;
407 sprintf(p, "%s", afhi->tags.comment);
410 static void load_afhi(const char *buf, struct afh_info *afhi)
412 afhi->seconds_total = read_u32(buf + AFHI_SECONDS_TOTAL_OFFSET);
413 afhi->bitrate = read_u32(buf + AFHI_BITRATE_OFFSET);
414 afhi->frequency = read_u32(buf + AFHI_FREQUENCY_OFFSET);
415 afhi->header_len = read_u32(buf + AFHI_HEADER_LEN_OFFSET);
416 afhi->channels = read_u8(buf + AFHI_CHANNELS_OFFSET);
417 afhi->chunks_total = read_u32(buf + CHUNKS_TOTAL_OFFSET);
418 afhi->header_len = read_u32(buf + HEADER_LEN_OFFSET);
419 afhi->chunk_tv.tv_sec = read_u32(buf + CHUNK_TV_TV_SEC_OFFSET);
420 afhi->chunk_tv.tv_usec = read_u32(buf + CHUNK_TV_TV_USEC_OFFSET);
421 afhi->techinfo = (char *)buf + AFHI_INFO_STRING_OFFSET;
422 afhi->tags.artist = afhi->techinfo + strlen(afhi->techinfo) + 1;
423 afhi->tags.title = afhi->tags.artist + strlen(afhi->tags.artist) + 1;
424 afhi->tags.year = afhi->tags.title + strlen(afhi->tags.title) + 1;
425 afhi->tags.album = afhi->tags.year + strlen(afhi->tags.year) + 1;
426 afhi->tags.comment = afhi->tags.album + strlen(afhi->tags.album) + 1;
429 static unsigned sizeof_chunk_table(struct afh_info *afhi)
433 return 4 * (afhi->chunks_total + 1);
436 static uint32_t save_chunk_table(struct afh_info *afhi, char *buf)
439 uint32_t max = 0, old = 0;
441 for (i = 0; i <= afhi->chunks_total; i++) {
442 uint32_t val = afhi->chunk_table[i];
443 write_u32(buf + 4 * i, val);
445 * If the first chunk is the header, do not consider it for the
446 * calculation of the largest chunk size.
448 if (i == 0 || (i == 1 && afhi->header_len > 0)) {
452 max = PARA_MAX(max, val - old);
458 static void load_chunk_table(struct afh_info *afhi, char *buf)
462 afhi->chunk_table = para_malloc(sizeof_chunk_table(afhi));
463 for (i = 0; i <= afhi->chunks_total; i++)
464 afhi->chunk_table[i] = read_u32(buf + 4 * i);
468 * Get the row of the audio file table corresponding to the given path.
470 * \param path The full path of the audio file.
471 * \param row Result pointer.
475 int aft_get_row_of_path(const char *path, struct osl_row **row)
477 struct osl_object obj = {.data = (char *)path, .size = strlen(path) + 1};
479 return osl(osl_get_row(audio_file_table, AFTCOL_PATH, &obj, row));
483 * Get the row of the audio file table corresponding to the given hash value.
485 * \param hash The hash value of the desired audio file.
486 * \param row Result pointer.
490 static int aft_get_row_of_hash(unsigned char *hash, struct osl_row **row)
492 const struct osl_object obj = {.data = hash, .size = HASH_SIZE};
493 return osl(osl_get_row(audio_file_table, AFTCOL_HASH, &obj, row));
497 * Get the audio file selector info object of a row.
499 * \param row Pointer to a row in the audio file table.
500 * \param obj Result pointer.
504 static int get_afsi_object_of_row(const struct osl_row *row,
505 struct osl_object *obj)
507 return osl(osl_get_object(audio_file_table, row, AFTCOL_AFSI, obj));
511 * Get the osl object holding the audio file selector info, given a path.
514 * \param path The full path of the audio file.
515 * \param obj Result pointer.
517 * \return Positive on success, negative on errors.
519 static int get_afsi_object_of_path(const char *path, struct osl_object *obj)
522 int ret = aft_get_row_of_path(path, &row);
525 return get_afsi_object_of_row(row, obj);
529 * Get the audio file selector info, given a row of the audio file table.
531 * \param row Pointer to a row in the audio file table.
532 * \param afsi Result pointer.
534 * \return Positive on success, negative on errors.
536 int get_afsi_of_row(const struct osl_row *row, struct afs_info *afsi)
538 struct osl_object obj;
539 int ret = get_afsi_object_of_row(row, &obj);
542 return load_afsi(afsi, &obj);
546 * Get the audio file selector info, given the path of an audio table.
548 * \param path The full path of the audio file.
549 * \param afsi Result pointer.
553 static int get_afsi_of_path(const char *path, struct afs_info *afsi)
555 struct osl_object obj;
556 int ret = get_afsi_object_of_path(path, &obj);
559 return load_afsi(afsi, &obj);
563 * Get the path of an audio file, given a row of the audio file table.
565 * \param row Pointer to a row in the audio file table.
566 * \param path Result pointer.
568 * The result is a pointer to mmapped data. The caller must not attempt
573 int get_audio_file_path_of_row(const struct osl_row *row, char **path)
575 struct osl_object path_obj;
576 int ret = osl(osl_get_object(audio_file_table, row, AFTCOL_PATH,
580 *path = path_obj.data;
585 * Get the object containing the hash value of an audio file, given a row.
587 * \param row Pointer to a row of the audio file table.
588 * \param obj Result pointer.
590 * \return The return value of the underlying call to osl_get_object().
592 * \sa get_hash_of_row().
594 static int get_hash_object_of_aft_row(const struct osl_row *row,
595 struct osl_object *obj)
597 return osl(osl_get_object(audio_file_table, row, AFTCOL_HASH, obj));
601 * Get the hash value of an audio file, given a row of the audio file table.
603 * \param row Pointer to a row of the audio file table.
604 * \param hash Result pointer.
606 * \a hash points to mapped data and must not be freed by the caller.
608 * \return The return value of the underlying call to
609 * get_hash_object_of_aft_row().
611 static int get_hash_of_row(const struct osl_row *row, unsigned char **hash)
613 struct osl_object obj;
614 int ret = get_hash_object_of_aft_row(row, &obj);
623 * Get the audio format handler info, given a row of the audio file table.
625 * \param row Pointer to a row of the audio file table.
626 * \param afhi Result pointer.
628 * \return The return value of the underlying call to osl_get_object().
630 * \sa get_chunk_table_of_row().
632 int get_afhi_of_row(const struct osl_row *row, struct afh_info *afhi)
634 struct osl_object obj;
635 int ret = osl(osl_get_object(audio_file_table, row, AFTCOL_AFHI,
639 load_afhi(obj.data, afhi);
643 /* returns shmid on success */
644 static int save_afd(struct audio_file_data *afd)
646 size_t size = sizeof(*afd) + sizeof_chunk_table(&afd->afhi);
647 int shmid, ret = shm_new(size);
654 ret = shm_attach(shmid, ATTACH_RW, &shm_afd);
659 afd->max_chunk_size = save_chunk_table(&afd->afhi, buf);
660 *(struct audio_file_data *)shm_afd = *afd;
669 * Extract a afd stored in a shared memory area.
671 * Attach the shared memory area given by \a shmid, load the audio file data
672 * stored therein and detach the area afterwards. Called by vss, after
673 * receiving a positive response to the request for the next audio file.
675 * \param shmid The identifier of the shared memory area containing the afd.
676 * \param afd Result pointer.
680 int load_afd(int shmid, struct audio_file_data *afd)
686 ret = shm_attach(shmid, ATTACH_RO, &shm_afd);
689 *afd = *(struct audio_file_data *)shm_afd;
692 load_chunk_table(&afd->afhi, buf);
697 static int get_local_time(uint64_t *seconds, char *buf, size_t size,
698 time_t current_time, enum ls_listing_mode lm)
702 if (!localtime_r((time_t *)seconds, &t))
704 if (lm == LS_MODE_MBOX) {
705 if (!strftime(buf, size, "%c", &t))
709 if (*seconds + 6 * 30 * 24 * 3600 > current_time) {
710 if (!strftime(buf, size, "%b %e %k:%M", &t))
714 if (!strftime(buf, size, "%b %e %Y", &t))
719 /** Compute the number of (decimal) digits of a number. */
720 #define GET_NUM_DIGITS(x, num) { \
721 typeof((x)) _tmp = PARA_ABS(x); \
724 while ((_tmp) > 9) { \
730 __a_const static short unsigned get_duration_width(int seconds)
732 short unsigned width;
733 unsigned hours = seconds / 3600, mins = (seconds % 3600) / 60;
735 if (!hours) /* less than one hour => m:ss or mm:ss => 4 or 5 digits */
736 return 4 + (mins > 9);
737 /* more than one hour => h:mm:ss, hh:mm:ss, hhh:mm:ss, ... */
738 GET_NUM_DIGITS(hours, &width);
742 static void get_duration_buf(int seconds, char *buf, struct ls_options *opts)
744 unsigned hours = seconds / 3600, mins = (seconds % 3600) / 60;
745 short unsigned max_width;
747 if (!hours) { /* m:ss or mm:ss */
748 max_width = opts->mode == LS_MODE_LONG?
749 opts->widths.duration_width : 4;
750 sprintf(buf, "%*u:%02u", max_width - 3, mins, seconds % 60);
751 } else { /* more than one hour => h:mm:ss, hh:mm:ss, hhh:mm:ss, ... */
752 max_width = opts->mode == LS_MODE_LONG?
753 opts->widths.duration_width : 7;
754 sprintf(buf, "%*u:%02u:%02u", max_width - 6, hours, mins,
760 static int write_attribute_items(struct para_buffer *b,
761 const char *att_bitmap, struct afs_info *afsi)
766 ret = WRITE_STATUS_ITEM(b, SI_ATTRIBUTES_BITMAP, "%s\n", att_bitmap);
769 ret = get_attribute_text(&afsi->attributes, " ", &att_text);
772 ret = WRITE_STATUS_ITEM(b, SI_ATTRIBUTES_TXT, "%s\n", att_text);
777 static int write_lyrics_items(struct para_buffer *b, struct afs_info *afsi)
782 ret = WRITE_STATUS_ITEM(b, SI_LYRICS_ID, "%u\n", afsi->lyrics_id);
785 lyr_get_name_by_id(afsi->lyrics_id, &lyrics_name);
786 return WRITE_STATUS_ITEM(b, SI_LYRICS_NAME, "%s\n", lyrics_name?
787 lyrics_name : "(none)");
790 static int write_image_items(struct para_buffer *b, struct afs_info *afsi)
795 ret = WRITE_STATUS_ITEM(b, SI_IMAGE_ID, "%u\n", afsi->image_id);
798 img_get_name_by_id(afsi->image_id, &image_name);
799 return WRITE_STATUS_ITEM(b, SI_IMAGE_NAME, "%s\n", image_name?
800 image_name : "(none)");
803 static int write_filename_items(struct para_buffer *b, const char *path,
809 if (!(flags & LS_FLAG_FULL_PATH))
810 return WRITE_STATUS_ITEM(b, SI_BASENAME, "%s\n", path);
811 ret = WRITE_STATUS_ITEM(b, SI_PATH, "%s\n", path);
814 val = para_basename(path);
815 ret = WRITE_STATUS_ITEM(b, SI_BASENAME, "%s\n", val? val : "");
818 val = para_dirname(path);
819 ret = WRITE_STATUS_ITEM(b, SI_DIRECTORY, "%s\n", val? val : "");
824 static int print_chunk_table(struct ls_data *d, struct para_buffer *b)
826 struct osl_object chunk_table_obj;
827 struct osl_row *aft_row;
831 ret = aft_get_row_of_hash(d->hash, &aft_row);
834 ret = osl_open_disk_object(audio_file_table, aft_row,
835 AFTCOL_CHUNKS, &chunk_table_obj);
838 ret = para_printf(b, "%s\n"
839 "chunk_time: %lu:%lu\nchunk_offsets: ",
841 (long unsigned) d->afhi.chunk_tv.tv_sec,
842 (long unsigned) d->afhi.chunk_tv.tv_usec
846 buf = chunk_table_obj.data;
847 for (i = 0; i <= d->afhi.chunks_total; i++) {
848 ret = para_printf(b, "%u ", (unsigned) read_u32(buf + 4 * i));
852 ret = para_printf(b, "\n");
854 osl_close_disk_object(&chunk_table_obj);
858 static int write_score(struct para_buffer *b, struct ls_data *d,
859 struct ls_options *opts)
861 if (!(opts->flags & LS_FLAG_ADMISSIBLE_ONLY)) /* no score*/
863 return WRITE_STATUS_ITEM(b, SI_SCORE, "%li\n", d->score);
866 static int print_list_item(struct ls_data *d, struct ls_options *opts,
867 struct para_buffer *b, time_t current_time)
871 char last_played_time[30];
872 char duration_buf[30]; /* nobody has an audio file long enough to overflow this */
873 struct afs_info *afsi = &d->afsi;
874 struct afh_info *afhi = &d->afhi;
875 char asc_hash[2 * HASH_SIZE + 1];
877 if (opts->mode == LS_MODE_SHORT) {
878 ret = para_printf(b, "%s\n", d->path);
881 if (opts->mode == LS_MODE_CHUNKS) {
882 ret = print_chunk_table(d, b);
885 get_attribute_bitmap(&afsi->attributes, att_buf);
886 if (opts->flags & LS_FLAG_UNIXDATE)
887 sprintf(last_played_time, "%llu",
888 (long long unsigned)afsi->last_played);
890 ret = get_local_time(&afsi->last_played, last_played_time,
891 sizeof(last_played_time), current_time, opts->mode);
895 get_duration_buf(afhi->seconds_total, duration_buf, opts);
896 if (opts->mode == LS_MODE_LONG) {
897 struct ls_widths *w = &opts->widths;
898 if (opts->flags & LS_FLAG_ADMISSIBLE_ONLY) {
899 ret = para_printf(b, "%*li ",
900 opts->widths.score_width, d->score);
905 "%s " /* attributes */
907 "%*d " /* image_id */
908 "%*d " /* lyrics_id */
910 "%*s " /* audio format */
911 "%*d " /* frequency */
914 "%*d " /* num_played */
915 "%s " /* last_played */
918 w->amp_width, afsi->amp,
919 w->image_id_width, afsi->image_id,
920 w->lyrics_id_width, afsi->lyrics_id,
921 w->bitrate_width, afhi->bitrate,
922 w->audio_format_width,
923 audio_format_name(afsi->audio_format_id),
924 w->frequency_width, afhi->frequency,
927 w->num_played_width, afsi->num_played,
933 if (opts->mode == LS_MODE_MBOX) {
934 const char *bn = para_basename(d->path);
936 "From foo@localhost %s\n"
937 "Received: from\nTo: bar\nFrom: a\n"
944 ret = write_filename_items(b, d->path, opts->flags);
947 ret = write_score(b, d, opts);
950 ret = write_attribute_items(b, att_buf, afsi);
953 ret = write_image_items(b, afsi);
956 ret = write_lyrics_items(b, afsi);
959 hash_to_asc(d->hash, asc_hash);
960 ret = WRITE_STATUS_ITEM(b, SI_HASH, "%s\n", asc_hash);
963 ret = WRITE_STATUS_ITEM(b, SI_BITRATE, "%dkbit/s\n", afhi->bitrate);
966 ret = WRITE_STATUS_ITEM(b, SI_FORMAT, "%s\n",
967 audio_format_name(afsi->audio_format_id));
970 ret = WRITE_STATUS_ITEM(b, SI_FREQUENCY, "%dHz\n", afhi->frequency);
973 ret = WRITE_STATUS_ITEM(b, SI_CHANNELS, "%d\n", afhi->channels);
976 ret = WRITE_STATUS_ITEM(b, SI_DURATION, "%s\n", duration_buf);
979 ret = WRITE_STATUS_ITEM(b, SI_SECONDS_TOTAL, "%lu\n",
980 afhi->seconds_total);
983 ret = WRITE_STATUS_ITEM(b, SI_LAST_PLAYED, "%s\n", last_played_time);
986 ret = WRITE_STATUS_ITEM(b, SI_NUM_PLAYED, "%d\n", afsi->num_played);
989 ret = WRITE_STATUS_ITEM(b, SI_AMPLIFICATION, "%u\n", afsi->amp);
992 ret = WRITE_STATUS_ITEM(b, SI_CHUNK_TIME, "%lu\n",
993 tv2ms(&afhi->chunk_tv));
996 ret = WRITE_STATUS_ITEM(b, SI_NUM_CHUNKS, "%lu\n",
1000 ret = WRITE_STATUS_ITEM(b, SI_TECHINFO, "%s\n", afhi->techinfo);
1003 ret = WRITE_STATUS_ITEM(b, SI_ARTIST, "%s\n", afhi->tags.artist);
1006 ret = WRITE_STATUS_ITEM(b, SI_TITLE, "%s\n", afhi->tags.title);
1009 ret = WRITE_STATUS_ITEM(b, SI_YEAR, "%s\n", afhi->tags.year);
1012 ret = WRITE_STATUS_ITEM(b, SI_ALBUM, "%s\n", afhi->tags.album);
1015 ret = WRITE_STATUS_ITEM(b, SI_COMMENT, "%s\n", afhi->tags.comment);
1018 if (opts->mode == LS_MODE_MBOX) {
1019 struct osl_object lyrics_def;
1020 lyr_get_def_by_id(afsi->lyrics_id, &lyrics_def);
1021 if (lyrics_def.data) {
1022 ret = para_printf(b, "Lyrics:\n~~~~~~~\n%s",
1023 (char *)lyrics_def.data);
1024 osl_close_disk_object(&lyrics_def);
1031 static int make_status_items(struct audio_file_data *afd,
1032 struct afs_info *afsi, char *path, long score,
1033 unsigned char *hash)
1035 struct ls_data d = {
1042 struct ls_options opts = {
1043 .flags = LS_FLAG_FULL_PATH | LS_FLAG_ADMISSIBLE_ONLY,
1044 .mode = LS_MODE_VERBOSE,
1046 struct para_buffer pb = {.max_size = shm_get_shmmax() - 1};
1047 time_t current_time;
1050 time(¤t_time);
1051 ret = print_list_item(&d, &opts, &pb, current_time);
1055 status_items = pb.buf;
1056 memset(&pb, 0, sizeof(pb));
1057 pb.max_size = shm_get_shmmax() - 1;
1058 pb.flags = PBF_SIZE_PREFIX;
1059 ret = print_list_item(&d, &opts, &pb, current_time);
1062 status_items = NULL;
1065 free(parser_friendly_status_items);
1066 parser_friendly_status_items = pb.buf;
1071 * Mmap the given audio file and update statistics.
1073 * \param aft_row Determines the audio file to be opened and updated.
1074 * \param score The score of the audio file.
1075 * \param afd Result pointer.
1077 * On success, the numplayed field of the audio file selector info is increased
1078 * and the lastplayed time is set to the current time. Finally, the score of
1079 * the audio file is updated.
1081 * \return Positive shmid on success, negative on errors.
1083 int open_and_update_audio_file(struct osl_row *aft_row, long score,
1084 struct audio_file_data *afd)
1086 unsigned char *aft_hash, file_hash[HASH_SIZE];
1087 struct osl_object afsi_obj;
1088 struct afs_info old_afsi, new_afsi;
1089 int ret = get_hash_of_row(aft_row, &aft_hash);
1090 struct afsi_change_event_data aced;
1091 struct osl_object map, chunk_table_obj;
1096 ret = get_audio_file_path_of_row(aft_row, &path);
1099 PARA_NOTICE_LOG("%s\n", path);
1100 ret = get_afsi_object_of_row(aft_row, &afsi_obj);
1103 ret = load_afsi(&old_afsi, &afsi_obj);
1106 ret = get_afhi_of_row(aft_row, &afd->afhi);
1109 afd->afhi.chunk_table = NULL;
1110 ret = osl_open_disk_object(audio_file_table, aft_row,
1111 AFTCOL_CHUNKS, &chunk_table_obj);
1114 ret = mmap_full_file(path, O_RDONLY, &map.data,
1115 &map.size, &afd->fd);
1118 hash_function(map.data, map.size, file_hash);
1119 ret = hash_compare(file_hash, aft_hash);
1120 para_munmap(map.data, map.size);
1122 ret = -E_HASH_MISMATCH;
1125 new_afsi = old_afsi;
1126 new_afsi.num_played++;
1127 new_afsi.last_played = time(NULL);
1128 save_afsi(&new_afsi, &afsi_obj); /* in-place update */
1130 afd->audio_format_id = old_afsi.audio_format_id;
1131 load_chunk_table(&afd->afhi, chunk_table_obj.data);
1132 ret = make_status_items(afd, &old_afsi, path, score, file_hash);
1135 aced.aft_row = aft_row;
1136 aced.old_afsi = &old_afsi;
1137 afs_event(AFSI_CHANGE, NULL, &aced);
1138 ret = save_afd(afd);
1140 free(afd->afhi.chunk_table);
1141 osl_close_disk_object(&chunk_table_obj);
1143 PARA_ERROR_LOG("%s: %s\n", path, para_strerror(-ret));
1147 static int ls_audio_format_compare(const void *a, const void *b)
1149 struct ls_data *d1 = *(struct ls_data **)a, *d2 = *(struct ls_data **)b;
1150 return NUM_COMPARE(d1->afsi.audio_format_id, d2->afsi.audio_format_id);
1153 static int ls_duration_compare(const void *a, const void *b)
1155 struct ls_data *d1 = *(struct ls_data **)a, *d2 = *(struct ls_data **)b;
1156 return NUM_COMPARE(d1->afhi.seconds_total, d2->afhi.seconds_total);
1159 static int ls_bitrate_compare(const void *a, const void *b)
1161 struct ls_data *d1 = *(struct ls_data **)a, *d2 = *(struct ls_data **)b;
1162 return NUM_COMPARE(d1->afhi.bitrate, d2->afhi.bitrate);
1165 static int ls_lyrics_id_compare(const void *a, const void *b)
1167 struct ls_data *d1 = *(struct ls_data **)a, *d2 = *(struct ls_data **)b;
1168 return NUM_COMPARE(d1->afsi.lyrics_id, d2->afsi.lyrics_id);
1171 static int ls_image_id_compare(const void *a, const void *b)
1173 struct ls_data *d1 = *(struct ls_data **)a, *d2 = *(struct ls_data **)b;
1174 return NUM_COMPARE(d1->afsi.image_id, d2->afsi.image_id);
1177 static int ls_channels_compare(const void *a, const void *b)
1179 struct ls_data *d1 = *(struct ls_data **)a, *d2 = *(struct ls_data **)b;
1180 return NUM_COMPARE(d1->afhi.channels, d2->afhi.channels);
1183 static int ls_frequency_compare(const void *a, const void *b)
1185 struct ls_data *d1 = *(struct ls_data **)a, *d2 = *(struct ls_data **)b;
1186 return NUM_COMPARE(d1->afhi.frequency, d2->afhi.frequency);
1189 static int ls_num_played_compare(const void *a, const void *b)
1191 struct ls_data *d1 = *(struct ls_data **)a, *d2 = *(struct ls_data **)b;
1192 return NUM_COMPARE(d1->afsi.num_played, d2->afsi.num_played);
1195 static int ls_last_played_compare(const void *a, const void *b)
1197 struct ls_data *d1 = *(struct ls_data **)a, *d2 = *(struct ls_data **)b;
1198 return NUM_COMPARE(d1->afsi.last_played, d2->afsi.last_played);
1201 static int ls_score_compare(const void *a, const void *b)
1203 struct ls_data *d1 = *(struct ls_data **)a, *d2 = *(struct ls_data **)b;
1204 return NUM_COMPARE(d1->score, d2->score);
1207 static int ls_path_compare(const void *a, const void *b)
1209 struct ls_data *d1 = *(struct ls_data **)a, *d2 = *(struct ls_data **)b;
1210 return strcmp(d1->path, d2->path);
1213 static int sort_matching_paths(struct ls_options *options)
1215 size_t nmemb = options->num_matching_paths;
1216 size_t size = sizeof(*options->data_ptr);
1217 int (*compar)(const void *, const void *);
1220 options->data_ptr = para_malloc(nmemb * sizeof(*options->data_ptr));
1221 for (i = 0; i < nmemb; i++)
1222 options->data_ptr[i] = options->data + i;
1224 /* In these cases the array is already sorted */
1225 if (options->sorting == LS_SORT_BY_PATH
1226 && !(options->flags & LS_FLAG_ADMISSIBLE_ONLY)
1227 && (options->flags & LS_FLAG_FULL_PATH))
1229 if (options->sorting == LS_SORT_BY_SCORE &&
1230 options->flags & LS_FLAG_ADMISSIBLE_ONLY)
1233 switch (options->sorting) {
1234 case LS_SORT_BY_PATH:
1235 compar = ls_path_compare; break;
1236 case LS_SORT_BY_SCORE:
1237 compar = ls_score_compare; break;
1238 case LS_SORT_BY_LAST_PLAYED:
1239 compar = ls_last_played_compare; break;
1240 case LS_SORT_BY_NUM_PLAYED:
1241 compar = ls_num_played_compare; break;
1242 case LS_SORT_BY_FREQUENCY:
1243 compar = ls_frequency_compare; break;
1244 case LS_SORT_BY_CHANNELS:
1245 compar = ls_channels_compare; break;
1246 case LS_SORT_BY_IMAGE_ID:
1247 compar = ls_image_id_compare; break;
1248 case LS_SORT_BY_LYRICS_ID:
1249 compar = ls_lyrics_id_compare; break;
1250 case LS_SORT_BY_BITRATE:
1251 compar = ls_bitrate_compare; break;
1252 case LS_SORT_BY_DURATION:
1253 compar = ls_duration_compare; break;
1254 case LS_SORT_BY_AUDIO_FORMAT:
1255 compar = ls_audio_format_compare; break;
1259 qsort(options->data_ptr, nmemb, size, compar);
1263 /* row is either an aft_row or a row of the score table */
1264 /* TODO: Only compute widths if we need them */
1265 static int prepare_ls_row(struct osl_row *row, void *ls_opts)
1268 struct ls_options *options = ls_opts;
1270 struct ls_widths *w;
1271 unsigned short num_digits;
1273 struct osl_row *aft_row;
1277 if (options->flags & LS_FLAG_ADMISSIBLE_ONLY) {
1278 ret = get_score_and_aft_row(row, &score, &aft_row);
1285 ret = get_audio_file_path_of_row(aft_row, &path);
1288 if (!(options->flags & LS_FLAG_FULL_PATH)) {
1289 char *p = strrchr(path, '/');
1293 if (options->num_patterns) {
1294 for (i = 0; i < options->num_patterns; i++) {
1295 ret = fnmatch(options->patterns[i], path, 0);
1298 if (ret == FNM_NOMATCH)
1302 if (i >= options->num_patterns) /* no match */
1305 tmp = options->num_matching_paths++;
1306 if (options->num_matching_paths > options->array_size) {
1307 options->array_size++;
1308 options->array_size *= 2;
1309 options->data = para_realloc(options->data, options->array_size
1310 * sizeof(*options->data));
1312 d = options->data + tmp;
1313 ret = get_afsi_of_row(aft_row, &d->afsi);
1316 ret = get_afhi_of_row(aft_row, &d->afhi);
1320 ret = get_hash_of_row(aft_row, &d->hash);
1323 w = &options->widths;
1324 GET_NUM_DIGITS(d->afsi.image_id, &num_digits);
1325 w->image_id_width = PARA_MAX(w->image_id_width, num_digits);
1326 GET_NUM_DIGITS(d->afsi.lyrics_id, &num_digits);
1327 w->lyrics_id_width = PARA_MAX(w->lyrics_id_width, num_digits);
1328 GET_NUM_DIGITS(d->afhi.bitrate, &num_digits);
1329 w->bitrate_width = PARA_MAX(w->bitrate_width, num_digits);
1330 GET_NUM_DIGITS(d->afhi.frequency, &num_digits);
1331 w->frequency_width = PARA_MAX(w->frequency_width, num_digits);
1332 GET_NUM_DIGITS(d->afsi.num_played, &num_digits);
1333 w->num_played_width = PARA_MAX(w->num_played_width, num_digits);
1334 /* get the number of chars to print this amount of time */
1335 num_digits = get_duration_width(d->afhi.seconds_total);
1336 w->duration_width = PARA_MAX(w->duration_width, num_digits);
1337 GET_NUM_DIGITS(d->afsi.amp, &num_digits);
1338 w->amp_width = PARA_MAX(w->amp_width, num_digits);
1339 num_digits = strlen(audio_format_name(d->afsi.audio_format_id));
1340 w->audio_format_width = PARA_MAX(w->audio_format_width, num_digits);
1341 if (options->flags & LS_FLAG_ADMISSIBLE_ONLY) {
1342 GET_NUM_DIGITS(score, &num_digits);
1343 num_digits++; /* add one for the sign (space or "-") */
1344 w->score_width = PARA_MAX(w->score_width, num_digits);
1352 static void com_ls_callback(int fd, const struct osl_object *query)
1354 struct ls_options *opts = query->data;
1355 char *p, *pattern_start = (char *)query->data + sizeof(*opts);
1356 struct para_buffer b = {
1357 .max_size = shm_get_shmmax(),
1358 .flags = (opts->mode == LS_MODE_PARSER)? PBF_SIZE_PREFIX : 0,
1359 .max_size_handler = afs_max_size_handler,
1360 .private_data = &(struct afs_max_size_handler_data) {
1366 time_t current_time;
1368 if (opts->num_patterns) {
1369 opts->patterns = para_malloc(opts->num_patterns * sizeof(char *));
1370 for (i = 0, p = pattern_start; i < opts->num_patterns; i++) {
1371 opts->patterns[i] = p;
1375 opts->patterns = NULL;
1376 if (opts->flags & LS_FLAG_ADMISSIBLE_ONLY)
1377 ret = admissible_file_loop(opts, prepare_ls_row);
1379 ret = osl(osl_rbtree_loop(audio_file_table, AFTCOL_PATH, opts,
1383 if (opts->num_matching_paths == 0) {
1384 if (opts->num_patterns > 0)
1385 para_printf(&b, "no matches\n");
1388 ret = sort_matching_paths(opts);
1391 time(¤t_time);
1392 if (opts->flags & LS_FLAG_REVERSE)
1393 for (i = opts->num_matching_paths - 1; i >= 0; i--) {
1394 ret = print_list_item(opts->data_ptr[i], opts, &b, current_time);
1399 for (i = 0; i < opts->num_matching_paths; i++) {
1400 ret = print_list_item(opts->data_ptr[i], opts, &b, current_time);
1406 pass_buffer_as_shm(fd, SBD_OUTPUT, b.buf, b.offset);
1409 free(opts->data_ptr);
1410 free(opts->patterns);
1414 * TODO: flags -h (sort by hash)
1416 int com_ls(struct command_context *cc)
1420 enum ls_sorting_method sort = LS_SORT_BY_PATH;
1421 enum ls_listing_mode mode = LS_MODE_SHORT;
1422 struct ls_options opts = {.patterns = NULL};
1423 struct osl_object query = {.data = &opts, .size = sizeof(opts)};
1425 for (i = 1; i < cc->argc; i++) {
1426 const char *arg = cc->argv[i];
1429 if (!strcmp(arg, "--")) {
1433 if (!strncmp(arg, "-l", 2)) {
1435 mode = LS_MODE_LONG;
1439 return -E_AFT_SYNTAX;
1440 switch(*(arg + 2)) {
1442 mode = LS_MODE_SHORT;
1445 mode = LS_MODE_LONG;
1448 mode = LS_MODE_VERBOSE;
1451 mode = LS_MODE_MBOX;
1454 mode = LS_MODE_CHUNKS;
1457 mode = LS_MODE_PARSER;
1460 return -E_AFT_SYNTAX;
1463 if (!strcmp(arg, "-p")) {
1464 flags |= LS_FLAG_FULL_PATH;
1467 if (!strcmp(arg, "-a")) {
1468 flags |= LS_FLAG_ADMISSIBLE_ONLY;
1471 if (!strcmp(arg, "-r")) {
1472 flags |= LS_FLAG_REVERSE;
1475 if (!strcmp(arg, "-d")) {
1476 flags |= LS_FLAG_UNIXDATE;
1479 if (!strncmp(arg, "-s", 2)) {
1480 if (!*(arg + 2) || *(arg + 3))
1481 return -E_AFT_SYNTAX;
1482 switch(*(arg + 2)) {
1484 sort = LS_SORT_BY_PATH;
1486 case 's': /* -ss implies -a */
1487 sort = LS_SORT_BY_SCORE;
1488 flags |= LS_FLAG_ADMISSIBLE_ONLY;
1491 sort = LS_SORT_BY_LAST_PLAYED;
1494 sort = LS_SORT_BY_NUM_PLAYED;
1497 sort = LS_SORT_BY_FREQUENCY;
1500 sort = LS_SORT_BY_CHANNELS;
1503 sort = LS_SORT_BY_IMAGE_ID;
1506 sort = LS_SORT_BY_LYRICS_ID;
1509 sort = LS_SORT_BY_BITRATE;
1512 sort = LS_SORT_BY_DURATION;
1515 sort = LS_SORT_BY_AUDIO_FORMAT;
1518 return -E_AFT_SYNTAX;
1521 return -E_AFT_SYNTAX;
1524 opts.sorting = sort;
1526 opts.num_patterns = cc->argc - i;
1527 ret = send_option_arg_callback_request(&query, opts.num_patterns,
1528 cc->argv + i, com_ls_callback, afs_cb_result_handler, cc);
1533 * Call the given function for each file in the audio file table.
1535 * \param private_data An arbitrary data pointer, passed to \a func.
1536 * \param func The custom function to be called.
1540 int audio_file_loop(void *private_data, osl_rbtree_loop_func *func)
1542 return osl(osl_rbtree_loop(audio_file_table, AFTCOL_HASH, private_data,
1546 static struct osl_row *find_hash_sister(unsigned char *hash)
1548 const struct osl_object obj = {.data = hash, .size = HASH_SIZE};
1549 struct osl_row *row;
1551 osl_get_row(audio_file_table, AFTCOL_HASH, &obj, &row);
1555 /** The format of the data stored by save_audio_file_data(). */
1556 enum com_add_buffer_offsets {
1557 /** afhi (if present) starts here. */
1558 CAB_AFHI_OFFSET_POS = 0,
1559 /** Start of the chunk table (if present). */
1560 CAB_CHUNKS_OFFSET_POS = 2,
1561 /** Audio format id. */
1562 CAB_AUDIO_FORMAT_OFFSET = 4,
1563 /** Flags given to the add command. */
1564 CAB_FLAGS_OFFSET = 5,
1565 /** The hash of the audio file being added. */
1566 CAB_HASH_OFFSET = 9,
1567 /** Start of the path of the audio file. */
1568 CAB_PATH_OFFSET = (CAB_HASH_OFFSET + HASH_SIZE),
1572 * Store the given data to a single buffer. Doesn't need the audio file selector
1573 * info struct as the server knows it as well.
1575 * It's OK to call this with afhi == NULL. In this case, the audio format
1576 * handler info won't be stored in the buffer.
1578 static void save_add_callback_buffer(unsigned char *hash, const char *path,
1579 struct afh_info *afhi, uint32_t flags,
1580 uint8_t audio_format_num, struct osl_object *obj)
1582 size_t path_len = strlen(path) + 1;
1583 size_t afhi_size = sizeof_afhi_buf(afhi);
1584 size_t size = CAB_PATH_OFFSET + path_len + afhi_size
1585 + sizeof_chunk_table(afhi);
1586 char *buf = para_malloc(size);
1589 write_u8(buf + CAB_AUDIO_FORMAT_OFFSET, audio_format_num);
1590 write_u32(buf + CAB_FLAGS_OFFSET, flags);
1592 memcpy(buf + CAB_HASH_OFFSET, hash, HASH_SIZE);
1593 strcpy(buf + CAB_PATH_OFFSET, path);
1595 pos = CAB_PATH_OFFSET + path_len;
1596 PARA_DEBUG_LOG("size: %zu, afhi starts at %d\n", size, pos);
1597 PARA_DEBUG_LOG("last afhi byte: %p, pos %zu\n", buf + pos + afhi_size - 1,
1598 pos + afhi_size - 1);
1599 write_u16(buf + CAB_AFHI_OFFSET_POS, pos);
1600 save_afhi(afhi, buf + pos);
1603 PARA_DEBUG_LOG("size: %zu, chunks start at %d\n", size, pos);
1604 write_u16(buf + CAB_CHUNKS_OFFSET_POS, pos);
1606 save_chunk_table(afhi, buf + pos);
1607 PARA_DEBUG_LOG("last byte in buf: %p\n", buf + size - 1);
1614 Overview of the add command.
1616 Input: What was passed to the callback by the command handler.
1618 HS: Hash sister. Whether an audio file with identical hash
1619 already exists in the osl database.
1621 PB: Path brother. Whether a file with the given path exists
1624 F: Force flag given. Whether add was called with -f.
1626 output: Action performed by the callback.
1628 AFHI: Whether afhi and chunk table are computed and sent.
1629 ACTION: Table modifications to be done by the callback.
1631 +----+----+---+------+---------------------------------------------------+
1632 | HS | PB | F | AFHI | ACTION
1633 +----+----+---+------+---------------------------------------------------+
1634 | Y | Y | Y | Y | if HS != PB: remove PB. HS: force afhi update,
1635 | | update path, keep afsi
1636 +----+----+---+------+---------------------------------------------------+
1637 | Y | Y | N | N | if HS == PB: do not send callback request at all.
1638 | | otherwise: remove PB, HS: update path, keep afhi,
1640 +----+----+---+------+---------------------------------------------------+
1641 | Y | N | Y | Y | (rename) force afhi update of HS, update path of
1643 +----+----+---+------+---------------------------------------------------+
1644 | Y | N | N | N | (file rename) update path of HS, keep afsi, afhi
1645 +----+----+---+------+---------------------------------------------------+
1646 | N | Y | Y | Y | (file change) update afhi, hash, of PB, keep afsi
1647 | | (force has no effect)
1648 +----+----+---+------+---------------------------------------------------+
1649 | N | Y | N | Y | (file change) update afhi, hash of PB, keep afsi
1650 +----+----+---+------+---------------------------------------------------+
1651 | N | N | Y | Y | (new file) create new entry (force has no effect)
1652 +----+----+---+------+---------------------------------------------------+
1653 | N | N | N | Y | (new file) create new entry
1654 +----+----+---+------+---------------------------------------------------+
1658 afhi <=> force or no HS
1663 /** Flags passed to the add command. */
1664 enum com_add_flags {
1665 /** Skip paths that exist already. */
1667 /** Force adding. */
1669 /** Print what is being done. */
1670 ADD_FLAG_VERBOSE = 4,
1671 /** Try to add files with unknown suffixes. */
1675 static void com_add_callback(int fd, const struct osl_object *query)
1677 char *buf = query->data, *path;
1678 struct osl_row *pb, *aft_row;
1680 struct osl_object objs[NUM_AFT_COLUMNS];
1681 unsigned char *hash;
1682 char asc[2 * HASH_SIZE + 1];
1684 char afsi_buf[AFSI_SIZE];
1685 uint32_t flags = read_u32(buf + CAB_FLAGS_OFFSET);
1686 struct afs_info default_afsi = {.last_played = 0};
1687 struct para_buffer msg = {
1688 .max_size = shm_get_shmmax(),
1689 .max_size_handler = afs_max_size_handler,
1690 .private_data = &(struct afs_max_size_handler_data) {
1695 uint16_t afhi_offset, chunks_offset;
1697 hash = (unsigned char *)buf + CAB_HASH_OFFSET;
1698 hash_to_asc(hash, asc);
1699 objs[AFTCOL_HASH].data = buf + CAB_HASH_OFFSET;
1700 objs[AFTCOL_HASH].size = HASH_SIZE;
1702 path = buf + CAB_PATH_OFFSET;
1703 objs[AFTCOL_PATH].data = path;
1704 objs[AFTCOL_PATH].size = strlen(path) + 1;
1706 PARA_INFO_LOG("request to add %s\n", path);
1707 hs = find_hash_sister(hash);
1708 ret = aft_get_row_of_path(path, &pb);
1709 if (ret < 0 && ret != -OSL_ERRNO_TO_PARA_ERROR(E_OSL_RB_KEY_NOT_FOUND))
1711 if (hs && pb && hs == pb && !(flags & ADD_FLAG_FORCE)) {
1712 if (flags & ADD_FLAG_VERBOSE)
1713 ret = para_printf(&msg, "ignoring duplicate\n");
1718 if (hs && hs != pb) {
1719 struct osl_object obj;
1720 if (pb) { /* hs trumps pb, remove pb */
1721 if (flags & ADD_FLAG_VERBOSE) {
1722 ret = para_printf(&msg, "removing path brother\n");
1726 ret = osl(osl_del_row(audio_file_table, pb));
1731 /* file rename, update hs' path */
1732 if (flags & ADD_FLAG_VERBOSE) {
1733 ret = osl(osl_get_object(audio_file_table, hs,
1734 AFTCOL_PATH, &obj));
1737 ret = para_printf(&msg, "renamed from %s\n", (char *)obj.data);
1741 ret = osl(osl_update_object(audio_file_table, hs, AFTCOL_PATH,
1742 &objs[AFTCOL_PATH]));
1745 afs_event(AUDIO_FILE_RENAME, &msg, hs);
1746 if (!(flags & ADD_FLAG_FORCE))
1749 /* no hs or force mode, child must have sent afhi */
1750 afhi_offset = read_u16(buf + CAB_AFHI_OFFSET_POS);
1751 chunks_offset = read_u16(buf + CAB_CHUNKS_OFFSET_POS);
1753 objs[AFTCOL_AFHI].data = buf + afhi_offset;
1754 objs[AFTCOL_AFHI].size = chunks_offset - afhi_offset;
1756 if (!objs[AFTCOL_AFHI].size) /* "impossible" */
1758 objs[AFTCOL_CHUNKS].data = buf + chunks_offset;
1759 objs[AFTCOL_CHUNKS].size = query->size - chunks_offset;
1760 if (pb && !hs) { /* update pb's hash */
1761 char old_asc[2 * HASH_SIZE + 1];
1762 unsigned char *old_hash;
1763 ret = get_hash_of_row(pb, &old_hash);
1766 hash_to_asc(old_hash, old_asc);
1767 if (flags & ADD_FLAG_VERBOSE) {
1768 ret = para_printf(&msg, "file change: %s -> %s\n",
1773 ret = osl_update_object(audio_file_table, pb, AFTCOL_HASH,
1774 &objs[AFTCOL_HASH]);
1778 if (hs || pb) { /* (hs != NULL and pb != NULL) implies hs == pb */
1779 struct osl_row *row = pb? pb : hs;
1780 /* update afhi and chunk_table */
1781 if (flags & ADD_FLAG_VERBOSE) {
1782 ret = para_printf(&msg, "updating afhi and chunk table\n");
1786 ret = osl(osl_update_object(audio_file_table, row, AFTCOL_AFHI,
1787 &objs[AFTCOL_AFHI]));
1790 ret = osl(osl_update_object(audio_file_table, row, AFTCOL_CHUNKS,
1791 &objs[AFTCOL_CHUNKS]));
1794 afs_event(AFHI_CHANGE, &msg, row);
1797 /* new entry, use default afsi */
1798 if (flags & ADD_FLAG_VERBOSE) {
1799 ret = para_printf(&msg, "new file\n");
1803 default_afsi.last_played = time(NULL) - 365 * 24 * 60 * 60;
1804 default_afsi.audio_format_id = read_u8(buf + CAB_AUDIO_FORMAT_OFFSET);
1806 objs[AFTCOL_AFSI].data = &afsi_buf;
1807 objs[AFTCOL_AFSI].size = AFSI_SIZE;
1808 save_afsi(&default_afsi, &objs[AFTCOL_AFSI]);
1809 ret = osl(osl_add_and_get_row(audio_file_table, objs, &aft_row));
1810 afs_event(AUDIO_FILE_ADD, &msg, aft_row);
1813 para_printf(&msg, "%s\n", para_strerror(-ret));
1815 pass_buffer_as_shm(fd, SBD_OUTPUT, msg.buf, msg.offset);
1819 /** Used by com_add(). */
1820 struct private_add_data {
1821 /** The pointer passed to the original command handler. */
1822 struct command_context *cc;
1823 /** The given add flags. */
1827 static void path_brother_callback(int fd, const struct osl_object *query)
1829 char *path = query->data;
1830 struct osl_row *path_brother;
1831 int ret = aft_get_row_of_path(path, &path_brother);
1834 pass_buffer_as_shm(fd, SBD_OUTPUT, (char *)&path_brother,
1835 sizeof(path_brother));
1838 static void hash_sister_callback(int fd, const struct osl_object *query)
1840 unsigned char *hash = query->data;
1841 struct osl_row *hash_sister;
1843 hash_sister = find_hash_sister(hash);
1846 pass_buffer_as_shm(fd, SBD_OUTPUT, (char *)&hash_sister,
1847 sizeof(hash_sister));
1850 static int get_row_pointer_from_result(struct osl_object *result,
1851 __a_unused uint8_t band, void *private)
1853 struct osl_row **row = private;
1854 *row = *(struct osl_row **)(result->data);
1858 static int add_one_audio_file(const char *path, void *private_data)
1860 int ret, send_ret = 1, fd;
1861 uint8_t format_num = -1;
1862 struct private_add_data *pad = private_data;
1863 struct afh_info afhi, *afhi_ptr = NULL;
1864 struct osl_row *pb = NULL, *hs = NULL; /* path brother/hash sister */
1865 struct osl_object map, obj = {.data = NULL}, query;
1866 unsigned char hash[HASH_SIZE];
1868 ret = guess_audio_format(path);
1869 if (ret < 0 && !(pad->flags & ADD_FLAG_ALL))
1871 query.data = (char *)path;
1872 query.size = strlen(path) + 1;
1873 ret = send_callback_request(path_brother_callback, &query,
1874 get_row_pointer_from_result, &pb);
1875 if (ret < 0 && ret != -OSL_ERRNO_TO_PARA_ERROR(E_OSL_RB_KEY_NOT_FOUND))
1878 if (pb && (pad->flags & ADD_FLAG_LAZY)) { /* lazy is really cheap */
1879 if (pad->flags & ADD_FLAG_VERBOSE)
1880 send_ret = send_sb_va(&pad->cc->scc, SBD_OUTPUT,
1881 "lazy-ignore: %s\n", path);
1884 /* We still want to add this file. Compute its hash. */
1885 ret = mmap_full_file(path, O_RDONLY, &map.data, &map.size, &fd);
1888 hash_function(map.data, map.size, hash);
1890 /* Check whether the database contains a file with the same hash. */
1892 query.size = HASH_SIZE;
1893 ret = send_callback_request(hash_sister_callback, &query,
1894 get_row_pointer_from_result, &hs);
1897 /* Return success if we already know this file. */
1899 if (pb && hs && hs == pb && !(pad->flags & ADD_FLAG_FORCE)) {
1900 if (pad->flags & ADD_FLAG_VERBOSE)
1901 send_ret = send_sb_va(&pad->cc->scc, SBD_OUTPUT,
1902 "%s exists, not forcing update\n", path);
1906 * We won't recalculate the audio format info and the chunk table if
1907 * there is a hash sister and FORCE was not given.
1909 if (!hs || (pad->flags & ADD_FLAG_FORCE)) {
1910 ret = compute_afhi(path, map.data, map.size, fd, &afhi);
1916 munmap(map.data, map.size);
1918 if (pad->flags & ADD_FLAG_VERBOSE) {
1919 send_ret = send_sb_va(&pad->cc->scc, SBD_OUTPUT,
1920 "adding %s\n", path);
1924 save_add_callback_buffer(hash, path, afhi_ptr, pad->flags, format_num, &obj);
1925 /* Ask afs to consider this entry for adding. */
1926 ret = send_callback_request(com_add_callback, &obj,
1927 afs_cb_result_handler, pad->cc);
1932 munmap(map.data, map.size);
1934 if (ret < 0 && send_ret >= 0)
1935 send_ret = send_sb_va(&pad->cc->scc, SBD_ERROR_LOG,
1936 "failed to add %s (%s)\n", path, para_strerror(-ret));
1938 clear_afhi(afhi_ptr);
1939 /* Stop adding files only on send errors. */
1943 int com_add(struct command_context *cc)
1946 struct private_add_data pad = {.cc = cc, .flags = 0};
1947 struct stat statbuf;
1949 for (i = 1; i < cc->argc; i++) {
1950 const char *arg = cc->argv[i];
1953 if (!strcmp(arg, "--")) {
1957 if (!strcmp(arg, "-a")) {
1958 pad.flags |= ADD_FLAG_ALL;
1961 if (!strcmp(arg, "-l")) {
1962 pad.flags |= ADD_FLAG_LAZY;
1965 if (!strcmp(arg, "-f")) {
1966 pad.flags |= ADD_FLAG_FORCE;
1969 if (!strcmp(arg, "-v")) {
1970 pad.flags |= ADD_FLAG_VERBOSE;
1975 return -E_AFT_SYNTAX;
1976 for (; i < cc->argc; i++) {
1978 ret = verify_path(cc->argv[i], &path);
1980 ret = send_sb_va(&cc->scc, SBD_ERROR_LOG, "%s: %s\n",
1981 cc->argv[i], para_strerror(-ret));
1986 ret = stat(path, &statbuf);
1988 ret = send_sb_va(&cc->scc, SBD_ERROR_LOG,
1989 "failed to stat %s (%s)\n", path,
1996 if (S_ISDIR(statbuf.st_mode))
1997 ret = for_each_file_in_dir(path, add_one_audio_file,
2000 ret = add_one_audio_file(path, &pad);
2002 send_sb_va(&cc->scc, SBD_OUTPUT, "%s: %s\n", path,
2003 para_strerror(-ret));
2014 * Flags used by the touch command.
2019 /** Whether the \p FNM_PATHNAME flag should be passed to fnmatch(). */
2020 TOUCH_FLAG_FNM_PATHNAME = 1,
2021 /** Activates verbose mode. */
2022 TOUCH_FLAG_VERBOSE = 2
2025 /** Options used by com_touch(). */
2026 struct com_touch_options {
2027 /** New num_played value. */
2029 /** New last played count. */
2030 int64_t last_played;
2031 /** New lyrics id. */
2033 /** New image id. */
2035 /** New amplification value. */
2037 /** Command line flags (see \ref touch_flags). */
2041 /** Data passed to the action handler of com_touch(). */
2042 struct touch_action_data {
2043 /** Command line options (see \ref com_touch_options). */
2044 struct com_touch_options *cto;
2045 /** Message buffer. */
2046 struct para_buffer pb;
2049 static int touch_audio_file(__a_unused struct osl_table *table,
2050 struct osl_row *row, const char *name, void *data)
2052 struct touch_action_data *tad = data;
2053 struct osl_object obj;
2054 struct afs_info old_afsi, new_afsi;
2055 int ret, no_options = tad->cto->num_played < 0 && tad->cto->last_played < 0 &&
2056 tad->cto->lyrics_id < 0 && tad->cto->image_id < 0 && tad->cto->amp < 0;
2057 struct afsi_change_event_data aced;
2059 ret = get_afsi_object_of_row(row, &obj);
2061 return para_printf(&tad->pb, "%s: %s\n", name, para_strerror(-ret));
2062 ret = load_afsi(&old_afsi, &obj);
2064 return para_printf(&tad->pb, "%s: %s\n", name, para_strerror(-ret));
2065 new_afsi = old_afsi;
2067 new_afsi.num_played++;
2068 new_afsi.last_played = time(NULL);
2069 if (tad->cto->flags & TOUCH_FLAG_VERBOSE) {
2070 ret = para_printf(&tad->pb, "%s: num_played = %u, "
2071 "last_played = now()\n", name,
2072 new_afsi.num_played);
2077 if (tad->cto->flags & TOUCH_FLAG_VERBOSE) {
2078 ret = para_printf(&tad->pb, "touching %s\n", name);
2082 if (tad->cto->lyrics_id >= 0)
2083 new_afsi.lyrics_id = tad->cto->lyrics_id;
2084 if (tad->cto->image_id >= 0)
2085 new_afsi.image_id = tad->cto->image_id;
2086 if (tad->cto->num_played >= 0)
2087 new_afsi.num_played = tad->cto->num_played;
2088 if (tad->cto->last_played >= 0)
2089 new_afsi.last_played = tad->cto->last_played;
2090 if (tad->cto->amp >= 0)
2091 new_afsi.amp = tad->cto->amp;
2093 save_afsi(&new_afsi, &obj); /* in-place update */
2095 aced.old_afsi = &old_afsi;
2096 afs_event(AFSI_CHANGE, &tad->pb, &aced);
2100 static void com_touch_callback(int fd, const struct osl_object *query)
2102 struct touch_action_data tad = {.cto = query->data,
2104 .max_size = shm_get_shmmax(),
2105 .private_data = &fd,
2106 .max_size_handler = afs_max_size_handler
2110 struct pattern_match_data pmd = {
2111 .table = audio_file_table,
2112 .loop_col_num = AFTCOL_HASH,
2113 .match_col_num = AFTCOL_PATH,
2114 .patterns = {.data = (char *)query->data + sizeof(*tad.cto),
2115 .size = query->size - sizeof(*tad.cto)},
2117 .action = touch_audio_file
2119 if (tad.cto->flags & TOUCH_FLAG_FNM_PATHNAME)
2120 pmd.fnmatch_flags |= FNM_PATHNAME;
2121 ret = for_each_matching_row(&pmd);
2123 ret2 = para_printf(&tad.pb, "%s\n", para_strerror(-ret));
2124 else if (pmd.num_matches == 0)
2125 ret2 = para_printf(&tad.pb, "no matches\n");
2126 if (ret2 >= 0 && tad.pb.offset)
2127 pass_buffer_as_shm(fd, SBD_OUTPUT, tad.pb.buf, tad.pb.offset);
2131 int com_touch(struct command_context *cc)
2133 struct com_touch_options cto = {
2140 struct osl_object query = {.data = &cto, .size = sizeof(cto)};
2144 for (i = 1; i < cc->argc; i++) {
2145 const char *arg = cc->argv[i];
2148 if (!strcmp(arg, "--")) {
2152 if (!strncmp(arg, "-n=", 3)) {
2153 ret = para_atoi32(arg + 3, &cto.num_played);
2158 if (!strncmp(arg, "-l=", 3)) {
2159 ret = para_atoi64(arg + 3, &cto.last_played);
2164 if (!strncmp(arg, "-y=", 3)) {
2165 ret = para_atoi32(arg + 3, &cto.lyrics_id);
2170 if (!strncmp(arg, "-i=", 3)) {
2171 ret = para_atoi32(arg + 3, &cto.image_id);
2176 if (!strncmp(arg, "-a=", 3)) {
2178 ret = para_atoi32(arg + 3, &val);
2181 if (val < 0 || val > 255)
2182 return -ERRNO_TO_PARA_ERROR(EINVAL);
2186 if (!strcmp(arg, "-p")) {
2187 cto.flags |= TOUCH_FLAG_FNM_PATHNAME;
2190 if (!strcmp(arg, "-v")) {
2191 cto.flags |= TOUCH_FLAG_VERBOSE;
2194 break; /* non-option starting with dash */
2197 return -E_AFT_SYNTAX;
2198 ret = send_option_arg_callback_request(&query, cc->argc - i,
2199 cc->argv + i, com_touch_callback, afs_cb_result_handler, cc);
2201 send_strerror(cc, -ret);
2205 /** Flags for com_rm(). */
2208 RM_FLAG_VERBOSE = 1,
2212 RM_FLAG_FNM_PATHNAME = 4
2215 /** Data passed to the action handler of com_rm(). */
2216 struct com_rm_action_data {
2217 /** Command line flags ((see \ref rm_flags). */
2219 /** Message buffer. */
2220 struct para_buffer pb;
2223 static int remove_audio_file(__a_unused struct osl_table *table,
2224 struct osl_row *row, const char *name, void *data)
2226 struct com_rm_action_data *crd = data;
2229 if (crd->flags & RM_FLAG_VERBOSE) {
2230 ret = para_printf(&crd->pb, "removing %s\n", name);
2234 afs_event(AUDIO_FILE_REMOVE, &crd->pb, row);
2235 ret = osl(osl_del_row(audio_file_table, row));
2237 para_printf(&crd->pb, "%s: %s\n", name, para_strerror(-ret));
2241 static void com_rm_callback(int fd, const struct osl_object *query)
2243 struct com_rm_action_data crd = {.flags = *(uint32_t *)query->data,
2245 .max_size = shm_get_shmmax(),
2246 .private_data = &fd,
2247 .max_size_handler = afs_max_size_handler
2251 struct pattern_match_data pmd = {
2252 .table = audio_file_table,
2253 .loop_col_num = AFTCOL_HASH,
2254 .match_col_num = AFTCOL_PATH,
2255 .patterns = {.data = (char *)query->data + sizeof(uint32_t),
2256 .size = query->size - sizeof(uint32_t)},
2258 .action = remove_audio_file
2260 if (crd.flags & RM_FLAG_FNM_PATHNAME)
2261 pmd.fnmatch_flags |= FNM_PATHNAME;
2262 ret = for_each_matching_row(&pmd);
2264 para_printf(&crd.pb, "%s\n", para_strerror(-ret));
2267 if ((pmd.num_matches == 0) && !(crd.flags & RM_FLAG_FORCE))
2268 ret = para_printf(&crd.pb, "no matches -- nothing removed\n");
2269 else if (crd.flags & RM_FLAG_VERBOSE) {
2270 ret = para_printf(&crd.pb, "removed %u files\n",
2273 if (ret >= 0 && crd.pb.offset)
2274 pass_buffer_as_shm(fd, SBD_OUTPUT, crd.pb.buf, crd.pb.offset);
2278 /* TODO options: -r (recursive) */
2279 int com_rm(struct command_context *cc)
2282 struct osl_object query = {.data = &flags, .size = sizeof(flags)};
2285 for (i = 1; i < cc->argc; i++) {
2286 const char *arg = cc->argv[i];
2289 if (!strcmp(arg, "--")) {
2293 if (!strcmp(arg, "-f")) {
2294 flags |= RM_FLAG_FORCE;
2297 if (!strcmp(arg, "-p")) {
2298 flags |= RM_FLAG_FNM_PATHNAME;
2301 if (!strcmp(arg, "-v")) {
2302 flags |= RM_FLAG_VERBOSE;
2308 return -E_AFT_SYNTAX;
2309 ret = send_option_arg_callback_request(&query, cc->argc - i,
2310 cc->argv + i, com_rm_callback, afs_cb_result_handler, cc);
2312 send_strerror(cc, -ret);
2317 * Flags used by the cpsi command.
2322 /** Whether the lyrics id should be copied. */
2323 CPSI_FLAG_COPY_LYRICS_ID = 1,
2324 /** Whether the image id should be copied. */
2325 CPSI_FLAG_COPY_IMAGE_ID = 2,
2326 /** Whether the lastplayed time should be copied. */
2327 CPSI_FLAG_COPY_LASTPLAYED = 4,
2328 /** Whether the numplayed count should be copied. */
2329 CPSI_FLAG_COPY_NUMPLAYED = 8,
2330 /** Whether the attributes should be copied. */
2331 CPSI_FLAG_COPY_ATTRIBUTES = 16,
2332 /** Activates verbose mode. */
2333 CPSI_FLAG_VERBOSE = 32,
2336 /** Data passed to the action handler of com_cpsi(). */
2337 struct cpsi_action_data {
2338 /** command line flags (see \ref cpsi_flags). */
2340 /** Message buffer. */
2341 struct para_buffer pb;
2342 /** Values are copied from here. */
2343 struct afs_info source_afsi;
2346 static int copy_selector_info(__a_unused struct osl_table *table,
2347 struct osl_row *row, const char *name, void *data)
2349 struct cpsi_action_data *cad = data;
2350 struct osl_object target_afsi_obj;
2352 struct afs_info old_afsi, target_afsi;
2353 struct afsi_change_event_data aced;
2355 ret = get_afsi_object_of_row(row, &target_afsi_obj);
2358 load_afsi(&target_afsi, &target_afsi_obj);
2359 old_afsi = target_afsi;
2360 if (cad->flags & CPSI_FLAG_COPY_LYRICS_ID)
2361 target_afsi.lyrics_id = cad->source_afsi.lyrics_id;
2362 if (cad->flags & CPSI_FLAG_COPY_IMAGE_ID)
2363 target_afsi.image_id = cad->source_afsi.image_id;
2364 if (cad->flags & CPSI_FLAG_COPY_LASTPLAYED)
2365 target_afsi.last_played = cad->source_afsi.last_played;
2366 if (cad->flags & CPSI_FLAG_COPY_NUMPLAYED)
2367 target_afsi.num_played = cad->source_afsi.num_played;
2368 if (cad->flags & CPSI_FLAG_COPY_ATTRIBUTES)
2369 target_afsi.attributes = cad->source_afsi.attributes;
2370 save_afsi(&target_afsi, &target_afsi_obj); /* in-place update */
2371 if (cad->flags & CPSI_FLAG_VERBOSE) {
2372 ret = para_printf(&cad->pb, "copied afsi to %s\n", name);
2377 aced.old_afsi = &old_afsi;
2378 afs_event(AFSI_CHANGE, &cad->pb, &aced);
2382 static void com_cpsi_callback(int fd, const struct osl_object *query)
2384 struct cpsi_action_data cad = {
2385 .flags = *(unsigned *)query->data,
2387 .max_size = shm_get_shmmax(),
2388 .private_data = &fd,
2389 .max_size_handler = afs_max_size_handler
2393 char *source_path = (char *)query->data + sizeof(cad.flags);
2394 struct pattern_match_data pmd = {
2395 .table = audio_file_table,
2396 .loop_col_num = AFTCOL_HASH,
2397 .match_col_num = AFTCOL_PATH,
2398 .patterns = {.data = source_path + strlen(source_path) + 1,
2399 .size = query->size - sizeof(cad.flags)
2400 - strlen(source_path) - 1},
2402 .action = copy_selector_info
2405 ret = get_afsi_of_path(source_path, &cad.source_afsi);
2408 ret = for_each_matching_row(&pmd);
2411 para_printf(&cad.pb, "%s\n", para_strerror(-ret));
2412 else if (cad.flags & CPSI_FLAG_VERBOSE) {
2413 if (pmd.num_matches > 0)
2414 para_printf(&cad.pb, "copied requested afsi from %s "
2415 "to %u files\n", source_path, pmd.num_matches);
2417 para_printf(&cad.pb, "nothing copied\n");
2420 pass_buffer_as_shm(fd, SBD_OUTPUT, cad.pb.buf, cad.pb.offset);
2424 int com_cpsi(struct command_context *cc)
2428 struct osl_object options = {.data = &flags, .size = sizeof(flags)};
2430 for (i = 1; i < cc->argc; i++) {
2431 const char *arg = cc->argv[i];
2434 if (!strcmp(arg, "--")) {
2438 if (!strcmp(arg, "-y")) {
2439 flags |= CPSI_FLAG_COPY_LYRICS_ID;
2442 if (!strcmp(arg, "-i")) {
2443 flags |= CPSI_FLAG_COPY_IMAGE_ID;
2446 if (!strcmp(arg, "-l")) {
2447 flags |= CPSI_FLAG_COPY_LASTPLAYED;
2450 if (!strcmp(arg, "-n")) {
2451 flags |= CPSI_FLAG_COPY_NUMPLAYED;
2454 if (!strcmp(arg, "-a")) {
2455 flags |= CPSI_FLAG_COPY_ATTRIBUTES;
2458 if (!strcmp(arg, "-v")) {
2459 flags |= CPSI_FLAG_VERBOSE;
2464 if (i + 1 >= cc->argc) /* need at least source file and pattern */
2465 return -E_AFT_SYNTAX;
2466 if (!(flags & ~CPSI_FLAG_VERBOSE)) /* no copy flags given */
2467 flags = ~(unsigned)CPSI_FLAG_VERBOSE | flags;
2468 ret = send_option_arg_callback_request(&options, cc->argc - i,
2469 cc->argv + i, com_cpsi_callback, afs_cb_result_handler, cc);
2471 send_strerror(cc, -ret);
2475 struct change_atts_data {
2476 uint64_t add_mask, del_mask;
2477 struct para_buffer pb;
2480 static int change_atts(__a_unused struct osl_table *table,
2481 struct osl_row *row, __a_unused const char *name, void *data)
2484 struct osl_object obj;
2485 struct afs_info old_afsi, new_afsi;
2486 struct afsi_change_event_data aced = {
2488 .old_afsi = &old_afsi
2490 struct change_atts_data *cad = data;
2492 ret = get_afsi_object_of_row(row, &obj);
2495 ret = load_afsi(&old_afsi, &obj);
2498 new_afsi = old_afsi;
2499 new_afsi.attributes |= cad->add_mask;
2500 new_afsi.attributes &= ~cad->del_mask;
2501 save_afsi(&new_afsi, &obj); /* in-place update */
2502 afs_event(AFSI_CHANGE, &cad->pb, &aced);
2506 static void com_setatt_callback(int fd, const struct osl_object *query)
2511 struct change_atts_data cad = {
2513 .max_size = shm_get_shmmax(),
2514 .max_size_handler = afs_max_size_handler,
2515 .private_data = &(struct afs_max_size_handler_data) {
2521 struct pattern_match_data pmd = {
2522 .table = audio_file_table,
2523 .loop_col_num = AFTCOL_HASH,
2524 .match_col_num = AFTCOL_PATH,
2525 .pm_flags = PM_SKIP_EMPTY_NAME,
2527 .action = change_atts
2530 for (p = query->data; p < (char *)query->data + query->size; p += len + 1) {
2532 unsigned char bitnum;
2535 ret = -E_ATTR_SYNTAX;
2539 if (c != '+' && c != '-')
2542 ret = get_attribute_bitnum_by_name(p, &bitnum);
2546 cad.add_mask |= (1UL << bitnum);
2548 cad.del_mask |= (1UL << bitnum);
2550 ret = -E_ATTR_SYNTAX;
2551 if (!cad.add_mask && !cad.del_mask)
2553 pmd.patterns.data = p;
2554 assert(p < (char *)query->data + query->size);
2555 pmd.patterns.size = (char *)query->data + query->size - p;
2556 ret = for_each_matching_row(&pmd);
2559 if (pmd.num_matches == 0)
2560 para_printf(&cad.pb, "no matches\n");
2563 para_printf(&cad.pb, "%s\n", para_strerror(-ret));
2565 pass_buffer_as_shm(fd, SBD_OUTPUT, cad.pb.buf, cad.pb.offset);
2569 int com_setatt(struct command_context *cc)
2572 return -E_ATTR_SYNTAX;
2573 return send_standard_callback_request(cc->argc - 1, cc->argv + 1,
2574 com_setatt_callback, afs_cb_result_handler, cc);
2577 static void afs_stat_callback(int fd, const struct osl_object *query)
2579 int *parser_friendly = query->data;
2580 char *buf = *parser_friendly?
2581 parser_friendly_status_items : status_items;
2585 pass_buffer_as_shm(fd, SBD_OUTPUT, buf, strlen(buf));
2589 * Get the current afs status items from the afs process and send it.
2591 * \param cc The command context, used e.g. for data encryption.
2592 * \param parser_friendly Whether parser-friendly output format should be used.
2594 * As the contents of the afs status items change in time and the command
2595 * handler only has a COW version created at fork time, it can not send
2596 * up-to-date afs status items directly. Therefore the usual callback mechanism
2597 * is used to pass the status items from the afs process to the command handler
2598 * via a shared memory area and a pipe.
2600 * \return The return value of the underyling call to \ref send_callback_request().
2602 int send_afs_status(struct command_context *cc, int parser_friendly)
2604 struct osl_object query = {.data = &parser_friendly,
2605 .size = sizeof(parser_friendly)};
2607 return send_callback_request(afs_stat_callback, &query,
2608 afs_cb_result_handler, cc);
2611 /* TODO: optionally fix problems by removing offending rows */
2612 static int check_audio_file(struct osl_row *row, void *data)
2615 struct para_buffer *pb = data;
2616 struct stat statbuf;
2617 int ret = get_audio_file_path_of_row(row, &path);
2618 struct afs_info afsi;
2622 return para_printf(pb, "%s\n", para_strerror(-ret));
2623 if (stat(path, &statbuf) < 0) {
2624 ret = para_printf(pb, "%s: stat error (%s)\n", path, strerror(errno));
2628 if (!S_ISREG(statbuf.st_mode)) {
2629 ret = para_printf(pb, "%s: not a regular file\n", path);
2634 ret = get_afsi_of_row(row, &afsi);
2636 return para_printf(pb, "%s: %s\n", path, para_strerror(-ret));
2637 ret = lyr_get_name_by_id(afsi.lyrics_id, &blob_name);
2639 ret = para_printf(pb, "%s lyrics id %u: %s\n", path, afsi.lyrics_id,
2640 para_strerror(-ret));
2644 ret = img_get_name_by_id(afsi.image_id, &blob_name);
2646 ret = para_printf(pb, "%s image id %u: %s\n", path, afsi.image_id,
2647 para_strerror(-ret));
2652 * Check the audio file table for inconsistencies.
2654 * \param fd The afs socket.
2655 * \param query Unused.
2657 * This function always succeeds.
2661 void aft_check_callback(int fd, __a_unused const struct osl_object *query)
2663 struct para_buffer pb = {
2664 .max_size = shm_get_shmmax(),
2665 .private_data = &(struct afs_max_size_handler_data) {
2669 .max_size_handler = afs_max_size_handler
2671 int ret = para_printf(&pb, "checking audio file table...\n");
2675 audio_file_loop(&pb, check_audio_file);
2677 pass_buffer_as_shm(fd, SBD_OUTPUT, pb.buf, pb.offset);
2682 * Close the audio file table.
2684 * \param flags Usual flags that are passed to osl_close_table().
2686 * \sa osl_close_table().
2688 static void aft_close(void)
2690 osl_close_table(audio_file_table, OSL_MARK_CLEAN);
2691 audio_file_table = NULL;
2695 * Open the audio file table.
2697 * \param dir The database directory.
2701 * \sa osl_open_table().
2703 static int aft_open(const char *dir)
2707 audio_file_table_desc.dir = dir;
2708 ret = osl(osl_open_table(&audio_file_table_desc, &audio_file_table));
2711 osl_get_num_rows(audio_file_table, &num);
2712 PARA_INFO_LOG("audio file table contains %d files\n", num);
2715 PARA_INFO_LOG("failed to open audio file table\n");
2716 audio_file_table = NULL;
2717 if (ret >= 0 || ret == -OSL_ERRNO_TO_PARA_ERROR(E_OSL_NOENT))
2722 static int aft_create(const char *dir)
2724 audio_file_table_desc.dir = dir;
2725 return osl(osl_create_table(&audio_file_table_desc));
2728 static int clear_attribute(struct osl_row *row, void *data)
2730 struct rmatt_event_data *red = data;
2731 struct afs_info afsi;
2732 struct osl_object obj;
2733 int ret = get_afsi_object_of_row(row, &obj);
2734 uint64_t mask = ~(1ULL << red->bitnum);
2738 ret = load_afsi(&afsi, &obj);
2741 afsi.attributes &= mask;
2742 save_afsi(&afsi, &obj);
2746 static int aft_event_handler(enum afs_events event, struct para_buffer *pb,
2752 case ATTRIBUTE_REMOVE: {
2753 const struct rmatt_event_data *red = data;
2754 ret = para_printf(pb, "clearing attribute %s (bit %u) from all "
2755 "entries in the audio file table\n", red->name,
2759 return audio_file_loop(data, clear_attribute);
2767 * Initialize the audio file table.
2769 * \param t Pointer to the structure to be initialized.
2771 void aft_init(struct afs_table *t)
2774 t->close = aft_close;
2775 t->create = aft_create;
2776 t->event_handler = aft_event_handler;