chiark / gitweb /
Add many comments to server/play.c, in advance of possible
[disorder] / lib / client.c
index 4dfd10cc27b9b11e321a9d44405595a12a8c1e5d..00d7cf51b0b804a7bb29e92f674a9579a6a36b80 100644 (file)
@@ -2,20 +2,18 @@
  * This file is part of DisOrder.
  * 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
  * 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,6 +51,7 @@
 #include "client-common.h"
 #include "rights.h"
 #include "trackdb.h"
+#include "kvp.h"
 
 /** @brief Client handle contents */
 struct disorder_client {
@@ -251,6 +245,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
@@ -261,10 +256,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;
@@ -274,7 +270,7 @@ 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) {
@@ -366,7 +362,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);
@@ -402,7 +399,8 @@ int disorder_connect(disorder_client *c) {
     error(0, "no password configured");
     return -1;
   }
-  return disorder_connect_generic(c,
+  return disorder_connect_generic(config,
+                                  c,
                                  username,
                                  password,
                                  0);
@@ -419,7 +417,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);
@@ -1215,6 +1214,103 @@ 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);
+}
+
 /*
 Local Variables:
 c-basic-offset:2