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