2 * This file is part of DisOrder
3 * Copyright (C) 2005, 2006, 2007 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 server/trackdb.c
21 * @brief Track database */
29 #include <sys/socket.h>
36 #include <sys/resource.h>
38 #include <arpa/inet.h>
47 #include "configuration.h"
52 #include "trackname.h"
53 #include "trackdb-int.h"
61 #define RESCAN "disorder-rescan"
62 #define DEADLOCK "disorder-deadlock"
64 static const char *getpart(const char *track
,
69 static int trackdb_alltags_tid(DB_TXN
*tid
, char ***taglistp
);
70 static char **trackdb_new_tid(int *ntracksp
,
73 static int trackdb_expire_noticed_tid(time_t earliest
, DB_TXN
*tid
);
75 const struct cache_type cache_files_type
= { 86400 };
76 unsigned long cache_files_hits
, cache_files_misses
;
78 /** @brief Set by trackdb_open() */
79 int trackdb_existing_database
;
81 /* setup and teardown ********************************************************/
83 static const char *home
; /* home had better not change */
84 DB_ENV
*trackdb_env
; /* db environment */
86 /** @brief The tracks database
87 * - Keys are UTF-8(NFC(unicode(path name)))
88 * - Values are encoded key-value pairs
89 * - Data is reconstructable data about tracks that currently exist
93 /** @brief The preferences database
95 * - Keys are UTF-8(NFC(unicode(path name)))
96 * - Values are encoded key-value pairs
97 * - Data is user data about tracks (that might not exist any more)
98 * and cannot be reconstructed
102 /** @brief The search database
104 * - Keys are UTF-8(NFKC(casefold(search term)))
105 * - Values are UTF-8(NFC(unicode(path name)))
106 * - There can be more than one value per key
107 * - Presence of key,value means that path matches the search terms
108 * - Only tracks fond in @ref tracks_tracksdb are represented here
109 * - This database can be reconstructed, it contains no user data
111 DB
*trackdb_searchdb
;
113 /** @brief The tags database
115 * - Keys are UTF-8(NFKC(casefold(tag)))
116 * - Values are UTF-8(NFC(unicode(path name)))
117 * - There can be more than one value per key
118 * - Presence of key,value means that path matches the tag
119 * - This is always in sync with the tags preference
120 * - This database can be reconstructed, it contains no user data
122 DB
*trackdb_tagsdb
; /* the tags database */
124 /** @brief The global preferences database
125 * - Keys are UTF-8(NFC(preference))
126 * - Values are global preference values
127 * - Data is user data and cannot be reconstructed
129 DB
*trackdb_globaldb
; /* global preferences */
131 /** @brief The noticed database
132 * - Keys are 64-bit big-endian timestamps
133 * - Values are UTF-8(NFC(unicode(path name)))
134 * - There can be more than one value per key
135 * - Presence of key,value means that path was added at the given time
136 * - Data cannot be reconstructed (but isn't THAT important)
138 DB
*trackdb_noticeddb
; /* when track noticed */
139 static pid_t db_deadlock_pid
= -1; /* deadlock manager PID */
140 static pid_t rescan_pid
= -1; /* rescanner PID */
141 static int initialized
, opened
; /* state */
143 /* tracks matched by required_tags */
144 static char **reqtracks
;
145 static size_t nreqtracks
;
147 /* comparison function for keys */
148 static int compare(DB
attribute((unused
)) *db_
,
149 const DBT
*a
, const DBT
*b
) {
150 return compare_path_raw(a
->data
, a
->size
, b
->data
, b
->size
);
153 /** @brief Open database environment
154 * @param flags Flags word
156 * Flags should be one of:
157 * - @ref TRACKDB_NO_RECOVER
158 * - @ref TRACKDB_NORMAL_RECOVER
159 * - @ref TRACKDB_FATAL_RECOVER
161 void trackdb_init(int flags
) {
163 const int recover
= flags
& TRACKDB_RECOVER_MASK
;
164 static int recover_type
[] = { 0, DB_RECOVER
, DB_RECOVER_FATAL
};
167 assert(initialized
== 0);
170 if(strcmp(home
, config
->home
))
171 fatal(0, "cannot change db home without server restart");
175 /* create environment */
176 if((err
= db_env_create(&trackdb_env
, 0))) fatal(0, "db_env_create: %s",
178 if((err
= trackdb_env
->set_alloc(trackdb_env
,
179 xmalloc_noptr
, xrealloc_noptr
, xfree
)))
180 fatal(0, "trackdb_env->set_alloc: %s", db_strerror(err
));
181 if((err
= trackdb_env
->set_lk_max_locks(trackdb_env
, 10000)))
182 fatal(0, "trackdb_env->set_lk_max_locks: %s", db_strerror(err
));
183 if((err
= trackdb_env
->set_lk_max_objects(trackdb_env
, 10000)))
184 fatal(0, "trackdb_env->set_lk_max_objects: %s", db_strerror(err
));
185 if((err
= trackdb_env
->open(trackdb_env
, config
->home
,
191 |recover_type
[recover
],
193 fatal(0, "trackdb_env->open %s: %s", config
->home
, db_strerror(err
));
194 trackdb_env
->set_errpfx(trackdb_env
, "DB");
195 trackdb_env
->set_errfile(trackdb_env
, stderr
);
196 trackdb_env
->set_verbose(trackdb_env
, DB_VERB_DEADLOCK
, 1);
197 trackdb_env
->set_verbose(trackdb_env
, DB_VERB_RECOVERY
, 1);
198 trackdb_env
->set_verbose(trackdb_env
, DB_VERB_REPLICATION
, 1);
199 D(("initialized database environment"));
202 /* called when deadlock manager terminates */
203 static int reap_db_deadlock(ev_source
attribute((unused
)) *ev
,
204 pid_t
attribute((unused
)) pid
,
206 const struct rusage
attribute((unused
)) *rusage
,
207 void attribute((unused
)) *u
) {
208 db_deadlock_pid
= -1;
210 fatal(0, "deadlock manager unexpectedly terminated: %s",
213 D(("deadlock manager terminated: %s", wstat(status
)));
217 static pid_t
subprogram(ev_source
*ev
, const char *prog
,
221 /* If we're in the background then trap subprocess stdout/stderr */
222 if(!(pid
= xfork())) {
225 ev_signal_atfork(ev
);
226 signal(SIGPIPE
, SIG_DFL
);
231 /* If we were negatively niced, undo it. We don't bother checking for
232 * error, it's not that important. */
233 setpriority(PRIO_PROCESS
, 0, 0);
234 execlp(prog
, prog
, "--config", configfile
,
235 debugging ?
"--debug" : "--no-debug",
236 log_default
== &log_syslog ?
"--syslog" : "--no-syslog",
238 fatal(errno
, "error invoking %s", prog
);
243 /* start deadlock manager */
244 void trackdb_master(ev_source
*ev
) {
245 assert(db_deadlock_pid
== -1);
246 db_deadlock_pid
= subprogram(ev
, DEADLOCK
, -1);
247 ev_child(ev
, db_deadlock_pid
, 0, reap_db_deadlock
, 0);
248 D(("started deadlock manager"));
251 /* close environment */
252 void trackdb_deinit(void) {
256 assert(initialized
== 1);
259 /* close the environment */
260 if((err
= trackdb_env
->close(trackdb_env
, 0)))
261 fatal(0, "trackdb_env->close: %s", db_strerror(err
));
263 if(rescan_pid
!= -1 && kill(rescan_pid
, SIGTERM
) < 0)
264 fatal(errno
, "error killing rescanner");
266 /* terminate the deadlock manager */
267 if(db_deadlock_pid
!= -1 && kill(db_deadlock_pid
, SIGTERM
) < 0)
268 fatal(errno
, "error killing deadlock manager");
269 db_deadlock_pid
= -1;
271 D(("deinitialized database environment"));
274 /* open a specific database */
275 static DB
*open_db(const char *path
,
283 D(("open %s", path
));
284 path
= config_get_file(path
);
285 if((err
= db_create(&db
, trackdb_env
, 0)))
286 fatal(0, "db_create %s: %s", path
, db_strerror(err
));
288 if((err
= db
->set_flags(db
, dbflags
)))
289 fatal(0, "db->set_flags %s: %s", path
, db_strerror(err
));
290 if(dbtype
== DB_BTREE
)
291 if((err
= db
->set_bt_compare(db
, compare
)))
292 fatal(0, "db->set_bt_compare %s: %s", path
, db_strerror(err
));
293 if((err
= db
->open(db
, 0, path
, 0, dbtype
,
294 openflags
| DB_AUTO_COMMIT
, mode
))) {
295 if((openflags
& DB_CREATE
) || errno
!= ENOENT
)
296 fatal(0, "db->open %s: %s", path
, db_strerror(err
));
303 /** @brief Open track databases
304 * @param Flags flags word
306 * @p flags should be one of:
307 * - @p TRACKDB_NO_UPGRADE, if no upgrade should be attempted
308 * - @p TRACKDB_CAN_UPGRADE, if an upgrade may be attempted
309 * - @p TRACKDB_OPEN_FOR_UPGRADE, if this is disorder-dbupgrade
311 void trackdb_open(int flags
) {
318 /* check the database version first */
319 trackdb_globaldb
= open_db("global.db", 0, DB_HASH
, 0, 0666);
320 if(trackdb_globaldb
) {
321 /* This is an existing database */
325 s
= trackdb_get_global("_dbversion");
326 /* Close the database again, we'll open it property below */
327 if((err
= trackdb_globaldb
->close(trackdb_globaldb
, 0)))
328 fatal(0, "error closing global.db: %s", db_strerror(err
));
329 trackdb_globaldb
= 0;
330 /* Convert version string to an integer */
331 oldversion
= s ?
atol(s
) : 1;
332 if(oldversion
> config
->dbversion
) {
333 /* Database is from the future; we never allow this. */
334 fatal(0, "this version of DisOrder is too old for database version %ld",
337 if(oldversion
< config
->dbversion
) {
338 /* Database version is out of date */
339 switch(flags
& TRACKDB_UPGRADE_MASK
) {
340 case TRACKDB_NO_UPGRADE
:
341 /* This database needs upgrading but this is not permitted */
342 fatal(0, "database needs upgrading from %ld to %ld",
343 oldversion
, config
->dbversion
);
344 case TRACKDB_CAN_UPGRADE
:
345 /* This database needs upgrading */
346 info("invoking disorder-dbupgrade to upgrade from %ld to %ld",
347 oldversion
, config
->dbversion
);
348 pid
= subprogram(0, "disorder-dbupgrade", -1);
349 while(waitpid(pid
, &err
, 0) == -1 && errno
== EINTR
)
352 fatal(0, "disorder-dbupgrade %s", wstat(err
));
353 info("disorder-dbupgrade succeeded");
355 case TRACKDB_OPEN_FOR_UPGRADE
:
361 if(oldversion
== config
->dbversion
&& (flags
& TRACKDB_OPEN_FOR_UPGRADE
)) {
362 /* This doesn't make any sense */
363 fatal(0, "database is already at current version");
365 trackdb_existing_database
= 1;
367 if(flags
& TRACKDB_OPEN_FOR_UPGRADE
) {
368 /* Cannot upgrade a new database */
369 fatal(0, "cannot upgrade a database that does not exist");
371 /* This is a brand new database */
372 trackdb_existing_database
= 0;
374 /* open the databases */
375 trackdb_tracksdb
= open_db("tracks.db",
376 DB_RECNUM
, DB_BTREE
, DB_CREATE
, 0666);
377 trackdb_searchdb
= open_db("search.db",
378 DB_DUP
|DB_DUPSORT
, DB_HASH
, DB_CREATE
, 0666);
379 trackdb_tagsdb
= open_db("tags.db",
380 DB_DUP
|DB_DUPSORT
, DB_HASH
, DB_CREATE
, 0666);
381 trackdb_prefsdb
= open_db("prefs.db", 0, DB_HASH
, DB_CREATE
, 0666);
382 trackdb_globaldb
= open_db("global.db", 0, DB_HASH
, DB_CREATE
, 0666);
383 trackdb_noticeddb
= open_db("noticed.db",
384 DB_DUPSORT
, DB_BTREE
, DB_CREATE
, 0666);
385 if(!trackdb_existing_database
) {
386 /* Stash the database version */
389 assert(!(flags
& TRACKDB_OPEN_FOR_UPGRADE
));
390 snprintf(buf
, sizeof buf
, "%ld", config
->dbversion
);
391 trackdb_set_global("_dbversion", buf
, 0);
393 D(("opened databases"));
396 /* close track databases */
397 void trackdb_close(void) {
403 if((err
= trackdb_tracksdb
->close(trackdb_tracksdb
, 0)))
404 fatal(0, "error closing tracks.db: %s", db_strerror(err
));
405 if((err
= trackdb_searchdb
->close(trackdb_searchdb
, 0)))
406 fatal(0, "error closing search.db: %s", db_strerror(err
));
407 if((err
= trackdb_tagsdb
->close(trackdb_tagsdb
, 0)))
408 fatal(0, "error closing tags.db: %s", db_strerror(err
));
409 if((err
= trackdb_prefsdb
->close(trackdb_prefsdb
, 0)))
410 fatal(0, "error closing prefs.db: %s", db_strerror(err
));
411 if((err
= trackdb_globaldb
->close(trackdb_globaldb
, 0)))
412 fatal(0, "error closing global.db: %s", db_strerror(err
));
413 if((err
= trackdb_noticeddb
->close(trackdb_noticeddb
, 0)))
414 fatal(0, "error closing noticed.db: %s", db_strerror(err
));
415 trackdb_tracksdb
= trackdb_searchdb
= trackdb_prefsdb
= 0;
416 trackdb_tagsdb
= trackdb_globaldb
= 0;
417 D(("closed databases"));
420 /* generic db routines *******************************************************/
422 /* fetch and decode a database entry. Returns 0, DB_NOTFOUND or
423 * DB_LOCK_DEADLOCK. */
424 int trackdb_getdata(DB
*db
,
431 switch(err
= db
->get(db
, tid
, make_key(&key
, track
),
432 prepare_data(&data
), 0)) {
434 *kp
= kvp_urldecode(data
.data
, data
.size
);
439 case DB_LOCK_DEADLOCK
:
440 error(0, "error querying database: %s", db_strerror(err
));
443 fatal(0, "error querying database: %s", db_strerror(err
));
447 /* encode and store a database entry. Returns 0, DB_KEYEXIST or
448 * DB_LOCK_DEADLOCK. */
449 int trackdb_putdata(DB
*db
,
457 switch(err
= db
->put(db
, tid
, make_key(&key
, track
),
458 encode_data(&data
, k
), flags
)) {
462 case DB_LOCK_DEADLOCK
:
463 error(0, "error updating database: %s", db_strerror(err
));
466 fatal(0, "error updating database: %s", db_strerror(err
));
470 /* delete a database entry */
471 int trackdb_delkey(DB
*db
,
477 switch(err
= db
->del(db
, tid
, make_key(&key
, track
), 0)) {
481 case DB_LOCK_DEADLOCK
:
482 error(0, "error updating database: %s", db_strerror(err
));
485 fatal(0, "error updating database: %s", db_strerror(err
));
489 /* open a database cursor */
490 DBC
*trackdb_opencursor(DB
*db
, DB_TXN
*tid
) {
494 switch(err
= db
->cursor(db
, tid
, &c
, 0)) {
496 default: fatal(0, "error creating cursor: %s", db_strerror(err
));
501 /* close a database cursor; returns 0 or DB_LOCK_DEADLOCK */
502 int trackdb_closecursor(DBC
*c
) {
506 switch(err
= c
->c_close(c
)) {
509 case DB_LOCK_DEADLOCK
:
510 error(0, "error closing cursor: %s", db_strerror(err
));
513 fatal(0, "error closing cursor: %s", db_strerror(err
));
517 /* delete a (key,data) pair. Returns 0, DB_NOTFOUND or DB_LOCK_DEADLOCK. */
518 int trackdb_delkeydata(DB
*db
,
526 c
= trackdb_opencursor(db
, tid
);
527 switch(err
= c
->c_get(c
, make_key(&key
, word
),
528 make_key(&data
, track
), DB_GET_BOTH
)) {
530 switch(err
= c
->c_del(c
, 0)) {
536 case DB_LOCK_DEADLOCK
:
537 error(0, "error updating database: %s", db_strerror(err
));
540 fatal(0, "c->c_del: %s", db_strerror(err
));
545 case DB_LOCK_DEADLOCK
:
546 error(0, "error updating database: %s", db_strerror(err
));
549 fatal(0, "c->c_get: %s", db_strerror(err
));
551 if(trackdb_closecursor(c
)) err
= DB_LOCK_DEADLOCK
;
555 /* start a transaction */
556 DB_TXN
*trackdb_begin_transaction(void) {
560 if((err
= trackdb_env
->txn_begin(trackdb_env
, 0, &tid
, 0)))
561 fatal(0, "trackdb_env->txn_begin: %s", db_strerror(err
));
565 /* abort transaction */
566 void trackdb_abort_transaction(DB_TXN
*tid
) {
570 if((err
= tid
->abort(tid
)))
571 fatal(0, "tid->abort: %s", db_strerror(err
));
574 /* commit transaction */
575 void trackdb_commit_transaction(DB_TXN
*tid
) {
578 if((err
= tid
->commit(tid
, 0)))
579 fatal(0, "tid->commit: %s", db_strerror(err
));
582 /* search/tags shared code ***************************************************/
584 /* comparison function used by dedupe() */
585 static int wordcmp(const void *a
, const void *b
) {
586 return strcmp(*(const char **)a
, *(const char **)b
);
589 /* sort and de-dupe VEC */
590 static char **dedupe(char **vec
, int nvec
) {
593 qsort(vec
, nvec
, sizeof (char *), wordcmp
);
597 for(n
= 1; n
< nvec
; ++n
)
598 if(strcmp(vec
[n
], vec
[m
- 1]))
605 /* update a key/track database. Returns 0 or DB_DEADLOCK. */
606 static int register_word(DB
*db
, const char *what
,
607 const char *track
, const char *word
,
612 switch(err
= db
->put(db
, tid
, make_key(&key
, word
),
613 make_key(&data
, track
), DB_NODUPDATA
)) {
617 case DB_LOCK_DEADLOCK
:
618 error(0, "error updating %s.db: %s", what
, db_strerror(err
));
621 fatal(0, "error updating %s.db: %s", what
, db_strerror(err
));
625 /* search primitives *********************************************************/
627 /* return true iff NAME is a trackname_display_ pref */
628 static int is_display_pref(const char *name
) {
629 static const char prefix
[] = "trackname_display_";
630 return !strncmp(name
, prefix
, (sizeof prefix
) - 1);
633 /** @brief Word_Break property tailor that treats underscores as spaces */
634 static int tailor_underscore_Word_Break_Other(uint32_t c
) {
638 case 0x005F: /* LOW LINE (SPACING UNDERSCORE) */
639 return unicode_Word_Break_Other
;
643 /** @brief Remove all combining characters in-place
644 * @param s Pointer to start of string
645 * @param ns Length of string
646 * @return New, possiblby reduced, length
648 static size_t remove_combining_chars(uint32_t *s
, size_t ns
) {
649 uint32_t *start
= s
, *t
= s
, *end
= s
+ ns
;
652 const uint32_t c
= *s
++;
653 if(!utf32_combining_class(c
))
659 /** @brief Normalize and split a string using a given tailoring */
660 static void word_split(struct vector
*v
,
662 unicode_property_tailor
*pt
) {
664 uint32_t *t32
, **w32
;
666 /* Convert to UTF-32 */
667 if(!(t32
= utf8_to_utf32(s
, strlen(s
), &nt32
)))
669 /* Erase case distinctions */
670 if(!(t32
= utf32_casefold_compat(t32
, nt32
, &nt32
)))
672 /* Drop combining characters */
673 nt32
= remove_combining_chars(t32
, nt32
);
674 /* Split into words, treating _ as a space */
675 w32
= utf32_word_split(t32
, nt32
, &nw
, pt
);
676 /* Convert words back to UTF-8 and append to result */
677 for(i
= 0; i
< nw
; ++i
)
678 vector_append(v
, utf32_to_utf8(w32
[i
], utf32_len(w32
[i
]), 0));
681 /* compute the words of a track name */
682 static char **track_to_words(const char *track
,
683 const struct kvp
*p
) {
685 const char *rootless
= track_rootless(track
);
688 rootless
= track
; /* bodge */
690 rootless
= strip_extension(rootless
);
691 word_split(&v
, strip_extension(rootless
), tailor_underscore_Word_Break_Other
);
692 for(; p
; p
= p
->next
)
693 if(is_display_pref(p
->name
))
694 word_split(&v
, p
->value
, 0);
695 vector_terminate(&v
);
696 return dedupe(v
.vec
, v
.nvec
);
699 /* return nonzero iff WORD is a stopword */
700 static int stopword(const char *word
) {
703 for(n
= 0; n
< config
->stopword
.n
704 && strcmp(word
, config
->stopword
.s
[n
]); ++n
)
706 return n
< config
->stopword
.n
;
709 /* record that WORD appears in TRACK. Returns 0 or DB_LOCK_DEADLOCK. */
710 static int register_search_word(const char *track
, const char *word
,
712 if(stopword(word
)) return 0;
713 return register_word(trackdb_searchdb
, "search", track
, word
, tid
);
716 /* Tags **********************************************************************/
718 /* Return nonzero if C is a valid tag character */
719 static int tagchar(int c
) {
728 /* Parse and de-dupe a tag list. If S=0 then assumes "". */
729 static char **parsetags(const char *s
) {
735 /* skip initial separators */
736 while(*s
&& (!tagchar(*s
) || *s
== ' '))
739 /* find the extent of the tag */
741 while(*s
&& tagchar(*s
))
743 /* strip trailing spaces */
744 while(s
> t
&& s
[-1] == ' ')
746 vector_append(&v
, xstrndup(t
, s
- t
));
747 /* skip intermediate and trailing separators */
748 while(*s
&& (!tagchar(*s
) || *s
== ' '))
752 vector_terminate(&v
);
753 return dedupe(v
.vec
, v
.nvec
);
756 /* Record that TRACK has TAG. Returns 0 or DB_LOCK_DEADLOCK. */
757 static int register_tag(const char *track
, const char *tag
, DB_TXN
*tid
) {
758 return register_word(trackdb_tagsdb
, "tags", track
, tag
, tid
);
761 /* aliases *******************************************************************/
763 /* compute the alias and store at aliasp. Returns 0 or DB_LOCK_DEADLOCK. If
764 * there is no alias sets *aliasp to 0. */
765 static int compute_alias(char **aliasp
,
770 const char *s
= config
->alias
, *t
, *expansion
, *part
;
771 int c
, used_db
= 0, slash_prefix
, err
;
773 const char *const root
= find_track_root(track
);
776 /* Bodge for tracks with no root */
781 dynstr_append_string(&d
, root
);
782 while((c
= (unsigned char)*s
++)) {
784 dynstr_append(&d
, c
);
787 if((slash_prefix
= (*s
== '/')))
790 assert(t
!= 0); /* validated at startup */
791 part
= xstrndup(s
, t
- s
);
792 expansion
= getpart(track
, "display", part
, p
, &used_db
);
794 if(slash_prefix
) dynstr_append(&d
, '/');
795 dynstr_append_string(&d
, expansion
);
797 s
= t
+ 1; /* skip {part} */
799 /* only admit to the alias if we used the db... */
804 dynstr_terminate(&d
);
805 /* ...and the answer differs from the original... */
806 if(!strcmp(track
, d
.vec
)) {
810 /* ...and there isn't already a different track with that name (including as
812 switch(err
= trackdb_getdata(trackdb_tracksdb
, d
.vec
, &at
, tid
)) {
814 if((s
= kvp_get(at
, "_alias_for"))
815 && !strcmp(s
, track
)) {
827 /* get track and prefs data (if tp/pp not null pointers). Returns 0 on
828 * success, DB_NOTFOUND if the track does not exist or DB_LOCK_DEADLOCK.
829 * Always sets the return values, even if only to null pointers. */
830 static int gettrackdata(const char *track
,
833 const char **actualp
,
835 #define GTD_NOALIAS 0x0001
838 const char *actual
= track
;
839 struct kvp
*t
= 0, *p
= 0;
841 if((err
= trackdb_getdata(trackdb_tracksdb
, track
, &t
, tid
))) goto done
;
842 if((actual
= kvp_get(t
, "_alias_for"))) {
843 if(flags
& GTD_NOALIAS
) {
844 error(0, "alias passed to gettrackdata where real path required");
847 if((err
= trackdb_getdata(trackdb_tracksdb
, actual
, &t
, tid
))) goto done
;
852 if((err
= trackdb_getdata(trackdb_prefsdb
, actual
, &p
, tid
)) == DB_LOCK_DEADLOCK
)
857 if(actualp
) *actualp
= actual
;
863 /* trackdb_notice() **********************************************************/
865 /** @brief notice a possibly new track
866 * @return @c DB_NOTFOUND if new, 0 if already known
868 int trackdb_notice(const char *track
,
874 tid
= trackdb_begin_transaction();
875 err
= trackdb_notice_tid(track
, path
, tid
);
876 if((err
== DB_LOCK_DEADLOCK
)) goto fail
;
879 trackdb_abort_transaction(tid
);
881 trackdb_commit_transaction(tid
);
885 /** @brief notice a possibly new track
886 * @param track NFC UTF-8 track name
887 * @param path Raw path name
888 * @param tid Transaction ID
889 * @return @c DB_NOTFOUND if new, 0 if already known, @c DB_LOCK_DEADLOCK also
891 int trackdb_notice_tid(const char *track
,
895 struct kvp
*t
, *a
, *p
;
899 /* notice whether the tracks.db entry changes */
901 /* get any existing tracks entry */
902 if((err
= gettrackdata(track
, &t
, &p
, 0, 0, tid
)) == DB_LOCK_DEADLOCK
)
904 ret
= err
; /* 0 or DB_NOTFOUND */
905 /* this is a real track */
906 t_changed
+= kvp_set(&t
, "_alias_for", 0);
907 t_changed
+= kvp_set(&t
, "_path", path
);
908 /* if we have an alias record it in the database */
909 if((err
= compute_alias(&alias
, track
, p
, tid
))) return err
;
911 /* won't overwrite someone else's alias as compute_alias() checks */
912 D(("%s: alias %s", track
, alias
));
914 kvp_set(&a
, "_alias_for", track
);
915 if((err
= trackdb_putdata(trackdb_tracksdb
, alias
, a
, tid
, 0))) return err
;
917 /* update search.db */
918 w
= track_to_words(track
, p
);
919 for(n
= 0; w
[n
]; ++n
)
920 if((err
= register_search_word(track
, w
[n
], tid
)))
923 w
= parsetags(kvp_get(p
, "tags"));
924 for(n
= 0; w
[n
]; ++n
)
925 if((err
= register_tag(track
, w
[n
], tid
)))
928 /* only store the tracks.db entry if it has changed */
929 if(t_changed
&& (err
= trackdb_putdata(trackdb_tracksdb
, track
, t
, tid
, 0)))
931 if(ret
== DB_NOTFOUND
) {
932 uint32_t timestamp
[2];
937 timestamp
[0] = htonl((uint64_t)now
>> 32);
938 timestamp
[1] = htonl((uint32_t)now
);
939 memset(&key
, 0, sizeof key
);
940 key
.data
= timestamp
;
941 key
.size
= sizeof timestamp
;
942 switch(err
= trackdb_noticeddb
->put(trackdb_noticeddb
, tid
, &key
,
943 make_key(&data
, track
), 0)) {
945 case DB_LOCK_DEADLOCK
: return err
;
946 default: fatal(0, "error updating noticed.db: %s", db_strerror(err
));
952 /* trackdb_obsolete() ********************************************************/
954 /* obsolete a track */
955 int trackdb_obsolete(const char *track
, DB_TXN
*tid
) {
960 if((err
= gettrackdata(track
, 0, &p
, 0,
961 GTD_NOALIAS
, tid
)) == DB_LOCK_DEADLOCK
)
963 else if(err
== DB_NOTFOUND
) return 0;
964 /* compute the alias, if any, and delete it */
965 if(compute_alias(&alias
, track
, p
, tid
)) return err
;
967 /* if the alias points to some other track then compute_alias won't
969 if(trackdb_delkey(trackdb_tracksdb
, alias
, tid
))
972 /* update search.db */
973 w
= track_to_words(track
, p
);
974 for(n
= 0; w
[n
]; ++n
)
975 if(trackdb_delkeydata(trackdb_searchdb
,
976 w
[n
], track
, tid
) == DB_LOCK_DEADLOCK
)
979 w
= parsetags(kvp_get(p
, "tags"));
980 for(n
= 0; w
[n
]; ++n
)
981 if(trackdb_delkeydata(trackdb_tagsdb
,
982 w
[n
], track
, tid
) == DB_LOCK_DEADLOCK
)
985 /* update tracks.db */
986 if(trackdb_delkey(trackdb_tracksdb
, track
, tid
) == DB_LOCK_DEADLOCK
)
988 /* We don't delete the prefs, so they survive temporary outages of the
989 * (possibly virtual) track filesystem */
993 /* trackdb_stats() ***********************************************************/
995 #define H(name) { #name, offsetof(DB_HASH_STAT, name) }
996 #define B(name) { #name, offsetof(DB_BTREE_STAT, name) }
998 static const struct statinfo
{
1001 } statinfo_hash
[] = {
1017 }, statinfo_btree
[] = {
1038 /* look up stats for DB */
1039 static int get_stats(struct vector
*v
,
1041 const struct statinfo
*si
,
1050 switch(err
= database
->stat(database
, tid
, &sp
, 0)) {
1053 case DB_LOCK_DEADLOCK
:
1054 error(0, "error querying database: %s", db_strerror(err
));
1057 fatal(0, "error querying database: %s", db_strerror(err
));
1059 for(n
= 0; n
< nsi
; ++n
) {
1060 byte_xasprintf(&str
, "%s=%"PRIuMAX
, si
[n
].name
,
1061 (uintmax_t)*(u_int32_t
*)((char *)sp
+ si
[n
].offset
));
1062 vector_append(v
, str
);
1068 struct search_entry
{
1073 /* find the top COUNT words in the search database */
1074 static int search_league(struct vector
*v
, int count
, DB_TXN
*tid
) {
1075 struct search_entry
*se
;
1078 int err
, n
= 0, nse
= 0, i
;
1083 cursor
= trackdb_opencursor(trackdb_searchdb
, tid
);
1084 se
= xmalloc(count
* sizeof *se
);
1085 while(!(err
= cursor
->c_get(cursor
, prepare_data(&k
), prepare_data(&d
),
1087 if(word
&& wl
== k
.size
&& !strncmp(word
, k
.data
, wl
))
1090 #define FINALIZE() do { \
1091 if(word && (nse < count || n > se[nse - 1].n)) { \
1096 while(i > 0 && n > se[i - 1].n) \
1098 memmove(&se[i + 1], &se[i], (nse - i) * sizeof *se); \
1099 se[i].word = word; \
1104 word
= xstrndup(k
.data
, wl
= k
.size
);
1112 case DB_LOCK_DEADLOCK
:
1113 error(0, "error querying search database: %s", db_strerror(err
));
1116 fatal(0, "error querying search database: %s", db_strerror(err
));
1118 if(trackdb_closecursor(cursor
)) err
= DB_LOCK_DEADLOCK
;
1121 byte_xasprintf(&str
, "Top %d search words:", nse
);
1122 vector_append(v
, str
);
1123 for(i
= 0; i
< nse
; ++i
) {
1124 byte_xasprintf(&str
, "%4d: %5d %s", i
+ 1, se
[i
].n
, se
[i
].word
);
1125 vector_append(v
, str
);
1130 #define SI(what) statinfo_##what, \
1131 sizeof statinfo_##what / sizeof (struct statinfo)
1133 /* return a list of database stats */
1134 char **trackdb_stats(int *nstatsp
) {
1140 tid
= trackdb_begin_transaction();
1142 vector_append(&v
, (char *)"Tracks database stats:");
1143 if(get_stats(&v
, trackdb_tracksdb
, SI(btree
), tid
)) goto fail
;
1144 vector_append(&v
, (char *)"");
1145 vector_append(&v
, (char *)"Search database stats:");
1146 if(get_stats(&v
, trackdb_searchdb
, SI(hash
), tid
)) goto fail
;
1147 vector_append(&v
, (char *)"");
1148 vector_append(&v
, (char *)"Prefs database stats:");
1149 if(get_stats(&v
, trackdb_prefsdb
, SI(hash
), tid
)) goto fail
;
1150 vector_append(&v
, (char *)"");
1151 if(search_league(&v
, 10, tid
)) goto fail
;
1152 vector_terminate(&v
);
1155 trackdb_abort_transaction(tid
);
1157 trackdb_commit_transaction(tid
);
1158 if(nstatsp
) *nstatsp
= v
.nvec
;
1162 struct stats_details
{
1163 void (*done
)(char *data
, void *u
);
1165 int exited
; /* subprocess exited */
1166 int closed
; /* pipe close */
1167 int wstat
; /* wait status from subprocess */
1168 struct dynstr data
[1]; /* data read from pipe */
1171 static void stats_complete(struct stats_details
*d
) {
1174 if(!(d
->exited
&& d
->closed
))
1176 byte_xasprintf(&s
, "\n"
1178 "track lookup cache hits: %lu\n"
1179 "track lookup cache misses: %lu\n",
1181 cache_files_misses
);
1182 dynstr_append_string(d
->data
, s
);
1183 dynstr_terminate(d
->data
);
1184 d
->done(d
->data
->vec
, d
->u
);
1187 static int stats_finished(ev_source
attribute((unused
)) *ev
,
1188 pid_t
attribute((unused
)) pid
,
1190 const struct rusage
attribute((unused
)) *rusage
,
1192 struct stats_details
*const d
= u
;
1196 error(0, "disorder-stats %s", wstat(status
));
1201 static int stats_read(ev_source
attribute((unused
)) *ev
,
1207 struct stats_details
*const d
= u
;
1209 dynstr_append_bytes(d
->data
, ptr
, bytes
);
1210 ev_reader_consume(reader
, bytes
);
1217 static int stats_error(ev_source
attribute((unused
)) *ev
,
1220 struct stats_details
*const d
= u
;
1222 error(errno_value
, "error reading from pipe to disorder-stats");
1228 void trackdb_stats_subprocess(ev_source
*ev
,
1229 void (*done
)(char *data
, void *u
),
1233 struct stats_details
*d
= xmalloc(sizeof *d
);
1235 dynstr_init(d
->data
);
1239 pid
= subprogram(ev
, "disorder-stats", p
[1]);
1241 ev_child(ev
, pid
, 0, stats_finished
, d
);
1242 ev_reader_new(ev
, p
[0], stats_read
, stats_error
, d
, "disorder-stats reader");
1245 /* set a pref (remove if value=0) */
1246 int trackdb_set(const char *track
,
1248 const char *value
) {
1249 struct kvp
*t
, *p
, *a
;
1252 char *oldalias
, *newalias
, **oldtags
= 0, **newtags
;
1255 /* TODO: if value matches default then set value=0 */
1259 tid
= trackdb_begin_transaction();
1260 if((err
= gettrackdata(track
, &t
, &p
, 0,
1261 0, tid
)) == DB_LOCK_DEADLOCK
)
1263 if(err
== DB_NOTFOUND
) break;
1264 if(name
[0] == '_') {
1265 if(kvp_set(&t
, name
, value
))
1266 if(trackdb_putdata(trackdb_tracksdb
, track
, t
, tid
, 0))
1269 /* get the old alias name */
1270 if(compute_alias(&oldalias
, track
, p
, tid
)) goto fail
;
1271 /* get the old tags */
1272 if(!strcmp(name
, "tags"))
1273 oldtags
= parsetags(kvp_get(p
, "tags"));
1275 if(kvp_set(&p
, name
, value
))
1276 if(trackdb_putdata(trackdb_prefsdb
, track
, p
, tid
, 0))
1278 /* compute the new alias name */
1279 if((err
= compute_alias(&newalias
, track
, p
, tid
))) goto fail
;
1280 /* check whether alias has changed */
1281 if(!(oldalias
== newalias
1282 || (oldalias
&& newalias
&& !strcmp(oldalias
, newalias
)))) {
1283 /* adjust alias records to fit change */
1285 && trackdb_delkey(trackdb_tracksdb
, oldalias
, tid
)) goto fail
;
1288 kvp_set(&a
, "_alias_for", track
);
1289 if(trackdb_putdata(trackdb_tracksdb
, newalias
, a
, tid
, 0)) goto fail
;
1292 /* check whether tags have changed */
1293 if(!strcmp(name
, "tags")) {
1294 newtags
= parsetags(value
);
1295 while(*oldtags
|| *newtags
) {
1296 if(*oldtags
&& *newtags
) {
1297 cmp
= strcmp(*oldtags
, *newtags
);
1299 /* keeping this tag */
1303 /* old tag fits into a gap in the new list, so delete old */
1306 /* new tag fits into a gap in the old list, so insert new */
1308 } else if(*oldtags
) {
1309 /* we've run out of new tags, so remaining old ones are to be
1312 if(trackdb_delkeydata(trackdb_tagsdb
,
1313 *oldtags
, track
, tid
) == DB_LOCK_DEADLOCK
)
1317 /* we've run out of old tags, so remainig new ones are to be
1320 if(register_tag(track
, *newtags
, tid
)) goto fail
;
1330 trackdb_abort_transaction(tid
);
1332 trackdb_commit_transaction(tid
);
1333 return err
== 0 ?
0 : -1;
1337 const char *trackdb_get(const char *track
,
1339 return kvp_get(trackdb_get_all(track
), name
);
1342 /* get all prefs as a 0-terminated array */
1343 struct kvp
*trackdb_get_all(const char *track
) {
1344 struct kvp
*t
, *p
, **pp
;
1348 tid
= trackdb_begin_transaction();
1349 if(gettrackdata(track
, &t
, &p
, 0, 0, tid
) == DB_LOCK_DEADLOCK
)
1353 trackdb_abort_transaction(tid
);
1355 trackdb_commit_transaction(tid
);
1356 for(pp
= &p
; *pp
; pp
= &(*pp
)->next
)
1363 const char *trackdb_resolve(const char *track
) {
1368 tid
= trackdb_begin_transaction();
1369 if(gettrackdata(track
, 0, 0, &actual
, 0, tid
) == DB_LOCK_DEADLOCK
)
1373 trackdb_abort_transaction(tid
);
1375 trackdb_commit_transaction(tid
);
1379 int trackdb_isalias(const char *track
) {
1380 const char *actual
= trackdb_resolve(track
);
1382 return strcmp(actual
, track
);
1385 /* test whether a track exists (perhaps an alias) */
1386 int trackdb_exists(const char *track
) {
1391 tid
= trackdb_begin_transaction();
1392 /* unusually, here we want the return value */
1393 if((err
= gettrackdata(track
, 0, 0, 0, 0, tid
)) == DB_LOCK_DEADLOCK
)
1397 trackdb_abort_transaction(tid
);
1399 trackdb_commit_transaction(tid
);
1403 /* return the list of tags */
1404 char **trackdb_alltags(void) {
1410 tid
= trackdb_begin_transaction();
1411 err
= trackdb_alltags_tid(tid
, &taglist
);
1413 trackdb_abort_transaction(tid
);
1415 trackdb_commit_transaction(tid
);
1419 static int trackdb_alltags_tid(DB_TXN
*tid
, char ***taglistp
) {
1426 c
= trackdb_opencursor(trackdb_tagsdb
, tid
);
1427 memset(&k
, 0, sizeof k
);
1428 while(!(err
= c
->c_get(c
, &k
, prepare_data(&d
), DB_NEXT_NODUP
)))
1429 vector_append(&v
, xstrndup(k
.data
, k
.size
));
1433 case DB_LOCK_DEADLOCK
:
1436 fatal(0, "c->c_get: %s", db_strerror(err
));
1438 if((err
= trackdb_closecursor(c
))) return err
;
1439 vector_terminate(&v
);
1444 /* return 1 iff sorted tag lists A and B have at least one member in common */
1445 static int tag_intersection(char **a
, char **b
) {
1448 /* Same sort of logic as trackdb_set() above */
1450 if(!(cmp
= strcmp(*a
, *b
))) return 1;
1451 else if(cmp
< 0) ++a
;
1457 /* Check whether a track is suitable for random play. Returns 0 if it is,
1458 * DB_NOTFOUND if it is not or DB_LOCK_DEADLOCK if the database gave us
1460 static int check_suitable(const char *track
,
1462 char **required_tags
,
1463 char **prohibited_tags
) {
1467 const char *pick_at_random
, *played_time
;
1469 /* don't pick tracks that aren't in any surviving collection (for instance
1470 * you've edited the config but the rescan hasn't done its job yet) */
1471 if(!find_track_root(track
)) {
1472 info("found track not in any collection: %s", track
);
1475 /* don't pick aliases - only pick the canonical form */
1476 if(gettrackdata(track
, &t
, &p
, 0, 0, tid
) == DB_LOCK_DEADLOCK
)
1477 return DB_LOCK_DEADLOCK
;
1478 if(kvp_get(t
, "_alias_for"))
1480 /* check that random play is not suppressed for this track */
1481 if((pick_at_random
= kvp_get(p
, "pick_at_random"))
1482 && !strcmp(pick_at_random
, "0"))
1484 /* don't pick a track that's been played in the last 8 hours */
1485 if((played_time
= kvp_get(p
, "played_time"))) {
1486 last
= atoll(played_time
);
1488 if(now
< last
+ 8 * 3600) /* TODO configurable */
1491 track_tags
= parsetags(kvp_get(p
, "tags"));
1492 /* check that no prohibited tag is present for this track */
1493 if(prohibited_tags
&& tag_intersection(track_tags
, prohibited_tags
))
1495 /* check that at least one required tags is present for this track */
1496 if(*required_tags
&& !tag_intersection(track_tags
, required_tags
))
1501 /* attempt to pick a random non-alias track */
1502 const char *trackdb_random(int tries
) {
1507 const char *track
, *candidate
;
1510 char **required_tags
, **prohibited_tags
, **tp
;
1515 tid
= trackdb_begin_transaction();
1516 if((err
= trackdb_get_global_tid("required-tags", tid
, &tags
)))
1518 required_tags
= parsetags(tags
);
1519 if((err
= trackdb_get_global_tid("prohibited-tags", tid
, &tags
)))
1521 prohibited_tags
= parsetags(tags
);
1523 if(*required_tags
) {
1524 /* Bung all the suitable tracks into a hash and convert to a list of keys
1525 * (to eliminate duplicates). We cache this list since it is possible
1526 * that it will be very large. */
1529 for(tp
= required_tags
; *tp
; ++tp
) {
1530 c
= trackdb_opencursor(trackdb_tagsdb
, tid
);
1531 memset(&key
, 0, sizeof key
);
1533 key
.size
= strlen(*tp
);
1535 err
= c
->c_get(c
, &key
, prepare_data(&data
), DB_SET
);
1537 hash_add(h
, xstrndup(data
.data
, data
.size
), 0,
1538 HASH_INSERT_OR_REPLACE
);
1540 err
= c
->c_get(c
, &key
, prepare_data(&data
), DB_NEXT_DUP
);
1546 case DB_LOCK_DEADLOCK
:
1549 fatal(0, "error querying tags.db: %s", db_strerror(err
));
1551 trackdb_closecursor(c
);
1554 error(0, "required tag %s does not match any tracks", *tp
);
1556 nreqtracks
= hash_count(h
);
1557 reqtracks
= hash_keys(h
);
1559 while(nreqtracks
&& !track
&& tries
-- > 0) {
1560 r
= (rand() * (double)nreqtracks
/ (RAND_MAX
+ 1.0));
1561 candidate
= reqtracks
[r
];
1562 switch(check_suitable(candidate
, tid
,
1563 required_tags
, prohibited_tags
)) {
1569 case DB_LOCK_DEADLOCK
:
1574 /* No required tags. We pick random record numbers in the database
1576 switch(err
= trackdb_tracksdb
->stat(trackdb_tracksdb
, tid
, &sp
, 0)) {
1579 case DB_LOCK_DEADLOCK
:
1580 error(0, "error querying tracks.db: %s", db_strerror(err
));
1583 fatal(0, "error querying tracks.db: %s", db_strerror(err
));
1586 error(0, "cannot pick tracks at random from an empty database");
1587 while(sp
->bt_nkeys
&& !track
&& tries
-- > 0) {
1588 /* record numbers count from 1 upwards */
1589 r
= 1 + (rand() * (double)sp
->bt_nkeys
/ (RAND_MAX
+ 1.0));
1590 memset(&key
, sizeof key
, 0);
1591 key
.flags
= DB_DBT_MALLOC
;
1592 key
.size
= sizeof r
;
1594 switch(err
= trackdb_tracksdb
->get(trackdb_tracksdb
, tid
, &key
, prepare_data(&data
),
1598 case DB_LOCK_DEADLOCK
:
1599 error(0, "error querying tracks.db: %s", db_strerror(err
));
1602 fatal(0, "error querying tracks.db: %s", db_strerror(err
));
1604 candidate
= xstrndup(key
.data
, key
.size
);
1605 switch(check_suitable(candidate
, tid
,
1606 required_tags
, prohibited_tags
)) {
1612 case DB_LOCK_DEADLOCK
:
1619 trackdb_closecursor(c
);
1621 trackdb_abort_transaction(tid
);
1623 trackdb_commit_transaction(tid
);
1625 error(0, "could not pick a random track");
1629 /* get a track name given the prefs. Set *used_db to 1 if we got the answer
1630 * from the prefs. */
1631 static const char *getpart(const char *track
,
1632 const char *context
,
1634 const struct kvp
*p
,
1639 byte_xasprintf(&pref
, "trackname_%s_%s", context
, part
);
1640 if((result
= kvp_get(p
, pref
)))
1643 result
= trackname_part(track
, context
, part
);
1644 assert(result
!= 0);
1648 /* get a track name part, like trackname_part(), but taking the database into
1650 const char *trackdb_getpart(const char *track
,
1651 const char *context
,
1659 /* construct the full pref */
1660 byte_xasprintf(&pref
, "trackname_%s_%s", context
, part
);
1662 tid
= trackdb_begin_transaction();
1663 if((err
= gettrackdata(track
, 0, &p
, &actual
, 0, tid
)) == DB_LOCK_DEADLOCK
)
1667 trackdb_abort_transaction(tid
);
1669 trackdb_commit_transaction(tid
);
1670 return getpart(actual
, context
, part
, p
, &used_db
);
1673 /* get the raw path name for @track@ (might be an alias) */
1674 const char *trackdb_rawpath(const char *track
) {
1680 tid
= trackdb_begin_transaction();
1681 if(gettrackdata(track
, &t
, 0, 0, 0, tid
) == DB_LOCK_DEADLOCK
)
1685 trackdb_abort_transaction(tid
);
1687 trackdb_commit_transaction(tid
);
1688 if(!(path
= kvp_get(t
, "_path"))) path
= track
;
1692 /* trackdb_list **************************************************************/
1694 /* this is incredibly ugly, sorry, perhaps it will be rewritten to be actually
1695 * readable at some point */
1697 /* return true if the basename of TRACK[0..TL-1], as defined by DL, matches RE.
1698 * If RE is a null pointer then it matches everything. */
1699 static int track_matches(size_t dl
, const char *track
, size_t tl
,
1707 switch(rc
= pcre_exec(re
, 0, track
, tl
, 0, 0, ovec
, 3)) {
1708 case PCRE_ERROR_NOMATCH
: return 0;
1711 error(0, "pcre_exec returned %d, subject '%s'", rc
, track
);
1718 static int do_list(struct vector
*v
, const char *dir
,
1719 enum trackdb_listable what
, const pcre
*re
, DB_TXN
*tid
) {
1725 size_t l
, last_dir_len
= 0;
1726 char *last_dir
= 0, *track
, *alias
;
1730 cursor
= trackdb_opencursor(trackdb_tracksdb
, tid
);
1733 /* find the first key >= dir */
1734 err
= cursor
->c_get(cursor
, &k
, &d
, DB_SET_RANGE
);
1735 /* keep going while we're dealing with <dir/anything> */
1738 && ((char *)k
.data
)[dl
] == '/'
1739 && !memcmp(k
.data
, dir
, dl
)) {
1740 ptr
= memchr((char *)k
.data
+ dl
+ 1, '/', k
.size
- (dl
+ 1));
1742 /* we have <dir/component/anything>, so <dir/component> is a directory */
1743 l
= ptr
- (char *)k
.data
;
1744 if(what
& trackdb_directories
)
1746 && l
== last_dir_len
1747 && !memcmp(last_dir
, k
.data
, l
))) {
1748 last_dir
= xstrndup(k
.data
, last_dir_len
= l
);
1749 if(track_matches(dl
, k
.data
, l
, re
))
1750 vector_append(v
, last_dir
);
1753 /* found a plain file */
1754 if((what
& trackdb_files
)) {
1755 track
= xstrndup(k
.data
, k
.size
);
1756 if((err
= trackdb_getdata(trackdb_prefsdb
,
1757 track
, &p
, tid
)) == DB_LOCK_DEADLOCK
)
1759 /* if this file has an alias in the same directory then we skip it */
1760 if((err
= compute_alias(&alias
, track
, p
, tid
)))
1762 if(!(alias
&& !strcmp(d_dirname(alias
), d_dirname(track
))))
1763 if(track_matches(dl
, k
.data
, k
.size
, re
))
1764 vector_append(v
, track
);
1767 err
= cursor
->c_get(cursor
, &k
, &d
, DB_NEXT
);
1775 case DB_LOCK_DEADLOCK
:
1776 error(0, "error querying database: %s", db_strerror(err
));
1779 fatal(0, "error querying database: %s", db_strerror(err
));
1782 if(trackdb_closecursor(cursor
)) err
= DB_LOCK_DEADLOCK
;
1786 /* return the directories or files below @dir@ */
1787 char **trackdb_list(const char *dir
, int *np
, enum trackdb_listable what
,
1795 tid
= trackdb_begin_transaction();
1798 if(do_list(&v
, dir
, what
, re
, tid
))
1801 for(n
= 0; n
< config
->collection
.n
; ++n
)
1802 if(do_list(&v
, config
->collection
.s
[n
].root
, what
, re
, tid
))
1807 trackdb_abort_transaction(tid
);
1809 trackdb_commit_transaction(tid
);
1810 vector_terminate(&v
);
1816 /* If S is tag:something, return something. Else return 0. */
1817 static const char *checktag(const char *s
) {
1818 if(!strncmp(s
, "tag:", 4))
1824 /* return a list of tracks containing all of the words given. If you
1825 * ask for only stopwords you get no tracks. */
1826 char **trackdb_search(char **wordlist
, int nwordlist
, int *ntracks
) {
1827 const char **w
, *best
= 0, *tag
;
1828 char **twords
, **tags
;
1829 int i
, j
, n
, err
, what
;
1839 *ntracks
= 0; /* for early returns */
1840 /* normalize all the words */
1841 w
= xmalloc(nwordlist
* sizeof (char *));
1842 for(n
= 0; n
< nwordlist
; ++n
) {
1846 w
[n
] = utf8_casefold_compat(wordlist
[n
], strlen(wordlist
[n
]), 0);
1847 if(checktag(w
[n
])) ++ntags
; /* count up tags */
1848 /* Strip out combining characters (AFTER checking whether it's a tag) */
1849 if(!(w32
= utf8_to_utf32(w
[n
], strlen(w
[n
]), &nw32
)))
1851 nw32
= remove_combining_chars(w32
, nw32
);
1852 if(!(w
[n
] = utf32_to_utf8(w32
, nw32
, 0)))
1855 /* find the longest non-stopword */
1856 for(n
= 0; n
< nwordlist
; ++n
)
1857 if(!stopword(w
[n
]) && !checktag(w
[n
]))
1858 if(!best
|| strlen(w
[n
]) > strlen(best
))
1860 /* TODO: we should at least in principal be able to identify the word or tag
1861 * with the least matches in log time, and choose that as our primary search
1863 if(ntags
&& !best
) {
1864 /* Only tags are listed. We limit to the first and narrow down with the
1866 best
= checktag(w
[0]);
1867 db
= trackdb_tagsdb
;
1870 /* We can limit to some word. */
1871 db
= trackdb_searchdb
;
1874 /* Only stopwords */
1880 tid
= trackdb_begin_transaction();
1881 /* find all the tracks that have that word */
1886 cursor
= trackdb_opencursor(db
, tid
);
1887 while(!(err
= cursor
->c_get(cursor
, &k
, &d
, what
))) {
1888 vector_append(&v
, xstrndup(d
.data
, d
.size
));
1895 case DB_LOCK_DEADLOCK
:
1896 error(0, "error querying %s database: %s", dbname
, db_strerror(err
));
1899 fatal(0, "error querying %s database: %s", dbname
, db_strerror(err
));
1901 if(trackdb_closecursor(cursor
)) err
= DB_LOCK_DEADLOCK
;
1903 /* do a naive search over that (hopefuly fairly small) list of tracks */
1905 for(n
= 0; n
< v
.nvec
; ++n
) {
1906 if((err
= gettrackdata(v
.vec
[n
], 0, &p
, 0, 0, tid
) == DB_LOCK_DEADLOCK
))
1909 error(0, "track %s unexpected error: %s", v
.vec
[n
], db_strerror(err
));
1912 twords
= track_to_words(v
.vec
[n
], p
);
1913 tags
= parsetags(kvp_get(p
, "tags"));
1914 for(i
= 0; i
< nwordlist
; ++i
) {
1915 if((tag
= checktag(w
[i
]))) {
1916 /* Track must have this tag */
1917 for(j
= 0; tags
[j
]; ++j
)
1918 if(!strcmp(tag
, tags
[j
])) break; /* tag found */
1919 if(!tags
[j
]) break; /* tag not found */
1921 /* Track must contain this word */
1922 for(j
= 0; twords
[j
]; ++j
)
1923 if(!strcmp(w
[i
], twords
[j
])) break; /* word found */
1924 if(!twords
[j
]) break; /* word not found */
1927 if(i
>= nwordlist
) /* all words found */
1928 vector_append(&u
, v
.vec
[n
]);
1932 trackdb_closecursor(cursor
);
1934 trackdb_abort_transaction(tid
);
1935 info("retrying search");
1937 trackdb_commit_transaction(tid
);
1938 vector_terminate(&u
);
1944 /* trackdb_scan **************************************************************/
1946 int trackdb_scan(const char *root
,
1947 int (*callback
)(const char *track
,
1955 const size_t root_len
= root ?
strlen(root
) : 0;
1960 cursor
= trackdb_opencursor(trackdb_tracksdb
, tid
);
1962 err
= cursor
->c_get(cursor
, make_key(&k
, root
), prepare_data(&d
),
1965 memset(&k
, 0, sizeof k
);
1966 err
= cursor
->c_get(cursor
, &k
, prepare_data(&d
),
1971 || (k
.size
> root_len
1972 && !strncmp(k
.data
, root
, root_len
)
1973 && ((char *)k
.data
)[root_len
] == '/')) {
1974 data
= kvp_urldecode(d
.data
, d
.size
);
1975 if(kvp_get(data
, "_path")) {
1976 track
= xstrndup(k
.data
, k
.size
);
1977 /* Advance to the next track before the callback so that the callback
1978 * may safely delete the track */
1979 err
= cursor
->c_get(cursor
, &k
, &d
, DB_NEXT
);
1980 if((cberr
= callback(track
, data
, u
, tid
))) {
1985 err
= cursor
->c_get(cursor
, &k
, &d
, DB_NEXT
);
1989 trackdb_closecursor(cursor
);
1996 case DB_LOCK_DEADLOCK
:
1997 error(0, "c->c_get: %s", db_strerror(err
));
2000 fatal(0, "c->c_get: %s", db_strerror(err
));
2004 /* trackdb_rescan ************************************************************/
2006 /* called when the rescanner terminates */
2007 static int reap_rescan(ev_source
attribute((unused
)) *ev
,
2010 const struct rusage
attribute((unused
)) *rusage
,
2011 void attribute((unused
)) *u
) {
2012 if(pid
== rescan_pid
) rescan_pid
= -1;
2014 error(0, RESCAN
": %s", wstat(status
));
2016 D((RESCAN
" terminated: %s", wstat(status
)));
2017 /* Our cache of file lookups is out of date now */
2018 cache_clean(&cache_files_type
);
2019 eventlog("rescanned", (char *)0);
2023 void trackdb_rescan(ev_source
*ev
) {
2026 if(rescan_pid
!= -1) {
2027 error(0, "rescan already underway");
2030 rescan_pid
= subprogram(ev
, RESCAN
, -1);
2032 ev_child(ev
, rescan_pid
, 0, reap_rescan
, 0);
2033 D(("started rescanner"));
2035 /* This is the first rescan, we block until it is complete */
2036 while(waitpid(rescan_pid
, &w
, 0) < 0 && errno
== EINTR
)
2038 reap_rescan(0, rescan_pid
, w
, 0, 0);
2042 int trackdb_rescan_cancel(void) {
2043 if(rescan_pid
== -1) return 0;
2044 if(kill(rescan_pid
, SIGTERM
) < 0)
2045 fatal(errno
, "error killing rescanner");
2050 /* global prefs **************************************************************/
2052 void trackdb_set_global(const char *name
,
2060 tid
= trackdb_begin_transaction();
2061 if(!(err
= trackdb_set_global_tid(name
, value
, tid
)))
2063 trackdb_abort_transaction(tid
);
2065 trackdb_commit_transaction(tid
);
2066 /* log important state changes */
2067 if(!strcmp(name
, "playing")) {
2068 state
= !value
|| !strcmp(value
, "yes");
2069 info("playing %s by %s",
2070 state ?
"enabled" : "disabled",
2072 eventlog("state", state ?
"enable_play" : "disable_play", (char *)0);
2074 if(!strcmp(name
, "random-play")) {
2075 state
= !value
|| !strcmp(value
, "yes");
2076 info("random play %s by %s",
2077 state ?
"enabled" : "disabled",
2079 eventlog("state", state ?
"enable_random" : "disable_random", (char *)0);
2081 if(!strcmp(name
, "required-tags"))
2085 int trackdb_set_global_tid(const char *name
,
2091 memset(&k
, 0, sizeof k
);
2092 memset(&d
, 0, sizeof d
);
2093 k
.data
= (void *)name
;
2094 k
.size
= strlen(name
);
2096 d
.data
= (void *)value
;
2097 d
.size
= strlen(value
);
2100 err
= trackdb_globaldb
->put(trackdb_globaldb
, tid
, &k
, &d
, 0);
2102 err
= trackdb_globaldb
->del(trackdb_globaldb
, tid
, &k
, 0);
2103 if(err
== DB_LOCK_DEADLOCK
) return err
;
2105 fatal(0, "error updating database: %s", db_strerror(err
));
2109 const char *trackdb_get_global(const char *name
) {
2115 tid
= trackdb_begin_transaction();
2116 if(!(err
= trackdb_get_global_tid(name
, tid
, &r
)))
2118 trackdb_abort_transaction(tid
);
2120 trackdb_commit_transaction(tid
);
2124 int trackdb_get_global_tid(const char *name
,
2130 memset(&k
, 0, sizeof k
);
2131 k
.data
= (void *)name
;
2132 k
.size
= strlen(name
);
2133 switch(err
= trackdb_globaldb
->get(trackdb_globaldb
, tid
, &k
,
2134 prepare_data(&d
), 0)) {
2136 *rp
= xstrndup(d
.data
, d
.size
);
2141 case DB_LOCK_DEADLOCK
:
2144 fatal(0, "error reading database: %s", db_strerror(err
));
2148 /** @brief Retrieve the most recently added tracks
2149 * @param ntracksp Where to put count, or 0
2150 * @param maxtracks Maximum number of tracks to retrieve
2151 * @return null-terminated array of track names
2153 * The most recently added track is first in the array.
2155 char **trackdb_new(int *ntracksp
,
2161 tid
= trackdb_begin_transaction();
2162 tracks
= trackdb_new_tid(ntracksp
, maxtracks
, tid
);
2165 trackdb_abort_transaction(tid
);
2167 trackdb_commit_transaction(tid
);
2171 /** @brief Retrieve the most recently added tracks
2172 * @param ntracksp Where to put count, or 0
2173 * @param maxtracks Maximum number of tracks to retrieve, or 0 for all
2174 * @param tid Transaction ID
2175 * @return null-terminated array of track names, or NULL on deadlock
2177 * The most recently added track is first in the array.
2179 static char **trackdb_new_tid(int *ntracksp
,
2185 struct vector tracks
[1];
2187 vector_init(tracks
);
2188 c
= trackdb_opencursor(trackdb_noticeddb
, tid
);
2189 while((maxtracks
<= 0 || tracks
->nvec
< maxtracks
)
2190 && !(err
= c
->c_get(c
, prepare_data(&k
), prepare_data(&d
), DB_PREV
)))
2191 vector_append(tracks
, xstrndup(d
.data
, d
.size
));
2193 case 0: /* hit maxtracks */
2194 case DB_NOTFOUND
: /* ran out of tracks */
2196 case DB_LOCK_DEADLOCK
:
2197 trackdb_closecursor(c
);
2200 fatal(0, "error reading noticed.db: %s", db_strerror(err
));
2202 if((err
= trackdb_closecursor(c
)))
2203 return 0; /* deadlock */
2204 vector_terminate(tracks
);
2206 *ntracksp
= tracks
->nvec
;
2210 /** @brief Expire noticed.db
2211 * @param earliest Earliest timestamp to keep
2213 void trackdb_expire_noticed(time_t earliest
) {
2217 tid
= trackdb_begin_transaction();
2218 if(!trackdb_expire_noticed_tid(earliest
, tid
))
2220 trackdb_abort_transaction(tid
);
2222 trackdb_commit_transaction(tid
);
2225 /** @brief Expire noticed.db
2226 * @param earliest Earliest timestamp to keep
2227 * @param tid Transaction ID
2228 * @return 0 or DB_LOCK_DEADLOCK
2230 static int trackdb_expire_noticed_tid(time_t earliest
, DB_TXN
*tid
) {
2238 c
= trackdb_opencursor(trackdb_noticeddb
, tid
);
2239 while(!(err
= c
->c_get(c
, prepare_data(&k
), prepare_data(&d
), DB_NEXT
))) {
2241 when
= (time_t)(((uint64_t)ntohl(kk
[0]) << 32) + ntohl(kk
[1]));
2242 if(when
>= earliest
)
2244 if((err
= c
->c_del(c
, 0))) {
2245 if(err
!= DB_LOCK_DEADLOCK
)
2246 fatal(0, "error deleting expired noticed.db entry: %s",
2252 if(err
== DB_NOTFOUND
)
2254 if(err
&& err
!= DB_LOCK_DEADLOCK
)
2255 fatal(0, "error expiring noticed.db: %s", db_strerror(err
));
2257 if((err
= trackdb_closecursor(c
))) {
2258 if(err
!= DB_LOCK_DEADLOCK
)
2259 fatal(0, "error closing cursor: %s", db_strerror(err
));
2263 info("expired %d tracks from noticed.db", count
);
2267 /* tidying up ****************************************************************/
2269 void trackdb_gc(void) {
2273 if((err
= trackdb_env
->txn_checkpoint(trackdb_env
,
2274 config
->checkpoint_kbyte
,
2275 config
->checkpoint_min
,
2277 fatal(0, "trackdb_env->txn_checkpoint: %s", db_strerror(err
));
2278 if((err
= trackdb_env
->log_archive(trackdb_env
, &logfiles
, DB_ARCH_REMOVE
)))
2279 fatal(0, "trackdb_env->log_archive: %s", db_strerror(err
));
2280 /* This makes catastrophic recovery impossible. However, the user can still
2281 * preserve the important data by using disorder-dump to snapshot their
2282 * prefs, and later to restore it. This is likely to have much small
2283 * long-term storage requirements than record the db logfiles. */
2291 indent-tabs-mode:nil