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