2 * Copyright (C) 2007-2011 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"
25 static struct osl_table *audio_file_table;
26 static char *status_items;
27 static char *parser_friendly_status_items;
29 /** The different sorting methods of the ls command. */
30 enum ls_sorting_method {
36 LS_SORT_BY_LAST_PLAYED,
38 LS_SORT_BY_NUM_PLAYED,
52 LS_SORT_BY_AUDIO_FORMAT,
57 /** The different listing modes of the ls command. */
58 enum ls_listing_mode {
59 /** Default listing mode. */
73 /** The flags accepted by the ls command. */
76 LS_FLAG_FULL_PATH = 1,
78 LS_FLAG_ADMISSIBLE_ONLY = 2,
86 * The size of the individual output fields of the ls command.
88 * These depend on the actual content being listed. If, for instance only files
89 * with duration less than an hour are being listed, then the duration with is
90 * made smaller because then the duration is listed as mm:ss rather than
94 /** size of the score field. */
95 unsigned short score_width;
96 /** size of the image id field. */
97 unsigned short image_id_width;
98 /** size of the lyrics id field. */
99 unsigned short lyrics_id_width;
100 /** size of the bitrate field. */
101 unsigned short bitrate_width;
102 /** size of the frequency field. */
103 unsigned short frequency_width;
104 /** size of the duration field. */
105 unsigned short duration_width;
106 /** size of the num played field. */
107 unsigned short num_played_width;
108 /** size of the amp field. */
109 unsigned short amp_width;
110 /** size of the audio format field. */
111 unsigned short audio_format_width;
114 /** Data passed from the ls command handler to its callback function. */
116 /** The given command line flags. */
118 /** The sorting method given at the command line. */
119 enum ls_sorting_method sorting;
120 /** The given listing mode (short, long, verbose, mbox). */
121 enum ls_listing_mode mode;
122 /** The arguments passed to the ls command. */
124 /** Number of non-option arguments. */
126 /** Used for long listing mode to align the output fields. */
127 struct ls_widths widths;
128 /** Size of the \a data array. */
130 /** Number of used entries in the data array. */
131 uint32_t num_matching_paths;
132 /** Array of matching entries. */
133 struct ls_data *data;
134 /** Used to sort the array. */
135 struct ls_data **data_ptr;
139 * Describes the layout of the mmapped-afs info struct.
141 * \sa struct afs_info.
144 /** Where .last_played is stored. */
145 AFSI_LAST_PLAYED_OFFSET = 0,
146 /** Storage position of the attributes bitmap. */
147 AFSI_ATTRIBUTES_OFFSET = 8,
148 /** Storage position of the .num_played field. */
149 AFSI_NUM_PLAYED_OFFSET = 16,
150 /** Storage position of the .image_id field. */
151 AFSI_IMAGE_ID_OFFSET = 20,
152 /** Storage position of the .lyrics_id field. */
153 AFSI_LYRICS_ID_OFFSET = 24,
154 /** Storage position of the .audio_format_id field. */
155 AFSI_AUDIO_FORMAT_ID_OFFSET = 28,
156 /** Storage position of the amplification field. */
157 AFSI_AMP_OFFSET = 29,
158 /** 2 bytes reserved space for future usage. */
159 AFSI_AUDIO_FORMAT_UNUSED_OFFSET = 30,
160 /** On-disk storage space needed. */
165 * Convert a struct afs_info to an osl object.
167 * \param afsi Pointer to the audio file info to be converted.
168 * \param obj Result pointer.
172 void save_afsi(struct afs_info *afsi, struct osl_object *obj)
174 char *buf = obj->data;
176 write_u64(buf + AFSI_LAST_PLAYED_OFFSET, afsi->last_played);
177 write_u64(buf + AFSI_ATTRIBUTES_OFFSET, afsi->attributes);
178 write_u32(buf + AFSI_NUM_PLAYED_OFFSET, afsi->num_played);
179 write_u32(buf + AFSI_IMAGE_ID_OFFSET, afsi->image_id);
180 write_u32(buf + AFSI_LYRICS_ID_OFFSET, afsi->lyrics_id);
181 write_u8(buf + AFSI_AUDIO_FORMAT_ID_OFFSET,
182 afsi->audio_format_id);
183 write_u8(buf + AFSI_AMP_OFFSET, afsi->amp);
184 memset(buf + AFSI_AUDIO_FORMAT_UNUSED_OFFSET, 0, 2);
188 * Get the audio file selector info struct stored in an osl object.
190 * \param afsi Points to the audio_file info structure to be filled in.
191 * \param obj The osl object holding the data.
193 * \return Positive on success, negative on errors. Possible errors: \p E_BAD_AFS.
197 int load_afsi(struct afs_info *afsi, struct osl_object *obj)
199 char *buf = obj->data;
200 if (obj->size < AFSI_SIZE)
202 afsi->last_played = read_u64(buf + AFSI_LAST_PLAYED_OFFSET);
203 afsi->attributes = read_u64(buf + AFSI_ATTRIBUTES_OFFSET);
204 afsi->num_played = read_u32(buf + AFSI_NUM_PLAYED_OFFSET);
205 afsi->image_id = read_u32(buf + AFSI_IMAGE_ID_OFFSET);
206 afsi->lyrics_id = read_u32(buf + AFSI_LYRICS_ID_OFFSET);
207 afsi->audio_format_id = read_u8(buf +
208 AFSI_AUDIO_FORMAT_ID_OFFSET);
209 afsi->amp = read_u8(buf + AFSI_AMP_OFFSET);
213 /** The columns of the audio file table. */
214 enum audio_file_table_columns {
215 /** The hash on the content of the audio file. */
217 /** The full path in the filesystem. */
219 /** The audio file selector info. */
221 /** The audio format handler info. */
223 /** The chunk table info and the chunk table of the audio file. */
225 /** The number of columns of this table. */
230 * Compare two osl objects pointing to hash values.
232 * \param obj1 Pointer to the first hash object.
233 * \param obj2 Pointer to the second hash object.
235 * \return The values required for an osl compare function.
237 * \sa osl_compare_func, uint32_compare().
239 static int aft_hash_compare(const struct osl_object *obj1, const struct osl_object *obj2)
241 return hash_compare((unsigned char *)obj1->data, (unsigned char *)obj2->data);
244 static struct osl_column_description aft_cols[] = {
246 .storage_type = OSL_MAPPED_STORAGE,
247 .storage_flags = OSL_RBTREE | OSL_FIXED_SIZE | OSL_UNIQUE,
249 .compare_function = aft_hash_compare,
250 .data_size = HASH_SIZE
253 .storage_type = OSL_MAPPED_STORAGE,
254 .storage_flags = OSL_RBTREE | OSL_UNIQUE,
256 .compare_function = string_compare,
259 .storage_type = OSL_MAPPED_STORAGE,
260 .storage_flags = OSL_FIXED_SIZE,
262 .data_size = AFSI_SIZE
265 .storage_type = OSL_MAPPED_STORAGE,
269 .storage_type = OSL_DISK_STORAGE,
274 static struct osl_table_description audio_file_table_desc = {
275 .name = "audio_files",
276 .num_columns = NUM_AFT_COLUMNS,
277 .flags = OSL_LARGE_TABLE,
278 .column_descriptions = aft_cols
281 /* We don't want * dot or dot-dot anywhere. */
282 static int verify_dotfile(const char *rest)
285 * The first character was '.', but that has already been discarded, we
289 case '\0': case '/': /* /foo/. and /foo/./bar are not ok */
291 case '.': /* path start with /foo/.. */
292 if (rest[1] == '\0' || rest[1] == '/')
293 return -1; /* /foo/.. or /foo/../bar are not ok */
294 /* /foo/..bar is ok */
300 * We fundamentally don't like some paths: We don't want double slashes or
301 * slashes at the end that can make pathnames ambiguous.
303 static int verify_path(const char *orig_path, char **resolved_path)
309 if (*orig_path != '/') /* we only accept absolute paths */
311 len = strlen(orig_path);
312 *resolved_path = para_strdup(orig_path);
313 path = *resolved_path;
314 while (len > 1 && path[--len] == '/')
315 path[len] = '\0'; /* remove slash at the end */
321 case '/': /* double slash */
324 if (verify_dotfile(path) < 0)
334 free(*resolved_path);
338 /** The on-disk layout of a afhi struct. */
340 /** Where the number of seconds is stored. */
341 AFHI_SECONDS_TOTAL_OFFSET = 0,
342 /** Position of the bitrate. */
343 AFHI_BITRATE_OFFSET = 4,
344 /** Position of the frequency. */
345 AFHI_FREQUENCY_OFFSET = 8,
346 /** Was: Location of the audio file header. */
347 AFHI_UNUSED1_OFFSET = 12,
348 /* Length of the audio file header. Zero means: No header. */
349 AFHI_HEADER_LEN_OFFSET = 16,
350 /** The total number of chunks (4 bytes). */
351 CHUNKS_TOTAL_OFFSET = 20,
352 /** The length of the audio file header (4 bytes). */
353 HEADER_LEN_OFFSET = 24,
354 /** Was: The start of the audio file header (4 bytes). */
355 AFHI_UNUSED2_OFFSET = 28,
356 /** The seconds part of the chunk time (4 bytes). */
357 CHUNK_TV_TV_SEC_OFFSET = 32,
358 /** The microseconds part of the chunk time (4 bytes). */
359 CHUNK_TV_TV_USEC_OFFSET = 36,
360 /** Number of channels is stored here. (1 byte) */
361 AFHI_CHANNELS_OFFSET = 40,
362 /** The tag info position. */
363 AFHI_INFO_STRING_OFFSET = 41,
364 /** Minimal on-disk size of a valid afhi struct. */
365 MIN_AFHI_SIZE = 47, /* at least 6 null bytes for techinfo/tags */
368 static unsigned sizeof_afhi_buf(const struct afh_info *afhi)
373 + strlen(afhi->techinfo)
374 + strlen(afhi->tags.artist)
375 + strlen(afhi->tags.title)
376 + strlen(afhi->tags.year)
377 + strlen(afhi->tags.album)
378 + strlen(afhi->tags.comment);
381 static void save_afhi(struct afh_info *afhi, char *buf)
387 write_u32(buf + AFHI_SECONDS_TOTAL_OFFSET, afhi->seconds_total);
388 write_u32(buf + AFHI_BITRATE_OFFSET, afhi->bitrate);
389 write_u32(buf + AFHI_FREQUENCY_OFFSET, afhi->frequency);
390 write_u32(buf + AFHI_UNUSED1_OFFSET, 0);
391 write_u32(buf + AFHI_HEADER_LEN_OFFSET, afhi->header_len);
392 write_u8(buf + AFHI_CHANNELS_OFFSET, afhi->channels);
393 write_u32(buf + CHUNKS_TOTAL_OFFSET, afhi->chunks_total);
394 write_u32(buf + HEADER_LEN_OFFSET, afhi->header_len);
395 write_u32(buf + AFHI_UNUSED2_OFFSET, 0);
396 write_u32(buf + CHUNK_TV_TV_SEC_OFFSET, afhi->chunk_tv.tv_sec);
397 write_u32(buf + CHUNK_TV_TV_USEC_OFFSET, afhi->chunk_tv.tv_usec);
398 p = buf + AFHI_INFO_STRING_OFFSET;
399 /* The sprintf's below are OK as our caller made sure that buf is large enough */
400 p += sprintf(p, "%s", afhi->techinfo) + 1;
401 p += sprintf(p, "%s", afhi->tags.artist) + 1;
402 p += sprintf(p, "%s", afhi->tags.title) + 1;
403 p += sprintf(p, "%s", afhi->tags.year) + 1;
404 p += sprintf(p, "%s", afhi->tags.album) + 1;
405 sprintf(p, "%s", afhi->tags.comment);
408 static void load_afhi(const char *buf, struct afh_info *afhi)
410 afhi->seconds_total = read_u32(buf + AFHI_SECONDS_TOTAL_OFFSET);
411 afhi->bitrate = read_u32(buf + AFHI_BITRATE_OFFSET);
412 afhi->frequency = read_u32(buf + AFHI_FREQUENCY_OFFSET);
413 afhi->header_len = read_u32(buf + AFHI_HEADER_LEN_OFFSET);
414 afhi->channels = read_u8(buf + AFHI_CHANNELS_OFFSET);
415 afhi->chunks_total = read_u32(buf + CHUNKS_TOTAL_OFFSET);
416 afhi->header_len = read_u32(buf + HEADER_LEN_OFFSET);
417 afhi->chunk_tv.tv_sec = read_u32(buf + CHUNK_TV_TV_SEC_OFFSET);
418 afhi->chunk_tv.tv_usec = read_u32(buf + CHUNK_TV_TV_USEC_OFFSET);
419 afhi->techinfo = (char *)buf + AFHI_INFO_STRING_OFFSET;
420 afhi->tags.artist = afhi->techinfo + strlen(afhi->techinfo) + 1;
421 afhi->tags.title = afhi->tags.artist + strlen(afhi->tags.artist) + 1;
422 afhi->tags.year = afhi->tags.title + strlen(afhi->tags.title) + 1;
423 afhi->tags.album = afhi->tags.year + strlen(afhi->tags.year) + 1;
424 afhi->tags.comment = afhi->tags.album + strlen(afhi->tags.album) + 1;
427 static unsigned sizeof_chunk_table(struct afh_info *afhi)
431 return 4 * (afhi->chunks_total + 1);
434 static uint32_t save_chunk_table(struct afh_info *afhi, char *buf)
437 uint32_t max = 0, old = 0;
439 for (i = 0; i <= afhi->chunks_total; i++) {
440 uint32_t val = afhi->chunk_table[i];
441 write_u32(buf + 4 * i, val);
443 * If the first chunk is the header, do not consider it for the
444 * calculation of the largest chunk size.
446 if (i == 0 || (i == 1 && afhi->header_len > 0)) {
450 max = PARA_MAX(max, val - old);
456 static void load_chunk_table(struct afh_info *afhi, char *buf)
460 afhi->chunk_table = para_malloc(sizeof_chunk_table(afhi));
461 for (i = 0; i <= afhi->chunks_total; i++)
462 afhi->chunk_table[i] = read_u32(buf + 4 * i);
466 * Get the row of the audio file table corresponding to the given path.
468 * \param path The full path of the audio file.
469 * \param row Result pointer.
473 int aft_get_row_of_path(const char *path, struct osl_row **row)
475 struct osl_object obj = {.data = (char *)path, .size = strlen(path) + 1};
477 return osl(osl_get_row(audio_file_table, AFTCOL_PATH, &obj, row));
481 * Get the row of the audio file table corresponding to the given hash value.
483 * \param hash The hash value of the desired audio file.
484 * \param row Result pointer.
488 static int aft_get_row_of_hash(unsigned char *hash, struct osl_row **row)
490 const struct osl_object obj = {.data = hash, .size = HASH_SIZE};
491 return osl(osl_get_row(audio_file_table, AFTCOL_HASH, &obj, row));
495 * Get the osl object holding the audio file selector info of a row.
497 * \param row Pointer to a row in the audio file table.
498 * \param obj Result pointer.
502 int get_afsi_object_of_row(const struct osl_row *row, struct osl_object *obj)
504 return osl(osl_get_object(audio_file_table, row, AFTCOL_AFSI, obj));
508 * Get the osl object holding the audio file selector info, given a path.
511 * \param path The full path of the audio file.
512 * \param obj Result pointer.
514 * \return Positive on success, negative on errors.
516 static int get_afsi_object_of_path(const char *path, struct osl_object *obj)
519 int ret = aft_get_row_of_path(path, &row);
522 return get_afsi_object_of_row(row, obj);
526 * Get the audio file selector info, given a row of the audio file table.
528 * \param row Pointer to a row in the audio file table.
529 * \param afsi Result pointer.
531 * \return Positive on success, negative on errors.
533 int get_afsi_of_row(const struct osl_row *row, struct afs_info *afsi)
535 struct osl_object obj;
536 int ret = get_afsi_object_of_row(row, &obj);
539 return load_afsi(afsi, &obj);
543 * Get the audio file selector info, given the path of an audio table.
545 * \param path The full path of the audio file.
546 * \param afsi Result pointer.
548 * \return Positive on success, negative on errors.
550 int get_afsi_of_path(const char *path, struct afs_info *afsi)
552 struct osl_object obj;
553 int ret = get_afsi_object_of_path(path, &obj);
556 return load_afsi(afsi, &obj);
560 * Get the path of an audio file, given a row of the audio file table.
562 * \param row Pointer to a row in the audio file table.
563 * \param path Result pointer.
565 * The result is a pointer to mmapped data. The caller must not attempt
570 int get_audio_file_path_of_row(const struct osl_row *row, char **path)
572 struct osl_object path_obj;
573 int ret = osl(osl_get_object(audio_file_table, row, AFTCOL_PATH,
577 *path = path_obj.data;
582 * Get the object containing the hash value of an audio file, given a row.
584 * \param row Pointer to a row of the audio file table.
585 * \param obj Result pointer.
587 * \return The return value of the underlying call to osl_get_object().
589 * \sa get_hash_of_row().
591 static int get_hash_object_of_aft_row(const struct osl_row *row,
592 struct osl_object *obj)
594 return osl(osl_get_object(audio_file_table, row, AFTCOL_HASH, obj));
598 * Get the hash value of an audio file, given a row of the audio file table.
600 * \param row Pointer to a row of the audio file table.
601 * \param hash Result pointer.
603 * \a hash points to mapped data and must not be freed by the caller.
605 * \return The return value of the underlying call to
606 * get_hash_object_of_aft_row().
608 static int get_hash_of_row(const struct osl_row *row, unsigned char **hash)
610 struct osl_object obj;
611 int ret = get_hash_object_of_aft_row(row, &obj);
620 * Get the audio format handler info, given a row of the audio file table.
622 * \param row Pointer to a row of the audio file table.
623 * \param afhi Result pointer.
625 * \return The return value of the underlying call to osl_get_object().
627 * \sa get_chunk_table_of_row().
629 int get_afhi_of_row(const struct osl_row *row, struct afh_info *afhi)
631 struct osl_object obj;
632 int ret = osl(osl_get_object(audio_file_table, row, AFTCOL_AFHI,
636 load_afhi(obj.data, afhi);
640 /* returns shmid on success */
641 static int save_afd(struct audio_file_data *afd)
643 size_t size = sizeof(*afd) + sizeof_chunk_table(&afd->afhi);
644 int shmid, ret = shm_new(size);
651 ret = shm_attach(shmid, ATTACH_RW, &shm_afd);
656 afd->max_chunk_size = save_chunk_table(&afd->afhi, buf);
657 *(struct audio_file_data *)shm_afd = *afd;
666 * Extract a afd stored in a shared memory area.
668 * Attach the shared memory area given by \a shmid, load the audio file data
669 * stored therein and detach the area afterwards. Called by vss, after
670 * receiving a positive response to the request for the next audio file.
672 * \param shmid The identifier of the shared memory area containing the afd.
673 * \param afd Result pointer.
677 int load_afd(int shmid, struct audio_file_data *afd)
683 ret = shm_attach(shmid, ATTACH_RO, &shm_afd);
686 *afd = *(struct audio_file_data *)shm_afd;
689 load_chunk_table(&afd->afhi, buf);
694 static int get_local_time(uint64_t *seconds, char *buf, size_t size,
695 time_t current_time, enum ls_listing_mode lm)
699 if (!localtime_r((time_t *)seconds, &t))
701 if (lm == LS_MODE_MBOX) {
702 if (!strftime(buf, size, "%c", &t))
706 if (*seconds + 6 * 30 * 24 * 3600 > current_time) {
707 if (!strftime(buf, size, "%b %e %k:%M", &t))
711 if (!strftime(buf, size, "%b %e %Y", &t))
716 /** Compute the number of (decimal) digits of a number. */
717 #define GET_NUM_DIGITS(x, num) { \
718 typeof((x)) _tmp = PARA_ABS(x); \
721 while ((_tmp) > 9) { \
727 __a_const static short unsigned get_duration_width(int seconds)
729 short unsigned width;
730 unsigned hours = seconds / 3600, mins = (seconds % 3600) / 60;
732 if (!hours) /* less than one hour => m:ss or mm:ss => 4 or 5 digits */
733 return 4 + (mins > 9);
734 /* more than one hour => h:mm:ss, hh:mm:ss, hhh:mm:ss, ... */
735 GET_NUM_DIGITS(hours, &width);
739 static void get_duration_buf(int seconds, char *buf, struct ls_options *opts)
741 unsigned hours = seconds / 3600, mins = (seconds % 3600) / 60;
742 short unsigned max_width;
744 if (!hours) { /* m:ss or mm:ss */
745 max_width = opts->mode == LS_MODE_LONG?
746 opts->widths.duration_width : 4;
747 sprintf(buf, "%*u:%02u", max_width - 3, mins, seconds % 60);
748 } else { /* more than one hour => h:mm:ss, hh:mm:ss, hhh:mm:ss, ... */
749 max_width = opts->mode == LS_MODE_LONG?
750 opts->widths.duration_width : 7;
751 sprintf(buf, "%*u:%02u:%02u", max_width - 6, hours, mins,
757 static int write_attribute_items(struct para_buffer *b,
758 const char *att_bitmap, struct afs_info *afsi)
763 ret = WRITE_STATUS_ITEM(b, SI_ATTRIBUTES_BITMAP, "%s\n", att_bitmap);
766 ret = get_attribute_text(&afsi->attributes, " ", &att_text);
769 ret = WRITE_STATUS_ITEM(b, SI_ATTRIBUTES_TXT, "%s\n", att_text);
774 static int write_lyrics_items(struct para_buffer *b, struct afs_info *afsi)
779 ret = WRITE_STATUS_ITEM(b, SI_LYRICS_ID, "%u\n", afsi->lyrics_id);
782 lyr_get_name_by_id(afsi->lyrics_id, &lyrics_name);
783 return WRITE_STATUS_ITEM(b, SI_LYRICS_NAME, "%s\n", lyrics_name?
784 lyrics_name : "(none)");
787 static int write_image_items(struct para_buffer *b, struct afs_info *afsi)
792 ret = WRITE_STATUS_ITEM(b, SI_IMAGE_ID, "%u\n", afsi->image_id);
795 img_get_name_by_id(afsi->image_id, &image_name);
796 return WRITE_STATUS_ITEM(b, SI_IMAGE_NAME, "%s\n", image_name?
797 image_name : "(none)");
800 static int write_filename_items(struct para_buffer *b, const char *path,
806 if (!(flags & LS_FLAG_FULL_PATH))
807 return WRITE_STATUS_ITEM(b, SI_BASENAME, "%s\n", path);
808 ret = WRITE_STATUS_ITEM(b, SI_PATH, "%s\n", path);
811 val = para_basename(path);
812 ret = WRITE_STATUS_ITEM(b, SI_BASENAME, "%s\n", val? val : "");
815 val = para_dirname(path);
816 ret = WRITE_STATUS_ITEM(b, SI_DIRECTORY, "%s\n", val? val : "");
821 static int print_chunk_table(struct ls_data *d, struct para_buffer *b)
823 struct osl_object chunk_table_obj;
824 struct osl_row *aft_row;
828 ret = aft_get_row_of_hash(d->hash, &aft_row);
831 ret = osl_open_disk_object(audio_file_table, aft_row,
832 AFTCOL_CHUNKS, &chunk_table_obj);
835 ret = para_printf(b, "%s\n"
836 "chunk_time: %lu:%lu\nchunk_offsets: ",
838 (long unsigned) d->afhi.chunk_tv.tv_sec,
839 (long unsigned) d->afhi.chunk_tv.tv_usec
843 buf = chunk_table_obj.data;
844 for (i = 0; i <= d->afhi.chunks_total; i++) {
845 ret = para_printf(b, "%u ", (unsigned) read_u32(buf + 4 * i));
849 ret = para_printf(b, "\n");
851 osl_close_disk_object(&chunk_table_obj);
855 static int write_score(struct para_buffer *b, struct ls_data *d,
856 struct ls_options *opts)
858 if (!(opts->flags & LS_FLAG_ADMISSIBLE_ONLY)) /* no score*/
860 return WRITE_STATUS_ITEM(b, SI_SCORE, "%li\n", d->score);
863 static int print_list_item(struct ls_data *d, struct ls_options *opts,
864 struct para_buffer *b, time_t current_time)
868 char last_played_time[30];
869 char duration_buf[30]; /* nobody has an audio file long enough to overflow this */
870 struct afs_info *afsi = &d->afsi;
871 struct afh_info *afhi = &d->afhi;
872 char asc_hash[2 * HASH_SIZE + 1];
874 if (opts->mode == LS_MODE_SHORT) {
875 ret = para_printf(b, "%s\n", d->path);
878 if (opts->mode == LS_MODE_CHUNKS) {
879 ret = print_chunk_table(d, b);
882 get_attribute_bitmap(&afsi->attributes, att_buf);
883 if (opts->flags & LS_FLAG_UNIXDATE)
884 sprintf(last_played_time, "%llu",
885 (long long unsigned)afsi->last_played);
887 ret = get_local_time(&afsi->last_played, last_played_time,
888 sizeof(last_played_time), current_time, opts->mode);
892 get_duration_buf(afhi->seconds_total, duration_buf, opts);
893 if (opts->mode == LS_MODE_LONG) {
894 struct ls_widths *w = &opts->widths;
895 if (opts->flags & LS_FLAG_ADMISSIBLE_ONLY) {
896 ret = para_printf(b, "%*li ",
897 opts->widths.score_width, d->score);
902 "%s " /* attributes */
904 "%*d " /* image_id */
905 "%*d " /* lyrics_id */
907 "%*s " /* audio format */
908 "%*d " /* frequency */
911 "%*d " /* num_played */
912 "%s " /* last_played */
915 w->amp_width, afsi->amp,
916 w->image_id_width, afsi->image_id,
917 w->lyrics_id_width, afsi->lyrics_id,
918 w->bitrate_width, afhi->bitrate,
919 w->audio_format_width,
920 audio_format_name(afsi->audio_format_id),
921 w->frequency_width, afhi->frequency,
924 w->num_played_width, afsi->num_played,
930 if (opts->mode == LS_MODE_MBOX) {
931 const char *bn = para_basename(d->path);
933 "From foo@localhost %s\n"
934 "Received: from\nTo: bar\nFrom: a\n"
941 ret = write_filename_items(b, d->path, opts->flags);
944 ret = write_score(b, d, opts);
947 ret = write_attribute_items(b, att_buf, afsi);
950 ret = write_image_items(b, afsi);
953 ret = write_lyrics_items(b, afsi);
956 hash_to_asc(d->hash, asc_hash);
957 ret = WRITE_STATUS_ITEM(b, SI_HASH, "%s\n", asc_hash);
960 ret = WRITE_STATUS_ITEM(b, SI_BITRATE, "%dkbit/s\n", afhi->bitrate);
963 ret = WRITE_STATUS_ITEM(b, SI_FORMAT, "%s\n",
964 audio_format_name(afsi->audio_format_id));
967 ret = WRITE_STATUS_ITEM(b, SI_FREQUENCY, "%dHz\n", afhi->frequency);
970 ret = WRITE_STATUS_ITEM(b, SI_CHANNELS, "%d\n", afhi->channels);
973 ret = WRITE_STATUS_ITEM(b, SI_DURATION, "%s\n", duration_buf);
976 ret = WRITE_STATUS_ITEM(b, SI_SECONDS_TOTAL, "%lu\n",
977 afhi->seconds_total);
980 ret = WRITE_STATUS_ITEM(b, SI_LAST_PLAYED, "%s\n", last_played_time);
983 ret = WRITE_STATUS_ITEM(b, SI_NUM_PLAYED, "%d\n", afsi->num_played);
986 ret = WRITE_STATUS_ITEM(b, SI_AMPLIFICATION, "%u\n", afsi->amp);
989 ret = WRITE_STATUS_ITEM(b, SI_CHUNK_TIME, "%lu\n",
990 tv2ms(&afhi->chunk_tv));
993 ret = WRITE_STATUS_ITEM(b, SI_NUM_CHUNKS, "%lu\n",
997 ret = WRITE_STATUS_ITEM(b, SI_TECHINFO, "%s\n", afhi->techinfo);
1000 ret = WRITE_STATUS_ITEM(b, SI_ARTIST, "%s\n", afhi->tags.artist);
1003 ret = WRITE_STATUS_ITEM(b, SI_TITLE, "%s\n", afhi->tags.title);
1006 ret = WRITE_STATUS_ITEM(b, SI_YEAR, "%s\n", afhi->tags.year);
1009 ret = WRITE_STATUS_ITEM(b, SI_ALBUM, "%s\n", afhi->tags.album);
1012 ret = WRITE_STATUS_ITEM(b, SI_COMMENT, "%s\n", afhi->tags.comment);
1015 if (opts->mode == LS_MODE_MBOX) {
1016 struct osl_object lyrics_def;
1017 lyr_get_def_by_id(afsi->lyrics_id, &lyrics_def);
1018 if (lyrics_def.data) {
1019 ret = para_printf(b, "Lyrics:\n~~~~~~~\n%s",
1020 (char *)lyrics_def.data);
1021 osl_close_disk_object(&lyrics_def);
1028 static int make_status_items(struct audio_file_data *afd,
1029 struct afs_info *afsi, char *path, long score,
1030 unsigned char *hash)
1032 struct ls_data d = {
1039 struct ls_options opts = {
1040 .flags = LS_FLAG_FULL_PATH | LS_FLAG_ADMISSIBLE_ONLY,
1041 .mode = LS_MODE_VERBOSE,
1043 struct para_buffer pb = {.max_size = shm_get_shmmax() - 1};
1044 time_t current_time;
1047 time(¤t_time);
1048 ret = print_list_item(&d, &opts, &pb, current_time);
1052 status_items = pb.buf;
1053 memset(&pb, 0, sizeof(pb));
1054 pb.max_size = shm_get_shmmax() - 1;
1055 pb.flags = PBF_SIZE_PREFIX;
1056 ret = print_list_item(&d, &opts, &pb, current_time);
1059 status_items = NULL;
1062 free(parser_friendly_status_items);
1063 parser_friendly_status_items = pb.buf;
1068 * Mmap the given audio file and update statistics.
1070 * \param aft_row Determines the audio file to be opened and updated.
1071 * \param score The score of the audio file.
1072 * \param afd Result pointer.
1074 * On success, the numplayed field of the audio file selector info is increased
1075 * and the lastplayed time is set to the current time. Finally, the score of
1076 * the audio file is updated.
1078 * \return Positive shmid on success, negative on errors.
1080 int open_and_update_audio_file(struct osl_row *aft_row, long score,
1081 struct audio_file_data *afd)
1083 unsigned char *aft_hash, file_hash[HASH_SIZE];
1084 struct osl_object afsi_obj;
1085 struct afs_info old_afsi, new_afsi;
1086 int ret = get_hash_of_row(aft_row, &aft_hash);
1087 struct afsi_change_event_data aced;
1088 struct osl_object map, chunk_table_obj;
1093 ret = get_audio_file_path_of_row(aft_row, &path);
1096 PARA_NOTICE_LOG("%s\n", path);
1097 ret = get_afsi_object_of_row(aft_row, &afsi_obj);
1100 ret = load_afsi(&old_afsi, &afsi_obj);
1103 ret = get_afhi_of_row(aft_row, &afd->afhi);
1106 afd->afhi.chunk_table = NULL;
1107 ret = osl_open_disk_object(audio_file_table, aft_row,
1108 AFTCOL_CHUNKS, &chunk_table_obj);
1111 ret = mmap_full_file(path, O_RDONLY, &map.data,
1112 &map.size, &afd->fd);
1115 hash_function(map.data, map.size, file_hash);
1116 ret = hash_compare(file_hash, aft_hash);
1117 para_munmap(map.data, map.size);
1119 ret = -E_HASH_MISMATCH;
1122 new_afsi = old_afsi;
1123 new_afsi.num_played++;
1124 new_afsi.last_played = time(NULL);
1125 save_afsi(&new_afsi, &afsi_obj); /* in-place update */
1127 afd->audio_format_id = old_afsi.audio_format_id;
1128 load_chunk_table(&afd->afhi, chunk_table_obj.data);
1129 ret = make_status_items(afd, &old_afsi, path, score, file_hash);
1132 aced.aft_row = aft_row;
1133 aced.old_afsi = &old_afsi;
1134 afs_event(AFSI_CHANGE, NULL, &aced);
1135 ret = save_afd(afd);
1137 free(afd->afhi.chunk_table);
1138 osl_close_disk_object(&chunk_table_obj);
1140 PARA_ERROR_LOG("%s: %s\n", path, para_strerror(-ret));
1144 static int ls_audio_format_compare(const void *a, const void *b)
1146 struct ls_data *d1 = *(struct ls_data **)a, *d2 = *(struct ls_data **)b;
1147 return NUM_COMPARE(d1->afsi.audio_format_id, d2->afsi.audio_format_id);
1150 static int ls_duration_compare(const void *a, const void *b)
1152 struct ls_data *d1 = *(struct ls_data **)a, *d2 = *(struct ls_data **)b;
1153 return NUM_COMPARE(d1->afhi.seconds_total, d2->afhi.seconds_total);
1156 static int ls_bitrate_compare(const void *a, const void *b)
1158 struct ls_data *d1 = *(struct ls_data **)a, *d2 = *(struct ls_data **)b;
1159 return NUM_COMPARE(d1->afhi.bitrate, d2->afhi.bitrate);
1162 static int ls_lyrics_id_compare(const void *a, const void *b)
1164 struct ls_data *d1 = *(struct ls_data **)a, *d2 = *(struct ls_data **)b;
1165 return NUM_COMPARE(d1->afsi.lyrics_id, d2->afsi.lyrics_id);
1168 static int ls_image_id_compare(const void *a, const void *b)
1170 struct ls_data *d1 = *(struct ls_data **)a, *d2 = *(struct ls_data **)b;
1171 return NUM_COMPARE(d1->afsi.image_id, d2->afsi.image_id);
1174 static int ls_channels_compare(const void *a, const void *b)
1176 struct ls_data *d1 = *(struct ls_data **)a, *d2 = *(struct ls_data **)b;
1177 return NUM_COMPARE(d1->afhi.channels, d2->afhi.channels);
1180 static int ls_frequency_compare(const void *a, const void *b)
1182 struct ls_data *d1 = *(struct ls_data **)a, *d2 = *(struct ls_data **)b;
1183 return NUM_COMPARE(d1->afhi.frequency, d2->afhi.frequency);
1186 static int ls_num_played_compare(const void *a, const void *b)
1188 struct ls_data *d1 = *(struct ls_data **)a, *d2 = *(struct ls_data **)b;
1189 return NUM_COMPARE(d1->afsi.num_played, d2->afsi.num_played);
1192 static int ls_last_played_compare(const void *a, const void *b)
1194 struct ls_data *d1 = *(struct ls_data **)a, *d2 = *(struct ls_data **)b;
1195 return NUM_COMPARE(d1->afsi.last_played, d2->afsi.last_played);
1198 static int ls_score_compare(const void *a, const void *b)
1200 struct ls_data *d1 = *(struct ls_data **)a, *d2 = *(struct ls_data **)b;
1201 return NUM_COMPARE(d1->score, d2->score);
1204 static int ls_path_compare(const void *a, const void *b)
1206 struct ls_data *d1 = *(struct ls_data **)a, *d2 = *(struct ls_data **)b;
1207 return strcmp(d1->path, d2->path);
1210 static int sort_matching_paths(struct ls_options *options)
1212 size_t nmemb = options->num_matching_paths;
1213 size_t size = sizeof(*options->data_ptr);
1214 int (*compar)(const void *, const void *);
1217 options->data_ptr = para_malloc(nmemb * sizeof(*options->data_ptr));
1218 for (i = 0; i < nmemb; i++)
1219 options->data_ptr[i] = options->data + i;
1221 /* In these cases the array is already sorted */
1222 if (options->sorting == LS_SORT_BY_PATH
1223 && !(options->flags & LS_FLAG_ADMISSIBLE_ONLY)
1224 && (options->flags & LS_FLAG_FULL_PATH))
1226 if (options->sorting == LS_SORT_BY_SCORE &&
1227 options->flags & LS_FLAG_ADMISSIBLE_ONLY)
1230 switch (options->sorting) {
1231 case LS_SORT_BY_PATH:
1232 compar = ls_path_compare; break;
1233 case LS_SORT_BY_SCORE:
1234 compar = ls_score_compare; break;
1235 case LS_SORT_BY_LAST_PLAYED:
1236 compar = ls_last_played_compare; break;
1237 case LS_SORT_BY_NUM_PLAYED:
1238 compar = ls_num_played_compare; break;
1239 case LS_SORT_BY_FREQUENCY:
1240 compar = ls_frequency_compare; break;
1241 case LS_SORT_BY_CHANNELS:
1242 compar = ls_channels_compare; break;
1243 case LS_SORT_BY_IMAGE_ID:
1244 compar = ls_image_id_compare; break;
1245 case LS_SORT_BY_LYRICS_ID:
1246 compar = ls_lyrics_id_compare; break;
1247 case LS_SORT_BY_BITRATE:
1248 compar = ls_bitrate_compare; break;
1249 case LS_SORT_BY_DURATION:
1250 compar = ls_duration_compare; break;
1251 case LS_SORT_BY_AUDIO_FORMAT:
1252 compar = ls_audio_format_compare; break;
1256 qsort(options->data_ptr, nmemb, size, compar);
1260 /* row is either an aft_row or a row of the score table */
1261 /* TODO: Only compute widths if we need them */
1262 static int prepare_ls_row(struct osl_row *row, void *ls_opts)
1265 struct ls_options *options = ls_opts;
1267 struct ls_widths *w;
1268 unsigned short num_digits;
1270 struct osl_row *aft_row;
1274 if (options->flags & LS_FLAG_ADMISSIBLE_ONLY) {
1275 ret = get_score_and_aft_row(row, &score, &aft_row);
1280 ret = get_audio_file_path_of_row(aft_row, &path);
1283 if (!(options->flags & LS_FLAG_FULL_PATH)) {
1284 char *p = strrchr(path, '/');
1288 if (options->num_patterns) {
1289 for (i = 0; i < options->num_patterns; i++) {
1290 ret = fnmatch(options->patterns[i], path, 0);
1293 if (ret == FNM_NOMATCH)
1297 if (i >= options->num_patterns) /* no match */
1300 tmp = options->num_matching_paths++;
1301 if (options->num_matching_paths > options->array_size) {
1302 options->array_size++;
1303 options->array_size *= 2;
1304 options->data = para_realloc(options->data, options->array_size
1305 * sizeof(*options->data));
1307 d = options->data + tmp;
1308 ret = get_afsi_of_row(aft_row, &d->afsi);
1311 ret = get_afhi_of_row(aft_row, &d->afhi);
1315 ret = get_hash_of_row(aft_row, &d->hash);
1318 w = &options->widths;
1319 GET_NUM_DIGITS(d->afsi.image_id, &num_digits);
1320 w->image_id_width = PARA_MAX(w->image_id_width, num_digits);
1321 GET_NUM_DIGITS(d->afsi.lyrics_id, &num_digits);
1322 w->lyrics_id_width = PARA_MAX(w->lyrics_id_width, num_digits);
1323 GET_NUM_DIGITS(d->afhi.bitrate, &num_digits);
1324 w->bitrate_width = PARA_MAX(w->bitrate_width, num_digits);
1325 GET_NUM_DIGITS(d->afhi.frequency, &num_digits);
1326 w->frequency_width = PARA_MAX(w->frequency_width, num_digits);
1327 GET_NUM_DIGITS(d->afsi.num_played, &num_digits);
1328 w->num_played_width = PARA_MAX(w->num_played_width, num_digits);
1329 /* get the number of chars to print this amount of time */
1330 num_digits = get_duration_width(d->afhi.seconds_total);
1331 w->duration_width = PARA_MAX(w->duration_width, num_digits);
1332 GET_NUM_DIGITS(d->afsi.amp, &num_digits);
1333 w->amp_width = PARA_MAX(w->amp_width, num_digits);
1334 num_digits = strlen(audio_format_name(d->afsi.audio_format_id));
1335 w->audio_format_width = PARA_MAX(w->audio_format_width, num_digits);
1336 if (options->flags & LS_FLAG_ADMISSIBLE_ONLY) {
1337 GET_NUM_DIGITS(score, &num_digits);
1338 num_digits++; /* add one for the sign (space or "-") */
1339 w->score_width = PARA_MAX(w->score_width, num_digits);
1347 static void com_ls_callback(int fd, const struct osl_object *query)
1349 struct ls_options *opts = query->data;
1350 char *p, *pattern_start = (char *)query->data + sizeof(*opts);
1351 struct para_buffer b = {.max_size = shm_get_shmmax(),
1352 .flags = (opts->mode == LS_MODE_PARSER)? PBF_SIZE_PREFIX : 0,
1353 .max_size_handler = pass_buffer_as_shm, .private_data = &fd};
1355 time_t current_time;
1357 if (opts->num_patterns) {
1358 opts->patterns = para_malloc(opts->num_patterns * sizeof(char *));
1359 for (i = 0, p = pattern_start; i < opts->num_patterns; i++) {
1360 opts->patterns[i] = p;
1364 opts->patterns = NULL;
1365 if (opts->flags & LS_FLAG_ADMISSIBLE_ONLY)
1366 ret = admissible_file_loop(opts, prepare_ls_row);
1368 ret = osl(osl_rbtree_loop(audio_file_table, AFTCOL_PATH, opts,
1372 if (opts->num_matching_paths == 0) {
1373 if (opts->num_patterns > 0)
1374 para_printf(&b, "no matches\n");
1377 ret = sort_matching_paths(opts);
1380 time(¤t_time);
1381 if (opts->flags & LS_FLAG_REVERSE)
1382 for (i = opts->num_matching_paths - 1; i >= 0; i--) {
1383 ret = print_list_item(opts->data_ptr[i], opts, &b, current_time);
1388 for (i = 0; i < opts->num_matching_paths; i++) {
1389 ret = print_list_item(opts->data_ptr[i], opts, &b, current_time);
1395 pass_buffer_as_shm(b.buf, b.offset, &fd);
1398 free(opts->data_ptr);
1399 free(opts->patterns);
1403 * TODO: flags -h (sort by hash)
1405 int com_ls(struct stream_cipher_context *scc, int argc, char * const * const argv)
1409 enum ls_sorting_method sort = LS_SORT_BY_PATH;
1410 enum ls_listing_mode mode = LS_MODE_SHORT;
1411 struct ls_options opts = {.patterns = NULL};
1412 struct osl_object query = {.data = &opts, .size = sizeof(opts)};
1414 for (i = 1; i < argc; i++) {
1415 const char *arg = argv[i];
1418 if (!strcmp(arg, "--")) {
1422 if (!strncmp(arg, "-l", 2)) {
1424 mode = LS_MODE_LONG;
1428 return -E_AFT_SYNTAX;
1429 switch(*(arg + 2)) {
1431 mode = LS_MODE_SHORT;
1434 mode = LS_MODE_LONG;
1437 mode = LS_MODE_VERBOSE;
1440 mode = LS_MODE_MBOX;
1443 mode = LS_MODE_CHUNKS;
1446 mode = LS_MODE_PARSER;
1449 return -E_AFT_SYNTAX;
1452 if (!strcmp(arg, "-p")) {
1453 flags |= LS_FLAG_FULL_PATH;
1456 if (!strcmp(arg, "-a")) {
1457 flags |= LS_FLAG_ADMISSIBLE_ONLY;
1460 if (!strcmp(arg, "-r")) {
1461 flags |= LS_FLAG_REVERSE;
1464 if (!strcmp(arg, "-d")) {
1465 flags |= LS_FLAG_UNIXDATE;
1468 if (!strncmp(arg, "-s", 2)) {
1469 if (!*(arg + 2) || *(arg + 3))
1470 return -E_AFT_SYNTAX;
1471 switch(*(arg + 2)) {
1473 sort = LS_SORT_BY_PATH;
1475 case 's': /* -ss implies -a */
1476 sort = LS_SORT_BY_SCORE;
1477 flags |= LS_FLAG_ADMISSIBLE_ONLY;
1480 sort = LS_SORT_BY_LAST_PLAYED;
1483 sort = LS_SORT_BY_NUM_PLAYED;
1486 sort = LS_SORT_BY_FREQUENCY;
1489 sort = LS_SORT_BY_CHANNELS;
1492 sort = LS_SORT_BY_IMAGE_ID;
1495 sort = LS_SORT_BY_LYRICS_ID;
1498 sort = LS_SORT_BY_BITRATE;
1501 sort = LS_SORT_BY_DURATION;
1504 sort = LS_SORT_BY_AUDIO_FORMAT;
1507 return -E_AFT_SYNTAX;
1510 return -E_AFT_SYNTAX;
1513 opts.sorting = sort;
1515 opts.num_patterns = argc - i;
1516 ret = send_option_arg_callback_request(&query, opts.num_patterns,
1517 argv + i, com_ls_callback, sc_send_result, scc);
1522 * Call the given function for each file in the audio file table.
1524 * \param private_data An arbitrary data pointer, passed to \a func.
1525 * \param func The custom function to be called.
1529 int audio_file_loop(void *private_data, osl_rbtree_loop_func *func)
1531 return osl(osl_rbtree_loop(audio_file_table, AFTCOL_HASH, private_data,
1535 static struct osl_row *find_hash_sister(unsigned char *hash)
1537 const struct osl_object obj = {.data = hash, .size = HASH_SIZE};
1538 struct osl_row *row;
1540 osl_get_row(audio_file_table, AFTCOL_HASH, &obj, &row);
1544 /** The format of the data stored by save_audio_file_data(). */
1545 enum com_add_buffer_offsets {
1546 /** afhi (if present) starts here. */
1547 CAB_AFHI_OFFSET_POS = 0,
1548 /** Start of the chunk table (if present). */
1549 CAB_CHUNKS_OFFSET_POS = 2,
1550 /** Audio format id. */
1551 CAB_AUDIO_FORMAT_OFFSET = 4,
1552 /** Flags given to the add command. */
1553 CAB_FLAGS_OFFSET = 5,
1554 /** The hash of the audio file being added. */
1555 CAB_HASH_OFFSET = 9,
1556 /** Start of the path of the audio file. */
1557 CAB_PATH_OFFSET = (CAB_HASH_OFFSET + HASH_SIZE),
1561 * Store the given data to a single buffer. Doesn't need the audio file selector
1562 * info struct as the server knows it as well.
1564 * It's OK to call this with afhi == NULL. In this case, the audio format
1565 * handler info won't be stored in the buffer.
1567 static void save_add_callback_buffer(unsigned char *hash, const char *path,
1568 struct afh_info *afhi, uint32_t flags,
1569 uint8_t audio_format_num, struct osl_object *obj)
1571 size_t path_len = strlen(path) + 1;
1572 size_t afhi_size = sizeof_afhi_buf(afhi);
1573 size_t size = CAB_PATH_OFFSET + path_len + afhi_size
1574 + sizeof_chunk_table(afhi);
1575 char *buf = para_malloc(size);
1578 write_u8(buf + CAB_AUDIO_FORMAT_OFFSET, audio_format_num);
1579 write_u32(buf + CAB_FLAGS_OFFSET, flags);
1581 memcpy(buf + CAB_HASH_OFFSET, hash, HASH_SIZE);
1582 strcpy(buf + CAB_PATH_OFFSET, path);
1584 pos = CAB_PATH_OFFSET + path_len;
1585 PARA_DEBUG_LOG("size: %zu, afhi starts at %d\n", size, pos);
1586 PARA_DEBUG_LOG("last afhi byte: %p, pos %zu\n", buf + pos + afhi_size - 1,
1587 pos + afhi_size - 1);
1588 write_u16(buf + CAB_AFHI_OFFSET_POS, pos);
1589 save_afhi(afhi, buf + pos);
1592 PARA_DEBUG_LOG("size: %zu, chunks start at %d\n", size, pos);
1593 write_u16(buf + CAB_CHUNKS_OFFSET_POS, pos);
1595 save_chunk_table(afhi, buf + pos);
1596 PARA_DEBUG_LOG("last byte in buf: %p\n", buf + size - 1);
1603 Overview of the add command.
1605 Input: What was passed to the callback by the command handler.
1607 HS: Hash sister. Whether an audio file with identical hash
1608 already exists in the osl database.
1610 PB: Path brother. Whether a file with the given path exists
1613 F: Force flag given. Whether add was called with -f.
1615 output: Action performed by the callback.
1617 AFHI: Whether afhi and chunk table are computed and sent.
1618 ACTION: Table modifications to be done by the callback.
1620 +----+----+---+------+---------------------------------------------------+
1621 | HS | PB | F | AFHI | ACTION
1622 +----+----+---+------+---------------------------------------------------+
1623 | Y | Y | Y | Y | if HS != PB: remove PB. HS: force afhi update,
1624 | | update path, keep afsi
1625 +----+----+---+------+---------------------------------------------------+
1626 | Y | Y | N | N | if HS == PB: do not send callback request at all.
1627 | | otherwise: remove PB, HS: update path, keep afhi,
1629 +----+----+---+------+---------------------------------------------------+
1630 | Y | N | Y | Y | (rename) force afhi update of HS, update path of
1632 +----+----+---+------+---------------------------------------------------+
1633 | Y | N | N | N | (file rename) update path of HS, keep afsi, afhi
1634 +----+----+---+------+---------------------------------------------------+
1635 | N | Y | Y | Y | (file change) update afhi, hash, of PB, keep afsi
1636 | | (force has no effect)
1637 +----+----+---+------+---------------------------------------------------+
1638 | N | Y | N | Y | (file change) update afhi, hash of PB, keep afsi
1639 +----+----+---+------+---------------------------------------------------+
1640 | N | N | Y | Y | (new file) create new entry (force has no effect)
1641 +----+----+---+------+---------------------------------------------------+
1642 | N | N | N | Y | (new file) create new entry
1643 +----+----+---+------+---------------------------------------------------+
1647 afhi <=> force or no HS
1652 /** Flags passed to the add command. */
1653 enum com_add_flags {
1654 /** Skip paths that exist already. */
1656 /** Force adding. */
1658 /** Print what is being done. */
1659 ADD_FLAG_VERBOSE = 4,
1660 /** Try to add files with unknown suffixes. */
1664 static void com_add_callback(int fd, const struct osl_object *query)
1666 char *buf = query->data, *path;
1667 struct osl_row *pb, *aft_row;
1669 struct osl_object objs[NUM_AFT_COLUMNS];
1670 unsigned char *hash;
1671 char asc[2 * HASH_SIZE + 1];
1673 char afsi_buf[AFSI_SIZE];
1674 uint32_t flags = read_u32(buf + CAB_FLAGS_OFFSET);
1675 struct afs_info default_afsi = {.last_played = 0};
1676 struct para_buffer msg = {.max_size = shm_get_shmmax(),
1677 .max_size_handler = pass_buffer_as_shm, .private_data = &fd};
1678 uint16_t afhi_offset, chunks_offset;
1680 hash = (unsigned char *)buf + CAB_HASH_OFFSET;
1681 hash_to_asc(hash, asc);;
1682 objs[AFTCOL_HASH].data = buf + CAB_HASH_OFFSET;
1683 objs[AFTCOL_HASH].size = HASH_SIZE;
1685 path = buf + CAB_PATH_OFFSET;
1686 objs[AFTCOL_PATH].data = path;
1687 objs[AFTCOL_PATH].size = strlen(path) + 1;
1689 PARA_INFO_LOG("request to add %s\n", path);
1690 hs = find_hash_sister(hash);
1691 ret = aft_get_row_of_path(path, &pb);
1692 if (ret < 0 && ret != -OSL_ERRNO_TO_PARA_ERROR(E_OSL_RB_KEY_NOT_FOUND))
1694 if (hs && pb && hs == pb && !(flags & ADD_FLAG_FORCE)) {
1695 if (flags & ADD_FLAG_VERBOSE)
1696 ret = para_printf(&msg, "ignoring duplicate\n");
1701 if (hs && hs != pb) {
1702 struct osl_object obj;
1703 if (pb) { /* hs trumps pb, remove pb */
1704 if (flags & ADD_FLAG_VERBOSE) {
1705 ret = para_printf(&msg, "removing path brother\n");
1709 ret = osl(osl_del_row(audio_file_table, pb));
1714 /* file rename, update hs' path */
1715 if (flags & ADD_FLAG_VERBOSE) {
1716 ret = osl(osl_get_object(audio_file_table, hs,
1717 AFTCOL_PATH, &obj));
1720 ret = para_printf(&msg, "renamed from %s\n", (char *)obj.data);
1724 ret = osl(osl_update_object(audio_file_table, hs, AFTCOL_PATH,
1725 &objs[AFTCOL_PATH]));
1728 afs_event(AUDIO_FILE_RENAME, &msg, hs);
1729 if (!(flags & ADD_FLAG_FORCE))
1732 /* no hs or force mode, child must have sent afhi */
1733 afhi_offset = read_u16(buf + CAB_AFHI_OFFSET_POS);
1734 chunks_offset = read_u16(buf + CAB_CHUNKS_OFFSET_POS);
1736 objs[AFTCOL_AFHI].data = buf + afhi_offset;
1737 objs[AFTCOL_AFHI].size = chunks_offset - afhi_offset;
1739 if (!objs[AFTCOL_AFHI].size) /* "impossible" */
1741 objs[AFTCOL_CHUNKS].data = buf + chunks_offset;
1742 objs[AFTCOL_CHUNKS].size = query->size - chunks_offset;
1743 if (pb && !hs) { /* update pb's hash */
1744 char old_asc[2 * HASH_SIZE + 1];
1745 unsigned char *old_hash;
1746 ret = get_hash_of_row(pb, &old_hash);
1749 hash_to_asc(old_hash, old_asc);
1750 if (flags & ADD_FLAG_VERBOSE) {
1751 ret = para_printf(&msg, "file change: %s -> %s\n",
1756 ret = osl_update_object(audio_file_table, pb, AFTCOL_HASH,
1757 &objs[AFTCOL_HASH]);
1761 if (hs || pb) { /* (hs != NULL and pb != NULL) implies hs == pb */
1762 struct osl_row *row = pb? pb : hs;
1763 /* update afhi and chunk_table */
1764 if (flags & ADD_FLAG_VERBOSE) {
1765 ret = para_printf(&msg, "updating afhi and chunk table\n");
1769 ret = osl(osl_update_object(audio_file_table, row, AFTCOL_AFHI,
1770 &objs[AFTCOL_AFHI]));
1773 ret = osl(osl_update_object(audio_file_table, row, AFTCOL_CHUNKS,
1774 &objs[AFTCOL_CHUNKS]));
1777 afs_event(AFHI_CHANGE, &msg, row);
1780 /* new entry, use default afsi */
1781 if (flags & ADD_FLAG_VERBOSE) {
1782 ret = para_printf(&msg, "new file\n");
1786 default_afsi.last_played = time(NULL) - 365 * 24 * 60 * 60;
1787 default_afsi.audio_format_id = read_u8(buf + CAB_AUDIO_FORMAT_OFFSET);
1789 objs[AFTCOL_AFSI].data = &afsi_buf;
1790 objs[AFTCOL_AFSI].size = AFSI_SIZE;
1791 save_afsi(&default_afsi, &objs[AFTCOL_AFSI]);
1792 ret = osl(osl_add_and_get_row(audio_file_table, objs, &aft_row));
1793 afs_event(AUDIO_FILE_ADD, &msg, aft_row);
1796 para_printf(&msg, "%s\n", para_strerror(-ret));
1798 pass_buffer_as_shm(msg.buf, msg.offset, &fd);
1802 /** Used by com_add(). */
1803 struct private_add_data {
1804 /** The socket file descriptor, including stream cipher keys. */
1805 struct stream_cipher_context *scc;
1806 /** The given add flags. */
1810 static void path_brother_callback(int fd, const struct osl_object *query)
1812 char *path = query->data;
1813 struct osl_row *path_brother;
1814 int ret = aft_get_row_of_path(path, &path_brother);
1817 pass_buffer_as_shm((char *)&path_brother, sizeof(path_brother), &fd);
1820 static void hash_sister_callback(int fd, const struct osl_object *query)
1822 unsigned char *hash = query->data;
1823 struct osl_row *hash_sister;
1825 hash_sister = find_hash_sister(hash);
1828 pass_buffer_as_shm((char *)&hash_sister, sizeof(hash_sister), &fd);
1831 static int get_row_pointer_from_result(struct osl_object *result, void *private)
1833 struct osl_row **row = private;
1834 *row = *(struct osl_row **)(result->data);
1838 static int add_one_audio_file(const char *path, void *private_data)
1840 int ret, send_ret = 1, fd;
1841 uint8_t format_num = -1;
1842 struct private_add_data *pad = private_data;
1843 struct afh_info afhi, *afhi_ptr = NULL;
1844 struct osl_row *pb = NULL, *hs = NULL; /* path brother/hash sister */
1845 struct osl_object map, obj = {.data = NULL}, query;
1846 unsigned char hash[HASH_SIZE];
1848 ret = guess_audio_format(path);
1849 if (ret < 0 && !(pad->flags & ADD_FLAG_ALL))
1851 query.data = (char *)path;
1852 query.size = strlen(path) + 1;
1853 ret = send_callback_request(path_brother_callback, &query,
1854 get_row_pointer_from_result, &pb);
1855 if (ret < 0 && ret != -OSL_ERRNO_TO_PARA_ERROR(E_OSL_RB_KEY_NOT_FOUND))
1858 if (pb && (pad->flags & ADD_FLAG_LAZY)) { /* lazy is really cheap */
1859 if (pad->flags & ADD_FLAG_VERBOSE)
1860 send_ret = sc_send_va_buffer(pad->scc,
1861 "lazy-ignore: %s\n", path);
1864 /* We still want to add this file. Compute its hash. */
1865 ret = mmap_full_file(path, O_RDONLY, &map.data, &map.size, &fd);
1868 hash_function(map.data, map.size, hash);
1870 /* Check whether the database contains a file with the same hash. */
1872 query.size = HASH_SIZE;
1873 ret = send_callback_request(hash_sister_callback, &query,
1874 get_row_pointer_from_result, &hs);
1877 /* Return success if we already know this file. */
1879 if (pb && hs && hs == pb && !(pad->flags & ADD_FLAG_FORCE)) {
1880 if (pad->flags & ADD_FLAG_VERBOSE)
1881 send_ret = sc_send_va_buffer(pad->scc,
1882 "%s exists, not forcing update\n", path);
1886 * We won't recalculate the audio format info and the chunk table if
1887 * there is a hash sister and FORCE was not given.
1889 if (!hs || (pad->flags & ADD_FLAG_FORCE)) {
1890 ret = compute_afhi(path, map.data, map.size, fd, &afhi);
1896 munmap(map.data, map.size);
1898 if (pad->flags & ADD_FLAG_VERBOSE) {
1899 send_ret = sc_send_va_buffer(pad->scc, "adding %s\n", path);
1903 save_add_callback_buffer(hash, path, afhi_ptr, pad->flags, format_num, &obj);
1904 /* Ask afs to consider this entry for adding. */
1905 ret = send_callback_request(com_add_callback, &obj, sc_send_result, pad->scc);
1910 munmap(map.data, map.size);
1912 if (ret < 0 && send_ret >= 0)
1913 send_ret = sc_send_va_buffer(pad->scc,
1914 "failed to add %s (%s)\n", path, para_strerror(-ret));
1917 free(afhi_ptr->chunk_table);
1918 free(afhi_ptr->techinfo);
1919 free(afhi_ptr->tags.artist);
1920 free(afhi_ptr->tags.title);
1921 free(afhi_ptr->tags.year);
1922 free(afhi_ptr->tags.album);
1923 free(afhi_ptr->tags.comment);
1925 /* Stop adding files only on send errors. */
1929 int com_add(struct stream_cipher_context *scc, int argc, char * const * const argv)
1932 struct private_add_data pad = {.scc = scc, .flags = 0};
1933 struct stat statbuf;
1935 for (i = 1; i < argc; i++) {
1936 const char *arg = argv[i];
1939 if (!strcmp(arg, "--")) {
1943 if (!strcmp(arg, "-a")) {
1944 pad.flags |= ADD_FLAG_ALL;
1947 if (!strcmp(arg, "-l")) {
1948 pad.flags |= ADD_FLAG_LAZY;
1951 if (!strcmp(arg, "-f")) {
1952 pad.flags |= ADD_FLAG_FORCE;
1955 if (!strcmp(arg, "-v")) {
1956 pad.flags |= ADD_FLAG_VERBOSE;
1961 return -E_AFT_SYNTAX;
1962 for (; i < argc; i++) {
1964 ret = verify_path(argv[i], &path);
1966 ret = sc_send_va_buffer(scc, "%s: %s\n", argv[i],
1967 para_strerror(-ret));
1972 ret = stat(path, &statbuf);
1974 ret = sc_send_va_buffer(scc, "failed to stat %s (%s)\n", path,
1981 if (S_ISDIR(statbuf.st_mode))
1982 ret = for_each_file_in_dir(path, add_one_audio_file,
1985 ret = add_one_audio_file(path, &pad);
1987 sc_send_va_buffer(scc, "%s: %s\n", path, para_strerror(-ret));
1998 * Flags used by the touch command.
2003 /** Whether the \p FNM_PATHNAME flag should be passed to fnmatch(). */
2004 TOUCH_FLAG_FNM_PATHNAME = 1,
2005 /** Activates verbose mode. */
2006 TOUCH_FLAG_VERBOSE = 2
2009 /** Options used by com_touch(). */
2010 struct com_touch_options {
2011 /** New num_played value. */
2013 /** New last played count. */
2014 int64_t last_played;
2015 /** New lyrics id. */
2017 /** New image id. */
2019 /** New amplification value. */
2021 /** Command line flags (see \ref touch_flags). */
2025 /** Data passed to the action handler of com_touch(). */
2026 struct touch_action_data {
2027 /** Command line options (see \ref com_touch_options). */
2028 struct com_touch_options *cto;
2029 /** Message buffer. */
2030 struct para_buffer pb;
2033 static int touch_audio_file(__a_unused struct osl_table *table,
2034 struct osl_row *row, const char *name, void *data)
2036 struct touch_action_data *tad = data;
2037 struct osl_object obj;
2038 struct afs_info old_afsi, new_afsi;
2039 int ret, no_options = tad->cto->num_played < 0 && tad->cto->last_played < 0 &&
2040 tad->cto->lyrics_id < 0 && tad->cto->image_id < 0 && tad->cto->amp < 0;
2041 struct afsi_change_event_data aced;
2043 ret = get_afsi_object_of_row(row, &obj);
2045 return para_printf(&tad->pb, "%s: %s\n", name, para_strerror(-ret));
2046 ret = load_afsi(&old_afsi, &obj);
2048 return para_printf(&tad->pb, "%s: %s\n", name, para_strerror(-ret));
2049 new_afsi = old_afsi;
2051 new_afsi.num_played++;
2052 new_afsi.last_played = time(NULL);
2053 if (tad->cto->flags & TOUCH_FLAG_VERBOSE) {
2054 ret = para_printf(&tad->pb, "%s: num_played = %u, "
2055 "last_played = now()\n", name,
2056 new_afsi.num_played);
2061 if (tad->cto->flags & TOUCH_FLAG_VERBOSE) {
2062 ret = para_printf(&tad->pb, "touching %s\n", name);
2066 if (tad->cto->lyrics_id >= 0)
2067 new_afsi.lyrics_id = tad->cto->lyrics_id;
2068 if (tad->cto->image_id >= 0)
2069 new_afsi.image_id = tad->cto->image_id;
2070 if (tad->cto->num_played >= 0)
2071 new_afsi.num_played = tad->cto->num_played;
2072 if (tad->cto->last_played >= 0)
2073 new_afsi.last_played = tad->cto->last_played;
2074 if (tad->cto->amp >= 0)
2075 new_afsi.amp = tad->cto->amp;
2077 save_afsi(&new_afsi, &obj); /* in-place update */
2079 aced.old_afsi = &old_afsi;
2080 afs_event(AFSI_CHANGE, &tad->pb, &aced);
2084 static void com_touch_callback(int fd, const struct osl_object *query)
2086 struct touch_action_data tad = {.cto = query->data,
2088 .max_size = shm_get_shmmax(),
2089 .private_data = &fd,
2090 .max_size_handler = pass_buffer_as_shm
2094 struct pattern_match_data pmd = {
2095 .table = audio_file_table,
2096 .loop_col_num = AFTCOL_HASH,
2097 .match_col_num = AFTCOL_PATH,
2098 .patterns = {.data = (char *)query->data + sizeof(*tad.cto),
2099 .size = query->size - sizeof(*tad.cto)},
2101 .action = touch_audio_file
2103 if (tad.cto->flags & TOUCH_FLAG_FNM_PATHNAME)
2104 pmd.fnmatch_flags |= FNM_PATHNAME;
2105 ret = for_each_matching_row(&pmd);
2107 ret2 = para_printf(&tad.pb, "%s\n", para_strerror(-ret));
2108 else if (pmd.num_matches == 0)
2109 ret2 = para_printf(&tad.pb, "no matches\n");
2110 if (ret2 >= 0 && tad.pb.offset)
2111 pass_buffer_as_shm(tad.pb.buf, tad.pb.offset, &fd);
2115 int com_touch(struct stream_cipher_context *scc, int argc, char * const * const argv)
2117 struct com_touch_options cto = {
2124 struct osl_object query = {.data = &cto, .size = sizeof(cto)};
2128 for (i = 1; i < argc; i++) {
2129 const char *arg = argv[i];
2132 if (!strcmp(arg, "--")) {
2136 if (!strncmp(arg, "-n=", 3)) {
2137 ret = para_atoi32(arg + 3, &cto.num_played);
2142 if (!strncmp(arg, "-l=", 3)) {
2143 ret = para_atoi64(arg + 3, &cto.last_played);
2148 if (!strncmp(arg, "-y=", 3)) {
2149 ret = para_atoi32(arg + 3, &cto.lyrics_id);
2154 if (!strncmp(arg, "-i=", 3)) {
2155 ret = para_atoi32(arg + 3, &cto.image_id);
2160 if (!strncmp(arg, "-a=", 3)) {
2162 ret = para_atoi32(arg + 3, &val);
2165 if (val < 0 || val > 255)
2166 return -ERRNO_TO_PARA_ERROR(EINVAL);
2170 if (!strcmp(arg, "-p")) {
2171 cto.flags |= TOUCH_FLAG_FNM_PATHNAME;
2174 if (!strcmp(arg, "-v")) {
2175 cto.flags |= TOUCH_FLAG_VERBOSE;
2178 break; /* non-option starting with dash */
2181 return -E_AFT_SYNTAX;
2182 ret = send_option_arg_callback_request(&query, argc - i,
2183 argv + i, com_touch_callback, sc_send_result, scc);
2185 sc_send_va_buffer(scc, "%s\n", para_strerror(-ret));
2189 /** Flags for com_rm(). */
2192 RM_FLAG_VERBOSE = 1,
2196 RM_FLAG_FNM_PATHNAME = 4
2199 /** Data passed to the action handler of com_rm(). */
2200 struct com_rm_action_data {
2201 /** Command line flags ((see \ref rm_flags). */
2203 /** Message buffer. */
2204 struct para_buffer pb;
2207 static int remove_audio_file(__a_unused struct osl_table *table,
2208 struct osl_row *row, const char *name, void *data)
2210 struct com_rm_action_data *crd = data;
2213 if (crd->flags & RM_FLAG_VERBOSE) {
2214 ret = para_printf(&crd->pb, "removing %s\n", name);
2218 afs_event(AUDIO_FILE_REMOVE, &crd->pb, row);
2219 ret = osl(osl_del_row(audio_file_table, row));
2221 para_printf(&crd->pb, "%s: %s\n", name, para_strerror(-ret));
2225 static void com_rm_callback(int fd, const struct osl_object *query)
2227 struct com_rm_action_data crd = {.flags = *(uint32_t *)query->data,
2229 .max_size = shm_get_shmmax(),
2230 .private_data = &fd,
2231 .max_size_handler = pass_buffer_as_shm
2235 struct pattern_match_data pmd = {
2236 .table = audio_file_table,
2237 .loop_col_num = AFTCOL_HASH,
2238 .match_col_num = AFTCOL_PATH,
2239 .patterns = {.data = (char *)query->data + sizeof(uint32_t),
2240 .size = query->size - sizeof(uint32_t)},
2242 .action = remove_audio_file
2244 if (crd.flags & RM_FLAG_FNM_PATHNAME)
2245 pmd.fnmatch_flags |= FNM_PATHNAME;
2246 ret = for_each_matching_row(&pmd);
2248 para_printf(&crd.pb, "%s\n", para_strerror(-ret));
2251 if ((pmd.num_matches == 0) && !(crd.flags & RM_FLAG_FORCE))
2252 ret = para_printf(&crd.pb, "no matches -- nothing removed\n");
2253 else if (crd.flags & RM_FLAG_VERBOSE) {
2254 ret = para_printf(&crd.pb, "removed %u files\n",
2257 if (ret >= 0 && crd.pb.offset)
2258 pass_buffer_as_shm(crd.pb.buf, crd.pb.offset, &fd);
2262 /* TODO options: -r (recursive) */
2263 int com_rm(struct stream_cipher_context *scc, int argc, char * const * const argv)
2266 struct osl_object query = {.data = &flags, .size = sizeof(flags)};
2269 for (i = 1; i < argc; i++) {
2270 const char *arg = argv[i];
2273 if (!strcmp(arg, "--")) {
2277 if (!strcmp(arg, "-f")) {
2278 flags |= RM_FLAG_FORCE;
2281 if (!strcmp(arg, "-p")) {
2282 flags |= RM_FLAG_FNM_PATHNAME;
2285 if (!strcmp(arg, "-v")) {
2286 flags |= RM_FLAG_VERBOSE;
2292 return -E_AFT_SYNTAX;
2293 ret = send_option_arg_callback_request(&query, argc - i, argv + i,
2294 com_rm_callback, sc_send_result, scc);
2296 sc_send_va_buffer(scc, "%s\n", para_strerror(-ret));
2301 * Flags used by the cpsi command.
2306 /** Whether the lyrics id should be copied. */
2307 CPSI_FLAG_COPY_LYRICS_ID = 1,
2308 /** Whether the image id should be copied. */
2309 CPSI_FLAG_COPY_IMAGE_ID = 2,
2310 /** Whether the lastplayed time should be copied. */
2311 CPSI_FLAG_COPY_LASTPLAYED = 4,
2312 /** Whether the numplayed count should be copied. */
2313 CPSI_FLAG_COPY_NUMPLAYED = 8,
2314 /** Whether the attributes should be copied. */
2315 CPSI_FLAG_COPY_ATTRIBUTES = 16,
2316 /** Activates verbose mode. */
2317 CPSI_FLAG_VERBOSE = 32,
2320 /** Data passed to the action handler of com_cpsi(). */
2321 struct cpsi_action_data {
2322 /** command line flags (see \ref cpsi_flags). */
2324 /** Message buffer. */
2325 struct para_buffer pb;
2326 /** Values are copied from here. */
2327 struct afs_info source_afsi;
2330 static int copy_selector_info(__a_unused struct osl_table *table,
2331 struct osl_row *row, const char *name, void *data)
2333 struct cpsi_action_data *cad = data;
2334 struct osl_object target_afsi_obj;
2336 struct afs_info old_afsi, target_afsi;
2337 struct afsi_change_event_data aced;
2339 ret = get_afsi_object_of_row(row, &target_afsi_obj);
2342 load_afsi(&target_afsi, &target_afsi_obj);
2343 old_afsi = target_afsi;
2344 if (cad->flags & CPSI_FLAG_COPY_LYRICS_ID)
2345 target_afsi.lyrics_id = cad->source_afsi.lyrics_id;
2346 if (cad->flags & CPSI_FLAG_COPY_IMAGE_ID)
2347 target_afsi.image_id = cad->source_afsi.image_id;
2348 if (cad->flags & CPSI_FLAG_COPY_LASTPLAYED)
2349 target_afsi.last_played = cad->source_afsi.last_played;
2350 if (cad->flags & CPSI_FLAG_COPY_NUMPLAYED)
2351 target_afsi.num_played = cad->source_afsi.num_played;
2352 if (cad->flags & CPSI_FLAG_COPY_ATTRIBUTES)
2353 target_afsi.attributes = cad->source_afsi.attributes;
2354 save_afsi(&target_afsi, &target_afsi_obj); /* in-place update */
2355 if (cad->flags & CPSI_FLAG_VERBOSE) {
2356 ret = para_printf(&cad->pb, "copied afsi to %s\n", name);
2361 aced.old_afsi = &old_afsi;
2362 afs_event(AFSI_CHANGE, &cad->pb, &aced);
2366 static void com_cpsi_callback(int fd, const struct osl_object *query)
2368 struct cpsi_action_data cad = {
2369 .flags = *(unsigned *)query->data,
2371 .max_size = shm_get_shmmax(),
2372 .private_data = &fd,
2373 .max_size_handler = pass_buffer_as_shm
2377 char *source_path = (char *)query->data + sizeof(cad.flags);
2378 struct pattern_match_data pmd = {
2379 .table = audio_file_table,
2380 .loop_col_num = AFTCOL_HASH,
2381 .match_col_num = AFTCOL_PATH,
2382 .patterns = {.data = source_path + strlen(source_path) + 1,
2383 .size = query->size - sizeof(cad.flags)
2384 - strlen(source_path) - 1},
2386 .action = copy_selector_info
2389 ret = get_afsi_of_path(source_path, &cad.source_afsi);
2392 ret = for_each_matching_row(&pmd);
2395 para_printf(&cad.pb, "%s\n", para_strerror(-ret));
2396 else if (cad.flags & CPSI_FLAG_VERBOSE) {
2397 if (pmd.num_matches > 0)
2398 para_printf(&cad.pb, "copied requested afsi from %s "
2399 "to %u files\n", source_path, pmd.num_matches);
2401 para_printf(&cad.pb, "nothing copied\n");
2404 pass_buffer_as_shm(cad.pb.buf, cad.pb.offset, &fd);
2408 int com_cpsi(struct stream_cipher_context *scc, int argc, char * const * const argv)
2412 struct osl_object options = {.data = &flags, .size = sizeof(flags)};
2414 for (i = 1; i < argc; i++) {
2415 const char *arg = argv[i];
2418 if (!strcmp(arg, "--")) {
2422 if (!strcmp(arg, "-y")) {
2423 flags |= CPSI_FLAG_COPY_LYRICS_ID;
2426 if (!strcmp(arg, "-i")) {
2427 flags |= CPSI_FLAG_COPY_IMAGE_ID;
2430 if (!strcmp(arg, "-l")) {
2431 flags |= CPSI_FLAG_COPY_LASTPLAYED;
2434 if (!strcmp(arg, "-n")) {
2435 flags |= CPSI_FLAG_COPY_NUMPLAYED;
2438 if (!strcmp(arg, "-a")) {
2439 flags |= CPSI_FLAG_COPY_ATTRIBUTES;
2442 if (!strcmp(arg, "-v")) {
2443 flags |= CPSI_FLAG_VERBOSE;
2448 if (i + 1 >= argc) /* need at least source file and pattern */
2449 return -E_AFT_SYNTAX;
2450 if (!(flags & ~CPSI_FLAG_VERBOSE)) /* no copy flags given */
2451 flags = ~(unsigned)CPSI_FLAG_VERBOSE | flags;
2452 ret = send_option_arg_callback_request(&options, argc - i, argv + i,
2453 com_cpsi_callback, sc_send_result, scc);
2455 sc_send_va_buffer(scc, "%s\n", para_strerror(-ret));
2459 static void afs_stat_callback(int fd, const struct osl_object *query)
2461 int *parser_friendly = query->data;
2462 char *buf = *parser_friendly?
2463 parser_friendly_status_items : status_items;
2467 pass_buffer_as_shm(buf, strlen(buf), &fd);
2471 * Get the current afs status items from the afs process and send it.
2473 * \param scc The stream cipher context for data encryption.
2474 * \param parser_friendly Whether parser-friendly output format should be used.
2476 * As the contents of the afs status items change in time and the command
2477 * handler only has a COW version created at fork time, it can not send
2478 * up-to-date afs status items directly. Therefore the usual callback mechanism
2479 * is used to pass the status items from the afs process to the command handler
2480 * via a shared memory area and a pipe.
2482 * \return The return value of the underyling call to \ref send_callback_request().
2484 int send_afs_status(struct stream_cipher_context *scc, int parser_friendly)
2486 struct osl_object query = {.data = &parser_friendly,
2487 .size = sizeof(parser_friendly)};
2489 return send_callback_request(afs_stat_callback, &query, sc_send_result, scc);
2492 /* TODO: optionally fix problems by removing offending rows */
2493 static int check_audio_file(struct osl_row *row, void *data)
2496 struct para_buffer *pb = data;
2497 struct stat statbuf;
2498 int ret = get_audio_file_path_of_row(row, &path);
2499 struct afs_info afsi;
2503 return para_printf(pb, "%s\n", para_strerror(-ret));
2504 if (stat(path, &statbuf) < 0) {
2505 ret = para_printf(pb, "%s: stat error (%s)\n", path, strerror(errno));
2509 if (!S_ISREG(statbuf.st_mode)) {
2510 ret = para_printf(pb, "%s: not a regular file\n", path);
2515 ret = get_afsi_of_row(row, &afsi);
2517 return para_printf(pb, "%s: %s\n", path, para_strerror(-ret));
2518 ret = lyr_get_name_by_id(afsi.lyrics_id, &blob_name);
2520 ret = para_printf(pb, "%s lyrics id %u: %s\n", path, afsi.lyrics_id,
2521 para_strerror(-ret));
2525 ret = img_get_name_by_id(afsi.image_id, &blob_name);
2527 ret = para_printf(pb, "%s image id %u: %s\n", path, afsi.image_id,
2528 para_strerror(-ret));
2533 * Check the audio file table for inconsistencies.
2535 * \param fd The afs socket.
2536 * \param query Unused.
2538 * This function always succeeds.
2542 void aft_check_callback(int fd, __a_unused const struct osl_object *query)
2544 struct para_buffer pb = {
2545 .max_size = shm_get_shmmax(),
2546 .private_data = &fd,
2547 .max_size_handler = pass_buffer_as_shm
2549 int ret = para_printf(&pb, "checking audio file table...\n");
2553 audio_file_loop(&pb, check_audio_file);
2555 pass_buffer_as_shm(pb.buf, pb.offset, &fd);
2560 * Close the audio file table.
2562 * \param flags Usual flags that are passed to osl_close_table().
2564 * \sa osl_close_table().
2566 static void aft_close(void)
2568 osl_close_table(audio_file_table, OSL_MARK_CLEAN);
2569 audio_file_table = NULL;
2573 * Open the audio file table.
2575 * \param dir The database directory.
2579 * \sa osl_open_table().
2581 static int aft_open(const char *dir)
2585 audio_file_table_desc.dir = dir;
2586 ret = osl(osl_open_table(&audio_file_table_desc, &audio_file_table));
2589 osl_get_num_rows(audio_file_table, &num);
2590 PARA_INFO_LOG("audio file table contains %d files\n", num);
2593 PARA_INFO_LOG("failed to open audio file table\n");
2594 audio_file_table = NULL;
2595 if (ret >= 0 || ret == -OSL_ERRNO_TO_PARA_ERROR(E_OSL_NOENT))
2600 static int aft_create(const char *dir)
2602 audio_file_table_desc.dir = dir;
2603 return osl(osl_create_table(&audio_file_table_desc));
2606 static int clear_attribute(struct osl_row *row, void *data)
2608 struct rmatt_event_data *red = data;
2609 struct afs_info afsi;
2610 struct osl_object obj;
2611 int ret = get_afsi_object_of_row(row, &obj);
2612 uint64_t mask = ~(1ULL << red->bitnum);
2616 ret = load_afsi(&afsi, &obj);
2619 afsi.attributes &= mask;
2620 save_afsi(&afsi, &obj);
2624 static int aft_event_handler(enum afs_events event, struct para_buffer *pb,
2630 case ATTRIBUTE_REMOVE: {
2631 const struct rmatt_event_data *red = data;
2632 ret = para_printf(pb, "clearing attribute %s (bit %u) from all "
2633 "entries in the audio file table\n", red->name,
2637 return audio_file_loop(data, clear_attribute);
2645 * Initialize the audio file table.
2647 * \param t Pointer to the structure to be initialized.
2649 void aft_init(struct afs_table *t)
2652 t->close = aft_close;
2653 t->create = aft_create;
2654 t->event_handler = aft_event_handler;