chiark - git - mdw - disorder/blob - lib/eclient.c

   1 /*
   2  * This file is part of DisOrder.
   3  * Copyright (C) 2006 Richard Kettlewell
   4  *
   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.
   9  *
  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.
  14  *
  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
  18  * USA
  19  */
  20 /** @file lib/eclient.c
  21  * @brief Client code for event-driven programs
  22  */
  23
  24 #include <config.h>
  25 #include "types.h"
  26
  27 #include <sys/types.h>
  28 #include <sys/socket.h>
  29 #include <netinet/in.h>
  30 #include <sys/un.h>
  31 #include <string.h>
  32 #include <stdio.h>
  33 #include <unistd.h>
  34 #include <errno.h>
  35 #include <netdb.h>
  36 #include <stdlib.h>
  37 #include <assert.h>
  38 #include <inttypes.h>
  39 #include <stddef.h>
  40
  41 #include "log.h"
  42 #include "mem.h"
  43 #include "configuration.h"
  44 #include "queue.h"
  45 #include "eclient.h"
  46 #include "charset.h"
  47 #include "hex.h"
  48 #include "split.h"
  49 #include "vector.h"
  50 #include "inputline.h"
  51 #include "kvp.h"
  52 #include "syscalls.h"
  53 #include "printf.h"
  54 #include "addr.h"
  55 #include "authhash.h"
  56 #include "table.h"
  57 #include "client-common.h"
  58
  59 /* TODO: more commands */
  60
  61 /* Types *********************************************************************/
  62
  63 /** @brief Client state */
  64 enum 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 */
  72 };
  73
  74 /** @brief Names for @ref client_state */
  75 static const char *const states[] = {
  76   "disconnected",
  77   "connecting",
  78   "connected",
  79   "idle",
  80   "cmdresponse",
  81   "body",
  82   "log"
  83 };
  84
  85 struct operation;                       /* forward decl */
  86
  87 /** @brief Type of an operation callback */
  88 typedef void operation_callback(disorder_eclient *c, struct operation *op);
  89
  90 /** @brief A pending operation.
  91  *
  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. */
  95 struct operation {
  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 */
 102
 103   /** @brief true if sent to server
 104    *
 105    * This is cleared by disorder_eclient_close(), forcing all queued
 106    * commands to be transparently resent.
 107    */
 108   int sent;
 109 };
 110
 111 /** @brief Client structure */
 112 struct disorder_eclient {
 113   const char *ident;
 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 current state */
 131 };
 132
 133 /* Forward declarations ******************************************************/
 134
 135 static int start_connect(void *cc,
 136                          const struct sockaddr *sa,
 137                          socklen_t len,
 138                          const char *ident);
 139 static void process_line(disorder_eclient *c, char *line);
 140 static int start_connect(void *cc,
 141                          const struct sockaddr *sa,
 142                          socklen_t len,
 143                          const char *ident);
 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,
 154                           int queuejump,
 155                           operation_callback *opcallback,
 156                           void (*completed)(),
 157                           void *v,
 158                           const char *cmd,
 159                           ...);
 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);
 173
 174 /* Tables ********************************************************************/
 175
 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,
 182                   int nvec,
 183                   char **vec);          /**< @brief Handler function */
 184 };
 185
 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 }
 189   LE(completed, 1, 1),
 190   LE(failed, 2, 2),
 191   LE(moved, 1, 1),
 192   LE(playing, 1, 2),
 193   LE(queue, 2, INT_MAX),
 194   LE(recent_added, 2, INT_MAX),
 195   LE(recent_removed, 1, 1),
 196   LE(removed, 1, 2),
 197   LE(scratched, 2, 2),
 198   LE(state, 1, 1),
 199   LE(volume, 2, 2)
 200 };
 201
 202 /* Setup and teardown ********************************************************/
 203
 204 /** @brief Create a new client
 205  *
 206  * Does NOT connect the client - connections are made (and re-made) on demand.
 207  */
 208 disorder_eclient *disorder_eclient_new(const disorder_eclient_callbacks *cb,
 209                                        void *u) {
 210   disorder_eclient *c = xmalloc(sizeof *c);
 211   D(("disorder_eclient_new"));
 212   c->fd = -1;
 213   c->callbacks = cb;
 214   c->u = u;
 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");
 221     return 0;
 222   }
 223   return c;
 224 }
 225
 226 /** @brief Disconnect a client
 227  * @param c Client to disconnect
 228  *
 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
 231  * reconnect.
 232  */
 233 void disorder_eclient_close(disorder_eclient *c) {
 234   struct operation *op;
 235
 236   D(("disorder_eclient_close"));
 237   if(c->fd != -1) {
 238     D(("disorder_eclient_close closing fd %d", c->fd));
 239     c->callbacks->poll(c->u, c, c->fd, 0);
 240     xclose(c->fd);
 241     c->fd = -1;
 242     c->state = state_disconnected;
 243   }
 244   c->output.nvec = 0;
 245   c->input.nvec = 0;
 246   c->eof = 0;
 247   c->authenticated = 0;
 248   /* We'll need to resend all operations */
 249   for(op = c->ops; op; op = op->next)
 250     op->sent = 0;
 251 }
 252
 253 /** @brief Return true if @c c is connected
 254  *
 255  * By connected it is meant that commands have a reasonable chance of being
 256  * processed soon, not merely that a TCP connection exists - for instance if
 257  * the client is still authenticating then that does not count as connected.
 258  */
 259 int disorder_eclient_connected(const disorder_eclient *c) {
 260   switch(c->state) {
 261   case state_disconnected:
 262   case state_connecting:
 263   case state_connected:
 264     return 0;
 265   case state_idle:
 266   case state_cmdresponse:
 267   case state_body:
 268   case state_log:
 269     return 1;
 270   }
 271   assert(!"reached");
 272 }
 273
 274 /* Error reporting ***********************************************************/
 275
 276 /** @brief called when a connection error occurs
 277  *
 278  * After this called we will be disconnected (by disorder_eclient_close()),
 279  * so there will be a reconnection before any commands can be sent.
 280  */
 281 static int comms_error(disorder_eclient *c, const char *fmt, ...) {
 282   va_list ap;
 283   char *s;
 284
 285   D(("comms_error"));
 286   va_start(ap, fmt);
 287   byte_xvasprintf(&s, fmt, ap);
 288   va_end(ap);
 289   disorder_eclient_close(c);
 290   c->callbacks->comms_error(c->u, s);
 291   return -1;
 292 }
 293
 294 /** @brief called when the server reports an error */
 295 static int protocol_error(disorder_eclient *c, struct operation *op,
 296                           int code, const char *fmt, ...) {
 297   va_list ap;
 298   char *s;
 299
 300   D(("protocol_error"));
 301   va_start(ap, fmt);
 302   byte_xvasprintf(&s, fmt, ap);
 303   va_end(ap);
 304   c->callbacks->protocol_error(c->u, op->v, code, s);
 305   return -1;
 306 }
 307
 308 /* State machine *************************************************************/
 309
 310 /** @brief Called when there's something to do
 311  * @param c Client
 312  * @param mode bitmap of @ref DISORDER_POLL_READ and/or @ref DISORDER_POLL_WRITE.
 313  *
 314  * This should be called from by your code when the file descriptor is readable
 315  * or writable (as requested by the @c poll callback, see @ref
 316  * disorder_eclient_callbacks) and in any case from time to time (with @p mode
 317  * = 0) to allow for retries to work.
 318  */
 319 void disorder_eclient_polled(disorder_eclient *c, unsigned mode) {
 320   struct operation *op;
 321
 322   D(("disorder_eclient_polled fd=%d state=%s mode=[%s %s]",
 323      c->fd, states[c->state],
 324      mode & DISORDER_POLL_READ ? "READ" : "",
 325      mode & DISORDER_POLL_WRITE ? "WRITE" : ""));
 326   /* The pattern here is to check each possible state in turn and try to
 327    * advance (though on error we might go back).  If we advance we leave open
 328    * the possibility of falling through to the next state, but we set the mode
 329    * bits to 0, to avoid false positives (which matter more in some cases than
 330    * others). */
 331
 332   if(c->state == state_disconnected) {
 333     D(("state_disconnected"));
 334     with_sockaddr(c, start_connect);
 335     /* might now be state_disconnected (on error), state_connecting (slow
 336      * connect) or state_connected (fast connect).  If state_disconnected then
 337      * we just rely on a periodic callback from the event loop sometime. */
 338     mode = 0;
 339   }
 340
 341   if(c->state == state_connecting && mode) {
 342     D(("state_connecting"));
 343     maybe_connected(c);
 344     /* Might be state_disconnected (on error) or state_connected (on success).
 345      * In the former case we rely on the event loop for a periodic callback to
 346      * retry. */
 347     mode = 0;
 348   }
 349
 350   if(c->state == state_connected) {
 351     D(("state_connected"));
 352     /* We just connected.  Initiate the authentication protocol. */
 353     stash_command(c, 1/*queuejump*/, authbanner_opcallback,
 354                   0/*completed*/, 0/*v*/, 0/*cmd*/);
 355     /* We never stay is state_connected very long.  We could in principle jump
 356      * straight to state_cmdresponse since there's actually no command to
 357      * send, but that would arguably be cheating. */
 358     c->state = state_idle;
 359   }
 360
 361   if(c->state == state_idle) {
 362     D(("state_idle"));
 363     /* We are connected, and have finished any command we set off, look for
 364      * some work to do */
 365     if(c->ops) {
 366       D(("have ops"));
 367       if(c->authenticated) {
 368         /* Transmit all unsent operations */
 369         for(op = c->ops; op; op = op->next) {
 370           if(!op->sent) {
 371             put(c, op->cmd, strlen(op->cmd));
 372             op->sent = 1;
 373           }
 374         }
 375       } else {
 376         /* Just send the head operation */
 377         if(c->ops->cmd && !c->ops->sent) {
 378           put(c, c->ops->cmd, strlen(c->ops->cmd));
 379           c->ops->sent = 1;
 380         }
 381       }
 382       /* Awaiting response for the operation at the head of the list */
 383       c->state = state_cmdresponse;
 384     } else
 385       /* genuinely idle */
 386       c->callbacks->report(c->u, 0);
 387   }
 388
 389   if(c->state == state_cmdresponse
 390      || c->state == state_body
 391      || c->state == state_log) {
 392     D(("state_%s", states[c->state]));
 393     /* We are awaiting a response */
 394     if(mode & DISORDER_POLL_WRITE) send_output(c);
 395     if(mode & DISORDER_POLL_READ) read_input(c);
 396     /* There are a couple of reasons we might want to re-enter the state
 397      * machine from the top.  state_idle is obvious: there may be further
 398      * commands to process.  Re-entering on state_disconnected means that we
 399      * immediately retry connection if a comms error occurs during a command.
 400      * This is different to the case where a connection fails, where we await a
 401      * spontaneous call to initiate the retry. */
 402     switch(c->state) {
 403     case state_disconnected:            /* lost connection */
 404     case state_idle:                    /* completed a command */
 405       D(("retrying"));
 406       disorder_eclient_polled(c, 0);
 407       return;
 408     default:
 409       break;
 410     }
 411   }
 412
 413   /* Figure out what to set the mode to */
 414   switch(c->state) {
 415   case state_disconnected:
 416     D(("state_disconnected (2)"));
 417     /* Probably an error occurred.  Await a retry. */
 418     mode = 0;
 419     break;
 420   case state_connecting:
 421     D(("state_connecting (2)"));
 422     /* Waiting for connect to complete */
 423     mode = DISORDER_POLL_READ|DISORDER_POLL_WRITE;
 424     break;
 425   case state_connected:
 426     D(("state_connected (2)"));
 427     assert(!"should never be in state_connected here");
 428     break;
 429   case state_idle:
 430     D(("state_idle (2)"));
 431     /* Connected but nothing to do. */
 432     mode = 0;
 433     break;
 434   case state_cmdresponse:
 435   case state_body:
 436   case state_log:
 437     D(("state_%s (2)", states[c->state]));
 438     /* Gathering a response.  Wait for input. */
 439     mode = DISORDER_POLL_READ;
 440     /* Flush any pending output. */
 441     if(c->output.nvec) mode |= DISORDER_POLL_WRITE;
 442     break;
 443   }
 444   D(("fd=%d new mode [%s %s]",
 445      c->fd,
 446      mode & DISORDER_POLL_READ ? "READ" : "",
 447      mode & DISORDER_POLL_WRITE ? "WRITE" : ""));
 448   if(c->fd != -1) c->callbacks->poll(c->u, c, c->fd, mode);
 449 }
 450
 451 /** @brief Called to start connecting */
 452 static int start_connect(void *cc,
 453                          const struct sockaddr *sa,
 454                          socklen_t len,
 455                          const char *ident) {
 456   disorder_eclient *c = cc;
 457
 458   D(("start_connect"));
 459   c->ident = xstrdup(ident);
 460   if(c->fd != -1) {
 461     xclose(c->fd);
 462     c->fd = -1;
 463   }
 464   if((c->fd = socket(sa->sa_family, SOCK_STREAM, 0)) < 0)
 465     return comms_error(c, "socket: %s", strerror(errno));
 466   c->eof = 0;
 467   nonblock(c->fd);
 468   if(connect(c->fd, sa, len) < 0) {
 469     switch(errno) {
 470     case EINTR:
 471     case EINPROGRESS:
 472       c->state = state_connecting;
 473       /* We are called from _polled so the state machine will get to do its
 474        * thing */
 475       return 0;
 476     default:
 477       /* Signal the error to the caller. */
 478       return comms_error(c, "connecting to %s: %s", ident, strerror(errno));
 479     }
 480   } else
 481     c->state = state_connected;
 482   return 0;
 483 }
 484
 485 /** @brief Called when poll triggers while waiting for a connection */
 486 static void maybe_connected(disorder_eclient *c) {
 487   /* We either connected, or got an error. */
 488   int err;
 489   socklen_t len = sizeof err;
 490
 491   D(("maybe_connected"));
 492   /* Work around over-enthusiastic error slippage */
 493   if(getsockopt(c->fd, SOL_SOCKET, SO_ERROR, &err, &len) < 0)
 494     err = errno;
 495   if(err) {
 496     /* The connection failed */
 497     comms_error(c, "connecting to %s: %s", c->ident, strerror(err));
 498     /* sets state_disconnected */
 499   } else {
 500     /* The connection succeeded */
 501     c->state = state_connected;
 502   }
 503 }
 504
 505 /* Authentication ************************************************************/
 506
 507 static void authbanner_opcallback(disorder_eclient *c,
 508                                   struct operation *op) {
 509   size_t nonce_len;
 510   const unsigned char *nonce;
 511   const char *res;
 512
 513   D(("authbanner_opcallback"));
 514   if(c->rc / 100 != 2) {
 515     /* Banner told us to go away.  We cannot proceed. */
 516     protocol_error(c, op, c->rc, "%s: %s", c->ident, c->line);
 517     disorder_eclient_close(c);
 518     return;
 519   }
 520   nonce = unhex(c->line +  4, &nonce_len);
 521   res = authhash(nonce, nonce_len, config->password);
 522   stash_command(c, 1/*queuejump*/, authuser_opcallback, 0/*completed*/, 0/*v*/,
 523                 "user", quoteutf8(config->username), quoteutf8(res),
 524                 (char *)0);
 525 }
 526
 527 static void authuser_opcallback(disorder_eclient *c,
 528                                 struct operation *op) {
 529   D(("authuser_opcallback"));
 530   if(c->rc / 100 != 2) {
 531     /* Wrong password or something.  We cannot proceed. */
 532     protocol_error(c, op, c->rc, "%s: %s", c->ident, c->line);
 533     disorder_eclient_close(c);
 534     return;
 535   }
 536   /* OK, we're authenticated now. */
 537   c->authenticated = 1;
 538   if(c->log_callbacks && !(c->ops && c->ops->opcallback == log_opcallback))
 539     /* We are a log client, switch to logging mode */
 540     stash_command(c, 0/*queuejump*/, log_opcallback, 0/*completed*/, c->log_v,
 541                   "log", (char *)0);
 542 }
 543
 544 /* Output ********************************************************************/
 545
 546 /* Chop N bytes off the front of a dynstr */
 547 static void consume(struct dynstr *d, int n) {
 548   D(("consume %d", n));
 549   assert(d->nvec >= n);
 550   memmove(d->vec, d->vec + n, d->nvec - n);
 551   d->nvec -= n;
 552 }
 553
 554 /* Write some bytes */
 555 static void put(disorder_eclient *c, const char *s, size_t n) {
 556   D(("put %d %.*s", c->fd, (int)n, s));
 557   dynstr_append_bytes(&c->output, s, n);
 558 }
 559
 560 /* Called when we can write to our FD, or at any other time */
 561 static void send_output(disorder_eclient *c) {
 562   int n;
 563
 564   D(("send_output %d bytes pending", c->output.nvec));
 565   if(c->state > state_connecting && c->output.nvec) {
 566     n = write(c->fd, c->output.vec, c->output.nvec);
 567     if(n < 0) {
 568       switch(errno) {
 569       case EINTR:
 570       case EAGAIN:
 571         break;
 572       default:
 573         comms_error(c, "writing to %s: %s", c->ident, strerror(errno));
 574         break;
 575       }
 576     } else
 577       consume(&c->output, n);
 578   }
 579 }
 580
 581 /* Input *********************************************************************/
 582
 583 /* Called when c->fd might be readable, or at any other time */
 584 static void read_input(disorder_eclient *c) {
 585   char *nl;
 586   int n;
 587   char buffer[512];
 588
 589   D(("read_input in state %s", states[c->state]));
 590   if(c->state <= state_connected) return; /* ignore bogus calls */
 591   /* read some more input */
 592   n = read(c->fd, buffer, sizeof buffer);
 593   if(n < 0) {
 594     switch(errno) {
 595     case EINTR:
 596     case EAGAIN:
 597       break;
 598     default:
 599       comms_error(c, "reading from %s: %s", c->ident, strerror(errno));
 600       break;
 601     }
 602     return;                             /* no new input to process */
 603   } else if(n) {
 604     D(("read %d bytes: [%.*s]", n, n, buffer));
 605     dynstr_append_bytes(&c->input, buffer, n);
 606   } else
 607     c->eof = 1;
 608   /* might have more than one line to process */
 609   while(c->state > state_connecting
 610         && (nl = memchr(c->input.vec, '\n', c->input.nvec))) {
 611     process_line(c, xstrndup(c->input.vec, nl - c->input.vec));
 612     /* we might have disconnected along the way, which zogs the input buffer */
 613     if(c->state > state_connecting)
 614       consume(&c->input, (nl - c->input.vec) + 1);
 615   }
 616   if(c->eof) {
 617     comms_error(c, "reading from %s: server disconnected", c->ident);
 618     c->authenticated = 0;
 619   }
 620 }
 621
 622 /* called with a line that has just been read */
 623 static void process_line(disorder_eclient *c, char *line) {
 624   D(("process_line %d [%s]", c->fd, line));
 625   switch(c->state) {
 626   case state_cmdresponse:
 627     /* This is the first line of a response */
 628     if(!(line[0] >= '0' && line[0] <= '9'
 629          && line[1] >= '0' && line[1] <= '9'
 630          && line[2] >= '0' && line[2] <= '9'
 631          && line[3] == ' '))
 632       fatal(0, "invalid response from server: %s", line);
 633     c->rc = (line[0] * 10 + line[1]) * 10 + line[2] - 111 * '0';
 634     c->line = line;
 635     switch(c->rc % 10) {
 636     case 3:
 637       /* We need to collect the body. */
 638       c->state = state_body;
 639       c->vec.nvec = 0;
 640       break;
 641     case 4:
 642       assert(c->log_callbacks != 0);
 643       if(c->log_callbacks->connected)
 644         c->log_callbacks->connected(c->log_v);
 645       c->state = state_log;
 646       break;
 647     default:
 648       /* We've got the whole response.  Go into the idle state so the state
 649        * machine knows we're done and then call the operation callback. */
 650       complete(c);
 651       break;
 652     }
 653     break;
 654   case state_body:
 655     if(strcmp(line, ".")) {
 656       /* A line from the body */
 657       vector_append(&c->vec, line + (line[0] == '.'));
 658     } else {
 659       /* End of the body. */
 660       vector_terminate(&c->vec);
 661       complete(c);
 662     }
 663     break;
 664   case state_log:
 665     if(strcmp(line, ".")) {
 666       logline(c, line + (line[0] == '.'));
 667     } else
 668       complete(c);
 669     break;
 670   default:
 671     assert(!"wrong state for location");
 672     break;
 673   }
 674 }
 675
 676 /* Called when an operation completes */
 677 static void complete(disorder_eclient *c) {
 678   struct operation *op;
 679
 680   D(("complete"));
 681   /* Pop the operation off the queue */
 682   op = c->ops;
 683   c->ops = op->next;
 684   if(c->opstail == &op->next)
 685     c->opstail = &c->ops;
 686   /* If we've pipelined a command ahead then we go straight to cmdresponser.
 687    * Otherwise we go to idle, which will arrange further sends. */
 688   c->state = c->ops && c->ops->sent ? state_cmdresponse : state_idle;
 689   op->opcallback(c, op);
 690   /* Note that we always call the opcallback even on error, though command
 691    * opcallbacks generally always do the same error handling, i.e. just call
 692    * protocol_error().  It's the auth* opcallbacks that have different
 693    * behaviour. */
 694 }
 695
 696 /* Operation setup ***********************************************************/
 697
 698 static void stash_command_vector(disorder_eclient *c,
 699                                  int queuejump,
 700                                  operation_callback *opcallback,
 701                                  void (*completed)(),
 702                                  void *v,
 703                                  int ncmd,
 704                                  char **cmd) {
 705   struct operation *op = xmalloc(sizeof *op);
 706   struct dynstr d;
 707   int n;
 708
 709   if(cmd) {
 710     dynstr_init(&d);
 711     for(n = 0; n < ncmd; ++n) {
 712       if(n)
 713         dynstr_append(&d, ' ');
 714       dynstr_append_string(&d, quoteutf8(cmd[n]));
 715     }
 716     dynstr_append(&d, '\n');
 717     dynstr_terminate(&d);
 718     op->cmd = d.vec;
 719   } else
 720     op->cmd = 0;                        /* usually, awaiting challenge */
 721   op->opcallback = opcallback;
 722   op->completed = completed;
 723   op->v = v;
 724   op->next = 0;
 725   op->client = c;
 726   assert(op->sent == 0);
 727   if(queuejump) {
 728     /* Authentication operations jump the queue of useful commands */
 729     op->next = c->ops;
 730     c->ops = op;
 731     if(c->opstail == &c->ops)
 732       c->opstail = &op->next;
 733     for(op = c->ops; op; op = op->next)
 734       assert(!op->sent);
 735   } else {
 736     *c->opstail = op;
 737     c->opstail = &op->next;
 738   }
 739 }
 740
 741 static void vstash_command(disorder_eclient *c,
 742                            int queuejump,
 743                            operation_callback *opcallback,
 744                            void (*completed)(),
 745                            void *v,
 746                            const char *cmd, va_list ap) {
 747   char *arg;
 748   struct vector vec;
 749
 750   D(("vstash_command %s", cmd ? cmd : "NULL"));
 751   if(cmd) {
 752     vector_init(&vec);
 753     vector_append(&vec, (char *)cmd);
 754     while((arg = va_arg(ap, char *)))
 755       vector_append(&vec, arg);
 756     stash_command_vector(c, queuejump, opcallback, completed, v,
 757                          vec.nvec, vec.vec);
 758   } else
 759     stash_command_vector(c, queuejump, opcallback, completed, v, 0, 0);
 760 }
 761
 762 static void stash_command(disorder_eclient *c,
 763                           int queuejump,
 764                           operation_callback *opcallback,
 765                           void (*completed)(),
 766                           void *v,
 767                           const char *cmd,
 768                           ...) {
 769   va_list ap;
 770
 771   va_start(ap, cmd);
 772   vstash_command(c, queuejump, opcallback, completed, v, cmd, ap);
 773   va_end(ap);
 774 }
 775
 776 /* Command support ***********************************************************/
 777
 778 /* for commands with a simple string response */
 779 static void string_response_opcallback(disorder_eclient *c,
 780                                        struct operation *op) {
 781   D(("string_response_callback"));
 782   if(c->rc / 100 == 2) {
 783     if(op->completed)
 784       ((disorder_eclient_string_response *)op->completed)(op->v, c->line + 4);
 785   } else
 786     protocol_error(c, op, c->rc, "%s: %s", c->ident, c->line);
 787 }
 788
 789 /* for commands with a simple integer response */
 790 static void integer_response_opcallback(disorder_eclient *c,
 791                                         struct operation *op) {
 792   D(("string_response_callback"));
 793   if(c->rc / 100 == 2) {
 794     if(op->completed)
 795       ((disorder_eclient_integer_response *)op->completed)
 796         (op->v, strtol(c->line + 4, 0, 10));
 797   } else
 798     protocol_error(c, op,  c->rc, "%s: %s", c->ident, c->line);
 799 }
 800
 801 /* for commands with no response */
 802 static void no_response_opcallback(disorder_eclient *c,
 803                                    struct operation *op) {
 804   D(("no_response_callback"));
 805   if(c->rc / 100 == 2) {
 806     if(op->completed)
 807       ((disorder_eclient_no_response *)op->completed)(op->v);
 808   } else
 809     protocol_error(c, op, c->rc, "%s: %s", c->ident, c->line);
 810 }
 811
 812 /* error callback for queue_unmarshall */
 813 static void eclient_queue_error(const char *msg,
 814                                 void *u) {
 815   struct operation *op = u;
 816
 817   protocol_error(op->client, op, -1, "error parsing queue entry: %s", msg);
 818 }
 819
 820 /* for commands that expect a queue dump */
 821 static void queue_response_opcallback(disorder_eclient *c,
 822                                       struct operation *op) {
 823   int n;
 824   struct queue_entry *q, *qh = 0, **qtail = &qh, *qlast = 0;
 825
 826   D(("queue_response_callback"));
 827   if(c->rc / 100 == 2) {
 828     /* parse the queue */
 829     for(n = 0; n < c->vec.nvec; ++n) {
 830       q = xmalloc(sizeof *q);
 831       D(("queue_unmarshall %s", c->vec.vec[n]));
 832       if(!queue_unmarshall(q, c->vec.vec[n], eclient_queue_error, op)) {
 833         q->prev = qlast;
 834         *qtail = q;
 835         qtail = &q->next;
 836         qlast = q;
 837       }
 838     }
 839     if(op->completed)
 840       ((disorder_eclient_queue_response *)op->completed)(op->v, qh);
 841   } else
 842     protocol_error(c, op, c->rc, "%s: %s", c->ident, c->line);
 843 }
 844
 845 /* for 'playing' */
 846 static void playing_response_opcallback(disorder_eclient *c,
 847                                         struct operation *op) {
 848   struct queue_entry *q;
 849
 850   D(("playing_response_callback"));
 851   if(c->rc / 100 == 2) {
 852     switch(c->rc % 10) {
 853     case 2:
 854       if(queue_unmarshall(q = xmalloc(sizeof *q), c->line + 4,
 855                           eclient_queue_error, c))
 856         return;
 857       break;
 858     case 9:
 859       q = 0;
 860       break;
 861     default:
 862       protocol_error(c, op, c->rc, "%s: %s", c->ident, c->line);
 863       return;
 864     }
 865     if(op->completed)
 866       ((disorder_eclient_queue_response *)op->completed)(op->v, q);
 867   } else
 868     protocol_error(c, op, c->rc, "%s: %s", c->ident, c->line);
 869 }
 870
 871 /* for commands that expect a list of some sort */
 872 static void list_response_opcallback(disorder_eclient *c,
 873                                      struct operation *op) {
 874   D(("list_response_callback"));
 875   if(c->rc / 100 == 2) {
 876     if(op->completed)
 877       ((disorder_eclient_list_response *)op->completed)(op->v,
 878                                                         c->vec.nvec,
 879                                                         c->vec.vec);
 880   } else
 881     protocol_error(c, op, c->rc, "%s: %s", c->ident, c->line);
 882 }
 883
 884 /* for volume */
 885 static void volume_response_opcallback(disorder_eclient *c,
 886                                        struct operation *op) {
 887   int l, r;
 888
 889   D(("volume_response_callback"));
 890   if(c->rc / 100 == 2) {
 891     if(op->completed) {
 892       if(sscanf(c->line + 4, "%d %d", &l, &r) != 2 || l < 0 || r < 0)
 893         protocol_error(c, op, -1, "%s: invalid volume response: %s",
 894                        c->ident, c->line);
 895       else
 896         ((disorder_eclient_volume_response *)op->completed)(op->v, l, r);
 897     }
 898   } else
 899     protocol_error(c, op, c->rc, "%s: %s", c->ident, c->line);
 900 }
 901
 902 static int simple(disorder_eclient *c,
 903                   operation_callback *opcallback,
 904                   void (*completed)(),
 905                   void *v,
 906                   const char *cmd, ...) {
 907   va_list ap;
 908
 909   va_start(ap, cmd);
 910   vstash_command(c, 0/*queuejump*/, opcallback, completed, v, cmd, ap);
 911   va_end(ap);
 912   /* Give the state machine a kick, since we might be in state_idle */
 913   disorder_eclient_polled(c, 0);
 914   return 0;
 915 }
 916
 917 /* Commands ******************************************************************/
 918
 919 int disorder_eclient_version(disorder_eclient *c,
 920                              disorder_eclient_string_response *completed,
 921                              void *v) {
 922   return simple(c, string_response_opcallback, (void (*)())completed, v,
 923                 "version", (char *)0);
 924 }
 925
 926 int disorder_eclient_namepart(disorder_eclient *c,
 927                               disorder_eclient_string_response *completed,
 928                               const char *track,
 929                               const char *context,
 930                               const char *part,
 931                               void *v) {
 932   return simple(c, string_response_opcallback, (void (*)())completed, v,
 933                 "part", track, context, part, (char *)0);
 934 }
 935
 936 int disorder_eclient_play(disorder_eclient *c,
 937                           const char *track,
 938                           disorder_eclient_no_response *completed,
 939                           void *v) {
 940   return simple(c, no_response_opcallback, (void (*)())completed, v,
 941                 "play", track, (char *)0);
 942 }
 943
 944 int disorder_eclient_pause(disorder_eclient *c,
 945                            disorder_eclient_no_response *completed,
 946                            void *v) {
 947   return simple(c, no_response_opcallback, (void (*)())completed, v,
 948                 "pause", (char *)0);
 949 }
 950
 951 int disorder_eclient_resume(disorder_eclient *c,
 952                             disorder_eclient_no_response *completed,
 953                             void *v) {
 954   return simple(c, no_response_opcallback, (void (*)())completed, v,
 955                 "resume", (char *)0);
 956 }
 957
 958 int disorder_eclient_scratch(disorder_eclient *c,
 959                              const char *id,
 960                              disorder_eclient_no_response *completed,
 961                              void *v) {
 962   return simple(c, no_response_opcallback, (void (*)())completed, v,
 963                 "scratch", id, (char *)0);
 964 }
 965
 966 int disorder_eclient_scratch_playing(disorder_eclient *c,
 967                                      disorder_eclient_no_response *completed,
 968                                      void *v) {
 969   return disorder_eclient_scratch(c, 0, completed, v);
 970 }
 971
 972 int disorder_eclient_remove(disorder_eclient *c,
 973                             const char *id,
 974                             disorder_eclient_no_response *completed,
 975                             void *v) {
 976   return simple(c, no_response_opcallback, (void (*)())completed, v,
 977                 "remove", id, (char *)0);
 978 }
 979
 980 int disorder_eclient_moveafter(disorder_eclient *c,
 981                                const char *target,
 982                                int nids,
 983                                const char **ids,
 984                                disorder_eclient_no_response *completed,
 985                                void *v) {
 986   struct vector vec;
 987   int n;
 988
 989   vector_init(&vec);
 990   vector_append(&vec, (char *)"moveafter");
 991   vector_append(&vec, (char *)target);
 992   for(n = 0; n < nids; ++n)
 993     vector_append(&vec, (char *)ids[n]);
 994   stash_command_vector(c, 0/*queuejump*/, no_response_opcallback, completed, v,
 995                        vec.nvec, vec.vec);
 996   disorder_eclient_polled(c, 0);
 997   return 0;
 998 }
 999
