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 ret
= afs_event(AFSI_CHANGE
, NULL
, &aced
);
1078 ret
= save_afd(afd
);
1080 free(afd
->afhi
.chunk_table
);
1081 osl_close_disk_object(&chunk_table_obj
);
1083 PARA_ERROR_LOG("%s: %s\n", d
->path
, para_strerror(-ret
));
1084 ret
= score_delete(current_aft_row
);
1091 static int ls_audio_format_compare(const void *a
, const void *b
)
1093 struct ls_data
*d1
= *(struct ls_data
**)a
, *d2
= *(struct ls_data
**)b
;
1094 return NUM_COMPARE(d1
->afsi
.audio_format_id
, d2
->afsi
.audio_format_id
);
1097 static int ls_duration_compare(const void *a
, const void *b
)
1099 struct ls_data
*d1
= *(struct ls_data
**)a
, *d2
= *(struct ls_data
**)b
;
1100 return NUM_COMPARE(d1
->afhi
.seconds_total
, d2
->afhi
.seconds_total
);
1103 static int ls_bitrate_compare(const void *a
, const void *b
)
1105 struct ls_data
*d1
= *(struct ls_data
**)a
, *d2
= *(struct ls_data
**)b
;
1106 return NUM_COMPARE(d1
->afhi
.bitrate
, d2
->afhi
.bitrate
);
1109 static int ls_lyrics_id_compare(const void *a
, const void *b
)
1111 struct ls_data
*d1
= *(struct ls_data
**)a
, *d2
= *(struct ls_data
**)b
;
1112 return NUM_COMPARE(d1
->afsi
.lyrics_id
, d2
->afsi
.lyrics_id
);
1115 static int ls_image_id_compare(const void *a
, const void *b
)
1117 struct ls_data
*d1
= *(struct ls_data
**)a
, *d2
= *(struct ls_data
**)b
;
1118 return NUM_COMPARE(d1
->afsi
.image_id
, d2
->afsi
.image_id
);
1121 static int ls_channels_compare(const void *a
, const void *b
)
1123 struct ls_data
*d1
= *(struct ls_data
**)a
, *d2
= *(struct ls_data
**)b
;
1124 return NUM_COMPARE(d1
->afhi
.channels
, d2
->afhi
.channels
);
1127 static int ls_frequency_compare(const void *a
, const void *b
)
1129 struct ls_data
*d1
= *(struct ls_data
**)a
, *d2
= *(struct ls_data
**)b
;
1130 return NUM_COMPARE(d1
->afhi
.frequency
, d2
->afhi
.frequency
);
1133 static int ls_num_played_compare(const void *a
, const void *b
)
1135 struct ls_data
*d1
= *(struct ls_data
**)a
, *d2
= *(struct ls_data
**)b
;
1136 return NUM_COMPARE(d1
->afsi
.num_played
, d2
->afsi
.num_played
);
1139 static int ls_last_played_compare(const void *a
, const void *b
)
1141 struct ls_data
*d1
= *(struct ls_data
**)a
, *d2
= *(struct ls_data
**)b
;
1142 return NUM_COMPARE(d1
->afsi
.last_played
, d2
->afsi
.last_played
);
1145 static int ls_score_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
->score
, d2
->score
);
1151 static int ls_path_compare(const void *a
, const void *b
)
1153 struct ls_data
*d1
= *(struct ls_data
**)a
, *d2
= *(struct ls_data
**)b
;
1154 return strcmp(d1
->path
, d2
->path
);
1157 static int sort_matching_paths(struct ls_options
*options
)
1159 size_t nmemb
= options
->num_matching_paths
;
1160 size_t size
= sizeof(*options
->data_ptr
);
1161 int (*compar
)(const void *, const void *);
1164 options
->data_ptr
= para_malloc(nmemb
* sizeof(*options
->data_ptr
));
1165 for (i
= 0; i
< nmemb
; i
++)
1166 options
->data_ptr
[i
] = options
->data
+ i
;
1168 /* In these cases the array is already sorted */
1169 if (options
->sorting
== LS_SORT_BY_PATH
1170 && !(options
->flags
& LS_FLAG_ADMISSIBLE_ONLY
)
1171 && (options
->flags
& LS_FLAG_FULL_PATH
))
1173 if (options
->sorting
== LS_SORT_BY_SCORE
&&
1174 options
->flags
& LS_FLAG_ADMISSIBLE_ONLY
)
1177 switch (options
->sorting
) {
1178 case LS_SORT_BY_PATH
:
1179 compar
= ls_path_compare
; break;
1180 case LS_SORT_BY_SCORE
:
1181 compar
= ls_score_compare
; break;
1182 case LS_SORT_BY_LAST_PLAYED
:
1183 compar
= ls_last_played_compare
; break;
1184 case LS_SORT_BY_NUM_PLAYED
:
1185 compar
= ls_num_played_compare
; break;
1186 case LS_SORT_BY_FREQUENCY
:
1187 compar
= ls_frequency_compare
; break;
1188 case LS_SORT_BY_CHANNELS
:
1189 compar
= ls_channels_compare
; break;
1190 case LS_SORT_BY_IMAGE_ID
:
1191 compar
= ls_image_id_compare
; break;
1192 case LS_SORT_BY_LYRICS_ID
:
1193 compar
= ls_lyrics_id_compare
; break;
1194 case LS_SORT_BY_BITRATE
:
1195 compar
= ls_bitrate_compare
; break;
1196 case LS_SORT_BY_DURATION
:
1197 compar
= ls_duration_compare
; break;
1198 case LS_SORT_BY_AUDIO_FORMAT
:
1199 compar
= ls_audio_format_compare
; break;
1203 qsort(options
->data_ptr
, nmemb
, size
, compar
);
1207 /* row is either an aft_row or a row of the score table */
1208 /* TODO: Only compute widths if we need them */
1209 static int prepare_ls_row(struct osl_row
*row
, void *ls_opts
)
1212 struct ls_options
*options
= ls_opts
;
1214 struct ls_widths
*w
;
1215 unsigned short num_digits
;
1217 struct osl_row
*aft_row
;
1221 if (options
->flags
& LS_FLAG_ADMISSIBLE_ONLY
) {
1222 ret
= get_score_and_aft_row(row
, &score
, &aft_row
);
1229 ret
= get_audio_file_path_of_row(aft_row
, &path
);
1232 if (!(options
->flags
& LS_FLAG_FULL_PATH
)) {
1233 char *p
= strrchr(path
, '/');
1237 if (options
->num_patterns
) {
1238 for (i
= 0; i
< options
->num_patterns
; i
++) {
1239 ret
= fnmatch(options
->patterns
[i
], path
, 0);
1242 if (ret
== FNM_NOMATCH
)
1246 if (i
>= options
->num_patterns
) /* no match */
1249 tmp
= options
->num_matching_paths
++;
1250 if (options
->num_matching_paths
> options
->array_size
) {
1251 options
->array_size
++;
1252 options
->array_size
*= 2;
1253 options
->data
= para_realloc(options
->data
, options
->array_size
1254 * sizeof(*options
->data
));
1256 d
= options
->data
+ tmp
;
1257 ret
= get_afsi_of_row(aft_row
, &d
->afsi
);
1260 ret
= get_afhi_of_row(aft_row
, &d
->afhi
);
1264 ret
= get_hash_of_row(aft_row
, &d
->hash
);
1267 w
= &options
->widths
;
1268 GET_NUM_DIGITS(d
->afsi
.image_id
, &num_digits
);
1269 w
->image_id_width
= PARA_MAX(w
->image_id_width
, num_digits
);
1270 GET_NUM_DIGITS(d
->afsi
.lyrics_id
, &num_digits
);
1271 w
->lyrics_id_width
= PARA_MAX(w
->lyrics_id_width
, num_digits
);
1272 GET_NUM_DIGITS(d
->afhi
.bitrate
, &num_digits
);
1273 w
->bitrate_width
= PARA_MAX(w
->bitrate_width
, num_digits
);
1274 GET_NUM_DIGITS(d
->afhi
.frequency
, &num_digits
);
1275 w
->frequency_width
= PARA_MAX(w
->frequency_width
, num_digits
);
1276 GET_NUM_DIGITS(d
->afsi
.num_played
, &num_digits
);
1277 w
->num_played_width
= PARA_MAX(w
->num_played_width
, num_digits
);
1278 /* get the number of chars to print this amount of time */
1279 num_digits
= get_duration_width(d
->afhi
.seconds_total
);
1280 w
->duration_width
= PARA_MAX(w
->duration_width
, num_digits
);
1281 GET_NUM_DIGITS(d
->afsi
.amp
, &num_digits
);
1282 w
->amp_width
= PARA_MAX(w
->amp_width
, num_digits
);
1283 num_digits
= strlen(audio_format_name(d
->afsi
.audio_format_id
));
1284 w
->audio_format_width
= PARA_MAX(w
->audio_format_width
, num_digits
);
1285 if (options
->flags
& LS_FLAG_ADMISSIBLE_ONLY
) {
1286 GET_NUM_DIGITS(score
, &num_digits
);
1287 num_digits
++; /* add one for the sign (space or "-") */
1288 w
->score_width
= PARA_MAX(w
->score_width
, num_digits
);
1296 static int com_ls_callback(struct afs_callback_arg
*aca
)
1298 struct ls_options
*opts
= aca
->query
.data
;
1299 char *p
, *pattern_start
= (char *)aca
->query
.data
+ sizeof(*opts
);
1301 time_t current_time
;
1303 aca
->pbout
.flags
= (opts
->mode
== LS_MODE_PARSER
)? PBF_SIZE_PREFIX
: 0;
1304 if (opts
->num_patterns
) {
1305 opts
->patterns
= para_malloc(opts
->num_patterns
* sizeof(char *));
1306 for (i
= 0, p
= pattern_start
; i
< opts
->num_patterns
; i
++) {
1307 opts
->patterns
[i
] = p
;
1311 opts
->patterns
= NULL
;
1312 if (opts
->flags
& LS_FLAG_ADMISSIBLE_ONLY
)
1313 ret
= admissible_file_loop(opts
, prepare_ls_row
);
1315 ret
= osl(osl_rbtree_loop(audio_file_table
, AFTCOL_PATH
, opts
,
1319 if (opts
->num_matching_paths
== 0) {
1320 ret
= opts
->num_patterns
> 0? -E_NO_MATCH
: 0;
1323 ret
= sort_matching_paths(opts
);
1326 time(¤t_time
);
1327 if (opts
->flags
& LS_FLAG_REVERSE
)
1328 for (i
= opts
->num_matching_paths
- 1; i
>= 0; i
--) {
1329 ret
= print_list_item(opts
->data_ptr
[i
], opts
,
1330 &aca
->pbout
, current_time
);
1335 for (i
= 0; i
< opts
->num_matching_paths
; i
++) {
1336 ret
= print_list_item(opts
->data_ptr
[i
], opts
,
1337 &aca
->pbout
, current_time
);
1343 free(opts
->data_ptr
);
1344 free(opts
->patterns
);
1349 * TODO: flags -h (sort by hash)
1351 int com_ls(struct command_context
*cc
)
1355 enum ls_sorting_method sort
= LS_SORT_BY_PATH
;
1356 enum ls_listing_mode mode
= LS_MODE_SHORT
;
1357 struct ls_options opts
= {.patterns
= NULL
};
1358 struct osl_object query
= {.data
= &opts
, .size
= sizeof(opts
)};
1360 for (i
= 1; i
< cc
->argc
; i
++) {
1361 const char *arg
= cc
->argv
[i
];
1364 if (!strcmp(arg
, "--")) {
1368 if (!strncmp(arg
, "-l", 2)) {
1370 mode
= LS_MODE_LONG
;
1374 return -E_AFT_SYNTAX
;
1375 switch(*(arg
+ 2)) {
1377 mode
= LS_MODE_SHORT
;
1380 mode
= LS_MODE_LONG
;
1383 mode
= LS_MODE_VERBOSE
;
1386 mode
= LS_MODE_MBOX
;
1389 mode
= LS_MODE_CHUNKS
;
1392 mode
= LS_MODE_PARSER
;
1395 return -E_AFT_SYNTAX
;
1398 if (!strcmp(arg
, "-p")) {
1399 flags
|= LS_FLAG_FULL_PATH
;
1402 if (!strcmp(arg
, "-a")) {
1403 flags
|= LS_FLAG_ADMISSIBLE_ONLY
;
1406 if (!strcmp(arg
, "-r")) {
1407 flags
|= LS_FLAG_REVERSE
;
1410 if (!strcmp(arg
, "-d")) {
1411 flags
|= LS_FLAG_UNIXDATE
;
1414 if (!strncmp(arg
, "-s", 2)) {
1415 if (!*(arg
+ 2) || *(arg
+ 3))
1416 return -E_AFT_SYNTAX
;
1417 switch(*(arg
+ 2)) {
1419 sort
= LS_SORT_BY_PATH
;
1421 case 's': /* -ss implies -a */
1422 sort
= LS_SORT_BY_SCORE
;
1423 flags
|= LS_FLAG_ADMISSIBLE_ONLY
;
1426 sort
= LS_SORT_BY_LAST_PLAYED
;
1429 sort
= LS_SORT_BY_NUM_PLAYED
;
1432 sort
= LS_SORT_BY_FREQUENCY
;
1435 sort
= LS_SORT_BY_CHANNELS
;
1438 sort
= LS_SORT_BY_IMAGE_ID
;
1441 sort
= LS_SORT_BY_LYRICS_ID
;
1444 sort
= LS_SORT_BY_BITRATE
;
1447 sort
= LS_SORT_BY_DURATION
;
1450 sort
= LS_SORT_BY_AUDIO_FORMAT
;
1453 return -E_AFT_SYNTAX
;
1456 return -E_AFT_SYNTAX
;
1459 opts
.sorting
= sort
;
1461 opts
.num_patterns
= cc
->argc
- i
;
1462 return send_option_arg_callback_request(&query
, opts
.num_patterns
,
1463 cc
->argv
+ i
, com_ls_callback
, afs_cb_result_handler
, cc
);
1467 * Call the given function for each file in the audio file table.
1469 * \param private_data An arbitrary data pointer, passed to \a func.
1470 * \param func The custom function to be called.
1474 int audio_file_loop(void *private_data
, osl_rbtree_loop_func
*func
)
1476 return osl(osl_rbtree_loop(audio_file_table
, AFTCOL_HASH
, private_data
,
1480 static int find_hash_sister(unsigned char *hash
, struct osl_row
**result
)
1482 int ret
= aft_get_row_of_hash(hash
, result
);
1484 if (ret
== -OSL_ERRNO_TO_PARA_ERROR(E_OSL_RB_KEY_NOT_FOUND
))
1489 static int find_path_brother(const char *path
, struct osl_row
**result
)
1491 int ret
= aft_get_row_of_path(path
, result
);
1493 if (ret
== -OSL_ERRNO_TO_PARA_ERROR(E_OSL_RB_KEY_NOT_FOUND
))
1498 /** The format of the data stored by save_audio_file_data(). */
1499 enum com_add_buffer_offsets
{
1500 /** afhi (if present) starts here. */
1501 CAB_AFHI_OFFSET_POS
= 0,
1502 /** Start of the chunk table (if present). */
1503 CAB_CHUNKS_OFFSET_POS
= 2,
1504 /** Audio format id. */
1505 CAB_AUDIO_FORMAT_OFFSET
= 4,
1506 /** Flags given to the add command. */
1507 CAB_FLAGS_OFFSET
= 5,
1508 /** The hash of the audio file being added. */
1509 CAB_HASH_OFFSET
= 9,
1510 /** Start of the path of the audio file. */
1511 CAB_PATH_OFFSET
= (CAB_HASH_OFFSET
+ HASH_SIZE
),
1515 * Store the given data to a single buffer. Doesn't need the audio file selector
1516 * info struct as the server knows it as well.
1518 * It's OK to call this with afhi == NULL. In this case, the audio format
1519 * handler info won't be stored in the buffer.
1521 static void save_add_callback_buffer(unsigned char *hash
, const char *path
,
1522 struct afh_info
*afhi
, uint32_t flags
,
1523 uint8_t audio_format_num
, struct osl_object
*obj
)
1525 size_t path_len
= strlen(path
) + 1;
1526 size_t afhi_size
= sizeof_afhi_buf(afhi
);
1527 size_t size
= CAB_PATH_OFFSET
+ path_len
+ afhi_size
1528 + sizeof_chunk_table(afhi
);
1529 char *buf
= para_malloc(size
);
1532 write_u8(buf
+ CAB_AUDIO_FORMAT_OFFSET
, audio_format_num
);
1533 write_u32(buf
+ CAB_FLAGS_OFFSET
, flags
);
1535 memcpy(buf
+ CAB_HASH_OFFSET
, hash
, HASH_SIZE
);
1536 strcpy(buf
+ CAB_PATH_OFFSET
, path
);
1538 pos
= CAB_PATH_OFFSET
+ path_len
;
1539 PARA_DEBUG_LOG("size: %zu, afhi starts at %d\n", size
, pos
);
1540 PARA_DEBUG_LOG("last afhi byte: %p, pos %zu\n", buf
+ pos
+ afhi_size
- 1,
1541 pos
+ afhi_size
- 1);
1542 write_u16(buf
+ CAB_AFHI_OFFSET_POS
, pos
);
1543 save_afhi(afhi
, buf
+ pos
);
1546 PARA_DEBUG_LOG("size: %zu, chunks start at %d\n", size
, pos
);
1547 write_u16(buf
+ CAB_CHUNKS_OFFSET_POS
, pos
);
1549 save_chunk_table(afhi
, buf
+ pos
);
1550 PARA_DEBUG_LOG("last byte in buf: %p\n", buf
+ size
- 1);
1557 Overview of the add command.
1559 Input: What was passed to the callback by the command handler.
1561 HS: Hash sister. Whether an audio file with identical hash
1562 already exists in the osl database.
1564 PB: Path brother. Whether a file with the given path exists
1567 F: Force flag given. Whether add was called with -f.
1569 output: Action performed by the callback.
1571 AFHI: Whether afhi and chunk table are computed and sent.
1572 ACTION: Table modifications to be done by the callback.
1574 +----+----+---+------+---------------------------------------------------+
1575 | HS | PB | F | AFHI | ACTION
1576 +----+----+---+------+---------------------------------------------------+
1577 | Y | Y | Y | Y | if HS != PB: remove PB. HS: force afhi update,
1578 | | update path, keep afsi
1579 +----+----+---+------+---------------------------------------------------+
1580 | Y | Y | N | N | if HS == PB: do not send callback request at all.
1581 | | otherwise: remove PB, HS: update path, keep afhi,
1583 +----+----+---+------+---------------------------------------------------+
1584 | Y | N | Y | Y | (rename) force afhi update of HS, update path of
1586 +----+----+---+------+---------------------------------------------------+
1587 | Y | N | N | N | (file rename) update path of HS, keep afsi, afhi
1588 +----+----+---+------+---------------------------------------------------+
1589 | N | Y | Y | Y | (file change) update afhi, hash, of PB, keep afsi
1590 | | (force has no effect)
1591 +----+----+---+------+---------------------------------------------------+
1592 | N | Y | N | Y | (file change) update afhi, hash of PB, keep afsi
1593 +----+----+---+------+---------------------------------------------------+
1594 | N | N | Y | Y | (new file) create new entry (force has no effect)
1595 +----+----+---+------+---------------------------------------------------+
1596 | N | N | N | Y | (new file) create new entry
1597 +----+----+---+------+---------------------------------------------------+
1601 afhi <=> force or no HS
1606 /** Flags passed to the add command. */
1607 enum com_add_flags
{
1608 /** Skip paths that exist already. */
1610 /** Force adding. */
1612 /** Print what is being done. */
1613 ADD_FLAG_VERBOSE
= 4,
1614 /** Try to add files with unknown suffixes. */
1618 static int com_add_callback(struct afs_callback_arg
*aca
)
1620 char *buf
= aca
->query
.data
, *path
;
1621 struct osl_row
*pb
, *aft_row
;
1623 struct osl_object objs
[NUM_AFT_COLUMNS
];
1624 unsigned char *hash
;
1625 char asc
[2 * HASH_SIZE
+ 1];
1627 char afsi_buf
[AFSI_SIZE
];
1628 uint32_t flags
= read_u32(buf
+ CAB_FLAGS_OFFSET
);
1629 struct afs_info default_afsi
= {.last_played
= 0};
1630 uint16_t afhi_offset
, chunks_offset
;
1632 hash
= (unsigned char *)buf
+ CAB_HASH_OFFSET
;
1633 hash_to_asc(hash
, asc
);
1634 objs
[AFTCOL_HASH
].data
= buf
+ CAB_HASH_OFFSET
;
1635 objs
[AFTCOL_HASH
].size
= HASH_SIZE
;
1637 path
= buf
+ CAB_PATH_OFFSET
;
1638 objs
[AFTCOL_PATH
].data
= path
;
1639 objs
[AFTCOL_PATH
].size
= strlen(path
) + 1;
1641 PARA_INFO_LOG("request to add %s\n", path
);
1642 ret
= find_hash_sister(hash
, &hs
);
1645 ret
= find_path_brother(path
, &pb
);
1648 if (hs
&& pb
&& hs
== pb
&& !(flags
& ADD_FLAG_FORCE
)) {
1649 if (flags
& ADD_FLAG_VERBOSE
)
1650 para_printf(&aca
->pbout
, "ignoring duplicate\n");
1654 if (hs
&& hs
!= pb
) {
1655 struct osl_object obj
;
1656 if (pb
) { /* hs trumps pb, remove pb */
1657 if (flags
& ADD_FLAG_VERBOSE
)
1658 para_printf(&aca
->pbout
, "removing %s\n", path
);
1659 ret
= afs_event(AUDIO_FILE_REMOVE
, &aca
->pbout
, 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(&aca
->pbout
, "renamed from %s\n",
1676 ret
= osl(osl_update_object(audio_file_table
, hs
, AFTCOL_PATH
,
1677 &objs
[AFTCOL_PATH
]));
1680 ret
= afs_event(AUDIO_FILE_RENAME
, &aca
->pbout
, hs
);
1683 if (!(flags
& ADD_FLAG_FORCE
))
1686 /* no hs or force mode, child must have sent afhi */
1687 afhi_offset
= read_u16(buf
+ CAB_AFHI_OFFSET_POS
);
1688 chunks_offset
= read_u16(buf
+ CAB_CHUNKS_OFFSET_POS
);
1690 objs
[AFTCOL_AFHI
].data
= buf
+ afhi_offset
;
1691 objs
[AFTCOL_AFHI
].size
= chunks_offset
- afhi_offset
;
1693 if (!objs
[AFTCOL_AFHI
].size
) /* "impossible" */
1695 objs
[AFTCOL_CHUNKS
].data
= buf
+ chunks_offset
;
1696 objs
[AFTCOL_CHUNKS
].size
= aca
->query
.size
- chunks_offset
;
1697 if (pb
&& !hs
) { /* update pb's hash */
1698 char old_asc
[2 * HASH_SIZE
+ 1];
1699 unsigned char *old_hash
;
1700 ret
= get_hash_of_row(pb
, &old_hash
);
1703 hash_to_asc(old_hash
, old_asc
);
1704 if (flags
& ADD_FLAG_VERBOSE
)
1705 para_printf(&aca
->pbout
, "file change: %s -> %s\n",
1707 ret
= osl_update_object(audio_file_table
, pb
, AFTCOL_HASH
,
1708 &objs
[AFTCOL_HASH
]);
1712 if (hs
|| pb
) { /* (hs != NULL and pb != NULL) implies hs == pb */
1713 struct osl_row
*row
= pb
? pb
: hs
;
1714 /* update afhi and chunk_table */
1715 if (flags
& ADD_FLAG_VERBOSE
)
1716 para_printf(&aca
->pbout
,
1717 "updating afhi and chunk table\n");
1718 ret
= osl(osl_update_object(audio_file_table
, row
, AFTCOL_AFHI
,
1719 &objs
[AFTCOL_AFHI
]));
1722 ret
= osl(osl_update_object(audio_file_table
, row
, AFTCOL_CHUNKS
,
1723 &objs
[AFTCOL_CHUNKS
]));
1726 ret
= afs_event(AFHI_CHANGE
, &aca
->pbout
, row
);
1731 /* new entry, use default afsi */
1732 if (flags
& ADD_FLAG_VERBOSE
)
1733 para_printf(&aca
->pbout
, "new file\n");
1734 default_afsi
.last_played
= time(NULL
) - 365 * 24 * 60 * 60;
1735 default_afsi
.audio_format_id
= read_u8(buf
+ CAB_AUDIO_FORMAT_OFFSET
);
1737 objs
[AFTCOL_AFSI
].data
= &afsi_buf
;
1738 objs
[AFTCOL_AFSI
].size
= AFSI_SIZE
;
1739 save_afsi(&default_afsi
, &objs
[AFTCOL_AFSI
]);
1740 ret
= osl(osl_add_and_get_row(audio_file_table
, objs
, &aft_row
));
1741 ret
= afs_event(AUDIO_FILE_ADD
, &aca
->pbout
, aft_row
);
1744 para_printf(&aca
->pbout
, "could not add %s\n", path
);
1748 /** Used by com_add(). */
1749 struct private_add_data
{
1750 /** The pointer passed to the original command handler. */
1751 struct command_context
*cc
;
1752 /** The given add flags. */
1756 static int path_brother_callback(struct afs_callback_arg
*aca
)
1758 char *path
= aca
->query
.data
;
1759 struct osl_row
*path_brother
;
1760 int ret
= find_path_brother(path
, &path_brother
);
1763 return pass_buffer_as_shm(aca
->fd
, SBD_OUTPUT
, (char *)&path_brother
,
1764 sizeof(path_brother
));
1767 static int hash_sister_callback(struct afs_callback_arg
*aca
)
1769 unsigned char *hash
= aca
->query
.data
;
1770 struct osl_row
*hash_sister
;
1771 int ret
= find_hash_sister(hash
, &hash_sister
);
1775 return pass_buffer_as_shm(aca
->fd
, SBD_OUTPUT
, (char *)&hash_sister
,
1776 sizeof(hash_sister
));
1779 static int get_row_pointer_from_result(struct osl_object
*result
,
1780 __a_unused
uint8_t band
, void *private)
1782 struct osl_row
**row
= private;
1784 if (band
== SBD_OUTPUT
)
1785 *row
= *(struct osl_row
**)(result
->data
);
1789 static int add_one_audio_file(const char *path
, void *private_data
)
1791 int ret
, send_ret
= 1, fd
;
1792 uint8_t format_num
= -1;
1793 struct private_add_data
*pad
= private_data
;
1794 struct afh_info afhi
, *afhi_ptr
= NULL
;
1795 struct osl_row
*pb
= NULL
, *hs
= NULL
; /* path brother/hash sister */
1796 struct osl_object map
, obj
= {.data
= NULL
}, query
;
1797 unsigned char hash
[HASH_SIZE
];
1799 ret
= guess_audio_format(path
);
1800 if (ret
< 0 && !(pad
->flags
& ADD_FLAG_ALL
)) {
1804 query
.data
= (char *)path
;
1805 query
.size
= strlen(path
) + 1;
1806 ret
= send_callback_request(path_brother_callback
, &query
,
1807 get_row_pointer_from_result
, &pb
);
1808 if (ret
< 0 && ret
!= -OSL_ERRNO_TO_PARA_ERROR(E_OSL_RB_KEY_NOT_FOUND
))
1811 if (pb
&& (pad
->flags
& ADD_FLAG_LAZY
)) { /* lazy is really cheap */
1812 if (pad
->flags
& ADD_FLAG_VERBOSE
)
1813 send_ret
= send_sb_va(&pad
->cc
->scc
, SBD_OUTPUT
,
1814 "lazy-ignore: %s\n", path
);
1817 /* We still want to add this file. Compute its hash. */
1818 ret
= mmap_full_file(path
, O_RDONLY
, &map
.data
, &map
.size
, &fd
);
1821 hash_function(map
.data
, map
.size
, hash
);
1823 /* Check whether the database contains a file with the same hash. */
1825 query
.size
= HASH_SIZE
;
1826 ret
= send_callback_request(hash_sister_callback
, &query
,
1827 get_row_pointer_from_result
, &hs
);
1830 /* Return success if we already know this file. */
1832 if (pb
&& hs
&& hs
== pb
&& !(pad
->flags
& ADD_FLAG_FORCE
)) {
1833 if (pad
->flags
& ADD_FLAG_VERBOSE
)
1834 send_ret
= send_sb_va(&pad
->cc
->scc
, SBD_OUTPUT
,
1835 "%s exists, not forcing update\n", path
);
1839 * We won't recalculate the audio format info and the chunk table if
1840 * there is a hash sister and FORCE was not given.
1842 if (!hs
|| (pad
->flags
& ADD_FLAG_FORCE
)) {
1843 ret
= compute_afhi(path
, map
.data
, map
.size
, fd
, &afhi
);
1849 munmap(map
.data
, map
.size
);
1851 if (pad
->flags
& ADD_FLAG_VERBOSE
) {
1852 send_ret
= send_sb_va(&pad
->cc
->scc
, SBD_OUTPUT
,
1853 "adding %s\n", path
);
1857 save_add_callback_buffer(hash
, path
, afhi_ptr
, pad
->flags
, format_num
, &obj
);
1858 /* Ask afs to consider this entry for adding. */
1859 ret
= send_callback_request(com_add_callback
, &obj
,
1860 afs_cb_result_handler
, pad
->cc
);
1865 munmap(map
.data
, map
.size
);
1867 if (ret
< 0 && send_ret
>= 0)
1868 send_ret
= send_sb_va(&pad
->cc
->scc
, SBD_ERROR_LOG
,
1869 "failed to add %s (%s)\n", path
, para_strerror(-ret
));
1871 clear_afhi(afhi_ptr
);
1872 /* Stop adding files only on send errors. */
1876 int com_add(struct command_context
*cc
)
1879 struct private_add_data pad
= {.cc
= cc
, .flags
= 0};
1881 for (i
= 1; i
< cc
->argc
; i
++) {
1882 const char *arg
= cc
->argv
[i
];
1885 if (!strcmp(arg
, "--")) {
1889 if (!strcmp(arg
, "-a")) {
1890 pad
.flags
|= ADD_FLAG_ALL
;
1893 if (!strcmp(arg
, "-l")) {
1894 pad
.flags
|= ADD_FLAG_LAZY
;
1897 if (!strcmp(arg
, "-f")) {
1898 pad
.flags
|= ADD_FLAG_FORCE
;
1901 if (!strcmp(arg
, "-v")) {
1902 pad
.flags
|= ADD_FLAG_VERBOSE
;
1907 return -E_AFT_SYNTAX
;
1908 for (; i
< cc
->argc
; i
++) {
1910 ret
= verify_path(cc
->argv
[i
], &path
);
1912 ret
= send_sb_va(&cc
->scc
, SBD_ERROR_LOG
, "%s: %s\n",
1913 cc
->argv
[i
], para_strerror(-ret
));
1918 if (ret
== 1) /* directory */
1919 ret
= for_each_file_in_dir(path
, add_one_audio_file
,
1921 else /* regular file */
1922 ret
= add_one_audio_file(path
, &pad
);
1924 send_sb_va(&cc
->scc
, SBD_OUTPUT
, "%s: %s\n", path
,
1925 para_strerror(-ret
));
1935 * Flags used by the touch command.
1940 /** Whether the \p FNM_PATHNAME flag should be passed to fnmatch(). */
1941 TOUCH_FLAG_FNM_PATHNAME
= 1,
1942 /** Activates verbose mode. */
1943 TOUCH_FLAG_VERBOSE
= 2
1946 /** Options used by com_touch(). */
1947 struct com_touch_options
{
1948 /** New num_played value. */
1950 /** New last played count. */
1951 int64_t last_played
;
1952 /** New lyrics id. */
1954 /** New image id. */
1956 /** New amplification value. */
1958 /** Command line flags (see \ref touch_flags). */
1962 static int touch_audio_file(__a_unused
struct osl_table
*table
,
1963 struct osl_row
*row
, const char *name
, void *data
)
1965 struct afs_callback_arg
*aca
= data
;
1966 struct com_touch_options
*cto
= aca
->query
.data
;
1967 struct osl_object obj
;
1968 struct afs_info old_afsi
, new_afsi
;
1969 int ret
, no_options
= cto
->num_played
< 0 && cto
->last_played
< 0 &&
1970 cto
->lyrics_id
< 0 && cto
->image_id
< 0 && cto
->amp
< 0;
1971 struct afsi_change_event_data aced
;
1973 ret
= get_afsi_object_of_row(row
, &obj
);
1975 para_printf(&aca
->pbout
, "cannot touch %s\n", name
);
1978 ret
= load_afsi(&old_afsi
, &obj
);
1980 para_printf(&aca
->pbout
, "cannot touch %s\n", name
);
1983 new_afsi
= old_afsi
;
1985 new_afsi
.num_played
++;
1986 new_afsi
.last_played
= time(NULL
);
1987 if (cto
->flags
& TOUCH_FLAG_VERBOSE
)
1988 para_printf(&aca
->pbout
, "%s: num_played = %u, "
1989 "last_played = now()\n", name
,
1990 new_afsi
.num_played
);
1992 if (cto
->flags
& TOUCH_FLAG_VERBOSE
)
1993 para_printf(&aca
->pbout
, "touching %s\n", name
);
1994 if (cto
->lyrics_id
>= 0)
1995 new_afsi
.lyrics_id
= cto
->lyrics_id
;
1996 if (cto
->image_id
>= 0)
1997 new_afsi
.image_id
= cto
->image_id
;
1998 if (cto
->num_played
>= 0)
1999 new_afsi
.num_played
= cto
->num_played
;
2000 if (cto
->last_played
>= 0)
2001 new_afsi
.last_played
= cto
->last_played
;
2003 new_afsi
.amp
= cto
->amp
;
2005 save_afsi(&new_afsi
, &obj
); /* in-place update */
2007 aced
.old_afsi
= &old_afsi
;
2008 return afs_event(AFSI_CHANGE
, &aca
->pbout
, &aced
);
2011 static int com_touch_callback(struct afs_callback_arg
*aca
)
2014 struct com_touch_options
*cto
= aca
->query
.data
;
2015 struct pattern_match_data pmd
= {
2016 .table
= audio_file_table
,
2017 .loop_col_num
= AFTCOL_HASH
,
2018 .match_col_num
= AFTCOL_PATH
,
2020 .data
= (char *)aca
->query
.data
2021 + sizeof(struct com_touch_options
),
2022 .size
= aca
->query
.size
2023 - sizeof(struct com_touch_options
)
2026 .action
= touch_audio_file
2028 if (cto
->flags
& TOUCH_FLAG_FNM_PATHNAME
)
2029 pmd
.fnmatch_flags
|= FNM_PATHNAME
;
2030 ret
= for_each_matching_row(&pmd
);
2031 if (ret
>= 0 && pmd
.num_matches
== 0)
2036 int com_touch(struct command_context
*cc
)
2038 struct com_touch_options cto
= {
2045 struct osl_object query
= {.data
= &cto
, .size
= sizeof(cto
)};
2049 for (i
= 1; i
< cc
->argc
; i
++) {
2050 const char *arg
= cc
->argv
[i
];
2053 if (!strcmp(arg
, "--")) {
2057 if (!strncmp(arg
, "-n=", 3)) {
2058 ret
= para_atoi32(arg
+ 3, &cto
.num_played
);
2063 if (!strncmp(arg
, "-l=", 3)) {
2064 ret
= para_atoi64(arg
+ 3, &cto
.last_played
);
2069 if (!strncmp(arg
, "-y=", 3)) {
2070 ret
= para_atoi32(arg
+ 3, &cto
.lyrics_id
);
2075 if (!strncmp(arg
, "-i=", 3)) {
2076 ret
= para_atoi32(arg
+ 3, &cto
.image_id
);
2081 if (!strncmp(arg
, "-a=", 3)) {
2083 ret
= para_atoi32(arg
+ 3, &val
);
2086 if (val
< 0 || val
> 255)
2087 return -ERRNO_TO_PARA_ERROR(EINVAL
);
2091 if (!strcmp(arg
, "-p")) {
2092 cto
.flags
|= TOUCH_FLAG_FNM_PATHNAME
;
2095 if (!strcmp(arg
, "-v")) {
2096 cto
.flags
|= TOUCH_FLAG_VERBOSE
;
2099 break; /* non-option starting with dash */
2102 return -E_AFT_SYNTAX
;
2103 return send_option_arg_callback_request(&query
, cc
->argc
- i
,
2104 cc
->argv
+ i
, com_touch_callback
, afs_cb_result_handler
, cc
);
2107 /** Flags for com_rm(). */
2110 RM_FLAG_VERBOSE
= 1,
2114 RM_FLAG_FNM_PATHNAME
= 4
2117 static int remove_audio_file(__a_unused
struct osl_table
*table
,
2118 struct osl_row
*row
, const char *name
, void *data
)
2120 struct afs_callback_arg
*aca
= data
;
2121 uint32_t flags
=*(uint32_t *)aca
->query
.data
;
2124 if (flags
& RM_FLAG_VERBOSE
)
2125 para_printf(&aca
->pbout
, "removing %s\n", name
);
2126 ret
= afs_event(AUDIO_FILE_REMOVE
, &aca
->pbout
, row
);
2129 ret
= osl(osl_del_row(audio_file_table
, row
));
2131 para_printf(&aca
->pbout
, "cannot remove %s\n", name
);
2135 static int com_rm_callback(struct afs_callback_arg
*aca
)
2138 uint32_t flags
= *(uint32_t *)aca
->query
.data
;
2139 struct pattern_match_data pmd
= {
2140 .table
= audio_file_table
,
2141 .loop_col_num
= AFTCOL_HASH
,
2142 .match_col_num
= AFTCOL_PATH
,
2143 .patterns
= {.data
= (char *)aca
->query
.data
+ sizeof(uint32_t),
2144 .size
= aca
->query
.size
- sizeof(uint32_t)},
2146 .action
= remove_audio_file
2148 if (flags
& RM_FLAG_FNM_PATHNAME
)
2149 pmd
.fnmatch_flags
|= FNM_PATHNAME
;
2150 ret
= for_each_matching_row(&pmd
);
2153 if (pmd
.num_matches
== 0)
2155 else if (flags
& RM_FLAG_VERBOSE
)
2156 para_printf(&aca
->pbout
, "removed %u file(s)\n",
2162 /* TODO options: -r (recursive) */
2163 int com_rm(struct command_context
*cc
)
2166 struct osl_object query
= {.data
= &flags
, .size
= sizeof(flags
)};
2169 for (i
= 1; i
< cc
->argc
; i
++) {
2170 const char *arg
= cc
->argv
[i
];
2173 if (!strcmp(arg
, "--")) {
2177 if (!strcmp(arg
, "-f")) {
2178 flags
|= RM_FLAG_FORCE
;
2181 if (!strcmp(arg
, "-p")) {
2182 flags
|= RM_FLAG_FNM_PATHNAME
;
2185 if (!strcmp(arg
, "-v")) {
2186 flags
|= RM_FLAG_VERBOSE
;
2192 return -E_AFT_SYNTAX
;
2193 return send_option_arg_callback_request(&query
, cc
->argc
- i
,
2194 cc
->argv
+ i
, com_rm_callback
, afs_cb_result_handler
, cc
);
2198 * Flags used by the cpsi command.
2203 /** Whether the lyrics id should be copied. */
2204 CPSI_FLAG_COPY_LYRICS_ID
= 1,
2205 /** Whether the image id should be copied. */
2206 CPSI_FLAG_COPY_IMAGE_ID
= 2,
2207 /** Whether the lastplayed time should be copied. */
2208 CPSI_FLAG_COPY_LASTPLAYED
= 4,
2209 /** Whether the numplayed count should be copied. */
2210 CPSI_FLAG_COPY_NUMPLAYED
= 8,
2211 /** Whether the attributes should be copied. */
2212 CPSI_FLAG_COPY_ATTRIBUTES
= 16,
2213 /** Activates verbose mode. */
2214 CPSI_FLAG_VERBOSE
= 32,
2217 /** Data passed to the action handler of com_cpsi(). */
2218 struct cpsi_action_data
{
2219 /** command line flags (see \ref cpsi_flags). */
2221 /** Values are copied from here. */
2222 struct afs_info source_afsi
;
2223 /** What was passed to com_cpsi_callback(). */
2224 struct afs_callback_arg
*aca
;
2227 static int copy_selector_info(__a_unused
struct osl_table
*table
,
2228 struct osl_row
*row
, const char *name
, void *data
)
2230 struct cpsi_action_data
*cad
= data
;
2231 struct osl_object target_afsi_obj
;
2233 struct afs_info old_afsi
, target_afsi
;
2234 struct afsi_change_event_data aced
;
2236 ret
= get_afsi_object_of_row(row
, &target_afsi_obj
);
2239 load_afsi(&target_afsi
, &target_afsi_obj
);
2240 old_afsi
= target_afsi
;
2241 if (cad
->flags
& CPSI_FLAG_COPY_LYRICS_ID
)
2242 target_afsi
.lyrics_id
= cad
->source_afsi
.lyrics_id
;
2243 if (cad
->flags
& CPSI_FLAG_COPY_IMAGE_ID
)
2244 target_afsi
.image_id
= cad
->source_afsi
.image_id
;
2245 if (cad
->flags
& CPSI_FLAG_COPY_LASTPLAYED
)
2246 target_afsi
.last_played
= cad
->source_afsi
.last_played
;
2247 if (cad
->flags
& CPSI_FLAG_COPY_NUMPLAYED
)
2248 target_afsi
.num_played
= cad
->source_afsi
.num_played
;
2249 if (cad
->flags
& CPSI_FLAG_COPY_ATTRIBUTES
)
2250 target_afsi
.attributes
= cad
->source_afsi
.attributes
;
2251 save_afsi(&target_afsi
, &target_afsi_obj
); /* in-place update */
2252 if (cad
->flags
& CPSI_FLAG_VERBOSE
)
2253 para_printf(&cad
->aca
->pbout
, "copied afsi to %s\n", name
);
2255 aced
.old_afsi
= &old_afsi
;
2256 return afs_event(AFSI_CHANGE
, &cad
->aca
->pbout
, &aced
);
2259 static int com_cpsi_callback(struct afs_callback_arg
*aca
)
2261 struct cpsi_action_data cad
= {
2262 .flags
= *(unsigned *)aca
->query
.data
,
2266 char *source_path
= (char *)aca
->query
.data
+ sizeof(cad
.flags
);
2267 struct pattern_match_data pmd
= {
2268 .table
= audio_file_table
,
2269 .loop_col_num
= AFTCOL_HASH
,
2270 .match_col_num
= AFTCOL_PATH
,
2271 .patterns
= {.data
= source_path
+ strlen(source_path
) + 1,
2272 .size
= aca
->query
.size
- sizeof(cad
.flags
)
2273 - strlen(source_path
) - 1},
2275 .action
= copy_selector_info
2278 ret
= get_afsi_of_path(source_path
, &cad
.source_afsi
);
2281 ret
= for_each_matching_row(&pmd
);
2284 if (pmd
.num_matches
> 0) {
2285 if (cad
.flags
& CPSI_FLAG_VERBOSE
)
2286 para_printf(&aca
->pbout
, "updated afsi of %u file(s)\n",
2294 int com_cpsi(struct command_context
*cc
)
2298 struct osl_object options
= {.data
= &flags
, .size
= sizeof(flags
)};
2300 for (i
= 1; i
< cc
->argc
; i
++) {
2301 const char *arg
= cc
->argv
[i
];
2304 if (!strcmp(arg
, "--")) {
2308 if (!strcmp(arg
, "-y")) {
2309 flags
|= CPSI_FLAG_COPY_LYRICS_ID
;
2312 if (!strcmp(arg
, "-i")) {
2313 flags
|= CPSI_FLAG_COPY_IMAGE_ID
;
2316 if (!strcmp(arg
, "-l")) {
2317 flags
|= CPSI_FLAG_COPY_LASTPLAYED
;
2320 if (!strcmp(arg
, "-n")) {
2321 flags
|= CPSI_FLAG_COPY_NUMPLAYED
;
2324 if (!strcmp(arg
, "-a")) {
2325 flags
|= CPSI_FLAG_COPY_ATTRIBUTES
;
2328 if (!strcmp(arg
, "-v")) {
2329 flags
|= CPSI_FLAG_VERBOSE
;
2334 if (i
+ 1 >= cc
->argc
) /* need at least source file and pattern */
2335 return -E_AFT_SYNTAX
;
2336 if (!(flags
& ~CPSI_FLAG_VERBOSE
)) /* no copy flags given */
2337 flags
= ~(unsigned)CPSI_FLAG_VERBOSE
| flags
;
2338 return send_option_arg_callback_request(&options
, cc
->argc
- i
,
2339 cc
->argv
+ i
, com_cpsi_callback
, afs_cb_result_handler
, cc
);
2342 struct change_atts_data
{
2343 uint64_t add_mask
, del_mask
;
2344 struct afs_callback_arg
*aca
;
2347 static int change_atts(__a_unused
struct osl_table
*table
,
2348 struct osl_row
*row
, __a_unused
const char *name
, void *data
)
2351 struct osl_object obj
;
2352 struct afs_info old_afsi
, new_afsi
;
2353 struct afsi_change_event_data aced
= {
2355 .old_afsi
= &old_afsi
2357 struct change_atts_data
*cad
= data
;
2359 ret
= get_afsi_object_of_row(row
, &obj
);
2362 ret
= load_afsi(&old_afsi
, &obj
);
2365 new_afsi
= old_afsi
;
2366 new_afsi
.attributes
|= cad
->add_mask
;
2367 new_afsi
.attributes
&= ~cad
->del_mask
;
2368 save_afsi(&new_afsi
, &obj
); /* in-place update */
2369 return afs_event(AFSI_CHANGE
, &cad
->aca
->pbout
, &aced
);
2372 static int com_setatt_callback(struct afs_callback_arg
*aca
)
2377 struct change_atts_data cad
= {.aca
= aca
};
2378 struct pattern_match_data pmd
= {
2379 .table
= audio_file_table
,
2380 .loop_col_num
= AFTCOL_HASH
,
2381 .match_col_num
= AFTCOL_PATH
,
2382 .pm_flags
= PM_SKIP_EMPTY_NAME
,
2384 .action
= change_atts
2388 p
= aca
->query
.data
;
2389 p
< (char *)aca
->query
.data
+ aca
->query
.size
;
2393 unsigned char bitnum
;
2396 ret
= -E_ATTR_SYNTAX
;
2400 if (c
!= '+' && c
!= '-')
2403 ret
= get_attribute_bitnum_by_name(p
, &bitnum
);
2405 para_printf(&aca
->pbout
, "attribute not found: %s\n", p
);
2409 cad
.add_mask
|= (1UL << bitnum
);
2411 cad
.del_mask
|= (1UL << bitnum
);
2413 ret
= -E_ATTR_SYNTAX
;
2414 if (!cad
.add_mask
&& !cad
.del_mask
)
2416 pmd
.patterns
.data
= p
;
2417 assert(p
< (char *)aca
->query
.data
+ aca
->query
.size
);
2418 pmd
.patterns
.size
= (char *)aca
->query
.data
+ aca
->query
.size
- p
;
2419 ret
= for_each_matching_row(&pmd
);
2422 if (pmd
.num_matches
== 0)
2428 int com_setatt(struct command_context
*cc
)
2431 return -E_ATTR_SYNTAX
;
2432 return send_standard_callback_request(cc
->argc
- 1, cc
->argv
+ 1,
2433 com_setatt_callback
, afs_cb_result_handler
, cc
);
2436 static int afs_stat_callback(struct afs_callback_arg
*aca
)
2438 int *parser_friendly
= aca
->query
.data
;
2439 char *buf
= *parser_friendly
?
2440 parser_friendly_status_items
: status_items
;
2444 return pass_buffer_as_shm(aca
->fd
, SBD_OUTPUT
, buf
, strlen(buf
));
2448 * Get the current afs status items from the afs process and send it.
2450 * \param cc The command context, used e.g. for data encryption.
2451 * \param parser_friendly Whether parser-friendly output format should be used.
2453 * As the contents of the afs status items change in time and the command
2454 * handler only has a COW version created at fork time, it can not send
2455 * up-to-date afs status items directly. Therefore the usual callback mechanism
2456 * is used to pass the status items from the afs process to the command handler
2457 * via a shared memory area and a pipe.
2459 * \return The return value of the underlying call to \ref send_callback_request().
2461 int send_afs_status(struct command_context
*cc
, int parser_friendly
)
2463 struct osl_object query
= {.data
= &parser_friendly
,
2464 .size
= sizeof(parser_friendly
)};
2466 return send_callback_request(afs_stat_callback
, &query
,
2467 afs_cb_result_handler
, cc
);
2470 /* returns success on non-fatal errors to keep the loop going */
2471 static int check_audio_file(struct osl_row
*row
, void *data
)
2474 struct para_buffer
*pb
= data
;
2475 struct stat statbuf
;
2476 int ret
= get_audio_file_path_of_row(row
, &path
);
2477 struct afs_info afsi
;
2481 para_printf(pb
, "%s\n", para_strerror(-ret
));
2484 if (stat(path
, &statbuf
) < 0)
2485 para_printf(pb
, "%s: stat error (%s)\n", path
, strerror(errno
));
2486 else if (!S_ISREG(statbuf
.st_mode
))
2487 para_printf(pb
, "%s: not a regular file\n", path
);
2488 ret
= get_afsi_of_row(row
, &afsi
);
2490 para_printf(pb
, "%s: %s\n", path
, para_strerror(-ret
));
2493 ret
= lyr_get_name_by_id(afsi
.lyrics_id
, &blob_name
);
2495 para_printf(pb
, "%s lyrics id %u: %s\n", path
, afsi
.lyrics_id
,
2496 para_strerror(-ret
));
2497 ret
= img_get_name_by_id(afsi
.image_id
, &blob_name
);
2499 para_printf(pb
, "%s image id %u: %s\n", path
, afsi
.image_id
,
2500 para_strerror(-ret
));
2505 * Check the audio file table for inconsistencies.
2507 * \param aca Only ->pbout is used for diagnostics.
2509 * \return Standard. Inconsistencies are reported but not regarded as an error.
2513 int aft_check_callback(struct afs_callback_arg
*aca
)
2515 para_printf(&aca
->pbout
, "checking audio file table...\n");
2516 return audio_file_loop(&aca
->pbout
, check_audio_file
);
2519 struct aft_check_atts_data
{
2521 struct para_buffer
*pb
;
2524 static int check_atts_of_audio_file(struct osl_row
*row
, void *data
)
2526 struct aft_check_atts_data
*acad
= data
;
2528 struct afs_info afsi
;
2532 ret
= get_afsi_of_row(row
, &afsi
);
2534 para_printf(acad
->pb
, "cannot get afsi\n");
2537 bad_bits
= afsi
.attributes
& ~acad
->att_mask
;
2538 if (bad_bits
== 0) /* OK */
2540 ret
= get_audio_file_path_of_row(row
, &path
);
2542 para_printf(acad
->pb
, "cannot get path\n");
2545 para_printf(acad
->pb
, "invalid attribute bits (%" PRIu64
"): %s\n",
2547 /* return success to keep looping */
2552 * Iterate over all audio files and check the attribute bit mask.
2554 * \param att_mask The mask of all valid attributes.
2555 * \param pb Used for reporting inconsistencies.
2557 * This reads the attribute bit mask of each audio file from the afs info
2558 * structure stored in the audio file table and verifies that all set bits are
2559 * also turned on in \a att_mask, i.e., correspond to an attribute of the
2560 * attribute table. Audio files for which this is not the case are reported via
2563 * \return Standard. Inconsistencies are not regarded as errors.
2565 * \sa \ref attribute_check_callback().
2567 int aft_check_attributes(uint64_t att_mask
, struct para_buffer
*pb
)
2569 struct aft_check_atts_data acad
= {.att_mask
= att_mask
, .pb
= pb
};
2571 para_printf(pb
, "checking attributes, mask: %" PRIx64
"\n", att_mask
);
2572 return audio_file_loop(&acad
, check_atts_of_audio_file
);
2576 * Close the audio file table.
2578 * \param flags Usual flags that are passed to osl_close_table().
2580 * \sa osl_close_table().
2582 static void aft_close(void)
2584 osl_close_table(audio_file_table
, OSL_MARK_CLEAN
);
2585 audio_file_table
= NULL
;
2589 * Open the audio file table.
2591 * \param dir The database directory.
2595 * \sa osl_open_table().
2597 static int aft_open(const char *dir
)
2601 audio_file_table_desc
.dir
= dir
;
2602 ret
= osl(osl_open_table(&audio_file_table_desc
, &audio_file_table
));
2605 osl_get_num_rows(audio_file_table
, &num
);
2606 PARA_INFO_LOG("audio file table contains %d files\n", num
);
2609 PARA_NOTICE_LOG("failed to open audio file table\n");
2610 audio_file_table
= NULL
;
2611 if (ret
== -OSL_ERRNO_TO_PARA_ERROR(E_OSL_NOENT
))
2616 static int aft_create(const char *dir
)
2618 audio_file_table_desc
.dir
= dir
;
2619 return osl(osl_create_table(&audio_file_table_desc
));
2622 static int clear_attribute(struct osl_row
*row
, void *data
)
2624 struct rmatt_event_data
*red
= data
;
2625 struct afs_info afsi
;
2626 struct osl_object obj
;
2627 int ret
= get_afsi_object_of_row(row
, &obj
);
2628 uint64_t mask
= ~(1ULL << red
->bitnum
);
2632 ret
= load_afsi(&afsi
, &obj
);
2635 afsi
.attributes
&= mask
;
2636 save_afsi(&afsi
, &obj
);
2640 static int aft_event_handler(enum afs_events event
, struct para_buffer
*pb
,
2646 case ATTRIBUTE_REMOVE
: {
2647 const struct rmatt_event_data
*red
= data
;
2648 para_printf(pb
, "clearing attribute %s (bit %u) from all "
2649 "entries in the audio file table\n", red
->name
,
2651 return audio_file_loop(data
, clear_attribute
);
2652 } case AFSI_CHANGE
: {
2653 struct afsi_change_event_data
*aced
= data
;
2654 uint64_t old_last_played
= status_item_ls_data
.afsi
.last_played
;
2655 if (aced
->aft_row
!= current_aft_row
)
2657 ret
= get_afsi_of_row(aced
->aft_row
, &status_item_ls_data
.afsi
);
2660 status_item_ls_data
.afsi
.last_played
= old_last_played
;
2661 make_status_items();
2663 } case AFHI_CHANGE
: {
2664 if (data
!= current_aft_row
)
2666 ret
= get_afhi_of_row(data
, &status_item_ls_data
.afhi
);
2669 make_status_items();
2677 * Initialize the audio file table.
2679 * \param t Pointer to the structure to be initialized.
2681 void aft_init(struct afs_table
*t
)
2684 t
->close
= aft_close
;
2685 t
->create
= aft_create
;
2686 t
->event_handler
= aft_event_handler
;