2 * This file is part of DisOrder
3 * Copyright (C) 2005-2008 Richard Kettlewell
5 * This program is free software: you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation, either version 3 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License
16 * along with this program. If not, see <http://www.gnu.org/licenses/>.
18 /** @file lib/trackdb.c
19 * @brief Track database
21 * This file is getting in desparate need of splitting up...
27 #include <sys/socket.h>
32 #include <sys/resource.h>
34 #include <arpa/inet.h>
47 #include "configuration.h"
52 #include "trackname.h"
53 #include "trackdb-int.h"
64 #define RESCAN "disorder-rescan"
65 #define DEADLOCK "disorder-deadlock"
67 static const char *getpart(const char *track,
72 static char **trackdb_new_tid(int *ntracksp,
75 static int trackdb_expire_noticed_tid(time_t earliest, DB_TXN *tid);
76 static char *normalize_tag(const char *s, size_t ns);
78 const struct cache_type cache_files_type = { 86400 };
79 unsigned long cache_files_hits, cache_files_misses;
81 /** @brief Set by trackdb_open() */
82 int trackdb_existing_database;
84 /* setup and teardown ********************************************************/
86 /** @brief Database home directory
88 * All database files live below here. It had better never change.
90 static const char *home;
92 /** @brief Database environment */
95 /** @brief The tracks database
96 * - Keys are UTF-8(NFC(unicode(path name)))
97 * - Values are encoded key-value pairs
98 * - Data is reconstructable data about tracks that currently exist
100 DB *trackdb_tracksdb;
102 /** @brief The preferences database
104 * - Keys are UTF-8(NFC(unicode(path name)))
105 * - Values are encoded key-value pairs
106 * - Data is user data about tracks (that might not exist any more)
107 * and cannot be reconstructed
111 /** @brief The search database
113 * - Keys are UTF-8(NFKC(casefold(search term)))
114 * - Values are UTF-8(NFC(unicode(path name)))
115 * - There can be more than one value per key
116 * - Presence of key,value means that path matches the search terms
117 * - Only tracks fond in @ref trackdb_tracksdb are represented here
118 * - This database can be reconstructed, it contains no user data
120 DB *trackdb_searchdb;
122 /** @brief The tags database
124 * - Keys are UTF-8(NFKC(casefold(tag)))
125 * - Values are UTF-8(NFC(unicode(path name)))
126 * - There can be more than one value per key
127 * - Presence of key,value means that path matches the tag
128 * - This is always in sync with the tags preference
129 * - This database can be reconstructed, it contains no user data
131 DB *trackdb_tagsdb; /* the tags database */
133 /** @brief The global preferences database
134 * - Keys are UTF-8(NFC(preference))
135 * - Values are global preference values
136 * - Data is user data and cannot be reconstructed
138 DB *trackdb_globaldb; /* global preferences */
140 /** @brief The noticed database
141 * - Keys are 64-bit big-endian timestamps
142 * - Values are UTF-8(NFC(unicode(path name)))
143 * - There can be more than one value per key
144 * - Presence of key,value means that path was added at the given time
145 * - Data cannot be reconstructed (but isn't THAT important)
147 DB *trackdb_noticeddb; /* when track noticed */
149 /** @brief The schedule database
151 * - Keys are ID strings, generated at random
152 * - Values are encoded key-value pairs
153 * - There can be more than one value per key
154 * - Data cannot be reconstructed
156 * See @ref server/schedule.c for further information.
158 DB *trackdb_scheduledb;
160 /** @brief The user database
161 * - Keys are usernames
162 * - Values are encoded key-value pairs
163 * - Data is user data and cannot be reconstructed
167 /** @brief The playlists database
168 * - Keys are playlist names
169 * - Values are encoded key-value pairs
170 * - Data is user data and cannot be reconstructed
172 DB *trackdb_playlistsdb;
174 /** @brief Deadlock manager PID */
175 static pid_t db_deadlock_pid = -1;
177 /** @brief Rescanner PID */
178 static pid_t rescan_pid = -1;
180 /** @brief Set when the database environment exists */
181 static int initialized;
183 /** @brief Set when databases are open */
186 /** @brief Current stats subprocess PIDs */
187 static hash *stats_pids;
189 /** @brief PID of current random track chooser (disorder-choose) */
190 static pid_t choose_pid = -1;
192 /** @brief Our end of pipe from disorder-choose */
193 static int choose_fd;
195 /** @brief Callback to supply random track to */
196 static random_callback *choose_callback;
198 /** @brief Accumulator for output from disorder-choose */
199 static struct dynstr choose_output;
201 /** @brief Current completion status of disorder-choose
202 * A bitmap of @ref CHOOSE_READING and @ref CHOOSE_RUNNING.
204 static unsigned choose_complete;
206 /* @brief Exit status from disorder-choose */
207 static int choose_status;
209 /** @brief disorder-choose process is running */
210 #define CHOOSE_RUNNING 1
212 /** @brief disorder-choose pipe is still open */
213 #define CHOOSE_READING 2
215 /** @brief Comparison function for filename-based keys */
216 static int compare(DB attribute((unused)) *db_,
217 const DBT *a, const DBT *b) {
218 return compare_path_raw(a->data, a->size, b->data, b->size);
221 /** @brief Test whether the track database can be read
222 * @return 1 if it can, 0 if it cannot
224 int trackdb_readable(void) {
227 byte_xasprintf(&usersdb, "%s/users.db", config->home);
228 return access(usersdb, R_OK) == 0;
231 /** @brief Open database environment
232 * @param flags Flags word
234 * Flags should be one of:
235 * - @ref TRACKDB_NO_RECOVER
236 * - @ref TRACKDB_NORMAL_RECOVER
237 * - @ref TRACKDB_FATAL_RECOVER
238 * - @ref TRACKDB_MAY_CREATE
240 void trackdb_init(int flags) {
242 const int recover = flags & TRACKDB_RECOVER_MASK;
243 static int recover_type[] = { 0, DB_RECOVER, DB_RECOVER_FATAL };
246 assert(initialized == 0);
249 if(strcmp(home, config->home))
250 disorder_fatal(0, "cannot change db home without server restart");
254 if(flags & TRACKDB_MAY_CREATE) {
260 /* Remove world/group permissions on any regular files already in the
261 * database directory. Actually we don't care about all of them but it's
262 * easier to just do the lot. This can be revisited if it's a serious
263 * practical inconvenience for anyone.
265 * The socket, not being a regular file, is excepted.
267 if(!(dp = opendir(config->home)))
268 disorder_fatal(errno, "error reading %s", config->home);
269 while((de = readdir(dp))) {
270 byte_xasprintf(&p, "%s/%s", config->home, de->d_name);
271 if(lstat(p, &st) == 0
272 && S_ISREG(st.st_mode)
273 && (st.st_mode & 077)) {
274 if(chmod(p, st.st_mode & 07700) < 0)
275 disorder_fatal(errno, "cannot chmod %s", p);
282 /* create environment */
283 if((err = db_env_create(&trackdb_env, 0)))
284 disorder_fatal(0, "db_env_create: %s", db_strerror(err));
285 if((err = trackdb_env->set_alloc(trackdb_env,
286 xmalloc_noptr, xrealloc_noptr, xfree)))
287 disorder_fatal(0, "trackdb_env->set_alloc: %s", db_strerror(err));
288 if((err = trackdb_env->set_lk_max_locks(trackdb_env, 10000)))
289 disorder_fatal(0, "trackdb_env->set_lk_max_locks: %s", db_strerror(err));
290 if((err = trackdb_env->set_lk_max_objects(trackdb_env, 10000)))
291 disorder_fatal(0, "trackdb_env->set_lk_max_objects: %s", db_strerror(err));
292 if((err = trackdb_env->open(trackdb_env, config->home,
298 |recover_type[recover],
300 disorder_fatal(0, "trackdb_env->open %s: %s",
301 config->home, db_strerror(err));
302 trackdb_env->set_errpfx(trackdb_env, "DB");
303 trackdb_env->set_errfile(trackdb_env, stderr);
304 trackdb_env->set_verbose(trackdb_env, DB_VERB_DEADLOCK, 1);
305 trackdb_env->set_verbose(trackdb_env, DB_VERB_RECOVERY, 1);
306 trackdb_env->set_verbose(trackdb_env, DB_VERB_REPLICATION, 1);
307 D(("initialized database environment"));
310 /** @brief Called when deadlock manager terminates */
311 static int reap_db_deadlock(ev_source attribute((unused)) *ev,
312 pid_t attribute((unused)) pid,
314 const struct rusage attribute((unused)) *rusage,
315 void attribute((unused)) *u) {
316 db_deadlock_pid = -1;
318 disorder_fatal(0, "deadlock manager unexpectedly terminated: %s",
321 D(("deadlock manager terminated: %s", wstat(status)));
325 /** @brief Start a subprogram
326 * @param ev Event loop
327 * @param outputfd File descriptor to redirect @c stdout to, or -1
328 * @param prog Program name
329 * @param ... Arguments
332 * Starts a subprocess. Adds the following arguments:
333 * - @c --config to ensure the right config file is used
334 * - @c --debug or @c --no-debug to match debug settings
335 * - @c --syslog or @c --no-syslog to match log settings
337 static pid_t subprogram(ev_source *ev, int outputfd, const char *prog,
341 const char *args[1024], **argp, *a;
345 *argp++ = "--config";
346 *argp++ = configfile;
347 *argp++ = debugging ? "--debug" : "--no-debug";
348 *argp++ = log_default == &log_syslog ? "--syslog" : "--no-syslog";
350 while((a = va_arg(ap, const char *)))
354 /* If we're in the background then trap subprocess stdout/stderr */
355 if(!(pid = xfork())) {
358 ev_signal_atfork(ev);
359 signal(SIGPIPE, SIG_DFL);
364 /* ensure we don't leak privilege anywhere */
365 if(setuid(geteuid()) < 0)
366 disorder_fatal(errno, "error calling setuid");
367 /* If we were negatively niced, undo it. We don't bother checking for
368 * error, it's not that important. */
369 setpriority(PRIO_PROCESS, 0, 0);
370 execvp(prog, (char **)args);
371 disorder_fatal(errno, "error invoking %s", prog);
376 /** @brief Start deadlock manager
377 * @param ev Event loop
379 * Called from the main server (only).
381 void trackdb_master(ev_source *ev) {
382 assert(db_deadlock_pid == -1);
383 db_deadlock_pid = subprogram(ev, -1, DEADLOCK, (char *)0);
384 ev_child(ev, db_deadlock_pid, 0, reap_db_deadlock, 0);
385 D(("started deadlock manager"));
388 /** @brief Kill a subprocess and wait for it to terminate
389 * @param ev Event loop or NULL
390 * @param pid Process ID or -1
391 * @param what Description of subprocess
393 * Used during trackdb_deinit(). This function blocks so don't use it for
394 * normal teardown as that will hang the server.
396 static void terminate_and_wait(ev_source *ev,
403 if(kill(pid, SIGTERM) < 0)
404 disorder_fatal(errno, "error killing %s", what);
405 /* wait for the rescanner to finish */
406 while(waitpid(pid, &err, 0) == -1 && errno == EINTR)
409 ev_child_cancel(ev, pid);
412 /** @brief Close database environment
413 * @param ev Event loop
415 void trackdb_deinit(ev_source *ev) {
419 assert(initialized == 1);
422 /* close the environment */
423 if((err = trackdb_env->close(trackdb_env, 0)))
424 disorder_fatal(0, "trackdb_env->close: %s", db_strerror(err));
426 terminate_and_wait(ev, rescan_pid, "disorder-rescan");
428 terminate_and_wait(ev, choose_pid, "disorder-choose");
432 char **ks = hash_keys(stats_pids);
435 pid_t pid = atoi(*ks++);
436 terminate_and_wait(ev, pid, "disorder-stats");
441 terminate_and_wait(ev, db_deadlock_pid, "disorder-deadlock");
442 db_deadlock_pid = -1;
443 D(("deinitialized database environment"));
446 /** @brief Open a specific database
447 * @param path Relative path to database
448 * @param dbflags Database flags: DB_DUP, DB_DUPSORT, etc
449 * @param dbtype Database type: DB_HASH, DB_BTREE, etc
450 * @param openflags Open flags: DB_RDONLY, DB_CREATE, etc
451 * @param mode Permission mask: usually 0666
452 * @return Database handle
454 static DB *open_db(const char *path,
462 D(("open %s", path));
463 path = config_get_file(path);
464 if((err = db_create(&db, trackdb_env, 0)))
465 disorder_fatal(0, "db_create %s: %s", path, db_strerror(err));
467 if((err = db->set_flags(db, dbflags)))
468 disorder_fatal(0, "db->set_flags %s: %s", path, db_strerror(err));
469 if(dbtype == DB_BTREE)
470 if((err = db->set_bt_compare(db, compare)))
471 disorder_fatal(0, "db->set_bt_compare %s: %s", path, db_strerror(err));
472 if((err = db->open(db, 0, path, 0, dbtype,
473 openflags | DB_AUTO_COMMIT, mode))) {
474 if((openflags & DB_CREATE) || errno != ENOENT) {
475 if((err2 = db->close(db, 0)))
476 disorder_error(0, "db->close: %s", db_strerror(err2));
478 trackdb_env->close(trackdb_env,0);
480 disorder_fatal(0, "db->open %s: %s", path, db_strerror(err));
488 /** @brief Open track databases
489 * @param flags Flags flags word
491 * @p flags should have one of:
492 * - @p TRACKDB_NO_UPGRADE, if no upgrade should be attempted
493 * - @p TRACKDB_CAN_UPGRADE, if an upgrade may be attempted
494 * - @p TRACKDB_OPEN_FOR_UPGRADE, if this is disorder-dbupgrade
496 * - @p TRACKDB_READ_ONLY, read only access
498 void trackdb_open(int flags) {
501 uint32_t dbflags = flags & TRACKDB_READ_ONLY ? DB_RDONLY : DB_CREATE;
506 /* check the database version first */
507 trackdb_globaldb = open_db("global.db", 0, DB_HASH, DB_RDONLY, 0666);
508 if(trackdb_globaldb) {
509 /* This is an existing database */
513 s = trackdb_get_global("_dbversion");
514 /* Close the database again, we'll open it property below */
515 if((err = trackdb_globaldb->close(trackdb_globaldb, 0)))
516 disorder_fatal(0, "error closing global.db: %s", db_strerror(err));
517 trackdb_globaldb = 0;
518 /* Convert version string to an integer */
519 oldversion = s ? atol(s) : 1;
520 if(oldversion > config->dbversion) {
521 /* Database is from the future; we never allow this. */
522 disorder_fatal(0, "this version of DisOrder is too old for database version %ld",
525 if(oldversion < config->dbversion) {
526 /* Database version is out of date */
527 switch(flags & TRACKDB_UPGRADE_MASK) {
528 case TRACKDB_NO_UPGRADE:
529 /* This database needs upgrading but this is not permitted */
530 disorder_fatal(0, "database needs upgrading from %ld to %ld",
531 oldversion, config->dbversion);
532 case TRACKDB_CAN_UPGRADE:
533 /* This database needs upgrading */
534 disorder_info("invoking disorder-dbupgrade to upgrade from %ld to %ld",
535 oldversion, config->dbversion);
536 pid = subprogram(0, -1, "disorder-dbupgrade", (char *)0);
537 while(waitpid(pid, &err, 0) == -1 && errno == EINTR)
540 disorder_fatal(0, "disorder-dbupgrade %s", wstat(err));
541 disorder_info("disorder-dbupgrade succeeded");
543 case TRACKDB_OPEN_FOR_UPGRADE:
549 if(oldversion == config->dbversion && (flags & TRACKDB_OPEN_FOR_UPGRADE)) {
550 /* This doesn't make any sense */
551 disorder_fatal(0, "database is already at current version");
553 trackdb_existing_database = 1;
555 if(flags & TRACKDB_OPEN_FOR_UPGRADE) {
556 /* Cannot upgrade a new database */
557 disorder_fatal(0, "cannot upgrade a database that does not exist");
559 /* This is a brand new database */
560 trackdb_existing_database = 0;
562 /* open the databases */
563 if(!(trackdb_usersdb = open_db("users.db",
564 0, DB_HASH, dbflags, 0600)))
565 disorder_fatal(0, "cannot open users.db");
566 trackdb_tracksdb = open_db("tracks.db",
567 DB_RECNUM, DB_BTREE, dbflags, 0666);
568 trackdb_searchdb = open_db("search.db",
569 DB_DUP|DB_DUPSORT, DB_HASH, dbflags, 0666);
570 trackdb_tagsdb = open_db("tags.db",
571 DB_DUP|DB_DUPSORT, DB_HASH, dbflags, 0666);
572 trackdb_prefsdb = open_db("prefs.db", 0, DB_HASH, dbflags, 0666);
573 trackdb_globaldb = open_db("global.db", 0, DB_HASH, dbflags, 0666);
574 trackdb_noticeddb = open_db("noticed.db",
575 DB_DUPSORT, DB_BTREE, dbflags, 0666);
576 trackdb_scheduledb = open_db("schedule.db", 0, DB_HASH, dbflags, 0666);
577 trackdb_playlistsdb = open_db("playlists.db", 0, DB_HASH, dbflags, 0666);
578 if(!trackdb_existing_database && !(flags & TRACKDB_READ_ONLY)) {
579 /* Stash the database version */
582 assert(!(flags & TRACKDB_OPEN_FOR_UPGRADE));
583 snprintf(buf, sizeof buf, "%ld", config->dbversion);
584 trackdb_set_global("_dbversion", buf, 0);
586 D(("opened databases"));
589 /** @brief Close track databases */
590 void trackdb_close(void) {
596 #define CLOSE(N, V) do { \
597 if(V && (err = V->close(V, 0))) \
598 disorder_fatal(0, "error closing %s: %s", N, db_strerror(err)); \
601 CLOSE("tracks.db", trackdb_tracksdb);
602 CLOSE("search.db", trackdb_searchdb);
603 CLOSE("tags.db", trackdb_tagsdb);
604 CLOSE("prefs.db", trackdb_prefsdb);
605 CLOSE("global.db", trackdb_globaldb);
606 CLOSE("noticed.db", trackdb_noticeddb);
607 CLOSE("schedule.db", trackdb_scheduledb);
608 CLOSE("users.db", trackdb_usersdb);
609 CLOSE("playlists.db", trackdb_playlistsdb);
610 D(("closed databases"));
613 /* generic db routines *******************************************************/
615 /** @brief Fetch and decode a database entry
617 * @param track Track name
618 * @param kp Where to put decoded list (or NULL if you don't care)
619 * @param tid Owning transaction
620 * @return 0, @c DB_NOTFOUND or @c DB_LOCK_DEADLOCK
622 int trackdb_getdata(DB *db,
629 switch(err = db->get(db, tid, make_key(&key, track),
630 prepare_data(&data), 0)) {
633 *kp = kvp_urldecode(data.data, data.size);
639 case DB_LOCK_DEADLOCK:
640 disorder_error(0, "error querying database: %s", db_strerror(err));
643 disorder_fatal(0, "error querying database: %s", db_strerror(err));
647 /** @brief Encode and store a database entry
649 * @param track Track name
650 * @param k List of key/value pairs to store
651 * @param tid Owning transaction
652 * @param flags DB flags e.g. DB_NOOVERWRITE
653 * @return 0, DB_KEYEXIST or DB_LOCK_DEADLOCK
655 int trackdb_putdata(DB *db,
663 switch(err = db->put(db, tid, make_key(&key, track),
664 encode_data(&data, k), flags)) {
668 case DB_LOCK_DEADLOCK:
669 disorder_error(0, "error updating database: %s", db_strerror(err));
672 disorder_fatal(0, "error updating database: %s", db_strerror(err));
676 /** @brief Delete a database entry
678 * @param track Key to delete
679 * @param tid Transaction ID
680 * @return 0, DB_NOTFOUND or DB_LOCK_DEADLOCK
682 int trackdb_delkey(DB *db,
688 switch(err = db->del(db, tid, make_key(&key, track), 0)) {
692 case DB_LOCK_DEADLOCK:
693 disorder_error(0, "error updating database: %s", db_strerror(err));
696 disorder_fatal(0, "error updating database: %s", db_strerror(err));
700 /** @brief Open a database cursor
702 * @param tid Owning transaction
705 DBC *trackdb_opencursor(DB *db, DB_TXN *tid) {
709 switch(err = db->cursor(db, tid, &c, 0)) {
711 default: disorder_fatal(0, "error creating cursor: %s", db_strerror(err));
716 /** @brief Close a database cursor
718 * @return 0 or DB_LOCK_DEADLOCK
720 int trackdb_closecursor(DBC *c) {
724 switch(err = c->c_close(c)) {
727 case DB_LOCK_DEADLOCK:
728 disorder_error(0, "error closing cursor: %s", db_strerror(err));
731 disorder_fatal(0, "error closing cursor: %s", db_strerror(err));
735 /** @brief Delete a key/data pair
739 * @param tid Owning transaction
740 * @return 0, DB_NOTFOUND or DB_LOCK_DEADLOCK
742 * Used by the search and tags databases, hence the odd parameter names.
743 * See also register_word().
745 int trackdb_delkeydata(DB *db,
753 c = trackdb_opencursor(db, tid);
754 switch(err = c->c_get(c, make_key(&key, word),
755 make_key(&data, track), DB_GET_BOTH)) {
757 switch(err = c->c_del(c, 0)) {
763 case DB_LOCK_DEADLOCK:
764 disorder_error(0, "error updating database: %s", db_strerror(err));
767 disorder_fatal(0, "c->c_del: %s", db_strerror(err));
772 case DB_LOCK_DEADLOCK:
773 disorder_error(0, "error updating database: %s", db_strerror(err));
776 disorder_fatal(0, "c->c_get: %s", db_strerror(err));
778 if(trackdb_closecursor(c)) err = DB_LOCK_DEADLOCK;
782 /** @brief Start a transaction
783 * @return Transaction
785 DB_TXN *trackdb_begin_transaction(void) {
789 if((err = trackdb_env->txn_begin(trackdb_env, 0, &tid, 0)))
790 disorder_fatal(0, "trackdb_env->txn_begin: %s", db_strerror(err));
794 /** @brief Abort transaction
795 * @param tid Transaction (or NULL)
797 * If @p tid is NULL then nothing happens.
799 void trackdb_abort_transaction(DB_TXN *tid) {
803 if((err = tid->abort(tid)))
804 disorder_fatal(0, "tid->abort: %s", db_strerror(err));
807 /** @brief Commit transaction
808 * @param tid Transaction (must not be NULL)
810 void trackdb_commit_transaction(DB_TXN *tid) {
813 if((err = tid->commit(tid, 0)))
814 disorder_fatal(0, "tid->commit: %s", db_strerror(err));
817 /* search/tags shared code ***************************************************/
819 /** @brief Comparison function used by dedupe()
820 * @param a Pointer to first key
821 * @param b Pointer to second key
826 static int wordcmp(const void *a, const void *b) {
827 return strcmp(*(const char **)a, *(const char **)b);
830 /** @brief Sort and de-duplicate @p vec
831 * @param vec Vector to sort
832 * @param nvec Length of @p vec
835 * The returned vector is NULL-terminated, and there must be room for this NULL
836 * even if there are no duplicates (i.e. it must have more than @p nvec
839 static char **dedupe(char **vec, int nvec) {
842 qsort(vec, nvec, sizeof (char *), wordcmp);
846 for(n = 1; n < nvec; ++n)
847 if(strcmp(vec[n], vec[m - 1]))
854 /** @brief Store a key/data pair
856 * @param what Description
859 * @param tid Owning transaction
860 * @return 0 or DB_DEADLOCK
862 * Used by the search and tags databases, hence the odd parameter names.
863 * See also trackdb_delkeydata().
865 static int register_word(DB *db, const char *what,
866 const char *track, const char *word,
871 switch(err = db->put(db, tid, make_key(&key, word),
872 make_key(&data, track), DB_NODUPDATA)) {
876 case DB_LOCK_DEADLOCK:
877 disorder_error(0, "error updating %s.db: %s", what, db_strerror(err));
880 disorder_fatal(0, "error updating %s.db: %s", what, db_strerror(err));
884 /* search primitives *********************************************************/
886 /** @brief Return true iff @p name is a trackname_display_ pref
887 * @param name Preference name
888 * @return Non-zero iff @p name is a trackname_display_ pref
890 static int is_display_pref(const char *name) {
891 static const char prefix[] = "trackname_display_";
892 return !strncmp(name, prefix, (sizeof prefix) - 1);
895 /** @brief Word_Break property tailor that treats underscores as spaces
896 * @param c Code point
897 * @return Tailored property or -1 to use standard value
899 * Passed to utf32_word_split() when splitting a track name into words.
900 * See word_split() and @ref unicode_property_tailor.
902 static int tailor_underscore_Word_Break_Other(uint32_t c) {
906 case 0x005F: /* LOW LINE (SPACING UNDERSCORE) */
907 return unicode_Word_Break_Other;
911 /** @brief Remove all combining characters in-place
912 * @param s Pointer to start of string
913 * @param ns Length of string
914 * @return New, possiblby reduced, length
916 static size_t remove_combining_chars(uint32_t *s, size_t ns) {
917 uint32_t *start = s, *t = s, *end = s + ns;
920 const uint32_t c = *s++;
921 if(!utf32_combining_class(c))
927 /** @brief Normalize and split a string using a given tailoring
928 * @param v Where to store words from string
929 * @param s Input string
930 * @param pt Word_Break property tailor, or NULL
932 * The output words will be:
934 * - have any combination characters stripped
935 * - not include any word break code points (as tailored)
937 * Used by track_to_words(), with @p pt set to @ref
938 * tailor_underscore_Word_Break_Other, and by normalize_tag() with no
941 static void word_split(struct vector *v,
943 unicode_property_tailor *pt) {
945 uint32_t *t32, **w32;
947 /* Convert to UTF-32 */
948 if(!(t32 = utf8_to_utf32(s, strlen(s), &nt32)))
950 /* Erase case distinctions */
951 if(!(t32 = utf32_casefold_compat(t32, nt32, &nt32)))
953 /* Drop combining characters */
954 nt32 = remove_combining_chars(t32, nt32);
955 /* Split into words, treating _ as a space */
956 w32 = utf32_word_split(t32, nt32, &nw, pt);
957 /* Convert words back to UTF-8 and append to result */
958 for(i = 0; i < nw; ++i)
959 vector_append(v, utf32_to_utf8(w32[i], utf32_len(w32[i]), 0));
962 /** @brief Normalize a tag
964 * @param ns Length of tag
965 * @return Normalized string or NULL on error
967 * The return value will be:
969 * - have no leading or trailing space
970 * - have no combining characters
971 * - all spacing between words will be a single U+0020 SPACE
973 static char *normalize_tag(const char *s, size_t ns) {
974 uint32_t *s32, **w32;
975 size_t ns32, nw32, i;
978 if(!(s32 = utf8_to_utf32(s, ns, &ns32)))
980 if(!(s32 = utf32_casefold_compat(s32, ns32, &ns32))) /* ->NFKD */
982 ns32 = remove_combining_chars(s32, ns32);
983 /* Split into words, no Word_Break tailoring */
984 w32 = utf32_word_split(s32, ns32, &nw32, 0);
985 /* Compose back into a string */
987 for(i = 0; i < nw32; ++i) {
989 dynstr_append(d, ' ');
990 dynstr_append_string(d, utf32_to_utf8(w32[i], utf32_len(w32[i]), 0));
996 /** @brief Compute the words of a track name
997 * @param track Track name
998 * @param p Preferences (for display prefs)
999 * @return NULL-terminated, de-duplicated list or words
1001 static char **track_to_words(const char *track,
1002 const struct kvp *p) {
1004 const char *rootless = track_rootless(track);
1007 rootless = track; /* bodge */
1009 rootless = strip_extension(rootless);
1010 word_split(&v, strip_extension(rootless), tailor_underscore_Word_Break_Other);
1011 for(; p; p = p->next)
1012 if(is_display_pref(p->name))
1013 word_split(&v, p->value, 0);
1014 vector_terminate(&v);
1015 return dedupe(v.vec, v.nvec);
1018 /** @brief Test for a stopword
1020 * @return Non-zero if @p word is a stopword
1022 static int stopword(const char *word) {
1025 for(n = 0; n < config->stopword.n
1026 && strcmp(word, config->stopword.s[n]); ++n)
1028 return n < config->stopword.n;
1031 /** @brief Register a search term
1032 * @param track Track name
1033 * @param word A word that appears in the name of @p track
1034 * @param tid Owning transaction
1035 * @return 0 or DB_LOCK_DEADLOCK
1037 static int register_search_word(const char *track, const char *word,
1039 if(stopword(word)) return 0;
1040 return register_word(trackdb_searchdb, "search", track, word, tid);
1043 /* Tags **********************************************************************/
1045 /** @brief Test for tag characters
1046 * @param c Character
1047 * @return Non-zero if @p c is a tag character
1049 * The current rule is that commas and the control characters 0-31 are not
1050 * allowed but anything else is permitted. This is arguably a bit loose.
1052 static int tagchar(int c) {
1061 /** @brief Parse a tag list
1062 * @param s Tag list or NULL (equivalent to "")
1063 * @return Parsed tag list
1065 * The tags will be normalized (as per normalize_tag()) and de-duplicated.
1067 char **parsetags(const char *s) {
1073 /* skip initial separators */
1074 while(*s && (!tagchar(*s) || *s == ' '))
1077 /* find the extent of the tag */
1079 while(*s && tagchar(*s))
1081 /* strip trailing spaces */
1082 while(s > t && s[-1] == ' ')
1084 /* add tag to list */
1085 vector_append(&v, normalize_tag(t, (size_t)(s - t)));
1086 /* skip intermediate and trailing separators */
1087 while(*s && (!tagchar(*s) || *s == ' '))
1091 vector_terminate(&v);
1092 return dedupe(v.vec, v.nvec);
1095 /** @brief Register a tag
1096 * @param track Track name
1097 * @param tag Tag name
1098 * @param tid Owning transaction
1099 * @return 0 or DB_LOCK_DEADLOCK
1101 static int register_tag(const char *track, const char *tag, DB_TXN *tid) {
1102 return register_word(trackdb_tagsdb, "tags", track, tag, tid);
1105 /* aliases *******************************************************************/
1107 /** @brief Compute an alias
1108 * @param aliasp Where to put alias (gets NULL if none)
1109 * @param track Track to find alias for
1110 * @param p Prefs for @p track
1111 * @param tid Owning transaction
1112 * @return 0 or DB_LOCK_DEADLOCK
1114 * This function looks up the track name parts for @p track. By default these
1115 * amount to the original values from the track name but are overridden by
1118 * These values are then substituted into the pattern defined by the @b alias
1119 * command; see disorder_config(5) for the syntax.
1121 * The track is only considered to have an alias if all of the following are
1123 * - a preference was used for at least one name part
1124 * - the result differs from the original track name
1125 * - the result does not match any existing track or alias
1127 static int compute_alias(char **aliasp,
1129 const struct kvp *p,
1132 const char *s = config->alias, *t, *expansion, *part;
1133 int c, used_db = 0, slash_prefix, err;
1135 const char *const root = find_track_root(track);
1138 /* Bodge for tracks with no root */
1143 dynstr_append_string(&d, root);
1144 while((c = (unsigned char)*s++)) {
1146 dynstr_append(&d, c);
1149 if((slash_prefix = (*s == '/')))
1152 assert(t != 0); /* validated at startup */
1153 part = xstrndup(s, t - s);
1154 expansion = getpart(track, "display", part, p, &used_db);
1156 if(slash_prefix) dynstr_append(&d, '/');
1157 dynstr_append_string(&d, expansion);
1159 s = t + 1; /* skip {part} */
1161 /* only admit to the alias if we used the db... */
1166 dynstr_terminate(&d);
1167 /* ...and the answer differs from the original... */
1168 if(!strcmp(track, d.vec)) {
1172 /* ...and there isn't already a different track with that name (including as
1174 switch(err = trackdb_getdata(trackdb_tracksdb, d.vec, &at, tid)) {
1176 if((s = kvp_get(at, "_alias_for"))
1177 && !strcmp(s, track)) {
1190 /** @brief Assert that no alias is allowed for gettrackdata() */
1191 #define GTD_NOALIAS 0x0001
1193 /** @brief Get all track data
1194 * @param track Track to look up; aliases allowed unless @ref GTD_NOALIAS
1195 * @param tp Where to put track data (if not NULL)
1196 * @param pp Where to put preferences (if not NULL)
1197 * @param actualp Where to put real (i.e. non-alias) path (if not NULL)
1198 * @param flags Flag values, see below
1199 * @param tid Owning transaction
1200 * @return 0, DB_NOTFOUND (track doesn't exist) or DB_LOCK_DEADLOCK
1202 * Possible flags values are:
1203 * - @ref GTD_NOALIAS to assert that an alias is not allowed
1205 * The return values are always set (even if to NULL).
1207 static int gettrackdata(const char *track,
1210 const char **actualp,
1214 const char *actual = track;
1215 struct kvp *t = 0, *p = 0;
1217 if((err = trackdb_getdata(trackdb_tracksdb, track, &t, tid))) goto done;
1218 if((actual = kvp_get(t, "_alias_for"))) {
1219 if(flags & GTD_NOALIAS) {
1221 "alias passed to gettrackdata where real path required");
1224 if((err = trackdb_getdata(trackdb_tracksdb, actual, &t, tid))) goto done;
1227 assert(actual != 0);
1229 if((err = trackdb_getdata(trackdb_prefsdb, actual, &p, tid)) == DB_LOCK_DEADLOCK)
1234 if(actualp) *actualp = actual;
1240 /* trackdb_notice() **********************************************************/
1242 /** @brief Notice a possibly new track
1243 * @param track NFC UTF-8 track name
1244 * @param path Raw path name (i.e. the bytes that came out of readdir())
1245 * @return @c DB_NOTFOUND if new, 0 if already known
1247 * @c disorder-rescan is responsible for normalizing the track name.
1249 int trackdb_notice(const char *track,
1255 tid = trackdb_begin_transaction();
1256 err = trackdb_notice_tid(track, path, tid);
1257 if(err == DB_LOCK_DEADLOCK) goto fail;
1260 trackdb_abort_transaction(tid);
1262 trackdb_commit_transaction(tid);
1266 /** @brief Notice a possibly new track
1267 * @param track NFC UTF-8 track name
1268 * @param path Raw path name (i.e. the bytes that came out of readdir())
1269 * @param tid Owning transaction
1270 * @return @c DB_NOTFOUND if new, 0 if already known, @c DB_LOCK_DEADLOCK also
1272 * @c disorder-rescan is responsible for normalizing the track name.
1274 int trackdb_notice_tid(const char *track,
1278 struct kvp *t, *a, *p;
1280 char *alias, **w, *noticed;
1283 /* notice whether the tracks.db entry changes */
1285 /* get any existing tracks entry */
1286 if((err = gettrackdata(track, &t, &p, 0, 0, tid)) == DB_LOCK_DEADLOCK)
1288 ret = err; /* 0 or DB_NOTFOUND */
1289 /* this is a real track */
1290 t_changed += kvp_set(&t, "_alias_for", 0);
1291 t_changed += kvp_set(&t, "_path", path);
1293 if(ret == DB_NOTFOUND) {
1294 /* It's a new track; record the time */
1295 byte_xasprintf(¬iced, "%lld", (long long)now);
1296 t_changed += kvp_set(&t, "_noticed", noticed);
1298 /* if we have an alias record it in the database */
1299 if((err = compute_alias(&alias, track, p, tid))) return err;
1301 /* won't overwrite someone else's alias as compute_alias() checks */
1302 D(("%s: alias %s", track, alias));
1304 kvp_set(&a, "_alias_for", track);
1305 if((err = trackdb_putdata(trackdb_tracksdb, alias, a, tid, 0))) return err;
1307 /* update search.db */
1308 w = track_to_words(track, p);
1309 for(n = 0; w[n]; ++n)
1310 if((err = register_search_word(track, w[n], tid)))
1312 /* update tags.db */
1313 w = parsetags(kvp_get(p, "tags"));
1314 for(n = 0; w[n]; ++n)
1315 if((err = register_tag(track, w[n], tid)))
1317 /* only store the tracks.db entry if it has changed */
1318 if(t_changed && (err = trackdb_putdata(trackdb_tracksdb, track, t, tid, 0)))
1320 if(ret == DB_NOTFOUND) {
1321 uint32_t timestamp[2];
1324 timestamp[0] = htonl((uint64_t)now >> 32);
1325 timestamp[1] = htonl((uint32_t)now);
1326 memset(&key, 0, sizeof key);
1327 key.data = timestamp;
1328 key.size = sizeof timestamp;
1329 switch(err = trackdb_noticeddb->put(trackdb_noticeddb, tid, &key,
1330 make_key(&data, track), 0)) {
1332 case DB_LOCK_DEADLOCK: return err;
1334 disorder_fatal(0, "error updating noticed.db: %s", db_strerror(err));
1340 /* trackdb_obsolete() ********************************************************/
1342 /** @brief Obsolete a track
1343 * @param track Track name
1344 * @param tid Owning transaction
1345 * @return 0 or DB_LOCK_DEADLOCK
1347 * Discards a track from the database when it's known not to exist any more.
1348 * Returns 0 even if it wasn't recorded.
1350 int trackdb_obsolete(const char *track, DB_TXN *tid) {
1355 if((err = gettrackdata(track, 0, &p, 0,
1356 GTD_NOALIAS, tid)) == DB_LOCK_DEADLOCK)
1358 else if(err == DB_NOTFOUND) return 0;
1359 /* compute the alias, if any, and delete it */
1360 if((err = compute_alias(&alias, track, p, tid))) return err;
1362 /* if the alias points to some other track then compute_alias won't
1364 if((err = trackdb_delkey(trackdb_tracksdb, alias, tid))
1365 && err != DB_NOTFOUND)
1368 /* update search.db */
1369 w = track_to_words(track, p);
1370 for(n = 0; w[n]; ++n)
1371 if(trackdb_delkeydata(trackdb_searchdb,
1372 w[n], track, tid) == DB_LOCK_DEADLOCK)
1374 /* update tags.db */
1375 w = parsetags(kvp_get(p, "tags"));
1376 for(n = 0; w[n]; ++n)
1377 if(trackdb_delkeydata(trackdb_tagsdb,
1378 w[n], track, tid) == DB_LOCK_DEADLOCK)
1380 /* update tracks.db */
1381 if(trackdb_delkey(trackdb_tracksdb, track, tid) == DB_LOCK_DEADLOCK)
1383 /* We don't delete the prefs, so they survive temporary outages of the
1384 * (possibly virtual) track filesystem */
1388 /* trackdb_stats() ***********************************************************/
1390 #define H(name) { #name, offsetof(DB_HASH_STAT, name) }
1391 #define B(name) { #name, offsetof(DB_BTREE_STAT, name) }
1393 /** @brief Table of libdb stats to return */
1394 static const struct statinfo {
1397 } statinfo_hash[] = {
1413 }, statinfo_btree[] = {
1434 /** @brief Look up DB statistics
1435 * @param v Where to store stats
1436 * @param database Database
1437 * @param si Pointer to table of stats
1438 * @param nsi Size of @p si
1439 * @param tid Owning transaction
1440 * @return 0 or DB_LOCK_DEADLOCK
1442 static int get_stats(struct vector *v,
1444 const struct statinfo *si,
1453 switch(err = database->stat(database, tid, &sp, 0)) {
1456 case DB_LOCK_DEADLOCK:
1457 disorder_error(0, "error querying database: %s", db_strerror(err));
1460 disorder_fatal(0, "error querying database: %s", db_strerror(err));
1462 for(n = 0; n < nsi; ++n) {
1463 byte_xasprintf(&str, "%s=%"PRIuMAX, si[n].name,
1464 (uintmax_t)*(u_int32_t *)((char *)sp + si[n].offset));
1465 vector_append(v, str);
1471 /** @brief One entry in the search league */
1472 struct search_entry {
1477 /** @brief Add a word to the search league
1478 * @param se Pointer to search league
1479 * @param count Maximum size for search league
1480 * @param nse Current size of search league
1481 * @param word New word, or NULL
1482 * @param n How often @p word appears
1483 * @return New size of search league
1485 static int register_search_entry(struct search_entry *se,
1492 if(word && (nse < count || n > se[nse - 1].n)) {
1493 /* Find the starting point */
1498 /* Find the insertion point */
1499 while(i > 0 && n > se[i - 1].n)
1501 memmove(&se[i + 1], &se[i], (nse - i - 1) * sizeof *se);
1508 /** @brief Find the top @p count words in the search database
1509 * @param v Where to format the result
1510 * @param count Maximum number of words
1511 * @param tid Owning transaction
1512 * @return 0 or DB_LOCK_DEADLOCK
1514 static int search_league(struct vector *v, int count, DB_TXN *tid) {
1515 struct search_entry *se;
1518 int err, n = 0, nse = 0, i;
1523 cursor = trackdb_opencursor(trackdb_searchdb, tid);
1524 se = xmalloc(count * sizeof *se);
1525 /* Walk across the whole database counting up the number of times each
1527 while(!(err = cursor->c_get(cursor, prepare_data(&k), prepare_data(&d),
1529 if(word && wl == k.size && !strncmp(word, k.data, wl))
1530 ++n; /* same word again */
1532 nse = register_search_entry(se, count, nse, word, n);
1533 word = xstrndup(k.data, wl = k.size);
1541 case DB_LOCK_DEADLOCK:
1542 disorder_error(0, "error querying search database: %s", db_strerror(err));
1545 disorder_fatal(0, "error querying search database: %s", db_strerror(err));
1547 if(trackdb_closecursor(cursor)) err = DB_LOCK_DEADLOCK;
1549 nse = register_search_entry(se, count, nse, word, n);
1550 byte_xasprintf(&str, "Top %d search words:", nse);
1551 vector_append(v, str);
1552 for(i = 0; i < nse; ++i) {
1553 byte_xasprintf(&str, "%4d: %5d %s", i + 1, se[i].n, se[i].word);
1554 vector_append(v, str);
1559 #define SI(what) statinfo_##what, \
1560 sizeof statinfo_##what / sizeof (struct statinfo)
1562 /** @brief Return a list of database stats
1563 * @param nstatsp Where to store number of lines (or NULL)
1564 * @return Database stats output
1566 * This is called by @c disorder-stats. Don't call it directly from elsewhere
1567 * as it can take unreasonably long.
1569 char **trackdb_stats(int *nstatsp) {
1575 tid = trackdb_begin_transaction();
1577 vector_append(&v, (char *)"Tracks database stats:");
1578 if(get_stats(&v, trackdb_tracksdb, SI(btree), tid)) goto fail;
1579 vector_append(&v, (char *)"");
1580 vector_append(&v, (char *)"Search database stats:");
1581 if(get_stats(&v, trackdb_searchdb, SI(hash), tid)) goto fail;
1582 vector_append(&v, (char *)"");
1583 vector_append(&v, (char *)"Prefs database stats:");
1584 if(get_stats(&v, trackdb_prefsdb, SI(hash), tid)) goto fail;
1585 vector_append(&v, (char *)"");
1586 if(search_league(&v, 10, tid)) goto fail;
1587 vector_terminate(&v);
1590 trackdb_abort_transaction(tid);
1592 trackdb_commit_transaction(tid);
1593 if(nstatsp) *nstatsp = v.nvec;
1597 /** @brief State structure tracking @c disorder-stats */
1598 struct stats_details {
1599 void (*done)(char *data, void *u);
1601 int exited; /* subprocess exited */
1602 int closed; /* pipe close */
1603 int wstat; /* wait status from subprocess */
1604 struct dynstr data[1]; /* data read from pipe */
1607 /** @brief Called when @c disorder-stats may have completed
1608 * @param d Pointer to state structure
1610 * Called from stats_finished() and stats_read(). Only proceeds when the
1611 * process has terminated and the output is complete.
1613 static void stats_complete(struct stats_details *d) {
1616 if(!(d->exited && d->closed))
1618 byte_xasprintf(&s, "\n"
1620 "track lookup cache hits: %lu\n"
1621 "track lookup cache misses: %lu\n",
1623 cache_files_misses);
1624 dynstr_append_string(d->data, s);
1625 dynstr_terminate(d->data);
1626 d->done(d->data->vec, d->u);
1629 /** @brief Called when @c disorder-stats exits
1630 * @param ev Event loop
1631 * @param pid Process ID
1632 * @param status Exit status
1633 * @param rusage Resource usage
1634 * @param u Pointer to state structure (@ref stats_details)
1637 static int stats_finished(ev_source attribute((unused)) *ev,
1640 const struct rusage attribute((unused)) *rusage,
1642 struct stats_details *const d = u;
1646 disorder_error(0, "disorder-stats %s", wstat(status));
1649 byte_xasprintf(&k, "%lu", (unsigned long)pid);
1650 hash_remove(stats_pids, k);
1654 /** @brief Called when pipe from @c disorder-stats is readable
1655 * @param ev Event loop
1656 * @param reader Reader state
1657 * @param ptr Pointer to bytes read
1658 * @param bytes Number of bytes available
1659 * @param eof Set at end of file
1660 * @param u Pointer to state structure (@ref stats_details)
1663 static int stats_read(ev_source attribute((unused)) *ev,
1669 struct stats_details *const d = u;
1671 dynstr_append_bytes(d->data, ptr, bytes);
1672 ev_reader_consume(reader, bytes);
1679 /** @brief Called when pipe from @c disorder-stats errors
1680 * @param ev Event loop
1681 * @param errno_value Error code
1682 * @param u Pointer to state structure (@ref stats_details)
1685 static int stats_error(ev_source attribute((unused)) *ev,
1688 struct stats_details *const d = u;
1690 disorder_error(errno_value, "error reading from pipe to disorder-stats");
1696 /** @brief Get database statistics via background process
1697 * @param ev Event loop
1698 * @param done Called on completion
1699 * @param u Passed to @p done
1701 * Within the main server use this instead of trackdb_stats(), which can take
1702 * unreasonably long.
1704 void trackdb_stats_subprocess(ev_source *ev,
1705 void (*done)(char *data, void *u),
1709 struct stats_details *d = xmalloc(sizeof *d);
1711 dynstr_init(d->data);
1715 pid = subprogram(ev, p[1], "disorder-stats", (char *)0);
1717 ev_child(ev, pid, 0, stats_finished, d);
1718 if(!ev_reader_new(ev, p[0], stats_read, stats_error, d,
1719 "disorder-stats reader"))
1720 disorder_fatal(0, "ev_reader_new for disorder-stats reader failed");
1721 /* Remember the PID */
1723 stats_pids = hash_new(1);
1725 byte_xasprintf(&k, "%lu", (unsigned long)pid);
1726 hash_add(stats_pids, k, "", HASH_INSERT);
1729 /** @brief Parse a track name part preference
1730 * @param name Preference name
1731 * @param partp Where to store part name
1732 * @param contextp Where to store context name
1733 * @return 0 on success, non-0 if parse fails
1735 static int trackdb__parse_namepref(const char *name,
1739 static const char prefix[] = "trackname_";
1741 if(strncmp(name, prefix, strlen(prefix)))
1742 return -1; /* not trackname_* at all */
1743 name += strlen(prefix);
1744 /* There had better be a _ between context and part */
1745 c = strchr(name, '_');
1748 /* Context is first in the pref name even though most APIs have the part
1749 * first. Confusing; sorry. */
1750 *contextp = xstrndup(name, c - name);
1752 /* There had better NOT be a second _ */
1755 *partp = xstrdup(c);
1759 /** @brief Compute the default value for a track preference
1760 * @param track Track name
1761 * @param name Preference name
1762 * @return Default value or 0 if none/not known
1764 static const char *trackdb__default(const char *track, const char *name) {
1765 char *context, *part;
1767 if(!trackdb__parse_namepref(name, &part, &context)) {
1768 /* We can work out the default for a trackname_ pref */
1769 return trackname_part(track, context, part);
1770 } else if(!strcmp(name, "weight")) {
1771 /* We know the default weight */
1773 } else if(!strcmp(name, "pick_at_random")) {
1774 /* By default everything is eligible for picking at random */
1776 } else if(!strcmp(name, "tags")) {
1777 /* By default everything no track has any tags */
1783 /** @brief Set a preference
1784 * @param track Track to modify
1785 * @param name Preference name
1786 * @param value New value, or NULL to erase any existing value
1787 * @return 0 on success or non-zero if not allowed to set preference
1789 int trackdb_set(const char *track,
1791 const char *value) {
1792 struct kvp *t, *p, *a;
1795 char *oldalias, *newalias, **oldtags = 0, **newtags;
1798 /* If the value matches the default then unset instead, to keep the database
1799 * tidy. Older versions did not have this feature so your database may yet
1800 * have some default values stored in it. */
1802 def = trackdb__default(track, name);
1803 if(def && !strcmp(value, def))
1808 tid = trackdb_begin_transaction();
1809 if((err = gettrackdata(track, &t, &p, 0,
1810 0, tid)) == DB_LOCK_DEADLOCK)
1812 if(err == DB_NOTFOUND) break;
1813 if(name[0] == '_') {
1814 if(kvp_set(&t, name, value))
1815 if(trackdb_putdata(trackdb_tracksdb, track, t, tid, 0))
1818 /* get the old alias name */
1819 if(compute_alias(&oldalias, track, p, tid)) goto fail;
1820 /* get the old tags */
1821 if(!strcmp(name, "tags"))
1822 oldtags = parsetags(kvp_get(p, "tags"));
1824 if(kvp_set(&p, name, value))
1825 if(trackdb_putdata(trackdb_prefsdb, track, p, tid, 0))
1827 /* compute the new alias name */
1828 if(compute_alias(&newalias, track, p, tid)) goto fail;
1829 /* check whether alias has changed */
1830 if(!(oldalias == newalias
1831 || (oldalias && newalias && !strcmp(oldalias, newalias)))) {
1832 /* adjust alias records to fit change */
1834 && trackdb_delkey(trackdb_tracksdb, oldalias, tid) == DB_LOCK_DEADLOCK)
1838 kvp_set(&a, "_alias_for", track);
1839 if(trackdb_putdata(trackdb_tracksdb, newalias, a, tid, 0)) goto fail;
1842 /* check whether tags have changed */
1843 if(!strcmp(name, "tags")) {
1844 newtags = parsetags(value);
1845 while(*oldtags || *newtags) {
1846 if(*oldtags && *newtags) {
1847 cmp = strcmp(*oldtags, *newtags);
1849 /* keeping this tag */
1853 /* old tag fits into a gap in the new list, so delete old */
1856 /* new tag fits into a gap in the old list, so insert new */
1858 } else if(*oldtags) {
1859 /* we've run out of new tags, so remaining old ones are to be
1862 if(trackdb_delkeydata(trackdb_tagsdb,
1863 *oldtags, track, tid) == DB_LOCK_DEADLOCK)
1867 /* we've run out of old tags, so remainig new ones are to be
1870 if(register_tag(track, *newtags, tid)) goto fail;
1879 trackdb_abort_transaction(tid);
1881 trackdb_commit_transaction(tid);
1882 return err == 0 ? 0 : -1;
1885 /** @brief Get the value of a preference
1886 * @param track Track name
1887 * @param name Preference name
1888 * @return Preference value or NULL if it's not set
1890 const char *trackdb_get(const char *track,
1892 return kvp_get(trackdb_get_all(track), name);
1895 /** @brief Get all preferences for a track
1896 * @param track Track name
1897 * @return Linked list of preferences
1899 struct kvp *trackdb_get_all(const char *track) {
1900 struct kvp *t, *p, **pp;
1904 tid = trackdb_begin_transaction();
1905 if(gettrackdata(track, &t, &p, 0, 0, tid) == DB_LOCK_DEADLOCK)
1909 trackdb_abort_transaction(tid);
1911 trackdb_commit_transaction(tid);
1912 for(pp = &p; *pp; pp = &(*pp)->next)
1918 /** @brief Resolve an alias
1919 * @param track Track name (might be an alias)
1920 * @return Real track name (definitely not an alias) or NULL if no such track
1922 const char *trackdb_resolve(const char *track) {
1927 tid = trackdb_begin_transaction();
1928 if(gettrackdata(track, 0, 0, &actual, 0, tid) == DB_LOCK_DEADLOCK)
1932 trackdb_abort_transaction(tid);
1934 trackdb_commit_transaction(tid);
1938 /** @brief Detect an alias
1939 * @param track Track name
1940 * @return Nonzero if @p track exists and is an alias
1942 int trackdb_isalias(const char *track) {
1943 const char *actual = trackdb_resolve(track);
1945 return strcmp(actual, track);
1948 /** @brief Detect whether a track exists
1949 * @param track Track name (can be an alias)
1950 * @return Nonzero if @p track exists (whether or not it's an alias)
1952 int trackdb_exists(const char *track) {
1957 tid = trackdb_begin_transaction();
1958 /* unusually, here we want the return value */
1959 if((err = gettrackdata(track, 0, 0, 0, 0, tid)) == DB_LOCK_DEADLOCK)
1963 trackdb_abort_transaction(tid);
1965 trackdb_commit_transaction(tid);
1969 /** @brief Return list of all known tags
1970 * @return NULL-terminated tag list
1972 char **trackdb_alltags(void) {
1977 WITH_TRANSACTION(trackdb_listkeys(trackdb_tagsdb, v, tid));
1981 /** @brief List all the keys in @p db
1982 * @param db Database
1983 * @param v Vector to store keys in
1984 * @param tid Transaction ID
1985 * @return 0 or DB_LOCK_DEADLOCK
1987 int trackdb_listkeys(DB *db, struct vector *v, DB_TXN *tid) {
1990 DBC *const c = trackdb_opencursor(db, tid);
1993 memset(&k, 0, sizeof k);
1994 while(!(e = c->c_get(c, &k, prepare_data(&d), DB_NEXT_NODUP)))
1995 vector_append(v, xstrndup(k.data, k.size));
1999 case DB_LOCK_DEADLOCK:
2002 disorder_fatal(0, "c->c_get: %s", db_strerror(e));
2004 if((e = trackdb_closecursor(c)))
2006 vector_terminate(v);
2010 /* return 1 iff sorted tag lists A and B have at least one member in common */
2011 /** @brief Detect intersecting tag lists
2012 * @param a First list of tags (NULL-terminated)
2013 * @param b Second list of tags (NULL-terminated)
2014 * @return 1 if @p a and @p b have at least one member in common
2016 * @p a and @p must be sorted.
2018 int tag_intersection(char **a, char **b) {
2021 /* Same sort of logic as trackdb_set() above */
2023 if(!(cmp = strcmp(*a, *b))) return 1;
2024 else if(cmp < 0) ++a;
2030 /** @brief Called when disorder-choose might have completed
2031 * @param ev Event loop
2032 * @param which @ref CHOOSE_RUNNING or @ref CHOOSE_READING
2034 * Once called with both @p which values, @ref choose_callback is called
2035 * (usually chosen_random_track()).
2037 static void choose_finished(ev_source *ev, unsigned which) {
2038 choose_complete |= which;
2039 if(choose_complete != (CHOOSE_RUNNING|CHOOSE_READING))
2042 if(choose_status == 0 && choose_output.nvec > 0) {
2043 dynstr_terminate(&choose_output);
2044 choose_callback(ev, xstrdup(choose_output.vec));
2046 choose_callback(ev, 0);
2049 /** @brief Called when @c disorder-choose terminates
2050 * @param ev Event loop
2051 * @param pid Process ID
2052 * @param status Exit status
2053 * @param rusage Resource usage
2054 * @param u User data
2057 static int choose_exited(ev_source *ev,
2058 pid_t attribute((unused)) pid,
2060 const struct rusage attribute((unused)) *rusage,
2061 void attribute((unused)) *u) {
2063 disorder_error(0, "disorder-choose %s", wstat(status));
2064 choose_status = status;
2065 choose_finished(ev, CHOOSE_RUNNING);
2069 /** @brief Called with data from @c disorder-choose pipe
2070 * @param ev Event loop
2071 * @param reader Reader state
2072 * @param ptr Data read
2073 * @param bytes Number of bytes read
2074 * @param eof Set at end of file
2075 * @param u User data
2078 static int choose_readable(ev_source *ev,
2083 void attribute((unused)) *u) {
2084 dynstr_append_bytes(&choose_output, ptr, bytes);
2085 ev_reader_consume(reader, bytes);
2087 choose_finished(ev, CHOOSE_READING);
2091 /** @brief Called when @c disorder-choose pipe errors
2092 * @param ev Event loop
2093 * @param errno_value Error code
2094 * @param u User data
2097 static int choose_read_error(ev_source *ev,
2099 void attribute((unused)) *u) {
2100 disorder_error(errno_value, "error reading disorder-choose pipe");
2101 choose_finished(ev, CHOOSE_READING);
2105 /** @brief Request a random track
2106 * @param ev Event source
2107 * @param callback Called with random track or NULL
2108 * @return 0 if a request was initiated, else -1
2110 * Initiates a random track choice. @p callback will later be called back with
2111 * the choice (or NULL on error). If a choice is already underway then -1 is
2112 * returned and there will be no additional callback.
2114 * The caller shouldn't assume that the track returned actually exists (it
2115 * might be removed between the choice and the callback, or between being added
2116 * to the queue and being played).
2118 int trackdb_request_random(ev_source *ev,
2119 random_callback *callback) {
2122 if(choose_pid != -1)
2123 return -1; /* don't run concurrent chooses */
2126 choose_pid = subprogram(ev, p[1], "disorder-choose", (char *)0);
2129 choose_callback = callback;
2130 choose_output.nvec = 0;
2131 choose_complete = 0;
2132 if(!ev_reader_new(ev, p[0], choose_readable, choose_read_error, 0,
2133 "disorder-choose reader")) /* owns p[0] */
2134 disorder_fatal(0, "ev_reader_new for disorder-choose reader failed");
2135 ev_child(ev, choose_pid, 0, choose_exited, 0); /* owns the subprocess */
2139 /** @brief Get a track name part, using prefs
2140 * @param track Track name
2141 * @param context Context ("display" etc)
2142 * @param part Part ("album" etc)
2143 * @param p Preference
2144 * @param used_db Set if a preference is used
2145 * @return Name part (never NULL)
2147 * Used by compute_alias() and trackdb_getpart().
2149 static const char *getpart(const char *track,
2150 const char *context,
2152 const struct kvp *p,
2157 byte_xasprintf(&pref, "trackname_%s_%s", context, part);
2158 if((result = kvp_get(p, pref)))
2161 result = trackname_part(track, context, part);
2162 assert(result != 0);
2166 /** @brief Get a track name part
2167 * @param track Track name
2168 * @param context Context ("display" etc)
2169 * @param part Part ("album" etc)
2170 * @return Name part (never NULL)
2172 * This is interface used by c_part().
2174 const char *trackdb_getpart(const char *track,
2175 const char *context,
2183 /* construct the full pref */
2184 byte_xasprintf(&pref, "trackname_%s_%s", context, part);
2186 tid = trackdb_begin_transaction();
2187 if(gettrackdata(track, 0, &p, &actual, 0, tid) == DB_LOCK_DEADLOCK)
2191 trackdb_abort_transaction(tid);
2193 trackdb_commit_transaction(tid);
2194 return getpart(actual, context, part, p, &used_db);
2197 /** @brief Get the raw (filesystem) path for @p track
2198 * @param track track Track name (can be an alias)
2199 * @return Raw path (never NULL)
2201 * The raw path is the actual bytes that came out of readdir() etc.
2203 const char *trackdb_rawpath(const char *track) {
2209 tid = trackdb_begin_transaction();
2210 if(gettrackdata(track, &t, 0, 0, 0, tid) == DB_LOCK_DEADLOCK)
2214 trackdb_abort_transaction(tid);
2216 trackdb_commit_transaction(tid);
2217 if(!(path = kvp_get(t, "_path"))) path = track;
2221 /* trackdb_list **************************************************************/
2223 /* this is incredibly ugly, sorry, perhaps it will be rewritten to be actually
2224 * readable at some point */
2226 /* return true if the basename of TRACK[0..TL-1], as defined by DL, matches RE.
2227 * If RE is a null pointer then it matches everything. */
2228 /** @brief Match a track against a rgeexp
2229 * @param dl Length of directory part of track
2230 * @param track Track name
2231 * @param tl Length of track name
2232 * @param re Regular expression or NULL
2233 * @return Nonzero on match
2235 * @p tl is the total length of @p track, @p dl is the length of the directory
2236 * part (the index of the final "/"). The subject of the regexp match is the
2237 * basename, i.e. the part after @p dl.
2239 * If @p re is NULL then always matches.
2241 static int track_matches(size_t dl, const char *track, size_t tl,
2250 switch(rc = regexp_match(re, track, tl, 0, ovec, 3)) {
2251 case RXERR_NOMATCH: return 0;
2254 disorder_error(0, "regexp_match returned %d, subject '%s'", rc, track);
2261 /** @brief Generate a list of tracks and/or directories in @p dir
2262 * @param v Where to put results
2263 * @param dir Directory to list
2264 * @param what Bitmap of objects to return
2265 * @param re Regexp to filter matches (or NULL to accept all)
2266 * @param tid Owning transaction
2267 * @return 0 or DB_LOCK_DEADLOCK
2269 static int do_list(struct vector *v, const char *dir,
2270 enum trackdb_listable what, const regexp *re, DB_TXN *tid) {
2276 size_t l, last_dir_len = 0;
2277 char *last_dir = 0, *track;
2281 cursor = trackdb_opencursor(trackdb_tracksdb, tid);
2284 /* find the first key >= dir */
2285 err = cursor->c_get(cursor, &k, &d, DB_SET_RANGE);
2286 /* keep going while we're dealing with <dir/anything> */
2289 && ((char *)k.data)[dl] == '/'
2290 && !memcmp(k.data, dir, dl)) {
2291 ptr = memchr((char *)k.data + dl + 1, '/', k.size - (dl + 1));
2293 /* we have <dir/component/anything>, so <dir/component> is a directory */
2294 l = ptr - (char *)k.data;
2295 if(what & trackdb_directories)
2297 && l == last_dir_len
2298 && !memcmp(last_dir, k.data, l))) {
2299 last_dir = xstrndup(k.data, last_dir_len = l);
2300 if(track_matches(dl, k.data, l, re))
2301 vector_append(v, last_dir);
2304 /* found a plain file */
2305 if((what & trackdb_files)) {
2306 track = xstrndup(k.data, k.size);
2307 if((err = trackdb_getdata(trackdb_prefsdb,
2308 track, &p, tid)) == DB_LOCK_DEADLOCK)
2310 /* There's an awkward question here...
2312 * If a track shares a directory with its alias then we could
2313 * do one of three things:
2314 * - report both. Looks ridiculuous in most UIs.
2315 * - report just the alias. Remarkably inconvenient to write
2317 * - report just the real name. Ugly if the UI doesn't prettify
2318 * names via the name parts.
2321 /* If this file is an alias for a track in the same directory then we
2323 struct kvp *t = kvp_urldecode(d.data, d.size);
2324 const char *alias_target = kvp_get(t, "_alias_for");
2326 && !strcmp(d_dirname(alias_target),
2328 if(track_matches(dl, k.data, k.size, re))
2329 vector_append(v, track);
2331 /* if this file has an alias in the same directory then we skip it */
2333 if((err = compute_alias(&alias, track, p, tid)))
2335 if(!(alias && !strcmp(d_dirname(alias), d_dirname(track))))
2336 if(track_matches(dl, k.data, k.size, re))
2337 vector_append(v, track);
2341 err = cursor->c_get(cursor, &k, &d, DB_NEXT);
2349 case DB_LOCK_DEADLOCK:
2350 disorder_error(0, "error querying database: %s", db_strerror(err));
2353 disorder_fatal(0, "error querying database: %s", db_strerror(err));
2356 if(trackdb_closecursor(cursor)) err = DB_LOCK_DEADLOCK;
2360 /** @brief Get the directories or files below @p dir
2361 * @param dir Directory to list
2362 * @param np Where to put number of results (or NULL)
2363 * @param what Bitmap of objects to return
2364 * @param re Regexp to filter matches (or NULL to accept all)
2365 * @return List of tracks
2367 char **trackdb_list(const char *dir, int *np, enum trackdb_listable what,
2375 tid = trackdb_begin_transaction();
2378 if(do_list(&v, dir, what, re, tid))
2381 for(n = 0; n < config->collection.n; ++n)
2382 if(do_list(&v, config->collection.s[n].root, what, re, tid))
2387 trackdb_abort_transaction(tid);
2389 trackdb_commit_transaction(tid);
2390 vector_terminate(&v);
2396 /** @brief Detect a tag element in a search string
2397 * @param s Element of search string
2398 * @return Pointer to tag name (in @p s) if this is a tag: search, else NULL
2400 * Tag searches take the form "tag:TAG".
2402 static const char *checktag(const char *s) {
2403 if(!strncmp(s, "tag:", 4))
2409 /* return a list of tracks containing all of the words given. If you
2410 * ask for only stopwords you get no tracks. */
2411 char **trackdb_search(char **wordlist, int nwordlist, int *ntracks) {
2412 const char **w, *best = 0, *tag;
2413 char **twords, **tags;
2415 int i, j, n, err, what;
2425 *ntracks = 0; /* for early returns */
2426 /* normalize all the words */
2427 w = xmalloc(nwordlist * sizeof (char *));
2428 istag = xmalloc_noptr(nwordlist);
2429 for(n = 0; n < nwordlist; ++n) {
2433 w[n] = utf8_casefold_compat(wordlist[n], strlen(wordlist[n]), 0);
2434 if(checktag(w[n])) {
2435 ++ntags; /* count up tags */
2436 /* Normalize the tag */
2437 w[n] = normalize_tag(w[n] + 4, strlen(w[n] + 4));
2440 /* Normalize the search term by removing combining characters */
2441 if(!(w32 = utf8_to_utf32(w[n], strlen(w[n]), &nw32)))
2443 nw32 = remove_combining_chars(w32, nw32);
2444 if(!(w[n] = utf32_to_utf8(w32, nw32, 0)))
2449 /* find the longest non-stopword */
2450 for(n = 0; n < nwordlist; ++n)
2451 if(!istag[n] && !stopword(w[n]))
2452 if(!best || strlen(w[n]) > strlen(best))
2454 /* TODO: we should at least in principal be able to identify the word or tag
2455 * with the least matches in log time, and choose that as our primary search
2457 if(ntags && !best) {
2458 /* Only tags are listed. We limit to the first and narrow down with the
2460 best = istag[0] ? w[0] : 0;
2461 db = trackdb_tagsdb;
2464 /* We can limit to some word. */
2465 db = trackdb_searchdb;
2468 /* Only stopwords */
2474 tid = trackdb_begin_transaction();
2475 /* find all the tracks that have that word */
2480 cursor = trackdb_opencursor(db, tid);
2481 while(!(err = cursor->c_get(cursor, &k, &d, what))) {
2482 vector_append(&v, xstrndup(d.data, d.size));
2489 case DB_LOCK_DEADLOCK:
2490 disorder_error(0, "error querying %s database: %s",
2491 dbname, db_strerror(err));
2494 disorder_fatal(0, "error querying %s database: %s",
2495 dbname, db_strerror(err));
2497 if(trackdb_closecursor(cursor)) err = DB_LOCK_DEADLOCK;
2502 /* do a naive search over that (hopefuly fairly small) list of tracks */
2504 for(n = 0; n < v.nvec; ++n) {
2505 if((err = gettrackdata(v.vec[n], 0, &p, 0, 0, tid) == DB_LOCK_DEADLOCK))
2508 disorder_error(0, "track %s unexpected error: %s",
2509 v.vec[n], db_strerror(err));
2512 twords = track_to_words(v.vec[n], p);
2513 tags = parsetags(kvp_get(p, "tags"));
2514 for(i = 0; i < nwordlist; ++i) {
2517 /* Track must have this tag */
2518 for(j = 0; tags[j]; ++j)
2519 if(!strcmp(tag, tags[j])) break; /* tag found */
2520 if(!tags[j]) break; /* tag not found */
2522 /* Track must contain this word */
2523 for(j = 0; twords[j]; ++j)
2524 if(!strcmp(w[i], twords[j])) break; /* word found */
2525 if(!twords[j]) break; /* word not found */
2528 if(i >= nwordlist) /* all words found */
2529 vector_append(&u, v.vec[n]);
2533 trackdb_closecursor(cursor);
2535 trackdb_abort_transaction(tid);
2536 disorder_info("retrying search");
2538 trackdb_commit_transaction(tid);
2539 vector_terminate(&u);
2545 /* trackdb_scan **************************************************************/
2547 /** @brief Visit every track
2548 * @param root Root to scan or NULL for all
2549 * @param callback Callback for each track
2550 * @param u Passed to @p callback
2551 * @param tid Owning transaction
2552 * @return 0, DB_LOCK_DEADLOCK or EINTR
2554 * Visits every track and calls @p callback. @p callback will get the track
2555 * data and preferences and should return 0 to continue scanning or EINTR to
2558 int trackdb_scan(const char *root,
2559 int (*callback)(const char *track,
2568 const size_t root_len = root ? strlen(root) : 0;
2570 struct kvp *data, *prefs;
2573 cursor = trackdb_opencursor(trackdb_tracksdb, tid);
2575 err = cursor->c_get(cursor, make_key(&k, root), prepare_data(&d),
2578 memset(&k, 0, sizeof k);
2579 err = cursor->c_get(cursor, &k, prepare_data(&d),
2584 || (k.size > root_len
2585 && !strncmp(k.data, root, root_len)
2586 && ((char *)k.data)[root_len] == '/')) {
2587 data = kvp_urldecode(d.data, d.size);
2588 if(kvp_get(data, "_path")) {
2589 track = xstrndup(k.data, k.size);
2590 /* TODO: trackdb_prefsdb is currently a DB_HASH. This means we have to
2591 * do a lookup for every single track. In fact this is quite quick:
2592 * with around 10,000 tracks a complete scan is around 0.3s on my
2593 * 2.2GHz Athlon. However, if it were a DB_BTREE, we could do the same
2594 * linear walk as we already do over trackdb_tracksdb, and probably get
2595 * even higher performance. That would require upgrade logic to
2596 * translate old databases though.
2598 switch(err = trackdb_prefsdb->get(trackdb_prefsdb, tid, &k,
2599 prepare_data(&pd), 0)) {
2601 prefs = kvp_urldecode(pd.data, pd.size);
2606 case DB_LOCK_DEADLOCK:
2607 disorder_error(0, "getting prefs: %s", db_strerror(err));
2608 trackdb_closecursor(cursor);
2611 disorder_fatal(0, "getting prefs: %s", db_strerror(err));
2613 /* Advance to the next track before the callback so that the callback
2614 * may safely delete the track */
2615 err = cursor->c_get(cursor, &k, &d, DB_NEXT);
2616 if((cberr = callback(track, data, prefs, u, tid))) {
2621 err = cursor->c_get(cursor, &k, &d, DB_NEXT);
2625 trackdb_closecursor(cursor);
2632 case DB_LOCK_DEADLOCK:
2633 disorder_error(0, "c->c_get: %s", db_strerror(err));
2636 disorder_fatal(0, "c->c_get: %s", db_strerror(err));
2640 /* trackdb_rescan ************************************************************/
2642 /** @brief Node in the list of rescan-complete callbacks */
2643 struct rescanned_node {
2644 struct rescanned_node *next;
2645 void (*rescanned)(void *ru);
2649 /** @brief List of rescan-complete callbacks */
2650 static struct rescanned_node *rescanned_list;
2652 /** @brief Add a rescan completion callback */
2653 void trackdb_add_rescanned(void (*rescanned)(void *ru),
2656 struct rescanned_node *n = xmalloc(sizeof *n);
2657 n->next = rescanned_list;
2658 n->rescanned = rescanned;
2664 /* called when the rescanner terminates */
2665 static int reap_rescan(ev_source attribute((unused)) *ev,
2668 const struct rusage attribute((unused)) *rusage,
2669 void attribute((unused)) *u) {
2670 if(pid == rescan_pid) rescan_pid = -1;
2672 disorder_error(0, RESCAN": %s", wstat(status));
2674 D((RESCAN" terminated: %s", wstat(status)));
2675 /* Our cache of file lookups is out of date now */
2676 cache_clean(&cache_files_type);
2677 eventlog("rescanned", (char *)0);
2678 /* Call rescanned callbacks */
2679 while(rescanned_list) {
2680 void (*rescanned)(void *u_) = rescanned_list->rescanned;
2681 void *ru = rescanned_list->ru;
2683 rescanned_list = rescanned_list->next;
2689 /** @brief Initiate a rescan
2690 * @param ev Event loop or 0 to block
2691 * @param recheck 1 to recheck lengths, 0 to suppress check
2692 * @param rescanned Called on completion (if not NULL)
2693 * @param ru Passed to @p rescanned
2695 void trackdb_rescan(ev_source *ev, int recheck,
2696 void (*rescanned)(void *ru),
2700 if(rescan_pid != -1) {
2701 trackdb_add_rescanned(rescanned, ru);
2702 disorder_error(0, "rescan already underway");
2705 rescan_pid = subprogram(ev, -1, RESCAN,
2706 recheck ? "--check" : "--no-check",
2708 trackdb_add_rescanned(rescanned, ru);
2710 ev_child(ev, rescan_pid, 0, reap_rescan, 0);
2711 D(("started rescanner"));
2713 /* This is the first rescan, we block until it is complete */
2714 while(waitpid(rescan_pid, &w, 0) < 0 && errno == EINTR)
2716 reap_rescan(0, rescan_pid, w, 0, 0);
2720 /** @brief Cancel a rescan
2721 * @return Nonzero if a rescan was cancelled
2723 int trackdb_rescan_cancel(void) {
2724 if(rescan_pid == -1) return 0;
2725 if(kill(rescan_pid, SIGTERM) < 0)
2726 disorder_fatal(errno, "error killing rescanner");
2731 /** @brief Return true if a rescan is underway */
2732 int trackdb_rescan_underway(void) {
2733 return rescan_pid != -1;
2736 /* global prefs **************************************************************/
2738 /** @brief Set a global preference
2739 * @param name Global preference name
2740 * @param value New value
2741 * @param who Who is setting it
2742 * @return 0 on success, -1 on error
2744 int trackdb_set_global(const char *name,
2751 tid = trackdb_begin_transaction();
2752 err = trackdb_set_global_tid(name, value, tid);
2753 if(err != DB_LOCK_DEADLOCK)
2755 trackdb_abort_transaction(tid);
2757 trackdb_commit_transaction(tid);
2758 /* log important state changes */
2759 if(!strcmp(name, "playing")) {
2760 state = !value || !strcmp(value, "yes");
2761 disorder_info("playing %s by %s",
2762 state ? "enabled" : "disabled",
2764 eventlog("state", state ? "enable_play" : "disable_play", (char *)0);
2766 if(!strcmp(name, "random-play")) {
2767 state = !value || !strcmp(value, "yes");
2768 disorder_info("random play %s by %s",
2769 state ? "enabled" : "disabled",
2771 eventlog("state", state ? "enable_random" : "disable_random", (char *)0);
2773 eventlog("global_pref", name, value, (char *)0);
2774 return err == 0 ? 0 : -1;
2777 /** @brief Set a global preference
2778 * @param name Global preference name
2779 * @param value New value
2780 * @param tid Owning transaction
2782 int trackdb_set_global_tid(const char *name,
2788 memset(&k, 0, sizeof k);
2789 memset(&d, 0, sizeof d);
2790 k.data = (void *)name;
2791 k.size = strlen(name);
2793 d.data = (void *)value;
2794 d.size = strlen(value);
2797 err = trackdb_globaldb->put(trackdb_globaldb, tid, &k, &d, 0);
2799 err = trackdb_globaldb->del(trackdb_globaldb, tid, &k, 0);
2800 if(err == DB_LOCK_DEADLOCK || err == DB_NOTFOUND) return err;
2802 disorder_fatal(0, "error updating database: %s", db_strerror(err));
2806 /** @brief Get a global preference
2807 * @param name Global preference name
2808 * @return Value of global preference, or NULL if it's not set
2810 const char *trackdb_get_global(const char *name) {
2815 tid = trackdb_begin_transaction();
2816 if(!trackdb_get_global_tid(name, tid, &r))
2818 trackdb_abort_transaction(tid);
2820 trackdb_commit_transaction(tid);
2824 /** @brief Get a global preference
2825 * @param name Global preference name
2826 * @param tid Owning transaction
2827 * @param rp Where to store value (will get NULL if preference not set)
2828 * @return 0 or DB_LOCK_DEADLOCK
2830 int trackdb_get_global_tid(const char *name,
2836 memset(&k, 0, sizeof k);
2837 k.data = (void *)name;
2838 k.size = strlen(name);
2839 switch(err = trackdb_globaldb->get(trackdb_globaldb, tid, &k,
2840 prepare_data(&d), 0)) {
2842 *rp = xstrndup(d.data, d.size);
2847 case DB_LOCK_DEADLOCK:
2850 disorder_fatal(0, "error reading database: %s", db_strerror(err));
2854 /** @brief Retrieve the most recently added tracks
2855 * @param ntracksp Where to put count, or 0
2856 * @param maxtracks Maximum number of tracks to retrieve
2857 * @return null-terminated array of track names
2859 * The most recently added track is first in the array.
2861 char **trackdb_new(int *ntracksp,
2867 tid = trackdb_begin_transaction();
2868 tracks = trackdb_new_tid(ntracksp, maxtracks, tid);
2871 trackdb_abort_transaction(tid);
2873 trackdb_commit_transaction(tid);
2877 /** @brief Retrieve the most recently added tracks
2878 * @param ntracksp Where to put count, or 0
2879 * @param maxtracks Maximum number of tracks to retrieve, or 0 for all
2880 * @param tid Transaction ID
2881 * @return null-terminated array of track names, or NULL on deadlock
2883 * The most recently added track is first in the array.
2885 static char **trackdb_new_tid(int *ntracksp,
2891 struct vector tracks[1];
2892 hash *h = hash_new(1);
2894 vector_init(tracks);
2895 c = trackdb_opencursor(trackdb_noticeddb, tid);
2896 while((maxtracks <= 0 || tracks->nvec < maxtracks)
2897 && !(err = c->c_get(c, prepare_data(&k), prepare_data(&d), DB_PREV))) {
2898 char *const track = xstrndup(d.data, d.size);
2899 /* Don't add any track more than once */
2900 if(hash_add(h, track, "", HASH_INSERT))
2902 /* See if the track still exists */
2903 err = trackdb_getdata(trackdb_tracksdb, track, NULL/*kp*/, tid);
2904 if(err == DB_NOTFOUND)
2905 continue; /* It doesn't, skip it */
2906 if(err == DB_LOCK_DEADLOCK)
2908 vector_append(tracks, track);
2911 case 0: /* hit maxtracks */
2912 case DB_NOTFOUND: /* ran out of tracks */
2914 case DB_LOCK_DEADLOCK:
2915 trackdb_closecursor(c);
2918 disorder_fatal(0, "error reading noticed.db: %s", db_strerror(err));
2920 if(trackdb_closecursor(c))
2921 return 0; /* deadlock */
2922 vector_terminate(tracks);
2924 *ntracksp = tracks->nvec;
2928 /** @brief Expire noticed.db
2929 * @param earliest Earliest timestamp to keep
2931 void trackdb_expire_noticed(time_t earliest) {
2935 tid = trackdb_begin_transaction();
2936 if(!trackdb_expire_noticed_tid(earliest, tid))
2938 trackdb_abort_transaction(tid);
2940 trackdb_commit_transaction(tid);
2943 /** @brief Expire noticed.db
2944 * @param earliest Earliest timestamp to keep
2945 * @param tid Transaction ID
2946 * @return 0 or DB_LOCK_DEADLOCK
2948 static int trackdb_expire_noticed_tid(time_t earliest, DB_TXN *tid) {
2956 c = trackdb_opencursor(trackdb_noticeddb, tid);
2957 while(!(err = c->c_get(c, prepare_data(&k), prepare_data(&d), DB_NEXT))) {
2959 when = (time_t)(((uint64_t)ntohl(kk[0]) << 32) + ntohl(kk[1]));
2960 if(when >= earliest)
2962 if((err = c->c_del(c, 0))) {
2963 if(err != DB_LOCK_DEADLOCK)
2964 disorder_fatal(0, "error deleting expired noticed.db entry: %s",
2970 if(err == DB_NOTFOUND)
2972 if(err && err != DB_LOCK_DEADLOCK)
2973 disorder_fatal(0, "error expiring noticed.db: %s", db_strerror(err));
2975 if((err = trackdb_closecursor(c))) {
2976 if(err != DB_LOCK_DEADLOCK)
2977 disorder_fatal(0, "error closing cursor: %s", db_strerror(err));
2981 disorder_info("expired %d tracks from noticed.db", count);
2985 /* tidying up ****************************************************************/
2987 /** @brief Do database garbage collection
2989 * Called form periodic_database_gc().
2991 void trackdb_gc(void) {
2995 if((err = trackdb_env->txn_checkpoint(trackdb_env,
2996 config->checkpoint_kbyte,
2997 config->checkpoint_min,
2999 disorder_fatal(0, "trackdb_env->txn_checkpoint: %s", db_strerror(err));
3000 if((err = trackdb_env->log_archive(trackdb_env, &logfiles, DB_ARCH_REMOVE)))
3001 disorder_fatal(0, "trackdb_env->log_archive: %s", db_strerror(err));
3002 /* This makes catastrophic recovery impossible. However, the user can still
3003 * preserve the important data by using disorder-dump to snapshot their
3004 * prefs, and later to restore it. This is likely to have much small
3005 * long-term storage requirements than record the db logfiles. */
3008 /* user database *************************************************************/
3010 /** @brief Add a user
3011 * @param user Username
3012 * @param password Initial password or NULL
3013 * @param rights Initial rights
3014 * @param email Email address or NULL
3015 * @param confirmation Confirmation string to require
3016 * @param tid Owning transaction
3017 * @param flags DB flags e.g. DB_NOOVERWRITE
3018 * @return 0, DB_KEYEXIST or DB_LOCK_DEADLOCK
3020 static int create_user(const char *user,
3021 const char *password,
3024 const char *confirmation,
3030 /* sanity check user */
3031 if(!valid_username(user)) {
3032 disorder_error(0, "invalid username '%s'", user);
3035 if(parse_rights(rights, 0, 1)) {
3036 disorder_error(0, "invalid rights string");
3039 /* data for this user */
3041 kvp_set(&k, "password", password);
3042 kvp_set(&k, "rights", rights);
3044 kvp_set(&k, "email", email);
3046 kvp_set(&k, "confirmation", confirmation);
3047 snprintf(s, sizeof s, "%jd", (intmax_t)xtime(0));
3048 kvp_set(&k, "created", s);
3049 return trackdb_putdata(trackdb_usersdb, user, k, tid, flags);
3052 /** @brief Create a root user in the user database if there is none */
3053 void trackdb_create_root(void) {
3058 /* Choose a new root password */
3059 gcry_randomize(pwbin, sizeof pwbin, GCRY_STRONG_RANDOM);
3060 pw = mime_to_base64(pwbin, sizeof pwbin);
3061 /* Create the root user if it does not exist */
3062 WITH_TRANSACTION(create_user("root", pw, "all",
3063 0/*email*/, 0/*confirmation*/,
3064 tid, DB_NOOVERWRITE));
3066 disorder_info("created root user");
3069 /** @brief Find a user's password from the database
3070 * @param user Username
3071 * @return Password or NULL
3073 * Only works if running as a user that can read the database!
3075 * If the user exists but has no password, "" is returned.
3077 const char *trackdb_get_password(const char *user) {
3080 const char *password;
3082 WITH_TRANSACTION(trackdb_getdata(trackdb_usersdb, user, &k, tid));
3085 password = kvp_get(k, "password");
3086 return password ? password : "";
3089 /** @brief Add a new user
3090 * @param user Username
3091 * @param password Password or NULL
3092 * @param rights Initial rights
3093 * @param email Email address or NULL
3094 * @param confirmation Confirmation string or NULL
3095 * @return 0 on success, non-0 on error
3097 int trackdb_adduser(const char *user,
3098 const char *password,
3101 const char *confirmation) {
3104 WITH_TRANSACTION(create_user(user, password, rights, email, confirmation,
3105 tid, DB_NOOVERWRITE));
3107 disorder_error(0, "cannot create user '%s' because they already exist",
3112 disorder_info("created user '%s' with rights '%s' and email address '%s'",
3113 user, rights, email);
3115 disorder_info("created user '%s' with rights '%s'", user, rights);
3116 eventlog("user_add", user, (char *)0);
3121 /** @brief Delete a user
3122 * @param user User to delete
3123 * @return 0 on success, non-0 if the user didn't exist anyway
3125 int trackdb_deluser(const char *user) {
3128 WITH_TRANSACTION(trackdb_delkey(trackdb_usersdb, user, tid));
3130 disorder_error(0, "cannot delete user '%s' because they do not exist",
3134 disorder_info("deleted user '%s'", user);
3135 eventlog("user_delete", user, (char *)0);
3139 /** @brief Get user information
3140 * @param user User to query
3141 * @return Linked list of user information or NULL if user does not exist
3143 * Every user has at least a @c rights entry so NULL can be used to mean no
3146 struct kvp *trackdb_getuserinfo(const char *user) {
3150 WITH_TRANSACTION(trackdb_getdata(trackdb_usersdb, user, &k, tid));
3157 /** @brief Edit user information
3158 * @param user User to edit
3159 * @param key Key to change
3160 * @param value Value to set, or NULL to remove
3161 * @param tid Transaction ID
3162 * @return 0, DB_LOCK_DEADLOCK or DB_NOTFOUND
3164 static int trackdb_edituserinfo_tid(const char *user, const char *key,
3165 const char *value, DB_TXN *tid) {
3169 if((e = trackdb_getdata(trackdb_usersdb, user, &k, tid)))
3171 if(!kvp_set(&k, key, value))
3172 return 0; /* no change */
3173 return trackdb_putdata(trackdb_usersdb, user, k, tid, 0);
3176 /** @brief Edit user information
3177 * @param user User to edit
3178 * @param key Key to change
3179 * @param value Value to set, or NULL to remove
3180 * @return 0 on success, non-0 on error
3182 int trackdb_edituserinfo(const char *user,
3183 const char *key, const char *value) {
3186 if(!strcmp(key, "rights")) {
3188 disorder_error(0, "cannot remove 'rights' key from user '%s'", user);
3191 if(parse_rights(value, 0, 1)) {
3192 disorder_error(0, "invalid rights string");
3195 } else if(!strcmp(key, "email")) {
3197 if(!email_valid(value)) {
3198 disorder_error(0, "invalid email address '%s' for user '%s'",
3203 value = 0; /* no email -> remove key */
3204 } else if(!strcmp(key, "created")) {
3205 disorder_error(0, "cannot change creation date for user '%s'", user);
3207 } else if(strcmp(key, "password")
3208 && !strcmp(key, "confirmation")) {
3209 disorder_error(0, "unknown user info key '%s' for user '%s'", key, user);
3212 WITH_TRANSACTION(trackdb_edituserinfo_tid(user, key, value, tid));
3214 disorder_error(0, "unknown user '%s'", user);
3217 eventlog("user_edit", user, key, (char *)0);
3222 /** @brief List all users
3223 * @return NULL-terminated list of users
3225 char **trackdb_listusers(void) {
3230 WITH_TRANSACTION(trackdb_listkeys(trackdb_usersdb, v, tid));
3234 /** @brief Confirm a user registration
3235 * @param user Username
3236 * @param confirmation Confirmation string
3237 * @param rightsp Where to put user rights
3238 * @param tid Transaction ID
3239 * @return 0 on success, non-0 on error
3241 static int trackdb_confirm_tid(const char *user, const char *confirmation,
3242 rights_type *rightsp,
3244 const char *stored_confirmation;
3249 if((e = trackdb_getdata(trackdb_usersdb, user, &k, tid)))
3251 if(!(stored_confirmation = kvp_get(k, "confirmation"))) {
3252 disorder_error(0, "already confirmed user '%s'", user);
3253 /* DB claims -30,800 to -30,999 so -1 should be a safe bet */
3256 if(!(rights = kvp_get(k, "rights"))) {
3257 disorder_error(0, "no rights for unconfirmed user '%s'", user);
3260 if(parse_rights(rights, rightsp, 1))
3262 if(strcmp(confirmation, stored_confirmation)) {
3263 disorder_error(0, "wrong confirmation string for user '%s'", user);
3267 kvp_set(&k, "confirmation", 0);
3268 return trackdb_putdata(trackdb_usersdb, user, k, tid, 0);
3271 /** @brief Confirm a user registration
3272 * @param user Username
3273 * @param confirmation Confirmation string
3274 * @param rightsp Where to put user rights
3275 * @return 0 on success, non-0 on error
3277 int trackdb_confirm(const char *user, const char *confirmation,
3278 rights_type *rightsp) {
3281 WITH_TRANSACTION(trackdb_confirm_tid(user, confirmation, rightsp, tid));
3284 disorder_info("registration confirmed for user '%s'", user);
3285 eventlog("user_confirm", user, (char *)0);
3288 disorder_error(0, "confirmation for nonexistent user '%s'", user);
3290 default: /* already reported */
3300 indent-tabs-mode:nil