2 * This file is part of DisOrder.
3 * Copyright (C) 2004-2008 Richard Kettlewell
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful, but
11 * WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * General Public License for more details.
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the Free Software
17 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
20 /** @file server/macros-disorder.c
21 * @brief DisOrder-specific expansions
24 #include "disorder-cgi.h"
26 /** @brief For error template */
27 char *dcgi_error_string
;
29 /** @brief For login template */
30 char *dcgi_status_string
;
32 /** @brief Return @p i as a string */
33 static const char *make_index(int i
) {
36 byte_xasprintf(&s
, "%d", i
);
42 * Expands to the server's version string, or a (safe to use) error
43 * value if the server is unavailable or broken.
45 static int exp_server_version(int attribute((unused
)) nargs
,
46 char attribute((unused
)) **args
,
48 void attribute((unused
)) *u
) {
52 if(disorder_version(dcgi_client
, (char **)&v
))
53 v
= "(cannot get version)";
55 v
= "(server not running)";
56 return sink_writes(output
, cgi_sgmlquote(v
)) < 0 ?
-1 : 0;
61 * Expands to the local version string.
63 static int exp_version(int attribute((unused
)) nargs
,
64 char attribute((unused
)) **args
,
66 void attribute((unused
)) *u
) {
67 return sink_writes(output
,
68 cgi_sgmlquote(disorder_short_version_string
)) < 0 ?
-1 : 0;
73 * Expands to the base URL of the web interface.
75 static int exp_url(int attribute((unused
)) nargs
,
76 char attribute((unused
)) **args
,
78 void attribute((unused
)) *u
) {
79 return sink_writes(output
,
80 cgi_sgmlquote(config
->url
)) < 0 ?
-1 : 0;
85 * Expands to the UNQUOTED form of CGI argument NAME, or the empty string if
86 * there is no such argument. Use @argq for a quick way to quote the argument.
88 static int exp_arg(int attribute((unused
)) nargs
,
91 void attribute((unused
)) *u
) {
92 const char *s
= cgi_get(args
[0]);
95 return sink_writes(output
, s
) < 0 ?
-1 : 0;
102 * Expands to the (quoted) form of CGI argument NAME, or the empty string if
103 * there is no such argument. Use @arg for the unquoted argument.
105 static int exp_argq(int attribute((unused
)) nargs
,
108 void attribute((unused
)) *u
) {
109 const char *s
= cgi_get(args
[0]);
112 return sink_writes(output
, cgi_sgmlquote(s
)) < 0 ?
-1 : 0;
119 * Expands to the logged-in username (which might be "guest"), or to
120 * the empty string if not connected.
122 static int exp_user(int attribute((unused
)) nargs
,
123 char attribute((unused
)) **args
,
125 void attribute((unused
)) *u
) {
128 if(dcgi_client
&& (user
= disorder_user(dcgi_client
)))
129 return sink_writes(output
, cgi_sgmlquote(user
)) < 0 ?
-1 : 0;
133 /* @part{TRACK|ID}{PART}{CONTEXT}
135 * Expands to a track name part.
137 * A track may be identified by name or by queue ID.
139 * CONTEXT may be omitted. If it is then 'display' is assumed.
141 * If the CONTEXT is 'short' then the 'display' part is looked up, and the
142 * result truncated according to the length defined by the short_display
143 * configuration directive.
145 static int exp_part(int nargs
,
148 void attribute((unused
)) *u
) {
149 const char *track
= args
[0], *part
= args
[1];
150 const char *context
= nargs
> 2 ? args
[2] : "display";
153 if(track
[0] != '/') {
154 struct queue_entry
*q
= dcgi_findtrack(track
);
161 fprintf(stderr
, "track=[%s] part=[%s] context=[%s] dcgi_client=[%p]\n",
164 !strcmp(context
, "short") ?
"display" : context
,
167 && !disorder_part(dcgi_client
, &s
,
169 !strcmp(context
, "short") ?
"display" : context
,
171 return sink_writes(output
, cgi_sgmlquote(s
)) < 0 ?
-1 : 0;
177 * SGML-quotes STRING. Note that most expansion results are already suitable
178 * quoted, so this expansion is usually not required.
180 static int exp_quote(int attribute((unused
)) nargs
,
183 void attribute((unused
)) *u
) {
184 return sink_writes(output
, cgi_sgmlquote(args
[0])) < 0 ?
-1 : 0;
189 * Expands to the name of the submitter of track ID, which must be a playing
190 * track, in the queue, or in the recent list.
192 static int exp_who(int attribute((unused
)) nargs
,
195 void attribute((unused
)) *u
) {
196 struct queue_entry
*q
= dcgi_findtrack(args
[0]);
198 if(q
&& q
->submitter
)
199 return sink_writes(output
, cgi_sgmlquote(q
->submitter
)) < 0 ?
-1 : 0;
205 * Expands to the time a track started or is expected to start. The track must
206 * be a playing track, in the queue, or in the recent list.
208 static int exp_when(int attribute((unused
)) nargs
,
211 void attribute((unused
)) *u
) {
212 struct queue_entry
*q
= dcgi_findtrack(args
[0]);
213 const struct tm
*w
= 0;
217 case playing_isscratch
:
218 case playing_unplayed
:
221 w
= localtime(&q
->expected
);
224 case playing_no_player
:
226 case playing_scratched
:
227 case playing_started
:
229 case playing_quitting
:
231 w
= localtime(&q
->played
);
235 return sink_printf(output
, "%d:%02d", w
->tm_hour
, w
->tm_min
) < 0 ?
-1 : 0;
237 return sink_writes(output
, " ") < 0 ?
-1 : 0;
242 * Expands to the length of a track, identified by its queue ID or its name.
243 * If it is the playing track (identified by ID) then the amount played so far
246 static int exp_length(int attribute((unused
)) nargs
,
249 void attribute((unused
)) *u
) {
250 struct queue_entry
*q
;
254 if(args
[0][0] == '/')
255 /* Track identified by name */
258 /* Track identified by queue ID */
259 if(!(q
= dcgi_findtrack(args
[0])))
261 if(q
->state
== playing_started
|| q
->state
== playing_paused
)
262 if(sink_printf(output
, "%ld:%02ld/", q
->sofar
/ 60, q
->sofar
% 60) < 0)
266 if(dcgi_client
&& disorder_length(dcgi_client
, name
, &length
))
267 return sink_printf(output
, "%ld:%02ld",
268 length
/ 60, length
% 60) < 0 ?
-1 : 0;
269 return sink_writes(output
, " ") < 0 ?
-1 : 0;
274 * Expands to "true" if track ID is removable (or scratchable, if it is the
275 * playing track) and "false" otherwise.
277 static int exp_removable(int attribute((unused
)) nargs
,
280 void attribute((unused
)) *u
) {
281 struct queue_entry
*q
= dcgi_findtrack(args
[0]);
282 /* TODO would be better to reject recent */
284 if(!q
|| !dcgi_client
)
285 return mx_bool_result(output
, 0);
286 dcgi_lookup(DCGI_RIGHTS
);
287 return mx_bool_result(output
,
288 (q
== dcgi_playing ? right_scratchable
: right_removable
)
289 (dcgi_rights
, disorder_user(dcgi_client
), q
));
294 * Expands to "true" if track ID is movable and "false" otherwise.
296 * DIR (which is optional) should be a non-zero integer. If it is negative
297 * then the intended move is down (later in the queue), if it is positive then
298 * the intended move is up (earlier in the queue). The first track is not
299 * movable up and the last track not movable down.
301 static int exp_movable(int nargs
,
304 void attribute((unused
)) *u
) {
305 struct queue_entry
*q
= dcgi_findtrack(args
[0]);
306 /* TODO would be better to recent playing/recent */
308 if(!q
|| !dcgi_client
)
309 return mx_bool_result(output
, 0);
311 const long dir
= atoi(args
[1]);
313 if(dir
> 0 && q
== dcgi_queue
)
314 return mx_bool_result(output
, 0);
315 if(dir
< 0 && q
->next
== 0)
316 return mx_bool_result(output
, 0);
318 dcgi_lookup(DCGI_RIGHTS
);
319 return mx_bool_result(output
,
320 right_movable(dcgi_rights
,
321 disorder_user(dcgi_client
),
325 /* @playing{TEMPLATE}
327 * Expands to TEMPLATE, with the following expansions:
328 * - @id: the queue ID of the playing track
329 * - @track: the playing track's
332 * If no track is playing expands to nothing.
334 * TEMPLATE is optional. If it is left out then instead expands to the queue
335 * ID of the playing track.
337 static int exp_playing(int nargs
,
338 const struct mx_node
**args
,
341 dcgi_lookup(DCGI_PLAYING
);
345 return sink_writes(output
, dcgi_playing
->id
) < 0 ?
-1 : 0;
346 return mx_expand(mx_rewritel(args
[0],
347 "id", dcgi_playing
->id
,
348 "track", dcgi_playing
->track
,
355 * For each track in the queue, expands TEMPLATE with the following expansions:
356 * - @id: the queue ID of the track
357 * - @track: the UNQUOTED track name
358 * - @index: the track number from 0
359 * - @parity: "even" or "odd" alternately
360 * - @first: "true" on the first track and "false" otherwise
361 * - @last: "true" on the last track and "false" otherwise
363 static int exp_queue(int attribute((unused
)) nargs
,
364 const struct mx_node
**args
,
367 struct queue_entry
*q
;
370 dcgi_lookup(DCGI_QUEUE
);
371 for(q
= dcgi_queue
, i
= 0; q
; q
= q
->next
, ++i
)
372 if((rc
= mx_expand(mx_rewritel(args
[0],
375 "index", make_index(i
),
376 "parity", i
% 2 ?
"odd" : "even",
377 "first", q
== dcgi_queue ?
"true" : "false",
378 "last", q
->next ?
"false" : "true",
387 * For each track in the recently played list, expands TEMPLATE with the
388 * following expansions:
389 * - @id: the queue ID of the track
390 * - @track: the UNQUOTED track name
391 * - @index: the track number from 0
392 * - @parity: "even" or "odd" alternately
393 * - @first: "true" on the first track and "false" otherwise
394 * - @last: "true" on the last track and "false" otherwise
396 static int exp_recent(int attribute((unused
)) nargs
,
397 const struct mx_node
**args
,
400 struct queue_entry
*q
;
403 dcgi_lookup(DCGI_RECENT
);
404 for(q
= dcgi_recent
, i
= 0; q
; q
= q
->next
, ++i
)
405 if((rc
= mx_expand(mx_rewritel(args
[0],
408 "index", make_index(i
),
409 "parity", i
% 2 ?
"odd" : "even",
410 "first", q
== dcgi_recent ?
"true" : "false",
411 "last", q
->next ?
"false" : "true",
420 * For each track in the newly added list, expands TEMPLATE wit the following
422 * - @track: the UNQUOTED track name
423 * - @index: the track number from 0
424 * - @parity: "even" or "odd" alternately
425 * - @first: "true" on the first track and "false" otherwise
426 * - @last: "true" on the last track and "false" otherwise
428 * Note that unlike @playing, @queue and @recent which are otherwise
429 * superficially similar, there is no @id sub-expansion here.
431 static int exp_new(int attribute((unused
)) nargs
,
432 const struct mx_node
**args
,
437 dcgi_lookup(DCGI_NEW
);
438 /* TODO perhaps we should generate an ID value for tracks in the new list */
439 for(i
= 0; i
< dcgi_nnew
; ++i
)
440 if((rc
= mx_expand(mx_rewritel(args
[0],
441 "track", dcgi_new
[i
],
442 "index", make_index(i
),
443 "parity", i
% 2 ?
"odd" : "even",
444 "first", i
== 0 ?
"true" : "false",
445 "last", i
== dcgi_nnew
- 1 ?
"false" : "true",
454 * Expands to the volume in a given channel. CHANNEL must be "left" or
457 static int exp_volume(int attribute((unused
)) nargs
,
460 void attribute((unused
)) *u
) {
461 dcgi_lookup(DCGI_VOLUME
);
462 return sink_printf(output
, "%d",
463 !strcmp(args
[0], "left")
464 ? dcgi_volume_left
: dcgi_volume_right
) < 0 ?
-1 : 0;
469 * Expands to "true" if there is a playing track, otherwise "false".
471 static int exp_isplaying(int attribute((unused
)) nargs
,
472 char attribute((unused
)) **args
,
474 void attribute((unused
)) *u
) {
475 dcgi_lookup(DCGI_PLAYING
);
476 return mx_bool_result(output
, !!dcgi_playing
);
481 * Expands to "true" if there the queue is nonempty, otherwise "false".
483 static int exp_isqueue(int attribute((unused
)) nargs
,
484 char attribute((unused
)) **args
,
486 void attribute((unused
)) *u
) {
487 dcgi_lookup(DCGI_QUEUE
);
488 return mx_bool_result(output
, !!dcgi_queue
);
493 * Expands to "true" if there the recently played list is nonempty, otherwise
496 static int exp_isrecent(int attribute((unused
)) nargs
,
497 char attribute((unused
)) **args
,
499 void attribute((unused
)) *u
) {
500 dcgi_lookup(DCGI_RECENT
);
501 return mx_bool_result(output
, !!dcgi_recent
);
506 * Expands to "true" if there the newly added track list is nonempty, otherwise
509 static int exp_isnew(int attribute((unused
)) nargs
,
510 char attribute((unused
)) **args
,
512 void attribute((unused
)) *u
) {
513 dcgi_lookup(DCGI_NEW
);
514 return mx_bool_result(output
, !!dcgi_nnew
);
519 * Expands to a track preference.
521 static int exp_pref(int attribute((unused
)) nargs
,
524 void attribute((unused
)) *u
) {
527 if(dcgi_client
&& !disorder_get(dcgi_client
, args
[0], args
[1], &value
))
528 return sink_writes(output
, cgi_sgmlquote(value
)) < 0 ?
-1 : 0;
532 /* @prefs{TRACK}{TEMPLATE}
534 * For each track preference of track TRACK, expands TEMPLATE with the
535 * following expansions:
536 * - @name: the UNQUOTED preference name
537 * - @index: the preference number from 0
538 * - @value: the UNQUOTED preference value
539 * - @parity: "even" or "odd" alternately
540 * - @first: "true" on the first preference and "false" otherwise
541 * - @last: "true" on the last preference and "false" otherwise
543 * Use @quote to quote preference names and values where necessary; see below.
545 static int exp_prefs(int attribute((unused
)) nargs
,
546 const struct mx_node
**args
,
550 struct kvp
*k
, *head
;
553 if((rc
= mx_expandstr(args
[0], &track
, u
, "argument #0 (TRACK)")))
555 if(!dcgi_client
|| disorder_prefs(dcgi_client
, track
, &head
))
557 for(k
= head
, i
= 0; k
; k
= k
->next
, ++i
)
558 if((rc
= mx_expand(mx_rewritel(args
[1],
559 "index", make_index(i
),
560 "parity", i
% 2 ?
"odd" : "even",
563 "first", k
== head ?
"true" : "false",
564 "last", k
->next ?
"false" : "true",
571 /* @transform{TRACK}{TYPE}{CONTEXT}
573 * Transforms a track name (if TYPE is "track") or directory name (if type is
574 * "dir"). CONTEXT should be the context, if it is left out then "display" is
577 static int exp_transform(int nargs
,
580 void attribute((unused
)) *u
) {
581 const char *t
= trackname_transform(args
[1], args
[0],
582 (nargs
> 2 ? args
[2] : "display"));
583 return sink_writes(output
, cgi_sgmlquote(t
)) < 0 ?
-1 : 0;
588 * Expands to "true" if playing is enabled, otherwise "false".
590 static int exp_enabled(int attribute((unused
)) nargs
,
591 char attribute((unused
)) **args
,
593 void attribute((unused
)) *u
) {
597 disorder_enabled(dcgi_client
, &e
);
598 return mx_bool_result(output
, e
);
603 * Expands to "true" if random play is enabled, otherwise "false".
605 static int exp_random_enabled(int attribute((unused
)) nargs
,
606 char attribute((unused
)) **args
,
608 void attribute((unused
)) *u
) {
612 disorder_random_enabled(dcgi_client
, &e
);
613 return mx_bool_result(output
, e
);
616 /* @trackstate{TRACK}
618 * Expands to "playing" if TRACK is currently playing, or "queue" if it is in
619 * the queue, otherwise to nothing.
621 static int exp_trackstate(int attribute((unused
)) nargs
,
624 void attribute((unused
)) *u
) {
626 struct queue_entry
*q
;
630 if(disorder_resolve(dcgi_client
, &track
, args
[0]))
632 dcgi_lookup(DCGI_PLAYING
);
633 if(dcgi_playing
&& !strcmp(track
, dcgi_playing
->track
))
634 return sink_writes(output
, "playing") < 0 ?
-1 : 0;
635 dcgi_lookup(DCGI_QUEUE
);
636 for(q
= dcgi_queue
; q
; q
= q
->next
)
637 if(!strcmp(track
, q
->track
))
638 return sink_writes(output
, "queued") < 0 ?
-1 : 0;
644 * Expands to an UNQUOTED URL which points back to the current page. (NB it
645 * might not be byte for byte identical - for instance, CGI arguments might be
648 static int exp_thisurl(int attribute((unused
)) nargs
,
649 char attribute((unused
)) **args
,
651 void attribute((unused
)) *u
) {
652 return sink_writes(output
, cgi_thisurl(config
->url
)) < 0 ?
-1 : 0;
657 * Expands to an UNQUOTED name for the TRACK that is not an alias, or to
658 * nothing if it is not a valid track.
660 static int exp_resolve(int attribute((unused
)) nargs
,
663 void attribute((unused
)) *u
) {
666 if(dcgi_client
&& !disorder_resolve(dcgi_client
, &r
, args
[0]))
667 return sink_writes(output
, r
) < 0 ?
-1 : 0;
673 * Expands to "true" if the playing track is paused, to "false" if it is
674 * playing (or if there is no playing track at all).
676 static int exp_paused(int attribute((unused
)) nargs
,
677 char attribute((unused
)) **args
,
679 void attribute((unused
)) *u
) {
680 dcgi_lookup(DCGI_PLAYING
);
681 return mx_bool_result(output
, (dcgi_playing
682 && dcgi_playing
->state
== playing_paused
));
687 * Expands to the current state of track ID.
689 static int exp_state(int attribute((unused
)) nargs
,
692 void attribute((unused
)) *u
) {
693 struct queue_entry
*q
= dcgi_findtrack(args
[0]);
696 return sink_writes(output
, playing_states
[q
->state
]) < 0 ?
-1 : 0;
700 /* @right{RIGHT}{WITH-RIGHT}{WITHOUT-RIGHT}@
702 * Expands to WITH-RIGHT if the current user has right RIGHT, otherwise to
703 * WITHOUT-RIGHT. The WITHOUT-RIGHT argument may be left out.
705 * If both WITH-RIGHT and WITHOUT-RIGHT are left out then expands to "true" if
706 * the user has the right and "false" otherwise.
708 * If there is no connection to the server then expands to nothing (in all
711 static int exp_right(int nargs
,
712 const struct mx_node
**args
,
721 dcgi_lookup(DCGI_RIGHTS
);
722 if((rc
= mx_expandstr(args
[0], &right
, u
, "argument #0 (RIGHT)")))
724 if(parse_rights(right
, &r
, 1/*report*/))
726 /* Single-argument form */
728 return mx_bool_result(output
, !!(r
& dcgi_rights
));
729 /* Multiple argument form */
731 return mx_expand(args
[1], output
, u
);
733 return mx_expand(args
[2], output
, u
);
737 /* @userinfo{PROPERTY}
739 * Expands to the named property of the current user.
741 static int exp_userinfo(int attribute((unused
)) nargs
,
744 void attribute((unused
)) *u
) {
748 && !disorder_userinfo(dcgi_client
, disorder_user(dcgi_client
),
750 return sink_writes(output
, v
) < 0 ?
-1 : 0;
756 * Expands to the latest error string.
758 static int exp_error(int attribute((unused
)) nargs
,
759 char attribute((unused
)) **args
,
761 void attribute((unused
)) *u
) {
762 return sink_writes(output
, dcgi_error_string ? dcgi_error_string
: "")
768 * Expands to the latest status string.
770 static int exp_status(int attribute((unused
)) nargs
,
771 char attribute((unused
)) **args
,
773 void attribute((unused
)) *u
) {
774 return sink_writes(output
, dcgi_status_string ? dcgi_status_string
: "")
780 * Expands to the URL of the image called NAME.
782 * Firstly if there is a label called images.NAME then the image stem will be
783 * the value of that label. Otherwise the stem will be NAME.png.
785 * If the label url.static exists then it will give the base URL for images.
786 * Otherwise the base url will be /disorder/.
788 static int exp_image(int attribute((unused
)) nargs
,
791 void attribute((unused
)) *u
) {
792 const char *url
, *stem
;
795 /* Compute the stem */
796 byte_xasprintf(&labelname
, "images.%s", args
[0]);
797 if(option_label_exists(labelname
))
798 stem
= option_label(labelname
);
800 byte_xasprintf((char **)&stem
, "%s.png", args
[0]);
801 /* If the stem looks like it's reasonalby complete, use that */
803 || !strncmp(stem
, "http:", 5)
804 || !strncmp(stem
, "https:", 6))
807 /* Compute the URL */
808 if(option_label_exists("url.static"))
809 byte_xasprintf((char **)&url
, "%s/%s",
810 option_label("url.static"), stem
);
812 /* Default base is /disorder */
813 byte_xasprintf((char **)&url
, "/disorder/%s", stem
);
815 return sink_writes(output
, cgi_sgmlquote(url
)) < 0 ?
-1 : 0;
818 /** @brief Entry in a list of tracks or directories */
820 /** @brief Track name */
822 /** @brief Sort key */
824 /** @brief Display key */
828 /** @brief Compare two @ref entry objects */
829 static int compare_entry(const void *a
, const void *b
) {
830 const struct entry
*ea
= a
, *eb
= b
;
832 return compare_tracks(ea
->sort
, eb
->sort
,
833 ea
->display
, eb
->display
,
834 ea
->track
, eb
->track
);
837 /** @brief Implementation of exp_tracks() and exp_dirs() */
838 static int exp__files_dirs(int nargs
,
839 const struct mx_node
**args
,
843 int (*fn
)(disorder_client
*client
,
848 char **tracks
, *dir
, *re
;
850 const struct mx_node
*m
;
853 if((rc
= mx_expandstr(args
[0], &dir
, u
, "argument #0 (DIR)")))
856 if((rc
= mx_expandstr(args
[1], &re
, u
, "argument #1 (RE)")))
866 if(fn(dcgi_client
, dir
, re
, &tracks
, &ntracks
))
868 /* Sort it. NB trackname_transform() does not go to the server. */
869 e
= xcalloc(ntracks
, sizeof *e
);
870 for(n
= 0; n
< ntracks
; ++n
) {
871 e
->track
= tracks
[n
];
872 e
[n
].track
= tracks
[n
];
873 e
[n
].sort
= trackname_transform(type
, tracks
[n
], "sort");
874 e
[n
].display
= trackname_transform(type
, tracks
[n
], "display");
876 qsort(e
, ntracks
, sizeof (struct entry
), compare_entry
);
877 /* Expand the subsiduary templates. We chuck in @sort and @display because
878 * it is particularly easy to do so. */
879 for(n
= 0; n
< ntracks
; ++n
)
880 if((rc
= mx_expand(mx_rewritel(m
,
881 "index", make_index(n
),
882 "parity", n
% 2 ?
"odd" : "even",
884 "first", n
== 0 ?
"true" : "false",
885 "last", n
+ 1 == ntracks ?
"false" : "true",
887 "display", e
[n
].display
,
895 /** @tracks{DIR}{RE}{TEMPLATE}
897 * For each track below DIR, expands TEMPLATE with the
898 * following expansions:
899 * - @track: the UNQUOTED track name
900 * - @index: the track number from 0
901 * - @parity: "even" or "odd" alternately
902 * - @first: "true" on the first track and "false" otherwise
903 * - @last: "true" on the last track and "false" otherwise
904 * - @sort: the sort key for this track
905 * - @display: the UNQUOTED display string for this track
907 * RE is optional and if present is the regexp to match against.
909 static int exp_tracks(int nargs
,
910 const struct mx_node
**args
,
913 return exp__files_dirs(nargs
, args
, output
, u
, "track", disorder_files
);
916 /** @dirs{DIR}{RE}{TEMPLATE}
918 * For each directory below DIR, expands TEMPLATE with the
919 * following expansions:
920 * - @track: the UNQUOTED directory name
921 * - @index: the directory number from 0
922 * - @parity: "even" or "odd" alternately
923 * - @first: "true" on the first directory and "false" otherwise
924 * - @last: "true" on the last directory and "false" otherwise
925 * - @sort: the sort key for this directory
926 * - @display: the UNQUOTED display string for this directory
928 * RE is optional and if present is the regexp to match against.
930 static int exp_dirs(int nargs
,
931 const struct mx_node
**args
,
934 return exp__files_dirs(nargs
, args
, output
, u
, "dir", disorder_directories
);
937 static int exp__search_shim(disorder_client
*c
, const char *terms
,
938 const char attribute((unused
)) *re
,
939 char ***vecp
, int *nvecp
) {
940 return disorder_search(c
, terms
, vecp
, nvecp
);
943 /** @search{KEYWORDS}{TEMPLATE}
945 * For each track matching KEYWORDS, expands TEMPLATE with the
946 * following expansions:
947 * - @track: the UNQUOTED directory name
948 * - @index: the directory number from 0
949 * - @parity: "even" or "odd" alternately
950 * - @first: "true" on the first directory and "false" otherwise
951 * - @last: "true" on the last directory and "false" otherwise
952 * - @sort: the sort key for this track
953 * - @display: the UNQUOTED display string for this track
955 static int exp_search(int nargs
,
956 const struct mx_node
**args
,
959 return exp__files_dirs(nargs
, args
, output
, u
, "track", exp__search_shim
);
962 static int exp_label(int attribute((unused
)) nargs
,
965 void attribute((unused
)) *u
) {
966 return sink_writes(output
, option_label(args
[0])) < 0 ?
-1 : 0;
969 /** @brief Register DisOrder-specific expansions */
970 void dcgi_expansions(void) {
971 mx_register("arg", 1, 1, exp_arg
);
972 mx_register("argq", 1, 1, exp_argq
);
973 mx_register("enabled", 0, 0, exp_enabled
);
974 mx_register("error", 0, 0, exp_error
);
975 mx_register("image", 1, 1, exp_image
);
976 mx_register("isnew", 0, 0, exp_isnew
);
977 mx_register("isplaying", 0, 0, exp_isplaying
);
978 mx_register("isqueue", 0, 0, exp_isqueue
);
979 mx_register("isrecent", 0, 0, exp_isrecent
);
980 mx_register("label", 1, 1, exp_label
);
981 mx_register("length", 1, 1, exp_length
);
982 mx_register("movable", 1, 2, exp_movable
);
983 mx_register("part", 2, 3, exp_part
);
984 mx_register("paused", 0, 0, exp_paused
);
985 mx_register("pref", 2, 2, exp_pref
);
986 mx_register("quote", 1, 1, exp_quote
);
987 mx_register("random-enabled", 0, 0, exp_random_enabled
);
988 mx_register("removable", 1, 1, exp_removable
);
989 mx_register("resolve", 1, 1, exp_resolve
);
990 mx_register("server-version", 0, 0, exp_server_version
);
991 mx_register("state", 1, 1, exp_state
);
992 mx_register("status", 0, 0, exp_status
);
993 mx_register("thisurl", 0, 0, exp_thisurl
);
994 mx_register("trackstate", 1, 1, exp_trackstate
);
995 mx_register("transform", 2, 3, exp_transform
);
996 mx_register("url", 0, 0, exp_url
);
997 mx_register("user", 0, 0, exp_user
);
998 mx_register("userinfo", 1, 1, exp_userinfo
);
999 mx_register("version", 0, 0, exp_version
);
1000 mx_register("volume", 1, 1, exp_volume
);
1001 mx_register("when", 1, 1, exp_when
);
1002 mx_register("who", 1, 1, exp_who
);
1003 mx_register_magic("dirs", 2, 3, exp_dirs
);
1004 mx_register_magic("new", 1, 1, exp_new
);
1005 mx_register_magic("playing", 0, 1, exp_playing
);
1006 mx_register_magic("prefs", 2, 2, exp_prefs
);
1007 mx_register_magic("queue", 1, 1, exp_queue
);
1008 mx_register_magic("recent", 1, 1, exp_recent
);
1009 mx_register_magic("right", 1, 3, exp_right
);
1010 mx_register_magic("search", 2, 2, exp_search
);
1011 mx_register_magic("tracks", 2, 3, exp_tracks
);
1019 indent-tabs-mode:nil