2 * This file is part of DisOrder.
3 * Copyright (C) 2006, 2007 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 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful, but
11 * WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * 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, write to the Free Software
17 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
20 /** @file lib/eclient.c
21 * @brief Client code for event-driven programs
27 #include <sys/types.h>
28 #include <sys/socket.h>
29 #include <netinet/in.h>
43 #include "configuration.h"
50 #include "inputline.h"
57 #include "client-common.h"
59 /* TODO: more commands */
61 /* Types *********************************************************************/
63 /** @brief Client state */
65 state_disconnected, /**< @brief not connected */
66 state_connecting, /**< @brief waiting for connect() */
67 state_connected, /**< @brief connected but not authenticated */
68 state_idle, /**< @brief not doing anything */
69 state_cmdresponse, /**< @brief waiting for command resonse */
70 state_body, /**< @brief accumulating body */
71 state_log, /**< @brief monitoring log */
74 /** @brief Names for @ref client_state */
75 static const char *const states[] = {
85 struct operation; /* forward decl */
87 /** @brief Type of an operation callback */
88 typedef void operation_callback(disorder_eclient *c, struct operation *op);
90 /** @brief A pending operation.
92 * This can be either a command or part of the authentication protocol. In the
93 * former case new commands are appended to the list, in the latter case they
94 * are inserted at the front. */
96 struct operation *next; /**< @brief next operation */
97 char *cmd; /**< @brief command to send or 0 */
98 operation_callback *opcallback; /**< @brief internal completion callback */
99 void (*completed)(); /**< @brief user completion callback or 0 */
100 void *v; /**< @brief data for COMPLETED */
101 disorder_eclient *client; /**< @brief owning client */
103 /** @brief true if sent to server
105 * This is cleared by disorder_eclient_close(), forcing all queued
106 * commands to be transparently resent.
111 /** @brief Client structure */
112 struct disorder_eclient {
114 int fd; /**< @brief connection to server */
115 enum client_state state; /**< @brief current state */
116 int authenticated; /**< @brief true when authenicated */
117 struct dynstr output; /**< @brief output buffer */
118 struct dynstr input; /**< @brief input buffer */
119 int eof; /**< @brief input buffer is at EOF */
120 const disorder_eclient_callbacks *callbacks; /**< @brief error callbacks */
121 void *u; /**< @brief user data */
122 struct operation *ops; /**< @brief queue of operations */
123 struct operation **opstail; /**< @brief queue tail */
124 /* accumulated response */
125 int rc; /**< @brief response code */
126 char *line; /**< @brief complete line */
127 struct vector vec; /**< @brief body */
128 const disorder_eclient_log_callbacks *log_callbacks; /**< @brief log callbacks */
129 void *log_v; /**< @brief user data */
130 unsigned long statebits; /**< @brief latest state */
133 /* Forward declarations ******************************************************/
135 static int start_connect(void *cc,
136 const struct sockaddr *sa,
139 static void process_line(disorder_eclient *c, char *line);
140 static int start_connect(void *cc,
141 const struct sockaddr *sa,
144 static void maybe_connected(disorder_eclient *c);
145 static void authbanner_opcallback(disorder_eclient *c,
146 struct operation *op);
147 static void authuser_opcallback(disorder_eclient *c,
148 struct operation *op);
149 static void complete(disorder_eclient *c);
150 static void send_output(disorder_eclient *c);
151 static void put(disorder_eclient *c, const char *s, size_t n);
152 static void read_input(disorder_eclient *c);
153 static void stash_command(disorder_eclient *c,
155 operation_callback *opcallback,
160 static void log_opcallback(disorder_eclient *c, struct operation *op);
161 static void logline(disorder_eclient *c, const char *line);
162 static void logentry_completed(disorder_eclient *c, int nvec, char **vec);
163 static void logentry_failed(disorder_eclient *c, int nvec, char **vec);
164 static void logentry_moved(disorder_eclient *c, int nvec, char **vec);
165 static void logentry_playing(disorder_eclient *c, int nvec, char **vec);
166 static void logentry_queue(disorder_eclient *c, int nvec, char **vec);
167 static void logentry_recent_added(disorder_eclient *c, int nvec, char **vec);
168 static void logentry_recent_removed(disorder_eclient *c, int nvec, char **vec);
169 static void logentry_removed(disorder_eclient *c, int nvec, char **vec);
170 static void logentry_scratched(disorder_eclient *c, int nvec, char **vec);
171 static void logentry_state(disorder_eclient *c, int nvec, char **vec);
172 static void logentry_volume(disorder_eclient *c, int nvec, char **vec);
174 /* Tables ********************************************************************/
176 /** @brief One possible log entry */
177 struct logentry_handler {
178 const char *name; /**< @brief Entry name */
179 int min; /**< @brief Minimum arguments */
180 int max; /**< @brief Maximum arguments */
181 void (*handler)(disorder_eclient *c,
183 char **vec); /**< @brief Handler function */
186 /** @brief Table for parsing log entries */
187 static const struct logentry_handler logentry_handlers[] = {
188 #define LE(X, MIN, MAX) { #X, MIN, MAX, logentry_##X }
193 LE(queue, 2, INT_MAX),
194 LE(recent_added, 2, INT_MAX),
195 LE(recent_removed, 1, 1),
202 /* Setup and teardown ********************************************************/
204 /** @brief Create a new client
206 * Does NOT connect the client - connections are made (and re-made) on demand.
208 disorder_eclient *disorder_eclient_new(const disorder_eclient_callbacks *cb,
210 disorder_eclient *c = xmalloc(sizeof *c);
211 D(("disorder_eclient_new"));
215 c->opstail = &c->ops;
216 vector_init(&c->vec);
217 dynstr_init(&c->input);
218 dynstr_init(&c->output);
219 if(!config->password) {
220 error(0, "no password set");
226 /** @brief Disconnect a client
227 * @param c Client to disconnect
229 * NB that this routine just disconnnects the TCP connection. It does not
230 * destroy the client! If you continue to use it then it will attempt to
233 void disorder_eclient_close(disorder_eclient *c) {
234 struct operation *op;
236 D(("disorder_eclient_close"));
238 D(("disorder_eclient_close closing fd %d", c->fd));
239 c->callbacks->poll(c->u, c, c->fd, 0);
242 c->state = state_disconnected;
248 c->authenticated = 0;
249 /* We'll need to resend all operations */
250 for(op = c->ops; op; op = op->next)
252 /* Drop our use a hint that we're disconnected */
253 if(c->log_callbacks && c->log_callbacks->state)
254 c->log_callbacks->state(c->log_v, c->statebits);
257 /** @brief Return current state */
258 unsigned long disorder_eclient_state(const disorder_eclient *c) {
259 return c->statebits | (c->state > state_connected ? DISORDER_CONNECTED : 0);
262 /* Error reporting ***********************************************************/
264 /** @brief called when a connection error occurs
266 * After this called we will be disconnected (by disorder_eclient_close()),
267 * so there will be a reconnection before any commands can be sent.
269 static int comms_error(disorder_eclient *c, const char *fmt, ...) {
275 byte_xvasprintf(&s, fmt, ap);
277 disorder_eclient_close(c);
278 c->callbacks->comms_error(c->u, s);
282 /** @brief called when the server reports an error */
283 static int protocol_error(disorder_eclient *c, struct operation *op,
284 int code, const char *fmt, ...) {
288 D(("protocol_error"));
290 byte_xvasprintf(&s, fmt, ap);
292 c->callbacks->protocol_error(c->u, op->v, code, s);
296 /* State machine *************************************************************/
298 /** @brief Called when there's something to do
300 * @param mode bitmap of @ref DISORDER_POLL_READ and/or @ref DISORDER_POLL_WRITE.
302 * This should be called from by your code when the file descriptor is readable
303 * or writable (as requested by the @c poll callback, see @ref
304 * disorder_eclient_callbacks) and in any case from time to time (with @p mode
305 * = 0) to allow for retries to work.
307 void disorder_eclient_polled(disorder_eclient *c, unsigned mode) {
308 struct operation *op;
310 D(("disorder_eclient_polled fd=%d state=%s mode=[%s %s]",
311 c->fd, states[c->state],
312 mode & DISORDER_POLL_READ ? "READ" : "",
313 mode & DISORDER_POLL_WRITE ? "WRITE" : ""));
314 /* The pattern here is to check each possible state in turn and try to
315 * advance (though on error we might go back). If we advance we leave open
316 * the possibility of falling through to the next state, but we set the mode
317 * bits to 0, to avoid false positives (which matter more in some cases than
320 if(c->state == state_disconnected) {
321 D(("state_disconnected"));
322 with_sockaddr(c, start_connect);
323 /* might now be state_disconnected (on error), state_connecting (slow
324 * connect) or state_connected (fast connect). If state_disconnected then
325 * we just rely on a periodic callback from the event loop sometime. */
329 if(c->state == state_connecting && mode) {
330 D(("state_connecting"));
332 /* Might be state_disconnected (on error) or state_connected (on success).
333 * In the former case we rely on the event loop for a periodic callback to
338 if(c->state == state_connected) {
339 D(("state_connected"));
340 /* We just connected. Initiate the authentication protocol. */
341 stash_command(c, 1/*queuejump*/, authbanner_opcallback,
342 0/*completed*/, 0/*v*/, 0/*cmd*/);
343 /* We never stay is state_connected very long. We could in principle jump
344 * straight to state_cmdresponse since there's actually no command to
345 * send, but that would arguably be cheating. */
346 c->state = state_idle;
349 if(c->state == state_idle) {
351 /* We are connected, and have finished any command we set off, look for
355 if(c->authenticated) {
356 /* Transmit all unsent operations */
357 for(op = c->ops; op; op = op->next) {
359 put(c, op->cmd, strlen(op->cmd));
364 /* Just send the head operation */
365 if(c->ops->cmd && !c->ops->sent) {
366 put(c, c->ops->cmd, strlen(c->ops->cmd));
370 /* Awaiting response for the operation at the head of the list */
371 c->state = state_cmdresponse;
374 c->callbacks->report(c->u, 0);
377 if(c->state == state_cmdresponse
378 || c->state == state_body
379 || c->state == state_log) {
380 D(("state_%s", states[c->state]));
381 /* We are awaiting a response */
382 if(mode & DISORDER_POLL_WRITE) send_output(c);
383 if(mode & DISORDER_POLL_READ) read_input(c);
384 /* There are a couple of reasons we might want to re-enter the state
385 * machine from the top. state_idle is obvious: there may be further
386 * commands to process. Re-entering on state_disconnected means that we
387 * immediately retry connection if a comms error occurs during a command.
388 * This is different to the case where a connection fails, where we await a
389 * spontaneous call to initiate the retry. */
391 case state_disconnected: /* lost connection */
392 case state_idle: /* completed a command */
394 disorder_eclient_polled(c, 0);
401 /* Figure out what to set the mode to */
403 case state_disconnected:
404 D(("state_disconnected (2)"));
405 /* Probably an error occurred. Await a retry. */
408 case state_connecting:
409 D(("state_connecting (2)"));
410 /* Waiting for connect to complete */
411 mode = DISORDER_POLL_READ|DISORDER_POLL_WRITE;
413 case state_connected:
414 D(("state_connected (2)"));
415 assert(!"should never be in state_connected here");
418 D(("state_idle (2)"));
419 /* Connected but nothing to do. */
422 case state_cmdresponse:
425 D(("state_%s (2)", states[c->state]));
426 /* Gathering a response. Wait for input. */
427 mode = DISORDER_POLL_READ;
428 /* Flush any pending output. */
429 if(c->output.nvec) mode |= DISORDER_POLL_WRITE;
432 D(("fd=%d new mode [%s %s]",
434 mode & DISORDER_POLL_READ ? "READ" : "",
435 mode & DISORDER_POLL_WRITE ? "WRITE" : ""));
436 if(c->fd != -1) c->callbacks->poll(c->u, c, c->fd, mode);
439 /** @brief Called to start connecting */
440 static int start_connect(void *cc,
441 const struct sockaddr *sa,
444 disorder_eclient *c = cc;
446 D(("start_connect"));
447 c->ident = xstrdup(ident);
452 if((c->fd = socket(sa->sa_family, SOCK_STREAM, 0)) < 0)
453 return comms_error(c, "socket: %s", strerror(errno));
456 if(connect(c->fd, sa, len) < 0) {
460 c->state = state_connecting;
461 /* We are called from _polled so the state machine will get to do its
465 /* Signal the error to the caller. */
466 return comms_error(c, "connecting to %s: %s", ident, strerror(errno));
469 c->state = state_connected;
473 /** @brief Called when poll triggers while waiting for a connection */
474 static void maybe_connected(disorder_eclient *c) {
475 /* We either connected, or got an error. */
477 socklen_t len = sizeof err;
479 D(("maybe_connected"));
480 /* Work around over-enthusiastic error slippage */
481 if(getsockopt(c->fd, SOL_SOCKET, SO_ERROR, &err, &len) < 0)
484 /* The connection failed */
485 comms_error(c, "connecting to %s: %s", c->ident, strerror(err));
486 /* sets state_disconnected */
490 /* The connection succeeded */
491 c->state = state_connected;
492 byte_xasprintf(&r, "connected to %s", c->ident);
493 c->callbacks->report(c->u, r);
494 /* If this is a log client we expect to get a bunch of updates from the
495 * server straight away */
499 /* Authentication ************************************************************/
501 static void authbanner_opcallback(disorder_eclient *c,
502 struct operation *op) {
504 const unsigned char *nonce;
508 const char *algo = "SHA1";
510 D(("authbanner_opcallback"));
512 || !(rvec = split(c->line + 4, &nrvec, SPLIT_QUOTES, 0, 0))
514 /* Banner told us to go away, or was malformed. We cannot proceed. */
515 protocol_error(c, op, c->rc, "%s: %s", c->ident, c->line);
516 disorder_eclient_close(c);
523 nonce = unhex(rvec[0], &nonce_len);
524 res = authhash(nonce, nonce_len, config->password, algo);
526 protocol_error(c, op, c->rc, "%s: unknown authentication algorithm '%s'",
528 disorder_eclient_close(c);
531 stash_command(c, 1/*queuejump*/, authuser_opcallback, 0/*completed*/, 0/*v*/,
532 "user", quoteutf8(config->username), quoteutf8(res),
536 static void authuser_opcallback(disorder_eclient *c,
537 struct operation *op) {
540 D(("authuser_opcallback"));
541 if(c->rc / 100 != 2) {
542 /* Wrong password or something. We cannot proceed. */
543 protocol_error(c, op, c->rc, "%s: %s", c->ident, c->line);
544 disorder_eclient_close(c);
547 /* OK, we're authenticated now. */
548 c->authenticated = 1;
549 byte_xasprintf(&r, "authenticated with %s", c->ident);
550 c->callbacks->report(c->u, r);
551 if(c->log_callbacks && !(c->ops && c->ops->opcallback == log_opcallback))
552 /* We are a log client, switch to logging mode */
553 stash_command(c, 0/*queuejump*/, log_opcallback, 0/*completed*/, c->log_v,
557 /* Output ********************************************************************/
559 /* Chop N bytes off the front of a dynstr */
560 static void consume(struct dynstr *d, int n) {
561 D(("consume %d", n));
562 assert(d->nvec >= n);
563 memmove(d->vec, d->vec + n, d->nvec - n);
567 /* Write some bytes */
568 static void put(disorder_eclient *c, const char *s, size_t n) {
569 D(("put %d %.*s", c->fd, (int)n, s));
570 dynstr_append_bytes(&c->output, s, n);
573 /* Called when we can write to our FD, or at any other time */
574 static void send_output(disorder_eclient *c) {
577 D(("send_output %d bytes pending", c->output.nvec));
578 if(c->state > state_connecting && c->output.nvec) {
579 n = write(c->fd, c->output.vec, c->output.nvec);
586 comms_error(c, "writing to %s: %s", c->ident, strerror(errno));
590 consume(&c->output, n);
594 /* Input *********************************************************************/
596 /* Called when c->fd might be readable, or at any other time */
597 static void read_input(disorder_eclient *c) {
602 D(("read_input in state %s", states[c->state]));
603 if(c->state <= state_connected) return; /* ignore bogus calls */
604 /* read some more input */
605 n = read(c->fd, buffer, sizeof buffer);
612 comms_error(c, "reading from %s: %s", c->ident, strerror(errno));
615 return; /* no new input to process */
617 D(("read %d bytes: [%.*s]", n, n, buffer));
618 dynstr_append_bytes(&c->input, buffer, n);
621 /* might have more than one line to process */
622 while(c->state > state_connecting
623 && (nl = memchr(c->input.vec, '\n', c->input.nvec))) {
624 process_line(c, xstrndup(c->input.vec, nl - c->input.vec));
625 /* we might have disconnected along the way, which zogs the input buffer */
626 if(c->state > state_connecting)
627 consume(&c->input, (nl - c->input.vec) + 1);
630 comms_error(c, "reading from %s: server disconnected", c->ident);
631 c->authenticated = 0;
635 /* called with a line that has just been read */
636 static void process_line(disorder_eclient *c, char *line) {
637 D(("process_line %d [%s]", c->fd, line));
639 case state_cmdresponse:
640 /* This is the first line of a response */
641 if(!(line[0] >= '0' && line[0] <= '9'
642 && line[1] >= '0' && line[1] <= '9'
643 && line[2] >= '0' && line[2] <= '9'
645 fatal(0, "invalid response from server: %s", line);
646 c->rc = (line[0] * 10 + line[1]) * 10 + line[2] - 111 * '0';
650 /* We need to collect the body. */
651 c->state = state_body;
655 assert(c->log_callbacks != 0);
656 if(c->log_callbacks->connected)
657 c->log_callbacks->connected(c->log_v);
658 c->state = state_log;
661 /* We've got the whole response. Go into the idle state so the state
662 * machine knows we're done and then call the operation callback. */
668 if(strcmp(line, ".")) {
669 /* A line from the body */
670 vector_append(&c->vec, line + (line[0] == '.'));
672 /* End of the body. */
673 vector_terminate(&c->vec);
678 if(strcmp(line, ".")) {
679 logline(c, line + (line[0] == '.'));
684 assert(!"wrong state for location");
689 /* Called when an operation completes */
690 static void complete(disorder_eclient *c) {
691 struct operation *op;
694 /* Pop the operation off the queue */
697 if(c->opstail == &op->next)
698 c->opstail = &c->ops;
699 /* If we've pipelined a command ahead then we go straight to cmdresponser.
700 * Otherwise we go to idle, which will arrange further sends. */
701 c->state = c->ops && c->ops->sent ? state_cmdresponse : state_idle;
702 op->opcallback(c, op);
703 /* Note that we always call the opcallback even on error, though command
704 * opcallbacks generally always do the same error handling, i.e. just call
705 * protocol_error(). It's the auth* opcallbacks that have different
709 /* Operation setup ***********************************************************/
711 static void stash_command_vector(disorder_eclient *c,
713 operation_callback *opcallback,
718 struct operation *op = xmalloc(sizeof *op);
724 for(n = 0; n < ncmd; ++n) {
726 dynstr_append(&d, ' ');
727 dynstr_append_string(&d, quoteutf8(cmd[n]));
729 dynstr_append(&d, '\n');
730 dynstr_terminate(&d);
733 op->cmd = 0; /* usually, awaiting challenge */
734 op->opcallback = opcallback;
735 op->completed = completed;
739 assert(op->sent == 0);
741 /* Authentication operations jump the queue of useful commands */
744 if(c->opstail == &c->ops)
745 c->opstail = &op->next;
746 for(op = c->ops; op; op = op->next)
750 c->opstail = &op->next;
754 static void vstash_command(disorder_eclient *c,
756 operation_callback *opcallback,
759 const char *cmd, va_list ap) {
763 D(("vstash_command %s", cmd ? cmd : "NULL"));
766 vector_append(&vec, (char *)cmd);
767 while((arg = va_arg(ap, char *)))
768 vector_append(&vec, arg);
769 stash_command_vector(c, queuejump, opcallback, completed, v,
772 stash_command_vector(c, queuejump, opcallback, completed, v, 0, 0);
775 static void stash_command(disorder_eclient *c,
777 operation_callback *opcallback,
785 vstash_command(c, queuejump, opcallback, completed, v, cmd, ap);
789 /* Command support ***********************************************************/
791 /* for commands with a simple string response */
792 static void string_response_opcallback(disorder_eclient *c,
793 struct operation *op) {
794 D(("string_response_callback"));
795 if(c->rc / 100 == 2) {
797 ((disorder_eclient_string_response *)op->completed)(op->v, c->line + 4);
799 protocol_error(c, op, c->rc, "%s: %s", c->ident, c->line);
802 /* for commands with a simple integer response */
803 static void integer_response_opcallback(disorder_eclient *c,
804 struct operation *op) {
805 D(("string_response_callback"));
806 if(c->rc / 100 == 2) {
808 ((disorder_eclient_integer_response *)op->completed)
809 (op->v, strtol(c->line + 4, 0, 10));
811 protocol_error(c, op, c->rc, "%s: %s", c->ident, c->line);
814 /* for commands with no response */
815 static void no_response_opcallback(disorder_eclient *c,
816 struct operation *op) {
817 D(("no_response_callback"));
818 if(c->rc / 100 == 2) {
820 ((disorder_eclient_no_response *)op->completed)(op->v);
822 protocol_error(c, op, c->rc, "%s: %s", c->ident, c->line);
825 /* error callback for queue_unmarshall */
826 static void eclient_queue_error(const char *msg,
828 struct operation *op = u;
830 protocol_error(op->client, op, -1, "error parsing queue entry: %s", msg);
833 /* for commands that expect a queue dump */
834 static void queue_response_opcallback(disorder_eclient *c,
835 struct operation *op) {
837 struct queue_entry *q, *qh = 0, **qtail = &qh, *qlast = 0;
839 D(("queue_response_callback"));
840 if(c->rc / 100 == 2) {
841 /* parse the queue */
842 for(n = 0; n < c->vec.nvec; ++n) {
843 q = xmalloc(sizeof *q);
844 D(("queue_unmarshall %s", c->vec.vec[n]));
845 if(!queue_unmarshall(q, c->vec.vec[n], eclient_queue_error, op)) {
853 ((disorder_eclient_queue_response *)op->completed)(op->v, qh);
855 protocol_error(c, op, c->rc, "%s: %s", c->ident, c->line);
859 static void playing_response_opcallback(disorder_eclient *c,
860 struct operation *op) {
861 struct queue_entry *q;
863 D(("playing_response_callback"));
864 if(c->rc / 100 == 2) {
867 if(queue_unmarshall(q = xmalloc(sizeof *q), c->line + 4,
868 eclient_queue_error, c))
875 protocol_error(c, op, c->rc, "%s: %s", c->ident, c->line);
879 ((disorder_eclient_queue_response *)op->completed)(op->v, q);
881 protocol_error(c, op, c->rc, "%s: %s", c->ident, c->line);
884 /* for commands that expect a list of some sort */
885 static void list_response_opcallback(disorder_eclient *c,
886 struct operation *op) {
887 D(("list_response_callback"));
888 if(c->rc / 100 == 2) {
890 ((disorder_eclient_list_response *)op->completed)(op->v,
894 protocol_error(c, op, c->rc, "%s: %s", c->ident, c->line);
898 static void volume_response_opcallback(disorder_eclient *c,
899 struct operation *op) {
902 D(("volume_response_callback"));
903 if(c->rc / 100 == 2) {
905 if(sscanf(c->line + 4, "%d %d", &l, &r) != 2 || l < 0 || r < 0)
906 protocol_error(c, op, -1, "%s: invalid volume response: %s",
909 ((disorder_eclient_volume_response *)op->completed)(op->v, l, r);
912 protocol_error(c, op, c->rc, "%s: %s", c->ident, c->line);
915 static int simple(disorder_eclient *c,
916 operation_callback *opcallback,
919 const char *cmd, ...) {
923 vstash_command(c, 0/*queuejump*/, opcallback, completed, v, cmd, ap);
925 /* Give the state machine a kick, since we might be in state_idle */
926 disorder_eclient_polled(c, 0);
930 /* Commands ******************************************************************/
932 int disorder_eclient_version(disorder_eclient *c,
933 disorder_eclient_string_response *completed,
935 return simple(c, string_response_opcallback, (void (*)())completed, v,
936 "version", (char *)0);
939 int disorder_eclient_namepart(disorder_eclient *c,
940 disorder_eclient_string_response *completed,
945 return simple(c, string_response_opcallback, (void (*)())completed, v,
946 "part", track, context, part, (char *)0);
949 int disorder_eclient_play(disorder_eclient *c,
951 disorder_eclient_no_response *completed,
953 return simple(c, no_response_opcallback, (void (*)())completed, v,
954 "play", track, (char *)0);
957 int disorder_eclient_pause(disorder_eclient *c,
958 disorder_eclient_no_response *completed,
960 return simple(c, no_response_opcallback, (void (*)())completed, v,
964 int disorder_eclient_resume(disorder_eclient *c,
965 disorder_eclient_no_response *completed,
967 return simple(c, no_response_opcallback, (void (*)())completed, v,
968 "resume", (char *)0);
971 int disorder_eclient_scratch(disorder_eclient *c,
973 disorder_eclient_no_response *completed,
975 return simple(c, no_response_opcallback, (void (*)())completed, v,
976 "scratch", id, (char *)0);
979 int disorder_eclient_scratch_playing(disorder_eclient *c,
980 disorder_eclient_no_response *completed,
982 return disorder_eclient_scratch(c, 0, completed, v);
985 int disorder_eclient_remove(disorder_eclient *c,
987 disorder_eclient_no_response *completed,
989 return simple(c, no_response_opcallback, (void (*)())completed, v,
990 "remove", id, (char *)0);
993 int disorder_eclient_moveafter(disorder_eclient *c,
997 disorder_eclient_no_response *completed,
1003 vector_append(&vec, (char *)"moveafter");
1004 vector_append(&vec, (char *)target);
1005 for(n = 0; n < nids; ++n)
1006 vector_append(&vec, (char *)ids[n]);
1007 stash_command_vector(c, 0/*queuejump*/, no_response_opcallback, completed, v,
1009 disorder_eclient_polled(c, 0);
1013 int disorder_eclient_recent(disorder_eclient *c,
1014 disorder_eclient_queue_response *completed,
1016 return simple(c, queue_response_opcallback, (void (*)())completed, v,
1017 "recent", (char *)0);
1020 int disorder_eclient_queue(disorder_eclient *c,
1021 disorder_eclient_queue_response *completed,
1023 return simple(c, queue_response_opcallback, (void (*)())completed, v,
1024 "queue", (char *)0);
1027 int disorder_eclient_files(disorder_eclient *c,
1028 disorder_eclient_list_response *completed,
1032 return simple(c, list_response_opcallback, (void (*)())completed, v,
1033 "files", dir, re, (char *)0);
1036 int disorder_eclient_dirs(disorder_eclient *c,
1037 disorder_eclient_list_response *completed,
1041 return simple(c, list_response_opcallback, (void (*)())completed, v,
1042 "dirs", dir, re, (char *)0);
1045 int disorder_eclient_playing(disorder_eclient *c,
1046 disorder_eclient_queue_response *completed,
1048 return simple(c, playing_response_opcallback, (void (*)())completed, v,
1049 "playing", (char *)0);
1052 int disorder_eclient_length(disorder_eclient *c,
1053 disorder_eclient_integer_response *completed,
1056 return simple(c, integer_response_opcallback, (void (*)())completed, v,
1057 "length", track, (char *)0);
1060 int disorder_eclient_volume(disorder_eclient *c,
1061 disorder_eclient_volume_response *completed,
1064 char sl[64], sr[64];
1066 if(l < 0 && r < 0) {
1067 return simple(c, volume_response_opcallback, (void (*)())completed, v,
1068 "volume", (char *)0);
1069 } else if(l >= 0 && r >= 0) {
1072 byte_snprintf(sl, sizeof sl, "%d", l);
1073 byte_snprintf(sr, sizeof sr, "%d", r);
1074 return simple(c, volume_response_opcallback, (void (*)())completed, v,
1075 "volume", sl, sr, (char *)0);
1077 assert(!"invalid arguments to disorder_eclient_volume");
1078 return -1; /* gcc is being dim */
1082 int disorder_eclient_enable(disorder_eclient *c,
1083 disorder_eclient_no_response *completed,
1085 return simple(c, no_response_opcallback, (void (*)())completed, v,
1086 "enable", (char *)0);
1089 int disorder_eclient_disable(disorder_eclient *c,
1090 disorder_eclient_no_response *completed,
1092 return simple(c, no_response_opcallback, (void (*)())completed, v,
1093 "disable", (char *)0);
1096 int disorder_eclient_random_enable(disorder_eclient *c,
1097 disorder_eclient_no_response *completed,
1099 return simple(c, no_response_opcallback, (void (*)())completed, v,
1100 "random-enable", (char *)0);
1103 int disorder_eclient_random_disable(disorder_eclient *c,
1104 disorder_eclient_no_response *completed,
1106 return simple(c, no_response_opcallback, (void (*)())completed, v,
1107 "random-disable", (char *)0);
1110 int disorder_eclient_get(disorder_eclient *c,
1111 disorder_eclient_string_response *completed,
1112 const char *track, const char *pref,
1114 return simple(c, string_response_opcallback, (void (*)())completed, v,
1115 "get", track, pref, (char *)0);
1118 int disorder_eclient_set(disorder_eclient *c,
1119 disorder_eclient_no_response *completed,
1120 const char *track, const char *pref,
1123 return simple(c, no_response_opcallback, (void (*)())completed, v,
1124 "set", track, pref, value, (char *)0);
1127 int disorder_eclient_unset(disorder_eclient *c,
1128 disorder_eclient_no_response *completed,
1129 const char *track, const char *pref,
1131 return simple(c, no_response_opcallback, (void (*)())completed, v,
1132 "unset", track, pref, (char *)0);
1135 int disorder_eclient_resolve(disorder_eclient *c,
1136 disorder_eclient_string_response *completed,
1139 return simple(c, string_response_opcallback, (void (*)())completed, v,
1140 "resolve", track, (char *)0);
1143 int disorder_eclient_search(disorder_eclient *c,
1144 disorder_eclient_list_response *completed,
1147 if(!split(terms, 0, SPLIT_QUOTES, 0, 0)) return -1;
1148 return simple(c, list_response_opcallback, (void (*)())completed, v,
1149 "search", terms, (char *)0);
1152 int disorder_eclient_nop(disorder_eclient *c,
1153 disorder_eclient_no_response *completed,
1155 return simple(c, no_response_opcallback, (void (*)())completed, v,
1159 /** @brief Get the last @p max added tracks
1161 * @param completed Called with list
1162 * @param max Number of tracks to get, 0 for all
1163 * @param v Passed to @p completed
1165 * The first track in the list is the most recently added.
1167 int disorder_eclient_new_tracks(disorder_eclient *c,
1168 disorder_eclient_list_response *completed,
1173 sprintf(limit, "%d", max);
1174 return simple(c, list_response_opcallback, (void (*)())completed, v,
1175 "new", limit, (char *)0);
1178 /* Log clients ***************************************************************/
1180 /** @brief Monitor the server log
1182 * @param callbacks Functions to call when anything happens
1183 * @param v Passed to @p callbacks functions
1185 * Once a client is being used for logging it cannot be used for anything else.
1186 * There is magic in authuser_opcallback() to re-submit the @c log command
1187 * after reconnection.
1189 * NB that the @c state callback may be called from within this function,
1190 * i.e. not solely later on from the event loop callback.
1192 int disorder_eclient_log(disorder_eclient *c,
1193 const disorder_eclient_log_callbacks *callbacks,
1195 if(c->log_callbacks) return -1;
1196 c->log_callbacks = callbacks;
1198 /* Repoort initial state */
1199 if(c->log_callbacks->state)
1200 c->log_callbacks->state(c->log_v, c->statebits);
1201 stash_command(c, 0/*queuejump*/, log_opcallback, 0/*completed*/, v,
1206 /* If we get here we've stopped being a log client */
1207 static void log_opcallback(disorder_eclient *c,
1208 struct operation attribute((unused)) *op) {
1209 D(("log_opcallback"));
1210 c->log_callbacks = 0;
1214 /* error callback for log line parsing */
1215 static void logline_error(const char *msg, void *u) {
1216 disorder_eclient *c = u;
1217 protocol_error(c, c->ops, -1, "error parsing log line: %s", msg);
1220 /* process a single log line */
1221 static void logline(disorder_eclient *c, const char *line) {
1226 D(("logline [%s]", line));
1227 vec = split(line, &nvec, SPLIT_QUOTES, logline_error, c);
1228 if(nvec < 2) return; /* probably an error, already
1230 if(sscanf(vec[0], "%"SCNxMAX, &when) != 1) {
1231 /* probably the wrong side of a format change */
1232 protocol_error(c, c->ops, -1, "invalid log timestamp '%s'", vec[0]);
1235 /* TODO: do something with the time */
1236 n = TABLE_FIND(logentry_handlers, struct logentry_handler, name, vec[1]);
1237 if(n < 0) return; /* probably a future command */
1240 if(nvec < logentry_handlers[n].min || nvec > logentry_handlers[n].max)
1242 logentry_handlers[n].handler(c, nvec, vec);
1245 static void logentry_completed(disorder_eclient *c,
1246 int attribute((unused)) nvec, char **vec) {
1247 if(!c->log_callbacks->completed) return;
1248 c->statebits &= ~DISORDER_PLAYING;
1249 c->log_callbacks->completed(c->log_v, vec[0]);
1250 if(c->log_callbacks->state)
1251 c->log_callbacks->state(c->log_v, c->statebits | DISORDER_CONNECTED);
1254 static void logentry_failed(disorder_eclient *c,
1255 int attribute((unused)) nvec, char **vec) {
1256 if(!c->log_callbacks->failed)return;
1257 c->statebits &= ~DISORDER_PLAYING;
1258 c->log_callbacks->failed(c->log_v, vec[0], vec[1]);
1259 if(c->log_callbacks->state)
1260 c->log_callbacks->state(c->log_v, c->statebits | DISORDER_CONNECTED);
1263 static void logentry_moved(disorder_eclient *c,
1264 int attribute((unused)) nvec, char **vec) {
1265 if(!c->log_callbacks->moved) return;
1266 c->log_callbacks->moved(c->log_v, vec[0]);
1269 static void logentry_playing(disorder_eclient *c,
1270 int attribute((unused)) nvec, char **vec) {
1271 if(!c->log_callbacks->playing) return;
1272 c->statebits |= DISORDER_PLAYING;
1273 c->log_callbacks->playing(c->log_v, vec[0], vec[1]);
1274 if(c->log_callbacks->state)
1275 c->log_callbacks->state(c->log_v, c->statebits | DISORDER_CONNECTED);
1278 static void logentry_queue(disorder_eclient *c,
1279 int attribute((unused)) nvec, char **vec) {
1280 struct queue_entry *q;
1282 if(!c->log_callbacks->completed) return;
1283 q = xmalloc(sizeof *q);
1284 if(queue_unmarshall_vec(q, nvec, vec, eclient_queue_error, c))
1286 c->log_callbacks->queue(c->log_v, q);
1289 static void logentry_recent_added(disorder_eclient *c,
1290 int attribute((unused)) nvec, char **vec) {
1291 struct queue_entry *q;
1293 if(!c->log_callbacks->recent_added) return;
1294 q = xmalloc(sizeof *q);
1295 if(queue_unmarshall_vec(q, nvec, vec, eclient_queue_error, c))
1297 c->log_callbacks->recent_added(c->log_v, q);
1300 static void logentry_recent_removed(disorder_eclient *c,
1301 int attribute((unused)) nvec, char **vec) {
1302 if(!c->log_callbacks->recent_removed) return;
1303 c->log_callbacks->recent_removed(c->log_v, vec[0]);
1306 static void logentry_removed(disorder_eclient *c,
1307 int attribute((unused)) nvec, char **vec) {
1308 if(!c->log_callbacks->removed) return;
1309 c->log_callbacks->removed(c->log_v, vec[0], vec[1]);
1312 static void logentry_scratched(disorder_eclient *c,
1313 int attribute((unused)) nvec, char **vec) {
1314 if(!c->log_callbacks->scratched) return;
1315 c->statebits &= ~DISORDER_PLAYING;
1316 c->log_callbacks->scratched(c->log_v, vec[0], vec[1]);
1317 if(c->log_callbacks->state)
1318 c->log_callbacks->state(c->log_v, c->statebits | DISORDER_CONNECTED);
1321 static const struct {
1324 const char *disable;
1325 } statestrings[] = {
1326 { DISORDER_PLAYING_ENABLED, "enable_play", "disable_play" },
1327 { DISORDER_RANDOM_ENABLED, "enable_random", "disable_random" },
1328 { DISORDER_TRACK_PAUSED, "pause", "resume" },
1329 { DISORDER_PLAYING, "playing", "completed" },
1330 { DISORDER_PLAYING, 0, "scratched" },
1331 { DISORDER_PLAYING, 0, "failed" },
1333 #define NSTATES (int)(sizeof statestrings / sizeof *statestrings)
1335 static void logentry_state(disorder_eclient *c,
1336 int attribute((unused)) nvec, char **vec) {
1339 for(n = 0; n < NSTATES; ++n)
1340 if(statestrings[n].enable && !strcmp(vec[0], statestrings[n].enable)) {
1341 c->statebits |= statestrings[n].bit;
1343 } else if(statestrings[n].disable && !strcmp(vec[0], statestrings[n].disable)) {
1344 c->statebits &= ~statestrings[n].bit;
1347 if(!c->log_callbacks->state) return;
1348 c->log_callbacks->state(c->log_v, c->statebits | DISORDER_CONNECTED);
1351 static void logentry_volume(disorder_eclient *c,
1352 int attribute((unused)) nvec, char **vec) {
1355 if(!c->log_callbacks->volume) return;
1356 if(xstrtol(&l, vec[0], 0, 10)
1357 || xstrtol(&r, vec[1], 0, 10)
1358 || l < 0 || l > INT_MAX
1359 || r < 0 || r > INT_MAX)
1361 c->log_callbacks->volume(c->log_v, (int)l, (int)r);
1364 /** @brief Convert @p statebits to a string */
1365 char *disorder_eclient_interpret_state(unsigned long statebits) {
1369 static const struct {
1373 { DISORDER_PLAYING_ENABLED, "playing_enabled" },
1374 { DISORDER_RANDOM_ENABLED, "random_enabled" },
1375 { DISORDER_TRACK_PAUSED, "track_paused" },
1376 { DISORDER_PLAYING, "playing" },
1377 { DISORDER_CONNECTED, "connected" },
1379 #define NBITS (sizeof bits / sizeof *bits)
1383 dynstr_append(d, '0');
1384 for(n = 0; n < NBITS; ++n)
1385 if(statebits & bits[n].bit) {
1387 dynstr_append(d, '|');
1388 dynstr_append_string(d, bits[n].name);
1389 statebits ^= bits[n].bit;
1395 dynstr_append(d, '|');
1396 sprintf(s, "%#lx", statebits);
1397 dynstr_append_string(d, s);
1399 dynstr_terminate(d);
1408 indent-tabs-mode:nil