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 /** EOF timeout in ms. */
329 AFHI_EOF_OFFSET = 13,
330 /** The tag info position. */
331 AFHI_INFO_STRING_OFFSET = 15,
332 /** Minimal on-disk size of a valid afhi struct. */
336 static unsigned sizeof_afhi_buf(const struct afh_info *afhi)
340 return strlen(afhi->info_string) + MIN_AFHI_SIZE;
343 static void save_afhi(struct afh_info *afhi, char *buf)
347 write_u32(buf + AFHI_SECONDS_TOTAL_OFFSET,
348 afhi->seconds_total);
349 write_u32(buf + AFHI_BITRATE_OFFSET, afhi->bitrate);
350 write_u32(buf + AFHI_FREQUENCY_OFFSET, afhi->frequency);
351 write_u8(buf + AFHI_CHANNELS_OFFSET, afhi->channels);
352 write_u16(buf + AFHI_EOF_OFFSET, tv2ms(&afhi->eof_tv));
353 strcpy(buf + AFHI_INFO_STRING_OFFSET, afhi->info_string); /* OK */
354 PARA_DEBUG_LOG("last byte written: %p\n", buf + AFHI_INFO_STRING_OFFSET + strlen(afhi->info_string));
357 static void load_afhi(const char *buf, struct afh_info *afhi)
359 afhi->seconds_total = read_u32(buf + AFHI_SECONDS_TOTAL_OFFSET);
360 afhi->bitrate = read_u32(buf + AFHI_BITRATE_OFFSET);
361 afhi->frequency = read_u32(buf + AFHI_FREQUENCY_OFFSET);
362 afhi->channels = read_u8(buf + AFHI_CHANNELS_OFFSET);
363 ms2tv(read_u16(buf + AFHI_EOF_OFFSET), &afhi->eof_tv);
364 strcpy(afhi->info_string, buf + AFHI_INFO_STRING_OFFSET);
367 //#define SIZEOF_CHUNK_TABLE(afhi) (((afhi)->chunks_total + 1) * sizeof(uint32_t))
369 static unsigned sizeof_chunk_info_buf(struct afh_info *afhi)
373 return 4 * (afhi->chunks_total + 1) + 20;
377 /** The offsets of the data contained in the AFTCOL_CHUNKS column. */
378 enum chunk_info_offsets{
379 /** The total number of chunks (4 bytes). */
380 CHUNKS_TOTAL_OFFSET = 0,
381 /** The length of the audio file header (4 bytes). */
382 HEADER_LEN_OFFSET = 4,
383 /** The start of the audio file header (4 bytes). */
384 HEADER_OFFSET_OFFSET = 8,
385 /** The seconds part of the chunk time (4 bytes). */
386 CHUNK_TV_TV_SEC_OFFSET = 12,
387 /** The microseconds part of the chunk time (4 bytes). */
388 CHUNK_TV_TV_USEC = 16,
389 /** Chunk table entries start here. */
390 CHUNK_TABLE_OFFSET = 20,
393 static void save_chunk_table(struct afh_info *afhi, char *buf)
397 PARA_DEBUG_LOG("%lu chunks\n", afhi->chunks_total);
398 for (i = 0; i <= afhi->chunks_total; i++)
399 write_u32(buf + 4 * i, afhi->chunk_table[i]);
402 static void load_chunk_table(struct afh_info *afhi, char *buf)
405 for (i = 0; i <= afhi->chunks_total; i++)
406 afhi->chunk_table[i] = read_u32(buf + 4 * i);
409 /* TODO: audio format handlers could just produce this */
410 static void save_chunk_info(struct afh_info *afhi, char *buf)
414 write_u32(buf + CHUNKS_TOTAL_OFFSET, afhi->chunks_total);
415 write_u32(buf + HEADER_LEN_OFFSET, afhi->header_len);
416 write_u32(buf + HEADER_OFFSET_OFFSET, afhi->header_offset);
417 write_u32(buf + CHUNK_TV_TV_SEC_OFFSET, afhi->chunk_tv.tv_sec);
418 write_u32(buf + CHUNK_TV_TV_USEC, afhi->chunk_tv.tv_usec);
419 save_chunk_table(afhi, buf + CHUNK_TABLE_OFFSET);
422 static int load_chunk_info(struct osl_object *obj, struct afh_info *afhi)
424 char *buf = obj->data;
426 if (obj->size < CHUNK_TABLE_OFFSET)
427 return -E_BAD_DATA_SIZE;
429 afhi->chunks_total = read_u32(buf + CHUNKS_TOTAL_OFFSET);
430 afhi->header_len = read_u32(buf + HEADER_LEN_OFFSET);
431 afhi->header_offset = read_u32(buf + HEADER_OFFSET_OFFSET);
432 afhi->chunk_tv.tv_sec = read_u32(buf + CHUNK_TV_TV_SEC_OFFSET);
433 afhi->chunk_tv.tv_usec = read_u32(buf + CHUNK_TV_TV_USEC);
435 if ((afhi->chunks_total + 1) * 4 + CHUNK_TABLE_OFFSET > obj->size)
436 return -E_BAD_DATA_SIZE;
437 afhi->chunk_table = para_malloc((afhi->chunks_total + 1) * 4);
438 load_chunk_table(afhi, buf + CHUNK_TABLE_OFFSET);
443 * Get the row of the audio file table corresponding to the given path.
445 * \param path The full path of the audio file.
446 * \param row Result pointer.
448 * \return The return value of the underlying call to osl_get_row().
450 int aft_get_row_of_path(const char *path, struct osl_row **row)
452 struct osl_object obj = {.data = (char *)path, .size = strlen(path) + 1};
454 return osl_get_row(audio_file_table, AFTCOL_PATH, &obj, row);
458 * Get the row of the audio file table corresponding to the given hash value.
460 * \param hash The hash value of the desired audio file.
461 * \param row resul pointer.
463 * \return The return value of the underlying call to osl_get_row().
465 int aft_get_row_of_hash(HASH_TYPE *hash, struct osl_row **row)
467 const struct osl_object obj = {.data = hash, .size = HASH_SIZE};
468 return osl_get_row(audio_file_table, AFTCOL_HASH, &obj, row);
472 * Get the osl object holding the audio file selector info of a row.
474 * \param row Pointer to a row in the audio file table.
475 * \param obj Result pointer.
477 * \return The return value of the underlying call to osl_get_object().
479 int get_afsi_object_of_row(const struct osl_row *row, struct osl_object *obj)
481 return osl_get_object(audio_file_table, row, AFTCOL_AFSI, obj);
485 * Get the osl object holding the audio file selector info, given a path.
488 * \param path The full path of the audio file.
489 * \param obj Result pointer.
491 * \return Positive on success, negative on errors.
493 int get_afsi_object_of_path(const char *path, struct osl_object *obj)
496 int ret = aft_get_row_of_path(path, &row);
499 return get_afsi_object_of_row(row, obj);
503 * Get the audio file selector info, given a row of the audio file table.
505 * \param row Pointer to a row in the audio file table.
506 * \param afsi Result pointer.
508 * \return Positive on success, negative on errors.
510 int get_afsi_of_row(const struct osl_row *row, struct afs_info *afsi)
512 struct osl_object obj;
513 int ret = get_afsi_object_of_row(row, &obj);
516 return load_afsi(afsi, &obj);
520 * Get the audio file selector info, given the path of an audio table.
522 * \param path The full path of the audio file.
523 * \param afsi Result pointer.
525 * \return Positive on success, negative on errors.
527 int get_afsi_of_path(const char *path, struct afs_info *afsi)
529 struct osl_object obj;
530 int ret = get_afsi_object_of_path(path, &obj);
533 return load_afsi(afsi, &obj);
537 * Get the path of an audio file, given a row of the audio file table.
539 * \param row Pointer to a row in the audio file table.
540 * \param path Result pointer.
542 * The result is a pointer to mmapped data. The caller must not attempt
547 int get_audio_file_path_of_row(const struct osl_row *row, char **path)
549 struct osl_object path_obj;
550 int ret = osl_get_object(audio_file_table, row, AFTCOL_PATH,
554 *path = path_obj.data;
559 * Get the object containing the hash value of an audio file, given a row.
561 * \param row Pointer to a row of the audio file table.
562 * \param obj Result pointer.
564 * \return The return value of the underlying call to osl_get_object().
566 * \sa get_hash_of_row().
568 static int get_hash_object_of_aft_row(const struct osl_row *row, struct osl_object *obj)
570 return osl_get_object(audio_file_table, row, AFTCOL_HASH, obj);
574 * Get the hash value of an audio file, given a row of the audio file table.
576 * \param row Pointer to a row of the audio file table.
577 * \param hash Result pointer.
579 * \a hash points to mapped data and must not be freed by the caller.
581 * \return The return value of the underlying call to
582 * get_hash_object_of_aft_row().
584 static int get_hash_of_row(const struct osl_row *row, HASH_TYPE **hash)
586 struct osl_object obj;
587 int ret = get_hash_object_of_aft_row(row, &obj);
596 * Get the audio format handler info, given a row of the audio file table.
598 * \param row Pointer to a row of the audio file table.
599 * \param afhi Result pointer.
601 * \return The return value of the underlying call to osl_get_object().
603 * \sa get_chunk_table_of_row().
605 int get_afhi_of_row(const struct osl_row *row, struct afh_info *afhi)
607 struct osl_object obj;
608 int ret = osl_get_object(audio_file_table, row, AFTCOL_AFHI,
612 load_afhi(obj.data, afhi);
616 /* returns shmid on success */
617 static int save_afd(struct audio_file_data *afd)
619 size_t size = sizeof(*afd)
620 + 4 * (afd->afhi.chunks_total + 1);
622 PARA_DEBUG_LOG("size: %zu\n", size);
623 int shmid, ret = shm_new(size);
630 ret = shm_attach(shmid, ATTACH_RW, &shm_afd);
633 *(struct audio_file_data *)shm_afd = *afd;
636 save_chunk_table(&afd->afhi, buf);
644 int load_afd(int shmid, struct audio_file_data *afd)
650 ret = shm_attach(shmid, ATTACH_RO, &shm_afd);
653 *afd = *(struct audio_file_data *)shm_afd;
656 afd->afhi.chunk_table = para_malloc((afd->afhi.chunks_total + 1) * 4);
657 load_chunk_table(&afd->afhi, buf);
663 * Mmap the given audio file and update statistics.
665 * \param aft_row Determines the audio file to be opened and updated.
666 * \param afd Result pointer.
668 * On success, the numplayed field of the audio file selector info is increased
669 * and the lastplayed time is set to the current time. Finally, the score of
670 * the audio file is updated.
672 * \return Positive on success, negative on errors.
674 int open_and_update_audio_file(struct osl_row *aft_row, struct audio_file_data *afd)
676 HASH_TYPE *aft_hash, file_hash[HASH_SIZE];
677 struct osl_object afsi_obj;
678 struct afs_info new_afsi;
679 int ret = get_hash_of_row(aft_row, &aft_hash);
680 struct afsi_change_event_data aced;
681 struct osl_object map, chunk_table_obj;
686 ret = get_audio_file_path_of_row(aft_row, &path);
689 strncpy(afd->path, path, sizeof(afd->path) - 1);
690 afd->path[sizeof(afd->path) - 1] = '\0';
691 ret = get_afsi_object_of_row(aft_row, &afsi_obj);
694 ret = load_afsi(&afd->afsi, &afsi_obj);
697 ret = get_afhi_of_row(aft_row, &afd->afhi);
700 ret = osl_open_disk_object(audio_file_table, aft_row,
701 AFTCOL_CHUNKS, &chunk_table_obj);
704 ret = mmap_full_file(path, O_RDONLY, &map.data,
705 &map.size, &afd->fd);
708 hash_function(map.data, map.size, file_hash);
709 ret = hash_compare(file_hash, aft_hash);
710 para_munmap(map.data, map.size);
712 ret = -E_HASH_MISMATCH;
715 new_afsi = afd->afsi;
716 new_afsi.num_played++;
717 new_afsi.last_played = time(NULL);
718 save_afsi(&new_afsi, &afsi_obj); /* in-place update */
720 ret = load_chunk_info(&chunk_table_obj, &afd->afhi);
723 ret = get_attribute_text(&afd->afsi.attributes, " ", &tmp);
726 tmp[sizeof(afd->attributes_string) - 1] = '\0';
727 strcpy(afd->attributes_string, tmp); /* OK */
730 aced.aft_row = aft_row;
731 aced.old_afsi = &afd->afsi;
732 afs_event(AFSI_CHANGE, NULL, &aced);
736 free(afd->afhi.chunk_table);
738 osl_close_disk_object(&chunk_table_obj);
742 static int get_local_time(uint64_t *seconds, char *buf, size_t size,
743 time_t current_time, enum ls_listing_mode lm)
747 if (!localtime_r((time_t *)seconds, &t))
749 if (lm == LS_MODE_MBOX) {
750 if (!strftime(buf, size, "%c", &t))
754 if (*seconds + 6 * 30 * 24 * 3600 > current_time) {
755 if (!strftime(buf, size, "%b %e %k:%M", &t))
759 if (!strftime(buf, size, "%b %e %Y", &t))
764 /** Compute the number of (decimal) digits of a number. */
765 #define GET_NUM_DIGITS(x, num) { \
766 typeof((x)) _tmp = PARA_ABS(x); \
769 while ((_tmp) > 9) { \
775 static short unsigned get_duration_width(int seconds)
777 short unsigned width;
778 unsigned hours = seconds / 3600, mins = (seconds % 3600) / 60;
780 if (!hours) /* less than one hour => m:ss or mm:ss => 4 or 5 digits */
781 return 4 + (mins > 9);
782 /* more than one hour => h:mm:ss, hh:mm:ss, hhh:mm:ss, ... */
783 GET_NUM_DIGITS(hours, &width);
787 static void get_duration_buf(int seconds, char *buf, short unsigned max_width)
789 unsigned hours = seconds / 3600, mins = (seconds % 3600) / 60;
791 if (!hours) /* m:ss or mm:ss */
792 sprintf(buf, "%*u:%02u", max_width - 3, mins, seconds % 60);
793 else /* more than one hour => h:mm:ss, hh:mm:ss, hhh:mm:ss, ... */
794 sprintf(buf, "%*u:%02u:%02u", max_width - 6, hours, mins,
798 static char *make_attribute_lines(const char *att_bitmap, struct afs_info *afsi)
800 char *att_text, *att_lines;
802 get_attribute_text(&afsi->attributes, " ", &att_text);
804 return para_strdup(att_bitmap);
805 att_lines = make_message("%s\nattributes_txt: %s",
806 att_bitmap, att_text);
811 static char *make_lyrics_line(struct afs_info *afsi)
815 lyr_get_name_by_id(afsi->lyrics_id, &lyrics_name);
817 return make_message("%u", afsi->lyrics_id);
818 return make_message("%u (%s)", afsi->lyrics_id, lyrics_name);
821 static char *make_image_line(struct afs_info *afsi)
824 img_get_name_by_id(afsi->image_id, &image_name);
826 return make_message("%u", afsi->image_id);
827 return make_message("%u (%s)", afsi->image_id, image_name);
830 static int print_list_item(struct ls_data *d, struct ls_options *opts,
831 struct para_buffer *b, time_t current_time)
835 char last_played_time[30];
836 char duration_buf[30]; /* nobody has an audio file long enough to overflow this */
837 char score_buf[30] = "";
838 struct afs_info *afsi = &d->afsi;
839 struct afh_info *afhi = &d->afhi;
840 struct ls_widths *w = &opts->widths;
841 int have_score = opts->flags & LS_FLAG_ADMISSIBLE_ONLY;
842 char asc_hash[2 * HASH_SIZE + 1];
843 char *att_lines, *lyrics_line, *image_line;
845 if (opts->mode == LS_MODE_SHORT) {
846 para_printf(b, "%s\n", d->path);
849 get_attribute_bitmap(&afsi->attributes, att_buf);
850 ret = get_local_time(&afsi->last_played, last_played_time,
851 sizeof(last_played_time), current_time, opts->mode);
854 get_duration_buf(afhi->seconds_total, duration_buf, w->duration_width);
856 if (opts->mode == LS_MODE_LONG)
857 sprintf(score_buf, "%*li ", w->score_width, d->score);
859 sprintf(score_buf, "%li ", d->score);
862 if (opts->mode == LS_MODE_LONG) {
865 "%s " /* attributes */
866 "%*d " /* image_id */
867 "%*d " /* lyrics_id */
869 "%s " /* audio format */
870 "%*d " /* frequency */
873 "%*d " /* num_played */
874 "%s " /* last_played */
878 w->image_id_width, afsi->image_id,
879 w->lyrics_id_width, afsi->lyrics_id,
880 w->bitrate_width, afhi->bitrate,
881 audio_format_name(afsi->audio_format_id),
882 w->frequency_width, afhi->frequency,
885 w->num_played_width, afsi->num_played,
891 hash_to_asc(d->hash, asc_hash);
892 att_lines = make_attribute_lines(att_buf, afsi);
893 lyrics_line = make_lyrics_line(afsi);
894 image_line = make_image_line(afsi);
895 /* TODO: Merge this with status items */
896 if (opts->mode == LS_MODE_VERBOSE) {
898 "%s: %s\n" /* path */
904 "bitrate: %dkbit/s\n"
912 (opts->flags & LS_FLAG_FULL_PATH)?
913 "path" : "file", d->path,
914 have_score? "score: " : "", score_buf,
915 have_score? "\n" : "",
921 audio_format_name(afsi->audio_format_id),
929 } else { /* mbox mode */
930 struct osl_object lyrics_def;
931 lyr_get_def_by_id(afsi->lyrics_id, &lyrics_def);
933 "From foo@localhost %s\n"
934 "Received: from\nTo: bar\nFrom: a\n"
935 "Subject: %s\n\n" /* path */
941 "bitrate: %dkbit/s\n"
951 have_score? "score: " : "", score_buf,
952 have_score? "\n" : "",
958 audio_format_name(afsi->audio_format_id),
964 lyrics_def.data? "Lyrics:\n~~~~~~~\n" : "",
965 lyrics_def.data? (char *)lyrics_def.data : ""
968 osl_close_disk_object(lyrics_def.data);
976 static int ls_audio_format_compare(const void *a, const void *b)
978 struct ls_data *d1 = *(struct ls_data **)a, *d2 = *(struct ls_data **)b;
979 return NUM_COMPARE(d1->afsi.audio_format_id, d2->afsi.audio_format_id);
982 static int ls_duration_compare(const void *a, const void *b)
984 struct ls_data *d1 = *(struct ls_data **)a, *d2 = *(struct ls_data **)b;
985 return NUM_COMPARE(d1->afhi.seconds_total, d2->afhi.seconds_total);
988 static int ls_bitrate_compare(const void *a, const void *b)
990 struct ls_data *d1 = *(struct ls_data **)a, *d2 = *(struct ls_data **)b;
991 return NUM_COMPARE(d1->afhi.bitrate, d2->afhi.bitrate);
994 static int ls_lyrics_id_compare(const void *a, const void *b)
996 struct ls_data *d1 = *(struct ls_data **)a, *d2 = *(struct ls_data **)b;
997 return NUM_COMPARE(d1->afsi.lyrics_id, d2->afsi.lyrics_id);
1000 static int ls_image_id_compare(const void *a, const void *b)
1002 struct ls_data *d1 = *(struct ls_data **)a, *d2 = *(struct ls_data **)b;
1003 return NUM_COMPARE(d1->afsi.image_id, d2->afsi.image_id);
1006 static int ls_channels_compare(const void *a, const void *b)
1008 struct ls_data *d1 = *(struct ls_data **)a, *d2 = *(struct ls_data **)b;
1009 return NUM_COMPARE(d1->afhi.channels, d2->afhi.channels);
1012 static int ls_frequency_compare(const void *a, const void *b)
1014 struct ls_data *d1 = *(struct ls_data **)a, *d2 = *(struct ls_data **)b;
1015 return NUM_COMPARE(d1->afhi.frequency, d2->afhi.frequency);
1018 static int ls_num_played_compare(const void *a, const void *b)
1020 struct ls_data *d1 = *(struct ls_data **)a, *d2 = *(struct ls_data **)b;
1021 return NUM_COMPARE(d1->afsi.num_played, d2->afsi.num_played);
1024 static int ls_last_played_compare(const void *a, const void *b)
1026 struct ls_data *d1 = *(struct ls_data **)a, *d2 = *(struct ls_data **)b;
1027 return NUM_COMPARE(d1->afsi.last_played, d2->afsi.last_played);
1030 static int ls_score_compare(const void *a, const void *b)
1032 struct ls_data *d1 = *(struct ls_data **)a, *d2 = *(struct ls_data **)b;
1033 return NUM_COMPARE(d1->score, d2->score);
1036 static int ls_path_compare(const void *a, const void *b)
1038 struct ls_data *d1 = *(struct ls_data **)a, *d2 = *(struct ls_data **)b;
1039 return strcmp(d1->path, d2->path);
1042 static int sort_matching_paths(struct ls_options *options)
1044 size_t nmemb = options->num_matching_paths;
1045 size_t size = sizeof(*options->data_ptr);
1046 int (*compar)(const void *, const void *);
1049 options->data_ptr = para_malloc(nmemb * sizeof(*options->data_ptr));
1050 for (i = 0; i < nmemb; i++)
1051 options->data_ptr[i] = options->data + i;
1053 /* In these cases the array is already sorted */
1054 if (options->sorting == LS_SORT_BY_PATH
1055 && !(options->flags & LS_FLAG_ADMISSIBLE_ONLY)
1056 && (options->flags & LS_FLAG_FULL_PATH))
1058 if (options->sorting == LS_SORT_BY_SCORE &&
1059 options->flags & LS_FLAG_ADMISSIBLE_ONLY)
1062 switch (options->sorting) {
1063 case LS_SORT_BY_PATH:
1064 compar = ls_path_compare; break;
1065 case LS_SORT_BY_SCORE:
1066 compar = ls_score_compare; break;
1067 case LS_SORT_BY_LAST_PLAYED:
1068 compar = ls_last_played_compare; break;
1069 case LS_SORT_BY_NUM_PLAYED:
1070 compar = ls_num_played_compare; break;
1071 case LS_SORT_BY_FREQUENCY:
1072 compar = ls_frequency_compare; break;
1073 case LS_SORT_BY_CHANNELS:
1074 compar = ls_channels_compare; break;
1075 case LS_SORT_BY_IMAGE_ID:
1076 compar = ls_image_id_compare; break;
1077 case LS_SORT_BY_LYRICS_ID:
1078 compar = ls_lyrics_id_compare; break;
1079 case LS_SORT_BY_BITRATE:
1080 compar = ls_bitrate_compare; break;
1081 case LS_SORT_BY_DURATION:
1082 compar = ls_duration_compare; break;
1083 case LS_SORT_BY_AUDIO_FORMAT:
1084 compar = ls_audio_format_compare; break;
1088 qsort(options->data_ptr, nmemb, size, compar);
1092 /* row is either an aft_row or a row of the score table */
1093 /* TODO: Only compute widths if we need them */
1094 static int prepare_ls_row(struct osl_row *row, void *ls_opts)
1097 struct ls_options *options = ls_opts;
1099 struct ls_widths *w;
1100 unsigned short num_digits;
1102 struct osl_row *aft_row;
1106 if (options->flags & LS_FLAG_ADMISSIBLE_ONLY) {
1107 ret = get_score_and_aft_row(row, &score, &aft_row);
1112 ret = get_audio_file_path_of_row(aft_row, &path);
1115 if (!(options->flags & LS_FLAG_FULL_PATH)) {
1116 char *p = strrchr(path, '/');
1120 if (options->num_patterns) {
1121 for (i = 0; i < options->num_patterns; i++) {
1122 ret = fnmatch(options->patterns[i], path, 0);
1125 if (ret == FNM_NOMATCH)
1129 if (i >= options->num_patterns) /* no match */
1132 tmp = options->num_matching_paths++;
1133 if (options->num_matching_paths > options->array_size) {
1134 options->array_size++;
1135 options->array_size *= 2;
1136 options->data = para_realloc(options->data, options->array_size
1137 * sizeof(*options->data));
1139 d = options->data + tmp;
1140 ret = get_afsi_of_row(aft_row, &d->afsi);
1143 ret = get_afhi_of_row(aft_row, &d->afhi);
1147 ret = get_hash_of_row(aft_row, &d->hash);
1150 w = &options->widths;
1151 GET_NUM_DIGITS(d->afsi.image_id, &num_digits);
1152 w->image_id_width = PARA_MAX(w->image_id_width, num_digits);
1153 GET_NUM_DIGITS(d->afsi.lyrics_id, &num_digits);
1154 w->lyrics_id_width = PARA_MAX(w->lyrics_id_width, num_digits);
1155 GET_NUM_DIGITS(d->afhi.bitrate, &num_digits);
1156 w->bitrate_width = PARA_MAX(w->bitrate_width, num_digits);
1157 GET_NUM_DIGITS(d->afhi.frequency, &num_digits);
1158 w->frequency_width = PARA_MAX(w->frequency_width, num_digits);
1159 GET_NUM_DIGITS(d->afsi.num_played, &num_digits);
1160 w->num_played_width = PARA_MAX(w->num_played_width, num_digits);
1161 /* get the number of chars to print this amount of time */
1162 tmp = get_duration_width(d->afhi.seconds_total);
1163 w->duration_width = PARA_MAX(w->duration_width, tmp);
1164 if (options->flags & LS_FLAG_ADMISSIBLE_ONLY) {
1165 GET_NUM_DIGITS(score, &num_digits);
1166 num_digits++; /* add one for the sign (space or "-") */
1167 w->score_width = PARA_MAX(w->score_width, num_digits);
1173 static int com_ls_callback(const struct osl_object *query,
1174 struct osl_object *ls_output)
1176 struct ls_options *opts = query->data;
1177 char *p, *pattern_start = (char *)query->data + sizeof(*opts);
1178 struct para_buffer b = {.buf = NULL, .size = 0};
1180 time_t current_time;
1183 if (opts->num_patterns) {
1184 opts->patterns = para_malloc(opts->num_patterns * sizeof(char *));
1185 for (i = 0, p = pattern_start; i < opts->num_patterns; i++) {
1186 opts->patterns[i] = p;
1190 opts->patterns = NULL;
1191 if (opts->flags & LS_FLAG_ADMISSIBLE_ONLY)
1192 ret = admissible_file_loop(opts, prepare_ls_row);
1194 ret = osl_rbtree_loop(audio_file_table, AFTCOL_PATH, opts,
1198 ret = opts->num_patterns? -E_NO_MATCH : 0;
1199 if (!opts->num_matching_paths)
1201 ret = sort_matching_paths(opts);
1204 time(¤t_time);
1205 if (opts->flags & LS_FLAG_REVERSE)
1206 for (i = opts->num_matching_paths - 1; i >= 0; i--) {
1207 ret = print_list_item(opts->data_ptr[i], opts, &b, current_time);
1212 for (i = 0; i < opts->num_matching_paths; i++) {
1213 ret = print_list_item(opts->data_ptr[i], opts, &b, current_time);
1219 ls_output->data = b.buf;
1220 ls_output->size = b.size;
1222 free(opts->data_ptr);
1223 free(opts->patterns);
1228 * TODO: flags -h (sort by hash)
1230 int com_ls(int fd, int argc, char * const * const argv)
1234 enum ls_sorting_method sort = LS_SORT_BY_PATH;
1235 enum ls_listing_mode mode = LS_MODE_SHORT;
1236 struct ls_options opts = {.patterns = NULL};
1237 struct osl_object query = {.data = &opts, .size = sizeof(opts)},
1240 for (i = 1; i < argc; i++) {
1241 const char *arg = argv[i];
1244 if (!strcmp(arg, "--")) {
1248 if (!strncmp(arg, "-l", 2)) {
1250 mode = LS_MODE_LONG;
1254 return -E_AFT_SYNTAX;
1255 switch(*(arg + 2)) {
1257 mode = LS_MODE_SHORT;
1260 mode = LS_MODE_LONG;
1263 mode = LS_MODE_VERBOSE;
1266 mode = LS_MODE_MBOX;
1269 return -E_AFT_SYNTAX;
1272 if (!strcmp(arg, "-p")) {
1273 flags |= LS_FLAG_FULL_PATH;
1276 if (!strcmp(arg, "-a")) {
1277 flags |= LS_FLAG_ADMISSIBLE_ONLY;
1280 if (!strcmp(arg, "-r")) {
1281 flags |= LS_FLAG_REVERSE;
1284 if (!strncmp(arg, "-s", 2)) {
1285 if (!*(arg + 2) || *(arg + 3))
1286 return -E_AFT_SYNTAX;
1287 switch(*(arg + 2)) {
1289 sort = LS_SORT_BY_PATH;
1291 case 's': /* -ss implies -a */
1292 sort = LS_SORT_BY_SCORE;
1293 flags |= LS_FLAG_ADMISSIBLE_ONLY;
1296 sort = LS_SORT_BY_LAST_PLAYED;
1299 sort = LS_SORT_BY_NUM_PLAYED;
1302 sort = LS_SORT_BY_FREQUENCY;
1305 sort = LS_SORT_BY_CHANNELS;
1308 sort = LS_SORT_BY_IMAGE_ID;
1311 sort = LS_SORT_BY_LYRICS_ID;
1314 sort = LS_SORT_BY_BITRATE;
1317 sort = LS_SORT_BY_DURATION;
1320 sort = LS_SORT_BY_AUDIO_FORMAT;
1323 return -E_AFT_SYNTAX;
1326 return -E_AFT_SYNTAX;
1329 opts.sorting = sort;
1331 opts.num_patterns = argc - i;
1332 ret = send_option_arg_callback_request(&query, opts.num_patterns,
1333 argv + i, com_ls_callback, &ls_output);
1335 ret = send_buffer(fd, (char *)ls_output.data);
1336 free(ls_output.data);
1342 * Call the given function for each file in the audio file table.
1344 * \param private_data An arbitrary data pointer, passed to \a func.
1345 * \param func The custom function to be called.
1347 * \return The return value of the underlying call to osl_rbtree_loop().
1349 int audio_file_loop(void *private_data, osl_rbtree_loop_func *func)
1351 return osl_rbtree_loop(audio_file_table, AFTCOL_HASH, private_data,
1355 static struct osl_row *find_hash_sister(HASH_TYPE *hash)
1357 const struct osl_object obj = {.data = hash, .size = HASH_SIZE};
1358 struct osl_row *row;
1360 osl_get_row(audio_file_table, AFTCOL_HASH, &obj, &row);
1364 enum aft_row_offsets {
1365 AFTROW_AFHI_OFFSET_POS = 0,
1366 AFTROW_CHUNKS_OFFSET_POS = 2,
1367 AFTROW_AUDIO_FORMAT_OFFSET = 4,
1368 AFTROW_FLAGS_OFFSET = 5,
1369 AFTROW_HASH_OFFSET = 9,
1370 AFTROW_PATH_OFFSET = (AFTROW_HASH_OFFSET + HASH_SIZE),
1373 /* never save the afsi, as the server knows it too. Note that afhi might be NULL.
1374 * In this case, afhi won't be stored in the buffer */
1375 static void save_audio_file_info(HASH_TYPE *hash, const char *path,
1376 struct afh_info *afhi, uint32_t flags,
1377 uint8_t audio_format_num, struct osl_object *obj)
1379 size_t path_len = strlen(path) + 1;
1380 size_t afhi_size = sizeof_afhi_buf(afhi);
1381 size_t size = AFTROW_PATH_OFFSET + path_len + afhi_size
1382 + sizeof_chunk_info_buf(afhi);
1383 char *buf = para_malloc(size);
1386 write_u8(buf + AFTROW_AUDIO_FORMAT_OFFSET, audio_format_num);
1387 write_u32(buf + AFTROW_FLAGS_OFFSET, flags);
1389 memcpy(buf + AFTROW_HASH_OFFSET, hash, HASH_SIZE);
1390 strcpy(buf + AFTROW_PATH_OFFSET, path);
1392 pos = AFTROW_PATH_OFFSET + path_len;
1393 PARA_DEBUG_LOG("size: %zu, afhi starts at %d\n", size, pos);
1394 PARA_DEBUG_LOG("last afhi byte: %p, pos %zu\n", buf + pos + afhi_size - 1,
1395 pos + afhi_size - 1);
1396 write_u16(buf + AFTROW_AFHI_OFFSET_POS, pos);
1397 save_afhi(afhi, buf + pos);
1400 PARA_DEBUG_LOG("size: %zu, chunks start at %d\n", size, pos);
1401 write_u16(buf + AFTROW_CHUNKS_OFFSET_POS, pos);
1402 save_chunk_info(afhi, buf + pos);
1403 PARA_DEBUG_LOG("last byte in buf: %p\n", buf + size - 1);
1417 AFHI: whether afhi and chunk table are computed and sent
1418 ACTION: table modifications to be performed
1420 +---+----+-----+------+---------------------------------------------------+
1421 | HS | PB | F | AFHI | ACTION
1422 +---+----+-----+------+---------------------------------------------------+
1423 | Y | Y | Y | Y | if HS != PB: remove PB. HS: force afhi update,
1424 | | update path, keep afsi
1425 +---+----+-----+------+---------------------------------------------------+
1426 | Y | Y | N | N | if HS == PB: do not send callback request at all.
1427 | | otherwise: remove PB, HS: update path, keep afhi,
1429 +---+----+-----+------+---------------------------------------------------+
1430 | Y | N | Y | Y | (rename) force afhi update of HS, update path of
1432 +---+----+-----+------+---------------------------------------------------+
1433 | Y | N | N | N | (file rename) update path of HS, keep afsi, afhi
1434 +---+----+-----+------+---------------------------------------------------+
1435 | N | Y | Y | Y | (file change) update afhi, hash, of PB, keep afsi
1436 | | (force has no effect)
1437 +---+----+-----+------+---------------------------------------------------+
1438 | N | Y | N | Y | (file change) update afhi, hash of PB, keep afsi
1439 +---+----+-----+------+---------------------------------------------------+
1440 | N | N | Y | Y | (new file) create new entry (force has no effect)
1441 +---+----+-----+------+---------------------------------------------------+
1442 | N | N | N | Y | (new file) create new entry
1443 +---+----+-----+------+---------------------------------------------------+
1445 afhi <=> force or no HS
1449 /** Flags passed to the add command. */
1450 enum com_add_flags {
1451 /** Skip paths that exist already. */
1453 /** Force adding. */
1455 /** Print what is being done. */
1456 ADD_FLAG_VERBOSE = 4,
1457 /** Try to add files with unknown suffixes. */
1461 static int com_add_callback(const struct osl_object *query,
1462 struct osl_object *result)
1464 char *buf = query->data, *path;
1465 struct osl_row *pb, *aft_row;
1467 struct osl_object objs[NUM_AFT_COLUMNS];
1469 char asc[2 * HASH_SIZE + 1];
1471 char afsi_buf[AFSI_SIZE];
1472 uint32_t flags = read_u32(buf + AFTROW_FLAGS_OFFSET);
1473 struct afs_info default_afsi = {.last_played = 0};
1474 struct para_buffer msg = {.buf = NULL};
1476 hash = (HASH_TYPE *)buf + AFTROW_HASH_OFFSET;
1477 hash_to_asc(hash, asc);;
1478 objs[AFTCOL_HASH].data = buf + AFTROW_HASH_OFFSET;
1479 objs[AFTCOL_HASH].size = HASH_SIZE;
1481 path = buf + AFTROW_PATH_OFFSET;
1482 objs[AFTCOL_PATH].data = path;
1483 objs[AFTCOL_PATH].size = strlen(path) + 1;
1485 PARA_INFO_LOG("request to add %s\n", path);
1486 hs = find_hash_sister(hash);
1487 ret = aft_get_row_of_path(path, &pb);
1488 if (ret < 0 && ret != -E_RB_KEY_NOT_FOUND)
1490 if (hs && pb && hs == pb && !(flags & ADD_FLAG_FORCE)) {
1491 if (flags & ADD_FLAG_VERBOSE)
1492 para_printf(&msg, "ignoring duplicate\n");
1496 if (hs && hs != pb) {
1497 struct osl_object obj;
1498 if (pb) { /* hs trumps pb, remove pb */
1499 if (flags & ADD_FLAG_VERBOSE)
1500 para_printf(&msg, "removing path brother\n");
1501 ret = osl_del_row(audio_file_table, pb);
1506 /* file rename, update hs' path */
1507 if (flags & ADD_FLAG_VERBOSE) {
1508 ret = osl_get_object(audio_file_table, hs,
1512 para_printf(&msg, "renamed from %s\n", (char *)obj.data);
1514 ret = osl_update_object(audio_file_table, hs, AFTCOL_PATH,
1515 &objs[AFTCOL_PATH]);
1518 afs_event(AUDIO_FILE_RENAME, &msg, hs);
1519 if (!(flags & ADD_FLAG_FORCE))
1522 /* no hs or force mode, child must have sent afhi */
1523 uint16_t afhi_offset = read_u16(buf + AFTROW_AFHI_OFFSET_POS);
1524 uint16_t chunks_offset = read_u16(buf + AFTROW_CHUNKS_OFFSET_POS);
1526 objs[AFTCOL_AFHI].data = buf + afhi_offset;
1527 objs[AFTCOL_AFHI].size = chunks_offset - afhi_offset;
1529 if (!objs[AFTCOL_AFHI].size) /* "impossible" */
1531 objs[AFTCOL_CHUNKS].data = buf + chunks_offset;
1532 objs[AFTCOL_CHUNKS].size = query->size - chunks_offset;
1533 if (pb && !hs) { /* update pb's hash */
1534 char old_asc[2 * HASH_SIZE + 1];
1535 HASH_TYPE *old_hash;
1536 ret = get_hash_of_row(pb, &old_hash);
1539 hash_to_asc(old_hash, old_asc);
1540 if (flags & ADD_FLAG_VERBOSE)
1541 para_printf(&msg, "file change: %s -> %s\n",
1543 ret = osl_update_object(audio_file_table, pb, AFTCOL_HASH,
1544 &objs[AFTCOL_HASH]);
1548 if (hs || pb) { /* (hs != NULL and pb != NULL) implies hs == pb */
1549 struct osl_row *row = pb? pb : hs;
1550 /* update afhi and chunk_table */
1551 if (flags & ADD_FLAG_VERBOSE)
1552 para_printf(&msg, "updating afhi and chunk table\n");
1553 ret = osl_update_object(audio_file_table, row, AFTCOL_AFHI,
1554 &objs[AFTCOL_AFHI]);
1557 ret = osl_update_object(audio_file_table, row, AFTCOL_CHUNKS,
1558 &objs[AFTCOL_CHUNKS]);
1561 afs_event(AFHI_CHANGE, &msg, row);
1564 /* new entry, use default afsi */
1565 if (flags & ADD_FLAG_VERBOSE)
1566 para_printf(&msg, "new file\n");
1567 default_afsi.last_played = time(NULL) - 365 * 24 * 60 * 60;
1568 default_afsi.audio_format_id = read_u8(buf + AFTROW_AUDIO_FORMAT_OFFSET);
1570 objs[AFTCOL_AFSI].data = &afsi_buf;
1571 objs[AFTCOL_AFSI].size = AFSI_SIZE;
1572 save_afsi(&default_afsi, &objs[AFTCOL_AFSI]);
1573 ret = osl_add_and_get_row(audio_file_table, objs, &aft_row);
1576 para_printf(&msg, "%s\n", PARA_STRERROR(-ret));
1579 result->data = msg.buf;
1580 result->size = msg.size;
1581 afs_event(AUDIO_FILE_ADD, &msg, aft_row);
1585 /** Used by com_add(). */
1586 struct private_add_data {
1587 /** The socket file descriptor. */
1589 /** The given add flags. */
1593 static int path_brother_callback(const struct osl_object *query,
1594 struct osl_object *result)
1596 char *path = query->data;
1597 struct osl_row *path_brother;
1598 int ret = aft_get_row_of_path(path, &path_brother);
1601 result->data = para_malloc(sizeof(path_brother));
1602 result->size = sizeof(path_brother);
1603 *(struct osl_row **)(result->data) = path_brother;
1607 static int hash_sister_callback(const struct osl_object *query,
1608 struct osl_object *result)
1610 HASH_TYPE *hash = query->data;
1611 struct osl_row *hash_sister;
1613 hash_sister = find_hash_sister(hash);
1615 return -E_RB_KEY_NOT_FOUND;
1616 result->data = para_malloc(sizeof(hash_sister));
1617 result->size = sizeof(hash_sister);
1618 *(struct osl_row **)(result->data) = hash_sister;
1622 static int add_one_audio_file(const char *path, const void *private_data)
1625 uint8_t format_num = -1;
1626 const struct private_add_data *pad = private_data;
1627 struct afh_info afhi, *afhi_ptr = NULL;
1628 struct osl_row *pb = NULL, *hs = NULL; /* path brother/hash sister */
1629 struct osl_object map, obj = {.data = NULL}, query, result = {.data = NULL};
1630 HASH_TYPE hash[HASH_SIZE];
1632 afhi.header_offset = 0;
1633 afhi.header_len = 0;
1634 ret = guess_audio_format(path);
1635 if (ret < 0 && !(pad->flags & ADD_FLAG_ALL))
1637 query.data = (char *)path;
1638 query.size = strlen(path) + 1;
1639 ret = send_callback_request(path_brother_callback, &query, &result);
1640 if (ret < 0 && ret != -E_RB_KEY_NOT_FOUND)
1643 pb = *(struct osl_row **)result.data;
1647 if (pb && (pad->flags & ADD_FLAG_LAZY)) { /* lazy is really cheap */
1648 if (pad->flags & ADD_FLAG_VERBOSE)
1649 ret = send_va_buffer(pad->fd, "lazy-ignore: %s\n", path);
1652 /* We still want to add this file. Compute its hash. */
1653 ret = mmap_full_file(path, O_RDONLY, &map.data, &map.size, NULL);
1656 hash_function(map.data, map.size, hash);
1658 /* Check whether database contains file with the same hash. */
1660 query.size = HASH_SIZE;
1661 ret = send_callback_request(hash_sister_callback, &query, &result);
1662 if (ret < 0 && ret != -E_RB_KEY_NOT_FOUND)
1665 hs = *(struct osl_row **)result.data;
1668 /* Return success if we already know this file. */
1670 if (pb && hs && hs == pb && (!(pad->flags & ADD_FLAG_FORCE))) {
1671 if (pad->flags & ADD_FLAG_VERBOSE)
1672 ret = send_va_buffer(pad->fd,
1673 "%s exists, not forcing update\n", path);
1677 * we won't recalculate the audio format info and the chunk table if
1678 * there is a hash sister unless in FORCE mode.
1680 if (!hs || (pad->flags & ADD_FLAG_FORCE)) {
1681 ret = compute_afhi(path, map.data, map.size, &afhi);
1687 if (pad->flags & ADD_FLAG_VERBOSE) {
1688 ret = send_va_buffer(pad->fd, "adding %s\n", path);
1692 munmap(map.data, map.size);
1693 save_audio_file_info(hash, path, afhi_ptr, pad->flags, format_num, &obj);
1694 /* Ask afs to consider this entry for adding. */
1695 ret = send_callback_request(com_add_callback, &obj, &result);
1696 if (ret >= 0 && result.data && result.size) {
1697 ret2 = send_va_buffer(pad->fd, "%s", (char *)result.data);
1699 if (ret >= 0 && ret2 < 0)
1705 munmap(map.data, map.size);
1707 if (ret < 0 && ret != -E_SEND)
1708 send_va_buffer(pad->fd, "failed to add %s (%s)\n", path,
1709 PARA_STRERROR(-ret));
1712 free(afhi_ptr->chunk_table);
1713 /* it's not an error if not all files could be added */
1714 return ret == -E_SEND? ret : 1;
1717 int com_add(int fd, int argc, char * const * const argv)
1720 struct private_add_data pad = {.fd = fd, .flags = 0};
1721 struct stat statbuf;
1723 for (i = 1; i < argc; i++) {
1724 const char *arg = argv[i];
1727 if (!strcmp(arg, "--")) {
1731 if (!strcmp(arg, "-a")) {
1732 pad.flags |= ADD_FLAG_ALL;
1735 if (!strcmp(arg, "-l")) {
1736 pad.flags |= ADD_FLAG_LAZY;
1739 if (!strcmp(arg, "-f")) {
1740 pad.flags |= ADD_FLAG_FORCE;
1743 if (!strcmp(arg, "-v")) {
1744 pad.flags |= ADD_FLAG_VERBOSE;
1749 return -E_AFT_SYNTAX;
1750 for (; i < argc; i++) {
1752 ret = verify_path(argv[i], &path);
1754 ret = send_va_buffer(fd, "%s: %s\n", argv[i], PARA_STRERROR(-ret));
1759 ret = stat(path, &statbuf);
1761 ret = send_va_buffer(fd, "failed to stat %s (%s)\n", path,
1768 if (S_ISDIR(statbuf.st_mode))
1769 ret = for_each_file_in_dir(path, add_one_audio_file,
1772 ret = add_one_audio_file(path, &pad);
1774 send_va_buffer(fd, "%s: %s\n", path, PARA_STRERROR(-ret));
1785 * Flags used by the touch command.
1790 /** Whether the \p FNM_PATHNAME flag should be passed to fnmatch(). */
1791 TOUCH_FLAG_FNM_PATHNAME = 1,
1792 /** Activates verbose mode. */
1793 TOUCH_FLAG_VERBOSE = 2
1796 /** Options used by com_touch(). */
1797 struct com_touch_options {
1798 /** New num_played value. */
1800 /** New last played count. */
1801 int64_t last_played;
1802 /** new lyrics id. */
1804 /** new image id. */
1806 /** command line flags (see \ref touch_flags). */
1810 /** Data passed to the action handler of com_touch(). */
1811 struct touch_action_data {
1812 /** Command line options (see \ref com_touch_options). */
1813 struct com_touch_options *cto;
1814 /** Message buffer. */
1815 struct para_buffer pb;
1818 static int touch_audio_file(__a_unused struct osl_table *table,
1819 struct osl_row *row, const char *name, void *data)
1821 struct touch_action_data *tad = data;
1822 struct osl_object obj;
1823 struct afs_info old_afsi, new_afsi;
1824 int ret, no_options = tad->cto->num_played < 0 && tad->cto->last_played < 0 &&
1825 tad->cto->lyrics_id < 0 && tad->cto->image_id < 0;
1826 struct afsi_change_event_data aced;
1828 ret = get_afsi_object_of_row(row, &obj);
1830 para_printf(&tad->pb, "%s: %s\n", name, PARA_STRERROR(-ret));
1833 ret = load_afsi(&old_afsi, &obj);
1835 para_printf(&tad->pb, "%s: %s\n", name, PARA_STRERROR(-ret));
1838 new_afsi = old_afsi;
1840 new_afsi.num_played++;
1841 new_afsi.last_played = time(NULL);
1842 if (tad->cto->flags & TOUCH_FLAG_VERBOSE)
1843 para_printf(&tad->pb, "%s: num_played = %u, "
1844 "last_played = now()\n", name,
1845 new_afsi.num_played);
1847 if (tad->cto->flags & TOUCH_FLAG_VERBOSE)
1848 para_printf(&tad->pb, "touching %s\n", name);
1849 if (tad->cto->lyrics_id >= 0)
1850 new_afsi.lyrics_id = tad->cto->lyrics_id;
1851 if (tad->cto->image_id >= 0)
1852 new_afsi.image_id = tad->cto->image_id;
1853 if (tad->cto->num_played >= 0)
1854 new_afsi.num_played = tad->cto->num_played;
1855 if (tad->cto->last_played >= 0)
1856 new_afsi.last_played = tad->cto->last_played;
1858 save_afsi(&new_afsi, &obj); /* in-place update */
1860 aced.old_afsi = &old_afsi;
1861 afs_event(AFSI_CHANGE, &tad->pb, &aced);
1865 static int com_touch_callback(const struct osl_object *query,
1866 struct osl_object *result)
1868 struct touch_action_data tad = {.cto = query->data};
1870 struct pattern_match_data pmd = {
1871 .table = audio_file_table,
1872 .loop_col_num = AFTCOL_HASH,
1873 .match_col_num = AFTCOL_PATH,
1874 .patterns = {.data = (char *)query->data + sizeof(*tad.cto),
1875 .size = query->size - sizeof(*tad.cto)},
1877 .action = touch_audio_file
1879 if (tad.cto->flags & TOUCH_FLAG_FNM_PATHNAME)
1880 pmd.fnmatch_flags |= FNM_PATHNAME;
1881 ret = for_each_matching_row(&pmd);
1883 para_printf(&tad.pb, "%s\n", PARA_STRERROR(-ret));
1885 result->data = tad.pb.buf;
1886 result->size = tad.pb.size;
1889 return ret < 0? ret : 0;
1892 int com_touch(int fd, int argc, char * const * const argv)
1894 struct com_touch_options cto = {
1900 struct osl_object query = {.data = &cto, .size = sizeof(cto)},
1905 for (i = 1; i < argc; i++) {
1906 const char *arg = argv[i];
1909 if (!strcmp(arg, "--")) {
1913 if (!strncmp(arg, "-n", 2)) {
1914 ret = para_atoi32(arg + 2, &cto.num_played);
1919 if (!strncmp(arg, "-l", 2)) {
1920 ret = para_atoi64(arg + 2, &cto.last_played);
1925 if (!strncmp(arg, "-y", 2)) {
1926 ret = para_atoi32(arg + 2, &cto.lyrics_id);
1931 if (!strncmp(arg, "-i", 2)) {
1932 ret = para_atoi32(arg + 2, &cto.image_id);
1937 if (!strcmp(arg, "-p")) {
1938 cto.flags |= TOUCH_FLAG_FNM_PATHNAME;
1941 if (!strcmp(arg, "-v")) {
1942 cto.flags |= TOUCH_FLAG_VERBOSE;
1945 break; /* non-option starting with dash */
1948 return -E_AFT_SYNTAX;
1949 ret = send_option_arg_callback_request(&query, argc - i,
1950 argv + i, com_touch_callback, &result);
1952 send_buffer(fd, (char *)result.data);
1955 send_va_buffer(fd, "%s\n", PARA_STRERROR(-ret));
1959 /** Flags for com_rm(). */
1962 RM_FLAG_VERBOSE = 1,
1966 RM_FLAG_FNM_PATHNAME = 4
1969 /** Data passed to the action handler of com_rm(). */
1970 struct com_rm_action_data {
1971 /** Command line flags ((see \ref rm_flags). */
1973 /** Message buffer. */
1974 struct para_buffer pb;
1975 /** Number of audio files removed. */
1976 unsigned num_removed;
1979 static int remove_audio_file(__a_unused struct osl_table *table,
1980 struct osl_row *row, const char *name, void *data)
1982 struct com_rm_action_data *crd = data;
1985 if (crd->flags & RM_FLAG_VERBOSE)
1986 para_printf(&crd->pb, "removing %s\n", name);
1987 afs_event(AUDIO_FILE_REMOVE, &crd->pb, row);
1988 ret = osl_del_row(audio_file_table, row);
1990 para_printf(&crd->pb, "%s: %s\n", name, PARA_STRERROR(-ret));
1996 static int com_rm_callback(const struct osl_object *query,
1997 __a_unused struct osl_object *result)
1999 struct com_rm_action_data crd = {.flags = *(uint32_t *)query->data};
2001 struct pattern_match_data pmd = {
2002 .table = audio_file_table,
2003 .loop_col_num = AFTCOL_HASH,
2004 .match_col_num = AFTCOL_PATH,
2005 .patterns = {.data = (char *)query->data + sizeof(uint32_t),
2006 .size = query->size - sizeof(uint32_t)},
2008 .action = remove_audio_file
2010 if (crd.flags & RM_FLAG_FNM_PATHNAME)
2011 pmd.fnmatch_flags |= FNM_PATHNAME;
2012 ret = for_each_matching_row(&pmd);
2014 para_printf(&crd.pb, "%s\n", PARA_STRERROR(-ret));
2015 if (!crd.num_removed && !(crd.flags & RM_FLAG_FORCE))
2016 para_printf(&crd.pb, "no matches -- nothing removed\n");
2018 if (crd.flags & RM_FLAG_VERBOSE)
2019 para_printf(&crd.pb, "removed %u files\n", crd.num_removed);
2022 result->data = crd.pb.buf;
2023 result->size = crd.pb.size;
2026 return ret < 0? ret : 0;
2029 /* TODO options: -r (recursive) */
2030 int com_rm(int fd, int argc, char * const * const argv)
2033 struct osl_object query = {.data = &flags, .size = sizeof(flags)},
2037 for (i = 1; i < argc; i++) {
2038 const char *arg = argv[i];
2041 if (!strcmp(arg, "--")) {
2045 if (!strcmp(arg, "-f")) {
2046 flags |= RM_FLAG_FORCE;
2049 if (!strcmp(arg, "-p")) {
2050 flags |= RM_FLAG_FNM_PATHNAME;
2053 if (!strcmp(arg, "-v")) {
2054 flags |= RM_FLAG_VERBOSE;
2060 return -E_AFT_SYNTAX;
2061 ret = send_option_arg_callback_request(&query, argc - i, argv + i,
2062 com_rm_callback, &result);
2064 send_buffer(fd, (char *)result.data);
2067 send_va_buffer(fd, "%s\n", PARA_STRERROR(-ret));
2072 * Flags used by the cpsi command.
2077 /** Whether the lyrics id should be copied. */
2078 CPSI_FLAG_COPY_LYRICS_ID = 1,
2079 /** Whether the image id should be copied. */
2080 CPSI_FLAG_COPY_IMAGE_ID = 2,
2081 /** Whether the lastplayed time should be copied. */
2082 CPSI_FLAG_COPY_LASTPLAYED = 4,
2083 /** Whether the numplayed count should be copied. */
2084 CPSI_FLAG_COPY_NUMPLAYED = 8,
2085 /** Whether the attributes should be copied. */
2086 CPSI_FLAG_COPY_ATTRIBUTES = 16,
2087 /** Activates verbose mode. */
2088 CPSI_FLAG_VERBOSE = 32,
2091 /** Data passed to the action handler of com_cpsi(). */
2092 struct cpsi_action_data {
2093 /** command line flags (see \ref cpsi_flags). */
2095 /** Number of audio files changed. */
2096 unsigned num_copied;
2097 /** Message buffer. */
2098 struct para_buffer pb;
2099 /** Values are copied from here. */
2100 struct afs_info source_afsi;
2103 static int copy_selector_info(__a_unused struct osl_table *table,
2104 struct osl_row *row, const char *name, void *data)
2106 struct cpsi_action_data *cad = data;
2107 struct osl_object target_afsi_obj;
2109 struct afs_info old_afsi, target_afsi;
2110 struct afsi_change_event_data aced;
2112 ret = get_afsi_object_of_row(row, &target_afsi_obj);
2115 load_afsi(&target_afsi, &target_afsi_obj);
2116 old_afsi = target_afsi;
2117 if (cad->flags & CPSI_FLAG_COPY_LYRICS_ID)
2118 target_afsi.lyrics_id = cad->source_afsi.lyrics_id;
2119 if (cad->flags & CPSI_FLAG_COPY_IMAGE_ID)
2120 target_afsi.image_id = cad->source_afsi.image_id;
2121 if (cad->flags & CPSI_FLAG_COPY_LASTPLAYED)
2122 target_afsi.last_played = cad->source_afsi.last_played;
2123 if (cad->flags & CPSI_FLAG_COPY_NUMPLAYED)
2124 target_afsi.num_played = cad->source_afsi.num_played;
2125 if (cad->flags & CPSI_FLAG_COPY_ATTRIBUTES)
2126 target_afsi.attributes = cad->source_afsi.attributes;
2127 save_afsi(&target_afsi, &target_afsi_obj); /* in-place update */
2129 if (cad->flags & CPSI_FLAG_VERBOSE)
2130 para_printf(&cad->pb, "copied afsi to %s\n", name);
2132 aced.old_afsi = &old_afsi;
2133 afs_event(AFSI_CHANGE, &cad->pb, &aced);
2137 static int com_cpsi_callback(const struct osl_object *query,
2138 struct osl_object *result)
2140 struct cpsi_action_data cad = {.flags = *(unsigned *)query->data};
2142 char *source_path = (char *)query->data + sizeof(cad.flags);
2144 ret = get_afsi_of_path(source_path, &cad.source_afsi);
2147 struct pattern_match_data pmd = {
2148 .table = audio_file_table,
2149 .loop_col_num = AFTCOL_HASH,
2150 .match_col_num = AFTCOL_PATH,
2151 .patterns = {.data = source_path + strlen(source_path) + 1,
2152 .size = query->size - sizeof(cad.flags)
2153 - strlen(source_path) - 1},
2155 .action = copy_selector_info
2157 ret = for_each_matching_row(&pmd);
2160 para_printf(&cad.pb, "%s\n", PARA_STRERROR(-ret));
2161 if (cad.flags & CPSI_FLAG_VERBOSE) {
2163 para_printf(&cad.pb, "copied requested afsi from %s "
2165 source_path, cad.num_copied);
2167 para_printf(&cad.pb, "nothing copied\n");
2170 result->data = cad.pb.buf;
2171 result->size = cad.pb.size;
2174 return ret < 0? ret : 0;
2177 int com_cpsi(int fd, int argc, char * const * const argv)
2181 struct osl_object options = {.data = &flags, .size = sizeof(flags)},
2184 for (i = 1; i < argc; i++) {
2185 const char *arg = argv[i];
2188 if (!strcmp(arg, "--")) {
2192 if (!strcmp(arg, "-y")) {
2193 flags |= CPSI_FLAG_COPY_LYRICS_ID;
2196 if (!strcmp(arg, "-i")) {
2197 flags |= CPSI_FLAG_COPY_IMAGE_ID;
2200 if (!strcmp(arg, "-l")) {
2201 flags |= CPSI_FLAG_COPY_LASTPLAYED;
2204 if (!strcmp(arg, "-n")) {
2205 flags |= CPSI_FLAG_COPY_NUMPLAYED;
2208 if (!strcmp(arg, "-a")) {
2209 flags |= CPSI_FLAG_COPY_ATTRIBUTES;
2212 if (!strcmp(arg, "-v")) {
2213 flags |= CPSI_FLAG_VERBOSE;
2218 if (i + 1 >= argc) /* need at least souce file and pattern */
2219 return -E_AFT_SYNTAX;
2220 if (!(flags & ~CPSI_FLAG_VERBOSE)) /* no copy flags given */
2221 flags = ~(unsigned)CPSI_FLAG_VERBOSE | flags;
2222 ret = send_option_arg_callback_request(&options, argc - i, argv + i,
2223 com_cpsi_callback, &result);
2225 send_buffer(fd, (char *)result.data);
2228 send_va_buffer(fd, "%s\n", PARA_STRERROR(-ret));
2232 /* TODO: optionally fix problems by removing offending rows */
2233 static int check_audio_file(struct osl_row *row, void *data)
2236 struct para_buffer *pb = data;
2237 struct stat statbuf;
2238 int ret = get_audio_file_path_of_row(row, &path);
2239 struct afs_info afsi;
2243 para_printf(pb, "%s\n", PARA_STRERROR(-ret));
2246 if (stat(path, &statbuf) < 0)
2247 para_printf(pb, "%s: stat error (%s)\n", path, strerror(errno));
2249 if (!S_ISREG(statbuf.st_mode))
2250 para_printf(pb, "%s: not a regular file\n", path);
2252 ret = get_afsi_of_row(row, &afsi);
2254 para_printf(pb, "%s: %s\n", path, PARA_STRERROR(-ret));
2257 ret = lyr_get_name_by_id(afsi.lyrics_id, &blob_name);
2259 para_printf(pb, "%s lyrics id %u: %s\n", path, afsi.lyrics_id,
2260 PARA_STRERROR(-ret));
2261 ret = img_get_name_by_id(afsi.image_id, &blob_name);
2263 para_printf(pb, "%s image id %u: %s\n", path, afsi.image_id,
2264 PARA_STRERROR(-ret));
2269 * Check the audio file table for inconsistencies.
2271 * \param query Unused.
2272 * \param result Contains message string upon return.
2274 * This function always succeeds.
2278 int aft_check_callback(__a_unused const struct osl_object *query, struct osl_object *result)
2280 struct para_buffer pb = {.buf = NULL};
2282 para_printf(&pb, "checking audio file table...\n");
2283 audio_file_loop(&pb, check_audio_file);
2284 result->data = pb.buf;
2285 result->size = pb.size;
2291 * Close the audio file table.
2293 * \param flags Usual flags that are passed to osl_close_table().
2295 * \sa osl_close_table().
2297 static void aft_close(void)
2299 osl_close_table(audio_file_table, OSL_MARK_CLEAN);
2300 audio_file_table = NULL;
2304 * Open the audio file table.
2306 * \param dir The database directory.
2310 * \sa osl_open_table().
2312 static int aft_open(const char *dir)
2316 audio_file_table_desc.dir = dir;
2317 ret = osl_open_table(&audio_file_table_desc, &audio_file_table);
2320 osl_get_num_rows(audio_file_table, &num);
2321 PARA_INFO_LOG("audio file table contains %d files\n", num);
2324 PARA_INFO_LOG("failed to open audio file table\n");
2325 audio_file_table = NULL;
2326 if (ret >= 0 || is_errno(-ret, ENOENT))
2331 static int aft_create(const char *dir)
2333 audio_file_table_desc.dir = dir;
2334 return osl_create_table(&audio_file_table_desc);
2337 static int clear_attribute(struct osl_row *row, void *data)
2339 struct rmatt_event_data *red = data;
2340 struct afs_info afsi;
2341 struct osl_object obj;
2342 int ret = get_afsi_object_of_row(row, &obj);
2343 uint64_t mask = ~(1ULL << red->bitnum);
2347 ret = load_afsi(&afsi, &obj);
2350 afsi.attributes &= mask;
2351 save_afsi(&afsi, &obj);
2355 static int aft_event_handler(enum afs_events event, struct para_buffer *pb,
2359 case ATTRIBUTE_REMOVE: {
2360 const struct rmatt_event_data *red = data;
2361 para_printf(pb, "clearing attribute %s (bit %u) from all "
2362 "entries in the audio file table\n", red->name,
2364 return audio_file_loop(data, clear_attribute);
2371 void aft_init(struct afs_table *t)
2373 t->name = audio_file_table_desc.name;
2375 t->close = aft_close;
2376 t->create = aft_create;
2377 t->event_handler = aft_event_handler;