| 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 | static const struct field { |
| 198 | const char *name; |
| 199 | size_t offset; |
| 200 | const char *(*marshall)(const struct queue_entry *q, size_t offset); |
| 201 | int (*unmarshall)(char *data, struct queue_entry *q, size_t offset, |
| 202 | void (*error_handler)(const char *, void *), |
| 203 | void *u); |
| 204 | void (*free)(struct queue_entry *q, size_t offset); |
| 205 | } fields[] = { |
| 206 | /* Keep this table sorted. */ |
| 207 | F(expected, time_t), |
| 208 | F(id, string), |
| 209 | F(origin, origin), |
| 210 | F(played, time_t), |
| 211 | F(scratched, string), |
| 212 | F(sofar, long), |
| 213 | F(state, state), |
| 214 | F(submitter, string), |
| 215 | F(track, string), |
| 216 | F(when, time_t), |
| 217 | F(wstat, long) |
| 218 | }; |
| 219 | #define NFIELDS (sizeof fields / sizeof *fields) |
| 220 | |
| 221 | int queue_unmarshall(struct queue_entry *q, const char *s, |
| 222 | void (*error_handler)(const char *, void *), |
| 223 | void *u) { |
| 224 | char **vec; |
| 225 | int nvec; |
| 226 | |
| 227 | q->pid = -1; /* =none */ |
| 228 | if(!(vec = split(s, &nvec, SPLIT_QUOTES, error_handler, u))) |
| 229 | return -1; |
| 230 | int rc = queue_unmarshall_vec(q, nvec, vec, error_handler, u); |
| 231 | free_strings(nvec, vec); |
| 232 | return rc; |
| 233 | } |
| 234 | |
| 235 | int queue_unmarshall_vec(struct queue_entry *q, int nvec, char **vec, |
| 236 | void (*error_handler)(const char *, void *), |
| 237 | void *u) { |
| 238 | int n; |
| 239 | |
| 240 | if(nvec % 2 != 0) { |
| 241 | error_handler("invalid marshalled queue format", u); |
| 242 | return -1; |
| 243 | } |
| 244 | while(*vec) { |
| 245 | D(("key %s value %s", vec[0], vec[1])); |
| 246 | if((n = TABLE_FIND(fields, name, *vec)) < 0) { |
| 247 | error_handler("unknown key in queue data", u); |
| 248 | return -1; |
| 249 | } else { |
| 250 | if(fields[n].unmarshall(vec[1], q, fields[n].offset, error_handler, u)) |
| 251 | return -1; |
| 252 | } |
| 253 | vec += 2; |
| 254 | } |
| 255 | return 0; |
| 256 | } |
| 257 | |
| 258 | char *queue_marshall(const struct queue_entry *q) { |
| 259 | unsigned n; |
| 260 | const char *vec[sizeof fields / sizeof *fields], *v; |
| 261 | char *r, *s; |
| 262 | size_t len = 1; |
| 263 | |
| 264 | for(n = 0; n < sizeof fields / sizeof *fields; ++n) |
| 265 | if((v = fields[n].marshall(q, fields[n].offset))) { |
| 266 | vec[n] = quoteutf8(v); |
| 267 | len += strlen(vec[n]) + strlen(fields[n].name) + 2; |
| 268 | } else |
| 269 | vec[n] = 0; |
| 270 | s = r = xmalloc_noptr(len); |
| 271 | for(n = 0; n < sizeof fields / sizeof *fields; ++n) |
| 272 | if(vec[n]) { |
| 273 | *s++ = ' '; |
| 274 | s += strlen(strcpy(s, fields[n].name)); |
| 275 | *s++ = ' '; |
| 276 | s += strlen(strcpy(s, vec[n])); |
| 277 | } |
| 278 | return r; |
| 279 | } |
| 280 | |
| 281 | void queue_free(struct queue_entry *q, int rest) { |
| 282 | if(!q) |
| 283 | return; |
| 284 | if(rest) |
| 285 | queue_free(q->next, rest); |
| 286 | for(unsigned n = 0; n < NFIELDS; ++n) |
| 287 | fields[n].free(q, fields[n].offset); |
| 288 | xfree(q); |
| 289 | } |
| 290 | |
| 291 | /* |
| 292 | Local Variables: |
| 293 | c-basic-offset:2 |
| 294 | comment-column:40 |
| 295 | fill-column:79 |
| 296 | End: |
| 297 | */ |