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 always have a command name as the first field of the line; responses
43 always have a 3-digit response code as the first field.
44 See below for more details about this field.
46 All commands require the connection to have been already authenticated unless
48 If not stated otherwise, the \fBread\fR right is sufficient to execute
51 Neither commands nor responses have a body unless stated otherwise.
53 .B adduser \fIUSERNAME PASSWORD \fR[\fIRIGHTS\fR]
54 Create a new user with the given username and password.
55 The new user's rights list can be specified; if it is not
56 then the \fBdefault_rights\fR setting applies instead.
57 Requires the \fBadmin\fR right, and only works on local
61 Adopts a randomly picked track, leaving it in a similar state to if it was
62 picked by this user. Requires the \fBplay\fR right.
64 .B allfiles \fIDIRECTORY\fR [\fIREGEXP\fR]
65 List all the files and directories in \fIDIRECTORY\fR in a response body.
66 If \fIREGEXP\fR is present only matching files and directories are returned.
68 .B confirm \fICONFIRMATION
69 Confirm user registration.
70 \fICONFIRMATION\fR is as returned from \fBregister\fR below.
71 This command can be used without logging in.
74 Log a user back in using a cookie created with \fBmake\-cookie\fR.
75 The response contains the username.
77 .B deluser \fIUSERNAME
78 Delete the named user.
79 Requires the \fBadmin\fR right, and only works on local connections.
81 .B dirs \fIDIRECTORY\fR [\fIREGEXP\fR]
82 List all the directories in \fIDIRECTORY\fR in a response body.
83 If \fIREGEXP\fR is present only matching directories are returned.
85 .B disable \fR[\fBnow\fR]
86 Disable further playing.
87 If the optional \fBnow\fR argument is present then the current track
89 Requires the \fBglobal prefs\fR right.
91 .B edituser \fIUSERNAME PROPERTY VALUE
93 With the \fBadmin\fR right any username and property may be specified.
94 Otherwise the \fBuserinfo\fR right is required and only the
95 \fBemail\fR and \fBpassword\fR properties may be set.
97 User properties are syntax-checked before setting. For instance \fBemail\fR
98 must contain an "@" sign or you will get an error. (Setting an empty value for
99 \fBemail\fR is allowed and removes the property.)
102 Re-enable further playing, and is the opposite of \fBdisable\fR.
103 Requires the \fBglobal prefs\fR right.
106 Report whether playing is enabled.
107 The second field of the response line will be \fByes\fR or \fBno\fR.
109 .B exists \fITRACK\fR
110 Report whether the named track exists.
111 The second field of the response line will be \fByes\fR or \fBno\fR.
113 .B files \fIDIRECTORY\fR [\fIREGEXP\fR]
114 List all the files in \fIDIRECTORY\fR in a response body.
115 If \fIREGEXP\fR is present only matching files are returned.
117 .B get \fITRACK\fR \fIPREF\fR
118 Getsa preference value.
119 On success the second field of the response line will have the value.
121 If the track or preference do not exist then the response code is 555.
123 .B get\-global \fIKEY\fR
124 Get a global preference.
126 If the preference does not exist then the response code is 555.
128 .B length \fITRACK\fR
129 Get the length of the track in seconds.
130 On success the second field of the response line will have the value.
133 Send event log messages in a response body.
134 The command will never terminate.
135 Any further data sent to the server will be discarded (explicitly;
136 i.e. it will not accumulate in a buffer somewhere).
138 See \fBEVENT LOG\fR below for more details.
141 Returns an opaque string that can be used by the \fBcookie\fR command to log
142 this user back in on another connection (until the cookie expires).
144 .B move \fITRACK\fR \fIDELTA\fR
145 Move a track in the queue.
146 The track may be identified by ID (preferred) or name (which might cause
147 confusion if it's there twice).
148 \fIDELTA\fR should be an negative or positive integer and indicates how
149 many steps towards the head of the queue the track should be moved.
151 Requires one of the \fBmove mine\fR, \fBmove random\fR or \fBmove any\fR rights
152 depending on how the track came to be added to the queue.
154 .B moveafter \fITARGET\fR \fIID\fR ...
155 Move all the tracks in the \fIID\fR list after ID \fITARGET\fR.
156 If \fITARGET\fR is the empty string then the listed tracks are put
157 at the head of the queue.
158 If \fITARGET\fR is listed in the ID list then the tracks are moved
159 to just after the first non-listed track before it, or to the head if there is
162 Requires one of the \fBmove mine\fR, \fBmove random\fR or \fBmove any\fR rights
163 depending on how the tracks came to be added to the queue.
165 .B new \fR[\fIMAX\fR]
166 Send the most recently added \fIMAX\fR tracks in a response body.
167 If the argument is ommitted, the \fBnew_max\fR most recent tracks are
168 listed (see \fBdisorder_config\fR(5)).
174 as a keepalive measure.
175 This command does not require authentication.
177 .B part \fITRACK\fR \fICONTEXT\fI \fIPART\fR
178 Get a track name part.
179 Returns an empty string if a name part cannot be constructed.
195 Pause the current track.
196 Requires the \fBpause\fR right.
199 Add a track to the queue.
200 The response contains the queue ID of the track.
201 Requires the \fBplay\fR right.
204 Report what track is playing.
206 If the response is \fB252\fR then the rest of the response line consists of
207 track information (see below).
209 If the response is \fB259\fR then nothing is playing.
212 Send back the preferences for \fITRACK\fR in a response body.
213 Each line of the response has the usual line syntax, the first field being the
214 name of the pref and the second the value.
217 Send back the current queue in a response body, one track to a line, the track
218 at the head of the queue (i.e. next to be be played) first.
219 See below for the track information syntax.
222 Disable random play (but don't stop the current track).
223 Requires the \fBglobal prefs\fR right.
227 Requires the \fBglobal prefs\fR right.
230 Report whether random play is enabled.
231 The second field of the response line will be \fByes\fR or \fBno\fR.
234 Send back the current recently-played list in a response body, one track to a
235 line, the track most recently played last.
236 See below for the track information syntax.
239 Request that DisOrder reconfigure itself.
240 Requires the \fBadmin\fR right.
242 .B register \fIUSERNAME PASSWORD EMAIL
244 Requires the \fBregister\fR right.
245 The result contains a confirmation string; the user will be be able
246 to log in until this has been presented back to the server via the
247 \fBconfirm\fR command.
249 .B reminder \fIUSERNAME\fR
250 Send a password reminder to user \fIUSERNAME\fR.
251 If the user has no valid email address, or no password, or a
252 reminder has been sent too recently, then no reminder will be sent.
255 Remove the track identified by \fIID\fR.
256 Requires one of the \fBremove mine\fR, \fBremove random\fR or
257 \fBremove any\fR rights depending on how the
258 track came to be added to the queue.
260 .B rescan \fR[\fBwait\fR] \fR[\fBfresh\fR]
261 Rescan all roots for new or obsolete tracks.
262 Requires the \fBrescan\fR right.
264 If the \fBwait\fR flag is present then the response is delayed until the rescan
266 Otherwise the response arrives immediately.
267 This is primarily intended for testing.
269 If the \fBfresh\fR flag is present a rescan is already underway then a second
270 rescan will be started when it completes.
271 The default behavior is to piggyback on the existing rescan.
273 NB that \fBfresh\fR is currently disabled in the server source, so using this
274 flag will just provoke an error.
276 .B resolve \fITRACK\fR
277 Resolve a track name, i.e. if this is an alias then return the real track name.
280 Resume the current track after a \fBpause\fR command.
281 Requires the \fBpause\fR right.
283 .B revoke \fBcookie\fR
284 Revoke a cookie previously created with \fBmake\-cookie\fR.
285 It will not be possible to use this cookie in the future.
288 Report the RTP broadcast (or multicast) address, in the form \fIADDRESS
290 This command does not require authentication.
292 .B scratch \fR[\fIID\fR]
293 Remove the track identified by \fIID\fR, or the currently playing track if no
294 \fIID\fR is specified.
295 Requires one of the \fBscratch mine\fR, \fBscratch random\fR or
296 \fBscratch any\fR rights depending on how the track came to be
299 .B schedule-add \fIWHEN\fR \fIPRIORITY\fR \fIACTION\fR ...
300 Schedule an event for the future.
303 is the time when it should happen, as \fBtime_t\fR value.
304 It must refer to a time in the future.
307 is the event priority.
308 This can be \fBnormal\fR, in which case the event will be run at startup if its
309 time has past, or \fBjunk\fR in which case it will be discarded if it is found
310 to be in the past at startup.
311 The meaning of other values is not defined.
314 is the action to perform.
315 The choice of action determines the meaning of the remaining arguments.
316 Possible actions are:
321 The next argument is the track name.
322 Requires the \fBplay\fR right.
325 Set a global preference.
326 The next argument is the preference name and the final argument is the value to
327 set it to (omit it to unset it).
328 Requires the \fBglobal prefs\fR right.
331 You need the right at the point you create the event.
332 It is not possible to create scheduled events in expectation of a future change
335 .B schedule-del \fIEVENT\fR
336 Deletes a scheduled event.
337 Users can always delete their own scheduled events; with the \fBadmin\fR
338 right you can delete any event.
340 .B schedule-get \fIEVENT\fR
341 Sends the details of scheduled event \fIEVENT\fR in a response body.
342 Each line is a pair of strings quoted in the usual way, the first being the key
343 ane the second the value.
344 No particular order is used.
346 Scheduled events are considered public information.
347 Right \fBread\fR is sufficient to see details of all events.
350 Sends the event IDs of all scheduled events in a response body, in no
352 Use \fBschedule-get\fR to get the details of each event.
354 .B search \fITERMS\fR
355 Search for tracks matching the search terms.
356 The results are put in a response body, one to a line.
358 The search string is split in the usual way, with quoting supported, into a
360 Only tracks matching all terms are included in the results.
362 Any terms of the form \fBtag:\fITAG\fR limits the search to tracks with that
365 All other terms are interpreted as individual words which must be present in
368 Spaces in terms don't currently make sense, but may one day be interpreted to
369 allow searching for phrases.
371 .B \fBset\fR \fITRACK\fR \fIPREF\fR \fIVALUE\fR
373 Requires the \fBprefs\fR right.
375 .B set\-global \fIKEY\fR \fIVALUE\fR
376 Set a global preference.
377 Requires the \fBglobal prefs\fR right.
380 Send server statistics in plain text in a response body.
383 Send the list of currently known tags in a response body.
385 .B \fBunset\fR \fITRACK\fR \fIPREF\fR
387 Requires the \fBprefs\fR right.
389 .B \fBunset\-global\fR \fIKEY\fR
390 Unset a global preference.
391 Requires the \fBglobal prefs\fR right.
393 .B user \fIUSERNAME\fR \fIRESPONSE\fR
394 Authenticate as user \fIUSERNAME\fR.
399 .B userinfo \fIUSERNAME PROPERTY
403 Send the list of currently known users in a response body.
406 Send back a response with the server version as the second field.
408 .B volume \fR[\fILEFT\fR [\fIRIGHT\fR]]
409 Get or set the volume.
411 With zero parameters just gets the volume and reports the left and right sides
412 as the 2nd and 3rd fields of the response.
414 With one parameter sets both sides to the same value.
415 With two parameters sets each side independently.
416 Setting the volume requires the \fBvolume\fR right.
418 Responses are three-digit codes.
419 The first digit distinguishes errors from succesful responses:
427 The second digit breaks down the origin of the response:
430 Generic responses not specific to the handling of the command.
431 Mostly this is parse errors.
434 51x errors indicate that the user had insufficient rights for the command.
437 Authentication responses.
440 Responses specific to the handling of the command.
442 The third digit provides extra information about the response:
445 Text part is just commentary.
448 Text part is a constant result e.g. \fBversion\fR.
451 Text part is a potentially variable result.
454 Text part is just commentary; a dot-stuffed body follows.
457 Text part is just commentary; an indefinite dot-stuffed body follows.
458 (Used for \fBlog\fR.)
461 Used with "normal" errors, for instance a preference not being found.
462 The text part is commentary.
465 The text part is just commentary (but would normally be a response for this
466 command) e.g. \fBplaying\fR.
468 Result strings (not bodies) intended for machine parsing (i.e. xx1 and xx2
469 responses) are quoted.
471 When a connection is made the server sends a \fB231\fR response before any
473 This contains a protocol generation, an algorithm name and a
474 challenge encoded in hex, all separated by whitespace.
476 The current protocol generation is \fB2\fR.
478 The possible algorithms are (currently) \fBsha1\fR, \fBsha256\fR, \fBsha384\fR
480 \fBSHA1\fR etc work as synonyms.
482 The \fBuser\fR response consists of the selected hash of the user's password
483 concatenated with the challenge, encoded in hex.
484 .SH "TRACK INFORMATION"
485 Track information is encoded in a line (i.e. using the usual line syntax) as
487 The first is a name, the second a value.
488 The names have the following meanings:
491 The time the track is expected to be played at.
494 A string uniquely identifying this queue entry.
497 The time the track was played at.
500 The user that scratched the track.
503 The origin of the track. Valid origins are:
507 The track was originally randomly picked but has been adopted by a user.
510 The track was picked by a user.
513 The track was randomly picked.
516 The track was played from a scheduled action.
519 The track is a scratch sound.
523 The current track state.
528 The player failed (exited with nonzero status but wasn't scratched).
531 The track was played without any problems.
534 The track was scratched.
537 The track is currently playing.
540 Track is playing but paused.
543 In the queue, hasn't been played yet.
546 The track was terminated because the server is shutting down.
550 The user that submitted the track.
553 The filename of the track.
556 The time the track was added to the queue.
559 The wait status of the player in decimal.
561 Note that \fBorigin\fR is new with DisOrder 4.3, and obsoletes some old
564 Times are decimal integers using the server's \fBtime_t\fR.
566 For file listings, the regexp applies to the basename of the returned file, not
567 the whole filename, and letter case is ignored.
568 \fBpcrepattern\fR(3) describes the regexp syntax.
570 Filenames are in UTF-8 even if the collection they come from uses some other
571 encoding - if you want to access the real file (in such cases as the filenames
572 actually correspond to a real file) you'll have to convert to whatever the
575 The event log consists of lines starting with a hexadecimal timestamp and a
576 keyword followed by (optionally) parameters.
577 The parameters are quoted in the usual DisOrder way.
578 Currently the following keywords are used:
580 .B adopted \fIID\fR \fIUSERNAME\fR
581 \fIUSERNAME\fR adopted track \fIID\fR.
583 .B completed \fITRACK\fR
584 Completed playing \fITRACK\fR
586 .B failed \fITRACK\fR \fIERROR\fR
587 Completed playing \fITRACK\fR with an error status
589 .B moved \fIUSERNAME\fR
590 User \fIUSERNAME\fR moved some track(s).
591 Further details aren't included any more.
593 .B playing \fITRACK\fR [\fIUSERNAME\fR]
594 Started playing \fITRACK\fR.
596 .B queue \fIQUEUE-ENTRY\fR...
597 Added \fITRACK\fR to the queue.
599 .B recent_added \fIQUEUE-ENTRY\fR...
600 Added \fIID\fR to the recently played list.
602 .B recent_removed \fIID\fR
603 Removed \fIID\fR from the recently played list.
605 .B removed \fIID\fR [\fIUSERNAME\fR]
606 Queue entry \fIID\fR was removed.
607 This is used both for explicit removal (when \fIUSERNAME\fR is present)
608 and when playing a track (when it is absent).
613 .B scratched \fITRACK\fR \fIUSERNAME\fR
614 \fITRACK\fR was scratched by \fIUSERNAME\fR.
616 .B state \fIKEYWORD\fR
617 Some state change occurred.
618 The current set of keywords is:
622 The current track completed successfully.
625 Playing was disabled.
628 Random play was disabled.
634 Random play was enabled.
637 The current track failed.
640 The current track was paused.
643 A track started playing.
646 The current track was resumed.
648 .B rights_changed \fIRIGHTS\fR
649 User's rights were changed.
652 The current track was scratched.
654 To simplify client implementation, \fBstate\fR commands reflecting the current
655 state are sent at the start of the log.
658 .B user_add \fIUSERNAME\fR
661 .B user_delete \fIUSERNAME\fR
664 .B user_edit \fIUSERNAME\fR \fIPROPERTY\fR
665 Some property of a user was edited.
667 .B user_confirm \fIUSERNAME\fR
668 A user's login was confirmed (via the web interface).
670 .B volume \fILEFT\fR \fIRIGHT\fR
675 .B "TRACK INFORMATION"
678 The \fBuser-*\fR messages are only sent to admin users, and are not sent over
679 non-local connections unless \fBremote_userman\fR is enabled.
680 .SH "CHARACTER ENCODING"
681 All data sent by both server and client is encoded using UTF-8.
682 Moreover it must be valid UTF-8, i.e. non-minimal sequences are not
683 permitted, nor are surrogates, nor are code points outside the
686 There are no particular normalization requirements on either side of the
688 The server currently converts internally to NFC, the client must
689 normalize the responses returned if it needs some normalized form for further
692 The various characters which divide up lines may not be followed by combining
694 For instance all of the following are prohibited:
697 LINE FEED followed by a combining character.
698 For example the sequence LINE FEED, COMBINING GRAVE ACCENT is never permitted.
701 APOSTROPHE or QUOTATION MARK followed by a combining character when used to
703 For instance a line starting APOSTROPHE, COMBINING CEDILLA is prohibited.
705 Note that such sequences are not prohibited when the quote character cannot be
706 interpreted as a field delimiter.
707 For instance APOSTROPHE, REVERSE SOLIDUS, APOSTROPHE, COMBINING CEDILLA,
708 APOSTROPHE would be permitted.
711 REVERSE SOLIDUS (BACKSLASH) followed by a combining character in a quoted
712 string when it is the first character of an escape sequence.
713 For instance a line starting APOSTROPHE, REVERSE SOLIDUS, COMBINING TILDE
716 As above such sequences are not prohibited when the character is not being used
717 to start an escape sequence.
718 For instance APOSTROPHE, REVERSE SOLIDUS, REVERSE SOLIDS, COMBINING TILDE,
719 APOSTROPHE is permitted.
722 Any of the field-splitting whitespace characters followed by a combining
723 character when not part of a quoted field.
724 For instance a line starting COLON, SPACE, COMBINING CANDRABINDU is prohibited.
726 As above non-delimiter uses are fine.
729 The FULL STOP characters used to quote or delimit a body.
731 Furthermore none of these characters are permitted to appear in the context of
732 a canonical decomposition (i.e. they must still be present when converted to
734 In practice however this is not an issue in Unicode 5.0.
736 These rules are consistent with the observation that the split() function is
737 essentially a naive ASCII parser.
738 The implication is not that these sequences never actually appear in
739 the protocol, merely that the server is not required to honor them in
740 any useful way nor be consistent between versions: in current
741 versions the result will be lines and fields that start with combining
742 characters and are not necessarily split where you expect, but future versions
743 may remove them, reject them or ignore some or all of the delimiters that have
744 following combining characters, and no notice will be given of any change.
750 \fBdisorder_config\fR(5),
~mdw / disorder / blob