2 * Copyright (C) 2007-2012 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 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.
195 * \return Positive on success, negative on errors. Possible errors: \p E_BAD_AFS.
199 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 osl object holding the audio file selector info of a row.
499 * \param row Pointer to a row in the audio file table.
500 * \param obj Result pointer.
504 int get_afsi_object_of_row(const struct osl_row *row, struct osl_object *obj)
506 return osl(osl_get_object(audio_file_table, row, AFTCOL_AFSI, obj));
510 * Get the osl object holding the audio file selector info, given a path.
513 * \param path The full path of the audio file.
514 * \param obj Result pointer.
516 * \return Positive on success, negative on errors.
518 static int get_afsi_object_of_path(const char *path, struct osl_object *obj)
521 int ret = aft_get_row_of_path(path, &row);
524 return get_afsi_object_of_row(row, obj);
528 * Get the audio file selector info, given a row of the audio file table.
530 * \param row Pointer to a row in the audio file table.
531 * \param afsi Result pointer.
533 * \return Positive on success, negative on errors.
535 int get_afsi_of_row(const struct osl_row *row, struct afs_info *afsi)
537 struct osl_object obj;
538 int ret = get_afsi_object_of_row(row, &obj);
541 return load_afsi(afsi, &obj);
545 * Get the audio file selector info, given the path of an audio table.
547 * \param path The full path of the audio file.
548 * \param afsi Result pointer.
550 * \return Positive on success, negative on errors.
552 int get_afsi_of_path(const char *path, struct afs_info *afsi)
554 struct osl_object obj;
555 int ret = get_afsi_object_of_path(path, &obj);
558 return load_afsi(afsi, &obj);
562 * Get the path of an audio file, given a row of the audio file table.
564 * \param row Pointer to a row in the audio file table.
565 * \param path Result pointer.
567 * The result is a pointer to mmapped data. The caller must not attempt
572 int get_audio_file_path_of_row(const struct osl_row *row, char **path)
574 struct osl_object path_obj;
575 int ret = osl(osl_get_object(audio_file_table, row, AFTCOL_PATH,
579 *path = path_obj.data;
584 * Get the object containing the hash value of an audio file, given a row.
586 * \param row Pointer to a row of the audio file table.
587 * \param obj Result pointer.
589 * \return The return value of the underlying call to osl_get_object().
591 * \sa get_hash_of_row().
593 static int get_hash_object_of_aft_row(const struct osl_row *row,
594 struct osl_object *obj)
596 return osl(osl_get_object(audio_file_table, row, AFTCOL_HASH, obj));
600 * Get the hash value of an audio file, given a row of the audio file table.
602 * \param row Pointer to a row of the audio file table.
603 * \param hash Result pointer.
605 * \a hash points to mapped data and must not be freed by the caller.
607 * \return The return value of the underlying call to
608 * get_hash_object_of_aft_row().
610 static int get_hash_of_row(const struct osl_row *row, unsigned char **hash)
612 struct osl_object obj;
613 int ret = get_hash_object_of_aft_row(row, &obj);
622 * Get the audio format handler info, given a row of the audio file table.
624 * \param row Pointer to a row of the audio file table.
625 * \param afhi Result pointer.
627 * \return The return value of the underlying call to osl_get_object().
629 * \sa get_chunk_table_of_row().
631 int get_afhi_of_row(const struct osl_row *row, struct afh_info *afhi)
633 struct osl_object obj;
634 int ret = osl(osl_get_object(audio_file_table, row, AFTCOL_AFHI,
638 load_afhi(obj.data, afhi);
642 /* returns shmid on success */
643 static int save_afd(struct audio_file_data *afd)
645 size_t size = sizeof(*afd) + sizeof_chunk_table(&afd->afhi);
646 int shmid, ret = shm_new(size);
653 ret = shm_attach(shmid, ATTACH_RW, &shm_afd);
658 afd->max_chunk_size = save_chunk_table(&afd->afhi, buf);
659 *(struct audio_file_data *)shm_afd = *afd;
668 * Extract a afd stored in a shared memory area.
670 * Attach the shared memory area given by \a shmid, load the audio file data
671 * stored therein and detach the area afterwards. Called by vss, after
672 * receiving a positive response to the request for the next audio file.
674 * \param shmid The identifier of the shared memory area containing the afd.
675 * \param afd Result pointer.
679 int load_afd(int shmid, struct audio_file_data *afd)
685 ret = shm_attach(shmid, ATTACH_RO, &shm_afd);
688 *afd = *(struct audio_file_data *)shm_afd;
691 load_chunk_table(&afd->afhi, buf);
696 static int get_local_time(uint64_t *seconds, char *buf, size_t size,
697 time_t current_time, enum ls_listing_mode lm)
701 if (!localtime_r((time_t *)seconds, &t))
703 if (lm == LS_MODE_MBOX) {
704 if (!strftime(buf, size, "%c", &t))
708 if (*seconds + 6 * 30 * 24 * 3600 > current_time) {
709 if (!strftime(buf, size, "%b %e %k:%M", &t))
713 if (!strftime(buf, size, "%b %e %Y", &t))
718 /** Compute the number of (decimal) digits of a number. */
719 #define GET_NUM_DIGITS(x, num) { \
720 typeof((x)) _tmp = PARA_ABS(x); \
723 while ((_tmp) > 9) { \
729 __a_const static short unsigned get_duration_width(int seconds)
731 short unsigned width;
732 unsigned hours = seconds / 3600, mins = (seconds % 3600) / 60;
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);
741 static void get_duration_buf(int seconds, char *buf, struct ls_options *opts)
743 unsigned hours = seconds / 3600, mins = (seconds % 3600) / 60;
744 short unsigned max_width;
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:%02u", 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:%02u", max_width - 6, hours, mins,
759 static int write_attribute_items(struct para_buffer *b,
760 const char *att_bitmap, struct afs_info *afsi)
765 ret = WRITE_STATUS_ITEM(b, SI_ATTRIBUTES_BITMAP, "%s\n", att_bitmap);
768 ret = get_attribute_text(&afsi->attributes, " ", &att_text);
771 ret = WRITE_STATUS_ITEM(b, SI_ATTRIBUTES_TXT, "%s\n", att_text);
776 static int write_lyrics_items(struct para_buffer *b, struct afs_info *afsi)
781 ret = WRITE_STATUS_ITEM(b, SI_LYRICS_ID, "%u\n", afsi->lyrics_id);
784 lyr_get_name_by_id(afsi->lyrics_id, &lyrics_name);
785 return WRITE_STATUS_ITEM(b, SI_LYRICS_NAME, "%s\n", lyrics_name?
786 lyrics_name : "(none)");
789 static int write_image_items(struct para_buffer *b, struct afs_info *afsi)
794 ret = WRITE_STATUS_ITEM(b, SI_IMAGE_ID, "%u\n", afsi->image_id);
797 img_get_name_by_id(afsi->image_id, &image_name);
798 return WRITE_STATUS_ITEM(b, SI_IMAGE_NAME, "%s\n", image_name?
799 image_name : "(none)");
802 static int write_filename_items(struct para_buffer *b, const char *path,
808 if (!(flags & LS_FLAG_FULL_PATH))
809 return WRITE_STATUS_ITEM(b, SI_BASENAME, "%s\n", path);
810 ret = WRITE_STATUS_ITEM(b, SI_PATH, "%s\n", path);
813 val = para_basename(path);
814 ret = WRITE_STATUS_ITEM(b, SI_BASENAME, "%s\n", val? val : "");
817 val = para_dirname(path);
818 ret = WRITE_STATUS_ITEM(b, SI_DIRECTORY, "%s\n", val? val : "");
823 static int print_chunk_table(struct ls_data *d, struct para_buffer *b)
825 struct osl_object chunk_table_obj;
826 struct osl_row *aft_row;
830 ret = aft_get_row_of_hash(d->hash, &aft_row);
833 ret = osl_open_disk_object(audio_file_table, aft_row,
834 AFTCOL_CHUNKS, &chunk_table_obj);
837 ret = para_printf(b, "%s\n"
838 "chunk_time: %lu:%lu\nchunk_offsets: ",
840 (long unsigned) d->afhi.chunk_tv.tv_sec,
841 (long unsigned) d->afhi.chunk_tv.tv_usec
845 buf = chunk_table_obj.data;
846 for (i = 0; i <= d->afhi.chunks_total; i++) {
847 ret = para_printf(b, "%u ", (unsigned) read_u32(buf + 4 * i));
851 ret = para_printf(b, "\n");
853 osl_close_disk_object(&chunk_table_obj);
857 static int write_score(struct para_buffer *b, struct ls_data *d,
858 struct ls_options *opts)
860 if (!(opts->flags & LS_FLAG_ADMISSIBLE_ONLY)) /* no score*/
862 return WRITE_STATUS_ITEM(b, SI_SCORE, "%li\n", d->score);
865 static int print_list_item(struct ls_data *d, struct ls_options *opts,
866 struct para_buffer *b, time_t current_time)
870 char last_played_time[30];
871 char duration_buf[30]; /* nobody has an audio file long enough to overflow this */
872 struct afs_info *afsi = &d->afsi;
873 struct afh_info *afhi = &d->afhi;
874 char asc_hash[2 * HASH_SIZE + 1];
876 if (opts->mode == LS_MODE_SHORT) {
877 ret = para_printf(b, "%s\n", d->path);
880 if (opts->mode == LS_MODE_CHUNKS) {
881 ret = print_chunk_table(d, b);
884 get_attribute_bitmap(&afsi->attributes, att_buf);
885 if (opts->flags & LS_FLAG_UNIXDATE)
886 sprintf(last_played_time, "%llu",
887 (long long unsigned)afsi->last_played);
889 ret = get_local_time(&afsi->last_played, last_played_time,
890 sizeof(last_played_time), current_time, opts->mode);
894 get_duration_buf(afhi->seconds_total, duration_buf, opts);
895 if (opts->mode == LS_MODE_LONG) {
896 struct ls_widths *w = &opts->widths;
897 if (opts->flags & LS_FLAG_ADMISSIBLE_ONLY) {
898 ret = para_printf(b, "%*li ",
899 opts->widths.score_width, d->score);
904 "%s " /* attributes */
906 "%*d " /* image_id */
907 "%*d " /* lyrics_id */
909 "%*s " /* audio format */
910 "%*d " /* frequency */
913 "%*d " /* num_played */
914 "%s " /* last_played */
917 w->amp_width, afsi->amp,
918 w->image_id_width, afsi->image_id,
919 w->lyrics_id_width, afsi->lyrics_id,
920 w->bitrate_width, afhi->bitrate,
921 w->audio_format_width,
922 audio_format_name(afsi->audio_format_id),
923 w->frequency_width, afhi->frequency,
926 w->num_played_width, afsi->num_played,
932 if (opts->mode == LS_MODE_MBOX) {
933 const char *bn = para_basename(d->path);
935 "From foo@localhost %s\n"
936 "Received: from\nTo: bar\nFrom: a\n"
943 ret = write_filename_items(b, d->path, opts->flags);
946 ret = write_score(b, d, opts);
949 ret = write_attribute_items(b, att_buf, afsi);
952 ret = write_image_items(b, afsi);
955 ret = write_lyrics_items(b, afsi);
958 hash_to_asc(d->hash, asc_hash);
959 ret = WRITE_STATUS_ITEM(b, SI_HASH, "%s\n", asc_hash);
962 ret = WRITE_STATUS_ITEM(b, SI_BITRATE, "%dkbit/s\n", afhi->bitrate);
965 ret = WRITE_STATUS_ITEM(b, SI_FORMAT, "%s\n",
966 audio_format_name(afsi->audio_format_id));
969 ret = WRITE_STATUS_ITEM(b, SI_FREQUENCY, "%dHz\n", afhi->frequency);
972 ret = WRITE_STATUS_ITEM(b, SI_CHANNELS, "%d\n", afhi->channels);
975 ret = WRITE_STATUS_ITEM(b, SI_DURATION, "%s\n", duration_buf);
978 ret = WRITE_STATUS_ITEM(b, SI_SECONDS_TOTAL, "%lu\n",
979 afhi->seconds_total);
982 ret = WRITE_STATUS_ITEM(b, SI_LAST_PLAYED, "%s\n", last_played_time);
985 ret = WRITE_STATUS_ITEM(b, SI_NUM_PLAYED, "%d\n", afsi->num_played);
988 ret = WRITE_STATUS_ITEM(b, SI_AMPLIFICATION, "%u\n", afsi->amp);
991 ret = WRITE_STATUS_ITEM(b, SI_CHUNK_TIME, "%lu\n",
992 tv2ms(&afhi->chunk_tv));
995 ret = WRITE_STATUS_ITEM(b, SI_NUM_CHUNKS, "%lu\n",
999 ret = WRITE_STATUS_ITEM(b, SI_TECHINFO, "%s\n", afhi->techinfo);
1002 ret = WRITE_STATUS_ITEM(b, SI_ARTIST, "%s\n", afhi->tags.artist);
1005 ret = WRITE_STATUS_ITEM(b, SI_TITLE, "%s\n", afhi->tags.title);
1008 ret = WRITE_STATUS_ITEM(b, SI_YEAR, "%s\n", afhi->tags.year);
1011 ret = WRITE_STATUS_ITEM(b, SI_ALBUM, "%s\n", afhi->tags.album);
1014 ret = WRITE_STATUS_ITEM(b, SI_COMMENT, "%s\n", afhi->tags.comment);
1017 if (opts->mode == LS_MODE_MBOX) {
1018 struct osl_object lyrics_def;
1019 lyr_get_def_by_id(afsi->lyrics_id, &lyrics_def);
1020 if (lyrics_def.data) {
1021 ret = para_printf(b, "Lyrics:\n~~~~~~~\n%s",
1022 (char *)lyrics_def.data);
1023 osl_close_disk_object(&lyrics_def);
1030 static int make_status_items(struct audio_file_data *afd,
1031 struct afs_info *afsi, char *path, long score,
1032 unsigned char *hash)
1034 struct ls_data d = {
1041 struct ls_options opts = {
1042 .flags = LS_FLAG_FULL_PATH | LS_FLAG_ADMISSIBLE_ONLY,
1043 .mode = LS_MODE_VERBOSE,
1045 struct para_buffer pb = {.max_size = shm_get_shmmax() - 1};
1046 time_t current_time;
1049 time(¤t_time);
1050 ret = print_list_item(&d, &opts, &pb, current_time);
1054 status_items = pb.buf;
1055 memset(&pb, 0, sizeof(pb));
1056 pb.max_size = shm_get_shmmax() - 1;
1057 pb.flags = PBF_SIZE_PREFIX;
1058 ret = print_list_item(&d, &opts, &pb, current_time);
1061 status_items = NULL;
1064 free(parser_friendly_status_items);
1065 parser_friendly_status_items = pb.buf;
1070 * Mmap the given audio file and update statistics.
1072 * \param aft_row Determines the audio file to be opened and updated.
1073 * \param score The score of the audio file.
1074 * \param afd Result pointer.
1076 * On success, the numplayed field of the audio file selector info is increased
1077 * and the lastplayed time is set to the current time. Finally, the score of
1078 * the audio file is updated.
1080 * \return Positive shmid on success, negative on errors.
1082 int open_and_update_audio_file(struct osl_row *aft_row, long score,
1083 struct audio_file_data *afd)
1085 unsigned char *aft_hash, file_hash[HASH_SIZE];
1086 struct osl_object afsi_obj;
1087 struct afs_info old_afsi, new_afsi;
1088 int ret = get_hash_of_row(aft_row, &aft_hash);
1089 struct afsi_change_event_data aced;
1090 struct osl_object map, chunk_table_obj;
1095 ret = get_audio_file_path_of_row(aft_row, &path);
1098 PARA_NOTICE_LOG("%s\n", path);
1099 ret = get_afsi_object_of_row(aft_row, &afsi_obj);
1102 ret = load_afsi(&old_afsi, &afsi_obj);
1105 ret = get_afhi_of_row(aft_row, &afd->afhi);
1108 afd->afhi.chunk_table = NULL;
1109 ret = osl_open_disk_object(audio_file_table, aft_row,
1110 AFTCOL_CHUNKS, &chunk_table_obj);
1113 ret = mmap_full_file(path, O_RDONLY, &map.data,
1114 &map.size, &afd->fd);
1117 hash_function(map.data, map.size, file_hash);
1118 ret = hash_compare(file_hash, aft_hash);
1119 para_munmap(map.data, map.size);
1121 ret = -E_HASH_MISMATCH;
1124 new_afsi = old_afsi;
1125 new_afsi.num_played++;
1126 new_afsi.last_played = time(NULL);
1127 save_afsi(&new_afsi, &afsi_obj); /* in-place update */
1129 afd->audio_format_id = old_afsi.audio_format_id;
1130 load_chunk_table(&afd->afhi, chunk_table_obj.data);
1131 ret = make_status_items(afd, &old_afsi, path, score, file_hash);
1134 aced.aft_row = aft_row;
1135 aced.old_afsi = &old_afsi;
1136 afs_event(AFSI_CHANGE, NULL, &aced);
1137 ret = save_afd(afd);
1139 free(afd->afhi.chunk_table);
1140 osl_close_disk_object(&chunk_table_obj);
1142 PARA_ERROR_LOG("%s: %s\n", path, para_strerror(-ret));
1146 static int ls_audio_format_compare(const void *a, const void *b)
1148 struct ls_data *d1 = *(struct ls_data **)a, *d2 = *(struct ls_data **)b;
1149 return NUM_COMPARE(d1->afsi.audio_format_id, d2->afsi.audio_format_id);
1152 static int ls_duration_compare(const void *a, const void *b)
1154 struct ls_data *d1 = *(struct ls_data **)a, *d2 = *(struct ls_data **)b;
1155 return NUM_COMPARE(d1->afhi.seconds_total, d2->afhi.seconds_total);
1158 static int ls_bitrate_compare(const void *a, const void *b)
1160 struct ls_data *d1 = *(struct ls_data **)a, *d2 = *(struct ls_data **)b;
1161 return NUM_COMPARE(d1->afhi.bitrate, d2->afhi.bitrate);
1164 static int ls_lyrics_id_compare(const void *a, const void *b)
1166 struct ls_data *d1 = *(struct ls_data **)a, *d2 = *(struct ls_data **)b;
1167 return NUM_COMPARE(d1->afsi.lyrics_id, d2->afsi.lyrics_id);
1170 static int ls_image_id_compare(const void *a, const void *b)
1172 struct ls_data *d1 = *(struct ls_data **)a, *d2 = *(struct ls_data **)b;
1173 return NUM_COMPARE(d1->afsi.image_id, d2->afsi.image_id);
1176 static int ls_channels_compare(const void *a, const void *b)
1178 struct ls_data *d1 = *(struct ls_data **)a, *d2 = *(struct ls_data **)b;
1179 return NUM_COMPARE(d1->afhi.channels, d2->afhi.channels);
1182 static int ls_frequency_compare(const void *a, const void *b)
1184 struct ls_data *d1 = *(struct ls_data **)a, *d2 = *(struct ls_data **)b;
1185 return NUM_COMPARE(d1->afhi.frequency, d2->afhi.frequency);
1188 static int ls_num_played_compare(const void *a, const void *b)
1190 struct ls_data *d1 = *(struct ls_data **)a, *d2 = *(struct ls_data **)b;
1191 return NUM_COMPARE(d1->afsi.num_played, d2->afsi.num_played);
1194 static int ls_last_played_compare(const void *a, const void *b)
1196 struct ls_data *d1 = *(struct ls_data **)a, *d2 = *(struct ls_data **)b;
1197 return NUM_COMPARE(d1->afsi.last_played, d2->afsi.last_played);
1200 static int ls_score_compare(const void *a, const void *b)
1202 struct ls_data *d1 = *(struct ls_data **)a, *d2 = *(struct ls_data **)b;
1203 return NUM_COMPARE(d1->score, d2->score);
1206 static int ls_path_compare(const void *a, const void *b)
1208 struct ls_data *d1 = *(struct ls_data **)a, *d2 = *(struct ls_data **)b;
1209 return strcmp(d1->path, d2->path);
1212 static int sort_matching_paths(struct ls_options *options)
1214 size_t nmemb = options->num_matching_paths;
1215 size_t size = sizeof(*options->data_ptr);
1216 int (*compar)(const void *, const void *);
1219 options->data_ptr = para_malloc(nmemb * sizeof(*options->data_ptr));
1220 for (i = 0; i < nmemb; i++)
1221 options->data_ptr[i] = options->data + i;
1223 /* In these cases the array is already sorted */
1224 if (options->sorting == LS_SORT_BY_PATH
1225 && !(options->flags & LS_FLAG_ADMISSIBLE_ONLY)
1226 && (options->flags & LS_FLAG_FULL_PATH))
1228 if (options->sorting == LS_SORT_BY_SCORE &&
1229 options->flags & LS_FLAG_ADMISSIBLE_ONLY)
1232 switch (options->sorting) {
1233 case LS_SORT_BY_PATH:
1234 compar = ls_path_compare; break;
1235 case LS_SORT_BY_SCORE:
1236 compar = ls_score_compare; break;
1237 case LS_SORT_BY_LAST_PLAYED:
1238 compar = ls_last_played_compare; break;
1239 case LS_SORT_BY_NUM_PLAYED:
1240 compar = ls_num_played_compare; break;
1241 case LS_SORT_BY_FREQUENCY:
1242 compar = ls_frequency_compare; break;
1243 case LS_SORT_BY_CHANNELS:
1244 compar = ls_channels_compare; break;
1245 case LS_SORT_BY_IMAGE_ID:
1246 compar = ls_image_id_compare; break;
1247 case LS_SORT_BY_LYRICS_ID:
1248 compar = ls_lyrics_id_compare; break;
1249 case LS_SORT_BY_BITRATE:
1250 compar = ls_bitrate_compare; break;
1251 case LS_SORT_BY_DURATION:
1252 compar = ls_duration_compare; break;
1253 case LS_SORT_BY_AUDIO_FORMAT:
1254 compar = ls_audio_format_compare; break;
1258 qsort(options->data_ptr, nmemb, size, compar);
1262 /* row is either an aft_row or a row of the score table */
1263 /* TODO: Only compute widths if we need them */
1264 static int prepare_ls_row(struct osl_row *row, void *ls_opts)
1267 struct ls_options *options = ls_opts;
1269 struct ls_widths *w;
1270 unsigned short num_digits;
1272 struct osl_row *aft_row;
1276 if (options->flags & LS_FLAG_ADMISSIBLE_ONLY) {
1277 ret = get_score_and_aft_row(row, &score, &aft_row);
1282 ret = get_audio_file_path_of_row(aft_row, &path);
1285 if (!(options->flags & LS_FLAG_FULL_PATH)) {
1286 char *p = strrchr(path, '/');
1290 if (options->num_patterns) {
1291 for (i = 0; i < options->num_patterns; i++) {
1292 ret = fnmatch(options->patterns[i], path, 0);
1295 if (ret == FNM_NOMATCH)
1299 if (i >= options->num_patterns) /* no match */
1302 tmp = options->num_matching_paths++;
1303 if (options->num_matching_paths > options->array_size) {
1304 options->array_size++;
1305 options->array_size *= 2;
1306 options->data = para_realloc(options->data, options->array_size
1307 * sizeof(*options->data));
1309 d = options->data + tmp;
1310 ret = get_afsi_of_row(aft_row, &d->afsi);
1313 ret = get_afhi_of_row(aft_row, &d->afhi);
1317 ret = get_hash_of_row(aft_row, &d->hash);
1320 w = &options->widths;
1321 GET_NUM_DIGITS(d->afsi.image_id, &num_digits);
1322 w->image_id_width = PARA_MAX(w->image_id_width, num_digits);
1323 GET_NUM_DIGITS(d->afsi.lyrics_id, &num_digits);
1324 w->lyrics_id_width = PARA_MAX(w->lyrics_id_width, num_digits);
1325 GET_NUM_DIGITS(d->afhi.bitrate, &num_digits);
1326 w->bitrate_width = PARA_MAX(w->bitrate_width, num_digits);
1327 GET_NUM_DIGITS(d->afhi.frequency, &num_digits);
1328 w->frequency_width = PARA_MAX(w->frequency_width, num_digits);
1329 GET_NUM_DIGITS(d->afsi.num_played, &num_digits);
1330 w->num_played_width = PARA_MAX(w->num_played_width, num_digits);
1331 /* get the number of chars to print this amount of time */
1332 num_digits = get_duration_width(d->afhi.seconds_total);
1333 w->duration_width = PARA_MAX(w->duration_width, num_digits);
1334 GET_NUM_DIGITS(d->afsi.amp, &num_digits);
1335 w->amp_width = PARA_MAX(w->amp_width, num_digits);
1336 num_digits = strlen(audio_format_name(d->afsi.audio_format_id));
1337 w->audio_format_width = PARA_MAX(w->audio_format_width, num_digits);
1338 if (options->flags & LS_FLAG_ADMISSIBLE_ONLY) {
1339 GET_NUM_DIGITS(score, &num_digits);
1340 num_digits++; /* add one for the sign (space or "-") */
1341 w->score_width = PARA_MAX(w->score_width, num_digits);
1349 static void com_ls_callback(int fd, const struct osl_object *query)
1351 struct ls_options *opts = query->data;
1352 char *p, *pattern_start = (char *)query->data + sizeof(*opts);
1353 struct para_buffer b = {
1354 .max_size = shm_get_shmmax(),
1355 .flags = (opts->mode == LS_MODE_PARSER)? PBF_SIZE_PREFIX : 0,
1356 .max_size_handler = afs_max_size_handler,
1357 .private_data = &(struct afs_max_size_handler_data) {
1362 time_t current_time;
1364 if (opts->num_patterns) {
1365 opts->patterns = para_malloc(opts->num_patterns * sizeof(char *));
1366 for (i = 0, p = pattern_start; i < opts->num_patterns; i++) {
1367 opts->patterns[i] = p;
1371 opts->patterns = NULL;
1372 if (opts->flags & LS_FLAG_ADMISSIBLE_ONLY)
1373 ret = admissible_file_loop(opts, prepare_ls_row);
1375 ret = osl(osl_rbtree_loop(audio_file_table, AFTCOL_PATH, opts,
1379 if (opts->num_matching_paths == 0) {
1380 if (opts->num_patterns > 0)
1381 para_printf(&b, "no matches\n");
1384 ret = sort_matching_paths(opts);
1387 time(¤t_time);
1388 if (opts->flags & LS_FLAG_REVERSE)
1389 for (i = opts->num_matching_paths - 1; i >= 0; i--) {
1390 ret = print_list_item(opts->data_ptr[i], opts, &b, current_time);
1395 for (i = 0; i < opts->num_matching_paths; i++) {
1396 ret = print_list_item(opts->data_ptr[i], opts, &b, current_time);
1402 pass_buffer_as_shm(fd, b.buf, b.offset);
1405 free(opts->data_ptr);
1406 free(opts->patterns);
1410 * TODO: flags -h (sort by hash)
1412 int com_ls(struct command_context *cc)
1416 enum ls_sorting_method sort = LS_SORT_BY_PATH;
1417 enum ls_listing_mode mode = LS_MODE_SHORT;
1418 struct ls_options opts = {.patterns = NULL};
1419 struct osl_object query = {.data = &opts, .size = sizeof(opts)};
1421 for (i = 1; i < cc->argc; i++) {
1422 const char *arg = cc->argv[i];
1425 if (!strcmp(arg, "--")) {
1429 if (!strncmp(arg, "-l", 2)) {
1431 mode = LS_MODE_LONG;
1435 return -E_AFT_SYNTAX;
1436 switch(*(arg + 2)) {
1438 mode = LS_MODE_SHORT;
1441 mode = LS_MODE_LONG;
1444 mode = LS_MODE_VERBOSE;
1447 mode = LS_MODE_MBOX;
1450 mode = LS_MODE_CHUNKS;
1453 mode = LS_MODE_PARSER;
1456 return -E_AFT_SYNTAX;
1459 if (!strcmp(arg, "-p")) {
1460 flags |= LS_FLAG_FULL_PATH;
1463 if (!strcmp(arg, "-a")) {
1464 flags |= LS_FLAG_ADMISSIBLE_ONLY;
1467 if (!strcmp(arg, "-r")) {
1468 flags |= LS_FLAG_REVERSE;
1471 if (!strcmp(arg, "-d")) {
1472 flags |= LS_FLAG_UNIXDATE;
1475 if (!strncmp(arg, "-s", 2)) {
1476 if (!*(arg + 2) || *(arg + 3))
1477 return -E_AFT_SYNTAX;
1478 switch(*(arg + 2)) {
1480 sort = LS_SORT_BY_PATH;
1482 case 's': /* -ss implies -a */
1483 sort = LS_SORT_BY_SCORE;
1484 flags |= LS_FLAG_ADMISSIBLE_ONLY;
1487 sort = LS_SORT_BY_LAST_PLAYED;
1490 sort = LS_SORT_BY_NUM_PLAYED;
1493 sort = LS_SORT_BY_FREQUENCY;
1496 sort = LS_SORT_BY_CHANNELS;
1499 sort = LS_SORT_BY_IMAGE_ID;
1502 sort = LS_SORT_BY_LYRICS_ID;
1505 sort = LS_SORT_BY_BITRATE;
1508 sort = LS_SORT_BY_DURATION;
1511 sort = LS_SORT_BY_AUDIO_FORMAT;
1514 return -E_AFT_SYNTAX;
1517 return -E_AFT_SYNTAX;
1520 opts.sorting = sort;
1522 opts.num_patterns = cc->argc - i;
1523 ret = send_option_arg_callback_request(&query, opts.num_patterns,
1524 cc->argv + i, com_ls_callback, afs_cb_result_handler, cc);
1529 * Call the given function for each file in the audio file table.
1531 * \param private_data An arbitrary data pointer, passed to \a func.
1532 * \param func The custom function to be called.
1536 int audio_file_loop(void *private_data, osl_rbtree_loop_func *func)
1538 return osl(osl_rbtree_loop(audio_file_table, AFTCOL_HASH, private_data,
1542 static struct osl_row *find_hash_sister(unsigned char *hash)
1544 const struct osl_object obj = {.data = hash, .size = HASH_SIZE};
1545 struct osl_row *row;
1547 osl_get_row(audio_file_table, AFTCOL_HASH, &obj, &row);
1551 /** The format of the data stored by save_audio_file_data(). */
1552 enum com_add_buffer_offsets {
1553 /** afhi (if present) starts here. */
1554 CAB_AFHI_OFFSET_POS = 0,
1555 /** Start of the chunk table (if present). */
1556 CAB_CHUNKS_OFFSET_POS = 2,
1557 /** Audio format id. */
1558 CAB_AUDIO_FORMAT_OFFSET = 4,
1559 /** Flags given to the add command. */
1560 CAB_FLAGS_OFFSET = 5,
1561 /** The hash of the audio file being added. */
1562 CAB_HASH_OFFSET = 9,
1563 /** Start of the path of the audio file. */
1564 CAB_PATH_OFFSET = (CAB_HASH_OFFSET + HASH_SIZE),
1568 * Store the given data to a single buffer. Doesn't need the audio file selector
1569 * info struct as the server knows it as well.
1571 * It's OK to call this with afhi == NULL. In this case, the audio format
1572 * handler info won't be stored in the buffer.
1574 static void save_add_callback_buffer(unsigned char *hash, const char *path,
1575 struct afh_info *afhi, uint32_t flags,
1576 uint8_t audio_format_num, struct osl_object *obj)
1578 size_t path_len = strlen(path) + 1;
1579 size_t afhi_size = sizeof_afhi_buf(afhi);
1580 size_t size = CAB_PATH_OFFSET + path_len + afhi_size
1581 + sizeof_chunk_table(afhi);
1582 char *buf = para_malloc(size);
1585 write_u8(buf + CAB_AUDIO_FORMAT_OFFSET, audio_format_num);
1586 write_u32(buf + CAB_FLAGS_OFFSET, flags);
1588 memcpy(buf + CAB_HASH_OFFSET, hash, HASH_SIZE);
1589 strcpy(buf + CAB_PATH_OFFSET, path);
1591 pos = CAB_PATH_OFFSET + path_len;
1592 PARA_DEBUG_LOG("size: %zu, afhi starts at %d\n", size, pos);
1593 PARA_DEBUG_LOG("last afhi byte: %p, pos %zu\n", buf + pos + afhi_size - 1,
1594 pos + afhi_size - 1);
1595 write_u16(buf + CAB_AFHI_OFFSET_POS, pos);
1596 save_afhi(afhi, buf + pos);
1599 PARA_DEBUG_LOG("size: %zu, chunks start at %d\n", size, pos);
1600 write_u16(buf + CAB_CHUNKS_OFFSET_POS, pos);
1602 save_chunk_table(afhi, buf + pos);
1603 PARA_DEBUG_LOG("last byte in buf: %p\n", buf + size - 1);
1610 Overview of the add command.
1612 Input: What was passed to the callback by the command handler.
1614 HS: Hash sister. Whether an audio file with identical hash
1615 already exists in the osl database.
1617 PB: Path brother. Whether a file with the given path exists
1620 F: Force flag given. Whether add was called with -f.
1622 output: Action performed by the callback.
1624 AFHI: Whether afhi and chunk table are computed and sent.
1625 ACTION: Table modifications to be done by the callback.
1627 +----+----+---+------+---------------------------------------------------+
1628 | HS | PB | F | AFHI | ACTION
1629 +----+----+---+------+---------------------------------------------------+
1630 | Y | Y | Y | Y | if HS != PB: remove PB. HS: force afhi update,
1631 | | update path, keep afsi
1632 +----+----+---+------+---------------------------------------------------+
1633 | Y | Y | N | N | if HS == PB: do not send callback request at all.
1634 | | otherwise: remove PB, HS: update path, keep afhi,
1636 +----+----+---+------+---------------------------------------------------+
1637 | Y | N | Y | Y | (rename) force afhi update of HS, update path of
1639 +----+----+---+------+---------------------------------------------------+
1640 | Y | N | N | N | (file rename) update path of HS, keep afsi, afhi
1641 +----+----+---+------+---------------------------------------------------+
1642 | N | Y | Y | Y | (file change) update afhi, hash, of PB, keep afsi
1643 | | (force has no effect)
1644 +----+----+---+------+---------------------------------------------------+
1645 | N | Y | N | Y | (file change) update afhi, hash of PB, keep afsi
1646 +----+----+---+------+---------------------------------------------------+
1647 | N | N | Y | Y | (new file) create new entry (force has no effect)
1648 +----+----+---+------+---------------------------------------------------+
1649 | N | N | N | Y | (new file) create new entry
1650 +----+----+---+------+---------------------------------------------------+
1654 afhi <=> force or no HS
1659 /** Flags passed to the add command. */
1660 enum com_add_flags {
1661 /** Skip paths that exist already. */
1663 /** Force adding. */
1665 /** Print what is being done. */
1666 ADD_FLAG_VERBOSE = 4,
1667 /** Try to add files with unknown suffixes. */
1671 static void com_add_callback(int fd, const struct osl_object *query)
1673 char *buf = query->data, *path;
1674 struct osl_row *pb, *aft_row;
1676 struct osl_object objs[NUM_AFT_COLUMNS];
1677 unsigned char *hash;
1678 char asc[2 * HASH_SIZE + 1];
1680 char afsi_buf[AFSI_SIZE];
1681 uint32_t flags = read_u32(buf + CAB_FLAGS_OFFSET);
1682 struct afs_info default_afsi = {.last_played = 0};
1683 struct para_buffer msg = {
1684 .max_size = shm_get_shmmax(),
1685 .max_size_handler = afs_max_size_handler,
1686 .private_data = &(struct afs_max_size_handler_data) {
1690 uint16_t afhi_offset, chunks_offset;
1692 hash = (unsigned char *)buf + CAB_HASH_OFFSET;
1693 hash_to_asc(hash, asc);;
1694 objs[AFTCOL_HASH].data = buf + CAB_HASH_OFFSET;
1695 objs[AFTCOL_HASH].size = HASH_SIZE;
1697 path = buf + CAB_PATH_OFFSET;
1698 objs[AFTCOL_PATH].data = path;
1699 objs[AFTCOL_PATH].size = strlen(path) + 1;
1701 PARA_INFO_LOG("request to add %s\n", path);
1702 hs = find_hash_sister(hash);
1703 ret = aft_get_row_of_path(path, &pb);
1704 if (ret < 0 && ret != -OSL_ERRNO_TO_PARA_ERROR(E_OSL_RB_KEY_NOT_FOUND))
1706 if (hs && pb && hs == pb && !(flags & ADD_FLAG_FORCE)) {
1707 if (flags & ADD_FLAG_VERBOSE)
1708 ret = para_printf(&msg, "ignoring duplicate\n");
1713 if (hs && hs != pb) {
1714 struct osl_object obj;
1715 if (pb) { /* hs trumps pb, remove pb */
1716 if (flags & ADD_FLAG_VERBOSE) {
1717 ret = para_printf(&msg, "removing path brother\n");
1721 ret = osl(osl_del_row(audio_file_table, pb));
1726 /* file rename, update hs' path */
1727 if (flags & ADD_FLAG_VERBOSE) {
1728 ret = osl(osl_get_object(audio_file_table, hs,
1729 AFTCOL_PATH, &obj));
1732 ret = para_printf(&msg, "renamed from %s\n", (char *)obj.data);
1736 ret = osl(osl_update_object(audio_file_table, hs, AFTCOL_PATH,
1737 &objs[AFTCOL_PATH]));
1740 afs_event(AUDIO_FILE_RENAME, &msg, hs);
1741 if (!(flags & ADD_FLAG_FORCE))
1744 /* no hs or force mode, child must have sent afhi */
1745 afhi_offset = read_u16(buf + CAB_AFHI_OFFSET_POS);
1746 chunks_offset = read_u16(buf + CAB_CHUNKS_OFFSET_POS);
1748 objs[AFTCOL_AFHI].data = buf + afhi_offset;
1749 objs[AFTCOL_AFHI].size = chunks_offset - afhi_offset;
1751 if (!objs[AFTCOL_AFHI].size) /* "impossible" */
1753 objs[AFTCOL_CHUNKS].data = buf + chunks_offset;
1754 objs[AFTCOL_CHUNKS].size = query->size - chunks_offset;
1755 if (pb && !hs) { /* update pb's hash */
1756 char old_asc[2 * HASH_SIZE + 1];
1757 unsigned char *old_hash;
1758 ret = get_hash_of_row(pb, &old_hash);
1761 hash_to_asc(old_hash, old_asc);
1762 if (flags & ADD_FLAG_VERBOSE) {
1763 ret = para_printf(&msg, "file change: %s -> %s\n",
1768 ret = osl_update_object(audio_file_table, pb, AFTCOL_HASH,
1769 &objs[AFTCOL_HASH]);
1773 if (hs || pb) { /* (hs != NULL and pb != NULL) implies hs == pb */
1774 struct osl_row *row = pb? pb : hs;
1775 /* update afhi and chunk_table */
1776 if (flags & ADD_FLAG_VERBOSE) {
1777 ret = para_printf(&msg, "updating afhi and chunk table\n");
1781 ret = osl(osl_update_object(audio_file_table, row, AFTCOL_AFHI,
1782 &objs[AFTCOL_AFHI]));
1785 ret = osl(osl_update_object(audio_file_table, row, AFTCOL_CHUNKS,
1786 &objs[AFTCOL_CHUNKS]));
1789 afs_event(AFHI_CHANGE, &msg, row);
1792 /* new entry, use default afsi */
1793 if (flags & ADD_FLAG_VERBOSE) {
1794 ret = para_printf(&msg, "new file\n");
1798 default_afsi.last_played = time(NULL) - 365 * 24 * 60 * 60;
1799 default_afsi.audio_format_id = read_u8(buf + CAB_AUDIO_FORMAT_OFFSET);
1801 objs[AFTCOL_AFSI].data = &afsi_buf;
1802 objs[AFTCOL_AFSI].size = AFSI_SIZE;
1803 save_afsi(&default_afsi, &objs[AFTCOL_AFSI]);
1804 ret = osl(osl_add_and_get_row(audio_file_table, objs, &aft_row));
1805 afs_event(AUDIO_FILE_ADD, &msg, aft_row);
1808 para_printf(&msg, "%s\n", para_strerror(-ret));
1810 pass_buffer_as_shm(fd, msg.buf, msg.offset);
1814 /** Used by com_add(). */
1815 struct private_add_data {
1816 /** The pointer passed to the original command handler. */
1817 struct command_context *cc;
1818 /** The given add flags. */
1822 static void path_brother_callback(int fd, const struct osl_object *query)
1824 char *path = query->data;
1825 struct osl_row *path_brother;
1826 int ret = aft_get_row_of_path(path, &path_brother);
1829 pass_buffer_as_shm(fd, (char *)&path_brother, sizeof(path_brother));
1832 static void hash_sister_callback(int fd, const struct osl_object *query)
1834 unsigned char *hash = query->data;
1835 struct osl_row *hash_sister;
1837 hash_sister = find_hash_sister(hash);
1840 pass_buffer_as_shm(fd, (char *)&hash_sister, sizeof(hash_sister));
1843 static int get_row_pointer_from_result(struct osl_object *result, void *private)
1845 struct osl_row **row = private;
1846 *row = *(struct osl_row **)(result->data);
1850 static int add_one_audio_file(const char *path, void *private_data)
1852 int ret, send_ret = 1, fd;
1853 uint8_t format_num = -1;
1854 struct private_add_data *pad = private_data;
1855 struct afh_info afhi, *afhi_ptr = NULL;
1856 struct osl_row *pb = NULL, *hs = NULL; /* path brother/hash sister */
1857 struct osl_object map, obj = {.data = NULL}, query;
1858 unsigned char hash[HASH_SIZE];
1860 ret = guess_audio_format(path);
1861 if (ret < 0 && !(pad->flags & ADD_FLAG_ALL))
1863 query.data = (char *)path;
1864 query.size = strlen(path) + 1;
1865 ret = send_callback_request(path_brother_callback, &query,
1866 get_row_pointer_from_result, &pb);
1867 if (ret < 0 && ret != -OSL_ERRNO_TO_PARA_ERROR(E_OSL_RB_KEY_NOT_FOUND))
1870 if (pb && (pad->flags & ADD_FLAG_LAZY)) { /* lazy is really cheap */
1871 if (pad->flags & ADD_FLAG_VERBOSE)
1872 send_ret = sc_send_va_buffer(&pad->cc->scc,
1873 "lazy-ignore: %s\n", path);
1876 /* We still want to add this file. Compute its hash. */
1877 ret = mmap_full_file(path, O_RDONLY, &map.data, &map.size, &fd);
1880 hash_function(map.data, map.size, hash);
1882 /* Check whether the database contains a file with the same hash. */
1884 query.size = HASH_SIZE;
1885 ret = send_callback_request(hash_sister_callback, &query,
1886 get_row_pointer_from_result, &hs);
1889 /* Return success if we already know this file. */
1891 if (pb && hs && hs == pb && !(pad->flags & ADD_FLAG_FORCE)) {
1892 if (pad->flags & ADD_FLAG_VERBOSE)
1893 send_ret = sc_send_va_buffer(&pad->cc->scc,
1894 "%s exists, not forcing update\n", path);
1898 * We won't recalculate the audio format info and the chunk table if
1899 * there is a hash sister and FORCE was not given.
1901 if (!hs || (pad->flags & ADD_FLAG_FORCE)) {
1902 ret = compute_afhi(path, map.data, map.size, fd, &afhi);
1908 munmap(map.data, map.size);
1910 if (pad->flags & ADD_FLAG_VERBOSE) {
1911 send_ret = sc_send_va_buffer(&pad->cc->scc, "adding %s\n", path);
1915 save_add_callback_buffer(hash, path, afhi_ptr, pad->flags, format_num, &obj);
1916 /* Ask afs to consider this entry for adding. */
1917 ret = send_callback_request(com_add_callback, &obj,
1918 afs_cb_result_handler, pad->cc);
1923 munmap(map.data, map.size);
1925 if (ret < 0 && send_ret >= 0)
1926 send_ret = sc_send_va_buffer(&pad->cc->scc,
1927 "failed to add %s (%s)\n", path, para_strerror(-ret));
1929 clear_afhi(afhi_ptr);
1930 /* Stop adding files only on send errors. */
1934 int com_add(struct command_context *cc)
1937 struct private_add_data pad = {.cc = cc, .flags = 0};
1938 struct stat statbuf;
1940 for (i = 1; i < cc->argc; i++) {
1941 const char *arg = cc->argv[i];
1944 if (!strcmp(arg, "--")) {
1948 if (!strcmp(arg, "-a")) {
1949 pad.flags |= ADD_FLAG_ALL;
1952 if (!strcmp(arg, "-l")) {
1953 pad.flags |= ADD_FLAG_LAZY;
1956 if (!strcmp(arg, "-f")) {
1957 pad.flags |= ADD_FLAG_FORCE;
1960 if (!strcmp(arg, "-v")) {
1961 pad.flags |= ADD_FLAG_VERBOSE;
1966 return -E_AFT_SYNTAX;
1967 for (; i < cc->argc; i++) {
1969 ret = verify_path(cc->argv[i], &path);
1971 ret = sc_send_va_buffer(&cc->scc, "%s: %s\n",
1972 cc->argv[i], para_strerror(-ret));
1977 ret = stat(path, &statbuf);
1979 ret = sc_send_va_buffer(&cc->scc,
1980 "failed to stat %s (%s)\n", path,
1987 if (S_ISDIR(statbuf.st_mode))
1988 ret = for_each_file_in_dir(path, add_one_audio_file,
1991 ret = add_one_audio_file(path, &pad);
1993 sc_send_va_buffer(&cc->scc, "%s: %s\n", path,
1994 para_strerror(-ret));
2005 * Flags used by the touch command.
2010 /** Whether the \p FNM_PATHNAME flag should be passed to fnmatch(). */
2011 TOUCH_FLAG_FNM_PATHNAME = 1,
2012 /** Activates verbose mode. */
2013 TOUCH_FLAG_VERBOSE = 2
2016 /** Options used by com_touch(). */
2017 struct com_touch_options {
2018 /** New num_played value. */
2020 /** New last played count. */
2021 int64_t last_played;
2022 /** New lyrics id. */
2024 /** New image id. */
2026 /** New amplification value. */
2028 /** Command line flags (see \ref touch_flags). */
2032 /** Data passed to the action handler of com_touch(). */
2033 struct touch_action_data {
2034 /** Command line options (see \ref com_touch_options). */
2035 struct com_touch_options *cto;
2036 /** Message buffer. */
2037 struct para_buffer pb;
2040 static int touch_audio_file(__a_unused struct osl_table *table,
2041 struct osl_row *row, const char *name, void *data)
2043 struct touch_action_data *tad = data;
2044 struct osl_object obj;
2045 struct afs_info old_afsi, new_afsi;
2046 int ret, no_options = tad->cto->num_played < 0 && tad->cto->last_played < 0 &&
2047 tad->cto->lyrics_id < 0 && tad->cto->image_id < 0 && tad->cto->amp < 0;
2048 struct afsi_change_event_data aced;
2050 ret = get_afsi_object_of_row(row, &obj);
2052 return para_printf(&tad->pb, "%s: %s\n", name, para_strerror(-ret));
2053 ret = load_afsi(&old_afsi, &obj);
2055 return para_printf(&tad->pb, "%s: %s\n", name, para_strerror(-ret));
2056 new_afsi = old_afsi;
2058 new_afsi.num_played++;
2059 new_afsi.last_played = time(NULL);
2060 if (tad->cto->flags & TOUCH_FLAG_VERBOSE) {
2061 ret = para_printf(&tad->pb, "%s: num_played = %u, "
2062 "last_played = now()\n", name,
2063 new_afsi.num_played);
2068 if (tad->cto->flags & TOUCH_FLAG_VERBOSE) {
2069 ret = para_printf(&tad->pb, "touching %s\n", name);
2073 if (tad->cto->lyrics_id >= 0)
2074 new_afsi.lyrics_id = tad->cto->lyrics_id;
2075 if (tad->cto->image_id >= 0)
2076 new_afsi.image_id = tad->cto->image_id;
2077 if (tad->cto->num_played >= 0)
2078 new_afsi.num_played = tad->cto->num_played;
2079 if (tad->cto->last_played >= 0)
2080 new_afsi.last_played = tad->cto->last_played;
2081 if (tad->cto->amp >= 0)
2082 new_afsi.amp = tad->cto->amp;
2084 save_afsi(&new_afsi, &obj); /* in-place update */
2086 aced.old_afsi = &old_afsi;
2087 afs_event(AFSI_CHANGE, &tad->pb, &aced);
2091 static void com_touch_callback(int fd, const struct osl_object *query)
2093 struct touch_action_data tad = {.cto = query->data,
2095 .max_size = shm_get_shmmax(),
2096 .private_data = &fd,
2097 .max_size_handler = afs_max_size_handler
2101 struct pattern_match_data pmd = {
2102 .table = audio_file_table,
2103 .loop_col_num = AFTCOL_HASH,
2104 .match_col_num = AFTCOL_PATH,
2105 .patterns = {.data = (char *)query->data + sizeof(*tad.cto),
2106 .size = query->size - sizeof(*tad.cto)},
2108 .action = touch_audio_file
2110 if (tad.cto->flags & TOUCH_FLAG_FNM_PATHNAME)
2111 pmd.fnmatch_flags |= FNM_PATHNAME;
2112 ret = for_each_matching_row(&pmd);
2114 ret2 = para_printf(&tad.pb, "%s\n", para_strerror(-ret));
2115 else if (pmd.num_matches == 0)
2116 ret2 = para_printf(&tad.pb, "no matches\n");
2117 if (ret2 >= 0 && tad.pb.offset)
2118 pass_buffer_as_shm(fd, tad.pb.buf, tad.pb.offset);
2122 int com_touch(struct command_context *cc)
2124 struct com_touch_options cto = {
2131 struct osl_object query = {.data = &cto, .size = sizeof(cto)};
2135 for (i = 1; i < cc->argc; i++) {
2136 const char *arg = cc->argv[i];
2139 if (!strcmp(arg, "--")) {
2143 if (!strncmp(arg, "-n=", 3)) {
2144 ret = para_atoi32(arg + 3, &cto.num_played);
2149 if (!strncmp(arg, "-l=", 3)) {
2150 ret = para_atoi64(arg + 3, &cto.last_played);
2155 if (!strncmp(arg, "-y=", 3)) {
2156 ret = para_atoi32(arg + 3, &cto.lyrics_id);
2161 if (!strncmp(arg, "-i=", 3)) {
2162 ret = para_atoi32(arg + 3, &cto.image_id);
2167 if (!strncmp(arg, "-a=", 3)) {
2169 ret = para_atoi32(arg + 3, &val);
2172 if (val < 0 || val > 255)
2173 return -ERRNO_TO_PARA_ERROR(EINVAL);
2177 if (!strcmp(arg, "-p")) {
2178 cto.flags |= TOUCH_FLAG_FNM_PATHNAME;
2181 if (!strcmp(arg, "-v")) {
2182 cto.flags |= TOUCH_FLAG_VERBOSE;
2185 break; /* non-option starting with dash */
2188 return -E_AFT_SYNTAX;
2189 ret = send_option_arg_callback_request(&query, cc->argc - i,
2190 cc->argv + i, com_touch_callback, afs_cb_result_handler, cc);
2192 sc_send_va_buffer(&cc->scc, "%s\n", para_strerror(-ret));
2196 /** Flags for com_rm(). */
2199 RM_FLAG_VERBOSE = 1,
2203 RM_FLAG_FNM_PATHNAME = 4
2206 /** Data passed to the action handler of com_rm(). */
2207 struct com_rm_action_data {
2208 /** Command line flags ((see \ref rm_flags). */
2210 /** Message buffer. */
2211 struct para_buffer pb;
2214 static int remove_audio_file(__a_unused struct osl_table *table,
2215 struct osl_row *row, const char *name, void *data)
2217 struct com_rm_action_data *crd = data;
2220 if (crd->flags & RM_FLAG_VERBOSE) {
2221 ret = para_printf(&crd->pb, "removing %s\n", name);
2225 afs_event(AUDIO_FILE_REMOVE, &crd->pb, row);
2226 ret = osl(osl_del_row(audio_file_table, row));
2228 para_printf(&crd->pb, "%s: %s\n", name, para_strerror(-ret));
2232 static void com_rm_callback(int fd, const struct osl_object *query)
2234 struct com_rm_action_data crd = {.flags = *(uint32_t *)query->data,
2236 .max_size = shm_get_shmmax(),
2237 .private_data = &fd,
2238 .max_size_handler = afs_max_size_handler
2242 struct pattern_match_data pmd = {
2243 .table = audio_file_table,
2244 .loop_col_num = AFTCOL_HASH,
2245 .match_col_num = AFTCOL_PATH,
2246 .patterns = {.data = (char *)query->data + sizeof(uint32_t),
2247 .size = query->size - sizeof(uint32_t)},
2249 .action = remove_audio_file
2251 if (crd.flags & RM_FLAG_FNM_PATHNAME)
2252 pmd.fnmatch_flags |= FNM_PATHNAME;
2253 ret = for_each_matching_row(&pmd);
2255 para_printf(&crd.pb, "%s\n", para_strerror(-ret));
2258 if ((pmd.num_matches == 0) && !(crd.flags & RM_FLAG_FORCE))
2259 ret = para_printf(&crd.pb, "no matches -- nothing removed\n");
2260 else if (crd.flags & RM_FLAG_VERBOSE) {
2261 ret = para_printf(&crd.pb, "removed %u files\n",
2264 if (ret >= 0 && crd.pb.offset)
2265 pass_buffer_as_shm(fd, crd.pb.buf, crd.pb.offset);
2269 /* TODO options: -r (recursive) */
2270 int com_rm(struct command_context *cc)
2273 struct osl_object query = {.data = &flags, .size = sizeof(flags)};
2276 for (i = 1; i < cc->argc; i++) {
2277 const char *arg = cc->argv[i];
2280 if (!strcmp(arg, "--")) {
2284 if (!strcmp(arg, "-f")) {
2285 flags |= RM_FLAG_FORCE;
2288 if (!strcmp(arg, "-p")) {
2289 flags |= RM_FLAG_FNM_PATHNAME;
2292 if (!strcmp(arg, "-v")) {
2293 flags |= RM_FLAG_VERBOSE;
2299 return -E_AFT_SYNTAX;
2300 ret = send_option_arg_callback_request(&query, cc->argc - i,
2301 cc->argv + i, com_rm_callback, afs_cb_result_handler, cc);
2303 sc_send_va_buffer(&cc->scc, "%s\n", para_strerror(-ret));
2308 * Flags used by the cpsi command.
2313 /** Whether the lyrics id should be copied. */
2314 CPSI_FLAG_COPY_LYRICS_ID = 1,
2315 /** Whether the image id should be copied. */
2316 CPSI_FLAG_COPY_IMAGE_ID = 2,
2317 /** Whether the lastplayed time should be copied. */
2318 CPSI_FLAG_COPY_LASTPLAYED = 4,
2319 /** Whether the numplayed count should be copied. */
2320 CPSI_FLAG_COPY_NUMPLAYED = 8,
2321 /** Whether the attributes should be copied. */
2322 CPSI_FLAG_COPY_ATTRIBUTES = 16,
2323 /** Activates verbose mode. */
2324 CPSI_FLAG_VERBOSE = 32,
2327 /** Data passed to the action handler of com_cpsi(). */
2328 struct cpsi_action_data {
2329 /** command line flags (see \ref cpsi_flags). */
2331 /** Message buffer. */
2332 struct para_buffer pb;
2333 /** Values are copied from here. */
2334 struct afs_info source_afsi;
2337 static int copy_selector_info(__a_unused struct osl_table *table,
2338 struct osl_row *row, const char *name, void *data)
2340 struct cpsi_action_data *cad = data;
2341 struct osl_object target_afsi_obj;
2343 struct afs_info old_afsi, target_afsi;
2344 struct afsi_change_event_data aced;
2346 ret = get_afsi_object_of_row(row, &target_afsi_obj);
2349 load_afsi(&target_afsi, &target_afsi_obj);
2350 old_afsi = target_afsi;
2351 if (cad->flags & CPSI_FLAG_COPY_LYRICS_ID)
2352 target_afsi.lyrics_id = cad->source_afsi.lyrics_id;
2353 if (cad->flags & CPSI_FLAG_COPY_IMAGE_ID)
2354 target_afsi.image_id = cad->source_afsi.image_id;
2355 if (cad->flags & CPSI_FLAG_COPY_LASTPLAYED)
2356 target_afsi.last_played = cad->source_afsi.last_played;
2357 if (cad->flags & CPSI_FLAG_COPY_NUMPLAYED)
2358 target_afsi.num_played = cad->source_afsi.num_played;
2359 if (cad->flags & CPSI_FLAG_COPY_ATTRIBUTES)
2360 target_afsi.attributes = cad->source_afsi.attributes;
2361 save_afsi(&target_afsi, &target_afsi_obj); /* in-place update */
2362 if (cad->flags & CPSI_FLAG_VERBOSE) {
2363 ret = para_printf(&cad->pb, "copied afsi to %s\n", name);
2368 aced.old_afsi = &old_afsi;
2369 afs_event(AFSI_CHANGE, &cad->pb, &aced);
2373 static void com_cpsi_callback(int fd, const struct osl_object *query)
2375 struct cpsi_action_data cad = {
2376 .flags = *(unsigned *)query->data,
2378 .max_size = shm_get_shmmax(),
2379 .private_data = &fd,
2380 .max_size_handler = afs_max_size_handler
2384 char *source_path = (char *)query->data + sizeof(cad.flags);
2385 struct pattern_match_data pmd = {
2386 .table = audio_file_table,
2387 .loop_col_num = AFTCOL_HASH,
2388 .match_col_num = AFTCOL_PATH,
2389 .patterns = {.data = source_path + strlen(source_path) + 1,
2390 .size = query->size - sizeof(cad.flags)
2391 - strlen(source_path) - 1},
2393 .action = copy_selector_info
2396 ret = get_afsi_of_path(source_path, &cad.source_afsi);
2399 ret = for_each_matching_row(&pmd);
2402 para_printf(&cad.pb, "%s\n", para_strerror(-ret));
2403 else if (cad.flags & CPSI_FLAG_VERBOSE) {
2404 if (pmd.num_matches > 0)
2405 para_printf(&cad.pb, "copied requested afsi from %s "
2406 "to %u files\n", source_path, pmd.num_matches);
2408 para_printf(&cad.pb, "nothing copied\n");
2411 pass_buffer_as_shm(fd, cad.pb.buf, cad.pb.offset);
2415 int com_cpsi(struct command_context *cc)
2419 struct osl_object options = {.data = &flags, .size = sizeof(flags)};
2421 for (i = 1; i < cc->argc; i++) {
2422 const char *arg = cc->argv[i];
2425 if (!strcmp(arg, "--")) {
2429 if (!strcmp(arg, "-y")) {
2430 flags |= CPSI_FLAG_COPY_LYRICS_ID;
2433 if (!strcmp(arg, "-i")) {
2434 flags |= CPSI_FLAG_COPY_IMAGE_ID;
2437 if (!strcmp(arg, "-l")) {
2438 flags |= CPSI_FLAG_COPY_LASTPLAYED;
2441 if (!strcmp(arg, "-n")) {
2442 flags |= CPSI_FLAG_COPY_NUMPLAYED;
2445 if (!strcmp(arg, "-a")) {
2446 flags |= CPSI_FLAG_COPY_ATTRIBUTES;
2449 if (!strcmp(arg, "-v")) {
2450 flags |= CPSI_FLAG_VERBOSE;
2455 if (i + 1 >= cc->argc) /* need at least source file and pattern */
2456 return -E_AFT_SYNTAX;
2457 if (!(flags & ~CPSI_FLAG_VERBOSE)) /* no copy flags given */
2458 flags = ~(unsigned)CPSI_FLAG_VERBOSE | flags;
2459 ret = send_option_arg_callback_request(&options, cc->argc - i,
2460 cc->argv + i, com_cpsi_callback, afs_cb_result_handler, cc);
2462 sc_send_va_buffer(&cc->scc, "%s\n", para_strerror(-ret));
2466 static void afs_stat_callback(int fd, const struct osl_object *query)
2468 int *parser_friendly = query->data;
2469 char *buf = *parser_friendly?
2470 parser_friendly_status_items : status_items;
2474 pass_buffer_as_shm(fd, buf, strlen(buf));
2478 * Get the current afs status items from the afs process and send it.
2480 * \param cc The command context, used e.g. for data encryption.
2481 * \param parser_friendly Whether parser-friendly output format should be used.
2483 * As the contents of the afs status items change in time and the command
2484 * handler only has a COW version created at fork time, it can not send
2485 * up-to-date afs status items directly. Therefore the usual callback mechanism
2486 * is used to pass the status items from the afs process to the command handler
2487 * via a shared memory area and a pipe.
2489 * \return The return value of the underyling call to \ref send_callback_request().
2491 int send_afs_status(struct command_context *cc, int parser_friendly)
2493 struct osl_object query = {.data = &parser_friendly,
2494 .size = sizeof(parser_friendly)};
2496 return send_callback_request(afs_stat_callback, &query,
2497 afs_cb_result_handler, cc);
2500 /* TODO: optionally fix problems by removing offending rows */
2501 static int check_audio_file(struct osl_row *row, void *data)
2504 struct para_buffer *pb = data;
2505 struct stat statbuf;
2506 int ret = get_audio_file_path_of_row(row, &path);
2507 struct afs_info afsi;
2511 return para_printf(pb, "%s\n", para_strerror(-ret));
2512 if (stat(path, &statbuf) < 0) {
2513 ret = para_printf(pb, "%s: stat error (%s)\n", path, strerror(errno));
2517 if (!S_ISREG(statbuf.st_mode)) {
2518 ret = para_printf(pb, "%s: not a regular file\n", path);
2523 ret = get_afsi_of_row(row, &afsi);
2525 return para_printf(pb, "%s: %s\n", path, para_strerror(-ret));
2526 ret = lyr_get_name_by_id(afsi.lyrics_id, &blob_name);
2528 ret = para_printf(pb, "%s lyrics id %u: %s\n", path, afsi.lyrics_id,
2529 para_strerror(-ret));
2533 ret = img_get_name_by_id(afsi.image_id, &blob_name);
2535 ret = para_printf(pb, "%s image id %u: %s\n", path, afsi.image_id,
2536 para_strerror(-ret));
2541 * Check the audio file table for inconsistencies.
2543 * \param fd The afs socket.
2544 * \param query Unused.
2546 * This function always succeeds.
2550 void aft_check_callback(int fd, __a_unused const struct osl_object *query)
2552 struct para_buffer pb = {
2553 .max_size = shm_get_shmmax(),
2554 .private_data = &(struct afs_max_size_handler_data) {
2557 .max_size_handler = afs_max_size_handler
2559 int ret = para_printf(&pb, "checking audio file table...\n");
2563 audio_file_loop(&pb, check_audio_file);
2565 pass_buffer_as_shm(fd, pb.buf, pb.offset);
2570 * Close the audio file table.
2572 * \param flags Usual flags that are passed to osl_close_table().
2574 * \sa osl_close_table().
2576 static void aft_close(void)
2578 osl_close_table(audio_file_table, OSL_MARK_CLEAN);
2579 audio_file_table = NULL;
2583 * Open the audio file table.
2585 * \param dir The database directory.
2589 * \sa osl_open_table().
2591 static int aft_open(const char *dir)
2595 audio_file_table_desc.dir = dir;
2596 ret = osl(osl_open_table(&audio_file_table_desc, &audio_file_table));
2599 osl_get_num_rows(audio_file_table, &num);
2600 PARA_INFO_LOG("audio file table contains %d files\n", num);
2603 PARA_INFO_LOG("failed to open audio file table\n");
2604 audio_file_table = NULL;
2605 if (ret >= 0 || ret == -OSL_ERRNO_TO_PARA_ERROR(E_OSL_NOENT))
2610 static int aft_create(const char *dir)
2612 audio_file_table_desc.dir = dir;
2613 return osl(osl_create_table(&audio_file_table_desc));
2616 static int clear_attribute(struct osl_row *row, void *data)
2618 struct rmatt_event_data *red = data;
2619 struct afs_info afsi;
2620 struct osl_object obj;
2621 int ret = get_afsi_object_of_row(row, &obj);
2622 uint64_t mask = ~(1ULL << red->bitnum);
2626 ret = load_afsi(&afsi, &obj);
2629 afsi.attributes &= mask;
2630 save_afsi(&afsi, &obj);
2634 static int aft_event_handler(enum afs_events event, struct para_buffer *pb,
2640 case ATTRIBUTE_REMOVE: {
2641 const struct rmatt_event_data *red = data;
2642 ret = para_printf(pb, "clearing attribute %s (bit %u) from all "
2643 "entries in the audio file table\n", red->name,
2647 return audio_file_loop(data, clear_attribute);
2655 * Initialize the audio file table.
2657 * \param t Pointer to the structure to be initialized.
2659 void aft_init(struct afs_table *t)
2662 t->close = aft_close;
2663 t->create = aft_create;
2664 t->event_handler = aft_event_handler;