c96e2f3982b5ab424964412266ec42d0939a16c8
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 Marker for a command body */
155 static const char disorder_body
[1];
157 /** @brief Marker for a list of args */
158 static const char disorder_list
[1];
160 /** @brief Issue a command and parse a simple response
162 * @param rp Where to store result, or NULL
164 * @param ap Arguments (UTF-8), terminated by (char *)0
165 * @return 0 on success, non-0 on error
167 * 5xx responses count as errors.
169 * @p rp will NOT be filled in for xx9 responses (where it is just
170 * commentary for a command where it would normally be meaningful).
172 * NB that the response will NOT be converted to the local encoding
173 * nor will quotes be stripped. See dequote().
175 * Put @ref disorder_body in the argument list followed by a char **
176 * and int giving the body to follow the command. If the int is @c -1
177 * then the list is assumed to be NULL-terminated. This may be used
180 * Put @ref disorder_list in the argument list followed by a char **
181 * and int giving a list of arguments to include. If the int is @c -1
182 * then the list is assumed to be NULL-terminated. This may be used
183 * any number of times.
185 * Usually you would call this via one of the following interfaces:
186 * - disorder_simple()
187 * - disorder_simple_list()
189 static int disorder_simple_v(disorder_client
*c
,
200 c
->last
= "not connected";
201 disorder_error(0, "not connected to server");
206 dynstr_append_string(&d
, cmd
);
207 while((arg
= va_arg(ap
, const char *))) {
208 if(arg
== disorder_body
) {
209 body
= va_arg(ap
, char **);
210 nbody
= va_arg(ap
, int);
212 } else if(arg
== disorder_list
) {
213 char **list
= va_arg(ap
, char **);
214 int nlist
= va_arg(ap
, int);
216 for(nlist
= 0; list
[nlist
]; ++nlist
)
219 for(int n
= 0; n
< nlist
; ++n
) {
220 dynstr_append(&d
, ' ');
221 dynstr_append_string(&d
, quoteutf8(arg
));
224 dynstr_append(&d
, ' ');
225 dynstr_append_string(&d
, quoteutf8(arg
));
228 dynstr_append(&d
, '\n');
229 dynstr_terminate(&d
);
230 D(("command: %s", d
.vec
));
231 if(fputs(d
.vec
, c
->fpout
) < 0)
236 for(nbody
= 0; body
[nbody
]; ++nbody
)
238 for(int n
= 0; n
< nbody
; ++n
) {
239 if(body
[n
][0] == '.')
240 if(fputc('.', c
->fpout
) < 0)
242 if(fputs(body
[n
], c
->fpout
) < 0)
244 if(fputc('\n', c
->fpout
) < 0)
247 if(fputs(".\n", c
->fpout
) < 0)
253 return check_response(c
, rp
);
255 byte_xasprintf((char **)&c
->last
, "write error: %s", strerror(errno
));
256 disorder_error(errno
, "error writing to %s", c
->ident
);
260 /** @brief Issue a command and parse a simple response
262 * @param rp Where to store result, or NULL (UTF-8)
264 * @return 0 on success, non-0 on error
266 * The remaining arguments are command arguments, terminated by (char
267 * *)0. They should be in UTF-8.
269 * 5xx responses count as errors.
271 * @p rp will NOT be filled in for xx9 responses (where it is just
272 * commentary for a command where it would normally be meaningful).
274 * NB that the response will NOT be converted to the local encoding
275 * nor will quotes be stripped. See dequote().
277 static int disorder_simple(disorder_client
*c
,
279 const char *cmd
, ...) {
284 ret
= disorder_simple_v(c
, rp
, cmd
, ap
);
289 /** @brief Dequote a result string
290 * @param rc 0 on success, non-0 on error
291 * @param rp Where result string is stored (UTF-8)
294 * This is used as a wrapper around disorder_simple() to dequote
297 static int dequote(int rc
, char **rp
) {
301 if((rr
= split(*rp
, 0, SPLIT_QUOTES
, 0, 0)) && *rr
) {
307 disorder_error(0, "invalid reply: %s", *rp
);
312 /** @brief Generic connection routine
313 * @param conf Configuration to follow
315 * @param username Username to log in with or NULL
316 * @param password Password to log in with or NULL
317 * @param cookie Cookie to log in with or NULL
318 * @return 0 on success, non-0 on error
320 * @p cookie is tried first if not NULL. If it is NULL then @p
321 * username must not be. If @p username is not NULL then nor may @p
324 int disorder_connect_generic(struct config
*conf
,
326 const char *username
,
327 const char *password
,
328 const char *cookie
) {
329 int fd
= -1, fd2
= -1, nrvec
= 0, rc
;
330 unsigned char *nonce
= NULL
;
333 char *r
= NULL
, **rvec
= NULL
;
334 const char *protocol
, *algorithm
, *challenge
;
335 struct sockaddr
*sa
= NULL
;
338 if((salen
= find_server(conf
, &sa
, &c
->ident
)) == (socklen_t
)-1)
340 c
->fpin
= c
->fpout
= 0;
341 if((fd
= socket(sa
->sa_family
, SOCK_STREAM
, 0)) < 0) {
342 byte_xasprintf((char **)&c
->last
, "socket: %s", strerror(errno
));
343 disorder_error(errno
, "error calling socket");
346 if(connect(fd
, sa
, salen
) < 0) {
347 byte_xasprintf((char **)&c
->last
, "connect: %s", strerror(errno
));
348 disorder_error(errno
, "error calling connect");
351 if((fd2
= dup(fd
)) < 0) {
352 byte_xasprintf((char **)&c
->last
, "dup: %s", strerror(errno
));
353 disorder_error(errno
, "error calling dup");
356 if(!(c
->fpin
= fdopen(fd
, "rb"))) {
357 byte_xasprintf((char **)&c
->last
, "fdopen: %s", strerror(errno
));
358 disorder_error(errno
, "error calling fdopen");
362 if(!(c
->fpout
= fdopen(fd2
, "wb"))) {
363 byte_xasprintf((char **)&c
->last
, "fdopen: %s", strerror(errno
));
364 disorder_error(errno
, "error calling fdopen");
368 if((rc
= disorder_simple(c
, &r
, 0, (const char *)0)))
370 if(!(rvec
= split(r
, &nrvec
, SPLIT_QUOTES
, 0, 0)))
373 c
->last
= "cannot parse server greeting";
374 disorder_error(0, "cannot parse server greeting %s", r
);
378 if(strcmp(protocol
, "2")) {
379 c
->last
= "unknown protocol version";
380 disorder_error(0, "unknown protocol version: %s", protocol
);
385 if(!(nonce
= unhex(challenge
, &nl
)))
388 if(!dequote(disorder_simple(c
, &c
->user
, "cookie", cookie
, (char *)0),
390 return 0; /* success */
392 c
->last
= "cookie failed and no username";
393 disorder_error(0, "cookie did not work and no username available");
397 if(!(res
= authhash(nonce
, nl
, password
, algorithm
))) {
398 c
->last
= "error computing authorization hash";
401 if((rc
= disorder_simple(c
, 0, "user", username
, res
, (char *)0)))
403 c
->user
= xstrdup(username
);
405 free_strings(nrvec
, rvec
);
421 if(fd2
!= -1) close(fd2
);
422 if(fd
!= -1) close(fd
);
426 /** @brief Connect a client with a specified username and password
428 * @param username Username to log in with
429 * @param password Password to log in with
430 * @return 0 on success, non-0 on error
432 int disorder_connect_user(disorder_client
*c
,
433 const char *username
,
434 const char *password
) {
435 return disorder_connect_generic(config
,
442 /** @brief Connect a client
444 * @return 0 on success, non-0 on error
446 * The connection will use the username and password found in @ref
447 * config, or directly from the database if no password is found and
448 * the database is readable (usually only for root).
450 int disorder_connect(disorder_client
*c
) {
451 const char *username
, *password
;
453 if(!(username
= config
->username
)) {
454 c
->last
= "no username";
455 disorder_error(0, "no username configured");
458 password
= config
->password
;
459 /* Maybe we can read the database */
460 if(!password
&& trackdb_readable()) {
461 trackdb_init(TRACKDB_NO_RECOVER
|TRACKDB_NO_UPGRADE
);
462 trackdb_open(TRACKDB_READ_ONLY
);
463 password
= trackdb_get_password(username
);
468 c
->last
= "no password";
469 disorder_error(0, "no password configured for user '%s'", username
);
472 return disorder_connect_generic(config
,
479 /** @brief Connect a client
481 * @param cookie Cookie to log in with, or NULL
482 * @return 0 on success, non-0 on error
484 * If @p cookie is NULL or does not work then we attempt to log in as
485 * guest instead (so when the cookie expires only an extra round trip
486 * is needed rathre than a complete new login).
488 int disorder_connect_cookie(disorder_client
*c
,
489 const char *cookie
) {
490 return disorder_connect_generic(config
,
497 /** @brief Close a client
499 * @return 0 on succcess, non-0 on errior
501 * The client is still closed even on error. It might well be
502 * appropriate to ignore the return value.
504 int disorder_close(disorder_client
*c
) {
508 if(fclose(c
->fpin
) < 0) {
509 byte_xasprintf((char **)&c
->last
, "fclose: %s", strerror(errno
));
510 disorder_error(errno
, "error calling fclose");
516 if(fclose(c
->fpout
) < 0) {
517 byte_xasprintf((char **)&c
->last
, "fclose: %s", strerror(errno
));
518 disorder_error(errno
, "error calling fclose");
530 static void client_error(const char *msg
,
531 void attribute((unused
)) *u
) {
532 disorder_error(0, "error parsing reply: %s", msg
);
535 /** @brief Get currently playing track
537 * @param qp Where to store track information
538 * @return 0 on success, non-0 on error
540 * @p qp gets NULL if no track is playing.
542 int disorder_playing(disorder_client
*c
, struct queue_entry
**qp
) {
544 struct queue_entry
*q
;
547 if((rc
= disorder_simple(c
, &r
, "playing", (char *)0)))
550 q
= xmalloc(sizeof *q
);
551 if(queue_unmarshall(q
, r
, client_error
, 0))
559 /** @brief Fetch the queue, recent list, etc */
560 static int disorder_somequeue(disorder_client
*c
,
561 const char *cmd
, struct queue_entry
**qp
) {
562 struct queue_entry
*qh
, **qt
= &qh
, *q
;
566 if((rc
= disorder_simple(c
, 0, cmd
, (char *)0)))
568 while(inputline(c
->ident
, c
->fpin
, &l
, '\n') >= 0) {
569 if(!strcmp(l
, ".")) {
575 q
= xmalloc(sizeof *q
);
576 if(!queue_unmarshall(q
, l
, client_error
, 0)) {
582 if(ferror(c
->fpin
)) {
583 byte_xasprintf((char **)&c
->last
, "input error: %s", strerror(errno
));
584 disorder_error(errno
, "error reading %s", c
->ident
);
586 c
->last
= "input error: unexpxected EOF";
587 disorder_error(0, "error reading %s: unexpected EOF", c
->ident
);
592 /** @brief Read a dot-stuffed list
594 * @param vecp Where to store list (UTF-8)
595 * @param nvecp Where to store number of items, or NULL
596 * @return 0 on success, non-0 on error
598 * The list will have a final NULL not counted in @p nvecp.
600 static int readlist(disorder_client
*c
, char ***vecp
, int *nvecp
) {
605 while(inputline(c
->ident
, c
->fpin
, &l
, '\n') >= 0) {
606 if(!strcmp(l
, ".")) {
607 vector_terminate(&v
);
614 vector_append(&v
, xstrdup(l
+ (*l
== '.')));
617 if(ferror(c
->fpin
)) {
618 byte_xasprintf((char **)&c
->last
, "input error: %s", strerror(errno
));
619 disorder_error(errno
, "error reading %s", c
->ident
);
621 c
->last
= "input error: unexpxected EOF";
622 disorder_error(0, "error reading %s: unexpected EOF", c
->ident
);
627 /** @brief Issue a comamnd and get a list response
629 * @param vecp Where to store list (UTF-8)
630 * @param nvecp Where to store number of items, or NULL
632 * @return 0 on success, non-0 on error
634 * The remaining arguments are command arguments, terminated by (char
635 * *)0. They should be in UTF-8.
637 * 5xx responses count as errors.
639 * See disorder_simple().
641 static int disorder_simple_list(disorder_client
*c
,
642 char ***vecp
, int *nvecp
,
643 const char *cmd
, ...) {
648 ret
= disorder_simple_v(c
, 0, cmd
, ap
);
651 return readlist(c
, vecp
, nvecp
);
654 /** @brief Return the user we logged in with
656 * @return User name (owned by @p c, don't modify)
658 char *disorder_user(disorder_client
*c
) {
662 static void pref_error_handler(const char *msg
,
663 void attribute((unused
)) *u
) {
664 disorder_error(0, "error handling 'prefs' reply: %s", msg
);
667 /** @brief Get all preferences for a trcak
669 * @param track Track name
670 * @param kp Where to store linked list of preferences
671 * @return 0 on success, non-0 on error
673 int disorder_prefs(disorder_client
*c
, const char *track
, struct kvp
**kp
) {
675 int nvec
, npvec
, n
, rc
;
678 if((rc
= disorder_simple_list(c
, &vec
, &nvec
, "prefs", track
, (char *)0)))
680 for(n
= 0; n
< nvec
; ++n
) {
681 if(!(pvec
= split(vec
[n
], &npvec
, SPLIT_QUOTES
, pref_error_handler
, 0)))
684 pref_error_handler("malformed response", 0);
687 *kp
= k
= xmalloc(sizeof *k
);
693 free_strings(nvec
, vec
);
698 /** @brief Parse a boolean response
699 * @param cmd Command for use in error messsage
700 * @param value Result from server
701 * @param flagp Where to store result
702 * @return 0 on success, non-0 on error
704 static int boolean(const char *cmd
, const char *value
,
706 if(!strcmp(value
, "yes")) *flagp
= 1;
707 else if(!strcmp(value
, "no")) *flagp
= 0;
709 disorder_error(0, "malformed response to '%s'", cmd
);
715 /** @brief Set volume
717 * @param left New left channel value
718 * @param right New right channel value
719 * @return 0 on success, non-0 on error
721 int disorder_set_volume(disorder_client
*c
, int left
, int right
) {
724 if(byte_asprintf(&ls
, "%d", left
) < 0
725 || byte_asprintf(&rs
, "%d", right
) < 0)
727 return disorder_simple(c
, 0, "volume", ls
, rs
, (char *)0);
730 /** @brief Get volume
732 * @param left Where to store left channel value
733 * @param right Where to store right channel value
734 * @return 0 on success, non-0 on error
736 int disorder_get_volume(disorder_client
*c
, int *left
, int *right
) {
740 if((rc
= disorder_simple(c
, &r
, "volume", (char *)0)))
742 if(sscanf(r
, "%d %d", left
, right
) != 2) {
743 c
->last
= "malformed volume response";
744 disorder_error(0, "error parsing response to 'volume': '%s'", r
);
750 /** @brief Log to a sink
752 * @param s Sink to write log lines to
753 * @return 0 on success, non-0 on error
755 int disorder_log(disorder_client
*c
, struct sink
*s
) {
759 if((rc
= disorder_simple(c
, 0, "log", (char *)0)))
761 while(inputline(c
->ident
, c
->fpin
, &l
, '\n') >= 0 && strcmp(l
, "."))
762 if(sink_printf(s
, "%s\n", l
) < 0) return -1;
763 if(ferror(c
->fpin
) || feof(c
->fpin
)) {
764 byte_xasprintf((char **)&c
->last
, "input error: %s",
765 ferror(c
->fpin
) ?
strerror(errno
) : "unexpxected EOF");
771 /** @brief Get recently added tracks
773 * @param vecp Where to store pointer to list (UTF-8)
774 * @param nvecp Where to store count
775 * @param max Maximum tracks to fetch, or 0 for all available
776 * @return 0 on success, non-0 on error
778 int disorder_new_tracks(disorder_client
*c
,
779 char ***vecp
, int *nvecp
,
783 sprintf(limit
, "%d", max
);
784 return disorder_simple_list(c
, vecp
, nvecp
, "new", limit
, (char *)0);
787 /** @brief Get server's RTP address information
789 * @param addressp Where to store address (UTF-8)
790 * @param portp Where to store port (UTF-8)
791 * @return 0 on success, non-0 on error
793 int disorder_rtp_address(disorder_client
*c
, char **addressp
, char **portp
) {
798 if((rc
= disorder_simple(c
, &r
, "rtp-address", (char *)0)))
800 vec
= split(r
, &n
, SPLIT_QUOTES
, 0, 0);
802 c
->last
= "malformed RTP address";
803 disorder_error(0, "malformed rtp-address reply");
811 /** @brief Get details of a scheduled event
814 * @param actiondatap Where to put details
815 * @return 0 on success, non-0 on error
817 int disorder_schedule_get(disorder_client
*c
, const char *id
,
818 struct kvp
**actiondatap
) {
819 char **lines
, **bits
;
823 if((rc
= disorder_simple_list(c
, &lines
, NULL
,
824 "schedule-get", id
, (char *)0)))
827 if(!(bits
= split(*lines
++, &nbits
, SPLIT_QUOTES
, 0, 0))) {
828 disorder_error(0, "invalid schedule-get reply: cannot split line");
832 disorder_error(0, "invalid schedule-get reply: wrong number of fields");
835 kvp_set(actiondatap
, bits
[0], bits
[1]);
840 /** @brief Add a scheduled event
842 * @param when When to trigger the event
843 * @param priority Event priority ("normal" or "junk")
844 * @param action What action to perform
845 * @param ... Action-specific arguments
846 * @return 0 on success, non-0 on error
848 * For action @c "play" the next argument is the track.
850 * For action @c "set-global" next argument is the global preference name
851 * and the final argument the value to set it to, or (char *)0 to unset it.
853 int disorder_schedule_add(disorder_client
*c
,
855 const char *priority
,
862 snprintf(when_str
, sizeof when_str
, "%lld", (long long)when
);
863 va_start(ap
, action
);
864 if(!strcmp(action
, "play"))
865 rc
= disorder_simple(c
, 0, "schedule-add", when_str
, priority
,
866 action
, va_arg(ap
, char *),
868 else if(!strcmp(action
, "set-global")) {
869 const char *key
= va_arg(ap
, char *);
870 const char *value
= va_arg(ap
, char *);
871 rc
= disorder_simple(c
, 0,"schedule-add", when_str
, priority
,
875 disorder_fatal(0, "unknown action '%s'", action
);
880 #include "client-stubs.c"