chiark - git - mdw - disorder/blob - doc/disorder_protocol.5.in

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