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 Remove all combining characters in-place
641 * @param s Pointer to start of string
642 * @param ns Length of string
643 * @return New, possiblby reduced, length
645 static size_t remove_combining_chars(uint32_t *s
, size_t ns
) {
646 uint32_t *start
= s
, *t
= s
, *end
= s
+ ns
;
649 const uint32_t c
= *s
++;
650 if(!utf32_combining_class(c
))
656 /** @brief Normalize and split a string using a given tailoring */
657 static void word_split(struct vector
*v
,
659 unicode_property_tailor
*pt
) {
661 uint32_t *t32
, **w32
;
663 /* Convert to UTF-32 */
664 if(!(t32
= utf8_to_utf32(s
, strlen(s
), &nt32
)))
666 /* Erase case distinctions */
667 if(!(t32
= utf32_casefold_compat(t32
, nt32
, &nt32
)))
669 /* Drop combining characters */
670 nt32
= remove_combining_chars(t32
, nt32
);
671 /* Split into words, treating _ as a space */
672 w32
= utf32_word_split(t32
, nt32
, &nw
, pt
);
673 /* Convert words back to UTF-8 and append to result */
674 for(i
= 0; i
< nw
; ++i
)
675 vector_append(v
, utf32_to_utf8(w32
[i
], utf32_len(w32
[i
]), 0));
678 /* compute the words of a track name */
679 static char **track_to_words(const char *track
,
680 const struct kvp
*p
) {
682 const char *rootless
= track_rootless(track
);
685 rootless
= track
; /* bodge */
687 rootless
= strip_extension(rootless
);
688 word_split(&v
, strip_extension(rootless
), tailor_underscore_Word_Break_Other
);
689 for(; p
; p
= p
->next
)
690 if(is_display_pref(p
->name
))
691 word_split(&v
, p
->value
, 0);
692 vector_terminate(&v
);
693 return dedupe(v
.vec
, v
.nvec
);
696 /* return nonzero iff WORD is a stopword */
697 static int stopword(const char *word
) {
700 for(n
= 0; n
< config
->stopword
.n
701 && strcmp(word
, config
->stopword
.s
[n
]); ++n
)
703 return n
< config
->stopword
.n
;
706 /* record that WORD appears in TRACK. Returns 0 or DB_LOCK_DEADLOCK. */
707 static int register_search_word(const char *track
, const char *word
,
709 if(stopword(word
)) return 0;
710 return register_word(trackdb_searchdb
, "search", track
, word
, tid
);
713 /* Tags **********************************************************************/
715 /* Return nonzero if C is a valid tag character */
716 static int tagchar(int c
) {
725 /* Parse and de-dupe a tag list. If S=0 then assumes "". */
726 static char **parsetags(const char *s
) {
732 /* skip initial separators */
733 while(*s
&& (!tagchar(*s
) || *s
== ' '))
736 /* find the extent of the tag */
738 while(*s
&& tagchar(*s
))
740 /* strip trailing spaces */
741 while(s
> t
&& s
[-1] == ' ')
743 vector_append(&v
, xstrndup(t
, s
- t
));
744 /* skip intermediate and trailing separators */
745 while(*s
&& (!tagchar(*s
) || *s
== ' '))
749 vector_terminate(&v
);
750 return dedupe(v
.vec
, v
.nvec
);
753 /* Record that TRACK has TAG. Returns 0 or DB_LOCK_DEADLOCK. */
754 static int register_tag(const char *track
, const char *tag
, DB_TXN
*tid
) {
755 return register_word(trackdb_tagsdb
, "tags", track
, tag
, tid
);
758 /* aliases *******************************************************************/
760 /* compute the alias and store at aliasp. Returns 0 or DB_LOCK_DEADLOCK. If
761 * there is no alias sets *aliasp to 0. */
762 static int compute_alias(char **aliasp
,
767 const char *s
= config
->alias
, *t
, *expansion
, *part
;
768 int c
, used_db
= 0, slash_prefix
, err
;
770 const char *const root
= find_track_root(track
);
773 /* Bodge for tracks with no root */
778 dynstr_append_string(&d
, root
);
779 while((c
= (unsigned char)*s
++)) {
781 dynstr_append(&d
, c
);
784 if((slash_prefix
= (*s
== '/')))
787 assert(t
!= 0); /* validated at startup */
788 part
= xstrndup(s
, t
- s
);
789 expansion
= getpart(track
, "display", part
, p
, &used_db
);
791 if(slash_prefix
) dynstr_append(&d
, '/');
792 dynstr_append_string(&d
, expansion
);
794 s
= t
+ 1; /* skip {part} */
796 /* only admit to the alias if we used the db... */
801 dynstr_terminate(&d
);
802 /* ...and the answer differs from the original... */
803 if(!strcmp(track
, d
.vec
)) {
807 /* ...and there isn't already a different track with that name (including as
809 switch(err
= trackdb_getdata(trackdb_tracksdb
, d
.vec
, &at
, tid
)) {
811 if((s
= kvp_get(at
, "_alias_for"))
812 && !strcmp(s
, track
)) {
824 /* get track and prefs data (if tp/pp not null pointers). Returns 0 on
825 * success, DB_NOTFOUND if the track does not exist or DB_LOCK_DEADLOCK.
826 * Always sets the return values, even if only to null pointers. */
827 static int gettrackdata(const char *track
,
830 const char **actualp
,
832 #define GTD_NOALIAS 0x0001
835 const char *actual
= track
;
836 struct kvp
*t
= 0, *p
= 0;
838 if((err
= trackdb_getdata(trackdb_tracksdb
, track
, &t
, tid
))) goto done
;
839 if((actual
= kvp_get(t
, "_alias_for"))) {
840 if(flags
& GTD_NOALIAS
) {
841 error(0, "alias passed to gettrackdata where real path required");
844 if((err
= trackdb_getdata(trackdb_tracksdb
, actual
, &t
, tid
))) goto done
;
849 if((err
= trackdb_getdata(trackdb_prefsdb
, actual
, &p
, tid
)) == DB_LOCK_DEADLOCK
)
854 if(actualp
) *actualp
= actual
;
860 /* trackdb_notice() **********************************************************/
862 /** @brief notice a possibly new track
863 * @return @c DB_NOTFOUND if new, 0 if already known
865 int trackdb_notice(const char *track
,
871 tid
= trackdb_begin_transaction();
872 err
= trackdb_notice_tid(track
, path
, tid
);
873 if((err
== DB_LOCK_DEADLOCK
)) goto fail
;
876 trackdb_abort_transaction(tid
);
878 trackdb_commit_transaction(tid
);
882 /** @brief notice a possibly new track
883 * @param track NFC UTF-8 track name
884 * @param path Raw path name
885 * @param tid Transaction ID
886 * @return @c DB_NOTFOUND if new, 0 if already known, @c DB_LOCK_DEADLOCK also
888 int trackdb_notice_tid(const char *track
,
892 struct kvp
*t
, *a
, *p
;
896 /* notice whether the tracks.db entry changes */
898 /* get any existing tracks entry */
899 if((err
= gettrackdata(track
, &t
, &p
, 0, 0, tid
)) == DB_LOCK_DEADLOCK
)
901 ret
= err
; /* 0 or DB_NOTFOUND */
902 /* this is a real track */
903 t_changed
+= kvp_set(&t
, "_alias_for", 0);
904 t_changed
+= kvp_set(&t
, "_path", path
);
905 /* if we have an alias record it in the database */
906 if((err
= compute_alias(&alias
, track
, p
, tid
))) return err
;
908 /* won't overwrite someone else's alias as compute_alias() checks */
909 D(("%s: alias %s", track
, alias
));
911 kvp_set(&a
, "_alias_for", track
);
912 if((err
= trackdb_putdata(trackdb_tracksdb
, alias
, a
, tid
, 0))) return err
;
914 /* update search.db */
915 w
= track_to_words(track
, p
);
916 for(n
= 0; w
[n
]; ++n
)
917 if((err
= register_search_word(track
, w
[n
], tid
)))
920 w
= parsetags(kvp_get(p
, "tags"));
921 for(n
= 0; w
[n
]; ++n
)
922 if((err
= register_tag(track
, w
[n
], tid
)))
925 /* only store the tracks.db entry if it has changed */
926 if(t_changed
&& (err
= trackdb_putdata(trackdb_tracksdb
, track
, t
, tid
, 0)))
928 if(ret
== DB_NOTFOUND
) {
929 uint32_t timestamp
[2];
934 timestamp
[0] = htonl((uint64_t)now
>> 32);
935 timestamp
[1] = htonl((uint32_t)now
);
936 memset(&key
, 0, sizeof key
);
937 key
.data
= timestamp
;
938 key
.size
= sizeof timestamp
;
939 switch(err
= trackdb_noticeddb
->put(trackdb_noticeddb
, tid
, &key
,
940 make_key(&data
, track
), 0)) {
942 case DB_LOCK_DEADLOCK
: return err
;
943 default: fatal(0, "error updating noticed.db: %s", db_strerror(err
));
949 /* trackdb_obsolete() ********************************************************/
951 /* obsolete a track */
952 int trackdb_obsolete(const char *track
, DB_TXN
*tid
) {
957 if((err
= gettrackdata(track
, 0, &p
, 0,
958 GTD_NOALIAS
, tid
)) == DB_LOCK_DEADLOCK
)
960 else if(err
== DB_NOTFOUND
) return 0;
961 /* compute the alias, if any, and delete it */
962 if(compute_alias(&alias
, track
, p
, tid
)) return err
;
964 /* if the alias points to some other track then compute_alias won't
966 if(trackdb_delkey(trackdb_tracksdb
, alias
, tid
))
969 /* update search.db */
970 w
= track_to_words(track
, p
);
971 for(n
= 0; w
[n
]; ++n
)
972 if(trackdb_delkeydata(trackdb_searchdb
,
973 w
[n
], track
, tid
) == DB_LOCK_DEADLOCK
)
976 w
= parsetags(kvp_get(p
, "tags"));
977 for(n
= 0; w
[n
]; ++n
)
978 if(trackdb_delkeydata(trackdb_tagsdb
,
979 w
[n
], track
, tid
) == DB_LOCK_DEADLOCK
)
982 /* update tracks.db */
983 if(trackdb_delkey(trackdb_tracksdb
, track
, tid
) == DB_LOCK_DEADLOCK
)
985 /* We don't delete the prefs, so they survive temporary outages of the
986 * (possibly virtual) track filesystem */
990 /* trackdb_stats() ***********************************************************/
992 #define H(name) { #name, offsetof(DB_HASH_STAT, name) }
993 #define B(name) { #name, offsetof(DB_BTREE_STAT, name) }
995 static const struct statinfo
{
998 } statinfo_hash
[] = {
1014 }, statinfo_btree
[] = {
1035 /* look up stats for DB */
1036 static int get_stats(struct vector
*v
,
1038 const struct statinfo
*si
,
1047 switch(err
= database
->stat(database
, tid
, &sp
, 0)) {
1050 case DB_LOCK_DEADLOCK
:
1051 error(0, "error querying database: %s", db_strerror(err
));
1054 fatal(0, "error querying database: %s", db_strerror(err
));
1056 for(n
= 0; n
< nsi
; ++n
) {
1057 byte_xasprintf(&str
, "%s=%"PRIuMAX
, si
[n
].name
,
1058 (uintmax_t)*(u_int32_t
*)((char *)sp
+ si
[n
].offset
));
1059 vector_append(v
, str
);
1065 struct search_entry
{
1070 /* find the top COUNT words in the search database */
1071 static int search_league(struct vector
*v
, int count
, DB_TXN
*tid
) {
1072 struct search_entry
*se
;
1075 int err
, n
= 0, nse
= 0, i
;
1080 cursor
= trackdb_opencursor(trackdb_searchdb
, tid
);
1081 se
= xmalloc(count
* sizeof *se
);
1082 while(!(err
= cursor
->c_get(cursor
, prepare_data(&k
), prepare_data(&d
),
1084 if(word
&& wl
== k
.size
&& !strncmp(word
, k
.data
, wl
))
1087 #define FINALIZE() do { \
1088 if(word && (nse < count || n > se[nse - 1].n)) { \
1093 while(i > 0 && n > se[i - 1].n) \
1095 memmove(&se[i + 1], &se[i], (nse - i) * sizeof *se); \
1096 se[i].word = word; \
1101 word
= xstrndup(k
.data
, wl
= k
.size
);
1109 case DB_LOCK_DEADLOCK
:
1110 error(0, "error querying search database: %s", db_strerror(err
));
1113 fatal(0, "error querying search database: %s", db_strerror(err
));
1115 if(trackdb_closecursor(cursor
)) err
= DB_LOCK_DEADLOCK
;
1118 byte_xasprintf(&str
, "Top %d search words:", nse
);
1119 vector_append(v
, str
);
1120 for(i
= 0; i
< nse
; ++i
) {
1121 byte_xasprintf(&str
, "%4d: %5d %s", i
+ 1, se
[i
].n
, se
[i
].word
);
1122 vector_append(v
, str
);
1127 #define SI(what) statinfo_##what, \
1128 sizeof statinfo_##what / sizeof (struct statinfo)
1130 /* return a list of database stats */
1131 char **trackdb_stats(int *nstatsp
) {
1137 tid
= trackdb_begin_transaction();
1139 vector_append(&v
, (char *)"Tracks database stats:");
1140 if(get_stats(&v
, trackdb_tracksdb
, SI(btree
), tid
)) goto fail
;
1141 vector_append(&v
, (char *)"");
1142 vector_append(&v
, (char *)"Search database stats:");
1143 if(get_stats(&v
, trackdb_searchdb
, SI(hash
), tid
)) goto fail
;
1144 vector_append(&v
, (char *)"");
1145 vector_append(&v
, (char *)"Prefs database stats:");
1146 if(get_stats(&v
, trackdb_prefsdb
, SI(hash
), tid
)) goto fail
;
1147 vector_append(&v
, (char *)"");
1148 if(search_league(&v
, 10, tid
)) goto fail
;
1149 vector_terminate(&v
);
1152 trackdb_abort_transaction(tid
);
1154 trackdb_commit_transaction(tid
);
1155 if(nstatsp
) *nstatsp
= v
.nvec
;
1159 struct stats_details
{
1160 void (*done
)(char *data
, void *u
);
1162 int exited
; /* subprocess exited */
1163 int closed
; /* pipe close */
1164 int wstat
; /* wait status from subprocess */
1165 struct dynstr data
[1]; /* data read from pipe */
1168 static void stats_complete(struct stats_details
*d
) {
1171 if(!(d
->exited
&& d
->closed
))
1173 byte_xasprintf(&s
, "\n"
1175 "track lookup cache hits: %lu\n"
1176 "track lookup cache misses: %lu\n",
1178 cache_files_misses
);
1179 dynstr_append_string(d
->data
, s
);
1180 dynstr_terminate(d
->data
);
1181 d
->done(d
->data
->vec
, d
->u
);
1184 static int stats_finished(ev_source
attribute((unused
)) *ev
,
1185 pid_t
attribute((unused
)) pid
,
1187 const struct rusage
attribute((unused
)) *rusage
,
1189 struct stats_details
*const d
= u
;
1193 error(0, "disorder-stats %s", wstat(status
));
1198 static int stats_read(ev_source
attribute((unused
)) *ev
,
1204 struct stats_details
*const d
= u
;
1206 dynstr_append_bytes(d
->data
, ptr
, bytes
);
1207 ev_reader_consume(reader
, bytes
);
1214 static int stats_error(ev_source
attribute((unused
)) *ev
,
1217 struct stats_details
*const d
= u
;
1219 error(errno_value
, "error reading from pipe to disorder-stats");
1225 void trackdb_stats_subprocess(ev_source
*ev
,
1226 void (*done
)(char *data
, void *u
),
1230 struct stats_details
*d
= xmalloc(sizeof *d
);
1232 dynstr_init(d
->data
);
1236 pid
= subprogram(ev
, "disorder-stats", p
[1]);
1238 ev_child(ev
, pid
, 0, stats_finished
, d
);
1239 ev_reader_new(ev
, p
[0], stats_read
, stats_error
, d
, "disorder-stats reader");
1242 /* set a pref (remove if value=0) */
1243 int trackdb_set(const char *track
,
1245 const char *value
) {
1246 struct kvp
*t
, *p
, *a
;
1249 char *oldalias
, *newalias
, **oldtags
= 0, **newtags
;
1252 /* TODO: if value matches default then set value=0 */
1256 tid
= trackdb_begin_transaction();
1257 if((err
= gettrackdata(track
, &t
, &p
, 0,
1258 0, tid
)) == DB_LOCK_DEADLOCK
)
1260 if(err
== DB_NOTFOUND
) break;
1261 if(name
[0] == '_') {
1262 if(kvp_set(&t
, name
, value
))
1263 if(trackdb_putdata(trackdb_tracksdb
, track
, t
, tid
, 0))
1266 /* get the old alias name */
1267 if(compute_alias(&oldalias
, track
, p
, tid
)) goto fail
;
1268 /* get the old tags */
1269 if(!strcmp(name
, "tags"))
1270 oldtags
= parsetags(kvp_get(p
, "tags"));
1272 if(kvp_set(&p
, name
, value
))
1273 if(trackdb_putdata(trackdb_prefsdb
, track
, p
, tid
, 0))
1275 /* compute the new alias name */
1276 if((err
= compute_alias(&newalias
, track
, p
, tid
))) goto fail
;
1277 /* check whether alias has changed */
1278 if(!(oldalias
== newalias
1279 || (oldalias
&& newalias
&& !strcmp(oldalias
, newalias
)))) {
1280 /* adjust alias records to fit change */
1282 && trackdb_delkey(trackdb_tracksdb
, oldalias
, tid
)) goto fail
;
1285 kvp_set(&a
, "_alias_for", track
);
1286 if(trackdb_putdata(trackdb_tracksdb
, newalias
, a
, tid
, 0)) goto fail
;
1289 /* check whether tags have changed */
1290 if(!strcmp(name
, "tags")) {
1291 newtags
= parsetags(value
);
1292 while(*oldtags
|| *newtags
) {
1293 if(*oldtags
&& *newtags
) {
1294 cmp
= strcmp(*oldtags
, *newtags
);
1296 /* keeping this tag */
1300 /* old tag fits into a gap in the new list, so delete old */
1303 /* new tag fits into a gap in the old list, so insert new */
1305 } else if(*oldtags
) {
1306 /* we've run out of new tags, so remaining old ones are to be
1309 if(trackdb_delkeydata(trackdb_tagsdb
,
1310 *oldtags
, track
, tid
) == DB_LOCK_DEADLOCK
)
1314 /* we've run out of old tags, so remainig new ones are to be
1317 if(register_tag(track
, *newtags
, tid
)) goto fail
;
1327 trackdb_abort_transaction(tid
);
1329 trackdb_commit_transaction(tid
);
1330 return err
== 0 ?
0 : -1;
1334 const char *trackdb_get(const char *track
,
1336 return kvp_get(trackdb_get_all(track
), name
);
1339 /* get all prefs as a 0-terminated array */
1340 struct kvp
*trackdb_get_all(const char *track
) {
1341 struct kvp
*t
, *p
, **pp
;
1345 tid
= trackdb_begin_transaction();
1346 if(gettrackdata(track
, &t
, &p
, 0, 0, tid
) == DB_LOCK_DEADLOCK
)
1350 trackdb_abort_transaction(tid
);
1352 trackdb_commit_transaction(tid
);
1353 for(pp
= &p
; *pp
; pp
= &(*pp
)->next
)
1360 const char *trackdb_resolve(const char *track
) {
1365 tid
= trackdb_begin_transaction();
1366 if(gettrackdata(track
, 0, 0, &actual
, 0, tid
) == DB_LOCK_DEADLOCK
)
1370 trackdb_abort_transaction(tid
);
1372 trackdb_commit_transaction(tid
);
1376 int trackdb_isalias(const char *track
) {
1377 const char *actual
= trackdb_resolve(track
);
1379 return strcmp(actual
, track
);
1382 /* test whether a track exists (perhaps an alias) */
1383 int trackdb_exists(const char *track
) {
1388 tid
= trackdb_begin_transaction();
1389 /* unusually, here we want the return value */
1390 if((err
= gettrackdata(track
, 0, 0, 0, 0, tid
)) == DB_LOCK_DEADLOCK
)
1394 trackdb_abort_transaction(tid
);
1396 trackdb_commit_transaction(tid
);
1400 /* return the list of tags */
1401 char **trackdb_alltags(void) {
1407 tid
= trackdb_begin_transaction();
1408 err
= trackdb_alltags_tid(tid
, &taglist
);
1410 trackdb_abort_transaction(tid
);
1412 trackdb_commit_transaction(tid
);
1416 static int trackdb_alltags_tid(DB_TXN
*tid
, char ***taglistp
) {
1423 c
= trackdb_opencursor(trackdb_tagsdb
, tid
);
1424 memset(&k
, 0, sizeof k
);
1425 while(!(err
= c
->c_get(c
, &k
, prepare_data(&d
), DB_NEXT_NODUP
)))
1426 vector_append(&v
, xstrndup(k
.data
, k
.size
));
1430 case DB_LOCK_DEADLOCK
:
1433 fatal(0, "c->c_get: %s", db_strerror(err
));
1435 if((err
= trackdb_closecursor(c
))) return err
;
1436 vector_terminate(&v
);
1441 /* return 1 iff sorted tag lists A and B have at least one member in common */
1442 static int tag_intersection(char **a
, char **b
) {
1445 /* Same sort of logic as trackdb_set() above */
1447 if(!(cmp
= strcmp(*a
, *b
))) return 1;
1448 else if(cmp
< 0) ++a
;
1454 /* Check whether a track is suitable for random play. Returns 0 if it is,
1455 * DB_NOTFOUND if it is not or DB_LOCK_DEADLOCK if the database gave us
1457 static int check_suitable(const char *track
,
1459 char **required_tags
,
1460 char **prohibited_tags
) {
1464 const char *pick_at_random
, *played_time
;
1466 /* don't pick tracks that aren't in any surviving collection (for instance
1467 * you've edited the config but the rescan hasn't done its job yet) */
1468 if(!find_track_root(track
)) {
1469 info("found track not in any collection: %s", track
);
1472 /* don't pick aliases - only pick the canonical form */
1473 if(gettrackdata(track
, &t
, &p
, 0, 0, tid
) == DB_LOCK_DEADLOCK
)
1474 return DB_LOCK_DEADLOCK
;
1475 if(kvp_get(t
, "_alias_for"))
1477 /* check that random play is not suppressed for this track */
1478 if((pick_at_random
= kvp_get(p
, "pick_at_random"))
1479 && !strcmp(pick_at_random
, "0"))
1481 /* don't pick a track that's been played in the last 8 hours */
1482 if((played_time
= kvp_get(p
, "played_time"))) {
1483 last
= atoll(played_time
);
1485 if(now
< last
+ 8 * 3600) /* TODO configurable */
1488 track_tags
= parsetags(kvp_get(p
, "tags"));
1489 /* check that no prohibited tag is present for this track */
1490 if(prohibited_tags
&& tag_intersection(track_tags
, prohibited_tags
))
1492 /* check that at least one required tags is present for this track */
1493 if(*required_tags
&& !tag_intersection(track_tags
, required_tags
))
1498 /* attempt to pick a random non-alias track */
1499 const char *trackdb_random(int tries
) {
1504 const char *track
, *candidate
;
1507 char **required_tags
, **prohibited_tags
, **tp
;
1512 tid
= trackdb_begin_transaction();
1513 if((err
= trackdb_get_global_tid("required-tags", tid
, &tags
)))
1515 required_tags
= parsetags(tags
);
1516 if((err
= trackdb_get_global_tid("prohibited-tags", tid
, &tags
)))
1518 prohibited_tags
= parsetags(tags
);
1520 if(*required_tags
) {
1521 /* Bung all the suitable tracks into a hash and convert to a list of keys
1522 * (to eliminate duplicates). We cache this list since it is possible
1523 * that it will be very large. */
1526 for(tp
= required_tags
; *tp
; ++tp
) {
1527 c
= trackdb_opencursor(trackdb_tagsdb
, tid
);
1528 memset(&key
, 0, sizeof key
);
1530 key
.size
= strlen(*tp
);
1532 err
= c
->c_get(c
, &key
, prepare_data(&data
), DB_SET
);
1534 hash_add(h
, xstrndup(data
.data
, data
.size
), 0,
1535 HASH_INSERT_OR_REPLACE
);
1537 err
= c
->c_get(c
, &key
, prepare_data(&data
), DB_NEXT_DUP
);
1543 case DB_LOCK_DEADLOCK
:
1546 fatal(0, "error querying tags.db: %s", db_strerror(err
));
1548 trackdb_closecursor(c
);
1551 error(0, "required tag %s does not match any tracks", *tp
);
1553 nreqtracks
= hash_count(h
);
1554 reqtracks
= hash_keys(h
);
1556 while(nreqtracks
&& !track
&& tries
-- > 0) {
1557 r
= (rand() * (double)nreqtracks
/ (RAND_MAX
+ 1.0));
1558 candidate
= reqtracks
[r
];
1559 switch(check_suitable(candidate
, tid
,
1560 required_tags
, prohibited_tags
)) {
1566 case DB_LOCK_DEADLOCK
:
1571 /* No required tags. We pick random record numbers in the database
1573 switch(err
= trackdb_tracksdb
->stat(trackdb_tracksdb
, tid
, &sp
, 0)) {
1576 case DB_LOCK_DEADLOCK
:
1577 error(0, "error querying tracks.db: %s", db_strerror(err
));
1580 fatal(0, "error querying tracks.db: %s", db_strerror(err
));
1583 error(0, "cannot pick tracks at random from an empty database");
1584 while(sp
->bt_nkeys
&& !track
&& tries
-- > 0) {
1585 /* record numbers count from 1 upwards */
1586 r
= 1 + (rand() * (double)sp
->bt_nkeys
/ (RAND_MAX
+ 1.0));
1587 memset(&key
, sizeof key
, 0);
1588 key
.flags
= DB_DBT_MALLOC
;
1589 key
.size
= sizeof r
;
1591 switch(err
= trackdb_tracksdb
->get(trackdb_tracksdb
, tid
, &key
, prepare_data(&data
),
1595 case DB_LOCK_DEADLOCK
:
1596 error(0, "error querying tracks.db: %s", db_strerror(err
));
1599 fatal(0, "error querying tracks.db: %s", db_strerror(err
));
1601 candidate
= xstrndup(key
.data
, key
.size
);
1602 switch(check_suitable(candidate
, tid
,
1603 required_tags
, prohibited_tags
)) {
1609 case DB_LOCK_DEADLOCK
:
1616 trackdb_closecursor(c
);
1618 trackdb_abort_transaction(tid
);
1620 trackdb_commit_transaction(tid
);
1622 error(0, "could not pick a random track");
1626 /* get a track name given the prefs. Set *used_db to 1 if we got the answer
1627 * from the prefs. */
1628 static const char *getpart(const char *track
,
1629 const char *context
,
1631 const struct kvp
*p
,
1636 byte_xasprintf(&pref
, "trackname_%s_%s", context
, part
);
1637 if((result
= kvp_get(p
, pref
)))
1640 result
= trackname_part(track
, context
, part
);
1641 assert(result
!= 0);
1645 /* get a track name part, like trackname_part(), but taking the database into
1647 const char *trackdb_getpart(const char *track
,
1648 const char *context
,
1656 /* construct the full pref */
1657 byte_xasprintf(&pref
, "trackname_%s_%s", context
, part
);
1659 tid
= trackdb_begin_transaction();
1660 if((err
= gettrackdata(track
, 0, &p
, &actual
, 0, tid
)) == DB_LOCK_DEADLOCK
)
1664 trackdb_abort_transaction(tid
);
1666 trackdb_commit_transaction(tid
);
1667 return getpart(actual
, context
, part
, p
, &used_db
);
1670 /* get the raw path name for @track@ (might be an alias) */
1671 const char *trackdb_rawpath(const char *track
) {
1677 tid
= trackdb_begin_transaction();
1678 if(gettrackdata(track
, &t
, 0, 0, 0, tid
) == DB_LOCK_DEADLOCK
)
1682 trackdb_abort_transaction(tid
);
1684 trackdb_commit_transaction(tid
);
1685 if(!(path
= kvp_get(t
, "_path"))) path
= track
;
1689 /* trackdb_list **************************************************************/
1691 /* this is incredibly ugly, sorry, perhaps it will be rewritten to be actually
1692 * readable at some point */
1694 /* return true if the basename of TRACK[0..TL-1], as defined by DL, matches RE.
1695 * If RE is a null pointer then it matches everything. */
1696 static int track_matches(size_t dl
, const char *track
, size_t tl
,
1704 switch(rc
= pcre_exec(re
, 0, track
, tl
, 0, 0, ovec
, 3)) {
1705 case PCRE_ERROR_NOMATCH
: return 0;
1708 error(0, "pcre_exec returned %d, subject '%s'", rc
, track
);
1715 static int do_list(struct vector
*v
, const char *dir
,
1716 enum trackdb_listable what
, const pcre
*re
, DB_TXN
*tid
) {
1722 size_t l
, last_dir_len
= 0;
1723 char *last_dir
= 0, *track
, *alias
;
1727 cursor
= trackdb_opencursor(trackdb_tracksdb
, tid
);
1730 /* find the first key >= dir */
1731 err
= cursor
->c_get(cursor
, &k
, &d
, DB_SET_RANGE
);
1732 /* keep going while we're dealing with <dir/anything> */
1735 && ((char *)k
.data
)[dl
] == '/'
1736 && !memcmp(k
.data
, dir
, dl
)) {
1737 ptr
= memchr((char *)k
.data
+ dl
+ 1, '/', k
.size
- (dl
+ 1));
1739 /* we have <dir/component/anything>, so <dir/component> is a directory */
1740 l
= ptr
- (char *)k
.data
;
1741 if(what
& trackdb_directories
)
1743 && l
== last_dir_len
1744 && !memcmp(last_dir
, k
.data
, l
))) {
1745 last_dir
= xstrndup(k
.data
, last_dir_len
= l
);
1746 if(track_matches(dl
, k
.data
, l
, re
))
1747 vector_append(v
, last_dir
);
1750 /* found a plain file */
1751 if((what
& trackdb_files
)) {
1752 track
= xstrndup(k
.data
, k
.size
);
1753 if((err
= trackdb_getdata(trackdb_prefsdb
,
1754 track
, &p
, tid
)) == DB_LOCK_DEADLOCK
)
1756 /* if this file has an alias in the same directory then we skip it */
1757 if((err
= compute_alias(&alias
, track
, p
, tid
)))
1759 if(!(alias
&& !strcmp(d_dirname(alias
), d_dirname(track
))))
1760 if(track_matches(dl
, k
.data
, k
.size
, re
))
1761 vector_append(v
, track
);
1764 err
= cursor
->c_get(cursor
, &k
, &d
, DB_NEXT
);
1772 case DB_LOCK_DEADLOCK
:
1773 error(0, "error querying database: %s", db_strerror(err
));
1776 fatal(0, "error querying database: %s", db_strerror(err
));
1779 if(trackdb_closecursor(cursor
)) err
= DB_LOCK_DEADLOCK
;
1783 /* return the directories or files below @dir@ */
1784 char **trackdb_list(const char *dir
, int *np
, enum trackdb_listable what
,
1792 tid
= trackdb_begin_transaction();
1795 if(do_list(&v
, dir
, what
, re
, tid
))
1798 for(n
= 0; n
< config
->collection
.n
; ++n
)
1799 if(do_list(&v
, config
->collection
.s
[n
].root
, what
, re
, tid
))
1804 trackdb_abort_transaction(tid
);
1806 trackdb_commit_transaction(tid
);
1807 vector_terminate(&v
);
1813 /* If S is tag:something, return something. Else return 0. */
1814 static const char *checktag(const char *s
) {
1815 if(!strncmp(s
, "tag:", 4))
1821 /* return a list of tracks containing all of the words given. If you
1822 * ask for only stopwords you get no tracks. */
1823 char **trackdb_search(char **wordlist
, int nwordlist
, int *ntracks
) {
1824 const char **w
, *best
= 0, *tag
;
1825 char **twords
, **tags
;
1826 int i
, j
, n
, err
, what
;
1836 *ntracks
= 0; /* for early returns */
1837 /* normalize all the words */
1838 w
= xmalloc(nwordlist
* sizeof (char *));
1839 for(n
= 0; n
< nwordlist
; ++n
) {
1843 w
[n
] = utf8_casefold_compat(wordlist
[n
], strlen(wordlist
[n
]), 0);
1844 if(checktag(w
[n
])) ++ntags
; /* count up tags */
1845 /* Strip out combining characters (AFTER checking whether it's a tag) */
1846 if(!(w32
= utf8_to_utf32(w
[n
], strlen(w
[n
]), &nw32
)))
1848 nw32
= remove_combining_chars(w32
, nw32
);
1849 if(!(w
[n
] = utf32_to_utf8(w32
, nw32
, 0)))
1852 /* find the longest non-stopword */
1853 for(n
= 0; n
< nwordlist
; ++n
)
1854 if(!stopword(w
[n
]) && !checktag(w
[n
]))
1855 if(!best
|| strlen(w
[n
]) > strlen(best
))
1857 /* TODO: we should at least in principal be able to identify the word or tag
1858 * with the least matches in log time, and choose that as our primary search
1860 if(ntags
&& !best
) {
1861 /* Only tags are listed. We limit to the first and narrow down with the
1863 best
= checktag(w
[0]);
1864 db
= trackdb_tagsdb
;
1867 /* We can limit to some word. */
1868 db
= trackdb_searchdb
;
1871 /* Only stopwords */
1877 tid
= trackdb_begin_transaction();
1878 /* find all the tracks that have that word */
1883 cursor
= trackdb_opencursor(db
, tid
);
1884 while(!(err
= cursor
->c_get(cursor
, &k
, &d
, what
))) {
1885 vector_append(&v
, xstrndup(d
.data
, d
.size
));
1892 case DB_LOCK_DEADLOCK
:
1893 error(0, "error querying %s database: %s", dbname
, db_strerror(err
));
1896 fatal(0, "error querying %s database: %s", dbname
, db_strerror(err
));
1898 if(trackdb_closecursor(cursor
)) err
= DB_LOCK_DEADLOCK
;
1900 /* do a naive search over that (hopefuly fairly small) list of tracks */
1902 for(n
= 0; n
< v
.nvec
; ++n
) {
1903 if((err
= gettrackdata(v
.vec
[n
], 0, &p
, 0, 0, tid
) == DB_LOCK_DEADLOCK
))
1906 error(0, "track %s unexpected error: %s", v
.vec
[n
], db_strerror(err
));
1909 twords
= track_to_words(v
.vec
[n
], p
);
1910 tags
= parsetags(kvp_get(p
, "tags"));
1911 for(i
= 0; i
< nwordlist
; ++i
) {
1912 if((tag
= checktag(w
[i
]))) {
1913 /* Track must have this tag */
1914 for(j
= 0; tags
[j
]; ++j
)
1915 if(!strcmp(tag
, tags
[j
])) break; /* tag found */
1916 if(!tags
[j
]) break; /* tag not found */
1918 /* Track must contain this word */
1919 for(j
= 0; twords
[j
]; ++j
)
1920 if(!strcmp(w
[i
], twords
[j
])) break; /* word found */
1921 if(!twords
[j
]) break; /* word not found */
1924 if(i
>= nwordlist
) /* all words found */
1925 vector_append(&u
, v
.vec
[n
]);
1929 trackdb_closecursor(cursor
);
1931 trackdb_abort_transaction(tid
);
1932 info("retrying search");
1934 trackdb_commit_transaction(tid
);
1935 vector_terminate(&u
);
1941 /* trackdb_scan **************************************************************/
1943 int trackdb_scan(const char *root
,
1944 int (*callback
)(const char *track
,
1952 const size_t root_len
= root ?
strlen(root
) : 0;
1957 cursor
= trackdb_opencursor(trackdb_tracksdb
, tid
);
1959 err
= cursor
->c_get(cursor
, make_key(&k
, root
), prepare_data(&d
),
1962 memset(&k
, 0, sizeof k
);
1963 err
= cursor
->c_get(cursor
, &k
, prepare_data(&d
),
1968 || (k
.size
> root_len
1969 && !strncmp(k
.data
, root
, root_len
)
1970 && ((char *)k
.data
)[root_len
] == '/')) {
1971 data
= kvp_urldecode(d
.data
, d
.size
);
1972 if(kvp_get(data
, "_path")) {
1973 track
= xstrndup(k
.data
, k
.size
);
1974 /* Advance to the next track before the callback so that the callback
1975 * may safely delete the track */
1976 err
= cursor
->c_get(cursor
, &k
, &d
, DB_NEXT
);
1977 if((cberr
= callback(track
, data
, u
, tid
))) {
1982 err
= cursor
->c_get(cursor
, &k
, &d
, DB_NEXT
);
1986 trackdb_closecursor(cursor
);
1993 case DB_LOCK_DEADLOCK
:
1994 error(0, "c->c_get: %s", db_strerror(err
));
1997 fatal(0, "c->c_get: %s", db_strerror(err
));
2001 /* trackdb_rescan ************************************************************/
2003 /* called when the rescanner terminates */
2004 static int reap_rescan(ev_source
attribute((unused
)) *ev
,
2007 const struct rusage
attribute((unused
)) *rusage
,
2008 void attribute((unused
)) *u
) {
2009 if(pid
== rescan_pid
) rescan_pid
= -1;
2011 error(0, RESCAN
": %s", wstat(status
));
2013 D((RESCAN
" terminated: %s", wstat(status
)));
2014 /* Our cache of file lookups is out of date now */
2015 cache_clean(&cache_files_type
);
2016 eventlog("rescanned", (char *)0);
2020 void trackdb_rescan(ev_source
*ev
) {
2023 if(rescan_pid
!= -1) {
2024 error(0, "rescan already underway");
2027 rescan_pid
= subprogram(ev
, RESCAN
, -1);
2029 ev_child(ev
, rescan_pid
, 0, reap_rescan
, 0);
2030 D(("started rescanner"));
2032 /* This is the first rescan, we block until it is complete */
2033 while(waitpid(rescan_pid
, &w
, 0) < 0 && errno
== EINTR
)
2035 reap_rescan(0, rescan_pid
, w
, 0, 0);
2039 int trackdb_rescan_cancel(void) {
2040 if(rescan_pid
== -1) return 0;
2041 if(kill(rescan_pid
, SIGTERM
) < 0)
2042 fatal(errno
, "error killing rescanner");
2047 /* global prefs **************************************************************/
2049 void trackdb_set_global(const char *name
,
2057 tid
= trackdb_begin_transaction();
2058 if(!(err
= trackdb_set_global_tid(name
, value
, tid
)))
2060 trackdb_abort_transaction(tid
);
2062 trackdb_commit_transaction(tid
);
2063 /* log important state changes */
2064 if(!strcmp(name
, "playing")) {
2065 state
= !value
|| !strcmp(value
, "yes");
2066 info("playing %s by %s",
2067 state ?
"enabled" : "disabled",
2069 eventlog("state", state ?
"enable_play" : "disable_play", (char *)0);
2071 if(!strcmp(name
, "random-play")) {
2072 state
= !value
|| !strcmp(value
, "yes");
2073 info("random play %s by %s",
2074 state ?
"enabled" : "disabled",
2076 eventlog("state", state ?
"enable_random" : "disable_random", (char *)0);
2078 if(!strcmp(name
, "required-tags"))
2082 int trackdb_set_global_tid(const char *name
,
2088 memset(&k
, 0, sizeof k
);
2089 memset(&d
, 0, sizeof d
);
2090 k
.data
= (void *)name
;
2091 k
.size
= strlen(name
);
2093 d
.data
= (void *)value
;
2094 d
.size
= strlen(value
);
2097 err
= trackdb_globaldb
->put(trackdb_globaldb
, tid
, &k
, &d
, 0);
2099 err
= trackdb_globaldb
->del(trackdb_globaldb
, tid
, &k
, 0);
2100 if(err
== DB_LOCK_DEADLOCK
) return err
;
2102 fatal(0, "error updating database: %s", db_strerror(err
));
2106 const char *trackdb_get_global(const char *name
) {
2112 tid
= trackdb_begin_transaction();
2113 if(!(err
= trackdb_get_global_tid(name
, tid
, &r
)))
2115 trackdb_abort_transaction(tid
);
2117 trackdb_commit_transaction(tid
);
2121 int trackdb_get_global_tid(const char *name
,
2127 memset(&k
, 0, sizeof k
);
2128 k
.data
= (void *)name
;
2129 k
.size
= strlen(name
);
2130 switch(err
= trackdb_globaldb
->get(trackdb_globaldb
, tid
, &k
,
2131 prepare_data(&d
), 0)) {
2133 *rp
= xstrndup(d
.data
, d
.size
);
2138 case DB_LOCK_DEADLOCK
:
2141 fatal(0, "error reading database: %s", db_strerror(err
));
2145 /** @brief Retrieve the most recently added tracks
2146 * @param ntracksp Where to put count, or 0
2147 * @param maxtracks Maximum number of tracks to retrieve
2148 * @return null-terminated array of track names
2150 * The most recently added track is first in the array.
2152 char **trackdb_new(int *ntracksp
,
2158 tid
= trackdb_begin_transaction();
2159 tracks
= trackdb_new_tid(ntracksp
, maxtracks
, tid
);
2162 trackdb_abort_transaction(tid
);
2164 trackdb_commit_transaction(tid
);
2168 /** @brief Retrieve the most recently added tracks
2169 * @param ntracksp Where to put count, or 0
2170 * @param maxtracks Maximum number of tracks to retrieve, or 0 for all
2171 * @param tid Transaction ID
2172 * @return null-terminated array of track names, or NULL on deadlock
2174 * The most recently added track is first in the array.
2176 static char **trackdb_new_tid(int *ntracksp
,
2182 struct vector tracks
[1];
2184 vector_init(tracks
);
2185 c
= trackdb_opencursor(trackdb_noticeddb
, tid
);
2186 while((maxtracks
<= 0 || tracks
->nvec
< maxtracks
)
2187 && !(err
= c
->c_get(c
, prepare_data(&k
), prepare_data(&d
), DB_PREV
)))
2188 vector_append(tracks
, xstrndup(d
.data
, d
.size
));
2190 case 0: /* hit maxtracks */
2191 case DB_NOTFOUND
: /* ran out of tracks */
2193 case DB_LOCK_DEADLOCK
:
2194 trackdb_closecursor(c
);
2197 fatal(0, "error reading noticed.db: %s", db_strerror(err
));
2199 if((err
= trackdb_closecursor(c
)))
2200 return 0; /* deadlock */
2201 vector_terminate(tracks
);
2203 *ntracksp
= tracks
->nvec
;
2207 /** @brief Expire noticed.db
2208 * @param earliest Earliest timestamp to keep
2210 void trackdb_expire_noticed(time_t earliest
) {
2214 tid
= trackdb_begin_transaction();
2215 if(!trackdb_expire_noticed_tid(earliest
, tid
))
2217 trackdb_abort_transaction(tid
);
2219 trackdb_commit_transaction(tid
);
2222 /** @brief Expire noticed.db
2223 * @param earliest Earliest timestamp to keep
2224 * @param tid Transaction ID
2225 * @return 0 or DB_LOCK_DEADLOCK
2227 static int trackdb_expire_noticed_tid(time_t earliest
, DB_TXN
*tid
) {
2235 c
= trackdb_opencursor(trackdb_noticeddb
, tid
);
2236 while(!(err
= c
->c_get(c
, prepare_data(&k
), prepare_data(&d
), DB_NEXT
))) {
2238 when
= (time_t)(((uint64_t)ntohl(kk
[0]) << 32) + ntohl(kk
[1]));
2239 if(when
>= earliest
)
2241 if((err
= c
->c_del(c
, 0))) {
2242 if(err
!= DB_LOCK_DEADLOCK
)
2243 fatal(0, "error deleting expired noticed.db entry: %s",
2249 if(err
== DB_NOTFOUND
)
2251 if(err
&& err
!= DB_LOCK_DEADLOCK
)
2252 fatal(0, "error expiring noticed.db: %s", db_strerror(err
));
2254 if((err
= trackdb_closecursor(c
))) {
2255 if(err
!= DB_LOCK_DEADLOCK
)
2256 fatal(0, "error closing cursor: %s", db_strerror(err
));
2260 info("expired %d tracks from noticed.db", count
);
2264 /* tidying up ****************************************************************/
2266 void trackdb_gc(void) {
2270 if((err
= trackdb_env
->txn_checkpoint(trackdb_env
,
2271 config
->checkpoint_kbyte
,
2272 config
->checkpoint_min
,
2274 fatal(0, "trackdb_env->txn_checkpoint: %s", db_strerror(err
));
2275 if((err
= trackdb_env
->log_archive(trackdb_env
, &logfiles
, DB_ARCH_REMOVE
)))
2276 fatal(0, "trackdb_env->log_archive: %s", db_strerror(err
));
2277 /* This makes catastrophic recovery impossible. However, the user can still
2278 * preserve the important data by using disorder-dump to snapshot their
2279 * prefs, and later to restore it. This is likely to have much small
2280 * long-term storage requirements than record the db logfiles. */
2288 indent-tabs-mode:nil