2 * This file is part of DisOrder.
3 * Copyright (C) 2004-2008 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 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful, but
11 * WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * 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, write to the Free Software
17 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
20 /** @file lib/client.c
21 * @brief Simple C client
23 * See @ref lib/eclient.c for an asynchronous-capable client
30 #include <sys/types.h>
31 #include <sys/socket.h>
32 #include <netinet/in.h>
44 #include "configuration.h"
51 #include "inputline.h"
58 #include "client-common.h"
62 /** @brief Client handle contents */
63 struct disorder_client {
64 /** @brief Stream to read from */
66 /** @brief Stream to write to */
68 /** @brief Peer description */
70 /** @brief Username */
72 /** @brief Report errors to @c stderr */
74 /** @brief Last error string */
78 /** @brief Create a new client
79 * @param verbose If nonzero, write extra junk to stderr
80 * @return Pointer to new client
82 * You must call disorder_connect(), disorder_connect_user() or
83 * disorder_connect_cookie() to connect it. Use disorder_close() to
84 * dispose of the client when finished with it.
86 disorder_client *disorder_new(int verbose) {
87 disorder_client *c = xmalloc(sizeof (struct disorder_client));
93 /** @brief Read a response line
95 * @param rp Where to store response, or NULL (UTF-8)
96 * @return Response code 0-999 or -1 on error
98 static int response(disorder_client *c, char **rp) {
101 if(inputline(c->ident, c->fpin, &r, '\n')) {
102 byte_xasprintf((char **)&c->last, "input error: %s", strerror(errno));
105 D(("response: %s", r));
108 if(r[0] >= '0' && r[0] <= '9'
109 && r[1] >= '0' && r[1] <= '9'
110 && r[2] >= '0' && r[2] <= '9'
113 return (r[0] * 10 + r[1]) * 10 + r[2] - 111 * '0';
115 c->last = "invalid reply format";
116 error(0, "invalid reply format from %s", c->ident);
121 /** @brief Return last response string
123 * @return Last response string (UTF-8, English) or NULL
125 const char *disorder_last(disorder_client *c) {
129 /** @brief Read and partially parse a response
131 * @param rp Where to store response text (or NULL) (UTF-8)
132 * @return 0 on success, non-0 on error
134 * 5xx responses count as errors.
136 * @p rp will NOT be filled in for xx9 responses (where it is just
137 * commentary for a command where it would normally be meaningful).
139 * NB that the response will NOT be converted to the local encoding.
141 static int check_response(disorder_client *c, char **rp) {
145 if((rc = response(c, &r)) == -1)
147 else if(rc / 100 == 2) {
149 *rp = (rc % 10 == 9) ? 0 : xstrdup(r + 4);
153 error(0, "from %s: %s", c->ident, utf82mb(r));
158 /** @brief Issue a command and parse a simple response
160 * @param rp Where to store result, or NULL
162 * @param ap Arguments (UTF-8), terminated by (char *)0
163 * @return 0 on success, non-0 on error
165 * 5xx responses count as errors.
167 * @p rp will NOT be filled in for xx9 responses (where it is just
168 * commentary for a command where it would normally be meaningful).
170 * NB that the response will NOT be converted to the local encoding
171 * nor will quotes be stripped. See dequote().
173 static int disorder_simple_v(disorder_client *c,
175 const char *cmd, va_list ap) {
180 c->last = "not connected";
181 error(0, "not connected to server");
186 dynstr_append_string(&d, cmd);
187 while((arg = va_arg(ap, const char *))) {
188 dynstr_append(&d, ' ');
189 dynstr_append_string(&d, quoteutf8(arg));
191 dynstr_append(&d, '\n');
192 dynstr_terminate(&d);
193 D(("command: %s", d.vec));
194 if(fputs(d.vec, c->fpout) < 0 || fflush(c->fpout)) {
195 byte_xasprintf((char **)&c->last, "write error: %s", strerror(errno));
196 error(errno, "error writing to %s", c->ident);
200 return check_response(c, rp);
203 /** @brief Issue a command and parse a simple response
205 * @param rp Where to store result, or NULL (UTF-8)
207 * @return 0 on success, non-0 on error
209 * The remaining arguments are command arguments, terminated by (char
210 * *)0. They should be in UTF-8.
212 * 5xx responses count as errors.
214 * @p rp will NOT be filled in for xx9 responses (where it is just
215 * commentary for a command where it would normally be meaningful).
217 * NB that the response will NOT be converted to the local encoding
218 * nor will quotes be stripped. See dequote().
220 static int disorder_simple(disorder_client *c,
222 const char *cmd, ...) {
227 ret = disorder_simple_v(c, rp, cmd, ap);
232 /** @brief Dequote a result string
233 * @param rc 0 on success, non-0 on error
234 * @param rp Where result string is stored (UTF-8)
237 * This is used as a wrapper around disorder_simple() to dequote
240 static int dequote(int rc, char **rp) {
244 if((rr = split(*rp, 0, SPLIT_QUOTES, 0, 0)) && *rr) {
248 error(0, "invalid reply: %s", *rp);
253 /** @brief Generic connection routine
255 * @param username Username to log in with or NULL
256 * @param password Password to log in with or NULL
257 * @param cookie Cookie to log in with or NULL
258 * @return 0 on success, non-0 on error
260 * @p cookie is tried first if not NULL. If it is NULL then @p
261 * username must not be. If @p username is not NULL then nor may @p
264 static int disorder_connect_generic(disorder_client *c,
265 const char *username,
266 const char *password,
267 const char *cookie) {
268 int fd = -1, fd2 = -1, nrvec, rc;
269 unsigned char *nonce;
273 const char *protocol, *algorithm, *challenge;
277 if((salen = find_server(&sa, &c->ident)) == (socklen_t)-1)
279 c->fpin = c->fpout = 0;
280 if((fd = socket(sa->sa_family, SOCK_STREAM, 0)) < 0) {
281 byte_xasprintf((char **)&c->last, "socket: %s", strerror(errno));
282 error(errno, "error calling socket");
285 if(connect(fd, sa, salen) < 0) {
286 byte_xasprintf((char **)&c->last, "connect: %s", strerror(errno));
287 error(errno, "error calling connect");
290 if((fd2 = dup(fd)) < 0) {
291 byte_xasprintf((char **)&c->last, "dup: %s", strerror(errno));
292 error(errno, "error calling dup");
295 if(!(c->fpin = fdopen(fd, "rb"))) {
296 byte_xasprintf((char **)&c->last, "fdopen: %s", strerror(errno));
297 error(errno, "error calling fdopen");
301 if(!(c->fpout = fdopen(fd2, "wb"))) {
302 byte_xasprintf((char **)&c->last, "fdopen: %s", strerror(errno));
303 error(errno, "error calling fdopen");
307 if((rc = disorder_simple(c, &r, 0, (const char *)0)))
309 if(!(rvec = split(r, &nrvec, SPLIT_QUOTES, 0, 0)))
312 c->last = "cannot parse server greeting";
313 error(0, "cannot parse server greeting %s", r);
317 if(strcmp(protocol, "2")) {
318 c->last = "unknown protocol version";
319 error(0, "unknown protocol version: %s", protocol);
324 if(!(nonce = unhex(challenge, &nl)))
327 if(!dequote(disorder_simple(c, &c->user, "cookie", cookie, (char *)0),
329 return 0; /* success */
331 c->last = "cookie failed and no username";
332 error(0, "cookie did not work and no username available");
336 if(!(res = authhash(nonce, nl, password, algorithm))) {
337 c->last = "error computing authorization hash";
340 if((rc = disorder_simple(c, 0, "user", username, res, (char *)0)))
342 c->user = xstrdup(username);
355 if(fd2 != -1) close(fd2);
356 if(fd != -1) close(fd);
360 /** @brief Connect a client with a specified username and password
362 * @param username Username to log in with
363 * @param password Password to log in with
364 * @return 0 on success, non-0 on error
366 int disorder_connect_user(disorder_client *c,
367 const char *username,
368 const char *password) {
369 return disorder_connect_generic(c,
375 /** @brief Connect a client
377 * @return 0 on success, non-0 on error
379 * The connection will use the username and password found in @ref
380 * config, or directly from the database if no password is found and
381 * the database is readable (usually only for root).
383 int disorder_connect(disorder_client *c) {
384 const char *username, *password;
386 if(!(username = config->username)) {
387 c->last = "no username";
388 error(0, "no username configured");
391 password = config->password;
392 /* Maybe we can read the database */
393 if(!password && trackdb_readable()) {
394 trackdb_init(TRACKDB_NO_RECOVER|TRACKDB_NO_UPGRADE);
395 trackdb_open(TRACKDB_READ_ONLY);
396 password = trackdb_get_password(username);
401 c->last = "no password";
402 error(0, "no password configured");
405 return disorder_connect_generic(c,
411 /** @brief Connect a client
413 * @param cookie Cookie to log in with, or NULL
414 * @return 0 on success, non-0 on error
416 * If @p cookie is NULL or does not work then we attempt to log in as
417 * guest instead (so when the cookie expires only an extra round trip
418 * is needed rathre than a complete new login).
420 int disorder_connect_cookie(disorder_client *c,
421 const char *cookie) {
422 return disorder_connect_generic(c,
428 /** @brief Close a client
430 * @return 0 on succcess, non-0 on errior
432 * The client is still closed even on error. It might well be
433 * appropriate to ignore the return value.
435 int disorder_close(disorder_client *c) {
439 if(fclose(c->fpin) < 0) {
440 byte_xasprintf((char **)&c->last, "fclose: %s", strerror(errno));
441 error(errno, "error calling fclose");
447 if(fclose(c->fpout) < 0) {
448 byte_xasprintf((char **)&c->last, "fclose: %s", strerror(errno));
449 error(errno, "error calling fclose");
459 /** @brief Play a track
461 * @param track Track to play (UTF-8)
462 * @return 0 on success, non-0 on error
464 int disorder_play(disorder_client *c, const char *track) {
465 return disorder_simple(c, 0, "play", track, (char *)0);
468 /** @brief Remove a track
470 * @param track Track to remove (UTF-8)
471 * @return 0 on success, non-0 on error
473 int disorder_remove(disorder_client *c, const char *track) {
474 return disorder_simple(c, 0, "remove", track, (char *)0);
477 /** @brief Move a track
479 * @param track Track to move (UTF-8)
480 * @param delta Distance to move by
481 * @return 0 on success, non-0 on error
483 int disorder_move(disorder_client *c, const char *track, int delta) {
486 byte_snprintf(d, sizeof d, "%d", delta);
487 return disorder_simple(c, 0, "move", track, d, (char *)0);
490 /** @brief Enable play
492 * @return 0 on success, non-0 on error
494 int disorder_enable(disorder_client *c) {
495 return disorder_simple(c, 0, "enable", (char *)0);
498 /** @brief Disable play
500 * @return 0 on success, non-0 on error
502 int disorder_disable(disorder_client *c) {
503 return disorder_simple(c, 0, "disable", (char *)0);
506 /** @brief Scratch the currently playing track
507 * @param id Playing track ID or NULL (UTF-8)
509 * @return 0 on success, non-0 on error
511 int disorder_scratch(disorder_client *c, const char *id) {
512 return disorder_simple(c, 0, "scratch", id, (char *)0);
515 /** @brief Shut down the server
517 * @return 0 on success, non-0 on error
519 int disorder_shutdown(disorder_client *c) {
520 return disorder_simple(c, 0, "shutdown", (char *)0);
523 /** @brief Make the server re-read its configuration
525 * @return 0 on success, non-0 on error
527 int disorder_reconfigure(disorder_client *c) {
528 return disorder_simple(c, 0, "reconfigure", (char *)0);
531 /** @brief Rescan tracks
533 * @return 0 on success, non-0 on error
535 int disorder_rescan(disorder_client *c) {
536 return disorder_simple(c, 0, "rescan", (char *)0);
539 /** @brief Get server version number
541 * @param rp Where to store version string (UTF-8)
542 * @return 0 on success, non-0 on error
544 int disorder_version(disorder_client *c, char **rp) {
545 return dequote(disorder_simple(c, rp, "version", (char *)0), rp);
548 static void client_error(const char *msg,
549 void attribute((unused)) *u) {
550 error(0, "error parsing reply: %s", msg);
553 /** @brief Get currently playing track
555 * @param qp Where to store track information
556 * @return 0 on success, non-0 on error
558 * @p qp gets NULL if no track is playing.
560 int disorder_playing(disorder_client *c, struct queue_entry **qp) {
562 struct queue_entry *q;
565 if((rc = disorder_simple(c, &r, "playing", (char *)0)))
568 q = xmalloc(sizeof *q);
569 if(queue_unmarshall(q, r, client_error, 0))
577 /** @brief Fetch the queue, recent list, etc */
578 static int disorder_somequeue(disorder_client *c,
579 const char *cmd, struct queue_entry **qp) {
580 struct queue_entry *qh, **qt = &qh, *q;
584 if((rc = disorder_simple(c, 0, cmd, (char *)0)))
586 while(inputline(c->ident, c->fpin, &l, '\n') >= 0) {
587 if(!strcmp(l, ".")) {
592 q = xmalloc(sizeof *q);
593 if(!queue_unmarshall(q, l, client_error, 0)) {
598 if(ferror(c->fpin)) {
599 byte_xasprintf((char **)&c->last, "input error: %s", strerror(errno));
600 error(errno, "error reading %s", c->ident);
602 c->last = "input error: unexpxected EOF";
603 error(0, "error reading %s: unexpected EOF", c->ident);
608 /** @brief Get recently played tracks
610 * @param qp Where to store track information
611 * @return 0 on success, non-0 on error
613 * The last entry in the list is the most recently played track.
615 int disorder_recent(disorder_client *c, struct queue_entry **qp) {
616 return disorder_somequeue(c, "recent", qp);
621 * @param qp Where to store track information
622 * @return 0 on success, non-0 on error
624 * The first entry in the list will be played next.
626 int disorder_queue(disorder_client *c, struct queue_entry **qp) {
627 return disorder_somequeue(c, "queue", qp);
630 /** @brief Read a dot-stuffed list
632 * @param vecp Where to store list (UTF-8)
633 * @param nvecp Where to store number of items, or NULL
634 * @return 0 on success, non-0 on error
636 * The list will have a final NULL not counted in @p nvecp.
638 static int readlist(disorder_client *c, char ***vecp, int *nvecp) {
643 while(inputline(c->ident, c->fpin, &l, '\n') >= 0) {
644 if(!strcmp(l, ".")) {
645 vector_terminate(&v);
651 vector_append(&v, l + (*l == '.'));
653 if(ferror(c->fpin)) {
654 byte_xasprintf((char **)&c->last, "input error: %s", strerror(errno));
655 error(errno, "error reading %s", c->ident);
657 c->last = "input error: unexpxected EOF";
658 error(0, "error reading %s: unexpected EOF", c->ident);
663 /** @brief Issue a comamnd and get a list response
665 * @param vecp Where to store list (UTF-8)
666 * @param nvecp Where to store number of items, or NULL
668 * @return 0 on success, non-0 on error
670 * The remaining arguments are command arguments, terminated by (char
671 * *)0. They should be in UTF-8.
673 * 5xx responses count as errors.
675 static int disorder_simple_list(disorder_client *c,
676 char ***vecp, int *nvecp,
677 const char *cmd, ...) {
682 ret = disorder_simple_v(c, 0, cmd, ap);
685 return readlist(c, vecp, nvecp);
688 /** @brief List directories below @p dir
690 * @param dir Directory to list, or NULL for root (UTF-8)
691 * @param re Regexp that results must match, or NULL (UTF-8)
692 * @param vecp Where to store list (UTF-8)
693 * @param nvecp Where to store number of items, or NULL
694 * @return 0 on success, non-0 on error
696 int disorder_directories(disorder_client *c, const char *dir, const char *re,
697 char ***vecp, int *nvecp) {
698 return disorder_simple_list(c, vecp, nvecp, "dirs", dir, re, (char *)0);
701 /** @brief List files below @p dir
703 * @param dir Directory to list, or NULL for root (UTF-8)
704 * @param re Regexp that results must match, or NULL (UTF-8)
705 * @param vecp Where to store list (UTF-8)
706 * @param nvecp Where to store number of items, or NULL
707 * @return 0 on success, non-0 on error
709 int disorder_files(disorder_client *c, const char *dir, const char *re,
710 char ***vecp, int *nvecp) {
711 return disorder_simple_list(c, vecp, nvecp, "files", dir, re, (char *)0);
714 /** @brief List files and directories below @p dir
716 * @param dir Directory to list, or NULL for root (UTF-8)
717 * @param re Regexp that results must match, or NULL (UTF-8)
718 * @param vecp Where to store list (UTF-8)
719 * @param nvecp Where to store number of items, or NULL
720 * @return 0 on success, non-0 on error
722 int disorder_allfiles(disorder_client *c, const char *dir, const char *re,
723 char ***vecp, int *nvecp) {
724 return disorder_simple_list(c, vecp, nvecp, "allfiles", dir, re, (char *)0);
727 /** @brief Return the user we logged in with
729 * @return User name (owned by @p c, don't modify)
731 char *disorder_user(disorder_client *c) {
735 /** @brief Set a track preference
737 * @param track Track name (UTF-8)
738 * @param key Preference name (UTF-8)
739 * @param value Preference value (UTF-8)
740 * @return 0 on success, non-0 on error
742 int disorder_set(disorder_client *c, const char *track,
743 const char *key, const char *value) {
744 return disorder_simple(c, 0, "set", track, key, value, (char *)0);
747 /** @brief Unset a track preference
749 * @param track Track name (UTF-8)
750 * @param key Preference name (UTF-8)
751 * @return 0 on success, non-0 on error
753 int disorder_unset(disorder_client *c, const char *track,
755 return disorder_simple(c, 0, "unset", track, key, (char *)0);
758 /** @brief Get a track preference
760 * @param track Track name (UTF-8)
761 * @param key Preference name (UTF-8)
762 * @param valuep Where to store preference value (UTF-8)
763 * @return 0 on success, non-0 on error
765 int disorder_get(disorder_client *c,
766 const char *track, const char *key, char **valuep) {
767 return dequote(disorder_simple(c, valuep, "get", track, key, (char *)0),
771 static void pref_error_handler(const char *msg,
772 void attribute((unused)) *u) {
773 error(0, "error handling 'prefs' reply: %s", msg);
776 /** @brief Get all preferences for a trcak
778 * @param track Track name
779 * @param kp Where to store linked list of preferences
780 * @return 0 on success, non-0 on error
782 int disorder_prefs(disorder_client *c, const char *track, struct kvp **kp) {
784 int nvec, npvec, n, rc;
787 if((rc = disorder_simple_list(c, &vec, &nvec, "prefs", track, (char *)0)))
789 for(n = 0; n < nvec; ++n) {
790 if(!(pvec = split(vec[n], &npvec, SPLIT_QUOTES, pref_error_handler, 0)))
793 pref_error_handler("malformed response", 0);
796 *kp = k = xmalloc(sizeof *k);
805 /** @brief Parse a boolean response
806 * @param cmd Command for use in error messsage
807 * @param value Result from server
808 * @param flagp Where to store result
809 * @return 0 on success, non-0 on error
811 static int boolean(const char *cmd, const char *value,
813 if(!strcmp(value, "yes")) *flagp = 1;
814 else if(!strcmp(value, "no")) *flagp = 0;
816 error(0, "malformed response to '%s'", cmd);
822 /** @brief Test whether a track exists
824 * @param track Track name (UTF-8)
825 * @param existsp Where to store result (non-0 iff does exist)
826 * @return 0 on success, non-0 on error
828 int disorder_exists(disorder_client *c, const char *track, int *existsp) {
832 if((rc = disorder_simple(c, &v, "exists", track, (char *)0)))
834 return boolean("exists", v, existsp);
837 /** @brief Test whether playing is enabled
839 * @param enabledp Where to store result (non-0 iff enabled)
840 * @return 0 on success, non-0 on error
842 int disorder_enabled(disorder_client *c, int *enabledp) {
846 if((rc = disorder_simple(c, &v, "enabled", (char *)0)))
848 return boolean("enabled", v, enabledp);
851 /** @brief Get the length of a track
853 * @param track Track name (UTF-8)
854 * @param valuep Where to store length in seconds
855 * @return 0 on success, non-0 on error
857 * If the length is unknown 0 is returned.
859 int disorder_length(disorder_client *c, const char *track,
864 if((rc = disorder_simple(c, &value, "length", track, (char *)0)))
866 *valuep = atol(value);
870 /** @brief Search for tracks
872 * @param terms Search terms (UTF-8)
873 * @param vecp Where to store list (UTF-8)
874 * @param nvecp Where to store number of items, or NULL
875 * @return 0 on success, non-0 on error
877 int disorder_search(disorder_client *c, const char *terms,
878 char ***vecp, int *nvecp) {
879 return disorder_simple_list(c, vecp, nvecp, "search", terms, (char *)0);
882 /** @brief Enable random play
884 * @return 0 on success, non-0 on error
886 int disorder_random_enable(disorder_client *c) {
887 return disorder_simple(c, 0, "random-enable", (char *)0);
890 /** @brief Disable random play
892 * @return 0 on success, non-0 on error
894 int disorder_random_disable(disorder_client *c) {
895 return disorder_simple(c, 0, "random-disable", (char *)0);
898 /** @brief Test whether random play is enabled
900 * @param enabledp Where to store result (non-0 iff enabled)
901 * @return 0 on success, non-0 on error
903 int disorder_random_enabled(disorder_client *c, int *enabledp) {
907 if((rc = disorder_simple(c, &v, "random-enabled", (char *)0)))
909 return boolean("random-enabled", v, enabledp);
912 /** @brief Get server stats
914 * @param vecp Where to store list (UTF-8)
915 * @param nvecp Where to store number of items, or NULL
916 * @return 0 on success, non-0 on error
918 int disorder_stats(disorder_client *c,
919 char ***vecp, int *nvecp) {
920 return disorder_simple_list(c, vecp, nvecp, "stats", (char *)0);
923 /** @brief Set volume
925 * @param left New left channel value
926 * @param right New right channel value
927 * @return 0 on success, non-0 on error
929 int disorder_set_volume(disorder_client *c, int left, int right) {
932 if(byte_asprintf(&ls, "%d", left) < 0
933 || byte_asprintf(&rs, "%d", right) < 0)
935 return disorder_simple(c, 0, "volume", ls, rs, (char *)0);
938 /** @brief Get volume
940 * @param left Where to store left channel value
941 * @param right Where to store right channel value
942 * @return 0 on success, non-0 on error
944 int disorder_get_volume(disorder_client *c, int *left, int *right) {
948 if((rc = disorder_simple(c, &r, "volume", (char *)0)))
950 if(sscanf(r, "%d %d", left, right) != 2) {
951 c->last = "malformed volume response";
952 error(0, "error parsing response to 'volume': '%s'", r);
958 /** @brief Log to a sink
960 * @param s Sink to write log lines to
961 * @return 0 on success, non-0 on error
963 int disorder_log(disorder_client *c, struct sink *s) {
967 if((rc = disorder_simple(c, 0, "log", (char *)0)))
969 while(inputline(c->ident, c->fpin, &l, '\n') >= 0 && strcmp(l, "."))
970 if(sink_printf(s, "%s\n", l) < 0) return -1;
971 if(ferror(c->fpin) || feof(c->fpin)) {
972 byte_xasprintf((char **)&c->last, "input error: %s",
973 ferror(c->fpin) ? strerror(errno) : "unexpxected EOF");
979 /** @brief Look up a track name part
981 * @param partp Where to store result (UTF-8)
982 * @param track Track name (UTF-8)
983 * @param context Context (usually "sort" or "display") (UTF-8)
984 * @param part Track part (UTF-8)
985 * @return 0 on success, non-0 on error
987 int disorder_part(disorder_client *c, char **partp,
988 const char *track, const char *context, const char *part) {
989 return dequote(disorder_simple(c, partp, "part",
990 track, context, part, (char *)0), partp);
993 /** @brief Resolve aliases
995 * @param trackp Where to store canonical name (UTF-8)
996 * @param track Track name (UTF-8)
997 * @return 0 on success, non-0 on error
999 int disorder_resolve(disorder_client *c, char **trackp, const char *track) {
1000 return dequote(disorder_simple(c, trackp, "resolve", track, (char *)0),
1004 /** @brief Pause the current track
1006 * @return 0 on success, non-0 on error
1008 int disorder_pause(disorder_client *c) {
1009 return disorder_simple(c, 0, "pause", (char *)0);
1012 /** @brief Resume the current track
1014 * @return 0 on success, non-0 on error
1016 int disorder_resume(disorder_client *c) {
1017 return disorder_simple(c, 0, "resume", (char *)0);
1020 /** @brief List all known tags
1022 * @param vecp Where to store list (UTF-8)
1023 * @param nvecp Where to store number of items, or NULL
1024 * @return 0 on success, non-0 on error
1026 int disorder_tags(disorder_client *c,
1027 char ***vecp, int *nvecp) {
1028 return disorder_simple_list(c, vecp, nvecp, "tags", (char *)0);
1031 /** @brief List all known users
1033 * @param vecp Where to store list (UTF-8)
1034 * @param nvecp Where to store number of items, or NULL
1035 * @return 0 on success, non-0 on error
1037 int disorder_users(disorder_client *c,
1038 char ***vecp, int *nvecp) {
1039 return disorder_simple_list(c, vecp, nvecp, "users", (char *)0);
1042 /** @brief Get recently added tracks
1044 * @param vecp Where to store pointer to list (UTF-8)
1045 * @param nvecp Where to store count
1046 * @param max Maximum tracks to fetch, or 0 for all available
1047 * @return 0 on success, non-0 on error
1049 int disorder_new_tracks(disorder_client *c,
1050 char ***vecp, int *nvecp,
1054 sprintf(limit, "%d", max);
1055 return disorder_simple_list(c, vecp, nvecp, "new", limit, (char *)0);
1058 /** @brief Set a global preference
1060 * @param key Preference name (UTF-8)
1061 * @param value Preference value (UTF-8)
1062 * @return 0 on success, non-0 on error
1064 int disorder_set_global(disorder_client *c,
1065 const char *key, const char *value) {
1066 return disorder_simple(c, 0, "set-global", key, value, (char *)0);
1069 /** @brief Unset a global preference
1071 * @param key Preference name (UTF-8)
1072 * @return 0 on success, non-0 on error
1074 int disorder_unset_global(disorder_client *c, const char *key) {
1075 return disorder_simple(c, 0, "unset-global", key, (char *)0);
1078 /** @brief Get a global preference
1080 * @param key Preference name (UTF-8)
1081 * @param valuep Where to store preference value (UTF-8)
1082 * @return 0 on success, non-0 on error
1084 int disorder_get_global(disorder_client *c, const char *key, char **valuep) {
1085 return dequote(disorder_simple(c, valuep, "get-global", key, (char *)0),
1089 /** @brief Get server's RTP address information
1091 * @param addressp Where to store address (UTF-8)
1092 * @param portp Where to store port (UTF-8)
1093 * @return 0 on success, non-0 on error
1095 int disorder_rtp_address(disorder_client *c, char **addressp, char **portp) {
1100 if((rc = disorder_simple(c, &r, "rtp-address", (char *)0)))
1102 vec = split(r, &n, SPLIT_QUOTES, 0, 0);
1104 c->last = "malformed RTP address";
1105 error(0, "malformed rtp-address reply");
1113 /** @brief Create a user
1115 * @param user Username
1116 * @param password Password
1117 * @param rights Initial rights or NULL to use default
1118 * @return 0 on success, non-0 on error
1120 int disorder_adduser(disorder_client *c,
1121 const char *user, const char *password,
1122 const char *rights) {
1123 return disorder_simple(c, 0, "adduser", user, password, rights, (char *)0);
1126 /** @brief Delete a user
1128 * @param user Username
1129 * @return 0 on success, non-0 on error
1131 int disorder_deluser(disorder_client *c, const char *user) {
1132 return disorder_simple(c, 0, "deluser", user, (char *)0);
1135 /** @brief Get user information
1137 * @param user Username
1138 * @param key Property name (UTF-8)
1139 * @param valuep Where to store value (UTF-8)
1140 * @return 0 on success, non-0 on error
1142 int disorder_userinfo(disorder_client *c, const char *user, const char *key,
1144 return dequote(disorder_simple(c, valuep, "userinfo", user, key, (char *)0),
1148 /** @brief Set user information
1150 * @param user Username
1151 * @param key Property name (UTF-8)
1152 * @param value New property value (UTF-8)
1153 * @return 0 on success, non-0 on error
1155 int disorder_edituser(disorder_client *c, const char *user,
1156 const char *key, const char *value) {
1157 return disorder_simple(c, 0, "edituser", user, key, value, (char *)0);
1160 /** @brief Register a user
1162 * @param user Username
1163 * @param password Password
1164 * @param email Email address (UTF-8)
1165 * @param confirmp Where to store confirmation string
1166 * @return 0 on success, non-0 on error
1168 int disorder_register(disorder_client *c, const char *user,
1169 const char *password, const char *email,
1171 return dequote(disorder_simple(c, confirmp, "register",
1172 user, password, email, (char *)0),
1176 /** @brief Confirm a user
1178 * @param confirm Confirmation string
1179 * @return 0 on success, non-0 on error
1181 int disorder_confirm(disorder_client *c, const char *confirm) {
1185 if(!(rc = dequote(disorder_simple(c, &u, "confirm", confirm, (char *)0),
1191 /** @brief Make a cookie for this login
1193 * @param cookiep Where to store cookie string
1194 * @return 0 on success, non-0 on error
1196 int disorder_make_cookie(disorder_client *c, char **cookiep) {
1197 return dequote(disorder_simple(c, cookiep, "make-cookie", (char *)0),
1201 /** @brief Revoke the cookie used by this session
1203 * @return 0 on success, non-0 on error
1205 int disorder_revoke(disorder_client *c) {
1206 return disorder_simple(c, 0, "revoke", (char *)0);
1209 /** @brief Request a password reminder email
1211 * @param user Username
1212 * @return 0 on success, non-0 on error
1214 int disorder_reminder(disorder_client *c, const char *user) {
1215 return disorder_simple(c, 0, "reminder", user, (char *)0);