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