chiark / gitweb /
log: more general error message formatting
[disorder] / lib / client.c
index 24343698208e972be1b96e73aa06dd51e339d345..08d70e762c1c37a87c2bf2c54638f354e8da1342 100644 (file)
@@ -1,6 +1,6 @@
 /*
  * This file is part of DisOrder.
- * Copyright (C) 2004-2009 Richard Kettlewell
+ * Copyright (C) 2004-13 Richard Kettlewell
  *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
 #include "common.h"
 
 #include <sys/types.h>
-#include <sys/socket.h>
-#include <netinet/in.h>
-#include <sys/un.h>
-#include <unistd.h>
+#if HAVE_SYS_SOCKET_H
+# include <sys/socket.h>
+#endif
+#if HAVE_NETINET_IN_H
+# include <netinet/in.h>
+#endif
+#if HAVE_SYS_UN_H
+# include <sys/un.h>
+#endif
+#if HAVE_UNISTD_H
+# include <unistd.h>
+#endif
 #include <errno.h>
-#include <netdb.h>
-#include <pcre.h>
+#if HAVE_NETDB_H
+# include <netdb.h>
+#endif
+#if HAVE_PCRE_H
+# include <pcre.h>
+#endif
 
 #include "log.h"
 #include "mem.h"
@@ -50,7 +62,6 @@
 #include "authhash.h"
 #include "client-common.h"
 #include "rights.h"
-#include "trackdb.h"
 #include "kvp.h"
 
 /** @brief Client handle contents */
