2 * Copyright (C) 2007 Andre Noll <maan@tuebingen.mpg.de>
4 * Licensed under the GPL v2. For licencing details see COPYING.
7 /** \file aft.c Audio file table functions. */
23 #include "portable_io.h"
27 static struct osl_table *audio_file_table;
28 static char *status_items;
29 static char *parser_friendly_status_items;
31 /** The different sorting methods of the ls command. */
32 enum ls_sorting_method {
38 LS_SORT_BY_LAST_PLAYED,
40 LS_SORT_BY_NUM_PLAYED,
54 LS_SORT_BY_AUDIO_FORMAT,
59 /** The different listing modes of the ls command. */
60 enum ls_listing_mode {
61 /** Default listing mode. */
75 /* Data about one audio file. Needed for ls and stat output. */
77 /* Usual audio format handler information. */
79 /* Audio file selector information. */
81 /* The full path of the audio file. */
83 /* The score value (if -a was given). */
85 /* The hash value of the audio file data. */
89 /** The flags accepted by the ls command. */
92 LS_FLAG_FULL_PATH = 1,
94 LS_FLAG_ADMISSIBLE_ONLY = 2,
102 * The size of the individual output fields of the ls command.
104 * These depend on the content being listed. For example, if each listed file
105 * is shorter than an hour, the duration format is set to mm:ss. Otherwise it
106 * is set to hh:mm:ss.
109 /** size of the score field. */
110 unsigned short score_width;
111 /** size of the image id field. */
112 unsigned short image_id_width;
113 /** size of the lyrics id field. */
114 unsigned short lyrics_id_width;
115 /** size of the bitrate field. */
116 unsigned short bitrate_width;
117 /** size of the frequency field. */
118 unsigned short frequency_width;
119 /** size of the duration field. */
120 unsigned short duration_width;
121 /** size of the num played field. */
122 unsigned short num_played_width;
123 /** size of the amp field. */
124 unsigned short amp_width;
125 /** size of the audio format field. */
126 unsigned short audio_format_width;
129 /** Data passed from the ls command handler to its callback function. */
131 /** The given command line flags. */
133 /** The sorting method given at the command line. */
134 enum ls_sorting_method sorting;
135 /** The given listing mode (short, long, verbose, mbox). */
136 enum ls_listing_mode mode;
137 /** The arguments passed to the ls command. */
139 /** Number of non-option arguments. */
141 /** Used for long listing mode to align the output fields. */
142 struct ls_widths widths;
143 /** Size of the \a data array. */
145 /** Number of used entries in the data array. */
146 uint32_t num_matching_paths;
147 /** Array of matching entries. */
148 struct ls_data *data;
149 /** Used to sort the array. */
150 struct ls_data **data_ptr;
154 * Describes the layout of the mmapped-afs info struct.
156 * \sa struct afs_info.
159 /** Where .last_played is stored. */
160 AFSI_LAST_PLAYED_OFFSET = 0,
161 /** Storage position of the attributes bitmap. */
162 AFSI_ATTRIBUTES_OFFSET = 8,
163 /** Storage position of the .num_played field. */
164 AFSI_NUM_PLAYED_OFFSET = 16,
165 /** Storage position of the .image_id field. */
166 AFSI_IMAGE_ID_OFFSET = 20,
167 /** Storage position of the .lyrics_id field. */
168 AFSI_LYRICS_ID_OFFSET = 24,
169 /** Storage position of the .audio_format_id field. */
170 AFSI_AUDIO_FORMAT_ID_OFFSET = 28,
171 /** Storage position of the amplification field. */
172 AFSI_AMP_OFFSET = 29,
173 /** 2 bytes reserved space for future usage. */
174 AFSI_AUDIO_FORMAT_UNUSED_OFFSET = 30,
175 /** On-disk storage space needed. */
180 * Convert a struct afs_info to an osl object.
182 * \param afsi Pointer to the audio file info to be converted.
183 * \param obj Result pointer.
187 static void save_afsi(struct afs_info *afsi, struct osl_object *obj)
189 char *buf = obj->data;
191 write_u64(buf + AFSI_LAST_PLAYED_OFFSET, afsi->last_played);
192 write_u64(buf + AFSI_ATTRIBUTES_OFFSET, afsi->attributes);
193 write_u32(buf + AFSI_NUM_PLAYED_OFFSET, afsi->num_played);
194 write_u32(buf + AFSI_IMAGE_ID_OFFSET, afsi->image_id);
195 write_u32(buf + AFSI_LYRICS_ID_OFFSET, afsi->lyrics_id);
196 write_u8(buf + AFSI_AUDIO_FORMAT_ID_OFFSET,
197 afsi->audio_format_id);
198 write_u8(buf + AFSI_AMP_OFFSET, afsi->amp);
199 memset(buf + AFSI_AUDIO_FORMAT_UNUSED_OFFSET, 0, 2);
203 * Get the audio file selector info struct stored in an osl object.
205 * \param afsi Points to the audio_file info structure to be filled in.
206 * \param obj The osl object holding the data.
212 static int load_afsi(struct afs_info *afsi, struct osl_object *obj)
214 char *buf = obj->data;
215 if (obj->size < AFSI_SIZE)
217 afsi->last_played = read_u64(buf + AFSI_LAST_PLAYED_OFFSET);
218 afsi->attributes = read_u64(buf + AFSI_ATTRIBUTES_OFFSET);
219 afsi->num_played = read_u32(buf + AFSI_NUM_PLAYED_OFFSET);
220 afsi->image_id = read_u32(buf + AFSI_IMAGE_ID_OFFSET);
221 afsi->lyrics_id = read_u32(buf + AFSI_LYRICS_ID_OFFSET);
222 afsi->audio_format_id = read_u8(buf +
223 AFSI_AUDIO_FORMAT_ID_OFFSET);
224 afsi->amp = read_u8(buf + AFSI_AMP_OFFSET);
228 /** The columns of the audio file table. */
229 enum audio_file_table_columns {
230 /** The hash on the content of the audio file. */
232 /** The full path in the filesystem. */
234 /** The audio file selector info. */
236 /** The audio format handler info. */
238 /** The chunk table info and the chunk table of the audio file. */
240 /** The number of columns of this table. */
245 * Compare two osl objects pointing to hash values.
247 * \param obj1 Pointer to the first hash object.
248 * \param obj2 Pointer to the second hash object.
250 * \return The values required for an osl compare function.
252 * \sa osl_compare_func, uint32_compare().
254 static int aft_hash_compare(const struct osl_object *obj1, const struct osl_object *obj2)
256 return hash_compare((unsigned char *)obj1->data, (unsigned char *)obj2->data);
259 static struct osl_column_description aft_cols[] = {
261 .storage_type = OSL_MAPPED_STORAGE,
262 .storage_flags = OSL_RBTREE | OSL_FIXED_SIZE | OSL_UNIQUE,
264 .compare_function = aft_hash_compare,
265 .data_size = HASH_SIZE
268 .storage_type = OSL_MAPPED_STORAGE,
269 .storage_flags = OSL_RBTREE | OSL_UNIQUE,
271 .compare_function = string_compare,
274 .storage_type = OSL_MAPPED_STORAGE,
275 .storage_flags = OSL_FIXED_SIZE,
277 .data_size = AFSI_SIZE
280 .storage_type = OSL_MAPPED_STORAGE,
284 .storage_type = OSL_DISK_STORAGE,
289 static struct osl_table_description audio_file_table_desc = {
290 .name = "audio_files",
291 .num_columns = NUM_AFT_COLUMNS,
292 .flags = OSL_LARGE_TABLE,
293 .column_descriptions = aft_cols
297 * Produce a canonicalized absolute pathname.
299 * Returns one if the resolved path a directory, zero if it is a regular file,
300 * negative on errors.
302 static int verify_path(const char *orig_path, char **resolved_path)
308 if (*orig_path != '/') /* we only accept absolute paths */
310 path = realpath(orig_path, NULL);
313 if (stat(path, &statbuf) < 0)
315 if (S_ISREG(statbuf.st_mode))
317 else if (S_ISDIR(statbuf.st_mode))
321 *resolved_path = path;
324 *resolved_path = NULL;
329 /** The on-disk layout of a afhi struct. */
331 /** Where the number of seconds is stored. */
332 AFHI_SECONDS_TOTAL_OFFSET = 0,
333 /** Position of the bitrate. */
334 AFHI_BITRATE_OFFSET = 4,
335 /** Position of the frequency. */
336 AFHI_FREQUENCY_OFFSET = 8,
337 /** Was: Location of the audio file header. */
338 AFHI_UNUSED1_OFFSET = 12,
339 /* Length of the audio file header. Zero means: No header. */
340 AFHI_HEADER_LEN_OFFSET = 16,
341 /** The total number of chunks (4 bytes). */
342 CHUNKS_TOTAL_OFFSET = 20,
343 /** The length of the audio file header (4 bytes). */
344 HEADER_LEN_OFFSET = 24,
345 /** Was: The start of the audio file header (4 bytes). */
346 AFHI_UNUSED2_OFFSET = 28,
347 /** The seconds part of the chunk time (4 bytes). */
348 CHUNK_TV_TV_SEC_OFFSET = 32,
349 /** The microseconds part of the chunk time (4 bytes). */
350 CHUNK_TV_TV_USEC_OFFSET = 36,
351 /** Number of channels is stored here. (1 byte) */
352 AFHI_CHANNELS_OFFSET = 40,
353 /** The tag info position. */
354 AFHI_INFO_STRING_OFFSET = 41,
355 /** Minimal on-disk size of a valid afhi struct. */
356 MIN_AFHI_SIZE = 47, /* at least 6 null bytes for techinfo/tags */
359 static unsigned sizeof_afhi_buf(const struct afh_info *afhi)
364 + strlen(afhi->techinfo)
365 + strlen(afhi->tags.artist)
366 + strlen(afhi->tags.title)
367 + strlen(afhi->tags.year)
368 + strlen(afhi->tags.album)
369 + strlen(afhi->tags.comment);
372 static void save_afhi(struct afh_info *afhi, char *buf)
378 write_u32(buf + AFHI_SECONDS_TOTAL_OFFSET, afhi->seconds_total);
379 write_u32(buf + AFHI_BITRATE_OFFSET, afhi->bitrate);
380 write_u32(buf + AFHI_FREQUENCY_OFFSET, afhi->frequency);
381 write_u32(buf + AFHI_UNUSED1_OFFSET, 0);
382 write_u32(buf + AFHI_HEADER_LEN_OFFSET, afhi->header_len);
383 write_u8(buf + AFHI_CHANNELS_OFFSET, afhi->channels);
384 write_u32(buf + CHUNKS_TOTAL_OFFSET, afhi->chunks_total);
385 write_u32(buf + HEADER_LEN_OFFSET, afhi->header_len);
386 write_u32(buf + AFHI_UNUSED2_OFFSET, 0);
387 write_u32(buf + CHUNK_TV_TV_SEC_OFFSET, afhi->chunk_tv.tv_sec);
388 write_u32(buf + CHUNK_TV_TV_USEC_OFFSET, afhi->chunk_tv.tv_usec);
389 p = buf + AFHI_INFO_STRING_OFFSET;
390 /* The sprintf's below are OK as our caller made sure that buf is large enough */
391 p += sprintf(p, "%s", afhi->techinfo) + 1;
392 p += sprintf(p, "%s", afhi->tags.artist) + 1;
393 p += sprintf(p, "%s", afhi->tags.title) + 1;
394 p += sprintf(p, "%s", afhi->tags.year) + 1;
395 p += sprintf(p, "%s", afhi->tags.album) + 1;
396 sprintf(p, "%s", afhi->tags.comment);
399 static void load_afhi(const char *buf, struct afh_info *afhi)
401 afhi->seconds_total = read_u32(buf + AFHI_SECONDS_TOTAL_OFFSET);
402 afhi->bitrate = read_u32(buf + AFHI_BITRATE_OFFSET);
403 afhi->frequency = read_u32(buf + AFHI_FREQUENCY_OFFSET);
404 afhi->header_len = read_u32(buf + AFHI_HEADER_LEN_OFFSET);
405 afhi->channels = read_u8(buf + AFHI_CHANNELS_OFFSET);
406 afhi->chunks_total = read_u32(buf + CHUNKS_TOTAL_OFFSET);
407 afhi->header_len = read_u32(buf + HEADER_LEN_OFFSET);
408 afhi->chunk_tv.tv_sec = read_u32(buf + CHUNK_TV_TV_SEC_OFFSET);
409 afhi->chunk_tv.tv_usec = read_u32(buf + CHUNK_TV_TV_USEC_OFFSET);
410 afhi->techinfo = (char *)buf + AFHI_INFO_STRING_OFFSET;
411 afhi->tags.artist = afhi->techinfo + strlen(afhi->techinfo) + 1;
412 afhi->tags.title = afhi->tags.artist + strlen(afhi->tags.artist) + 1;
413 afhi->tags.year = afhi->tags.title + strlen(afhi->tags.title) + 1;
414 afhi->tags.album = afhi->tags.year + strlen(afhi->tags.year) + 1;
415 afhi->tags.comment = afhi->tags.album + strlen(afhi->tags.album) + 1;
418 static unsigned sizeof_chunk_table(struct afh_info *afhi)
422 return 4 * (afhi->chunks_total + 1);
425 static uint32_t save_chunk_table(struct afh_info *afhi, char *buf)
428 uint32_t max = 0, old = 0;
430 for (i = 0; i <= afhi->chunks_total; i++) {
431 uint32_t val = afhi->chunk_table[i];
432 write_u32(buf + 4 * i, val);
434 * If the first chunk is the header, do not consider it for the
435 * calculation of the largest chunk size.
437 if (i == 0 || (i == 1 && afhi->header_len > 0)) {
441 max = PARA_MAX(max, val - old);
447 static void load_chunk_table(struct afh_info *afhi, char *buf)
451 afhi->chunk_table = para_malloc(sizeof_chunk_table(afhi));
452 for (i = 0; i <= afhi->chunks_total; i++)
453 afhi->chunk_table[i] = read_u32(buf + 4 * i);
457 * Get the row of the audio file table corresponding to the given path.
459 * \param path The full path of the audio file.
460 * \param row Result pointer.
464 int aft_get_row_of_path(const char *path, struct osl_row **row)
466 struct osl_object obj = {.data = (char *)path, .size = strlen(path) + 1};
468 return osl(osl_get_row(audio_file_table, AFTCOL_PATH, &obj, row));
472 * Get the row of the audio file table corresponding to the given hash value.
474 * \param hash The hash value of the desired audio file.
475 * \param row Result pointer.
479 static int aft_get_row_of_hash(unsigned char *hash, struct osl_row **row)
481 const struct osl_object obj = {.data = hash, .size = HASH_SIZE};
482 return osl(osl_get_row(audio_file_table, AFTCOL_HASH, &obj, row));
486 * Get the audio file selector info object of a row.
488 * \param row Pointer to a row in the audio file table.
489 * \param obj Result pointer.
493 static int get_afsi_object_of_row(const struct osl_row *row,
494 struct osl_object *obj)
496 return osl(osl_get_object(audio_file_table, row, AFTCOL_AFSI, obj));
500 * Get the osl object holding the audio file selector info, given a path.
503 * \param path The full path of the audio file.
504 * \param obj Result pointer.
506 * \return Positive on success, negative on errors.
508 static int get_afsi_object_of_path(const char *path, struct osl_object *obj)
511 int ret = aft_get_row_of_path(path, &row);
514 return get_afsi_object_of_row(row, obj);
518 * Get the audio file selector info, given a row of the audio file table.
520 * \param row Pointer to a row in the audio file table.
521 * \param afsi Result pointer.
523 * \return Positive on success, negative on errors.
525 int get_afsi_of_row(const struct osl_row *row, struct afs_info *afsi)
527 struct osl_object obj;
528 int ret = get_afsi_object_of_row(row, &obj);
531 return load_afsi(afsi, &obj);
535 * Get the audio file selector info, given the path of an audio table.
537 * \param path The full path of the audio file.
538 * \param afsi Result pointer.
542 static int get_afsi_of_path(const char *path, struct afs_info *afsi)
544 struct osl_object obj;
545 int ret = get_afsi_object_of_path(path, &obj);
548 return load_afsi(afsi, &obj);
552 * Get the path of an audio file, given a row of the audio file table.
554 * \param row Pointer to a row in the audio file table.
555 * \param path Result pointer.
557 * The result is a pointer to mmapped data. The caller must not attempt
562 int get_audio_file_path_of_row(const struct osl_row *row, char **path)
564 struct osl_object path_obj;
565 int ret = osl(osl_get_object(audio_file_table, row, AFTCOL_PATH,
569 *path = path_obj.data;
574 * Get the object containing the hash value of an audio file, given a row.
576 * \param row Pointer to a row of the audio file table.
577 * \param obj Result pointer.
579 * \return The return value of the underlying call to osl_get_object().
581 * \sa get_hash_of_row().
583 static int get_hash_object_of_aft_row(const struct osl_row *row,
584 struct osl_object *obj)
586 return osl(osl_get_object(audio_file_table, row, AFTCOL_HASH, obj));
590 * Get the hash value of an audio file, given a row of the audio file table.
592 * \param row Pointer to a row of the audio file table.
593 * \param hash Result pointer.
595 * \a hash points to mapped data and must not be freed by the caller.
597 * \return The return value of the underlying call to
598 * get_hash_object_of_aft_row().
600 static int get_hash_of_row(const struct osl_row *row, unsigned char **hash)
602 struct osl_object obj;
603 int ret = get_hash_object_of_aft_row(row, &obj);
612 * Get the audio format handler info, given a row of the audio file table.
614 * \param row Pointer to a row of the audio file table.
615 * \param afhi Result pointer.
617 * \return The return value of the underlying call to osl_get_object().
619 * \sa get_chunk_table_of_row().
621 int get_afhi_of_row(const struct osl_row *row, struct afh_info *afhi)
623 struct osl_object obj;
624 int ret = osl(osl_get_object(audio_file_table, row, AFTCOL_AFHI,
628 load_afhi(obj.data, afhi);
632 /* returns shmid on success */
633 static int save_afd(struct audio_file_data *afd)
635 size_t size = sizeof(*afd) + sizeof_chunk_table(&afd->afhi);
636 int shmid, ret = shm_new(size);
643 ret = shm_attach(shmid, ATTACH_RW, &shm_afd);
648 afd->max_chunk_size = save_chunk_table(&afd->afhi, buf);
649 *(struct audio_file_data *)shm_afd = *afd;
658 * Extract a afd stored in a shared memory area.
660 * Attach the shared memory area given by \a shmid, load the audio file data
661 * stored therein and detach the area afterwards. Called by vss, after
662 * receiving a positive response to the request for the next audio file.
664 * \param shmid The identifier of the shared memory area containing the afd.
665 * \param afd Result pointer.
669 int load_afd(int shmid, struct audio_file_data *afd)
674 ret = shm_attach(shmid, ATTACH_RO, &shm_afd);
677 *afd = *(struct audio_file_data *)shm_afd;
678 load_chunk_table(&afd->afhi, shm_afd + sizeof(*afd));
683 static int get_local_time(uint64_t *seconds, char *buf, size_t size,
684 time_t current_time, enum ls_listing_mode lm)
688 if (!localtime_r((time_t *)seconds, &t))
690 if (lm == LS_MODE_MBOX) {
691 if (!strftime(buf, size, "%c", &t))
695 if (*seconds + 6 * 30 * 24 * 3600 > current_time) {
696 if (!strftime(buf, size, "%b %e %k:%M", &t))
700 if (!strftime(buf, size, "%b %e %Y", &t))
705 /** Compute the number of (decimal) digits of a number. */
706 #define GET_NUM_DIGITS(x, num) { \
707 typeof((x)) _tmp = PARA_ABS(x); \
710 while ((_tmp) > 9) { \
716 __a_const static short unsigned get_duration_width(int seconds)
718 short unsigned width;
719 unsigned hours = seconds / 3600, mins = (seconds % 3600) / 60;
721 if (!hours) /* less than one hour => m:ss or mm:ss => 4 or 5 digits */
722 return 4 + (mins > 9);
723 /* more than one hour => h:mm:ss, hh:mm:ss, hhh:mm:ss, ... */
724 GET_NUM_DIGITS(hours, &width);
728 static void get_duration_buf(int seconds, char *buf, struct ls_options *opts)
730 unsigned hours = seconds / 3600, mins = (seconds % 3600) / 60;
731 short unsigned max_width;
733 if (!hours) { /* m:ss or mm:ss */
734 max_width = opts->mode == LS_MODE_LONG?
735 opts->widths.duration_width : 4;
736 sprintf(buf, "%*u:%02u", max_width - 3, mins, seconds % 60);
737 } else { /* more than one hour => h:mm:ss, hh:mm:ss, hhh:mm:ss, ... */
738 max_width = opts->mode == LS_MODE_LONG?
739 opts->widths.duration_width : 7;
740 sprintf(buf, "%*u:%02u:%02u", max_width - 6, hours, mins,
745 static int write_attribute_items(struct para_buffer *b,
746 const char *att_bitmap, struct afs_info *afsi)
751 WRITE_STATUS_ITEM(b, SI_ATTRIBUTES_BITMAP, "%s\n", att_bitmap);
752 ret = get_attribute_text(&afsi->attributes, " ", &att_text);
755 WRITE_STATUS_ITEM(b, SI_ATTRIBUTES_TXT, "%s\n", att_text);
760 static void write_lyrics_items(struct para_buffer *b, struct afs_info *afsi)
764 WRITE_STATUS_ITEM(b, SI_LYRICS_ID, "%u\n", afsi->lyrics_id);
765 lyr_get_name_by_id(afsi->lyrics_id, &lyrics_name);
766 WRITE_STATUS_ITEM(b, SI_LYRICS_NAME, "%s\n", lyrics_name?
767 lyrics_name : "(none)");
770 static void write_image_items(struct para_buffer *b, struct afs_info *afsi)
774 WRITE_STATUS_ITEM(b, SI_IMAGE_ID, "%u\n", afsi->image_id);
775 img_get_name_by_id(afsi->image_id, &image_name);
776 WRITE_STATUS_ITEM(b, SI_IMAGE_NAME, "%s\n", image_name?
777 image_name : "(none)");
780 static void write_filename_items(struct para_buffer *b, const char *path,
785 if (!(flags & LS_FLAG_FULL_PATH)) {
786 WRITE_STATUS_ITEM(b, SI_BASENAME, "%s\n", path);
789 WRITE_STATUS_ITEM(b, SI_PATH, "%s\n", path);
790 val = para_basename(path);
791 WRITE_STATUS_ITEM(b, SI_BASENAME, "%s\n", val? val : "");
792 val = para_dirname(path);
793 WRITE_STATUS_ITEM(b, SI_DIRECTORY, "%s\n", val? val : "");
797 static int print_chunk_table(struct ls_data *d, struct para_buffer *b)
799 struct osl_object chunk_table_obj;
800 struct osl_row *aft_row;
804 ret = aft_get_row_of_hash(d->hash, &aft_row);
807 ret = osl(osl_open_disk_object(audio_file_table, aft_row,
808 AFTCOL_CHUNKS, &chunk_table_obj));
811 para_printf(b, "%s\n"
812 "chunk_time: %lu:%lu\nchunk_offsets: ",
814 (long unsigned) d->afhi.chunk_tv.tv_sec,
815 (long unsigned) d->afhi.chunk_tv.tv_usec
817 buf = chunk_table_obj.data;
818 for (i = 0; i <= d->afhi.chunks_total; i++)
819 para_printf(b, "%u ", (unsigned) read_u32(buf + 4 * i));
820 para_printf(b, "\n");
822 osl_close_disk_object(&chunk_table_obj);
826 static void write_score(struct para_buffer *b, struct ls_data *d,
827 struct ls_options *opts)
829 if (!(opts->flags & LS_FLAG_ADMISSIBLE_ONLY)) /* no score*/
831 WRITE_STATUS_ITEM(b, SI_SCORE, "%li\n", d->score);
834 static int print_list_item(struct ls_data *d, struct ls_options *opts,
835 struct para_buffer *b, time_t current_time)
839 char last_played_time[30];
840 char duration_buf[30]; /* nobody has an audio file long enough to overflow this */
841 struct afs_info *afsi = &d->afsi;
842 struct afh_info *afhi = &d->afhi;
843 char asc_hash[2 * HASH_SIZE + 1];
845 if (opts->mode == LS_MODE_SHORT) {
846 para_printf(b, "%s\n", d->path);
850 if (opts->mode == LS_MODE_CHUNKS) {
851 ret = print_chunk_table(d, b);
854 get_attribute_bitmap(&afsi->attributes, att_buf);
855 if (opts->flags & LS_FLAG_UNIXDATE)
856 sprintf(last_played_time, "%llu",
857 (long long unsigned)afsi->last_played);
859 ret = get_local_time(&afsi->last_played, last_played_time,
860 sizeof(last_played_time), current_time, opts->mode);
864 get_duration_buf(afhi->seconds_total, duration_buf, opts);
865 if (opts->mode == LS_MODE_LONG) {
866 struct ls_widths *w = &opts->widths;
867 if (opts->flags & LS_FLAG_ADMISSIBLE_ONLY) {
868 para_printf(b, "%*li ", opts->widths.score_width,
872 "%s " /* attributes */
874 "%*d " /* image_id */
875 "%*d " /* lyrics_id */
877 "%*s " /* audio format */
878 "%*d " /* frequency */
881 "%*d " /* num_played */
882 "%s " /* last_played */
885 w->amp_width, afsi->amp,
886 w->image_id_width, afsi->image_id,
887 w->lyrics_id_width, afsi->lyrics_id,
888 w->bitrate_width, afhi->bitrate,
889 w->audio_format_width,
890 audio_format_name(afsi->audio_format_id),
891 w->frequency_width, afhi->frequency,
894 w->num_played_width, afsi->num_played,
901 if (opts->mode == LS_MODE_MBOX) {
902 const char *bn = para_basename(d->path);
904 "From foo@localhost %s\n"
905 "Received: from\nTo: bar\nFrom: a\n"
910 write_filename_items(b, d->path, opts->flags);
911 write_score(b, d, opts);
912 ret = write_attribute_items(b, att_buf, afsi);
915 write_image_items(b, afsi);
916 write_lyrics_items(b, afsi);
917 hash_to_asc(d->hash, asc_hash);
918 WRITE_STATUS_ITEM(b, SI_HASH, "%s\n", asc_hash);
919 WRITE_STATUS_ITEM(b, SI_BITRATE, "%dkbit/s\n", afhi->bitrate);
920 WRITE_STATUS_ITEM(b, SI_FORMAT, "%s\n",
921 audio_format_name(afsi->audio_format_id));
922 WRITE_STATUS_ITEM(b, SI_FREQUENCY, "%dHz\n", afhi->frequency);
923 WRITE_STATUS_ITEM(b, SI_CHANNELS, "%d\n", afhi->channels);
924 WRITE_STATUS_ITEM(b, SI_DURATION, "%s\n", duration_buf);
925 WRITE_STATUS_ITEM(b, SI_SECONDS_TOTAL, "%lu\n", afhi->seconds_total);
926 WRITE_STATUS_ITEM(b, SI_LAST_PLAYED, "%s\n", last_played_time);
927 WRITE_STATUS_ITEM(b, SI_NUM_PLAYED, "%d\n", afsi->num_played);
928 WRITE_STATUS_ITEM(b, SI_AMPLIFICATION, "%u\n", afsi->amp);
929 WRITE_STATUS_ITEM(b, SI_CHUNK_TIME, "%lu\n", tv2ms(&afhi->chunk_tv));
930 WRITE_STATUS_ITEM(b, SI_NUM_CHUNKS, "%lu\n", afhi->chunks_total);
931 WRITE_STATUS_ITEM(b, SI_TECHINFO, "%s\n", afhi->techinfo);
932 WRITE_STATUS_ITEM(b, SI_ARTIST, "%s\n", afhi->tags.artist);
933 WRITE_STATUS_ITEM(b, SI_TITLE, "%s\n", afhi->tags.title);
934 WRITE_STATUS_ITEM(b, SI_YEAR, "%s\n", afhi->tags.year);
935 WRITE_STATUS_ITEM(b, SI_ALBUM, "%s\n", afhi->tags.album);
936 WRITE_STATUS_ITEM(b, SI_COMMENT, "%s\n", afhi->tags.comment);
937 if (opts->mode == LS_MODE_MBOX) {
938 struct osl_object lyrics_def;
939 lyr_get_def_by_id(afsi->lyrics_id, &lyrics_def);
940 if (lyrics_def.data) {
941 para_printf(b, "Lyrics:\n~~~~~~~\n%s",
942 (char *)lyrics_def.data);
943 osl_close_disk_object(&lyrics_def);
950 static struct ls_data status_item_ls_data;
951 static struct osl_row *current_aft_row;
953 static void make_inode_status_items(struct para_buffer *pb)
955 struct stat statbuf = {.st_size = 0};
956 char *path, mtime_str[30] = "\0";
960 ret = get_audio_file_path_of_row(current_aft_row, &path);
963 ret = stat(path, &statbuf);
966 localtime_r(&statbuf.st_mtime, &mtime_tm);
967 ret = strftime(mtime_str, 29, "%b %d %Y", &mtime_tm);
968 assert(ret > 0); /* number of bytes placed in mtime_str */
970 WRITE_STATUS_ITEM(pb, SI_MTIME, "%s\n", mtime_str);
971 WRITE_STATUS_ITEM(pb, SI_FILE_SIZE, "%ld\n", statbuf.st_size / 1024);
974 static int make_status_items(void)
976 struct ls_options opts = {
977 .flags = LS_FLAG_FULL_PATH | LS_FLAG_ADMISSIBLE_ONLY,
978 .mode = LS_MODE_VERBOSE,
980 struct para_buffer pb = {.max_size = shm_get_shmmax() - 1};
985 ret = print_list_item(&status_item_ls_data, &opts, &pb, current_time);
988 make_inode_status_items(&pb);
990 status_items = pb.buf;
991 memset(&pb, 0, sizeof(pb));
992 pb.max_size = shm_get_shmmax() - 1;
993 pb.flags = PBF_SIZE_PREFIX;
994 ret = print_list_item(&status_item_ls_data, &opts, &pb, current_time);
1000 make_inode_status_items(&pb);
1001 free(parser_friendly_status_items);
1002 parser_friendly_status_items = pb.buf;
1007 * Open the audio file with highest score and set up an afd structure.
1009 * \param afd Result pointer.
1011 * On success, the numplayed field of the audio file selector info is increased
1012 * and the lastplayed time is set to the current time. Finally, the score of
1013 * the audio file is updated.
1015 * \return Positive shmid on success, negative on errors.
1017 int open_and_update_audio_file(struct audio_file_data *afd)
1019 unsigned char file_hash[HASH_SIZE];
1020 struct osl_object afsi_obj;
1021 struct afs_info new_afsi;
1023 struct afsi_change_event_data aced;
1024 struct osl_object map, chunk_table_obj;
1025 struct ls_data *d = &status_item_ls_data;
1027 ret = score_get_best(¤t_aft_row, &d->score);
1030 ret = get_hash_of_row(current_aft_row, &d->hash);
1033 ret = get_audio_file_path_of_row(current_aft_row, &d->path);
1036 PARA_NOTICE_LOG("%s\n", d->path);
1037 ret = get_afsi_object_of_row(current_aft_row, &afsi_obj);
1040 ret = load_afsi(&d->afsi, &afsi_obj);
1043 ret = get_afhi_of_row(current_aft_row, &afd->afhi);
1046 d->afhi = afd->afhi;
1047 d->afhi.chunk_table = afd->afhi.chunk_table = NULL;
1048 ret = osl(osl_open_disk_object(audio_file_table, current_aft_row,
1049 AFTCOL_CHUNKS, &chunk_table_obj));
1052 ret = mmap_full_file(d->path, O_RDONLY, &map.data, &map.size, &afd->fd);
1055 hash_function(map.data, map.size, file_hash);
1056 ret = hash_compare(file_hash, d->hash);
1057 para_munmap(map.data, map.size);
1059 ret = -E_HASH_MISMATCH;
1063 new_afsi.num_played++;
1064 new_afsi.last_played = time(NULL);
1065 save_afsi(&new_afsi, &afsi_obj); /* in-place update */
1067 afd->audio_format_id = d->afsi.audio_format_id;
1068 load_chunk_table(&afd->afhi, chunk_table_obj.data);
1069 aced.aft_row = current_aft_row;
1070 aced.old_afsi = &d->afsi;
1072 * No need to update the status items as the AFSI_CHANGE event will
1075 afs_event(AFSI_CHANGE, NULL, &aced);
1076 ret = save_afd(afd);
1078 free(afd->afhi.chunk_table);
1079 osl_close_disk_object(&chunk_table_obj);
1081 PARA_ERROR_LOG("%s: %s\n", d->path, para_strerror(-ret));
1082 ret = score_delete(current_aft_row);
1089 static int ls_audio_format_compare(const void *a, const void *b)
1091 struct ls_data *d1 = *(struct ls_data **)a, *d2 = *(struct ls_data **)b;
1092 return NUM_COMPARE(d1->afsi.audio_format_id, d2->afsi.audio_format_id);
1095 static int ls_duration_compare(const void *a, const void *b)
1097 struct ls_data *d1 = *(struct ls_data **)a, *d2 = *(struct ls_data **)b;
1098 return NUM_COMPARE(d1->afhi.seconds_total, d2->afhi.seconds_total);
1101 static int ls_bitrate_compare(const void *a, const void *b)
1103 struct ls_data *d1 = *(struct ls_data **)a, *d2 = *(struct ls_data **)b;
1104 return NUM_COMPARE(d1->afhi.bitrate, d2->afhi.bitrate);
1107 static int ls_lyrics_id_compare(const void *a, const void *b)
1109 struct ls_data *d1 = *(struct ls_data **)a, *d2 = *(struct ls_data **)b;
1110 return NUM_COMPARE(d1->afsi.lyrics_id, d2->afsi.lyrics_id);
1113 static int ls_image_id_compare(const void *a, const void *b)
1115 struct ls_data *d1 = *(struct ls_data **)a, *d2 = *(struct ls_data **)b;
1116 return NUM_COMPARE(d1->afsi.image_id, d2->afsi.image_id);
1119 static int ls_channels_compare(const void *a, const void *b)
1121 struct ls_data *d1 = *(struct ls_data **)a, *d2 = *(struct ls_data **)b;
1122 return NUM_COMPARE(d1->afhi.channels, d2->afhi.channels);
1125 static int ls_frequency_compare(const void *a, const void *b)
1127 struct ls_data *d1 = *(struct ls_data **)a, *d2 = *(struct ls_data **)b;
1128 return NUM_COMPARE(d1->afhi.frequency, d2->afhi.frequency);
1131 static int ls_num_played_compare(const void *a, const void *b)
1133 struct ls_data *d1 = *(struct ls_data **)a, *d2 = *(struct ls_data **)b;
1134 return NUM_COMPARE(d1->afsi.num_played, d2->afsi.num_played);
1137 static int ls_last_played_compare(const void *a, const void *b)
1139 struct ls_data *d1 = *(struct ls_data **)a, *d2 = *(struct ls_data **)b;
1140 return NUM_COMPARE(d1->afsi.last_played, d2->afsi.last_played);
1143 static int ls_score_compare(const void *a, const void *b)
1145 struct ls_data *d1 = *(struct ls_data **)a, *d2 = *(struct ls_data **)b;
1146 return NUM_COMPARE(d1->score, d2->score);
1149 static int ls_path_compare(const void *a, const void *b)
1151 struct ls_data *d1 = *(struct ls_data **)a, *d2 = *(struct ls_data **)b;
1152 return strcmp(d1->path, d2->path);
1155 static int sort_matching_paths(struct ls_options *options)
1157 size_t nmemb = options->num_matching_paths;
1158 size_t size = sizeof(*options->data_ptr);
1159 int (*compar)(const void *, const void *);
1162 options->data_ptr = para_malloc(nmemb * sizeof(*options->data_ptr));
1163 for (i = 0; i < nmemb; i++)
1164 options->data_ptr[i] = options->data + i;
1166 /* In these cases the array is already sorted */
1167 if (options->sorting == LS_SORT_BY_PATH
1168 && !(options->flags & LS_FLAG_ADMISSIBLE_ONLY)
1169 && (options->flags & LS_FLAG_FULL_PATH))
1171 if (options->sorting == LS_SORT_BY_SCORE &&
1172 options->flags & LS_FLAG_ADMISSIBLE_ONLY)
1175 switch (options->sorting) {
1176 case LS_SORT_BY_PATH:
1177 compar = ls_path_compare; break;
1178 case LS_SORT_BY_SCORE:
1179 compar = ls_score_compare; break;
1180 case LS_SORT_BY_LAST_PLAYED:
1181 compar = ls_last_played_compare; break;
1182 case LS_SORT_BY_NUM_PLAYED:
1183 compar = ls_num_played_compare; break;
1184 case LS_SORT_BY_FREQUENCY:
1185 compar = ls_frequency_compare; break;
1186 case LS_SORT_BY_CHANNELS:
1187 compar = ls_channels_compare; break;
1188 case LS_SORT_BY_IMAGE_ID:
1189 compar = ls_image_id_compare; break;
1190 case LS_SORT_BY_LYRICS_ID:
1191 compar = ls_lyrics_id_compare; break;
1192 case LS_SORT_BY_BITRATE:
1193 compar = ls_bitrate_compare; break;
1194 case LS_SORT_BY_DURATION:
1195 compar = ls_duration_compare; break;
1196 case LS_SORT_BY_AUDIO_FORMAT:
1197 compar = ls_audio_format_compare; break;
1201 qsort(options->data_ptr, nmemb, size, compar);
1205 /* row is either an aft_row or a row of the score table */
1206 /* TODO: Only compute widths if we need them */
1207 static int prepare_ls_row(struct osl_row *row, void *ls_opts)
1210 struct ls_options *options = ls_opts;
1212 struct ls_widths *w;
1213 unsigned short num_digits;
1215 struct osl_row *aft_row;
1219 if (options->flags & LS_FLAG_ADMISSIBLE_ONLY) {
1220 ret = get_score_and_aft_row(row, &score, &aft_row);
1227 ret = get_audio_file_path_of_row(aft_row, &path);
1230 if (!(options->flags & LS_FLAG_FULL_PATH)) {
1231 char *p = strrchr(path, '/');
1235 if (options->num_patterns) {
1236 for (i = 0; i < options->num_patterns; i++) {
1237 ret = fnmatch(options->patterns[i], path, 0);
1240 if (ret == FNM_NOMATCH)
1244 if (i >= options->num_patterns) /* no match */
1247 tmp = options->num_matching_paths++;
1248 if (options->num_matching_paths > options->array_size) {
1249 options->array_size++;
1250 options->array_size *= 2;
1251 options->data = para_realloc(options->data, options->array_size
1252 * sizeof(*options->data));
1254 d = options->data + tmp;
1255 ret = get_afsi_of_row(aft_row, &d->afsi);
1258 ret = get_afhi_of_row(aft_row, &d->afhi);
1262 ret = get_hash_of_row(aft_row, &d->hash);
1265 w = &options->widths;
1266 GET_NUM_DIGITS(d->afsi.image_id, &num_digits);
1267 w->image_id_width = PARA_MAX(w->image_id_width, num_digits);
1268 GET_NUM_DIGITS(d->afsi.lyrics_id, &num_digits);
1269 w->lyrics_id_width = PARA_MAX(w->lyrics_id_width, num_digits);
1270 GET_NUM_DIGITS(d->afhi.bitrate, &num_digits);
1271 w->bitrate_width = PARA_MAX(w->bitrate_width, num_digits);
1272 GET_NUM_DIGITS(d->afhi.frequency, &num_digits);
1273 w->frequency_width = PARA_MAX(w->frequency_width, num_digits);
1274 GET_NUM_DIGITS(d->afsi.num_played, &num_digits);
1275 w->num_played_width = PARA_MAX(w->num_played_width, num_digits);
1276 /* get the number of chars to print this amount of time */
1277 num_digits = get_duration_width(d->afhi.seconds_total);
1278 w->duration_width = PARA_MAX(w->duration_width, num_digits);
1279 GET_NUM_DIGITS(d->afsi.amp, &num_digits);
1280 w->amp_width = PARA_MAX(w->amp_width, num_digits);
1281 num_digits = strlen(audio_format_name(d->afsi.audio_format_id));
1282 w->audio_format_width = PARA_MAX(w->audio_format_width, num_digits);
1283 if (options->flags & LS_FLAG_ADMISSIBLE_ONLY) {
1284 GET_NUM_DIGITS(score, &num_digits);
1285 num_digits++; /* add one for the sign (space or "-") */
1286 w->score_width = PARA_MAX(w->score_width, num_digits);
1294 static int com_ls_callback(int fd, const struct osl_object *query)
1296 struct ls_options *opts = query->data;
1297 char *p, *pattern_start = (char *)query->data + sizeof(*opts);
1298 struct para_buffer b = {
1299 .max_size = shm_get_shmmax(),
1300 .flags = (opts->mode == LS_MODE_PARSER)? PBF_SIZE_PREFIX : 0,
1301 .max_size_handler = afs_max_size_handler,
1302 .private_data = &(struct afs_max_size_handler_data) {
1308 time_t current_time;
1310 if (opts->num_patterns) {
1311 opts->patterns = para_malloc(opts->num_patterns * sizeof(char *));
1312 for (i = 0, p = pattern_start; i < opts->num_patterns; i++) {
1313 opts->patterns[i] = p;
1317 opts->patterns = NULL;
1318 if (opts->flags & LS_FLAG_ADMISSIBLE_ONLY)
1319 ret = admissible_file_loop(opts, prepare_ls_row);
1321 ret = osl(osl_rbtree_loop(audio_file_table, AFTCOL_PATH, opts,
1325 if (opts->num_matching_paths == 0) {
1326 ret = opts->num_patterns > 0? -E_NO_MATCH : 0;
1329 ret = sort_matching_paths(opts);
1332 time(¤t_time);
1333 if (opts->flags & LS_FLAG_REVERSE)
1334 for (i = opts->num_matching_paths - 1; i >= 0; i--) {
1335 ret = print_list_item(opts->data_ptr[i], opts, &b, current_time);
1340 for (i = 0; i < opts->num_matching_paths; i++) {
1341 ret = print_list_item(opts->data_ptr[i], opts, &b, current_time);
1346 flush_and_free_pb(&b);
1348 free(opts->data_ptr);
1349 free(opts->patterns);
1354 * TODO: flags -h (sort by hash)
1356 int com_ls(struct command_context *cc)
1360 enum ls_sorting_method sort = LS_SORT_BY_PATH;
1361 enum ls_listing_mode mode = LS_MODE_SHORT;
1362 struct ls_options opts = {.patterns = NULL};
1363 struct osl_object query = {.data = &opts, .size = sizeof(opts)};
1365 for (i = 1; i < cc->argc; i++) {
1366 const char *arg = cc->argv[i];
1369 if (!strcmp(arg, "--")) {
1373 if (!strncmp(arg, "-l", 2)) {
1375 mode = LS_MODE_LONG;
1379 return -E_AFT_SYNTAX;
1380 switch(*(arg + 2)) {
1382 mode = LS_MODE_SHORT;
1385 mode = LS_MODE_LONG;
1388 mode = LS_MODE_VERBOSE;
1391 mode = LS_MODE_MBOX;
1394 mode = LS_MODE_CHUNKS;
1397 mode = LS_MODE_PARSER;
1400 return -E_AFT_SYNTAX;
1403 if (!strcmp(arg, "-p")) {
1404 flags |= LS_FLAG_FULL_PATH;
1407 if (!strcmp(arg, "-a")) {
1408 flags |= LS_FLAG_ADMISSIBLE_ONLY;
1411 if (!strcmp(arg, "-r")) {
1412 flags |= LS_FLAG_REVERSE;
1415 if (!strcmp(arg, "-d")) {
1416 flags |= LS_FLAG_UNIXDATE;
1419 if (!strncmp(arg, "-s", 2)) {
1420 if (!*(arg + 2) || *(arg + 3))
1421 return -E_AFT_SYNTAX;
1422 switch(*(arg + 2)) {
1424 sort = LS_SORT_BY_PATH;
1426 case 's': /* -ss implies -a */
1427 sort = LS_SORT_BY_SCORE;
1428 flags |= LS_FLAG_ADMISSIBLE_ONLY;
1431 sort = LS_SORT_BY_LAST_PLAYED;
1434 sort = LS_SORT_BY_NUM_PLAYED;
1437 sort = LS_SORT_BY_FREQUENCY;
1440 sort = LS_SORT_BY_CHANNELS;
1443 sort = LS_SORT_BY_IMAGE_ID;
1446 sort = LS_SORT_BY_LYRICS_ID;
1449 sort = LS_SORT_BY_BITRATE;
1452 sort = LS_SORT_BY_DURATION;
1455 sort = LS_SORT_BY_AUDIO_FORMAT;
1458 return -E_AFT_SYNTAX;
1461 return -E_AFT_SYNTAX;
1464 opts.sorting = sort;
1466 opts.num_patterns = cc->argc - i;
1467 return send_option_arg_callback_request(&query, opts.num_patterns,
1468 cc->argv + i, com_ls_callback, afs_cb_result_handler, cc);
1472 * Call the given function for each file in the audio file table.
1474 * \param private_data An arbitrary data pointer, passed to \a func.
1475 * \param func The custom function to be called.
1479 int audio_file_loop(void *private_data, osl_rbtree_loop_func *func)
1481 return osl(osl_rbtree_loop(audio_file_table, AFTCOL_HASH, private_data,
1485 static struct osl_row *find_hash_sister(unsigned char *hash)
1487 const struct osl_object obj = {.data = hash, .size = HASH_SIZE};
1488 struct osl_row *row;
1490 osl_get_row(audio_file_table, AFTCOL_HASH, &obj, &row);
1494 /** The format of the data stored by save_audio_file_data(). */
1495 enum com_add_buffer_offsets {
1496 /** afhi (if present) starts here. */
1497 CAB_AFHI_OFFSET_POS = 0,
1498 /** Start of the chunk table (if present). */
1499 CAB_CHUNKS_OFFSET_POS = 2,
1500 /** Audio format id. */
1501 CAB_AUDIO_FORMAT_OFFSET = 4,
1502 /** Flags given to the add command. */
1503 CAB_FLAGS_OFFSET = 5,
1504 /** The hash of the audio file being added. */
1505 CAB_HASH_OFFSET = 9,
1506 /** Start of the path of the audio file. */
1507 CAB_PATH_OFFSET = (CAB_HASH_OFFSET + HASH_SIZE),
1511 * Store the given data to a single buffer. Doesn't need the audio file selector
1512 * info struct as the server knows it as well.
1514 * It's OK to call this with afhi == NULL. In this case, the audio format
1515 * handler info won't be stored in the buffer.
1517 static void save_add_callback_buffer(unsigned char *hash, const char *path,
1518 struct afh_info *afhi, uint32_t flags,
1519 uint8_t audio_format_num, struct osl_object *obj)
1521 size_t path_len = strlen(path) + 1;
1522 size_t afhi_size = sizeof_afhi_buf(afhi);
1523 size_t size = CAB_PATH_OFFSET + path_len + afhi_size
1524 + sizeof_chunk_table(afhi);
1525 char *buf = para_malloc(size);
1528 write_u8(buf + CAB_AUDIO_FORMAT_OFFSET, audio_format_num);
1529 write_u32(buf + CAB_FLAGS_OFFSET, flags);
1531 memcpy(buf + CAB_HASH_OFFSET, hash, HASH_SIZE);
1532 strcpy(buf + CAB_PATH_OFFSET, path);
1534 pos = CAB_PATH_OFFSET + path_len;
1535 PARA_DEBUG_LOG("size: %zu, afhi starts at %d\n", size, pos);
1536 PARA_DEBUG_LOG("last afhi byte: %p, pos %zu\n", buf + pos + afhi_size - 1,
1537 pos + afhi_size - 1);
1538 write_u16(buf + CAB_AFHI_OFFSET_POS, pos);
1539 save_afhi(afhi, buf + pos);
1542 PARA_DEBUG_LOG("size: %zu, chunks start at %d\n", size, pos);
1543 write_u16(buf + CAB_CHUNKS_OFFSET_POS, pos);
1545 save_chunk_table(afhi, buf + pos);
1546 PARA_DEBUG_LOG("last byte in buf: %p\n", buf + size - 1);
1553 Overview of the add command.
1555 Input: What was passed to the callback by the command handler.
1557 HS: Hash sister. Whether an audio file with identical hash
1558 already exists in the osl database.
1560 PB: Path brother. Whether a file with the given path exists
1563 F: Force flag given. Whether add was called with -f.
1565 output: Action performed by the callback.
1567 AFHI: Whether afhi and chunk table are computed and sent.
1568 ACTION: Table modifications to be done by the callback.
1570 +----+----+---+------+---------------------------------------------------+
1571 | HS | PB | F | AFHI | ACTION
1572 +----+----+---+------+---------------------------------------------------+
1573 | Y | Y | Y | Y | if HS != PB: remove PB. HS: force afhi update,
1574 | | update path, keep afsi
1575 +----+----+---+------+---------------------------------------------------+
1576 | Y | Y | N | N | if HS == PB: do not send callback request at all.
1577 | | otherwise: remove PB, HS: update path, keep afhi,
1579 +----+----+---+------+---------------------------------------------------+
1580 | Y | N | Y | Y | (rename) force afhi update of HS, update path of
1582 +----+----+---+------+---------------------------------------------------+
1583 | Y | N | N | N | (file rename) update path of HS, keep afsi, afhi
1584 +----+----+---+------+---------------------------------------------------+
1585 | N | Y | Y | Y | (file change) update afhi, hash, of PB, keep afsi
1586 | | (force has no effect)
1587 +----+----+---+------+---------------------------------------------------+
1588 | N | Y | N | Y | (file change) update afhi, hash of PB, keep afsi
1589 +----+----+---+------+---------------------------------------------------+
1590 | N | N | Y | Y | (new file) create new entry (force has no effect)
1591 +----+----+---+------+---------------------------------------------------+
1592 | N | N | N | Y | (new file) create new entry
1593 +----+----+---+------+---------------------------------------------------+
1597 afhi <=> force or no HS
1602 /** Flags passed to the add command. */
1603 enum com_add_flags {
1604 /** Skip paths that exist already. */
1606 /** Force adding. */
1608 /** Print what is being done. */
1609 ADD_FLAG_VERBOSE = 4,
1610 /** Try to add files with unknown suffixes. */
1614 static int com_add_callback(int fd, const struct osl_object *query)
1616 char *buf = query->data, *path;
1617 struct osl_row *pb, *aft_row;
1619 struct osl_object objs[NUM_AFT_COLUMNS];
1620 unsigned char *hash;
1621 char asc[2 * HASH_SIZE + 1];
1623 char afsi_buf[AFSI_SIZE];
1624 uint32_t flags = read_u32(buf + CAB_FLAGS_OFFSET);
1625 struct afs_info default_afsi = {.last_played = 0};
1626 struct para_buffer msg = {
1627 .max_size = shm_get_shmmax(),
1628 .max_size_handler = afs_max_size_handler,
1629 .private_data = &(struct afs_max_size_handler_data) {
1634 uint16_t afhi_offset, chunks_offset;
1636 hash = (unsigned char *)buf + CAB_HASH_OFFSET;
1637 hash_to_asc(hash, asc);
1638 objs[AFTCOL_HASH].data = buf + CAB_HASH_OFFSET;
1639 objs[AFTCOL_HASH].size = HASH_SIZE;
1641 path = buf + CAB_PATH_OFFSET;
1642 objs[AFTCOL_PATH].data = path;
1643 objs[AFTCOL_PATH].size = strlen(path) + 1;
1645 PARA_INFO_LOG("request to add %s\n", path);
1646 hs = find_hash_sister(hash);
1647 ret = aft_get_row_of_path(path, &pb);
1648 if (ret < 0 && ret != -OSL_ERRNO_TO_PARA_ERROR(E_OSL_RB_KEY_NOT_FOUND))
1650 if (hs && pb && hs == pb && !(flags & ADD_FLAG_FORCE)) {
1651 if (flags & ADD_FLAG_VERBOSE)
1652 para_printf(&msg, "ignoring duplicate\n");
1656 if (hs && hs != pb) {
1657 struct osl_object obj;
1658 if (pb) { /* hs trumps pb, remove pb */
1659 if (flags & ADD_FLAG_VERBOSE)
1660 para_printf(&msg, "removing %s\n", path);
1661 afs_event(AUDIO_FILE_REMOVE, &msg, pb);
1662 ret = osl(osl_del_row(audio_file_table, pb));
1667 /* file rename, update hs' path */
1668 if (flags & ADD_FLAG_VERBOSE) {
1669 ret = osl(osl_get_object(audio_file_table, hs,
1670 AFTCOL_PATH, &obj));
1673 para_printf(&msg, "renamed from %s\n", (char *)obj.data);
1675 ret = osl(osl_update_object(audio_file_table, hs, AFTCOL_PATH,
1676 &objs[AFTCOL_PATH]));
1679 afs_event(AUDIO_FILE_RENAME, &msg, hs);
1680 if (!(flags & ADD_FLAG_FORCE))
1683 /* no hs or force mode, child must have sent afhi */
1684 afhi_offset = read_u16(buf + CAB_AFHI_OFFSET_POS);
1685 chunks_offset = read_u16(buf + CAB_CHUNKS_OFFSET_POS);
1687 objs[AFTCOL_AFHI].data = buf + afhi_offset;
1688 objs[AFTCOL_AFHI].size = chunks_offset - afhi_offset;
1690 if (!objs[AFTCOL_AFHI].size) /* "impossible" */
1692 objs[AFTCOL_CHUNKS].data = buf + chunks_offset;
1693 objs[AFTCOL_CHUNKS].size = query->size - chunks_offset;
1694 if (pb && !hs) { /* update pb's hash */
1695 char old_asc[2 * HASH_SIZE + 1];
1696 unsigned char *old_hash;
1697 ret = get_hash_of_row(pb, &old_hash);
1700 hash_to_asc(old_hash, old_asc);
1701 if (flags & ADD_FLAG_VERBOSE)
1702 para_printf(&msg, "file change: %s -> %s\n", old_asc,
1704 ret = osl_update_object(audio_file_table, pb, AFTCOL_HASH,
1705 &objs[AFTCOL_HASH]);
1709 if (hs || pb) { /* (hs != NULL and pb != NULL) implies hs == pb */
1710 struct osl_row *row = pb? pb : hs;
1711 /* update afhi and chunk_table */
1712 if (flags & ADD_FLAG_VERBOSE)
1713 para_printf(&msg, "updating afhi and chunk table\n");
1714 ret = osl(osl_update_object(audio_file_table, row, AFTCOL_AFHI,
1715 &objs[AFTCOL_AFHI]));
1718 ret = osl(osl_update_object(audio_file_table, row, AFTCOL_CHUNKS,
1719 &objs[AFTCOL_CHUNKS]));
1722 afs_event(AFHI_CHANGE, &msg, row);
1725 /* new entry, use default afsi */
1726 if (flags & ADD_FLAG_VERBOSE)
1727 para_printf(&msg, "new file\n");
1728 default_afsi.last_played = time(NULL) - 365 * 24 * 60 * 60;
1729 default_afsi.audio_format_id = read_u8(buf + CAB_AUDIO_FORMAT_OFFSET);
1731 objs[AFTCOL_AFSI].data = &afsi_buf;
1732 objs[AFTCOL_AFSI].size = AFSI_SIZE;
1733 save_afsi(&default_afsi, &objs[AFTCOL_AFSI]);
1734 ret = osl(osl_add_and_get_row(audio_file_table, objs, &aft_row));
1735 afs_event(AUDIO_FILE_ADD, &msg, aft_row);
1738 para_printf(&msg, "could not add %s\n", path);
1739 flush_and_free_pb(&msg);
1743 /** Used by com_add(). */
1744 struct private_add_data {
1745 /** The pointer passed to the original command handler. */
1746 struct command_context *cc;
1747 /** The given add flags. */
1751 static int path_brother_callback(int fd, const struct osl_object *query)
1753 char *path = query->data;
1754 struct osl_row *path_brother;
1755 int ret = aft_get_row_of_path(path, &path_brother);
1758 return pass_buffer_as_shm(fd, SBD_OUTPUT, (char *)&path_brother,
1759 sizeof(path_brother));
1762 static int hash_sister_callback(int fd, const struct osl_object *query)
1764 unsigned char *hash = query->data;
1765 struct osl_row *hash_sister;
1767 hash_sister = find_hash_sister(hash);
1770 return pass_buffer_as_shm(fd, SBD_OUTPUT, (char *)&hash_sister,
1771 sizeof(hash_sister));
1774 static int get_row_pointer_from_result(struct osl_object *result,
1775 __a_unused uint8_t band, void *private)
1777 struct osl_row **row = private;
1779 if (band == SBD_OUTPUT)
1780 *row = *(struct osl_row **)(result->data);
1784 static int add_one_audio_file(const char *path, void *private_data)
1786 int ret, send_ret = 1, fd;
1787 uint8_t format_num = -1;
1788 struct private_add_data *pad = private_data;
1789 struct afh_info afhi, *afhi_ptr = NULL;
1790 struct osl_row *pb = NULL, *hs = NULL; /* path brother/hash sister */
1791 struct osl_object map, obj = {.data = NULL}, query;
1792 unsigned char hash[HASH_SIZE];
1794 ret = guess_audio_format(path);
1795 if (ret < 0 && !(pad->flags & ADD_FLAG_ALL)) {
1799 query.data = (char *)path;
1800 query.size = strlen(path) + 1;
1801 ret = send_callback_request(path_brother_callback, &query,
1802 get_row_pointer_from_result, &pb);
1803 if (ret < 0 && ret != -OSL_ERRNO_TO_PARA_ERROR(E_OSL_RB_KEY_NOT_FOUND))
1806 if (pb && (pad->flags & ADD_FLAG_LAZY)) { /* lazy is really cheap */
1807 if (pad->flags & ADD_FLAG_VERBOSE)
1808 send_ret = send_sb_va(&pad->cc->scc, SBD_OUTPUT,
1809 "lazy-ignore: %s\n", path);
1812 /* We still want to add this file. Compute its hash. */
1813 ret = mmap_full_file(path, O_RDONLY, &map.data, &map.size, &fd);
1816 hash_function(map.data, map.size, hash);
1818 /* Check whether the database contains a file with the same hash. */
1820 query.size = HASH_SIZE;
1821 ret = send_callback_request(hash_sister_callback, &query,
1822 get_row_pointer_from_result, &hs);
1825 /* Return success if we already know this file. */
1827 if (pb && hs && hs == pb && !(pad->flags & ADD_FLAG_FORCE)) {
1828 if (pad->flags & ADD_FLAG_VERBOSE)
1829 send_ret = send_sb_va(&pad->cc->scc, SBD_OUTPUT,
1830 "%s exists, not forcing update\n", path);
1834 * We won't recalculate the audio format info and the chunk table if
1835 * there is a hash sister and FORCE was not given.
1837 if (!hs || (pad->flags & ADD_FLAG_FORCE)) {
1838 ret = compute_afhi(path, map.data, map.size, fd, &afhi);
1844 munmap(map.data, map.size);
1846 if (pad->flags & ADD_FLAG_VERBOSE) {
1847 send_ret = send_sb_va(&pad->cc->scc, SBD_OUTPUT,
1848 "adding %s\n", path);
1852 save_add_callback_buffer(hash, path, afhi_ptr, pad->flags, format_num, &obj);
1853 /* Ask afs to consider this entry for adding. */
1854 ret = send_callback_request(com_add_callback, &obj,
1855 afs_cb_result_handler, pad->cc);
1860 munmap(map.data, map.size);
1862 if (ret < 0 && send_ret >= 0)
1863 send_ret = send_sb_va(&pad->cc->scc, SBD_ERROR_LOG,
1864 "failed to add %s (%s)\n", path, para_strerror(-ret));
1866 clear_afhi(afhi_ptr);
1867 /* Stop adding files only on send errors. */
1871 int com_add(struct command_context *cc)
1874 struct private_add_data pad = {.cc = cc, .flags = 0};
1876 for (i = 1; i < cc->argc; i++) {
1877 const char *arg = cc->argv[i];
1880 if (!strcmp(arg, "--")) {
1884 if (!strcmp(arg, "-a")) {
1885 pad.flags |= ADD_FLAG_ALL;
1888 if (!strcmp(arg, "-l")) {
1889 pad.flags |= ADD_FLAG_LAZY;
1892 if (!strcmp(arg, "-f")) {
1893 pad.flags |= ADD_FLAG_FORCE;
1896 if (!strcmp(arg, "-v")) {
1897 pad.flags |= ADD_FLAG_VERBOSE;
1902 return -E_AFT_SYNTAX;
1903 for (; i < cc->argc; i++) {
1905 ret = verify_path(cc->argv[i], &path);
1907 ret = send_sb_va(&cc->scc, SBD_ERROR_LOG, "%s: %s\n",
1908 cc->argv[i], para_strerror(-ret));
1913 if (ret == 1) /* directory */
1914 ret = for_each_file_in_dir(path, add_one_audio_file,
1916 else /* regular file */
1917 ret = add_one_audio_file(path, &pad);
1919 send_sb_va(&cc->scc, SBD_OUTPUT, "%s: %s\n", path,
1920 para_strerror(-ret));
1930 * Flags used by the touch command.
1935 /** Whether the \p FNM_PATHNAME flag should be passed to fnmatch(). */
1936 TOUCH_FLAG_FNM_PATHNAME = 1,
1937 /** Activates verbose mode. */
1938 TOUCH_FLAG_VERBOSE = 2
1941 /** Options used by com_touch(). */
1942 struct com_touch_options {
1943 /** New num_played value. */
1945 /** New last played count. */
1946 int64_t last_played;
1947 /** New lyrics id. */
1949 /** New image id. */
1951 /** New amplification value. */
1953 /** Command line flags (see \ref touch_flags). */
1957 /** Data passed to the action handler of com_touch(). */
1958 struct touch_action_data {
1959 /** Command line options (see \ref com_touch_options). */
1960 struct com_touch_options *cto;
1961 /** Message buffer. */
1962 struct para_buffer pb;
1965 static int touch_audio_file(__a_unused struct osl_table *table,
1966 struct osl_row *row, const char *name, void *data)
1968 struct touch_action_data *tad = data;
1969 struct osl_object obj;
1970 struct afs_info old_afsi, new_afsi;
1971 int ret, no_options = tad->cto->num_played < 0 && tad->cto->last_played < 0 &&
1972 tad->cto->lyrics_id < 0 && tad->cto->image_id < 0 && tad->cto->amp < 0;
1973 struct afsi_change_event_data aced;
1975 ret = get_afsi_object_of_row(row, &obj);
1977 para_printf(&tad->pb, "cannot touch %s\n", name);
1980 ret = load_afsi(&old_afsi, &obj);
1982 para_printf(&tad->pb, "cannot touch %s\n", name);
1985 new_afsi = old_afsi;
1987 new_afsi.num_played++;
1988 new_afsi.last_played = time(NULL);
1989 if (tad->cto->flags & TOUCH_FLAG_VERBOSE)
1990 para_printf(&tad->pb, "%s: num_played = %u, "
1991 "last_played = now()\n", name,
1992 new_afsi.num_played);
1994 if (tad->cto->flags & TOUCH_FLAG_VERBOSE)
1995 para_printf(&tad->pb, "touching %s\n", name);
1996 if (tad->cto->lyrics_id >= 0)
1997 new_afsi.lyrics_id = tad->cto->lyrics_id;
1998 if (tad->cto->image_id >= 0)
1999 new_afsi.image_id = tad->cto->image_id;
2000 if (tad->cto->num_played >= 0)
2001 new_afsi.num_played = tad->cto->num_played;
2002 if (tad->cto->last_played >= 0)
2003 new_afsi.last_played = tad->cto->last_played;
2004 if (tad->cto->amp >= 0)
2005 new_afsi.amp = tad->cto->amp;
2007 save_afsi(&new_afsi, &obj); /* in-place update */
2009 aced.old_afsi = &old_afsi;
2010 afs_event(AFSI_CHANGE, &tad->pb, &aced);
2014 static int com_touch_callback(int fd, const struct osl_object *query)
2016 struct touch_action_data tad = {.cto = query->data,
2018 .max_size = shm_get_shmmax(),
2019 .private_data = &(struct afs_max_size_handler_data) {
2023 .max_size_handler = afs_max_size_handler
2027 struct pattern_match_data pmd = {
2028 .table = audio_file_table,
2029 .loop_col_num = AFTCOL_HASH,
2030 .match_col_num = AFTCOL_PATH,
2031 .patterns = {.data = (char *)query->data + sizeof(*tad.cto),
2032 .size = query->size - sizeof(*tad.cto)},
2034 .action = touch_audio_file
2036 if (tad.cto->flags & TOUCH_FLAG_FNM_PATHNAME)
2037 pmd.fnmatch_flags |= FNM_PATHNAME;
2038 ret = for_each_matching_row(&pmd);
2039 if (ret >= 0 && pmd.num_matches == 0)
2041 flush_and_free_pb(&tad.pb);
2045 int com_touch(struct command_context *cc)
2047 struct com_touch_options cto = {
2054 struct osl_object query = {.data = &cto, .size = sizeof(cto)};
2058 for (i = 1; i < cc->argc; i++) {
2059 const char *arg = cc->argv[i];
2062 if (!strcmp(arg, "--")) {
2066 if (!strncmp(arg, "-n=", 3)) {
2067 ret = para_atoi32(arg + 3, &cto.num_played);
2072 if (!strncmp(arg, "-l=", 3)) {
2073 ret = para_atoi64(arg + 3, &cto.last_played);
2078 if (!strncmp(arg, "-y=", 3)) {
2079 ret = para_atoi32(arg + 3, &cto.lyrics_id);
2084 if (!strncmp(arg, "-i=", 3)) {
2085 ret = para_atoi32(arg + 3, &cto.image_id);
2090 if (!strncmp(arg, "-a=", 3)) {
2092 ret = para_atoi32(arg + 3, &val);
2095 if (val < 0 || val > 255)
2096 return -ERRNO_TO_PARA_ERROR(EINVAL);
2100 if (!strcmp(arg, "-p")) {
2101 cto.flags |= TOUCH_FLAG_FNM_PATHNAME;
2104 if (!strcmp(arg, "-v")) {
2105 cto.flags |= TOUCH_FLAG_VERBOSE;
2108 break; /* non-option starting with dash */
2111 return -E_AFT_SYNTAX;
2112 return send_option_arg_callback_request(&query, cc->argc - i,
2113 cc->argv + i, com_touch_callback, afs_cb_result_handler, cc);
2116 /** Flags for com_rm(). */
2119 RM_FLAG_VERBOSE = 1,
2123 RM_FLAG_FNM_PATHNAME = 4
2126 /** Data passed to the action handler of com_rm(). */
2127 struct com_rm_action_data {
2128 /** Command line flags ((see \ref rm_flags). */
2130 /** Message buffer. */
2131 struct para_buffer pb;
2134 static int remove_audio_file(__a_unused struct osl_table *table,
2135 struct osl_row *row, const char *name, void *data)
2137 struct com_rm_action_data *crd = data;
2140 if (crd->flags & RM_FLAG_VERBOSE)
2141 para_printf(&crd->pb, "removing %s\n", name);
2142 afs_event(AUDIO_FILE_REMOVE, &crd->pb, row);
2143 ret = osl(osl_del_row(audio_file_table, row));
2145 para_printf(&crd->pb, "%s: %s\n", name, para_strerror(-ret));
2149 static int com_rm_callback(int fd, const struct osl_object *query)
2151 struct com_rm_action_data crd = {.flags = *(uint32_t *)query->data,
2153 .max_size = shm_get_shmmax(),
2154 .private_data = &(struct afs_max_size_handler_data) {
2158 .max_size_handler = afs_max_size_handler
2162 struct pattern_match_data pmd = {
2163 .table = audio_file_table,
2164 .loop_col_num = AFTCOL_HASH,
2165 .match_col_num = AFTCOL_PATH,
2166 .patterns = {.data = (char *)query->data + sizeof(uint32_t),
2167 .size = query->size - sizeof(uint32_t)},
2169 .action = remove_audio_file
2171 if (crd.flags & RM_FLAG_FNM_PATHNAME)
2172 pmd.fnmatch_flags |= FNM_PATHNAME;
2173 ret = for_each_matching_row(&pmd);
2175 para_printf(&crd.pb, "%s\n", para_strerror(-ret));
2178 if ((pmd.num_matches == 0) && !(crd.flags & RM_FLAG_FORCE))
2179 para_printf(&crd.pb, "no matches -- nothing removed\n");
2180 else if (crd.flags & RM_FLAG_VERBOSE)
2181 para_printf(&crd.pb, "removed %u files\n", pmd.num_matches);
2182 flush_and_free_pb(&crd.pb);
2186 /* TODO options: -r (recursive) */
2187 int com_rm(struct command_context *cc)
2190 struct osl_object query = {.data = &flags, .size = sizeof(flags)};
2193 for (i = 1; i < cc->argc; i++) {
2194 const char *arg = cc->argv[i];
2197 if (!strcmp(arg, "--")) {
2201 if (!strcmp(arg, "-f")) {
2202 flags |= RM_FLAG_FORCE;
2205 if (!strcmp(arg, "-p")) {
2206 flags |= RM_FLAG_FNM_PATHNAME;
2209 if (!strcmp(arg, "-v")) {
2210 flags |= RM_FLAG_VERBOSE;
2216 return -E_AFT_SYNTAX;
2217 ret = send_option_arg_callback_request(&query, cc->argc - i,
2218 cc->argv + i, com_rm_callback, afs_cb_result_handler, cc);
2220 send_strerror(cc, -ret);
2225 * Flags used by the cpsi command.
2230 /** Whether the lyrics id should be copied. */
2231 CPSI_FLAG_COPY_LYRICS_ID = 1,
2232 /** Whether the image id should be copied. */
2233 CPSI_FLAG_COPY_IMAGE_ID = 2,
2234 /** Whether the lastplayed time should be copied. */
2235 CPSI_FLAG_COPY_LASTPLAYED = 4,
2236 /** Whether the numplayed count should be copied. */
2237 CPSI_FLAG_COPY_NUMPLAYED = 8,
2238 /** Whether the attributes should be copied. */
2239 CPSI_FLAG_COPY_ATTRIBUTES = 16,
2240 /** Activates verbose mode. */
2241 CPSI_FLAG_VERBOSE = 32,
2244 /** Data passed to the action handler of com_cpsi(). */
2245 struct cpsi_action_data {
2246 /** command line flags (see \ref cpsi_flags). */
2248 /** Message buffer. */
2249 struct para_buffer pb;
2250 /** Values are copied from here. */
2251 struct afs_info source_afsi;
2254 static int copy_selector_info(__a_unused struct osl_table *table,
2255 struct osl_row *row, const char *name, void *data)
2257 struct cpsi_action_data *cad = data;
2258 struct osl_object target_afsi_obj;
2260 struct afs_info old_afsi, target_afsi;
2261 struct afsi_change_event_data aced;
2263 ret = get_afsi_object_of_row(row, &target_afsi_obj);
2266 load_afsi(&target_afsi, &target_afsi_obj);
2267 old_afsi = target_afsi;
2268 if (cad->flags & CPSI_FLAG_COPY_LYRICS_ID)
2269 target_afsi.lyrics_id = cad->source_afsi.lyrics_id;
2270 if (cad->flags & CPSI_FLAG_COPY_IMAGE_ID)
2271 target_afsi.image_id = cad->source_afsi.image_id;
2272 if (cad->flags & CPSI_FLAG_COPY_LASTPLAYED)
2273 target_afsi.last_played = cad->source_afsi.last_played;
2274 if (cad->flags & CPSI_FLAG_COPY_NUMPLAYED)
2275 target_afsi.num_played = cad->source_afsi.num_played;
2276 if (cad->flags & CPSI_FLAG_COPY_ATTRIBUTES)
2277 target_afsi.attributes = cad->source_afsi.attributes;
2278 save_afsi(&target_afsi, &target_afsi_obj); /* in-place update */
2279 if (cad->flags & CPSI_FLAG_VERBOSE)
2280 para_printf(&cad->pb, "copied afsi to %s\n", name);
2282 aced.old_afsi = &old_afsi;
2283 afs_event(AFSI_CHANGE, &cad->pb, &aced);
2287 static int com_cpsi_callback(int fd, const struct osl_object *query)
2289 struct cpsi_action_data cad = {
2290 .flags = *(unsigned *)query->data,
2292 .max_size = shm_get_shmmax(),
2293 .private_data = &(struct afs_max_size_handler_data) {
2297 .max_size_handler = afs_max_size_handler
2301 char *source_path = (char *)query->data + sizeof(cad.flags);
2302 struct pattern_match_data pmd = {
2303 .table = audio_file_table,
2304 .loop_col_num = AFTCOL_HASH,
2305 .match_col_num = AFTCOL_PATH,
2306 .patterns = {.data = source_path + strlen(source_path) + 1,
2307 .size = query->size - sizeof(cad.flags)
2308 - strlen(source_path) - 1},
2310 .action = copy_selector_info
2313 ret = get_afsi_of_path(source_path, &cad.source_afsi);
2316 ret = for_each_matching_row(&pmd);
2319 para_printf(&cad.pb, "%s\n", para_strerror(-ret));
2320 else if (pmd.num_matches > 0) {
2321 if (cad.flags & CPSI_FLAG_VERBOSE)
2322 para_printf(&cad.pb, "copied requested afsi from %s "
2323 "to %u files\n", source_path, pmd.num_matches);
2325 para_printf(&cad.pb, "no matches - nothing copied\n");
2326 flush_and_free_pb(&cad.pb);
2330 int com_cpsi(struct command_context *cc)
2334 struct osl_object options = {.data = &flags, .size = sizeof(flags)};
2336 for (i = 1; i < cc->argc; i++) {
2337 const char *arg = cc->argv[i];
2340 if (!strcmp(arg, "--")) {
2344 if (!strcmp(arg, "-y")) {
2345 flags |= CPSI_FLAG_COPY_LYRICS_ID;
2348 if (!strcmp(arg, "-i")) {
2349 flags |= CPSI_FLAG_COPY_IMAGE_ID;
2352 if (!strcmp(arg, "-l")) {
2353 flags |= CPSI_FLAG_COPY_LASTPLAYED;
2356 if (!strcmp(arg, "-n")) {
2357 flags |= CPSI_FLAG_COPY_NUMPLAYED;
2360 if (!strcmp(arg, "-a")) {
2361 flags |= CPSI_FLAG_COPY_ATTRIBUTES;
2364 if (!strcmp(arg, "-v")) {
2365 flags |= CPSI_FLAG_VERBOSE;
2370 if (i + 1 >= cc->argc) /* need at least source file and pattern */
2371 return -E_AFT_SYNTAX;
2372 if (!(flags & ~CPSI_FLAG_VERBOSE)) /* no copy flags given */
2373 flags = ~(unsigned)CPSI_FLAG_VERBOSE | flags;
2374 ret = send_option_arg_callback_request(&options, cc->argc - i,
2375 cc->argv + i, com_cpsi_callback, afs_cb_result_handler, cc);
2377 send_strerror(cc, -ret);
2381 struct change_atts_data {
2382 uint64_t add_mask, del_mask;
2383 struct para_buffer pb;
2386 static int change_atts(__a_unused struct osl_table *table,
2387 struct osl_row *row, __a_unused const char *name, void *data)
2390 struct osl_object obj;
2391 struct afs_info old_afsi, new_afsi;
2392 struct afsi_change_event_data aced = {
2394 .old_afsi = &old_afsi
2396 struct change_atts_data *cad = data;
2398 ret = get_afsi_object_of_row(row, &obj);
2401 ret = load_afsi(&old_afsi, &obj);
2404 new_afsi = old_afsi;
2405 new_afsi.attributes |= cad->add_mask;
2406 new_afsi.attributes &= ~cad->del_mask;
2407 save_afsi(&new_afsi, &obj); /* in-place update */
2408 afs_event(AFSI_CHANGE, &cad->pb, &aced);
2412 static int com_setatt_callback(int fd, const struct osl_object *query)
2417 struct change_atts_data cad = {
2419 .max_size = shm_get_shmmax(),
2420 .max_size_handler = afs_max_size_handler,
2421 .private_data = &(struct afs_max_size_handler_data) {
2427 struct pattern_match_data pmd = {
2428 .table = audio_file_table,
2429 .loop_col_num = AFTCOL_HASH,
2430 .match_col_num = AFTCOL_PATH,
2431 .pm_flags = PM_SKIP_EMPTY_NAME,
2433 .action = change_atts
2436 for (p = query->data; p < (char *)query->data + query->size; p += len + 1) {
2438 unsigned char bitnum;
2441 ret = -E_ATTR_SYNTAX;
2445 if (c != '+' && c != '-')
2448 ret = get_attribute_bitnum_by_name(p, &bitnum);
2450 para_printf(&cad.pb, "attribute not found: %s\n", p);
2454 cad.add_mask |= (1UL << bitnum);
2456 cad.del_mask |= (1UL << bitnum);
2458 ret = -E_ATTR_SYNTAX;
2459 if (!cad.add_mask && !cad.del_mask)
2461 pmd.patterns.data = p;
2462 assert(p < (char *)query->data + query->size);
2463 pmd.patterns.size = (char *)query->data + query->size - p;
2464 ret = for_each_matching_row(&pmd);
2467 if (pmd.num_matches == 0)
2468 para_printf(&cad.pb, "no matches\n");
2471 para_printf(&cad.pb, "%s\n", para_strerror(-ret));
2472 flush_and_free_pb(&cad.pb);
2476 int com_setatt(struct command_context *cc)
2479 return -E_ATTR_SYNTAX;
2480 return send_standard_callback_request(cc->argc - 1, cc->argv + 1,
2481 com_setatt_callback, afs_cb_result_handler, cc);
2484 static int afs_stat_callback(int fd, const struct osl_object *query)
2486 int *parser_friendly = query->data;
2487 char *buf = *parser_friendly?
2488 parser_friendly_status_items : status_items;
2492 return pass_buffer_as_shm(fd, SBD_OUTPUT, buf, strlen(buf));
2496 * Get the current afs status items from the afs process and send it.
2498 * \param cc The command context, used e.g. for data encryption.
2499 * \param parser_friendly Whether parser-friendly output format should be used.
2501 * As the contents of the afs status items change in time and the command
2502 * handler only has a COW version created at fork time, it can not send
2503 * up-to-date afs status items directly. Therefore the usual callback mechanism
2504 * is used to pass the status items from the afs process to the command handler
2505 * via a shared memory area and a pipe.
2507 * \return The return value of the underlying call to \ref send_callback_request().
2509 int send_afs_status(struct command_context *cc, int parser_friendly)
2511 struct osl_object query = {.data = &parser_friendly,
2512 .size = sizeof(parser_friendly)};
2514 return send_callback_request(afs_stat_callback, &query,
2515 afs_cb_result_handler, cc);
2518 /* returns success even on errors to keep the loop going */
2519 static int check_audio_file(struct osl_row *row, void *data)
2522 struct para_buffer *pb = data;
2523 struct stat statbuf;
2524 int ret = get_audio_file_path_of_row(row, &path);
2525 struct afs_info afsi;
2529 para_printf(pb, "%s\n", para_strerror(-ret));
2532 if (stat(path, &statbuf) < 0)
2533 para_printf(pb, "%s: stat error (%s)\n", path, strerror(errno));
2534 else if (!S_ISREG(statbuf.st_mode))
2535 para_printf(pb, "%s: not a regular file\n", path);
2536 ret = get_afsi_of_row(row, &afsi);
2538 para_printf(pb, "%s: %s\n", path, para_strerror(-ret));
2541 ret = lyr_get_name_by_id(afsi.lyrics_id, &blob_name);
2543 para_printf(pb, "%s lyrics id %u: %s\n", path, afsi.lyrics_id,
2544 para_strerror(-ret));
2545 ret = img_get_name_by_id(afsi.image_id, &blob_name);
2547 para_printf(pb, "%s image id %u: %s\n", path, afsi.image_id,
2548 para_strerror(-ret));
2553 * Check the audio file table for inconsistencies.
2555 * \param fd The afs socket.
2556 * \param query Unused.
2558 * \return This function always returns zero.
2562 int aft_check_callback(int fd, __a_unused const struct osl_object *query)
2564 struct para_buffer pb = {
2565 .max_size = shm_get_shmmax(),
2566 .private_data = &(struct afs_max_size_handler_data) {
2570 .max_size_handler = afs_max_size_handler
2572 para_printf(&pb, "checking audio file table...\n");
2573 audio_file_loop(&pb, check_audio_file);
2574 flush_and_free_pb(&pb);
2579 * Close the audio file table.
2581 * \param flags Usual flags that are passed to osl_close_table().
2583 * \sa osl_close_table().
2585 static void aft_close(void)
2587 osl_close_table(audio_file_table, OSL_MARK_CLEAN);
2588 audio_file_table = NULL;
2592 * Open the audio file table.
2594 * \param dir The database directory.
2598 * \sa osl_open_table().
2600 static int aft_open(const char *dir)
2604 audio_file_table_desc.dir = dir;
2605 ret = osl(osl_open_table(&audio_file_table_desc, &audio_file_table));
2608 osl_get_num_rows(audio_file_table, &num);
2609 PARA_INFO_LOG("audio file table contains %d files\n", num);
2612 PARA_NOTICE_LOG("failed to open audio file table\n");
2613 audio_file_table = NULL;
2614 if (ret == -OSL_ERRNO_TO_PARA_ERROR(E_OSL_NOENT))
2619 static int aft_create(const char *dir)
2621 audio_file_table_desc.dir = dir;
2622 return osl(osl_create_table(&audio_file_table_desc));
2625 static int clear_attribute(struct osl_row *row, void *data)
2627 struct rmatt_event_data *red = data;
2628 struct afs_info afsi;
2629 struct osl_object obj;
2630 int ret = get_afsi_object_of_row(row, &obj);
2631 uint64_t mask = ~(1ULL << red->bitnum);
2635 ret = load_afsi(&afsi, &obj);
2638 afsi.attributes &= mask;
2639 save_afsi(&afsi, &obj);
2643 static int aft_event_handler(enum afs_events event, struct para_buffer *pb,
2649 case ATTRIBUTE_REMOVE: {
2650 const struct rmatt_event_data *red = data;
2651 para_printf(pb, "clearing attribute %s (bit %u) from all "
2652 "entries in the audio file table\n", red->name,
2654 return audio_file_loop(data, clear_attribute);
2655 } case AFSI_CHANGE: {
2656 struct afsi_change_event_data *aced = data;
2657 uint64_t old_last_played = status_item_ls_data.afsi.last_played;
2658 if (aced->aft_row != current_aft_row)
2660 ret = get_afsi_of_row(aced->aft_row, &status_item_ls_data.afsi);
2663 status_item_ls_data.afsi.last_played = old_last_played;
2664 make_status_items();
2666 } case AFHI_CHANGE: {
2667 if (data != current_aft_row)
2669 ret = get_afhi_of_row(data, &status_item_ls_data.afhi);
2672 make_status_items();
2680 * Initialize the audio file table.
2682 * \param t Pointer to the structure to be initialized.
2684 void aft_init(struct afs_table *t)
2687 t->close = aft_close;
2688 t->create = aft_create;
2689 t->event_handler = aft_event_handler;