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 Move a track
536 * @param track Track to move (UTF-8)
537 * @param delta Distance to move by
538 * @return 0 on success, non-0 on error
540 int disorder_move(disorder_client *c, const char *track, int delta) {
543 byte_snprintf(d, sizeof d, "%d", delta);
544 return disorder_simple(c, 0, "move", track, d, (char *)0);
547 static void client_error(const char *msg,
548 void attribute((unused)) *u) {
549 disorder_error(0, "error parsing reply: %s", msg);
552 /** @brief Get currently playing track
554 * @param qp Where to store track information
555 * @return 0 on success, non-0 on error
557 * @p qp gets NULL if no track is playing.
559 int disorder_playing(disorder_client *c, struct queue_entry **qp) {
561 struct queue_entry *q;
564 if((rc = disorder_simple(c, &r, "playing", (char *)0)))
567 q = xmalloc(sizeof *q);
568 if(queue_unmarshall(q, r, client_error, 0))
576 /** @brief Fetch the queue, recent list, etc */
577 static int disorder_somequeue(disorder_client *c,
578 const char *cmd, struct queue_entry **qp) {
579 struct queue_entry *qh, **qt = &qh, *q;
583 if((rc = disorder_simple(c, 0, cmd, (char *)0)))
585 while(inputline(c->ident, c->fpin, &l, '\n') >= 0) {
586 if(!strcmp(l, ".")) {
592 q = xmalloc(sizeof *q);
593 if(!queue_unmarshall(q, l, client_error, 0)) {
599 if(ferror(c->fpin)) {
600 byte_xasprintf((char **)&c->last, "input error: %s", strerror(errno));
601 disorder_error(errno, "error reading %s", c->ident);
603 c->last = "input error: unexpxected EOF";
604 disorder_error(0, "error reading %s: unexpected EOF", c->ident);
609 /** @brief Get recently played tracks
611 * @param qp Where to store track information
612 * @return 0 on success, non-0 on error
614 * The last entry in the list is the most recently played track.
616 int disorder_recent(disorder_client *c, struct queue_entry **qp) {
617 return disorder_somequeue(c, "recent", qp);
622 * @param qp Where to store track information
623 * @return 0 on success, non-0 on error
625 * The first entry in the list will be played next.
627 int disorder_queue(disorder_client *c, struct queue_entry **qp) {
628 return disorder_somequeue(c, "queue", qp);
631 /** @brief Read a dot-stuffed list
633 * @param vecp Where to store list (UTF-8)
634 * @param nvecp Where to store number of items, or NULL
635 * @return 0 on success, non-0 on error
637 * The list will have a final NULL not counted in @p nvecp.
639 static int readlist(disorder_client *c, char ***vecp, int *nvecp) {
644 while(inputline(c->ident, c->fpin, &l, '\n') >= 0) {
645 if(!strcmp(l, ".")) {
646 vector_terminate(&v);
653 vector_append(&v, xstrdup(l + (*l == '.')));
656 if(ferror(c->fpin)) {
657 byte_xasprintf((char **)&c->last, "input error: %s", strerror(errno));
658 disorder_error(errno, "error reading %s", c->ident);
660 c->last = "input error: unexpxected EOF";
661 disorder_error(0, "error reading %s: unexpected EOF", c->ident);
666 /** @brief Issue a comamnd and get a list response
668 * @param vecp Where to store list (UTF-8)
669 * @param nvecp Where to store number of items, or NULL
671 * @return 0 on success, non-0 on error
673 * The remaining arguments are command arguments, terminated by (char
674 * *)0. They should be in UTF-8.
676 * 5xx responses count as errors.
678 * See disorder_simple().
680 static int disorder_simple_list(disorder_client *c,
681 char ***vecp, int *nvecp,
682 const char *cmd, ...) {
687 ret = disorder_simple_v(c, 0, cmd, 0, 0, ap);
690 return readlist(c, vecp, nvecp);
693 /** @brief Return the user we logged in with
695 * @return User name (owned by @p c, don't modify)
697 char *disorder_user(disorder_client *c) {
701 static void pref_error_handler(const char *msg,
702 void attribute((unused)) *u) {
703 disorder_error(0, "error handling 'prefs' reply: %s", msg);
706 /** @brief Get all preferences for a trcak
708 * @param track Track name
709 * @param kp Where to store linked list of preferences
710 * @return 0 on success, non-0 on error
712 int disorder_prefs(disorder_client *c, const char *track, struct kvp **kp) {
714 int nvec, npvec, n, rc;
717 if((rc = disorder_simple_list(c, &vec, &nvec, "prefs", track, (char *)0)))
719 for(n = 0; n < nvec; ++n) {
720 if(!(pvec = split(vec[n], &npvec, SPLIT_QUOTES, pref_error_handler, 0)))
723 pref_error_handler("malformed response", 0);
726 *kp = k = xmalloc(sizeof *k);
732 free_strings(nvec, vec);
737 /** @brief Parse a boolean response
738 * @param cmd Command for use in error messsage
739 * @param value Result from server
740 * @param flagp Where to store result
741 * @return 0 on success, non-0 on error
743 static int boolean(const char *cmd, const char *value,
745 if(!strcmp(value, "yes")) *flagp = 1;
746 else if(!strcmp(value, "no")) *flagp = 0;
748 disorder_error(0, "malformed response to '%s'", cmd);
754 /** @brief Get the length of a track
756 * @param track Track name (UTF-8)
757 * @param valuep Where to store length in seconds
758 * @return 0 on success, non-0 on error
760 * If the length is unknown 0 is returned.
762 int disorder_length(disorder_client *c, const char *track,
767 if((rc = disorder_simple(c, &value, "length", track, (char *)0)))
769 *valuep = atol(value);
773 /** @brief Set volume
775 * @param left New left channel value
776 * @param right New right channel value
777 * @return 0 on success, non-0 on error
779 int disorder_set_volume(disorder_client *c, int left, int right) {
782 if(byte_asprintf(&ls, "%d", left) < 0
783 || byte_asprintf(&rs, "%d", right) < 0)
785 return disorder_simple(c, 0, "volume", ls, rs, (char *)0);
788 /** @brief Get volume
790 * @param left Where to store left channel value
791 * @param right Where to store right channel value
792 * @return 0 on success, non-0 on error
794 int disorder_get_volume(disorder_client *c, int *left, int *right) {
798 if((rc = disorder_simple(c, &r, "volume", (char *)0)))
800 if(sscanf(r, "%d %d", left, right) != 2) {
801 c->last = "malformed volume response";
802 disorder_error(0, "error parsing response to 'volume': '%s'", r);
808 /** @brief Log to a sink
810 * @param s Sink to write log lines to
811 * @return 0 on success, non-0 on error
813 int disorder_log(disorder_client *c, struct sink *s) {
817 if((rc = disorder_simple(c, 0, "log", (char *)0)))
819 while(inputline(c->ident, c->fpin, &l, '\n') >= 0 && strcmp(l, "."))
820 if(sink_printf(s, "%s\n", l) < 0) return -1;
821 if(ferror(c->fpin) || feof(c->fpin)) {
822 byte_xasprintf((char **)&c->last, "input error: %s",
823 ferror(c->fpin) ? strerror(errno) : "unexpxected EOF");
829 /** @brief Get recently added tracks
831 * @param vecp Where to store pointer to list (UTF-8)
832 * @param nvecp Where to store count
833 * @param max Maximum tracks to fetch, or 0 for all available
834 * @return 0 on success, non-0 on error
836 int disorder_new_tracks(disorder_client *c,
837 char ***vecp, int *nvecp,
841 sprintf(limit, "%d", max);
842 return disorder_simple_list(c, vecp, nvecp, "new", limit, (char *)0);
845 /** @brief Get server's RTP address information
847 * @param addressp Where to store address (UTF-8)
848 * @param portp Where to store port (UTF-8)
849 * @return 0 on success, non-0 on error
851 int disorder_rtp_address(disorder_client *c, char **addressp, char **portp) {
856 if((rc = disorder_simple(c, &r, "rtp-address", (char *)0)))
858 vec = split(r, &n, SPLIT_QUOTES, 0, 0);
860 c->last = "malformed RTP address";
861 disorder_error(0, "malformed rtp-address reply");
869 /** @brief Get details of a scheduled event
872 * @param actiondatap Where to put details
873 * @return 0 on success, non-0 on error
875 int disorder_schedule_get(disorder_client *c, const char *id,
876 struct kvp **actiondatap) {
877 char **lines, **bits;
881 if((rc = disorder_simple_list(c, &lines, NULL,
882 "schedule-get", id, (char *)0)))
885 if(!(bits = split(*lines++, &nbits, SPLIT_QUOTES, 0, 0))) {
886 disorder_error(0, "invalid schedule-get reply: cannot split line");
890 disorder_error(0, "invalid schedule-get reply: wrong number of fields");
893 kvp_set(actiondatap, bits[0], bits[1]);
898 /** @brief Add a scheduled event
900 * @param when When to trigger the event
901 * @param priority Event priority ("normal" or "junk")
902 * @param action What action to perform
903 * @param ... Action-specific arguments
904 * @return 0 on success, non-0 on error
906 * For action @c "play" the next argument is the track.
908 * For action @c "set-global" next argument is the global preference name
909 * and the final argument the value to set it to, or (char *)0 to unset it.
911 int disorder_schedule_add(disorder_client *c,
913 const char *priority,
920 snprintf(when_str, sizeof when_str, "%lld", (long long)when);
921 va_start(ap, action);
922 if(!strcmp(action, "play"))
923 rc = disorder_simple(c, 0, "schedule-add", when_str, priority,
924 action, va_arg(ap, char *),
926 else if(!strcmp(action, "set-global")) {
927 const char *key = va_arg(ap, char *);
928 const char *value = va_arg(ap, char *);
929 rc = disorder_simple(c, 0,"schedule-add", when_str, priority,
933 disorder_fatal(0, "unknown action '%s'", action);
938 /** @brief Set the contents of a playlst
940 * @param playlist Playlist to modify
941 * @param tracks List of tracks
942 * @param ntracks Length of @p tracks (or -1 to count up to the first NULL)
943 * @return 0 on success, non-0 on error
945 int disorder_playlist_set(disorder_client *c,
946 const char *playlist,
949 return disorder_simple_body(c, 0, tracks, ntracks,
950 "playlist-set", playlist, (char *)0);
953 #include "client-stubs.c"