2 * This file is part of DisOrder
3 * Copyright (C) 2005-2008 Richard Kettlewell
5 * This program is free software: you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation, either version 3 of the License, or
8 * (at your option) any later version.
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.
15 * You should have received a copy of the GNU General Public License
16 * along with this program. If not, see <http://www.gnu.org/licenses/>.
18 /** @file lib/trackdb.c
19 * @brief Track database
21 * This file is getting in desparate need of splitting up...
27 #include <sys/socket.h>
33 #include <sys/resource.h>
35 #include <arpa/inet.h>
47 #include "configuration.h"
52 #include "trackname.h"
53 #include "trackdb-int.h"
63 #define RESCAN "disorder-rescan"
64 #define DEADLOCK "disorder-deadlock"
66 static const char *getpart(const char *track,
71 static char **trackdb_new_tid(int *ntracksp,
74 static int trackdb_expire_noticed_tid(time_t earliest, DB_TXN *tid);
75 static char *normalize_tag(const char *s, size_t ns);
77 const struct cache_type cache_files_type = { 86400 };
78 unsigned long cache_files_hits, cache_files_misses;
80 /** @brief Set by trackdb_open() */
81 int trackdb_existing_database;
83 /* setup and teardown ********************************************************/
85 /** @brief Database home directory
87 * All database files live below here. It had better never change.
89 static const char *home;
91 /** @brief Database environment */
94 /** @brief The tracks database
95 * - Keys are UTF-8(NFC(unicode(path name)))
96 * - Values are encoded key-value pairs
97 * - Data is reconstructable data about tracks that currently exist
101 /** @brief The preferences database
103 * - Keys are UTF-8(NFC(unicode(path name)))
104 * - Values are encoded key-value pairs
105 * - Data is user data about tracks (that might not exist any more)
106 * and cannot be reconstructed
110 /** @brief The search database
112 * - Keys are UTF-8(NFKC(casefold(search term)))
113 * - Values are UTF-8(NFC(unicode(path name)))
114 * - There can be more than one value per key
115 * - Presence of key,value means that path matches the search terms
116 * - Only tracks fond in @ref trackdb_tracksdb are represented here
117 * - This database can be reconstructed, it contains no user data
119 DB *trackdb_searchdb;
121 /** @brief The tags database
123 * - Keys are UTF-8(NFKC(casefold(tag)))
124 * - Values are UTF-8(NFC(unicode(path name)))
125 * - There can be more than one value per key
126 * - Presence of key,value means that path matches the tag
127 * - This is always in sync with the tags preference
128 * - This database can be reconstructed, it contains no user data
130 DB *trackdb_tagsdb; /* the tags database */
132 /** @brief The global preferences database
133 * - Keys are UTF-8(NFC(preference))
134 * - Values are global preference values
135 * - Data is user data and cannot be reconstructed
137 DB *trackdb_globaldb; /* global preferences */
139 /** @brief The noticed database
140 * - Keys are 64-bit big-endian timestamps
141 * - Values are UTF-8(NFC(unicode(path name)))
142 * - There can be more than one value per key
143 * - Presence of key,value means that path was added at the given time
144 * - Data cannot be reconstructed (but isn't THAT important)
146 DB *trackdb_noticeddb; /* when track noticed */
148 /** @brief The schedule database
150 * - Keys are ID strings, generated at random
151 * - Values are encoded key-value pairs
152 * - There can be more than one value per key
153 * - Data cannot be reconstructed
155 * See @ref server/schedule.c for further information.
157 DB *trackdb_scheduledb;
159 /** @brief The user database
160 * - Keys are usernames
161 * - Values are encoded key-value pairs
162 * - Data is user data and cannot be reconstructed
166 /** @brief The playlists database
167 * - Keys are playlist names
168 * - Values are encoded key-value pairs
169 * - Data is user data and cannot be reconstructed
171 DB *trackdb_playlistsdb;
173 /** @brief Deadlock manager PID */
174 static pid_t db_deadlock_pid = -1;
176 /** @brief Rescanner PID */
177 static pid_t rescan_pid = -1;
179 /** @brief Set when the database environment exists */
180 static int initialized;
182 /** @brief Set when databases are open */
185 /** @brief Current stats subprocess PIDs */
186 static hash *stats_pids;
188 /** @brief PID of current random track chooser (disorder-choose) */
189 static pid_t choose_pid = -1;
191 /** @brief Our end of pipe from disorder-choose */
192 static int choose_fd;
194 /** @brief Callback to supply random track to */
195 static random_callback *choose_callback;
197 /** @brief Accumulator for output from disorder-choose */
198 static struct dynstr choose_output;
200 /** @brief Current completion status of disorder-choose
201 * A bitmap of @ref CHOOSE_READING and @ref CHOOSE_RUNNING.
203 static unsigned choose_complete;
205 /* @brief Exit status from disorder-choose */
206 static int choose_status;
208 /** @brief disorder-choose process is running */
209 #define CHOOSE_RUNNING 1
211 /** @brief disorder-choose pipe is still open */
212 #define CHOOSE_READING 2
214 /** @brief Comparison function for filename-based keys */
215 static int compare(DB attribute((unused)) *db_,
216 const DBT *a, const DBT *b) {
217 return compare_path_raw(a->data, a->size, b->data, b->size);
220 /** @brief Test whether the track database can be read
221 * @return 1 if it can, 0 if it cannot
223 int trackdb_readable(void) {
226 byte_xasprintf(&usersdb, "%s/users.db", config->home);
227 return access(usersdb, R_OK) == 0;
230 /** @brief Open database environment
231 * @param flags Flags word
233 * Flags should be one of:
234 * - @ref TRACKDB_NO_RECOVER
235 * - @ref TRACKDB_NORMAL_RECOVER
236 * - @ref TRACKDB_FATAL_RECOVER
237 * - @ref TRACKDB_MAY_CREATE
239 void trackdb_init(int flags) {
241 const int recover = flags & TRACKDB_RECOVER_MASK;
242 static int recover_type[] = { 0, DB_RECOVER, DB_RECOVER_FATAL };
245 assert(initialized == 0);
248 if(strcmp(home, config->home))
249 fatal(0, "cannot change db home without server restart");
253 if(flags & TRACKDB_MAY_CREATE) {
259 /* Remove world/group permissions on any regular files already in the
260 * database directory. Actually we don't care about all of them but it's
261 * easier to just do the lot. This can be revisited if it's a serious
262 * practical inconvenience for anyone.
264 * The socket, not being a regular file, is excepted.
266 if(!(dp = opendir(config->home)))
267 fatal(errno, "error reading %s", config->home);
268 while((de = readdir(dp))) {
269 byte_xasprintf(&p, "%s/%s", config->home, de->d_name);
270 if(lstat(p, &st) == 0
271 && S_ISREG(st.st_mode)
272 && (st.st_mode & 077)) {
273 if(chmod(p, st.st_mode & 07700) < 0)
274 fatal(errno, "cannot chmod %s", p);
281 /* create environment */
282 if((err = db_env_create(&trackdb_env, 0))) fatal(0, "db_env_create: %s",
284 if((err = trackdb_env->set_alloc(trackdb_env,
285 xmalloc_noptr, xrealloc_noptr, xfree)))
286 fatal(0, "trackdb_env->set_alloc: %s", db_strerror(err));
287 if((err = trackdb_env->set_lk_max_locks(trackdb_env, 10000)))
288 fatal(0, "trackdb_env->set_lk_max_locks: %s", db_strerror(err));
289 if((err = trackdb_env->set_lk_max_objects(trackdb_env, 10000)))
290 fatal(0, "trackdb_env->set_lk_max_objects: %s", db_strerror(err));
291 if((err = trackdb_env->open(trackdb_env, config->home,
297 |recover_type[recover],
299 fatal(0, "trackdb_env->open %s: %s", config->home, db_strerror(err));
300 trackdb_env->set_errpfx(trackdb_env, "DB");
301 trackdb_env->set_errfile(trackdb_env, stderr);
302 trackdb_env->set_verbose(trackdb_env, DB_VERB_DEADLOCK, 1);
303 trackdb_env->set_verbose(trackdb_env, DB_VERB_RECOVERY, 1);
304 trackdb_env->set_verbose(trackdb_env, DB_VERB_REPLICATION, 1);
305 D(("initialized database environment"));
308 /** @brief Called when deadlock manager terminates */
309 static int reap_db_deadlock(ev_source attribute((unused)) *ev,
310 pid_t attribute((unused)) pid,
312 const struct rusage attribute((unused)) *rusage,
313 void attribute((unused)) *u) {
314 db_deadlock_pid = -1;
316 fatal(0, "deadlock manager unexpectedly terminated: %s",
319 D(("deadlock manager terminated: %s", wstat(status)));
323 /** @brief Start a subprogram
324 * @param ev Event loop
325 * @param outputfd File descriptor to redirect @c stdout to, or -1
326 * @param prog Program name
327 * @param ... Arguments
330 * Starts a subprocess. Adds the following arguments:
331 * - @c --config to ensure the right config file is used
332 * - @c --debug or @c --no-debug to match debug settings
333 * - @c --syslog or @c --no-syslog to match log settings
335 static pid_t subprogram(ev_source *ev, int outputfd, const char *prog,
339 const char *args[1024], **argp, *a;
343 *argp++ = "--config";
344 *argp++ = configfile;
345 *argp++ = debugging ? "--debug" : "--no-debug";
346 *argp++ = log_default == &log_syslog ? "--syslog" : "--no-syslog";
348 while((a = va_arg(ap, const char *)))
352 /* If we're in the background then trap subprocess stdout/stderr */
353 if(!(pid = xfork())) {
356 ev_signal_atfork(ev);
357 signal(SIGPIPE, SIG_DFL);
362 /* ensure we don't leak privilege anywhere */
363 if(setuid(geteuid()) < 0)
364 fatal(errno, "error calling setuid");
365 /* If we were negatively niced, undo it. We don't bother checking for
366 * error, it's not that important. */
367 setpriority(PRIO_PROCESS, 0, 0);
368 execvp(prog, (char **)args);
369 fatal(errno, "error invoking %s", prog);
374 /** @brief Start deadlock manager
375 * @param ev Event loop
377 * Called from the main server (only).
379 void trackdb_master(ev_source *ev) {
380 assert(db_deadlock_pid == -1);
381 db_deadlock_pid = subprogram(ev, -1, DEADLOCK, (char *)0);
382 ev_child(ev, db_deadlock_pid, 0, reap_db_deadlock, 0);
383 D(("started deadlock manager"));
386 /** @brief Kill a subprocess and wait for it to terminate
387 * @param ev Event loop or NULL
388 * @param pid Process ID or -1
389 * @param what Description of subprocess
391 * Used during trackdb_deinit(). This function blocks so don't use it for
392 * normal teardown as that will hang the server.
394 static void terminate_and_wait(ev_source *ev,
401 if(kill(pid, SIGTERM) < 0)
402 fatal(errno, "error killing %s", what);
403 /* wait for the rescanner to finish */
404 while(waitpid(pid, &err, 0) == -1 && errno == EINTR)
407 ev_child_cancel(ev, pid);
410 /** @brief Close database environment
411 * @param ev Event loop
413 void trackdb_deinit(ev_source *ev) {
417 assert(initialized == 1);
420 /* close the environment */
421 if((err = trackdb_env->close(trackdb_env, 0)))
422 fatal(0, "trackdb_env->close: %s", db_strerror(err));
424 terminate_and_wait(ev, rescan_pid, "disorder-rescan");
426 terminate_and_wait(ev, choose_pid, "disorder-choose");
430 char **ks = hash_keys(stats_pids);
433 pid_t pid = atoi(*ks++);
434 terminate_and_wait(ev, pid, "disorder-stats");
439 terminate_and_wait(ev, db_deadlock_pid, "disorder-deadlock");
440 db_deadlock_pid = -1;
441 D(("deinitialized database environment"));
444 /** @brief Open a specific database
445 * @param path Relative path to database
446 * @param dbflags Database flags: DB_DUP, DB_DUPSORT, etc
447 * @param dbtype Database type: DB_HASH, DB_BTREE, etc
448 * @param openflags Open flags: DB_RDONLY, DB_CREATE, etc
449 * @param mode Permission mask: usually 0666
450 * @return Database handle
452 static DB *open_db(const char *path,
460 D(("open %s", path));
461 path = config_get_file(path);
462 if((err = db_create(&db, trackdb_env, 0)))
463 fatal(0, "db_create %s: %s", path, db_strerror(err));
465 if((err = db->set_flags(db, dbflags)))
466 fatal(0, "db->set_flags %s: %s", path, db_strerror(err));
467 if(dbtype == DB_BTREE)
468 if((err = db->set_bt_compare(db, compare)))
469 fatal(0, "db->set_bt_compare %s: %s", path, db_strerror(err));
470 if((err = db->open(db, 0, path, 0, dbtype,
471 openflags | DB_AUTO_COMMIT, mode))) {
472 if((openflags & DB_CREATE) || errno != ENOENT) {
473 if((err2 = db->close(db, 0)))
474 error(0, "db->close: %s", db_strerror(err2));
476 trackdb_env->close(trackdb_env,0);
478 fatal(0, "db->open %s: %s", path, db_strerror(err));
486 /** @brief Open track databases
487 * @param flags Flags flags word
489 * @p flags should have one of:
490 * - @p TRACKDB_NO_UPGRADE, if no upgrade should be attempted
491 * - @p TRACKDB_CAN_UPGRADE, if an upgrade may be attempted
492 * - @p TRACKDB_OPEN_FOR_UPGRADE, if this is disorder-dbupgrade
494 * - @p TRACKDB_READ_ONLY, read only access
496 void trackdb_open(int flags) {
499 uint32_t dbflags = flags & TRACKDB_READ_ONLY ? DB_RDONLY : DB_CREATE;
504 /* check the database version first */
505 trackdb_globaldb = open_db("global.db", 0, DB_HASH, DB_RDONLY, 0666);
506 if(trackdb_globaldb) {
507 /* This is an existing database */
511 s = trackdb_get_global("_dbversion");
512 /* Close the database again, we'll open it property below */
513 if((err = trackdb_globaldb->close(trackdb_globaldb, 0)))
514 fatal(0, "error closing global.db: %s", db_strerror(err));
515 trackdb_globaldb = 0;
516 /* Convert version string to an integer */
517 oldversion = s ? atol(s) : 1;
518 if(oldversion > config->dbversion) {
519 /* Database is from the future; we never allow this. */
520 fatal(0, "this version of DisOrder is too old for database version %ld",
523 if(oldversion < config->dbversion) {
524 /* Database version is out of date */
525 switch(flags & TRACKDB_UPGRADE_MASK) {
526 case TRACKDB_NO_UPGRADE:
527 /* This database needs upgrading but this is not permitted */
528 fatal(0, "database needs upgrading from %ld to %ld",
529 oldversion, config->dbversion);
530 case TRACKDB_CAN_UPGRADE:
531 /* This database needs upgrading */
532 info("invoking disorder-dbupgrade to upgrade from %ld to %ld",
533 oldversion, config->dbversion);
534 pid = subprogram(0, -1, "disorder-dbupgrade", (char *)0);
535 while(waitpid(pid, &err, 0) == -1 && errno == EINTR)
538 fatal(0, "disorder-dbupgrade %s", wstat(err));
539 info("disorder-dbupgrade succeeded");
541 case TRACKDB_OPEN_FOR_UPGRADE:
547 if(oldversion == config->dbversion && (flags & TRACKDB_OPEN_FOR_UPGRADE)) {
548 /* This doesn't make any sense */
549 fatal(0, "database is already at current version");
551 trackdb_existing_database = 1;
553 if(flags & TRACKDB_OPEN_FOR_UPGRADE) {
554 /* Cannot upgrade a new database */
555 fatal(0, "cannot upgrade a database that does not exist");
557 /* This is a brand new database */
558 trackdb_existing_database = 0;
560 /* open the databases */
561 if(!(trackdb_usersdb = open_db("users.db",
562 0, DB_HASH, dbflags, 0600)))
563 fatal(0, "cannot open users.db");
564 trackdb_tracksdb = open_db("tracks.db",
565 DB_RECNUM, DB_BTREE, dbflags, 0666);
566 trackdb_searchdb = open_db("search.db",
567 DB_DUP|DB_DUPSORT, DB_HASH, dbflags, 0666);
568 trackdb_tagsdb = open_db("tags.db",
569 DB_DUP|DB_DUPSORT, DB_HASH, dbflags, 0666);
570 trackdb_prefsdb = open_db("prefs.db", 0, DB_HASH, dbflags, 0666);
571 trackdb_globaldb = open_db("global.db", 0, DB_HASH, dbflags, 0666);
572 trackdb_noticeddb = open_db("noticed.db",
573 DB_DUPSORT, DB_BTREE, dbflags, 0666);
574 trackdb_scheduledb = open_db("schedule.db", 0, DB_HASH, dbflags, 0666);
575 trackdb_playlistsdb = open_db("playlists.db", 0, DB_HASH, dbflags, 0666);
576 if(!trackdb_existing_database && !(flags & TRACKDB_READ_ONLY)) {
577 /* Stash the database version */
580 assert(!(flags & TRACKDB_OPEN_FOR_UPGRADE));
581 snprintf(buf, sizeof buf, "%ld", config->dbversion);
582 trackdb_set_global("_dbversion", buf, 0);
584 D(("opened databases"));
587 /** @brief Close track databases */
588 void trackdb_close(void) {
594 #define CLOSE(N, V) do { \
595 if(V && (err = V->close(V, 0))) \
596 fatal(0, "error closing %s: %s", N, db_strerror(err)); \
599 CLOSE("tracks.db", trackdb_tracksdb);
600 CLOSE("search.db", trackdb_searchdb);
601 CLOSE("tags.db", trackdb_tagsdb);
602 CLOSE("prefs.db", trackdb_prefsdb);
603 CLOSE("global.db", trackdb_globaldb);
604 CLOSE("noticed.db", trackdb_noticeddb);
605 CLOSE("schedule.db", trackdb_scheduledb);
606 CLOSE("users.db", trackdb_usersdb);
607 CLOSE("playlists.db", trackdb_playlistsdb);
608 D(("closed databases"));
611 /* generic db routines *******************************************************/
613 /** @brief Fetch and decode a database entry
615 * @param track Track name
616 * @param kp Where to put decoded list (or NULL if you don't care)
617 * @param tid Owning transaction
618 * @return 0, @c DB_NOTFOUND or @c DB_LOCK_DEADLOCK
620 int trackdb_getdata(DB *db,
627 switch(err = db->get(db, tid, make_key(&key, track),
628 prepare_data(&data), 0)) {
631 *kp = kvp_urldecode(data.data, data.size);
637 case DB_LOCK_DEADLOCK:
638 error(0, "error querying database: %s", db_strerror(err));
641 fatal(0, "error querying database: %s", db_strerror(err));
645 /** @brief Encode and store a database entry
647 * @param track Track name
648 * @param k List of key/value pairs to store
649 * @param tid Owning transaction
650 * @param flags DB flags e.g. DB_NOOVERWRITE
651 * @return 0, DB_KEYEXIST or DB_LOCK_DEADLOCK
653 int trackdb_putdata(DB *db,
661 switch(err = db->put(db, tid, make_key(&key, track),
662 encode_data(&data, k), flags)) {
666 case DB_LOCK_DEADLOCK:
667 error(0, "error updating database: %s", db_strerror(err));
670 fatal(0, "error updating database: %s", db_strerror(err));
674 /** @brief Delete a database entry
676 * @param track Key to delete
677 * @param tid Transaction ID
678 * @return 0, DB_NOTFOUND or DB_LOCK_DEADLOCK
680 int trackdb_delkey(DB *db,
686 switch(err = db->del(db, tid, make_key(&key, track), 0)) {
690 case DB_LOCK_DEADLOCK:
691 error(0, "error updating database: %s", db_strerror(err));
694 fatal(0, "error updating database: %s", db_strerror(err));
698 /* open a database cursor */
699 DBC *trackdb_opencursor(DB *db, DB_TXN *tid) {
703 switch(err = db->cursor(db, tid, &c, 0)) {
705 default: fatal(0, "error creating cursor: %s", db_strerror(err));
710 /* close a database cursor; returns 0 or DB_LOCK_DEADLOCK */
711 int trackdb_closecursor(DBC *c) {
715 switch(err = c->c_close(c)) {
718 case DB_LOCK_DEADLOCK:
719 error(0, "error closing cursor: %s", db_strerror(err));
722 fatal(0, "error closing cursor: %s", db_strerror(err));
726 /* delete a (key,data) pair. Returns 0, DB_NOTFOUND or DB_LOCK_DEADLOCK. */
727 int trackdb_delkeydata(DB *db,
735 c = trackdb_opencursor(db, tid);
736 switch(err = c->c_get(c, make_key(&key, word),
737 make_key(&data, track), DB_GET_BOTH)) {
739 switch(err = c->c_del(c, 0)) {
745 case DB_LOCK_DEADLOCK:
746 error(0, "error updating database: %s", db_strerror(err));
749 fatal(0, "c->c_del: %s", db_strerror(err));
754 case DB_LOCK_DEADLOCK:
755 error(0, "error updating database: %s", db_strerror(err));
758 fatal(0, "c->c_get: %s", db_strerror(err));
760 if(trackdb_closecursor(c)) err = DB_LOCK_DEADLOCK;
764 /* start a transaction */
765 DB_TXN *trackdb_begin_transaction(void) {
769 if((err = trackdb_env->txn_begin(trackdb_env, 0, &tid, 0)))
770 fatal(0, "trackdb_env->txn_begin: %s", db_strerror(err));
774 /* abort transaction */
775 void trackdb_abort_transaction(DB_TXN *tid) {
779 if((err = tid->abort(tid)))
780 fatal(0, "tid->abort: %s", db_strerror(err));
783 /* commit transaction */
784 void trackdb_commit_transaction(DB_TXN *tid) {
787 if((err = tid->commit(tid, 0)))
788 fatal(0, "tid->commit: %s", db_strerror(err));
791 /* search/tags shared code ***************************************************/
793 /* comparison function used by dedupe() */
794 static int wordcmp(const void *a, const void *b) {
795 return strcmp(*(const char **)a, *(const char **)b);
798 /* sort and de-dupe VEC */
799 static char **dedupe(char **vec, int nvec) {
802 qsort(vec, nvec, sizeof (char *), wordcmp);
806 for(n = 1; n < nvec; ++n)
807 if(strcmp(vec[n], vec[m - 1]))
814 /* update a key/track database. Returns 0 or DB_DEADLOCK. */
815 static int register_word(DB *db, const char *what,
816 const char *track, const char *word,
821 switch(err = db->put(db, tid, make_key(&key, word),
822 make_key(&data, track), DB_NODUPDATA)) {
826 case DB_LOCK_DEADLOCK:
827 error(0, "error updating %s.db: %s", what, db_strerror(err));
830 fatal(0, "error updating %s.db: %s", what, db_strerror(err));
834 /* search primitives *********************************************************/
836 /* return true iff NAME is a trackname_display_ pref */
837 static int is_display_pref(const char *name) {
838 static const char prefix[] = "trackname_display_";
839 return !strncmp(name, prefix, (sizeof prefix) - 1);
842 /** @brief Word_Break property tailor that treats underscores as spaces */
843 static int tailor_underscore_Word_Break_Other(uint32_t c) {
847 case 0x005F: /* LOW LINE (SPACING UNDERSCORE) */
848 return unicode_Word_Break_Other;
852 /** @brief Remove all combining characters in-place
853 * @param s Pointer to start of string
854 * @param ns Length of string
855 * @return New, possiblby reduced, length
857 static size_t remove_combining_chars(uint32_t *s, size_t ns) {
858 uint32_t *start = s, *t = s, *end = s + ns;
861 const uint32_t c = *s++;
862 if(!utf32_combining_class(c))
868 /** @brief Normalize and split a string using a given tailoring */
869 static void word_split(struct vector *v,
871 unicode_property_tailor *pt) {
873 uint32_t *t32, **w32;
875 /* Convert to UTF-32 */
876 if(!(t32 = utf8_to_utf32(s, strlen(s), &nt32)))
878 /* Erase case distinctions */
879 if(!(t32 = utf32_casefold_compat(t32, nt32, &nt32)))
881 /* Drop combining characters */
882 nt32 = remove_combining_chars(t32, nt32);
883 /* Split into words, treating _ as a space */
884 w32 = utf32_word_split(t32, nt32, &nw, pt);
885 /* Convert words back to UTF-8 and append to result */
886 for(i = 0; i < nw; ++i)
887 vector_append(v, utf32_to_utf8(w32[i], utf32_len(w32[i]), 0));
890 /** @brief Normalize a tag
892 * @param ns Length of tag
893 * @return Normalized string or NULL on error
895 * The return value will be:
897 * - have no leading or trailing space
898 * - have no combining characters
899 * - all spacing between words will be a single U+0020 SPACE
901 static char *normalize_tag(const char *s, size_t ns) {
902 uint32_t *s32, **w32;
903 size_t ns32, nw32, i;
906 if(!(s32 = utf8_to_utf32(s, ns, &ns32)))
908 if(!(s32 = utf32_casefold_compat(s32, ns32, &ns32))) /* ->NFKD */
910 ns32 = remove_combining_chars(s32, ns32);
911 /* Split into words, no Word_Break tailoring */
912 w32 = utf32_word_split(s32, ns32, &nw32, 0);
913 /* Compose back into a string */
915 for(i = 0; i < nw32; ++i) {
917 dynstr_append(d, ' ');
918 dynstr_append_string(d, utf32_to_utf8(w32[i], utf32_len(w32[i]), 0));
924 /* compute the words of a track name */
925 static char **track_to_words(const char *track,
926 const struct kvp *p) {
928 const char *rootless = track_rootless(track);
931 rootless = track; /* bodge */
933 rootless = strip_extension(rootless);
934 word_split(&v, strip_extension(rootless), tailor_underscore_Word_Break_Other);
935 for(; p; p = p->next)
936 if(is_display_pref(p->name))
937 word_split(&v, p->value, 0);
938 vector_terminate(&v);
939 return dedupe(v.vec, v.nvec);
942 /* return nonzero iff WORD is a stopword */
943 static int stopword(const char *word) {
946 for(n = 0; n < config->stopword.n
947 && strcmp(word, config->stopword.s[n]); ++n)
949 return n < config->stopword.n;
952 /* record that WORD appears in TRACK. Returns 0 or DB_LOCK_DEADLOCK. */
953 static int register_search_word(const char *track, const char *word,
955 if(stopword(word)) return 0;
956 return register_word(trackdb_searchdb, "search", track, word, tid);
959 /* Tags **********************************************************************/
961 /* Return nonzero if C is a valid tag character */
962 static int tagchar(int c) {
971 /* Parse and de-dupe a tag list. If S=0 then assumes "". */
972 char **parsetags(const char *s) {
978 /* skip initial separators */
979 while(*s && (!tagchar(*s) || *s == ' '))
982 /* find the extent of the tag */
984 while(*s && tagchar(*s))
986 /* strip trailing spaces */
987 while(s > t && s[-1] == ' ')
989 /* add tag to list */
990 vector_append(&v, normalize_tag(t, (size_t)(s - t)));
991 /* skip intermediate and trailing separators */
992 while(*s && (!tagchar(*s) || *s == ' '))
996 vector_terminate(&v);
997 return dedupe(v.vec, v.nvec);
1000 /* Record that TRACK has TAG. Returns 0 or DB_LOCK_DEADLOCK. */
1001 static int register_tag(const char *track, const char *tag, DB_TXN *tid) {
1002 return register_word(trackdb_tagsdb, "tags", track, tag, tid);
1005 /* aliases *******************************************************************/
1007 /* compute the alias and store at aliasp. Returns 0 or DB_LOCK_DEADLOCK. If
1008 * there is no alias sets *aliasp to 0. */
1009 static int compute_alias(char **aliasp,
1011 const struct kvp *p,
1014 const char *s = config->alias, *t, *expansion, *part;
1015 int c, used_db = 0, slash_prefix, err;
1017 const char *const root = find_track_root(track);
1020 /* Bodge for tracks with no root */
1025 dynstr_append_string(&d, root);
1026 while((c = (unsigned char)*s++)) {
1028 dynstr_append(&d, c);
1031 if((slash_prefix = (*s == '/')))
1034 assert(t != 0); /* validated at startup */
1035 part = xstrndup(s, t - s);
1036 expansion = getpart(track, "display", part, p, &used_db);
1038 if(slash_prefix) dynstr_append(&d, '/');
1039 dynstr_append_string(&d, expansion);
1041 s = t + 1; /* skip {part} */
1043 /* only admit to the alias if we used the db... */
1048 dynstr_terminate(&d);
1049 /* ...and the answer differs from the original... */
1050 if(!strcmp(track, d.vec)) {
1054 /* ...and there isn't already a different track with that name (including as
1056 switch(err = trackdb_getdata(trackdb_tracksdb, d.vec, &at, tid)) {
1058 if((s = kvp_get(at, "_alias_for"))
1059 && !strcmp(s, track)) {
1071 /* get track and prefs data (if tp/pp not null pointers). Returns 0 on
1072 * success, DB_NOTFOUND if the track does not exist or DB_LOCK_DEADLOCK.
1073 * Always sets the return values, even if only to null pointers. */
1074 static int gettrackdata(const char *track,
1077 const char **actualp,
1079 #define GTD_NOALIAS 0x0001
1082 const char *actual = track;
1083 struct kvp *t = 0, *p = 0;
1085 if((err = trackdb_getdata(trackdb_tracksdb, track, &t, tid))) goto done;
1086 if((actual = kvp_get(t, "_alias_for"))) {
1087 if(flags & GTD_NOALIAS) {
1088 error(0, "alias passed to gettrackdata where real path required");
1091 if((err = trackdb_getdata(trackdb_tracksdb, actual, &t, tid))) goto done;
1094 assert(actual != 0);
1096 if((err = trackdb_getdata(trackdb_prefsdb, actual, &p, tid)) == DB_LOCK_DEADLOCK)
1101 if(actualp) *actualp = actual;
1107 /* trackdb_notice() **********************************************************/
1109 /** @brief notice a possibly new track
1110 * @return @c DB_NOTFOUND if new, 0 if already known
1112 int trackdb_notice(const char *track,
1118 tid = trackdb_begin_transaction();
1119 err = trackdb_notice_tid(track, path, tid);
1120 if((err == DB_LOCK_DEADLOCK)) goto fail;
1123 trackdb_abort_transaction(tid);
1125 trackdb_commit_transaction(tid);
1129 /** @brief notice a possibly new track
1130 * @param track NFC UTF-8 track name
1131 * @param path Raw path name
1132 * @param tid Transaction ID
1133 * @return @c DB_NOTFOUND if new, 0 if already known, @c DB_LOCK_DEADLOCK also
1135 int trackdb_notice_tid(const char *track,
1139 struct kvp *t, *a, *p;
1141 char *alias, **w, *noticed;
1144 /* notice whether the tracks.db entry changes */
1146 /* get any existing tracks entry */
1147 if((err = gettrackdata(track, &t, &p, 0, 0, tid)) == DB_LOCK_DEADLOCK)
1149 ret = err; /* 0 or DB_NOTFOUND */
1150 /* this is a real track */
1151 t_changed += kvp_set(&t, "_alias_for", 0);
1152 t_changed += kvp_set(&t, "_path", path);
1154 if(ret == DB_NOTFOUND) {
1155 /* It's a new track; record the time */
1156 byte_xasprintf(¬iced, "%lld", (long long)now);
1157 t_changed += kvp_set(&t, "_noticed", noticed);
1159 /* if we have an alias record it in the database */
1160 if((err = compute_alias(&alias, track, p, tid))) return err;
1162 /* won't overwrite someone else's alias as compute_alias() checks */
1163 D(("%s: alias %s", track, alias));
1165 kvp_set(&a, "_alias_for", track);
1166 if((err = trackdb_putdata(trackdb_tracksdb, alias, a, tid, 0))) return err;
1168 /* update search.db */
1169 w = track_to_words(track, p);
1170 for(n = 0; w[n]; ++n)
1171 if((err = register_search_word(track, w[n], tid)))
1173 /* update tags.db */
1174 w = parsetags(kvp_get(p, "tags"));
1175 for(n = 0; w[n]; ++n)
1176 if((err = register_tag(track, w[n], tid)))
1178 /* only store the tracks.db entry if it has changed */
1179 if(t_changed && (err = trackdb_putdata(trackdb_tracksdb, track, t, tid, 0)))
1181 if(ret == DB_NOTFOUND) {
1182 uint32_t timestamp[2];
1185 timestamp[0] = htonl((uint64_t)now >> 32);
1186 timestamp[1] = htonl((uint32_t)now);
1187 memset(&key, 0, sizeof key);
1188 key.data = timestamp;
1189 key.size = sizeof timestamp;
1190 switch(err = trackdb_noticeddb->put(trackdb_noticeddb, tid, &key,
1191 make_key(&data, track), 0)) {
1193 case DB_LOCK_DEADLOCK: return err;
1194 default: fatal(0, "error updating noticed.db: %s", db_strerror(err));
1200 /* trackdb_obsolete() ********************************************************/
1202 /* obsolete a track */
1203 int trackdb_obsolete(const char *track, DB_TXN *tid) {
1208 if((err = gettrackdata(track, 0, &p, 0,
1209 GTD_NOALIAS, tid)) == DB_LOCK_DEADLOCK)
1211 else if(err == DB_NOTFOUND) return 0;
1212 /* compute the alias, if any, and delete it */
1213 if((err = compute_alias(&alias, track, p, tid))) return err;
1215 /* if the alias points to some other track then compute_alias won't
1217 if((err = trackdb_delkey(trackdb_tracksdb, alias, tid))
1218 && err != DB_NOTFOUND)
1221 /* update search.db */
1222 w = track_to_words(track, p);
1223 for(n = 0; w[n]; ++n)
1224 if(trackdb_delkeydata(trackdb_searchdb,
1225 w[n], track, tid) == DB_LOCK_DEADLOCK)
1227 /* update tags.db */
1228 w = parsetags(kvp_get(p, "tags"));
1229 for(n = 0; w[n]; ++n)
1230 if(trackdb_delkeydata(trackdb_tagsdb,
1231 w[n], track, tid) == DB_LOCK_DEADLOCK)
1233 /* update tracks.db */
1234 if(trackdb_delkey(trackdb_tracksdb, track, tid) == DB_LOCK_DEADLOCK)
1236 /* We don't delete the prefs, so they survive temporary outages of the
1237 * (possibly virtual) track filesystem */
1241 /* trackdb_stats() ***********************************************************/
1243 #define H(name) { #name, offsetof(DB_HASH_STAT, name) }
1244 #define B(name) { #name, offsetof(DB_BTREE_STAT, name) }
1246 static const struct statinfo {
1249 } statinfo_hash[] = {
1265 }, statinfo_btree[] = {
1286 /* look up stats for DB */
1287 static int get_stats(struct vector *v,
1289 const struct statinfo *si,
1298 switch(err = database->stat(database, tid, &sp, 0)) {
1301 case DB_LOCK_DEADLOCK:
1302 error(0, "error querying database: %s", db_strerror(err));
1305 fatal(0, "error querying database: %s", db_strerror(err));
1307 for(n = 0; n < nsi; ++n) {
1308 byte_xasprintf(&str, "%s=%"PRIuMAX, si[n].name,
1309 (uintmax_t)*(u_int32_t *)((char *)sp + si[n].offset));
1310 vector_append(v, str);
1316 /** @brief One entry in the search league */
1317 struct search_entry {
1322 /** @brief Add a word to the search league
1323 * @param se Pointer to search league
1324 * @param count Maximum size for search league
1325 * @param nse Current size of search league
1326 * @param word New word, or NULL
1327 * @param n How often @p word appears
1328 * @return New size of search league
1330 static int register_search_entry(struct search_entry *se,
1337 if(word && (nse < count || n > se[nse - 1].n)) {
1338 /* Find the starting point */
1343 /* Find the insertion point */
1344 while(i > 0 && n > se[i - 1].n)
1346 memmove(&se[i + 1], &se[i], (nse - i - 1) * sizeof *se);
1353 /* find the top COUNT words in the search database */
1354 static int search_league(struct vector *v, int count, DB_TXN *tid) {
1355 struct search_entry *se;
1358 int err, n = 0, nse = 0, i;
1363 cursor = trackdb_opencursor(trackdb_searchdb, tid);
1364 se = xmalloc(count * sizeof *se);
1365 /* Walk across the whole database counting up the number of times each
1367 while(!(err = cursor->c_get(cursor, prepare_data(&k), prepare_data(&d),
1369 if(word && wl == k.size && !strncmp(word, k.data, wl))
1370 ++n; /* same word again */
1372 nse = register_search_entry(se, count, nse, word, n);
1373 word = xstrndup(k.data, wl = k.size);
1381 case DB_LOCK_DEADLOCK:
1382 error(0, "error querying search database: %s", db_strerror(err));
1385 fatal(0, "error querying search database: %s", db_strerror(err));
1387 if(trackdb_closecursor(cursor)) err = DB_LOCK_DEADLOCK;
1389 nse = register_search_entry(se, count, nse, word, n);
1390 byte_xasprintf(&str, "Top %d search words:", nse);
1391 vector_append(v, str);
1392 for(i = 0; i < nse; ++i) {
1393 byte_xasprintf(&str, "%4d: %5d %s", i + 1, se[i].n, se[i].word);
1394 vector_append(v, str);
1399 #define SI(what) statinfo_##what, \
1400 sizeof statinfo_##what / sizeof (struct statinfo)
1402 /* return a list of database stats */
1403 char **trackdb_stats(int *nstatsp) {
1409 tid = trackdb_begin_transaction();
1411 vector_append(&v, (char *)"Tracks database stats:");
1412 if(get_stats(&v, trackdb_tracksdb, SI(btree), tid)) goto fail;
1413 vector_append(&v, (char *)"");
1414 vector_append(&v, (char *)"Search database stats:");
1415 if(get_stats(&v, trackdb_searchdb, SI(hash), tid)) goto fail;
1416 vector_append(&v, (char *)"");
1417 vector_append(&v, (char *)"Prefs database stats:");
1418 if(get_stats(&v, trackdb_prefsdb, SI(hash), tid)) goto fail;
1419 vector_append(&v, (char *)"");
1420 if(search_league(&v, 10, tid)) goto fail;
1421 vector_terminate(&v);
1424 trackdb_abort_transaction(tid);
1426 trackdb_commit_transaction(tid);
1427 if(nstatsp) *nstatsp = v.nvec;
1431 struct stats_details {
1432 void (*done)(char *data, void *u);
1434 int exited; /* subprocess exited */
1435 int closed; /* pipe close */
1436 int wstat; /* wait status from subprocess */
1437 struct dynstr data[1]; /* data read from pipe */
1440 static void stats_complete(struct stats_details *d) {
1443 if(!(d->exited && d->closed))
1445 byte_xasprintf(&s, "\n"
1447 "track lookup cache hits: %lu\n"
1448 "track lookup cache misses: %lu\n",
1450 cache_files_misses);
1451 dynstr_append_string(d->data, s);
1452 dynstr_terminate(d->data);
1453 d->done(d->data->vec, d->u);
1456 static int stats_finished(ev_source attribute((unused)) *ev,
1459 const struct rusage attribute((unused)) *rusage,
1461 struct stats_details *const d = u;
1465 error(0, "disorder-stats %s", wstat(status));
1468 byte_xasprintf(&k, "%lu", (unsigned long)pid);
1469 hash_remove(stats_pids, k);
1473 static int stats_read(ev_source attribute((unused)) *ev,
1479 struct stats_details *const d = u;
1481 dynstr_append_bytes(d->data, ptr, bytes);
1482 ev_reader_consume(reader, bytes);
1489 static int stats_error(ev_source attribute((unused)) *ev,
1492 struct stats_details *const d = u;
1494 error(errno_value, "error reading from pipe to disorder-stats");
1500 void trackdb_stats_subprocess(ev_source *ev,
1501 void (*done)(char *data, void *u),
1505 struct stats_details *d = xmalloc(sizeof *d);
1507 dynstr_init(d->data);
1511 pid = subprogram(ev, p[1], "disorder-stats", (char *)0);
1513 ev_child(ev, pid, 0, stats_finished, d);
1514 if(!ev_reader_new(ev, p[0], stats_read, stats_error, d,
1515 "disorder-stats reader"))
1516 fatal(0, "ev_reader_new for disorder-stats reader failed");
1517 /* Remember the PID */
1519 stats_pids = hash_new(1);
1521 byte_xasprintf(&k, "%lu", (unsigned long)pid);
1522 hash_add(stats_pids, k, "", HASH_INSERT);
1525 /** @brief Parse a track name part preference
1526 * @param name Preference name
1527 * @param partp Where to store part name
1528 * @param contextp Where to store context name
1529 * @return 0 on success, non-0 if parse fails
1531 static int trackdb__parse_namepref(const char *name,
1535 static const char prefix[] = "trackname_";
1537 if(strncmp(name, prefix, strlen(prefix)))
1538 return -1; /* not trackname_* at all */
1539 name += strlen(prefix);
1540 /* There had better be a _ between context and part */
1541 c = strchr(name, '_');
1544 /* Context is first in the pref name even though most APIs have the part
1545 * first. Confusing; sorry. */
1546 *contextp = xstrndup(name, c - name);
1548 /* There had better NOT be a second _ */
1551 *partp = xstrdup(c);
1555 /** @brief Compute the default value for a track preference
1556 * @param track Track name
1557 * @param name Preference name
1558 * @return Default value or 0 if none/not known
1560 static const char *trackdb__default(const char *track, const char *name) {
1561 char *context, *part;
1563 if(!trackdb__parse_namepref(name, &part, &context)) {
1564 /* We can work out the default for a trackname_ pref */
1565 return trackname_part(track, context, part);
1566 } else if(!strcmp(name, "weight")) {
1567 /* We know the default weight */
1569 } else if(!strcmp(name, "pick_at_random")) {
1570 /* By default everything is eligible for picking at random */
1572 } else if(!strcmp(name, "tags")) {
1573 /* By default everything no track has any tags */
1579 /* set a pref (remove if value=0) */
1580 int trackdb_set(const char *track,
1582 const char *value) {
1583 struct kvp *t, *p, *a;
1586 char *oldalias, *newalias, **oldtags = 0, **newtags;
1589 /* If the value matches the default then unset instead, to keep the database
1590 * tidy. Older versions did not have this feature so your database may yet
1591 * have some default values stored in it. */
1593 def = trackdb__default(track, name);
1594 if(def && !strcmp(value, def))
1599 tid = trackdb_begin_transaction();
1600 if((err = gettrackdata(track, &t, &p, 0,
1601 0, tid)) == DB_LOCK_DEADLOCK)
1603 if(err == DB_NOTFOUND) break;
1604 if(name[0] == '_') {
1605 if(kvp_set(&t, name, value))
1606 if(trackdb_putdata(trackdb_tracksdb, track, t, tid, 0))
1609 /* get the old alias name */
1610 if(compute_alias(&oldalias, track, p, tid)) goto fail;
1611 /* get the old tags */
1612 if(!strcmp(name, "tags"))
1613 oldtags = parsetags(kvp_get(p, "tags"));
1615 if(kvp_set(&p, name, value))
1616 if(trackdb_putdata(trackdb_prefsdb, track, p, tid, 0))
1618 /* compute the new alias name */
1619 if((err = compute_alias(&newalias, track, p, tid))) goto fail;
1620 /* check whether alias has changed */
1621 if(!(oldalias == newalias
1622 || (oldalias && newalias && !strcmp(oldalias, newalias)))) {
1623 /* adjust alias records to fit change */
1625 && trackdb_delkey(trackdb_tracksdb, oldalias, tid) == DB_LOCK_DEADLOCK)
1629 kvp_set(&a, "_alias_for", track);
1630 if(trackdb_putdata(trackdb_tracksdb, newalias, a, tid, 0)) goto fail;
1633 /* check whether tags have changed */
1634 if(!strcmp(name, "tags")) {
1635 newtags = parsetags(value);
1636 while(*oldtags || *newtags) {
1637 if(*oldtags && *newtags) {
1638 cmp = strcmp(*oldtags, *newtags);
1640 /* keeping this tag */
1644 /* old tag fits into a gap in the new list, so delete old */
1647 /* new tag fits into a gap in the old list, so insert new */
1649 } else if(*oldtags) {
1650 /* we've run out of new tags, so remaining old ones are to be
1653 if(trackdb_delkeydata(trackdb_tagsdb,
1654 *oldtags, track, tid) == DB_LOCK_DEADLOCK)
1658 /* we've run out of old tags, so remainig new ones are to be
1661 if(register_tag(track, *newtags, tid)) goto fail;
1670 trackdb_abort_transaction(tid);
1672 trackdb_commit_transaction(tid);
1673 return err == 0 ? 0 : -1;
1677 const char *trackdb_get(const char *track,
1679 return kvp_get(trackdb_get_all(track), name);
1682 /* get all prefs as a 0-terminated array */
1683 struct kvp *trackdb_get_all(const char *track) {
1684 struct kvp *t, *p, **pp;
1688 tid = trackdb_begin_transaction();
1689 if(gettrackdata(track, &t, &p, 0, 0, tid) == DB_LOCK_DEADLOCK)
1693 trackdb_abort_transaction(tid);
1695 trackdb_commit_transaction(tid);
1696 for(pp = &p; *pp; pp = &(*pp)->next)
1703 const char *trackdb_resolve(const char *track) {
1708 tid = trackdb_begin_transaction();
1709 if(gettrackdata(track, 0, 0, &actual, 0, tid) == DB_LOCK_DEADLOCK)
1713 trackdb_abort_transaction(tid);
1715 trackdb_commit_transaction(tid);
1719 int trackdb_isalias(const char *track) {
1720 const char *actual = trackdb_resolve(track);
1722 return strcmp(actual, track);
1725 /* test whether a track exists (perhaps an alias) */
1726 int trackdb_exists(const char *track) {
1731 tid = trackdb_begin_transaction();
1732 /* unusually, here we want the return value */
1733 if((err = gettrackdata(track, 0, 0, 0, 0, tid)) == DB_LOCK_DEADLOCK)
1737 trackdb_abort_transaction(tid);
1739 trackdb_commit_transaction(tid);
1743 /* return the list of tags */
1744 char **trackdb_alltags(void) {
1749 WITH_TRANSACTION(trackdb_listkeys(trackdb_tagsdb, v, tid));
1753 /** @brief List all the keys in @p db
1754 * @param db Database
1755 * @param v Vector to store keys in
1756 * @param tid Transaction ID
1757 * @return 0 or DB_LOCK_DEADLOCK
1759 int trackdb_listkeys(DB *db, struct vector *v, DB_TXN *tid) {
1762 DBC *const c = trackdb_opencursor(db, tid);
1765 memset(&k, 0, sizeof k);
1766 while(!(e = c->c_get(c, &k, prepare_data(&d), DB_NEXT_NODUP)))
1767 vector_append(v, xstrndup(k.data, k.size));
1771 case DB_LOCK_DEADLOCK:
1774 fatal(0, "c->c_get: %s", db_strerror(e));
1776 if((e = trackdb_closecursor(c)))
1778 vector_terminate(v);
1782 /* return 1 iff sorted tag lists A and B have at least one member in common */
1783 int tag_intersection(char **a, char **b) {
1786 /* Same sort of logic as trackdb_set() above */
1788 if(!(cmp = strcmp(*a, *b))) return 1;
1789 else if(cmp < 0) ++a;
1795 static void choose_finished(ev_source *ev, unsigned which) {
1796 choose_complete |= which;
1797 if(choose_complete != (CHOOSE_RUNNING|CHOOSE_READING))
1800 if(choose_status == 0 && choose_output.nvec > 0) {
1801 dynstr_terminate(&choose_output);
1802 choose_callback(ev, xstrdup(choose_output.vec));
1804 choose_callback(ev, 0);
1807 /** @brief Called when @c disorder-choose terminates */
1808 static int choose_exited(ev_source *ev,
1809 pid_t attribute((unused)) pid,
1811 const struct rusage attribute((unused)) *rusage,
1812 void attribute((unused)) *u) {
1814 error(0, "disorder-choose %s", wstat(status));
1815 choose_status = status;
1816 choose_finished(ev, CHOOSE_RUNNING);
1820 /** @brief Called with data from @c disorder-choose pipe */
1821 static int choose_readable(ev_source *ev,
1826 void attribute((unused)) *u) {
1827 dynstr_append_bytes(&choose_output, ptr, bytes);
1828 ev_reader_consume(reader, bytes);
1830 choose_finished(ev, CHOOSE_READING);
1834 static int choose_read_error(ev_source *ev,
1836 void attribute((unused)) *u) {
1837 error(errno_value, "error reading disorder-choose pipe");
1838 choose_finished(ev, CHOOSE_READING);
1842 /** @brief Request a random track
1843 * @param ev Event source
1844 * @param callback Called with random track or NULL
1845 * @return 0 if a request was initiated, else -1
1847 * Initiates a random track choice. @p callback will later be called back with
1848 * the choice (or NULL on error). If a choice is already underway then -1 is
1849 * returned and there will be no additional callback.
1851 * The caller shouldn't assume that the track returned actually exists (it
1852 * might be removed between the choice and the callback, or between being added
1853 * to the queue and being played).
1855 int trackdb_request_random(ev_source *ev,
1856 random_callback *callback) {
1859 if(choose_pid != -1)
1860 return -1; /* don't run concurrent chooses */
1863 choose_pid = subprogram(ev, p[1], "disorder-choose", (char *)0);
1866 choose_callback = callback;
1867 choose_output.nvec = 0;
1868 choose_complete = 0;
1869 if(!ev_reader_new(ev, p[0], choose_readable, choose_read_error, 0,
1870 "disorder-choose reader")) /* owns p[0] */
1871 fatal(0, "ev_reader_new for disorder-choose reader failed");
1872 ev_child(ev, choose_pid, 0, choose_exited, 0); /* owns the subprocess */
1876 /* get a track name given the prefs. Set *used_db to 1 if we got the answer
1877 * from the prefs. */
1878 static const char *getpart(const char *track,
1879 const char *context,
1881 const struct kvp *p,
1886 byte_xasprintf(&pref, "trackname_%s_%s", context, part);
1887 if((result = kvp_get(p, pref)))
1890 result = trackname_part(track, context, part);
1891 assert(result != 0);
1895 /* get a track name part, like trackname_part(), but taking the database into
1897 const char *trackdb_getpart(const char *track,
1898 const char *context,
1906 /* construct the full pref */
1907 byte_xasprintf(&pref, "trackname_%s_%s", context, part);
1909 tid = trackdb_begin_transaction();
1910 if((err = gettrackdata(track, 0, &p, &actual, 0, tid)) == DB_LOCK_DEADLOCK)
1914 trackdb_abort_transaction(tid);
1916 trackdb_commit_transaction(tid);
1917 return getpart(actual, context, part, p, &used_db);
1920 /* get the raw path name for @track@ (might be an alias) */
1921 const char *trackdb_rawpath(const char *track) {
1927 tid = trackdb_begin_transaction();
1928 if(gettrackdata(track, &t, 0, 0, 0, tid) == DB_LOCK_DEADLOCK)
1932 trackdb_abort_transaction(tid);
1934 trackdb_commit_transaction(tid);
1935 if(!(path = kvp_get(t, "_path"))) path = track;
1939 /* trackdb_list **************************************************************/
1941 /* this is incredibly ugly, sorry, perhaps it will be rewritten to be actually
1942 * readable at some point */
1944 /* return true if the basename of TRACK[0..TL-1], as defined by DL, matches RE.
1945 * If RE is a null pointer then it matches everything. */
1946 static int track_matches(size_t dl, const char *track, size_t tl,
1954 switch(rc = pcre_exec(re, 0, track, tl, 0, 0, ovec, 3)) {
1955 case PCRE_ERROR_NOMATCH: return 0;
1958 error(0, "pcre_exec returned %d, subject '%s'", rc, track);
1965 static int do_list(struct vector *v, const char *dir,
1966 enum trackdb_listable what, const pcre *re, DB_TXN *tid) {
1972 size_t l, last_dir_len = 0;
1973 char *last_dir = 0, *track;
1977 cursor = trackdb_opencursor(trackdb_tracksdb, tid);
1980 /* find the first key >= dir */
1981 err = cursor->c_get(cursor, &k, &d, DB_SET_RANGE);
1982 /* keep going while we're dealing with <dir/anything> */
1985 && ((char *)k.data)[dl] == '/'
1986 && !memcmp(k.data, dir, dl)) {
1987 ptr = memchr((char *)k.data + dl + 1, '/', k.size - (dl + 1));
1989 /* we have <dir/component/anything>, so <dir/component> is a directory */
1990 l = ptr - (char *)k.data;
1991 if(what & trackdb_directories)
1993 && l == last_dir_len
1994 && !memcmp(last_dir, k.data, l))) {
1995 last_dir = xstrndup(k.data, last_dir_len = l);
1996 if(track_matches(dl, k.data, l, re))
1997 vector_append(v, last_dir);
2000 /* found a plain file */
2001 if((what & trackdb_files)) {
2002 track = xstrndup(k.data, k.size);
2003 if((err = trackdb_getdata(trackdb_prefsdb,
2004 track, &p, tid)) == DB_LOCK_DEADLOCK)
2006 /* There's an awkward question here...
2008 * If a track shares a directory with its alias then we could
2009 * do one of three things:
2010 * - report both. Looks ridiculuous in most UIs.
2011 * - report just the alias. Remarkably inconvenient to write
2013 * - report just the real name. Ugly if the UI doesn't prettify
2014 * names via the name parts.
2017 /* If this file is an alias for a track in the same directory then we
2019 struct kvp *t = kvp_urldecode(d.data, d.size);
2020 const char *alias_target = kvp_get(t, "_alias_for");
2022 && !strcmp(d_dirname(alias_target),
2024 if(track_matches(dl, k.data, k.size, re))
2025 vector_append(v, track);
2027 /* if this file has an alias in the same directory then we skip it */
2029 if((err = compute_alias(&alias, track, p, tid)))
2031 if(!(alias && !strcmp(d_dirname(alias), d_dirname(track))))
2032 if(track_matches(dl, k.data, k.size, re))
2033 vector_append(v, track);
2037 err = cursor->c_get(cursor, &k, &d, DB_NEXT);
2045 case DB_LOCK_DEADLOCK:
2046 error(0, "error querying database: %s", db_strerror(err));
2049 fatal(0, "error querying database: %s", db_strerror(err));
2052 if(trackdb_closecursor(cursor)) err = DB_LOCK_DEADLOCK;
2056 /* return the directories or files below @dir@ */
2057 char **trackdb_list(const char *dir, int *np, enum trackdb_listable what,
2065 tid = trackdb_begin_transaction();
2068 if(do_list(&v, dir, what, re, tid))
2071 for(n = 0; n < config->collection.n; ++n)
2072 if(do_list(&v, config->collection.s[n].root, what, re, tid))
2077 trackdb_abort_transaction(tid);
2079 trackdb_commit_transaction(tid);
2080 vector_terminate(&v);
2086 /* If S is tag:something, return something. Else return 0. */
2087 static const char *checktag(const char *s) {
2088 if(!strncmp(s, "tag:", 4))
2094 /* return a list of tracks containing all of the words given. If you
2095 * ask for only stopwords you get no tracks. */
2096 char **trackdb_search(char **wordlist, int nwordlist, int *ntracks) {
2097 const char **w, *best = 0, *tag;
2098 char **twords, **tags;
2100 int i, j, n, err, what;
2110 *ntracks = 0; /* for early returns */
2111 /* normalize all the words */
2112 w = xmalloc(nwordlist * sizeof (char *));
2113 istag = xmalloc_noptr(nwordlist);
2114 for(n = 0; n < nwordlist; ++n) {
2118 w[n] = utf8_casefold_compat(wordlist[n], strlen(wordlist[n]), 0);
2119 if(checktag(w[n])) {
2120 ++ntags; /* count up tags */
2121 /* Normalize the tag */
2122 w[n] = normalize_tag(w[n] + 4, strlen(w[n] + 4));
2125 /* Normalize the search term by removing combining characters */
2126 if(!(w32 = utf8_to_utf32(w[n], strlen(w[n]), &nw32)))
2128 nw32 = remove_combining_chars(w32, nw32);
2129 if(!(w[n] = utf32_to_utf8(w32, nw32, 0)))
2134 /* find the longest non-stopword */
2135 for(n = 0; n < nwordlist; ++n)
2136 if(!istag[n] && !stopword(w[n]))
2137 if(!best || strlen(w[n]) > strlen(best))
2139 /* TODO: we should at least in principal be able to identify the word or tag
2140 * with the least matches in log time, and choose that as our primary search
2142 if(ntags && !best) {
2143 /* Only tags are listed. We limit to the first and narrow down with the
2145 best = istag[0] ? w[0] : 0;
2146 db = trackdb_tagsdb;
2149 /* We can limit to some word. */
2150 db = trackdb_searchdb;
2153 /* Only stopwords */
2159 tid = trackdb_begin_transaction();
2160 /* find all the tracks that have that word */
2165 cursor = trackdb_opencursor(db, tid);
2166 while(!(err = cursor->c_get(cursor, &k, &d, what))) {
2167 vector_append(&v, xstrndup(d.data, d.size));
2174 case DB_LOCK_DEADLOCK:
2175 error(0, "error querying %s database: %s", dbname, db_strerror(err));
2178 fatal(0, "error querying %s database: %s", dbname, db_strerror(err));
2180 if(trackdb_closecursor(cursor)) err = DB_LOCK_DEADLOCK;
2182 /* do a naive search over that (hopefuly fairly small) list of tracks */
2184 for(n = 0; n < v.nvec; ++n) {
2185 if((err = gettrackdata(v.vec[n], 0, &p, 0, 0, tid) == DB_LOCK_DEADLOCK))
2188 error(0, "track %s unexpected error: %s", v.vec[n], db_strerror(err));
2191 twords = track_to_words(v.vec[n], p);
2192 tags = parsetags(kvp_get(p, "tags"));
2193 for(i = 0; i < nwordlist; ++i) {
2196 /* Track must have this tag */
2197 for(j = 0; tags[j]; ++j)
2198 if(!strcmp(tag, tags[j])) break; /* tag found */
2199 if(!tags[j]) break; /* tag not found */
2201 /* Track must contain this word */
2202 for(j = 0; twords[j]; ++j)
2203 if(!strcmp(w[i], twords[j])) break; /* word found */
2204 if(!twords[j]) break; /* word not found */
2207 if(i >= nwordlist) /* all words found */
2208 vector_append(&u, v.vec[n]);
2212 trackdb_closecursor(cursor);
2214 trackdb_abort_transaction(tid);
2215 info("retrying search");
2217 trackdb_commit_transaction(tid);
2218 vector_terminate(&u);
2224 /* trackdb_scan **************************************************************/
2226 int trackdb_scan(const char *root,
2227 int (*callback)(const char *track,
2236 const size_t root_len = root ? strlen(root) : 0;
2238 struct kvp *data, *prefs;
2241 cursor = trackdb_opencursor(trackdb_tracksdb, tid);
2243 err = cursor->c_get(cursor, make_key(&k, root), prepare_data(&d),
2246 memset(&k, 0, sizeof k);
2247 err = cursor->c_get(cursor, &k, prepare_data(&d),
2252 || (k.size > root_len
2253 && !strncmp(k.data, root, root_len)
2254 && ((char *)k.data)[root_len] == '/')) {
2255 data = kvp_urldecode(d.data, d.size);
2256 if(kvp_get(data, "_path")) {
2257 track = xstrndup(k.data, k.size);
2258 /* TODO: trackdb_prefsdb is currently a DB_HASH. This means we have to
2259 * do a lookup for every single track. In fact this is quite quick:
2260 * with around 10,000 tracks a complete scan is around 0.3s on my
2261 * 2.2GHz Athlon. However, if it were a DB_BTREE, we could do the same
2262 * linear walk as we already do over trackdb_tracksdb, and probably get
2263 * even higher performance. That would require upgrade logic to
2264 * translate old databases though.
2266 switch(err = trackdb_prefsdb->get(trackdb_prefsdb, tid, &k,
2267 prepare_data(&pd), 0)) {
2269 prefs = kvp_urldecode(pd.data, pd.size);
2274 case DB_LOCK_DEADLOCK:
2275 error(0, "getting prefs: %s", db_strerror(err));
2276 trackdb_closecursor(cursor);
2279 fatal(0, "getting prefs: %s", db_strerror(err));
2281 /* Advance to the next track before the callback so that the callback
2282 * may safely delete the track */
2283 err = cursor->c_get(cursor, &k, &d, DB_NEXT);
2284 if((cberr = callback(track, data, prefs, u, tid))) {
2289 err = cursor->c_get(cursor, &k, &d, DB_NEXT);
2293 trackdb_closecursor(cursor);
2300 case DB_LOCK_DEADLOCK:
2301 error(0, "c->c_get: %s", db_strerror(err));
2304 fatal(0, "c->c_get: %s", db_strerror(err));
2308 /* trackdb_rescan ************************************************************/
2310 /** @brief Node in the list of rescan-complete callbacks */
2311 struct rescanned_node {
2312 struct rescanned_node *next;
2313 void (*rescanned)(void *ru);
2317 /** @brief List of rescan-complete callbacks */
2318 static struct rescanned_node *rescanned_list;
2320 /** @brief Add a rescan completion callback */
2321 void trackdb_add_rescanned(void (*rescanned)(void *ru),
2324 struct rescanned_node *n = xmalloc(sizeof *n);
2325 n->next = rescanned_list;
2326 n->rescanned = rescanned;
2332 /* called when the rescanner terminates */
2333 static int reap_rescan(ev_source attribute((unused)) *ev,
2336 const struct rusage attribute((unused)) *rusage,
2337 void attribute((unused)) *u) {
2338 if(pid == rescan_pid) rescan_pid = -1;
2340 error(0, RESCAN": %s", wstat(status));
2342 D((RESCAN" terminated: %s", wstat(status)));
2343 /* Our cache of file lookups is out of date now */
2344 cache_clean(&cache_files_type);
2345 eventlog("rescanned", (char *)0);
2346 /* Call rescanned callbacks */
2347 while(rescanned_list) {
2348 void (*rescanned)(void *u_) = rescanned_list->rescanned;
2349 void *ru = rescanned_list->ru;
2351 rescanned_list = rescanned_list->next;
2357 /** @brief Initiate a rescan
2358 * @param ev Event loop or 0 to block
2359 * @param recheck 1 to recheck lengths, 0 to suppress check
2360 * @param rescanned Called on completion (if not NULL)
2361 * @param ru Passed to @p rescanned
2363 void trackdb_rescan(ev_source *ev, int recheck,
2364 void (*rescanned)(void *ru),
2368 if(rescan_pid != -1) {
2369 trackdb_add_rescanned(rescanned, ru);
2370 error(0, "rescan already underway");
2373 rescan_pid = subprogram(ev, -1, RESCAN,
2374 recheck ? "--check" : "--no-check",
2376 trackdb_add_rescanned(rescanned, ru);
2378 ev_child(ev, rescan_pid, 0, reap_rescan, 0);
2379 D(("started rescanner"));
2381 /* This is the first rescan, we block until it is complete */
2382 while(waitpid(rescan_pid, &w, 0) < 0 && errno == EINTR)
2384 reap_rescan(0, rescan_pid, w, 0, 0);
2388 int trackdb_rescan_cancel(void) {
2389 if(rescan_pid == -1) return 0;
2390 if(kill(rescan_pid, SIGTERM) < 0)
2391 fatal(errno, "error killing rescanner");
2396 /** @brief Return true if a rescan is underway */
2397 int trackdb_rescan_underway(void) {
2398 return rescan_pid != -1;
2401 /* global prefs **************************************************************/
2403 void trackdb_set_global(const char *name,
2411 tid = trackdb_begin_transaction();
2412 if(!(err = trackdb_set_global_tid(name, value, tid)))
2414 trackdb_abort_transaction(tid);
2416 trackdb_commit_transaction(tid);
2417 /* log important state changes */
2418 if(!strcmp(name, "playing")) {
2419 state = !value || !strcmp(value, "yes");
2420 info("playing %s by %s",
2421 state ? "enabled" : "disabled",
2423 eventlog("state", state ? "enable_play" : "disable_play", (char *)0);
2425 if(!strcmp(name, "random-play")) {
2426 state = !value || !strcmp(value, "yes");
2427 info("random play %s by %s",
2428 state ? "enabled" : "disabled",
2430 eventlog("state", state ? "enable_random" : "disable_random", (char *)0);
2434 int trackdb_set_global_tid(const char *name,
2440 memset(&k, 0, sizeof k);
2441 memset(&d, 0, sizeof d);
2442 k.data = (void *)name;
2443 k.size = strlen(name);
2445 d.data = (void *)value;
2446 d.size = strlen(value);
2449 err = trackdb_globaldb->put(trackdb_globaldb, tid, &k, &d, 0);
2451 err = trackdb_globaldb->del(trackdb_globaldb, tid, &k, 0);
2452 if(err == DB_LOCK_DEADLOCK) return err;
2454 fatal(0, "error updating database: %s", db_strerror(err));
2458 const char *trackdb_get_global(const char *name) {
2464 tid = trackdb_begin_transaction();
2465 if(!(err = trackdb_get_global_tid(name, tid, &r)))
2467 trackdb_abort_transaction(tid);
2469 trackdb_commit_transaction(tid);
2473 int trackdb_get_global_tid(const char *name,
2479 memset(&k, 0, sizeof k);
2480 k.data = (void *)name;
2481 k.size = strlen(name);
2482 switch(err = trackdb_globaldb->get(trackdb_globaldb, tid, &k,
2483 prepare_data(&d), 0)) {
2485 *rp = xstrndup(d.data, d.size);
2490 case DB_LOCK_DEADLOCK:
2493 fatal(0, "error reading database: %s", db_strerror(err));
2497 /** @brief Retrieve the most recently added tracks
2498 * @param ntracksp Where to put count, or 0
2499 * @param maxtracks Maximum number of tracks to retrieve
2500 * @return null-terminated array of track names
2502 * The most recently added track is first in the array.
2504 char **trackdb_new(int *ntracksp,
2510 tid = trackdb_begin_transaction();
2511 tracks = trackdb_new_tid(ntracksp, maxtracks, tid);
2514 trackdb_abort_transaction(tid);
2516 trackdb_commit_transaction(tid);
2520 /** @brief Retrieve the most recently added tracks
2521 * @param ntracksp Where to put count, or 0
2522 * @param maxtracks Maximum number of tracks to retrieve, or 0 for all
2523 * @param tid Transaction ID
2524 * @return null-terminated array of track names, or NULL on deadlock
2526 * The most recently added track is first in the array.
2528 static char **trackdb_new_tid(int *ntracksp,
2534 struct vector tracks[1];
2535 hash *h = hash_new(1);
2537 vector_init(tracks);
2538 c = trackdb_opencursor(trackdb_noticeddb, tid);
2539 while((maxtracks <= 0 || tracks->nvec < maxtracks)
2540 && !(err = c->c_get(c, prepare_data(&k), prepare_data(&d), DB_PREV))) {
2541 char *const track = xstrndup(d.data, d.size);
2542 /* Don't add any track more than once */
2543 if(hash_add(h, track, "", HASH_INSERT))
2545 /* See if the track still exists */
2546 err = trackdb_getdata(trackdb_tracksdb, track, NULL/*kp*/, tid);
2547 if(err == DB_NOTFOUND)
2548 continue; /* It doesn't, skip it */
2549 if(err == DB_LOCK_DEADLOCK)
2551 vector_append(tracks, track);
2554 case 0: /* hit maxtracks */
2555 case DB_NOTFOUND: /* ran out of tracks */
2557 case DB_LOCK_DEADLOCK:
2558 trackdb_closecursor(c);
2561 fatal(0, "error reading noticed.db: %s", db_strerror(err));
2563 if((err = trackdb_closecursor(c)))
2564 return 0; /* deadlock */
2565 vector_terminate(tracks);
2567 *ntracksp = tracks->nvec;
2571 /** @brief Expire noticed.db
2572 * @param earliest Earliest timestamp to keep
2574 void trackdb_expire_noticed(time_t earliest) {
2578 tid = trackdb_begin_transaction();
2579 if(!trackdb_expire_noticed_tid(earliest, tid))
2581 trackdb_abort_transaction(tid);
2583 trackdb_commit_transaction(tid);
2586 /** @brief Expire noticed.db
2587 * @param earliest Earliest timestamp to keep
2588 * @param tid Transaction ID
2589 * @return 0 or DB_LOCK_DEADLOCK
2591 static int trackdb_expire_noticed_tid(time_t earliest, DB_TXN *tid) {
2599 c = trackdb_opencursor(trackdb_noticeddb, tid);
2600 while(!(err = c->c_get(c, prepare_data(&k), prepare_data(&d), DB_NEXT))) {
2602 when = (time_t)(((uint64_t)ntohl(kk[0]) << 32) + ntohl(kk[1]));
2603 if(when >= earliest)
2605 if((err = c->c_del(c, 0))) {
2606 if(err != DB_LOCK_DEADLOCK)
2607 fatal(0, "error deleting expired noticed.db entry: %s",
2613 if(err == DB_NOTFOUND)
2615 if(err && err != DB_LOCK_DEADLOCK)
2616 fatal(0, "error expiring noticed.db: %s", db_strerror(err));
2618 if((err = trackdb_closecursor(c))) {
2619 if(err != DB_LOCK_DEADLOCK)
2620 fatal(0, "error closing cursor: %s", db_strerror(err));
2624 info("expired %d tracks from noticed.db", count);
2628 /* tidying up ****************************************************************/
2630 void trackdb_gc(void) {
2634 if((err = trackdb_env->txn_checkpoint(trackdb_env,
2635 config->checkpoint_kbyte,
2636 config->checkpoint_min,
2638 fatal(0, "trackdb_env->txn_checkpoint: %s", db_strerror(err));
2639 if((err = trackdb_env->log_archive(trackdb_env, &logfiles, DB_ARCH_REMOVE)))
2640 fatal(0, "trackdb_env->log_archive: %s", db_strerror(err));
2641 /* This makes catastrophic recovery impossible. However, the user can still
2642 * preserve the important data by using disorder-dump to snapshot their
2643 * prefs, and later to restore it. This is likely to have much small
2644 * long-term storage requirements than record the db logfiles. */
2647 /* user database *************************************************************/
2649 /** @brief Return true if @p user is trusted */
2650 static int trusted(const char *user) {
2653 for(n = 0; (n < config->trust.n
2654 && strcmp(config->trust.s[n], user)); ++n)
2656 return n < config->trust.n;
2659 /** @brief Return non-zero for a valid username
2661 * Currently we only allow the letters and digits in ASCII. We could be more
2662 * liberal than this but it is a nice simple test. It is critical that
2663 * semicolons are never allowed.
2665 * NB also used by playlist_parse_name() to validate playlist names!
2667 int valid_username(const char *user) {
2671 const uint8_t c = *user++;
2672 /* For now we are very strict */
2673 if((c >= 'a' && c <= 'z')
2674 || (c >= 'A' && c <= 'Z')
2675 || (c >= '0' && c <= '9'))
2683 /** @brief Add a user */
2684 static int create_user(const char *user,
2685 const char *password,
2688 const char *confirmation,
2694 /* sanity check user */
2695 if(!valid_username(user)) {
2696 error(0, "invalid username '%s'", user);
2699 if(parse_rights(rights, 0, 1)) {
2700 error(0, "invalid rights string");
2703 /* data for this user */
2705 kvp_set(&k, "password", password);
2706 kvp_set(&k, "rights", rights);
2708 kvp_set(&k, "email", email);
2710 kvp_set(&k, "confirmation", confirmation);
2711 snprintf(s, sizeof s, "%jd", (intmax_t)xtime(0));
2712 kvp_set(&k, "created", s);
2713 return trackdb_putdata(trackdb_usersdb, user, k, tid, flags);
2716 /** @brief Add one pre-existing user */
2717 static int one_old_user(const char *user, const char *password,
2721 /* www-data doesn't get added */
2722 if(!strcmp(user, "www-data")) {
2723 info("not adding www-data to user database");
2727 if(!strcmp(user, "root"))
2729 else if(trusted(user)) {
2732 parse_rights(config->default_rights, &r, 1);
2733 r &= ~(rights_type)(RIGHT_SCRATCH__MASK|RIGHT_MOVE__MASK|RIGHT_REMOVE__MASK);
2734 r |= (RIGHT_ADMIN|RIGHT_RESCAN
2735 |RIGHT_SCRATCH_ANY|RIGHT_MOVE_ANY|RIGHT_REMOVE_ANY);
2736 rights = rights_string(r);
2738 rights = config->default_rights;
2739 return create_user(user, password, rights, 0/*email*/, 0/*confirmation*/,
2740 tid, DB_NOOVERWRITE);
2743 static int trackdb_old_users_tid(DB_TXN *tid) {
2746 for(n = 0; n < config->allow.n; ++n) {
2747 switch(one_old_user(config->allow.s[n].s[0], config->allow.s[n].s[1],
2750 info("created user %s from 'allow' directive", config->allow.s[n].s[0]);
2753 error(0, "user %s already exists, delete 'allow' directive",
2754 config->allow.s[n].s[0]);
2755 /* This won't ever become fatal - eventually 'allow' will be
2758 case DB_LOCK_DEADLOCK:
2759 return DB_LOCK_DEADLOCK;
2765 /** @brief Read old 'allow' directives and copy them to the users database */
2766 void trackdb_old_users(void) {
2770 WITH_TRANSACTION(trackdb_old_users_tid(tid));
2773 /** @brief Create a root user in the user database if there is none */
2774 void trackdb_create_root(void) {
2779 /* Choose a new root password */
2780 gcry_randomize(pwbin, sizeof pwbin, GCRY_STRONG_RANDOM);
2781 pw = mime_to_base64(pwbin, sizeof pwbin);
2782 /* Create the root user if it does not exist */
2783 WITH_TRANSACTION(create_user("root", pw, "all",
2784 0/*email*/, 0/*confirmation*/,
2785 tid, DB_NOOVERWRITE));
2787 info("created root user");
2790 /** @brief Find a user's password from the database
2791 * @param user Username
2792 * @return Password or NULL
2794 * Only works if running as a user that can read the database!
2796 * If the user exists but has no password, "" is returned.
2798 const char *trackdb_get_password(const char *user) {
2801 const char *password;
2803 WITH_TRANSACTION(trackdb_getdata(trackdb_usersdb, user, &k, tid));
2806 password = kvp_get(k, "password");
2807 return password ? password : "";
2810 /** @brief Add a new user
2811 * @param user Username
2812 * @param password Password or NULL
2813 * @param rights Initial rights
2814 * @param email Email address or NULL
2815 * @param confirmation Confirmation string or NULL
2816 * @return 0 on success, non-0 on error
2818 int trackdb_adduser(const char *user,
2819 const char *password,
2822 const char *confirmation) {
2825 WITH_TRANSACTION(create_user(user, password, rights, email, confirmation,
2826 tid, DB_NOOVERWRITE));
2828 error(0, "cannot create user '%s' because they already exist", user);
2832 info("created user '%s' with rights '%s' and email address '%s'",
2833 user, rights, email);
2835 info("created user '%s' with rights '%s'", user, rights);
2836 eventlog("user_add", user, (char *)0);
2841 /** @brief Delete a user
2842 * @param user User to delete
2843 * @return 0 on success, non-0 if the user didn't exist anyway
2845 int trackdb_deluser(const char *user) {
2848 WITH_TRANSACTION(trackdb_delkey(trackdb_usersdb, user, tid));
2850 error(0, "cannot delete user '%s' because they do not exist", user);
2853 info("deleted user '%s'", user);
2854 eventlog("user_delete", user, (char *)0);
2858 /** @brief Get user information
2859 * @param user User to query
2860 * @return Linked list of user information or NULL if user does not exist
2862 * Every user has at least a @c rights entry so NULL can be used to mean no
2865 struct kvp *trackdb_getuserinfo(const char *user) {
2869 WITH_TRANSACTION(trackdb_getdata(trackdb_usersdb, user, &k, tid));
2876 /** @brief Edit user information
2877 * @param user User to edit
2878 * @param key Key to change
2879 * @param value Value to set, or NULL to remove
2880 * @param tid Transaction ID
2881 * @return 0, DB_LOCK_DEADLOCK or DB_NOTFOUND
2883 static int trackdb_edituserinfo_tid(const char *user, const char *key,
2884 const char *value, DB_TXN *tid) {
2888 if((e = trackdb_getdata(trackdb_usersdb, user, &k, tid)))
2890 if(!kvp_set(&k, key, value))
2891 return 0; /* no change */
2892 return trackdb_putdata(trackdb_usersdb, user, k, tid, 0);
2895 /** @brief Edit user information
2896 * @param user User to edit
2897 * @param key Key to change
2898 * @param value Value to set, or NULL to remove
2899 * @return 0 on success, non-0 on error
2901 int trackdb_edituserinfo(const char *user,
2902 const char *key, const char *value) {
2905 if(!strcmp(key, "rights")) {
2907 error(0, "cannot remove 'rights' key from user '%s'", user);
2910 if(parse_rights(value, 0, 1)) {
2911 error(0, "invalid rights string");
2914 } else if(!strcmp(key, "email")) {
2916 if(!email_valid(value)) {
2917 error(0, "invalid email address '%s' for user '%s'", value, user);
2921 value = 0; /* no email -> remove key */
2922 } else if(!strcmp(key, "created")) {
2923 error(0, "cannot change creation date for user '%s'", user);
2925 } else if(strcmp(key, "password")
2926 && !strcmp(key, "confirmation")) {
2927 error(0, "unknown user info key '%s' for user '%s'", key, user);
2930 WITH_TRANSACTION(trackdb_edituserinfo_tid(user, key, value, tid));
2932 error(0, "unknown user '%s'", user);
2935 eventlog("user_edit", user, key, (char *)0);
2940 /** @brief List all users
2941 * @return NULL-terminated list of users
2943 char **trackdb_listusers(void) {
2948 WITH_TRANSACTION(trackdb_listkeys(trackdb_usersdb, v, tid));
2952 /** @brief Confirm a user registration
2953 * @param user Username
2954 * @param confirmation Confirmation string
2955 * @param rightsp Where to put user rights
2956 * @param tid Transaction ID
2957 * @return 0 on success, non-0 on error
2959 static int trackdb_confirm_tid(const char *user, const char *confirmation,
2960 rights_type *rightsp,
2962 const char *stored_confirmation;
2967 if((e = trackdb_getdata(trackdb_usersdb, user, &k, tid)))
2969 if(!(stored_confirmation = kvp_get(k, "confirmation"))) {
2970 error(0, "already confirmed user '%s'", user);
2971 /* DB claims -30,800 to -30,999 so -1 should be a safe bet */
2974 if(!(rights = kvp_get(k, "rights"))) {
2975 error(0, "no rights for unconfirmed user '%s'", user);
2978 if(parse_rights(rights, rightsp, 1))
2980 if(strcmp(confirmation, stored_confirmation)) {
2981 error(0, "wrong confirmation string for user '%s'", user);
2985 kvp_set(&k, "confirmation", 0);
2986 return trackdb_putdata(trackdb_usersdb, user, k, tid, 0);
2989 /** @brief Confirm a user registration
2990 * @param user Username
2991 * @param confirmation Confirmation string
2992 * @param rightsp Where to put user rights
2993 * @return 0 on success, non-0 on error
2995 int trackdb_confirm(const char *user, const char *confirmation,
2996 rights_type *rightsp) {
2999 WITH_TRANSACTION(trackdb_confirm_tid(user, confirmation, rightsp, tid));
3002 info("registration confirmed for user '%s'", user);
3003 eventlog("user_confirm", user, (char *)0);
3006 error(0, "confirmation for nonexistent user '%s'", user);
3008 default: /* already reported */
3018 indent-tabs-mode:nil