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. */
10 #include <dirent.h> /* readdir() */
25 #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;
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 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 audio_format_name(afsi->audio_format_id),
920 w->frequency_width, afhi->frequency,
923 w->num_played_width, afsi->num_played,
929 if (opts->mode == LS_MODE_MBOX) {
930 const char *bn = para_basename(d->path);
932 "From foo@localhost %s\n"
933 "Received: from\nTo: bar\nFrom: a\n"
940 ret = write_filename_items(b, d->path, opts->flags);
943 ret = write_score(b, d, opts);
946 ret = write_attribute_items(b, att_buf, afsi);
949 ret = write_image_items(b, afsi);
952 ret = write_lyrics_items(b, afsi);
955 hash_to_asc(d->hash, asc_hash);
956 ret = WRITE_STATUS_ITEM(b, SI_HASH, "%s\n", asc_hash);
959 ret = WRITE_STATUS_ITEM(b, SI_BITRATE, "%dkbit/s\n", afhi->bitrate);
962 ret = WRITE_STATUS_ITEM(b, SI_FORMAT, "%s\n",
963 audio_format_name(afsi->audio_format_id));
966 ret = WRITE_STATUS_ITEM(b, SI_FREQUENCY, "%dHz\n", afhi->frequency);
969 ret = WRITE_STATUS_ITEM(b, SI_CHANNELS, "%d\n", afhi->channels);
972 ret = WRITE_STATUS_ITEM(b, SI_DURATION, "%s\n", duration_buf);
975 ret = WRITE_STATUS_ITEM(b, SI_SECONDS_TOTAL, "%lu\n",
976 afhi->seconds_total);
979 ret = WRITE_STATUS_ITEM(b, SI_LAST_PLAYED, "%s\n", last_played_time);
982 ret = WRITE_STATUS_ITEM(b, SI_NUM_PLAYED, "%d\n", afsi->num_played);
985 ret = WRITE_STATUS_ITEM(b, SI_AMPLIFICATION, "%u\n", afsi->amp);
988 ret = WRITE_STATUS_ITEM(b, SI_CHUNK_TIME, "%lu\n",
989 tv2ms(&afhi->chunk_tv));
992 ret = WRITE_STATUS_ITEM(b, SI_NUM_CHUNKS, "%lu\n",
996 ret = WRITE_STATUS_ITEM(b, SI_TECHINFO, "%s\n", afhi->techinfo);
999 ret = WRITE_STATUS_ITEM(b, SI_ARTIST, "%s\n", afhi->tags.artist);
1002 ret = WRITE_STATUS_ITEM(b, SI_TITLE, "%s\n", afhi->tags.title);
1005 ret = WRITE_STATUS_ITEM(b, SI_YEAR, "%s\n", afhi->tags.year);
1008 ret = WRITE_STATUS_ITEM(b, SI_ALBUM, "%s\n", afhi->tags.album);
1011 ret = WRITE_STATUS_ITEM(b, SI_COMMENT, "%s\n", afhi->tags.comment);
1014 if (opts->mode == LS_MODE_MBOX) {
1015 struct osl_object lyrics_def;
1016 lyr_get_def_by_id(afsi->lyrics_id, &lyrics_def);
1017 if (lyrics_def.data) {
1018 ret = para_printf(b, "Lyrics:\n~~~~~~~\n%s",
1019 (char *)lyrics_def.data);
1020 osl_close_disk_object(&lyrics_def);
1027 static int make_status_items(struct audio_file_data *afd,
1028 struct afs_info *afsi, char *path, long score,
1029 unsigned char *hash)
1031 struct ls_data d = {
1038 struct ls_options opts = {
1039 .flags = LS_FLAG_FULL_PATH | LS_FLAG_ADMISSIBLE_ONLY,
1040 .mode = LS_MODE_VERBOSE,
1042 struct para_buffer pb = {.max_size = SHMMAX - 1};
1043 time_t current_time;
1046 time(¤t_time);
1047 ret = print_list_item(&d, &opts, &pb, current_time);
1051 status_items = pb.buf;
1052 memset(&pb, 0, sizeof(pb));
1053 pb.max_size = SHMMAX - 1;
1054 pb.flags = PBF_SIZE_PREFIX;
1055 ret = print_list_item(&d, &opts, &pb, current_time);
1058 status_items = NULL;
1061 free(parser_friendly_status_items);
1062 parser_friendly_status_items = pb.buf;
1067 * Mmap the given audio file and update statistics.
1069 * \param aft_row Determines the audio file to be opened and updated.
1070 * \param score The score of the audio file.
1071 * \param afd Result pointer.
1073 * On success, the numplayed field of the audio file selector info is increased
1074 * and the lastplayed time is set to the current time. Finally, the score of
1075 * the audio file is updated.
1077 * \return Positive shmid on success, negative on errors.
1079 int open_and_update_audio_file(struct osl_row *aft_row, long score,
1080 struct audio_file_data *afd)
1082 unsigned char *aft_hash, file_hash[HASH_SIZE];
1083 struct osl_object afsi_obj;
1084 struct afs_info old_afsi, new_afsi;
1085 int ret = get_hash_of_row(aft_row, &aft_hash);
1086 struct afsi_change_event_data aced;
1087 struct osl_object map, chunk_table_obj;
1092 ret = get_audio_file_path_of_row(aft_row, &path);
1095 PARA_NOTICE_LOG("%s\n", path);
1096 ret = get_afsi_object_of_row(aft_row, &afsi_obj);
1099 ret = load_afsi(&old_afsi, &afsi_obj);
1102 ret = get_afhi_of_row(aft_row, &afd->afhi);
1105 afd->afhi.chunk_table = NULL;
1106 ret = osl_open_disk_object(audio_file_table, aft_row,
1107 AFTCOL_CHUNKS, &chunk_table_obj);
1110 ret = mmap_full_file(path, O_RDONLY, &map.data,
1111 &map.size, &afd->fd);
1114 hash_function(map.data, map.size, file_hash);
1115 ret = hash_compare(file_hash, aft_hash);
1116 para_munmap(map.data, map.size);
1118 ret = -E_HASH_MISMATCH;
1121 new_afsi = old_afsi;
1122 new_afsi.num_played++;
1123 new_afsi.last_played = time(NULL);
1124 save_afsi(&new_afsi, &afsi_obj); /* in-place update */
1126 afd->audio_format_id = old_afsi.audio_format_id;
1127 load_chunk_table(&afd->afhi, chunk_table_obj.data);
1128 ret = make_status_items(afd, &old_afsi, path, score, file_hash);
1131 aced.aft_row = aft_row;
1132 aced.old_afsi = &old_afsi;
1133 afs_event(AFSI_CHANGE, NULL, &aced);
1134 ret = save_afd(afd);
1136 free(afd->afhi.chunk_table);
1137 osl_close_disk_object(&chunk_table_obj);
1139 PARA_ERROR_LOG("%s: %s\n", path, para_strerror(-ret));
1143 static int ls_audio_format_compare(const void *a, const void *b)
1145 struct ls_data *d1 = *(struct ls_data **)a, *d2 = *(struct ls_data **)b;
1146 return NUM_COMPARE(d1->afsi.audio_format_id, d2->afsi.audio_format_id);
1149 static int ls_duration_compare(const void *a, const void *b)
1151 struct ls_data *d1 = *(struct ls_data **)a, *d2 = *(struct ls_data **)b;
1152 return NUM_COMPARE(d1->afhi.seconds_total, d2->afhi.seconds_total);
1155 static int ls_bitrate_compare(const void *a, const void *b)
1157 struct ls_data *d1 = *(struct ls_data **)a, *d2 = *(struct ls_data **)b;
1158 return NUM_COMPARE(d1->afhi.bitrate, d2->afhi.bitrate);
1161 static int ls_lyrics_id_compare(const void *a, const void *b)
1163 struct ls_data *d1 = *(struct ls_data **)a, *d2 = *(struct ls_data **)b;
1164 return NUM_COMPARE(d1->afsi.lyrics_id, d2->afsi.lyrics_id);
1167 static int ls_image_id_compare(const void *a, const void *b)
1169 struct ls_data *d1 = *(struct ls_data **)a, *d2 = *(struct ls_data **)b;
1170 return NUM_COMPARE(d1->afsi.image_id, d2->afsi.image_id);
1173 static int ls_channels_compare(const void *a, const void *b)
1175 struct ls_data *d1 = *(struct ls_data **)a, *d2 = *(struct ls_data **)b;
1176 return NUM_COMPARE(d1->afhi.channels, d2->afhi.channels);
1179 static int ls_frequency_compare(const void *a, const void *b)
1181 struct ls_data *d1 = *(struct ls_data **)a, *d2 = *(struct ls_data **)b;
1182 return NUM_COMPARE(d1->afhi.frequency, d2->afhi.frequency);
1185 static int ls_num_played_compare(const void *a, const void *b)
1187 struct ls_data *d1 = *(struct ls_data **)a, *d2 = *(struct ls_data **)b;
1188 return NUM_COMPARE(d1->afsi.num_played, d2->afsi.num_played);
1191 static int ls_last_played_compare(const void *a, const void *b)
1193 struct ls_data *d1 = *(struct ls_data **)a, *d2 = *(struct ls_data **)b;
1194 return NUM_COMPARE(d1->afsi.last_played, d2->afsi.last_played);
1197 static int ls_score_compare(const void *a, const void *b)
1199 struct ls_data *d1 = *(struct ls_data **)a, *d2 = *(struct ls_data **)b;
1200 return NUM_COMPARE(d1->score, d2->score);
1203 static int ls_path_compare(const void *a, const void *b)
1205 struct ls_data *d1 = *(struct ls_data **)a, *d2 = *(struct ls_data **)b;
1206 return strcmp(d1->path, d2->path);
1209 static int sort_matching_paths(struct ls_options *options)
1211 size_t nmemb = options->num_matching_paths;
1212 size_t size = sizeof(*options->data_ptr);
1213 int (*compar)(const void *, const void *);
1216 options->data_ptr = para_malloc(nmemb * sizeof(*options->data_ptr));
1217 for (i = 0; i < nmemb; i++)
1218 options->data_ptr[i] = options->data + i;
1220 /* In these cases the array is already sorted */
1221 if (options->sorting == LS_SORT_BY_PATH
1222 && !(options->flags & LS_FLAG_ADMISSIBLE_ONLY)
1223 && (options->flags & LS_FLAG_FULL_PATH))
1225 if (options->sorting == LS_SORT_BY_SCORE &&
1226 options->flags & LS_FLAG_ADMISSIBLE_ONLY)
1229 switch (options->sorting) {
1230 case LS_SORT_BY_PATH:
1231 compar = ls_path_compare; break;
1232 case LS_SORT_BY_SCORE:
1233 compar = ls_score_compare; break;
1234 case LS_SORT_BY_LAST_PLAYED:
1235 compar = ls_last_played_compare; break;
1236 case LS_SORT_BY_NUM_PLAYED:
1237 compar = ls_num_played_compare; break;
1238 case LS_SORT_BY_FREQUENCY:
1239 compar = ls_frequency_compare; break;
1240 case LS_SORT_BY_CHANNELS:
1241 compar = ls_channels_compare; break;
1242 case LS_SORT_BY_IMAGE_ID:
1243 compar = ls_image_id_compare; break;
1244 case LS_SORT_BY_LYRICS_ID:
1245 compar = ls_lyrics_id_compare; break;
1246 case LS_SORT_BY_BITRATE:
1247 compar = ls_bitrate_compare; break;
1248 case LS_SORT_BY_DURATION:
1249 compar = ls_duration_compare; break;
1250 case LS_SORT_BY_AUDIO_FORMAT:
1251 compar = ls_audio_format_compare; break;
1255 qsort(options->data_ptr, nmemb, size, compar);
1259 /* row is either an aft_row or a row of the score table */
1260 /* TODO: Only compute widths if we need them */
1261 static int prepare_ls_row(struct osl_row *row, void *ls_opts)
1264 struct ls_options *options = ls_opts;
1266 struct ls_widths *w;
1267 unsigned short num_digits;
1269 struct osl_row *aft_row;
1273 if (options->flags & LS_FLAG_ADMISSIBLE_ONLY) {
1274 ret = get_score_and_aft_row(row, &score, &aft_row);
1279 ret = get_audio_file_path_of_row(aft_row, &path);
1282 if (!(options->flags & LS_FLAG_FULL_PATH)) {
1283 char *p = strrchr(path, '/');
1287 if (options->num_patterns) {
1288 for (i = 0; i < options->num_patterns; i++) {
1289 ret = fnmatch(options->patterns[i], path, 0);
1292 if (ret == FNM_NOMATCH)
1296 if (i >= options->num_patterns) /* no match */
1299 tmp = options->num_matching_paths++;
1300 if (options->num_matching_paths > options->array_size) {
1301 options->array_size++;
1302 options->array_size *= 2;
1303 options->data = para_realloc(options->data, options->array_size
1304 * sizeof(*options->data));
1306 d = options->data + tmp;
1307 ret = get_afsi_of_row(aft_row, &d->afsi);
1310 ret = get_afhi_of_row(aft_row, &d->afhi);
1314 ret = get_hash_of_row(aft_row, &d->hash);
1317 w = &options->widths;
1318 GET_NUM_DIGITS(d->afsi.image_id, &num_digits);
1319 w->image_id_width = PARA_MAX(w->image_id_width, num_digits);
1320 GET_NUM_DIGITS(d->afsi.lyrics_id, &num_digits);
1321 w->lyrics_id_width = PARA_MAX(w->lyrics_id_width, num_digits);
1322 GET_NUM_DIGITS(d->afhi.bitrate, &num_digits);
1323 w->bitrate_width = PARA_MAX(w->bitrate_width, num_digits);
1324 GET_NUM_DIGITS(d->afhi.frequency, &num_digits);
1325 w->frequency_width = PARA_MAX(w->frequency_width, num_digits);
1326 GET_NUM_DIGITS(d->afsi.num_played, &num_digits);
1327 w->num_played_width = PARA_MAX(w->num_played_width, num_digits);
1328 /* get the number of chars to print this amount of time */
1329 num_digits = get_duration_width(d->afhi.seconds_total);
1330 w->duration_width = PARA_MAX(w->duration_width, num_digits);
1331 GET_NUM_DIGITS(d->afsi.amp, &num_digits);
1332 w->amp_width = PARA_MAX(w->amp_width, num_digits);
1333 if (options->flags & LS_FLAG_ADMISSIBLE_ONLY) {
1334 GET_NUM_DIGITS(score, &num_digits);
1335 num_digits++; /* add one for the sign (space or "-") */
1336 w->score_width = PARA_MAX(w->score_width, num_digits);
1344 static void com_ls_callback(int fd, const struct osl_object *query)
1346 struct ls_options *opts = query->data;
1347 char *p, *pattern_start = (char *)query->data + sizeof(*opts);
1348 struct para_buffer b = {.max_size = SHMMAX,
1349 .flags = (opts->mode == LS_MODE_PARSER)? PBF_SIZE_PREFIX : 0,
1350 .max_size_handler = pass_buffer_as_shm, .private_data = &fd};
1352 time_t current_time;
1354 if (opts->num_patterns) {
1355 opts->patterns = para_malloc(opts->num_patterns * sizeof(char *));
1356 for (i = 0, p = pattern_start; i < opts->num_patterns; i++) {
1357 opts->patterns[i] = p;
1361 opts->patterns = NULL;
1362 if (opts->flags & LS_FLAG_ADMISSIBLE_ONLY)
1363 ret = admissible_file_loop(opts, prepare_ls_row);
1365 ret = osl(osl_rbtree_loop(audio_file_table, AFTCOL_PATH, opts,
1369 if (!opts->num_matching_paths)
1371 ret = sort_matching_paths(opts);
1374 time(¤t_time);
1375 if (opts->flags & LS_FLAG_REVERSE)
1376 for (i = opts->num_matching_paths - 1; i >= 0; i--) {
1377 ret = print_list_item(opts->data_ptr[i], opts, &b, current_time);
1382 for (i = 0; i < opts->num_matching_paths; i++) {
1383 ret = print_list_item(opts->data_ptr[i], opts, &b, current_time);
1389 pass_buffer_as_shm(b.buf, b.offset, &fd);
1392 free(opts->data_ptr);
1393 free(opts->patterns);
1397 * TODO: flags -h (sort by hash)
1399 int com_ls(struct stream_cipher_context *scc, int argc, char * const * const argv)
1403 enum ls_sorting_method sort = LS_SORT_BY_PATH;
1404 enum ls_listing_mode mode = LS_MODE_SHORT;
1405 struct ls_options opts = {.patterns = NULL};
1406 struct osl_object query = {.data = &opts, .size = sizeof(opts)};
1408 for (i = 1; i < argc; i++) {
1409 const char *arg = argv[i];
1412 if (!strcmp(arg, "--")) {
1416 if (!strncmp(arg, "-l", 2)) {
1418 mode = LS_MODE_LONG;
1422 return -E_AFT_SYNTAX;
1423 switch(*(arg + 2)) {
1425 mode = LS_MODE_SHORT;
1428 mode = LS_MODE_LONG;
1431 mode = LS_MODE_VERBOSE;
1434 mode = LS_MODE_MBOX;
1437 mode = LS_MODE_CHUNKS;
1440 mode = LS_MODE_PARSER;
1443 return -E_AFT_SYNTAX;
1446 if (!strcmp(arg, "-p")) {
1447 flags |= LS_FLAG_FULL_PATH;
1450 if (!strcmp(arg, "-a")) {
1451 flags |= LS_FLAG_ADMISSIBLE_ONLY;
1454 if (!strcmp(arg, "-r")) {
1455 flags |= LS_FLAG_REVERSE;
1458 if (!strcmp(arg, "-d")) {
1459 flags |= LS_FLAG_UNIXDATE;
1462 if (!strncmp(arg, "-s", 2)) {
1463 if (!*(arg + 2) || *(arg + 3))
1464 return -E_AFT_SYNTAX;
1465 switch(*(arg + 2)) {
1467 sort = LS_SORT_BY_PATH;
1469 case 's': /* -ss implies -a */
1470 sort = LS_SORT_BY_SCORE;
1471 flags |= LS_FLAG_ADMISSIBLE_ONLY;
1474 sort = LS_SORT_BY_LAST_PLAYED;
1477 sort = LS_SORT_BY_NUM_PLAYED;
1480 sort = LS_SORT_BY_FREQUENCY;
1483 sort = LS_SORT_BY_CHANNELS;
1486 sort = LS_SORT_BY_IMAGE_ID;
1489 sort = LS_SORT_BY_LYRICS_ID;
1492 sort = LS_SORT_BY_BITRATE;
1495 sort = LS_SORT_BY_DURATION;
1498 sort = LS_SORT_BY_AUDIO_FORMAT;
1501 return -E_AFT_SYNTAX;
1504 return -E_AFT_SYNTAX;
1507 opts.sorting = sort;
1509 opts.num_patterns = argc - i;
1510 ret = send_option_arg_callback_request(&query, opts.num_patterns,
1511 argv + i, com_ls_callback, sc_send_result, scc);
1516 * Call the given function for each file in the audio file table.
1518 * \param private_data An arbitrary data pointer, passed to \a func.
1519 * \param func The custom function to be called.
1523 int audio_file_loop(void *private_data, osl_rbtree_loop_func *func)
1525 return osl(osl_rbtree_loop(audio_file_table, AFTCOL_HASH, private_data,
1529 static struct osl_row *find_hash_sister(unsigned char *hash)
1531 const struct osl_object obj = {.data = hash, .size = HASH_SIZE};
1532 struct osl_row *row;
1534 osl_get_row(audio_file_table, AFTCOL_HASH, &obj, &row);
1538 /** The format of the data stored by save_audio_file_data(). */
1539 enum com_add_buffer_offsets {
1540 /** afhi (if present) starts here. */
1541 CAB_AFHI_OFFSET_POS = 0,
1542 /** Start of the chunk table (if present). */
1543 CAB_CHUNKS_OFFSET_POS = 2,
1544 /** Audio format id. */
1545 CAB_AUDIO_FORMAT_OFFSET = 4,
1546 /** Flags given to the add command. */
1547 CAB_FLAGS_OFFSET = 5,
1548 /** The hash of the audio file being added. */
1549 CAB_HASH_OFFSET = 9,
1550 /** Start of the path of the audio file. */
1551 CAB_PATH_OFFSET = (CAB_HASH_OFFSET + HASH_SIZE),
1555 * Store the given data to a single buffer. Doesn't need the audio file selector
1556 * info struct as the server knows it as well.
1558 * It's OK to call this with afhi == NULL. In this case, the audio format
1559 * handler info won't be stored in the buffer.
1561 static void save_add_callback_buffer(unsigned char *hash, const char *path,
1562 struct afh_info *afhi, uint32_t flags,
1563 uint8_t audio_format_num, struct osl_object *obj)
1565 size_t path_len = strlen(path) + 1;
1566 size_t afhi_size = sizeof_afhi_buf(afhi);
1567 size_t size = CAB_PATH_OFFSET + path_len + afhi_size
1568 + sizeof_chunk_table(afhi);
1569 char *buf = para_malloc(size);
1572 write_u8(buf + CAB_AUDIO_FORMAT_OFFSET, audio_format_num);
1573 write_u32(buf + CAB_FLAGS_OFFSET, flags);
1575 memcpy(buf + CAB_HASH_OFFSET, hash, HASH_SIZE);
1576 strcpy(buf + CAB_PATH_OFFSET, path);
1578 pos = CAB_PATH_OFFSET + path_len;
1579 PARA_DEBUG_LOG("size: %zu, afhi starts at %d\n", size, pos);
1580 PARA_DEBUG_LOG("last afhi byte: %p, pos %zu\n", buf + pos + afhi_size - 1,
1581 pos + afhi_size - 1);
1582 write_u16(buf + CAB_AFHI_OFFSET_POS, pos);
1583 save_afhi(afhi, buf + pos);
1586 PARA_DEBUG_LOG("size: %zu, chunks start at %d\n", size, pos);
1587 write_u16(buf + CAB_CHUNKS_OFFSET_POS, pos);
1589 save_chunk_table(afhi, buf + pos);
1590 PARA_DEBUG_LOG("last byte in buf: %p\n", buf + size - 1);
1597 Overview of the add command.
1599 Input: What was passed to the callback by the command handler.
1601 HS: Hash sister. Whether an audio file with identical hash
1602 already exists in the osl database.
1604 PB: Path brother. Whether a file with the given path exists
1607 F: Force flag given. Whether add was called with -f.
1609 output: Action performed by the callback.
1611 AFHI: Whether afhi and chunk table are computed and sent.
1612 ACTION: Table modifications to be done by the callback.
1614 +----+----+---+------+---------------------------------------------------+
1615 | HS | PB | F | AFHI | ACTION
1616 +----+----+---+------+---------------------------------------------------+
1617 | Y | Y | Y | Y | if HS != PB: remove PB. HS: force afhi update,
1618 | | update path, keep afsi
1619 +----+----+---+------+---------------------------------------------------+
1620 | Y | Y | N | N | if HS == PB: do not send callback request at all.
1621 | | otherwise: remove PB, HS: update path, keep afhi,
1623 +----+----+---+------+---------------------------------------------------+
1624 | Y | N | Y | Y | (rename) force afhi update of HS, update path of
1626 +----+----+---+------+---------------------------------------------------+
1627 | Y | N | N | N | (file rename) update path of HS, keep afsi, afhi
1628 +----+----+---+------+---------------------------------------------------+
1629 | N | Y | Y | Y | (file change) update afhi, hash, of PB, keep afsi
1630 | | (force has no effect)
1631 +----+----+---+------+---------------------------------------------------+
1632 | N | Y | N | Y | (file change) update afhi, hash of PB, keep afsi
1633 +----+----+---+------+---------------------------------------------------+
1634 | N | N | Y | Y | (new file) create new entry (force has no effect)
1635 +----+----+---+------+---------------------------------------------------+
1636 | N | N | N | Y | (new file) create new entry
1637 +----+----+---+------+---------------------------------------------------+
1641 afhi <=> force or no HS
1646 /** Flags passed to the add command. */
1647 enum com_add_flags {
1648 /** Skip paths that exist already. */
1650 /** Force adding. */
1652 /** Print what is being done. */
1653 ADD_FLAG_VERBOSE = 4,
1654 /** Try to add files with unknown suffixes. */
1658 static void com_add_callback(int fd, const struct osl_object *query)
1660 char *buf = query->data, *path;
1661 struct osl_row *pb, *aft_row;
1663 struct osl_object objs[NUM_AFT_COLUMNS];
1664 unsigned char *hash;
1665 char asc[2 * HASH_SIZE + 1];
1667 char afsi_buf[AFSI_SIZE];
1668 uint32_t flags = read_u32(buf + CAB_FLAGS_OFFSET);
1669 struct afs_info default_afsi = {.last_played = 0};
1670 struct para_buffer msg = {.max_size = SHMMAX,
1671 .max_size_handler = pass_buffer_as_shm, .private_data = &fd};
1672 uint16_t afhi_offset, chunks_offset;
1674 hash = (unsigned char *)buf + CAB_HASH_OFFSET;
1675 hash_to_asc(hash, asc);;
1676 objs[AFTCOL_HASH].data = buf + CAB_HASH_OFFSET;
1677 objs[AFTCOL_HASH].size = HASH_SIZE;
1679 path = buf + CAB_PATH_OFFSET;
1680 objs[AFTCOL_PATH].data = path;
1681 objs[AFTCOL_PATH].size = strlen(path) + 1;
1683 PARA_INFO_LOG("request to add %s\n", path);
1684 hs = find_hash_sister(hash);
1685 ret = aft_get_row_of_path(path, &pb);
1686 if (ret < 0 && ret != -OSL_ERRNO_TO_PARA_ERROR(E_OSL_RB_KEY_NOT_FOUND))
1688 if (hs && pb && hs == pb && !(flags & ADD_FLAG_FORCE)) {
1689 if (flags & ADD_FLAG_VERBOSE)
1690 ret = para_printf(&msg, "ignoring duplicate\n");
1695 if (hs && hs != pb) {
1696 struct osl_object obj;
1697 if (pb) { /* hs trumps pb, remove pb */
1698 if (flags & ADD_FLAG_VERBOSE) {
1699 ret = para_printf(&msg, "removing path brother\n");
1703 ret = osl(osl_del_row(audio_file_table, pb));
1708 /* file rename, update hs' path */
1709 if (flags & ADD_FLAG_VERBOSE) {
1710 ret = osl(osl_get_object(audio_file_table, hs,
1711 AFTCOL_PATH, &obj));
1714 ret = para_printf(&msg, "renamed from %s\n", (char *)obj.data);
1718 ret = osl(osl_update_object(audio_file_table, hs, AFTCOL_PATH,
1719 &objs[AFTCOL_PATH]));
1722 afs_event(AUDIO_FILE_RENAME, &msg, hs);
1723 if (!(flags & ADD_FLAG_FORCE))
1726 /* no hs or force mode, child must have sent afhi */
1727 afhi_offset = read_u16(buf + CAB_AFHI_OFFSET_POS);
1728 chunks_offset = read_u16(buf + CAB_CHUNKS_OFFSET_POS);
1730 objs[AFTCOL_AFHI].data = buf + afhi_offset;
1731 objs[AFTCOL_AFHI].size = chunks_offset - afhi_offset;
1733 if (!objs[AFTCOL_AFHI].size) /* "impossible" */
1735 objs[AFTCOL_CHUNKS].data = buf + chunks_offset;
1736 objs[AFTCOL_CHUNKS].size = query->size - chunks_offset;
1737 if (pb && !hs) { /* update pb's hash */
1738 char old_asc[2 * HASH_SIZE + 1];
1739 unsigned char *old_hash;
1740 ret = get_hash_of_row(pb, &old_hash);
1743 hash_to_asc(old_hash, old_asc);
1744 if (flags & ADD_FLAG_VERBOSE) {
1745 ret = para_printf(&msg, "file change: %s -> %s\n",
1750 ret = osl_update_object(audio_file_table, pb, AFTCOL_HASH,
1751 &objs[AFTCOL_HASH]);
1755 if (hs || pb) { /* (hs != NULL and pb != NULL) implies hs == pb */
1756 struct osl_row *row = pb? pb : hs;
1757 /* update afhi and chunk_table */
1758 if (flags & ADD_FLAG_VERBOSE) {
1759 ret = para_printf(&msg, "updating afhi and chunk table\n");
1763 ret = osl(osl_update_object(audio_file_table, row, AFTCOL_AFHI,
1764 &objs[AFTCOL_AFHI]));
1767 ret = osl(osl_update_object(audio_file_table, row, AFTCOL_CHUNKS,
1768 &objs[AFTCOL_CHUNKS]));
1771 afs_event(AFHI_CHANGE, &msg, row);
1774 /* new entry, use default afsi */
1775 if (flags & ADD_FLAG_VERBOSE) {
1776 ret = para_printf(&msg, "new file\n");
1780 default_afsi.last_played = time(NULL) - 365 * 24 * 60 * 60;
1781 default_afsi.audio_format_id = read_u8(buf + CAB_AUDIO_FORMAT_OFFSET);
1783 objs[AFTCOL_AFSI].data = &afsi_buf;
1784 objs[AFTCOL_AFSI].size = AFSI_SIZE;
1785 save_afsi(&default_afsi, &objs[AFTCOL_AFSI]);
1786 ret = osl(osl_add_and_get_row(audio_file_table, objs, &aft_row));
1787 afs_event(AUDIO_FILE_ADD, &msg, aft_row);
1790 para_printf(&msg, "%s\n", para_strerror(-ret));
1792 pass_buffer_as_shm(msg.buf, msg.offset, &fd);
1796 /** Used by com_add(). */
1797 struct private_add_data {
1798 /** The socket file descriptor, including stream cipher keys. */
1799 struct stream_cipher_context *scc;
1800 /** The given add flags. */
1804 static void path_brother_callback(int fd, const struct osl_object *query)
1806 char *path = query->data;
1807 struct osl_row *path_brother;
1808 int ret = aft_get_row_of_path(path, &path_brother);
1811 pass_buffer_as_shm((char *)&path_brother, sizeof(path_brother), &fd);
1814 static void hash_sister_callback(int fd, const struct osl_object *query)
1816 unsigned char *hash = query->data;
1817 struct osl_row *hash_sister;
1819 hash_sister = find_hash_sister(hash);
1822 pass_buffer_as_shm((char *)&hash_sister, sizeof(hash_sister), &fd);
1825 static int get_row_pointer_from_result(struct osl_object *result, void *private)
1827 struct osl_row **row = private;
1828 *row = result->data;
1832 static int add_one_audio_file(const char *path, void *private_data)
1834 int ret, send_ret = 1, fd;
1835 uint8_t format_num = -1;
1836 struct private_add_data *pad = private_data;
1837 struct afh_info afhi, *afhi_ptr = NULL;
1838 struct osl_row *pb = NULL, *hs = NULL; /* path brother/hash sister */
1839 struct osl_object map, obj = {.data = NULL}, query;
1840 unsigned char hash[HASH_SIZE];
1842 ret = guess_audio_format(path);
1843 if (ret < 0 && !(pad->flags & ADD_FLAG_ALL))
1845 query.data = (char *)path;
1846 query.size = strlen(path) + 1;
1847 ret = send_callback_request(path_brother_callback, &query,
1848 get_row_pointer_from_result, &pb);
1849 if (ret < 0 && ret != -OSL_ERRNO_TO_PARA_ERROR(E_OSL_RB_KEY_NOT_FOUND))
1852 if (pb && (pad->flags & ADD_FLAG_LAZY)) { /* lazy is really cheap */
1853 if (pad->flags & ADD_FLAG_VERBOSE)
1854 send_ret = sc_send_va_buffer(pad->scc,
1855 "lazy-ignore: %s\n", path);
1858 /* We still want to add this file. Compute its hash. */
1859 ret = mmap_full_file(path, O_RDONLY, &map.data, &map.size, &fd);
1862 hash_function(map.data, map.size, hash);
1864 /* Check whether the database contains a file with the same hash. */
1866 query.size = HASH_SIZE;
1867 ret = send_callback_request(hash_sister_callback, &query,
1868 get_row_pointer_from_result, &hs);
1871 /* Return success if we already know this file. */
1873 if (pb && hs && hs == pb && !(pad->flags & ADD_FLAG_FORCE)) {
1874 if (pad->flags & ADD_FLAG_VERBOSE)
1875 send_ret = sc_send_va_buffer(pad->scc,
1876 "%s exists, not forcing update\n", path);
1880 * We won't recalculate the audio format info and the chunk table if
1881 * there is a hash sister and FORCE was not given.
1883 if (!hs || (pad->flags & ADD_FLAG_FORCE)) {
1884 ret = compute_afhi(path, map.data, map.size, fd, &afhi);
1890 munmap(map.data, map.size);
1892 if (pad->flags & ADD_FLAG_VERBOSE) {
1893 send_ret = sc_send_va_buffer(pad->scc, "adding %s\n", path);
1897 save_add_callback_buffer(hash, path, afhi_ptr, pad->flags, format_num, &obj);
1898 /* Ask afs to consider this entry for adding. */
1899 ret = send_callback_request(com_add_callback, &obj, sc_send_result, pad->scc);
1904 munmap(map.data, map.size);
1906 if (ret < 0 && send_ret >= 0)
1907 send_ret = sc_send_va_buffer(pad->scc,
1908 "failed to add %s (%s)\n", path, para_strerror(-ret));
1911 free(afhi_ptr->chunk_table);
1912 free(afhi_ptr->techinfo);
1913 free(afhi_ptr->tags.artist);
1914 free(afhi_ptr->tags.title);
1915 free(afhi_ptr->tags.year);
1916 free(afhi_ptr->tags.album);
1917 free(afhi_ptr->tags.comment);
1919 /* Stop adding files only on send errors. */
1923 int com_add(struct stream_cipher_context *scc, int argc, char * const * const argv)
1926 struct private_add_data pad = {.scc = scc, .flags = 0};
1927 struct stat statbuf;
1929 for (i = 1; i < argc; i++) {
1930 const char *arg = argv[i];
1933 if (!strcmp(arg, "--")) {
1937 if (!strcmp(arg, "-a")) {
1938 pad.flags |= ADD_FLAG_ALL;
1941 if (!strcmp(arg, "-l")) {
1942 pad.flags |= ADD_FLAG_LAZY;
1945 if (!strcmp(arg, "-f")) {
1946 pad.flags |= ADD_FLAG_FORCE;
1949 if (!strcmp(arg, "-v")) {
1950 pad.flags |= ADD_FLAG_VERBOSE;
1955 return -E_AFT_SYNTAX;
1956 for (; i < argc; i++) {
1958 ret = verify_path(argv[i], &path);
1960 ret = sc_send_va_buffer(scc, "%s: %s\n", argv[i],
1961 para_strerror(-ret));
1966 ret = stat(path, &statbuf);
1968 ret = sc_send_va_buffer(scc, "failed to stat %s (%s)\n", path,
1975 if (S_ISDIR(statbuf.st_mode))
1976 ret = for_each_file_in_dir(path, add_one_audio_file,
1979 ret = add_one_audio_file(path, &pad);
1981 sc_send_va_buffer(scc, "%s: %s\n", path, para_strerror(-ret));
1992 * Flags used by the touch command.
1997 /** Whether the \p FNM_PATHNAME flag should be passed to fnmatch(). */
1998 TOUCH_FLAG_FNM_PATHNAME = 1,
1999 /** Activates verbose mode. */
2000 TOUCH_FLAG_VERBOSE = 2
2003 /** Options used by com_touch(). */
2004 struct com_touch_options {
2005 /** New num_played value. */
2007 /** New last played count. */
2008 int64_t last_played;
2009 /** New lyrics id. */
2011 /** New image id. */
2013 /** New amplification value. */
2015 /** Command line flags (see \ref touch_flags). */
2019 /** Data passed to the action handler of com_touch(). */
2020 struct touch_action_data {
2021 /** Command line options (see \ref com_touch_options). */
2022 struct com_touch_options *cto;
2023 /** Message buffer. */
2024 struct para_buffer pb;
2025 /** How many audio files matched the given pattern. */
2026 unsigned num_matches;
2029 static int touch_audio_file(__a_unused struct osl_table *table,
2030 struct osl_row *row, const char *name, void *data)
2032 struct touch_action_data *tad = data;
2033 struct osl_object obj;
2034 struct afs_info old_afsi, new_afsi;
2035 int ret, no_options = tad->cto->num_played < 0 && tad->cto->last_played < 0 &&
2036 tad->cto->lyrics_id < 0 && tad->cto->image_id < 0 && tad->cto->amp < 0;
2037 struct afsi_change_event_data aced;
2039 ret = get_afsi_object_of_row(row, &obj);
2041 return para_printf(&tad->pb, "%s: %s\n", name, para_strerror(-ret));
2042 ret = load_afsi(&old_afsi, &obj);
2044 return para_printf(&tad->pb, "%s: %s\n", name, para_strerror(-ret));
2045 new_afsi = old_afsi;
2047 new_afsi.num_played++;
2048 new_afsi.last_played = time(NULL);
2049 if (tad->cto->flags & TOUCH_FLAG_VERBOSE) {
2050 ret = para_printf(&tad->pb, "%s: num_played = %u, "
2051 "last_played = now()\n", name,
2052 new_afsi.num_played);
2057 if (tad->cto->flags & TOUCH_FLAG_VERBOSE) {
2058 ret = para_printf(&tad->pb, "touching %s\n", name);
2062 if (tad->cto->lyrics_id >= 0)
2063 new_afsi.lyrics_id = tad->cto->lyrics_id;
2064 if (tad->cto->image_id >= 0)
2065 new_afsi.image_id = tad->cto->image_id;
2066 if (tad->cto->num_played >= 0)
2067 new_afsi.num_played = tad->cto->num_played;
2068 if (tad->cto->last_played >= 0)
2069 new_afsi.last_played = tad->cto->last_played;
2070 if (tad->cto->amp >= 0)
2071 new_afsi.amp = tad->cto->amp;
2074 save_afsi(&new_afsi, &obj); /* in-place update */
2076 aced.old_afsi = &old_afsi;
2077 afs_event(AFSI_CHANGE, &tad->pb, &aced);
2081 static void com_touch_callback(int fd, const struct osl_object *query)
2083 struct touch_action_data tad = {.cto = query->data,
2086 .private_data = &fd,
2087 .max_size_handler = pass_buffer_as_shm
2091 struct pattern_match_data pmd = {
2092 .table = audio_file_table,
2093 .loop_col_num = AFTCOL_HASH,
2094 .match_col_num = AFTCOL_PATH,
2095 .patterns = {.data = (char *)query->data + sizeof(*tad.cto),
2096 .size = query->size - sizeof(*tad.cto)},
2098 .action = touch_audio_file
2100 if (tad.cto->flags & TOUCH_FLAG_FNM_PATHNAME)
2101 pmd.fnmatch_flags |= FNM_PATHNAME;
2102 ret = for_each_matching_row(&pmd);
2104 ret2 = para_printf(&tad.pb, "%s\n", para_strerror(-ret));
2106 if (!tad.num_matches)
2107 ret2 = para_printf(&tad.pb, "no matches\n");
2108 if (ret2 >= 0 && tad.pb.offset)
2109 pass_buffer_as_shm(tad.pb.buf, tad.pb.offset, &fd);
2113 int com_touch(struct stream_cipher_context *scc, int argc, char * const * const argv)
2115 struct com_touch_options cto = {
2122 struct osl_object query = {.data = &cto, .size = sizeof(cto)};
2126 for (i = 1; i < argc; i++) {
2127 const char *arg = argv[i];
2130 if (!strcmp(arg, "--")) {
2134 if (!strncmp(arg, "-n=", 3)) {
2135 ret = para_atoi32(arg + 3, &cto.num_played);
2140 if (!strncmp(arg, "-l=", 3)) {
2141 ret = para_atoi64(arg + 3, &cto.last_played);
2146 if (!strncmp(arg, "-y=", 3)) {
2147 ret = para_atoi32(arg + 3, &cto.lyrics_id);
2152 if (!strncmp(arg, "-i=", 3)) {
2153 ret = para_atoi32(arg + 3, &cto.image_id);
2158 if (!strncmp(arg, "-a=", 3)) {
2160 ret = para_atoi32(arg + 3, &val);
2163 if (val < 0 || val > 255)
2164 return -ERRNO_TO_PARA_ERROR(EINVAL);
2168 if (!strcmp(arg, "-p")) {
2169 cto.flags |= TOUCH_FLAG_FNM_PATHNAME;
2172 if (!strcmp(arg, "-v")) {
2173 cto.flags |= TOUCH_FLAG_VERBOSE;
2176 break; /* non-option starting with dash */
2179 return -E_AFT_SYNTAX;
2180 ret = send_option_arg_callback_request(&query, argc - i,
2181 argv + i, com_touch_callback, sc_send_result, scc);
2183 sc_send_va_buffer(scc, "%s\n", para_strerror(-ret));
2187 /** Flags for com_rm(). */
2190 RM_FLAG_VERBOSE = 1,
2194 RM_FLAG_FNM_PATHNAME = 4
2197 /** Data passed to the action handler of com_rm(). */
2198 struct com_rm_action_data {
2199 /** Command line flags ((see \ref rm_flags). */
2201 /** Message buffer. */
2202 struct para_buffer pb;
2203 /** Number of audio files removed. */
2204 unsigned num_removed;
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));
2227 static void com_rm_callback(int fd, const struct osl_object *query)
2229 struct com_rm_action_data crd = {.flags = *(uint32_t *)query->data,
2232 .private_data = &fd,
2233 .max_size_handler = pass_buffer_as_shm
2237 struct pattern_match_data pmd = {
2238 .table = audio_file_table,
2239 .loop_col_num = AFTCOL_HASH,
2240 .match_col_num = AFTCOL_PATH,
2241 .patterns = {.data = (char *)query->data + sizeof(uint32_t),
2242 .size = query->size - sizeof(uint32_t)},
2244 .action = remove_audio_file
2246 if (crd.flags & RM_FLAG_FNM_PATHNAME)
2247 pmd.fnmatch_flags |= FNM_PATHNAME;
2248 ret = for_each_matching_row(&pmd);
2250 para_printf(&crd.pb, "%s\n", para_strerror(-ret));
2253 if (!crd.num_removed && !(crd.flags & RM_FLAG_FORCE))
2254 ret = para_printf(&crd.pb, "no matches -- nothing removed\n");
2256 if (crd.flags & RM_FLAG_VERBOSE)
2257 ret = para_printf(&crd.pb, "removed %u files\n", crd.num_removed);
2259 if (ret >= 0 && crd.pb.offset)
2260 pass_buffer_as_shm(crd.pb.buf, crd.pb.offset, &fd);
2264 /* TODO options: -r (recursive) */
2265 int com_rm(struct stream_cipher_context *scc, int argc, char * const * const argv)
2268 struct osl_object query = {.data = &flags, .size = sizeof(flags)};
2271 for (i = 1; i < argc; i++) {
2272 const char *arg = argv[i];
2275 if (!strcmp(arg, "--")) {
2279 if (!strcmp(arg, "-f")) {
2280 flags |= RM_FLAG_FORCE;
2283 if (!strcmp(arg, "-p")) {
2284 flags |= RM_FLAG_FNM_PATHNAME;
2287 if (!strcmp(arg, "-v")) {
2288 flags |= RM_FLAG_VERBOSE;
2294 return -E_AFT_SYNTAX;
2295 ret = send_option_arg_callback_request(&query, argc - i, argv + i,
2296 com_rm_callback, sc_send_result, scc);
2298 sc_send_va_buffer(scc, "%s\n", para_strerror(-ret));
2303 * Flags used by the cpsi command.
2308 /** Whether the lyrics id should be copied. */
2309 CPSI_FLAG_COPY_LYRICS_ID = 1,
2310 /** Whether the image id should be copied. */
2311 CPSI_FLAG_COPY_IMAGE_ID = 2,
2312 /** Whether the lastplayed time should be copied. */
2313 CPSI_FLAG_COPY_LASTPLAYED = 4,
2314 /** Whether the numplayed count should be copied. */
2315 CPSI_FLAG_COPY_NUMPLAYED = 8,
2316 /** Whether the attributes should be copied. */
2317 CPSI_FLAG_COPY_ATTRIBUTES = 16,
2318 /** Activates verbose mode. */
2319 CPSI_FLAG_VERBOSE = 32,
2322 /** Data passed to the action handler of com_cpsi(). */
2323 struct cpsi_action_data {
2324 /** command line flags (see \ref cpsi_flags). */
2326 /** Number of audio files changed. */
2327 unsigned num_copied;
2328 /** Message buffer. */
2329 struct para_buffer pb;
2330 /** Values are copied from here. */
2331 struct afs_info source_afsi;
2334 static int copy_selector_info(__a_unused struct osl_table *table,
2335 struct osl_row *row, const char *name, void *data)
2337 struct cpsi_action_data *cad = data;
2338 struct osl_object target_afsi_obj;
2340 struct afs_info old_afsi, target_afsi;
2341 struct afsi_change_event_data aced;
2343 ret = get_afsi_object_of_row(row, &target_afsi_obj);
2346 load_afsi(&target_afsi, &target_afsi_obj);
2347 old_afsi = target_afsi;
2348 if (cad->flags & CPSI_FLAG_COPY_LYRICS_ID)
2349 target_afsi.lyrics_id = cad->source_afsi.lyrics_id;
2350 if (cad->flags & CPSI_FLAG_COPY_IMAGE_ID)
2351 target_afsi.image_id = cad->source_afsi.image_id;
2352 if (cad->flags & CPSI_FLAG_COPY_LASTPLAYED)
2353 target_afsi.last_played = cad->source_afsi.last_played;
2354 if (cad->flags & CPSI_FLAG_COPY_NUMPLAYED)
2355 target_afsi.num_played = cad->source_afsi.num_played;
2356 if (cad->flags & CPSI_FLAG_COPY_ATTRIBUTES)
2357 target_afsi.attributes = cad->source_afsi.attributes;
2358 save_afsi(&target_afsi, &target_afsi_obj); /* in-place update */
2360 if (cad->flags & CPSI_FLAG_VERBOSE) {
2361 ret = para_printf(&cad->pb, "copied afsi to %s\n", name);
2366 aced.old_afsi = &old_afsi;
2367 afs_event(AFSI_CHANGE, &cad->pb, &aced);
2371 static void com_cpsi_callback(int fd, const struct osl_object *query)
2373 struct cpsi_action_data cad = {
2374 .flags = *(unsigned *)query->data,
2377 .private_data = &fd,
2378 .max_size_handler = pass_buffer_as_shm
2382 char *source_path = (char *)query->data + sizeof(cad.flags);
2383 struct pattern_match_data pmd = {
2384 .table = audio_file_table,
2385 .loop_col_num = AFTCOL_HASH,
2386 .match_col_num = AFTCOL_PATH,
2387 .patterns = {.data = source_path + strlen(source_path) + 1,
2388 .size = query->size - sizeof(cad.flags)
2389 - strlen(source_path) - 1},
2391 .action = copy_selector_info
2394 ret = get_afsi_of_path(source_path, &cad.source_afsi);
2397 ret = for_each_matching_row(&pmd);
2400 para_printf(&cad.pb, "%s\n", para_strerror(-ret));
2401 else if (cad.flags & CPSI_FLAG_VERBOSE) {
2403 para_printf(&cad.pb, "copied requested afsi from %s "
2404 "to %u files\n", source_path, cad.num_copied);
2406 para_printf(&cad.pb, "nothing copied\n");
2409 pass_buffer_as_shm(cad.pb.buf, cad.pb.offset, &fd);
2413 int com_cpsi(struct stream_cipher_context *scc, int argc, char * const * const argv)
2417 struct osl_object options = {.data = &flags, .size = sizeof(flags)};
2419 for (i = 1; i < argc; i++) {
2420 const char *arg = argv[i];
2423 if (!strcmp(arg, "--")) {
2427 if (!strcmp(arg, "-y")) {
2428 flags |= CPSI_FLAG_COPY_LYRICS_ID;
2431 if (!strcmp(arg, "-i")) {
2432 flags |= CPSI_FLAG_COPY_IMAGE_ID;
2435 if (!strcmp(arg, "-l")) {
2436 flags |= CPSI_FLAG_COPY_LASTPLAYED;
2439 if (!strcmp(arg, "-n")) {
2440 flags |= CPSI_FLAG_COPY_NUMPLAYED;
2443 if (!strcmp(arg, "-a")) {
2444 flags |= CPSI_FLAG_COPY_ATTRIBUTES;
2447 if (!strcmp(arg, "-v")) {
2448 flags |= CPSI_FLAG_VERBOSE;
2453 if (i + 1 >= argc) /* need at least source file and pattern */
2454 return -E_AFT_SYNTAX;
2455 if (!(flags & ~CPSI_FLAG_VERBOSE)) /* no copy flags given */
2456 flags = ~(unsigned)CPSI_FLAG_VERBOSE | flags;
2457 ret = send_option_arg_callback_request(&options, argc - i, argv + i,
2458 com_cpsi_callback, sc_send_result, scc);
2460 sc_send_va_buffer(scc, "%s\n", para_strerror(-ret));
2464 static void afs_stat_callback(int fd, const struct osl_object *query)
2466 int *parser_friendly = query->data;
2467 char *buf = *parser_friendly?
2468 parser_friendly_status_items : status_items;
2472 pass_buffer_as_shm(buf, strlen(buf), &fd);
2476 * Get the current afs status items from the afs process and send it.
2478 * \param scc The stream cipher context for data encryption.
2479 * \param parser_friendly Whether parser-friendly output format should be used.
2481 * As the contents of the afs status items change in time and the command
2482 * handler only has a COW version created at fork time, it can not send
2483 * up-to-date afs status items directly. Therefore the usual callback mechanism
2484 * is used to pass the status items from the afs process to the command handler
2485 * via a shared memory area and a pipe.
2487 int send_afs_status(struct stream_cipher_context *scc, int parser_friendly)
2489 struct osl_object query = {.data = &parser_friendly,
2490 .size = sizeof(parser_friendly)};
2492 return send_callback_request(afs_stat_callback, &query, sc_send_result, scc);
2495 /* TODO: optionally fix problems by removing offending rows */
2496 static int check_audio_file(struct osl_row *row, void *data)
2499 struct para_buffer *pb = data;
2500 struct stat statbuf;
2501 int ret = get_audio_file_path_of_row(row, &path);
2502 struct afs_info afsi;
2506 return para_printf(pb, "%s\n", para_strerror(-ret));
2507 if (stat(path, &statbuf) < 0) {
2508 ret = para_printf(pb, "%s: stat error (%s)\n", path, strerror(errno));
2512 if (!S_ISREG(statbuf.st_mode)) {
2513 ret = para_printf(pb, "%s: not a regular file\n", path);
2518 ret = get_afsi_of_row(row, &afsi);
2520 return para_printf(pb, "%s: %s\n", path, para_strerror(-ret));
2521 ret = lyr_get_name_by_id(afsi.lyrics_id, &blob_name);
2523 ret = para_printf(pb, "%s lyrics id %u: %s\n", path, afsi.lyrics_id,
2524 para_strerror(-ret));
2528 ret = img_get_name_by_id(afsi.image_id, &blob_name);
2530 ret = para_printf(pb, "%s image id %u: %s\n", path, afsi.image_id,
2531 para_strerror(-ret));
2536 * Check the audio file table for inconsistencies.
2538 * \param fd The afs socket.
2539 * \param query Unused.
2541 * This function always succeeds.
2545 void aft_check_callback(int fd, __a_unused const struct osl_object *query)
2547 struct para_buffer pb = {
2549 .private_data = &fd,
2550 .max_size_handler = pass_buffer_as_shm
2552 int ret = para_printf(&pb, "checking audio file table...\n");
2556 audio_file_loop(&pb, check_audio_file);
2558 pass_buffer_as_shm(pb.buf, pb.offset, &fd);
2563 * Close the audio file table.
2565 * \param flags Usual flags that are passed to osl_close_table().
2567 * \sa osl_close_table().
2569 static void aft_close(void)
2571 osl_close_table(audio_file_table, OSL_MARK_CLEAN);
2572 audio_file_table = NULL;
2574 status_items = NULL;
2575 free(parser_friendly_status_items);
2576 parser_friendly_status_items = NULL;
2580 * Open the audio file table.
2582 * \param dir The database directory.
2586 * \sa osl_open_table().
2588 static int aft_open(const char *dir)
2592 audio_file_table_desc.dir = dir;
2593 ret = osl(osl_open_table(&audio_file_table_desc, &audio_file_table));
2596 osl_get_num_rows(audio_file_table, &num);
2597 PARA_INFO_LOG("audio file table contains %d files\n", num);
2600 PARA_INFO_LOG("failed to open audio file table\n");
2601 audio_file_table = NULL;
2602 if (ret >= 0 || ret == -OSL_ERRNO_TO_PARA_ERROR(E_OSL_NOENT))
2607 static int aft_create(const char *dir)
2609 audio_file_table_desc.dir = dir;
2610 return osl(osl_create_table(&audio_file_table_desc));
2613 static int clear_attribute(struct osl_row *row, void *data)
2615 struct rmatt_event_data *red = data;
2616 struct afs_info afsi;
2617 struct osl_object obj;
2618 int ret = get_afsi_object_of_row(row, &obj);
2619 uint64_t mask = ~(1ULL << red->bitnum);
2623 ret = load_afsi(&afsi, &obj);
2626 afsi.attributes &= mask;
2627 save_afsi(&afsi, &obj);
2631 static int aft_event_handler(enum afs_events event, struct para_buffer *pb,
2637 case ATTRIBUTE_REMOVE: {
2638 const struct rmatt_event_data *red = data;
2639 ret = para_printf(pb, "clearing attribute %s (bit %u) from all "
2640 "entries in the audio file table\n", red->name,
2644 return audio_file_loop(data, clear_attribute);
2652 * Initialize the audio file table.
2654 * \param t Pointer to the structure to be initialized.
2656 void aft_init(struct afs_table *t)
2659 t->close = aft_close;
2660 t->create = aft_create;
2661 t->event_handler = aft_event_handler;