3 # This file is part of DisOrder.
4 # Copyright (C) 2010-11 Richard Kettlewell
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.
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.
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/>.
21 # This file contains the definition of the disorder protocol, plus
22 # code to generates stubs for it in the various supported languages.
24 # At the time of writing it is a work in progress!
29 # string A (Unicode) string.
30 # string-raw A string that is not subject to de-quoting (return only)
31 # integer An integer. Decimal on the wire.
32 # time A timestamp. Decimal on the wire.
33 # boolean True or false. "yes" or "no" on the wire.
34 # list In commands: a list of strings in the command.
35 # In returns: a list of lines in the response.
36 # pair-list In returns: a list of key-value pairs in a response body.
37 # body In commands: a list of strings as a command body.
38 # In returns: a list of strings as a response body.
39 # queue In returns: a list of queue entries in a response body.
40 # queue-one In returns: a queue entry in the response.
41 # literal Constant string sent in sequence
44 # Variables and utilities -----------------------------------------------------
51 # Write array ref LINES to file PATH.
59 or die "$0: $path: $!\n";
62 # Command classes -------------------------------------------------------------
64 # c_in_decl([TYPE, NAME])
66 # Return the C declaration for an input parameter of type TYPE with
73 if($type eq 'string') {
74 return "const char *$name";
75 } elsif($type eq 'integer') {
77 } elsif($type eq 'time') {
78 return "time_t $name";
79 } elsif($type eq 'list' or $type eq 'body') {
80 return ("char **$name",
82 } elsif($type eq 'literal') {
85 die "$0: c_in_decl: unknown type '$type'\n";
89 # c_out_decl([TYPE, NAME])
91 # Return the C declaration for an output (reference) parameter of type
92 # TYPE with name NAME.
96 return () unless defined $arg;
99 if($type eq 'string' or $type eq 'string-raw') {
100 return ("char **${name}p");
101 } elsif($type eq 'integer') {
102 return ("long *${name}p");
103 } elsif($type eq 'time') {
104 return ("time_t *${name}p");
105 } elsif($type eq 'boolean') {
106 return ("int *${name}p");
107 } elsif($type eq 'list' or $type eq 'body') {
108 return ("char ***${name}p",
110 } elsif($type eq 'pair-list') {
111 return ("struct kvp **${name}p");
112 } elsif($type eq 'queue' or $type eq 'queue-one') {
113 return ("struct queue_entry **${name}p");
114 } elsif($type eq 'user') {
117 die "$0: c_out_decl: unknown type '$type'\n";
121 # c_param_docs([TYPE, NAME})
123 # Return the doc string for a C input parameter.
127 for my $arg (@$args) {
128 my $type = $arg->[0];
129 my $name = $arg->[1];
130 my $description = $arg->[2];
131 if($type eq 'body' or $type eq 'list') {
133 " * \@param $name $description\n",
134 " * \@param n$name Length of $name\n");
135 } elsif($type ne 'literal') {
136 push(@d, " * \@param $name $description\n");
142 # c_param_docs([TYPE, NAME})
144 # Return the doc string for a C output parameter.
147 return () unless defined $returns;
148 for my $return (@$returns) {
149 my $type = $return->[0];
150 my $name = $return->[1];
151 my $descr = $return->[2];
153 or $type eq 'string-raw'
154 or $type eq 'integer'
156 or $type eq 'boolean') {
157 return (" * \@param ${name}p $descr\n");
158 } elsif($type eq 'list' or $type eq 'body') {
159 return (" * \@param ${name}p $descr\n",
160 " * \@param n${name}p Number of elements in ${name}p\n");
161 } elsif($type eq 'pair-list') {
162 return (" * \@param ${name}p $descr\n");
163 } elsif($type eq 'queue' or $type eq 'queue-one') {
164 return (" * \@param ${name}p $descr\n");
165 } elsif($type eq 'user') {
168 die "$0: c_return_docs: unknown type '$type'\n";
173 # simple(CMD, SUMMARY, DETAIL,
174 # [[TYPE,NAME,DESCR], [TYPE,NAME,DESCR], ...],
175 # [[RETURN-TYPE, RETURN-NAME, RETURN_DESCR]])
177 # CMD is normally just the name of the command, but can
178 # be [COMMAND,FUNCTION] if the function name should differ
179 # from the protocol command.
188 if(ref $cmd eq 'ARRAY') {
195 print STDERR "Processing $cmd... ";
198 push(@h, "/** \@brief $summary\n",
202 " * \@param c Client\n",
204 c_return_docs($returns),
205 " * \@return 0 on success, non-0 on error\n",
207 "int disorder_$cmdc(",
208 join(", ", "disorder_client *c",
209 map(c_in_decl($_), @$args),
210 map(c_out_decl($_), @$returns)),
213 push(@c, "int disorder_$cmdc(",
214 join(", ", "disorder_client *c",
215 map(c_in_decl($_), @$args),
216 map(c_out_decl($_), @$returns)),
219 for my $arg (@$args) {
220 if($arg->[0] eq 'body' or $arg->[0] eq 'list') {
221 push(@cargs, "disorder_$arg->[0]", $arg->[1], "n$arg->[1]");
222 } elsif($arg->[0] eq 'string') {
223 push(@cargs, $arg->[1]);
224 } elsif($arg->[0] eq 'integer') {
225 push(@cargs, "buf_$arg->[1]");
226 push(@c, " char buf_$arg->[1]\[16];\n",
227 " byte_snprintf(buf_$arg->[1], sizeof buf_$arg->[1], \"%ld\", $arg->[1]);\n");
228 } elsif($arg->[0] eq 'time') {
229 push(@cargs, "buf_$arg->[1]");
230 push(@c, " char buf_$arg->[1]\[16];\n",
231 " byte_snprintf(buf_$arg->[1], sizeof buf_$arg->[1], \"%lld\", (long long)$arg->[1]);\n");
232 } elsif($arg->[0] eq 'literal') {
233 push(@cargs, "\"$arg->[1]\"");
235 die "$0: unsupported arg type '$arg->[0]' for '$cmd'\n";
238 if(!defined $returns or scalar @$returns == 0) {
240 push(@c, " return disorder_simple(",
241 join(", ", "c", "NULL", "\"$cmd\"", @cargs, "(char *)NULL"),
243 } elsif(scalar @$returns == 1
244 and $returns->[0]->[0] eq 'queue-one') {
246 my $return = $$returns[0];
247 push(@c, " return onequeue(c, \"$cmd\", $return->[1]p);\n");
248 } elsif(scalar @$returns == 1
249 and $returns->[0]->[0] eq 'string-raw') {
251 my $return = $$returns[0];
252 push(@c, " return disorder_simple(",
253 join(", ", "c", "$return->[1]p", "\"$cmd\"", @cargs, "(char *)NULL"),
255 } elsif(scalar @$returns == 1
256 and $returns->[0]->[0] eq 'pair-list') {
258 my $return = $$returns[0];
259 push(@c, " return pairlist(",
260 join(", ", "c", "$return->[1]p", "\"$cmd\"",
266 for(my $n = 0; $n < scalar @$returns; ++$n) {
267 my $return = $returns->[$n];
268 my $type = $return->[0];
269 my $name = $return->[1];
271 or $type eq 'boolean'
272 or $type eq 'integer'
274 or $type eq 'user') {
279 push(@c, " char **v;\n",
280 " int nv, rc = disorder_simple_split(",
294 " int rc = disorder_simple(",
305 for(my $n = 0; $n < scalar @$returns; ++$n) {
306 my $return = $returns->[$n];
307 my $type = $return->[0];
308 my $name = $return->[1];
309 if($type eq 'string') {
311 " *${name}p = v[$n];\n");
312 } elsif($type eq 'boolean') {
314 " if(boolean(\"$cmd\", v[$n], ${name}p))\n",
316 } elsif($type eq 'integer') {
318 " *${name}p = atol(v[$n]);\n");
319 } elsif($type eq 'time') {
321 " *${name}p = atoll(v[$n]);\n");
322 } elsif($type eq 'user') {
324 " c->user = v[$n];\n");
325 } elsif($type eq 'body') {
327 " if(readlist(c, ${name}p, n${name}p))\n",
329 } elsif($type eq 'queue') {
331 " if(readqueue(c, ${name}p))\n",
334 die "$0: C API: unknown return type '$type' for '$name'\n";
337 push(@c, " return 0;\n");
338 # TODO xfree unconsumed split output
353 # TODO other command classes
355 # Front matter ----------------------------------------------------------------
357 our @generated = ("/*\n",
358 " * Automatically generated file, see scripts/protocol\n",
364 " * This file is part of DisOrder.\n",
365 " * Copyright (C) 2010-11 Richard Kettlewell\n",
367 " * This program is free software: you can redistribute it and/or modify\n",
368 " * it under the terms of the GNU General Public License as published by\n",
369 " * the Free Software Foundation, either version 3 of the License, or\n",
370 " * (at your option) any later version.\n",
372 " * This program is distributed in the hope that it will be useful,\n",
373 " * but WITHOUT ANY WARRANTY; without even the implied warranty of\n",
374 " * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n",
375 " * GNU General Public License for more details.\n",
377 " * You should have received a copy of the GNU General Public License\n",
378 " * along with this program. If not, see <http://www.gnu.org/licenses/>.\n",
382 push(@h, @generated, @gpl,
383 "#ifndef CLIENT_STUBS_H\n",
384 "#define CLIENT_STUBS_H\n",
387 push(@c, @generated, @gpl,
390 # The protocol ----------------------------------------------------------------
394 "Makes the calling user owner of a randomly picked track.",
395 [["string", "id", "Track ID"]]);
399 "Create a new user. Requires the 'admin' right. Email addresses etc must be filled in in separate commands.",
400 [["string", "user", "New username"],
401 ["string", "password", "Initial password"],
402 ["string", "rights", "Initial rights (optional)"]]);
405 "List files and directories in a directory",
406 "See 'files' and 'dirs' for more specific lists.",
407 [["string", "dir", "Directory to list (optional)"],
408 ["string", "re", "Regexp that results must match (optional)"]],
409 [["body", "files", "List of matching files and directories"]]);
412 "Confirm registration",
413 "The confirmation string must have been created with 'register'. The username is returned so the caller knows who they are.",
414 [["string", "confirmation", "Confirmation string"]],
418 "Log in with a cookie",
419 "The cookie must have been created with 'make-cookie'. The username is returned so the caller knows who they are.",
420 [["string", "cookie", "Cookie string"]],
425 "Requires the 'admin' right.",
426 [["string", "user", "User to delete"]]);
429 "List directories in a directory",
431 [["string", "dir", "Directory to list (optional)"],
432 ["string", "re", "Regexp that results must match (optional)"]],
433 [["body", "files", "List of matching directories"]]);
437 "Play will stop at the end of the current track, if one is playing. Requires the 'global prefs' right.",
441 "Set a user property",
442 "With the 'admin' right you can do anything. Otherwise you need the 'userinfo' right and can only set 'email' and 'password'.",
443 [["string", "username", "User to modify"],
444 ["string", "property", "Property name"],
445 ["string", "value", "New property value"]]);
449 "Requires the 'global prefs' right.",
453 "Detect whether play is enabled",
456 [["boolean", "enabled", "1 if play is enabled and 0 otherwise"]]);
459 "Test whether a track exists",
461 [["string", "track", "Track name"]],
462 [["boolean", "exists", "1 if the track exists and 0 otherwise"]]);
465 "List files in a directory",
467 [["string", "dir", "Directory to list (optional)"],
468 ["string", "re", "Regexp that results must match (optional)"]],
469 [["body", "files", "List of matching files"]]);
472 "Get a track preference",
473 "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.",
474 [["string", "track", "Track name"],
475 ["string", "pref", "Preference name"]],
476 [["string", "value", "Preference value"]]);
479 "Get a global preference",
480 "If the preference does exist not then a null value is returned.",
481 [["string", "pref", "Global preference name"]],
482 [["string", "value", "Preference value"]]);
485 "Get a track's length",
486 "If the track does not exist an error is returned.",
487 [["string", "track", "Track name"]],
488 [["integer", "length", "Track length in seconds"]]);
492 simple("make-cookie",
493 "Create a login cookie for this user",
494 "The cookie may be redeemed via the 'cookie' command",
496 [["string", "cookie", "Newly created cookie"]]);
500 "Requires one of the 'move mine', 'move random' or 'move any' rights depending on how the track came to be added to the queue.",
501 [["string", "track", "Track ID or name"],
502 ["integer", "delta", "How far to move the track towards the head of the queue"]]);
505 "Move multiple tracks",
506 "Requires one of the 'move mine', 'move random' or 'move any' rights depending on how the track came to be added to the queue.",
507 [["string", "target", "Move after this track, or to head if \"\""],
508 ["list", "ids", "List of tracks to move by ID"]]);
510 simple(["new", "new_tracks"],
511 "List recently added tracks",
513 [["integer", "max", "Maximum tracks to fetch, or 0 for all available"]],
514 [["body", "tracks", "Recently added tracks"]]);
518 "Used as a keepalive. No authentication required.",
522 "Get a track name part",
523 "If the name part cannot be constructed an empty string is returned.",
524 [["string", "track", "Track name"],
525 ["string", "context", "Context (\"sort\" or \"display\")"],
526 ["string", "part", "Name part (\"artist\", \"album\" or \"title\")"]],
527 [["string", "part", "Value of name part"]]);
530 "Pause the currently playing track",
531 "Requires the 'pause' right.",
536 "Requires the 'play' right.",
537 [["string", "track", "Track to play"]],
538 [["string-raw", "id", "Queue ID of new track"]]);
541 "Play multiple tracks",
542 "Requires the 'play' right.",
543 [["string", "target", "Insert into queue after this track, or at head if \"\""],
544 ["list", "tracks", "List of track names to play"]]);
547 "Retrieve the playing track",
550 [["queue-one", "playing", "Details of the playing track"]]);
552 simple("playlist-delete",
554 "Requires the 'play' right and permission to modify the playlist.",
555 [["string", "playlist", "Playlist to delete"]]);
557 simple("playlist-get",
558 "List the contents of a playlist",
559 "Requires the 'read' right and oermission to read the playlist.",
560 [["string", "playlist", "Playlist name"]],
561 [["body", "tracks", "List of tracks in playlist"]]);
563 simple("playlist-get-share",
564 "Get a playlist's sharing status",
565 "Requires the 'read' right and permission to read the playlist.",
566 [["string", "playlist", "Playlist to read"]],
567 [["string-raw", "share", "Sharing status (\"public\", \"private\" or \"shared\")"]]);
569 simple("playlist-lock",
571 "Requires the 'play' right and permission to modify the playlist. A given connection may lock at most one playlist.",
572 [["string", "playlist", "Playlist to delete"]]);
574 simple("playlist-set",
575 "Set the contents of a playlist",
576 "Requires the 'play' right and permission to modify the playlist, which must be locked.",
577 [["string", "playlist", "Playlist to modify"],
578 ["body", "tracks", "New list of tracks for playlist"]]);
580 simple("playlist-set-share",
581 "Set a playlist's sharing status",
582 "Requires the 'play' right and permission to modify the playlist.",
583 [["string", "playlist", "Playlist to modify"],
584 ["string", "share", "New sharing status (\"public\", \"private\" or \"shared\")"]]);
586 simple("playlist-unlock",
587 "Unlock the locked playlist playlist",
588 "The playlist to unlock is implicit in the connection.",
593 "Requires the 'read' right. Only playlists that you have permission to read are returned.",
595 [["body", "playlists", "Playlist names"]]);
598 "Get all the preferences for a track",
600 [["string", "track", "Track name"]],
601 [["pair-list", "prefs", "Track preferences"]]);
607 [["queue", "queue", "Current queue contents"]]);
609 simple("random-disable",
610 "Disable random play",
611 "Requires the 'global prefs' right.",
614 simple("random-enable",
615 "Enable random play",
616 "Requires the 'global prefs' right.",
619 simple("random-enabled",
620 "Detect whether random play is enabled",
621 "Random play counts as enabled even if play is disabled.",
623 [["boolean", "enabled", "1 if random play is enabled and 0 otherwise"]]);
626 "List recently played tracks",
629 [["queue", "recent", "Recently played tracks"]]);
631 simple("reconfigure",
632 "Re-read configuraiton file.",
633 "Requires the 'admin' right.",
637 "Register a new user",
638 "Requires the 'register' right which is usually only available to the 'guest' user. Redeem the confirmation string via 'confirm' to complete registration.",
639 [["string", "username", "Requested new username"],
640 ["string", "password", "Requested initial password"],
641 ["string", "email", "New user's email address"]],
642 [["string", "confirmation", "Confirmation string"]]);
645 "Send a password reminder.",
646 "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.",
647 [["string", "username", "User to remind"]]);
650 "Remove a track form the queue.",
651 "Requires one of the 'remove mine', 'remove random' or 'remove any' rights depending on how the track came to be added to the queue.",
652 [["string", "id", "Track ID"]]);
655 "Rescan all collections for new or obsolete tracks.",
656 "Requires the 'rescan' right.",
657 []); # TODO wait/fresh flags
660 "Resolve a track name",
661 "Converts aliases to non-alias track names",
662 [["string", "track", "Track name (might be an alias)"]],
663 [["string", "resolved", "Resolve track name (definitely not an alias)"]]);
666 "Resume the currently playing track",
667 "Requires the 'pause' right.",
672 "It will not subsequently be possible to log in with the cookie.",
675 simple("rtp-address",
676 "Get the server's RTP address information",
679 [["string", "address", "Where to store hostname or address"],
680 ["string", "port", "Where to store service name or port number"]]);
683 "Terminate the playing track.",
684 "Requires one of the 'scratch mine', 'scratch random' or 'scratch any' rights depending on how the track came to be added to the queue.",
685 [["string", "id", "Track ID (optional)"]]);
687 simple(["schedule-add", "schedule_add_play"],
688 "Schedule a track to play in the future",
690 [["time", "when", "When to play the track"],
691 ["string", "priority", "Event priority (\"normal\" or \"junk\")"],
692 ["literal", "play", ""],
693 ["string", "track", "Track to play"]]);
695 simple(["schedule-add", "schedule_add_set_global"],
696 "Schedule a global setting to be changed in the future",
698 [["time", "when", "When to change the setting"],
699 ["string", "priority", "Event priority (\"normal\" or \"junk\")"],
700 ["literal", "set-global", ""],
701 ["string", "pref", "Global preference to set"],
702 ["string", "value", "New value of global preference"]]);
704 simple(["schedule-add", "schedule_add_unset_global"],
705 "Schedule a global setting to be unset in the future",
707 [["time", "when", "When to change the setting"],
708 ["string", "priority", "Event priority (\"normal\" or \"junk\")"],
709 ["literal", "set-global", ""],
710 ["string", "pref", "Global preference to set"]]);
712 simple("schedule-del",
713 "Delete a scheduled event.",
714 "Users can always delete their own scheduled events; with the admin right you can delete any event.",
715 [["string", "event", "ID of event to delete"]]);
717 simple("schedule-get",
718 "Get the details of scheduled event",
720 [["string", "id", "Event ID"]],
721 [["pair-list", "actiondata", "Details of event"]]);
723 simple("schedule-list",
724 "List scheduled events",
725 "This just lists IDs. Use 'schedule-get' to retrieve more detail",
727 [["body", "ids", "List of event IDs"]]);
731 "Terms are either keywords or tags formatted as 'tag:TAG-NAME'.",
732 [["string", "terms", "List of search terms"]],
733 [["body", "tracks", "List of matching tracks"]]);
736 "Set a track preference",
737 "Requires the 'prefs' right.",
738 [["string", "track", "Track name"],
739 ["string", "pref", "Preference name"],
740 ["string", "value", "New value"]]);
743 "Set a global preference",
744 "Requires the 'global prefs' right.",
745 [["string", "pref", "Preference name"],
746 ["string", "value", "New value"]]);
749 "Request server shutdown",
750 "Requires the 'admin' right.",
754 "Get server statistics",
755 "The details of what the server reports are not really defined. The returned strings are intended to be printed out one to a line.",
757 [["body", "stats", "List of server information strings."]]);
760 "Get a list of known tags",
761 "Only tags which apply to at least one track are returned.",
763 [["body", "tags", "List of tags"]]);
766 "Unset a track preference",
767 "Requires the 'prefs' right.",
768 [["string", "track", "Track name"],
769 ["string", "pref", "Preference name"]]);
771 simple("unset-global",
772 "Set a global preference",
773 "Requires the 'global prefs' right.",
774 [["string", "pref", "Preference name"]]);
776 # 'user' only used for authentication
779 "Get a user property.",
780 "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.",
781 [["string", "username", "User to read"],
782 ["string", "property", "Property to read"]],
783 [["string", "value", "Value of property"]]);
786 "Get a list of users",
789 [["body", "users", "List of users"]]);
792 "Get the server version",
795 [["string", "version", "Server version string"]]);
797 simple(["volume", "set_volume"],
800 [["integer", "left", "Left channel volume"],
801 ["integer", "right", "Right channel volume"]]);
803 simple(["volume", "get_volume"],
807 [["integer", "left", "Left channel volume"],
808 ["integer", "right", "Right channel volume"]]);
810 # End matter ------------------------------------------------------------------
812 push(@h, "#endif\n");
814 # Write it all out ------------------------------------------------------------
816 Write("lib/client-stubs.h", \@h);
817 Write("lib/client-stubs.c", \@c);