2 .\" Copyright (C) 2004-2008 Richard Kettlewell
4 .\" This program is free software: you can redistribute it and/or modify
5 .\" it under the terms of the GNU General Public License as published by
6 .\" the Free Software Foundation, either version 3 of the License, or
7 .\" (at your option) any later version.
9 .\" This program is distributed in the hope that it will be useful,
10 .\" but WITHOUT ANY WARRANTY; without even the implied warranty of
11 .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 .\" GNU General Public License for more details.
14 .\" You should have received a copy of the GNU General Public License
15 .\" along with this program. If not, see <http://www.gnu.org/licenses/>.
17 .TH disorder_protocol 5
19 disorder_protocol \- DisOrder communication protocol
21 The DisOrder client and server communicate via the protocol described
24 The protocol is liable to change without notice.
25 You are recommended to check the implementation before believing this document.
27 Everything is encoded using UTF-8.
29 .B "CHARACTER ENCODING"
30 below for more detail on character encoding issues.
32 Commands and responses consist of a line perhaps followed (depending on the
33 command or response) by a body.
35 The line syntax is the same as described in \fBdisorder_config\fR(5) except
36 that comments are prohibited.
38 Bodies borrow their syntax from RFC821; they consist of zero or more ordinary
39 lines, with any initial full stop doubled up, and are terminated by a line
40 consisting of a full stop and a line feed.
42 Commands only have a body if explicitly stated below.
43 If they do have a body then the body should always be sent immediately;
44 unlike (for instance) the SMTP "DATA" command there is no intermediate step
45 where the server asks for the body to be sent.
47 Replies also only have a body if stated below.
48 The presence of a reply body can always be inferred from the response code;
49 if the last digit is a 3 then a body is present, otherwise it is not.
51 Commands always have a command name as the first field of the line; responses
52 always have a 3-digit response code as the first field.
53 See below for more details about this field.
55 All commands require the connection to have been already authenticated unless
57 If not stated otherwise, the \fBread\fR right is sufficient to execute
60 .B adduser \fIUSERNAME PASSWORD \fR[\fIRIGHTS\fR]
61 Create a new user with the given username and password.
62 The new user's rights list can be specified; if it is not
63 then the \fBdefault_rights\fR setting applies instead.
64 Requires the \fBadmin\fR right, and only works on local
68 Adopts a randomly picked track, leaving it in a similar state to if it was
69 picked by this user. Requires the \fBplay\fR right.
71 .B allfiles \fIDIRECTORY\fR [\fIREGEXP\fR]
72 List all the files and directories in \fIDIRECTORY\fR in a response body.
73 If \fIREGEXP\fR is present only matching files and directories are returned.
75 .B confirm \fICONFIRMATION
76 Confirm user registration.
77 \fICONFIRMATION\fR is as returned from \fBregister\fR below.
78 This command can be used without logging in.
81 Log a user back in using a cookie created with \fBmake\-cookie\fR.
82 The response contains the username.
84 .B deluser \fIUSERNAME
85 Delete the named user.
86 Requires the \fBadmin\fR right, and only works on local connections.
88 .B dirs \fIDIRECTORY\fR [\fIREGEXP\fR]
89 List all the directories in \fIDIRECTORY\fR in a response body.
90 If \fIREGEXP\fR is present only matching directories are returned.
92 .B disable \fR[\fBnow\fR]
93 Disable further playing.
94 If the optional \fBnow\fR argument is present then the current track
96 Requires the \fBglobal prefs\fR right.
98 .B edituser \fIUSERNAME PROPERTY VALUE
100 With the \fBadmin\fR right any username and property may be specified.
101 Otherwise the \fBuserinfo\fR right is required and only the
102 \fBemail\fR and \fBpassword\fR properties may be set.
104 User properties are syntax-checked before setting. For instance \fBemail\fR
105 must contain an "@" sign or you will get an error. (Setting an empty value for
106 \fBemail\fR is allowed and removes the property.)
109 Re-enable further playing, and is the opposite of \fBdisable\fR.
110 Requires the \fBglobal prefs\fR right.
113 Report whether playing is enabled.
114 The second field of the response line will be \fByes\fR or \fBno\fR.
116 .B exists \fITRACK\fR
117 Report whether the named track exists.
118 The second field of the response line will be \fByes\fR or \fBno\fR.
120 .B files \fIDIRECTORY\fR [\fIREGEXP\fR]
121 List all the files in \fIDIRECTORY\fR in a response body.
122 If \fIREGEXP\fR is present only matching files are returned.
124 .B get \fITRACK\fR \fIPREF\fR
125 Gets a preference value.
126 On success the second field of the response line will have the value.
128 If the track or preference do not exist then the response code is 555.
130 .B get\-global \fIKEY\fR
131 Get a global preference.
133 If the preference does not exist then the response code is 555.
135 .B length \fITRACK\fR
136 Get the length of the track in seconds.
137 On success the second field of the response line will have the value.
140 Send event log messages in a response body.
141 The command will never terminate.
142 Any further data sent to the server will be discarded (explicitly;
143 i.e. it will not accumulate in a buffer somewhere).
145 See \fBEVENT LOG\fR below for more details.
148 Returns an opaque string that can be used by the \fBcookie\fR command to log
149 this user back in on another connection (until the cookie expires).
151 .B move \fITRACK\fR \fIDELTA\fR
152 Move a track in the queue.
153 The track may be identified by ID (preferred) or name (which might cause
154 confusion if it's there twice).
155 \fIDELTA\fR should be an negative or positive integer and indicates how
156 many steps towards the head of the queue the track should be moved.
158 Requires one of the \fBmove mine\fR, \fBmove random\fR or \fBmove any\fR rights
159 depending on how the track came to be added to the queue.
161 .B moveafter \fITARGET\fR \fIID\fR ...
162 Move all the tracks in the \fIID\fR list after ID \fITARGET\fR.
163 If \fITARGET\fR is the empty string then the listed tracks are put
164 at the head of the queue.
165 If \fITARGET\fR is listed in the ID list then the tracks are moved
166 to just after the first non-listed track before it, or to the head if there is
169 Requires one of the \fBmove mine\fR, \fBmove random\fR or \fBmove any\fR rights
170 depending on how the tracks came to be added to the queue.
172 .B new \fR[\fIMAX\fR]
173 Send the most recently added \fIMAX\fR tracks in a response body.
174 If the argument is omitted, the \fBnew_max\fR most recent tracks are
175 listed (see \fBdisorder_config\fR(5)).
181 as a keepalive measure.
182 This command does not require authentication.
184 .B part \fITRACK\fR \fICONTEXT\fI \fIPART\fR
185 Get a track name part.
186 Returns an empty string if a name part cannot be constructed.
202 Pause the current track.
203 Requires the \fBpause\fR right.
206 Add a track to the queue.
207 The response contains the queue ID of the track.
208 Requires the \fBplay\fR right.
210 .B playafter \fITARGET\fR \fITRACK\fR ...
211 Add all the tracks in the \fITRACK\fR list to the queue after \fITARGET\fR
212 (which should be a track ID).
213 If \fITARGET\fR is the empty string then the listed tracks are put
214 at the head of the queue.
216 Currently the success result does \fInot\fR include the new track IDs.
218 Requires the \fBplay\fR right.
221 Report what track is playing.
223 If the response is \fB252\fR then the rest of the response line consists of
224 track information (see below).
226 If the response is \fB259\fR then nothing is playing.
228 .B playlist-delete \fIPLAYLIST\fR
230 Requires permission to modify that playlist and the \fBplay\fR right.
232 .B playlist-get \fIPLAYLIST\fR
233 Get the contents of a playlist, in a response body.
234 Requires permission to read that playlist and the \fBread\fR right.
235 If the playlist does not exist the response is 555.
237 .B playlist-get-share \fIPLAYLIST\fR
238 Get the sharing status of a playlist.
239 The result will be \fBpublic\fR, \fBprivate\fR or \fBshared\fR.
240 Requires permission to read that playlist and the \fBread\fR right.
242 .B playlist-lock \fIPLAYLIST\fR
244 Requires permission to modify that playlist and the \fBplay\fR right.
245 Only one playlist may be locked at a time on a given connection and the lock
246 automatically expires when the connection is closed.
248 .B playlist-set \fIPLAYLIST\fR
249 Set the contents of a playlist.
250 The new contents should be supplied in a command body.
251 Requires permission to modify that playlist and the \fBplay\fR right.
252 The playlist must be locked.
254 .B playlist-set-share \fIPLAYLIST\fR \fISHARE\fR
255 Set the sharing status of a playlist to
256 \fBpublic\fR, \fBprivate\fR or \fBshared\fR.
257 Requires permission to modify that playlist and the \fBplay\fR right.
259 .B playlist-unlock\fR
260 Unlock the locked playlist.
263 List all playlists that this connection has permission to read.
264 Requires the \fBread\fR right.
267 Send back the preferences for \fITRACK\fR in a response body.
268 Each line of the response has the usual line syntax, the first field being the
269 name of the pref and the second the value.
272 Send back the current queue in a response body, one track to a line, the track
273 at the head of the queue (i.e. next to be be played) first.
274 See below for the track information syntax.
277 Disable random play (but don't stop the current track).
278 Requires the \fBglobal prefs\fR right.
282 Requires the \fBglobal prefs\fR right.
285 Report whether random play is enabled.
286 The second field of the response line will be \fByes\fR or \fBno\fR.
289 Send back the current recently-played list in a response body, one track to a
290 line, the track most recently played last.
291 See below for the track information syntax.
294 Request that DisOrder reconfigure itself.
295 Requires the \fBadmin\fR right.
297 Not all configuration options can be modified during the lifetime of the
298 server; of those that can't, some will just be ignored if they change while
299 others will cause the new configuration to be rejected.
300 See \fBdisorder_config\fR(5) for details.
302 .B register \fIUSERNAME PASSWORD EMAIL
304 Requires the \fBregister\fR right.
305 The result contains a confirmation string; the user will be be able
306 to log in until this has been presented back to the server via the
307 \fBconfirm\fR command.
309 .B reminder \fIUSERNAME\fR
310 Send a password reminder to user \fIUSERNAME\fR.
311 If the user has no valid email address, or no password, or a
312 reminder has been sent too recently, then no reminder will be sent.
315 Remove the track identified by \fIID\fR.
316 Requires one of the \fBremove mine\fR, \fBremove random\fR or
317 \fBremove any\fR rights depending on how the
318 track came to be added to the queue.
320 .B rescan \fR[\fBwait\fR] \fR[\fBfresh\fR]
321 Rescan all roots for new or obsolete tracks.
322 Requires the \fBrescan\fR right.
324 If the \fBwait\fR flag is present then the response is delayed until the rescan
326 Otherwise the response arrives immediately.
327 This is primarily intended for testing.
329 If the \fBfresh\fR flag is present a rescan is already underway then a second
330 rescan will be started when it completes.
331 The default behavior is to piggyback on the existing rescan.
333 NB that \fBfresh\fR is currently disabled in the server source, so using this
334 flag will just provoke an error.
336 .B resolve \fITRACK\fR
337 Resolve a track name, i.e. if this is an alias then return the real track name.
340 Resume the current track after a \fBpause\fR command.
341 Requires the \fBpause\fR right.
343 .B revoke \fBcookie\fR
344 Revoke a cookie previously created with \fBmake\-cookie\fR.
345 It will not be possible to use this cookie in the future.
348 Report the RTP broadcast (or multicast) address, in the form \fIADDRESS
350 This command does not require authentication.
352 .B scratch \fR[\fIID\fR]
353 Remove the track identified by \fIID\fR, or the currently playing track if no
354 \fIID\fR is specified.
355 Requires one of the \fBscratch mine\fR, \fBscratch random\fR or
356 \fBscratch any\fR rights depending on how the track came to be
359 .B schedule-add \fIWHEN\fR \fIPRIORITY\fR \fIACTION\fR ...
360 Schedule an event for the future.
363 is the time when it should happen, as \fBtime_t\fR value.
364 It must refer to a time in the future.
367 is the event priority.
368 This can be \fBnormal\fR, in which case the event will be run at startup if its
369 time has past, or \fBjunk\fR in which case it will be discarded if it is found
370 to be in the past at startup.
371 The meaning of other values is not defined.
374 is the action to perform.
375 The choice of action determines the meaning of the remaining arguments.
376 Possible actions are:
381 The next argument is the track name.
382 Requires the \fBplay\fR right.
385 Set a global preference.
386 The next argument is the preference name and the final argument is the value to
387 set it to (omit it to unset it).
388 Requires the \fBglobal prefs\fR right.
391 You need the right at the point you create the event.
392 It is not possible to create scheduled events in expectation of a future change
395 .B schedule-del \fIEVENT\fR
396 Deletes a scheduled event.
397 Users can always delete their own scheduled events; with the \fBadmin\fR
398 right you can delete any event.
400 .B schedule-get \fIEVENT\fR
401 Sends the details of scheduled event \fIEVENT\fR in a response body.
402 Each line is a pair of strings quoted in the usual way, the first being the key
403 ane the second the value.
404 No particular order is used.
406 Scheduled events are considered public information.
407 Right \fBread\fR is sufficient to see details of all events.
410 Sends the event IDs of all scheduled events in a response body, in no
412 Use \fBschedule-get\fR to get the details of each event.
414 .B search \fITERMS\fR
415 Search for tracks matching the search terms.
416 The results are put in a response body, one to a line.
418 The search string is split in the usual way, with quoting supported, into a
420 Only tracks matching all terms are included in the results.
422 Any terms of the form \fBtag:\fITAG\fR limits the search to tracks with that
425 All other terms are interpreted as individual words which must be present in
428 Spaces in terms don't currently make sense, but may one day be interpreted to
429 allow searching for phrases.
431 .B \fBset\fR \fITRACK\fR \fIPREF\fR \fIVALUE\fR
433 Requires the \fBprefs\fR right.
435 .B set\-global \fIKEY\fR \fIVALUE\fR
436 Set a global preference.
437 Requires the \fBglobal prefs\fR right.
440 Send server statistics in plain text in a response body.
443 Send the list of currently known tags in a response body.
445 .B \fBunset\fR \fITRACK\fR \fIPREF\fR
447 Requires the \fBprefs\fR right.
449 .B \fBunset\-global\fR \fIKEY\fR
450 Unset a global preference.
451 Requires the \fBglobal prefs\fR right.
453 .B user \fIUSERNAME\fR \fIRESPONSE\fR
454 Authenticate as user \fIUSERNAME\fR.
459 .B userinfo \fIUSERNAME PROPERTY
463 Send the list of currently known users in a response body.
466 Send back a response with the server version as the second field.
468 .B volume \fR[\fILEFT\fR [\fIRIGHT\fR]]
469 Get or set the volume.
471 With zero parameters just gets the volume and reports the left and right sides
472 as the 2nd and 3rd fields of the response.
474 With one parameter sets both sides to the same value.
475 With two parameters sets each side independently.
476 Setting the volume requires the \fBvolume\fR right.
478 Responses are three-digit codes.
479 The first digit distinguishes errors from successful responses:
487 The second digit breaks down the origin of the response:
490 Generic responses not specific to the handling of the command.
491 Mostly this is parse errors.
494 51x errors indicate that the user had insufficient rights for the command.
497 Authentication responses.
500 Responses specific to the handling of the command.
502 The third digit provides extra information about the response:
505 Text part is just commentary.
508 Text part is a constant result e.g. \fBversion\fR.
511 Text part is a potentially variable result.
514 Text part is just commentary; a dot-stuffed body follows.
517 Text part is just commentary; an indefinite dot-stuffed body follows.
518 (Used for \fBlog\fR.)
521 Used with "normal" errors, for instance a preference not being found.
522 The text part is commentary.
525 The text part is just commentary (but would normally be a response for this
526 command) e.g. \fBplaying\fR.
528 Result strings (not bodies) intended for machine parsing (i.e. xx1 and xx2
529 responses) are quoted.
531 When a connection is made the server sends a \fB231\fR response before any
533 This contains a protocol generation, an algorithm name and a
534 challenge encoded in hex, all separated by whitespace.
536 The current protocol generation is \fB2\fR.
538 The possible algorithms are (currently) \fBsha1\fR, \fBsha256\fR, \fBsha384\fR
540 \fBSHA1\fR etc work as synonyms.
542 The \fBuser\fR response consists of the selected hash of the user's password
543 concatenated with the challenge, encoded in hex.
544 .SH "TRACK INFORMATION"
545 Track information is encoded in a line (i.e. using the usual line syntax) as
547 The first is a name, the second a value.
548 The names have the following meanings:
551 The time the track is expected to be played at.
554 A string uniquely identifying this queue entry.
557 The time the track was played at.
560 The user that scratched the track.
563 The origin of the track. Valid origins are:
567 The track was originally randomly picked but has been adopted by a user.
570 The track was picked by a user.
573 The track was randomly picked.
576 The track was played from a scheduled action.
579 The track is a scratch sound.
583 The current track state.
588 The player failed (exited with nonzero status but wasn't scratched).
591 The track was played without any problems.
594 The track was scratched.
597 The track is currently playing.
600 Track is playing but paused.
603 In the queue, hasn't been played yet.
606 The track was terminated because the server is shutting down.
610 The user that submitted the track.
613 The filename of the track.
616 The time the track was added to the queue.
619 The wait status of the player in decimal.
621 Note that \fBorigin\fR is new with DisOrder 4.3, and obsoletes some old
624 Times are decimal integers using the server's \fBtime_t\fR.
626 For file listings, the regexp applies to the basename of the returned file, not
627 the whole filename, and letter case is ignored.
628 \fBpcrepattern\fR(3) describes the regexp syntax.
630 Filenames are in UTF-8 even if the collection they come from uses some other
631 encoding - if you want to access the real file (in such cases as the filenames
632 actually correspond to a real file) you'll have to convert to whatever the
635 The event log consists of lines starting with a hexadecimal timestamp and a
636 keyword followed by (optionally) parameters.
637 The parameters are quoted in the usual DisOrder way.
638 Currently the following keywords are used:
640 .B adopted \fIID\fR \fIUSERNAME\fR
641 \fIUSERNAME\fR adopted track \fIID\fR.
643 .B completed \fITRACK\fR
644 Completed playing \fITRACK\fR
646 .B failed \fITRACK\fR \fIERROR\fR
647 Completed playing \fITRACK\fR with an error status
649 .B global_pref \fIPREF\fR [\fIVALUE\fR]
650 A global preference was set or unset.
652 .B moved \fIUSERNAME\fR
653 User \fIUSERNAME\fR moved some track(s).
654 Further details aren't included any more.
656 .B playing \fITRACK\fR [\fIUSERNAME\fR]
657 Started playing \fITRACK\fR.
659 .B playlist_created \fIPLAYLIST\fR \fISHARING\fR
660 Sent when a playlist is created.
661 For private playlists this is intended to be sent only to the owner (but
662 this is not currently implemented).
664 .B playlist_deleted \fIPLAYLIST\fR
665 Sent when a playlist is deleted.
666 For private playlists this is intended to be sent only to the owner (but
667 this is not currently implemented).
669 .B playlist_modified \fIPLAYLIST\fR \fISHARING\fR
670 Sent when a playlist is modified (either its contents or its sharing status).
671 For private playlists this is intended to be sent only to the owner (but
672 this is not currently implemented).
674 .B queue \fIQUEUE-ENTRY\fR...
675 Added \fITRACK\fR to the queue.
677 .B recent_added \fIQUEUE-ENTRY\fR...
678 Added \fIID\fR to the recently played list.
680 .B recent_removed \fIID\fR
681 Removed \fIID\fR from the recently played list.
683 .B removed \fIID\fR [\fIUSERNAME\fR]
684 Queue entry \fIID\fR was removed.
685 This is used both for explicit removal (when \fIUSERNAME\fR is present)
686 and when playing a track (when it is absent).
691 .B scratched \fITRACK\fR \fIUSERNAME\fR
692 \fITRACK\fR was scratched by \fIUSERNAME\fR.
694 .B state \fIKEYWORD\fR
695 Some state change occurred.
696 The current set of keywords is:
700 The current track completed successfully.
703 Playing was disabled.
706 Random play was disabled.
712 Random play was enabled.
715 The current track failed.
718 The current track was paused.
721 A track started playing.
724 The current track was resumed.
726 .B rights_changed \fIRIGHTS\fR
727 User's rights were changed.
730 The current track was scratched.
732 To simplify client implementation, \fBstate\fR commands reflecting the current
733 state are sent at the start of the log.
736 .B user_add \fIUSERNAME\fR
739 .B user_delete \fIUSERNAME\fR
742 .B user_edit \fIUSERNAME\fR \fIPROPERTY\fR
743 Some property of a user was edited.
745 .B user_confirm \fIUSERNAME\fR
746 A user's login was confirmed (via the web interface).
748 .B volume \fILEFT\fR \fIRIGHT\fR
753 .B "TRACK INFORMATION"
756 The \fBuser-*\fR messages are only sent to admin users, and are not sent over
757 non-local connections unless \fBremote_userman\fR is enabled.
758 .SH "CHARACTER ENCODING"
759 All data sent by both server and client is encoded using UTF-8.
760 Moreover it must be valid UTF-8, i.e. non-minimal sequences are not
761 permitted, nor are surrogates, nor are code points outside the
764 There are no particular normalization requirements on either side of the
766 The server currently converts internally to NFC, the client must
767 normalize the responses returned if it needs some normalized form for further
770 The various characters which divide up lines may not be followed by combining
772 For instance all of the following are prohibited:
775 LINE FEED followed by a combining character.
776 For example the sequence LINE FEED, COMBINING GRAVE ACCENT is never permitted.
779 APOSTROPHE or QUOTATION MARK followed by a combining character when used to
781 For instance a line starting APOSTROPHE, COMBINING CEDILLA is prohibited.
783 Note that such sequences are not prohibited when the quote character cannot be
784 interpreted as a field delimiter.
785 For instance APOSTROPHE, REVERSE SOLIDUS, APOSTROPHE, COMBINING CEDILLA,
786 APOSTROPHE would be permitted.
789 REVERSE SOLIDUS (BACKSLASH) followed by a combining character in a quoted
790 string when it is the first character of an escape sequence.
791 For instance a line starting APOSTROPHE, REVERSE SOLIDUS, COMBINING TILDE
794 As above such sequences are not prohibited when the character is not being used
795 to start an escape sequence.
796 For instance APOSTROPHE, REVERSE SOLIDUS, REVERSE SOLIDS, COMBINING TILDE,
797 APOSTROPHE is permitted.
800 Any of the field-splitting whitespace characters followed by a combining
801 character when not part of a quoted field.
802 For instance a line starting COLON, SPACE, COMBINING CANDRABINDU is prohibited.
804 As above non-delimiter uses are fine.
807 The FULL STOP characters used to quote or delimit a body.
809 Furthermore none of these characters are permitted to appear in the context of
810 a canonical decomposition (i.e. they must still be present when converted to
812 In practice however this is not an issue in Unicode 5.0.
814 These rules are consistent with the observation that the split() function is
815 essentially a naive ASCII parser.
816 The implication is not that these sequences never actually appear in
817 the protocol, merely that the server is not required to honor them in
818 any useful way nor be consistent between versions: in current
819 versions the result will be lines and fields that start with combining
820 characters and are not necessarily split where you expect, but future versions
821 may remove them, reject them or ignore some or all of the delimiters that have
822 following combining characters, and no notice will be given of any change.
828 \fBdisorder_config\fR(5),