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