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 * Put @ref disorder__integer in the argument list followed by a long to
180 * send its value in decimal. This may be used any number of times.
182 * Put @ref disorder__time in the argument list followed by a time_t
183 * to send its value in decimal. This may be used any number of
186 * Usually you would call this via one of the following interfaces:
187 * - disorder_simple()
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));
223 } else if(arg == disorder__integer) {
224 long n = va_arg(ap, long);
226 snprintf(buffer, sizeof buffer, "%ld", n);
227 dynstr_append(&d, ' ');
228 dynstr_append_string(&d, buffer);
229 } else if(arg == disorder__time) {
230 time_t n = va_arg(ap, time_t);
232 snprintf(buffer, sizeof buffer, "%lld", (long long)n);
233 dynstr_append(&d, ' ');
234 dynstr_append_string(&d, buffer);
236 dynstr_append(&d, ' ');
237 dynstr_append_string(&d, quoteutf8(arg));
240 dynstr_append(&d, '\n');
241 dynstr_terminate(&d);
242 D(("command: %s", d.vec));
243 if(fputs(d.vec, c->fpout) < 0)
248 for(nbody = 0; body[nbody]; ++nbody)
250 for(int n = 0; n < nbody; ++n) {
251 if(body[n][0] == '.')
252 if(fputc('.', c->fpout) < 0)
254 if(fputs(body[n], c->fpout) < 0)
256 if(fputc('\n', c->fpout) < 0)
259 if(fputs(".\n", c->fpout) < 0)
265 return check_response(c, rp);
267 byte_xasprintf((char **)&c->last, "write error: %s", strerror(errno));
268 disorder_error(errno, "error writing to %s", c->ident);
272 /** @brief Issue a command and parse a simple response
274 * @param rp Where to store result, or NULL (UTF-8)
276 * @return 0 on success, non-0 on error
278 * The remaining arguments are command arguments, terminated by (char
279 * *)0. They should be in UTF-8.
281 * 5xx responses count as errors.
283 * @p rp will NOT be filled in for xx9 responses (where it is just
284 * commentary for a command where it would normally be meaningful).
286 * NB that the response will NOT be converted to the local encoding
287 * nor will quotes be stripped. See dequote().
289 static int disorder_simple(disorder_client *c,
291 const char *cmd, ...) {
296 ret = disorder_simple_v(c, rp, cmd, ap);
301 /** @brief Issue a command and split the response
303 * @param vecp Where to store results
304 * @param nvecp Where to store count of results
305 * @param expected Expected count (or -1 to not check)
307 * @return 0 on success, non-0 on error
309 * The remaining arguments are command arguments, terminated by (char
310 * *)0. They should be in UTF-8.
312 * 5xx responses count as errors.
314 * @p rp will NOT be filled in for xx9 responses (where it is just
315 * commentary for a command where it would normally be meaningful).
317 * NB that the response will NOT be converted to the local encoding
318 * nor will quotes be stripped. See dequote().
320 static int disorder_simple_split(disorder_client *c,
324 const char *cmd, ...) {
332 ret = disorder_simple_v(c, &r, cmd, ap);
335 vec = split(r, &nvec, SPLIT_QUOTES, 0, 0);
337 if(expected < 0 || nvec == expected) {
341 disorder_error(0, "malformed reply to %s", cmd);
342 c->last = "malformed reply";
344 free_strings(nvec, vec);
354 /** @brief Dequote a result string
355 * @param rc 0 on success, non-0 on error
356 * @param rp Where result string is stored (UTF-8)
359 * This is used as a wrapper around disorder_simple() to dequote
362 static int dequote(int rc, char **rp) {
366 if((rr = split(*rp, 0, SPLIT_QUOTES, 0, 0)) && *rr) {
372 disorder_error(0, "invalid reply: %s", *rp);
377 /** @brief Generic connection routine
378 * @param conf Configuration to follow
380 * @param username Username to log in with or NULL
381 * @param password Password to log in with or NULL
382 * @param cookie Cookie to log in with or NULL
383 * @return 0 on success, non-0 on error
385 * @p cookie is tried first if not NULL. If it is NULL then @p
386 * username must not be. If @p username is not NULL then nor may @p
389 int disorder_connect_generic(struct config *conf,
391 const char *username,
392 const char *password,
393 const char *cookie) {
394 int fd = -1, fd2 = -1, nrvec = 0, rc;
395 unsigned char *nonce = NULL;
398 char *r = NULL, **rvec = NULL;
399 const char *protocol, *algorithm, *challenge;
400 struct sockaddr *sa = NULL;
403 if((salen = find_server(conf, &sa, &c->ident)) == (socklen_t)-1)
405 c->fpin = c->fpout = 0;
406 if((fd = socket(sa->sa_family, SOCK_STREAM, 0)) < 0) {
407 byte_xasprintf((char **)&c->last, "socket: %s", strerror(errno));
408 disorder_error(errno, "error calling socket");
411 if(connect(fd, sa, salen) < 0) {
412 byte_xasprintf((char **)&c->last, "connect: %s", strerror(errno));
413 disorder_error(errno, "error calling connect");
416 if((fd2 = dup(fd)) < 0) {
417 byte_xasprintf((char **)&c->last, "dup: %s", strerror(errno));
418 disorder_error(errno, "error calling dup");
421 if(!(c->fpin = fdopen(fd, "rb"))) {
422 byte_xasprintf((char **)&c->last, "fdopen: %s", strerror(errno));
423 disorder_error(errno, "error calling fdopen");
427 if(!(c->fpout = fdopen(fd2, "wb"))) {
428 byte_xasprintf((char **)&c->last, "fdopen: %s", strerror(errno));
429 disorder_error(errno, "error calling fdopen");
433 if((rc = disorder_simple(c, &r, 0, (const char *)0)))
435 if(!(rvec = split(r, &nrvec, SPLIT_QUOTES, 0, 0)))
438 c->last = "cannot parse server greeting";
439 disorder_error(0, "cannot parse server greeting %s", r);
443 if(strcmp(protocol, "2")) {
444 c->last = "unknown protocol version";
445 disorder_error(0, "unknown protocol version: %s", protocol);
450 if(!(nonce = unhex(challenge, &nl)))
453 if(!dequote(disorder_simple(c, &c->user, "cookie", cookie, (char *)0),
455 return 0; /* success */
457 c->last = "cookie failed and no username";
458 disorder_error(0, "cookie did not work and no username available");
462 if(!(res = authhash(nonce, nl, password, algorithm))) {
463 c->last = "error computing authorization hash";
466 if((rc = disorder_simple(c, 0, "user", username, res, (char *)0)))
468 c->user = xstrdup(username);
470 free_strings(nrvec, rvec);
486 if(fd2 != -1) close(fd2);
487 if(fd != -1) close(fd);
491 /** @brief Connect a client with a specified username and password
493 * @param username Username to log in with
494 * @param password Password to log in with
495 * @return 0 on success, non-0 on error
497 int disorder_connect_user(disorder_client *c,
498 const char *username,
499 const char *password) {
500 return disorder_connect_generic(config,
507 /** @brief Connect a client
509 * @return 0 on success, non-0 on error
511 * The connection will use the username and password found in @ref
512 * config, or directly from the database if no password is found and
513 * the database is readable (usually only for root).
515 int disorder_connect(disorder_client *c) {
516 const char *username, *password;
518 if(!(username = config->username)) {
519 c->last = "no username";
520 disorder_error(0, "no username configured");
523 password = config->password;
524 /* Maybe we can read the database */
525 if(!password && trackdb_readable()) {
526 trackdb_init(TRACKDB_NO_RECOVER|TRACKDB_NO_UPGRADE);
527 trackdb_open(TRACKDB_READ_ONLY);
528 password = trackdb_get_password(username);
533 c->last = "no password";
534 disorder_error(0, "no password configured for user '%s'", username);
537 return disorder_connect_generic(config,
544 /** @brief Connect a client
546 * @param cookie Cookie to log in with, or NULL
547 * @return 0 on success, non-0 on error
549 * If @p cookie is NULL or does not work then we attempt to log in as
550 * guest instead (so when the cookie expires only an extra round trip
551 * is needed rathre than a complete new login).
553 int disorder_connect_cookie(disorder_client *c,
554 const char *cookie) {
555 return disorder_connect_generic(config,
562 /** @brief Close a client
564 * @return 0 on succcess, non-0 on errior
566 * The client is still closed even on error. It might well be
567 * appropriate to ignore the return value.
569 int disorder_close(disorder_client *c) {
573 if(fclose(c->fpin) < 0) {
574 byte_xasprintf((char **)&c->last, "fclose: %s", strerror(errno));
575 disorder_error(errno, "error calling fclose");
581 if(fclose(c->fpout) < 0) {
582 byte_xasprintf((char **)&c->last, "fclose: %s", strerror(errno));
583 disorder_error(errno, "error calling fclose");
595 static void client_error(const char *msg,
596 void attribute((unused)) *u) {
597 disorder_error(0, "error parsing reply: %s", msg);
600 /** @brief Get a single queue entry
603 * @param qp Where to store track information
604 * @return 0 on success, non-0 on error
606 static int onequeue(disorder_client *c, const char *cmd,
607 struct queue_entry **qp) {
609 struct queue_entry *q;
612 if((rc = disorder_simple(c, &r, cmd, (char *)0)))
615 q = xmalloc(sizeof *q);
616 if(queue_unmarshall(q, r, client_error, 0))
624 /** @brief Fetch the queue, recent list, etc */
625 static int readqueue(disorder_client *c,
626 struct queue_entry **qp) {
627 struct queue_entry *qh, **qt = &qh, *q;
630 while(inputline(c->ident, c->fpin, &l, '\n') >= 0) {
631 if(!strcmp(l, ".")) {
637 q = xmalloc(sizeof *q);
638 if(!queue_unmarshall(q, l, client_error, 0)) {
644 if(ferror(c->fpin)) {
645 byte_xasprintf((char **)&c->last, "input error: %s", strerror(errno));
646 disorder_error(errno, "error reading %s", c->ident);
648 c->last = "input error: unexpected EOF";
649 disorder_error(0, "error reading %s: unexpected EOF", c->ident);
654 /** @brief Read a dot-stuffed list
656 * @param vecp Where to store list (UTF-8)
657 * @param nvecp Where to store number of items, or NULL
658 * @return 0 on success, non-0 on error
660 * The list will have a final NULL not counted in @p nvecp.
662 static int readlist(disorder_client *c, char ***vecp, int *nvecp) {
667 while(inputline(c->ident, c->fpin, &l, '\n') >= 0) {
668 if(!strcmp(l, ".")) {
669 vector_terminate(&v);
676 vector_append(&v, xstrdup(l + (*l == '.')));
679 if(ferror(c->fpin)) {
680 byte_xasprintf((char **)&c->last, "input error: %s", strerror(errno));
681 disorder_error(errno, "error reading %s", c->ident);
683 c->last = "input error: unexpxected EOF";
684 disorder_error(0, "error reading %s: unexpected EOF", c->ident);
689 /** @brief Return the user we logged in with
691 * @return User name (owned by @p c, don't modify)
693 char *disorder_user(disorder_client *c) {
697 static void pairlist_error_handler(const char *msg,
698 void attribute((unused)) *u) {
699 disorder_error(0, "error handling key-value pair reply: %s", msg);
702 /** @brief Get a list of key-value pairs
704 * @param kp Where to store linked list of preferences
706 * @param ... Arguments
707 * @return 0 on success, non-0 on error
709 static int pairlist(disorder_client *c, struct kvp **kp, const char *cmd, ...) {
711 int nvec, npvec, n, rc;
716 rc = disorder_simple_v(c, 0, cmd, ap);
720 if((rc = readlist(c, &vec, &nvec)))
722 for(n = 0; n < nvec; ++n) {
723 if(!(pvec = split(vec[n], &npvec, SPLIT_QUOTES, pairlist_error_handler, 0)))
726 pairlist_error_handler("malformed response", 0);
729 *kp = k = xmalloc(sizeof *k);
735 free_strings(nvec, vec);
740 /** @brief Parse a boolean response
741 * @param cmd Command for use in error messsage
742 * @param value Result from server
743 * @param flagp Where to store result
744 * @return 0 on success, non-0 on error
746 static int boolean(const char *cmd, const char *value,
748 if(!strcmp(value, "yes")) *flagp = 1;
749 else if(!strcmp(value, "no")) *flagp = 0;
751 disorder_error(0, "malformed response to '%s'", cmd);
757 /** @brief Log to a sink
759 * @param s Sink to write log lines to
760 * @return 0 on success, non-0 on error
762 int disorder_log(disorder_client *c, struct sink *s) {
766 if((rc = disorder_simple(c, 0, "log", (char *)0)))
768 while(inputline(c->ident, c->fpin, &l, '\n') >= 0 && strcmp(l, "."))
769 if(sink_printf(s, "%s\n", l) < 0) return -1;
770 if(ferror(c->fpin) || feof(c->fpin)) {
771 byte_xasprintf((char **)&c->last, "input error: %s",
772 ferror(c->fpin) ? strerror(errno) : "unexpxected EOF");
778 #include "client-stubs.c"