X-Git-Url: https://git.distorted.org.uk/~mdw/disorder/blobdiff_plain/9e89d26a8e1378f17a19da072c5f7308ddaf24f1..08af2413287bc5f665b8c337a4be6763600c3dd2:/lib/client.c diff --git a/lib/client.c b/lib/client.c index 2cbcfa7..acd20eb 100644 --- a/lib/client.c +++ b/lib/client.c @@ -151,12 +151,13 @@ static int check_response(disorder_client *c, char **rp) { } } +/** @brief Marker for a command body */ +static const char disorder_body[1]; + /** @brief Issue a command and parse a simple response * @param c Client * @param rp Where to store result, or NULL * @param cmd Command - * @param body Body or NULL - * @param nbody Length of body or -1 * @param ap Arguments (UTF-8), terminated by (char *)0 * @return 0 on success, non-0 on error * @@ -168,22 +169,23 @@ static int check_response(disorder_client *c, char **rp) { * NB that the response will NOT be converted to the local encoding * nor will quotes be stripped. See dequote(). * - * If @p body is not NULL then the body is sent immediately after the - * command. @p nbody should be the number of lines or @c -1 to count - * them if @p body is NULL-terminated. + * Put @ref disorder_body in the argument list followed by a char ** + * and int giving the body to follow the command. If the int is @c -1 + * then the list is assumed to be NULL-terminated. * * Usually you would call this via one of the following interfaces: * - disorder_simple() - * - disorder_simple_body() * - disorder_simple_list() */ static int disorder_simple_v(disorder_client *c, char **rp, const char *cmd, - char **body, int nbody, va_list ap) { const char *arg; struct dynstr d; + char **body = NULL; + int nbody = 0; + int has_body = 0; if(!c->fpout) { c->last = "not connected"; @@ -194,8 +196,14 @@ static int disorder_simple_v(disorder_client *c, dynstr_init(&d); dynstr_append_string(&d, cmd); while((arg = va_arg(ap, const char *))) { - dynstr_append(&d, ' '); - dynstr_append_string(&d, quoteutf8(arg)); + if(arg == disorder_body) { + body = va_arg(ap, char **); + nbody = va_arg(ap, int); + has_body = 1; + } else { + dynstr_append(&d, ' '); + dynstr_append_string(&d, quoteutf8(arg)); + } } dynstr_append(&d, '\n'); dynstr_terminate(&d); @@ -203,7 +211,7 @@ static int disorder_simple_v(disorder_client *c, if(fputs(d.vec, c->fpout) < 0) goto write_error; xfree(d.vec); - if(body) { + if(has_body) { if(nbody < 0) for(nbody = 0; body[nbody]; ++nbody) ; @@ -253,30 +261,7 @@ static int disorder_simple(disorder_client *c, int ret; va_start(ap, cmd); - ret = disorder_simple_v(c, rp, cmd, 0, 0, ap); - va_end(ap); - return ret; -} - -/** @brief Issue a command with a body and parse a simple response - * @param c Client - * @param rp Where to store result, or NULL (UTF-8) - * @param body Pointer to body - * @param nbody Size of body - * @param cmd Command - * @return 0 on success, non-0 on error - * - * See disorder_simple(). - */ -static int disorder_simple_body(disorder_client *c, - char **rp, - char **body, int nbody, - const char *cmd, ...) { - va_list ap; - int ret; - - va_start(ap, cmd); - ret = disorder_simple_v(c, rp, cmd, body, nbody, ap); + ret = disorder_simple_v(c, rp, cmd, ap); va_end(ap); return ret; } @@ -522,24 +507,6 @@ int disorder_close(disorder_client *c) { return ret; } -/** @brief Play a track - * @param c Client - * @param track Track to play (UTF-8) - * @return 0 on success, non-0 on error - */ -int disorder_play(disorder_client *c, const char *track) { - return disorder_simple(c, 0, "play", track, (char *)0); -} - -/** @brief Remove a track - * @param c Client - * @param track Track to remove (UTF-8) - * @return 0 on success, non-0 on error - */ -int disorder_remove(disorder_client *c, const char *track) { - return disorder_simple(c, 0, "remove", track, (char *)0); -} - /** @brief Move a track * @param c Client * @param track Track to move (UTF-8) @@ -553,64 +520,6 @@ int disorder_move(disorder_client *c, const char *track, int delta) { return disorder_simple(c, 0, "move", track, d, (char *)0); } -/** @brief Enable play - * @param c Client - * @return 0 on success, non-0 on error - */ -int disorder_enable(disorder_client *c) { - return disorder_simple(c, 0, "enable", (char *)0); -} - -/** @brief Disable play - * @param c Client - * @return 0 on success, non-0 on error - */ -int disorder_disable(disorder_client *c) { - return disorder_simple(c, 0, "disable", (char *)0); -} - -/** @brief Scratch the currently playing track - * @param id Playing track ID or NULL (UTF-8) - * @param c Client - * @return 0 on success, non-0 on error - */ -int disorder_scratch(disorder_client *c, const char *id) { - return disorder_simple(c, 0, "scratch", id, (char *)0); -} - -/** @brief Shut down the server - * @param c Client - * @return 0 on success, non-0 on error - */ -int disorder_shutdown(disorder_client *c) { - return disorder_simple(c, 0, "shutdown", (char *)0); -} - -/** @brief Make the server re-read its configuration - * @param c Client - * @return 0 on success, non-0 on error - */ -int disorder_reconfigure(disorder_client *c) { - return disorder_simple(c, 0, "reconfigure", (char *)0); -} - -/** @brief Rescan tracks - * @param c Client - * @return 0 on success, non-0 on error - */ -int disorder_rescan(disorder_client *c) { - return disorder_simple(c, 0, "rescan", (char *)0); -} - -/** @brief Get server version number - * @param c Client - * @param rp Where to store version string (UTF-8) - * @return 0 on success, non-0 on error - */ -int disorder_version(disorder_client *c, char **rp) { - return dequote(disorder_simple(c, rp, "version", (char *)0), rp); -} - static void client_error(const char *msg, void attribute((unused)) *u) { disorder_error(0, "error parsing reply: %s", msg); @@ -673,28 +582,6 @@ static int disorder_somequeue(disorder_client *c, return -1; } -/** @brief Get recently played tracks - * @param c Client - * @param qp Where to store track information - * @return 0 on success, non-0 on error - * - * The last entry in the list is the most recently played track. - */ -int disorder_recent(disorder_client *c, struct queue_entry **qp) { - return disorder_somequeue(c, "recent", qp); -} - -/** @brief Get queue - * @param c Client - * @param qp Where to store track information - * @return 0 on success, non-0 on error - * - * The first entry in the list will be played next. - */ -int disorder_queue(disorder_client *c, struct queue_entry **qp) { - return disorder_somequeue(c, "queue", qp); -} - /** @brief Read a dot-stuffed list * @param c Client * @param vecp Where to store list (UTF-8) @@ -751,51 +638,12 @@ static int disorder_simple_list(disorder_client *c, int ret; va_start(ap, cmd); - ret = disorder_simple_v(c, 0, cmd, 0, 0, ap); + ret = disorder_simple_v(c, 0, cmd, ap); va_end(ap); if(ret) return ret; return readlist(c, vecp, nvecp); } -/** @brief List directories below @p dir - * @param c Client - * @param dir Directory to list, or NULL for root (UTF-8) - * @param re Regexp that results must match, or NULL (UTF-8) - * @param vecp Where to store list (UTF-8) - * @param nvecp Where to store number of items, or NULL - * @return 0 on success, non-0 on error - */ -int disorder_directories(disorder_client *c, const char *dir, const char *re, - char ***vecp, int *nvecp) { - return disorder_simple_list(c, vecp, nvecp, "dirs", dir, re, (char *)0); -} - -/** @brief List files below @p dir - * @param c Client - * @param dir Directory to list, or NULL for root (UTF-8) - * @param re Regexp that results must match, or NULL (UTF-8) - * @param vecp Where to store list (UTF-8) - * @param nvecp Where to store number of items, or NULL - * @return 0 on success, non-0 on error - */ -int disorder_files(disorder_client *c, const char *dir, const char *re, - char ***vecp, int *nvecp) { - return disorder_simple_list(c, vecp, nvecp, "files", dir, re, (char *)0); -} - -/** @brief List files and directories below @p dir - * @param c Client - * @param dir Directory to list, or NULL for root (UTF-8) - * @param re Regexp that results must match, or NULL (UTF-8) - * @param vecp Where to store list (UTF-8) - * @param nvecp Where to store number of items, or NULL - * @return 0 on success, non-0 on error - */ -int disorder_allfiles(disorder_client *c, const char *dir, const char *re, - char ***vecp, int *nvecp) { - return disorder_simple_list(c, vecp, nvecp, "allfiles", dir, re, (char *)0); -} - /** @brief Return the user we logged in with * @param c Client * @return User name (owned by @p c, don't modify) @@ -804,42 +652,6 @@ char *disorder_user(disorder_client *c) { return c->user; } -/** @brief Set a track preference - * @param c Client - * @param track Track name (UTF-8) - * @param key Preference name (UTF-8) - * @param value Preference value (UTF-8) - * @return 0 on success, non-0 on error - */ -int disorder_set(disorder_client *c, const char *track, - const char *key, const char *value) { - return disorder_simple(c, 0, "set", track, key, value, (char *)0); -} - -/** @brief Unset a track preference - * @param c Client - * @param track Track name (UTF-8) - * @param key Preference name (UTF-8) - * @return 0 on success, non-0 on error - */ -int disorder_unset(disorder_client *c, const char *track, - const char *key) { - return disorder_simple(c, 0, "unset", track, key, (char *)0); -} - -/** @brief Get a track preference - * @param c Client - * @param track Track name (UTF-8) - * @param key Preference name (UTF-8) - * @param valuep Where to store preference value (UTF-8) - * @return 0 on success, non-0 on error - */ -int disorder_get(disorder_client *c, - const char *track, const char *key, char **valuep) { - return dequote(disorder_simple(c, valuep, "get", track, key, (char *)0), - valuep); -} - static void pref_error_handler(const char *msg, void attribute((unused)) *u) { disorder_error(0, "error handling 'prefs' reply: %s", msg); @@ -893,107 +705,6 @@ static int boolean(const char *cmd, const char *value, return 0; } -/** @brief Test whether a track exists - * @param c Client - * @param track Track name (UTF-8) - * @param existsp Where to store result (non-0 iff does exist) - * @return 0 on success, non-0 on error - */ -int disorder_exists(disorder_client *c, const char *track, int *existsp) { - char *v; - int rc; - - if((rc = disorder_simple(c, &v, "exists", track, (char *)0))) - return rc; - return boolean("exists", v, existsp); -} - -/** @brief Test whether playing is enabled - * @param c Client - * @param enabledp Where to store result (non-0 iff enabled) - * @return 0 on success, non-0 on error - */ -int disorder_enabled(disorder_client *c, int *enabledp) { - char *v; - int rc; - - if((rc = disorder_simple(c, &v, "enabled", (char *)0))) - return rc; - return boolean("enabled", v, enabledp); -} - -/** @brief Get the length of a track - * @param c Client - * @param track Track name (UTF-8) - * @param valuep Where to store length in seconds - * @return 0 on success, non-0 on error - * - * If the length is unknown 0 is returned. - */ -int disorder_length(disorder_client *c, const char *track, - long *valuep) { - char *value; - int rc; - - if((rc = disorder_simple(c, &value, "length", track, (char *)0))) - return rc; - *valuep = atol(value); - return 0; -} - -/** @brief Search for tracks - * @param c Client - * @param terms Search terms (UTF-8) - * @param vecp Where to store list (UTF-8) - * @param nvecp Where to store number of items, or NULL - * @return 0 on success, non-0 on error - */ -int disorder_search(disorder_client *c, const char *terms, - char ***vecp, int *nvecp) { - return disorder_simple_list(c, vecp, nvecp, "search", terms, (char *)0); -} - -/** @brief Enable random play - * @param c Client - * @return 0 on success, non-0 on error - */ -int disorder_random_enable(disorder_client *c) { - return disorder_simple(c, 0, "random-enable", (char *)0); -} - -/** @brief Disable random play - * @param c Client - * @return 0 on success, non-0 on error - */ -int disorder_random_disable(disorder_client *c) { - return disorder_simple(c, 0, "random-disable", (char *)0); -} - -/** @brief Test whether random play is enabled - * @param c Client - * @param enabledp Where to store result (non-0 iff enabled) - * @return 0 on success, non-0 on error - */ -int disorder_random_enabled(disorder_client *c, int *enabledp) { - char *v; - int rc; - - if((rc = disorder_simple(c, &v, "random-enabled", (char *)0))) - return rc; - return boolean("random-enabled", v, enabledp); -} - -/** @brief Get server stats - * @param c Client - * @param vecp Where to store list (UTF-8) - * @param nvecp Where to store number of items, or NULL - * @return 0 on success, non-0 on error - */ -int disorder_stats(disorder_client *c, - char ***vecp, int *nvecp) { - return disorder_simple_list(c, vecp, nvecp, "stats", (char *)0); -} - /** @brief Set volume * @param c Client * @param left New left channel value @@ -1050,69 +761,6 @@ int disorder_log(disorder_client *c, struct sink *s) { return 0; } -/** @brief Look up a track name part - * @param c Client - * @param partp Where to store result (UTF-8) - * @param track Track name (UTF-8) - * @param context Context (usually "sort" or "display") (UTF-8) - * @param part Track part (UTF-8) - * @return 0 on success, non-0 on error - */ -int disorder_part(disorder_client *c, char **partp, - const char *track, const char *context, const char *part) { - return dequote(disorder_simple(c, partp, "part", - track, context, part, (char *)0), partp); -} - -/** @brief Resolve aliases - * @param c Client - * @param trackp Where to store canonical name (UTF-8) - * @param track Track name (UTF-8) - * @return 0 on success, non-0 on error - */ -int disorder_resolve(disorder_client *c, char **trackp, const char *track) { - return dequote(disorder_simple(c, trackp, "resolve", track, (char *)0), - trackp); -} - -/** @brief Pause the current track - * @param c Client - * @return 0 on success, non-0 on error - */ -int disorder_pause(disorder_client *c) { - return disorder_simple(c, 0, "pause", (char *)0); -} - -/** @brief Resume the current track - * @param c Client - * @return 0 on success, non-0 on error - */ -int disorder_resume(disorder_client *c) { - return disorder_simple(c, 0, "resume", (char *)0); -} - -/** @brief List all known tags - * @param c Client - * @param vecp Where to store list (UTF-8) - * @param nvecp Where to store number of items, or NULL - * @return 0 on success, non-0 on error - */ -int disorder_tags(disorder_client *c, - char ***vecp, int *nvecp) { - return disorder_simple_list(c, vecp, nvecp, "tags", (char *)0); -} - -/** @brief List all known users - * @param c Client - * @param vecp Where to store list (UTF-8) - * @param nvecp Where to store number of items, or NULL - * @return 0 on success, non-0 on error - */ -int disorder_users(disorder_client *c, - char ***vecp, int *nvecp) { - return disorder_simple_list(c, vecp, nvecp, "users", (char *)0); -} - /** @brief Get recently added tracks * @param c Client * @param vecp Where to store pointer to list (UTF-8) @@ -1129,37 +777,6 @@ int disorder_new_tracks(disorder_client *c, return disorder_simple_list(c, vecp, nvecp, "new", limit, (char *)0); } -/** @brief Set a global preference - * @param c Client - * @param key Preference name (UTF-8) - * @param value Preference value (UTF-8) - * @return 0 on success, non-0 on error - */ -int disorder_set_global(disorder_client *c, - const char *key, const char *value) { - return disorder_simple(c, 0, "set-global", key, value, (char *)0); -} - -/** @brief Unset a global preference - * @param c Client - * @param key Preference name (UTF-8) - * @return 0 on success, non-0 on error - */ -int disorder_unset_global(disorder_client *c, const char *key) { - return disorder_simple(c, 0, "unset-global", key, (char *)0); -} - -/** @brief Get a global preference - * @param c Client - * @param key Preference name (UTF-8) - * @param valuep Where to store preference value (UTF-8) - * @return 0 on success, non-0 on error - */ -int disorder_get_global(disorder_client *c, const char *key, char **valuep) { - return dequote(disorder_simple(c, valuep, "get-global", key, (char *)0), - valuep); -} - /** @brief Get server's RTP address information * @param c Client * @param addressp Where to store address (UTF-8) @@ -1184,130 +801,6 @@ int disorder_rtp_address(disorder_client *c, char **addressp, char **portp) { return 0; } -/** @brief Create a user - * @param c Client - * @param user Username - * @param password Password - * @param rights Initial rights or NULL to use default - * @return 0 on success, non-0 on error - */ -int disorder_adduser(disorder_client *c, - const char *user, const char *password, - const char *rights) { - return disorder_simple(c, 0, "adduser", user, password, rights, (char *)0); -} - -/** @brief Delete a user - * @param c Client - * @param user Username - * @return 0 on success, non-0 on error - */ -int disorder_deluser(disorder_client *c, const char *user) { - return disorder_simple(c, 0, "deluser", user, (char *)0); -} - -/** @brief Get user information - * @param c Client - * @param user Username - * @param key Property name (UTF-8) - * @param valuep Where to store value (UTF-8) - * @return 0 on success, non-0 on error - */ -int disorder_userinfo(disorder_client *c, const char *user, const char *key, - char **valuep) { - return dequote(disorder_simple(c, valuep, "userinfo", user, key, (char *)0), - valuep); -} - -/** @brief Set user information - * @param c Client - * @param user Username - * @param key Property name (UTF-8) - * @param value New property value (UTF-8) - * @return 0 on success, non-0 on error - */ -int disorder_edituser(disorder_client *c, const char *user, - const char *key, const char *value) { - return disorder_simple(c, 0, "edituser", user, key, value, (char *)0); -} - -/** @brief Register a user - * @param c Client - * @param user Username - * @param password Password - * @param email Email address (UTF-8) - * @param confirmp Where to store confirmation string - * @return 0 on success, non-0 on error - */ -int disorder_register(disorder_client *c, const char *user, - const char *password, const char *email, - char **confirmp) { - return dequote(disorder_simple(c, confirmp, "register", - user, password, email, (char *)0), - confirmp); -} - -/** @brief Confirm a user - * @param c Client - * @param confirm Confirmation string - * @return 0 on success, non-0 on error - */ -int disorder_confirm(disorder_client *c, const char *confirm) { - char *u; - int rc; - - if(!(rc = dequote(disorder_simple(c, &u, "confirm", confirm, (char *)0), - &u))) - c->user = u; - return rc; -} - -/** @brief Make a cookie for this login - * @param c Client - * @param cookiep Where to store cookie string - * @return 0 on success, non-0 on error - */ -int disorder_make_cookie(disorder_client *c, char **cookiep) { - return dequote(disorder_simple(c, cookiep, "make-cookie", (char *)0), - cookiep); -} - -/** @brief Revoke the cookie used by this session - * @param c Client - * @return 0 on success, non-0 on error - */ -int disorder_revoke(disorder_client *c) { - return disorder_simple(c, 0, "revoke", (char *)0); -} - -/** @brief Request a password reminder email - * @param c Client - * @param user Username - * @return 0 on success, non-0 on error - */ -int disorder_reminder(disorder_client *c, const char *user) { - return disorder_simple(c, 0, "reminder", user, (char *)0); -} - -/** @brief List scheduled events - * @param c Client - * @param idsp Where to put list of event IDs - * @param nidsp Where to put count of event IDs, or NULL - * @return 0 on success, non-0 on error - */ -int disorder_schedule_list(disorder_client *c, char ***idsp, int *nidsp) { - return disorder_simple_list(c, idsp, nidsp, "schedule-list", (char *)0); -} - -/** @brief Delete a scheduled event - * @param c Client - * @param id Event ID to delete - * @return 0 on success, non-0 on error - */ -int disorder_schedule_del(disorder_client *c, const char *id) { - return disorder_simple(c, 0, "schedule-del", id, (char *)0); -} - /** @brief Get details of a scheduled event * @param c Client * @param id Event ID @@ -1377,111 +870,7 @@ int disorder_schedule_add(disorder_client *c, return rc; } -/** @brief Adopt a track - * @param c Client - * @param id Track ID to adopt - * @return 0 on success, non-0 on error - */ -int disorder_adopt(disorder_client *c, const char *id) { - return disorder_simple(c, 0, "adopt", id, (char *)0); -} - -/** @brief Delete a playlist - * @param c Client - * @param playlist Playlist to delete - * @return 0 on success, non-0 on error - */ -int disorder_playlist_delete(disorder_client *c, - const char *playlist) { - return disorder_simple(c, 0, "playlist-delete", playlist, (char *)0); -} - -/** @brief Get the contents of a playlist - * @param c Client - * @param playlist Playlist to get - * @param tracksp Where to put list of tracks - * @param ntracksp Where to put count of tracks - * @return 0 on success, non-0 on error - */ -int disorder_playlist_get(disorder_client *c, const char *playlist, - char ***tracksp, int *ntracksp) { - return disorder_simple_list(c, tracksp, ntracksp, - "playlist-get", playlist, (char *)0); -} - -/** @brief List all readable playlists - * @param c Client - * @param playlistsp Where to put list of playlists - * @param nplaylistsp Where to put count of playlists - * @return 0 on success, non-0 on error - */ -int disorder_playlists(disorder_client *c, - char ***playlistsp, int *nplaylistsp) { - return disorder_simple_list(c, playlistsp, nplaylistsp, - "playlists", (char *)0); -} - -/** @brief Get the sharing status of a playlist - * @param c Client - * @param playlist Playlist to inspect - * @param sharep Where to put sharing status - * @return 0 on success, non-0 on error - * - * Possible @p sharep values are @c public, @c private and @c shared. - */ -int disorder_playlist_get_share(disorder_client *c, const char *playlist, - char **sharep) { - return disorder_simple(c, sharep, - "playlist-get-share", playlist, (char *)0); -} - -/** @brief Get the sharing status of a playlist - * @param c Client - * @param playlist Playlist to modify - * @param share New sharing status - * @return 0 on success, non-0 on error - * - * Possible @p share values are @c public, @c private and @c shared. - */ -int disorder_playlist_set_share(disorder_client *c, const char *playlist, - const char *share) { - return disorder_simple(c, 0, - "playlist-set-share", playlist, share, (char *)0); -} - -/** @brief Lock a playlist for modifications - * @param c Client - * @param playlist Playlist to lock - * @return 0 on success, non-0 on error - */ -int disorder_playlist_lock(disorder_client *c, const char *playlist) { - return disorder_simple(c, 0, - "playlist-lock", playlist, (char *)0); -} - -/** @brief Unlock the locked playlist - * @param c Client - * @return 0 on success, non-0 on error - */ -int disorder_playlist_unlock(disorder_client *c) { - return disorder_simple(c, 0, - "playlist-unlock", (char *)0); -} - -/** @brief Set the contents of a playlst - * @param c Client - * @param playlist Playlist to modify - * @param tracks List of tracks - * @param ntracks Length of @p tracks (or -1 to count up to the first NULL) - * @return 0 on success, non-0 on error - */ -int disorder_playlist_set(disorder_client *c, - const char *playlist, - char **tracks, - int ntracks) { - return disorder_simple_body(c, 0, tracks, ntracks, - "playlist-set", playlist, (char *)0); -} +#include "client-stubs.c" /* Local Variables: