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 static const char *home; /* home had better not change */
86 DB_ENV *trackdb_env; /* db environment */
88 /** @brief The tracks database
89 * - Keys are UTF-8(NFC(unicode(path name)))
90 * - Values are encoded key-value pairs
91 * - Data is reconstructable data about tracks that currently exist
95 /** @brief The preferences database
97 * - Keys are UTF-8(NFC(unicode(path name)))
98 * - Values are encoded key-value pairs
99 * - Data is user data about tracks (that might not exist any more)
100 * and cannot be reconstructed
104 /** @brief The search database
106 * - Keys are UTF-8(NFKC(casefold(search term)))
107 * - Values are UTF-8(NFC(unicode(path name)))
108 * - There can be more than one value per key
109 * - Presence of key,value means that path matches the search terms
110 * - Only tracks fond in @ref trackdb_tracksdb are represented here
111 * - This database can be reconstructed, it contains no user data
113 DB *trackdb_searchdb;
115 /** @brief The tags database
117 * - Keys are UTF-8(NFKC(casefold(tag)))
118 * - Values are UTF-8(NFC(unicode(path name)))
119 * - There can be more than one value per key
120 * - Presence of key,value means that path matches the tag
121 * - This is always in sync with the tags preference
122 * - This database can be reconstructed, it contains no user data
124 DB *trackdb_tagsdb; /* the tags database */
126 /** @brief The global preferences database
127 * - Keys are UTF-8(NFC(preference))
128 * - Values are global preference values
129 * - Data is user data and cannot be reconstructed
131 DB *trackdb_globaldb; /* global preferences */
133 /** @brief The noticed database
134 * - Keys are 64-bit big-endian timestamps
135 * - Values are UTF-8(NFC(unicode(path name)))
136 * - There can be more than one value per key
137 * - Presence of key,value means that path was added at the given time
138 * - Data cannot be reconstructed (but isn't THAT important)
140 DB *trackdb_noticeddb; /* when track noticed */
142 /** @brief The schedule database
144 * - Keys are ID strings, generated at random
145 * - Values are encoded key-value pairs
146 * - There can be more than one value per key
147 * - Data cannot be reconstructed
149 * See @ref server/schedule.c for further information.
151 DB *trackdb_scheduledb;
153 /** @brief The user database
154 * - Keys are usernames
155 * - Values are encoded key-value pairs
156 * - Data is user data and cannot be reconstructed
160 /** @brief The playlists database
161 * - Keys are playlist names
162 * - Values are encoded key-value pairs
163 * - Data is user data and cannot be reconstructed
165 DB *trackdb_playlistsdb;
167 static pid_t db_deadlock_pid = -1; /* deadlock manager PID */
168 static pid_t rescan_pid = -1; /* rescanner PID */
169 static int initialized, opened; /* state */
171 /** @brief Current stats subprocess PIDs */
172 static hash *stats_pids;
174 /* comparison function for keys */
175 static int compare(DB attribute((unused)) *db_,
176 const DBT *a, const DBT *b) {
177 return compare_path_raw(a->data, a->size, b->data, b->size);
180 /** @brief Test whether the track database can be read
181 * @return 1 if it can, 0 if it cannot
183 int trackdb_readable(void) {
186 byte_xasprintf(&usersdb, "%s/users.db", config->home);
187 return access(usersdb, R_OK) == 0;
190 /** @brief Open database environment
191 * @param flags Flags word
193 * Flags should be one of:
194 * - @ref TRACKDB_NO_RECOVER
195 * - @ref TRACKDB_NORMAL_RECOVER
196 * - @ref TRACKDB_FATAL_RECOVER
197 * - @ref TRACKDB_MAY_CREATE
199 void trackdb_init(int flags) {
201 const int recover = flags & TRACKDB_RECOVER_MASK;
202 static int recover_type[] = { 0, DB_RECOVER, DB_RECOVER_FATAL };
205 assert(initialized == 0);
208 if(strcmp(home, config->home))
209 fatal(0, "cannot change db home without server restart");
213 if(flags & TRACKDB_MAY_CREATE) {
219 /* Remove world/group permissions on any regular files already in the
220 * database directory. Actually we don't care about all of them but it's
221 * easier to just do the lot. This can be revisited if it's a serious
222 * practical inconvenience for anyone.
224 * The socket, not being a regular file, is excepted.
226 if(!(dp = opendir(config->home)))
227 fatal(errno, "error reading %s", config->home);
228 while((de = readdir(dp))) {
229 byte_xasprintf(&p, "%s/%s", config->home, de->d_name);
230 if(lstat(p, &st) == 0
231 && S_ISREG(st.st_mode)
232 && (st.st_mode & 077)) {
233 if(chmod(p, st.st_mode & 07700) < 0)
234 fatal(errno, "cannot chmod %s", p);
241 /* create environment */
242 if((err = db_env_create(&trackdb_env, 0))) fatal(0, "db_env_create: %s",
244 if((err = trackdb_env->set_alloc(trackdb_env,
245 xmalloc_noptr, xrealloc_noptr, xfree)))
246 fatal(0, "trackdb_env->set_alloc: %s", db_strerror(err));
247 if((err = trackdb_env->set_lk_max_locks(trackdb_env, 10000)))
248 fatal(0, "trackdb_env->set_lk_max_locks: %s", db_strerror(err));
249 if((err = trackdb_env->set_lk_max_objects(trackdb_env, 10000)))
250 fatal(0, "trackdb_env->set_lk_max_objects: %s", db_strerror(err));
251 if((err = trackdb_env->open(trackdb_env, config->home,
257 |recover_type[recover],
259 fatal(0, "trackdb_env->open %s: %s", config->home, db_strerror(err));
260 trackdb_env->set_errpfx(trackdb_env, "DB");
261 trackdb_env->set_errfile(trackdb_env, stderr);
262 trackdb_env->set_verbose(trackdb_env, DB_VERB_DEADLOCK, 1);
263 trackdb_env->set_verbose(trackdb_env, DB_VERB_RECOVERY, 1);
264 trackdb_env->set_verbose(trackdb_env, DB_VERB_REPLICATION, 1);
265 D(("initialized database environment"));
268 /* called when deadlock manager terminates */
269 static int reap_db_deadlock(ev_source attribute((unused)) *ev,
270 pid_t attribute((unused)) pid,
272 const struct rusage attribute((unused)) *rusage,
273 void attribute((unused)) *u) {
274 db_deadlock_pid = -1;
276 fatal(0, "deadlock manager unexpectedly terminated: %s",
279 D(("deadlock manager terminated: %s", wstat(status)));
283 static pid_t subprogram(ev_source *ev, int outputfd, const char *prog,
287 const char *args[1024], **argp, *a;
291 *argp++ = "--config";
292 *argp++ = configfile;
293 *argp++ = debugging ? "--debug" : "--no-debug";
294 *argp++ = log_default == &log_syslog ? "--syslog" : "--no-syslog";
296 while((a = va_arg(ap, const char *)))
300 /* If we're in the background then trap subprocess stdout/stderr */
301 if(!(pid = xfork())) {
304 ev_signal_atfork(ev);
305 signal(SIGPIPE, SIG_DFL);
310 /* ensure we don't leak privilege anywhere */
311 if(setuid(geteuid()) < 0)
312 fatal(errno, "error calling setuid");
313 /* If we were negatively niced, undo it. We don't bother checking for
314 * error, it's not that important. */
315 setpriority(PRIO_PROCESS, 0, 0);
316 execvp(prog, (char **)args);
317 fatal(errno, "error invoking %s", prog);
322 /* start deadlock manager */
323 void trackdb_master(ev_source *ev) {
324 assert(db_deadlock_pid == -1);
325 db_deadlock_pid = subprogram(ev, -1, DEADLOCK, (char *)0);
326 ev_child(ev, db_deadlock_pid, 0, reap_db_deadlock, 0);
327 D(("started deadlock manager"));
330 /* close environment */
331 void trackdb_deinit(ev_source *ev) {
335 assert(initialized == 1);
338 /* close the environment */
339 if((err = trackdb_env->close(trackdb_env, 0)))
340 fatal(0, "trackdb_env->close: %s", db_strerror(err));
342 if(rescan_pid != -1) {
343 /* shut down the rescanner */
344 if(kill(rescan_pid, SIGTERM) < 0)
345 fatal(errno, "error killing rescanner");
346 /* wait for the rescanner to finish */
347 while(waitpid(rescan_pid, &err, 0) == -1 && errno == EINTR)
350 ev_child_cancel(ev, rescan_pid);
355 char **ks = hash_keys(stats_pids);
358 pid_t pid = atoi(*ks++);
359 if(kill(pid, SIGTERM) < 0)
360 fatal(errno, "error killing stats subprocess");
361 while(waitpid(pid, &err, 0) == -1 && errno == EINTR)
364 ev_child_cancel(ev, pid);
369 if(db_deadlock_pid != -1) {
370 /* shut down the deadlock manager */
371 if(kill(db_deadlock_pid, SIGTERM) < 0)
372 fatal(errno, "error killing deadlock manager");
373 while(waitpid(db_deadlock_pid, &err, 0) == -1 && errno == EINTR)
376 ev_child_cancel(ev, db_deadlock_pid);
377 db_deadlock_pid = -1;
380 D(("deinitialized database environment"));
383 /* open a specific database */
384 static DB *open_db(const char *path,
392 D(("open %s", path));
393 path = config_get_file(path);
394 if((err = db_create(&db, trackdb_env, 0)))
395 fatal(0, "db_create %s: %s", path, db_strerror(err));
397 if((err = db->set_flags(db, dbflags)))
398 fatal(0, "db->set_flags %s: %s", path, db_strerror(err));
399 if(dbtype == DB_BTREE)
400 if((err = db->set_bt_compare(db, compare)))
401 fatal(0, "db->set_bt_compare %s: %s", path, db_strerror(err));
402 if((err = db->open(db, 0, path, 0, dbtype,
403 openflags | DB_AUTO_COMMIT, mode))) {
404 if((openflags & DB_CREATE) || errno != ENOENT) {
405 if((err2 = db->close(db, 0)))
406 error(0, "db->close: %s", db_strerror(err2));
408 trackdb_env->close(trackdb_env,0);
410 fatal(0, "db->open %s: %s", path, db_strerror(err));
418 /** @brief Open track databases
419 * @param flags Flags flags word
421 * @p flags should have one of:
422 * - @p TRACKDB_NO_UPGRADE, if no upgrade should be attempted
423 * - @p TRACKDB_CAN_UPGRADE, if an upgrade may be attempted
424 * - @p TRACKDB_OPEN_FOR_UPGRADE, if this is disorder-dbupgrade
426 * - @p TRACKDB_READ_ONLY, read only access
428 void trackdb_open(int flags) {
431 uint32_t dbflags = flags & TRACKDB_READ_ONLY ? DB_RDONLY : DB_CREATE;
436 /* check the database version first */
437 trackdb_globaldb = open_db("global.db", 0, DB_HASH, DB_RDONLY, 0666);
438 if(trackdb_globaldb) {
439 /* This is an existing database */
443 s = trackdb_get_global("_dbversion");
444 /* Close the database again, we'll open it property below */
445 if((err = trackdb_globaldb->close(trackdb_globaldb, 0)))
446 fatal(0, "error closing global.db: %s", db_strerror(err));
447 trackdb_globaldb = 0;
448 /* Convert version string to an integer */
449 oldversion = s ? atol(s) : 1;
450 if(oldversion > config->dbversion) {
451 /* Database is from the future; we never allow this. */
452 fatal(0, "this version of DisOrder is too old for database version %ld",
455 if(oldversion < config->dbversion) {
456 /* Database version is out of date */
457 switch(flags & TRACKDB_UPGRADE_MASK) {
458 case TRACKDB_NO_UPGRADE:
459 /* This database needs upgrading but this is not permitted */
460 fatal(0, "database needs upgrading from %ld to %ld",
461 oldversion, config->dbversion);
462 case TRACKDB_CAN_UPGRADE:
463 /* This database needs upgrading */
464 info("invoking disorder-dbupgrade to upgrade from %ld to %ld",
465 oldversion, config->dbversion);
466 pid = subprogram(0, -1, "disorder-dbupgrade", (char *)0);
467 while(waitpid(pid, &err, 0) == -1 && errno == EINTR)
470 fatal(0, "disorder-dbupgrade %s", wstat(err));
471 info("disorder-dbupgrade succeeded");
473 case TRACKDB_OPEN_FOR_UPGRADE:
479 if(oldversion == config->dbversion && (flags & TRACKDB_OPEN_FOR_UPGRADE)) {
480 /* This doesn't make any sense */
481 fatal(0, "database is already at current version");
483 trackdb_existing_database = 1;
485 if(flags & TRACKDB_OPEN_FOR_UPGRADE) {
486 /* Cannot upgrade a new database */
487 fatal(0, "cannot upgrade a database that does not exist");
489 /* This is a brand new database */
490 trackdb_existing_database = 0;
492 /* open the databases */
493 if(!(trackdb_usersdb = open_db("users.db",
494 0, DB_HASH, dbflags, 0600)))
495 fatal(0, "cannot open users.db");
496 trackdb_tracksdb = open_db("tracks.db",
497 DB_RECNUM, DB_BTREE, dbflags, 0666);
498 trackdb_searchdb = open_db("search.db",
499 DB_DUP|DB_DUPSORT, DB_HASH, dbflags, 0666);
500 trackdb_tagsdb = open_db("tags.db",
501 DB_DUP|DB_DUPSORT, DB_HASH, dbflags, 0666);
502 trackdb_prefsdb = open_db("prefs.db", 0, DB_HASH, dbflags, 0666);
503 trackdb_globaldb = open_db("global.db", 0, DB_HASH, dbflags, 0666);
504 trackdb_noticeddb = open_db("noticed.db",
505 DB_DUPSORT, DB_BTREE, dbflags, 0666);
506 trackdb_scheduledb = open_db("schedule.db", 0, DB_HASH, dbflags, 0666);
507 trackdb_playlistsdb = open_db("playlists.db", 0, DB_HASH, dbflags, 0666);
508 if(!trackdb_existing_database && !(flags & TRACKDB_READ_ONLY)) {
509 /* Stash the database version */
512 assert(!(flags & TRACKDB_OPEN_FOR_UPGRADE));
513 snprintf(buf, sizeof buf, "%ld", config->dbversion);
514 trackdb_set_global("_dbversion", buf, 0);
516 D(("opened databases"));
519 /* close track databases */
520 void trackdb_close(void) {
526 #define CLOSE(N, V) do { \
527 if(V && (err = V->close(V, 0))) \
528 fatal(0, "error closing %s: %s", N, db_strerror(err)); \
531 CLOSE("tracks.db", trackdb_tracksdb);
532 CLOSE("search.db", trackdb_searchdb);
533 CLOSE("tags.db", trackdb_tagsdb);
534 CLOSE("prefs.db", trackdb_prefsdb);
535 CLOSE("global.db", trackdb_globaldb);
536 CLOSE("noticed.db", trackdb_noticeddb);
537 CLOSE("schedule.db", trackdb_scheduledb);
538 CLOSE("users.db", trackdb_usersdb);
539 CLOSE("playlists.db", trackdb_playlistsdb);
540 D(("closed databases"));
543 /* generic db routines *******************************************************/
545 /** @brief Fetch and decode a database entry
547 * @param track Track name
548 * @param kp Where to put decoded list (or NULL if you don't care)
549 * @param tid Owning transaction
550 * @return 0, @c DB_NOTFOUND or @c DB_LOCK_DEADLOCK
552 int trackdb_getdata(DB *db,
559 switch(err = db->get(db, tid, make_key(&key, track),
560 prepare_data(&data), 0)) {
563 *kp = kvp_urldecode(data.data, data.size);
569 case DB_LOCK_DEADLOCK:
570 error(0, "error querying database: %s", db_strerror(err));
573 fatal(0, "error querying database: %s", db_strerror(err));
577 /* encode and store a database entry. Returns 0, DB_KEYEXIST or
578 * DB_LOCK_DEADLOCK. */
579 int trackdb_putdata(DB *db,
587 switch(err = db->put(db, tid, make_key(&key, track),
588 encode_data(&data, k), flags)) {
592 case DB_LOCK_DEADLOCK:
593 error(0, "error updating database: %s", db_strerror(err));
596 fatal(0, "error updating database: %s", db_strerror(err));
600 /** @brief Delete a database entry
602 * @param track Key to delete
603 * @param tid Transaction ID
604 * @return 0, DB_NOTFOUND or DB_LOCK_DEADLOCK
606 int trackdb_delkey(DB *db,
612 switch(err = db->del(db, tid, make_key(&key, track), 0)) {
616 case DB_LOCK_DEADLOCK:
617 error(0, "error updating database: %s", db_strerror(err));
620 fatal(0, "error updating database: %s", db_strerror(err));
624 /* open a database cursor */
625 DBC *trackdb_opencursor(DB *db, DB_TXN *tid) {
629 switch(err = db->cursor(db, tid, &c, 0)) {
631 default: fatal(0, "error creating cursor: %s", db_strerror(err));
636 /* close a database cursor; returns 0 or DB_LOCK_DEADLOCK */
637 int trackdb_closecursor(DBC *c) {
641 switch(err = c->c_close(c)) {
644 case DB_LOCK_DEADLOCK:
645 error(0, "error closing cursor: %s", db_strerror(err));
648 fatal(0, "error closing cursor: %s", db_strerror(err));
652 /* delete a (key,data) pair. Returns 0, DB_NOTFOUND or DB_LOCK_DEADLOCK. */
653 int trackdb_delkeydata(DB *db,
661 c = trackdb_opencursor(db, tid);
662 switch(err = c->c_get(c, make_key(&key, word),
663 make_key(&data, track), DB_GET_BOTH)) {
665 switch(err = c->c_del(c, 0)) {
671 case DB_LOCK_DEADLOCK:
672 error(0, "error updating database: %s", db_strerror(err));
675 fatal(0, "c->c_del: %s", db_strerror(err));
680 case DB_LOCK_DEADLOCK:
681 error(0, "error updating database: %s", db_strerror(err));
684 fatal(0, "c->c_get: %s", db_strerror(err));
686 if(trackdb_closecursor(c)) err = DB_LOCK_DEADLOCK;
690 /* start a transaction */
691 DB_TXN *trackdb_begin_transaction(void) {
695 if((err = trackdb_env->txn_begin(trackdb_env, 0, &tid, 0)))
696 fatal(0, "trackdb_env->txn_begin: %s", db_strerror(err));
700 /* abort transaction */
701 void trackdb_abort_transaction(DB_TXN *tid) {
705 if((err = tid->abort(tid)))
706 fatal(0, "tid->abort: %s", db_strerror(err));
709 /* commit transaction */
710 void trackdb_commit_transaction(DB_TXN *tid) {
713 if((err = tid->commit(tid, 0)))
714 fatal(0, "tid->commit: %s", db_strerror(err));
717 /* search/tags shared code ***************************************************/
719 /* comparison function used by dedupe() */
720 static int wordcmp(const void *a, const void *b) {
721 return strcmp(*(const char **)a, *(const char **)b);
724 /* sort and de-dupe VEC */
725 static char **dedupe(char **vec, int nvec) {
728 qsort(vec, nvec, sizeof (char *), wordcmp);
732 for(n = 1; n < nvec; ++n)
733 if(strcmp(vec[n], vec[m - 1]))
740 /* update a key/track database. Returns 0 or DB_DEADLOCK. */
741 static int register_word(DB *db, const char *what,
742 const char *track, const char *word,
747 switch(err = db->put(db, tid, make_key(&key, word),
748 make_key(&data, track), DB_NODUPDATA)) {
752 case DB_LOCK_DEADLOCK:
753 error(0, "error updating %s.db: %s", what, db_strerror(err));
756 fatal(0, "error updating %s.db: %s", what, db_strerror(err));
760 /* search primitives *********************************************************/
762 /* return true iff NAME is a trackname_display_ pref */
763 static int is_display_pref(const char *name) {
764 static const char prefix[] = "trackname_display_";
765 return !strncmp(name, prefix, (sizeof prefix) - 1);
768 /** @brief Word_Break property tailor that treats underscores as spaces */
769 static int tailor_underscore_Word_Break_Other(uint32_t c) {
773 case 0x005F: /* LOW LINE (SPACING UNDERSCORE) */
774 return unicode_Word_Break_Other;
778 /** @brief Remove all combining characters in-place
779 * @param s Pointer to start of string
780 * @param ns Length of string
781 * @return New, possiblby reduced, length
783 static size_t remove_combining_chars(uint32_t *s, size_t ns) {
784 uint32_t *start = s, *t = s, *end = s + ns;
787 const uint32_t c = *s++;
788 if(!utf32_combining_class(c))
794 /** @brief Normalize and split a string using a given tailoring */
795 static void word_split(struct vector *v,
797 unicode_property_tailor *pt) {
799 uint32_t *t32, **w32;
801 /* Convert to UTF-32 */
802 if(!(t32 = utf8_to_utf32(s, strlen(s), &nt32)))
804 /* Erase case distinctions */
805 if(!(t32 = utf32_casefold_compat(t32, nt32, &nt32)))
807 /* Drop combining characters */
808 nt32 = remove_combining_chars(t32, nt32);
809 /* Split into words, treating _ as a space */
810 w32 = utf32_word_split(t32, nt32, &nw, pt);
811 /* Convert words back to UTF-8 and append to result */
812 for(i = 0; i < nw; ++i)
813 vector_append(v, utf32_to_utf8(w32[i], utf32_len(w32[i]), 0));
816 /** @brief Normalize a tag
818 * @param ns Length of tag
819 * @return Normalized string or NULL on error
821 * The return value will be:
823 * - have no leading or trailing space
824 * - have no combining characters
825 * - all spacing between words will be a single U+0020 SPACE
827 static char *normalize_tag(const char *s, size_t ns) {
828 uint32_t *s32, **w32;
829 size_t ns32, nw32, i;
832 if(!(s32 = utf8_to_utf32(s, ns, &ns32)))
834 if(!(s32 = utf32_casefold_compat(s32, ns32, &ns32))) /* ->NFKD */
836 ns32 = remove_combining_chars(s32, ns32);
837 /* Split into words, no Word_Break tailoring */
838 w32 = utf32_word_split(s32, ns32, &nw32, 0);
839 /* Compose back into a string */
841 for(i = 0; i < nw32; ++i) {
843 dynstr_append(d, ' ');
844 dynstr_append_string(d, utf32_to_utf8(w32[i], utf32_len(w32[i]), 0));
850 /* compute the words of a track name */
851 static char **track_to_words(const char *track,
852 const struct kvp *p) {
854 const char *rootless = track_rootless(track);
857 rootless = track; /* bodge */
859 rootless = strip_extension(rootless);
860 word_split(&v, strip_extension(rootless), tailor_underscore_Word_Break_Other);
861 for(; p; p = p->next)
862 if(is_display_pref(p->name))
863 word_split(&v, p->value, 0);
864 vector_terminate(&v);
865 return dedupe(v.vec, v.nvec);
868 /* return nonzero iff WORD is a stopword */
869 static int stopword(const char *word) {
872 for(n = 0; n < config->stopword.n
873 && strcmp(word, config->stopword.s[n]); ++n)
875 return n < config->stopword.n;
878 /* record that WORD appears in TRACK. Returns 0 or DB_LOCK_DEADLOCK. */
879 static int register_search_word(const char *track, const char *word,
881 if(stopword(word)) return 0;
882 return register_word(trackdb_searchdb, "search", track, word, tid);
885 /* Tags **********************************************************************/
887 /* Return nonzero if C is a valid tag character */
888 static int tagchar(int c) {
897 /* Parse and de-dupe a tag list. If S=0 then assumes "". */
898 char **parsetags(const char *s) {
904 /* skip initial separators */
905 while(*s && (!tagchar(*s) || *s == ' '))
908 /* find the extent of the tag */
910 while(*s && tagchar(*s))
912 /* strip trailing spaces */
913 while(s > t && s[-1] == ' ')
915 /* add tag to list */
916 vector_append(&v, normalize_tag(t, (size_t)(s - t)));
917 /* skip intermediate and trailing separators */
918 while(*s && (!tagchar(*s) || *s == ' '))
922 vector_terminate(&v);
923 return dedupe(v.vec, v.nvec);
926 /* Record that TRACK has TAG. Returns 0 or DB_LOCK_DEADLOCK. */
927 static int register_tag(const char *track, const char *tag, DB_TXN *tid) {
928 return register_word(trackdb_tagsdb, "tags", track, tag, tid);
931 /* aliases *******************************************************************/
933 /* compute the alias and store at aliasp. Returns 0 or DB_LOCK_DEADLOCK. If
934 * there is no alias sets *aliasp to 0. */
935 static int compute_alias(char **aliasp,
940 const char *s = config->alias, *t, *expansion, *part;
941 int c, used_db = 0, slash_prefix, err;
943 const char *const root = find_track_root(track);
946 /* Bodge for tracks with no root */
951 dynstr_append_string(&d, root);
952 while((c = (unsigned char)*s++)) {
954 dynstr_append(&d, c);
957 if((slash_prefix = (*s == '/')))
960 assert(t != 0); /* validated at startup */
961 part = xstrndup(s, t - s);
962 expansion = getpart(track, "display", part, p, &used_db);
964 if(slash_prefix) dynstr_append(&d, '/');
965 dynstr_append_string(&d, expansion);
967 s = t + 1; /* skip {part} */
969 /* only admit to the alias if we used the db... */
974 dynstr_terminate(&d);
975 /* ...and the answer differs from the original... */
976 if(!strcmp(track, d.vec)) {
980 /* ...and there isn't already a different track with that name (including as
982 switch(err = trackdb_getdata(trackdb_tracksdb, d.vec, &at, tid)) {
984 if((s = kvp_get(at, "_alias_for"))
985 && !strcmp(s, track)) {
997 /* get track and prefs data (if tp/pp not null pointers). Returns 0 on
998 * success, DB_NOTFOUND if the track does not exist or DB_LOCK_DEADLOCK.
999 * Always sets the return values, even if only to null pointers. */
1000 static int gettrackdata(const char *track,
1003 const char **actualp,
1005 #define GTD_NOALIAS 0x0001
1008 const char *actual = track;
1009 struct kvp *t = 0, *p = 0;
1011 if((err = trackdb_getdata(trackdb_tracksdb, track, &t, tid))) goto done;
1012 if((actual = kvp_get(t, "_alias_for"))) {
1013 if(flags & GTD_NOALIAS) {
1014 error(0, "alias passed to gettrackdata where real path required");
1017 if((err = trackdb_getdata(trackdb_tracksdb, actual, &t, tid))) goto done;
1020 assert(actual != 0);
1022 if((err = trackdb_getdata(trackdb_prefsdb, actual, &p, tid)) == DB_LOCK_DEADLOCK)
1027 if(actualp) *actualp = actual;
1033 /* trackdb_notice() **********************************************************/
1035 /** @brief notice a possibly new track
1036 * @return @c DB_NOTFOUND if new, 0 if already known
1038 int trackdb_notice(const char *track,
1044 tid = trackdb_begin_transaction();
1045 err = trackdb_notice_tid(track, path, tid);
1046 if((err == DB_LOCK_DEADLOCK)) goto fail;
1049 trackdb_abort_transaction(tid);
1051 trackdb_commit_transaction(tid);
1055 /** @brief notice a possibly new track
1056 * @param track NFC UTF-8 track name
1057 * @param path Raw path name
1058 * @param tid Transaction ID
1059 * @return @c DB_NOTFOUND if new, 0 if already known, @c DB_LOCK_DEADLOCK also
1061 int trackdb_notice_tid(const char *track,
1065 struct kvp *t, *a, *p;
1067 char *alias, **w, *noticed;
1070 /* notice whether the tracks.db entry changes */
1072 /* get any existing tracks entry */
1073 if((err = gettrackdata(track, &t, &p, 0, 0, tid)) == DB_LOCK_DEADLOCK)
1075 ret = err; /* 0 or DB_NOTFOUND */
1076 /* this is a real track */
1077 t_changed += kvp_set(&t, "_alias_for", 0);
1078 t_changed += kvp_set(&t, "_path", path);
1080 if(ret == DB_NOTFOUND) {
1081 /* It's a new track; record the time */
1082 byte_xasprintf(¬iced, "%lld", (long long)now);
1083 t_changed += kvp_set(&t, "_noticed", noticed);
1085 /* if we have an alias record it in the database */
1086 if((err = compute_alias(&alias, track, p, tid))) return err;
1088 /* won't overwrite someone else's alias as compute_alias() checks */
1089 D(("%s: alias %s", track, alias));
1091 kvp_set(&a, "_alias_for", track);
1092 if((err = trackdb_putdata(trackdb_tracksdb, alias, a, tid, 0))) return err;
1094 /* update search.db */
1095 w = track_to_words(track, p);
1096 for(n = 0; w[n]; ++n)
1097 if((err = register_search_word(track, w[n], tid)))
1099 /* update tags.db */
1100 w = parsetags(kvp_get(p, "tags"));
1101 for(n = 0; w[n]; ++n)
1102 if((err = register_tag(track, w[n], tid)))
1104 /* only store the tracks.db entry if it has changed */
1105 if(t_changed && (err = trackdb_putdata(trackdb_tracksdb, track, t, tid, 0)))
1107 if(ret == DB_NOTFOUND) {
1108 uint32_t timestamp[2];
1111 timestamp[0] = htonl((uint64_t)now >> 32);
1112 timestamp[1] = htonl((uint32_t)now);
1113 memset(&key, 0, sizeof key);
1114 key.data = timestamp;
1115 key.size = sizeof timestamp;
1116 switch(err = trackdb_noticeddb->put(trackdb_noticeddb, tid, &key,
1117 make_key(&data, track), 0)) {
1119 case DB_LOCK_DEADLOCK: return err;
1120 default: fatal(0, "error updating noticed.db: %s", db_strerror(err));
1126 /* trackdb_obsolete() ********************************************************/
1128 /* obsolete a track */
1129 int trackdb_obsolete(const char *track, DB_TXN *tid) {
1134 if((err = gettrackdata(track, 0, &p, 0,
1135 GTD_NOALIAS, tid)) == DB_LOCK_DEADLOCK)
1137 else if(err == DB_NOTFOUND) return 0;
1138 /* compute the alias, if any, and delete it */
1139 if((err = compute_alias(&alias, track, p, tid))) return err;
1141 /* if the alias points to some other track then compute_alias won't
1143 if((err = trackdb_delkey(trackdb_tracksdb, alias, tid))
1144 && err != DB_NOTFOUND)
1147 /* update search.db */
1148 w = track_to_words(track, p);
1149 for(n = 0; w[n]; ++n)
1150 if(trackdb_delkeydata(trackdb_searchdb,
1151 w[n], track, tid) == DB_LOCK_DEADLOCK)
1153 /* update tags.db */
1154 w = parsetags(kvp_get(p, "tags"));
1155 for(n = 0; w[n]; ++n)
1156 if(trackdb_delkeydata(trackdb_tagsdb,
1157 w[n], track, tid) == DB_LOCK_DEADLOCK)
1159 /* update tracks.db */
1160 if(trackdb_delkey(trackdb_tracksdb, track, tid) == DB_LOCK_DEADLOCK)
1162 /* We don't delete the prefs, so they survive temporary outages of the
1163 * (possibly virtual) track filesystem */
1167 /* trackdb_stats() ***********************************************************/
1169 #define H(name) { #name, offsetof(DB_HASH_STAT, name) }
1170 #define B(name) { #name, offsetof(DB_BTREE_STAT, name) }
1172 static const struct statinfo {
1175 } statinfo_hash[] = {
1191 }, statinfo_btree[] = {
1212 /* look up stats for DB */
1213 static int get_stats(struct vector *v,
1215 const struct statinfo *si,
1224 switch(err = database->stat(database, tid, &sp, 0)) {
1227 case DB_LOCK_DEADLOCK:
1228 error(0, "error querying database: %s", db_strerror(err));
1231 fatal(0, "error querying database: %s", db_strerror(err));
1233 for(n = 0; n < nsi; ++n) {
1234 byte_xasprintf(&str, "%s=%"PRIuMAX, si[n].name,
1235 (uintmax_t)*(u_int32_t *)((char *)sp + si[n].offset));
1236 vector_append(v, str);
1242 /** @brief One entry in the search league */
1243 struct search_entry {
1248 /** @brief Add a word to the search league
1249 * @param se Pointer to search league
1250 * @param count Maximum size for search league
1251 * @param nse Current size of search league
1252 * @param word New word, or NULL
1253 * @param n How often @p word appears
1254 * @return New size of search league
1256 static int register_search_entry(struct search_entry *se,
1263 if(word && (nse < count || n > se[nse - 1].n)) {
1264 /* Find the starting point */
1269 /* Find the insertion point */
1270 while(i > 0 && n > se[i - 1].n)
1272 memmove(&se[i + 1], &se[i], (nse - i - 1) * sizeof *se);
1279 /* find the top COUNT words in the search database */
1280 static int search_league(struct vector *v, int count, DB_TXN *tid) {
1281 struct search_entry *se;
1284 int err, n = 0, nse = 0, i;
1289 cursor = trackdb_opencursor(trackdb_searchdb, tid);
1290 se = xmalloc(count * sizeof *se);
1291 /* Walk across the whole database counting up the number of times each
1293 while(!(err = cursor->c_get(cursor, prepare_data(&k), prepare_data(&d),
1295 if(word && wl == k.size && !strncmp(word, k.data, wl))
1296 ++n; /* same word again */
1298 nse = register_search_entry(se, count, nse, word, n);
1299 word = xstrndup(k.data, wl = k.size);
1307 case DB_LOCK_DEADLOCK:
1308 error(0, "error querying search database: %s", db_strerror(err));
1311 fatal(0, "error querying search database: %s", db_strerror(err));
1313 if(trackdb_closecursor(cursor)) err = DB_LOCK_DEADLOCK;
1315 nse = register_search_entry(se, count, nse, word, n);
1316 byte_xasprintf(&str, "Top %d search words:", nse);
1317 vector_append(v, str);
1318 for(i = 0; i < nse; ++i) {
1319 byte_xasprintf(&str, "%4d: %5d %s", i + 1, se[i].n, se[i].word);
1320 vector_append(v, str);
1325 #define SI(what) statinfo_##what, \
1326 sizeof statinfo_##what / sizeof (struct statinfo)
1328 /* return a list of database stats */
1329 char **trackdb_stats(int *nstatsp) {
1335 tid = trackdb_begin_transaction();
1337 vector_append(&v, (char *)"Tracks database stats:");
1338 if(get_stats(&v, trackdb_tracksdb, SI(btree), tid)) goto fail;
1339 vector_append(&v, (char *)"");
1340 vector_append(&v, (char *)"Search database stats:");
1341 if(get_stats(&v, trackdb_searchdb, SI(hash), tid)) goto fail;
1342 vector_append(&v, (char *)"");
1343 vector_append(&v, (char *)"Prefs database stats:");
1344 if(get_stats(&v, trackdb_prefsdb, SI(hash), tid)) goto fail;
1345 vector_append(&v, (char *)"");
1346 if(search_league(&v, 10, tid)) goto fail;
1347 vector_terminate(&v);
1350 trackdb_abort_transaction(tid);
1352 trackdb_commit_transaction(tid);
1353 if(nstatsp) *nstatsp = v.nvec;
1357 struct stats_details {
1358 void (*done)(char *data, void *u);
1360 int exited; /* subprocess exited */
1361 int closed; /* pipe close */
1362 int wstat; /* wait status from subprocess */
1363 struct dynstr data[1]; /* data read from pipe */
1366 static void stats_complete(struct stats_details *d) {
1369 if(!(d->exited && d->closed))
1371 byte_xasprintf(&s, "\n"
1373 "track lookup cache hits: %lu\n"
1374 "track lookup cache misses: %lu\n",
1376 cache_files_misses);
1377 dynstr_append_string(d->data, s);
1378 dynstr_terminate(d->data);
1379 d->done(d->data->vec, d->u);
1382 static int stats_finished(ev_source attribute((unused)) *ev,
1385 const struct rusage attribute((unused)) *rusage,
1387 struct stats_details *const d = u;
1391 error(0, "disorder-stats %s", wstat(status));
1394 byte_xasprintf(&k, "%lu", (unsigned long)pid);
1395 hash_remove(stats_pids, k);
1399 static int stats_read(ev_source attribute((unused)) *ev,
1405 struct stats_details *const d = u;
1407 dynstr_append_bytes(d->data, ptr, bytes);
1408 ev_reader_consume(reader, bytes);
1415 static int stats_error(ev_source attribute((unused)) *ev,
1418 struct stats_details *const d = u;
1420 error(errno_value, "error reading from pipe to disorder-stats");
1426 void trackdb_stats_subprocess(ev_source *ev,
1427 void (*done)(char *data, void *u),
1431 struct stats_details *d = xmalloc(sizeof *d);
1433 dynstr_init(d->data);
1437 pid = subprogram(ev, p[1], "disorder-stats", (char *)0);
1439 ev_child(ev, pid, 0, stats_finished, d);
1440 if(!ev_reader_new(ev, p[0], stats_read, stats_error, d,
1441 "disorder-stats reader"))
1442 fatal(0, "ev_reader_new for disorder-stats reader failed");
1443 /* Remember the PID */
1445 stats_pids = hash_new(1);
1447 byte_xasprintf(&k, "%lu", (unsigned long)pid);
1448 hash_add(stats_pids, k, "", HASH_INSERT);
1451 /** @brief Parse a track name part preference
1452 * @param name Preference name
1453 * @param partp Where to store part name
1454 * @param contextp Where to store context name
1455 * @return 0 on success, non-0 if parse fails
1457 static int trackdb__parse_namepref(const char *name,
1461 static const char prefix[] = "trackname_";
1463 if(strncmp(name, prefix, strlen(prefix)))
1464 return -1; /* not trackname_* at all */
1465 name += strlen(prefix);
1466 /* There had better be a _ between context and part */
1467 c = strchr(name, '_');
1470 /* Context is first in the pref name even though most APIs have the part
1471 * first. Confusing; sorry. */
1472 *contextp = xstrndup(name, c - name);
1474 /* There had better NOT be a second _ */
1477 *partp = xstrdup(c);
1481 /** @brief Compute the default value for a track preference
1482 * @param track Track name
1483 * @param name Preference name
1484 * @return Default value or 0 if none/not known
1486 static const char *trackdb__default(const char *track, const char *name) {
1487 char *context, *part;
1489 if(!trackdb__parse_namepref(name, &part, &context)) {
1490 /* We can work out the default for a trackname_ pref */
1491 return trackname_part(track, context, part);
1492 } else if(!strcmp(name, "weight")) {
1493 /* We know the default weight */
1495 } else if(!strcmp(name, "pick_at_random")) {
1496 /* By default everything is eligible for picking at random */
1498 } else if(!strcmp(name, "tags")) {
1499 /* By default everything no track has any tags */
1505 /* set a pref (remove if value=0) */
1506 int trackdb_set(const char *track,
1508 const char *value) {
1509 struct kvp *t, *p, *a;
1512 char *oldalias, *newalias, **oldtags = 0, **newtags;
1515 /* If the value matches the default then unset instead, to keep the database
1516 * tidy. Older versions did not have this feature so your database may yet
1517 * have some default values stored in it. */
1519 def = trackdb__default(track, name);
1520 if(def && !strcmp(value, def))
1525 tid = trackdb_begin_transaction();
1526 if((err = gettrackdata(track, &t, &p, 0,
1527 0, tid)) == DB_LOCK_DEADLOCK)
1529 if(err == DB_NOTFOUND) break;
1530 if(name[0] == '_') {
1531 if(kvp_set(&t, name, value))
1532 if(trackdb_putdata(trackdb_tracksdb, track, t, tid, 0))
1535 /* get the old alias name */
1536 if(compute_alias(&oldalias, track, p, tid)) goto fail;
1537 /* get the old tags */
1538 if(!strcmp(name, "tags"))
1539 oldtags = parsetags(kvp_get(p, "tags"));
1541 if(kvp_set(&p, name, value))
1542 if(trackdb_putdata(trackdb_prefsdb, track, p, tid, 0))
1544 /* compute the new alias name */
1545 if((err = compute_alias(&newalias, track, p, tid))) goto fail;
1546 /* check whether alias has changed */
1547 if(!(oldalias == newalias
1548 || (oldalias && newalias && !strcmp(oldalias, newalias)))) {
1549 /* adjust alias records to fit change */
1551 && trackdb_delkey(trackdb_tracksdb, oldalias, tid) == DB_LOCK_DEADLOCK)
1555 kvp_set(&a, "_alias_for", track);
1556 if(trackdb_putdata(trackdb_tracksdb, newalias, a, tid, 0)) goto fail;
1559 /* check whether tags have changed */
1560 if(!strcmp(name, "tags")) {
1561 newtags = parsetags(value);
1562 while(*oldtags || *newtags) {
1563 if(*oldtags && *newtags) {
1564 cmp = strcmp(*oldtags, *newtags);
1566 /* keeping this tag */
1570 /* old tag fits into a gap in the new list, so delete old */
1573 /* new tag fits into a gap in the old list, so insert new */
1575 } else if(*oldtags) {
1576 /* we've run out of new tags, so remaining old ones are to be
1579 if(trackdb_delkeydata(trackdb_tagsdb,
1580 *oldtags, track, tid) == DB_LOCK_DEADLOCK)
1584 /* we've run out of old tags, so remainig new ones are to be
1587 if(register_tag(track, *newtags, tid)) goto fail;
1596 trackdb_abort_transaction(tid);
1598 trackdb_commit_transaction(tid);
1599 return err == 0 ? 0 : -1;
1603 const char *trackdb_get(const char *track,
1605 return kvp_get(trackdb_get_all(track), name);
1608 /* get all prefs as a 0-terminated array */
1609 struct kvp *trackdb_get_all(const char *track) {
1610 struct kvp *t, *p, **pp;
1614 tid = trackdb_begin_transaction();
1615 if(gettrackdata(track, &t, &p, 0, 0, tid) == DB_LOCK_DEADLOCK)
1619 trackdb_abort_transaction(tid);
1621 trackdb_commit_transaction(tid);
1622 for(pp = &p; *pp; pp = &(*pp)->next)
1629 const char *trackdb_resolve(const char *track) {
1634 tid = trackdb_begin_transaction();
1635 if(gettrackdata(track, 0, 0, &actual, 0, tid) == DB_LOCK_DEADLOCK)
1639 trackdb_abort_transaction(tid);
1641 trackdb_commit_transaction(tid);
1645 int trackdb_isalias(const char *track) {
1646 const char *actual = trackdb_resolve(track);
1648 return strcmp(actual, track);
1651 /* test whether a track exists (perhaps an alias) */
1652 int trackdb_exists(const char *track) {
1657 tid = trackdb_begin_transaction();
1658 /* unusually, here we want the return value */
1659 if((err = gettrackdata(track, 0, 0, 0, 0, tid)) == DB_LOCK_DEADLOCK)
1663 trackdb_abort_transaction(tid);
1665 trackdb_commit_transaction(tid);
1669 /* return the list of tags */
1670 char **trackdb_alltags(void) {
1675 WITH_TRANSACTION(trackdb_listkeys(trackdb_tagsdb, v, tid));
1679 /** @brief List all the keys in @p db
1680 * @param db Database
1681 * @param v Vector to store keys in
1682 * @param tid Transaction ID
1683 * @return 0 or DB_LOCK_DEADLOCK
1685 int trackdb_listkeys(DB *db, struct vector *v, DB_TXN *tid) {
1688 DBC *const c = trackdb_opencursor(db, tid);
1691 memset(&k, 0, sizeof k);
1692 while(!(e = c->c_get(c, &k, prepare_data(&d), DB_NEXT_NODUP)))
1693 vector_append(v, xstrndup(k.data, k.size));
1697 case DB_LOCK_DEADLOCK:
1700 fatal(0, "c->c_get: %s", db_strerror(e));
1702 if((e = trackdb_closecursor(c)))
1704 vector_terminate(v);
1708 /* return 1 iff sorted tag lists A and B have at least one member in common */
1709 int tag_intersection(char **a, char **b) {
1712 /* Same sort of logic as trackdb_set() above */
1714 if(!(cmp = strcmp(*a, *b))) return 1;
1715 else if(cmp < 0) ++a;
1721 static pid_t choose_pid = -1;
1722 static int choose_fd;
1723 static random_callback *choose_callback;
1724 static struct dynstr choose_output;
1725 static unsigned choose_complete;
1726 static int choose_status;
1727 #define CHOOSE_RUNNING 1
1728 #define CHOOSE_READING 2
1730 static void choose_finished(ev_source *ev, unsigned which) {
1731 choose_complete |= which;
1732 if(choose_complete != (CHOOSE_RUNNING|CHOOSE_READING))
1735 if(choose_status == 0 && choose_output.nvec > 0) {
1736 dynstr_terminate(&choose_output);
1737 choose_callback(ev, xstrdup(choose_output.vec));
1739 choose_callback(ev, 0);
1742 /** @brief Called when @c disorder-choose terminates */
1743 static int choose_exited(ev_source *ev,
1744 pid_t attribute((unused)) pid,
1746 const struct rusage attribute((unused)) *rusage,
1747 void attribute((unused)) *u) {
1749 error(0, "disorder-choose %s", wstat(status));
1750 choose_status = status;
1751 choose_finished(ev, CHOOSE_RUNNING);
1755 /** @brief Called with data from @c disorder-choose pipe */
1756 static int choose_readable(ev_source *ev,
1761 void attribute((unused)) *u) {
1762 dynstr_append_bytes(&choose_output, ptr, bytes);
1763 ev_reader_consume(reader, bytes);
1765 choose_finished(ev, CHOOSE_READING);
1769 static int choose_read_error(ev_source *ev,
1771 void attribute((unused)) *u) {
1772 error(errno_value, "error reading disorder-choose pipe");
1773 choose_finished(ev, CHOOSE_READING);
1777 /** @brief Request a random track
1778 * @param ev Event source
1779 * @param callback Called with random track or NULL
1780 * @return 0 if a request was initiated, else -1
1782 * Initiates a random track choice. @p callback will later be called back with
1783 * the choice (or NULL on error). If a choice is already underway then -1 is
1784 * returned and there will be no additional callback.
1786 * The caller shouldn't assume that the track returned actually exists (it
1787 * might be removed between the choice and the callback, or between being added
1788 * to the queue and being played).
1790 int trackdb_request_random(ev_source *ev,
1791 random_callback *callback) {
1794 if(choose_pid != -1)
1795 return -1; /* don't run concurrent chooses */
1798 choose_pid = subprogram(ev, p[1], "disorder-choose", (char *)0);
1801 choose_callback = callback;
1802 choose_output.nvec = 0;
1803 choose_complete = 0;
1804 if(!ev_reader_new(ev, p[0], choose_readable, choose_read_error, 0,
1805 "disorder-choose reader")) /* owns p[0] */
1806 fatal(0, "ev_reader_new for disorder-choose reader failed");
1807 ev_child(ev, choose_pid, 0, choose_exited, 0); /* owns the subprocess */
1811 /* get a track name given the prefs. Set *used_db to 1 if we got the answer
1812 * from the prefs. */
1813 static const char *getpart(const char *track,
1814 const char *context,
1816 const struct kvp *p,
1821 byte_xasprintf(&pref, "trackname_%s_%s", context, part);
1822 if((result = kvp_get(p, pref)))
1825 result = trackname_part(track, context, part);
1826 assert(result != 0);
1830 /* get a track name part, like trackname_part(), but taking the database into
1832 const char *trackdb_getpart(const char *track,
1833 const char *context,
1841 /* construct the full pref */
1842 byte_xasprintf(&pref, "trackname_%s_%s", context, part);
1844 tid = trackdb_begin_transaction();
1845 if((err = gettrackdata(track, 0, &p, &actual, 0, tid)) == DB_LOCK_DEADLOCK)
1849 trackdb_abort_transaction(tid);
1851 trackdb_commit_transaction(tid);
1852 return getpart(actual, context, part, p, &used_db);
1855 /* get the raw path name for @track@ (might be an alias) */
1856 const char *trackdb_rawpath(const char *track) {
1862 tid = trackdb_begin_transaction();
1863 if(gettrackdata(track, &t, 0, 0, 0, tid) == DB_LOCK_DEADLOCK)
1867 trackdb_abort_transaction(tid);
1869 trackdb_commit_transaction(tid);
1870 if(!(path = kvp_get(t, "_path"))) path = track;
1874 /* trackdb_list **************************************************************/
1876 /* this is incredibly ugly, sorry, perhaps it will be rewritten to be actually
1877 * readable at some point */
1879 /* return true if the basename of TRACK[0..TL-1], as defined by DL, matches RE.
1880 * If RE is a null pointer then it matches everything. */
1881 static int track_matches(size_t dl, const char *track, size_t tl,
1889 switch(rc = pcre_exec(re, 0, track, tl, 0, 0, ovec, 3)) {
1890 case PCRE_ERROR_NOMATCH: return 0;
1893 error(0, "pcre_exec returned %d, subject '%s'", rc, track);
1900 static int do_list(struct vector *v, const char *dir,
1901 enum trackdb_listable what, const pcre *re, DB_TXN *tid) {
1907 size_t l, last_dir_len = 0;
1908 char *last_dir = 0, *track;
1912 cursor = trackdb_opencursor(trackdb_tracksdb, tid);
1915 /* find the first key >= dir */
1916 err = cursor->c_get(cursor, &k, &d, DB_SET_RANGE);
1917 /* keep going while we're dealing with <dir/anything> */
1920 && ((char *)k.data)[dl] == '/'
1921 && !memcmp(k.data, dir, dl)) {
1922 ptr = memchr((char *)k.data + dl + 1, '/', k.size - (dl + 1));
1924 /* we have <dir/component/anything>, so <dir/component> is a directory */
1925 l = ptr - (char *)k.data;
1926 if(what & trackdb_directories)
1928 && l == last_dir_len
1929 && !memcmp(last_dir, k.data, l))) {
1930 last_dir = xstrndup(k.data, last_dir_len = l);
1931 if(track_matches(dl, k.data, l, re))
1932 vector_append(v, last_dir);
1935 /* found a plain file */
1936 if((what & trackdb_files)) {
1937 track = xstrndup(k.data, k.size);
1938 if((err = trackdb_getdata(trackdb_prefsdb,
1939 track, &p, tid)) == DB_LOCK_DEADLOCK)
1941 /* There's an awkward question here...
1943 * If a track shares a directory with its alias then we could
1944 * do one of three things:
1945 * - report both. Looks ridiculuous in most UIs.
1946 * - report just the alias. Remarkably inconvenient to write
1948 * - report just the real name. Ugly if the UI doesn't prettify
1949 * names via the name parts.
1952 /* If this file is an alias for a track in the same directory then we
1954 struct kvp *t = kvp_urldecode(d.data, d.size);
1955 const char *alias_target = kvp_get(t, "_alias_for");
1957 && !strcmp(d_dirname(alias_target),
1959 if(track_matches(dl, k.data, k.size, re))
1960 vector_append(v, track);
1962 /* if this file has an alias in the same directory then we skip it */
1964 if((err = compute_alias(&alias, track, p, tid)))
1966 if(!(alias && !strcmp(d_dirname(alias), d_dirname(track))))
1967 if(track_matches(dl, k.data, k.size, re))
1968 vector_append(v, track);
1972 err = cursor->c_get(cursor, &k, &d, DB_NEXT);
1980 case DB_LOCK_DEADLOCK:
1981 error(0, "error querying database: %s", db_strerror(err));
1984 fatal(0, "error querying database: %s", db_strerror(err));
1987 if(trackdb_closecursor(cursor)) err = DB_LOCK_DEADLOCK;
1991 /* return the directories or files below @dir@ */
1992 char **trackdb_list(const char *dir, int *np, enum trackdb_listable what,
2000 tid = trackdb_begin_transaction();
2003 if(do_list(&v, dir, what, re, tid))
2006 for(n = 0; n < config->collection.n; ++n)
2007 if(do_list(&v, config->collection.s[n].root, what, re, tid))
2012 trackdb_abort_transaction(tid);
2014 trackdb_commit_transaction(tid);
2015 vector_terminate(&v);
2021 /* If S is tag:something, return something. Else return 0. */
2022 static const char *checktag(const char *s) {
2023 if(!strncmp(s, "tag:", 4))
2029 /* return a list of tracks containing all of the words given. If you
2030 * ask for only stopwords you get no tracks. */
2031 char **trackdb_search(char **wordlist, int nwordlist, int *ntracks) {
2032 const char **w, *best = 0, *tag;
2033 char **twords, **tags;
2035 int i, j, n, err, what;
2045 *ntracks = 0; /* for early returns */
2046 /* normalize all the words */
2047 w = xmalloc(nwordlist * sizeof (char *));
2048 istag = xmalloc_noptr(nwordlist);
2049 for(n = 0; n < nwordlist; ++n) {
2053 w[n] = utf8_casefold_compat(wordlist[n], strlen(wordlist[n]), 0);
2054 if(checktag(w[n])) {
2055 ++ntags; /* count up tags */
2056 /* Normalize the tag */
2057 w[n] = normalize_tag(w[n] + 4, strlen(w[n] + 4));
2060 /* Normalize the search term by removing combining characters */
2061 if(!(w32 = utf8_to_utf32(w[n], strlen(w[n]), &nw32)))
2063 nw32 = remove_combining_chars(w32, nw32);
2064 if(!(w[n] = utf32_to_utf8(w32, nw32, 0)))
2069 /* find the longest non-stopword */
2070 for(n = 0; n < nwordlist; ++n)
2071 if(!istag[n] && !stopword(w[n]))
2072 if(!best || strlen(w[n]) > strlen(best))
2074 /* TODO: we should at least in principal be able to identify the word or tag
2075 * with the least matches in log time, and choose that as our primary search
2077 if(ntags && !best) {
2078 /* Only tags are listed. We limit to the first and narrow down with the
2080 best = istag[0] ? w[0] : 0;
2081 db = trackdb_tagsdb;
2084 /* We can limit to some word. */
2085 db = trackdb_searchdb;
2088 /* Only stopwords */
2094 tid = trackdb_begin_transaction();
2095 /* find all the tracks that have that word */
2100 cursor = trackdb_opencursor(db, tid);
2101 while(!(err = cursor->c_get(cursor, &k, &d, what))) {
2102 vector_append(&v, xstrndup(d.data, d.size));
2109 case DB_LOCK_DEADLOCK:
2110 error(0, "error querying %s database: %s", dbname, db_strerror(err));
2113 fatal(0, "error querying %s database: %s", dbname, db_strerror(err));
2115 if(trackdb_closecursor(cursor)) err = DB_LOCK_DEADLOCK;
2117 /* do a naive search over that (hopefuly fairly small) list of tracks */
2119 for(n = 0; n < v.nvec; ++n) {
2120 if((err = gettrackdata(v.vec[n], 0, &p, 0, 0, tid) == DB_LOCK_DEADLOCK))
2123 error(0, "track %s unexpected error: %s", v.vec[n], db_strerror(err));
2126 twords = track_to_words(v.vec[n], p);
2127 tags = parsetags(kvp_get(p, "tags"));
2128 for(i = 0; i < nwordlist; ++i) {
2131 /* Track must have this tag */
2132 for(j = 0; tags[j]; ++j)
2133 if(!strcmp(tag, tags[j])) break; /* tag found */
2134 if(!tags[j]) break; /* tag not found */
2136 /* Track must contain this word */
2137 for(j = 0; twords[j]; ++j)
2138 if(!strcmp(w[i], twords[j])) break; /* word found */
2139 if(!twords[j]) break; /* word not found */
2142 if(i >= nwordlist) /* all words found */
2143 vector_append(&u, v.vec[n]);
2147 trackdb_closecursor(cursor);
2149 trackdb_abort_transaction(tid);
2150 info("retrying search");
2152 trackdb_commit_transaction(tid);
2153 vector_terminate(&u);
2159 /* trackdb_scan **************************************************************/
2161 int trackdb_scan(const char *root,
2162 int (*callback)(const char *track,
2171 const size_t root_len = root ? strlen(root) : 0;
2173 struct kvp *data, *prefs;
2176 cursor = trackdb_opencursor(trackdb_tracksdb, tid);
2178 err = cursor->c_get(cursor, make_key(&k, root), prepare_data(&d),
2181 memset(&k, 0, sizeof k);
2182 err = cursor->c_get(cursor, &k, prepare_data(&d),
2187 || (k.size > root_len
2188 && !strncmp(k.data, root, root_len)
2189 && ((char *)k.data)[root_len] == '/')) {
2190 data = kvp_urldecode(d.data, d.size);
2191 if(kvp_get(data, "_path")) {
2192 track = xstrndup(k.data, k.size);
2193 /* TODO: trackdb_prefsdb is currently a DB_HASH. This means we have to
2194 * do a lookup for every single track. In fact this is quite quick:
2195 * with around 10,000 tracks a complete scan is around 0.3s on my
2196 * 2.2GHz Athlon. However, if it were a DB_BTREE, we could do the same
2197 * linear walk as we already do over trackdb_tracksdb, and probably get
2198 * even higher performance. That would require upgrade logic to
2199 * translate old databases though.
2201 switch(err = trackdb_prefsdb->get(trackdb_prefsdb, tid, &k,
2202 prepare_data(&pd), 0)) {
2204 prefs = kvp_urldecode(pd.data, pd.size);
2209 case DB_LOCK_DEADLOCK:
2210 error(0, "getting prefs: %s", db_strerror(err));
2211 trackdb_closecursor(cursor);
2214 fatal(0, "getting prefs: %s", db_strerror(err));
2216 /* Advance to the next track before the callback so that the callback
2217 * may safely delete the track */
2218 err = cursor->c_get(cursor, &k, &d, DB_NEXT);
2219 if((cberr = callback(track, data, prefs, u, tid))) {
2224 err = cursor->c_get(cursor, &k, &d, DB_NEXT);
2228 trackdb_closecursor(cursor);
2235 case DB_LOCK_DEADLOCK:
2236 error(0, "c->c_get: %s", db_strerror(err));
2239 fatal(0, "c->c_get: %s", db_strerror(err));
2243 /* trackdb_rescan ************************************************************/
2245 /** @brief Node in the list of rescan-complete callbacks */
2246 struct rescanned_node {
2247 struct rescanned_node *next;
2248 void (*rescanned)(void *ru);
2252 /** @brief List of rescan-complete callbacks */
2253 static struct rescanned_node *rescanned_list;
2255 /** @brief Add a rescan completion callback */
2256 void trackdb_add_rescanned(void (*rescanned)(void *ru),
2259 struct rescanned_node *n = xmalloc(sizeof *n);
2260 n->next = rescanned_list;
2261 n->rescanned = rescanned;
2267 /* called when the rescanner terminates */
2268 static int reap_rescan(ev_source attribute((unused)) *ev,
2271 const struct rusage attribute((unused)) *rusage,
2272 void attribute((unused)) *u) {
2273 if(pid == rescan_pid) rescan_pid = -1;
2275 error(0, RESCAN": %s", wstat(status));
2277 D((RESCAN" terminated: %s", wstat(status)));
2278 /* Our cache of file lookups is out of date now */
2279 cache_clean(&cache_files_type);
2280 eventlog("rescanned", (char *)0);
2281 /* Call rescanned callbacks */
2282 while(rescanned_list) {
2283 void (*rescanned)(void *u_) = rescanned_list->rescanned;
2284 void *ru = rescanned_list->ru;
2286 rescanned_list = rescanned_list->next;
2292 /** @brief Initiate a rescan
2293 * @param ev Event loop or 0 to block
2294 * @param recheck 1 to recheck lengths, 0 to suppress check
2295 * @param rescanned Called on completion (if not NULL)
2296 * @param ru Passed to @p rescanned
2298 void trackdb_rescan(ev_source *ev, int recheck,
2299 void (*rescanned)(void *ru),
2303 if(rescan_pid != -1) {
2304 trackdb_add_rescanned(rescanned, ru);
2305 error(0, "rescan already underway");
2308 rescan_pid = subprogram(ev, -1, RESCAN,
2309 recheck ? "--check" : "--no-check",
2311 trackdb_add_rescanned(rescanned, ru);
2313 ev_child(ev, rescan_pid, 0, reap_rescan, 0);
2314 D(("started rescanner"));
2316 /* This is the first rescan, we block until it is complete */
2317 while(waitpid(rescan_pid, &w, 0) < 0 && errno == EINTR)
2319 reap_rescan(0, rescan_pid, w, 0, 0);
2323 int trackdb_rescan_cancel(void) {
2324 if(rescan_pid == -1) return 0;
2325 if(kill(rescan_pid, SIGTERM) < 0)
2326 fatal(errno, "error killing rescanner");
2331 /** @brief Return true if a rescan is underway */
2332 int trackdb_rescan_underway(void) {
2333 return rescan_pid != -1;
2336 /* global prefs **************************************************************/
2338 void trackdb_set_global(const char *name,
2346 tid = trackdb_begin_transaction();
2347 if(!(err = trackdb_set_global_tid(name, value, tid)))
2349 trackdb_abort_transaction(tid);
2351 trackdb_commit_transaction(tid);
2352 /* log important state changes */
2353 if(!strcmp(name, "playing")) {
2354 state = !value || !strcmp(value, "yes");
2355 info("playing %s by %s",
2356 state ? "enabled" : "disabled",
2358 eventlog("state", state ? "enable_play" : "disable_play", (char *)0);
2360 if(!strcmp(name, "random-play")) {
2361 state = !value || !strcmp(value, "yes");
2362 info("random play %s by %s",
2363 state ? "enabled" : "disabled",
2365 eventlog("state", state ? "enable_random" : "disable_random", (char *)0);
2369 int trackdb_set_global_tid(const char *name,
2375 memset(&k, 0, sizeof k);
2376 memset(&d, 0, sizeof d);
2377 k.data = (void *)name;
2378 k.size = strlen(name);
2380 d.data = (void *)value;
2381 d.size = strlen(value);
2384 err = trackdb_globaldb->put(trackdb_globaldb, tid, &k, &d, 0);
2386 err = trackdb_globaldb->del(trackdb_globaldb, tid, &k, 0);
2387 if(err == DB_LOCK_DEADLOCK) return err;
2389 fatal(0, "error updating database: %s", db_strerror(err));
2393 const char *trackdb_get_global(const char *name) {
2399 tid = trackdb_begin_transaction();
2400 if(!(err = trackdb_get_global_tid(name, tid, &r)))
2402 trackdb_abort_transaction(tid);
2404 trackdb_commit_transaction(tid);
2408 int trackdb_get_global_tid(const char *name,
2414 memset(&k, 0, sizeof k);
2415 k.data = (void *)name;
2416 k.size = strlen(name);
2417 switch(err = trackdb_globaldb->get(trackdb_globaldb, tid, &k,
2418 prepare_data(&d), 0)) {
2420 *rp = xstrndup(d.data, d.size);
2425 case DB_LOCK_DEADLOCK:
2428 fatal(0, "error reading database: %s", db_strerror(err));
2432 /** @brief Retrieve the most recently added tracks
2433 * @param ntracksp Where to put count, or 0
2434 * @param maxtracks Maximum number of tracks to retrieve
2435 * @return null-terminated array of track names
2437 * The most recently added track is first in the array.
2439 char **trackdb_new(int *ntracksp,
2445 tid = trackdb_begin_transaction();
2446 tracks = trackdb_new_tid(ntracksp, maxtracks, tid);
2449 trackdb_abort_transaction(tid);
2451 trackdb_commit_transaction(tid);
2455 /** @brief Retrieve the most recently added tracks
2456 * @param ntracksp Where to put count, or 0
2457 * @param maxtracks Maximum number of tracks to retrieve, or 0 for all
2458 * @param tid Transaction ID
2459 * @return null-terminated array of track names, or NULL on deadlock
2461 * The most recently added track is first in the array.
2463 static char **trackdb_new_tid(int *ntracksp,
2469 struct vector tracks[1];
2470 hash *h = hash_new(1);
2472 vector_init(tracks);
2473 c = trackdb_opencursor(trackdb_noticeddb, tid);
2474 while((maxtracks <= 0 || tracks->nvec < maxtracks)
2475 && !(err = c->c_get(c, prepare_data(&k), prepare_data(&d), DB_PREV))) {
2476 char *const track = xstrndup(d.data, d.size);
2477 /* Don't add any track more than once */
2478 if(hash_add(h, track, "", HASH_INSERT))
2480 /* See if the track still exists */
2481 err = trackdb_getdata(trackdb_tracksdb, track, NULL/*kp*/, tid);
2482 if(err == DB_NOTFOUND)
2483 continue; /* It doesn't, skip it */
2484 if(err == DB_LOCK_DEADLOCK)
2486 vector_append(tracks, track);
2489 case 0: /* hit maxtracks */
2490 case DB_NOTFOUND: /* ran out of tracks */
2492 case DB_LOCK_DEADLOCK:
2493 trackdb_closecursor(c);
2496 fatal(0, "error reading noticed.db: %s", db_strerror(err));
2498 if((err = trackdb_closecursor(c)))
2499 return 0; /* deadlock */
2500 vector_terminate(tracks);
2502 *ntracksp = tracks->nvec;
2506 /** @brief Expire noticed.db
2507 * @param earliest Earliest timestamp to keep
2509 void trackdb_expire_noticed(time_t earliest) {
2513 tid = trackdb_begin_transaction();
2514 if(!trackdb_expire_noticed_tid(earliest, tid))
2516 trackdb_abort_transaction(tid);
2518 trackdb_commit_transaction(tid);
2521 /** @brief Expire noticed.db
2522 * @param earliest Earliest timestamp to keep
2523 * @param tid Transaction ID
2524 * @return 0 or DB_LOCK_DEADLOCK
2526 static int trackdb_expire_noticed_tid(time_t earliest, DB_TXN *tid) {
2534 c = trackdb_opencursor(trackdb_noticeddb, tid);
2535 while(!(err = c->c_get(c, prepare_data(&k), prepare_data(&d), DB_NEXT))) {
2537 when = (time_t)(((uint64_t)ntohl(kk[0]) << 32) + ntohl(kk[1]));
2538 if(when >= earliest)
2540 if((err = c->c_del(c, 0))) {
2541 if(err != DB_LOCK_DEADLOCK)
2542 fatal(0, "error deleting expired noticed.db entry: %s",
2548 if(err == DB_NOTFOUND)
2550 if(err && err != DB_LOCK_DEADLOCK)
2551 fatal(0, "error expiring noticed.db: %s", db_strerror(err));
2553 if((err = trackdb_closecursor(c))) {
2554 if(err != DB_LOCK_DEADLOCK)
2555 fatal(0, "error closing cursor: %s", db_strerror(err));
2559 info("expired %d tracks from noticed.db", count);
2563 /* tidying up ****************************************************************/
2565 void trackdb_gc(void) {
2569 if((err = trackdb_env->txn_checkpoint(trackdb_env,
2570 config->checkpoint_kbyte,
2571 config->checkpoint_min,
2573 fatal(0, "trackdb_env->txn_checkpoint: %s", db_strerror(err));
2574 if((err = trackdb_env->log_archive(trackdb_env, &logfiles, DB_ARCH_REMOVE)))
2575 fatal(0, "trackdb_env->log_archive: %s", db_strerror(err));
2576 /* This makes catastrophic recovery impossible. However, the user can still
2577 * preserve the important data by using disorder-dump to snapshot their
2578 * prefs, and later to restore it. This is likely to have much small
2579 * long-term storage requirements than record the db logfiles. */
2582 /* user database *************************************************************/
2584 /** @brief Return true if @p user is trusted */
2585 static int trusted(const char *user) {
2588 for(n = 0; (n < config->trust.n
2589 && strcmp(config->trust.s[n], user)); ++n)
2591 return n < config->trust.n;
2594 /** @brief Return non-zero for a valid username
2596 * Currently we only allow the letters and digits in ASCII. We could be more
2597 * liberal than this but it is a nice simple test. It is critical that
2598 * semicolons are never allowed.
2600 * NB also used by playlist_parse_name() to validate playlist names!
2602 int valid_username(const char *user) {
2606 const uint8_t c = *user++;
2607 /* For now we are very strict */
2608 if((c >= 'a' && c <= 'z')
2609 || (c >= 'A' && c <= 'Z')
2610 || (c >= '0' && c <= '9'))
2618 /** @brief Add a user */
2619 static int create_user(const char *user,
2620 const char *password,
2623 const char *confirmation,
2629 /* sanity check user */
2630 if(!valid_username(user)) {
2631 error(0, "invalid username '%s'", user);
2634 if(parse_rights(rights, 0, 1)) {
2635 error(0, "invalid rights string");
2638 /* data for this user */
2640 kvp_set(&k, "password", password);
2641 kvp_set(&k, "rights", rights);
2643 kvp_set(&k, "email", email);
2645 kvp_set(&k, "confirmation", confirmation);
2646 snprintf(s, sizeof s, "%jd", (intmax_t)xtime(0));
2647 kvp_set(&k, "created", s);
2648 return trackdb_putdata(trackdb_usersdb, user, k, tid, flags);
2651 /** @brief Add one pre-existing user */
2652 static int one_old_user(const char *user, const char *password,
2656 /* www-data doesn't get added */
2657 if(!strcmp(user, "www-data")) {
2658 info("not adding www-data to user database");
2662 if(!strcmp(user, "root"))
2664 else if(trusted(user)) {
2667 parse_rights(config->default_rights, &r, 1);
2668 r &= ~(rights_type)(RIGHT_SCRATCH__MASK|RIGHT_MOVE__MASK|RIGHT_REMOVE__MASK);
2669 r |= (RIGHT_ADMIN|RIGHT_RESCAN
2670 |RIGHT_SCRATCH_ANY|RIGHT_MOVE_ANY|RIGHT_REMOVE_ANY);
2671 rights = rights_string(r);
2673 rights = config->default_rights;
2674 return create_user(user, password, rights, 0/*email*/, 0/*confirmation*/,
2675 tid, DB_NOOVERWRITE);
2678 static int trackdb_old_users_tid(DB_TXN *tid) {
2681 for(n = 0; n < config->allow.n; ++n) {
2682 switch(one_old_user(config->allow.s[n].s[0], config->allow.s[n].s[1],
2685 info("created user %s from 'allow' directive", config->allow.s[n].s[0]);
2688 error(0, "user %s already exists, delete 'allow' directive",
2689 config->allow.s[n].s[0]);
2690 /* This won't ever become fatal - eventually 'allow' will be
2693 case DB_LOCK_DEADLOCK:
2694 return DB_LOCK_DEADLOCK;
2700 /** @brief Read old 'allow' directives and copy them to the users database */
2701 void trackdb_old_users(void) {
2705 WITH_TRANSACTION(trackdb_old_users_tid(tid));
2708 /** @brief Create a root user in the user database if there is none */
2709 void trackdb_create_root(void) {
2714 /* Choose a new root password */
2715 gcry_randomize(pwbin, sizeof pwbin, GCRY_STRONG_RANDOM);
2716 pw = mime_to_base64(pwbin, sizeof pwbin);
2717 /* Create the root user if it does not exist */
2718 WITH_TRANSACTION(create_user("root", pw, "all",
2719 0/*email*/, 0/*confirmation*/,
2720 tid, DB_NOOVERWRITE));
2722 info("created root user");
2725 /** @brief Find a user's password from the database
2726 * @param user Username
2727 * @return Password or NULL
2729 * Only works if running as a user that can read the database!
2731 * If the user exists but has no password, "" is returned.
2733 const char *trackdb_get_password(const char *user) {
2736 const char *password;
2738 WITH_TRANSACTION(trackdb_getdata(trackdb_usersdb, user, &k, tid));
2741 password = kvp_get(k, "password");
2742 return password ? password : "";
2745 /** @brief Add a new user
2746 * @param user Username
2747 * @param password Password or NULL
2748 * @param rights Initial rights
2749 * @param email Email address or NULL
2750 * @param confirmation Confirmation string or NULL
2751 * @return 0 on success, non-0 on error
2753 int trackdb_adduser(const char *user,
2754 const char *password,
2757 const char *confirmation) {
2760 WITH_TRANSACTION(create_user(user, password, rights, email, confirmation,
2761 tid, DB_NOOVERWRITE));
2763 error(0, "cannot create user '%s' because they already exist", user);
2767 info("created user '%s' with rights '%s' and email address '%s'",
2768 user, rights, email);
2770 info("created user '%s' with rights '%s'", user, rights);
2771 eventlog("user_add", user, (char *)0);
2776 /** @brief Delete a user
2777 * @param user User to delete
2778 * @return 0 on success, non-0 if the user didn't exist anyway
2780 int trackdb_deluser(const char *user) {
2783 WITH_TRANSACTION(trackdb_delkey(trackdb_usersdb, user, tid));
2785 error(0, "cannot delete user '%s' because they do not exist", user);
2788 info("deleted user '%s'", user);
2789 eventlog("user_delete", user, (char *)0);
2793 /** @brief Get user information
2794 * @param user User to query
2795 * @return Linked list of user information or NULL if user does not exist
2797 * Every user has at least a @c rights entry so NULL can be used to mean no
2800 struct kvp *trackdb_getuserinfo(const char *user) {
2804 WITH_TRANSACTION(trackdb_getdata(trackdb_usersdb, user, &k, tid));
2811 /** @brief Edit user information
2812 * @param user User to edit
2813 * @param key Key to change
2814 * @param value Value to set, or NULL to remove
2815 * @param tid Transaction ID
2816 * @return 0, DB_LOCK_DEADLOCK or DB_NOTFOUND
2818 static int trackdb_edituserinfo_tid(const char *user, const char *key,
2819 const char *value, DB_TXN *tid) {
2823 if((e = trackdb_getdata(trackdb_usersdb, user, &k, tid)))
2825 if(!kvp_set(&k, key, value))
2826 return 0; /* no change */
2827 return trackdb_putdata(trackdb_usersdb, user, k, tid, 0);
2830 /** @brief Edit user information
2831 * @param user User to edit
2832 * @param key Key to change
2833 * @param value Value to set, or NULL to remove
2834 * @return 0 on success, non-0 on error
2836 int trackdb_edituserinfo(const char *user,
2837 const char *key, const char *value) {
2840 if(!strcmp(key, "rights")) {
2842 error(0, "cannot remove 'rights' key from user '%s'", user);
2845 if(parse_rights(value, 0, 1)) {
2846 error(0, "invalid rights string");
2849 } else if(!strcmp(key, "email")) {
2851 if(!email_valid(value)) {
2852 error(0, "invalid email address '%s' for user '%s'", value, user);
2856 value = 0; /* no email -> remove key */
2857 } else if(!strcmp(key, "created")) {
2858 error(0, "cannot change creation date for user '%s'", user);
2860 } else if(strcmp(key, "password")
2861 && !strcmp(key, "confirmation")) {
2862 error(0, "unknown user info key '%s' for user '%s'", key, user);
2865 WITH_TRANSACTION(trackdb_edituserinfo_tid(user, key, value, tid));
2867 error(0, "unknown user '%s'", user);
2870 eventlog("user_edit", user, key, (char *)0);
2875 /** @brief List all users
2876 * @return NULL-terminated list of users
2878 char **trackdb_listusers(void) {
2883 WITH_TRANSACTION(trackdb_listkeys(trackdb_usersdb, v, tid));
2887 /** @brief Confirm a user registration
2888 * @param user Username
2889 * @param confirmation Confirmation string
2890 * @param rightsp Where to put user rights
2891 * @param tid Transaction ID
2892 * @return 0 on success, non-0 on error
2894 static int trackdb_confirm_tid(const char *user, const char *confirmation,
2895 rights_type *rightsp,
2897 const char *stored_confirmation;
2902 if((e = trackdb_getdata(trackdb_usersdb, user, &k, tid)))
2904 if(!(stored_confirmation = kvp_get(k, "confirmation"))) {
2905 error(0, "already confirmed user '%s'", user);
2906 /* DB claims -30,800 to -30,999 so -1 should be a safe bet */
2909 if(!(rights = kvp_get(k, "rights"))) {
2910 error(0, "no rights for unconfirmed user '%s'", user);
2913 if(parse_rights(rights, rightsp, 1))
2915 if(strcmp(confirmation, stored_confirmation)) {
2916 error(0, "wrong confirmation string for user '%s'", user);
2920 kvp_set(&k, "confirmation", 0);
2921 return trackdb_putdata(trackdb_usersdb, user, k, tid, 0);
2924 /** @brief Confirm a user registration
2925 * @param user Username
2926 * @param confirmation Confirmation string
2927 * @param rightsp Where to put user rights
2928 * @return 0 on success, non-0 on error
2930 int trackdb_confirm(const char *user, const char *confirmation,
2931 rights_type *rightsp) {
2934 WITH_TRANSACTION(trackdb_confirm_tid(user, confirmation, rightsp, tid));
2937 info("registration confirmed for user '%s'", user);
2938 eventlog("user_confirm", user, (char *)0);
2941 error(0, "confirmation for nonexistent user '%s'", user);
2943 default: /* already reported */
2953 indent-tabs-mode:nil