2 * This file is part of DisOrder.
3 * Copyright (C) 2004-2009 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 /** @file lib/client.c
19 * @brief Simple C client
21 * See @ref lib/eclient.c for an asynchronous-capable client
27 #include <sys/types.h>
28 #include <sys/socket.h>
29 #include <netinet/in.h>
44 #include "inputline.h"
51 #include "client-common.h"
56 /** @brief Client handle contents */
57 struct disorder_client
{
58 /** @brief Stream to read from */
60 /** @brief Stream to write to */
62 /** @brief Peer description */
64 /** @brief Username */
66 /** @brief Report errors to @c stderr */
68 /** @brief Last error string */
72 /** @brief Create a new client
73 * @param verbose If nonzero, write extra junk to stderr
74 * @return Pointer to new client
76 * You must call disorder_connect(), disorder_connect_user() or
77 * disorder_connect_cookie() to connect it. Use disorder_close() to
78 * dispose of the client when finished with it.
80 disorder_client
*disorder_new(int verbose
) {
81 disorder_client
*c
= xmalloc(sizeof (struct disorder_client
));
87 /** @brief Read a response line
89 * @param rp Where to store response, or NULL (UTF-8)
90 * @return Response code 0-999 or -1 on error
92 static int response(disorder_client
*c
, char **rp
) {
95 if(inputline(c
->ident
, c
->fpin
, &r
, '\n')) {
96 byte_xasprintf((char **)&c
->last
, "input error: %s", strerror(errno
));
99 D(("response: %s", r
));
102 if(r
[0] >= '0' && r
[0] <= '9'
103 && r
[1] >= '0' && r
[1] <= '9'
104 && r
[2] >= '0' && r
[2] <= '9'
107 return (r
[0] * 10 + r
[1]) * 10 + r
[2] - 111 * '0';
109 c
->last
= "invalid reply format";
110 disorder_error(0, "invalid reply format from %s", c
->ident
);
115 /** @brief Return last response string
117 * @return Last response string (UTF-8, English) or NULL
119 const char *disorder_last(disorder_client
*c
) {
123 /** @brief Read and partially parse a response
125 * @param rp Where to store response text (or NULL) (UTF-8)
126 * @return 0 on success, non-0 on error
128 * 5xx responses count as errors.
130 * @p rp will NOT be filled in for xx9 responses (where it is just
131 * commentary for a command where it would normally be meaningful).
133 * NB that the response will NOT be converted to the local encoding.
135 static int check_response(disorder_client
*c
, char **rp
) {
139 if((rc
= response(c
, &r
)) == -1)
141 else if(rc
/ 100 == 2) {
143 *rp
= (rc
% 10 == 9) ?
0 : xstrdup(r
+ 4);
148 disorder_error(0, "from %s: %s", c
->ident
, utf82mb(r
));
154 /** @brief Issue a command and parse a simple response
156 * @param rp Where to store result, or NULL
158 * @param body Body or NULL
159 * @param nbody Length of body or -1
160 * @param ap Arguments (UTF-8), terminated by (char *)0
161 * @return 0 on success, non-0 on error
163 * 5xx responses count as errors.
165 * @p rp will NOT be filled in for xx9 responses (where it is just
166 * commentary for a command where it would normally be meaningful).
168 * NB that the response will NOT be converted to the local encoding
169 * nor will quotes be stripped. See dequote().
171 * If @p body is not NULL then the body is sent immediately after the
172 * command. @p nbody should be the number of lines or @c -1 to count
173 * them if @p body is NULL-terminated.
175 * Usually you would call this via one of the following interfaces:
176 * - disorder_simple()
177 * - disorder_simple_body()
178 * - disorder_simple_list()
180 static int disorder_simple_v(disorder_client
*c
,
183 char **body
, int nbody
,
189 c
->last
= "not connected";
190 disorder_error(0, "not connected to server");
195 dynstr_append_string(&d
, cmd
);
196 while((arg
= va_arg(ap
, const char *))) {
197 dynstr_append(&d
, ' ');
198 dynstr_append_string(&d
, quoteutf8(arg
));
200 dynstr_append(&d
, '\n');
201 dynstr_terminate(&d
);
202 D(("command: %s", d
.vec
));
203 if(fputs(d
.vec
, c
->fpout
) < 0)
208 for(nbody
= 0; body
[nbody
]; ++nbody
)
210 for(int n
= 0; n
< nbody
; ++n
) {
211 if(body
[n
][0] == '.')
212 if(fputc('.', c
->fpout
) < 0)
214 if(fputs(body
[n
], c
->fpout
) < 0)
216 if(fputc('\n', c
->fpout
) < 0)
219 if(fputs(".\n", c
->fpout
) < 0)
225 return check_response(c
, rp
);
227 byte_xasprintf((char **)&c
->last
, "write error: %s", strerror(errno
));
228 disorder_error(errno
, "error writing to %s", c
->ident
);
232 /** @brief Issue a command and parse a simple response
234 * @param rp Where to store result, or NULL (UTF-8)
236 * @return 0 on success, non-0 on error
238 * The remaining arguments are command arguments, terminated by (char
239 * *)0. They should be in UTF-8.
241 * 5xx responses count as errors.
243 * @p rp will NOT be filled in for xx9 responses (where it is just
244 * commentary for a command where it would normally be meaningful).
246 * NB that the response will NOT be converted to the local encoding
247 * nor will quotes be stripped. See dequote().
249 static int disorder_simple(disorder_client
*c
,
251 const char *cmd
, ...) {
256 ret
= disorder_simple_v(c
, rp
, cmd
, 0, 0, ap
);
261 /** @brief Issue a command with a body and parse a simple response
263 * @param rp Where to store result, or NULL (UTF-8)
264 * @param body Pointer to body
265 * @param nbody Size of body
267 * @return 0 on success, non-0 on error
269 * See disorder_simple().
271 static int disorder_simple_body(disorder_client
*c
,
273 char **body
, int nbody
,
274 const char *cmd
, ...) {
279 ret
= disorder_simple_v(c
, rp
, cmd
, body
, nbody
, ap
);
284 /** @brief Dequote a result string
285 * @param rc 0 on success, non-0 on error
286 * @param rp Where result string is stored (UTF-8)
289 * This is used as a wrapper around disorder_simple() to dequote
292 static int dequote(int rc
, char **rp
) {
296 if((rr
= split(*rp
, 0, SPLIT_QUOTES
, 0, 0)) && *rr
) {
302 disorder_error(0, "invalid reply: %s", *rp
);
307 /** @brief Generic connection routine
308 * @param conf Configuration to follow
310 * @param username Username to log in with or NULL
311 * @param password Password to log in with or NULL
312 * @param cookie Cookie to log in with or NULL
313 * @return 0 on success, non-0 on error
315 * @p cookie is tried first if not NULL. If it is NULL then @p
316 * username must not be. If @p username is not NULL then nor may @p
319 int disorder_connect_generic(struct config
*conf
,
321 const char *username
,
322 const char *password
,
323 const char *cookie
) {
324 int fd
= -1, fd2
= -1, nrvec
= 0, rc
;
325 unsigned char *nonce
= NULL
;
328 char *r
= NULL
, **rvec
= NULL
;
329 const char *protocol
, *algorithm
, *challenge
;
330 struct sockaddr
*sa
= NULL
;
333 if((salen
= find_server(conf
, &sa
, &c
->ident
)) == (socklen_t
)-1)
335 c
->fpin
= c
->fpout
= 0;
336 if((fd
= socket(sa
->sa_family
, SOCK_STREAM
, 0)) < 0) {
337 byte_xasprintf((char **)&c
->last
, "socket: %s", strerror(errno
));
338 disorder_error(errno
, "error calling socket");
341 if(connect(fd
, sa
, salen
) < 0) {
342 byte_xasprintf((char **)&c
->last
, "connect: %s", strerror(errno
));
343 disorder_error(errno
, "error calling connect");
346 if((fd2
= dup(fd
)) < 0) {
347 byte_xasprintf((char **)&c
->last
, "dup: %s", strerror(errno
));
348 disorder_error(errno
, "error calling dup");
351 if(!(c
->fpin
= fdopen(fd
, "rb"))) {
352 byte_xasprintf((char **)&c
->last
, "fdopen: %s", strerror(errno
));
353 disorder_error(errno
, "error calling fdopen");
357 if(!(c
->fpout
= fdopen(fd2
, "wb"))) {
358 byte_xasprintf((char **)&c
->last
, "fdopen: %s", strerror(errno
));
359 disorder_error(errno
, "error calling fdopen");
363 if((rc
= disorder_simple(c
, &r
, 0, (const char *)0)))
365 if(!(rvec
= split(r
, &nrvec
, SPLIT_QUOTES
, 0, 0)))
368 c
->last
= "cannot parse server greeting";
369 disorder_error(0, "cannot parse server greeting %s", r
);
373 if(strcmp(protocol
, "2")) {
374 c
->last
= "unknown protocol version";
375 disorder_error(0, "unknown protocol version: %s", protocol
);
380 if(!(nonce
= unhex(challenge
, &nl
)))
383 if(!dequote(disorder_simple(c
, &c
->user
, "cookie", cookie
, (char *)0),
385 return 0; /* success */
387 c
->last
= "cookie failed and no username";
388 disorder_error(0, "cookie did not work and no username available");
392 if(!(res
= authhash(nonce
, nl
, password
, algorithm
))) {
393 c
->last
= "error computing authorization hash";
396 if((rc
= disorder_simple(c
, 0, "user", username
, res
, (char *)0)))
398 c
->user
= xstrdup(username
);
400 free_strings(nrvec
, rvec
);
416 if(fd2
!= -1) close(fd2
);
417 if(fd
!= -1) close(fd
);
421 /** @brief Connect a client with a specified username and password
423 * @param username Username to log in with
424 * @param password Password to log in with
425 * @return 0 on success, non-0 on error
427 int disorder_connect_user(disorder_client
*c
,
428 const char *username
,
429 const char *password
) {
430 return disorder_connect_generic(config
,
437 /** @brief Connect a client
439 * @return 0 on success, non-0 on error
441 * The connection will use the username and password found in @ref
442 * config, or directly from the database if no password is found and
443 * the database is readable (usually only for root).
445 int disorder_connect(disorder_client
*c
) {
446 const char *username
, *password
;
448 if(!(username
= config
->username
)) {
449 c
->last
= "no username";
450 disorder_error(0, "no username configured");
453 password
= config
->password
;
454 /* Maybe we can read the database */
455 if(!password
&& trackdb_readable()) {
456 trackdb_init(TRACKDB_NO_RECOVER
|TRACKDB_NO_UPGRADE
);
457 trackdb_open(TRACKDB_READ_ONLY
);
458 password
= trackdb_get_password(username
);
463 c
->last
= "no password";
464 disorder_error(0, "no password configured for user '%s'", username
);
467 return disorder_connect_generic(config
,
474 /** @brief Connect a client
476 * @param cookie Cookie to log in with, or NULL
477 * @return 0 on success, non-0 on error
479 * If @p cookie is NULL or does not work then we attempt to log in as
480 * guest instead (so when the cookie expires only an extra round trip
481 * is needed rathre than a complete new login).
483 int disorder_connect_cookie(disorder_client
*c
,
484 const char *cookie
) {
485 return disorder_connect_generic(config
,
492 /** @brief Close a client
494 * @return 0 on succcess, non-0 on errior
496 * The client is still closed even on error. It might well be
497 * appropriate to ignore the return value.
499 int disorder_close(disorder_client
*c
) {
503 if(fclose(c
->fpin
) < 0) {
504 byte_xasprintf((char **)&c
->last
, "fclose: %s", strerror(errno
));
505 disorder_error(errno
, "error calling fclose");
511 if(fclose(c
->fpout
) < 0) {
512 byte_xasprintf((char **)&c
->last
, "fclose: %s", strerror(errno
));
513 disorder_error(errno
, "error calling fclose");
525 /** @brief Play a track
527 * @param track Track to play (UTF-8)
528 * @return 0 on success, non-0 on error
530 int disorder_play(disorder_client
*c
, const char *track
) {
531 return disorder_simple(c
, 0, "play", track
, (char *)0);
534 /** @brief Remove a track
536 * @param track Track to remove (UTF-8)
537 * @return 0 on success, non-0 on error
539 int disorder_remove(disorder_client
*c
, const char *track
) {
540 return disorder_simple(c
, 0, "remove", track
, (char *)0);
543 /** @brief Move a track
545 * @param track Track to move (UTF-8)
546 * @param delta Distance to move by
547 * @return 0 on success, non-0 on error
549 int disorder_move(disorder_client
*c
, const char *track
, int delta
) {
552 byte_snprintf(d
, sizeof d
, "%d", delta
);
553 return disorder_simple(c
, 0, "move", track
, d
, (char *)0);
556 /** @brief Enable play
558 * @return 0 on success, non-0 on error
560 int disorder_enable(disorder_client
*c
) {
561 return disorder_simple(c
, 0, "enable", (char *)0);
564 /** @brief Disable play
566 * @return 0 on success, non-0 on error
568 int disorder_disable(disorder_client
*c
) {
569 return disorder_simple(c
, 0, "disable", (char *)0);
572 /** @brief Scratch the currently playing track
573 * @param id Playing track ID or NULL (UTF-8)
575 * @return 0 on success, non-0 on error
577 int disorder_scratch(disorder_client
*c
, const char *id
) {
578 return disorder_simple(c
, 0, "scratch", id
, (char *)0);
581 /** @brief Shut down the server
583 * @return 0 on success, non-0 on error
585 int disorder_shutdown(disorder_client
*c
) {
586 return disorder_simple(c
, 0, "shutdown", (char *)0);
589 /** @brief Make the server re-read its configuration
591 * @return 0 on success, non-0 on error
593 int disorder_reconfigure(disorder_client
*c
) {
594 return disorder_simple(c
, 0, "reconfigure", (char *)0);
597 /** @brief Rescan tracks
599 * @return 0 on success, non-0 on error
601 int disorder_rescan(disorder_client
*c
) {
602 return disorder_simple(c
, 0, "rescan", (char *)0);
605 /** @brief Get server version number
607 * @param rp Where to store version string (UTF-8)
608 * @return 0 on success, non-0 on error
610 int disorder_version(disorder_client
*c
, char **rp
) {
611 return dequote(disorder_simple(c
, rp
, "version", (char *)0), rp
);
614 static void client_error(const char *msg
,
615 void attribute((unused
)) *u
) {
616 disorder_error(0, "error parsing reply: %s", msg
);
619 /** @brief Get currently playing track
621 * @param qp Where to store track information
622 * @return 0 on success, non-0 on error
624 * @p qp gets NULL if no track is playing.
626 int disorder_playing(disorder_client
*c
, struct queue_entry
**qp
) {
628 struct queue_entry
*q
;
631 if((rc
= disorder_simple(c
, &r
, "playing", (char *)0)))
634 q
= xmalloc(sizeof *q
);
635 if(queue_unmarshall(q
, r
, client_error
, 0))
643 /** @brief Fetch the queue, recent list, etc */
644 static int disorder_somequeue(disorder_client
*c
,
645 const char *cmd
, struct queue_entry
**qp
) {
646 struct queue_entry
*qh
, **qt
= &qh
, *q
;
650 if((rc
= disorder_simple(c
, 0, cmd
, (char *)0)))
652 while(inputline(c
->ident
, c
->fpin
, &l
, '\n') >= 0) {
653 if(!strcmp(l
, ".")) {
658 q
= xmalloc(sizeof *q
);
659 if(!queue_unmarshall(q
, l
, client_error
, 0)) {
664 if(ferror(c
->fpin
)) {
665 byte_xasprintf((char **)&c
->last
, "input error: %s", strerror(errno
));
666 disorder_error(errno
, "error reading %s", c
->ident
);
668 c
->last
= "input error: unexpxected EOF";
669 disorder_error(0, "error reading %s: unexpected EOF", c
->ident
);
674 /** @brief Get recently played tracks
676 * @param qp Where to store track information
677 * @return 0 on success, non-0 on error
679 * The last entry in the list is the most recently played track.
681 int disorder_recent(disorder_client
*c
, struct queue_entry
**qp
) {
682 return disorder_somequeue(c
, "recent", qp
);
687 * @param qp Where to store track information
688 * @return 0 on success, non-0 on error
690 * The first entry in the list will be played next.
692 int disorder_queue(disorder_client
*c
, struct queue_entry
**qp
) {
693 return disorder_somequeue(c
, "queue", qp
);
696 /** @brief Read a dot-stuffed list
698 * @param vecp Where to store list (UTF-8)
699 * @param nvecp Where to store number of items, or NULL
700 * @return 0 on success, non-0 on error
702 * The list will have a final NULL not counted in @p nvecp.
704 static int readlist(disorder_client
*c
, char ***vecp
, int *nvecp
) {
709 while(inputline(c
->ident
, c
->fpin
, &l
, '\n') >= 0) {
710 if(!strcmp(l
, ".")) {
711 vector_terminate(&v
);
718 vector_append(&v
, xstrdup(l
+ (*l
== '.')));
721 if(ferror(c
->fpin
)) {
722 byte_xasprintf((char **)&c
->last
, "input error: %s", strerror(errno
));
723 disorder_error(errno
, "error reading %s", c
->ident
);
725 c
->last
= "input error: unexpxected EOF";
726 disorder_error(0, "error reading %s: unexpected EOF", c
->ident
);
731 /** @brief Issue a comamnd and get a list response
733 * @param vecp Where to store list (UTF-8)
734 * @param nvecp Where to store number of items, or NULL
736 * @return 0 on success, non-0 on error
738 * The remaining arguments are command arguments, terminated by (char
739 * *)0. They should be in UTF-8.
741 * 5xx responses count as errors.
743 * See disorder_simple().
745 static int disorder_simple_list(disorder_client
*c
,
746 char ***vecp
, int *nvecp
,
747 const char *cmd
, ...) {
752 ret
= disorder_simple_v(c
, 0, cmd
, 0, 0, ap
);
755 return readlist(c
, vecp
, nvecp
);
758 /** @brief List directories below @p dir
760 * @param dir Directory to list, or NULL for root (UTF-8)
761 * @param re Regexp that results must match, or NULL (UTF-8)
762 * @param vecp Where to store list (UTF-8)
763 * @param nvecp Where to store number of items, or NULL
764 * @return 0 on success, non-0 on error
766 int disorder_directories(disorder_client
*c
, const char *dir
, const char *re
,
767 char ***vecp
, int *nvecp
) {
768 return disorder_simple_list(c
, vecp
, nvecp
, "dirs", dir
, re
, (char *)0);
771 /** @brief List files below @p dir
773 * @param dir Directory to list, or NULL for root (UTF-8)
774 * @param re Regexp that results must match, or NULL (UTF-8)
775 * @param vecp Where to store list (UTF-8)
776 * @param nvecp Where to store number of items, or NULL
777 * @return 0 on success, non-0 on error
779 int disorder_files(disorder_client
*c
, const char *dir
, const char *re
,
780 char ***vecp
, int *nvecp
) {
781 return disorder_simple_list(c
, vecp
, nvecp
, "files", dir
, re
, (char *)0);
784 /** @brief List files and directories below @p dir
786 * @param dir Directory to list, or NULL for root (UTF-8)
787 * @param re Regexp that results must match, or NULL (UTF-8)
788 * @param vecp Where to store list (UTF-8)
789 * @param nvecp Where to store number of items, or NULL
790 * @return 0 on success, non-0 on error
792 int disorder_allfiles(disorder_client
*c
, const char *dir
, const char *re
,
793 char ***vecp
, int *nvecp
) {
794 return disorder_simple_list(c
, vecp
, nvecp
, "allfiles", dir
, re
, (char *)0);
797 /** @brief Return the user we logged in with
799 * @return User name (owned by @p c, don't modify)
801 char *disorder_user(disorder_client
*c
) {
805 /** @brief Set a track preference
807 * @param track Track name (UTF-8)
808 * @param key Preference name (UTF-8)
809 * @param value Preference value (UTF-8)
810 * @return 0 on success, non-0 on error
812 int disorder_set(disorder_client
*c
, const char *track
,
813 const char *key
, const char *value
) {
814 return disorder_simple(c
, 0, "set", track
, key
, value
, (char *)0);
817 /** @brief Unset a track preference
819 * @param track Track name (UTF-8)
820 * @param key Preference name (UTF-8)
821 * @return 0 on success, non-0 on error
823 int disorder_unset(disorder_client
*c
, const char *track
,
825 return disorder_simple(c
, 0, "unset", track
, key
, (char *)0);
828 /** @brief Get a track preference
830 * @param track Track name (UTF-8)
831 * @param key Preference name (UTF-8)
832 * @param valuep Where to store preference value (UTF-8)
833 * @return 0 on success, non-0 on error
835 int disorder_get(disorder_client
*c
,
836 const char *track
, const char *key
, char **valuep
) {
837 return dequote(disorder_simple(c
, valuep
, "get", track
, key
, (char *)0),
841 static void pref_error_handler(const char *msg
,
842 void attribute((unused
)) *u
) {
843 disorder_error(0, "error handling 'prefs' reply: %s", msg
);
846 /** @brief Get all preferences for a trcak
848 * @param track Track name
849 * @param kp Where to store linked list of preferences
850 * @return 0 on success, non-0 on error
852 int disorder_prefs(disorder_client
*c
, const char *track
, struct kvp
**kp
) {
854 int nvec
, npvec
, n
, rc
;
857 if((rc
= disorder_simple_list(c
, &vec
, &nvec
, "prefs", track
, (char *)0)))
859 for(n
= 0; n
< nvec
; ++n
) {
860 if(!(pvec
= split(vec
[n
], &npvec
, SPLIT_QUOTES
, pref_error_handler
, 0)))
863 pref_error_handler("malformed response", 0);
866 *kp
= k
= xmalloc(sizeof *k
);
875 /** @brief Parse a boolean response
876 * @param cmd Command for use in error messsage
877 * @param value Result from server
878 * @param flagp Where to store result
879 * @return 0 on success, non-0 on error
881 static int boolean(const char *cmd
, const char *value
,
883 if(!strcmp(value
, "yes")) *flagp
= 1;
884 else if(!strcmp(value
, "no")) *flagp
= 0;
886 disorder_error(0, "malformed response to '%s'", cmd
);
892 /** @brief Test whether a track exists
894 * @param track Track name (UTF-8)
895 * @param existsp Where to store result (non-0 iff does exist)
896 * @return 0 on success, non-0 on error
898 int disorder_exists(disorder_client
*c
, const char *track
, int *existsp
) {
902 if((rc
= disorder_simple(c
, &v
, "exists", track
, (char *)0)))
904 return boolean("exists", v
, existsp
);
907 /** @brief Test whether playing is enabled
909 * @param enabledp Where to store result (non-0 iff enabled)
910 * @return 0 on success, non-0 on error
912 int disorder_enabled(disorder_client
*c
, int *enabledp
) {
916 if((rc
= disorder_simple(c
, &v
, "enabled", (char *)0)))
918 return boolean("enabled", v
, enabledp
);
921 /** @brief Get the length of a track
923 * @param track Track name (UTF-8)
924 * @param valuep Where to store length in seconds
925 * @return 0 on success, non-0 on error
927 * If the length is unknown 0 is returned.
929 int disorder_length(disorder_client
*c
, const char *track
,
934 if((rc
= disorder_simple(c
, &value
, "length", track
, (char *)0)))
936 *valuep
= atol(value
);
940 /** @brief Search for tracks
942 * @param terms Search terms (UTF-8)
943 * @param vecp Where to store list (UTF-8)
944 * @param nvecp Where to store number of items, or NULL
945 * @return 0 on success, non-0 on error
947 int disorder_search(disorder_client
*c
, const char *terms
,
948 char ***vecp
, int *nvecp
) {
949 return disorder_simple_list(c
, vecp
, nvecp
, "search", terms
, (char *)0);
952 /** @brief Enable random play
954 * @return 0 on success, non-0 on error
956 int disorder_random_enable(disorder_client
*c
) {
957 return disorder_simple(c
, 0, "random-enable", (char *)0);
960 /** @brief Disable random play
962 * @return 0 on success, non-0 on error
964 int disorder_random_disable(disorder_client
*c
) {
965 return disorder_simple(c
, 0, "random-disable", (char *)0);
968 /** @brief Test whether random play is enabled
970 * @param enabledp Where to store result (non-0 iff enabled)
971 * @return 0 on success, non-0 on error
973 int disorder_random_enabled(disorder_client
*c
, int *enabledp
) {
977 if((rc
= disorder_simple(c
, &v
, "random-enabled", (char *)0)))
979 return boolean("random-enabled", v
, enabledp
);
982 /** @brief Get server stats
984 * @param vecp Where to store list (UTF-8)
985 * @param nvecp Where to store number of items, or NULL
986 * @return 0 on success, non-0 on error
988 int disorder_stats(disorder_client
*c
,
989 char ***vecp
, int *nvecp
) {
990 return disorder_simple_list(c
, vecp
, nvecp
, "stats", (char *)0);
993 /** @brief Set volume
995 * @param left New left channel value
996 * @param right New right channel value
997 * @return 0 on success, non-0 on error
999 int disorder_set_volume(disorder_client
*c
, int left
, int right
) {
1002 if(byte_asprintf(&ls
, "%d", left
) < 0
1003 || byte_asprintf(&rs
, "%d", right
) < 0)
1005 return disorder_simple(c
, 0, "volume", ls
, rs
, (char *)0);
1008 /** @brief Get volume
1010 * @param left Where to store left channel value
1011 * @param right Where to store right channel value
1012 * @return 0 on success, non-0 on error
1014 int disorder_get_volume(disorder_client
*c
, int *left
, int *right
) {
1018 if((rc
= disorder_simple(c
, &r
, "volume", (char *)0)))
1020 if(sscanf(r
, "%d %d", left
, right
) != 2) {
1021 c
->last
= "malformed volume response";
1022 disorder_error(0, "error parsing response to 'volume': '%s'", r
);
1028 /** @brief Log to a sink
1030 * @param s Sink to write log lines to
1031 * @return 0 on success, non-0 on error
1033 int disorder_log(disorder_client
*c
, struct sink
*s
) {
1037 if((rc
= disorder_simple(c
, 0, "log", (char *)0)))
1039 while(inputline(c
->ident
, c
->fpin
, &l
, '\n') >= 0 && strcmp(l
, "."))
1040 if(sink_printf(s
, "%s\n", l
) < 0) return -1;
1041 if(ferror(c
->fpin
) || feof(c
->fpin
)) {
1042 byte_xasprintf((char **)&c
->last
, "input error: %s",
1043 ferror(c
->fpin
) ?
strerror(errno
) : "unexpxected EOF");
1049 /** @brief Look up a track name part
1051 * @param partp Where to store result (UTF-8)
1052 * @param track Track name (UTF-8)
1053 * @param context Context (usually "sort" or "display") (UTF-8)
1054 * @param part Track part (UTF-8)
1055 * @return 0 on success, non-0 on error
1057 int disorder_part(disorder_client
*c
, char **partp
,
1058 const char *track
, const char *context
, const char *part
) {
1059 return dequote(disorder_simple(c
, partp
, "part",
1060 track
, context
, part
, (char *)0), partp
);
1063 /** @brief Resolve aliases
1065 * @param trackp Where to store canonical name (UTF-8)
1066 * @param track Track name (UTF-8)
1067 * @return 0 on success, non-0 on error
1069 int disorder_resolve(disorder_client
*c
, char **trackp
, const char *track
) {
1070 return dequote(disorder_simple(c
, trackp
, "resolve", track
, (char *)0),
1074 /** @brief Pause the current track
1076 * @return 0 on success, non-0 on error
1078 int disorder_pause(disorder_client
*c
) {
1079 return disorder_simple(c
, 0, "pause", (char *)0);
1082 /** @brief Resume the current track
1084 * @return 0 on success, non-0 on error
1086 int disorder_resume(disorder_client
*c
) {
1087 return disorder_simple(c
, 0, "resume", (char *)0);
1090 /** @brief List all known tags
1092 * @param vecp Where to store list (UTF-8)
1093 * @param nvecp Where to store number of items, or NULL
1094 * @return 0 on success, non-0 on error
1096 int disorder_tags(disorder_client
*c
,
1097 char ***vecp
, int *nvecp
) {
1098 return disorder_simple_list(c
, vecp
, nvecp
, "tags", (char *)0);
1101 /** @brief List all known users
1103 * @param vecp Where to store list (UTF-8)
1104 * @param nvecp Where to store number of items, or NULL
1105 * @return 0 on success, non-0 on error
1107 int disorder_users(disorder_client
*c
,
1108 char ***vecp
, int *nvecp
) {
1109 return disorder_simple_list(c
, vecp
, nvecp
, "users", (char *)0);
1112 /** @brief Get recently added tracks
1114 * @param vecp Where to store pointer to list (UTF-8)
1115 * @param nvecp Where to store count
1116 * @param max Maximum tracks to fetch, or 0 for all available
1117 * @return 0 on success, non-0 on error
1119 int disorder_new_tracks(disorder_client
*c
,
1120 char ***vecp
, int *nvecp
,
1124 sprintf(limit
, "%d", max
);
1125 return disorder_simple_list(c
, vecp
, nvecp
, "new", limit
, (char *)0);
1128 /** @brief Set a global preference
1130 * @param key Preference name (UTF-8)
1131 * @param value Preference value (UTF-8)
1132 * @return 0 on success, non-0 on error
1134 int disorder_set_global(disorder_client
*c
,
1135 const char *key
, const char *value
) {
1136 return disorder_simple(c
, 0, "set-global", key
, value
, (char *)0);
1139 /** @brief Unset a global preference
1141 * @param key Preference name (UTF-8)
1142 * @return 0 on success, non-0 on error
1144 int disorder_unset_global(disorder_client
*c
, const char *key
) {
1145 return disorder_simple(c
, 0, "unset-global", key
, (char *)0);
1148 /** @brief Get a global preference
1150 * @param key Preference name (UTF-8)
1151 * @param valuep Where to store preference value (UTF-8)
1152 * @return 0 on success, non-0 on error
1154 int disorder_get_global(disorder_client
*c
, const char *key
, char **valuep
) {
1155 return dequote(disorder_simple(c
, valuep
, "get-global", key
, (char *)0),
1159 /** @brief Get server's RTP address information
1161 * @param addressp Where to store address (UTF-8)
1162 * @param portp Where to store port (UTF-8)
1163 * @return 0 on success, non-0 on error
1165 int disorder_rtp_address(disorder_client
*c
, char **addressp
, char **portp
) {
1170 if((rc
= disorder_simple(c
, &r
, "rtp-address", (char *)0)))
1172 vec
= split(r
, &n
, SPLIT_QUOTES
, 0, 0);
1174 c
->last
= "malformed RTP address";
1175 disorder_error(0, "malformed rtp-address reply");
1183 /** @brief Create a user
1185 * @param user Username
1186 * @param password Password
1187 * @param rights Initial rights or NULL to use default
1188 * @return 0 on success, non-0 on error
1190 int disorder_adduser(disorder_client
*c
,
1191 const char *user
, const char *password
,
1192 const char *rights
) {
1193 return disorder_simple(c
, 0, "adduser", user
, password
, rights
, (char *)0);
1196 /** @brief Delete a user
1198 * @param user Username
1199 * @return 0 on success, non-0 on error
1201 int disorder_deluser(disorder_client
*c
, const char *user
) {
1202 return disorder_simple(c
, 0, "deluser", user
, (char *)0);
1205 /** @brief Get user information
1207 * @param user Username
1208 * @param key Property name (UTF-8)
1209 * @param valuep Where to store value (UTF-8)
1210 * @return 0 on success, non-0 on error
1212 int disorder_userinfo(disorder_client
*c
, const char *user
, const char *key
,
1214 return dequote(disorder_simple(c
, valuep
, "userinfo", user
, key
, (char *)0),
1218 /** @brief Set user information
1220 * @param user Username
1221 * @param key Property name (UTF-8)
1222 * @param value New property value (UTF-8)
1223 * @return 0 on success, non-0 on error
1225 int disorder_edituser(disorder_client
*c
, const char *user
,
1226 const char *key
, const char *value
) {
1227 return disorder_simple(c
, 0, "edituser", user
, key
, value
, (char *)0);
1230 /** @brief Register a user
1232 * @param user Username
1233 * @param password Password
1234 * @param email Email address (UTF-8)
1235 * @param confirmp Where to store confirmation string
1236 * @return 0 on success, non-0 on error
1238 int disorder_register(disorder_client
*c
, const char *user
,
1239 const char *password
, const char *email
,
1241 return dequote(disorder_simple(c
, confirmp
, "register",
1242 user
, password
, email
, (char *)0),
1246 /** @brief Confirm a user
1248 * @param confirm Confirmation string
1249 * @return 0 on success, non-0 on error
1251 int disorder_confirm(disorder_client
*c
, const char *confirm
) {
1255 if(!(rc
= dequote(disorder_simple(c
, &u
, "confirm", confirm
, (char *)0),
1261 /** @brief Make a cookie for this login
1263 * @param cookiep Where to store cookie string
1264 * @return 0 on success, non-0 on error
1266 int disorder_make_cookie(disorder_client
*c
, char **cookiep
) {
1267 return dequote(disorder_simple(c
, cookiep
, "make-cookie", (char *)0),
1271 /** @brief Revoke the cookie used by this session
1273 * @return 0 on success, non-0 on error
1275 int disorder_revoke(disorder_client
*c
) {
1276 return disorder_simple(c
, 0, "revoke", (char *)0);
1279 /** @brief Request a password reminder email
1281 * @param user Username
1282 * @return 0 on success, non-0 on error
1284 int disorder_reminder(disorder_client
*c
, const char *user
) {
1285 return disorder_simple(c
, 0, "reminder", user
, (char *)0);
1288 /** @brief List scheduled events
1290 * @param idsp Where to put list of event IDs
1291 * @param nidsp Where to put count of event IDs, or NULL
1292 * @return 0 on success, non-0 on error
1294 int disorder_schedule_list(disorder_client
*c
, char ***idsp
, int *nidsp
) {
1295 return disorder_simple_list(c
, idsp
, nidsp
, "schedule-list", (char *)0);
1298 /** @brief Delete a scheduled event
1300 * @param id Event ID to delete
1301 * @return 0 on success, non-0 on error
1303 int disorder_schedule_del(disorder_client
*c
, const char *id
) {
1304 return disorder_simple(c
, 0, "schedule-del", id
, (char *)0);
1307 /** @brief Get details of a scheduled event
1309 * @param id Event ID
1310 * @param actiondatap Where to put details
1311 * @return 0 on success, non-0 on error
1313 int disorder_schedule_get(disorder_client
*c
, const char *id
,
1314 struct kvp
**actiondatap
) {
1315 char **lines
, **bits
;
1319 if((rc
= disorder_simple_list(c
, &lines
, NULL
,
1320 "schedule-get", id
, (char *)0)))
1323 if(!(bits
= split(*lines
++, &nbits
, SPLIT_QUOTES
, 0, 0))) {
1324 disorder_error(0, "invalid schedule-get reply: cannot split line");
1328 disorder_error(0, "invalid schedule-get reply: wrong number of fields");
1331 kvp_set(actiondatap
, bits
[0], bits
[1]);
1336 /** @brief Add a scheduled event
1338 * @param when When to trigger the event
1339 * @param priority Event priority ("normal" or "junk")
1340 * @param action What action to perform
1341 * @param ... Action-specific arguments
1342 * @return 0 on success, non-0 on error
1344 * For action @c "play" the next argument is the track.
1346 * For action @c "set-global" next argument is the global preference name
1347 * and the final argument the value to set it to, or (char *)0 to unset it.
1349 int disorder_schedule_add(disorder_client
*c
,
1351 const char *priority
,
1358 snprintf(when_str
, sizeof when_str
, "%lld", (long long)when
);
1359 va_start(ap
, action
);
1360 if(!strcmp(action
, "play"))
1361 rc
= disorder_simple(c
, 0, "schedule-add", when_str
, priority
,
1362 action
, va_arg(ap
, char *),
1364 else if(!strcmp(action
, "set-global")) {
1365 const char *key
= va_arg(ap
, char *);
1366 const char *value
= va_arg(ap
, char *);
1367 rc
= disorder_simple(c
, 0,"schedule-add", when_str
, priority
,
1371 disorder_fatal(0, "unknown action '%s'", action
);
1376 /** @brief Adopt a track
1378 * @param id Track ID to adopt
1379 * @return 0 on success, non-0 on error
1381 int disorder_adopt(disorder_client
*c
, const char *id
) {
1382 return disorder_simple(c
, 0, "adopt", id
, (char *)0);
1385 /** @brief Delete a playlist
1387 * @param playlist Playlist to delete
1388 * @return 0 on success, non-0 on error
1390 int disorder_playlist_delete(disorder_client
*c
,
1391 const char *playlist
) {
1392 return disorder_simple(c
, 0, "playlist-delete", playlist
, (char *)0);
1395 /** @brief Get the contents of a playlist
1397 * @param playlist Playlist to get
1398 * @param tracksp Where to put list of tracks
1399 * @param ntracksp Where to put count of tracks
1400 * @return 0 on success, non-0 on error
1402 int disorder_playlist_get(disorder_client
*c
, const char *playlist
,
1403 char ***tracksp
, int *ntracksp
) {
1404 return disorder_simple_list(c
, tracksp
, ntracksp
,
1405 "playlist-get", playlist
, (char *)0);
1408 /** @brief List all readable playlists
1410 * @param playlistsp Where to put list of playlists
1411 * @param nplaylistsp Where to put count of playlists
1412 * @return 0 on success, non-0 on error
1414 int disorder_playlists(disorder_client
*c
,
1415 char ***playlistsp
, int *nplaylistsp
) {
1416 return disorder_simple_list(c
, playlistsp
, nplaylistsp
,
1417 "playlists", (char *)0);
1420 /** @brief Get the sharing status of a playlist
1422 * @param playlist Playlist to inspect
1423 * @param sharep Where to put sharing status
1424 * @return 0 on success, non-0 on error
1426 * Possible @p sharep values are @c public, @c private and @c shared.
1428 int disorder_playlist_get_share(disorder_client
*c
, const char *playlist
,
1430 return disorder_simple(c
, sharep
,
1431 "playlist-get-share", playlist
, (char *)0);
1434 /** @brief Get the sharing status of a playlist
1436 * @param playlist Playlist to modify
1437 * @param share New sharing status
1438 * @return 0 on success, non-0 on error
1440 * Possible @p share values are @c public, @c private and @c shared.
1442 int disorder_playlist_set_share(disorder_client
*c
, const char *playlist
,
1443 const char *share
) {
1444 return disorder_simple(c
, 0,
1445 "playlist-set-share", playlist
, share
, (char *)0);
1448 /** @brief Lock a playlist for modifications
1450 * @param playlist Playlist to lock
1451 * @return 0 on success, non-0 on error
1453 int disorder_playlist_lock(disorder_client
*c
, const char *playlist
) {
1454 return disorder_simple(c
, 0,
1455 "playlist-lock", playlist
, (char *)0);
1458 /** @brief Unlock the locked playlist
1460 * @return 0 on success, non-0 on error
1462 int disorder_playlist_unlock(disorder_client
*c
) {
1463 return disorder_simple(c
, 0,
1464 "playlist-unlock", (char *)0);
1467 /** @brief Set the contents of a playlst
1469 * @param playlist Playlist to modify
1470 * @param tracks List of tracks
1471 * @param ntracks Length of @p tracks (or -1 to count up to the first NULL)
1472 * @return 0 on success, non-0 on error
1474 int disorder_playlist_set(disorder_client
*c
,
1475 const char *playlist
,
1478 return disorder_simple_body(c
, 0, tracks
, ntracks
,
1479 "playlist-set", playlist
, (char *)0);