chiark - git - mdw - disorder/blob - scripts/protocol

   1 #! /usr/bin/perl -w
   2 #
   3 # This file is part of DisOrder.
   4 # Copyright (C) 2010 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 3 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,
  12 # but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 # GNU 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, see <http://www.gnu.org/licenses/>.
  18 #
  19 use strict;
  20
  21 # Variables and utilities -----------------------------------------------------
  22
  23 our @h = ();
  24 our @c = ();
  25
  26 sub Write {
  27     my $path = shift;
  28     my $lines = shift;
  29
  30     (open(F, ">$path")
  31      and print F @$lines
  32      and close F)
  33         or die "$0: $path: $!\n";
  34 }
  35
  36 # Command classes -------------------------------------------------------------
  37
  38 # simple(CMD, SUMMARY, DETAIL, [[NAME,DESCR], [NAME,DESCR], ...],)
  39 #
  40 # Response is simply success/failure
  41 sub simple {
  42     my $cmd = shift;
  43     my $summary = shift;
  44     my $detail = shift;
  45     my $args = shift;
  46
  47     my $cmdc = $cmd;
  48     $cmdc =~ s/-/_/g;
  49     # Synchronous C API
  50     push(@h, "/** \@brief $summary\n",
  51          " *\n",
  52          " * $detail\n",
  53          " *\n",
  54          map(" * \@param $_->[0] $_->[1]\n", @$args),
  55          " * \@return 0 on success, non-0 on error\n",
  56          " */\n",
  57          "int disorder_$cmdc(disorder_client *c",
  58          map(", const char *$_->[0]", @$args), ");\n",
  59          "\n");
  60     push(@c, "int disorder_$cmdc(disorder_client *c",
  61          map(", const char *$_->[0]", @$args), ") {\n",
  62          "  return disorder_simple(c, 0, \"$cmd\"",
  63          map(", $_->[0]", @$args),
  64          ", (char *)0);\n",
  65          "}\n\n");
  66
  67     # Asynchronous C API
  68     # TODO
  69
  70     # Python API
  71     # TODO
  72
  73     # Java API
  74     # TODO
  75 }
  76
  77 # string(CMD, SUMMARY, DETAIL, [[NAME,DESCR], [NAME,DESCR], ...], [RETURN, DESCR])
  78 #
  79 # Response is a string, or failure, or 555 for "none".
  80 sub string {
  81     my $cmd = shift;
  82     my $summary = shift;
  83     my $detail = shift;
  84     my $args = shift;
  85     my $return = shift;
  86
  87     my $cmdc = $cmd;
  88     $cmdc =~ s/-/_/g;
  89     # Synchronous C API
  90     push(@h, "/** \@brief $summary\n",
  91          " *\n",
  92          " * $detail\n",
  93          " *\n",
  94          map(" * \@param $_->[0] $_->[1]\n", @$args),
  95          " * \@param $return->[0]p $return->[1]\n",
  96          " * \@return 0 on success, non-0 on error\n",
  97          " */\n",
  98          "int disorder_$cmdc(disorder_client *c",
  99          map(", const char *$_->[0]", @$args),
 100          ", char **$return->[0]p);\n",
 101          "\n");
 102     push(@c, "int disorder_$cmdc(disorder_client *c",
 103          map(", const char *$_->[0]", @$args),
 104          ", char **$return->[0]p) {\n",
 105          "  return dequote(disorder_simple(c, $return->[0]p, \"$cmd\"",
 106          map(", $_->[0]", @$args),
 107          ", (char *)0), $return->[0]p);\n",
 108          "}\n\n");
 109
 110     # Asynchronous C API
 111     # TODO
 112
 113     # Python API
 114     # TODO
 115
 116     # Java API
 117     # TODO
 118 }
 119
 120 # string_login(CMD, SUMMARY, DETAIL, [[NAME,DESCR], [NAME,DESCR], ...])
 121 #
 122 # Like string(), but the server returns a username, which we squirrel
 123 # away rather than returning to the caller.
 124 sub string_login {
 125     my $cmd = shift;
 126     my $summary = shift;
 127     my $detail = shift;
 128     my $args = shift;
 129     my $return = shift;
 130
 131     my $cmdc = $cmd;
 132     $cmdc =~ s/-/_/g;
 133     # Synchronous C API
 134     push(@h, "/** \@brief $summary\n",
 135          " *\n",
 136          " * $detail\n",
 137          " *\n",
 138          map(" * \@param $_->[0] $_->[1]\n", @$args),
 139          " * \@return 0 on success, non-0 on error\n",
 140          " */\n",
 141          "int disorder_$cmdc(disorder_client *c",
 142          map(", const char *$_->[0]", @$args),
 143          ");\n");
 144     push(@c, "int disorder_$cmdc(disorder_client *c",
 145          map(", const char *$_->[0]", @$args),
 146          ") {\n",
 147          "  char *u;\n",
 148          "  int rc;\n",
 149          "  if((rc = disorder_simple(c, &u, \"$cmd\"",
 150          map(", $_->[0]", @$args),
 151          "  )))\n",
 152          "    return rc;\n",
 153          "  c->user = u;\n",
 154          "  return 0;\n",
 155          "}\n\n");
 156
 157     # Asynchronous C API
 158     # TODO
 159
 160     # Python API
 161     # TODO
 162
 163     # Java API
 164     # TODO
 165 }
 166
 167 # boolean(CMD, SUMMARY, DETAIL, [[NAME,DESCR], [NAME,DESCR], ...], [RETURN, DESCR])
 168 #
 169 # Response is yes/no or failure
 170 sub boolean {
 171     my $cmd = shift;
 172     my $summary = shift;
 173     my $detail = shift;
 174     my $args = shift;
 175     my $return = shift;
 176
 177     my $cmdc = $cmd;
 178     $cmdc =~ s/-/_/g;
 179     # Synchronous C API
 180     push(@h, "/** \@brief $summary\n",
 181          " *\n",
 182          " * $detail\n",
 183          " *\n",
 184          map(" * \@param $_->[0] $_->[1]\n", @$args),
 185          " * \@param $return->[0]p $return->[1]\n",
 186          " * \@return 0 on success, non-0 on error\n",
 187          " */\n",
 188          "int disorder_$cmdc(disorder_client *c",
 189          map(", const char *$_->[0]", @$args),
 190          ", int *$return->[0]p);\n",
 191          "\n");
 192     push(@c, "int disorder_$cmdc(disorder_client *c",
 193          map(", const char *$_->[0]", @$args),
 194          ", int *$return->[0]p) {\n",
 195          "  char *v;\n",
 196          "  int rc;\n",
 197          "  if((rc = disorder_simple(c, &v, \"$cmd\"",
 198          map(", $_->[0]", @$args),
 199          ", (char *)0)))\n",
 200          "    return rc;\n",
 201          "  return boolean(\"$cmd\", v, $return->[0]p);\n",
 202          "}\n\n");
 203
 204     # Asynchronous C API
 205     # TODO
 206
 207     # Python API
 208     # TODO
 209
 210     # Java API
 211     # TODO
 212 }
 213
 214 # list(CMD, SUMMARY, DETAIL, [[NAME,DESCR], [NAME,DESCR], ...], [RETURN, DESCR])
 215 #
 216 # Response is a a list of strings in a dot-stuffed body
 217 sub list {
 218     my $cmd = shift;
 219     my $summary = shift;
 220     my $detail = shift;
 221     my $args = shift;
 222     my $return = shift;
 223
 224     my $cmdc = $cmd;
 225     $cmdc =~ s/-/_/g;
 226     # Synchronous C API
 227     push(@h, "/** \@brief $summary\n",
 228          " *\n",
 229          " * $detail\n",
 230          " *\n",
 231          map(" * \@param $_->[0] $_->[1]\n", @$args),
 232          " * \@param $return->[0]p $return->[1]\n",
 233          " * \@param n$return->[0]p Number of elements in $return->[0]p\n",
 234          " * \@return 0 on success, non-0 on error\n",
 235          " */\n",
 236          "int disorder_$cmdc(disorder_client *c",
 237          map(", const char *$_->[0]", @$args),
 238          ", char ***$return->[0]p, int *n$return->[0]p);\n",
 239          "\n");
 240     push(@c, "int disorder_$cmdc(disorder_client *c",
 241          map(", const char *$_->[0]", @$args),
 242          ", char ***$return->[0]p, int *n$return->[0]p) {\n",
 243          "  return disorder_simple_list(c, $return->[0]p, n$return->[0]p, \"$cmd\"",
 244          map(", $_->[0]", @$args),
 245          ", (char *)0);\n",
 246          "}\n\n");
 247
 248     # Asynchronous C API
 249     # TODO
 250
 251     # Python API
 252     # TODO
 253
 254     # Java API
 255     # TODO
 256 }
 257
 258 # TODO other command classes
 259
 260 # Front matter ----------------------------------------------------------------
 261
 262 our @gpl = ("/*\n",
 263             " * This file is part of DisOrder.\n",
 264             " * Copyright (C) 2010 Richard Kettlewell\n",
 265             " *\n",
 266             " * This program is free software: you can redistribute it and/or modify\n",
 267             " * it under the terms of the GNU General Public License as published by\n",
 268             " * the Free Software Foundation, either version 3 of the License, or\n",
 269             " * (at your option) any later version.\n",
 270             " *\n",
 271             " * This program is distributed in the hope that it will be useful,\n",
 272             " * but WITHOUT ANY WARRANTY; without even the implied warranty of\n",
 273             " * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\n",
 274             " * GNU General Public License for more details.\n",
 275             " *\n",
 276             " * You should have received a copy of the GNU General Public License\n",
 277             " * along with this program.  If not, see <http://www.gnu.org/licenses/>.\n",
 278             " */\n");
 279
 280
 281 push(@h, @gpl,
 282      "#ifndef CLIENT_STUBS_H\n",
 283      "#define CLIENT_STUBS_H\n",
 284      "\n");
 285
 286 push(@c, @gpl,
 287      "\n");
 288
 289 # The protocol ----------------------------------------------------------------
 290
 291 simple("adopt",
 292        "Adopt a track",
 293        "Makes the calling user owner of a randomly picked track.",
 294        [["id", "Track ID"]]);
 295
 296 simple("adduser",
 297        "Create a user",
 298        "Create a new user.  Requires the 'admin' right.  Email addresses etc must be filled in in separate commands.",
 299        [["user", "New username"],
 300         ["password", "Initial password"],
 301         ["rights", "Initial rights (optional)"]]);
 302
 303 list("allfiles",
 304      "List files and directories in a directory",
 305      "See 'files' and 'dirs' for more specific lists.",
 306      [["dir", "Directory to list (optional)"],
 307       ["re", "Regexp that results must match (optional)"]],
 308      ["files", "List of matching files and directories"]);
 309
 310 string_login("confirm",
 311              "Confirm registration",
 312              "The confirmation string must have been created with 'register'.  The username is returned so the caller knows who they are.",
 313              [["confirmation", "Confirmation string"]]);
 314
 315 string_login("cookie",
 316              "Log in with a cookie",
 317              "The cookie must have been created with 'make-cookie'.  The username is returned so the caller knows who they are.",
 318              [["cookie", "Cookie string"]]);
 319
 320 simple("deluser",
 321        "Delete user",
 322        "Requires the 'admin' right.",
 323        [["user", "User to delete"]]);
 324
 325 list("dirs",
 326      "List directories in a directory",
 327      "",
 328      [["dir", "Directory to list (optional)"],
 329       ["re", "Regexp that results must match (optional)"]],
 330      ["files", "List of matching directories"]);
 331
 332 simple("disable",
 333        "Disable play",
 334        "Play will stop at the end of the current track, if one is playing.  Requires the 'global prefs' right.",
 335        []);
 336
 337 simple("edituser",
 338        "Set a user property",
 339        "With the 'admin' right you can do anything.  Otherwise you need the 'userinfo' right and can only set 'email' and 'password'.",
 340        [["username", "User to modify"],
 341         ["property", "Property name"],
 342         ["value", "New property value"]]);
 343
 344 simple("enable",
 345        "Enable play",
 346        "Requires the 'global prefs' right.",
 347        []);
 348
 349 boolean("enabled",
 350         "Detect whether play is enabled",
 351         "",
 352         [],
 353         ["enabled", "1 if play is enabled and 0 otherwise"]);
 354
 355 boolean("exists",
 356         "Test whether a track exists",
 357         "",
 358         [["track", "Track name"]],
 359         ["exists", "1 if the track exists and 0 otherwise"]);
 360
 361 list("files",
 362      "List files in a directory",
 363      "",
 364      [["dir", "Directory to list (optional)"],
 365       ["re", "Regexp that results must match (optional)"]],
 366      ["files", "List of matching files"]);
 367
 368 string("get",
 369        "Get a track preference",
 370        "If the track does not exist that is an error.  If the track exists but the preference does not then a null value is returned.",
 371        [["track", "Track name"],
 372         ["pref", "Preference name"]],
 373        ["value", "Preference value"]);
 374
 375 string("get-global",
 376        "Get a global preference",
 377        "If the preference does exist not then a null value is returned.",
 378        [["pref", "Global preference name"]],
 379        ["value", "Preference value"]);
 380
 381 # TODO length
 382
 383 # TODO log
 384
 385 string("make-cookie",
 386        "Create a login cookie for this user",
 387        "The cookie may be redeemed via the 'cookie' command",
 388        [],
 389        ["cookie", "Newly created cookie"]);
 390
 391 # TODO move
 392
 393 # TODO moveafter
 394
 395 # TODO new
 396
 397 simple("nop",
 398        "Do nothing",
 399        "Used as a keepalive.  No authentication required.",
 400        []);
 401
 402 string("part",
 403        "Get a track name part",
 404        "If the name part cannot be constructed an empty string is returned.",
 405        [["track", "Track name"],
 406         ["context", "Context (\"sort\" or \"display\")"],
 407         ["part", "Name part (\"artist\", \"album\" or \"title\")"]],
 408        ["part", "Value of name part"]);
 409
 410 simple("pause",
 411        "Pause the currently playing track",
 412        "Requires the 'pause' right.",
 413        []);
 414
 415 # TODO playafter
 416
 417 # TODO playing
 418
 419 simple("playlist-delete",
 420        "Delete a playlist",
 421        "Requires the 'play' right and permission to modify the playlist.",
 422        [["playlist", "Playlist to delete"]]);
 423
 424 list("playlist-get",
 425      "List the contents of a playlist",
 426      "Requires the 'read' right and oermission to read the playlist.",
 427      [["playlist", "Playlist name"]],
 428      ["tracks", "List of tracks in playlist"]);
 429
 430 string("playlist-get-share",
 431        "Get a playlist's sharing status",
 432        "Requires the 'read' right and permission to read the playlist.",
 433        [["playlist", "Playlist to read"]],
 434        ["share", "Sharing status (\"public\", \"private\" or \"shared\")"]);
 435
 436 simple("playlist-lock",
 437        "Lock a playlist",
 438        "Requires the 'play' right and permission to modify the playlist.  A given connection may lock at most one playlist.",
 439        [["playlist", "Playlist to delete"]]);
 440
 441 simple("playlist-set-share",
 442        "Set a playlist's sharing status",
 443        "Requires the 'play' right and permission to modify the playlist.",
 444        [["playlist", "Playlist to modify"],
 445         ["share", "New sharing status (\"public\", \"private\" or \"shared\")"]]);
 446
 447 simple("playlist-unlock",
 448        "Unlock the locked playlist playlist",
 449        "The playlist to unlock is implicit in the connection.",
 450        []);
 451
 452 list("playlists",
 453      "List playlists",
 454      "Requires the 'read' right.  Only playlists that you have permission to read are returned.",
 455      [],
 456      ["playlists", "Playlist names"]);
 457
 458 # TODO prefs
 459
 460 # TODO queue
 461
 462 simple("random-disable",
 463        "Disable random play",
 464        "Requires the 'global prefs' right.",
 465        []);
 466
 467 simple("random-enable",
 468        "Enable random play",
 469        "Requires the 'global prefs' right.",
 470        []);
 471
 472 boolean("random-enabled",
 473         "Detect whether random play is enabled",
 474         "Random play counts as enabled even if play is disabled.",
 475         [],
 476         ["enabled", "1 if random play is enabled and 0 otherwise"]);
 477
 478 # TODO recent
 479
 480 simple("reconfigure",
 481        "Re-read configuraiton file.",
 482        "Requires the 'admin' right.",
 483        []);
 484
 485 string("register",
 486        "Register a new user",
 487        "Requires the 'register' right which is usually only available to the 'guest' user.  Redeem the confirmation string via 'confirm' to complete registration.",
 488        [["username", "Requested new username"],
 489         ["password", "Requested initial password"],
 490         ["email", "New user's email address"]],
 491        ["confirmation", "Confirmation string"]);
 492
 493 simple("reminder",
 494        "Send a password reminder.",
 495        "If the user has no valid email address, or no password, or a reminder has been sent too recently, then no reminder will be sent.",
 496        [["username", "User to remind"]]);
 497
 498 simple("remove",
 499        "Remove a track form the queue.",
 500        "Requires one of the 'remove mine', 'remove random' or 'remove any' rights depending on how the track came to be added to the queue.",
 501        [["id", "Track ID"]]);
 502
 503 simple("rescan",
 504        "Rescan all collections for new or obsolete tracks.",
 505        "Requires the 'rescan' right.",
 506        []);     # TODO wait/fresh flags
 507
 508 string("resolve",
 509        "Resolve a track name",
 510        "Converts aliases to non-alias track names",
 511        [["track", "Track name (might be an alias)"]],
 512        ["resolved", "Resolve track name (definitely not an alias)"]);
 513
 514 simple("resume",
 515        "Resume the currently playing track",
 516        "Requires the 'pause' right.",
 517        []);
 518
 519 simple("revoke",
 520        "Revoke a cookie.",
 521        "It will not subsequently be possible to log in with the cookie.",
 522        []);                     # TODO fix docs!
 523
 524 # TODO rtp-address
 525
 526 simple("scratch",
 527        "Terminate the playing track.",
 528        "Requires one of the 'scratch mine', 'scratch random' or 'scratch any' rights depending on how the track came to be added to the queue.",
 529        [["id", "Track ID (optional)"]]);
 530
 531 # TODO schedule-add
 532
 533 simple("schedule-del",
 534        "Delete a scheduled event.",
 535        "Users can always delete their own scheduled events; with the admin right you can delete any event.",
 536        [["event", "ID of event to delete"]]);
 537
 538 # TODO schedule-get
 539
 540 list("schedule-list",
 541      "List scheduled events",
 542      "This just lists IDs.  Use 'schedule-get' to retrieve more detail",
 543      [],
 544      ["ids", "List of event IDs"]);
 545
 546 list("search",
 547      "Search for tracks",
 548      "Terms are either keywords or tags formatted as 'tag:TAG-NAME'.",
 549      [["terms", "List of search terms"]],
 550      ["tracks", "List of matching tracks"]);
 551
 552 simple("set",
 553        "Set a track preference",
 554        "Requires the 'prefs' right.",
 555        [["track", "Track name"],
 556         ["pref", "Preference name"],
 557         ["value", "New value"]]);
 558
 559 simple("set-global",
 560        "Set a global preference",
 561        "Requires the 'global prefs' right.",
 562        [["pref", "Preference name"],
 563         ["value", "New value"]]);
 564
 565 # TODO shutdown (also needs documenting)
 566
 567 list("stats",
 568      "Get server statistics",
 569      "The details of what the server reports are not really defined.  The returned strings are intended to be printed out one to a line..",
 570      [],
 571      ["stats", "List of server information strings."]);
 572
 573 list("tags",
 574      "Get a list of known tags",
 575      "Only tags which apply to at least one track are returned.",
 576      [],
 577      ["tags", "List of tags"]);
 578
 579 simple("unset",
 580        "Unset a track preference",
 581        "Requires the 'prefs' right.",
 582        [["track", "Track name"],
 583         ["pref", "Preference name"]]);
 584
 585 simple("unset-global",
 586        "Set a global preference",
 587        "Requires the 'global prefs' right.",
 588        [["pref", "Preference name"]]);
 589
 590 # TODO user?
 591
 592 string("userinfo",
 593        "Get a user property.",
 594        "If the user does not exist an error is returned, if the user exists but the property does not then a null value is returned.",
 595        [["username", "User to read"],
 596         ["property", "Property to read"]],
 597        ["value", "Value of property"]);
 598
 599 list("users",
 600      "Get a list of users",
 601      "",
 602      [],
 603      ["users", "List of users"]);
 604
 605 string("version",
 606        "Get the server version",
 607        "",
 608        [],
 609        ["version", "Server version string"]);
 610
 611 # TODO volume
 612
 613 # End matter ------------------------------------------------------------------
 614
 615 push(@h, "#endif\n");
 616
 617 # Write it all out ------------------------------------------------------------
 618
 619 Write("lib/client-stubs.h", \@h);
 620 Write("lib/client-stubs.c", \@c);