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

   1 /*
   2  * This file is part of DisOrder.
   3  * Copyright (C) 2004-2009, 2011, 2013 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 3 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,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  * GNU 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, see <http://www.gnu.org/licenses/>.
  17  */
  18 /** @file lib/queue.c
  19  * @brief Track queues
  20  */
  21 #include "common.h"
  22
  23 #include <errno.h>
  24 #include <stddef.h>
  25
  26 #include "mem.h"
  27 #include "queue.h"
  28 #include "log.h"
  29 #include "split.h"
  30 #include "syscalls.h"
  31 #include "table.h"
  32 #include "printf.h"
  33 #include "vector.h"
  34
  35 const char *const playing_states[] = {
  36   "failed",
  37   "isscratch",
  38   "no_player",
  39   "ok",
  40   "paused",
  41   "quitting",
  42   "random",
  43   "scratched",
  44   "started",
  45   "unplayed"
  46 };
  47
  48 /** @brief String values for @c origin field */
  49 const char *const track_origins[] = {
  50   "adopted",
  51   "picked",
  52   "random",
  53   "scheduled",
  54   "scratch",
  55 };
  56
  57 #define VALUE(q, offset, type) *(type *)((char *)q + offset)
  58
  59 /** @brief Insert queue entry @p n just after @p b
  60  * @param b Insert after this entry
  61  * @param n New entry to insert
  62  */
  63 void queue_insert_entry(struct queue_entry *b, struct queue_entry *n) {
  64   n->prev = b;
  65   n->next = b->next;
  66   n->next->prev = n;
  67   n->prev->next = n;
  68 }
  69
  70 /* remove an entry from a doubly-linked list */
  71 void queue_delete_entry(struct queue_entry *node) {
  72   node->next->prev = node->prev;
  73   node->prev->next = node->next;
  74 }
  75
  76 static int unmarshall_long(char *data, struct queue_entry *q,
  77                            size_t offset,
  78                            void (*error_handler)(const char *, void *),
  79                            void *u) {
  80   char errbuf[1024];
  81   if(xstrtol(&VALUE(q, offset, long), data, 0, 0)) {
  82     error_handler(format_error(ec_errno, errno, errbuf, sizeof errbuf), u);
  83     return -1;
  84   }
  85   return 0;
  86 }
  87
  88 static const char *marshall_long(const struct queue_entry *q, size_t offset) {
  89   char buffer[256];
  90   int n;
  91
  92   n = byte_snprintf(buffer, sizeof buffer, "%ld", VALUE(q, offset, long));
  93   if(n < 0)
  94     disorder_fatal(errno, "error converting int");
  95   else if((size_t)n >= sizeof buffer)
  96     disorder_fatal(0, "long converted to decimal is too long");
  97   return xstrdup(buffer);
  98 }
  99
 100 static void free_none(struct queue_entry attribute((unused)) *q,
 101                       size_t attribute((unused)) offset) {
 102 }
 103
 104 #define free_long free_none
 105
 106 static int unmarshall_string(char *data, struct queue_entry *q,
 107                              size_t offset,
 108                              void attribute((unused)) (*error_handler)(const char *, void *),
 109                              void attribute((unused)) *u) {
 110   VALUE(q, offset, char *) = xstrdup(data);
 111   return 0;
 112 }
 113
 114 static const char *marshall_string(const struct queue_entry *q, size_t offset) {
 115   return VALUE(q, offset, char *);
 116 }
 117
 118 static void free_string(struct queue_entry *q, size_t offset) {
 119   xfree(VALUE(q, offset, char *));
 120 }
 121
 122 static int unmarshall_time_t(char *data, struct queue_entry *q,
 123                              size_t offset,
 124                              void (*error_handler)(const char *, void *),
 125                              void *u) {
 126   long_long ul;
 127   char errbuf[1024];
 128
 129   if(xstrtoll(&ul, data, 0, 0)) {
 130     error_handler(format_error(ec_errno, errno, errbuf, sizeof errbuf), u);
 131     return -1;
 132   }
 133   VALUE(q, offset, time_t) = ul;
 134   return 0;
 135 }
 136
 137 static const char *marshall_time_t(const struct queue_entry *q, size_t offset) {
 138   char buffer[256];
 139   int n;
 140
 141   n = byte_snprintf(buffer, sizeof buffer,
 142                     "%"PRIdMAX, (intmax_t)VALUE(q, offset, time_t));
 143   if(n < 0)
 144     disorder_fatal(errno, "error converting time");
 145   else if((size_t)n >= sizeof buffer)
 146     disorder_fatal(0, "time converted to decimal is too long");
 147   return xstrdup(buffer);
 148 }
 149
 150 #define free_time_t free_none
 151
 152 static int unmarshall_state(char *data, struct queue_entry *q,
 153                             size_t offset,
 154                             void (*error_handler)(const char *, void *),
 155                             void *u) {
 156   int n;
 157
 158   if((n = table_find(playing_states, 0, sizeof (char *),
 159                      sizeof playing_states / sizeof *playing_states,
 160                      data)) < 0) {
 161     D(("state=[%s] n=%d", data, n));
 162     error_handler("invalid state", u);
 163     return -1;
 164   }
 165   VALUE(q, offset, enum playing_state) = n;
 166   return 0;
 167 }
 168
 169 static int unmarshall_origin(char *data, struct queue_entry *q,
 170                              size_t offset,
 171                              void (*error_handler)(const char *, void *),
 172                              void *u) {
 173   int n;
 174
 175   if((n = table_find(track_origins, 0, sizeof (char *),
 176                      sizeof track_origins / sizeof *track_origins,
 177                      data)) < 0) {
 178     D(("origin=[%s] n=%d", data, n));
 179     error_handler("invalid origin", u);
 180     return -1;
 181   }
 182   VALUE(q, offset, enum track_origin) = n;
 183   return 0;
 184 }
 185
 186 static const char *marshall_state(const struct queue_entry *q, size_t offset) {
 187   return playing_states[VALUE(q, offset, enum playing_state)];
 188 }
 189
 190 static const char *marshall_origin(const struct queue_entry *q, size_t offset) {
 191   return track_origins[VALUE(q, offset, enum track_origin)];
 192 }
 193
 194 #define free_state free_none
 195 #define free_origin free_none
 196
 197 #define F(n, h) { #n, offsetof(struct queue_entry, n), marshall_##h, unmarshall_##h, free_##h }
 198
 199 /** @brief A field in a @ref queue_entry */
 200 static const struct queue_field {
 201   /** @brief Field name */
 202   const char *name;
 203
 204   /** @brief Offset of value in @ref queue_entry structure */
 205   size_t offset;
 206
 207   /** @brief Marshaling function */
 208   const char *(*marshall)(const struct queue_entry *q, size_t offset);
 209
 210   /** @brief Unmarshaling function */
 211   int (*unmarshall)(char *data, struct queue_entry *q, size_t offset,
 212                     void (*error_handler)(const char *, void *),
 213                     void *u);
 214
 215   /** @brief Destructor */
 216   void (*free)(struct queue_entry *q, size_t offset);
 217 } fields[] = {
 218   /* Keep this table sorted. */
 219   F(expected, time_t),
 220   F(id, string),
 221   F(origin, origin),
 222   F(played, time_t),
 223   F(scratched, string),
 224   F(sofar, long),
 225   F(state, state),
 226   F(submitter, string),
 227   F(track, string),
 228   F(when, time_t),
 229   F(wstat, long)
 230 };
 231 #define NFIELDS (sizeof fields / sizeof *fields)
 232
 233 int queue_unmarshall(struct queue_entry *q, const char *s,
 234                      void (*error_handler)(const char *, void *),
 235                      void *u) {
 236   char **vec;
 237   int nvec, rc;
 238
 239   q->pid = -1;                          /* =none */
 240   if(!(vec = split(s, &nvec, SPLIT_QUOTES, error_handler, u)))
 241     return -1;
 242   rc = queue_unmarshall_vec(q, nvec, vec, error_handler, u);
 243   free_strings(nvec, vec);
 244   return rc;
 245 }
 246
 247 int queue_unmarshall_vec(struct queue_entry *q, int nvec, char **vec,
 248                          void (*error_handler)(const char *, void *),
 249                          void *u) {
 250   int n;
 251
 252   if(nvec % 2 != 0) {
 253     error_handler("invalid marshalled queue format", u);
 254     return -1;
 255   }
 256   while(*vec) {
 257     D(("key %s value %s", vec[0], vec[1]));
 258     if((n = TABLE_FIND(fields, name, *vec)) < 0) {
 259       error_handler("unknown key in queue data", u);
 260       return -1;
 261     } else {
 262       if(fields[n].unmarshall(vec[1], q, fields[n].offset, error_handler, u))
 263         return -1;
 264     }
 265     vec += 2;
 266   }
 267   return 0;
 268 }
 269
 270 char *queue_marshall(const struct queue_entry *q) {
 271   unsigned n;
 272   const char *vec[sizeof fields / sizeof *fields], *v;
 273   char *r, *s;
 274   size_t len = 1;
 275
 276   for(n = 0; n < sizeof fields / sizeof *fields; ++n)
 277     if((v = fields[n].marshall(q, fields[n].offset))) {
 278       vec[n] = quoteutf8(v);
 279       len += strlen(vec[n]) + strlen(fields[n].name) + 2;
 280     } else
 281       vec[n] = 0;
 282   s = r = xmalloc_noptr(len);
 283   for(n = 0; n < sizeof fields / sizeof *fields; ++n)
 284     if(vec[n]) {
 285       *s++ = ' ';
 286       s += strlen(strcpy(s, fields[n].name));
 287       *s++ = ' ';
 288       s += strlen(strcpy(s, vec[n]));
 289     }
 290   return r;
 291 }
 292
 293 void queue_free(struct queue_entry *q, int rest) {
 294   unsigned n;
 295   if(!q)
 296     return;
 297   if(rest)
 298     queue_free(q->next, rest);
 299   for(n = 0; n < NFIELDS; ++n)
 300     fields[n].free(q, fields[n].offset);
 301   xfree(q);
 302 }
 303
 304 /*
 305 Local Variables:
 306 c-basic-offset:2
 307 comment-column:40
 308 fill-column:79
 309 End:
 310 */