chiark / gitweb /
more templates plus support code changes
[disorder] / server / macros-disorder.c
CommitLineData
9faa7a88
RK
1/*
2 * This file is part of DisOrder.
3 * Copyright (C) 2004-2008 Richard Kettlewell
4 *
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.
9 *
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.
14 *
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
18 * USA
19 */
20/** @file server/macros-disorder.c
21 * @brief DisOrder-specific expansions
22 */
23
1e97629d 24#include "disorder-cgi.h"
9faa7a88 25
bca4e2b7 26/** @brief For error template */
1e97629d 27char *dcgi_error_string;
bca4e2b7 28
9faa7a88
RK
29/** @brief Return @p i as a string */
30static const char *make_index(int i) {
31 char *s;
32
33 byte_xasprintf(&s, "%d", i);
34 return s;
35}
36
bca4e2b7 37/* @server-version
9faa7a88
RK
38 *
39 * Expands to the server's version string, or a (safe to use) error
40 * value if the server is unavailable or broken.
41 */
42static int exp_server_version(int attribute((unused)) nargs,
43 char attribute((unused)) **args,
44 struct sink *output,
45 void attribute((unused)) *u) {
46 const char *v;
47
1e97629d
RK
48 if(dcgi_client) {
49 if(disorder_version(dcgi_client, (char **)&v))
9faa7a88
RK
50 v = "(cannot get version)";
51 } else
52 v = "(server not running)";
71634563 53 return sink_writes(output, cgi_sgmlquote(v)) < 0 ? -1 : 0;
9faa7a88
RK
54}
55
bca4e2b7 56/* @version
9faa7a88
RK
57 *
58 * Expands to the local version string.
59 */
60static int exp_version(int attribute((unused)) nargs,
61 char attribute((unused)) **args,
62 struct sink *output,
63 void attribute((unused)) *u) {
71634563
RK
64 return sink_writes(output,
65 cgi_sgmlquote(disorder_short_version_string)) < 0 ? -1 : 0;
9faa7a88
RK
66}
67
bca4e2b7 68/* @url
9faa7a88
RK
69 *
70 * Expands to the base URL of the web interface.
71 */
72static int exp_url(int attribute((unused)) nargs,
73 char attribute((unused)) **args,
74 struct sink *output,
75 void attribute((unused)) *u) {
71634563
RK
76 return sink_writes(output,
77 cgi_sgmlquote(config->url)) < 0 ? -1 : 0;
9faa7a88
RK
78}
79
bca4e2b7 80/* @arg{NAME}
9faa7a88
RK
81 *
82 * Expands to the CGI argument NAME, or the empty string if there is
83 * no such argument.
84 */
85static int exp_arg(int attribute((unused)) nargs,
86 char **args,
87 struct sink *output,
88 void attribute((unused)) *u) {
89 const char *s = cgi_get(args[0]);
2257512d 90
9faa7a88 91 if(s)
71634563
RK
92 return sink_writes(output,
93 cgi_sgmlquote(s)) < 0 ? -1 : 0;
9faa7a88
RK
94 else
95 return 0;
96}
97
bca4e2b7 98/* @user
9faa7a88
RK
99 *
100 * Expands to the logged-in username (which might be "guest"), or to
101 * the empty string if not connected.
102 */
103static int exp_user(int attribute((unused)) nargs,
104 char attribute((unused)) **args,
105 struct sink *output,
106 void attribute((unused)) *u) {
71634563 107 const char *user;
9faa7a88 108
1e97629d 109 if(dcgi_client && (user = disorder_user(dcgi_client)))
71634563 110 return sink_writes(output, cgi_sgmlquote(user)) < 0 ? -1 : 0;
9faa7a88
RK
111 return 0;
112}
113
114/* @part{TRACK|ID}{PART}{CONTEXT}
115 *
116 * Expands to a track name part.
117 *
118 * A track may be identified by name or by queue ID.
119 *
120 * CONTEXT may be omitted. If it is then 'display' is assumed.
121 *
122 * If the CONTEXT is 'short' then the 'display' part is looked up, and the
123 * result truncated according to the length defined by the short_display
124 * configuration directive.
125 */
126static int exp_part(int nargs,
127 char **args,
128 struct sink *output,
129 void attribute((unused)) *u) {
130 const char *track = args[0], *part = args[1];
131 const char *context = nargs > 2 ? args[2] : "display";
132 char *s;
133
134 if(track[0] != '/') {
a2c4ad5f 135 struct queue_entry *q = dcgi_findtrack(track);
9faa7a88
RK
136
137 if(q)
138 track = q->track;
139 else
140 return 0;
141 }
1e97629d
RK
142 if(dcgi_client
143 && !disorder_part(dcgi_client, &s,
71634563
RK
144 track,
145 !strcmp(context, "short") ? "display" : context,
146 part))
147 return sink_writes(output, cgi_sgmlquote(s)) < 0 ? -1 : 0;
9faa7a88
RK
148 return 0;
149}
150
151/* @quote{STRING}
152 *
153 * SGML-quotes STRING. Note that most expansion results are already suitable
154 * quoted, so this expansion is usually not required.
155 */
156static int exp_quote(int attribute((unused)) nargs,
157 char **args,
158 struct sink *output,
159 void attribute((unused)) *u) {
71634563 160 return sink_writes(output, cgi_sgmlquote(args[0])) < 0 ? -1 : 0;
9faa7a88
RK
161}
162
163/* @who{ID}
164 *
165 * Expands to the name of the submitter of track ID, which must be a playing
166 * track, in the queue, or in the recent list.
167 */
168static int exp_who(int attribute((unused)) nargs,
169 char **args,
170 struct sink *output,
171 void attribute((unused)) *u) {
a2c4ad5f 172 struct queue_entry *q = dcgi_findtrack(args[0]);
9faa7a88
RK
173
174 if(q && q->submitter)
71634563 175 return sink_writes(output, cgi_sgmlquote(q->submitter)) < 0 ? -1 : 0;
9faa7a88
RK
176 return 0;
177}
178
179/* @when{ID}
180 *
181 * Expands to the time a track started or is expected to start. The track must
182 * be a playing track, in the queue, or in the recent list.
183 */
184static int exp_when(int attribute((unused)) nargs,
185 char **args,
186 struct sink *output,
187 void attribute((unused)) *u) {
a2c4ad5f 188 struct queue_entry *q = dcgi_findtrack(args[0]);
9faa7a88
RK
189 const struct tm *w = 0;
190
191 if(q) {
192 switch(q->state) {
193 case playing_isscratch:
194 case playing_unplayed:
195 case playing_random:
196 if(q->expected)
197 w = localtime(&q->expected);
198 break;
199 case playing_failed:
200 case playing_no_player:
201 case playing_ok:
202 case playing_scratched:
203 case playing_started:
204 case playing_paused:
205 case playing_quitting:
206 if(q->played)
207 w = localtime(&q->played);
208 break;
209 }
210 if(w)
211 return sink_printf(output, "%d:%02d", w->tm_hour, w->tm_min) < 0 ? -1 : 0;
212 }
71634563 213 return sink_writes(output, "&nbsp;") < 0 ? -1 : 0;
9faa7a88
RK
214}
215
216/* @length{ID|TRACK}
217 *
218 * Expands to the length of a track, identified by its queue ID or its name.
219 * If it is the playing track (identified by ID) then the amount played so far
220 * is included.
221 */
222static int exp_length(int attribute((unused)) nargs,
223 char **args,
224 struct sink *output,
225 void attribute((unused)) *u) {
226 struct queue_entry *q;
227 long length = 0;
228 const char *name;
229
230 if(args[0][0] == '/')
231 /* Track identified by name */
232 name = args[0];
233 else {
234 /* Track identified by queue ID */
a2c4ad5f 235 if(!(q = dcgi_findtrack(args[0])))
9faa7a88 236 return 0;
71634563 237 if(q->state == playing_started || q->state == playing_paused)
9faa7a88
RK
238 if(sink_printf(output, "%ld:%02ld/", q->sofar / 60, q->sofar % 60) < 0)
239 return -1;
240 name = q->track;
241 }
1e97629d 242 if(dcgi_client && disorder_length(dcgi_client, name, &length))
9faa7a88
RK
243 return sink_printf(output, "%ld:%02ld",
244 length / 60, length % 60) < 0 ? -1 : 0;
71634563 245 return sink_writes(output, "&nbsp;") < 0 ? -1 : 0;
9faa7a88
RK
246}
247
bca4e2b7 248/* @removable{ID}
9faa7a88
RK
249 *
250 * Expands to "true" if track ID is removable (or scratchable, if it is the
251 * playing track) and "false" otherwise.
252 */
253static int exp_removable(int attribute((unused)) nargs,
254 char **args,
255 struct sink *output,
256 void attribute((unused)) *u) {
a2c4ad5f 257 struct queue_entry *q = dcgi_findtrack(args[0]);
9faa7a88
RK
258 /* TODO would be better to reject recent */
259
1e97629d 260 if(!q || !dcgi_client)
9faa7a88 261 return mx_bool_result(output, 0);
1e97629d 262 dcgi_lookup(DCGI_RIGHTS);
9faa7a88 263 return mx_bool_result(output,
1e97629d
RK
264 (q == dcgi_playing ? right_scratchable : right_removable)
265 (dcgi_rights, disorder_user(dcgi_client), q));
9faa7a88
RK
266}
267
af106f2d 268/* @movable{ID}{DIR}
9faa7a88
RK
269 *
270 * Expands to "true" if track ID is movable and "false" otherwise.
af106f2d
RK
271 *
272 * DIR (which is optional) should be a non-zero integer. If it is negative
273 * then the intended move is down (later in the queue), if it is positive then
274 * the intended move is up (earlier in the queue). The first track is not
275 * movable up and the last track not movable down.
9faa7a88 276 */
af106f2d 277static int exp_movable(int nargs,
9faa7a88
RK
278 char **args,
279 struct sink *output,
280 void attribute((unused)) *u) {
a2c4ad5f 281 struct queue_entry *q = dcgi_findtrack(args[0]);
9faa7a88
RK
282 /* TODO would be better to recent playing/recent */
283
1e97629d 284 if(!q || !dcgi_client)
9faa7a88 285 return mx_bool_result(output, 0);
af106f2d
RK
286 if(nargs > 1) {
287 const long dir = atoi(args[1]);
288
289 if(dir > 0 && q == dcgi_queue)
290 return mx_bool_result(output, 0);
291 if(dir < 0 && q->next == 0)
292 return mx_bool_result(output, 0);
293 }
1e97629d 294 dcgi_lookup(DCGI_RIGHTS);
9faa7a88 295 return mx_bool_result(output,
af106f2d
RK
296 right_movable(dcgi_rights,
297 disorder_user(dcgi_client),
298 q));
9faa7a88
RK
299}
300
301/* @playing{TEMPLATE}
302 *
303 * Expands to TEMPLATE, with:
304 * - @id@ expanded to the queue ID of the playing track
305 * - @track@ expanded to its UNQUOTED name
306 *
307 * If no track is playing expands to nothing.
308 *
309 * TEMPLATE is optional. If it is left out then instead expands to the queue
310 * ID of the playing track.
311 */
312static int exp_playing(int nargs,
313 const struct mx_node **args,
314 struct sink *output,
71634563 315 void *u) {
1e97629d
RK
316 dcgi_lookup(DCGI_PLAYING);
317 if(!dcgi_playing)
9faa7a88
RK
318 return 0;
319 if(!nargs)
1e97629d 320 return sink_writes(output, dcgi_playing->id) < 0 ? -1 : 0;
71634563 321 return mx_expand(mx_rewritel(args[0],
1e97629d
RK
322 "id", dcgi_playing->id,
323 "track", dcgi_playing->track,
71634563
RK
324 (char *)0),
325 output, u);
9faa7a88
RK
326}
327
328/* @queue{TEMPLATE}
329 *
330 * For each track in the queue, expands TEMPLATE with the following expansions:
331 * - @id@ to the queue ID of the track
332 * - @track@ to the UNQUOTED track name
333 * - @index@ to the track number from 0
334 * - @parity@ to "even" or "odd" alternately
335 * - @first@ to "true" on the first track and "false" otherwise
336 * - @last@ to "true" on the last track and "false" otherwise
337 */
338static int exp_queue(int attribute((unused)) nargs,
339 const struct mx_node **args,
340 struct sink *output,
71634563 341 void *u) {
9faa7a88
RK
342 struct queue_entry *q;
343 int rc, i;
344
1e97629d
RK
345 dcgi_lookup(DCGI_QUEUE);
346 for(q = dcgi_queue, i = 0; q; q = q->next, ++i)
71634563
RK
347 if((rc = mx_expand(mx_rewritel(args[0],
348 "id", q->id,
349 "track", q->track,
350 "index", make_index(i),
351 "parity", i % 2 ? "odd" : "even",
1e97629d 352 "first", q == dcgi_queue ? "true" : "false",
71634563
RK
353 "last", q->next ? "false" : "true",
354 (char *)0),
355 output, u)))
9faa7a88
RK
356 return rc;
357 return 0;
358}
359
360/* @recent{TEMPLATE}
361 *
362 * For each track in the recently played list, expands TEMPLATE with the
363 * following expansions:
364 * - @id@ to the queue ID of the track
365 * - @track@ to the UNQUOTED track name
366 * - @index@ to the track number from 0
367 * - @parity@ to "even" or "odd" alternately
368 * - @first@ to "true" on the first track and "false" otherwise
369 * - @last@ to "true" on the last track and "false" otherwise
370 */
371static int exp_recent(int attribute((unused)) nargs,
372 const struct mx_node **args,
373 struct sink *output,
71634563 374 void *u) {
9faa7a88
RK
375 struct queue_entry *q;
376 int rc, i;
377
1e97629d
RK
378 dcgi_lookup(DCGI_RECENT);
379 for(q = dcgi_recent, i = 0; q; q = q->next, ++i)
71634563
RK
380 if((rc = mx_expand(mx_rewritel(args[0],
381 "id", q->id,
382 "track", q->track,
383 "index", make_index(i),
384 "parity", i % 2 ? "odd" : "even",
1e97629d 385 "first", q == dcgi_recent ? "true" : "false",
71634563
RK
386 "last", q->next ? "false" : "true",
387 (char *)0),
388 output, u)))
9faa7a88
RK
389 return rc;
390 return 0;
391}
392
393/* @new{TEMPLATE}
394 *
395 * For each track in the newly added list, expands TEMPLATE wit the following
396 * expansions:
397 * - @track@ to the UNQUOTED track name
398 * - @index@ to the track number from 0
399 * - @parity@ to "even" or "odd" alternately
400 * - @first@ to "true" on the first track and "false" otherwise
401 * - @last@ to "true" on the last track and "false" otherwise
402 *
403 * Note that unlike @playing@, @queue@ and @recent@ which are otherwise
404 * superficially similar, there is no @id@ sub-expansion here.
405 */
406static int exp_new(int attribute((unused)) nargs,
407 const struct mx_node **args,
408 struct sink *output,
71634563 409 void *u) {
9faa7a88
RK
410 int rc, i;
411
1e97629d 412 dcgi_lookup(DCGI_NEW);
9faa7a88 413 /* TODO perhaps we should generate an ID value for tracks in the new list */
1e97629d 414 for(i = 0; i < dcgi_nnew; ++i)
71634563 415 if((rc = mx_expand(mx_rewritel(args[0],
1e97629d 416 "track", dcgi_new[i],
71634563
RK
417 "index", make_index(i),
418 "parity", i % 2 ? "odd" : "even",
419 "first", i == 0 ? "true" : "false",
1e97629d 420 "last", i == dcgi_nnew - 1 ? "false" : "true",
71634563
RK
421 (char *)0),
422 output, u)))
9faa7a88
RK
423 return rc;
424 return 0;
425}
426
bca4e2b7 427/* @volume{CHANNEL}
9faa7a88
RK
428 *
429 * Expands to the volume in a given channel. CHANNEL must be "left" or
430 * "right".
431 */
432static int exp_volume(int attribute((unused)) nargs,
433 char **args,
434 struct sink *output,
435 void attribute((unused)) *u) {
1e97629d 436 dcgi_lookup(DCGI_VOLUME);
71634563
RK
437 return sink_printf(output, "%d",
438 !strcmp(args[0], "left")
1e97629d 439 ? dcgi_volume_left : dcgi_volume_right) < 0 ? -1 : 0;
9faa7a88
RK
440}
441
bca4e2b7 442/* @isplaying
9faa7a88
RK
443 *
444 * Expands to "true" if there is a playing track, otherwise "false".
445 */
446static int exp_isplaying(int attribute((unused)) nargs,
447 char attribute((unused)) **args,
448 struct sink *output,
449 void attribute((unused)) *u) {
1e97629d
RK
450 dcgi_lookup(DCGI_PLAYING);
451 return mx_bool_result(output, !!dcgi_playing);
9faa7a88
RK
452}
453
bca4e2b7 454/* @isqueue
9faa7a88
RK
455 *
456 * Expands to "true" if there the queue is nonempty, otherwise "false".
457 */
458static int exp_isqueue(int attribute((unused)) nargs,
459 char attribute((unused)) **args,
460 struct sink *output,
461 void attribute((unused)) *u) {
1e97629d
RK
462 dcgi_lookup(DCGI_QUEUE);
463 return mx_bool_result(output, !!dcgi_queue);
9faa7a88
RK
464}
465
466/* @isrecent@
467 *
468 * Expands to "true" if there the recently played list is nonempty, otherwise
469 * "false".
470 */
471static int exp_isrecent(int attribute((unused)) nargs,
472 char attribute((unused)) **args,
473 struct sink *output,
474 void attribute((unused)) *u) {
1e97629d
RK
475 dcgi_lookup(DCGI_RECENT);
476 return mx_bool_result(output, !!dcgi_recent);
9faa7a88
RK
477}
478
bca4e2b7 479/* @isnew
9faa7a88
RK
480 *
481 * Expands to "true" if there the newly added track list is nonempty, otherwise
482 * "false".
483 */
484static int exp_isnew(int attribute((unused)) nargs,
485 char attribute((unused)) **args,
486 struct sink *output,
487 void attribute((unused)) *u) {
1e97629d
RK
488 dcgi_lookup(DCGI_NEW);
489 return mx_bool_result(output, !!dcgi_nnew);
9faa7a88
RK
490}
491
bca4e2b7 492/* @pref{TRACK}{KEY}
9faa7a88
RK
493 *
494 * Expands to a track preference.
495 */
496static int exp_pref(int attribute((unused)) nargs,
497 char **args,
498 struct sink *output,
499 void attribute((unused)) *u) {
500 char *value;
501
1e97629d 502 if(dcgi_client && !disorder_get(dcgi_client, args[0], args[1], &value))
71634563
RK
503 return sink_writes(output, cgi_sgmlquote(value)) < 0 ? -1 : 0;
504 return 0;
9faa7a88
RK
505}
506
bca4e2b7 507/* @prefs{TRACK}{TEMPLATE}
9faa7a88
RK
508 *
509 * For each track preference of track TRACK, expands TEMPLATE with the
510 * following expansions:
511 * - @name@ to the UNQUOTED preference name
512 * - @index@ to the preference number from 0
513 * - @value@ to the UNQUOTED preference value
514 * - @parity@ to "even" or "odd" alternately
515 * - @first@ to "true" on the first preference and "false" otherwise
516 * - @last@ to "true" on the last preference and "false" otherwise
517 *
518 * Use @quote@ to quote preference names and values where necessary; see below.
519 */
520static int exp_prefs(int attribute((unused)) nargs,
521 const struct mx_node **args,
522 struct sink *output,
71634563 523 void *u) {
9faa7a88
RK
524 int rc, i;
525 struct kvp *k, *head;
526 char *track;
527
528 if((rc = mx_expandstr(args[0], &track, u, "argument #0 (TRACK)")))
529 return rc;
1e97629d 530 if(!dcgi_client || disorder_prefs(dcgi_client, track, &head))
9faa7a88
RK
531 return 0;
532 for(k = head, i = 0; k; k = k->next, ++i)
71634563
RK
533 if((rc = mx_expand(mx_rewritel(args[1],
534 "index", make_index(i),
535 "parity", i % 2 ? "odd" : "even",
536 "name", k->name,
537 "value", k->value,
538 "first", k == head ? "true" : "false",
539 "last", k->next ? "false" : "true",
540 (char *)0),
541 output, u)))
9faa7a88
RK
542 return rc;
543 return 0;
544}
545
bca4e2b7 546/* @transform{TRACK}{TYPE}{CONTEXT}
9faa7a88
RK
547 *
548 * Transforms a track name (if TYPE is "track") or directory name (if type is
549 * "dir"). CONTEXT should be the context, if it is left out then "display" is
550 * assumed.
551 */
552static int exp_transform(int nargs,
553 char **args,
554 struct sink *output,
555 void attribute((unused)) *u) {
556 const char *t = trackname_transform(args[1], args[0],
71634563
RK
557 (nargs > 2 ? args[2] : "display"));
558 return sink_writes(output, cgi_sgmlquote(t)) < 0 ? -1 : 0;
9faa7a88
RK
559}
560
561/* @enabled@
562 *
563 * Expands to "true" if playing is enabled, otherwise "false".
564 */
565static int exp_enabled(int attribute((unused)) nargs,
566 char attribute((unused)) **args,
567 struct sink *output,
568 void attribute((unused)) *u) {
1e97629d 569 int e = 0;
9faa7a88 570
1e97629d
RK
571 if(dcgi_client)
572 disorder_enabled(dcgi_client, &e);
573 return mx_bool_result(output, e);
9faa7a88
RK
574}
575
bca4e2b7 576/* @random-enabled
9faa7a88
RK
577 *
578 * Expands to "true" if random play is enabled, otherwise "false".
579 */
71634563
RK
580static int exp_random_enabled(int attribute((unused)) nargs,
581 char attribute((unused)) **args,
582 struct sink *output,
583 void attribute((unused)) *u) {
1e97629d 584 int e = 0;
9faa7a88 585
1e97629d
RK
586 if(dcgi_client)
587 disorder_random_enabled(dcgi_client, &e);
588 return mx_bool_result(output, e);
9faa7a88
RK
589}
590
04024c2c 591/* @trackstate{TRACK}
9faa7a88
RK
592 *
593 * Expands to "playing" if TRACK is currently playing, or "queue" if it is in
594 * the queue, otherwise to nothing.
595 */
596static int exp_trackstate(int attribute((unused)) nargs,
597 char **args,
598 struct sink *output,
599 void attribute((unused)) *u) {
600 char *track;
601 struct queue_entry *q;
602
1e97629d 603 if(!dcgi_client)
9faa7a88 604 return 0;
1e97629d 605 if(disorder_resolve(dcgi_client, &track, args[0]))
9faa7a88 606 return 0;
1e97629d
RK
607 dcgi_lookup(DCGI_PLAYING);
608 if(dcgi_playing && !strcmp(track, dcgi_playing->track))
71634563 609 return sink_writes(output, "playing") < 0 ? -1 : 0;
1e97629d
RK
610 dcgi_lookup(DCGI_QUEUE);
611 for(q = dcgi_queue; q; q = q->next)
9faa7a88 612 if(!strcmp(track, q->track))
71634563 613 return sink_writes(output, "queued") < 0 ? -1 : 0;
9faa7a88
RK
614 return 0;
615}
616
bca4e2b7 617/* @thisurl
9faa7a88
RK
618 *
619 * Expands to an UNQUOTED URL which points back to the current page. (NB it
620 * might not be byte for byte identical - for instance, CGI arguments might be
621 * re-ordered.)
622 */
623static int exp_thisurl(int attribute((unused)) nargs,
624 char attribute((unused)) **args,
625 struct sink *output,
626 void attribute((unused)) *u) {
71634563 627 return sink_writes(output, cgi_thisurl(config->url)) < 0 ? -1 : 0;
9faa7a88
RK
628}
629
bca4e2b7 630/* @resolve{TRACK}
9faa7a88
RK
631 *
632 * Expands to an UNQUOTED name for the TRACK that is not an alias, or to
633 * nothing if it is not a valid track.
634 */
635static int exp_resolve(int attribute((unused)) nargs,
636 char **args,
637 struct sink *output,
638 void attribute((unused)) *u) {
639 char *r;
640
1e97629d 641 if(dcgi_client && !disorder_resolve(dcgi_client, &r, args[0]))
71634563 642 return sink_writes(output, r) < 0 ? -1 : 0;
9faa7a88
RK
643 return 0;
644}
645
bca4e2b7 646/* @paused
9faa7a88
RK
647 *
648 * Expands to "true" if the playing track is paused, to "false" if it is
649 * playing (or if there is no playing track at all).
650 */
651static int exp_paused(int attribute((unused)) nargs,
652 char attribute((unused)) **args,
653 struct sink *output,
654 void attribute((unused)) *u) {
1e97629d
RK
655 dcgi_lookup(DCGI_PLAYING);
656 return mx_bool_result(output, (dcgi_playing
657 && dcgi_playing->state == playing_paused));
9faa7a88
RK
658}
659
660/* @state{ID}@
661 *
662 * Expands to the current state of track ID.
663 */
664static int exp_state(int attribute((unused)) nargs,
665 char **args,
666 struct sink *output,
667 void attribute((unused)) *u) {
a2c4ad5f 668 struct queue_entry *q = dcgi_findtrack(args[0]);
9faa7a88
RK
669
670 if(q)
71634563 671 return sink_writes(output, playing_states[q->state]) < 0 ? -1 : 0;
9faa7a88
RK
672 return 0;
673}
674
675/* @right{RIGHT}{WITH-RIGHT}{WITHOUT-RIGHT}@
676 *
677 * Expands to WITH-RIGHT if the current user has right RIGHT, otherwise to
678 * WITHOUT-RIGHT. The WITHOUT-RIGHT argument may be left out.
679 *
680 * If both WITH-RIGHT and WITHOUT-RIGHT are left out then expands to "true" if
681 * the user has the right and "false" otherwise.
682 *
683 * If there is no connection to the server then expands to nothing (in all
684 * cases).
685 */
686static int exp_right(int nargs,
687 const struct mx_node **args,
688 struct sink *output,
71634563 689 void *u) {
9faa7a88
RK
690 char *right;
691 rights_type r;
71634563 692 int rc;
9faa7a88 693
1e97629d 694 if(!dcgi_client)
9faa7a88 695 return 0;
1e97629d 696 dcgi_lookup(DCGI_RIGHTS);
71634563 697 if((rc = mx_expandstr(args[0], &right, u, "argument #0 (RIGHT)")))
9faa7a88
RK
698 return rc;
699 if(parse_rights(right, &r, 1/*report*/))
700 return 0;
701 /* Single-argument form */
702 if(nargs == 1)
1e97629d 703 return mx_bool_result(output, !!(r & dcgi_rights));
9faa7a88 704 /* Multiple argument form */
1e97629d 705 if(r & dcgi_rights)
71634563 706 return mx_expand(args[1], output, u);
9faa7a88 707 if(nargs == 3)
71634563 708 return mx_expand(args[2], output, u);
9faa7a88
RK
709 return 0;
710}
711
bca4e2b7 712/* @userinfo{PROPERTY}
9faa7a88
RK
713 *
714 * Expands to the named property of the current user.
715 */
716static int exp_userinfo(int attribute((unused)) nargs,
717 char **args,
718 struct sink *output,
719 void attribute((unused)) *u) {
720 char *v;
721
1e97629d
RK
722 if(dcgi_client
723 && !disorder_userinfo(dcgi_client, disorder_user(dcgi_client),
724 args[0], &v))
71634563 725 return sink_writes(output, v) < 0 ? -1 : 0;
9faa7a88
RK
726 return 0;
727}
728
bca4e2b7
RK
729/* @error
730 *
731 * Expands to the latest error string.
732 */
733static int exp_error(int attribute((unused)) nargs,
734 char attribute((unused)) **args,
735 struct sink *output,
736 void attribute((unused)) *u) {
0d0253c9 737 return sink_writes(output, dcgi_error_string) < 0 ? -1 : 0;
bca4e2b7
RK
738}
739
30d85588
RK
740/* @image{NAME}
741 *
742 * Expands to the URL of the image called NAME.
743 *
744 * Firstly if there is a label called images.NAME then the image stem will be
745 * the value of that label. Otherwise the stem will be NAME.png.
746 *
747 * If the label url.static exists then it will give the base URL for images.
748 * Otherwise the base url will be /disorder/.
749 */
750static int exp_image(int attribute((unused)) nargs,
751 char **args,
752 struct sink *output,
753 void attribute((unused)) *u) {
754 const char *url, *stem;
755 char *labelname;
756
757 /* Compute the stem */
758 byte_xasprintf(&labelname, "images.%s", args[0]);
759 if(option_label_exists(labelname))
760 stem = option_label(labelname);
761 else
762 byte_xasprintf((char **)&stem, "%s.png", args[0]);
763 /* If the stem looks like it's reasonalby complete, use that */
764 if(stem[0] == '/'
765 || !strncmp(stem, "http:", 5)
766 || !strncmp(stem, "https:", 6))
767 url = stem;
768 else {
769 /* Compute the URL */
770 if(option_label_exists("url.static"))
771 byte_xasprintf((char **)&url, "%s/%s",
772 option_label("url.static"), stem);
773 else
774 /* Default base is /disorder */
775 byte_xasprintf((char **)&url, "/disorder/%s", stem);
776 }
777 return sink_writes(output, cgi_sgmlquote(url)) < 0 ? -1 : 0;
778}
779
9faa7a88 780/** @brief Register DisOrder-specific expansions */
1e97629d 781void dcgi_expansions(void) {
71634563
RK
782 mx_register("arg", 1, 1, exp_arg);
783 mx_register("enabled", 0, 0, exp_enabled);
784 mx_register("error", 0, 0, exp_error);
30d85588 785 mx_register("image", 1, 1, exp_image);
71634563
RK
786 mx_register("isnew", 0, 0, exp_isnew);
787 mx_register("isplaying", 0, 0, exp_isplaying);
788 mx_register("isplaying", 0, 0, exp_isqueue);
789 mx_register("isrecent", 0, 0, exp_isrecent);
790 mx_register("length", 1, 1, exp_length);
791 mx_register("movable", 1, 1, exp_movable);
792 mx_register("part", 2, 3, exp_part);
793 mx_register("paused", 0, 0, exp_paused);
794 mx_register("pref", 2, 2, exp_pref);
795 mx_register("quote", 1, 1, exp_quote);
796 mx_register("random-enabled", 0, 0, exp_random_enabled);
797 mx_register("removable", 1, 1, exp_removable);
798 mx_register("resolve", 1, 1, exp_resolve);
799 mx_register("server-version", 0, 0, exp_server_version);
800 mx_register("state", 1, 1, exp_state);
801 mx_register("thisurl", 0, 0, exp_thisurl);
802 mx_register("trackstate", 1, 1, exp_trackstate);
803 mx_register("transform", 2, 3, exp_transform);
804 mx_register("url", 0, 0, exp_url);
805 mx_register("user", 0, 0, exp_user);
806 mx_register("userinfo", 1, 1, exp_userinfo);
807 mx_register("version", 0, 0, exp_version);
808 mx_register("volume", 1, 1, exp_volume);
809 mx_register("when", 1, 1, exp_when);
810 mx_register("who", 1, 1, exp_who);
811 mx_register_magic("new", 1, 1, exp_new);
812 mx_register_magic("playing", 0, 1, exp_playing);
813 mx_register_magic("prefs", 2, 2, exp_prefs);
814 mx_register_magic("queue", 1, 1, exp_queue);
815 mx_register_magic("recent", 1, 1, exp_recent);
816 mx_register_magic("right", 1, 3, exp_right);
bca4e2b7
RK
817}
818
9faa7a88
RK
819/*
820Local Variables:
821c-basic-offset:2
822comment-column:40
823fill-column:79
824indent-tabs-mode:nil
825End:
826*/