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. */
244 /* compare function for the hash column */
245 static int aft_hash_compare(const struct osl_object *obj1,
246 const struct osl_object *obj2)
248 return hash_compare((unsigned char *)obj1->data,
249 (unsigned char *)obj2->data);
252 static struct osl_column_description aft_cols[] = {
254 .storage_type = OSL_MAPPED_STORAGE,
255 .storage_flags = OSL_RBTREE | OSL_FIXED_SIZE | OSL_UNIQUE,
257 .compare_function = aft_hash_compare,
258 .data_size = HASH_SIZE
261 .storage_type = OSL_MAPPED_STORAGE,
262 .storage_flags = OSL_RBTREE | OSL_UNIQUE,
264 .compare_function = string_compare,
267 .storage_type = OSL_MAPPED_STORAGE,
268 .storage_flags = OSL_FIXED_SIZE,
270 .data_size = AFSI_SIZE
273 .storage_type = OSL_MAPPED_STORAGE,
277 .storage_type = OSL_DISK_STORAGE,
282 static struct osl_table_description audio_file_table_desc = {
283 .name = "audio_files",
284 .num_columns = NUM_AFT_COLUMNS,
285 .flags = OSL_LARGE_TABLE,
286 .column_descriptions = aft_cols
290 * Produce a canonicalized absolute pathname.
292 * Returns one if the resolved path a directory, zero if it is a regular file,
293 * negative on errors.
295 static int verify_path(const char *orig_path, char **resolved_path)
301 if (*orig_path != '/') /* we only accept absolute paths */
303 path = realpath(orig_path, NULL);
306 if (stat(path, &statbuf) < 0)
308 if (S_ISREG(statbuf.st_mode))
310 else if (S_ISDIR(statbuf.st_mode))
314 *resolved_path = path;
317 *resolved_path = NULL;
322 /** The on-disk layout of a afhi struct. */
324 /** Where the number of seconds is stored. */
325 AFHI_SECONDS_TOTAL_OFFSET = 0,
326 /** Position of the bitrate. */
327 AFHI_BITRATE_OFFSET = 4,
328 /** Position of the frequency. */
329 AFHI_FREQUENCY_OFFSET = 8,
330 /** Was: Location of the audio file header. */
331 AFHI_UNUSED1_OFFSET = 12,
332 /* Length of the audio file header. Zero means: No header. */
333 AFHI_HEADER_LEN_OFFSET = 16,
334 /** The total number of chunks (4 bytes). */
335 CHUNKS_TOTAL_OFFSET = 20,
336 /** The length of the audio file header (4 bytes). */
337 HEADER_LEN_OFFSET = 24,
338 /** Was: The start of the audio file header (4 bytes). */
339 AFHI_UNUSED2_OFFSET = 28,
340 /** The seconds part of the chunk time (4 bytes). */
341 CHUNK_TV_TV_SEC_OFFSET = 32,
342 /** The microseconds part of the chunk time (4 bytes). */
343 CHUNK_TV_TV_USEC_OFFSET = 36,
344 /** Number of channels is stored here. (1 byte) */
345 AFHI_CHANNELS_OFFSET = 40,
346 /** The tag info position. */
347 AFHI_INFO_STRING_OFFSET = 41,
348 /** Minimal on-disk size of a valid afhi struct. */
349 MIN_AFHI_SIZE = 47, /* at least 6 null bytes for techinfo/tags */
352 static unsigned sizeof_afhi_buf(const struct afh_info *afhi)
357 + strlen(afhi->techinfo)
358 + strlen(afhi->tags.artist)
359 + strlen(afhi->tags.title)
360 + strlen(afhi->tags.year)
361 + strlen(afhi->tags.album)
362 + strlen(afhi->tags.comment);
365 static void save_afhi(struct afh_info *afhi, char *buf)
371 write_u32(buf + AFHI_SECONDS_TOTAL_OFFSET, afhi->seconds_total);
372 write_u32(buf + AFHI_BITRATE_OFFSET, afhi->bitrate);
373 write_u32(buf + AFHI_FREQUENCY_OFFSET, afhi->frequency);
374 write_u32(buf + AFHI_UNUSED1_OFFSET, 0);
375 write_u32(buf + AFHI_HEADER_LEN_OFFSET, afhi->header_len);
376 write_u8(buf + AFHI_CHANNELS_OFFSET, afhi->channels);
377 write_u32(buf + CHUNKS_TOTAL_OFFSET, afhi->chunks_total);
378 write_u32(buf + HEADER_LEN_OFFSET, afhi->header_len);
379 write_u32(buf + AFHI_UNUSED2_OFFSET, 0);
380 write_u32(buf + CHUNK_TV_TV_SEC_OFFSET, afhi->chunk_tv.tv_sec);
381 write_u32(buf + CHUNK_TV_TV_USEC_OFFSET, afhi->chunk_tv.tv_usec);
382 p = buf + AFHI_INFO_STRING_OFFSET;
383 /* The sprintf's below are OK as our caller made sure that buf is large enough */
384 p += sprintf(p, "%s", afhi->techinfo) + 1;
385 p += sprintf(p, "%s", afhi->tags.artist) + 1;
386 p += sprintf(p, "%s", afhi->tags.title) + 1;
387 p += sprintf(p, "%s", afhi->tags.year) + 1;
388 p += sprintf(p, "%s", afhi->tags.album) + 1;
389 sprintf(p, "%s", afhi->tags.comment);
392 static void load_afhi(const char *buf, struct afh_info *afhi)
394 afhi->seconds_total = read_u32(buf + AFHI_SECONDS_TOTAL_OFFSET);
395 afhi->bitrate = read_u32(buf + AFHI_BITRATE_OFFSET);
396 afhi->frequency = read_u32(buf + AFHI_FREQUENCY_OFFSET);
397 afhi->header_len = read_u32(buf + AFHI_HEADER_LEN_OFFSET);
398 afhi->channels = read_u8(buf + AFHI_CHANNELS_OFFSET);
399 afhi->chunks_total = read_u32(buf + CHUNKS_TOTAL_OFFSET);
400 afhi->header_len = read_u32(buf + HEADER_LEN_OFFSET);
401 afhi->chunk_tv.tv_sec = read_u32(buf + CHUNK_TV_TV_SEC_OFFSET);
402 afhi->chunk_tv.tv_usec = read_u32(buf + CHUNK_TV_TV_USEC_OFFSET);
403 afhi->techinfo = (char *)buf + AFHI_INFO_STRING_OFFSET;
404 afhi->tags.artist = afhi->techinfo + strlen(afhi->techinfo) + 1;
405 afhi->tags.title = afhi->tags.artist + strlen(afhi->tags.artist) + 1;
406 afhi->tags.year = afhi->tags.title + strlen(afhi->tags.title) + 1;
407 afhi->tags.album = afhi->tags.year + strlen(afhi->tags.year) + 1;
408 afhi->tags.comment = afhi->tags.album + strlen(afhi->tags.album) + 1;
411 static unsigned sizeof_chunk_table(struct afh_info *afhi)
415 return 4 * (afhi->chunks_total + 1);
418 static uint32_t save_chunk_table(struct afh_info *afhi, char *buf)
421 uint32_t max = 0, old = 0;
423 for (i = 0; i <= afhi->chunks_total; i++) {
424 uint32_t val = afhi->chunk_table[i];
425 write_u32(buf + 4 * i, val);
427 * If the first chunk is the header, do not consider it for the
428 * calculation of the largest chunk size.
430 if (i == 0 || (i == 1 && afhi->header_len > 0)) {
434 max = PARA_MAX(max, val - old);
440 static void load_chunk_table(struct afh_info *afhi, char *buf)
444 afhi->chunk_table = para_malloc(sizeof_chunk_table(afhi));
445 for (i = 0; i <= afhi->chunks_total; i++)
446 afhi->chunk_table[i] = read_u32(buf + 4 * i);
450 * Get the row of the audio file table corresponding to the given path.
452 * \param path The full path of the audio file.
453 * \param row Result pointer.
457 int aft_get_row_of_path(const char *path, struct osl_row **row)
459 struct osl_object obj = {.data = (char *)path, .size = strlen(path) + 1};
461 return osl(osl_get_row(audio_file_table, AFTCOL_PATH, &obj, row));
465 * Get the row of the audio file table corresponding to the given hash value.
467 * \param hash The hash value of the desired audio file.
468 * \param row Result pointer.
472 static int aft_get_row_of_hash(unsigned char *hash, struct osl_row **row)
474 const struct osl_object obj = {.data = hash, .size = HASH_SIZE};
475 return osl(osl_get_row(audio_file_table, AFTCOL_HASH, &obj, row));
479 * Get the audio file selector info object of a row.
481 * \param row Pointer to a row in the audio file table.
482 * \param obj Result pointer.
486 static int get_afsi_object_of_row(const struct osl_row *row,
487 struct osl_object *obj)
489 return osl(osl_get_object(audio_file_table, row, AFTCOL_AFSI, obj));
493 * Get the osl object holding the audio file selector info, given a path.
496 * \param path The full path of the audio file.
497 * \param obj Result pointer.
499 * \return Positive on success, negative on errors.
501 static int get_afsi_object_of_path(const char *path, struct osl_object *obj)
504 int ret = aft_get_row_of_path(path, &row);
507 return get_afsi_object_of_row(row, obj);
511 * Get the audio file selector info, given a row of the audio file table.
513 * \param row Pointer to a row in the audio file table.
514 * \param afsi Result pointer.
516 * \return Positive on success, negative on errors.
518 int get_afsi_of_row(const struct osl_row *row, struct afs_info *afsi)
520 struct osl_object obj;
521 int ret = get_afsi_object_of_row(row, &obj);
524 return load_afsi(afsi, &obj);
528 * Get the audio file selector info, given the path of an audio table.
530 * \param path The full path of the audio file.
531 * \param afsi Result pointer.
535 static int get_afsi_of_path(const char *path, struct afs_info *afsi)
537 struct osl_object obj;
538 int ret = get_afsi_object_of_path(path, &obj);
541 return load_afsi(afsi, &obj);
545 * Get the path of an audio file, given a row of the audio file table.
547 * \param row Pointer to a row in the audio file table.
548 * \param path Result pointer.
550 * The result is a pointer to mmapped data. The caller must not attempt
555 int get_audio_file_path_of_row(const struct osl_row *row, char **path)
557 struct osl_object path_obj;
558 int ret = osl(osl_get_object(audio_file_table, row, AFTCOL_PATH,
562 *path = path_obj.data;
567 * Get the object containing the hash value of an audio file, given a row.
569 * \param row Pointer to a row of the audio file table.
570 * \param obj Result pointer.
572 * \return The return value of the underlying call to osl_get_object().
574 * \sa get_hash_of_row().
576 static int get_hash_object_of_aft_row(const struct osl_row *row,
577 struct osl_object *obj)
579 return osl(osl_get_object(audio_file_table, row, AFTCOL_HASH, obj));
583 * Get the hash value of an audio file, given a row of the audio file table.
585 * \param row Pointer to a row of the audio file table.
586 * \param hash Result pointer.
588 * \a hash points to mapped data and must not be freed by the caller.
590 * \return The return value of the underlying call to
591 * get_hash_object_of_aft_row().
593 static int get_hash_of_row(const struct osl_row *row, unsigned char **hash)
595 struct osl_object obj;
596 int ret = get_hash_object_of_aft_row(row, &obj);
605 * Get the audio format handler info, given a row of the audio file table.
607 * \param row Pointer to a row of the audio file table.
608 * \param afhi Result pointer.
610 * \return The return value of the underlying call to osl_get_object().
612 * \sa get_chunk_table_of_row().
614 int get_afhi_of_row(const struct osl_row *row, struct afh_info *afhi)
616 struct osl_object obj;
617 int ret = osl(osl_get_object(audio_file_table, row, AFTCOL_AFHI,
621 load_afhi(obj.data, afhi);
625 /* returns shmid on success */
626 static int save_afd(struct audio_file_data *afd)
628 size_t size = sizeof(*afd) + sizeof_chunk_table(&afd->afhi);
629 int shmid, ret = shm_new(size);
636 ret = shm_attach(shmid, ATTACH_RW, &shm_afd);
641 afd->max_chunk_size = save_chunk_table(&afd->afhi, buf);
642 *(struct audio_file_data *)shm_afd = *afd;
651 * Extract a afd stored in a shared memory area.
653 * Attach the shared memory area given by \a shmid, load the audio file data
654 * stored therein and detach the area afterwards. Called by vss, after
655 * receiving a positive response to the request for the next audio file.
657 * \param shmid The identifier of the shared memory area containing the afd.
658 * \param afd Result pointer.
662 int load_afd(int shmid, struct audio_file_data *afd)
667 ret = shm_attach(shmid, ATTACH_RO, &shm_afd);
670 *afd = *(struct audio_file_data *)shm_afd;
671 load_chunk_table(&afd->afhi, shm_afd + sizeof(*afd));
676 static int get_local_time(uint64_t *seconds, char *buf, size_t size,
677 time_t current_time, enum ls_listing_mode lm)
681 * Omit year but show time if the given value is closer to the current
682 * time than this many seconds.
684 const time_t m = 6 * 30 * 24 * 3600; /* six months */
686 tm = localtime((time_t *)seconds);
689 if (lm == LS_MODE_MBOX) {
690 if (!strftime(buf, size, "%c", tm))
694 if (*seconds > current_time - m && *seconds < current_time + m) {
695 if (!strftime(buf, size, "%b %e %k:%M", tm))
699 if (!strftime(buf, size, "%b %e %Y", tm))
704 /** Compute the number of (decimal) digits of a number. */
705 #define GET_NUM_DIGITS(x, num) { \
706 typeof((x)) _tmp = PARA_ABS(x); \
709 while ((_tmp) > 9) { \
715 __a_const static short unsigned get_duration_width(int seconds)
717 short unsigned width;
718 unsigned hours = seconds / 3600, mins = (seconds % 3600) / 60;
720 if (!hours) /* less than one hour => m:ss or mm:ss => 4 or 5 digits */
721 return 4 + (mins > 9);
722 /* more than one hour => h:mm:ss, hh:mm:ss, hhh:mm:ss, ... */
723 GET_NUM_DIGITS(hours, &width);
727 static void get_duration_buf(int seconds, char *buf, struct ls_options *opts)
729 unsigned hours = seconds / 3600, mins = (seconds % 3600) / 60;
730 short unsigned max_width;
732 if (!hours) { /* m:ss or mm:ss */
733 max_width = opts->mode == LS_MODE_LONG?
734 opts->widths.duration_width : 4;
735 sprintf(buf, "%*u:%02u", max_width - 3, mins, seconds % 60);
736 } else { /* more than one hour => h:mm:ss, hh:mm:ss, hhh:mm:ss, ... */
737 max_width = opts->mode == LS_MODE_LONG?
738 opts->widths.duration_width : 7;
739 sprintf(buf, "%*u:%02u:%02u", max_width - 6, hours, mins,
744 static int write_attribute_items(struct para_buffer *b,
745 const char *att_bitmap, struct afs_info *afsi)
750 WRITE_STATUS_ITEM(b, SI_ATTRIBUTES_BITMAP, "%s\n", att_bitmap);
751 ret = get_attribute_text(&afsi->attributes, " ", &att_text);
754 WRITE_STATUS_ITEM(b, SI_ATTRIBUTES_TXT, "%s\n", att_text);
759 static void write_lyrics_items(struct para_buffer *b, struct afs_info *afsi)
763 WRITE_STATUS_ITEM(b, SI_LYRICS_ID, "%u\n", afsi->lyrics_id);
764 lyr_get_name_by_id(afsi->lyrics_id, &lyrics_name);
765 WRITE_STATUS_ITEM(b, SI_LYRICS_NAME, "%s\n", lyrics_name?
766 lyrics_name : "(none)");
769 static void write_image_items(struct para_buffer *b, struct afs_info *afsi)
773 WRITE_STATUS_ITEM(b, SI_IMAGE_ID, "%u\n", afsi->image_id);
774 img_get_name_by_id(afsi->image_id, &image_name);
775 WRITE_STATUS_ITEM(b, SI_IMAGE_NAME, "%s\n", image_name?
776 image_name : "(none)");
779 static void write_filename_items(struct para_buffer *b, const char *path,
784 if (!(flags & LS_FLAG_FULL_PATH)) {
785 WRITE_STATUS_ITEM(b, SI_BASENAME, "%s\n", path);
788 WRITE_STATUS_ITEM(b, SI_PATH, "%s\n", path);
789 val = para_basename(path);
790 WRITE_STATUS_ITEM(b, SI_BASENAME, "%s\n", val? val : "");
791 val = para_dirname(path);
792 WRITE_STATUS_ITEM(b, SI_DIRECTORY, "%s\n", val? val : "");
796 static int print_chunk_table(struct ls_data *d, struct para_buffer *b)
798 struct osl_object chunk_table_obj;
799 struct osl_row *aft_row;
803 ret = aft_get_row_of_hash(d->hash, &aft_row);
806 ret = osl(osl_open_disk_object(audio_file_table, aft_row,
807 AFTCOL_CHUNKS, &chunk_table_obj));
810 para_printf(b, "%s\n"
811 "chunk_time: %lu:%lu\nchunk_offsets: ",
813 (long unsigned) d->afhi.chunk_tv.tv_sec,
814 (long unsigned) d->afhi.chunk_tv.tv_usec
816 buf = chunk_table_obj.data;
817 for (i = 0; i <= d->afhi.chunks_total; i++)
818 para_printf(b, "%u ", (unsigned) read_u32(buf + 4 * i));
819 para_printf(b, "\n");
821 osl_close_disk_object(&chunk_table_obj);
825 static void write_score(struct para_buffer *b, struct ls_data *d,
826 struct ls_options *opts)
828 if (!(opts->flags & LS_FLAG_ADMISSIBLE_ONLY)) /* no score*/
830 WRITE_STATUS_ITEM(b, SI_SCORE, "%li\n", d->score);
833 static int print_list_item(struct ls_data *d, struct ls_options *opts,
834 struct para_buffer *b, time_t current_time)
838 char last_played_time[30];
839 char duration_buf[30]; /* nobody has an audio file long enough to overflow this */
840 struct afs_info *afsi = &d->afsi;
841 struct afh_info *afhi = &d->afhi;
842 char asc_hash[2 * HASH_SIZE + 1];
844 if (opts->mode == LS_MODE_SHORT) {
845 para_printf(b, "%s\n", d->path);
849 if (opts->mode == LS_MODE_CHUNKS) {
850 ret = print_chunk_table(d, b);
853 get_attribute_bitmap(&afsi->attributes, att_buf);
854 if (opts->flags & LS_FLAG_UNIXDATE)
855 sprintf(last_played_time, "%llu",
856 (long long unsigned)afsi->last_played);
858 ret = get_local_time(&afsi->last_played, last_played_time,
859 sizeof(last_played_time), current_time, opts->mode);
863 get_duration_buf(afhi->seconds_total, duration_buf, opts);
864 if (opts->mode == LS_MODE_LONG) {
865 struct ls_widths *w = &opts->widths;
866 if (opts->flags & LS_FLAG_ADMISSIBLE_ONLY) {
867 para_printf(b, "%*li ", opts->widths.score_width,
871 "%s " /* attributes */
873 "%*d " /* image_id */
874 "%*d " /* lyrics_id */
876 "%*s " /* audio format */
877 "%*d " /* frequency */
880 "%*d " /* num_played */
881 "%s " /* last_played */
884 w->amp_width, afsi->amp,
885 w->image_id_width, afsi->image_id,
886 w->lyrics_id_width, afsi->lyrics_id,
887 w->bitrate_width, afhi->bitrate,
888 w->audio_format_width,
889 audio_format_name(afsi->audio_format_id),
890 w->frequency_width, afhi->frequency,
893 w->num_played_width, afsi->num_played,
900 if (opts->mode == LS_MODE_MBOX) {
901 const char *bn = para_basename(d->path);
903 "From foo@localhost %s\n"
904 "Received: from\nTo: bar\nFrom: a\n"
909 write_filename_items(b, d->path, opts->flags);
910 write_score(b, d, opts);
911 ret = write_attribute_items(b, att_buf, afsi);
914 write_image_items(b, afsi);
915 write_lyrics_items(b, afsi);
916 hash_to_asc(d->hash, asc_hash);
917 WRITE_STATUS_ITEM(b, SI_HASH, "%s\n", asc_hash);
918 WRITE_STATUS_ITEM(b, SI_BITRATE, "%dkbit/s\n", afhi->bitrate);
919 WRITE_STATUS_ITEM(b, SI_FORMAT, "%s\n",
920 audio_format_name(afsi->audio_format_id));
921 WRITE_STATUS_ITEM(b, SI_FREQUENCY, "%dHz\n", afhi->frequency);
922 WRITE_STATUS_ITEM(b, SI_CHANNELS, "%d\n", afhi->channels);
923 WRITE_STATUS_ITEM(b, SI_DURATION, "%s\n", duration_buf);
924 WRITE_STATUS_ITEM(b, SI_SECONDS_TOTAL, "%lu\n", afhi->seconds_total);
925 WRITE_STATUS_ITEM(b, SI_LAST_PLAYED, "%s\n", last_played_time);
926 WRITE_STATUS_ITEM(b, SI_NUM_PLAYED, "%d\n", afsi->num_played);
927 WRITE_STATUS_ITEM(b, SI_AMPLIFICATION, "%u\n", afsi->amp);
928 WRITE_STATUS_ITEM(b, SI_CHUNK_TIME, "%lu\n", tv2ms(&afhi->chunk_tv));
929 WRITE_STATUS_ITEM(b, SI_NUM_CHUNKS, "%lu\n", afhi->chunks_total);
930 WRITE_STATUS_ITEM(b, SI_TECHINFO, "%s\n", afhi->techinfo);
931 WRITE_STATUS_ITEM(b, SI_ARTIST, "%s\n", afhi->tags.artist);
932 WRITE_STATUS_ITEM(b, SI_TITLE, "%s\n", afhi->tags.title);
933 WRITE_STATUS_ITEM(b, SI_YEAR, "%s\n", afhi->tags.year);
934 WRITE_STATUS_ITEM(b, SI_ALBUM, "%s\n", afhi->tags.album);
935 WRITE_STATUS_ITEM(b, SI_COMMENT, "%s\n", afhi->tags.comment);
936 if (opts->mode == LS_MODE_MBOX) {
937 struct osl_object lyrics_def;
938 lyr_get_def_by_id(afsi->lyrics_id, &lyrics_def);
939 if (lyrics_def.data) {
940 para_printf(b, "Lyrics:\n~~~~~~~\n%s",
941 (char *)lyrics_def.data);
942 osl_close_disk_object(&lyrics_def);
949 static struct ls_data status_item_ls_data;
950 static struct osl_row *current_aft_row;
952 static void make_inode_status_items(struct para_buffer *pb)
954 struct stat statbuf = {.st_size = 0};
955 char *path, mtime_str[30] = "\0";
959 ret = get_audio_file_path_of_row(current_aft_row, &path);
962 ret = stat(path, &statbuf);
965 localtime_r(&statbuf.st_mtime, &mtime_tm);
966 ret = strftime(mtime_str, 29, "%b %d %Y", &mtime_tm);
967 assert(ret > 0); /* number of bytes placed in mtime_str */
969 WRITE_STATUS_ITEM(pb, SI_MTIME, "%s\n", mtime_str);
970 WRITE_STATUS_ITEM(pb, SI_FILE_SIZE, "%ld\n", statbuf.st_size / 1024);
973 static int make_status_items(void)
975 struct ls_options opts = {
976 .flags = LS_FLAG_FULL_PATH | LS_FLAG_ADMISSIBLE_ONLY,
977 .mode = LS_MODE_VERBOSE,
979 struct para_buffer pb = {.max_size = shm_get_shmmax() - 1};
984 ret = print_list_item(&status_item_ls_data, &opts, &pb, current_time);
987 make_inode_status_items(&pb);
989 status_items = pb.buf;
990 memset(&pb, 0, sizeof(pb));
991 pb.max_size = shm_get_shmmax() - 1;
992 pb.flags = PBF_SIZE_PREFIX;
993 ret = print_list_item(&status_item_ls_data, &opts, &pb, current_time);
999 make_inode_status_items(&pb);
1000 free(parser_friendly_status_items);
1001 parser_friendly_status_items = pb.buf;
1006 * Open the audio file with highest score and set up an afd structure.
1008 * \param afd Result pointer.
1010 * On success, the numplayed field of the audio file selector info is increased
1011 * and the lastplayed time is set to the current time. Finally, the score of
1012 * the audio file is updated.
1014 * \return Positive shmid on success, negative on errors.
1016 int open_and_update_audio_file(struct audio_file_data *afd)
1018 unsigned char file_hash[HASH_SIZE];
1019 struct osl_object afsi_obj;
1020 struct afs_info new_afsi;
1022 struct afsi_change_event_data aced;
1023 struct osl_object map, chunk_table_obj;
1024 struct ls_data *d = &status_item_ls_data;
1026 ret = score_get_best(¤t_aft_row, &d->score);
1029 ret = get_hash_of_row(current_aft_row, &d->hash);
1032 ret = get_audio_file_path_of_row(current_aft_row, &d->path);
1035 PARA_NOTICE_LOG("%s\n", d->path);
1036 ret = get_afsi_object_of_row(current_aft_row, &afsi_obj);
1039 ret = load_afsi(&d->afsi, &afsi_obj);
1042 ret = get_afhi_of_row(current_aft_row, &afd->afhi);
1045 d->afhi = afd->afhi;
1046 d->afhi.chunk_table = afd->afhi.chunk_table = NULL;
1047 ret = osl(osl_open_disk_object(audio_file_table, current_aft_row,
1048 AFTCOL_CHUNKS, &chunk_table_obj));
1051 ret = mmap_full_file(d->path, O_RDONLY, &map.data, &map.size, &afd->fd);
1054 hash_function(map.data, map.size, file_hash);
1055 ret = hash_compare(file_hash, d->hash);
1056 para_munmap(map.data, map.size);
1058 ret = -E_HASH_MISMATCH;
1062 new_afsi.num_played++;
1063 new_afsi.last_played = time(NULL);
1064 save_afsi(&new_afsi, &afsi_obj); /* in-place update */
1066 afd->audio_format_id = d->afsi.audio_format_id;
1067 load_chunk_table(&afd->afhi, chunk_table_obj.data);
1068 aced.aft_row = current_aft_row;
1069 aced.old_afsi = &d->afsi;
1071 * No need to update the status items as the AFSI_CHANGE event will
1074 ret = afs_event(AFSI_CHANGE, NULL, &aced);
1077 ret = save_afd(afd);
1079 free(afd->afhi.chunk_table);
1080 osl_close_disk_object(&chunk_table_obj);
1082 PARA_ERROR_LOG("%s: %s\n", d->path, para_strerror(-ret));
1083 ret = score_delete(current_aft_row);
1090 static int ls_audio_format_compare(const void *a, const void *b)
1092 struct ls_data *d1 = *(struct ls_data **)a, *d2 = *(struct ls_data **)b;
1093 return NUM_COMPARE(d1->afsi.audio_format_id, d2->afsi.audio_format_id);
1096 static int ls_duration_compare(const void *a, const void *b)
1098 struct ls_data *d1 = *(struct ls_data **)a, *d2 = *(struct ls_data **)b;
1099 return NUM_COMPARE(d1->afhi.seconds_total, d2->afhi.seconds_total);
1102 static int ls_bitrate_compare(const void *a, const void *b)
1104 struct ls_data *d1 = *(struct ls_data **)a, *d2 = *(struct ls_data **)b;
1105 return NUM_COMPARE(d1->afhi.bitrate, d2->afhi.bitrate);
1108 static int ls_lyrics_id_compare(const void *a, const void *b)
1110 struct ls_data *d1 = *(struct ls_data **)a, *d2 = *(struct ls_data **)b;
1111 return NUM_COMPARE(d1->afsi.lyrics_id, d2->afsi.lyrics_id);
1114 static int ls_image_id_compare(const void *a, const void *b)
1116 struct ls_data *d1 = *(struct ls_data **)a, *d2 = *(struct ls_data **)b;
1117 return NUM_COMPARE(d1->afsi.image_id, d2->afsi.image_id);
1120 static int ls_channels_compare(const void *a, const void *b)
1122 struct ls_data *d1 = *(struct ls_data **)a, *d2 = *(struct ls_data **)b;
1123 return NUM_COMPARE(d1->afhi.channels, d2->afhi.channels);
1126 static int ls_frequency_compare(const void *a, const void *b)
1128 struct ls_data *d1 = *(struct ls_data **)a, *d2 = *(struct ls_data **)b;
1129 return NUM_COMPARE(d1->afhi.frequency, d2->afhi.frequency);
1132 static int ls_num_played_compare(const void *a, const void *b)
1134 struct ls_data *d1 = *(struct ls_data **)a, *d2 = *(struct ls_data **)b;
1135 return NUM_COMPARE(d1->afsi.num_played, d2->afsi.num_played);
1138 static int ls_last_played_compare(const void *a, const void *b)
1140 struct ls_data *d1 = *(struct ls_data **)a, *d2 = *(struct ls_data **)b;
1141 return NUM_COMPARE(d1->afsi.last_played, d2->afsi.last_played);
1144 static int ls_score_compare(const void *a, const void *b)
1146 struct ls_data *d1 = *(struct ls_data **)a, *d2 = *(struct ls_data **)b;
1147 return NUM_COMPARE(d1->score, d2->score);
1150 static int ls_path_compare(const void *a, const void *b)
1152 struct ls_data *d1 = *(struct ls_data **)a, *d2 = *(struct ls_data **)b;
1153 return strcmp(d1->path, d2->path);
1156 static int sort_matching_paths(struct ls_options *options)
1158 size_t nmemb = options->num_matching_paths;
1159 size_t size = sizeof(*options->data_ptr);
1160 int (*compar)(const void *, const void *);
1163 options->data_ptr = para_malloc(nmemb * sizeof(*options->data_ptr));
1164 for (i = 0; i < nmemb; i++)
1165 options->data_ptr[i] = options->data + i;
1167 /* In these cases the array is already sorted */
1168 if (options->sorting == LS_SORT_BY_PATH
1169 && !(options->flags & LS_FLAG_ADMISSIBLE_ONLY)
1170 && (options->flags & LS_FLAG_FULL_PATH))
1172 if (options->sorting == LS_SORT_BY_SCORE &&
1173 options->flags & LS_FLAG_ADMISSIBLE_ONLY)
1176 switch (options->sorting) {
1177 case LS_SORT_BY_PATH:
1178 compar = ls_path_compare; break;
1179 case LS_SORT_BY_SCORE:
1180 compar = ls_score_compare; break;
1181 case LS_SORT_BY_LAST_PLAYED:
1182 compar = ls_last_played_compare; break;
1183 case LS_SORT_BY_NUM_PLAYED:
1184 compar = ls_num_played_compare; break;
1185 case LS_SORT_BY_FREQUENCY:
1186 compar = ls_frequency_compare; break;
1187 case LS_SORT_BY_CHANNELS:
1188 compar = ls_channels_compare; break;
1189 case LS_SORT_BY_IMAGE_ID:
1190 compar = ls_image_id_compare; break;
1191 case LS_SORT_BY_LYRICS_ID:
1192 compar = ls_lyrics_id_compare; break;
1193 case LS_SORT_BY_BITRATE:
1194 compar = ls_bitrate_compare; break;
1195 case LS_SORT_BY_DURATION:
1196 compar = ls_duration_compare; break;
1197 case LS_SORT_BY_AUDIO_FORMAT:
1198 compar = ls_audio_format_compare; break;
1202 qsort(options->data_ptr, nmemb, size, compar);
1206 /* row is either an aft_row or a row of the score table */
1207 /* TODO: Only compute widths if we need them */
1208 static int prepare_ls_row(struct osl_row *row, void *ls_opts)
1211 struct ls_options *options = ls_opts;
1213 struct ls_widths *w;
1214 unsigned short num_digits;
1216 struct osl_row *aft_row;
1220 if (options->flags & LS_FLAG_ADMISSIBLE_ONLY) {
1221 ret = get_score_and_aft_row(row, &score, &aft_row);
1228 ret = get_audio_file_path_of_row(aft_row, &path);
1231 if (!(options->flags & LS_FLAG_FULL_PATH)) {
1232 char *p = strrchr(path, '/');
1236 if (options->num_patterns) {
1237 for (i = 0; i < options->num_patterns; i++) {
1238 ret = fnmatch(options->patterns[i], path, 0);
1241 if (ret == FNM_NOMATCH)
1245 if (i >= options->num_patterns) /* no match */
1248 tmp = options->num_matching_paths++;
1249 if (options->num_matching_paths > options->array_size) {
1250 options->array_size++;
1251 options->array_size *= 2;
1252 options->data = para_realloc(options->data, options->array_size
1253 * sizeof(*options->data));
1255 d = options->data + tmp;
1256 ret = get_afsi_of_row(aft_row, &d->afsi);
1259 ret = get_afhi_of_row(aft_row, &d->afhi);
1263 ret = get_hash_of_row(aft_row, &d->hash);
1266 w = &options->widths;
1267 GET_NUM_DIGITS(d->afsi.image_id, &num_digits);
1268 w->image_id_width = PARA_MAX(w->image_id_width, num_digits);
1269 GET_NUM_DIGITS(d->afsi.lyrics_id, &num_digits);
1270 w->lyrics_id_width = PARA_MAX(w->lyrics_id_width, num_digits);
1271 GET_NUM_DIGITS(d->afhi.bitrate, &num_digits);
1272 w->bitrate_width = PARA_MAX(w->bitrate_width, num_digits);
1273 GET_NUM_DIGITS(d->afhi.frequency, &num_digits);
1274 w->frequency_width = PARA_MAX(w->frequency_width, num_digits);
1275 GET_NUM_DIGITS(d->afsi.num_played, &num_digits);
1276 w->num_played_width = PARA_MAX(w->num_played_width, num_digits);
1277 /* get the number of chars to print this amount of time */
1278 num_digits = get_duration_width(d->afhi.seconds_total);
1279 w->duration_width = PARA_MAX(w->duration_width, num_digits);
1280 GET_NUM_DIGITS(d->afsi.amp, &num_digits);
1281 w->amp_width = PARA_MAX(w->amp_width, num_digits);
1282 num_digits = strlen(audio_format_name(d->afsi.audio_format_id));
1283 w->audio_format_width = PARA_MAX(w->audio_format_width, num_digits);
1284 if (options->flags & LS_FLAG_ADMISSIBLE_ONLY) {
1285 GET_NUM_DIGITS(score, &num_digits);
1286 num_digits++; /* add one for the sign (space or "-") */
1287 w->score_width = PARA_MAX(w->score_width, num_digits);
1295 static int com_ls_callback(struct afs_callback_arg *aca)
1297 struct ls_options *opts = aca->query.data;
1298 char *p, *pattern_start = (char *)aca->query.data + sizeof(*opts);
1300 time_t current_time;
1302 aca->pbout.flags = (opts->mode == LS_MODE_PARSER)? PBF_SIZE_PREFIX : 0;
1303 if (opts->num_patterns) {
1304 opts->patterns = para_malloc(opts->num_patterns * sizeof(char *));
1305 for (i = 0, p = pattern_start; i < opts->num_patterns; i++) {
1306 opts->patterns[i] = p;
1310 opts->patterns = NULL;
1311 if (opts->flags & LS_FLAG_ADMISSIBLE_ONLY)
1312 ret = admissible_file_loop(opts, prepare_ls_row);
1314 ret = osl(osl_rbtree_loop(audio_file_table, AFTCOL_PATH, opts,
1318 if (opts->num_matching_paths == 0) {
1319 ret = opts->num_patterns > 0? -E_NO_MATCH : 0;
1322 ret = sort_matching_paths(opts);
1325 time(¤t_time);
1326 if (opts->flags & LS_FLAG_REVERSE)
1327 for (i = opts->num_matching_paths - 1; i >= 0; i--) {
1328 ret = print_list_item(opts->data_ptr[i], opts,
1329 &aca->pbout, current_time);
1334 for (i = 0; i < opts->num_matching_paths; i++) {
1335 ret = print_list_item(opts->data_ptr[i], opts,
1336 &aca->pbout, current_time);
1342 free(opts->data_ptr);
1343 free(opts->patterns);
1348 * TODO: flags -h (sort by hash)
1350 int com_ls(struct command_context *cc)
1354 enum ls_sorting_method sort = LS_SORT_BY_PATH;
1355 enum ls_listing_mode mode = LS_MODE_SHORT;
1356 struct ls_options opts = {.patterns = NULL};
1357 struct osl_object query = {.data = &opts, .size = sizeof(opts)};
1359 for (i = 1; i < cc->argc; i++) {
1360 const char *arg = cc->argv[i];
1363 if (!strcmp(arg, "--")) {
1368 * Compatibility: Prior to 0.5.5 it was necessary to specify
1369 * the listing mode without the '=' character as in -lv, for
1370 * example. Now the variant with '=' is preferred and
1371 * documented but we still accept the old way to specify the
1374 * Support for the legacy syntax can be dropped at 0.6.0
1377 if (!strncmp(arg, "-l", 2)) {
1383 mode = LS_MODE_SHORT;
1387 mode = LS_MODE_LONG;
1390 mode = LS_MODE_VERBOSE;
1393 mode = LS_MODE_MBOX;
1396 mode = LS_MODE_CHUNKS;
1399 mode = LS_MODE_PARSER;
1402 return -E_AFT_SYNTAX;
1405 if (!strcmp(arg, "-p")) {
1406 flags |= LS_FLAG_FULL_PATH;
1409 if (!strcmp(arg, "-a")) {
1410 flags |= LS_FLAG_ADMISSIBLE_ONLY;
1413 if (!strcmp(arg, "-r")) {
1414 flags |= LS_FLAG_REVERSE;
1417 if (!strcmp(arg, "-d")) {
1418 flags |= LS_FLAG_UNIXDATE;
1421 /* The compatibility remark above applies also to -s. */
1422 if (!strncmp(arg, "-s", 2)) {
1428 sort = LS_SORT_BY_PATH;
1430 case 's': /* -ss implies -a */
1431 sort = LS_SORT_BY_SCORE;
1432 flags |= LS_FLAG_ADMISSIBLE_ONLY;
1435 sort = LS_SORT_BY_LAST_PLAYED;
1438 sort = LS_SORT_BY_NUM_PLAYED;
1441 sort = LS_SORT_BY_FREQUENCY;
1444 sort = LS_SORT_BY_CHANNELS;
1447 sort = LS_SORT_BY_IMAGE_ID;
1450 sort = LS_SORT_BY_LYRICS_ID;
1453 sort = LS_SORT_BY_BITRATE;
1456 sort = LS_SORT_BY_DURATION;
1459 sort = LS_SORT_BY_AUDIO_FORMAT;
1462 return -E_AFT_SYNTAX;
1465 return -E_AFT_SYNTAX;
1468 opts.sorting = sort;
1470 opts.num_patterns = cc->argc - i;
1471 return send_option_arg_callback_request(&query, opts.num_patterns,
1472 cc->argv + i, com_ls_callback, afs_cb_result_handler, cc);
1476 * Call the given function for each file in the audio file table.
1478 * \param private_data An arbitrary data pointer, passed to \a func.
1479 * \param func The custom function to be called.
1483 int audio_file_loop(void *private_data, osl_rbtree_loop_func *func)
1485 return osl(osl_rbtree_loop(audio_file_table, AFTCOL_HASH, private_data,
1489 static int find_hash_sister(unsigned char *hash, struct osl_row **result)
1491 int ret = aft_get_row_of_hash(hash, result);
1493 if (ret == -OSL_ERRNO_TO_PARA_ERROR(E_OSL_RB_KEY_NOT_FOUND))
1498 static int find_path_brother(const char *path, struct osl_row **result)
1500 int ret = aft_get_row_of_path(path, result);
1502 if (ret == -OSL_ERRNO_TO_PARA_ERROR(E_OSL_RB_KEY_NOT_FOUND))
1507 /** The format of the data stored by save_audio_file_data(). */
1508 enum com_add_buffer_offsets {
1509 /* afhi (if present) starts at this offset. */
1510 CAB_AFHI_OFFSET_POS = 0,
1511 /** Start of the chunk table (if present). */
1512 CAB_CHUNKS_OFFSET_POS = 4,
1513 /** Flags given to the add command. */
1514 CAB_FLAGS_OFFSET = 8,
1515 /** Audio format id. */
1516 CAB_AUDIO_FORMAT_ID_OFFSET = 12,
1517 /** The hash of the audio file being added. */
1518 CAB_HASH_OFFSET = 13,
1519 /** Start of the path of the audio file. */
1520 CAB_PATH_OFFSET = (CAB_HASH_OFFSET + HASH_SIZE),
1524 * Store the given data to a single buffer. Doesn't need the audio file selector
1525 * info struct as the server knows it as well.
1527 * It's OK to call this with afhi == NULL. In this case, the audio format
1528 * handler info won't be stored in the buffer.
1530 static void save_add_callback_buffer(unsigned char *hash, const char *path,
1531 struct afh_info *afhi, uint32_t flags,
1532 uint8_t audio_format_num, struct osl_object *obj)
1534 size_t path_len = strlen(path) + 1;
1535 size_t afhi_size = sizeof_afhi_buf(afhi);
1536 size_t size = CAB_PATH_OFFSET + path_len + afhi_size
1537 + sizeof_chunk_table(afhi);
1538 char *buf = para_malloc(size);
1541 pos = CAB_PATH_OFFSET + path_len;
1542 write_u32(buf + CAB_AFHI_OFFSET_POS, pos);
1543 save_afhi(afhi, buf + pos);
1546 write_u32(buf + CAB_CHUNKS_OFFSET_POS, pos);
1548 save_chunk_table(afhi, buf + pos);
1550 write_u32(buf + CAB_FLAGS_OFFSET, flags);
1551 write_u8(buf + CAB_AUDIO_FORMAT_ID_OFFSET, audio_format_num);
1553 memcpy(buf + CAB_HASH_OFFSET, hash, HASH_SIZE);
1554 strcpy(buf + CAB_PATH_OFFSET, path);
1562 Overview of the add command.
1564 Input: What was passed to the callback by the command handler.
1566 HS: Hash sister. Whether an audio file with identical hash
1567 already exists in the osl database.
1569 PB: Path brother. Whether a file with the given path exists
1572 F: Force flag given. Whether add was called with -f.
1574 output: Action performed by the callback.
1576 AFHI: Whether afhi and chunk table are computed and sent.
1577 ACTION: Table modifications to be done by the callback.
1579 +----+----+---+------+---------------------------------------------------+
1580 | HS | PB | F | AFHI | ACTION
1581 +----+----+---+------+---------------------------------------------------+
1582 | Y | Y | Y | Y | if HS != PB: remove PB. HS: force afhi update,
1583 | | update path, keep afsi
1584 +----+----+---+------+---------------------------------------------------+
1585 | Y | Y | N | N | if HS == PB: do not send callback request at all.
1586 | | otherwise: remove PB, HS: update path, keep afhi,
1588 +----+----+---+------+---------------------------------------------------+
1589 | Y | N | Y | Y | (rename) force afhi update of HS, update path of
1591 +----+----+---+------+---------------------------------------------------+
1592 | Y | N | N | N | (file rename) update path of HS, keep afsi, afhi
1593 +----+----+---+------+---------------------------------------------------+
1594 | N | Y | Y | Y | (file change) update afhi, hash, of PB, keep afsi
1595 | | (force has no effect)
1596 +----+----+---+------+---------------------------------------------------+
1597 | N | Y | N | Y | (file change) update afhi, hash of PB, keep afsi
1598 +----+----+---+------+---------------------------------------------------+
1599 | N | N | Y | Y | (new file) create new entry (force has no effect)
1600 +----+----+---+------+---------------------------------------------------+
1601 | N | N | N | Y | (new file) create new entry
1602 +----+----+---+------+---------------------------------------------------+
1606 afhi <=> force or no HS
1611 /** Flags passed to the add command. */
1612 enum com_add_flags {
1613 /** Skip paths that exist already. */
1615 /** Force adding. */
1617 /** Print what is being done. */
1618 ADD_FLAG_VERBOSE = 4,
1619 /** Try to add files with unknown suffixes. */
1623 static int com_add_callback(struct afs_callback_arg *aca)
1625 char *buf = aca->query.data, *path;
1626 struct osl_row *pb, *aft_row;
1628 struct osl_object objs[NUM_AFT_COLUMNS];
1629 unsigned char *hash;
1630 char asc[2 * HASH_SIZE + 1];
1632 char afsi_buf[AFSI_SIZE];
1633 uint32_t flags = read_u32(buf + CAB_FLAGS_OFFSET);
1634 struct afs_info default_afsi = {.last_played = 0};
1635 uint16_t afhi_offset, chunks_offset;
1637 hash = (unsigned char *)buf + CAB_HASH_OFFSET;
1638 hash_to_asc(hash, asc);
1639 objs[AFTCOL_HASH].data = buf + CAB_HASH_OFFSET;
1640 objs[AFTCOL_HASH].size = HASH_SIZE;
1642 path = buf + CAB_PATH_OFFSET;
1643 objs[AFTCOL_PATH].data = path;
1644 objs[AFTCOL_PATH].size = strlen(path) + 1;
1646 PARA_INFO_LOG("request to add %s\n", path);
1647 ret = find_hash_sister(hash, &hs);
1650 ret = find_path_brother(path, &pb);
1653 if (hs && pb && hs == pb && !(flags & ADD_FLAG_FORCE)) {
1654 if (flags & ADD_FLAG_VERBOSE)
1655 para_printf(&aca->pbout, "ignoring duplicate\n");
1659 if (hs && hs != pb) {
1660 struct osl_object obj;
1661 if (pb) { /* hs trumps pb, remove pb */
1662 if (flags & ADD_FLAG_VERBOSE)
1663 para_printf(&aca->pbout, "removing %s\n", path);
1664 ret = afs_event(AUDIO_FILE_REMOVE, &aca->pbout, pb);
1667 ret = osl(osl_del_row(audio_file_table, pb));
1672 /* file rename, update hs' path */
1673 if (flags & ADD_FLAG_VERBOSE) {
1674 ret = osl(osl_get_object(audio_file_table, hs,
1675 AFTCOL_PATH, &obj));
1678 para_printf(&aca->pbout, "renamed from %s\n",
1681 ret = osl(osl_update_object(audio_file_table, hs, AFTCOL_PATH,
1682 &objs[AFTCOL_PATH]));
1685 ret = afs_event(AUDIO_FILE_RENAME, &aca->pbout, hs);
1688 if (!(flags & ADD_FLAG_FORCE))
1691 /* no hs or force mode, child must have sent afhi */
1692 afhi_offset = read_u32(buf + CAB_AFHI_OFFSET_POS);
1693 chunks_offset = read_u32(buf + CAB_CHUNKS_OFFSET_POS);
1695 objs[AFTCOL_AFHI].data = buf + afhi_offset;
1696 objs[AFTCOL_AFHI].size = chunks_offset - afhi_offset;
1698 if (!objs[AFTCOL_AFHI].size) /* "impossible" */
1700 objs[AFTCOL_CHUNKS].data = buf + chunks_offset;
1701 objs[AFTCOL_CHUNKS].size = aca->query.size - chunks_offset;
1702 if (pb && !hs) { /* update pb's hash */
1703 char old_asc[2 * HASH_SIZE + 1];
1704 unsigned char *old_hash;
1705 ret = get_hash_of_row(pb, &old_hash);
1708 hash_to_asc(old_hash, old_asc);
1709 if (flags & ADD_FLAG_VERBOSE)
1710 para_printf(&aca->pbout, "file change: %s -> %s\n",
1712 ret = osl_update_object(audio_file_table, pb, AFTCOL_HASH,
1713 &objs[AFTCOL_HASH]);
1717 if (hs || pb) { /* (hs != NULL and pb != NULL) implies hs == pb */
1718 struct osl_row *row = pb? pb : hs;
1719 /* update afhi and chunk_table */
1720 if (flags & ADD_FLAG_VERBOSE)
1721 para_printf(&aca->pbout,
1722 "updating afhi and chunk table\n");
1723 ret = osl(osl_update_object(audio_file_table, row, AFTCOL_AFHI,
1724 &objs[AFTCOL_AFHI]));
1727 ret = osl(osl_update_object(audio_file_table, row, AFTCOL_CHUNKS,
1728 &objs[AFTCOL_CHUNKS]));
1731 ret = afs_event(AFHI_CHANGE, &aca->pbout, row);
1736 /* new entry, use default afsi */
1737 if (flags & ADD_FLAG_VERBOSE)
1738 para_printf(&aca->pbout, "new file\n");
1739 default_afsi.last_played = time(NULL) - 365 * 24 * 60 * 60;
1740 default_afsi.audio_format_id = read_u8(buf + CAB_AUDIO_FORMAT_ID_OFFSET);
1742 objs[AFTCOL_AFSI].data = &afsi_buf;
1743 objs[AFTCOL_AFSI].size = AFSI_SIZE;
1744 save_afsi(&default_afsi, &objs[AFTCOL_AFSI]);
1745 ret = osl(osl_add_and_get_row(audio_file_table, objs, &aft_row));
1746 ret = afs_event(AUDIO_FILE_ADD, &aca->pbout, aft_row);
1749 para_printf(&aca->pbout, "could not add %s\n", path);
1753 /** Used by com_add(). */
1754 struct private_add_data {
1755 /** The pointer passed to the original command handler. */
1756 struct command_context *cc;
1757 /** The given add flags. */
1761 static int path_brother_callback(struct afs_callback_arg *aca)
1763 char *path = aca->query.data;
1764 struct osl_row *path_brother;
1765 int ret = find_path_brother(path, &path_brother);
1768 return pass_buffer_as_shm(aca->fd, SBD_OUTPUT, (char *)&path_brother,
1769 sizeof(path_brother));
1772 static int hash_sister_callback(struct afs_callback_arg *aca)
1774 unsigned char *hash = aca->query.data;
1775 struct osl_row *hash_sister;
1776 int ret = find_hash_sister(hash, &hash_sister);
1780 return pass_buffer_as_shm(aca->fd, SBD_OUTPUT, (char *)&hash_sister,
1781 sizeof(hash_sister));
1784 static int get_row_pointer_from_result(struct osl_object *result,
1785 __a_unused uint8_t band, void *private)
1787 struct osl_row **row = private;
1789 if (band == SBD_OUTPUT)
1790 *row = *(struct osl_row **)(result->data);
1794 static int add_one_audio_file(const char *path, void *private_data)
1796 int ret, send_ret = 1, fd;
1797 uint8_t format_num = -1;
1798 struct private_add_data *pad = private_data;
1799 struct afh_info afhi, *afhi_ptr = NULL;
1800 struct osl_row *pb = NULL, *hs = NULL; /* path brother/hash sister */
1801 struct osl_object map, obj = {.data = NULL}, query;
1802 unsigned char hash[HASH_SIZE];
1804 ret = guess_audio_format(path);
1805 if (ret < 0 && !(pad->flags & ADD_FLAG_ALL)) {
1809 query.data = (char *)path;
1810 query.size = strlen(path) + 1;
1811 ret = send_callback_request(path_brother_callback, &query,
1812 get_row_pointer_from_result, &pb);
1813 if (ret < 0 && ret != -OSL_ERRNO_TO_PARA_ERROR(E_OSL_RB_KEY_NOT_FOUND))
1816 if (pb && (pad->flags & ADD_FLAG_LAZY)) { /* lazy is really cheap */
1817 if (pad->flags & ADD_FLAG_VERBOSE)
1818 send_ret = send_sb_va(&pad->cc->scc, SBD_OUTPUT,
1819 "lazy-ignore: %s\n", path);
1822 /* We still want to add this file. Compute its hash. */
1823 ret = mmap_full_file(path, O_RDONLY, &map.data, &map.size, &fd);
1826 hash_function(map.data, map.size, hash);
1828 /* Check whether the database contains a file with the same hash. */
1830 query.size = HASH_SIZE;
1831 ret = send_callback_request(hash_sister_callback, &query,
1832 get_row_pointer_from_result, &hs);
1835 /* Return success if we already know this file. */
1837 if (pb && hs && hs == pb && !(pad->flags & ADD_FLAG_FORCE)) {
1838 if (pad->flags & ADD_FLAG_VERBOSE)
1839 send_ret = send_sb_va(&pad->cc->scc, SBD_OUTPUT,
1840 "%s exists, not forcing update\n", path);
1844 * We won't recalculate the audio format info and the chunk table if
1845 * there is a hash sister and FORCE was not given.
1847 if (!hs || (pad->flags & ADD_FLAG_FORCE)) {
1848 ret = compute_afhi(path, map.data, map.size, fd, &afhi);
1854 munmap(map.data, map.size);
1856 if (pad->flags & ADD_FLAG_VERBOSE) {
1857 send_ret = send_sb_va(&pad->cc->scc, SBD_OUTPUT,
1858 "adding %s\n", path);
1862 save_add_callback_buffer(hash, path, afhi_ptr, pad->flags, format_num, &obj);
1863 /* Ask afs to consider this entry for adding. */
1864 ret = send_callback_request(com_add_callback, &obj,
1865 afs_cb_result_handler, pad->cc);
1870 munmap(map.data, map.size);
1872 if (ret < 0 && send_ret >= 0)
1873 send_ret = send_sb_va(&pad->cc->scc, SBD_ERROR_LOG,
1874 "failed to add %s (%s)\n", path, para_strerror(-ret));
1876 clear_afhi(afhi_ptr);
1877 /* Stop adding files only on send errors. */
1881 int com_add(struct command_context *cc)
1884 struct private_add_data pad = {.cc = cc, .flags = 0};
1886 for (i = 1; i < cc->argc; i++) {
1887 const char *arg = cc->argv[i];
1890 if (!strcmp(arg, "--")) {
1894 if (!strcmp(arg, "-a")) {
1895 pad.flags |= ADD_FLAG_ALL;
1898 if (!strcmp(arg, "-l")) {
1899 pad.flags |= ADD_FLAG_LAZY;
1902 if (!strcmp(arg, "-f")) {
1903 pad.flags |= ADD_FLAG_FORCE;
1906 if (!strcmp(arg, "-v")) {
1907 pad.flags |= ADD_FLAG_VERBOSE;
1912 return -E_AFT_SYNTAX;
1913 for (; i < cc->argc; i++) {
1915 ret = verify_path(cc->argv[i], &path);
1917 ret = send_sb_va(&cc->scc, SBD_ERROR_LOG, "%s: %s\n",
1918 cc->argv[i], para_strerror(-ret));
1923 if (ret == 1) /* directory */
1924 ret = for_each_file_in_dir(path, add_one_audio_file,
1926 else /* regular file */
1927 ret = add_one_audio_file(path, &pad);
1929 send_sb_va(&cc->scc, SBD_OUTPUT, "%s: %s\n", path,
1930 para_strerror(-ret));
1940 * Flags used by the touch command.
1945 /** Whether the \p FNM_PATHNAME flag should be passed to fnmatch(). */
1946 TOUCH_FLAG_FNM_PATHNAME = 1,
1947 /** Activates verbose mode. */
1948 TOUCH_FLAG_VERBOSE = 2
1951 /** Options used by com_touch(). */
1952 struct com_touch_options {
1953 /** New num_played value. */
1955 /** New last played count. */
1956 int64_t last_played;
1957 /** New lyrics id. */
1959 /** New image id. */
1961 /** New amplification value. */
1963 /** Command line flags (see \ref touch_flags). */
1967 static int touch_audio_file(__a_unused struct osl_table *table,
1968 struct osl_row *row, const char *name, void *data)
1970 struct afs_callback_arg *aca = data;
1971 struct com_touch_options *cto = aca->query.data;
1972 struct osl_object obj;
1973 struct afs_info old_afsi, new_afsi;
1974 int ret, no_options = cto->num_played < 0 && cto->last_played < 0 &&
1975 cto->lyrics_id < 0 && cto->image_id < 0 && cto->amp < 0;
1976 struct afsi_change_event_data aced;
1978 ret = get_afsi_object_of_row(row, &obj);
1980 para_printf(&aca->pbout, "cannot touch %s\n", name);
1983 ret = load_afsi(&old_afsi, &obj);
1985 para_printf(&aca->pbout, "cannot touch %s\n", name);
1988 new_afsi = old_afsi;
1990 new_afsi.num_played++;
1991 new_afsi.last_played = time(NULL);
1992 if (cto->flags & TOUCH_FLAG_VERBOSE)
1993 para_printf(&aca->pbout, "%s: num_played = %u, "
1994 "last_played = now()\n", name,
1995 new_afsi.num_played);
1997 if (cto->flags & TOUCH_FLAG_VERBOSE)
1998 para_printf(&aca->pbout, "touching %s\n", name);
1999 if (cto->lyrics_id >= 0)
2000 new_afsi.lyrics_id = cto->lyrics_id;
2001 if (cto->image_id >= 0)
2002 new_afsi.image_id = cto->image_id;
2003 if (cto->num_played >= 0)
2004 new_afsi.num_played = cto->num_played;
2005 if (cto->last_played >= 0)
2006 new_afsi.last_played = cto->last_played;
2008 new_afsi.amp = cto->amp;
2010 save_afsi(&new_afsi, &obj); /* in-place update */
2012 aced.old_afsi = &old_afsi;
2013 return afs_event(AFSI_CHANGE, &aca->pbout, &aced);
2016 static int com_touch_callback(struct afs_callback_arg *aca)
2019 struct com_touch_options *cto = aca->query.data;
2020 struct pattern_match_data pmd = {
2021 .table = audio_file_table,
2022 .loop_col_num = AFTCOL_HASH,
2023 .match_col_num = AFTCOL_PATH,
2025 .data = (char *)aca->query.data
2026 + sizeof(struct com_touch_options),
2027 .size = aca->query.size
2028 - sizeof(struct com_touch_options)
2031 .action = touch_audio_file
2033 if (cto->flags & TOUCH_FLAG_FNM_PATHNAME)
2034 pmd.fnmatch_flags |= FNM_PATHNAME;
2035 ret = for_each_matching_row(&pmd);
2036 if (ret >= 0 && pmd.num_matches == 0)
2041 int com_touch(struct command_context *cc)
2043 struct com_touch_options cto = {
2050 struct osl_object query = {.data = &cto, .size = sizeof(cto)};
2054 for (i = 1; i < cc->argc; i++) {
2055 const char *arg = cc->argv[i];
2058 if (!strcmp(arg, "--")) {
2062 if (!strncmp(arg, "-n=", 3)) {
2063 ret = para_atoi32(arg + 3, &cto.num_played);
2068 if (!strncmp(arg, "-l=", 3)) {
2069 ret = para_atoi64(arg + 3, &cto.last_played);
2074 if (!strncmp(arg, "-y=", 3)) {
2075 ret = para_atoi32(arg + 3, &cto.lyrics_id);
2080 if (!strncmp(arg, "-i=", 3)) {
2081 ret = para_atoi32(arg + 3, &cto.image_id);
2086 if (!strncmp(arg, "-a=", 3)) {
2088 ret = para_atoi32(arg + 3, &val);
2091 if (val < 0 || val > 255)
2092 return -ERRNO_TO_PARA_ERROR(EINVAL);
2096 if (!strcmp(arg, "-p")) {
2097 cto.flags |= TOUCH_FLAG_FNM_PATHNAME;
2100 if (!strcmp(arg, "-v")) {
2101 cto.flags |= TOUCH_FLAG_VERBOSE;
2104 break; /* non-option starting with dash */
2107 return -E_AFT_SYNTAX;
2108 return send_option_arg_callback_request(&query, cc->argc - i,
2109 cc->argv + i, com_touch_callback, afs_cb_result_handler, cc);
2112 /** Flags for com_rm(). */
2115 RM_FLAG_VERBOSE = 1,
2119 RM_FLAG_FNM_PATHNAME = 4
2122 static int remove_audio_file(__a_unused struct osl_table *table,
2123 struct osl_row *row, const char *name, void *data)
2125 struct afs_callback_arg *aca = data;
2126 uint32_t flags =*(uint32_t *)aca->query.data;
2129 if (flags & RM_FLAG_VERBOSE)
2130 para_printf(&aca->pbout, "removing %s\n", name);
2131 ret = afs_event(AUDIO_FILE_REMOVE, &aca->pbout, row);
2134 ret = osl(osl_del_row(audio_file_table, row));
2136 para_printf(&aca->pbout, "cannot remove %s\n", name);
2140 static int com_rm_callback(struct afs_callback_arg *aca)
2143 uint32_t flags = *(uint32_t *)aca->query.data;
2144 struct pattern_match_data pmd = {
2145 .table = audio_file_table,
2146 .loop_col_num = AFTCOL_HASH,
2147 .match_col_num = AFTCOL_PATH,
2148 .patterns = {.data = (char *)aca->query.data + sizeof(uint32_t),
2149 .size = aca->query.size - sizeof(uint32_t)},
2151 .action = remove_audio_file
2153 if (flags & RM_FLAG_FNM_PATHNAME)
2154 pmd.fnmatch_flags |= FNM_PATHNAME;
2155 ret = for_each_matching_row(&pmd);
2158 if (pmd.num_matches == 0) {
2159 if (!(flags & RM_FLAG_FORCE))
2161 } else if (flags & RM_FLAG_VERBOSE)
2162 para_printf(&aca->pbout, "removed %u file(s)\n",
2168 /* TODO options: -r (recursive) */
2169 int com_rm(struct command_context *cc)
2172 struct osl_object query = {.data = &flags, .size = sizeof(flags)};
2175 for (i = 1; i < cc->argc; i++) {
2176 const char *arg = cc->argv[i];
2179 if (!strcmp(arg, "--")) {
2183 if (!strcmp(arg, "-f")) {
2184 flags |= RM_FLAG_FORCE;
2187 if (!strcmp(arg, "-p")) {
2188 flags |= RM_FLAG_FNM_PATHNAME;
2191 if (!strcmp(arg, "-v")) {
2192 flags |= RM_FLAG_VERBOSE;
2198 return -E_AFT_SYNTAX;
2199 return send_option_arg_callback_request(&query, cc->argc - i,
2200 cc->argv + i, com_rm_callback, afs_cb_result_handler, cc);
2204 * Flags used by the cpsi command.
2209 /** Whether the lyrics id should be copied. */
2210 CPSI_FLAG_COPY_LYRICS_ID = 1,
2211 /** Whether the image id should be copied. */
2212 CPSI_FLAG_COPY_IMAGE_ID = 2,
2213 /** Whether the lastplayed time should be copied. */
2214 CPSI_FLAG_COPY_LASTPLAYED = 4,
2215 /** Whether the numplayed count should be copied. */
2216 CPSI_FLAG_COPY_NUMPLAYED = 8,
2217 /** Whether the attributes should be copied. */
2218 CPSI_FLAG_COPY_ATTRIBUTES = 16,
2219 /** Activates verbose mode. */
2220 CPSI_FLAG_VERBOSE = 32,
2223 /** Data passed to the action handler of com_cpsi(). */
2224 struct cpsi_action_data {
2225 /** command line flags (see \ref cpsi_flags). */
2227 /** Values are copied from here. */
2228 struct afs_info source_afsi;
2229 /** What was passed to com_cpsi_callback(). */
2230 struct afs_callback_arg *aca;
2233 static int copy_selector_info(__a_unused struct osl_table *table,
2234 struct osl_row *row, const char *name, void *data)
2236 struct cpsi_action_data *cad = data;
2237 struct osl_object target_afsi_obj;
2239 struct afs_info old_afsi, target_afsi;
2240 struct afsi_change_event_data aced;
2242 ret = get_afsi_object_of_row(row, &target_afsi_obj);
2245 load_afsi(&target_afsi, &target_afsi_obj);
2246 old_afsi = target_afsi;
2247 if (cad->flags & CPSI_FLAG_COPY_LYRICS_ID)
2248 target_afsi.lyrics_id = cad->source_afsi.lyrics_id;
2249 if (cad->flags & CPSI_FLAG_COPY_IMAGE_ID)
2250 target_afsi.image_id = cad->source_afsi.image_id;
2251 if (cad->flags & CPSI_FLAG_COPY_LASTPLAYED)
2252 target_afsi.last_played = cad->source_afsi.last_played;
2253 if (cad->flags & CPSI_FLAG_COPY_NUMPLAYED)
2254 target_afsi.num_played = cad->source_afsi.num_played;
2255 if (cad->flags & CPSI_FLAG_COPY_ATTRIBUTES)
2256 target_afsi.attributes = cad->source_afsi.attributes;
2257 save_afsi(&target_afsi, &target_afsi_obj); /* in-place update */
2258 if (cad->flags & CPSI_FLAG_VERBOSE)
2259 para_printf(&cad->aca->pbout, "copied afsi to %s\n", name);
2261 aced.old_afsi = &old_afsi;
2262 return afs_event(AFSI_CHANGE, &cad->aca->pbout, &aced);
2265 static int com_cpsi_callback(struct afs_callback_arg *aca)
2267 struct cpsi_action_data cad = {
2268 .flags = *(unsigned *)aca->query.data,
2272 char *source_path = (char *)aca->query.data + sizeof(cad.flags);
2273 struct pattern_match_data pmd = {
2274 .table = audio_file_table,
2275 .loop_col_num = AFTCOL_HASH,
2276 .match_col_num = AFTCOL_PATH,
2277 .patterns = {.data = source_path + strlen(source_path) + 1,
2278 .size = aca->query.size - sizeof(cad.flags)
2279 - strlen(source_path) - 1},
2281 .action = copy_selector_info
2284 ret = get_afsi_of_path(source_path, &cad.source_afsi);
2287 ret = for_each_matching_row(&pmd);
2290 if (pmd.num_matches > 0) {
2291 if (cad.flags & CPSI_FLAG_VERBOSE)
2292 para_printf(&aca->pbout, "updated afsi of %u file(s)\n",
2300 int com_cpsi(struct command_context *cc)
2304 struct osl_object options = {.data = &flags, .size = sizeof(flags)};
2306 for (i = 1; i < cc->argc; i++) {
2307 const char *arg = cc->argv[i];
2310 if (!strcmp(arg, "--")) {
2314 if (!strcmp(arg, "-y")) {
2315 flags |= CPSI_FLAG_COPY_LYRICS_ID;
2318 if (!strcmp(arg, "-i")) {
2319 flags |= CPSI_FLAG_COPY_IMAGE_ID;
2322 if (!strcmp(arg, "-l")) {
2323 flags |= CPSI_FLAG_COPY_LASTPLAYED;
2326 if (!strcmp(arg, "-n")) {
2327 flags |= CPSI_FLAG_COPY_NUMPLAYED;
2330 if (!strcmp(arg, "-a")) {
2331 flags |= CPSI_FLAG_COPY_ATTRIBUTES;
2334 if (!strcmp(arg, "-v")) {
2335 flags |= CPSI_FLAG_VERBOSE;
2340 if (i + 1 >= cc->argc) /* need at least source file and pattern */
2341 return -E_AFT_SYNTAX;
2342 if (!(flags & ~CPSI_FLAG_VERBOSE)) /* no copy flags given */
2343 flags = ~(unsigned)CPSI_FLAG_VERBOSE | flags;
2344 return send_option_arg_callback_request(&options, cc->argc - i,
2345 cc->argv + i, com_cpsi_callback, afs_cb_result_handler, cc);
2348 struct change_atts_data {
2349 uint64_t add_mask, del_mask;
2350 struct afs_callback_arg *aca;
2353 static int change_atts(__a_unused struct osl_table *table,
2354 struct osl_row *row, __a_unused const char *name, void *data)
2357 struct osl_object obj;
2358 struct afs_info old_afsi, new_afsi;
2359 struct afsi_change_event_data aced = {
2361 .old_afsi = &old_afsi
2363 struct change_atts_data *cad = data;
2365 ret = get_afsi_object_of_row(row, &obj);
2368 ret = load_afsi(&old_afsi, &obj);
2371 new_afsi = old_afsi;
2372 new_afsi.attributes |= cad->add_mask;
2373 new_afsi.attributes &= ~cad->del_mask;
2374 save_afsi(&new_afsi, &obj); /* in-place update */
2375 return afs_event(AFSI_CHANGE, &cad->aca->pbout, &aced);
2378 static int com_setatt_callback(struct afs_callback_arg *aca)
2383 struct change_atts_data cad = {.aca = aca};
2384 struct pattern_match_data pmd = {
2385 .table = audio_file_table,
2386 .loop_col_num = AFTCOL_HASH,
2387 .match_col_num = AFTCOL_PATH,
2388 .pm_flags = PM_SKIP_EMPTY_NAME,
2390 .action = change_atts
2394 p = aca->query.data;
2395 p < (char *)aca->query.data + aca->query.size;
2399 unsigned char bitnum;
2402 ret = -E_ATTR_SYNTAX;
2406 if (c != '+' && c != '-')
2409 ret = get_attribute_bitnum_by_name(p, &bitnum);
2411 para_printf(&aca->pbout, "attribute not found: %s\n", p);
2415 cad.add_mask |= (1UL << bitnum);
2417 cad.del_mask |= (1UL << bitnum);
2419 ret = -E_ATTR_SYNTAX;
2420 if (!cad.add_mask && !cad.del_mask)
2422 pmd.patterns.data = p;
2423 if (p >= (char *)aca->query.data + aca->query.size)
2425 pmd.patterns.size = (char *)aca->query.data + aca->query.size - p;
2426 ret = for_each_matching_row(&pmd);
2429 if (pmd.num_matches == 0)
2435 int com_setatt(struct command_context *cc)
2438 return -E_ATTR_SYNTAX;
2439 return send_standard_callback_request(cc->argc - 1, cc->argv + 1,
2440 com_setatt_callback, afs_cb_result_handler, cc);
2443 static int afs_stat_callback(struct afs_callback_arg *aca)
2445 int *parser_friendly = aca->query.data;
2446 char *buf = *parser_friendly?
2447 parser_friendly_status_items : status_items;
2451 return pass_buffer_as_shm(aca->fd, SBD_OUTPUT, buf, strlen(buf));
2455 * Get the current afs status items from the afs process and send it.
2457 * \param cc The command context, used e.g. for data encryption.
2458 * \param parser_friendly Whether parser-friendly output format should be used.
2460 * As the contents of the afs status items change in time and the command
2461 * handler only has a COW version created at fork time, it can not send
2462 * up-to-date afs status items directly. Therefore the usual callback mechanism
2463 * is used to pass the status items from the afs process to the command handler
2464 * via a shared memory area and a pipe.
2466 * \return The return value of the underlying call to \ref send_callback_request().
2468 int send_afs_status(struct command_context *cc, int parser_friendly)
2470 struct osl_object query = {.data = &parser_friendly,
2471 .size = sizeof(parser_friendly)};
2473 return send_callback_request(afs_stat_callback, &query,
2474 afs_cb_result_handler, cc);
2477 /* returns success on non-fatal errors to keep the loop going */
2478 static int check_audio_file(struct osl_row *row, void *data)
2481 struct para_buffer *pb = data;
2482 struct stat statbuf;
2483 int ret = get_audio_file_path_of_row(row, &path);
2484 struct afs_info afsi;
2488 para_printf(pb, "%s\n", para_strerror(-ret));
2491 if (stat(path, &statbuf) < 0)
2492 para_printf(pb, "%s: stat error (%s)\n", path, strerror(errno));
2493 else if (!S_ISREG(statbuf.st_mode))
2494 para_printf(pb, "%s: not a regular file\n", path);
2495 ret = get_afsi_of_row(row, &afsi);
2497 para_printf(pb, "%s: %s\n", path, para_strerror(-ret));
2500 ret = lyr_get_name_by_id(afsi.lyrics_id, &blob_name);
2502 para_printf(pb, "%s lyrics id %u: %s\n", path, afsi.lyrics_id,
2503 para_strerror(-ret));
2504 ret = img_get_name_by_id(afsi.image_id, &blob_name);
2506 para_printf(pb, "%s image id %u: %s\n", path, afsi.image_id,
2507 para_strerror(-ret));
2512 * Check the audio file table for inconsistencies.
2514 * \param aca Only ->pbout is used for diagnostics.
2516 * \return Standard. Inconsistencies are reported but not regarded as an error.
2520 int aft_check_callback(struct afs_callback_arg *aca)
2522 para_printf(&aca->pbout, "checking audio file table...\n");
2523 return audio_file_loop(&aca->pbout, check_audio_file);
2526 struct aft_check_atts_data {
2528 struct para_buffer *pb;
2531 static int check_atts_of_audio_file(struct osl_row *row, void *data)
2533 struct aft_check_atts_data *acad = data;
2535 struct afs_info afsi;
2539 ret = get_afsi_of_row(row, &afsi);
2541 para_printf(acad->pb, "cannot get afsi\n");
2544 bad_bits = afsi.attributes & ~acad->att_mask;
2545 if (bad_bits == 0) /* OK */
2547 ret = get_audio_file_path_of_row(row, &path);
2549 para_printf(acad->pb, "cannot get path\n");
2552 para_printf(acad->pb, "invalid attribute bits (%" PRIu64 "): %s\n",
2554 /* return success to keep looping */
2559 * Iterate over all audio files and check the attribute bit mask.
2561 * \param att_mask The mask of all valid attributes.
2562 * \param pb Used for reporting inconsistencies.
2564 * This reads the attribute bit mask of each audio file from the afs info
2565 * structure stored in the audio file table and verifies that all set bits are
2566 * also turned on in \a att_mask, i.e., correspond to an attribute of the
2567 * attribute table. Audio files for which this is not the case are reported via
2570 * \return Standard. Inconsistencies are not regarded as errors.
2572 * \sa \ref attribute_check_callback().
2574 int aft_check_attributes(uint64_t att_mask, struct para_buffer *pb)
2576 struct aft_check_atts_data acad = {.att_mask = att_mask, .pb = pb};
2578 para_printf(pb, "checking attributes, mask: %" PRIx64 "\n", att_mask);
2579 return audio_file_loop(&acad, check_atts_of_audio_file);
2583 * Close the audio file table.
2585 * \param flags Usual flags that are passed to osl_close_table().
2587 * \sa osl_close_table().
2589 static void aft_close(void)
2591 osl_close_table(audio_file_table, OSL_MARK_CLEAN);
2592 audio_file_table = NULL;
2596 * Open the audio file table.
2598 * \param dir The database directory.
2602 * \sa osl_open_table().
2604 static int aft_open(const char *dir)
2608 audio_file_table_desc.dir = dir;
2609 ret = osl(osl_open_table(&audio_file_table_desc, &audio_file_table));
2612 osl_get_num_rows(audio_file_table, &num);
2613 PARA_INFO_LOG("audio file table contains %d files\n", num);
2616 PARA_NOTICE_LOG("failed to open audio file table\n");
2617 audio_file_table = NULL;
2618 if (ret == -OSL_ERRNO_TO_PARA_ERROR(E_OSL_NOENT))
2623 static int aft_create(const char *dir)
2625 audio_file_table_desc.dir = dir;
2626 return osl(osl_create_table(&audio_file_table_desc));
2629 static int clear_attribute(struct osl_row *row, void *data)
2631 struct rmatt_event_data *red = data;
2632 struct afs_info afsi;
2633 struct osl_object obj;
2634 int ret = get_afsi_object_of_row(row, &obj);
2635 uint64_t mask = ~(1ULL << red->bitnum);
2639 ret = load_afsi(&afsi, &obj);
2642 afsi.attributes &= mask;
2643 save_afsi(&afsi, &obj);
2647 static int aft_event_handler(enum afs_events event, struct para_buffer *pb,
2653 case ATTRIBUTE_REMOVE: {
2654 const struct rmatt_event_data *red = data;
2655 para_printf(pb, "clearing attribute %s (bit %u) from all "
2656 "entries in the audio file table\n", red->name,
2658 return audio_file_loop(data, clear_attribute);
2659 } case AFSI_CHANGE: {
2660 struct afsi_change_event_data *aced = data;
2661 uint64_t old_last_played = status_item_ls_data.afsi.last_played;
2662 if (aced->aft_row != current_aft_row)
2664 ret = get_afsi_of_row(aced->aft_row, &status_item_ls_data.afsi);
2667 status_item_ls_data.afsi.last_played = old_last_played;
2668 make_status_items();
2670 } case AFHI_CHANGE: {
2671 if (data != current_aft_row)
2673 ret = get_afhi_of_row(data, &status_item_ls_data.afhi);
2676 make_status_items();
2684 * Initialize the audio file table.
2686 * \param t Pointer to the structure to be initialized.
2688 void aft_init(struct afs_table *t)
2691 t->close = aft_close;
2692 t->create = aft_create;
2693 t->event_handler = aft_event_handler;