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 Issue a command and parse a simple response
156 * @param rp Where to store result, or NULL
158 * @param ap Arguments (UTF-8), terminated by (char *)0
159 * @return 0 on success, non-0 on error
161 * 5xx responses count as errors.
163 * @p rp will NOT be filled in for xx9 responses (where it is just
164 * commentary for a command where it would normally be meaningful).
166 * NB that the response will NOT be converted to the local encoding
167 * nor will quotes be stripped. See dequote().
169 * Put @ref disorder__body in the argument list followed by a char **
170 * and int giving the body to follow the command. If the int is @c -1
171 * then the list is assumed to be NULL-terminated. This may be used
174 * Put @ref disorder__list in the argument list followed by a char **
175 * and int giving a list of arguments to include. If the int is @c -1
176 * then the list is assumed to be NULL-terminated. This may be used
177 * any number of times.
179 * Usually you would call this via one of the following interfaces:
180 * - disorder_simple()
182 static int disorder_simple_v(disorder_client *c,
193 c->last = "not connected";
194 disorder_error(0, "not connected to server");
199 dynstr_append_string(&d, cmd);
200 while((arg = va_arg(ap, const char *))) {
201 if(arg == disorder__body) {
202 body = va_arg(ap, char **);
203 nbody = va_arg(ap, int);
205 } else if(arg == disorder__list) {
206 char **list = va_arg(ap, char **);
207 int nlist = va_arg(ap, int);
209 for(nlist = 0; list[nlist]; ++nlist)
212 for(int n = 0; n < nlist; ++n) {
213 dynstr_append(&d, ' ');
214 dynstr_append_string(&d, quoteutf8(arg));
217 dynstr_append(&d, ' ');
218 dynstr_append_string(&d, quoteutf8(arg));
221 dynstr_append(&d, '\n');
222 dynstr_terminate(&d);
223 D(("command: %s", d.vec));
224 if(fputs(d.vec, c->fpout) < 0)
229 for(nbody = 0; body[nbody]; ++nbody)
231 for(int n = 0; n < nbody; ++n) {
232 if(body[n][0] == '.')
233 if(fputc('.', c->fpout) < 0)
235 if(fputs(body[n], c->fpout) < 0)
237 if(fputc('\n', c->fpout) < 0)
240 if(fputs(".\n", c->fpout) < 0)
246 return check_response(c, rp);
248 byte_xasprintf((char **)&c->last, "write error: %s", strerror(errno));
249 disorder_error(errno, "error writing to %s", c->ident);
253 /** @brief Issue a command and parse a simple response
255 * @param rp Where to store result, or NULL (UTF-8)
257 * @return 0 on success, non-0 on error
259 * The remaining arguments are command arguments, terminated by (char
260 * *)0. They should be in UTF-8.
262 * 5xx responses count as errors.
264 * @p rp will NOT be filled in for xx9 responses (where it is just
265 * commentary for a command where it would normally be meaningful).
267 * NB that the response will NOT be converted to the local encoding
268 * nor will quotes be stripped. See dequote().
270 static int disorder_simple(disorder_client *c,
272 const char *cmd, ...) {
277 ret = disorder_simple_v(c, rp, cmd, ap);
282 /** @brief Issue a command and split the response
284 * @param vecp Where to store results
285 * @param nvecp Where to store count of results
286 * @param expected Expected count (or -1 to not check)
288 * @return 0 on success, non-0 on error
290 * The remaining arguments are command arguments, terminated by (char
291 * *)0. They should be in UTF-8.
293 * 5xx responses count as errors.
295 * @p rp will NOT be filled in for xx9 responses (where it is just
296 * commentary for a command where it would normally be meaningful).
298 * NB that the response will NOT be converted to the local encoding
299 * nor will quotes be stripped. See dequote().
301 static int disorder_simple_split(disorder_client *c,
305 const char *cmd, ...) {
313 ret = disorder_simple_v(c, &r, cmd, ap);
316 vec = split(r, &nvec, SPLIT_QUOTES, 0, 0);
318 if(expected < 0 || nvec == expected) {
322 disorder_error(0, "malformed reply to %s", cmd);
323 c->last = "malformed reply";
325 free_strings(nvec, vec);
335 /** @brief Dequote a result string
336 * @param rc 0 on success, non-0 on error
337 * @param rp Where result string is stored (UTF-8)
340 * This is used as a wrapper around disorder_simple() to dequote
343 static int dequote(int rc, char **rp) {
347 if((rr = split(*rp, 0, SPLIT_QUOTES, 0, 0)) && *rr) {
353 disorder_error(0, "invalid reply: %s", *rp);
358 /** @brief Generic connection routine
359 * @param conf Configuration to follow
361 * @param username Username to log in with or NULL
362 * @param password Password to log in with or NULL
363 * @param cookie Cookie to log in with or NULL
364 * @return 0 on success, non-0 on error
366 * @p cookie is tried first if not NULL. If it is NULL then @p
367 * username must not be. If @p username is not NULL then nor may @p
370 int disorder_connect_generic(struct config *conf,
372 const char *username,
373 const char *password,
374 const char *cookie) {
375 int fd = -1, fd2 = -1, nrvec = 0, rc;
376 unsigned char *nonce = NULL;
379 char *r = NULL, **rvec = NULL;
380 const char *protocol, *algorithm, *challenge;
381 struct sockaddr *sa = NULL;
384 if((salen = find_server(conf, &sa, &c->ident)) == (socklen_t)-1)
386 c->fpin = c->fpout = 0;
387 if((fd = socket(sa->sa_family, SOCK_STREAM, 0)) < 0) {
388 byte_xasprintf((char **)&c->last, "socket: %s", strerror(errno));
389 disorder_error(errno, "error calling socket");
392 if(connect(fd, sa, salen) < 0) {
393 byte_xasprintf((char **)&c->last, "connect: %s", strerror(errno));
394 disorder_error(errno, "error calling connect");
397 if((fd2 = dup(fd)) < 0) {
398 byte_xasprintf((char **)&c->last, "dup: %s", strerror(errno));
399 disorder_error(errno, "error calling dup");
402 if(!(c->fpin = fdopen(fd, "rb"))) {
403 byte_xasprintf((char **)&c->last, "fdopen: %s", strerror(errno));
404 disorder_error(errno, "error calling fdopen");
408 if(!(c->fpout = fdopen(fd2, "wb"))) {
409 byte_xasprintf((char **)&c->last, "fdopen: %s", strerror(errno));
410 disorder_error(errno, "error calling fdopen");
414 if((rc = disorder_simple(c, &r, 0, (const char *)0)))
416 if(!(rvec = split(r, &nrvec, SPLIT_QUOTES, 0, 0)))
419 c->last = "cannot parse server greeting";
420 disorder_error(0, "cannot parse server greeting %s", r);
424 if(strcmp(protocol, "2")) {
425 c->last = "unknown protocol version";
426 disorder_error(0, "unknown protocol version: %s", protocol);
431 if(!(nonce = unhex(challenge, &nl)))
434 if(!dequote(disorder_simple(c, &c->user, "cookie", cookie, (char *)0),
436 return 0; /* success */
438 c->last = "cookie failed and no username";
439 disorder_error(0, "cookie did not work and no username available");
443 if(!(res = authhash(nonce, nl, password, algorithm))) {
444 c->last = "error computing authorization hash";
447 if((rc = disorder_simple(c, 0, "user", username, res, (char *)0)))
449 c->user = xstrdup(username);
451 free_strings(nrvec, rvec);
467 if(fd2 != -1) close(fd2);
468 if(fd != -1) close(fd);
472 /** @brief Connect a client with a specified username and password
474 * @param username Username to log in with
475 * @param password Password to log in with
476 * @return 0 on success, non-0 on error
478 int disorder_connect_user(disorder_client *c,
479 const char *username,
480 const char *password) {
481 return disorder_connect_generic(config,
488 /** @brief Connect a client
490 * @return 0 on success, non-0 on error
492 * The connection will use the username and password found in @ref
493 * config, or directly from the database if no password is found and
494 * the database is readable (usually only for root).
496 int disorder_connect(disorder_client *c) {
497 const char *username, *password;
499 if(!(username = config->username)) {
500 c->last = "no username";
501 disorder_error(0, "no username configured");
504 password = config->password;
505 /* Maybe we can read the database */
506 if(!password && trackdb_readable()) {
507 trackdb_init(TRACKDB_NO_RECOVER|TRACKDB_NO_UPGRADE);
508 trackdb_open(TRACKDB_READ_ONLY);
509 password = trackdb_get_password(username);
514 c->last = "no password";
515 disorder_error(0, "no password configured for user '%s'", username);
518 return disorder_connect_generic(config,
525 /** @brief Connect a client
527 * @param cookie Cookie to log in with, or NULL
528 * @return 0 on success, non-0 on error
530 * If @p cookie is NULL or does not work then we attempt to log in as
531 * guest instead (so when the cookie expires only an extra round trip
532 * is needed rathre than a complete new login).
534 int disorder_connect_cookie(disorder_client *c,
535 const char *cookie) {
536 return disorder_connect_generic(config,
543 /** @brief Close a client
545 * @return 0 on succcess, non-0 on errior
547 * The client is still closed even on error. It might well be
548 * appropriate to ignore the return value.
550 int disorder_close(disorder_client *c) {
554 if(fclose(c->fpin) < 0) {
555 byte_xasprintf((char **)&c->last, "fclose: %s", strerror(errno));
556 disorder_error(errno, "error calling fclose");
562 if(fclose(c->fpout) < 0) {
563 byte_xasprintf((char **)&c->last, "fclose: %s", strerror(errno));
564 disorder_error(errno, "error calling fclose");
576 static void client_error(const char *msg,
577 void attribute((unused)) *u) {
578 disorder_error(0, "error parsing reply: %s", msg);
581 /** @brief Get a single queue entry
584 * @param qp Where to store track information
585 * @return 0 on success, non-0 on error
587 static int onequeue(disorder_client *c, const char *cmd,
588 struct queue_entry **qp) {
590 struct queue_entry *q;
593 if((rc = disorder_simple(c, &r, cmd, (char *)0)))
596 q = xmalloc(sizeof *q);
597 if(queue_unmarshall(q, r, client_error, 0))
605 /** @brief Fetch the queue, recent list, etc */
606 static int readqueue(disorder_client *c,
607 struct queue_entry **qp) {
608 struct queue_entry *qh, **qt = &qh, *q;
611 while(inputline(c->ident, c->fpin, &l, '\n') >= 0) {
612 if(!strcmp(l, ".")) {
618 q = xmalloc(sizeof *q);
619 if(!queue_unmarshall(q, l, client_error, 0)) {
625 if(ferror(c->fpin)) {
626 byte_xasprintf((char **)&c->last, "input error: %s", strerror(errno));
627 disorder_error(errno, "error reading %s", c->ident);
629 c->last = "input error: unexpected EOF";
630 disorder_error(0, "error reading %s: unexpected EOF", c->ident);
635 /** @brief Read a dot-stuffed list
637 * @param vecp Where to store list (UTF-8)
638 * @param nvecp Where to store number of items, or NULL
639 * @return 0 on success, non-0 on error
641 * The list will have a final NULL not counted in @p nvecp.
643 static int readlist(disorder_client *c, char ***vecp, int *nvecp) {
648 while(inputline(c->ident, c->fpin, &l, '\n') >= 0) {
649 if(!strcmp(l, ".")) {
650 vector_terminate(&v);
657 vector_append(&v, xstrdup(l + (*l == '.')));
660 if(ferror(c->fpin)) {
661 byte_xasprintf((char **)&c->last, "input error: %s", strerror(errno));
662 disorder_error(errno, "error reading %s", c->ident);
664 c->last = "input error: unexpxected EOF";
665 disorder_error(0, "error reading %s: unexpected EOF", c->ident);
670 /** @brief Return the user we logged in with
672 * @return User name (owned by @p c, don't modify)
674 char *disorder_user(disorder_client *c) {
678 static void pairlist_error_handler(const char *msg,
679 void attribute((unused)) *u) {
680 disorder_error(0, "error handling key-value pair reply: %s", msg);
683 /** @brief Get a list of key-value pairs
685 * @param kp Where to store linked list of preferences
687 * @param ... Arguments
688 * @return 0 on success, non-0 on error
690 static int pairlist(disorder_client *c, struct kvp **kp, const char *cmd, ...) {
692 int nvec, npvec, n, rc;
697 rc = disorder_simple_v(c, 0, cmd, ap);
701 if((rc = readlist(c, &vec, &nvec)))
703 for(n = 0; n < nvec; ++n) {
704 if(!(pvec = split(vec[n], &npvec, SPLIT_QUOTES, pairlist_error_handler, 0)))
707 pairlist_error_handler("malformed response", 0);
710 *kp = k = xmalloc(sizeof *k);
716 free_strings(nvec, vec);
721 /** @brief Parse a boolean response
722 * @param cmd Command for use in error messsage
723 * @param value Result from server
724 * @param flagp Where to store result
725 * @return 0 on success, non-0 on error
727 static int boolean(const char *cmd, const char *value,
729 if(!strcmp(value, "yes")) *flagp = 1;
730 else if(!strcmp(value, "no")) *flagp = 0;
732 disorder_error(0, "malformed response to '%s'", cmd);
738 /** @brief Log to a sink
740 * @param s Sink to write log lines to
741 * @return 0 on success, non-0 on error
743 int disorder_log(disorder_client *c, struct sink *s) {
747 if((rc = disorder_simple(c, 0, "log", (char *)0)))
749 while(inputline(c->ident, c->fpin, &l, '\n') >= 0 && strcmp(l, "."))
750 if(sink_printf(s, "%s\n", l) < 0) return -1;
751 if(ferror(c->fpin) || feof(c->fpin)) {
752 byte_xasprintf((char **)&c->last, "input error: %s",
753 ferror(c->fpin) ? strerror(errno) : "unexpxected EOF");
759 #include "client-stubs.c"