2 * Copyright (C) 2007 Andre Noll <maan@tuebingen.mpg.de>
4 * Licensed under the GPL v2. For licencing details see COPYING.
7 /** \file aft.c Audio file table functions. */
23 #include "portable_io.h"
27 static struct osl_table
*audio_file_table
;
28 static char *status_items
;
29 static char *parser_friendly_status_items
;
31 /** The different sorting methods of the ls command. */
32 enum ls_sorting_method
{
38 LS_SORT_BY_LAST_PLAYED
,
40 LS_SORT_BY_NUM_PLAYED
,
54 LS_SORT_BY_AUDIO_FORMAT
,
59 /** The different listing modes of the ls command. */
60 enum ls_listing_mode
{
61 /** Default listing mode. */
75 /* Data about one audio file. Needed for ls and stat output. */
77 /* Usual audio format handler information. */
79 /* Audio file selector information. */
81 /* The full path of the audio file. */
83 /* The score value (if -a was given). */
85 /* The hash value of the audio file data. */
89 /** The flags accepted by the ls command. */
92 LS_FLAG_FULL_PATH
= 1,
94 LS_FLAG_ADMISSIBLE_ONLY
= 2,
102 * The size of the individual output fields of the ls command.
104 * These depend on the content being listed. For example, if each listed file
105 * is shorter than an hour, the duration format is set to mm:ss. Otherwise it
106 * is set to hh:mm:ss.
109 /** size of the score field. */
110 unsigned short score_width
;
111 /** size of the image id field. */
112 unsigned short image_id_width
;
113 /** size of the lyrics id field. */
114 unsigned short lyrics_id_width
;
115 /** size of the bitrate field. */
116 unsigned short bitrate_width
;
117 /** size of the frequency field. */
118 unsigned short frequency_width
;
119 /** size of the duration field. */
120 unsigned short duration_width
;
121 /** size of the num played field. */
122 unsigned short num_played_width
;
123 /** size of the amp field. */
124 unsigned short amp_width
;
125 /** size of the audio format field. */
126 unsigned short audio_format_width
;
129 /** Data passed from the ls command handler to its callback function. */
131 /** The given command line flags. */
133 /** The sorting method given at the command line. */
134 enum ls_sorting_method sorting
;
135 /** The given listing mode (short, long, verbose, mbox). */
136 enum ls_listing_mode mode
;
137 /** The arguments passed to the ls command. */
139 /** Number of non-option arguments. */
141 /** Used for long listing mode to align the output fields. */
142 struct ls_widths widths
;
143 /** Size of the \a data array. */
145 /** Number of used entries in the data array. */
146 uint32_t num_matching_paths
;
147 /** Array of matching entries. */
148 struct ls_data
*data
;
149 /** Used to sort the array. */
150 struct ls_data
**data_ptr
;
154 * Describes the layout of the mmapped-afs info struct.
156 * \sa struct afs_info.
159 /** Where .last_played is stored. */
160 AFSI_LAST_PLAYED_OFFSET
= 0,
161 /** Storage position of the attributes bitmap. */
162 AFSI_ATTRIBUTES_OFFSET
= 8,
163 /** Storage position of the .num_played field. */
164 AFSI_NUM_PLAYED_OFFSET
= 16,
165 /** Storage position of the .image_id field. */
166 AFSI_IMAGE_ID_OFFSET
= 20,
167 /** Storage position of the .lyrics_id field. */
168 AFSI_LYRICS_ID_OFFSET
= 24,
169 /** Storage position of the .audio_format_id field. */
170 AFSI_AUDIO_FORMAT_ID_OFFSET
= 28,
171 /** Storage position of the amplification field. */
172 AFSI_AMP_OFFSET
= 29,
173 /** 2 bytes reserved space for future usage. */
174 AFSI_AUDIO_FORMAT_UNUSED_OFFSET
= 30,
175 /** On-disk storage space needed. */
180 * Convert a struct afs_info to an osl object.
182 * \param afsi Pointer to the audio file info to be converted.
183 * \param obj Result pointer.
187 static void save_afsi(struct afs_info
*afsi
, struct osl_object
*obj
)
189 char *buf
= obj
->data
;
191 write_u64(buf
+ AFSI_LAST_PLAYED_OFFSET
, afsi
->last_played
);
192 write_u64(buf
+ AFSI_ATTRIBUTES_OFFSET
, afsi
->attributes
);
193 write_u32(buf
+ AFSI_NUM_PLAYED_OFFSET
, afsi
->num_played
);
194 write_u32(buf
+ AFSI_IMAGE_ID_OFFSET
, afsi
->image_id
);
195 write_u32(buf
+ AFSI_LYRICS_ID_OFFSET
, afsi
->lyrics_id
);
196 write_u8(buf
+ AFSI_AUDIO_FORMAT_ID_OFFSET
,
197 afsi
->audio_format_id
);
198 write_u8(buf
+ AFSI_AMP_OFFSET
, afsi
->amp
);
199 memset(buf
+ AFSI_AUDIO_FORMAT_UNUSED_OFFSET
, 0, 2);
203 * Get the audio file selector info struct stored in an osl object.
205 * \param afsi Points to the audio_file info structure to be filled in.
206 * \param obj The osl object holding the data.
212 static int load_afsi(struct afs_info
*afsi
, struct osl_object
*obj
)
214 char *buf
= obj
->data
;
215 if (obj
->size
< AFSI_SIZE
)
217 afsi
->last_played
= read_u64(buf
+ AFSI_LAST_PLAYED_OFFSET
);
218 afsi
->attributes
= read_u64(buf
+ AFSI_ATTRIBUTES_OFFSET
);
219 afsi
->num_played
= read_u32(buf
+ AFSI_NUM_PLAYED_OFFSET
);
220 afsi
->image_id
= read_u32(buf
+ AFSI_IMAGE_ID_OFFSET
);
221 afsi
->lyrics_id
= read_u32(buf
+ AFSI_LYRICS_ID_OFFSET
);
222 afsi
->audio_format_id
= read_u8(buf
+
223 AFSI_AUDIO_FORMAT_ID_OFFSET
);
224 afsi
->amp
= read_u8(buf
+ AFSI_AMP_OFFSET
);
228 /** The columns of the audio file table. */
229 enum audio_file_table_columns
{
230 /** The hash on the content of the audio file. */
232 /** The full path in the filesystem. */
234 /** The audio file selector info. */
236 /** The audio format handler info. */
238 /** The chunk table info and the chunk table of the audio file. */
240 /** The number of columns of this table. */
244 /* compare function for the hash column */
245 static int aft_hash_compare(const struct osl_object
*obj1
,
246 const struct osl_object
*obj2
)
248 return hash_compare((unsigned char *)obj1
->data
,
249 (unsigned char *)obj2
->data
);
252 static struct osl_column_description aft_cols
[] = {
254 .storage_type
= OSL_MAPPED_STORAGE
,
255 .storage_flags
= OSL_RBTREE
| OSL_FIXED_SIZE
| OSL_UNIQUE
,
257 .compare_function
= aft_hash_compare
,
258 .data_size
= HASH_SIZE
261 .storage_type
= OSL_MAPPED_STORAGE
,
262 .storage_flags
= OSL_RBTREE
| OSL_UNIQUE
,
264 .compare_function
= string_compare
,
267 .storage_type
= OSL_MAPPED_STORAGE
,
268 .storage_flags
= OSL_FIXED_SIZE
,
270 .data_size
= AFSI_SIZE
273 .storage_type
= OSL_MAPPED_STORAGE
,
277 .storage_type
= OSL_DISK_STORAGE
,
282 static struct osl_table_description audio_file_table_desc
= {
283 .name
= "audio_files",
284 .num_columns
= NUM_AFT_COLUMNS
,
285 .flags
= OSL_LARGE_TABLE
,
286 .column_descriptions
= aft_cols
290 * Produce a canonicalized absolute pathname.
292 * Returns one if the resolved path a directory, zero if it is a regular file,
293 * negative on errors.
295 static int verify_path(const char *orig_path
, char **resolved_path
)
301 if (*orig_path
!= '/') /* we only accept absolute paths */
303 path
= realpath(orig_path
, NULL
);
306 if (stat(path
, &statbuf
) < 0)
308 if (S_ISREG(statbuf
.st_mode
))
310 else if (S_ISDIR(statbuf
.st_mode
))
314 *resolved_path
= path
;
317 *resolved_path
= NULL
;
322 /** The on-disk layout of a afhi struct. */
324 /** Where the number of seconds is stored. */
325 AFHI_SECONDS_TOTAL_OFFSET
= 0,
326 /** Position of the bitrate. */
327 AFHI_BITRATE_OFFSET
= 4,
328 /** Position of the frequency. */
329 AFHI_FREQUENCY_OFFSET
= 8,
330 /** Was: Location of the audio file header. */
331 AFHI_UNUSED1_OFFSET
= 12,
332 /* Length of the audio file header. Zero means: No header. */
333 AFHI_HEADER_LEN_OFFSET
= 16,
334 /** The total number of chunks (4 bytes). */
335 CHUNKS_TOTAL_OFFSET
= 20,
336 /** The length of the audio file header (4 bytes). */
337 HEADER_LEN_OFFSET
= 24,
338 /** Was: The start of the audio file header (4 bytes). */
339 AFHI_UNUSED2_OFFSET
= 28,
340 /** The seconds part of the chunk time (4 bytes). */
341 CHUNK_TV_TV_SEC_OFFSET
= 32,
342 /** The microseconds part of the chunk time (4 bytes). */
343 CHUNK_TV_TV_USEC_OFFSET
= 36,
344 /** Number of channels is stored here. (1 byte) */
345 AFHI_CHANNELS_OFFSET
= 40,
346 /** The tag info position. */
347 AFHI_INFO_STRING_OFFSET
= 41,
348 /** Minimal on-disk size of a valid afhi struct. */
349 MIN_AFHI_SIZE
= 47, /* at least 6 null bytes for techinfo/tags */
352 static unsigned sizeof_afhi_buf(const struct afh_info
*afhi
)
357 + strlen(afhi
->techinfo
)
358 + strlen(afhi
->tags
.artist
)
359 + strlen(afhi
->tags
.title
)
360 + strlen(afhi
->tags
.year
)
361 + strlen(afhi
->tags
.album
)
362 + strlen(afhi
->tags
.comment
);
365 static void save_afhi(struct afh_info
*afhi
, char *buf
)
371 write_u32(buf
+ AFHI_SECONDS_TOTAL_OFFSET
, afhi
->seconds_total
);
372 write_u32(buf
+ AFHI_BITRATE_OFFSET
, afhi
->bitrate
);
373 write_u32(buf
+ AFHI_FREQUENCY_OFFSET
, afhi
->frequency
);
374 write_u32(buf
+ AFHI_UNUSED1_OFFSET
, 0);
375 write_u32(buf
+ AFHI_HEADER_LEN_OFFSET
, afhi
->header_len
);
376 write_u8(buf
+ AFHI_CHANNELS_OFFSET
, afhi
->channels
);
377 write_u32(buf
+ CHUNKS_TOTAL_OFFSET
, afhi
->chunks_total
);
378 write_u32(buf
+ HEADER_LEN_OFFSET
, afhi
->header_len
);
379 write_u32(buf
+ AFHI_UNUSED2_OFFSET
, 0);
380 write_u32(buf
+ CHUNK_TV_TV_SEC_OFFSET
, afhi
->chunk_tv
.tv_sec
);
381 write_u32(buf
+ CHUNK_TV_TV_USEC_OFFSET
, afhi
->chunk_tv
.tv_usec
);
382 p
= buf
+ AFHI_INFO_STRING_OFFSET
;
383 /* The sprintf's below are OK as our caller made sure that buf is large enough */
384 p
+= sprintf(p
, "%s", afhi
->techinfo
) + 1;
385 p
+= sprintf(p
, "%s", afhi
->tags
.artist
) + 1;
386 p
+= sprintf(p
, "%s", afhi
->tags
.title
) + 1;
387 p
+= sprintf(p
, "%s", afhi
->tags
.year
) + 1;
388 p
+= sprintf(p
, "%s", afhi
->tags
.album
) + 1;
389 sprintf(p
, "%s", afhi
->tags
.comment
);
392 static void load_afhi(const char *buf
, struct afh_info
*afhi
)
394 afhi
->seconds_total
= read_u32(buf
+ AFHI_SECONDS_TOTAL_OFFSET
);
395 afhi
->bitrate
= read_u32(buf
+ AFHI_BITRATE_OFFSET
);
396 afhi
->frequency
= read_u32(buf
+ AFHI_FREQUENCY_OFFSET
);
397 afhi
->header_len
= read_u32(buf
+ AFHI_HEADER_LEN_OFFSET
);
398 afhi
->channels
= read_u8(buf
+ AFHI_CHANNELS_OFFSET
);
399 afhi
->chunks_total
= read_u32(buf
+ CHUNKS_TOTAL_OFFSET
);
400 afhi
->header_len
= read_u32(buf
+ HEADER_LEN_OFFSET
);
401 afhi
->chunk_tv
.tv_sec
= read_u32(buf
+ CHUNK_TV_TV_SEC_OFFSET
);
402 afhi
->chunk_tv
.tv_usec
= read_u32(buf
+ CHUNK_TV_TV_USEC_OFFSET
);
403 afhi
->techinfo
= (char *)buf
+ AFHI_INFO_STRING_OFFSET
;
404 afhi
->tags
.artist
= afhi
->techinfo
+ strlen(afhi
->techinfo
) + 1;
405 afhi
->tags
.title
= afhi
->tags
.artist
+ strlen(afhi
->tags
.artist
) + 1;
406 afhi
->tags
.year
= afhi
->tags
.title
+ strlen(afhi
->tags
.title
) + 1;
407 afhi
->tags
.album
= afhi
->tags
.year
+ strlen(afhi
->tags
.year
) + 1;
408 afhi
->tags
.comment
= afhi
->tags
.album
+ strlen(afhi
->tags
.album
) + 1;
411 static unsigned sizeof_chunk_table(struct afh_info
*afhi
)
415 return 4 * (afhi
->chunks_total
+ 1);
418 static uint32_t save_chunk_table(struct afh_info
*afhi
, char *buf
)
421 uint32_t max
= 0, old
= 0;
423 for (i
= 0; i
<= afhi
->chunks_total
; i
++) {
424 uint32_t val
= afhi
->chunk_table
[i
];
425 write_u32(buf
+ 4 * i
, val
);
427 * If the first chunk is the header, do not consider it for the
428 * calculation of the largest chunk size.
430 if (i
== 0 || (i
== 1 && afhi
->header_len
> 0)) {
434 max
= PARA_MAX(max
, val
- old
);
440 static void load_chunk_table(struct afh_info
*afhi
, char *buf
)
444 afhi
->chunk_table
= para_malloc(sizeof_chunk_table(afhi
));
445 for (i
= 0; i
<= afhi
->chunks_total
; i
++)
446 afhi
->chunk_table
[i
] = read_u32(buf
+ 4 * i
);
450 * Get the row of the audio file table corresponding to the given path.
452 * \param path The full path of the audio file.
453 * \param row Result pointer.
457 int aft_get_row_of_path(const char *path
, struct osl_row
**row
)
459 struct osl_object obj
= {.data
= (char *)path
, .size
= strlen(path
) + 1};
461 return osl(osl_get_row(audio_file_table
, AFTCOL_PATH
, &obj
, row
));
465 * Get the row of the audio file table corresponding to the given hash value.
467 * \param hash The hash value of the desired audio file.
468 * \param row Result pointer.
472 static int aft_get_row_of_hash(unsigned char *hash
, struct osl_row
**row
)
474 const struct osl_object obj
= {.data
= hash
, .size
= HASH_SIZE
};
475 return osl(osl_get_row(audio_file_table
, AFTCOL_HASH
, &obj
, row
));
479 * Get the audio file selector info object of a row.
481 * \param row Pointer to a row in the audio file table.
482 * \param obj Result pointer.
486 static int get_afsi_object_of_row(const struct osl_row
*row
,
487 struct osl_object
*obj
)
489 return osl(osl_get_object(audio_file_table
, row
, AFTCOL_AFSI
, obj
));
493 * Get the osl object holding the audio file selector info, given a path.
496 * \param path The full path of the audio file.
497 * \param obj Result pointer.
499 * \return Positive on success, negative on errors.
501 static int get_afsi_object_of_path(const char *path
, struct osl_object
*obj
)
504 int ret
= aft_get_row_of_path(path
, &row
);
507 return get_afsi_object_of_row(row
, obj
);
511 * Get the audio file selector info, given a row of the audio file table.
513 * \param row Pointer to a row in the audio file table.
514 * \param afsi Result pointer.
516 * \return Positive on success, negative on errors.
518 int get_afsi_of_row(const struct osl_row
*row
, struct afs_info
*afsi
)
520 struct osl_object obj
;
521 int ret
= get_afsi_object_of_row(row
, &obj
);
524 return load_afsi(afsi
, &obj
);
528 * Get the audio file selector info, given the path of an audio table.
530 * \param path The full path of the audio file.
531 * \param afsi Result pointer.
535 static int get_afsi_of_path(const char *path
, struct afs_info
*afsi
)
537 struct osl_object obj
;
538 int ret
= get_afsi_object_of_path(path
, &obj
);
541 return load_afsi(afsi
, &obj
);
545 * Get the path of an audio file, given a row of the audio file table.
547 * \param row Pointer to a row in the audio file table.
548 * \param path Result pointer.
550 * The result is a pointer to mmapped data. The caller must not attempt
555 int get_audio_file_path_of_row(const struct osl_row
*row
, char **path
)
557 struct osl_object path_obj
;
558 int ret
= osl(osl_get_object(audio_file_table
, row
, AFTCOL_PATH
,
562 *path
= path_obj
.data
;
567 * Get the object containing the hash value of an audio file, given a row.
569 * \param row Pointer to a row of the audio file table.
570 * \param obj Result pointer.
572 * \return The return value of the underlying call to osl_get_object().
574 * \sa get_hash_of_row().
576 static int get_hash_object_of_aft_row(const struct osl_row
*row
,
577 struct osl_object
*obj
)
579 return osl(osl_get_object(audio_file_table
, row
, AFTCOL_HASH
, obj
));
583 * Get the hash value of an audio file, given a row of the audio file table.
585 * \param row Pointer to a row of the audio file table.
586 * \param hash Result pointer.
588 * \a hash points to mapped data and must not be freed by the caller.
590 * \return The return value of the underlying call to
591 * get_hash_object_of_aft_row().
593 static int get_hash_of_row(const struct osl_row
*row
, unsigned char **hash
)
595 struct osl_object obj
;
596 int ret
= get_hash_object_of_aft_row(row
, &obj
);
605 * Get the audio format handler info, given a row of the audio file table.
607 * \param row Pointer to a row of the audio file table.
608 * \param afhi Result pointer.
610 * \return The return value of the underlying call to osl_get_object().
612 * \sa get_chunk_table_of_row().
614 int get_afhi_of_row(const struct osl_row
*row
, struct afh_info
*afhi
)
616 struct osl_object obj
;
617 int ret
= osl(osl_get_object(audio_file_table
, row
, AFTCOL_AFHI
,
621 load_afhi(obj
.data
, afhi
);
625 /* returns shmid on success */
626 static int save_afd(struct audio_file_data
*afd
)
628 size_t size
= sizeof(*afd
) + sizeof_chunk_table(&afd
->afhi
);
629 int shmid
, ret
= shm_new(size
);
636 ret
= shm_attach(shmid
, ATTACH_RW
, &shm_afd
);
641 afd
->max_chunk_size
= save_chunk_table(&afd
->afhi
, buf
);
642 *(struct audio_file_data
*)shm_afd
= *afd
;
651 * Extract a afd stored in a shared memory area.
653 * Attach the shared memory area given by \a shmid, load the audio file data
654 * stored therein and detach the area afterwards. Called by vss, after
655 * receiving a positive response to the request for the next audio file.
657 * \param shmid The identifier of the shared memory area containing the afd.
658 * \param afd Result pointer.
662 int load_afd(int shmid
, struct audio_file_data
*afd
)
667 ret
= shm_attach(shmid
, ATTACH_RO
, &shm_afd
);
670 *afd
= *(struct audio_file_data
*)shm_afd
;
671 load_chunk_table(&afd
->afhi
, shm_afd
+ sizeof(*afd
));
676 static int get_local_time(uint64_t *seconds
, char *buf
, size_t size
,
677 time_t current_time
, enum ls_listing_mode lm
)
681 if (!localtime_r((time_t *)seconds
, &t
))
683 if (lm
== LS_MODE_MBOX
) {
684 if (!strftime(buf
, size
, "%c", &t
))
688 if (*seconds
+ 6 * 30 * 24 * 3600 > current_time
) {
689 if (!strftime(buf
, size
, "%b %e %k:%M", &t
))
693 if (!strftime(buf
, size
, "%b %e %Y", &t
))
698 /** Compute the number of (decimal) digits of a number. */
699 #define GET_NUM_DIGITS(x, num) { \
700 typeof((x)) _tmp = PARA_ABS(x); \
703 while ((_tmp) > 9) { \
709 __a_const
static short unsigned get_duration_width(int seconds
)
711 short unsigned width
;
712 unsigned hours
= seconds
/ 3600, mins
= (seconds
% 3600) / 60;
714 if (!hours
) /* less than one hour => m:ss or mm:ss => 4 or 5 digits */
715 return 4 + (mins
> 9);
716 /* more than one hour => h:mm:ss, hh:mm:ss, hhh:mm:ss, ... */
717 GET_NUM_DIGITS(hours
, &width
);
721 static void get_duration_buf(int seconds
, char *buf
, struct ls_options
*opts
)
723 unsigned hours
= seconds
/ 3600, mins
= (seconds
% 3600) / 60;
724 short unsigned max_width
;
726 if (!hours
) { /* m:ss or mm:ss */
727 max_width
= opts
->mode
== LS_MODE_LONG
?
728 opts
->widths
.duration_width
: 4;
729 sprintf(buf
, "%*u:%02u", max_width
- 3, mins
, seconds
% 60);
730 } else { /* more than one hour => h:mm:ss, hh:mm:ss, hhh:mm:ss, ... */
731 max_width
= opts
->mode
== LS_MODE_LONG
?
732 opts
->widths
.duration_width
: 7;
733 sprintf(buf
, "%*u:%02u:%02u", max_width
- 6, hours
, mins
,
738 static int write_attribute_items(struct para_buffer
*b
,
739 const char *att_bitmap
, struct afs_info
*afsi
)
744 WRITE_STATUS_ITEM(b
, SI_ATTRIBUTES_BITMAP
, "%s\n", att_bitmap
);
745 ret
= get_attribute_text(&afsi
->attributes
, " ", &att_text
);
748 WRITE_STATUS_ITEM(b
, SI_ATTRIBUTES_TXT
, "%s\n", att_text
);
753 static void write_lyrics_items(struct para_buffer
*b
, struct afs_info
*afsi
)
757 WRITE_STATUS_ITEM(b
, SI_LYRICS_ID
, "%u\n", afsi
->lyrics_id
);
758 lyr_get_name_by_id(afsi
->lyrics_id
, &lyrics_name
);
759 WRITE_STATUS_ITEM(b
, SI_LYRICS_NAME
, "%s\n", lyrics_name
?
760 lyrics_name
: "(none)");
763 static void write_image_items(struct para_buffer
*b
, struct afs_info
*afsi
)
767 WRITE_STATUS_ITEM(b
, SI_IMAGE_ID
, "%u\n", afsi
->image_id
);
768 img_get_name_by_id(afsi
->image_id
, &image_name
);
769 WRITE_STATUS_ITEM(b
, SI_IMAGE_NAME
, "%s\n", image_name
?
770 image_name
: "(none)");
773 static void write_filename_items(struct para_buffer
*b
, const char *path
,
778 if (!(flags
& LS_FLAG_FULL_PATH
)) {
779 WRITE_STATUS_ITEM(b
, SI_BASENAME
, "%s\n", path
);
782 WRITE_STATUS_ITEM(b
, SI_PATH
, "%s\n", path
);
783 val
= para_basename(path
);
784 WRITE_STATUS_ITEM(b
, SI_BASENAME
, "%s\n", val
? val
: "");
785 val
= para_dirname(path
);
786 WRITE_STATUS_ITEM(b
, SI_DIRECTORY
, "%s\n", val
? val
: "");
790 static int print_chunk_table(struct ls_data
*d
, struct para_buffer
*b
)
792 struct osl_object chunk_table_obj
;
793 struct osl_row
*aft_row
;
797 ret
= aft_get_row_of_hash(d
->hash
, &aft_row
);
800 ret
= osl(osl_open_disk_object(audio_file_table
, aft_row
,
801 AFTCOL_CHUNKS
, &chunk_table_obj
));
804 para_printf(b
, "%s\n"
805 "chunk_time: %lu:%lu\nchunk_offsets: ",
807 (long unsigned) d
->afhi
.chunk_tv
.tv_sec
,
808 (long unsigned) d
->afhi
.chunk_tv
.tv_usec
810 buf
= chunk_table_obj
.data
;
811 for (i
= 0; i
<= d
->afhi
.chunks_total
; i
++)
812 para_printf(b
, "%u ", (unsigned) read_u32(buf
+ 4 * i
));
813 para_printf(b
, "\n");
815 osl_close_disk_object(&chunk_table_obj
);
819 static void write_score(struct para_buffer
*b
, struct ls_data
*d
,
820 struct ls_options
*opts
)
822 if (!(opts
->flags
& LS_FLAG_ADMISSIBLE_ONLY
)) /* no score*/
824 WRITE_STATUS_ITEM(b
, SI_SCORE
, "%li\n", d
->score
);
827 static int print_list_item(struct ls_data
*d
, struct ls_options
*opts
,
828 struct para_buffer
*b
, time_t current_time
)
832 char last_played_time
[30];
833 char duration_buf
[30]; /* nobody has an audio file long enough to overflow this */
834 struct afs_info
*afsi
= &d
->afsi
;
835 struct afh_info
*afhi
= &d
->afhi
;
836 char asc_hash
[2 * HASH_SIZE
+ 1];
838 if (opts
->mode
== LS_MODE_SHORT
) {
839 para_printf(b
, "%s\n", d
->path
);
843 if (opts
->mode
== LS_MODE_CHUNKS
) {
844 ret
= print_chunk_table(d
, b
);
847 get_attribute_bitmap(&afsi
->attributes
, att_buf
);
848 if (opts
->flags
& LS_FLAG_UNIXDATE
)
849 sprintf(last_played_time
, "%llu",
850 (long long unsigned)afsi
->last_played
);
852 ret
= get_local_time(&afsi
->last_played
, last_played_time
,
853 sizeof(last_played_time
), current_time
, opts
->mode
);
857 get_duration_buf(afhi
->seconds_total
, duration_buf
, opts
);
858 if (opts
->mode
== LS_MODE_LONG
) {
859 struct ls_widths
*w
= &opts
->widths
;
860 if (opts
->flags
& LS_FLAG_ADMISSIBLE_ONLY
) {
861 para_printf(b
, "%*li ", opts
->widths
.score_width
,
865 "%s " /* attributes */
867 "%*d " /* image_id */
868 "%*d " /* lyrics_id */
870 "%*s " /* audio format */
871 "%*d " /* frequency */
874 "%*d " /* num_played */
875 "%s " /* last_played */
878 w
->amp_width
, afsi
->amp
,
879 w
->image_id_width
, afsi
->image_id
,
880 w
->lyrics_id_width
, afsi
->lyrics_id
,
881 w
->bitrate_width
, afhi
->bitrate
,
882 w
->audio_format_width
,
883 audio_format_name(afsi
->audio_format_id
),
884 w
->frequency_width
, afhi
->frequency
,
887 w
->num_played_width
, afsi
->num_played
,
894 if (opts
->mode
== LS_MODE_MBOX
) {
895 const char *bn
= para_basename(d
->path
);
897 "From foo@localhost %s\n"
898 "Received: from\nTo: bar\nFrom: a\n"
903 write_filename_items(b
, d
->path
, opts
->flags
);
904 write_score(b
, d
, opts
);
905 ret
= write_attribute_items(b
, att_buf
, afsi
);
908 write_image_items(b
, afsi
);
909 write_lyrics_items(b
, afsi
);
910 hash_to_asc(d
->hash
, asc_hash
);
911 WRITE_STATUS_ITEM(b
, SI_HASH
, "%s\n", asc_hash
);
912 WRITE_STATUS_ITEM(b
, SI_BITRATE
, "%dkbit/s\n", afhi
->bitrate
);
913 WRITE_STATUS_ITEM(b
, SI_FORMAT
, "%s\n",
914 audio_format_name(afsi
->audio_format_id
));
915 WRITE_STATUS_ITEM(b
, SI_FREQUENCY
, "%dHz\n", afhi
->frequency
);
916 WRITE_STATUS_ITEM(b
, SI_CHANNELS
, "%d\n", afhi
->channels
);
917 WRITE_STATUS_ITEM(b
, SI_DURATION
, "%s\n", duration_buf
);
918 WRITE_STATUS_ITEM(b
, SI_SECONDS_TOTAL
, "%lu\n", afhi
->seconds_total
);
919 WRITE_STATUS_ITEM(b
, SI_LAST_PLAYED
, "%s\n", last_played_time
);
920 WRITE_STATUS_ITEM(b
, SI_NUM_PLAYED
, "%d\n", afsi
->num_played
);
921 WRITE_STATUS_ITEM(b
, SI_AMPLIFICATION
, "%u\n", afsi
->amp
);
922 WRITE_STATUS_ITEM(b
, SI_CHUNK_TIME
, "%lu\n", tv2ms(&afhi
->chunk_tv
));
923 WRITE_STATUS_ITEM(b
, SI_NUM_CHUNKS
, "%lu\n", afhi
->chunks_total
);
924 WRITE_STATUS_ITEM(b
, SI_TECHINFO
, "%s\n", afhi
->techinfo
);
925 WRITE_STATUS_ITEM(b
, SI_ARTIST
, "%s\n", afhi
->tags
.artist
);
926 WRITE_STATUS_ITEM(b
, SI_TITLE
, "%s\n", afhi
->tags
.title
);
927 WRITE_STATUS_ITEM(b
, SI_YEAR
, "%s\n", afhi
->tags
.year
);
928 WRITE_STATUS_ITEM(b
, SI_ALBUM
, "%s\n", afhi
->tags
.album
);
929 WRITE_STATUS_ITEM(b
, SI_COMMENT
, "%s\n", afhi
->tags
.comment
);
930 if (opts
->mode
== LS_MODE_MBOX
) {
931 struct osl_object lyrics_def
;
932 lyr_get_def_by_id(afsi
->lyrics_id
, &lyrics_def
);
933 if (lyrics_def
.data
) {
934 para_printf(b
, "Lyrics:\n~~~~~~~\n%s",
935 (char *)lyrics_def
.data
);
936 osl_close_disk_object(&lyrics_def
);
943 static struct ls_data status_item_ls_data
;
944 static struct osl_row
*current_aft_row
;
946 static void make_inode_status_items(struct para_buffer
*pb
)
948 struct stat statbuf
= {.st_size
= 0};
949 char *path
, mtime_str
[30] = "\0";
953 ret
= get_audio_file_path_of_row(current_aft_row
, &path
);
956 ret
= stat(path
, &statbuf
);
959 localtime_r(&statbuf
.st_mtime
, &mtime_tm
);
960 ret
= strftime(mtime_str
, 29, "%b %d %Y", &mtime_tm
);
961 assert(ret
> 0); /* number of bytes placed in mtime_str */
963 WRITE_STATUS_ITEM(pb
, SI_MTIME
, "%s\n", mtime_str
);
964 WRITE_STATUS_ITEM(pb
, SI_FILE_SIZE
, "%ld\n", statbuf
.st_size
/ 1024);
967 static int make_status_items(void)
969 struct ls_options opts
= {
970 .flags
= LS_FLAG_FULL_PATH
| LS_FLAG_ADMISSIBLE_ONLY
,
971 .mode
= LS_MODE_VERBOSE
,
973 struct para_buffer pb
= {.max_size
= shm_get_shmmax() - 1};
978 ret
= print_list_item(&status_item_ls_data
, &opts
, &pb
, current_time
);
981 make_inode_status_items(&pb
);
983 status_items
= pb
.buf
;
984 memset(&pb
, 0, sizeof(pb
));
985 pb
.max_size
= shm_get_shmmax() - 1;
986 pb
.flags
= PBF_SIZE_PREFIX
;
987 ret
= print_list_item(&status_item_ls_data
, &opts
, &pb
, current_time
);
993 make_inode_status_items(&pb
);
994 free(parser_friendly_status_items
);
995 parser_friendly_status_items
= pb
.buf
;
1000 * Open the audio file with highest score and set up an afd structure.
1002 * \param afd Result pointer.
1004 * On success, the numplayed field of the audio file selector info is increased
1005 * and the lastplayed time is set to the current time. Finally, the score of
1006 * the audio file is updated.
1008 * \return Positive shmid on success, negative on errors.
1010 int open_and_update_audio_file(struct audio_file_data
*afd
)
1012 unsigned char file_hash
[HASH_SIZE
];
1013 struct osl_object afsi_obj
;
1014 struct afs_info new_afsi
;
1016 struct afsi_change_event_data aced
;
1017 struct osl_object map
, chunk_table_obj
;
1018 struct ls_data
*d
= &status_item_ls_data
;
1020 ret
= score_get_best(¤t_aft_row
, &d
->score
);
1023 ret
= get_hash_of_row(current_aft_row
, &d
->hash
);
1026 ret
= get_audio_file_path_of_row(current_aft_row
, &d
->path
);
1029 PARA_NOTICE_LOG("%s\n", d
->path
);
1030 ret
= get_afsi_object_of_row(current_aft_row
, &afsi_obj
);
1033 ret
= load_afsi(&d
->afsi
, &afsi_obj
);
1036 ret
= get_afhi_of_row(current_aft_row
, &afd
->afhi
);
1039 d
->afhi
= afd
->afhi
;
1040 d
->afhi
.chunk_table
= afd
->afhi
.chunk_table
= NULL
;
1041 ret
= osl(osl_open_disk_object(audio_file_table
, current_aft_row
,
1042 AFTCOL_CHUNKS
, &chunk_table_obj
));
1045 ret
= mmap_full_file(d
->path
, O_RDONLY
, &map
.data
, &map
.size
, &afd
->fd
);
1048 hash_function(map
.data
, map
.size
, file_hash
);
1049 ret
= hash_compare(file_hash
, d
->hash
);
1050 para_munmap(map
.data
, map
.size
);
1052 ret
= -E_HASH_MISMATCH
;
1056 new_afsi
.num_played
++;
1057 new_afsi
.last_played
= time(NULL
);
1058 save_afsi(&new_afsi
, &afsi_obj
); /* in-place update */
1060 afd
->audio_format_id
= d
->afsi
.audio_format_id
;
1061 load_chunk_table(&afd
->afhi
, chunk_table_obj
.data
);
1062 aced
.aft_row
= current_aft_row
;
1063 aced
.old_afsi
= &d
->afsi
;
1065 * No need to update the status items as the AFSI_CHANGE event will
1068 ret
= afs_event(AFSI_CHANGE
, NULL
, &aced
);
1071 ret
= save_afd(afd
);
1073 free(afd
->afhi
.chunk_table
);
1074 osl_close_disk_object(&chunk_table_obj
);
1076 PARA_ERROR_LOG("%s: %s\n", d
->path
, para_strerror(-ret
));
1077 ret
= score_delete(current_aft_row
);
1084 static int ls_audio_format_compare(const void *a
, const void *b
)
1086 struct ls_data
*d1
= *(struct ls_data
**)a
, *d2
= *(struct ls_data
**)b
;
1087 return NUM_COMPARE(d1
->afsi
.audio_format_id
, d2
->afsi
.audio_format_id
);
1090 static int ls_duration_compare(const void *a
, const void *b
)
1092 struct ls_data
*d1
= *(struct ls_data
**)a
, *d2
= *(struct ls_data
**)b
;
1093 return NUM_COMPARE(d1
->afhi
.seconds_total
, d2
->afhi
.seconds_total
);
1096 static int ls_bitrate_compare(const void *a
, const void *b
)
1098 struct ls_data
*d1
= *(struct ls_data
**)a
, *d2
= *(struct ls_data
**)b
;
1099 return NUM_COMPARE(d1
->afhi
.bitrate
, d2
->afhi
.bitrate
);
1102 static int ls_lyrics_id_compare(const void *a
, const void *b
)
1104 struct ls_data
*d1
= *(struct ls_data
**)a
, *d2
= *(struct ls_data
**)b
;
1105 return NUM_COMPARE(d1
->afsi
.lyrics_id
, d2
->afsi
.lyrics_id
);
1108 static int ls_image_id_compare(const void *a
, const void *b
)
1110 struct ls_data
*d1
= *(struct ls_data
**)a
, *d2
= *(struct ls_data
**)b
;
1111 return NUM_COMPARE(d1
->afsi
.image_id
, d2
->afsi
.image_id
);
1114 static int ls_channels_compare(const void *a
, const void *b
)
1116 struct ls_data
*d1
= *(struct ls_data
**)a
, *d2
= *(struct ls_data
**)b
;
1117 return NUM_COMPARE(d1
->afhi
.channels
, d2
->afhi
.channels
);
1120 static int ls_frequency_compare(const void *a
, const void *b
)
1122 struct ls_data
*d1
= *(struct ls_data
**)a
, *d2
= *(struct ls_data
**)b
;
1123 return NUM_COMPARE(d1
->afhi
.frequency
, d2
->afhi
.frequency
);
1126 static int ls_num_played_compare(const void *a
, const void *b
)
1128 struct ls_data
*d1
= *(struct ls_data
**)a
, *d2
= *(struct ls_data
**)b
;
1129 return NUM_COMPARE(d1
->afsi
.num_played
, d2
->afsi
.num_played
);
1132 static int ls_last_played_compare(const void *a
, const void *b
)
1134 struct ls_data
*d1
= *(struct ls_data
**)a
, *d2
= *(struct ls_data
**)b
;
1135 return NUM_COMPARE(d1
->afsi
.last_played
, d2
->afsi
.last_played
);
1138 static int ls_score_compare(const void *a
, const void *b
)
1140 struct ls_data
*d1
= *(struct ls_data
**)a
, *d2
= *(struct ls_data
**)b
;
1141 return NUM_COMPARE(d1
->score
, d2
->score
);
1144 static int ls_path_compare(const void *a
, const void *b
)
1146 struct ls_data
*d1
= *(struct ls_data
**)a
, *d2
= *(struct ls_data
**)b
;
1147 return strcmp(d1
->path
, d2
->path
);
1150 static int sort_matching_paths(struct ls_options
*options
)
1152 size_t nmemb
= options
->num_matching_paths
;
1153 size_t size
= sizeof(*options
->data_ptr
);
1154 int (*compar
)(const void *, const void *);
1157 options
->data_ptr
= para_malloc(nmemb
* sizeof(*options
->data_ptr
));
1158 for (i
= 0; i
< nmemb
; i
++)
1159 options
->data_ptr
[i
] = options
->data
+ i
;
1161 /* In these cases the array is already sorted */
1162 if (options
->sorting
== LS_SORT_BY_PATH
1163 && !(options
->flags
& LS_FLAG_ADMISSIBLE_ONLY
)
1164 && (options
->flags
& LS_FLAG_FULL_PATH
))
1166 if (options
->sorting
== LS_SORT_BY_SCORE
&&
1167 options
->flags
& LS_FLAG_ADMISSIBLE_ONLY
)
1170 switch (options
->sorting
) {
1171 case LS_SORT_BY_PATH
:
1172 compar
= ls_path_compare
; break;
1173 case LS_SORT_BY_SCORE
:
1174 compar
= ls_score_compare
; break;
1175 case LS_SORT_BY_LAST_PLAYED
:
1176 compar
= ls_last_played_compare
; break;
1177 case LS_SORT_BY_NUM_PLAYED
:
1178 compar
= ls_num_played_compare
; break;
1179 case LS_SORT_BY_FREQUENCY
:
1180 compar
= ls_frequency_compare
; break;
1181 case LS_SORT_BY_CHANNELS
:
1182 compar
= ls_channels_compare
; break;
1183 case LS_SORT_BY_IMAGE_ID
:
1184 compar
= ls_image_id_compare
; break;
1185 case LS_SORT_BY_LYRICS_ID
:
1186 compar
= ls_lyrics_id_compare
; break;
1187 case LS_SORT_BY_BITRATE
:
1188 compar
= ls_bitrate_compare
; break;
1189 case LS_SORT_BY_DURATION
:
1190 compar
= ls_duration_compare
; break;
1191 case LS_SORT_BY_AUDIO_FORMAT
:
1192 compar
= ls_audio_format_compare
; break;
1196 qsort(options
->data_ptr
, nmemb
, size
, compar
);
1200 /* row is either an aft_row or a row of the score table */
1201 /* TODO: Only compute widths if we need them */
1202 static int prepare_ls_row(struct osl_row
*row
, void *ls_opts
)
1205 struct ls_options
*options
= ls_opts
;
1207 struct ls_widths
*w
;
1208 unsigned short num_digits
;
1210 struct osl_row
*aft_row
;
1214 if (options
->flags
& LS_FLAG_ADMISSIBLE_ONLY
) {
1215 ret
= get_score_and_aft_row(row
, &score
, &aft_row
);
1222 ret
= get_audio_file_path_of_row(aft_row
, &path
);
1225 if (!(options
->flags
& LS_FLAG_FULL_PATH
)) {
1226 char *p
= strrchr(path
, '/');
1230 if (options
->num_patterns
) {
1231 for (i
= 0; i
< options
->num_patterns
; i
++) {
1232 ret
= fnmatch(options
->patterns
[i
], path
, 0);
1235 if (ret
== FNM_NOMATCH
)
1239 if (i
>= options
->num_patterns
) /* no match */
1242 tmp
= options
->num_matching_paths
++;
1243 if (options
->num_matching_paths
> options
->array_size
) {
1244 options
->array_size
++;
1245 options
->array_size
*= 2;
1246 options
->data
= para_realloc(options
->data
, options
->array_size
1247 * sizeof(*options
->data
));
1249 d
= options
->data
+ tmp
;
1250 ret
= get_afsi_of_row(aft_row
, &d
->afsi
);
1253 ret
= get_afhi_of_row(aft_row
, &d
->afhi
);
1257 ret
= get_hash_of_row(aft_row
, &d
->hash
);
1260 w
= &options
->widths
;
1261 GET_NUM_DIGITS(d
->afsi
.image_id
, &num_digits
);
1262 w
->image_id_width
= PARA_MAX(w
->image_id_width
, num_digits
);
1263 GET_NUM_DIGITS(d
->afsi
.lyrics_id
, &num_digits
);
1264 w
->lyrics_id_width
= PARA_MAX(w
->lyrics_id_width
, num_digits
);
1265 GET_NUM_DIGITS(d
->afhi
.bitrate
, &num_digits
);
1266 w
->bitrate_width
= PARA_MAX(w
->bitrate_width
, num_digits
);
1267 GET_NUM_DIGITS(d
->afhi
.frequency
, &num_digits
);
1268 w
->frequency_width
= PARA_MAX(w
->frequency_width
, num_digits
);
1269 GET_NUM_DIGITS(d
->afsi
.num_played
, &num_digits
);
1270 w
->num_played_width
= PARA_MAX(w
->num_played_width
, num_digits
);
1271 /* get the number of chars to print this amount of time */
1272 num_digits
= get_duration_width(d
->afhi
.seconds_total
);
1273 w
->duration_width
= PARA_MAX(w
->duration_width
, num_digits
);
1274 GET_NUM_DIGITS(d
->afsi
.amp
, &num_digits
);
1275 w
->amp_width
= PARA_MAX(w
->amp_width
, num_digits
);
1276 num_digits
= strlen(audio_format_name(d
->afsi
.audio_format_id
));
1277 w
->audio_format_width
= PARA_MAX(w
->audio_format_width
, num_digits
);
1278 if (options
->flags
& LS_FLAG_ADMISSIBLE_ONLY
) {
1279 GET_NUM_DIGITS(score
, &num_digits
);
1280 num_digits
++; /* add one for the sign (space or "-") */
1281 w
->score_width
= PARA_MAX(w
->score_width
, num_digits
);
1289 static int com_ls_callback(struct afs_callback_arg
*aca
)
1291 struct ls_options
*opts
= aca
->query
.data
;
1292 char *p
, *pattern_start
= (char *)aca
->query
.data
+ sizeof(*opts
);
1294 time_t current_time
;
1296 aca
->pbout
.flags
= (opts
->mode
== LS_MODE_PARSER
)? PBF_SIZE_PREFIX
: 0;
1297 if (opts
->num_patterns
) {
1298 opts
->patterns
= para_malloc(opts
->num_patterns
* sizeof(char *));
1299 for (i
= 0, p
= pattern_start
; i
< opts
->num_patterns
; i
++) {
1300 opts
->patterns
[i
] = p
;
1304 opts
->patterns
= NULL
;
1305 if (opts
->flags
& LS_FLAG_ADMISSIBLE_ONLY
)
1306 ret
= admissible_file_loop(opts
, prepare_ls_row
);
1308 ret
= osl(osl_rbtree_loop(audio_file_table
, AFTCOL_PATH
, opts
,
1312 if (opts
->num_matching_paths
== 0) {
1313 ret
= opts
->num_patterns
> 0? -E_NO_MATCH
: 0;
1316 ret
= sort_matching_paths(opts
);
1319 time(¤t_time
);
1320 if (opts
->flags
& LS_FLAG_REVERSE
)
1321 for (i
= opts
->num_matching_paths
- 1; i
>= 0; i
--) {
1322 ret
= print_list_item(opts
->data_ptr
[i
], opts
,
1323 &aca
->pbout
, current_time
);
1328 for (i
= 0; i
< opts
->num_matching_paths
; i
++) {
1329 ret
= print_list_item(opts
->data_ptr
[i
], opts
,
1330 &aca
->pbout
, current_time
);
1336 free(opts
->data_ptr
);
1337 free(opts
->patterns
);
1342 * TODO: flags -h (sort by hash)
1344 int com_ls(struct command_context
*cc
)
1348 enum ls_sorting_method sort
= LS_SORT_BY_PATH
;
1349 enum ls_listing_mode mode
= LS_MODE_SHORT
;
1350 struct ls_options opts
= {.patterns
= NULL
};
1351 struct osl_object query
= {.data
= &opts
, .size
= sizeof(opts
)};
1353 for (i
= 1; i
< cc
->argc
; i
++) {
1354 const char *arg
= cc
->argv
[i
];
1357 if (!strcmp(arg
, "--")) {
1362 * Compatibility: Prior to 0.5.5 it was necessary to specify
1363 * the listing mode without the '=' character as in -lv, for
1364 * example. Now the variant with '=' is preferred and
1365 * documented but we still accept the old way to specify the
1368 * Support for the legacy syntax can be dropped at 0.6.0
1371 if (!strncmp(arg
, "-l", 2)) {
1377 mode
= LS_MODE_SHORT
;
1381 mode
= LS_MODE_LONG
;
1384 mode
= LS_MODE_VERBOSE
;
1387 mode
= LS_MODE_MBOX
;
1390 mode
= LS_MODE_CHUNKS
;
1393 mode
= LS_MODE_PARSER
;
1396 return -E_AFT_SYNTAX
;
1399 if (!strcmp(arg
, "-p")) {
1400 flags
|= LS_FLAG_FULL_PATH
;
1403 if (!strcmp(arg
, "-a")) {
1404 flags
|= LS_FLAG_ADMISSIBLE_ONLY
;
1407 if (!strcmp(arg
, "-r")) {
1408 flags
|= LS_FLAG_REVERSE
;
1411 if (!strcmp(arg
, "-d")) {
1412 flags
|= LS_FLAG_UNIXDATE
;
1415 /* The compatibility remark above applies also to -s. */
1416 if (!strncmp(arg
, "-s", 2)) {
1422 sort
= LS_SORT_BY_PATH
;
1424 case 's': /* -ss implies -a */
1425 sort
= LS_SORT_BY_SCORE
;
1426 flags
|= LS_FLAG_ADMISSIBLE_ONLY
;
1429 sort
= LS_SORT_BY_LAST_PLAYED
;
1432 sort
= LS_SORT_BY_NUM_PLAYED
;
1435 sort
= LS_SORT_BY_FREQUENCY
;
1438 sort
= LS_SORT_BY_CHANNELS
;
1441 sort
= LS_SORT_BY_IMAGE_ID
;
1444 sort
= LS_SORT_BY_LYRICS_ID
;
1447 sort
= LS_SORT_BY_BITRATE
;
1450 sort
= LS_SORT_BY_DURATION
;
1453 sort
= LS_SORT_BY_AUDIO_FORMAT
;
1456 return -E_AFT_SYNTAX
;
1459 return -E_AFT_SYNTAX
;
1462 opts
.sorting
= sort
;
1464 opts
.num_patterns
= cc
->argc
- i
;
1465 return send_option_arg_callback_request(&query
, opts
.num_patterns
,
1466 cc
->argv
+ i
, com_ls_callback
, afs_cb_result_handler
, cc
);
1470 * Call the given function for each file in the audio file table.
1472 * \param private_data An arbitrary data pointer, passed to \a func.
1473 * \param func The custom function to be called.
1477 int audio_file_loop(void *private_data
, osl_rbtree_loop_func
*func
)
1479 return osl(osl_rbtree_loop(audio_file_table
, AFTCOL_HASH
, private_data
,
1483 static int find_hash_sister(unsigned char *hash
, struct osl_row
**result
)
1485 int ret
= aft_get_row_of_hash(hash
, result
);
1487 if (ret
== -OSL_ERRNO_TO_PARA_ERROR(E_OSL_RB_KEY_NOT_FOUND
))
1492 static int find_path_brother(const char *path
, struct osl_row
**result
)
1494 int ret
= aft_get_row_of_path(path
, result
);
1496 if (ret
== -OSL_ERRNO_TO_PARA_ERROR(E_OSL_RB_KEY_NOT_FOUND
))
1501 /** The format of the data stored by save_audio_file_data(). */
1502 enum com_add_buffer_offsets
{
1503 /* afhi (if present) starts at this offset. */
1504 CAB_AFHI_OFFSET_POS
= 0,
1505 /** Start of the chunk table (if present). */
1506 CAB_CHUNKS_OFFSET_POS
= 4,
1507 /** Flags given to the add command. */
1508 CAB_FLAGS_OFFSET
= 8,
1509 /** Audio format id. */
1510 CAB_AUDIO_FORMAT_ID_OFFSET
= 12,
1511 /** The hash of the audio file being added. */
1512 CAB_HASH_OFFSET
= 13,
1513 /** Start of the path of the audio file. */
1514 CAB_PATH_OFFSET
= (CAB_HASH_OFFSET
+ HASH_SIZE
),
1518 * Store the given data to a single buffer. Doesn't need the audio file selector
1519 * info struct as the server knows it as well.
1521 * It's OK to call this with afhi == NULL. In this case, the audio format
1522 * handler info won't be stored in the buffer.
1524 static void save_add_callback_buffer(unsigned char *hash
, const char *path
,
1525 struct afh_info
*afhi
, uint32_t flags
,
1526 uint8_t audio_format_num
, struct osl_object
*obj
)
1528 size_t path_len
= strlen(path
) + 1;
1529 size_t afhi_size
= sizeof_afhi_buf(afhi
);
1530 size_t size
= CAB_PATH_OFFSET
+ path_len
+ afhi_size
1531 + sizeof_chunk_table(afhi
);
1532 char *buf
= para_malloc(size
);
1535 pos
= CAB_PATH_OFFSET
+ path_len
;
1536 write_u32(buf
+ CAB_AFHI_OFFSET_POS
, pos
);
1537 save_afhi(afhi
, buf
+ pos
);
1540 write_u32(buf
+ CAB_CHUNKS_OFFSET_POS
, pos
);
1542 save_chunk_table(afhi
, buf
+ pos
);
1544 write_u32(buf
+ CAB_FLAGS_OFFSET
, flags
);
1545 write_u8(buf
+ CAB_AUDIO_FORMAT_ID_OFFSET
, audio_format_num
);
1547 memcpy(buf
+ CAB_HASH_OFFSET
, hash
, HASH_SIZE
);
1548 strcpy(buf
+ CAB_PATH_OFFSET
, path
);
1556 Overview of the add command.
1558 Input: What was passed to the callback by the command handler.
1560 HS: Hash sister. Whether an audio file with identical hash
1561 already exists in the osl database.
1563 PB: Path brother. Whether a file with the given path exists
1566 F: Force flag given. Whether add was called with -f.
1568 output: Action performed by the callback.
1570 AFHI: Whether afhi and chunk table are computed and sent.
1571 ACTION: Table modifications to be done by the callback.
1573 +----+----+---+------+---------------------------------------------------+
1574 | HS | PB | F | AFHI | ACTION
1575 +----+----+---+------+---------------------------------------------------+
1576 | Y | Y | Y | Y | if HS != PB: remove PB. HS: force afhi update,
1577 | | update path, keep afsi
1578 +----+----+---+------+---------------------------------------------------+
1579 | Y | Y | N | N | if HS == PB: do not send callback request at all.
1580 | | otherwise: remove PB, HS: update path, keep afhi,
1582 +----+----+---+------+---------------------------------------------------+
1583 | Y | N | Y | Y | (rename) force afhi update of HS, update path of
1585 +----+----+---+------+---------------------------------------------------+
1586 | Y | N | N | N | (file rename) update path of HS, keep afsi, afhi
1587 +----+----+---+------+---------------------------------------------------+
1588 | N | Y | Y | Y | (file change) update afhi, hash, of PB, keep afsi
1589 | | (force has no effect)
1590 +----+----+---+------+---------------------------------------------------+
1591 | N | Y | N | Y | (file change) update afhi, hash of PB, keep afsi
1592 +----+----+---+------+---------------------------------------------------+
1593 | N | N | Y | Y | (new file) create new entry (force has no effect)
1594 +----+----+---+------+---------------------------------------------------+
1595 | N | N | N | Y | (new file) create new entry
1596 +----+----+---+------+---------------------------------------------------+
1600 afhi <=> force or no HS
1605 /** Flags passed to the add command. */
1606 enum com_add_flags
{
1607 /** Skip paths that exist already. */
1609 /** Force adding. */
1611 /** Print what is being done. */
1612 ADD_FLAG_VERBOSE
= 4,
1613 /** Try to add files with unknown suffixes. */
1617 static int com_add_callback(struct afs_callback_arg
*aca
)
1619 char *buf
= aca
->query
.data
, *path
;
1620 struct osl_row
*pb
, *aft_row
;
1622 struct osl_object objs
[NUM_AFT_COLUMNS
];
1623 unsigned char *hash
;
1624 char asc
[2 * HASH_SIZE
+ 1];
1626 char afsi_buf
[AFSI_SIZE
];
1627 uint32_t flags
= read_u32(buf
+ CAB_FLAGS_OFFSET
);
1628 struct afs_info default_afsi
= {.last_played
= 0};
1629 uint16_t afhi_offset
, chunks_offset
;
1631 hash
= (unsigned char *)buf
+ CAB_HASH_OFFSET
;
1632 hash_to_asc(hash
, asc
);
1633 objs
[AFTCOL_HASH
].data
= buf
+ CAB_HASH_OFFSET
;
1634 objs
[AFTCOL_HASH
].size
= HASH_SIZE
;
1636 path
= buf
+ CAB_PATH_OFFSET
;
1637 objs
[AFTCOL_PATH
].data
= path
;
1638 objs
[AFTCOL_PATH
].size
= strlen(path
) + 1;
1640 PARA_INFO_LOG("request to add %s\n", path
);
1641 ret
= find_hash_sister(hash
, &hs
);
1644 ret
= find_path_brother(path
, &pb
);
1647 if (hs
&& pb
&& hs
== pb
&& !(flags
& ADD_FLAG_FORCE
)) {
1648 if (flags
& ADD_FLAG_VERBOSE
)
1649 para_printf(&aca
->pbout
, "ignoring duplicate\n");
1653 if (hs
&& hs
!= pb
) {
1654 struct osl_object obj
;
1655 if (pb
) { /* hs trumps pb, remove pb */
1656 if (flags
& ADD_FLAG_VERBOSE
)
1657 para_printf(&aca
->pbout
, "removing %s\n", path
);
1658 ret
= afs_event(AUDIO_FILE_REMOVE
, &aca
->pbout
, pb
);
1661 ret
= osl(osl_del_row(audio_file_table
, pb
));
1666 /* file rename, update hs' path */
1667 if (flags
& ADD_FLAG_VERBOSE
) {
1668 ret
= osl(osl_get_object(audio_file_table
, hs
,
1669 AFTCOL_PATH
, &obj
));
1672 para_printf(&aca
->pbout
, "renamed from %s\n",
1675 ret
= osl(osl_update_object(audio_file_table
, hs
, AFTCOL_PATH
,
1676 &objs
[AFTCOL_PATH
]));
1679 ret
= afs_event(AUDIO_FILE_RENAME
, &aca
->pbout
, hs
);
1682 if (!(flags
& ADD_FLAG_FORCE
))
1685 /* no hs or force mode, child must have sent afhi */
1686 afhi_offset
= read_u32(buf
+ CAB_AFHI_OFFSET_POS
);
1687 chunks_offset
= read_u32(buf
+ CAB_CHUNKS_OFFSET_POS
);
1689 objs
[AFTCOL_AFHI
].data
= buf
+ afhi_offset
;
1690 objs
[AFTCOL_AFHI
].size
= chunks_offset
- afhi_offset
;
1692 if (!objs
[AFTCOL_AFHI
].size
) /* "impossible" */
1694 objs
[AFTCOL_CHUNKS
].data
= buf
+ chunks_offset
;
1695 objs
[AFTCOL_CHUNKS
].size
= aca
->query
.size
- chunks_offset
;
1696 if (pb
&& !hs
) { /* update pb's hash */
1697 char old_asc
[2 * HASH_SIZE
+ 1];
1698 unsigned char *old_hash
;
1699 ret
= get_hash_of_row(pb
, &old_hash
);
1702 hash_to_asc(old_hash
, old_asc
);
1703 if (flags
& ADD_FLAG_VERBOSE
)
1704 para_printf(&aca
->pbout
, "file change: %s -> %s\n",
1706 ret
= osl_update_object(audio_file_table
, pb
, AFTCOL_HASH
,
1707 &objs
[AFTCOL_HASH
]);
1711 if (hs
|| pb
) { /* (hs != NULL and pb != NULL) implies hs == pb */
1712 struct osl_row
*row
= pb
? pb
: hs
;
1713 /* update afhi and chunk_table */
1714 if (flags
& ADD_FLAG_VERBOSE
)
1715 para_printf(&aca
->pbout
,
1716 "updating afhi and chunk table\n");
1717 ret
= osl(osl_update_object(audio_file_table
, row
, AFTCOL_AFHI
,
1718 &objs
[AFTCOL_AFHI
]));
1721 ret
= osl(osl_update_object(audio_file_table
, row
, AFTCOL_CHUNKS
,
1722 &objs
[AFTCOL_CHUNKS
]));
1725 ret
= afs_event(AFHI_CHANGE
, &aca
->pbout
, row
);
1730 /* new entry, use default afsi */
1731 if (flags
& ADD_FLAG_VERBOSE
)
1732 para_printf(&aca
->pbout
, "new file\n");
1733 default_afsi
.last_played
= time(NULL
) - 365 * 24 * 60 * 60;
1734 default_afsi
.audio_format_id
= read_u8(buf
+ CAB_AUDIO_FORMAT_ID_OFFSET
);
1736 objs
[AFTCOL_AFSI
].data
= &afsi_buf
;
1737 objs
[AFTCOL_AFSI
].size
= AFSI_SIZE
;
1738 save_afsi(&default_afsi
, &objs
[AFTCOL_AFSI
]);
1739 ret
= osl(osl_add_and_get_row(audio_file_table
, objs
, &aft_row
));
1740 ret
= afs_event(AUDIO_FILE_ADD
, &aca
->pbout
, aft_row
);
1743 para_printf(&aca
->pbout
, "could not add %s\n", path
);
1747 /** Used by com_add(). */
1748 struct private_add_data
{
1749 /** The pointer passed to the original command handler. */
1750 struct command_context
*cc
;
1751 /** The given add flags. */
1755 static int path_brother_callback(struct afs_callback_arg
*aca
)
1757 char *path
= aca
->query
.data
;
1758 struct osl_row
*path_brother
;
1759 int ret
= find_path_brother(path
, &path_brother
);
1762 return pass_buffer_as_shm(aca
->fd
, SBD_OUTPUT
, (char *)&path_brother
,
1763 sizeof(path_brother
));
1766 static int hash_sister_callback(struct afs_callback_arg
*aca
)
1768 unsigned char *hash
= aca
->query
.data
;
1769 struct osl_row
*hash_sister
;
1770 int ret
= find_hash_sister(hash
, &hash_sister
);
1774 return pass_buffer_as_shm(aca
->fd
, SBD_OUTPUT
, (char *)&hash_sister
,
1775 sizeof(hash_sister
));
1778 static int get_row_pointer_from_result(struct osl_object
*result
,
1779 __a_unused
uint8_t band
, void *private)
1781 struct osl_row
**row
= private;
1783 if (band
== SBD_OUTPUT
)
1784 *row
= *(struct osl_row
**)(result
->data
);
1788 static int add_one_audio_file(const char *path
, void *private_data
)
1790 int ret
, send_ret
= 1, fd
;
1791 uint8_t format_num
= -1;
1792 struct private_add_data
*pad
= private_data
;
1793 struct afh_info afhi
, *afhi_ptr
= NULL
;
1794 struct osl_row
*pb
= NULL
, *hs
= NULL
; /* path brother/hash sister */
1795 struct osl_object map
, obj
= {.data
= NULL
}, query
;
1796 unsigned char hash
[HASH_SIZE
];
1798 ret
= guess_audio_format(path
);
1799 if (ret
< 0 && !(pad
->flags
& ADD_FLAG_ALL
)) {
1803 query
.data
= (char *)path
;
1804 query
.size
= strlen(path
) + 1;
1805 ret
= send_callback_request(path_brother_callback
, &query
,
1806 get_row_pointer_from_result
, &pb
);
1807 if (ret
< 0 && ret
!= -OSL_ERRNO_TO_PARA_ERROR(E_OSL_RB_KEY_NOT_FOUND
))
1810 if (pb
&& (pad
->flags
& ADD_FLAG_LAZY
)) { /* lazy is really cheap */
1811 if (pad
->flags
& ADD_FLAG_VERBOSE
)
1812 send_ret
= send_sb_va(&pad
->cc
->scc
, SBD_OUTPUT
,
1813 "lazy-ignore: %s\n", path
);
1816 /* We still want to add this file. Compute its hash. */
1817 ret
= mmap_full_file(path
, O_RDONLY
, &map
.data
, &map
.size
, &fd
);
1820 hash_function(map
.data
, map
.size
, hash
);
1822 /* Check whether the database contains a file with the same hash. */
1824 query
.size
= HASH_SIZE
;
1825 ret
= send_callback_request(hash_sister_callback
, &query
,
1826 get_row_pointer_from_result
, &hs
);
1829 /* Return success if we already know this file. */
1831 if (pb
&& hs
&& hs
== pb
&& !(pad
->flags
& ADD_FLAG_FORCE
)) {
1832 if (pad
->flags
& ADD_FLAG_VERBOSE
)
1833 send_ret
= send_sb_va(&pad
->cc
->scc
, SBD_OUTPUT
,
1834 "%s exists, not forcing update\n", path
);
1838 * We won't recalculate the audio format info and the chunk table if
1839 * there is a hash sister and FORCE was not given.
1841 if (!hs
|| (pad
->flags
& ADD_FLAG_FORCE
)) {
1842 ret
= compute_afhi(path
, map
.data
, map
.size
, fd
, &afhi
);
1848 munmap(map
.data
, map
.size
);
1850 if (pad
->flags
& ADD_FLAG_VERBOSE
) {
1851 send_ret
= send_sb_va(&pad
->cc
->scc
, SBD_OUTPUT
,
1852 "adding %s\n", path
);
1856 save_add_callback_buffer(hash
, path
, afhi_ptr
, pad
->flags
, format_num
, &obj
);
1857 /* Ask afs to consider this entry for adding. */
1858 ret
= send_callback_request(com_add_callback
, &obj
,
1859 afs_cb_result_handler
, pad
->cc
);
1864 munmap(map
.data
, map
.size
);
1866 if (ret
< 0 && send_ret
>= 0)
1867 send_ret
= send_sb_va(&pad
->cc
->scc
, SBD_ERROR_LOG
,
1868 "failed to add %s (%s)\n", path
, para_strerror(-ret
));
1870 clear_afhi(afhi_ptr
);
1871 /* Stop adding files only on send errors. */
1875 int com_add(struct command_context
*cc
)
1878 struct private_add_data pad
= {.cc
= cc
, .flags
= 0};
1880 for (i
= 1; i
< cc
->argc
; i
++) {
1881 const char *arg
= cc
->argv
[i
];
1884 if (!strcmp(arg
, "--")) {
1888 if (!strcmp(arg
, "-a")) {
1889 pad
.flags
|= ADD_FLAG_ALL
;
1892 if (!strcmp(arg
, "-l")) {
1893 pad
.flags
|= ADD_FLAG_LAZY
;
1896 if (!strcmp(arg
, "-f")) {
1897 pad
.flags
|= ADD_FLAG_FORCE
;
1900 if (!strcmp(arg
, "-v")) {
1901 pad
.flags
|= ADD_FLAG_VERBOSE
;
1906 return -E_AFT_SYNTAX
;
1907 for (; i
< cc
->argc
; i
++) {
1909 ret
= verify_path(cc
->argv
[i
], &path
);
1911 ret
= send_sb_va(&cc
->scc
, SBD_ERROR_LOG
, "%s: %s\n",
1912 cc
->argv
[i
], para_strerror(-ret
));
1917 if (ret
== 1) /* directory */
1918 ret
= for_each_file_in_dir(path
, add_one_audio_file
,
1920 else /* regular file */
1921 ret
= add_one_audio_file(path
, &pad
);
1923 send_sb_va(&cc
->scc
, SBD_OUTPUT
, "%s: %s\n", path
,
1924 para_strerror(-ret
));
1934 * Flags used by the touch command.
1939 /** Whether the \p FNM_PATHNAME flag should be passed to fnmatch(). */
1940 TOUCH_FLAG_FNM_PATHNAME
= 1,
1941 /** Activates verbose mode. */
1942 TOUCH_FLAG_VERBOSE
= 2
1945 /** Options used by com_touch(). */
1946 struct com_touch_options
{
1947 /** New num_played value. */
1949 /** New last played count. */
1950 int64_t last_played
;
1951 /** New lyrics id. */
1953 /** New image id. */
1955 /** New amplification value. */
1957 /** Command line flags (see \ref touch_flags). */
1961 static int touch_audio_file(__a_unused
struct osl_table
*table
,
1962 struct osl_row
*row
, const char *name
, void *data
)
1964 struct afs_callback_arg
*aca
= data
;
1965 struct com_touch_options
*cto
= aca
->query
.data
;
1966 struct osl_object obj
;
1967 struct afs_info old_afsi
, new_afsi
;
1968 int ret
, no_options
= cto
->num_played
< 0 && cto
->last_played
< 0 &&
1969 cto
->lyrics_id
< 0 && cto
->image_id
< 0 && cto
->amp
< 0;
1970 struct afsi_change_event_data aced
;
1972 ret
= get_afsi_object_of_row(row
, &obj
);
1974 para_printf(&aca
->pbout
, "cannot touch %s\n", name
);
1977 ret
= load_afsi(&old_afsi
, &obj
);
1979 para_printf(&aca
->pbout
, "cannot touch %s\n", name
);
1982 new_afsi
= old_afsi
;
1984 new_afsi
.num_played
++;
1985 new_afsi
.last_played
= time(NULL
);
1986 if (cto
->flags
& TOUCH_FLAG_VERBOSE
)
1987 para_printf(&aca
->pbout
, "%s: num_played = %u, "
1988 "last_played = now()\n", name
,
1989 new_afsi
.num_played
);
1991 if (cto
->flags
& TOUCH_FLAG_VERBOSE
)
1992 para_printf(&aca
->pbout
, "touching %s\n", name
);
1993 if (cto
->lyrics_id
>= 0)
1994 new_afsi
.lyrics_id
= cto
->lyrics_id
;
1995 if (cto
->image_id
>= 0)
1996 new_afsi
.image_id
= cto
->image_id
;
1997 if (cto
->num_played
>= 0)
1998 new_afsi
.num_played
= cto
->num_played
;
1999 if (cto
->last_played
>= 0)
2000 new_afsi
.last_played
= cto
->last_played
;
2002 new_afsi
.amp
= cto
->amp
;
2004 save_afsi(&new_afsi
, &obj
); /* in-place update */
2006 aced
.old_afsi
= &old_afsi
;
2007 return afs_event(AFSI_CHANGE
, &aca
->pbout
, &aced
);
2010 static int com_touch_callback(struct afs_callback_arg
*aca
)
2013 struct com_touch_options
*cto
= aca
->query
.data
;
2014 struct pattern_match_data pmd
= {
2015 .table
= audio_file_table
,
2016 .loop_col_num
= AFTCOL_HASH
,
2017 .match_col_num
= AFTCOL_PATH
,
2019 .data
= (char *)aca
->query
.data
2020 + sizeof(struct com_touch_options
),
2021 .size
= aca
->query
.size
2022 - sizeof(struct com_touch_options
)
2025 .action
= touch_audio_file
2027 if (cto
->flags
& TOUCH_FLAG_FNM_PATHNAME
)
2028 pmd
.fnmatch_flags
|= FNM_PATHNAME
;
2029 ret
= for_each_matching_row(&pmd
);
2030 if (ret
>= 0 && pmd
.num_matches
== 0)
2035 int com_touch(struct command_context
*cc
)
2037 struct com_touch_options cto
= {
2044 struct osl_object query
= {.data
= &cto
, .size
= sizeof(cto
)};
2048 for (i
= 1; i
< cc
->argc
; i
++) {
2049 const char *arg
= cc
->argv
[i
];
2052 if (!strcmp(arg
, "--")) {
2056 if (!strncmp(arg
, "-n=", 3)) {
2057 ret
= para_atoi32(arg
+ 3, &cto
.num_played
);
2062 if (!strncmp(arg
, "-l=", 3)) {
2063 ret
= para_atoi64(arg
+ 3, &cto
.last_played
);
2068 if (!strncmp(arg
, "-y=", 3)) {
2069 ret
= para_atoi32(arg
+ 3, &cto
.lyrics_id
);
2074 if (!strncmp(arg
, "-i=", 3)) {
2075 ret
= para_atoi32(arg
+ 3, &cto
.image_id
);
2080 if (!strncmp(arg
, "-a=", 3)) {
2082 ret
= para_atoi32(arg
+ 3, &val
);
2085 if (val
< 0 || val
> 255)
2086 return -ERRNO_TO_PARA_ERROR(EINVAL
);
2090 if (!strcmp(arg
, "-p")) {
2091 cto
.flags
|= TOUCH_FLAG_FNM_PATHNAME
;
2094 if (!strcmp(arg
, "-v")) {
2095 cto
.flags
|= TOUCH_FLAG_VERBOSE
;
2098 break; /* non-option starting with dash */
2101 return -E_AFT_SYNTAX
;
2102 return send_option_arg_callback_request(&query
, cc
->argc
- i
,
2103 cc
->argv
+ i
, com_touch_callback
, afs_cb_result_handler
, cc
);
2106 /** Flags for com_rm(). */
2109 RM_FLAG_VERBOSE
= 1,
2113 RM_FLAG_FNM_PATHNAME
= 4
2116 static int remove_audio_file(__a_unused
struct osl_table
*table
,
2117 struct osl_row
*row
, const char *name
, void *data
)
2119 struct afs_callback_arg
*aca
= data
;
2120 uint32_t flags
=*(uint32_t *)aca
->query
.data
;
2123 if (flags
& RM_FLAG_VERBOSE
)
2124 para_printf(&aca
->pbout
, "removing %s\n", name
);
2125 ret
= afs_event(AUDIO_FILE_REMOVE
, &aca
->pbout
, row
);
2128 ret
= osl(osl_del_row(audio_file_table
, row
));
2130 para_printf(&aca
->pbout
, "cannot remove %s\n", name
);
2134 static int com_rm_callback(struct afs_callback_arg
*aca
)
2137 uint32_t flags
= *(uint32_t *)aca
->query
.data
;
2138 struct pattern_match_data pmd
= {
2139 .table
= audio_file_table
,
2140 .loop_col_num
= AFTCOL_HASH
,
2141 .match_col_num
= AFTCOL_PATH
,
2142 .patterns
= {.data
= (char *)aca
->query
.data
+ sizeof(uint32_t),
2143 .size
= aca
->query
.size
- sizeof(uint32_t)},
2145 .action
= remove_audio_file
2147 if (flags
& RM_FLAG_FNM_PATHNAME
)
2148 pmd
.fnmatch_flags
|= FNM_PATHNAME
;
2149 ret
= for_each_matching_row(&pmd
);
2152 if (pmd
.num_matches
== 0) {
2153 if (!(flags
& RM_FLAG_FORCE
))
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 if (p
>= (char *)aca
->query
.data
+ aca
->query
.size
)
2419 pmd
.patterns
.size
= (char *)aca
->query
.data
+ aca
->query
.size
- p
;
2420 ret
= for_each_matching_row(&pmd
);
2423 if (pmd
.num_matches
== 0)
2429 int com_setatt(struct command_context
*cc
)
2432 return -E_ATTR_SYNTAX
;
2433 return send_standard_callback_request(cc
->argc
- 1, cc
->argv
+ 1,
2434 com_setatt_callback
, afs_cb_result_handler
, cc
);
2437 static int afs_stat_callback(struct afs_callback_arg
*aca
)
2439 int *parser_friendly
= aca
->query
.data
;
2440 char *buf
= *parser_friendly
?
2441 parser_friendly_status_items
: status_items
;
2445 return pass_buffer_as_shm(aca
->fd
, SBD_OUTPUT
, buf
, strlen(buf
));
2449 * Get the current afs status items from the afs process and send it.
2451 * \param cc The command context, used e.g. for data encryption.
2452 * \param parser_friendly Whether parser-friendly output format should be used.
2454 * As the contents of the afs status items change in time and the command
2455 * handler only has a COW version created at fork time, it can not send
2456 * up-to-date afs status items directly. Therefore the usual callback mechanism
2457 * is used to pass the status items from the afs process to the command handler
2458 * via a shared memory area and a pipe.
2460 * \return The return value of the underlying call to \ref send_callback_request().
2462 int send_afs_status(struct command_context
*cc
, int parser_friendly
)
2464 struct osl_object query
= {.data
= &parser_friendly
,
2465 .size
= sizeof(parser_friendly
)};
2467 return send_callback_request(afs_stat_callback
, &query
,
2468 afs_cb_result_handler
, cc
);
2471 /* returns success on non-fatal errors to keep the loop going */
2472 static int check_audio_file(struct osl_row
*row
, void *data
)
2475 struct para_buffer
*pb
= data
;
2476 struct stat statbuf
;
2477 int ret
= get_audio_file_path_of_row(row
, &path
);
2478 struct afs_info afsi
;
2482 para_printf(pb
, "%s\n", para_strerror(-ret
));
2485 if (stat(path
, &statbuf
) < 0)
2486 para_printf(pb
, "%s: stat error (%s)\n", path
, strerror(errno
));
2487 else if (!S_ISREG(statbuf
.st_mode
))
2488 para_printf(pb
, "%s: not a regular file\n", path
);
2489 ret
= get_afsi_of_row(row
, &afsi
);
2491 para_printf(pb
, "%s: %s\n", path
, para_strerror(-ret
));
2494 ret
= lyr_get_name_by_id(afsi
.lyrics_id
, &blob_name
);
2496 para_printf(pb
, "%s lyrics id %u: %s\n", path
, afsi
.lyrics_id
,
2497 para_strerror(-ret
));
2498 ret
= img_get_name_by_id(afsi
.image_id
, &blob_name
);
2500 para_printf(pb
, "%s image id %u: %s\n", path
, afsi
.image_id
,
2501 para_strerror(-ret
));
2506 * Check the audio file table for inconsistencies.
2508 * \param aca Only ->pbout is used for diagnostics.
2510 * \return Standard. Inconsistencies are reported but not regarded as an error.
2514 int aft_check_callback(struct afs_callback_arg
*aca
)
2516 para_printf(&aca
->pbout
, "checking audio file table...\n");
2517 return audio_file_loop(&aca
->pbout
, check_audio_file
);
2520 struct aft_check_atts_data
{
2522 struct para_buffer
*pb
;
2525 static int check_atts_of_audio_file(struct osl_row
*row
, void *data
)
2527 struct aft_check_atts_data
*acad
= data
;
2529 struct afs_info afsi
;
2533 ret
= get_afsi_of_row(row
, &afsi
);
2535 para_printf(acad
->pb
, "cannot get afsi\n");
2538 bad_bits
= afsi
.attributes
& ~acad
->att_mask
;
2539 if (bad_bits
== 0) /* OK */
2541 ret
= get_audio_file_path_of_row(row
, &path
);
2543 para_printf(acad
->pb
, "cannot get path\n");
2546 para_printf(acad
->pb
, "invalid attribute bits (%" PRIu64
"): %s\n",
2548 /* return success to keep looping */
2553 * Iterate over all audio files and check the attribute bit mask.
2555 * \param att_mask The mask of all valid attributes.
2556 * \param pb Used for reporting inconsistencies.
2558 * This reads the attribute bit mask of each audio file from the afs info
2559 * structure stored in the audio file table and verifies that all set bits are
2560 * also turned on in \a att_mask, i.e., correspond to an attribute of the
2561 * attribute table. Audio files for which this is not the case are reported via
2564 * \return Standard. Inconsistencies are not regarded as errors.
2566 * \sa \ref attribute_check_callback().
2568 int aft_check_attributes(uint64_t att_mask
, struct para_buffer
*pb
)
2570 struct aft_check_atts_data acad
= {.att_mask
= att_mask
, .pb
= pb
};
2572 para_printf(pb
, "checking attributes, mask: %" PRIx64
"\n", att_mask
);
2573 return audio_file_loop(&acad
, check_atts_of_audio_file
);
2577 * Close the audio file table.
2579 * \param flags Usual flags that are passed to osl_close_table().
2581 * \sa osl_close_table().
2583 static void aft_close(void)
2585 osl_close_table(audio_file_table
, OSL_MARK_CLEAN
);
2586 audio_file_table
= NULL
;
2590 * Open the audio file table.
2592 * \param dir The database directory.
2596 * \sa osl_open_table().
2598 static int aft_open(const char *dir
)
2602 audio_file_table_desc
.dir
= dir
;
2603 ret
= osl(osl_open_table(&audio_file_table_desc
, &audio_file_table
));
2606 osl_get_num_rows(audio_file_table
, &num
);
2607 PARA_INFO_LOG("audio file table contains %d files\n", num
);
2610 PARA_NOTICE_LOG("failed to open audio file table\n");
2611 audio_file_table
= NULL
;
2612 if (ret
== -OSL_ERRNO_TO_PARA_ERROR(E_OSL_NOENT
))
2617 static int aft_create(const char *dir
)
2619 audio_file_table_desc
.dir
= dir
;
2620 return osl(osl_create_table(&audio_file_table_desc
));
2623 static int clear_attribute(struct osl_row
*row
, void *data
)
2625 struct rmatt_event_data
*red
= data
;
2626 struct afs_info afsi
;
2627 struct osl_object obj
;
2628 int ret
= get_afsi_object_of_row(row
, &obj
);
2629 uint64_t mask
= ~(1ULL << red
->bitnum
);
2633 ret
= load_afsi(&afsi
, &obj
);
2636 afsi
.attributes
&= mask
;
2637 save_afsi(&afsi
, &obj
);
2641 static int aft_event_handler(enum afs_events event
, struct para_buffer
*pb
,
2647 case ATTRIBUTE_REMOVE
: {
2648 const struct rmatt_event_data
*red
= data
;
2649 para_printf(pb
, "clearing attribute %s (bit %u) from all "
2650 "entries in the audio file table\n", red
->name
,
2652 return audio_file_loop(data
, clear_attribute
);
2653 } case AFSI_CHANGE
: {
2654 struct afsi_change_event_data
*aced
= data
;
2655 uint64_t old_last_played
= status_item_ls_data
.afsi
.last_played
;
2656 if (aced
->aft_row
!= current_aft_row
)
2658 ret
= get_afsi_of_row(aced
->aft_row
, &status_item_ls_data
.afsi
);
2661 status_item_ls_data
.afsi
.last_played
= old_last_played
;
2662 make_status_items();
2664 } case AFHI_CHANGE
: {
2665 if (data
!= current_aft_row
)
2667 ret
= get_afhi_of_row(data
, &status_item_ls_data
.afhi
);
2670 make_status_items();
2678 * Initialize the audio file table.
2680 * \param t Pointer to the structure to be initialized.
2682 void aft_init(struct afs_table
*t
)
2685 t
->close
= aft_close
;
2686 t
->create
= aft_create
;
2687 t
->event_handler
= aft_event_handler
;