@@ -67,6 +78,8 @@ struct disorder_client {
   int verbose;
   /** @brief Last error string */
   const char *last;
+  /** @brief Address family */
+  int family;
 };
 
 /** @brief Create a new client
@@ -81,9 +94,15 @@ disorder_client *disorder_new(int verbose) {
   disorder_client *c = xmalloc(sizeof (struct disorder_client));
 
   c->verbose = verbose;
+  c->family = -1;
   return c;
 }
 
+/** @brief Return the address family used by this client */
+int disorder_client_af(disorder_client *c) {
+  return c->family;
+}
+
 /** @brief Read a response line
  * @param c Client
  * @param rp Where to store response, or NULL (UTF-8)
@@ -151,12 +170,6 @@ static int check_response(disorder_client *c, char **rp) {
   }
 }
 
-/** @brief Marker for a command body */
-static const char disorder_body[1];
-
-/** @brief Marker for a list of args */
-static const char disorder_list[1];
-
 /** @brief Issue a command and parse a simple response
  * @param c Client
  * @param rp Where to store result, or NULL
@@ -172,19 +185,25 @@ static const char disorder_list[1];
  * NB that the response will NOT be converted to the local encoding
  * nor will quotes be stripped.  See dequote().
  *
- * Put @ref disorder_body in the argument list followed by a char **
+ * Put @ref disorder__body in the argument list followed by a char **
  * and int giving the body to follow the command.  If the int is @c -1
  * then the list is assumed to be NULL-terminated.  This may be used
  * only once.
  *
- * Put @ref disorder_list in the argument list followed by a char **
+ * Put @ref disorder__list in the argument list followed by a char **
  * and int giving a list of arguments to include.  If the int is @c -1
  * then the list is assumed to be NULL-terminated.  This may be used
  * any number of times.
  *
+ * Put @ref disorder__integer in the argument list followed by a long to
+ * send its value in decimal.  This may be used any number of times.
+ *
+ * Put @ref disorder__time in the argument list followed by a time_t
+ * to send its value in decimal.  This may be used any number of
+ * times.
+ *
  * Usually you would call this via one of the following interfaces:
  * - disorder_simple()
- * - disorder_simple_list()
  */
 static int disorder_simple_v(disorder_client *c,
                             char **rp,
@@ -205,11 +224,11 @@ static int disorder_simple_v(disorder_client *c,
     dynstr_init(&d);
     dynstr_append_string(&d, cmd);
     while((arg = va_arg(ap, const char *))) {
-      if(arg == disorder_body) {
+      if(arg == disorder__body) {
        body = va_arg(ap, char **);
        nbody = va_arg(ap, int);
        has_body = 1;
-      } else if(arg == disorder_list) {
+      } else if(arg == disorder__list) {
        char **list = va_arg(ap, char **);
        int nlist = va_arg(ap, int);
        if(nlist < 0) {
@@ -220,6 +239,18 @@ static int disorder_simple_v(disorder_client *c,
          dynstr_append(&d, ' ');
          dynstr_append_string(&d, quoteutf8(arg));
        }
+      } else if(arg == disorder__integer) {
+       long n = va_arg(ap, long);
+       char buffer[16];
+       snprintf(buffer, sizeof buffer, "%ld", n);
+       dynstr_append(&d, ' ');
+       dynstr_append_string(&d, buffer);
+      } else if(arg == disorder__time) {
+       time_t n = va_arg(ap, time_t);
+       char buffer[16];
+       snprintf(buffer, sizeof buffer, "%lld", (long long)n);
+       dynstr_append(&d, ' ');
+       dynstr_append_string(&d, buffer);
       } else {
        dynstr_append(&d, ' ');
        dynstr_append_string(&d, quoteutf8(arg));
@@ -286,6 +317,59 @@ static int disorder_simple(disorder_client *c,
   return ret;
 }
 
+/** @brief Issue a command and split the response
+ * @param c Client
+ * @param vecp Where to store results
+ * @param nvecp Where to store count of results
+ * @param expected Expected count (or -1 to not check)
+ * @param cmd Command
+ * @return 0 on success, non-0 on error
+ *
+ * The remaining arguments are command arguments, terminated by (char
+ * *)0.  They should be in UTF-8.
+ *
+ * 5xx responses count as errors.
+ *
+ * @p rp will NOT be filled in for xx9 responses (where it is just
+ * commentary for a command where it would normally be meaningful).
+ *
+ * NB that the response will NOT be converted to the local encoding
+ * nor will quotes be stripped.  See dequote().
+ */
+static int disorder_simple_split(disorder_client *c,
+                                char ***vecp,
+                                int *nvecp,
+                                int expected,
+                                const char *cmd, ...) {
+  va_list ap;
+  int ret;
+  char *r;
+  char **vec;
+  int nvec;
+
+  va_start(ap, cmd);
+  ret = disorder_simple_v(c, &r, cmd, ap);
+  va_end(ap);
+  if(!ret) {
+    vec = split(r, &nvec, SPLIT_QUOTES, 0, 0);
+    xfree(r);
+    if(expected < 0 || nvec == expected) {
+      *vecp = vec;
+      *nvecp = nvec;
+    } else {
+      disorder_error(0, "malformed reply to %s", cmd);
+      c->last = "malformed reply";
+      ret = -1;
+      free_strings(nvec, vec);
+    }
+  }
+  if(ret) {
+    *vecp = NULL;
+    *nvecp = 0;
+  }
+  return ret;
+}
+
 /** @brief Dequote a result string
  * @param rc 0 on success, non-0 on error
  * @param rp Where result string is stored (UTF-8)
@@ -343,6 +427,7 @@ int disorder_connect_generic(struct config *conf,
     disorder_error(errno, "error calling socket");
     return -1;
   }
+  c->family = sa->sa_family;
   if(connect(fd, sa, salen) < 0) {
     byte_xasprintf((char **)&c->last, "connect: %s", strerror(errno));
     disorder_error(errno, "error calling connect");
@@ -456,13 +541,13 @@ int disorder_connect(disorder_client *c) {
     return -1;
   }
   password = config->password;
-  /* Maybe we can read the database */
-  if(!password && trackdb_readable()) {
-    trackdb_init(TRACKDB_NO_RECOVER|TRACKDB_NO_UPGRADE);
-    trackdb_open(TRACKDB_READ_ONLY);
-    password = trackdb_get_password(username);
-    trackdb_close();
-  }
+  /* If we're connecting as 'root' guess that we're the system root
+   * user (or the jukebox user), both of which can use the privileged
+   * socket.  They can also furtle with the db directly: that is why
+   * privileged socket does not represent a privilege escalation. */
+  if(!password
+     && !strcmp(username, "root"))
+    password = "anything will do for root";
   if(!password) {
     /* Oh well */
     c->last = "no password";
@@ -557,14 +642,11 @@ static int onequeue(disorder_client *c, const char *cmd,
 }
 
 /** @brief Fetch the queue, recent list, etc */
-static int somequeue(disorder_client *c,
-                    const char *cmd, struct queue_entry **qp) {
+static int readqueue(disorder_client *c,
+                    struct queue_entry **qp) {
   struct queue_entry *qh, **qt = &qh, *q;
   char *l;
-  int rc;
 
-  if((rc = disorder_simple(c, 0, cmd, (char *)0)))
-    return rc;
   while(inputline(c->ident, c->fpin, &l, '\n') >= 0) {
     if(!strcmp(l, ".")) {
       *qt = 0;
@@ -583,7 +665,7 @@ static int somequeue(disorder_client *c,
     byte_xasprintf((char **)&c->last, "input error: %s", strerror(errno));
     disorder_error(errno, "error reading %s", c->ident);
   } else {
-    c->last = "input error: unexpxected EOF";
+    c->last = "input error: unexpected EOF";
     disorder_error(0, "error reading %s: unexpected EOF", c->ident);
   }
   return -1;
@@ -624,33 +706,6 @@ static int readlist(disorder_client *c, char ***vecp, int *nvecp) {
   return -1;
 }
 
-/** @brief Issue a comamnd and get a list response
- * @param c Client
- * @param vecp Where to store list (UTF-8)
- * @param nvecp Where to store number of items, or NULL
- * @param cmd Command
- * @return 0 on success, non-0 on error
- *
- * The remaining arguments are command arguments, terminated by (char
- * *)0.  They should be in UTF-8.
- *
- * 5xx responses count as errors.
- *
- * See disorder_simple().
- */
-static int disorder_simple_list(disorder_client *c,
-                               char ***vecp, int *nvecp,
-                               const char *cmd, ...) {
-  va_list ap;
-  int ret;
-
-  va_start(ap, cmd);
-  ret = disorder_simple_v(c, 0, cmd, ap);
-  va_end(ap);
-  if(ret) return ret;
-  return readlist(c, vecp, nvecp);
-}
-
 /** @brief Return the user we logged in with
  * @param c Client
  * @return User name (owned by @p c, don't modify)
@@ -719,41 +774,6 @@ static int boolean(const char *cmd, const char *value,
   return 0;
 }
 
-/** @brief Set volume
- * @param c Client
- * @param left New left channel value
- * @param right New right channel value
- * @return 0 on success, non-0 on error
- */
-int disorder_set_volume(disorder_client *c, int left, int right) {
-  char *ls, *rs;
-
-  if(byte_asprintf(&ls, "%d", left) < 0
-     || byte_asprintf(&rs, "%d", right) < 0)
-    return -1;
-  return disorder_simple(c, 0, "volume", ls, rs, (char *)0);
-}
-
-/** @brief Get volume
- * @param c Client
- * @param left Where to store left channel value
- * @param right Where to store right channel value
- * @return 0 on success, non-0 on error
- */
-int disorder_get_volume(disorder_client *c, int *left, int *right) {
-  char *r;
-  int rc;
-
-  if((rc = disorder_simple(c, &r, "volume", (char *)0)))
-    return rc;
-  if(sscanf(r, "%d %d", left, right) != 2) {
-    c->last = "malformed volume response";
-    disorder_error(0, "error parsing response to 'volume': '%s'", r);
-    return -1;
-  }
-  return 0;
-}
-
 /** @brief Log to a sink
  * @param c Client
  * @param s Sink to write log lines to
@@ -775,86 +795,6 @@ int disorder_log(disorder_client *c, struct sink *s) {
   return 0;
 }
 
-/** @brief Get recently added tracks
- * @param c Client
- * @param vecp Where to store pointer to list (UTF-8)
- * @param nvecp Where to store count
- * @param max Maximum tracks to fetch, or 0 for all available
- * @return 0 on success, non-0 on error
- */
-int disorder_new_tracks(disorder_client *c,
-                       char ***vecp, int *nvecp,
-                       int max) {
-  char limit[32];
-
-  sprintf(limit, "%d", max);
-  return disorder_simple_list(c, vecp, nvecp, "new", limit, (char *)0);
-}
-
-/** @brief Get server's RTP address information
- * @param c Client
- * @param addressp Where to store address (UTF-8)
- * @param portp Where to store port (UTF-8)
- * @return 0 on success, non-0 on error
- */
-int disorder_rtp_address(disorder_client *c, char **addressp, char **portp) {
-  char *r;
-  int rc, n;
-  char **vec;
-
-  if((rc = disorder_simple(c, &r, "rtp-address", (char *)0)))
-    return rc;
-  vec = split(r, &n, SPLIT_QUOTES, 0, 0);
-  if(n != 2) {
-    c->last = "malformed RTP address";
-    disorder_error(0, "malformed rtp-address reply");
-    return -1;
-  }
-  *addressp = vec[0];
-  *portp = vec[1];
-  return 0;
-}
-
-/** @brief Add a scheduled event
- * @param c Client
- * @param when When to trigger the event
- * @param priority Event priority ("normal" or "junk")
- * @param action What action to perform
- * @param ... Action-specific arguments
- * @return 0 on success, non-0 on error
- *
- * For action @c "play" the next argument is the track.
- *
- * For action @c "set-global" next argument is the global preference name
- * and the final argument the value to set it to, or (char *)0 to unset it.
- */
-int disorder_schedule_add(disorder_client *c,
-                         time_t when,
-                         const char *priority,
-                         const char *action,
-                         ...) {
-  va_list ap;
-  char when_str[64];
-  int rc;
-
-  snprintf(when_str, sizeof when_str, "%lld", (long long)when);
-  va_start(ap, action);
-  if(!strcmp(action, "play"))
-    rc = disorder_simple(c, 0, "schedule-add", when_str, priority,
-                        action, va_arg(ap, char *),
-                        (char *)0);
-  else if(!strcmp(action, "set-global")) {
-    const char *key = va_arg(ap, char *);
-    const char *value = va_arg(ap, char *);
-    rc = disorder_simple(c, 0,"schedule-add",  when_str, priority,
-                        action, key, value,
-                        (char *)0);
-  } else
-    disorder_fatal(0, "unknown action '%s'", action);
-  va_end(ap);
-  return rc;
-}
-
 #include "client-stubs.c"
 
 /*