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
  34 const char *const playing_states[] = {
  35   "failed",
  36   "isscratch",
  37   "no_player",
  38   "ok",
  39   "paused",
  40   "quitting",
  41   "random",
  42   "scratched",
  43   "started",
  44   "unplayed"
  45 };
  46
  47 /** @brief String values for @c origin field */
  48 const char *const track_origins[] = {
  49   "adopted",
  50   "picked",
  51   "random",
  52   "scheduled",
  53   "scratch",
  54 };
  55
  56 #define VALUE(q, offset, type) *(type *)((char *)q + offset)
  57
  58 /** @brief Insert queue entry @p n just after @p b
  59  * @param b Insert after this entry
  60  * @param n New entry to insert
  61  */
  62 void queue_insert_entry(struct queue_entry *b, struct queue_entry *n) {
  63   n->prev = b;
  64   n->next = b->next;
  65   n->next->prev = n;
  66   n->prev->next = n;
  67 }
  68
  69 /* remove an entry from a doubly-linked list */
  70 void queue_delete_entry(struct queue_entry *node) {
  71   node->next->prev = node->prev;
  72   node->prev->next = node->next;
  73 }
  74
  75 static int unmarshall_long(char *data, struct queue_entry *q,
  76                            size_t offset,
  77                            void (*error_handler)(const char *, void *),
  78                            void *u) {
  79   if(xstrtol(&VALUE(q, offset, long), data, 0, 0)) {
  80     error_handler(strerror(errno), u);
  81     return -1;
  82   }
  83   return 0;
  84 }
  85
  86 static const char *marshall_long(const struct queue_entry *q, size_t offset) {
  87   char buffer[256];
  88   int n;
  89
  90   n = byte_snprintf(buffer, sizeof buffer, "%ld", VALUE(q, offset, long));
  91   if(n < 0)
  92     disorder_fatal(errno, "error converting int");
  93   else if((size_t)n >= sizeof buffer)
  94     disorder_fatal(0, "long converted to decimal is too long");
  95   return xstrdup(buffer);
  96 }
  97
  98 static int unmarshall_string(char *data, struct queue_entry *q,
  99                              size_t offset,
 100                              void attribute((unused)) (*error_handler)(const char *, void *),
 101                              void attribute((unused)) *u) {
 102   VALUE(q, offset, char *) = data;
 103   return 0;
 104 }
 105
 106 static const char *marshall_string(const struct queue_entry *q, size_t offset) {
 107   return VALUE(q, offset, char *);
 108 }
 109
 110 static int unmarshall_time_t(char *data, struct queue_entry *q,
 111                              size_t offset,
 112                              void (*error_handler)(const char *, void *),
 113                              void *u) {
 114   long_long ul;
 115
 116   if(xstrtoll(&ul, data, 0, 0)) {
 117     error_handler(strerror(errno), u);
 118     return -1;
 119   }
 120   VALUE(q, offset, time_t) = ul;
 121   return 0;
 122 }
 123
 124 static const char *marshall_time_t(const struct queue_entry *q, size_t offset) {
 125   char buffer[256];
 126   int n;
 127
 128   n = byte_snprintf(buffer, sizeof buffer,
 129                     "%"PRIdMAX, (intmax_t)VALUE(q, offset, time_t));
 130   if(n < 0)
 131     disorder_fatal(errno, "error converting time");
 132   else if((size_t)n >= sizeof buffer)
 133     disorder_fatal(0, "time converted to decimal is too long");
 134   return xstrdup(buffer);
 135 }
 136
 137 static int unmarshall_state(char *data, struct queue_entry *q,
 138                             size_t offset,
 139                             void (*error_handler)(const char *, void *),
 140                             void *u) {
 141   int n;
 142
 143   if((n = table_find(playing_states, 0, sizeof (char *),
 144                      sizeof playing_states / sizeof *playing_states,
 145                      data)) < 0) {
 146     D(("state=[%s] n=%d", data, n));
 147     error_handler("invalid state", u);
 148     return -1;
 149   }
 150   VALUE(q, offset, enum playing_state) = n;
 151   return 0;
 152 }
 153
 154 static int unmarshall_origin(char *data, struct queue_entry *q,
 155                              size_t offset,
 156                              void (*error_handler)(const char *, void *),
 157                              void *u) {
 158   int n;
 159
 160   if((n = table_find(track_origins, 0, sizeof (char *),
 161                      sizeof track_origins / sizeof *track_origins,
 162                      data)) < 0) {
 163     D(("origin=[%s] n=%d", data, n));
 164     error_handler("invalid origin", u);
 165     return -1;
 166   }
 167   VALUE(q, offset, enum track_origin) = n;
 168   return 0;
 169 }
 170
 171 static const char *marshall_state(const struct queue_entry *q, size_t offset) {
 172   return playing_states[VALUE(q, offset, enum playing_state)];
 173 }
 174
 175 static const char *marshall_origin(const struct queue_entry *q, size_t offset) {
 176   return track_origins[VALUE(q, offset, enum track_origin)];
 177 }
 178
 179 #define F(n, h) { #n, offsetof(struct queue_entry, n), marshall_##h, unmarshall_##h }
 180
 181 static const struct field {
 182   const char *name;
 183   size_t offset;
 184   const char *(*marshall)(const struct queue_entry *q, size_t offset);
 185   int (*unmarshall)(char *data, struct queue_entry *q, size_t offset,
 186                     void (*error_handler)(const char *, void *),
 187                     void *u);
 188 } fields[] = {
 189   /* Keep this table sorted. */
 190   F(expected, time_t),
 191   F(id, string),
 192   F(origin, origin),
 193   F(played, time_t),
 194   F(scratched, string),
 195   F(sofar, long),
 196   F(state, state),
 197   F(submitter, string),
 198   F(track, string),
 199   F(when, time_t),
 200   F(wstat, long)
 201 };
 202
 203 int queue_unmarshall(struct queue_entry *q, const char *s,
 204                      void (*error_handler)(const char *, void *),
 205                      void *u) {
 206   char **vec;
 207   int nvec;
 208
 209   q->pid = -1;                          /* =none */
 210   if(!(vec = split(s, &nvec, SPLIT_QUOTES, error_handler, u)))
 211     return -1;
 212   return queue_unmarshall_vec(q, nvec, vec, error_handler, u);
 213 }
 214
 215 int queue_unmarshall_vec(struct queue_entry *q, int nvec, char **vec,
 216                          void (*error_handler)(const char *, void *),
 217                          void *u) {
 218   int n;
 219
 220   if(nvec % 2 != 0) {
 221     error_handler("invalid marshalled queue format", u);
 222     return -1;
 223   }
 224   while(*vec) {
 225     D(("key %s value %s", vec[0], vec[1]));
 226     if((n = TABLE_FIND(fields, name, *vec)) < 0) {
 227       error_handler("unknown key in queue data", u);
 228       return -1;
 229     } else {
 230       if(fields[n].unmarshall(vec[1], q, fields[n].offset, error_handler, u))
 231         return -1;
 232     }
 233     vec += 2;
 234   }
 235   return 0;
 236 }
 237
 238 char *queue_marshall(const struct queue_entry *q) {
 239   unsigned n;
 240   const char *vec[sizeof fields / sizeof *fields], *v;
 241   char *r, *s;
 242   size_t len = 1;
 243
 244   for(n = 0; n < sizeof fields / sizeof *fields; ++n)
 245     if((v = fields[n].marshall(q, fields[n].offset))) {
 246       vec[n] = quoteutf8(v);
 247       len += strlen(vec[n]) + strlen(fields[n].name) + 2;
 248     } else
 249       vec[n] = 0;
 250   s = r = xmalloc_noptr(len);
 251   for(n = 0; n < sizeof fields / sizeof *fields; ++n)
 252     if(vec[n]) {
 253       *s++ = ' ';
 254       s += strlen(strcpy(s, fields[n].name));
 255       *s++ = ' ';
 256       s += strlen(strcpy(s, vec[n]));
 257     }
 258   return r;
 259 }
 260
 261 /*
 262 Local Variables:
 263 c-basic-offset:2
 264 comment-column:40
 265 fill-column:79
 266 End:
 267 */