2 * Copyright (C) 2007 Andre Noll <maan@tuebingen.mpg.de>
4 * Licensed under the GPL v2. For licencing details see COPYING.
7 /** \file aft.c Audio file table functions. */
23 #include "portable_io.h"
27 static struct osl_table *audio_file_table;
28 static char *status_items;
29 static char *parser_friendly_status_items;
31 /** The different sorting methods of the ls command. */
32 enum ls_sorting_method {
38 LS_SORT_BY_LAST_PLAYED,
40 LS_SORT_BY_NUM_PLAYED,
54 LS_SORT_BY_AUDIO_FORMAT,
59 /** The different listing modes of the ls command. */
60 enum ls_listing_mode {
61 /** Default listing mode. */
75 /* Data about one audio file. Needed for ls and stat output. */
77 /* Usual audio format handler information. */
79 /* Audio file selector information. */
81 /* The full path of the audio file. */
83 /* The score value (if -a was given). */
85 /* The hash value of the audio file data. */
89 /** The flags accepted by the ls command. */
92 LS_FLAG_FULL_PATH = 1,
94 LS_FLAG_ADMISSIBLE_ONLY = 2,
102 * The size of the individual output fields of the ls command.
104 * These depend on the content being listed. For example, if each listed file
105 * is shorter than an hour, the duration format is set to mm:ss. Otherwise it
106 * is set to hh:mm:ss.
109 /** size of the score field. */
110 unsigned short score_width;
111 /** size of the image id field. */
112 unsigned short image_id_width;
113 /** size of the lyrics id field. */
114 unsigned short lyrics_id_width;
115 /** size of the bitrate field. */
116 unsigned short bitrate_width;
117 /** size of the frequency field. */
118 unsigned short frequency_width;
119 /** size of the duration field. */
120 unsigned short duration_width;
121 /** size of the num played field. */
122 unsigned short num_played_width;
123 /** size of the amp field. */
124 unsigned short amp_width;
125 /** size of the audio format field. */
126 unsigned short audio_format_width;
129 /** Data passed from the ls command handler to its callback function. */
131 /** The given command line flags. */
133 /** The sorting method given at the command line. */
134 enum ls_sorting_method sorting;
135 /** The given listing mode (short, long, verbose, mbox). */
136 enum ls_listing_mode mode;
137 /** The arguments passed to the ls command. */
139 /** Number of non-option arguments. */
141 /** Used for long listing mode to align the output fields. */
142 struct ls_widths widths;
143 /** Size of the \a data array. */
145 /** Number of used entries in the data array. */
146 uint32_t num_matching_paths;
147 /** Array of matching entries. */
148 struct ls_data *data;
149 /** Used to sort the array. */
150 struct ls_data **data_ptr;
154 * Describes the layout of the mmapped-afs info struct.
156 * \sa struct afs_info.
159 /** Where .last_played is stored. */
160 AFSI_LAST_PLAYED_OFFSET = 0,
161 /** Storage position of the attributes bitmap. */
162 AFSI_ATTRIBUTES_OFFSET = 8,
163 /** Storage position of the .num_played field. */
164 AFSI_NUM_PLAYED_OFFSET = 16,
165 /** Storage position of the .image_id field. */
166 AFSI_IMAGE_ID_OFFSET = 20,
167 /** Storage position of the .lyrics_id field. */
168 AFSI_LYRICS_ID_OFFSET = 24,
169 /** Storage position of the .audio_format_id field. */
170 AFSI_AUDIO_FORMAT_ID_OFFSET = 28,
171 /** Storage position of the amplification field. */
172 AFSI_AMP_OFFSET = 29,
173 /** 2 bytes reserved space for future usage. */
174 AFSI_AUDIO_FORMAT_UNUSED_OFFSET = 30,
175 /** On-disk storage space needed. */
180 * Convert a struct afs_info to an osl object.
182 * \param afsi Pointer to the audio file info to be converted.
183 * \param obj Result pointer.
187 static void save_afsi(struct afs_info *afsi, struct osl_object *obj)
189 char *buf = obj->data;
191 write_u64(buf + AFSI_LAST_PLAYED_OFFSET, afsi->last_played);
192 write_u64(buf + AFSI_ATTRIBUTES_OFFSET, afsi->attributes);
193 write_u32(buf + AFSI_NUM_PLAYED_OFFSET, afsi->num_played);
194 write_u32(buf + AFSI_IMAGE_ID_OFFSET, afsi->image_id);
195 write_u32(buf + AFSI_LYRICS_ID_OFFSET, afsi->lyrics_id);
196 write_u8(buf + AFSI_AUDIO_FORMAT_ID_OFFSET,
197 afsi->audio_format_id);
198 write_u8(buf + AFSI_AMP_OFFSET, afsi->amp);
199 memset(buf + AFSI_AUDIO_FORMAT_UNUSED_OFFSET, 0, 2);
203 * Get the audio file selector info struct stored in an osl object.
205 * \param afsi Points to the audio_file info structure to be filled in.
206 * \param obj The osl object holding the data.
212 static int load_afsi(struct afs_info *afsi, struct osl_object *obj)
214 char *buf = obj->data;
215 if (obj->size < AFSI_SIZE)
217 afsi->last_played = read_u64(buf + AFSI_LAST_PLAYED_OFFSET);
218 afsi->attributes = read_u64(buf + AFSI_ATTRIBUTES_OFFSET);
219 afsi->num_played = read_u32(buf + AFSI_NUM_PLAYED_OFFSET);
220 afsi->image_id = read_u32(buf + AFSI_IMAGE_ID_OFFSET);
221 afsi->lyrics_id = read_u32(buf + AFSI_LYRICS_ID_OFFSET);
222 afsi->audio_format_id = read_u8(buf +
223 AFSI_AUDIO_FORMAT_ID_OFFSET);
224 afsi->amp = read_u8(buf + AFSI_AMP_OFFSET);
228 /** The columns of the audio file table. */
229 enum audio_file_table_columns {
230 /** The hash on the content of the audio file. */
232 /** The full path in the filesystem. */
234 /** The audio file selector info. */
236 /** The audio format handler info. */
238 /** The chunk table info and the chunk table of the audio file. */
240 /** The number of columns of this table. */
245 * Compare two osl objects pointing to hash values.
247 * \param obj1 Pointer to the first hash object.
248 * \param obj2 Pointer to the second hash object.
250 * \return The values required for an osl compare function.
252 * \sa osl_compare_func, uint32_compare().
254 static int aft_hash_compare(const struct osl_object *obj1, const struct osl_object *obj2)
256 return hash_compare((unsigned char *)obj1->data, (unsigned char *)obj2->data);
259 static struct osl_column_description aft_cols[] = {
261 .storage_type = OSL_MAPPED_STORAGE,
262 .storage_flags = OSL_RBTREE | OSL_FIXED_SIZE | OSL_UNIQUE,
264 .compare_function = aft_hash_compare,
265 .data_size = HASH_SIZE
268 .storage_type = OSL_MAPPED_STORAGE,
269 .storage_flags = OSL_RBTREE | OSL_UNIQUE,
271 .compare_function = string_compare,
274 .storage_type = OSL_MAPPED_STORAGE,
275 .storage_flags = OSL_FIXED_SIZE,
277 .data_size = AFSI_SIZE
280 .storage_type = OSL_MAPPED_STORAGE,
284 .storage_type = OSL_DISK_STORAGE,
289 static struct osl_table_description audio_file_table_desc = {
290 .name = "audio_files",
291 .num_columns = NUM_AFT_COLUMNS,
292 .flags = OSL_LARGE_TABLE,
293 .column_descriptions = aft_cols
296 /* We don't want dot or dot-dot anywhere. */
297 static int verify_dotfile(const char *rest)
300 * The first character was '.', but that has already been discarded, we
304 case '\0': case '/': /* /foo/. and /foo/./bar are not ok */
306 case '.': /* path start with /foo/.. */
307 if (rest[1] == '\0' || rest[1] == '/')
308 return -1; /* /foo/.. or /foo/../bar are not ok */
309 /* /foo/..bar is ok */
315 * We fundamentally don't like some paths: We don't want double slashes or
316 * slashes at the end that can make pathnames ambiguous.
318 static int verify_path(const char *orig_path, char **resolved_path)
324 if (*orig_path != '/') /* we only accept absolute paths */
326 len = strlen(orig_path);
327 *resolved_path = para_strdup(orig_path);
328 path = *resolved_path;
329 while (len > 1 && path[--len] == '/')
330 path[len] = '\0'; /* remove slash at the end */
336 case '/': /* double slash */
339 if (verify_dotfile(path) < 0)
349 free(*resolved_path);
353 /** The on-disk layout of a afhi struct. */
355 /** Where the number of seconds is stored. */
356 AFHI_SECONDS_TOTAL_OFFSET = 0,
357 /** Position of the bitrate. */
358 AFHI_BITRATE_OFFSET = 4,
359 /** Position of the frequency. */
360 AFHI_FREQUENCY_OFFSET = 8,
361 /** Was: Location of the audio file header. */
362 AFHI_UNUSED1_OFFSET = 12,
363 /* Length of the audio file header. Zero means: No header. */
364 AFHI_HEADER_LEN_OFFSET = 16,
365 /** The total number of chunks (4 bytes). */
366 CHUNKS_TOTAL_OFFSET = 20,
367 /** The length of the audio file header (4 bytes). */
368 HEADER_LEN_OFFSET = 24,
369 /** Was: The start of the audio file header (4 bytes). */
370 AFHI_UNUSED2_OFFSET = 28,
371 /** The seconds part of the chunk time (4 bytes). */
372 CHUNK_TV_TV_SEC_OFFSET = 32,
373 /** The microseconds part of the chunk time (4 bytes). */
374 CHUNK_TV_TV_USEC_OFFSET = 36,
375 /** Number of channels is stored here. (1 byte) */
376 AFHI_CHANNELS_OFFSET = 40,
377 /** The tag info position. */
378 AFHI_INFO_STRING_OFFSET = 41,
379 /** Minimal on-disk size of a valid afhi struct. */
380 MIN_AFHI_SIZE = 47, /* at least 6 null bytes for techinfo/tags */
383 static unsigned sizeof_afhi_buf(const struct afh_info *afhi)
388 + strlen(afhi->techinfo)
389 + strlen(afhi->tags.artist)
390 + strlen(afhi->tags.title)
391 + strlen(afhi->tags.year)
392 + strlen(afhi->tags.album)
393 + strlen(afhi->tags.comment);
396 static void save_afhi(struct afh_info *afhi, char *buf)
402 write_u32(buf + AFHI_SECONDS_TOTAL_OFFSET, afhi->seconds_total);
403 write_u32(buf + AFHI_BITRATE_OFFSET, afhi->bitrate);
404 write_u32(buf + AFHI_FREQUENCY_OFFSET, afhi->frequency);
405 write_u32(buf + AFHI_UNUSED1_OFFSET, 0);
406 write_u32(buf + AFHI_HEADER_LEN_OFFSET, afhi->header_len);
407 write_u8(buf + AFHI_CHANNELS_OFFSET, afhi->channels);
408 write_u32(buf + CHUNKS_TOTAL_OFFSET, afhi->chunks_total);
409 write_u32(buf + HEADER_LEN_OFFSET, afhi->header_len);
410 write_u32(buf + AFHI_UNUSED2_OFFSET, 0);
411 write_u32(buf + CHUNK_TV_TV_SEC_OFFSET, afhi->chunk_tv.tv_sec);
412 write_u32(buf + CHUNK_TV_TV_USEC_OFFSET, afhi->chunk_tv.tv_usec);
413 p = buf + AFHI_INFO_STRING_OFFSET;
414 /* The sprintf's below are OK as our caller made sure that buf is large enough */
415 p += sprintf(p, "%s", afhi->techinfo) + 1;
416 p += sprintf(p, "%s", afhi->tags.artist) + 1;
417 p += sprintf(p, "%s", afhi->tags.title) + 1;
418 p += sprintf(p, "%s", afhi->tags.year) + 1;
419 p += sprintf(p, "%s", afhi->tags.album) + 1;
420 sprintf(p, "%s", afhi->tags.comment);
423 static void load_afhi(const char *buf, struct afh_info *afhi)
425 afhi->seconds_total = read_u32(buf + AFHI_SECONDS_TOTAL_OFFSET);
426 afhi->bitrate = read_u32(buf + AFHI_BITRATE_OFFSET);
427 afhi->frequency = read_u32(buf + AFHI_FREQUENCY_OFFSET);
428 afhi->header_len = read_u32(buf + AFHI_HEADER_LEN_OFFSET);
429 afhi->channels = read_u8(buf + AFHI_CHANNELS_OFFSET);
430 afhi->chunks_total = read_u32(buf + CHUNKS_TOTAL_OFFSET);
431 afhi->header_len = read_u32(buf + HEADER_LEN_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_OFFSET);
434 afhi->techinfo = (char *)buf + AFHI_INFO_STRING_OFFSET;
435 afhi->tags.artist = afhi->techinfo + strlen(afhi->techinfo) + 1;
436 afhi->tags.title = afhi->tags.artist + strlen(afhi->tags.artist) + 1;
437 afhi->tags.year = afhi->tags.title + strlen(afhi->tags.title) + 1;
438 afhi->tags.album = afhi->tags.year + strlen(afhi->tags.year) + 1;
439 afhi->tags.comment = afhi->tags.album + strlen(afhi->tags.album) + 1;
442 static unsigned sizeof_chunk_table(struct afh_info *afhi)
446 return 4 * (afhi->chunks_total + 1);
449 static uint32_t save_chunk_table(struct afh_info *afhi, char *buf)
452 uint32_t max = 0, old = 0;
454 for (i = 0; i <= afhi->chunks_total; i++) {
455 uint32_t val = afhi->chunk_table[i];
456 write_u32(buf + 4 * i, val);
458 * If the first chunk is the header, do not consider it for the
459 * calculation of the largest chunk size.
461 if (i == 0 || (i == 1 && afhi->header_len > 0)) {
465 max = PARA_MAX(max, val - old);
471 static void load_chunk_table(struct afh_info *afhi, char *buf)
475 afhi->chunk_table = para_malloc(sizeof_chunk_table(afhi));
476 for (i = 0; i <= afhi->chunks_total; i++)
477 afhi->chunk_table[i] = read_u32(buf + 4 * i);
481 * Get the row of the audio file table corresponding to the given path.
483 * \param path The full path of the audio file.
484 * \param row Result pointer.
488 int aft_get_row_of_path(const char *path, struct osl_row **row)
490 struct osl_object obj = {.data = (char *)path, .size = strlen(path) + 1};
492 return osl(osl_get_row(audio_file_table, AFTCOL_PATH, &obj, row));
496 * Get the row of the audio file table corresponding to the given hash value.
498 * \param hash The hash value of the desired audio file.
499 * \param row Result pointer.
503 static int aft_get_row_of_hash(unsigned char *hash, struct osl_row **row)
505 const struct osl_object obj = {.data = hash, .size = HASH_SIZE};
506 return osl(osl_get_row(audio_file_table, AFTCOL_HASH, &obj, row));
510 * Get the audio file selector info object of a row.
512 * \param row Pointer to a row in the audio file table.
513 * \param obj Result pointer.
517 static int get_afsi_object_of_row(const struct osl_row *row,
518 struct osl_object *obj)
520 return osl(osl_get_object(audio_file_table, row, AFTCOL_AFSI, obj));
524 * Get the osl object holding the audio file selector info, given a path.
527 * \param path The full path of the audio file.
528 * \param obj Result pointer.
530 * \return Positive on success, negative on errors.
532 static int get_afsi_object_of_path(const char *path, struct osl_object *obj)
535 int ret = aft_get_row_of_path(path, &row);
538 return get_afsi_object_of_row(row, obj);
542 * Get the audio file selector info, given a row of the audio file table.
544 * \param row Pointer to a row in the audio file table.
545 * \param afsi Result pointer.
547 * \return Positive on success, negative on errors.
549 int get_afsi_of_row(const struct osl_row *row, struct afs_info *afsi)
551 struct osl_object obj;
552 int ret = get_afsi_object_of_row(row, &obj);
555 return load_afsi(afsi, &obj);
559 * Get the audio file selector info, given the path of an audio table.
561 * \param path The full path of the audio file.
562 * \param afsi Result pointer.
566 static int get_afsi_of_path(const char *path, struct afs_info *afsi)
568 struct osl_object obj;
569 int ret = get_afsi_object_of_path(path, &obj);
572 return load_afsi(afsi, &obj);
576 * Get the path of an audio file, given a row of the audio file table.
578 * \param row Pointer to a row in the audio file table.
579 * \param path Result pointer.
581 * The result is a pointer to mmapped data. The caller must not attempt
586 int get_audio_file_path_of_row(const struct osl_row *row, char **path)
588 struct osl_object path_obj;
589 int ret = osl(osl_get_object(audio_file_table, row, AFTCOL_PATH,
593 *path = path_obj.data;
598 * Get the object containing the hash value of an audio file, given a row.
600 * \param row Pointer to a row of the audio file table.
601 * \param obj Result pointer.
603 * \return The return value of the underlying call to osl_get_object().
605 * \sa get_hash_of_row().
607 static int get_hash_object_of_aft_row(const struct osl_row *row,
608 struct osl_object *obj)
610 return osl(osl_get_object(audio_file_table, row, AFTCOL_HASH, obj));
614 * Get the hash value of an audio file, given a row of the audio file table.
616 * \param row Pointer to a row of the audio file table.
617 * \param hash Result pointer.
619 * \a hash points to mapped data and must not be freed by the caller.
621 * \return The return value of the underlying call to
622 * get_hash_object_of_aft_row().
624 static int get_hash_of_row(const struct osl_row *row, unsigned char **hash)
626 struct osl_object obj;
627 int ret = get_hash_object_of_aft_row(row, &obj);
636 * Get the audio format handler info, given a row of the audio file table.
638 * \param row Pointer to a row of the audio file table.
639 * \param afhi Result pointer.
641 * \return The return value of the underlying call to osl_get_object().
643 * \sa get_chunk_table_of_row().
645 int get_afhi_of_row(const struct osl_row *row, struct afh_info *afhi)
647 struct osl_object obj;
648 int ret = osl(osl_get_object(audio_file_table, row, AFTCOL_AFHI,
652 load_afhi(obj.data, afhi);
656 /* returns shmid on success */
657 static int save_afd(struct audio_file_data *afd)
659 size_t size = sizeof(*afd) + sizeof_chunk_table(&afd->afhi);
660 int shmid, ret = shm_new(size);
667 ret = shm_attach(shmid, ATTACH_RW, &shm_afd);
672 afd->max_chunk_size = save_chunk_table(&afd->afhi, buf);
673 *(struct audio_file_data *)shm_afd = *afd;
682 * Extract a afd stored in a shared memory area.
684 * Attach the shared memory area given by \a shmid, load the audio file data
685 * stored therein and detach the area afterwards. Called by vss, after
686 * receiving a positive response to the request for the next audio file.
688 * \param shmid The identifier of the shared memory area containing the afd.
689 * \param afd Result pointer.
693 int load_afd(int shmid, struct audio_file_data *afd)
699 ret = shm_attach(shmid, ATTACH_RO, &shm_afd);
702 *afd = *(struct audio_file_data *)shm_afd;
705 load_chunk_table(&afd->afhi, buf);
710 static int get_local_time(uint64_t *seconds, char *buf, size_t size,
711 time_t current_time, enum ls_listing_mode lm)
715 if (!localtime_r((time_t *)seconds, &t))
717 if (lm == LS_MODE_MBOX) {
718 if (!strftime(buf, size, "%c", &t))
722 if (*seconds + 6 * 30 * 24 * 3600 > current_time) {
723 if (!strftime(buf, size, "%b %e %k:%M", &t))
727 if (!strftime(buf, size, "%b %e %Y", &t))
732 /** Compute the number of (decimal) digits of a number. */
733 #define GET_NUM_DIGITS(x, num) { \
734 typeof((x)) _tmp = PARA_ABS(x); \
737 while ((_tmp) > 9) { \
743 __a_const static short unsigned get_duration_width(int seconds)
745 short unsigned width;
746 unsigned hours = seconds / 3600, mins = (seconds % 3600) / 60;
748 if (!hours) /* less than one hour => m:ss or mm:ss => 4 or 5 digits */
749 return 4 + (mins > 9);
750 /* more than one hour => h:mm:ss, hh:mm:ss, hhh:mm:ss, ... */
751 GET_NUM_DIGITS(hours, &width);
755 static void get_duration_buf(int seconds, char *buf, struct ls_options *opts)
757 unsigned hours = seconds / 3600, mins = (seconds % 3600) / 60;
758 short unsigned max_width;
760 if (!hours) { /* m:ss or mm:ss */
761 max_width = opts->mode == LS_MODE_LONG?
762 opts->widths.duration_width : 4;
763 sprintf(buf, "%*u:%02u", max_width - 3, mins, seconds % 60);
764 } else { /* more than one hour => h:mm:ss, hh:mm:ss, hhh:mm:ss, ... */
765 max_width = opts->mode == LS_MODE_LONG?
766 opts->widths.duration_width : 7;
767 sprintf(buf, "%*u:%02u:%02u", max_width - 6, hours, mins,
772 static int write_attribute_items(struct para_buffer *b,
773 const char *att_bitmap, struct afs_info *afsi)
778 ret = WRITE_STATUS_ITEM(b, SI_ATTRIBUTES_BITMAP, "%s\n", att_bitmap);
781 ret = get_attribute_text(&afsi->attributes, " ", &att_text);
784 ret = WRITE_STATUS_ITEM(b, SI_ATTRIBUTES_TXT, "%s\n", att_text);
789 static int write_lyrics_items(struct para_buffer *b, struct afs_info *afsi)
794 ret = WRITE_STATUS_ITEM(b, SI_LYRICS_ID, "%u\n", afsi->lyrics_id);
797 lyr_get_name_by_id(afsi->lyrics_id, &lyrics_name);
798 return WRITE_STATUS_ITEM(b, SI_LYRICS_NAME, "%s\n", lyrics_name?
799 lyrics_name : "(none)");
802 static int write_image_items(struct para_buffer *b, struct afs_info *afsi)
807 ret = WRITE_STATUS_ITEM(b, SI_IMAGE_ID, "%u\n", afsi->image_id);
810 img_get_name_by_id(afsi->image_id, &image_name);
811 return WRITE_STATUS_ITEM(b, SI_IMAGE_NAME, "%s\n", image_name?
812 image_name : "(none)");
815 static int write_filename_items(struct para_buffer *b, const char *path,
821 if (!(flags & LS_FLAG_FULL_PATH))
822 return WRITE_STATUS_ITEM(b, SI_BASENAME, "%s\n", path);
823 ret = WRITE_STATUS_ITEM(b, SI_PATH, "%s\n", path);
826 val = para_basename(path);
827 ret = WRITE_STATUS_ITEM(b, SI_BASENAME, "%s\n", val? val : "");
830 val = para_dirname(path);
831 ret = WRITE_STATUS_ITEM(b, SI_DIRECTORY, "%s\n", val? val : "");
836 static int print_chunk_table(struct ls_data *d, struct para_buffer *b)
838 struct osl_object chunk_table_obj;
839 struct osl_row *aft_row;
843 ret = aft_get_row_of_hash(d->hash, &aft_row);
846 ret = osl(osl_open_disk_object(audio_file_table, aft_row,
847 AFTCOL_CHUNKS, &chunk_table_obj));
850 ret = para_printf(b, "%s\n"
851 "chunk_time: %lu:%lu\nchunk_offsets: ",
853 (long unsigned) d->afhi.chunk_tv.tv_sec,
854 (long unsigned) d->afhi.chunk_tv.tv_usec
858 buf = chunk_table_obj.data;
859 for (i = 0; i <= d->afhi.chunks_total; i++) {
860 ret = para_printf(b, "%u ", (unsigned) read_u32(buf + 4 * i));
864 ret = para_printf(b, "\n");
866 osl_close_disk_object(&chunk_table_obj);
870 static int write_score(struct para_buffer *b, struct ls_data *d,
871 struct ls_options *opts)
873 if (!(opts->flags & LS_FLAG_ADMISSIBLE_ONLY)) /* no score*/
875 return WRITE_STATUS_ITEM(b, SI_SCORE, "%li\n", d->score);
878 static int print_list_item(struct ls_data *d, struct ls_options *opts,
879 struct para_buffer *b, time_t current_time)
883 char last_played_time[30];
884 char duration_buf[30]; /* nobody has an audio file long enough to overflow this */
885 struct afs_info *afsi = &d->afsi;
886 struct afh_info *afhi = &d->afhi;
887 char asc_hash[2 * HASH_SIZE + 1];
889 if (opts->mode == LS_MODE_SHORT) {
890 ret = para_printf(b, "%s\n", d->path);
893 if (opts->mode == LS_MODE_CHUNKS) {
894 ret = print_chunk_table(d, b);
897 get_attribute_bitmap(&afsi->attributes, att_buf);
898 if (opts->flags & LS_FLAG_UNIXDATE)
899 sprintf(last_played_time, "%llu",
900 (long long unsigned)afsi->last_played);
902 ret = get_local_time(&afsi->last_played, last_played_time,
903 sizeof(last_played_time), current_time, opts->mode);
907 get_duration_buf(afhi->seconds_total, duration_buf, opts);
908 if (opts->mode == LS_MODE_LONG) {
909 struct ls_widths *w = &opts->widths;
910 if (opts->flags & LS_FLAG_ADMISSIBLE_ONLY) {
911 ret = para_printf(b, "%*li ",
912 opts->widths.score_width, d->score);
917 "%s " /* attributes */
919 "%*d " /* image_id */
920 "%*d " /* lyrics_id */
922 "%*s " /* audio format */
923 "%*d " /* frequency */
926 "%*d " /* num_played */
927 "%s " /* last_played */
930 w->amp_width, afsi->amp,
931 w->image_id_width, afsi->image_id,
932 w->lyrics_id_width, afsi->lyrics_id,
933 w->bitrate_width, afhi->bitrate,
934 w->audio_format_width,
935 audio_format_name(afsi->audio_format_id),
936 w->frequency_width, afhi->frequency,
939 w->num_played_width, afsi->num_played,
945 if (opts->mode == LS_MODE_MBOX) {
946 const char *bn = para_basename(d->path);
948 "From foo@localhost %s\n"
949 "Received: from\nTo: bar\nFrom: a\n"
956 ret = write_filename_items(b, d->path, opts->flags);
959 ret = write_score(b, d, opts);
962 ret = write_attribute_items(b, att_buf, afsi);
965 ret = write_image_items(b, afsi);
968 ret = write_lyrics_items(b, afsi);
971 hash_to_asc(d->hash, asc_hash);
972 ret = WRITE_STATUS_ITEM(b, SI_HASH, "%s\n", asc_hash);
975 ret = WRITE_STATUS_ITEM(b, SI_BITRATE, "%dkbit/s\n", afhi->bitrate);
978 ret = WRITE_STATUS_ITEM(b, SI_FORMAT, "%s\n",
979 audio_format_name(afsi->audio_format_id));
982 ret = WRITE_STATUS_ITEM(b, SI_FREQUENCY, "%dHz\n", afhi->frequency);
985 ret = WRITE_STATUS_ITEM(b, SI_CHANNELS, "%d\n", afhi->channels);
988 ret = WRITE_STATUS_ITEM(b, SI_DURATION, "%s\n", duration_buf);
991 ret = WRITE_STATUS_ITEM(b, SI_SECONDS_TOTAL, "%lu\n",
992 afhi->seconds_total);
995 ret = WRITE_STATUS_ITEM(b, SI_LAST_PLAYED, "%s\n", last_played_time);
998 ret = WRITE_STATUS_ITEM(b, SI_NUM_PLAYED, "%d\n", afsi->num_played);
1001 ret = WRITE_STATUS_ITEM(b, SI_AMPLIFICATION, "%u\n", afsi->amp);
1004 ret = WRITE_STATUS_ITEM(b, SI_CHUNK_TIME, "%lu\n",
1005 tv2ms(&afhi->chunk_tv));
1008 ret = WRITE_STATUS_ITEM(b, SI_NUM_CHUNKS, "%lu\n",
1009 afhi->chunks_total);
1012 ret = WRITE_STATUS_ITEM(b, SI_TECHINFO, "%s\n", afhi->techinfo);
1015 ret = WRITE_STATUS_ITEM(b, SI_ARTIST, "%s\n", afhi->tags.artist);
1018 ret = WRITE_STATUS_ITEM(b, SI_TITLE, "%s\n", afhi->tags.title);
1021 ret = WRITE_STATUS_ITEM(b, SI_YEAR, "%s\n", afhi->tags.year);
1024 ret = WRITE_STATUS_ITEM(b, SI_ALBUM, "%s\n", afhi->tags.album);
1027 ret = WRITE_STATUS_ITEM(b, SI_COMMENT, "%s\n", afhi->tags.comment);
1030 if (opts->mode == LS_MODE_MBOX) {
1031 struct osl_object lyrics_def;
1032 lyr_get_def_by_id(afsi->lyrics_id, &lyrics_def);
1033 if (lyrics_def.data) {
1034 ret = para_printf(b, "Lyrics:\n~~~~~~~\n%s",
1035 (char *)lyrics_def.data);
1036 osl_close_disk_object(&lyrics_def);
1043 static int make_status_items(struct ls_data *d)
1045 struct ls_options opts = {
1046 .flags = LS_FLAG_FULL_PATH | LS_FLAG_ADMISSIBLE_ONLY,
1047 .mode = LS_MODE_VERBOSE,
1049 struct para_buffer pb = {.max_size = shm_get_shmmax() - 1};
1050 time_t current_time;
1053 time(¤t_time);
1054 ret = print_list_item(d, &opts, &pb, current_time);
1058 status_items = pb.buf;
1059 memset(&pb, 0, sizeof(pb));
1060 pb.max_size = shm_get_shmmax() - 1;
1061 pb.flags = PBF_SIZE_PREFIX;
1062 ret = print_list_item(d, &opts, &pb, current_time);
1065 status_items = NULL;
1068 free(parser_friendly_status_items);
1069 parser_friendly_status_items = pb.buf;
1074 * Open the audio file with highest score and set up an afd structure.
1076 * \param afd Result pointer.
1078 * On success, the numplayed field of the audio file selector info is increased
1079 * and the lastplayed time is set to the current time. Finally, the score of
1080 * the audio file is updated.
1082 * \return Positive shmid on success, negative on errors.
1084 int open_and_update_audio_file(struct audio_file_data *afd)
1086 struct osl_row *aft_row;
1087 unsigned char file_hash[HASH_SIZE];
1088 struct osl_object afsi_obj;
1089 struct afs_info new_afsi;
1091 struct afsi_change_event_data aced;
1092 struct osl_object map, chunk_table_obj;
1095 ret = score_get_best(&aft_row, &d.score);
1098 ret = get_hash_of_row(aft_row, &d.hash);
1101 ret = get_audio_file_path_of_row(aft_row, &d.path);
1104 PARA_NOTICE_LOG("%s\n", d.path);
1105 ret = get_afsi_object_of_row(aft_row, &afsi_obj);
1108 ret = load_afsi(&d.afsi, &afsi_obj);
1111 ret = get_afhi_of_row(aft_row, &afd->afhi);
1115 d.afhi.chunk_table = afd->afhi.chunk_table = NULL;
1116 ret = osl(osl_open_disk_object(audio_file_table, aft_row,
1117 AFTCOL_CHUNKS, &chunk_table_obj));
1120 ret = mmap_full_file(d.path, O_RDONLY, &map.data, &map.size, &afd->fd);
1123 hash_function(map.data, map.size, file_hash);
1124 ret = hash_compare(file_hash, d.hash);
1125 para_munmap(map.data, map.size);
1127 ret = -E_HASH_MISMATCH;
1131 new_afsi.num_played++;
1132 new_afsi.last_played = time(NULL);
1133 save_afsi(&new_afsi, &afsi_obj); /* in-place update */
1135 afd->audio_format_id = d.afsi.audio_format_id;
1136 load_chunk_table(&afd->afhi, chunk_table_obj.data);
1137 ret = make_status_items(&d);
1140 aced.aft_row = aft_row;
1141 aced.old_afsi = &d.afsi;
1142 afs_event(AFSI_CHANGE, NULL, &aced);
1143 ret = save_afd(afd);
1145 free(afd->afhi.chunk_table);
1146 osl_close_disk_object(&chunk_table_obj);
1148 PARA_ERROR_LOG("%s: %s\n", d.path, para_strerror(-ret));
1149 ret = score_delete(aft_row);
1156 static int ls_audio_format_compare(const void *a, const void *b)
1158 struct ls_data *d1 = *(struct ls_data **)a, *d2 = *(struct ls_data **)b;
1159 return NUM_COMPARE(d1->afsi.audio_format_id, d2->afsi.audio_format_id);
1162 static int ls_duration_compare(const void *a, const void *b)
1164 struct ls_data *d1 = *(struct ls_data **)a, *d2 = *(struct ls_data **)b;
1165 return NUM_COMPARE(d1->afhi.seconds_total, d2->afhi.seconds_total);
1168 static int ls_bitrate_compare(const void *a, const void *b)
1170 struct ls_data *d1 = *(struct ls_data **)a, *d2 = *(struct ls_data **)b;
1171 return NUM_COMPARE(d1->afhi.bitrate, d2->afhi.bitrate);
1174 static int ls_lyrics_id_compare(const void *a, const void *b)
1176 struct ls_data *d1 = *(struct ls_data **)a, *d2 = *(struct ls_data **)b;
1177 return NUM_COMPARE(d1->afsi.lyrics_id, d2->afsi.lyrics_id);
1180 static int ls_image_id_compare(const void *a, const void *b)
1182 struct ls_data *d1 = *(struct ls_data **)a, *d2 = *(struct ls_data **)b;
1183 return NUM_COMPARE(d1->afsi.image_id, d2->afsi.image_id);
1186 static int ls_channels_compare(const void *a, const void *b)
1188 struct ls_data *d1 = *(struct ls_data **)a, *d2 = *(struct ls_data **)b;
1189 return NUM_COMPARE(d1->afhi.channels, d2->afhi.channels);
1192 static int ls_frequency_compare(const void *a, const void *b)
1194 struct ls_data *d1 = *(struct ls_data **)a, *d2 = *(struct ls_data **)b;
1195 return NUM_COMPARE(d1->afhi.frequency, d2->afhi.frequency);
1198 static int ls_num_played_compare(const void *a, const void *b)
1200 struct ls_data *d1 = *(struct ls_data **)a, *d2 = *(struct ls_data **)b;
1201 return NUM_COMPARE(d1->afsi.num_played, d2->afsi.num_played);
1204 static int ls_last_played_compare(const void *a, const void *b)
1206 struct ls_data *d1 = *(struct ls_data **)a, *d2 = *(struct ls_data **)b;
1207 return NUM_COMPARE(d1->afsi.last_played, d2->afsi.last_played);
1210 static int ls_score_compare(const void *a, const void *b)
1212 struct ls_data *d1 = *(struct ls_data **)a, *d2 = *(struct ls_data **)b;
1213 return NUM_COMPARE(d1->score, d2->score);
1216 static int ls_path_compare(const void *a, const void *b)
1218 struct ls_data *d1 = *(struct ls_data **)a, *d2 = *(struct ls_data **)b;
1219 return strcmp(d1->path, d2->path);
1222 static int sort_matching_paths(struct ls_options *options)
1224 size_t nmemb = options->num_matching_paths;
1225 size_t size = sizeof(*options->data_ptr);
1226 int (*compar)(const void *, const void *);
1229 options->data_ptr = para_malloc(nmemb * sizeof(*options->data_ptr));
1230 for (i = 0; i < nmemb; i++)
1231 options->data_ptr[i] = options->data + i;
1233 /* In these cases the array is already sorted */
1234 if (options->sorting == LS_SORT_BY_PATH
1235 && !(options->flags & LS_FLAG_ADMISSIBLE_ONLY)
1236 && (options->flags & LS_FLAG_FULL_PATH))
1238 if (options->sorting == LS_SORT_BY_SCORE &&
1239 options->flags & LS_FLAG_ADMISSIBLE_ONLY)
1242 switch (options->sorting) {
1243 case LS_SORT_BY_PATH:
1244 compar = ls_path_compare; break;
1245 case LS_SORT_BY_SCORE:
1246 compar = ls_score_compare; break;
1247 case LS_SORT_BY_LAST_PLAYED:
1248 compar = ls_last_played_compare; break;
1249 case LS_SORT_BY_NUM_PLAYED:
1250 compar = ls_num_played_compare; break;
1251 case LS_SORT_BY_FREQUENCY:
1252 compar = ls_frequency_compare; break;
1253 case LS_SORT_BY_CHANNELS:
1254 compar = ls_channels_compare; break;
1255 case LS_SORT_BY_IMAGE_ID:
1256 compar = ls_image_id_compare; break;
1257 case LS_SORT_BY_LYRICS_ID:
1258 compar = ls_lyrics_id_compare; break;
1259 case LS_SORT_BY_BITRATE:
1260 compar = ls_bitrate_compare; break;
1261 case LS_SORT_BY_DURATION:
1262 compar = ls_duration_compare; break;
1263 case LS_SORT_BY_AUDIO_FORMAT:
1264 compar = ls_audio_format_compare; break;
1268 qsort(options->data_ptr, nmemb, size, compar);
1272 /* row is either an aft_row or a row of the score table */
1273 /* TODO: Only compute widths if we need them */
1274 static int prepare_ls_row(struct osl_row *row, void *ls_opts)
1277 struct ls_options *options = ls_opts;
1279 struct ls_widths *w;
1280 unsigned short num_digits;
1282 struct osl_row *aft_row;
1286 if (options->flags & LS_FLAG_ADMISSIBLE_ONLY) {
1287 ret = get_score_and_aft_row(row, &score, &aft_row);
1294 ret = get_audio_file_path_of_row(aft_row, &path);
1297 if (!(options->flags & LS_FLAG_FULL_PATH)) {
1298 char *p = strrchr(path, '/');
1302 if (options->num_patterns) {
1303 for (i = 0; i < options->num_patterns; i++) {
1304 ret = fnmatch(options->patterns[i], path, 0);
1307 if (ret == FNM_NOMATCH)
1311 if (i >= options->num_patterns) /* no match */
1314 tmp = options->num_matching_paths++;
1315 if (options->num_matching_paths > options->array_size) {
1316 options->array_size++;
1317 options->array_size *= 2;
1318 options->data = para_realloc(options->data, options->array_size
1319 * sizeof(*options->data));
1321 d = options->data + tmp;
1322 ret = get_afsi_of_row(aft_row, &d->afsi);
1325 ret = get_afhi_of_row(aft_row, &d->afhi);
1329 ret = get_hash_of_row(aft_row, &d->hash);
1332 w = &options->widths;
1333 GET_NUM_DIGITS(d->afsi.image_id, &num_digits);
1334 w->image_id_width = PARA_MAX(w->image_id_width, num_digits);
1335 GET_NUM_DIGITS(d->afsi.lyrics_id, &num_digits);
1336 w->lyrics_id_width = PARA_MAX(w->lyrics_id_width, num_digits);
1337 GET_NUM_DIGITS(d->afhi.bitrate, &num_digits);
1338 w->bitrate_width = PARA_MAX(w->bitrate_width, num_digits);
1339 GET_NUM_DIGITS(d->afhi.frequency, &num_digits);
1340 w->frequency_width = PARA_MAX(w->frequency_width, num_digits);
1341 GET_NUM_DIGITS(d->afsi.num_played, &num_digits);
1342 w->num_played_width = PARA_MAX(w->num_played_width, num_digits);
1343 /* get the number of chars to print this amount of time */
1344 num_digits = get_duration_width(d->afhi.seconds_total);
1345 w->duration_width = PARA_MAX(w->duration_width, num_digits);
1346 GET_NUM_DIGITS(d->afsi.amp, &num_digits);
1347 w->amp_width = PARA_MAX(w->amp_width, num_digits);
1348 num_digits = strlen(audio_format_name(d->afsi.audio_format_id));
1349 w->audio_format_width = PARA_MAX(w->audio_format_width, num_digits);
1350 if (options->flags & LS_FLAG_ADMISSIBLE_ONLY) {
1351 GET_NUM_DIGITS(score, &num_digits);
1352 num_digits++; /* add one for the sign (space or "-") */
1353 w->score_width = PARA_MAX(w->score_width, num_digits);
1361 static void com_ls_callback(int fd, const struct osl_object *query)
1363 struct ls_options *opts = query->data;
1364 char *p, *pattern_start = (char *)query->data + sizeof(*opts);
1365 struct para_buffer b = {
1366 .max_size = shm_get_shmmax(),
1367 .flags = (opts->mode == LS_MODE_PARSER)? PBF_SIZE_PREFIX : 0,
1368 .max_size_handler = afs_max_size_handler,
1369 .private_data = &(struct afs_max_size_handler_data) {
1375 time_t current_time;
1377 if (opts->num_patterns) {
1378 opts->patterns = para_malloc(opts->num_patterns * sizeof(char *));
1379 for (i = 0, p = pattern_start; i < opts->num_patterns; i++) {
1380 opts->patterns[i] = p;
1384 opts->patterns = NULL;
1385 if (opts->flags & LS_FLAG_ADMISSIBLE_ONLY)
1386 ret = admissible_file_loop(opts, prepare_ls_row);
1388 ret = osl(osl_rbtree_loop(audio_file_table, AFTCOL_PATH, opts,
1392 if (opts->num_matching_paths == 0) {
1393 if (opts->num_patterns > 0)
1394 para_printf(&b, "no matches\n");
1397 ret = sort_matching_paths(opts);
1400 time(¤t_time);
1401 if (opts->flags & LS_FLAG_REVERSE)
1402 for (i = opts->num_matching_paths - 1; i >= 0; i--) {
1403 ret = print_list_item(opts->data_ptr[i], opts, &b, current_time);
1408 for (i = 0; i < opts->num_matching_paths; i++) {
1409 ret = print_list_item(opts->data_ptr[i], opts, &b, current_time);
1415 pass_buffer_as_shm(fd, SBD_OUTPUT, b.buf, b.offset);
1418 free(opts->data_ptr);
1419 free(opts->patterns);
1423 * TODO: flags -h (sort by hash)
1425 int com_ls(struct command_context *cc)
1429 enum ls_sorting_method sort = LS_SORT_BY_PATH;
1430 enum ls_listing_mode mode = LS_MODE_SHORT;
1431 struct ls_options opts = {.patterns = NULL};
1432 struct osl_object query = {.data = &opts, .size = sizeof(opts)};
1434 for (i = 1; i < cc->argc; i++) {
1435 const char *arg = cc->argv[i];
1438 if (!strcmp(arg, "--")) {
1442 if (!strncmp(arg, "-l", 2)) {
1444 mode = LS_MODE_LONG;
1448 return -E_AFT_SYNTAX;
1449 switch(*(arg + 2)) {
1451 mode = LS_MODE_SHORT;
1454 mode = LS_MODE_LONG;
1457 mode = LS_MODE_VERBOSE;
1460 mode = LS_MODE_MBOX;
1463 mode = LS_MODE_CHUNKS;
1466 mode = LS_MODE_PARSER;
1469 return -E_AFT_SYNTAX;
1472 if (!strcmp(arg, "-p")) {
1473 flags |= LS_FLAG_FULL_PATH;
1476 if (!strcmp(arg, "-a")) {
1477 flags |= LS_FLAG_ADMISSIBLE_ONLY;
1480 if (!strcmp(arg, "-r")) {
1481 flags |= LS_FLAG_REVERSE;
1484 if (!strcmp(arg, "-d")) {
1485 flags |= LS_FLAG_UNIXDATE;
1488 if (!strncmp(arg, "-s", 2)) {
1489 if (!*(arg + 2) || *(arg + 3))
1490 return -E_AFT_SYNTAX;
1491 switch(*(arg + 2)) {
1493 sort = LS_SORT_BY_PATH;
1495 case 's': /* -ss implies -a */
1496 sort = LS_SORT_BY_SCORE;
1497 flags |= LS_FLAG_ADMISSIBLE_ONLY;
1500 sort = LS_SORT_BY_LAST_PLAYED;
1503 sort = LS_SORT_BY_NUM_PLAYED;
1506 sort = LS_SORT_BY_FREQUENCY;
1509 sort = LS_SORT_BY_CHANNELS;
1512 sort = LS_SORT_BY_IMAGE_ID;
1515 sort = LS_SORT_BY_LYRICS_ID;
1518 sort = LS_SORT_BY_BITRATE;
1521 sort = LS_SORT_BY_DURATION;
1524 sort = LS_SORT_BY_AUDIO_FORMAT;
1527 return -E_AFT_SYNTAX;
1530 return -E_AFT_SYNTAX;
1533 opts.sorting = sort;
1535 opts.num_patterns = cc->argc - i;
1536 ret = send_option_arg_callback_request(&query, opts.num_patterns,
1537 cc->argv + i, com_ls_callback, afs_cb_result_handler, cc);
1542 * Call the given function for each file in the audio file table.
1544 * \param private_data An arbitrary data pointer, passed to \a func.
1545 * \param func The custom function to be called.
1549 int audio_file_loop(void *private_data, osl_rbtree_loop_func *func)
1551 return osl(osl_rbtree_loop(audio_file_table, AFTCOL_HASH, private_data,
1555 static struct osl_row *find_hash_sister(unsigned char *hash)
1557 const struct osl_object obj = {.data = hash, .size = HASH_SIZE};
1558 struct osl_row *row;
1560 osl_get_row(audio_file_table, AFTCOL_HASH, &obj, &row);
1564 /** The format of the data stored by save_audio_file_data(). */
1565 enum com_add_buffer_offsets {
1566 /** afhi (if present) starts here. */
1567 CAB_AFHI_OFFSET_POS = 0,
1568 /** Start of the chunk table (if present). */
1569 CAB_CHUNKS_OFFSET_POS = 2,
1570 /** Audio format id. */
1571 CAB_AUDIO_FORMAT_OFFSET = 4,
1572 /** Flags given to the add command. */
1573 CAB_FLAGS_OFFSET = 5,
1574 /** The hash of the audio file being added. */
1575 CAB_HASH_OFFSET = 9,
1576 /** Start of the path of the audio file. */
1577 CAB_PATH_OFFSET = (CAB_HASH_OFFSET + HASH_SIZE),
1581 * Store the given data to a single buffer. Doesn't need the audio file selector
1582 * info struct as the server knows it as well.
1584 * It's OK to call this with afhi == NULL. In this case, the audio format
1585 * handler info won't be stored in the buffer.
1587 static void save_add_callback_buffer(unsigned char *hash, const char *path,
1588 struct afh_info *afhi, uint32_t flags,
1589 uint8_t audio_format_num, struct osl_object *obj)
1591 size_t path_len = strlen(path) + 1;
1592 size_t afhi_size = sizeof_afhi_buf(afhi);
1593 size_t size = CAB_PATH_OFFSET + path_len + afhi_size
1594 + sizeof_chunk_table(afhi);
1595 char *buf = para_malloc(size);
1598 write_u8(buf + CAB_AUDIO_FORMAT_OFFSET, audio_format_num);
1599 write_u32(buf + CAB_FLAGS_OFFSET, flags);
1601 memcpy(buf + CAB_HASH_OFFSET, hash, HASH_SIZE);
1602 strcpy(buf + CAB_PATH_OFFSET, path);
1604 pos = CAB_PATH_OFFSET + path_len;
1605 PARA_DEBUG_LOG("size: %zu, afhi starts at %d\n", size, pos);
1606 PARA_DEBUG_LOG("last afhi byte: %p, pos %zu\n", buf + pos + afhi_size - 1,
1607 pos + afhi_size - 1);
1608 write_u16(buf + CAB_AFHI_OFFSET_POS, pos);
1609 save_afhi(afhi, buf + pos);
1612 PARA_DEBUG_LOG("size: %zu, chunks start at %d\n", size, pos);
1613 write_u16(buf + CAB_CHUNKS_OFFSET_POS, pos);
1615 save_chunk_table(afhi, buf + pos);
1616 PARA_DEBUG_LOG("last byte in buf: %p\n", buf + size - 1);
1623 Overview of the add command.
1625 Input: What was passed to the callback by the command handler.
1627 HS: Hash sister. Whether an audio file with identical hash
1628 already exists in the osl database.
1630 PB: Path brother. Whether a file with the given path exists
1633 F: Force flag given. Whether add was called with -f.
1635 output: Action performed by the callback.
1637 AFHI: Whether afhi and chunk table are computed and sent.
1638 ACTION: Table modifications to be done by the callback.
1640 +----+----+---+------+---------------------------------------------------+
1641 | HS | PB | F | AFHI | ACTION
1642 +----+----+---+------+---------------------------------------------------+
1643 | Y | Y | Y | Y | if HS != PB: remove PB. HS: force afhi update,
1644 | | update path, keep afsi
1645 +----+----+---+------+---------------------------------------------------+
1646 | Y | Y | N | N | if HS == PB: do not send callback request at all.
1647 | | otherwise: remove PB, HS: update path, keep afhi,
1649 +----+----+---+------+---------------------------------------------------+
1650 | Y | N | Y | Y | (rename) force afhi update of HS, update path of
1652 +----+----+---+------+---------------------------------------------------+
1653 | Y | N | N | N | (file rename) update path of HS, keep afsi, afhi
1654 +----+----+---+------+---------------------------------------------------+
1655 | N | Y | Y | Y | (file change) update afhi, hash, of PB, keep afsi
1656 | | (force has no effect)
1657 +----+----+---+------+---------------------------------------------------+
1658 | N | Y | N | Y | (file change) update afhi, hash of PB, keep afsi
1659 +----+----+---+------+---------------------------------------------------+
1660 | N | N | Y | Y | (new file) create new entry (force has no effect)
1661 +----+----+---+------+---------------------------------------------------+
1662 | N | N | N | Y | (new file) create new entry
1663 +----+----+---+------+---------------------------------------------------+
1667 afhi <=> force or no HS
1672 /** Flags passed to the add command. */
1673 enum com_add_flags {
1674 /** Skip paths that exist already. */
1676 /** Force adding. */
1678 /** Print what is being done. */
1679 ADD_FLAG_VERBOSE = 4,
1680 /** Try to add files with unknown suffixes. */
1684 static void com_add_callback(int fd, const struct osl_object *query)
1686 char *buf = query->data, *path;
1687 struct osl_row *pb, *aft_row;
1689 struct osl_object objs[NUM_AFT_COLUMNS];
1690 unsigned char *hash;
1691 char asc[2 * HASH_SIZE + 1];
1693 char afsi_buf[AFSI_SIZE];
1694 uint32_t flags = read_u32(buf + CAB_FLAGS_OFFSET);
1695 struct afs_info default_afsi = {.last_played = 0};
1696 struct para_buffer msg = {
1697 .max_size = shm_get_shmmax(),
1698 .max_size_handler = afs_max_size_handler,
1699 .private_data = &(struct afs_max_size_handler_data) {
1704 uint16_t afhi_offset, chunks_offset;
1706 hash = (unsigned char *)buf + CAB_HASH_OFFSET;
1707 hash_to_asc(hash, asc);
1708 objs[AFTCOL_HASH].data = buf + CAB_HASH_OFFSET;
1709 objs[AFTCOL_HASH].size = HASH_SIZE;
1711 path = buf + CAB_PATH_OFFSET;
1712 objs[AFTCOL_PATH].data = path;
1713 objs[AFTCOL_PATH].size = strlen(path) + 1;
1715 PARA_INFO_LOG("request to add %s\n", path);
1716 hs = find_hash_sister(hash);
1717 ret = aft_get_row_of_path(path, &pb);
1718 if (ret < 0 && ret != -OSL_ERRNO_TO_PARA_ERROR(E_OSL_RB_KEY_NOT_FOUND))
1720 if (hs && pb && hs == pb && !(flags & ADD_FLAG_FORCE)) {
1721 if (flags & ADD_FLAG_VERBOSE)
1722 ret = para_printf(&msg, "ignoring duplicate\n");
1727 if (hs && hs != pb) {
1728 struct osl_object obj;
1729 if (pb) { /* hs trumps pb, remove pb */
1730 if (flags & ADD_FLAG_VERBOSE) {
1731 ret = para_printf(&msg, "removing %s\n", path);
1735 afs_event(AUDIO_FILE_REMOVE, &msg, pb);
1736 ret = osl(osl_del_row(audio_file_table, pb));
1741 /* file rename, update hs' path */
1742 if (flags & ADD_FLAG_VERBOSE) {
1743 ret = osl(osl_get_object(audio_file_table, hs,
1744 AFTCOL_PATH, &obj));
1747 ret = para_printf(&msg, "renamed from %s\n", (char *)obj.data);
1751 ret = osl(osl_update_object(audio_file_table, hs, AFTCOL_PATH,
1752 &objs[AFTCOL_PATH]));
1755 afs_event(AUDIO_FILE_RENAME, &msg, hs);
1756 if (!(flags & ADD_FLAG_FORCE))
1759 /* no hs or force mode, child must have sent afhi */
1760 afhi_offset = read_u16(buf + CAB_AFHI_OFFSET_POS);
1761 chunks_offset = read_u16(buf + CAB_CHUNKS_OFFSET_POS);
1763 objs[AFTCOL_AFHI].data = buf + afhi_offset;
1764 objs[AFTCOL_AFHI].size = chunks_offset - afhi_offset;
1766 if (!objs[AFTCOL_AFHI].size) /* "impossible" */
1768 objs[AFTCOL_CHUNKS].data = buf + chunks_offset;
1769 objs[AFTCOL_CHUNKS].size = query->size - chunks_offset;
1770 if (pb && !hs) { /* update pb's hash */
1771 char old_asc[2 * HASH_SIZE + 1];
1772 unsigned char *old_hash;
1773 ret = get_hash_of_row(pb, &old_hash);
1776 hash_to_asc(old_hash, old_asc);
1777 if (flags & ADD_FLAG_VERBOSE) {
1778 ret = para_printf(&msg, "file change: %s -> %s\n",
1783 ret = osl_update_object(audio_file_table, pb, AFTCOL_HASH,
1784 &objs[AFTCOL_HASH]);
1788 if (hs || pb) { /* (hs != NULL and pb != NULL) implies hs == pb */
1789 struct osl_row *row = pb? pb : hs;
1790 /* update afhi and chunk_table */
1791 if (flags & ADD_FLAG_VERBOSE) {
1792 ret = para_printf(&msg, "updating afhi and chunk table\n");
1796 ret = osl(osl_update_object(audio_file_table, row, AFTCOL_AFHI,
1797 &objs[AFTCOL_AFHI]));
1800 ret = osl(osl_update_object(audio_file_table, row, AFTCOL_CHUNKS,
1801 &objs[AFTCOL_CHUNKS]));
1804 afs_event(AFHI_CHANGE, &msg, row);
1807 /* new entry, use default afsi */
1808 if (flags & ADD_FLAG_VERBOSE) {
1809 ret = para_printf(&msg, "new file\n");
1813 default_afsi.last_played = time(NULL) - 365 * 24 * 60 * 60;
1814 default_afsi.audio_format_id = read_u8(buf + CAB_AUDIO_FORMAT_OFFSET);
1816 objs[AFTCOL_AFSI].data = &afsi_buf;
1817 objs[AFTCOL_AFSI].size = AFSI_SIZE;
1818 save_afsi(&default_afsi, &objs[AFTCOL_AFSI]);
1819 ret = osl(osl_add_and_get_row(audio_file_table, objs, &aft_row));
1820 afs_event(AUDIO_FILE_ADD, &msg, aft_row);
1823 para_printf(&msg, "%s\n", para_strerror(-ret));
1825 pass_buffer_as_shm(fd, SBD_OUTPUT, msg.buf, msg.offset);
1829 /** Used by com_add(). */
1830 struct private_add_data {
1831 /** The pointer passed to the original command handler. */
1832 struct command_context *cc;
1833 /** The given add flags. */
1837 static void path_brother_callback(int fd, const struct osl_object *query)
1839 char *path = query->data;
1840 struct osl_row *path_brother;
1841 int ret = aft_get_row_of_path(path, &path_brother);
1844 pass_buffer_as_shm(fd, SBD_OUTPUT, (char *)&path_brother,
1845 sizeof(path_brother));
1848 static void hash_sister_callback(int fd, const struct osl_object *query)
1850 unsigned char *hash = query->data;
1851 struct osl_row *hash_sister;
1853 hash_sister = find_hash_sister(hash);
1856 pass_buffer_as_shm(fd, SBD_OUTPUT, (char *)&hash_sister,
1857 sizeof(hash_sister));
1860 static int get_row_pointer_from_result(struct osl_object *result,
1861 __a_unused uint8_t band, void *private)
1863 struct osl_row **row = private;
1864 *row = *(struct osl_row **)(result->data);
1868 static int add_one_audio_file(const char *path, void *private_data)
1870 int ret, send_ret = 1, fd;
1871 uint8_t format_num = -1;
1872 struct private_add_data *pad = private_data;
1873 struct afh_info afhi, *afhi_ptr = NULL;
1874 struct osl_row *pb = NULL, *hs = NULL; /* path brother/hash sister */
1875 struct osl_object map, obj = {.data = NULL}, query;
1876 unsigned char hash[HASH_SIZE];
1878 ret = guess_audio_format(path);
1879 if (ret < 0 && !(pad->flags & ADD_FLAG_ALL))
1881 query.data = (char *)path;
1882 query.size = strlen(path) + 1;
1883 ret = send_callback_request(path_brother_callback, &query,
1884 get_row_pointer_from_result, &pb);
1885 if (ret < 0 && ret != -OSL_ERRNO_TO_PARA_ERROR(E_OSL_RB_KEY_NOT_FOUND))
1888 if (pb && (pad->flags & ADD_FLAG_LAZY)) { /* lazy is really cheap */
1889 if (pad->flags & ADD_FLAG_VERBOSE)
1890 send_ret = send_sb_va(&pad->cc->scc, SBD_OUTPUT,
1891 "lazy-ignore: %s\n", path);
1894 /* We still want to add this file. Compute its hash. */
1895 ret = mmap_full_file(path, O_RDONLY, &map.data, &map.size, &fd);
1898 hash_function(map.data, map.size, hash);
1900 /* Check whether the database contains a file with the same hash. */
1902 query.size = HASH_SIZE;
1903 ret = send_callback_request(hash_sister_callback, &query,
1904 get_row_pointer_from_result, &hs);
1907 /* Return success if we already know this file. */
1909 if (pb && hs && hs == pb && !(pad->flags & ADD_FLAG_FORCE)) {
1910 if (pad->flags & ADD_FLAG_VERBOSE)
1911 send_ret = send_sb_va(&pad->cc->scc, SBD_OUTPUT,
1912 "%s exists, not forcing update\n", path);
1916 * We won't recalculate the audio format info and the chunk table if
1917 * there is a hash sister and FORCE was not given.
1919 if (!hs || (pad->flags & ADD_FLAG_FORCE)) {
1920 ret = compute_afhi(path, map.data, map.size, fd, &afhi);
1926 munmap(map.data, map.size);
1928 if (pad->flags & ADD_FLAG_VERBOSE) {
1929 send_ret = send_sb_va(&pad->cc->scc, SBD_OUTPUT,
1930 "adding %s\n", path);
1934 save_add_callback_buffer(hash, path, afhi_ptr, pad->flags, format_num, &obj);
1935 /* Ask afs to consider this entry for adding. */
1936 ret = send_callback_request(com_add_callback, &obj,
1937 afs_cb_result_handler, pad->cc);
1942 munmap(map.data, map.size);
1944 if (ret < 0 && send_ret >= 0)
1945 send_ret = send_sb_va(&pad->cc->scc, SBD_ERROR_LOG,
1946 "failed to add %s (%s)\n", path, para_strerror(-ret));
1948 clear_afhi(afhi_ptr);
1949 /* Stop adding files only on send errors. */
1953 int com_add(struct command_context *cc)
1956 struct private_add_data pad = {.cc = cc, .flags = 0};
1957 struct stat statbuf;
1959 for (i = 1; i < cc->argc; i++) {
1960 const char *arg = cc->argv[i];
1963 if (!strcmp(arg, "--")) {
1967 if (!strcmp(arg, "-a")) {
1968 pad.flags |= ADD_FLAG_ALL;
1971 if (!strcmp(arg, "-l")) {
1972 pad.flags |= ADD_FLAG_LAZY;
1975 if (!strcmp(arg, "-f")) {
1976 pad.flags |= ADD_FLAG_FORCE;
1979 if (!strcmp(arg, "-v")) {
1980 pad.flags |= ADD_FLAG_VERBOSE;
1985 return -E_AFT_SYNTAX;
1986 for (; i < cc->argc; i++) {
1988 ret = verify_path(cc->argv[i], &path);
1990 ret = send_sb_va(&cc->scc, SBD_ERROR_LOG, "%s: %s\n",
1991 cc->argv[i], para_strerror(-ret));
1996 ret = stat(path, &statbuf);
1998 ret = send_sb_va(&cc->scc, SBD_ERROR_LOG,
1999 "failed to stat %s (%s)\n", path,
2006 if (S_ISDIR(statbuf.st_mode))
2007 ret = for_each_file_in_dir(path, add_one_audio_file,
2010 ret = add_one_audio_file(path, &pad);
2012 send_sb_va(&cc->scc, SBD_OUTPUT, "%s: %s\n", path,
2013 para_strerror(-ret));
2023 * Flags used by the touch command.
2028 /** Whether the \p FNM_PATHNAME flag should be passed to fnmatch(). */
2029 TOUCH_FLAG_FNM_PATHNAME = 1,
2030 /** Activates verbose mode. */
2031 TOUCH_FLAG_VERBOSE = 2
2034 /** Options used by com_touch(). */
2035 struct com_touch_options {
2036 /** New num_played value. */
2038 /** New last played count. */
2039 int64_t last_played;
2040 /** New lyrics id. */
2042 /** New image id. */
2044 /** New amplification value. */
2046 /** Command line flags (see \ref touch_flags). */
2050 /** Data passed to the action handler of com_touch(). */
2051 struct touch_action_data {
2052 /** Command line options (see \ref com_touch_options). */
2053 struct com_touch_options *cto;
2054 /** Message buffer. */
2055 struct para_buffer pb;
2058 static int touch_audio_file(__a_unused struct osl_table *table,
2059 struct osl_row *row, const char *name, void *data)
2061 struct touch_action_data *tad = data;
2062 struct osl_object obj;
2063 struct afs_info old_afsi, new_afsi;
2064 int ret, no_options = tad->cto->num_played < 0 && tad->cto->last_played < 0 &&
2065 tad->cto->lyrics_id < 0 && tad->cto->image_id < 0 && tad->cto->amp < 0;
2066 struct afsi_change_event_data aced;
2068 ret = get_afsi_object_of_row(row, &obj);
2070 return para_printf(&tad->pb, "%s: %s\n", name, para_strerror(-ret));
2071 ret = load_afsi(&old_afsi, &obj);
2073 return para_printf(&tad->pb, "%s: %s\n", name, para_strerror(-ret));
2074 new_afsi = old_afsi;
2076 new_afsi.num_played++;
2077 new_afsi.last_played = time(NULL);
2078 if (tad->cto->flags & TOUCH_FLAG_VERBOSE) {
2079 ret = para_printf(&tad->pb, "%s: num_played = %u, "
2080 "last_played = now()\n", name,
2081 new_afsi.num_played);
2086 if (tad->cto->flags & TOUCH_FLAG_VERBOSE) {
2087 ret = para_printf(&tad->pb, "touching %s\n", name);
2091 if (tad->cto->lyrics_id >= 0)
2092 new_afsi.lyrics_id = tad->cto->lyrics_id;
2093 if (tad->cto->image_id >= 0)
2094 new_afsi.image_id = tad->cto->image_id;
2095 if (tad->cto->num_played >= 0)
2096 new_afsi.num_played = tad->cto->num_played;
2097 if (tad->cto->last_played >= 0)
2098 new_afsi.last_played = tad->cto->last_played;
2099 if (tad->cto->amp >= 0)
2100 new_afsi.amp = tad->cto->amp;
2102 save_afsi(&new_afsi, &obj); /* in-place update */
2104 aced.old_afsi = &old_afsi;
2105 afs_event(AFSI_CHANGE, &tad->pb, &aced);
2109 static void com_touch_callback(int fd, const struct osl_object *query)
2111 struct touch_action_data tad = {.cto = query->data,
2113 .max_size = shm_get_shmmax(),
2114 .private_data = &fd,
2115 .max_size_handler = afs_max_size_handler
2119 struct pattern_match_data pmd = {
2120 .table = audio_file_table,
2121 .loop_col_num = AFTCOL_HASH,
2122 .match_col_num = AFTCOL_PATH,
2123 .patterns = {.data = (char *)query->data + sizeof(*tad.cto),
2124 .size = query->size - sizeof(*tad.cto)},
2126 .action = touch_audio_file
2128 if (tad.cto->flags & TOUCH_FLAG_FNM_PATHNAME)
2129 pmd.fnmatch_flags |= FNM_PATHNAME;
2130 ret = for_each_matching_row(&pmd);
2132 ret2 = para_printf(&tad.pb, "%s\n", para_strerror(-ret));
2133 else if (pmd.num_matches == 0)
2134 ret2 = para_printf(&tad.pb, "no matches\n");
2135 if (ret2 >= 0 && tad.pb.offset)
2136 pass_buffer_as_shm(fd, SBD_OUTPUT, tad.pb.buf, tad.pb.offset);
2140 int com_touch(struct command_context *cc)
2142 struct com_touch_options cto = {
2149 struct osl_object query = {.data = &cto, .size = sizeof(cto)};
2153 for (i = 1; i < cc->argc; i++) {
2154 const char *arg = cc->argv[i];
2157 if (!strcmp(arg, "--")) {
2161 if (!strncmp(arg, "-n=", 3)) {
2162 ret = para_atoi32(arg + 3, &cto.num_played);
2167 if (!strncmp(arg, "-l=", 3)) {
2168 ret = para_atoi64(arg + 3, &cto.last_played);
2173 if (!strncmp(arg, "-y=", 3)) {
2174 ret = para_atoi32(arg + 3, &cto.lyrics_id);
2179 if (!strncmp(arg, "-i=", 3)) {
2180 ret = para_atoi32(arg + 3, &cto.image_id);
2185 if (!strncmp(arg, "-a=", 3)) {
2187 ret = para_atoi32(arg + 3, &val);
2190 if (val < 0 || val > 255)
2191 return -ERRNO_TO_PARA_ERROR(EINVAL);
2195 if (!strcmp(arg, "-p")) {
2196 cto.flags |= TOUCH_FLAG_FNM_PATHNAME;
2199 if (!strcmp(arg, "-v")) {
2200 cto.flags |= TOUCH_FLAG_VERBOSE;
2203 break; /* non-option starting with dash */
2206 return -E_AFT_SYNTAX;
2207 ret = send_option_arg_callback_request(&query, cc->argc - i,
2208 cc->argv + i, com_touch_callback, afs_cb_result_handler, cc);
2210 send_strerror(cc, -ret);
2214 /** Flags for com_rm(). */
2217 RM_FLAG_VERBOSE = 1,
2221 RM_FLAG_FNM_PATHNAME = 4
2224 /** Data passed to the action handler of com_rm(). */
2225 struct com_rm_action_data {
2226 /** Command line flags ((see \ref rm_flags). */
2228 /** Message buffer. */
2229 struct para_buffer pb;
2232 static int remove_audio_file(__a_unused struct osl_table *table,
2233 struct osl_row *row, const char *name, void *data)
2235 struct com_rm_action_data *crd = data;
2238 if (crd->flags & RM_FLAG_VERBOSE) {
2239 ret = para_printf(&crd->pb, "removing %s\n", name);
2243 afs_event(AUDIO_FILE_REMOVE, &crd->pb, row);
2244 ret = osl(osl_del_row(audio_file_table, row));
2246 para_printf(&crd->pb, "%s: %s\n", name, para_strerror(-ret));
2250 static void com_rm_callback(int fd, const struct osl_object *query)
2252 struct com_rm_action_data crd = {.flags = *(uint32_t *)query->data,
2254 .max_size = shm_get_shmmax(),
2255 .private_data = &fd,
2256 .max_size_handler = afs_max_size_handler
2260 struct pattern_match_data pmd = {
2261 .table = audio_file_table,
2262 .loop_col_num = AFTCOL_HASH,
2263 .match_col_num = AFTCOL_PATH,
2264 .patterns = {.data = (char *)query->data + sizeof(uint32_t),
2265 .size = query->size - sizeof(uint32_t)},
2267 .action = remove_audio_file
2269 if (crd.flags & RM_FLAG_FNM_PATHNAME)
2270 pmd.fnmatch_flags |= FNM_PATHNAME;
2271 ret = for_each_matching_row(&pmd);
2273 para_printf(&crd.pb, "%s\n", para_strerror(-ret));
2276 if ((pmd.num_matches == 0) && !(crd.flags & RM_FLAG_FORCE))
2277 ret = para_printf(&crd.pb, "no matches -- nothing removed\n");
2278 else if (crd.flags & RM_FLAG_VERBOSE) {
2279 ret = para_printf(&crd.pb, "removed %u files\n",
2282 if (ret >= 0 && crd.pb.offset)
2283 pass_buffer_as_shm(fd, SBD_OUTPUT, crd.pb.buf, crd.pb.offset);
2287 /* TODO options: -r (recursive) */
2288 int com_rm(struct command_context *cc)
2291 struct osl_object query = {.data = &flags, .size = sizeof(flags)};
2294 for (i = 1; i < cc->argc; i++) {
2295 const char *arg = cc->argv[i];
2298 if (!strcmp(arg, "--")) {
2302 if (!strcmp(arg, "-f")) {
2303 flags |= RM_FLAG_FORCE;
2306 if (!strcmp(arg, "-p")) {
2307 flags |= RM_FLAG_FNM_PATHNAME;
2310 if (!strcmp(arg, "-v")) {
2311 flags |= RM_FLAG_VERBOSE;
2317 return -E_AFT_SYNTAX;
2318 ret = send_option_arg_callback_request(&query, cc->argc - i,
2319 cc->argv + i, com_rm_callback, afs_cb_result_handler, cc);
2321 send_strerror(cc, -ret);
2326 * Flags used by the cpsi command.
2331 /** Whether the lyrics id should be copied. */
2332 CPSI_FLAG_COPY_LYRICS_ID = 1,
2333 /** Whether the image id should be copied. */
2334 CPSI_FLAG_COPY_IMAGE_ID = 2,
2335 /** Whether the lastplayed time should be copied. */
2336 CPSI_FLAG_COPY_LASTPLAYED = 4,
2337 /** Whether the numplayed count should be copied. */
2338 CPSI_FLAG_COPY_NUMPLAYED = 8,
2339 /** Whether the attributes should be copied. */
2340 CPSI_FLAG_COPY_ATTRIBUTES = 16,
2341 /** Activates verbose mode. */
2342 CPSI_FLAG_VERBOSE = 32,
2345 /** Data passed to the action handler of com_cpsi(). */
2346 struct cpsi_action_data {
2347 /** command line flags (see \ref cpsi_flags). */
2349 /** Message buffer. */
2350 struct para_buffer pb;
2351 /** Values are copied from here. */
2352 struct afs_info source_afsi;
2355 static int copy_selector_info(__a_unused struct osl_table *table,
2356 struct osl_row *row, const char *name, void *data)
2358 struct cpsi_action_data *cad = data;
2359 struct osl_object target_afsi_obj;
2361 struct afs_info old_afsi, target_afsi;
2362 struct afsi_change_event_data aced;
2364 ret = get_afsi_object_of_row(row, &target_afsi_obj);
2367 load_afsi(&target_afsi, &target_afsi_obj);
2368 old_afsi = target_afsi;
2369 if (cad->flags & CPSI_FLAG_COPY_LYRICS_ID)
2370 target_afsi.lyrics_id = cad->source_afsi.lyrics_id;
2371 if (cad->flags & CPSI_FLAG_COPY_IMAGE_ID)
2372 target_afsi.image_id = cad->source_afsi.image_id;
2373 if (cad->flags & CPSI_FLAG_COPY_LASTPLAYED)
2374 target_afsi.last_played = cad->source_afsi.last_played;
2375 if (cad->flags & CPSI_FLAG_COPY_NUMPLAYED)
2376 target_afsi.num_played = cad->source_afsi.num_played;
2377 if (cad->flags & CPSI_FLAG_COPY_ATTRIBUTES)
2378 target_afsi.attributes = cad->source_afsi.attributes;
2379 save_afsi(&target_afsi, &target_afsi_obj); /* in-place update */
2380 if (cad->flags & CPSI_FLAG_VERBOSE) {
2381 ret = para_printf(&cad->pb, "copied afsi to %s\n", name);
2386 aced.old_afsi = &old_afsi;
2387 afs_event(AFSI_CHANGE, &cad->pb, &aced);
2391 static void com_cpsi_callback(int fd, const struct osl_object *query)
2393 struct cpsi_action_data cad = {
2394 .flags = *(unsigned *)query->data,
2396 .max_size = shm_get_shmmax(),
2397 .private_data = &fd,
2398 .max_size_handler = afs_max_size_handler
2402 char *source_path = (char *)query->data + sizeof(cad.flags);
2403 struct pattern_match_data pmd = {
2404 .table = audio_file_table,
2405 .loop_col_num = AFTCOL_HASH,
2406 .match_col_num = AFTCOL_PATH,
2407 .patterns = {.data = source_path + strlen(source_path) + 1,
2408 .size = query->size - sizeof(cad.flags)
2409 - strlen(source_path) - 1},
2411 .action = copy_selector_info
2414 ret = get_afsi_of_path(source_path, &cad.source_afsi);
2417 ret = for_each_matching_row(&pmd);
2420 para_printf(&cad.pb, "%s\n", para_strerror(-ret));
2421 else if (pmd.num_matches > 0) {
2422 if (cad.flags & CPSI_FLAG_VERBOSE)
2423 para_printf(&cad.pb, "copied requested afsi from %s "
2424 "to %u files\n", source_path, pmd.num_matches);
2426 para_printf(&cad.pb, "no matches - nothing copied\n");
2428 pass_buffer_as_shm(fd, SBD_OUTPUT, cad.pb.buf, cad.pb.offset);
2432 int com_cpsi(struct command_context *cc)
2436 struct osl_object options = {.data = &flags, .size = sizeof(flags)};
2438 for (i = 1; i < cc->argc; i++) {
2439 const char *arg = cc->argv[i];
2442 if (!strcmp(arg, "--")) {
2446 if (!strcmp(arg, "-y")) {
2447 flags |= CPSI_FLAG_COPY_LYRICS_ID;
2450 if (!strcmp(arg, "-i")) {
2451 flags |= CPSI_FLAG_COPY_IMAGE_ID;
2454 if (!strcmp(arg, "-l")) {
2455 flags |= CPSI_FLAG_COPY_LASTPLAYED;
2458 if (!strcmp(arg, "-n")) {
2459 flags |= CPSI_FLAG_COPY_NUMPLAYED;
2462 if (!strcmp(arg, "-a")) {
2463 flags |= CPSI_FLAG_COPY_ATTRIBUTES;
2466 if (!strcmp(arg, "-v")) {
2467 flags |= CPSI_FLAG_VERBOSE;
2472 if (i + 1 >= cc->argc) /* need at least source file and pattern */
2473 return -E_AFT_SYNTAX;
2474 if (!(flags & ~CPSI_FLAG_VERBOSE)) /* no copy flags given */
2475 flags = ~(unsigned)CPSI_FLAG_VERBOSE | flags;
2476 ret = send_option_arg_callback_request(&options, cc->argc - i,
2477 cc->argv + i, com_cpsi_callback, afs_cb_result_handler, cc);
2479 send_strerror(cc, -ret);
2483 struct change_atts_data {
2484 uint64_t add_mask, del_mask;
2485 struct para_buffer pb;
2488 static int change_atts(__a_unused struct osl_table *table,
2489 struct osl_row *row, __a_unused const char *name, void *data)
2492 struct osl_object obj;
2493 struct afs_info old_afsi, new_afsi;
2494 struct afsi_change_event_data aced = {
2496 .old_afsi = &old_afsi
2498 struct change_atts_data *cad = data;
2500 ret = get_afsi_object_of_row(row, &obj);
2503 ret = load_afsi(&old_afsi, &obj);
2506 new_afsi = old_afsi;
2507 new_afsi.attributes |= cad->add_mask;
2508 new_afsi.attributes &= ~cad->del_mask;
2509 save_afsi(&new_afsi, &obj); /* in-place update */
2510 afs_event(AFSI_CHANGE, &cad->pb, &aced);
2514 static void com_setatt_callback(int fd, const struct osl_object *query)
2519 struct change_atts_data cad = {
2521 .max_size = shm_get_shmmax(),
2522 .max_size_handler = afs_max_size_handler,
2523 .private_data = &(struct afs_max_size_handler_data) {
2529 struct pattern_match_data pmd = {
2530 .table = audio_file_table,
2531 .loop_col_num = AFTCOL_HASH,
2532 .match_col_num = AFTCOL_PATH,
2533 .pm_flags = PM_SKIP_EMPTY_NAME,
2535 .action = change_atts
2538 for (p = query->data; p < (char *)query->data + query->size; p += len + 1) {
2540 unsigned char bitnum;
2543 ret = -E_ATTR_SYNTAX;
2547 if (c != '+' && c != '-')
2550 ret = get_attribute_bitnum_by_name(p, &bitnum);
2554 cad.add_mask |= (1UL << bitnum);
2556 cad.del_mask |= (1UL << bitnum);
2558 ret = -E_ATTR_SYNTAX;
2559 if (!cad.add_mask && !cad.del_mask)
2561 pmd.patterns.data = p;
2562 assert(p < (char *)query->data + query->size);
2563 pmd.patterns.size = (char *)query->data + query->size - p;
2564 ret = for_each_matching_row(&pmd);
2567 if (pmd.num_matches == 0)
2568 para_printf(&cad.pb, "no matches\n");
2571 para_printf(&cad.pb, "%s\n", para_strerror(-ret));
2573 pass_buffer_as_shm(fd, SBD_OUTPUT, cad.pb.buf, cad.pb.offset);
2577 int com_setatt(struct command_context *cc)
2580 return -E_ATTR_SYNTAX;
2581 return send_standard_callback_request(cc->argc - 1, cc->argv + 1,
2582 com_setatt_callback, afs_cb_result_handler, cc);
2585 static void afs_stat_callback(int fd, const struct osl_object *query)
2587 int *parser_friendly = query->data;
2588 char *buf = *parser_friendly?
2589 parser_friendly_status_items : status_items;
2593 pass_buffer_as_shm(fd, SBD_OUTPUT, buf, strlen(buf));
2597 * Get the current afs status items from the afs process and send it.
2599 * \param cc The command context, used e.g. for data encryption.
2600 * \param parser_friendly Whether parser-friendly output format should be used.
2602 * As the contents of the afs status items change in time and the command
2603 * handler only has a COW version created at fork time, it can not send
2604 * up-to-date afs status items directly. Therefore the usual callback mechanism
2605 * is used to pass the status items from the afs process to the command handler
2606 * via a shared memory area and a pipe.
2608 * \return The return value of the underlying call to \ref send_callback_request().
2610 int send_afs_status(struct command_context *cc, int parser_friendly)
2612 struct osl_object query = {.data = &parser_friendly,
2613 .size = sizeof(parser_friendly)};
2615 return send_callback_request(afs_stat_callback, &query,
2616 afs_cb_result_handler, cc);
2619 /* TODO: optionally fix problems by removing offending rows */
2620 static int check_audio_file(struct osl_row *row, void *data)
2623 struct para_buffer *pb = data;
2624 struct stat statbuf;
2625 int ret = get_audio_file_path_of_row(row, &path);
2626 struct afs_info afsi;
2630 return para_printf(pb, "%s\n", para_strerror(-ret));
2631 if (stat(path, &statbuf) < 0) {
2632 ret = para_printf(pb, "%s: stat error (%s)\n", path, strerror(errno));
2636 if (!S_ISREG(statbuf.st_mode)) {
2637 ret = para_printf(pb, "%s: not a regular file\n", path);
2642 ret = get_afsi_of_row(row, &afsi);
2644 return para_printf(pb, "%s: %s\n", path, para_strerror(-ret));
2645 ret = lyr_get_name_by_id(afsi.lyrics_id, &blob_name);
2647 ret = para_printf(pb, "%s lyrics id %u: %s\n", path, afsi.lyrics_id,
2648 para_strerror(-ret));
2652 ret = img_get_name_by_id(afsi.image_id, &blob_name);
2654 ret = para_printf(pb, "%s image id %u: %s\n", path, afsi.image_id,
2655 para_strerror(-ret));
2660 * Check the audio file table for inconsistencies.
2662 * \param fd The afs socket.
2663 * \param query Unused.
2665 * This function always succeeds.
2669 void aft_check_callback(int fd, __a_unused const struct osl_object *query)
2671 struct para_buffer pb = {
2672 .max_size = shm_get_shmmax(),
2673 .private_data = &(struct afs_max_size_handler_data) {
2677 .max_size_handler = afs_max_size_handler
2679 int ret = para_printf(&pb, "checking audio file table...\n");
2683 audio_file_loop(&pb, check_audio_file);
2685 pass_buffer_as_shm(fd, SBD_OUTPUT, pb.buf, pb.offset);
2690 * Close the audio file table.
2692 * \param flags Usual flags that are passed to osl_close_table().
2694 * \sa osl_close_table().
2696 static void aft_close(void)
2698 osl_close_table(audio_file_table, OSL_MARK_CLEAN);
2699 audio_file_table = NULL;
2703 * Open the audio file table.
2705 * \param dir The database directory.
2709 * \sa osl_open_table().
2711 static int aft_open(const char *dir)
2715 audio_file_table_desc.dir = dir;
2716 ret = osl(osl_open_table(&audio_file_table_desc, &audio_file_table));
2719 osl_get_num_rows(audio_file_table, &num);
2720 PARA_INFO_LOG("audio file table contains %d files\n", num);
2723 PARA_INFO_LOG("failed to open audio file table\n");
2724 audio_file_table = NULL;
2725 if (ret >= 0 || ret == -OSL_ERRNO_TO_PARA_ERROR(E_OSL_NOENT))
2730 static int aft_create(const char *dir)
2732 audio_file_table_desc.dir = dir;
2733 return osl(osl_create_table(&audio_file_table_desc));
2736 static int clear_attribute(struct osl_row *row, void *data)
2738 struct rmatt_event_data *red = data;
2739 struct afs_info afsi;
2740 struct osl_object obj;
2741 int ret = get_afsi_object_of_row(row, &obj);
2742 uint64_t mask = ~(1ULL << red->bitnum);
2746 ret = load_afsi(&afsi, &obj);
2749 afsi.attributes &= mask;
2750 save_afsi(&afsi, &obj);
2754 static int aft_event_handler(enum afs_events event, struct para_buffer *pb,
2760 case ATTRIBUTE_REMOVE: {
2761 const struct rmatt_event_data *red = data;
2762 ret = para_printf(pb, "clearing attribute %s (bit %u) from all "
2763 "entries in the audio file table\n", red->name,
2767 return audio_file_loop(data, clear_attribute);
2775 * Initialize the audio file table.
2777 * \param t Pointer to the structure to be initialized.
2779 void aft_init(struct afs_table *t)
2782 t->close = aft_close;
2783 t->create = aft_create;
2784 t->event_handler = aft_event_handler;