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

   1 /*
   2  * This file is part of DisOrder.
   3  * Copyright (C) 2004-2009 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   if(xstrtol(&VALUE(q, offset, long), data, 0, 0)) {
  81     error_handler(strerror(errno), u);
  82     return -1;
  83   }
  84   return 0;
  85 }
  86
  87 static const char *marshall_long(const struct queue_entry *q, size_t offset) {
  88   char buffer[256];
  89   int n;
  90
  91   n = byte_snprintf(buffer, sizeof buffer, "%ld", VALUE(q, offset, long));
  92   if(n < 0)
  93     disorder_fatal(errno, "error converting int");
  94   else if((size_t)n >= sizeof buffer)
  95     disorder_fatal(0, "long converted to decimal is too long");
  96   return xstrdup(buffer);
  97 }
  98
  99 static void free_none(struct queue_entry attribute((unused)) *q,
 100                       size_t attribute((unused)) offset) {
 101 }
 102
 103 #define free_long free_none
 104
 105 static int unmarshall_string(char *data, struct queue_entry *q,
 106                              size_t offset,
 107                              void attribute((unused)) (*error_handler)(const char *, void *),
 108                              void attribute((unused)) *u) {
 109   VALUE(q, offset, char *) = xstrdup(data);
 110   return 0;
 111 }
 112
 113 static const char *marshall_string(const struct queue_entry *q, size_t offset) {
 114   return VALUE(q, offset, char *);
 115 }
 116
 117 static void free_string(struct queue_entry *q, size_t offset) {
 118   xfree(VALUE(q, offset, char *));
 119 }
 120
 121 static int unmarshall_time_t(char *data, struct queue_entry *q,
 122                              size_t offset,
 123                              void (*error_handler)(const char *, void *),
 124                              void *u) {
 125   long_long ul;
 126
 127   if(xstrtoll(&ul, data, 0, 0)) {
 128     error_handler(strerror(errno), u);
 129     return -1;
 130   }
 131   VALUE(q, offset, time_t) = ul;
 132   return 0;
 133 }
 134
 135 static const char *marshall_time_t(const struct queue_entry *q, size_t offset) {
 136   char buffer[256];
 137   int n;
 138
 139   n = byte_snprintf(buffer, sizeof buffer,
 140                     "%"PRIdMAX, (intmax_t)VALUE(q, offset, time_t));
 141   if(n < 0)
 142     disorder_fatal(errno, "error converting time");
 143   else if((size_t)n >= sizeof buffer)
 144     disorder_fatal(0, "time converted to decimal is too long");
 145   return xstrdup(buffer);
 146 }
 147
 148 #define free_time_t free_none
 149
 150 static int unmarshall_state(char *data, struct queue_entry *q,
 151                             size_t offset,
 152                             void (*error_handler)(const char *, void *),
 153                             void *u) {
 154   int n;
 155
 156   if((n = table_find(playing_states, 0, sizeof (char *),
 157                      sizeof playing_states / sizeof *playing_states,
 158                      data)) < 0) {
 159     D(("state=[%s] n=%d", data, n));
 160     error_handler("invalid state", u);
 161     return -1;
 162   }
 163   VALUE(q, offset, enum playing_state) = n;
 164   return 0;
 165 }
 166
 167 static int unmarshall_origin(char *data, struct queue_entry *q,
 168                              size_t offset,
 169                              void (*error_handler)(const char *, void *),
 170                              void *u) {
 171   int n;
 172
 173   if((n = table_find(track_origins, 0, sizeof (char *),
 174                      sizeof track_origins / sizeof *track_origins,
 175                      data)) < 0) {
 176     D(("origin=[%s] n=%d", data, n));
 177     error_handler("invalid origin", u);
 178     return -1;
 179   }
 180   VALUE(q, offset, enum track_origin) = n;
 181   return 0;
 182 }
 183
 184 static const char *marshall_state(const struct queue_entry *q, size_t offset) {
 185   return playing_states[VALUE(q, offset, enum playing_state)];
 186 }
 187
 188 static const char *marshall_origin(const struct queue_entry *q, size_t offset) {
 189   return track_origins[VALUE(q, offset, enum track_origin)];
 190 }
 191
 192 #define free_state free_none
 193 #define free_origin free_none
 194
 195 #define F(n, h) { #n, offsetof(struct queue_entry, n), marshall_##h, unmarshall_##h, free_##h }
 196
 197 /** @brief A field in a @ref queue_entry */
 198 static const struct queue_field {
 199   /** @brief Field name */
 200   const char *name;
 201
 202   /** @brief Offset of value in @ref queue_entry structure */
 203   size_t offset;
 204
 205   /** @brief Marshaling function */
 206   const char *(*marshall)(const struct queue_entry *q, size_t offset);
 207
 208   /** @brief Unmarshaling function */
 209   int (*unmarshall)(char *data, struct queue_entry *q, size_t offset,
 210                     void (*error_handler)(const char *, void *),
 211                     void *u);
 212
 213   /** @brief Destructor */
 214   void (*free)(struct queue_entry *q, size_t offset);
 215 } fields[] = {
 216   /* Keep this table sorted. */
 217   F(expected, time_t),
 218   F(id, string),
 219   F(origin, origin),
 220   F(played, time_t),
 221   F(scratched, string),
 222   F(sofar, long),
 223   F(state, state),
 224   F(submitter, string),
 225   F(track, string),
 226   F(when, time_t),
 227   F(wstat, long)
 228 };
 229 #define NFIELDS (sizeof fields / sizeof *fields)
 230
 231 int queue_unmarshall(struct queue_entry *q, const char *s,
 232                      void (*error_handler)(const char *, void *),
 233                      void *u) {
 234   char **vec;
 235   int nvec;
 236
 237   q->pid = -1;                          /* =none */
 238   if(!(vec = split(s, &nvec, SPLIT_QUOTES, error_handler, u)))
 239     return -1;
 240   int rc = queue_unmarshall_vec(q, nvec, vec, error_handler, u);
 241   free_strings(nvec, vec);
 242   return rc;
 243 }
 244
 245 int queue_unmarshall_vec(struct queue_entry *q, int nvec, char **vec,
 246                          void (*error_handler)(const char *, void *),
 247                          void *u) {
 248   int n;
 249
 250   if(nvec % 2 != 0) {
 251     error_handler("invalid marshalled queue format", u);
 252     return -1;
 253   }
 254   while(*vec) {
 255     D(("key %s value %s", vec[0], vec[1]));
 256     if((n = TABLE_FIND(fields, name, *vec)) < 0) {
 257       error_handler("unknown key in queue data", u);
 258       return -1;
 259     } else {
 260       if(fields[n].unmarshall(vec[1], q, fields[n].offset, error_handler, u))
 261         return -1;
 262     }
 263     vec += 2;
 264   }
 265   return 0;
 266 }
 267
 268 char *queue_marshall(const struct queue_entry *q) {
 269   unsigned n;
 270   const char *vec[sizeof fields / sizeof *fields], *v;
 271   char *r, *s;
 272   size_t len = 1;
 273
 274   for(n = 0; n < sizeof fields / sizeof *fields; ++n)
 275     if((v = fields[n].marshall(q, fields[n].offset))) {
 276       vec[n] = quoteutf8(v);
 277       len += strlen(vec[n]) + strlen(fields[n].name) + 2;
 278     } else
 279       vec[n] = 0;
 280   s = r = xmalloc_noptr(len);
 281   for(n = 0; n < sizeof fields / sizeof *fields; ++n)
 282     if(vec[n]) {
 283       *s++ = ' ';
 284       s += strlen(strcpy(s, fields[n].name));
 285       *s++ = ' ';
 286       s += strlen(strcpy(s, vec[n]));
 287     }
 288   return r;
 289 }
 290
 291 void queue_free(struct queue_entry *q, int rest) {
 292   if(!q)
 293     return;
 294   if(rest)
 295     queue_free(q->next, rest);
 296   for(unsigned n = 0; n < NFIELDS; ++n)
 297     fields[n].free(q, fields[n].offset);
 298   xfree(q);
 299 }
 300
 301 /*
 302 Local Variables:
 303 c-basic-offset:2
 304 comment-column:40
 305 fill-column:79
 306 End:
 307 */