2 * This file is part of DisOrder.
3 * Copyright (C) 2010 Richard Kettlewell
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.
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.
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/>.
18 #ifndef CLIENT_STUBS_H
19 #define CLIENT_STUBS_H
21 /** @brief Adopt a track
23 * Makes the calling user owner of a randomly picked track.
26 * @return 0 on success, non-0 on error
28 int disorder_adopt(disorder_client *c, const char *id);
30 /** @brief Create a user
32 * Create a new user. Requires the 'admin' right. Email addresses etc must be filled in in separate commands.
34 * @param user New username
35 * @param password Initial password
36 * @param rights Initial rights (optional)
37 * @return 0 on success, non-0 on error
39 int disorder_adduser(disorder_client *c, const char *user, const char *password, const char *rights);
41 /** @brief List files and directories in a directory
43 * See 'files' and 'dirs' for more specific lists.
45 * @param dir Directory to list (optional)
46 * @param re Regexp that results must match (optional)
47 * @param filesp List of matching files and directories
48 * @param nfilesp Number of elements in filesp
49 * @return 0 on success, non-0 on error
51 int disorder_allfiles(disorder_client *c, const char *dir, const char *re, char ***filesp, int *nfilesp);
53 /** @brief Confirm registration
55 * The confirmation string must have been created with 'register'. The username is returned so the caller knows who they are.
57 * @param confirmation Confirmation string
58 * @return 0 on success, non-0 on error
60 int disorder_confirm(disorder_client *c, const char *confirmation);
61 /** @brief Log in with a cookie
63 * The cookie must have been created with 'make-cookie'. The username is returned so the caller knows who they are.
65 * @param cookie Cookie string
66 * @return 0 on success, non-0 on error
68 int disorder_cookie(disorder_client *c, const char *cookie);
69 /** @brief Delete user
71 * Requires the 'admin' right.
73 * @param user User to delete
74 * @return 0 on success, non-0 on error
76 int disorder_deluser(disorder_client *c, const char *user);
78 /** @brief List directories in a directory
82 * @param dir Directory to list (optional)
83 * @param re Regexp that results must match (optional)
84 * @param filesp List of matching directories
85 * @param nfilesp Number of elements in filesp
86 * @return 0 on success, non-0 on error
88 int disorder_dirs(disorder_client *c, const char *dir, const char *re, char ***filesp, int *nfilesp);
90 /** @brief Disable play
92 * Play will stop at the end of the current track, if one is playing. Requires the 'global prefs' right.
94 * @return 0 on success, non-0 on error
96 int disorder_disable(disorder_client *c);
98 /** @brief Set a user property
100 * With the 'admin' right you can do anything. Otherwise you need the 'userinfo' right and can only set 'email' and 'password'.
102 * @param username User to modify
103 * @param property Property name
104 * @param value New property value
105 * @return 0 on success, non-0 on error
107 int disorder_edituser(disorder_client *c, const char *username, const char *property, const char *value);
109 /** @brief Enable play
111 * Requires the 'global prefs' right.
113 * @return 0 on success, non-0 on error
115 int disorder_enable(disorder_client *c);
117 /** @brief Detect whether play is enabled
121 * @param enabledp 1 if play is enabled and 0 otherwise
122 * @return 0 on success, non-0 on error
124 int disorder_enabled(disorder_client *c, int *enabledp);
126 /** @brief Test whether a track exists
130 * @param track Track name
131 * @param existsp 1 if the track exists and 0 otherwise
132 * @return 0 on success, non-0 on error
134 int disorder_exists(disorder_client *c, const char *track, int *existsp);
136 /** @brief List files in a directory
140 * @param dir Directory to list (optional)
141 * @param re Regexp that results must match (optional)
142 * @param filesp List of matching files
143 * @param nfilesp Number of elements in filesp
144 * @return 0 on success, non-0 on error
146 int disorder_files(disorder_client *c, const char *dir, const char *re, char ***filesp, int *nfilesp);
148 /** @brief Get a track preference
150 * 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.
152 * @param track Track name
153 * @param pref Preference name
154 * @param valuep Preference value
155 * @return 0 on success, non-0 on error
157 int disorder_get(disorder_client *c, const char *track, const char *pref, char **valuep);
159 /** @brief Get a global preference
161 * If the preference does exist not then a null value is returned.
163 * @param pref Global preference name
164 * @param valuep Preference value
165 * @return 0 on success, non-0 on error
167 int disorder_get_global(disorder_client *c, const char *pref, char **valuep);
169 /** @brief Create a login cookie for this user
171 * The cookie may be redeemed via the 'cookie' command
173 * @param cookiep Newly created cookie
174 * @return 0 on success, non-0 on error
176 int disorder_make_cookie(disorder_client *c, char **cookiep);
178 /** @brief Do nothing
180 * Used as a keepalive. No authentication required.
182 * @return 0 on success, non-0 on error
184 int disorder_nop(disorder_client *c);
186 /** @brief Get a track name part
188 * If the name part cannot be constructed an empty string is returned.
190 * @param track Track name
191 * @param context Context ("sort" or "display")
192 * @param part Name part ("artist", "album" or "title")
193 * @param partp Value of name part
194 * @return 0 on success, non-0 on error
196 int disorder_part(disorder_client *c, const char *track, const char *context, const char *part, char **partp);
198 /** @brief Pause the currently playing track
200 * Requires the 'pause' right.
202 * @return 0 on success, non-0 on error
204 int disorder_pause(disorder_client *c);
206 /** @brief Play a track
208 * Requires the 'play' right.
210 * @param track Track to play
211 * @param idp Queue ID of new track
212 * @return 0 on success, non-0 on error
214 int disorder_play(disorder_client *c, const char *track, char **idp);
216 /** @brief Delete a playlist
218 * Requires the 'play' right and permission to modify the playlist.
220 * @param playlist Playlist to delete
221 * @return 0 on success, non-0 on error
223 int disorder_playlist_delete(disorder_client *c, const char *playlist);
225 /** @brief List the contents of a playlist
227 * Requires the 'read' right and oermission to read the playlist.
229 * @param playlist Playlist name
230 * @param tracksp List of tracks in playlist
231 * @param ntracksp Number of elements in tracksp
232 * @return 0 on success, non-0 on error
234 int disorder_playlist_get(disorder_client *c, const char *playlist, char ***tracksp, int *ntracksp);
236 /** @brief Get a playlist's sharing status
238 * Requires the 'read' right and permission to read the playlist.
240 * @param playlist Playlist to read
241 * @param sharep Sharing status ("public", "private" or "shared")
242 * @return 0 on success, non-0 on error
244 int disorder_playlist_get_share(disorder_client *c, const char *playlist, char **sharep);
246 /** @brief Lock a playlist
248 * Requires the 'play' right and permission to modify the playlist. A given connection may lock at most one playlist.
250 * @param playlist Playlist to delete
251 * @return 0 on success, non-0 on error
253 int disorder_playlist_lock(disorder_client *c, const char *playlist);
255 /** @brief Set a playlist's sharing status
257 * Requires the 'play' right and permission to modify the playlist.
259 * @param playlist Playlist to modify
260 * @param share New sharing status ("public", "private" or "shared")
261 * @return 0 on success, non-0 on error
263 int disorder_playlist_set_share(disorder_client *c, const char *playlist, const char *share);
265 /** @brief Unlock the locked playlist playlist
267 * The playlist to unlock is implicit in the connection.
269 * @return 0 on success, non-0 on error
271 int disorder_playlist_unlock(disorder_client *c);
273 /** @brief List playlists
275 * Requires the 'read' right. Only playlists that you have permission to read are returned.
277 * @param playlistsp Playlist names
278 * @param nplaylistsp Number of elements in playlistsp
279 * @return 0 on success, non-0 on error
281 int disorder_playlists(disorder_client *c, char ***playlistsp, int *nplaylistsp);
283 /** @brief Disable random play
285 * Requires the 'global prefs' right.
287 * @return 0 on success, non-0 on error
289 int disorder_random_disable(disorder_client *c);
291 /** @brief Enable random play
293 * Requires the 'global prefs' right.
295 * @return 0 on success, non-0 on error
297 int disorder_random_enable(disorder_client *c);
299 /** @brief Detect whether random play is enabled
301 * Random play counts as enabled even if play is disabled.
303 * @param enabledp 1 if random play is enabled and 0 otherwise
304 * @return 0 on success, non-0 on error
306 int disorder_random_enabled(disorder_client *c, int *enabledp);
308 /** @brief Re-read configuraiton file.
310 * Requires the 'admin' right.
312 * @return 0 on success, non-0 on error
314 int disorder_reconfigure(disorder_client *c);
316 /** @brief Register a new user
318 * Requires the 'register' right which is usually only available to the 'guest' user. Redeem the confirmation string via 'confirm' to complete registration.
320 * @param username Requested new username
321 * @param password Requested initial password
322 * @param email New user's email address
323 * @param confirmationp Confirmation string
324 * @return 0 on success, non-0 on error
326 int disorder_register(disorder_client *c, const char *username, const char *password, const char *email, char **confirmationp);
328 /** @brief Send a password reminder.
330 * 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.
332 * @param username User to remind
333 * @return 0 on success, non-0 on error
335 int disorder_reminder(disorder_client *c, const char *username);
337 /** @brief Remove a track form the queue.
339 * Requires one of the 'remove mine', 'remove random' or 'remove any' rights depending on how the track came to be added to the queue.
342 * @return 0 on success, non-0 on error
344 int disorder_remove(disorder_client *c, const char *id);
346 /** @brief Rescan all collections for new or obsolete tracks.
348 * Requires the 'rescan' right.
350 * @return 0 on success, non-0 on error
352 int disorder_rescan(disorder_client *c);
354 /** @brief Resolve a track name
356 * Converts aliases to non-alias track names
358 * @param track Track name (might be an alias)
359 * @param resolvedp Resolve track name (definitely not an alias)
360 * @return 0 on success, non-0 on error
362 int disorder_resolve(disorder_client *c, const char *track, char **resolvedp);
364 /** @brief Resume the currently playing track
366 * Requires the 'pause' right.
368 * @return 0 on success, non-0 on error
370 int disorder_resume(disorder_client *c);
372 /** @brief Revoke a cookie.
374 * It will not subsequently be possible to log in with the cookie.
376 * @return 0 on success, non-0 on error
378 int disorder_revoke(disorder_client *c);
380 /** @brief Terminate the playing track.
382 * Requires one of the 'scratch mine', 'scratch random' or 'scratch any' rights depending on how the track came to be added to the queue.
384 * @param id Track ID (optional)
385 * @return 0 on success, non-0 on error
387 int disorder_scratch(disorder_client *c, const char *id);
389 /** @brief Delete a scheduled event.
391 * Users can always delete their own scheduled events; with the admin right you can delete any event.
393 * @param event ID of event to delete
394 * @return 0 on success, non-0 on error
396 int disorder_schedule_del(disorder_client *c, const char *event);
398 /** @brief List scheduled events
400 * This just lists IDs. Use 'schedule-get' to retrieve more detail
402 * @param idsp List of event IDs
403 * @param nidsp Number of elements in idsp
404 * @return 0 on success, non-0 on error
406 int disorder_schedule_list(disorder_client *c, char ***idsp, int *nidsp);
408 /** @brief Search for tracks
410 * Terms are either keywords or tags formatted as 'tag:TAG-NAME'.
412 * @param terms List of search terms
413 * @param tracksp List of matching tracks
414 * @param ntracksp Number of elements in tracksp
415 * @return 0 on success, non-0 on error
417 int disorder_search(disorder_client *c, const char *terms, char ***tracksp, int *ntracksp);
419 /** @brief Set a track preference
421 * Requires the 'prefs' right.
423 * @param track Track name
424 * @param pref Preference name
425 * @param value New value
426 * @return 0 on success, non-0 on error
428 int disorder_set(disorder_client *c, const char *track, const char *pref, const char *value);
430 /** @brief Set a global preference
432 * Requires the 'global prefs' right.
434 * @param pref Preference name
435 * @param value New value
436 * @return 0 on success, non-0 on error
438 int disorder_set_global(disorder_client *c, const char *pref, const char *value);
440 /** @brief Request server shutdown
442 * Requires the 'admin' right.
444 * @return 0 on success, non-0 on error
446 int disorder_shutdown(disorder_client *c);
448 /** @brief Get server statistics
450 * The details of what the server reports are not really defined. The returned strings are intended to be printed out one to a line..
452 * @param statsp List of server information strings.
453 * @param nstatsp Number of elements in statsp
454 * @return 0 on success, non-0 on error
456 int disorder_stats(disorder_client *c, char ***statsp, int *nstatsp);
458 /** @brief Get a list of known tags
460 * Only tags which apply to at least one track are returned.
462 * @param tagsp List of tags
463 * @param ntagsp Number of elements in tagsp
464 * @return 0 on success, non-0 on error
466 int disorder_tags(disorder_client *c, char ***tagsp, int *ntagsp);
468 /** @brief Unset a track preference
470 * Requires the 'prefs' right.
472 * @param track Track name
473 * @param pref Preference name
474 * @return 0 on success, non-0 on error
476 int disorder_unset(disorder_client *c, const char *track, const char *pref);
478 /** @brief Set a global preference
480 * Requires the 'global prefs' right.
482 * @param pref Preference name
483 * @return 0 on success, non-0 on error
485 int disorder_unset_global(disorder_client *c, const char *pref);
487 /** @brief Get a user property.
489 * 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.
491 * @param username User to read
492 * @param property Property to read
493 * @param valuep Value of property
494 * @return 0 on success, non-0 on error
496 int disorder_userinfo(disorder_client *c, const char *username, const char *property, char **valuep);
498 /** @brief Get a list of users
502 * @param usersp List of users
503 * @param nusersp Number of elements in usersp
504 * @return 0 on success, non-0 on error
506 int disorder_users(disorder_client *c, char ***usersp, int *nusersp);
508 /** @brief Get the server version
512 * @param versionp Server version string
513 * @return 0 on success, non-0 on error
515 int disorder_version(disorder_client *c, char **versionp);