Commit | Line | Data |
---|---|---|
7788b7c7 RK |
1 | /* |
2 | * This file is part of DisOrder. | |
3 | * Copyright (C) 2010 Richard Kettlewell | |
4 | * | |
5 | * This program is free software: you can redistribute it and/or modify | |
6 | * it under the terms of the GNU General Public License as published by | |
7 | * the Free Software Foundation, either version 3 of the License, or | |
8 | * (at your option) any later version. | |
9 | * | |
10 | * This program is distributed in the hope that it will be useful, | |
11 | * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
12 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
13 | * GNU General Public License for more details. | |
14 | * | |
15 | * You should have received a copy of the GNU General Public License | |
16 | * along with this program. If not, see <http://www.gnu.org/licenses/>. | |
17 | */ | |
18 | #ifndef CLIENT_STUBS_H | |
19 | #define CLIENT_STUBS_H | |
20 | ||
21 | /** @brief Adopt a track | |
22 | * | |
23 | * Makes the calling user owner of a randomly picked track. | |
24 | * | |
08af2413 | 25 | * @param c Client |
7788b7c7 RK |
26 | * @param id Track ID |
27 | * @return 0 on success, non-0 on error | |
28 | */ | |
29 | int disorder_adopt(disorder_client *c, const char *id); | |
30 | ||
31 | /** @brief Create a user | |
32 | * | |
33 | * Create a new user. Requires the 'admin' right. Email addresses etc must be filled in in separate commands. | |
34 | * | |
08af2413 | 35 | * @param c Client |
7788b7c7 RK |
36 | * @param user New username |
37 | * @param password Initial password | |
38 | * @param rights Initial rights (optional) | |
39 | * @return 0 on success, non-0 on error | |
40 | */ | |
41 | int disorder_adduser(disorder_client *c, const char *user, const char *password, const char *rights); | |
42 | ||
3680ef53 RK |
43 | /** @brief List files and directories in a directory |
44 | * | |
45 | * See 'files' and 'dirs' for more specific lists. | |
46 | * | |
08af2413 | 47 | * @param c Client |
3680ef53 RK |
48 | * @param dir Directory to list (optional) |
49 | * @param re Regexp that results must match (optional) | |
50 | * @param filesp List of matching files and directories | |
51 | * @param nfilesp Number of elements in filesp | |
52 | * @return 0 on success, non-0 on error | |
53 | */ | |
54 | int disorder_allfiles(disorder_client *c, const char *dir, const char *re, char ***filesp, int *nfilesp); | |
55 | ||
7788b7c7 RK |
56 | /** @brief Confirm registration |
57 | * | |
58 | * The confirmation string must have been created with 'register'. The username is returned so the caller knows who they are. | |
59 | * | |
f4522fa7 | 60 | * @param c Client |
7788b7c7 RK |
61 | * @param confirmation Confirmation string |
62 | * @return 0 on success, non-0 on error | |
63 | */ | |
64 | int disorder_confirm(disorder_client *c, const char *confirmation); | |
f4522fa7 | 65 | |
7788b7c7 RK |
66 | /** @brief Log in with a cookie |
67 | * | |
68 | * The cookie must have been created with 'make-cookie'. The username is returned so the caller knows who they are. | |
69 | * | |
f4522fa7 | 70 | * @param c Client |
7788b7c7 RK |
71 | * @param cookie Cookie string |
72 | * @return 0 on success, non-0 on error | |
73 | */ | |
74 | int disorder_cookie(disorder_client *c, const char *cookie); | |
f4522fa7 | 75 | |
7788b7c7 RK |
76 | /** @brief Delete user |
77 | * | |
78 | * Requires the 'admin' right. | |
79 | * | |
08af2413 | 80 | * @param c Client |
7788b7c7 RK |
81 | * @param user User to delete |
82 | * @return 0 on success, non-0 on error | |
83 | */ | |
84 | int disorder_deluser(disorder_client *c, const char *user); | |
85 | ||
3680ef53 RK |
86 | /** @brief List directories in a directory |
87 | * | |
88 | * | |
89 | * | |
08af2413 | 90 | * @param c Client |
3680ef53 RK |
91 | * @param dir Directory to list (optional) |
92 | * @param re Regexp that results must match (optional) | |
93 | * @param filesp List of matching directories | |
94 | * @param nfilesp Number of elements in filesp | |
95 | * @return 0 on success, non-0 on error | |
96 | */ | |
97 | int disorder_dirs(disorder_client *c, const char *dir, const char *re, char ***filesp, int *nfilesp); | |
98 | ||
7788b7c7 RK |
99 | /** @brief Disable play |
100 | * | |
101 | * Play will stop at the end of the current track, if one is playing. Requires the 'global prefs' right. | |
102 | * | |
08af2413 | 103 | * @param c Client |
7788b7c7 RK |
104 | * @return 0 on success, non-0 on error |
105 | */ | |
106 | int disorder_disable(disorder_client *c); | |
107 | ||
108 | /** @brief Set a user property | |
109 | * | |
110 | * With the 'admin' right you can do anything. Otherwise you need the 'userinfo' right and can only set 'email' and 'password'. | |
111 | * | |
08af2413 | 112 | * @param c Client |
7788b7c7 RK |
113 | * @param username User to modify |
114 | * @param property Property name | |
115 | * @param value New property value | |
116 | * @return 0 on success, non-0 on error | |
117 | */ | |
118 | int disorder_edituser(disorder_client *c, const char *username, const char *property, const char *value); | |
119 | ||
120 | /** @brief Enable play | |
121 | * | |
122 | * Requires the 'global prefs' right. | |
123 | * | |
08af2413 | 124 | * @param c Client |
7788b7c7 RK |
125 | * @return 0 on success, non-0 on error |
126 | */ | |
127 | int disorder_enable(disorder_client *c); | |
128 | ||
129 | /** @brief Detect whether play is enabled | |
130 | * | |
131 | * | |
132 | * | |
08af2413 | 133 | * @param c Client |
7788b7c7 RK |
134 | * @param enabledp 1 if play is enabled and 0 otherwise |
135 | * @return 0 on success, non-0 on error | |
136 | */ | |
137 | int disorder_enabled(disorder_client *c, int *enabledp); | |
138 | ||
139 | /** @brief Test whether a track exists | |
140 | * | |
141 | * | |
142 | * | |
08af2413 | 143 | * @param c Client |
7788b7c7 RK |
144 | * @param track Track name |
145 | * @param existsp 1 if the track exists and 0 otherwise | |
146 | * @return 0 on success, non-0 on error | |
147 | */ | |
148 | int disorder_exists(disorder_client *c, const char *track, int *existsp); | |
149 | ||
3680ef53 RK |
150 | /** @brief List files in a directory |
151 | * | |
152 | * | |
153 | * | |
08af2413 | 154 | * @param c Client |
3680ef53 RK |
155 | * @param dir Directory to list (optional) |
156 | * @param re Regexp that results must match (optional) | |
157 | * @param filesp List of matching files | |
158 | * @param nfilesp Number of elements in filesp | |
159 | * @return 0 on success, non-0 on error | |
160 | */ | |
161 | int disorder_files(disorder_client *c, const char *dir, const char *re, char ***filesp, int *nfilesp); | |
162 | ||
7788b7c7 RK |
163 | /** @brief Get a track preference |
164 | * | |
165 | * If the track does not exist that is an error. If the track exists but the preference does not then a null value is returned. | |
166 | * | |
08af2413 | 167 | * @param c Client |
7788b7c7 RK |
168 | * @param track Track name |
169 | * @param pref Preference name | |
170 | * @param valuep Preference value | |
171 | * @return 0 on success, non-0 on error | |
172 | */ | |
173 | int disorder_get(disorder_client *c, const char *track, const char *pref, char **valuep); | |
174 | ||
175 | /** @brief Get a global preference | |
176 | * | |
177 | * If the preference does exist not then a null value is returned. | |
178 | * | |
08af2413 | 179 | * @param c Client |
7788b7c7 RK |
180 | * @param pref Global preference name |
181 | * @param valuep Preference value | |
182 | * @return 0 on success, non-0 on error | |
183 | */ | |
184 | int disorder_get_global(disorder_client *c, const char *pref, char **valuep); | |
185 | ||
711a4497 RK |
186 | /** @brief Get a track's length |
187 | * | |
188 | * If the track does not exist an error is returned. | |
189 | * | |
08af2413 | 190 | * @param c Client |
711a4497 RK |
191 | * @param track Track name |
192 | * @param lengthp Track length in seconds | |
193 | * @return 0 on success, non-0 on error | |
194 | */ | |
195 | int disorder_length(disorder_client *c, const char *track, long *lengthp); | |
196 | ||
7788b7c7 RK |
197 | /** @brief Create a login cookie for this user |
198 | * | |
199 | * The cookie may be redeemed via the 'cookie' command | |
200 | * | |
08af2413 | 201 | * @param c Client |
7788b7c7 RK |
202 | * @param cookiep Newly created cookie |
203 | * @return 0 on success, non-0 on error | |
204 | */ | |
205 | int disorder_make_cookie(disorder_client *c, char **cookiep); | |
206 | ||
0bc1d67c RK |
207 | /** @brief Move a track |
208 | * | |
209 | * Requires one of the 'move mine', 'move random' or 'move any' rights depending on how the track came to be added to the queue. | |
210 | * | |
211 | * @param c Client | |
212 | * @param track Track ID or name | |
213 | * @param delta How far to move the track towards the head of the queue | |
214 | * @return 0 on success, non-0 on error | |
215 | */ | |
216 | int disorder_move(disorder_client *c, const char *track, long delta); | |
217 | ||
218 | /** @brief Move multiple tracks | |
219 | * | |
220 | * Requires one of the 'move mine', 'move random' or 'move any' rights depending on how the track came to be added to the queue. | |
221 | * | |
222 | * @param c Client | |
223 | * @param target Move after this track, or to head if "" | |
224 | * @param ids List of tracks to move by ID | |
225 | * @param nids Length of ids | |
226 | * @return 0 on success, non-0 on error | |
227 | */ | |
228 | int disorder_moveafter(disorder_client *c, const char *target, char **ids, int nids); | |
229 | ||
7788b7c7 RK |
230 | /** @brief Do nothing |
231 | * | |
232 | * Used as a keepalive. No authentication required. | |
233 | * | |
08af2413 | 234 | * @param c Client |
7788b7c7 RK |
235 | * @return 0 on success, non-0 on error |
236 | */ | |
237 | int disorder_nop(disorder_client *c); | |
238 | ||
239 | /** @brief Get a track name part | |
240 | * | |
241 | * If the name part cannot be constructed an empty string is returned. | |
242 | * | |
08af2413 | 243 | * @param c Client |
7788b7c7 RK |
244 | * @param track Track name |
245 | * @param context Context ("sort" or "display") | |
246 | * @param part Name part ("artist", "album" or "title") | |
247 | * @param partp Value of name part | |
248 | * @return 0 on success, non-0 on error | |
249 | */ | |
250 | int disorder_part(disorder_client *c, const char *track, const char *context, const char *part, char **partp); | |
251 | ||
252 | /** @brief Pause the currently playing track | |
253 | * | |
254 | * Requires the 'pause' right. | |
255 | * | |
08af2413 | 256 | * @param c Client |
7788b7c7 RK |
257 | * @return 0 on success, non-0 on error |
258 | */ | |
259 | int disorder_pause(disorder_client *c); | |
260 | ||
00861dcb RK |
261 | /** @brief Play a track |
262 | * | |
263 | * Requires the 'play' right. | |
264 | * | |
08af2413 | 265 | * @param c Client |
00861dcb RK |
266 | * @param track Track to play |
267 | * @param idp Queue ID of new track | |
268 | * @return 0 on success, non-0 on error | |
269 | */ | |
270 | int disorder_play(disorder_client *c, const char *track, char **idp); | |
271 | ||
0bc1d67c RK |
272 | /** @brief Play multiple tracks |
273 | * | |
274 | * Requires the 'play' right. | |
275 | * | |
276 | * @param c Client | |
277 | * @param target Insert into queue after this track, or at head if "" | |
278 | * @param tracks List of track names to play | |
279 | * @param ntracks Length of tracks | |
280 | * @return 0 on success, non-0 on error | |
281 | */ | |
282 | int disorder_playafter(disorder_client *c, const char *target, char **tracks, int ntracks); | |
283 | ||
ec9c0462 RK |
284 | /** @brief Retrieve the playing track |
285 | * | |
286 | * | |
287 | * | |
288 | * @param c Client | |
289 | * @param playingp Details of the playing track | |
290 | * @return 0 on success, non-0 on error | |
291 | */ | |
292 | int disorder_playing(disorder_client *c, struct queue_entry **playingp); | |
293 | ||
7788b7c7 RK |
294 | /** @brief Delete a playlist |
295 | * | |
296 | * Requires the 'play' right and permission to modify the playlist. | |
297 | * | |
08af2413 | 298 | * @param c Client |
7788b7c7 RK |
299 | * @param playlist Playlist to delete |
300 | * @return 0 on success, non-0 on error | |
301 | */ | |
302 | int disorder_playlist_delete(disorder_client *c, const char *playlist); | |
303 | ||
3680ef53 | 304 | /** @brief List the contents of a playlist |
7788b7c7 | 305 | * |
3680ef53 | 306 | * Requires the 'read' right and oermission to read the playlist. |
7788b7c7 | 307 | * |
08af2413 | 308 | * @param c Client |
3680ef53 RK |
309 | * @param playlist Playlist name |
310 | * @param tracksp List of tracks in playlist | |
311 | * @param ntracksp Number of elements in tracksp | |
7788b7c7 RK |
312 | * @return 0 on success, non-0 on error |
313 | */ | |
3680ef53 | 314 | int disorder_playlist_get(disorder_client *c, const char *playlist, char ***tracksp, int *ntracksp); |
7788b7c7 RK |
315 | |
316 | /** @brief Get a playlist's sharing status | |
317 | * | |
318 | * Requires the 'read' right and permission to read the playlist. | |
319 | * | |
08af2413 | 320 | * @param c Client |
7788b7c7 RK |
321 | * @param playlist Playlist to read |
322 | * @param sharep Sharing status ("public", "private" or "shared") | |
323 | * @return 0 on success, non-0 on error | |
324 | */ | |
325 | int disorder_playlist_get_share(disorder_client *c, const char *playlist, char **sharep); | |
326 | ||
3680ef53 RK |
327 | /** @brief Lock a playlist |
328 | * | |
329 | * Requires the 'play' right and permission to modify the playlist. A given connection may lock at most one playlist. | |
330 | * | |
08af2413 | 331 | * @param c Client |
3680ef53 RK |
332 | * @param playlist Playlist to delete |
333 | * @return 0 on success, non-0 on error | |
334 | */ | |
335 | int disorder_playlist_lock(disorder_client *c, const char *playlist); | |
336 | ||
08af2413 RK |
337 | /** @brief Set the contents of a playlist |
338 | * | |
339 | * Requires the 'play' right and permission to modify the playlist, which must be locked. | |
340 | * | |
341 | * @param c Client | |
342 | * @param playlist Playlist to modify | |
343 | * @param tracks New list of tracks for playlist | |
344 | * @param ntracks Length of tracks | |
345 | * @return 0 on success, non-0 on error | |
346 | */ | |
347 | int disorder_playlist_set(disorder_client *c, const char *playlist, char **tracks, int ntracks); | |
348 | ||
7788b7c7 RK |
349 | /** @brief Set a playlist's sharing status |
350 | * | |
351 | * Requires the 'play' right and permission to modify the playlist. | |
352 | * | |
08af2413 | 353 | * @param c Client |
7788b7c7 RK |
354 | * @param playlist Playlist to modify |
355 | * @param share New sharing status ("public", "private" or "shared") | |
356 | * @return 0 on success, non-0 on error | |
357 | */ | |
358 | int disorder_playlist_set_share(disorder_client *c, const char *playlist, const char *share); | |
359 | ||
360 | /** @brief Unlock the locked playlist playlist | |
361 | * | |
362 | * The playlist to unlock is implicit in the connection. | |
363 | * | |
08af2413 | 364 | * @param c Client |
7788b7c7 RK |
365 | * @return 0 on success, non-0 on error |
366 | */ | |
367 | int disorder_playlist_unlock(disorder_client *c); | |
368 | ||
3680ef53 RK |
369 | /** @brief List playlists |
370 | * | |
371 | * Requires the 'read' right. Only playlists that you have permission to read are returned. | |
372 | * | |
08af2413 | 373 | * @param c Client |
3680ef53 RK |
374 | * @param playlistsp Playlist names |
375 | * @param nplaylistsp Number of elements in playlistsp | |
376 | * @return 0 on success, non-0 on error | |
377 | */ | |
378 | int disorder_playlists(disorder_client *c, char ***playlistsp, int *nplaylistsp); | |
379 | ||
5dc19ffd RK |
380 | /** @brief Get all the preferences for a track |
381 | * | |
382 | * | |
383 | * | |
384 | * @param c Client | |
385 | * @param track Track name | |
386 | * @param prefsp Track preferences | |
387 | * @return 0 on success, non-0 on error | |
388 | */ | |
389 | int disorder_prefs(disorder_client *c, const char *track, struct kvp **prefsp); | |
390 | ||
08af2413 RK |
391 | /** @brief List the queue |
392 | * | |
393 | * | |
394 | * | |
395 | * @param c Client | |
396 | * @param queuep Current queue contents | |
397 | * @return 0 on success, non-0 on error | |
398 | */ | |
399 | int disorder_queue(disorder_client *c, struct queue_entry **queuep); | |
400 | ||
7788b7c7 RK |
401 | /** @brief Disable random play |
402 | * | |
403 | * Requires the 'global prefs' right. | |
404 | * | |
08af2413 | 405 | * @param c Client |
7788b7c7 RK |
406 | * @return 0 on success, non-0 on error |
407 | */ | |
408 | int disorder_random_disable(disorder_client *c); | |
409 | ||
410 | /** @brief Enable random play | |
411 | * | |
412 | * Requires the 'global prefs' right. | |
413 | * | |
08af2413 | 414 | * @param c Client |
7788b7c7 RK |
415 | * @return 0 on success, non-0 on error |
416 | */ | |
417 | int disorder_random_enable(disorder_client *c); | |
418 | ||
419 | /** @brief Detect whether random play is enabled | |
420 | * | |
421 | * Random play counts as enabled even if play is disabled. | |
422 | * | |
08af2413 | 423 | * @param c Client |
7788b7c7 RK |
424 | * @param enabledp 1 if random play is enabled and 0 otherwise |
425 | * @return 0 on success, non-0 on error | |
426 | */ | |
427 | int disorder_random_enabled(disorder_client *c, int *enabledp); | |
428 | ||
08af2413 RK |
429 | /** @brief List recently played tracks |
430 | * | |
431 | * | |
432 | * | |
433 | * @param c Client | |
434 | * @param recentp Recently played tracks | |
435 | * @return 0 on success, non-0 on error | |
436 | */ | |
437 | int disorder_recent(disorder_client *c, struct queue_entry **recentp); | |
438 | ||
7788b7c7 RK |
439 | /** @brief Re-read configuraiton file. |
440 | * | |
441 | * Requires the 'admin' right. | |
442 | * | |
08af2413 | 443 | * @param c Client |
7788b7c7 RK |
444 | * @return 0 on success, non-0 on error |
445 | */ | |
446 | int disorder_reconfigure(disorder_client *c); | |
447 | ||
448 | /** @brief Register a new user | |
449 | * | |
450 | * Requires the 'register' right which is usually only available to the 'guest' user. Redeem the confirmation string via 'confirm' to complete registration. | |
451 | * | |
08af2413 | 452 | * @param c Client |
7788b7c7 RK |
453 | * @param username Requested new username |
454 | * @param password Requested initial password | |
455 | * @param email New user's email address | |
456 | * @param confirmationp Confirmation string | |
457 | * @return 0 on success, non-0 on error | |
458 | */ | |
459 | int disorder_register(disorder_client *c, const char *username, const char *password, const char *email, char **confirmationp); | |
460 | ||
461 | /** @brief Send a password reminder. | |
462 | * | |
463 | * If the user has no valid email address, or no password, or a reminder has been sent too recently, then no reminder will be sent. | |
464 | * | |
08af2413 | 465 | * @param c Client |
7788b7c7 RK |
466 | * @param username User to remind |
467 | * @return 0 on success, non-0 on error | |
468 | */ | |
469 | int disorder_reminder(disorder_client *c, const char *username); | |
470 | ||
471 | /** @brief Remove a track form the queue. | |
472 | * | |
473 | * Requires one of the 'remove mine', 'remove random' or 'remove any' rights depending on how the track came to be added to the queue. | |
474 | * | |
08af2413 | 475 | * @param c Client |
7788b7c7 RK |
476 | * @param id Track ID |
477 | * @return 0 on success, non-0 on error | |
478 | */ | |
479 | int disorder_remove(disorder_client *c, const char *id); | |
480 | ||
481 | /** @brief Rescan all collections for new or obsolete tracks. | |
482 | * | |
483 | * Requires the 'rescan' right. | |
484 | * | |
08af2413 | 485 | * @param c Client |
7788b7c7 RK |
486 | * @return 0 on success, non-0 on error |
487 | */ | |
488 | int disorder_rescan(disorder_client *c); | |
489 | ||
490 | /** @brief Resolve a track name | |
491 | * | |
492 | * Converts aliases to non-alias track names | |
493 | * | |
08af2413 | 494 | * @param c Client |
7788b7c7 RK |
495 | * @param track Track name (might be an alias) |
496 | * @param resolvedp Resolve track name (definitely not an alias) | |
497 | * @return 0 on success, non-0 on error | |
498 | */ | |
499 | int disorder_resolve(disorder_client *c, const char *track, char **resolvedp); | |
500 | ||
501 | /** @brief Resume the currently playing track | |
502 | * | |
503 | * Requires the 'pause' right. | |
504 | * | |
08af2413 | 505 | * @param c Client |
7788b7c7 RK |
506 | * @return 0 on success, non-0 on error |
507 | */ | |
508 | int disorder_resume(disorder_client *c); | |
509 | ||
510 | /** @brief Revoke a cookie. | |
511 | * | |
512 | * It will not subsequently be possible to log in with the cookie. | |
513 | * | |
08af2413 | 514 | * @param c Client |
7788b7c7 RK |
515 | * @return 0 on success, non-0 on error |
516 | */ | |
517 | int disorder_revoke(disorder_client *c); | |
518 | ||
519 | /** @brief Terminate the playing track. | |
520 | * | |
521 | * Requires one of the 'scratch mine', 'scratch random' or 'scratch any' rights depending on how the track came to be added to the queue. | |
522 | * | |
08af2413 | 523 | * @param c Client |
7788b7c7 RK |
524 | * @param id Track ID (optional) |
525 | * @return 0 on success, non-0 on error | |
526 | */ | |
527 | int disorder_scratch(disorder_client *c, const char *id); | |
528 | ||
529 | /** @brief Delete a scheduled event. | |
530 | * | |
531 | * Users can always delete their own scheduled events; with the admin right you can delete any event. | |
532 | * | |
08af2413 | 533 | * @param c Client |
7788b7c7 RK |
534 | * @param event ID of event to delete |
535 | * @return 0 on success, non-0 on error | |
536 | */ | |
537 | int disorder_schedule_del(disorder_client *c, const char *event); | |
538 | ||
5dc19ffd RK |
539 | /** @brief Get the details of scheduled event |
540 | * | |
541 | * | |
542 | * | |
543 | * @param c Client | |
544 | * @param id Event ID | |
545 | * @param actiondatap Details of event | |
546 | * @return 0 on success, non-0 on error | |
547 | */ | |
548 | int disorder_schedule_get(disorder_client *c, const char *id, struct kvp **actiondatap); | |
549 | ||
3680ef53 RK |
550 | /** @brief List scheduled events |
551 | * | |
552 | * This just lists IDs. Use 'schedule-get' to retrieve more detail | |
553 | * | |
08af2413 | 554 | * @param c Client |
3680ef53 RK |
555 | * @param idsp List of event IDs |
556 | * @param nidsp Number of elements in idsp | |
557 | * @return 0 on success, non-0 on error | |
558 | */ | |
559 | int disorder_schedule_list(disorder_client *c, char ***idsp, int *nidsp); | |
560 | ||
561 | /** @brief Search for tracks | |
562 | * | |
563 | * Terms are either keywords or tags formatted as 'tag:TAG-NAME'. | |
564 | * | |
08af2413 | 565 | * @param c Client |
3680ef53 RK |
566 | * @param terms List of search terms |
567 | * @param tracksp List of matching tracks | |
568 | * @param ntracksp Number of elements in tracksp | |
569 | * @return 0 on success, non-0 on error | |
570 | */ | |
571 | int disorder_search(disorder_client *c, const char *terms, char ***tracksp, int *ntracksp); | |
572 | ||
7788b7c7 RK |
573 | /** @brief Set a track preference |
574 | * | |
575 | * Requires the 'prefs' right. | |
576 | * | |
08af2413 | 577 | * @param c Client |
7788b7c7 RK |
578 | * @param track Track name |
579 | * @param pref Preference name | |
580 | * @param value New value | |
581 | * @return 0 on success, non-0 on error | |
582 | */ | |
583 | int disorder_set(disorder_client *c, const char *track, const char *pref, const char *value); | |
584 | ||
585 | /** @brief Set a global preference | |
586 | * | |
587 | * Requires the 'global prefs' right. | |
588 | * | |
08af2413 | 589 | * @param c Client |
7788b7c7 RK |
590 | * @param pref Preference name |
591 | * @param value New value | |
592 | * @return 0 on success, non-0 on error | |
593 | */ | |
594 | int disorder_set_global(disorder_client *c, const char *pref, const char *value); | |
595 | ||
eea34c08 RK |
596 | /** @brief Request server shutdown |
597 | * | |
598 | * Requires the 'admin' right. | |
599 | * | |
08af2413 | 600 | * @param c Client |
eea34c08 RK |
601 | * @return 0 on success, non-0 on error |
602 | */ | |
603 | int disorder_shutdown(disorder_client *c); | |
604 | ||
3680ef53 RK |
605 | /** @brief Get server statistics |
606 | * | |
607 | * The details of what the server reports are not really defined. The returned strings are intended to be printed out one to a line.. | |
608 | * | |
08af2413 | 609 | * @param c Client |
3680ef53 RK |
610 | * @param statsp List of server information strings. |
611 | * @param nstatsp Number of elements in statsp | |
612 | * @return 0 on success, non-0 on error | |
613 | */ | |
614 | int disorder_stats(disorder_client *c, char ***statsp, int *nstatsp); | |
615 | ||
616 | /** @brief Get a list of known tags | |
617 | * | |
618 | * Only tags which apply to at least one track are returned. | |
619 | * | |
08af2413 | 620 | * @param c Client |
3680ef53 RK |
621 | * @param tagsp List of tags |
622 | * @param ntagsp Number of elements in tagsp | |
623 | * @return 0 on success, non-0 on error | |
624 | */ | |
625 | int disorder_tags(disorder_client *c, char ***tagsp, int *ntagsp); | |
626 | ||
7788b7c7 RK |
627 | /** @brief Unset a track preference |
628 | * | |
629 | * Requires the 'prefs' right. | |
630 | * | |
08af2413 | 631 | * @param c Client |
7788b7c7 RK |
632 | * @param track Track name |
633 | * @param pref Preference name | |
634 | * @return 0 on success, non-0 on error | |
635 | */ | |
636 | int disorder_unset(disorder_client *c, const char *track, const char *pref); | |
637 | ||
638 | /** @brief Set a global preference | |
639 | * | |
640 | * Requires the 'global prefs' right. | |
641 | * | |
08af2413 | 642 | * @param c Client |
7788b7c7 RK |
643 | * @param pref Preference name |
644 | * @return 0 on success, non-0 on error | |
645 | */ | |
646 | int disorder_unset_global(disorder_client *c, const char *pref); | |
647 | ||
648 | /** @brief Get a user property. | |
649 | * | |
650 | * If the user does not exist an error is returned, if the user exists but the property does not then a null value is returned. | |
651 | * | |
08af2413 | 652 | * @param c Client |
7788b7c7 RK |
653 | * @param username User to read |
654 | * @param property Property to read | |
655 | * @param valuep Value of property | |
656 | * @return 0 on success, non-0 on error | |
657 | */ | |
658 | int disorder_userinfo(disorder_client *c, const char *username, const char *property, char **valuep); | |
659 | ||
3680ef53 RK |
660 | /** @brief Get a list of users |
661 | * | |
662 | * | |
663 | * | |
08af2413 | 664 | * @param c Client |
3680ef53 RK |
665 | * @param usersp List of users |
666 | * @param nusersp Number of elements in usersp | |
667 | * @return 0 on success, non-0 on error | |
668 | */ | |
669 | int disorder_users(disorder_client *c, char ***usersp, int *nusersp); | |
670 | ||
7788b7c7 RK |
671 | /** @brief Get the server version |
672 | * | |
673 | * | |
674 | * | |
08af2413 | 675 | * @param c Client |
7788b7c7 RK |
676 | * @param versionp Server version string |
677 | * @return 0 on success, non-0 on error | |
678 | */ | |
679 | int disorder_version(disorder_client *c, char **versionp); | |
680 | ||
681 | #endif |