chiark / gitweb /
Update some copyright dates.
[disorder] / doc / disorder_protocol.5.in
CommitLineData
460b9539 1.\"
964e027d 2.\" Copyright (C) 2004-2008 Richard Kettlewell
460b9539 3.\"
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.
8.\"
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.
13.\"
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
17.\" USA
18.\"
19.TH disorder_protocol 5
20.SH NAME
21disorder_protocol \- DisOrder communication protocol
22.SH DESCRIPTION
23The DisOrder client and server communicate via the protocol described
24in this man page.
25.PP
26The protocol is liable to change without notice. You are recommended to check
27the implementation before believing this document.
28.SH "GENERAL SYNTAX"
f9635e06
RK
29Everything is encoded using UTF-8. See
30.B "CHARACTER ENCODING"
31below for more detail on character encoding issues.
460b9539 32.PP
f9635e06
RK
33Commands and responses consist of a line perhaps followed (depending on the
34command or response) by a body.
460b9539 35.PP
36The line syntax is the same as described in \fBdisorder_config\fR(5) except
37that comments are prohibited.
38.PP
39Bodies borrow their syntax from RFC821; they consist of zero or more ordinary
40lines, with any initial full stop doubled up, and are terminated by a line
41consisting of a full stop and a line feed.
42.SH COMMANDS
43Commands always have a command name as the first field of the line; responses
44always have a 3-digit response code as the first field. See below for more
45details about this field.
46.PP
47All commands require the connection to have been already authenticated unless
eb5dc014
RK
48stated otherwise. If not stated otherwise, the \fBread\fR right is sufficient
49to execute the command.
460b9539 50.PP
51Neither commands nor responses have a body unless stated otherwise.
52.TP
0f55e905 53.B adduser \fIUSERNAME PASSWORD \fR[\fIRIGHTS\fR]
5818980a 54Create a new user with the given username and password. The new user's rights
0f55e905
RK
55list can be specified; if it is not then the \fBdefault_rights\fR setting
56applies instead. Requires the \fBadmin\fR right, and only works on local
57connections.
eb5dc014 58.TP
460b9539 59.B allfiles \fIDIRECTORY\fR [\fIREGEXP\fR]
5818980a 60List all the files and directories in \fIDIRECTORY\fR in a response body.
460b9539 61If \fIREGEXP\fR is present only matching files and directories are returned.
62.TP
ba39faf6
RK
63.B confirm \fICONFIRMATION
64Confirm user registration. \fICONFIRMATION\fR is as returned from
65\fBregister\fR below. This command can be used without logging in.
66.TP
eb5dc014 67.B cookie \fICOOKIE
0227f67d
RK
68Log a user back in using a cookie created with \fBmake-cookie\fR. The response
69contains the username.
eb5dc014
RK
70.TP
71.B deluser \fIUSERNAME
5818980a 72Delete the named user. Requires the \fBadmin\fR right, and only works on
eb5dc014 73local connections.
460b9539 74.TP
75.B dirs \fIDIRECTORY\fR [\fIREGEXP\fR]
5818980a 76List all the directories in \fIDIRECTORY\fR in a response body.
460b9539 77If \fIREGEXP\fR is present only matching directories are returned.
78.TP
79.B disable \fR[\fBnow\fR]
5818980a 80Disable further playing. If the optional \fBnow\fR argument is present then
eb5dc014
RK
81the current track is stopped. Requires the \fBglobal prefs\fR right.
82.TP
83.B edituser \fIUSERNAME PROPERTY VALUE
5818980a 84Set a user property. With the \fBadmin\fR right any username and property may
eb5dc014
RK
85be specified. Otherwise the \fBuserinfo\fR right is required and only the
86\fBemail\fR and \fBpassword\fR properties may be set.
460b9539 87.TP
88.B enable
5818980a 89Re-enable further playing, and is the opposite of \fBdisable\fR. Requires the
eb5dc014 90\fBglobal prefs\fR right.
460b9539 91.TP
92.B enabled
5818980a 93Report whether playing is enabled. The second field of the response line will
460b9539 94be \fByes\fR or \fBno\fR.
95.TP
96.B exists \fITRACK\fR
5818980a 97Report whether the named track exists. The second field of the response line
460b9539 98will be \fByes\fR or \fBno\fR.
99.TP
100.B files \fIDIRECTORY\fR [\fIREGEXP\fR]
5818980a 101List all the files in \fIDIRECTORY\fR in a response body.
460b9539 102If \fIREGEXP\fR is present only matching files are returned.
103.TP
104.B get \fITRACK\fR \fIPREF\fR
5818980a 105Getsa preference value. On success the second field of the response line will
460b9539 106have the value.
fb1bc1f5
RK
107.IP
108If the track or preference do not exist then the response code is 555.
460b9539 109.TP
110.B get-global \fIKEY\fR
111Get a global preference.
fb1bc1f5
RK
112.IP
113If the preference does not exist then the response code is 555.
460b9539 114.TP
115.B length \fITRACK\fR
5818980a 116Get the length of the track in seconds. On success the second field of the
460b9539 117response line will have the value.
118.TP
119.B log
5818980a 120Send event log messages in a response body. The command will never terminate.
397ef7bb
RK
121Any further data sent to the server will be discarded (explicitly; i.e. it will
122not accumulate in a buffer somewhere).
460b9539 123.IP
124See \fBEVENT LOG\fR below for more details.
125.TP
eb5dc014
RK
126.B make-cookie
127Returns an opaque string that can be used by the \fBcookie\fR command to log
128this user back in on another connection (until the cookie expires).
129.TP
460b9539 130.B move \fITRACK\fR \fIDELTA\fR
131Move a track in the queue. The track may be identified by ID (preferred) or
132name (which might cause confusion if it's there twice). \fIDELTA\fR should be
133an negative or positive integer and indicates how many steps towards the head
134of the queue the track should be moved.
eb5dc014
RK
135.IP
136Requires one of the \fBmove mine\fR, \fBmove random\fR or \fBmove any\fR rights
137depending on how the track came to be added to the queue.
460b9539 138.TP
139.B moveafter \fITARGET\fR \fIID\fR ...
140Move all the tracks in the \fIID\fR list after ID \fITARGET\fR. If
141\fITARGET\fR is the empty string then the listed tracks are put at the head of
142the queue. If \fITARGET\fR is listed in the ID list then the tracks are moved
143to just after the first non-listed track before it, or to the head if there is
144no such track.
eb5dc014
RK
145.IP
146Requires one of the \fBmove mine\fR, \fBmove random\fR or \fBmove any\fR rights
147depending on how the tracks came to be added to the queue.
460b9539 148.TP
2a10b70b 149.B new \fR[\fIMAX\fR]
5818980a 150Send the most recently added \fIMAX\fR tracks in a response body. If the
d742bb47
RK
151argument is ommitted, the \fBnew_max\fR most recent tracks are listed (see
152\fBdisorder_config\fR(5)).
2a10b70b 153.TP
7858930d 154.B nop
155Do nothing. Used by
156.BR disobedience (1)
eb5dc014 157as a keepalive measure. This command does not require authentication.
7858930d 158.TP
460b9539 159.B part \fITRACK\fR \fICONTEXT\fI \fIPART\fR
160Get a track name part. Returns an empty string if a name part cannot be
161constructed.
162.IP
163.I CONTEXT
164is one of
165.B sort
166or
167.B display
168and
169.I PART
170is usually one of
171.BR artist ,
172.B album
173or
174.BR title .
175.TP
176.B pause
fce810c2 177Pause the current track. Requires the \fBpause\fR right.
460b9539 178.TP
179.B play \fITRACK\fR
81e440ce 180Add a track to the queue. The response contains the queue ID of the track.
eb5dc014 181Requires the \fBplay\fR right.
460b9539 182.TP
183.B playing
5818980a 184Report what track is playing.
460b9539 185.IP
186If the response is \fB252\fR then the rest of the response line consists of
187track information (see below).
188.IP
189If the response is \fB259\fR then nothing is playing.
190.TP
191.B prefs \fBTRACK\fR
5818980a 192Send back the preferences for \fITRACK\fR in a response body.
460b9539 193Each line of the response has the usual line syntax, the first field being the
194name of the pref and the second the value.
195.TP
196.B queue
5818980a 197Send back the current queue in a response body, one track to a line, the track
460b9539 198at the head of the queue (i.e. next to be be played) first. See below for the
199track information syntax.
200.TP
201.B random-disable
eb5dc014
RK
202Disable random play (but don't stop the current track). Requires the \fBglobal
203prefs\fR right.
460b9539 204.TP
205.B random-enable
eb5dc014 206Enable random play. Requires the \fBglobal prefs\fR right.
460b9539 207.TP
208.B random-enabled
5818980a 209Report whether random play is enabled. The second field of the response line
460b9539 210will be \fByes\fR or \fBno\fR.
211.TP
212.B recent
5818980a 213Send back the current recently-played list in a response body, one track to a
460b9539 214line, the track most recently played last. See below for the track
215information syntax.
216.TP
217.B reconfigure
eb5dc014 218Request that DisOrder reconfigure itself. Requires the \fBadmin\fR right.
460b9539 219command.
220.TP
ba39faf6
RK
221.B register \fIUSER PASSWORD EMAIL
222Register a new user. Requires the \fBregister\fR right. The result contains a
223confirmation string; the user will be be able to log in until this has been
224presented back to the server via the \fBconfirm\fR command.
225.TP
460b9539 226.B remove \fIID\fR
eb5dc014
RK
227Remove the track identified by \fIID\fR. Requires one of the \fBremove
228mine\fR, \fBremove random\fR or \fBremove any\fR rights depending on how the
229track came to be added to the queue.
460b9539 230.TP
231.B rescan
eb5dc014 232Rescan all roots for new or obsolete tracks. Requires the \fBrescan\fR right.
460b9539 233.TP
234.B resolve \fITRACK\fR
235Resolve a track name, i.e. if this is an alias then return the real track name.
236.TP
237.B resume
eb5dc014
RK
238Resume the current track after a \fBpause\fR command. Requires the \fBpause\fR
239right.
240.TP
241.B revoke \fBcookie\fR
5818980a 242Revoke a cookie previously created with \fBmake-cookie\fR. It will not be
eb5dc014 243possible to use this cookie in the future.
460b9539 244.TP
ca831831 245.B rtp-address
5818980a 246Report the RTP broadcast (or multicast) address, in the form \fIADDRESS
eb5dc014 247PORT\fR. This command does not require authentication.
ca831831 248.TP
460b9539 249.B scratch \fR[\fIID\fR]
250Remove the track identified by \fIID\fR, or the currently playing track if no
eb5dc014
RK
251\fIID\fR is specified. Requires one of the \fBscratch mine\fR, \fBscratch
252random\fR or \fBscratch any\fR rights depending on how the track came to be
253added to the queue.
460b9539 254.TP
255.B search \fITERMS\fR
256Search for tracks matching the search terms. The results are put in a response
257body, one to a line.
258.IP
259The search string is split in the usual way, with quoting supported, into a
260list of terms. Only tracks matching all terms are included in the results.
261.IP
262Any terms of the form \fBtag:\fITAG\fR limits the search to tracks with that
263tag.
264.IP
265All other terms are interpreted as individual words which must be present in
266the track name.
267.IP
268Spaces in terms don't currently make sense, but may one day be interpreted to
269allow searching for phrases.
270.TP
271.B \fBset\fR \fITRACK\fR \fIPREF\fR \fIVALUE\fR
eb5dc014 272Set a preference. Requires the \fBprefs\fR right.
460b9539 273.TP
274.B set-global \fIKEY\fR \fIVALUE\fR
eb5dc014 275Set a global preference. Requires the \fBglobal prefs\fR right.
460b9539 276.TP
277.B stats
278Send server statistics in plain text in a response body.
279.TP
280.B \fBtags\fR
281Send the list of currently known tags in a response body.
282.TP
283.B \fBunset\fR \fITRACK\fR \fIPREF\fR
eb5dc014 284Unset a preference. Requires the \fBprefs\fR right.
460b9539 285.TP
286.B \fBunset-global\fR \fIKEY\fR
eb5dc014 287Unset a global preference. Requires the \fBglobal prefs\fR right.
460b9539 288.TP
289.B user \fIUSER\fR \fIRESPONSE\fR
5e3f9e08
RK
290Authenticate as \fIUSER\fR. See
291.B AUTHENTICATION
292below.
460b9539 293.TP
eb5dc014 294.B users
5818980a 295Send the list of currently known users in a response body.
eb5dc014 296.TP
460b9539 297.B version
298Send back a response with the server version as the second field.
299.TP
300.B volume \fR[\fILEFT\fR [\fIRIGHT\fR]]
301Get or set the volume.
302.IP
303With zero parameters just gets the volume and reports the left and right sides
304as the 2nd and 3rd fields of the response.
305.IP
306With one parameter sets both sides to the same value. With two parameters sets
eb5dc014 307each side independently. Setting the volume requires the \fBvolume\fR right.
460b9539 308.SH RESPONSES
309Responses are three-digit codes. The first digit distinguishes errors from
310succesful responses:
311.TP
312.B 2
313Operation succeeded.
314.TP
315.B 5
316Operation failed.
317.PP
318The second digit breaks down the origin of the response:
319.TP
320.B 0
321Generic responses not specific to the handling of the command. Mostly this is
322parse errors.
323.TP
b4a80f69 324.B 1
32551x errors indicate that the user had insufficient rights for the command.
326.TP
460b9539 327.B 3
328Authentication responses.
329.TP
330.B 5
331Responses specific to the handling of the command.
332.PP
333The third digit provides extra information about the response:
334.TP
335.B 0
336Text part is just commentary.
337.TP
338.B 1
339Text part is a constant result e.g. \fBversion\fR.
340.TP
341.B 2
342Text part is a potentially variable result.
343.TP
344.B 3
345Text part is just commentary; a dot-stuffed body follows.
346.TP
347.B 4
348Text part is just commentary; an indefinite dot-stuffed body follows. (Used
349for \fBlog\fR.)
350.TP
fb1bc1f5
RK
351.B 5
352Used with "normal" errors, for instance a preference not being found. The text
353part is commentary.
354.TP
460b9539 355.B 9
356The text part is just commentary (but would normally be a response for this
357command) e.g. \fBplaying\fR.
7b32e917
RK
358.PP
359Result strings (not bodies) intended for machine parsing (i.e. xx1 and xx2
360responses) are quoted.
460b9539 361.SH AUTHENTICATION
5e3f9e08 362When a connection is made the server sends a \fB231\fR response before any
7b32e917
RK
363command is received. This contains a protocol generation, an algorithm name
364and a challenge encoded in hex, all separated by whitespace.
365.PP
366The current protocol generation is \fB2\fR.
5e3f9e08 367.PP
b3141726
RK
368The possible algorithms are (currently) \fBsha1\fR, \fBsha256\fR, \fBsha384\fR
369and \fBsha512\fR. \fBSHA1\fR etc work as synonyms.
460b9539 370.PP
5e3f9e08
RK
371The \fBuser\fR response consists of the selected hash of the user's password
372concatenated with the challenge, encoded in hex.
460b9539 373.SH "TRACK INFORMATION"
374Track information is encoded in a line (i.e. using the usual line syntax) as
375pairs of fields. The first is a name, the second a value. The names have the
376following meanings:
377.TP 12
378.B expected
379The time the track is expected to be played at.
380.TP
381.B id
382A string uniquely identifying this queue entry.
383.TP
384.B played
385The time the track was played at.
386.TP
387.B scratched
388The user that scratched the track.
389.TP
390.B state
391The current track state. Valid states are:
392.RS
393.TP 12
394.B failed
395The player failed (exited with nonzero status but wasn't scratched).
396.TP
397.B isscratch
398The track is actually a scratch.
399.TP
400.B no_player
401No player could be found for the track.
402.TP
403.B ok
404The track was played without any problems.
405.TP
406.B scratched
407The track was scratched.
408.TP
409.B started
410The track is currently playing.
411.TP
412.B unplayed
413In the queue, hasn't been played yet.
414.TP
415.B quitting
416The track was terminated because the server is shutting down.
417.RE
418.TP
419.B submitter
420The user that submitted the track.
421.TP
422.B track
423The filename of the track.
424.TP
425.B when
426The time the track was added to the queue.
427.TP
428.B wstat
429The wait status of the player in decimal.
430.SH NOTES
431Times are decimal integers using the server's \fBtime_t\fR.
432.PP
433For file listings, the regexp applies to the basename of the returned file, not
434the whole filename, and letter case is ignored. \fBpcrepattern\fR(3) describes
435the regexp syntax.
436.PP
437Filenames are in UTF-8 even if the collection they come from uses some other
438encoding - if you want to access the real file (in such cases as the filenames
439actually correspond to a real file) you'll have to convert to whatever the
440right encoding is.
441.SH "EVENT LOG"
442The event log consists of lines starting with a hexadecimal timestamp and a
443keyword followed by (optionally) parameters. The parameters are quoted in the
444usual DisOrder way. Currently the following keywords are used:
445.TP
446.B completed \fITRACK\fR
447Completed playing \fITRACK\fR
448.TP
449.B failed \fITRACK\fR \fIERROR\fR
450Completed playing \fITRACK\fR with an error status
451.TP
452.B moved \fIUSER\fR
453User \fIUSER\fR moved some track(s). Further details aren't included any
454more.
455.TP
456.B playing \fITRACK\fR [\fIUSER\fR]
457Started playing \fITRACK\fR.
458.TP
459.B queue \fIQUEUE-ENTRY\fR...
460Added \fITRACK\fR to the queue.
461.TP
462.B recent_added \fIQUEUE-ENTRY\fR...
463Added \fIID\fR to the recently played list.
464.TP
465.B recent_removed \fIID\fR
466Removed \fIID\fR from the recently played list.
467.TP
468.B removed \fIID\fR [\fIUSER\fR]
469Queue entry \fIID\fR was removed. This is used both for explicit removal (when
470\fIUSER\fR is present) and when playing a track (when it is absent).
471.TP
e025abff
RK
472.B rescanned
473A rescan completed.
474.TP
460b9539 475.B scratched \fITRACK\fR \fIUSER\fR
476\fITRACK\fR was scratched by \fIUSER\fR.
477.TP
478.B state \fIKEYWORD\fR
479Some state change occurred. The current set of keywords is:
480.RS
481.TP
5abe307a
RK
482.B completed
483The current track completed successfully.
484.TP
460b9539 485.B disable_play
486Playing was disabled.
487.TP
488.B disable_random
489Random play was disabled.
490.TP
491.B enable_play
492Playing was enabled.
493.TP
494.B enable_random
495Random play was enabled.
496.TP
5abe307a
RK
497.B failed
498The current track failed.
499.TP
460b9539 500.B pause
501The current track was paused.
502.TP
5abe307a
RK
503.B playing
504A track started playing.
505.TP
460b9539 506.B resume
507The current track was resumed.
5abe307a
RK
508.TP
509.B scratched
510The current track was scratched.
511.PP
512To simplify client implementation, \fBstate\fR commands reflecting the current
513state are sent at the start of the log.
460b9539 514.RE
515.TP
516.B volume \fILEFT\fR \fIRIGHT\fR
517The volume changed.
518.PP
519.IR QUEUE-ENTRY ...
520is as defined in
521.B "TRACK INFORMATION"
522above.
f9635e06
RK
523.SH "CHARACTER ENCODING"
524All data sent by both server and client is encoded using UTF-8. Moreover it
525must be valid UTF-8, i.e. non-minimal sequences are not permitted, nor are
526surrogates, nor are code points outside the Unicode code space.
527.PP
528There are no particular normalization requirements on either side of the
529protocol. The server currently converts internally to NFC, the client must
530normalize the responses returned if it needs some normalized form for further
531processing.
532.PP
533The various characters which divide up lines may not be followed by combining
534characters. For instance all of the following are prohibited:
535.TP
536.B o
537LINE FEED followed by a combining character. For example the sequence
538LINE FEED, COMBINING GRAVE ACCENT is never permitted.
539.TP
540.B o
541APOSTROPHE or QUOTATION MARK followed by a combining character when used to
542delimit fields. For instance a line starting APOSTROPHE, COMBINING CEDILLA
543is prohibited.
544.IP
545Note that such sequences are not prohibited when the quote character cannot be
546interpreted as a field delimiter. For instance APOSTROPHE, REVERSE SOLIDUS,
547APOSTROPHE, COMBINING CEDILLA, APOSTROPHE would be permitted.
548.TP
549.B o
550REVERSE SOLIDUS (BACKSLASH) followed by a combining character in a quoted
551string when it is the first character of an escape sequence. For instance a
552line starting APOSTROPHE, REVERSE SOLIDUS, COMBINING TILDE is prohibited.
553.IP
554As above such sequences are not prohibited when the character is not being used
555to start an escape sequence. For instance APOSTROPHE, REVERSE SOLIDUS,
556REVERSE SOLIDS, COMBINING TILDER, APOSTROPHE is permitted.
557.TP
558.B o
559Any of the field-splitting whitespace characters followed by a combining
560character when not part of a quoted field. For instance a line starting COLON,
561SPACE, COMBINING CANDRABINDU is prohibited.
562.IP
563As above non-delimiter uses are fine.
564.TP
565.B o
566The FULL STOP characters used to quote or delimit a body.
567.PP
568Furthermore none of these characters are permitted to appear in the context of
569a canonical decomposition (i.e. they must still be present when converted to
570NFC). In practice however this is not an issue in Unicode 5.0.
571.PP
572These rules are consistent with the observation that the split() function is
573essentially a naive ASCII parser. The implication is not that these sequences
574never actually appear in the protocol, merely that the server is not required
575to honor them in any useful way nor be consistent between versions: in current
576versions the result will be lines and fields that start with combining
577characters and are not necessarily split where you expect, but future versions
578may remove them, reject them or ignore some or all of the delimiters that have
579following combining characters, and no notice will be given of any change.
460b9539 580.SH "SEE ALSO"
581\fBdisorder\fR(1),
582\fBtime\fR(2),
583\fBdisorder\fR(3),
584\fBpcrepattern\fR(3)
585\fBdisorder_config\fR(5),
586\fBdisorderd\fR(8),
587\fButf8\fR(7)
588.\" Local Variables:
589.\" mode:nroff
590.\" fill-column:79
591.\" End: