2 * Copyright (C) 2007-2012 Andre Noll <maan@systemlinux.org>
4 * Licensed under the GPL v2. For licencing details see COPYING.
7 /** \file aft.c Audio file table functions. */
23 #include "portable_io.h"
26 static struct osl_table
*audio_file_table
;
27 static char *status_items
;
28 static char *parser_friendly_status_items
;
30 /** The different sorting methods of the ls command. */
31 enum ls_sorting_method
{
37 LS_SORT_BY_LAST_PLAYED
,
39 LS_SORT_BY_NUM_PLAYED
,
53 LS_SORT_BY_AUDIO_FORMAT
,
58 /** The different listing modes of the ls command. */
59 enum ls_listing_mode
{
60 /** Default listing mode. */
74 /** The flags accepted by the ls command. */
77 LS_FLAG_FULL_PATH
= 1,
79 LS_FLAG_ADMISSIBLE_ONLY
= 2,
87 * The size of the individual output fields of the ls command.
89 * These depend on the actual content being listed. If, for instance only files
90 * with duration less than an hour are being listed, then the duration with is
91 * made smaller because then the duration is listed as mm:ss rather than
95 /** size of the score field. */
96 unsigned short score_width
;
97 /** size of the image id field. */
98 unsigned short image_id_width
;
99 /** size of the lyrics id field. */
100 unsigned short lyrics_id_width
;
101 /** size of the bitrate field. */
102 unsigned short bitrate_width
;
103 /** size of the frequency field. */
104 unsigned short frequency_width
;
105 /** size of the duration field. */
106 unsigned short duration_width
;
107 /** size of the num played field. */
108 unsigned short num_played_width
;
109 /** size of the amp field. */
110 unsigned short amp_width
;
111 /** size of the audio format field. */
112 unsigned short audio_format_width
;
115 /** Data passed from the ls command handler to its callback function. */
117 /** The given command line flags. */
119 /** The sorting method given at the command line. */
120 enum ls_sorting_method sorting
;
121 /** The given listing mode (short, long, verbose, mbox). */
122 enum ls_listing_mode mode
;
123 /** The arguments passed to the ls command. */
125 /** Number of non-option arguments. */
127 /** Used for long listing mode to align the output fields. */
128 struct ls_widths widths
;
129 /** Size of the \a data array. */
131 /** Number of used entries in the data array. */
132 uint32_t num_matching_paths
;
133 /** Array of matching entries. */
134 struct ls_data
*data
;
135 /** Used to sort the array. */
136 struct ls_data
**data_ptr
;
140 * Describes the layout of the mmapped-afs info struct.
142 * \sa struct afs_info.
145 /** Where .last_played is stored. */
146 AFSI_LAST_PLAYED_OFFSET
= 0,
147 /** Storage position of the attributes bitmap. */
148 AFSI_ATTRIBUTES_OFFSET
= 8,
149 /** Storage position of the .num_played field. */
150 AFSI_NUM_PLAYED_OFFSET
= 16,
151 /** Storage position of the .image_id field. */
152 AFSI_IMAGE_ID_OFFSET
= 20,
153 /** Storage position of the .lyrics_id field. */
154 AFSI_LYRICS_ID_OFFSET
= 24,
155 /** Storage position of the .audio_format_id field. */
156 AFSI_AUDIO_FORMAT_ID_OFFSET
= 28,
157 /** Storage position of the amplification field. */
158 AFSI_AMP_OFFSET
= 29,
159 /** 2 bytes reserved space for future usage. */
160 AFSI_AUDIO_FORMAT_UNUSED_OFFSET
= 30,
161 /** On-disk storage space needed. */
166 * Convert a struct afs_info to an osl object.
168 * \param afsi Pointer to the audio file info to be converted.
169 * \param obj Result pointer.
173 void save_afsi(struct afs_info
*afsi
, struct osl_object
*obj
)
175 char *buf
= obj
->data
;
177 write_u64(buf
+ AFSI_LAST_PLAYED_OFFSET
, afsi
->last_played
);
178 write_u64(buf
+ AFSI_ATTRIBUTES_OFFSET
, afsi
->attributes
);
179 write_u32(buf
+ AFSI_NUM_PLAYED_OFFSET
, afsi
->num_played
);
180 write_u32(buf
+ AFSI_IMAGE_ID_OFFSET
, afsi
->image_id
);
181 write_u32(buf
+ AFSI_LYRICS_ID_OFFSET
, afsi
->lyrics_id
);
182 write_u8(buf
+ AFSI_AUDIO_FORMAT_ID_OFFSET
,
183 afsi
->audio_format_id
);
184 write_u8(buf
+ AFSI_AMP_OFFSET
, afsi
->amp
);
185 memset(buf
+ AFSI_AUDIO_FORMAT_UNUSED_OFFSET
, 0, 2);
189 * Get the audio file selector info struct stored in an osl object.
191 * \param afsi Points to the audio_file info structure to be filled in.
192 * \param obj The osl object holding the data.
194 * \return Positive on success, negative on errors. Possible errors: \p E_BAD_AFS.
198 int load_afsi(struct afs_info
*afsi
, struct osl_object
*obj
)
200 char *buf
= obj
->data
;
201 if (obj
->size
< AFSI_SIZE
)
203 afsi
->last_played
= read_u64(buf
+ AFSI_LAST_PLAYED_OFFSET
);
204 afsi
->attributes
= read_u64(buf
+ AFSI_ATTRIBUTES_OFFSET
);
205 afsi
->num_played
= read_u32(buf
+ AFSI_NUM_PLAYED_OFFSET
);
206 afsi
->image_id
= read_u32(buf
+ AFSI_IMAGE_ID_OFFSET
);
207 afsi
->lyrics_id
= read_u32(buf
+ AFSI_LYRICS_ID_OFFSET
);
208 afsi
->audio_format_id
= read_u8(buf
+
209 AFSI_AUDIO_FORMAT_ID_OFFSET
);
210 afsi
->amp
= read_u8(buf
+ AFSI_AMP_OFFSET
);
214 /** The columns of the audio file table. */
215 enum audio_file_table_columns
{
216 /** The hash on the content of the audio file. */
218 /** The full path in the filesystem. */
220 /** The audio file selector info. */
222 /** The audio format handler info. */
224 /** The chunk table info and the chunk table of the audio file. */
226 /** The number of columns of this table. */
231 * Compare two osl objects pointing to hash values.
233 * \param obj1 Pointer to the first hash object.
234 * \param obj2 Pointer to the second hash object.
236 * \return The values required for an osl compare function.
238 * \sa osl_compare_func, uint32_compare().
240 static int aft_hash_compare(const struct osl_object
*obj1
, const struct osl_object
*obj2
)
242 return hash_compare((unsigned char *)obj1
->data
, (unsigned char *)obj2
->data
);
245 static struct osl_column_description aft_cols
[] = {
247 .storage_type
= OSL_MAPPED_STORAGE
,
248 .storage_flags
= OSL_RBTREE
| OSL_FIXED_SIZE
| OSL_UNIQUE
,
250 .compare_function
= aft_hash_compare
,
251 .data_size
= HASH_SIZE
254 .storage_type
= OSL_MAPPED_STORAGE
,
255 .storage_flags
= OSL_RBTREE
| OSL_UNIQUE
,
257 .compare_function
= string_compare
,
260 .storage_type
= OSL_MAPPED_STORAGE
,
261 .storage_flags
= OSL_FIXED_SIZE
,
263 .data_size
= AFSI_SIZE
266 .storage_type
= OSL_MAPPED_STORAGE
,
270 .storage_type
= OSL_DISK_STORAGE
,
275 static struct osl_table_description audio_file_table_desc
= {
276 .name
= "audio_files",
277 .num_columns
= NUM_AFT_COLUMNS
,
278 .flags
= OSL_LARGE_TABLE
,
279 .column_descriptions
= aft_cols
282 /* We don't want * dot or dot-dot anywhere. */
283 static int verify_dotfile(const char *rest
)
286 * The first character was '.', but that has already been discarded, we
290 case '\0': case '/': /* /foo/. and /foo/./bar are not ok */
292 case '.': /* path start with /foo/.. */
293 if (rest
[1] == '\0' || rest
[1] == '/')
294 return -1; /* /foo/.. or /foo/../bar are not ok */
295 /* /foo/..bar is ok */
301 * We fundamentally don't like some paths: We don't want double slashes or
302 * slashes at the end that can make pathnames ambiguous.
304 static int verify_path(const char *orig_path
, char **resolved_path
)
310 if (*orig_path
!= '/') /* we only accept absolute paths */
312 len
= strlen(orig_path
);
313 *resolved_path
= para_strdup(orig_path
);
314 path
= *resolved_path
;
315 while (len
> 1 && path
[--len
] == '/')
316 path
[len
] = '\0'; /* remove slash at the end */
322 case '/': /* double slash */
325 if (verify_dotfile(path
) < 0)
335 free(*resolved_path
);
339 /** The on-disk layout of a afhi struct. */
341 /** Where the number of seconds is stored. */
342 AFHI_SECONDS_TOTAL_OFFSET
= 0,
343 /** Position of the bitrate. */
344 AFHI_BITRATE_OFFSET
= 4,
345 /** Position of the frequency. */
346 AFHI_FREQUENCY_OFFSET
= 8,
347 /** Was: Location of the audio file header. */
348 AFHI_UNUSED1_OFFSET
= 12,
349 /* Length of the audio file header. Zero means: No header. */
350 AFHI_HEADER_LEN_OFFSET
= 16,
351 /** The total number of chunks (4 bytes). */
352 CHUNKS_TOTAL_OFFSET
= 20,
353 /** The length of the audio file header (4 bytes). */
354 HEADER_LEN_OFFSET
= 24,
355 /** Was: The start of the audio file header (4 bytes). */
356 AFHI_UNUSED2_OFFSET
= 28,
357 /** The seconds part of the chunk time (4 bytes). */
358 CHUNK_TV_TV_SEC_OFFSET
= 32,
359 /** The microseconds part of the chunk time (4 bytes). */
360 CHUNK_TV_TV_USEC_OFFSET
= 36,
361 /** Number of channels is stored here. (1 byte) */
362 AFHI_CHANNELS_OFFSET
= 40,
363 /** The tag info position. */
364 AFHI_INFO_STRING_OFFSET
= 41,
365 /** Minimal on-disk size of a valid afhi struct. */
366 MIN_AFHI_SIZE
= 47, /* at least 6 null bytes for techinfo/tags */
369 static unsigned sizeof_afhi_buf(const struct afh_info
*afhi
)
374 + strlen(afhi
->techinfo
)
375 + strlen(afhi
->tags
.artist
)
376 + strlen(afhi
->tags
.title
)
377 + strlen(afhi
->tags
.year
)
378 + strlen(afhi
->tags
.album
)
379 + strlen(afhi
->tags
.comment
);
382 static void save_afhi(struct afh_info
*afhi
, char *buf
)
388 write_u32(buf
+ AFHI_SECONDS_TOTAL_OFFSET
, afhi
->seconds_total
);
389 write_u32(buf
+ AFHI_BITRATE_OFFSET
, afhi
->bitrate
);
390 write_u32(buf
+ AFHI_FREQUENCY_OFFSET
, afhi
->frequency
);
391 write_u32(buf
+ AFHI_UNUSED1_OFFSET
, 0);
392 write_u32(buf
+ AFHI_HEADER_LEN_OFFSET
, afhi
->header_len
);
393 write_u8(buf
+ AFHI_CHANNELS_OFFSET
, afhi
->channels
);
394 write_u32(buf
+ CHUNKS_TOTAL_OFFSET
, afhi
->chunks_total
);
395 write_u32(buf
+ HEADER_LEN_OFFSET
, afhi
->header_len
);
396 write_u32(buf
+ AFHI_UNUSED2_OFFSET
, 0);
397 write_u32(buf
+ CHUNK_TV_TV_SEC_OFFSET
, afhi
->chunk_tv
.tv_sec
);
398 write_u32(buf
+ CHUNK_TV_TV_USEC_OFFSET
, afhi
->chunk_tv
.tv_usec
);
399 p
= buf
+ AFHI_INFO_STRING_OFFSET
;
400 /* The sprintf's below are OK as our caller made sure that buf is large enough */
401 p
+= sprintf(p
, "%s", afhi
->techinfo
) + 1;
402 p
+= sprintf(p
, "%s", afhi
->tags
.artist
) + 1;
403 p
+= sprintf(p
, "%s", afhi
->tags
.title
) + 1;
404 p
+= sprintf(p
, "%s", afhi
->tags
.year
) + 1;
405 p
+= sprintf(p
, "%s", afhi
->tags
.album
) + 1;
406 sprintf(p
, "%s", afhi
->tags
.comment
);
409 static void load_afhi(const char *buf
, struct afh_info
*afhi
)
411 afhi
->seconds_total
= read_u32(buf
+ AFHI_SECONDS_TOTAL_OFFSET
);
412 afhi
->bitrate
= read_u32(buf
+ AFHI_BITRATE_OFFSET
);
413 afhi
->frequency
= read_u32(buf
+ AFHI_FREQUENCY_OFFSET
);
414 afhi
->header_len
= read_u32(buf
+ AFHI_HEADER_LEN_OFFSET
);
415 afhi
->channels
= read_u8(buf
+ AFHI_CHANNELS_OFFSET
);
416 afhi
->chunks_total
= read_u32(buf
+ CHUNKS_TOTAL_OFFSET
);
417 afhi
->header_len
= read_u32(buf
+ HEADER_LEN_OFFSET
);
418 afhi
->chunk_tv
.tv_sec
= read_u32(buf
+ CHUNK_TV_TV_SEC_OFFSET
);
419 afhi
->chunk_tv
.tv_usec
= read_u32(buf
+ CHUNK_TV_TV_USEC_OFFSET
);
420 afhi
->techinfo
= (char *)buf
+ AFHI_INFO_STRING_OFFSET
;
421 afhi
->tags
.artist
= afhi
->techinfo
+ strlen(afhi
->techinfo
) + 1;
422 afhi
->tags
.title
= afhi
->tags
.artist
+ strlen(afhi
->tags
.artist
) + 1;
423 afhi
->tags
.year
= afhi
->tags
.title
+ strlen(afhi
->tags
.title
) + 1;
424 afhi
->tags
.album
= afhi
->tags
.year
+ strlen(afhi
->tags
.year
) + 1;
425 afhi
->tags
.comment
= afhi
->tags
.album
+ strlen(afhi
->tags
.album
) + 1;
428 static unsigned sizeof_chunk_table(struct afh_info
*afhi
)
432 return 4 * (afhi
->chunks_total
+ 1);
435 static uint32_t save_chunk_table(struct afh_info
*afhi
, char *buf
)
438 uint32_t max
= 0, old
= 0;
440 for (i
= 0; i
<= afhi
->chunks_total
; i
++) {
441 uint32_t val
= afhi
->chunk_table
[i
];
442 write_u32(buf
+ 4 * i
, val
);
444 * If the first chunk is the header, do not consider it for the
445 * calculation of the largest chunk size.
447 if (i
== 0 || (i
== 1 && afhi
->header_len
> 0)) {
451 max
= PARA_MAX(max
, val
- old
);
457 static void load_chunk_table(struct afh_info
*afhi
, char *buf
)
461 afhi
->chunk_table
= para_malloc(sizeof_chunk_table(afhi
));
462 for (i
= 0; i
<= afhi
->chunks_total
; i
++)
463 afhi
->chunk_table
[i
] = read_u32(buf
+ 4 * i
);
467 * Get the row of the audio file table corresponding to the given path.
469 * \param path The full path of the audio file.
470 * \param row Result pointer.
474 int aft_get_row_of_path(const char *path
, struct osl_row
**row
)
476 struct osl_object obj
= {.data
= (char *)path
, .size
= strlen(path
) + 1};
478 return osl(osl_get_row(audio_file_table
, AFTCOL_PATH
, &obj
, row
));
482 * Get the row of the audio file table corresponding to the given hash value.
484 * \param hash The hash value of the desired audio file.
485 * \param row Result pointer.
489 static int aft_get_row_of_hash(unsigned char *hash
, struct osl_row
**row
)
491 const struct osl_object obj
= {.data
= hash
, .size
= HASH_SIZE
};
492 return osl(osl_get_row(audio_file_table
, AFTCOL_HASH
, &obj
, row
));
496 * Get the osl object holding the audio file selector info of a row.
498 * \param row Pointer to a row in the audio file table.
499 * \param obj Result pointer.
503 int get_afsi_object_of_row(const struct osl_row
*row
, struct osl_object
*obj
)
505 return osl(osl_get_object(audio_file_table
, row
, AFTCOL_AFSI
, obj
));
509 * Get the osl object holding the audio file selector info, given a path.
512 * \param path The full path of the audio file.
513 * \param obj Result pointer.
515 * \return Positive on success, negative on errors.
517 static int get_afsi_object_of_path(const char *path
, struct osl_object
*obj
)
520 int ret
= aft_get_row_of_path(path
, &row
);
523 return get_afsi_object_of_row(row
, obj
);
527 * Get the audio file selector info, given a row of the audio file table.
529 * \param row Pointer to a row in the audio file table.
530 * \param afsi Result pointer.
532 * \return Positive on success, negative on errors.
534 int get_afsi_of_row(const struct osl_row
*row
, struct afs_info
*afsi
)
536 struct osl_object obj
;
537 int ret
= get_afsi_object_of_row(row
, &obj
);
540 return load_afsi(afsi
, &obj
);
544 * Get the audio file selector info, given the path of an audio table.
546 * \param path The full path of the audio file.
547 * \param afsi Result pointer.
549 * \return Positive on success, negative on errors.
551 int get_afsi_of_path(const char *path
, struct afs_info
*afsi
)
553 struct osl_object obj
;
554 int ret
= get_afsi_object_of_path(path
, &obj
);
557 return load_afsi(afsi
, &obj
);
561 * Get the path of an audio file, given a row of the audio file table.
563 * \param row Pointer to a row in the audio file table.
564 * \param path Result pointer.
566 * The result is a pointer to mmapped data. The caller must not attempt
571 int get_audio_file_path_of_row(const struct osl_row
*row
, char **path
)
573 struct osl_object path_obj
;
574 int ret
= osl(osl_get_object(audio_file_table
, row
, AFTCOL_PATH
,
578 *path
= path_obj
.data
;
583 * Get the object containing the hash value of an audio file, given a row.
585 * \param row Pointer to a row of the audio file table.
586 * \param obj Result pointer.
588 * \return The return value of the underlying call to osl_get_object().
590 * \sa get_hash_of_row().
592 static int get_hash_object_of_aft_row(const struct osl_row
*row
,
593 struct osl_object
*obj
)
595 return osl(osl_get_object(audio_file_table
, row
, AFTCOL_HASH
, obj
));
599 * Get the hash value of an audio file, given a row of the audio file table.
601 * \param row Pointer to a row of the audio file table.
602 * \param hash Result pointer.
604 * \a hash points to mapped data and must not be freed by the caller.
606 * \return The return value of the underlying call to
607 * get_hash_object_of_aft_row().
609 static int get_hash_of_row(const struct osl_row
*row
, unsigned char **hash
)
611 struct osl_object obj
;
612 int ret
= get_hash_object_of_aft_row(row
, &obj
);
621 * Get the audio format handler info, given a row of the audio file table.
623 * \param row Pointer to a row of the audio file table.
624 * \param afhi Result pointer.
626 * \return The return value of the underlying call to osl_get_object().
628 * \sa get_chunk_table_of_row().
630 int get_afhi_of_row(const struct osl_row
*row
, struct afh_info
*afhi
)
632 struct osl_object obj
;
633 int ret
= osl(osl_get_object(audio_file_table
, row
, AFTCOL_AFHI
,
637 load_afhi(obj
.data
, afhi
);
641 /* returns shmid on success */
642 static int save_afd(struct audio_file_data
*afd
)
644 size_t size
= sizeof(*afd
) + sizeof_chunk_table(&afd
->afhi
);
645 int shmid
, ret
= shm_new(size
);
652 ret
= shm_attach(shmid
, ATTACH_RW
, &shm_afd
);
657 afd
->max_chunk_size
= save_chunk_table(&afd
->afhi
, buf
);
658 *(struct audio_file_data
*)shm_afd
= *afd
;
667 * Extract a afd stored in a shared memory area.
669 * Attach the shared memory area given by \a shmid, load the audio file data
670 * stored therein and detach the area afterwards. Called by vss, after
671 * receiving a positive response to the request for the next audio file.
673 * \param shmid The identifier of the shared memory area containing the afd.
674 * \param afd Result pointer.
678 int load_afd(int shmid
, struct audio_file_data
*afd
)
684 ret
= shm_attach(shmid
, ATTACH_RO
, &shm_afd
);
687 *afd
= *(struct audio_file_data
*)shm_afd
;
690 load_chunk_table(&afd
->afhi
, buf
);
695 static int get_local_time(uint64_t *seconds
, char *buf
, size_t size
,
696 time_t current_time
, enum ls_listing_mode lm
)
700 if (!localtime_r((time_t *)seconds
, &t
))
702 if (lm
== LS_MODE_MBOX
) {
703 if (!strftime(buf
, size
, "%c", &t
))
707 if (*seconds
+ 6 * 30 * 24 * 3600 > current_time
) {
708 if (!strftime(buf
, size
, "%b %e %k:%M", &t
))
712 if (!strftime(buf
, size
, "%b %e %Y", &t
))
717 /** Compute the number of (decimal) digits of a number. */
718 #define GET_NUM_DIGITS(x, num) { \
719 typeof((x)) _tmp = PARA_ABS(x); \
722 while ((_tmp) > 9) { \
728 __a_const
static short unsigned get_duration_width(int seconds
)
730 short unsigned width
;
731 unsigned hours
= seconds
/ 3600, mins
= (seconds
% 3600) / 60;
733 if (!hours
) /* less than one hour => m:ss or mm:ss => 4 or 5 digits */
734 return 4 + (mins
> 9);
735 /* more than one hour => h:mm:ss, hh:mm:ss, hhh:mm:ss, ... */
736 GET_NUM_DIGITS(hours
, &width
);
740 static void get_duration_buf(int seconds
, char *buf
, struct ls_options
*opts
)
742 unsigned hours
= seconds
/ 3600, mins
= (seconds
% 3600) / 60;
743 short unsigned max_width
;
745 if (!hours
) { /* m:ss or mm:ss */
746 max_width
= opts
->mode
== LS_MODE_LONG
?
747 opts
->widths
.duration_width
: 4;
748 sprintf(buf
, "%*u:%02u", max_width
- 3, mins
, seconds
% 60);
749 } else { /* more than one hour => h:mm:ss, hh:mm:ss, hhh:mm:ss, ... */
750 max_width
= opts
->mode
== LS_MODE_LONG
?
751 opts
->widths
.duration_width
: 7;
752 sprintf(buf
, "%*u:%02u:%02u", max_width
- 6, hours
, mins
,
758 static int write_attribute_items(struct para_buffer
*b
,
759 const char *att_bitmap
, struct afs_info
*afsi
)
764 ret
= WRITE_STATUS_ITEM(b
, SI_ATTRIBUTES_BITMAP
, "%s\n", att_bitmap
);
767 ret
= get_attribute_text(&afsi
->attributes
, " ", &att_text
);
770 ret
= WRITE_STATUS_ITEM(b
, SI_ATTRIBUTES_TXT
, "%s\n", att_text
);
775 static int write_lyrics_items(struct para_buffer
*b
, struct afs_info
*afsi
)
780 ret
= WRITE_STATUS_ITEM(b
, SI_LYRICS_ID
, "%u\n", afsi
->lyrics_id
);
783 lyr_get_name_by_id(afsi
->lyrics_id
, &lyrics_name
);
784 return WRITE_STATUS_ITEM(b
, SI_LYRICS_NAME
, "%s\n", lyrics_name
?
785 lyrics_name
: "(none)");
788 static int write_image_items(struct para_buffer
*b
, struct afs_info
*afsi
)
793 ret
= WRITE_STATUS_ITEM(b
, SI_IMAGE_ID
, "%u\n", afsi
->image_id
);
796 img_get_name_by_id(afsi
->image_id
, &image_name
);
797 return WRITE_STATUS_ITEM(b
, SI_IMAGE_NAME
, "%s\n", image_name
?
798 image_name
: "(none)");
801 static int write_filename_items(struct para_buffer
*b
, const char *path
,
807 if (!(flags
& LS_FLAG_FULL_PATH
))
808 return WRITE_STATUS_ITEM(b
, SI_BASENAME
, "%s\n", path
);
809 ret
= WRITE_STATUS_ITEM(b
, SI_PATH
, "%s\n", path
);
812 val
= para_basename(path
);
813 ret
= WRITE_STATUS_ITEM(b
, SI_BASENAME
, "%s\n", val
? val
: "");
816 val
= para_dirname(path
);
817 ret
= WRITE_STATUS_ITEM(b
, SI_DIRECTORY
, "%s\n", val
? val
: "");
822 static int print_chunk_table(struct ls_data
*d
, struct para_buffer
*b
)
824 struct osl_object chunk_table_obj
;
825 struct osl_row
*aft_row
;
829 ret
= aft_get_row_of_hash(d
->hash
, &aft_row
);
832 ret
= osl_open_disk_object(audio_file_table
, aft_row
,
833 AFTCOL_CHUNKS
, &chunk_table_obj
);
836 ret
= para_printf(b
, "%s\n"
837 "chunk_time: %lu:%lu\nchunk_offsets: ",
839 (long unsigned) d
->afhi
.chunk_tv
.tv_sec
,
840 (long unsigned) d
->afhi
.chunk_tv
.tv_usec
844 buf
= chunk_table_obj
.data
;
845 for (i
= 0; i
<= d
->afhi
.chunks_total
; i
++) {
846 ret
= para_printf(b
, "%u ", (unsigned) read_u32(buf
+ 4 * i
));
850 ret
= para_printf(b
, "\n");
852 osl_close_disk_object(&chunk_table_obj
);
856 static int write_score(struct para_buffer
*b
, struct ls_data
*d
,
857 struct ls_options
*opts
)
859 if (!(opts
->flags
& LS_FLAG_ADMISSIBLE_ONLY
)) /* no score*/
861 return WRITE_STATUS_ITEM(b
, SI_SCORE
, "%li\n", d
->score
);
864 static int print_list_item(struct ls_data
*d
, struct ls_options
*opts
,
865 struct para_buffer
*b
, time_t current_time
)
869 char last_played_time
[30];
870 char duration_buf
[30]; /* nobody has an audio file long enough to overflow this */
871 struct afs_info
*afsi
= &d
->afsi
;
872 struct afh_info
*afhi
= &d
->afhi
;
873 char asc_hash
[2 * HASH_SIZE
+ 1];
875 if (opts
->mode
== LS_MODE_SHORT
) {
876 ret
= para_printf(b
, "%s\n", d
->path
);
879 if (opts
->mode
== LS_MODE_CHUNKS
) {
880 ret
= print_chunk_table(d
, b
);
883 get_attribute_bitmap(&afsi
->attributes
, att_buf
);
884 if (opts
->flags
& LS_FLAG_UNIXDATE
)
885 sprintf(last_played_time
, "%llu",
886 (long long unsigned)afsi
->last_played
);
888 ret
= get_local_time(&afsi
->last_played
, last_played_time
,
889 sizeof(last_played_time
), current_time
, opts
->mode
);
893 get_duration_buf(afhi
->seconds_total
, duration_buf
, opts
);
894 if (opts
->mode
== LS_MODE_LONG
) {
895 struct ls_widths
*w
= &opts
->widths
;
896 if (opts
->flags
& LS_FLAG_ADMISSIBLE_ONLY
) {
897 ret
= para_printf(b
, "%*li ",
898 opts
->widths
.score_width
, d
->score
);
903 "%s " /* attributes */
905 "%*d " /* image_id */
906 "%*d " /* lyrics_id */
908 "%*s " /* audio format */
909 "%*d " /* frequency */
912 "%*d " /* num_played */
913 "%s " /* last_played */
916 w
->amp_width
, afsi
->amp
,
917 w
->image_id_width
, afsi
->image_id
,
918 w
->lyrics_id_width
, afsi
->lyrics_id
,
919 w
->bitrate_width
, afhi
->bitrate
,
920 w
->audio_format_width
,
921 audio_format_name(afsi
->audio_format_id
),
922 w
->frequency_width
, afhi
->frequency
,
925 w
->num_played_width
, afsi
->num_played
,
931 if (opts
->mode
== LS_MODE_MBOX
) {
932 const char *bn
= para_basename(d
->path
);
934 "From foo@localhost %s\n"
935 "Received: from\nTo: bar\nFrom: a\n"
942 ret
= write_filename_items(b
, d
->path
, opts
->flags
);
945 ret
= write_score(b
, d
, opts
);
948 ret
= write_attribute_items(b
, att_buf
, afsi
);
951 ret
= write_image_items(b
, afsi
);
954 ret
= write_lyrics_items(b
, afsi
);
957 hash_to_asc(d
->hash
, asc_hash
);
958 ret
= WRITE_STATUS_ITEM(b
, SI_HASH
, "%s\n", asc_hash
);
961 ret
= WRITE_STATUS_ITEM(b
, SI_BITRATE
, "%dkbit/s\n", afhi
->bitrate
);
964 ret
= WRITE_STATUS_ITEM(b
, SI_FORMAT
, "%s\n",
965 audio_format_name(afsi
->audio_format_id
));
968 ret
= WRITE_STATUS_ITEM(b
, SI_FREQUENCY
, "%dHz\n", afhi
->frequency
);
971 ret
= WRITE_STATUS_ITEM(b
, SI_CHANNELS
, "%d\n", afhi
->channels
);
974 ret
= WRITE_STATUS_ITEM(b
, SI_DURATION
, "%s\n", duration_buf
);
977 ret
= WRITE_STATUS_ITEM(b
, SI_SECONDS_TOTAL
, "%lu\n",
978 afhi
->seconds_total
);
981 ret
= WRITE_STATUS_ITEM(b
, SI_LAST_PLAYED
, "%s\n", last_played_time
);
984 ret
= WRITE_STATUS_ITEM(b
, SI_NUM_PLAYED
, "%d\n", afsi
->num_played
);
987 ret
= WRITE_STATUS_ITEM(b
, SI_AMPLIFICATION
, "%u\n", afsi
->amp
);
990 ret
= WRITE_STATUS_ITEM(b
, SI_CHUNK_TIME
, "%lu\n",
991 tv2ms(&afhi
->chunk_tv
));
994 ret
= WRITE_STATUS_ITEM(b
, SI_NUM_CHUNKS
, "%lu\n",
998 ret
= WRITE_STATUS_ITEM(b
, SI_TECHINFO
, "%s\n", afhi
->techinfo
);
1001 ret
= WRITE_STATUS_ITEM(b
, SI_ARTIST
, "%s\n", afhi
->tags
.artist
);
1004 ret
= WRITE_STATUS_ITEM(b
, SI_TITLE
, "%s\n", afhi
->tags
.title
);
1007 ret
= WRITE_STATUS_ITEM(b
, SI_YEAR
, "%s\n", afhi
->tags
.year
);
1010 ret
= WRITE_STATUS_ITEM(b
, SI_ALBUM
, "%s\n", afhi
->tags
.album
);
1013 ret
= WRITE_STATUS_ITEM(b
, SI_COMMENT
, "%s\n", afhi
->tags
.comment
);
1016 if (opts
->mode
== LS_MODE_MBOX
) {
1017 struct osl_object lyrics_def
;
1018 lyr_get_def_by_id(afsi
->lyrics_id
, &lyrics_def
);
1019 if (lyrics_def
.data
) {
1020 ret
= para_printf(b
, "Lyrics:\n~~~~~~~\n%s",
1021 (char *)lyrics_def
.data
);
1022 osl_close_disk_object(&lyrics_def
);
1029 static int make_status_items(struct audio_file_data
*afd
,
1030 struct afs_info
*afsi
, char *path
, long score
,
1031 unsigned char *hash
)
1033 struct ls_data d
= {
1040 struct ls_options opts
= {
1041 .flags
= LS_FLAG_FULL_PATH
| LS_FLAG_ADMISSIBLE_ONLY
,
1042 .mode
= LS_MODE_VERBOSE
,
1044 struct para_buffer pb
= {.max_size
= shm_get_shmmax() - 1};
1045 time_t current_time
;
1048 time(¤t_time
);
1049 ret
= print_list_item(&d
, &opts
, &pb
, current_time
);
1053 status_items
= pb
.buf
;
1054 memset(&pb
, 0, sizeof(pb
));
1055 pb
.max_size
= shm_get_shmmax() - 1;
1056 pb
.flags
= PBF_SIZE_PREFIX
;
1057 ret
= print_list_item(&d
, &opts
, &pb
, current_time
);
1060 status_items
= NULL
;
1063 free(parser_friendly_status_items
);
1064 parser_friendly_status_items
= pb
.buf
;
1069 * Mmap the given audio file and update statistics.
1071 * \param aft_row Determines the audio file to be opened and updated.
1072 * \param score The score of the audio file.
1073 * \param afd Result pointer.
1075 * On success, the numplayed field of the audio file selector info is increased
1076 * and the lastplayed time is set to the current time. Finally, the score of
1077 * the audio file is updated.
1079 * \return Positive shmid on success, negative on errors.
1081 int open_and_update_audio_file(struct osl_row
*aft_row
, long score
,
1082 struct audio_file_data
*afd
)
1084 unsigned char *aft_hash
, file_hash
[HASH_SIZE
];
1085 struct osl_object afsi_obj
;
1086 struct afs_info old_afsi
, new_afsi
;
1087 int ret
= get_hash_of_row(aft_row
, &aft_hash
);
1088 struct afsi_change_event_data aced
;
1089 struct osl_object map
, chunk_table_obj
;
1094 ret
= get_audio_file_path_of_row(aft_row
, &path
);
1097 PARA_NOTICE_LOG("%s\n", path
);
1098 ret
= get_afsi_object_of_row(aft_row
, &afsi_obj
);
1101 ret
= load_afsi(&old_afsi
, &afsi_obj
);
1104 ret
= get_afhi_of_row(aft_row
, &afd
->afhi
);
1107 afd
->afhi
.chunk_table
= NULL
;
1108 ret
= osl_open_disk_object(audio_file_table
, aft_row
,
1109 AFTCOL_CHUNKS
, &chunk_table_obj
);
1112 ret
= mmap_full_file(path
, O_RDONLY
, &map
.data
,
1113 &map
.size
, &afd
->fd
);
1116 hash_function(map
.data
, map
.size
, file_hash
);
1117 ret
= hash_compare(file_hash
, aft_hash
);
1118 para_munmap(map
.data
, map
.size
);
1120 ret
= -E_HASH_MISMATCH
;
1123 new_afsi
= old_afsi
;
1124 new_afsi
.num_played
++;
1125 new_afsi
.last_played
= time(NULL
);
1126 save_afsi(&new_afsi
, &afsi_obj
); /* in-place update */
1128 afd
->audio_format_id
= old_afsi
.audio_format_id
;
1129 load_chunk_table(&afd
->afhi
, chunk_table_obj
.data
);
1130 ret
= make_status_items(afd
, &old_afsi
, path
, score
, file_hash
);
1133 aced
.aft_row
= aft_row
;
1134 aced
.old_afsi
= &old_afsi
;
1135 afs_event(AFSI_CHANGE
, NULL
, &aced
);
1136 ret
= save_afd(afd
);
1138 free(afd
->afhi
.chunk_table
);
1139 osl_close_disk_object(&chunk_table_obj
);
1141 PARA_ERROR_LOG("%s: %s\n", path
, para_strerror(-ret
));
1145 static int ls_audio_format_compare(const void *a
, const void *b
)
1147 struct ls_data
*d1
= *(struct ls_data
**)a
, *d2
= *(struct ls_data
**)b
;
1148 return NUM_COMPARE(d1
->afsi
.audio_format_id
, d2
->afsi
.audio_format_id
);
1151 static int ls_duration_compare(const void *a
, const void *b
)
1153 struct ls_data
*d1
= *(struct ls_data
**)a
, *d2
= *(struct ls_data
**)b
;
1154 return NUM_COMPARE(d1
->afhi
.seconds_total
, d2
->afhi
.seconds_total
);
1157 static int ls_bitrate_compare(const void *a
, const void *b
)
1159 struct ls_data
*d1
= *(struct ls_data
**)a
, *d2
= *(struct ls_data
**)b
;
1160 return NUM_COMPARE(d1
->afhi
.bitrate
, d2
->afhi
.bitrate
);
1163 static int ls_lyrics_id_compare(const void *a
, const void *b
)
1165 struct ls_data
*d1
= *(struct ls_data
**)a
, *d2
= *(struct ls_data
**)b
;
1166 return NUM_COMPARE(d1
->afsi
.lyrics_id
, d2
->afsi
.lyrics_id
);
1169 static int ls_image_id_compare(const void *a
, const void *b
)
1171 struct ls_data
*d1
= *(struct ls_data
**)a
, *d2
= *(struct ls_data
**)b
;
1172 return NUM_COMPARE(d1
->afsi
.image_id
, d2
->afsi
.image_id
);
1175 static int ls_channels_compare(const void *a
, const void *b
)
1177 struct ls_data
*d1
= *(struct ls_data
**)a
, *d2
= *(struct ls_data
**)b
;
1178 return NUM_COMPARE(d1
->afhi
.channels
, d2
->afhi
.channels
);
1181 static int ls_frequency_compare(const void *a
, const void *b
)
1183 struct ls_data
*d1
= *(struct ls_data
**)a
, *d2
= *(struct ls_data
**)b
;
1184 return NUM_COMPARE(d1
->afhi
.frequency
, d2
->afhi
.frequency
);
1187 static int ls_num_played_compare(const void *a
, const void *b
)
1189 struct ls_data
*d1
= *(struct ls_data
**)a
, *d2
= *(struct ls_data
**)b
;
1190 return NUM_COMPARE(d1
->afsi
.num_played
, d2
->afsi
.num_played
);
1193 static int ls_last_played_compare(const void *a
, const void *b
)
1195 struct ls_data
*d1
= *(struct ls_data
**)a
, *d2
= *(struct ls_data
**)b
;
1196 return NUM_COMPARE(d1
->afsi
.last_played
, d2
->afsi
.last_played
);
1199 static int ls_score_compare(const void *a
, const void *b
)
1201 struct ls_data
*d1
= *(struct ls_data
**)a
, *d2
= *(struct ls_data
**)b
;
1202 return NUM_COMPARE(d1
->score
, d2
->score
);
1205 static int ls_path_compare(const void *a
, const void *b
)
1207 struct ls_data
*d1
= *(struct ls_data
**)a
, *d2
= *(struct ls_data
**)b
;
1208 return strcmp(d1
->path
, d2
->path
);
1211 static int sort_matching_paths(struct ls_options
*options
)
1213 size_t nmemb
= options
->num_matching_paths
;
1214 size_t size
= sizeof(*options
->data_ptr
);
1215 int (*compar
)(const void *, const void *);
1218 options
->data_ptr
= para_malloc(nmemb
* sizeof(*options
->data_ptr
));
1219 for (i
= 0; i
< nmemb
; i
++)
1220 options
->data_ptr
[i
] = options
->data
+ i
;
1222 /* In these cases the array is already sorted */
1223 if (options
->sorting
== LS_SORT_BY_PATH
1224 && !(options
->flags
& LS_FLAG_ADMISSIBLE_ONLY
)
1225 && (options
->flags
& LS_FLAG_FULL_PATH
))
1227 if (options
->sorting
== LS_SORT_BY_SCORE
&&
1228 options
->flags
& LS_FLAG_ADMISSIBLE_ONLY
)
1231 switch (options
->sorting
) {
1232 case LS_SORT_BY_PATH
:
1233 compar
= ls_path_compare
; break;
1234 case LS_SORT_BY_SCORE
:
1235 compar
= ls_score_compare
; break;
1236 case LS_SORT_BY_LAST_PLAYED
:
1237 compar
= ls_last_played_compare
; break;
1238 case LS_SORT_BY_NUM_PLAYED
:
1239 compar
= ls_num_played_compare
; break;
1240 case LS_SORT_BY_FREQUENCY
:
1241 compar
= ls_frequency_compare
; break;
1242 case LS_SORT_BY_CHANNELS
:
1243 compar
= ls_channels_compare
; break;
1244 case LS_SORT_BY_IMAGE_ID
:
1245 compar
= ls_image_id_compare
; break;
1246 case LS_SORT_BY_LYRICS_ID
:
1247 compar
= ls_lyrics_id_compare
; break;
1248 case LS_SORT_BY_BITRATE
:
1249 compar
= ls_bitrate_compare
; break;
1250 case LS_SORT_BY_DURATION
:
1251 compar
= ls_duration_compare
; break;
1252 case LS_SORT_BY_AUDIO_FORMAT
:
1253 compar
= ls_audio_format_compare
; break;
1257 qsort(options
->data_ptr
, nmemb
, size
, compar
);
1261 /* row is either an aft_row or a row of the score table */
1262 /* TODO: Only compute widths if we need them */
1263 static int prepare_ls_row(struct osl_row
*row
, void *ls_opts
)
1266 struct ls_options
*options
= ls_opts
;
1268 struct ls_widths
*w
;
1269 unsigned short num_digits
;
1271 struct osl_row
*aft_row
;
1275 if (options
->flags
& LS_FLAG_ADMISSIBLE_ONLY
) {
1276 ret
= get_score_and_aft_row(row
, &score
, &aft_row
);
1281 ret
= get_audio_file_path_of_row(aft_row
, &path
);
1284 if (!(options
->flags
& LS_FLAG_FULL_PATH
)) {
1285 char *p
= strrchr(path
, '/');
1289 if (options
->num_patterns
) {
1290 for (i
= 0; i
< options
->num_patterns
; i
++) {
1291 ret
= fnmatch(options
->patterns
[i
], path
, 0);
1294 if (ret
== FNM_NOMATCH
)
1298 if (i
>= options
->num_patterns
) /* no match */
1301 tmp
= options
->num_matching_paths
++;
1302 if (options
->num_matching_paths
> options
->array_size
) {
1303 options
->array_size
++;
1304 options
->array_size
*= 2;
1305 options
->data
= para_realloc(options
->data
, options
->array_size
1306 * sizeof(*options
->data
));
1308 d
= options
->data
+ tmp
;
1309 ret
= get_afsi_of_row(aft_row
, &d
->afsi
);
1312 ret
= get_afhi_of_row(aft_row
, &d
->afhi
);
1316 ret
= get_hash_of_row(aft_row
, &d
->hash
);
1319 w
= &options
->widths
;
1320 GET_NUM_DIGITS(d
->afsi
.image_id
, &num_digits
);
1321 w
->image_id_width
= PARA_MAX(w
->image_id_width
, num_digits
);
1322 GET_NUM_DIGITS(d
->afsi
.lyrics_id
, &num_digits
);
1323 w
->lyrics_id_width
= PARA_MAX(w
->lyrics_id_width
, num_digits
);
1324 GET_NUM_DIGITS(d
->afhi
.bitrate
, &num_digits
);
1325 w
->bitrate_width
= PARA_MAX(w
->bitrate_width
, num_digits
);
1326 GET_NUM_DIGITS(d
->afhi
.frequency
, &num_digits
);
1327 w
->frequency_width
= PARA_MAX(w
->frequency_width
, num_digits
);
1328 GET_NUM_DIGITS(d
->afsi
.num_played
, &num_digits
);
1329 w
->num_played_width
= PARA_MAX(w
->num_played_width
, num_digits
);
1330 /* get the number of chars to print this amount of time */
1331 num_digits
= get_duration_width(d
->afhi
.seconds_total
);
1332 w
->duration_width
= PARA_MAX(w
->duration_width
, num_digits
);
1333 GET_NUM_DIGITS(d
->afsi
.amp
, &num_digits
);
1334 w
->amp_width
= PARA_MAX(w
->amp_width
, num_digits
);
1335 num_digits
= strlen(audio_format_name(d
->afsi
.audio_format_id
));
1336 w
->audio_format_width
= PARA_MAX(w
->audio_format_width
, num_digits
);
1337 if (options
->flags
& LS_FLAG_ADMISSIBLE_ONLY
) {
1338 GET_NUM_DIGITS(score
, &num_digits
);
1339 num_digits
++; /* add one for the sign (space or "-") */
1340 w
->score_width
= PARA_MAX(w
->score_width
, num_digits
);
1348 static void com_ls_callback(int fd
, const struct osl_object
*query
)
1350 struct ls_options
*opts
= query
->data
;
1351 char *p
, *pattern_start
= (char *)query
->data
+ sizeof(*opts
);
1352 struct para_buffer b
= {
1353 .max_size
= shm_get_shmmax(),
1354 .flags
= (opts
->mode
== LS_MODE_PARSER
)? PBF_SIZE_PREFIX
: 0,
1355 .max_size_handler
= afs_max_size_handler
,
1356 .private_data
= &(struct afs_max_size_handler_data
) {
1361 time_t current_time
;
1363 if (opts
->num_patterns
) {
1364 opts
->patterns
= para_malloc(opts
->num_patterns
* sizeof(char *));
1365 for (i
= 0, p
= pattern_start
; i
< opts
->num_patterns
; i
++) {
1366 opts
->patterns
[i
] = p
;
1370 opts
->patterns
= NULL
;
1371 if (opts
->flags
& LS_FLAG_ADMISSIBLE_ONLY
)
1372 ret
= admissible_file_loop(opts
, prepare_ls_row
);
1374 ret
= osl(osl_rbtree_loop(audio_file_table
, AFTCOL_PATH
, opts
,
1378 if (opts
->num_matching_paths
== 0) {
1379 if (opts
->num_patterns
> 0)
1380 para_printf(&b
, "no matches\n");
1383 ret
= sort_matching_paths(opts
);
1386 time(¤t_time
);
1387 if (opts
->flags
& LS_FLAG_REVERSE
)
1388 for (i
= opts
->num_matching_paths
- 1; i
>= 0; i
--) {
1389 ret
= print_list_item(opts
->data_ptr
[i
], opts
, &b
, current_time
);
1394 for (i
= 0; i
< opts
->num_matching_paths
; i
++) {
1395 ret
= print_list_item(opts
->data_ptr
[i
], opts
, &b
, current_time
);
1401 pass_buffer_as_shm(b
.buf
, b
.offset
, &fd
);
1404 free(opts
->data_ptr
);
1405 free(opts
->patterns
);
1409 * TODO: flags -h (sort by hash)
1411 int com_ls(struct command_context
*cc
)
1415 enum ls_sorting_method sort
= LS_SORT_BY_PATH
;
1416 enum ls_listing_mode mode
= LS_MODE_SHORT
;
1417 struct ls_options opts
= {.patterns
= NULL
};
1418 struct osl_object query
= {.data
= &opts
, .size
= sizeof(opts
)};
1420 for (i
= 1; i
< cc
->argc
; i
++) {
1421 const char *arg
= cc
->argv
[i
];
1424 if (!strcmp(arg
, "--")) {
1428 if (!strncmp(arg
, "-l", 2)) {
1430 mode
= LS_MODE_LONG
;
1434 return -E_AFT_SYNTAX
;
1435 switch(*(arg
+ 2)) {
1437 mode
= LS_MODE_SHORT
;
1440 mode
= LS_MODE_LONG
;
1443 mode
= LS_MODE_VERBOSE
;
1446 mode
= LS_MODE_MBOX
;
1449 mode
= LS_MODE_CHUNKS
;
1452 mode
= LS_MODE_PARSER
;
1455 return -E_AFT_SYNTAX
;
1458 if (!strcmp(arg
, "-p")) {
1459 flags
|= LS_FLAG_FULL_PATH
;
1462 if (!strcmp(arg
, "-a")) {
1463 flags
|= LS_FLAG_ADMISSIBLE_ONLY
;
1466 if (!strcmp(arg
, "-r")) {
1467 flags
|= LS_FLAG_REVERSE
;
1470 if (!strcmp(arg
, "-d")) {
1471 flags
|= LS_FLAG_UNIXDATE
;
1474 if (!strncmp(arg
, "-s", 2)) {
1475 if (!*(arg
+ 2) || *(arg
+ 3))
1476 return -E_AFT_SYNTAX
;
1477 switch(*(arg
+ 2)) {
1479 sort
= LS_SORT_BY_PATH
;
1481 case 's': /* -ss implies -a */
1482 sort
= LS_SORT_BY_SCORE
;
1483 flags
|= LS_FLAG_ADMISSIBLE_ONLY
;
1486 sort
= LS_SORT_BY_LAST_PLAYED
;
1489 sort
= LS_SORT_BY_NUM_PLAYED
;
1492 sort
= LS_SORT_BY_FREQUENCY
;
1495 sort
= LS_SORT_BY_CHANNELS
;
1498 sort
= LS_SORT_BY_IMAGE_ID
;
1501 sort
= LS_SORT_BY_LYRICS_ID
;
1504 sort
= LS_SORT_BY_BITRATE
;
1507 sort
= LS_SORT_BY_DURATION
;
1510 sort
= LS_SORT_BY_AUDIO_FORMAT
;
1513 return -E_AFT_SYNTAX
;
1516 return -E_AFT_SYNTAX
;
1519 opts
.sorting
= sort
;
1521 opts
.num_patterns
= cc
->argc
- i
;
1522 ret
= send_option_arg_callback_request(&query
, opts
.num_patterns
,
1523 cc
->argv
+ i
, com_ls_callback
, afs_cb_result_handler
, cc
);
1528 * Call the given function for each file in the audio file table.
1530 * \param private_data An arbitrary data pointer, passed to \a func.
1531 * \param func The custom function to be called.
1535 int audio_file_loop(void *private_data
, osl_rbtree_loop_func
*func
)
1537 return osl(osl_rbtree_loop(audio_file_table
, AFTCOL_HASH
, private_data
,
1541 static struct osl_row
*find_hash_sister(unsigned char *hash
)
1543 const struct osl_object obj
= {.data
= hash
, .size
= HASH_SIZE
};
1544 struct osl_row
*row
;
1546 osl_get_row(audio_file_table
, AFTCOL_HASH
, &obj
, &row
);
1550 /** The format of the data stored by save_audio_file_data(). */
1551 enum com_add_buffer_offsets
{
1552 /** afhi (if present) starts here. */
1553 CAB_AFHI_OFFSET_POS
= 0,
1554 /** Start of the chunk table (if present). */
1555 CAB_CHUNKS_OFFSET_POS
= 2,
1556 /** Audio format id. */
1557 CAB_AUDIO_FORMAT_OFFSET
= 4,
1558 /** Flags given to the add command. */
1559 CAB_FLAGS_OFFSET
= 5,
1560 /** The hash of the audio file being added. */
1561 CAB_HASH_OFFSET
= 9,
1562 /** Start of the path of the audio file. */
1563 CAB_PATH_OFFSET
= (CAB_HASH_OFFSET
+ HASH_SIZE
),
1567 * Store the given data to a single buffer. Doesn't need the audio file selector
1568 * info struct as the server knows it as well.
1570 * It's OK to call this with afhi == NULL. In this case, the audio format
1571 * handler info won't be stored in the buffer.
1573 static void save_add_callback_buffer(unsigned char *hash
, const char *path
,
1574 struct afh_info
*afhi
, uint32_t flags
,
1575 uint8_t audio_format_num
, struct osl_object
*obj
)
1577 size_t path_len
= strlen(path
) + 1;
1578 size_t afhi_size
= sizeof_afhi_buf(afhi
);
1579 size_t size
= CAB_PATH_OFFSET
+ path_len
+ afhi_size
1580 + sizeof_chunk_table(afhi
);
1581 char *buf
= para_malloc(size
);
1584 write_u8(buf
+ CAB_AUDIO_FORMAT_OFFSET
, audio_format_num
);
1585 write_u32(buf
+ CAB_FLAGS_OFFSET
, flags
);
1587 memcpy(buf
+ CAB_HASH_OFFSET
, hash
, HASH_SIZE
);
1588 strcpy(buf
+ CAB_PATH_OFFSET
, path
);
1590 pos
= CAB_PATH_OFFSET
+ path_len
;
1591 PARA_DEBUG_LOG("size: %zu, afhi starts at %d\n", size
, pos
);
1592 PARA_DEBUG_LOG("last afhi byte: %p, pos %zu\n", buf
+ pos
+ afhi_size
- 1,
1593 pos
+ afhi_size
- 1);
1594 write_u16(buf
+ CAB_AFHI_OFFSET_POS
, pos
);
1595 save_afhi(afhi
, buf
+ pos
);
1598 PARA_DEBUG_LOG("size: %zu, chunks start at %d\n", size
, pos
);
1599 write_u16(buf
+ CAB_CHUNKS_OFFSET_POS
, pos
);
1601 save_chunk_table(afhi
, buf
+ pos
);
1602 PARA_DEBUG_LOG("last byte in buf: %p\n", buf
+ size
- 1);
1609 Overview of the add command.
1611 Input: What was passed to the callback by the command handler.
1613 HS: Hash sister. Whether an audio file with identical hash
1614 already exists in the osl database.
1616 PB: Path brother. Whether a file with the given path exists
1619 F: Force flag given. Whether add was called with -f.
1621 output: Action performed by the callback.
1623 AFHI: Whether afhi and chunk table are computed and sent.
1624 ACTION: Table modifications to be done by the callback.
1626 +----+----+---+------+---------------------------------------------------+
1627 | HS | PB | F | AFHI | ACTION
1628 +----+----+---+------+---------------------------------------------------+
1629 | Y | Y | Y | Y | if HS != PB: remove PB. HS: force afhi update,
1630 | | update path, keep afsi
1631 +----+----+---+------+---------------------------------------------------+
1632 | Y | Y | N | N | if HS == PB: do not send callback request at all.
1633 | | otherwise: remove PB, HS: update path, keep afhi,
1635 +----+----+---+------+---------------------------------------------------+
1636 | Y | N | Y | Y | (rename) force afhi update of HS, update path of
1638 +----+----+---+------+---------------------------------------------------+
1639 | Y | N | N | N | (file rename) update path of HS, keep afsi, afhi
1640 +----+----+---+------+---------------------------------------------------+
1641 | N | Y | Y | Y | (file change) update afhi, hash, of PB, keep afsi
1642 | | (force has no effect)
1643 +----+----+---+------+---------------------------------------------------+
1644 | N | Y | N | Y | (file change) update afhi, hash of PB, keep afsi
1645 +----+----+---+------+---------------------------------------------------+
1646 | N | N | Y | Y | (new file) create new entry (force has no effect)
1647 +----+----+---+------+---------------------------------------------------+
1648 | N | N | N | Y | (new file) create new entry
1649 +----+----+---+------+---------------------------------------------------+
1653 afhi <=> force or no HS
1658 /** Flags passed to the add command. */
1659 enum com_add_flags
{
1660 /** Skip paths that exist already. */
1662 /** Force adding. */
1664 /** Print what is being done. */
1665 ADD_FLAG_VERBOSE
= 4,
1666 /** Try to add files with unknown suffixes. */
1670 static void com_add_callback(int fd
, const struct osl_object
*query
)
1672 char *buf
= query
->data
, *path
;
1673 struct osl_row
*pb
, *aft_row
;
1675 struct osl_object objs
[NUM_AFT_COLUMNS
];
1676 unsigned char *hash
;
1677 char asc
[2 * HASH_SIZE
+ 1];
1679 char afsi_buf
[AFSI_SIZE
];
1680 uint32_t flags
= read_u32(buf
+ CAB_FLAGS_OFFSET
);
1681 struct afs_info default_afsi
= {.last_played
= 0};
1682 struct para_buffer msg
= {
1683 .max_size
= shm_get_shmmax(),
1684 .max_size_handler
= afs_max_size_handler
,
1685 .private_data
= &(struct afs_max_size_handler_data
) {
1689 uint16_t afhi_offset
, chunks_offset
;
1691 hash
= (unsigned char *)buf
+ CAB_HASH_OFFSET
;
1692 hash_to_asc(hash
, asc
);;
1693 objs
[AFTCOL_HASH
].data
= buf
+ CAB_HASH_OFFSET
;
1694 objs
[AFTCOL_HASH
].size
= HASH_SIZE
;
1696 path
= buf
+ CAB_PATH_OFFSET
;
1697 objs
[AFTCOL_PATH
].data
= path
;
1698 objs
[AFTCOL_PATH
].size
= strlen(path
) + 1;
1700 PARA_INFO_LOG("request to add %s\n", path
);
1701 hs
= find_hash_sister(hash
);
1702 ret
= aft_get_row_of_path(path
, &pb
);
1703 if (ret
< 0 && ret
!= -OSL_ERRNO_TO_PARA_ERROR(E_OSL_RB_KEY_NOT_FOUND
))
1705 if (hs
&& pb
&& hs
== pb
&& !(flags
& ADD_FLAG_FORCE
)) {
1706 if (flags
& ADD_FLAG_VERBOSE
)
1707 ret
= para_printf(&msg
, "ignoring duplicate\n");
1712 if (hs
&& hs
!= pb
) {
1713 struct osl_object obj
;
1714 if (pb
) { /* hs trumps pb, remove pb */
1715 if (flags
& ADD_FLAG_VERBOSE
) {
1716 ret
= para_printf(&msg
, "removing path brother\n");
1720 ret
= osl(osl_del_row(audio_file_table
, pb
));
1725 /* file rename, update hs' path */
1726 if (flags
& ADD_FLAG_VERBOSE
) {
1727 ret
= osl(osl_get_object(audio_file_table
, hs
,
1728 AFTCOL_PATH
, &obj
));
1731 ret
= para_printf(&msg
, "renamed from %s\n", (char *)obj
.data
);
1735 ret
= osl(osl_update_object(audio_file_table
, hs
, AFTCOL_PATH
,
1736 &objs
[AFTCOL_PATH
]));
1739 afs_event(AUDIO_FILE_RENAME
, &msg
, hs
);
1740 if (!(flags
& ADD_FLAG_FORCE
))
1743 /* no hs or force mode, child must have sent afhi */
1744 afhi_offset
= read_u16(buf
+ CAB_AFHI_OFFSET_POS
);
1745 chunks_offset
= read_u16(buf
+ CAB_CHUNKS_OFFSET_POS
);
1747 objs
[AFTCOL_AFHI
].data
= buf
+ afhi_offset
;
1748 objs
[AFTCOL_AFHI
].size
= chunks_offset
- afhi_offset
;
1750 if (!objs
[AFTCOL_AFHI
].size
) /* "impossible" */
1752 objs
[AFTCOL_CHUNKS
].data
= buf
+ chunks_offset
;
1753 objs
[AFTCOL_CHUNKS
].size
= query
->size
- chunks_offset
;
1754 if (pb
&& !hs
) { /* update pb's hash */
1755 char old_asc
[2 * HASH_SIZE
+ 1];
1756 unsigned char *old_hash
;
1757 ret
= get_hash_of_row(pb
, &old_hash
);
1760 hash_to_asc(old_hash
, old_asc
);
1761 if (flags
& ADD_FLAG_VERBOSE
) {
1762 ret
= para_printf(&msg
, "file change: %s -> %s\n",
1767 ret
= osl_update_object(audio_file_table
, pb
, AFTCOL_HASH
,
1768 &objs
[AFTCOL_HASH
]);
1772 if (hs
|| pb
) { /* (hs != NULL and pb != NULL) implies hs == pb */
1773 struct osl_row
*row
= pb
? pb
: hs
;
1774 /* update afhi and chunk_table */
1775 if (flags
& ADD_FLAG_VERBOSE
) {
1776 ret
= para_printf(&msg
, "updating afhi and chunk table\n");
1780 ret
= osl(osl_update_object(audio_file_table
, row
, AFTCOL_AFHI
,
1781 &objs
[AFTCOL_AFHI
]));
1784 ret
= osl(osl_update_object(audio_file_table
, row
, AFTCOL_CHUNKS
,
1785 &objs
[AFTCOL_CHUNKS
]));
1788 afs_event(AFHI_CHANGE
, &msg
, row
);
1791 /* new entry, use default afsi */
1792 if (flags
& ADD_FLAG_VERBOSE
) {
1793 ret
= para_printf(&msg
, "new file\n");
1797 default_afsi
.last_played
= time(NULL
) - 365 * 24 * 60 * 60;
1798 default_afsi
.audio_format_id
= read_u8(buf
+ CAB_AUDIO_FORMAT_OFFSET
);
1800 objs
[AFTCOL_AFSI
].data
= &afsi_buf
;
1801 objs
[AFTCOL_AFSI
].size
= AFSI_SIZE
;
1802 save_afsi(&default_afsi
, &objs
[AFTCOL_AFSI
]);
1803 ret
= osl(osl_add_and_get_row(audio_file_table
, objs
, &aft_row
));
1804 afs_event(AUDIO_FILE_ADD
, &msg
, aft_row
);
1807 para_printf(&msg
, "%s\n", para_strerror(-ret
));
1809 pass_buffer_as_shm(msg
.buf
, msg
.offset
, &fd
);
1813 /** Used by com_add(). */
1814 struct private_add_data
{
1815 /** The pointer passed to the original command handler. */
1816 struct command_context
*cc
;
1817 /** The given add flags. */
1821 static void path_brother_callback(int fd
, const struct osl_object
*query
)
1823 char *path
= query
->data
;
1824 struct osl_row
*path_brother
;
1825 int ret
= aft_get_row_of_path(path
, &path_brother
);
1828 pass_buffer_as_shm((char *)&path_brother
, sizeof(path_brother
), &fd
);
1831 static void hash_sister_callback(int fd
, const struct osl_object
*query
)
1833 unsigned char *hash
= query
->data
;
1834 struct osl_row
*hash_sister
;
1836 hash_sister
= find_hash_sister(hash
);
1839 pass_buffer_as_shm((char *)&hash_sister
, sizeof(hash_sister
), &fd
);
1842 static int get_row_pointer_from_result(struct osl_object
*result
, void *private)
1844 struct osl_row
**row
= private;
1845 *row
= *(struct osl_row
**)(result
->data
);
1849 static int add_one_audio_file(const char *path
, void *private_data
)
1851 int ret
, send_ret
= 1, fd
;
1852 uint8_t format_num
= -1;
1853 struct private_add_data
*pad
= private_data
;
1854 struct afh_info afhi
, *afhi_ptr
= NULL
;
1855 struct osl_row
*pb
= NULL
, *hs
= NULL
; /* path brother/hash sister */
1856 struct osl_object map
, obj
= {.data
= NULL
}, query
;
1857 unsigned char hash
[HASH_SIZE
];
1859 ret
= guess_audio_format(path
);
1860 if (ret
< 0 && !(pad
->flags
& ADD_FLAG_ALL
))
1862 query
.data
= (char *)path
;
1863 query
.size
= strlen(path
) + 1;
1864 ret
= send_callback_request(path_brother_callback
, &query
,
1865 get_row_pointer_from_result
, &pb
);
1866 if (ret
< 0 && ret
!= -OSL_ERRNO_TO_PARA_ERROR(E_OSL_RB_KEY_NOT_FOUND
))
1869 if (pb
&& (pad
->flags
& ADD_FLAG_LAZY
)) { /* lazy is really cheap */
1870 if (pad
->flags
& ADD_FLAG_VERBOSE
)
1871 send_ret
= sc_send_va_buffer(&pad
->cc
->scc
,
1872 "lazy-ignore: %s\n", path
);
1875 /* We still want to add this file. Compute its hash. */
1876 ret
= mmap_full_file(path
, O_RDONLY
, &map
.data
, &map
.size
, &fd
);
1879 hash_function(map
.data
, map
.size
, hash
);
1881 /* Check whether the database contains a file with the same hash. */
1883 query
.size
= HASH_SIZE
;
1884 ret
= send_callback_request(hash_sister_callback
, &query
,
1885 get_row_pointer_from_result
, &hs
);
1888 /* Return success if we already know this file. */
1890 if (pb
&& hs
&& hs
== pb
&& !(pad
->flags
& ADD_FLAG_FORCE
)) {
1891 if (pad
->flags
& ADD_FLAG_VERBOSE
)
1892 send_ret
= sc_send_va_buffer(&pad
->cc
->scc
,
1893 "%s exists, not forcing update\n", path
);
1897 * We won't recalculate the audio format info and the chunk table if
1898 * there is a hash sister and FORCE was not given.
1900 if (!hs
|| (pad
->flags
& ADD_FLAG_FORCE
)) {
1901 ret
= compute_afhi(path
, map
.data
, map
.size
, fd
, &afhi
);
1907 munmap(map
.data
, map
.size
);
1909 if (pad
->flags
& ADD_FLAG_VERBOSE
) {
1910 send_ret
= sc_send_va_buffer(&pad
->cc
->scc
, "adding %s\n", path
);
1914 save_add_callback_buffer(hash
, path
, afhi_ptr
, pad
->flags
, format_num
, &obj
);
1915 /* Ask afs to consider this entry for adding. */
1916 ret
= send_callback_request(com_add_callback
, &obj
,
1917 afs_cb_result_handler
, pad
->cc
);
1922 munmap(map
.data
, map
.size
);
1924 if (ret
< 0 && send_ret
>= 0)
1925 send_ret
= sc_send_va_buffer(&pad
->cc
->scc
,
1926 "failed to add %s (%s)\n", path
, para_strerror(-ret
));
1928 clear_afhi(afhi_ptr
);
1929 /* Stop adding files only on send errors. */
1933 int com_add(struct command_context
*cc
)
1936 struct private_add_data pad
= {.cc
= cc
, .flags
= 0};
1937 struct stat statbuf
;
1939 for (i
= 1; i
< cc
->argc
; i
++) {
1940 const char *arg
= cc
->argv
[i
];
1943 if (!strcmp(arg
, "--")) {
1947 if (!strcmp(arg
, "-a")) {
1948 pad
.flags
|= ADD_FLAG_ALL
;
1951 if (!strcmp(arg
, "-l")) {
1952 pad
.flags
|= ADD_FLAG_LAZY
;
1955 if (!strcmp(arg
, "-f")) {
1956 pad
.flags
|= ADD_FLAG_FORCE
;
1959 if (!strcmp(arg
, "-v")) {
1960 pad
.flags
|= ADD_FLAG_VERBOSE
;
1965 return -E_AFT_SYNTAX
;
1966 for (; i
< cc
->argc
; i
++) {
1968 ret
= verify_path(cc
->argv
[i
], &path
);
1970 ret
= sc_send_va_buffer(&cc
->scc
, "%s: %s\n",
1971 cc
->argv
[i
], para_strerror(-ret
));
1976 ret
= stat(path
, &statbuf
);
1978 ret
= sc_send_va_buffer(&cc
->scc
,
1979 "failed to stat %s (%s)\n", path
,
1986 if (S_ISDIR(statbuf
.st_mode
))
1987 ret
= for_each_file_in_dir(path
, add_one_audio_file
,
1990 ret
= add_one_audio_file(path
, &pad
);
1992 sc_send_va_buffer(&cc
->scc
, "%s: %s\n", path
,
1993 para_strerror(-ret
));
2004 * Flags used by the touch command.
2009 /** Whether the \p FNM_PATHNAME flag should be passed to fnmatch(). */
2010 TOUCH_FLAG_FNM_PATHNAME
= 1,
2011 /** Activates verbose mode. */
2012 TOUCH_FLAG_VERBOSE
= 2
2015 /** Options used by com_touch(). */
2016 struct com_touch_options
{
2017 /** New num_played value. */
2019 /** New last played count. */
2020 int64_t last_played
;
2021 /** New lyrics id. */
2023 /** New image id. */
2025 /** New amplification value. */
2027 /** Command line flags (see \ref touch_flags). */
2031 /** Data passed to the action handler of com_touch(). */
2032 struct touch_action_data
{
2033 /** Command line options (see \ref com_touch_options). */
2034 struct com_touch_options
*cto
;
2035 /** Message buffer. */
2036 struct para_buffer pb
;
2039 static int touch_audio_file(__a_unused
struct osl_table
*table
,
2040 struct osl_row
*row
, const char *name
, void *data
)
2042 struct touch_action_data
*tad
= data
;
2043 struct osl_object obj
;
2044 struct afs_info old_afsi
, new_afsi
;
2045 int ret
, no_options
= tad
->cto
->num_played
< 0 && tad
->cto
->last_played
< 0 &&
2046 tad
->cto
->lyrics_id
< 0 && tad
->cto
->image_id
< 0 && tad
->cto
->amp
< 0;
2047 struct afsi_change_event_data aced
;
2049 ret
= get_afsi_object_of_row(row
, &obj
);
2051 return para_printf(&tad
->pb
, "%s: %s\n", name
, para_strerror(-ret
));
2052 ret
= load_afsi(&old_afsi
, &obj
);
2054 return para_printf(&tad
->pb
, "%s: %s\n", name
, para_strerror(-ret
));
2055 new_afsi
= old_afsi
;
2057 new_afsi
.num_played
++;
2058 new_afsi
.last_played
= time(NULL
);
2059 if (tad
->cto
->flags
& TOUCH_FLAG_VERBOSE
) {
2060 ret
= para_printf(&tad
->pb
, "%s: num_played = %u, "
2061 "last_played = now()\n", name
,
2062 new_afsi
.num_played
);
2067 if (tad
->cto
->flags
& TOUCH_FLAG_VERBOSE
) {
2068 ret
= para_printf(&tad
->pb
, "touching %s\n", name
);
2072 if (tad
->cto
->lyrics_id
>= 0)
2073 new_afsi
.lyrics_id
= tad
->cto
->lyrics_id
;
2074 if (tad
->cto
->image_id
>= 0)
2075 new_afsi
.image_id
= tad
->cto
->image_id
;
2076 if (tad
->cto
->num_played
>= 0)
2077 new_afsi
.num_played
= tad
->cto
->num_played
;
2078 if (tad
->cto
->last_played
>= 0)
2079 new_afsi
.last_played
= tad
->cto
->last_played
;
2080 if (tad
->cto
->amp
>= 0)
2081 new_afsi
.amp
= tad
->cto
->amp
;
2083 save_afsi(&new_afsi
, &obj
); /* in-place update */
2085 aced
.old_afsi
= &old_afsi
;
2086 afs_event(AFSI_CHANGE
, &tad
->pb
, &aced
);
2090 static void com_touch_callback(int fd
, const struct osl_object
*query
)
2092 struct touch_action_data tad
= {.cto
= query
->data
,
2094 .max_size
= shm_get_shmmax(),
2095 .private_data
= &fd
,
2096 .max_size_handler
= afs_max_size_handler
2100 struct pattern_match_data pmd
= {
2101 .table
= audio_file_table
,
2102 .loop_col_num
= AFTCOL_HASH
,
2103 .match_col_num
= AFTCOL_PATH
,
2104 .patterns
= {.data
= (char *)query
->data
+ sizeof(*tad
.cto
),
2105 .size
= query
->size
- sizeof(*tad
.cto
)},
2107 .action
= touch_audio_file
2109 if (tad
.cto
->flags
& TOUCH_FLAG_FNM_PATHNAME
)
2110 pmd
.fnmatch_flags
|= FNM_PATHNAME
;
2111 ret
= for_each_matching_row(&pmd
);
2113 ret2
= para_printf(&tad
.pb
, "%s\n", para_strerror(-ret
));
2114 else if (pmd
.num_matches
== 0)
2115 ret2
= para_printf(&tad
.pb
, "no matches\n");
2116 if (ret2
>= 0 && tad
.pb
.offset
)
2117 pass_buffer_as_shm(tad
.pb
.buf
, tad
.pb
.offset
, &fd
);
2121 int com_touch(struct command_context
*cc
)
2123 struct com_touch_options cto
= {
2130 struct osl_object query
= {.data
= &cto
, .size
= sizeof(cto
)};
2134 for (i
= 1; i
< cc
->argc
; i
++) {
2135 const char *arg
= cc
->argv
[i
];
2138 if (!strcmp(arg
, "--")) {
2142 if (!strncmp(arg
, "-n=", 3)) {
2143 ret
= para_atoi32(arg
+ 3, &cto
.num_played
);
2148 if (!strncmp(arg
, "-l=", 3)) {
2149 ret
= para_atoi64(arg
+ 3, &cto
.last_played
);
2154 if (!strncmp(arg
, "-y=", 3)) {
2155 ret
= para_atoi32(arg
+ 3, &cto
.lyrics_id
);
2160 if (!strncmp(arg
, "-i=", 3)) {
2161 ret
= para_atoi32(arg
+ 3, &cto
.image_id
);
2166 if (!strncmp(arg
, "-a=", 3)) {
2168 ret
= para_atoi32(arg
+ 3, &val
);
2171 if (val
< 0 || val
> 255)
2172 return -ERRNO_TO_PARA_ERROR(EINVAL
);
2176 if (!strcmp(arg
, "-p")) {
2177 cto
.flags
|= TOUCH_FLAG_FNM_PATHNAME
;
2180 if (!strcmp(arg
, "-v")) {
2181 cto
.flags
|= TOUCH_FLAG_VERBOSE
;
2184 break; /* non-option starting with dash */
2187 return -E_AFT_SYNTAX
;
2188 ret
= send_option_arg_callback_request(&query
, cc
->argc
- i
,
2189 cc
->argv
+ i
, com_touch_callback
, afs_cb_result_handler
, cc
);
2191 sc_send_va_buffer(&cc
->scc
, "%s\n", para_strerror(-ret
));
2195 /** Flags for com_rm(). */
2198 RM_FLAG_VERBOSE
= 1,
2202 RM_FLAG_FNM_PATHNAME
= 4
2205 /** Data passed to the action handler of com_rm(). */
2206 struct com_rm_action_data
{
2207 /** Command line flags ((see \ref rm_flags). */
2209 /** Message buffer. */
2210 struct para_buffer pb
;
2213 static int remove_audio_file(__a_unused
struct osl_table
*table
,
2214 struct osl_row
*row
, const char *name
, void *data
)
2216 struct com_rm_action_data
*crd
= data
;
2219 if (crd
->flags
& RM_FLAG_VERBOSE
) {
2220 ret
= para_printf(&crd
->pb
, "removing %s\n", name
);
2224 afs_event(AUDIO_FILE_REMOVE
, &crd
->pb
, row
);
2225 ret
= osl(osl_del_row(audio_file_table
, row
));
2227 para_printf(&crd
->pb
, "%s: %s\n", name
, para_strerror(-ret
));
2231 static void com_rm_callback(int fd
, const struct osl_object
*query
)
2233 struct com_rm_action_data crd
= {.flags
= *(uint32_t *)query
->data
,
2235 .max_size
= shm_get_shmmax(),
2236 .private_data
= &fd
,
2237 .max_size_handler
= afs_max_size_handler
2241 struct pattern_match_data pmd
= {
2242 .table
= audio_file_table
,
2243 .loop_col_num
= AFTCOL_HASH
,
2244 .match_col_num
= AFTCOL_PATH
,
2245 .patterns
= {.data
= (char *)query
->data
+ sizeof(uint32_t),
2246 .size
= query
->size
- sizeof(uint32_t)},
2248 .action
= remove_audio_file
2250 if (crd
.flags
& RM_FLAG_FNM_PATHNAME
)
2251 pmd
.fnmatch_flags
|= FNM_PATHNAME
;
2252 ret
= for_each_matching_row(&pmd
);
2254 para_printf(&crd
.pb
, "%s\n", para_strerror(-ret
));
2257 if ((pmd
.num_matches
== 0) && !(crd
.flags
& RM_FLAG_FORCE
))
2258 ret
= para_printf(&crd
.pb
, "no matches -- nothing removed\n");
2259 else if (crd
.flags
& RM_FLAG_VERBOSE
) {
2260 ret
= para_printf(&crd
.pb
, "removed %u files\n",
2263 if (ret
>= 0 && crd
.pb
.offset
)
2264 pass_buffer_as_shm(crd
.pb
.buf
, crd
.pb
.offset
, &fd
);
2268 /* TODO options: -r (recursive) */
2269 int com_rm(struct command_context
*cc
)
2272 struct osl_object query
= {.data
= &flags
, .size
= sizeof(flags
)};
2275 for (i
= 1; i
< cc
->argc
; i
++) {
2276 const char *arg
= cc
->argv
[i
];
2279 if (!strcmp(arg
, "--")) {
2283 if (!strcmp(arg
, "-f")) {
2284 flags
|= RM_FLAG_FORCE
;
2287 if (!strcmp(arg
, "-p")) {
2288 flags
|= RM_FLAG_FNM_PATHNAME
;
2291 if (!strcmp(arg
, "-v")) {
2292 flags
|= RM_FLAG_VERBOSE
;
2298 return -E_AFT_SYNTAX
;
2299 ret
= send_option_arg_callback_request(&query
, cc
->argc
- i
,
2300 cc
->argv
+ i
, com_rm_callback
, afs_cb_result_handler
, cc
);
2302 sc_send_va_buffer(&cc
->scc
, "%s\n", para_strerror(-ret
));
2307 * Flags used by the cpsi command.
2312 /** Whether the lyrics id should be copied. */
2313 CPSI_FLAG_COPY_LYRICS_ID
= 1,
2314 /** Whether the image id should be copied. */
2315 CPSI_FLAG_COPY_IMAGE_ID
= 2,
2316 /** Whether the lastplayed time should be copied. */
2317 CPSI_FLAG_COPY_LASTPLAYED
= 4,
2318 /** Whether the numplayed count should be copied. */
2319 CPSI_FLAG_COPY_NUMPLAYED
= 8,
2320 /** Whether the attributes should be copied. */
2321 CPSI_FLAG_COPY_ATTRIBUTES
= 16,
2322 /** Activates verbose mode. */
2323 CPSI_FLAG_VERBOSE
= 32,
2326 /** Data passed to the action handler of com_cpsi(). */
2327 struct cpsi_action_data
{
2328 /** command line flags (see \ref cpsi_flags). */
2330 /** Message buffer. */
2331 struct para_buffer pb
;
2332 /** Values are copied from here. */
2333 struct afs_info source_afsi
;
2336 static int copy_selector_info(__a_unused
struct osl_table
*table
,
2337 struct osl_row
*row
, const char *name
, void *data
)
2339 struct cpsi_action_data
*cad
= data
;
2340 struct osl_object target_afsi_obj
;
2342 struct afs_info old_afsi
, target_afsi
;
2343 struct afsi_change_event_data aced
;
2345 ret
= get_afsi_object_of_row(row
, &target_afsi_obj
);
2348 load_afsi(&target_afsi
, &target_afsi_obj
);
2349 old_afsi
= target_afsi
;
2350 if (cad
->flags
& CPSI_FLAG_COPY_LYRICS_ID
)
2351 target_afsi
.lyrics_id
= cad
->source_afsi
.lyrics_id
;
2352 if (cad
->flags
& CPSI_FLAG_COPY_IMAGE_ID
)
2353 target_afsi
.image_id
= cad
->source_afsi
.image_id
;
2354 if (cad
->flags
& CPSI_FLAG_COPY_LASTPLAYED
)
2355 target_afsi
.last_played
= cad
->source_afsi
.last_played
;
2356 if (cad
->flags
& CPSI_FLAG_COPY_NUMPLAYED
)
2357 target_afsi
.num_played
= cad
->source_afsi
.num_played
;
2358 if (cad
->flags
& CPSI_FLAG_COPY_ATTRIBUTES
)
2359 target_afsi
.attributes
= cad
->source_afsi
.attributes
;
2360 save_afsi(&target_afsi
, &target_afsi_obj
); /* in-place update */
2361 if (cad
->flags
& CPSI_FLAG_VERBOSE
) {
2362 ret
= para_printf(&cad
->pb
, "copied afsi to %s\n", name
);
2367 aced
.old_afsi
= &old_afsi
;
2368 afs_event(AFSI_CHANGE
, &cad
->pb
, &aced
);
2372 static void com_cpsi_callback(int fd
, const struct osl_object
*query
)
2374 struct cpsi_action_data cad
= {
2375 .flags
= *(unsigned *)query
->data
,
2377 .max_size
= shm_get_shmmax(),
2378 .private_data
= &fd
,
2379 .max_size_handler
= afs_max_size_handler
2383 char *source_path
= (char *)query
->data
+ sizeof(cad
.flags
);
2384 struct pattern_match_data pmd
= {
2385 .table
= audio_file_table
,
2386 .loop_col_num
= AFTCOL_HASH
,
2387 .match_col_num
= AFTCOL_PATH
,
2388 .patterns
= {.data
= source_path
+ strlen(source_path
) + 1,
2389 .size
= query
->size
- sizeof(cad
.flags
)
2390 - strlen(source_path
) - 1},
2392 .action
= copy_selector_info
2395 ret
= get_afsi_of_path(source_path
, &cad
.source_afsi
);
2398 ret
= for_each_matching_row(&pmd
);
2401 para_printf(&cad
.pb
, "%s\n", para_strerror(-ret
));
2402 else if (cad
.flags
& CPSI_FLAG_VERBOSE
) {
2403 if (pmd
.num_matches
> 0)
2404 para_printf(&cad
.pb
, "copied requested afsi from %s "
2405 "to %u files\n", source_path
, pmd
.num_matches
);
2407 para_printf(&cad
.pb
, "nothing copied\n");
2410 pass_buffer_as_shm(cad
.pb
.buf
, cad
.pb
.offset
, &fd
);
2414 int com_cpsi(struct command_context
*cc
)
2418 struct osl_object options
= {.data
= &flags
, .size
= sizeof(flags
)};
2420 for (i
= 1; i
< cc
->argc
; i
++) {
2421 const char *arg
= cc
->argv
[i
];
2424 if (!strcmp(arg
, "--")) {
2428 if (!strcmp(arg
, "-y")) {
2429 flags
|= CPSI_FLAG_COPY_LYRICS_ID
;
2432 if (!strcmp(arg
, "-i")) {
2433 flags
|= CPSI_FLAG_COPY_IMAGE_ID
;
2436 if (!strcmp(arg
, "-l")) {
2437 flags
|= CPSI_FLAG_COPY_LASTPLAYED
;
2440 if (!strcmp(arg
, "-n")) {
2441 flags
|= CPSI_FLAG_COPY_NUMPLAYED
;
2444 if (!strcmp(arg
, "-a")) {
2445 flags
|= CPSI_FLAG_COPY_ATTRIBUTES
;
2448 if (!strcmp(arg
, "-v")) {
2449 flags
|= CPSI_FLAG_VERBOSE
;
2454 if (i
+ 1 >= cc
->argc
) /* need at least source file and pattern */
2455 return -E_AFT_SYNTAX
;
2456 if (!(flags
& ~CPSI_FLAG_VERBOSE
)) /* no copy flags given */
2457 flags
= ~(unsigned)CPSI_FLAG_VERBOSE
| flags
;
2458 ret
= send_option_arg_callback_request(&options
, cc
->argc
- i
,
2459 cc
->argv
+ i
, com_cpsi_callback
, afs_cb_result_handler
, cc
);
2461 sc_send_va_buffer(&cc
->scc
, "%s\n", para_strerror(-ret
));
2465 static void afs_stat_callback(int fd
, const struct osl_object
*query
)
2467 int *parser_friendly
= query
->data
;
2468 char *buf
= *parser_friendly
?
2469 parser_friendly_status_items
: status_items
;
2473 pass_buffer_as_shm(buf
, strlen(buf
), &fd
);
2477 * Get the current afs status items from the afs process and send it.
2479 * \param cc The command context, used e.g. for data encryption.
2480 * \param parser_friendly Whether parser-friendly output format should be used.
2482 * As the contents of the afs status items change in time and the command
2483 * handler only has a COW version created at fork time, it can not send
2484 * up-to-date afs status items directly. Therefore the usual callback mechanism
2485 * is used to pass the status items from the afs process to the command handler
2486 * via a shared memory area and a pipe.
2488 * \return The return value of the underyling call to \ref send_callback_request().
2490 int send_afs_status(struct command_context
*cc
, int parser_friendly
)
2492 struct osl_object query
= {.data
= &parser_friendly
,
2493 .size
= sizeof(parser_friendly
)};
2495 return send_callback_request(afs_stat_callback
, &query
,
2496 afs_cb_result_handler
, cc
);
2499 /* TODO: optionally fix problems by removing offending rows */
2500 static int check_audio_file(struct osl_row
*row
, void *data
)
2503 struct para_buffer
*pb
= data
;
2504 struct stat statbuf
;
2505 int ret
= get_audio_file_path_of_row(row
, &path
);
2506 struct afs_info afsi
;
2510 return para_printf(pb
, "%s\n", para_strerror(-ret
));
2511 if (stat(path
, &statbuf
) < 0) {
2512 ret
= para_printf(pb
, "%s: stat error (%s)\n", path
, strerror(errno
));
2516 if (!S_ISREG(statbuf
.st_mode
)) {
2517 ret
= para_printf(pb
, "%s: not a regular file\n", path
);
2522 ret
= get_afsi_of_row(row
, &afsi
);
2524 return para_printf(pb
, "%s: %s\n", path
, para_strerror(-ret
));
2525 ret
= lyr_get_name_by_id(afsi
.lyrics_id
, &blob_name
);
2527 ret
= para_printf(pb
, "%s lyrics id %u: %s\n", path
, afsi
.lyrics_id
,
2528 para_strerror(-ret
));
2532 ret
= img_get_name_by_id(afsi
.image_id
, &blob_name
);
2534 ret
= para_printf(pb
, "%s image id %u: %s\n", path
, afsi
.image_id
,
2535 para_strerror(-ret
));
2540 * Check the audio file table for inconsistencies.
2542 * \param fd The afs socket.
2543 * \param query Unused.
2545 * This function always succeeds.
2549 void aft_check_callback(int fd
, __a_unused
const struct osl_object
*query
)
2551 struct para_buffer pb
= {
2552 .max_size
= shm_get_shmmax(),
2553 .private_data
= &(struct afs_max_size_handler_data
) {
2556 .max_size_handler
= afs_max_size_handler
2558 int ret
= para_printf(&pb
, "checking audio file table...\n");
2562 audio_file_loop(&pb
, check_audio_file
);
2564 pass_buffer_as_shm(pb
.buf
, pb
.offset
, &fd
);
2569 * Close the audio file table.
2571 * \param flags Usual flags that are passed to osl_close_table().
2573 * \sa osl_close_table().
2575 static void aft_close(void)
2577 osl_close_table(audio_file_table
, OSL_MARK_CLEAN
);
2578 audio_file_table
= NULL
;
2582 * Open the audio file table.
2584 * \param dir The database directory.
2588 * \sa osl_open_table().
2590 static int aft_open(const char *dir
)
2594 audio_file_table_desc
.dir
= dir
;
2595 ret
= osl(osl_open_table(&audio_file_table_desc
, &audio_file_table
));
2598 osl_get_num_rows(audio_file_table
, &num
);
2599 PARA_INFO_LOG("audio file table contains %d files\n", num
);
2602 PARA_INFO_LOG("failed to open audio file table\n");
2603 audio_file_table
= NULL
;
2604 if (ret
>= 0 || ret
== -OSL_ERRNO_TO_PARA_ERROR(E_OSL_NOENT
))
2609 static int aft_create(const char *dir
)
2611 audio_file_table_desc
.dir
= dir
;
2612 return osl(osl_create_table(&audio_file_table_desc
));
2615 static int clear_attribute(struct osl_row
*row
, void *data
)
2617 struct rmatt_event_data
*red
= data
;
2618 struct afs_info afsi
;
2619 struct osl_object obj
;
2620 int ret
= get_afsi_object_of_row(row
, &obj
);
2621 uint64_t mask
= ~(1ULL << red
->bitnum
);
2625 ret
= load_afsi(&afsi
, &obj
);
2628 afsi
.attributes
&= mask
;
2629 save_afsi(&afsi
, &obj
);
2633 static int aft_event_handler(enum afs_events event
, struct para_buffer
*pb
,
2639 case ATTRIBUTE_REMOVE
: {
2640 const struct rmatt_event_data
*red
= data
;
2641 ret
= para_printf(pb
, "clearing attribute %s (bit %u) from all "
2642 "entries in the audio file table\n", red
->name
,
2646 return audio_file_loop(data
, clear_attribute
);
2654 * Initialize the audio file table.
2656 * \param t Pointer to the structure to be initialized.
2658 void aft_init(struct afs_table
*t
)
2661 t
->close
= aft_close
;
2662 t
->create
= aft_create
;
2663 t
->event_handler
= aft_event_handler
;