2 * This file is part of DisOrder.
3 * Copyright (C) 2004-2010 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()
188 static int disorder_simple_v(disorder_client
*c
,
199 c
->last
= "not connected";
200 disorder_error(0, "not connected to server");
205 dynstr_append_string(&d
, cmd
);
206 while((arg
= va_arg(ap
, const char *))) {
207 if(arg
== disorder_body
) {
208 body
= va_arg(ap
, char **);
209 nbody
= va_arg(ap
, int);
211 } else if(arg
== disorder_list
) {
212 char **list
= va_arg(ap
, char **);
213 int nlist
= va_arg(ap
, int);
215 for(nlist
= 0; list
[nlist
]; ++nlist
)
218 for(int n
= 0; n
< nlist
; ++n
) {
219 dynstr_append(&d
, ' ');
220 dynstr_append_string(&d
, quoteutf8(arg
));
223 dynstr_append(&d
, ' ');
224 dynstr_append_string(&d
, quoteutf8(arg
));
227 dynstr_append(&d
, '\n');
228 dynstr_terminate(&d
);
229 D(("command: %s", d
.vec
));
230 if(fputs(d
.vec
, c
->fpout
) < 0)
235 for(nbody
= 0; body
[nbody
]; ++nbody
)
237 for(int n
= 0; n
< nbody
; ++n
) {
238 if(body
[n
][0] == '.')
239 if(fputc('.', c
->fpout
) < 0)
241 if(fputs(body
[n
], c
->fpout
) < 0)
243 if(fputc('\n', c
->fpout
) < 0)
246 if(fputs(".\n", c
->fpout
) < 0)
252 return check_response(c
, rp
);
254 byte_xasprintf((char **)&c
->last
, "write error: %s", strerror(errno
));
255 disorder_error(errno
, "error writing to %s", c
->ident
);
259 /** @brief Issue a command and parse a simple response
261 * @param rp Where to store result, or NULL (UTF-8)
263 * @return 0 on success, non-0 on error
265 * The remaining arguments are command arguments, terminated by (char
266 * *)0. They should be in UTF-8.
268 * 5xx responses count as errors.
270 * @p rp will NOT be filled in for xx9 responses (where it is just
271 * commentary for a command where it would normally be meaningful).
273 * NB that the response will NOT be converted to the local encoding
274 * nor will quotes be stripped. See dequote().
276 static int disorder_simple(disorder_client
*c
,
278 const char *cmd
, ...) {
283 ret
= disorder_simple_v(c
, rp
, cmd
, ap
);
288 /** @brief Dequote a result string
289 * @param rc 0 on success, non-0 on error
290 * @param rp Where result string is stored (UTF-8)
293 * This is used as a wrapper around disorder_simple() to dequote
296 static int dequote(int rc
, char **rp
) {
300 if((rr
= split(*rp
, 0, SPLIT_QUOTES
, 0, 0)) && *rr
) {
306 disorder_error(0, "invalid reply: %s", *rp
);
311 /** @brief Generic connection routine
312 * @param conf Configuration to follow
314 * @param username Username to log in with or NULL
315 * @param password Password to log in with or NULL
316 * @param cookie Cookie to log in with or NULL
317 * @return 0 on success, non-0 on error
319 * @p cookie is tried first if not NULL. If it is NULL then @p
320 * username must not be. If @p username is not NULL then nor may @p
323 int disorder_connect_generic(struct config
*conf
,
325 const char *username
,
326 const char *password
,
327 const char *cookie
) {
328 int fd
= -1, fd2
= -1, nrvec
= 0, rc
;
329 unsigned char *nonce
= NULL
;
332 char *r
= NULL
, **rvec
= NULL
;
333 const char *protocol
, *algorithm
, *challenge
;
334 struct sockaddr
*sa
= NULL
;
337 if((salen
= find_server(conf
, &sa
, &c
->ident
)) == (socklen_t
)-1)
339 c
->fpin
= c
->fpout
= 0;
340 if((fd
= socket(sa
->sa_family
, SOCK_STREAM
, 0)) < 0) {
341 byte_xasprintf((char **)&c
->last
, "socket: %s", strerror(errno
));
342 disorder_error(errno
, "error calling socket");
345 if(connect(fd
, sa
, salen
) < 0) {
346 byte_xasprintf((char **)&c
->last
, "connect: %s", strerror(errno
));
347 disorder_error(errno
, "error calling connect");
350 if((fd2
= dup(fd
)) < 0) {
351 byte_xasprintf((char **)&c
->last
, "dup: %s", strerror(errno
));
352 disorder_error(errno
, "error calling dup");
355 if(!(c
->fpin
= fdopen(fd
, "rb"))) {
356 byte_xasprintf((char **)&c
->last
, "fdopen: %s", strerror(errno
));
357 disorder_error(errno
, "error calling fdopen");
361 if(!(c
->fpout
= fdopen(fd2
, "wb"))) {
362 byte_xasprintf((char **)&c
->last
, "fdopen: %s", strerror(errno
));
363 disorder_error(errno
, "error calling fdopen");
367 if((rc
= disorder_simple(c
, &r
, 0, (const char *)0)))
369 if(!(rvec
= split(r
, &nrvec
, SPLIT_QUOTES
, 0, 0)))
372 c
->last
= "cannot parse server greeting";
373 disorder_error(0, "cannot parse server greeting %s", r
);
377 if(strcmp(protocol
, "2")) {
378 c
->last
= "unknown protocol version";
379 disorder_error(0, "unknown protocol version: %s", protocol
);
384 if(!(nonce
= unhex(challenge
, &nl
)))
387 if(!dequote(disorder_simple(c
, &c
->user
, "cookie", cookie
, (char *)0),
389 return 0; /* success */
391 c
->last
= "cookie failed and no username";
392 disorder_error(0, "cookie did not work and no username available");
396 if(!(res
= authhash(nonce
, nl
, password
, algorithm
))) {
397 c
->last
= "error computing authorization hash";
400 if((rc
= disorder_simple(c
, 0, "user", username
, res
, (char *)0)))
402 c
->user
= xstrdup(username
);
404 free_strings(nrvec
, rvec
);
420 if(fd2
!= -1) close(fd2
);
421 if(fd
!= -1) close(fd
);
425 /** @brief Connect a client with a specified username and password
427 * @param username Username to log in with
428 * @param password Password to log in with
429 * @return 0 on success, non-0 on error
431 int disorder_connect_user(disorder_client
*c
,
432 const char *username
,
433 const char *password
) {
434 return disorder_connect_generic(config
,
441 /** @brief Connect a client
443 * @return 0 on success, non-0 on error
445 * The connection will use the username and password found in @ref
446 * config, or directly from the database if no password is found and
447 * the database is readable (usually only for root).
449 int disorder_connect(disorder_client
*c
) {
450 const char *username
, *password
;
452 if(!(username
= config
->username
)) {
453 c
->last
= "no username";
454 disorder_error(0, "no username configured");
457 password
= config
->password
;
458 /* Maybe we can read the database */
459 if(!password
&& trackdb_readable()) {
460 trackdb_init(TRACKDB_NO_RECOVER
|TRACKDB_NO_UPGRADE
);
461 trackdb_open(TRACKDB_READ_ONLY
);
462 password
= trackdb_get_password(username
);
467 c
->last
= "no password";
468 disorder_error(0, "no password configured for user '%s'", username
);
471 return disorder_connect_generic(config
,
478 /** @brief Connect a client
480 * @param cookie Cookie to log in with, or NULL
481 * @return 0 on success, non-0 on error
483 * If @p cookie is NULL or does not work then we attempt to log in as
484 * guest instead (so when the cookie expires only an extra round trip
485 * is needed rathre than a complete new login).
487 int disorder_connect_cookie(disorder_client
*c
,
488 const char *cookie
) {
489 return disorder_connect_generic(config
,
496 /** @brief Close a client
498 * @return 0 on succcess, non-0 on errior
500 * The client is still closed even on error. It might well be
501 * appropriate to ignore the return value.
503 int disorder_close(disorder_client
*c
) {
507 if(fclose(c
->fpin
) < 0) {
508 byte_xasprintf((char **)&c
->last
, "fclose: %s", strerror(errno
));
509 disorder_error(errno
, "error calling fclose");
515 if(fclose(c
->fpout
) < 0) {
516 byte_xasprintf((char **)&c
->last
, "fclose: %s", strerror(errno
));
517 disorder_error(errno
, "error calling fclose");
529 static void client_error(const char *msg
,
530 void attribute((unused
)) *u
) {
531 disorder_error(0, "error parsing reply: %s", msg
);
534 /** @brief Get a single queue entry
537 * @param qp Where to store track information
538 * @return 0 on success, non-0 on error
540 static int onequeue(disorder_client
*c
, const char *cmd
,
541 struct queue_entry
**qp
) {
543 struct queue_entry
*q
;
546 if((rc
= disorder_simple(c
, &r
, cmd
, (char *)0)))
549 q
= xmalloc(sizeof *q
);
550 if(queue_unmarshall(q
, r
, client_error
, 0))
558 /** @brief Fetch the queue, recent list, etc */
559 static int readqueue(disorder_client
*c
,
560 struct queue_entry
**qp
) {
561 struct queue_entry
*qh
, **qt
= &qh
, *q
;
564 while(inputline(c
->ident
, c
->fpin
, &l
, '\n') >= 0) {
565 if(!strcmp(l
, ".")) {
571 q
= xmalloc(sizeof *q
);
572 if(!queue_unmarshall(q
, l
, client_error
, 0)) {
578 if(ferror(c
->fpin
)) {
579 byte_xasprintf((char **)&c
->last
, "input error: %s", strerror(errno
));
580 disorder_error(errno
, "error reading %s", c
->ident
);
582 c
->last
= "input error: unexpected EOF";
583 disorder_error(0, "error reading %s: unexpected EOF", c
->ident
);
588 /** @brief Read a dot-stuffed list
590 * @param vecp Where to store list (UTF-8)
591 * @param nvecp Where to store number of items, or NULL
592 * @return 0 on success, non-0 on error
594 * The list will have a final NULL not counted in @p nvecp.
596 static int readlist(disorder_client
*c
, char ***vecp
, int *nvecp
) {
601 while(inputline(c
->ident
, c
->fpin
, &l
, '\n') >= 0) {
602 if(!strcmp(l
, ".")) {
603 vector_terminate(&v
);
610 vector_append(&v
, xstrdup(l
+ (*l
== '.')));
613 if(ferror(c
->fpin
)) {
614 byte_xasprintf((char **)&c
->last
, "input error: %s", strerror(errno
));
615 disorder_error(errno
, "error reading %s", c
->ident
);
617 c
->last
= "input error: unexpxected EOF";
618 disorder_error(0, "error reading %s: unexpected EOF", c
->ident
);
623 /** @brief Return the user we logged in with
625 * @return User name (owned by @p c, don't modify)
627 char *disorder_user(disorder_client
*c
) {
631 static void pairlist_error_handler(const char *msg
,
632 void attribute((unused
)) *u
) {
633 disorder_error(0, "error handling key-value pair reply: %s", msg
);
636 /** @brief Get a list of key-value pairs
638 * @param kp Where to store linked list of preferences
640 * @param ... Arguments
641 * @return 0 on success, non-0 on error
643 static int pairlist(disorder_client
*c
, struct kvp
**kp
, const char *cmd
, ...) {
645 int nvec
, npvec
, n
, rc
;
650 rc
= disorder_simple_v(c
, 0, cmd
, ap
);
654 if((rc
= readlist(c
, &vec
, &nvec
)))
656 for(n
= 0; n
< nvec
; ++n
) {
657 if(!(pvec
= split(vec
[n
], &npvec
, SPLIT_QUOTES
, pairlist_error_handler
, 0)))
660 pairlist_error_handler("malformed response", 0);
663 *kp
= k
= xmalloc(sizeof *k
);
669 free_strings(nvec
, vec
);
674 /** @brief Parse a boolean response
675 * @param cmd Command for use in error messsage
676 * @param value Result from server
677 * @param flagp Where to store result
678 * @return 0 on success, non-0 on error
680 static int boolean(const char *cmd
, const char *value
,
682 if(!strcmp(value
, "yes")) *flagp
= 1;
683 else if(!strcmp(value
, "no")) *flagp
= 0;
685 disorder_error(0, "malformed response to '%s'", cmd
);
691 /** @brief Log to a sink
693 * @param s Sink to write log lines to
694 * @return 0 on success, non-0 on error
696 int disorder_log(disorder_client
*c
, struct sink
*s
) {
700 if((rc
= disorder_simple(c
, 0, "log", (char *)0)))
702 while(inputline(c
->ident
, c
->fpin
, &l
, '\n') >= 0 && strcmp(l
, "."))
703 if(sink_printf(s
, "%s\n", l
) < 0) return -1;
704 if(ferror(c
->fpin
) || feof(c
->fpin
)) {
705 byte_xasprintf((char **)&c
->last
, "input error: %s",
706 ferror(c
->fpin
) ?
strerror(errno
) : "unexpxected EOF");
712 /** @brief Add a scheduled event
714 * @param when When to trigger the event
715 * @param priority Event priority ("normal" or "junk")
716 * @param action What action to perform
717 * @param ... Action-specific arguments
718 * @return 0 on success, non-0 on error
720 * For action @c "play" the next argument is the track.
722 * For action @c "set-global" next argument is the global preference name
723 * and the final argument the value to set it to, or (char *)0 to unset it.
725 int disorder_schedule_add(disorder_client
*c
,
727 const char *priority
,
734 snprintf(when_str
, sizeof when_str
, "%lld", (long long)when
);
735 va_start(ap
, action
);
736 if(!strcmp(action
, "play"))
737 rc
= disorder_simple(c
, 0, "schedule-add", when_str
, priority
,
738 action
, va_arg(ap
, char *),
740 else if(!strcmp(action
, "set-global")) {
741 const char *key
= va_arg(ap
, char *);
742 const char *value
= va_arg(ap
, char *);
743 rc
= disorder_simple(c
, 0,"schedule-add", when_str
, priority
,
747 disorder_fatal(0, "unknown action '%s'", action
);
752 #include "client-stubs.c"