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 Issue a command and split the response
290 * @param vecp Where to store results
291 * @param nvecp Where to store count of results
292 * @param expected Expected count (or -1 to not check)
294 * @return 0 on success, non-0 on error
296 * The remaining arguments are command arguments, terminated by (char
297 * *)0. They should be in UTF-8.
299 * 5xx responses count as errors.
301 * @p rp will NOT be filled in for xx9 responses (where it is just
302 * commentary for a command where it would normally be meaningful).
304 * NB that the response will NOT be converted to the local encoding
305 * nor will quotes be stripped. See dequote().
307 static int disorder_simple_split(disorder_client
*c
,
311 const char *cmd
, ...) {
319 ret
= disorder_simple_v(c
, &r
, cmd
, ap
);
322 vec
= split(r
, &nvec
, SPLIT_QUOTES
, 0, 0);
324 if(expected
< 0 || nvec
== expected
) {
328 disorder_error(0, "malformed reply to %s", cmd
);
329 c
->last
= "malformed reply";
331 free_strings(nvec
, vec
);
341 /** @brief Dequote a result string
342 * @param rc 0 on success, non-0 on error
343 * @param rp Where result string is stored (UTF-8)
346 * This is used as a wrapper around disorder_simple() to dequote
349 static int dequote(int rc
, char **rp
) {
353 if((rr
= split(*rp
, 0, SPLIT_QUOTES
, 0, 0)) && *rr
) {
359 disorder_error(0, "invalid reply: %s", *rp
);
364 /** @brief Generic connection routine
365 * @param conf Configuration to follow
367 * @param username Username to log in with or NULL
368 * @param password Password to log in with or NULL
369 * @param cookie Cookie to log in with or NULL
370 * @return 0 on success, non-0 on error
372 * @p cookie is tried first if not NULL. If it is NULL then @p
373 * username must not be. If @p username is not NULL then nor may @p
376 int disorder_connect_generic(struct config
*conf
,
378 const char *username
,
379 const char *password
,
380 const char *cookie
) {
381 int fd
= -1, fd2
= -1, nrvec
= 0, rc
;
382 unsigned char *nonce
= NULL
;
385 char *r
= NULL
, **rvec
= NULL
;
386 const char *protocol
, *algorithm
, *challenge
;
387 struct sockaddr
*sa
= NULL
;
390 if((salen
= find_server(conf
, &sa
, &c
->ident
)) == (socklen_t
)-1)
392 c
->fpin
= c
->fpout
= 0;
393 if((fd
= socket(sa
->sa_family
, SOCK_STREAM
, 0)) < 0) {
394 byte_xasprintf((char **)&c
->last
, "socket: %s", strerror(errno
));
395 disorder_error(errno
, "error calling socket");
398 if(connect(fd
, sa
, salen
) < 0) {
399 byte_xasprintf((char **)&c
->last
, "connect: %s", strerror(errno
));
400 disorder_error(errno
, "error calling connect");
403 if((fd2
= dup(fd
)) < 0) {
404 byte_xasprintf((char **)&c
->last
, "dup: %s", strerror(errno
));
405 disorder_error(errno
, "error calling dup");
408 if(!(c
->fpin
= fdopen(fd
, "rb"))) {
409 byte_xasprintf((char **)&c
->last
, "fdopen: %s", strerror(errno
));
410 disorder_error(errno
, "error calling fdopen");
414 if(!(c
->fpout
= fdopen(fd2
, "wb"))) {
415 byte_xasprintf((char **)&c
->last
, "fdopen: %s", strerror(errno
));
416 disorder_error(errno
, "error calling fdopen");
420 if((rc
= disorder_simple(c
, &r
, 0, (const char *)0)))
422 if(!(rvec
= split(r
, &nrvec
, SPLIT_QUOTES
, 0, 0)))
425 c
->last
= "cannot parse server greeting";
426 disorder_error(0, "cannot parse server greeting %s", r
);
430 if(strcmp(protocol
, "2")) {
431 c
->last
= "unknown protocol version";
432 disorder_error(0, "unknown protocol version: %s", protocol
);
437 if(!(nonce
= unhex(challenge
, &nl
)))
440 if(!dequote(disorder_simple(c
, &c
->user
, "cookie", cookie
, (char *)0),
442 return 0; /* success */
444 c
->last
= "cookie failed and no username";
445 disorder_error(0, "cookie did not work and no username available");
449 if(!(res
= authhash(nonce
, nl
, password
, algorithm
))) {
450 c
->last
= "error computing authorization hash";
453 if((rc
= disorder_simple(c
, 0, "user", username
, res
, (char *)0)))
455 c
->user
= xstrdup(username
);
457 free_strings(nrvec
, rvec
);
473 if(fd2
!= -1) close(fd2
);
474 if(fd
!= -1) close(fd
);
478 /** @brief Connect a client with a specified username and password
480 * @param username Username to log in with
481 * @param password Password to log in with
482 * @return 0 on success, non-0 on error
484 int disorder_connect_user(disorder_client
*c
,
485 const char *username
,
486 const char *password
) {
487 return disorder_connect_generic(config
,
494 /** @brief Connect a client
496 * @return 0 on success, non-0 on error
498 * The connection will use the username and password found in @ref
499 * config, or directly from the database if no password is found and
500 * the database is readable (usually only for root).
502 int disorder_connect(disorder_client
*c
) {
503 const char *username
, *password
;
505 if(!(username
= config
->username
)) {
506 c
->last
= "no username";
507 disorder_error(0, "no username configured");
510 password
= config
->password
;
511 /* Maybe we can read the database */
512 if(!password
&& trackdb_readable()) {
513 trackdb_init(TRACKDB_NO_RECOVER
|TRACKDB_NO_UPGRADE
);
514 trackdb_open(TRACKDB_READ_ONLY
);
515 password
= trackdb_get_password(username
);
520 c
->last
= "no password";
521 disorder_error(0, "no password configured for user '%s'", username
);
524 return disorder_connect_generic(config
,
531 /** @brief Connect a client
533 * @param cookie Cookie to log in with, or NULL
534 * @return 0 on success, non-0 on error
536 * If @p cookie is NULL or does not work then we attempt to log in as
537 * guest instead (so when the cookie expires only an extra round trip
538 * is needed rathre than a complete new login).
540 int disorder_connect_cookie(disorder_client
*c
,
541 const char *cookie
) {
542 return disorder_connect_generic(config
,
549 /** @brief Close a client
551 * @return 0 on succcess, non-0 on errior
553 * The client is still closed even on error. It might well be
554 * appropriate to ignore the return value.
556 int disorder_close(disorder_client
*c
) {
560 if(fclose(c
->fpin
) < 0) {
561 byte_xasprintf((char **)&c
->last
, "fclose: %s", strerror(errno
));
562 disorder_error(errno
, "error calling fclose");
568 if(fclose(c
->fpout
) < 0) {
569 byte_xasprintf((char **)&c
->last
, "fclose: %s", strerror(errno
));
570 disorder_error(errno
, "error calling fclose");
582 static void client_error(const char *msg
,
583 void attribute((unused
)) *u
) {
584 disorder_error(0, "error parsing reply: %s", msg
);
587 /** @brief Get a single queue entry
590 * @param qp Where to store track information
591 * @return 0 on success, non-0 on error
593 static int onequeue(disorder_client
*c
, const char *cmd
,
594 struct queue_entry
**qp
) {
596 struct queue_entry
*q
;
599 if((rc
= disorder_simple(c
, &r
, cmd
, (char *)0)))
602 q
= xmalloc(sizeof *q
);
603 if(queue_unmarshall(q
, r
, client_error
, 0))
611 /** @brief Fetch the queue, recent list, etc */
612 static int readqueue(disorder_client
*c
,
613 struct queue_entry
**qp
) {
614 struct queue_entry
*qh
, **qt
= &qh
, *q
;
617 while(inputline(c
->ident
, c
->fpin
, &l
, '\n') >= 0) {
618 if(!strcmp(l
, ".")) {
624 q
= xmalloc(sizeof *q
);
625 if(!queue_unmarshall(q
, l
, client_error
, 0)) {
631 if(ferror(c
->fpin
)) {
632 byte_xasprintf((char **)&c
->last
, "input error: %s", strerror(errno
));
633 disorder_error(errno
, "error reading %s", c
->ident
);
635 c
->last
= "input error: unexpected EOF";
636 disorder_error(0, "error reading %s: unexpected EOF", c
->ident
);
641 /** @brief Read a dot-stuffed list
643 * @param vecp Where to store list (UTF-8)
644 * @param nvecp Where to store number of items, or NULL
645 * @return 0 on success, non-0 on error
647 * The list will have a final NULL not counted in @p nvecp.
649 static int readlist(disorder_client
*c
, char ***vecp
, int *nvecp
) {
654 while(inputline(c
->ident
, c
->fpin
, &l
, '\n') >= 0) {
655 if(!strcmp(l
, ".")) {
656 vector_terminate(&v
);
663 vector_append(&v
, xstrdup(l
+ (*l
== '.')));
666 if(ferror(c
->fpin
)) {
667 byte_xasprintf((char **)&c
->last
, "input error: %s", strerror(errno
));
668 disorder_error(errno
, "error reading %s", c
->ident
);
670 c
->last
= "input error: unexpxected EOF";
671 disorder_error(0, "error reading %s: unexpected EOF", c
->ident
);
676 /** @brief Return the user we logged in with
678 * @return User name (owned by @p c, don't modify)
680 char *disorder_user(disorder_client
*c
) {
684 static void pairlist_error_handler(const char *msg
,
685 void attribute((unused
)) *u
) {
686 disorder_error(0, "error handling key-value pair reply: %s", msg
);
689 /** @brief Get a list of key-value pairs
691 * @param kp Where to store linked list of preferences
693 * @param ... Arguments
694 * @return 0 on success, non-0 on error
696 static int pairlist(disorder_client
*c
, struct kvp
**kp
, const char *cmd
, ...) {
698 int nvec
, npvec
, n
, rc
;
703 rc
= disorder_simple_v(c
, 0, cmd
, ap
);
707 if((rc
= readlist(c
, &vec
, &nvec
)))
709 for(n
= 0; n
< nvec
; ++n
) {
710 if(!(pvec
= split(vec
[n
], &npvec
, SPLIT_QUOTES
, pairlist_error_handler
, 0)))
713 pairlist_error_handler("malformed response", 0);
716 *kp
= k
= xmalloc(sizeof *k
);
722 free_strings(nvec
, vec
);
727 /** @brief Parse a boolean response
728 * @param cmd Command for use in error messsage
729 * @param value Result from server
730 * @param flagp Where to store result
731 * @return 0 on success, non-0 on error
733 static int boolean(const char *cmd
, const char *value
,
735 if(!strcmp(value
, "yes")) *flagp
= 1;
736 else if(!strcmp(value
, "no")) *flagp
= 0;
738 disorder_error(0, "malformed response to '%s'", cmd
);
744 /** @brief Log to a sink
746 * @param s Sink to write log lines to
747 * @return 0 on success, non-0 on error
749 int disorder_log(disorder_client
*c
, struct sink
*s
) {
753 if((rc
= disorder_simple(c
, 0, "log", (char *)0)))
755 while(inputline(c
->ident
, c
->fpin
, &l
, '\n') >= 0 && strcmp(l
, "."))
756 if(sink_printf(s
, "%s\n", l
) < 0) return -1;
757 if(ferror(c
->fpin
) || feof(c
->fpin
)) {
758 byte_xasprintf((char **)&c
->last
, "input error: %s",
759 ferror(c
->fpin
) ?
strerror(errno
) : "unexpxected EOF");
765 #include "client-stubs.c"