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 static pid_t choose_pid = -1;
175 static int choose_fd;
176 static random_callback *choose_callback;
177 static struct dynstr choose_output;
178 static unsigned choose_complete;
179 static int choose_status;
180 #define CHOOSE_RUNNING 1
181 #define CHOOSE_READING 2
183 /* comparison function for keys */
184 static int compare(DB attribute((unused)) *db_,
185 const DBT *a, const DBT *b) {
186 return compare_path_raw(a->data, a->size, b->data, b->size);
189 /** @brief Test whether the track database can be read
190 * @return 1 if it can, 0 if it cannot
192 int trackdb_readable(void) {
195 byte_xasprintf(&usersdb, "%s/users.db", config->home);
196 return access(usersdb, R_OK) == 0;
199 /** @brief Open database environment
200 * @param flags Flags word
202 * Flags should be one of:
203 * - @ref TRACKDB_NO_RECOVER
204 * - @ref TRACKDB_NORMAL_RECOVER
205 * - @ref TRACKDB_FATAL_RECOVER
206 * - @ref TRACKDB_MAY_CREATE
208 void trackdb_init(int flags) {
210 const int recover = flags & TRACKDB_RECOVER_MASK;
211 static int recover_type[] = { 0, DB_RECOVER, DB_RECOVER_FATAL };
214 assert(initialized == 0);
217 if(strcmp(home, config->home))
218 fatal(0, "cannot change db home without server restart");
222 if(flags & TRACKDB_MAY_CREATE) {
228 /* Remove world/group permissions on any regular files already in the
229 * database directory. Actually we don't care about all of them but it's
230 * easier to just do the lot. This can be revisited if it's a serious
231 * practical inconvenience for anyone.
233 * The socket, not being a regular file, is excepted.
235 if(!(dp = opendir(config->home)))
236 fatal(errno, "error reading %s", config->home);
237 while((de = readdir(dp))) {
238 byte_xasprintf(&p, "%s/%s", config->home, de->d_name);
239 if(lstat(p, &st) == 0
240 && S_ISREG(st.st_mode)
241 && (st.st_mode & 077)) {
242 if(chmod(p, st.st_mode & 07700) < 0)
243 fatal(errno, "cannot chmod %s", p);
250 /* create environment */
251 if((err = db_env_create(&trackdb_env, 0))) fatal(0, "db_env_create: %s",
253 if((err = trackdb_env->set_alloc(trackdb_env,
254 xmalloc_noptr, xrealloc_noptr, xfree)))
255 fatal(0, "trackdb_env->set_alloc: %s", db_strerror(err));
256 if((err = trackdb_env->set_lk_max_locks(trackdb_env, 10000)))
257 fatal(0, "trackdb_env->set_lk_max_locks: %s", db_strerror(err));
258 if((err = trackdb_env->set_lk_max_objects(trackdb_env, 10000)))
259 fatal(0, "trackdb_env->set_lk_max_objects: %s", db_strerror(err));
260 if((err = trackdb_env->open(trackdb_env, config->home,
266 |recover_type[recover],
268 fatal(0, "trackdb_env->open %s: %s", config->home, db_strerror(err));
269 trackdb_env->set_errpfx(trackdb_env, "DB");
270 trackdb_env->set_errfile(trackdb_env, stderr);
271 trackdb_env->set_verbose(trackdb_env, DB_VERB_DEADLOCK, 1);
272 trackdb_env->set_verbose(trackdb_env, DB_VERB_RECOVERY, 1);
273 trackdb_env->set_verbose(trackdb_env, DB_VERB_REPLICATION, 1);
274 D(("initialized database environment"));
277 /* called when deadlock manager terminates */
278 static int reap_db_deadlock(ev_source attribute((unused)) *ev,
279 pid_t attribute((unused)) pid,
281 const struct rusage attribute((unused)) *rusage,
282 void attribute((unused)) *u) {
283 db_deadlock_pid = -1;
285 fatal(0, "deadlock manager unexpectedly terminated: %s",
288 D(("deadlock manager terminated: %s", wstat(status)));
292 static pid_t subprogram(ev_source *ev, int outputfd, const char *prog,
296 const char *args[1024], **argp, *a;
300 *argp++ = "--config";
301 *argp++ = configfile;
302 *argp++ = debugging ? "--debug" : "--no-debug";
303 *argp++ = log_default == &log_syslog ? "--syslog" : "--no-syslog";
305 while((a = va_arg(ap, const char *)))
309 /* If we're in the background then trap subprocess stdout/stderr */
310 if(!(pid = xfork())) {
313 ev_signal_atfork(ev);
314 signal(SIGPIPE, SIG_DFL);
319 /* ensure we don't leak privilege anywhere */
320 if(setuid(geteuid()) < 0)
321 fatal(errno, "error calling setuid");
322 /* If we were negatively niced, undo it. We don't bother checking for
323 * error, it's not that important. */
324 setpriority(PRIO_PROCESS, 0, 0);
325 execvp(prog, (char **)args);
326 fatal(errno, "error invoking %s", prog);
331 /* start deadlock manager */
332 void trackdb_master(ev_source *ev) {
333 assert(db_deadlock_pid == -1);
334 db_deadlock_pid = subprogram(ev, -1, DEADLOCK, (char *)0);
335 ev_child(ev, db_deadlock_pid, 0, reap_db_deadlock, 0);
336 D(("started deadlock manager"));
339 static void terminate_and_wait(ev_source *ev,
346 if(kill(pid, SIGTERM) < 0)
347 fatal(errno, "error killing %s", what);
348 /* wait for the rescanner to finish */
349 while(waitpid(pid, &err, 0) == -1 && errno == EINTR)
352 ev_child_cancel(ev, pid);
355 /* close environment */
356 void trackdb_deinit(ev_source *ev) {
360 assert(initialized == 1);
363 /* close the environment */
364 if((err = trackdb_env->close(trackdb_env, 0)))
365 fatal(0, "trackdb_env->close: %s", db_strerror(err));
367 terminate_and_wait(ev, rescan_pid, "disorder-rescan");
369 terminate_and_wait(ev, choose_pid, "disorder-choose");
373 char **ks = hash_keys(stats_pids);
376 pid_t pid = atoi(*ks++);
377 terminate_and_wait(ev, pid, "disorder-stats");
382 terminate_and_wait(ev, db_deadlock_pid, "disorder-deadlock");
383 db_deadlock_pid = -1;
384 D(("deinitialized database environment"));
387 /* open a specific database */
388 static DB *open_db(const char *path,
396 D(("open %s", path));
397 path = config_get_file(path);
398 if((err = db_create(&db, trackdb_env, 0)))
399 fatal(0, "db_create %s: %s", path, db_strerror(err));
401 if((err = db->set_flags(db, dbflags)))
402 fatal(0, "db->set_flags %s: %s", path, db_strerror(err));
403 if(dbtype == DB_BTREE)
404 if((err = db->set_bt_compare(db, compare)))
405 fatal(0, "db->set_bt_compare %s: %s", path, db_strerror(err));
406 if((err = db->open(db, 0, path, 0, dbtype,
407 openflags | DB_AUTO_COMMIT, mode))) {
408 if((openflags & DB_CREATE) || errno != ENOENT) {
409 if((err2 = db->close(db, 0)))
410 error(0, "db->close: %s", db_strerror(err2));
412 trackdb_env->close(trackdb_env,0);
414 fatal(0, "db->open %s: %s", path, db_strerror(err));
422 /** @brief Open track databases
423 * @param flags Flags flags word
425 * @p flags should have one of:
426 * - @p TRACKDB_NO_UPGRADE, if no upgrade should be attempted
427 * - @p TRACKDB_CAN_UPGRADE, if an upgrade may be attempted
428 * - @p TRACKDB_OPEN_FOR_UPGRADE, if this is disorder-dbupgrade
430 * - @p TRACKDB_READ_ONLY, read only access
432 void trackdb_open(int flags) {
435 uint32_t dbflags = flags & TRACKDB_READ_ONLY ? DB_RDONLY : DB_CREATE;
440 /* check the database version first */
441 trackdb_globaldb = open_db("global.db", 0, DB_HASH, DB_RDONLY, 0666);
442 if(trackdb_globaldb) {
443 /* This is an existing database */
447 s = trackdb_get_global("_dbversion");
448 /* Close the database again, we'll open it property below */
449 if((err = trackdb_globaldb->close(trackdb_globaldb, 0)))
450 fatal(0, "error closing global.db: %s", db_strerror(err));
451 trackdb_globaldb = 0;
452 /* Convert version string to an integer */
453 oldversion = s ? atol(s) : 1;
454 if(oldversion > config->dbversion) {
455 /* Database is from the future; we never allow this. */
456 fatal(0, "this version of DisOrder is too old for database version %ld",
459 if(oldversion < config->dbversion) {
460 /* Database version is out of date */
461 switch(flags & TRACKDB_UPGRADE_MASK) {
462 case TRACKDB_NO_UPGRADE:
463 /* This database needs upgrading but this is not permitted */
464 fatal(0, "database needs upgrading from %ld to %ld",
465 oldversion, config->dbversion);
466 case TRACKDB_CAN_UPGRADE:
467 /* This database needs upgrading */
468 info("invoking disorder-dbupgrade to upgrade from %ld to %ld",
469 oldversion, config->dbversion);
470 pid = subprogram(0, -1, "disorder-dbupgrade", (char *)0);
471 while(waitpid(pid, &err, 0) == -1 && errno == EINTR)
474 fatal(0, "disorder-dbupgrade %s", wstat(err));
475 info("disorder-dbupgrade succeeded");
477 case TRACKDB_OPEN_FOR_UPGRADE:
483 if(oldversion == config->dbversion && (flags & TRACKDB_OPEN_FOR_UPGRADE)) {
484 /* This doesn't make any sense */
485 fatal(0, "database is already at current version");
487 trackdb_existing_database = 1;
489 if(flags & TRACKDB_OPEN_FOR_UPGRADE) {
490 /* Cannot upgrade a new database */
491 fatal(0, "cannot upgrade a database that does not exist");
493 /* This is a brand new database */
494 trackdb_existing_database = 0;
496 /* open the databases */
497 if(!(trackdb_usersdb = open_db("users.db",
498 0, DB_HASH, dbflags, 0600)))
499 fatal(0, "cannot open users.db");
500 trackdb_tracksdb = open_db("tracks.db",
501 DB_RECNUM, DB_BTREE, dbflags, 0666);
502 trackdb_searchdb = open_db("search.db",
503 DB_DUP|DB_DUPSORT, DB_HASH, dbflags, 0666);
504 trackdb_tagsdb = open_db("tags.db",
505 DB_DUP|DB_DUPSORT, DB_HASH, dbflags, 0666);
506 trackdb_prefsdb = open_db("prefs.db", 0, DB_HASH, dbflags, 0666);
507 trackdb_globaldb = open_db("global.db", 0, DB_HASH, dbflags, 0666);
508 trackdb_noticeddb = open_db("noticed.db",
509 DB_DUPSORT, DB_BTREE, dbflags, 0666);
510 trackdb_scheduledb = open_db("schedule.db", 0, DB_HASH, dbflags, 0666);
511 trackdb_playlistsdb = open_db("playlists.db", 0, DB_HASH, dbflags, 0666);
512 if(!trackdb_existing_database && !(flags & TRACKDB_READ_ONLY)) {
513 /* Stash the database version */
516 assert(!(flags & TRACKDB_OPEN_FOR_UPGRADE));
517 snprintf(buf, sizeof buf, "%ld", config->dbversion);
518 trackdb_set_global("_dbversion", buf, 0);
520 D(("opened databases"));
523 /* close track databases */
524 void trackdb_close(void) {
530 #define CLOSE(N, V) do { \
531 if(V && (err = V->close(V, 0))) \
532 fatal(0, "error closing %s: %s", N, db_strerror(err)); \
535 CLOSE("tracks.db", trackdb_tracksdb);
536 CLOSE("search.db", trackdb_searchdb);
537 CLOSE("tags.db", trackdb_tagsdb);
538 CLOSE("prefs.db", trackdb_prefsdb);
539 CLOSE("global.db", trackdb_globaldb);
540 CLOSE("noticed.db", trackdb_noticeddb);
541 CLOSE("schedule.db", trackdb_scheduledb);
542 CLOSE("users.db", trackdb_usersdb);
543 CLOSE("playlists.db", trackdb_playlistsdb);
544 D(("closed databases"));
547 /* generic db routines *******************************************************/
549 /** @brief Fetch and decode a database entry
551 * @param track Track name
552 * @param kp Where to put decoded list (or NULL if you don't care)
553 * @param tid Owning transaction
554 * @return 0, @c DB_NOTFOUND or @c DB_LOCK_DEADLOCK
556 int trackdb_getdata(DB *db,
563 switch(err = db->get(db, tid, make_key(&key, track),
564 prepare_data(&data), 0)) {
567 *kp = kvp_urldecode(data.data, data.size);
573 case DB_LOCK_DEADLOCK:
574 error(0, "error querying database: %s", db_strerror(err));
577 fatal(0, "error querying database: %s", db_strerror(err));
581 /* encode and store a database entry. Returns 0, DB_KEYEXIST or
582 * DB_LOCK_DEADLOCK. */
583 int trackdb_putdata(DB *db,
591 switch(err = db->put(db, tid, make_key(&key, track),
592 encode_data(&data, k), flags)) {
596 case DB_LOCK_DEADLOCK:
597 error(0, "error updating database: %s", db_strerror(err));
600 fatal(0, "error updating database: %s", db_strerror(err));
604 /** @brief Delete a database entry
606 * @param track Key to delete
607 * @param tid Transaction ID
608 * @return 0, DB_NOTFOUND or DB_LOCK_DEADLOCK
610 int trackdb_delkey(DB *db,
616 switch(err = db->del(db, tid, make_key(&key, track), 0)) {
620 case DB_LOCK_DEADLOCK:
621 error(0, "error updating database: %s", db_strerror(err));
624 fatal(0, "error updating database: %s", db_strerror(err));
628 /* open a database cursor */
629 DBC *trackdb_opencursor(DB *db, DB_TXN *tid) {
633 switch(err = db->cursor(db, tid, &c, 0)) {
635 default: fatal(0, "error creating cursor: %s", db_strerror(err));
640 /* close a database cursor; returns 0 or DB_LOCK_DEADLOCK */
641 int trackdb_closecursor(DBC *c) {
645 switch(err = c->c_close(c)) {
648 case DB_LOCK_DEADLOCK:
649 error(0, "error closing cursor: %s", db_strerror(err));
652 fatal(0, "error closing cursor: %s", db_strerror(err));
656 /* delete a (key,data) pair. Returns 0, DB_NOTFOUND or DB_LOCK_DEADLOCK. */
657 int trackdb_delkeydata(DB *db,
665 c = trackdb_opencursor(db, tid);
666 switch(err = c->c_get(c, make_key(&key, word),
667 make_key(&data, track), DB_GET_BOTH)) {
669 switch(err = c->c_del(c, 0)) {
675 case DB_LOCK_DEADLOCK:
676 error(0, "error updating database: %s", db_strerror(err));
679 fatal(0, "c->c_del: %s", db_strerror(err));
684 case DB_LOCK_DEADLOCK:
685 error(0, "error updating database: %s", db_strerror(err));
688 fatal(0, "c->c_get: %s", db_strerror(err));
690 if(trackdb_closecursor(c)) err = DB_LOCK_DEADLOCK;
694 /* start a transaction */
695 DB_TXN *trackdb_begin_transaction(void) {
699 if((err = trackdb_env->txn_begin(trackdb_env, 0, &tid, 0)))
700 fatal(0, "trackdb_env->txn_begin: %s", db_strerror(err));
704 /* abort transaction */
705 void trackdb_abort_transaction(DB_TXN *tid) {
709 if((err = tid->abort(tid)))
710 fatal(0, "tid->abort: %s", db_strerror(err));
713 /* commit transaction */
714 void trackdb_commit_transaction(DB_TXN *tid) {
717 if((err = tid->commit(tid, 0)))
718 fatal(0, "tid->commit: %s", db_strerror(err));
721 /* search/tags shared code ***************************************************/
723 /* comparison function used by dedupe() */
724 static int wordcmp(const void *a, const void *b) {
725 return strcmp(*(const char **)a, *(const char **)b);
728 /* sort and de-dupe VEC */
729 static char **dedupe(char **vec, int nvec) {
732 qsort(vec, nvec, sizeof (char *), wordcmp);
736 for(n = 1; n < nvec; ++n)
737 if(strcmp(vec[n], vec[m - 1]))
744 /* update a key/track database. Returns 0 or DB_DEADLOCK. */
745 static int register_word(DB *db, const char *what,
746 const char *track, const char *word,
751 switch(err = db->put(db, tid, make_key(&key, word),
752 make_key(&data, track), DB_NODUPDATA)) {
756 case DB_LOCK_DEADLOCK:
757 error(0, "error updating %s.db: %s", what, db_strerror(err));
760 fatal(0, "error updating %s.db: %s", what, db_strerror(err));
764 /* search primitives *********************************************************/
766 /* return true iff NAME is a trackname_display_ pref */
767 static int is_display_pref(const char *name) {
768 static const char prefix[] = "trackname_display_";
769 return !strncmp(name, prefix, (sizeof prefix) - 1);
772 /** @brief Word_Break property tailor that treats underscores as spaces */
773 static int tailor_underscore_Word_Break_Other(uint32_t c) {
777 case 0x005F: /* LOW LINE (SPACING UNDERSCORE) */
778 return unicode_Word_Break_Other;
782 /** @brief Remove all combining characters in-place
783 * @param s Pointer to start of string
784 * @param ns Length of string
785 * @return New, possiblby reduced, length
787 static size_t remove_combining_chars(uint32_t *s, size_t ns) {
788 uint32_t *start = s, *t = s, *end = s + ns;
791 const uint32_t c = *s++;
792 if(!utf32_combining_class(c))
798 /** @brief Normalize and split a string using a given tailoring */
799 static void word_split(struct vector *v,
801 unicode_property_tailor *pt) {
803 uint32_t *t32, **w32;
805 /* Convert to UTF-32 */
806 if(!(t32 = utf8_to_utf32(s, strlen(s), &nt32)))
808 /* Erase case distinctions */
809 if(!(t32 = utf32_casefold_compat(t32, nt32, &nt32)))
811 /* Drop combining characters */
812 nt32 = remove_combining_chars(t32, nt32);
813 /* Split into words, treating _ as a space */
814 w32 = utf32_word_split(t32, nt32, &nw, pt);
815 /* Convert words back to UTF-8 and append to result */
816 for(i = 0; i < nw; ++i)
817 vector_append(v, utf32_to_utf8(w32[i], utf32_len(w32[i]), 0));
820 /** @brief Normalize a tag
822 * @param ns Length of tag
823 * @return Normalized string or NULL on error
825 * The return value will be:
827 * - have no leading or trailing space
828 * - have no combining characters
829 * - all spacing between words will be a single U+0020 SPACE
831 static char *normalize_tag(const char *s, size_t ns) {
832 uint32_t *s32, **w32;
833 size_t ns32, nw32, i;
836 if(!(s32 = utf8_to_utf32(s, ns, &ns32)))
838 if(!(s32 = utf32_casefold_compat(s32, ns32, &ns32))) /* ->NFKD */
840 ns32 = remove_combining_chars(s32, ns32);
841 /* Split into words, no Word_Break tailoring */
842 w32 = utf32_word_split(s32, ns32, &nw32, 0);
843 /* Compose back into a string */
845 for(i = 0; i < nw32; ++i) {
847 dynstr_append(d, ' ');
848 dynstr_append_string(d, utf32_to_utf8(w32[i], utf32_len(w32[i]), 0));
854 /* compute the words of a track name */
855 static char **track_to_words(const char *track,
856 const struct kvp *p) {
858 const char *rootless = track_rootless(track);
861 rootless = track; /* bodge */
863 rootless = strip_extension(rootless);
864 word_split(&v, strip_extension(rootless), tailor_underscore_Word_Break_Other);
865 for(; p; p = p->next)
866 if(is_display_pref(p->name))
867 word_split(&v, p->value, 0);
868 vector_terminate(&v);
869 return dedupe(v.vec, v.nvec);
872 /* return nonzero iff WORD is a stopword */
873 static int stopword(const char *word) {
876 for(n = 0; n < config->stopword.n
877 && strcmp(word, config->stopword.s[n]); ++n)
879 return n < config->stopword.n;
882 /* record that WORD appears in TRACK. Returns 0 or DB_LOCK_DEADLOCK. */
883 static int register_search_word(const char *track, const char *word,
885 if(stopword(word)) return 0;
886 return register_word(trackdb_searchdb, "search", track, word, tid);
889 /* Tags **********************************************************************/
891 /* Return nonzero if C is a valid tag character */
892 static int tagchar(int c) {
901 /* Parse and de-dupe a tag list. If S=0 then assumes "". */
902 char **parsetags(const char *s) {
908 /* skip initial separators */
909 while(*s && (!tagchar(*s) || *s == ' '))
912 /* find the extent of the tag */
914 while(*s && tagchar(*s))
916 /* strip trailing spaces */
917 while(s > t && s[-1] == ' ')
919 /* add tag to list */
920 vector_append(&v, normalize_tag(t, (size_t)(s - t)));
921 /* skip intermediate and trailing separators */
922 while(*s && (!tagchar(*s) || *s == ' '))
926 vector_terminate(&v);
927 return dedupe(v.vec, v.nvec);
930 /* Record that TRACK has TAG. Returns 0 or DB_LOCK_DEADLOCK. */
931 static int register_tag(const char *track, const char *tag, DB_TXN *tid) {
932 return register_word(trackdb_tagsdb, "tags", track, tag, tid);
935 /* aliases *******************************************************************/
937 /* compute the alias and store at aliasp. Returns 0 or DB_LOCK_DEADLOCK. If
938 * there is no alias sets *aliasp to 0. */
939 static int compute_alias(char **aliasp,
944 const char *s = config->alias, *t, *expansion, *part;
945 int c, used_db = 0, slash_prefix, err;
947 const char *const root = find_track_root(track);
950 /* Bodge for tracks with no root */
955 dynstr_append_string(&d, root);
956 while((c = (unsigned char)*s++)) {
958 dynstr_append(&d, c);
961 if((slash_prefix = (*s == '/')))
964 assert(t != 0); /* validated at startup */
965 part = xstrndup(s, t - s);
966 expansion = getpart(track, "display", part, p, &used_db);
968 if(slash_prefix) dynstr_append(&d, '/');
969 dynstr_append_string(&d, expansion);
971 s = t + 1; /* skip {part} */
973 /* only admit to the alias if we used the db... */
978 dynstr_terminate(&d);
979 /* ...and the answer differs from the original... */
980 if(!strcmp(track, d.vec)) {
984 /* ...and there isn't already a different track with that name (including as
986 switch(err = trackdb_getdata(trackdb_tracksdb, d.vec, &at, tid)) {
988 if((s = kvp_get(at, "_alias_for"))
989 && !strcmp(s, track)) {
1001 /* get track and prefs data (if tp/pp not null pointers). Returns 0 on
1002 * success, DB_NOTFOUND if the track does not exist or DB_LOCK_DEADLOCK.
1003 * Always sets the return values, even if only to null pointers. */
1004 static int gettrackdata(const char *track,
1007 const char **actualp,
1009 #define GTD_NOALIAS 0x0001
1012 const char *actual = track;
1013 struct kvp *t = 0, *p = 0;
1015 if((err = trackdb_getdata(trackdb_tracksdb, track, &t, tid))) goto done;
1016 if((actual = kvp_get(t, "_alias_for"))) {
1017 if(flags & GTD_NOALIAS) {
1018 error(0, "alias passed to gettrackdata where real path required");
1021 if((err = trackdb_getdata(trackdb_tracksdb, actual, &t, tid))) goto done;
1024 assert(actual != 0);
1026 if((err = trackdb_getdata(trackdb_prefsdb, actual, &p, tid)) == DB_LOCK_DEADLOCK)
1031 if(actualp) *actualp = actual;
1037 /* trackdb_notice() **********************************************************/
1039 /** @brief notice a possibly new track
1040 * @return @c DB_NOTFOUND if new, 0 if already known
1042 int trackdb_notice(const char *track,
1048 tid = trackdb_begin_transaction();
1049 err = trackdb_notice_tid(track, path, tid);
1050 if((err == DB_LOCK_DEADLOCK)) goto fail;
1053 trackdb_abort_transaction(tid);
1055 trackdb_commit_transaction(tid);
1059 /** @brief notice a possibly new track
1060 * @param track NFC UTF-8 track name
1061 * @param path Raw path name
1062 * @param tid Transaction ID
1063 * @return @c DB_NOTFOUND if new, 0 if already known, @c DB_LOCK_DEADLOCK also
1065 int trackdb_notice_tid(const char *track,
1069 struct kvp *t, *a, *p;
1071 char *alias, **w, *noticed;
1074 /* notice whether the tracks.db entry changes */
1076 /* get any existing tracks entry */
1077 if((err = gettrackdata(track, &t, &p, 0, 0, tid)) == DB_LOCK_DEADLOCK)
1079 ret = err; /* 0 or DB_NOTFOUND */
1080 /* this is a real track */
1081 t_changed += kvp_set(&t, "_alias_for", 0);
1082 t_changed += kvp_set(&t, "_path", path);
1084 if(ret == DB_NOTFOUND) {
1085 /* It's a new track; record the time */
1086 byte_xasprintf(¬iced, "%lld", (long long)now);
1087 t_changed += kvp_set(&t, "_noticed", noticed);
1089 /* if we have an alias record it in the database */
1090 if((err = compute_alias(&alias, track, p, tid))) return err;
1092 /* won't overwrite someone else's alias as compute_alias() checks */
1093 D(("%s: alias %s", track, alias));
1095 kvp_set(&a, "_alias_for", track);
1096 if((err = trackdb_putdata(trackdb_tracksdb, alias, a, tid, 0))) return err;
1098 /* update search.db */
1099 w = track_to_words(track, p);
1100 for(n = 0; w[n]; ++n)
1101 if((err = register_search_word(track, w[n], tid)))
1103 /* update tags.db */
1104 w = parsetags(kvp_get(p, "tags"));
1105 for(n = 0; w[n]; ++n)
1106 if((err = register_tag(track, w[n], tid)))
1108 /* only store the tracks.db entry if it has changed */
1109 if(t_changed && (err = trackdb_putdata(trackdb_tracksdb, track, t, tid, 0)))
1111 if(ret == DB_NOTFOUND) {
1112 uint32_t timestamp[2];
1115 timestamp[0] = htonl((uint64_t)now >> 32);
1116 timestamp[1] = htonl((uint32_t)now);
1117 memset(&key, 0, sizeof key);
1118 key.data = timestamp;
1119 key.size = sizeof timestamp;
1120 switch(err = trackdb_noticeddb->put(trackdb_noticeddb, tid, &key,
1121 make_key(&data, track), 0)) {
1123 case DB_LOCK_DEADLOCK: return err;
1124 default: fatal(0, "error updating noticed.db: %s", db_strerror(err));
1130 /* trackdb_obsolete() ********************************************************/
1132 /* obsolete a track */
1133 int trackdb_obsolete(const char *track, DB_TXN *tid) {
1138 if((err = gettrackdata(track, 0, &p, 0,
1139 GTD_NOALIAS, tid)) == DB_LOCK_DEADLOCK)
1141 else if(err == DB_NOTFOUND) return 0;
1142 /* compute the alias, if any, and delete it */
1143 if((err = compute_alias(&alias, track, p, tid))) return err;
1145 /* if the alias points to some other track then compute_alias won't
1147 if((err = trackdb_delkey(trackdb_tracksdb, alias, tid))
1148 && err != DB_NOTFOUND)
1151 /* update search.db */
1152 w = track_to_words(track, p);
1153 for(n = 0; w[n]; ++n)
1154 if(trackdb_delkeydata(trackdb_searchdb,
1155 w[n], track, tid) == DB_LOCK_DEADLOCK)
1157 /* update tags.db */
1158 w = parsetags(kvp_get(p, "tags"));
1159 for(n = 0; w[n]; ++n)
1160 if(trackdb_delkeydata(trackdb_tagsdb,
1161 w[n], track, tid) == DB_LOCK_DEADLOCK)
1163 /* update tracks.db */
1164 if(trackdb_delkey(trackdb_tracksdb, track, tid) == DB_LOCK_DEADLOCK)
1166 /* We don't delete the prefs, so they survive temporary outages of the
1167 * (possibly virtual) track filesystem */
1171 /* trackdb_stats() ***********************************************************/
1173 #define H(name) { #name, offsetof(DB_HASH_STAT, name) }
1174 #define B(name) { #name, offsetof(DB_BTREE_STAT, name) }
1176 static const struct statinfo {
1179 } statinfo_hash[] = {
1195 }, statinfo_btree[] = {
1216 /* look up stats for DB */
1217 static int get_stats(struct vector *v,
1219 const struct statinfo *si,
1228 switch(err = database->stat(database, tid, &sp, 0)) {
1231 case DB_LOCK_DEADLOCK:
1232 error(0, "error querying database: %s", db_strerror(err));
1235 fatal(0, "error querying database: %s", db_strerror(err));
1237 for(n = 0; n < nsi; ++n) {
1238 byte_xasprintf(&str, "%s=%"PRIuMAX, si[n].name,
1239 (uintmax_t)*(u_int32_t *)((char *)sp + si[n].offset));
1240 vector_append(v, str);
1246 /** @brief One entry in the search league */
1247 struct search_entry {
1252 /** @brief Add a word to the search league
1253 * @param se Pointer to search league
1254 * @param count Maximum size for search league
1255 * @param nse Current size of search league
1256 * @param word New word, or NULL
1257 * @param n How often @p word appears
1258 * @return New size of search league
1260 static int register_search_entry(struct search_entry *se,
1267 if(word && (nse < count || n > se[nse - 1].n)) {
1268 /* Find the starting point */
1273 /* Find the insertion point */
1274 while(i > 0 && n > se[i - 1].n)
1276 memmove(&se[i + 1], &se[i], (nse - i - 1) * sizeof *se);
1283 /* find the top COUNT words in the search database */
1284 static int search_league(struct vector *v, int count, DB_TXN *tid) {
1285 struct search_entry *se;
1288 int err, n = 0, nse = 0, i;
1293 cursor = trackdb_opencursor(trackdb_searchdb, tid);
1294 se = xmalloc(count * sizeof *se);
1295 /* Walk across the whole database counting up the number of times each
1297 while(!(err = cursor->c_get(cursor, prepare_data(&k), prepare_data(&d),
1299 if(word && wl == k.size && !strncmp(word, k.data, wl))
1300 ++n; /* same word again */
1302 nse = register_search_entry(se, count, nse, word, n);
1303 word = xstrndup(k.data, wl = k.size);
1311 case DB_LOCK_DEADLOCK:
1312 error(0, "error querying search database: %s", db_strerror(err));
1315 fatal(0, "error querying search database: %s", db_strerror(err));
1317 if(trackdb_closecursor(cursor)) err = DB_LOCK_DEADLOCK;
1319 nse = register_search_entry(se, count, nse, word, n);
1320 byte_xasprintf(&str, "Top %d search words:", nse);
1321 vector_append(v, str);
1322 for(i = 0; i < nse; ++i) {
1323 byte_xasprintf(&str, "%4d: %5d %s", i + 1, se[i].n, se[i].word);
1324 vector_append(v, str);
1329 #define SI(what) statinfo_##what, \
1330 sizeof statinfo_##what / sizeof (struct statinfo)
1332 /* return a list of database stats */
1333 char **trackdb_stats(int *nstatsp) {
1339 tid = trackdb_begin_transaction();
1341 vector_append(&v, (char *)"Tracks database stats:");
1342 if(get_stats(&v, trackdb_tracksdb, SI(btree), tid)) goto fail;
1343 vector_append(&v, (char *)"");
1344 vector_append(&v, (char *)"Search database stats:");
1345 if(get_stats(&v, trackdb_searchdb, SI(hash), tid)) goto fail;
1346 vector_append(&v, (char *)"");
1347 vector_append(&v, (char *)"Prefs database stats:");
1348 if(get_stats(&v, trackdb_prefsdb, SI(hash), tid)) goto fail;
1349 vector_append(&v, (char *)"");
1350 if(search_league(&v, 10, tid)) goto fail;
1351 vector_terminate(&v);
1354 trackdb_abort_transaction(tid);
1356 trackdb_commit_transaction(tid);
1357 if(nstatsp) *nstatsp = v.nvec;
1361 struct stats_details {
1362 void (*done)(char *data, void *u);
1364 int exited; /* subprocess exited */
1365 int closed; /* pipe close */
1366 int wstat; /* wait status from subprocess */
1367 struct dynstr data[1]; /* data read from pipe */
1370 static void stats_complete(struct stats_details *d) {
1373 if(!(d->exited && d->closed))
1375 byte_xasprintf(&s, "\n"
1377 "track lookup cache hits: %lu\n"
1378 "track lookup cache misses: %lu\n",
1380 cache_files_misses);
1381 dynstr_append_string(d->data, s);
1382 dynstr_terminate(d->data);
1383 d->done(d->data->vec, d->u);
1386 static int stats_finished(ev_source attribute((unused)) *ev,
1389 const struct rusage attribute((unused)) *rusage,
1391 struct stats_details *const d = u;
1395 error(0, "disorder-stats %s", wstat(status));
1398 byte_xasprintf(&k, "%lu", (unsigned long)pid);
1399 hash_remove(stats_pids, k);
1403 static int stats_read(ev_source attribute((unused)) *ev,
1409 struct stats_details *const d = u;
1411 dynstr_append_bytes(d->data, ptr, bytes);
1412 ev_reader_consume(reader, bytes);
1419 static int stats_error(ev_source attribute((unused)) *ev,
1422 struct stats_details *const d = u;
1424 error(errno_value, "error reading from pipe to disorder-stats");
1430 void trackdb_stats_subprocess(ev_source *ev,
1431 void (*done)(char *data, void *u),
1435 struct stats_details *d = xmalloc(sizeof *d);
1437 dynstr_init(d->data);
1441 pid = subprogram(ev, p[1], "disorder-stats", (char *)0);
1443 ev_child(ev, pid, 0, stats_finished, d);
1444 if(!ev_reader_new(ev, p[0], stats_read, stats_error, d,
1445 "disorder-stats reader"))
1446 fatal(0, "ev_reader_new for disorder-stats reader failed");
1447 /* Remember the PID */
1449 stats_pids = hash_new(1);
1451 byte_xasprintf(&k, "%lu", (unsigned long)pid);
1452 hash_add(stats_pids, k, "", HASH_INSERT);
1455 /** @brief Parse a track name part preference
1456 * @param name Preference name
1457 * @param partp Where to store part name
1458 * @param contextp Where to store context name
1459 * @return 0 on success, non-0 if parse fails
1461 static int trackdb__parse_namepref(const char *name,
1465 static const char prefix[] = "trackname_";
1467 if(strncmp(name, prefix, strlen(prefix)))
1468 return -1; /* not trackname_* at all */
1469 name += strlen(prefix);
1470 /* There had better be a _ between context and part */
1471 c = strchr(name, '_');
1474 /* Context is first in the pref name even though most APIs have the part
1475 * first. Confusing; sorry. */
1476 *contextp = xstrndup(name, c - name);
1478 /* There had better NOT be a second _ */
1481 *partp = xstrdup(c);
1485 /** @brief Compute the default value for a track preference
1486 * @param track Track name
1487 * @param name Preference name
1488 * @return Default value or 0 if none/not known
1490 static const char *trackdb__default(const char *track, const char *name) {
1491 char *context, *part;
1493 if(!trackdb__parse_namepref(name, &part, &context)) {
1494 /* We can work out the default for a trackname_ pref */
1495 return trackname_part(track, context, part);
1496 } else if(!strcmp(name, "weight")) {
1497 /* We know the default weight */
1499 } else if(!strcmp(name, "pick_at_random")) {
1500 /* By default everything is eligible for picking at random */
1502 } else if(!strcmp(name, "tags")) {
1503 /* By default everything no track has any tags */
1509 /* set a pref (remove if value=0) */
1510 int trackdb_set(const char *track,
1512 const char *value) {
1513 struct kvp *t, *p, *a;
1516 char *oldalias, *newalias, **oldtags = 0, **newtags;
1519 /* If the value matches the default then unset instead, to keep the database
1520 * tidy. Older versions did not have this feature so your database may yet
1521 * have some default values stored in it. */
1523 def = trackdb__default(track, name);
1524 if(def && !strcmp(value, def))
1529 tid = trackdb_begin_transaction();
1530 if((err = gettrackdata(track, &t, &p, 0,
1531 0, tid)) == DB_LOCK_DEADLOCK)
1533 if(err == DB_NOTFOUND) break;
1534 if(name[0] == '_') {
1535 if(kvp_set(&t, name, value))
1536 if(trackdb_putdata(trackdb_tracksdb, track, t, tid, 0))
1539 /* get the old alias name */
1540 if(compute_alias(&oldalias, track, p, tid)) goto fail;
1541 /* get the old tags */
1542 if(!strcmp(name, "tags"))
1543 oldtags = parsetags(kvp_get(p, "tags"));
1545 if(kvp_set(&p, name, value))
1546 if(trackdb_putdata(trackdb_prefsdb, track, p, tid, 0))
1548 /* compute the new alias name */
1549 if((err = compute_alias(&newalias, track, p, tid))) goto fail;
1550 /* check whether alias has changed */
1551 if(!(oldalias == newalias
1552 || (oldalias && newalias && !strcmp(oldalias, newalias)))) {
1553 /* adjust alias records to fit change */
1555 && trackdb_delkey(trackdb_tracksdb, oldalias, tid) == DB_LOCK_DEADLOCK)
1559 kvp_set(&a, "_alias_for", track);
1560 if(trackdb_putdata(trackdb_tracksdb, newalias, a, tid, 0)) goto fail;
1563 /* check whether tags have changed */
1564 if(!strcmp(name, "tags")) {
1565 newtags = parsetags(value);
1566 while(*oldtags || *newtags) {
1567 if(*oldtags && *newtags) {
1568 cmp = strcmp(*oldtags, *newtags);
1570 /* keeping this tag */
1574 /* old tag fits into a gap in the new list, so delete old */
1577 /* new tag fits into a gap in the old list, so insert new */
1579 } else if(*oldtags) {
1580 /* we've run out of new tags, so remaining old ones are to be
1583 if(trackdb_delkeydata(trackdb_tagsdb,
1584 *oldtags, track, tid) == DB_LOCK_DEADLOCK)
1588 /* we've run out of old tags, so remainig new ones are to be
1591 if(register_tag(track, *newtags, tid)) goto fail;
1600 trackdb_abort_transaction(tid);
1602 trackdb_commit_transaction(tid);
1603 return err == 0 ? 0 : -1;
1607 const char *trackdb_get(const char *track,
1609 return kvp_get(trackdb_get_all(track), name);
1612 /* get all prefs as a 0-terminated array */
1613 struct kvp *trackdb_get_all(const char *track) {
1614 struct kvp *t, *p, **pp;
1618 tid = trackdb_begin_transaction();
1619 if(gettrackdata(track, &t, &p, 0, 0, tid) == DB_LOCK_DEADLOCK)
1623 trackdb_abort_transaction(tid);
1625 trackdb_commit_transaction(tid);
1626 for(pp = &p; *pp; pp = &(*pp)->next)
1633 const char *trackdb_resolve(const char *track) {
1638 tid = trackdb_begin_transaction();
1639 if(gettrackdata(track, 0, 0, &actual, 0, tid) == DB_LOCK_DEADLOCK)
1643 trackdb_abort_transaction(tid);
1645 trackdb_commit_transaction(tid);
1649 int trackdb_isalias(const char *track) {
1650 const char *actual = trackdb_resolve(track);
1652 return strcmp(actual, track);
1655 /* test whether a track exists (perhaps an alias) */
1656 int trackdb_exists(const char *track) {
1661 tid = trackdb_begin_transaction();
1662 /* unusually, here we want the return value */
1663 if((err = gettrackdata(track, 0, 0, 0, 0, tid)) == DB_LOCK_DEADLOCK)
1667 trackdb_abort_transaction(tid);
1669 trackdb_commit_transaction(tid);
1673 /* return the list of tags */
1674 char **trackdb_alltags(void) {
1679 WITH_TRANSACTION(trackdb_listkeys(trackdb_tagsdb, v, tid));
1683 /** @brief List all the keys in @p db
1684 * @param db Database
1685 * @param v Vector to store keys in
1686 * @param tid Transaction ID
1687 * @return 0 or DB_LOCK_DEADLOCK
1689 int trackdb_listkeys(DB *db, struct vector *v, DB_TXN *tid) {
1692 DBC *const c = trackdb_opencursor(db, tid);
1695 memset(&k, 0, sizeof k);
1696 while(!(e = c->c_get(c, &k, prepare_data(&d), DB_NEXT_NODUP)))
1697 vector_append(v, xstrndup(k.data, k.size));
1701 case DB_LOCK_DEADLOCK:
1704 fatal(0, "c->c_get: %s", db_strerror(e));
1706 if((e = trackdb_closecursor(c)))
1708 vector_terminate(v);
1712 /* return 1 iff sorted tag lists A and B have at least one member in common */
1713 int tag_intersection(char **a, char **b) {
1716 /* Same sort of logic as trackdb_set() above */
1718 if(!(cmp = strcmp(*a, *b))) return 1;
1719 else if(cmp < 0) ++a;
1725 static void choose_finished(ev_source *ev, unsigned which) {
1726 choose_complete |= which;
1727 if(choose_complete != (CHOOSE_RUNNING|CHOOSE_READING))
1730 if(choose_status == 0 && choose_output.nvec > 0) {
1731 dynstr_terminate(&choose_output);
1732 choose_callback(ev, xstrdup(choose_output.vec));
1734 choose_callback(ev, 0);
1737 /** @brief Called when @c disorder-choose terminates */
1738 static int choose_exited(ev_source *ev,
1739 pid_t attribute((unused)) pid,
1741 const struct rusage attribute((unused)) *rusage,
1742 void attribute((unused)) *u) {
1744 error(0, "disorder-choose %s", wstat(status));
1745 choose_status = status;
1746 choose_finished(ev, CHOOSE_RUNNING);
1750 /** @brief Called with data from @c disorder-choose pipe */
1751 static int choose_readable(ev_source *ev,
1756 void attribute((unused)) *u) {
1757 dynstr_append_bytes(&choose_output, ptr, bytes);
1758 ev_reader_consume(reader, bytes);
1760 choose_finished(ev, CHOOSE_READING);
1764 static int choose_read_error(ev_source *ev,
1766 void attribute((unused)) *u) {
1767 error(errno_value, "error reading disorder-choose pipe");
1768 choose_finished(ev, CHOOSE_READING);
1772 /** @brief Request a random track
1773 * @param ev Event source
1774 * @param callback Called with random track or NULL
1775 * @return 0 if a request was initiated, else -1
1777 * Initiates a random track choice. @p callback will later be called back with
1778 * the choice (or NULL on error). If a choice is already underway then -1 is
1779 * returned and there will be no additional callback.
1781 * The caller shouldn't assume that the track returned actually exists (it
1782 * might be removed between the choice and the callback, or between being added
1783 * to the queue and being played).
1785 int trackdb_request_random(ev_source *ev,
1786 random_callback *callback) {
1789 if(choose_pid != -1)
1790 return -1; /* don't run concurrent chooses */
1793 choose_pid = subprogram(ev, p[1], "disorder-choose", (char *)0);
1796 choose_callback = callback;
1797 choose_output.nvec = 0;
1798 choose_complete = 0;
1799 if(!ev_reader_new(ev, p[0], choose_readable, choose_read_error, 0,
1800 "disorder-choose reader")) /* owns p[0] */
1801 fatal(0, "ev_reader_new for disorder-choose reader failed");
1802 ev_child(ev, choose_pid, 0, choose_exited, 0); /* owns the subprocess */
1806 /* get a track name given the prefs. Set *used_db to 1 if we got the answer
1807 * from the prefs. */
1808 static const char *getpart(const char *track,
1809 const char *context,
1811 const struct kvp *p,
1816 byte_xasprintf(&pref, "trackname_%s_%s", context, part);
1817 if((result = kvp_get(p, pref)))
1820 result = trackname_part(track, context, part);
1821 assert(result != 0);
1825 /* get a track name part, like trackname_part(), but taking the database into
1827 const char *trackdb_getpart(const char *track,
1828 const char *context,
1836 /* construct the full pref */
1837 byte_xasprintf(&pref, "trackname_%s_%s", context, part);
1839 tid = trackdb_begin_transaction();
1840 if((err = gettrackdata(track, 0, &p, &actual, 0, tid)) == DB_LOCK_DEADLOCK)
1844 trackdb_abort_transaction(tid);
1846 trackdb_commit_transaction(tid);
1847 return getpart(actual, context, part, p, &used_db);
1850 /* get the raw path name for @track@ (might be an alias) */
1851 const char *trackdb_rawpath(const char *track) {
1857 tid = trackdb_begin_transaction();
1858 if(gettrackdata(track, &t, 0, 0, 0, tid) == DB_LOCK_DEADLOCK)
1862 trackdb_abort_transaction(tid);
1864 trackdb_commit_transaction(tid);
1865 if(!(path = kvp_get(t, "_path"))) path = track;
1869 /* trackdb_list **************************************************************/
1871 /* this is incredibly ugly, sorry, perhaps it will be rewritten to be actually
1872 * readable at some point */
1874 /* return true if the basename of TRACK[0..TL-1], as defined by DL, matches RE.
1875 * If RE is a null pointer then it matches everything. */
1876 static int track_matches(size_t dl, const char *track, size_t tl,
1884 switch(rc = pcre_exec(re, 0, track, tl, 0, 0, ovec, 3)) {
1885 case PCRE_ERROR_NOMATCH: return 0;
1888 error(0, "pcre_exec returned %d, subject '%s'", rc, track);
1895 static int do_list(struct vector *v, const char *dir,
1896 enum trackdb_listable what, const pcre *re, DB_TXN *tid) {
1902 size_t l, last_dir_len = 0;
1903 char *last_dir = 0, *track;
1907 cursor = trackdb_opencursor(trackdb_tracksdb, tid);
1910 /* find the first key >= dir */
1911 err = cursor->c_get(cursor, &k, &d, DB_SET_RANGE);
1912 /* keep going while we're dealing with <dir/anything> */
1915 && ((char *)k.data)[dl] == '/'
1916 && !memcmp(k.data, dir, dl)) {
1917 ptr = memchr((char *)k.data + dl + 1, '/', k.size - (dl + 1));
1919 /* we have <dir/component/anything>, so <dir/component> is a directory */
1920 l = ptr - (char *)k.data;
1921 if(what & trackdb_directories)
1923 && l == last_dir_len
1924 && !memcmp(last_dir, k.data, l))) {
1925 last_dir = xstrndup(k.data, last_dir_len = l);
1926 if(track_matches(dl, k.data, l, re))
1927 vector_append(v, last_dir);
1930 /* found a plain file */
1931 if((what & trackdb_files)) {
1932 track = xstrndup(k.data, k.size);
1933 if((err = trackdb_getdata(trackdb_prefsdb,
1934 track, &p, tid)) == DB_LOCK_DEADLOCK)
1936 /* There's an awkward question here...
1938 * If a track shares a directory with its alias then we could
1939 * do one of three things:
1940 * - report both. Looks ridiculuous in most UIs.
1941 * - report just the alias. Remarkably inconvenient to write
1943 * - report just the real name. Ugly if the UI doesn't prettify
1944 * names via the name parts.
1947 /* If this file is an alias for a track in the same directory then we
1949 struct kvp *t = kvp_urldecode(d.data, d.size);
1950 const char *alias_target = kvp_get(t, "_alias_for");
1952 && !strcmp(d_dirname(alias_target),
1954 if(track_matches(dl, k.data, k.size, re))
1955 vector_append(v, track);
1957 /* if this file has an alias in the same directory then we skip it */
1959 if((err = compute_alias(&alias, track, p, tid)))
1961 if(!(alias && !strcmp(d_dirname(alias), d_dirname(track))))
1962 if(track_matches(dl, k.data, k.size, re))
1963 vector_append(v, track);
1967 err = cursor->c_get(cursor, &k, &d, DB_NEXT);
1975 case DB_LOCK_DEADLOCK:
1976 error(0, "error querying database: %s", db_strerror(err));
1979 fatal(0, "error querying database: %s", db_strerror(err));
1982 if(trackdb_closecursor(cursor)) err = DB_LOCK_DEADLOCK;
1986 /* return the directories or files below @dir@ */
1987 char **trackdb_list(const char *dir, int *np, enum trackdb_listable what,
1995 tid = trackdb_begin_transaction();
1998 if(do_list(&v, dir, what, re, tid))
2001 for(n = 0; n < config->collection.n; ++n)
2002 if(do_list(&v, config->collection.s[n].root, what, re, tid))
2007 trackdb_abort_transaction(tid);
2009 trackdb_commit_transaction(tid);
2010 vector_terminate(&v);
2016 /* If S is tag:something, return something. Else return 0. */
2017 static const char *checktag(const char *s) {
2018 if(!strncmp(s, "tag:", 4))
2024 /* return a list of tracks containing all of the words given. If you
2025 * ask for only stopwords you get no tracks. */
2026 char **trackdb_search(char **wordlist, int nwordlist, int *ntracks) {
2027 const char **w, *best = 0, *tag;
2028 char **twords, **tags;
2030 int i, j, n, err, what;
2040 *ntracks = 0; /* for early returns */
2041 /* normalize all the words */
2042 w = xmalloc(nwordlist * sizeof (char *));
2043 istag = xmalloc_noptr(nwordlist);
2044 for(n = 0; n < nwordlist; ++n) {
2048 w[n] = utf8_casefold_compat(wordlist[n], strlen(wordlist[n]), 0);
2049 if(checktag(w[n])) {
2050 ++ntags; /* count up tags */
2051 /* Normalize the tag */
2052 w[n] = normalize_tag(w[n] + 4, strlen(w[n] + 4));
2055 /* Normalize the search term by removing combining characters */
2056 if(!(w32 = utf8_to_utf32(w[n], strlen(w[n]), &nw32)))
2058 nw32 = remove_combining_chars(w32, nw32);
2059 if(!(w[n] = utf32_to_utf8(w32, nw32, 0)))
2064 /* find the longest non-stopword */
2065 for(n = 0; n < nwordlist; ++n)
2066 if(!istag[n] && !stopword(w[n]))
2067 if(!best || strlen(w[n]) > strlen(best))
2069 /* TODO: we should at least in principal be able to identify the word or tag
2070 * with the least matches in log time, and choose that as our primary search
2072 if(ntags && !best) {
2073 /* Only tags are listed. We limit to the first and narrow down with the
2075 best = istag[0] ? w[0] : 0;
2076 db = trackdb_tagsdb;
2079 /* We can limit to some word. */
2080 db = trackdb_searchdb;
2083 /* Only stopwords */
2089 tid = trackdb_begin_transaction();
2090 /* find all the tracks that have that word */
2095 cursor = trackdb_opencursor(db, tid);
2096 while(!(err = cursor->c_get(cursor, &k, &d, what))) {
2097 vector_append(&v, xstrndup(d.data, d.size));
2104 case DB_LOCK_DEADLOCK:
2105 error(0, "error querying %s database: %s", dbname, db_strerror(err));
2108 fatal(0, "error querying %s database: %s", dbname, db_strerror(err));
2110 if(trackdb_closecursor(cursor)) err = DB_LOCK_DEADLOCK;
2112 /* do a naive search over that (hopefuly fairly small) list of tracks */
2114 for(n = 0; n < v.nvec; ++n) {
2115 if((err = gettrackdata(v.vec[n], 0, &p, 0, 0, tid) == DB_LOCK_DEADLOCK))
2118 error(0, "track %s unexpected error: %s", v.vec[n], db_strerror(err));
2121 twords = track_to_words(v.vec[n], p);
2122 tags = parsetags(kvp_get(p, "tags"));
2123 for(i = 0; i < nwordlist; ++i) {
2126 /* Track must have this tag */
2127 for(j = 0; tags[j]; ++j)
2128 if(!strcmp(tag, tags[j])) break; /* tag found */
2129 if(!tags[j]) break; /* tag not found */
2131 /* Track must contain this word */
2132 for(j = 0; twords[j]; ++j)
2133 if(!strcmp(w[i], twords[j])) break; /* word found */
2134 if(!twords[j]) break; /* word not found */
2137 if(i >= nwordlist) /* all words found */
2138 vector_append(&u, v.vec[n]);
2142 trackdb_closecursor(cursor);
2144 trackdb_abort_transaction(tid);
2145 info("retrying search");
2147 trackdb_commit_transaction(tid);
2148 vector_terminate(&u);
2154 /* trackdb_scan **************************************************************/
2156 int trackdb_scan(const char *root,
2157 int (*callback)(const char *track,
2166 const size_t root_len = root ? strlen(root) : 0;
2168 struct kvp *data, *prefs;
2171 cursor = trackdb_opencursor(trackdb_tracksdb, tid);
2173 err = cursor->c_get(cursor, make_key(&k, root), prepare_data(&d),
2176 memset(&k, 0, sizeof k);
2177 err = cursor->c_get(cursor, &k, prepare_data(&d),
2182 || (k.size > root_len
2183 && !strncmp(k.data, root, root_len)
2184 && ((char *)k.data)[root_len] == '/')) {
2185 data = kvp_urldecode(d.data, d.size);
2186 if(kvp_get(data, "_path")) {
2187 track = xstrndup(k.data, k.size);
2188 /* TODO: trackdb_prefsdb is currently a DB_HASH. This means we have to
2189 * do a lookup for every single track. In fact this is quite quick:
2190 * with around 10,000 tracks a complete scan is around 0.3s on my
2191 * 2.2GHz Athlon. However, if it were a DB_BTREE, we could do the same
2192 * linear walk as we already do over trackdb_tracksdb, and probably get
2193 * even higher performance. That would require upgrade logic to
2194 * translate old databases though.
2196 switch(err = trackdb_prefsdb->get(trackdb_prefsdb, tid, &k,
2197 prepare_data(&pd), 0)) {
2199 prefs = kvp_urldecode(pd.data, pd.size);
2204 case DB_LOCK_DEADLOCK:
2205 error(0, "getting prefs: %s", db_strerror(err));
2206 trackdb_closecursor(cursor);
2209 fatal(0, "getting prefs: %s", db_strerror(err));
2211 /* Advance to the next track before the callback so that the callback
2212 * may safely delete the track */
2213 err = cursor->c_get(cursor, &k, &d, DB_NEXT);
2214 if((cberr = callback(track, data, prefs, u, tid))) {
2219 err = cursor->c_get(cursor, &k, &d, DB_NEXT);
2223 trackdb_closecursor(cursor);
2230 case DB_LOCK_DEADLOCK:
2231 error(0, "c->c_get: %s", db_strerror(err));
2234 fatal(0, "c->c_get: %s", db_strerror(err));
2238 /* trackdb_rescan ************************************************************/
2240 /** @brief Node in the list of rescan-complete callbacks */
2241 struct rescanned_node {
2242 struct rescanned_node *next;
2243 void (*rescanned)(void *ru);
2247 /** @brief List of rescan-complete callbacks */
2248 static struct rescanned_node *rescanned_list;
2250 /** @brief Add a rescan completion callback */
2251 void trackdb_add_rescanned(void (*rescanned)(void *ru),
2254 struct rescanned_node *n = xmalloc(sizeof *n);
2255 n->next = rescanned_list;
2256 n->rescanned = rescanned;
2262 /* called when the rescanner terminates */
2263 static int reap_rescan(ev_source attribute((unused)) *ev,
2266 const struct rusage attribute((unused)) *rusage,
2267 void attribute((unused)) *u) {
2268 if(pid == rescan_pid) rescan_pid = -1;
2270 error(0, RESCAN": %s", wstat(status));
2272 D((RESCAN" terminated: %s", wstat(status)));
2273 /* Our cache of file lookups is out of date now */
2274 cache_clean(&cache_files_type);
2275 eventlog("rescanned", (char *)0);
2276 /* Call rescanned callbacks */
2277 while(rescanned_list) {
2278 void (*rescanned)(void *u_) = rescanned_list->rescanned;
2279 void *ru = rescanned_list->ru;
2281 rescanned_list = rescanned_list->next;
2287 /** @brief Initiate a rescan
2288 * @param ev Event loop or 0 to block
2289 * @param recheck 1 to recheck lengths, 0 to suppress check
2290 * @param rescanned Called on completion (if not NULL)
2291 * @param ru Passed to @p rescanned
2293 void trackdb_rescan(ev_source *ev, int recheck,
2294 void (*rescanned)(void *ru),
2298 if(rescan_pid != -1) {
2299 trackdb_add_rescanned(rescanned, ru);
2300 error(0, "rescan already underway");
2303 rescan_pid = subprogram(ev, -1, RESCAN,
2304 recheck ? "--check" : "--no-check",
2306 trackdb_add_rescanned(rescanned, ru);
2308 ev_child(ev, rescan_pid, 0, reap_rescan, 0);
2309 D(("started rescanner"));
2311 /* This is the first rescan, we block until it is complete */
2312 while(waitpid(rescan_pid, &w, 0) < 0 && errno == EINTR)
2314 reap_rescan(0, rescan_pid, w, 0, 0);
2318 int trackdb_rescan_cancel(void) {
2319 if(rescan_pid == -1) return 0;
2320 if(kill(rescan_pid, SIGTERM) < 0)
2321 fatal(errno, "error killing rescanner");
2326 /** @brief Return true if a rescan is underway */
2327 int trackdb_rescan_underway(void) {
2328 return rescan_pid != -1;
2331 /* global prefs **************************************************************/
2333 void trackdb_set_global(const char *name,
2341 tid = trackdb_begin_transaction();
2342 if(!(err = trackdb_set_global_tid(name, value, tid)))
2344 trackdb_abort_transaction(tid);
2346 trackdb_commit_transaction(tid);
2347 /* log important state changes */
2348 if(!strcmp(name, "playing")) {
2349 state = !value || !strcmp(value, "yes");
2350 info("playing %s by %s",
2351 state ? "enabled" : "disabled",
2353 eventlog("state", state ? "enable_play" : "disable_play", (char *)0);
2355 if(!strcmp(name, "random-play")) {
2356 state = !value || !strcmp(value, "yes");
2357 info("random play %s by %s",
2358 state ? "enabled" : "disabled",
2360 eventlog("state", state ? "enable_random" : "disable_random", (char *)0);
2364 int trackdb_set_global_tid(const char *name,
2370 memset(&k, 0, sizeof k);
2371 memset(&d, 0, sizeof d);
2372 k.data = (void *)name;
2373 k.size = strlen(name);
2375 d.data = (void *)value;
2376 d.size = strlen(value);
2379 err = trackdb_globaldb->put(trackdb_globaldb, tid, &k, &d, 0);
2381 err = trackdb_globaldb->del(trackdb_globaldb, tid, &k, 0);
2382 if(err == DB_LOCK_DEADLOCK) return err;
2384 fatal(0, "error updating database: %s", db_strerror(err));
2388 const char *trackdb_get_global(const char *name) {
2394 tid = trackdb_begin_transaction();
2395 if(!(err = trackdb_get_global_tid(name, tid, &r)))
2397 trackdb_abort_transaction(tid);
2399 trackdb_commit_transaction(tid);
2403 int trackdb_get_global_tid(const char *name,
2409 memset(&k, 0, sizeof k);
2410 k.data = (void *)name;
2411 k.size = strlen(name);
2412 switch(err = trackdb_globaldb->get(trackdb_globaldb, tid, &k,
2413 prepare_data(&d), 0)) {
2415 *rp = xstrndup(d.data, d.size);
2420 case DB_LOCK_DEADLOCK:
2423 fatal(0, "error reading database: %s", db_strerror(err));
2427 /** @brief Retrieve the most recently added tracks
2428 * @param ntracksp Where to put count, or 0
2429 * @param maxtracks Maximum number of tracks to retrieve
2430 * @return null-terminated array of track names
2432 * The most recently added track is first in the array.
2434 char **trackdb_new(int *ntracksp,
2440 tid = trackdb_begin_transaction();
2441 tracks = trackdb_new_tid(ntracksp, maxtracks, tid);
2444 trackdb_abort_transaction(tid);
2446 trackdb_commit_transaction(tid);
2450 /** @brief Retrieve the most recently added tracks
2451 * @param ntracksp Where to put count, or 0
2452 * @param maxtracks Maximum number of tracks to retrieve, or 0 for all
2453 * @param tid Transaction ID
2454 * @return null-terminated array of track names, or NULL on deadlock
2456 * The most recently added track is first in the array.
2458 static char **trackdb_new_tid(int *ntracksp,
2464 struct vector tracks[1];
2465 hash *h = hash_new(1);
2467 vector_init(tracks);
2468 c = trackdb_opencursor(trackdb_noticeddb, tid);
2469 while((maxtracks <= 0 || tracks->nvec < maxtracks)
2470 && !(err = c->c_get(c, prepare_data(&k), prepare_data(&d), DB_PREV))) {
2471 char *const track = xstrndup(d.data, d.size);
2472 /* Don't add any track more than once */
2473 if(hash_add(h, track, "", HASH_INSERT))
2475 /* See if the track still exists */
2476 err = trackdb_getdata(trackdb_tracksdb, track, NULL/*kp*/, tid);
2477 if(err == DB_NOTFOUND)
2478 continue; /* It doesn't, skip it */
2479 if(err == DB_LOCK_DEADLOCK)
2481 vector_append(tracks, track);
2484 case 0: /* hit maxtracks */
2485 case DB_NOTFOUND: /* ran out of tracks */
2487 case DB_LOCK_DEADLOCK:
2488 trackdb_closecursor(c);
2491 fatal(0, "error reading noticed.db: %s", db_strerror(err));
2493 if((err = trackdb_closecursor(c)))
2494 return 0; /* deadlock */
2495 vector_terminate(tracks);
2497 *ntracksp = tracks->nvec;
2501 /** @brief Expire noticed.db
2502 * @param earliest Earliest timestamp to keep
2504 void trackdb_expire_noticed(time_t earliest) {
2508 tid = trackdb_begin_transaction();
2509 if(!trackdb_expire_noticed_tid(earliest, tid))
2511 trackdb_abort_transaction(tid);
2513 trackdb_commit_transaction(tid);
2516 /** @brief Expire noticed.db
2517 * @param earliest Earliest timestamp to keep
2518 * @param tid Transaction ID
2519 * @return 0 or DB_LOCK_DEADLOCK
2521 static int trackdb_expire_noticed_tid(time_t earliest, DB_TXN *tid) {
2529 c = trackdb_opencursor(trackdb_noticeddb, tid);
2530 while(!(err = c->c_get(c, prepare_data(&k), prepare_data(&d), DB_NEXT))) {
2532 when = (time_t)(((uint64_t)ntohl(kk[0]) << 32) + ntohl(kk[1]));
2533 if(when >= earliest)
2535 if((err = c->c_del(c, 0))) {
2536 if(err != DB_LOCK_DEADLOCK)
2537 fatal(0, "error deleting expired noticed.db entry: %s",
2543 if(err == DB_NOTFOUND)
2545 if(err && err != DB_LOCK_DEADLOCK)
2546 fatal(0, "error expiring noticed.db: %s", db_strerror(err));
2548 if((err = trackdb_closecursor(c))) {
2549 if(err != DB_LOCK_DEADLOCK)
2550 fatal(0, "error closing cursor: %s", db_strerror(err));
2554 info("expired %d tracks from noticed.db", count);
2558 /* tidying up ****************************************************************/
2560 void trackdb_gc(void) {
2564 if((err = trackdb_env->txn_checkpoint(trackdb_env,
2565 config->checkpoint_kbyte,
2566 config->checkpoint_min,
2568 fatal(0, "trackdb_env->txn_checkpoint: %s", db_strerror(err));
2569 if((err = trackdb_env->log_archive(trackdb_env, &logfiles, DB_ARCH_REMOVE)))
2570 fatal(0, "trackdb_env->log_archive: %s", db_strerror(err));
2571 /* This makes catastrophic recovery impossible. However, the user can still
2572 * preserve the important data by using disorder-dump to snapshot their
2573 * prefs, and later to restore it. This is likely to have much small
2574 * long-term storage requirements than record the db logfiles. */
2577 /* user database *************************************************************/
2579 /** @brief Return true if @p user is trusted */
2580 static int trusted(const char *user) {
2583 for(n = 0; (n < config->trust.n
2584 && strcmp(config->trust.s[n], user)); ++n)
2586 return n < config->trust.n;
2589 /** @brief Return non-zero for a valid username
2591 * Currently we only allow the letters and digits in ASCII. We could be more
2592 * liberal than this but it is a nice simple test. It is critical that
2593 * semicolons are never allowed.
2595 * NB also used by playlist_parse_name() to validate playlist names!
2597 int valid_username(const char *user) {
2601 const uint8_t c = *user++;
2602 /* For now we are very strict */
2603 if((c >= 'a' && c <= 'z')
2604 || (c >= 'A' && c <= 'Z')
2605 || (c >= '0' && c <= '9'))
2613 /** @brief Add a user */
2614 static int create_user(const char *user,
2615 const char *password,
2618 const char *confirmation,
2624 /* sanity check user */
2625 if(!valid_username(user)) {
2626 error(0, "invalid username '%s'", user);
2629 if(parse_rights(rights, 0, 1)) {
2630 error(0, "invalid rights string");
2633 /* data for this user */
2635 kvp_set(&k, "password", password);
2636 kvp_set(&k, "rights", rights);
2638 kvp_set(&k, "email", email);
2640 kvp_set(&k, "confirmation", confirmation);
2641 snprintf(s, sizeof s, "%jd", (intmax_t)xtime(0));
2642 kvp_set(&k, "created", s);
2643 return trackdb_putdata(trackdb_usersdb, user, k, tid, flags);
2646 /** @brief Add one pre-existing user */
2647 static int one_old_user(const char *user, const char *password,
2651 /* www-data doesn't get added */
2652 if(!strcmp(user, "www-data")) {
2653 info("not adding www-data to user database");
2657 if(!strcmp(user, "root"))
2659 else if(trusted(user)) {
2662 parse_rights(config->default_rights, &r, 1);
2663 r &= ~(rights_type)(RIGHT_SCRATCH__MASK|RIGHT_MOVE__MASK|RIGHT_REMOVE__MASK);
2664 r |= (RIGHT_ADMIN|RIGHT_RESCAN
2665 |RIGHT_SCRATCH_ANY|RIGHT_MOVE_ANY|RIGHT_REMOVE_ANY);
2666 rights = rights_string(r);
2668 rights = config->default_rights;
2669 return create_user(user, password, rights, 0/*email*/, 0/*confirmation*/,
2670 tid, DB_NOOVERWRITE);
2673 static int trackdb_old_users_tid(DB_TXN *tid) {
2676 for(n = 0; n < config->allow.n; ++n) {
2677 switch(one_old_user(config->allow.s[n].s[0], config->allow.s[n].s[1],
2680 info("created user %s from 'allow' directive", config->allow.s[n].s[0]);
2683 error(0, "user %s already exists, delete 'allow' directive",
2684 config->allow.s[n].s[0]);
2685 /* This won't ever become fatal - eventually 'allow' will be
2688 case DB_LOCK_DEADLOCK:
2689 return DB_LOCK_DEADLOCK;
2695 /** @brief Read old 'allow' directives and copy them to the users database */
2696 void trackdb_old_users(void) {
2700 WITH_TRANSACTION(trackdb_old_users_tid(tid));
2703 /** @brief Create a root user in the user database if there is none */
2704 void trackdb_create_root(void) {
2709 /* Choose a new root password */
2710 gcry_randomize(pwbin, sizeof pwbin, GCRY_STRONG_RANDOM);
2711 pw = mime_to_base64(pwbin, sizeof pwbin);
2712 /* Create the root user if it does not exist */
2713 WITH_TRANSACTION(create_user("root", pw, "all",
2714 0/*email*/, 0/*confirmation*/,
2715 tid, DB_NOOVERWRITE));
2717 info("created root user");
2720 /** @brief Find a user's password from the database
2721 * @param user Username
2722 * @return Password or NULL
2724 * Only works if running as a user that can read the database!
2726 * If the user exists but has no password, "" is returned.
2728 const char *trackdb_get_password(const char *user) {
2731 const char *password;
2733 WITH_TRANSACTION(trackdb_getdata(trackdb_usersdb, user, &k, tid));
2736 password = kvp_get(k, "password");
2737 return password ? password : "";
2740 /** @brief Add a new user
2741 * @param user Username
2742 * @param password Password or NULL
2743 * @param rights Initial rights
2744 * @param email Email address or NULL
2745 * @param confirmation Confirmation string or NULL
2746 * @return 0 on success, non-0 on error
2748 int trackdb_adduser(const char *user,
2749 const char *password,
2752 const char *confirmation) {
2755 WITH_TRANSACTION(create_user(user, password, rights, email, confirmation,
2756 tid, DB_NOOVERWRITE));
2758 error(0, "cannot create user '%s' because they already exist", user);
2762 info("created user '%s' with rights '%s' and email address '%s'",
2763 user, rights, email);
2765 info("created user '%s' with rights '%s'", user, rights);
2766 eventlog("user_add", user, (char *)0);
2771 /** @brief Delete a user
2772 * @param user User to delete
2773 * @return 0 on success, non-0 if the user didn't exist anyway
2775 int trackdb_deluser(const char *user) {
2778 WITH_TRANSACTION(trackdb_delkey(trackdb_usersdb, user, tid));
2780 error(0, "cannot delete user '%s' because they do not exist", user);
2783 info("deleted user '%s'", user);
2784 eventlog("user_delete", user, (char *)0);
2788 /** @brief Get user information
2789 * @param user User to query
2790 * @return Linked list of user information or NULL if user does not exist
2792 * Every user has at least a @c rights entry so NULL can be used to mean no
2795 struct kvp *trackdb_getuserinfo(const char *user) {
2799 WITH_TRANSACTION(trackdb_getdata(trackdb_usersdb, user, &k, tid));
2806 /** @brief Edit user information
2807 * @param user User to edit
2808 * @param key Key to change
2809 * @param value Value to set, or NULL to remove
2810 * @param tid Transaction ID
2811 * @return 0, DB_LOCK_DEADLOCK or DB_NOTFOUND
2813 static int trackdb_edituserinfo_tid(const char *user, const char *key,
2814 const char *value, DB_TXN *tid) {
2818 if((e = trackdb_getdata(trackdb_usersdb, user, &k, tid)))
2820 if(!kvp_set(&k, key, value))
2821 return 0; /* no change */
2822 return trackdb_putdata(trackdb_usersdb, user, k, tid, 0);
2825 /** @brief Edit user information
2826 * @param user User to edit
2827 * @param key Key to change
2828 * @param value Value to set, or NULL to remove
2829 * @return 0 on success, non-0 on error
2831 int trackdb_edituserinfo(const char *user,
2832 const char *key, const char *value) {
2835 if(!strcmp(key, "rights")) {
2837 error(0, "cannot remove 'rights' key from user '%s'", user);
2840 if(parse_rights(value, 0, 1)) {
2841 error(0, "invalid rights string");
2844 } else if(!strcmp(key, "email")) {
2846 if(!email_valid(value)) {
2847 error(0, "invalid email address '%s' for user '%s'", value, user);
2851 value = 0; /* no email -> remove key */
2852 } else if(!strcmp(key, "created")) {
2853 error(0, "cannot change creation date for user '%s'", user);
2855 } else if(strcmp(key, "password")
2856 && !strcmp(key, "confirmation")) {
2857 error(0, "unknown user info key '%s' for user '%s'", key, user);
2860 WITH_TRANSACTION(trackdb_edituserinfo_tid(user, key, value, tid));
2862 error(0, "unknown user '%s'", user);
2865 eventlog("user_edit", user, key, (char *)0);
2870 /** @brief List all users
2871 * @return NULL-terminated list of users
2873 char **trackdb_listusers(void) {
2878 WITH_TRANSACTION(trackdb_listkeys(trackdb_usersdb, v, tid));
2882 /** @brief Confirm a user registration
2883 * @param user Username
2884 * @param confirmation Confirmation string
2885 * @param rightsp Where to put user rights
2886 * @param tid Transaction ID
2887 * @return 0 on success, non-0 on error
2889 static int trackdb_confirm_tid(const char *user, const char *confirmation,
2890 rights_type *rightsp,
2892 const char *stored_confirmation;
2897 if((e = trackdb_getdata(trackdb_usersdb, user, &k, tid)))
2899 if(!(stored_confirmation = kvp_get(k, "confirmation"))) {
2900 error(0, "already confirmed user '%s'", user);
2901 /* DB claims -30,800 to -30,999 so -1 should be a safe bet */
2904 if(!(rights = kvp_get(k, "rights"))) {
2905 error(0, "no rights for unconfirmed user '%s'", user);
2908 if(parse_rights(rights, rightsp, 1))
2910 if(strcmp(confirmation, stored_confirmation)) {
2911 error(0, "wrong confirmation string for user '%s'", user);
2915 kvp_set(&k, "confirmation", 0);
2916 return trackdb_putdata(trackdb_usersdb, user, k, tid, 0);
2919 /** @brief Confirm a user registration
2920 * @param user Username
2921 * @param confirmation Confirmation string
2922 * @param rightsp Where to put user rights
2923 * @return 0 on success, non-0 on error
2925 int trackdb_confirm(const char *user, const char *confirmation,
2926 rights_type *rightsp) {
2929 WITH_TRANSACTION(trackdb_confirm_tid(user, confirmation, rightsp, tid));
2932 info("registration confirmed for user '%s'", user);
2933 eventlog("user_confirm", user, (char *)0);
2936 error(0, "confirmation for nonexistent user '%s'", user);
2938 default: /* already reported */
2948 indent-tabs-mode:nil