Commit | Line | Data |
---|---|---|
460b9539 | 1 | /* |
2 | * This file is part of DisOrder | |
4363757e | 3 | * Copyright (C) 2005-2008 Richard Kettlewell |
460b9539 | 4 | * |
e7eb3a27 | 5 | * This program is free software: you can redistribute it and/or modify |
460b9539 | 6 | * it under the terms of the GNU General Public License as published by |
e7eb3a27 | 7 | * the Free Software Foundation, either version 3 of the License, or |
460b9539 | 8 | * (at your option) any later version. |
e7eb3a27 RK |
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 | * | |
460b9539 | 15 | * You should have received a copy of the GNU General Public License |
e7eb3a27 | 16 | * along with this program. If not, see <http://www.gnu.org/licenses/>. |
460b9539 | 17 | */ |
158d0961 | 18 | /** @file lib/trackdb.c |
f0feb22e RK |
19 | * @brief Track database |
20 | * | |
21 | * This file is getting in desparate need of splitting up... | |
22 | */ | |
460b9539 | 23 | |
05b75f8d | 24 | #include "common.h" |
460b9539 | 25 | |
460b9539 | 26 | #include <db.h> |
27 | #include <sys/socket.h> | |
28 | #include <pcre.h> | |
460b9539 | 29 | #include <unistd.h> |
30 | #include <errno.h> | |
31 | #include <stddef.h> | |
32 | #include <sys/time.h> | |
33 | #include <sys/resource.h> | |
34 | #include <time.h> | |
2a10b70b | 35 | #include <arpa/inet.h> |
a745dd43 RK |
36 | #include <dirent.h> |
37 | #include <sys/stat.h> | |
f0feb22e | 38 | #include <gcrypt.h> |
460b9539 | 39 | |
40 | #include "event.h" | |
41 | #include "mem.h" | |
42 | #include "kvp.h" | |
43 | #include "log.h" | |
44 | #include "vector.h" | |
5df73aeb | 45 | #include "rights.h" |
460b9539 | 46 | #include "trackdb.h" |
47 | #include "configuration.h" | |
48 | #include "syscalls.h" | |
49 | #include "wstat.h" | |
460b9539 | 50 | #include "printf.h" |
51 | #include "filepart.h" | |
52 | #include "trackname.h" | |
53 | #include "trackdb-int.h" | |
54 | #include "logfd.h" | |
55 | #include "cache.h" | |
56 | #include "eventlog.h" | |
57 | #include "hash.h" | |
c85b7022 RK |
58 | #include "unicode.h" |
59 | #include "unidata.h" | |
fce810c2 | 60 | #include "base64.h" |
33e95f03 | 61 | #include "sendmail.h" |
460b9539 | 62 | |
63 | #define RESCAN "disorder-rescan" | |
64 | #define DEADLOCK "disorder-deadlock" | |
65 | ||
66 | static const char *getpart(const char *track, | |
67 | const char *context, | |
68 | const char *part, | |
69 | const struct kvp *p, | |
70 | int *used_db); | |
2a10b70b RK |
71 | static char **trackdb_new_tid(int *ntracksp, |
72 | int maxtracks, | |
73 | DB_TXN *tid); | |
1e64e9fb | 74 | static int trackdb_expire_noticed_tid(time_t earliest, DB_TXN *tid); |
a3777123 | 75 | static char *normalize_tag(const char *s, size_t ns); |
460b9539 | 76 | |
77 | const struct cache_type cache_files_type = { 86400 }; | |
78 | unsigned long cache_files_hits, cache_files_misses; | |
79 | ||
f982b120 RK |
80 | /** @brief Set by trackdb_open() */ |
81 | int trackdb_existing_database; | |
82 | ||
460b9539 | 83 | /* setup and teardown ********************************************************/ |
84 | ||
85 | static const char *home; /* home had better not change */ | |
86 | DB_ENV *trackdb_env; /* db environment */ | |
f9635e06 RK |
87 | |
88 | /** @brief The tracks database | |
89 | * - Keys are UTF-8(NFC(unicode(path name))) | |
90 | * - Values are encoded key-value pairs | |
91 | * - Data is reconstructable data about tracks that currently exist | |
92 | */ | |
93 | DB *trackdb_tracksdb; | |
94 | ||
95 | /** @brief The preferences database | |
96 | * | |
97 | * - Keys are UTF-8(NFC(unicode(path name))) | |
98 | * - Values are encoded key-value pairs | |
99 | * - Data is user data about tracks (that might not exist any more) | |
100 | * and cannot be reconstructed | |
101 | */ | |
102 | DB *trackdb_prefsdb; | |
103 | ||
104 | /** @brief The search database | |
105 | * | |
106 | * - Keys are UTF-8(NFKC(casefold(search term))) | |
107 | * - Values are UTF-8(NFC(unicode(path name))) | |
108 | * - There can be more than one value per key | |
109 | * - Presence of key,value means that path matches the search terms | |
158d0961 | 110 | * - Only tracks fond in @ref trackdb_tracksdb are represented here |
f9635e06 RK |
111 | * - This database can be reconstructed, it contains no user data |
112 | */ | |
113 | DB *trackdb_searchdb; | |
114 | ||
115 | /** @brief The tags database | |
116 | * | |
117 | * - Keys are UTF-8(NFKC(casefold(tag))) | |
118 | * - Values are UTF-8(NFC(unicode(path name))) | |
119 | * - There can be more than one value per key | |
120 | * - Presence of key,value means that path matches the tag | |
121 | * - This is always in sync with the tags preference | |
122 | * - This database can be reconstructed, it contains no user data | |
123 | */ | |
460b9539 | 124 | DB *trackdb_tagsdb; /* the tags database */ |
f9635e06 RK |
125 | |
126 | /** @brief The global preferences database | |
127 | * - Keys are UTF-8(NFC(preference)) | |
128 | * - Values are global preference values | |
129 | * - Data is user data and cannot be reconstructed | |
130 | */ | |
460b9539 | 131 | DB *trackdb_globaldb; /* global preferences */ |
f9635e06 RK |
132 | |
133 | /** @brief The noticed database | |
134 | * - Keys are 64-bit big-endian timestamps | |
135 | * - Values are UTF-8(NFC(unicode(path name))) | |
136 | * - There can be more than one value per key | |
137 | * - Presence of key,value means that path was added at the given time | |
138 | * - Data cannot be reconstructed (but isn't THAT important) | |
139 | */ | |
2a10b70b | 140 | DB *trackdb_noticeddb; /* when track noticed */ |
a745dd43 | 141 | |
fdca70ee RK |
142 | /** @brief The schedule database |
143 | * | |
144 | * - Keys are ID strings, generated at random | |
145 | * - Values are encoded key-value pairs | |
146 | * - There can be more than one value per key | |
147 | * - Data cannot be reconstructed | |
148 | * | |
149 | * See @ref server/schedule.c for further information. | |
150 | */ | |
151 | DB *trackdb_scheduledb; | |
152 | ||
a745dd43 RK |
153 | /** @brief The user database |
154 | * - Keys are usernames | |
155 | * - Values are encoded key-value pairs | |
156 | * - Data is user data and cannot be reconstructed | |
157 | */ | |
158 | DB *trackdb_usersdb; | |
159 | ||
460b9539 | 160 | static pid_t db_deadlock_pid = -1; /* deadlock manager PID */ |
161 | static pid_t rescan_pid = -1; /* rescanner PID */ | |
162 | static int initialized, opened; /* state */ | |
163 | ||
460b9539 | 164 | /* comparison function for keys */ |
165 | static int compare(DB attribute((unused)) *db_, | |
166 | const DBT *a, const DBT *b) { | |
167 | return compare_path_raw(a->data, a->size, b->data, b->size); | |
168 | } | |
169 | ||
199c2a23 RK |
170 | /** @brief Test whether the track database can be read |
171 | * @return 1 if it can, 0 if it cannot | |
172 | */ | |
173 | int trackdb_readable(void) { | |
174 | char *usersdb; | |
175 | ||
176 | byte_xasprintf(&usersdb, "%s/users.db", config->home); | |
177 | return access(usersdb, R_OK) == 0; | |
178 | } | |
179 | ||
d25c4615 RK |
180 | /** @brief Open database environment |
181 | * @param flags Flags word | |
182 | * | |
183 | * Flags should be one of: | |
184 | * - @ref TRACKDB_NO_RECOVER | |
185 | * - @ref TRACKDB_NORMAL_RECOVER | |
186 | * - @ref TRACKDB_FATAL_RECOVER | |
a745dd43 | 187 | * - @ref TRACKDB_MAY_CREATE |
d25c4615 RK |
188 | */ |
189 | void trackdb_init(int flags) { | |
460b9539 | 190 | int err; |
d25c4615 | 191 | const int recover = flags & TRACKDB_RECOVER_MASK; |
460b9539 | 192 | static int recover_type[] = { 0, DB_RECOVER, DB_RECOVER_FATAL }; |
193 | ||
194 | /* sanity checks */ | |
195 | assert(initialized == 0); | |
196 | ++initialized; | |
197 | if(home) { | |
198 | if(strcmp(home, config->home)) | |
199 | fatal(0, "cannot change db home without server restart"); | |
200 | home = config->home; | |
201 | } | |
202 | ||
a745dd43 RK |
203 | if(flags & TRACKDB_MAY_CREATE) { |
204 | DIR *dp; | |
205 | struct dirent *de; | |
206 | struct stat st; | |
207 | char *p; | |
208 | ||
a745dd43 RK |
209 | /* Remove world/group permissions on any regular files already in the |
210 | * database directory. Actually we don't care about all of them but it's | |
211 | * easier to just do the lot. This can be revisited if it's a serious | |
212 | * practical inconvenience for anyone. | |
213 | * | |
214 | * The socket, not being a regular file, is excepted. | |
215 | */ | |
216 | if(!(dp = opendir(config->home))) | |
217 | fatal(errno, "error reading %s", config->home); | |
218 | while((de = readdir(dp))) { | |
219 | byte_xasprintf(&p, "%s/%s", config->home, de->d_name); | |
220 | if(lstat(p, &st) == 0 | |
221 | && S_ISREG(st.st_mode) | |
222 | && (st.st_mode & 077)) { | |
f0feb22e | 223 | if(chmod(p, st.st_mode & 07700) < 0) |
a745dd43 RK |
224 | fatal(errno, "cannot chmod %s", p); |
225 | } | |
226 | xfree(p); | |
227 | } | |
228 | closedir(dp); | |
229 | } | |
230 | ||
460b9539 | 231 | /* create environment */ |
232 | if((err = db_env_create(&trackdb_env, 0))) fatal(0, "db_env_create: %s", | |
233 | db_strerror(err)); | |
234 | if((err = trackdb_env->set_alloc(trackdb_env, | |
235 | xmalloc_noptr, xrealloc_noptr, xfree))) | |
236 | fatal(0, "trackdb_env->set_alloc: %s", db_strerror(err)); | |
237 | if((err = trackdb_env->set_lk_max_locks(trackdb_env, 10000))) | |
238 | fatal(0, "trackdb_env->set_lk_max_locks: %s", db_strerror(err)); | |
239 | if((err = trackdb_env->set_lk_max_objects(trackdb_env, 10000))) | |
240 | fatal(0, "trackdb_env->set_lk_max_objects: %s", db_strerror(err)); | |
241 | if((err = trackdb_env->open(trackdb_env, config->home, | |
242 | DB_INIT_LOG | |
243 | |DB_INIT_LOCK | |
244 | |DB_INIT_MPOOL | |
245 | |DB_INIT_TXN | |
246 | |DB_CREATE | |
247 | |recover_type[recover], | |
a745dd43 | 248 | 0600))) |
dc450d30 | 249 | fatal(0, "trackdb_env->open %s: %s", config->home, db_strerror(err)); |
460b9539 | 250 | trackdb_env->set_errpfx(trackdb_env, "DB"); |
251 | trackdb_env->set_errfile(trackdb_env, stderr); | |
252 | trackdb_env->set_verbose(trackdb_env, DB_VERB_DEADLOCK, 1); | |
253 | trackdb_env->set_verbose(trackdb_env, DB_VERB_RECOVERY, 1); | |
254 | trackdb_env->set_verbose(trackdb_env, DB_VERB_REPLICATION, 1); | |
255 | D(("initialized database environment")); | |
256 | } | |
257 | ||
258 | /* called when deadlock manager terminates */ | |
259 | static int reap_db_deadlock(ev_source attribute((unused)) *ev, | |
260 | pid_t attribute((unused)) pid, | |
261 | int status, | |
262 | const struct rusage attribute((unused)) *rusage, | |
263 | void attribute((unused)) *u) { | |
264 | db_deadlock_pid = -1; | |
265 | if(initialized) | |
266 | fatal(0, "deadlock manager unexpectedly terminated: %s", | |
267 | wstat(status)); | |
268 | else | |
269 | D(("deadlock manager terminated: %s", wstat(status))); | |
270 | return 0; | |
271 | } | |
272 | ||
ffac51d7 RK |
273 | static pid_t subprogram(ev_source *ev, int outputfd, const char *prog, |
274 | ...) { | |
460b9539 | 275 | pid_t pid; |
ffac51d7 RK |
276 | va_list ap; |
277 | const char *args[1024], **argp, *a; | |
278 | ||
279 | argp = args; | |
280 | *argp++ = prog; | |
281 | *argp++ = "--config"; | |
282 | *argp++ = configfile; | |
283 | *argp++ = debugging ? "--debug" : "--no-debug"; | |
284 | *argp++ = log_default == &log_syslog ? "--syslog" : "--no-syslog"; | |
285 | va_start(ap, prog); | |
286 | while((a = va_arg(ap, const char *))) | |
287 | *argp++ = a; | |
288 | va_end(ap); | |
289 | *argp = 0; | |
460b9539 | 290 | /* If we're in the background then trap subprocess stdout/stderr */ |
460b9539 | 291 | if(!(pid = xfork())) { |
292 | exitfn = _exit; | |
f2218e3c RK |
293 | if(ev) |
294 | ev_signal_atfork(ev); | |
460b9539 | 295 | signal(SIGPIPE, SIG_DFL); |
d6dde5a3 RK |
296 | if(outputfd != -1) { |
297 | xdup2(outputfd, 1); | |
298 | xclose(outputfd); | |
460b9539 | 299 | } |
f0feb22e RK |
300 | /* ensure we don't leak privilege anywhere */ |
301 | if(setuid(geteuid()) < 0) | |
302 | fatal(errno, "error calling setuid"); | |
303 | /* If we were negatively niced, undo it. We don't bother checking for | |
304 | * error, it's not that important. */ | |
460b9539 | 305 | setpriority(PRIO_PROCESS, 0, 0); |
ffac51d7 | 306 | execvp(prog, (char **)args); |
460b9539 | 307 | fatal(errno, "error invoking %s", prog); |
308 | } | |
460b9539 | 309 | return pid; |
310 | } | |
311 | ||
312 | /* start deadlock manager */ | |
313 | void trackdb_master(ev_source *ev) { | |
314 | assert(db_deadlock_pid == -1); | |
ffac51d7 | 315 | db_deadlock_pid = subprogram(ev, -1, DEADLOCK, (char *)0); |
460b9539 | 316 | ev_child(ev, db_deadlock_pid, 0, reap_db_deadlock, 0); |
317 | D(("started deadlock manager")); | |
318 | } | |
319 | ||
320 | /* close environment */ | |
321 | void trackdb_deinit(void) { | |
322 | int err; | |
323 | ||
324 | /* sanity checks */ | |
325 | assert(initialized == 1); | |
326 | --initialized; | |
327 | ||
328 | /* close the environment */ | |
329 | if((err = trackdb_env->close(trackdb_env, 0))) | |
330 | fatal(0, "trackdb_env->close: %s", db_strerror(err)); | |
331 | ||
4363757e RK |
332 | if(rescan_pid != -1) { |
333 | /* shut down the rescanner */ | |
334 | if(kill(rescan_pid, SIGTERM) < 0) | |
335 | fatal(errno, "error killing rescanner"); | |
336 | /* wait for the rescanner to finish */ | |
337 | while(waitpid(rescan_pid, &err, 0) == -1 && errno == EINTR) | |
338 | ; | |
339 | } | |
340 | ||
341 | /* TODO kill any stats subprocesses */ | |
460b9539 | 342 | |
4363757e | 343 | /* finally terminate the deadlock manager */ |
460b9539 | 344 | if(db_deadlock_pid != -1 && kill(db_deadlock_pid, SIGTERM) < 0) |
345 | fatal(errno, "error killing deadlock manager"); | |
346 | db_deadlock_pid = -1; | |
347 | ||
348 | D(("deinitialized database environment")); | |
349 | } | |
350 | ||
351 | /* open a specific database */ | |
352 | static DB *open_db(const char *path, | |
353 | u_int32_t dbflags, | |
354 | DBTYPE dbtype, | |
355 | u_int32_t openflags, | |
356 | int mode) { | |
958a9462 | 357 | int err, err2; |
460b9539 | 358 | DB *db; |
359 | ||
360 | D(("open %s", path)); | |
361 | path = config_get_file(path); | |
362 | if((err = db_create(&db, trackdb_env, 0))) | |
363 | fatal(0, "db_create %s: %s", path, db_strerror(err)); | |
364 | if(dbflags) | |
365 | if((err = db->set_flags(db, dbflags))) | |
366 | fatal(0, "db->set_flags %s: %s", path, db_strerror(err)); | |
367 | if(dbtype == DB_BTREE) | |
368 | if((err = db->set_bt_compare(db, compare))) | |
369 | fatal(0, "db->set_bt_compare %s: %s", path, db_strerror(err)); | |
370 | if((err = db->open(db, 0, path, 0, dbtype, | |
f9635e06 | 371 | openflags | DB_AUTO_COMMIT, mode))) { |
958a9462 RK |
372 | if((openflags & DB_CREATE) || errno != ENOENT) { |
373 | if((err2 = db->close(db, 0))) | |
374 | error(0, "db->close: %s", db_strerror(err2)); | |
375 | trackdb_close(); | |
376 | trackdb_env->close(trackdb_env,0); | |
377 | trackdb_env = 0; | |
f9635e06 | 378 | fatal(0, "db->open %s: %s", path, db_strerror(err)); |
958a9462 | 379 | } |
f9635e06 RK |
380 | db->close(db, 0); |
381 | db = 0; | |
382 | } | |
460b9539 | 383 | return db; |
384 | } | |
385 | ||
3dc3d7db | 386 | /** @brief Open track databases |
158d0961 | 387 | * @param flags Flags flags word |
d25c4615 | 388 | * |
f0feb22e | 389 | * @p flags should have one of: |
d25c4615 RK |
390 | * - @p TRACKDB_NO_UPGRADE, if no upgrade should be attempted |
391 | * - @p TRACKDB_CAN_UPGRADE, if an upgrade may be attempted | |
392 | * - @p TRACKDB_OPEN_FOR_UPGRADE, if this is disorder-dbupgrade | |
f0feb22e RK |
393 | * Also it may have: |
394 | * - @p TRACKDB_READ_ONLY, read only access | |
3dc3d7db | 395 | */ |
d25c4615 | 396 | void trackdb_open(int flags) { |
f982b120 | 397 | int err; |
f2218e3c | 398 | pid_t pid; |
f0feb22e | 399 | uint32_t dbflags = flags & TRACKDB_READ_ONLY ? DB_RDONLY : DB_CREATE; |
f9635e06 | 400 | |
460b9539 | 401 | /* sanity checks */ |
402 | assert(opened == 0); | |
403 | ++opened; | |
f9635e06 | 404 | /* check the database version first */ |
f0feb22e | 405 | trackdb_globaldb = open_db("global.db", 0, DB_HASH, DB_RDONLY, 0666); |
f9635e06 RK |
406 | if(trackdb_globaldb) { |
407 | /* This is an existing database */ | |
8818b7fc RK |
408 | const char *s; |
409 | long oldversion; | |
f9635e06 | 410 | |
8818b7fc | 411 | s = trackdb_get_global("_dbversion"); |
d25c4615 RK |
412 | /* Close the database again, we'll open it property below */ |
413 | if((err = trackdb_globaldb->close(trackdb_globaldb, 0))) | |
414 | fatal(0, "error closing global.db: %s", db_strerror(err)); | |
415 | trackdb_globaldb = 0; | |
416 | /* Convert version string to an integer */ | |
8818b7fc | 417 | oldversion = s ? atol(s) : 1; |
3dc3d7db | 418 | if(oldversion > config->dbversion) { |
d25c4615 | 419 | /* Database is from the future; we never allow this. */ |
3dc3d7db RK |
420 | fatal(0, "this version of DisOrder is too old for database version %ld", |
421 | oldversion); | |
422 | } | |
d25c4615 RK |
423 | if(oldversion < config->dbversion) { |
424 | /* Database version is out of date */ | |
425 | switch(flags & TRACKDB_UPGRADE_MASK) { | |
426 | case TRACKDB_NO_UPGRADE: | |
427 | /* This database needs upgrading but this is not permitted */ | |
428 | fatal(0, "database needs upgrading from %ld to %ld", | |
429 | oldversion, config->dbversion); | |
430 | case TRACKDB_CAN_UPGRADE: | |
431 | /* This database needs upgrading */ | |
f2218e3c RK |
432 | info("invoking disorder-dbupgrade to upgrade from %ld to %ld", |
433 | oldversion, config->dbversion); | |
ffac51d7 | 434 | pid = subprogram(0, -1, "disorder-dbupgrade", (char *)0); |
f2218e3c RK |
435 | while(waitpid(pid, &err, 0) == -1 && errno == EINTR) |
436 | ; | |
437 | if(err) | |
438 | fatal(0, "disorder-dbupgrade %s", wstat(err)); | |
439 | info("disorder-dbupgrade succeeded"); | |
440 | break; | |
d25c4615 RK |
441 | case TRACKDB_OPEN_FOR_UPGRADE: |
442 | break; | |
443 | default: | |
444 | abort(); | |
445 | } | |
f9635e06 | 446 | } |
d25c4615 | 447 | if(oldversion == config->dbversion && (flags & TRACKDB_OPEN_FOR_UPGRADE)) { |
3dc3d7db RK |
448 | /* This doesn't make any sense */ |
449 | fatal(0, "database is already at current version"); | |
450 | } | |
f982b120 | 451 | trackdb_existing_database = 1; |
f9635e06 | 452 | } else { |
d25c4615 | 453 | if(flags & TRACKDB_OPEN_FOR_UPGRADE) { |
3dc3d7db RK |
454 | /* Cannot upgrade a new database */ |
455 | fatal(0, "cannot upgrade a database that does not exist"); | |
456 | } | |
f9635e06 | 457 | /* This is a brand new database */ |
f982b120 | 458 | trackdb_existing_database = 0; |
f9635e06 | 459 | } |
460b9539 | 460 | /* open the databases */ |
0934814d RK |
461 | if(!(trackdb_usersdb = open_db("users.db", |
462 | 0, DB_HASH, dbflags, 0600))) | |
463 | fatal(0, "cannot open users.db"); | |
460b9539 | 464 | trackdb_tracksdb = open_db("tracks.db", |
f0feb22e | 465 | DB_RECNUM, DB_BTREE, dbflags, 0666); |
460b9539 | 466 | trackdb_searchdb = open_db("search.db", |
f0feb22e | 467 | DB_DUP|DB_DUPSORT, DB_HASH, dbflags, 0666); |
460b9539 | 468 | trackdb_tagsdb = open_db("tags.db", |
f0feb22e RK |
469 | DB_DUP|DB_DUPSORT, DB_HASH, dbflags, 0666); |
470 | trackdb_prefsdb = open_db("prefs.db", 0, DB_HASH, dbflags, 0666); | |
471 | trackdb_globaldb = open_db("global.db", 0, DB_HASH, dbflags, 0666); | |
2a10b70b | 472 | trackdb_noticeddb = open_db("noticed.db", |
f0feb22e | 473 | DB_DUPSORT, DB_BTREE, dbflags, 0666); |
fdca70ee | 474 | trackdb_scheduledb = open_db("schedule.db", 0, DB_HASH, dbflags, 0666); |
f982b120 | 475 | if(!trackdb_existing_database) { |
3dc3d7db | 476 | /* Stash the database version */ |
8818b7fc RK |
477 | char buf[32]; |
478 | ||
d25c4615 | 479 | assert(!(flags & TRACKDB_OPEN_FOR_UPGRADE)); |
8818b7fc RK |
480 | snprintf(buf, sizeof buf, "%ld", config->dbversion); |
481 | trackdb_set_global("_dbversion", buf, 0); | |
482 | } | |
460b9539 | 483 | D(("opened databases")); |
484 | } | |
485 | ||
486 | /* close track databases */ | |
487 | void trackdb_close(void) { | |
488 | int err; | |
f0feb22e | 489 | |
460b9539 | 490 | /* sanity checks */ |
491 | assert(opened == 1); | |
492 | --opened; | |
958a9462 RK |
493 | #define CLOSE(N, V) do { \ |
494 | if(V && (err = V->close(V, 0))) \ | |
495 | fatal(0, "error closing %s: %s", N, db_strerror(err)); \ | |
496 | V = 0; \ | |
497 | } while(0) | |
498 | CLOSE("tracks.db", trackdb_tracksdb); | |
499 | CLOSE("search.db", trackdb_searchdb); | |
500 | CLOSE("tags.db", trackdb_tagsdb); | |
501 | CLOSE("prefs.db", trackdb_prefsdb); | |
502 | CLOSE("global.db", trackdb_globaldb); | |
503 | CLOSE("noticed.db", trackdb_noticeddb); | |
504 | CLOSE("schedule.db", trackdb_scheduledb); | |
505 | CLOSE("users.db", trackdb_usersdb); | |
460b9539 | 506 | D(("closed databases")); |
507 | } | |
508 | ||
509 | /* generic db routines *******************************************************/ | |
510 | ||
053a839e RK |
511 | /** @brief Fetch and decode a database entry |
512 | * @param db Database | |
513 | * @param track Track name | |
514 | * @param kp Where to put decoded list (or NULL if you don't care) | |
515 | * @param tid Owning transaction | |
516 | * @return 0, @c DB_NOTFOUND or @c DB_LOCK_DEADLOCK | |
517 | */ | |
460b9539 | 518 | int trackdb_getdata(DB *db, |
519 | const char *track, | |
520 | struct kvp **kp, | |
521 | DB_TXN *tid) { | |
522 | int err; | |
523 | DBT key, data; | |
524 | ||
525 | switch(err = db->get(db, tid, make_key(&key, track), | |
526 | prepare_data(&data), 0)) { | |
527 | case 0: | |
053a839e RK |
528 | if(kp) |
529 | *kp = kvp_urldecode(data.data, data.size); | |
460b9539 | 530 | return 0; |
531 | case DB_NOTFOUND: | |
053a839e RK |
532 | if(kp) |
533 | *kp = 0; | |
460b9539 | 534 | return err; |
535 | case DB_LOCK_DEADLOCK: | |
536 | error(0, "error querying database: %s", db_strerror(err)); | |
537 | return err; | |
538 | default: | |
539 | fatal(0, "error querying database: %s", db_strerror(err)); | |
540 | } | |
541 | } | |
542 | ||
543 | /* encode and store a database entry. Returns 0, DB_KEYEXIST or | |
544 | * DB_LOCK_DEADLOCK. */ | |
545 | int trackdb_putdata(DB *db, | |
546 | const char *track, | |
547 | const struct kvp *k, | |
548 | DB_TXN *tid, | |
549 | u_int32_t flags) { | |
550 | int err; | |
551 | DBT key, data; | |
552 | ||
553 | switch(err = db->put(db, tid, make_key(&key, track), | |
554 | encode_data(&data, k), flags)) { | |
555 | case 0: | |
556 | case DB_KEYEXIST: | |
557 | return err; | |
558 | case DB_LOCK_DEADLOCK: | |
559 | error(0, "error updating database: %s", db_strerror(err)); | |
560 | return err; | |
561 | default: | |
562 | fatal(0, "error updating database: %s", db_strerror(err)); | |
563 | } | |
564 | } | |
565 | ||
f0feb22e RK |
566 | /** @brief Delete a database entry |
567 | * @param db Database | |
568 | * @param track Key to delete | |
569 | * @param tid Transaction ID | |
570 | * @return 0, DB_NOTFOUND or DB_LOCK_DEADLOCK | |
571 | */ | |
460b9539 | 572 | int trackdb_delkey(DB *db, |
573 | const char *track, | |
574 | DB_TXN *tid) { | |
575 | int err; | |
576 | ||
577 | DBT key; | |
578 | switch(err = db->del(db, tid, make_key(&key, track), 0)) { | |
579 | case 0: | |
580 | case DB_NOTFOUND: | |
581 | return 0; | |
582 | case DB_LOCK_DEADLOCK: | |
583 | error(0, "error updating database: %s", db_strerror(err)); | |
584 | return err; | |
585 | default: | |
586 | fatal(0, "error updating database: %s", db_strerror(err)); | |
587 | } | |
588 | } | |
589 | ||
590 | /* open a database cursor */ | |
591 | DBC *trackdb_opencursor(DB *db, DB_TXN *tid) { | |
592 | int err; | |
593 | DBC *c; | |
594 | ||
595 | switch(err = db->cursor(db, tid, &c, 0)) { | |
596 | case 0: break; | |
597 | default: fatal(0, "error creating cursor: %s", db_strerror(err)); | |
598 | } | |
599 | return c; | |
600 | } | |
601 | ||
602 | /* close a database cursor; returns 0 or DB_LOCK_DEADLOCK */ | |
603 | int trackdb_closecursor(DBC *c) { | |
604 | int err; | |
605 | ||
606 | if(!c) return 0; | |
607 | switch(err = c->c_close(c)) { | |
608 | case 0: | |
609 | return err; | |
610 | case DB_LOCK_DEADLOCK: | |
611 | error(0, "error closing cursor: %s", db_strerror(err)); | |
612 | return err; | |
613 | default: | |
614 | fatal(0, "error closing cursor: %s", db_strerror(err)); | |
615 | } | |
616 | } | |
617 | ||
618 | /* delete a (key,data) pair. Returns 0, DB_NOTFOUND or DB_LOCK_DEADLOCK. */ | |
619 | int trackdb_delkeydata(DB *db, | |
620 | const char *word, | |
621 | const char *track, | |
622 | DB_TXN *tid) { | |
623 | int err; | |
624 | DBC *c; | |
625 | DBT key, data; | |
626 | ||
627 | c = trackdb_opencursor(db, tid); | |
628 | switch(err = c->c_get(c, make_key(&key, word), | |
629 | make_key(&data, track), DB_GET_BOTH)) { | |
630 | case 0: | |
631 | switch(err = c->c_del(c, 0)) { | |
632 | case 0: | |
633 | break; | |
634 | case DB_KEYEMPTY: | |
635 | err = 0; | |
636 | break; | |
637 | case DB_LOCK_DEADLOCK: | |
638 | error(0, "error updating database: %s", db_strerror(err)); | |
639 | break; | |
640 | default: | |
641 | fatal(0, "c->c_del: %s", db_strerror(err)); | |
642 | } | |
643 | break; | |
644 | case DB_NOTFOUND: | |
645 | break; | |
646 | case DB_LOCK_DEADLOCK: | |
647 | error(0, "error updating database: %s", db_strerror(err)); | |
648 | break; | |
649 | default: | |
650 | fatal(0, "c->c_get: %s", db_strerror(err)); | |
651 | } | |
652 | if(trackdb_closecursor(c)) err = DB_LOCK_DEADLOCK; | |
653 | return err; | |
654 | } | |
655 | ||
656 | /* start a transaction */ | |
657 | DB_TXN *trackdb_begin_transaction(void) { | |
658 | DB_TXN *tid; | |
659 | int err; | |
660 | ||
661 | if((err = trackdb_env->txn_begin(trackdb_env, 0, &tid, 0))) | |
662 | fatal(0, "trackdb_env->txn_begin: %s", db_strerror(err)); | |
663 | return tid; | |
664 | } | |
665 | ||
666 | /* abort transaction */ | |
667 | void trackdb_abort_transaction(DB_TXN *tid) { | |
668 | int err; | |
669 | ||
670 | if(tid) | |
671 | if((err = tid->abort(tid))) | |
672 | fatal(0, "tid->abort: %s", db_strerror(err)); | |
673 | } | |
674 | ||
675 | /* commit transaction */ | |
676 | void trackdb_commit_transaction(DB_TXN *tid) { | |
677 | int err; | |
678 | ||
679 | if((err = tid->commit(tid, 0))) | |
680 | fatal(0, "tid->commit: %s", db_strerror(err)); | |
681 | } | |
682 | ||
683 | /* search/tags shared code ***************************************************/ | |
684 | ||
685 | /* comparison function used by dedupe() */ | |
686 | static int wordcmp(const void *a, const void *b) { | |
687 | return strcmp(*(const char **)a, *(const char **)b); | |
688 | } | |
689 | ||
690 | /* sort and de-dupe VEC */ | |
691 | static char **dedupe(char **vec, int nvec) { | |
692 | int m, n; | |
693 | ||
694 | qsort(vec, nvec, sizeof (char *), wordcmp); | |
695 | m = n = 0; | |
696 | if(nvec) { | |
697 | vec[m++] = vec[0]; | |
698 | for(n = 1; n < nvec; ++n) | |
699 | if(strcmp(vec[n], vec[m - 1])) | |
700 | vec[m++] = vec[n]; | |
701 | } | |
702 | vec[m] = 0; | |
703 | return vec; | |
704 | } | |
705 | ||
706 | /* update a key/track database. Returns 0 or DB_DEADLOCK. */ | |
707 | static int register_word(DB *db, const char *what, | |
708 | const char *track, const char *word, | |
709 | DB_TXN *tid) { | |
710 | int err; | |
711 | DBT key, data; | |
712 | ||
713 | switch(err = db->put(db, tid, make_key(&key, word), | |
714 | make_key(&data, track), DB_NODUPDATA)) { | |
715 | case 0: | |
716 | case DB_KEYEXIST: | |
717 | return 0; | |
718 | case DB_LOCK_DEADLOCK: | |
719 | error(0, "error updating %s.db: %s", what, db_strerror(err)); | |
720 | return err; | |
721 | default: | |
722 | fatal(0, "error updating %s.db: %s", what, db_strerror(err)); | |
723 | } | |
724 | } | |
725 | ||
726 | /* search primitives *********************************************************/ | |
727 | ||
728 | /* return true iff NAME is a trackname_display_ pref */ | |
729 | static int is_display_pref(const char *name) { | |
730 | static const char prefix[] = "trackname_display_"; | |
731 | return !strncmp(name, prefix, (sizeof prefix) - 1); | |
732 | } | |
733 | ||
c85b7022 RK |
734 | /** @brief Word_Break property tailor that treats underscores as spaces */ |
735 | static int tailor_underscore_Word_Break_Other(uint32_t c) { | |
736 | switch(c) { | |
737 | default: | |
738 | return -1; | |
739 | case 0x005F: /* LOW LINE (SPACING UNDERSCORE) */ | |
740 | return unicode_Word_Break_Other; | |
741 | } | |
742 | } | |
743 | ||
3c82b504 RK |
744 | /** @brief Remove all combining characters in-place |
745 | * @param s Pointer to start of string | |
746 | * @param ns Length of string | |
747 | * @return New, possiblby reduced, length | |
748 | */ | |
749 | static size_t remove_combining_chars(uint32_t *s, size_t ns) { | |
750 | uint32_t *start = s, *t = s, *end = s + ns; | |
751 | ||
752 | while(s < end) { | |
753 | const uint32_t c = *s++; | |
754 | if(!utf32_combining_class(c)) | |
755 | *t++ = c; | |
756 | } | |
757 | return t - start; | |
758 | } | |
759 | ||
c85b7022 RK |
760 | /** @brief Normalize and split a string using a given tailoring */ |
761 | static void word_split(struct vector *v, | |
762 | const char *s, | |
763 | unicode_property_tailor *pt) { | |
764 | size_t nw, nt32, i; | |
765 | uint32_t *t32, **w32; | |
766 | ||
767 | /* Convert to UTF-32 */ | |
768 | if(!(t32 = utf8_to_utf32(s, strlen(s), &nt32))) | |
769 | return; | |
770 | /* Erase case distinctions */ | |
771 | if(!(t32 = utf32_casefold_compat(t32, nt32, &nt32))) | |
772 | return; | |
3c82b504 RK |
773 | /* Drop combining characters */ |
774 | nt32 = remove_combining_chars(t32, nt32); | |
c85b7022 RK |
775 | /* Split into words, treating _ as a space */ |
776 | w32 = utf32_word_split(t32, nt32, &nw, pt); | |
777 | /* Convert words back to UTF-8 and append to result */ | |
778 | for(i = 0; i < nw; ++i) | |
779 | vector_append(v, utf32_to_utf8(w32[i], utf32_len(w32[i]), 0)); | |
780 | } | |
781 | ||
a3777123 RK |
782 | /** @brief Normalize a tag |
783 | * @param s Tag | |
784 | * @param ns Length of tag | |
785 | * @return Normalized string or NULL on error | |
786 | * | |
787 | * The return value will be: | |
788 | * - case-folded | |
789 | * - have no leading or trailing space | |
790 | * - have no combining characters | |
791 | * - all spacing between words will be a single U+0020 SPACE | |
792 | */ | |
793 | static char *normalize_tag(const char *s, size_t ns) { | |
794 | uint32_t *s32, **w32; | |
795 | size_t ns32, nw32, i; | |
796 | struct dynstr d[1]; | |
797 | ||
798 | if(!(s32 = utf8_to_utf32(s, ns, &ns32))) | |
799 | return 0; | |
800 | if(!(s32 = utf32_casefold_compat(s32, ns32, &ns32))) /* ->NFKD */ | |
801 | return 0; | |
802 | ns32 = remove_combining_chars(s32, ns32); | |
803 | /* Split into words, no Word_Break tailoring */ | |
804 | w32 = utf32_word_split(s32, ns32, &nw32, 0); | |
805 | /* Compose back into a string */ | |
806 | dynstr_init(d); | |
807 | for(i = 0; i < nw32; ++i) { | |
808 | if(i) | |
809 | dynstr_append(d, ' '); | |
810 | dynstr_append_string(d, utf32_to_utf8(w32[i], utf32_len(w32[i]), 0)); | |
811 | } | |
812 | dynstr_terminate(d); | |
813 | return d->vec; | |
814 | } | |
815 | ||
460b9539 | 816 | /* compute the words of a track name */ |
817 | static char **track_to_words(const char *track, | |
818 | const struct kvp *p) { | |
819 | struct vector v; | |
a8747834 | 820 | const char *rootless = track_rootless(track); |
460b9539 | 821 | |
a8747834 | 822 | if(!rootless) |
823 | rootless = track; /* bodge */ | |
460b9539 | 824 | vector_init(&v); |
c85b7022 RK |
825 | rootless = strip_extension(rootless); |
826 | word_split(&v, strip_extension(rootless), tailor_underscore_Word_Break_Other); | |
460b9539 | 827 | for(; p; p = p->next) |
828 | if(is_display_pref(p->name)) | |
c85b7022 | 829 | word_split(&v, p->value, 0); |
460b9539 | 830 | vector_terminate(&v); |
831 | return dedupe(v.vec, v.nvec); | |
832 | } | |
833 | ||
834 | /* return nonzero iff WORD is a stopword */ | |
835 | static int stopword(const char *word) { | |
836 | int n; | |
837 | ||
838 | for(n = 0; n < config->stopword.n | |
839 | && strcmp(word, config->stopword.s[n]); ++n) | |
840 | ; | |
841 | return n < config->stopword.n; | |
842 | } | |
843 | ||
844 | /* record that WORD appears in TRACK. Returns 0 or DB_LOCK_DEADLOCK. */ | |
845 | static int register_search_word(const char *track, const char *word, | |
846 | DB_TXN *tid) { | |
847 | if(stopword(word)) return 0; | |
848 | return register_word(trackdb_searchdb, "search", track, word, tid); | |
849 | } | |
850 | ||
851 | /* Tags **********************************************************************/ | |
852 | ||
853 | /* Return nonzero if C is a valid tag character */ | |
854 | static int tagchar(int c) { | |
855 | switch(c) { | |
856 | case ',': | |
857 | return 0; | |
858 | default: | |
859 | return c >= ' '; | |
860 | } | |
861 | } | |
862 | ||
863 | /* Parse and de-dupe a tag list. If S=0 then assumes "". */ | |
91c9324a | 864 | char **parsetags(const char *s) { |
460b9539 | 865 | const char *t; |
866 | struct vector v; | |
867 | ||
868 | vector_init(&v); | |
869 | if(s) { | |
870 | /* skip initial separators */ | |
871 | while(*s && (!tagchar(*s) || *s == ' ')) | |
872 | ++s; | |
873 | while(*s) { | |
874 | /* find the extent of the tag */ | |
875 | t = s; | |
876 | while(*s && tagchar(*s)) | |
877 | ++s; | |
878 | /* strip trailing spaces */ | |
879 | while(s > t && s[-1] == ' ') | |
880 | --s; | |
a3777123 RK |
881 | /* add tag to list */ |
882 | vector_append(&v, normalize_tag(t, (size_t)(s - t))); | |
460b9539 | 883 | /* skip intermediate and trailing separators */ |
884 | while(*s && (!tagchar(*s) || *s == ' ')) | |
885 | ++s; | |
886 | } | |
887 | } | |
888 | vector_terminate(&v); | |
889 | return dedupe(v.vec, v.nvec); | |
890 | } | |
891 | ||
892 | /* Record that TRACK has TAG. Returns 0 or DB_LOCK_DEADLOCK. */ | |
893 | static int register_tag(const char *track, const char *tag, DB_TXN *tid) { | |
894 | return register_word(trackdb_tagsdb, "tags", track, tag, tid); | |
895 | } | |
896 | ||
897 | /* aliases *******************************************************************/ | |
898 | ||
899 | /* compute the alias and store at aliasp. Returns 0 or DB_LOCK_DEADLOCK. If | |
900 | * there is no alias sets *aliasp to 0. */ | |
901 | static int compute_alias(char **aliasp, | |
902 | const char *track, | |
903 | const struct kvp *p, | |
904 | DB_TXN *tid) { | |
905 | struct dynstr d; | |
906 | const char *s = config->alias, *t, *expansion, *part; | |
907 | int c, used_db = 0, slash_prefix, err; | |
908 | struct kvp *at; | |
137e36ed | 909 | const char *const root = find_track_root(track); |
460b9539 | 910 | |
137e36ed | 911 | if(!root) { |
912 | /* Bodge for tracks with no root */ | |
913 | *aliasp = 0; | |
914 | return 0; | |
915 | } | |
460b9539 | 916 | dynstr_init(&d); |
137e36ed | 917 | dynstr_append_string(&d, root); |
460b9539 | 918 | while((c = (unsigned char)*s++)) { |
919 | if(c != '{') { | |
920 | dynstr_append(&d, c); | |
921 | continue; | |
922 | } | |
923 | if((slash_prefix = (*s == '/'))) | |
924 | s++; | |
925 | t = strchr(s, '}'); | |
926 | assert(t != 0); /* validated at startup */ | |
927 | part = xstrndup(s, t - s); | |
928 | expansion = getpart(track, "display", part, p, &used_db); | |
929 | if(*expansion) { | |
930 | if(slash_prefix) dynstr_append(&d, '/'); | |
931 | dynstr_append_string(&d, expansion); | |
932 | } | |
933 | s = t + 1; /* skip {part} */ | |
934 | } | |
935 | /* only admit to the alias if we used the db... */ | |
936 | if(!used_db) { | |
937 | *aliasp = 0; | |
938 | return 0; | |
939 | } | |
940 | dynstr_terminate(&d); | |
941 | /* ...and the answer differs from the original... */ | |
942 | if(!strcmp(track, d.vec)) { | |
943 | *aliasp = 0; | |
944 | return 0; | |
945 | } | |
946 | /* ...and there isn't already a different track with that name (including as | |
947 | * an alias) */ | |
948 | switch(err = trackdb_getdata(trackdb_tracksdb, d.vec, &at, tid)) { | |
949 | case 0: | |
460b9539 | 950 | if((s = kvp_get(at, "_alias_for")) |
951 | && !strcmp(s, track)) { | |
952 | case DB_NOTFOUND: | |
460b9539 | 953 | *aliasp = d.vec; |
954 | } else { | |
460b9539 | 955 | *aliasp = 0; |
956 | } | |
957 | return 0; | |
958 | default: | |
959 | return err; | |
960 | } | |
961 | } | |
962 | ||
963 | /* get track and prefs data (if tp/pp not null pointers). Returns 0 on | |
964 | * success, DB_NOTFOUND if the track does not exist or DB_LOCK_DEADLOCK. | |
965 | * Always sets the return values, even if only to null pointers. */ | |
966 | static int gettrackdata(const char *track, | |
967 | struct kvp **tp, | |
968 | struct kvp **pp, | |
969 | const char **actualp, | |
970 | unsigned flags, | |
971 | #define GTD_NOALIAS 0x0001 | |
972 | DB_TXN *tid) { | |
973 | int err; | |
974 | const char *actual = track; | |
975 | struct kvp *t = 0, *p = 0; | |
f0feb22e | 976 | |
460b9539 | 977 | if((err = trackdb_getdata(trackdb_tracksdb, track, &t, tid))) goto done; |
978 | if((actual = kvp_get(t, "_alias_for"))) { | |
979 | if(flags & GTD_NOALIAS) { | |
980 | error(0, "alias passed to gettrackdata where real path required"); | |
981 | abort(); | |
982 | } | |
983 | if((err = trackdb_getdata(trackdb_tracksdb, actual, &t, tid))) goto done; | |
984 | } else | |
985 | actual = track; | |
986 | assert(actual != 0); | |
987 | if(pp) { | |
988 | if((err = trackdb_getdata(trackdb_prefsdb, actual, &p, tid)) == DB_LOCK_DEADLOCK) | |
989 | goto done; | |
990 | } | |
991 | err = 0; | |
992 | done: | |
993 | if(actualp) *actualp = actual; | |
994 | if(tp) *tp = t; | |
995 | if(pp) *pp = p; | |
996 | return err; | |
997 | } | |
998 | ||
999 | /* trackdb_notice() **********************************************************/ | |
1000 | ||
6c81eef9 | 1001 | /** @brief notice a possibly new track |
2a10b70b RK |
1002 | * @return @c DB_NOTFOUND if new, 0 if already known |
1003 | */ | |
460b9539 | 1004 | int trackdb_notice(const char *track, |
1005 | const char *path) { | |
1006 | int err; | |
1007 | DB_TXN *tid; | |
f0feb22e | 1008 | |
460b9539 | 1009 | for(;;) { |
1010 | tid = trackdb_begin_transaction(); | |
1011 | err = trackdb_notice_tid(track, path, tid); | |
1012 | if((err == DB_LOCK_DEADLOCK)) goto fail; | |
1013 | break; | |
1014 | fail: | |
1015 | trackdb_abort_transaction(tid); | |
1016 | } | |
1017 | trackdb_commit_transaction(tid); | |
1018 | return err; | |
1019 | } | |
1020 | ||
6c81eef9 | 1021 | /** @brief notice a possibly new track |
f9635e06 RK |
1022 | * @param track NFC UTF-8 track name |
1023 | * @param path Raw path name | |
1024 | * @param tid Transaction ID | |
2a10b70b RK |
1025 | * @return @c DB_NOTFOUND if new, 0 if already known, @c DB_LOCK_DEADLOCK also |
1026 | */ | |
460b9539 | 1027 | int trackdb_notice_tid(const char *track, |
1028 | const char *path, | |
1029 | DB_TXN *tid) { | |
1030 | int err, n; | |
1031 | struct kvp *t, *a, *p; | |
1032 | int t_changed, ret; | |
343c64f2 RK |
1033 | char *alias, **w, *noticed; |
1034 | time_t now; | |
2a10b70b | 1035 | |
460b9539 | 1036 | /* notice whether the tracks.db entry changes */ |
1037 | t_changed = 0; | |
1038 | /* get any existing tracks entry */ | |
1039 | if((err = gettrackdata(track, &t, &p, 0, 0, tid)) == DB_LOCK_DEADLOCK) | |
1040 | return err; | |
2a10b70b | 1041 | ret = err; /* 0 or DB_NOTFOUND */ |
460b9539 | 1042 | /* this is a real track */ |
1043 | t_changed += kvp_set(&t, "_alias_for", 0); | |
1044 | t_changed += kvp_set(&t, "_path", path); | |
343c64f2 RK |
1045 | time(&now); |
1046 | if(ret == DB_NOTFOUND) { | |
1047 | /* It's a new track; record the time */ | |
1048 | byte_xasprintf(¬iced, "%lld", (long long)now); | |
1049 | t_changed += kvp_set(&t, "_noticed", noticed); | |
1050 | } | |
460b9539 | 1051 | /* if we have an alias record it in the database */ |
1052 | if((err = compute_alias(&alias, track, p, tid))) return err; | |
1053 | if(alias) { | |
1054 | /* won't overwrite someone else's alias as compute_alias() checks */ | |
1055 | D(("%s: alias %s", track, alias)); | |
1056 | a = 0; | |
1057 | kvp_set(&a, "_alias_for", track); | |
1058 | if((err = trackdb_putdata(trackdb_tracksdb, alias, a, tid, 0))) return err; | |
1059 | } | |
1060 | /* update search.db */ | |
1061 | w = track_to_words(track, p); | |
1062 | for(n = 0; w[n]; ++n) | |
1063 | if((err = register_search_word(track, w[n], tid))) | |
1064 | return err; | |
1065 | /* update tags.db */ | |
1066 | w = parsetags(kvp_get(p, "tags")); | |
1067 | for(n = 0; w[n]; ++n) | |
1068 | if((err = register_tag(track, w[n], tid))) | |
1069 | return err; | |
460b9539 | 1070 | /* only store the tracks.db entry if it has changed */ |
1071 | if(t_changed && (err = trackdb_putdata(trackdb_tracksdb, track, t, tid, 0))) | |
1072 | return err; | |
2a10b70b RK |
1073 | if(ret == DB_NOTFOUND) { |
1074 | uint32_t timestamp[2]; | |
2a10b70b RK |
1075 | DBT key, data; |
1076 | ||
2a10b70b RK |
1077 | timestamp[0] = htonl((uint64_t)now >> 32); |
1078 | timestamp[1] = htonl((uint32_t)now); | |
1079 | memset(&key, 0, sizeof key); | |
1080 | key.data = timestamp; | |
1081 | key.size = sizeof timestamp; | |
1082 | switch(err = trackdb_noticeddb->put(trackdb_noticeddb, tid, &key, | |
1083 | make_key(&data, track), 0)) { | |
1084 | case 0: break; | |
1085 | case DB_LOCK_DEADLOCK: return err; | |
1086 | default: fatal(0, "error updating noticed.db: %s", db_strerror(err)); | |
1087 | } | |
1088 | } | |
460b9539 | 1089 | return ret; |
1090 | } | |
1091 | ||
1092 | /* trackdb_obsolete() ********************************************************/ | |
1093 | ||
1094 | /* obsolete a track */ | |
1095 | int trackdb_obsolete(const char *track, DB_TXN *tid) { | |
1096 | int err, n; | |
1097 | struct kvp *p; | |
1098 | char *alias, **w; | |
1099 | ||
1100 | if((err = gettrackdata(track, 0, &p, 0, | |
1101 | GTD_NOALIAS, tid)) == DB_LOCK_DEADLOCK) | |
1102 | return err; | |
1103 | else if(err == DB_NOTFOUND) return 0; | |
1104 | /* compute the alias, if any, and delete it */ | |
f0feb22e | 1105 | if((err = compute_alias(&alias, track, p, tid))) return err; |
460b9539 | 1106 | if(alias) { |
1107 | /* if the alias points to some other track then compute_alias won't | |
1108 | * return it */ | |
f0feb22e RK |
1109 | if((err = trackdb_delkey(trackdb_tracksdb, alias, tid)) |
1110 | && err != DB_NOTFOUND) | |
460b9539 | 1111 | return err; |
1112 | } | |
1113 | /* update search.db */ | |
1114 | w = track_to_words(track, p); | |
1115 | for(n = 0; w[n]; ++n) | |
1116 | if(trackdb_delkeydata(trackdb_searchdb, | |
1117 | w[n], track, tid) == DB_LOCK_DEADLOCK) | |
1118 | return err; | |
1119 | /* update tags.db */ | |
1120 | w = parsetags(kvp_get(p, "tags")); | |
1121 | for(n = 0; w[n]; ++n) | |
1122 | if(trackdb_delkeydata(trackdb_tagsdb, | |
1123 | w[n], track, tid) == DB_LOCK_DEADLOCK) | |
1124 | return err; | |
460b9539 | 1125 | /* update tracks.db */ |
1126 | if(trackdb_delkey(trackdb_tracksdb, track, tid) == DB_LOCK_DEADLOCK) | |
1127 | return err; | |
1128 | /* We don't delete the prefs, so they survive temporary outages of the | |
1129 | * (possibly virtual) track filesystem */ | |
1130 | return 0; | |
1131 | } | |
1132 | ||
1133 | /* trackdb_stats() ***********************************************************/ | |
1134 | ||
1135 | #define H(name) { #name, offsetof(DB_HASH_STAT, name) } | |
1136 | #define B(name) { #name, offsetof(DB_BTREE_STAT, name) } | |
1137 | ||
1138 | static const struct statinfo { | |
1139 | const char *name; | |
1140 | size_t offset; | |
1141 | } statinfo_hash[] = { | |
1142 | H(hash_magic), | |
1143 | H(hash_version), | |
1144 | H(hash_nkeys), | |
1145 | H(hash_ndata), | |
1146 | H(hash_pagesize), | |
1147 | H(hash_ffactor), | |
1148 | H(hash_buckets), | |
1149 | H(hash_free), | |
1150 | H(hash_bfree), | |
1151 | H(hash_bigpages), | |
1152 | H(hash_big_bfree), | |
1153 | H(hash_overflows), | |
1154 | H(hash_ovfl_free), | |
1155 | H(hash_dup), | |
1156 | H(hash_dup_free), | |
1157 | }, statinfo_btree[] = { | |
1158 | B(bt_magic), | |
1159 | B(bt_version), | |
1160 | B(bt_nkeys), | |
1161 | B(bt_ndata), | |
1162 | B(bt_pagesize), | |
1163 | B(bt_minkey), | |
1164 | B(bt_re_len), | |
1165 | B(bt_re_pad), | |
1166 | B(bt_levels), | |
1167 | B(bt_int_pg), | |
1168 | B(bt_leaf_pg), | |
1169 | B(bt_dup_pg), | |
1170 | B(bt_over_pg), | |
1171 | B(bt_free), | |
1172 | B(bt_int_pgfree), | |
1173 | B(bt_leaf_pgfree), | |
1174 | B(bt_dup_pgfree), | |
1175 | B(bt_over_pgfree), | |
1176 | }; | |
1177 | ||
1178 | /* look up stats for DB */ | |
1179 | static int get_stats(struct vector *v, | |
1180 | DB *database, | |
1181 | const struct statinfo *si, | |
1182 | size_t nsi, | |
1183 | DB_TXN *tid) { | |
1184 | void *sp; | |
1185 | size_t n; | |
1186 | char *str; | |
1187 | int err; | |
1188 | ||
1189 | if(database) { | |
1190 | switch(err = database->stat(database, tid, &sp, 0)) { | |
1191 | case 0: | |
1192 | break; | |
1193 | case DB_LOCK_DEADLOCK: | |
1194 | error(0, "error querying database: %s", db_strerror(err)); | |
1195 | return err; | |
1196 | default: | |
1197 | fatal(0, "error querying database: %s", db_strerror(err)); | |
1198 | } | |
1199 | for(n = 0; n < nsi; ++n) { | |
1200 | byte_xasprintf(&str, "%s=%"PRIuMAX, si[n].name, | |
1201 | (uintmax_t)*(u_int32_t *)((char *)sp + si[n].offset)); | |
1202 | vector_append(v, str); | |
1203 | } | |
1204 | } | |
1205 | return 0; | |
1206 | } | |
1207 | ||
ff76b21b | 1208 | /** @brief One entry in the search league */ |
460b9539 | 1209 | struct search_entry { |
1210 | char *word; | |
1211 | int n; | |
1212 | }; | |
1213 | ||
ff76b21b RK |
1214 | /** @brief Add a word to the search league |
1215 | * @param se Pointer to search league | |
1216 | * @param count Maximum size for search league | |
1217 | * @param nse Current size of search league | |
1218 | * @param word New word, or NULL | |
1219 | * @param n How often @p word appears | |
1220 | * @return New size of search league | |
1221 | */ | |
1222 | static int register_search_entry(struct search_entry *se, | |
1223 | int count, | |
1224 | int nse, | |
1225 | char *word, | |
1226 | int n) { | |
1227 | int i; | |
1228 | ||
1229 | if(word && (nse < count || n > se[nse - 1].n)) { | |
1230 | /* Find the starting point */ | |
1231 | if(nse == count) | |
1232 | i = nse - 1; | |
1233 | else | |
1234 | i = nse++; | |
1235 | /* Find the insertion point */ | |
1236 | while(i > 0 && n > se[i - 1].n) | |
1237 | --i; | |
1238 | memmove(&se[i + 1], &se[i], (nse - i - 1) * sizeof *se); | |
1239 | se[i].word = word; | |
1240 | se[i].n = n; | |
1241 | } | |
1242 | return nse; | |
1243 | } | |
1244 | ||
460b9539 | 1245 | /* find the top COUNT words in the search database */ |
1246 | static int search_league(struct vector *v, int count, DB_TXN *tid) { | |
1247 | struct search_entry *se; | |
1248 | DBT k, d; | |
1249 | DBC *cursor; | |
1250 | int err, n = 0, nse = 0, i; | |
1251 | char *word = 0; | |
1252 | size_t wl = 0; | |
1253 | char *str; | |
1254 | ||
1255 | cursor = trackdb_opencursor(trackdb_searchdb, tid); | |
1256 | se = xmalloc(count * sizeof *se); | |
ff76b21b RK |
1257 | /* Walk across the whole database counting up the number of times each |
1258 | * word appears. */ | |
460b9539 | 1259 | while(!(err = cursor->c_get(cursor, prepare_data(&k), prepare_data(&d), |
1260 | DB_NEXT))) { | |
1261 | if(word && wl == k.size && !strncmp(word, k.data, wl)) | |
ff76b21b | 1262 | ++n; /* same word again */ |
460b9539 | 1263 | else { |
ff76b21b | 1264 | nse = register_search_entry(se, count, nse, word, n); |
460b9539 | 1265 | word = xstrndup(k.data, wl = k.size); |
1266 | n = 1; | |
1267 | } | |
1268 | } | |
1269 | switch(err) { | |
1270 | case DB_NOTFOUND: | |
1271 | err = 0; | |
1272 | break; | |
1273 | case DB_LOCK_DEADLOCK: | |
1274 | error(0, "error querying search database: %s", db_strerror(err)); | |
1275 | break; | |
1276 | default: | |
1277 | fatal(0, "error querying search database: %s", db_strerror(err)); | |
1278 | } | |
1279 | if(trackdb_closecursor(cursor)) err = DB_LOCK_DEADLOCK; | |
1280 | if(err) return err; | |
ff76b21b | 1281 | nse = register_search_entry(se, count, nse, word, n); |
460b9539 | 1282 | byte_xasprintf(&str, "Top %d search words:", nse); |
1283 | vector_append(v, str); | |
1284 | for(i = 0; i < nse; ++i) { | |
1285 | byte_xasprintf(&str, "%4d: %5d %s", i + 1, se[i].n, se[i].word); | |
1286 | vector_append(v, str); | |
1287 | } | |
1288 | return 0; | |
1289 | } | |
1290 | ||
1291 | #define SI(what) statinfo_##what, \ | |
1292 | sizeof statinfo_##what / sizeof (struct statinfo) | |
1293 | ||
1294 | /* return a list of database stats */ | |
1295 | char **trackdb_stats(int *nstatsp) { | |
1296 | DB_TXN *tid; | |
1297 | struct vector v; | |
f0feb22e | 1298 | |
460b9539 | 1299 | vector_init(&v); |
1300 | for(;;) { | |
1301 | tid = trackdb_begin_transaction(); | |
1302 | v.nvec = 0; | |
1303 | vector_append(&v, (char *)"Tracks database stats:"); | |
1304 | if(get_stats(&v, trackdb_tracksdb, SI(btree), tid)) goto fail; | |
1305 | vector_append(&v, (char *)""); | |
1306 | vector_append(&v, (char *)"Search database stats:"); | |
1307 | if(get_stats(&v, trackdb_searchdb, SI(hash), tid)) goto fail; | |
1308 | vector_append(&v, (char *)""); | |
1309 | vector_append(&v, (char *)"Prefs database stats:"); | |
1310 | if(get_stats(&v, trackdb_prefsdb, SI(hash), tid)) goto fail; | |
1311 | vector_append(&v, (char *)""); | |
1312 | if(search_league(&v, 10, tid)) goto fail; | |
460b9539 | 1313 | vector_terminate(&v); |
1314 | break; | |
1315 | fail: | |
1316 | trackdb_abort_transaction(tid); | |
1317 | } | |
1318 | trackdb_commit_transaction(tid); | |
1319 | if(nstatsp) *nstatsp = v.nvec; | |
1320 | return v.vec; | |
1321 | } | |
1322 | ||
d6dde5a3 RK |
1323 | struct stats_details { |
1324 | void (*done)(char *data, void *u); | |
1325 | void *u; | |
1326 | int exited; /* subprocess exited */ | |
1327 | int closed; /* pipe close */ | |
1328 | int wstat; /* wait status from subprocess */ | |
1329 | struct dynstr data[1]; /* data read from pipe */ | |
1330 | }; | |
1331 | ||
1332 | static void stats_complete(struct stats_details *d) { | |
1333 | char *s; | |
ff76b21b | 1334 | |
d6dde5a3 RK |
1335 | if(!(d->exited && d->closed)) |
1336 | return; | |
1337 | byte_xasprintf(&s, "\n" | |
1338 | "Server stats:\n" | |
1339 | "track lookup cache hits: %lu\n" | |
1340 | "track lookup cache misses: %lu\n", | |
1341 | cache_files_hits, | |
1342 | cache_files_misses); | |
1343 | dynstr_append_string(d->data, s); | |
1344 | dynstr_terminate(d->data); | |
1345 | d->done(d->data->vec, d->u); | |
1346 | } | |
1347 | ||
1348 | static int stats_finished(ev_source attribute((unused)) *ev, | |
1349 | pid_t attribute((unused)) pid, | |
1350 | int status, | |
1351 | const struct rusage attribute((unused)) *rusage, | |
1352 | void *u) { | |
1353 | struct stats_details *const d = u; | |
1354 | ||
1355 | d->exited = 1; | |
1356 | if(status) | |
1357 | error(0, "disorder-stats %s", wstat(status)); | |
1358 | stats_complete(d); | |
1359 | return 0; | |
1360 | } | |
1361 | ||
1362 | static int stats_read(ev_source attribute((unused)) *ev, | |
1363 | ev_reader *reader, | |
d6dde5a3 RK |
1364 | void *ptr, |
1365 | size_t bytes, | |
1366 | int eof, | |
1367 | void *u) { | |
1368 | struct stats_details *const d = u; | |
1369 | ||
1370 | dynstr_append_bytes(d->data, ptr, bytes); | |
1371 | ev_reader_consume(reader, bytes); | |
1372 | if(eof) | |
1373 | d->closed = 1; | |
1374 | stats_complete(d); | |
1375 | return 0; | |
1376 | } | |
1377 | ||
1378 | static int stats_error(ev_source attribute((unused)) *ev, | |
d6dde5a3 RK |
1379 | int errno_value, |
1380 | void *u) { | |
1381 | struct stats_details *const d = u; | |
1382 | ||
1383 | error(errno_value, "error reading from pipe to disorder-stats"); | |
1384 | d->closed = 1; | |
1385 | stats_complete(d); | |
1386 | return 0; | |
1387 | } | |
1388 | ||
1389 | void trackdb_stats_subprocess(ev_source *ev, | |
1390 | void (*done)(char *data, void *u), | |
1391 | void *u) { | |
1392 | int p[2]; | |
1393 | pid_t pid; | |
1394 | struct stats_details *d = xmalloc(sizeof *d); | |
1395 | ||
1396 | dynstr_init(d->data); | |
1397 | d->done = done; | |
1398 | d->u = u; | |
1399 | xpipe(p); | |
ffac51d7 | 1400 | pid = subprogram(ev, p[1], "disorder-stats", (char *)0); |
d6dde5a3 RK |
1401 | xclose(p[1]); |
1402 | ev_child(ev, pid, 0, stats_finished, d); | |
1403 | ev_reader_new(ev, p[0], stats_read, stats_error, d, "disorder-stats reader"); | |
1404 | } | |
1405 | ||
02eaa49d RK |
1406 | /** @brief Parse a track name part preference |
1407 | * @param name Preference name | |
1408 | * @param partp Where to store part name | |
1409 | * @param contextp Where to store context name | |
1410 | * @return 0 on success, non-0 if parse fails | |
1411 | */ | |
1412 | static int trackdb__parse_namepref(const char *name, | |
1413 | char **partp, | |
1414 | char **contextp) { | |
1415 | char *c; | |
1416 | static const char prefix[] = "trackname_"; | |
1417 | ||
1418 | if(strncmp(name, prefix, strlen(prefix))) | |
1419 | return -1; /* not trackname_* at all */ | |
1420 | name += strlen(prefix); | |
1421 | /* There had better be a _ between context and part */ | |
1422 | c = strchr(name, '_'); | |
1423 | if(!c) | |
1424 | return -1; | |
1425 | /* Context is first in the pref name even though most APIs have the part | |
1426 | * first. Confusing; sorry. */ | |
1427 | *contextp = xstrndup(name, c - name); | |
1428 | ++c; | |
1429 | /* There had better NOT be a second _ */ | |
1430 | if(strchr(c, '_')) | |
1431 | return -1; | |
1432 | *partp = xstrdup(c); | |
1433 | return 0; | |
1434 | } | |
1435 | ||
1436 | /** @brief Compute the default value for a track preference | |
1437 | * @param track Track name | |
1438 | * @param name Preference name | |
1439 | * @return Default value or 0 if none/not known | |
1440 | */ | |
1441 | static const char *trackdb__default(const char *track, const char *name) { | |
1442 | char *context, *part; | |
1443 | ||
1444 | if(!trackdb__parse_namepref(name, &part, &context)) { | |
1445 | /* We can work out the default for a trackname_ pref */ | |
1446 | return trackname_part(track, context, part); | |
1447 | } else if(!strcmp(name, "weight")) { | |
1448 | /* We know the default weight */ | |
1449 | return "90000"; | |
1450 | } else if(!strcmp(name, "pick_at_random")) { | |
1451 | /* By default everything is eligible for picking at random */ | |
1452 | return "1"; | |
1453 | } else if(!strcmp(name, "tags")) { | |
1454 | /* By default everything no track has any tags */ | |
1455 | return ""; | |
1456 | } | |
1457 | return 0; | |
1458 | } | |
1459 | ||
460b9539 | 1460 | /* set a pref (remove if value=0) */ |
1461 | int trackdb_set(const char *track, | |
1462 | const char *name, | |
1463 | const char *value) { | |
1464 | struct kvp *t, *p, *a; | |
1465 | DB_TXN *tid; | |
1466 | int err, cmp; | |
1467 | char *oldalias, *newalias, **oldtags = 0, **newtags; | |
02eaa49d | 1468 | const char *def; |
460b9539 | 1469 | |
02eaa49d RK |
1470 | /* If the value matches the default then unset instead, to keep the database |
1471 | * tidy. Older versions did not have this feature so your database may yet | |
1472 | * have some default values stored in it. */ | |
f26f062a | 1473 | if(value) { |
02eaa49d RK |
1474 | def = trackdb__default(track, name); |
1475 | if(def && !strcmp(value, def)) | |
1476 | value = 0; | |
f26f062a | 1477 | } |
f0feb22e | 1478 | |
460b9539 | 1479 | for(;;) { |
1480 | tid = trackdb_begin_transaction(); | |
1481 | if((err = gettrackdata(track, &t, &p, 0, | |
1482 | 0, tid)) == DB_LOCK_DEADLOCK) | |
1483 | goto fail; | |
1484 | if(err == DB_NOTFOUND) break; | |
1485 | if(name[0] == '_') { | |
1486 | if(kvp_set(&t, name, value)) | |
1487 | if(trackdb_putdata(trackdb_tracksdb, track, t, tid, 0)) | |
1488 | goto fail; | |
1489 | } else { | |
1490 | /* get the old alias name */ | |
1491 | if(compute_alias(&oldalias, track, p, tid)) goto fail; | |
1492 | /* get the old tags */ | |
1493 | if(!strcmp(name, "tags")) | |
1494 | oldtags = parsetags(kvp_get(p, "tags")); | |
1495 | /* set the value */ | |
1496 | if(kvp_set(&p, name, value)) | |
1497 | if(trackdb_putdata(trackdb_prefsdb, track, p, tid, 0)) | |
1498 | goto fail; | |
1499 | /* compute the new alias name */ | |
1500 | if((err = compute_alias(&newalias, track, p, tid))) goto fail; | |
1501 | /* check whether alias has changed */ | |
1502 | if(!(oldalias == newalias | |
1503 | || (oldalias && newalias && !strcmp(oldalias, newalias)))) { | |
1504 | /* adjust alias records to fit change */ | |
1505 | if(oldalias | |
f0feb22e RK |
1506 | && trackdb_delkey(trackdb_tracksdb, oldalias, tid) == DB_LOCK_DEADLOCK) |
1507 | goto fail; | |
460b9539 | 1508 | if(newalias) { |
1509 | a = 0; | |
1510 | kvp_set(&a, "_alias_for", track); | |
1511 | if(trackdb_putdata(trackdb_tracksdb, newalias, a, tid, 0)) goto fail; | |
1512 | } | |
1513 | } | |
1514 | /* check whether tags have changed */ | |
1515 | if(!strcmp(name, "tags")) { | |
1516 | newtags = parsetags(value); | |
1517 | while(*oldtags || *newtags) { | |
1518 | if(*oldtags && *newtags) { | |
1519 | cmp = strcmp(*oldtags, *newtags); | |
1520 | if(!cmp) { | |
1521 | /* keeping this tag */ | |
1522 | ++oldtags; | |
1523 | ++newtags; | |
1524 | } else if(cmp < 0) | |
1525 | /* old tag fits into a gap in the new list, so delete old */ | |
1526 | goto delete_old; | |
1527 | else | |
1528 | /* new tag fits into a gap in the old list, so insert new */ | |
1529 | goto insert_new; | |
1530 | } else if(*oldtags) { | |
1531 | /* we've run out of new tags, so remaining old ones are to be | |
1532 | * deleted */ | |
1533 | delete_old: | |
1534 | if(trackdb_delkeydata(trackdb_tagsdb, | |
1535 | *oldtags, track, tid) == DB_LOCK_DEADLOCK) | |
1536 | goto fail; | |
1537 | ++oldtags; | |
1538 | } else { | |
1539 | /* we've run out of old tags, so remainig new ones are to be | |
1540 | * inserted */ | |
1541 | insert_new: | |
1542 | if(register_tag(track, *newtags, tid)) goto fail; | |
1543 | ++newtags; | |
1544 | } | |
1545 | } | |
460b9539 | 1546 | } |
1547 | } | |
1548 | err = 0; | |
1549 | break; | |
1550 | fail: | |
1551 | trackdb_abort_transaction(tid); | |
1552 | } | |
1553 | trackdb_commit_transaction(tid); | |
1554 | return err == 0 ? 0 : -1; | |
1555 | } | |
1556 | ||
1557 | /* get a pref */ | |
1558 | const char *trackdb_get(const char *track, | |
1559 | const char *name) { | |
1560 | return kvp_get(trackdb_get_all(track), name); | |
1561 | } | |
1562 | ||
1563 | /* get all prefs as a 0-terminated array */ | |
1564 | struct kvp *trackdb_get_all(const char *track) { | |
1565 | struct kvp *t, *p, **pp; | |
1566 | DB_TXN *tid; | |
1567 | ||
1568 | for(;;) { | |
1569 | tid = trackdb_begin_transaction(); | |
1570 | if(gettrackdata(track, &t, &p, 0, 0, tid) == DB_LOCK_DEADLOCK) | |
1571 | goto fail; | |
1572 | break; | |
1573 | fail: | |
1574 | trackdb_abort_transaction(tid); | |
1575 | } | |
1576 | trackdb_commit_transaction(tid); | |
1577 | for(pp = &p; *pp; pp = &(*pp)->next) | |
1578 | ; | |
1579 | *pp = t; | |
1580 | return p; | |
1581 | } | |
1582 | ||
1583 | /* resolve alias */ | |
1584 | const char *trackdb_resolve(const char *track) { | |
1585 | DB_TXN *tid; | |
1586 | const char *actual; | |
f0feb22e | 1587 | |
460b9539 | 1588 | for(;;) { |
1589 | tid = trackdb_begin_transaction(); | |
1590 | if(gettrackdata(track, 0, 0, &actual, 0, tid) == DB_LOCK_DEADLOCK) | |
1591 | goto fail; | |
1592 | break; | |
1593 | fail: | |
1594 | trackdb_abort_transaction(tid); | |
1595 | } | |
1596 | trackdb_commit_transaction(tid); | |
1597 | return actual; | |
1598 | } | |
1599 | ||
1600 | int trackdb_isalias(const char *track) { | |
1601 | const char *actual = trackdb_resolve(track); | |
1602 | ||
1603 | return strcmp(actual, track); | |
1604 | } | |
1605 | ||
1606 | /* test whether a track exists (perhaps an alias) */ | |
1607 | int trackdb_exists(const char *track) { | |
1608 | DB_TXN *tid; | |
1609 | int err; | |
1610 | ||
1611 | for(;;) { | |
1612 | tid = trackdb_begin_transaction(); | |
1613 | /* unusually, here we want the return value */ | |
1614 | if((err = gettrackdata(track, 0, 0, 0, 0, tid)) == DB_LOCK_DEADLOCK) | |
1615 | goto fail; | |
1616 | break; | |
1617 | fail: | |
1618 | trackdb_abort_transaction(tid); | |
1619 | } | |
1620 | trackdb_commit_transaction(tid); | |
1621 | return (err == 0); | |
1622 | } | |
1623 | ||
1624 | /* return the list of tags */ | |
1625 | char **trackdb_alltags(void) { | |
c3be4f19 RK |
1626 | int e; |
1627 | struct vector v[1]; | |
460b9539 | 1628 | |
5b3f0631 | 1629 | vector_init(v); |
c3be4f19 RK |
1630 | WITH_TRANSACTION(trackdb_listkeys(trackdb_tagsdb, v, tid)); |
1631 | return v->vec; | |
460b9539 | 1632 | } |
1633 | ||
c3be4f19 RK |
1634 | /** @brief List all the keys in @p db |
1635 | * @param db Database | |
1636 | * @param v Vector to store keys in | |
1637 | * @param tid Transaction ID | |
1638 | * @return 0 or DB_LOCK_DEADLOCK | |
1639 | */ | |
1640 | int trackdb_listkeys(DB *db, struct vector *v, DB_TXN *tid) { | |
1641 | int e; | |
460b9539 | 1642 | DBT k, d; |
c3be4f19 | 1643 | DBC *const c = trackdb_opencursor(db, tid); |
460b9539 | 1644 | |
c3be4f19 | 1645 | v->nvec = 0; |
460b9539 | 1646 | memset(&k, 0, sizeof k); |
c3be4f19 RK |
1647 | while(!(e = c->c_get(c, &k, prepare_data(&d), DB_NEXT_NODUP))) |
1648 | vector_append(v, xstrndup(k.data, k.size)); | |
1649 | switch(e) { | |
460b9539 | 1650 | case DB_NOTFOUND: |
1651 | break; | |
1652 | case DB_LOCK_DEADLOCK: | |
c3be4f19 | 1653 | return e; |
460b9539 | 1654 | default: |
c3be4f19 | 1655 | fatal(0, "c->c_get: %s", db_strerror(e)); |
460b9539 | 1656 | } |
c3be4f19 RK |
1657 | if((e = trackdb_closecursor(c))) |
1658 | return e; | |
1659 | vector_terminate(v); | |
460b9539 | 1660 | return 0; |
1661 | } | |
1662 | ||
1663 | /* return 1 iff sorted tag lists A and B have at least one member in common */ | |
91c9324a | 1664 | int tag_intersection(char **a, char **b) { |
460b9539 | 1665 | int cmp; |
1666 | ||
1667 | /* Same sort of logic as trackdb_set() above */ | |
1668 | while(*a && *b) { | |
1669 | if(!(cmp = strcmp(*a, *b))) return 1; | |
1670 | else if(cmp < 0) ++a; | |
1671 | else ++b; | |
1672 | } | |
1673 | return 0; | |
1674 | } | |
1675 | ||
49a773eb RK |
1676 | static pid_t choose_pid = -1; |
1677 | static int choose_fd; | |
1678 | static random_callback *choose_callback; | |
1679 | static struct dynstr choose_output; | |
1680 | static unsigned choose_complete; | |
1681 | static int choose_status; | |
1682 | #define CHOOSE_RUNNING 1 | |
1683 | #define CHOOSE_READING 2 | |
1684 | ||
1685 | static void choose_finished(ev_source *ev, unsigned which) { | |
1686 | choose_complete |= which; | |
1687 | if(choose_complete != (CHOOSE_RUNNING|CHOOSE_READING)) | |
1688 | return; | |
1689 | choose_pid = -1; | |
1690 | if(choose_status == 0 && choose_output.nvec > 0) { | |
1691 | dynstr_terminate(&choose_output); | |
1692 | choose_callback(ev, xstrdup(choose_output.vec)); | |
1693 | } else | |
1694 | choose_callback(ev, 0); | |
1695 | } | |
1696 | ||
1697 | /** @brief Called when @c disorder-choose terminates */ | |
1698 | static int choose_exited(ev_source *ev, | |
1699 | pid_t attribute((unused)) pid, | |
1700 | int status, | |
1701 | const struct rusage attribute((unused)) *rusage, | |
1702 | void attribute((unused)) *u) { | |
1703 | if(status) | |
1704 | error(0, "disorder-choose %s", wstat(status)); | |
1705 | choose_status = status; | |
1706 | choose_finished(ev, CHOOSE_RUNNING); | |
460b9539 | 1707 | return 0; |
1708 | } | |
1709 | ||
49a773eb RK |
1710 | /** @brief Called with data from @c disorder-choose pipe */ |
1711 | static int choose_readable(ev_source *ev, | |
1712 | ev_reader *reader, | |
1713 | void *ptr, | |
1714 | size_t bytes, | |
1715 | int eof, | |
1716 | void attribute((unused)) *u) { | |
1717 | dynstr_append_bytes(&choose_output, ptr, bytes); | |
1718 | ev_reader_consume(reader, bytes); | |
1719 | if(eof) | |
1720 | choose_finished(ev, CHOOSE_READING); | |
1721 | return 0; | |
1722 | } | |
460b9539 | 1723 | |
49a773eb RK |
1724 | static int choose_read_error(ev_source *ev, |
1725 | int errno_value, | |
1726 | void attribute((unused)) *u) { | |
1727 | error(errno_value, "error reading disorder-choose pipe"); | |
1728 | choose_finished(ev, CHOOSE_READING); | |
1729 | return 0; | |
1730 | } | |
1731 | ||
1732 | /** @brief Request a random track | |
1733 | * @param ev Event source | |
1734 | * @param callback Called with random track or NULL | |
1735 | * @return 0 if a request was initiated, else -1 | |
1736 | * | |
1737 | * Initiates a random track choice. @p callback will later be called back with | |
1738 | * the choice (or NULL on error). If a choice is already underway then -1 is | |
1739 | * returned and there will be no additional callback. | |
1740 | * | |
1741 | * The caller shouldn't assume that the track returned actually exists (it | |
1742 | * might be removed between the choice and the callback, or between being added | |
1743 | * to the queue and being played). | |
1744 | */ | |
1745 | int trackdb_request_random(ev_source *ev, | |
1746 | random_callback *callback) { | |
1747 | int p[2]; | |
1748 | ||
1749 | if(choose_pid != -1) | |
1750 | return -1; /* don't run concurrent chooses */ | |
1751 | xpipe(p); | |
1752 | cloexec(p[0]); | |
1753 | choose_pid = subprogram(ev, p[1], "disorder-choose", (char *)0); | |
1754 | choose_fd = p[0]; | |
1755 | xclose(p[1]); | |
1756 | choose_callback = callback; | |
1757 | choose_output.nvec = 0; | |
1758 | choose_complete = 0; | |
1759 | ev_reader_new(ev, p[0], choose_readable, choose_read_error, 0, | |
1760 | "disorder-choose reader"); /* owns p[0] */ | |
1761 | ev_child(ev, choose_pid, 0, choose_exited, 0); /* owns the subprocess */ | |
1762 | return 0; | |
460b9539 | 1763 | } |
1764 | ||
1765 | /* get a track name given the prefs. Set *used_db to 1 if we got the answer | |
1766 | * from the prefs. */ | |
1767 | static const char *getpart(const char *track, | |
1768 | const char *context, | |
1769 | const char *part, | |
1770 | const struct kvp *p, | |
1771 | int *used_db) { | |
1772 | const char *result; | |
1773 | char *pref; | |
1774 | ||
1775 | byte_xasprintf(&pref, "trackname_%s_%s", context, part); | |
1776 | if((result = kvp_get(p, pref))) | |
1777 | *used_db = 1; | |
1778 | else | |
1779 | result = trackname_part(track, context, part); | |
1780 | assert(result != 0); | |
1781 | return result; | |
1782 | } | |
1783 | ||
1784 | /* get a track name part, like trackname_part(), but taking the database into | |
1785 | * account. */ | |
1786 | const char *trackdb_getpart(const char *track, | |
1787 | const char *context, | |
1788 | const char *part) { | |
1789 | struct kvp *p; | |
1790 | DB_TXN *tid; | |
1791 | char *pref; | |
1792 | const char *actual; | |
1793 | int used_db, err; | |
1794 | ||
1795 | /* construct the full pref */ | |
1796 | byte_xasprintf(&pref, "trackname_%s_%s", context, part); | |
1797 | for(;;) { | |
1798 | tid = trackdb_begin_transaction(); | |
1799 | if((err = gettrackdata(track, 0, &p, &actual, 0, tid)) == DB_LOCK_DEADLOCK) | |
1800 | goto fail; | |
1801 | break; | |
1802 | fail: | |
1803 | trackdb_abort_transaction(tid); | |
1804 | } | |
1805 | trackdb_commit_transaction(tid); | |
1806 | return getpart(actual, context, part, p, &used_db); | |
1807 | } | |
1808 | ||
1809 | /* get the raw path name for @track@ (might be an alias) */ | |
1810 | const char *trackdb_rawpath(const char *track) { | |
1811 | DB_TXN *tid; | |
1812 | struct kvp *t; | |
1813 | const char *path; | |
1814 | ||
1815 | for(;;) { | |
1816 | tid = trackdb_begin_transaction(); | |
1817 | if(gettrackdata(track, &t, 0, 0, 0, tid) == DB_LOCK_DEADLOCK) | |
1818 | goto fail; | |
1819 | break; | |
1820 | fail: | |
1821 | trackdb_abort_transaction(tid); | |
1822 | } | |
1823 | trackdb_commit_transaction(tid); | |
1824 | if(!(path = kvp_get(t, "_path"))) path = track; | |
1825 | return path; | |
1826 | } | |
1827 | ||
1828 | /* trackdb_list **************************************************************/ | |
1829 | ||
1830 | /* this is incredibly ugly, sorry, perhaps it will be rewritten to be actually | |
1831 | * readable at some point */ | |
1832 | ||
1833 | /* return true if the basename of TRACK[0..TL-1], as defined by DL, matches RE. | |
1834 | * If RE is a null pointer then it matches everything. */ | |
1835 | static int track_matches(size_t dl, const char *track, size_t tl, | |
1836 | const pcre *re) { | |
1837 | int ovec[3], rc; | |
1838 | ||
1839 | if(!re) | |
1840 | return 1; | |
1841 | track += dl + 1; | |
1842 | tl -= (dl + 1); | |
1843 | switch(rc = pcre_exec(re, 0, track, tl, 0, 0, ovec, 3)) { | |
1844 | case PCRE_ERROR_NOMATCH: return 0; | |
1845 | default: | |
1846 | if(rc < 0) { | |
1847 | error(0, "pcre_exec returned %d, subject '%s'", rc, track); | |
1848 | return 0; | |
1849 | } | |
1850 | return 1; | |
1851 | } | |
1852 | } | |
1853 | ||
1854 | static int do_list(struct vector *v, const char *dir, | |
1855 | enum trackdb_listable what, const pcre *re, DB_TXN *tid) { | |
1856 | DBC *cursor; | |
1857 | DBT k, d; | |
1858 | size_t dl; | |
1859 | char *ptr; | |
1860 | int err; | |
1861 | size_t l, last_dir_len = 0; | |
03a01f3a | 1862 | char *last_dir = 0, *track; |
460b9539 | 1863 | struct kvp *p; |
f0feb22e | 1864 | |
460b9539 | 1865 | dl = strlen(dir); |
1866 | cursor = trackdb_opencursor(trackdb_tracksdb, tid); | |
1867 | make_key(&k, dir); | |
1868 | prepare_data(&d); | |
1869 | /* find the first key >= dir */ | |
1870 | err = cursor->c_get(cursor, &k, &d, DB_SET_RANGE); | |
1871 | /* keep going while we're dealing with <dir/anything> */ | |
1872 | while(err == 0 | |
1873 | && k.size > dl | |
1874 | && ((char *)k.data)[dl] == '/' | |
1875 | && !memcmp(k.data, dir, dl)) { | |
1876 | ptr = memchr((char *)k.data + dl + 1, '/', k.size - (dl + 1)); | |
1877 | if(ptr) { | |
1878 | /* we have <dir/component/anything>, so <dir/component> is a directory */ | |
1879 | l = ptr - (char *)k.data; | |
1880 | if(what & trackdb_directories) | |
1881 | if(!(last_dir | |
1882 | && l == last_dir_len | |
1883 | && !memcmp(last_dir, k.data, l))) { | |
1884 | last_dir = xstrndup(k.data, last_dir_len = l); | |
1885 | if(track_matches(dl, k.data, l, re)) | |
1886 | vector_append(v, last_dir); | |
1887 | } | |
1888 | } else { | |
1889 | /* found a plain file */ | |
1890 | if((what & trackdb_files)) { | |
1891 | track = xstrndup(k.data, k.size); | |
1892 | if((err = trackdb_getdata(trackdb_prefsdb, | |
1893 | track, &p, tid)) == DB_LOCK_DEADLOCK) | |
1894 | goto deadlocked; | |
03a01f3a RK |
1895 | /* There's an awkward question here... |
1896 | * | |
1897 | * If a track shares a directory with its alias then we could | |
1898 | * do one of three things: | |
1899 | * - report both. Looks ridiculuous in most UIs. | |
1900 | * - report just the alias. Remarkably inconvenient to write | |
1901 | * UI code for! | |
1902 | * - report just the real name. Ugly if the UI doesn't prettify | |
1903 | * names via the name parts. | |
1904 | */ | |
1905 | #if 1 | |
1906 | /* If this file is an alias for a track in the same directory then we | |
1907 | * skip it */ | |
1908 | struct kvp *t = kvp_urldecode(d.data, d.size); | |
1909 | const char *alias_target = kvp_get(t, "_alias_for"); | |
1910 | if(!(alias_target | |
1911 | && !strcmp(d_dirname(alias_target), | |
1912 | d_dirname(track)))) | |
1913 | if(track_matches(dl, k.data, k.size, re)) | |
1914 | vector_append(v, track); | |
1915 | #else | |
460b9539 | 1916 | /* if this file has an alias in the same directory then we skip it */ |
03a01f3a | 1917 | char *alias; |
460b9539 | 1918 | if((err = compute_alias(&alias, track, p, tid))) |
1919 | goto deadlocked; | |
1920 | if(!(alias && !strcmp(d_dirname(alias), d_dirname(track)))) | |
1921 | if(track_matches(dl, k.data, k.size, re)) | |
1922 | vector_append(v, track); | |
03a01f3a | 1923 | #endif |
460b9539 | 1924 | } |
1925 | } | |
1926 | err = cursor->c_get(cursor, &k, &d, DB_NEXT); | |
1927 | } | |
1928 | switch(err) { | |
1929 | case 0: | |
1930 | break; | |
1931 | case DB_NOTFOUND: | |
1932 | err = 0; | |
1933 | break; | |
1934 | case DB_LOCK_DEADLOCK: | |
1935 | error(0, "error querying database: %s", db_strerror(err)); | |
1936 | break; | |
1937 | default: | |
1938 | fatal(0, "error querying database: %s", db_strerror(err)); | |
1939 | } | |
1940 | deadlocked: | |
1941 | if(trackdb_closecursor(cursor)) err = DB_LOCK_DEADLOCK; | |
1942 | return err; | |
1943 | } | |
1944 | ||
1945 | /* return the directories or files below @dir@ */ | |
1946 | char **trackdb_list(const char *dir, int *np, enum trackdb_listable what, | |
1947 | const pcre *re) { | |
1948 | DB_TXN *tid; | |
1949 | int n; | |
1950 | struct vector v; | |
1951 | ||
1952 | vector_init(&v); | |
1953 | for(;;) { | |
1954 | tid = trackdb_begin_transaction(); | |
1955 | v.nvec = 0; | |
1956 | if(dir) { | |
1957 | if(do_list(&v, dir, what, re, tid)) | |
1958 | goto fail; | |
1959 | } else { | |
1960 | for(n = 0; n < config->collection.n; ++n) | |
1961 | if(do_list(&v, config->collection.s[n].root, what, re, tid)) | |
1962 | goto fail; | |
1963 | } | |
1964 | break; | |
1965 | fail: | |
1966 | trackdb_abort_transaction(tid); | |
1967 | } | |
1968 | trackdb_commit_transaction(tid); | |
1969 | vector_terminate(&v); | |
1970 | if(np) | |
1971 | *np = v.nvec; | |
1972 | return v.vec; | |
f0feb22e | 1973 | } |
460b9539 | 1974 | |
1975 | /* If S is tag:something, return something. Else return 0. */ | |
1976 | static const char *checktag(const char *s) { | |
1977 | if(!strncmp(s, "tag:", 4)) | |
1978 | return s + 4; | |
1979 | else | |
1980 | return 0; | |
1981 | } | |
1982 | ||
1983 | /* return a list of tracks containing all of the words given. If you | |
1984 | * ask for only stopwords you get no tracks. */ | |
1985 | char **trackdb_search(char **wordlist, int nwordlist, int *ntracks) { | |
1986 | const char **w, *best = 0, *tag; | |
1987 | char **twords, **tags; | |
d1d4a182 | 1988 | char *istag; |
460b9539 | 1989 | int i, j, n, err, what; |
1990 | DBC *cursor = 0; | |
1991 | DBT k, d; | |
1992 | struct vector u, v; | |
1993 | DB_TXN *tid; | |
1994 | struct kvp *p; | |
1995 | int ntags = 0; | |
1996 | DB *db; | |
1997 | const char *dbname; | |
1998 | ||
1999 | *ntracks = 0; /* for early returns */ | |
3c82b504 | 2000 | /* normalize all the words */ |
460b9539 | 2001 | w = xmalloc(nwordlist * sizeof (char *)); |
d1d4a182 | 2002 | istag = xmalloc_noptr(nwordlist); |
460b9539 | 2003 | for(n = 0; n < nwordlist; ++n) { |
3c82b504 RK |
2004 | uint32_t *w32; |
2005 | size_t nw32; | |
f0feb22e | 2006 | |
c85b7022 | 2007 | w[n] = utf8_casefold_compat(wordlist[n], strlen(wordlist[n]), 0); |
a3777123 RK |
2008 | if(checktag(w[n])) { |
2009 | ++ntags; /* count up tags */ | |
2010 | /* Normalize the tag */ | |
d1d4a182 RK |
2011 | w[n] = normalize_tag(w[n] + 4, strlen(w[n] + 4)); |
2012 | istag[n] = 1; | |
a3777123 RK |
2013 | } else { |
2014 | /* Normalize the search term by removing combining characters */ | |
2015 | if(!(w32 = utf8_to_utf32(w[n], strlen(w[n]), &nw32))) | |
2016 | return 0; | |
2017 | nw32 = remove_combining_chars(w32, nw32); | |
2018 | if(!(w[n] = utf32_to_utf8(w32, nw32, 0))) | |
2019 | return 0; | |
d1d4a182 | 2020 | istag[n] = 0; |
a3777123 | 2021 | } |
460b9539 | 2022 | } |
2023 | /* find the longest non-stopword */ | |
2024 | for(n = 0; n < nwordlist; ++n) | |
d1d4a182 | 2025 | if(!istag[n] && !stopword(w[n])) |
460b9539 | 2026 | if(!best || strlen(w[n]) > strlen(best)) |
2027 | best = w[n]; | |
2028 | /* TODO: we should at least in principal be able to identify the word or tag | |
2029 | * with the least matches in log time, and choose that as our primary search | |
2030 | * term. */ | |
2031 | if(ntags && !best) { | |
2032 | /* Only tags are listed. We limit to the first and narrow down with the | |
2033 | * rest. */ | |
d1d4a182 | 2034 | best = istag[0] ? w[0] : 0; |
460b9539 | 2035 | db = trackdb_tagsdb; |
2036 | dbname = "tags"; | |
2037 | } else if(best) { | |
2038 | /* We can limit to some word. */ | |
2039 | db = trackdb_searchdb; | |
2040 | dbname = "search"; | |
2041 | } else { | |
2042 | /* Only stopwords */ | |
2043 | return 0; | |
2044 | } | |
2045 | vector_init(&u); | |
2046 | vector_init(&v); | |
2047 | for(;;) { | |
2048 | tid = trackdb_begin_transaction(); | |
2049 | /* find all the tracks that have that word */ | |
2050 | make_key(&k, best); | |
2051 | prepare_data(&d); | |
2052 | what = DB_SET; | |
2053 | v.nvec = 0; | |
2054 | cursor = trackdb_opencursor(db, tid); | |
2055 | while(!(err = cursor->c_get(cursor, &k, &d, what))) { | |
2056 | vector_append(&v, xstrndup(d.data, d.size)); | |
2057 | what = DB_NEXT_DUP; | |
2058 | } | |
2059 | switch(err) { | |
2060 | case DB_NOTFOUND: | |
2061 | err = 0; | |
2062 | break; | |
2063 | case DB_LOCK_DEADLOCK: | |
2064 | error(0, "error querying %s database: %s", dbname, db_strerror(err)); | |
2065 | break; | |
2066 | default: | |
2067 | fatal(0, "error querying %s database: %s", dbname, db_strerror(err)); | |
2068 | } | |
2069 | if(trackdb_closecursor(cursor)) err = DB_LOCK_DEADLOCK; | |
2070 | cursor = 0; | |
2071 | /* do a naive search over that (hopefuly fairly small) list of tracks */ | |
2072 | u.nvec = 0; | |
2073 | for(n = 0; n < v.nvec; ++n) { | |
2074 | if((err = gettrackdata(v.vec[n], 0, &p, 0, 0, tid) == DB_LOCK_DEADLOCK)) | |
2075 | goto fail; | |
2076 | else if(err) { | |
2077 | error(0, "track %s unexpected error: %s", v.vec[n], db_strerror(err)); | |
2078 | continue; | |
2079 | } | |
2080 | twords = track_to_words(v.vec[n], p); | |
2081 | tags = parsetags(kvp_get(p, "tags")); | |
2082 | for(i = 0; i < nwordlist; ++i) { | |
d1d4a182 RK |
2083 | if(istag[i]) { |
2084 | tag = w[i]; | |
460b9539 | 2085 | /* Track must have this tag */ |
2086 | for(j = 0; tags[j]; ++j) | |
2087 | if(!strcmp(tag, tags[j])) break; /* tag found */ | |
2088 | if(!tags[j]) break; /* tag not found */ | |
2089 | } else { | |
2090 | /* Track must contain this word */ | |
2091 | for(j = 0; twords[j]; ++j) | |
2092 | if(!strcmp(w[i], twords[j])) break; /* word found */ | |
2093 | if(!twords[j]) break; /* word not found */ | |
2094 | } | |
2095 | } | |
2096 | if(i >= nwordlist) /* all words found */ | |
2097 | vector_append(&u, v.vec[n]); | |
2098 | } | |
2099 | break; | |
2100 | fail: | |
2101 | trackdb_closecursor(cursor); | |
2102 | cursor = 0; | |
2103 | trackdb_abort_transaction(tid); | |
2104 | info("retrying search"); | |
2105 | } | |
2106 | trackdb_commit_transaction(tid); | |
2107 | vector_terminate(&u); | |
2108 | if(ntracks) | |
2109 | *ntracks = u.nvec; | |
2110 | return u.vec; | |
2111 | } | |
2112 | ||
2113 | /* trackdb_scan **************************************************************/ | |
2114 | ||
2115 | int trackdb_scan(const char *root, | |
2116 | int (*callback)(const char *track, | |
2117 | struct kvp *data, | |
bea6f6d5 | 2118 | struct kvp *prefs, |
460b9539 | 2119 | void *u, |
2120 | DB_TXN *tid), | |
2121 | void *u, | |
2122 | DB_TXN *tid) { | |
2123 | DBC *cursor; | |
bea6f6d5 | 2124 | DBT k, d, pd; |
d1694464 | 2125 | const size_t root_len = root ? strlen(root) : 0; |
2126 | int err, cberr; | |
bea6f6d5 | 2127 | struct kvp *data, *prefs; |
d1694464 | 2128 | const char *track; |
460b9539 | 2129 | |
2130 | cursor = trackdb_opencursor(trackdb_tracksdb, tid); | |
d1694464 | 2131 | if(root) |
2132 | err = cursor->c_get(cursor, make_key(&k, root), prepare_data(&d), | |
2133 | DB_SET_RANGE); | |
2134 | else { | |
2135 | memset(&k, 0, sizeof k); | |
2136 | err = cursor->c_get(cursor, &k, prepare_data(&d), | |
2137 | DB_FIRST); | |
2138 | } | |
460b9539 | 2139 | while(!err) { |
d1694464 | 2140 | if(!root |
2141 | || (k.size > root_len | |
2142 | && !strncmp(k.data, root, root_len) | |
2143 | && ((char *)k.data)[root_len] == '/')) { | |
460b9539 | 2144 | data = kvp_urldecode(d.data, d.size); |
d1694464 | 2145 | if(kvp_get(data, "_path")) { |
2146 | track = xstrndup(k.data, k.size); | |
bea6f6d5 RK |
2147 | /* TODO: trackdb_prefsdb is currently a DB_HASH. This means we have to |
2148 | * do a lookup for every single track. In fact this is quite quick: | |
2149 | * with around 10,000 tracks a complete scan is around 0.3s on my | |
2150 | * 2.2GHz Athlon. However, if it were a DB_BTREE, we could do the same | |
2151 | * linear walk as we already do over trackdb_tracksdb, and probably get | |
2152 | * even higher performance. That would require upgrade logic to | |
2153 | * translate old databases though. | |
2154 | */ | |
2155 | switch(err = trackdb_prefsdb->get(trackdb_prefsdb, tid, &k, | |
2156 | prepare_data(&pd), 0)) { | |
2157 | case 0: | |
2158 | prefs = kvp_urldecode(pd.data, pd.size); | |
2159 | break; | |
2160 | case DB_NOTFOUND: | |
2161 | prefs = 0; | |
2162 | break; | |
2163 | case DB_LOCK_DEADLOCK: | |
2164 | error(0, "getting prefs: %s", db_strerror(err)); | |
2165 | trackdb_closecursor(cursor); | |
2166 | return err; | |
2167 | default: | |
2168 | fatal(0, "getting prefs: %s", db_strerror(err)); | |
2169 | } | |
d1694464 | 2170 | /* Advance to the next track before the callback so that the callback |
2171 | * may safely delete the track */ | |
2172 | err = cursor->c_get(cursor, &k, &d, DB_NEXT); | |
bea6f6d5 | 2173 | if((cberr = callback(track, data, prefs, u, tid))) { |
d1694464 | 2174 | err = cberr; |
460b9539 | 2175 | break; |
d1694464 | 2176 | } |
2177 | } else | |
2178 | err = cursor->c_get(cursor, &k, &d, DB_NEXT); | |
460b9539 | 2179 | } else |
2180 | break; | |
2181 | } | |
2182 | trackdb_closecursor(cursor); | |
2183 | switch(err) { | |
2184 | case EINTR: | |
2185 | return err; | |
2186 | case 0: | |
2187 | case DB_NOTFOUND: | |
2188 | return 0; | |
2189 | case DB_LOCK_DEADLOCK: | |
2190 | error(0, "c->c_get: %s", db_strerror(err)); | |
2191 | return err; | |
2192 | default: | |
2193 | fatal(0, "c->c_get: %s", db_strerror(err)); | |
2194 | } | |
2195 | } | |
2196 | ||
2197 | /* trackdb_rescan ************************************************************/ | |
2198 | ||
dd9af5cb RK |
2199 | /** @brief Node in the list of rescan-complete callbacks */ |
2200 | struct rescanned_node { | |
2201 | struct rescanned_node *next; | |
2202 | void (*rescanned)(void *ru); | |
2203 | void *ru; | |
2204 | }; | |
2205 | ||
2206 | /** @brief List of rescan-complete callbacks */ | |
2207 | static struct rescanned_node *rescanned_list; | |
2208 | ||
2209 | /** @brief Add a rescan completion callback */ | |
2210 | void trackdb_add_rescanned(void (*rescanned)(void *ru), | |
2211 | void *ru) { | |
2212 | if(rescanned) { | |
2213 | struct rescanned_node *n = xmalloc(sizeof *n); | |
2214 | n->next = rescanned_list; | |
2215 | n->rescanned = rescanned; | |
2216 | n->ru = ru; | |
2217 | rescanned_list = n; | |
2218 | } | |
2219 | } | |
2220 | ||
460b9539 | 2221 | /* called when the rescanner terminates */ |
2222 | static int reap_rescan(ev_source attribute((unused)) *ev, | |
2223 | pid_t pid, | |
2224 | int status, | |
2225 | const struct rusage attribute((unused)) *rusage, | |
2226 | void attribute((unused)) *u) { | |
2227 | if(pid == rescan_pid) rescan_pid = -1; | |
2228 | if(status) | |
c0bcd134 | 2229 | error(0, RESCAN": %s", wstat(status)); |
460b9539 | 2230 | else |
c0bcd134 | 2231 | D((RESCAN" terminated: %s", wstat(status))); |
460b9539 | 2232 | /* Our cache of file lookups is out of date now */ |
2233 | cache_clean(&cache_files_type); | |
e025abff | 2234 | eventlog("rescanned", (char *)0); |
dd9af5cb RK |
2235 | /* Call rescanned callbacks */ |
2236 | while(rescanned_list) { | |
fdbb860d | 2237 | void (*rescanned)(void *u_) = rescanned_list->rescanned; |
dd9af5cb RK |
2238 | void *ru = rescanned_list->ru; |
2239 | ||
2240 | rescanned_list = rescanned_list->next; | |
2241 | rescanned(ru); | |
2242 | } | |
460b9539 | 2243 | return 0; |
2244 | } | |
2245 | ||
ffac51d7 RK |
2246 | /** @brief Initiate a rescan |
2247 | * @param ev Event loop or 0 to block | |
0590cedc | 2248 | * @param recheck 1 to recheck lengths, 0 to suppress check |
dd9af5cb | 2249 | * @param rescanned Called on completion (if not NULL) |
59cf25c4 | 2250 | * @param ru Passed to @p rescanned |
ffac51d7 | 2251 | */ |
dd9af5cb RK |
2252 | void trackdb_rescan(ev_source *ev, int recheck, |
2253 | void (*rescanned)(void *ru), | |
2254 | void *ru) { | |
1a4a6350 | 2255 | int w; |
c0bcd134 | 2256 | |
460b9539 | 2257 | if(rescan_pid != -1) { |
dd9af5cb | 2258 | trackdb_add_rescanned(rescanned, ru); |
460b9539 | 2259 | error(0, "rescan already underway"); |
2260 | return; | |
2261 | } | |
ffac51d7 | 2262 | rescan_pid = subprogram(ev, -1, RESCAN, |
3d2988f6 | 2263 | recheck ? "--check" : "--no-check", |
ffac51d7 | 2264 | (char *)0); |
dd9af5cb | 2265 | trackdb_add_rescanned(rescanned, ru); |
1a4a6350 RK |
2266 | if(ev) { |
2267 | ev_child(ev, rescan_pid, 0, reap_rescan, 0); | |
2268 | D(("started rescanner")); | |
2269 | } else { | |
2270 | /* This is the first rescan, we block until it is complete */ | |
2271 | while(waitpid(rescan_pid, &w, 0) < 0 && errno == EINTR) | |
2272 | ; | |
2273 | reap_rescan(0, rescan_pid, w, 0, 0); | |
2274 | } | |
460b9539 | 2275 | } |
2276 | ||
2277 | int trackdb_rescan_cancel(void) { | |
2278 | if(rescan_pid == -1) return 0; | |
2279 | if(kill(rescan_pid, SIGTERM) < 0) | |
2280 | fatal(errno, "error killing rescanner"); | |
2281 | rescan_pid = -1; | |
2282 | return 1; | |
2283 | } | |
2284 | ||
dd9af5cb RK |
2285 | /** @brief Return true if a rescan is underway */ |
2286 | int trackdb_rescan_underway(void) { | |
2287 | return rescan_pid != -1; | |
2288 | } | |
2289 | ||
460b9539 | 2290 | /* global prefs **************************************************************/ |
2291 | ||
2292 | void trackdb_set_global(const char *name, | |
2293 | const char *value, | |
2294 | const char *who) { | |
2295 | DB_TXN *tid; | |
460b9539 | 2296 | int err; |
2297 | int state; | |
2298 | ||
460b9539 | 2299 | for(;;) { |
2300 | tid = trackdb_begin_transaction(); | |
f9635e06 RK |
2301 | if(!(err = trackdb_set_global_tid(name, value, tid))) |
2302 | break; | |
460b9539 | 2303 | trackdb_abort_transaction(tid); |
2304 | } | |
2305 | trackdb_commit_transaction(tid); | |
2306 | /* log important state changes */ | |
2307 | if(!strcmp(name, "playing")) { | |
2308 | state = !value || !strcmp(value, "yes"); | |
2309 | info("playing %s by %s", | |
2310 | state ? "enabled" : "disabled", | |
2311 | who ? who : "-"); | |
2312 | eventlog("state", state ? "enable_play" : "disable_play", (char *)0); | |
2313 | } | |
2314 | if(!strcmp(name, "random-play")) { | |
2315 | state = !value || !strcmp(value, "yes"); | |
2316 | info("random play %s by %s", | |
2317 | state ? "enabled" : "disabled", | |
2318 | who ? who : "-"); | |
2319 | eventlog("state", state ? "enable_random" : "disable_random", (char *)0); | |
2320 | } | |
460b9539 | 2321 | } |
2322 | ||
f9635e06 RK |
2323 | int trackdb_set_global_tid(const char *name, |
2324 | const char *value, | |
2325 | DB_TXN *tid) { | |
2326 | DBT k, d; | |
2327 | int err; | |
2328 | ||
2329 | memset(&k, 0, sizeof k); | |
2330 | memset(&d, 0, sizeof d); | |
2331 | k.data = (void *)name; | |
2332 | k.size = strlen(name); | |
2333 | if(value) { | |
2334 | d.data = (void *)value; | |
2335 | d.size = strlen(value); | |
2336 | } | |
2337 | if(value) | |
2338 | err = trackdb_globaldb->put(trackdb_globaldb, tid, &k, &d, 0); | |
2339 | else | |
2340 | err = trackdb_globaldb->del(trackdb_globaldb, tid, &k, 0); | |
2341 | if(err == DB_LOCK_DEADLOCK) return err; | |
2342 | if(err) | |
2343 | fatal(0, "error updating database: %s", db_strerror(err)); | |
2344 | return 0; | |
2345 | } | |
2346 | ||
460b9539 | 2347 | const char *trackdb_get_global(const char *name) { |
2348 | DB_TXN *tid; | |
2349 | int err; | |
2350 | const char *r; | |
2351 | ||
2352 | for(;;) { | |
2353 | tid = trackdb_begin_transaction(); | |
2354 | if(!(err = trackdb_get_global_tid(name, tid, &r))) | |
2355 | break; | |
2356 | trackdb_abort_transaction(tid); | |
2357 | } | |
2358 | trackdb_commit_transaction(tid); | |
2359 | return r; | |
2360 | } | |
2361 | ||
f9635e06 RK |
2362 | int trackdb_get_global_tid(const char *name, |
2363 | DB_TXN *tid, | |
2364 | const char **rp) { | |
460b9539 | 2365 | DBT k, d; |
2366 | int err; | |
2367 | ||
2368 | memset(&k, 0, sizeof k); | |
2369 | k.data = (void *)name; | |
2370 | k.size = strlen(name); | |
2371 | switch(err = trackdb_globaldb->get(trackdb_globaldb, tid, &k, | |
2372 | prepare_data(&d), 0)) { | |
2373 | case 0: | |
2374 | *rp = xstrndup(d.data, d.size); | |
2375 | return 0; | |
2376 | case DB_NOTFOUND: | |
2377 | *rp = 0; | |
2378 | return 0; | |
2379 | case DB_LOCK_DEADLOCK: | |
2380 | return err; | |
2381 | default: | |
f9635e06 | 2382 | fatal(0, "error reading database: %s", db_strerror(err)); |
460b9539 | 2383 | } |
2384 | } | |
2385 | ||
2a10b70b RK |
2386 | /** @brief Retrieve the most recently added tracks |
2387 | * @param ntracksp Where to put count, or 0 | |
2388 | * @param maxtracks Maximum number of tracks to retrieve | |
2389 | * @return null-terminated array of track names | |
2390 | * | |
2391 | * The most recently added track is first in the array. | |
2392 | */ | |
2393 | char **trackdb_new(int *ntracksp, | |
2394 | int maxtracks) { | |
2395 | DB_TXN *tid; | |
2396 | char **tracks; | |
2397 | ||
2398 | for(;;) { | |
2399 | tid = trackdb_begin_transaction(); | |
2400 | tracks = trackdb_new_tid(ntracksp, maxtracks, tid); | |
2401 | if(tracks) | |
2402 | break; | |
2403 | trackdb_abort_transaction(tid); | |
2404 | } | |
2405 | trackdb_commit_transaction(tid); | |
2406 | return tracks; | |
2407 | } | |
2408 | ||
2409 | /** @brief Retrieve the most recently added tracks | |
2410 | * @param ntracksp Where to put count, or 0 | |
2411 | * @param maxtracks Maximum number of tracks to retrieve, or 0 for all | |
2412 | * @param tid Transaction ID | |
2413 | * @return null-terminated array of track names, or NULL on deadlock | |
2414 | * | |
2415 | * The most recently added track is first in the array. | |
2416 | */ | |
2417 | static char **trackdb_new_tid(int *ntracksp, | |
2418 | int maxtracks, | |
2419 | DB_TXN *tid) { | |
2420 | DBC *c; | |
2421 | DBT k, d; | |
2422 | int err = 0; | |
2423 | struct vector tracks[1]; | |
049dec87 | 2424 | hash *h = hash_new(1); |
2a10b70b RK |
2425 | |
2426 | vector_init(tracks); | |
2427 | c = trackdb_opencursor(trackdb_noticeddb, tid); | |
2428 | while((maxtracks <= 0 || tracks->nvec < maxtracks) | |
053a839e | 2429 | && !(err = c->c_get(c, prepare_data(&k), prepare_data(&d), DB_PREV))) { |
053a839e | 2430 | char *const track = xstrndup(d.data, d.size); |
049dec87 RK |
2431 | /* Don't add any track more than once */ |
2432 | if(hash_add(h, track, "", HASH_INSERT)) | |
2433 | continue; | |
2434 | /* See if the track still exists */ | |
053a839e RK |
2435 | err = trackdb_getdata(trackdb_tracksdb, track, NULL/*kp*/, tid); |
2436 | if(err == DB_NOTFOUND) | |
2437 | continue; /* It doesn't, skip it */ | |
2438 | if(err == DB_LOCK_DEADLOCK) | |
2439 | break; /* Doh */ | |
2440 | vector_append(tracks, track); | |
2441 | } | |
2a10b70b RK |
2442 | switch(err) { |
2443 | case 0: /* hit maxtracks */ | |
2444 | case DB_NOTFOUND: /* ran out of tracks */ | |
2445 | break; | |
2446 | case DB_LOCK_DEADLOCK: | |
2447 | trackdb_closecursor(c); | |
2448 | return 0; | |
2449 | default: | |
2450 | fatal(0, "error reading noticed.db: %s", db_strerror(err)); | |
2451 | } | |
2452 | if((err = trackdb_closecursor(c))) | |
2453 | return 0; /* deadlock */ | |
2454 | vector_terminate(tracks); | |
2455 | if(ntracksp) | |
2456 | *ntracksp = tracks->nvec; | |
2457 | return tracks->vec; | |
2458 | } | |
2459 | ||
1e64e9fb RK |
2460 | /** @brief Expire noticed.db |
2461 | * @param earliest Earliest timestamp to keep | |
2462 | */ | |
2463 | void trackdb_expire_noticed(time_t earliest) { | |
2464 | DB_TXN *tid; | |
2465 | ||
2466 | for(;;) { | |
2467 | tid = trackdb_begin_transaction(); | |
2468 | if(!trackdb_expire_noticed_tid(earliest, tid)) | |
2469 | break; | |
2470 | trackdb_abort_transaction(tid); | |
2471 | } | |
2472 | trackdb_commit_transaction(tid); | |
2473 | } | |
2474 | ||
2475 | /** @brief Expire noticed.db | |
2476 | * @param earliest Earliest timestamp to keep | |
2477 | * @param tid Transaction ID | |
2478 | * @return 0 or DB_LOCK_DEADLOCK | |
2479 | */ | |
2480 | static int trackdb_expire_noticed_tid(time_t earliest, DB_TXN *tid) { | |
2481 | DBC *c; | |
2482 | DBT k, d; | |
2483 | int err = 0, ret; | |
2484 | time_t when; | |
2485 | uint32_t *kk; | |
2486 | int count = 0; | |
2487 | ||
2488 | c = trackdb_opencursor(trackdb_noticeddb, tid); | |
2489 | while(!(err = c->c_get(c, prepare_data(&k), prepare_data(&d), DB_NEXT))) { | |
2490 | kk = k.data; | |
2491 | when = (time_t)(((uint64_t)ntohl(kk[0]) << 32) + ntohl(kk[1])); | |
2492 | if(when >= earliest) | |
2493 | break; | |
2494 | if((err = c->c_del(c, 0))) { | |
2495 | if(err != DB_LOCK_DEADLOCK) | |
2496 | fatal(0, "error deleting expired noticed.db entry: %s", | |
2497 | db_strerror(err)); | |
2498 | break; | |
2499 | } | |
2500 | ++count; | |
2501 | } | |
2502 | if(err == DB_NOTFOUND) | |
2503 | err = 0; | |
2504 | if(err && err != DB_LOCK_DEADLOCK) | |
2505 | fatal(0, "error expiring noticed.db: %s", db_strerror(err)); | |
2506 | ret = err; | |
2507 | if((err = trackdb_closecursor(c))) { | |
2508 | if(err != DB_LOCK_DEADLOCK) | |
2509 | fatal(0, "error closing cursor: %s", db_strerror(err)); | |
2510 | ret = err; | |
2511 | } | |
2512 | if(!ret && count) | |
2513 | info("expired %d tracks from noticed.db", count); | |
2514 | return ret; | |
2515 | } | |
2516 | ||
460b9539 | 2517 | /* tidying up ****************************************************************/ |
2518 | ||
2519 | void trackdb_gc(void) { | |
2520 | int err; | |
2521 | char **logfiles; | |
2522 | ||
2523 | if((err = trackdb_env->txn_checkpoint(trackdb_env, | |
2524 | config->checkpoint_kbyte, | |
2525 | config->checkpoint_min, | |
2526 | 0))) | |
2527 | fatal(0, "trackdb_env->txn_checkpoint: %s", db_strerror(err)); | |
2528 | if((err = trackdb_env->log_archive(trackdb_env, &logfiles, DB_ARCH_REMOVE))) | |
2529 | fatal(0, "trackdb_env->log_archive: %s", db_strerror(err)); | |
2530 | /* This makes catastrophic recovery impossible. However, the user can still | |
2531 | * preserve the important data by using disorder-dump to snapshot their | |
2532 | * prefs, and later to restore it. This is likely to have much small | |
2533 | * long-term storage requirements than record the db logfiles. */ | |
2534 | } | |
2535 | ||
f0feb22e RK |
2536 | /* user database *************************************************************/ |
2537 | ||
2538 | /** @brief Return true if @p user is trusted */ | |
2539 | static int trusted(const char *user) { | |
2540 | int n; | |
2541 | ||
2542 | for(n = 0; (n < config->trust.n | |
2543 | && strcmp(config->trust.s[n], user)); ++n) | |
2544 | ; | |
2545 | return n < config->trust.n; | |
2546 | } | |
2547 | ||
ba39faf6 RK |
2548 | /** @brief Return non-zero for a valid username |
2549 | * | |
2550 | * Currently we only allow the letters and digits in ASCII. We could be more | |
2551 | * liberal than this but it is a nice simple test. It is critical that | |
2552 | * semicolons are never allowed. | |
2553 | */ | |
2554 | static int valid_username(const char *user) { | |
2555 | if(!*user) | |
2556 | return 0; | |
2557 | while(*user) { | |
2558 | const uint8_t c = *user++; | |
2559 | /* For now we are very strict */ | |
2560 | if((c >= 'a' && c <= 'z') | |
2561 | || (c >= 'A' && c <= 'Z') | |
2562 | || (c >= '0' && c <= '9')) | |
2563 | /* ok */; | |
2564 | else | |
2565 | return 0; | |
2566 | } | |
2567 | return 1; | |
2568 | } | |
2569 | ||
f0feb22e RK |
2570 | /** @brief Add a user */ |
2571 | static int create_user(const char *user, | |
2572 | const char *password, | |
2573 | const char *rights, | |
2574 | const char *email, | |
ba39faf6 | 2575 | const char *confirmation, |
f0feb22e RK |
2576 | DB_TXN *tid, |
2577 | uint32_t flags) { | |
2578 | struct kvp *k = 0; | |
2579 | char s[64]; | |
2580 | ||
ba39faf6 RK |
2581 | /* sanity check user */ |
2582 | if(!valid_username(user)) { | |
2583 | error(0, "invalid username '%s'", user); | |
2584 | return -1; | |
2585 | } | |
0f55e905 RK |
2586 | if(parse_rights(rights, 0, 1)) { |
2587 | error(0, "invalid rights string"); | |
2588 | return -1; | |
2589 | } | |
f0feb22e RK |
2590 | /* data for this user */ |
2591 | if(password) | |
2592 | kvp_set(&k, "password", password); | |
2593 | kvp_set(&k, "rights", rights); | |
2594 | if(email) | |
2595 | kvp_set(&k, "email", email); | |
ba39faf6 RK |
2596 | if(confirmation) |
2597 | kvp_set(&k, "confirmation", confirmation); | |
f0feb22e RK |
2598 | snprintf(s, sizeof s, "%jd", (intmax_t)time(0)); |
2599 | kvp_set(&k, "created", s); | |
2600 | return trackdb_putdata(trackdb_usersdb, user, k, tid, flags); | |
2601 | } | |
2602 | ||
2603 | /** @brief Add one pre-existing user */ | |
2604 | static int one_old_user(const char *user, const char *password, | |
2605 | DB_TXN *tid) { | |
2606 | const char *rights; | |
2607 | ||
2608 | /* www-data doesn't get added */ | |
2609 | if(!strcmp(user, "www-data")) { | |
2610 | info("not adding www-data to user database"); | |
2611 | return 0; | |
2612 | } | |
2613 | /* pick rights */ | |
2614 | if(!strcmp(user, "root")) | |
2615 | rights = "all"; | |
0f55e905 RK |
2616 | else if(trusted(user)) { |
2617 | rights_type r; | |
2618 | ||
2619 | parse_rights(config->default_rights, &r, 1); | |
fce810c2 | 2620 | r &= ~(rights_type)(RIGHT_SCRATCH__MASK|RIGHT_MOVE__MASK|RIGHT_REMOVE__MASK); |
0f55e905 RK |
2621 | r |= (RIGHT_ADMIN|RIGHT_RESCAN |
2622 | |RIGHT_SCRATCH_ANY|RIGHT_MOVE_ANY|RIGHT_REMOVE_ANY); | |
2623 | rights = rights_string(r); | |
2624 | } else | |
2625 | rights = config->default_rights; | |
ba39faf6 RK |
2626 | return create_user(user, password, rights, 0/*email*/, 0/*confirmation*/, |
2627 | tid, DB_NOOVERWRITE); | |
f0feb22e RK |
2628 | } |
2629 | ||
2630 | static int trackdb_old_users_tid(DB_TXN *tid) { | |
2631 | int n; | |
2632 | ||
2633 | for(n = 0; n < config->allow.n; ++n) { | |
2634 | switch(one_old_user(config->allow.s[n].s[0], config->allow.s[n].s[1], | |
2635 | tid)) { | |
2636 | case 0: | |
2637 | info("created user %s from 'allow' directive", config->allow.s[n].s[0]); | |
2638 | break; | |
2639 | case DB_KEYEXIST: | |
2640 | error(0, "user %s already exists, delete 'allow' directive", | |
2641 | config->allow.s[n].s[0]); | |
2642 | /* This won't ever become fatal - eventually 'allow' will be | |
2643 | * disabled. */ | |
2644 | break; | |
2645 | case DB_LOCK_DEADLOCK: | |
2646 | return DB_LOCK_DEADLOCK; | |
2647 | } | |
2648 | } | |
2649 | return 0; | |
2650 | } | |
2651 | ||
2652 | /** @brief Read old 'allow' directives and copy them to the users database */ | |
2653 | void trackdb_old_users(void) { | |
2654 | int e; | |
2655 | ||
2656 | if(config->allow.n) | |
2657 | WITH_TRANSACTION(trackdb_old_users_tid(tid)); | |
2658 | } | |
2659 | ||
2660 | /** @brief Create a root user in the user database if there is none */ | |
2661 | void trackdb_create_root(void) { | |
2662 | int e; | |
2663 | uint8_t pwbin[12]; | |
2664 | char *pw; | |
2665 | ||
2666 | /* Choose a new root password */ | |
2667 | gcry_randomize(pwbin, sizeof pwbin, GCRY_STRONG_RANDOM); | |
2668 | pw = mime_to_base64(pwbin, sizeof pwbin); | |
2669 | /* Create the root user if it does not exist */ | |
ba39faf6 RK |
2670 | WITH_TRANSACTION(create_user("root", pw, "all", |
2671 | 0/*email*/, 0/*confirmation*/, | |
2672 | tid, DB_NOOVERWRITE)); | |
f0feb22e RK |
2673 | if(e == 0) |
2674 | info("created root user"); | |
2675 | } | |
2676 | ||
2677 | /** @brief Find a user's password from the database | |
2678 | * @param user Username | |
2679 | * @return Password or NULL | |
2680 | * | |
2681 | * Only works if running as a user that can read the database! | |
2682 | * | |
2683 | * If the user exists but has no password, "" is returned. | |
2684 | */ | |
2685 | const char *trackdb_get_password(const char *user) { | |
2686 | int e; | |
2687 | struct kvp *k; | |
2688 | const char *password; | |
2689 | ||
2690 | WITH_TRANSACTION(trackdb_getdata(trackdb_usersdb, user, &k, tid)); | |
2691 | if(e) | |
2692 | return 0; | |
2693 | password = kvp_get(k, "password"); | |
2694 | return password ? password : ""; | |
2695 | } | |
2696 | ||
2697 | /** @brief Add a new user | |
2698 | * @param user Username | |
2699 | * @param password Password or NULL | |
2700 | * @param rights Initial rights | |
158d0961 | 2701 | * @param email Email address or NULL |
2702 | * @param confirmation Confirmation string or NULL | |
f0feb22e RK |
2703 | * @return 0 on success, non-0 on error |
2704 | */ | |
2705 | int trackdb_adduser(const char *user, | |
2706 | const char *password, | |
0f55e905 | 2707 | const char *rights, |
ba39faf6 RK |
2708 | const char *email, |
2709 | const char *confirmation) { | |
f0feb22e | 2710 | int e; |
f0feb22e | 2711 | |
0f55e905 | 2712 | WITH_TRANSACTION(create_user(user, password, rights, email, confirmation, |
f0feb22e RK |
2713 | tid, DB_NOOVERWRITE)); |
2714 | if(e) { | |
9c722791 | 2715 | error(0, "cannot create user '%s' because they already exist", user); |
f0feb22e RK |
2716 | return -1; |
2717 | } else { | |
2718 | if(email) | |
2719 | info("created user '%s' with rights '%s' and email address '%s'", | |
0f55e905 | 2720 | user, rights, email); |
f0feb22e | 2721 | else |
0f55e905 | 2722 | info("created user '%s' with rights '%s'", user, rights); |
75e7b7c3 | 2723 | eventlog("user_add", user, (char *)0); |
f0feb22e RK |
2724 | return 0; |
2725 | } | |
2726 | } | |
2727 | ||
2728 | /** @brief Delete a user | |
2729 | * @param user User to delete | |
158d0961 | 2730 | * @return 0 on success, non-0 if the user didn't exist anyway |
f0feb22e RK |
2731 | */ |
2732 | int trackdb_deluser(const char *user) { | |
2733 | int e; | |
2734 | ||
2735 | WITH_TRANSACTION(trackdb_delkey(trackdb_usersdb, user, tid)); | |
2736 | if(e) { | |
2737 | error(0, "cannot delete user '%s' because they do not exist", user); | |
2738 | return -1; | |
2739 | } | |
2740 | info("deleted user '%s'", user); | |
75e7b7c3 | 2741 | eventlog("user_delete", user, (char *)0); |
f0feb22e RK |
2742 | return 0; |
2743 | } | |
2744 | ||
2745 | /** @brief Get user information | |
2746 | * @param user User to query | |
2747 | * @return Linked list of user information or NULL if user does not exist | |
2748 | * | |
2749 | * Every user has at least a @c rights entry so NULL can be used to mean no | |
2750 | * such user safely. | |
2751 | */ | |
2752 | struct kvp *trackdb_getuserinfo(const char *user) { | |
2753 | int e; | |
2754 | struct kvp *k; | |
2755 | ||
2756 | WITH_TRANSACTION(trackdb_getdata(trackdb_usersdb, user, &k, tid)); | |
2757 | if(e) | |
2758 | return 0; | |
2759 | else | |
2760 | return k; | |
2761 | } | |
2762 | ||
2763 | /** @brief Edit user information | |
2764 | * @param user User to edit | |
2765 | * @param key Key to change | |
2766 | * @param value Value to set, or NULL to remove | |
2767 | * @param tid Transaction ID | |
2768 | * @return 0, DB_LOCK_DEADLOCK or DB_NOTFOUND | |
2769 | */ | |
2770 | static int trackdb_edituserinfo_tid(const char *user, const char *key, | |
2771 | const char *value, DB_TXN *tid) { | |
2772 | struct kvp *k; | |
2773 | int e; | |
2774 | ||
2775 | if((e = trackdb_getdata(trackdb_usersdb, user, &k, tid))) | |
2776 | return e; | |
2777 | if(!kvp_set(&k, key, value)) | |
2778 | return 0; /* no change */ | |
2779 | return trackdb_putdata(trackdb_usersdb, user, k, tid, 0); | |
2780 | } | |
2781 | ||
2782 | /** @brief Edit user information | |
2783 | * @param user User to edit | |
2784 | * @param key Key to change | |
2785 | * @param value Value to set, or NULL to remove | |
2786 | * @return 0 on success, non-0 on error | |
2787 | */ | |
2788 | int trackdb_edituserinfo(const char *user, | |
2789 | const char *key, const char *value) { | |
2790 | int e; | |
2791 | ||
5df73aeb RK |
2792 | if(!strcmp(key, "rights")) { |
2793 | if(!value) { | |
2794 | error(0, "cannot remove 'rights' key from user '%s'", user); | |
2795 | return -1; | |
2796 | } | |
0f55e905 | 2797 | if(parse_rights(value, 0, 1)) { |
5df73aeb RK |
2798 | error(0, "invalid rights string"); |
2799 | return -1; | |
2800 | } | |
2801 | } else if(!strcmp(key, "email")) { | |
0517868c | 2802 | if(*value) { |
33e95f03 RK |
2803 | if(!email_valid(value)) { |
2804 | error(0, "invalid email address '%s' for user '%s'", value, user); | |
0517868c RK |
2805 | return -1; |
2806 | } | |
2807 | } else | |
2808 | value = 0; /* no email -> remove key */ | |
5df73aeb RK |
2809 | } else if(!strcmp(key, "created")) { |
2810 | error(0, "cannot change creation date for user '%s'", user); | |
2811 | return -1; | |
2812 | } else if(strcmp(key, "password") | |
2813 | && !strcmp(key, "confirmation")) { | |
2814 | error(0, "unknown user info key '%s' for user '%s'", key, user); | |
2815 | return -1; | |
2816 | } | |
f0feb22e | 2817 | WITH_TRANSACTION(trackdb_edituserinfo_tid(user, key, value, tid)); |
5df73aeb RK |
2818 | if(e) { |
2819 | error(0, "unknown user '%s'", user); | |
f0feb22e | 2820 | return -1; |
58d2aad2 | 2821 | } else { |
75e7b7c3 | 2822 | eventlog("user_edit", user, key, (char *)0); |
f0feb22e | 2823 | return 0; |
58d2aad2 | 2824 | } |
f0feb22e RK |
2825 | } |
2826 | ||
c3be4f19 RK |
2827 | /** @brief List all users |
2828 | * @return NULL-terminated list of users | |
2829 | */ | |
2830 | char **trackdb_listusers(void) { | |
2831 | int e; | |
2832 | struct vector v[1]; | |
2833 | ||
2834 | vector_init(v); | |
2835 | WITH_TRANSACTION(trackdb_listkeys(trackdb_usersdb, v, tid)); | |
2836 | return v->vec; | |
2837 | } | |
2838 | ||
30365519 | 2839 | /** @brief Confirm a user registration |
2840 | * @param user Username | |
2841 | * @param confirmation Confirmation string | |
2842 | * @param rightsp Where to put user rights | |
2843 | * @param tid Transaction ID | |
2844 | * @return 0 on success, non-0 on error | |
2845 | */ | |
ba39faf6 | 2846 | static int trackdb_confirm_tid(const char *user, const char *confirmation, |
30365519 | 2847 | rights_type *rightsp, |
ba39faf6 RK |
2848 | DB_TXN *tid) { |
2849 | const char *stored_confirmation; | |
2850 | struct kvp *k; | |
2851 | int e; | |
30365519 | 2852 | const char *rights; |
ba39faf6 RK |
2853 | |
2854 | if((e = trackdb_getdata(trackdb_usersdb, user, &k, tid))) | |
2855 | return e; | |
2856 | if(!(stored_confirmation = kvp_get(k, "confirmation"))) { | |
2857 | error(0, "already confirmed user '%s'", user); | |
2858 | /* DB claims -30,800 to -30,999 so -1 should be a safe bet */ | |
2859 | return -1; | |
2860 | } | |
30365519 | 2861 | if(!(rights = kvp_get(k, "rights"))) { |
2862 | error(0, "no rights for unconfirmed user '%s'", user); | |
2863 | return -1; | |
2864 | } | |
2865 | if(parse_rights(rights, rightsp, 1)) | |
2866 | return -1; | |
ba39faf6 RK |
2867 | if(strcmp(confirmation, stored_confirmation)) { |
2868 | error(0, "wrong confirmation string for user '%s'", user); | |
2869 | return -1; | |
2870 | } | |
2871 | /* 'sall good */ | |
2872 | kvp_set(&k, "confirmation", 0); | |
2873 | return trackdb_putdata(trackdb_usersdb, user, k, tid, 0); | |
2874 | } | |
2875 | ||
2876 | /** @brief Confirm a user registration | |
2877 | * @param user Username | |
2878 | * @param confirmation Confirmation string | |
30365519 | 2879 | * @param rightsp Where to put user rights |
ba39faf6 RK |
2880 | * @return 0 on success, non-0 on error |
2881 | */ | |
30365519 | 2882 | int trackdb_confirm(const char *user, const char *confirmation, |
2883 | rights_type *rightsp) { | |
ba39faf6 RK |
2884 | int e; |
2885 | ||
30365519 | 2886 | WITH_TRANSACTION(trackdb_confirm_tid(user, confirmation, rightsp, tid)); |
ba39faf6 RK |
2887 | switch(e) { |
2888 | case 0: | |
2889 | info("registration confirmed for user '%s'", user); | |
75e7b7c3 | 2890 | eventlog("user_confirm", user, (char *)0); |
ba39faf6 RK |
2891 | return 0; |
2892 | case DB_NOTFOUND: | |
2893 | error(0, "confirmation for nonexistent user '%s'", user); | |
2894 | return -1; | |
2895 | default: /* already reported */ | |
2896 | return -1; | |
2897 | } | |
2898 | } | |
2899 | ||
460b9539 | 2900 | /* |
2901 | Local Variables: | |
2902 | c-basic-offset:2 | |
2903 | comment-column:40 | |
2904 | fill-column:79 | |
2905 | indent-tabs-mode:nil | |
2906 | End: | |
2907 | */ |