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 /* setup and teardown ********************************************************/
80 static const char *home
; /* home had better not change */
81 DB_ENV
*trackdb_env
; /* db environment */
83 /** @brief The tracks database
84 * - Keys are UTF-8(NFC(unicode(path name)))
85 * - Values are encoded key-value pairs
86 * - Data is reconstructable data about tracks that currently exist
90 /** @brief The preferences database
92 * - Keys are UTF-8(NFC(unicode(path name)))
93 * - Values are encoded key-value pairs
94 * - Data is user data about tracks (that might not exist any more)
95 * and cannot be reconstructed
99 /** @brief The search database
101 * - Keys are UTF-8(NFKC(casefold(search term)))
102 * - Values are UTF-8(NFC(unicode(path name)))
103 * - There can be more than one value per key
104 * - Presence of key,value means that path matches the search terms
105 * - Only tracks fond in @ref tracks_tracksdb are represented here
106 * - This database can be reconstructed, it contains no user data
108 DB
*trackdb_searchdb
;
110 /** @brief The tags database
112 * - Keys are UTF-8(NFKC(casefold(tag)))
113 * - Values are UTF-8(NFC(unicode(path name)))
114 * - There can be more than one value per key
115 * - Presence of key,value means that path matches the tag
116 * - This is always in sync with the tags preference
117 * - This database can be reconstructed, it contains no user data
119 DB
*trackdb_tagsdb
; /* the tags database */
121 /** @brief The global preferences database
122 * - Keys are UTF-8(NFC(preference))
123 * - Values are global preference values
124 * - Data is user data and cannot be reconstructed
126 DB
*trackdb_globaldb
; /* global preferences */
128 /** @brief The noticed database
129 * - Keys are 64-bit big-endian timestamps
130 * - Values are UTF-8(NFC(unicode(path name)))
131 * - There can be more than one value per key
132 * - Presence of key,value means that path was added at the given time
133 * - Data cannot be reconstructed (but isn't THAT important)
135 DB
*trackdb_noticeddb
; /* when track noticed */
136 static pid_t db_deadlock_pid
= -1; /* deadlock manager PID */
137 static pid_t rescan_pid
= -1; /* rescanner PID */
138 static int initialized
, opened
; /* state */
140 /* tracks matched by required_tags */
141 static char **reqtracks
;
142 static size_t nreqtracks
;
144 /* comparison function for keys */
145 static int compare(DB
attribute((unused
)) *db_
,
146 const DBT
*a
, const DBT
*b
) {
147 return compare_path_raw(a
->data
, a
->size
, b
->data
, b
->size
);
150 /** @brief Open database environment
151 * @param flags Flags word
153 * Flags should be one of:
154 * - @ref TRACKDB_NO_RECOVER
155 * - @ref TRACKDB_NORMAL_RECOVER
156 * - @ref TRACKDB_FATAL_RECOVER
158 void trackdb_init(int flags
) {
160 const int recover
= flags
& TRACKDB_RECOVER_MASK
;
161 static int recover_type
[] = { 0, DB_RECOVER
, DB_RECOVER_FATAL
};
164 assert(initialized
== 0);
167 if(strcmp(home
, config
->home
))
168 fatal(0, "cannot change db home without server restart");
172 /* create environment */
173 if((err
= db_env_create(&trackdb_env
, 0))) fatal(0, "db_env_create: %s",
175 if((err
= trackdb_env
->set_alloc(trackdb_env
,
176 xmalloc_noptr
, xrealloc_noptr
, xfree
)))
177 fatal(0, "trackdb_env->set_alloc: %s", db_strerror(err
));
178 if((err
= trackdb_env
->set_lk_max_locks(trackdb_env
, 10000)))
179 fatal(0, "trackdb_env->set_lk_max_locks: %s", db_strerror(err
));
180 if((err
= trackdb_env
->set_lk_max_objects(trackdb_env
, 10000)))
181 fatal(0, "trackdb_env->set_lk_max_objects: %s", db_strerror(err
));
182 if((err
= trackdb_env
->open(trackdb_env
, config
->home
,
188 |recover_type
[recover
],
190 fatal(0, "trackdb_env->open %s: %s", config
->home
, db_strerror(err
));
191 trackdb_env
->set_errpfx(trackdb_env
, "DB");
192 trackdb_env
->set_errfile(trackdb_env
, stderr
);
193 trackdb_env
->set_verbose(trackdb_env
, DB_VERB_DEADLOCK
, 1);
194 trackdb_env
->set_verbose(trackdb_env
, DB_VERB_RECOVERY
, 1);
195 trackdb_env
->set_verbose(trackdb_env
, DB_VERB_REPLICATION
, 1);
196 D(("initialized database environment"));
199 /* called when deadlock manager terminates */
200 static int reap_db_deadlock(ev_source
attribute((unused
)) *ev
,
201 pid_t
attribute((unused
)) pid
,
203 const struct rusage
attribute((unused
)) *rusage
,
204 void attribute((unused
)) *u
) {
205 db_deadlock_pid
= -1;
207 fatal(0, "deadlock manager unexpectedly terminated: %s",
210 D(("deadlock manager terminated: %s", wstat(status
)));
214 static pid_t
subprogram(ev_source
*ev
, const char *prog
,
218 /* If we're in the background then trap subprocess stdout/stderr */
219 if(!(pid
= xfork())) {
222 ev_signal_atfork(ev
);
223 signal(SIGPIPE
, SIG_DFL
);
228 /* If we were negatively niced, undo it. We don't bother checking for
229 * error, it's not that important. */
230 setpriority(PRIO_PROCESS
, 0, 0);
231 execlp(prog
, prog
, "--config", configfile
,
232 debugging ?
"--debug" : "--no-debug",
233 log_default
== &log_syslog ?
"--syslog" : "--no-syslog",
235 fatal(errno
, "error invoking %s", prog
);
240 /* start deadlock manager */
241 void trackdb_master(ev_source
*ev
) {
242 assert(db_deadlock_pid
== -1);
243 db_deadlock_pid
= subprogram(ev
, DEADLOCK
, -1);
244 ev_child(ev
, db_deadlock_pid
, 0, reap_db_deadlock
, 0);
245 D(("started deadlock manager"));
248 /* close environment */
249 void trackdb_deinit(void) {
253 assert(initialized
== 1);
256 /* close the environment */
257 if((err
= trackdb_env
->close(trackdb_env
, 0)))
258 fatal(0, "trackdb_env->close: %s", db_strerror(err
));
260 if(rescan_pid
!= -1 && kill(rescan_pid
, SIGTERM
) < 0)
261 fatal(errno
, "error killing rescanner");
263 /* terminate the deadlock manager */
264 if(db_deadlock_pid
!= -1 && kill(db_deadlock_pid
, SIGTERM
) < 0)
265 fatal(errno
, "error killing deadlock manager");
266 db_deadlock_pid
= -1;
268 D(("deinitialized database environment"));
271 /* open a specific database */
272 static DB
*open_db(const char *path
,
280 D(("open %s", path
));
281 path
= config_get_file(path
);
282 if((err
= db_create(&db
, trackdb_env
, 0)))
283 fatal(0, "db_create %s: %s", path
, db_strerror(err
));
285 if((err
= db
->set_flags(db
, dbflags
)))
286 fatal(0, "db->set_flags %s: %s", path
, db_strerror(err
));
287 if(dbtype
== DB_BTREE
)
288 if((err
= db
->set_bt_compare(db
, compare
)))
289 fatal(0, "db->set_bt_compare %s: %s", path
, db_strerror(err
));
290 if((err
= db
->open(db
, 0, path
, 0, dbtype
,
291 openflags
| DB_AUTO_COMMIT
, mode
))) {
292 if((openflags
& DB_CREATE
) || errno
!= ENOENT
)
293 fatal(0, "db->open %s: %s", path
, db_strerror(err
));
300 /** @brief Open track databases
301 * @param Flags flags word
303 * @p flags should be one of:
304 * - @p TRACKDB_NO_UPGRADE, if no upgrade should be attempted
305 * - @p TRACKDB_CAN_UPGRADE, if an upgrade may be attempted
306 * - @p TRACKDB_OPEN_FOR_UPGRADE, if this is disorder-dbupgrade
308 void trackdb_open(int flags
) {
315 /* check the database version first */
316 trackdb_globaldb
= open_db("global.db", 0, DB_HASH
, 0, 0666);
317 if(trackdb_globaldb
) {
318 /* This is an existing database */
322 s
= trackdb_get_global("_dbversion");
323 /* Close the database again, we'll open it property below */
324 if((err
= trackdb_globaldb
->close(trackdb_globaldb
, 0)))
325 fatal(0, "error closing global.db: %s", db_strerror(err
));
326 trackdb_globaldb
= 0;
327 /* Convert version string to an integer */
328 oldversion
= s ?
atol(s
) : 1;
329 if(oldversion
> config
->dbversion
) {
330 /* Database is from the future; we never allow this. */
331 fatal(0, "this version of DisOrder is too old for database version %ld",
334 if(oldversion
< config
->dbversion
) {
335 /* Database version is out of date */
336 switch(flags
& TRACKDB_UPGRADE_MASK
) {
337 case TRACKDB_NO_UPGRADE
:
338 /* This database needs upgrading but this is not permitted */
339 fatal(0, "database needs upgrading from %ld to %ld",
340 oldversion
, config
->dbversion
);
341 case TRACKDB_CAN_UPGRADE
:
342 /* This database needs upgrading */
343 info("invoking disorder-dbupgrade to upgrade from %ld to %ld",
344 oldversion
, config
->dbversion
);
345 pid
= subprogram(0, "disorder-dbupgrade", -1);
346 while(waitpid(pid
, &err
, 0) == -1 && errno
== EINTR
)
349 fatal(0, "disorder-dbupgrade %s", wstat(err
));
350 info("disorder-dbupgrade succeeded");
352 case TRACKDB_OPEN_FOR_UPGRADE
:
358 if(oldversion
== config
->dbversion
&& (flags
& TRACKDB_OPEN_FOR_UPGRADE
)) {
359 /* This doesn't make any sense */
360 fatal(0, "database is already at current version");
364 if(flags
& TRACKDB_OPEN_FOR_UPGRADE
) {
365 /* Cannot upgrade a new database */
366 fatal(0, "cannot upgrade a database that does not exist");
368 /* This is a brand new database */
371 /* open the databases */
372 trackdb_tracksdb
= open_db("tracks.db",
373 DB_RECNUM
, DB_BTREE
, DB_CREATE
, 0666);
374 trackdb_searchdb
= open_db("search.db",
375 DB_DUP
|DB_DUPSORT
, DB_HASH
, DB_CREATE
, 0666);
376 trackdb_tagsdb
= open_db("tags.db",
377 DB_DUP
|DB_DUPSORT
, DB_HASH
, DB_CREATE
, 0666);
378 trackdb_prefsdb
= open_db("prefs.db", 0, DB_HASH
, DB_CREATE
, 0666);
379 trackdb_globaldb
= open_db("global.db", 0, DB_HASH
, DB_CREATE
, 0666);
380 trackdb_noticeddb
= open_db("noticed.db",
381 DB_DUPSORT
, DB_BTREE
, DB_CREATE
, 0666);
383 /* Stash the database version */
386 assert(!(flags
& TRACKDB_OPEN_FOR_UPGRADE
));
387 snprintf(buf
, sizeof buf
, "%ld", config
->dbversion
);
388 trackdb_set_global("_dbversion", buf
, 0);
390 D(("opened databases"));
393 /* close track databases */
394 void trackdb_close(void) {
400 if((err
= trackdb_tracksdb
->close(trackdb_tracksdb
, 0)))
401 fatal(0, "error closing tracks.db: %s", db_strerror(err
));
402 if((err
= trackdb_searchdb
->close(trackdb_searchdb
, 0)))
403 fatal(0, "error closing search.db: %s", db_strerror(err
));
404 if((err
= trackdb_tagsdb
->close(trackdb_tagsdb
, 0)))
405 fatal(0, "error closing tags.db: %s", db_strerror(err
));
406 if((err
= trackdb_prefsdb
->close(trackdb_prefsdb
, 0)))
407 fatal(0, "error closing prefs.db: %s", db_strerror(err
));
408 if((err
= trackdb_globaldb
->close(trackdb_globaldb
, 0)))
409 fatal(0, "error closing global.db: %s", db_strerror(err
));
410 if((err
= trackdb_noticeddb
->close(trackdb_noticeddb
, 0)))
411 fatal(0, "error closing noticed.db: %s", db_strerror(err
));
412 trackdb_tracksdb
= trackdb_searchdb
= trackdb_prefsdb
= 0;
413 trackdb_tagsdb
= trackdb_globaldb
= 0;
414 D(("closed databases"));
417 /* generic db routines *******************************************************/
419 /* fetch and decode a database entry. Returns 0, DB_NOTFOUND or
420 * DB_LOCK_DEADLOCK. */
421 int trackdb_getdata(DB
*db
,
428 switch(err
= db
->get(db
, tid
, make_key(&key
, track
),
429 prepare_data(&data
), 0)) {
431 *kp
= kvp_urldecode(data
.data
, data
.size
);
436 case DB_LOCK_DEADLOCK
:
437 error(0, "error querying database: %s", db_strerror(err
));
440 fatal(0, "error querying database: %s", db_strerror(err
));
444 /* encode and store a database entry. Returns 0, DB_KEYEXIST or
445 * DB_LOCK_DEADLOCK. */
446 int trackdb_putdata(DB
*db
,
454 switch(err
= db
->put(db
, tid
, make_key(&key
, track
),
455 encode_data(&data
, k
), flags
)) {
459 case DB_LOCK_DEADLOCK
:
460 error(0, "error updating database: %s", db_strerror(err
));
463 fatal(0, "error updating database: %s", db_strerror(err
));
467 /* delete a database entry */
468 int trackdb_delkey(DB
*db
,
474 switch(err
= db
->del(db
, tid
, make_key(&key
, track
), 0)) {
478 case DB_LOCK_DEADLOCK
:
479 error(0, "error updating database: %s", db_strerror(err
));
482 fatal(0, "error updating database: %s", db_strerror(err
));
486 /* open a database cursor */
487 DBC
*trackdb_opencursor(DB
*db
, DB_TXN
*tid
) {
491 switch(err
= db
->cursor(db
, tid
, &c
, 0)) {
493 default: fatal(0, "error creating cursor: %s", db_strerror(err
));
498 /* close a database cursor; returns 0 or DB_LOCK_DEADLOCK */
499 int trackdb_closecursor(DBC
*c
) {
503 switch(err
= c
->c_close(c
)) {
506 case DB_LOCK_DEADLOCK
:
507 error(0, "error closing cursor: %s", db_strerror(err
));
510 fatal(0, "error closing cursor: %s", db_strerror(err
));
514 /* delete a (key,data) pair. Returns 0, DB_NOTFOUND or DB_LOCK_DEADLOCK. */
515 int trackdb_delkeydata(DB
*db
,
523 c
= trackdb_opencursor(db
, tid
);
524 switch(err
= c
->c_get(c
, make_key(&key
, word
),
525 make_key(&data
, track
), DB_GET_BOTH
)) {
527 switch(err
= c
->c_del(c
, 0)) {
533 case DB_LOCK_DEADLOCK
:
534 error(0, "error updating database: %s", db_strerror(err
));
537 fatal(0, "c->c_del: %s", db_strerror(err
));
542 case DB_LOCK_DEADLOCK
:
543 error(0, "error updating database: %s", db_strerror(err
));
546 fatal(0, "c->c_get: %s", db_strerror(err
));
548 if(trackdb_closecursor(c
)) err
= DB_LOCK_DEADLOCK
;
552 /* start a transaction */
553 DB_TXN
*trackdb_begin_transaction(void) {
557 if((err
= trackdb_env
->txn_begin(trackdb_env
, 0, &tid
, 0)))
558 fatal(0, "trackdb_env->txn_begin: %s", db_strerror(err
));
562 /* abort transaction */
563 void trackdb_abort_transaction(DB_TXN
*tid
) {
567 if((err
= tid
->abort(tid
)))
568 fatal(0, "tid->abort: %s", db_strerror(err
));
571 /* commit transaction */
572 void trackdb_commit_transaction(DB_TXN
*tid
) {
575 if((err
= tid
->commit(tid
, 0)))
576 fatal(0, "tid->commit: %s", db_strerror(err
));
579 /* search/tags shared code ***************************************************/
581 /* comparison function used by dedupe() */
582 static int wordcmp(const void *a
, const void *b
) {
583 return strcmp(*(const char **)a
, *(const char **)b
);
586 /* sort and de-dupe VEC */
587 static char **dedupe(char **vec
, int nvec
) {
590 qsort(vec
, nvec
, sizeof (char *), wordcmp
);
594 for(n
= 1; n
< nvec
; ++n
)
595 if(strcmp(vec
[n
], vec
[m
- 1]))
602 /* update a key/track database. Returns 0 or DB_DEADLOCK. */
603 static int register_word(DB
*db
, const char *what
,
604 const char *track
, const char *word
,
609 switch(err
= db
->put(db
, tid
, make_key(&key
, word
),
610 make_key(&data
, track
), DB_NODUPDATA
)) {
614 case DB_LOCK_DEADLOCK
:
615 error(0, "error updating %s.db: %s", what
, db_strerror(err
));
618 fatal(0, "error updating %s.db: %s", what
, db_strerror(err
));
622 /* search primitives *********************************************************/
624 /* return true iff NAME is a trackname_display_ pref */
625 static int is_display_pref(const char *name
) {
626 static const char prefix
[] = "trackname_display_";
627 return !strncmp(name
, prefix
, (sizeof prefix
) - 1);
630 /** @brief Word_Break property tailor that treats underscores as spaces */
631 static int tailor_underscore_Word_Break_Other(uint32_t c
) {
635 case 0x005F: /* LOW LINE (SPACING UNDERSCORE) */
636 return unicode_Word_Break_Other
;
640 /** @brief Normalize and split a string using a given tailoring */
641 static void word_split(struct vector
*v
,
643 unicode_property_tailor
*pt
) {
645 uint32_t *t32
, **w32
;
647 /* Convert to UTF-32 */
648 if(!(t32
= utf8_to_utf32(s
, strlen(s
), &nt32
)))
650 /* Erase case distinctions */
651 if(!(t32
= utf32_casefold_compat(t32
, nt32
, &nt32
)))
653 /* Split into words, treating _ as a space */
654 w32
= utf32_word_split(t32
, nt32
, &nw
, pt
);
655 /* Convert words back to UTF-8 and append to result */
656 for(i
= 0; i
< nw
; ++i
)
657 vector_append(v
, utf32_to_utf8(w32
[i
], utf32_len(w32
[i
]), 0));
660 /* compute the words of a track name */
661 static char **track_to_words(const char *track
,
662 const struct kvp
*p
) {
664 const char *rootless
= track_rootless(track
);
667 rootless
= track
; /* bodge */
669 rootless
= strip_extension(rootless
);
670 word_split(&v
, strip_extension(rootless
), tailor_underscore_Word_Break_Other
);
671 for(; p
; p
= p
->next
)
672 if(is_display_pref(p
->name
))
673 word_split(&v
, p
->value
, 0);
674 vector_terminate(&v
);
675 return dedupe(v
.vec
, v
.nvec
);
678 /* return nonzero iff WORD is a stopword */
679 static int stopword(const char *word
) {
682 for(n
= 0; n
< config
->stopword
.n
683 && strcmp(word
, config
->stopword
.s
[n
]); ++n
)
685 return n
< config
->stopword
.n
;
688 /* record that WORD appears in TRACK. Returns 0 or DB_LOCK_DEADLOCK. */
689 static int register_search_word(const char *track
, const char *word
,
691 if(stopword(word
)) return 0;
692 return register_word(trackdb_searchdb
, "search", track
, word
, tid
);
695 /* Tags **********************************************************************/
697 /* Return nonzero if C is a valid tag character */
698 static int tagchar(int c
) {
707 /* Parse and de-dupe a tag list. If S=0 then assumes "". */
708 static char **parsetags(const char *s
) {
714 /* skip initial separators */
715 while(*s
&& (!tagchar(*s
) || *s
== ' '))
718 /* find the extent of the tag */
720 while(*s
&& tagchar(*s
))
722 /* strip trailing spaces */
723 while(s
> t
&& s
[-1] == ' ')
725 vector_append(&v
, xstrndup(t
, s
- t
));
726 /* skip intermediate and trailing separators */
727 while(*s
&& (!tagchar(*s
) || *s
== ' '))
731 vector_terminate(&v
);
732 return dedupe(v
.vec
, v
.nvec
);
735 /* Record that TRACK has TAG. Returns 0 or DB_LOCK_DEADLOCK. */
736 static int register_tag(const char *track
, const char *tag
, DB_TXN
*tid
) {
737 return register_word(trackdb_tagsdb
, "tags", track
, tag
, tid
);
740 /* aliases *******************************************************************/
742 /* compute the alias and store at aliasp. Returns 0 or DB_LOCK_DEADLOCK. If
743 * there is no alias sets *aliasp to 0. */
744 static int compute_alias(char **aliasp
,
749 const char *s
= config
->alias
, *t
, *expansion
, *part
;
750 int c
, used_db
= 0, slash_prefix
, err
;
752 const char *const root
= find_track_root(track
);
755 /* Bodge for tracks with no root */
760 dynstr_append_string(&d
, root
);
761 while((c
= (unsigned char)*s
++)) {
763 dynstr_append(&d
, c
);
766 if((slash_prefix
= (*s
== '/')))
769 assert(t
!= 0); /* validated at startup */
770 part
= xstrndup(s
, t
- s
);
771 expansion
= getpart(track
, "display", part
, p
, &used_db
);
773 if(slash_prefix
) dynstr_append(&d
, '/');
774 dynstr_append_string(&d
, expansion
);
776 s
= t
+ 1; /* skip {part} */
778 /* only admit to the alias if we used the db... */
783 dynstr_terminate(&d
);
784 /* ...and the answer differs from the original... */
785 if(!strcmp(track
, d
.vec
)) {
789 /* ...and there isn't already a different track with that name (including as
791 switch(err
= trackdb_getdata(trackdb_tracksdb
, d
.vec
, &at
, tid
)) {
793 if((s
= kvp_get(at
, "_alias_for"))
794 && !strcmp(s
, track
)) {
806 /* get track and prefs data (if tp/pp not null pointers). Returns 0 on
807 * success, DB_NOTFOUND if the track does not exist or DB_LOCK_DEADLOCK.
808 * Always sets the return values, even if only to null pointers. */
809 static int gettrackdata(const char *track
,
812 const char **actualp
,
814 #define GTD_NOALIAS 0x0001
817 const char *actual
= track
;
818 struct kvp
*t
= 0, *p
= 0;
820 if((err
= trackdb_getdata(trackdb_tracksdb
, track
, &t
, tid
))) goto done
;
821 if((actual
= kvp_get(t
, "_alias_for"))) {
822 if(flags
& GTD_NOALIAS
) {
823 error(0, "alias passed to gettrackdata where real path required");
826 if((err
= trackdb_getdata(trackdb_tracksdb
, actual
, &t
, tid
))) goto done
;
831 if((err
= trackdb_getdata(trackdb_prefsdb
, actual
, &p
, tid
)) == DB_LOCK_DEADLOCK
)
836 if(actualp
) *actualp
= actual
;
842 /* trackdb_notice() **********************************************************/
844 /** @brief notice a possibly new track
845 * @return @c DB_NOTFOUND if new, 0 if already known
847 int trackdb_notice(const char *track
,
853 tid
= trackdb_begin_transaction();
854 err
= trackdb_notice_tid(track
, path
, tid
);
855 if((err
== DB_LOCK_DEADLOCK
)) goto fail
;
858 trackdb_abort_transaction(tid
);
860 trackdb_commit_transaction(tid
);
864 /** @brief notice a possibly new track
865 * @param track NFC UTF-8 track name
866 * @param path Raw path name
867 * @param tid Transaction ID
868 * @return @c DB_NOTFOUND if new, 0 if already known, @c DB_LOCK_DEADLOCK also
870 int trackdb_notice_tid(const char *track
,
874 struct kvp
*t
, *a
, *p
;
878 /* notice whether the tracks.db entry changes */
880 /* get any existing tracks entry */
881 if((err
= gettrackdata(track
, &t
, &p
, 0, 0, tid
)) == DB_LOCK_DEADLOCK
)
883 ret
= err
; /* 0 or DB_NOTFOUND */
884 /* this is a real track */
885 t_changed
+= kvp_set(&t
, "_alias_for", 0);
886 t_changed
+= kvp_set(&t
, "_path", path
);
887 /* if we have an alias record it in the database */
888 if((err
= compute_alias(&alias
, track
, p
, tid
))) return err
;
890 /* won't overwrite someone else's alias as compute_alias() checks */
891 D(("%s: alias %s", track
, alias
));
893 kvp_set(&a
, "_alias_for", track
);
894 if((err
= trackdb_putdata(trackdb_tracksdb
, alias
, a
, tid
, 0))) return err
;
896 /* update search.db */
897 w
= track_to_words(track
, p
);
898 for(n
= 0; w
[n
]; ++n
)
899 if((err
= register_search_word(track
, w
[n
], tid
)))
902 w
= parsetags(kvp_get(p
, "tags"));
903 for(n
= 0; w
[n
]; ++n
)
904 if((err
= register_tag(track
, w
[n
], tid
)))
907 /* only store the tracks.db entry if it has changed */
908 if(t_changed
&& (err
= trackdb_putdata(trackdb_tracksdb
, track
, t
, tid
, 0)))
910 if(ret
== DB_NOTFOUND
) {
911 uint32_t timestamp
[2];
916 timestamp
[0] = htonl((uint64_t)now
>> 32);
917 timestamp
[1] = htonl((uint32_t)now
);
918 memset(&key
, 0, sizeof key
);
919 key
.data
= timestamp
;
920 key
.size
= sizeof timestamp
;
921 switch(err
= trackdb_noticeddb
->put(trackdb_noticeddb
, tid
, &key
,
922 make_key(&data
, track
), 0)) {
924 case DB_LOCK_DEADLOCK
: return err
;
925 default: fatal(0, "error updating noticed.db: %s", db_strerror(err
));
931 /* trackdb_obsolete() ********************************************************/
933 /* obsolete a track */
934 int trackdb_obsolete(const char *track
, DB_TXN
*tid
) {
939 if((err
= gettrackdata(track
, 0, &p
, 0,
940 GTD_NOALIAS
, tid
)) == DB_LOCK_DEADLOCK
)
942 else if(err
== DB_NOTFOUND
) return 0;
943 /* compute the alias, if any, and delete it */
944 if(compute_alias(&alias
, track
, p
, tid
)) return err
;
946 /* if the alias points to some other track then compute_alias won't
948 if(trackdb_delkey(trackdb_tracksdb
, alias
, tid
))
951 /* update search.db */
952 w
= track_to_words(track
, p
);
953 for(n
= 0; w
[n
]; ++n
)
954 if(trackdb_delkeydata(trackdb_searchdb
,
955 w
[n
], track
, tid
) == DB_LOCK_DEADLOCK
)
958 w
= parsetags(kvp_get(p
, "tags"));
959 for(n
= 0; w
[n
]; ++n
)
960 if(trackdb_delkeydata(trackdb_tagsdb
,
961 w
[n
], track
, tid
) == DB_LOCK_DEADLOCK
)
964 /* update tracks.db */
965 if(trackdb_delkey(trackdb_tracksdb
, track
, tid
) == DB_LOCK_DEADLOCK
)
967 /* We don't delete the prefs, so they survive temporary outages of the
968 * (possibly virtual) track filesystem */
972 /* trackdb_stats() ***********************************************************/
974 #define H(name) { #name, offsetof(DB_HASH_STAT, name) }
975 #define B(name) { #name, offsetof(DB_BTREE_STAT, name) }
977 static const struct statinfo
{
980 } statinfo_hash
[] = {
996 }, statinfo_btree
[] = {
1017 /* look up stats for DB */
1018 static int get_stats(struct vector
*v
,
1020 const struct statinfo
*si
,
1029 switch(err
= database
->stat(database
, tid
, &sp
, 0)) {
1032 case DB_LOCK_DEADLOCK
:
1033 error(0, "error querying database: %s", db_strerror(err
));
1036 fatal(0, "error querying database: %s", db_strerror(err
));
1038 for(n
= 0; n
< nsi
; ++n
) {
1039 byte_xasprintf(&str
, "%s=%"PRIuMAX
, si
[n
].name
,
1040 (uintmax_t)*(u_int32_t
*)((char *)sp
+ si
[n
].offset
));
1041 vector_append(v
, str
);
1047 struct search_entry
{
1052 /* find the top COUNT words in the search database */
1053 static int search_league(struct vector
*v
, int count
, DB_TXN
*tid
) {
1054 struct search_entry
*se
;
1057 int err
, n
= 0, nse
= 0, i
;
1062 cursor
= trackdb_opencursor(trackdb_searchdb
, tid
);
1063 se
= xmalloc(count
* sizeof *se
);
1064 while(!(err
= cursor
->c_get(cursor
, prepare_data(&k
), prepare_data(&d
),
1066 if(word
&& wl
== k
.size
&& !strncmp(word
, k
.data
, wl
))
1069 #define FINALIZE() do { \
1070 if(word && (nse < count || n > se[nse - 1].n)) { \
1075 while(i > 0 && n > se[i - 1].n) \
1077 memmove(&se[i + 1], &se[i], (nse - i) * sizeof *se); \
1078 se[i].word = word; \
1083 word
= xstrndup(k
.data
, wl
= k
.size
);
1091 case DB_LOCK_DEADLOCK
:
1092 error(0, "error querying search database: %s", db_strerror(err
));
1095 fatal(0, "error querying search database: %s", db_strerror(err
));
1097 if(trackdb_closecursor(cursor
)) err
= DB_LOCK_DEADLOCK
;
1100 byte_xasprintf(&str
, "Top %d search words:", nse
);
1101 vector_append(v
, str
);
1102 for(i
= 0; i
< nse
; ++i
) {
1103 byte_xasprintf(&str
, "%4d: %5d %s", i
+ 1, se
[i
].n
, se
[i
].word
);
1104 vector_append(v
, str
);
1109 #define SI(what) statinfo_##what, \
1110 sizeof statinfo_##what / sizeof (struct statinfo)
1112 /* return a list of database stats */
1113 char **trackdb_stats(int *nstatsp
) {
1119 tid
= trackdb_begin_transaction();
1121 vector_append(&v
, (char *)"Tracks database stats:");
1122 if(get_stats(&v
, trackdb_tracksdb
, SI(btree
), tid
)) goto fail
;
1123 vector_append(&v
, (char *)"");
1124 vector_append(&v
, (char *)"Search database stats:");
1125 if(get_stats(&v
, trackdb_searchdb
, SI(hash
), tid
)) goto fail
;
1126 vector_append(&v
, (char *)"");
1127 vector_append(&v
, (char *)"Prefs database stats:");
1128 if(get_stats(&v
, trackdb_prefsdb
, SI(hash
), tid
)) goto fail
;
1129 vector_append(&v
, (char *)"");
1130 if(search_league(&v
, 10, tid
)) goto fail
;
1131 vector_terminate(&v
);
1134 trackdb_abort_transaction(tid
);
1136 trackdb_commit_transaction(tid
);
1137 if(nstatsp
) *nstatsp
= v
.nvec
;
1141 struct stats_details
{
1142 void (*done
)(char *data
, void *u
);
1144 int exited
; /* subprocess exited */
1145 int closed
; /* pipe close */
1146 int wstat
; /* wait status from subprocess */
1147 struct dynstr data
[1]; /* data read from pipe */
1150 static void stats_complete(struct stats_details
*d
) {
1153 if(!(d
->exited
&& d
->closed
))
1155 byte_xasprintf(&s
, "\n"
1157 "track lookup cache hits: %lu\n"
1158 "track lookup cache misses: %lu\n",
1160 cache_files_misses
);
1161 dynstr_append_string(d
->data
, s
);
1162 dynstr_terminate(d
->data
);
1163 d
->done(d
->data
->vec
, d
->u
);
1166 static int stats_finished(ev_source
attribute((unused
)) *ev
,
1167 pid_t
attribute((unused
)) pid
,
1169 const struct rusage
attribute((unused
)) *rusage
,
1171 struct stats_details
*const d
= u
;
1175 error(0, "disorder-stats %s", wstat(status
));
1180 static int stats_read(ev_source
attribute((unused
)) *ev
,
1186 struct stats_details
*const d
= u
;
1188 dynstr_append_bytes(d
->data
, ptr
, bytes
);
1189 ev_reader_consume(reader
, bytes
);
1196 static int stats_error(ev_source
attribute((unused
)) *ev
,
1199 struct stats_details
*const d
= u
;
1201 error(errno_value
, "error reading from pipe to disorder-stats");
1207 void trackdb_stats_subprocess(ev_source
*ev
,
1208 void (*done
)(char *data
, void *u
),
1212 struct stats_details
*d
= xmalloc(sizeof *d
);
1214 dynstr_init(d
->data
);
1218 pid
= subprogram(ev
, "disorder-stats", p
[1]);
1220 ev_child(ev
, pid
, 0, stats_finished
, d
);
1221 ev_reader_new(ev
, p
[0], stats_read
, stats_error
, d
, "disorder-stats reader");
1224 /* set a pref (remove if value=0) */
1225 int trackdb_set(const char *track
,
1227 const char *value
) {
1228 struct kvp
*t
, *p
, *a
;
1231 char *oldalias
, *newalias
, **oldtags
= 0, **newtags
;
1234 /* TODO: if value matches default then set value=0 */
1238 tid
= trackdb_begin_transaction();
1239 if((err
= gettrackdata(track
, &t
, &p
, 0,
1240 0, tid
)) == DB_LOCK_DEADLOCK
)
1242 if(err
== DB_NOTFOUND
) break;
1243 if(name
[0] == '_') {
1244 if(kvp_set(&t
, name
, value
))
1245 if(trackdb_putdata(trackdb_tracksdb
, track
, t
, tid
, 0))
1248 /* get the old alias name */
1249 if(compute_alias(&oldalias
, track
, p
, tid
)) goto fail
;
1250 /* get the old tags */
1251 if(!strcmp(name
, "tags"))
1252 oldtags
= parsetags(kvp_get(p
, "tags"));
1254 if(kvp_set(&p
, name
, value
))
1255 if(trackdb_putdata(trackdb_prefsdb
, track
, p
, tid
, 0))
1257 /* compute the new alias name */
1258 if((err
= compute_alias(&newalias
, track
, p
, tid
))) goto fail
;
1259 /* check whether alias has changed */
1260 if(!(oldalias
== newalias
1261 || (oldalias
&& newalias
&& !strcmp(oldalias
, newalias
)))) {
1262 /* adjust alias records to fit change */
1264 && trackdb_delkey(trackdb_tracksdb
, oldalias
, tid
)) goto fail
;
1267 kvp_set(&a
, "_alias_for", track
);
1268 if(trackdb_putdata(trackdb_tracksdb
, newalias
, a
, tid
, 0)) goto fail
;
1271 /* check whether tags have changed */
1272 if(!strcmp(name
, "tags")) {
1273 newtags
= parsetags(value
);
1274 while(*oldtags
|| *newtags
) {
1275 if(*oldtags
&& *newtags
) {
1276 cmp
= strcmp(*oldtags
, *newtags
);
1278 /* keeping this tag */
1282 /* old tag fits into a gap in the new list, so delete old */
1285 /* new tag fits into a gap in the old list, so insert new */
1287 } else if(*oldtags
) {
1288 /* we've run out of new tags, so remaining old ones are to be
1291 if(trackdb_delkeydata(trackdb_tagsdb
,
1292 *oldtags
, track
, tid
) == DB_LOCK_DEADLOCK
)
1296 /* we've run out of old tags, so remainig new ones are to be
1299 if(register_tag(track
, *newtags
, tid
)) goto fail
;
1309 trackdb_abort_transaction(tid
);
1311 trackdb_commit_transaction(tid
);
1312 return err
== 0 ?
0 : -1;
1316 const char *trackdb_get(const char *track
,
1318 return kvp_get(trackdb_get_all(track
), name
);
1321 /* get all prefs as a 0-terminated array */
1322 struct kvp
*trackdb_get_all(const char *track
) {
1323 struct kvp
*t
, *p
, **pp
;
1327 tid
= trackdb_begin_transaction();
1328 if(gettrackdata(track
, &t
, &p
, 0, 0, tid
) == DB_LOCK_DEADLOCK
)
1332 trackdb_abort_transaction(tid
);
1334 trackdb_commit_transaction(tid
);
1335 for(pp
= &p
; *pp
; pp
= &(*pp
)->next
)
1342 const char *trackdb_resolve(const char *track
) {
1347 tid
= trackdb_begin_transaction();
1348 if(gettrackdata(track
, 0, 0, &actual
, 0, tid
) == DB_LOCK_DEADLOCK
)
1352 trackdb_abort_transaction(tid
);
1354 trackdb_commit_transaction(tid
);
1358 int trackdb_isalias(const char *track
) {
1359 const char *actual
= trackdb_resolve(track
);
1361 return strcmp(actual
, track
);
1364 /* test whether a track exists (perhaps an alias) */
1365 int trackdb_exists(const char *track
) {
1370 tid
= trackdb_begin_transaction();
1371 /* unusually, here we want the return value */
1372 if((err
= gettrackdata(track
, 0, 0, 0, 0, tid
)) == DB_LOCK_DEADLOCK
)
1376 trackdb_abort_transaction(tid
);
1378 trackdb_commit_transaction(tid
);
1382 /* return the list of tags */
1383 char **trackdb_alltags(void) {
1389 tid
= trackdb_begin_transaction();
1390 err
= trackdb_alltags_tid(tid
, &taglist
);
1392 trackdb_abort_transaction(tid
);
1394 trackdb_commit_transaction(tid
);
1398 static int trackdb_alltags_tid(DB_TXN
*tid
, char ***taglistp
) {
1405 c
= trackdb_opencursor(trackdb_tagsdb
, tid
);
1406 memset(&k
, 0, sizeof k
);
1407 while(!(err
= c
->c_get(c
, &k
, prepare_data(&d
), DB_NEXT_NODUP
)))
1408 vector_append(&v
, xstrndup(k
.data
, k
.size
));
1412 case DB_LOCK_DEADLOCK
:
1415 fatal(0, "c->c_get: %s", db_strerror(err
));
1417 if((err
= trackdb_closecursor(c
))) return err
;
1418 vector_terminate(&v
);
1423 /* return 1 iff sorted tag lists A and B have at least one member in common */
1424 static int tag_intersection(char **a
, char **b
) {
1427 /* Same sort of logic as trackdb_set() above */
1429 if(!(cmp
= strcmp(*a
, *b
))) return 1;
1430 else if(cmp
< 0) ++a
;
1436 /* Check whether a track is suitable for random play. Returns 0 if it is,
1437 * DB_NOTFOUND if it is not or DB_LOCK_DEADLOCK if the database gave us
1439 static int check_suitable(const char *track
,
1441 char **required_tags
,
1442 char **prohibited_tags
) {
1446 const char *pick_at_random
, *played_time
;
1448 /* don't pick tracks that aren't in any surviving collection (for instance
1449 * you've edited the config but the rescan hasn't done its job yet) */
1450 if(!find_track_root(track
)) {
1451 info("found track not in any collection: %s", track
);
1454 /* don't pick aliases - only pick the canonical form */
1455 if(gettrackdata(track
, &t
, &p
, 0, 0, tid
) == DB_LOCK_DEADLOCK
)
1456 return DB_LOCK_DEADLOCK
;
1457 if(kvp_get(t
, "_alias_for"))
1459 /* check that random play is not suppressed for this track */
1460 if((pick_at_random
= kvp_get(p
, "pick_at_random"))
1461 && !strcmp(pick_at_random
, "0"))
1463 /* don't pick a track that's been played in the last 8 hours */
1464 if((played_time
= kvp_get(p
, "played_time"))) {
1465 last
= atoll(played_time
);
1467 if(now
< last
+ 8 * 3600) /* TODO configurable */
1470 track_tags
= parsetags(kvp_get(p
, "tags"));
1471 /* check that no prohibited tag is present for this track */
1472 if(prohibited_tags
&& tag_intersection(track_tags
, prohibited_tags
))
1474 /* check that at least one required tags is present for this track */
1475 if(*required_tags
&& !tag_intersection(track_tags
, required_tags
))
1480 /* attempt to pick a random non-alias track */
1481 const char *trackdb_random(int tries
) {
1486 const char *track
, *candidate
;
1489 char **required_tags
, **prohibited_tags
, **tp
;
1494 tid
= trackdb_begin_transaction();
1495 if((err
= trackdb_get_global_tid("required-tags", tid
, &tags
)))
1497 required_tags
= parsetags(tags
);
1498 if((err
= trackdb_get_global_tid("prohibited-tags", tid
, &tags
)))
1500 prohibited_tags
= parsetags(tags
);
1502 if(*required_tags
) {
1503 /* Bung all the suitable tracks into a hash and convert to a list of keys
1504 * (to eliminate duplicates). We cache this list since it is possible
1505 * that it will be very large. */
1508 for(tp
= required_tags
; *tp
; ++tp
) {
1509 c
= trackdb_opencursor(trackdb_tagsdb
, tid
);
1510 memset(&key
, 0, sizeof key
);
1512 key
.size
= strlen(*tp
);
1514 err
= c
->c_get(c
, &key
, prepare_data(&data
), DB_SET
);
1516 hash_add(h
, xstrndup(data
.data
, data
.size
), 0,
1517 HASH_INSERT_OR_REPLACE
);
1519 err
= c
->c_get(c
, &key
, prepare_data(&data
), DB_NEXT_DUP
);
1525 case DB_LOCK_DEADLOCK
:
1528 fatal(0, "error querying tags.db: %s", db_strerror(err
));
1530 trackdb_closecursor(c
);
1533 error(0, "required tag %s does not match any tracks", *tp
);
1535 nreqtracks
= hash_count(h
);
1536 reqtracks
= hash_keys(h
);
1538 while(nreqtracks
&& !track
&& tries
-- > 0) {
1539 r
= (rand() * (double)nreqtracks
/ (RAND_MAX
+ 1.0));
1540 candidate
= reqtracks
[r
];
1541 switch(check_suitable(candidate
, tid
,
1542 required_tags
, prohibited_tags
)) {
1548 case DB_LOCK_DEADLOCK
:
1553 /* No required tags. We pick random record numbers in the database
1555 switch(err
= trackdb_tracksdb
->stat(trackdb_tracksdb
, tid
, &sp
, 0)) {
1558 case DB_LOCK_DEADLOCK
:
1559 error(0, "error querying tracks.db: %s", db_strerror(err
));
1562 fatal(0, "error querying tracks.db: %s", db_strerror(err
));
1565 error(0, "cannot pick tracks at random from an empty database");
1566 while(sp
->bt_nkeys
&& !track
&& tries
-- > 0) {
1567 /* record numbers count from 1 upwards */
1568 r
= 1 + (rand() * (double)sp
->bt_nkeys
/ (RAND_MAX
+ 1.0));
1569 memset(&key
, sizeof key
, 0);
1570 key
.flags
= DB_DBT_MALLOC
;
1571 key
.size
= sizeof r
;
1573 switch(err
= trackdb_tracksdb
->get(trackdb_tracksdb
, tid
, &key
, prepare_data(&data
),
1577 case DB_LOCK_DEADLOCK
:
1578 error(0, "error querying tracks.db: %s", db_strerror(err
));
1581 fatal(0, "error querying tracks.db: %s", db_strerror(err
));
1583 candidate
= xstrndup(key
.data
, key
.size
);
1584 switch(check_suitable(candidate
, tid
,
1585 required_tags
, prohibited_tags
)) {
1591 case DB_LOCK_DEADLOCK
:
1598 trackdb_closecursor(c
);
1600 trackdb_abort_transaction(tid
);
1602 trackdb_commit_transaction(tid
);
1604 error(0, "could not pick a random track");
1608 /* get a track name given the prefs. Set *used_db to 1 if we got the answer
1609 * from the prefs. */
1610 static const char *getpart(const char *track
,
1611 const char *context
,
1613 const struct kvp
*p
,
1618 byte_xasprintf(&pref
, "trackname_%s_%s", context
, part
);
1619 if((result
= kvp_get(p
, pref
)))
1622 result
= trackname_part(track
, context
, part
);
1623 assert(result
!= 0);
1627 /* get a track name part, like trackname_part(), but taking the database into
1629 const char *trackdb_getpart(const char *track
,
1630 const char *context
,
1638 /* construct the full pref */
1639 byte_xasprintf(&pref
, "trackname_%s_%s", context
, part
);
1641 tid
= trackdb_begin_transaction();
1642 if((err
= gettrackdata(track
, 0, &p
, &actual
, 0, tid
)) == DB_LOCK_DEADLOCK
)
1646 trackdb_abort_transaction(tid
);
1648 trackdb_commit_transaction(tid
);
1649 return getpart(actual
, context
, part
, p
, &used_db
);
1652 /* get the raw path name for @track@ (might be an alias) */
1653 const char *trackdb_rawpath(const char *track
) {
1659 tid
= trackdb_begin_transaction();
1660 if(gettrackdata(track
, &t
, 0, 0, 0, tid
) == DB_LOCK_DEADLOCK
)
1664 trackdb_abort_transaction(tid
);
1666 trackdb_commit_transaction(tid
);
1667 if(!(path
= kvp_get(t
, "_path"))) path
= track
;
1671 /* trackdb_list **************************************************************/
1673 /* this is incredibly ugly, sorry, perhaps it will be rewritten to be actually
1674 * readable at some point */
1676 /* return true if the basename of TRACK[0..TL-1], as defined by DL, matches RE.
1677 * If RE is a null pointer then it matches everything. */
1678 static int track_matches(size_t dl
, const char *track
, size_t tl
,
1686 switch(rc
= pcre_exec(re
, 0, track
, tl
, 0, 0, ovec
, 3)) {
1687 case PCRE_ERROR_NOMATCH
: return 0;
1690 error(0, "pcre_exec returned %d, subject '%s'", rc
, track
);
1697 static int do_list(struct vector
*v
, const char *dir
,
1698 enum trackdb_listable what
, const pcre
*re
, DB_TXN
*tid
) {
1704 size_t l
, last_dir_len
= 0;
1705 char *last_dir
= 0, *track
, *alias
;
1709 cursor
= trackdb_opencursor(trackdb_tracksdb
, tid
);
1712 /* find the first key >= dir */
1713 err
= cursor
->c_get(cursor
, &k
, &d
, DB_SET_RANGE
);
1714 /* keep going while we're dealing with <dir/anything> */
1717 && ((char *)k
.data
)[dl
] == '/'
1718 && !memcmp(k
.data
, dir
, dl
)) {
1719 ptr
= memchr((char *)k
.data
+ dl
+ 1, '/', k
.size
- (dl
+ 1));
1721 /* we have <dir/component/anything>, so <dir/component> is a directory */
1722 l
= ptr
- (char *)k
.data
;
1723 if(what
& trackdb_directories
)
1725 && l
== last_dir_len
1726 && !memcmp(last_dir
, k
.data
, l
))) {
1727 last_dir
= xstrndup(k
.data
, last_dir_len
= l
);
1728 if(track_matches(dl
, k
.data
, l
, re
))
1729 vector_append(v
, last_dir
);
1732 /* found a plain file */
1733 if((what
& trackdb_files
)) {
1734 track
= xstrndup(k
.data
, k
.size
);
1735 if((err
= trackdb_getdata(trackdb_prefsdb
,
1736 track
, &p
, tid
)) == DB_LOCK_DEADLOCK
)
1738 /* if this file has an alias in the same directory then we skip it */
1739 if((err
= compute_alias(&alias
, track
, p
, tid
)))
1741 if(!(alias
&& !strcmp(d_dirname(alias
), d_dirname(track
))))
1742 if(track_matches(dl
, k
.data
, k
.size
, re
))
1743 vector_append(v
, track
);
1746 err
= cursor
->c_get(cursor
, &k
, &d
, DB_NEXT
);
1754 case DB_LOCK_DEADLOCK
:
1755 error(0, "error querying database: %s", db_strerror(err
));
1758 fatal(0, "error querying database: %s", db_strerror(err
));
1761 if(trackdb_closecursor(cursor
)) err
= DB_LOCK_DEADLOCK
;
1765 /* return the directories or files below @dir@ */
1766 char **trackdb_list(const char *dir
, int *np
, enum trackdb_listable what
,
1774 tid
= trackdb_begin_transaction();
1777 if(do_list(&v
, dir
, what
, re
, tid
))
1780 for(n
= 0; n
< config
->collection
.n
; ++n
)
1781 if(do_list(&v
, config
->collection
.s
[n
].root
, what
, re
, tid
))
1786 trackdb_abort_transaction(tid
);
1788 trackdb_commit_transaction(tid
);
1789 vector_terminate(&v
);
1795 /* If S is tag:something, return something. Else return 0. */
1796 static const char *checktag(const char *s
) {
1797 if(!strncmp(s
, "tag:", 4))
1803 /* return a list of tracks containing all of the words given. If you
1804 * ask for only stopwords you get no tracks. */
1805 char **trackdb_search(char **wordlist
, int nwordlist
, int *ntracks
) {
1806 const char **w
, *best
= 0, *tag
;
1807 char **twords
, **tags
;
1808 int i
, j
, n
, err
, what
;
1818 *ntracks
= 0; /* for early returns */
1819 /* casefold all the words */
1820 w
= xmalloc(nwordlist
* sizeof (char *));
1821 for(n
= 0; n
< nwordlist
; ++n
) {
1822 w
[n
] = utf8_casefold_compat(wordlist
[n
], strlen(wordlist
[n
]), 0);
1823 if(checktag(w
[n
])) ++ntags
; /* count up tags */
1825 /* find the longest non-stopword */
1826 for(n
= 0; n
< nwordlist
; ++n
)
1827 if(!stopword(w
[n
]) && !checktag(w
[n
]))
1828 if(!best
|| strlen(w
[n
]) > strlen(best
))
1830 /* TODO: we should at least in principal be able to identify the word or tag
1831 * with the least matches in log time, and choose that as our primary search
1833 if(ntags
&& !best
) {
1834 /* Only tags are listed. We limit to the first and narrow down with the
1836 best
= checktag(w
[0]);
1837 db
= trackdb_tagsdb
;
1840 /* We can limit to some word. */
1841 db
= trackdb_searchdb
;
1844 /* Only stopwords */
1850 tid
= trackdb_begin_transaction();
1851 /* find all the tracks that have that word */
1856 cursor
= trackdb_opencursor(db
, tid
);
1857 while(!(err
= cursor
->c_get(cursor
, &k
, &d
, what
))) {
1858 vector_append(&v
, xstrndup(d
.data
, d
.size
));
1865 case DB_LOCK_DEADLOCK
:
1866 error(0, "error querying %s database: %s", dbname
, db_strerror(err
));
1869 fatal(0, "error querying %s database: %s", dbname
, db_strerror(err
));
1871 if(trackdb_closecursor(cursor
)) err
= DB_LOCK_DEADLOCK
;
1873 /* do a naive search over that (hopefuly fairly small) list of tracks */
1875 for(n
= 0; n
< v
.nvec
; ++n
) {
1876 if((err
= gettrackdata(v
.vec
[n
], 0, &p
, 0, 0, tid
) == DB_LOCK_DEADLOCK
))
1879 error(0, "track %s unexpected error: %s", v
.vec
[n
], db_strerror(err
));
1882 twords
= track_to_words(v
.vec
[n
], p
);
1883 tags
= parsetags(kvp_get(p
, "tags"));
1884 for(i
= 0; i
< nwordlist
; ++i
) {
1885 if((tag
= checktag(w
[i
]))) {
1886 /* Track must have this tag */
1887 for(j
= 0; tags
[j
]; ++j
)
1888 if(!strcmp(tag
, tags
[j
])) break; /* tag found */
1889 if(!tags
[j
]) break; /* tag not found */
1891 /* Track must contain this word */
1892 for(j
= 0; twords
[j
]; ++j
)
1893 if(!strcmp(w
[i
], twords
[j
])) break; /* word found */
1894 if(!twords
[j
]) break; /* word not found */
1897 if(i
>= nwordlist
) /* all words found */
1898 vector_append(&u
, v
.vec
[n
]);
1902 trackdb_closecursor(cursor
);
1904 trackdb_abort_transaction(tid
);
1905 info("retrying search");
1907 trackdb_commit_transaction(tid
);
1908 vector_terminate(&u
);
1914 /* trackdb_scan **************************************************************/
1916 int trackdb_scan(const char *root
,
1917 int (*callback
)(const char *track
,
1925 const size_t root_len
= root ?
strlen(root
) : 0;
1930 cursor
= trackdb_opencursor(trackdb_tracksdb
, tid
);
1932 err
= cursor
->c_get(cursor
, make_key(&k
, root
), prepare_data(&d
),
1935 memset(&k
, 0, sizeof k
);
1936 err
= cursor
->c_get(cursor
, &k
, prepare_data(&d
),
1941 || (k
.size
> root_len
1942 && !strncmp(k
.data
, root
, root_len
)
1943 && ((char *)k
.data
)[root_len
] == '/')) {
1944 data
= kvp_urldecode(d
.data
, d
.size
);
1945 if(kvp_get(data
, "_path")) {
1946 track
= xstrndup(k
.data
, k
.size
);
1947 /* Advance to the next track before the callback so that the callback
1948 * may safely delete the track */
1949 err
= cursor
->c_get(cursor
, &k
, &d
, DB_NEXT
);
1950 if((cberr
= callback(track
, data
, u
, tid
))) {
1955 err
= cursor
->c_get(cursor
, &k
, &d
, DB_NEXT
);
1959 trackdb_closecursor(cursor
);
1966 case DB_LOCK_DEADLOCK
:
1967 error(0, "c->c_get: %s", db_strerror(err
));
1970 fatal(0, "c->c_get: %s", db_strerror(err
));
1974 /* trackdb_rescan ************************************************************/
1976 /* called when the rescanner terminates */
1977 static int reap_rescan(ev_source
attribute((unused
)) *ev
,
1980 const struct rusage
attribute((unused
)) *rusage
,
1981 void attribute((unused
)) *u
) {
1982 if(pid
== rescan_pid
) rescan_pid
= -1;
1984 error(0, RESCAN
": %s", wstat(status
));
1986 D((RESCAN
" terminated: %s", wstat(status
)));
1987 /* Our cache of file lookups is out of date now */
1988 cache_clean(&cache_files_type
);
1989 eventlog("rescanned", (char *)0);
1993 void trackdb_rescan(ev_source
*ev
) {
1996 if(rescan_pid
!= -1) {
1997 error(0, "rescan already underway");
2000 rescan_pid
= subprogram(ev
, RESCAN
, -1);
2002 ev_child(ev
, rescan_pid
, 0, reap_rescan
, 0);
2003 D(("started rescanner"));
2005 /* This is the first rescan, we block until it is complete */
2006 while(waitpid(rescan_pid
, &w
, 0) < 0 && errno
== EINTR
)
2008 reap_rescan(0, rescan_pid
, w
, 0, 0);
2012 int trackdb_rescan_cancel(void) {
2013 if(rescan_pid
== -1) return 0;
2014 if(kill(rescan_pid
, SIGTERM
) < 0)
2015 fatal(errno
, "error killing rescanner");
2020 /* global prefs **************************************************************/
2022 void trackdb_set_global(const char *name
,
2030 tid
= trackdb_begin_transaction();
2031 if(!(err
= trackdb_set_global_tid(name
, value
, tid
)))
2033 trackdb_abort_transaction(tid
);
2035 trackdb_commit_transaction(tid
);
2036 /* log important state changes */
2037 if(!strcmp(name
, "playing")) {
2038 state
= !value
|| !strcmp(value
, "yes");
2039 info("playing %s by %s",
2040 state ?
"enabled" : "disabled",
2042 eventlog("state", state ?
"enable_play" : "disable_play", (char *)0);
2044 if(!strcmp(name
, "random-play")) {
2045 state
= !value
|| !strcmp(value
, "yes");
2046 info("random play %s by %s",
2047 state ?
"enabled" : "disabled",
2049 eventlog("state", state ?
"enable_random" : "disable_random", (char *)0);
2051 if(!strcmp(name
, "required-tags"))
2055 int trackdb_set_global_tid(const char *name
,
2061 memset(&k
, 0, sizeof k
);
2062 memset(&d
, 0, sizeof d
);
2063 k
.data
= (void *)name
;
2064 k
.size
= strlen(name
);
2066 d
.data
= (void *)value
;
2067 d
.size
= strlen(value
);
2070 err
= trackdb_globaldb
->put(trackdb_globaldb
, tid
, &k
, &d
, 0);
2072 err
= trackdb_globaldb
->del(trackdb_globaldb
, tid
, &k
, 0);
2073 if(err
== DB_LOCK_DEADLOCK
) return err
;
2075 fatal(0, "error updating database: %s", db_strerror(err
));
2079 const char *trackdb_get_global(const char *name
) {
2085 tid
= trackdb_begin_transaction();
2086 if(!(err
= trackdb_get_global_tid(name
, tid
, &r
)))
2088 trackdb_abort_transaction(tid
);
2090 trackdb_commit_transaction(tid
);
2094 int trackdb_get_global_tid(const char *name
,
2100 memset(&k
, 0, sizeof k
);
2101 k
.data
= (void *)name
;
2102 k
.size
= strlen(name
);
2103 switch(err
= trackdb_globaldb
->get(trackdb_globaldb
, tid
, &k
,
2104 prepare_data(&d
), 0)) {
2106 *rp
= xstrndup(d
.data
, d
.size
);
2111 case DB_LOCK_DEADLOCK
:
2114 fatal(0, "error reading database: %s", db_strerror(err
));
2118 /** @brief Retrieve the most recently added tracks
2119 * @param ntracksp Where to put count, or 0
2120 * @param maxtracks Maximum number of tracks to retrieve
2121 * @return null-terminated array of track names
2123 * The most recently added track is first in the array.
2125 char **trackdb_new(int *ntracksp
,
2131 tid
= trackdb_begin_transaction();
2132 tracks
= trackdb_new_tid(ntracksp
, maxtracks
, tid
);
2135 trackdb_abort_transaction(tid
);
2137 trackdb_commit_transaction(tid
);
2141 /** @brief Retrieve the most recently added tracks
2142 * @param ntracksp Where to put count, or 0
2143 * @param maxtracks Maximum number of tracks to retrieve, or 0 for all
2144 * @param tid Transaction ID
2145 * @return null-terminated array of track names, or NULL on deadlock
2147 * The most recently added track is first in the array.
2149 static char **trackdb_new_tid(int *ntracksp
,
2155 struct vector tracks
[1];
2157 vector_init(tracks
);
2158 c
= trackdb_opencursor(trackdb_noticeddb
, tid
);
2159 while((maxtracks
<= 0 || tracks
->nvec
< maxtracks
)
2160 && !(err
= c
->c_get(c
, prepare_data(&k
), prepare_data(&d
), DB_PREV
)))
2161 vector_append(tracks
, xstrndup(d
.data
, d
.size
));
2163 case 0: /* hit maxtracks */
2164 case DB_NOTFOUND
: /* ran out of tracks */
2166 case DB_LOCK_DEADLOCK
:
2167 trackdb_closecursor(c
);
2170 fatal(0, "error reading noticed.db: %s", db_strerror(err
));
2172 if((err
= trackdb_closecursor(c
)))
2173 return 0; /* deadlock */
2174 vector_terminate(tracks
);
2176 *ntracksp
= tracks
->nvec
;
2180 /** @brief Expire noticed.db
2181 * @param earliest Earliest timestamp to keep
2183 void trackdb_expire_noticed(time_t earliest
) {
2187 tid
= trackdb_begin_transaction();
2188 if(!trackdb_expire_noticed_tid(earliest
, tid
))
2190 trackdb_abort_transaction(tid
);
2192 trackdb_commit_transaction(tid
);
2195 /** @brief Expire noticed.db
2196 * @param earliest Earliest timestamp to keep
2197 * @param tid Transaction ID
2198 * @return 0 or DB_LOCK_DEADLOCK
2200 static int trackdb_expire_noticed_tid(time_t earliest
, DB_TXN
*tid
) {
2208 c
= trackdb_opencursor(trackdb_noticeddb
, tid
);
2209 while(!(err
= c
->c_get(c
, prepare_data(&k
), prepare_data(&d
), DB_NEXT
))) {
2211 when
= (time_t)(((uint64_t)ntohl(kk
[0]) << 32) + ntohl(kk
[1]));
2212 if(when
>= earliest
)
2214 if((err
= c
->c_del(c
, 0))) {
2215 if(err
!= DB_LOCK_DEADLOCK
)
2216 fatal(0, "error deleting expired noticed.db entry: %s",
2222 if(err
== DB_NOTFOUND
)
2224 if(err
&& err
!= DB_LOCK_DEADLOCK
)
2225 fatal(0, "error expiring noticed.db: %s", db_strerror(err
));
2227 if((err
= trackdb_closecursor(c
))) {
2228 if(err
!= DB_LOCK_DEADLOCK
)
2229 fatal(0, "error closing cursor: %s", db_strerror(err
));
2233 info("expired %d tracks from noticed.db", count
);
2237 /* tidying up ****************************************************************/
2239 void trackdb_gc(void) {
2243 if((err
= trackdb_env
->txn_checkpoint(trackdb_env
,
2244 config
->checkpoint_kbyte
,
2245 config
->checkpoint_min
,
2247 fatal(0, "trackdb_env->txn_checkpoint: %s", db_strerror(err
));
2248 if((err
= trackdb_env
->log_archive(trackdb_env
, &logfiles
, DB_ARCH_REMOVE
)))
2249 fatal(0, "trackdb_env->log_archive: %s", db_strerror(err
));
2250 /* This makes catastrophic recovery impossible. However, the user can still
2251 * preserve the important data by using disorder-dump to snapshot their
2252 * prefs, and later to restore it. This is likely to have much small
2253 * long-term storage requirements than record the db logfiles. */
2261 indent-tabs-mode:nil