2 * Copyright (C) 2007 Andre Noll <maan@systemlinux.org>
4 * Licensed under the GPL v2. For licencing details see COPYING.
7 /** \file aft.c Audio file table functions. */
9 #include <dirent.h> /* readdir() */
22 static struct osl_table *audio_file_table;
24 /** The different sorting methods of the ls command. */
25 enum ls_sorting_method {
31 LS_SORT_BY_LAST_PLAYED,
33 LS_SORT_BY_NUM_PLAYED,
47 LS_SORT_BY_AUDIO_FORMAT,
52 /** The different listing modes of the ls command. */
53 enum ls_listing_mode {
54 /** Default listing mode. */
64 /** The flags accepted by the ls command. */
67 LS_FLAG_FULL_PATH = 1,
69 LS_FLAG_ADMISSIBLE_ONLY = 2,
75 * The size of the individual output fields of the ls command.
77 * These depend on the actual content being listed. If, for instance only files
78 * with duration less than an hour are being listed, then the duration with is
79 * made smaller because then the duration is listed as mm:ss rather than
83 /** size of the score field. */
84 unsigned short score_width;
85 /** size of the image id field. */
86 unsigned short image_id_width;
87 /** size of the lyrics id field. */
88 unsigned short lyrics_id_width;
89 /** size of the bitrate field. */
90 unsigned short bitrate_width;
91 /** size of the frequency field. */
92 unsigned short frequency_width;
93 /** size of the duration field. */
94 unsigned short duration_width;
95 /** size of the num played field. */
96 unsigned short num_played_width;
99 /** Data passed to the different compare functions (called by qsort()). */
101 /** Usual audio format handler information. */
102 struct afh_info afhi;
103 /** Audio file selector information. */
104 struct afs_info afsi;
105 /** The full path of the audio file. */
107 /** The score value (if -a was given). */
109 /** The sha1 hash of audio file. */
113 /** Data passed from the ls command handler to its callback function. */
115 /** The given command line flags. */
117 /** The sorting method given at the command line. */
118 enum ls_sorting_method sorting;
119 /** The given listing mode (short, long, verbose, mbox). */
120 enum ls_listing_mode mode;
121 /** The arguments passed to the ls command. */
123 /** Number of non-option arguments. */
125 /** Used for long listing mode to align the output fields. */
126 struct ls_widths widths;
127 /** Size of the \a data array. */
129 /** Number of used entries in the data array. */
130 uint32_t num_matching_paths;
131 /** Array of matching entries. */
132 struct ls_data *data;
133 /** Used to sort the array. */
134 struct ls_data **data_ptr;
138 * Describes the layout of the mmapped-afs info struct.
140 * \sa struct afs_info.
143 /** Where .last_played is stored. */
144 AFSI_LAST_PLAYED_OFFSET = 0,
145 /** Storage position of the attributes bitmap. */
146 AFSI_ATTRIBUTES_OFFSET = 8,
147 /** Storage position of the .num_played field. */
148 AFSI_NUM_PLAYED_OFFSET = 16,
149 /** Storage position of the .image_id field. */
150 AFSI_IMAGE_ID_OFFSET = 20,
151 /** Storage position of the .lyrics_id field. */
152 AFSI_LYRICS_ID_OFFSET = 24,
153 /** Storage position of the .audio_format_id field. */
154 AFSI_AUDIO_FORMAT_ID_OFFSET = 28,
155 /** 3 bytes reserved space for future usage. */
156 AFSI_AUDIO_FORMAT_UNUSED_OFFSET = 29,
157 /** On-disk storage space needed. */
162 * Convert a struct afs_info to an osl object.
164 * \param afsi Pointer to the audio file info to be converted.
165 * \param obj Result pointer.
169 void save_afsi(struct afs_info *afsi, struct osl_object *obj)
171 char *buf = obj->data;
173 write_u64(buf + AFSI_LAST_PLAYED_OFFSET, afsi->last_played);
174 write_u64(buf + AFSI_ATTRIBUTES_OFFSET, afsi->attributes);
175 write_u32(buf + AFSI_NUM_PLAYED_OFFSET, afsi->num_played);
176 write_u32(buf + AFSI_IMAGE_ID_OFFSET, afsi->image_id);
177 write_u32(buf + AFSI_LYRICS_ID_OFFSET, afsi->lyrics_id);
178 write_u8(buf + AFSI_AUDIO_FORMAT_ID_OFFSET,
179 afsi->audio_format_id);
180 memset(buf + AFSI_AUDIO_FORMAT_UNUSED_OFFSET, 0, 3);
184 * Get the audio file selector info struct stored in an osl object.
186 * \param afsi Points to the audio_file info structure to be filled in.
187 * \param obj The osl object holding the data.
189 * \return Positive on success, negative on errors. Possible errors: \p E_BAD_AFS.
193 int load_afsi(struct afs_info *afsi, struct osl_object *obj)
195 char *buf = obj->data;
196 if (obj->size < AFSI_SIZE)
198 afsi->last_played = read_u64(buf + AFSI_LAST_PLAYED_OFFSET);
199 afsi->attributes = read_u64(buf + AFSI_ATTRIBUTES_OFFSET);
200 afsi->num_played = read_u32(buf + AFSI_NUM_PLAYED_OFFSET);
201 afsi->image_id = read_u32(buf + AFSI_IMAGE_ID_OFFSET);
202 afsi->lyrics_id = read_u32(buf + AFSI_LYRICS_ID_OFFSET);
203 afsi->audio_format_id = read_u8(buf +
204 AFSI_AUDIO_FORMAT_ID_OFFSET);
208 /** The columns of the audio file table. */
209 enum audio_file_table_columns {
210 /** The hash on the content of the audio file. */
212 /** The full path in the filesystem. */
214 /** The audio file selector info. */
216 /** The audio format handler info. */
218 /** The chunk table info and the chunk table of the audio file. */
220 /** The number of columns of this table. */
224 static struct osl_column_description aft_cols[] = {
226 .storage_type = OSL_MAPPED_STORAGE,
227 .storage_flags = OSL_RBTREE | OSL_FIXED_SIZE | OSL_UNIQUE,
229 .compare_function = osl_hash_compare,
230 .data_size = HASH_SIZE
233 .storage_type = OSL_MAPPED_STORAGE,
234 .storage_flags = OSL_RBTREE | OSL_UNIQUE,
236 .compare_function = string_compare,
239 .storage_type = OSL_MAPPED_STORAGE,
240 .storage_flags = OSL_FIXED_SIZE,
242 .data_size = AFSI_SIZE
245 .storage_type = OSL_MAPPED_STORAGE,
249 .storage_type = OSL_DISK_STORAGE,
254 static struct osl_table_description audio_file_table_desc = {
255 .name = "audio_files",
256 .num_columns = NUM_AFT_COLUMNS,
257 .flags = OSL_LARGE_TABLE,
258 .column_descriptions = aft_cols
261 /* We don't want * dot or dot-dot anywhere. */
262 static int verify_dotfile(const char *rest)
265 * The first character was '.', but that has already been discarded, we
269 case '\0': case '/': /* /foo/. and /foo/./bar are not ok */
271 case '.': /* path start with /foo/.. */
272 if (rest[1] == '\0' || rest[1] == '/')
273 return -1; /* /foo/.. or /foo/../bar are not ok */
274 /* /foo/..bar is ok */
280 * We fundamentally don't like some paths: We don't want double slashes or
281 * slashes at the end that can make pathnames ambiguous.
283 static int verify_path(const char *orig_path, char **resolved_path)
289 if (*orig_path != '/') /* we only accept absolute paths */
291 len = strlen(orig_path);
292 *resolved_path = para_strdup(orig_path);
293 path = *resolved_path;
294 while (len > 1 && path[--len] == '/')
295 path[len] = '\0'; /* remove slash at the end */
301 case '/': /* double slash */
304 if (verify_dotfile(path) < 0)
314 free(*resolved_path);
318 /** The on-disk layout of a afhi struct. */
320 /** Where the number of seconds is stored. */
321 AFHI_SECONDS_TOTAL_OFFSET = 0,
322 /** Position of the bitrate. */
323 AFHI_BITRATE_OFFSET = 4,
324 /** Position of the frequency. */
325 AFHI_FREQUENCY_OFFSET = 8,
326 /** Number of channels is stored here. */
327 AFHI_CHANNELS_OFFSET = 12,
328 /** The tag info position. */
329 AFHI_INFO_STRING_OFFSET = 13,
330 /** Minimal on-disk size of a valid afhi struct. */
334 static unsigned sizeof_afhi_buf(const struct afh_info *afhi)
338 return strlen(afhi->info_string) + MIN_AFHI_SIZE;
341 static void save_afhi(struct afh_info *afhi, char *buf)
345 write_u32(buf + AFHI_SECONDS_TOTAL_OFFSET,
346 afhi->seconds_total);
347 write_u32(buf + AFHI_BITRATE_OFFSET, afhi->bitrate);
348 write_u32(buf + AFHI_FREQUENCY_OFFSET, afhi->frequency);
349 write_u8(buf + AFHI_CHANNELS_OFFSET, afhi->channels);
350 strcpy(buf + AFHI_INFO_STRING_OFFSET, afhi->info_string); /* OK */
351 PARA_DEBUG_LOG("last byte written: %p\n", buf + AFHI_INFO_STRING_OFFSET + strlen(afhi->info_string));
354 static void load_afhi(const char *buf, struct afh_info *afhi)
356 afhi->seconds_total = read_u32(buf + AFHI_SECONDS_TOTAL_OFFSET);
357 afhi->bitrate = read_u32(buf + AFHI_BITRATE_OFFSET);
358 afhi->frequency = read_u32(buf + AFHI_FREQUENCY_OFFSET);
359 afhi->channels = read_u8(buf + AFHI_CHANNELS_OFFSET);
360 strcpy(afhi->info_string, buf + AFHI_INFO_STRING_OFFSET);
363 //#define SIZEOF_CHUNK_TABLE(afhi) (((afhi)->chunks_total + 1) * sizeof(uint32_t))
365 static unsigned sizeof_chunk_info_buf(struct afh_info *afhi)
369 return 4 * (afhi->chunks_total + 1) + 20;
373 /** The offsets of the data contained in the AFTCOL_CHUNKS column. */
374 enum chunk_info_offsets{
375 /** The total number of chunks (4 bytes). */
376 CHUNKS_TOTAL_OFFSET = 0,
377 /** The length of the audio file header (4 bytes). */
378 HEADER_LEN_OFFSET = 4,
379 /** The start of the audio file header (4 bytes). */
380 HEADER_OFFSET_OFFSET = 8,
381 /** The seconds part of the chunk time (4 bytes). */
382 CHUNK_TV_TV_SEC_OFFSET = 12,
383 /** The microseconds part of the chunk time (4 bytes). */
384 CHUNK_TV_TV_USEC = 16,
385 /** Chunk table entries start here. */
386 CHUNK_TABLE_OFFSET = 20,
389 static void save_chunk_table(struct afh_info *afhi, char *buf)
393 PARA_DEBUG_LOG("%lu chunks\n", afhi->chunks_total);
394 for (i = 0; i <= afhi->chunks_total; i++)
395 write_u32(buf + 4 * i, afhi->chunk_table[i]);
398 static void load_chunk_table(struct afh_info *afhi, char *buf)
401 for (i = 0; i <= afhi->chunks_total; i++)
402 afhi->chunk_table[i] = read_u32(buf + 4 * i);
405 /* TODO: audio format handlers could just produce this */
406 static void save_chunk_info(struct afh_info *afhi, char *buf)
410 write_u32(buf + CHUNKS_TOTAL_OFFSET, afhi->chunks_total);
411 write_u32(buf + HEADER_LEN_OFFSET, afhi->header_len);
412 write_u32(buf + HEADER_OFFSET_OFFSET, afhi->header_offset);
413 write_u32(buf + CHUNK_TV_TV_SEC_OFFSET, afhi->chunk_tv.tv_sec);
414 write_u32(buf + CHUNK_TV_TV_USEC, afhi->chunk_tv.tv_usec);
415 save_chunk_table(afhi, buf + CHUNK_TABLE_OFFSET);
418 static int load_chunk_info(struct osl_object *obj, struct afh_info *afhi)
420 char *buf = obj->data;
422 if (obj->size < CHUNK_TABLE_OFFSET)
423 return -E_BAD_DATA_SIZE;
425 afhi->chunks_total = read_u32(buf + CHUNKS_TOTAL_OFFSET);
426 afhi->header_len = read_u32(buf + HEADER_LEN_OFFSET);
427 afhi->header_offset = read_u32(buf + HEADER_OFFSET_OFFSET);
428 afhi->chunk_tv.tv_sec = read_u32(buf + CHUNK_TV_TV_SEC_OFFSET);
429 afhi->chunk_tv.tv_usec = read_u32(buf + CHUNK_TV_TV_USEC);
431 if ((afhi->chunks_total + 1) * 4 + CHUNK_TABLE_OFFSET > obj->size)
432 return -E_BAD_DATA_SIZE;
433 afhi->chunk_table = para_malloc((afhi->chunks_total + 1) * 4);
434 load_chunk_table(afhi, buf + CHUNK_TABLE_OFFSET);
439 * Get the row of the audio file table corresponding to the given path.
441 * \param path The full path of the audio file.
442 * \param row Result pointer.
444 * \return The return value of the underlying call to osl_get_row().
446 int aft_get_row_of_path(const char *path, struct osl_row **row)
448 struct osl_object obj = {.data = (char *)path, .size = strlen(path) + 1};
450 return osl_get_row(audio_file_table, AFTCOL_PATH, &obj, row);
454 * Get the row of the audio file table corresponding to the given hash value.
456 * \param hash The hash value of the desired audio file.
457 * \param row resul pointer.
459 * \return The return value of the underlying call to osl_get_row().
461 int aft_get_row_of_hash(HASH_TYPE *hash, struct osl_row **row)
463 const struct osl_object obj = {.data = hash, .size = HASH_SIZE};
464 return osl_get_row(audio_file_table, AFTCOL_HASH, &obj, row);
468 * Get the osl object holding the audio file selector info of a row.
470 * \param row Pointer to a row in the audio file table.
471 * \param obj Result pointer.
473 * \return The return value of the underlying call to osl_get_object().
475 int get_afsi_object_of_row(const struct osl_row *row, struct osl_object *obj)
477 return osl_get_object(audio_file_table, row, AFTCOL_AFSI, obj);
481 * Get the osl object holding the audio file selector info, given a path.
484 * \param path The full path of the audio file.
485 * \param obj Result pointer.
487 * \return Positive on success, negative on errors.
489 int get_afsi_object_of_path(const char *path, struct osl_object *obj)
492 int ret = aft_get_row_of_path(path, &row);
495 return get_afsi_object_of_row(row, obj);
499 * Get the audio file selector info, given a row of the audio file table.
501 * \param row Pointer to a row in the audio file table.
502 * \param afsi Result pointer.
504 * \return Positive on success, negative on errors.
506 int get_afsi_of_row(const struct osl_row *row, struct afs_info *afsi)
508 struct osl_object obj;
509 int ret = get_afsi_object_of_row(row, &obj);
512 return load_afsi(afsi, &obj);
516 * Get the audio file selector info, given the path of an audio table.
518 * \param path The full path of the audio file.
519 * \param afsi Result pointer.
521 * \return Positive on success, negative on errors.
523 int get_afsi_of_path(const char *path, struct afs_info *afsi)
525 struct osl_object obj;
526 int ret = get_afsi_object_of_path(path, &obj);
529 return load_afsi(afsi, &obj);
533 * Get the path of an audio file, given a row of the audio file table.
535 * \param row Pointer to a row in the audio file table.
536 * \param path Result pointer.
538 * The result is a pointer to mmapped data. The caller must not attempt
543 int get_audio_file_path_of_row(const struct osl_row *row, char **path)
545 struct osl_object path_obj;
546 int ret = osl_get_object(audio_file_table, row, AFTCOL_PATH,
550 *path = path_obj.data;
555 * Get the object containing the hash value of an audio file, given a row.
557 * \param row Pointer to a row of the audio file table.
558 * \param obj Result pointer.
560 * \return The return value of the underlying call to osl_get_object().
562 * \sa get_hash_of_row().
564 static int get_hash_object_of_aft_row(const struct osl_row *row, struct osl_object *obj)
566 return osl_get_object(audio_file_table, row, AFTCOL_HASH, obj);
570 * Get the hash value of an audio file, given a row of the audio file table.
572 * \param row Pointer to a row of the audio file table.
573 * \param hash Result pointer.
575 * \a hash points to mapped data and must not be freed by the caller.
577 * \return The return value of the underlying call to
578 * get_hash_object_of_aft_row().
580 static int get_hash_of_row(const struct osl_row *row, HASH_TYPE **hash)
582 struct osl_object obj;
583 int ret = get_hash_object_of_aft_row(row, &obj);
592 * Get the audio format handler info, given a row of the audio file table.
594 * \param row Pointer to a row of the audio file table.
595 * \param afhi Result pointer.
597 * \return The return value of the underlying call to osl_get_object().
599 * \sa get_chunk_table_of_row().
601 int get_afhi_of_row(const struct osl_row *row, struct afh_info *afhi)
603 struct osl_object obj;
604 int ret = osl_get_object(audio_file_table, row, AFTCOL_AFHI,
608 load_afhi(obj.data, afhi);
612 /* returns shmid on success */
613 static int save_afd(struct audio_file_data *afd)
615 size_t size = sizeof(*afd)
616 + 4 * (afd->afhi.chunks_total + 1);
618 PARA_DEBUG_LOG("size: %zu\n", size);
619 int shmid, ret = shm_new(size);
626 ret = shm_attach(shmid, ATTACH_RW, &shm_afd);
629 *(struct audio_file_data *)shm_afd = *afd;
632 save_chunk_table(&afd->afhi, buf);
640 int load_afd(int shmid, struct audio_file_data *afd)
646 ret = shm_attach(shmid, ATTACH_RO, &shm_afd);
649 *afd = *(struct audio_file_data *)shm_afd;
652 afd->afhi.chunk_table = para_malloc((afd->afhi.chunks_total + 1) * 4);
653 load_chunk_table(&afd->afhi, buf);
659 * Mmap the given audio file and update statistics.
661 * \param aft_row Determines the audio file to be opened and updated.
662 * \param afd Result pointer.
664 * On success, the numplayed field of the audio file selector info is increased
665 * and the lastplayed time is set to the current time. Finally, the score of
666 * the audio file is updated.
668 * \return Positive on success, negative on errors.
670 int open_and_update_audio_file(struct osl_row *aft_row, struct audio_file_data *afd)
672 HASH_TYPE *aft_hash, file_hash[HASH_SIZE];
673 struct osl_object afsi_obj;
674 struct afs_info new_afsi;
675 int ret = get_hash_of_row(aft_row, &aft_hash);
676 struct afsi_change_event_data aced;
677 struct osl_object map, chunk_table_obj;
682 ret = get_audio_file_path_of_row(aft_row, &path);
685 strncpy(afd->path, path, sizeof(afd->path) - 1);
686 afd->path[sizeof(afd->path) - 1] = '\0';
687 ret = get_afsi_object_of_row(aft_row, &afsi_obj);
690 ret = load_afsi(&afd->afsi, &afsi_obj);
693 ret = get_afhi_of_row(aft_row, &afd->afhi);
696 ret = osl_open_disk_object(audio_file_table, aft_row,
697 AFTCOL_CHUNKS, &chunk_table_obj);
700 ret = mmap_full_file(path, O_RDONLY, &map.data,
701 &map.size, &afd->fd);
704 hash_function(map.data, map.size, file_hash);
705 ret = hash_compare(file_hash, aft_hash);
706 para_munmap(map.data, map.size);
708 ret = -E_HASH_MISMATCH;
711 new_afsi = afd->afsi;
712 new_afsi.num_played++;
713 new_afsi.last_played = time(NULL);
714 save_afsi(&new_afsi, &afsi_obj); /* in-place update */
716 ret = load_chunk_info(&chunk_table_obj, &afd->afhi);
719 ret = get_attribute_text(&afd->afsi.attributes, " ", &tmp);
722 tmp[sizeof(afd->attributes_string) - 1] = '\0';
723 strcpy(afd->attributes_string, tmp); /* OK */
726 aced.aft_row = aft_row;
727 aced.old_afsi = &afd->afsi;
728 afs_event(AFSI_CHANGE, NULL, &aced);
732 free(afd->afhi.chunk_table);
734 osl_close_disk_object(&chunk_table_obj);
738 static int get_local_time(uint64_t *seconds, char *buf, size_t size,
739 time_t current_time, enum ls_listing_mode lm)
743 if (!localtime_r((time_t *)seconds, &t))
745 if (lm == LS_MODE_MBOX) {
746 if (!strftime(buf, size, "%c", &t))
750 if (*seconds + 6 * 30 * 24 * 3600 > current_time) {
751 if (!strftime(buf, size, "%b %e %k:%M", &t))
755 if (!strftime(buf, size, "%b %e %Y", &t))
760 /** Compute the number of (decimal) digits of a number. */
761 #define GET_NUM_DIGITS(x, num) { \
762 typeof((x)) _tmp = PARA_ABS(x); \
765 while ((_tmp) > 9) { \
771 static short unsigned get_duration_width(int seconds)
773 short unsigned width;
774 unsigned hours = seconds / 3600, mins = (seconds % 3600) / 60;
776 if (!hours) /* less than one hour => m:ss or mm:ss => 4 or 5 digits */
777 return 4 + (mins > 9);
778 /* more than one hour => h:mm:ss, hh:mm:ss, hhh:mm:ss, ... */
779 GET_NUM_DIGITS(hours, &width);
783 static void get_duration_buf(int seconds, char *buf, short unsigned max_width)
785 unsigned hours = seconds / 3600, mins = (seconds % 3600) / 60;
787 if (!hours) /* m:ss or mm:ss */
788 sprintf(buf, "%*u:%02u", max_width - 3, mins, seconds % 60);
789 else /* more than one hour => h:mm:ss, hh:mm:ss, hhh:mm:ss, ... */
790 sprintf(buf, "%*u:%02u:%02u", max_width - 6, hours, mins,
794 static char *make_attribute_lines(const char *att_bitmap, struct afs_info *afsi)
796 char *att_text, *att_lines;
798 get_attribute_text(&afsi->attributes, " ", &att_text);
800 return para_strdup(att_bitmap);
801 att_lines = make_message("%s\nattributes_txt: %s",
802 att_bitmap, att_text);
807 static char *make_lyrics_line(struct afs_info *afsi)
811 lyr_get_name_by_id(afsi->lyrics_id, &lyrics_name);
813 return make_message("%u", afsi->lyrics_id);
814 return make_message("%u (%s)", afsi->lyrics_id, lyrics_name);
817 static char *make_image_line(struct afs_info *afsi)
820 img_get_name_by_id(afsi->image_id, &image_name);
822 return make_message("%u", afsi->image_id);
823 return make_message("%u (%s)", afsi->image_id, image_name);
826 static int print_list_item(struct ls_data *d, struct ls_options *opts,
827 struct para_buffer *b, time_t current_time)
831 char last_played_time[30];
832 char duration_buf[30]; /* nobody has an audio file long enough to overflow this */
833 char score_buf[30] = "";
834 struct afs_info *afsi = &d->afsi;
835 struct afh_info *afhi = &d->afhi;
836 struct ls_widths *w = &opts->widths;
837 int have_score = opts->flags & LS_FLAG_ADMISSIBLE_ONLY;
838 char asc_hash[2 * HASH_SIZE + 1];
839 char *att_lines, *lyrics_line, *image_line;
841 if (opts->mode == LS_MODE_SHORT) {
842 para_printf(b, "%s\n", d->path);
845 get_attribute_bitmap(&afsi->attributes, att_buf);
846 ret = get_local_time(&afsi->last_played, last_played_time,
847 sizeof(last_played_time), current_time, opts->mode);
850 get_duration_buf(afhi->seconds_total, duration_buf, w->duration_width);
852 if (opts->mode == LS_MODE_LONG)
853 sprintf(score_buf, "%*li ", w->score_width, d->score);
855 sprintf(score_buf, "%li ", d->score);
858 if (opts->mode == LS_MODE_LONG) {
861 "%s " /* attributes */
862 "%*d " /* image_id */
863 "%*d " /* lyrics_id */
865 "%s " /* audio format */
866 "%*d " /* frequency */
869 "%*d " /* num_played */
870 "%s " /* last_played */
874 w->image_id_width, afsi->image_id,
875 w->lyrics_id_width, afsi->lyrics_id,
876 w->bitrate_width, afhi->bitrate,
877 audio_format_name(afsi->audio_format_id),
878 w->frequency_width, afhi->frequency,
881 w->num_played_width, afsi->num_played,
887 hash_to_asc(d->hash, asc_hash);
888 att_lines = make_attribute_lines(att_buf, afsi);
889 lyrics_line = make_lyrics_line(afsi);
890 image_line = make_image_line(afsi);
891 /* TODO: Merge this with status items */
892 if (opts->mode == LS_MODE_VERBOSE) {
894 "%s: %s\n" /* path */
900 "bitrate: %dkbit/s\n"
908 (opts->flags & LS_FLAG_FULL_PATH)?
909 "path" : "file", d->path,
910 have_score? "score: " : "", score_buf,
911 have_score? "\n" : "",
917 audio_format_name(afsi->audio_format_id),
925 } else { /* mbox mode */
926 struct osl_object lyrics_def;
927 lyr_get_def_by_id(afsi->lyrics_id, &lyrics_def);
929 "From foo@localhost %s\n"
930 "Received: from\nTo: bar\nFrom: a\n"
931 "Subject: %s\n\n" /* path */
937 "bitrate: %dkbit/s\n"
947 have_score? "score: " : "", score_buf,
948 have_score? "\n" : "",
954 audio_format_name(afsi->audio_format_id),
960 lyrics_def.data? "Lyrics:\n~~~~~~~\n" : "",
961 lyrics_def.data? (char *)lyrics_def.data : ""
964 osl_close_disk_object(lyrics_def.data);
972 static int ls_audio_format_compare(const void *a, const void *b)
974 struct ls_data *d1 = *(struct ls_data **)a, *d2 = *(struct ls_data **)b;
975 return NUM_COMPARE(d1->afsi.audio_format_id, d2->afsi.audio_format_id);
978 static int ls_duration_compare(const void *a, const void *b)
980 struct ls_data *d1 = *(struct ls_data **)a, *d2 = *(struct ls_data **)b;
981 return NUM_COMPARE(d1->afhi.seconds_total, d2->afhi.seconds_total);
984 static int ls_bitrate_compare(const void *a, const void *b)
986 struct ls_data *d1 = *(struct ls_data **)a, *d2 = *(struct ls_data **)b;
987 return NUM_COMPARE(d1->afhi.bitrate, d2->afhi.bitrate);
990 static int ls_lyrics_id_compare(const void *a, const void *b)
992 struct ls_data *d1 = *(struct ls_data **)a, *d2 = *(struct ls_data **)b;
993 return NUM_COMPARE(d1->afsi.lyrics_id, d2->afsi.lyrics_id);
996 static int ls_image_id_compare(const void *a, const void *b)
998 struct ls_data *d1 = *(struct ls_data **)a, *d2 = *(struct ls_data **)b;
999 return NUM_COMPARE(d1->afsi.image_id, d2->afsi.image_id);
1002 static int ls_channels_compare(const void *a, const void *b)
1004 struct ls_data *d1 = *(struct ls_data **)a, *d2 = *(struct ls_data **)b;
1005 return NUM_COMPARE(d1->afhi.channels, d2->afhi.channels);
1008 static int ls_frequency_compare(const void *a, const void *b)
1010 struct ls_data *d1 = *(struct ls_data **)a, *d2 = *(struct ls_data **)b;
1011 return NUM_COMPARE(d1->afhi.frequency, d2->afhi.frequency);
1014 static int ls_num_played_compare(const void *a, const void *b)
1016 struct ls_data *d1 = *(struct ls_data **)a, *d2 = *(struct ls_data **)b;
1017 return NUM_COMPARE(d1->afsi.num_played, d2->afsi.num_played);
1020 static int ls_last_played_compare(const void *a, const void *b)
1022 struct ls_data *d1 = *(struct ls_data **)a, *d2 = *(struct ls_data **)b;
1023 return NUM_COMPARE(d1->afsi.last_played, d2->afsi.last_played);
1026 static int ls_score_compare(const void *a, const void *b)
1028 struct ls_data *d1 = *(struct ls_data **)a, *d2 = *(struct ls_data **)b;
1029 return NUM_COMPARE(d1->score, d2->score);
1032 static int ls_path_compare(const void *a, const void *b)
1034 struct ls_data *d1 = *(struct ls_data **)a, *d2 = *(struct ls_data **)b;
1035 return strcmp(d1->path, d2->path);
1038 static int sort_matching_paths(struct ls_options *options)
1040 size_t nmemb = options->num_matching_paths;
1041 size_t size = sizeof(*options->data_ptr);
1042 int (*compar)(const void *, const void *);
1045 options->data_ptr = para_malloc(nmemb * sizeof(*options->data_ptr));
1046 for (i = 0; i < nmemb; i++)
1047 options->data_ptr[i] = options->data + i;
1049 /* In these cases the array is already sorted */
1050 if (options->sorting == LS_SORT_BY_PATH
1051 && !(options->flags & LS_FLAG_ADMISSIBLE_ONLY)
1052 && (options->flags & LS_FLAG_FULL_PATH))
1054 if (options->sorting == LS_SORT_BY_SCORE &&
1055 options->flags & LS_FLAG_ADMISSIBLE_ONLY)
1058 switch (options->sorting) {
1059 case LS_SORT_BY_PATH:
1060 compar = ls_path_compare; break;
1061 case LS_SORT_BY_SCORE:
1062 compar = ls_score_compare; break;
1063 case LS_SORT_BY_LAST_PLAYED:
1064 compar = ls_last_played_compare; break;
1065 case LS_SORT_BY_NUM_PLAYED:
1066 compar = ls_num_played_compare; break;
1067 case LS_SORT_BY_FREQUENCY:
1068 compar = ls_frequency_compare; break;
1069 case LS_SORT_BY_CHANNELS:
1070 compar = ls_channels_compare; break;
1071 case LS_SORT_BY_IMAGE_ID:
1072 compar = ls_image_id_compare; break;
1073 case LS_SORT_BY_LYRICS_ID:
1074 compar = ls_lyrics_id_compare; break;
1075 case LS_SORT_BY_BITRATE:
1076 compar = ls_bitrate_compare; break;
1077 case LS_SORT_BY_DURATION:
1078 compar = ls_duration_compare; break;
1079 case LS_SORT_BY_AUDIO_FORMAT:
1080 compar = ls_audio_format_compare; break;
1084 qsort(options->data_ptr, nmemb, size, compar);
1088 /* row is either an aft_row or a row of the score table */
1089 /* TODO: Only compute widths if we need them */
1090 static int prepare_ls_row(struct osl_row *row, void *ls_opts)
1093 struct ls_options *options = ls_opts;
1095 struct ls_widths *w;
1096 unsigned short num_digits;
1098 struct osl_row *aft_row;
1102 if (options->flags & LS_FLAG_ADMISSIBLE_ONLY) {
1103 ret = get_score_and_aft_row(row, &score, &aft_row);
1108 ret = get_audio_file_path_of_row(aft_row, &path);
1111 if (!(options->flags & LS_FLAG_FULL_PATH)) {
1112 char *p = strrchr(path, '/');
1116 if (options->num_patterns) {
1117 for (i = 0; i < options->num_patterns; i++) {
1118 ret = fnmatch(options->patterns[i], path, 0);
1121 if (ret == FNM_NOMATCH)
1125 if (i >= options->num_patterns) /* no match */
1128 tmp = options->num_matching_paths++;
1129 if (options->num_matching_paths > options->array_size) {
1130 options->array_size++;
1131 options->array_size *= 2;
1132 options->data = para_realloc(options->data, options->array_size
1133 * sizeof(*options->data));
1135 d = options->data + tmp;
1136 ret = get_afsi_of_row(aft_row, &d->afsi);
1139 ret = get_afhi_of_row(aft_row, &d->afhi);
1143 ret = get_hash_of_row(aft_row, &d->hash);
1146 w = &options->widths;
1147 GET_NUM_DIGITS(d->afsi.image_id, &num_digits);
1148 w->image_id_width = PARA_MAX(w->image_id_width, num_digits);
1149 GET_NUM_DIGITS(d->afsi.lyrics_id, &num_digits);
1150 w->lyrics_id_width = PARA_MAX(w->lyrics_id_width, num_digits);
1151 GET_NUM_DIGITS(d->afhi.bitrate, &num_digits);
1152 w->bitrate_width = PARA_MAX(w->bitrate_width, num_digits);
1153 GET_NUM_DIGITS(d->afhi.frequency, &num_digits);
1154 w->frequency_width = PARA_MAX(w->frequency_width, num_digits);
1155 GET_NUM_DIGITS(d->afsi.num_played, &num_digits);
1156 w->num_played_width = PARA_MAX(w->num_played_width, num_digits);
1157 /* get the number of chars to print this amount of time */
1158 tmp = get_duration_width(d->afhi.seconds_total);
1159 w->duration_width = PARA_MAX(w->duration_width, tmp);
1160 if (options->flags & LS_FLAG_ADMISSIBLE_ONLY) {
1161 GET_NUM_DIGITS(score, &num_digits);
1162 num_digits++; /* add one for the sign (space or "-") */
1163 w->score_width = PARA_MAX(w->score_width, num_digits);
1169 static int com_ls_callback(const struct osl_object *query,
1170 struct osl_object *ls_output)
1172 struct ls_options *opts = query->data;
1173 char *p, *pattern_start = (char *)query->data + sizeof(*opts);
1174 struct para_buffer b = {.buf = NULL, .size = 0};
1176 time_t current_time;
1179 if (opts->num_patterns) {
1180 opts->patterns = para_malloc(opts->num_patterns * sizeof(char *));
1181 for (i = 0, p = pattern_start; i < opts->num_patterns; i++) {
1182 opts->patterns[i] = p;
1186 opts->patterns = NULL;
1187 if (opts->flags & LS_FLAG_ADMISSIBLE_ONLY)
1188 ret = admissible_file_loop(opts, prepare_ls_row);
1190 ret = osl_rbtree_loop(audio_file_table, AFTCOL_PATH, opts,
1194 ret = opts->num_patterns? -E_NO_MATCH : 0;
1195 if (!opts->num_matching_paths)
1197 ret = sort_matching_paths(opts);
1200 time(¤t_time);
1201 if (opts->flags & LS_FLAG_REVERSE)
1202 for (i = opts->num_matching_paths - 1; i >= 0; i--) {
1203 ret = print_list_item(opts->data_ptr[i], opts, &b, current_time);
1208 for (i = 0; i < opts->num_matching_paths; i++) {
1209 ret = print_list_item(opts->data_ptr[i], opts, &b, current_time);
1215 ls_output->data = b.buf;
1216 ls_output->size = b.size;
1218 free(opts->data_ptr);
1219 free(opts->patterns);
1224 * TODO: flags -h (sort by hash)
1226 int com_ls(int fd, int argc, char * const * const argv)
1230 enum ls_sorting_method sort = LS_SORT_BY_PATH;
1231 enum ls_listing_mode mode = LS_MODE_SHORT;
1232 struct ls_options opts = {.patterns = NULL};
1233 struct osl_object query = {.data = &opts, .size = sizeof(opts)},
1236 for (i = 1; i < argc; i++) {
1237 const char *arg = argv[i];
1240 if (!strcmp(arg, "--")) {
1244 if (!strncmp(arg, "-l", 2)) {
1246 mode = LS_MODE_LONG;
1250 return -E_AFT_SYNTAX;
1251 switch(*(arg + 2)) {
1253 mode = LS_MODE_SHORT;
1256 mode = LS_MODE_LONG;
1259 mode = LS_MODE_VERBOSE;
1262 mode = LS_MODE_MBOX;
1265 return -E_AFT_SYNTAX;
1268 if (!strcmp(arg, "-p")) {
1269 flags |= LS_FLAG_FULL_PATH;
1272 if (!strcmp(arg, "-a")) {
1273 flags |= LS_FLAG_ADMISSIBLE_ONLY;
1276 if (!strcmp(arg, "-r")) {
1277 flags |= LS_FLAG_REVERSE;
1280 if (!strncmp(arg, "-s", 2)) {
1281 if (!*(arg + 2) || *(arg + 3))
1282 return -E_AFT_SYNTAX;
1283 switch(*(arg + 2)) {
1285 sort = LS_SORT_BY_PATH;
1287 case 's': /* -ss implies -a */
1288 sort = LS_SORT_BY_SCORE;
1289 flags |= LS_FLAG_ADMISSIBLE_ONLY;
1292 sort = LS_SORT_BY_LAST_PLAYED;
1295 sort = LS_SORT_BY_NUM_PLAYED;
1298 sort = LS_SORT_BY_FREQUENCY;
1301 sort = LS_SORT_BY_CHANNELS;
1304 sort = LS_SORT_BY_IMAGE_ID;
1307 sort = LS_SORT_BY_LYRICS_ID;
1310 sort = LS_SORT_BY_BITRATE;
1313 sort = LS_SORT_BY_DURATION;
1316 sort = LS_SORT_BY_AUDIO_FORMAT;
1319 return -E_AFT_SYNTAX;
1322 return -E_AFT_SYNTAX;
1325 opts.sorting = sort;
1327 opts.num_patterns = argc - i;
1328 ret = send_option_arg_callback_request(&query, opts.num_patterns,
1329 argv + i, com_ls_callback, &ls_output);
1331 ret = send_buffer(fd, (char *)ls_output.data);
1332 free(ls_output.data);
1338 * Call the given function for each file in the audio file table.
1340 * \param private_data An arbitrary data pointer, passed to \a func.
1341 * \param func The custom function to be called.
1343 * \return The return value of the underlying call to osl_rbtree_loop().
1345 int audio_file_loop(void *private_data, osl_rbtree_loop_func *func)
1347 return osl_rbtree_loop(audio_file_table, AFTCOL_HASH, private_data,
1351 static struct osl_row *find_hash_sister(HASH_TYPE *hash)
1353 const struct osl_object obj = {.data = hash, .size = HASH_SIZE};
1354 struct osl_row *row;
1356 osl_get_row(audio_file_table, AFTCOL_HASH, &obj, &row);
1360 enum aft_row_offsets {
1361 AFTROW_AFHI_OFFSET_POS = 0,
1362 AFTROW_CHUNKS_OFFSET_POS = 2,
1363 AFTROW_AUDIO_FORMAT_OFFSET = 4,
1364 AFTROW_FLAGS_OFFSET = 5,
1365 AFTROW_HASH_OFFSET = 9,
1366 AFTROW_PATH_OFFSET = (AFTROW_HASH_OFFSET + HASH_SIZE),
1369 /* never save the afsi, as the server knows it too. Note that afhi might be NULL.
1370 * In this case, afhi won't be stored in the buffer */
1371 static void save_audio_file_info(HASH_TYPE *hash, const char *path,
1372 struct afh_info *afhi, uint32_t flags,
1373 uint8_t audio_format_num, struct osl_object *obj)
1375 size_t path_len = strlen(path) + 1;
1376 size_t afhi_size = sizeof_afhi_buf(afhi);
1377 size_t size = AFTROW_PATH_OFFSET + path_len + afhi_size
1378 + sizeof_chunk_info_buf(afhi);
1379 char *buf = para_malloc(size);
1382 write_u8(buf + AFTROW_AUDIO_FORMAT_OFFSET, audio_format_num);
1383 write_u32(buf + AFTROW_FLAGS_OFFSET, flags);
1385 memcpy(buf + AFTROW_HASH_OFFSET, hash, HASH_SIZE);
1386 strcpy(buf + AFTROW_PATH_OFFSET, path);
1388 pos = AFTROW_PATH_OFFSET + path_len;
1389 PARA_DEBUG_LOG("size: %zu, afhi starts at %d\n", size, pos);
1390 PARA_DEBUG_LOG("last afhi byte: %p, pos %zu\n", buf + pos + afhi_size - 1,
1391 pos + afhi_size - 1);
1392 write_u16(buf + AFTROW_AFHI_OFFSET_POS, pos);
1393 save_afhi(afhi, buf + pos);
1396 PARA_DEBUG_LOG("size: %zu, chunks start at %d\n", size, pos);
1397 write_u16(buf + AFTROW_CHUNKS_OFFSET_POS, pos);
1398 save_chunk_info(afhi, buf + pos);
1399 PARA_DEBUG_LOG("last byte in buf: %p\n", buf + size - 1);
1413 AFHI: whether afhi and chunk table are computed and sent
1414 ACTION: table modifications to be performed
1416 +---+----+-----+------+---------------------------------------------------+
1417 | HS | PB | F | AFHI | ACTION
1418 +---+----+-----+------+---------------------------------------------------+
1419 | Y | Y | Y | Y | if HS != PB: remove PB. HS: force afhi update,
1420 | | update path, keep afsi
1421 +---+----+-----+------+---------------------------------------------------+
1422 | Y | Y | N | N | if HS == PB: do not send callback request at all.
1423 | | otherwise: remove PB, HS: update path, keep afhi,
1425 +---+----+-----+------+---------------------------------------------------+
1426 | Y | N | Y | Y | (rename) force afhi update of HS, update path of
1428 +---+----+-----+------+---------------------------------------------------+
1429 | Y | N | N | N | (file rename) update path of HS, keep afsi, afhi
1430 +---+----+-----+------+---------------------------------------------------+
1431 | N | Y | Y | Y | (file change) update afhi, hash, of PB, keep afsi
1432 | | (force has no effect)
1433 +---+----+-----+------+---------------------------------------------------+
1434 | N | Y | N | Y | (file change) update afhi, hash of PB, keep afsi
1435 +---+----+-----+------+---------------------------------------------------+
1436 | N | N | Y | Y | (new file) create new entry (force has no effect)
1437 +---+----+-----+------+---------------------------------------------------+
1438 | N | N | N | Y | (new file) create new entry
1439 +---+----+-----+------+---------------------------------------------------+
1441 afhi <=> force or no HS
1445 /** Flags passed to the add command. */
1446 enum com_add_flags {
1447 /** Skip paths that exist already. */
1449 /** Force adding. */
1451 /** Print what is being done. */
1452 ADD_FLAG_VERBOSE = 4,
1453 /** Try to add files with unknown suffixes. */
1457 static int com_add_callback(const struct osl_object *query,
1458 struct osl_object *result)
1460 char *buf = query->data, *path;
1461 struct osl_row *pb, *aft_row;
1463 struct osl_object objs[NUM_AFT_COLUMNS];
1465 char asc[2 * HASH_SIZE + 1];
1467 char afsi_buf[AFSI_SIZE];
1468 uint32_t flags = read_u32(buf + AFTROW_FLAGS_OFFSET);
1469 struct afs_info default_afsi = {.last_played = 0};
1470 struct para_buffer msg = {.buf = NULL};
1472 hash = (HASH_TYPE *)buf + AFTROW_HASH_OFFSET;
1473 hash_to_asc(hash, asc);;
1474 objs[AFTCOL_HASH].data = buf + AFTROW_HASH_OFFSET;
1475 objs[AFTCOL_HASH].size = HASH_SIZE;
1477 path = buf + AFTROW_PATH_OFFSET;
1478 objs[AFTCOL_PATH].data = path;
1479 objs[AFTCOL_PATH].size = strlen(path) + 1;
1481 PARA_INFO_LOG("request to add %s\n", path);
1482 hs = find_hash_sister(hash);
1483 ret = aft_get_row_of_path(path, &pb);
1484 if (ret < 0 && ret != -E_RB_KEY_NOT_FOUND)
1486 if (hs && pb && hs == pb && !(flags & ADD_FLAG_FORCE)) {
1487 if (flags & ADD_FLAG_VERBOSE)
1488 para_printf(&msg, "ignoring duplicate\n");
1492 if (hs && hs != pb) {
1493 struct osl_object obj;
1494 if (pb) { /* hs trumps pb, remove pb */
1495 if (flags & ADD_FLAG_VERBOSE)
1496 para_printf(&msg, "removing path brother\n");
1497 ret = osl_del_row(audio_file_table, pb);
1502 /* file rename, update hs' path */
1503 if (flags & ADD_FLAG_VERBOSE) {
1504 ret = osl_get_object(audio_file_table, hs,
1508 para_printf(&msg, "renamed from %s\n", (char *)obj.data);
1510 ret = osl_update_object(audio_file_table, hs, AFTCOL_PATH,
1511 &objs[AFTCOL_PATH]);
1514 afs_event(AUDIO_FILE_RENAME, &msg, hs);
1515 if (!(flags & ADD_FLAG_FORCE))
1518 /* no hs or force mode, child must have sent afhi */
1519 uint16_t afhi_offset = read_u16(buf + AFTROW_AFHI_OFFSET_POS);
1520 uint16_t chunks_offset = read_u16(buf + AFTROW_CHUNKS_OFFSET_POS);
1522 objs[AFTCOL_AFHI].data = buf + afhi_offset;
1523 objs[AFTCOL_AFHI].size = chunks_offset - afhi_offset;
1525 if (!objs[AFTCOL_AFHI].size) /* "impossible" */
1527 objs[AFTCOL_CHUNKS].data = buf + chunks_offset;
1528 objs[AFTCOL_CHUNKS].size = query->size - chunks_offset;
1529 if (pb && !hs) { /* update pb's hash */
1530 char old_asc[2 * HASH_SIZE + 1];
1531 HASH_TYPE *old_hash;
1532 ret = get_hash_of_row(pb, &old_hash);
1535 hash_to_asc(old_hash, old_asc);
1536 if (flags & ADD_FLAG_VERBOSE)
1537 para_printf(&msg, "file change: %s -> %s\n",
1539 ret = osl_update_object(audio_file_table, pb, AFTCOL_HASH,
1540 &objs[AFTCOL_HASH]);
1544 if (hs || pb) { /* (hs != NULL and pb != NULL) implies hs == pb */
1545 struct osl_row *row = pb? pb : hs;
1546 /* update afhi and chunk_table */
1547 if (flags & ADD_FLAG_VERBOSE)
1548 para_printf(&msg, "updating afhi and chunk table\n");
1549 ret = osl_update_object(audio_file_table, row, AFTCOL_AFHI,
1550 &objs[AFTCOL_AFHI]);
1553 ret = osl_update_object(audio_file_table, row, AFTCOL_CHUNKS,
1554 &objs[AFTCOL_CHUNKS]);
1557 afs_event(AFHI_CHANGE, &msg, row);
1560 /* new entry, use default afsi */
1561 if (flags & ADD_FLAG_VERBOSE)
1562 para_printf(&msg, "new file\n");
1563 default_afsi.last_played = time(NULL) - 365 * 24 * 60 * 60;
1564 default_afsi.audio_format_id = read_u8(buf + AFTROW_AUDIO_FORMAT_OFFSET);
1566 objs[AFTCOL_AFSI].data = &afsi_buf;
1567 objs[AFTCOL_AFSI].size = AFSI_SIZE;
1568 save_afsi(&default_afsi, &objs[AFTCOL_AFSI]);
1569 ret = osl_add_and_get_row(audio_file_table, objs, &aft_row);
1572 para_printf(&msg, "%s\n", PARA_STRERROR(-ret));
1575 result->data = msg.buf;
1576 result->size = msg.size;
1577 afs_event(AUDIO_FILE_ADD, &msg, aft_row);
1581 /** Used by com_add(). */
1582 struct private_add_data {
1583 /** The socket file descriptor. */
1585 /** The given add flags. */
1589 static int path_brother_callback(const struct osl_object *query,
1590 struct osl_object *result)
1592 char *path = query->data;
1593 struct osl_row *path_brother;
1594 int ret = aft_get_row_of_path(path, &path_brother);
1597 result->data = para_malloc(sizeof(path_brother));
1598 result->size = sizeof(path_brother);
1599 *(struct osl_row **)(result->data) = path_brother;
1603 static int hash_sister_callback(const struct osl_object *query,
1604 struct osl_object *result)
1606 HASH_TYPE *hash = query->data;
1607 struct osl_row *hash_sister;
1609 hash_sister = find_hash_sister(hash);
1611 return -E_RB_KEY_NOT_FOUND;
1612 result->data = para_malloc(sizeof(hash_sister));
1613 result->size = sizeof(hash_sister);
1614 *(struct osl_row **)(result->data) = hash_sister;
1618 static int add_one_audio_file(const char *path, const void *private_data)
1621 uint8_t format_num = -1;
1622 const struct private_add_data *pad = private_data;
1623 struct afh_info afhi, *afhi_ptr = NULL;
1624 struct osl_row *pb = NULL, *hs = NULL; /* path brother/hash sister */
1625 struct osl_object map, obj = {.data = NULL}, query, result = {.data = NULL};
1626 HASH_TYPE hash[HASH_SIZE];
1628 afhi.header_offset = 0;
1629 afhi.header_len = 0;
1630 ret = guess_audio_format(path);
1631 if (ret < 0 && !(pad->flags & ADD_FLAG_ALL))
1633 query.data = (char *)path;
1634 query.size = strlen(path) + 1;
1635 ret = send_callback_request(path_brother_callback, &query, &result);
1636 if (ret < 0 && ret != -E_RB_KEY_NOT_FOUND)
1639 pb = *(struct osl_row **)result.data;
1643 if (pb && (pad->flags & ADD_FLAG_LAZY)) { /* lazy is really cheap */
1644 if (pad->flags & ADD_FLAG_VERBOSE)
1645 ret = send_va_buffer(pad->fd, "lazy-ignore: %s\n", path);
1648 /* We still want to add this file. Compute its hash. */
1649 ret = mmap_full_file(path, O_RDONLY, &map.data, &map.size, NULL);
1652 hash_function(map.data, map.size, hash);
1654 /* Check whether database contains file with the same hash. */
1656 query.size = HASH_SIZE;
1657 ret = send_callback_request(hash_sister_callback, &query, &result);
1658 if (ret < 0 && ret != -E_RB_KEY_NOT_FOUND)
1661 hs = *(struct osl_row **)result.data;
1664 /* Return success if we already know this file. */
1666 if (pb && hs && hs == pb && (!(pad->flags & ADD_FLAG_FORCE))) {
1667 if (pad->flags & ADD_FLAG_VERBOSE)
1668 ret = send_va_buffer(pad->fd,
1669 "%s exists, not forcing update\n", path);
1673 * we won't recalculate the audio format info and the chunk table if
1674 * there is a hash sister unless in FORCE mode.
1676 if (!hs || (pad->flags & ADD_FLAG_FORCE)) {
1677 ret = compute_afhi(path, map.data, map.size, &afhi);
1683 if (pad->flags & ADD_FLAG_VERBOSE) {
1684 ret = send_va_buffer(pad->fd, "adding %s\n", path);
1688 munmap(map.data, map.size);
1689 save_audio_file_info(hash, path, afhi_ptr, pad->flags, format_num, &obj);
1690 /* Ask afs to consider this entry for adding. */
1691 ret = send_callback_request(com_add_callback, &obj, &result);
1692 if (ret >= 0 && result.data && result.size) {
1693 ret2 = send_va_buffer(pad->fd, "%s", (char *)result.data);
1695 if (ret >= 0 && ret2 < 0)
1701 munmap(map.data, map.size);
1703 if (ret < 0 && ret != -E_SEND)
1704 send_va_buffer(pad->fd, "failed to add %s (%s)\n", path,
1705 PARA_STRERROR(-ret));
1708 free(afhi_ptr->chunk_table);
1709 /* it's not an error if not all files could be added */
1710 return ret == -E_SEND? ret : 1;
1713 int com_add(int fd, int argc, char * const * const argv)
1716 struct private_add_data pad = {.fd = fd, .flags = 0};
1717 struct stat statbuf;
1719 for (i = 1; i < argc; i++) {
1720 const char *arg = argv[i];
1723 if (!strcmp(arg, "--")) {
1727 if (!strcmp(arg, "-a")) {
1728 pad.flags |= ADD_FLAG_ALL;
1731 if (!strcmp(arg, "-l")) {
1732 pad.flags |= ADD_FLAG_LAZY;
1735 if (!strcmp(arg, "-f")) {
1736 pad.flags |= ADD_FLAG_FORCE;
1739 if (!strcmp(arg, "-v")) {
1740 pad.flags |= ADD_FLAG_VERBOSE;
1745 return -E_AFT_SYNTAX;
1746 for (; i < argc; i++) {
1748 ret = verify_path(argv[i], &path);
1750 ret = send_va_buffer(fd, "%s: %s\n", argv[i], PARA_STRERROR(-ret));
1755 ret = stat(path, &statbuf);
1757 ret = send_va_buffer(fd, "failed to stat %s (%s)\n", path,
1764 if (S_ISDIR(statbuf.st_mode))
1765 ret = for_each_file_in_dir(path, add_one_audio_file,
1768 ret = add_one_audio_file(path, &pad);
1770 send_va_buffer(fd, "%s: %s\n", path, PARA_STRERROR(-ret));
1781 * Flags used by the touch command.
1786 /** Whether the \p FNM_PATHNAME flag should be passed to fnmatch(). */
1787 TOUCH_FLAG_FNM_PATHNAME = 1,
1788 /** Activates verbose mode. */
1789 TOUCH_FLAG_VERBOSE = 2
1792 /** Options used by com_touch(). */
1793 struct com_touch_options {
1794 /** New num_played value. */
1796 /** New last played count. */
1797 int64_t last_played;
1798 /** new lyrics id. */
1800 /** new image id. */
1802 /** command line flags (see \ref touch_flags). */
1806 /** Data passed to the action handler of com_touch(). */
1807 struct touch_action_data {
1808 /** Command line options (see \ref com_touch_options). */
1809 struct com_touch_options *cto;
1810 /** Message buffer. */
1811 struct para_buffer pb;
1814 static int touch_audio_file(__a_unused struct osl_table *table,
1815 struct osl_row *row, const char *name, void *data)
1817 struct touch_action_data *tad = data;
1818 struct osl_object obj;
1819 struct afs_info old_afsi, new_afsi;
1820 int ret, no_options = tad->cto->num_played < 0 && tad->cto->last_played < 0 &&
1821 tad->cto->lyrics_id < 0 && tad->cto->image_id < 0;
1822 struct afsi_change_event_data aced;
1824 ret = get_afsi_object_of_row(row, &obj);
1826 para_printf(&tad->pb, "%s: %s\n", name, PARA_STRERROR(-ret));
1829 ret = load_afsi(&old_afsi, &obj);
1831 para_printf(&tad->pb, "%s: %s\n", name, PARA_STRERROR(-ret));
1834 new_afsi = old_afsi;
1836 new_afsi.num_played++;
1837 new_afsi.last_played = time(NULL);
1838 if (tad->cto->flags & TOUCH_FLAG_VERBOSE)
1839 para_printf(&tad->pb, "%s: num_played = %u, "
1840 "last_played = now()\n", name,
1841 new_afsi.num_played);
1843 if (tad->cto->flags & TOUCH_FLAG_VERBOSE)
1844 para_printf(&tad->pb, "touching %s\n", name);
1845 if (tad->cto->lyrics_id >= 0)
1846 new_afsi.lyrics_id = tad->cto->lyrics_id;
1847 if (tad->cto->image_id >= 0)
1848 new_afsi.image_id = tad->cto->image_id;
1849 if (tad->cto->num_played >= 0)
1850 new_afsi.num_played = tad->cto->num_played;
1851 if (tad->cto->last_played >= 0)
1852 new_afsi.last_played = tad->cto->last_played;
1854 save_afsi(&new_afsi, &obj); /* in-place update */
1856 aced.old_afsi = &old_afsi;
1857 afs_event(AFSI_CHANGE, &tad->pb, &aced);
1861 static int com_touch_callback(const struct osl_object *query,
1862 struct osl_object *result)
1864 struct touch_action_data tad = {.cto = query->data};
1866 struct pattern_match_data pmd = {
1867 .table = audio_file_table,
1868 .loop_col_num = AFTCOL_HASH,
1869 .match_col_num = AFTCOL_PATH,
1870 .patterns = {.data = (char *)query->data + sizeof(*tad.cto),
1871 .size = query->size - sizeof(*tad.cto)},
1873 .action = touch_audio_file
1875 if (tad.cto->flags & TOUCH_FLAG_FNM_PATHNAME)
1876 pmd.fnmatch_flags |= FNM_PATHNAME;
1877 ret = for_each_matching_row(&pmd);
1879 para_printf(&tad.pb, "%s\n", PARA_STRERROR(-ret));
1881 result->data = tad.pb.buf;
1882 result->size = tad.pb.size;
1885 return ret < 0? ret : 0;
1888 int com_touch(int fd, int argc, char * const * const argv)
1890 struct com_touch_options cto = {
1896 struct osl_object query = {.data = &cto, .size = sizeof(cto)},
1901 for (i = 1; i < argc; i++) {
1902 const char *arg = argv[i];
1905 if (!strcmp(arg, "--")) {
1909 if (!strncmp(arg, "-n", 2)) {
1910 ret = para_atoi32(arg + 2, &cto.num_played);
1915 if (!strncmp(arg, "-l", 2)) {
1916 ret = para_atoi64(arg + 2, &cto.last_played);
1921 if (!strncmp(arg, "-y", 2)) {
1922 ret = para_atoi32(arg + 2, &cto.lyrics_id);
1927 if (!strncmp(arg, "-i", 2)) {
1928 ret = para_atoi32(arg + 2, &cto.image_id);
1933 if (!strcmp(arg, "-p")) {
1934 cto.flags |= TOUCH_FLAG_FNM_PATHNAME;
1937 if (!strcmp(arg, "-v")) {
1938 cto.flags |= TOUCH_FLAG_VERBOSE;
1941 break; /* non-option starting with dash */
1944 return -E_AFT_SYNTAX;
1945 ret = send_option_arg_callback_request(&query, argc - i,
1946 argv + i, com_touch_callback, &result);
1948 send_buffer(fd, (char *)result.data);
1951 send_va_buffer(fd, "%s\n", PARA_STRERROR(-ret));
1955 /** Flags for com_rm(). */
1958 RM_FLAG_VERBOSE = 1,
1962 RM_FLAG_FNM_PATHNAME = 4
1965 /** Data passed to the action handler of com_rm(). */
1966 struct com_rm_action_data {
1967 /** Command line flags ((see \ref rm_flags). */
1969 /** Message buffer. */
1970 struct para_buffer pb;
1971 /** Number of audio files removed. */
1972 unsigned num_removed;
1975 static int remove_audio_file(__a_unused struct osl_table *table,
1976 struct osl_row *row, const char *name, void *data)
1978 struct com_rm_action_data *crd = data;
1981 if (crd->flags & RM_FLAG_VERBOSE)
1982 para_printf(&crd->pb, "removing %s\n", name);
1983 afs_event(AUDIO_FILE_REMOVE, &crd->pb, row);
1984 ret = osl_del_row(audio_file_table, row);
1986 para_printf(&crd->pb, "%s: %s\n", name, PARA_STRERROR(-ret));
1992 static int com_rm_callback(const struct osl_object *query,
1993 __a_unused struct osl_object *result)
1995 struct com_rm_action_data crd = {.flags = *(uint32_t *)query->data};
1997 struct pattern_match_data pmd = {
1998 .table = audio_file_table,
1999 .loop_col_num = AFTCOL_HASH,
2000 .match_col_num = AFTCOL_PATH,
2001 .patterns = {.data = (char *)query->data + sizeof(uint32_t),
2002 .size = query->size - sizeof(uint32_t)},
2004 .action = remove_audio_file
2006 if (crd.flags & RM_FLAG_FNM_PATHNAME)
2007 pmd.fnmatch_flags |= FNM_PATHNAME;
2008 ret = for_each_matching_row(&pmd);
2010 para_printf(&crd.pb, "%s\n", PARA_STRERROR(-ret));
2011 if (!crd.num_removed && !(crd.flags & RM_FLAG_FORCE))
2012 para_printf(&crd.pb, "no matches -- nothing removed\n");
2014 if (crd.flags & RM_FLAG_VERBOSE)
2015 para_printf(&crd.pb, "removed %u files\n", crd.num_removed);
2018 result->data = crd.pb.buf;
2019 result->size = crd.pb.size;
2022 return ret < 0? ret : 0;
2025 /* TODO options: -r (recursive) */
2026 int com_rm(int fd, int argc, char * const * const argv)
2029 struct osl_object query = {.data = &flags, .size = sizeof(flags)},
2033 for (i = 1; i < argc; i++) {
2034 const char *arg = argv[i];
2037 if (!strcmp(arg, "--")) {
2041 if (!strcmp(arg, "-f")) {
2042 flags |= RM_FLAG_FORCE;
2045 if (!strcmp(arg, "-p")) {
2046 flags |= RM_FLAG_FNM_PATHNAME;
2049 if (!strcmp(arg, "-v")) {
2050 flags |= RM_FLAG_VERBOSE;
2056 return -E_AFT_SYNTAX;
2057 ret = send_option_arg_callback_request(&query, argc - i, argv + i,
2058 com_rm_callback, &result);
2060 send_buffer(fd, (char *)result.data);
2063 send_va_buffer(fd, "%s\n", PARA_STRERROR(-ret));
2068 * Flags used by the cpsi command.
2073 /** Whether the lyrics id should be copied. */
2074 CPSI_FLAG_COPY_LYRICS_ID = 1,
2075 /** Whether the image id should be copied. */
2076 CPSI_FLAG_COPY_IMAGE_ID = 2,
2077 /** Whether the lastplayed time should be copied. */
2078 CPSI_FLAG_COPY_LASTPLAYED = 4,
2079 /** Whether the numplayed count should be copied. */
2080 CPSI_FLAG_COPY_NUMPLAYED = 8,
2081 /** Whether the attributes should be copied. */
2082 CPSI_FLAG_COPY_ATTRIBUTES = 16,
2083 /** Activates verbose mode. */
2084 CPSI_FLAG_VERBOSE = 32,
2087 /** Data passed to the action handler of com_cpsi(). */
2088 struct cpsi_action_data {
2089 /** command line flags (see \ref cpsi_flags). */
2091 /** Number of audio files changed. */
2092 unsigned num_copied;
2093 /** Message buffer. */
2094 struct para_buffer pb;
2095 /** Values are copied from here. */
2096 struct afs_info source_afsi;
2099 static int copy_selector_info(__a_unused struct osl_table *table,
2100 struct osl_row *row, const char *name, void *data)
2102 struct cpsi_action_data *cad = data;
2103 struct osl_object target_afsi_obj;
2105 struct afs_info old_afsi, target_afsi;
2106 struct afsi_change_event_data aced;
2108 ret = get_afsi_object_of_row(row, &target_afsi_obj);
2111 load_afsi(&target_afsi, &target_afsi_obj);
2112 old_afsi = target_afsi;
2113 if (cad->flags & CPSI_FLAG_COPY_LYRICS_ID)
2114 target_afsi.lyrics_id = cad->source_afsi.lyrics_id;
2115 if (cad->flags & CPSI_FLAG_COPY_IMAGE_ID)
2116 target_afsi.image_id = cad->source_afsi.image_id;
2117 if (cad->flags & CPSI_FLAG_COPY_LASTPLAYED)
2118 target_afsi.last_played = cad->source_afsi.last_played;
2119 if (cad->flags & CPSI_FLAG_COPY_NUMPLAYED)
2120 target_afsi.num_played = cad->source_afsi.num_played;
2121 if (cad->flags & CPSI_FLAG_COPY_ATTRIBUTES)
2122 target_afsi.attributes = cad->source_afsi.attributes;
2123 save_afsi(&target_afsi, &target_afsi_obj); /* in-place update */
2125 if (cad->flags & CPSI_FLAG_VERBOSE)
2126 para_printf(&cad->pb, "copied afsi to %s\n", name);
2128 aced.old_afsi = &old_afsi;
2129 afs_event(AFSI_CHANGE, &cad->pb, &aced);
2133 static int com_cpsi_callback(const struct osl_object *query,
2134 struct osl_object *result)
2136 struct cpsi_action_data cad = {.flags = *(unsigned *)query->data};
2138 char *source_path = (char *)query->data + sizeof(cad.flags);
2140 ret = get_afsi_of_path(source_path, &cad.source_afsi);
2143 struct pattern_match_data pmd = {
2144 .table = audio_file_table,
2145 .loop_col_num = AFTCOL_HASH,
2146 .match_col_num = AFTCOL_PATH,
2147 .patterns = {.data = source_path + strlen(source_path) + 1,
2148 .size = query->size - sizeof(cad.flags)
2149 - strlen(source_path) - 1},
2151 .action = copy_selector_info
2153 ret = for_each_matching_row(&pmd);
2156 para_printf(&cad.pb, "%s\n", PARA_STRERROR(-ret));
2157 if (cad.flags & CPSI_FLAG_VERBOSE) {
2159 para_printf(&cad.pb, "copied requested afsi from %s "
2161 source_path, cad.num_copied);
2163 para_printf(&cad.pb, "nothing copied\n");
2166 result->data = cad.pb.buf;
2167 result->size = cad.pb.size;
2170 return ret < 0? ret : 0;
2173 int com_cpsi(int fd, int argc, char * const * const argv)
2177 struct osl_object options = {.data = &flags, .size = sizeof(flags)},
2180 for (i = 1; i < argc; i++) {
2181 const char *arg = argv[i];
2184 if (!strcmp(arg, "--")) {
2188 if (!strcmp(arg, "-y")) {
2189 flags |= CPSI_FLAG_COPY_LYRICS_ID;
2192 if (!strcmp(arg, "-i")) {
2193 flags |= CPSI_FLAG_COPY_IMAGE_ID;
2196 if (!strcmp(arg, "-l")) {
2197 flags |= CPSI_FLAG_COPY_LASTPLAYED;
2200 if (!strcmp(arg, "-n")) {
2201 flags |= CPSI_FLAG_COPY_NUMPLAYED;
2204 if (!strcmp(arg, "-a")) {
2205 flags |= CPSI_FLAG_COPY_ATTRIBUTES;
2208 if (!strcmp(arg, "-v")) {
2209 flags |= CPSI_FLAG_VERBOSE;
2214 if (i + 1 >= argc) /* need at least souce file and pattern */
2215 return -E_AFT_SYNTAX;
2216 if (!(flags & ~CPSI_FLAG_VERBOSE)) /* no copy flags given */
2217 flags = ~(unsigned)CPSI_FLAG_VERBOSE | flags;
2218 ret = send_option_arg_callback_request(&options, argc - i, argv + i,
2219 com_cpsi_callback, &result);
2221 send_buffer(fd, (char *)result.data);
2224 send_va_buffer(fd, "%s\n", PARA_STRERROR(-ret));
2228 /* TODO: optionally fix problems by removing offending rows */
2229 static int check_audio_file(struct osl_row *row, void *data)
2232 struct para_buffer *pb = data;
2233 struct stat statbuf;
2234 int ret = get_audio_file_path_of_row(row, &path);
2235 struct afs_info afsi;
2239 para_printf(pb, "%s\n", PARA_STRERROR(-ret));
2242 if (stat(path, &statbuf) < 0)
2243 para_printf(pb, "%s: stat error (%s)\n", path, strerror(errno));
2245 if (!S_ISREG(statbuf.st_mode))
2246 para_printf(pb, "%s: not a regular file\n", path);
2248 ret = get_afsi_of_row(row, &afsi);
2250 para_printf(pb, "%s: %s\n", path, PARA_STRERROR(-ret));
2253 ret = lyr_get_name_by_id(afsi.lyrics_id, &blob_name);
2255 para_printf(pb, "%s lyrics id %u: %s\n", path, afsi.lyrics_id,
2256 PARA_STRERROR(-ret));
2257 ret = img_get_name_by_id(afsi.image_id, &blob_name);
2259 para_printf(pb, "%s image id %u: %s\n", path, afsi.image_id,
2260 PARA_STRERROR(-ret));
2265 * Check the audio file table for inconsistencies.
2267 * \param query Unused.
2268 * \param result Contains message string upon return.
2270 * This function always succeeds.
2274 int aft_check_callback(__a_unused const struct osl_object *query, struct osl_object *result)
2276 struct para_buffer pb = {.buf = NULL};
2278 para_printf(&pb, "checking audio file table...\n");
2279 audio_file_loop(&pb, check_audio_file);
2280 result->data = pb.buf;
2281 result->size = pb.size;
2287 * Close the audio file table.
2289 * \param flags Usual flags that are passed to osl_close_table().
2291 * \sa osl_close_table().
2293 static void aft_close(void)
2295 osl_close_table(audio_file_table, OSL_MARK_CLEAN);
2296 audio_file_table = NULL;
2300 * Open the audio file table.
2302 * \param dir The database directory.
2306 * \sa osl_open_table().
2308 static int aft_open(const char *dir)
2312 audio_file_table_desc.dir = dir;
2313 ret = osl_open_table(&audio_file_table_desc, &audio_file_table);
2316 osl_get_num_rows(audio_file_table, &num);
2317 PARA_INFO_LOG("audio file table contains %d files\n", num);
2320 PARA_INFO_LOG("failed to open audio file table\n");
2321 audio_file_table = NULL;
2322 if (ret >= 0 || is_errno(-ret, ENOENT))
2327 static int aft_create(const char *dir)
2329 audio_file_table_desc.dir = dir;
2330 return osl_create_table(&audio_file_table_desc);
2333 static int clear_attribute(struct osl_row *row, void *data)
2335 struct rmatt_event_data *red = data;
2336 struct afs_info afsi;
2337 struct osl_object obj;
2338 int ret = get_afsi_object_of_row(row, &obj);
2339 uint64_t mask = ~(1ULL << red->bitnum);
2343 ret = load_afsi(&afsi, &obj);
2346 afsi.attributes &= mask;
2347 save_afsi(&afsi, &obj);
2351 static int aft_event_handler(enum afs_events event, struct para_buffer *pb,
2355 case ATTRIBUTE_REMOVE: {
2356 const struct rmatt_event_data *red = data;
2357 para_printf(pb, "clearing attribute %s (bit %u) from all "
2358 "entries in the audio file table\n", red->name,
2360 return audio_file_loop(data, clear_attribute);
2367 void aft_init(struct afs_table *t)
2369 t->name = audio_file_table_desc.name;
2371 t->close = aft_close;
2372 t->create = aft_create;
2373 t->event_handler = aft_event_handler;