mdw@git.distorted.org.uk Git - disorder/blob - lib/client-stubs.h

   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  *
  25  * @param id Track ID
  26  * @return 0 on success, non-0 on error
  27  */
  28 int disorder_adopt(disorder_client *c, const char *id);
  29
  30 /** @brief Create a user
  31  *
  32  * Create a new user.  Requires the 'admin' right.  Email addresses etc must be filled in in separate commands.
  33  *
  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
  38  */
  39 int disorder_adduser(disorder_client *c, const char *user, const char *password, const char *rights);
  40
  41 /** @brief List files and directories in a directory
  42  *
  43  * See 'files' and 'dirs' for more specific lists.
  44  *
  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
  50  */
  51 int disorder_allfiles(disorder_client *c, const char *dir, const char *re, char ***filesp, int *nfilesp);
  52
  53 /** @brief Confirm registration
  54  *
  55  * The confirmation string must have been created with 'register'.  The username is returned so the caller knows who they are.
  56  *
  57  * @param confirmation Confirmation string
  58  * @return 0 on success, non-0 on error
  59  */
  60 int disorder_confirm(disorder_client *c, const char *confirmation);
  61 /** @brief Log in with a cookie
  62  *
  63  * The cookie must have been created with 'make-cookie'.  The username is returned so the caller knows who they are.
  64  *
  65  * @param cookie Cookie string
  66  * @return 0 on success, non-0 on error
  67  */
  68 int disorder_cookie(disorder_client *c, const char *cookie);
  69 /** @brief Delete user
  70  *
  71  * Requires the 'admin' right.
  72  *
  73  * @param user User to delete
  74  * @return 0 on success, non-0 on error
  75  */
  76 int disorder_deluser(disorder_client *c, const char *user);
  77
  78 /** @brief List directories in a directory
  79  *
  80  *
  81  *
  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
  87  */
  88 int disorder_dirs(disorder_client *c, const char *dir, const char *re, char ***filesp, int *nfilesp);
  89
  90 /** @brief Disable play
  91  *
  92  * Play will stop at the end of the current track, if one is playing.  Requires the 'global prefs' right.
  93  *
  94  * @return 0 on success, non-0 on error
  95  */
  96 int disorder_disable(disorder_client *c);
  97
  98 /** @brief Set a user property
  99  *
 100  * With the 'admin' right you can do anything.  Otherwise you need the 'userinfo' right and can only set 'email' and 'password'.
 101  *
 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
 106  */
 107 int disorder_edituser(disorder_client *c, const char *username, const char *property, const char *value);
 108
 109 /** @brief Enable play
 110  *
 111  * Requires the 'global prefs' right.
 112  *
 113  * @return 0 on success, non-0 on error
 114  */
 115 int disorder_enable(disorder_client *c);
 116
 117 /** @brief Detect whether play is enabled
 118  *
 119  *
 120  *
 121  * @param enabledp 1 if play is enabled and 0 otherwise
 122  * @return 0 on success, non-0 on error
 123  */
 124 int disorder_enabled(disorder_client *c, int *enabledp);
 125
 126 /** @brief Test whether a track exists
 127  *
 128  *
 129  *
 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
 133  */
 134 int disorder_exists(disorder_client *c, const char *track, int *existsp);
 135
 136 /** @brief List files in a directory
 137  *
 138  *
 139  *
 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
 145  */
 146 int disorder_files(disorder_client *c, const char *dir, const char *re, char ***filesp, int *nfilesp);
 147
 148 /** @brief Get a track preference
 149  *
 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.
 151  *
 152  * @param track Track name
 153  * @param pref Preference name
 154  * @param valuep Preference value
 155  * @return 0 on success, non-0 on error
 156  */
 157 int disorder_get(disorder_client *c, const char *track, const char *pref, char **valuep);
 158
 159 /** @brief Get a global preference
 160  *
 161  * If the preference does exist not then a null value is returned.
 162  *
 163  * @param pref Global preference name
 164  * @param valuep Preference value
 165  * @return 0 on success, non-0 on error
 166  */
 167 int disorder_get_global(disorder_client *c, const char *pref, char **valuep);
 168
 169 /** @brief Create a login cookie for this user
 170  *
 171  * The cookie may be redeemed via the 'cookie' command
 172  *
 173  * @param cookiep Newly created cookie
 174  * @return 0 on success, non-0 on error
 175  */
 176 int disorder_make_cookie(disorder_client *c, char **cookiep);
 177
 178 /** @brief Do nothing
 179  *
 180  * Used as a keepalive.  No authentication required.
 181  *
 182  * @return 0 on success, non-0 on error
 183  */
 184 int disorder_nop(disorder_client *c);
 185
 186 /** @brief Get a track name part
 187  *
 188  * If the name part cannot be constructed an empty string is returned.
 189  *
 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
 195  */
 196 int disorder_part(disorder_client *c, const char *track, const char *context, const char *part, char **partp);
 197
 198 /** @brief Pause the currently playing track
 199  *
 200  * Requires the 'pause' right.
 201  *
 202  * @return 0 on success, non-0 on error
 203  */
 204 int disorder_pause(disorder_client *c);
 205
 206 /** @brief Play a track
 207  *
 208  * Requires the 'play' right.
 209  *
 210  * @param track Track to play
 211  * @param idp Queue ID of new track
 212  * @return 0 on success, non-0 on error
 213  */
 214 int disorder_play(disorder_client *c, const char *track, char **idp);
 215
 216 /** @brief Delete a playlist
 217  *
 218  * Requires the 'play' right and permission to modify the playlist.
 219  *
 220  * @param playlist Playlist to delete
 221  * @return 0 on success, non-0 on error
 222  */
 223 int disorder_playlist_delete(disorder_client *c, const char *playlist);
 224
 225 /** @brief List the contents of a playlist
 226  *
 227  * Requires the 'read' right and oermission to read the playlist.
 228  *
 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
 233  */
 234 int disorder_playlist_get(disorder_client *c, const char *playlist, char ***tracksp, int *ntracksp);
 235
 236 /** @brief Get a playlist's sharing status
 237  *
 238  * Requires the 'read' right and permission to read the playlist.
 239  *
 240  * @param playlist Playlist to read
 241  * @param sharep Sharing status ("public", "private" or "shared")
 242  * @return 0 on success, non-0 on error
 243  */
 244 int disorder_playlist_get_share(disorder_client *c, const char *playlist, char **sharep);
 245
 246 /** @brief Lock a playlist
 247  *
 248  * Requires the 'play' right and permission to modify the playlist.  A given connection may lock at most one playlist.
 249  *
 250  * @param playlist Playlist to delete
 251  * @return 0 on success, non-0 on error
 252  */
 253 int disorder_playlist_lock(disorder_client *c, const char *playlist);
 254
 255 /** @brief Set a playlist's sharing status
 256  *
 257  * Requires the 'play' right and permission to modify the playlist.
 258  *
 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
 262  */
 263 int disorder_playlist_set_share(disorder_client *c, const char *playlist, const char *share);
 264
 265 /** @brief Unlock the locked playlist playlist
 266  *
 267  * The playlist to unlock is implicit in the connection.
 268  *
 269  * @return 0 on success, non-0 on error
 270  */
 271 int disorder_playlist_unlock(disorder_client *c);
 272
 273 /** @brief List playlists
 274  *
 275  * Requires the 'read' right.  Only playlists that you have permission to read are returned.
 276  *
 277  * @param playlistsp Playlist names
 278  * @param nplaylistsp Number of elements in playlistsp
 279  * @return 0 on success, non-0 on error
 280  */
 281 int disorder_playlists(disorder_client *c, char ***playlistsp, int *nplaylistsp);
 282
 283 /** @brief Disable random play
 284  *
 285  * Requires the 'global prefs' right.
 286  *
 287  * @return 0 on success, non-0 on error
 288  */
 289 int disorder_random_disable(disorder_client *c);
 290
 291 /** @brief Enable random play
 292  *
 293  * Requires the 'global prefs' right.
 294  *
 295  * @return 0 on success, non-0 on error
 296  */
 297 int disorder_random_enable(disorder_client *c);
 298
 299 /** @brief Detect whether random play is enabled
 300  *
 301  * Random play counts as enabled even if play is disabled.
 302  *
 303  * @param enabledp 1 if random play is enabled and 0 otherwise
 304  * @return 0 on success, non-0 on error
 305  */
 306 int disorder_random_enabled(disorder_client *c, int *enabledp);
 307
 308 /** @brief Re-read configuraiton file.
 309  *
 310  * Requires the 'admin' right.
 311  *
 312  * @return 0 on success, non-0 on error
 313  */
 314 int disorder_reconfigure(disorder_client *c);
 315
 316 /** @brief Register a new user
 317  *
 318  * Requires the 'register' right which is usually only available to the 'guest' user.  Redeem the confirmation string via 'confirm' to complete registration.
 319  *
 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
 325  */
 326 int disorder_register(disorder_client *c, const char *username, const char *password, const char *email, char **confirmationp);
 327
 328 /** @brief Send a password reminder.
 329  *
 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.
 331  *
 332  * @param username User to remind
 333  * @return 0 on success, non-0 on error
 334  */
 335 int disorder_reminder(disorder_client *c, const char *username);
 336
 337 /** @brief Remove a track form the queue.
 338  *
 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.
 340  *
 341  * @param id Track ID
 342  * @return 0 on success, non-0 on error
 343  */
 344 int disorder_remove(disorder_client *c, const char *id);
 345
 346 /** @brief Rescan all collections for new or obsolete tracks.
 347  *
 348  * Requires the 'rescan' right.
 349  *
 350  * @return 0 on success, non-0 on error
 351  */
 352 int disorder_rescan(disorder_client *c);
 353
 354 /** @brief Resolve a track name
 355  *
 356  * Converts aliases to non-alias track names
 357  *
 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
 361  */
 362 int disorder_resolve(disorder_client *c, const char *track, char **resolvedp);
 363
 364 /** @brief Resume the currently playing track
 365  *
 366  * Requires the 'pause' right.
 367  *
 368  * @return 0 on success, non-0 on error
 369  */
 370 int disorder_resume(disorder_client *c);
 371
 372 /** @brief Revoke a cookie.
 373  *
 374  * It will not subsequently be possible to log in with the cookie.
 375  *
 376  * @return 0 on success, non-0 on error
 377  */
 378 int disorder_revoke(disorder_client *c);
 379
 380 /** @brief Terminate the playing track.
 381  *
 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.
 383  *
 384  * @param id Track ID (optional)
 385  * @return 0 on success, non-0 on error
 386  */
 387 int disorder_scratch(disorder_client *c, const char *id);
 388
 389 /** @brief Delete a scheduled event.
 390  *
 391  * Users can always delete their own scheduled events; with the admin right you can delete any event.
 392  *
 393  * @param event ID of event to delete
 394  * @return 0 on success, non-0 on error
 395  */
 396 int disorder_schedule_del(disorder_client *c, const char *event);
 397
 398 /** @brief List scheduled events
 399  *
 400  * This just lists IDs.  Use 'schedule-get' to retrieve more detail
 401  *
 402  * @param idsp List of event IDs
 403  * @param nidsp Number of elements in idsp
 404  * @return 0 on success, non-0 on error
 405  */
 406 int disorder_schedule_list(disorder_client *c, char ***idsp, int *nidsp);
 407
 408 /** @brief Search for tracks
 409  *
 410  * Terms are either keywords or tags formatted as 'tag:TAG-NAME'.
 411  *
 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
 416  */
 417 int disorder_search(disorder_client *c, const char *terms, char ***tracksp, int *ntracksp);
 418
 419 /** @brief Set a track preference
 420  *
 421  * Requires the 'prefs' right.
 422  *
 423  * @param track Track name
 424  * @param pref Preference name
 425  * @param value New value
 426  * @return 0 on success, non-0 on error
 427  */
 428 int disorder_set(disorder_client *c, const char *track, const char *pref, const char *value);
 429
 430 /** @brief Set a global preference
 431  *
 432  * Requires the 'global prefs' right.
 433  *
 434  * @param pref Preference name
 435  * @param value New value
 436  * @return 0 on success, non-0 on error
 437  */
 438 int disorder_set_global(disorder_client *c, const char *pref, const char *value);
 439
 440 /** @brief Request server shutdown
 441  *
 442  * Requires the 'admin' right.
 443  *
 444  * @return 0 on success, non-0 on error
 445  */
 446 int disorder_shutdown(disorder_client *c);
 447
 448 /** @brief Get server statistics
 449  *
 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..
 451  *
 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
 455  */
 456 int disorder_stats(disorder_client *c, char ***statsp, int *nstatsp);
 457
 458 /** @brief Get a list of known tags
 459  *
 460  * Only tags which apply to at least one track are returned.
 461  *
 462  * @param tagsp List of tags
 463  * @param ntagsp Number of elements in tagsp
 464  * @return 0 on success, non-0 on error
 465  */
 466 int disorder_tags(disorder_client *c, char ***tagsp, int *ntagsp);
 467
 468 /** @brief Unset a track preference
 469  *
 470  * Requires the 'prefs' right.
 471  *
 472  * @param track Track name
 473  * @param pref Preference name
 474  * @return 0 on success, non-0 on error
 475  */
 476 int disorder_unset(disorder_client *c, const char *track, const char *pref);
 477
 478 /** @brief Set a global preference
 479  *
 480  * Requires the 'global prefs' right.
 481  *
 482  * @param pref Preference name
 483  * @return 0 on success, non-0 on error
 484  */
 485 int disorder_unset_global(disorder_client *c, const char *pref);
 486
 487 /** @brief Get a user property.
 488  *
 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.
 490  *
 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
 495  */
 496 int disorder_userinfo(disorder_client *c, const char *username, const char *property, char **valuep);
 497
 498 /** @brief Get a list of users
 499  *
 500  *
 501  *
 502  * @param usersp List of users
 503  * @param nusersp Number of elements in usersp
 504  * @return 0 on success, non-0 on error
 505  */
 506 int disorder_users(disorder_client *c, char ***usersp, int *nusersp);
 507
 508 /** @brief Get the server version
 509  *
 510  *
 511  *
 512  * @param versionp Server version string
 513  * @return 0 on success, non-0 on error
 514  */
 515 int disorder_version(disorder_client *c, char **versionp);
 516
 517 #endif