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 /* tracks matched by required_tags */
160 static char **reqtracks;
161 static size_t nreqtracks;
163 /* comparison function for keys */
164 static int compare(DB attribute((unused)) *db_,
165 const DBT *a, const DBT *b) {
166 return compare_path_raw(a->data, a->size, b->data, b->size);
169 /** @brief Open database environment
170 * @param flags Flags word
172 * Flags should be one of:
173 * - @ref TRACKDB_NO_RECOVER
174 * - @ref TRACKDB_NORMAL_RECOVER
175 * - @ref TRACKDB_FATAL_RECOVER
176 * - @ref TRACKDB_MAY_CREATE
178 void trackdb_init(int flags) {
180 const int recover = flags & TRACKDB_RECOVER_MASK;
181 static int recover_type[] = { 0, DB_RECOVER, DB_RECOVER_FATAL };
184 assert(initialized == 0);
187 if(strcmp(home, config->home))
188 fatal(0, "cannot change db home without server restart");
192 if(flags & TRACKDB_MAY_CREATE) {
198 /* Remove world/group permissions on any regular files already in the
199 * database directory. Actually we don't care about all of them but it's
200 * easier to just do the lot. This can be revisited if it's a serious
201 * practical inconvenience for anyone.
203 * The socket, not being a regular file, is excepted.
205 if(!(dp = opendir(config->home)))
206 fatal(errno, "error reading %s", config->home);
207 while((de = readdir(dp))) {
208 byte_xasprintf(&p, "%s/%s", config->home, de->d_name);
209 if(lstat(p, &st) == 0
210 && S_ISREG(st.st_mode)
211 && (st.st_mode & 077)) {
212 if(chmod(p, st.st_mode & 07700) < 0)
213 fatal(errno, "cannot chmod %s", p);
220 /* create environment */
221 if((err = db_env_create(&trackdb_env, 0))) fatal(0, "db_env_create: %s",
223 if((err = trackdb_env->set_alloc(trackdb_env,
224 xmalloc_noptr, xrealloc_noptr, xfree)))
225 fatal(0, "trackdb_env->set_alloc: %s", db_strerror(err));
226 if((err = trackdb_env->set_lk_max_locks(trackdb_env, 10000)))
227 fatal(0, "trackdb_env->set_lk_max_locks: %s", db_strerror(err));
228 if((err = trackdb_env->set_lk_max_objects(trackdb_env, 10000)))
229 fatal(0, "trackdb_env->set_lk_max_objects: %s", db_strerror(err));
230 if((err = trackdb_env->open(trackdb_env, config->home,
236 |recover_type[recover],
238 fatal(0, "trackdb_env->open %s: %s", config->home, db_strerror(err));
239 trackdb_env->set_errpfx(trackdb_env, "DB");
240 trackdb_env->set_errfile(trackdb_env, stderr);
241 trackdb_env->set_verbose(trackdb_env, DB_VERB_DEADLOCK, 1);
242 trackdb_env->set_verbose(trackdb_env, DB_VERB_RECOVERY, 1);
243 trackdb_env->set_verbose(trackdb_env, DB_VERB_REPLICATION, 1);
244 D(("initialized database environment"));
247 /* called when deadlock manager terminates */
248 static int reap_db_deadlock(ev_source attribute((unused)) *ev,
249 pid_t attribute((unused)) pid,
251 const struct rusage attribute((unused)) *rusage,
252 void attribute((unused)) *u) {
253 db_deadlock_pid = -1;
255 fatal(0, "deadlock manager unexpectedly terminated: %s",
258 D(("deadlock manager terminated: %s", wstat(status)));
262 static pid_t subprogram(ev_source *ev, int outputfd, const char *prog,
266 const char *args[1024], **argp, *a;
270 *argp++ = "--config";
271 *argp++ = configfile;
272 *argp++ = debugging ? "--debug" : "--no-debug";
273 *argp++ = log_default == &log_syslog ? "--syslog" : "--no-syslog";
275 while((a = va_arg(ap, const char *)))
279 /* If we're in the background then trap subprocess stdout/stderr */
280 if(!(pid = xfork())) {
283 ev_signal_atfork(ev);
284 signal(SIGPIPE, SIG_DFL);
289 /* ensure we don't leak privilege anywhere */
290 if(setuid(geteuid()) < 0)
291 fatal(errno, "error calling setuid");
292 /* If we were negatively niced, undo it. We don't bother checking for
293 * error, it's not that important. */
294 setpriority(PRIO_PROCESS, 0, 0);
295 execvp(prog, (char **)args);
296 fatal(errno, "error invoking %s", prog);
301 /* start deadlock manager */
302 void trackdb_master(ev_source *ev) {
303 assert(db_deadlock_pid == -1);
304 db_deadlock_pid = subprogram(ev, -1, DEADLOCK, (char *)0);
305 ev_child(ev, db_deadlock_pid, 0, reap_db_deadlock, 0);
306 D(("started deadlock manager"));
309 /* close environment */
310 void trackdb_deinit(void) {
314 assert(initialized == 1);
317 /* close the environment */
318 if((err = trackdb_env->close(trackdb_env, 0)))
319 fatal(0, "trackdb_env->close: %s", db_strerror(err));
321 if(rescan_pid != -1) {
322 /* shut down the rescanner */
323 if(kill(rescan_pid, SIGTERM) < 0)
324 fatal(errno, "error killing rescanner");
325 /* wait for the rescanner to finish */
326 while(waitpid(rescan_pid, &err, 0) == -1 && errno == EINTR)
330 /* TODO kill any stats subprocesses */
332 /* finally terminate the deadlock manager */
333 if(db_deadlock_pid != -1 && kill(db_deadlock_pid, SIGTERM) < 0)
334 fatal(errno, "error killing deadlock manager");
335 db_deadlock_pid = -1;
337 D(("deinitialized database environment"));
340 /* open a specific database */
341 static DB *open_db(const char *path,
349 D(("open %s", path));
350 path = config_get_file(path);
351 if((err = db_create(&db, trackdb_env, 0)))
352 fatal(0, "db_create %s: %s", path, db_strerror(err));
354 if((err = db->set_flags(db, dbflags)))
355 fatal(0, "db->set_flags %s: %s", path, db_strerror(err));
356 if(dbtype == DB_BTREE)
357 if((err = db->set_bt_compare(db, compare)))
358 fatal(0, "db->set_bt_compare %s: %s", path, db_strerror(err));
359 if((err = db->open(db, 0, path, 0, dbtype,
360 openflags | DB_AUTO_COMMIT, mode))) {
361 if((openflags & DB_CREATE) || errno != ENOENT)
362 fatal(0, "db->open %s: %s", path, db_strerror(err));
369 /** @brief Open track databases
370 * @param flags Flags flags word
372 * @p flags should have one of:
373 * - @p TRACKDB_NO_UPGRADE, if no upgrade should be attempted
374 * - @p TRACKDB_CAN_UPGRADE, if an upgrade may be attempted
375 * - @p TRACKDB_OPEN_FOR_UPGRADE, if this is disorder-dbupgrade
377 * - @p TRACKDB_READ_ONLY, read only access
379 void trackdb_open(int flags) {
382 uint32_t dbflags = flags & TRACKDB_READ_ONLY ? DB_RDONLY : DB_CREATE;
387 /* check the database version first */
388 trackdb_globaldb = open_db("global.db", 0, DB_HASH, DB_RDONLY, 0666);
389 if(trackdb_globaldb) {
390 /* This is an existing database */
394 s = trackdb_get_global("_dbversion");
395 /* Close the database again, we'll open it property below */
396 if((err = trackdb_globaldb->close(trackdb_globaldb, 0)))
397 fatal(0, "error closing global.db: %s", db_strerror(err));
398 trackdb_globaldb = 0;
399 /* Convert version string to an integer */
400 oldversion = s ? atol(s) : 1;
401 if(oldversion > config->dbversion) {
402 /* Database is from the future; we never allow this. */
403 fatal(0, "this version of DisOrder is too old for database version %ld",
406 if(oldversion < config->dbversion) {
407 /* Database version is out of date */
408 switch(flags & TRACKDB_UPGRADE_MASK) {
409 case TRACKDB_NO_UPGRADE:
410 /* This database needs upgrading but this is not permitted */
411 fatal(0, "database needs upgrading from %ld to %ld",
412 oldversion, config->dbversion);
413 case TRACKDB_CAN_UPGRADE:
414 /* This database needs upgrading */
415 info("invoking disorder-dbupgrade to upgrade from %ld to %ld",
416 oldversion, config->dbversion);
417 pid = subprogram(0, -1, "disorder-dbupgrade", (char *)0);
418 while(waitpid(pid, &err, 0) == -1 && errno == EINTR)
421 fatal(0, "disorder-dbupgrade %s", wstat(err));
422 info("disorder-dbupgrade succeeded");
424 case TRACKDB_OPEN_FOR_UPGRADE:
430 if(oldversion == config->dbversion && (flags & TRACKDB_OPEN_FOR_UPGRADE)) {
431 /* This doesn't make any sense */
432 fatal(0, "database is already at current version");
434 trackdb_existing_database = 1;
436 if(flags & TRACKDB_OPEN_FOR_UPGRADE) {
437 /* Cannot upgrade a new database */
438 fatal(0, "cannot upgrade a database that does not exist");
440 /* This is a brand new database */
441 trackdb_existing_database = 0;
443 /* open the databases */
444 if(!(trackdb_usersdb = open_db("users.db",
445 0, DB_HASH, dbflags, 0600)))
446 fatal(0, "cannot open users.db");
447 trackdb_tracksdb = open_db("tracks.db",
448 DB_RECNUM, DB_BTREE, dbflags, 0666);
449 trackdb_searchdb = open_db("search.db",
450 DB_DUP|DB_DUPSORT, DB_HASH, dbflags, 0666);
451 trackdb_tagsdb = open_db("tags.db",
452 DB_DUP|DB_DUPSORT, DB_HASH, dbflags, 0666);
453 trackdb_prefsdb = open_db("prefs.db", 0, DB_HASH, dbflags, 0666);
454 trackdb_globaldb = open_db("global.db", 0, DB_HASH, dbflags, 0666);
455 trackdb_noticeddb = open_db("noticed.db",
456 DB_DUPSORT, DB_BTREE, dbflags, 0666);
457 if(!trackdb_existing_database) {
458 /* Stash the database version */
461 assert(!(flags & TRACKDB_OPEN_FOR_UPGRADE));
462 snprintf(buf, sizeof buf, "%ld", config->dbversion);
463 trackdb_set_global("_dbversion", buf, 0);
465 D(("opened databases"));
468 /* close track databases */
469 void trackdb_close(void) {
475 if((err = trackdb_tracksdb->close(trackdb_tracksdb, 0)))
476 fatal(0, "error closing tracks.db: %s", db_strerror(err));
477 if((err = trackdb_searchdb->close(trackdb_searchdb, 0)))
478 fatal(0, "error closing search.db: %s", db_strerror(err));
479 if((err = trackdb_tagsdb->close(trackdb_tagsdb, 0)))
480 fatal(0, "error closing tags.db: %s", db_strerror(err));
481 if((err = trackdb_prefsdb->close(trackdb_prefsdb, 0)))
482 fatal(0, "error closing prefs.db: %s", db_strerror(err));
483 if((err = trackdb_globaldb->close(trackdb_globaldb, 0)))
484 fatal(0, "error closing global.db: %s", db_strerror(err));
485 if((err = trackdb_noticeddb->close(trackdb_noticeddb, 0)))
486 fatal(0, "error closing noticed.db: %s", db_strerror(err));
487 if((err = trackdb_usersdb->close(trackdb_usersdb, 0)))
488 fatal(0, "error closing users.db: %s", db_strerror(err));
489 trackdb_tracksdb = trackdb_searchdb = trackdb_prefsdb = 0;
490 trackdb_tagsdb = trackdb_globaldb = 0;
491 D(("closed databases"));
494 /* generic db routines *******************************************************/
496 /* fetch and decode a database entry. Returns 0, DB_NOTFOUND or
497 * DB_LOCK_DEADLOCK. */
498 int trackdb_getdata(DB *db,
505 switch(err = db->get(db, tid, make_key(&key, track),
506 prepare_data(&data), 0)) {
508 *kp = kvp_urldecode(data.data, data.size);
513 case DB_LOCK_DEADLOCK:
514 error(0, "error querying database: %s", db_strerror(err));
517 fatal(0, "error querying database: %s", db_strerror(err));
521 /* encode and store a database entry. Returns 0, DB_KEYEXIST or
522 * DB_LOCK_DEADLOCK. */
523 int trackdb_putdata(DB *db,
531 switch(err = db->put(db, tid, make_key(&key, track),
532 encode_data(&data, k), flags)) {
536 case DB_LOCK_DEADLOCK:
537 error(0, "error updating database: %s", db_strerror(err));
540 fatal(0, "error updating database: %s", db_strerror(err));
544 /** @brief Delete a database entry
546 * @param track Key to delete
547 * @param tid Transaction ID
548 * @return 0, DB_NOTFOUND or DB_LOCK_DEADLOCK
550 int trackdb_delkey(DB *db,
556 switch(err = db->del(db, tid, make_key(&key, track), 0)) {
560 case DB_LOCK_DEADLOCK:
561 error(0, "error updating database: %s", db_strerror(err));
564 fatal(0, "error updating database: %s", db_strerror(err));
568 /* open a database cursor */
569 DBC *trackdb_opencursor(DB *db, DB_TXN *tid) {
573 switch(err = db->cursor(db, tid, &c, 0)) {
575 default: fatal(0, "error creating cursor: %s", db_strerror(err));
580 /* close a database cursor; returns 0 or DB_LOCK_DEADLOCK */
581 int trackdb_closecursor(DBC *c) {
585 switch(err = c->c_close(c)) {
588 case DB_LOCK_DEADLOCK:
589 error(0, "error closing cursor: %s", db_strerror(err));
592 fatal(0, "error closing cursor: %s", db_strerror(err));
596 /* delete a (key,data) pair. Returns 0, DB_NOTFOUND or DB_LOCK_DEADLOCK. */
597 int trackdb_delkeydata(DB *db,
605 c = trackdb_opencursor(db, tid);
606 switch(err = c->c_get(c, make_key(&key, word),
607 make_key(&data, track), DB_GET_BOTH)) {
609 switch(err = c->c_del(c, 0)) {
615 case DB_LOCK_DEADLOCK:
616 error(0, "error updating database: %s", db_strerror(err));
619 fatal(0, "c->c_del: %s", db_strerror(err));
624 case DB_LOCK_DEADLOCK:
625 error(0, "error updating database: %s", db_strerror(err));
628 fatal(0, "c->c_get: %s", db_strerror(err));
630 if(trackdb_closecursor(c)) err = DB_LOCK_DEADLOCK;
634 /* start a transaction */
635 DB_TXN *trackdb_begin_transaction(void) {
639 if((err = trackdb_env->txn_begin(trackdb_env, 0, &tid, 0)))
640 fatal(0, "trackdb_env->txn_begin: %s", db_strerror(err));
644 /* abort transaction */
645 void trackdb_abort_transaction(DB_TXN *tid) {
649 if((err = tid->abort(tid)))
650 fatal(0, "tid->abort: %s", db_strerror(err));
653 /* commit transaction */
654 void trackdb_commit_transaction(DB_TXN *tid) {
657 if((err = tid->commit(tid, 0)))
658 fatal(0, "tid->commit: %s", db_strerror(err));
661 /* search/tags shared code ***************************************************/
663 /* comparison function used by dedupe() */
664 static int wordcmp(const void *a, const void *b) {
665 return strcmp(*(const char **)a, *(const char **)b);
668 /* sort and de-dupe VEC */
669 static char **dedupe(char **vec, int nvec) {
672 qsort(vec, nvec, sizeof (char *), wordcmp);
676 for(n = 1; n < nvec; ++n)
677 if(strcmp(vec[n], vec[m - 1]))
684 /* update a key/track database. Returns 0 or DB_DEADLOCK. */
685 static int register_word(DB *db, const char *what,
686 const char *track, const char *word,
691 switch(err = db->put(db, tid, make_key(&key, word),
692 make_key(&data, track), DB_NODUPDATA)) {
696 case DB_LOCK_DEADLOCK:
697 error(0, "error updating %s.db: %s", what, db_strerror(err));
700 fatal(0, "error updating %s.db: %s", what, db_strerror(err));
704 /* search primitives *********************************************************/
706 /* return true iff NAME is a trackname_display_ pref */
707 static int is_display_pref(const char *name) {
708 static const char prefix[] = "trackname_display_";
709 return !strncmp(name, prefix, (sizeof prefix) - 1);
712 /** @brief Word_Break property tailor that treats underscores as spaces */
713 static int tailor_underscore_Word_Break_Other(uint32_t c) {
717 case 0x005F: /* LOW LINE (SPACING UNDERSCORE) */
718 return unicode_Word_Break_Other;
722 /** @brief Remove all combining characters in-place
723 * @param s Pointer to start of string
724 * @param ns Length of string
725 * @return New, possiblby reduced, length
727 static size_t remove_combining_chars(uint32_t *s, size_t ns) {
728 uint32_t *start = s, *t = s, *end = s + ns;
731 const uint32_t c = *s++;
732 if(!utf32_combining_class(c))
738 /** @brief Normalize and split a string using a given tailoring */
739 static void word_split(struct vector *v,
741 unicode_property_tailor *pt) {
743 uint32_t *t32, **w32;
745 /* Convert to UTF-32 */
746 if(!(t32 = utf8_to_utf32(s, strlen(s), &nt32)))
748 /* Erase case distinctions */
749 if(!(t32 = utf32_casefold_compat(t32, nt32, &nt32)))
751 /* Drop combining characters */
752 nt32 = remove_combining_chars(t32, nt32);
753 /* Split into words, treating _ as a space */
754 w32 = utf32_word_split(t32, nt32, &nw, pt);
755 /* Convert words back to UTF-8 and append to result */
756 for(i = 0; i < nw; ++i)
757 vector_append(v, utf32_to_utf8(w32[i], utf32_len(w32[i]), 0));
760 /** @brief Normalize a tag
762 * @param ns Length of tag
763 * @return Normalized string or NULL on error
765 * The return value will be:
767 * - have no leading or trailing space
768 * - have no combining characters
769 * - all spacing between words will be a single U+0020 SPACE
771 static char *normalize_tag(const char *s, size_t ns) {
772 uint32_t *s32, **w32;
773 size_t ns32, nw32, i;
776 if(!(s32 = utf8_to_utf32(s, ns, &ns32)))
778 if(!(s32 = utf32_casefold_compat(s32, ns32, &ns32))) /* ->NFKD */
780 ns32 = remove_combining_chars(s32, ns32);
781 /* Split into words, no Word_Break tailoring */
782 w32 = utf32_word_split(s32, ns32, &nw32, 0);
783 /* Compose back into a string */
785 for(i = 0; i < nw32; ++i) {
787 dynstr_append(d, ' ');
788 dynstr_append_string(d, utf32_to_utf8(w32[i], utf32_len(w32[i]), 0));
794 /* compute the words of a track name */
795 static char **track_to_words(const char *track,
796 const struct kvp *p) {
798 const char *rootless = track_rootless(track);
801 rootless = track; /* bodge */
803 rootless = strip_extension(rootless);
804 word_split(&v, strip_extension(rootless), tailor_underscore_Word_Break_Other);
805 for(; p; p = p->next)
806 if(is_display_pref(p->name))
807 word_split(&v, p->value, 0);
808 vector_terminate(&v);
809 return dedupe(v.vec, v.nvec);
812 /* return nonzero iff WORD is a stopword */
813 static int stopword(const char *word) {
816 for(n = 0; n < config->stopword.n
817 && strcmp(word, config->stopword.s[n]); ++n)
819 return n < config->stopword.n;
822 /* record that WORD appears in TRACK. Returns 0 or DB_LOCK_DEADLOCK. */
823 static int register_search_word(const char *track, const char *word,
825 if(stopword(word)) return 0;
826 return register_word(trackdb_searchdb, "search", track, word, tid);
829 /* Tags **********************************************************************/
831 /* Return nonzero if C is a valid tag character */
832 static int tagchar(int c) {
841 /* Parse and de-dupe a tag list. If S=0 then assumes "". */
842 static char **parsetags(const char *s) {
848 /* skip initial separators */
849 while(*s && (!tagchar(*s) || *s == ' '))
852 /* find the extent of the tag */
854 while(*s && tagchar(*s))
856 /* strip trailing spaces */
857 while(s > t && s[-1] == ' ')
859 /* add tag to list */
860 vector_append(&v, normalize_tag(t, (size_t)(s - t)));
861 /* skip intermediate and trailing separators */
862 while(*s && (!tagchar(*s) || *s == ' '))
866 vector_terminate(&v);
867 return dedupe(v.vec, v.nvec);
870 /* Record that TRACK has TAG. Returns 0 or DB_LOCK_DEADLOCK. */
871 static int register_tag(const char *track, const char *tag, DB_TXN *tid) {
872 return register_word(trackdb_tagsdb, "tags", track, tag, tid);
875 /* aliases *******************************************************************/
877 /* compute the alias and store at aliasp. Returns 0 or DB_LOCK_DEADLOCK. If
878 * there is no alias sets *aliasp to 0. */
879 static int compute_alias(char **aliasp,
884 const char *s = config->alias, *t, *expansion, *part;
885 int c, used_db = 0, slash_prefix, err;
887 const char *const root = find_track_root(track);
890 /* Bodge for tracks with no root */
895 dynstr_append_string(&d, root);
896 while((c = (unsigned char)*s++)) {
898 dynstr_append(&d, c);
901 if((slash_prefix = (*s == '/')))
904 assert(t != 0); /* validated at startup */
905 part = xstrndup(s, t - s);
906 expansion = getpart(track, "display", part, p, &used_db);
908 if(slash_prefix) dynstr_append(&d, '/');
909 dynstr_append_string(&d, expansion);
911 s = t + 1; /* skip {part} */
913 /* only admit to the alias if we used the db... */
918 dynstr_terminate(&d);
919 /* ...and the answer differs from the original... */
920 if(!strcmp(track, d.vec)) {
924 /* ...and there isn't already a different track with that name (including as
926 switch(err = trackdb_getdata(trackdb_tracksdb, d.vec, &at, tid)) {
928 if((s = kvp_get(at, "_alias_for"))
929 && !strcmp(s, track)) {
941 /* get track and prefs data (if tp/pp not null pointers). Returns 0 on
942 * success, DB_NOTFOUND if the track does not exist or DB_LOCK_DEADLOCK.
943 * Always sets the return values, even if only to null pointers. */
944 static int gettrackdata(const char *track,
947 const char **actualp,
949 #define GTD_NOALIAS 0x0001
952 const char *actual = track;
953 struct kvp *t = 0, *p = 0;
955 if((err = trackdb_getdata(trackdb_tracksdb, track, &t, tid))) goto done;
956 if((actual = kvp_get(t, "_alias_for"))) {
957 if(flags & GTD_NOALIAS) {
958 error(0, "alias passed to gettrackdata where real path required");
961 if((err = trackdb_getdata(trackdb_tracksdb, actual, &t, tid))) goto done;
966 if((err = trackdb_getdata(trackdb_prefsdb, actual, &p, tid)) == DB_LOCK_DEADLOCK)
971 if(actualp) *actualp = actual;
977 /* trackdb_notice() **********************************************************/
979 /** @brief notice a possibly new track
980 * @return @c DB_NOTFOUND if new, 0 if already known
982 int trackdb_notice(const char *track,
988 tid = trackdb_begin_transaction();
989 err = trackdb_notice_tid(track, path, tid);
990 if((err == DB_LOCK_DEADLOCK)) goto fail;
993 trackdb_abort_transaction(tid);
995 trackdb_commit_transaction(tid);
999 /** @brief notice a possibly new track
1000 * @param track NFC UTF-8 track name
1001 * @param path Raw path name
1002 * @param tid Transaction ID
1003 * @return @c DB_NOTFOUND if new, 0 if already known, @c DB_LOCK_DEADLOCK also
1005 int trackdb_notice_tid(const char *track,
1009 struct kvp *t, *a, *p;
1013 /* notice whether the tracks.db entry changes */
1015 /* get any existing tracks entry */
1016 if((err = gettrackdata(track, &t, &p, 0, 0, tid)) == DB_LOCK_DEADLOCK)
1018 ret = err; /* 0 or DB_NOTFOUND */
1019 /* this is a real track */
1020 t_changed += kvp_set(&t, "_alias_for", 0);
1021 t_changed += kvp_set(&t, "_path", path);
1022 /* if we have an alias record it in the database */
1023 if((err = compute_alias(&alias, track, p, tid))) return err;
1025 /* won't overwrite someone else's alias as compute_alias() checks */
1026 D(("%s: alias %s", track, alias));
1028 kvp_set(&a, "_alias_for", track);
1029 if((err = trackdb_putdata(trackdb_tracksdb, alias, a, tid, 0))) return err;
1031 /* update search.db */
1032 w = track_to_words(track, p);
1033 for(n = 0; w[n]; ++n)
1034 if((err = register_search_word(track, w[n], tid)))
1036 /* update tags.db */
1037 w = parsetags(kvp_get(p, "tags"));
1038 for(n = 0; w[n]; ++n)
1039 if((err = register_tag(track, w[n], tid)))
1042 /* only store the tracks.db entry if it has changed */
1043 if(t_changed && (err = trackdb_putdata(trackdb_tracksdb, track, t, tid, 0)))
1045 if(ret == DB_NOTFOUND) {
1046 uint32_t timestamp[2];
1051 timestamp[0] = htonl((uint64_t)now >> 32);
1052 timestamp[1] = htonl((uint32_t)now);
1053 memset(&key, 0, sizeof key);
1054 key.data = timestamp;
1055 key.size = sizeof timestamp;
1056 switch(err = trackdb_noticeddb->put(trackdb_noticeddb, tid, &key,
1057 make_key(&data, track), 0)) {
1059 case DB_LOCK_DEADLOCK: return err;
1060 default: fatal(0, "error updating noticed.db: %s", db_strerror(err));
1066 /* trackdb_obsolete() ********************************************************/
1068 /* obsolete a track */
1069 int trackdb_obsolete(const char *track, DB_TXN *tid) {
1074 if((err = gettrackdata(track, 0, &p, 0,
1075 GTD_NOALIAS, tid)) == DB_LOCK_DEADLOCK)
1077 else if(err == DB_NOTFOUND) return 0;
1078 /* compute the alias, if any, and delete it */
1079 if((err = compute_alias(&alias, track, p, tid))) return err;
1081 /* if the alias points to some other track then compute_alias won't
1083 if((err = trackdb_delkey(trackdb_tracksdb, alias, tid))
1084 && err != DB_NOTFOUND)
1087 /* update search.db */
1088 w = track_to_words(track, p);
1089 for(n = 0; w[n]; ++n)
1090 if(trackdb_delkeydata(trackdb_searchdb,
1091 w[n], track, tid) == DB_LOCK_DEADLOCK)
1093 /* update tags.db */
1094 w = parsetags(kvp_get(p, "tags"));
1095 for(n = 0; w[n]; ++n)
1096 if(trackdb_delkeydata(trackdb_tagsdb,
1097 w[n], track, tid) == DB_LOCK_DEADLOCK)
1100 /* update tracks.db */
1101 if(trackdb_delkey(trackdb_tracksdb, track, tid) == DB_LOCK_DEADLOCK)
1103 /* We don't delete the prefs, so they survive temporary outages of the
1104 * (possibly virtual) track filesystem */
1108 /* trackdb_stats() ***********************************************************/
1110 #define H(name) { #name, offsetof(DB_HASH_STAT, name) }
1111 #define B(name) { #name, offsetof(DB_BTREE_STAT, name) }
1113 static const struct statinfo {
1116 } statinfo_hash[] = {
1132 }, statinfo_btree[] = {
1153 /* look up stats for DB */
1154 static int get_stats(struct vector *v,
1156 const struct statinfo *si,
1165 switch(err = database->stat(database, tid, &sp, 0)) {
1168 case DB_LOCK_DEADLOCK:
1169 error(0, "error querying database: %s", db_strerror(err));
1172 fatal(0, "error querying database: %s", db_strerror(err));
1174 for(n = 0; n < nsi; ++n) {
1175 byte_xasprintf(&str, "%s=%"PRIuMAX, si[n].name,
1176 (uintmax_t)*(u_int32_t *)((char *)sp + si[n].offset));
1177 vector_append(v, str);
1183 /** @brief One entry in the search league */
1184 struct search_entry {
1189 /** @brief Add a word to the search league
1190 * @param se Pointer to search league
1191 * @param count Maximum size for search league
1192 * @param nse Current size of search league
1193 * @param word New word, or NULL
1194 * @param n How often @p word appears
1195 * @return New size of search league
1197 static int register_search_entry(struct search_entry *se,
1204 if(word && (nse < count || n > se[nse - 1].n)) {
1205 /* Find the starting point */
1210 /* Find the insertion point */
1211 while(i > 0 && n > se[i - 1].n)
1213 memmove(&se[i + 1], &se[i], (nse - i - 1) * sizeof *se);
1220 /* find the top COUNT words in the search database */
1221 static int search_league(struct vector *v, int count, DB_TXN *tid) {
1222 struct search_entry *se;
1225 int err, n = 0, nse = 0, i;
1230 cursor = trackdb_opencursor(trackdb_searchdb, tid);
1231 se = xmalloc(count * sizeof *se);
1232 /* Walk across the whole database counting up the number of times each
1234 while(!(err = cursor->c_get(cursor, prepare_data(&k), prepare_data(&d),
1236 if(word && wl == k.size && !strncmp(word, k.data, wl))
1237 ++n; /* same word again */
1239 nse = register_search_entry(se, count, nse, word, n);
1240 word = xstrndup(k.data, wl = k.size);
1248 case DB_LOCK_DEADLOCK:
1249 error(0, "error querying search database: %s", db_strerror(err));
1252 fatal(0, "error querying search database: %s", db_strerror(err));
1254 if(trackdb_closecursor(cursor)) err = DB_LOCK_DEADLOCK;
1256 nse = register_search_entry(se, count, nse, word, n);
1257 byte_xasprintf(&str, "Top %d search words:", nse);
1258 vector_append(v, str);
1259 for(i = 0; i < nse; ++i) {
1260 byte_xasprintf(&str, "%4d: %5d %s", i + 1, se[i].n, se[i].word);
1261 vector_append(v, str);
1266 #define SI(what) statinfo_##what, \
1267 sizeof statinfo_##what / sizeof (struct statinfo)
1269 /* return a list of database stats */
1270 char **trackdb_stats(int *nstatsp) {
1276 tid = trackdb_begin_transaction();
1278 vector_append(&v, (char *)"Tracks database stats:");
1279 if(get_stats(&v, trackdb_tracksdb, SI(btree), tid)) goto fail;
1280 vector_append(&v, (char *)"");
1281 vector_append(&v, (char *)"Search database stats:");
1282 if(get_stats(&v, trackdb_searchdb, SI(hash), tid)) goto fail;
1283 vector_append(&v, (char *)"");
1284 vector_append(&v, (char *)"Prefs database stats:");
1285 if(get_stats(&v, trackdb_prefsdb, SI(hash), tid)) goto fail;
1286 vector_append(&v, (char *)"");
1287 if(search_league(&v, 10, tid)) goto fail;
1288 vector_terminate(&v);
1291 trackdb_abort_transaction(tid);
1293 trackdb_commit_transaction(tid);
1294 if(nstatsp) *nstatsp = v.nvec;
1298 struct stats_details {
1299 void (*done)(char *data, void *u);
1301 int exited; /* subprocess exited */
1302 int closed; /* pipe close */
1303 int wstat; /* wait status from subprocess */
1304 struct dynstr data[1]; /* data read from pipe */
1307 static void stats_complete(struct stats_details *d) {
1310 if(!(d->exited && d->closed))
1312 byte_xasprintf(&s, "\n"
1314 "track lookup cache hits: %lu\n"
1315 "track lookup cache misses: %lu\n",
1317 cache_files_misses);
1318 dynstr_append_string(d->data, s);
1319 dynstr_terminate(d->data);
1320 d->done(d->data->vec, d->u);
1323 static int stats_finished(ev_source attribute((unused)) *ev,
1324 pid_t attribute((unused)) pid,
1326 const struct rusage attribute((unused)) *rusage,
1328 struct stats_details *const d = u;
1332 error(0, "disorder-stats %s", wstat(status));
1337 static int stats_read(ev_source attribute((unused)) *ev,
1343 struct stats_details *const d = u;
1345 dynstr_append_bytes(d->data, ptr, bytes);
1346 ev_reader_consume(reader, bytes);
1353 static int stats_error(ev_source attribute((unused)) *ev,
1356 struct stats_details *const d = u;
1358 error(errno_value, "error reading from pipe to disorder-stats");
1364 void trackdb_stats_subprocess(ev_source *ev,
1365 void (*done)(char *data, void *u),
1369 struct stats_details *d = xmalloc(sizeof *d);
1371 dynstr_init(d->data);
1375 pid = subprogram(ev, p[1], "disorder-stats", (char *)0);
1377 ev_child(ev, pid, 0, stats_finished, d);
1378 ev_reader_new(ev, p[0], stats_read, stats_error, d, "disorder-stats reader");
1381 /* set a pref (remove if value=0) */
1382 int trackdb_set(const char *track,
1384 const char *value) {
1385 struct kvp *t, *p, *a;
1388 char *oldalias, *newalias, **oldtags = 0, **newtags;
1391 /* TODO: if value matches default then set value=0 */
1395 tid = trackdb_begin_transaction();
1396 if((err = gettrackdata(track, &t, &p, 0,
1397 0, tid)) == DB_LOCK_DEADLOCK)
1399 if(err == DB_NOTFOUND) break;
1400 if(name[0] == '_') {
1401 if(kvp_set(&t, name, value))
1402 if(trackdb_putdata(trackdb_tracksdb, track, t, tid, 0))
1405 /* get the old alias name */
1406 if(compute_alias(&oldalias, track, p, tid)) goto fail;
1407 /* get the old tags */
1408 if(!strcmp(name, "tags"))
1409 oldtags = parsetags(kvp_get(p, "tags"));
1411 if(kvp_set(&p, name, value))
1412 if(trackdb_putdata(trackdb_prefsdb, track, p, tid, 0))
1414 /* compute the new alias name */
1415 if((err = compute_alias(&newalias, track, p, tid))) goto fail;
1416 /* check whether alias has changed */
1417 if(!(oldalias == newalias
1418 || (oldalias && newalias && !strcmp(oldalias, newalias)))) {
1419 /* adjust alias records to fit change */
1421 && trackdb_delkey(trackdb_tracksdb, oldalias, tid) == DB_LOCK_DEADLOCK)
1425 kvp_set(&a, "_alias_for", track);
1426 if(trackdb_putdata(trackdb_tracksdb, newalias, a, tid, 0)) goto fail;
1429 /* check whether tags have changed */
1430 if(!strcmp(name, "tags")) {
1431 newtags = parsetags(value);
1432 while(*oldtags || *newtags) {
1433 if(*oldtags && *newtags) {
1434 cmp = strcmp(*oldtags, *newtags);
1436 /* keeping this tag */
1440 /* old tag fits into a gap in the new list, so delete old */
1443 /* new tag fits into a gap in the old list, so insert new */
1445 } else if(*oldtags) {
1446 /* we've run out of new tags, so remaining old ones are to be
1449 if(trackdb_delkeydata(trackdb_tagsdb,
1450 *oldtags, track, tid) == DB_LOCK_DEADLOCK)
1454 /* we've run out of old tags, so remainig new ones are to be
1457 if(register_tag(track, *newtags, tid)) goto fail;
1467 trackdb_abort_transaction(tid);
1469 trackdb_commit_transaction(tid);
1470 return err == 0 ? 0 : -1;
1474 const char *trackdb_get(const char *track,
1476 return kvp_get(trackdb_get_all(track), name);
1479 /* get all prefs as a 0-terminated array */
1480 struct kvp *trackdb_get_all(const char *track) {
1481 struct kvp *t, *p, **pp;
1485 tid = trackdb_begin_transaction();
1486 if(gettrackdata(track, &t, &p, 0, 0, tid) == DB_LOCK_DEADLOCK)
1490 trackdb_abort_transaction(tid);
1492 trackdb_commit_transaction(tid);
1493 for(pp = &p; *pp; pp = &(*pp)->next)
1500 const char *trackdb_resolve(const char *track) {
1505 tid = trackdb_begin_transaction();
1506 if(gettrackdata(track, 0, 0, &actual, 0, tid) == DB_LOCK_DEADLOCK)
1510 trackdb_abort_transaction(tid);
1512 trackdb_commit_transaction(tid);
1516 int trackdb_isalias(const char *track) {
1517 const char *actual = trackdb_resolve(track);
1519 return strcmp(actual, track);
1522 /* test whether a track exists (perhaps an alias) */
1523 int trackdb_exists(const char *track) {
1528 tid = trackdb_begin_transaction();
1529 /* unusually, here we want the return value */
1530 if((err = gettrackdata(track, 0, 0, 0, 0, tid)) == DB_LOCK_DEADLOCK)
1534 trackdb_abort_transaction(tid);
1536 trackdb_commit_transaction(tid);
1540 /* return the list of tags */
1541 char **trackdb_alltags(void) {
1546 WITH_TRANSACTION(trackdb_listkeys(trackdb_tagsdb, v, tid));
1550 /** @brief List all the keys in @p db
1551 * @param db Database
1552 * @param v Vector to store keys in
1553 * @param tid Transaction ID
1554 * @return 0 or DB_LOCK_DEADLOCK
1556 int trackdb_listkeys(DB *db, struct vector *v, DB_TXN *tid) {
1559 DBC *const c = trackdb_opencursor(db, tid);
1562 memset(&k, 0, sizeof k);
1563 while(!(e = c->c_get(c, &k, prepare_data(&d), DB_NEXT_NODUP)))
1564 vector_append(v, xstrndup(k.data, k.size));
1568 case DB_LOCK_DEADLOCK:
1571 fatal(0, "c->c_get: %s", db_strerror(e));
1573 if((e = trackdb_closecursor(c)))
1575 vector_terminate(v);
1579 /* return 1 iff sorted tag lists A and B have at least one member in common */
1580 static int tag_intersection(char **a, char **b) {
1583 /* Same sort of logic as trackdb_set() above */
1585 if(!(cmp = strcmp(*a, *b))) return 1;
1586 else if(cmp < 0) ++a;
1592 /* Check whether a track is suitable for random play. Returns 0 if it is,
1593 * DB_NOTFOUND if it is not or DB_LOCK_DEADLOCK if the database gave us
1595 static int check_suitable(const char *track,
1597 char **required_tags,
1598 char **prohibited_tags) {
1602 const char *pick_at_random, *played_time;
1604 /* don't pick tracks that aren't in any surviving collection (for instance
1605 * you've edited the config but the rescan hasn't done its job yet) */
1606 if(!find_track_root(track)) {
1607 info("found track not in any collection: %s", track);
1610 /* don't pick aliases - only pick the canonical form */
1611 if(gettrackdata(track, &t, &p, 0, 0, tid) == DB_LOCK_DEADLOCK)
1612 return DB_LOCK_DEADLOCK;
1613 if(kvp_get(t, "_alias_for"))
1615 /* check that random play is not suppressed for this track */
1616 if((pick_at_random = kvp_get(p, "pick_at_random"))
1617 && !strcmp(pick_at_random, "0"))
1619 /* don't pick a track that's been played in the last 8 hours */
1620 if((played_time = kvp_get(p, "played_time"))) {
1621 last = atoll(played_time);
1623 if(now < last + 8 * 3600) /* TODO configurable */
1626 track_tags = parsetags(kvp_get(p, "tags"));
1627 /* check that no prohibited tag is present for this track */
1628 if(prohibited_tags && tag_intersection(track_tags, prohibited_tags))
1630 /* check that at least one required tags is present for this track */
1631 if(*required_tags && !tag_intersection(track_tags, required_tags))
1636 /* attempt to pick a random non-alias track */
1637 const char *trackdb_random(int tries) {
1642 const char *track, *candidate;
1645 char **required_tags, **prohibited_tags, **tp;
1650 tid = trackdb_begin_transaction();
1651 if((err = trackdb_get_global_tid("required-tags", tid, &tags)))
1653 required_tags = parsetags(tags);
1654 if((err = trackdb_get_global_tid("prohibited-tags", tid, &tags)))
1656 prohibited_tags = parsetags(tags);
1658 if(*required_tags) {
1659 /* Bung all the suitable tracks into a hash and convert to a list of keys
1660 * (to eliminate duplicates). We cache this list since it is possible
1661 * that it will be very large. */
1664 for(tp = required_tags; *tp; ++tp) {
1665 c = trackdb_opencursor(trackdb_tagsdb, tid);
1666 memset(&key, 0, sizeof key);
1668 key.size = strlen(*tp);
1670 err = c->c_get(c, &key, prepare_data(&data), DB_SET);
1672 hash_add(h, xstrndup(data.data, data.size), 0,
1673 HASH_INSERT_OR_REPLACE);
1675 err = c->c_get(c, &key, prepare_data(&data), DB_NEXT_DUP);
1681 case DB_LOCK_DEADLOCK:
1684 fatal(0, "error querying tags.db: %s", db_strerror(err));
1686 trackdb_closecursor(c);
1689 error(0, "required tag %s does not match any tracks", *tp);
1691 nreqtracks = hash_count(h);
1692 reqtracks = hash_keys(h);
1694 while(nreqtracks && !track && tries-- > 0) {
1695 r = (rand() * (double)nreqtracks / (RAND_MAX + 1.0));
1696 candidate = reqtracks[r];
1697 switch(check_suitable(candidate, tid,
1698 required_tags, prohibited_tags)) {
1704 case DB_LOCK_DEADLOCK:
1709 /* No required tags. We pick random record numbers in the database
1711 switch(err = trackdb_tracksdb->stat(trackdb_tracksdb, tid, &sp, 0)) {
1714 case DB_LOCK_DEADLOCK:
1715 error(0, "error querying tracks.db: %s", db_strerror(err));
1718 fatal(0, "error querying tracks.db: %s", db_strerror(err));
1721 error(0, "cannot pick tracks at random from an empty database");
1722 while(sp->bt_nkeys && !track && tries-- > 0) {
1723 /* record numbers count from 1 upwards */
1724 r = 1 + (rand() * (double)sp->bt_nkeys / (RAND_MAX + 1.0));
1725 memset(&key, sizeof key, 0);
1726 key.flags = DB_DBT_MALLOC;
1727 key.size = sizeof r;
1729 switch(err = trackdb_tracksdb->get(trackdb_tracksdb, tid, &key, prepare_data(&data),
1733 case DB_LOCK_DEADLOCK:
1734 error(0, "error querying tracks.db: %s", db_strerror(err));
1737 fatal(0, "error querying tracks.db: %s", db_strerror(err));
1739 candidate = xstrndup(key.data, key.size);
1740 switch(check_suitable(candidate, tid,
1741 required_tags, prohibited_tags)) {
1747 case DB_LOCK_DEADLOCK:
1754 trackdb_closecursor(c);
1756 trackdb_abort_transaction(tid);
1758 trackdb_commit_transaction(tid);
1760 error(0, "could not pick a random track");
1764 /* get a track name given the prefs. Set *used_db to 1 if we got the answer
1765 * from the prefs. */
1766 static const char *getpart(const char *track,
1767 const char *context,
1769 const struct kvp *p,
1774 byte_xasprintf(&pref, "trackname_%s_%s", context, part);
1775 if((result = kvp_get(p, pref)))
1778 result = trackname_part(track, context, part);
1779 assert(result != 0);
1783 /* get a track name part, like trackname_part(), but taking the database into
1785 const char *trackdb_getpart(const char *track,
1786 const char *context,
1794 /* construct the full pref */
1795 byte_xasprintf(&pref, "trackname_%s_%s", context, part);
1797 tid = trackdb_begin_transaction();
1798 if((err = gettrackdata(track, 0, &p, &actual, 0, tid)) == DB_LOCK_DEADLOCK)
1802 trackdb_abort_transaction(tid);
1804 trackdb_commit_transaction(tid);
1805 return getpart(actual, context, part, p, &used_db);
1808 /* get the raw path name for @track@ (might be an alias) */
1809 const char *trackdb_rawpath(const char *track) {
1815 tid = trackdb_begin_transaction();
1816 if(gettrackdata(track, &t, 0, 0, 0, tid) == DB_LOCK_DEADLOCK)
1820 trackdb_abort_transaction(tid);
1822 trackdb_commit_transaction(tid);
1823 if(!(path = kvp_get(t, "_path"))) path = track;
1827 /* trackdb_list **************************************************************/
1829 /* this is incredibly ugly, sorry, perhaps it will be rewritten to be actually
1830 * readable at some point */
1832 /* return true if the basename of TRACK[0..TL-1], as defined by DL, matches RE.
1833 * If RE is a null pointer then it matches everything. */
1834 static int track_matches(size_t dl, const char *track, size_t tl,
1842 switch(rc = pcre_exec(re, 0, track, tl, 0, 0, ovec, 3)) {
1843 case PCRE_ERROR_NOMATCH: return 0;
1846 error(0, "pcre_exec returned %d, subject '%s'", rc, track);
1853 static int do_list(struct vector *v, const char *dir,
1854 enum trackdb_listable what, const pcre *re, DB_TXN *tid) {
1860 size_t l, last_dir_len = 0;
1861 char *last_dir = 0, *track, *alias;
1865 cursor = trackdb_opencursor(trackdb_tracksdb, tid);
1868 /* find the first key >= dir */
1869 err = cursor->c_get(cursor, &k, &d, DB_SET_RANGE);
1870 /* keep going while we're dealing with <dir/anything> */
1873 && ((char *)k.data)[dl] == '/'
1874 && !memcmp(k.data, dir, dl)) {
1875 ptr = memchr((char *)k.data + dl + 1, '/', k.size - (dl + 1));
1877 /* we have <dir/component/anything>, so <dir/component> is a directory */
1878 l = ptr - (char *)k.data;
1879 if(what & trackdb_directories)
1881 && l == last_dir_len
1882 && !memcmp(last_dir, k.data, l))) {
1883 last_dir = xstrndup(k.data, last_dir_len = l);
1884 if(track_matches(dl, k.data, l, re))
1885 vector_append(v, last_dir);
1888 /* found a plain file */
1889 if((what & trackdb_files)) {
1890 track = xstrndup(k.data, k.size);
1891 if((err = trackdb_getdata(trackdb_prefsdb,
1892 track, &p, tid)) == DB_LOCK_DEADLOCK)
1894 /* if this file has an alias in the same directory then we skip it */
1895 if((err = compute_alias(&alias, track, p, tid)))
1897 if(!(alias && !strcmp(d_dirname(alias), d_dirname(track))))
1898 if(track_matches(dl, k.data, k.size, re))
1899 vector_append(v, track);
1902 err = cursor->c_get(cursor, &k, &d, DB_NEXT);
1910 case DB_LOCK_DEADLOCK:
1911 error(0, "error querying database: %s", db_strerror(err));
1914 fatal(0, "error querying database: %s", db_strerror(err));
1917 if(trackdb_closecursor(cursor)) err = DB_LOCK_DEADLOCK;
1921 /* return the directories or files below @dir@ */
1922 char **trackdb_list(const char *dir, int *np, enum trackdb_listable what,
1930 tid = trackdb_begin_transaction();
1933 if(do_list(&v, dir, what, re, tid))
1936 for(n = 0; n < config->collection.n; ++n)
1937 if(do_list(&v, config->collection.s[n].root, what, re, tid))
1942 trackdb_abort_transaction(tid);
1944 trackdb_commit_transaction(tid);
1945 vector_terminate(&v);
1951 /* If S is tag:something, return something. Else return 0. */
1952 static const char *checktag(const char *s) {
1953 if(!strncmp(s, "tag:", 4))
1959 /* return a list of tracks containing all of the words given. If you
1960 * ask for only stopwords you get no tracks. */
1961 char **trackdb_search(char **wordlist, int nwordlist, int *ntracks) {
1962 const char **w, *best = 0, *tag;
1963 char **twords, **tags;
1965 int i, j, n, err, what;
1975 *ntracks = 0; /* for early returns */
1976 /* normalize all the words */
1977 w = xmalloc(nwordlist * sizeof (char *));
1978 istag = xmalloc_noptr(nwordlist);
1979 for(n = 0; n < nwordlist; ++n) {
1983 w[n] = utf8_casefold_compat(wordlist[n], strlen(wordlist[n]), 0);
1984 if(checktag(w[n])) {
1985 ++ntags; /* count up tags */
1986 /* Normalize the tag */
1987 w[n] = normalize_tag(w[n] + 4, strlen(w[n] + 4));
1990 /* Normalize the search term by removing combining characters */
1991 if(!(w32 = utf8_to_utf32(w[n], strlen(w[n]), &nw32)))
1993 nw32 = remove_combining_chars(w32, nw32);
1994 if(!(w[n] = utf32_to_utf8(w32, nw32, 0)))
1999 /* find the longest non-stopword */
2000 for(n = 0; n < nwordlist; ++n)
2001 if(!istag[n] && !stopword(w[n]))
2002 if(!best || strlen(w[n]) > strlen(best))
2004 /* TODO: we should at least in principal be able to identify the word or tag
2005 * with the least matches in log time, and choose that as our primary search
2007 if(ntags && !best) {
2008 /* Only tags are listed. We limit to the first and narrow down with the
2010 best = istag[0] ? w[0] : 0;
2011 db = trackdb_tagsdb;
2014 /* We can limit to some word. */
2015 db = trackdb_searchdb;
2018 /* Only stopwords */
2024 tid = trackdb_begin_transaction();
2025 /* find all the tracks that have that word */
2030 cursor = trackdb_opencursor(db, tid);
2031 while(!(err = cursor->c_get(cursor, &k, &d, what))) {
2032 vector_append(&v, xstrndup(d.data, d.size));
2039 case DB_LOCK_DEADLOCK:
2040 error(0, "error querying %s database: %s", dbname, db_strerror(err));
2043 fatal(0, "error querying %s database: %s", dbname, db_strerror(err));
2045 if(trackdb_closecursor(cursor)) err = DB_LOCK_DEADLOCK;
2047 /* do a naive search over that (hopefuly fairly small) list of tracks */
2049 for(n = 0; n < v.nvec; ++n) {
2050 if((err = gettrackdata(v.vec[n], 0, &p, 0, 0, tid) == DB_LOCK_DEADLOCK))
2053 error(0, "track %s unexpected error: %s", v.vec[n], db_strerror(err));
2056 twords = track_to_words(v.vec[n], p);
2057 tags = parsetags(kvp_get(p, "tags"));
2058 for(i = 0; i < nwordlist; ++i) {
2061 /* Track must have this tag */
2062 for(j = 0; tags[j]; ++j)
2063 if(!strcmp(tag, tags[j])) break; /* tag found */
2064 if(!tags[j]) break; /* tag not found */
2066 /* Track must contain this word */
2067 for(j = 0; twords[j]; ++j)
2068 if(!strcmp(w[i], twords[j])) break; /* word found */
2069 if(!twords[j]) break; /* word not found */
2072 if(i >= nwordlist) /* all words found */
2073 vector_append(&u, v.vec[n]);
2077 trackdb_closecursor(cursor);
2079 trackdb_abort_transaction(tid);
2080 info("retrying search");
2082 trackdb_commit_transaction(tid);
2083 vector_terminate(&u);
2089 /* trackdb_scan **************************************************************/
2091 int trackdb_scan(const char *root,
2092 int (*callback)(const char *track,
2100 const size_t root_len = root ? strlen(root) : 0;
2105 cursor = trackdb_opencursor(trackdb_tracksdb, tid);
2107 err = cursor->c_get(cursor, make_key(&k, root), prepare_data(&d),
2110 memset(&k, 0, sizeof k);
2111 err = cursor->c_get(cursor, &k, prepare_data(&d),
2116 || (k.size > root_len
2117 && !strncmp(k.data, root, root_len)
2118 && ((char *)k.data)[root_len] == '/')) {
2119 data = kvp_urldecode(d.data, d.size);
2120 if(kvp_get(data, "_path")) {
2121 track = xstrndup(k.data, k.size);
2122 /* Advance to the next track before the callback so that the callback
2123 * may safely delete the track */
2124 err = cursor->c_get(cursor, &k, &d, DB_NEXT);
2125 if((cberr = callback(track, data, u, tid))) {
2130 err = cursor->c_get(cursor, &k, &d, DB_NEXT);
2134 trackdb_closecursor(cursor);
2141 case DB_LOCK_DEADLOCK:
2142 error(0, "c->c_get: %s", db_strerror(err));
2145 fatal(0, "c->c_get: %s", db_strerror(err));
2149 /* trackdb_rescan ************************************************************/
2151 /* called when the rescanner terminates */
2152 static int reap_rescan(ev_source attribute((unused)) *ev,
2155 const struct rusage attribute((unused)) *rusage,
2156 void attribute((unused)) *u) {
2157 if(pid == rescan_pid) rescan_pid = -1;
2159 error(0, RESCAN": %s", wstat(status));
2161 D((RESCAN" terminated: %s", wstat(status)));
2162 /* Our cache of file lookups is out of date now */
2163 cache_clean(&cache_files_type);
2164 eventlog("rescanned", (char *)0);
2168 /** @brief Initiate a rescan
2169 * @param ev Event loop or 0 to block
2170 * @param recheck 1 to recheck lengths, 0 to suppress check
2172 void trackdb_rescan(ev_source *ev, int recheck) {
2175 if(rescan_pid != -1) {
2176 error(0, "rescan already underway");
2179 rescan_pid = subprogram(ev, -1, RESCAN,
2180 recheck ? "--check" : "--no-check",
2183 ev_child(ev, rescan_pid, 0, reap_rescan, 0);
2184 D(("started rescanner"));
2186 /* This is the first rescan, we block until it is complete */
2187 while(waitpid(rescan_pid, &w, 0) < 0 && errno == EINTR)
2189 reap_rescan(0, rescan_pid, w, 0, 0);
2193 int trackdb_rescan_cancel(void) {
2194 if(rescan_pid == -1) return 0;
2195 if(kill(rescan_pid, SIGTERM) < 0)
2196 fatal(errno, "error killing rescanner");
2201 /* global prefs **************************************************************/
2203 void trackdb_set_global(const char *name,
2211 tid = trackdb_begin_transaction();
2212 if(!(err = trackdb_set_global_tid(name, value, tid)))
2214 trackdb_abort_transaction(tid);
2216 trackdb_commit_transaction(tid);
2217 /* log important state changes */
2218 if(!strcmp(name, "playing")) {
2219 state = !value || !strcmp(value, "yes");
2220 info("playing %s by %s",
2221 state ? "enabled" : "disabled",
2223 eventlog("state", state ? "enable_play" : "disable_play", (char *)0);
2225 if(!strcmp(name, "random-play")) {
2226 state = !value || !strcmp(value, "yes");
2227 info("random play %s by %s",
2228 state ? "enabled" : "disabled",
2230 eventlog("state", state ? "enable_random" : "disable_random", (char *)0);
2232 if(!strcmp(name, "required-tags"))
2236 int trackdb_set_global_tid(const char *name,
2242 memset(&k, 0, sizeof k);
2243 memset(&d, 0, sizeof d);
2244 k.data = (void *)name;
2245 k.size = strlen(name);
2247 d.data = (void *)value;
2248 d.size = strlen(value);
2251 err = trackdb_globaldb->put(trackdb_globaldb, tid, &k, &d, 0);
2253 err = trackdb_globaldb->del(trackdb_globaldb, tid, &k, 0);
2254 if(err == DB_LOCK_DEADLOCK) return err;
2256 fatal(0, "error updating database: %s", db_strerror(err));
2260 const char *trackdb_get_global(const char *name) {
2266 tid = trackdb_begin_transaction();
2267 if(!(err = trackdb_get_global_tid(name, tid, &r)))
2269 trackdb_abort_transaction(tid);
2271 trackdb_commit_transaction(tid);
2275 int trackdb_get_global_tid(const char *name,
2281 memset(&k, 0, sizeof k);
2282 k.data = (void *)name;
2283 k.size = strlen(name);
2284 switch(err = trackdb_globaldb->get(trackdb_globaldb, tid, &k,
2285 prepare_data(&d), 0)) {
2287 *rp = xstrndup(d.data, d.size);
2292 case DB_LOCK_DEADLOCK:
2295 fatal(0, "error reading database: %s", db_strerror(err));
2299 /** @brief Retrieve the most recently added tracks
2300 * @param ntracksp Where to put count, or 0
2301 * @param maxtracks Maximum number of tracks to retrieve
2302 * @return null-terminated array of track names
2304 * The most recently added track is first in the array.
2306 char **trackdb_new(int *ntracksp,
2312 tid = trackdb_begin_transaction();
2313 tracks = trackdb_new_tid(ntracksp, maxtracks, tid);
2316 trackdb_abort_transaction(tid);
2318 trackdb_commit_transaction(tid);
2322 /** @brief Retrieve the most recently added tracks
2323 * @param ntracksp Where to put count, or 0
2324 * @param maxtracks Maximum number of tracks to retrieve, or 0 for all
2325 * @param tid Transaction ID
2326 * @return null-terminated array of track names, or NULL on deadlock
2328 * The most recently added track is first in the array.
2330 static char **trackdb_new_tid(int *ntracksp,
2336 struct vector tracks[1];
2338 vector_init(tracks);
2339 c = trackdb_opencursor(trackdb_noticeddb, tid);
2340 while((maxtracks <= 0 || tracks->nvec < maxtracks)
2341 && !(err = c->c_get(c, prepare_data(&k), prepare_data(&d), DB_PREV)))
2342 vector_append(tracks, xstrndup(d.data, d.size));
2344 case 0: /* hit maxtracks */
2345 case DB_NOTFOUND: /* ran out of tracks */
2347 case DB_LOCK_DEADLOCK:
2348 trackdb_closecursor(c);
2351 fatal(0, "error reading noticed.db: %s", db_strerror(err));
2353 if((err = trackdb_closecursor(c)))
2354 return 0; /* deadlock */
2355 vector_terminate(tracks);
2357 *ntracksp = tracks->nvec;
2361 /** @brief Expire noticed.db
2362 * @param earliest Earliest timestamp to keep
2364 void trackdb_expire_noticed(time_t earliest) {
2368 tid = trackdb_begin_transaction();
2369 if(!trackdb_expire_noticed_tid(earliest, tid))
2371 trackdb_abort_transaction(tid);
2373 trackdb_commit_transaction(tid);
2376 /** @brief Expire noticed.db
2377 * @param earliest Earliest timestamp to keep
2378 * @param tid Transaction ID
2379 * @return 0 or DB_LOCK_DEADLOCK
2381 static int trackdb_expire_noticed_tid(time_t earliest, DB_TXN *tid) {
2389 c = trackdb_opencursor(trackdb_noticeddb, tid);
2390 while(!(err = c->c_get(c, prepare_data(&k), prepare_data(&d), DB_NEXT))) {
2392 when = (time_t)(((uint64_t)ntohl(kk[0]) << 32) + ntohl(kk[1]));
2393 if(when >= earliest)
2395 if((err = c->c_del(c, 0))) {
2396 if(err != DB_LOCK_DEADLOCK)
2397 fatal(0, "error deleting expired noticed.db entry: %s",
2403 if(err == DB_NOTFOUND)
2405 if(err && err != DB_LOCK_DEADLOCK)
2406 fatal(0, "error expiring noticed.db: %s", db_strerror(err));
2408 if((err = trackdb_closecursor(c))) {
2409 if(err != DB_LOCK_DEADLOCK)
2410 fatal(0, "error closing cursor: %s", db_strerror(err));
2414 info("expired %d tracks from noticed.db", count);
2418 /* tidying up ****************************************************************/
2420 void trackdb_gc(void) {
2424 if((err = trackdb_env->txn_checkpoint(trackdb_env,
2425 config->checkpoint_kbyte,
2426 config->checkpoint_min,
2428 fatal(0, "trackdb_env->txn_checkpoint: %s", db_strerror(err));
2429 if((err = trackdb_env->log_archive(trackdb_env, &logfiles, DB_ARCH_REMOVE)))
2430 fatal(0, "trackdb_env->log_archive: %s", db_strerror(err));
2431 /* This makes catastrophic recovery impossible. However, the user can still
2432 * preserve the important data by using disorder-dump to snapshot their
2433 * prefs, and later to restore it. This is likely to have much small
2434 * long-term storage requirements than record the db logfiles. */
2437 /* user database *************************************************************/
2439 /** @brief Return true if @p user is trusted */
2440 static int trusted(const char *user) {
2443 for(n = 0; (n < config->trust.n
2444 && strcmp(config->trust.s[n], user)); ++n)
2446 return n < config->trust.n;
2449 /** @brief Return non-zero for a valid username
2451 * Currently we only allow the letters and digits in ASCII. We could be more
2452 * liberal than this but it is a nice simple test. It is critical that
2453 * semicolons are never allowed.
2455 static int valid_username(const char *user) {
2459 const uint8_t c = *user++;
2460 /* For now we are very strict */
2461 if((c >= 'a' && c <= 'z')
2462 || (c >= 'A' && c <= 'Z')
2463 || (c >= '0' && c <= '9'))
2471 /** @brief Add a user */
2472 static int create_user(const char *user,
2473 const char *password,
2476 const char *confirmation,
2482 /* sanity check user */
2483 if(!valid_username(user)) {
2484 error(0, "invalid username '%s'", user);
2487 if(parse_rights(rights, 0, 1)) {
2488 error(0, "invalid rights string");
2491 /* data for this user */
2493 kvp_set(&k, "password", password);
2494 kvp_set(&k, "rights", rights);
2496 kvp_set(&k, "email", email);
2498 kvp_set(&k, "confirmation", confirmation);
2499 snprintf(s, sizeof s, "%jd", (intmax_t)time(0));
2500 kvp_set(&k, "created", s);
2501 return trackdb_putdata(trackdb_usersdb, user, k, tid, flags);
2504 /** @brief Add one pre-existing user */
2505 static int one_old_user(const char *user, const char *password,
2509 /* www-data doesn't get added */
2510 if(!strcmp(user, "www-data")) {
2511 info("not adding www-data to user database");
2515 if(!strcmp(user, "root"))
2517 else if(trusted(user)) {
2520 parse_rights(config->default_rights, &r, 1);
2521 r &= ~(rights_type)(RIGHT_SCRATCH__MASK|RIGHT_MOVE__MASK|RIGHT_REMOVE__MASK);
2522 r |= (RIGHT_ADMIN|RIGHT_RESCAN
2523 |RIGHT_SCRATCH_ANY|RIGHT_MOVE_ANY|RIGHT_REMOVE_ANY);
2524 rights = rights_string(r);
2526 rights = config->default_rights;
2527 return create_user(user, password, rights, 0/*email*/, 0/*confirmation*/,
2528 tid, DB_NOOVERWRITE);
2531 static int trackdb_old_users_tid(DB_TXN *tid) {
2534 for(n = 0; n < config->allow.n; ++n) {
2535 switch(one_old_user(config->allow.s[n].s[0], config->allow.s[n].s[1],
2538 info("created user %s from 'allow' directive", config->allow.s[n].s[0]);
2541 error(0, "user %s already exists, delete 'allow' directive",
2542 config->allow.s[n].s[0]);
2543 /* This won't ever become fatal - eventually 'allow' will be
2546 case DB_LOCK_DEADLOCK:
2547 return DB_LOCK_DEADLOCK;
2553 /** @brief Read old 'allow' directives and copy them to the users database */
2554 void trackdb_old_users(void) {
2558 WITH_TRANSACTION(trackdb_old_users_tid(tid));
2561 /** @brief Create a root user in the user database if there is none */
2562 void trackdb_create_root(void) {
2567 /* Choose a new root password */
2568 gcry_randomize(pwbin, sizeof pwbin, GCRY_STRONG_RANDOM);
2569 pw = mime_to_base64(pwbin, sizeof pwbin);
2570 /* Create the root user if it does not exist */
2571 WITH_TRANSACTION(create_user("root", pw, "all",
2572 0/*email*/, 0/*confirmation*/,
2573 tid, DB_NOOVERWRITE));
2575 info("created root user");
2578 /** @brief Find a user's password from the database
2579 * @param user Username
2580 * @return Password or NULL
2582 * Only works if running as a user that can read the database!
2584 * If the user exists but has no password, "" is returned.
2586 const char *trackdb_get_password(const char *user) {
2589 const char *password;
2591 WITH_TRANSACTION(trackdb_getdata(trackdb_usersdb, user, &k, tid));
2594 password = kvp_get(k, "password");
2595 return password ? password : "";
2598 /** @brief Add a new user
2599 * @param user Username
2600 * @param password Password or NULL
2601 * @param rights Initial rights
2602 * @param email Email address or NULL
2603 * @param confirmation Confirmation string or NULL
2604 * @return 0 on success, non-0 on error
2606 int trackdb_adduser(const char *user,
2607 const char *password,
2610 const char *confirmation) {
2613 WITH_TRANSACTION(create_user(user, password, rights, email, confirmation,
2614 tid, DB_NOOVERWRITE));
2616 error(0, "cannot create user '%s' because they already exist", user);
2620 info("created user '%s' with rights '%s' and email address '%s'",
2621 user, rights, email);
2623 info("created user '%s' with rights '%s'", user, rights);
2628 /** @brief Delete a user
2629 * @param user User to delete
2630 * @return 0 on success, non-0 if the user didn't exist anyway
2632 int trackdb_deluser(const char *user) {
2635 WITH_TRANSACTION(trackdb_delkey(trackdb_usersdb, user, tid));
2637 error(0, "cannot delete user '%s' because they do not exist", user);
2640 info("deleted user '%s'", user);
2644 /** @brief Get user information
2645 * @param user User to query
2646 * @return Linked list of user information or NULL if user does not exist
2648 * Every user has at least a @c rights entry so NULL can be used to mean no
2651 struct kvp *trackdb_getuserinfo(const char *user) {
2655 WITH_TRANSACTION(trackdb_getdata(trackdb_usersdb, user, &k, tid));
2662 /** @brief Edit user information
2663 * @param user User to edit
2664 * @param key Key to change
2665 * @param value Value to set, or NULL to remove
2666 * @param tid Transaction ID
2667 * @return 0, DB_LOCK_DEADLOCK or DB_NOTFOUND
2669 static int trackdb_edituserinfo_tid(const char *user, const char *key,
2670 const char *value, DB_TXN *tid) {
2674 if((e = trackdb_getdata(trackdb_usersdb, user, &k, tid)))
2676 if(!kvp_set(&k, key, value))
2677 return 0; /* no change */
2678 return trackdb_putdata(trackdb_usersdb, user, k, tid, 0);
2681 /** @brief Edit user information
2682 * @param user User to edit
2683 * @param key Key to change
2684 * @param value Value to set, or NULL to remove
2685 * @return 0 on success, non-0 on error
2687 int trackdb_edituserinfo(const char *user,
2688 const char *key, const char *value) {
2691 if(!strcmp(key, "rights")) {
2693 error(0, "cannot remove 'rights' key from user '%s'", user);
2696 if(parse_rights(value, 0, 1)) {
2697 error(0, "invalid rights string");
2700 } else if(!strcmp(key, "email")) {
2701 if(!strchr(value, '@')) {
2702 error(0, "invalid email address '%s' for user '%s'", user, value);
2705 } else if(!strcmp(key, "created")) {
2706 error(0, "cannot change creation date for user '%s'", user);
2708 } else if(strcmp(key, "password")
2709 && !strcmp(key, "confirmation")) {
2710 error(0, "unknown user info key '%s' for user '%s'", key, user);
2713 WITH_TRANSACTION(trackdb_edituserinfo_tid(user, key, value, tid));
2715 error(0, "unknown user '%s'", user);
2721 /** @brief List all users
2722 * @return NULL-terminated list of users
2724 char **trackdb_listusers(void) {
2729 WITH_TRANSACTION(trackdb_listkeys(trackdb_usersdb, v, tid));
2733 /** @brief Confirm a user registration
2734 * @param user Username
2735 * @param confirmation Confirmation string
2736 * @param rightsp Where to put user rights
2737 * @param tid Transaction ID
2738 * @return 0 on success, non-0 on error
2740 static int trackdb_confirm_tid(const char *user, const char *confirmation,
2741 rights_type *rightsp,
2743 const char *stored_confirmation;
2748 if((e = trackdb_getdata(trackdb_usersdb, user, &k, tid)))
2750 if(!(stored_confirmation = kvp_get(k, "confirmation"))) {
2751 error(0, "already confirmed user '%s'", user);
2752 /* DB claims -30,800 to -30,999 so -1 should be a safe bet */
2755 if(!(rights = kvp_get(k, "rights"))) {
2756 error(0, "no rights for unconfirmed user '%s'", user);
2759 if(parse_rights(rights, rightsp, 1))
2761 if(strcmp(confirmation, stored_confirmation)) {
2762 error(0, "wrong confirmation string for user '%s'", user);
2766 kvp_set(&k, "confirmation", 0);
2767 return trackdb_putdata(trackdb_usersdb, user, k, tid, 0);
2770 /** @brief Confirm a user registration
2771 * @param user Username
2772 * @param confirmation Confirmation string
2773 * @param rightsp Where to put user rights
2774 * @return 0 on success, non-0 on error
2776 int trackdb_confirm(const char *user, const char *confirmation,
2777 rights_type *rightsp) {
2780 WITH_TRANSACTION(trackdb_confirm_tid(user, confirmation, rightsp, tid));
2783 info("registration confirmed for user '%s'", user);
2786 error(0, "confirmation for nonexistent user '%s'", user);
2788 default: /* already reported */
2798 indent-tabs-mode:nil