chiark / gitweb /
Switch to GPL v3
[disorder] / cgi / macros-disorder.c
CommitLineData
9faa7a88
RK
1/*
2 * This file is part of DisOrder.
3 * Copyright (C) 2004-2008 Richard Kettlewell
4 *
e7eb3a27 5 * This program is free software: you can redistribute it and/or modify
9faa7a88 6 * it under the terms of the GNU General Public License as published by
e7eb3a27 7 * the Free Software Foundation, either version 3 of the License, or
9faa7a88
RK
8 * (at your option) any later version.
9 *
e7eb3a27
RK
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
14 *
9faa7a88 15 * You should have received a copy of the GNU General Public License
e7eb3a27 16 * along with this program. If not, see <http://www.gnu.org/licenses/>.
9faa7a88
RK
17 */
18/** @file server/macros-disorder.c
19 * @brief DisOrder-specific expansions
20 */
21
1e97629d 22#include "disorder-cgi.h"
9faa7a88 23
bca4e2b7 24/** @brief For error template */
e7ce7665 25const char *dcgi_error_string;
bca4e2b7 26
343d9c2b 27/** @brief For login template */
e7ce7665 28const char *dcgi_status_string;
343d9c2b 29
9faa7a88
RK
30/** @brief Return @p i as a string */
31static const char *make_index(int i) {
32 char *s;
33
34 byte_xasprintf(&s, "%d", i);
35 return s;
36}
37
5c1ae3bc 38/*! @server-version
9faa7a88
RK
39 *
40 * Expands to the server's version string, or a (safe to use) error
41 * value if the server is unavailable or broken.
42 */
43static int exp_server_version(int attribute((unused)) nargs,
44 char attribute((unused)) **args,
45 struct sink *output,
46 void attribute((unused)) *u) {
47 const char *v;
48
1e97629d
RK
49 if(dcgi_client) {
50 if(disorder_version(dcgi_client, (char **)&v))
9faa7a88
RK
51 v = "(cannot get version)";
52 } else
53 v = "(server not running)";
71634563 54 return sink_writes(output, cgi_sgmlquote(v)) < 0 ? -1 : 0;
9faa7a88
RK
55}
56
5c1ae3bc 57/*! @version
9faa7a88
RK
58 *
59 * Expands to the local version string.
60 */
61static int exp_version(int attribute((unused)) nargs,
62 char attribute((unused)) **args,
63 struct sink *output,
64 void attribute((unused)) *u) {
71634563
RK
65 return sink_writes(output,
66 cgi_sgmlquote(disorder_short_version_string)) < 0 ? -1 : 0;
9faa7a88
RK
67}
68
5c1ae3bc 69/*! @url
9faa7a88
RK
70 *
71 * Expands to the base URL of the web interface.
72 */
73static int exp_url(int attribute((unused)) nargs,
74 char attribute((unused)) **args,
75 struct sink *output,
76 void attribute((unused)) *u) {
71634563
RK
77 return sink_writes(output,
78 cgi_sgmlquote(config->url)) < 0 ? -1 : 0;
9faa7a88
RK
79}
80
5c1ae3bc 81/*! @arg{NAME}
9faa7a88 82 *
48e472fa
RK
83 * Expands to the UNQUOTED form of CGI argument NAME, or the empty string if
84 * there is no such argument. Use @argq for a quick way to quote the argument.
9faa7a88
RK
85 */
86static int exp_arg(int attribute((unused)) nargs,
87 char **args,
88 struct sink *output,
89 void attribute((unused)) *u) {
90 const char *s = cgi_get(args[0]);
2257512d 91
9faa7a88 92 if(s)
48e472fa
RK
93 return sink_writes(output, s) < 0 ? -1 : 0;
94 else
95 return 0;
96}
97
5c1ae3bc 98/*! @argq{NAME}
48e472fa
RK
99 *
100 * Expands to the (quoted) form of CGI argument NAME, or the empty string if
101 * there is no such argument. Use @arg for the unquoted argument.
102 */
103static int exp_argq(int attribute((unused)) nargs,
104 char **args,
105 struct sink *output,
106 void attribute((unused)) *u) {
107 const char *s = cgi_get(args[0]);
108
109 if(s)
110 return sink_writes(output, cgi_sgmlquote(s)) < 0 ? -1 : 0;
9faa7a88
RK
111 else
112 return 0;
113}
114
5c1ae3bc 115/*! @user
9faa7a88
RK
116 *
117 * Expands to the logged-in username (which might be "guest"), or to
118 * the empty string if not connected.
119 */
120static int exp_user(int attribute((unused)) nargs,
121 char attribute((unused)) **args,
122 struct sink *output,
123 void attribute((unused)) *u) {
71634563 124 const char *user;
9faa7a88 125
1e97629d 126 if(dcgi_client && (user = disorder_user(dcgi_client)))
71634563 127 return sink_writes(output, cgi_sgmlquote(user)) < 0 ? -1 : 0;
9faa7a88
RK
128 return 0;
129}
130
5c1ae3bc 131/*! @part{TRACK|ID}{PART}{CONTEXT}
9faa7a88
RK
132 *
133 * Expands to a track name part.
134 *
135 * A track may be identified by name or by queue ID.
136 *
137 * CONTEXT may be omitted. If it is then 'display' is assumed.
138 *
139 * If the CONTEXT is 'short' then the 'display' part is looked up, and the
140 * result truncated according to the length defined by the short_display
141 * configuration directive.
142 */
143static int exp_part(int nargs,
144 char **args,
145 struct sink *output,
146 void attribute((unused)) *u) {
147 const char *track = args[0], *part = args[1];
148 const char *context = nargs > 2 ? args[2] : "display";
2647daf5 149 const char *s;
9faa7a88
RK
150
151 if(track[0] != '/') {
a2c4ad5f 152 struct queue_entry *q = dcgi_findtrack(track);
9faa7a88
RK
153
154 if(q)
155 track = q->track;
156 else
157 return 0;
158 }
1e97629d 159 if(dcgi_client
2647daf5 160 && !disorder_part(dcgi_client, (char **)&s,
71634563
RK
161 track,
162 !strcmp(context, "short") ? "display" : context,
2647daf5
RK
163 part)) {
164 if(!strcmp(context, "short"))
165 s = truncate_for_display(s, config->short_display);
71634563 166 return sink_writes(output, cgi_sgmlquote(s)) < 0 ? -1 : 0;
2647daf5 167 }
9faa7a88
RK
168 return 0;
169}
170
5c1ae3bc 171/*! @quote{STRING}
9faa7a88
RK
172 *
173 * SGML-quotes STRING. Note that most expansion results are already suitable
174 * quoted, so this expansion is usually not required.
175 */
176static int exp_quote(int attribute((unused)) nargs,
177 char **args,
178 struct sink *output,
179 void attribute((unused)) *u) {
71634563 180 return sink_writes(output, cgi_sgmlquote(args[0])) < 0 ? -1 : 0;
9faa7a88
RK
181}
182
5c1ae3bc 183/*! @who{ID}
9faa7a88
RK
184 *
185 * Expands to the name of the submitter of track ID, which must be a playing
186 * track, in the queue, or in the recent list.
187 */
188static int exp_who(int attribute((unused)) nargs,
189 char **args,
190 struct sink *output,
191 void attribute((unused)) *u) {
a2c4ad5f 192 struct queue_entry *q = dcgi_findtrack(args[0]);
9faa7a88
RK
193
194 if(q && q->submitter)
71634563 195 return sink_writes(output, cgi_sgmlquote(q->submitter)) < 0 ? -1 : 0;
9faa7a88
RK
196 return 0;
197}
198
5c1ae3bc 199/*! @when{ID}
9faa7a88
RK
200 *
201 * Expands to the time a track started or is expected to start. The track must
202 * be a playing track, in the queue, or in the recent list.
203 */
204static int exp_when(int attribute((unused)) nargs,
205 char **args,
206 struct sink *output,
207 void attribute((unused)) *u) {
a2c4ad5f 208 struct queue_entry *q = dcgi_findtrack(args[0]);
9faa7a88
RK
209 const struct tm *w = 0;
210
211 if(q) {
212 switch(q->state) {
213 case playing_isscratch:
214 case playing_unplayed:
215 case playing_random:
216 if(q->expected)
217 w = localtime(&q->expected);
218 break;
219 case playing_failed:
220 case playing_no_player:
221 case playing_ok:
222 case playing_scratched:
223 case playing_started:
224 case playing_paused:
225 case playing_quitting:
226 if(q->played)
227 w = localtime(&q->played);
228 break;
229 }
230 if(w)
231 return sink_printf(output, "%d:%02d", w->tm_hour, w->tm_min) < 0 ? -1 : 0;
232 }
71634563 233 return sink_writes(output, "&nbsp;") < 0 ? -1 : 0;
9faa7a88
RK
234}
235
5c1ae3bc 236/*! @length{ID|TRACK}
9faa7a88
RK
237 *
238 * Expands to the length of a track, identified by its queue ID or its name.
239 * If it is the playing track (identified by ID) then the amount played so far
240 * is included.
241 */
242static int exp_length(int attribute((unused)) nargs,
243 char **args,
244 struct sink *output,
245 void attribute((unused)) *u) {
246 struct queue_entry *q;
247 long length = 0;
248 const char *name;
249
250 if(args[0][0] == '/')
251 /* Track identified by name */
252 name = args[0];
253 else {
254 /* Track identified by queue ID */
a2c4ad5f 255 if(!(q = dcgi_findtrack(args[0])))
9faa7a88 256 return 0;
71634563 257 if(q->state == playing_started || q->state == playing_paused)
9faa7a88
RK
258 if(sink_printf(output, "%ld:%02ld/", q->sofar / 60, q->sofar % 60) < 0)
259 return -1;
260 name = q->track;
261 }
8a82274b 262 if(dcgi_client && !disorder_length(dcgi_client, name, &length))
9faa7a88
RK
263 return sink_printf(output, "%ld:%02ld",
264 length / 60, length % 60) < 0 ? -1 : 0;
71634563 265 return sink_writes(output, "&nbsp;") < 0 ? -1 : 0;
9faa7a88
RK
266}
267
5c1ae3bc 268/*! @removable{ID}
9faa7a88
RK
269 *
270 * Expands to "true" if track ID is removable (or scratchable, if it is the
271 * playing track) and "false" otherwise.
272 */
273static int exp_removable(int attribute((unused)) nargs,
274 char **args,
275 struct sink *output,
276 void attribute((unused)) *u) {
a2c4ad5f 277 struct queue_entry *q = dcgi_findtrack(args[0]);
9faa7a88
RK
278 /* TODO would be better to reject recent */
279
1e97629d 280 if(!q || !dcgi_client)
9faa7a88 281 return mx_bool_result(output, 0);
1e97629d 282 dcgi_lookup(DCGI_RIGHTS);
9faa7a88 283 return mx_bool_result(output,
1e97629d
RK
284 (q == dcgi_playing ? right_scratchable : right_removable)
285 (dcgi_rights, disorder_user(dcgi_client), q));
9faa7a88
RK
286}
287
5c1ae3bc 288/*! @movable{ID}{DIR}
9faa7a88
RK
289 *
290 * Expands to "true" if track ID is movable and "false" otherwise.
af106f2d
RK
291 *
292 * DIR (which is optional) should be a non-zero integer. If it is negative
293 * then the intended move is down (later in the queue), if it is positive then
294 * the intended move is up (earlier in the queue). The first track is not
295 * movable up and the last track not movable down.
9faa7a88 296 */
af106f2d 297static int exp_movable(int nargs,
9faa7a88
RK
298 char **args,
299 struct sink *output,
300 void attribute((unused)) *u) {
a2c4ad5f 301 struct queue_entry *q = dcgi_findtrack(args[0]);
9faa7a88
RK
302 /* TODO would be better to recent playing/recent */
303
1e97629d 304 if(!q || !dcgi_client)
9faa7a88 305 return mx_bool_result(output, 0);
af106f2d
RK
306 if(nargs > 1) {
307 const long dir = atoi(args[1]);
308
309 if(dir > 0 && q == dcgi_queue)
310 return mx_bool_result(output, 0);
311 if(dir < 0 && q->next == 0)
312 return mx_bool_result(output, 0);
313 }
1e97629d 314 dcgi_lookup(DCGI_RIGHTS);
9faa7a88 315 return mx_bool_result(output,
af106f2d
RK
316 right_movable(dcgi_rights,
317 disorder_user(dcgi_client),
318 q));
9faa7a88
RK
319}
320
5c1ae3bc 321/*! @playing{TEMPLATE}
9faa7a88 322 *
3e1616b6
RK
323 * Expands to TEMPLATE, with the following expansions:
324 * - @id: the queue ID of the playing track
325 * - @track: the playing track's
326 UNQUOTED name
9faa7a88
RK
327 *
328 * If no track is playing expands to nothing.
329 *
330 * TEMPLATE is optional. If it is left out then instead expands to the queue
331 * ID of the playing track.
332 */
333static int exp_playing(int nargs,
334 const struct mx_node **args,
335 struct sink *output,
71634563 336 void *u) {
1e97629d
RK
337 dcgi_lookup(DCGI_PLAYING);
338 if(!dcgi_playing)
9faa7a88
RK
339 return 0;
340 if(!nargs)
1e97629d 341 return sink_writes(output, dcgi_playing->id) < 0 ? -1 : 0;
71634563 342 return mx_expand(mx_rewritel(args[0],
1e97629d
RK
343 "id", dcgi_playing->id,
344 "track", dcgi_playing->track,
71634563
RK
345 (char *)0),
346 output, u);
9faa7a88
RK
347}
348
5c1ae3bc 349/*! @queue{TEMPLATE}
9faa7a88
RK
350 *
351 * For each track in the queue, expands TEMPLATE with the following expansions:
3e1616b6
RK
352 * - @id: the queue ID of the track
353 * - @track: the UNQUOTED track name
354 * - @index: the track number from 0
355 * - @parity: "even" or "odd" alternately
356 * - @first: "true" on the first track and "false" otherwise
357 * - @last: "true" on the last track and "false" otherwise
9faa7a88
RK
358 */
359static int exp_queue(int attribute((unused)) nargs,
360 const struct mx_node **args,
361 struct sink *output,
71634563 362 void *u) {
9faa7a88
RK
363 struct queue_entry *q;
364 int rc, i;
365
1e97629d
RK
366 dcgi_lookup(DCGI_QUEUE);
367 for(q = dcgi_queue, i = 0; q; q = q->next, ++i)
71634563
RK
368 if((rc = mx_expand(mx_rewritel(args[0],
369 "id", q->id,
370 "track", q->track,
371 "index", make_index(i),
372 "parity", i % 2 ? "odd" : "even",
1e97629d 373 "first", q == dcgi_queue ? "true" : "false",
71634563
RK
374 "last", q->next ? "false" : "true",
375 (char *)0),
376 output, u)))
9faa7a88
RK
377 return rc;
378 return 0;
379}
380
5c1ae3bc 381/*! @recent{TEMPLATE}
9faa7a88
RK
382 *
383 * For each track in the recently played list, expands TEMPLATE with the
384 * following expansions:
3e1616b6
RK
385 * - @id: the queue ID of the track
386 * - @track: the UNQUOTED track name
387 * - @index: the track number from 0
388 * - @parity: "even" or "odd" alternately
389 * - @first: "true" on the first track and "false" otherwise
390 * - @last: "true" on the last track and "false" otherwise
9faa7a88
RK
391 */
392static int exp_recent(int attribute((unused)) nargs,
393 const struct mx_node **args,
394 struct sink *output,
71634563 395 void *u) {
9faa7a88
RK
396 struct queue_entry *q;
397 int rc, i;
398
1e97629d
RK
399 dcgi_lookup(DCGI_RECENT);
400 for(q = dcgi_recent, i = 0; q; q = q->next, ++i)
71634563
RK
401 if((rc = mx_expand(mx_rewritel(args[0],
402 "id", q->id,
403 "track", q->track,
404 "index", make_index(i),
405 "parity", i % 2 ? "odd" : "even",
1e97629d 406 "first", q == dcgi_recent ? "true" : "false",
71634563
RK
407 "last", q->next ? "false" : "true",
408 (char *)0),
409 output, u)))
9faa7a88
RK
410 return rc;
411 return 0;
412}
413
5c1ae3bc 414/*! @new{TEMPLATE}
9faa7a88
RK
415 *
416 * For each track in the newly added list, expands TEMPLATE wit the following
417 * expansions:
3e1616b6
RK
418 * - @track: the UNQUOTED track name
419 * - @index: the track number from 0
420 * - @parity: "even" or "odd" alternately
421 * - @first: "true" on the first track and "false" otherwise
422 * - @last: "true" on the last track and "false" otherwise
9faa7a88 423 *
9bf61b29
RK
424 * Note that unlike @playing, @queue and @recent which are otherwise
425 * superficially similar, there is no @id sub-expansion here.
9faa7a88
RK
426 */
427static int exp_new(int attribute((unused)) nargs,
428 const struct mx_node **args,
429 struct sink *output,
71634563 430 void *u) {
9faa7a88
RK
431 int rc, i;
432
1e97629d 433 dcgi_lookup(DCGI_NEW);
9faa7a88 434 /* TODO perhaps we should generate an ID value for tracks in the new list */
1e97629d 435 for(i = 0; i < dcgi_nnew; ++i)
71634563 436 if((rc = mx_expand(mx_rewritel(args[0],
1e97629d 437 "track", dcgi_new[i],
71634563
RK
438 "index", make_index(i),
439 "parity", i % 2 ? "odd" : "even",
440 "first", i == 0 ? "true" : "false",
1e97629d 441 "last", i == dcgi_nnew - 1 ? "false" : "true",
71634563
RK
442 (char *)0),
443 output, u)))
9faa7a88
RK
444 return rc;
445 return 0;
446}
447
5c1ae3bc 448/*! @volume{CHANNEL}
9faa7a88
RK
449 *
450 * Expands to the volume in a given channel. CHANNEL must be "left" or
451 * "right".
452 */
453static int exp_volume(int attribute((unused)) nargs,
454 char **args,
455 struct sink *output,
456 void attribute((unused)) *u) {
1e97629d 457 dcgi_lookup(DCGI_VOLUME);
71634563
RK
458 return sink_printf(output, "%d",
459 !strcmp(args[0], "left")
1e97629d 460 ? dcgi_volume_left : dcgi_volume_right) < 0 ? -1 : 0;
9faa7a88
RK
461}
462
5c1ae3bc 463/*! @isplaying
9faa7a88
RK
464 *
465 * Expands to "true" if there is a playing track, otherwise "false".
466 */
467static int exp_isplaying(int attribute((unused)) nargs,
468 char attribute((unused)) **args,
469 struct sink *output,
470 void attribute((unused)) *u) {
1e97629d
RK
471 dcgi_lookup(DCGI_PLAYING);
472 return mx_bool_result(output, !!dcgi_playing);
9faa7a88
RK
473}
474
5c1ae3bc 475/*! @isqueue
9faa7a88
RK
476 *
477 * Expands to "true" if there the queue is nonempty, otherwise "false".
478 */
479static int exp_isqueue(int attribute((unused)) nargs,
480 char attribute((unused)) **args,
481 struct sink *output,
482 void attribute((unused)) *u) {
1e97629d
RK
483 dcgi_lookup(DCGI_QUEUE);
484 return mx_bool_result(output, !!dcgi_queue);
9faa7a88
RK
485}
486
5c1ae3bc 487/*! @isrecent@
9faa7a88
RK
488 *
489 * Expands to "true" if there the recently played list is nonempty, otherwise
490 * "false".
491 */
492static int exp_isrecent(int attribute((unused)) nargs,
493 char attribute((unused)) **args,
494 struct sink *output,
495 void attribute((unused)) *u) {
1e97629d
RK
496 dcgi_lookup(DCGI_RECENT);
497 return mx_bool_result(output, !!dcgi_recent);
9faa7a88
RK
498}
499
5c1ae3bc 500/*! @isnew
9faa7a88
RK
501 *
502 * Expands to "true" if there the newly added track list is nonempty, otherwise
503 * "false".
504 */
505static int exp_isnew(int attribute((unused)) nargs,
506 char attribute((unused)) **args,
507 struct sink *output,
508 void attribute((unused)) *u) {
1e97629d
RK
509 dcgi_lookup(DCGI_NEW);
510 return mx_bool_result(output, !!dcgi_nnew);
9faa7a88
RK
511}
512
5c1ae3bc 513/*! @pref{TRACK}{KEY}
9faa7a88
RK
514 *
515 * Expands to a track preference.
516 */
517static int exp_pref(int attribute((unused)) nargs,
518 char **args,
519 struct sink *output,
520 void attribute((unused)) *u) {
521 char *value;
522
1e97629d 523 if(dcgi_client && !disorder_get(dcgi_client, args[0], args[1], &value))
71634563
RK
524 return sink_writes(output, cgi_sgmlquote(value)) < 0 ? -1 : 0;
525 return 0;
9faa7a88
RK
526}
527
5c1ae3bc 528/*! @prefs{TRACK}{TEMPLATE}
9faa7a88
RK
529 *
530 * For each track preference of track TRACK, expands TEMPLATE with the
531 * following expansions:
3e1616b6
RK
532 * - @name: the UNQUOTED preference name
533 * - @index: the preference number from 0
534 * - @value: the UNQUOTED preference value
535 * - @parity: "even" or "odd" alternately
536 * - @first: "true" on the first preference and "false" otherwise
537 * - @last: "true" on the last preference and "false" otherwise
9faa7a88 538 *
9bf61b29 539 * Use @quote to quote preference names and values where necessary; see below.
9faa7a88
RK
540 */
541static int exp_prefs(int attribute((unused)) nargs,
542 const struct mx_node **args,
543 struct sink *output,
71634563 544 void *u) {
9faa7a88
RK
545 int rc, i;
546 struct kvp *k, *head;
547 char *track;
548
549 if((rc = mx_expandstr(args[0], &track, u, "argument #0 (TRACK)")))
550 return rc;
1e97629d 551 if(!dcgi_client || disorder_prefs(dcgi_client, track, &head))
9faa7a88
RK
552 return 0;
553 for(k = head, i = 0; k; k = k->next, ++i)
71634563
RK
554 if((rc = mx_expand(mx_rewritel(args[1],
555 "index", make_index(i),
556 "parity", i % 2 ? "odd" : "even",
557 "name", k->name,
558 "value", k->value,
559 "first", k == head ? "true" : "false",
560 "last", k->next ? "false" : "true",
561 (char *)0),
562 output, u)))
9faa7a88
RK
563 return rc;
564 return 0;
565}
566
5c1ae3bc 567/*! @transform{TRACK}{TYPE}{CONTEXT}
9faa7a88
RK
568 *
569 * Transforms a track name (if TYPE is "track") or directory name (if type is
570 * "dir"). CONTEXT should be the context, if it is left out then "display" is
571 * assumed.
572 */
573static int exp_transform(int nargs,
574 char **args,
575 struct sink *output,
576 void attribute((unused)) *u) {
577 const char *t = trackname_transform(args[1], args[0],
71634563
RK
578 (nargs > 2 ? args[2] : "display"));
579 return sink_writes(output, cgi_sgmlquote(t)) < 0 ? -1 : 0;
9faa7a88
RK
580}
581
5c1ae3bc 582/*! @enabled@
9faa7a88
RK
583 *
584 * Expands to "true" if playing is enabled, otherwise "false".
585 */
586static int exp_enabled(int attribute((unused)) nargs,
587 char attribute((unused)) **args,
588 struct sink *output,
589 void attribute((unused)) *u) {
1e97629d 590 int e = 0;
9faa7a88 591
1e97629d
RK
592 if(dcgi_client)
593 disorder_enabled(dcgi_client, &e);
594 return mx_bool_result(output, e);
9faa7a88
RK
595}
596
5c1ae3bc 597/*! @random-enabled
9faa7a88
RK
598 *
599 * Expands to "true" if random play is enabled, otherwise "false".
600 */
71634563
RK
601static int exp_random_enabled(int attribute((unused)) nargs,
602 char attribute((unused)) **args,
603 struct sink *output,
604 void attribute((unused)) *u) {
1e97629d 605 int e = 0;
9faa7a88 606
1e97629d
RK
607 if(dcgi_client)
608 disorder_random_enabled(dcgi_client, &e);
609 return mx_bool_result(output, e);
9faa7a88
RK
610}
611
5c1ae3bc 612/*! @trackstate{TRACK}
9faa7a88
RK
613 *
614 * Expands to "playing" if TRACK is currently playing, or "queue" if it is in
615 * the queue, otherwise to nothing.
616 */
617static int exp_trackstate(int attribute((unused)) nargs,
618 char **args,
619 struct sink *output,
620 void attribute((unused)) *u) {
621 char *track;
622 struct queue_entry *q;
623
1e97629d 624 if(!dcgi_client)
9faa7a88 625 return 0;
1e97629d 626 if(disorder_resolve(dcgi_client, &track, args[0]))
9faa7a88 627 return 0;
1e97629d
RK
628 dcgi_lookup(DCGI_PLAYING);
629 if(dcgi_playing && !strcmp(track, dcgi_playing->track))
71634563 630 return sink_writes(output, "playing") < 0 ? -1 : 0;
1e97629d
RK
631 dcgi_lookup(DCGI_QUEUE);
632 for(q = dcgi_queue; q; q = q->next)
9faa7a88 633 if(!strcmp(track, q->track))
71634563 634 return sink_writes(output, "queued") < 0 ? -1 : 0;
9faa7a88
RK
635 return 0;
636}
637
5c1ae3bc 638/*! @thisurl
9faa7a88
RK
639 *
640 * Expands to an UNQUOTED URL which points back to the current page. (NB it
641 * might not be byte for byte identical - for instance, CGI arguments might be
642 * re-ordered.)
643 */
644static int exp_thisurl(int attribute((unused)) nargs,
645 char attribute((unused)) **args,
646 struct sink *output,
647 void attribute((unused)) *u) {
71634563 648 return sink_writes(output, cgi_thisurl(config->url)) < 0 ? -1 : 0;
9faa7a88
RK
649}
650
5c1ae3bc 651/*! @resolve{TRACK}
9faa7a88
RK
652 *
653 * Expands to an UNQUOTED name for the TRACK that is not an alias, or to
654 * nothing if it is not a valid track.
655 */
656static int exp_resolve(int attribute((unused)) nargs,
657 char **args,
658 struct sink *output,
659 void attribute((unused)) *u) {
660 char *r;
661
1e97629d 662 if(dcgi_client && !disorder_resolve(dcgi_client, &r, args[0]))
71634563 663 return sink_writes(output, r) < 0 ? -1 : 0;
9faa7a88
RK
664 return 0;
665}
666
5c1ae3bc 667/*! @paused
9faa7a88
RK
668 *
669 * Expands to "true" if the playing track is paused, to "false" if it is
670 * playing (or if there is no playing track at all).
671 */
672static int exp_paused(int attribute((unused)) nargs,
673 char attribute((unused)) **args,
674 struct sink *output,
48e472fa 675 void attribute((unused)) *u) {
1e97629d
RK
676 dcgi_lookup(DCGI_PLAYING);
677 return mx_bool_result(output, (dcgi_playing
678 && dcgi_playing->state == playing_paused));
9faa7a88
RK
679}
680
5c1ae3bc 681/*! @state{ID}@
9faa7a88
RK
682 *
683 * Expands to the current state of track ID.
684 */
685static int exp_state(int attribute((unused)) nargs,
686 char **args,
687 struct sink *output,
688 void attribute((unused)) *u) {
a2c4ad5f 689 struct queue_entry *q = dcgi_findtrack(args[0]);
9faa7a88
RK
690
691 if(q)
71634563 692 return sink_writes(output, playing_states[q->state]) < 0 ? -1 : 0;
9faa7a88
RK
693 return 0;
694}
695
5c1ae3bc 696/*! @right{RIGHT}{WITH-RIGHT}{WITHOUT-RIGHT}@
9faa7a88
RK
697 *
698 * Expands to WITH-RIGHT if the current user has right RIGHT, otherwise to
699 * WITHOUT-RIGHT. The WITHOUT-RIGHT argument may be left out.
700 *
701 * If both WITH-RIGHT and WITHOUT-RIGHT are left out then expands to "true" if
702 * the user has the right and "false" otherwise.
703 *
704 * If there is no connection to the server then expands to nothing (in all
705 * cases).
706 */
707static int exp_right(int nargs,
708 const struct mx_node **args,
709 struct sink *output,
71634563 710 void *u) {
9faa7a88
RK
711 char *right;
712 rights_type r;
71634563 713 int rc;
9faa7a88 714
1e97629d 715 if(!dcgi_client)
9faa7a88 716 return 0;
1e97629d 717 dcgi_lookup(DCGI_RIGHTS);
71634563 718 if((rc = mx_expandstr(args[0], &right, u, "argument #0 (RIGHT)")))
9faa7a88
RK
719 return rc;
720 if(parse_rights(right, &r, 1/*report*/))
721 return 0;
722 /* Single-argument form */
723 if(nargs == 1)
1e97629d 724 return mx_bool_result(output, !!(r & dcgi_rights));
9faa7a88 725 /* Multiple argument form */
1e97629d 726 if(r & dcgi_rights)
71634563 727 return mx_expand(args[1], output, u);
9faa7a88 728 if(nargs == 3)
71634563 729 return mx_expand(args[2], output, u);
9faa7a88
RK
730 return 0;
731}
732
5c1ae3bc 733/*! @userinfo{PROPERTY}
9faa7a88
RK
734 *
735 * Expands to the named property of the current user.
736 */
737static int exp_userinfo(int attribute((unused)) nargs,
738 char **args,
739 struct sink *output,
740 void attribute((unused)) *u) {
741 char *v;
742
1e97629d
RK
743 if(dcgi_client
744 && !disorder_userinfo(dcgi_client, disorder_user(dcgi_client),
745 args[0], &v))
71634563 746 return sink_writes(output, v) < 0 ? -1 : 0;
9faa7a88
RK
747 return 0;
748}
749
5c1ae3bc 750/*! @error
bca4e2b7
RK
751 *
752 * Expands to the latest error string.
753 */
754static int exp_error(int attribute((unused)) nargs,
755 char attribute((unused)) **args,
756 struct sink *output,
757 void attribute((unused)) *u) {
343d9c2b
RK
758 return sink_writes(output, dcgi_error_string ? dcgi_error_string : "")
759 < 0 ? -1 : 0;
760}
761
5c1ae3bc 762/*! @status
343d9c2b
RK
763 *
764 * Expands to the latest status string.
765 */
766static int exp_status(int attribute((unused)) nargs,
767 char attribute((unused)) **args,
768 struct sink *output,
769 void attribute((unused)) *u) {
770 return sink_writes(output, dcgi_status_string ? dcgi_status_string : "")
771 < 0 ? -1 : 0;
bca4e2b7
RK
772}
773
5c1ae3bc 774/*! @image{NAME}
30d85588
RK
775 *
776 * Expands to the URL of the image called NAME.
777 *
778 * Firstly if there is a label called images.NAME then the image stem will be
779 * the value of that label. Otherwise the stem will be NAME.png.
780 *
781 * If the label url.static exists then it will give the base URL for images.
782 * Otherwise the base url will be /disorder/.
783 */
784static int exp_image(int attribute((unused)) nargs,
785 char **args,
786 struct sink *output,
787 void attribute((unused)) *u) {
788 const char *url, *stem;
789 char *labelname;
790
791 /* Compute the stem */
792 byte_xasprintf(&labelname, "images.%s", args[0]);
793 if(option_label_exists(labelname))
794 stem = option_label(labelname);
795 else
796 byte_xasprintf((char **)&stem, "%s.png", args[0]);
797 /* If the stem looks like it's reasonalby complete, use that */
798 if(stem[0] == '/'
799 || !strncmp(stem, "http:", 5)
800 || !strncmp(stem, "https:", 6))
801 url = stem;
802 else {
803 /* Compute the URL */
804 if(option_label_exists("url.static"))
805 byte_xasprintf((char **)&url, "%s/%s",
806 option_label("url.static"), stem);
807 else
808 /* Default base is /disorder */
809 byte_xasprintf((char **)&url, "/disorder/%s", stem);
810 }
811 return sink_writes(output, cgi_sgmlquote(url)) < 0 ? -1 : 0;
812}
813
9bf61b29
RK
814/** @brief Implementation of exp_tracks() and exp_dirs() */
815static int exp__files_dirs(int nargs,
816 const struct mx_node **args,
817 struct sink *output,
818 void *u,
819 const char *type,
820 int (*fn)(disorder_client *client,
821 const char *name,
822 const char *re,
823 char ***vecp,
824 int *nvecp)) {
825 char **tracks, *dir, *re;
826 int n, ntracks, rc;
827 const struct mx_node *m;
e13809e4 828 struct tracksort_data *tsd;
9bf61b29
RK
829
830 if((rc = mx_expandstr(args[0], &dir, u, "argument #0 (DIR)")))
831 return rc;
832 if(nargs == 3) {
833 if((rc = mx_expandstr(args[1], &re, u, "argument #1 (RE)")))
834 return rc;
835 m = args[2];
836 } else {
837 re = 0;
838 m = args[1];
839 }
840 if(!dcgi_client)
841 return 0;
842 /* Get the list */
843 if(fn(dcgi_client, dir, re, &tracks, &ntracks))
844 return 0;
845 /* Sort it. NB trackname_transform() does not go to the server. */
e13809e4 846 tsd = tracksort_init(ntracks, tracks, type);
48e472fa
RK
847 /* Expand the subsiduary templates. We chuck in @sort and @display because
848 * it is particularly easy to do so. */
9bf61b29
RK
849 for(n = 0; n < ntracks; ++n)
850 if((rc = mx_expand(mx_rewritel(m,
851 "index", make_index(n),
852 "parity", n % 2 ? "odd" : "even",
e13809e4 853 "track", tsd[n].track,
9bf61b29
RK
854 "first", n == 0 ? "true" : "false",
855 "last", n + 1 == ntracks ? "false" : "true",
e13809e4
RK
856 "sort", tsd[n].sort,
857 "display", tsd[n].display,
9bf61b29
RK
858 (char *)0),
859 output, u)))
860 return rc;
861 return 0;
862
863}
864
5c1ae3bc 865/*! @tracks{DIR}{RE}{TEMPLATE}
9bf61b29
RK
866 *
867 * For each track below DIR, expands TEMPLATE with the
868 * following expansions:
3e1616b6
RK
869 * - @track: the UNQUOTED track name
870 * - @index: the track number from 0
871 * - @parity: "even" or "odd" alternately
872 * - @first: "true" on the first track and "false" otherwise
873 * - @last: "true" on the last track and "false" otherwise
874 * - @sort: the sort key for this track
875 * - @display: the UNQUOTED display string for this track
9bf61b29
RK
876 *
877 * RE is optional and if present is the regexp to match against.
878 */
879static int exp_tracks(int nargs,
880 const struct mx_node **args,
881 struct sink *output,
882 void *u) {
883 return exp__files_dirs(nargs, args, output, u, "track", disorder_files);
884}
885
5c1ae3bc 886/*! @dirs{DIR}{RE}{TEMPLATE}
9bf61b29
RK
887 *
888 * For each directory below DIR, expands TEMPLATE with the
889 * following expansions:
3e1616b6
RK
890 * - @track: the UNQUOTED directory name
891 * - @index: the directory number from 0
892 * - @parity: "even" or "odd" alternately
893 * - @first: "true" on the first directory and "false" otherwise
894 * - @last: "true" on the last directory and "false" otherwise
895 * - @sort: the sort key for this directory
896 * - @display: the UNQUOTED display string for this directory
9bf61b29
RK
897 *
898 * RE is optional and if present is the regexp to match against.
899 */
900static int exp_dirs(int nargs,
901 const struct mx_node **args,
902 struct sink *output,
903 void *u) {
904 return exp__files_dirs(nargs, args, output, u, "dir", disorder_directories);
905}
906
b43dc0cc
RK
907static int exp__search_shim(disorder_client *c, const char *terms,
908 const char attribute((unused)) *re,
909 char ***vecp, int *nvecp) {
910 return disorder_search(c, terms, vecp, nvecp);
911}
912
5c1ae3bc 913/*! @search{KEYWORDS}{TEMPLATE}
b43dc0cc
RK
914 *
915 * For each track matching KEYWORDS, expands TEMPLATE with the
916 * following expansions:
3e1616b6
RK
917 * - @track: the UNQUOTED directory name
918 * - @index: the directory number from 0
919 * - @parity: "even" or "odd" alternately
920 * - @first: "true" on the first directory and "false" otherwise
921 * - @last: "true" on the last directory and "false" otherwise
922 * - @sort: the sort key for this track
923 * - @display: the UNQUOTED display string for this track
b43dc0cc
RK
924 */
925static int exp_search(int nargs,
99955407
RK
926 const struct mx_node **args,
927 struct sink *output,
928 void *u) {
b43dc0cc
RK
929 return exp__files_dirs(nargs, args, output, u, "track", exp__search_shim);
930}
931
5c1ae3bc 932/*! @label{NAME}
f4a26919
RK
933 *
934 * Expands to label NAME from options.labels. Undefined lables expand to the
935 * last dot-separated component, e.g. X.Y.Z to Z.
936 */
99955407
RK
937static int exp_label(int attribute((unused)) nargs,
938 char **args,
939 struct sink *output,
940 void attribute((unused)) *u) {
941 return sink_writes(output, option_label(args[0])) < 0 ? -1 : 0;
942}
943
5c1ae3bc 944/*! @breadcrumbs{DIR}{TEMPLATE}
f4a26919
RK
945 *
946 * Expands TEMPLATE for each directory in the path up to DIR, excluding the root
947 * but including DIR itself, with the following expansions:
948 * - @dir: the directory
949 * - @last: "true" if this is the last directory, otherwise "false"
950 *
951 * DIR must be an absolute path.
952 */
953static int exp_breadcrumbs(int attribute((unused)) nargs,
954 const struct mx_node **args,
955 struct sink *output,
956 void attribute((unused)) *u) {
957 int rc;
958 char *dir, *parent, *ptr;
959
960 if((rc = mx_expandstr(args[0], &dir, u, "argument #0 (DIR)")))
961 return rc;
962 /* Reject relative paths */
963 if(dir[0] != '/') {
964 error(0, "breadcrumbs: '%s' is a relative path", dir);
965 return 0;
966 }
967 /* Skip the root */
968 ptr = dir + 1;
969 while(*ptr) {
970 /* Find the end of this directory */
971 while(*ptr && *ptr != '/')
972 ++ptr;
973 parent = xstrndup(dir, ptr - dir);
974 if((rc = mx_expand(mx_rewritel(args[1],
975 "dir", parent,
976 "last", *ptr ? "false" : "true",
977 (char *)0),
978 output, u)))
979 return rc;
980 if(*ptr)
981 ++ptr;
982 }
983 return 0;
984}
985
9faa7a88 986/** @brief Register DisOrder-specific expansions */
1e97629d 987void dcgi_expansions(void) {
71634563 988 mx_register("arg", 1, 1, exp_arg);
48e472fa 989 mx_register("argq", 1, 1, exp_argq);
71634563
RK
990 mx_register("enabled", 0, 0, exp_enabled);
991 mx_register("error", 0, 0, exp_error);
30d85588 992 mx_register("image", 1, 1, exp_image);
71634563
RK
993 mx_register("isnew", 0, 0, exp_isnew);
994 mx_register("isplaying", 0, 0, exp_isplaying);
99955407 995 mx_register("isqueue", 0, 0, exp_isqueue);
71634563 996 mx_register("isrecent", 0, 0, exp_isrecent);
99955407 997 mx_register("label", 1, 1, exp_label);
71634563 998 mx_register("length", 1, 1, exp_length);
99955407 999 mx_register("movable", 1, 2, exp_movable);
71634563
RK
1000 mx_register("part", 2, 3, exp_part);
1001 mx_register("paused", 0, 0, exp_paused);
1002 mx_register("pref", 2, 2, exp_pref);
1003 mx_register("quote", 1, 1, exp_quote);
1004 mx_register("random-enabled", 0, 0, exp_random_enabled);
1005 mx_register("removable", 1, 1, exp_removable);
1006 mx_register("resolve", 1, 1, exp_resolve);
1007 mx_register("server-version", 0, 0, exp_server_version);
1008 mx_register("state", 1, 1, exp_state);
343d9c2b 1009 mx_register("status", 0, 0, exp_status);
71634563
RK
1010 mx_register("thisurl", 0, 0, exp_thisurl);
1011 mx_register("trackstate", 1, 1, exp_trackstate);
1012 mx_register("transform", 2, 3, exp_transform);
1013 mx_register("url", 0, 0, exp_url);
1014 mx_register("user", 0, 0, exp_user);
1015 mx_register("userinfo", 1, 1, exp_userinfo);
1016 mx_register("version", 0, 0, exp_version);
1017 mx_register("volume", 1, 1, exp_volume);
1018 mx_register("when", 1, 1, exp_when);
1019 mx_register("who", 1, 1, exp_who);
f4a26919 1020 mx_register_magic("breadcrumbs", 2, 2, exp_breadcrumbs);
9bf61b29 1021 mx_register_magic("dirs", 2, 3, exp_dirs);
71634563
RK
1022 mx_register_magic("new", 1, 1, exp_new);
1023 mx_register_magic("playing", 0, 1, exp_playing);
1024 mx_register_magic("prefs", 2, 2, exp_prefs);
1025 mx_register_magic("queue", 1, 1, exp_queue);
1026 mx_register_magic("recent", 1, 1, exp_recent);
1027 mx_register_magic("right", 1, 3, exp_right);
b43dc0cc 1028 mx_register_magic("search", 2, 2, exp_search);
9bf61b29 1029 mx_register_magic("tracks", 2, 3, exp_tracks);
bca4e2b7
RK
1030}
1031
9faa7a88
RK
1032/*
1033Local Variables:
1034c-basic-offset:2
1035comment-column:40
1036fill-column:79
1037indent-tabs-mode:nil
1038End:
1039*/