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
296 /* We don't want dot or dot-dot anywhere. */
297 static int verify_dotfile(const char *rest
)
300 * The first character was '.', but that has already been discarded, we
304 case '\0': case '/': /* /foo/. and /foo/./bar are not ok */
306 case '.': /* path start with /foo/.. */
307 if (rest
[1] == '\0' || rest
[1] == '/')
308 return -1; /* /foo/.. or /foo/../bar are not ok */
309 /* /foo/..bar is ok */
315 * We fundamentally don't like some paths: We don't want double slashes or
316 * slashes at the end that can make pathnames ambiguous.
318 static int verify_path(const char *orig_path
, char **resolved_path
)
324 if (*orig_path
!= '/') /* we only accept absolute paths */
326 len
= strlen(orig_path
);
327 *resolved_path
= para_strdup(orig_path
);
328 path
= *resolved_path
;
329 while (len
> 1 && path
[--len
] == '/')
330 path
[len
] = '\0'; /* remove slash at the end */
336 case '/': /* double slash */
339 if (verify_dotfile(path
) < 0)
349 free(*resolved_path
);
353 /** The on-disk layout of a afhi struct. */
355 /** Where the number of seconds is stored. */
356 AFHI_SECONDS_TOTAL_OFFSET
= 0,
357 /** Position of the bitrate. */
358 AFHI_BITRATE_OFFSET
= 4,
359 /** Position of the frequency. */
360 AFHI_FREQUENCY_OFFSET
= 8,
361 /** Was: Location of the audio file header. */
362 AFHI_UNUSED1_OFFSET
= 12,
363 /* Length of the audio file header. Zero means: No header. */
364 AFHI_HEADER_LEN_OFFSET
= 16,
365 /** The total number of chunks (4 bytes). */
366 CHUNKS_TOTAL_OFFSET
= 20,
367 /** The length of the audio file header (4 bytes). */
368 HEADER_LEN_OFFSET
= 24,
369 /** Was: The start of the audio file header (4 bytes). */
370 AFHI_UNUSED2_OFFSET
= 28,
371 /** The seconds part of the chunk time (4 bytes). */
372 CHUNK_TV_TV_SEC_OFFSET
= 32,
373 /** The microseconds part of the chunk time (4 bytes). */
374 CHUNK_TV_TV_USEC_OFFSET
= 36,
375 /** Number of channels is stored here. (1 byte) */
376 AFHI_CHANNELS_OFFSET
= 40,
377 /** The tag info position. */
378 AFHI_INFO_STRING_OFFSET
= 41,
379 /** Minimal on-disk size of a valid afhi struct. */
380 MIN_AFHI_SIZE
= 47, /* at least 6 null bytes for techinfo/tags */
383 static unsigned sizeof_afhi_buf(const struct afh_info
*afhi
)
388 + strlen(afhi
->techinfo
)
389 + strlen(afhi
->tags
.artist
)
390 + strlen(afhi
->tags
.title
)
391 + strlen(afhi
->tags
.year
)
392 + strlen(afhi
->tags
.album
)
393 + strlen(afhi
->tags
.comment
);
396 static void save_afhi(struct afh_info
*afhi
, char *buf
)
402 write_u32(buf
+ AFHI_SECONDS_TOTAL_OFFSET
, afhi
->seconds_total
);
403 write_u32(buf
+ AFHI_BITRATE_OFFSET
, afhi
->bitrate
);
404 write_u32(buf
+ AFHI_FREQUENCY_OFFSET
, afhi
->frequency
);
405 write_u32(buf
+ AFHI_UNUSED1_OFFSET
, 0);
406 write_u32(buf
+ AFHI_HEADER_LEN_OFFSET
, afhi
->header_len
);
407 write_u8(buf
+ AFHI_CHANNELS_OFFSET
, afhi
->channels
);
408 write_u32(buf
+ CHUNKS_TOTAL_OFFSET
, afhi
->chunks_total
);
409 write_u32(buf
+ HEADER_LEN_OFFSET
, afhi
->header_len
);
410 write_u32(buf
+ AFHI_UNUSED2_OFFSET
, 0);
411 write_u32(buf
+ CHUNK_TV_TV_SEC_OFFSET
, afhi
->chunk_tv
.tv_sec
);
412 write_u32(buf
+ CHUNK_TV_TV_USEC_OFFSET
, afhi
->chunk_tv
.tv_usec
);
413 p
= buf
+ AFHI_INFO_STRING_OFFSET
;
414 /* The sprintf's below are OK as our caller made sure that buf is large enough */
415 p
+= sprintf(p
, "%s", afhi
->techinfo
) + 1;
416 p
+= sprintf(p
, "%s", afhi
->tags
.artist
) + 1;
417 p
+= sprintf(p
, "%s", afhi
->tags
.title
) + 1;
418 p
+= sprintf(p
, "%s", afhi
->tags
.year
) + 1;
419 p
+= sprintf(p
, "%s", afhi
->tags
.album
) + 1;
420 sprintf(p
, "%s", afhi
->tags
.comment
);
423 static void load_afhi(const char *buf
, struct afh_info
*afhi
)
425 afhi
->seconds_total
= read_u32(buf
+ AFHI_SECONDS_TOTAL_OFFSET
);
426 afhi
->bitrate
= read_u32(buf
+ AFHI_BITRATE_OFFSET
);
427 afhi
->frequency
= read_u32(buf
+ AFHI_FREQUENCY_OFFSET
);
428 afhi
->header_len
= read_u32(buf
+ AFHI_HEADER_LEN_OFFSET
);
429 afhi
->channels
= read_u8(buf
+ AFHI_CHANNELS_OFFSET
);
430 afhi
->chunks_total
= read_u32(buf
+ CHUNKS_TOTAL_OFFSET
);
431 afhi
->header_len
= read_u32(buf
+ HEADER_LEN_OFFSET
);
432 afhi
->chunk_tv
.tv_sec
= read_u32(buf
+ CHUNK_TV_TV_SEC_OFFSET
);
433 afhi
->chunk_tv
.tv_usec
= read_u32(buf
+ CHUNK_TV_TV_USEC_OFFSET
);
434 afhi
->techinfo
= (char *)buf
+ AFHI_INFO_STRING_OFFSET
;
435 afhi
->tags
.artist
= afhi
->techinfo
+ strlen(afhi
->techinfo
) + 1;
436 afhi
->tags
.title
= afhi
->tags
.artist
+ strlen(afhi
->tags
.artist
) + 1;
437 afhi
->tags
.year
= afhi
->tags
.title
+ strlen(afhi
->tags
.title
) + 1;
438 afhi
->tags
.album
= afhi
->tags
.year
+ strlen(afhi
->tags
.year
) + 1;
439 afhi
->tags
.comment
= afhi
->tags
.album
+ strlen(afhi
->tags
.album
) + 1;
442 static unsigned sizeof_chunk_table(struct afh_info
*afhi
)
446 return 4 * (afhi
->chunks_total
+ 1);
449 static uint32_t save_chunk_table(struct afh_info
*afhi
, char *buf
)
452 uint32_t max
= 0, old
= 0;
454 for (i
= 0; i
<= afhi
->chunks_total
; i
++) {
455 uint32_t val
= afhi
->chunk_table
[i
];
456 write_u32(buf
+ 4 * i
, val
);
458 * If the first chunk is the header, do not consider it for the
459 * calculation of the largest chunk size.
461 if (i
== 0 || (i
== 1 && afhi
->header_len
> 0)) {
465 max
= PARA_MAX(max
, val
- old
);
471 static void load_chunk_table(struct afh_info
*afhi
, char *buf
)
475 afhi
->chunk_table
= para_malloc(sizeof_chunk_table(afhi
));
476 for (i
= 0; i
<= afhi
->chunks_total
; i
++)
477 afhi
->chunk_table
[i
] = read_u32(buf
+ 4 * i
);
481 * Get the row of the audio file table corresponding to the given path.
483 * \param path The full path of the audio file.
484 * \param row Result pointer.
488 int aft_get_row_of_path(const char *path
, struct osl_row
**row
)
490 struct osl_object obj
= {.data
= (char *)path
, .size
= strlen(path
) + 1};
492 return osl(osl_get_row(audio_file_table
, AFTCOL_PATH
, &obj
, row
));
496 * Get the row of the audio file table corresponding to the given hash value.
498 * \param hash The hash value of the desired audio file.
499 * \param row Result pointer.
503 static int aft_get_row_of_hash(unsigned char *hash
, struct osl_row
**row
)
505 const struct osl_object obj
= {.data
= hash
, .size
= HASH_SIZE
};
506 return osl(osl_get_row(audio_file_table
, AFTCOL_HASH
, &obj
, row
));
510 * Get the audio file selector info object of a row.
512 * \param row Pointer to a row in the audio file table.
513 * \param obj Result pointer.
517 static int get_afsi_object_of_row(const struct osl_row
*row
,
518 struct osl_object
*obj
)
520 return osl(osl_get_object(audio_file_table
, row
, AFTCOL_AFSI
, obj
));
524 * Get the osl object holding the audio file selector info, given a path.
527 * \param path The full path of the audio file.
528 * \param obj Result pointer.
530 * \return Positive on success, negative on errors.
532 static int get_afsi_object_of_path(const char *path
, struct osl_object
*obj
)
535 int ret
= aft_get_row_of_path(path
, &row
);
538 return get_afsi_object_of_row(row
, obj
);
542 * Get the audio file selector info, given a row of the audio file table.
544 * \param row Pointer to a row in the audio file table.
545 * \param afsi Result pointer.
547 * \return Positive on success, negative on errors.
549 int get_afsi_of_row(const struct osl_row
*row
, struct afs_info
*afsi
)
551 struct osl_object obj
;
552 int ret
= get_afsi_object_of_row(row
, &obj
);
555 return load_afsi(afsi
, &obj
);
559 * Get the audio file selector info, given the path of an audio table.
561 * \param path The full path of the audio file.
562 * \param afsi Result pointer.
566 static int get_afsi_of_path(const char *path
, struct afs_info
*afsi
)
568 struct osl_object obj
;
569 int ret
= get_afsi_object_of_path(path
, &obj
);
572 return load_afsi(afsi
, &obj
);
576 * Get the path of an audio file, given a row of the audio file table.
578 * \param row Pointer to a row in the audio file table.
579 * \param path Result pointer.
581 * The result is a pointer to mmapped data. The caller must not attempt
586 int get_audio_file_path_of_row(const struct osl_row
*row
, char **path
)
588 struct osl_object path_obj
;
589 int ret
= osl(osl_get_object(audio_file_table
, row
, AFTCOL_PATH
,
593 *path
= path_obj
.data
;
598 * Get the object containing the hash value of an audio file, given a row.
600 * \param row Pointer to a row of the audio file table.
601 * \param obj Result pointer.
603 * \return The return value of the underlying call to osl_get_object().
605 * \sa get_hash_of_row().
607 static int get_hash_object_of_aft_row(const struct osl_row
*row
,
608 struct osl_object
*obj
)
610 return osl(osl_get_object(audio_file_table
, row
, AFTCOL_HASH
, obj
));
614 * Get the hash value of an audio file, given a row of the audio file table.
616 * \param row Pointer to a row of the audio file table.
617 * \param hash Result pointer.
619 * \a hash points to mapped data and must not be freed by the caller.
621 * \return The return value of the underlying call to
622 * get_hash_object_of_aft_row().
624 static int get_hash_of_row(const struct osl_row
*row
, unsigned char **hash
)
626 struct osl_object obj
;
627 int ret
= get_hash_object_of_aft_row(row
, &obj
);
636 * Get the audio format handler info, given a row of the audio file table.
638 * \param row Pointer to a row of the audio file table.
639 * \param afhi Result pointer.
641 * \return The return value of the underlying call to osl_get_object().
643 * \sa get_chunk_table_of_row().
645 int get_afhi_of_row(const struct osl_row
*row
, struct afh_info
*afhi
)
647 struct osl_object obj
;
648 int ret
= osl(osl_get_object(audio_file_table
, row
, AFTCOL_AFHI
,
652 load_afhi(obj
.data
, afhi
);
656 /* returns shmid on success */
657 static int save_afd(struct audio_file_data
*afd
)
659 size_t size
= sizeof(*afd
) + sizeof_chunk_table(&afd
->afhi
);
660 int shmid
, ret
= shm_new(size
);
667 ret
= shm_attach(shmid
, ATTACH_RW
, &shm_afd
);
672 afd
->max_chunk_size
= save_chunk_table(&afd
->afhi
, buf
);
673 *(struct audio_file_data
*)shm_afd
= *afd
;
682 * Extract a afd stored in a shared memory area.
684 * Attach the shared memory area given by \a shmid, load the audio file data
685 * stored therein and detach the area afterwards. Called by vss, after
686 * receiving a positive response to the request for the next audio file.
688 * \param shmid The identifier of the shared memory area containing the afd.
689 * \param afd Result pointer.
693 int load_afd(int shmid
, struct audio_file_data
*afd
)
699 ret
= shm_attach(shmid
, ATTACH_RO
, &shm_afd
);
702 *afd
= *(struct audio_file_data
*)shm_afd
;
705 load_chunk_table(&afd
->afhi
, buf
);
710 static int get_local_time(uint64_t *seconds
, char *buf
, size_t size
,
711 time_t current_time
, enum ls_listing_mode lm
)
715 if (!localtime_r((time_t *)seconds
, &t
))
717 if (lm
== LS_MODE_MBOX
) {
718 if (!strftime(buf
, size
, "%c", &t
))
722 if (*seconds
+ 6 * 30 * 24 * 3600 > current_time
) {
723 if (!strftime(buf
, size
, "%b %e %k:%M", &t
))
727 if (!strftime(buf
, size
, "%b %e %Y", &t
))
732 /** Compute the number of (decimal) digits of a number. */
733 #define GET_NUM_DIGITS(x, num) { \
734 typeof((x)) _tmp = PARA_ABS(x); \
737 while ((_tmp) > 9) { \
743 __a_const
static short unsigned get_duration_width(int seconds
)
745 short unsigned width
;
746 unsigned hours
= seconds
/ 3600, mins
= (seconds
% 3600) / 60;
748 if (!hours
) /* less than one hour => m:ss or mm:ss => 4 or 5 digits */
749 return 4 + (mins
> 9);
750 /* more than one hour => h:mm:ss, hh:mm:ss, hhh:mm:ss, ... */
751 GET_NUM_DIGITS(hours
, &width
);
755 static void get_duration_buf(int seconds
, char *buf
, struct ls_options
*opts
)
757 unsigned hours
= seconds
/ 3600, mins
= (seconds
% 3600) / 60;
758 short unsigned max_width
;
760 if (!hours
) { /* m:ss or mm:ss */
761 max_width
= opts
->mode
== LS_MODE_LONG
?
762 opts
->widths
.duration_width
: 4;
763 sprintf(buf
, "%*u:%02u", max_width
- 3, mins
, seconds
% 60);
764 } else { /* more than one hour => h:mm:ss, hh:mm:ss, hhh:mm:ss, ... */
765 max_width
= opts
->mode
== LS_MODE_LONG
?
766 opts
->widths
.duration_width
: 7;
767 sprintf(buf
, "%*u:%02u:%02u", max_width
- 6, hours
, mins
,
772 static int write_attribute_items(struct para_buffer
*b
,
773 const char *att_bitmap
, struct afs_info
*afsi
)
778 ret
= WRITE_STATUS_ITEM(b
, SI_ATTRIBUTES_BITMAP
, "%s\n", att_bitmap
);
781 ret
= get_attribute_text(&afsi
->attributes
, " ", &att_text
);
784 ret
= WRITE_STATUS_ITEM(b
, SI_ATTRIBUTES_TXT
, "%s\n", att_text
);
789 static int write_lyrics_items(struct para_buffer
*b
, struct afs_info
*afsi
)
794 ret
= WRITE_STATUS_ITEM(b
, SI_LYRICS_ID
, "%u\n", afsi
->lyrics_id
);
797 lyr_get_name_by_id(afsi
->lyrics_id
, &lyrics_name
);
798 return WRITE_STATUS_ITEM(b
, SI_LYRICS_NAME
, "%s\n", lyrics_name
?
799 lyrics_name
: "(none)");
802 static int write_image_items(struct para_buffer
*b
, struct afs_info
*afsi
)
807 ret
= WRITE_STATUS_ITEM(b
, SI_IMAGE_ID
, "%u\n", afsi
->image_id
);
810 img_get_name_by_id(afsi
->image_id
, &image_name
);
811 return WRITE_STATUS_ITEM(b
, SI_IMAGE_NAME
, "%s\n", image_name
?
812 image_name
: "(none)");
815 static int write_filename_items(struct para_buffer
*b
, const char *path
,
821 if (!(flags
& LS_FLAG_FULL_PATH
))
822 return WRITE_STATUS_ITEM(b
, SI_BASENAME
, "%s\n", path
);
823 ret
= WRITE_STATUS_ITEM(b
, SI_PATH
, "%s\n", path
);
826 val
= para_basename(path
);
827 ret
= WRITE_STATUS_ITEM(b
, SI_BASENAME
, "%s\n", val
? val
: "");
830 val
= para_dirname(path
);
831 ret
= WRITE_STATUS_ITEM(b
, SI_DIRECTORY
, "%s\n", val
? val
: "");
836 static int print_chunk_table(struct ls_data
*d
, struct para_buffer
*b
)
838 struct osl_object chunk_table_obj
;
839 struct osl_row
*aft_row
;
843 ret
= aft_get_row_of_hash(d
->hash
, &aft_row
);
846 ret
= osl(osl_open_disk_object(audio_file_table
, aft_row
,
847 AFTCOL_CHUNKS
, &chunk_table_obj
));
850 ret
= para_printf(b
, "%s\n"
851 "chunk_time: %lu:%lu\nchunk_offsets: ",
853 (long unsigned) d
->afhi
.chunk_tv
.tv_sec
,
854 (long unsigned) d
->afhi
.chunk_tv
.tv_usec
858 buf
= chunk_table_obj
.data
;
859 for (i
= 0; i
<= d
->afhi
.chunks_total
; i
++) {
860 ret
= para_printf(b
, "%u ", (unsigned) read_u32(buf
+ 4 * i
));
864 ret
= para_printf(b
, "\n");
866 osl_close_disk_object(&chunk_table_obj
);
870 static int write_score(struct para_buffer
*b
, struct ls_data
*d
,
871 struct ls_options
*opts
)
873 if (!(opts
->flags
& LS_FLAG_ADMISSIBLE_ONLY
)) /* no score*/
875 return WRITE_STATUS_ITEM(b
, SI_SCORE
, "%li\n", d
->score
);
878 static int print_list_item(struct ls_data
*d
, struct ls_options
*opts
,
879 struct para_buffer
*b
, time_t current_time
)
883 char last_played_time
[30];
884 char duration_buf
[30]; /* nobody has an audio file long enough to overflow this */
885 struct afs_info
*afsi
= &d
->afsi
;
886 struct afh_info
*afhi
= &d
->afhi
;
887 char asc_hash
[2 * HASH_SIZE
+ 1];
889 if (opts
->mode
== LS_MODE_SHORT
) {
890 ret
= para_printf(b
, "%s\n", d
->path
);
893 if (opts
->mode
== LS_MODE_CHUNKS
) {
894 ret
= print_chunk_table(d
, b
);
897 get_attribute_bitmap(&afsi
->attributes
, att_buf
);
898 if (opts
->flags
& LS_FLAG_UNIXDATE
)
899 sprintf(last_played_time
, "%llu",
900 (long long unsigned)afsi
->last_played
);
902 ret
= get_local_time(&afsi
->last_played
, last_played_time
,
903 sizeof(last_played_time
), current_time
, opts
->mode
);
907 get_duration_buf(afhi
->seconds_total
, duration_buf
, opts
);
908 if (opts
->mode
== LS_MODE_LONG
) {
909 struct ls_widths
*w
= &opts
->widths
;
910 if (opts
->flags
& LS_FLAG_ADMISSIBLE_ONLY
) {
911 ret
= para_printf(b
, "%*li ",
912 opts
->widths
.score_width
, d
->score
);
917 "%s " /* attributes */
919 "%*d " /* image_id */
920 "%*d " /* lyrics_id */
922 "%*s " /* audio format */
923 "%*d " /* frequency */
926 "%*d " /* num_played */
927 "%s " /* last_played */
930 w
->amp_width
, afsi
->amp
,
931 w
->image_id_width
, afsi
->image_id
,
932 w
->lyrics_id_width
, afsi
->lyrics_id
,
933 w
->bitrate_width
, afhi
->bitrate
,
934 w
->audio_format_width
,
935 audio_format_name(afsi
->audio_format_id
),
936 w
->frequency_width
, afhi
->frequency
,
939 w
->num_played_width
, afsi
->num_played
,
945 if (opts
->mode
== LS_MODE_MBOX
) {
946 const char *bn
= para_basename(d
->path
);
948 "From foo@localhost %s\n"
949 "Received: from\nTo: bar\nFrom: a\n"
956 ret
= write_filename_items(b
, d
->path
, opts
->flags
);
959 ret
= write_score(b
, d
, opts
);
962 ret
= write_attribute_items(b
, att_buf
, afsi
);
965 ret
= write_image_items(b
, afsi
);
968 ret
= write_lyrics_items(b
, afsi
);
971 hash_to_asc(d
->hash
, asc_hash
);
972 ret
= WRITE_STATUS_ITEM(b
, SI_HASH
, "%s\n", asc_hash
);
975 ret
= WRITE_STATUS_ITEM(b
, SI_BITRATE
, "%dkbit/s\n", afhi
->bitrate
);
978 ret
= WRITE_STATUS_ITEM(b
, SI_FORMAT
, "%s\n",
979 audio_format_name(afsi
->audio_format_id
));
982 ret
= WRITE_STATUS_ITEM(b
, SI_FREQUENCY
, "%dHz\n", afhi
->frequency
);
985 ret
= WRITE_STATUS_ITEM(b
, SI_CHANNELS
, "%d\n", afhi
->channels
);
988 ret
= WRITE_STATUS_ITEM(b
, SI_DURATION
, "%s\n", duration_buf
);
991 ret
= WRITE_STATUS_ITEM(b
, SI_SECONDS_TOTAL
, "%lu\n",
992 afhi
->seconds_total
);
995 ret
= WRITE_STATUS_ITEM(b
, SI_LAST_PLAYED
, "%s\n", last_played_time
);
998 ret
= WRITE_STATUS_ITEM(b
, SI_NUM_PLAYED
, "%d\n", afsi
->num_played
);
1001 ret
= WRITE_STATUS_ITEM(b
, SI_AMPLIFICATION
, "%u\n", afsi
->amp
);
1004 ret
= WRITE_STATUS_ITEM(b
, SI_CHUNK_TIME
, "%lu\n",
1005 tv2ms(&afhi
->chunk_tv
));
1008 ret
= WRITE_STATUS_ITEM(b
, SI_NUM_CHUNKS
, "%lu\n",
1009 afhi
->chunks_total
);
1012 ret
= WRITE_STATUS_ITEM(b
, SI_TECHINFO
, "%s\n", afhi
->techinfo
);
1015 ret
= WRITE_STATUS_ITEM(b
, SI_ARTIST
, "%s\n", afhi
->tags
.artist
);
1018 ret
= WRITE_STATUS_ITEM(b
, SI_TITLE
, "%s\n", afhi
->tags
.title
);
1021 ret
= WRITE_STATUS_ITEM(b
, SI_YEAR
, "%s\n", afhi
->tags
.year
);
1024 ret
= WRITE_STATUS_ITEM(b
, SI_ALBUM
, "%s\n", afhi
->tags
.album
);
1027 ret
= WRITE_STATUS_ITEM(b
, SI_COMMENT
, "%s\n", afhi
->tags
.comment
);
1030 if (opts
->mode
== LS_MODE_MBOX
) {
1031 struct osl_object lyrics_def
;
1032 lyr_get_def_by_id(afsi
->lyrics_id
, &lyrics_def
);
1033 if (lyrics_def
.data
) {
1034 ret
= para_printf(b
, "Lyrics:\n~~~~~~~\n%s",
1035 (char *)lyrics_def
.data
);
1036 osl_close_disk_object(&lyrics_def
);
1043 static int make_status_items(struct audio_file_data
*afd
,
1044 struct afs_info
*afsi
, char *path
, long score
,
1045 unsigned char *hash
)
1047 struct ls_data d
= {
1054 struct ls_options opts
= {
1055 .flags
= LS_FLAG_FULL_PATH
| LS_FLAG_ADMISSIBLE_ONLY
,
1056 .mode
= LS_MODE_VERBOSE
,
1058 struct para_buffer pb
= {.max_size
= shm_get_shmmax() - 1};
1059 time_t current_time
;
1062 time(¤t_time
);
1063 ret
= print_list_item(&d
, &opts
, &pb
, current_time
);
1067 status_items
= pb
.buf
;
1068 memset(&pb
, 0, sizeof(pb
));
1069 pb
.max_size
= shm_get_shmmax() - 1;
1070 pb
.flags
= PBF_SIZE_PREFIX
;
1071 ret
= print_list_item(&d
, &opts
, &pb
, current_time
);
1074 status_items
= NULL
;
1077 free(parser_friendly_status_items
);
1078 parser_friendly_status_items
= pb
.buf
;
1083 * Mmap the given audio file and update statistics.
1085 * \param aft_row Determines the audio file to be opened and updated.
1086 * \param score The score of the audio file.
1087 * \param afd Result pointer.
1089 * On success, the numplayed field of the audio file selector info is increased
1090 * and the lastplayed time is set to the current time. Finally, the score of
1091 * the audio file is updated.
1093 * \return Positive shmid on success, negative on errors.
1095 int open_and_update_audio_file(struct osl_row
*aft_row
, long score
,
1096 struct audio_file_data
*afd
)
1098 unsigned char *aft_hash
, file_hash
[HASH_SIZE
];
1099 struct osl_object afsi_obj
;
1100 struct afs_info old_afsi
, new_afsi
;
1101 int ret
= get_hash_of_row(aft_row
, &aft_hash
);
1102 struct afsi_change_event_data aced
;
1103 struct osl_object map
, chunk_table_obj
;
1108 ret
= get_audio_file_path_of_row(aft_row
, &path
);
1111 PARA_NOTICE_LOG("%s\n", path
);
1112 ret
= get_afsi_object_of_row(aft_row
, &afsi_obj
);
1115 ret
= load_afsi(&old_afsi
, &afsi_obj
);
1118 ret
= get_afhi_of_row(aft_row
, &afd
->afhi
);
1121 afd
->afhi
.chunk_table
= NULL
;
1122 ret
= osl(osl_open_disk_object(audio_file_table
, aft_row
,
1123 AFTCOL_CHUNKS
, &chunk_table_obj
));
1126 ret
= mmap_full_file(path
, O_RDONLY
, &map
.data
, &map
.size
, &afd
->fd
);
1129 hash_function(map
.data
, map
.size
, file_hash
);
1130 ret
= hash_compare(file_hash
, aft_hash
);
1131 para_munmap(map
.data
, map
.size
);
1133 ret
= -E_HASH_MISMATCH
;
1136 new_afsi
= old_afsi
;
1137 new_afsi
.num_played
++;
1138 new_afsi
.last_played
= time(NULL
);
1139 save_afsi(&new_afsi
, &afsi_obj
); /* in-place update */
1141 afd
->audio_format_id
= old_afsi
.audio_format_id
;
1142 load_chunk_table(&afd
->afhi
, chunk_table_obj
.data
);
1143 ret
= make_status_items(afd
, &old_afsi
, path
, score
, file_hash
);
1146 aced
.aft_row
= aft_row
;
1147 aced
.old_afsi
= &old_afsi
;
1148 afs_event(AFSI_CHANGE
, NULL
, &aced
);
1149 ret
= save_afd(afd
);
1151 free(afd
->afhi
.chunk_table
);
1152 osl_close_disk_object(&chunk_table_obj
);
1154 PARA_ERROR_LOG("%s: %s\n", path
, para_strerror(-ret
));
1158 static int ls_audio_format_compare(const void *a
, const void *b
)
1160 struct ls_data
*d1
= *(struct ls_data
**)a
, *d2
= *(struct ls_data
**)b
;
1161 return NUM_COMPARE(d1
->afsi
.audio_format_id
, d2
->afsi
.audio_format_id
);
1164 static int ls_duration_compare(const void *a
, const void *b
)
1166 struct ls_data
*d1
= *(struct ls_data
**)a
, *d2
= *(struct ls_data
**)b
;
1167 return NUM_COMPARE(d1
->afhi
.seconds_total
, d2
->afhi
.seconds_total
);
1170 static int ls_bitrate_compare(const void *a
, const void *b
)
1172 struct ls_data
*d1
= *(struct ls_data
**)a
, *d2
= *(struct ls_data
**)b
;
1173 return NUM_COMPARE(d1
->afhi
.bitrate
, d2
->afhi
.bitrate
);
1176 static int ls_lyrics_id_compare(const void *a
, const void *b
)
1178 struct ls_data
*d1
= *(struct ls_data
**)a
, *d2
= *(struct ls_data
**)b
;
1179 return NUM_COMPARE(d1
->afsi
.lyrics_id
, d2
->afsi
.lyrics_id
);
1182 static int ls_image_id_compare(const void *a
, const void *b
)
1184 struct ls_data
*d1
= *(struct ls_data
**)a
, *d2
= *(struct ls_data
**)b
;
1185 return NUM_COMPARE(d1
->afsi
.image_id
, d2
->afsi
.image_id
);
1188 static int ls_channels_compare(const void *a
, const void *b
)
1190 struct ls_data
*d1
= *(struct ls_data
**)a
, *d2
= *(struct ls_data
**)b
;
1191 return NUM_COMPARE(d1
->afhi
.channels
, d2
->afhi
.channels
);
1194 static int ls_frequency_compare(const void *a
, const void *b
)
1196 struct ls_data
*d1
= *(struct ls_data
**)a
, *d2
= *(struct ls_data
**)b
;
1197 return NUM_COMPARE(d1
->afhi
.frequency
, d2
->afhi
.frequency
);
1200 static int ls_num_played_compare(const void *a
, const void *b
)
1202 struct ls_data
*d1
= *(struct ls_data
**)a
, *d2
= *(struct ls_data
**)b
;
1203 return NUM_COMPARE(d1
->afsi
.num_played
, d2
->afsi
.num_played
);
1206 static int ls_last_played_compare(const void *a
, const void *b
)
1208 struct ls_data
*d1
= *(struct ls_data
**)a
, *d2
= *(struct ls_data
**)b
;
1209 return NUM_COMPARE(d1
->afsi
.last_played
, d2
->afsi
.last_played
);
1212 static int ls_score_compare(const void *a
, const void *b
)
1214 struct ls_data
*d1
= *(struct ls_data
**)a
, *d2
= *(struct ls_data
**)b
;
1215 return NUM_COMPARE(d1
->score
, d2
->score
);
1218 static int ls_path_compare(const void *a
, const void *b
)
1220 struct ls_data
*d1
= *(struct ls_data
**)a
, *d2
= *(struct ls_data
**)b
;
1221 return strcmp(d1
->path
, d2
->path
);
1224 static int sort_matching_paths(struct ls_options
*options
)
1226 size_t nmemb
= options
->num_matching_paths
;
1227 size_t size
= sizeof(*options
->data_ptr
);
1228 int (*compar
)(const void *, const void *);
1231 options
->data_ptr
= para_malloc(nmemb
* sizeof(*options
->data_ptr
));
1232 for (i
= 0; i
< nmemb
; i
++)
1233 options
->data_ptr
[i
] = options
->data
+ i
;
1235 /* In these cases the array is already sorted */
1236 if (options
->sorting
== LS_SORT_BY_PATH
1237 && !(options
->flags
& LS_FLAG_ADMISSIBLE_ONLY
)
1238 && (options
->flags
& LS_FLAG_FULL_PATH
))
1240 if (options
->sorting
== LS_SORT_BY_SCORE
&&
1241 options
->flags
& LS_FLAG_ADMISSIBLE_ONLY
)
1244 switch (options
->sorting
) {
1245 case LS_SORT_BY_PATH
:
1246 compar
= ls_path_compare
; break;
1247 case LS_SORT_BY_SCORE
:
1248 compar
= ls_score_compare
; break;
1249 case LS_SORT_BY_LAST_PLAYED
:
1250 compar
= ls_last_played_compare
; break;
1251 case LS_SORT_BY_NUM_PLAYED
:
1252 compar
= ls_num_played_compare
; break;
1253 case LS_SORT_BY_FREQUENCY
:
1254 compar
= ls_frequency_compare
; break;
1255 case LS_SORT_BY_CHANNELS
:
1256 compar
= ls_channels_compare
; break;
1257 case LS_SORT_BY_IMAGE_ID
:
1258 compar
= ls_image_id_compare
; break;
1259 case LS_SORT_BY_LYRICS_ID
:
1260 compar
= ls_lyrics_id_compare
; break;
1261 case LS_SORT_BY_BITRATE
:
1262 compar
= ls_bitrate_compare
; break;
1263 case LS_SORT_BY_DURATION
:
1264 compar
= ls_duration_compare
; break;
1265 case LS_SORT_BY_AUDIO_FORMAT
:
1266 compar
= ls_audio_format_compare
; break;
1270 qsort(options
->data_ptr
, nmemb
, size
, compar
);
1274 /* row is either an aft_row or a row of the score table */
1275 /* TODO: Only compute widths if we need them */
1276 static int prepare_ls_row(struct osl_row
*row
, void *ls_opts
)
1279 struct ls_options
*options
= ls_opts
;
1281 struct ls_widths
*w
;
1282 unsigned short num_digits
;
1284 struct osl_row
*aft_row
;
1288 if (options
->flags
& LS_FLAG_ADMISSIBLE_ONLY
) {
1289 ret
= get_score_and_aft_row(row
, &score
, &aft_row
);
1296 ret
= get_audio_file_path_of_row(aft_row
, &path
);
1299 if (!(options
->flags
& LS_FLAG_FULL_PATH
)) {
1300 char *p
= strrchr(path
, '/');
1304 if (options
->num_patterns
) {
1305 for (i
= 0; i
< options
->num_patterns
; i
++) {
1306 ret
= fnmatch(options
->patterns
[i
], path
, 0);
1309 if (ret
== FNM_NOMATCH
)
1313 if (i
>= options
->num_patterns
) /* no match */
1316 tmp
= options
->num_matching_paths
++;
1317 if (options
->num_matching_paths
> options
->array_size
) {
1318 options
->array_size
++;
1319 options
->array_size
*= 2;
1320 options
->data
= para_realloc(options
->data
, options
->array_size
1321 * sizeof(*options
->data
));
1323 d
= options
->data
+ tmp
;
1324 ret
= get_afsi_of_row(aft_row
, &d
->afsi
);
1327 ret
= get_afhi_of_row(aft_row
, &d
->afhi
);
1331 ret
= get_hash_of_row(aft_row
, &d
->hash
);
1334 w
= &options
->widths
;
1335 GET_NUM_DIGITS(d
->afsi
.image_id
, &num_digits
);
1336 w
->image_id_width
= PARA_MAX(w
->image_id_width
, num_digits
);
1337 GET_NUM_DIGITS(d
->afsi
.lyrics_id
, &num_digits
);
1338 w
->lyrics_id_width
= PARA_MAX(w
->lyrics_id_width
, num_digits
);
1339 GET_NUM_DIGITS(d
->afhi
.bitrate
, &num_digits
);
1340 w
->bitrate_width
= PARA_MAX(w
->bitrate_width
, num_digits
);
1341 GET_NUM_DIGITS(d
->afhi
.frequency
, &num_digits
);
1342 w
->frequency_width
= PARA_MAX(w
->frequency_width
, num_digits
);
1343 GET_NUM_DIGITS(d
->afsi
.num_played
, &num_digits
);
1344 w
->num_played_width
= PARA_MAX(w
->num_played_width
, num_digits
);
1345 /* get the number of chars to print this amount of time */
1346 num_digits
= get_duration_width(d
->afhi
.seconds_total
);
1347 w
->duration_width
= PARA_MAX(w
->duration_width
, num_digits
);
1348 GET_NUM_DIGITS(d
->afsi
.amp
, &num_digits
);
1349 w
->amp_width
= PARA_MAX(w
->amp_width
, num_digits
);
1350 num_digits
= strlen(audio_format_name(d
->afsi
.audio_format_id
));
1351 w
->audio_format_width
= PARA_MAX(w
->audio_format_width
, num_digits
);
1352 if (options
->flags
& LS_FLAG_ADMISSIBLE_ONLY
) {
1353 GET_NUM_DIGITS(score
, &num_digits
);
1354 num_digits
++; /* add one for the sign (space or "-") */
1355 w
->score_width
= PARA_MAX(w
->score_width
, num_digits
);
1363 static void com_ls_callback(int fd
, const struct osl_object
*query
)
1365 struct ls_options
*opts
= query
->data
;
1366 char *p
, *pattern_start
= (char *)query
->data
+ sizeof(*opts
);
1367 struct para_buffer b
= {
1368 .max_size
= shm_get_shmmax(),
1369 .flags
= (opts
->mode
== LS_MODE_PARSER
)? PBF_SIZE_PREFIX
: 0,
1370 .max_size_handler
= afs_max_size_handler
,
1371 .private_data
= &(struct afs_max_size_handler_data
) {
1377 time_t current_time
;
1379 if (opts
->num_patterns
) {
1380 opts
->patterns
= para_malloc(opts
->num_patterns
* sizeof(char *));
1381 for (i
= 0, p
= pattern_start
; i
< opts
->num_patterns
; i
++) {
1382 opts
->patterns
[i
] = p
;
1386 opts
->patterns
= NULL
;
1387 if (opts
->flags
& LS_FLAG_ADMISSIBLE_ONLY
)
1388 ret
= admissible_file_loop(opts
, prepare_ls_row
);
1390 ret
= osl(osl_rbtree_loop(audio_file_table
, AFTCOL_PATH
, opts
,
1394 if (opts
->num_matching_paths
== 0) {
1395 if (opts
->num_patterns
> 0)
1396 para_printf(&b
, "no matches\n");
1399 ret
= sort_matching_paths(opts
);
1402 time(¤t_time
);
1403 if (opts
->flags
& LS_FLAG_REVERSE
)
1404 for (i
= opts
->num_matching_paths
- 1; i
>= 0; i
--) {
1405 ret
= print_list_item(opts
->data_ptr
[i
], opts
, &b
, current_time
);
1410 for (i
= 0; i
< opts
->num_matching_paths
; i
++) {
1411 ret
= print_list_item(opts
->data_ptr
[i
], opts
, &b
, current_time
);
1417 pass_buffer_as_shm(fd
, SBD_OUTPUT
, b
.buf
, b
.offset
);
1420 free(opts
->data_ptr
);
1421 free(opts
->patterns
);
1425 * TODO: flags -h (sort by hash)
1427 int com_ls(struct command_context
*cc
)
1431 enum ls_sorting_method sort
= LS_SORT_BY_PATH
;
1432 enum ls_listing_mode mode
= LS_MODE_SHORT
;
1433 struct ls_options opts
= {.patterns
= NULL
};
1434 struct osl_object query
= {.data
= &opts
, .size
= sizeof(opts
)};
1436 for (i
= 1; i
< cc
->argc
; i
++) {
1437 const char *arg
= cc
->argv
[i
];
1440 if (!strcmp(arg
, "--")) {
1444 if (!strncmp(arg
, "-l", 2)) {
1446 mode
= LS_MODE_LONG
;
1450 return -E_AFT_SYNTAX
;
1451 switch(*(arg
+ 2)) {
1453 mode
= LS_MODE_SHORT
;
1456 mode
= LS_MODE_LONG
;
1459 mode
= LS_MODE_VERBOSE
;
1462 mode
= LS_MODE_MBOX
;
1465 mode
= LS_MODE_CHUNKS
;
1468 mode
= LS_MODE_PARSER
;
1471 return -E_AFT_SYNTAX
;
1474 if (!strcmp(arg
, "-p")) {
1475 flags
|= LS_FLAG_FULL_PATH
;
1478 if (!strcmp(arg
, "-a")) {
1479 flags
|= LS_FLAG_ADMISSIBLE_ONLY
;
1482 if (!strcmp(arg
, "-r")) {
1483 flags
|= LS_FLAG_REVERSE
;
1486 if (!strcmp(arg
, "-d")) {
1487 flags
|= LS_FLAG_UNIXDATE
;
1490 if (!strncmp(arg
, "-s", 2)) {
1491 if (!*(arg
+ 2) || *(arg
+ 3))
1492 return -E_AFT_SYNTAX
;
1493 switch(*(arg
+ 2)) {
1495 sort
= LS_SORT_BY_PATH
;
1497 case 's': /* -ss implies -a */
1498 sort
= LS_SORT_BY_SCORE
;
1499 flags
|= LS_FLAG_ADMISSIBLE_ONLY
;
1502 sort
= LS_SORT_BY_LAST_PLAYED
;
1505 sort
= LS_SORT_BY_NUM_PLAYED
;
1508 sort
= LS_SORT_BY_FREQUENCY
;
1511 sort
= LS_SORT_BY_CHANNELS
;
1514 sort
= LS_SORT_BY_IMAGE_ID
;
1517 sort
= LS_SORT_BY_LYRICS_ID
;
1520 sort
= LS_SORT_BY_BITRATE
;
1523 sort
= LS_SORT_BY_DURATION
;
1526 sort
= LS_SORT_BY_AUDIO_FORMAT
;
1529 return -E_AFT_SYNTAX
;
1532 return -E_AFT_SYNTAX
;
1535 opts
.sorting
= sort
;
1537 opts
.num_patterns
= cc
->argc
- i
;
1538 ret
= send_option_arg_callback_request(&query
, opts
.num_patterns
,
1539 cc
->argv
+ i
, com_ls_callback
, afs_cb_result_handler
, cc
);
1544 * Call the given function for each file in the audio file table.
1546 * \param private_data An arbitrary data pointer, passed to \a func.
1547 * \param func The custom function to be called.
1551 int audio_file_loop(void *private_data
, osl_rbtree_loop_func
*func
)
1553 return osl(osl_rbtree_loop(audio_file_table
, AFTCOL_HASH
, private_data
,
1557 static struct osl_row
*find_hash_sister(unsigned char *hash
)
1559 const struct osl_object obj
= {.data
= hash
, .size
= HASH_SIZE
};
1560 struct osl_row
*row
;
1562 osl_get_row(audio_file_table
, AFTCOL_HASH
, &obj
, &row
);
1566 /** The format of the data stored by save_audio_file_data(). */
1567 enum com_add_buffer_offsets
{
1568 /** afhi (if present) starts here. */
1569 CAB_AFHI_OFFSET_POS
= 0,
1570 /** Start of the chunk table (if present). */
1571 CAB_CHUNKS_OFFSET_POS
= 2,
1572 /** Audio format id. */
1573 CAB_AUDIO_FORMAT_OFFSET
= 4,
1574 /** Flags given to the add command. */
1575 CAB_FLAGS_OFFSET
= 5,
1576 /** The hash of the audio file being added. */
1577 CAB_HASH_OFFSET
= 9,
1578 /** Start of the path of the audio file. */
1579 CAB_PATH_OFFSET
= (CAB_HASH_OFFSET
+ HASH_SIZE
),
1583 * Store the given data to a single buffer. Doesn't need the audio file selector
1584 * info struct as the server knows it as well.
1586 * It's OK to call this with afhi == NULL. In this case, the audio format
1587 * handler info won't be stored in the buffer.
1589 static void save_add_callback_buffer(unsigned char *hash
, const char *path
,
1590 struct afh_info
*afhi
, uint32_t flags
,
1591 uint8_t audio_format_num
, struct osl_object
*obj
)
1593 size_t path_len
= strlen(path
) + 1;
1594 size_t afhi_size
= sizeof_afhi_buf(afhi
);
1595 size_t size
= CAB_PATH_OFFSET
+ path_len
+ afhi_size
1596 + sizeof_chunk_table(afhi
);
1597 char *buf
= para_malloc(size
);
1600 write_u8(buf
+ CAB_AUDIO_FORMAT_OFFSET
, audio_format_num
);
1601 write_u32(buf
+ CAB_FLAGS_OFFSET
, flags
);
1603 memcpy(buf
+ CAB_HASH_OFFSET
, hash
, HASH_SIZE
);
1604 strcpy(buf
+ CAB_PATH_OFFSET
, path
);
1606 pos
= CAB_PATH_OFFSET
+ path_len
;
1607 PARA_DEBUG_LOG("size: %zu, afhi starts at %d\n", size
, pos
);
1608 PARA_DEBUG_LOG("last afhi byte: %p, pos %zu\n", buf
+ pos
+ afhi_size
- 1,
1609 pos
+ afhi_size
- 1);
1610 write_u16(buf
+ CAB_AFHI_OFFSET_POS
, pos
);
1611 save_afhi(afhi
, buf
+ pos
);
1614 PARA_DEBUG_LOG("size: %zu, chunks start at %d\n", size
, pos
);
1615 write_u16(buf
+ CAB_CHUNKS_OFFSET_POS
, pos
);
1617 save_chunk_table(afhi
, buf
+ pos
);
1618 PARA_DEBUG_LOG("last byte in buf: %p\n", buf
+ size
- 1);
1625 Overview of the add command.
1627 Input: What was passed to the callback by the command handler.
1629 HS: Hash sister. Whether an audio file with identical hash
1630 already exists in the osl database.
1632 PB: Path brother. Whether a file with the given path exists
1635 F: Force flag given. Whether add was called with -f.
1637 output: Action performed by the callback.
1639 AFHI: Whether afhi and chunk table are computed and sent.
1640 ACTION: Table modifications to be done by the callback.
1642 +----+----+---+------+---------------------------------------------------+
1643 | HS | PB | F | AFHI | ACTION
1644 +----+----+---+------+---------------------------------------------------+
1645 | Y | Y | Y | Y | if HS != PB: remove PB. HS: force afhi update,
1646 | | update path, keep afsi
1647 +----+----+---+------+---------------------------------------------------+
1648 | Y | Y | N | N | if HS == PB: do not send callback request at all.
1649 | | otherwise: remove PB, HS: update path, keep afhi,
1651 +----+----+---+------+---------------------------------------------------+
1652 | Y | N | Y | Y | (rename) force afhi update of HS, update path of
1654 +----+----+---+------+---------------------------------------------------+
1655 | Y | N | N | N | (file rename) update path of HS, keep afsi, afhi
1656 +----+----+---+------+---------------------------------------------------+
1657 | N | Y | Y | Y | (file change) update afhi, hash, of PB, keep afsi
1658 | | (force has no effect)
1659 +----+----+---+------+---------------------------------------------------+
1660 | N | Y | N | Y | (file change) update afhi, hash of PB, keep afsi
1661 +----+----+---+------+---------------------------------------------------+
1662 | N | N | Y | Y | (new file) create new entry (force has no effect)
1663 +----+----+---+------+---------------------------------------------------+
1664 | N | N | N | Y | (new file) create new entry
1665 +----+----+---+------+---------------------------------------------------+
1669 afhi <=> force or no HS
1674 /** Flags passed to the add command. */
1675 enum com_add_flags
{
1676 /** Skip paths that exist already. */
1678 /** Force adding. */
1680 /** Print what is being done. */
1681 ADD_FLAG_VERBOSE
= 4,
1682 /** Try to add files with unknown suffixes. */
1686 static void com_add_callback(int fd
, const struct osl_object
*query
)
1688 char *buf
= query
->data
, *path
;
1689 struct osl_row
*pb
, *aft_row
;
1691 struct osl_object objs
[NUM_AFT_COLUMNS
];
1692 unsigned char *hash
;
1693 char asc
[2 * HASH_SIZE
+ 1];
1695 char afsi_buf
[AFSI_SIZE
];
1696 uint32_t flags
= read_u32(buf
+ CAB_FLAGS_OFFSET
);
1697 struct afs_info default_afsi
= {.last_played
= 0};
1698 struct para_buffer msg
= {
1699 .max_size
= shm_get_shmmax(),
1700 .max_size_handler
= afs_max_size_handler
,
1701 .private_data
= &(struct afs_max_size_handler_data
) {
1706 uint16_t afhi_offset
, chunks_offset
;
1708 hash
= (unsigned char *)buf
+ CAB_HASH_OFFSET
;
1709 hash_to_asc(hash
, asc
);
1710 objs
[AFTCOL_HASH
].data
= buf
+ CAB_HASH_OFFSET
;
1711 objs
[AFTCOL_HASH
].size
= HASH_SIZE
;
1713 path
= buf
+ CAB_PATH_OFFSET
;
1714 objs
[AFTCOL_PATH
].data
= path
;
1715 objs
[AFTCOL_PATH
].size
= strlen(path
) + 1;
1717 PARA_INFO_LOG("request to add %s\n", path
);
1718 hs
= find_hash_sister(hash
);
1719 ret
= aft_get_row_of_path(path
, &pb
);
1720 if (ret
< 0 && ret
!= -OSL_ERRNO_TO_PARA_ERROR(E_OSL_RB_KEY_NOT_FOUND
))
1722 if (hs
&& pb
&& hs
== pb
&& !(flags
& ADD_FLAG_FORCE
)) {
1723 if (flags
& ADD_FLAG_VERBOSE
)
1724 ret
= para_printf(&msg
, "ignoring duplicate\n");
1729 if (hs
&& hs
!= pb
) {
1730 struct osl_object obj
;
1731 if (pb
) { /* hs trumps pb, remove pb */
1732 if (flags
& ADD_FLAG_VERBOSE
) {
1733 ret
= para_printf(&msg
, "removing %s\n", path
);
1737 afs_event(AUDIO_FILE_REMOVE
, &msg
, pb
);
1738 ret
= osl(osl_del_row(audio_file_table
, pb
));
1743 /* file rename, update hs' path */
1744 if (flags
& ADD_FLAG_VERBOSE
) {
1745 ret
= osl(osl_get_object(audio_file_table
, hs
,
1746 AFTCOL_PATH
, &obj
));
1749 ret
= para_printf(&msg
, "renamed from %s\n", (char *)obj
.data
);
1753 ret
= osl(osl_update_object(audio_file_table
, hs
, AFTCOL_PATH
,
1754 &objs
[AFTCOL_PATH
]));
1757 afs_event(AUDIO_FILE_RENAME
, &msg
, hs
);
1758 if (!(flags
& ADD_FLAG_FORCE
))
1761 /* no hs or force mode, child must have sent afhi */
1762 afhi_offset
= read_u16(buf
+ CAB_AFHI_OFFSET_POS
);
1763 chunks_offset
= read_u16(buf
+ CAB_CHUNKS_OFFSET_POS
);
1765 objs
[AFTCOL_AFHI
].data
= buf
+ afhi_offset
;
1766 objs
[AFTCOL_AFHI
].size
= chunks_offset
- afhi_offset
;
1768 if (!objs
[AFTCOL_AFHI
].size
) /* "impossible" */
1770 objs
[AFTCOL_CHUNKS
].data
= buf
+ chunks_offset
;
1771 objs
[AFTCOL_CHUNKS
].size
= query
->size
- chunks_offset
;
1772 if (pb
&& !hs
) { /* update pb's hash */
1773 char old_asc
[2 * HASH_SIZE
+ 1];
1774 unsigned char *old_hash
;
1775 ret
= get_hash_of_row(pb
, &old_hash
);
1778 hash_to_asc(old_hash
, old_asc
);
1779 if (flags
& ADD_FLAG_VERBOSE
) {
1780 ret
= para_printf(&msg
, "file change: %s -> %s\n",
1785 ret
= osl_update_object(audio_file_table
, pb
, AFTCOL_HASH
,
1786 &objs
[AFTCOL_HASH
]);
1790 if (hs
|| pb
) { /* (hs != NULL and pb != NULL) implies hs == pb */
1791 struct osl_row
*row
= pb
? pb
: hs
;
1792 /* update afhi and chunk_table */
1793 if (flags
& ADD_FLAG_VERBOSE
) {
1794 ret
= para_printf(&msg
, "updating afhi and chunk table\n");
1798 ret
= osl(osl_update_object(audio_file_table
, row
, AFTCOL_AFHI
,
1799 &objs
[AFTCOL_AFHI
]));
1802 ret
= osl(osl_update_object(audio_file_table
, row
, AFTCOL_CHUNKS
,
1803 &objs
[AFTCOL_CHUNKS
]));
1806 afs_event(AFHI_CHANGE
, &msg
, row
);
1809 /* new entry, use default afsi */
1810 if (flags
& ADD_FLAG_VERBOSE
) {
1811 ret
= para_printf(&msg
, "new file\n");
1815 default_afsi
.last_played
= time(NULL
) - 365 * 24 * 60 * 60;
1816 default_afsi
.audio_format_id
= read_u8(buf
+ CAB_AUDIO_FORMAT_OFFSET
);
1818 objs
[AFTCOL_AFSI
].data
= &afsi_buf
;
1819 objs
[AFTCOL_AFSI
].size
= AFSI_SIZE
;
1820 save_afsi(&default_afsi
, &objs
[AFTCOL_AFSI
]);
1821 ret
= osl(osl_add_and_get_row(audio_file_table
, objs
, &aft_row
));
1822 afs_event(AUDIO_FILE_ADD
, &msg
, aft_row
);
1825 para_printf(&msg
, "%s\n", para_strerror(-ret
));
1827 pass_buffer_as_shm(fd
, SBD_OUTPUT
, msg
.buf
, msg
.offset
);
1831 /** Used by com_add(). */
1832 struct private_add_data
{
1833 /** The pointer passed to the original command handler. */
1834 struct command_context
*cc
;
1835 /** The given add flags. */
1839 static void path_brother_callback(int fd
, const struct osl_object
*query
)
1841 char *path
= query
->data
;
1842 struct osl_row
*path_brother
;
1843 int ret
= aft_get_row_of_path(path
, &path_brother
);
1846 pass_buffer_as_shm(fd
, SBD_OUTPUT
, (char *)&path_brother
,
1847 sizeof(path_brother
));
1850 static void hash_sister_callback(int fd
, const struct osl_object
*query
)
1852 unsigned char *hash
= query
->data
;
1853 struct osl_row
*hash_sister
;
1855 hash_sister
= find_hash_sister(hash
);
1858 pass_buffer_as_shm(fd
, SBD_OUTPUT
, (char *)&hash_sister
,
1859 sizeof(hash_sister
));
1862 static int get_row_pointer_from_result(struct osl_object
*result
,
1863 __a_unused
uint8_t band
, void *private)
1865 struct osl_row
**row
= private;
1866 *row
= *(struct osl_row
**)(result
->data
);
1870 static int add_one_audio_file(const char *path
, void *private_data
)
1872 int ret
, send_ret
= 1, fd
;
1873 uint8_t format_num
= -1;
1874 struct private_add_data
*pad
= private_data
;
1875 struct afh_info afhi
, *afhi_ptr
= NULL
;
1876 struct osl_row
*pb
= NULL
, *hs
= NULL
; /* path brother/hash sister */
1877 struct osl_object map
, obj
= {.data
= NULL
}, query
;
1878 unsigned char hash
[HASH_SIZE
];
1880 ret
= guess_audio_format(path
);
1881 if (ret
< 0 && !(pad
->flags
& ADD_FLAG_ALL
))
1883 query
.data
= (char *)path
;
1884 query
.size
= strlen(path
) + 1;
1885 ret
= send_callback_request(path_brother_callback
, &query
,
1886 get_row_pointer_from_result
, &pb
);
1887 if (ret
< 0 && ret
!= -OSL_ERRNO_TO_PARA_ERROR(E_OSL_RB_KEY_NOT_FOUND
))
1890 if (pb
&& (pad
->flags
& ADD_FLAG_LAZY
)) { /* lazy is really cheap */
1891 if (pad
->flags
& ADD_FLAG_VERBOSE
)
1892 send_ret
= send_sb_va(&pad
->cc
->scc
, SBD_OUTPUT
,
1893 "lazy-ignore: %s\n", path
);
1896 /* We still want to add this file. Compute its hash. */
1897 ret
= mmap_full_file(path
, O_RDONLY
, &map
.data
, &map
.size
, &fd
);
1900 hash_function(map
.data
, map
.size
, hash
);
1902 /* Check whether the database contains a file with the same hash. */
1904 query
.size
= HASH_SIZE
;
1905 ret
= send_callback_request(hash_sister_callback
, &query
,
1906 get_row_pointer_from_result
, &hs
);
1909 /* Return success if we already know this file. */
1911 if (pb
&& hs
&& hs
== pb
&& !(pad
->flags
& ADD_FLAG_FORCE
)) {
1912 if (pad
->flags
& ADD_FLAG_VERBOSE
)
1913 send_ret
= send_sb_va(&pad
->cc
->scc
, SBD_OUTPUT
,
1914 "%s exists, not forcing update\n", path
);
1918 * We won't recalculate the audio format info and the chunk table if
1919 * there is a hash sister and FORCE was not given.
1921 if (!hs
|| (pad
->flags
& ADD_FLAG_FORCE
)) {
1922 ret
= compute_afhi(path
, map
.data
, map
.size
, fd
, &afhi
);
1928 munmap(map
.data
, map
.size
);
1930 if (pad
->flags
& ADD_FLAG_VERBOSE
) {
1931 send_ret
= send_sb_va(&pad
->cc
->scc
, SBD_OUTPUT
,
1932 "adding %s\n", path
);
1936 save_add_callback_buffer(hash
, path
, afhi_ptr
, pad
->flags
, format_num
, &obj
);
1937 /* Ask afs to consider this entry for adding. */
1938 ret
= send_callback_request(com_add_callback
, &obj
,
1939 afs_cb_result_handler
, pad
->cc
);
1944 munmap(map
.data
, map
.size
);
1946 if (ret
< 0 && send_ret
>= 0)
1947 send_ret
= send_sb_va(&pad
->cc
->scc
, SBD_ERROR_LOG
,
1948 "failed to add %s (%s)\n", path
, para_strerror(-ret
));
1950 clear_afhi(afhi_ptr
);
1951 /* Stop adding files only on send errors. */
1955 int com_add(struct command_context
*cc
)
1958 struct private_add_data pad
= {.cc
= cc
, .flags
= 0};
1959 struct stat statbuf
;
1961 for (i
= 1; i
< cc
->argc
; i
++) {
1962 const char *arg
= cc
->argv
[i
];
1965 if (!strcmp(arg
, "--")) {
1969 if (!strcmp(arg
, "-a")) {
1970 pad
.flags
|= ADD_FLAG_ALL
;
1973 if (!strcmp(arg
, "-l")) {
1974 pad
.flags
|= ADD_FLAG_LAZY
;
1977 if (!strcmp(arg
, "-f")) {
1978 pad
.flags
|= ADD_FLAG_FORCE
;
1981 if (!strcmp(arg
, "-v")) {
1982 pad
.flags
|= ADD_FLAG_VERBOSE
;
1987 return -E_AFT_SYNTAX
;
1988 for (; i
< cc
->argc
; i
++) {
1990 ret
= verify_path(cc
->argv
[i
], &path
);
1992 ret
= send_sb_va(&cc
->scc
, SBD_ERROR_LOG
, "%s: %s\n",
1993 cc
->argv
[i
], para_strerror(-ret
));
1998 ret
= stat(path
, &statbuf
);
2000 ret
= send_sb_va(&cc
->scc
, SBD_ERROR_LOG
,
2001 "failed to stat %s (%s)\n", path
,
2008 if (S_ISDIR(statbuf
.st_mode
))
2009 ret
= for_each_file_in_dir(path
, add_one_audio_file
,
2012 ret
= add_one_audio_file(path
, &pad
);
2014 send_sb_va(&cc
->scc
, SBD_OUTPUT
, "%s: %s\n", path
,
2015 para_strerror(-ret
));
2025 * Flags used by the touch command.
2030 /** Whether the \p FNM_PATHNAME flag should be passed to fnmatch(). */
2031 TOUCH_FLAG_FNM_PATHNAME
= 1,
2032 /** Activates verbose mode. */
2033 TOUCH_FLAG_VERBOSE
= 2
2036 /** Options used by com_touch(). */
2037 struct com_touch_options
{
2038 /** New num_played value. */
2040 /** New last played count. */
2041 int64_t last_played
;
2042 /** New lyrics id. */
2044 /** New image id. */
2046 /** New amplification value. */
2048 /** Command line flags (see \ref touch_flags). */
2052 /** Data passed to the action handler of com_touch(). */
2053 struct touch_action_data
{
2054 /** Command line options (see \ref com_touch_options). */
2055 struct com_touch_options
*cto
;
2056 /** Message buffer. */
2057 struct para_buffer pb
;
2060 static int touch_audio_file(__a_unused
struct osl_table
*table
,
2061 struct osl_row
*row
, const char *name
, void *data
)
2063 struct touch_action_data
*tad
= data
;
2064 struct osl_object obj
;
2065 struct afs_info old_afsi
, new_afsi
;
2066 int ret
, no_options
= tad
->cto
->num_played
< 0 && tad
->cto
->last_played
< 0 &&
2067 tad
->cto
->lyrics_id
< 0 && tad
->cto
->image_id
< 0 && tad
->cto
->amp
< 0;
2068 struct afsi_change_event_data aced
;
2070 ret
= get_afsi_object_of_row(row
, &obj
);
2072 return para_printf(&tad
->pb
, "%s: %s\n", name
, para_strerror(-ret
));
2073 ret
= load_afsi(&old_afsi
, &obj
);
2075 return para_printf(&tad
->pb
, "%s: %s\n", name
, para_strerror(-ret
));
2076 new_afsi
= old_afsi
;
2078 new_afsi
.num_played
++;
2079 new_afsi
.last_played
= time(NULL
);
2080 if (tad
->cto
->flags
& TOUCH_FLAG_VERBOSE
) {
2081 ret
= para_printf(&tad
->pb
, "%s: num_played = %u, "
2082 "last_played = now()\n", name
,
2083 new_afsi
.num_played
);
2088 if (tad
->cto
->flags
& TOUCH_FLAG_VERBOSE
) {
2089 ret
= para_printf(&tad
->pb
, "touching %s\n", name
);
2093 if (tad
->cto
->lyrics_id
>= 0)
2094 new_afsi
.lyrics_id
= tad
->cto
->lyrics_id
;
2095 if (tad
->cto
->image_id
>= 0)
2096 new_afsi
.image_id
= tad
->cto
->image_id
;
2097 if (tad
->cto
->num_played
>= 0)
2098 new_afsi
.num_played
= tad
->cto
->num_played
;
2099 if (tad
->cto
->last_played
>= 0)
2100 new_afsi
.last_played
= tad
->cto
->last_played
;
2101 if (tad
->cto
->amp
>= 0)
2102 new_afsi
.amp
= tad
->cto
->amp
;
2104 save_afsi(&new_afsi
, &obj
); /* in-place update */
2106 aced
.old_afsi
= &old_afsi
;
2107 afs_event(AFSI_CHANGE
, &tad
->pb
, &aced
);
2111 static void com_touch_callback(int fd
, const struct osl_object
*query
)
2113 struct touch_action_data tad
= {.cto
= query
->data
,
2115 .max_size
= shm_get_shmmax(),
2116 .private_data
= &fd
,
2117 .max_size_handler
= afs_max_size_handler
2121 struct pattern_match_data pmd
= {
2122 .table
= audio_file_table
,
2123 .loop_col_num
= AFTCOL_HASH
,
2124 .match_col_num
= AFTCOL_PATH
,
2125 .patterns
= {.data
= (char *)query
->data
+ sizeof(*tad
.cto
),
2126 .size
= query
->size
- sizeof(*tad
.cto
)},
2128 .action
= touch_audio_file
2130 if (tad
.cto
->flags
& TOUCH_FLAG_FNM_PATHNAME
)
2131 pmd
.fnmatch_flags
|= FNM_PATHNAME
;
2132 ret
= for_each_matching_row(&pmd
);
2134 ret2
= para_printf(&tad
.pb
, "%s\n", para_strerror(-ret
));
2135 else if (pmd
.num_matches
== 0)
2136 ret2
= para_printf(&tad
.pb
, "no matches\n");
2137 if (ret2
>= 0 && tad
.pb
.offset
)
2138 pass_buffer_as_shm(fd
, SBD_OUTPUT
, tad
.pb
.buf
, tad
.pb
.offset
);
2142 int com_touch(struct command_context
*cc
)
2144 struct com_touch_options cto
= {
2151 struct osl_object query
= {.data
= &cto
, .size
= sizeof(cto
)};
2155 for (i
= 1; i
< cc
->argc
; i
++) {
2156 const char *arg
= cc
->argv
[i
];
2159 if (!strcmp(arg
, "--")) {
2163 if (!strncmp(arg
, "-n=", 3)) {
2164 ret
= para_atoi32(arg
+ 3, &cto
.num_played
);
2169 if (!strncmp(arg
, "-l=", 3)) {
2170 ret
= para_atoi64(arg
+ 3, &cto
.last_played
);
2175 if (!strncmp(arg
, "-y=", 3)) {
2176 ret
= para_atoi32(arg
+ 3, &cto
.lyrics_id
);
2181 if (!strncmp(arg
, "-i=", 3)) {
2182 ret
= para_atoi32(arg
+ 3, &cto
.image_id
);
2187 if (!strncmp(arg
, "-a=", 3)) {
2189 ret
= para_atoi32(arg
+ 3, &val
);
2192 if (val
< 0 || val
> 255)
2193 return -ERRNO_TO_PARA_ERROR(EINVAL
);
2197 if (!strcmp(arg
, "-p")) {
2198 cto
.flags
|= TOUCH_FLAG_FNM_PATHNAME
;
2201 if (!strcmp(arg
, "-v")) {
2202 cto
.flags
|= TOUCH_FLAG_VERBOSE
;
2205 break; /* non-option starting with dash */
2208 return -E_AFT_SYNTAX
;
2209 ret
= send_option_arg_callback_request(&query
, cc
->argc
- i
,
2210 cc
->argv
+ i
, com_touch_callback
, afs_cb_result_handler
, cc
);
2212 send_strerror(cc
, -ret
);
2216 /** Flags for com_rm(). */
2219 RM_FLAG_VERBOSE
= 1,
2223 RM_FLAG_FNM_PATHNAME
= 4
2226 /** Data passed to the action handler of com_rm(). */
2227 struct com_rm_action_data
{
2228 /** Command line flags ((see \ref rm_flags). */
2230 /** Message buffer. */
2231 struct para_buffer pb
;
2234 static int remove_audio_file(__a_unused
struct osl_table
*table
,
2235 struct osl_row
*row
, const char *name
, void *data
)
2237 struct com_rm_action_data
*crd
= data
;
2240 if (crd
->flags
& RM_FLAG_VERBOSE
) {
2241 ret
= para_printf(&crd
->pb
, "removing %s\n", name
);
2245 afs_event(AUDIO_FILE_REMOVE
, &crd
->pb
, row
);
2246 ret
= osl(osl_del_row(audio_file_table
, row
));
2248 para_printf(&crd
->pb
, "%s: %s\n", name
, para_strerror(-ret
));
2252 static void com_rm_callback(int fd
, const struct osl_object
*query
)
2254 struct com_rm_action_data crd
= {.flags
= *(uint32_t *)query
->data
,
2256 .max_size
= shm_get_shmmax(),
2257 .private_data
= &fd
,
2258 .max_size_handler
= afs_max_size_handler
2262 struct pattern_match_data pmd
= {
2263 .table
= audio_file_table
,
2264 .loop_col_num
= AFTCOL_HASH
,
2265 .match_col_num
= AFTCOL_PATH
,
2266 .patterns
= {.data
= (char *)query
->data
+ sizeof(uint32_t),
2267 .size
= query
->size
- sizeof(uint32_t)},
2269 .action
= remove_audio_file
2271 if (crd
.flags
& RM_FLAG_FNM_PATHNAME
)
2272 pmd
.fnmatch_flags
|= FNM_PATHNAME
;
2273 ret
= for_each_matching_row(&pmd
);
2275 para_printf(&crd
.pb
, "%s\n", para_strerror(-ret
));
2278 if ((pmd
.num_matches
== 0) && !(crd
.flags
& RM_FLAG_FORCE
))
2279 ret
= para_printf(&crd
.pb
, "no matches -- nothing removed\n");
2280 else if (crd
.flags
& RM_FLAG_VERBOSE
) {
2281 ret
= para_printf(&crd
.pb
, "removed %u files\n",
2284 if (ret
>= 0 && crd
.pb
.offset
)
2285 pass_buffer_as_shm(fd
, SBD_OUTPUT
, crd
.pb
.buf
, crd
.pb
.offset
);
2289 /* TODO options: -r (recursive) */
2290 int com_rm(struct command_context
*cc
)
2293 struct osl_object query
= {.data
= &flags
, .size
= sizeof(flags
)};
2296 for (i
= 1; i
< cc
->argc
; i
++) {
2297 const char *arg
= cc
->argv
[i
];
2300 if (!strcmp(arg
, "--")) {
2304 if (!strcmp(arg
, "-f")) {
2305 flags
|= RM_FLAG_FORCE
;
2308 if (!strcmp(arg
, "-p")) {
2309 flags
|= RM_FLAG_FNM_PATHNAME
;
2312 if (!strcmp(arg
, "-v")) {
2313 flags
|= RM_FLAG_VERBOSE
;
2319 return -E_AFT_SYNTAX
;
2320 ret
= send_option_arg_callback_request(&query
, cc
->argc
- i
,
2321 cc
->argv
+ i
, com_rm_callback
, afs_cb_result_handler
, cc
);
2323 send_strerror(cc
, -ret
);
2328 * Flags used by the cpsi command.
2333 /** Whether the lyrics id should be copied. */
2334 CPSI_FLAG_COPY_LYRICS_ID
= 1,
2335 /** Whether the image id should be copied. */
2336 CPSI_FLAG_COPY_IMAGE_ID
= 2,
2337 /** Whether the lastplayed time should be copied. */
2338 CPSI_FLAG_COPY_LASTPLAYED
= 4,
2339 /** Whether the numplayed count should be copied. */
2340 CPSI_FLAG_COPY_NUMPLAYED
= 8,
2341 /** Whether the attributes should be copied. */
2342 CPSI_FLAG_COPY_ATTRIBUTES
= 16,
2343 /** Activates verbose mode. */
2344 CPSI_FLAG_VERBOSE
= 32,
2347 /** Data passed to the action handler of com_cpsi(). */
2348 struct cpsi_action_data
{
2349 /** command line flags (see \ref cpsi_flags). */
2351 /** Message buffer. */
2352 struct para_buffer pb
;
2353 /** Values are copied from here. */
2354 struct afs_info source_afsi
;
2357 static int copy_selector_info(__a_unused
struct osl_table
*table
,
2358 struct osl_row
*row
, const char *name
, void *data
)
2360 struct cpsi_action_data
*cad
= data
;
2361 struct osl_object target_afsi_obj
;
2363 struct afs_info old_afsi
, target_afsi
;
2364 struct afsi_change_event_data aced
;
2366 ret
= get_afsi_object_of_row(row
, &target_afsi_obj
);
2369 load_afsi(&target_afsi
, &target_afsi_obj
);
2370 old_afsi
= target_afsi
;
2371 if (cad
->flags
& CPSI_FLAG_COPY_LYRICS_ID
)
2372 target_afsi
.lyrics_id
= cad
->source_afsi
.lyrics_id
;
2373 if (cad
->flags
& CPSI_FLAG_COPY_IMAGE_ID
)
2374 target_afsi
.image_id
= cad
->source_afsi
.image_id
;
2375 if (cad
->flags
& CPSI_FLAG_COPY_LASTPLAYED
)
2376 target_afsi
.last_played
= cad
->source_afsi
.last_played
;
2377 if (cad
->flags
& CPSI_FLAG_COPY_NUMPLAYED
)
2378 target_afsi
.num_played
= cad
->source_afsi
.num_played
;
2379 if (cad
->flags
& CPSI_FLAG_COPY_ATTRIBUTES
)
2380 target_afsi
.attributes
= cad
->source_afsi
.attributes
;
2381 save_afsi(&target_afsi
, &target_afsi_obj
); /* in-place update */
2382 if (cad
->flags
& CPSI_FLAG_VERBOSE
) {
2383 ret
= para_printf(&cad
->pb
, "copied afsi to %s\n", name
);
2388 aced
.old_afsi
= &old_afsi
;
2389 afs_event(AFSI_CHANGE
, &cad
->pb
, &aced
);
2393 static void com_cpsi_callback(int fd
, const struct osl_object
*query
)
2395 struct cpsi_action_data cad
= {
2396 .flags
= *(unsigned *)query
->data
,
2398 .max_size
= shm_get_shmmax(),
2399 .private_data
= &fd
,
2400 .max_size_handler
= afs_max_size_handler
2404 char *source_path
= (char *)query
->data
+ sizeof(cad
.flags
);
2405 struct pattern_match_data pmd
= {
2406 .table
= audio_file_table
,
2407 .loop_col_num
= AFTCOL_HASH
,
2408 .match_col_num
= AFTCOL_PATH
,
2409 .patterns
= {.data
= source_path
+ strlen(source_path
) + 1,
2410 .size
= query
->size
- sizeof(cad
.flags
)
2411 - strlen(source_path
) - 1},
2413 .action
= copy_selector_info
2416 ret
= get_afsi_of_path(source_path
, &cad
.source_afsi
);
2419 ret
= for_each_matching_row(&pmd
);
2422 para_printf(&cad
.pb
, "%s\n", para_strerror(-ret
));
2423 else if (pmd
.num_matches
> 0) {
2424 if (cad
.flags
& CPSI_FLAG_VERBOSE
)
2425 para_printf(&cad
.pb
, "copied requested afsi from %s "
2426 "to %u files\n", source_path
, pmd
.num_matches
);
2428 para_printf(&cad
.pb
, "no matches - nothing copied\n");
2430 pass_buffer_as_shm(fd
, SBD_OUTPUT
, cad
.pb
.buf
, cad
.pb
.offset
);
2434 int com_cpsi(struct command_context
*cc
)
2438 struct osl_object options
= {.data
= &flags
, .size
= sizeof(flags
)};
2440 for (i
= 1; i
< cc
->argc
; i
++) {
2441 const char *arg
= cc
->argv
[i
];
2444 if (!strcmp(arg
, "--")) {
2448 if (!strcmp(arg
, "-y")) {
2449 flags
|= CPSI_FLAG_COPY_LYRICS_ID
;
2452 if (!strcmp(arg
, "-i")) {
2453 flags
|= CPSI_FLAG_COPY_IMAGE_ID
;
2456 if (!strcmp(arg
, "-l")) {
2457 flags
|= CPSI_FLAG_COPY_LASTPLAYED
;
2460 if (!strcmp(arg
, "-n")) {
2461 flags
|= CPSI_FLAG_COPY_NUMPLAYED
;
2464 if (!strcmp(arg
, "-a")) {
2465 flags
|= CPSI_FLAG_COPY_ATTRIBUTES
;
2468 if (!strcmp(arg
, "-v")) {
2469 flags
|= CPSI_FLAG_VERBOSE
;
2474 if (i
+ 1 >= cc
->argc
) /* need at least source file and pattern */
2475 return -E_AFT_SYNTAX
;
2476 if (!(flags
& ~CPSI_FLAG_VERBOSE
)) /* no copy flags given */
2477 flags
= ~(unsigned)CPSI_FLAG_VERBOSE
| flags
;
2478 ret
= send_option_arg_callback_request(&options
, cc
->argc
- i
,
2479 cc
->argv
+ i
, com_cpsi_callback
, afs_cb_result_handler
, cc
);
2481 send_strerror(cc
, -ret
);
2485 struct change_atts_data
{
2486 uint64_t add_mask
, del_mask
;
2487 struct para_buffer pb
;
2490 static int change_atts(__a_unused
struct osl_table
*table
,
2491 struct osl_row
*row
, __a_unused
const char *name
, void *data
)
2494 struct osl_object obj
;
2495 struct afs_info old_afsi
, new_afsi
;
2496 struct afsi_change_event_data aced
= {
2498 .old_afsi
= &old_afsi
2500 struct change_atts_data
*cad
= data
;
2502 ret
= get_afsi_object_of_row(row
, &obj
);
2505 ret
= load_afsi(&old_afsi
, &obj
);
2508 new_afsi
= old_afsi
;
2509 new_afsi
.attributes
|= cad
->add_mask
;
2510 new_afsi
.attributes
&= ~cad
->del_mask
;
2511 save_afsi(&new_afsi
, &obj
); /* in-place update */
2512 afs_event(AFSI_CHANGE
, &cad
->pb
, &aced
);
2516 static void com_setatt_callback(int fd
, const struct osl_object
*query
)
2521 struct change_atts_data cad
= {
2523 .max_size
= shm_get_shmmax(),
2524 .max_size_handler
= afs_max_size_handler
,
2525 .private_data
= &(struct afs_max_size_handler_data
) {
2531 struct pattern_match_data pmd
= {
2532 .table
= audio_file_table
,
2533 .loop_col_num
= AFTCOL_HASH
,
2534 .match_col_num
= AFTCOL_PATH
,
2535 .pm_flags
= PM_SKIP_EMPTY_NAME
,
2537 .action
= change_atts
2540 for (p
= query
->data
; p
< (char *)query
->data
+ query
->size
; p
+= len
+ 1) {
2542 unsigned char bitnum
;
2545 ret
= -E_ATTR_SYNTAX
;
2549 if (c
!= '+' && c
!= '-')
2552 ret
= get_attribute_bitnum_by_name(p
, &bitnum
);
2556 cad
.add_mask
|= (1UL << bitnum
);
2558 cad
.del_mask
|= (1UL << bitnum
);
2560 ret
= -E_ATTR_SYNTAX
;
2561 if (!cad
.add_mask
&& !cad
.del_mask
)
2563 pmd
.patterns
.data
= p
;
2564 assert(p
< (char *)query
->data
+ query
->size
);
2565 pmd
.patterns
.size
= (char *)query
->data
+ query
->size
- p
;
2566 ret
= for_each_matching_row(&pmd
);
2569 if (pmd
.num_matches
== 0)
2570 para_printf(&cad
.pb
, "no matches\n");
2573 para_printf(&cad
.pb
, "%s\n", para_strerror(-ret
));
2575 pass_buffer_as_shm(fd
, SBD_OUTPUT
, cad
.pb
.buf
, cad
.pb
.offset
);
2579 int com_setatt(struct command_context
*cc
)
2582 return -E_ATTR_SYNTAX
;
2583 return send_standard_callback_request(cc
->argc
- 1, cc
->argv
+ 1,
2584 com_setatt_callback
, afs_cb_result_handler
, cc
);
2587 static void afs_stat_callback(int fd
, const struct osl_object
*query
)
2589 int *parser_friendly
= query
->data
;
2590 char *buf
= *parser_friendly
?
2591 parser_friendly_status_items
: status_items
;
2595 pass_buffer_as_shm(fd
, SBD_OUTPUT
, buf
, strlen(buf
));
2599 * Get the current afs status items from the afs process and send it.
2601 * \param cc The command context, used e.g. for data encryption.
2602 * \param parser_friendly Whether parser-friendly output format should be used.
2604 * As the contents of the afs status items change in time and the command
2605 * handler only has a COW version created at fork time, it can not send
2606 * up-to-date afs status items directly. Therefore the usual callback mechanism
2607 * is used to pass the status items from the afs process to the command handler
2608 * via a shared memory area and a pipe.
2610 * \return The return value of the underlying call to \ref send_callback_request().
2612 int send_afs_status(struct command_context
*cc
, int parser_friendly
)
2614 struct osl_object query
= {.data
= &parser_friendly
,
2615 .size
= sizeof(parser_friendly
)};
2617 return send_callback_request(afs_stat_callback
, &query
,
2618 afs_cb_result_handler
, cc
);
2621 /* TODO: optionally fix problems by removing offending rows */
2622 static int check_audio_file(struct osl_row
*row
, void *data
)
2625 struct para_buffer
*pb
= data
;
2626 struct stat statbuf
;
2627 int ret
= get_audio_file_path_of_row(row
, &path
);
2628 struct afs_info afsi
;
2632 return para_printf(pb
, "%s\n", para_strerror(-ret
));
2633 if (stat(path
, &statbuf
) < 0) {
2634 ret
= para_printf(pb
, "%s: stat error (%s)\n", path
, strerror(errno
));
2638 if (!S_ISREG(statbuf
.st_mode
)) {
2639 ret
= para_printf(pb
, "%s: not a regular file\n", path
);
2644 ret
= get_afsi_of_row(row
, &afsi
);
2646 return para_printf(pb
, "%s: %s\n", path
, para_strerror(-ret
));
2647 ret
= lyr_get_name_by_id(afsi
.lyrics_id
, &blob_name
);
2649 ret
= para_printf(pb
, "%s lyrics id %u: %s\n", path
, afsi
.lyrics_id
,
2650 para_strerror(-ret
));
2654 ret
= img_get_name_by_id(afsi
.image_id
, &blob_name
);
2656 ret
= para_printf(pb
, "%s image id %u: %s\n", path
, afsi
.image_id
,
2657 para_strerror(-ret
));
2662 * Check the audio file table for inconsistencies.
2664 * \param fd The afs socket.
2665 * \param query Unused.
2667 * This function always succeeds.
2671 void aft_check_callback(int fd
, __a_unused
const struct osl_object
*query
)
2673 struct para_buffer pb
= {
2674 .max_size
= shm_get_shmmax(),
2675 .private_data
= &(struct afs_max_size_handler_data
) {
2679 .max_size_handler
= afs_max_size_handler
2681 int ret
= para_printf(&pb
, "checking audio file table...\n");
2685 audio_file_loop(&pb
, check_audio_file
);
2687 pass_buffer_as_shm(fd
, SBD_OUTPUT
, pb
.buf
, pb
.offset
);
2692 * Close the audio file table.
2694 * \param flags Usual flags that are passed to osl_close_table().
2696 * \sa osl_close_table().
2698 static void aft_close(void)
2700 osl_close_table(audio_file_table
, OSL_MARK_CLEAN
);
2701 audio_file_table
= NULL
;
2705 * Open the audio file table.
2707 * \param dir The database directory.
2711 * \sa osl_open_table().
2713 static int aft_open(const char *dir
)
2717 audio_file_table_desc
.dir
= dir
;
2718 ret
= osl(osl_open_table(&audio_file_table_desc
, &audio_file_table
));
2721 osl_get_num_rows(audio_file_table
, &num
);
2722 PARA_INFO_LOG("audio file table contains %d files\n", num
);
2725 PARA_INFO_LOG("failed to open audio file table\n");
2726 audio_file_table
= NULL
;
2727 if (ret
>= 0 || ret
== -OSL_ERRNO_TO_PARA_ERROR(E_OSL_NOENT
))
2732 static int aft_create(const char *dir
)
2734 audio_file_table_desc
.dir
= dir
;
2735 return osl(osl_create_table(&audio_file_table_desc
));
2738 static int clear_attribute(struct osl_row
*row
, void *data
)
2740 struct rmatt_event_data
*red
= data
;
2741 struct afs_info afsi
;
2742 struct osl_object obj
;
2743 int ret
= get_afsi_object_of_row(row
, &obj
);
2744 uint64_t mask
= ~(1ULL << red
->bitnum
);
2748 ret
= load_afsi(&afsi
, &obj
);
2751 afsi
.attributes
&= mask
;
2752 save_afsi(&afsi
, &obj
);
2756 static int aft_event_handler(enum afs_events event
, struct para_buffer
*pb
,
2762 case ATTRIBUTE_REMOVE
: {
2763 const struct rmatt_event_data
*red
= data
;
2764 ret
= para_printf(pb
, "clearing attribute %s (bit %u) from all "
2765 "entries in the audio file table\n", red
->name
,
2769 return audio_file_loop(data
, clear_attribute
);
2777 * Initialize the audio file table.
2779 * \param t Pointer to the structure to be initialized.
2781 void aft_init(struct afs_table
*t
)
2784 t
->close
= aft_close
;
2785 t
->create
= aft_create
;
2786 t
->event_handler
= aft_event_handler
;