2 .\" Copyright (C) 2004, 2005, 2006 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 2 of the License, or
7 .\" (at your option) any later version.
9 .\" This program is distributed in the hope that it will be useful, but
10 .\" WITHOUT ANY WARRANTY; without even the implied warranty of
11 .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 .\" 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, write to the Free Software
16 .\" Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
19 .TH disorder_protocol 5
21 disorder_protocol \- DisOrder communication protocol
23 The DisOrder client and server communicate via the protocol described
26 The protocol is liable to change without notice. You are recommended to check
27 the implementation before believing this document.
29 Everything is encoded using UTF-8. See
30 .B "CHARACTER ENCODING"
31 below for more detail on character encoding issues.
33 Commands and responses consist of a line perhaps followed (depending on the
34 command or response) by a body.
36 The line syntax is the same as described in \fBdisorder_config\fR(5) except
37 that comments are prohibited.
39 Bodies borrow their syntax from RFC821; they consist of zero or more ordinary
40 lines, with any initial full stop doubled up, and are terminated by a line
41 consisting of a full stop and a line feed.
43 Commands always have a command name as the first field of the line; responses
44 always have a 3-digit response code as the first field. See below for more
45 details about this field.
47 All commands require the connection to have been already authenticated unless
50 Neither commands nor responses have a body unless stated otherwise.
52 .B allfiles \fIDIRECTORY\fR [\fIREGEXP\fR]
53 Lists all the files and directories in \fIDIRECTORY\fR in a response body.
54 If \fIREGEXP\fR is present only matching files and directories are returned.
57 Instructs the server to treat the connection as if \fIUSER\fR had
58 authenticated it. Only trusted users may issue this command.
60 .B dirs \fIDIRECTORY\fR [\fIREGEXP\fR]
61 Lists all the directories in \fIDIRECTORY\fR in a response body.
62 If \fIREGEXP\fR is present only matching directories are returned.
64 .B disable \fR[\fBnow\fR]
65 Disables further playing. If the optional \fBnow\fR argument is present then
66 the current track is stopped.
69 Re-enables further playing, and is the opposite of \fBdisable\fR.
72 Reports whether playing is enabled. The second field of the response line will
73 be \fByes\fR or \fBno\fR.
76 Reports whether the named track exists. The second field of the response line
77 will be \fByes\fR or \fBno\fR.
79 .B files \fIDIRECTORY\fR [\fIREGEXP\fR]
80 Lists all the files in \fIDIRECTORY\fR in a response body.
81 If \fIREGEXP\fR is present only matching files are returned.
83 .B get \fITRACK\fR \fIPREF\fR
84 Gets a preference value. On success the second field of the response line will
87 If the track or preference do not exist then the response code is 555.
89 .B get-global \fIKEY\fR
90 Get a global preference.
92 If the preference does not exist then the response code is 555.
95 Gets the length of the track in seconds. On success the second field of the
96 response line will have the value.
99 Sends event log messages in a response body. The command will never terminate.
100 Any further data sent to the server will be discarded (explicitly; i.e. it will
101 not accumulate in a buffer somewhere).
103 See \fBEVENT LOG\fR below for more details.
105 .B move \fITRACK\fR \fIDELTA\fR
106 Move a track in the queue. The track may be identified by ID (preferred) or
107 name (which might cause confusion if it's there twice). \fIDELTA\fR should be
108 an negative or positive integer and indicates how many steps towards the head
109 of the queue the track should be moved.
111 .B moveafter \fITARGET\fR \fIID\fR ...
112 Move all the tracks in the \fIID\fR list after ID \fITARGET\fR. If
113 \fITARGET\fR is the empty string then the listed tracks are put at the head of
114 the queue. If \fITARGET\fR is listed in the ID list then the tracks are moved
115 to just after the first non-listed track before it, or to the head if there is
118 .B new \fR[\fIMAX\fR]
119 Sends the most recently added \fIMAX\fR tracks in a response body. If the
120 argument is ommitted, all recently added tracks are listed.
125 as a keepalive measure.
127 .B part \fITRACK\fR \fICONTEXT\fI \fIPART\fR
128 Get a track name part. Returns an empty string if a name part cannot be
145 Pause the current track.
148 Add a track to the queue. The response contains the queue ID of the track.
151 Reports what track is playing.
153 If the response is \fB252\fR then the rest of the response line consists of
154 track information (see below).
156 If the response is \fB259\fR then nothing is playing.
159 Sends back the preferences for \fITRACK\fR in a response body.
160 Each line of the response has the usual line syntax, the first field being the
161 name of the pref and the second the value.
164 Sends back the current queue in a response body, one track to a line, the track
165 at the head of the queue (i.e. next to be be played) first. See below for the
166 track information syntax.
169 Disable random play (but don't stop the current track).
175 Reports whether random play is enabled. The second field of the response line
176 will be \fByes\fR or \fBno\fR.
179 Sends back the current recently-played list in a response body, one track to a
180 line, the track most recently played last. See below for the track
184 Request that DisOrder reconfigure itself. Only trusted users may issue this
188 Remove the track identified by \fIID\fR. If \fBrestrict remove\fR is enabled
189 in the server's configuration then only the user that submitted the track may
193 Rescan all roots for new or obsolete tracks.
195 .B resolve \fITRACK\fR
196 Resolve a track name, i.e. if this is an alias then return the real track name.
199 Resume the current track after a \fBpause\fR command.
202 Reports the RTP broadcast (or multicast) address, in the form \fIADDRESS
205 .B scratch \fR[\fIID\fR]
206 Remove the track identified by \fIID\fR, or the currently playing track if no
207 \fIID\fR is specified. If \fBrestrict scratch\fR is enabled in the server's
208 configuration then only the user that submitted the track may scratch it.
210 .B search \fITERMS\fR
211 Search for tracks matching the search terms. The results are put in a response
214 The search string is split in the usual way, with quoting supported, into a
215 list of terms. Only tracks matching all terms are included in the results.
217 Any terms of the form \fBtag:\fITAG\fR limits the search to tracks with that
220 All other terms are interpreted as individual words which must be present in
223 Spaces in terms don't currently make sense, but may one day be interpreted to
224 allow searching for phrases.
226 .B \fBset\fR \fITRACK\fR \fIPREF\fR \fIVALUE\fR
229 .B set-global \fIKEY\fR \fIVALUE\fR
230 Set a global preference.
233 Send server statistics in plain text in a response body.
236 Send the list of currently known tags in a response body.
238 .B \fBunset\fR \fITRACK\fR \fIPREF\fR
241 .B \fBunset-global\fR \fIKEY\fR
242 Unset a global preference.
244 .B user \fIUSER\fR \fIRESPONSE\fR
245 Authenticate as \fIUSER\fR. See
250 Send back a response with the server version as the second field.
252 .B volume \fR[\fILEFT\fR [\fIRIGHT\fR]]
253 Get or set the volume.
255 With zero parameters just gets the volume and reports the left and right sides
256 as the 2nd and 3rd fields of the response.
258 With one parameter sets both sides to the same value. With two parameters sets
259 each side independently.
261 Responses are three-digit codes. The first digit distinguishes errors from
270 The second digit breaks down the origin of the response:
273 Generic responses not specific to the handling of the command. Mostly this is
277 Authentication responses.
280 Responses specific to the handling of the command.
282 The third digit provides extra information about the response:
285 Text part is just commentary.
288 Text part is a constant result e.g. \fBversion\fR.
291 Text part is a potentially variable result.
294 Text part is just commentary; a dot-stuffed body follows.
297 Text part is just commentary; an indefinite dot-stuffed body follows. (Used
301 Used with "normal" errors, for instance a preference not being found. The text
305 The text part is just commentary (but would normally be a response for this
306 command) e.g. \fBplaying\fR.
308 When a connection is made the server sends a \fB231\fR response before any
309 command is received. This contains an algorithm name and a challenge encoded
312 Currently the algorithm name is omitted if it is \fBsha1\fR (but this will
313 probably change in a future version). The other options are \fBsha256\fR,
314 \fBsha384\fR and \fBsha512\fR. \fBSHA1\fR etc work as synonyms.
316 The \fBuser\fR response consists of the selected hash of the user's password
317 concatenated with the challenge, encoded in hex.
318 .SH "TRACK INFORMATION"
319 Track information is encoded in a line (i.e. using the usual line syntax) as
320 pairs of fields. The first is a name, the second a value. The names have the
324 The time the track is expected to be played at.
327 A string uniquely identifying this queue entry.
330 The time the track was played at.
333 The user that scratched the track.
336 The current track state. Valid states are:
340 The player failed (exited with nonzero status but wasn't scratched).
343 The track is actually a scratch.
346 No player could be found for the track.
349 The track was played without any problems.
352 The track was scratched.
355 The track is currently playing.
358 In the queue, hasn't been played yet.
361 The track was terminated because the server is shutting down.
365 The user that submitted the track.
368 The filename of the track.
371 The time the track was added to the queue.
374 The wait status of the player in decimal.
376 Times are decimal integers using the server's \fBtime_t\fR.
378 For file listings, the regexp applies to the basename of the returned file, not
379 the whole filename, and letter case is ignored. \fBpcrepattern\fR(3) describes
382 Filenames are in UTF-8 even if the collection they come from uses some other
383 encoding - if you want to access the real file (in such cases as the filenames
384 actually correspond to a real file) you'll have to convert to whatever the
387 The event log consists of lines starting with a hexadecimal timestamp and a
388 keyword followed by (optionally) parameters. The parameters are quoted in the
389 usual DisOrder way. Currently the following keywords are used:
391 .B completed \fITRACK\fR
392 Completed playing \fITRACK\fR
394 .B failed \fITRACK\fR \fIERROR\fR
395 Completed playing \fITRACK\fR with an error status
398 User \fIUSER\fR moved some track(s). Further details aren't included any
401 .B playing \fITRACK\fR [\fIUSER\fR]
402 Started playing \fITRACK\fR.
404 .B queue \fIQUEUE-ENTRY\fR...
405 Added \fITRACK\fR to the queue.
407 .B recent_added \fIQUEUE-ENTRY\fR...
408 Added \fIID\fR to the recently played list.
410 .B recent_removed \fIID\fR
411 Removed \fIID\fR from the recently played list.
413 .B removed \fIID\fR [\fIUSER\fR]
414 Queue entry \fIID\fR was removed. This is used both for explicit removal (when
415 \fIUSER\fR is present) and when playing a track (when it is absent).
420 .B scratched \fITRACK\fR \fIUSER\fR
421 \fITRACK\fR was scratched by \fIUSER\fR.
423 .B state \fIKEYWORD\fR
424 Some state change occurred. The current set of keywords is:
428 The current track completed successfully.
431 Playing was disabled.
434 Random play was disabled.
440 Random play was enabled.
443 The current track failed.
446 The current track was paused.
449 A track started playing.
452 The current track was resumed.
455 The current track was scratched.
457 To simplify client implementation, \fBstate\fR commands reflecting the current
458 state are sent at the start of the log.
461 .B volume \fILEFT\fR \fIRIGHT\fR
466 .B "TRACK INFORMATION"
468 .SH "CHARACTER ENCODING"
469 All data sent by both server and client is encoded using UTF-8. Moreover it
470 must be valid UTF-8, i.e. non-minimal sequences are not permitted, nor are
471 surrogates, nor are code points outside the Unicode code space.
473 There are no particular normalization requirements on either side of the
474 protocol. The server currently converts internally to NFC, the client must
475 normalize the responses returned if it needs some normalized form for further
478 The various characters which divide up lines may not be followed by combining
479 characters. For instance all of the following are prohibited:
482 LINE FEED followed by a combining character. For example the sequence
483 LINE FEED, COMBINING GRAVE ACCENT is never permitted.
486 APOSTROPHE or QUOTATION MARK followed by a combining character when used to
487 delimit fields. For instance a line starting APOSTROPHE, COMBINING CEDILLA
490 Note that such sequences are not prohibited when the quote character cannot be
491 interpreted as a field delimiter. For instance APOSTROPHE, REVERSE SOLIDUS,
492 APOSTROPHE, COMBINING CEDILLA, APOSTROPHE would be permitted.
495 REVERSE SOLIDUS (BACKSLASH) followed by a combining character in a quoted
496 string when it is the first character of an escape sequence. For instance a
497 line starting APOSTROPHE, REVERSE SOLIDUS, COMBINING TILDE is prohibited.
499 As above such sequences are not prohibited when the character is not being used
500 to start an escape sequence. For instance APOSTROPHE, REVERSE SOLIDUS,
501 REVERSE SOLIDS, COMBINING TILDER, APOSTROPHE is permitted.
504 Any of the field-splitting whitespace characters followed by a combining
505 character when not part of a quoted field. For instance a line starting COLON,
506 SPACE, COMBINING CANDRABINDU is prohibited.
508 As above non-delimiter uses are fine.
511 The FULL STOP characters used to quote or delimit a body.
513 Furthermore none of these characters are permitted to appear in the context of
514 a canonical decomposition (i.e. they must still be present when converted to
515 NFC). In practice however this is not an issue in Unicode 5.0.
517 These rules are consistent with the observation that the split() function is
518 essentially a naive ASCII parser. The implication is not that these sequences
519 never actually appear in the protocol, merely that the server is not required
520 to honor them in any useful way nor be consistent between versions: in current
521 versions the result will be lines and fields that start with combining
522 characters and are not necessarily split where you expect, but future versions
523 may remove them, reject them or ignore some or all of the delimiters that have
524 following combining characters, and no notice will be given of any change.
530 \fBdisorder_config\fR(5),
~mdw / disorder / blob