2 * Copyright (C) 2007-2010 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() */
11 #include <openssl/rc4.h>
27 #include "portable_io.h"
29 static struct osl_table *audio_file_table;
30 static char *status_items;
31 static char *parser_friendly_status_items;
33 /** The different sorting methods of the ls command. */
34 enum ls_sorting_method {
40 LS_SORT_BY_LAST_PLAYED,
42 LS_SORT_BY_NUM_PLAYED,
56 LS_SORT_BY_AUDIO_FORMAT,
61 /** The different listing modes of the ls command. */
62 enum ls_listing_mode {
63 /** Default listing mode. */
77 /** The flags accepted by the ls command. */
80 LS_FLAG_FULL_PATH = 1,
82 LS_FLAG_ADMISSIBLE_ONLY = 2,
90 * The size of the individual output fields of the ls command.
92 * These depend on the actual content being listed. If, for instance only files
93 * with duration less than an hour are being listed, then the duration with is
94 * made smaller because then the duration is listed as mm:ss rather than
98 /** size of the score field. */
99 unsigned short score_width;
100 /** size of the image id field. */
101 unsigned short image_id_width;
102 /** size of the lyrics id field. */
103 unsigned short lyrics_id_width;
104 /** size of the bitrate field. */
105 unsigned short bitrate_width;
106 /** size of the frequency field. */
107 unsigned short frequency_width;
108 /** size of the duration field. */
109 unsigned short duration_width;
110 /** size of the num played field. */
111 unsigned short num_played_width;
112 /** size of the amp field. */
113 unsigned short amp_width;
116 /** Data passed from the ls command handler to its callback function. */
118 /** The given command line flags. */
120 /** The sorting method given at the command line. */
121 enum ls_sorting_method sorting;
122 /** The given listing mode (short, long, verbose, mbox). */
123 enum ls_listing_mode mode;
124 /** The arguments passed to the ls command. */
126 /** Number of non-option arguments. */
128 /** Used for long listing mode to align the output fields. */
129 struct ls_widths widths;
130 /** Size of the \a data array. */
132 /** Number of used entries in the data array. */
133 uint32_t num_matching_paths;
134 /** Array of matching entries. */
135 struct ls_data *data;
136 /** Used to sort the array. */
137 struct ls_data **data_ptr;
141 * Describes the layout of the mmapped-afs info struct.
143 * \sa struct afs_info.
146 /** Where .last_played is stored. */
147 AFSI_LAST_PLAYED_OFFSET = 0,
148 /** Storage position of the attributes bitmap. */
149 AFSI_ATTRIBUTES_OFFSET = 8,
150 /** Storage position of the .num_played field. */
151 AFSI_NUM_PLAYED_OFFSET = 16,
152 /** Storage position of the .image_id field. */
153 AFSI_IMAGE_ID_OFFSET = 20,
154 /** Storage position of the .lyrics_id field. */
155 AFSI_LYRICS_ID_OFFSET = 24,
156 /** Storage position of the .audio_format_id field. */
157 AFSI_AUDIO_FORMAT_ID_OFFSET = 28,
158 /** Storage position of the amplification field. */
159 AFSI_AMP_OFFSET = 29,
160 /** 2 bytes reserved space for future usage. */
161 AFSI_AUDIO_FORMAT_UNUSED_OFFSET = 30,
162 /** On-disk storage space needed. */
167 * Convert a struct afs_info to an osl object.
169 * \param afsi Pointer to the audio file info to be converted.
170 * \param obj Result pointer.
174 void save_afsi(struct afs_info *afsi, struct osl_object *obj)
176 char *buf = obj->data;
178 write_u64(buf + AFSI_LAST_PLAYED_OFFSET, afsi->last_played);
179 write_u64(buf + AFSI_ATTRIBUTES_OFFSET, afsi->attributes);
180 write_u32(buf + AFSI_NUM_PLAYED_OFFSET, afsi->num_played);
181 write_u32(buf + AFSI_IMAGE_ID_OFFSET, afsi->image_id);
182 write_u32(buf + AFSI_LYRICS_ID_OFFSET, afsi->lyrics_id);
183 write_u8(buf + AFSI_AUDIO_FORMAT_ID_OFFSET,
184 afsi->audio_format_id);
185 write_u8(buf + AFSI_AMP_OFFSET, afsi->amp);
186 memset(buf + AFSI_AUDIO_FORMAT_UNUSED_OFFSET, 0, 2);
190 * Get the audio file selector info struct stored in an osl object.
192 * \param afsi Points to the audio_file info structure to be filled in.
193 * \param obj The osl object holding the data.
195 * \return Positive on success, negative on errors. Possible errors: \p E_BAD_AFS.
199 int load_afsi(struct afs_info *afsi, struct osl_object *obj)
201 char *buf = obj->data;
202 if (obj->size < AFSI_SIZE)
204 afsi->last_played = read_u64(buf + AFSI_LAST_PLAYED_OFFSET);
205 afsi->attributes = read_u64(buf + AFSI_ATTRIBUTES_OFFSET);
206 afsi->num_played = read_u32(buf + AFSI_NUM_PLAYED_OFFSET);
207 afsi->image_id = read_u32(buf + AFSI_IMAGE_ID_OFFSET);
208 afsi->lyrics_id = read_u32(buf + AFSI_LYRICS_ID_OFFSET);
209 afsi->audio_format_id = read_u8(buf +
210 AFSI_AUDIO_FORMAT_ID_OFFSET);
211 afsi->amp = read_u8(buf + AFSI_AMP_OFFSET);
215 /** The columns of the audio file table. */
216 enum audio_file_table_columns {
217 /** The hash on the content of the audio file. */
219 /** The full path in the filesystem. */
221 /** The audio file selector info. */
223 /** The audio format handler info. */
225 /** The chunk table info and the chunk table of the audio file. */
227 /** The number of columns of this table. */
232 * Compare two osl objects pointing to hash values.
234 * \param obj1 Pointer to the first hash object.
235 * \param obj2 Pointer to the second hash object.
237 * \return The values required for an osl compare function.
239 * \sa osl_compare_func, uint32_compare().
241 static int aft_hash_compare(const struct osl_object *obj1, const struct osl_object *obj2)
243 return hash_compare((HASH_TYPE *)obj1->data, (HASH_TYPE *)obj2->data);
246 static struct osl_column_description aft_cols[] = {
248 .storage_type = OSL_MAPPED_STORAGE,
249 .storage_flags = OSL_RBTREE | OSL_FIXED_SIZE | OSL_UNIQUE,
251 .compare_function = aft_hash_compare,
252 .data_size = HASH_SIZE
255 .storage_type = OSL_MAPPED_STORAGE,
256 .storage_flags = OSL_RBTREE | OSL_UNIQUE,
258 .compare_function = string_compare,
261 .storage_type = OSL_MAPPED_STORAGE,
262 .storage_flags = OSL_FIXED_SIZE,
264 .data_size = AFSI_SIZE
267 .storage_type = OSL_MAPPED_STORAGE,
271 .storage_type = OSL_DISK_STORAGE,
276 static struct osl_table_description audio_file_table_desc = {
277 .name = "audio_files",
278 .num_columns = NUM_AFT_COLUMNS,
279 .flags = OSL_LARGE_TABLE,
280 .column_descriptions = aft_cols
283 /* We don't want * dot or dot-dot anywhere. */
284 static int verify_dotfile(const char *rest)
287 * The first character was '.', but that has already been discarded, we
291 case '\0': case '/': /* /foo/. and /foo/./bar are not ok */
293 case '.': /* path start with /foo/.. */
294 if (rest[1] == '\0' || rest[1] == '/')
295 return -1; /* /foo/.. or /foo/../bar are not ok */
296 /* /foo/..bar is ok */
302 * We fundamentally don't like some paths: We don't want double slashes or
303 * slashes at the end that can make pathnames ambiguous.
305 static int verify_path(const char *orig_path, char **resolved_path)
311 if (*orig_path != '/') /* we only accept absolute paths */
313 len = strlen(orig_path);
314 *resolved_path = para_strdup(orig_path);
315 path = *resolved_path;
316 while (len > 1 && path[--len] == '/')
317 path[len] = '\0'; /* remove slash at the end */
323 case '/': /* double slash */
326 if (verify_dotfile(path) < 0)
336 free(*resolved_path);
340 /** The on-disk layout of a afhi struct. */
342 /** Where the number of seconds is stored. */
343 AFHI_SECONDS_TOTAL_OFFSET = 0,
344 /** Position of the bitrate. */
345 AFHI_BITRATE_OFFSET = 4,
346 /** Position of the frequency. */
347 AFHI_FREQUENCY_OFFSET = 8,
348 /** Location of the audio file header. */
349 AFHI_HEADER_OFFSET_OFFSET = 12,
350 /* Length of the audio file header. Zero means: No header. */
351 AFHI_HEADER_LEN_OFFSET = 16,
352 /** The total number of chunks (4 bytes). */
353 CHUNKS_TOTAL_OFFSET = 20,
354 /** The length of the audio file header (4 bytes). */
355 HEADER_LEN_OFFSET = 24,
356 /** The start of the audio file header (4 bytes). */
357 HEADER_OFFSET_OFFSET = 28,
358 /** The seconds part of the chunk time (4 bytes). */
359 CHUNK_TV_TV_SEC_OFFSET = 32,
360 /** The microseconds part of the chunk time (4 bytes). */
361 CHUNK_TV_TV_USEC_OFFSET = 36,
362 /** Number of channels is stored here. (1 byte) */
363 AFHI_CHANNELS_OFFSET = 40,
364 /** The tag info position. */
365 AFHI_INFO_STRING_OFFSET = 41,
366 /** Minimal on-disk size of a valid afhi struct. */
367 MIN_AFHI_SIZE = 47, /* at least 6 null bytes for techinfo/tags */
370 static unsigned sizeof_afhi_buf(const struct afh_info *afhi)
375 + strlen(afhi->techinfo)
376 + strlen(afhi->tags.artist)
377 + strlen(afhi->tags.title)
378 + strlen(afhi->tags.year)
379 + strlen(afhi->tags.album)
380 + strlen(afhi->tags.comment);
383 static void save_afhi(struct afh_info *afhi, char *buf)
389 write_u32(buf + AFHI_SECONDS_TOTAL_OFFSET, afhi->seconds_total);
390 write_u32(buf + AFHI_BITRATE_OFFSET, afhi->bitrate);
391 write_u32(buf + AFHI_FREQUENCY_OFFSET, afhi->frequency);
392 write_u32(buf + AFHI_HEADER_OFFSET_OFFSET, afhi->header_offset);
393 write_u32(buf + AFHI_HEADER_LEN_OFFSET, afhi->header_len);
394 write_u8(buf + AFHI_CHANNELS_OFFSET, afhi->channels);
395 write_u32(buf + CHUNKS_TOTAL_OFFSET, afhi->chunks_total);
396 write_u32(buf + HEADER_LEN_OFFSET, afhi->header_len);
397 write_u32(buf + HEADER_OFFSET_OFFSET, afhi->header_offset);
398 write_u32(buf + CHUNK_TV_TV_SEC_OFFSET, afhi->chunk_tv.tv_sec);
399 write_u32(buf + CHUNK_TV_TV_USEC_OFFSET, afhi->chunk_tv.tv_usec);
400 p = buf + AFHI_INFO_STRING_OFFSET;
401 /* The sprintf's below are OK as our caller made sure that buf is large enough */
402 p += sprintf(p, "%s", afhi->techinfo) + 1;
403 p += sprintf(p, "%s", afhi->tags.artist) + 1;
404 p += sprintf(p, "%s", afhi->tags.title) + 1;
405 p += sprintf(p, "%s", afhi->tags.year) + 1;
406 p += sprintf(p, "%s", afhi->tags.album) + 1;
407 sprintf(p, "%s", afhi->tags.comment);
410 static void load_afhi(const char *buf, struct afh_info *afhi)
412 afhi->seconds_total = read_u32(buf + AFHI_SECONDS_TOTAL_OFFSET);
413 afhi->bitrate = read_u32(buf + AFHI_BITRATE_OFFSET);
414 afhi->frequency = read_u32(buf + AFHI_FREQUENCY_OFFSET);
415 afhi->header_offset = read_u32(buf + AFHI_HEADER_OFFSET_OFFSET);
416 afhi->header_len = read_u32(buf + AFHI_HEADER_LEN_OFFSET);
417 afhi->channels = read_u8(buf + AFHI_CHANNELS_OFFSET);
418 afhi->chunks_total = read_u32(buf + CHUNKS_TOTAL_OFFSET);
419 afhi->header_len = read_u32(buf + HEADER_LEN_OFFSET);
420 afhi->header_offset = read_u32(buf + HEADER_OFFSET_OFFSET);
421 afhi->chunk_tv.tv_sec = read_u32(buf + CHUNK_TV_TV_SEC_OFFSET);
422 afhi->chunk_tv.tv_usec = read_u32(buf + CHUNK_TV_TV_USEC_OFFSET);
423 afhi->techinfo = (char *)buf + AFHI_INFO_STRING_OFFSET;
424 afhi->tags.artist = afhi->techinfo + strlen(afhi->techinfo) + 1;
425 afhi->tags.title = afhi->tags.artist + strlen(afhi->tags.artist) + 1;
426 afhi->tags.year = afhi->tags.title + strlen(afhi->tags.title) + 1;
427 afhi->tags.album = afhi->tags.year + strlen(afhi->tags.year) + 1;
428 afhi->tags.comment = afhi->tags.album + strlen(afhi->tags.album) + 1;
431 static unsigned sizeof_chunk_table(struct afh_info *afhi)
435 return 4 * (afhi->chunks_total + 1);
438 static void save_chunk_table(struct afh_info *afhi, char *buf)
442 for (i = 0; i <= afhi->chunks_total; i++)
443 write_u32(buf + 4 * i, afhi->chunk_table[i]);
446 static void load_chunk_table(struct afh_info *afhi, char *buf)
450 afhi->chunk_table = para_malloc(sizeof_chunk_table(afhi));
451 for (i = 0; i <= afhi->chunks_total; i++)
452 afhi->chunk_table[i] = read_u32(buf + 4 * i);
456 * Get the row of the audio file table corresponding to the given path.
458 * \param path The full path of the audio file.
459 * \param row Result pointer.
463 int aft_get_row_of_path(const char *path, struct osl_row **row)
465 struct osl_object obj = {.data = (char *)path, .size = strlen(path) + 1};
467 return osl(osl_get_row(audio_file_table, AFTCOL_PATH, &obj, row));
471 * Get the row of the audio file table corresponding to the given hash value.
473 * \param hash The hash value of the desired audio file.
474 * \param row Result pointer.
478 static int aft_get_row_of_hash(HASH_TYPE *hash, struct osl_row **row)
480 const struct osl_object obj = {.data = hash, .size = HASH_SIZE};
481 return osl(osl_get_row(audio_file_table, AFTCOL_HASH, &obj, row));
485 * Get the osl object holding the audio file selector info of a row.
487 * \param row Pointer to a row in the audio file table.
488 * \param obj Result pointer.
492 int get_afsi_object_of_row(const struct osl_row *row, struct osl_object *obj)
494 return osl(osl_get_object(audio_file_table, row, AFTCOL_AFSI, obj));
498 * Get the osl object holding the audio file selector info, given a path.
501 * \param path The full path of the audio file.
502 * \param obj Result pointer.
504 * \return Positive on success, negative on errors.
506 static int get_afsi_object_of_path(const char *path, struct osl_object *obj)
509 int ret = aft_get_row_of_path(path, &row);
512 return get_afsi_object_of_row(row, obj);
516 * Get the audio file selector info, given a row of the audio file table.
518 * \param row Pointer to a row in the audio file table.
519 * \param afsi Result pointer.
521 * \return Positive on success, negative on errors.
523 int get_afsi_of_row(const struct osl_row *row, struct afs_info *afsi)
525 struct osl_object obj;
526 int ret = get_afsi_object_of_row(row, &obj);
529 return load_afsi(afsi, &obj);
533 * Get the audio file selector info, given the path of an audio table.
535 * \param path The full path of the audio file.
536 * \param afsi Result pointer.
538 * \return Positive on success, negative on errors.
540 int get_afsi_of_path(const char *path, struct afs_info *afsi)
542 struct osl_object obj;
543 int ret = get_afsi_object_of_path(path, &obj);
546 return load_afsi(afsi, &obj);
550 * Get the path of an audio file, given a row of the audio file table.
552 * \param row Pointer to a row in the audio file table.
553 * \param path Result pointer.
555 * The result is a pointer to mmapped data. The caller must not attempt
560 int get_audio_file_path_of_row(const struct osl_row *row, char **path)
562 struct osl_object path_obj;
563 int ret = osl(osl_get_object(audio_file_table, row, AFTCOL_PATH,
567 *path = path_obj.data;
572 * Get the object containing the hash value of an audio file, given a row.
574 * \param row Pointer to a row of the audio file table.
575 * \param obj Result pointer.
577 * \return The return value of the underlying call to osl_get_object().
579 * \sa get_hash_of_row().
581 static int get_hash_object_of_aft_row(const struct osl_row *row,
582 struct osl_object *obj)
584 return osl(osl_get_object(audio_file_table, row, AFTCOL_HASH, obj));
588 * Get the hash value of an audio file, given a row of the audio file table.
590 * \param row Pointer to a row of the audio file table.
591 * \param hash Result pointer.
593 * \a hash points to mapped data and must not be freed by the caller.
595 * \return The return value of the underlying call to
596 * get_hash_object_of_aft_row().
598 static int get_hash_of_row(const struct osl_row *row, HASH_TYPE **hash)
600 struct osl_object obj;
601 int ret = get_hash_object_of_aft_row(row, &obj);
610 * Get the audio format handler info, given a row of the audio file table.
612 * \param row Pointer to a row of the audio file table.
613 * \param afhi Result pointer.
615 * \return The return value of the underlying call to osl_get_object().
617 * \sa get_chunk_table_of_row().
619 int get_afhi_of_row(const struct osl_row *row, struct afh_info *afhi)
621 struct osl_object obj;
622 int ret = osl(osl_get_object(audio_file_table, row, AFTCOL_AFHI,
626 load_afhi(obj.data, afhi);
630 /* returns shmid on success */
631 static int save_afd(struct audio_file_data *afd)
633 size_t size = sizeof(*afd) + sizeof_chunk_table(&afd->afhi);
634 int shmid, ret = shm_new(size);
641 ret = shm_attach(shmid, ATTACH_RW, &shm_afd);
644 *(struct audio_file_data *)shm_afd = *afd;
647 save_chunk_table(&afd->afhi, buf);
656 * Extract a afd stored in a shared memory area.
658 * Attach the shared memory area given by \a shmid, load the audio file data
659 * stored therein and detach the area afterwards. Called by vss, after
660 * receiving a positive response to the request for the next audio file.
662 * \param shmid The identifier of the shared memory area containing the afd.
663 * \param afd Result pointer.
667 int load_afd(int shmid, struct audio_file_data *afd)
673 ret = shm_attach(shmid, ATTACH_RO, &shm_afd);
676 *afd = *(struct audio_file_data *)shm_afd;
679 load_chunk_table(&afd->afhi, buf);
684 static int get_local_time(uint64_t *seconds, char *buf, size_t size,
685 time_t current_time, enum ls_listing_mode lm)
689 if (!localtime_r((time_t *)seconds, &t))
691 if (lm == LS_MODE_MBOX) {
692 if (!strftime(buf, size, "%c", &t))
696 if (*seconds + 6 * 30 * 24 * 3600 > current_time) {
697 if (!strftime(buf, size, "%b %e %k:%M", &t))
701 if (!strftime(buf, size, "%b %e %Y", &t))
706 /** Compute the number of (decimal) digits of a number. */
707 #define GET_NUM_DIGITS(x, num) { \
708 typeof((x)) _tmp = PARA_ABS(x); \
711 while ((_tmp) > 9) { \
717 static short unsigned get_duration_width(int seconds)
719 short unsigned width;
720 unsigned hours = seconds / 3600, mins = (seconds % 3600) / 60;
722 if (!hours) /* less than one hour => m:ss or mm:ss => 4 or 5 digits */
723 return 4 + (mins > 9);
724 /* more than one hour => h:mm:ss, hh:mm:ss, hhh:mm:ss, ... */
725 GET_NUM_DIGITS(hours, &width);
729 static void get_duration_buf(int seconds, char *buf, struct ls_options *opts)
731 unsigned hours = seconds / 3600, mins = (seconds % 3600) / 60;
732 short unsigned max_width;
734 if (!hours) { /* m:ss or mm:ss */
735 max_width = opts->mode == LS_MODE_LONG?
736 opts->widths.duration_width : 4;
737 sprintf(buf, "%*u:%02u", max_width - 3, mins, seconds % 60);
738 } else { /* more than one hour => h:mm:ss, hh:mm:ss, hhh:mm:ss, ... */
739 max_width = opts->mode == LS_MODE_LONG?
740 opts->widths.duration_width : 7;
741 sprintf(buf, "%*u:%02u:%02u", max_width - 6, hours, mins,
747 static int write_attribute_items(struct para_buffer *b,
748 const char *att_bitmap, struct afs_info *afsi)
753 ret = WRITE_STATUS_ITEM(b, SI_ATTRIBUTES_BITMAP, "%s\n", att_bitmap);
756 ret = get_attribute_text(&afsi->attributes, " ", &att_text);
759 ret = WRITE_STATUS_ITEM(b, SI_ATTRIBUTES_TXT, "%s\n", att_text);
764 static int write_lyrics_items(struct para_buffer *b, struct afs_info *afsi)
769 ret = WRITE_STATUS_ITEM(b, SI_LYRICS_ID, "%u\n", afsi->lyrics_id);
772 lyr_get_name_by_id(afsi->lyrics_id, &lyrics_name);
773 return WRITE_STATUS_ITEM(b, SI_LYRICS_NAME, "%s\n", lyrics_name?
774 lyrics_name : "(none)");
777 static int write_image_items(struct para_buffer *b, struct afs_info *afsi)
782 ret = WRITE_STATUS_ITEM(b, SI_IMAGE_ID, "%u\n", afsi->image_id);
785 img_get_name_by_id(afsi->image_id, &image_name);
786 return WRITE_STATUS_ITEM(b, SI_IMAGE_NAME, "%s\n", image_name?
787 image_name : "(none)");
790 static int write_filename_items(struct para_buffer *b, const char *path,
796 if (!(flags & LS_FLAG_FULL_PATH))
797 return WRITE_STATUS_ITEM(b, SI_BASENAME, "%s\n", path);
798 ret = WRITE_STATUS_ITEM(b, SI_PATH, "%s\n", path);
801 val = para_basename(path);
802 ret = WRITE_STATUS_ITEM(b, SI_BASENAME, "%s\n", val? val : "");
805 val = para_dirname(path);
806 ret = WRITE_STATUS_ITEM(b, SI_DIRECTORY, "%s\n", val? val : "");
811 static int print_chunk_table(struct ls_data *d, struct para_buffer *b)
813 struct osl_object chunk_table_obj;
814 struct osl_row *aft_row;
818 ret = aft_get_row_of_hash(d->hash, &aft_row);
821 ret = osl_open_disk_object(audio_file_table, aft_row,
822 AFTCOL_CHUNKS, &chunk_table_obj);
825 ret = para_printf(b, "%s\n"
826 "chunk_time: %lu:%lu\nchunk_offsets: ",
828 (long unsigned) d->afhi.chunk_tv.tv_sec,
829 (long unsigned) d->afhi.chunk_tv.tv_usec
833 buf = chunk_table_obj.data;
834 for (i = 0; i <= d->afhi.chunks_total; i++) {
835 ret = para_printf(b, "%u ", (unsigned) read_u32(buf + 4 * i));
839 ret = para_printf(b, "\n");
841 osl_close_disk_object(&chunk_table_obj);
845 static int write_score(struct para_buffer *b, struct ls_data *d,
846 struct ls_options *opts)
848 if (!(opts->flags & LS_FLAG_ADMISSIBLE_ONLY)) /* no score*/
850 return WRITE_STATUS_ITEM(b, SI_SCORE, "%li\n", d->score);
853 static int print_list_item(struct ls_data *d, struct ls_options *opts,
854 struct para_buffer *b, time_t current_time)
858 char last_played_time[30];
859 char duration_buf[30]; /* nobody has an audio file long enough to overflow this */
860 struct afs_info *afsi = &d->afsi;
861 struct afh_info *afhi = &d->afhi;
862 char asc_hash[2 * HASH_SIZE + 1];
864 if (opts->mode == LS_MODE_SHORT) {
865 ret = para_printf(b, "%s\n", d->path);
868 if (opts->mode == LS_MODE_CHUNKS) {
869 ret = print_chunk_table(d, b);
872 get_attribute_bitmap(&afsi->attributes, att_buf);
873 if (opts->flags & LS_FLAG_UNIXDATE)
874 sprintf(last_played_time, "%llu",
875 (long long unsigned)afsi->last_played);
877 ret = get_local_time(&afsi->last_played, last_played_time,
878 sizeof(last_played_time), current_time, opts->mode);
882 get_duration_buf(afhi->seconds_total, duration_buf, opts);
883 if (opts->mode == LS_MODE_LONG) {
884 struct ls_widths *w = &opts->widths;
885 if (opts->flags & LS_FLAG_ADMISSIBLE_ONLY) {
886 ret = para_printf(b, "%*li ",
887 opts->widths.score_width, d->score);
892 "%s " /* attributes */
894 "%*d " /* image_id */
895 "%*d " /* lyrics_id */
897 "%s " /* audio format */
898 "%*d " /* frequency */
901 "%*d " /* num_played */
902 "%s " /* last_played */
905 w->amp_width, afsi->amp,
906 w->image_id_width, afsi->image_id,
907 w->lyrics_id_width, afsi->lyrics_id,
908 w->bitrate_width, afhi->bitrate,
909 audio_format_name(afsi->audio_format_id),
910 w->frequency_width, afhi->frequency,
913 w->num_played_width, afsi->num_played,
919 if (opts->mode == LS_MODE_MBOX) {
920 const char *bn = para_basename(d->path);
922 "From foo@localhost %s\n"
923 "Received: from\nTo: bar\nFrom: a\n"
930 ret = write_filename_items(b, d->path, opts->flags);
933 ret = write_score(b, d, opts);
936 ret = write_attribute_items(b, att_buf, afsi);
939 ret = write_image_items(b, afsi);
942 ret = write_lyrics_items(b, afsi);
945 hash_to_asc(d->hash, asc_hash);
946 ret = WRITE_STATUS_ITEM(b, SI_HASH, "%s\n", asc_hash);
949 ret = WRITE_STATUS_ITEM(b, SI_BITRATE, "%dkbit/s\n", afhi->bitrate);
952 ret = WRITE_STATUS_ITEM(b, SI_FORMAT, "%s\n",
953 audio_format_name(afsi->audio_format_id));
956 ret = WRITE_STATUS_ITEM(b, SI_FREQUENCY, "%dHz\n", afhi->frequency);
959 ret = WRITE_STATUS_ITEM(b, SI_CHANNELS, "%d\n", afhi->channels);
962 ret = WRITE_STATUS_ITEM(b, SI_DURATION, "%s\n", duration_buf);
965 ret = WRITE_STATUS_ITEM(b, SI_SECONDS_TOTAL, "%lu\n",
966 afhi->seconds_total);
969 ret = WRITE_STATUS_ITEM(b, SI_LAST_PLAYED, "%s\n", last_played_time);
972 ret = WRITE_STATUS_ITEM(b, SI_NUM_PLAYED, "%d\n", afsi->num_played);
975 ret = WRITE_STATUS_ITEM(b, SI_AMPLIFICATION, "%u\n", afsi->amp);
978 ret = WRITE_STATUS_ITEM(b, SI_CHUNK_TIME, "%lu\n",
979 tv2ms(&afhi->chunk_tv));
982 ret = WRITE_STATUS_ITEM(b, SI_NUM_CHUNKS, "%lu\n",
986 ret = WRITE_STATUS_ITEM(b, SI_TECHINFO, "%s\n", afhi->techinfo);
989 ret = WRITE_STATUS_ITEM(b, SI_ARTIST, "%s\n", afhi->tags.artist);
992 ret = WRITE_STATUS_ITEM(b, SI_TITLE, "%s\n", afhi->tags.title);
995 ret = WRITE_STATUS_ITEM(b, SI_YEAR, "%s\n", afhi->tags.year);
998 ret = WRITE_STATUS_ITEM(b, SI_ALBUM, "%s\n", afhi->tags.album);
1001 ret = WRITE_STATUS_ITEM(b, SI_COMMENT, "%s\n", afhi->tags.comment);
1004 if (opts->mode == LS_MODE_MBOX) {
1005 struct osl_object lyrics_def;
1006 lyr_get_def_by_id(afsi->lyrics_id, &lyrics_def);
1007 if (lyrics_def.data) {
1008 ret = para_printf(b, "Lyrics:\n~~~~~~~\n%s",
1009 (char *)lyrics_def.data);
1010 osl_close_disk_object(&lyrics_def);
1017 static int make_status_items(struct audio_file_data *afd,
1018 struct afs_info *afsi, char *path, long score,
1021 struct ls_data d = {
1028 struct ls_options opts = {
1029 .flags = LS_FLAG_FULL_PATH | LS_FLAG_ADMISSIBLE_ONLY,
1030 .mode = LS_MODE_VERBOSE,
1032 struct para_buffer pb = {.max_size = SHMMAX - 1};
1033 time_t current_time;
1036 time(¤t_time);
1037 ret = print_list_item(&d, &opts, &pb, current_time);
1041 status_items = pb.buf;
1042 memset(&pb, 0, sizeof(pb));
1043 pb.max_size = SHMMAX - 1;
1044 pb.flags = PBF_SIZE_PREFIX;
1045 ret = print_list_item(&d, &opts, &pb, current_time);
1048 status_items = NULL;
1051 free(parser_friendly_status_items);
1052 parser_friendly_status_items = pb.buf;
1057 * Mmap the given audio file and update statistics.
1059 * \param aft_row Determines the audio file to be opened and updated.
1060 * \param score The score of the audio file.
1061 * \param afd Result pointer.
1063 * On success, the numplayed field of the audio file selector info is increased
1064 * and the lastplayed time is set to the current time. Finally, the score of
1065 * the audio file is updated.
1067 * \return Positive shmid on success, negative on errors.
1069 int open_and_update_audio_file(struct osl_row *aft_row, long score,
1070 struct audio_file_data *afd)
1072 HASH_TYPE *aft_hash, file_hash[HASH_SIZE];
1073 struct osl_object afsi_obj;
1074 struct afs_info old_afsi, new_afsi;
1075 int ret = get_hash_of_row(aft_row, &aft_hash);
1076 struct afsi_change_event_data aced;
1077 struct osl_object map, chunk_table_obj;
1082 ret = get_audio_file_path_of_row(aft_row, &path);
1085 PARA_NOTICE_LOG("%s\n", path);
1086 ret = get_afsi_object_of_row(aft_row, &afsi_obj);
1089 ret = load_afsi(&old_afsi, &afsi_obj);
1092 ret = get_afhi_of_row(aft_row, &afd->afhi);
1095 afd->afhi.chunk_table = NULL;
1096 ret = osl_open_disk_object(audio_file_table, aft_row,
1097 AFTCOL_CHUNKS, &chunk_table_obj);
1100 ret = mmap_full_file(path, O_RDONLY, &map.data,
1101 &map.size, &afd->fd);
1104 hash_function(map.data, map.size, file_hash);
1105 ret = hash_compare(file_hash, aft_hash);
1106 para_munmap(map.data, map.size);
1108 ret = -E_HASH_MISMATCH;
1111 new_afsi = old_afsi;
1112 new_afsi.num_played++;
1113 new_afsi.last_played = time(NULL);
1114 save_afsi(&new_afsi, &afsi_obj); /* in-place update */
1116 load_chunk_table(&afd->afhi, chunk_table_obj.data);
1117 ret = make_status_items(afd, &old_afsi, path, score, file_hash);
1120 aced.aft_row = aft_row;
1121 aced.old_afsi = &old_afsi;
1122 afs_event(AFSI_CHANGE, NULL, &aced);
1123 ret = save_afd(afd);
1125 free(afd->afhi.chunk_table);
1126 osl_close_disk_object(&chunk_table_obj);
1130 static int ls_audio_format_compare(const void *a, const void *b)
1132 struct ls_data *d1 = *(struct ls_data **)a, *d2 = *(struct ls_data **)b;
1133 return NUM_COMPARE(d1->afsi.audio_format_id, d2->afsi.audio_format_id);
1136 static int ls_duration_compare(const void *a, const void *b)
1138 struct ls_data *d1 = *(struct ls_data **)a, *d2 = *(struct ls_data **)b;
1139 return NUM_COMPARE(d1->afhi.seconds_total, d2->afhi.seconds_total);
1142 static int ls_bitrate_compare(const void *a, const void *b)
1144 struct ls_data *d1 = *(struct ls_data **)a, *d2 = *(struct ls_data **)b;
1145 return NUM_COMPARE(d1->afhi.bitrate, d2->afhi.bitrate);
1148 static int ls_lyrics_id_compare(const void *a, const void *b)
1150 struct ls_data *d1 = *(struct ls_data **)a, *d2 = *(struct ls_data **)b;
1151 return NUM_COMPARE(d1->afsi.lyrics_id, d2->afsi.lyrics_id);
1154 static int ls_image_id_compare(const void *a, const void *b)
1156 struct ls_data *d1 = *(struct ls_data **)a, *d2 = *(struct ls_data **)b;
1157 return NUM_COMPARE(d1->afsi.image_id, d2->afsi.image_id);
1160 static int ls_channels_compare(const void *a, const void *b)
1162 struct ls_data *d1 = *(struct ls_data **)a, *d2 = *(struct ls_data **)b;
1163 return NUM_COMPARE(d1->afhi.channels, d2->afhi.channels);
1166 static int ls_frequency_compare(const void *a, const void *b)
1168 struct ls_data *d1 = *(struct ls_data **)a, *d2 = *(struct ls_data **)b;
1169 return NUM_COMPARE(d1->afhi.frequency, d2->afhi.frequency);
1172 static int ls_num_played_compare(const void *a, const void *b)
1174 struct ls_data *d1 = *(struct ls_data **)a, *d2 = *(struct ls_data **)b;
1175 return NUM_COMPARE(d1->afsi.num_played, d2->afsi.num_played);
1178 static int ls_last_played_compare(const void *a, const void *b)
1180 struct ls_data *d1 = *(struct ls_data **)a, *d2 = *(struct ls_data **)b;
1181 return NUM_COMPARE(d1->afsi.last_played, d2->afsi.last_played);
1184 static int ls_score_compare(const void *a, const void *b)
1186 struct ls_data *d1 = *(struct ls_data **)a, *d2 = *(struct ls_data **)b;
1187 return NUM_COMPARE(d1->score, d2->score);
1190 static int ls_path_compare(const void *a, const void *b)
1192 struct ls_data *d1 = *(struct ls_data **)a, *d2 = *(struct ls_data **)b;
1193 return strcmp(d1->path, d2->path);
1196 static int sort_matching_paths(struct ls_options *options)
1198 size_t nmemb = options->num_matching_paths;
1199 size_t size = sizeof(*options->data_ptr);
1200 int (*compar)(const void *, const void *);
1203 options->data_ptr = para_malloc(nmemb * sizeof(*options->data_ptr));
1204 for (i = 0; i < nmemb; i++)
1205 options->data_ptr[i] = options->data + i;
1207 /* In these cases the array is already sorted */
1208 if (options->sorting == LS_SORT_BY_PATH
1209 && !(options->flags & LS_FLAG_ADMISSIBLE_ONLY)
1210 && (options->flags & LS_FLAG_FULL_PATH))
1212 if (options->sorting == LS_SORT_BY_SCORE &&
1213 options->flags & LS_FLAG_ADMISSIBLE_ONLY)
1216 switch (options->sorting) {
1217 case LS_SORT_BY_PATH:
1218 compar = ls_path_compare; break;
1219 case LS_SORT_BY_SCORE:
1220 compar = ls_score_compare; break;
1221 case LS_SORT_BY_LAST_PLAYED:
1222 compar = ls_last_played_compare; break;
1223 case LS_SORT_BY_NUM_PLAYED:
1224 compar = ls_num_played_compare; break;
1225 case LS_SORT_BY_FREQUENCY:
1226 compar = ls_frequency_compare; break;
1227 case LS_SORT_BY_CHANNELS:
1228 compar = ls_channels_compare; break;
1229 case LS_SORT_BY_IMAGE_ID:
1230 compar = ls_image_id_compare; break;
1231 case LS_SORT_BY_LYRICS_ID:
1232 compar = ls_lyrics_id_compare; break;
1233 case LS_SORT_BY_BITRATE:
1234 compar = ls_bitrate_compare; break;
1235 case LS_SORT_BY_DURATION:
1236 compar = ls_duration_compare; break;
1237 case LS_SORT_BY_AUDIO_FORMAT:
1238 compar = ls_audio_format_compare; break;
1242 qsort(options->data_ptr, nmemb, size, compar);
1246 /* row is either an aft_row or a row of the score table */
1247 /* TODO: Only compute widths if we need them */
1248 static int prepare_ls_row(struct osl_row *row, void *ls_opts)
1251 struct ls_options *options = ls_opts;
1253 struct ls_widths *w;
1254 unsigned short num_digits;
1256 struct osl_row *aft_row;
1260 if (options->flags & LS_FLAG_ADMISSIBLE_ONLY) {
1261 ret = get_score_and_aft_row(row, &score, &aft_row);
1266 ret = get_audio_file_path_of_row(aft_row, &path);
1269 if (!(options->flags & LS_FLAG_FULL_PATH)) {
1270 char *p = strrchr(path, '/');
1274 if (options->num_patterns) {
1275 for (i = 0; i < options->num_patterns; i++) {
1276 ret = fnmatch(options->patterns[i], path, 0);
1279 if (ret == FNM_NOMATCH)
1283 if (i >= options->num_patterns) /* no match */
1286 tmp = options->num_matching_paths++;
1287 if (options->num_matching_paths > options->array_size) {
1288 options->array_size++;
1289 options->array_size *= 2;
1290 options->data = para_realloc(options->data, options->array_size
1291 * sizeof(*options->data));
1293 d = options->data + tmp;
1294 ret = get_afsi_of_row(aft_row, &d->afsi);
1297 ret = get_afhi_of_row(aft_row, &d->afhi);
1301 ret = get_hash_of_row(aft_row, &d->hash);
1304 w = &options->widths;
1305 GET_NUM_DIGITS(d->afsi.image_id, &num_digits);
1306 w->image_id_width = PARA_MAX(w->image_id_width, num_digits);
1307 GET_NUM_DIGITS(d->afsi.lyrics_id, &num_digits);
1308 w->lyrics_id_width = PARA_MAX(w->lyrics_id_width, num_digits);
1309 GET_NUM_DIGITS(d->afhi.bitrate, &num_digits);
1310 w->bitrate_width = PARA_MAX(w->bitrate_width, num_digits);
1311 GET_NUM_DIGITS(d->afhi.frequency, &num_digits);
1312 w->frequency_width = PARA_MAX(w->frequency_width, num_digits);
1313 GET_NUM_DIGITS(d->afsi.num_played, &num_digits);
1314 w->num_played_width = PARA_MAX(w->num_played_width, num_digits);
1315 /* get the number of chars to print this amount of time */
1316 num_digits = get_duration_width(d->afhi.seconds_total);
1317 w->duration_width = PARA_MAX(w->duration_width, num_digits);
1318 GET_NUM_DIGITS(d->afsi.amp, &num_digits);
1319 w->amp_width = PARA_MAX(w->amp_width, num_digits);
1320 if (options->flags & LS_FLAG_ADMISSIBLE_ONLY) {
1321 GET_NUM_DIGITS(score, &num_digits);
1322 num_digits++; /* add one for the sign (space or "-") */
1323 w->score_width = PARA_MAX(w->score_width, num_digits);
1331 static void com_ls_callback(int fd, const struct osl_object *query)
1333 struct ls_options *opts = query->data;
1334 char *p, *pattern_start = (char *)query->data + sizeof(*opts);
1335 struct para_buffer b = {.max_size = SHMMAX,
1336 .flags = (opts->mode == LS_MODE_PARSER)? PBF_SIZE_PREFIX : 0,
1337 .max_size_handler = pass_buffer_as_shm, .private_data = &fd};
1339 time_t current_time;
1341 if (opts->num_patterns) {
1342 opts->patterns = para_malloc(opts->num_patterns * sizeof(char *));
1343 for (i = 0, p = pattern_start; i < opts->num_patterns; i++) {
1344 opts->patterns[i] = p;
1348 opts->patterns = NULL;
1349 if (opts->flags & LS_FLAG_ADMISSIBLE_ONLY)
1350 ret = admissible_file_loop(opts, prepare_ls_row);
1352 ret = osl(osl_rbtree_loop(audio_file_table, AFTCOL_PATH, opts,
1356 if (!opts->num_matching_paths)
1358 ret = sort_matching_paths(opts);
1361 time(¤t_time);
1362 if (opts->flags & LS_FLAG_REVERSE)
1363 for (i = opts->num_matching_paths - 1; i >= 0; i--) {
1364 ret = print_list_item(opts->data_ptr[i], opts, &b, current_time);
1369 for (i = 0; i < opts->num_matching_paths; i++) {
1370 ret = print_list_item(opts->data_ptr[i], opts, &b, current_time);
1376 pass_buffer_as_shm(b.buf, b.offset, &fd);
1379 free(opts->data_ptr);
1380 free(opts->patterns);
1384 * TODO: flags -h (sort by hash)
1386 int com_ls(struct rc4_context *rc4c, int argc, char * const * const argv)
1390 enum ls_sorting_method sort = LS_SORT_BY_PATH;
1391 enum ls_listing_mode mode = LS_MODE_SHORT;
1392 struct ls_options opts = {.patterns = NULL};
1393 struct osl_object query = {.data = &opts, .size = sizeof(opts)};
1395 for (i = 1; i < argc; i++) {
1396 const char *arg = argv[i];
1399 if (!strcmp(arg, "--")) {
1403 if (!strncmp(arg, "-l", 2)) {
1405 mode = LS_MODE_LONG;
1409 return -E_AFT_SYNTAX;
1410 switch(*(arg + 2)) {
1412 mode = LS_MODE_SHORT;
1415 mode = LS_MODE_LONG;
1418 mode = LS_MODE_VERBOSE;
1421 mode = LS_MODE_MBOX;
1424 mode = LS_MODE_CHUNKS;
1427 mode = LS_MODE_PARSER;
1430 return -E_AFT_SYNTAX;
1433 if (!strcmp(arg, "-p")) {
1434 flags |= LS_FLAG_FULL_PATH;
1437 if (!strcmp(arg, "-a")) {
1438 flags |= LS_FLAG_ADMISSIBLE_ONLY;
1441 if (!strcmp(arg, "-r")) {
1442 flags |= LS_FLAG_REVERSE;
1445 if (!strcmp(arg, "-d")) {
1446 flags |= LS_FLAG_UNIXDATE;
1449 if (!strncmp(arg, "-s", 2)) {
1450 if (!*(arg + 2) || *(arg + 3))
1451 return -E_AFT_SYNTAX;
1452 switch(*(arg + 2)) {
1454 sort = LS_SORT_BY_PATH;
1456 case 's': /* -ss implies -a */
1457 sort = LS_SORT_BY_SCORE;
1458 flags |= LS_FLAG_ADMISSIBLE_ONLY;
1461 sort = LS_SORT_BY_LAST_PLAYED;
1464 sort = LS_SORT_BY_NUM_PLAYED;
1467 sort = LS_SORT_BY_FREQUENCY;
1470 sort = LS_SORT_BY_CHANNELS;
1473 sort = LS_SORT_BY_IMAGE_ID;
1476 sort = LS_SORT_BY_LYRICS_ID;
1479 sort = LS_SORT_BY_BITRATE;
1482 sort = LS_SORT_BY_DURATION;
1485 sort = LS_SORT_BY_AUDIO_FORMAT;
1488 return -E_AFT_SYNTAX;
1491 return -E_AFT_SYNTAX;
1494 opts.sorting = sort;
1496 opts.num_patterns = argc - i;
1497 ret = send_option_arg_callback_request(&query, opts.num_patterns,
1498 argv + i, com_ls_callback, rc4_send_result, rc4c);
1503 * Call the given function for each file in the audio file table.
1505 * \param private_data An arbitrary data pointer, passed to \a func.
1506 * \param func The custom function to be called.
1510 int audio_file_loop(void *private_data, osl_rbtree_loop_func *func)
1512 return osl(osl_rbtree_loop(audio_file_table, AFTCOL_HASH, private_data,
1516 static struct osl_row *find_hash_sister(HASH_TYPE *hash)
1518 const struct osl_object obj = {.data = hash, .size = HASH_SIZE};
1519 struct osl_row *row;
1521 osl_get_row(audio_file_table, AFTCOL_HASH, &obj, &row);
1525 /** The format of the data stored by save_audio_file_data(). */
1526 enum com_add_buffer_offsets {
1527 /** afhi (if present) starts here. */
1528 CAB_AFHI_OFFSET_POS = 0,
1529 /** Start of the chunk table (if present). */
1530 CAB_CHUNKS_OFFSET_POS = 2,
1531 /** Audio format id. */
1532 CAB_AUDIO_FORMAT_OFFSET = 4,
1533 /** Flags given to the add command. */
1534 CAB_FLAGS_OFFSET = 5,
1535 /** The hash of the audio file being added. */
1536 CAB_HASH_OFFSET = 9,
1537 /** Start of the path of the audio file. */
1538 CAB_PATH_OFFSET = (CAB_HASH_OFFSET + HASH_SIZE),
1542 * Store the given data to a single buffer. Doesn't need the audio file selector
1543 * info struct as the server knows it as well.
1545 * It's OK to call this with afhi == NULL. In this case, the audio format
1546 * handler info won't be stored in the buffer.
1548 static void save_add_callback_buffer(HASH_TYPE *hash, const char *path,
1549 struct afh_info *afhi, uint32_t flags,
1550 uint8_t audio_format_num, struct osl_object *obj)
1552 size_t path_len = strlen(path) + 1;
1553 size_t afhi_size = sizeof_afhi_buf(afhi);
1554 size_t size = CAB_PATH_OFFSET + path_len + afhi_size
1555 + sizeof_chunk_table(afhi);
1556 char *buf = para_malloc(size);
1559 write_u8(buf + CAB_AUDIO_FORMAT_OFFSET, audio_format_num);
1560 write_u32(buf + CAB_FLAGS_OFFSET, flags);
1562 memcpy(buf + CAB_HASH_OFFSET, hash, HASH_SIZE);
1563 strcpy(buf + CAB_PATH_OFFSET, path);
1565 pos = CAB_PATH_OFFSET + path_len;
1566 PARA_DEBUG_LOG("size: %zu, afhi starts at %d\n", size, pos);
1567 PARA_DEBUG_LOG("last afhi byte: %p, pos %zu\n", buf + pos + afhi_size - 1,
1568 pos + afhi_size - 1);
1569 write_u16(buf + CAB_AFHI_OFFSET_POS, pos);
1570 save_afhi(afhi, buf + pos);
1573 PARA_DEBUG_LOG("size: %zu, chunks start at %d\n", size, pos);
1574 write_u16(buf + CAB_CHUNKS_OFFSET_POS, pos);
1576 save_chunk_table(afhi, buf + pos);
1577 PARA_DEBUG_LOG("last byte in buf: %p\n", buf + size - 1);
1584 Overview of the add command.
1586 Input: What was passed to the callback by the command handler.
1588 HS: Hash sister. Whether an audio file with identical hash
1589 already exists in the osl database.
1591 PB: Path brother. Whether a file with the given path exists
1594 F: Force flag given. Whether add was called with -f.
1596 output: Action performed by the callback.
1598 AFHI: Whether afhi and chunk table are computed and sent.
1599 ACTION: Table modifications to be done by the callback.
1601 +----+----+---+------+---------------------------------------------------+
1602 | HS | PB | F | AFHI | ACTION
1603 +----+----+---+------+---------------------------------------------------+
1604 | Y | Y | Y | Y | if HS != PB: remove PB. HS: force afhi update,
1605 | | update path, keep afsi
1606 +----+----+---+------+---------------------------------------------------+
1607 | Y | Y | N | N | if HS == PB: do not send callback request at all.
1608 | | otherwise: remove PB, HS: update path, keep afhi,
1610 +----+----+---+------+---------------------------------------------------+
1611 | Y | N | Y | Y | (rename) force afhi update of HS, update path of
1613 +----+----+---+------+---------------------------------------------------+
1614 | Y | N | N | N | (file rename) update path of HS, keep afsi, afhi
1615 +----+----+---+------+---------------------------------------------------+
1616 | N | Y | Y | Y | (file change) update afhi, hash, of PB, keep afsi
1617 | | (force has no effect)
1618 +----+----+---+------+---------------------------------------------------+
1619 | N | Y | N | Y | (file change) update afhi, hash of PB, keep afsi
1620 +----+----+---+------+---------------------------------------------------+
1621 | N | N | Y | Y | (new file) create new entry (force has no effect)
1622 +----+----+---+------+---------------------------------------------------+
1623 | N | N | N | Y | (new file) create new entry
1624 +----+----+---+------+---------------------------------------------------+
1628 afhi <=> force or no HS
1633 /** Flags passed to the add command. */
1634 enum com_add_flags {
1635 /** Skip paths that exist already. */
1637 /** Force adding. */
1639 /** Print what is being done. */
1640 ADD_FLAG_VERBOSE = 4,
1641 /** Try to add files with unknown suffixes. */
1645 static void com_add_callback(int fd, const struct osl_object *query)
1647 char *buf = query->data, *path;
1648 struct osl_row *pb, *aft_row;
1650 struct osl_object objs[NUM_AFT_COLUMNS];
1652 char asc[2 * HASH_SIZE + 1];
1654 char afsi_buf[AFSI_SIZE];
1655 uint32_t flags = read_u32(buf + CAB_FLAGS_OFFSET);
1656 struct afs_info default_afsi = {.last_played = 0};
1657 struct para_buffer msg = {.max_size = SHMMAX,
1658 .max_size_handler = pass_buffer_as_shm, .private_data = &fd};
1659 uint16_t afhi_offset, chunks_offset;
1661 hash = (HASH_TYPE *)buf + CAB_HASH_OFFSET;
1662 hash_to_asc(hash, asc);;
1663 objs[AFTCOL_HASH].data = buf + CAB_HASH_OFFSET;
1664 objs[AFTCOL_HASH].size = HASH_SIZE;
1666 path = buf + CAB_PATH_OFFSET;
1667 objs[AFTCOL_PATH].data = path;
1668 objs[AFTCOL_PATH].size = strlen(path) + 1;
1670 PARA_INFO_LOG("request to add %s\n", path);
1671 hs = find_hash_sister(hash);
1672 ret = aft_get_row_of_path(path, &pb);
1673 if (ret < 0 && ret != -OSL_ERRNO_TO_PARA_ERROR(E_OSL_RB_KEY_NOT_FOUND))
1675 if (hs && pb && hs == pb && !(flags & ADD_FLAG_FORCE)) {
1676 if (flags & ADD_FLAG_VERBOSE)
1677 ret = para_printf(&msg, "ignoring duplicate\n");
1682 if (hs && hs != pb) {
1683 struct osl_object obj;
1684 if (pb) { /* hs trumps pb, remove pb */
1685 if (flags & ADD_FLAG_VERBOSE) {
1686 ret = para_printf(&msg, "removing path brother\n");
1690 ret = osl(osl_del_row(audio_file_table, pb));
1695 /* file rename, update hs' path */
1696 if (flags & ADD_FLAG_VERBOSE) {
1697 ret = osl(osl_get_object(audio_file_table, hs,
1698 AFTCOL_PATH, &obj));
1701 ret = para_printf(&msg, "renamed from %s\n", (char *)obj.data);
1705 ret = osl(osl_update_object(audio_file_table, hs, AFTCOL_PATH,
1706 &objs[AFTCOL_PATH]));
1709 afs_event(AUDIO_FILE_RENAME, &msg, hs);
1710 if (!(flags & ADD_FLAG_FORCE))
1713 /* no hs or force mode, child must have sent afhi */
1714 afhi_offset = read_u16(buf + CAB_AFHI_OFFSET_POS);
1715 chunks_offset = read_u16(buf + CAB_CHUNKS_OFFSET_POS);
1717 objs[AFTCOL_AFHI].data = buf + afhi_offset;
1718 objs[AFTCOL_AFHI].size = chunks_offset - afhi_offset;
1720 if (!objs[AFTCOL_AFHI].size) /* "impossible" */
1722 objs[AFTCOL_CHUNKS].data = buf + chunks_offset;
1723 objs[AFTCOL_CHUNKS].size = query->size - chunks_offset;
1724 if (pb && !hs) { /* update pb's hash */
1725 char old_asc[2 * HASH_SIZE + 1];
1726 HASH_TYPE *old_hash;
1727 ret = get_hash_of_row(pb, &old_hash);
1730 hash_to_asc(old_hash, old_asc);
1731 if (flags & ADD_FLAG_VERBOSE) {
1732 ret = para_printf(&msg, "file change: %s -> %s\n",
1737 ret = osl_update_object(audio_file_table, pb, AFTCOL_HASH,
1738 &objs[AFTCOL_HASH]);
1742 if (hs || pb) { /* (hs != NULL and pb != NULL) implies hs == pb */
1743 struct osl_row *row = pb? pb : hs;
1744 /* update afhi and chunk_table */
1745 if (flags & ADD_FLAG_VERBOSE) {
1746 ret = para_printf(&msg, "updating afhi and chunk table\n");
1750 ret = osl(osl_update_object(audio_file_table, row, AFTCOL_AFHI,
1751 &objs[AFTCOL_AFHI]));
1754 ret = osl(osl_update_object(audio_file_table, row, AFTCOL_CHUNKS,
1755 &objs[AFTCOL_CHUNKS]));
1758 afs_event(AFHI_CHANGE, &msg, row);
1761 /* new entry, use default afsi */
1762 if (flags & ADD_FLAG_VERBOSE) {
1763 ret = para_printf(&msg, "new file\n");
1767 default_afsi.last_played = time(NULL) - 365 * 24 * 60 * 60;
1768 default_afsi.audio_format_id = read_u8(buf + CAB_AUDIO_FORMAT_OFFSET);
1770 objs[AFTCOL_AFSI].data = &afsi_buf;
1771 objs[AFTCOL_AFSI].size = AFSI_SIZE;
1772 save_afsi(&default_afsi, &objs[AFTCOL_AFSI]);
1773 ret = osl(osl_add_and_get_row(audio_file_table, objs, &aft_row));
1774 afs_event(AUDIO_FILE_ADD, &msg, aft_row);
1777 para_printf(&msg, "%s\n", para_strerror(-ret));
1779 pass_buffer_as_shm(msg.buf, msg.offset, &fd);
1783 /** Used by com_add(). */
1784 struct private_add_data {
1785 /** The socket file descriptor, including rc4 keys. */
1786 struct rc4_context *rc4c;
1787 /** The given add flags. */
1791 static void path_brother_callback(int fd, const struct osl_object *query)
1793 char *path = query->data;
1794 struct osl_row *path_brother;
1795 int ret = aft_get_row_of_path(path, &path_brother);
1798 pass_buffer_as_shm((char *)&path_brother, sizeof(path_brother), &fd);
1801 static void hash_sister_callback(int fd, const struct osl_object *query)
1803 HASH_TYPE *hash = query->data;
1804 struct osl_row *hash_sister;
1806 hash_sister = find_hash_sister(hash);
1809 pass_buffer_as_shm((char *)&hash_sister, sizeof(hash_sister), &fd);
1812 static int get_row_pointer_from_result(struct osl_object *result, void *private)
1814 struct osl_row **row = private;
1815 *row = result->data;
1819 static int add_one_audio_file(const char *path, void *private_data)
1821 int ret, send_ret = 1, fd;
1822 uint8_t format_num = -1;
1823 struct private_add_data *pad = private_data;
1824 struct afh_info afhi, *afhi_ptr = NULL;
1825 struct osl_row *pb = NULL, *hs = NULL; /* path brother/hash sister */
1826 struct osl_object map, obj = {.data = NULL}, query;
1827 HASH_TYPE hash[HASH_SIZE];
1829 ret = guess_audio_format(path);
1830 if (ret < 0 && !(pad->flags & ADD_FLAG_ALL))
1832 query.data = (char *)path;
1833 query.size = strlen(path) + 1;
1834 ret = send_callback_request(path_brother_callback, &query,
1835 get_row_pointer_from_result, &pb);
1836 if (ret < 0 && ret != -OSL_ERRNO_TO_PARA_ERROR(E_OSL_RB_KEY_NOT_FOUND))
1839 if (pb && (pad->flags & ADD_FLAG_LAZY)) { /* lazy is really cheap */
1840 if (pad->flags & ADD_FLAG_VERBOSE)
1841 send_ret = rc4_send_va_buffer(pad->rc4c,
1842 "lazy-ignore: %s\n", path);
1845 /* We still want to add this file. Compute its hash. */
1846 ret = mmap_full_file(path, O_RDONLY, &map.data, &map.size, &fd);
1849 hash_function(map.data, map.size, hash);
1851 /* Check whether the database contains a file with the same hash. */
1853 query.size = HASH_SIZE;
1854 ret = send_callback_request(hash_sister_callback, &query,
1855 get_row_pointer_from_result, &hs);
1858 /* Return success if we already know this file. */
1860 if (pb && hs && hs == pb && !(pad->flags & ADD_FLAG_FORCE)) {
1861 if (pad->flags & ADD_FLAG_VERBOSE)
1862 send_ret = rc4_send_va_buffer(pad->rc4c,
1863 "%s exists, not forcing update\n", path);
1867 * We won't recalculate the audio format info and the chunk table if
1868 * there is a hash sister and FORCE was not given.
1870 if (!hs || (pad->flags & ADD_FLAG_FORCE)) {
1871 ret = compute_afhi(path, map.data, map.size, fd, &afhi);
1877 munmap(map.data, map.size);
1879 if (pad->flags & ADD_FLAG_VERBOSE) {
1880 send_ret = rc4_send_va_buffer(pad->rc4c, "adding %s\n", path);
1884 save_add_callback_buffer(hash, path, afhi_ptr, pad->flags, format_num, &obj);
1885 /* Ask afs to consider this entry for adding. */
1886 ret = send_callback_request(com_add_callback, &obj, rc4_send_result, pad->rc4c);
1891 munmap(map.data, map.size);
1893 if (ret < 0 && send_ret >= 0)
1894 send_ret = rc4_send_va_buffer(pad->rc4c,
1895 "failed to add %s (%s)\n", path, para_strerror(-ret));
1898 free(afhi_ptr->chunk_table);
1899 free(afhi_ptr->techinfo);
1900 free(afhi_ptr->tags.artist);
1901 free(afhi_ptr->tags.title);
1902 free(afhi_ptr->tags.year);
1903 free(afhi_ptr->tags.album);
1904 free(afhi_ptr->tags.comment);
1906 /* Stop adding files only on send errors. */
1910 int com_add(struct rc4_context *rc4c, int argc, char * const * const argv)
1913 struct private_add_data pad = {.rc4c = rc4c, .flags = 0};
1914 struct stat statbuf;
1916 for (i = 1; i < argc; i++) {
1917 const char *arg = argv[i];
1920 if (!strcmp(arg, "--")) {
1924 if (!strcmp(arg, "-a")) {
1925 pad.flags |= ADD_FLAG_ALL;
1928 if (!strcmp(arg, "-l")) {
1929 pad.flags |= ADD_FLAG_LAZY;
1932 if (!strcmp(arg, "-f")) {
1933 pad.flags |= ADD_FLAG_FORCE;
1936 if (!strcmp(arg, "-v")) {
1937 pad.flags |= ADD_FLAG_VERBOSE;
1942 return -E_AFT_SYNTAX;
1943 for (; i < argc; i++) {
1945 ret = verify_path(argv[i], &path);
1947 ret = rc4_send_va_buffer(rc4c, "%s: %s\n", argv[i],
1948 para_strerror(-ret));
1953 ret = stat(path, &statbuf);
1955 ret = rc4_send_va_buffer(rc4c, "failed to stat %s (%s)\n", path,
1962 if (S_ISDIR(statbuf.st_mode))
1963 ret = for_each_file_in_dir(path, add_one_audio_file,
1966 ret = add_one_audio_file(path, &pad);
1968 rc4_send_va_buffer(rc4c, "%s: %s\n", path, para_strerror(-ret));
1979 * Flags used by the touch command.
1984 /** Whether the \p FNM_PATHNAME flag should be passed to fnmatch(). */
1985 TOUCH_FLAG_FNM_PATHNAME = 1,
1986 /** Activates verbose mode. */
1987 TOUCH_FLAG_VERBOSE = 2
1990 /** Options used by com_touch(). */
1991 struct com_touch_options {
1992 /** New num_played value. */
1994 /** New last played count. */
1995 int64_t last_played;
1996 /** New lyrics id. */
1998 /** New image id. */
2000 /** New amplification value. */
2002 /** Command line flags (see \ref touch_flags). */
2006 /** Data passed to the action handler of com_touch(). */
2007 struct touch_action_data {
2008 /** Command line options (see \ref com_touch_options). */
2009 struct com_touch_options *cto;
2010 /** Message buffer. */
2011 struct para_buffer pb;
2012 /** How many audio files matched the given pattern. */
2013 unsigned num_matches;
2016 static int touch_audio_file(__a_unused struct osl_table *table,
2017 struct osl_row *row, const char *name, void *data)
2019 struct touch_action_data *tad = data;
2020 struct osl_object obj;
2021 struct afs_info old_afsi, new_afsi;
2022 int ret, no_options = tad->cto->num_played < 0 && tad->cto->last_played < 0 &&
2023 tad->cto->lyrics_id < 0 && tad->cto->image_id < 0 && tad->cto->amp < 0;
2024 struct afsi_change_event_data aced;
2026 ret = get_afsi_object_of_row(row, &obj);
2028 return para_printf(&tad->pb, "%s: %s\n", name, para_strerror(-ret));
2029 ret = load_afsi(&old_afsi, &obj);
2031 return para_printf(&tad->pb, "%s: %s\n", name, para_strerror(-ret));
2032 new_afsi = old_afsi;
2034 new_afsi.num_played++;
2035 new_afsi.last_played = time(NULL);
2036 if (tad->cto->flags & TOUCH_FLAG_VERBOSE) {
2037 ret = para_printf(&tad->pb, "%s: num_played = %u, "
2038 "last_played = now()\n", name,
2039 new_afsi.num_played);
2044 if (tad->cto->flags & TOUCH_FLAG_VERBOSE) {
2045 ret = para_printf(&tad->pb, "touching %s\n", name);
2049 if (tad->cto->lyrics_id >= 0)
2050 new_afsi.lyrics_id = tad->cto->lyrics_id;
2051 if (tad->cto->image_id >= 0)
2052 new_afsi.image_id = tad->cto->image_id;
2053 if (tad->cto->num_played >= 0)
2054 new_afsi.num_played = tad->cto->num_played;
2055 if (tad->cto->last_played >= 0)
2056 new_afsi.last_played = tad->cto->last_played;
2057 if (tad->cto->amp >= 0)
2058 new_afsi.amp = tad->cto->amp;
2061 save_afsi(&new_afsi, &obj); /* in-place update */
2063 aced.old_afsi = &old_afsi;
2064 afs_event(AFSI_CHANGE, &tad->pb, &aced);
2068 static void com_touch_callback(int fd, const struct osl_object *query)
2070 struct touch_action_data tad = {.cto = query->data,
2073 .private_data = &fd,
2074 .max_size_handler = pass_buffer_as_shm
2078 struct pattern_match_data pmd = {
2079 .table = audio_file_table,
2080 .loop_col_num = AFTCOL_HASH,
2081 .match_col_num = AFTCOL_PATH,
2082 .patterns = {.data = (char *)query->data + sizeof(*tad.cto),
2083 .size = query->size - sizeof(*tad.cto)},
2085 .action = touch_audio_file
2087 if (tad.cto->flags & TOUCH_FLAG_FNM_PATHNAME)
2088 pmd.fnmatch_flags |= FNM_PATHNAME;
2089 ret = for_each_matching_row(&pmd);
2091 ret2 = para_printf(&tad.pb, "%s\n", para_strerror(-ret));
2093 if (!tad.num_matches)
2094 ret2 = para_printf(&tad.pb, "no matches\n");
2095 if (ret2 >= 0 && tad.pb.offset)
2096 pass_buffer_as_shm(tad.pb.buf, tad.pb.offset, &fd);
2100 int com_touch(struct rc4_context *rc4c, int argc, char * const * const argv)
2102 struct com_touch_options cto = {
2109 struct osl_object query = {.data = &cto, .size = sizeof(cto)};
2113 for (i = 1; i < argc; i++) {
2114 const char *arg = argv[i];
2117 if (!strcmp(arg, "--")) {
2121 if (!strncmp(arg, "-n=", 3)) {
2122 ret = para_atoi32(arg + 3, &cto.num_played);
2127 if (!strncmp(arg, "-l=", 3)) {
2128 ret = para_atoi64(arg + 3, &cto.last_played);
2133 if (!strncmp(arg, "-y=", 3)) {
2134 ret = para_atoi32(arg + 3, &cto.lyrics_id);
2139 if (!strncmp(arg, "-i=", 3)) {
2140 ret = para_atoi32(arg + 3, &cto.image_id);
2145 if (!strncmp(arg, "-a=", 3)) {
2147 ret = para_atoi32(arg + 3, &val);
2150 if (val < 0 || val > 255)
2151 return -ERRNO_TO_PARA_ERROR(EINVAL);
2155 if (!strcmp(arg, "-p")) {
2156 cto.flags |= TOUCH_FLAG_FNM_PATHNAME;
2159 if (!strcmp(arg, "-v")) {
2160 cto.flags |= TOUCH_FLAG_VERBOSE;
2163 break; /* non-option starting with dash */
2166 return -E_AFT_SYNTAX;
2167 ret = send_option_arg_callback_request(&query, argc - i,
2168 argv + i, com_touch_callback, rc4_send_result, rc4c);
2170 rc4_send_va_buffer(rc4c, "%s\n", para_strerror(-ret));
2174 /** Flags for com_rm(). */
2177 RM_FLAG_VERBOSE = 1,
2181 RM_FLAG_FNM_PATHNAME = 4
2184 /** Data passed to the action handler of com_rm(). */
2185 struct com_rm_action_data {
2186 /** Command line flags ((see \ref rm_flags). */
2188 /** Message buffer. */
2189 struct para_buffer pb;
2190 /** Number of audio files removed. */
2191 unsigned num_removed;
2194 static int remove_audio_file(__a_unused struct osl_table *table,
2195 struct osl_row *row, const char *name, void *data)
2197 struct com_rm_action_data *crd = data;
2200 if (crd->flags & RM_FLAG_VERBOSE) {
2201 ret = para_printf(&crd->pb, "removing %s\n", name);
2205 afs_event(AUDIO_FILE_REMOVE, &crd->pb, row);
2206 ret = osl(osl_del_row(audio_file_table, row));
2208 para_printf(&crd->pb, "%s: %s\n", name, para_strerror(-ret));
2214 static void com_rm_callback(int fd, const struct osl_object *query)
2216 struct com_rm_action_data crd = {.flags = *(uint32_t *)query->data,
2219 .private_data = &fd,
2220 .max_size_handler = pass_buffer_as_shm
2224 struct pattern_match_data pmd = {
2225 .table = audio_file_table,
2226 .loop_col_num = AFTCOL_HASH,
2227 .match_col_num = AFTCOL_PATH,
2228 .patterns = {.data = (char *)query->data + sizeof(uint32_t),
2229 .size = query->size - sizeof(uint32_t)},
2231 .action = remove_audio_file
2233 if (crd.flags & RM_FLAG_FNM_PATHNAME)
2234 pmd.fnmatch_flags |= FNM_PATHNAME;
2235 ret = for_each_matching_row(&pmd);
2237 para_printf(&crd.pb, "%s\n", para_strerror(-ret));
2240 if (!crd.num_removed && !(crd.flags & RM_FLAG_FORCE))
2241 ret = para_printf(&crd.pb, "no matches -- nothing removed\n");
2243 if (crd.flags & RM_FLAG_VERBOSE)
2244 ret = para_printf(&crd.pb, "removed %u files\n", crd.num_removed);
2246 if (ret >= 0 && crd.pb.offset)
2247 pass_buffer_as_shm(crd.pb.buf, crd.pb.offset, &fd);
2251 /* TODO options: -r (recursive) */
2252 int com_rm(struct rc4_context *rc4c, int argc, char * const * const argv)
2255 struct osl_object query = {.data = &flags, .size = sizeof(flags)};
2258 for (i = 1; i < argc; i++) {
2259 const char *arg = argv[i];
2262 if (!strcmp(arg, "--")) {
2266 if (!strcmp(arg, "-f")) {
2267 flags |= RM_FLAG_FORCE;
2270 if (!strcmp(arg, "-p")) {
2271 flags |= RM_FLAG_FNM_PATHNAME;
2274 if (!strcmp(arg, "-v")) {
2275 flags |= RM_FLAG_VERBOSE;
2281 return -E_AFT_SYNTAX;
2282 ret = send_option_arg_callback_request(&query, argc - i, argv + i,
2283 com_rm_callback, rc4_send_result, rc4c);
2285 rc4_send_va_buffer(rc4c, "%s\n", para_strerror(-ret));
2290 * Flags used by the cpsi command.
2295 /** Whether the lyrics id should be copied. */
2296 CPSI_FLAG_COPY_LYRICS_ID = 1,
2297 /** Whether the image id should be copied. */
2298 CPSI_FLAG_COPY_IMAGE_ID = 2,
2299 /** Whether the lastplayed time should be copied. */
2300 CPSI_FLAG_COPY_LASTPLAYED = 4,
2301 /** Whether the numplayed count should be copied. */
2302 CPSI_FLAG_COPY_NUMPLAYED = 8,
2303 /** Whether the attributes should be copied. */
2304 CPSI_FLAG_COPY_ATTRIBUTES = 16,
2305 /** Activates verbose mode. */
2306 CPSI_FLAG_VERBOSE = 32,
2309 /** Data passed to the action handler of com_cpsi(). */
2310 struct cpsi_action_data {
2311 /** command line flags (see \ref cpsi_flags). */
2313 /** Number of audio files changed. */
2314 unsigned num_copied;
2315 /** Message buffer. */
2316 struct para_buffer pb;
2317 /** Values are copied from here. */
2318 struct afs_info source_afsi;
2321 static int copy_selector_info(__a_unused struct osl_table *table,
2322 struct osl_row *row, const char *name, void *data)
2324 struct cpsi_action_data *cad = data;
2325 struct osl_object target_afsi_obj;
2327 struct afs_info old_afsi, target_afsi;
2328 struct afsi_change_event_data aced;
2330 ret = get_afsi_object_of_row(row, &target_afsi_obj);
2333 load_afsi(&target_afsi, &target_afsi_obj);
2334 old_afsi = target_afsi;
2335 if (cad->flags & CPSI_FLAG_COPY_LYRICS_ID)
2336 target_afsi.lyrics_id = cad->source_afsi.lyrics_id;
2337 if (cad->flags & CPSI_FLAG_COPY_IMAGE_ID)
2338 target_afsi.image_id = cad->source_afsi.image_id;
2339 if (cad->flags & CPSI_FLAG_COPY_LASTPLAYED)
2340 target_afsi.last_played = cad->source_afsi.last_played;
2341 if (cad->flags & CPSI_FLAG_COPY_NUMPLAYED)
2342 target_afsi.num_played = cad->source_afsi.num_played;
2343 if (cad->flags & CPSI_FLAG_COPY_ATTRIBUTES)
2344 target_afsi.attributes = cad->source_afsi.attributes;
2345 save_afsi(&target_afsi, &target_afsi_obj); /* in-place update */
2347 if (cad->flags & CPSI_FLAG_VERBOSE) {
2348 ret = para_printf(&cad->pb, "copied afsi to %s\n", name);
2353 aced.old_afsi = &old_afsi;
2354 afs_event(AFSI_CHANGE, &cad->pb, &aced);
2358 static void com_cpsi_callback(int fd, const struct osl_object *query)
2360 struct cpsi_action_data cad = {
2361 .flags = *(unsigned *)query->data,
2364 .private_data = &fd,
2365 .max_size_handler = pass_buffer_as_shm
2369 char *source_path = (char *)query->data + sizeof(cad.flags);
2370 struct pattern_match_data pmd = {
2371 .table = audio_file_table,
2372 .loop_col_num = AFTCOL_HASH,
2373 .match_col_num = AFTCOL_PATH,
2374 .patterns = {.data = source_path + strlen(source_path) + 1,
2375 .size = query->size - sizeof(cad.flags)
2376 - strlen(source_path) - 1},
2378 .action = copy_selector_info
2381 ret = get_afsi_of_path(source_path, &cad.source_afsi);
2384 ret = for_each_matching_row(&pmd);
2387 para_printf(&cad.pb, "%s\n", para_strerror(-ret));
2388 else if (cad.flags & CPSI_FLAG_VERBOSE) {
2390 para_printf(&cad.pb, "copied requested afsi from %s "
2391 "to %u files\n", source_path, cad.num_copied);
2393 para_printf(&cad.pb, "nothing copied\n");
2396 pass_buffer_as_shm(cad.pb.buf, cad.pb.offset, &fd);
2400 int com_cpsi(struct rc4_context *rc4c, int argc, char * const * const argv)
2404 struct osl_object options = {.data = &flags, .size = sizeof(flags)};
2406 for (i = 1; i < argc; i++) {
2407 const char *arg = argv[i];
2410 if (!strcmp(arg, "--")) {
2414 if (!strcmp(arg, "-y")) {
2415 flags |= CPSI_FLAG_COPY_LYRICS_ID;
2418 if (!strcmp(arg, "-i")) {
2419 flags |= CPSI_FLAG_COPY_IMAGE_ID;
2422 if (!strcmp(arg, "-l")) {
2423 flags |= CPSI_FLAG_COPY_LASTPLAYED;
2426 if (!strcmp(arg, "-n")) {
2427 flags |= CPSI_FLAG_COPY_NUMPLAYED;
2430 if (!strcmp(arg, "-a")) {
2431 flags |= CPSI_FLAG_COPY_ATTRIBUTES;
2434 if (!strcmp(arg, "-v")) {
2435 flags |= CPSI_FLAG_VERBOSE;
2440 if (i + 1 >= argc) /* need at least source file and pattern */
2441 return -E_AFT_SYNTAX;
2442 if (!(flags & ~CPSI_FLAG_VERBOSE)) /* no copy flags given */
2443 flags = ~(unsigned)CPSI_FLAG_VERBOSE | flags;
2444 ret = send_option_arg_callback_request(&options, argc - i, argv + i,
2445 com_cpsi_callback, rc4_send_result, rc4c);
2447 rc4_send_va_buffer(rc4c, "%s\n", para_strerror(-ret));
2451 static void afs_stat_callback(int fd, const struct osl_object *query)
2453 int *parser_friendly = query->data;
2454 char *buf = *parser_friendly?
2455 parser_friendly_status_items : status_items;
2459 pass_buffer_as_shm(buf, strlen(buf), &fd);
2463 * Get the current afs status items from the afs process and send it using RC4.
2465 * \param rc4c The rc4 context for data encryption.
2466 * \param parser_friendly Whether parser-friendly output format should be used.
2468 * As the contents of the afs status items change in time and the command
2469 * handler only has a COW version created at fork time, it can not send
2470 * up-to-date afs status items directly. Therefore the usual callback mechanism
2471 * is used to pass the status items from the afs process to the command handler
2472 * via a shared memory area and a pipe.
2474 int send_afs_status(struct rc4_context *rc4c, int parser_friendly)
2476 struct osl_object query = {.data = &parser_friendly,
2477 .size = sizeof(parser_friendly)};
2479 return send_callback_request(afs_stat_callback, &query, rc4_send_result, rc4c);
2482 /* TODO: optionally fix problems by removing offending rows */
2483 static int check_audio_file(struct osl_row *row, void *data)
2486 struct para_buffer *pb = data;
2487 struct stat statbuf;
2488 int ret = get_audio_file_path_of_row(row, &path);
2489 struct afs_info afsi;
2493 return para_printf(pb, "%s\n", para_strerror(-ret));
2494 if (stat(path, &statbuf) < 0) {
2495 ret = para_printf(pb, "%s: stat error (%s)\n", path, strerror(errno));
2499 if (!S_ISREG(statbuf.st_mode)) {
2500 ret = para_printf(pb, "%s: not a regular file\n", path);
2505 ret = get_afsi_of_row(row, &afsi);
2507 return para_printf(pb, "%s: %s\n", path, para_strerror(-ret));
2508 ret = lyr_get_name_by_id(afsi.lyrics_id, &blob_name);
2510 ret = para_printf(pb, "%s lyrics id %u: %s\n", path, afsi.lyrics_id,
2511 para_strerror(-ret));
2515 ret = img_get_name_by_id(afsi.image_id, &blob_name);
2517 ret = para_printf(pb, "%s image id %u: %s\n", path, afsi.image_id,
2518 para_strerror(-ret));
2523 * Check the audio file table for inconsistencies.
2525 * \param fd The afs socket.
2526 * \param query Unused.
2528 * This function always succeeds.
2532 void aft_check_callback(int fd, __a_unused const struct osl_object *query)
2534 struct para_buffer pb = {
2536 .private_data = &fd,
2537 .max_size_handler = pass_buffer_as_shm
2539 int ret = para_printf(&pb, "checking audio file table...\n");
2543 audio_file_loop(&pb, check_audio_file);
2545 pass_buffer_as_shm(pb.buf, pb.offset, &fd);
2550 * Close the audio file table.
2552 * \param flags Usual flags that are passed to osl_close_table().
2554 * \sa osl_close_table().
2556 static void aft_close(void)
2558 osl_close_table(audio_file_table, OSL_MARK_CLEAN);
2559 audio_file_table = NULL;
2561 status_items = NULL;
2562 free(parser_friendly_status_items);
2563 parser_friendly_status_items = NULL;
2567 * Open the audio file table.
2569 * \param dir The database directory.
2573 * \sa osl_open_table().
2575 static int aft_open(const char *dir)
2579 audio_file_table_desc.dir = dir;
2580 ret = osl(osl_open_table(&audio_file_table_desc, &audio_file_table));
2583 osl_get_num_rows(audio_file_table, &num);
2584 PARA_INFO_LOG("audio file table contains %d files\n", num);
2587 PARA_INFO_LOG("failed to open audio file table\n");
2588 audio_file_table = NULL;
2589 if (ret >= 0 || ret == -OSL_ERRNO_TO_PARA_ERROR(E_OSL_NOENT))
2594 static int aft_create(const char *dir)
2596 audio_file_table_desc.dir = dir;
2597 return osl(osl_create_table(&audio_file_table_desc));
2600 static int clear_attribute(struct osl_row *row, void *data)
2602 struct rmatt_event_data *red = data;
2603 struct afs_info afsi;
2604 struct osl_object obj;
2605 int ret = get_afsi_object_of_row(row, &obj);
2606 uint64_t mask = ~(1ULL << red->bitnum);
2610 ret = load_afsi(&afsi, &obj);
2613 afsi.attributes &= mask;
2614 save_afsi(&afsi, &obj);
2618 static int aft_event_handler(enum afs_events event, struct para_buffer *pb,
2624 case ATTRIBUTE_REMOVE: {
2625 const struct rmatt_event_data *red = data;
2626 ret = para_printf(pb, "clearing attribute %s (bit %u) from all "
2627 "entries in the audio file table\n", red->name,
2631 return audio_file_loop(data, clear_attribute);
2639 * Initialize the audio file table.
2641 * \param t Pointer to the structure to be initialized.
2643 void aft_init(struct afs_table *t)
2646 t->close = aft_close;
2647 t->create = aft_create;
2648 t->event_handler = aft_event_handler;