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
);
74 static char *normalize_tag(const char *s
, size_t ns
);
76 const struct cache_type cache_files_type
= { 86400 };
77 unsigned long cache_files_hits
, cache_files_misses
;
79 /** @brief Set by trackdb_open() */
80 int trackdb_existing_database
;
82 /* setup and teardown ********************************************************/
84 static const char *home
; /* home had better not change */
85 DB_ENV
*trackdb_env
; /* db environment */
87 /** @brief The tracks database
88 * - Keys are UTF-8(NFC(unicode(path name)))
89 * - Values are encoded key-value pairs
90 * - Data is reconstructable data about tracks that currently exist
94 /** @brief The preferences database
96 * - Keys are UTF-8(NFC(unicode(path name)))
97 * - Values are encoded key-value pairs
98 * - Data is user data about tracks (that might not exist any more)
99 * and cannot be reconstructed
103 /** @brief The search database
105 * - Keys are UTF-8(NFKC(casefold(search term)))
106 * - Values are UTF-8(NFC(unicode(path name)))
107 * - There can be more than one value per key
108 * - Presence of key,value means that path matches the search terms
109 * - Only tracks fond in @ref tracks_tracksdb are represented here
110 * - This database can be reconstructed, it contains no user data
112 DB
*trackdb_searchdb
;
114 /** @brief The tags database
116 * - Keys are UTF-8(NFKC(casefold(tag)))
117 * - Values are UTF-8(NFC(unicode(path name)))
118 * - There can be more than one value per key
119 * - Presence of key,value means that path matches the tag
120 * - This is always in sync with the tags preference
121 * - This database can be reconstructed, it contains no user data
123 DB
*trackdb_tagsdb
; /* the tags database */
125 /** @brief The global preferences database
126 * - Keys are UTF-8(NFC(preference))
127 * - Values are global preference values
128 * - Data is user data and cannot be reconstructed
130 DB
*trackdb_globaldb
; /* global preferences */
132 /** @brief The noticed database
133 * - Keys are 64-bit big-endian timestamps
134 * - Values are UTF-8(NFC(unicode(path name)))
135 * - There can be more than one value per key
136 * - Presence of key,value means that path was added at the given time
137 * - Data cannot be reconstructed (but isn't THAT important)
139 DB
*trackdb_noticeddb
; /* when track noticed */
140 static pid_t db_deadlock_pid
= -1; /* deadlock manager PID */
141 static pid_t rescan_pid
= -1; /* rescanner PID */
142 static int initialized
, opened
; /* state */
144 /* tracks matched by required_tags */
145 static char **reqtracks
;
146 static size_t nreqtracks
;
148 /* comparison function for keys */
149 static int compare(DB
attribute((unused
)) *db_
,
150 const DBT
*a
, const DBT
*b
) {
151 return compare_path_raw(a
->data
, a
->size
, b
->data
, b
->size
);
154 /** @brief Open database environment
155 * @param flags Flags word
157 * Flags should be one of:
158 * - @ref TRACKDB_NO_RECOVER
159 * - @ref TRACKDB_NORMAL_RECOVER
160 * - @ref TRACKDB_FATAL_RECOVER
162 void trackdb_init(int flags
) {
164 const int recover
= flags
& TRACKDB_RECOVER_MASK
;
165 static int recover_type
[] = { 0, DB_RECOVER
, DB_RECOVER_FATAL
};
168 assert(initialized
== 0);
171 if(strcmp(home
, config
->home
))
172 fatal(0, "cannot change db home without server restart");
176 /* create environment */
177 if((err
= db_env_create(&trackdb_env
, 0))) fatal(0, "db_env_create: %s",
179 if((err
= trackdb_env
->set_alloc(trackdb_env
,
180 xmalloc_noptr
, xrealloc_noptr
, xfree
)))
181 fatal(0, "trackdb_env->set_alloc: %s", db_strerror(err
));
182 if((err
= trackdb_env
->set_lk_max_locks(trackdb_env
, 10000)))
183 fatal(0, "trackdb_env->set_lk_max_locks: %s", db_strerror(err
));
184 if((err
= trackdb_env
->set_lk_max_objects(trackdb_env
, 10000)))
185 fatal(0, "trackdb_env->set_lk_max_objects: %s", db_strerror(err
));
186 if((err
= trackdb_env
->open(trackdb_env
, config
->home
,
192 |recover_type
[recover
],
194 fatal(0, "trackdb_env->open %s: %s", config
->home
, db_strerror(err
));
195 trackdb_env
->set_errpfx(trackdb_env
, "DB");
196 trackdb_env
->set_errfile(trackdb_env
, stderr
);
197 trackdb_env
->set_verbose(trackdb_env
, DB_VERB_DEADLOCK
, 1);
198 trackdb_env
->set_verbose(trackdb_env
, DB_VERB_RECOVERY
, 1);
199 trackdb_env
->set_verbose(trackdb_env
, DB_VERB_REPLICATION
, 1);
200 D(("initialized database environment"));
203 /* called when deadlock manager terminates */
204 static int reap_db_deadlock(ev_source
attribute((unused
)) *ev
,
205 pid_t
attribute((unused
)) pid
,
207 const struct rusage
attribute((unused
)) *rusage
,
208 void attribute((unused
)) *u
) {
209 db_deadlock_pid
= -1;
211 fatal(0, "deadlock manager unexpectedly terminated: %s",
214 D(("deadlock manager terminated: %s", wstat(status
)));
218 static pid_t
subprogram(ev_source
*ev
, const char *prog
,
222 /* If we're in the background then trap subprocess stdout/stderr */
223 if(!(pid
= xfork())) {
226 ev_signal_atfork(ev
);
227 signal(SIGPIPE
, SIG_DFL
);
232 /* If we were negatively niced, undo it. We don't bother checking for
233 * error, it's not that important. */
234 setpriority(PRIO_PROCESS
, 0, 0);
235 execlp(prog
, prog
, "--config", configfile
,
236 debugging ?
"--debug" : "--no-debug",
237 log_default
== &log_syslog ?
"--syslog" : "--no-syslog",
239 fatal(errno
, "error invoking %s", prog
);
244 /* start deadlock manager */
245 void trackdb_master(ev_source
*ev
) {
246 assert(db_deadlock_pid
== -1);
247 db_deadlock_pid
= subprogram(ev
, DEADLOCK
, -1);
248 ev_child(ev
, db_deadlock_pid
, 0, reap_db_deadlock
, 0);
249 D(("started deadlock manager"));
252 /* close environment */
253 void trackdb_deinit(void) {
257 assert(initialized
== 1);
260 /* close the environment */
261 if((err
= trackdb_env
->close(trackdb_env
, 0)))
262 fatal(0, "trackdb_env->close: %s", db_strerror(err
));
264 if(rescan_pid
!= -1 && kill(rescan_pid
, SIGTERM
) < 0)
265 fatal(errno
, "error killing rescanner");
267 /* terminate the deadlock manager */
268 if(db_deadlock_pid
!= -1 && kill(db_deadlock_pid
, SIGTERM
) < 0)
269 fatal(errno
, "error killing deadlock manager");
270 db_deadlock_pid
= -1;
272 D(("deinitialized database environment"));
275 /* open a specific database */
276 static DB
*open_db(const char *path
,
284 D(("open %s", path
));
285 path
= config_get_file(path
);
286 if((err
= db_create(&db
, trackdb_env
, 0)))
287 fatal(0, "db_create %s: %s", path
, db_strerror(err
));
289 if((err
= db
->set_flags(db
, dbflags
)))
290 fatal(0, "db->set_flags %s: %s", path
, db_strerror(err
));
291 if(dbtype
== DB_BTREE
)
292 if((err
= db
->set_bt_compare(db
, compare
)))
293 fatal(0, "db->set_bt_compare %s: %s", path
, db_strerror(err
));
294 if((err
= db
->open(db
, 0, path
, 0, dbtype
,
295 openflags
| DB_AUTO_COMMIT
, mode
))) {
296 if((openflags
& DB_CREATE
) || errno
!= ENOENT
)
297 fatal(0, "db->open %s: %s", path
, db_strerror(err
));
304 /** @brief Open track databases
305 * @param Flags flags word
307 * @p flags should be one of:
308 * - @p TRACKDB_NO_UPGRADE, if no upgrade should be attempted
309 * - @p TRACKDB_CAN_UPGRADE, if an upgrade may be attempted
310 * - @p TRACKDB_OPEN_FOR_UPGRADE, if this is disorder-dbupgrade
312 void trackdb_open(int flags
) {
319 /* check the database version first */
320 trackdb_globaldb
= open_db("global.db", 0, DB_HASH
, 0, 0666);
321 if(trackdb_globaldb
) {
322 /* This is an existing database */
326 s
= trackdb_get_global("_dbversion");
327 /* Close the database again, we'll open it property below */
328 if((err
= trackdb_globaldb
->close(trackdb_globaldb
, 0)))
329 fatal(0, "error closing global.db: %s", db_strerror(err
));
330 trackdb_globaldb
= 0;
331 /* Convert version string to an integer */
332 oldversion
= s ?
atol(s
) : 1;
333 if(oldversion
> config
->dbversion
) {
334 /* Database is from the future; we never allow this. */
335 fatal(0, "this version of DisOrder is too old for database version %ld",
338 if(oldversion
< config
->dbversion
) {
339 /* Database version is out of date */
340 switch(flags
& TRACKDB_UPGRADE_MASK
) {
341 case TRACKDB_NO_UPGRADE
:
342 /* This database needs upgrading but this is not permitted */
343 fatal(0, "database needs upgrading from %ld to %ld",
344 oldversion
, config
->dbversion
);
345 case TRACKDB_CAN_UPGRADE
:
346 /* This database needs upgrading */
347 info("invoking disorder-dbupgrade to upgrade from %ld to %ld",
348 oldversion
, config
->dbversion
);
349 pid
= subprogram(0, "disorder-dbupgrade", -1);
350 while(waitpid(pid
, &err
, 0) == -1 && errno
== EINTR
)
353 fatal(0, "disorder-dbupgrade %s", wstat(err
));
354 info("disorder-dbupgrade succeeded");
356 case TRACKDB_OPEN_FOR_UPGRADE
:
362 if(oldversion
== config
->dbversion
&& (flags
& TRACKDB_OPEN_FOR_UPGRADE
)) {
363 /* This doesn't make any sense */
364 fatal(0, "database is already at current version");
366 trackdb_existing_database
= 1;
368 if(flags
& TRACKDB_OPEN_FOR_UPGRADE
) {
369 /* Cannot upgrade a new database */
370 fatal(0, "cannot upgrade a database that does not exist");
372 /* This is a brand new database */
373 trackdb_existing_database
= 0;
375 /* open the databases */
376 trackdb_tracksdb
= open_db("tracks.db",
377 DB_RECNUM
, DB_BTREE
, DB_CREATE
, 0666);
378 trackdb_searchdb
= open_db("search.db",
379 DB_DUP
|DB_DUPSORT
, DB_HASH
, DB_CREATE
, 0666);
380 trackdb_tagsdb
= open_db("tags.db",
381 DB_DUP
|DB_DUPSORT
, DB_HASH
, DB_CREATE
, 0666);
382 trackdb_prefsdb
= open_db("prefs.db", 0, DB_HASH
, DB_CREATE
, 0666);
383 trackdb_globaldb
= open_db("global.db", 0, DB_HASH
, DB_CREATE
, 0666);
384 trackdb_noticeddb
= open_db("noticed.db",
385 DB_DUPSORT
, DB_BTREE
, DB_CREATE
, 0666);
386 if(!trackdb_existing_database
) {
387 /* Stash the database version */
390 assert(!(flags
& TRACKDB_OPEN_FOR_UPGRADE
));
391 snprintf(buf
, sizeof buf
, "%ld", config
->dbversion
);
392 trackdb_set_global("_dbversion", buf
, 0);
394 D(("opened databases"));
397 /* close track databases */
398 void trackdb_close(void) {
404 if((err
= trackdb_tracksdb
->close(trackdb_tracksdb
, 0)))
405 fatal(0, "error closing tracks.db: %s", db_strerror(err
));
406 if((err
= trackdb_searchdb
->close(trackdb_searchdb
, 0)))
407 fatal(0, "error closing search.db: %s", db_strerror(err
));
408 if((err
= trackdb_tagsdb
->close(trackdb_tagsdb
, 0)))
409 fatal(0, "error closing tags.db: %s", db_strerror(err
));
410 if((err
= trackdb_prefsdb
->close(trackdb_prefsdb
, 0)))
411 fatal(0, "error closing prefs.db: %s", db_strerror(err
));
412 if((err
= trackdb_globaldb
->close(trackdb_globaldb
, 0)))
413 fatal(0, "error closing global.db: %s", db_strerror(err
));
414 if((err
= trackdb_noticeddb
->close(trackdb_noticeddb
, 0)))
415 fatal(0, "error closing noticed.db: %s", db_strerror(err
));
416 trackdb_tracksdb
= trackdb_searchdb
= trackdb_prefsdb
= 0;
417 trackdb_tagsdb
= trackdb_globaldb
= 0;
418 D(("closed databases"));
421 /* generic db routines *******************************************************/
423 /* fetch and decode a database entry. Returns 0, DB_NOTFOUND or
424 * DB_LOCK_DEADLOCK. */
425 int trackdb_getdata(DB
*db
,
432 switch(err
= db
->get(db
, tid
, make_key(&key
, track
),
433 prepare_data(&data
), 0)) {
435 *kp
= kvp_urldecode(data
.data
, data
.size
);
440 case DB_LOCK_DEADLOCK
:
441 error(0, "error querying database: %s", db_strerror(err
));
444 fatal(0, "error querying database: %s", db_strerror(err
));
448 /* encode and store a database entry. Returns 0, DB_KEYEXIST or
449 * DB_LOCK_DEADLOCK. */
450 int trackdb_putdata(DB
*db
,
458 switch(err
= db
->put(db
, tid
, make_key(&key
, track
),
459 encode_data(&data
, k
), flags
)) {
463 case DB_LOCK_DEADLOCK
:
464 error(0, "error updating database: %s", db_strerror(err
));
467 fatal(0, "error updating database: %s", db_strerror(err
));
471 /* delete a database entry */
472 int trackdb_delkey(DB
*db
,
478 switch(err
= db
->del(db
, tid
, make_key(&key
, track
), 0)) {
482 case DB_LOCK_DEADLOCK
:
483 error(0, "error updating database: %s", db_strerror(err
));
486 fatal(0, "error updating database: %s", db_strerror(err
));
490 /* open a database cursor */
491 DBC
*trackdb_opencursor(DB
*db
, DB_TXN
*tid
) {
495 switch(err
= db
->cursor(db
, tid
, &c
, 0)) {
497 default: fatal(0, "error creating cursor: %s", db_strerror(err
));
502 /* close a database cursor; returns 0 or DB_LOCK_DEADLOCK */
503 int trackdb_closecursor(DBC
*c
) {
507 switch(err
= c
->c_close(c
)) {
510 case DB_LOCK_DEADLOCK
:
511 error(0, "error closing cursor: %s", db_strerror(err
));
514 fatal(0, "error closing cursor: %s", db_strerror(err
));
518 /* delete a (key,data) pair. Returns 0, DB_NOTFOUND or DB_LOCK_DEADLOCK. */
519 int trackdb_delkeydata(DB
*db
,
527 c
= trackdb_opencursor(db
, tid
);
528 switch(err
= c
->c_get(c
, make_key(&key
, word
),
529 make_key(&data
, track
), DB_GET_BOTH
)) {
531 switch(err
= c
->c_del(c
, 0)) {
537 case DB_LOCK_DEADLOCK
:
538 error(0, "error updating database: %s", db_strerror(err
));
541 fatal(0, "c->c_del: %s", db_strerror(err
));
546 case DB_LOCK_DEADLOCK
:
547 error(0, "error updating database: %s", db_strerror(err
));
550 fatal(0, "c->c_get: %s", db_strerror(err
));
552 if(trackdb_closecursor(c
)) err
= DB_LOCK_DEADLOCK
;
556 /* start a transaction */
557 DB_TXN
*trackdb_begin_transaction(void) {
561 if((err
= trackdb_env
->txn_begin(trackdb_env
, 0, &tid
, 0)))
562 fatal(0, "trackdb_env->txn_begin: %s", db_strerror(err
));
566 /* abort transaction */
567 void trackdb_abort_transaction(DB_TXN
*tid
) {
571 if((err
= tid
->abort(tid
)))
572 fatal(0, "tid->abort: %s", db_strerror(err
));
575 /* commit transaction */
576 void trackdb_commit_transaction(DB_TXN
*tid
) {
579 if((err
= tid
->commit(tid
, 0)))
580 fatal(0, "tid->commit: %s", db_strerror(err
));
583 /* search/tags shared code ***************************************************/
585 /* comparison function used by dedupe() */
586 static int wordcmp(const void *a
, const void *b
) {
587 return strcmp(*(const char **)a
, *(const char **)b
);
590 /* sort and de-dupe VEC */
591 static char **dedupe(char **vec
, int nvec
) {
594 qsort(vec
, nvec
, sizeof (char *), wordcmp
);
598 for(n
= 1; n
< nvec
; ++n
)
599 if(strcmp(vec
[n
], vec
[m
- 1]))
606 /* update a key/track database. Returns 0 or DB_DEADLOCK. */
607 static int register_word(DB
*db
, const char *what
,
608 const char *track
, const char *word
,
613 switch(err
= db
->put(db
, tid
, make_key(&key
, word
),
614 make_key(&data
, track
), DB_NODUPDATA
)) {
618 case DB_LOCK_DEADLOCK
:
619 error(0, "error updating %s.db: %s", what
, db_strerror(err
));
622 fatal(0, "error updating %s.db: %s", what
, db_strerror(err
));
626 /* search primitives *********************************************************/
628 /* return true iff NAME is a trackname_display_ pref */
629 static int is_display_pref(const char *name
) {
630 static const char prefix
[] = "trackname_display_";
631 return !strncmp(name
, prefix
, (sizeof prefix
) - 1);
634 /** @brief Word_Break property tailor that treats underscores as spaces */
635 static int tailor_underscore_Word_Break_Other(uint32_t c
) {
639 case 0x005F: /* LOW LINE (SPACING UNDERSCORE) */
640 return unicode_Word_Break_Other
;
644 /** @brief Remove all combining characters in-place
645 * @param s Pointer to start of string
646 * @param ns Length of string
647 * @return New, possiblby reduced, length
649 static size_t remove_combining_chars(uint32_t *s
, size_t ns
) {
650 uint32_t *start
= s
, *t
= s
, *end
= s
+ ns
;
653 const uint32_t c
= *s
++;
654 if(!utf32_combining_class(c
))
660 /** @brief Normalize and split a string using a given tailoring */
661 static void word_split(struct vector
*v
,
663 unicode_property_tailor
*pt
) {
665 uint32_t *t32
, **w32
;
667 /* Convert to UTF-32 */
668 if(!(t32
= utf8_to_utf32(s
, strlen(s
), &nt32
)))
670 /* Erase case distinctions */
671 if(!(t32
= utf32_casefold_compat(t32
, nt32
, &nt32
)))
673 /* Drop combining characters */
674 nt32
= remove_combining_chars(t32
, nt32
);
675 /* Split into words, treating _ as a space */
676 w32
= utf32_word_split(t32
, nt32
, &nw
, pt
);
677 /* Convert words back to UTF-8 and append to result */
678 for(i
= 0; i
< nw
; ++i
)
679 vector_append(v
, utf32_to_utf8(w32
[i
], utf32_len(w32
[i
]), 0));
682 /** @brief Normalize a tag
684 * @param ns Length of tag
685 * @return Normalized string or NULL on error
687 * The return value will be:
689 * - have no leading or trailing space
690 * - have no combining characters
691 * - all spacing between words will be a single U+0020 SPACE
693 static char *normalize_tag(const char *s
, size_t ns
) {
694 uint32_t *s32
, **w32
;
695 size_t ns32
, nw32
, i
;
698 if(!(s32
= utf8_to_utf32(s
, ns
, &ns32
)))
700 if(!(s32
= utf32_casefold_compat(s32
, ns32
, &ns32
))) /* ->NFKD */
702 ns32
= remove_combining_chars(s32
, ns32
);
703 /* Split into words, no Word_Break tailoring */
704 w32
= utf32_word_split(s32
, ns32
, &nw32
, 0);
705 /* Compose back into a string */
707 for(i
= 0; i
< nw32
; ++i
) {
709 dynstr_append(d
, ' ');
710 dynstr_append_string(d
, utf32_to_utf8(w32
[i
], utf32_len(w32
[i
]), 0));
716 /* compute the words of a track name */
717 static char **track_to_words(const char *track
,
718 const struct kvp
*p
) {
720 const char *rootless
= track_rootless(track
);
723 rootless
= track
; /* bodge */
725 rootless
= strip_extension(rootless
);
726 word_split(&v
, strip_extension(rootless
), tailor_underscore_Word_Break_Other
);
727 for(; p
; p
= p
->next
)
728 if(is_display_pref(p
->name
))
729 word_split(&v
, p
->value
, 0);
730 vector_terminate(&v
);
731 return dedupe(v
.vec
, v
.nvec
);
734 /* return nonzero iff WORD is a stopword */
735 static int stopword(const char *word
) {
738 for(n
= 0; n
< config
->stopword
.n
739 && strcmp(word
, config
->stopword
.s
[n
]); ++n
)
741 return n
< config
->stopword
.n
;
744 /* record that WORD appears in TRACK. Returns 0 or DB_LOCK_DEADLOCK. */
745 static int register_search_word(const char *track
, const char *word
,
747 if(stopword(word
)) return 0;
748 return register_word(trackdb_searchdb
, "search", track
, word
, tid
);
751 /* Tags **********************************************************************/
753 /* Return nonzero if C is a valid tag character */
754 static int tagchar(int c
) {
763 /* Parse and de-dupe a tag list. If S=0 then assumes "". */
764 static char **parsetags(const char *s
) {
770 /* skip initial separators */
771 while(*s
&& (!tagchar(*s
) || *s
== ' '))
774 /* find the extent of the tag */
776 while(*s
&& tagchar(*s
))
778 /* strip trailing spaces */
779 while(s
> t
&& s
[-1] == ' ')
781 /* add tag to list */
782 vector_append(&v
, normalize_tag(t
, (size_t)(s
- t
)));
783 /* skip intermediate and trailing separators */
784 while(*s
&& (!tagchar(*s
) || *s
== ' '))
788 vector_terminate(&v
);
789 return dedupe(v
.vec
, v
.nvec
);
792 /* Record that TRACK has TAG. Returns 0 or DB_LOCK_DEADLOCK. */
793 static int register_tag(const char *track
, const char *tag
, DB_TXN
*tid
) {
794 return register_word(trackdb_tagsdb
, "tags", track
, tag
, tid
);
797 /* aliases *******************************************************************/
799 /* compute the alias and store at aliasp. Returns 0 or DB_LOCK_DEADLOCK. If
800 * there is no alias sets *aliasp to 0. */
801 static int compute_alias(char **aliasp
,
806 const char *s
= config
->alias
, *t
, *expansion
, *part
;
807 int c
, used_db
= 0, slash_prefix
, err
;
809 const char *const root
= find_track_root(track
);
812 /* Bodge for tracks with no root */
817 dynstr_append_string(&d
, root
);
818 while((c
= (unsigned char)*s
++)) {
820 dynstr_append(&d
, c
);
823 if((slash_prefix
= (*s
== '/')))
826 assert(t
!= 0); /* validated at startup */
827 part
= xstrndup(s
, t
- s
);
828 expansion
= getpart(track
, "display", part
, p
, &used_db
);
830 if(slash_prefix
) dynstr_append(&d
, '/');
831 dynstr_append_string(&d
, expansion
);
833 s
= t
+ 1; /* skip {part} */
835 /* only admit to the alias if we used the db... */
840 dynstr_terminate(&d
);
841 /* ...and the answer differs from the original... */
842 if(!strcmp(track
, d
.vec
)) {
846 /* ...and there isn't already a different track with that name (including as
848 switch(err
= trackdb_getdata(trackdb_tracksdb
, d
.vec
, &at
, tid
)) {
850 if((s
= kvp_get(at
, "_alias_for"))
851 && !strcmp(s
, track
)) {
863 /* get track and prefs data (if tp/pp not null pointers). Returns 0 on
864 * success, DB_NOTFOUND if the track does not exist or DB_LOCK_DEADLOCK.
865 * Always sets the return values, even if only to null pointers. */
866 static int gettrackdata(const char *track
,
869 const char **actualp
,
871 #define GTD_NOALIAS 0x0001
874 const char *actual
= track
;
875 struct kvp
*t
= 0, *p
= 0;
877 if((err
= trackdb_getdata(trackdb_tracksdb
, track
, &t
, tid
))) goto done
;
878 if((actual
= kvp_get(t
, "_alias_for"))) {
879 if(flags
& GTD_NOALIAS
) {
880 error(0, "alias passed to gettrackdata where real path required");
883 if((err
= trackdb_getdata(trackdb_tracksdb
, actual
, &t
, tid
))) goto done
;
888 if((err
= trackdb_getdata(trackdb_prefsdb
, actual
, &p
, tid
)) == DB_LOCK_DEADLOCK
)
893 if(actualp
) *actualp
= actual
;
899 /* trackdb_notice() **********************************************************/
901 /** @brief notice a possibly new track
902 * @return @c DB_NOTFOUND if new, 0 if already known
904 int trackdb_notice(const char *track
,
910 tid
= trackdb_begin_transaction();
911 err
= trackdb_notice_tid(track
, path
, tid
);
912 if((err
== DB_LOCK_DEADLOCK
)) goto fail
;
915 trackdb_abort_transaction(tid
);
917 trackdb_commit_transaction(tid
);
921 /** @brief notice a possibly new track
922 * @param track NFC UTF-8 track name
923 * @param path Raw path name
924 * @param tid Transaction ID
925 * @return @c DB_NOTFOUND if new, 0 if already known, @c DB_LOCK_DEADLOCK also
927 int trackdb_notice_tid(const char *track
,
931 struct kvp
*t
, *a
, *p
;
935 /* notice whether the tracks.db entry changes */
937 /* get any existing tracks entry */
938 if((err
= gettrackdata(track
, &t
, &p
, 0, 0, tid
)) == DB_LOCK_DEADLOCK
)
940 ret
= err
; /* 0 or DB_NOTFOUND */
941 /* this is a real track */
942 t_changed
+= kvp_set(&t
, "_alias_for", 0);
943 t_changed
+= kvp_set(&t
, "_path", path
);
944 /* if we have an alias record it in the database */
945 if((err
= compute_alias(&alias
, track
, p
, tid
))) return err
;
947 /* won't overwrite someone else's alias as compute_alias() checks */
948 D(("%s: alias %s", track
, alias
));
950 kvp_set(&a
, "_alias_for", track
);
951 if((err
= trackdb_putdata(trackdb_tracksdb
, alias
, a
, tid
, 0))) return err
;
953 /* update search.db */
954 w
= track_to_words(track
, p
);
955 for(n
= 0; w
[n
]; ++n
)
956 if((err
= register_search_word(track
, w
[n
], tid
)))
959 w
= parsetags(kvp_get(p
, "tags"));
960 for(n
= 0; w
[n
]; ++n
)
961 if((err
= register_tag(track
, w
[n
], tid
)))
964 /* only store the tracks.db entry if it has changed */
965 if(t_changed
&& (err
= trackdb_putdata(trackdb_tracksdb
, track
, t
, tid
, 0)))
967 if(ret
== DB_NOTFOUND
) {
968 uint32_t timestamp
[2];
973 timestamp
[0] = htonl((uint64_t)now
>> 32);
974 timestamp
[1] = htonl((uint32_t)now
);
975 memset(&key
, 0, sizeof key
);
976 key
.data
= timestamp
;
977 key
.size
= sizeof timestamp
;
978 switch(err
= trackdb_noticeddb
->put(trackdb_noticeddb
, tid
, &key
,
979 make_key(&data
, track
), 0)) {
981 case DB_LOCK_DEADLOCK
: return err
;
982 default: fatal(0, "error updating noticed.db: %s", db_strerror(err
));
988 /* trackdb_obsolete() ********************************************************/
990 /* obsolete a track */
991 int trackdb_obsolete(const char *track
, DB_TXN
*tid
) {
996 if((err
= gettrackdata(track
, 0, &p
, 0,
997 GTD_NOALIAS
, tid
)) == DB_LOCK_DEADLOCK
)
999 else if(err
== DB_NOTFOUND
) return 0;
1000 /* compute the alias, if any, and delete it */
1001 if(compute_alias(&alias
, track
, p
, tid
)) return err
;
1003 /* if the alias points to some other track then compute_alias won't
1005 if(trackdb_delkey(trackdb_tracksdb
, alias
, tid
))
1008 /* update search.db */
1009 w
= track_to_words(track
, p
);
1010 for(n
= 0; w
[n
]; ++n
)
1011 if(trackdb_delkeydata(trackdb_searchdb
,
1012 w
[n
], track
, tid
) == DB_LOCK_DEADLOCK
)
1014 /* update tags.db */
1015 w
= parsetags(kvp_get(p
, "tags"));
1016 for(n
= 0; w
[n
]; ++n
)
1017 if(trackdb_delkeydata(trackdb_tagsdb
,
1018 w
[n
], track
, tid
) == DB_LOCK_DEADLOCK
)
1021 /* update tracks.db */
1022 if(trackdb_delkey(trackdb_tracksdb
, track
, tid
) == DB_LOCK_DEADLOCK
)
1024 /* We don't delete the prefs, so they survive temporary outages of the
1025 * (possibly virtual) track filesystem */
1029 /* trackdb_stats() ***********************************************************/
1031 #define H(name) { #name, offsetof(DB_HASH_STAT, name) }
1032 #define B(name) { #name, offsetof(DB_BTREE_STAT, name) }
1034 static const struct statinfo
{
1037 } statinfo_hash
[] = {
1053 }, statinfo_btree
[] = {
1074 /* look up stats for DB */
1075 static int get_stats(struct vector
*v
,
1077 const struct statinfo
*si
,
1086 switch(err
= database
->stat(database
, tid
, &sp
, 0)) {
1089 case DB_LOCK_DEADLOCK
:
1090 error(0, "error querying database: %s", db_strerror(err
));
1093 fatal(0, "error querying database: %s", db_strerror(err
));
1095 for(n
= 0; n
< nsi
; ++n
) {
1096 byte_xasprintf(&str
, "%s=%"PRIuMAX
, si
[n
].name
,
1097 (uintmax_t)*(u_int32_t
*)((char *)sp
+ si
[n
].offset
));
1098 vector_append(v
, str
);
1104 /** @brief One entry in the search league */
1105 struct search_entry
{
1110 /** @brief Add a word to the search league
1111 * @param se Pointer to search league
1112 * @param count Maximum size for search league
1113 * @param nse Current size of search league
1114 * @param word New word, or NULL
1115 * @param n How often @p word appears
1116 * @return New size of search league
1118 static int register_search_entry(struct search_entry
*se
,
1125 if(word
&& (nse
< count
|| n
> se
[nse
- 1].n
)) {
1126 /* Find the starting point */
1131 /* Find the insertion point */
1132 while(i
> 0 && n
> se
[i
- 1].n
)
1134 memmove(&se
[i
+ 1], &se
[i
], (nse
- i
- 1) * sizeof *se
);
1141 /* find the top COUNT words in the search database */
1142 static int search_league(struct vector
*v
, int count
, DB_TXN
*tid
) {
1143 struct search_entry
*se
;
1146 int err
, n
= 0, nse
= 0, i
;
1151 cursor
= trackdb_opencursor(trackdb_searchdb
, tid
);
1152 se
= xmalloc(count
* sizeof *se
);
1153 /* Walk across the whole database counting up the number of times each
1155 while(!(err
= cursor
->c_get(cursor
, prepare_data(&k
), prepare_data(&d
),
1157 if(word
&& wl
== k
.size
&& !strncmp(word
, k
.data
, wl
))
1158 ++n
; /* same word again */
1160 nse
= register_search_entry(se
, count
, nse
, word
, n
);
1161 word
= xstrndup(k
.data
, wl
= k
.size
);
1169 case DB_LOCK_DEADLOCK
:
1170 error(0, "error querying search database: %s", db_strerror(err
));
1173 fatal(0, "error querying search database: %s", db_strerror(err
));
1175 if(trackdb_closecursor(cursor
)) err
= DB_LOCK_DEADLOCK
;
1177 nse
= register_search_entry(se
, count
, nse
, word
, n
);
1178 byte_xasprintf(&str
, "Top %d search words:", nse
);
1179 vector_append(v
, str
);
1180 for(i
= 0; i
< nse
; ++i
) {
1181 byte_xasprintf(&str
, "%4d: %5d %s", i
+ 1, se
[i
].n
, se
[i
].word
);
1182 vector_append(v
, str
);
1187 #define SI(what) statinfo_##what, \
1188 sizeof statinfo_##what / sizeof (struct statinfo)
1190 /* return a list of database stats */
1191 char **trackdb_stats(int *nstatsp
) {
1197 tid
= trackdb_begin_transaction();
1199 vector_append(&v
, (char *)"Tracks database stats:");
1200 if(get_stats(&v
, trackdb_tracksdb
, SI(btree
), tid
)) goto fail
;
1201 vector_append(&v
, (char *)"");
1202 vector_append(&v
, (char *)"Search database stats:");
1203 if(get_stats(&v
, trackdb_searchdb
, SI(hash
), tid
)) goto fail
;
1204 vector_append(&v
, (char *)"");
1205 vector_append(&v
, (char *)"Prefs database stats:");
1206 if(get_stats(&v
, trackdb_prefsdb
, SI(hash
), tid
)) goto fail
;
1207 vector_append(&v
, (char *)"");
1208 if(search_league(&v
, 10, tid
)) goto fail
;
1209 vector_terminate(&v
);
1212 trackdb_abort_transaction(tid
);
1214 trackdb_commit_transaction(tid
);
1215 if(nstatsp
) *nstatsp
= v
.nvec
;
1219 struct stats_details
{
1220 void (*done
)(char *data
, void *u
);
1222 int exited
; /* subprocess exited */
1223 int closed
; /* pipe close */
1224 int wstat
; /* wait status from subprocess */
1225 struct dynstr data
[1]; /* data read from pipe */
1228 static void stats_complete(struct stats_details
*d
) {
1231 if(!(d
->exited
&& d
->closed
))
1233 byte_xasprintf(&s
, "\n"
1235 "track lookup cache hits: %lu\n"
1236 "track lookup cache misses: %lu\n",
1238 cache_files_misses
);
1239 dynstr_append_string(d
->data
, s
);
1240 dynstr_terminate(d
->data
);
1241 d
->done(d
->data
->vec
, d
->u
);
1244 static int stats_finished(ev_source
attribute((unused
)) *ev
,
1245 pid_t
attribute((unused
)) pid
,
1247 const struct rusage
attribute((unused
)) *rusage
,
1249 struct stats_details
*const d
= u
;
1253 error(0, "disorder-stats %s", wstat(status
));
1258 static int stats_read(ev_source
attribute((unused
)) *ev
,
1264 struct stats_details
*const d
= u
;
1266 dynstr_append_bytes(d
->data
, ptr
, bytes
);
1267 ev_reader_consume(reader
, bytes
);
1274 static int stats_error(ev_source
attribute((unused
)) *ev
,
1277 struct stats_details
*const d
= u
;
1279 error(errno_value
, "error reading from pipe to disorder-stats");
1285 void trackdb_stats_subprocess(ev_source
*ev
,
1286 void (*done
)(char *data
, void *u
),
1290 struct stats_details
*d
= xmalloc(sizeof *d
);
1292 dynstr_init(d
->data
);
1296 pid
= subprogram(ev
, "disorder-stats", p
[1]);
1298 ev_child(ev
, pid
, 0, stats_finished
, d
);
1299 ev_reader_new(ev
, p
[0], stats_read
, stats_error
, d
, "disorder-stats reader");
1302 /* set a pref (remove if value=0) */
1303 int trackdb_set(const char *track
,
1305 const char *value
) {
1306 struct kvp
*t
, *p
, *a
;
1309 char *oldalias
, *newalias
, **oldtags
= 0, **newtags
;
1312 /* TODO: if value matches default then set value=0 */
1316 tid
= trackdb_begin_transaction();
1317 if((err
= gettrackdata(track
, &t
, &p
, 0,
1318 0, tid
)) == DB_LOCK_DEADLOCK
)
1320 if(err
== DB_NOTFOUND
) break;
1321 if(name
[0] == '_') {
1322 if(kvp_set(&t
, name
, value
))
1323 if(trackdb_putdata(trackdb_tracksdb
, track
, t
, tid
, 0))
1326 /* get the old alias name */
1327 if(compute_alias(&oldalias
, track
, p
, tid
)) goto fail
;
1328 /* get the old tags */
1329 if(!strcmp(name
, "tags"))
1330 oldtags
= parsetags(kvp_get(p
, "tags"));
1332 if(kvp_set(&p
, name
, value
))
1333 if(trackdb_putdata(trackdb_prefsdb
, track
, p
, tid
, 0))
1335 /* compute the new alias name */
1336 if((err
= compute_alias(&newalias
, track
, p
, tid
))) goto fail
;
1337 /* check whether alias has changed */
1338 if(!(oldalias
== newalias
1339 || (oldalias
&& newalias
&& !strcmp(oldalias
, newalias
)))) {
1340 /* adjust alias records to fit change */
1342 && trackdb_delkey(trackdb_tracksdb
, oldalias
, tid
)) goto fail
;
1345 kvp_set(&a
, "_alias_for", track
);
1346 if(trackdb_putdata(trackdb_tracksdb
, newalias
, a
, tid
, 0)) goto fail
;
1349 /* check whether tags have changed */
1350 if(!strcmp(name
, "tags")) {
1351 newtags
= parsetags(value
);
1352 while(*oldtags
|| *newtags
) {
1353 if(*oldtags
&& *newtags
) {
1354 cmp
= strcmp(*oldtags
, *newtags
);
1356 /* keeping this tag */
1360 /* old tag fits into a gap in the new list, so delete old */
1363 /* new tag fits into a gap in the old list, so insert new */
1365 } else if(*oldtags
) {
1366 /* we've run out of new tags, so remaining old ones are to be
1369 if(trackdb_delkeydata(trackdb_tagsdb
,
1370 *oldtags
, track
, tid
) == DB_LOCK_DEADLOCK
)
1374 /* we've run out of old tags, so remainig new ones are to be
1377 if(register_tag(track
, *newtags
, tid
)) goto fail
;
1387 trackdb_abort_transaction(tid
);
1389 trackdb_commit_transaction(tid
);
1390 return err
== 0 ?
0 : -1;
1394 const char *trackdb_get(const char *track
,
1396 return kvp_get(trackdb_get_all(track
), name
);
1399 /* get all prefs as a 0-terminated array */
1400 struct kvp
*trackdb_get_all(const char *track
) {
1401 struct kvp
*t
, *p
, **pp
;
1405 tid
= trackdb_begin_transaction();
1406 if(gettrackdata(track
, &t
, &p
, 0, 0, tid
) == DB_LOCK_DEADLOCK
)
1410 trackdb_abort_transaction(tid
);
1412 trackdb_commit_transaction(tid
);
1413 for(pp
= &p
; *pp
; pp
= &(*pp
)->next
)
1420 const char *trackdb_resolve(const char *track
) {
1425 tid
= trackdb_begin_transaction();
1426 if(gettrackdata(track
, 0, 0, &actual
, 0, tid
) == DB_LOCK_DEADLOCK
)
1430 trackdb_abort_transaction(tid
);
1432 trackdb_commit_transaction(tid
);
1436 int trackdb_isalias(const char *track
) {
1437 const char *actual
= trackdb_resolve(track
);
1439 return strcmp(actual
, track
);
1442 /* test whether a track exists (perhaps an alias) */
1443 int trackdb_exists(const char *track
) {
1448 tid
= trackdb_begin_transaction();
1449 /* unusually, here we want the return value */
1450 if((err
= gettrackdata(track
, 0, 0, 0, 0, tid
)) == DB_LOCK_DEADLOCK
)
1454 trackdb_abort_transaction(tid
);
1456 trackdb_commit_transaction(tid
);
1460 /* return the list of tags */
1461 char **trackdb_alltags(void) {
1467 tid
= trackdb_begin_transaction();
1468 err
= trackdb_alltags_tid(tid
, &taglist
);
1470 trackdb_abort_transaction(tid
);
1472 trackdb_commit_transaction(tid
);
1476 static int trackdb_alltags_tid(DB_TXN
*tid
, char ***taglistp
) {
1483 c
= trackdb_opencursor(trackdb_tagsdb
, tid
);
1484 memset(&k
, 0, sizeof k
);
1485 while(!(err
= c
->c_get(c
, &k
, prepare_data(&d
), DB_NEXT_NODUP
)))
1486 vector_append(&v
, xstrndup(k
.data
, k
.size
));
1490 case DB_LOCK_DEADLOCK
:
1493 fatal(0, "c->c_get: %s", db_strerror(err
));
1495 if((err
= trackdb_closecursor(c
))) return err
;
1496 vector_terminate(&v
);
1501 /* return 1 iff sorted tag lists A and B have at least one member in common */
1502 static int tag_intersection(char **a
, char **b
) {
1505 /* Same sort of logic as trackdb_set() above */
1507 if(!(cmp
= strcmp(*a
, *b
))) return 1;
1508 else if(cmp
< 0) ++a
;
1514 /* Check whether a track is suitable for random play. Returns 0 if it is,
1515 * DB_NOTFOUND if it is not or DB_LOCK_DEADLOCK if the database gave us
1517 static int check_suitable(const char *track
,
1519 char **required_tags
,
1520 char **prohibited_tags
) {
1524 const char *pick_at_random
, *played_time
;
1526 /* don't pick tracks that aren't in any surviving collection (for instance
1527 * you've edited the config but the rescan hasn't done its job yet) */
1528 if(!find_track_root(track
)) {
1529 info("found track not in any collection: %s", track
);
1532 /* don't pick aliases - only pick the canonical form */
1533 if(gettrackdata(track
, &t
, &p
, 0, 0, tid
) == DB_LOCK_DEADLOCK
)
1534 return DB_LOCK_DEADLOCK
;
1535 if(kvp_get(t
, "_alias_for"))
1537 /* check that random play is not suppressed for this track */
1538 if((pick_at_random
= kvp_get(p
, "pick_at_random"))
1539 && !strcmp(pick_at_random
, "0"))
1541 /* don't pick a track that's been played in the last 8 hours */
1542 if((played_time
= kvp_get(p
, "played_time"))) {
1543 last
= atoll(played_time
);
1545 if(now
< last
+ 8 * 3600) /* TODO configurable */
1548 track_tags
= parsetags(kvp_get(p
, "tags"));
1549 /* check that no prohibited tag is present for this track */
1550 if(prohibited_tags
&& tag_intersection(track_tags
, prohibited_tags
))
1552 /* check that at least one required tags is present for this track */
1553 if(*required_tags
&& !tag_intersection(track_tags
, required_tags
))
1558 /* attempt to pick a random non-alias track */
1559 const char *trackdb_random(int tries
) {
1564 const char *track
, *candidate
;
1567 char **required_tags
, **prohibited_tags
, **tp
;
1572 tid
= trackdb_begin_transaction();
1573 if((err
= trackdb_get_global_tid("required-tags", tid
, &tags
)))
1575 required_tags
= parsetags(tags
);
1576 if((err
= trackdb_get_global_tid("prohibited-tags", tid
, &tags
)))
1578 prohibited_tags
= parsetags(tags
);
1580 if(*required_tags
) {
1581 /* Bung all the suitable tracks into a hash and convert to a list of keys
1582 * (to eliminate duplicates). We cache this list since it is possible
1583 * that it will be very large. */
1586 for(tp
= required_tags
; *tp
; ++tp
) {
1587 c
= trackdb_opencursor(trackdb_tagsdb
, tid
);
1588 memset(&key
, 0, sizeof key
);
1590 key
.size
= strlen(*tp
);
1592 err
= c
->c_get(c
, &key
, prepare_data(&data
), DB_SET
);
1594 hash_add(h
, xstrndup(data
.data
, data
.size
), 0,
1595 HASH_INSERT_OR_REPLACE
);
1597 err
= c
->c_get(c
, &key
, prepare_data(&data
), DB_NEXT_DUP
);
1603 case DB_LOCK_DEADLOCK
:
1606 fatal(0, "error querying tags.db: %s", db_strerror(err
));
1608 trackdb_closecursor(c
);
1611 error(0, "required tag %s does not match any tracks", *tp
);
1613 nreqtracks
= hash_count(h
);
1614 reqtracks
= hash_keys(h
);
1616 while(nreqtracks
&& !track
&& tries
-- > 0) {
1617 r
= (rand() * (double)nreqtracks
/ (RAND_MAX
+ 1.0));
1618 candidate
= reqtracks
[r
];
1619 switch(check_suitable(candidate
, tid
,
1620 required_tags
, prohibited_tags
)) {
1626 case DB_LOCK_DEADLOCK
:
1631 /* No required tags. We pick random record numbers in the database
1633 switch(err
= trackdb_tracksdb
->stat(trackdb_tracksdb
, tid
, &sp
, 0)) {
1636 case DB_LOCK_DEADLOCK
:
1637 error(0, "error querying tracks.db: %s", db_strerror(err
));
1640 fatal(0, "error querying tracks.db: %s", db_strerror(err
));
1643 error(0, "cannot pick tracks at random from an empty database");
1644 while(sp
->bt_nkeys
&& !track
&& tries
-- > 0) {
1645 /* record numbers count from 1 upwards */
1646 r
= 1 + (rand() * (double)sp
->bt_nkeys
/ (RAND_MAX
+ 1.0));
1647 memset(&key
, sizeof key
, 0);
1648 key
.flags
= DB_DBT_MALLOC
;
1649 key
.size
= sizeof r
;
1651 switch(err
= trackdb_tracksdb
->get(trackdb_tracksdb
, tid
, &key
, prepare_data(&data
),
1655 case DB_LOCK_DEADLOCK
:
1656 error(0, "error querying tracks.db: %s", db_strerror(err
));
1659 fatal(0, "error querying tracks.db: %s", db_strerror(err
));
1661 candidate
= xstrndup(key
.data
, key
.size
);
1662 switch(check_suitable(candidate
, tid
,
1663 required_tags
, prohibited_tags
)) {
1669 case DB_LOCK_DEADLOCK
:
1676 trackdb_closecursor(c
);
1678 trackdb_abort_transaction(tid
);
1680 trackdb_commit_transaction(tid
);
1682 error(0, "could not pick a random track");
1686 /* get a track name given the prefs. Set *used_db to 1 if we got the answer
1687 * from the prefs. */
1688 static const char *getpart(const char *track
,
1689 const char *context
,
1691 const struct kvp
*p
,
1696 byte_xasprintf(&pref
, "trackname_%s_%s", context
, part
);
1697 if((result
= kvp_get(p
, pref
)))
1700 result
= trackname_part(track
, context
, part
);
1701 assert(result
!= 0);
1705 /* get a track name part, like trackname_part(), but taking the database into
1707 const char *trackdb_getpart(const char *track
,
1708 const char *context
,
1716 /* construct the full pref */
1717 byte_xasprintf(&pref
, "trackname_%s_%s", context
, part
);
1719 tid
= trackdb_begin_transaction();
1720 if((err
= gettrackdata(track
, 0, &p
, &actual
, 0, tid
)) == DB_LOCK_DEADLOCK
)
1724 trackdb_abort_transaction(tid
);
1726 trackdb_commit_transaction(tid
);
1727 return getpart(actual
, context
, part
, p
, &used_db
);
1730 /* get the raw path name for @track@ (might be an alias) */
1731 const char *trackdb_rawpath(const char *track
) {
1737 tid
= trackdb_begin_transaction();
1738 if(gettrackdata(track
, &t
, 0, 0, 0, tid
) == DB_LOCK_DEADLOCK
)
1742 trackdb_abort_transaction(tid
);
1744 trackdb_commit_transaction(tid
);
1745 if(!(path
= kvp_get(t
, "_path"))) path
= track
;
1749 /* trackdb_list **************************************************************/
1751 /* this is incredibly ugly, sorry, perhaps it will be rewritten to be actually
1752 * readable at some point */
1754 /* return true if the basename of TRACK[0..TL-1], as defined by DL, matches RE.
1755 * If RE is a null pointer then it matches everything. */
1756 static int track_matches(size_t dl
, const char *track
, size_t tl
,
1764 switch(rc
= pcre_exec(re
, 0, track
, tl
, 0, 0, ovec
, 3)) {
1765 case PCRE_ERROR_NOMATCH
: return 0;
1768 error(0, "pcre_exec returned %d, subject '%s'", rc
, track
);
1775 static int do_list(struct vector
*v
, const char *dir
,
1776 enum trackdb_listable what
, const pcre
*re
, DB_TXN
*tid
) {
1782 size_t l
, last_dir_len
= 0;
1783 char *last_dir
= 0, *track
, *alias
;
1787 cursor
= trackdb_opencursor(trackdb_tracksdb
, tid
);
1790 /* find the first key >= dir */
1791 err
= cursor
->c_get(cursor
, &k
, &d
, DB_SET_RANGE
);
1792 /* keep going while we're dealing with <dir/anything> */
1795 && ((char *)k
.data
)[dl
] == '/'
1796 && !memcmp(k
.data
, dir
, dl
)) {
1797 ptr
= memchr((char *)k
.data
+ dl
+ 1, '/', k
.size
- (dl
+ 1));
1799 /* we have <dir/component/anything>, so <dir/component> is a directory */
1800 l
= ptr
- (char *)k
.data
;
1801 if(what
& trackdb_directories
)
1803 && l
== last_dir_len
1804 && !memcmp(last_dir
, k
.data
, l
))) {
1805 last_dir
= xstrndup(k
.data
, last_dir_len
= l
);
1806 if(track_matches(dl
, k
.data
, l
, re
))
1807 vector_append(v
, last_dir
);
1810 /* found a plain file */
1811 if((what
& trackdb_files
)) {
1812 track
= xstrndup(k
.data
, k
.size
);
1813 if((err
= trackdb_getdata(trackdb_prefsdb
,
1814 track
, &p
, tid
)) == DB_LOCK_DEADLOCK
)
1816 /* if this file has an alias in the same directory then we skip it */
1817 if((err
= compute_alias(&alias
, track
, p
, tid
)))
1819 if(!(alias
&& !strcmp(d_dirname(alias
), d_dirname(track
))))
1820 if(track_matches(dl
, k
.data
, k
.size
, re
))
1821 vector_append(v
, track
);
1824 err
= cursor
->c_get(cursor
, &k
, &d
, DB_NEXT
);
1832 case DB_LOCK_DEADLOCK
:
1833 error(0, "error querying database: %s", db_strerror(err
));
1836 fatal(0, "error querying database: %s", db_strerror(err
));
1839 if(trackdb_closecursor(cursor
)) err
= DB_LOCK_DEADLOCK
;
1843 /* return the directories or files below @dir@ */
1844 char **trackdb_list(const char *dir
, int *np
, enum trackdb_listable what
,
1852 tid
= trackdb_begin_transaction();
1855 if(do_list(&v
, dir
, what
, re
, tid
))
1858 for(n
= 0; n
< config
->collection
.n
; ++n
)
1859 if(do_list(&v
, config
->collection
.s
[n
].root
, what
, re
, tid
))
1864 trackdb_abort_transaction(tid
);
1866 trackdb_commit_transaction(tid
);
1867 vector_terminate(&v
);
1873 /* If S is tag:something, return something. Else return 0. */
1874 static const char *checktag(const char *s
) {
1875 if(!strncmp(s
, "tag:", 4))
1881 /* return a list of tracks containing all of the words given. If you
1882 * ask for only stopwords you get no tracks. */
1883 char **trackdb_search(char **wordlist
, int nwordlist
, int *ntracks
) {
1884 const char **w
, *best
= 0, *tag
;
1885 char **twords
, **tags
;
1887 int i
, j
, n
, err
, what
;
1897 *ntracks
= 0; /* for early returns */
1898 /* normalize all the words */
1899 w
= xmalloc(nwordlist
* sizeof (char *));
1900 istag
= xmalloc_noptr(nwordlist
);
1901 for(n
= 0; n
< nwordlist
; ++n
) {
1905 w
[n
] = utf8_casefold_compat(wordlist
[n
], strlen(wordlist
[n
]), 0);
1906 if(checktag(w
[n
])) {
1907 ++ntags
; /* count up tags */
1908 /* Normalize the tag */
1909 w
[n
] = normalize_tag(w
[n
] + 4, strlen(w
[n
] + 4));
1912 /* Normalize the search term by removing combining characters */
1913 if(!(w32
= utf8_to_utf32(w
[n
], strlen(w
[n
]), &nw32
)))
1915 nw32
= remove_combining_chars(w32
, nw32
);
1916 if(!(w
[n
] = utf32_to_utf8(w32
, nw32
, 0)))
1921 /* find the longest non-stopword */
1922 for(n
= 0; n
< nwordlist
; ++n
)
1923 if(!istag
[n
] && !stopword(w
[n
]))
1924 if(!best
|| strlen(w
[n
]) > strlen(best
))
1926 /* TODO: we should at least in principal be able to identify the word or tag
1927 * with the least matches in log time, and choose that as our primary search
1929 if(ntags
&& !best
) {
1930 /* Only tags are listed. We limit to the first and narrow down with the
1932 best
= istag
[0] ? w
[0] : 0;
1933 db
= trackdb_tagsdb
;
1936 /* We can limit to some word. */
1937 db
= trackdb_searchdb
;
1940 /* Only stopwords */
1946 tid
= trackdb_begin_transaction();
1947 /* find all the tracks that have that word */
1952 cursor
= trackdb_opencursor(db
, tid
);
1953 while(!(err
= cursor
->c_get(cursor
, &k
, &d
, what
))) {
1954 vector_append(&v
, xstrndup(d
.data
, d
.size
));
1961 case DB_LOCK_DEADLOCK
:
1962 error(0, "error querying %s database: %s", dbname
, db_strerror(err
));
1965 fatal(0, "error querying %s database: %s", dbname
, db_strerror(err
));
1967 if(trackdb_closecursor(cursor
)) err
= DB_LOCK_DEADLOCK
;
1969 /* do a naive search over that (hopefuly fairly small) list of tracks */
1971 for(n
= 0; n
< v
.nvec
; ++n
) {
1972 if((err
= gettrackdata(v
.vec
[n
], 0, &p
, 0, 0, tid
) == DB_LOCK_DEADLOCK
))
1975 error(0, "track %s unexpected error: %s", v
.vec
[n
], db_strerror(err
));
1978 twords
= track_to_words(v
.vec
[n
], p
);
1979 tags
= parsetags(kvp_get(p
, "tags"));
1980 for(i
= 0; i
< nwordlist
; ++i
) {
1983 /* Track must have this tag */
1984 for(j
= 0; tags
[j
]; ++j
)
1985 if(!strcmp(tag
, tags
[j
])) break; /* tag found */
1986 if(!tags
[j
]) break; /* tag not found */
1988 /* Track must contain this word */
1989 for(j
= 0; twords
[j
]; ++j
)
1990 if(!strcmp(w
[i
], twords
[j
])) break; /* word found */
1991 if(!twords
[j
]) break; /* word not found */
1994 if(i
>= nwordlist
) /* all words found */
1995 vector_append(&u
, v
.vec
[n
]);
1999 trackdb_closecursor(cursor
);
2001 trackdb_abort_transaction(tid
);
2002 info("retrying search");
2004 trackdb_commit_transaction(tid
);
2005 vector_terminate(&u
);
2011 /* trackdb_scan **************************************************************/
2013 int trackdb_scan(const char *root
,
2014 int (*callback
)(const char *track
,
2022 const size_t root_len
= root ?
strlen(root
) : 0;
2027 cursor
= trackdb_opencursor(trackdb_tracksdb
, tid
);
2029 err
= cursor
->c_get(cursor
, make_key(&k
, root
), prepare_data(&d
),
2032 memset(&k
, 0, sizeof k
);
2033 err
= cursor
->c_get(cursor
, &k
, prepare_data(&d
),
2038 || (k
.size
> root_len
2039 && !strncmp(k
.data
, root
, root_len
)
2040 && ((char *)k
.data
)[root_len
] == '/')) {
2041 data
= kvp_urldecode(d
.data
, d
.size
);
2042 if(kvp_get(data
, "_path")) {
2043 track
= xstrndup(k
.data
, k
.size
);
2044 /* Advance to the next track before the callback so that the callback
2045 * may safely delete the track */
2046 err
= cursor
->c_get(cursor
, &k
, &d
, DB_NEXT
);
2047 if((cberr
= callback(track
, data
, u
, tid
))) {
2052 err
= cursor
->c_get(cursor
, &k
, &d
, DB_NEXT
);
2056 trackdb_closecursor(cursor
);
2063 case DB_LOCK_DEADLOCK
:
2064 error(0, "c->c_get: %s", db_strerror(err
));
2067 fatal(0, "c->c_get: %s", db_strerror(err
));
2071 /* trackdb_rescan ************************************************************/
2073 /* called when the rescanner terminates */
2074 static int reap_rescan(ev_source
attribute((unused
)) *ev
,
2077 const struct rusage
attribute((unused
)) *rusage
,
2078 void attribute((unused
)) *u
) {
2079 if(pid
== rescan_pid
) rescan_pid
= -1;
2081 error(0, RESCAN
": %s", wstat(status
));
2083 D((RESCAN
" terminated: %s", wstat(status
)));
2084 /* Our cache of file lookups is out of date now */
2085 cache_clean(&cache_files_type
);
2086 eventlog("rescanned", (char *)0);
2090 void trackdb_rescan(ev_source
*ev
) {
2093 if(rescan_pid
!= -1) {
2094 error(0, "rescan already underway");
2097 rescan_pid
= subprogram(ev
, RESCAN
, -1);
2099 ev_child(ev
, rescan_pid
, 0, reap_rescan
, 0);
2100 D(("started rescanner"));
2102 /* This is the first rescan, we block until it is complete */
2103 while(waitpid(rescan_pid
, &w
, 0) < 0 && errno
== EINTR
)
2105 reap_rescan(0, rescan_pid
, w
, 0, 0);
2109 int trackdb_rescan_cancel(void) {
2110 if(rescan_pid
== -1) return 0;
2111 if(kill(rescan_pid
, SIGTERM
) < 0)
2112 fatal(errno
, "error killing rescanner");
2117 /* global prefs **************************************************************/
2119 void trackdb_set_global(const char *name
,
2127 tid
= trackdb_begin_transaction();
2128 if(!(err
= trackdb_set_global_tid(name
, value
, tid
)))
2130 trackdb_abort_transaction(tid
);
2132 trackdb_commit_transaction(tid
);
2133 /* log important state changes */
2134 if(!strcmp(name
, "playing")) {
2135 state
= !value
|| !strcmp(value
, "yes");
2136 info("playing %s by %s",
2137 state ?
"enabled" : "disabled",
2139 eventlog("state", state ?
"enable_play" : "disable_play", (char *)0);
2141 if(!strcmp(name
, "random-play")) {
2142 state
= !value
|| !strcmp(value
, "yes");
2143 info("random play %s by %s",
2144 state ?
"enabled" : "disabled",
2146 eventlog("state", state ?
"enable_random" : "disable_random", (char *)0);
2148 if(!strcmp(name
, "required-tags"))
2152 int trackdb_set_global_tid(const char *name
,
2158 memset(&k
, 0, sizeof k
);
2159 memset(&d
, 0, sizeof d
);
2160 k
.data
= (void *)name
;
2161 k
.size
= strlen(name
);
2163 d
.data
= (void *)value
;
2164 d
.size
= strlen(value
);
2167 err
= trackdb_globaldb
->put(trackdb_globaldb
, tid
, &k
, &d
, 0);
2169 err
= trackdb_globaldb
->del(trackdb_globaldb
, tid
, &k
, 0);
2170 if(err
== DB_LOCK_DEADLOCK
) return err
;
2172 fatal(0, "error updating database: %s", db_strerror(err
));
2176 const char *trackdb_get_global(const char *name
) {
2182 tid
= trackdb_begin_transaction();
2183 if(!(err
= trackdb_get_global_tid(name
, tid
, &r
)))
2185 trackdb_abort_transaction(tid
);
2187 trackdb_commit_transaction(tid
);
2191 int trackdb_get_global_tid(const char *name
,
2197 memset(&k
, 0, sizeof k
);
2198 k
.data
= (void *)name
;
2199 k
.size
= strlen(name
);
2200 switch(err
= trackdb_globaldb
->get(trackdb_globaldb
, tid
, &k
,
2201 prepare_data(&d
), 0)) {
2203 *rp
= xstrndup(d
.data
, d
.size
);
2208 case DB_LOCK_DEADLOCK
:
2211 fatal(0, "error reading database: %s", db_strerror(err
));
2215 /** @brief Retrieve the most recently added tracks
2216 * @param ntracksp Where to put count, or 0
2217 * @param maxtracks Maximum number of tracks to retrieve
2218 * @return null-terminated array of track names
2220 * The most recently added track is first in the array.
2222 char **trackdb_new(int *ntracksp
,
2228 tid
= trackdb_begin_transaction();
2229 tracks
= trackdb_new_tid(ntracksp
, maxtracks
, tid
);
2232 trackdb_abort_transaction(tid
);
2234 trackdb_commit_transaction(tid
);
2238 /** @brief Retrieve the most recently added tracks
2239 * @param ntracksp Where to put count, or 0
2240 * @param maxtracks Maximum number of tracks to retrieve, or 0 for all
2241 * @param tid Transaction ID
2242 * @return null-terminated array of track names, or NULL on deadlock
2244 * The most recently added track is first in the array.
2246 static char **trackdb_new_tid(int *ntracksp
,
2252 struct vector tracks
[1];
2254 vector_init(tracks
);
2255 c
= trackdb_opencursor(trackdb_noticeddb
, tid
);
2256 while((maxtracks
<= 0 || tracks
->nvec
< maxtracks
)
2257 && !(err
= c
->c_get(c
, prepare_data(&k
), prepare_data(&d
), DB_PREV
)))
2258 vector_append(tracks
, xstrndup(d
.data
, d
.size
));
2260 case 0: /* hit maxtracks */
2261 case DB_NOTFOUND
: /* ran out of tracks */
2263 case DB_LOCK_DEADLOCK
:
2264 trackdb_closecursor(c
);
2267 fatal(0, "error reading noticed.db: %s", db_strerror(err
));
2269 if((err
= trackdb_closecursor(c
)))
2270 return 0; /* deadlock */
2271 vector_terminate(tracks
);
2273 *ntracksp
= tracks
->nvec
;
2277 /** @brief Expire noticed.db
2278 * @param earliest Earliest timestamp to keep
2280 void trackdb_expire_noticed(time_t earliest
) {
2284 tid
= trackdb_begin_transaction();
2285 if(!trackdb_expire_noticed_tid(earliest
, tid
))
2287 trackdb_abort_transaction(tid
);
2289 trackdb_commit_transaction(tid
);
2292 /** @brief Expire noticed.db
2293 * @param earliest Earliest timestamp to keep
2294 * @param tid Transaction ID
2295 * @return 0 or DB_LOCK_DEADLOCK
2297 static int trackdb_expire_noticed_tid(time_t earliest
, DB_TXN
*tid
) {
2305 c
= trackdb_opencursor(trackdb_noticeddb
, tid
);
2306 while(!(err
= c
->c_get(c
, prepare_data(&k
), prepare_data(&d
), DB_NEXT
))) {
2308 when
= (time_t)(((uint64_t)ntohl(kk
[0]) << 32) + ntohl(kk
[1]));
2309 if(when
>= earliest
)
2311 if((err
= c
->c_del(c
, 0))) {
2312 if(err
!= DB_LOCK_DEADLOCK
)
2313 fatal(0, "error deleting expired noticed.db entry: %s",
2319 if(err
== DB_NOTFOUND
)
2321 if(err
&& err
!= DB_LOCK_DEADLOCK
)
2322 fatal(0, "error expiring noticed.db: %s", db_strerror(err
));
2324 if((err
= trackdb_closecursor(c
))) {
2325 if(err
!= DB_LOCK_DEADLOCK
)
2326 fatal(0, "error closing cursor: %s", db_strerror(err
));
2330 info("expired %d tracks from noticed.db", count
);
2334 /* tidying up ****************************************************************/
2336 void trackdb_gc(void) {
2340 if((err
= trackdb_env
->txn_checkpoint(trackdb_env
,
2341 config
->checkpoint_kbyte
,
2342 config
->checkpoint_min
,
2344 fatal(0, "trackdb_env->txn_checkpoint: %s", db_strerror(err
));
2345 if((err
= trackdb_env
->log_archive(trackdb_env
, &logfiles
, DB_ARCH_REMOVE
)))
2346 fatal(0, "trackdb_env->log_archive: %s", db_strerror(err
));
2347 /* This makes catastrophic recovery impossible. However, the user can still
2348 * preserve the important data by using disorder-dump to snapshot their
2349 * prefs, and later to restore it. This is likely to have much small
2350 * long-term storage requirements than record the db logfiles. */
2358 indent-tabs-mode:nil