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 if (!localtime_r((time_t *)seconds, &t))
683 if (lm == LS_MODE_MBOX) {
684 if (!strftime(buf, size, "%c", &t))
688 if (*seconds + 6 * 30 * 24 * 3600 > current_time) {
689 if (!strftime(buf, size, "%b %e %k:%M", &t))
693 if (!strftime(buf, size, "%b %e %Y", &t))
698 /** Compute the number of (decimal) digits of a number. */
699 #define GET_NUM_DIGITS(x, num) { \
700 typeof((x)) _tmp = PARA_ABS(x); \
703 while ((_tmp) > 9) { \
709 __a_const static short unsigned get_duration_width(int seconds)
711 short unsigned width;
712 unsigned hours = seconds / 3600, mins = (seconds % 3600) / 60;
714 if (!hours) /* less than one hour => m:ss or mm:ss => 4 or 5 digits */
715 return 4 + (mins > 9);
716 /* more than one hour => h:mm:ss, hh:mm:ss, hhh:mm:ss, ... */
717 GET_NUM_DIGITS(hours, &width);
721 static void get_duration_buf(int seconds, char *buf, struct ls_options *opts)
723 unsigned hours = seconds / 3600, mins = (seconds % 3600) / 60;
724 short unsigned max_width;
726 if (!hours) { /* m:ss or mm:ss */
727 max_width = opts->mode == LS_MODE_LONG?
728 opts->widths.duration_width : 4;
729 sprintf(buf, "%*u:%02u", max_width - 3, mins, seconds % 60);
730 } else { /* more than one hour => h:mm:ss, hh:mm:ss, hhh:mm:ss, ... */
731 max_width = opts->mode == LS_MODE_LONG?
732 opts->widths.duration_width : 7;
733 sprintf(buf, "%*u:%02u:%02u", max_width - 6, hours, mins,
738 static int write_attribute_items(struct para_buffer *b,
739 const char *att_bitmap, struct afs_info *afsi)
744 ret = WRITE_STATUS_ITEM(b, SI_ATTRIBUTES_BITMAP, "%s\n", att_bitmap);
747 ret = get_attribute_text(&afsi->attributes, " ", &att_text);
750 ret = WRITE_STATUS_ITEM(b, SI_ATTRIBUTES_TXT, "%s\n", att_text);
755 static int write_lyrics_items(struct para_buffer *b, struct afs_info *afsi)
760 ret = WRITE_STATUS_ITEM(b, SI_LYRICS_ID, "%u\n", afsi->lyrics_id);
763 lyr_get_name_by_id(afsi->lyrics_id, &lyrics_name);
764 return WRITE_STATUS_ITEM(b, SI_LYRICS_NAME, "%s\n", lyrics_name?
765 lyrics_name : "(none)");
768 static int write_image_items(struct para_buffer *b, struct afs_info *afsi)
773 ret = WRITE_STATUS_ITEM(b, SI_IMAGE_ID, "%u\n", afsi->image_id);
776 img_get_name_by_id(afsi->image_id, &image_name);
777 return WRITE_STATUS_ITEM(b, SI_IMAGE_NAME, "%s\n", image_name?
778 image_name : "(none)");
781 static int write_filename_items(struct para_buffer *b, const char *path,
787 if (!(flags & LS_FLAG_FULL_PATH))
788 return WRITE_STATUS_ITEM(b, SI_BASENAME, "%s\n", path);
789 ret = WRITE_STATUS_ITEM(b, SI_PATH, "%s\n", path);
792 val = para_basename(path);
793 ret = WRITE_STATUS_ITEM(b, SI_BASENAME, "%s\n", val? val : "");
796 val = para_dirname(path);
797 ret = WRITE_STATUS_ITEM(b, SI_DIRECTORY, "%s\n", val? val : "");
802 static int print_chunk_table(struct ls_data *d, struct para_buffer *b)
804 struct osl_object chunk_table_obj;
805 struct osl_row *aft_row;
809 ret = aft_get_row_of_hash(d->hash, &aft_row);
812 ret = osl(osl_open_disk_object(audio_file_table, aft_row,
813 AFTCOL_CHUNKS, &chunk_table_obj));
816 ret = para_printf(b, "%s\n"
817 "chunk_time: %lu:%lu\nchunk_offsets: ",
819 (long unsigned) d->afhi.chunk_tv.tv_sec,
820 (long unsigned) d->afhi.chunk_tv.tv_usec
824 buf = chunk_table_obj.data;
825 for (i = 0; i <= d->afhi.chunks_total; i++) {
826 ret = para_printf(b, "%u ", (unsigned) read_u32(buf + 4 * i));
830 ret = para_printf(b, "\n");
832 osl_close_disk_object(&chunk_table_obj);
836 static int write_score(struct para_buffer *b, struct ls_data *d,
837 struct ls_options *opts)
839 if (!(opts->flags & LS_FLAG_ADMISSIBLE_ONLY)) /* no score*/
841 return WRITE_STATUS_ITEM(b, SI_SCORE, "%li\n", d->score);
844 static int print_list_item(struct ls_data *d, struct ls_options *opts,
845 struct para_buffer *b, time_t current_time)
849 char last_played_time[30];
850 char duration_buf[30]; /* nobody has an audio file long enough to overflow this */
851 struct afs_info *afsi = &d->afsi;
852 struct afh_info *afhi = &d->afhi;
853 char asc_hash[2 * HASH_SIZE + 1];
855 if (opts->mode == LS_MODE_SHORT) {
856 ret = para_printf(b, "%s\n", d->path);
859 if (opts->mode == LS_MODE_CHUNKS) {
860 ret = print_chunk_table(d, b);
863 get_attribute_bitmap(&afsi->attributes, att_buf);
864 if (opts->flags & LS_FLAG_UNIXDATE)
865 sprintf(last_played_time, "%llu",
866 (long long unsigned)afsi->last_played);
868 ret = get_local_time(&afsi->last_played, last_played_time,
869 sizeof(last_played_time), current_time, opts->mode);
873 get_duration_buf(afhi->seconds_total, duration_buf, opts);
874 if (opts->mode == LS_MODE_LONG) {
875 struct ls_widths *w = &opts->widths;
876 if (opts->flags & LS_FLAG_ADMISSIBLE_ONLY) {
877 ret = para_printf(b, "%*li ",
878 opts->widths.score_width, d->score);
883 "%s " /* attributes */
885 "%*d " /* image_id */
886 "%*d " /* lyrics_id */
888 "%*s " /* audio format */
889 "%*d " /* frequency */
892 "%*d " /* num_played */
893 "%s " /* last_played */
896 w->amp_width, afsi->amp,
897 w->image_id_width, afsi->image_id,
898 w->lyrics_id_width, afsi->lyrics_id,
899 w->bitrate_width, afhi->bitrate,
900 w->audio_format_width,
901 audio_format_name(afsi->audio_format_id),
902 w->frequency_width, afhi->frequency,
905 w->num_played_width, afsi->num_played,
911 if (opts->mode == LS_MODE_MBOX) {
912 const char *bn = para_basename(d->path);
914 "From foo@localhost %s\n"
915 "Received: from\nTo: bar\nFrom: a\n"
922 ret = write_filename_items(b, d->path, opts->flags);
925 ret = write_score(b, d, opts);
928 ret = write_attribute_items(b, att_buf, afsi);
931 ret = write_image_items(b, afsi);
934 ret = write_lyrics_items(b, afsi);
937 hash_to_asc(d->hash, asc_hash);
938 ret = WRITE_STATUS_ITEM(b, SI_HASH, "%s\n", asc_hash);
941 ret = WRITE_STATUS_ITEM(b, SI_BITRATE, "%dkbit/s\n", afhi->bitrate);
944 ret = WRITE_STATUS_ITEM(b, SI_FORMAT, "%s\n",
945 audio_format_name(afsi->audio_format_id));
948 ret = WRITE_STATUS_ITEM(b, SI_FREQUENCY, "%dHz\n", afhi->frequency);
951 ret = WRITE_STATUS_ITEM(b, SI_CHANNELS, "%d\n", afhi->channels);
954 ret = WRITE_STATUS_ITEM(b, SI_DURATION, "%s\n", duration_buf);
957 ret = WRITE_STATUS_ITEM(b, SI_SECONDS_TOTAL, "%lu\n",
958 afhi->seconds_total);
961 ret = WRITE_STATUS_ITEM(b, SI_LAST_PLAYED, "%s\n", last_played_time);
964 ret = WRITE_STATUS_ITEM(b, SI_NUM_PLAYED, "%d\n", afsi->num_played);
967 ret = WRITE_STATUS_ITEM(b, SI_AMPLIFICATION, "%u\n", afsi->amp);
970 ret = WRITE_STATUS_ITEM(b, SI_CHUNK_TIME, "%lu\n",
971 tv2ms(&afhi->chunk_tv));
974 ret = WRITE_STATUS_ITEM(b, SI_NUM_CHUNKS, "%lu\n",
978 ret = WRITE_STATUS_ITEM(b, SI_TECHINFO, "%s\n", afhi->techinfo);
981 ret = WRITE_STATUS_ITEM(b, SI_ARTIST, "%s\n", afhi->tags.artist);
984 ret = WRITE_STATUS_ITEM(b, SI_TITLE, "%s\n", afhi->tags.title);
987 ret = WRITE_STATUS_ITEM(b, SI_YEAR, "%s\n", afhi->tags.year);
990 ret = WRITE_STATUS_ITEM(b, SI_ALBUM, "%s\n", afhi->tags.album);
993 ret = WRITE_STATUS_ITEM(b, SI_COMMENT, "%s\n", afhi->tags.comment);
996 if (opts->mode == LS_MODE_MBOX) {
997 struct osl_object lyrics_def;
998 lyr_get_def_by_id(afsi->lyrics_id, &lyrics_def);
999 if (lyrics_def.data) {
1000 ret = para_printf(b, "Lyrics:\n~~~~~~~\n%s",
1001 (char *)lyrics_def.data);
1002 osl_close_disk_object(&lyrics_def);
1009 static struct ls_data status_item_ls_data;
1010 static struct osl_row *current_aft_row;
1012 static void make_inode_status_items(struct para_buffer *pb)
1014 struct stat statbuf = {.st_size = 0};
1015 char *path, mtime_str[30] = "\0";
1019 ret = get_audio_file_path_of_row(current_aft_row, &path);
1022 ret = stat(path, &statbuf);
1025 localtime_r(&statbuf.st_mtime, &mtime_tm);
1026 ret = strftime(mtime_str, 29, "%b %d %Y", &mtime_tm);
1027 assert(ret > 0); /* number of bytes placed in mtime_str */
1029 /* We don't care too much about errors here */
1030 (void)WRITE_STATUS_ITEM(pb, SI_MTIME, "%s\n", mtime_str);
1031 (void)WRITE_STATUS_ITEM(pb, SI_FILE_SIZE, "%ld\n", statbuf.st_size / 1024);
1034 static int make_status_items(void)
1036 struct ls_options opts = {
1037 .flags = LS_FLAG_FULL_PATH | LS_FLAG_ADMISSIBLE_ONLY,
1038 .mode = LS_MODE_VERBOSE,
1040 struct para_buffer pb = {.max_size = shm_get_shmmax() - 1};
1041 time_t current_time;
1044 time(¤t_time);
1045 ret = print_list_item(&status_item_ls_data, &opts, &pb, current_time);
1048 make_inode_status_items(&pb);
1050 status_items = pb.buf;
1051 memset(&pb, 0, sizeof(pb));
1052 pb.max_size = shm_get_shmmax() - 1;
1053 pb.flags = PBF_SIZE_PREFIX;
1054 ret = print_list_item(&status_item_ls_data, &opts, &pb, current_time);
1057 status_items = NULL;
1060 make_inode_status_items(&pb);
1061 free(parser_friendly_status_items);
1062 parser_friendly_status_items = pb.buf;
1067 * Open the audio file with highest score and set up an afd structure.
1069 * \param afd Result pointer.
1071 * On success, the numplayed field of the audio file selector info is increased
1072 * and the lastplayed time is set to the current time. Finally, the score of
1073 * the audio file is updated.
1075 * \return Positive shmid on success, negative on errors.
1077 int open_and_update_audio_file(struct audio_file_data *afd)
1079 unsigned char file_hash[HASH_SIZE];
1080 struct osl_object afsi_obj;
1081 struct afs_info new_afsi;
1083 struct afsi_change_event_data aced;
1084 struct osl_object map, chunk_table_obj;
1085 struct ls_data *d = &status_item_ls_data;
1087 ret = score_get_best(¤t_aft_row, &d->score);
1090 ret = get_hash_of_row(current_aft_row, &d->hash);
1093 ret = get_audio_file_path_of_row(current_aft_row, &d->path);
1096 PARA_NOTICE_LOG("%s\n", d->path);
1097 ret = get_afsi_object_of_row(current_aft_row, &afsi_obj);
1100 ret = load_afsi(&d->afsi, &afsi_obj);
1103 ret = get_afhi_of_row(current_aft_row, &afd->afhi);
1106 d->afhi = afd->afhi;
1107 d->afhi.chunk_table = afd->afhi.chunk_table = NULL;
1108 ret = osl(osl_open_disk_object(audio_file_table, current_aft_row,
1109 AFTCOL_CHUNKS, &chunk_table_obj));
1112 ret = mmap_full_file(d->path, O_RDONLY, &map.data, &map.size, &afd->fd);
1115 hash_function(map.data, map.size, file_hash);
1116 ret = hash_compare(file_hash, d->hash);
1117 para_munmap(map.data, map.size);
1119 ret = -E_HASH_MISMATCH;
1123 new_afsi.num_played++;
1124 new_afsi.last_played = time(NULL);
1125 save_afsi(&new_afsi, &afsi_obj); /* in-place update */
1127 afd->audio_format_id = d->afsi.audio_format_id;
1128 load_chunk_table(&afd->afhi, chunk_table_obj.data);
1129 aced.aft_row = current_aft_row;
1130 aced.old_afsi = &d->afsi;
1132 * No need to update the status items as the AFSI_CHANGE event will
1135 afs_event(AFSI_CHANGE, NULL, &aced);
1136 ret = save_afd(afd);
1138 free(afd->afhi.chunk_table);
1139 osl_close_disk_object(&chunk_table_obj);
1141 PARA_ERROR_LOG("%s: %s\n", d->path, para_strerror(-ret));
1142 ret = score_delete(current_aft_row);
1149 static int ls_audio_format_compare(const void *a, const void *b)
1151 struct ls_data *d1 = *(struct ls_data **)a, *d2 = *(struct ls_data **)b;
1152 return NUM_COMPARE(d1->afsi.audio_format_id, d2->afsi.audio_format_id);
1155 static int ls_duration_compare(const void *a, const void *b)
1157 struct ls_data *d1 = *(struct ls_data **)a, *d2 = *(struct ls_data **)b;
1158 return NUM_COMPARE(d1->afhi.seconds_total, d2->afhi.seconds_total);
1161 static int ls_bitrate_compare(const void *a, const void *b)
1163 struct ls_data *d1 = *(struct ls_data **)a, *d2 = *(struct ls_data **)b;
1164 return NUM_COMPARE(d1->afhi.bitrate, d2->afhi.bitrate);
1167 static int ls_lyrics_id_compare(const void *a, const void *b)
1169 struct ls_data *d1 = *(struct ls_data **)a, *d2 = *(struct ls_data **)b;
1170 return NUM_COMPARE(d1->afsi.lyrics_id, d2->afsi.lyrics_id);
1173 static int ls_image_id_compare(const void *a, const void *b)
1175 struct ls_data *d1 = *(struct ls_data **)a, *d2 = *(struct ls_data **)b;
1176 return NUM_COMPARE(d1->afsi.image_id, d2->afsi.image_id);
1179 static int ls_channels_compare(const void *a, const void *b)
1181 struct ls_data *d1 = *(struct ls_data **)a, *d2 = *(struct ls_data **)b;
1182 return NUM_COMPARE(d1->afhi.channels, d2->afhi.channels);
1185 static int ls_frequency_compare(const void *a, const void *b)
1187 struct ls_data *d1 = *(struct ls_data **)a, *d2 = *(struct ls_data **)b;
1188 return NUM_COMPARE(d1->afhi.frequency, d2->afhi.frequency);
1191 static int ls_num_played_compare(const void *a, const void *b)
1193 struct ls_data *d1 = *(struct ls_data **)a, *d2 = *(struct ls_data **)b;
1194 return NUM_COMPARE(d1->afsi.num_played, d2->afsi.num_played);
1197 static int ls_last_played_compare(const void *a, const void *b)
1199 struct ls_data *d1 = *(struct ls_data **)a, *d2 = *(struct ls_data **)b;
1200 return NUM_COMPARE(d1->afsi.last_played, d2->afsi.last_played);
1203 static int ls_score_compare(const void *a, const void *b)
1205 struct ls_data *d1 = *(struct ls_data **)a, *d2 = *(struct ls_data **)b;
1206 return NUM_COMPARE(d1->score, d2->score);
1209 static int ls_path_compare(const void *a, const void *b)
1211 struct ls_data *d1 = *(struct ls_data **)a, *d2 = *(struct ls_data **)b;
1212 return strcmp(d1->path, d2->path);
1215 static int sort_matching_paths(struct ls_options *options)
1217 size_t nmemb = options->num_matching_paths;
1218 size_t size = sizeof(*options->data_ptr);
1219 int (*compar)(const void *, const void *);
1222 options->data_ptr = para_malloc(nmemb * sizeof(*options->data_ptr));
1223 for (i = 0; i < nmemb; i++)
1224 options->data_ptr[i] = options->data + i;
1226 /* In these cases the array is already sorted */
1227 if (options->sorting == LS_SORT_BY_PATH
1228 && !(options->flags & LS_FLAG_ADMISSIBLE_ONLY)
1229 && (options->flags & LS_FLAG_FULL_PATH))
1231 if (options->sorting == LS_SORT_BY_SCORE &&
1232 options->flags & LS_FLAG_ADMISSIBLE_ONLY)
1235 switch (options->sorting) {
1236 case LS_SORT_BY_PATH:
1237 compar = ls_path_compare; break;
1238 case LS_SORT_BY_SCORE:
1239 compar = ls_score_compare; break;
1240 case LS_SORT_BY_LAST_PLAYED:
1241 compar = ls_last_played_compare; break;
1242 case LS_SORT_BY_NUM_PLAYED:
1243 compar = ls_num_played_compare; break;
1244 case LS_SORT_BY_FREQUENCY:
1245 compar = ls_frequency_compare; break;
1246 case LS_SORT_BY_CHANNELS:
1247 compar = ls_channels_compare; break;
1248 case LS_SORT_BY_IMAGE_ID:
1249 compar = ls_image_id_compare; break;
1250 case LS_SORT_BY_LYRICS_ID:
1251 compar = ls_lyrics_id_compare; break;
1252 case LS_SORT_BY_BITRATE:
1253 compar = ls_bitrate_compare; break;
1254 case LS_SORT_BY_DURATION:
1255 compar = ls_duration_compare; break;
1256 case LS_SORT_BY_AUDIO_FORMAT:
1257 compar = ls_audio_format_compare; break;
1261 qsort(options->data_ptr, nmemb, size, compar);
1265 /* row is either an aft_row or a row of the score table */
1266 /* TODO: Only compute widths if we need them */
1267 static int prepare_ls_row(struct osl_row *row, void *ls_opts)
1270 struct ls_options *options = ls_opts;
1272 struct ls_widths *w;
1273 unsigned short num_digits;
1275 struct osl_row *aft_row;
1279 if (options->flags & LS_FLAG_ADMISSIBLE_ONLY) {
1280 ret = get_score_and_aft_row(row, &score, &aft_row);
1287 ret = get_audio_file_path_of_row(aft_row, &path);
1290 if (!(options->flags & LS_FLAG_FULL_PATH)) {
1291 char *p = strrchr(path, '/');
1295 if (options->num_patterns) {
1296 for (i = 0; i < options->num_patterns; i++) {
1297 ret = fnmatch(options->patterns[i], path, 0);
1300 if (ret == FNM_NOMATCH)
1304 if (i >= options->num_patterns) /* no match */
1307 tmp = options->num_matching_paths++;
1308 if (options->num_matching_paths > options->array_size) {
1309 options->array_size++;
1310 options->array_size *= 2;
1311 options->data = para_realloc(options->data, options->array_size
1312 * sizeof(*options->data));
1314 d = options->data + tmp;
1315 ret = get_afsi_of_row(aft_row, &d->afsi);
1318 ret = get_afhi_of_row(aft_row, &d->afhi);
1322 ret = get_hash_of_row(aft_row, &d->hash);
1325 w = &options->widths;
1326 GET_NUM_DIGITS(d->afsi.image_id, &num_digits);
1327 w->image_id_width = PARA_MAX(w->image_id_width, num_digits);
1328 GET_NUM_DIGITS(d->afsi.lyrics_id, &num_digits);
1329 w->lyrics_id_width = PARA_MAX(w->lyrics_id_width, num_digits);
1330 GET_NUM_DIGITS(d->afhi.bitrate, &num_digits);
1331 w->bitrate_width = PARA_MAX(w->bitrate_width, num_digits);
1332 GET_NUM_DIGITS(d->afhi.frequency, &num_digits);
1333 w->frequency_width = PARA_MAX(w->frequency_width, num_digits);
1334 GET_NUM_DIGITS(d->afsi.num_played, &num_digits);
1335 w->num_played_width = PARA_MAX(w->num_played_width, num_digits);
1336 /* get the number of chars to print this amount of time */
1337 num_digits = get_duration_width(d->afhi.seconds_total);
1338 w->duration_width = PARA_MAX(w->duration_width, num_digits);
1339 GET_NUM_DIGITS(d->afsi.amp, &num_digits);
1340 w->amp_width = PARA_MAX(w->amp_width, num_digits);
1341 num_digits = strlen(audio_format_name(d->afsi.audio_format_id));
1342 w->audio_format_width = PARA_MAX(w->audio_format_width, num_digits);
1343 if (options->flags & LS_FLAG_ADMISSIBLE_ONLY) {
1344 GET_NUM_DIGITS(score, &num_digits);
1345 num_digits++; /* add one for the sign (space or "-") */
1346 w->score_width = PARA_MAX(w->score_width, num_digits);
1354 static void com_ls_callback(int fd, const struct osl_object *query)
1356 struct ls_options *opts = query->data;
1357 char *p, *pattern_start = (char *)query->data + sizeof(*opts);
1358 struct para_buffer b = {
1359 .max_size = shm_get_shmmax(),
1360 .flags = (opts->mode == LS_MODE_PARSER)? PBF_SIZE_PREFIX : 0,
1361 .max_size_handler = afs_max_size_handler,
1362 .private_data = &(struct afs_max_size_handler_data) {
1368 time_t current_time;
1370 if (opts->num_patterns) {
1371 opts->patterns = para_malloc(opts->num_patterns * sizeof(char *));
1372 for (i = 0, p = pattern_start; i < opts->num_patterns; i++) {
1373 opts->patterns[i] = p;
1377 opts->patterns = NULL;
1378 if (opts->flags & LS_FLAG_ADMISSIBLE_ONLY)
1379 ret = admissible_file_loop(opts, prepare_ls_row);
1381 ret = osl(osl_rbtree_loop(audio_file_table, AFTCOL_PATH, opts,
1385 if (opts->num_matching_paths == 0) {
1386 if (opts->num_patterns > 0)
1387 para_printf(&b, "no matches\n");
1390 ret = sort_matching_paths(opts);
1393 time(¤t_time);
1394 if (opts->flags & LS_FLAG_REVERSE)
1395 for (i = opts->num_matching_paths - 1; i >= 0; i--) {
1396 ret = print_list_item(opts->data_ptr[i], opts, &b, current_time);
1401 for (i = 0; i < opts->num_matching_paths; i++) {
1402 ret = print_list_item(opts->data_ptr[i], opts, &b, current_time);
1408 pass_buffer_as_shm(fd, SBD_OUTPUT, b.buf, b.offset);
1411 free(opts->data_ptr);
1412 free(opts->patterns);
1416 * TODO: flags -h (sort by hash)
1418 int com_ls(struct command_context *cc)
1422 enum ls_sorting_method sort = LS_SORT_BY_PATH;
1423 enum ls_listing_mode mode = LS_MODE_SHORT;
1424 struct ls_options opts = {.patterns = NULL};
1425 struct osl_object query = {.data = &opts, .size = sizeof(opts)};
1427 for (i = 1; i < cc->argc; i++) {
1428 const char *arg = cc->argv[i];
1431 if (!strcmp(arg, "--")) {
1436 * Compatibility: Prior to 0.5.5 it was necessary to specify
1437 * the listing mode without the '=' character as in -lv, for
1438 * example. Now the variant with '=' is preferred and
1439 * documented but we still accept the old way to specify the
1442 * Support for the legacy syntax can be dropped at 0.6.0
1445 if (!strncmp(arg, "-l", 2)) {
1451 mode = LS_MODE_SHORT;
1455 mode = LS_MODE_LONG;
1458 mode = LS_MODE_VERBOSE;
1461 mode = LS_MODE_MBOX;
1464 mode = LS_MODE_CHUNKS;
1467 mode = LS_MODE_PARSER;
1470 return -E_AFT_SYNTAX;
1473 if (!strcmp(arg, "-p")) {
1474 flags |= LS_FLAG_FULL_PATH;
1477 if (!strcmp(arg, "-a")) {
1478 flags |= LS_FLAG_ADMISSIBLE_ONLY;
1481 if (!strcmp(arg, "-r")) {
1482 flags |= LS_FLAG_REVERSE;
1485 if (!strcmp(arg, "-d")) {
1486 flags |= LS_FLAG_UNIXDATE;
1489 /* The compatibility remark above applies also to -s. */
1490 if (!strncmp(arg, "-s", 2)) {
1496 sort = LS_SORT_BY_PATH;
1498 case 's': /* -ss implies -a */
1499 sort = LS_SORT_BY_SCORE;
1500 flags |= LS_FLAG_ADMISSIBLE_ONLY;
1503 sort = LS_SORT_BY_LAST_PLAYED;
1506 sort = LS_SORT_BY_NUM_PLAYED;
1509 sort = LS_SORT_BY_FREQUENCY;
1512 sort = LS_SORT_BY_CHANNELS;
1515 sort = LS_SORT_BY_IMAGE_ID;
1518 sort = LS_SORT_BY_LYRICS_ID;
1521 sort = LS_SORT_BY_BITRATE;
1524 sort = LS_SORT_BY_DURATION;
1527 sort = LS_SORT_BY_AUDIO_FORMAT;
1530 return -E_AFT_SYNTAX;
1533 return -E_AFT_SYNTAX;
1536 opts.sorting = sort;
1538 opts.num_patterns = cc->argc - i;
1539 ret = send_option_arg_callback_request(&query, opts.num_patterns,
1540 cc->argv + i, com_ls_callback, afs_cb_result_handler, cc);
1545 * Call the given function for each file in the audio file table.
1547 * \param private_data An arbitrary data pointer, passed to \a func.
1548 * \param func The custom function to be called.
1552 int audio_file_loop(void *private_data, osl_rbtree_loop_func *func)
1554 return osl(osl_rbtree_loop(audio_file_table, AFTCOL_HASH, private_data,
1558 static struct osl_row *find_hash_sister(unsigned char *hash)
1560 const struct osl_object obj = {.data = hash, .size = HASH_SIZE};
1561 struct osl_row *row;
1563 osl_get_row(audio_file_table, AFTCOL_HASH, &obj, &row);
1567 /** The format of the data stored by save_audio_file_data(). */
1568 enum com_add_buffer_offsets {
1569 /* afhi (if present) starts at this offset. */
1570 CAB_AFHI_OFFSET_POS = 0,
1571 /** Start of the chunk table (if present). */
1572 CAB_CHUNKS_OFFSET_POS = 4,
1573 /** Flags given to the add command. */
1574 CAB_FLAGS_OFFSET = 8,
1575 /** Audio format id. */
1576 CAB_AUDIO_FORMAT_ID_OFFSET = 12,
1577 /** The hash of the audio file being added. */
1578 CAB_HASH_OFFSET = 13,
1579 /** Start of the path of the audio file. */
1580 CAB_PATH_OFFSET = (CAB_HASH_OFFSET + HASH_SIZE),
1584 * Store the given data to a single buffer. Doesn't need the audio file selector
1585 * info struct as the server knows it as well.
1587 * It's OK to call this with afhi == NULL. In this case, the audio format
1588 * handler info won't be stored in the buffer.
1590 static void save_add_callback_buffer(unsigned char *hash, const char *path,
1591 struct afh_info *afhi, uint32_t flags,
1592 uint8_t audio_format_num, struct osl_object *obj)
1594 size_t path_len = strlen(path) + 1;
1595 size_t afhi_size = sizeof_afhi_buf(afhi);
1596 size_t size = CAB_PATH_OFFSET + path_len + afhi_size
1597 + sizeof_chunk_table(afhi);
1598 char *buf = para_malloc(size);
1601 pos = CAB_PATH_OFFSET + path_len;
1602 write_u32(buf + CAB_AFHI_OFFSET_POS, pos);
1603 save_afhi(afhi, buf + pos);
1606 write_u32(buf + CAB_CHUNKS_OFFSET_POS, pos);
1608 save_chunk_table(afhi, buf + pos);
1610 write_u32(buf + CAB_FLAGS_OFFSET, flags);
1611 write_u8(buf + CAB_AUDIO_FORMAT_ID_OFFSET, audio_format_num);
1613 memcpy(buf + CAB_HASH_OFFSET, hash, HASH_SIZE);
1614 strcpy(buf + CAB_PATH_OFFSET, path);
1622 Overview of the add command.
1624 Input: What was passed to the callback by the command handler.
1626 HS: Hash sister. Whether an audio file with identical hash
1627 already exists in the osl database.
1629 PB: Path brother. Whether a file with the given path exists
1632 F: Force flag given. Whether add was called with -f.
1634 output: Action performed by the callback.
1636 AFHI: Whether afhi and chunk table are computed and sent.
1637 ACTION: Table modifications to be done by the callback.
1639 +----+----+---+------+---------------------------------------------------+
1640 | HS | PB | F | AFHI | ACTION
1641 +----+----+---+------+---------------------------------------------------+
1642 | Y | Y | Y | Y | if HS != PB: remove PB. HS: force afhi update,
1643 | | update path, keep afsi
1644 +----+----+---+------+---------------------------------------------------+
1645 | Y | Y | N | N | if HS == PB: do not send callback request at all.
1646 | | otherwise: remove PB, HS: update path, keep afhi,
1648 +----+----+---+------+---------------------------------------------------+
1649 | Y | N | Y | Y | (rename) force afhi update of HS, update path of
1651 +----+----+---+------+---------------------------------------------------+
1652 | Y | N | N | N | (file rename) update path of HS, keep afsi, afhi
1653 +----+----+---+------+---------------------------------------------------+
1654 | N | Y | Y | Y | (file change) update afhi, hash, of PB, keep afsi
1655 | | (force has no effect)
1656 +----+----+---+------+---------------------------------------------------+
1657 | N | Y | N | Y | (file change) update afhi, hash of PB, keep afsi
1658 +----+----+---+------+---------------------------------------------------+
1659 | N | N | Y | Y | (new file) create new entry (force has no effect)
1660 +----+----+---+------+---------------------------------------------------+
1661 | N | N | N | Y | (new file) create new entry
1662 +----+----+---+------+---------------------------------------------------+
1666 afhi <=> force or no HS
1671 /** Flags passed to the add command. */
1672 enum com_add_flags {
1673 /** Skip paths that exist already. */
1675 /** Force adding. */
1677 /** Print what is being done. */
1678 ADD_FLAG_VERBOSE = 4,
1679 /** Try to add files with unknown suffixes. */
1683 static void com_add_callback(int fd, const struct osl_object *query)
1685 char *buf = query->data, *path;
1686 struct osl_row *pb, *aft_row;
1688 struct osl_object objs[NUM_AFT_COLUMNS];
1689 unsigned char *hash;
1690 char asc[2 * HASH_SIZE + 1];
1692 char afsi_buf[AFSI_SIZE];
1693 uint32_t flags = read_u32(buf + CAB_FLAGS_OFFSET);
1694 struct afs_info default_afsi = {.last_played = 0};
1695 struct para_buffer msg = {
1696 .max_size = shm_get_shmmax(),
1697 .max_size_handler = afs_max_size_handler,
1698 .private_data = &(struct afs_max_size_handler_data) {
1703 uint16_t afhi_offset, chunks_offset;
1705 hash = (unsigned char *)buf + CAB_HASH_OFFSET;
1706 hash_to_asc(hash, asc);
1707 objs[AFTCOL_HASH].data = buf + CAB_HASH_OFFSET;
1708 objs[AFTCOL_HASH].size = HASH_SIZE;
1710 path = buf + CAB_PATH_OFFSET;
1711 objs[AFTCOL_PATH].data = path;
1712 objs[AFTCOL_PATH].size = strlen(path) + 1;
1714 PARA_INFO_LOG("request to add %s\n", path);
1715 hs = find_hash_sister(hash);
1716 ret = aft_get_row_of_path(path, &pb);
1717 if (ret < 0 && ret != -OSL_ERRNO_TO_PARA_ERROR(E_OSL_RB_KEY_NOT_FOUND))
1719 if (hs && pb && hs == pb && !(flags & ADD_FLAG_FORCE)) {
1720 if (flags & ADD_FLAG_VERBOSE)
1721 ret = para_printf(&msg, "ignoring duplicate\n");
1726 if (hs && hs != pb) {
1727 struct osl_object obj;
1728 if (pb) { /* hs trumps pb, remove pb */
1729 if (flags & ADD_FLAG_VERBOSE) {
1730 ret = para_printf(&msg, "removing %s\n", path);
1734 afs_event(AUDIO_FILE_REMOVE, &msg, pb);
1735 ret = osl(osl_del_row(audio_file_table, pb));
1740 /* file rename, update hs' path */
1741 if (flags & ADD_FLAG_VERBOSE) {
1742 ret = osl(osl_get_object(audio_file_table, hs,
1743 AFTCOL_PATH, &obj));
1746 ret = para_printf(&msg, "renamed from %s\n", (char *)obj.data);
1750 ret = osl(osl_update_object(audio_file_table, hs, AFTCOL_PATH,
1751 &objs[AFTCOL_PATH]));
1754 afs_event(AUDIO_FILE_RENAME, &msg, hs);
1755 if (!(flags & ADD_FLAG_FORCE))
1758 /* no hs or force mode, child must have sent afhi */
1759 afhi_offset = read_u32(buf + CAB_AFHI_OFFSET_POS);
1760 chunks_offset = read_u32(buf + CAB_CHUNKS_OFFSET_POS);
1762 objs[AFTCOL_AFHI].data = buf + afhi_offset;
1763 objs[AFTCOL_AFHI].size = chunks_offset - afhi_offset;
1765 if (!objs[AFTCOL_AFHI].size) /* "impossible" */
1767 objs[AFTCOL_CHUNKS].data = buf + chunks_offset;
1768 objs[AFTCOL_CHUNKS].size = query->size - chunks_offset;
1769 if (pb && !hs) { /* update pb's hash */
1770 char old_asc[2 * HASH_SIZE + 1];
1771 unsigned char *old_hash;
1772 ret = get_hash_of_row(pb, &old_hash);
1775 hash_to_asc(old_hash, old_asc);
1776 if (flags & ADD_FLAG_VERBOSE) {
1777 ret = para_printf(&msg, "file change: %s -> %s\n",
1782 ret = osl_update_object(audio_file_table, pb, AFTCOL_HASH,
1783 &objs[AFTCOL_HASH]);
1787 if (hs || pb) { /* (hs != NULL and pb != NULL) implies hs == pb */
1788 struct osl_row *row = pb? pb : hs;
1789 /* update afhi and chunk_table */
1790 if (flags & ADD_FLAG_VERBOSE) {
1791 ret = para_printf(&msg, "updating afhi and chunk table\n");
1795 ret = osl(osl_update_object(audio_file_table, row, AFTCOL_AFHI,
1796 &objs[AFTCOL_AFHI]));
1799 ret = osl(osl_update_object(audio_file_table, row, AFTCOL_CHUNKS,
1800 &objs[AFTCOL_CHUNKS]));
1803 afs_event(AFHI_CHANGE, &msg, row);
1806 /* new entry, use default afsi */
1807 if (flags & ADD_FLAG_VERBOSE) {
1808 ret = para_printf(&msg, "new file\n");
1812 default_afsi.last_played = time(NULL) - 365 * 24 * 60 * 60;
1813 default_afsi.audio_format_id = read_u8(buf + CAB_AUDIO_FORMAT_ID_OFFSET);
1815 objs[AFTCOL_AFSI].data = &afsi_buf;
1816 objs[AFTCOL_AFSI].size = AFSI_SIZE;
1817 save_afsi(&default_afsi, &objs[AFTCOL_AFSI]);
1818 ret = osl(osl_add_and_get_row(audio_file_table, objs, &aft_row));
1819 afs_event(AUDIO_FILE_ADD, &msg, aft_row);
1822 para_printf(&msg, "%s\n", para_strerror(-ret));
1824 pass_buffer_as_shm(fd, SBD_OUTPUT, msg.buf, msg.offset);
1828 /** Used by com_add(). */
1829 struct private_add_data {
1830 /** The pointer passed to the original command handler. */
1831 struct command_context *cc;
1832 /** The given add flags. */
1836 static void path_brother_callback(int fd, const struct osl_object *query)
1838 char *path = query->data;
1839 struct osl_row *path_brother;
1840 int ret = aft_get_row_of_path(path, &path_brother);
1843 pass_buffer_as_shm(fd, SBD_OUTPUT, (char *)&path_brother,
1844 sizeof(path_brother));
1847 static void hash_sister_callback(int fd, const struct osl_object *query)
1849 unsigned char *hash = query->data;
1850 struct osl_row *hash_sister;
1852 hash_sister = find_hash_sister(hash);
1855 pass_buffer_as_shm(fd, SBD_OUTPUT, (char *)&hash_sister,
1856 sizeof(hash_sister));
1859 static int get_row_pointer_from_result(struct osl_object *result,
1860 __a_unused uint8_t band, void *private)
1862 struct osl_row **row = private;
1863 *row = *(struct osl_row **)(result->data);
1867 static int add_one_audio_file(const char *path, void *private_data)
1869 int ret, send_ret = 1, fd;
1870 uint8_t format_num = -1;
1871 struct private_add_data *pad = private_data;
1872 struct afh_info afhi, *afhi_ptr = NULL;
1873 struct osl_row *pb = NULL, *hs = NULL; /* path brother/hash sister */
1874 struct osl_object map, obj = {.data = NULL}, query;
1875 unsigned char hash[HASH_SIZE];
1877 ret = guess_audio_format(path);
1878 if (ret < 0 && !(pad->flags & ADD_FLAG_ALL)) {
1882 query.data = (char *)path;
1883 query.size = strlen(path) + 1;
1884 ret = send_callback_request(path_brother_callback, &query,
1885 get_row_pointer_from_result, &pb);
1886 if (ret < 0 && ret != -OSL_ERRNO_TO_PARA_ERROR(E_OSL_RB_KEY_NOT_FOUND))
1889 if (pb && (pad->flags & ADD_FLAG_LAZY)) { /* lazy is really cheap */
1890 if (pad->flags & ADD_FLAG_VERBOSE)
1891 send_ret = send_sb_va(&pad->cc->scc, SBD_OUTPUT,
1892 "lazy-ignore: %s\n", path);
1895 /* We still want to add this file. Compute its hash. */
1896 ret = mmap_full_file(path, O_RDONLY, &map.data, &map.size, &fd);
1899 hash_function(map.data, map.size, hash);
1901 /* Check whether the database contains a file with the same hash. */
1903 query.size = HASH_SIZE;
1904 ret = send_callback_request(hash_sister_callback, &query,
1905 get_row_pointer_from_result, &hs);
1908 /* Return success if we already know this file. */
1910 if (pb && hs && hs == pb && !(pad->flags & ADD_FLAG_FORCE)) {
1911 if (pad->flags & ADD_FLAG_VERBOSE)
1912 send_ret = send_sb_va(&pad->cc->scc, SBD_OUTPUT,
1913 "%s exists, not forcing update\n", path);
1917 * We won't recalculate the audio format info and the chunk table if
1918 * there is a hash sister and FORCE was not given.
1920 if (!hs || (pad->flags & ADD_FLAG_FORCE)) {
1921 ret = compute_afhi(path, map.data, map.size, fd, &afhi);
1927 munmap(map.data, map.size);
1929 if (pad->flags & ADD_FLAG_VERBOSE) {
1930 send_ret = send_sb_va(&pad->cc->scc, SBD_OUTPUT,
1931 "adding %s\n", path);
1935 save_add_callback_buffer(hash, path, afhi_ptr, pad->flags, format_num, &obj);
1936 /* Ask afs to consider this entry for adding. */
1937 ret = send_callback_request(com_add_callback, &obj,
1938 afs_cb_result_handler, pad->cc);
1943 munmap(map.data, map.size);
1945 if (ret < 0 && send_ret >= 0)
1946 send_ret = send_sb_va(&pad->cc->scc, SBD_ERROR_LOG,
1947 "failed to add %s (%s)\n", path, para_strerror(-ret));
1949 clear_afhi(afhi_ptr);
1950 /* Stop adding files only on send errors. */
1954 int com_add(struct command_context *cc)
1957 struct private_add_data pad = {.cc = cc, .flags = 0};
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 if (ret == 1) /* directory */
1997 ret = for_each_file_in_dir(path, add_one_audio_file,
1999 else /* regular file */
2000 ret = add_one_audio_file(path, &pad);
2002 send_sb_va(&cc->scc, SBD_OUTPUT, "%s: %s\n", path,
2003 para_strerror(-ret));
2013 * Flags used by the touch command.
2018 /** Whether the \p FNM_PATHNAME flag should be passed to fnmatch(). */
2019 TOUCH_FLAG_FNM_PATHNAME = 1,
2020 /** Activates verbose mode. */
2021 TOUCH_FLAG_VERBOSE = 2
2024 /** Options used by com_touch(). */
2025 struct com_touch_options {
2026 /** New num_played value. */
2028 /** New last played count. */
2029 int64_t last_played;
2030 /** New lyrics id. */
2032 /** New image id. */
2034 /** New amplification value. */
2036 /** Command line flags (see \ref touch_flags). */
2040 /** Data passed to the action handler of com_touch(). */
2041 struct touch_action_data {
2042 /** Command line options (see \ref com_touch_options). */
2043 struct com_touch_options *cto;
2044 /** Message buffer. */
2045 struct para_buffer pb;
2048 static int touch_audio_file(__a_unused struct osl_table *table,
2049 struct osl_row *row, const char *name, void *data)
2051 struct touch_action_data *tad = data;
2052 struct osl_object obj;
2053 struct afs_info old_afsi, new_afsi;
2054 int ret, no_options = tad->cto->num_played < 0 && tad->cto->last_played < 0 &&
2055 tad->cto->lyrics_id < 0 && tad->cto->image_id < 0 && tad->cto->amp < 0;
2056 struct afsi_change_event_data aced;
2058 ret = get_afsi_object_of_row(row, &obj);
2060 return para_printf(&tad->pb, "%s: %s\n", name, para_strerror(-ret));
2061 ret = load_afsi(&old_afsi, &obj);
2063 return para_printf(&tad->pb, "%s: %s\n", name, para_strerror(-ret));
2064 new_afsi = old_afsi;
2066 new_afsi.num_played++;
2067 new_afsi.last_played = time(NULL);
2068 if (tad->cto->flags & TOUCH_FLAG_VERBOSE) {
2069 ret = para_printf(&tad->pb, "%s: num_played = %u, "
2070 "last_played = now()\n", name,
2071 new_afsi.num_played);
2076 if (tad->cto->flags & TOUCH_FLAG_VERBOSE) {
2077 ret = para_printf(&tad->pb, "touching %s\n", name);
2081 if (tad->cto->lyrics_id >= 0)
2082 new_afsi.lyrics_id = tad->cto->lyrics_id;
2083 if (tad->cto->image_id >= 0)
2084 new_afsi.image_id = tad->cto->image_id;
2085 if (tad->cto->num_played >= 0)
2086 new_afsi.num_played = tad->cto->num_played;
2087 if (tad->cto->last_played >= 0)
2088 new_afsi.last_played = tad->cto->last_played;
2089 if (tad->cto->amp >= 0)
2090 new_afsi.amp = tad->cto->amp;
2092 save_afsi(&new_afsi, &obj); /* in-place update */
2094 aced.old_afsi = &old_afsi;
2095 afs_event(AFSI_CHANGE, &tad->pb, &aced);
2099 static void com_touch_callback(int fd, const struct osl_object *query)
2101 struct touch_action_data tad = {.cto = query->data,
2103 .max_size = shm_get_shmmax(),
2104 .private_data = &(struct afs_max_size_handler_data) {
2108 .max_size_handler = afs_max_size_handler
2112 struct pattern_match_data pmd = {
2113 .table = audio_file_table,
2114 .loop_col_num = AFTCOL_HASH,
2115 .match_col_num = AFTCOL_PATH,
2116 .patterns = {.data = (char *)query->data + sizeof(*tad.cto),
2117 .size = query->size - sizeof(*tad.cto)},
2119 .action = touch_audio_file
2121 if (tad.cto->flags & TOUCH_FLAG_FNM_PATHNAME)
2122 pmd.fnmatch_flags |= FNM_PATHNAME;
2123 ret = for_each_matching_row(&pmd);
2125 ret2 = para_printf(&tad.pb, "%s\n", para_strerror(-ret));
2126 else if (pmd.num_matches == 0)
2127 ret2 = para_printf(&tad.pb, "no matches\n");
2128 if (ret2 >= 0 && tad.pb.offset)
2129 pass_buffer_as_shm(fd, SBD_OUTPUT, tad.pb.buf, tad.pb.offset);
2133 int com_touch(struct command_context *cc)
2135 struct com_touch_options cto = {
2142 struct osl_object query = {.data = &cto, .size = sizeof(cto)};
2146 for (i = 1; i < cc->argc; i++) {
2147 const char *arg = cc->argv[i];
2150 if (!strcmp(arg, "--")) {
2154 if (!strncmp(arg, "-n=", 3)) {
2155 ret = para_atoi32(arg + 3, &cto.num_played);
2160 if (!strncmp(arg, "-l=", 3)) {
2161 ret = para_atoi64(arg + 3, &cto.last_played);
2166 if (!strncmp(arg, "-y=", 3)) {
2167 ret = para_atoi32(arg + 3, &cto.lyrics_id);
2172 if (!strncmp(arg, "-i=", 3)) {
2173 ret = para_atoi32(arg + 3, &cto.image_id);
2178 if (!strncmp(arg, "-a=", 3)) {
2180 ret = para_atoi32(arg + 3, &val);
2183 if (val < 0 || val > 255)
2184 return -ERRNO_TO_PARA_ERROR(EINVAL);
2188 if (!strcmp(arg, "-p")) {
2189 cto.flags |= TOUCH_FLAG_FNM_PATHNAME;
2192 if (!strcmp(arg, "-v")) {
2193 cto.flags |= TOUCH_FLAG_VERBOSE;
2196 break; /* non-option starting with dash */
2199 return -E_AFT_SYNTAX;
2200 ret = send_option_arg_callback_request(&query, cc->argc - i,
2201 cc->argv + i, com_touch_callback, afs_cb_result_handler, cc);
2203 send_strerror(cc, -ret);
2207 /** Flags for com_rm(). */
2210 RM_FLAG_VERBOSE = 1,
2214 RM_FLAG_FNM_PATHNAME = 4
2217 /** Data passed to the action handler of com_rm(). */
2218 struct com_rm_action_data {
2219 /** Command line flags ((see \ref rm_flags). */
2221 /** Message buffer. */
2222 struct para_buffer pb;
2225 static int remove_audio_file(__a_unused struct osl_table *table,
2226 struct osl_row *row, const char *name, void *data)
2228 struct com_rm_action_data *crd = data;
2231 if (crd->flags & RM_FLAG_VERBOSE) {
2232 ret = para_printf(&crd->pb, "removing %s\n", name);
2236 afs_event(AUDIO_FILE_REMOVE, &crd->pb, row);
2237 ret = osl(osl_del_row(audio_file_table, row));
2239 para_printf(&crd->pb, "%s: %s\n", name, para_strerror(-ret));
2243 static void com_rm_callback(int fd, const struct osl_object *query)
2245 struct com_rm_action_data crd = {.flags = *(uint32_t *)query->data,
2247 .max_size = shm_get_shmmax(),
2248 .private_data = &(struct afs_max_size_handler_data) {
2252 .max_size_handler = afs_max_size_handler
2256 struct pattern_match_data pmd = {
2257 .table = audio_file_table,
2258 .loop_col_num = AFTCOL_HASH,
2259 .match_col_num = AFTCOL_PATH,
2260 .patterns = {.data = (char *)query->data + sizeof(uint32_t),
2261 .size = query->size - sizeof(uint32_t)},
2263 .action = remove_audio_file
2265 if (crd.flags & RM_FLAG_FNM_PATHNAME)
2266 pmd.fnmatch_flags |= FNM_PATHNAME;
2267 ret = for_each_matching_row(&pmd);
2269 para_printf(&crd.pb, "%s\n", para_strerror(-ret));
2272 if ((pmd.num_matches == 0) && !(crd.flags & RM_FLAG_FORCE))
2273 ret = para_printf(&crd.pb, "no matches -- nothing removed\n");
2274 else if (crd.flags & RM_FLAG_VERBOSE) {
2275 ret = para_printf(&crd.pb, "removed %u files\n",
2278 if (ret >= 0 && crd.pb.offset)
2279 pass_buffer_as_shm(fd, SBD_OUTPUT, crd.pb.buf, crd.pb.offset);
2283 /* TODO options: -r (recursive) */
2284 int com_rm(struct command_context *cc)
2287 struct osl_object query = {.data = &flags, .size = sizeof(flags)};
2290 for (i = 1; i < cc->argc; i++) {
2291 const char *arg = cc->argv[i];
2294 if (!strcmp(arg, "--")) {
2298 if (!strcmp(arg, "-f")) {
2299 flags |= RM_FLAG_FORCE;
2302 if (!strcmp(arg, "-p")) {
2303 flags |= RM_FLAG_FNM_PATHNAME;
2306 if (!strcmp(arg, "-v")) {
2307 flags |= RM_FLAG_VERBOSE;
2313 return -E_AFT_SYNTAX;
2314 ret = send_option_arg_callback_request(&query, cc->argc - i,
2315 cc->argv + i, com_rm_callback, afs_cb_result_handler, cc);
2317 send_strerror(cc, -ret);
2322 * Flags used by the cpsi command.
2327 /** Whether the lyrics id should be copied. */
2328 CPSI_FLAG_COPY_LYRICS_ID = 1,
2329 /** Whether the image id should be copied. */
2330 CPSI_FLAG_COPY_IMAGE_ID = 2,
2331 /** Whether the lastplayed time should be copied. */
2332 CPSI_FLAG_COPY_LASTPLAYED = 4,
2333 /** Whether the numplayed count should be copied. */
2334 CPSI_FLAG_COPY_NUMPLAYED = 8,
2335 /** Whether the attributes should be copied. */
2336 CPSI_FLAG_COPY_ATTRIBUTES = 16,
2337 /** Activates verbose mode. */
2338 CPSI_FLAG_VERBOSE = 32,
2341 /** Data passed to the action handler of com_cpsi(). */
2342 struct cpsi_action_data {
2343 /** command line flags (see \ref cpsi_flags). */
2345 /** Message buffer. */
2346 struct para_buffer pb;
2347 /** Values are copied from here. */
2348 struct afs_info source_afsi;
2351 static int copy_selector_info(__a_unused struct osl_table *table,
2352 struct osl_row *row, const char *name, void *data)
2354 struct cpsi_action_data *cad = data;
2355 struct osl_object target_afsi_obj;
2357 struct afs_info old_afsi, target_afsi;
2358 struct afsi_change_event_data aced;
2360 ret = get_afsi_object_of_row(row, &target_afsi_obj);
2363 load_afsi(&target_afsi, &target_afsi_obj);
2364 old_afsi = target_afsi;
2365 if (cad->flags & CPSI_FLAG_COPY_LYRICS_ID)
2366 target_afsi.lyrics_id = cad->source_afsi.lyrics_id;
2367 if (cad->flags & CPSI_FLAG_COPY_IMAGE_ID)
2368 target_afsi.image_id = cad->source_afsi.image_id;
2369 if (cad->flags & CPSI_FLAG_COPY_LASTPLAYED)
2370 target_afsi.last_played = cad->source_afsi.last_played;
2371 if (cad->flags & CPSI_FLAG_COPY_NUMPLAYED)
2372 target_afsi.num_played = cad->source_afsi.num_played;
2373 if (cad->flags & CPSI_FLAG_COPY_ATTRIBUTES)
2374 target_afsi.attributes = cad->source_afsi.attributes;
2375 save_afsi(&target_afsi, &target_afsi_obj); /* in-place update */
2376 if (cad->flags & CPSI_FLAG_VERBOSE) {
2377 ret = para_printf(&cad->pb, "copied afsi to %s\n", name);
2382 aced.old_afsi = &old_afsi;
2383 afs_event(AFSI_CHANGE, &cad->pb, &aced);
2387 static void com_cpsi_callback(int fd, const struct osl_object *query)
2389 struct cpsi_action_data cad = {
2390 .flags = *(unsigned *)query->data,
2392 .max_size = shm_get_shmmax(),
2393 .private_data = &(struct afs_max_size_handler_data) {
2397 .max_size_handler = afs_max_size_handler
2401 char *source_path = (char *)query->data + sizeof(cad.flags);
2402 struct pattern_match_data pmd = {
2403 .table = audio_file_table,
2404 .loop_col_num = AFTCOL_HASH,
2405 .match_col_num = AFTCOL_PATH,
2406 .patterns = {.data = source_path + strlen(source_path) + 1,
2407 .size = query->size - sizeof(cad.flags)
2408 - strlen(source_path) - 1},
2410 .action = copy_selector_info
2413 ret = get_afsi_of_path(source_path, &cad.source_afsi);
2416 ret = for_each_matching_row(&pmd);
2419 para_printf(&cad.pb, "%s\n", para_strerror(-ret));
2420 else if (pmd.num_matches > 0) {
2421 if (cad.flags & CPSI_FLAG_VERBOSE)
2422 para_printf(&cad.pb, "copied requested afsi from %s "
2423 "to %u files\n", source_path, pmd.num_matches);
2425 para_printf(&cad.pb, "no matches - nothing copied\n");
2427 pass_buffer_as_shm(fd, SBD_OUTPUT, cad.pb.buf, cad.pb.offset);
2431 int com_cpsi(struct command_context *cc)
2435 struct osl_object options = {.data = &flags, .size = sizeof(flags)};
2437 for (i = 1; i < cc->argc; i++) {
2438 const char *arg = cc->argv[i];
2441 if (!strcmp(arg, "--")) {
2445 if (!strcmp(arg, "-y")) {
2446 flags |= CPSI_FLAG_COPY_LYRICS_ID;
2449 if (!strcmp(arg, "-i")) {
2450 flags |= CPSI_FLAG_COPY_IMAGE_ID;
2453 if (!strcmp(arg, "-l")) {
2454 flags |= CPSI_FLAG_COPY_LASTPLAYED;
2457 if (!strcmp(arg, "-n")) {
2458 flags |= CPSI_FLAG_COPY_NUMPLAYED;
2461 if (!strcmp(arg, "-a")) {
2462 flags |= CPSI_FLAG_COPY_ATTRIBUTES;
2465 if (!strcmp(arg, "-v")) {
2466 flags |= CPSI_FLAG_VERBOSE;
2471 if (i + 1 >= cc->argc) /* need at least source file and pattern */
2472 return -E_AFT_SYNTAX;
2473 if (!(flags & ~CPSI_FLAG_VERBOSE)) /* no copy flags given */
2474 flags = ~(unsigned)CPSI_FLAG_VERBOSE | flags;
2475 ret = send_option_arg_callback_request(&options, cc->argc - i,
2476 cc->argv + i, com_cpsi_callback, afs_cb_result_handler, cc);
2478 send_strerror(cc, -ret);
2482 struct change_atts_data {
2483 uint64_t add_mask, del_mask;
2484 struct para_buffer pb;
2487 static int change_atts(__a_unused struct osl_table *table,
2488 struct osl_row *row, __a_unused const char *name, void *data)
2491 struct osl_object obj;
2492 struct afs_info old_afsi, new_afsi;
2493 struct afsi_change_event_data aced = {
2495 .old_afsi = &old_afsi
2497 struct change_atts_data *cad = data;
2499 ret = get_afsi_object_of_row(row, &obj);
2502 ret = load_afsi(&old_afsi, &obj);
2505 new_afsi = old_afsi;
2506 new_afsi.attributes |= cad->add_mask;
2507 new_afsi.attributes &= ~cad->del_mask;
2508 save_afsi(&new_afsi, &obj); /* in-place update */
2509 afs_event(AFSI_CHANGE, &cad->pb, &aced);
2513 static void com_setatt_callback(int fd, const struct osl_object *query)
2518 struct change_atts_data cad = {
2520 .max_size = shm_get_shmmax(),
2521 .max_size_handler = afs_max_size_handler,
2522 .private_data = &(struct afs_max_size_handler_data) {
2528 struct pattern_match_data pmd = {
2529 .table = audio_file_table,
2530 .loop_col_num = AFTCOL_HASH,
2531 .match_col_num = AFTCOL_PATH,
2532 .pm_flags = PM_SKIP_EMPTY_NAME,
2534 .action = change_atts
2537 for (p = query->data; p < (char *)query->data + query->size; p += len + 1) {
2539 unsigned char bitnum;
2542 ret = -E_ATTR_SYNTAX;
2546 if (c != '+' && c != '-')
2549 ret = get_attribute_bitnum_by_name(p, &bitnum);
2551 para_printf(&cad.pb, "attribute not found: %s\n", p);
2555 cad.add_mask |= (1UL << bitnum);
2557 cad.del_mask |= (1UL << bitnum);
2559 ret = -E_ATTR_SYNTAX;
2560 if (!cad.add_mask && !cad.del_mask)
2562 pmd.patterns.data = p;
2563 if (p >= (char *)query->data + query->size)
2565 pmd.patterns.size = (char *)query->data + query->size - p;
2566 ret = for_each_matching_row(&pmd);
2569 if (pmd.num_matches == 0)
2570 para_printf(&cad.pb, "no matches\n");
2573 para_printf(&cad.pb, "%s\n", para_strerror(-ret));
2575 pass_buffer_as_shm(fd, SBD_OUTPUT, cad.pb.buf, cad.pb.offset);
2579 int com_setatt(struct command_context *cc)
2582 return -E_ATTR_SYNTAX;
2583 return send_standard_callback_request(cc->argc - 1, cc->argv + 1,
2584 com_setatt_callback, afs_cb_result_handler, cc);
2587 static void afs_stat_callback(int fd, const struct osl_object *query)
2589 int *parser_friendly = query->data;
2590 char *buf = *parser_friendly?
2591 parser_friendly_status_items : status_items;
2595 pass_buffer_as_shm(fd, SBD_OUTPUT, buf, strlen(buf));
2599 * Get the current afs status items from the afs process and send it.
2601 * \param cc The command context, used e.g. for data encryption.
2602 * \param parser_friendly Whether parser-friendly output format should be used.
2604 * As the contents of the afs status items change in time and the command
2605 * handler only has a COW version created at fork time, it can not send
2606 * up-to-date afs status items directly. Therefore the usual callback mechanism
2607 * is used to pass the status items from the afs process to the command handler
2608 * via a shared memory area and a pipe.
2610 * \return The return value of the underlying call to \ref send_callback_request().
2612 int send_afs_status(struct command_context *cc, int parser_friendly)
2614 struct osl_object query = {.data = &parser_friendly,
2615 .size = sizeof(parser_friendly)};
2617 return send_callback_request(afs_stat_callback, &query,
2618 afs_cb_result_handler, cc);
2621 /* TODO: optionally fix problems by removing offending rows */
2622 static int check_audio_file(struct osl_row *row, void *data)
2625 struct para_buffer *pb = data;
2626 struct stat statbuf;
2627 int ret = get_audio_file_path_of_row(row, &path);
2628 struct afs_info afsi;
2632 return para_printf(pb, "%s\n", para_strerror(-ret));
2633 if (stat(path, &statbuf) < 0) {
2634 ret = para_printf(pb, "%s: stat error (%s)\n", path, strerror(errno));
2638 if (!S_ISREG(statbuf.st_mode)) {
2639 ret = para_printf(pb, "%s: not a regular file\n", path);
2644 ret = get_afsi_of_row(row, &afsi);
2646 return para_printf(pb, "%s: %s\n", path, para_strerror(-ret));
2647 ret = lyr_get_name_by_id(afsi.lyrics_id, &blob_name);
2649 ret = para_printf(pb, "%s lyrics id %u: %s\n", path, afsi.lyrics_id,
2650 para_strerror(-ret));
2654 ret = img_get_name_by_id(afsi.image_id, &blob_name);
2656 ret = para_printf(pb, "%s image id %u: %s\n", path, afsi.image_id,
2657 para_strerror(-ret));
2662 * Check the audio file table for inconsistencies.
2664 * \param fd The afs socket.
2665 * \param query Unused.
2667 * This function always succeeds.
2671 void aft_check_callback(int fd, __a_unused const struct osl_object *query)
2673 struct para_buffer pb = {
2674 .max_size = shm_get_shmmax(),
2675 .private_data = &(struct afs_max_size_handler_data) {
2679 .max_size_handler = afs_max_size_handler
2681 int ret = para_printf(&pb, "checking audio file table...\n");
2685 audio_file_loop(&pb, check_audio_file);
2687 pass_buffer_as_shm(fd, SBD_OUTPUT, pb.buf, pb.offset);
2692 * Close the audio file table.
2694 * \param flags Usual flags that are passed to osl_close_table().
2696 * \sa osl_close_table().
2698 static void aft_close(void)
2700 osl_close_table(audio_file_table, OSL_MARK_CLEAN);
2701 audio_file_table = NULL;
2705 * Open the audio file table.
2707 * \param dir The database directory.
2711 * \sa osl_open_table().
2713 static int aft_open(const char *dir)
2717 audio_file_table_desc.dir = dir;
2718 ret = osl(osl_open_table(&audio_file_table_desc, &audio_file_table));
2721 osl_get_num_rows(audio_file_table, &num);
2722 PARA_INFO_LOG("audio file table contains %d files\n", num);
2725 PARA_NOTICE_LOG("failed to open audio file table\n");
2726 audio_file_table = NULL;
2727 if (ret == -OSL_ERRNO_TO_PARA_ERROR(E_OSL_NOENT))
2732 static int aft_create(const char *dir)
2734 audio_file_table_desc.dir = dir;
2735 return osl(osl_create_table(&audio_file_table_desc));
2738 static int clear_attribute(struct osl_row *row, void *data)
2740 struct rmatt_event_data *red = data;
2741 struct afs_info afsi;
2742 struct osl_object obj;
2743 int ret = get_afsi_object_of_row(row, &obj);
2744 uint64_t mask = ~(1ULL << red->bitnum);
2748 ret = load_afsi(&afsi, &obj);
2751 afsi.attributes &= mask;
2752 save_afsi(&afsi, &obj);
2756 static int aft_event_handler(enum afs_events event, struct para_buffer *pb,
2762 case ATTRIBUTE_REMOVE: {
2763 const struct rmatt_event_data *red = data;
2764 ret = para_printf(pb, "clearing attribute %s (bit %u) from all "
2765 "entries in the audio file table\n", red->name,
2769 return audio_file_loop(data, clear_attribute);
2770 } case AFSI_CHANGE: {
2771 struct afsi_change_event_data *aced = data;
2772 uint64_t old_last_played = status_item_ls_data.afsi.last_played;
2773 if (aced->aft_row != current_aft_row)
2775 ret = get_afsi_of_row(aced->aft_row, &status_item_ls_data.afsi);
2778 status_item_ls_data.afsi.last_played = old_last_played;
2779 make_status_items();
2781 } case AFHI_CHANGE: {
2782 if (data != current_aft_row)
2784 ret = get_afhi_of_row(data, &status_item_ls_data.afhi);
2787 make_status_items();
2795 * Initialize the audio file table.
2797 * \param t Pointer to the structure to be initialized.
2799 void aft_init(struct afs_table *t)
2802 t->close = aft_close;
2803 t->create = aft_create;
2804 t->event_handler = aft_event_handler;