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 /** Size of the largest chunk in bytes. (4 bytes). */
339 AFHI_MAX_CHUNK_SIZE_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_MAX_CHUNK_SIZE_OFFSET, afhi->max_chunk_size);
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->max_chunk_size = read_u32(buf + AFHI_MAX_CHUNK_SIZE_OFFSET);
402 afhi->chunk_tv.tv_sec = read_u32(buf + CHUNK_TV_TV_SEC_OFFSET);
403 afhi->chunk_tv.tv_usec = read_u32(buf + CHUNK_TV_TV_USEC_OFFSET);
404 afhi->techinfo = (char *)buf + AFHI_INFO_STRING_OFFSET;
405 afhi->tags.artist = afhi->techinfo + strlen(afhi->techinfo) + 1;
406 afhi->tags.title = afhi->tags.artist + strlen(afhi->tags.artist) + 1;
407 afhi->tags.year = afhi->tags.title + strlen(afhi->tags.title) + 1;
408 afhi->tags.album = afhi->tags.year + strlen(afhi->tags.year) + 1;
409 afhi->tags.comment = afhi->tags.album + strlen(afhi->tags.album) + 1;
412 /* Only used for saving the chunk table, but not for loading. */
413 static unsigned sizeof_chunk_table(struct afh_info *afhi)
415 if (!afhi || !afhi->chunk_table)
417 return 4 * (afhi->chunks_total + 1);
420 static void save_chunk_table(struct afh_info *afhi, char *buf)
424 if (!afhi->chunk_table)
426 for (n = 0; n <= afhi->chunks_total; n++)
427 write_u32(buf + 4 * n, afhi->chunk_table[n]);
430 static void load_chunk_table(struct afh_info *afhi, const struct osl_object *ct)
435 if (!ct->data || ct->size < 4) {
436 afhi->chunk_table = NULL;
439 sz = PARA_MIN(((size_t)afhi->chunks_total + 1) * 4, ct->size) + 1;
440 afhi->chunk_table = para_malloc(sz);
441 for (i = 0; i <= afhi->chunks_total && i * 4 + 3 < ct->size; i++)
442 afhi->chunk_table[i] = read_u32(ct->data + 4 * i);
446 * Get the row of the audio file table corresponding to the given path.
448 * \param path The full path of the audio file.
449 * \param row Result pointer.
453 int aft_get_row_of_path(const char *path, struct osl_row **row)
455 struct osl_object obj = {.data = (char *)path, .size = strlen(path) + 1};
457 return osl(osl_get_row(audio_file_table, AFTCOL_PATH, &obj, row));
461 * Get the row of the audio file table corresponding to the given hash value.
463 * \param hash The hash value of the desired audio file.
464 * \param row Result pointer.
468 static int aft_get_row_of_hash(unsigned char *hash, struct osl_row **row)
470 const struct osl_object obj = {.data = hash, .size = HASH_SIZE};
471 return osl(osl_get_row(audio_file_table, AFTCOL_HASH, &obj, row));
475 * Get the audio file selector info object of a row.
477 * \param row Pointer to a row in the audio file table.
478 * \param obj Result pointer.
482 static int get_afsi_object_of_row(const struct osl_row *row,
483 struct osl_object *obj)
485 return osl(osl_get_object(audio_file_table, row, AFTCOL_AFSI, obj));
489 * Get the osl object holding the audio file selector info, given a path.
492 * \param path The full path of the audio file.
493 * \param obj Result pointer.
495 * \return Positive on success, negative on errors.
497 static int get_afsi_object_of_path(const char *path, struct osl_object *obj)
500 int ret = aft_get_row_of_path(path, &row);
503 return get_afsi_object_of_row(row, obj);
507 * Get the audio file selector info, given a row of the audio file table.
509 * \param row Pointer to a row in the audio file table.
510 * \param afsi Result pointer.
512 * \return Positive on success, negative on errors.
514 int get_afsi_of_row(const struct osl_row *row, struct afs_info *afsi)
516 struct osl_object obj;
517 int ret = get_afsi_object_of_row(row, &obj);
520 return load_afsi(afsi, &obj);
524 * Get the audio file selector info, given the path of an audio table.
526 * \param path The full path of the audio file.
527 * \param afsi Result pointer.
531 static int get_afsi_of_path(const char *path, struct afs_info *afsi)
533 struct osl_object obj;
534 int ret = get_afsi_object_of_path(path, &obj);
537 return load_afsi(afsi, &obj);
541 * Get the path of an audio file, given a row of the audio file table.
543 * \param row Pointer to a row in the audio file table.
544 * \param path Result pointer.
546 * The result is a pointer to mmapped data. The caller must not attempt
551 int get_audio_file_path_of_row(const struct osl_row *row, char **path)
553 struct osl_object path_obj;
554 int ret = osl(osl_get_object(audio_file_table, row, AFTCOL_PATH,
558 *path = path_obj.data;
563 * Get the object containing the hash value of an audio file, given a row.
565 * \param row Pointer to a row of the audio file table.
566 * \param obj Result pointer.
568 * \return The return value of the underlying call to osl_get_object().
570 * \sa get_hash_of_row().
572 static int get_hash_object_of_aft_row(const struct osl_row *row,
573 struct osl_object *obj)
575 return osl(osl_get_object(audio_file_table, row, AFTCOL_HASH, obj));
579 * Get the hash value of an audio file, given a row of the audio file table.
581 * \param row Pointer to a row of the audio file table.
582 * \param hash Result pointer.
584 * \a hash points to mapped data and must not be freed by the caller.
586 * \return The return value of the underlying call to
587 * get_hash_object_of_aft_row().
589 static int get_hash_of_row(const struct osl_row *row, unsigned char **hash)
591 struct osl_object obj;
592 int ret = get_hash_object_of_aft_row(row, &obj);
601 * Get the audio format handler info, given a row of the audio file table.
603 * \param row Pointer to a row of the audio file table.
604 * \param afhi Result pointer.
606 * \return The return value of the underlying call to osl_get_object().
608 * \sa get_chunk_table_of_row().
610 int get_afhi_of_row(const struct osl_row *row, struct afh_info *afhi)
612 struct osl_object obj;
613 int ret = osl(osl_get_object(audio_file_table, row, AFTCOL_AFHI,
617 load_afhi(obj.data, afhi);
621 /* returns shmid on success */
622 static int save_afd(struct audio_file_data *afd)
624 size_t size = sizeof(*afd) + sizeof_chunk_table(&afd->afhi);
625 int shmid, ret = shm_new(size);
632 ret = shm_attach(shmid, ATTACH_RW, &shm_afd);
637 save_chunk_table(&afd->afhi, buf);
638 if (afd->afhi.max_chunk_size == 0) { /* v0.5.x on-disk afhi */
639 set_max_chunk_size(&afd->afhi);
640 PARA_NOTICE_LOG("max chunk size unset, re-add required\n");
642 PARA_INFO_LOG("using max chunk size from afhi\n");
643 afd->max_chunk_size = afd->afhi.max_chunk_size;
644 *(struct audio_file_data *)shm_afd = *afd;
653 * Extract a afd stored in a shared memory area.
655 * Attach the shared memory area given by \a shmid, load the audio file data
656 * stored therein and detach the area afterwards. Called by vss, after
657 * receiving a positive response to the request for the next audio file.
659 * \param shmid The identifier of the shared memory area containing the afd.
660 * \param afd Result pointer.
664 int load_afd(int shmid, struct audio_file_data *afd)
668 struct osl_object obj;
670 ret = shm_attach(shmid, ATTACH_RO, &shm_afd);
673 ret = shm_size(shmid, &obj.size);
676 *afd = *(struct audio_file_data *)shm_afd;
677 obj.data = shm_afd + sizeof(*afd);
678 obj.size -= sizeof(*afd);
679 load_chunk_table(&afd->afhi, &obj);
686 static int get_local_time(uint64_t *seconds, char *buf, size_t size,
687 time_t current_time, enum ls_listing_mode lm)
691 * Omit year but show time if the given value is closer to the current
692 * time than this many seconds.
694 const time_t m = 6 * 30 * 24 * 3600; /* six months */
696 tm = localtime((time_t *)seconds);
699 if (lm == LS_MODE_MBOX) {
700 if (!strftime(buf, size, "%c", tm))
704 if (*seconds > current_time - m && *seconds < current_time + m) {
705 if (!strftime(buf, size, "%b %e %k:%M", tm))
710 * If the given time is more than six month away from the current time,
711 * we print only the year. The additional space character in the format
712 * string below makes the formated date align nicely with dates that
713 * contain the time (those written by the above strftime() statement).
715 if (!strftime(buf, size, "%b %e %Y", tm))
720 /** Compute the number of (decimal) digits of a number. */
721 #define GET_NUM_DIGITS(x, num) { \
722 typeof((x)) _tmp = PARA_ABS(x); \
725 while ((_tmp) > 9) { \
731 __a_const static short unsigned get_duration_width(int seconds)
733 short unsigned width;
734 unsigned hours = seconds / 3600, mins = (seconds % 3600) / 60;
736 if (!hours) /* less than one hour => m:ss or mm:ss => 4 or 5 digits */
737 return 4 + (mins > 9);
738 /* more than one hour => h:mm:ss, hh:mm:ss, hhh:mm:ss, ... */
739 GET_NUM_DIGITS(hours, &width);
743 static void get_duration_buf(int seconds, char *buf, struct ls_options *opts)
745 unsigned hours = seconds / 3600, mins = (seconds % 3600) / 60;
746 short unsigned max_width;
748 if (!hours) { /* m:ss or mm:ss */
749 max_width = opts->mode == LS_MODE_LONG?
750 opts->widths.duration_width : 4;
751 sprintf(buf, "%*u:%02d", max_width - 3, mins, seconds % 60);
752 } else { /* more than one hour => h:mm:ss, hh:mm:ss, hhh:mm:ss, ... */
753 max_width = opts->mode == LS_MODE_LONG?
754 opts->widths.duration_width : 7;
755 sprintf(buf, "%*u:%02u:%02d", max_width - 6, hours, mins,
760 static int write_attribute_items(struct para_buffer *b,
761 const char *att_bitmap, struct afs_info *afsi)
766 WRITE_STATUS_ITEM(b, SI_ATTRIBUTES_BITMAP, "%s\n", att_bitmap);
767 ret = get_attribute_text(&afsi->attributes, " ", &att_text);
770 WRITE_STATUS_ITEM(b, SI_ATTRIBUTES_TXT, "%s\n", att_text);
775 static void write_lyrics_items(struct para_buffer *b, struct afs_info *afsi)
779 WRITE_STATUS_ITEM(b, SI_LYRICS_ID, "%u\n", afsi->lyrics_id);
780 lyr_get_name_by_id(afsi->lyrics_id, &lyrics_name);
781 WRITE_STATUS_ITEM(b, SI_LYRICS_NAME, "%s\n", lyrics_name?
782 lyrics_name : "(none)");
785 static void write_image_items(struct para_buffer *b, struct afs_info *afsi)
789 WRITE_STATUS_ITEM(b, SI_IMAGE_ID, "%u\n", afsi->image_id);
790 img_get_name_by_id(afsi->image_id, &image_name);
791 WRITE_STATUS_ITEM(b, SI_IMAGE_NAME, "%s\n", image_name?
792 image_name : "(none)");
795 static void write_filename_items(struct para_buffer *b, const char *path,
800 if (!(flags & LS_FLAG_FULL_PATH)) {
801 WRITE_STATUS_ITEM(b, SI_BASENAME, "%s\n", path);
804 WRITE_STATUS_ITEM(b, SI_PATH, "%s\n", path);
805 val = para_basename(path);
806 WRITE_STATUS_ITEM(b, SI_BASENAME, "%s\n", val? val : "");
807 val = para_dirname(path);
808 WRITE_STATUS_ITEM(b, SI_DIRECTORY, "%s\n", val? val : "");
812 static int print_chunk_table(struct ls_data *d, struct para_buffer *b)
814 struct osl_object chunk_table_obj;
815 struct osl_row *aft_row;
819 ret = aft_get_row_of_hash(d->hash, &aft_row);
822 ret = osl(osl_open_disk_object(audio_file_table, aft_row,
823 AFTCOL_CHUNKS, &chunk_table_obj));
826 para_printf(b, "%s\n"
827 "chunk_time: %lu:%lu\nchunk_offsets: ",
829 (long unsigned) d->afhi.chunk_tv.tv_sec,
830 (long unsigned) d->afhi.chunk_tv.tv_usec
832 buf = chunk_table_obj.data;
835 i <= d->afhi.chunks_total && 4 * i + 3 < chunk_table_obj.size;
838 para_printf(b, "%u ", (unsigned) read_u32(buf + 4 * i));
839 para_printf(b, "\n");
841 osl_close_disk_object(&chunk_table_obj);
845 static void write_score(struct para_buffer *b, struct ls_data *d,
846 struct ls_options *opts)
848 if (!(opts->flags & LS_FLAG_ADMISSIBLE_ONLY)) /* no score*/
850 WRITE_STATUS_ITEM(b, SI_SCORE, "%li\n", d->score);
853 static int print_list_item(struct ls_data *d, struct ls_options *opts,
854 struct para_buffer *b, time_t current_time)
858 char last_played_time[30];
859 char duration_buf[30]; /* nobody has an audio file long enough to overflow this */
860 struct afs_info *afsi = &d->afsi;
861 struct afh_info *afhi = &d->afhi;
862 char asc_hash[2 * HASH_SIZE + 1];
864 if (opts->mode == LS_MODE_SHORT) {
865 para_printf(b, "%s\n", d->path);
869 if (opts->mode == LS_MODE_CHUNKS) {
870 ret = print_chunk_table(d, b);
873 get_attribute_bitmap(&afsi->attributes, att_buf);
874 if (opts->flags & LS_FLAG_UNIXDATE)
875 sprintf(last_played_time, "%llu",
876 (long long unsigned)afsi->last_played);
878 ret = get_local_time(&afsi->last_played, last_played_time,
879 sizeof(last_played_time), current_time, opts->mode);
883 get_duration_buf(afhi->seconds_total, duration_buf, opts);
884 if (opts->mode == LS_MODE_LONG) {
885 struct ls_widths *w = &opts->widths;
886 if (opts->flags & LS_FLAG_ADMISSIBLE_ONLY) {
887 para_printf(b, "%*li ", opts->widths.score_width,
891 "%s " /* attributes */
893 "%*u " /* image_id */
894 "%*u " /* lyrics_id */
896 "%*s " /* audio format */
897 "%*u " /* frequency */
900 "%*u " /* num_played */
901 "%s " /* last_played */
904 w->amp_width, afsi->amp,
905 w->image_id_width, afsi->image_id,
906 w->lyrics_id_width, afsi->lyrics_id,
907 w->bitrate_width, afhi->bitrate,
908 w->audio_format_width,
909 audio_format_name(afsi->audio_format_id),
910 w->frequency_width, afhi->frequency,
913 w->num_played_width, afsi->num_played,
920 if (opts->mode == LS_MODE_MBOX) {
921 const char *bn = para_basename(d->path);
923 "From foo@localhost %s\n"
924 "Received: from\nTo: bar\nFrom: a\n"
929 write_filename_items(b, d->path, opts->flags);
930 write_score(b, d, opts);
931 ret = write_attribute_items(b, att_buf, afsi);
934 write_image_items(b, afsi);
935 write_lyrics_items(b, afsi);
936 hash_to_asc(d->hash, asc_hash);
937 WRITE_STATUS_ITEM(b, SI_HASH, "%s\n", asc_hash);
938 WRITE_STATUS_ITEM(b, SI_BITRATE, "%dkbit/s\n", afhi->bitrate);
939 WRITE_STATUS_ITEM(b, SI_FORMAT, "%s\n",
940 audio_format_name(afsi->audio_format_id));
941 WRITE_STATUS_ITEM(b, SI_FREQUENCY, "%dHz\n", afhi->frequency);
942 WRITE_STATUS_ITEM(b, SI_CHANNELS, "%d\n", afhi->channels);
943 WRITE_STATUS_ITEM(b, SI_DURATION, "%s\n", duration_buf);
944 WRITE_STATUS_ITEM(b, SI_SECONDS_TOTAL, "%" PRIu32 "\n",
945 afhi->seconds_total);
946 WRITE_STATUS_ITEM(b, SI_LAST_PLAYED, "%s\n", last_played_time);
947 WRITE_STATUS_ITEM(b, SI_NUM_PLAYED, "%u\n", afsi->num_played);
948 WRITE_STATUS_ITEM(b, SI_AMPLIFICATION, "%u\n", afsi->amp);
949 WRITE_STATUS_ITEM(b, SI_CHUNK_TIME, "%lu\n", tv2ms(&afhi->chunk_tv));
950 WRITE_STATUS_ITEM(b, SI_NUM_CHUNKS, "%" PRIu32 "\n",
952 WRITE_STATUS_ITEM(b, SI_MAX_CHUNK_SIZE, "%" PRIu32 "\n",
953 afhi->max_chunk_size);
954 WRITE_STATUS_ITEM(b, SI_TECHINFO, "%s\n", afhi->techinfo);
955 WRITE_STATUS_ITEM(b, SI_ARTIST, "%s\n", afhi->tags.artist);
956 WRITE_STATUS_ITEM(b, SI_TITLE, "%s\n", afhi->tags.title);
957 WRITE_STATUS_ITEM(b, SI_YEAR, "%s\n", afhi->tags.year);
958 WRITE_STATUS_ITEM(b, SI_ALBUM, "%s\n", afhi->tags.album);
959 WRITE_STATUS_ITEM(b, SI_COMMENT, "%s\n", afhi->tags.comment);
960 if (opts->mode == LS_MODE_MBOX) {
961 struct osl_object lyrics_def;
962 lyr_get_def_by_id(afsi->lyrics_id, &lyrics_def);
963 if (lyrics_def.data) {
964 para_printf(b, "Lyrics:\n~~~~~~~\n%s",
965 (char *)lyrics_def.data);
966 osl_close_disk_object(&lyrics_def);
973 static struct ls_data status_item_ls_data;
974 static struct osl_row *current_aft_row;
976 static void make_inode_status_items(struct para_buffer *pb)
978 struct stat statbuf = {.st_size = 0};
979 char *path, mtime_str[30] = "\0";
983 ret = get_audio_file_path_of_row(current_aft_row, &path);
986 ret = stat(path, &statbuf);
989 localtime_r(&statbuf.st_mtime, &mtime_tm);
990 ret = strftime(mtime_str, 29, "%b %d %Y", &mtime_tm);
991 assert(ret > 0); /* number of bytes placed in mtime_str */
993 WRITE_STATUS_ITEM(pb, SI_MTIME, "%s\n", mtime_str);
994 WRITE_STATUS_ITEM(pb, SI_FILE_SIZE, "%ld\n", statbuf.st_size / 1024);
997 static int make_status_items(void)
999 struct ls_options opts = {
1000 .flags = LS_FLAG_FULL_PATH | LS_FLAG_ADMISSIBLE_ONLY,
1001 .mode = LS_MODE_VERBOSE,
1003 struct para_buffer pb = {.max_size = shm_get_shmmax() - 1};
1004 time_t current_time;
1007 time(¤t_time);
1008 ret = print_list_item(&status_item_ls_data, &opts, &pb, current_time);
1011 make_inode_status_items(&pb);
1013 status_items = pb.buf;
1014 memset(&pb, 0, sizeof(pb));
1015 pb.max_size = shm_get_shmmax() - 1;
1016 pb.flags = PBF_SIZE_PREFIX;
1017 ret = print_list_item(&status_item_ls_data, &opts, &pb, current_time);
1020 status_items = NULL;
1023 make_inode_status_items(&pb);
1024 free(parser_friendly_status_items);
1025 parser_friendly_status_items = pb.buf;
1030 * Open the audio file with highest score and set up an afd structure.
1032 * \param afd Result pointer.
1034 * On success, the numplayed field of the audio file selector info is increased
1035 * and the lastplayed time is set to the current time. Finally, the score of
1036 * the audio file is updated.
1038 * \return Positive shmid on success, negative on errors.
1040 int open_and_update_audio_file(struct audio_file_data *afd)
1042 unsigned char file_hash[HASH_SIZE];
1043 struct osl_object afsi_obj;
1044 struct afs_info new_afsi;
1046 struct afsi_change_event_data aced;
1047 struct osl_object map, chunk_table_obj;
1048 struct ls_data *d = &status_item_ls_data;
1050 ret = score_get_best(¤t_aft_row, &d->score);
1053 ret = get_hash_of_row(current_aft_row, &d->hash);
1056 ret = get_audio_file_path_of_row(current_aft_row, &d->path);
1059 PARA_NOTICE_LOG("%s\n", d->path);
1060 ret = get_afsi_object_of_row(current_aft_row, &afsi_obj);
1063 ret = load_afsi(&d->afsi, &afsi_obj);
1066 ret = get_afhi_of_row(current_aft_row, &afd->afhi);
1069 d->afhi = afd->afhi;
1070 d->afhi.chunk_table = afd->afhi.chunk_table = NULL;
1071 ret = osl(osl_open_disk_object(audio_file_table, current_aft_row,
1072 AFTCOL_CHUNKS, &chunk_table_obj));
1074 if (!afh_supports_dynamic_chunks(d->afsi.audio_format_id))
1076 PARA_INFO_LOG("no chunk table for %s\n", d->path);
1077 chunk_table_obj.data = NULL;
1078 chunk_table_obj.size = 0;
1080 PARA_INFO_LOG("chunk table: %zu bytes\n", chunk_table_obj.size);
1082 ret = mmap_full_file(d->path, O_RDONLY, &map.data, &map.size, &afd->fd);
1085 hash_function(map.data, map.size, file_hash);
1086 ret = hash_compare(file_hash, d->hash);
1087 para_munmap(map.data, map.size);
1089 ret = -E_HASH_MISMATCH;
1093 new_afsi.num_played++;
1094 new_afsi.last_played = time(NULL);
1095 save_afsi(&new_afsi, &afsi_obj); /* in-place update */
1097 afd->audio_format_id = d->afsi.audio_format_id;
1098 load_chunk_table(&afd->afhi, &chunk_table_obj);
1099 aced.aft_row = current_aft_row;
1100 aced.old_afsi = &d->afsi;
1102 * No need to update the status items as the AFSI_CHANGE event will
1105 ret = afs_event(AFSI_CHANGE, NULL, &aced);
1108 ret = save_afd(afd);
1110 free(afd->afhi.chunk_table);
1111 if (chunk_table_obj.data)
1112 osl_close_disk_object(&chunk_table_obj);
1114 PARA_ERROR_LOG("%s: %s\n", d->path, para_strerror(-ret));
1115 ret = score_delete(current_aft_row);
1122 static int ls_audio_format_compare(const void *a, const void *b)
1124 struct ls_data *d1 = *(struct ls_data **)a, *d2 = *(struct ls_data **)b;
1125 return NUM_COMPARE(d1->afsi.audio_format_id, d2->afsi.audio_format_id);
1128 static int ls_duration_compare(const void *a, const void *b)
1130 struct ls_data *d1 = *(struct ls_data **)a, *d2 = *(struct ls_data **)b;
1131 return NUM_COMPARE(d1->afhi.seconds_total, d2->afhi.seconds_total);
1134 static int ls_bitrate_compare(const void *a, const void *b)
1136 struct ls_data *d1 = *(struct ls_data **)a, *d2 = *(struct ls_data **)b;
1137 return NUM_COMPARE(d1->afhi.bitrate, d2->afhi.bitrate);
1140 static int ls_lyrics_id_compare(const void *a, const void *b)
1142 struct ls_data *d1 = *(struct ls_data **)a, *d2 = *(struct ls_data **)b;
1143 return NUM_COMPARE(d1->afsi.lyrics_id, d2->afsi.lyrics_id);
1146 static int ls_image_id_compare(const void *a, const void *b)
1148 struct ls_data *d1 = *(struct ls_data **)a, *d2 = *(struct ls_data **)b;
1149 return NUM_COMPARE(d1->afsi.image_id, d2->afsi.image_id);
1152 static int ls_channels_compare(const void *a, const void *b)
1154 struct ls_data *d1 = *(struct ls_data **)a, *d2 = *(struct ls_data **)b;
1155 return NUM_COMPARE(d1->afhi.channels, d2->afhi.channels);
1158 static int ls_frequency_compare(const void *a, const void *b)
1160 struct ls_data *d1 = *(struct ls_data **)a, *d2 = *(struct ls_data **)b;
1161 return NUM_COMPARE(d1->afhi.frequency, d2->afhi.frequency);
1164 static int ls_num_played_compare(const void *a, const void *b)
1166 struct ls_data *d1 = *(struct ls_data **)a, *d2 = *(struct ls_data **)b;
1167 return NUM_COMPARE(d1->afsi.num_played, d2->afsi.num_played);
1170 static int ls_last_played_compare(const void *a, const void *b)
1172 struct ls_data *d1 = *(struct ls_data **)a, *d2 = *(struct ls_data **)b;
1173 return NUM_COMPARE(d1->afsi.last_played, d2->afsi.last_played);
1176 static int ls_score_compare(const void *a, const void *b)
1178 struct ls_data *d1 = *(struct ls_data **)a, *d2 = *(struct ls_data **)b;
1179 return NUM_COMPARE(d1->score, d2->score);
1182 static int ls_path_compare(const void *a, const void *b)
1184 struct ls_data *d1 = *(struct ls_data **)a, *d2 = *(struct ls_data **)b;
1185 return strcmp(d1->path, d2->path);
1188 static int sort_matching_paths(struct ls_options *options)
1190 size_t nmemb = options->num_matching_paths;
1191 size_t size = sizeof(*options->data_ptr);
1192 int (*compar)(const void *, const void *);
1195 options->data_ptr = para_malloc(nmemb * sizeof(*options->data_ptr));
1196 for (i = 0; i < nmemb; i++)
1197 options->data_ptr[i] = options->data + i;
1199 /* In these cases the array is already sorted */
1200 if (options->sorting == LS_SORT_BY_PATH
1201 && !(options->flags & LS_FLAG_ADMISSIBLE_ONLY)
1202 && (options->flags & LS_FLAG_FULL_PATH))
1204 if (options->sorting == LS_SORT_BY_SCORE &&
1205 options->flags & LS_FLAG_ADMISSIBLE_ONLY)
1208 switch (options->sorting) {
1209 case LS_SORT_BY_PATH:
1210 compar = ls_path_compare; break;
1211 case LS_SORT_BY_SCORE:
1212 compar = ls_score_compare; break;
1213 case LS_SORT_BY_LAST_PLAYED:
1214 compar = ls_last_played_compare; break;
1215 case LS_SORT_BY_NUM_PLAYED:
1216 compar = ls_num_played_compare; break;
1217 case LS_SORT_BY_FREQUENCY:
1218 compar = ls_frequency_compare; break;
1219 case LS_SORT_BY_CHANNELS:
1220 compar = ls_channels_compare; break;
1221 case LS_SORT_BY_IMAGE_ID:
1222 compar = ls_image_id_compare; break;
1223 case LS_SORT_BY_LYRICS_ID:
1224 compar = ls_lyrics_id_compare; break;
1225 case LS_SORT_BY_BITRATE:
1226 compar = ls_bitrate_compare; break;
1227 case LS_SORT_BY_DURATION:
1228 compar = ls_duration_compare; break;
1229 case LS_SORT_BY_AUDIO_FORMAT:
1230 compar = ls_audio_format_compare; break;
1234 qsort(options->data_ptr, nmemb, size, compar);
1238 /* row is either an aft_row or a row of the score table */
1239 /* TODO: Only compute widths if we need them */
1240 static int prepare_ls_row(struct osl_row *row, void *ls_opts)
1243 struct ls_options *options = ls_opts;
1245 struct ls_widths *w;
1246 unsigned short num_digits;
1248 struct osl_row *aft_row;
1252 if (options->flags & LS_FLAG_ADMISSIBLE_ONLY) {
1253 ret = get_score_and_aft_row(row, &score, &aft_row);
1260 ret = get_audio_file_path_of_row(aft_row, &path);
1263 if (!(options->flags & LS_FLAG_FULL_PATH)) {
1264 char *p = strrchr(path, '/');
1268 if (options->num_patterns) {
1269 for (i = 0; i < options->num_patterns; i++) {
1270 ret = fnmatch(options->patterns[i], path, 0);
1273 if (ret == FNM_NOMATCH)
1277 if (i >= options->num_patterns) /* no match */
1280 tmp = options->num_matching_paths++;
1281 if (options->num_matching_paths > options->array_size) {
1282 options->array_size++;
1283 options->array_size *= 2;
1284 options->data = para_realloc(options->data, options->array_size
1285 * sizeof(*options->data));
1287 d = options->data + tmp;
1288 ret = get_afsi_of_row(aft_row, &d->afsi);
1291 ret = get_afhi_of_row(aft_row, &d->afhi);
1295 ret = get_hash_of_row(aft_row, &d->hash);
1298 w = &options->widths;
1299 GET_NUM_DIGITS(d->afsi.image_id, &num_digits);
1300 w->image_id_width = PARA_MAX(w->image_id_width, num_digits);
1301 GET_NUM_DIGITS(d->afsi.lyrics_id, &num_digits);
1302 w->lyrics_id_width = PARA_MAX(w->lyrics_id_width, num_digits);
1303 GET_NUM_DIGITS(d->afhi.bitrate, &num_digits);
1304 w->bitrate_width = PARA_MAX(w->bitrate_width, num_digits);
1305 GET_NUM_DIGITS(d->afhi.frequency, &num_digits);
1306 w->frequency_width = PARA_MAX(w->frequency_width, num_digits);
1307 GET_NUM_DIGITS(d->afsi.num_played, &num_digits);
1308 w->num_played_width = PARA_MAX(w->num_played_width, num_digits);
1309 /* get the number of chars to print this amount of time */
1310 num_digits = get_duration_width(d->afhi.seconds_total);
1311 w->duration_width = PARA_MAX(w->duration_width, num_digits);
1312 GET_NUM_DIGITS(d->afsi.amp, &num_digits);
1313 w->amp_width = PARA_MAX(w->amp_width, num_digits);
1314 num_digits = strlen(audio_format_name(d->afsi.audio_format_id));
1315 w->audio_format_width = PARA_MAX(w->audio_format_width, num_digits);
1316 if (options->flags & LS_FLAG_ADMISSIBLE_ONLY) {
1317 GET_NUM_DIGITS(score, &num_digits);
1318 num_digits++; /* add one for the sign (space or "-") */
1319 w->score_width = PARA_MAX(w->score_width, num_digits);
1327 static int com_ls_callback(struct afs_callback_arg *aca)
1329 struct ls_options *opts = aca->query.data;
1330 char *p, *pattern_start = (char *)aca->query.data + sizeof(*opts);
1332 time_t current_time;
1334 aca->pbout.flags = (opts->mode == LS_MODE_PARSER)? PBF_SIZE_PREFIX : 0;
1335 if (opts->num_patterns) {
1336 opts->patterns = para_malloc(opts->num_patterns * sizeof(char *));
1337 for (i = 0, p = pattern_start; i < opts->num_patterns; i++) {
1338 opts->patterns[i] = p;
1342 opts->patterns = NULL;
1343 if (opts->flags & LS_FLAG_ADMISSIBLE_ONLY)
1344 ret = admissible_file_loop(opts, prepare_ls_row);
1346 ret = osl(osl_rbtree_loop(audio_file_table, AFTCOL_PATH, opts,
1350 if (opts->num_matching_paths == 0) {
1351 ret = opts->num_patterns > 0? -E_NO_MATCH : 0;
1354 ret = sort_matching_paths(opts);
1357 time(¤t_time);
1358 if (opts->flags & LS_FLAG_REVERSE)
1359 for (i = opts->num_matching_paths - 1; i >= 0; i--) {
1360 ret = print_list_item(opts->data_ptr[i], opts,
1361 &aca->pbout, current_time);
1366 for (i = 0; i < opts->num_matching_paths; i++) {
1367 ret = print_list_item(opts->data_ptr[i], opts,
1368 &aca->pbout, current_time);
1374 free(opts->data_ptr);
1375 free(opts->patterns);
1380 * TODO: flags -h (sort by hash)
1382 int com_ls(struct command_context *cc)
1386 enum ls_sorting_method sort = LS_SORT_BY_PATH;
1387 enum ls_listing_mode mode = LS_MODE_SHORT;
1388 struct ls_options opts = {.patterns = NULL};
1389 struct osl_object query = {.data = &opts, .size = sizeof(opts)};
1391 for (i = 1; i < cc->argc; i++) {
1392 const char *arg = cc->argv[i];
1395 if (!strcmp(arg, "--")) {
1400 * Compatibility: Prior to 0.5.5 it was necessary to specify
1401 * the listing mode without the '=' character as in -lv, for
1402 * example. Now the variant with '=' is preferred and
1403 * documented but we still accept the old way to specify the
1406 * Support for the legacy syntax can be dropped at 0.6.0
1409 if (!strncmp(arg, "-l", 2)) {
1415 mode = LS_MODE_SHORT;
1419 mode = LS_MODE_LONG;
1422 mode = LS_MODE_VERBOSE;
1425 mode = LS_MODE_MBOX;
1428 mode = LS_MODE_CHUNKS;
1431 mode = LS_MODE_PARSER;
1434 return -E_AFT_SYNTAX;
1437 if (!strcmp(arg, "-p") || !strcmp(arg, "-F")) {
1438 flags |= LS_FLAG_FULL_PATH;
1441 if (!strcmp(arg, "-b")) {
1442 flags &= ~LS_FLAG_FULL_PATH;
1445 if (!strcmp(arg, "-a")) {
1446 flags |= LS_FLAG_ADMISSIBLE_ONLY;
1449 if (!strcmp(arg, "-r")) {
1450 flags |= LS_FLAG_REVERSE;
1453 if (!strcmp(arg, "-d")) {
1454 flags |= LS_FLAG_UNIXDATE;
1457 /* The compatibility remark above applies also to -s. */
1458 if (!strncmp(arg, "-s", 2)) {
1464 sort = LS_SORT_BY_PATH;
1466 case 's': /* -ss implies -a */
1467 sort = LS_SORT_BY_SCORE;
1468 flags |= LS_FLAG_ADMISSIBLE_ONLY;
1471 sort = LS_SORT_BY_LAST_PLAYED;
1474 sort = LS_SORT_BY_NUM_PLAYED;
1477 sort = LS_SORT_BY_FREQUENCY;
1480 sort = LS_SORT_BY_CHANNELS;
1483 sort = LS_SORT_BY_IMAGE_ID;
1486 sort = LS_SORT_BY_LYRICS_ID;
1489 sort = LS_SORT_BY_BITRATE;
1492 sort = LS_SORT_BY_DURATION;
1495 sort = LS_SORT_BY_AUDIO_FORMAT;
1498 return -E_AFT_SYNTAX;
1501 return -E_AFT_SYNTAX;
1504 opts.sorting = sort;
1506 opts.num_patterns = cc->argc - i;
1507 return send_option_arg_callback_request(&query, opts.num_patterns,
1508 cc->argv + i, com_ls_callback, afs_cb_result_handler, cc);
1512 * Call the given function for each file in the audio file table.
1514 * \param private_data An arbitrary data pointer, passed to \a func.
1515 * \param func The custom function to be called.
1519 int audio_file_loop(void *private_data, osl_rbtree_loop_func *func)
1521 return osl(osl_rbtree_loop(audio_file_table, AFTCOL_HASH, private_data,
1525 static int find_hash_sister(unsigned char *hash, struct osl_row **result)
1527 int ret = aft_get_row_of_hash(hash, result);
1529 if (ret == -OSL_ERRNO_TO_PARA_ERROR(E_OSL_RB_KEY_NOT_FOUND))
1534 static int find_path_brother(const char *path, struct osl_row **result)
1536 int ret = aft_get_row_of_path(path, result);
1538 if (ret == -OSL_ERRNO_TO_PARA_ERROR(E_OSL_RB_KEY_NOT_FOUND))
1543 /** The format of the data stored by save_audio_file_data(). */
1544 enum com_add_buffer_offsets {
1545 /* afhi (if present) starts at this offset. */
1546 CAB_AFHI_OFFSET_POS = 0,
1547 /** Start of the chunk table (if present). */
1548 CAB_CHUNKS_OFFSET_POS = 4,
1549 /** Flags given to the add command. */
1550 CAB_FLAGS_OFFSET = 8,
1551 /** Audio format id. */
1552 CAB_AUDIO_FORMAT_ID_OFFSET = 12,
1553 /** The hash of the audio file being added. */
1554 CAB_HASH_OFFSET = 13,
1555 /** Start of the path of the audio file. */
1556 CAB_PATH_OFFSET = (CAB_HASH_OFFSET + HASH_SIZE),
1560 * Store the given data to a single buffer. Doesn't need the audio file selector
1561 * info struct as the server knows it as well.
1563 * It's OK to call this with afhi == NULL. In this case, the audio format
1564 * handler info won't be stored in the buffer.
1566 static void save_add_callback_buffer(unsigned char *hash, const char *path,
1567 struct afh_info *afhi, uint32_t flags,
1568 uint8_t audio_format_num, struct osl_object *obj)
1570 size_t path_len = strlen(path) + 1;
1571 size_t afhi_size = sizeof_afhi_buf(afhi);
1572 size_t size = CAB_PATH_OFFSET + path_len + afhi_size
1573 + sizeof_chunk_table(afhi);
1574 char *buf = para_malloc(size);
1577 pos = CAB_PATH_OFFSET + path_len;
1578 write_u32(buf + CAB_AFHI_OFFSET_POS, pos);
1579 save_afhi(afhi, buf + pos);
1582 write_u32(buf + CAB_CHUNKS_OFFSET_POS, pos);
1584 save_chunk_table(afhi, buf + pos);
1586 write_u32(buf + CAB_FLAGS_OFFSET, flags);
1587 write_u8(buf + CAB_AUDIO_FORMAT_ID_OFFSET, audio_format_num);
1589 memcpy(buf + CAB_HASH_OFFSET, hash, HASH_SIZE);
1590 strcpy(buf + CAB_PATH_OFFSET, path);
1598 Overview of the add command.
1600 Input: What was passed to the callback by the command handler.
1602 HS: Hash sister. Whether an audio file with identical hash
1603 already exists in the osl database.
1605 PB: Path brother. Whether a file with the given path exists
1608 F: Force flag given. Whether add was called with -f.
1610 output: Action performed by the callback.
1612 AFHI: Whether afhi and chunk table are computed and sent.
1613 ACTION: Table modifications to be done by the callback.
1615 +----+----+---+------+---------------------------------------------------+
1616 | HS | PB | F | AFHI | ACTION
1617 +----+----+---+------+---------------------------------------------------+
1618 | Y | Y | Y | Y | if HS != PB: remove PB. HS: force afhi update,
1619 | | update path, keep afsi
1620 +----+----+---+------+---------------------------------------------------+
1621 | Y | Y | N | N | if HS == PB: do not send callback request at all.
1622 | | otherwise: remove PB, HS: update path, keep afhi,
1624 +----+----+---+------+---------------------------------------------------+
1625 | Y | N | Y | Y | (rename) force afhi update of HS, update path of
1627 +----+----+---+------+---------------------------------------------------+
1628 | Y | N | N | N | (file rename) update path of HS, keep afsi, afhi
1629 +----+----+---+------+---------------------------------------------------+
1630 | N | Y | Y | Y | (file change) update afhi, hash, of PB, keep afsi
1631 | | (force has no effect)
1632 +----+----+---+------+---------------------------------------------------+
1633 | N | Y | N | Y | (file change) update afhi, hash of PB, keep afsi
1634 +----+----+---+------+---------------------------------------------------+
1635 | N | N | Y | Y | (new file) create new entry (force has no effect)
1636 +----+----+---+------+---------------------------------------------------+
1637 | N | N | N | Y | (new file) create new entry
1638 +----+----+---+------+---------------------------------------------------+
1642 afhi <=> force or no HS
1647 /** Flags passed to the add command. */
1648 enum com_add_flags {
1649 /** Skip paths that exist already. */
1651 /** Force adding. */
1653 /** Print what is being done. */
1654 ADD_FLAG_VERBOSE = 4,
1655 /** Try to add files with unknown suffixes. */
1659 static int com_add_callback(struct afs_callback_arg *aca)
1661 char *buf = aca->query.data, *path;
1662 struct osl_row *pb, *aft_row;
1664 struct osl_object objs[NUM_AFT_COLUMNS];
1665 unsigned char *hash;
1666 char asc[2 * HASH_SIZE + 1];
1668 char afsi_buf[AFSI_SIZE];
1669 uint32_t flags = read_u32(buf + CAB_FLAGS_OFFSET);
1670 struct afs_info default_afsi = {.last_played = 0};
1671 uint16_t afhi_offset, chunks_offset;
1673 hash = (unsigned char *)buf + CAB_HASH_OFFSET;
1674 hash_to_asc(hash, asc);
1675 objs[AFTCOL_HASH].data = buf + CAB_HASH_OFFSET;
1676 objs[AFTCOL_HASH].size = HASH_SIZE;
1678 path = buf + CAB_PATH_OFFSET;
1679 objs[AFTCOL_PATH].data = path;
1680 objs[AFTCOL_PATH].size = strlen(path) + 1;
1682 PARA_INFO_LOG("request to add %s\n", path);
1683 ret = find_hash_sister(hash, &hs);
1686 ret = find_path_brother(path, &pb);
1689 if (hs && pb && hs == pb && !(flags & ADD_FLAG_FORCE)) {
1690 if (flags & ADD_FLAG_VERBOSE)
1691 para_printf(&aca->pbout, "ignoring duplicate\n");
1695 if (hs && hs != pb) {
1696 struct osl_object obj;
1697 if (pb) { /* hs trumps pb, remove pb */
1698 if (flags & ADD_FLAG_VERBOSE)
1699 para_printf(&aca->pbout, "removing %s\n", path);
1700 ret = afs_event(AUDIO_FILE_REMOVE, &aca->pbout, pb);
1703 ret = osl(osl_del_row(audio_file_table, pb));
1708 /* file rename, update hs' path */
1709 if (flags & ADD_FLAG_VERBOSE) {
1710 ret = osl(osl_get_object(audio_file_table, hs,
1711 AFTCOL_PATH, &obj));
1714 para_printf(&aca->pbout, "renamed from %s\n",
1717 ret = osl(osl_update_object(audio_file_table, hs, AFTCOL_PATH,
1718 &objs[AFTCOL_PATH]));
1721 ret = afs_event(AUDIO_FILE_RENAME, &aca->pbout, hs);
1724 if (!(flags & ADD_FLAG_FORCE))
1727 /* no hs or force mode, child must have sent afhi */
1728 afhi_offset = read_u32(buf + CAB_AFHI_OFFSET_POS);
1729 chunks_offset = read_u32(buf + CAB_CHUNKS_OFFSET_POS);
1731 objs[AFTCOL_AFHI].data = buf + afhi_offset;
1732 objs[AFTCOL_AFHI].size = chunks_offset - afhi_offset;
1734 if (!objs[AFTCOL_AFHI].size) /* "impossible" */
1736 objs[AFTCOL_CHUNKS].data = buf + chunks_offset;
1737 objs[AFTCOL_CHUNKS].size = aca->query.size - chunks_offset;
1738 if (pb && !hs) { /* update pb's hash */
1739 char old_asc[2 * HASH_SIZE + 1];
1740 unsigned char *old_hash;
1741 ret = get_hash_of_row(pb, &old_hash);
1744 hash_to_asc(old_hash, old_asc);
1745 if (flags & ADD_FLAG_VERBOSE)
1746 para_printf(&aca->pbout, "file change: %s -> %s\n",
1748 ret = osl_update_object(audio_file_table, pb, AFTCOL_HASH,
1749 &objs[AFTCOL_HASH]);
1753 if (hs || pb) { /* (hs != NULL and pb != NULL) implies hs == pb */
1754 struct osl_row *row = pb? pb : hs;
1755 /* update afhi and chunk_table */
1756 if (flags & ADD_FLAG_VERBOSE)
1757 para_printf(&aca->pbout,
1758 "updating afhi and chunk table\n");
1759 ret = osl(osl_update_object(audio_file_table, row, AFTCOL_AFHI,
1760 &objs[AFTCOL_AFHI]));
1763 /* truncate the file to size zero if there is no chunk table */
1764 ret = osl(osl_update_object(audio_file_table, row, AFTCOL_CHUNKS,
1765 &objs[AFTCOL_CHUNKS]));
1768 ret = afs_event(AFHI_CHANGE, &aca->pbout, row);
1773 /* new entry, use default afsi */
1774 if (flags & ADD_FLAG_VERBOSE)
1775 para_printf(&aca->pbout, "new file\n");
1776 default_afsi.last_played = time(NULL) - 365 * 24 * 60 * 60;
1777 default_afsi.audio_format_id = read_u8(buf + CAB_AUDIO_FORMAT_ID_OFFSET);
1779 objs[AFTCOL_AFSI].data = &afsi_buf;
1780 objs[AFTCOL_AFSI].size = AFSI_SIZE;
1781 save_afsi(&default_afsi, &objs[AFTCOL_AFSI]);
1782 ret = osl(osl_add_and_get_row(audio_file_table, objs, &aft_row));
1785 ret = afs_event(AUDIO_FILE_ADD, &aca->pbout, aft_row);
1788 para_printf(&aca->pbout, "could not add %s\n", path);
1792 /** Used by com_add(). */
1793 struct private_add_data {
1794 /** The pointer passed to the original command handler. */
1795 struct command_context *cc;
1796 /** The given add flags. */
1800 static int path_brother_callback(struct afs_callback_arg *aca)
1802 char *path = aca->query.data;
1803 struct osl_row *path_brother;
1804 int ret = find_path_brother(path, &path_brother);
1807 return pass_buffer_as_shm(aca->fd, SBD_OUTPUT, (char *)&path_brother,
1808 sizeof(path_brother));
1811 static int hash_sister_callback(struct afs_callback_arg *aca)
1813 unsigned char *hash = aca->query.data;
1814 struct osl_row *hash_sister;
1815 int ret = find_hash_sister(hash, &hash_sister);
1819 return pass_buffer_as_shm(aca->fd, SBD_OUTPUT, (char *)&hash_sister,
1820 sizeof(hash_sister));
1823 static int get_row_pointer_from_result(struct osl_object *result,
1824 __a_unused uint8_t band, void *private)
1826 struct osl_row **row = private;
1828 if (band == SBD_OUTPUT)
1829 *row = *(struct osl_row **)(result->data);
1833 static int add_one_audio_file(const char *path, void *private_data)
1835 int ret, send_ret = 1, fd;
1836 uint8_t format_num = -1;
1837 struct private_add_data *pad = private_data;
1838 struct afh_info afhi, *afhi_ptr = NULL;
1839 struct osl_row *pb = NULL, *hs = NULL; /* path brother/hash sister */
1840 struct osl_object map, obj = {.data = NULL}, query;
1841 unsigned char hash[HASH_SIZE];
1843 ret = guess_audio_format(path);
1844 if (ret < 0 && !(pad->flags & ADD_FLAG_ALL)) {
1848 query.data = (char *)path;
1849 query.size = strlen(path) + 1;
1850 ret = send_callback_request(path_brother_callback, &query,
1851 get_row_pointer_from_result, &pb);
1852 if (ret < 0 && ret != -OSL_ERRNO_TO_PARA_ERROR(E_OSL_RB_KEY_NOT_FOUND))
1855 if (pb && (pad->flags & ADD_FLAG_LAZY)) { /* lazy is really cheap */
1856 if (pad->flags & ADD_FLAG_VERBOSE)
1857 send_ret = send_sb_va(&pad->cc->scc, SBD_OUTPUT,
1858 "lazy-ignore: %s\n", path);
1861 /* We still want to add this file. Compute its hash. */
1862 ret = mmap_full_file(path, O_RDONLY, &map.data, &map.size, &fd);
1865 hash_function(map.data, map.size, hash);
1867 /* Check whether the database contains a file with the same hash. */
1869 query.size = HASH_SIZE;
1870 ret = send_callback_request(hash_sister_callback, &query,
1871 get_row_pointer_from_result, &hs);
1874 /* Return success if we already know this file. */
1876 if (pb && hs && hs == pb && !(pad->flags & ADD_FLAG_FORCE)) {
1877 if (pad->flags & ADD_FLAG_VERBOSE)
1878 send_ret = send_sb_va(&pad->cc->scc, SBD_OUTPUT,
1879 "%s exists, not forcing update\n", path);
1883 * We won't recalculate the audio format info and the chunk table if
1884 * there is a hash sister and FORCE was not given.
1886 if (!hs || (pad->flags & ADD_FLAG_FORCE)) {
1887 ret = compute_afhi(path, map.data, map.size, fd, &afhi);
1893 munmap(map.data, map.size);
1895 if (pad->flags & ADD_FLAG_VERBOSE) {
1896 send_ret = send_sb_va(&pad->cc->scc, SBD_OUTPUT,
1897 "adding %s\n", path);
1901 save_add_callback_buffer(hash, path, afhi_ptr, pad->flags, format_num, &obj);
1902 /* Ask afs to consider this entry for adding. */
1903 ret = send_callback_request(com_add_callback, &obj,
1904 afs_cb_result_handler, pad->cc);
1909 munmap(map.data, map.size);
1911 if (ret < 0 && send_ret >= 0)
1912 send_ret = send_sb_va(&pad->cc->scc, SBD_ERROR_LOG,
1913 "failed to add %s (%s)\n", path, para_strerror(-ret));
1915 clear_afhi(afhi_ptr);
1916 /* Stop adding files only on send errors. */
1920 int com_add(struct command_context *cc)
1923 struct private_add_data pad = {.cc = cc, .flags = 0};
1925 for (i = 1; i < cc->argc; i++) {
1926 const char *arg = cc->argv[i];
1929 if (!strcmp(arg, "--")) {
1933 if (!strcmp(arg, "-a")) {
1934 pad.flags |= ADD_FLAG_ALL;
1937 if (!strcmp(arg, "-l")) {
1938 pad.flags |= ADD_FLAG_LAZY;
1941 if (!strcmp(arg, "-f")) {
1942 pad.flags |= ADD_FLAG_FORCE;
1945 if (!strcmp(arg, "-v")) {
1946 pad.flags |= ADD_FLAG_VERBOSE;
1951 return -E_AFT_SYNTAX;
1952 for (; i < cc->argc; i++) {
1954 ret = verify_path(cc->argv[i], &path);
1956 ret = send_sb_va(&cc->scc, SBD_ERROR_LOG, "%s: %s\n",
1957 cc->argv[i], para_strerror(-ret));
1962 if (ret == 1) /* directory */
1963 ret = for_each_file_in_dir(path, add_one_audio_file,
1965 else /* regular file */
1966 ret = add_one_audio_file(path, &pad);
1968 send_sb_va(&cc->scc, SBD_OUTPUT, "%s: %s\n", path,
1969 para_strerror(-ret));
1979 * Flags used by the touch command.
1984 /** Whether the \p FNM_PATHNAME flag should be passed to fnmatch(). */
1985 TOUCH_FLAG_FNM_PATHNAME = 1,
1986 /** Activates verbose mode. */
1987 TOUCH_FLAG_VERBOSE = 2
1990 /** Options used by com_touch(). */
1991 struct com_touch_options {
1992 /** New num_played value. */
1994 /** New last played count. */
1995 int64_t last_played;
1996 /** New lyrics id. */
1998 /** New image id. */
2000 /** New amplification value. */
2002 /** Command line flags (see \ref touch_flags). */
2006 static int touch_audio_file(__a_unused struct osl_table *table,
2007 struct osl_row *row, const char *name, void *data)
2009 struct afs_callback_arg *aca = data;
2010 struct com_touch_options *cto = aca->query.data;
2011 struct osl_object obj;
2012 struct afs_info old_afsi, new_afsi;
2013 int ret, no_options = cto->num_played < 0 && cto->last_played < 0 &&
2014 cto->lyrics_id < 0 && cto->image_id < 0 && cto->amp < 0;
2015 struct afsi_change_event_data aced;
2017 ret = get_afsi_object_of_row(row, &obj);
2019 para_printf(&aca->pbout, "cannot touch %s\n", name);
2022 ret = load_afsi(&old_afsi, &obj);
2024 para_printf(&aca->pbout, "cannot touch %s\n", name);
2027 new_afsi = old_afsi;
2029 new_afsi.num_played++;
2030 new_afsi.last_played = time(NULL);
2031 if (cto->flags & TOUCH_FLAG_VERBOSE)
2032 para_printf(&aca->pbout, "%s: num_played = %u, "
2033 "last_played = now()\n", name,
2034 new_afsi.num_played);
2036 if (cto->flags & TOUCH_FLAG_VERBOSE)
2037 para_printf(&aca->pbout, "touching %s\n", name);
2038 if (cto->lyrics_id >= 0)
2039 new_afsi.lyrics_id = cto->lyrics_id;
2040 if (cto->image_id >= 0)
2041 new_afsi.image_id = cto->image_id;
2042 if (cto->num_played >= 0)
2043 new_afsi.num_played = cto->num_played;
2044 if (cto->last_played >= 0)
2045 new_afsi.last_played = cto->last_played;
2047 new_afsi.amp = cto->amp;
2049 save_afsi(&new_afsi, &obj); /* in-place update */
2051 aced.old_afsi = &old_afsi;
2052 return afs_event(AFSI_CHANGE, &aca->pbout, &aced);
2055 static int com_touch_callback(struct afs_callback_arg *aca)
2058 struct com_touch_options *cto = aca->query.data;
2059 struct pattern_match_data pmd = {
2060 .table = audio_file_table,
2061 .loop_col_num = AFTCOL_HASH,
2062 .match_col_num = AFTCOL_PATH,
2064 .data = (char *)aca->query.data
2065 + sizeof(struct com_touch_options),
2066 .size = aca->query.size
2067 - sizeof(struct com_touch_options)
2070 .action = touch_audio_file
2072 if (cto->image_id >= 0) {
2073 ret = img_get_name_by_id(cto->image_id, NULL);
2075 para_printf(&aca->pbout, "invalid image ID: %d\n",
2080 if (cto->lyrics_id >= 0) {
2081 ret = lyr_get_name_by_id(cto->lyrics_id, NULL);
2083 para_printf(&aca->pbout, "invalid lyrics ID: %d\n",
2088 if (cto->flags & TOUCH_FLAG_FNM_PATHNAME)
2089 pmd.fnmatch_flags |= FNM_PATHNAME;
2090 ret = for_each_matching_row(&pmd);
2091 if (ret >= 0 && pmd.num_matches == 0)
2096 int com_touch(struct command_context *cc)
2098 struct com_touch_options cto = {
2105 struct osl_object query = {.data = &cto, .size = sizeof(cto)};
2109 for (i = 1; i < cc->argc; i++) {
2110 const char *arg = cc->argv[i];
2113 if (!strcmp(arg, "--")) {
2117 if (!strncmp(arg, "-n=", 3)) {
2118 ret = para_atoi32(arg + 3, &cto.num_played);
2123 if (!strncmp(arg, "-l=", 3)) {
2124 ret = para_atoi64(arg + 3, &cto.last_played);
2129 if (!strncmp(arg, "-y=", 3)) {
2130 ret = para_atoi32(arg + 3, &cto.lyrics_id);
2135 if (!strncmp(arg, "-i=", 3)) {
2136 ret = para_atoi32(arg + 3, &cto.image_id);
2141 if (!strncmp(arg, "-a=", 3)) {
2143 ret = para_atoi32(arg + 3, &val);
2146 if (val < 0 || val > 255)
2147 return -ERRNO_TO_PARA_ERROR(EINVAL);
2151 if (!strcmp(arg, "-p")) {
2152 cto.flags |= TOUCH_FLAG_FNM_PATHNAME;
2155 if (!strcmp(arg, "-v")) {
2156 cto.flags |= TOUCH_FLAG_VERBOSE;
2159 break; /* non-option starting with dash */
2162 return -E_AFT_SYNTAX;
2163 return send_option_arg_callback_request(&query, cc->argc - i,
2164 cc->argv + i, com_touch_callback, afs_cb_result_handler, cc);
2167 /** Flags for com_rm(). */
2170 RM_FLAG_VERBOSE = 1,
2174 RM_FLAG_FNM_PATHNAME = 4
2177 static int remove_audio_file(__a_unused struct osl_table *table,
2178 struct osl_row *row, const char *name, void *data)
2180 struct afs_callback_arg *aca = data;
2181 uint32_t flags =*(uint32_t *)aca->query.data;
2184 if (flags & RM_FLAG_VERBOSE)
2185 para_printf(&aca->pbout, "removing %s\n", name);
2186 ret = afs_event(AUDIO_FILE_REMOVE, &aca->pbout, row);
2189 ret = osl(osl_del_row(audio_file_table, row));
2191 para_printf(&aca->pbout, "cannot remove %s\n", name);
2195 static int com_rm_callback(struct afs_callback_arg *aca)
2198 uint32_t flags = *(uint32_t *)aca->query.data;
2199 struct pattern_match_data pmd = {
2200 .table = audio_file_table,
2201 .loop_col_num = AFTCOL_HASH,
2202 .match_col_num = AFTCOL_PATH,
2203 .patterns = {.data = (char *)aca->query.data + sizeof(uint32_t),
2204 .size = aca->query.size - sizeof(uint32_t)},
2206 .action = remove_audio_file
2208 if (flags & RM_FLAG_FNM_PATHNAME)
2209 pmd.fnmatch_flags |= FNM_PATHNAME;
2210 ret = for_each_matching_row(&pmd);
2213 if (pmd.num_matches == 0) {
2214 if (!(flags & RM_FLAG_FORCE))
2216 } else if (flags & RM_FLAG_VERBOSE)
2217 para_printf(&aca->pbout, "removed %u file(s)\n",
2223 /* TODO options: -r (recursive) */
2224 int com_rm(struct command_context *cc)
2227 struct osl_object query = {.data = &flags, .size = sizeof(flags)};
2230 for (i = 1; i < cc->argc; i++) {
2231 const char *arg = cc->argv[i];
2234 if (!strcmp(arg, "--")) {
2238 if (!strcmp(arg, "-f")) {
2239 flags |= RM_FLAG_FORCE;
2242 if (!strcmp(arg, "-p")) {
2243 flags |= RM_FLAG_FNM_PATHNAME;
2246 if (!strcmp(arg, "-v")) {
2247 flags |= RM_FLAG_VERBOSE;
2253 return -E_AFT_SYNTAX;
2254 return send_option_arg_callback_request(&query, cc->argc - i,
2255 cc->argv + i, com_rm_callback, afs_cb_result_handler, cc);
2259 * Flags used by the cpsi command.
2264 /** Whether the lyrics id should be copied. */
2265 CPSI_FLAG_COPY_LYRICS_ID = 1,
2266 /** Whether the image id should be copied. */
2267 CPSI_FLAG_COPY_IMAGE_ID = 2,
2268 /** Whether the lastplayed time should be copied. */
2269 CPSI_FLAG_COPY_LASTPLAYED = 4,
2270 /** Whether the numplayed count should be copied. */
2271 CPSI_FLAG_COPY_NUMPLAYED = 8,
2272 /** Whether the attributes should be copied. */
2273 CPSI_FLAG_COPY_ATTRIBUTES = 16,
2274 /** Activates verbose mode. */
2275 CPSI_FLAG_VERBOSE = 32,
2278 /** Data passed to the action handler of com_cpsi(). */
2279 struct cpsi_action_data {
2280 /** command line flags (see \ref cpsi_flags). */
2282 /** Values are copied from here. */
2283 struct afs_info source_afsi;
2284 /** What was passed to com_cpsi_callback(). */
2285 struct afs_callback_arg *aca;
2288 static int copy_selector_info(__a_unused struct osl_table *table,
2289 struct osl_row *row, const char *name, void *data)
2291 struct cpsi_action_data *cad = data;
2292 struct osl_object target_afsi_obj;
2294 struct afs_info old_afsi, target_afsi;
2295 struct afsi_change_event_data aced;
2297 ret = get_afsi_object_of_row(row, &target_afsi_obj);
2300 load_afsi(&target_afsi, &target_afsi_obj);
2301 old_afsi = target_afsi;
2302 if (cad->flags & CPSI_FLAG_COPY_LYRICS_ID)
2303 target_afsi.lyrics_id = cad->source_afsi.lyrics_id;
2304 if (cad->flags & CPSI_FLAG_COPY_IMAGE_ID)
2305 target_afsi.image_id = cad->source_afsi.image_id;
2306 if (cad->flags & CPSI_FLAG_COPY_LASTPLAYED)
2307 target_afsi.last_played = cad->source_afsi.last_played;
2308 if (cad->flags & CPSI_FLAG_COPY_NUMPLAYED)
2309 target_afsi.num_played = cad->source_afsi.num_played;
2310 if (cad->flags & CPSI_FLAG_COPY_ATTRIBUTES)
2311 target_afsi.attributes = cad->source_afsi.attributes;
2312 save_afsi(&target_afsi, &target_afsi_obj); /* in-place update */
2313 if (cad->flags & CPSI_FLAG_VERBOSE)
2314 para_printf(&cad->aca->pbout, "copied afsi to %s\n", name);
2316 aced.old_afsi = &old_afsi;
2317 return afs_event(AFSI_CHANGE, &cad->aca->pbout, &aced);
2320 static int com_cpsi_callback(struct afs_callback_arg *aca)
2322 struct cpsi_action_data cad = {
2323 .flags = *(unsigned *)aca->query.data,
2327 char *source_path = (char *)aca->query.data + sizeof(cad.flags);
2328 struct pattern_match_data pmd = {
2329 .table = audio_file_table,
2330 .loop_col_num = AFTCOL_HASH,
2331 .match_col_num = AFTCOL_PATH,
2332 .patterns = {.data = source_path + strlen(source_path) + 1,
2333 .size = aca->query.size - sizeof(cad.flags)
2334 - strlen(source_path) - 1},
2336 .action = copy_selector_info
2339 ret = get_afsi_of_path(source_path, &cad.source_afsi);
2342 ret = for_each_matching_row(&pmd);
2345 if (pmd.num_matches > 0) {
2346 if (cad.flags & CPSI_FLAG_VERBOSE)
2347 para_printf(&aca->pbout, "updated afsi of %u file(s)\n",
2355 int com_cpsi(struct command_context *cc)
2359 struct osl_object options = {.data = &flags, .size = sizeof(flags)};
2361 for (i = 1; i < cc->argc; i++) {
2362 const char *arg = cc->argv[i];
2365 if (!strcmp(arg, "--")) {
2369 if (!strcmp(arg, "-y")) {
2370 flags |= CPSI_FLAG_COPY_LYRICS_ID;
2373 if (!strcmp(arg, "-i")) {
2374 flags |= CPSI_FLAG_COPY_IMAGE_ID;
2377 if (!strcmp(arg, "-l")) {
2378 flags |= CPSI_FLAG_COPY_LASTPLAYED;
2381 if (!strcmp(arg, "-n")) {
2382 flags |= CPSI_FLAG_COPY_NUMPLAYED;
2385 if (!strcmp(arg, "-a")) {
2386 flags |= CPSI_FLAG_COPY_ATTRIBUTES;
2389 if (!strcmp(arg, "-v")) {
2390 flags |= CPSI_FLAG_VERBOSE;
2395 if (i + 1 >= cc->argc) /* need at least source file and pattern */
2396 return -E_AFT_SYNTAX;
2397 if (!(flags & ~CPSI_FLAG_VERBOSE)) /* no copy flags given */
2398 flags = ~(unsigned)CPSI_FLAG_VERBOSE | flags;
2399 return send_option_arg_callback_request(&options, cc->argc - i,
2400 cc->argv + i, com_cpsi_callback, afs_cb_result_handler, cc);
2403 struct change_atts_data {
2404 uint64_t add_mask, del_mask;
2405 struct afs_callback_arg *aca;
2408 static int change_atts(__a_unused struct osl_table *table,
2409 struct osl_row *row, __a_unused const char *name, void *data)
2412 struct osl_object obj;
2413 struct afs_info old_afsi, new_afsi;
2414 struct afsi_change_event_data aced = {
2416 .old_afsi = &old_afsi
2418 struct change_atts_data *cad = data;
2420 ret = get_afsi_object_of_row(row, &obj);
2423 ret = load_afsi(&old_afsi, &obj);
2426 new_afsi = old_afsi;
2427 new_afsi.attributes |= cad->add_mask;
2428 new_afsi.attributes &= ~cad->del_mask;
2429 save_afsi(&new_afsi, &obj); /* in-place update */
2430 return afs_event(AFSI_CHANGE, &cad->aca->pbout, &aced);
2433 static int com_setatt_callback(struct afs_callback_arg *aca)
2438 struct change_atts_data cad = {.aca = aca};
2439 struct pattern_match_data pmd = {
2440 .table = audio_file_table,
2441 .loop_col_num = AFTCOL_HASH,
2442 .match_col_num = AFTCOL_PATH,
2443 .pm_flags = PM_SKIP_EMPTY_NAME,
2445 .action = change_atts
2449 p = aca->query.data;
2450 p < (char *)aca->query.data + aca->query.size;
2454 unsigned char bitnum;
2458 ret = -E_ATTR_SYNTAX;
2462 if (c != '+' && c != '-')
2465 ret = get_attribute_bitnum_by_name(p, &bitnum);
2467 para_printf(&aca->pbout, "attribute not found: %s\n", p);
2471 cad.add_mask |= (one << bitnum);
2473 cad.del_mask |= (one << bitnum);
2475 ret = -E_ATTR_SYNTAX;
2476 if (!cad.add_mask && !cad.del_mask)
2478 pmd.patterns.data = p;
2479 if (p >= (char *)aca->query.data + aca->query.size)
2481 pmd.patterns.size = (char *)aca->query.data + aca->query.size - p;
2482 ret = for_each_matching_row(&pmd);
2485 if (pmd.num_matches == 0)
2491 int com_setatt(struct command_context *cc)
2494 return -E_ATTR_SYNTAX;
2495 return send_standard_callback_request(cc->argc - 1, cc->argv + 1,
2496 com_setatt_callback, afs_cb_result_handler, cc);
2499 static int afs_stat_callback(struct afs_callback_arg *aca)
2501 int *parser_friendly = aca->query.data;
2502 char *buf = *parser_friendly?
2503 parser_friendly_status_items : status_items;
2507 return pass_buffer_as_shm(aca->fd, SBD_OUTPUT, buf, strlen(buf));
2511 * Get the current afs status items from the afs process and send it.
2513 * \param cc The command context, used e.g. for data encryption.
2514 * \param parser_friendly Whether parser-friendly output format should be used.
2516 * As the contents of the afs status items change in time and the command
2517 * handler only has a COW version created at fork time, it can not send
2518 * up-to-date afs status items directly. Therefore the usual callback mechanism
2519 * is used to pass the status items from the afs process to the command handler
2520 * via a shared memory area and a pipe.
2522 * \return The return value of the underlying call to \ref send_callback_request().
2524 int send_afs_status(struct command_context *cc, int parser_friendly)
2526 struct osl_object query = {.data = &parser_friendly,
2527 .size = sizeof(parser_friendly)};
2529 return send_callback_request(afs_stat_callback, &query,
2530 afs_cb_result_handler, cc);
2533 /* returns success on non-fatal errors to keep the loop going */
2534 static int check_audio_file(struct osl_row *row, void *data)
2537 struct para_buffer *pb = data;
2538 struct stat statbuf;
2539 int ret = get_audio_file_path_of_row(row, &path);
2540 struct afs_info afsi;
2544 para_printf(pb, "%s\n", para_strerror(-ret));
2547 if (stat(path, &statbuf) < 0)
2548 para_printf(pb, "%s: stat error (%s)\n", path, strerror(errno));
2549 else if (!S_ISREG(statbuf.st_mode))
2550 para_printf(pb, "%s: not a regular file\n", path);
2551 ret = get_afsi_of_row(row, &afsi);
2553 para_printf(pb, "%s: %s\n", path, para_strerror(-ret));
2556 ret = lyr_get_name_by_id(afsi.lyrics_id, &blob_name);
2558 para_printf(pb, "%s lyrics id %u: %s\n", path, afsi.lyrics_id,
2559 para_strerror(-ret));
2560 ret = img_get_name_by_id(afsi.image_id, &blob_name);
2562 para_printf(pb, "%s image id %u: %s\n", path, afsi.image_id,
2563 para_strerror(-ret));
2568 * Check the audio file table for inconsistencies.
2570 * \param aca Only ->pbout is used for diagnostics.
2572 * \return Standard. Inconsistencies are reported but not regarded as an error.
2576 int aft_check_callback(struct afs_callback_arg *aca)
2578 para_printf(&aca->pbout, "checking audio file table...\n");
2579 return audio_file_loop(&aca->pbout, check_audio_file);
2582 struct aft_check_atts_data {
2584 struct para_buffer *pb;
2587 static int check_atts_of_audio_file(struct osl_row *row, void *data)
2589 struct aft_check_atts_data *acad = data;
2591 struct afs_info afsi;
2595 ret = get_afsi_of_row(row, &afsi);
2597 para_printf(acad->pb, "cannot get afsi\n");
2600 bad_bits = afsi.attributes & ~acad->att_mask;
2601 if (bad_bits == 0) /* OK */
2603 ret = get_audio_file_path_of_row(row, &path);
2605 para_printf(acad->pb, "cannot get path\n");
2608 para_printf(acad->pb, "invalid attribute bits (%" PRIu64 "): %s\n",
2610 /* return success to keep looping */
2615 * Iterate over all audio files and check the attribute bit mask.
2617 * \param att_mask The mask of all valid attributes.
2618 * \param pb Used for reporting inconsistencies.
2620 * This reads the attribute bit mask of each audio file from the afs info
2621 * structure stored in the audio file table and verifies that all set bits are
2622 * also turned on in \a att_mask, i.e., correspond to an attribute of the
2623 * attribute table. Audio files for which this is not the case are reported via
2626 * \return Standard. Inconsistencies are not regarded as errors.
2628 * \sa \ref attribute_check_callback().
2630 int aft_check_attributes(uint64_t att_mask, struct para_buffer *pb)
2632 struct aft_check_atts_data acad = {.att_mask = att_mask, .pb = pb};
2634 para_printf(pb, "checking attributes, mask: %" PRIx64 "\n", att_mask);
2635 return audio_file_loop(&acad, check_atts_of_audio_file);
2639 * Close the audio file table.
2641 * \param flags Usual flags that are passed to osl_close_table().
2643 * \sa osl_close_table().
2645 static void aft_close(void)
2647 osl_close_table(audio_file_table, OSL_MARK_CLEAN);
2648 audio_file_table = NULL;
2652 * Open the audio file table.
2654 * \param dir The database directory.
2658 * \sa osl_open_table().
2660 static int aft_open(const char *dir)
2664 audio_file_table_desc.dir = dir;
2665 ret = osl(osl_open_table(&audio_file_table_desc, &audio_file_table));
2668 osl_get_num_rows(audio_file_table, &num);
2669 PARA_INFO_LOG("audio file table contains %u files\n", num);
2672 PARA_NOTICE_LOG("failed to open audio file table\n");
2673 audio_file_table = NULL;
2674 if (ret == -OSL_ERRNO_TO_PARA_ERROR(E_OSL_NOENT))
2679 static int aft_create(const char *dir)
2681 audio_file_table_desc.dir = dir;
2682 return osl(osl_create_table(&audio_file_table_desc));
2685 static int clear_attribute(struct osl_row *row, void *data)
2687 struct rmatt_event_data *red = data;
2688 struct afs_info afsi;
2689 struct osl_object obj;
2690 int ret = get_afsi_object_of_row(row, &obj);
2691 uint64_t mask = ~(1ULL << red->bitnum);
2695 ret = load_afsi(&afsi, &obj);
2698 afsi.attributes &= mask;
2699 save_afsi(&afsi, &obj);
2703 static int aft_event_handler(enum afs_events event, struct para_buffer *pb,
2709 case ATTRIBUTE_REMOVE: {
2710 const struct rmatt_event_data *red = data;
2711 para_printf(pb, "clearing attribute %s (bit %u) from all "
2712 "entries in the audio file table\n", red->name,
2714 return audio_file_loop(data, clear_attribute);
2715 } case AFSI_CHANGE: {
2716 struct afsi_change_event_data *aced = data;
2717 uint64_t old_last_played = status_item_ls_data.afsi.last_played;
2718 if (aced->aft_row != current_aft_row)
2720 ret = get_afsi_of_row(aced->aft_row, &status_item_ls_data.afsi);
2723 status_item_ls_data.afsi.last_played = old_last_played;
2724 make_status_items();
2726 } case AFHI_CHANGE: {
2727 if (data != current_aft_row)
2729 ret = get_afhi_of_row(data, &status_item_ls_data.afhi);
2732 make_status_items();
2740 * Initialize the audio file table.
2742 * \param t Pointer to the structure to be initialized.
2744 void aft_init(struct afs_table *t)
2747 t->close = aft_close;
2748 t->create = aft_create;
2749 t->event_handler = aft_event_handler;