1 /* Copyright (C) 2007 Andre Noll <maan@tuebingen.mpg.de>, see file COPYING. */
3 /** \file aft.c Audio file table functions. */
12 #include "server_cmd.lsg.h"
21 #include "portable_io.h"
25 /* Data about one audio file. Needed for ls and stat output. */
27 /* Usual audio format handler information. */
29 /* Audio file selector information. */
31 /* The full path of the audio file. */
33 /* The score value (if -a was given). */
35 /* The hash value of the audio file data. */
40 * The internal state of the audio file table is described by the following
41 * variables which are private to aft.c.
43 static struct osl_table
*audio_file_table
; /* NULL if table not open */
44 static struct osl_row
*current_aft_row
; /* NULL if no audio file open */
45 static unsigned char current_hash
[HASH_SIZE
]; /* only used on sighup */
47 static char *status_items
;
48 static char *parser_friendly_status_items
;
49 static struct ls_data status_item_ls_data
;
51 /** The different sorting methods of the ls command. */
52 enum ls_sorting_method
{
53 LS_SORT_BY_PATH
, /**< -s=p (default) */
54 LS_SORT_BY_SCORE
, /**< -s=s */
55 LS_SORT_BY_LAST_PLAYED
, /**< -s=l */
56 LS_SORT_BY_NUM_PLAYED
, /**< -s=n */
57 LS_SORT_BY_FREQUENCY
, /**< -s=f */
58 LS_SORT_BY_CHANNELS
, /**< -s=c */
59 LS_SORT_BY_IMAGE_ID
, /**< -s=i */
60 LS_SORT_BY_LYRICS_ID
, /**< -s=y */
61 LS_SORT_BY_BITRATE
, /**< -s=b */
62 LS_SORT_BY_DURATION
, /**< -s=d */
63 LS_SORT_BY_AUDIO_FORMAT
, /**< -s=a */
64 LS_SORT_BY_HASH
, /**< -s=h */
67 /** The different listing modes of the ls command. */
68 enum ls_listing_mode
{
69 LS_MODE_SHORT
, /**< Default listing mode. */
70 LS_MODE_LONG
, /**< -l or -l=l */
71 LS_MODE_VERBOSE
, /** -l=v */
72 LS_MODE_MBOX
, /** -l=m */
73 LS_MODE_CHUNKS
, /** -l=c */
74 LS_MODE_PARSER
, /** -l=p */
78 * The size of the individual output fields of the ls command.
80 * These depend on the content being listed. For example, if each listed file
81 * is shorter than an hour, the duration format is set to mm:ss. Otherwise it
85 /** size of the score field. */
86 unsigned short score_width
;
87 /** size of the image id field. */
88 unsigned short image_id_width
;
89 /** size of the lyrics id field. */
90 unsigned short lyrics_id_width
;
91 /** size of the bitrate field. */
92 unsigned short bitrate_width
;
93 /** size of the frequency field. */
94 unsigned short frequency_width
;
95 /** size of the duration field. */
96 unsigned short duration_width
;
97 /** size of the num played field. */
98 unsigned short num_played_width
;
99 /** size of the amp field. */
100 unsigned short amp_width
;
101 /** size of the audio format field. */
102 unsigned short audio_format_width
;
105 /** Data passed from the ls command handler to its callback function. */
107 struct lls_parse_result
*lpr
;
108 /* Derived from lpr */
109 enum ls_sorting_method sorting
;
110 /* Derived from lpr */
111 enum ls_listing_mode mode
;
112 /** Used for long listing mode to align the output fields. */
113 struct ls_widths widths
;
114 /** Size of the \a data array. */
116 /** Number of used entries in the data array. */
117 uint32_t num_matching_paths
;
118 /** Array of matching entries. */
119 struct ls_data
*data
;
120 /** Used to sort the array. */
121 struct ls_data
**data_ptr
;
125 * Describes the layout of the mmapped-afs info struct.
127 * \sa struct \ref afs_info.
130 /** Where .last_played is stored. */
131 AFSI_LAST_PLAYED_OFFSET
= 0,
132 /** Storage position of the attributes bitmap. */
133 AFSI_ATTRIBUTES_OFFSET
= 8,
134 /** Storage position of the .num_played field. */
135 AFSI_NUM_PLAYED_OFFSET
= 16,
136 /** Storage position of the .image_id field. */
137 AFSI_IMAGE_ID_OFFSET
= 20,
138 /** Storage position of the .lyrics_id field. */
139 AFSI_LYRICS_ID_OFFSET
= 24,
140 /** Storage position of the .audio_format_id field. */
141 AFSI_AUDIO_FORMAT_ID_OFFSET
= 28,
142 /** Storage position of the amplification field. */
143 AFSI_AMP_OFFSET
= 29,
144 /** 2 bytes reserved space for future usage. */
145 AFSI_AUDIO_FORMAT_UNUSED_OFFSET
= 30,
146 /** On-disk storage space needed. */
151 * Convert a struct afs_info to an osl object.
153 * \param afsi Pointer to the audio file info to be converted.
154 * \param obj Result pointer.
156 * \sa \ref load_afsi().
158 static void save_afsi(struct afs_info
*afsi
, struct osl_object
*obj
)
160 char *buf
= obj
->data
;
162 write_u64(buf
+ AFSI_LAST_PLAYED_OFFSET
, afsi
->last_played
);
163 write_u64(buf
+ AFSI_ATTRIBUTES_OFFSET
, afsi
->attributes
);
164 write_u32(buf
+ AFSI_NUM_PLAYED_OFFSET
, afsi
->num_played
);
165 write_u32(buf
+ AFSI_IMAGE_ID_OFFSET
, afsi
->image_id
);
166 write_u32(buf
+ AFSI_LYRICS_ID_OFFSET
, afsi
->lyrics_id
);
167 write_u8(buf
+ AFSI_AUDIO_FORMAT_ID_OFFSET
,
168 afsi
->audio_format_id
);
169 write_u8(buf
+ AFSI_AMP_OFFSET
, afsi
->amp
);
170 memset(buf
+ AFSI_AUDIO_FORMAT_UNUSED_OFFSET
, 0, 2);
174 * Get the audio file selector info struct stored in an osl object.
176 * \param afsi Points to the audio_file info structure to be filled in.
177 * \param obj The osl object holding the data.
181 * \sa \ref save_afsi().
183 static int load_afsi(struct afs_info
*afsi
, struct osl_object
*obj
)
185 char *buf
= obj
->data
;
186 if (obj
->size
< AFSI_SIZE
)
188 afsi
->last_played
= read_u64(buf
+ AFSI_LAST_PLAYED_OFFSET
);
189 afsi
->attributes
= read_u64(buf
+ AFSI_ATTRIBUTES_OFFSET
);
190 afsi
->num_played
= read_u32(buf
+ AFSI_NUM_PLAYED_OFFSET
);
191 afsi
->image_id
= read_u32(buf
+ AFSI_IMAGE_ID_OFFSET
);
192 afsi
->lyrics_id
= read_u32(buf
+ AFSI_LYRICS_ID_OFFSET
);
193 afsi
->audio_format_id
= read_u8(buf
+
194 AFSI_AUDIO_FORMAT_ID_OFFSET
);
195 afsi
->amp
= read_u8(buf
+ AFSI_AMP_OFFSET
);
199 /** The columns of the audio file table. */
200 enum audio_file_table_columns
{
201 /** The hash on the content of the audio file. */
203 /** The full path in the filesystem. */
205 /** The audio file selector info. */
207 /** The audio format handler info. */
209 /** The chunk table info and the chunk table of the audio file. */
211 /** The number of columns of this table. */
215 /* compare function for the hash column */
216 static int aft_hash_compare(const struct osl_object
*obj1
,
217 const struct osl_object
*obj2
)
219 return hash_compare((unsigned char *)obj1
->data
,
220 (unsigned char *)obj2
->data
);
223 static struct osl_column_description aft_cols
[] = {
225 .storage_type
= OSL_MAPPED_STORAGE
,
226 .storage_flags
= OSL_RBTREE
| OSL_FIXED_SIZE
| OSL_UNIQUE
,
228 .compare_function
= aft_hash_compare
,
229 .data_size
= HASH_SIZE
232 .storage_type
= OSL_MAPPED_STORAGE
,
233 .storage_flags
= OSL_RBTREE
| OSL_UNIQUE
,
235 .compare_function
= string_compare
,
238 .storage_type
= OSL_MAPPED_STORAGE
,
239 .storage_flags
= OSL_FIXED_SIZE
,
241 .data_size
= AFSI_SIZE
244 .storage_type
= OSL_MAPPED_STORAGE
,
248 .storage_type
= OSL_DISK_STORAGE
,
253 static struct osl_table_description audio_file_table_desc
= {
254 .name
= "audio_files",
255 .num_columns
= NUM_AFT_COLUMNS
,
256 .flags
= OSL_LARGE_TABLE
,
257 .column_descriptions
= aft_cols
261 * Produce a canonicalized absolute pathname.
263 * Returns one if the resolved path a directory, zero if it is a regular file,
264 * negative on errors.
266 static int verify_path(const char *orig_path
, char **resolved_path
)
272 if (*orig_path
!= '/') /* we only accept absolute paths */
274 path
= realpath(orig_path
, NULL
);
277 if (stat(path
, &statbuf
) < 0)
279 if (S_ISREG(statbuf
.st_mode
))
281 else if (S_ISDIR(statbuf
.st_mode
))
285 *resolved_path
= path
;
288 *resolved_path
= NULL
;
293 /** The on-disk layout of a afhi struct. */
295 /** Where the number of seconds is stored. */
296 AFHI_SECONDS_TOTAL_OFFSET
= 0,
297 /** Position of the bitrate. */
298 AFHI_BITRATE_OFFSET
= 4,
299 /** Position of the frequency. */
300 AFHI_FREQUENCY_OFFSET
= 8,
301 /** Was: Location of the audio file header. */
302 AFHI_UNUSED1_OFFSET
= 12,
303 /* Length of the audio file header. Zero means: No header. */
304 AFHI_HEADER_LEN_OFFSET
= 16,
305 /** The total number of chunks (4 bytes). */
306 CHUNKS_TOTAL_OFFSET
= 20,
307 /** The length of the audio file header (4 bytes). */
308 HEADER_LEN_OFFSET
= 24,
309 /** Size of the largest chunk in bytes. (4 bytes). */
310 AFHI_MAX_CHUNK_SIZE_OFFSET
= 28,
311 /** The seconds part of the chunk time (4 bytes). */
312 CHUNK_TV_TV_SEC_OFFSET
= 32,
313 /** The microseconds part of the chunk time (4 bytes). */
314 CHUNK_TV_TV_USEC_OFFSET
= 36,
315 /** Number of channels is stored here. (1 byte) */
316 AFHI_CHANNELS_OFFSET
= 40,
317 /** The tag info position. */
318 AFHI_INFO_STRING_OFFSET
= 41,
319 /** Minimal on-disk size of a valid afhi struct. */
320 MIN_AFHI_SIZE
= 47, /* at least 6 null bytes for techinfo/tags */
323 static unsigned sizeof_afhi_buf(const struct afh_info
*afhi
)
328 + strlen(afhi
->techinfo
)
329 + strlen(afhi
->tags
.artist
)
330 + strlen(afhi
->tags
.title
)
331 + strlen(afhi
->tags
.year
)
332 + strlen(afhi
->tags
.album
)
333 + strlen(afhi
->tags
.comment
);
336 static void save_afhi(struct afh_info
*afhi
, char *buf
)
342 write_u32(buf
+ AFHI_SECONDS_TOTAL_OFFSET
, afhi
->seconds_total
);
343 write_u32(buf
+ AFHI_BITRATE_OFFSET
, afhi
->bitrate
);
344 write_u32(buf
+ AFHI_FREQUENCY_OFFSET
, afhi
->frequency
);
345 write_u32(buf
+ AFHI_UNUSED1_OFFSET
, 0);
346 write_u32(buf
+ AFHI_HEADER_LEN_OFFSET
, afhi
->header_len
);
347 write_u8(buf
+ AFHI_CHANNELS_OFFSET
, afhi
->channels
);
348 write_u32(buf
+ CHUNKS_TOTAL_OFFSET
, afhi
->chunks_total
);
349 write_u32(buf
+ HEADER_LEN_OFFSET
, afhi
->header_len
);
350 write_u32(buf
+ AFHI_MAX_CHUNK_SIZE_OFFSET
, afhi
->max_chunk_size
);
351 write_u32(buf
+ CHUNK_TV_TV_SEC_OFFSET
, afhi
->chunk_tv
.tv_sec
);
352 write_u32(buf
+ CHUNK_TV_TV_USEC_OFFSET
, afhi
->chunk_tv
.tv_usec
);
353 p
= buf
+ AFHI_INFO_STRING_OFFSET
;
355 * The below sprintf(3) calls are OK because our caller already made
356 * sure that buf is large enough.
358 p
+= sprintf(p
, "%s", afhi
->techinfo
) + 1;
359 p
+= sprintf(p
, "%s", afhi
->tags
.artist
) + 1;
360 p
+= sprintf(p
, "%s", afhi
->tags
.title
) + 1;
361 p
+= sprintf(p
, "%s", afhi
->tags
.year
) + 1;
362 p
+= sprintf(p
, "%s", afhi
->tags
.album
) + 1;
363 sprintf(p
, "%s", afhi
->tags
.comment
);
366 /* does not load the chunk table */
367 static void load_afhi(const char *buf
, struct afh_info
*afhi
)
369 afhi
->seconds_total
= read_u32(buf
+ AFHI_SECONDS_TOTAL_OFFSET
);
370 afhi
->bitrate
= read_u32(buf
+ AFHI_BITRATE_OFFSET
);
371 afhi
->frequency
= read_u32(buf
+ AFHI_FREQUENCY_OFFSET
);
372 afhi
->header_len
= read_u32(buf
+ AFHI_HEADER_LEN_OFFSET
);
373 afhi
->channels
= read_u8(buf
+ AFHI_CHANNELS_OFFSET
);
374 afhi
->chunks_total
= read_u32(buf
+ CHUNKS_TOTAL_OFFSET
);
375 afhi
->header_len
= read_u32(buf
+ HEADER_LEN_OFFSET
);
376 afhi
->max_chunk_size
= read_u32(buf
+ AFHI_MAX_CHUNK_SIZE_OFFSET
);
377 afhi
->chunk_tv
.tv_sec
= read_u32(buf
+ CHUNK_TV_TV_SEC_OFFSET
);
378 afhi
->chunk_tv
.tv_usec
= read_u32(buf
+ CHUNK_TV_TV_USEC_OFFSET
);
379 afhi
->techinfo
= (char *)buf
+ AFHI_INFO_STRING_OFFSET
;
380 afhi
->tags
.artist
= afhi
->techinfo
+ strlen(afhi
->techinfo
) + 1;
381 afhi
->tags
.title
= afhi
->tags
.artist
+ strlen(afhi
->tags
.artist
) + 1;
382 afhi
->tags
.year
= afhi
->tags
.title
+ strlen(afhi
->tags
.title
) + 1;
383 afhi
->tags
.album
= afhi
->tags
.year
+ strlen(afhi
->tags
.year
) + 1;
384 afhi
->tags
.comment
= afhi
->tags
.album
+ strlen(afhi
->tags
.album
) + 1;
387 /* Only used for saving the chunk table, but not for loading. */
388 static unsigned sizeof_chunk_table(struct afh_info
*afhi
)
390 if (!afhi
|| !afhi
->chunk_table
)
392 return 4 * (afhi
->chunks_total
+ 1);
395 static void save_chunk_table(struct afh_info
*afhi
, char *buf
)
399 if (!afhi
->chunk_table
|| afhi
->chunks_total
== 0)
401 for (n
= 0; n
<= afhi
->chunks_total
; n
++)
402 write_u32(buf
+ 4 * n
, afhi
->chunk_table
[n
]);
405 static void load_chunk_table(struct afh_info
*afhi
, const struct osl_object
*ct
)
410 if (!ct
->data
|| ct
->size
< 4) {
411 afhi
->chunk_table
= NULL
;
414 sz
= PARA_MIN(((size_t)afhi
->chunks_total
+ 1) * 4, ct
->size
) + 1;
415 afhi
->chunk_table
= para_malloc(sz
);
416 for (i
= 0; i
<= afhi
->chunks_total
&& i
* 4 + 3 < ct
->size
; i
++)
417 afhi
->chunk_table
[i
] = read_u32(ct
->data
+ 4 * i
);
421 * Get the row of the audio file table corresponding to the given path.
423 * \param path The full path of the audio file.
424 * \param row Result pointer.
428 int aft_get_row_of_path(const char *path
, struct osl_row
**row
)
430 struct osl_object obj
= {.data
= (char *)path
, .size
= strlen(path
) + 1};
432 return osl(osl_get_row(audio_file_table
, AFTCOL_PATH
, &obj
, row
));
436 * Get the row of the audio file table corresponding to the given hash value.
438 * \param hash The hash value of the desired audio file.
439 * \param row Result pointer.
443 static int aft_get_row_of_hash(unsigned char *hash
, struct osl_row
**row
)
445 const struct osl_object obj
= {.data
= hash
, .size
= HASH_SIZE
};
446 return osl(osl_get_row(audio_file_table
, AFTCOL_HASH
, &obj
, row
));
450 * Get the audio file selector info object of a row.
452 * \param row Pointer to a row in the audio file table.
453 * \param obj Result pointer.
457 static int get_afsi_object_of_row(const struct osl_row
*row
,
458 struct osl_object
*obj
)
460 return osl(osl_get_object(audio_file_table
, row
, AFTCOL_AFSI
, obj
));
464 * Get the osl object holding the audio file selector info, given a path.
467 * \param path The full path of the audio file.
468 * \param obj Result pointer.
470 * \return Positive on success, negative on errors.
472 static int get_afsi_object_of_path(const char *path
, struct osl_object
*obj
)
475 int ret
= aft_get_row_of_path(path
, &row
);
478 return get_afsi_object_of_row(row
, obj
);
482 * Get the audio file selector info, given a row of the audio file table.
484 * \param row Pointer to a row in the audio file table.
485 * \param afsi Result pointer.
487 * \return Positive on success, negative on errors.
489 int get_afsi_of_row(const struct osl_row
*row
, struct afs_info
*afsi
)
491 struct osl_object obj
;
492 int ret
= get_afsi_object_of_row(row
, &obj
);
495 return load_afsi(afsi
, &obj
);
499 * Get the audio file selector info, given the path of an audio table.
501 * \param path The full path of the audio file.
502 * \param afsi Result pointer.
506 static int get_afsi_of_path(const char *path
, struct afs_info
*afsi
)
508 struct osl_object obj
;
509 int ret
= get_afsi_object_of_path(path
, &obj
);
512 return load_afsi(afsi
, &obj
);
516 * Get the path of an audio file, given a row of the audio file table.
518 * \param row Pointer to a row in the audio file table.
519 * \param path Result pointer.
521 * The result is a pointer to memory-mapped data. The caller must not attempt
526 int get_audio_file_path_of_row(const struct osl_row
*row
, char **path
)
528 struct osl_object path_obj
;
529 int ret
= osl(osl_get_object(audio_file_table
, row
, AFTCOL_PATH
,
535 *path
= path_obj
.data
;
540 * Get the object containing the hash value of an audio file, given a row.
542 * \param row Pointer to a row of the audio file table.
543 * \param obj Result pointer.
545 * \return The return value of the underlying call to osl_get_object().
547 * \sa \ref get_hash_of_row().
549 static int get_hash_object_of_aft_row(const struct osl_row
*row
,
550 struct osl_object
*obj
)
552 return osl(osl_get_object(audio_file_table
, row
, AFTCOL_HASH
, obj
));
556 * Get the hash value of an audio file, given a row of the audio file table.
558 * \param row Pointer to a row of the audio file table.
559 * \param hash Result pointer.
561 * \a hash points to mapped data and must not be freed by the caller.
563 * \return The return value of the underlying call to
564 * get_hash_object_of_aft_row().
566 static int get_hash_of_row(const struct osl_row
*row
, unsigned char **hash
)
568 struct osl_object obj
;
569 int ret
= get_hash_object_of_aft_row(row
, &obj
);
578 * Get the audio format handler info, given a row of the audio file table.
580 * \param row Pointer to a row of the audio file table.
581 * \param afhi Result pointer.
583 * \return The return value of the underlying call to osl_get_object().
585 * After the call the members of the afhi structure point to mapped memory
586 * which is owned by the osl table, Hence the caller must not attempt to free
587 * this memory by calling \ref clear_afhi().
589 int get_afhi_of_row(const struct osl_row
*row
, struct afh_info
*afhi
)
591 struct osl_object obj
;
592 int ret
= osl(osl_get_object(audio_file_table
, row
, AFTCOL_AFHI
,
596 load_afhi(obj
.data
, afhi
);
600 /* returns shmid on success */
601 static int save_afd(struct audio_file_data
*afd
)
603 size_t size
= sizeof(*afd
) + sizeof_chunk_table(&afd
->afhi
);
604 int shmid
, ret
= shm_new(size
);
611 ret
= shm_attach(shmid
, ATTACH_RW
, &shm_afd
);
616 save_chunk_table(&afd
->afhi
, buf
);
617 if (afd
->afhi
.max_chunk_size
== 0) { /* v0.5.x on-disk afhi */
618 set_max_chunk_size(&afd
->afhi
);
619 PARA_NOTICE_LOG("max chunk size unset, re-add required\n");
621 PARA_INFO_LOG("using max chunk size from afhi\n");
622 afd
->max_chunk_size
= afd
->afhi
.max_chunk_size
;
623 *(struct audio_file_data
*)shm_afd
= *afd
;
632 * Extract a afd stored in a shared memory area.
634 * Attach the shared memory area given by \a shmid, load the audio file data
635 * stored therein and detach the area afterwards. Called by vss, after
636 * receiving a positive response to the request for the next audio file.
638 * \param shmid The identifier of the shared memory area containing the afd.
639 * \param afd Result pointer.
643 int load_afd(int shmid
, struct audio_file_data
*afd
)
647 struct osl_object obj
;
649 ret
= shm_attach(shmid
, ATTACH_RO
, &shm_afd
);
652 ret
= shm_size(shmid
, &obj
.size
);
655 *afd
= *(struct audio_file_data
*)shm_afd
;
656 obj
.data
= shm_afd
+ sizeof(*afd
);
657 obj
.size
-= sizeof(*afd
);
658 load_chunk_table(&afd
->afhi
, &obj
);
665 static int get_local_time(uint64_t *seconds
, char *buf
, size_t size
,
666 time_t current_time
, enum ls_listing_mode lm
)
670 * Omit year but show time if the given value is closer to the current
671 * time than this many seconds.
673 const time_t m
= 6 * 30 * 24 * 3600; /* six months */
675 tm
= localtime((time_t *)seconds
);
678 if (lm
== LS_MODE_MBOX
) {
679 if (!strftime(buf
, size
, "%c", tm
))
683 if (*seconds
> current_time
- m
&& *seconds
< current_time
+ m
) {
684 if (!strftime(buf
, size
, "%b %e %k:%M", tm
))
689 * If the given time is more than six month away from the current time,
690 * we print only the year. The additional space character in the format
691 * string below makes the formatted date align nicely with dates that
692 * contain the time (those written by the above strftime() statement).
694 if (!strftime(buf
, size
, "%b %e %Y", tm
))
699 /** Compute the number of (decimal) digits of a number. */
700 #define GET_NUM_DIGITS(x, num) { \
701 typeof((x)) _tmp = PARA_ABS(x); \
704 while ((_tmp) > 9) { \
710 __a_const
static short unsigned get_duration_width(int seconds
)
712 short unsigned width
;
713 unsigned hours
= seconds
/ 3600, mins
= (seconds
% 3600) / 60;
715 if (!hours
) /* less than one hour => m:ss or mm:ss => 4 or 5 digits */
716 return 4 + (mins
> 9);
717 /* more than one hour => h:mm:ss, hh:mm:ss, hhh:mm:ss, ... */
718 GET_NUM_DIGITS(hours
, &width
);
722 static void get_duration_buf(int seconds
, char *buf
, struct ls_options
*opts
)
724 unsigned hours
= seconds
/ 3600, mins
= (seconds
% 3600) / 60;
725 short unsigned max_width
;
727 if (!hours
) { /* m:ss or mm:ss */
728 max_width
= opts
->mode
== LS_MODE_LONG
?
729 opts
->widths
.duration_width
: 4;
730 sprintf(buf
, "%*u:%02d", max_width
- 3, mins
, seconds
% 60);
731 } else { /* more than one hour => h:mm:ss, hh:mm:ss, hhh:mm:ss, ... */
732 max_width
= opts
->mode
== LS_MODE_LONG
?
733 opts
->widths
.duration_width
: 7;
734 sprintf(buf
, "%*u:%02u:%02d", max_width
- 6, hours
, mins
,
739 static int write_attribute_items(struct para_buffer
*b
,
740 const char *att_bitmap
, struct afs_info
*afsi
)
745 WRITE_STATUS_ITEM(b
, SI_attributes_bitmap
, "%s\n", att_bitmap
);
746 ret
= get_attribute_text(&afsi
->attributes
, " ", &att_text
);
749 WRITE_STATUS_ITEM(b
, SI_attributes_txt
, "%s\n", att_text
);
754 static void write_lyrics_items(struct para_buffer
*b
, struct afs_info
*afsi
)
758 WRITE_STATUS_ITEM(b
, SI_lyrics_id
, "%u\n", afsi
->lyrics_id
);
759 lyr_get_name_by_id(afsi
->lyrics_id
, &lyrics_name
);
760 WRITE_STATUS_ITEM(b
, SI_lyrics_name
, "%s\n", lyrics_name
?
761 lyrics_name
: "(none)");
764 static void write_image_items(struct para_buffer
*b
, struct afs_info
*afsi
)
768 WRITE_STATUS_ITEM(b
, SI_image_id
, "%u\n", afsi
->image_id
);
769 img_get_name_by_id(afsi
->image_id
, &image_name
);
770 WRITE_STATUS_ITEM(b
, SI_image_name
, "%s\n", image_name
?
771 image_name
: "(none)");
774 static void write_filename_items(struct para_buffer
*b
, const char *path
,
780 WRITE_STATUS_ITEM(b
, SI_basename
, "%s\n", path
);
783 WRITE_STATUS_ITEM(b
, SI_path
, "%s\n", path
);
784 val
= para_basename(path
);
785 WRITE_STATUS_ITEM(b
, SI_basename
, "%s\n", val
? val
: "");
786 val
= para_dirname(path
);
787 WRITE_STATUS_ITEM(b
, SI_directory
, "%s\n", val
? val
: "");
791 static int print_chunk_table(struct ls_data
*d
, struct para_buffer
*b
)
793 struct osl_object chunk_table_obj
;
794 struct osl_row
*aft_row
;
798 ret
= aft_get_row_of_hash(d
->hash
, &aft_row
);
801 ret
= osl(osl_open_disk_object(audio_file_table
, aft_row
,
802 AFTCOL_CHUNKS
, &chunk_table_obj
));
805 para_printf(b
, "%s\n"
806 "chunk_time: %lu:%lu\nchunk_offsets: ",
808 (long unsigned) d
->afhi
.chunk_tv
.tv_sec
,
809 (long unsigned) d
->afhi
.chunk_tv
.tv_usec
811 buf
= chunk_table_obj
.data
;
814 i
<= d
->afhi
.chunks_total
&& 4 * i
+ 3 < chunk_table_obj
.size
;
817 para_printf(b
, "%u ", (unsigned) read_u32(buf
+ 4 * i
));
818 para_printf(b
, "\n");
820 osl_close_disk_object(&chunk_table_obj
);
824 static int print_list_item(struct ls_data
*d
, struct ls_options
*opts
,
825 struct para_buffer
*b
, time_t current_time
)
827 const struct lls_opt_result
*r_a
= SERVER_CMD_OPT_RESULT(LS
, ADMISSIBLE
, opts
->lpr
);
828 const struct lls_opt_result
*r_b
= SERVER_CMD_OPT_RESULT(LS
, BASENAME
, opts
->lpr
);
829 const struct lls_opt_result
*r_d
= SERVER_CMD_OPT_RESULT(LS
, UNIX_DATE
, opts
->lpr
);
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 (lls_opt_given(r_d
))
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 (lls_opt_given(r_a
))
861 para_printf(b
, "%*li ", opts
->widths
.score_width
,
864 "%s " /* attributes */
866 "%*u " /* image_id */
867 "%*u " /* lyrics_id */
869 "%*s " /* audio format */
870 "%*u " /* frequency */
873 "%*u " /* num_played */
874 "%s " /* last_played */
877 w
->amp_width
, afsi
->amp
,
878 w
->image_id_width
, afsi
->image_id
,
879 w
->lyrics_id_width
, afsi
->lyrics_id
,
880 w
->bitrate_width
, afhi
->bitrate
,
881 w
->audio_format_width
,
882 audio_format_name(afsi
->audio_format_id
),
883 w
->frequency_width
, afhi
->frequency
,
886 w
->num_played_width
, afsi
->num_played
,
893 if (opts
->mode
== LS_MODE_MBOX
) {
894 const char *bn
= para_basename(d
->path
);
896 "From foo@localhost %s\n"
897 "Received: from\nTo: bar\nFrom: a\n"
902 write_filename_items(b
, d
->path
, lls_opt_given(r_b
));
903 if (lls_opt_given(r_a
))
904 WRITE_STATUS_ITEM(b
, SI_score
, "%li\n", d
->score
);
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
, "%" PRIu32
"\n",
919 afhi
->seconds_total
);
920 WRITE_STATUS_ITEM(b
, SI_last_played
, "%s\n", last_played_time
);
921 WRITE_STATUS_ITEM(b
, SI_num_played
, "%u\n", afsi
->num_played
);
922 WRITE_STATUS_ITEM(b
, SI_amplification
, "%u\n", afsi
->amp
);
923 WRITE_STATUS_ITEM(b
, SI_chunk_time
, "%lu\n", tv2ms(&afhi
->chunk_tv
));
924 WRITE_STATUS_ITEM(b
, SI_num_chunks
, "%" PRIu32
"\n",
926 WRITE_STATUS_ITEM(b
, SI_max_chunk_size
, "%" PRIu32
"\n",
927 afhi
->max_chunk_size
);
928 WRITE_STATUS_ITEM(b
, SI_techinfo
, "%s\n", afhi
->techinfo
);
929 WRITE_STATUS_ITEM(b
, SI_artist
, "%s\n", afhi
->tags
.artist
);
930 WRITE_STATUS_ITEM(b
, SI_title
, "%s\n", afhi
->tags
.title
);
931 WRITE_STATUS_ITEM(b
, SI_year
, "%s\n", afhi
->tags
.year
);
932 WRITE_STATUS_ITEM(b
, SI_album
, "%s\n", afhi
->tags
.album
);
933 WRITE_STATUS_ITEM(b
, SI_comment
, "%s\n", afhi
->tags
.comment
);
934 if (opts
->mode
== LS_MODE_MBOX
) {
935 struct osl_object lyrics_def
;
936 lyr_get_def_by_id(afsi
->lyrics_id
, &lyrics_def
);
937 if (lyrics_def
.data
) {
938 para_printf(b
, "Lyrics:\n~~~~~~~\n%s",
939 (char *)lyrics_def
.data
);
940 osl_close_disk_object(&lyrics_def
);
947 static void make_inode_status_items(struct para_buffer
*pb
)
949 struct stat statbuf
= {.st_size
= 0};
950 char *path
, mtime_str
[30] = "\0";
954 ret
= get_audio_file_path_of_row(current_aft_row
, &path
);
957 ret
= stat(path
, &statbuf
);
960 localtime_r(&statbuf
.st_mtime
, &mtime_tm
);
961 ret
= strftime(mtime_str
, 29, "%b %d %Y", &mtime_tm
);
962 assert(ret
> 0); /* number of bytes placed in mtime_str */
964 WRITE_STATUS_ITEM(pb
, SI_mtime
, "%s\n", mtime_str
);
965 WRITE_STATUS_ITEM(pb
, SI_file_size
, "%ld\n", statbuf
.st_size
/ 1024);
969 * Deallocate and invalidate the status item strings.
971 * This needs to be a public function so that afs.c can call it on shutdown.
973 void free_status_items(void)
975 freep(&status_items
);
976 freep(&parser_friendly_status_items
);
979 static void make_status_items(void)
981 const struct lls_command
*cmd
= SERVER_CMD_CMD_PTR(LS
);
982 char *argv
[] = {"ls", "--admissible", "--listing-mode=verbose"};
983 struct ls_options opts
= {.mode
= LS_MODE_VERBOSE
};
984 struct para_buffer pb
= {.max_size
= shm_get_shmmax() - 1};
989 if (!status_item_ls_data
.path
) /* no audio file open */
991 ret
= lls_parse(ARRAY_SIZE(argv
), argv
, cmd
, &opts
.lpr
, NULL
);
994 ret
= print_list_item(&status_item_ls_data
, &opts
, &pb
, current_time
);
997 make_inode_status_items(&pb
);
998 status_items
= pb
.buf
;
1000 memset(&pb
, 0, sizeof(pb
));
1001 pb
.max_size
= shm_get_shmmax() - 1;
1002 pb
.flags
= PBF_SIZE_PREFIX
;
1003 ret
= print_list_item(&status_item_ls_data
, &opts
, &pb
, current_time
);
1006 make_inode_status_items(&pb
);
1007 parser_friendly_status_items
= pb
.buf
;
1011 PARA_WARNING_LOG("could not create status items: %s\n",
1012 para_strerror(-ret
));
1013 free_status_items();
1015 lls_free_parse_result(opts
.lpr
, cmd
);
1019 * Open the audio file with highest score and set up an afd structure.
1021 * \param afd Result pointer.
1023 * On success, the numplayed field of the audio file selector info is increased
1024 * and the lastplayed time is set to the current time. Finally, the score of
1025 * the audio file is updated.
1027 * \return Positive shmid on success, negative on errors.
1029 int open_and_update_audio_file(struct audio_file_data
*afd
)
1031 unsigned char file_hash
[HASH_SIZE
];
1032 struct osl_object afsi_obj
;
1033 struct afs_info new_afsi
;
1035 struct afsi_change_event_data aced
;
1036 struct osl_object map
, chunk_table_obj
;
1037 struct ls_data
*d
= &status_item_ls_data
;
1038 unsigned char *tmp_hash
;
1040 ret
= score_get_best(¤t_aft_row
, &d
->score
);
1044 * get_hash_of_row() and get_audio_file_path_of_row() initialize
1045 * their pointer argument to point to memory-mapped files. These pointers
1046 * become stale after a new audio file has been added or after the
1047 * server process received SIGHUP. For in both cases libosl unmaps and
1048 * remaps the underlying database files, and this remapping may well
1049 * change the starting address of the mapping. To avoid stale pointer
1050 * references we create copies on the heap.
1052 ret
= get_hash_of_row(current_aft_row
, &tmp_hash
);
1056 d
->hash
= para_malloc(HASH_SIZE
);
1057 memcpy(d
->hash
, tmp_hash
, HASH_SIZE
);
1059 ret
= get_audio_file_path_of_row(current_aft_row
, &d
->path
);
1062 PARA_NOTICE_LOG("%s\n", d
->path
);
1063 d
->path
= para_strdup(d
->path
);
1065 ret
= get_afsi_object_of_row(current_aft_row
, &afsi_obj
);
1068 ret
= load_afsi(&d
->afsi
, &afsi_obj
);
1071 ret
= get_afhi_of_row(current_aft_row
, &afd
->afhi
);
1074 d
->afhi
= afd
->afhi
;
1075 d
->afhi
.chunk_table
= afd
->afhi
.chunk_table
= NULL
;
1076 ret
= osl(osl_open_disk_object(audio_file_table
, current_aft_row
,
1077 AFTCOL_CHUNKS
, &chunk_table_obj
));
1079 if (!afh_supports_dynamic_chunks(d
->afsi
.audio_format_id
))
1081 PARA_INFO_LOG("no chunk table for %s\n", d
->path
);
1082 chunk_table_obj
.data
= NULL
;
1083 chunk_table_obj
.size
= 0;
1085 PARA_INFO_LOG("chunk table: %zu bytes\n", chunk_table_obj
.size
);
1087 ret
= mmap_full_file(d
->path
, O_RDONLY
, &map
.data
, &map
.size
, &afd
->fd
);
1090 hash_function(map
.data
, map
.size
, file_hash
);
1091 ret
= hash_compare(file_hash
, d
->hash
);
1092 para_munmap(map
.data
, map
.size
);
1094 ret
= -E_HASH_MISMATCH
;
1098 new_afsi
.num_played
++;
1099 new_afsi
.last_played
= time(NULL
);
1100 save_afsi(&new_afsi
, &afsi_obj
); /* in-place update */
1102 afd
->audio_format_id
= d
->afsi
.audio_format_id
;
1103 load_chunk_table(&afd
->afhi
, &chunk_table_obj
);
1104 aced
.aft_row
= current_aft_row
;
1105 aced
.old_afsi
= &d
->afsi
;
1107 * No need to update the status items as the AFSI_CHANGE event will
1110 ret
= afs_event(AFSI_CHANGE
, NULL
, &aced
);
1113 ret
= save_afd(afd
);
1115 free(afd
->afhi
.chunk_table
);
1116 if (chunk_table_obj
.data
)
1117 osl_close_disk_object(&chunk_table_obj
);
1119 PARA_ERROR_LOG("%s: %s\n", d
->path
, para_strerror(-ret
));
1120 ret
= score_delete(current_aft_row
);
1127 static int ls_hash_compare(const void *a
, const void *b
)
1129 struct ls_data
*d1
= *(struct ls_data
**)a
, *d2
= *(struct ls_data
**)b
;
1130 return memcmp(d1
->hash
, d2
->hash
, HASH_SIZE
);
1133 static int ls_audio_format_compare(const void *a
, const void *b
)
1135 struct ls_data
*d1
= *(struct ls_data
**)a
, *d2
= *(struct ls_data
**)b
;
1136 return NUM_COMPARE(d1
->afsi
.audio_format_id
, d2
->afsi
.audio_format_id
);
1139 static int ls_duration_compare(const void *a
, const void *b
)
1141 struct ls_data
*d1
= *(struct ls_data
**)a
, *d2
= *(struct ls_data
**)b
;
1142 return NUM_COMPARE(d1
->afhi
.seconds_total
, d2
->afhi
.seconds_total
);
1145 static int ls_bitrate_compare(const void *a
, const void *b
)
1147 struct ls_data
*d1
= *(struct ls_data
**)a
, *d2
= *(struct ls_data
**)b
;
1148 return NUM_COMPARE(d1
->afhi
.bitrate
, d2
->afhi
.bitrate
);
1151 static int ls_lyrics_id_compare(const void *a
, const void *b
)
1153 struct ls_data
*d1
= *(struct ls_data
**)a
, *d2
= *(struct ls_data
**)b
;
1154 return NUM_COMPARE(d1
->afsi
.lyrics_id
, d2
->afsi
.lyrics_id
);
1157 static int ls_image_id_compare(const void *a
, const void *b
)
1159 struct ls_data
*d1
= *(struct ls_data
**)a
, *d2
= *(struct ls_data
**)b
;
1160 return NUM_COMPARE(d1
->afsi
.image_id
, d2
->afsi
.image_id
);
1163 static int ls_channels_compare(const void *a
, const void *b
)
1165 struct ls_data
*d1
= *(struct ls_data
**)a
, *d2
= *(struct ls_data
**)b
;
1166 return NUM_COMPARE(d1
->afhi
.channels
, d2
->afhi
.channels
);
1169 static int ls_frequency_compare(const void *a
, const void *b
)
1171 struct ls_data
*d1
= *(struct ls_data
**)a
, *d2
= *(struct ls_data
**)b
;
1172 return NUM_COMPARE(d1
->afhi
.frequency
, d2
->afhi
.frequency
);
1175 static int ls_num_played_compare(const void *a
, const void *b
)
1177 struct ls_data
*d1
= *(struct ls_data
**)a
, *d2
= *(struct ls_data
**)b
;
1178 return NUM_COMPARE(d1
->afsi
.num_played
, d2
->afsi
.num_played
);
1181 static int ls_last_played_compare(const void *a
, const void *b
)
1183 struct ls_data
*d1
= *(struct ls_data
**)a
, *d2
= *(struct ls_data
**)b
;
1184 return NUM_COMPARE(d1
->afsi
.last_played
, d2
->afsi
.last_played
);
1187 static int ls_score_compare(const void *a
, const void *b
)
1189 struct ls_data
*d1
= *(struct ls_data
**)a
, *d2
= *(struct ls_data
**)b
;
1190 return NUM_COMPARE(d1
->score
, d2
->score
);
1193 static int ls_path_compare(const void *a
, const void *b
)
1195 struct ls_data
*d1
= *(struct ls_data
**)a
, *d2
= *(struct ls_data
**)b
;
1196 return strcmp(d1
->path
, d2
->path
);
1199 static inline bool admissible_only(struct ls_options
*opts
)
1201 return SERVER_CMD_OPT_GIVEN(LS
, ADMISSIBLE
, opts
->lpr
)
1202 || opts
->sorting
== LS_SORT_BY_SCORE
;
1205 static int sort_matching_paths(struct ls_options
*options
)
1207 const struct lls_opt_result
*r_b
= SERVER_CMD_OPT_RESULT(LS
, BASENAME
,
1209 size_t nmemb
= options
->num_matching_paths
;
1210 size_t size
= sizeof(*options
->data_ptr
);
1211 int (*compar
)(const void *, const void *);
1214 options
->data_ptr
= para_malloc(nmemb
* sizeof(*options
->data_ptr
));
1215 for (i
= 0; i
< nmemb
; i
++)
1216 options
->data_ptr
[i
] = options
->data
+ i
;
1218 /* In these cases the array is already sorted */
1219 if (admissible_only(options
)) {
1220 if (options
->sorting
== LS_SORT_BY_SCORE
)
1223 if (options
->sorting
== LS_SORT_BY_PATH
&& !lls_opt_given(r_b
))
1227 switch (options
->sorting
) {
1228 case LS_SORT_BY_PATH
:
1229 compar
= ls_path_compare
; break;
1230 case LS_SORT_BY_SCORE
:
1231 compar
= ls_score_compare
; break;
1232 case LS_SORT_BY_LAST_PLAYED
:
1233 compar
= ls_last_played_compare
; break;
1234 case LS_SORT_BY_NUM_PLAYED
:
1235 compar
= ls_num_played_compare
; break;
1236 case LS_SORT_BY_FREQUENCY
:
1237 compar
= ls_frequency_compare
; break;
1238 case LS_SORT_BY_CHANNELS
:
1239 compar
= ls_channels_compare
; break;
1240 case LS_SORT_BY_IMAGE_ID
:
1241 compar
= ls_image_id_compare
; break;
1242 case LS_SORT_BY_LYRICS_ID
:
1243 compar
= ls_lyrics_id_compare
; break;
1244 case LS_SORT_BY_BITRATE
:
1245 compar
= ls_bitrate_compare
; break;
1246 case LS_SORT_BY_DURATION
:
1247 compar
= ls_duration_compare
; break;
1248 case LS_SORT_BY_AUDIO_FORMAT
:
1249 compar
= ls_audio_format_compare
; break;
1250 case LS_SORT_BY_HASH
:
1251 compar
= ls_hash_compare
; break;
1255 qsort(options
->data_ptr
, nmemb
, size
, compar
);
1259 /* row is either an aft_row or a row of the score table */
1260 /* TODO: Only compute widths if we need them */
1261 static int prepare_ls_row(struct osl_row
*row
, void *ls_opts
)
1264 struct ls_options
*options
= ls_opts
;
1265 bool basename_given
= SERVER_CMD_OPT_GIVEN(LS
, BASENAME
, options
->lpr
);
1267 struct ls_widths
*w
;
1268 unsigned short num_digits
;
1269 unsigned tmp
, num_inputs
;
1270 struct osl_row
*aft_row
;
1274 if (admissible_only(options
)) {
1275 ret
= get_score_and_aft_row(row
, &score
, &aft_row
);
1282 ret
= get_audio_file_path_of_row(aft_row
, &path
);
1285 if (basename_given
) {
1286 char *p
= strrchr(path
, '/');
1290 num_inputs
= lls_num_inputs(options
->lpr
);
1291 if (num_inputs
> 0) {
1292 for (i
= 0; i
< num_inputs
; i
++) {
1293 ret
= fnmatch(lls_input(i
, options
->lpr
), path
, 0);
1296 if (ret
== FNM_NOMATCH
)
1300 if (i
>= num_inputs
) /* no match */
1303 tmp
= options
->num_matching_paths
++;
1304 if (options
->num_matching_paths
> options
->array_size
) {
1305 options
->array_size
++;
1306 options
->array_size
*= 2;
1307 options
->data
= para_realloc(options
->data
, options
->array_size
1308 * sizeof(*options
->data
));
1310 d
= options
->data
+ tmp
;
1311 ret
= get_afsi_of_row(aft_row
, &d
->afsi
);
1314 ret
= get_afhi_of_row(aft_row
, &d
->afhi
);
1318 ret
= get_hash_of_row(aft_row
, &d
->hash
);
1321 w
= &options
->widths
;
1322 GET_NUM_DIGITS(d
->afsi
.image_id
, &num_digits
);
1323 w
->image_id_width
= PARA_MAX(w
->image_id_width
, num_digits
);
1324 GET_NUM_DIGITS(d
->afsi
.lyrics_id
, &num_digits
);
1325 w
->lyrics_id_width
= PARA_MAX(w
->lyrics_id_width
, num_digits
);
1326 GET_NUM_DIGITS(d
->afhi
.bitrate
, &num_digits
);
1327 w
->bitrate_width
= PARA_MAX(w
->bitrate_width
, num_digits
);
1328 GET_NUM_DIGITS(d
->afhi
.frequency
, &num_digits
);
1329 w
->frequency_width
= PARA_MAX(w
->frequency_width
, num_digits
);
1330 GET_NUM_DIGITS(d
->afsi
.num_played
, &num_digits
);
1331 w
->num_played_width
= PARA_MAX(w
->num_played_width
, num_digits
);
1332 /* get the number of chars to print this amount of time */
1333 num_digits
= get_duration_width(d
->afhi
.seconds_total
);
1334 w
->duration_width
= PARA_MAX(w
->duration_width
, num_digits
);
1335 GET_NUM_DIGITS(d
->afsi
.amp
, &num_digits
);
1336 w
->amp_width
= PARA_MAX(w
->amp_width
, num_digits
);
1337 num_digits
= strlen(audio_format_name(d
->afsi
.audio_format_id
));
1338 w
->audio_format_width
= PARA_MAX(w
->audio_format_width
, num_digits
);
1339 if (admissible_only(options
)) {
1340 GET_NUM_DIGITS(score
, &num_digits
);
1341 num_digits
++; /* add one for the sign (space or "-") */
1342 w
->score_width
= PARA_MAX(w
->score_width
, num_digits
);
1350 static int com_ls_callback(struct afs_callback_arg
*aca
)
1352 const struct lls_command
*cmd
= SERVER_CMD_CMD_PTR(LS
);
1353 struct ls_options
*opts
= aca
->query
.data
;
1355 time_t current_time
;
1356 const struct lls_opt_result
*r_r
;
1358 ret
= lls_deserialize_parse_result(
1359 (char *)aca
->query
.data
+ sizeof(*opts
), cmd
, &opts
->lpr
);
1361 r_r
= SERVER_CMD_OPT_RESULT(LS
, REVERSE
, opts
->lpr
);
1363 aca
->pbout
.flags
= (opts
->mode
== LS_MODE_PARSER
)? PBF_SIZE_PREFIX
: 0;
1364 if (admissible_only(opts
))
1365 ret
= admissible_file_loop(opts
, prepare_ls_row
);
1367 ret
= osl(osl_rbtree_loop(audio_file_table
, AFTCOL_PATH
, opts
,
1371 if (opts
->num_matching_paths
== 0) {
1372 ret
= lls_num_inputs(opts
->lpr
) > 0? -E_NO_MATCH
: 0;
1375 ret
= sort_matching_paths(opts
);
1378 time(¤t_time
);
1379 if (lls_opt_given(r_r
))
1380 for (i
= opts
->num_matching_paths
- 1; i
>= 0; i
--) {
1381 ret
= print_list_item(opts
->data_ptr
[i
], opts
,
1382 &aca
->pbout
, current_time
);
1387 for (i
= 0; i
< opts
->num_matching_paths
; i
++) {
1388 ret
= print_list_item(opts
->data_ptr
[i
], opts
,
1389 &aca
->pbout
, current_time
);
1394 lls_free_parse_result(opts
->lpr
, cmd
);
1396 free(opts
->data_ptr
);
1400 static int com_ls(struct command_context
*cc
, struct lls_parse_result
*lpr
)
1402 const struct lls_command
*cmd
= SERVER_CMD_CMD_PTR(LS
);
1403 struct ls_options
*opts
;
1404 struct osl_object query
;
1405 const struct lls_opt_result
*r_l
= SERVER_CMD_OPT_RESULT(LS
, LISTING_MODE
,
1407 const struct lls_opt_result
*r_s
= SERVER_CMD_OPT_RESULT(LS
, SORT
, lpr
);
1411 ret
= lls_serialize_parse_result(lpr
, cmd
, NULL
, &query
.size
);
1413 query
.size
+= sizeof(*opts
);
1414 query
.data
= para_malloc(query
.size
);
1416 memset(opts
, 0, sizeof(*opts
));
1417 slpr
= query
.data
+ sizeof(*opts
);
1418 ret
= lls_serialize_parse_result(lpr
, cmd
, &slpr
, NULL
);
1420 opts
->mode
= LS_MODE_SHORT
;
1421 opts
->sorting
= LS_SORT_BY_PATH
;
1422 if (lls_opt_given(r_l
)) {
1423 const char *val
= lls_string_val(0, r_l
);
1424 if (!strcmp(val
, "l") || !strcmp(val
, "long"))
1425 opts
->mode
= LS_MODE_LONG
;
1426 else if (!strcmp(val
, "s") || !strcmp(val
, "short"))
1427 opts
->mode
= LS_MODE_SHORT
;
1428 else if (!strcmp(val
, "v") || !strcmp(val
, "verbose"))
1429 opts
->mode
= LS_MODE_VERBOSE
;
1430 else if (!strcmp(val
, "m") || !strcmp(val
, "mbox"))
1431 opts
->mode
= LS_MODE_MBOX
;
1432 else if (!strcmp(val
, "c") || !strcmp(val
, "chunk-table"))
1433 opts
->mode
= LS_MODE_MBOX
;
1434 else if (!strcmp(val
, "p") || !strcmp(val
, "parser-friendly"))
1435 opts
->mode
= LS_MODE_PARSER
;
1437 ret
= -E_AFT_SYNTAX
;
1441 if (lls_opt_given(r_s
)) {
1442 const char *val
= lls_string_val(0, r_s
);
1443 if (!strcmp(val
, "p") || !strcmp(val
, "path"))
1444 opts
->sorting
= LS_SORT_BY_PATH
;
1445 else if (!strcmp(val
, "s") || !strcmp(val
, "score"))
1446 opts
->sorting
= LS_SORT_BY_SCORE
;
1447 else if (!strcmp(val
, "l") || !strcmp(val
, "lastplayed"))
1448 opts
->sorting
= LS_SORT_BY_LAST_PLAYED
;
1449 else if (!strcmp(val
, "n") || !strcmp(val
, "numplayed"))
1450 opts
->sorting
= LS_SORT_BY_NUM_PLAYED
;
1451 else if (!strcmp(val
, "f") || !strcmp(val
, "frquency"))
1452 opts
->sorting
= LS_SORT_BY_FREQUENCY
;
1453 else if (!strcmp(val
, "c") || !strcmp(val
, "channels"))
1454 opts
->sorting
= LS_SORT_BY_CHANNELS
;
1455 else if (!strcmp(val
, "i") || !strcmp(val
, "image-id"))
1456 opts
->sorting
= LS_SORT_BY_IMAGE_ID
;
1457 else if (!strcmp(val
, "y") || !strcmp(val
, "lyrics-id"))
1458 opts
->sorting
= LS_SORT_BY_LYRICS_ID
;
1459 else if (!strcmp(val
, "b") || !strcmp(val
, "bitrate"))
1460 opts
->sorting
= LS_SORT_BY_BITRATE
;
1461 else if (!strcmp(val
, "d") || !strcmp(val
, "duration"))
1462 opts
->sorting
= LS_SORT_BY_DURATION
;
1463 else if (!strcmp(val
, "a") || !strcmp(val
, "audio-format"))
1464 opts
->sorting
= LS_SORT_BY_AUDIO_FORMAT
;
1465 else if (!strcmp(val
, "h") || !strcmp(val
, "hash"))
1466 opts
->sorting
= LS_SORT_BY_HASH
;
1468 ret
= -E_AFT_SYNTAX
;
1472 ret
= send_callback_request(com_ls_callback
, &query
,
1473 afs_cb_result_handler
, cc
);
1478 EXPORT_SERVER_CMD_HANDLER(ls
);
1481 * Call the given function for each file in the audio file table.
1483 * \param private_data An arbitrary data pointer, passed to \a func.
1484 * \param func The custom function to be called.
1488 int audio_file_loop(void *private_data
, osl_rbtree_loop_func
*func
)
1490 return osl(osl_rbtree_loop(audio_file_table
, AFTCOL_HASH
, private_data
,
1494 static int find_hash_sister(unsigned char *hash
, struct osl_row
**result
)
1496 int ret
= aft_get_row_of_hash(hash
, result
);
1498 if (ret
== -OSL_ERRNO_TO_PARA_ERROR(E_OSL_RB_KEY_NOT_FOUND
))
1503 static int find_path_brother(const char *path
, struct osl_row
**result
)
1505 int ret
= aft_get_row_of_path(path
, result
);
1507 if (ret
== -OSL_ERRNO_TO_PARA_ERROR(E_OSL_RB_KEY_NOT_FOUND
))
1512 /** The format of the data stored by save_audio_file_data(). */
1513 enum com_add_buffer_offsets
{
1514 /* afhi (if present) starts at this offset. */
1515 CAB_AFHI_OFFSET_POS
= 0,
1516 /** Start of the chunk table (if present). */
1517 CAB_CHUNKS_OFFSET_POS
= 4,
1518 /** Start of the (serialized) lopsub parse result. */
1520 /** Audio format id. */
1521 CAB_AUDIO_FORMAT_ID_OFFSET
= 12,
1522 /** The hash of the audio file being added. */
1523 CAB_HASH_OFFSET
= 13,
1524 /** Start of the path of the audio file. */
1525 CAB_PATH_OFFSET
= (CAB_HASH_OFFSET
+ HASH_SIZE
),
1529 * Store the given data to a single buffer. Doesn't need the audio file selector
1530 * info struct as the server knows it as well.
1532 * It's OK to call this with afhi == NULL. In this case, the audio format
1533 * handler info won't be stored in the buffer.
1535 static void save_add_callback_buffer(unsigned char *hash
, const char *path
,
1536 struct afh_info
*afhi
, const char *slpr
, size_t slpr_size
,
1537 uint8_t audio_format_num
, struct osl_object
*obj
)
1539 size_t path_len
= strlen(path
) + 1;
1540 size_t afhi_size
= sizeof_afhi_buf(afhi
);
1541 size_t size
= CAB_PATH_OFFSET
+ path_len
+ afhi_size
1542 + sizeof_chunk_table(afhi
) + slpr_size
;
1543 char *buf
= para_malloc(size
);
1546 assert(size
<= ~(uint32_t)0);
1547 write_u8(buf
+ CAB_AUDIO_FORMAT_ID_OFFSET
, audio_format_num
);
1548 memcpy(buf
+ CAB_HASH_OFFSET
, hash
, HASH_SIZE
);
1549 strcpy(buf
+ CAB_PATH_OFFSET
, path
);
1550 pos
= CAB_PATH_OFFSET
+ path_len
;
1551 write_u32(buf
+ CAB_AFHI_OFFSET_POS
, pos
);
1552 save_afhi(afhi
, buf
+ pos
);
1554 write_u32(buf
+ CAB_CHUNKS_OFFSET_POS
, pos
);
1556 save_chunk_table(afhi
, buf
+ pos
);
1557 pos
+= sizeof_chunk_table(afhi
);
1559 write_u32(buf
+ CAB_LPR_OFFSET
, pos
);
1560 memcpy(buf
+ pos
, slpr
, slpr_size
);
1561 assert(pos
+ slpr_size
== size
);
1568 Overview of the add command.
1570 Input: What was passed to the callback by the command handler.
1572 HS: Hash sister. Whether an audio file with identical hash
1573 already exists in the osl database.
1575 PB: Path brother. Whether a file with the given path exists
1578 F: Force flag given. Whether add was called with -f.
1580 output: Action performed by the callback.
1582 AFHI: Whether afhi and chunk table are computed and sent.
1583 ACTION: Table modifications to be done by the callback.
1585 +----+----+---+------+---------------------------------------------------+
1586 | HS | PB | F | AFHI | ACTION
1587 +----+----+---+------+---------------------------------------------------+
1588 | Y | Y | Y | Y | if HS != PB: remove PB. HS: force afhi update,
1589 | | update path, keep afsi
1590 +----+----+---+------+---------------------------------------------------+
1591 | Y | Y | N | N | if HS == PB: do not send callback request at all.
1592 | | otherwise: remove PB, HS: update path, keep afhi,
1594 +----+----+---+------+---------------------------------------------------+
1595 | Y | N | Y | Y | (rename) force afhi update of HS, update path of
1597 +----+----+---+------+---------------------------------------------------+
1598 | Y | N | N | N | (file rename) update path of HS, keep afsi, afhi
1599 +----+----+---+------+---------------------------------------------------+
1600 | N | Y | Y | Y | (file change) update afhi, hash, of PB, keep afsi
1601 | | (force has no effect)
1602 +----+----+---+------+---------------------------------------------------+
1603 | N | Y | N | Y | (file change) update afhi, hash of PB, keep afsi
1604 +----+----+---+------+---------------------------------------------------+
1605 | N | N | Y | Y | (new file) create new entry (force has no effect)
1606 +----+----+---+------+---------------------------------------------------+
1607 | N | N | N | Y | (new file) create new entry
1608 +----+----+---+------+---------------------------------------------------+
1612 afhi <=> force or no HS
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 char *slpr
= buf
+ read_u32(buf
+ CAB_LPR_OFFSET
);
1628 struct afs_info default_afsi
= {.last_played
= 0};
1629 uint16_t afhi_offset
, chunks_offset
;
1630 const struct lls_command
*cmd
= SERVER_CMD_CMD_PTR(ADD
);
1631 const struct lls_opt_result
*r_f
, *r_v
;
1633 ret
= lls_deserialize_parse_result(slpr
, cmd
, &aca
->lpr
);
1635 r_f
= SERVER_CMD_OPT_RESULT(ADD
, FORCE
, aca
->lpr
);
1636 r_v
= SERVER_CMD_OPT_RESULT(ADD
, VERBOSE
, aca
->lpr
);
1638 hash
= (unsigned char *)buf
+ CAB_HASH_OFFSET
;
1639 hash_to_asc(hash
, asc
);
1640 objs
[AFTCOL_HASH
].data
= buf
+ CAB_HASH_OFFSET
;
1641 objs
[AFTCOL_HASH
].size
= HASH_SIZE
;
1643 path
= buf
+ CAB_PATH_OFFSET
;
1644 objs
[AFTCOL_PATH
].data
= path
;
1645 objs
[AFTCOL_PATH
].size
= strlen(path
) + 1;
1647 PARA_INFO_LOG("request to add %s\n", path
);
1648 ret
= find_hash_sister(hash
, &hs
);
1651 ret
= find_path_brother(path
, &pb
);
1654 if (hs
&& pb
&& hs
== pb
&& !lls_opt_given(r_f
)) {
1655 if (lls_opt_given(r_v
))
1656 para_printf(&aca
->pbout
, "ignoring duplicate\n");
1660 if (hs
&& hs
!= pb
) {
1661 struct osl_object obj
;
1662 if (pb
) { /* hs trumps pb, remove pb */
1663 if (lls_opt_given(r_v
))
1664 para_printf(&aca
->pbout
, "removing %s\n", path
);
1665 ret
= afs_event(AUDIO_FILE_REMOVE
, &aca
->pbout
, pb
);
1668 ret
= osl(osl_del_row(audio_file_table
, pb
));
1673 /* file rename, update hs' path */
1674 if (lls_opt_given(r_v
)) {
1675 ret
= osl(osl_get_object(audio_file_table
, hs
,
1676 AFTCOL_PATH
, &obj
));
1679 para_printf(&aca
->pbout
, "renamed from %s\n",
1682 ret
= osl(osl_update_object(audio_file_table
, hs
, AFTCOL_PATH
,
1683 &objs
[AFTCOL_PATH
]));
1686 ret
= afs_event(AUDIO_FILE_RENAME
, &aca
->pbout
, hs
);
1689 if (!lls_opt_given(r_f
))
1692 /* no hs or force mode, child must have sent afhi */
1693 afhi_offset
= read_u32(buf
+ CAB_AFHI_OFFSET_POS
);
1694 chunks_offset
= read_u32(buf
+ CAB_CHUNKS_OFFSET_POS
);
1696 objs
[AFTCOL_AFHI
].data
= buf
+ afhi_offset
;
1697 objs
[AFTCOL_AFHI
].size
= chunks_offset
- afhi_offset
;
1699 if (!objs
[AFTCOL_AFHI
].size
) /* "impossible" */
1701 objs
[AFTCOL_CHUNKS
].data
= buf
+ chunks_offset
;
1702 objs
[AFTCOL_CHUNKS
].size
= aca
->query
.size
- chunks_offset
;
1703 if (pb
&& !hs
) { /* update pb's hash */
1704 char old_asc
[2 * HASH_SIZE
+ 1];
1705 unsigned char *old_hash
;
1706 ret
= get_hash_of_row(pb
, &old_hash
);
1709 hash_to_asc(old_hash
, old_asc
);
1710 if (lls_opt_given(r_v
))
1711 para_printf(&aca
->pbout
, "file change: %s -> %s\n",
1713 ret
= osl(osl_update_object(audio_file_table
, pb
, AFTCOL_HASH
,
1714 &objs
[AFTCOL_HASH
]));
1718 if (hs
|| pb
) { /* (hs != NULL and pb != NULL) implies hs == pb */
1719 struct osl_row
*row
= pb
? pb
: hs
;
1720 /* update afhi and chunk_table */
1721 if (lls_opt_given(r_v
))
1722 para_printf(&aca
->pbout
,
1723 "updating afhi and chunk table\n");
1724 ret
= osl(osl_update_object(audio_file_table
, row
, AFTCOL_AFHI
,
1725 &objs
[AFTCOL_AFHI
]));
1728 /* truncate the file to size zero if there is no chunk table */
1729 ret
= osl(osl_update_object(audio_file_table
, row
, AFTCOL_CHUNKS
,
1730 &objs
[AFTCOL_CHUNKS
]));
1733 ret
= afs_event(AFHI_CHANGE
, &aca
->pbout
, row
);
1736 /* new entry, use default afsi */
1737 if (lls_opt_given(r_v
))
1738 para_printf(&aca
->pbout
, "new file\n");
1739 default_afsi
.last_played
= time(NULL
) - 365 * 24 * 60 * 60;
1740 default_afsi
.audio_format_id
= read_u8(buf
+ CAB_AUDIO_FORMAT_ID_OFFSET
);
1742 objs
[AFTCOL_AFSI
].data
= &afsi_buf
;
1743 objs
[AFTCOL_AFSI
].size
= AFSI_SIZE
;
1744 save_afsi(&default_afsi
, &objs
[AFTCOL_AFSI
]);
1745 ret
= osl(osl_add_and_get_row(audio_file_table
, objs
, &aft_row
));
1748 ret
= afs_event(AUDIO_FILE_ADD
, &aca
->pbout
, aft_row
);
1751 para_printf(&aca
->pbout
, "could not add %s\n", path
);
1752 lls_free_parse_result(aca
->lpr
, cmd
);
1756 /* Used by com_add(). */
1757 struct private_add_data
{
1758 /* The pointer passed to the original command handler. */
1759 struct command_context
*cc
;
1760 /* Contains the flags given at the command line. */
1761 struct lls_parse_result
*lpr
;
1762 /* Serialized lopsub parse result. */
1764 /* Number of bytes. */
1768 static int path_brother_callback(struct afs_callback_arg
*aca
)
1770 char *path
= aca
->query
.data
;
1771 struct osl_row
*path_brother
;
1772 int ret
= find_path_brother(path
, &path_brother
);
1775 return pass_buffer_as_shm(aca
->fd
, SBD_OUTPUT
, (char *)&path_brother
,
1776 sizeof(path_brother
));
1779 static int hash_sister_callback(struct afs_callback_arg
*aca
)
1781 unsigned char *hash
= aca
->query
.data
;
1782 struct osl_row
*hash_sister
;
1783 int ret
= find_hash_sister(hash
, &hash_sister
);
1787 return pass_buffer_as_shm(aca
->fd
, SBD_OUTPUT
, (char *)&hash_sister
,
1788 sizeof(hash_sister
));
1791 static int get_row_pointer_from_result(struct osl_object
*result
,
1792 __a_unused
uint8_t band
, void *private)
1794 struct osl_row
**row
= private;
1796 if (band
== SBD_OUTPUT
)
1797 *row
= *(struct osl_row
**)(result
->data
);
1801 static int add_one_audio_file(const char *path
, void *private_data
)
1803 int ret
, send_ret
= 1, fd
;
1804 uint8_t format_num
= -1;
1805 struct private_add_data
*pad
= private_data
;
1806 struct afh_info afhi
, *afhi_ptr
= NULL
;
1807 struct osl_row
*pb
= NULL
, *hs
= NULL
; /* path brother/hash sister */
1808 struct osl_object map
, obj
= {.data
= NULL
}, query
;
1809 unsigned char hash
[HASH_SIZE
];
1810 bool a_given
= SERVER_CMD_OPT_GIVEN(ADD
, ALL
, pad
->lpr
);
1811 bool f_given
= SERVER_CMD_OPT_GIVEN(ADD
, FORCE
, pad
->lpr
);
1812 bool l_given
= SERVER_CMD_OPT_GIVEN(ADD
, LAZY
, pad
->lpr
);
1813 bool v_given
= SERVER_CMD_OPT_GIVEN(ADD
, VERBOSE
, pad
->lpr
);
1815 ret
= guess_audio_format(path
);
1816 if (ret
< 0 && !a_given
) {
1820 query
.data
= (char *)path
;
1821 query
.size
= strlen(path
) + 1;
1822 ret
= send_callback_request(path_brother_callback
, &query
,
1823 get_row_pointer_from_result
, &pb
);
1824 if (ret
< 0 && ret
!= -OSL_ERRNO_TO_PARA_ERROR(E_OSL_RB_KEY_NOT_FOUND
))
1827 if (pb
&& l_given
) { /* lazy is really cheap */
1829 send_ret
= send_sb_va(&pad
->cc
->scc
, SBD_OUTPUT
,
1830 "lazy-ignore: %s\n", path
);
1833 /* We still want to add this file. Compute its hash. */
1834 ret
= mmap_full_file(path
, O_RDONLY
, &map
.data
, &map
.size
, &fd
);
1837 hash_function(map
.data
, map
.size
, hash
);
1839 /* Check whether the database contains a file with the same hash. */
1841 query
.size
= HASH_SIZE
;
1842 ret
= send_callback_request(hash_sister_callback
, &query
,
1843 get_row_pointer_from_result
, &hs
);
1846 /* Return success if we already know this file. */
1848 if (pb
&& hs
&& hs
== pb
&& !f_given
) {
1850 send_ret
= send_sb_va(&pad
->cc
->scc
, SBD_OUTPUT
,
1851 "%s exists, not forcing update\n", path
);
1855 * We won't recalculate the audio format info and the chunk table if
1856 * there is a hash sister and FORCE was not given.
1858 if (!hs
|| f_given
) {
1859 ret
= compute_afhi(path
, map
.data
, map
.size
, fd
, &afhi
);
1865 munmap(map
.data
, map
.size
);
1868 send_ret
= send_sb_va(&pad
->cc
->scc
, SBD_OUTPUT
,
1869 "adding %s\n", path
);
1873 save_add_callback_buffer(hash
, path
, afhi_ptr
, pad
->slpr
,
1874 pad
->slpr_size
, format_num
, &obj
);
1875 /* Ask afs to consider this entry for adding. */
1876 ret
= send_callback_request(com_add_callback
, &obj
,
1877 afs_cb_result_handler
, pad
->cc
);
1882 munmap(map
.data
, map
.size
);
1884 if (ret
< 0 && send_ret
>= 0)
1885 send_ret
= send_sb_va(&pad
->cc
->scc
, SBD_ERROR_LOG
,
1886 "failed to add %s (%s)\n", path
, para_strerror(-ret
));
1888 clear_afhi(afhi_ptr
);
1889 /* Stop adding files only on send errors. */
1893 static int com_add(struct command_context
*cc
, struct lls_parse_result
*lpr
)
1896 struct private_add_data pad
= {.cc
= cc
, .lpr
= lpr
};
1897 const struct lls_command
*cmd
= SERVER_CMD_CMD_PTR(ADD
);
1898 unsigned num_inputs
;
1901 ret
= lls(lls_check_arg_count(lpr
, 1, INT_MAX
, &errctx
));
1903 send_errctx(cc
, errctx
);
1906 ret
= lls_serialize_parse_result(lpr
, cmd
, &pad
.slpr
, &pad
.slpr_size
);
1908 num_inputs
= lls_num_inputs(lpr
);
1909 for (i
= 0; i
< num_inputs
; i
++) {
1911 ret
= verify_path(lls_input(i
, lpr
), &path
);
1913 ret
= send_sb_va(&cc
->scc
, SBD_ERROR_LOG
, "%s: %s\n",
1914 lls_input(i
, lpr
), para_strerror(-ret
));
1919 if (ret
== 1) /* directory */
1920 ret
= for_each_file_in_dir(path
, add_one_audio_file
,
1922 else /* regular file */
1923 ret
= add_one_audio_file(path
, &pad
);
1925 send_sb_va(&cc
->scc
, SBD_OUTPUT
, "%s: %s\n", path
,
1926 para_strerror(-ret
));
1937 EXPORT_SERVER_CMD_HANDLER(add
);
1939 /** Flags used by the touch command. */
1941 /** Whether the \p FNM_PATHNAME flag should be passed to fnmatch(). */
1942 TOUCH_FLAG_FNM_PATHNAME
= 1,
1943 /** Activates verbose mode. */
1944 TOUCH_FLAG_VERBOSE
= 2
1947 static int touch_audio_file(__a_unused
struct osl_table
*table
,
1948 struct osl_row
*row
, const char *name
, void *data
)
1950 struct afs_callback_arg
*aca
= data
;
1951 bool v_given
= SERVER_CMD_OPT_GIVEN(TOUCH
, VERBOSE
, aca
->lpr
);
1952 const struct lls_opt_result
*r_n
, *r_l
, *r_i
, *r_y
, *r_a
;
1954 struct osl_object obj
;
1955 struct afs_info old_afsi
, new_afsi
;
1957 struct afsi_change_event_data aced
;
1959 r_n
= SERVER_CMD_OPT_RESULT(TOUCH
, NUMPLAYED
, aca
->lpr
);
1960 r_l
= SERVER_CMD_OPT_RESULT(TOUCH
, LASTPLAYED
, aca
->lpr
);
1961 r_i
= SERVER_CMD_OPT_RESULT(TOUCH
, IMAGE_ID
, aca
->lpr
);
1962 r_y
= SERVER_CMD_OPT_RESULT(TOUCH
, LYRICS_ID
, aca
->lpr
);
1963 r_a
= SERVER_CMD_OPT_RESULT(TOUCH
, AMP
, aca
->lpr
);
1964 no_options
= !lls_opt_given(r_n
) && !lls_opt_given(r_l
) && !lls_opt_given(r_i
)
1965 && !lls_opt_given(r_y
) && !lls_opt_given(r_a
);
1967 ret
= get_afsi_object_of_row(row
, &obj
);
1969 para_printf(&aca
->pbout
, "cannot touch %s\n", name
);
1972 ret
= load_afsi(&old_afsi
, &obj
);
1974 para_printf(&aca
->pbout
, "cannot touch %s\n", name
);
1977 new_afsi
= old_afsi
;
1979 new_afsi
.num_played
++;
1980 new_afsi
.last_played
= time(NULL
);
1982 para_printf(&aca
->pbout
, "%s: num_played = %u, "
1983 "last_played = now()\n", name
,
1984 new_afsi
.num_played
);
1986 if (lls_opt_given(r_l
))
1987 new_afsi
.last_played
= lls_uint64_val(0, r_l
);
1988 if (lls_opt_given(r_n
))
1989 new_afsi
.num_played
= lls_uint32_val(0, r_n
);
1990 if (lls_opt_given(r_i
))
1991 new_afsi
.image_id
= lls_uint32_val(0, r_i
);
1992 if (lls_opt_given(r_y
))
1993 new_afsi
.lyrics_id
= lls_uint32_val(0, r_y
);
1994 if (lls_opt_given(r_a
))
1995 new_afsi
.amp
= lls_uint32_val(0, r_a
);
1997 para_printf(&aca
->pbout
, "touching %s\n", name
);
1999 save_afsi(&new_afsi
, &obj
); /* in-place update */
2001 aced
.old_afsi
= &old_afsi
;
2002 return afs_event(AFSI_CHANGE
, &aca
->pbout
, &aced
);
2005 static int com_touch_callback(struct afs_callback_arg
*aca
)
2007 const struct lls_command
*cmd
= SERVER_CMD_CMD_PTR(TOUCH
);
2009 const struct lls_opt_result
*r_i
, *r_y
;
2011 struct pattern_match_data pmd
= {
2012 .table
= audio_file_table
,
2013 .loop_col_num
= AFTCOL_HASH
,
2014 .match_col_num
= AFTCOL_PATH
,
2016 .action
= touch_audio_file
2019 ret
= lls_deserialize_parse_result(aca
->query
.data
, cmd
, &aca
->lpr
);
2023 r_i
= SERVER_CMD_OPT_RESULT(TOUCH
, IMAGE_ID
, aca
->lpr
);
2024 if (lls_opt_given(r_i
)) {
2025 uint32_t id
= lls_uint32_val(0, r_i
);
2026 ret
= img_get_name_by_id(id
, NULL
);
2028 para_printf(&aca
->pbout
, "invalid image ID: %u\n", id
);
2032 r_y
= SERVER_CMD_OPT_RESULT(TOUCH
, LYRICS_ID
, aca
->lpr
);
2033 if (lls_opt_given(r_y
)) {
2034 uint32_t id
= lls_uint32_val(0, r_y
);
2035 ret
= lyr_get_name_by_id(id
, NULL
);
2037 para_printf(&aca
->pbout
, "invalid lyrics ID: %u\n", id
);
2041 p_given
= SERVER_CMD_OPT_GIVEN(TOUCH
, PATHNAME_MATCH
, aca
->lpr
);
2043 pmd
.fnmatch_flags
|= FNM_PATHNAME
;
2044 ret
= for_each_matching_row(&pmd
);
2045 if (ret
>= 0 && pmd
.num_matches
== 0)
2047 lls_free_parse_result(aca
->lpr
, cmd
);
2051 static int com_touch(struct command_context
*cc
, struct lls_parse_result
*lpr
)
2053 const struct lls_command
*cmd
= SERVER_CMD_CMD_PTR(TOUCH
);
2057 ret
= lls(lls_check_arg_count(lpr
, 1, INT_MAX
, &errctx
));
2059 send_errctx(cc
, errctx
);
2062 return send_lls_callback_request(com_touch_callback
, cmd
, lpr
, cc
);
2064 EXPORT_SERVER_CMD_HANDLER(touch
);
2066 static int remove_audio_file(__a_unused
struct osl_table
*table
,
2067 struct osl_row
*row
, const char *name
, void *data
)
2069 struct afs_callback_arg
*aca
= data
;
2070 bool v_given
= SERVER_CMD_OPT_GIVEN(RM
, VERBOSE
, aca
->lpr
);
2074 para_printf(&aca
->pbout
, "removing %s\n", name
);
2075 ret
= afs_event(AUDIO_FILE_REMOVE
, &aca
->pbout
, row
);
2078 ret
= osl(osl_del_row(audio_file_table
, row
));
2080 para_printf(&aca
->pbout
, "cannot remove %s\n", name
);
2084 static int com_rm_callback(struct afs_callback_arg
*aca
)
2086 const struct lls_command
*cmd
= SERVER_CMD_CMD_PTR(RM
);
2088 struct pattern_match_data pmd
= {
2089 .table
= audio_file_table
,
2090 .loop_col_num
= AFTCOL_HASH
,
2091 .match_col_num
= AFTCOL_PATH
,
2093 .action
= remove_audio_file
2095 bool v_given
, p_given
, f_given
;
2097 ret
= lls_deserialize_parse_result(aca
->query
.data
, cmd
, &aca
->lpr
);
2100 v_given
= SERVER_CMD_OPT_GIVEN(RM
, VERBOSE
, aca
->lpr
);
2101 p_given
= SERVER_CMD_OPT_GIVEN(RM
, PATHNAME_MATCH
, aca
->lpr
);
2102 f_given
= SERVER_CMD_OPT_GIVEN(RM
, FORCE
, aca
->lpr
);
2105 pmd
.fnmatch_flags
|= FNM_PATHNAME
;
2106 ret
= for_each_matching_row(&pmd
);
2109 if (pmd
.num_matches
== 0) {
2113 para_printf(&aca
->pbout
, "removed %u file(s)\n",
2116 lls_free_parse_result(aca
->lpr
, cmd
);
2120 /* TODO options: -r (recursive) */
2121 static int com_rm(struct command_context
*cc
, struct lls_parse_result
*lpr
)
2123 const struct lls_command
*cmd
= SERVER_CMD_CMD_PTR(RM
);
2127 ret
= lls(lls_check_arg_count(lpr
, 1, INT_MAX
, &errctx
));
2129 send_errctx(cc
, errctx
);
2132 return send_lls_callback_request(com_rm_callback
, cmd
, lpr
, cc
);
2134 EXPORT_SERVER_CMD_HANDLER(rm
);
2136 /** Data passed to the action handler of com_cpsi(). */
2137 struct cpsi_action_data
{
2138 /** Values are copied from here. */
2139 struct afs_info source_afsi
;
2140 /** What was passed to com_cpsi_callback(). */
2141 struct afs_callback_arg
*aca
;
2145 static int copy_selector_info(__a_unused
struct osl_table
*table
,
2146 struct osl_row
*row
, const char *name
, void *data
)
2148 struct cpsi_action_data
*cad
= data
;
2149 struct osl_object target_afsi_obj
;
2151 struct afs_info old_afsi
, target_afsi
;
2152 struct afsi_change_event_data aced
;
2153 bool a_given
, y_given
, i_given
, l_given
, n_given
, v_given
;
2155 a_given
= SERVER_CMD_OPT_GIVEN(CPSI
, ATTRIBUTE_BITMAP
, cad
->aca
->lpr
);
2156 y_given
= SERVER_CMD_OPT_GIVEN(CPSI
, LYRICS_ID
, cad
->aca
->lpr
);
2157 i_given
= SERVER_CMD_OPT_GIVEN(CPSI
, IMAGE_ID
, cad
->aca
->lpr
);
2158 l_given
= SERVER_CMD_OPT_GIVEN(CPSI
, LASTPLAYED
, cad
->aca
->lpr
);
2159 n_given
= SERVER_CMD_OPT_GIVEN(CPSI
, NUMPLAYED
, cad
->aca
->lpr
);
2160 v_given
= SERVER_CMD_OPT_GIVEN(CPSI
, VERBOSE
, cad
->aca
->lpr
);
2162 ret
= get_afsi_object_of_row(row
, &target_afsi_obj
);
2165 ret
= load_afsi(&target_afsi
, &target_afsi_obj
);
2168 old_afsi
= target_afsi
;
2169 if (cad
->copy_all
|| y_given
)
2170 target_afsi
.lyrics_id
= cad
->source_afsi
.lyrics_id
;
2171 if (cad
->copy_all
|| i_given
)
2172 target_afsi
.image_id
= cad
->source_afsi
.image_id
;
2173 if (cad
->copy_all
|| l_given
)
2174 target_afsi
.last_played
= cad
->source_afsi
.last_played
;
2175 if (cad
->copy_all
|| n_given
)
2176 target_afsi
.num_played
= cad
->source_afsi
.num_played
;
2177 if (cad
->copy_all
|| a_given
)
2178 target_afsi
.attributes
= cad
->source_afsi
.attributes
;
2179 save_afsi(&target_afsi
, &target_afsi_obj
); /* in-place update */
2181 para_printf(&cad
->aca
->pbout
, "copied afsi to %s\n", name
);
2183 aced
.old_afsi
= &old_afsi
;
2184 return afs_event(AFSI_CHANGE
, &cad
->aca
->pbout
, &aced
);
2187 static int com_cpsi_callback(struct afs_callback_arg
*aca
)
2189 const struct lls_command
*cmd
= SERVER_CMD_CMD_PTR(CPSI
);
2190 bool a_given
, y_given
, i_given
, l_given
, n_given
, v_given
;
2191 struct cpsi_action_data cad
= {.aca
= aca
};
2193 struct pattern_match_data pmd
= {
2194 .table
= audio_file_table
,
2195 .loop_col_num
= AFTCOL_HASH
,
2196 .match_col_num
= AFTCOL_PATH
,
2197 .input_skip
= 1, /* skip first argument (source file) */
2199 .action
= copy_selector_info
2202 ret
= lls_deserialize_parse_result(aca
->query
.data
, cmd
, &aca
->lpr
);
2206 a_given
= SERVER_CMD_OPT_GIVEN(CPSI
, ATTRIBUTE_BITMAP
, aca
->lpr
);
2207 y_given
= SERVER_CMD_OPT_GIVEN(CPSI
, LYRICS_ID
, aca
->lpr
);
2208 i_given
= SERVER_CMD_OPT_GIVEN(CPSI
, IMAGE_ID
, aca
->lpr
);
2209 l_given
= SERVER_CMD_OPT_GIVEN(CPSI
, LASTPLAYED
, aca
->lpr
);
2210 n_given
= SERVER_CMD_OPT_GIVEN(CPSI
, NUMPLAYED
, aca
->lpr
);
2211 v_given
= SERVER_CMD_OPT_GIVEN(CPSI
, VERBOSE
, aca
->lpr
);
2212 cad
.copy_all
= !a_given
&& !y_given
&& !i_given
&& !l_given
&& !n_given
;
2214 ret
= get_afsi_of_path(lls_input(0, aca
->lpr
), &cad
.source_afsi
);
2217 ret
= for_each_matching_row(&pmd
);
2220 if (pmd
.num_matches
> 0) {
2222 para_printf(&aca
->pbout
, "updated afsi of %u file(s)\n",
2227 lls_free_parse_result(aca
->lpr
, cmd
);
2231 static int com_cpsi(struct command_context
*cc
, struct lls_parse_result
*lpr
)
2233 const struct lls_command
*cmd
= SERVER_CMD_CMD_PTR(CPSI
);
2235 int ret
= lls(lls_check_arg_count(lpr
, 2, INT_MAX
, &errctx
));
2237 send_errctx(cc
, errctx
);
2240 return send_lls_callback_request(com_cpsi_callback
, cmd
, lpr
, cc
);
2242 EXPORT_SERVER_CMD_HANDLER(cpsi
);
2244 struct change_atts_data
{
2245 uint64_t add_mask
, del_mask
;
2246 struct afs_callback_arg
*aca
;
2249 static int change_atts(__a_unused
struct osl_table
*table
,
2250 struct osl_row
*row
, __a_unused
const char *name
, void *data
)
2253 struct osl_object obj
;
2254 struct afs_info old_afsi
, new_afsi
;
2255 struct afsi_change_event_data aced
= {
2257 .old_afsi
= &old_afsi
2259 struct change_atts_data
*cad
= data
;
2261 ret
= get_afsi_object_of_row(row
, &obj
);
2264 ret
= load_afsi(&old_afsi
, &obj
);
2267 new_afsi
= old_afsi
;
2268 new_afsi
.attributes
|= cad
->add_mask
;
2269 new_afsi
.attributes
&= ~cad
->del_mask
;
2270 save_afsi(&new_afsi
, &obj
); /* in-place update */
2271 return afs_event(AFSI_CHANGE
, &cad
->aca
->pbout
, &aced
);
2274 static int com_setatt_callback(struct afs_callback_arg
*aca
)
2276 const struct lls_command
*cmd
= SERVER_CMD_CMD_PTR(SETATT
);
2278 struct change_atts_data cad
= {.aca
= aca
};
2279 struct pattern_match_data pmd
= {
2280 .table
= audio_file_table
,
2281 .loop_col_num
= AFTCOL_HASH
,
2282 .match_col_num
= AFTCOL_PATH
,
2283 .pm_flags
= PM_SKIP_EMPTY_NAME
,
2285 .action
= change_atts
2287 unsigned num_inputs
;
2289 ret
= lls_deserialize_parse_result(aca
->query
.data
, cmd
, &aca
->lpr
);
2293 num_inputs
= lls_num_inputs(aca
->lpr
);
2294 for (i
= 0; i
< num_inputs
; i
++) {
2295 unsigned char bitnum
;
2297 const char *arg
= lls_input(i
, aca
->lpr
);
2299 size_t len
= strlen(arg
);
2301 ret
= -E_ATTR_SYNTAX
;
2305 if (c
!= '+' && c
!= '-') {
2306 if (cad
.add_mask
== 0 && cad
.del_mask
== 0)
2307 goto out
; /* no attribute modifier given */
2310 p
= para_malloc(len
);
2311 memcpy(p
, arg
, len
- 1);
2313 ret
= get_attribute_bitnum_by_name(p
, &bitnum
);
2316 para_printf(&aca
->pbout
, "invalid argument: %s\n", arg
);
2320 cad
.add_mask
|= (one
<< bitnum
);
2322 cad
.del_mask
|= (one
<< bitnum
);
2324 /* no pattern given */
2325 ret
= -E_ATTR_SYNTAX
;
2329 ret
= for_each_matching_row(&pmd
);
2330 if (ret
>= 0 && pmd
.num_matches
== 0)
2333 lls_free_parse_result(aca
->lpr
, cmd
);
2337 static int com_setatt(struct command_context
*cc
, struct lls_parse_result
*lpr
)
2339 const struct lls_command
*cmd
= SERVER_CMD_CMD_PTR(SETATT
);
2341 int ret
= lls(lls_check_arg_count(lpr
, 2, INT_MAX
, &errctx
));
2344 send_errctx(cc
, errctx
);
2347 return send_lls_callback_request(com_setatt_callback
, cmd
, lpr
, cc
);
2349 EXPORT_SERVER_CMD_HANDLER(setatt
);
2351 static int afs_stat_callback(struct afs_callback_arg
*aca
)
2353 int *parser_friendly
= aca
->query
.data
;
2354 char *buf
= *parser_friendly
?
2355 parser_friendly_status_items
: status_items
;
2359 return pass_buffer_as_shm(aca
->fd
, SBD_OUTPUT
, buf
, strlen(buf
));
2363 * Get the current afs status items from the afs process and send it.
2365 * \param cc The command context, used e.g. for data encryption.
2366 * \param parser_friendly Whether parser-friendly output format should be used.
2368 * As the contents of the afs status items change in time and the command
2369 * handler only has a COW version created at fork time, it can not send
2370 * up-to-date afs status items directly. Therefore the usual callback mechanism
2371 * is used to pass the status items from the afs process to the command handler
2372 * via a shared memory area and a pipe.
2374 * \return The return value of the underlying call to \ref send_callback_request().
2376 int send_afs_status(struct command_context
*cc
, int parser_friendly
)
2378 struct osl_object query
= {.data
= &parser_friendly
,
2379 .size
= sizeof(parser_friendly
)};
2381 return send_callback_request(afs_stat_callback
, &query
,
2382 afs_cb_result_handler
, cc
);
2385 /* returns success on non-fatal errors to keep the loop going */
2386 static int check_audio_file(struct osl_row
*row
, void *data
)
2389 struct para_buffer
*pb
= data
;
2390 struct stat statbuf
;
2391 int ret
= get_audio_file_path_of_row(row
, &path
);
2392 struct afs_info afsi
;
2396 para_printf(pb
, "%s\n", para_strerror(-ret
));
2399 if (stat(path
, &statbuf
) < 0)
2400 para_printf(pb
, "%s: stat error (%s)\n", path
, strerror(errno
));
2401 else if (!S_ISREG(statbuf
.st_mode
))
2402 para_printf(pb
, "%s: not a regular file\n", path
);
2403 ret
= get_afsi_of_row(row
, &afsi
);
2405 para_printf(pb
, "%s: %s\n", path
, para_strerror(-ret
));
2408 ret
= lyr_get_name_by_id(afsi
.lyrics_id
, &blob_name
);
2410 para_printf(pb
, "%s lyrics id %u: %s\n", path
, afsi
.lyrics_id
,
2411 para_strerror(-ret
));
2412 ret
= img_get_name_by_id(afsi
.image_id
, &blob_name
);
2414 para_printf(pb
, "%s image id %u: %s\n", path
, afsi
.image_id
,
2415 para_strerror(-ret
));
2420 * Check the audio file table for inconsistencies.
2422 * \param aca Only ->pbout is used for diagnostics.
2424 * \return Standard. Inconsistencies are reported but not regarded as an error.
2426 int aft_check_callback(struct afs_callback_arg
*aca
)
2428 para_printf(&aca
->pbout
, "checking audio file table...\n");
2429 return audio_file_loop(&aca
->pbout
, check_audio_file
);
2432 struct aft_check_atts_data
{
2434 struct para_buffer
*pb
;
2437 static int check_atts_of_audio_file(struct osl_row
*row
, void *data
)
2439 struct aft_check_atts_data
*acad
= data
;
2441 struct afs_info afsi
;
2445 ret
= get_afsi_of_row(row
, &afsi
);
2447 para_printf(acad
->pb
, "cannot get afsi\n");
2450 bad_bits
= afsi
.attributes
& ~acad
->att_mask
;
2451 if (bad_bits
== 0) /* OK */
2453 ret
= get_audio_file_path_of_row(row
, &path
);
2455 para_printf(acad
->pb
, "cannot get path\n");
2458 para_printf(acad
->pb
, "invalid attribute bits (%" PRIu64
"): %s\n",
2460 /* return success to keep looping */
2465 * Iterate over all audio files and check the attribute bit mask.
2467 * \param att_mask The mask of all valid attributes.
2468 * \param pb Used for reporting inconsistencies.
2470 * This reads the attribute bit mask of each audio file from the afs info
2471 * structure stored in the audio file table and verifies that all set bits are
2472 * also turned on in \a att_mask, i.e., correspond to an attribute of the
2473 * attribute table. Audio files for which this is not the case are reported via
2476 * \return Standard. Inconsistencies are not regarded as errors.
2478 * \sa \ref attribute_check_callback().
2480 int aft_check_attributes(uint64_t att_mask
, struct para_buffer
*pb
)
2482 struct aft_check_atts_data acad
= {.att_mask
= att_mask
, .pb
= pb
};
2484 para_printf(pb
, "checking attributes, mask: %" PRIx64
"\n", att_mask
);
2485 return audio_file_loop(&acad
, check_atts_of_audio_file
);
2489 * This sets audio_file_table to NULL, but leaves current_aft_row unmodified,
2490 * though stale (pointing to unmapped memory). If the table is being closed
2491 * because we received SIGHUP, the table will be reopened after the config file
2492 * has been reloaded. We remember the hash of the current audio file here so
2493 * that aft_open() can initialize current_aft_row by looking up the saved hash.
2495 static void aft_close(void)
2500 if (current_aft_row
) {
2501 ret
= get_hash_of_row(current_aft_row
, &p
);
2503 PARA_WARNING_LOG("hash lookup failure\n");
2504 current_aft_row
= NULL
;
2506 memcpy(current_hash
, p
, HASH_SIZE
);
2508 osl_close_table(audio_file_table
, OSL_MARK_CLEAN
);
2509 audio_file_table
= NULL
;
2512 static int aft_open(const char *dir
)
2516 audio_file_table_desc
.dir
= dir
;
2517 ret
= osl(osl_open_table(&audio_file_table_desc
, &audio_file_table
));
2520 osl_get_num_rows(audio_file_table
, &num
);
2521 PARA_INFO_LOG("audio file table contains %u files\n", num
);
2522 if (!current_aft_row
) {
2523 PARA_DEBUG_LOG("no current aft row\n");
2526 /* SIGHUP case, update current_aft_row */
2527 ret
= aft_get_row_of_hash(current_hash
, ¤t_aft_row
);
2528 if (ret
< 0) { /* not fatal */
2529 PARA_WARNING_LOG("current hash lookup failure: %s\n",
2530 para_strerror(-ret
));
2531 current_aft_row
= NULL
;
2534 PARA_NOTICE_LOG("current audio file hash lookup: success\n");
2537 audio_file_table
= NULL
;
2538 if (ret
== -OSL_ERRNO_TO_PARA_ERROR(E_OSL_NOENT
)) {
2539 PARA_WARNING_LOG("no audio file table\n");
2542 PARA_NOTICE_LOG("failed to open audio file table\n");
2546 static int aft_create(const char *dir
)
2548 audio_file_table_desc
.dir
= dir
;
2549 return osl(osl_create_table(&audio_file_table_desc
));
2552 static int clear_attribute(struct osl_row
*row
, void *data
)
2554 struct rmatt_event_data
*red
= data
;
2555 struct afs_info afsi
;
2556 struct osl_object obj
;
2557 int ret
= get_afsi_object_of_row(row
, &obj
);
2558 uint64_t mask
= ~(1ULL << red
->bitnum
);
2562 ret
= load_afsi(&afsi
, &obj
);
2565 afsi
.attributes
&= mask
;
2566 save_afsi(&afsi
, &obj
);
2570 static int aft_event_handler(enum afs_events event
, struct para_buffer
*pb
,
2576 case ATTRIBUTE_REMOVE
: {
2577 const struct rmatt_event_data
*red
= data
;
2578 para_printf(pb
, "clearing attribute %s (bit %u) from all "
2579 "entries in the audio file table\n", red
->name
,
2581 return audio_file_loop(data
, clear_attribute
);
2582 } case AFSI_CHANGE
: {
2583 struct afsi_change_event_data
*aced
= data
;
2584 uint64_t old_last_played
= status_item_ls_data
.afsi
.last_played
;
2585 if (aced
->aft_row
!= current_aft_row
)
2587 ret
= get_afsi_of_row(aced
->aft_row
, &status_item_ls_data
.afsi
);
2590 status_item_ls_data
.afsi
.last_played
= old_last_played
;
2591 make_status_items();
2593 } case AUDIO_FILE_RENAME
: {
2595 if (data
!= current_aft_row
)
2597 ret
= get_audio_file_path_of_row(current_aft_row
, &path
);
2600 free(status_item_ls_data
.path
);
2601 status_item_ls_data
.path
= para_strdup(path
);
2602 make_status_items();
2604 } case AFHI_CHANGE
: {
2605 if (data
!= current_aft_row
)
2607 ret
= get_afhi_of_row(data
, &status_item_ls_data
.afhi
);
2610 make_status_items();
2612 } case AUDIO_FILE_REMOVE
: {
2613 if (data
== current_aft_row
)
2614 current_aft_row
= NULL
;
2621 * These events are rare. We don't bother to check whether the
2622 * current status items are affected and simply recreate them
2625 ret
= get_afhi_of_row(current_aft_row
,
2626 &status_item_ls_data
.afhi
);
2629 make_status_items();
2637 * Initialize the audio file table.
2639 * \param t Pointer to the structure to be initialized.
2641 void aft_init(struct afs_table
*t
)
2644 t
->close
= aft_close
;
2645 t
->create
= aft_create
;
2646 t
->event_handler
= aft_event_handler
;