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 Return @p i as a string */
30 static const char *make_index(int i
) {
33 byte_xasprintf(&s
, "%d", i
);
39 * Expands to the server's version string, or a (safe to use) error
40 * value if the server is unavailable or broken.
42 static int exp_server_version(int attribute((unused
)) nargs
,
43 char attribute((unused
)) **args
,
45 void attribute((unused
)) *u
) {
49 if(disorder_version(dcgi_client
, (char **)&v
))
50 v
= "(cannot get version)";
52 v
= "(server not running)";
53 return sink_writes(output
, cgi_sgmlquote(v
)) < 0 ?
-1 : 0;
58 * Expands to the local version string.
60 static int exp_version(int attribute((unused
)) nargs
,
61 char attribute((unused
)) **args
,
63 void attribute((unused
)) *u
) {
64 return sink_writes(output
,
65 cgi_sgmlquote(disorder_short_version_string
)) < 0 ?
-1 : 0;
70 * Expands to the base URL of the web interface.
72 static int exp_url(int attribute((unused
)) nargs
,
73 char attribute((unused
)) **args
,
75 void attribute((unused
)) *u
) {
76 return sink_writes(output
,
77 cgi_sgmlquote(config
->url
)) < 0 ?
-1 : 0;
82 * Expands to the UNQUOTED form of CGI argument NAME, or the empty string if
83 * there is no such argument. Use @argq for a quick way to quote the argument.
85 static int exp_arg(int attribute((unused
)) nargs
,
88 void attribute((unused
)) *u
) {
89 const char *s
= cgi_get(args
[0]);
92 return sink_writes(output
, s
) < 0 ?
-1 : 0;
99 * Expands to the (quoted) form of CGI argument NAME, or the empty string if
100 * there is no such argument. Use @arg for the unquoted argument.
102 static int exp_argq(int attribute((unused
)) nargs
,
105 void attribute((unused
)) *u
) {
106 const char *s
= cgi_get(args
[0]);
109 return sink_writes(output
, cgi_sgmlquote(s
)) < 0 ?
-1 : 0;
116 * Expands to the logged-in username (which might be "guest"), or to
117 * the empty string if not connected.
119 static int exp_user(int attribute((unused
)) nargs
,
120 char attribute((unused
)) **args
,
122 void attribute((unused
)) *u
) {
125 if(dcgi_client
&& (user
= disorder_user(dcgi_client
)))
126 return sink_writes(output
, cgi_sgmlquote(user
)) < 0 ?
-1 : 0;
130 /* @part{TRACK|ID}{PART}{CONTEXT}
132 * Expands to a track name part.
134 * A track may be identified by name or by queue ID.
136 * CONTEXT may be omitted. If it is then 'display' is assumed.
138 * If the CONTEXT is 'short' then the 'display' part is looked up, and the
139 * result truncated according to the length defined by the short_display
140 * configuration directive.
142 static int exp_part(int nargs
,
145 void attribute((unused
)) *u
) {
146 const char *track
= args
[0], *part
= args
[1];
147 const char *context
= nargs
> 2 ? args
[2] : "display";
150 if(track
[0] != '/') {
151 struct queue_entry
*q
= dcgi_findtrack(track
);
159 && !disorder_part(dcgi_client
, &s
,
161 !strcmp(context
, "short") ?
"display" : context
,
163 return sink_writes(output
, cgi_sgmlquote(s
)) < 0 ?
-1 : 0;
169 * SGML-quotes STRING. Note that most expansion results are already suitable
170 * quoted, so this expansion is usually not required.
172 static int exp_quote(int attribute((unused
)) nargs
,
175 void attribute((unused
)) *u
) {
176 return sink_writes(output
, cgi_sgmlquote(args
[0])) < 0 ?
-1 : 0;
181 * Expands to the name of the submitter of track ID, which must be a playing
182 * track, in the queue, or in the recent list.
184 static int exp_who(int attribute((unused
)) nargs
,
187 void attribute((unused
)) *u
) {
188 struct queue_entry
*q
= dcgi_findtrack(args
[0]);
190 if(q
&& q
->submitter
)
191 return sink_writes(output
, cgi_sgmlquote(q
->submitter
)) < 0 ?
-1 : 0;
197 * Expands to the time a track started or is expected to start. The track must
198 * be a playing track, in the queue, or in the recent list.
200 static int exp_when(int attribute((unused
)) nargs
,
203 void attribute((unused
)) *u
) {
204 struct queue_entry
*q
= dcgi_findtrack(args
[0]);
205 const struct tm
*w
= 0;
209 case playing_isscratch
:
210 case playing_unplayed
:
213 w
= localtime(&q
->expected
);
216 case playing_no_player
:
218 case playing_scratched
:
219 case playing_started
:
221 case playing_quitting
:
223 w
= localtime(&q
->played
);
227 return sink_printf(output
, "%d:%02d", w
->tm_hour
, w
->tm_min
) < 0 ?
-1 : 0;
229 return sink_writes(output
, " ") < 0 ?
-1 : 0;
234 * Expands to the length of a track, identified by its queue ID or its name.
235 * If it is the playing track (identified by ID) then the amount played so far
238 static int exp_length(int attribute((unused
)) nargs
,
241 void attribute((unused
)) *u
) {
242 struct queue_entry
*q
;
246 if(args
[0][0] == '/')
247 /* Track identified by name */
250 /* Track identified by queue ID */
251 if(!(q
= dcgi_findtrack(args
[0])))
253 if(q
->state
== playing_started
|| q
->state
== playing_paused
)
254 if(sink_printf(output
, "%ld:%02ld/", q
->sofar
/ 60, q
->sofar
% 60) < 0)
258 if(dcgi_client
&& disorder_length(dcgi_client
, name
, &length
))
259 return sink_printf(output
, "%ld:%02ld",
260 length
/ 60, length
% 60) < 0 ?
-1 : 0;
261 return sink_writes(output
, " ") < 0 ?
-1 : 0;
266 * Expands to "true" if track ID is removable (or scratchable, if it is the
267 * playing track) and "false" otherwise.
269 static int exp_removable(int attribute((unused
)) nargs
,
272 void attribute((unused
)) *u
) {
273 struct queue_entry
*q
= dcgi_findtrack(args
[0]);
274 /* TODO would be better to reject recent */
276 if(!q
|| !dcgi_client
)
277 return mx_bool_result(output
, 0);
278 dcgi_lookup(DCGI_RIGHTS
);
279 return mx_bool_result(output
,
280 (q
== dcgi_playing ? right_scratchable
: right_removable
)
281 (dcgi_rights
, disorder_user(dcgi_client
), q
));
286 * Expands to "true" if track ID is movable and "false" otherwise.
288 * DIR (which is optional) should be a non-zero integer. If it is negative
289 * then the intended move is down (later in the queue), if it is positive then
290 * the intended move is up (earlier in the queue). The first track is not
291 * movable up and the last track not movable down.
293 static int exp_movable(int nargs
,
296 void attribute((unused
)) *u
) {
297 struct queue_entry
*q
= dcgi_findtrack(args
[0]);
298 /* TODO would be better to recent playing/recent */
300 if(!q
|| !dcgi_client
)
301 return mx_bool_result(output
, 0);
303 const long dir
= atoi(args
[1]);
305 if(dir
> 0 && q
== dcgi_queue
)
306 return mx_bool_result(output
, 0);
307 if(dir
< 0 && q
->next
== 0)
308 return mx_bool_result(output
, 0);
310 dcgi_lookup(DCGI_RIGHTS
);
311 return mx_bool_result(output
,
312 right_movable(dcgi_rights
,
313 disorder_user(dcgi_client
),
317 /* @playing{TEMPLATE}
319 * Expands to TEMPLATE, with:
320 * - @id expanded to the queue ID of the playing track
321 * - @track expanded to its UNQUOTED name
323 * If no track is playing expands to nothing.
325 * TEMPLATE is optional. If it is left out then instead expands to the queue
326 * ID of the playing track.
328 static int exp_playing(int nargs
,
329 const struct mx_node
**args
,
332 dcgi_lookup(DCGI_PLAYING
);
336 return sink_writes(output
, dcgi_playing
->id
) < 0 ?
-1 : 0;
337 return mx_expand(mx_rewritel(args
[0],
338 "id", dcgi_playing
->id
,
339 "track", dcgi_playing
->track
,
346 * For each track in the queue, expands TEMPLATE with the following expansions:
347 * - @id to the queue ID of the track
348 * - @track to the UNQUOTED track name
349 * - @index to the track number from 0
350 * - @parity to "even" or "odd" alternately
351 * - @first to "true" on the first track and "false" otherwise
352 * - @last to "true" on the last track and "false" otherwise
354 static int exp_queue(int attribute((unused
)) nargs
,
355 const struct mx_node
**args
,
358 struct queue_entry
*q
;
361 dcgi_lookup(DCGI_QUEUE
);
362 for(q
= dcgi_queue
, i
= 0; q
; q
= q
->next
, ++i
)
363 if((rc
= mx_expand(mx_rewritel(args
[0],
366 "index", make_index(i
),
367 "parity", i
% 2 ?
"odd" : "even",
368 "first", q
== dcgi_queue ?
"true" : "false",
369 "last", q
->next ?
"false" : "true",
378 * For each track in the recently played list, expands TEMPLATE with the
379 * following expansions:
380 * - @id to the queue ID of the track
381 * - @track to the UNQUOTED track name
382 * - @index to the track number from 0
383 * - @parity to "even" or "odd" alternately
384 * - @first to "true" on the first track and "false" otherwise
385 * - @last to "true" on the last track and "false" otherwise
387 static int exp_recent(int attribute((unused
)) nargs
,
388 const struct mx_node
**args
,
391 struct queue_entry
*q
;
394 dcgi_lookup(DCGI_RECENT
);
395 for(q
= dcgi_recent
, i
= 0; q
; q
= q
->next
, ++i
)
396 if((rc
= mx_expand(mx_rewritel(args
[0],
399 "index", make_index(i
),
400 "parity", i
% 2 ?
"odd" : "even",
401 "first", q
== dcgi_recent ?
"true" : "false",
402 "last", q
->next ?
"false" : "true",
411 * For each track in the newly added list, expands TEMPLATE wit the following
413 * - @track to the UNQUOTED track name
414 * - @index to the track number from 0
415 * - @parity to "even" or "odd" alternately
416 * - @first to "true" on the first track and "false" otherwise
417 * - @last to "true" on the last track and "false" otherwise
419 * Note that unlike @playing, @queue and @recent which are otherwise
420 * superficially similar, there is no @id sub-expansion here.
422 static int exp_new(int attribute((unused
)) nargs
,
423 const struct mx_node
**args
,
428 dcgi_lookup(DCGI_NEW
);
429 /* TODO perhaps we should generate an ID value for tracks in the new list */
430 for(i
= 0; i
< dcgi_nnew
; ++i
)
431 if((rc
= mx_expand(mx_rewritel(args
[0],
432 "track", dcgi_new
[i
],
433 "index", make_index(i
),
434 "parity", i
% 2 ?
"odd" : "even",
435 "first", i
== 0 ?
"true" : "false",
436 "last", i
== dcgi_nnew
- 1 ?
"false" : "true",
445 * Expands to the volume in a given channel. CHANNEL must be "left" or
448 static int exp_volume(int attribute((unused
)) nargs
,
451 void attribute((unused
)) *u
) {
452 dcgi_lookup(DCGI_VOLUME
);
453 return sink_printf(output
, "%d",
454 !strcmp(args
[0], "left")
455 ? dcgi_volume_left
: dcgi_volume_right
) < 0 ?
-1 : 0;
460 * Expands to "true" if there is a playing track, otherwise "false".
462 static int exp_isplaying(int attribute((unused
)) nargs
,
463 char attribute((unused
)) **args
,
465 void attribute((unused
)) *u
) {
466 dcgi_lookup(DCGI_PLAYING
);
467 return mx_bool_result(output
, !!dcgi_playing
);
472 * Expands to "true" if there the queue is nonempty, otherwise "false".
474 static int exp_isqueue(int attribute((unused
)) nargs
,
475 char attribute((unused
)) **args
,
477 void attribute((unused
)) *u
) {
478 dcgi_lookup(DCGI_QUEUE
);
479 return mx_bool_result(output
, !!dcgi_queue
);
484 * Expands to "true" if there the recently played list is nonempty, otherwise
487 static int exp_isrecent(int attribute((unused
)) nargs
,
488 char attribute((unused
)) **args
,
490 void attribute((unused
)) *u
) {
491 dcgi_lookup(DCGI_RECENT
);
492 return mx_bool_result(output
, !!dcgi_recent
);
497 * Expands to "true" if there the newly added track list is nonempty, otherwise
500 static int exp_isnew(int attribute((unused
)) nargs
,
501 char attribute((unused
)) **args
,
503 void attribute((unused
)) *u
) {
504 dcgi_lookup(DCGI_NEW
);
505 return mx_bool_result(output
, !!dcgi_nnew
);
510 * Expands to a track preference.
512 static int exp_pref(int attribute((unused
)) nargs
,
515 void attribute((unused
)) *u
) {
518 if(dcgi_client
&& !disorder_get(dcgi_client
, args
[0], args
[1], &value
))
519 return sink_writes(output
, cgi_sgmlquote(value
)) < 0 ?
-1 : 0;
523 /* @prefs{TRACK}{TEMPLATE}
525 * For each track preference of track TRACK, expands TEMPLATE with the
526 * following expansions:
527 * - @name to the UNQUOTED preference name
528 * - @index to the preference number from 0
529 * - @value to the UNQUOTED preference value
530 * - @parity to "even" or "odd" alternately
531 * - @first to "true" on the first preference and "false" otherwise
532 * - @last to "true" on the last preference and "false" otherwise
534 * Use @quote to quote preference names and values where necessary; see below.
536 static int exp_prefs(int attribute((unused
)) nargs
,
537 const struct mx_node
**args
,
541 struct kvp
*k
, *head
;
544 if((rc
= mx_expandstr(args
[0], &track
, u
, "argument #0 (TRACK)")))
546 if(!dcgi_client
|| disorder_prefs(dcgi_client
, track
, &head
))
548 for(k
= head
, i
= 0; k
; k
= k
->next
, ++i
)
549 if((rc
= mx_expand(mx_rewritel(args
[1],
550 "index", make_index(i
),
551 "parity", i
% 2 ?
"odd" : "even",
554 "first", k
== head ?
"true" : "false",
555 "last", k
->next ?
"false" : "true",
562 /* @transform{TRACK}{TYPE}{CONTEXT}
564 * Transforms a track name (if TYPE is "track") or directory name (if type is
565 * "dir"). CONTEXT should be the context, if it is left out then "display" is
568 static int exp_transform(int nargs
,
571 void attribute((unused
)) *u
) {
572 const char *t
= trackname_transform(args
[1], args
[0],
573 (nargs
> 2 ? args
[2] : "display"));
574 return sink_writes(output
, cgi_sgmlquote(t
)) < 0 ?
-1 : 0;
579 * Expands to "true" if playing is enabled, otherwise "false".
581 static int exp_enabled(int attribute((unused
)) nargs
,
582 char attribute((unused
)) **args
,
584 void attribute((unused
)) *u
) {
588 disorder_enabled(dcgi_client
, &e
);
589 return mx_bool_result(output
, e
);
594 * Expands to "true" if random play is enabled, otherwise "false".
596 static int exp_random_enabled(int attribute((unused
)) nargs
,
597 char attribute((unused
)) **args
,
599 void attribute((unused
)) *u
) {
603 disorder_random_enabled(dcgi_client
, &e
);
604 return mx_bool_result(output
, e
);
607 /* @trackstate{TRACK}
609 * Expands to "playing" if TRACK is currently playing, or "queue" if it is in
610 * the queue, otherwise to nothing.
612 static int exp_trackstate(int attribute((unused
)) nargs
,
615 void attribute((unused
)) *u
) {
617 struct queue_entry
*q
;
621 if(disorder_resolve(dcgi_client
, &track
, args
[0]))
623 dcgi_lookup(DCGI_PLAYING
);
624 if(dcgi_playing
&& !strcmp(track
, dcgi_playing
->track
))
625 return sink_writes(output
, "playing") < 0 ?
-1 : 0;
626 dcgi_lookup(DCGI_QUEUE
);
627 for(q
= dcgi_queue
; q
; q
= q
->next
)
628 if(!strcmp(track
, q
->track
))
629 return sink_writes(output
, "queued") < 0 ?
-1 : 0;
635 * Expands to an UNQUOTED URL which points back to the current page. (NB it
636 * might not be byte for byte identical - for instance, CGI arguments might be
639 static int exp_thisurl(int attribute((unused
)) nargs
,
640 char attribute((unused
)) **args
,
642 void attribute((unused
)) *u
) {
643 return sink_writes(output
, cgi_thisurl(config
->url
)) < 0 ?
-1 : 0;
648 * Expands to an UNQUOTED name for the TRACK that is not an alias, or to
649 * nothing if it is not a valid track.
651 static int exp_resolve(int attribute((unused
)) nargs
,
654 void attribute((unused
)) *u
) {
657 if(dcgi_client
&& !disorder_resolve(dcgi_client
, &r
, args
[0]))
658 return sink_writes(output
, r
) < 0 ?
-1 : 0;
664 * Expands to "true" if the playing track is paused, to "false" if it is
665 * playing (or if there is no playing track at all).
667 static int exp_paused(int attribute((unused
)) nargs
,
668 char attribute((unused
)) **args
,
670 void attribute((unused
)) *u
) {
671 dcgi_lookup(DCGI_PLAYING
);
672 return mx_bool_result(output
, (dcgi_playing
673 && dcgi_playing
->state
== playing_paused
));
678 * Expands to the current state of track ID.
680 static int exp_state(int attribute((unused
)) nargs
,
683 void attribute((unused
)) *u
) {
684 struct queue_entry
*q
= dcgi_findtrack(args
[0]);
687 return sink_writes(output
, playing_states
[q
->state
]) < 0 ?
-1 : 0;
691 /* @right{RIGHT}{WITH-RIGHT}{WITHOUT-RIGHT}@
693 * Expands to WITH-RIGHT if the current user has right RIGHT, otherwise to
694 * WITHOUT-RIGHT. The WITHOUT-RIGHT argument may be left out.
696 * If both WITH-RIGHT and WITHOUT-RIGHT are left out then expands to "true" if
697 * the user has the right and "false" otherwise.
699 * If there is no connection to the server then expands to nothing (in all
702 static int exp_right(int nargs
,
703 const struct mx_node
**args
,
712 dcgi_lookup(DCGI_RIGHTS
);
713 if((rc
= mx_expandstr(args
[0], &right
, u
, "argument #0 (RIGHT)")))
715 if(parse_rights(right
, &r
, 1/*report*/))
717 /* Single-argument form */
719 return mx_bool_result(output
, !!(r
& dcgi_rights
));
720 /* Multiple argument form */
722 return mx_expand(args
[1], output
, u
);
724 return mx_expand(args
[2], output
, u
);
728 /* @userinfo{PROPERTY}
730 * Expands to the named property of the current user.
732 static int exp_userinfo(int attribute((unused
)) nargs
,
735 void attribute((unused
)) *u
) {
739 && !disorder_userinfo(dcgi_client
, disorder_user(dcgi_client
),
741 return sink_writes(output
, v
) < 0 ?
-1 : 0;
747 * Expands to the latest error string.
749 static int exp_error(int attribute((unused
)) nargs
,
750 char attribute((unused
)) **args
,
752 void attribute((unused
)) *u
) {
753 return sink_writes(output
, dcgi_error_string
) < 0 ?
-1 : 0;
758 * Expands to the URL of the image called NAME.
760 * Firstly if there is a label called images.NAME then the image stem will be
761 * the value of that label. Otherwise the stem will be NAME.png.
763 * If the label url.static exists then it will give the base URL for images.
764 * Otherwise the base url will be /disorder/.
766 static int exp_image(int attribute((unused
)) nargs
,
769 void attribute((unused
)) *u
) {
770 const char *url
, *stem
;
773 /* Compute the stem */
774 byte_xasprintf(&labelname
, "images.%s", args
[0]);
775 if(option_label_exists(labelname
))
776 stem
= option_label(labelname
);
778 byte_xasprintf((char **)&stem
, "%s.png", args
[0]);
779 /* If the stem looks like it's reasonalby complete, use that */
781 || !strncmp(stem
, "http:", 5)
782 || !strncmp(stem
, "https:", 6))
785 /* Compute the URL */
786 if(option_label_exists("url.static"))
787 byte_xasprintf((char **)&url
, "%s/%s",
788 option_label("url.static"), stem
);
790 /* Default base is /disorder */
791 byte_xasprintf((char **)&url
, "/disorder/%s", stem
);
793 return sink_writes(output
, cgi_sgmlquote(url
)) < 0 ?
-1 : 0;
796 /** @brief Entry in a list of tracks or directories */
798 /** @brief Track name */
800 /** @brief Sort key */
802 /** @brief Display key */
806 /** @brief Compare two @ref entry objects */
807 static int compare_entry(const void *a
, const void *b
) {
808 const struct entry
*ea
= a
, *eb
= b
;
810 return compare_tracks(ea
->sort
, eb
->sort
,
811 ea
->display
, eb
->display
,
812 ea
->track
, eb
->track
);
815 /** @brief Implementation of exp_tracks() and exp_dirs() */
816 static int exp__files_dirs(int nargs
,
817 const struct mx_node
**args
,
821 int (*fn
)(disorder_client
*client
,
826 char **tracks
, *dir
, *re
;
828 const struct mx_node
*m
;
831 if((rc
= mx_expandstr(args
[0], &dir
, u
, "argument #0 (DIR)")))
834 if((rc
= mx_expandstr(args
[1], &re
, u
, "argument #1 (RE)")))
844 if(fn(dcgi_client
, dir
, re
, &tracks
, &ntracks
))
846 /* Sort it. NB trackname_transform() does not go to the server. */
847 e
= xcalloc(ntracks
, sizeof *e
);
848 for(n
= 0; n
< ntracks
; ++n
) {
849 e
->track
= tracks
[n
];
850 e
[n
].track
= tracks
[n
];
851 e
[n
].sort
= trackname_transform(type
, tracks
[n
], "sort");
852 e
[n
].display
= trackname_transform(type
, tracks
[n
], "display");
854 qsort(e
, ntracks
, sizeof (struct entry
), compare_entry
);
855 /* Expand the subsiduary templates. We chuck in @sort and @display because
856 * it is particularly easy to do so. */
857 for(n
= 0; n
< ntracks
; ++n
)
858 if((rc
= mx_expand(mx_rewritel(m
,
859 "index", make_index(n
),
860 "parity", n
% 2 ?
"odd" : "even",
862 "first", n
== 0 ?
"true" : "false",
863 "last", n
+ 1 == ntracks ?
"false" : "true",
865 "display", e
[n
].display
,
873 /** @tracks{DIR}{RE}{TEMPLATE}
875 * For each track below DIR, expands TEMPLATE with the
876 * following expansions:
877 * - @track to the UNQUOTED track name
878 * - @index to the track number from 0
879 * - @parity to "even" or "odd" alternately
880 * - @first to "true" on the first track and "false" otherwise
881 * - @last to "true" on the last track and "false" otherwise
882 * - @sort to the sort key for this track
883 * - @display to the UNQUOTED display string for this track
885 * RE is optional and if present is the regexp to match against.
887 static int exp_tracks(int nargs
,
888 const struct mx_node
**args
,
891 return exp__files_dirs(nargs
, args
, output
, u
, "track", disorder_files
);
894 /** @dirs{DIR}{RE}{TEMPLATE}
896 * For each directory below DIR, expands TEMPLATE with the
897 * following expansions:
898 * - @track to the UNQUOTED directory name
899 * - @index to the directory number from 0
900 * - @parity to "even" or "odd" alternately
901 * - @first to "true" on the first directory and "false" otherwise
902 * - @last to "true" on the last directory and "false" otherwise
903 * - @sort to the sort key for this directory
904 * - @display to the UNQUOTED display string for this directory
906 * RE is optional and if present is the regexp to match against.
908 static int exp_dirs(int nargs
,
909 const struct mx_node
**args
,
912 return exp__files_dirs(nargs
, args
, output
, u
, "dir", disorder_directories
);
915 static int exp__search_shim(disorder_client
*c
, const char *terms
,
916 const char attribute((unused
)) *re
,
917 char ***vecp
, int *nvecp
) {
918 return disorder_search(c
, terms
, vecp
, nvecp
);
921 /** @search{KEYWORDS}{TEMPLATE}
923 * For each track matching KEYWORDS, expands TEMPLATE with the
924 * following expansions:
925 * - @track to the UNQUOTED directory name
926 * - @index to the directory number from 0
927 * - @parity to "even" or "odd" alternately
928 * - @first to "true" on the first directory and "false" otherwise
929 * - @last to "true" on the last directory and "false" otherwise
930 * - @sort to the sort key for this track
931 * - @display to the UNQUOTED display string for this track
933 static int exp_search(int nargs
,
934 const struct mx_node
**args
,
937 return exp__files_dirs(nargs
, args
, output
, u
, "track", exp__search_shim
);
940 /** @brief Register DisOrder-specific expansions */
941 void dcgi_expansions(void) {
942 mx_register("arg", 1, 1, exp_arg
);
943 mx_register("argq", 1, 1, exp_argq
);
944 mx_register("enabled", 0, 0, exp_enabled
);
945 mx_register("error", 0, 0, exp_error
);
946 mx_register("image", 1, 1, exp_image
);
947 mx_register("isnew", 0, 0, exp_isnew
);
948 mx_register("isplaying", 0, 0, exp_isplaying
);
949 mx_register("isplaying", 0, 0, exp_isqueue
);
950 mx_register("isrecent", 0, 0, exp_isrecent
);
951 mx_register("length", 1, 1, exp_length
);
952 mx_register("movable", 1, 1, exp_movable
);
953 mx_register("part", 2, 3, exp_part
);
954 mx_register("paused", 0, 0, exp_paused
);
955 mx_register("pref", 2, 2, exp_pref
);
956 mx_register("quote", 1, 1, exp_quote
);
957 mx_register("random-enabled", 0, 0, exp_random_enabled
);
958 mx_register("removable", 1, 1, exp_removable
);
959 mx_register("resolve", 1, 1, exp_resolve
);
960 mx_register("server-version", 0, 0, exp_server_version
);
961 mx_register("state", 1, 1, exp_state
);
962 mx_register("thisurl", 0, 0, exp_thisurl
);
963 mx_register("trackstate", 1, 1, exp_trackstate
);
964 mx_register("transform", 2, 3, exp_transform
);
965 mx_register("url", 0, 0, exp_url
);
966 mx_register("user", 0, 0, exp_user
);
967 mx_register("userinfo", 1, 1, exp_userinfo
);
968 mx_register("version", 0, 0, exp_version
);
969 mx_register("volume", 1, 1, exp_volume
);
970 mx_register("when", 1, 1, exp_when
);
971 mx_register("who", 1, 1, exp_who
);
972 mx_register_magic("dirs", 2, 3, exp_dirs
);
973 mx_register_magic("new", 1, 1, exp_new
);
974 mx_register_magic("playing", 0, 1, exp_playing
);
975 mx_register_magic("prefs", 2, 2, exp_prefs
);
976 mx_register_magic("queue", 1, 1, exp_queue
);
977 mx_register_magic("recent", 1, 1, exp_recent
);
978 mx_register_magic("right", 1, 3, exp_right
);
979 mx_register_magic("search", 2, 2, exp_search
);
980 mx_register_magic("tracks", 2, 3, exp_tracks
);