1000 int disorder_eclient_recent(disorder_eclient *c,
1001                             disorder_eclient_queue_response *completed,
1002                             void *v) {
1003   return simple(c, queue_response_opcallback, (void (*)())completed, v,
1004                 "recent", (char *)0);
1005 }
1006
1007 int disorder_eclient_queue(disorder_eclient *c,
1008                             disorder_eclient_queue_response *completed,
1009                             void *v) {
1010   return simple(c, queue_response_opcallback, (void (*)())completed, v,
1011                 "queue", (char *)0);
1012 }
1013
1014 int disorder_eclient_files(disorder_eclient *c,
1015                            disorder_eclient_list_response *completed,
1016                            const char *dir,
1017                            const char *re,
1018                            void *v) {
1019   return simple(c, list_response_opcallback, (void (*)())completed, v,
1020                 "files", dir, re, (char *)0);
1021 }
1022
1023 int disorder_eclient_dirs(disorder_eclient *c,
1024                           disorder_eclient_list_response *completed,
1025                           const char *dir,
1026                           const char *re,
1027                           void *v) {
1028   return simple(c, list_response_opcallback, (void (*)())completed, v,
1029                 "dirs", dir, re, (char *)0);
1030 }
1031
1032 int disorder_eclient_playing(disorder_eclient *c,
1033                              disorder_eclient_queue_response *completed,
1034                              void *v) {
1035   return simple(c, playing_response_opcallback, (void (*)())completed, v,
1036                 "playing", (char *)0);
1037 }
1038
1039 int disorder_eclient_length(disorder_eclient *c,
1040                             disorder_eclient_integer_response *completed,
1041                             const char *track,
1042                             void *v) {
1043   return simple(c, integer_response_opcallback, (void (*)())completed, v,
1044                 "length", track, (char *)0);
1045 }
1046
1047 int disorder_eclient_volume(disorder_eclient *c,
1048                             disorder_eclient_volume_response *completed,
1049                             int l, int r,
1050                             void *v) {
1051   char sl[64], sr[64];
1052
1053   if(l < 0 && r < 0) {
1054     return simple(c, volume_response_opcallback, (void (*)())completed, v,
1055                   "volume", (char *)0);
1056   } else if(l >= 0 && r >= 0) {
1057     assert(l <= 100);
1058     assert(r <= 100);
1059     byte_snprintf(sl, sizeof sl, "%d", l);
1060     byte_snprintf(sr, sizeof sr, "%d", r);
1061     return simple(c, volume_response_opcallback, (void (*)())completed, v,
1062                   "volume", sl, sr, (char *)0);
1063   } else {
1064     assert(!"invalid arguments to disorder_eclient_volume");
1065     return -1;                          /* gcc is being dim */
1066   }
1067 }
1068
1069 int disorder_eclient_enable(disorder_eclient *c,
1070                             disorder_eclient_no_response *completed,
1071                             void *v) {
1072   return simple(c, no_response_opcallback, (void (*)())completed, v,
1073                 "enable", (char *)0);
1074 }
1075
1076 int disorder_eclient_disable(disorder_eclient *c,
1077                              disorder_eclient_no_response *completed,
1078                              void *v){
1079   return simple(c, no_response_opcallback, (void (*)())completed, v,
1080                 "disable", (char *)0);
1081 }
1082
1083 int disorder_eclient_random_enable(disorder_eclient *c,
1084                                    disorder_eclient_no_response *completed,
1085                                    void *v){
1086   return simple(c, no_response_opcallback, (void (*)())completed, v,
1087                 "random-enable", (char *)0);
1088 }
1089
1090 int disorder_eclient_random_disable(disorder_eclient *c,
1091                                     disorder_eclient_no_response *completed,
1092                                     void *v){
1093   return simple(c, no_response_opcallback, (void (*)())completed, v,
1094                 "random-disable", (char *)0);
1095 }
1096
1097 int disorder_eclient_get(disorder_eclient *c,
1098                          disorder_eclient_string_response *completed,
1099                          const char *track, const char *pref,
1100                          void *v) {
1101   return simple(c, string_response_opcallback, (void (*)())completed, v,
1102                 "get", track, pref, (char *)0);
1103 }
1104
1105 int disorder_eclient_set(disorder_eclient *c,
1106                          disorder_eclient_no_response *completed,
1107                          const char *track, const char *pref,
1108                          const char *value,
1109                          void *v) {
1110   return simple(c, no_response_opcallback, (void (*)())completed, v,
1111                 "set", track, pref, value, (char *)0);
1112 }
1113
1114 int disorder_eclient_unset(disorder_eclient *c,
1115                            disorder_eclient_no_response *completed,
1116                            const char *track, const char *pref,
1117                            void *v) {
1118   return simple(c, no_response_opcallback, (void (*)())completed, v,
1119                 "unset", track, pref, (char *)0);
1120 }
1121
1122 int disorder_eclient_resolve(disorder_eclient *c,
1123                              disorder_eclient_string_response *completed,
1124                              const char *track,
1125                              void *v) {
1126   return simple(c, string_response_opcallback,  (void (*)())completed, v,
1127                 "resolve", track, (char *)0);
1128 }
1129
1130 int disorder_eclient_search(disorder_eclient *c,
1131                             disorder_eclient_list_response *completed,
1132                             const char *terms,
1133                             void *v) {
1134   if(!split(terms, 0, SPLIT_QUOTES, 0, 0)) return -1;
1135   return simple(c, list_response_opcallback, (void (*)())completed, v,
1136                 "search", terms, (char *)0);
1137 }
1138
1139 /* Log clients ***************************************************************/
1140
1141 /** @brief Monitor the server log
1142  * @param c Client
1143  * @param callbacks Functions to call when anything happens
1144  * @param v Passed to @p callbacks functions
1145  *
1146  * Once a client is being used for logging it cannot be used for anything else.
1147  * There is magic in authuser_opcallback() to re-submit the @c log command
1148  * after reconnection.
1149  */
1150 int disorder_eclient_log(disorder_eclient *c,
1151                          const disorder_eclient_log_callbacks *callbacks,
1152                          void *v) {
1153   if(c->log_callbacks) return -1;
1154   c->log_callbacks = callbacks;
1155   c->log_v = v;
1156   stash_command(c, 0/*queuejump*/, log_opcallback, 0/*completed*/, v,
1157                 "log", (char *)0);
1158   return 0;
1159 }
1160
1161 /* If we get here we've stopped being a log client */
1162 static void log_opcallback(disorder_eclient *c,
1163                            struct operation attribute((unused)) *op) {
1164   D(("log_opcallback"));
1165   c->log_callbacks = 0;
1166   c->log_v = 0;
1167 }
1168
1169 /* error callback for log line parsing */
1170 static void logline_error(const char *msg, void *u) {
1171   disorder_eclient *c = u;
1172   protocol_error(c, c->ops, -1, "error parsing log line: %s", msg);
1173 }
1174
1175 /* process a single log line */
1176 static void logline(disorder_eclient *c, const char *line) {
1177   int nvec, n;
1178   char **vec;
1179   uintmax_t when;
1180
1181   D(("log_opcallback [%s]", line));
1182   vec = split(line, &nvec, SPLIT_QUOTES, logline_error, c);
1183   if(nvec < 2) return;                  /* probably an error, already
1184                                          * reported */
1185   if(sscanf(vec[0], "%"SCNxMAX, &when) != 1) {
1186     /* probably the wrong side of a format change */
1187     protocol_error(c, c->ops, -1, "invalid log timestamp '%s'", vec[0]);
1188     return;
1189   }
1190   /* TODO: do something with the time */
1191   n = TABLE_FIND(logentry_handlers, struct logentry_handler, name, vec[1]);
1192   if(n < 0) return;                     /* probably a future command */
1193   vec += 2;
1194   nvec -= 2;
1195   if(nvec < logentry_handlers[n].min || nvec > logentry_handlers[n].max)
1196     return;
1197   logentry_handlers[n].handler(c, nvec, vec);
1198 }
1199
1200 static void logentry_completed(disorder_eclient *c,
1201                                int attribute((unused)) nvec, char **vec) {
1202   if(!c->log_callbacks->completed) return;
1203   c->log_callbacks->completed(c->log_v, vec[0]);
1204 }
1205
1206 static void logentry_failed(disorder_eclient *c,
1207                             int attribute((unused)) nvec, char **vec) {
1208   if(!c->log_callbacks->failed)return;
1209   c->log_callbacks->failed(c->log_v, vec[0], vec[1]);
1210 }
1211
1212 static void logentry_moved(disorder_eclient *c,
1213                            int attribute((unused)) nvec, char **vec) {
1214   if(!c->log_callbacks->moved) return;
1215   c->log_callbacks->moved(c->log_v, vec[0]);
1216 }
1217
1218 static void logentry_playing(disorder_eclient *c,
1219                              int attribute((unused)) nvec, char **vec) {
1220   if(!c->log_callbacks->playing) return;
1221   c->log_callbacks->playing(c->log_v, vec[0], vec[1]);
1222 }
1223
1224 static void logentry_queue(disorder_eclient *c,
1225                            int attribute((unused)) nvec, char **vec) {
1226   struct queue_entry *q;
1227
1228   if(!c->log_callbacks->completed) return;
1229   q = xmalloc(sizeof *q);
1230   if(queue_unmarshall_vec(q, nvec, vec, eclient_queue_error, c))
1231     return;                             /* bogus */
1232   c->log_callbacks->queue(c->log_v, q);
1233 }
1234
1235 static void logentry_recent_added(disorder_eclient *c,
1236                                   int attribute((unused)) nvec, char **vec) {
1237   struct queue_entry *q;
1238
1239   if(!c->log_callbacks->recent_added) return;
1240   q = xmalloc(sizeof *q);
1241   if(queue_unmarshall_vec(q, nvec, vec, eclient_queue_error, c))
1242     return;                           /* bogus */
1243   c->log_callbacks->recent_added(c->log_v, q);
1244 }
1245
1246 static void logentry_recent_removed(disorder_eclient *c,
1247                                     int attribute((unused)) nvec, char **vec) {
1248   if(!c->log_callbacks->recent_removed) return;
1249   c->log_callbacks->recent_removed(c->log_v, vec[0]);
1250 }
1251
1252 static void logentry_removed(disorder_eclient *c,
1253                              int attribute((unused)) nvec, char **vec) {
1254   if(!c->log_callbacks->removed) return;
1255   c->log_callbacks->removed(c->log_v, vec[0], vec[1]);
1256 }
1257
1258 static void logentry_scratched(disorder_eclient *c,
1259                                int attribute((unused)) nvec, char **vec) {
1260   if(!c->log_callbacks->scratched) return;
1261   c->log_callbacks->scratched(c->log_v, vec[0], vec[1]);
1262 }
1263
1264 static const struct {
1265   unsigned long bit;
1266   const char *enable;
1267   const char *disable;
1268 } statestrings[] = {
1269   { DISORDER_PLAYING_ENABLED, "enable_play", "disable_play" },
1270   { DISORDER_RANDOM_ENABLED, "enable_random", "disable_random" },
1271   { DISORDER_TRACK_PAUSED, "pause", "resume" },
1272 };
1273 #define NSTATES (int)(sizeof states / sizeof *states)
1274
1275 static void logentry_state(disorder_eclient *c,
1276                            int attribute((unused)) nvec, char **vec) {
1277   int n;
1278
1279   for(n = 0; n < NSTATES; ++n)
1280     if(!strcmp(vec[0], statestrings[n].enable)) {
1281       c->statebits |= statestrings[n].bit;
1282       break;
1283     } else if(!strcmp(vec[0], statestrings[n].disable)) {
1284       c->statebits &= ~statestrings[n].bit;
1285       break;
1286     }
1287   if(!c->log_callbacks->state) return;
1288   c->log_callbacks->state(c->log_v, c->statebits);
1289 }
1290
1291 static void logentry_volume(disorder_eclient *c,
1292                             int attribute((unused)) nvec, char **vec) {
1293   long l, r;
1294
1295   if(!c->log_callbacks->volume) return;
1296   if(xstrtol(&l, vec[0], 0, 10)
1297      || xstrtol(&r, vec[1], 0, 10)
1298      || l < 0 || l > INT_MAX
1299      || r < 0 || r > INT_MAX)
1300     return;                             /* bogus */
1301   c->log_callbacks->volume(c->log_v, (int)l, (int)r);
1302 }
1303
1304 /*
1305 Local Variables:
1306 c-basic-offset:2
1307 comment-column:40
1308 fill-column:79
1309 indent-tabs-mode:nil
1310 End:
1311 */