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 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful, but
11 * WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * General Public License for more details.
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the Free Software
17 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
20 /** @file lib/trackdb.c
21 * @brief Track database
23 * This file is getting in desparate need of splitting up...
32 #include <sys/socket.h>
39 #include <sys/resource.h>
41 #include <arpa/inet.h>
54 #include "configuration.h"
59 #include "trackname.h"
60 #include "trackdb-int.h"
69 #define RESCAN "disorder-rescan"
70 #define DEADLOCK "disorder-deadlock"
72 static const char *getpart(const char *track,
77 static char **trackdb_new_tid(int *ntracksp,
80 static int trackdb_expire_noticed_tid(time_t earliest, DB_TXN *tid);
81 static char *normalize_tag(const char *s, size_t ns);
83 const struct cache_type cache_files_type = { 86400 };
84 unsigned long cache_files_hits, cache_files_misses;
86 /** @brief Set by trackdb_open() */
87 int trackdb_existing_database;
89 /* setup and teardown ********************************************************/
91 static const char *home; /* home had better not change */
92 DB_ENV *trackdb_env; /* db environment */
94 /** @brief The tracks database
95 * - Keys are UTF-8(NFC(unicode(path name)))
96 * - Values are encoded key-value pairs
97 * - Data is reconstructable data about tracks that currently exist
101 /** @brief The preferences database
103 * - Keys are UTF-8(NFC(unicode(path name)))
104 * - Values are encoded key-value pairs
105 * - Data is user data about tracks (that might not exist any more)
106 * and cannot be reconstructed
110 /** @brief The search database
112 * - Keys are UTF-8(NFKC(casefold(search term)))
113 * - Values are UTF-8(NFC(unicode(path name)))
114 * - There can be more than one value per key
115 * - Presence of key,value means that path matches the search terms
116 * - Only tracks fond in @ref trackdb_tracksdb are represented here
117 * - This database can be reconstructed, it contains no user data
119 DB *trackdb_searchdb;
121 /** @brief The tags database
123 * - Keys are UTF-8(NFKC(casefold(tag)))
124 * - Values are UTF-8(NFC(unicode(path name)))
125 * - There can be more than one value per key
126 * - Presence of key,value means that path matches the tag
127 * - This is always in sync with the tags preference
128 * - This database can be reconstructed, it contains no user data
130 DB *trackdb_tagsdb; /* the tags database */
132 /** @brief The global preferences database
133 * - Keys are UTF-8(NFC(preference))
134 * - Values are global preference values
135 * - Data is user data and cannot be reconstructed
137 DB *trackdb_globaldb; /* global preferences */
139 /** @brief The noticed database
140 * - Keys are 64-bit big-endian timestamps
141 * - Values are UTF-8(NFC(unicode(path name)))
142 * - There can be more than one value per key
143 * - Presence of key,value means that path was added at the given time
144 * - Data cannot be reconstructed (but isn't THAT important)
146 DB *trackdb_noticeddb; /* when track noticed */
148 /** @brief The user database
149 * - Keys are usernames
150 * - Values are encoded key-value pairs
151 * - Data is user data and cannot be reconstructed
155 static pid_t db_deadlock_pid = -1; /* deadlock manager PID */
156 static pid_t rescan_pid = -1; /* rescanner PID */
157 static int initialized, opened; /* state */
159 /* comparison function for keys */
160 static int compare(DB attribute((unused)) *db_,
161 const DBT *a, const DBT *b) {
162 return compare_path_raw(a->data, a->size, b->data, b->size);
165 /** @brief Open database environment
166 * @param flags Flags word
168 * Flags should be one of:
169 * - @ref TRACKDB_NO_RECOVER
170 * - @ref TRACKDB_NORMAL_RECOVER
171 * - @ref TRACKDB_FATAL_RECOVER
172 * - @ref TRACKDB_MAY_CREATE
174 void trackdb_init(int flags) {
176 const int recover = flags & TRACKDB_RECOVER_MASK;
177 static int recover_type[] = { 0, DB_RECOVER, DB_RECOVER_FATAL };
180 assert(initialized == 0);
183 if(strcmp(home, config->home))
184 fatal(0, "cannot change db home without server restart");
188 if(flags & TRACKDB_MAY_CREATE) {
194 /* Remove world/group permissions on any regular files already in the
195 * database directory. Actually we don't care about all of them but it's
196 * easier to just do the lot. This can be revisited if it's a serious
197 * practical inconvenience for anyone.
199 * The socket, not being a regular file, is excepted.
201 if(!(dp = opendir(config->home)))
202 fatal(errno, "error reading %s", config->home);
203 while((de = readdir(dp))) {
204 byte_xasprintf(&p, "%s/%s", config->home, de->d_name);
205 if(lstat(p, &st) == 0
206 && S_ISREG(st.st_mode)
207 && (st.st_mode & 077)) {
208 if(chmod(p, st.st_mode & 07700) < 0)
209 fatal(errno, "cannot chmod %s", p);
216 /* create environment */
217 if((err = db_env_create(&trackdb_env, 0))) fatal(0, "db_env_create: %s",
219 if((err = trackdb_env->set_alloc(trackdb_env,
220 xmalloc_noptr, xrealloc_noptr, xfree)))
221 fatal(0, "trackdb_env->set_alloc: %s", db_strerror(err));
222 if((err = trackdb_env->set_lk_max_locks(trackdb_env, 10000)))
223 fatal(0, "trackdb_env->set_lk_max_locks: %s", db_strerror(err));
224 if((err = trackdb_env->set_lk_max_objects(trackdb_env, 10000)))
225 fatal(0, "trackdb_env->set_lk_max_objects: %s", db_strerror(err));
226 if((err = trackdb_env->open(trackdb_env, config->home,
232 |recover_type[recover],
234 fatal(0, "trackdb_env->open %s: %s", config->home, db_strerror(err));
235 trackdb_env->set_errpfx(trackdb_env, "DB");
236 trackdb_env->set_errfile(trackdb_env, stderr);
237 trackdb_env->set_verbose(trackdb_env, DB_VERB_DEADLOCK, 1);
238 trackdb_env->set_verbose(trackdb_env, DB_VERB_RECOVERY, 1);
239 trackdb_env->set_verbose(trackdb_env, DB_VERB_REPLICATION, 1);
240 D(("initialized database environment"));
243 /* called when deadlock manager terminates */
244 static int reap_db_deadlock(ev_source attribute((unused)) *ev,
245 pid_t attribute((unused)) pid,
247 const struct rusage attribute((unused)) *rusage,
248 void attribute((unused)) *u) {
249 db_deadlock_pid = -1;
251 fatal(0, "deadlock manager unexpectedly terminated: %s",
254 D(("deadlock manager terminated: %s", wstat(status)));
258 static pid_t subprogram(ev_source *ev, int outputfd, const char *prog,
262 const char *args[1024], **argp, *a;
266 *argp++ = "--config";
267 *argp++ = configfile;
268 *argp++ = debugging ? "--debug" : "--no-debug";
269 *argp++ = log_default == &log_syslog ? "--syslog" : "--no-syslog";
271 while((a = va_arg(ap, const char *)))
275 /* If we're in the background then trap subprocess stdout/stderr */
276 if(!(pid = xfork())) {
279 ev_signal_atfork(ev);
280 signal(SIGPIPE, SIG_DFL);
285 /* ensure we don't leak privilege anywhere */
286 if(setuid(geteuid()) < 0)
287 fatal(errno, "error calling setuid");
288 /* If we were negatively niced, undo it. We don't bother checking for
289 * error, it's not that important. */
290 setpriority(PRIO_PROCESS, 0, 0);
291 execvp(prog, (char **)args);
292 fatal(errno, "error invoking %s", prog);
297 /* start deadlock manager */
298 void trackdb_master(ev_source *ev) {
299 assert(db_deadlock_pid == -1);
300 db_deadlock_pid = subprogram(ev, -1, DEADLOCK, (char *)0);
301 ev_child(ev, db_deadlock_pid, 0, reap_db_deadlock, 0);
302 D(("started deadlock manager"));
305 /* close environment */
306 void trackdb_deinit(void) {
310 assert(initialized == 1);
313 /* close the environment */
314 if((err = trackdb_env->close(trackdb_env, 0)))
315 fatal(0, "trackdb_env->close: %s", db_strerror(err));
317 if(rescan_pid != -1) {
318 /* shut down the rescanner */
319 if(kill(rescan_pid, SIGTERM) < 0)
320 fatal(errno, "error killing rescanner");
321 /* wait for the rescanner to finish */
322 while(waitpid(rescan_pid, &err, 0) == -1 && errno == EINTR)
326 /* TODO kill any stats subprocesses */
328 /* finally terminate the deadlock manager */
329 if(db_deadlock_pid != -1 && kill(db_deadlock_pid, SIGTERM) < 0)
330 fatal(errno, "error killing deadlock manager");
331 db_deadlock_pid = -1;
333 D(("deinitialized database environment"));
336 /* open a specific database */
337 static DB *open_db(const char *path,
345 D(("open %s", path));
346 path = config_get_file(path);
347 if((err = db_create(&db, trackdb_env, 0)))
348 fatal(0, "db_create %s: %s", path, db_strerror(err));
350 if((err = db->set_flags(db, dbflags)))
351 fatal(0, "db->set_flags %s: %s", path, db_strerror(err));
352 if(dbtype == DB_BTREE)
353 if((err = db->set_bt_compare(db, compare)))
354 fatal(0, "db->set_bt_compare %s: %s", path, db_strerror(err));
355 if((err = db->open(db, 0, path, 0, dbtype,
356 openflags | DB_AUTO_COMMIT, mode))) {
357 if((openflags & DB_CREATE) || errno != ENOENT)
358 fatal(0, "db->open %s: %s", path, db_strerror(err));
365 /** @brief Open track databases
366 * @param flags Flags flags word
368 * @p flags should have one of:
369 * - @p TRACKDB_NO_UPGRADE, if no upgrade should be attempted
370 * - @p TRACKDB_CAN_UPGRADE, if an upgrade may be attempted
371 * - @p TRACKDB_OPEN_FOR_UPGRADE, if this is disorder-dbupgrade
373 * - @p TRACKDB_READ_ONLY, read only access
375 void trackdb_open(int flags) {
378 uint32_t dbflags = flags & TRACKDB_READ_ONLY ? DB_RDONLY : DB_CREATE;
383 /* check the database version first */
384 trackdb_globaldb = open_db("global.db", 0, DB_HASH, DB_RDONLY, 0666);
385 if(trackdb_globaldb) {
386 /* This is an existing database */
390 s = trackdb_get_global("_dbversion");
391 /* Close the database again, we'll open it property below */
392 if((err = trackdb_globaldb->close(trackdb_globaldb, 0)))
393 fatal(0, "error closing global.db: %s", db_strerror(err));
394 trackdb_globaldb = 0;
395 /* Convert version string to an integer */
396 oldversion = s ? atol(s) : 1;
397 if(oldversion > config->dbversion) {
398 /* Database is from the future; we never allow this. */
399 fatal(0, "this version of DisOrder is too old for database version %ld",
402 if(oldversion < config->dbversion) {
403 /* Database version is out of date */
404 switch(flags & TRACKDB_UPGRADE_MASK) {
405 case TRACKDB_NO_UPGRADE:
406 /* This database needs upgrading but this is not permitted */
407 fatal(0, "database needs upgrading from %ld to %ld",
408 oldversion, config->dbversion);
409 case TRACKDB_CAN_UPGRADE:
410 /* This database needs upgrading */
411 info("invoking disorder-dbupgrade to upgrade from %ld to %ld",
412 oldversion, config->dbversion);
413 pid = subprogram(0, -1, "disorder-dbupgrade", (char *)0);
414 while(waitpid(pid, &err, 0) == -1 && errno == EINTR)
417 fatal(0, "disorder-dbupgrade %s", wstat(err));
418 info("disorder-dbupgrade succeeded");
420 case TRACKDB_OPEN_FOR_UPGRADE:
426 if(oldversion == config->dbversion && (flags & TRACKDB_OPEN_FOR_UPGRADE)) {
427 /* This doesn't make any sense */
428 fatal(0, "database is already at current version");
430 trackdb_existing_database = 1;
432 if(flags & TRACKDB_OPEN_FOR_UPGRADE) {
433 /* Cannot upgrade a new database */
434 fatal(0, "cannot upgrade a database that does not exist");
436 /* This is a brand new database */
437 trackdb_existing_database = 0;
439 /* open the databases */
440 if(!(trackdb_usersdb = open_db("users.db",
441 0, DB_HASH, dbflags, 0600)))
442 fatal(0, "cannot open users.db");
443 trackdb_tracksdb = open_db("tracks.db",
444 DB_RECNUM, DB_BTREE, dbflags, 0666);
445 trackdb_searchdb = open_db("search.db",
446 DB_DUP|DB_DUPSORT, DB_HASH, dbflags, 0666);
447 trackdb_tagsdb = open_db("tags.db",
448 DB_DUP|DB_DUPSORT, DB_HASH, dbflags, 0666);
449 trackdb_prefsdb = open_db("prefs.db", 0, DB_HASH, dbflags, 0666);
450 trackdb_globaldb = open_db("global.db", 0, DB_HASH, dbflags, 0666);
451 trackdb_noticeddb = open_db("noticed.db",
452 DB_DUPSORT, DB_BTREE, dbflags, 0666);
453 if(!trackdb_existing_database) {
454 /* Stash the database version */
457 assert(!(flags & TRACKDB_OPEN_FOR_UPGRADE));
458 snprintf(buf, sizeof buf, "%ld", config->dbversion);
459 trackdb_set_global("_dbversion", buf, 0);
461 D(("opened databases"));
464 /* close track databases */
465 void trackdb_close(void) {
471 if((err = trackdb_tracksdb->close(trackdb_tracksdb, 0)))
472 fatal(0, "error closing tracks.db: %s", db_strerror(err));
473 if((err = trackdb_searchdb->close(trackdb_searchdb, 0)))
474 fatal(0, "error closing search.db: %s", db_strerror(err));
475 if((err = trackdb_tagsdb->close(trackdb_tagsdb, 0)))
476 fatal(0, "error closing tags.db: %s", db_strerror(err));
477 if((err = trackdb_prefsdb->close(trackdb_prefsdb, 0)))
478 fatal(0, "error closing prefs.db: %s", db_strerror(err));
479 if((err = trackdb_globaldb->close(trackdb_globaldb, 0)))
480 fatal(0, "error closing global.db: %s", db_strerror(err));
481 if((err = trackdb_noticeddb->close(trackdb_noticeddb, 0)))
482 fatal(0, "error closing noticed.db: %s", db_strerror(err));
483 if((err = trackdb_usersdb->close(trackdb_usersdb, 0)))
484 fatal(0, "error closing users.db: %s", db_strerror(err));
485 trackdb_tracksdb = trackdb_searchdb = trackdb_prefsdb = 0;
486 trackdb_tagsdb = trackdb_globaldb = 0;
487 D(("closed databases"));
490 /* generic db routines *******************************************************/
492 /* fetch and decode a database entry. Returns 0, DB_NOTFOUND or
493 * DB_LOCK_DEADLOCK. */
494 int trackdb_getdata(DB *db,
501 switch(err = db->get(db, tid, make_key(&key, track),
502 prepare_data(&data), 0)) {
504 *kp = kvp_urldecode(data.data, data.size);
509 case DB_LOCK_DEADLOCK:
510 error(0, "error querying database: %s", db_strerror(err));
513 fatal(0, "error querying database: %s", db_strerror(err));
517 /* encode and store a database entry. Returns 0, DB_KEYEXIST or
518 * DB_LOCK_DEADLOCK. */
519 int trackdb_putdata(DB *db,
527 switch(err = db->put(db, tid, make_key(&key, track),
528 encode_data(&data, k), flags)) {
532 case DB_LOCK_DEADLOCK:
533 error(0, "error updating database: %s", db_strerror(err));
536 fatal(0, "error updating database: %s", db_strerror(err));
540 /** @brief Delete a database entry
542 * @param track Key to delete
543 * @param tid Transaction ID
544 * @return 0, DB_NOTFOUND or DB_LOCK_DEADLOCK
546 int trackdb_delkey(DB *db,
552 switch(err = db->del(db, tid, make_key(&key, track), 0)) {
556 case DB_LOCK_DEADLOCK:
557 error(0, "error updating database: %s", db_strerror(err));
560 fatal(0, "error updating database: %s", db_strerror(err));
564 /* open a database cursor */
565 DBC *trackdb_opencursor(DB *db, DB_TXN *tid) {
569 switch(err = db->cursor(db, tid, &c, 0)) {
571 default: fatal(0, "error creating cursor: %s", db_strerror(err));
576 /* close a database cursor; returns 0 or DB_LOCK_DEADLOCK */
577 int trackdb_closecursor(DBC *c) {
581 switch(err = c->c_close(c)) {
584 case DB_LOCK_DEADLOCK:
585 error(0, "error closing cursor: %s", db_strerror(err));
588 fatal(0, "error closing cursor: %s", db_strerror(err));
592 /* delete a (key,data) pair. Returns 0, DB_NOTFOUND or DB_LOCK_DEADLOCK. */
593 int trackdb_delkeydata(DB *db,
601 c = trackdb_opencursor(db, tid);
602 switch(err = c->c_get(c, make_key(&key, word),
603 make_key(&data, track), DB_GET_BOTH)) {
605 switch(err = c->c_del(c, 0)) {
611 case DB_LOCK_DEADLOCK:
612 error(0, "error updating database: %s", db_strerror(err));
615 fatal(0, "c->c_del: %s", db_strerror(err));
620 case DB_LOCK_DEADLOCK:
621 error(0, "error updating database: %s", db_strerror(err));
624 fatal(0, "c->c_get: %s", db_strerror(err));
626 if(trackdb_closecursor(c)) err = DB_LOCK_DEADLOCK;
630 /* start a transaction */
631 DB_TXN *trackdb_begin_transaction(void) {
635 if((err = trackdb_env->txn_begin(trackdb_env, 0, &tid, 0)))
636 fatal(0, "trackdb_env->txn_begin: %s", db_strerror(err));
640 /* abort transaction */
641 void trackdb_abort_transaction(DB_TXN *tid) {
645 if((err = tid->abort(tid)))
646 fatal(0, "tid->abort: %s", db_strerror(err));
649 /* commit transaction */
650 void trackdb_commit_transaction(DB_TXN *tid) {
653 if((err = tid->commit(tid, 0)))
654 fatal(0, "tid->commit: %s", db_strerror(err));
657 /* search/tags shared code ***************************************************/
659 /* comparison function used by dedupe() */
660 static int wordcmp(const void *a, const void *b) {
661 return strcmp(*(const char **)a, *(const char **)b);
664 /* sort and de-dupe VEC */
665 static char **dedupe(char **vec, int nvec) {
668 qsort(vec, nvec, sizeof (char *), wordcmp);
672 for(n = 1; n < nvec; ++n)
673 if(strcmp(vec[n], vec[m - 1]))
680 /* update a key/track database. Returns 0 or DB_DEADLOCK. */
681 static int register_word(DB *db, const char *what,
682 const char *track, const char *word,
687 switch(err = db->put(db, tid, make_key(&key, word),
688 make_key(&data, track), DB_NODUPDATA)) {
692 case DB_LOCK_DEADLOCK:
693 error(0, "error updating %s.db: %s", what, db_strerror(err));
696 fatal(0, "error updating %s.db: %s", what, db_strerror(err));
700 /* search primitives *********************************************************/
702 /* return true iff NAME is a trackname_display_ pref */
703 static int is_display_pref(const char *name) {
704 static const char prefix[] = "trackname_display_";
705 return !strncmp(name, prefix, (sizeof prefix) - 1);
708 /** @brief Word_Break property tailor that treats underscores as spaces */
709 static int tailor_underscore_Word_Break_Other(uint32_t c) {
713 case 0x005F: /* LOW LINE (SPACING UNDERSCORE) */
714 return unicode_Word_Break_Other;
718 /** @brief Remove all combining characters in-place
719 * @param s Pointer to start of string
720 * @param ns Length of string
721 * @return New, possiblby reduced, length
723 static size_t remove_combining_chars(uint32_t *s, size_t ns) {
724 uint32_t *start = s, *t = s, *end = s + ns;
727 const uint32_t c = *s++;
728 if(!utf32_combining_class(c))
734 /** @brief Normalize and split a string using a given tailoring */
735 static void word_split(struct vector *v,
737 unicode_property_tailor *pt) {
739 uint32_t *t32, **w32;
741 /* Convert to UTF-32 */
742 if(!(t32 = utf8_to_utf32(s, strlen(s), &nt32)))
744 /* Erase case distinctions */
745 if(!(t32 = utf32_casefold_compat(t32, nt32, &nt32)))
747 /* Drop combining characters */
748 nt32 = remove_combining_chars(t32, nt32);
749 /* Split into words, treating _ as a space */
750 w32 = utf32_word_split(t32, nt32, &nw, pt);
751 /* Convert words back to UTF-8 and append to result */
752 for(i = 0; i < nw; ++i)
753 vector_append(v, utf32_to_utf8(w32[i], utf32_len(w32[i]), 0));
756 /** @brief Normalize a tag
758 * @param ns Length of tag
759 * @return Normalized string or NULL on error
761 * The return value will be:
763 * - have no leading or trailing space
764 * - have no combining characters
765 * - all spacing between words will be a single U+0020 SPACE
767 static char *normalize_tag(const char *s, size_t ns) {
768 uint32_t *s32, **w32;
769 size_t ns32, nw32, i;
772 if(!(s32 = utf8_to_utf32(s, ns, &ns32)))
774 if(!(s32 = utf32_casefold_compat(s32, ns32, &ns32))) /* ->NFKD */
776 ns32 = remove_combining_chars(s32, ns32);
777 /* Split into words, no Word_Break tailoring */
778 w32 = utf32_word_split(s32, ns32, &nw32, 0);
779 /* Compose back into a string */
781 for(i = 0; i < nw32; ++i) {
783 dynstr_append(d, ' ');
784 dynstr_append_string(d, utf32_to_utf8(w32[i], utf32_len(w32[i]), 0));
790 /* compute the words of a track name */
791 static char **track_to_words(const char *track,
792 const struct kvp *p) {
794 const char *rootless = track_rootless(track);
797 rootless = track; /* bodge */
799 rootless = strip_extension(rootless);
800 word_split(&v, strip_extension(rootless), tailor_underscore_Word_Break_Other);
801 for(; p; p = p->next)
802 if(is_display_pref(p->name))
803 word_split(&v, p->value, 0);
804 vector_terminate(&v);
805 return dedupe(v.vec, v.nvec);
808 /* return nonzero iff WORD is a stopword */
809 static int stopword(const char *word) {
812 for(n = 0; n < config->stopword.n
813 && strcmp(word, config->stopword.s[n]); ++n)
815 return n < config->stopword.n;
818 /* record that WORD appears in TRACK. Returns 0 or DB_LOCK_DEADLOCK. */
819 static int register_search_word(const char *track, const char *word,
821 if(stopword(word)) return 0;
822 return register_word(trackdb_searchdb, "search", track, word, tid);
825 /* Tags **********************************************************************/
827 /* Return nonzero if C is a valid tag character */
828 static int tagchar(int c) {
837 /* Parse and de-dupe a tag list. If S=0 then assumes "". */
838 char **parsetags(const char *s) {
844 /* skip initial separators */
845 while(*s && (!tagchar(*s) || *s == ' '))
848 /* find the extent of the tag */
850 while(*s && tagchar(*s))
852 /* strip trailing spaces */
853 while(s > t && s[-1] == ' ')
855 /* add tag to list */
856 vector_append(&v, normalize_tag(t, (size_t)(s - t)));
857 /* skip intermediate and trailing separators */
858 while(*s && (!tagchar(*s) || *s == ' '))
862 vector_terminate(&v);
863 return dedupe(v.vec, v.nvec);
866 /* Record that TRACK has TAG. Returns 0 or DB_LOCK_DEADLOCK. */
867 static int register_tag(const char *track, const char *tag, DB_TXN *tid) {
868 return register_word(trackdb_tagsdb, "tags", track, tag, tid);
871 /* aliases *******************************************************************/
873 /* compute the alias and store at aliasp. Returns 0 or DB_LOCK_DEADLOCK. If
874 * there is no alias sets *aliasp to 0. */
875 static int compute_alias(char **aliasp,
880 const char *s = config->alias, *t, *expansion, *part;
881 int c, used_db = 0, slash_prefix, err;
883 const char *const root = find_track_root(track);
886 /* Bodge for tracks with no root */
891 dynstr_append_string(&d, root);
892 while((c = (unsigned char)*s++)) {
894 dynstr_append(&d, c);
897 if((slash_prefix = (*s == '/')))
900 assert(t != 0); /* validated at startup */
901 part = xstrndup(s, t - s);
902 expansion = getpart(track, "display", part, p, &used_db);
904 if(slash_prefix) dynstr_append(&d, '/');
905 dynstr_append_string(&d, expansion);
907 s = t + 1; /* skip {part} */
909 /* only admit to the alias if we used the db... */
914 dynstr_terminate(&d);
915 /* ...and the answer differs from the original... */
916 if(!strcmp(track, d.vec)) {
920 /* ...and there isn't already a different track with that name (including as
922 switch(err = trackdb_getdata(trackdb_tracksdb, d.vec, &at, tid)) {
924 if((s = kvp_get(at, "_alias_for"))
925 && !strcmp(s, track)) {
937 /* get track and prefs data (if tp/pp not null pointers). Returns 0 on
938 * success, DB_NOTFOUND if the track does not exist or DB_LOCK_DEADLOCK.
939 * Always sets the return values, even if only to null pointers. */
940 static int gettrackdata(const char *track,
943 const char **actualp,
945 #define GTD_NOALIAS 0x0001
948 const char *actual = track;
949 struct kvp *t = 0, *p = 0;
951 if((err = trackdb_getdata(trackdb_tracksdb, track, &t, tid))) goto done;
952 if((actual = kvp_get(t, "_alias_for"))) {
953 if(flags & GTD_NOALIAS) {
954 error(0, "alias passed to gettrackdata where real path required");
957 if((err = trackdb_getdata(trackdb_tracksdb, actual, &t, tid))) goto done;
962 if((err = trackdb_getdata(trackdb_prefsdb, actual, &p, tid)) == DB_LOCK_DEADLOCK)
967 if(actualp) *actualp = actual;
973 /* trackdb_notice() **********************************************************/
975 /** @brief notice a possibly new track
976 * @return @c DB_NOTFOUND if new, 0 if already known
978 int trackdb_notice(const char *track,
984 tid = trackdb_begin_transaction();
985 err = trackdb_notice_tid(track, path, tid);
986 if((err == DB_LOCK_DEADLOCK)) goto fail;
989 trackdb_abort_transaction(tid);
991 trackdb_commit_transaction(tid);
995 /** @brief notice a possibly new track
996 * @param track NFC UTF-8 track name
997 * @param path Raw path name
998 * @param tid Transaction ID
999 * @return @c DB_NOTFOUND if new, 0 if already known, @c DB_LOCK_DEADLOCK also
1001 int trackdb_notice_tid(const char *track,
1005 struct kvp *t, *a, *p;
1009 /* notice whether the tracks.db entry changes */
1011 /* get any existing tracks entry */
1012 if((err = gettrackdata(track, &t, &p, 0, 0, tid)) == DB_LOCK_DEADLOCK)
1014 ret = err; /* 0 or DB_NOTFOUND */
1015 /* this is a real track */
1016 t_changed += kvp_set(&t, "_alias_for", 0);
1017 t_changed += kvp_set(&t, "_path", path);
1018 /* if we have an alias record it in the database */
1019 if((err = compute_alias(&alias, track, p, tid))) return err;
1021 /* won't overwrite someone else's alias as compute_alias() checks */
1022 D(("%s: alias %s", track, alias));
1024 kvp_set(&a, "_alias_for", track);
1025 if((err = trackdb_putdata(trackdb_tracksdb, alias, a, tid, 0))) return err;
1027 /* update search.db */
1028 w = track_to_words(track, p);
1029 for(n = 0; w[n]; ++n)
1030 if((err = register_search_word(track, w[n], tid)))
1032 /* update tags.db */
1033 w = parsetags(kvp_get(p, "tags"));
1034 for(n = 0; w[n]; ++n)
1035 if((err = register_tag(track, w[n], tid)))
1037 /* only store the tracks.db entry if it has changed */
1038 if(t_changed && (err = trackdb_putdata(trackdb_tracksdb, track, t, tid, 0)))
1040 if(ret == DB_NOTFOUND) {
1041 uint32_t timestamp[2];
1046 timestamp[0] = htonl((uint64_t)now >> 32);
1047 timestamp[1] = htonl((uint32_t)now);
1048 memset(&key, 0, sizeof key);
1049 key.data = timestamp;
1050 key.size = sizeof timestamp;
1051 switch(err = trackdb_noticeddb->put(trackdb_noticeddb, tid, &key,
1052 make_key(&data, track), 0)) {
1054 case DB_LOCK_DEADLOCK: return err;
1055 default: fatal(0, "error updating noticed.db: %s", db_strerror(err));
1061 /* trackdb_obsolete() ********************************************************/
1063 /* obsolete a track */
1064 int trackdb_obsolete(const char *track, DB_TXN *tid) {
1069 if((err = gettrackdata(track, 0, &p, 0,
1070 GTD_NOALIAS, tid)) == DB_LOCK_DEADLOCK)
1072 else if(err == DB_NOTFOUND) return 0;
1073 /* compute the alias, if any, and delete it */
1074 if((err = compute_alias(&alias, track, p, tid))) return err;
1076 /* if the alias points to some other track then compute_alias won't
1078 if((err = trackdb_delkey(trackdb_tracksdb, alias, tid))
1079 && err != DB_NOTFOUND)
1082 /* update search.db */
1083 w = track_to_words(track, p);
1084 for(n = 0; w[n]; ++n)
1085 if(trackdb_delkeydata(trackdb_searchdb,
1086 w[n], track, tid) == DB_LOCK_DEADLOCK)
1088 /* update tags.db */
1089 w = parsetags(kvp_get(p, "tags"));
1090 for(n = 0; w[n]; ++n)
1091 if(trackdb_delkeydata(trackdb_tagsdb,
1092 w[n], track, tid) == DB_LOCK_DEADLOCK)
1094 /* update tracks.db */
1095 if(trackdb_delkey(trackdb_tracksdb, track, tid) == DB_LOCK_DEADLOCK)
1097 /* We don't delete the prefs, so they survive temporary outages of the
1098 * (possibly virtual) track filesystem */
1102 /* trackdb_stats() ***********************************************************/
1104 #define H(name) { #name, offsetof(DB_HASH_STAT, name) }
1105 #define B(name) { #name, offsetof(DB_BTREE_STAT, name) }
1107 static const struct statinfo {
1110 } statinfo_hash[] = {
1126 }, statinfo_btree[] = {
1147 /* look up stats for DB */
1148 static int get_stats(struct vector *v,
1150 const struct statinfo *si,
1159 switch(err = database->stat(database, tid, &sp, 0)) {
1162 case DB_LOCK_DEADLOCK:
1163 error(0, "error querying database: %s", db_strerror(err));
1166 fatal(0, "error querying database: %s", db_strerror(err));
1168 for(n = 0; n < nsi; ++n) {
1169 byte_xasprintf(&str, "%s=%"PRIuMAX, si[n].name,
1170 (uintmax_t)*(u_int32_t *)((char *)sp + si[n].offset));
1171 vector_append(v, str);
1177 /** @brief One entry in the search league */
1178 struct search_entry {
1183 /** @brief Add a word to the search league
1184 * @param se Pointer to search league
1185 * @param count Maximum size for search league
1186 * @param nse Current size of search league
1187 * @param word New word, or NULL
1188 * @param n How often @p word appears
1189 * @return New size of search league
1191 static int register_search_entry(struct search_entry *se,
1198 if(word && (nse < count || n > se[nse - 1].n)) {
1199 /* Find the starting point */
1204 /* Find the insertion point */
1205 while(i > 0 && n > se[i - 1].n)
1207 memmove(&se[i + 1], &se[i], (nse - i - 1) * sizeof *se);
1214 /* find the top COUNT words in the search database */
1215 static int search_league(struct vector *v, int count, DB_TXN *tid) {
1216 struct search_entry *se;
1219 int err, n = 0, nse = 0, i;
1224 cursor = trackdb_opencursor(trackdb_searchdb, tid);
1225 se = xmalloc(count * sizeof *se);
1226 /* Walk across the whole database counting up the number of times each
1228 while(!(err = cursor->c_get(cursor, prepare_data(&k), prepare_data(&d),
1230 if(word && wl == k.size && !strncmp(word, k.data, wl))
1231 ++n; /* same word again */
1233 nse = register_search_entry(se, count, nse, word, n);
1234 word = xstrndup(k.data, wl = k.size);
1242 case DB_LOCK_DEADLOCK:
1243 error(0, "error querying search database: %s", db_strerror(err));
1246 fatal(0, "error querying search database: %s", db_strerror(err));
1248 if(trackdb_closecursor(cursor)) err = DB_LOCK_DEADLOCK;
1250 nse = register_search_entry(se, count, nse, word, n);
1251 byte_xasprintf(&str, "Top %d search words:", nse);
1252 vector_append(v, str);
1253 for(i = 0; i < nse; ++i) {
1254 byte_xasprintf(&str, "%4d: %5d %s", i + 1, se[i].n, se[i].word);
1255 vector_append(v, str);
1260 #define SI(what) statinfo_##what, \
1261 sizeof statinfo_##what / sizeof (struct statinfo)
1263 /* return a list of database stats */
1264 char **trackdb_stats(int *nstatsp) {
1270 tid = trackdb_begin_transaction();
1272 vector_append(&v, (char *)"Tracks database stats:");
1273 if(get_stats(&v, trackdb_tracksdb, SI(btree), tid)) goto fail;
1274 vector_append(&v, (char *)"");
1275 vector_append(&v, (char *)"Search database stats:");
1276 if(get_stats(&v, trackdb_searchdb, SI(hash), tid)) goto fail;
1277 vector_append(&v, (char *)"");
1278 vector_append(&v, (char *)"Prefs database stats:");
1279 if(get_stats(&v, trackdb_prefsdb, SI(hash), tid)) goto fail;
1280 vector_append(&v, (char *)"");
1281 if(search_league(&v, 10, tid)) goto fail;
1282 vector_terminate(&v);
1285 trackdb_abort_transaction(tid);
1287 trackdb_commit_transaction(tid);
1288 if(nstatsp) *nstatsp = v.nvec;
1292 struct stats_details {
1293 void (*done)(char *data, void *u);
1295 int exited; /* subprocess exited */
1296 int closed; /* pipe close */
1297 int wstat; /* wait status from subprocess */
1298 struct dynstr data[1]; /* data read from pipe */
1301 static void stats_complete(struct stats_details *d) {
1304 if(!(d->exited && d->closed))
1306 byte_xasprintf(&s, "\n"
1308 "track lookup cache hits: %lu\n"
1309 "track lookup cache misses: %lu\n",
1311 cache_files_misses);
1312 dynstr_append_string(d->data, s);
1313 dynstr_terminate(d->data);
1314 d->done(d->data->vec, d->u);
1317 static int stats_finished(ev_source attribute((unused)) *ev,
1318 pid_t attribute((unused)) pid,
1320 const struct rusage attribute((unused)) *rusage,
1322 struct stats_details *const d = u;
1326 error(0, "disorder-stats %s", wstat(status));
1331 static int stats_read(ev_source attribute((unused)) *ev,
1337 struct stats_details *const d = u;
1339 dynstr_append_bytes(d->data, ptr, bytes);
1340 ev_reader_consume(reader, bytes);
1347 static int stats_error(ev_source attribute((unused)) *ev,
1350 struct stats_details *const d = u;
1352 error(errno_value, "error reading from pipe to disorder-stats");
1358 void trackdb_stats_subprocess(ev_source *ev,
1359 void (*done)(char *data, void *u),
1363 struct stats_details *d = xmalloc(sizeof *d);
1365 dynstr_init(d->data);
1369 pid = subprogram(ev, p[1], "disorder-stats", (char *)0);
1371 ev_child(ev, pid, 0, stats_finished, d);
1372 ev_reader_new(ev, p[0], stats_read, stats_error, d, "disorder-stats reader");
1375 /* set a pref (remove if value=0) */
1376 int trackdb_set(const char *track,
1378 const char *value) {
1379 struct kvp *t, *p, *a;
1382 char *oldalias, *newalias, **oldtags = 0, **newtags;
1385 /* TODO: if value matches default then set value=0 */
1389 tid = trackdb_begin_transaction();
1390 if((err = gettrackdata(track, &t, &p, 0,
1391 0, tid)) == DB_LOCK_DEADLOCK)
1393 if(err == DB_NOTFOUND) break;
1394 if(name[0] == '_') {
1395 if(kvp_set(&t, name, value))
1396 if(trackdb_putdata(trackdb_tracksdb, track, t, tid, 0))
1399 /* get the old alias name */
1400 if(compute_alias(&oldalias, track, p, tid)) goto fail;
1401 /* get the old tags */
1402 if(!strcmp(name, "tags"))
1403 oldtags = parsetags(kvp_get(p, "tags"));
1405 if(kvp_set(&p, name, value))
1406 if(trackdb_putdata(trackdb_prefsdb, track, p, tid, 0))
1408 /* compute the new alias name */
1409 if((err = compute_alias(&newalias, track, p, tid))) goto fail;
1410 /* check whether alias has changed */
1411 if(!(oldalias == newalias
1412 || (oldalias && newalias && !strcmp(oldalias, newalias)))) {
1413 /* adjust alias records to fit change */
1415 && trackdb_delkey(trackdb_tracksdb, oldalias, tid) == DB_LOCK_DEADLOCK)
1419 kvp_set(&a, "_alias_for", track);
1420 if(trackdb_putdata(trackdb_tracksdb, newalias, a, tid, 0)) goto fail;
1423 /* check whether tags have changed */
1424 if(!strcmp(name, "tags")) {
1425 newtags = parsetags(value);
1426 while(*oldtags || *newtags) {
1427 if(*oldtags && *newtags) {
1428 cmp = strcmp(*oldtags, *newtags);
1430 /* keeping this tag */
1434 /* old tag fits into a gap in the new list, so delete old */
1437 /* new tag fits into a gap in the old list, so insert new */
1439 } else if(*oldtags) {
1440 /* we've run out of new tags, so remaining old ones are to be
1443 if(trackdb_delkeydata(trackdb_tagsdb,
1444 *oldtags, track, tid) == DB_LOCK_DEADLOCK)
1448 /* we've run out of old tags, so remainig new ones are to be
1451 if(register_tag(track, *newtags, tid)) goto fail;
1460 trackdb_abort_transaction(tid);
1462 trackdb_commit_transaction(tid);
1463 return err == 0 ? 0 : -1;
1467 const char *trackdb_get(const char *track,
1469 return kvp_get(trackdb_get_all(track), name);
1472 /* get all prefs as a 0-terminated array */
1473 struct kvp *trackdb_get_all(const char *track) {
1474 struct kvp *t, *p, **pp;
1478 tid = trackdb_begin_transaction();
1479 if(gettrackdata(track, &t, &p, 0, 0, tid) == DB_LOCK_DEADLOCK)
1483 trackdb_abort_transaction(tid);
1485 trackdb_commit_transaction(tid);
1486 for(pp = &p; *pp; pp = &(*pp)->next)
1493 const char *trackdb_resolve(const char *track) {
1498 tid = trackdb_begin_transaction();
1499 if(gettrackdata(track, 0, 0, &actual, 0, tid) == DB_LOCK_DEADLOCK)
1503 trackdb_abort_transaction(tid);
1505 trackdb_commit_transaction(tid);
1509 int trackdb_isalias(const char *track) {
1510 const char *actual = trackdb_resolve(track);
1512 return strcmp(actual, track);
1515 /* test whether a track exists (perhaps an alias) */
1516 int trackdb_exists(const char *track) {
1521 tid = trackdb_begin_transaction();
1522 /* unusually, here we want the return value */
1523 if((err = gettrackdata(track, 0, 0, 0, 0, tid)) == DB_LOCK_DEADLOCK)
1527 trackdb_abort_transaction(tid);
1529 trackdb_commit_transaction(tid);
1533 /* return the list of tags */
1534 char **trackdb_alltags(void) {
1539 WITH_TRANSACTION(trackdb_listkeys(trackdb_tagsdb, v, tid));
1543 /** @brief List all the keys in @p db
1544 * @param db Database
1545 * @param v Vector to store keys in
1546 * @param tid Transaction ID
1547 * @return 0 or DB_LOCK_DEADLOCK
1549 int trackdb_listkeys(DB *db, struct vector *v, DB_TXN *tid) {
1552 DBC *const c = trackdb_opencursor(db, tid);
1555 memset(&k, 0, sizeof k);
1556 while(!(e = c->c_get(c, &k, prepare_data(&d), DB_NEXT_NODUP)))
1557 vector_append(v, xstrndup(k.data, k.size));
1561 case DB_LOCK_DEADLOCK:
1564 fatal(0, "c->c_get: %s", db_strerror(e));
1566 if((e = trackdb_closecursor(c)))
1568 vector_terminate(v);
1572 /* return 1 iff sorted tag lists A and B have at least one member in common */
1573 int tag_intersection(char **a, char **b) {
1576 /* Same sort of logic as trackdb_set() above */
1578 if(!(cmp = strcmp(*a, *b))) return 1;
1579 else if(cmp < 0) ++a;
1585 static pid_t choose_pid = -1;
1586 static int choose_fd;
1587 static random_callback *choose_callback;
1588 static struct dynstr choose_output;
1589 static unsigned choose_complete;
1590 static int choose_status;
1591 #define CHOOSE_RUNNING 1
1592 #define CHOOSE_READING 2
1594 static void choose_finished(ev_source *ev, unsigned which) {
1595 choose_complete |= which;
1596 if(choose_complete != (CHOOSE_RUNNING|CHOOSE_READING))
1599 if(choose_status == 0 && choose_output.nvec > 0) {
1600 dynstr_terminate(&choose_output);
1601 choose_callback(ev, xstrdup(choose_output.vec));
1603 choose_callback(ev, 0);
1606 /** @brief Called when @c disorder-choose terminates */
1607 static int choose_exited(ev_source *ev,
1608 pid_t attribute((unused)) pid,
1610 const struct rusage attribute((unused)) *rusage,
1611 void attribute((unused)) *u) {
1613 error(0, "disorder-choose %s", wstat(status));
1614 choose_status = status;
1615 choose_finished(ev, CHOOSE_RUNNING);
1619 /** @brief Called with data from @c disorder-choose pipe */
1620 static int choose_readable(ev_source *ev,
1625 void attribute((unused)) *u) {
1626 dynstr_append_bytes(&choose_output, ptr, bytes);
1627 ev_reader_consume(reader, bytes);
1629 choose_finished(ev, CHOOSE_READING);
1633 static int choose_read_error(ev_source *ev,
1635 void attribute((unused)) *u) {
1636 error(errno_value, "error reading disorder-choose pipe");
1637 choose_finished(ev, CHOOSE_READING);
1641 /** @brief Request a random track
1642 * @param ev Event source
1643 * @param callback Called with random track or NULL
1644 * @return 0 if a request was initiated, else -1
1646 * Initiates a random track choice. @p callback will later be called back with
1647 * the choice (or NULL on error). If a choice is already underway then -1 is
1648 * returned and there will be no additional callback.
1650 * The caller shouldn't assume that the track returned actually exists (it
1651 * might be removed between the choice and the callback, or between being added
1652 * to the queue and being played).
1654 int trackdb_request_random(ev_source *ev,
1655 random_callback *callback) {
1658 if(choose_pid != -1)
1659 return -1; /* don't run concurrent chooses */
1662 choose_pid = subprogram(ev, p[1], "disorder-choose", (char *)0);
1665 choose_callback = callback;
1666 choose_output.nvec = 0;
1667 choose_complete = 0;
1668 ev_reader_new(ev, p[0], choose_readable, choose_read_error, 0,
1669 "disorder-choose reader"); /* owns p[0] */
1670 ev_child(ev, choose_pid, 0, choose_exited, 0); /* owns the subprocess */
1674 /* get a track name given the prefs. Set *used_db to 1 if we got the answer
1675 * from the prefs. */
1676 static const char *getpart(const char *track,
1677 const char *context,
1679 const struct kvp *p,
1684 byte_xasprintf(&pref, "trackname_%s_%s", context, part);
1685 if((result = kvp_get(p, pref)))
1688 result = trackname_part(track, context, part);
1689 assert(result != 0);
1693 /* get a track name part, like trackname_part(), but taking the database into
1695 const char *trackdb_getpart(const char *track,
1696 const char *context,
1704 /* construct the full pref */
1705 byte_xasprintf(&pref, "trackname_%s_%s", context, part);
1707 tid = trackdb_begin_transaction();
1708 if((err = gettrackdata(track, 0, &p, &actual, 0, tid)) == DB_LOCK_DEADLOCK)
1712 trackdb_abort_transaction(tid);
1714 trackdb_commit_transaction(tid);
1715 return getpart(actual, context, part, p, &used_db);
1718 /* get the raw path name for @track@ (might be an alias) */
1719 const char *trackdb_rawpath(const char *track) {
1725 tid = trackdb_begin_transaction();
1726 if(gettrackdata(track, &t, 0, 0, 0, tid) == DB_LOCK_DEADLOCK)
1730 trackdb_abort_transaction(tid);
1732 trackdb_commit_transaction(tid);
1733 if(!(path = kvp_get(t, "_path"))) path = track;
1737 /* trackdb_list **************************************************************/
1739 /* this is incredibly ugly, sorry, perhaps it will be rewritten to be actually
1740 * readable at some point */
1742 /* return true if the basename of TRACK[0..TL-1], as defined by DL, matches RE.
1743 * If RE is a null pointer then it matches everything. */
1744 static int track_matches(size_t dl, const char *track, size_t tl,
1752 switch(rc = pcre_exec(re, 0, track, tl, 0, 0, ovec, 3)) {
1753 case PCRE_ERROR_NOMATCH: return 0;
1756 error(0, "pcre_exec returned %d, subject '%s'", rc, track);
1763 static int do_list(struct vector *v, const char *dir,
1764 enum trackdb_listable what, const pcre *re, DB_TXN *tid) {
1770 size_t l, last_dir_len = 0;
1771 char *last_dir = 0, *track, *alias;
1775 cursor = trackdb_opencursor(trackdb_tracksdb, tid);
1778 /* find the first key >= dir */
1779 err = cursor->c_get(cursor, &k, &d, DB_SET_RANGE);
1780 /* keep going while we're dealing with <dir/anything> */
1783 && ((char *)k.data)[dl] == '/'
1784 && !memcmp(k.data, dir, dl)) {
1785 ptr = memchr((char *)k.data + dl + 1, '/', k.size - (dl + 1));
1787 /* we have <dir/component/anything>, so <dir/component> is a directory */
1788 l = ptr - (char *)k.data;
1789 if(what & trackdb_directories)
1791 && l == last_dir_len
1792 && !memcmp(last_dir, k.data, l))) {
1793 last_dir = xstrndup(k.data, last_dir_len = l);
1794 if(track_matches(dl, k.data, l, re))
1795 vector_append(v, last_dir);
1798 /* found a plain file */
1799 if((what & trackdb_files)) {
1800 track = xstrndup(k.data, k.size);
1801 if((err = trackdb_getdata(trackdb_prefsdb,
1802 track, &p, tid)) == DB_LOCK_DEADLOCK)
1804 /* if this file has an alias in the same directory then we skip it */
1805 if((err = compute_alias(&alias, track, p, tid)))
1807 if(!(alias && !strcmp(d_dirname(alias), d_dirname(track))))
1808 if(track_matches(dl, k.data, k.size, re))
1809 vector_append(v, track);
1812 err = cursor->c_get(cursor, &k, &d, DB_NEXT);
1820 case DB_LOCK_DEADLOCK:
1821 error(0, "error querying database: %s", db_strerror(err));
1824 fatal(0, "error querying database: %s", db_strerror(err));
1827 if(trackdb_closecursor(cursor)) err = DB_LOCK_DEADLOCK;
1831 /* return the directories or files below @dir@ */
1832 char **trackdb_list(const char *dir, int *np, enum trackdb_listable what,
1840 tid = trackdb_begin_transaction();
1843 if(do_list(&v, dir, what, re, tid))
1846 for(n = 0; n < config->collection.n; ++n)
1847 if(do_list(&v, config->collection.s[n].root, what, re, tid))
1852 trackdb_abort_transaction(tid);
1854 trackdb_commit_transaction(tid);
1855 vector_terminate(&v);
1861 /* If S is tag:something, return something. Else return 0. */
1862 static const char *checktag(const char *s) {
1863 if(!strncmp(s, "tag:", 4))
1869 /* return a list of tracks containing all of the words given. If you
1870 * ask for only stopwords you get no tracks. */
1871 char **trackdb_search(char **wordlist, int nwordlist, int *ntracks) {
1872 const char **w, *best = 0, *tag;
1873 char **twords, **tags;
1875 int i, j, n, err, what;
1885 *ntracks = 0; /* for early returns */
1886 /* normalize all the words */
1887 w = xmalloc(nwordlist * sizeof (char *));
1888 istag = xmalloc_noptr(nwordlist);
1889 for(n = 0; n < nwordlist; ++n) {
1893 w[n] = utf8_casefold_compat(wordlist[n], strlen(wordlist[n]), 0);
1894 if(checktag(w[n])) {
1895 ++ntags; /* count up tags */
1896 /* Normalize the tag */
1897 w[n] = normalize_tag(w[n] + 4, strlen(w[n] + 4));
1900 /* Normalize the search term by removing combining characters */
1901 if(!(w32 = utf8_to_utf32(w[n], strlen(w[n]), &nw32)))
1903 nw32 = remove_combining_chars(w32, nw32);
1904 if(!(w[n] = utf32_to_utf8(w32, nw32, 0)))
1909 /* find the longest non-stopword */
1910 for(n = 0; n < nwordlist; ++n)
1911 if(!istag[n] && !stopword(w[n]))
1912 if(!best || strlen(w[n]) > strlen(best))
1914 /* TODO: we should at least in principal be able to identify the word or tag
1915 * with the least matches in log time, and choose that as our primary search
1917 if(ntags && !best) {
1918 /* Only tags are listed. We limit to the first and narrow down with the
1920 best = istag[0] ? w[0] : 0;
1921 db = trackdb_tagsdb;
1924 /* We can limit to some word. */
1925 db = trackdb_searchdb;
1928 /* Only stopwords */
1934 tid = trackdb_begin_transaction();
1935 /* find all the tracks that have that word */
1940 cursor = trackdb_opencursor(db, tid);
1941 while(!(err = cursor->c_get(cursor, &k, &d, what))) {
1942 vector_append(&v, xstrndup(d.data, d.size));
1949 case DB_LOCK_DEADLOCK:
1950 error(0, "error querying %s database: %s", dbname, db_strerror(err));
1953 fatal(0, "error querying %s database: %s", dbname, db_strerror(err));
1955 if(trackdb_closecursor(cursor)) err = DB_LOCK_DEADLOCK;
1957 /* do a naive search over that (hopefuly fairly small) list of tracks */
1959 for(n = 0; n < v.nvec; ++n) {
1960 if((err = gettrackdata(v.vec[n], 0, &p, 0, 0, tid) == DB_LOCK_DEADLOCK))
1963 error(0, "track %s unexpected error: %s", v.vec[n], db_strerror(err));
1966 twords = track_to_words(v.vec[n], p);
1967 tags = parsetags(kvp_get(p, "tags"));
1968 for(i = 0; i < nwordlist; ++i) {
1971 /* Track must have this tag */
1972 for(j = 0; tags[j]; ++j)
1973 if(!strcmp(tag, tags[j])) break; /* tag found */
1974 if(!tags[j]) break; /* tag not found */
1976 /* Track must contain this word */
1977 for(j = 0; twords[j]; ++j)
1978 if(!strcmp(w[i], twords[j])) break; /* word found */
1979 if(!twords[j]) break; /* word not found */
1982 if(i >= nwordlist) /* all words found */
1983 vector_append(&u, v.vec[n]);
1987 trackdb_closecursor(cursor);
1989 trackdb_abort_transaction(tid);
1990 info("retrying search");
1992 trackdb_commit_transaction(tid);
1993 vector_terminate(&u);
1999 /* trackdb_scan **************************************************************/
2001 int trackdb_scan(const char *root,
2002 int (*callback)(const char *track,
2011 const size_t root_len = root ? strlen(root) : 0;
2013 struct kvp *data, *prefs;
2016 cursor = trackdb_opencursor(trackdb_tracksdb, tid);
2018 err = cursor->c_get(cursor, make_key(&k, root), prepare_data(&d),
2021 memset(&k, 0, sizeof k);
2022 err = cursor->c_get(cursor, &k, prepare_data(&d),
2027 || (k.size > root_len
2028 && !strncmp(k.data, root, root_len)
2029 && ((char *)k.data)[root_len] == '/')) {
2030 data = kvp_urldecode(d.data, d.size);
2031 if(kvp_get(data, "_path")) {
2032 track = xstrndup(k.data, k.size);
2033 /* TODO: trackdb_prefsdb is currently a DB_HASH. This means we have to
2034 * do a lookup for every single track. In fact this is quite quick:
2035 * with around 10,000 tracks a complete scan is around 0.3s on my
2036 * 2.2GHz Athlon. However, if it were a DB_BTREE, we could do the same
2037 * linear walk as we already do over trackdb_tracksdb, and probably get
2038 * even higher performance. That would require upgrade logic to
2039 * translate old databases though.
2041 switch(err = trackdb_prefsdb->get(trackdb_prefsdb, tid, &k,
2042 prepare_data(&pd), 0)) {
2044 prefs = kvp_urldecode(pd.data, pd.size);
2049 case DB_LOCK_DEADLOCK:
2050 error(0, "getting prefs: %s", db_strerror(err));
2051 trackdb_closecursor(cursor);
2054 fatal(0, "getting prefs: %s", db_strerror(err));
2056 /* Advance to the next track before the callback so that the callback
2057 * may safely delete the track */
2058 err = cursor->c_get(cursor, &k, &d, DB_NEXT);
2059 if((cberr = callback(track, data, prefs, u, tid))) {
2064 err = cursor->c_get(cursor, &k, &d, DB_NEXT);
2068 trackdb_closecursor(cursor);
2075 case DB_LOCK_DEADLOCK:
2076 error(0, "c->c_get: %s", db_strerror(err));
2079 fatal(0, "c->c_get: %s", db_strerror(err));
2083 /* trackdb_rescan ************************************************************/
2085 /* called when the rescanner terminates */
2086 static int reap_rescan(ev_source attribute((unused)) *ev,
2089 const struct rusage attribute((unused)) *rusage,
2090 void attribute((unused)) *u) {
2091 if(pid == rescan_pid) rescan_pid = -1;
2093 error(0, RESCAN": %s", wstat(status));
2095 D((RESCAN" terminated: %s", wstat(status)));
2096 /* Our cache of file lookups is out of date now */
2097 cache_clean(&cache_files_type);
2098 eventlog("rescanned", (char *)0);
2102 /** @brief Initiate a rescan
2103 * @param ev Event loop or 0 to block
2104 * @param recheck 1 to recheck lengths, 0 to suppress check
2106 void trackdb_rescan(ev_source *ev, int recheck) {
2109 if(rescan_pid != -1) {
2110 error(0, "rescan already underway");
2113 rescan_pid = subprogram(ev, -1, RESCAN,
2114 recheck ? "--check" : "--no-check",
2117 ev_child(ev, rescan_pid, 0, reap_rescan, 0);
2118 D(("started rescanner"));
2120 /* This is the first rescan, we block until it is complete */
2121 while(waitpid(rescan_pid, &w, 0) < 0 && errno == EINTR)
2123 reap_rescan(0, rescan_pid, w, 0, 0);
2127 int trackdb_rescan_cancel(void) {
2128 if(rescan_pid == -1) return 0;
2129 if(kill(rescan_pid, SIGTERM) < 0)
2130 fatal(errno, "error killing rescanner");
2135 /* global prefs **************************************************************/
2137 void trackdb_set_global(const char *name,
2145 tid = trackdb_begin_transaction();
2146 if(!(err = trackdb_set_global_tid(name, value, tid)))
2148 trackdb_abort_transaction(tid);
2150 trackdb_commit_transaction(tid);
2151 /* log important state changes */
2152 if(!strcmp(name, "playing")) {
2153 state = !value || !strcmp(value, "yes");
2154 info("playing %s by %s",
2155 state ? "enabled" : "disabled",
2157 eventlog("state", state ? "enable_play" : "disable_play", (char *)0);
2159 if(!strcmp(name, "random-play")) {
2160 state = !value || !strcmp(value, "yes");
2161 info("random play %s by %s",
2162 state ? "enabled" : "disabled",
2164 eventlog("state", state ? "enable_random" : "disable_random", (char *)0);
2168 int trackdb_set_global_tid(const char *name,
2174 memset(&k, 0, sizeof k);
2175 memset(&d, 0, sizeof d);
2176 k.data = (void *)name;
2177 k.size = strlen(name);
2179 d.data = (void *)value;
2180 d.size = strlen(value);
2183 err = trackdb_globaldb->put(trackdb_globaldb, tid, &k, &d, 0);
2185 err = trackdb_globaldb->del(trackdb_globaldb, tid, &k, 0);
2186 if(err == DB_LOCK_DEADLOCK) return err;
2188 fatal(0, "error updating database: %s", db_strerror(err));
2192 const char *trackdb_get_global(const char *name) {
2198 tid = trackdb_begin_transaction();
2199 if(!(err = trackdb_get_global_tid(name, tid, &r)))
2201 trackdb_abort_transaction(tid);
2203 trackdb_commit_transaction(tid);
2207 int trackdb_get_global_tid(const char *name,
2213 memset(&k, 0, sizeof k);
2214 k.data = (void *)name;
2215 k.size = strlen(name);
2216 switch(err = trackdb_globaldb->get(trackdb_globaldb, tid, &k,
2217 prepare_data(&d), 0)) {
2219 *rp = xstrndup(d.data, d.size);
2224 case DB_LOCK_DEADLOCK:
2227 fatal(0, "error reading database: %s", db_strerror(err));
2231 /** @brief Retrieve the most recently added tracks
2232 * @param ntracksp Where to put count, or 0
2233 * @param maxtracks Maximum number of tracks to retrieve
2234 * @return null-terminated array of track names
2236 * The most recently added track is first in the array.
2238 char **trackdb_new(int *ntracksp,
2244 tid = trackdb_begin_transaction();
2245 tracks = trackdb_new_tid(ntracksp, maxtracks, tid);
2248 trackdb_abort_transaction(tid);
2250 trackdb_commit_transaction(tid);
2254 /** @brief Retrieve the most recently added tracks
2255 * @param ntracksp Where to put count, or 0
2256 * @param maxtracks Maximum number of tracks to retrieve, or 0 for all
2257 * @param tid Transaction ID
2258 * @return null-terminated array of track names, or NULL on deadlock
2260 * The most recently added track is first in the array.
2262 static char **trackdb_new_tid(int *ntracksp,
2268 struct vector tracks[1];
2270 vector_init(tracks);
2271 c = trackdb_opencursor(trackdb_noticeddb, tid);
2272 while((maxtracks <= 0 || tracks->nvec < maxtracks)
2273 && !(err = c->c_get(c, prepare_data(&k), prepare_data(&d), DB_PREV)))
2274 vector_append(tracks, xstrndup(d.data, d.size));
2276 case 0: /* hit maxtracks */
2277 case DB_NOTFOUND: /* ran out of tracks */
2279 case DB_LOCK_DEADLOCK:
2280 trackdb_closecursor(c);
2283 fatal(0, "error reading noticed.db: %s", db_strerror(err));
2285 if((err = trackdb_closecursor(c)))
2286 return 0; /* deadlock */
2287 vector_terminate(tracks);
2289 *ntracksp = tracks->nvec;
2293 /** @brief Expire noticed.db
2294 * @param earliest Earliest timestamp to keep
2296 void trackdb_expire_noticed(time_t earliest) {
2300 tid = trackdb_begin_transaction();
2301 if(!trackdb_expire_noticed_tid(earliest, tid))
2303 trackdb_abort_transaction(tid);
2305 trackdb_commit_transaction(tid);
2308 /** @brief Expire noticed.db
2309 * @param earliest Earliest timestamp to keep
2310 * @param tid Transaction ID
2311 * @return 0 or DB_LOCK_DEADLOCK
2313 static int trackdb_expire_noticed_tid(time_t earliest, DB_TXN *tid) {
2321 c = trackdb_opencursor(trackdb_noticeddb, tid);
2322 while(!(err = c->c_get(c, prepare_data(&k), prepare_data(&d), DB_NEXT))) {
2324 when = (time_t)(((uint64_t)ntohl(kk[0]) << 32) + ntohl(kk[1]));
2325 if(when >= earliest)
2327 if((err = c->c_del(c, 0))) {
2328 if(err != DB_LOCK_DEADLOCK)
2329 fatal(0, "error deleting expired noticed.db entry: %s",
2335 if(err == DB_NOTFOUND)
2337 if(err && err != DB_LOCK_DEADLOCK)
2338 fatal(0, "error expiring noticed.db: %s", db_strerror(err));
2340 if((err = trackdb_closecursor(c))) {
2341 if(err != DB_LOCK_DEADLOCK)
2342 fatal(0, "error closing cursor: %s", db_strerror(err));
2346 info("expired %d tracks from noticed.db", count);
2350 /* tidying up ****************************************************************/
2352 void trackdb_gc(void) {
2356 if((err = trackdb_env->txn_checkpoint(trackdb_env,
2357 config->checkpoint_kbyte,
2358 config->checkpoint_min,
2360 fatal(0, "trackdb_env->txn_checkpoint: %s", db_strerror(err));
2361 if((err = trackdb_env->log_archive(trackdb_env, &logfiles, DB_ARCH_REMOVE)))
2362 fatal(0, "trackdb_env->log_archive: %s", db_strerror(err));
2363 /* This makes catastrophic recovery impossible. However, the user can still
2364 * preserve the important data by using disorder-dump to snapshot their
2365 * prefs, and later to restore it. This is likely to have much small
2366 * long-term storage requirements than record the db logfiles. */
2369 /* user database *************************************************************/
2371 /** @brief Return true if @p user is trusted */
2372 static int trusted(const char *user) {
2375 for(n = 0; (n < config->trust.n
2376 && strcmp(config->trust.s[n], user)); ++n)
2378 return n < config->trust.n;
2381 /** @brief Return non-zero for a valid username
2383 * Currently we only allow the letters and digits in ASCII. We could be more
2384 * liberal than this but it is a nice simple test. It is critical that
2385 * semicolons are never allowed.
2387 static int valid_username(const char *user) {
2391 const uint8_t c = *user++;
2392 /* For now we are very strict */
2393 if((c >= 'a' && c <= 'z')
2394 || (c >= 'A' && c <= 'Z')
2395 || (c >= '0' && c <= '9'))
2403 /** @brief Add a user */
2404 static int create_user(const char *user,
2405 const char *password,
2408 const char *confirmation,
2414 /* sanity check user */
2415 if(!valid_username(user)) {
2416 error(0, "invalid username '%s'", user);
2419 if(parse_rights(rights, 0, 1)) {
2420 error(0, "invalid rights string");
2423 /* data for this user */
2425 kvp_set(&k, "password", password);
2426 kvp_set(&k, "rights", rights);
2428 kvp_set(&k, "email", email);
2430 kvp_set(&k, "confirmation", confirmation);
2431 snprintf(s, sizeof s, "%jd", (intmax_t)time(0));
2432 kvp_set(&k, "created", s);
2433 return trackdb_putdata(trackdb_usersdb, user, k, tid, flags);
2436 /** @brief Add one pre-existing user */
2437 static int one_old_user(const char *user, const char *password,
2441 /* www-data doesn't get added */
2442 if(!strcmp(user, "www-data")) {
2443 info("not adding www-data to user database");
2447 if(!strcmp(user, "root"))
2449 else if(trusted(user)) {
2452 parse_rights(config->default_rights, &r, 1);
2453 r &= ~(rights_type)(RIGHT_SCRATCH__MASK|RIGHT_MOVE__MASK|RIGHT_REMOVE__MASK);
2454 r |= (RIGHT_ADMIN|RIGHT_RESCAN
2455 |RIGHT_SCRATCH_ANY|RIGHT_MOVE_ANY|RIGHT_REMOVE_ANY);
2456 rights = rights_string(r);
2458 rights = config->default_rights;
2459 return create_user(user, password, rights, 0/*email*/, 0/*confirmation*/,
2460 tid, DB_NOOVERWRITE);
2463 static int trackdb_old_users_tid(DB_TXN *tid) {
2466 for(n = 0; n < config->allow.n; ++n) {
2467 switch(one_old_user(config->allow.s[n].s[0], config->allow.s[n].s[1],
2470 info("created user %s from 'allow' directive", config->allow.s[n].s[0]);
2473 error(0, "user %s already exists, delete 'allow' directive",
2474 config->allow.s[n].s[0]);
2475 /* This won't ever become fatal - eventually 'allow' will be
2478 case DB_LOCK_DEADLOCK:
2479 return DB_LOCK_DEADLOCK;
2485 /** @brief Read old 'allow' directives and copy them to the users database */
2486 void trackdb_old_users(void) {
2490 WITH_TRANSACTION(trackdb_old_users_tid(tid));
2493 /** @brief Create a root user in the user database if there is none */
2494 void trackdb_create_root(void) {
2499 /* Choose a new root password */
2500 gcry_randomize(pwbin, sizeof pwbin, GCRY_STRONG_RANDOM);
2501 pw = mime_to_base64(pwbin, sizeof pwbin);
2502 /* Create the root user if it does not exist */
2503 WITH_TRANSACTION(create_user("root", pw, "all",
2504 0/*email*/, 0/*confirmation*/,
2505 tid, DB_NOOVERWRITE));
2507 info("created root user");
2510 /** @brief Find a user's password from the database
2511 * @param user Username
2512 * @return Password or NULL
2514 * Only works if running as a user that can read the database!
2516 * If the user exists but has no password, "" is returned.
2518 const char *trackdb_get_password(const char *user) {
2521 const char *password;
2523 WITH_TRANSACTION(trackdb_getdata(trackdb_usersdb, user, &k, tid));
2526 password = kvp_get(k, "password");
2527 return password ? password : "";
2530 /** @brief Add a new user
2531 * @param user Username
2532 * @param password Password or NULL
2533 * @param rights Initial rights
2534 * @param email Email address or NULL
2535 * @param confirmation Confirmation string or NULL
2536 * @return 0 on success, non-0 on error
2538 int trackdb_adduser(const char *user,
2539 const char *password,
2542 const char *confirmation) {
2545 WITH_TRANSACTION(create_user(user, password, rights, email, confirmation,
2546 tid, DB_NOOVERWRITE));
2548 error(0, "cannot create user '%s' because they already exist", user);
2552 info("created user '%s' with rights '%s' and email address '%s'",
2553 user, rights, email);
2555 info("created user '%s' with rights '%s'", user, rights);
2560 /** @brief Delete a user
2561 * @param user User to delete
2562 * @return 0 on success, non-0 if the user didn't exist anyway
2564 int trackdb_deluser(const char *user) {
2567 WITH_TRANSACTION(trackdb_delkey(trackdb_usersdb, user, tid));
2569 error(0, "cannot delete user '%s' because they do not exist", user);
2572 info("deleted user '%s'", user);
2576 /** @brief Get user information
2577 * @param user User to query
2578 * @return Linked list of user information or NULL if user does not exist
2580 * Every user has at least a @c rights entry so NULL can be used to mean no
2583 struct kvp *trackdb_getuserinfo(const char *user) {
2587 WITH_TRANSACTION(trackdb_getdata(trackdb_usersdb, user, &k, tid));
2594 /** @brief Edit user information
2595 * @param user User to edit
2596 * @param key Key to change
2597 * @param value Value to set, or NULL to remove
2598 * @param tid Transaction ID
2599 * @return 0, DB_LOCK_DEADLOCK or DB_NOTFOUND
2601 static int trackdb_edituserinfo_tid(const char *user, const char *key,
2602 const char *value, DB_TXN *tid) {
2606 if((e = trackdb_getdata(trackdb_usersdb, user, &k, tid)))
2608 if(!kvp_set(&k, key, value))
2609 return 0; /* no change */
2610 return trackdb_putdata(trackdb_usersdb, user, k, tid, 0);
2613 /** @brief Edit user information
2614 * @param user User to edit
2615 * @param key Key to change
2616 * @param value Value to set, or NULL to remove
2617 * @return 0 on success, non-0 on error
2619 int trackdb_edituserinfo(const char *user,
2620 const char *key, const char *value) {
2623 if(!strcmp(key, "rights")) {
2625 error(0, "cannot remove 'rights' key from user '%s'", user);
2628 if(parse_rights(value, 0, 1)) {
2629 error(0, "invalid rights string");
2632 } else if(!strcmp(key, "email")) {
2634 if(!strchr(value, '@')) {
2635 error(0, "invalid email address '%s' for user '%s'", user, value);
2639 value = 0; /* no email -> remove key */
2640 } else if(!strcmp(key, "created")) {
2641 error(0, "cannot change creation date for user '%s'", user);
2643 } else if(strcmp(key, "password")
2644 && !strcmp(key, "confirmation")) {
2645 error(0, "unknown user info key '%s' for user '%s'", key, user);
2648 WITH_TRANSACTION(trackdb_edituserinfo_tid(user, key, value, tid));
2650 error(0, "unknown user '%s'", user);
2656 /** @brief List all users
2657 * @return NULL-terminated list of users
2659 char **trackdb_listusers(void) {
2664 WITH_TRANSACTION(trackdb_listkeys(trackdb_usersdb, v, tid));
2668 /** @brief Confirm a user registration
2669 * @param user Username
2670 * @param confirmation Confirmation string
2671 * @param rightsp Where to put user rights
2672 * @param tid Transaction ID
2673 * @return 0 on success, non-0 on error
2675 static int trackdb_confirm_tid(const char *user, const char *confirmation,
2676 rights_type *rightsp,
2678 const char *stored_confirmation;
2683 if((e = trackdb_getdata(trackdb_usersdb, user, &k, tid)))
2685 if(!(stored_confirmation = kvp_get(k, "confirmation"))) {
2686 error(0, "already confirmed user '%s'", user);
2687 /* DB claims -30,800 to -30,999 so -1 should be a safe bet */
2690 if(!(rights = kvp_get(k, "rights"))) {
2691 error(0, "no rights for unconfirmed user '%s'", user);
2694 if(parse_rights(rights, rightsp, 1))
2696 if(strcmp(confirmation, stored_confirmation)) {
2697 error(0, "wrong confirmation string for user '%s'", user);
2701 kvp_set(&k, "confirmation", 0);
2702 return trackdb_putdata(trackdb_usersdb, user, k, tid, 0);
2705 /** @brief Confirm a user registration
2706 * @param user Username
2707 * @param confirmation Confirmation string
2708 * @param rightsp Where to put user rights
2709 * @return 0 on success, non-0 on error
2711 int trackdb_confirm(const char *user, const char *confirmation,
2712 rights_type *rightsp) {
2715 WITH_TRANSACTION(trackdb_confirm_tid(user, confirmation, rightsp, tid));
2718 info("registration confirmed for user '%s'", user);
2721 error(0, "confirmation for nonexistent user '%s'", user);
2723 default: /* already reported */
2733 indent-tabs-mode:nil