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

   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 3 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,
  10 .\" but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12 .\" GNU 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, see <http://www.gnu.org/licenses/>.
  16 .\"
  17 .TH disorder_protocol 5
  18 .SH NAME
  19 disorder_protocol \- DisOrder communication protocol
  20 .SH DESCRIPTION
  21 The DisOrder client and server communicate via the protocol described
  22 in this man page.
  23 .PP
  24 The protocol is liable to change without notice.
  25 You are recommended to check the implementation before believing this document.
  26 .SH "GENERAL SYNTAX"
  27 Everything is encoded using UTF-8.
  28 See
  29 .B "CHARACTER ENCODING"
  30 below for more detail on character encoding issues.
  31 .PP
  32 Commands and responses consist of a line perhaps followed (depending on the
  33 command or response) by a body.
  34 .PP
  35 The line syntax is the same as described in \fBdisorder_config\fR(5) except
  36 that comments are prohibited.
  37 .PP
  38 Bodies borrow their syntax from RFC821; they consist of zero or more ordinary
  39 lines, with any initial full stop doubled up, and are terminated by a line
  40 consisting of a full stop and a line feed.
  41 .PP
  42 Commands only have a body if explicitly stated below.
  43 If they do have a body then the body should always be sent immediately;
  44 unlike (for instance) the SMTP "DATA" command there is no intermediate step
  45 where the server asks for the body to be sent.
  46 .PP
  47 Replies also only have a body if stated below.
  48 The presence of a reply body can always be inferred from the response code;
  49 if the last digit is a 3 then a body is present, otherwise it is not.
  50 .SH COMMANDS
  51 Commands always have a command name as the first field of the line; responses
  52 always have a 3-digit response code as the first field.
  53 See below for more details about this field.
  54 .PP
  55 All commands require the connection to have been already authenticated unless
  56 stated otherwise.
  57 If not stated otherwise, the \fBread\fR right is sufficient to execute
  58 the command.
  59 .TP
  60 .B adduser \fIUSERNAME PASSWORD \fR[\fIRIGHTS\fR]
  61 Create a new user with the given username and password.
  62 The new user's rights list can be specified; if it is not
  63 then the \fBdefault_rights\fR setting applies instead.
  64 Requires the \fBadmin\fR right, and only works on local
  65 connections.
  66 .TP
  67 .B adopt \fIID\fR
  68 Adopts a randomly picked track, leaving it in a similar state to if it was
  69 picked by this user.  Requires the \fBplay\fR right.
  70 .TP
  71 .B allfiles \fIDIRECTORY\fR [\fIREGEXP\fR]
  72 List all the files and directories in \fIDIRECTORY\fR in a response body.
  73 If \fIREGEXP\fR is present only matching files and directories are returned.
  74 .TP
  75 .B confirm \fICONFIRMATION
  76 Confirm user registration.
  77 \fICONFIRMATION\fR is as returned from \fBregister\fR below.
  78 This command can be used without logging in.
  79 .TP
  80 .B cookie \fICOOKIE
  81 Log a user back in using a cookie created with \fBmake\-cookie\fR.
  82 The response contains the username.
  83 .TP
  84 .B deluser \fIUSERNAME
  85 Delete the named user.
  86 Requires the \fBadmin\fR right, and only works on local connections.
  87 .TP
  88 .B dirs \fIDIRECTORY\fR [\fIREGEXP\fR]
  89 List all the directories in \fIDIRECTORY\fR in a response body.
  90 If \fIREGEXP\fR is present only matching directories are returned.
  91 .TP
  92 .B disable \fR[\fBnow\fR]
  93 Disable further playing.
  94 If the optional \fBnow\fR argument is present then the current track
  95 is stopped.
  96 Requires the \fBglobal prefs\fR right.
  97 .TP
  98 .B edituser \fIUSERNAME PROPERTY VALUE
  99 Set a user property.
 100 With the \fBadmin\fR right any username and property may be specified.
 101 Otherwise the \fBuserinfo\fR right is required and only the
 102 \fBemail\fR and \fBpassword\fR properties may be set.
 103 .IP
 104 User properties are syntax-checked before setting.  For instance \fBemail\fR
 105 must contain an "@" sign or you will get an error.  (Setting an empty value for
 106 \fBemail\fR is allowed and removes the property.)
 107 .TP
 108 .B enable
 109 Re-enable further playing, and is the opposite of \fBdisable\fR.
 110 Requires the \fBglobal prefs\fR right.
 111 .TP
 112 .B enabled
 113 Report whether playing is enabled.
 114 The second field of the response line will be \fByes\fR or \fBno\fR.
 115 .TP
 116 .B exists \fITRACK\fR
 117 Report whether the named track exists.
 118 The second field of the response line will be \fByes\fR or \fBno\fR.
 119 .TP
 120 .B files \fIDIRECTORY\fR [\fIREGEXP\fR]
 121 List all the files in \fIDIRECTORY\fR in a response body.
 122 If \fIREGEXP\fR is present only matching files are returned.
 123 .TP
 124 .B get \fITRACK\fR \fIPREF\fR
 125 Getsa preference value.
 126 On success the second field of the response line will have the value.
 127 .IP
 128 If the track or preference do not exist then the response code is 555.
 129 .TP
 130 .B get\-global \fIKEY\fR
 131 Get a global preference.
 132 .IP
 133 If the preference does not exist then the response code is 555.
 134 .TP
 135 .B length \fITRACK\fR
 136 Get the length of the track in seconds.
 137 On success the second field of the response line will have the value.
 138 .TP
 139 .B log
 140 Send event log messages in a response body.
 141 The command will never terminate.
 142 Any further data sent to the server will be discarded (explicitly;
 143 i.e. it will not accumulate in a buffer somewhere).
 144 .IP
 145 See \fBEVENT LOG\fR below for more details.
 146 .TP
 147 .B make\-cookie
 148 Returns an opaque string that can be used by the \fBcookie\fR command to log
 149 this user back in on another connection (until the cookie expires).
 150 .TP
 151 .B move \fITRACK\fR \fIDELTA\fR
 152 Move a track in the queue.
 153 The track may be identified by ID (preferred) or name (which might cause
 154 confusion if it's there twice).
 155 \fIDELTA\fR should be an negative or positive integer and indicates how
 156 many steps towards the head of the queue the track should be moved.
 157 .IP
 158 Requires one of the \fBmove mine\fR, \fBmove random\fR or \fBmove any\fR rights
 159 depending on how the track came to be added to the queue.
 160 .TP
 161 .B moveafter \fITARGET\fR \fIID\fR ...
 162 Move all the tracks in the \fIID\fR list after ID \fITARGET\fR.
 163 If \fITARGET\fR is the empty string then the listed tracks are put
 164 at the head of the queue.
 165 If \fITARGET\fR is listed in the ID list then the tracks are moved
 166 to just after the first non-listed track before it, or to the head if there is
 167 no such track.
 168 .IP
 169 Requires one of the \fBmove mine\fR, \fBmove random\fR or \fBmove any\fR rights
 170 depending on how the tracks came to be added to the queue.
 171 .TP
 172 .B new \fR[\fIMAX\fR]
 173 Send the most recently added \fIMAX\fR tracks in a response body.
 174 If the argument is ommitted, the \fBnew_max\fR most recent tracks are
 175 listed (see \fBdisorder_config\fR(5)).
 176 .TP
 177 .B nop
 178 Do nothing.
 179 Used by
 180 .BR disobedience (1)
 181 as a keepalive measure.
 182 This command does not require authentication.
 183 .TP
 184 .B part \fITRACK\fR \fICONTEXT\fI \fIPART\fR
 185 Get a track name part.
 186 Returns an empty string if a name part cannot be constructed.
 187 .IP
 188 .I CONTEXT
 189 is one of
 190 .B sort
 191 or
 192 .B display
 193 and
 194 .I PART
 195 is usually one of
 196 .BR artist ,
 197 .B album
 198 or
 199 .BR title .
 200 .TP
 201 .B pause
 202 Pause the current track.
 203 Requires the \fBpause\fR right.
 204 .TP
 205 .B play \fITRACK\fR
 206 Add a track to the queue.
 207 The response contains the queue ID of the track.
 208 Requires the \fBplay\fR right.
 209 .TP
 210 .B playing
 211 Report what track is playing.
 212 .IP
 213 If the response is \fB252\fR then the rest of the response line consists of
 214 track information (see below).
 215 .IP
 216 If the response is \fB259\fR then nothing is playing.
 217 .TP
 218 .B playlist-delete \fIPLAYLIST\fR
 219 Delete a playlist.
 220 Requires permission to modify that playlist and the \fBplay\fR right.
 221 .TP
 222 .B playlist-get \fIPLAYLIST\fR
 223 Get the contents of a playlist, in a response body.
 224 Requires permission to read that playlist and the \fBread\fR right.
 225 .TP
 226 .B playlist-get-share \fIPLAYLIST\fR
 227 Get the sharing status of a playlist.
 228 The result will be \fBpublic\fR, \fBprivate\fR or \fBshared\fR.
 229 Requires permission to read that playlist and the \fBread\fR right.
 230 .TP
 231 .B playlist-lock \fIPLAYLIST\fR
 232 Lock a playlist.
 233 Requires permission to modify that playlist and the \fBplay\fR right.
 234 Only one playlist may be locked at a time on a given connection and the lock
 235 automatically expires when the connection is closed.
 236 .TP
 237 .B playlist-set \fIPLAYLIST\fR
 238 Set the contents of a playlist.
 239 The new contents should be supplied in a command body.
 240 Requires permission to modify that playlist and the \fBplay\fR right.
 241 The playlist must be locked.
 242 .TP
 243 .B playlist-set-share \fIPLAYLIST\fR \fISHARE\fR
 244 Set the sharing status of a playlist to
 245 \fBpublic\fR, \fBprivate\fR or \fBshared\fR.
 246 Requires permission to modify that playlist and the \fBplay\fR right.
 247 .TP
 248 .B playlist-unlock\fR
 249 Unlock the locked playlist.
 250 .TP
 251 .B playlists
 252 List all playlists that this connection has permission to read.
 253 Requires the \fBread\fR right.
 254 .TP
 255 .B prefs \fBTRACK\fR
 256 Send back the preferences for \fITRACK\fR in a response body.
 257 Each line of the response has the usual line syntax, the first field being the
 258 name of the pref and the second the value.
 259 .TP
 260 .B queue
 261 Send back the current queue in a response body, one track to a line, the track
 262 at the head of the queue (i.e. next to be be played) first.
 263 See below for the track information syntax.
 264 .TP
 265 .B random\-disable
 266 Disable random play (but don't stop the current track).
 267 Requires the \fBglobal prefs\fR right.
 268 .TP
 269 .B random\-enable
 270 Enable random play.
 271 Requires the \fBglobal prefs\fR right.
 272 .TP
 273 .B random\-enabled
 274 Report whether random play is enabled.
 275 The second field of the response line will be \fByes\fR or \fBno\fR.
 276 .TP
 277 .B recent
 278 Send back the current recently-played list in a response body, one track to a
 279 line, the track most recently played last.
 280 See below for the track information syntax.
 281 .TP
 282 .B reconfigure
 283 Request that DisOrder reconfigure itself.
 284 Requires the \fBadmin\fR right.
 285 .TP
 286 .B register \fIUSERNAME PASSWORD EMAIL
 287 Register a new user.
 288 Requires the \fBregister\fR right.
 289 The result contains a confirmation string; the user will be be able
 290 to log in until this has been presented back to the server via the
 291 \fBconfirm\fR command.
 292 .TP
 293 .B reminder \fIUSERNAME\fR
 294 Send a password reminder to user \fIUSERNAME\fR.
 295 If the user has no valid email address, or no password, or a
 296 reminder has been sent too recently, then no reminder will be sent.
 297 .TP
 298 .B remove \fIID\fR
 299 Remove the track identified by \fIID\fR.
 300 Requires one of the \fBremove mine\fR, \fBremove random\fR or
 301 \fBremove any\fR rights depending on how the
 302 track came to be added to the queue.
 303 .TP
 304 .B rescan \fR[\fBwait\fR] \fR[\fBfresh\fR]
 305 Rescan all roots for new or obsolete tracks.
 306 Requires the \fBrescan\fR right.
 307 .IP
 308 If the \fBwait\fR flag is present then the response is delayed until the rescan
 309 completes.
 310 Otherwise the response arrives immediately.
 311 This is primarily intended for testing.
 312 .IP
 313 If the \fBfresh\fR flag is present a rescan is already underway then a second
 314 rescan will be started when it completes.
 315 The default behavior is to piggyback on the existing rescan.
 316 .IP
 317 NB that \fBfresh\fR is currently disabled in the server source, so using this
 318 flag will just provoke an error.
 319 .TP
 320 .B resolve \fITRACK\fR
 321 Resolve a track name, i.e. if this is an alias then return the real track name.
 322 .TP
 323 .B resume
 324 Resume the current track after a \fBpause\fR command.
 325 Requires the \fBpause\fR right.
 326 .TP
 327 .B revoke \fBcookie\fR
 328 Revoke a cookie previously created with \fBmake\-cookie\fR.
 329 It will not be possible to use this cookie in the future.
 330 .TP
 331 .B rtp\-address
 332 Report the RTP broadcast (or multicast) address, in the form \fIADDRESS
 333 PORT\fR.
 334 This command does not require authentication.
 335 .TP
 336 .B scratch \fR[\fIID\fR]
 337 Remove the track identified by \fIID\fR, or the currently playing track if no
 338 \fIID\fR is specified.
 339 Requires one of the \fBscratch mine\fR, \fBscratch random\fR or
 340 \fBscratch any\fR rights depending on how the track came to be
 341 added to the queue.
 342 .TP
 343 .B schedule-add \fIWHEN\fR \fIPRIORITY\fR \fIACTION\fR ...
 344 Schedule an event for the future.
 345 .IP
 346 .I WHEN
 347 is the time when it should happen, as \fBtime_t\fR value.
 348 It must refer to a time in the future.
 349 .IP
 350 .I PRIORITY
 351 is the event priority.
 352 This can be \fBnormal\fR, in which case the event will be run at startup if its
 353 time has past, or \fBjunk\fR in which case it will be discarded if it is found
 354 to be in the past at startup.
 355 The meaning of other values is not defined.
 356 .IP
 357 .I ACTION
 358 is the action to perform.
 359 The choice of action determines the meaning of the remaining arguments.
 360 Possible actions are:
 361 .RS
 362 .TP
 363 .B play
 364 Play a track.
 365 The next argument is the track name.
 366 Requires the \fBplay\fR right.
 367 .TP
 368 .B set-global
 369 Set a global preference.
 370 The next argument is the preference name and the final argument is the value to
 371 set it to (omit it to unset it).
 372 Requires the \fBglobal prefs\fR right.
 373 .RE
 374 .IP
 375 You need the right at the point you create the event.
 376 It is not possible to create scheduled events in expectation of a future change
 377 in rights.
 378 .TP
 379 .B schedule-del \fIEVENT\fR
 380 Deletes a scheduled event.
 381 Users can always delete their own scheduled events; with the \fBadmin\fR
 382 right you can delete any event.
 383 .TP
 384 .B schedule-get \fIEVENT\fR
 385 Sends the details of scheduled event \fIEVENT\fR in a response body.
 386 Each line is a pair of strings quoted in the usual way, the first being the key
 387 ane the second the value.
 388 No particular order is used.
 389 .IP
 390 Scheduled events are considered public information.
 391 Right \fBread\fR is sufficient to see details of all events.
 392 .TP
 393 .B schedule-list
 394 Sends the event IDs of all scheduled events in a response body, in no
 395 particular order.
 396 Use \fBschedule-get\fR to get the details of each event.
 397 .TP
 398 .B search \fITERMS\fR
 399 Search for tracks matching the search terms.
 400 The results are put in a response body, one to a line.
 401 .IP
 402 The search string is split in the usual way, with quoting supported, into a
 403 list of terms.
 404 Only tracks matching all terms are included in the results.
 405 .IP
 406 Any terms of the form \fBtag:\fITAG\fR limits the search to tracks with that
 407 tag.
 408 .IP
 409 All other terms are interpreted as individual words which must be present in
 410 the track name.
 411 .IP
 412 Spaces in terms don't currently make sense, but may one day be interpreted to
 413 allow searching for phrases.
 414 .TP
 415 .B \fBset\fR \fITRACK\fR \fIPREF\fR \fIVALUE\fR
 416 Set a preference.
 417 Requires the \fBprefs\fR right.
 418 .TP
 419 .B set\-global \fIKEY\fR \fIVALUE\fR
 420 Set a global preference.
 421 Requires the \fBglobal prefs\fR right.
 422 .TP
 423 .B stats
 424 Send server statistics in plain text in a response body.
 425 .TP
 426 .B \fBtags\fR
 427 Send the list of currently known tags in a response body.
 428 .TP
 429 .B \fBunset\fR \fITRACK\fR \fIPREF\fR
 430 Unset a preference.
 431 Requires the \fBprefs\fR right.
 432 .TP
 433 .B \fBunset\-global\fR \fIKEY\fR
 434 Unset a global preference.
 435 Requires the \fBglobal prefs\fR right.
 436 .TP
 437 .B user \fIUSERNAME\fR \fIRESPONSE\fR
 438 Authenticate as user \fIUSERNAME\fR.
 439 See
 440 .B AUTHENTICATION
 441 below.
 442 .TP
 443 .B userinfo \fIUSERNAME PROPERTY
 444 Get a user property.
 445 .TP
 446 .B users
 447 Send the list of currently known users in a response body.
 448 .TP
 449 .B version
 450 Send back a response with the server version as the second field.
 451 .TP
 452 .B volume \fR[\fILEFT\fR [\fIRIGHT\fR]]
 453 Get or set the volume.
 454 .IP
 455 With zero parameters just gets the volume and reports the left and right sides
 456 as the 2nd and 3rd fields of the response.
 457 .IP
 458 With one parameter sets both sides to the same value.
 459 With two parameters sets each side independently.
 460 Setting the volume requires the \fBvolume\fR right.
 461 .SH RESPONSES
 462 Responses are three-digit codes.
 463 The first digit distinguishes errors from succesful responses:
 464 .TP
 465 .B 2
 466 Operation succeeded.
 467 .TP
 468 .B 5
 469 Operation failed.
 470 .PP
 471 The second digit breaks down the origin of the response:
 472 .TP
 473 .B 0
 474 Generic responses not specific to the handling of the command.
 475 Mostly this is parse errors.
 476 .TP
 477 .B 1
 478 51x errors indicate that the user had insufficient rights for the command.
 479 .TP
 480 .B 3
 481 Authentication responses.
 482 .TP
 483 .B 5
 484 Responses specific to the handling of the command.
 485 .PP
 486 The third digit provides extra information about the response:
 487 .TP
 488 .B 0
 489 Text part is just commentary.
 490 .TP
 491 .B 1
 492 Text part is a constant result e.g. \fBversion\fR.
 493 .TP
 494 .B 2
 495 Text part is a potentially variable result.
 496 .TP
 497 .B 3
 498 Text part is just commentary; a dot-stuffed body follows.
 499 .TP
 500 .B 4
 501 Text part is just commentary; an indefinite dot-stuffed body follows.
 502 (Used for \fBlog\fR.)
 503 .TP
 504 .B 5
 505 Used with "normal" errors, for instance a preference not being found.
 506 The text part is commentary.
 507 .TP
 508 .B 9
 509 The text part is just commentary (but would normally be a response for this
 510 command) e.g. \fBplaying\fR.
 511 .PP
 512 Result strings (not bodies) intended for machine parsing (i.e. xx1 and xx2
 513 responses) are quoted.
 514 .SH AUTHENTICATION
 515 When a connection is made the server sends a \fB231\fR response before any
 516 command is received.
 517 This contains a protocol generation, an algorithm name and a
 518 challenge encoded in hex, all separated by whitespace.
 519 .PP
 520 The current protocol generation is \fB2\fR.
 521 .PP
 522 The possible algorithms are (currently) \fBsha1\fR, \fBsha256\fR, \fBsha384\fR
 523 and \fBsha512\fR.
 524 \fBSHA1\fR etc work as synonyms.
 525 .PP
 526 The \fBuser\fR response consists of the selected hash of the user's password
 527 concatenated with the challenge, encoded in hex.
 528 .SH "TRACK INFORMATION"
 529 Track information is encoded in a line (i.e. using the usual line syntax) as
 530 pairs of fields.
 531 The first is a name, the second a value.
 532 The names have the following meanings:
 533 .TP 12
 534 .B expected
 535 The time the track is expected to be played at.
 536 .TP
 537 .B id
 538 A string uniquely identifying this queue entry.
 539 .TP
 540 .B played
 541 The time the track was played at.
 542 .TP
 543 .B scratched
 544 The user that scratched the track.
 545 .TP
 546 .B origin
 547 The origin of the track.  Valid origins are:
 548 .RS
 549 .TP 12
 550 .B adopted
 551 The track was originally randomly picked but has been adopted by a user.
 552 .TP
 553 .B picked
 554 The track was picked by a user.
 555 .TP
 556 .B random
 557 The track was randomly picked.
 558 .TP
 559 .B scheduled
 560 The track was played from a scheduled action.
 561 .TP
 562 .B scratch
 563 The track is a scratch sound.
 564 .RE
 565 .TP
 566 .B state
 567 The current track state.
 568 Valid states are:
 569 .RS
 570 .TP 12
 571 .B failed
 572 The player failed (exited with nonzero status but wasn't scratched).
 573 .TP
 574 .B ok
 575 The track was played without any problems.
 576 .TP
 577 .B scratched
 578 The track was scratched.
 579 .TP
 580 .B started
 581 The track is currently playing.
 582 .TP
 583 .B paused
 584 Track is playing but paused.
 585 .TP
 586 .B unplayed
 587 In the queue, hasn't been played yet.
 588 .TP
 589 .B quitting
 590 The track was terminated because the server is shutting down.
 591 .RE
 592 .TP
 593 .B submitter
 594 The user that submitted the track.
 595 .TP
 596 .B track
 597 The filename of the track.
 598 .TP
 599 .B when
 600 The time the track was added to the queue.
 601 .TP
 602 .B wstat
 603 The wait status of the player in decimal.
 604 .PP
 605 Note that \fBorigin\fR is new with DisOrder 4.3, and obsoletes some old
 606 \fBstate\fR values.
 607 .SH NOTES
 608 Times are decimal integers using the server's \fBtime_t\fR.
 609 .PP
 610 For file listings, the regexp applies to the basename of the returned file, not
 611 the whole filename, and letter case is ignored.
 612 \fBpcrepattern\fR(3) describes the regexp syntax.
 613 .PP
 614 Filenames are in UTF-8 even if the collection they come from uses some other
 615 encoding - if you want to access the real file (in such cases as the filenames
 616 actually correspond to a real file) you'll have to convert to whatever the
 617 right encoding is.
 618 .SH "EVENT LOG"
 619 The event log consists of lines starting with a hexadecimal timestamp and a
 620 keyword followed by (optionally) parameters.
 621 The parameters are quoted in the usual DisOrder way.
 622 Currently the following keywords are used:
 623 .TP
 624 .B adopted \fIID\fR \fIUSERNAME\fR
 625 \fIUSERNAME\fR adopted track \fIID\fR.
 626 .TP
 627 .B completed \fITRACK\fR
 628 Completed playing \fITRACK\fR
 629 .TP
 630 .B failed \fITRACK\fR \fIERROR\fR
 631 Completed playing \fITRACK\fR with an error status
 632 .TP
 633 .B moved \fIUSERNAME\fR
 634 User \fIUSERNAME\fR moved some track(s).
 635 Further details aren't included any more.
 636 .TP
 637 .B playing \fITRACK\fR [\fIUSERNAME\fR]
 638 Started playing \fITRACK\fR.
 639 .TP
 640 .B playlist_created \fIPLAYLIST\fR \fISHARING\fR
 641 Sent when a playlist is created.
 642 For private playlists this is intended to be sent only to the owner (but
 643 this is not currently implemented).
 644 .TP
 645 .B playlist_deleted \fIPLAYLIST\fR
 646 Sent when a playlist is deleted.
 647 For private playlists this is intended to be sent only to the owner (but
 648 this is not currently implemented).
 649 .TP
 650 .B playlist_modified \fIPLAYLIST\fR \fISHARING\fR
 651 Sent when a playlist is modified (either its contents or its sharing status).
 652 For private playlists this is intended to be sent only to the owner (but
 653 this is not currently implemented).
 654 .TP
 655 .B queue \fIQUEUE-ENTRY\fR...
 656 Added \fITRACK\fR to the queue.
 657 .TP
 658 .B recent_added \fIQUEUE-ENTRY\fR...
 659 Added \fIID\fR to the recently played list.
 660 .TP
 661 .B recent_removed \fIID\fR
 662 Removed \fIID\fR from the recently played list.
 663 .TP
 664 .B removed \fIID\fR [\fIUSERNAME\fR]
 665 Queue entry \fIID\fR was removed.
 666 This is used both for explicit removal (when \fIUSERNAME\fR is present)
 667 and when playing a track (when it is absent).
 668 .TP
 669 .B rescanned
 670 A rescan completed.
 671 .TP
 672 .B scratched \fITRACK\fR \fIUSERNAME\fR
 673 \fITRACK\fR was scratched by \fIUSERNAME\fR.
 674 .TP
 675 .B state \fIKEYWORD\fR
 676 Some state change occurred.
 677 The current set of keywords is:
 678 .RS
 679 .TP
 680 .B completed
 681 The current track completed successfully.
 682 .TP
 683 .B disable_play
 684 Playing was disabled.
 685 .TP
 686 .B disable_random
 687 Random play was disabled.
 688 .TP
 689 .B enable_play
 690 Playing was enabled.
 691 .TP
 692 .B enable_random
 693 Random play was enabled.
 694 .TP
 695 .B failed
 696 The current track failed.
 697 .TP
 698 .B pause
 699 The current track was paused.
 700 .TP
 701 .B playing
 702 A track started playing.
 703 .TP
 704 .B resume
 705 The current track was resumed.
 706 .TP
 707 .B rights_changed \fIRIGHTS\fR
 708 User's rights were changed.
 709 .TP
 710 .B scratched
 711 The current track was scratched.
 712 .PP
 713 To simplify client implementation, \fBstate\fR commands reflecting the current
 714 state are sent at the start of the log.
 715 .RE
 716 .TP
 717 .B user_add \fIUSERNAME\fR
 718 A user was created.
 719 .TP
 720 .B user_delete \fIUSERNAME\fR
 721 A user was deleted.
 722 .TP
 723 .B user_edit \fIUSERNAME\fR \fIPROPERTY\fR
 724 Some property of a user was edited.
 725 .TP
 726 .B user_confirm \fIUSERNAME\fR
 727 A user's login was confirmed (via the web interface).
 728 .TP
 729 .B volume \fILEFT\fR \fIRIGHT\fR
 730 The volume changed.
 731 .PP
 732 .IR QUEUE-ENTRY ...
 733 is as defined in
 734 .B "TRACK INFORMATION"
 735 above.
 736 .PP
 737 The \fBuser-*\fR messages are only sent to admin users, and are not sent over
 738 non-local connections unless \fBremote_userman\fR is enabled.
 739 .SH "CHARACTER ENCODING"
 740 All data sent by both server and client is encoded using UTF-8.
 741 Moreover it must be valid UTF-8, i.e. non-minimal sequences are not
 742 permitted, nor are surrogates, nor are code points outside the
 743 Unicode code space.
 744 .PP
 745 There are no particular normalization requirements on either side of the
 746 protocol.
 747 The server currently converts internally to NFC, the client must
 748 normalize the responses returned if it needs some normalized form for further
 749 processing.
 750 .PP
 751 The various characters which divide up lines may not be followed by combining
 752 characters.
 753 For instance all of the following are prohibited:
 754 .TP
 755 .B o
 756 LINE FEED followed by a combining character.
 757 For example the sequence LINE FEED, COMBINING GRAVE ACCENT is never permitted.
 758 .TP
 759 .B o
 760 APOSTROPHE or QUOTATION MARK followed by a combining character when used to
 761 delimit fields.
 762 For instance a line starting APOSTROPHE, COMBINING CEDILLA is prohibited.
 763 .IP
 764 Note that such sequences are not prohibited when the quote character cannot be
 765 interpreted as a field delimiter.
 766 For instance APOSTROPHE, REVERSE SOLIDUS, APOSTROPHE, COMBINING CEDILLA,
 767 APOSTROPHE would be permitted.
 768 .TP
 769 .B o
 770 REVERSE SOLIDUS (BACKSLASH) followed by a combining character in a quoted
 771 string when it is the first character of an escape sequence.
 772 For instance a line starting APOSTROPHE, REVERSE SOLIDUS, COMBINING TILDE
 773 is prohibited.
 774 .IP
 775 As above such sequences are not prohibited when the character is not being used
 776 to start an escape sequence.
 777 For instance APOSTROPHE, REVERSE SOLIDUS, REVERSE SOLIDS, COMBINING TILDE,
 778 APOSTROPHE is permitted.
 779 .TP
 780 .B o
 781 Any of the field-splitting whitespace characters followed by a combining
 782 character when not part of a quoted field.
 783 For instance a line starting COLON, SPACE, COMBINING CANDRABINDU is prohibited.
 784 .IP
 785 As above non-delimiter uses are fine.
 786 .TP
 787 .B o
 788 The FULL STOP characters used to quote or delimit a body.
 789 .PP
 790 Furthermore none of these characters are permitted to appear in the context of
 791 a canonical decomposition (i.e. they must still be present when converted to
 792 NFC).
 793 In practice however this is not an issue in Unicode 5.0.
 794 .PP
 795 These rules are consistent with the observation that the split() function is
 796 essentially a naive ASCII parser.
 797 The implication is not that these sequences never actually appear in
 798 the protocol, merely that the server is not required to honor them in
 799 any useful way nor be consistent between versions: in current
 800 versions the result will be lines and fields that start with combining
 801 characters and are not necessarily split where you expect, but future versions
 802 may remove them, reject them or ignore some or all of the delimiters that have
 803 following combining characters, and no notice will be given of any change.
 804 .SH "SEE ALSO"
 805 \fBdisorder\fR(1),
 806 \fBtime\fR(2),
 807 \fBdisorder\fR(3),
 808 \fBpcrepattern\fR(3)
 809 \fBdisorder_config\fR(5),
 810 \fBdisorderd\fR(8),
 811 \fButf8\fR(7)
 812 .\" Local Variables:
 813 .\" mode:nroff
 814 .\" fill-column:79
 815 .\" End: