X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~mdw/git/disorder/blobdiff_plain/3036551977f003d9ef3bc15e682201272f400840..fde67de26e36cf02d5632d934623bbc054a3c1d9:/lib/client.c

diff --git a/lib/client.c b/lib/client.c
index aabea87..a0502eb 100644
--- a/lib/client.c
+++ b/lib/client.c
@@ -1,21 +1,19 @@
 /*
  * This file is part of DisOrder.
- * Copyright (C) 2004, 2005, 2006, 2007 Richard Kettlewell
+ * Copyright (C) 2004-2008 Richard Kettlewell
  *
- * This program is free software; you can redistribute it and/or modify
+ * 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
- * the Free Software Foundation; either version 2 of the License, or
+ * the Free Software Foundation, either version 3 of the License, or
  * (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful, but
- * WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
- * General Public License for more details.
- *
+ * 
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ * 
  * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
- * USA
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  */
 /** @file lib/client.c
  * @brief Simple C client
@@ -24,24 +22,19 @@
  * implementation.
  */
 
-#include <config.h>
-#include "types.h"
+#include "common.h"
 
 #include <sys/types.h>
 #include <sys/socket.h>
 #include <netinet/in.h>
 #include <sys/un.h>
-#include <string.h>
-#include <stdio.h>
 #include <unistd.h>
 #include <errno.h>
 #include <netdb.h>
-#include <stdlib.h>
 #include <pcre.h>
 
 #include "log.h"
 #include "mem.h"
-#include "configuration.h"
 #include "queue.h"
 #include "client.h"
 #include "charset.h"
@@ -58,13 +51,22 @@
 #include "client-common.h"
 #include "rights.h"
 #include "trackdb.h"
+#include "kvp.h"
 
+/** @brief Client handle contents */
 struct disorder_client {
-  FILE *fpin, *fpout;
+  /** @brief Stream to read from */
+  FILE *fpin;
+  /** @brief Stream to write to */
+  FILE *fpout;
+  /** @brief Peer description */
   char *ident;
+  /** @brief Username */
   char *user;
+  /** @brief Report errors to @c stderr */
   int verbose;
-  char *last;				/* last error string */
+  /** @brief Last error string */
+  const char *last;
 };
 
 /** @brief Create a new client
@@ -90,8 +92,10 @@ disorder_client *disorder_new(int verbose) {
 static int response(disorder_client *c, char **rp) {
   char *r;
 
-  if(inputline(c->ident, c->fpin, &r, '\n'))
+  if(inputline(c->ident, c->fpin, &r, '\n')) {
+    byte_xasprintf((char **)&c->last, "input error: %s", strerror(errno));
     return -1;
+  }
   D(("response: %s", r));
   if(rp)
     *rp = r;
@@ -102,6 +106,7 @@ static int response(disorder_client *c, char **rp) {
     c->last = r + 4;
     return (r[0] * 10 + r[1]) * 10 + r[2] - 111 * '0';
   } else {
+    c->last = "invalid reply format";
     error(0, "invalid reply format from %s", c->ident);
     return -1;
   }
@@ -148,6 +153,8 @@ static int check_response(disorder_client *c, char **rp) {
  * @param c Client
  * @param rp Where to store result, or NULL
  * @param cmd Command
+ * @param body Body or NULL
+ * @param nbody Length of body or -1
  * @param ap Arguments (UTF-8), terminated by (char *)0
  * @return 0 on success, non-0 on error
  *
@@ -158,14 +165,26 @@ static int check_response(disorder_client *c, char **rp) {
  *
  * NB that the response will NOT be converted to the local encoding
  * nor will quotes be stripped.  See dequote().
+ *
+ * If @p body is not NULL then the body is sent immediately after the
+ * command.  @p nbody should be the number of lines or @c -1 to count
+ * them if @p body is NULL-terminated.
+ *
+ * Usually you would call this via one of the following interfaces:
+ * - disorder_simple()
+ * - disorder_simple_body()
+ * - disorder_simple_list()
  */
 static int disorder_simple_v(disorder_client *c,
 			     char **rp,
-			     const char *cmd, va_list ap) {
+			     const char *cmd,
+                             char **body, int nbody,
+                             va_list ap) {
   const char *arg;
   struct dynstr d;
 
   if(!c->fpout) {
+    c->last = "not connected";
     error(0, "not connected to server");
     return -1;
   }
@@ -179,12 +198,32 @@ static int disorder_simple_v(disorder_client *c,
     dynstr_append(&d, '\n');
     dynstr_terminate(&d);
     D(("command: %s", d.vec));
-    if(fputs(d.vec, c->fpout) < 0 || fflush(c->fpout)) {
-      error(errno, "error writing to %s", c->ident);
-      return -1;
+    if(fputs(d.vec, c->fpout) < 0)
+      goto write_error;
+    if(body) {
+      if(nbody < 0)
+        for(nbody = 0; body[nbody]; ++nbody)
+          ;
+      for(int n = 0; n < nbody; ++n) {
+        if(body[n][0] == '.')
+          if(fputc('.', c->fpout) < 0)
+            goto write_error;
+        if(fputs(body[n], c->fpout) < 0)
+          goto write_error;
+        if(fputc('\n', c->fpout) < 0)
+          goto write_error;
+      }
+      if(fputs(".\n", c->fpout) < 0)
+        goto write_error;
     }
+    if(fflush(c->fpout))
+      goto write_error;
   }
   return check_response(c, rp);
+write_error:
+  byte_xasprintf((char **)&c->last, "write error: %s", strerror(errno));
+  error(errno, "error writing to %s", c->ident);
+  return -1;
 }
 
 /** @brief Issue a command and parse a simple response
@@ -211,7 +250,30 @@ static int disorder_simple(disorder_client *c,
   int ret;
 
   va_start(ap, cmd);
-  ret = disorder_simple_v(c, rp, cmd, ap);
+  ret = disorder_simple_v(c, rp, cmd, 0, 0, ap);
+  va_end(ap);
+  return ret;
+}
+
+/** @brief Issue a command with a body and parse a simple response
+ * @param c Client
+ * @param rp Where to store result, or NULL (UTF-8)
+ * @param body Pointer to body
+ * @param nbody Size of body
+ * @param cmd Command
+ * @return 0 on success, non-0 on error
+ *
+ * See disorder_simple().
+ */
+static int disorder_simple_body(disorder_client *c,
+                                char **rp,
+                                char **body, int nbody,
+                                const char *cmd, ...) {
+  va_list ap;
+  int ret;
+
+  va_start(ap, cmd);
+  ret = disorder_simple_v(c, rp, cmd, body, nbody, ap);
   va_end(ap);
   return ret;
 }
@@ -238,6 +300,7 @@ static int dequote(int rc, char **rp) {
 }
 
 /** @brief Generic connection routine
+ * @param conf Configuration to follow
  * @param c Client
  * @param username Username to log in with or NULL
  * @param password Password to log in with or NULL
@@ -248,10 +311,11 @@ static int dequote(int rc, char **rp) {
  * username must not be.  If @p username is not NULL then nor may @p
  * password be.
  */
-static int disorder_connect_generic(disorder_client *c,
-				    const char *username,
-				    const char *password,
-				    const char *cookie) {
+int disorder_connect_generic(struct config *conf,
+                             disorder_client *c,
+                             const char *username,
+                             const char *password,
+                             const char *cookie) {
   int fd = -1, fd2 = -1, nrvec, rc;
   unsigned char *nonce;
   size_t nl;
@@ -261,27 +325,32 @@ static int disorder_connect_generic(disorder_client *c,
   struct sockaddr *sa;
   socklen_t salen;
 
-  if((salen = find_server(&sa, &c->ident)) == (socklen_t)-1)
+  if((salen = find_server(conf, &sa, &c->ident)) == (socklen_t)-1)
     return -1;
   c->fpin = c->fpout = 0;
   if((fd = socket(sa->sa_family, SOCK_STREAM, 0)) < 0) {
+    byte_xasprintf((char **)&c->last, "socket: %s", strerror(errno));
     error(errno, "error calling socket");
     return -1;
   }
   if(connect(fd, sa, salen) < 0) {
+    byte_xasprintf((char **)&c->last, "connect: %s", strerror(errno));
     error(errno, "error calling connect");
     goto error;
   }
   if((fd2 = dup(fd)) < 0) {
+    byte_xasprintf((char **)&c->last, "dup: %s", strerror(errno));
     error(errno, "error calling dup");
     goto error;
   }
   if(!(c->fpin = fdopen(fd, "rb"))) {
+    byte_xasprintf((char **)&c->last, "fdopen: %s", strerror(errno));
     error(errno, "error calling fdopen");
     goto error;
   }
   fd = -1;
   if(!(c->fpout = fdopen(fd2, "wb"))) {
+    byte_xasprintf((char **)&c->last, "fdopen: %s", strerror(errno));
     error(errno, "error calling fdopen");
     goto error;
   }
@@ -291,11 +360,13 @@ static int disorder_connect_generic(disorder_client *c,
   if(!(rvec = split(r, &nrvec, SPLIT_QUOTES, 0, 0)))
     goto error;
   if(nrvec != 3) {
+    c->last = "cannot parse server greeting";
     error(0, "cannot parse server greeting %s", r);
     goto error;
   }
   protocol = *rvec++;
   if(strcmp(protocol, "2")) {
+    c->last = "unknown protocol version";
     error(0, "unknown protocol version: %s", protocol);
     goto error;
   }
@@ -308,11 +379,15 @@ static int disorder_connect_generic(disorder_client *c,
 		&c->user))
       return 0;				/* success */
     if(!username) {
+      c->last = "cookie failed and no username";
       error(0, "cookie did not work and no username available");
       goto error;
     }
   }
-  if(!(res = authhash(nonce, nl, password, algorithm))) goto error;
+  if(!(res = authhash(nonce, nl, password, algorithm))) {
+    c->last = "error computing authorization hash";
+    goto error;
+  }
   if((rc = disorder_simple(c, 0, "user", username, res, (char *)0)))
     goto error_rc;
   c->user = xstrdup(username);
@@ -342,7 +417,8 @@ error_rc:
 int disorder_connect_user(disorder_client *c,
 			  const char *username,
 			  const char *password) {
-  return disorder_connect_generic(c,
+  return disorder_connect_generic(config,
+                                  c,
 				  username,
 				  password,
 				  0);
@@ -360,13 +436,13 @@ int disorder_connect(disorder_client *c) {
   const char *username, *password;
 
   if(!(username = config->username)) {
+    c->last = "no username";
     error(0, "no username configured");
     return -1;
   }
   password = config->password;
-  if(!password) {
-    /* Maybe we can read the database */
-    /* TODO failure to open the database should not be fatal */
+  /* 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);
@@ -374,10 +450,12 @@ int disorder_connect(disorder_client *c) {
   }
   if(!password) {
     /* Oh well */
-    error(0, "no password configured");
+    c->last = "no password";
+    error(0, "no password configured for user '%s'", username);
     return -1;
   }
-  return disorder_connect_generic(c,
+  return disorder_connect_generic(config,
+                                  c,
 				  username,
 				  password,
 				  0);
@@ -394,7 +472,8 @@ int disorder_connect(disorder_client *c) {
  */
 int disorder_connect_cookie(disorder_client *c,
 			    const char *cookie) {
-  return disorder_connect_generic(c,
+  return disorder_connect_generic(config,
+                                  c,
 				  "guest",
 				  "",
 				  cookie);
@@ -412,6 +491,7 @@ int disorder_close(disorder_client *c) {
 
   if(c->fpin) {
     if(fclose(c->fpin) < 0) {
+      byte_xasprintf((char **)&c->last, "fclose: %s", strerror(errno));
       error(errno, "error calling fclose");
       ret = -1;
     }
@@ -419,6 +499,7 @@ int disorder_close(disorder_client *c) {
   }
   if(c->fpout) {
     if(fclose(c->fpout) < 0) {
+      byte_xasprintf((char **)&c->last, "fclose: %s", strerror(errno));
       error(errno, "error calling fclose");
       ret = -1;
     }
@@ -547,6 +628,7 @@ int disorder_playing(disorder_client *c, struct queue_entry **qp) {
   return 0;
 }
 
+/** @brief Fetch the queue, recent list, etc */
 static int disorder_somequeue(disorder_client *c,
 			      const char *cmd, struct queue_entry **qp) {
   struct queue_entry *qh, **qt = &qh, *q;
@@ -567,10 +649,13 @@ static int disorder_somequeue(disorder_client *c,
       qt = &q->next;
     }
   }
-  if(ferror(c->fpin))
+  if(ferror(c->fpin)) {
+    byte_xasprintf((char **)&c->last, "input error: %s", strerror(errno));
     error(errno, "error reading %s", c->ident);
-  else
+  } else {
+    c->last = "input error: unexpxected EOF";
     error(0, "error reading %s: unexpected EOF", c->ident);
+  }
   return -1;
 }
 
@@ -619,10 +704,13 @@ static int readlist(disorder_client *c, char ***vecp, int *nvecp) {
     }
     vector_append(&v, l + (*l == '.'));
   }
-  if(ferror(c->fpin))
+  if(ferror(c->fpin)) {
+    byte_xasprintf((char **)&c->last, "input error: %s", strerror(errno));
     error(errno, "error reading %s", c->ident);
-  else
+  } else {
+    c->last = "input error: unexpxected EOF";
     error(0, "error reading %s: unexpected EOF", c->ident);
+  }
   return -1;
 }
 
@@ -637,6 +725,8 @@ static int readlist(disorder_client *c, char ***vecp, int *nvecp) {
  * *)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,
@@ -645,7 +735,7 @@ static int disorder_simple_list(disorder_client *c,
   int ret;
 
   va_start(ap, cmd);
-  ret = disorder_simple_v(c, 0, cmd, ap);
+  ret = disorder_simple_v(c, 0, cmd, 0, 0, ap);
   va_end(ap);
   if(ret) return ret;
   return readlist(c, vecp, nvecp);
@@ -914,6 +1004,7 @@ int disorder_get_volume(disorder_client *c, int *left, int *right) {
   if((rc = disorder_simple(c, &r, "volume", (char *)0)))
     return rc;
   if(sscanf(r, "%d %d", left, right) != 2) {
+    c->last = "malformed volume response";
     error(0, "error parsing response to 'volume': '%s'", r);
     return -1;
   }
@@ -933,7 +1024,11 @@ int disorder_log(disorder_client *c, struct sink *s) {
     return rc;
   while(inputline(c->ident, c->fpin, &l, '\n') >= 0 && strcmp(l, "."))
     if(sink_printf(s, "%s\n", l) < 0) return -1;
-  if(ferror(c->fpin) || feof(c->fpin)) return -1;
+  if(ferror(c->fpin) || feof(c->fpin)) {
+    byte_xasprintf((char **)&c->last, "input error: %s",
+		   ferror(c->fpin) ? strerror(errno) : "unexpxected EOF");
+    return -1;
+  }
   return 0;
 }
 
@@ -1062,6 +1157,7 @@ int disorder_rtp_address(disorder_client *c, char **addressp, char **portp) {
     return rc;
   vec = split(r, &n, SPLIT_QUOTES, 0, 0);
   if(n != 2) {
+    c->last = "malformed RTP address";
     error(0, "malformed rtp-address reply");
     return -1;
   }
@@ -1166,6 +1262,209 @@ int disorder_revoke(disorder_client *c) {
   return disorder_simple(c, 0, "revoke", (char *)0);
 }
 
+/** @brief Request a password reminder email
+ * @param c Client
+ * @param user Username
+ * @return 0 on success, non-0 on error
+ */
+int disorder_reminder(disorder_client *c, const char *user) {
+  return disorder_simple(c, 0, "reminder", user, (char *)0);
+}
+
+/** @brief List scheduled events
+ * @param c Client
+ * @param idsp Where to put list of event IDs
+ * @param nidsp Where to put count of event IDs, or NULL
+ * @return 0 on success, non-0 on error
+ */
+int disorder_schedule_list(disorder_client *c, char ***idsp, int *nidsp) {
+  return disorder_simple_list(c, idsp, nidsp, "schedule-list", (char *)0);
+}
+
+/** @brief Delete a scheduled event
+ * @param c Client
+ * @param id Event ID to delete
+ * @return 0 on success, non-0 on error
+ */
+int disorder_schedule_del(disorder_client *c, const char *id) {
+  return disorder_simple(c, 0, "schedule-del", id, (char *)0);
+}
+
+/** @brief Get details of a scheduled event
+ * @param c Client
+ * @param id Event ID
+ * @param actiondatap Where to put details
+ * @return 0 on success, non-0 on error
+ */
+int disorder_schedule_get(disorder_client *c, const char *id,
+			  struct kvp **actiondatap) {
+  char **lines, **bits;
+  int rc, nbits;
+
+  *actiondatap = 0;
+  if((rc = disorder_simple_list(c, &lines, NULL,
+				"schedule-get", id, (char *)0)))
+    return rc;
+  while(*lines) {
+    if(!(bits = split(*lines++, &nbits, SPLIT_QUOTES, 0, 0))) {
+      error(0, "invalid schedule-get reply: cannot split line");
+      return -1;
+    }
+    if(nbits != 2) {
+      error(0, "invalid schedule-get reply: wrong number of fields");
+      return -1;
+    }
+    kvp_set(actiondatap, bits[0], bits[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
+    fatal(0, "unknown action '%s'", action);
+  va_end(ap);
+  return rc;
+}
+
+/** @brief Adopt a track
+ * @param c Client
+ * @param id Track ID to adopt
+ * @return 0 on success, non-0 on error
+ */
+int disorder_adopt(disorder_client *c, const char *id) {
+  return disorder_simple(c, 0, "adopt", id, (char *)0);
+}
+
+/** @brief Delete a playlist
+ * @param c Client
+ * @param playlist Playlist to delete
+ * @return 0 on success, non-0 on error
+ */
+int disorder_playlist_delete(disorder_client *c,
+                             const char *playlist) {
+  return disorder_simple(c, 0, "playlist-delete", playlist, (char *)0);
+}
+
+/** @brief Get the contents of a playlist
+ * @param c Client
+ * @param playlist Playlist to get
+ * @param tracksp Where to put list of tracks
+ * @param ntracksp Where to put count of tracks
+ * @return 0 on success, non-0 on error
+ */
+int disorder_playlist_get(disorder_client *c, const char *playlist,
+                          char ***tracksp, int *ntracksp) {
+  return disorder_simple_list(c, tracksp, ntracksp,
+                              "playlist-get", playlist, (char *)0);
+}
+
+/** @brief List all readable playlists
+ * @param c Client
+ * @param playlistsp Where to put list of playlists
+ * @param nplaylistsp Where to put count of playlists
+ * @return 0 on success, non-0 on error
+ */
+int disorder_playlists(disorder_client *c,
+                       char ***playlistsp, int *nplaylistsp) {
+  return disorder_simple_list(c, playlistsp, nplaylistsp,
+                              "playlists", (char *)0);
+}
+
+/** @brief Get the sharing status of a playlist
+ * @param c Client
+ * @param playlist Playlist to inspect
+ * @param sharep Where to put sharing status
+ * @return 0 on success, non-0 on error
+ *
+ * Possible @p sharep values are @c public, @c private and @c shared.
+ */
+int disorder_playlist_get_share(disorder_client *c, const char *playlist,
+                                char **sharep) {
+  return disorder_simple(c, sharep,
+                         "playlist-get-share", playlist, (char *)0);
+}
+
+/** @brief Get the sharing status of a playlist
+ * @param c Client
+ * @param playlist Playlist to modify
+ * @param share New sharing status
+ * @return 0 on success, non-0 on error
+ *
+ * Possible @p share values are @c public, @c private and @c shared.
+ */
+int disorder_playlist_set_share(disorder_client *c, const char *playlist,
+                                const char *share) {
+  return disorder_simple(c, 0,
+                         "playlist-set-share", playlist, share, (char *)0);
+}
+
+/** @brief Lock a playlist for modifications
+ * @param c Client
+ * @param playlist Playlist to lock
+ * @return 0 on success, non-0 on error
+ */
+int disorder_playlist_lock(disorder_client *c, const char *playlist) {
+  return disorder_simple(c, 0,
+                         "playlist-lock", playlist, (char *)0);
+}
+
+/** @brief Unlock the locked playlist
+ * @param c Client
+ * @return 0 on success, non-0 on error
+ */
+int disorder_playlist_unlock(disorder_client *c) {
+  return disorder_simple(c, 0,
+                         "playlist-unlock", (char *)0);
+}
+
+/** @brief Set the contents of a playlst
+ * @param c Client
+ * @param playlist Playlist to modify
+ * @param tracks List of tracks
+ * @param ntracks Length of @p tracks (or -1 to count up to the first NULL)
+ * @return 0 on success, non-0 on error
+ */
+int disorder_playlist_set(disorder_client *c,
+                          const char *playlist,
+                          char **tracks,
+                          int ntracks) {
+  return disorder_simple_body(c, 0, tracks, ntracks,
+                              "playlist-set", playlist, (char *)0);
+}
+
 /*
 Local Variables:
 c-basic-offset:2