2 * Copyright (C) 2007-2014 Andre Noll <maan@tuebingen.mpg.de>
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,
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, &map.size, &afd->fd);
1116 hash_function(map.data, map.size, file_hash);
1117 ret = hash_compare(file_hash, aft_hash);
1118 para_munmap(map.data, map.size);
1120 ret = -E_HASH_MISMATCH;
1123 new_afsi = old_afsi;
1124 new_afsi.num_played++;
1125 new_afsi.last_played = time(NULL);
1126 save_afsi(&new_afsi, &afsi_obj); /* in-place update */
1128 afd->audio_format_id = old_afsi.audio_format_id;
1129 load_chunk_table(&afd->afhi, chunk_table_obj.data);
1130 ret = make_status_items(afd, &old_afsi, path, score, file_hash);
1133 aced.aft_row = aft_row;
1134 aced.old_afsi = &old_afsi;
1135 afs_event(AFSI_CHANGE, NULL, &aced);
1136 ret = save_afd(afd);
1138 free(afd->afhi.chunk_table);
1139 osl_close_disk_object(&chunk_table_obj);
1141 PARA_ERROR_LOG("%s: %s\n", path, para_strerror(-ret));
1145 static int ls_audio_format_compare(const void *a, const void *b)
1147 struct ls_data *d1 = *(struct ls_data **)a, *d2 = *(struct ls_data **)b;
1148 return NUM_COMPARE(d1->afsi.audio_format_id, d2->afsi.audio_format_id);
1151 static int ls_duration_compare(const void *a, const void *b)
1153 struct ls_data *d1 = *(struct ls_data **)a, *d2 = *(struct ls_data **)b;
1154 return NUM_COMPARE(d1->afhi.seconds_total, d2->afhi.seconds_total);
1157 static int ls_bitrate_compare(const void *a, const void *b)
1159 struct ls_data *d1 = *(struct ls_data **)a, *d2 = *(struct ls_data **)b;
1160 return NUM_COMPARE(d1->afhi.bitrate, d2->afhi.bitrate);
1163 static int ls_lyrics_id_compare(const void *a, const void *b)
1165 struct ls_data *d1 = *(struct ls_data **)a, *d2 = *(struct ls_data **)b;
1166 return NUM_COMPARE(d1->afsi.lyrics_id, d2->afsi.lyrics_id);
1169 static int ls_image_id_compare(const void *a, const void *b)
1171 struct ls_data *d1 = *(struct ls_data **)a, *d2 = *(struct ls_data **)b;
1172 return NUM_COMPARE(d1->afsi.image_id, d2->afsi.image_id);
1175 static int ls_channels_compare(const void *a, const void *b)
1177 struct ls_data *d1 = *(struct ls_data **)a, *d2 = *(struct ls_data **)b;
1178 return NUM_COMPARE(d1->afhi.channels, d2->afhi.channels);
1181 static int ls_frequency_compare(const void *a, const void *b)
1183 struct ls_data *d1 = *(struct ls_data **)a, *d2 = *(struct ls_data **)b;
1184 return NUM_COMPARE(d1->afhi.frequency, d2->afhi.frequency);
1187 static int ls_num_played_compare(const void *a, const void *b)
1189 struct ls_data *d1 = *(struct ls_data **)a, *d2 = *(struct ls_data **)b;
1190 return NUM_COMPARE(d1->afsi.num_played, d2->afsi.num_played);
1193 static int ls_last_played_compare(const void *a, const void *b)
1195 struct ls_data *d1 = *(struct ls_data **)a, *d2 = *(struct ls_data **)b;
1196 return NUM_COMPARE(d1->afsi.last_played, d2->afsi.last_played);
1199 static int ls_score_compare(const void *a, const void *b)
1201 struct ls_data *d1 = *(struct ls_data **)a, *d2 = *(struct ls_data **)b;
1202 return NUM_COMPARE(d1->score, d2->score);
1205 static int ls_path_compare(const void *a, const void *b)
1207 struct ls_data *d1 = *(struct ls_data **)a, *d2 = *(struct ls_data **)b;
1208 return strcmp(d1->path, d2->path);
1211 static int sort_matching_paths(struct ls_options *options)
1213 size_t nmemb = options->num_matching_paths;
1214 size_t size = sizeof(*options->data_ptr);
1215 int (*compar)(const void *, const void *);
1218 options->data_ptr = para_malloc(nmemb * sizeof(*options->data_ptr));
1219 for (i = 0; i < nmemb; i++)
1220 options->data_ptr[i] = options->data + i;
1222 /* In these cases the array is already sorted */
1223 if (options->sorting == LS_SORT_BY_PATH
1224 && !(options->flags & LS_FLAG_ADMISSIBLE_ONLY)
1225 && (options->flags & LS_FLAG_FULL_PATH))
1227 if (options->sorting == LS_SORT_BY_SCORE &&
1228 options->flags & LS_FLAG_ADMISSIBLE_ONLY)
1231 switch (options->sorting) {
1232 case LS_SORT_BY_PATH:
1233 compar = ls_path_compare; break;
1234 case LS_SORT_BY_SCORE:
1235 compar = ls_score_compare; break;
1236 case LS_SORT_BY_LAST_PLAYED:
1237 compar = ls_last_played_compare; break;
1238 case LS_SORT_BY_NUM_PLAYED:
1239 compar = ls_num_played_compare; break;
1240 case LS_SORT_BY_FREQUENCY:
1241 compar = ls_frequency_compare; break;
1242 case LS_SORT_BY_CHANNELS:
1243 compar = ls_channels_compare; break;
1244 case LS_SORT_BY_IMAGE_ID:
1245 compar = ls_image_id_compare; break;
1246 case LS_SORT_BY_LYRICS_ID:
1247 compar = ls_lyrics_id_compare; break;
1248 case LS_SORT_BY_BITRATE:
1249 compar = ls_bitrate_compare; break;
1250 case LS_SORT_BY_DURATION:
1251 compar = ls_duration_compare; break;
1252 case LS_SORT_BY_AUDIO_FORMAT:
1253 compar = ls_audio_format_compare; break;
1257 qsort(options->data_ptr, nmemb, size, compar);
1261 /* row is either an aft_row or a row of the score table */
1262 /* TODO: Only compute widths if we need them */
1263 static int prepare_ls_row(struct osl_row *row, void *ls_opts)
1266 struct ls_options *options = ls_opts;
1268 struct ls_widths *w;
1269 unsigned short num_digits;
1271 struct osl_row *aft_row;
1275 if (options->flags & LS_FLAG_ADMISSIBLE_ONLY) {
1276 ret = get_score_and_aft_row(row, &score, &aft_row);
1283 ret = get_audio_file_path_of_row(aft_row, &path);
1286 if (!(options->flags & LS_FLAG_FULL_PATH)) {
1287 char *p = strrchr(path, '/');
1291 if (options->num_patterns) {
1292 for (i = 0; i < options->num_patterns; i++) {
1293 ret = fnmatch(options->patterns[i], path, 0);
1296 if (ret == FNM_NOMATCH)
1300 if (i >= options->num_patterns) /* no match */
1303 tmp = options->num_matching_paths++;
1304 if (options->num_matching_paths > options->array_size) {
1305 options->array_size++;
1306 options->array_size *= 2;
1307 options->data = para_realloc(options->data, options->array_size
1308 * sizeof(*options->data));
1310 d = options->data + tmp;
1311 ret = get_afsi_of_row(aft_row, &d->afsi);
1314 ret = get_afhi_of_row(aft_row, &d->afhi);
1318 ret = get_hash_of_row(aft_row, &d->hash);
1321 w = &options->widths;
1322 GET_NUM_DIGITS(d->afsi.image_id, &num_digits);
1323 w->image_id_width = PARA_MAX(w->image_id_width, num_digits);
1324 GET_NUM_DIGITS(d->afsi.lyrics_id, &num_digits);
1325 w->lyrics_id_width = PARA_MAX(w->lyrics_id_width, num_digits);
1326 GET_NUM_DIGITS(d->afhi.bitrate, &num_digits);
1327 w->bitrate_width = PARA_MAX(w->bitrate_width, num_digits);
1328 GET_NUM_DIGITS(d->afhi.frequency, &num_digits);
1329 w->frequency_width = PARA_MAX(w->frequency_width, num_digits);
1330 GET_NUM_DIGITS(d->afsi.num_played, &num_digits);
1331 w->num_played_width = PARA_MAX(w->num_played_width, num_digits);
1332 /* get the number of chars to print this amount of time */
1333 num_digits = get_duration_width(d->afhi.seconds_total);
1334 w->duration_width = PARA_MAX(w->duration_width, num_digits);
1335 GET_NUM_DIGITS(d->afsi.amp, &num_digits);
1336 w->amp_width = PARA_MAX(w->amp_width, num_digits);
1337 num_digits = strlen(audio_format_name(d->afsi.audio_format_id));
1338 w->audio_format_width = PARA_MAX(w->audio_format_width, num_digits);
1339 if (options->flags & LS_FLAG_ADMISSIBLE_ONLY) {
1340 GET_NUM_DIGITS(score, &num_digits);
1341 num_digits++; /* add one for the sign (space or "-") */
1342 w->score_width = PARA_MAX(w->score_width, num_digits);
1350 static void com_ls_callback(int fd, const struct osl_object *query)
1352 struct ls_options *opts = query->data;
1353 char *p, *pattern_start = (char *)query->data + sizeof(*opts);
1354 struct para_buffer b = {
1355 .max_size = shm_get_shmmax(),
1356 .flags = (opts->mode == LS_MODE_PARSER)? PBF_SIZE_PREFIX : 0,
1357 .max_size_handler = afs_max_size_handler,
1358 .private_data = &(struct afs_max_size_handler_data) {
1364 time_t current_time;
1366 if (opts->num_patterns) {
1367 opts->patterns = para_malloc(opts->num_patterns * sizeof(char *));
1368 for (i = 0, p = pattern_start; i < opts->num_patterns; i++) {
1369 opts->patterns[i] = p;
1373 opts->patterns = NULL;
1374 if (opts->flags & LS_FLAG_ADMISSIBLE_ONLY)
1375 ret = admissible_file_loop(opts, prepare_ls_row);
1377 ret = osl(osl_rbtree_loop(audio_file_table, AFTCOL_PATH, opts,
1381 if (opts->num_matching_paths == 0) {
1382 if (opts->num_patterns > 0)
1383 para_printf(&b, "no matches\n");
1386 ret = sort_matching_paths(opts);
1389 time(¤t_time);
1390 if (opts->flags & LS_FLAG_REVERSE)
1391 for (i = opts->num_matching_paths - 1; i >= 0; i--) {
1392 ret = print_list_item(opts->data_ptr[i], opts, &b, current_time);
1397 for (i = 0; i < opts->num_matching_paths; i++) {
1398 ret = print_list_item(opts->data_ptr[i], opts, &b, current_time);
1404 pass_buffer_as_shm(fd, SBD_OUTPUT, b.buf, b.offset);
1407 free(opts->data_ptr);
1408 free(opts->patterns);
1412 * TODO: flags -h (sort by hash)
1414 int com_ls(struct command_context *cc)
1418 enum ls_sorting_method sort = LS_SORT_BY_PATH;
1419 enum ls_listing_mode mode = LS_MODE_SHORT;
1420 struct ls_options opts = {.patterns = NULL};
1421 struct osl_object query = {.data = &opts, .size = sizeof(opts)};
1423 for (i = 1; i < cc->argc; i++) {
1424 const char *arg = cc->argv[i];
1427 if (!strcmp(arg, "--")) {
1431 if (!strncmp(arg, "-l", 2)) {
1433 mode = LS_MODE_LONG;
1437 return -E_AFT_SYNTAX;
1438 switch(*(arg + 2)) {
1440 mode = LS_MODE_SHORT;
1443 mode = LS_MODE_LONG;
1446 mode = LS_MODE_VERBOSE;
1449 mode = LS_MODE_MBOX;
1452 mode = LS_MODE_CHUNKS;
1455 mode = LS_MODE_PARSER;
1458 return -E_AFT_SYNTAX;
1461 if (!strcmp(arg, "-p")) {
1462 flags |= LS_FLAG_FULL_PATH;
1465 if (!strcmp(arg, "-a")) {
1466 flags |= LS_FLAG_ADMISSIBLE_ONLY;
1469 if (!strcmp(arg, "-r")) {
1470 flags |= LS_FLAG_REVERSE;
1473 if (!strcmp(arg, "-d")) {
1474 flags |= LS_FLAG_UNIXDATE;
1477 if (!strncmp(arg, "-s", 2)) {
1478 if (!*(arg + 2) || *(arg + 3))
1479 return -E_AFT_SYNTAX;
1480 switch(*(arg + 2)) {
1482 sort = LS_SORT_BY_PATH;
1484 case 's': /* -ss implies -a */
1485 sort = LS_SORT_BY_SCORE;
1486 flags |= LS_FLAG_ADMISSIBLE_ONLY;
1489 sort = LS_SORT_BY_LAST_PLAYED;
1492 sort = LS_SORT_BY_NUM_PLAYED;
1495 sort = LS_SORT_BY_FREQUENCY;
1498 sort = LS_SORT_BY_CHANNELS;
1501 sort = LS_SORT_BY_IMAGE_ID;
1504 sort = LS_SORT_BY_LYRICS_ID;
1507 sort = LS_SORT_BY_BITRATE;
1510 sort = LS_SORT_BY_DURATION;
1513 sort = LS_SORT_BY_AUDIO_FORMAT;
1516 return -E_AFT_SYNTAX;
1519 return -E_AFT_SYNTAX;
1522 opts.sorting = sort;
1524 opts.num_patterns = cc->argc - i;
1525 ret = send_option_arg_callback_request(&query, opts.num_patterns,
1526 cc->argv + i, com_ls_callback, afs_cb_result_handler, cc);
1531 * Call the given function for each file in the audio file table.
1533 * \param private_data An arbitrary data pointer, passed to \a func.
1534 * \param func The custom function to be called.
1538 int audio_file_loop(void *private_data, osl_rbtree_loop_func *func)
1540 return osl(osl_rbtree_loop(audio_file_table, AFTCOL_HASH, private_data,
1544 static struct osl_row *find_hash_sister(unsigned char *hash)
1546 const struct osl_object obj = {.data = hash, .size = HASH_SIZE};
1547 struct osl_row *row;
1549 osl_get_row(audio_file_table, AFTCOL_HASH, &obj, &row);
1553 /** The format of the data stored by save_audio_file_data(). */
1554 enum com_add_buffer_offsets {
1555 /** afhi (if present) starts here. */
1556 CAB_AFHI_OFFSET_POS = 0,
1557 /** Start of the chunk table (if present). */
1558 CAB_CHUNKS_OFFSET_POS = 2,
1559 /** Audio format id. */
1560 CAB_AUDIO_FORMAT_OFFSET = 4,
1561 /** Flags given to the add command. */
1562 CAB_FLAGS_OFFSET = 5,
1563 /** The hash of the audio file being added. */
1564 CAB_HASH_OFFSET = 9,
1565 /** Start of the path of the audio file. */
1566 CAB_PATH_OFFSET = (CAB_HASH_OFFSET + HASH_SIZE),
1570 * Store the given data to a single buffer. Doesn't need the audio file selector
1571 * info struct as the server knows it as well.
1573 * It's OK to call this with afhi == NULL. In this case, the audio format
1574 * handler info won't be stored in the buffer.
1576 static void save_add_callback_buffer(unsigned char *hash, const char *path,
1577 struct afh_info *afhi, uint32_t flags,
1578 uint8_t audio_format_num, struct osl_object *obj)
1580 size_t path_len = strlen(path) + 1;
1581 size_t afhi_size = sizeof_afhi_buf(afhi);
1582 size_t size = CAB_PATH_OFFSET + path_len + afhi_size
1583 + sizeof_chunk_table(afhi);
1584 char *buf = para_malloc(size);
1587 write_u8(buf + CAB_AUDIO_FORMAT_OFFSET, audio_format_num);
1588 write_u32(buf + CAB_FLAGS_OFFSET, flags);
1590 memcpy(buf + CAB_HASH_OFFSET, hash, HASH_SIZE);
1591 strcpy(buf + CAB_PATH_OFFSET, path);
1593 pos = CAB_PATH_OFFSET + path_len;
1594 PARA_DEBUG_LOG("size: %zu, afhi starts at %d\n", size, pos);
1595 PARA_DEBUG_LOG("last afhi byte: %p, pos %zu\n", buf + pos + afhi_size - 1,
1596 pos + afhi_size - 1);
1597 write_u16(buf + CAB_AFHI_OFFSET_POS, pos);
1598 save_afhi(afhi, buf + pos);
1601 PARA_DEBUG_LOG("size: %zu, chunks start at %d\n", size, pos);
1602 write_u16(buf + CAB_CHUNKS_OFFSET_POS, pos);
1604 save_chunk_table(afhi, buf + pos);
1605 PARA_DEBUG_LOG("last byte in buf: %p\n", buf + size - 1);
1612 Overview of the add command.
1614 Input: What was passed to the callback by the command handler.
1616 HS: Hash sister. Whether an audio file with identical hash
1617 already exists in the osl database.
1619 PB: Path brother. Whether a file with the given path exists
1622 F: Force flag given. Whether add was called with -f.
1624 output: Action performed by the callback.
1626 AFHI: Whether afhi and chunk table are computed and sent.
1627 ACTION: Table modifications to be done by the callback.
1629 +----+----+---+------+---------------------------------------------------+
1630 | HS | PB | F | AFHI | ACTION
1631 +----+----+---+------+---------------------------------------------------+
1632 | Y | Y | Y | Y | if HS != PB: remove PB. HS: force afhi update,
1633 | | update path, keep afsi
1634 +----+----+---+------+---------------------------------------------------+
1635 | Y | Y | N | N | if HS == PB: do not send callback request at all.
1636 | | otherwise: remove PB, HS: update path, keep afhi,
1638 +----+----+---+------+---------------------------------------------------+
1639 | Y | N | Y | Y | (rename) force afhi update of HS, update path of
1641 +----+----+---+------+---------------------------------------------------+
1642 | Y | N | N | N | (file rename) update path of HS, keep afsi, afhi
1643 +----+----+---+------+---------------------------------------------------+
1644 | N | Y | Y | Y | (file change) update afhi, hash, of PB, keep afsi
1645 | | (force has no effect)
1646 +----+----+---+------+---------------------------------------------------+
1647 | N | Y | N | Y | (file change) update afhi, hash of PB, keep afsi
1648 +----+----+---+------+---------------------------------------------------+
1649 | N | N | Y | Y | (new file) create new entry (force has no effect)
1650 +----+----+---+------+---------------------------------------------------+
1651 | N | N | N | Y | (new file) create new entry
1652 +----+----+---+------+---------------------------------------------------+
1656 afhi <=> force or no HS
1661 /** Flags passed to the add command. */
1662 enum com_add_flags {
1663 /** Skip paths that exist already. */
1665 /** Force adding. */
1667 /** Print what is being done. */
1668 ADD_FLAG_VERBOSE = 4,
1669 /** Try to add files with unknown suffixes. */
1673 static void com_add_callback(int fd, const struct osl_object *query)
1675 char *buf = query->data, *path;
1676 struct osl_row *pb, *aft_row;
1678 struct osl_object objs[NUM_AFT_COLUMNS];
1679 unsigned char *hash;
1680 char asc[2 * HASH_SIZE + 1];
1682 char afsi_buf[AFSI_SIZE];
1683 uint32_t flags = read_u32(buf + CAB_FLAGS_OFFSET);
1684 struct afs_info default_afsi = {.last_played = 0};
1685 struct para_buffer msg = {
1686 .max_size = shm_get_shmmax(),
1687 .max_size_handler = afs_max_size_handler,
1688 .private_data = &(struct afs_max_size_handler_data) {
1693 uint16_t afhi_offset, chunks_offset;
1695 hash = (unsigned char *)buf + CAB_HASH_OFFSET;
1696 hash_to_asc(hash, asc);
1697 objs[AFTCOL_HASH].data = buf + CAB_HASH_OFFSET;
1698 objs[AFTCOL_HASH].size = HASH_SIZE;
1700 path = buf + CAB_PATH_OFFSET;
1701 objs[AFTCOL_PATH].data = path;
1702 objs[AFTCOL_PATH].size = strlen(path) + 1;
1704 PARA_INFO_LOG("request to add %s\n", path);
1705 hs = find_hash_sister(hash);
1706 ret = aft_get_row_of_path(path, &pb);
1707 if (ret < 0 && ret != -OSL_ERRNO_TO_PARA_ERROR(E_OSL_RB_KEY_NOT_FOUND))
1709 if (hs && pb && hs == pb && !(flags & ADD_FLAG_FORCE)) {
1710 if (flags & ADD_FLAG_VERBOSE)
1711 ret = para_printf(&msg, "ignoring duplicate\n");
1716 if (hs && hs != pb) {
1717 struct osl_object obj;
1718 if (pb) { /* hs trumps pb, remove pb */
1719 if (flags & ADD_FLAG_VERBOSE) {
1720 ret = para_printf(&msg, "removing path brother\n");
1724 ret = osl(osl_del_row(audio_file_table, pb));
1729 /* file rename, update hs' path */
1730 if (flags & ADD_FLAG_VERBOSE) {
1731 ret = osl(osl_get_object(audio_file_table, hs,
1732 AFTCOL_PATH, &obj));
1735 ret = para_printf(&msg, "renamed from %s\n", (char *)obj.data);
1739 ret = osl(osl_update_object(audio_file_table, hs, AFTCOL_PATH,
1740 &objs[AFTCOL_PATH]));
1743 afs_event(AUDIO_FILE_RENAME, &msg, hs);
1744 if (!(flags & ADD_FLAG_FORCE))
1747 /* no hs or force mode, child must have sent afhi */
1748 afhi_offset = read_u16(buf + CAB_AFHI_OFFSET_POS);
1749 chunks_offset = read_u16(buf + CAB_CHUNKS_OFFSET_POS);
1751 objs[AFTCOL_AFHI].data = buf + afhi_offset;
1752 objs[AFTCOL_AFHI].size = chunks_offset - afhi_offset;
1754 if (!objs[AFTCOL_AFHI].size) /* "impossible" */
1756 objs[AFTCOL_CHUNKS].data = buf + chunks_offset;
1757 objs[AFTCOL_CHUNKS].size = query->size - chunks_offset;
1758 if (pb && !hs) { /* update pb's hash */
1759 char old_asc[2 * HASH_SIZE + 1];
1760 unsigned char *old_hash;
1761 ret = get_hash_of_row(pb, &old_hash);
1764 hash_to_asc(old_hash, old_asc);
1765 if (flags & ADD_FLAG_VERBOSE) {
1766 ret = para_printf(&msg, "file change: %s -> %s\n",
1771 ret = osl_update_object(audio_file_table, pb, AFTCOL_HASH,
1772 &objs[AFTCOL_HASH]);
1776 if (hs || pb) { /* (hs != NULL and pb != NULL) implies hs == pb */
1777 struct osl_row *row = pb? pb : hs;
1778 /* update afhi and chunk_table */
1779 if (flags & ADD_FLAG_VERBOSE) {
1780 ret = para_printf(&msg, "updating afhi and chunk table\n");
1784 ret = osl(osl_update_object(audio_file_table, row, AFTCOL_AFHI,
1785 &objs[AFTCOL_AFHI]));
1788 ret = osl(osl_update_object(audio_file_table, row, AFTCOL_CHUNKS,
1789 &objs[AFTCOL_CHUNKS]));
1792 afs_event(AFHI_CHANGE, &msg, row);
1795 /* new entry, use default afsi */
1796 if (flags & ADD_FLAG_VERBOSE) {
1797 ret = para_printf(&msg, "new file\n");
1801 default_afsi.last_played = time(NULL) - 365 * 24 * 60 * 60;
1802 default_afsi.audio_format_id = read_u8(buf + CAB_AUDIO_FORMAT_OFFSET);
1804 objs[AFTCOL_AFSI].data = &afsi_buf;
1805 objs[AFTCOL_AFSI].size = AFSI_SIZE;
1806 save_afsi(&default_afsi, &objs[AFTCOL_AFSI]);
1807 ret = osl(osl_add_and_get_row(audio_file_table, objs, &aft_row));
1808 afs_event(AUDIO_FILE_ADD, &msg, aft_row);
1811 para_printf(&msg, "%s\n", para_strerror(-ret));
1813 pass_buffer_as_shm(fd, SBD_OUTPUT, msg.buf, msg.offset);
1817 /** Used by com_add(). */
1818 struct private_add_data {
1819 /** The pointer passed to the original command handler. */
1820 struct command_context *cc;
1821 /** The given add flags. */
1825 static void path_brother_callback(int fd, const struct osl_object *query)
1827 char *path = query->data;
1828 struct osl_row *path_brother;
1829 int ret = aft_get_row_of_path(path, &path_brother);
1832 pass_buffer_as_shm(fd, SBD_OUTPUT, (char *)&path_brother,
1833 sizeof(path_brother));
1836 static void hash_sister_callback(int fd, const struct osl_object *query)
1838 unsigned char *hash = query->data;
1839 struct osl_row *hash_sister;
1841 hash_sister = find_hash_sister(hash);
1844 pass_buffer_as_shm(fd, SBD_OUTPUT, (char *)&hash_sister,
1845 sizeof(hash_sister));
1848 static int get_row_pointer_from_result(struct osl_object *result,
1849 __a_unused uint8_t band, void *private)
1851 struct osl_row **row = private;
1852 *row = *(struct osl_row **)(result->data);
1856 static int add_one_audio_file(const char *path, void *private_data)
1858 int ret, send_ret = 1, fd;
1859 uint8_t format_num = -1;
1860 struct private_add_data *pad = private_data;
1861 struct afh_info afhi, *afhi_ptr = NULL;
1862 struct osl_row *pb = NULL, *hs = NULL; /* path brother/hash sister */
1863 struct osl_object map, obj = {.data = NULL}, query;
1864 unsigned char hash[HASH_SIZE];
1866 ret = guess_audio_format(path);
1867 if (ret < 0 && !(pad->flags & ADD_FLAG_ALL))
1869 query.data = (char *)path;
1870 query.size = strlen(path) + 1;
1871 ret = send_callback_request(path_brother_callback, &query,
1872 get_row_pointer_from_result, &pb);
1873 if (ret < 0 && ret != -OSL_ERRNO_TO_PARA_ERROR(E_OSL_RB_KEY_NOT_FOUND))
1876 if (pb && (pad->flags & ADD_FLAG_LAZY)) { /* lazy is really cheap */
1877 if (pad->flags & ADD_FLAG_VERBOSE)
1878 send_ret = send_sb_va(&pad->cc->scc, SBD_OUTPUT,
1879 "lazy-ignore: %s\n", path);
1882 /* We still want to add this file. Compute its hash. */
1883 ret = mmap_full_file(path, O_RDONLY, &map.data, &map.size, &fd);
1886 hash_function(map.data, map.size, hash);
1888 /* Check whether the database contains a file with the same hash. */
1890 query.size = HASH_SIZE;
1891 ret = send_callback_request(hash_sister_callback, &query,
1892 get_row_pointer_from_result, &hs);
1895 /* Return success if we already know this file. */
1897 if (pb && hs && hs == pb && !(pad->flags & ADD_FLAG_FORCE)) {
1898 if (pad->flags & ADD_FLAG_VERBOSE)
1899 send_ret = send_sb_va(&pad->cc->scc, SBD_OUTPUT,
1900 "%s exists, not forcing update\n", path);
1904 * We won't recalculate the audio format info and the chunk table if
1905 * there is a hash sister and FORCE was not given.
1907 if (!hs || (pad->flags & ADD_FLAG_FORCE)) {
1908 ret = compute_afhi(path, map.data, map.size, fd, &afhi);
1914 munmap(map.data, map.size);
1916 if (pad->flags & ADD_FLAG_VERBOSE) {
1917 send_ret = send_sb_va(&pad->cc->scc, SBD_OUTPUT,
1918 "adding %s\n", path);
1922 save_add_callback_buffer(hash, path, afhi_ptr, pad->flags, format_num, &obj);
1923 /* Ask afs to consider this entry for adding. */
1924 ret = send_callback_request(com_add_callback, &obj,
1925 afs_cb_result_handler, pad->cc);
1930 munmap(map.data, map.size);
1932 if (ret < 0 && send_ret >= 0)
1933 send_ret = send_sb_va(&pad->cc->scc, SBD_ERROR_LOG,
1934 "failed to add %s (%s)\n", path, para_strerror(-ret));
1936 clear_afhi(afhi_ptr);
1937 /* Stop adding files only on send errors. */
1941 int com_add(struct command_context *cc)
1944 struct private_add_data pad = {.cc = cc, .flags = 0};
1945 struct stat statbuf;
1947 for (i = 1; i < cc->argc; i++) {
1948 const char *arg = cc->argv[i];
1951 if (!strcmp(arg, "--")) {
1955 if (!strcmp(arg, "-a")) {
1956 pad.flags |= ADD_FLAG_ALL;
1959 if (!strcmp(arg, "-l")) {
1960 pad.flags |= ADD_FLAG_LAZY;
1963 if (!strcmp(arg, "-f")) {
1964 pad.flags |= ADD_FLAG_FORCE;
1967 if (!strcmp(arg, "-v")) {
1968 pad.flags |= ADD_FLAG_VERBOSE;
1973 return -E_AFT_SYNTAX;
1974 for (; i < cc->argc; i++) {
1976 ret = verify_path(cc->argv[i], &path);
1978 ret = send_sb_va(&cc->scc, SBD_ERROR_LOG, "%s: %s\n",
1979 cc->argv[i], para_strerror(-ret));
1984 ret = stat(path, &statbuf);
1986 ret = send_sb_va(&cc->scc, SBD_ERROR_LOG,
1987 "failed to stat %s (%s)\n", path,
1994 if (S_ISDIR(statbuf.st_mode))
1995 ret = for_each_file_in_dir(path, add_one_audio_file,
1998 ret = add_one_audio_file(path, &pad);
2000 send_sb_va(&cc->scc, SBD_OUTPUT, "%s: %s\n", path,
2001 para_strerror(-ret));
2011 * Flags used by the touch command.
2016 /** Whether the \p FNM_PATHNAME flag should be passed to fnmatch(). */
2017 TOUCH_FLAG_FNM_PATHNAME = 1,
2018 /** Activates verbose mode. */
2019 TOUCH_FLAG_VERBOSE = 2
2022 /** Options used by com_touch(). */
2023 struct com_touch_options {
2024 /** New num_played value. */
2026 /** New last played count. */
2027 int64_t last_played;
2028 /** New lyrics id. */
2030 /** New image id. */
2032 /** New amplification value. */
2034 /** Command line flags (see \ref touch_flags). */
2038 /** Data passed to the action handler of com_touch(). */
2039 struct touch_action_data {
2040 /** Command line options (see \ref com_touch_options). */
2041 struct com_touch_options *cto;
2042 /** Message buffer. */
2043 struct para_buffer pb;
2046 static int touch_audio_file(__a_unused struct osl_table *table,
2047 struct osl_row *row, const char *name, void *data)
2049 struct touch_action_data *tad = data;
2050 struct osl_object obj;
2051 struct afs_info old_afsi, new_afsi;
2052 int ret, no_options = tad->cto->num_played < 0 && tad->cto->last_played < 0 &&
2053 tad->cto->lyrics_id < 0 && tad->cto->image_id < 0 && tad->cto->amp < 0;
2054 struct afsi_change_event_data aced;
2056 ret = get_afsi_object_of_row(row, &obj);
2058 return para_printf(&tad->pb, "%s: %s\n", name, para_strerror(-ret));
2059 ret = load_afsi(&old_afsi, &obj);
2061 return para_printf(&tad->pb, "%s: %s\n", name, para_strerror(-ret));
2062 new_afsi = old_afsi;
2064 new_afsi.num_played++;
2065 new_afsi.last_played = time(NULL);
2066 if (tad->cto->flags & TOUCH_FLAG_VERBOSE) {
2067 ret = para_printf(&tad->pb, "%s: num_played = %u, "
2068 "last_played = now()\n", name,
2069 new_afsi.num_played);
2074 if (tad->cto->flags & TOUCH_FLAG_VERBOSE) {
2075 ret = para_printf(&tad->pb, "touching %s\n", name);
2079 if (tad->cto->lyrics_id >= 0)
2080 new_afsi.lyrics_id = tad->cto->lyrics_id;
2081 if (tad->cto->image_id >= 0)
2082 new_afsi.image_id = tad->cto->image_id;
2083 if (tad->cto->num_played >= 0)
2084 new_afsi.num_played = tad->cto->num_played;
2085 if (tad->cto->last_played >= 0)
2086 new_afsi.last_played = tad->cto->last_played;
2087 if (tad->cto->amp >= 0)
2088 new_afsi.amp = tad->cto->amp;
2090 save_afsi(&new_afsi, &obj); /* in-place update */
2092 aced.old_afsi = &old_afsi;
2093 afs_event(AFSI_CHANGE, &tad->pb, &aced);
2097 static void com_touch_callback(int fd, const struct osl_object *query)
2099 struct touch_action_data tad = {.cto = query->data,
2101 .max_size = shm_get_shmmax(),
2102 .private_data = &fd,
2103 .max_size_handler = afs_max_size_handler
2107 struct pattern_match_data pmd = {
2108 .table = audio_file_table,
2109 .loop_col_num = AFTCOL_HASH,
2110 .match_col_num = AFTCOL_PATH,
2111 .patterns = {.data = (char *)query->data + sizeof(*tad.cto),
2112 .size = query->size - sizeof(*tad.cto)},
2114 .action = touch_audio_file
2116 if (tad.cto->flags & TOUCH_FLAG_FNM_PATHNAME)
2117 pmd.fnmatch_flags |= FNM_PATHNAME;
2118 ret = for_each_matching_row(&pmd);
2120 ret2 = para_printf(&tad.pb, "%s\n", para_strerror(-ret));
2121 else if (pmd.num_matches == 0)
2122 ret2 = para_printf(&tad.pb, "no matches\n");
2123 if (ret2 >= 0 && tad.pb.offset)
2124 pass_buffer_as_shm(fd, SBD_OUTPUT, tad.pb.buf, tad.pb.offset);
2128 int com_touch(struct command_context *cc)
2130 struct com_touch_options cto = {
2137 struct osl_object query = {.data = &cto, .size = sizeof(cto)};
2141 for (i = 1; i < cc->argc; i++) {
2142 const char *arg = cc->argv[i];
2145 if (!strcmp(arg, "--")) {
2149 if (!strncmp(arg, "-n=", 3)) {
2150 ret = para_atoi32(arg + 3, &cto.num_played);
2155 if (!strncmp(arg, "-l=", 3)) {
2156 ret = para_atoi64(arg + 3, &cto.last_played);
2161 if (!strncmp(arg, "-y=", 3)) {
2162 ret = para_atoi32(arg + 3, &cto.lyrics_id);
2167 if (!strncmp(arg, "-i=", 3)) {
2168 ret = para_atoi32(arg + 3, &cto.image_id);
2173 if (!strncmp(arg, "-a=", 3)) {
2175 ret = para_atoi32(arg + 3, &val);
2178 if (val < 0 || val > 255)
2179 return -ERRNO_TO_PARA_ERROR(EINVAL);
2183 if (!strcmp(arg, "-p")) {
2184 cto.flags |= TOUCH_FLAG_FNM_PATHNAME;
2187 if (!strcmp(arg, "-v")) {
2188 cto.flags |= TOUCH_FLAG_VERBOSE;
2191 break; /* non-option starting with dash */
2194 return -E_AFT_SYNTAX;
2195 ret = send_option_arg_callback_request(&query, cc->argc - i,
2196 cc->argv + i, com_touch_callback, afs_cb_result_handler, cc);
2198 send_strerror(cc, -ret);
2202 /** Flags for com_rm(). */
2205 RM_FLAG_VERBOSE = 1,
2209 RM_FLAG_FNM_PATHNAME = 4
2212 /** Data passed to the action handler of com_rm(). */
2213 struct com_rm_action_data {
2214 /** Command line flags ((see \ref rm_flags). */
2216 /** Message buffer. */
2217 struct para_buffer pb;
2220 static int remove_audio_file(__a_unused struct osl_table *table,
2221 struct osl_row *row, const char *name, void *data)
2223 struct com_rm_action_data *crd = data;
2226 if (crd->flags & RM_FLAG_VERBOSE) {
2227 ret = para_printf(&crd->pb, "removing %s\n", name);
2231 afs_event(AUDIO_FILE_REMOVE, &crd->pb, row);
2232 ret = osl(osl_del_row(audio_file_table, row));
2234 para_printf(&crd->pb, "%s: %s\n", name, para_strerror(-ret));
2238 static void com_rm_callback(int fd, const struct osl_object *query)
2240 struct com_rm_action_data crd = {.flags = *(uint32_t *)query->data,
2242 .max_size = shm_get_shmmax(),
2243 .private_data = &fd,
2244 .max_size_handler = afs_max_size_handler
2248 struct pattern_match_data pmd = {
2249 .table = audio_file_table,
2250 .loop_col_num = AFTCOL_HASH,
2251 .match_col_num = AFTCOL_PATH,
2252 .patterns = {.data = (char *)query->data + sizeof(uint32_t),
2253 .size = query->size - sizeof(uint32_t)},
2255 .action = remove_audio_file
2257 if (crd.flags & RM_FLAG_FNM_PATHNAME)
2258 pmd.fnmatch_flags |= FNM_PATHNAME;
2259 ret = for_each_matching_row(&pmd);
2261 para_printf(&crd.pb, "%s\n", para_strerror(-ret));
2264 if ((pmd.num_matches == 0) && !(crd.flags & RM_FLAG_FORCE))
2265 ret = para_printf(&crd.pb, "no matches -- nothing removed\n");
2266 else if (crd.flags & RM_FLAG_VERBOSE) {
2267 ret = para_printf(&crd.pb, "removed %u files\n",
2270 if (ret >= 0 && crd.pb.offset)
2271 pass_buffer_as_shm(fd, SBD_OUTPUT, crd.pb.buf, crd.pb.offset);
2275 /* TODO options: -r (recursive) */
2276 int com_rm(struct command_context *cc)
2279 struct osl_object query = {.data = &flags, .size = sizeof(flags)};
2282 for (i = 1; i < cc->argc; i++) {
2283 const char *arg = cc->argv[i];
2286 if (!strcmp(arg, "--")) {
2290 if (!strcmp(arg, "-f")) {
2291 flags |= RM_FLAG_FORCE;
2294 if (!strcmp(arg, "-p")) {
2295 flags |= RM_FLAG_FNM_PATHNAME;
2298 if (!strcmp(arg, "-v")) {
2299 flags |= RM_FLAG_VERBOSE;
2305 return -E_AFT_SYNTAX;
2306 ret = send_option_arg_callback_request(&query, cc->argc - i,
2307 cc->argv + i, com_rm_callback, afs_cb_result_handler, cc);
2309 send_strerror(cc, -ret);
2314 * Flags used by the cpsi command.
2319 /** Whether the lyrics id should be copied. */
2320 CPSI_FLAG_COPY_LYRICS_ID = 1,
2321 /** Whether the image id should be copied. */
2322 CPSI_FLAG_COPY_IMAGE_ID = 2,
2323 /** Whether the lastplayed time should be copied. */
2324 CPSI_FLAG_COPY_LASTPLAYED = 4,
2325 /** Whether the numplayed count should be copied. */
2326 CPSI_FLAG_COPY_NUMPLAYED = 8,
2327 /** Whether the attributes should be copied. */
2328 CPSI_FLAG_COPY_ATTRIBUTES = 16,
2329 /** Activates verbose mode. */
2330 CPSI_FLAG_VERBOSE = 32,
2333 /** Data passed to the action handler of com_cpsi(). */
2334 struct cpsi_action_data {
2335 /** command line flags (see \ref cpsi_flags). */
2337 /** Message buffer. */
2338 struct para_buffer pb;
2339 /** Values are copied from here. */
2340 struct afs_info source_afsi;
2343 static int copy_selector_info(__a_unused struct osl_table *table,
2344 struct osl_row *row, const char *name, void *data)
2346 struct cpsi_action_data *cad = data;
2347 struct osl_object target_afsi_obj;
2349 struct afs_info old_afsi, target_afsi;
2350 struct afsi_change_event_data aced;
2352 ret = get_afsi_object_of_row(row, &target_afsi_obj);
2355 load_afsi(&target_afsi, &target_afsi_obj);
2356 old_afsi = target_afsi;
2357 if (cad->flags & CPSI_FLAG_COPY_LYRICS_ID)
2358 target_afsi.lyrics_id = cad->source_afsi.lyrics_id;
2359 if (cad->flags & CPSI_FLAG_COPY_IMAGE_ID)
2360 target_afsi.image_id = cad->source_afsi.image_id;
2361 if (cad->flags & CPSI_FLAG_COPY_LASTPLAYED)
2362 target_afsi.last_played = cad->source_afsi.last_played;
2363 if (cad->flags & CPSI_FLAG_COPY_NUMPLAYED)
2364 target_afsi.num_played = cad->source_afsi.num_played;
2365 if (cad->flags & CPSI_FLAG_COPY_ATTRIBUTES)
2366 target_afsi.attributes = cad->source_afsi.attributes;
2367 save_afsi(&target_afsi, &target_afsi_obj); /* in-place update */
2368 if (cad->flags & CPSI_FLAG_VERBOSE) {
2369 ret = para_printf(&cad->pb, "copied afsi to %s\n", name);
2374 aced.old_afsi = &old_afsi;
2375 afs_event(AFSI_CHANGE, &cad->pb, &aced);
2379 static void com_cpsi_callback(int fd, const struct osl_object *query)
2381 struct cpsi_action_data cad = {
2382 .flags = *(unsigned *)query->data,
2384 .max_size = shm_get_shmmax(),
2385 .private_data = &fd,
2386 .max_size_handler = afs_max_size_handler
2390 char *source_path = (char *)query->data + sizeof(cad.flags);
2391 struct pattern_match_data pmd = {
2392 .table = audio_file_table,
2393 .loop_col_num = AFTCOL_HASH,
2394 .match_col_num = AFTCOL_PATH,
2395 .patterns = {.data = source_path + strlen(source_path) + 1,
2396 .size = query->size - sizeof(cad.flags)
2397 - strlen(source_path) - 1},
2399 .action = copy_selector_info
2402 ret = get_afsi_of_path(source_path, &cad.source_afsi);
2405 ret = for_each_matching_row(&pmd);
2408 para_printf(&cad.pb, "%s\n", para_strerror(-ret));
2409 else if (pmd.num_matches > 0) {
2410 if (cad.flags & CPSI_FLAG_VERBOSE)
2411 para_printf(&cad.pb, "copied requested afsi from %s "
2412 "to %u files\n", source_path, pmd.num_matches);
2414 para_printf(&cad.pb, "no matches - nothing copied\n");
2416 pass_buffer_as_shm(fd, SBD_OUTPUT, cad.pb.buf, cad.pb.offset);
2420 int com_cpsi(struct command_context *cc)
2424 struct osl_object options = {.data = &flags, .size = sizeof(flags)};
2426 for (i = 1; i < cc->argc; i++) {
2427 const char *arg = cc->argv[i];
2430 if (!strcmp(arg, "--")) {
2434 if (!strcmp(arg, "-y")) {
2435 flags |= CPSI_FLAG_COPY_LYRICS_ID;
2438 if (!strcmp(arg, "-i")) {
2439 flags |= CPSI_FLAG_COPY_IMAGE_ID;
2442 if (!strcmp(arg, "-l")) {
2443 flags |= CPSI_FLAG_COPY_LASTPLAYED;
2446 if (!strcmp(arg, "-n")) {
2447 flags |= CPSI_FLAG_COPY_NUMPLAYED;
2450 if (!strcmp(arg, "-a")) {
2451 flags |= CPSI_FLAG_COPY_ATTRIBUTES;
2454 if (!strcmp(arg, "-v")) {
2455 flags |= CPSI_FLAG_VERBOSE;
2460 if (i + 1 >= cc->argc) /* need at least source file and pattern */
2461 return -E_AFT_SYNTAX;
2462 if (!(flags & ~CPSI_FLAG_VERBOSE)) /* no copy flags given */
2463 flags = ~(unsigned)CPSI_FLAG_VERBOSE | flags;
2464 ret = send_option_arg_callback_request(&options, cc->argc - i,
2465 cc->argv + i, com_cpsi_callback, afs_cb_result_handler, cc);
2467 send_strerror(cc, -ret);
2471 struct change_atts_data {
2472 uint64_t add_mask, del_mask;
2473 struct para_buffer pb;
2476 static int change_atts(__a_unused struct osl_table *table,
2477 struct osl_row *row, __a_unused const char *name, void *data)
2480 struct osl_object obj;
2481 struct afs_info old_afsi, new_afsi;
2482 struct afsi_change_event_data aced = {
2484 .old_afsi = &old_afsi
2486 struct change_atts_data *cad = data;
2488 ret = get_afsi_object_of_row(row, &obj);
2491 ret = load_afsi(&old_afsi, &obj);
2494 new_afsi = old_afsi;
2495 new_afsi.attributes |= cad->add_mask;
2496 new_afsi.attributes &= ~cad->del_mask;
2497 save_afsi(&new_afsi, &obj); /* in-place update */
2498 afs_event(AFSI_CHANGE, &cad->pb, &aced);
2502 static void com_setatt_callback(int fd, const struct osl_object *query)
2507 struct change_atts_data cad = {
2509 .max_size = shm_get_shmmax(),
2510 .max_size_handler = afs_max_size_handler,
2511 .private_data = &(struct afs_max_size_handler_data) {
2517 struct pattern_match_data pmd = {
2518 .table = audio_file_table,
2519 .loop_col_num = AFTCOL_HASH,
2520 .match_col_num = AFTCOL_PATH,
2521 .pm_flags = PM_SKIP_EMPTY_NAME,
2523 .action = change_atts
2526 for (p = query->data; p < (char *)query->data + query->size; p += len + 1) {
2528 unsigned char bitnum;
2531 ret = -E_ATTR_SYNTAX;
2535 if (c != '+' && c != '-')
2538 ret = get_attribute_bitnum_by_name(p, &bitnum);
2542 cad.add_mask |= (1UL << bitnum);
2544 cad.del_mask |= (1UL << bitnum);
2546 ret = -E_ATTR_SYNTAX;
2547 if (!cad.add_mask && !cad.del_mask)
2549 pmd.patterns.data = p;
2550 assert(p < (char *)query->data + query->size);
2551 pmd.patterns.size = (char *)query->data + query->size - p;
2552 ret = for_each_matching_row(&pmd);
2555 if (pmd.num_matches == 0)
2556 para_printf(&cad.pb, "no matches\n");
2559 para_printf(&cad.pb, "%s\n", para_strerror(-ret));
2561 pass_buffer_as_shm(fd, SBD_OUTPUT, cad.pb.buf, cad.pb.offset);
2565 int com_setatt(struct command_context *cc)
2568 return -E_ATTR_SYNTAX;
2569 return send_standard_callback_request(cc->argc - 1, cc->argv + 1,
2570 com_setatt_callback, afs_cb_result_handler, cc);
2573 static void afs_stat_callback(int fd, const struct osl_object *query)
2575 int *parser_friendly = query->data;
2576 char *buf = *parser_friendly?
2577 parser_friendly_status_items : status_items;
2581 pass_buffer_as_shm(fd, SBD_OUTPUT, buf, strlen(buf));
2585 * Get the current afs status items from the afs process and send it.
2587 * \param cc The command context, used e.g. for data encryption.
2588 * \param parser_friendly Whether parser-friendly output format should be used.
2590 * As the contents of the afs status items change in time and the command
2591 * handler only has a COW version created at fork time, it can not send
2592 * up-to-date afs status items directly. Therefore the usual callback mechanism
2593 * is used to pass the status items from the afs process to the command handler
2594 * via a shared memory area and a pipe.
2596 * \return The return value of the underlying call to \ref send_callback_request().
2598 int send_afs_status(struct command_context *cc, int parser_friendly)
2600 struct osl_object query = {.data = &parser_friendly,
2601 .size = sizeof(parser_friendly)};
2603 return send_callback_request(afs_stat_callback, &query,
2604 afs_cb_result_handler, cc);
2607 /* TODO: optionally fix problems by removing offending rows */
2608 static int check_audio_file(struct osl_row *row, void *data)
2611 struct para_buffer *pb = data;
2612 struct stat statbuf;
2613 int ret = get_audio_file_path_of_row(row, &path);
2614 struct afs_info afsi;
2618 return para_printf(pb, "%s\n", para_strerror(-ret));
2619 if (stat(path, &statbuf) < 0) {
2620 ret = para_printf(pb, "%s: stat error (%s)\n", path, strerror(errno));
2624 if (!S_ISREG(statbuf.st_mode)) {
2625 ret = para_printf(pb, "%s: not a regular file\n", path);
2630 ret = get_afsi_of_row(row, &afsi);
2632 return para_printf(pb, "%s: %s\n", path, para_strerror(-ret));
2633 ret = lyr_get_name_by_id(afsi.lyrics_id, &blob_name);
2635 ret = para_printf(pb, "%s lyrics id %u: %s\n", path, afsi.lyrics_id,
2636 para_strerror(-ret));
2640 ret = img_get_name_by_id(afsi.image_id, &blob_name);
2642 ret = para_printf(pb, "%s image id %u: %s\n", path, afsi.image_id,
2643 para_strerror(-ret));
2648 * Check the audio file table for inconsistencies.
2650 * \param fd The afs socket.
2651 * \param query Unused.
2653 * This function always succeeds.
2657 void aft_check_callback(int fd, __a_unused const struct osl_object *query)
2659 struct para_buffer pb = {
2660 .max_size = shm_get_shmmax(),
2661 .private_data = &(struct afs_max_size_handler_data) {
2665 .max_size_handler = afs_max_size_handler
2667 int ret = para_printf(&pb, "checking audio file table...\n");
2671 audio_file_loop(&pb, check_audio_file);
2673 pass_buffer_as_shm(fd, SBD_OUTPUT, pb.buf, pb.offset);
2678 * Close the audio file table.
2680 * \param flags Usual flags that are passed to osl_close_table().
2682 * \sa osl_close_table().
2684 static void aft_close(void)
2686 osl_close_table(audio_file_table, OSL_MARK_CLEAN);
2687 audio_file_table = NULL;
2691 * Open the audio file table.
2693 * \param dir The database directory.
2697 * \sa osl_open_table().
2699 static int aft_open(const char *dir)
2703 audio_file_table_desc.dir = dir;
2704 ret = osl(osl_open_table(&audio_file_table_desc, &audio_file_table));
2707 osl_get_num_rows(audio_file_table, &num);
2708 PARA_INFO_LOG("audio file table contains %d files\n", num);
2711 PARA_INFO_LOG("failed to open audio file table\n");
2712 audio_file_table = NULL;
2713 if (ret >= 0 || ret == -OSL_ERRNO_TO_PARA_ERROR(E_OSL_NOENT))
2718 static int aft_create(const char *dir)
2720 audio_file_table_desc.dir = dir;
2721 return osl(osl_create_table(&audio_file_table_desc));
2724 static int clear_attribute(struct osl_row *row, void *data)
2726 struct rmatt_event_data *red = data;
2727 struct afs_info afsi;
2728 struct osl_object obj;
2729 int ret = get_afsi_object_of_row(row, &obj);
2730 uint64_t mask = ~(1ULL << red->bitnum);
2734 ret = load_afsi(&afsi, &obj);
2737 afsi.attributes &= mask;
2738 save_afsi(&afsi, &obj);
2742 static int aft_event_handler(enum afs_events event, struct para_buffer *pb,
2748 case ATTRIBUTE_REMOVE: {
2749 const struct rmatt_event_data *red = data;
2750 ret = para_printf(pb, "clearing attribute %s (bit %u) from all "
2751 "entries in the audio file table\n", red->name,
2755 return audio_file_loop(data, clear_attribute);
2763 * Initialize the audio file table.
2765 * \param t Pointer to the structure to be initialized.
2767 void aft_init(struct afs_table *t)
2770 t->close = aft_close;
2771 t->create = aft_create;
2772 t->event_handler = aft_event_handler;