chiark - git - mdw - disorder/blob - cgi/macros-disorder.c

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