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"
55 /** @brief Client handle contents */
56 struct disorder_client {
57 /** @brief Stream to read from */
59 /** @brief Stream to write to */
61 /** @brief Peer description */
63 /** @brief Username */
65 /** @brief Report errors to @c stderr */
67 /** @brief Last error string */
71 /** @brief Create a new client
72 * @param verbose If nonzero, write extra junk to stderr
73 * @return Pointer to new client
75 * You must call disorder_connect(), disorder_connect_user() or
76 * disorder_connect_cookie() to connect it. Use disorder_close() to
77 * dispose of the client when finished with it.
79 disorder_client *disorder_new(int verbose) {
80 disorder_client *c = xmalloc(sizeof (struct disorder_client));
86 /** @brief Read a response line
88 * @param rp Where to store response, or NULL (UTF-8)
89 * @return Response code 0-999 or -1 on error
91 static int response(disorder_client *c, char **rp) {
94 if(inputline(c->ident, c->fpin, &r, '\n')) {
95 byte_xasprintf((char **)&c->last, "input error: %s", strerror(errno));
98 D(("response: %s", r));
101 if(r[0] >= '0' && r[0] <= '9'
102 && r[1] >= '0' && r[1] <= '9'
103 && r[2] >= '0' && r[2] <= '9'
106 return (r[0] * 10 + r[1]) * 10 + r[2] - 111 * '0';
108 c->last = "invalid reply format";
109 disorder_error(0, "invalid reply format from %s", c->ident);
114 /** @brief Return last response string
116 * @return Last response string (UTF-8, English) or NULL
118 const char *disorder_last(disorder_client *c) {
122 /** @brief Read and partially parse a response
124 * @param rp Where to store response text (or NULL) (UTF-8)
125 * @return 0 on success, non-0 on error
127 * 5xx responses count as errors.
129 * @p rp will NOT be filled in for xx9 responses (where it is just
130 * commentary for a command where it would normally be meaningful).
132 * NB that the response will NOT be converted to the local encoding.
134 static int check_response(disorder_client *c, char **rp) {
138 if((rc = response(c, &r)) == -1)
140 else if(rc / 100 == 2) {
142 *rp = (rc % 10 == 9) ? 0 : xstrdup(r + 4);
147 disorder_error(0, "from %s: %s", c->ident, utf82mb(r));
153 /** @brief Issue a command and parse a simple response
155 * @param rp Where to store result, or NULL
157 * @param ap Arguments (UTF-8), terminated by (char *)0
158 * @return 0 on success, non-0 on error
160 * 5xx responses count as errors.
162 * @p rp will NOT be filled in for xx9 responses (where it is just
163 * commentary for a command where it would normally be meaningful).
165 * NB that the response will NOT be converted to the local encoding
166 * nor will quotes be stripped. See dequote().
168 * Put @ref disorder__body in the argument list followed by a char **
169 * and int giving the body to follow the command. If the int is @c -1
170 * then the list is assumed to be NULL-terminated. This may be used
173 * Put @ref disorder__list in the argument list followed by a char **
174 * and int giving a list of arguments to include. If the int is @c -1
175 * then the list is assumed to be NULL-terminated. This may be used
176 * any number of times.
178 * Put @ref disorder__integer in the argument list followed by a long to
179 * send its value in decimal. This may be used any number of times.
181 * Put @ref disorder__time in the argument list followed by a time_t
182 * to send its value in decimal. This may be used any number of
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));
222 } else if(arg == disorder__integer) {
223 long n = va_arg(ap, long);
225 snprintf(buffer, sizeof buffer, "%ld", n);
226 dynstr_append(&d, ' ');
227 dynstr_append_string(&d, buffer);
228 } else if(arg == disorder__time) {
229 time_t n = va_arg(ap, time_t);
231 snprintf(buffer, sizeof buffer, "%lld", (long long)n);
232 dynstr_append(&d, ' ');
233 dynstr_append_string(&d, buffer);
235 dynstr_append(&d, ' ');
236 dynstr_append_string(&d, quoteutf8(arg));
239 dynstr_append(&d, '\n');
240 dynstr_terminate(&d);
241 D(("command: %s", d.vec));
242 if(fputs(d.vec, c->fpout) < 0)
247 for(nbody = 0; body[nbody]; ++nbody)
249 for(int n = 0; n < nbody; ++n) {
250 if(body[n][0] == '.')
251 if(fputc('.', c->fpout) < 0)
253 if(fputs(body[n], c->fpout) < 0)
255 if(fputc('\n', c->fpout) < 0)
258 if(fputs(".\n", c->fpout) < 0)
264 return check_response(c, rp);
266 byte_xasprintf((char **)&c->last, "write error: %s", strerror(errno));
267 disorder_error(errno, "error writing to %s", c->ident);
271 /** @brief Issue a command and parse a simple response
273 * @param rp Where to store result, or NULL (UTF-8)
275 * @return 0 on success, non-0 on error
277 * The remaining arguments are command arguments, terminated by (char
278 * *)0. They should be in UTF-8.
280 * 5xx responses count as errors.
282 * @p rp will NOT be filled in for xx9 responses (where it is just
283 * commentary for a command where it would normally be meaningful).
285 * NB that the response will NOT be converted to the local encoding
286 * nor will quotes be stripped. See dequote().
288 static int disorder_simple(disorder_client *c,
290 const char *cmd, ...) {
295 ret = disorder_simple_v(c, rp, cmd, ap);
300 /** @brief Issue a command and split the response
302 * @param vecp Where to store results
303 * @param nvecp Where to store count of results
304 * @param expected Expected count (or -1 to not check)
306 * @return 0 on success, non-0 on error
308 * The remaining arguments are command arguments, terminated by (char
309 * *)0. They should be in UTF-8.
311 * 5xx responses count as errors.
313 * @p rp will NOT be filled in for xx9 responses (where it is just
314 * commentary for a command where it would normally be meaningful).
316 * NB that the response will NOT be converted to the local encoding
317 * nor will quotes be stripped. See dequote().
319 static int disorder_simple_split(disorder_client *c,
323 const char *cmd, ...) {
331 ret = disorder_simple_v(c, &r, cmd, ap);
334 vec = split(r, &nvec, SPLIT_QUOTES, 0, 0);
336 if(expected < 0 || nvec == expected) {
340 disorder_error(0, "malformed reply to %s", cmd);
341 c->last = "malformed reply";
343 free_strings(nvec, vec);
353 /** @brief Dequote a result string
354 * @param rc 0 on success, non-0 on error
355 * @param rp Where result string is stored (UTF-8)
358 * This is used as a wrapper around disorder_simple() to dequote
361 static int dequote(int rc, char **rp) {
365 if((rr = split(*rp, 0, SPLIT_QUOTES, 0, 0)) && *rr) {
371 disorder_error(0, "invalid reply: %s", *rp);
376 /** @brief Generic connection routine
377 * @param conf Configuration to follow
379 * @param username Username to log in with or NULL
380 * @param password Password to log in with or NULL
381 * @param cookie Cookie to log in with or NULL
382 * @return 0 on success, non-0 on error
384 * @p cookie is tried first if not NULL. If it is NULL then @p
385 * username must not be. If @p username is not NULL then nor may @p
388 int disorder_connect_generic(struct config *conf,
390 const char *username,
391 const char *password,
392 const char *cookie) {
393 int fd = -1, fd2 = -1, nrvec = 0, rc;
394 unsigned char *nonce = NULL;
397 char *r = NULL, **rvec = NULL;
398 const char *protocol, *algorithm, *challenge;
399 struct sockaddr *sa = NULL;
402 if((salen = find_server(conf, &sa, &c->ident)) == (socklen_t)-1)
404 c->fpin = c->fpout = 0;
405 if((fd = socket(sa->sa_family, SOCK_STREAM, 0)) < 0) {
406 byte_xasprintf((char **)&c->last, "socket: %s", strerror(errno));
407 disorder_error(errno, "error calling socket");
410 if(connect(fd, sa, salen) < 0) {
411 byte_xasprintf((char **)&c->last, "connect: %s", strerror(errno));
412 disorder_error(errno, "error calling connect");
415 if((fd2 = dup(fd)) < 0) {
416 byte_xasprintf((char **)&c->last, "dup: %s", strerror(errno));
417 disorder_error(errno, "error calling dup");
420 if(!(c->fpin = fdopen(fd, "rb"))) {
421 byte_xasprintf((char **)&c->last, "fdopen: %s", strerror(errno));
422 disorder_error(errno, "error calling fdopen");
426 if(!(c->fpout = fdopen(fd2, "wb"))) {
427 byte_xasprintf((char **)&c->last, "fdopen: %s", strerror(errno));
428 disorder_error(errno, "error calling fdopen");
432 if((rc = disorder_simple(c, &r, 0, (const char *)0)))
434 if(!(rvec = split(r, &nrvec, SPLIT_QUOTES, 0, 0)))
437 c->last = "cannot parse server greeting";
438 disorder_error(0, "cannot parse server greeting %s", r);
442 if(strcmp(protocol, "2")) {
443 c->last = "unknown protocol version";
444 disorder_error(0, "unknown protocol version: %s", protocol);
449 if(!(nonce = unhex(challenge, &nl)))
452 if(!dequote(disorder_simple(c, &c->user, "cookie", cookie, (char *)0),
454 return 0; /* success */
456 c->last = "cookie failed and no username";
457 disorder_error(0, "cookie did not work and no username available");
461 if(!(res = authhash(nonce, nl, password, algorithm))) {
462 c->last = "error computing authorization hash";
465 if((rc = disorder_simple(c, 0, "user", username, res, (char *)0)))
467 c->user = xstrdup(username);
469 free_strings(nrvec, rvec);
485 if(fd2 != -1) close(fd2);
486 if(fd != -1) close(fd);
490 /** @brief Connect a client with a specified username and password
492 * @param username Username to log in with
493 * @param password Password to log in with
494 * @return 0 on success, non-0 on error
496 int disorder_connect_user(disorder_client *c,
497 const char *username,
498 const char *password) {
499 return disorder_connect_generic(config,
506 /** @brief Connect a client
508 * @return 0 on success, non-0 on error
510 * The connection will use the username and password found in @ref
511 * config, or directly from the database if no password is found and
512 * the database is readable (usually only for root).
514 int disorder_connect(disorder_client *c) {
515 const char *username, *password;
517 if(!(username = config->username)) {
518 c->last = "no username";
519 disorder_error(0, "no username configured");
522 password = config->password;
523 /* If we're connecting as 'root' guess that we're the system root
524 * user (or the jukebox user), both of which can use the privileged
525 * socket. They can also furtle with the db directly: that is why
526 * privileged socket does not represent a privilege escalation. */
528 && !strcmp(username, "root"))
529 password = "anything will do for root";
532 c->last = "no password";
533 disorder_error(0, "no password configured for user '%s'", username);
536 return disorder_connect_generic(config,
543 /** @brief Connect a client
545 * @param cookie Cookie to log in with, or NULL
546 * @return 0 on success, non-0 on error
548 * If @p cookie is NULL or does not work then we attempt to log in as
549 * guest instead (so when the cookie expires only an extra round trip
550 * is needed rathre than a complete new login).
552 int disorder_connect_cookie(disorder_client *c,
553 const char *cookie) {
554 return disorder_connect_generic(config,
561 /** @brief Close a client
563 * @return 0 on succcess, non-0 on errior
565 * The client is still closed even on error. It might well be
566 * appropriate to ignore the return value.
568 int disorder_close(disorder_client *c) {
572 if(fclose(c->fpin) < 0) {
573 byte_xasprintf((char **)&c->last, "fclose: %s", strerror(errno));
574 disorder_error(errno, "error calling fclose");
580 if(fclose(c->fpout) < 0) {
581 byte_xasprintf((char **)&c->last, "fclose: %s", strerror(errno));
582 disorder_error(errno, "error calling fclose");
594 static void client_error(const char *msg,
595 void attribute((unused)) *u) {
596 disorder_error(0, "error parsing reply: %s", msg);
599 /** @brief Get a single queue entry
602 * @param qp Where to store track information
603 * @return 0 on success, non-0 on error
605 static int onequeue(disorder_client *c, const char *cmd,
606 struct queue_entry **qp) {
608 struct queue_entry *q;
611 if((rc = disorder_simple(c, &r, cmd, (char *)0)))
614 q = xmalloc(sizeof *q);
615 if(queue_unmarshall(q, r, client_error, 0))
623 /** @brief Fetch the queue, recent list, etc */
624 static int readqueue(disorder_client *c,
625 struct queue_entry **qp) {
626 struct queue_entry *qh, **qt = &qh, *q;
629 while(inputline(c->ident, c->fpin, &l, '\n') >= 0) {
630 if(!strcmp(l, ".")) {
636 q = xmalloc(sizeof *q);
637 if(!queue_unmarshall(q, l, client_error, 0)) {
643 if(ferror(c->fpin)) {
644 byte_xasprintf((char **)&c->last, "input error: %s", strerror(errno));
645 disorder_error(errno, "error reading %s", c->ident);
647 c->last = "input error: unexpected EOF";
648 disorder_error(0, "error reading %s: unexpected EOF", c->ident);
653 /** @brief Read a dot-stuffed list
655 * @param vecp Where to store list (UTF-8)
656 * @param nvecp Where to store number of items, or NULL
657 * @return 0 on success, non-0 on error
659 * The list will have a final NULL not counted in @p nvecp.
661 static int readlist(disorder_client *c, char ***vecp, int *nvecp) {
666 while(inputline(c->ident, c->fpin, &l, '\n') >= 0) {
667 if(!strcmp(l, ".")) {
668 vector_terminate(&v);
675 vector_append(&v, xstrdup(l + (*l == '.')));
678 if(ferror(c->fpin)) {
679 byte_xasprintf((char **)&c->last, "input error: %s", strerror(errno));
680 disorder_error(errno, "error reading %s", c->ident);
682 c->last = "input error: unexpxected EOF";
683 disorder_error(0, "error reading %s: unexpected EOF", c->ident);
688 /** @brief Return the user we logged in with
690 * @return User name (owned by @p c, don't modify)
692 char *disorder_user(disorder_client *c) {
696 static void pairlist_error_handler(const char *msg,
697 void attribute((unused)) *u) {
698 disorder_error(0, "error handling key-value pair reply: %s", msg);
701 /** @brief Get a list of key-value pairs
703 * @param kp Where to store linked list of preferences
705 * @param ... Arguments
706 * @return 0 on success, non-0 on error
708 static int pairlist(disorder_client *c, struct kvp **kp, const char *cmd, ...) {
710 int nvec, npvec, n, rc;
715 rc = disorder_simple_v(c, 0, cmd, ap);
719 if((rc = readlist(c, &vec, &nvec)))
721 for(n = 0; n < nvec; ++n) {
722 if(!(pvec = split(vec[n], &npvec, SPLIT_QUOTES, pairlist_error_handler, 0)))
725 pairlist_error_handler("malformed response", 0);
728 *kp = k = xmalloc(sizeof *k);
734 free_strings(nvec, vec);
739 /** @brief Parse a boolean response
740 * @param cmd Command for use in error messsage
741 * @param value Result from server
742 * @param flagp Where to store result
743 * @return 0 on success, non-0 on error
745 static int boolean(const char *cmd, const char *value,
747 if(!strcmp(value, "yes")) *flagp = 1;
748 else if(!strcmp(value, "no")) *flagp = 0;
750 disorder_error(0, "malformed response to '%s'", cmd);
756 /** @brief Log to a sink
758 * @param s Sink to write log lines to
759 * @return 0 on success, non-0 on error
761 int disorder_log(disorder_client *c, struct sink *s) {
765 if((rc = disorder_simple(c, 0, "log", (char *)0)))
767 while(inputline(c->ident, c->fpin, &l, '\n') >= 0 && strcmp(l, "."))
768 if(sink_printf(s, "%s\n", l) < 0) return -1;
769 if(ferror(c->fpin) || feof(c->fpin)) {
770 byte_xasprintf((char **)&c->last, "input error: %s",
771 ferror(c->fpin) ? strerror(errno) : "unexpxected EOF");
777 #include "client-stubs.c"