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