2 * This file is part of DisOrder.
3 * Copyright (C) 2004-13 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>
29 # include <sys/socket.h>
32 # include <netinet/in.h>
56 #include "inputline.h"
63 #include "client-common.h"
67 /** @brief Client handle contents */
68 struct disorder_client {
69 /** @brief Stream to read from */
71 /** @brief Stream to write to */
73 /** @brief Peer description */
75 /** @brief Username */
77 /** @brief Report errors to @c stderr */
79 /** @brief Last error string */
81 /** @brief Address family */
85 /** @brief Create a new client
86 * @param verbose If nonzero, write extra junk to stderr
87 * @return Pointer to new client
89 * You must call disorder_connect(), disorder_connect_user() or
90 * disorder_connect_cookie() to connect it. Use disorder_close() to
91 * dispose of the client when finished with it.
93 disorder_client *disorder_new(int verbose) {
94 disorder_client *c = xmalloc(sizeof (struct disorder_client));
101 /** @brief Return the address family used by this client */
102 int disorder_client_af(disorder_client *c) {
106 /** @brief Read a response line
108 * @param rp Where to store response, or NULL (UTF-8)
109 * @return Response code 0-999 or -1 on error
111 static int response(disorder_client *c, char **rp) {
114 if(inputline(c->ident, c->fpin, &r, '\n')) {
115 byte_xasprintf((char **)&c->last, "input error: %s", strerror(errno));
118 D(("response: %s", r));
121 if(r[0] >= '0' && r[0] <= '9'
122 && r[1] >= '0' && r[1] <= '9'
123 && r[2] >= '0' && r[2] <= '9'
126 return (r[0] * 10 + r[1]) * 10 + r[2] - 111 * '0';
128 c->last = "invalid reply format";
129 disorder_error(0, "invalid reply format from %s", c->ident);
134 /** @brief Return last response string
136 * @return Last response string (UTF-8, English) or NULL
138 const char *disorder_last(disorder_client *c) {
142 /** @brief Read and partially parse a response
144 * @param rp Where to store response text (or NULL) (UTF-8)
145 * @return 0 on success, non-0 on error
147 * 5xx responses count as errors.
149 * @p rp will NOT be filled in for xx9 responses (where it is just
150 * commentary for a command where it would normally be meaningful).
152 * NB that the response will NOT be converted to the local encoding.
154 static int check_response(disorder_client *c, char **rp) {
158 if((rc = response(c, &r)) == -1)
160 else if(rc / 100 == 2) {
162 *rp = (rc % 10 == 9) ? 0 : xstrdup(r + 4);
167 disorder_error(0, "from %s: %s", c->ident, utf82mb(r));
173 /** @brief Issue a command and parse a simple response
175 * @param rp Where to store result, or NULL
177 * @param ap Arguments (UTF-8), terminated by (char *)0
178 * @return 0 on success, non-0 on error
180 * 5xx responses count as errors.
182 * @p rp will NOT be filled in for xx9 responses (where it is just
183 * commentary for a command where it would normally be meaningful).
185 * NB that the response will NOT be converted to the local encoding
186 * nor will quotes be stripped. See dequote().
188 * Put @ref disorder__body in the argument list followed by a char **
189 * and int giving the body to follow the command. If the int is @c -1
190 * then the list is assumed to be NULL-terminated. This may be used
193 * Put @ref disorder__list in the argument list followed by a char **
194 * and int giving a list of arguments to include. If the int is @c -1
195 * then the list is assumed to be NULL-terminated. This may be used
196 * any number of times.
198 * Put @ref disorder__integer in the argument list followed by a long to
199 * send its value in decimal. This may be used any number of times.
201 * Put @ref disorder__time in the argument list followed by a time_t
202 * to send its value in decimal. This may be used any number of
205 * Usually you would call this via one of the following interfaces:
206 * - disorder_simple()
208 static int disorder_simple_v(disorder_client *c,
219 c->last = "not connected";
220 disorder_error(0, "not connected to server");
225 dynstr_append_string(&d, cmd);
226 while((arg = va_arg(ap, const char *))) {
227 if(arg == disorder__body) {
228 body = va_arg(ap, char **);
229 nbody = va_arg(ap, int);
231 } else if(arg == disorder__list) {
232 char **list = va_arg(ap, char **);
233 int nlist = va_arg(ap, int);
235 for(nlist = 0; list[nlist]; ++nlist)
238 for(int n = 0; n < nlist; ++n) {
239 dynstr_append(&d, ' ');
240 dynstr_append_string(&d, quoteutf8(arg));
242 } else if(arg == disorder__integer) {
243 long n = va_arg(ap, long);
245 snprintf(buffer, sizeof buffer, "%ld", n);
246 dynstr_append(&d, ' ');
247 dynstr_append_string(&d, buffer);
248 } else if(arg == disorder__time) {
249 time_t n = va_arg(ap, time_t);
251 snprintf(buffer, sizeof buffer, "%lld", (long long)n);
252 dynstr_append(&d, ' ');
253 dynstr_append_string(&d, buffer);
255 dynstr_append(&d, ' ');
256 dynstr_append_string(&d, quoteutf8(arg));
259 dynstr_append(&d, '\n');
260 dynstr_terminate(&d);
261 D(("command: %s", d.vec));
262 if(fputs(d.vec, c->fpout) < 0)
267 for(nbody = 0; body[nbody]; ++nbody)
269 for(int n = 0; n < nbody; ++n) {
270 if(body[n][0] == '.')
271 if(fputc('.', c->fpout) < 0)
273 if(fputs(body[n], c->fpout) < 0)
275 if(fputc('\n', c->fpout) < 0)
278 if(fputs(".\n", c->fpout) < 0)
284 return check_response(c, rp);
286 byte_xasprintf((char **)&c->last, "write error: %s", strerror(errno));
287 disorder_error(errno, "error writing to %s", c->ident);
291 /** @brief Issue a command and parse a simple response
293 * @param rp Where to store result, or NULL (UTF-8)
295 * @return 0 on success, non-0 on error
297 * The remaining arguments are command arguments, terminated by (char
298 * *)0. They should be in UTF-8.
300 * 5xx responses count as errors.
302 * @p rp will NOT be filled in for xx9 responses (where it is just
303 * commentary for a command where it would normally be meaningful).
305 * NB that the response will NOT be converted to the local encoding
306 * nor will quotes be stripped. See dequote().
308 static int disorder_simple(disorder_client *c,
310 const char *cmd, ...) {
315 ret = disorder_simple_v(c, rp, cmd, ap);
320 /** @brief Issue a command and split the response
322 * @param vecp Where to store results
323 * @param nvecp Where to store count of results
324 * @param expected Expected count (or -1 to not check)
326 * @return 0 on success, non-0 on error
328 * The remaining arguments are command arguments, terminated by (char
329 * *)0. They should be in UTF-8.
331 * 5xx responses count as errors.
333 * @p rp will NOT be filled in for xx9 responses (where it is just
334 * commentary for a command where it would normally be meaningful).
336 * NB that the response will NOT be converted to the local encoding
337 * nor will quotes be stripped. See dequote().
339 static int disorder_simple_split(disorder_client *c,
343 const char *cmd, ...) {
351 ret = disorder_simple_v(c, &r, cmd, ap);
354 vec = split(r, &nvec, SPLIT_QUOTES, 0, 0);
356 if(expected < 0 || nvec == expected) {
360 disorder_error(0, "malformed reply to %s", cmd);
361 c->last = "malformed reply";
363 free_strings(nvec, vec);
373 /** @brief Dequote a result string
374 * @param rc 0 on success, non-0 on error
375 * @param rp Where result string is stored (UTF-8)
378 * This is used as a wrapper around disorder_simple() to dequote
381 static int dequote(int rc, char **rp) {
385 if((rr = split(*rp, 0, SPLIT_QUOTES, 0, 0)) && *rr) {
391 disorder_error(0, "invalid reply: %s", *rp);
396 /** @brief Generic connection routine
397 * @param conf Configuration to follow
399 * @param username Username to log in with or NULL
400 * @param password Password to log in with or NULL
401 * @param cookie Cookie to log in with or NULL
402 * @return 0 on success, non-0 on error
404 * @p cookie is tried first if not NULL. If it is NULL then @p
405 * username must not be. If @p username is not NULL then nor may @p
408 int disorder_connect_generic(struct config *conf,
410 const char *username,
411 const char *password,
412 const char *cookie) {
413 int fd = -1, fd2 = -1, nrvec = 0, rc;
414 unsigned char *nonce = NULL;
417 char *r = NULL, **rvec = NULL;
418 const char *protocol, *algorithm, *challenge;
419 struct sockaddr *sa = NULL;
422 if((salen = find_server(conf, &sa, &c->ident)) == (socklen_t)-1)
424 c->fpin = c->fpout = 0;
425 if((fd = socket(sa->sa_family, SOCK_STREAM, 0)) < 0) {
426 byte_xasprintf((char **)&c->last, "socket: %s", strerror(errno));
427 disorder_error(errno, "error calling socket");
430 c->family = sa->sa_family;
431 if(connect(fd, sa, salen) < 0) {
432 byte_xasprintf((char **)&c->last, "connect: %s", strerror(errno));
433 disorder_error(errno, "error calling connect");
436 if((fd2 = dup(fd)) < 0) {
437 byte_xasprintf((char **)&c->last, "dup: %s", strerror(errno));
438 disorder_error(errno, "error calling dup");
441 if(!(c->fpin = fdopen(fd, "rb"))) {
442 byte_xasprintf((char **)&c->last, "fdopen: %s", strerror(errno));
443 disorder_error(errno, "error calling fdopen");
447 if(!(c->fpout = fdopen(fd2, "wb"))) {
448 byte_xasprintf((char **)&c->last, "fdopen: %s", strerror(errno));
449 disorder_error(errno, "error calling fdopen");
453 if((rc = disorder_simple(c, &r, 0, (const char *)0)))
455 if(!(rvec = split(r, &nrvec, SPLIT_QUOTES, 0, 0)))
458 c->last = "cannot parse server greeting";
459 disorder_error(0, "cannot parse server greeting %s", r);
463 if(strcmp(protocol, "2")) {
464 c->last = "unknown protocol version";
465 disorder_error(0, "unknown protocol version: %s", protocol);
470 if(!(nonce = unhex(challenge, &nl)))
473 if(!dequote(disorder_simple(c, &c->user, "cookie", cookie, (char *)0),
475 return 0; /* success */
477 c->last = "cookie failed and no username";
478 disorder_error(0, "cookie did not work and no username available");
482 if(!(res = authhash(nonce, nl, password, algorithm))) {
483 c->last = "error computing authorization hash";
486 if((rc = disorder_simple(c, 0, "user", username, res, (char *)0)))
488 c->user = xstrdup(username);
490 free_strings(nrvec, rvec);
506 if(fd2 != -1) close(fd2);
507 if(fd != -1) close(fd);
511 /** @brief Connect a client with a specified username and password
513 * @param username Username to log in with
514 * @param password Password to log in with
515 * @return 0 on success, non-0 on error
517 int disorder_connect_user(disorder_client *c,
518 const char *username,
519 const char *password) {
520 return disorder_connect_generic(config,
527 /** @brief Connect a client
529 * @return 0 on success, non-0 on error
531 * The connection will use the username and password found in @ref
532 * config, or directly from the database if no password is found and
533 * the database is readable (usually only for root).
535 int disorder_connect(disorder_client *c) {
536 const char *username, *password;
538 if(!(username = config->username)) {
539 c->last = "no username";
540 disorder_error(0, "no username configured");
543 password = config->password;
544 /* If we're connecting as 'root' guess that we're the system root
545 * user (or the jukebox user), both of which can use the privileged
546 * socket. They can also furtle with the db directly: that is why
547 * privileged socket does not represent a privilege escalation. */
549 && !strcmp(username, "root"))
550 password = "anything will do for root";
553 c->last = "no password";
554 disorder_error(0, "no password configured for user '%s'", username);
557 return disorder_connect_generic(config,
564 /** @brief Connect a client
566 * @param cookie Cookie to log in with, or NULL
567 * @return 0 on success, non-0 on error
569 * If @p cookie is NULL or does not work then we attempt to log in as
570 * guest instead (so when the cookie expires only an extra round trip
571 * is needed rathre than a complete new login).
573 int disorder_connect_cookie(disorder_client *c,
574 const char *cookie) {
575 return disorder_connect_generic(config,
582 /** @brief Close a client
584 * @return 0 on succcess, non-0 on errior
586 * The client is still closed even on error. It might well be
587 * appropriate to ignore the return value.
589 int disorder_close(disorder_client *c) {
593 if(fclose(c->fpin) < 0) {
594 byte_xasprintf((char **)&c->last, "fclose: %s", strerror(errno));
595 disorder_error(errno, "error calling fclose");
601 if(fclose(c->fpout) < 0) {
602 byte_xasprintf((char **)&c->last, "fclose: %s", strerror(errno));
603 disorder_error(errno, "error calling fclose");
615 static void client_error(const char *msg,
616 void attribute((unused)) *u) {
617 disorder_error(0, "error parsing reply: %s", msg);
620 /** @brief Get a single queue entry
623 * @param qp Where to store track information
624 * @return 0 on success, non-0 on error
626 static int onequeue(disorder_client *c, const char *cmd,
627 struct queue_entry **qp) {
629 struct queue_entry *q;
632 if((rc = disorder_simple(c, &r, cmd, (char *)0)))
635 q = xmalloc(sizeof *q);
636 if(queue_unmarshall(q, r, client_error, 0))
644 /** @brief Fetch the queue, recent list, etc */
645 static int readqueue(disorder_client *c,
646 struct queue_entry **qp) {
647 struct queue_entry *qh, **qt = &qh, *q;
650 while(inputline(c->ident, c->fpin, &l, '\n') >= 0) {
651 if(!strcmp(l, ".")) {
657 q = xmalloc(sizeof *q);
658 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: unexpected EOF";
669 disorder_error(0, "error reading %s: unexpected EOF", c->ident);
674 /** @brief Read a dot-stuffed list
676 * @param vecp Where to store list (UTF-8)
677 * @param nvecp Where to store number of items, or NULL
678 * @return 0 on success, non-0 on error
680 * The list will have a final NULL not counted in @p nvecp.
682 static int readlist(disorder_client *c, char ***vecp, int *nvecp) {
687 while(inputline(c->ident, c->fpin, &l, '\n') >= 0) {
688 if(!strcmp(l, ".")) {
689 vector_terminate(&v);
696 vector_append(&v, xstrdup(l + (*l == '.')));
699 if(ferror(c->fpin)) {
700 byte_xasprintf((char **)&c->last, "input error: %s", strerror(errno));
701 disorder_error(errno, "error reading %s", c->ident);
703 c->last = "input error: unexpxected EOF";
704 disorder_error(0, "error reading %s: unexpected EOF", c->ident);
709 /** @brief Return the user we logged in with
711 * @return User name (owned by @p c, don't modify)
713 char *disorder_user(disorder_client *c) {
717 static void pairlist_error_handler(const char *msg,
718 void attribute((unused)) *u) {
719 disorder_error(0, "error handling key-value pair reply: %s", msg);
722 /** @brief Get a list of key-value pairs
724 * @param kp Where to store linked list of preferences
726 * @param ... Arguments
727 * @return 0 on success, non-0 on error
729 static int pairlist(disorder_client *c, struct kvp **kp, const char *cmd, ...) {
731 int nvec, npvec, n, rc;
736 rc = disorder_simple_v(c, 0, cmd, ap);
740 if((rc = readlist(c, &vec, &nvec)))
742 for(n = 0; n < nvec; ++n) {
743 if(!(pvec = split(vec[n], &npvec, SPLIT_QUOTES, pairlist_error_handler, 0)))
746 pairlist_error_handler("malformed response", 0);
749 *kp = k = xmalloc(sizeof *k);
755 free_strings(nvec, vec);
760 /** @brief Parse a boolean response
761 * @param cmd Command for use in error messsage
762 * @param value Result from server
763 * @param flagp Where to store result
764 * @return 0 on success, non-0 on error
766 static int boolean(const char *cmd, const char *value,
768 if(!strcmp(value, "yes")) *flagp = 1;
769 else if(!strcmp(value, "no")) *flagp = 0;
771 disorder_error(0, "malformed response to '%s'", cmd);
777 /** @brief Log to a sink
779 * @param s Sink to write log lines to
780 * @return 0 on success, non-0 on error
782 int disorder_log(disorder_client *c, struct sink *s) {
786 if((rc = disorder_simple(c, 0, "log", (char *)0)))
788 while(inputline(c->ident, c->fpin, &l, '\n') >= 0 && strcmp(l, "."))
789 if(sink_printf(s, "%s\n", l) < 0) return -1;
790 if(ferror(c->fpin) || feof(c->fpin)) {
791 byte_xasprintf((char **)&c->last, "input error: %s",
792 ferror(c->fpin) ? strerror(errno) : "unexpxected EOF");
798 #include "client-stubs.c"